blob: 4c22067b8305b9b4d9b48226728283566e2169a9 [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"
Argyrios Kyrtzidis4bd97102010-08-20 16:03:52 +000015#include "ASTCommon.h"
Richard Smithd88a7f12015-09-01 20:35:42 +000016#include "ASTReaderInternals.h"
17#include "MultiOnDiskHashTable.h"
Douglas Gregoref84c4b2009-04-09 22:27:44 +000018#include "clang/AST/ASTContext.h"
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +000019#include "clang/AST/ASTUnresolvedSet.h"
Douglas Gregoref84c4b2009-04-09 22:27:44 +000020#include "clang/AST/Decl.h"
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +000021#include "clang/AST/DeclCXX.h"
Duncan P. N. Exon Smith60fa2882017-03-13 18:45:08 +000022#include "clang/AST/DeclContextInternals.h"
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +000023#include "clang/AST/DeclFriend.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"
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +000027#include "clang/AST/LambdaCapture.h"
28#include "clang/AST/NestedNameSpecifier.h"
29#include "clang/AST/RawCommentList.h"
30#include "clang/AST/TemplateName.h"
Douglas Gregoref84c4b2009-04-09 22:27:44 +000031#include "clang/AST/Type.h"
John McCall8f115c62009-10-16 21:56:05 +000032#include "clang/AST/TypeLocVisitor.h"
Benjamin Kramerf3ca26982014-05-10 16:31:55 +000033#include "clang/Basic/DiagnosticOptions.h"
Douglas Gregora7f71a92009-04-10 03:52:48 +000034#include "clang/Basic/FileManager.h"
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +000035#include "clang/Basic/FileSystemOptions.h"
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +000036#include "clang/Basic/LLVM.h"
Duncan P. N. Exon Smith60fa2882017-03-13 18:45:08 +000037#include "clang/Basic/LangOptions.h"
Duncan P. N. Exon Smith030d7d62017-03-20 17:58:26 +000038#include "clang/Basic/MemoryBufferCache.h"
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +000039#include "clang/Basic/Module.h"
40#include "clang/Basic/ObjCRuntime.h"
Douglas Gregora7f71a92009-04-10 03:52:48 +000041#include "clang/Basic/SourceManager.h"
Douglas Gregor4c7626e2009-04-13 16:31:14 +000042#include "clang/Basic/SourceManagerInternals.h"
Douglas Gregorbfbde532009-04-10 21:16:55 +000043#include "clang/Basic/TargetInfo.h"
Douglas Gregorcb177f12012-10-16 23:40:58 +000044#include "clang/Basic/TargetOptions.h"
Douglas Gregor7b71e632009-04-27 22:23:34 +000045#include "clang/Basic/Version.h"
Douglas Gregor20b2ebd2011-03-23 00:50:03 +000046#include "clang/Basic/VersionTuple.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000047#include "clang/Lex/HeaderSearch.h"
48#include "clang/Lex/HeaderSearchOptions.h"
49#include "clang/Lex/MacroInfo.h"
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +000050#include "clang/Lex/ModuleMap.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000051#include "clang/Lex/PreprocessingRecord.h"
52#include "clang/Lex/Preprocessor.h"
53#include "clang/Lex/PreprocessorOptions.h"
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +000054#include "clang/Lex/Token.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000055#include "clang/Sema/IdentifierResolver.h"
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +000056#include "clang/Sema/ObjCMethodList.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000057#include "clang/Sema/Sema.h"
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +000058#include "clang/Sema/Weak.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000059#include "clang/Serialization/ASTReader.h"
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +000060#include "clang/Serialization/Module.h"
Mehdi Amini9670f842016-07-18 19:02:11 +000061#include "clang/Serialization/ModuleFileExtension.h"
Richard Smithb5aaf5a2015-09-01 02:35:58 +000062#include "clang/Serialization/SerializationDiagnostic.h"
Douglas Gregore0a3a512009-04-14 21:55:33 +000063#include "llvm/ADT/APFloat.h"
64#include "llvm/ADT/APInt.h"
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +000065#include "llvm/ADT/Hashing.h"
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +000066#include "llvm/ADT/IntrusiveRefCntPtr.h"
67#include "llvm/ADT/Optional.h"
Duncan P. N. Exon Smith60fa2882017-03-13 18:45:08 +000068#include "llvm/ADT/STLExtras.h"
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +000069#include "llvm/ADT/SmallSet.h"
70#include "llvm/ADT/SmallString.h"
Daniel Dunbarf8502d52009-10-17 23:52:28 +000071#include "llvm/ADT/StringExtras.h"
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +000072#include "llvm/Bitcode/BitCodes.h"
Douglas Gregoref84c4b2009-04-09 22:27:44 +000073#include "llvm/Bitcode/BitstreamWriter.h"
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +000074#include "llvm/Support/Casting.h"
Richard Smithaada85c2016-02-06 02:06:43 +000075#include "llvm/Support/Compression.h"
Justin Bognere1c147c2014-03-28 22:03:19 +000076#include "llvm/Support/EndianStream.h"
George Rimarc39f5492017-01-17 15:45:31 +000077#include "llvm/Support/Error.h"
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +000078#include "llvm/Support/ErrorHandling.h"
Douglas Gregora7f71a92009-04-10 03:52:48 +000079#include "llvm/Support/MemoryBuffer.h"
Justin Bognerbb094f02014-04-18 19:57:06 +000080#include "llvm/Support/OnDiskHashTable.h"
Michael J. Spencer8aaf4992010-11-29 18:12:39 +000081#include "llvm/Support/Path.h"
Ben Langmuir487ea142014-10-23 18:05:36 +000082#include "llvm/Support/Process.h"
Duncan P. N. Exon Smith60fa2882017-03-13 18:45:08 +000083#include "llvm/Support/SHA1.h"
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +000084#include "llvm/Support/raw_ostream.h"
Douglas Gregor925296b2011-07-19 16:10:42 +000085#include <algorithm>
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +000086#include <cassert>
87#include <cstdint>
88#include <cstdlib>
89#include <cstring>
90#include <deque>
91#include <limits>
92#include <new>
93#include <tuple>
Douglas Gregor925296b2011-07-19 16:10:42 +000094#include <utility>
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +000095
Douglas Gregoref84c4b2009-04-09 22:27:44 +000096using namespace clang;
Sebastian Redl539c5062010-08-18 23:57:32 +000097using namespace clang::serialization;
Douglas Gregoref84c4b2009-04-09 22:27:44 +000098
Sebastian Redl3df5a082010-07-30 17:03:48 +000099template <typename T, typename Allocator>
Reid Kleckner012665e2015-05-21 00:13:09 +0000100static StringRef bytes(const std::vector<T, Allocator> &v) {
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000101 if (v.empty()) return StringRef();
102 return StringRef(reinterpret_cast<const char*>(&v[0]),
Benjamin Kramerd47a12a2011-04-24 17:44:50 +0000103 sizeof(T) * v.size());
Sebastian Redl3df5a082010-07-30 17:03:48 +0000104}
Benjamin Kramerd47a12a2011-04-24 17:44:50 +0000105
106template <typename T>
Reid Kleckner012665e2015-05-21 00:13:09 +0000107static StringRef bytes(const SmallVectorImpl<T> &v) {
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000108 return StringRef(reinterpret_cast<const char*>(v.data()),
Benjamin Kramerd47a12a2011-04-24 17:44:50 +0000109 sizeof(T) * v.size());
Sebastian Redl3df5a082010-07-30 17:03:48 +0000110}
111
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000112//===----------------------------------------------------------------------===//
113// Type serialization
114//===----------------------------------------------------------------------===//
Chris Lattner7099dbc2009-04-27 06:16:06 +0000115
Richard Smith290d8012016-04-06 17:06:00 +0000116namespace clang {
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000117
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000118 class ASTTypeWriter {
Sebastian Redl55c0ad52010-08-18 23:56:21 +0000119 ASTWriter &Writer;
Richard Smith69c82bf2016-04-01 22:52:03 +0000120 ASTRecordWriter Record;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000121
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000122 /// \brief Type code that corresponds to the record generated.
Sebastian Redl539c5062010-08-18 23:57:32 +0000123 TypeCode Code;
Richard Smith01b2cb42014-07-26 06:37:51 +0000124 /// \brief Abbreviation to use for the record, if any.
125 unsigned AbbrevToUse;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000126
Richard Smith290d8012016-04-06 17:06:00 +0000127 public:
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +0000128 ASTTypeWriter(ASTWriter &Writer, ASTWriter::RecordDataImpl &Record)
Richard Smith290d8012016-04-06 17:06:00 +0000129 : Writer(Writer), Record(Writer, Record), Code((TypeCode)0), AbbrevToUse(0) { }
130
131 uint64_t Emit() {
132 return Record.Emit(Code, AbbrevToUse);
133 }
134
135 void Visit(QualType T) {
136 if (T.hasLocalNonFastQualifiers()) {
137 Qualifiers Qs = T.getLocalQualifiers();
138 Record.AddTypeRef(T.getLocalUnqualifiedType());
139 Record.push_back(Qs.getAsOpaqueValue());
140 Code = TYPE_EXT_QUAL;
141 AbbrevToUse = Writer.TypeExtQualAbbrev;
142 } else {
143 switch (T->getTypeClass()) {
144 // For all of the concrete, non-dependent types, call the
145 // appropriate visitor function.
146#define TYPE(Class, Base) \
147 case Type::Class: Visit##Class##Type(cast<Class##Type>(T)); break;
148#define ABSTRACT_TYPE(Class, Base)
149#include "clang/AST/TypeNodes.def"
150 }
151 }
152 }
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000153
154 void VisitArrayType(const ArrayType *T);
155 void VisitFunctionType(const FunctionType *T);
156 void VisitTagType(const TagType *T);
157
158#define TYPE(Class, Base) void Visit##Class##Type(const Class##Type *T);
159#define ABSTRACT_TYPE(Class, Base)
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000160#include "clang/AST/TypeNodes.def"
161 };
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000162
Richard Smith290d8012016-04-06 17:06:00 +0000163} // end namespace clang
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000164
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000165void ASTTypeWriter::VisitBuiltinType(const BuiltinType *T) {
David Blaikie83d382b2011-09-23 05:06:16 +0000166 llvm_unreachable("Built-in types are never serialized");
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000167}
168
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000169void ASTTypeWriter::VisitComplexType(const ComplexType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000170 Record.AddTypeRef(T->getElementType());
Sebastian Redl539c5062010-08-18 23:57:32 +0000171 Code = TYPE_COMPLEX;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000172}
173
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000174void ASTTypeWriter::VisitPointerType(const PointerType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000175 Record.AddTypeRef(T->getPointeeType());
Sebastian Redl539c5062010-08-18 23:57:32 +0000176 Code = TYPE_POINTER;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000177}
178
Reid Kleckner8a365022013-06-24 17:51:48 +0000179void ASTTypeWriter::VisitDecayedType(const DecayedType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000180 Record.AddTypeRef(T->getOriginalType());
Reid Kleckner8a365022013-06-24 17:51:48 +0000181 Code = TYPE_DECAYED;
182}
183
Reid Kleckner0503a872013-12-05 01:23:43 +0000184void ASTTypeWriter::VisitAdjustedType(const AdjustedType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000185 Record.AddTypeRef(T->getOriginalType());
186 Record.AddTypeRef(T->getAdjustedType());
Reid Kleckner0503a872013-12-05 01:23:43 +0000187 Code = TYPE_ADJUSTED;
188}
189
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000190void ASTTypeWriter::VisitBlockPointerType(const BlockPointerType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000191 Record.AddTypeRef(T->getPointeeType());
Sebastian Redl539c5062010-08-18 23:57:32 +0000192 Code = TYPE_BLOCK_POINTER;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000193}
194
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000195void ASTTypeWriter::VisitLValueReferenceType(const LValueReferenceType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000196 Record.AddTypeRef(T->getPointeeTypeAsWritten());
Richard Smith0f538462011-04-12 10:38:03 +0000197 Record.push_back(T->isSpelledAsLValue());
Sebastian Redl539c5062010-08-18 23:57:32 +0000198 Code = TYPE_LVALUE_REFERENCE;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000199}
200
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000201void ASTTypeWriter::VisitRValueReferenceType(const RValueReferenceType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000202 Record.AddTypeRef(T->getPointeeTypeAsWritten());
Sebastian Redl539c5062010-08-18 23:57:32 +0000203 Code = TYPE_RVALUE_REFERENCE;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000204}
205
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000206void ASTTypeWriter::VisitMemberPointerType(const MemberPointerType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000207 Record.AddTypeRef(T->getPointeeType());
208 Record.AddTypeRef(QualType(T->getClass(), 0));
Sebastian Redl539c5062010-08-18 23:57:32 +0000209 Code = TYPE_MEMBER_POINTER;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000210}
211
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000212void ASTTypeWriter::VisitArrayType(const ArrayType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000213 Record.AddTypeRef(T->getElementType());
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000214 Record.push_back(T->getSizeModifier()); // FIXME: stable values
John McCall8ccfcb52009-09-24 19:53:00 +0000215 Record.push_back(T->getIndexTypeCVRQualifiers()); // FIXME: stable values
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000216}
217
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000218void ASTTypeWriter::VisitConstantArrayType(const ConstantArrayType *T) {
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000219 VisitArrayType(T);
Richard Smith69c82bf2016-04-01 22:52:03 +0000220 Record.AddAPInt(T->getSize());
Sebastian Redl539c5062010-08-18 23:57:32 +0000221 Code = TYPE_CONSTANT_ARRAY;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000222}
223
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000224void ASTTypeWriter::VisitIncompleteArrayType(const IncompleteArrayType *T) {
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000225 VisitArrayType(T);
Sebastian Redl539c5062010-08-18 23:57:32 +0000226 Code = TYPE_INCOMPLETE_ARRAY;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000227}
228
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000229void ASTTypeWriter::VisitVariableArrayType(const VariableArrayType *T) {
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000230 VisitArrayType(T);
Richard Smith69c82bf2016-04-01 22:52:03 +0000231 Record.AddSourceLocation(T->getLBracketLoc());
232 Record.AddSourceLocation(T->getRBracketLoc());
Richard Smith290d8012016-04-06 17:06:00 +0000233 Record.AddStmt(T->getSizeExpr());
Sebastian Redl539c5062010-08-18 23:57:32 +0000234 Code = TYPE_VARIABLE_ARRAY;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000235}
236
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000237void ASTTypeWriter::VisitVectorType(const VectorType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000238 Record.AddTypeRef(T->getElementType());
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000239 Record.push_back(T->getNumElements());
Bob Wilsonaeb56442010-11-10 21:56:12 +0000240 Record.push_back(T->getVectorKind());
Sebastian Redl539c5062010-08-18 23:57:32 +0000241 Code = TYPE_VECTOR;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000242}
243
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000244void ASTTypeWriter::VisitExtVectorType(const ExtVectorType *T) {
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000245 VisitVectorType(T);
Sebastian Redl539c5062010-08-18 23:57:32 +0000246 Code = TYPE_EXT_VECTOR;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000247}
248
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000249void ASTTypeWriter::VisitFunctionType(const FunctionType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000250 Record.AddTypeRef(T->getReturnType());
Rafael Espindolac50c27c2010-03-30 20:24:48 +0000251 FunctionType::ExtInfo C = T->getExtInfo();
252 Record.push_back(C.getNoReturn());
Eli Friedmanc5b20b52011-04-09 08:18:08 +0000253 Record.push_back(C.getHasRegParm());
Rafael Espindola49b85ab2010-03-30 22:15:11 +0000254 Record.push_back(C.getRegParm());
Douglas Gregor8c940862010-01-18 17:14:39 +0000255 // FIXME: need to stabilize encoding of calling convention...
Rafael Espindolac50c27c2010-03-30 20:24:48 +0000256 Record.push_back(C.getCC());
John McCall31168b02011-06-15 23:02:42 +0000257 Record.push_back(C.getProducesResult());
Oren Ben Simhon318a6ea2017-04-27 12:01:00 +0000258 Record.push_back(C.getNoCallerSavedRegs());
Richard Smith01b2cb42014-07-26 06:37:51 +0000259
260 if (C.getHasRegParm() || C.getRegParm() || C.getProducesResult())
261 AbbrevToUse = 0;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000262}
263
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000264void ASTTypeWriter::VisitFunctionNoProtoType(const FunctionNoProtoType *T) {
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000265 VisitFunctionType(T);
Sebastian Redl539c5062010-08-18 23:57:32 +0000266 Code = TYPE_FUNCTION_NO_PROTO;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000267}
268
Richard Smith290d8012016-04-06 17:06:00 +0000269static void addExceptionSpec(const FunctionProtoType *T,
270 ASTRecordWriter &Record) {
Sebastian Redlfa453cf2011-03-12 11:50:43 +0000271 Record.push_back(T->getExceptionSpecType());
272 if (T->getExceptionSpecType() == EST_Dynamic) {
273 Record.push_back(T->getNumExceptions());
274 for (unsigned I = 0, N = T->getNumExceptions(); I != N; ++I)
Richard Smith69c82bf2016-04-01 22:52:03 +0000275 Record.AddTypeRef(T->getExceptionType(I));
Sebastian Redlfa453cf2011-03-12 11:50:43 +0000276 } else if (T->getExceptionSpecType() == EST_ComputedNoexcept) {
Richard Smith290d8012016-04-06 17:06:00 +0000277 Record.AddStmt(T->getNoexceptExpr());
Richard Smith8b987a92012-04-21 17:47:47 +0000278 } else if (T->getExceptionSpecType() == EST_Uninstantiated) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000279 Record.AddDeclRef(T->getExceptionSpecDecl());
280 Record.AddDeclRef(T->getExceptionSpecTemplate());
Richard Smithd3b5c9082012-07-27 04:22:15 +0000281 } else if (T->getExceptionSpecType() == EST_Unevaluated) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000282 Record.AddDeclRef(T->getExceptionSpecDecl());
Sebastian Redlfa453cf2011-03-12 11:50:43 +0000283 }
Richard Smith564417a2014-03-20 21:47:22 +0000284}
285
286void ASTTypeWriter::VisitFunctionProtoType(const FunctionProtoType *T) {
287 VisitFunctionType(T);
Richard Smith01b2cb42014-07-26 06:37:51 +0000288
Richard Smith564417a2014-03-20 21:47:22 +0000289 Record.push_back(T->isVariadic());
290 Record.push_back(T->hasTrailingReturn());
291 Record.push_back(T->getTypeQuals());
292 Record.push_back(static_cast<unsigned>(T->getRefQualifier()));
Richard Smith290d8012016-04-06 17:06:00 +0000293 addExceptionSpec(T, Record);
Richard Smith01b2cb42014-07-26 06:37:51 +0000294
295 Record.push_back(T->getNumParams());
296 for (unsigned I = 0, N = T->getNumParams(); I != N; ++I)
Richard Smith69c82bf2016-04-01 22:52:03 +0000297 Record.AddTypeRef(T->getParamType(I));
Richard Smith01b2cb42014-07-26 06:37:51 +0000298
John McCall18afab72016-03-01 00:49:02 +0000299 if (T->hasExtParameterInfos()) {
300 for (unsigned I = 0, N = T->getNumParams(); I != N; ++I)
301 Record.push_back(T->getExtParameterInfo(I).getOpaqueValue());
302 }
303
Richard Smith01b2cb42014-07-26 06:37:51 +0000304 if (T->isVariadic() || T->hasTrailingReturn() || T->getTypeQuals() ||
John McCall18afab72016-03-01 00:49:02 +0000305 T->getRefQualifier() || T->getExceptionSpecType() != EST_None ||
306 T->hasExtParameterInfos())
Richard Smith01b2cb42014-07-26 06:37:51 +0000307 AbbrevToUse = 0;
308
Sebastian Redl539c5062010-08-18 23:57:32 +0000309 Code = TYPE_FUNCTION_PROTO;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000310}
311
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000312void ASTTypeWriter::VisitUnresolvedUsingType(const UnresolvedUsingType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000313 Record.AddDeclRef(T->getDecl());
Sebastian Redl539c5062010-08-18 23:57:32 +0000314 Code = TYPE_UNRESOLVED_USING;
John McCallb96ec562009-12-04 22:46:56 +0000315}
John McCallb96ec562009-12-04 22:46:56 +0000316
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000317void ASTTypeWriter::VisitTypedefType(const TypedefType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000318 Record.AddDeclRef(T->getDecl());
Argyrios Kyrtzidis45a83f92010-07-02 11:55:11 +0000319 assert(!T->isCanonicalUnqualified() && "Invalid typedef ?");
Richard Smith69c82bf2016-04-01 22:52:03 +0000320 Record.AddTypeRef(T->getCanonicalTypeInternal());
Sebastian Redl539c5062010-08-18 23:57:32 +0000321 Code = TYPE_TYPEDEF;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000322}
323
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000324void ASTTypeWriter::VisitTypeOfExprType(const TypeOfExprType *T) {
Richard Smith290d8012016-04-06 17:06:00 +0000325 Record.AddStmt(T->getUnderlyingExpr());
Sebastian Redl539c5062010-08-18 23:57:32 +0000326 Code = TYPE_TYPEOF_EXPR;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000327}
328
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000329void ASTTypeWriter::VisitTypeOfType(const TypeOfType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000330 Record.AddTypeRef(T->getUnderlyingType());
Sebastian Redl539c5062010-08-18 23:57:32 +0000331 Code = TYPE_TYPEOF;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000332}
333
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000334void ASTTypeWriter::VisitDecltypeType(const DecltypeType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000335 Record.AddTypeRef(T->getUnderlyingType());
Richard Smith290d8012016-04-06 17:06:00 +0000336 Record.AddStmt(T->getUnderlyingExpr());
Sebastian Redl539c5062010-08-18 23:57:32 +0000337 Code = TYPE_DECLTYPE;
Anders Carlsson81df7b82009-06-24 19:06:50 +0000338}
339
Alexis Hunte852b102011-05-24 22:41:36 +0000340void ASTTypeWriter::VisitUnaryTransformType(const UnaryTransformType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000341 Record.AddTypeRef(T->getBaseType());
342 Record.AddTypeRef(T->getUnderlyingType());
Alexis Hunte852b102011-05-24 22:41:36 +0000343 Record.push_back(T->getUTTKind());
344 Code = TYPE_UNARY_TRANSFORM;
345}
346
Richard Smith30482bc2011-02-20 03:19:35 +0000347void ASTTypeWriter::VisitAutoType(const AutoType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000348 Record.AddTypeRef(T->getDeducedType());
Richard Smithe301ba22015-11-11 02:02:15 +0000349 Record.push_back((unsigned)T->getKeyword());
Richard Smith27d807c2013-04-30 13:56:41 +0000350 if (T->getDeducedType().isNull())
351 Record.push_back(T->isDependentType());
Richard Smith30482bc2011-02-20 03:19:35 +0000352 Code = TYPE_AUTO;
353}
354
Richard Smith600b5262017-01-26 20:40:47 +0000355void ASTTypeWriter::VisitDeducedTemplateSpecializationType(
356 const DeducedTemplateSpecializationType *T) {
357 Record.AddTemplateName(T->getTemplateName());
358 Record.AddTypeRef(T->getDeducedType());
359 if (T->getDeducedType().isNull())
360 Record.push_back(T->isDependentType());
361 Code = TYPE_DEDUCED_TEMPLATE_SPECIALIZATION;
362}
363
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000364void ASTTypeWriter::VisitTagType(const TagType *T) {
Argyrios Kyrtzidisa4ed1812010-07-08 13:09:53 +0000365 Record.push_back(T->isDependentType());
Richard Smith69c82bf2016-04-01 22:52:03 +0000366 Record.AddDeclRef(T->getDecl()->getCanonicalDecl());
Mike Stump11289f42009-09-09 15:08:12 +0000367 assert(!T->isBeingDefined() &&
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000368 "Cannot serialize in the middle of a type definition");
369}
370
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000371void ASTTypeWriter::VisitRecordType(const RecordType *T) {
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000372 VisitTagType(T);
Sebastian Redl539c5062010-08-18 23:57:32 +0000373 Code = TYPE_RECORD;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000374}
375
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000376void ASTTypeWriter::VisitEnumType(const EnumType *T) {
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000377 VisitTagType(T);
Sebastian Redl539c5062010-08-18 23:57:32 +0000378 Code = TYPE_ENUM;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000379}
380
John McCall81904512011-01-06 01:58:22 +0000381void ASTTypeWriter::VisitAttributedType(const AttributedType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000382 Record.AddTypeRef(T->getModifiedType());
383 Record.AddTypeRef(T->getEquivalentType());
John McCall81904512011-01-06 01:58:22 +0000384 Record.push_back(T->getAttrKind());
385 Code = TYPE_ATTRIBUTED;
386}
387
Mike Stump11289f42009-09-09 15:08:12 +0000388void
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000389ASTTypeWriter::VisitSubstTemplateTypeParmType(
John McCallcebee162009-10-18 09:09:24 +0000390 const SubstTemplateTypeParmType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000391 Record.AddTypeRef(QualType(T->getReplacedParameter(), 0));
392 Record.AddTypeRef(T->getReplacementType());
Sebastian Redl539c5062010-08-18 23:57:32 +0000393 Code = TYPE_SUBST_TEMPLATE_TYPE_PARM;
John McCallcebee162009-10-18 09:09:24 +0000394}
395
396void
Douglas Gregorada4b792011-01-14 02:55:32 +0000397ASTTypeWriter::VisitSubstTemplateTypeParmPackType(
398 const SubstTemplateTypeParmPackType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000399 Record.AddTypeRef(QualType(T->getReplacedParameter(), 0));
400 Record.AddTemplateArgument(T->getArgumentPack());
Douglas Gregorada4b792011-01-14 02:55:32 +0000401 Code = TYPE_SUBST_TEMPLATE_TYPE_PARM_PACK;
402}
403
404void
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000405ASTTypeWriter::VisitTemplateSpecializationType(
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000406 const TemplateSpecializationType *T) {
Argyrios Kyrtzidisa4ed1812010-07-08 13:09:53 +0000407 Record.push_back(T->isDependentType());
Richard Smith69c82bf2016-04-01 22:52:03 +0000408 Record.AddTemplateName(T->getTemplateName());
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +0000409 Record.push_back(T->getNumArgs());
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +0000410 for (const auto &ArgI : *T)
Richard Smith69c82bf2016-04-01 22:52:03 +0000411 Record.AddTemplateArgument(ArgI);
412 Record.AddTypeRef(T->isTypeAlias() ? T->getAliasedType()
413 : T->isCanonicalUnqualified()
414 ? QualType()
415 : T->getCanonicalTypeInternal());
Sebastian Redl539c5062010-08-18 23:57:32 +0000416 Code = TYPE_TEMPLATE_SPECIALIZATION;
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +0000417}
418
419void
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000420ASTTypeWriter::VisitDependentSizedArrayType(const DependentSizedArrayType *T) {
Argyrios Kyrtzidis4a57bd02010-06-30 08:49:25 +0000421 VisitArrayType(T);
Richard Smith290d8012016-04-06 17:06:00 +0000422 Record.AddStmt(T->getSizeExpr());
Richard Smith69c82bf2016-04-01 22:52:03 +0000423 Record.AddSourceRange(T->getBracketsRange());
Sebastian Redl539c5062010-08-18 23:57:32 +0000424 Code = TYPE_DEPENDENT_SIZED_ARRAY;
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +0000425}
426
427void
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000428ASTTypeWriter::VisitDependentSizedExtVectorType(
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +0000429 const DependentSizedExtVectorType *T) {
Alex Lorenz00aee432017-03-22 10:04:48 +0000430 Record.AddTypeRef(T->getElementType());
431 Record.AddStmt(T->getSizeExpr());
432 Record.AddSourceLocation(T->getAttributeLoc());
433 Code = TYPE_DEPENDENT_SIZED_EXT_VECTOR;
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +0000434}
435
436void
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000437ASTTypeWriter::VisitTemplateTypeParmType(const TemplateTypeParmType *T) {
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +0000438 Record.push_back(T->getDepth());
439 Record.push_back(T->getIndex());
440 Record.push_back(T->isParameterPack());
Richard Smith69c82bf2016-04-01 22:52:03 +0000441 Record.AddDeclRef(T->getDecl());
Sebastian Redl539c5062010-08-18 23:57:32 +0000442 Code = TYPE_TEMPLATE_TYPE_PARM;
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +0000443}
444
445void
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000446ASTTypeWriter::VisitDependentNameType(const DependentNameType *T) {
Argyrios Kyrtzidisbfcacee2010-06-24 08:57:31 +0000447 Record.push_back(T->getKeyword());
Richard Smith69c82bf2016-04-01 22:52:03 +0000448 Record.AddNestedNameSpecifier(T->getQualifier());
449 Record.AddIdentifierRef(T->getIdentifier());
450 Record.AddTypeRef(
451 T->isCanonicalUnqualified() ? QualType() : T->getCanonicalTypeInternal());
Sebastian Redl539c5062010-08-18 23:57:32 +0000452 Code = TYPE_DEPENDENT_NAME;
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +0000453}
454
455void
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000456ASTTypeWriter::VisitDependentTemplateSpecializationType(
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +0000457 const DependentTemplateSpecializationType *T) {
Argyrios Kyrtzidisf0f7a792010-06-25 16:24:58 +0000458 Record.push_back(T->getKeyword());
Richard Smith69c82bf2016-04-01 22:52:03 +0000459 Record.AddNestedNameSpecifier(T->getQualifier());
460 Record.AddIdentifierRef(T->getIdentifier());
Argyrios Kyrtzidisf0f7a792010-06-25 16:24:58 +0000461 Record.push_back(T->getNumArgs());
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +0000462 for (const auto &I : *T)
Richard Smith69c82bf2016-04-01 22:52:03 +0000463 Record.AddTemplateArgument(I);
Sebastian Redl539c5062010-08-18 23:57:32 +0000464 Code = TYPE_DEPENDENT_TEMPLATE_SPECIALIZATION;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000465}
466
Douglas Gregord2fa7662010-12-20 02:24:11 +0000467void ASTTypeWriter::VisitPackExpansionType(const PackExpansionType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000468 Record.AddTypeRef(T->getPattern());
David Blaikie05785d12013-02-20 22:23:23 +0000469 if (Optional<unsigned> NumExpansions = T->getNumExpansions())
Douglas Gregor0dca5fd2011-01-14 17:04:44 +0000470 Record.push_back(*NumExpansions + 1);
471 else
472 Record.push_back(0);
Douglas Gregord2fa7662010-12-20 02:24:11 +0000473 Code = TYPE_PACK_EXPANSION;
474}
475
Abramo Bagnara924a8f32010-12-10 16:29:40 +0000476void ASTTypeWriter::VisitParenType(const ParenType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000477 Record.AddTypeRef(T->getInnerType());
Abramo Bagnara924a8f32010-12-10 16:29:40 +0000478 Code = TYPE_PAREN;
479}
480
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000481void ASTTypeWriter::VisitElaboratedType(const ElaboratedType *T) {
Abramo Bagnara6150c882010-05-11 21:36:43 +0000482 Record.push_back(T->getKeyword());
Richard Smith69c82bf2016-04-01 22:52:03 +0000483 Record.AddNestedNameSpecifier(T->getQualifier());
484 Record.AddTypeRef(T->getNamedType());
Sebastian Redl539c5062010-08-18 23:57:32 +0000485 Code = TYPE_ELABORATED;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000486}
487
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000488void ASTTypeWriter::VisitInjectedClassNameType(const InjectedClassNameType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000489 Record.AddDeclRef(T->getDecl()->getCanonicalDecl());
490 Record.AddTypeRef(T->getInjectedSpecializationType());
Sebastian Redl539c5062010-08-18 23:57:32 +0000491 Code = TYPE_INJECTED_CLASS_NAME;
John McCalle78aac42010-03-10 03:28:59 +0000492}
493
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000494void ASTTypeWriter::VisitObjCInterfaceType(const ObjCInterfaceType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000495 Record.AddDeclRef(T->getDecl()->getCanonicalDecl());
Sebastian Redl539c5062010-08-18 23:57:32 +0000496 Code = TYPE_OBJC_INTERFACE;
John McCall8b07ec22010-05-15 11:32:37 +0000497}
498
Manman Rene6be26c2016-09-13 17:25:08 +0000499void ASTTypeWriter::VisitObjCTypeParamType(const ObjCTypeParamType *T) {
500 Record.AddDeclRef(T->getDecl());
501 Record.push_back(T->getNumProtocols());
502 for (const auto *I : T->quals())
503 Record.AddDeclRef(I);
504 Code = TYPE_OBJC_TYPE_PARAM;
505}
506
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000507void ASTTypeWriter::VisitObjCObjectType(const ObjCObjectType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000508 Record.AddTypeRef(T->getBaseType());
Douglas Gregore83b9562015-07-07 03:57:53 +0000509 Record.push_back(T->getTypeArgsAsWritten().size());
510 for (auto TypeArg : T->getTypeArgsAsWritten())
Richard Smith69c82bf2016-04-01 22:52:03 +0000511 Record.AddTypeRef(TypeArg);
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000512 Record.push_back(T->getNumProtocols());
Aaron Ballman1683f7b2014-03-17 15:55:30 +0000513 for (const auto *I : T->quals())
Richard Smith69c82bf2016-04-01 22:52:03 +0000514 Record.AddDeclRef(I);
Douglas Gregorab209d82015-07-07 03:58:42 +0000515 Record.push_back(T->isKindOfTypeAsWritten());
Sebastian Redl539c5062010-08-18 23:57:32 +0000516 Code = TYPE_OBJC_OBJECT;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000517}
518
Steve Narofffb4330f2009-06-17 22:40:22 +0000519void
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000520ASTTypeWriter::VisitObjCObjectPointerType(const ObjCObjectPointerType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000521 Record.AddTypeRef(T->getPointeeType());
Sebastian Redl539c5062010-08-18 23:57:32 +0000522 Code = TYPE_OBJC_OBJECT_POINTER;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000523}
524
Eli Friedman0dfb8892011-10-06 23:00:33 +0000525void
526ASTTypeWriter::VisitAtomicType(const AtomicType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000527 Record.AddTypeRef(T->getValueType());
Eli Friedman0dfb8892011-10-06 23:00:33 +0000528 Code = TYPE_ATOMIC;
529}
530
Xiuli Pan9c14e282016-01-09 12:53:17 +0000531void
532ASTTypeWriter::VisitPipeType(const PipeType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000533 Record.AddTypeRef(T->getElementType());
Joey Goulye3c85de2016-12-01 11:30:49 +0000534 Record.push_back(T->isReadOnly());
535 Code = TYPE_PIPE;
Xiuli Pan9c14e282016-01-09 12:53:17 +0000536}
537
John McCall8f115c62009-10-16 21:56:05 +0000538namespace {
539
540class TypeLocWriter : public TypeLocVisitor<TypeLocWriter> {
Richard Smith290d8012016-04-06 17:06:00 +0000541 ASTRecordWriter &Record;
John McCall8f115c62009-10-16 21:56:05 +0000542
543public:
Richard Smith290d8012016-04-06 17:06:00 +0000544 TypeLocWriter(ASTRecordWriter &Record)
545 : Record(Record) { }
John McCall8f115c62009-10-16 21:56:05 +0000546
John McCall17001972009-10-18 01:05:36 +0000547#define ABSTRACT_TYPELOC(CLASS, PARENT)
John McCall8f115c62009-10-16 21:56:05 +0000548#define TYPELOC(CLASS, PARENT) \
John McCall17001972009-10-18 01:05:36 +0000549 void Visit##CLASS##TypeLoc(CLASS##TypeLoc TyLoc);
John McCall8f115c62009-10-16 21:56:05 +0000550#include "clang/AST/TypeLocNodes.def"
551
John McCall17001972009-10-18 01:05:36 +0000552 void VisitArrayTypeLoc(ArrayTypeLoc TyLoc);
553 void VisitFunctionTypeLoc(FunctionTypeLoc TyLoc);
John McCall8f115c62009-10-16 21:56:05 +0000554};
555
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +0000556} // end anonymous namespace
John McCall8f115c62009-10-16 21:56:05 +0000557
John McCall17001972009-10-18 01:05:36 +0000558void TypeLocWriter::VisitQualifiedTypeLoc(QualifiedTypeLoc TL) {
559 // nothing to do
John McCall8f115c62009-10-16 21:56:05 +0000560}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000561
John McCall17001972009-10-18 01:05:36 +0000562void TypeLocWriter::VisitBuiltinTypeLoc(BuiltinTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000563 Record.AddSourceLocation(TL.getBuiltinLoc());
Douglas Gregorc9b7a592010-01-18 18:04:31 +0000564 if (TL.needsExtraLocalData()) {
565 Record.push_back(TL.getWrittenTypeSpec());
566 Record.push_back(TL.getWrittenSignSpec());
567 Record.push_back(TL.getWrittenWidthSpec());
568 Record.push_back(TL.hasModeAttr());
569 }
John McCall8f115c62009-10-16 21:56:05 +0000570}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000571
John McCall17001972009-10-18 01:05:36 +0000572void TypeLocWriter::VisitComplexTypeLoc(ComplexTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000573 Record.AddSourceLocation(TL.getNameLoc());
John McCall8f115c62009-10-16 21:56:05 +0000574}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000575
John McCall17001972009-10-18 01:05:36 +0000576void TypeLocWriter::VisitPointerTypeLoc(PointerTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000577 Record.AddSourceLocation(TL.getStarLoc());
John McCall8f115c62009-10-16 21:56:05 +0000578}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000579
Reid Kleckner8a365022013-06-24 17:51:48 +0000580void TypeLocWriter::VisitDecayedTypeLoc(DecayedTypeLoc TL) {
581 // nothing to do
582}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000583
Reid Kleckner0503a872013-12-05 01:23:43 +0000584void TypeLocWriter::VisitAdjustedTypeLoc(AdjustedTypeLoc TL) {
585 // nothing to do
586}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000587
John McCall17001972009-10-18 01:05:36 +0000588void TypeLocWriter::VisitBlockPointerTypeLoc(BlockPointerTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000589 Record.AddSourceLocation(TL.getCaretLoc());
John McCall8f115c62009-10-16 21:56:05 +0000590}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000591
John McCall17001972009-10-18 01:05:36 +0000592void TypeLocWriter::VisitLValueReferenceTypeLoc(LValueReferenceTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000593 Record.AddSourceLocation(TL.getAmpLoc());
John McCall8f115c62009-10-16 21:56:05 +0000594}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000595
John McCall17001972009-10-18 01:05:36 +0000596void TypeLocWriter::VisitRValueReferenceTypeLoc(RValueReferenceTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000597 Record.AddSourceLocation(TL.getAmpAmpLoc());
John McCall8f115c62009-10-16 21:56:05 +0000598}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000599
John McCall17001972009-10-18 01:05:36 +0000600void TypeLocWriter::VisitMemberPointerTypeLoc(MemberPointerTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000601 Record.AddSourceLocation(TL.getStarLoc());
602 Record.AddTypeSourceInfo(TL.getClassTInfo());
John McCall8f115c62009-10-16 21:56:05 +0000603}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000604
John McCall17001972009-10-18 01:05:36 +0000605void TypeLocWriter::VisitArrayTypeLoc(ArrayTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000606 Record.AddSourceLocation(TL.getLBracketLoc());
607 Record.AddSourceLocation(TL.getRBracketLoc());
John McCall17001972009-10-18 01:05:36 +0000608 Record.push_back(TL.getSizeExpr() ? 1 : 0);
609 if (TL.getSizeExpr())
Richard Smith290d8012016-04-06 17:06:00 +0000610 Record.AddStmt(TL.getSizeExpr());
John McCall8f115c62009-10-16 21:56:05 +0000611}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000612
John McCall17001972009-10-18 01:05:36 +0000613void TypeLocWriter::VisitConstantArrayTypeLoc(ConstantArrayTypeLoc TL) {
614 VisitArrayTypeLoc(TL);
615}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000616
John McCall17001972009-10-18 01:05:36 +0000617void TypeLocWriter::VisitIncompleteArrayTypeLoc(IncompleteArrayTypeLoc TL) {
618 VisitArrayTypeLoc(TL);
619}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000620
John McCall17001972009-10-18 01:05:36 +0000621void TypeLocWriter::VisitVariableArrayTypeLoc(VariableArrayTypeLoc TL) {
622 VisitArrayTypeLoc(TL);
623}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000624
John McCall17001972009-10-18 01:05:36 +0000625void TypeLocWriter::VisitDependentSizedArrayTypeLoc(
626 DependentSizedArrayTypeLoc TL) {
627 VisitArrayTypeLoc(TL);
628}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000629
John McCall17001972009-10-18 01:05:36 +0000630void TypeLocWriter::VisitDependentSizedExtVectorTypeLoc(
631 DependentSizedExtVectorTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000632 Record.AddSourceLocation(TL.getNameLoc());
John McCall17001972009-10-18 01:05:36 +0000633}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000634
John McCall17001972009-10-18 01:05:36 +0000635void TypeLocWriter::VisitVectorTypeLoc(VectorTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000636 Record.AddSourceLocation(TL.getNameLoc());
John McCall17001972009-10-18 01:05:36 +0000637}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000638
John McCall17001972009-10-18 01:05:36 +0000639void TypeLocWriter::VisitExtVectorTypeLoc(ExtVectorTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000640 Record.AddSourceLocation(TL.getNameLoc());
John McCall17001972009-10-18 01:05:36 +0000641}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000642
John McCall17001972009-10-18 01:05:36 +0000643void TypeLocWriter::VisitFunctionTypeLoc(FunctionTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000644 Record.AddSourceLocation(TL.getLocalRangeBegin());
645 Record.AddSourceLocation(TL.getLParenLoc());
646 Record.AddSourceLocation(TL.getRParenLoc());
Malcolm Parsonsa3220ce2017-01-12 16:11:28 +0000647 Record.AddSourceRange(TL.getExceptionSpecRange());
Richard Smith69c82bf2016-04-01 22:52:03 +0000648 Record.AddSourceLocation(TL.getLocalRangeEnd());
Alp Tokerb3fd5cf2014-01-21 00:32:38 +0000649 for (unsigned i = 0, e = TL.getNumParams(); i != e; ++i)
Richard Smith69c82bf2016-04-01 22:52:03 +0000650 Record.AddDeclRef(TL.getParam(i));
John McCall17001972009-10-18 01:05:36 +0000651}
652void TypeLocWriter::VisitFunctionProtoTypeLoc(FunctionProtoTypeLoc TL) {
653 VisitFunctionTypeLoc(TL);
654}
655void TypeLocWriter::VisitFunctionNoProtoTypeLoc(FunctionNoProtoTypeLoc TL) {
656 VisitFunctionTypeLoc(TL);
657}
John McCallb96ec562009-12-04 22:46:56 +0000658void TypeLocWriter::VisitUnresolvedUsingTypeLoc(UnresolvedUsingTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000659 Record.AddSourceLocation(TL.getNameLoc());
John McCallb96ec562009-12-04 22:46:56 +0000660}
John McCall17001972009-10-18 01:05:36 +0000661void TypeLocWriter::VisitTypedefTypeLoc(TypedefTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000662 Record.AddSourceLocation(TL.getNameLoc());
John McCall17001972009-10-18 01:05:36 +0000663}
Manman Rene6be26c2016-09-13 17:25:08 +0000664void TypeLocWriter::VisitObjCTypeParamTypeLoc(ObjCTypeParamTypeLoc TL) {
665 if (TL.getNumProtocols()) {
666 Record.AddSourceLocation(TL.getProtocolLAngleLoc());
667 Record.AddSourceLocation(TL.getProtocolRAngleLoc());
668 }
669 for (unsigned i = 0, e = TL.getNumProtocols(); i != e; ++i)
670 Record.AddSourceLocation(TL.getProtocolLoc(i));
671}
John McCall17001972009-10-18 01:05:36 +0000672void TypeLocWriter::VisitTypeOfExprTypeLoc(TypeOfExprTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000673 Record.AddSourceLocation(TL.getTypeofLoc());
674 Record.AddSourceLocation(TL.getLParenLoc());
675 Record.AddSourceLocation(TL.getRParenLoc());
John McCall17001972009-10-18 01:05:36 +0000676}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000677
John McCall17001972009-10-18 01:05:36 +0000678void TypeLocWriter::VisitTypeOfTypeLoc(TypeOfTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000679 Record.AddSourceLocation(TL.getTypeofLoc());
680 Record.AddSourceLocation(TL.getLParenLoc());
681 Record.AddSourceLocation(TL.getRParenLoc());
682 Record.AddTypeSourceInfo(TL.getUnderlyingTInfo());
John McCall17001972009-10-18 01:05:36 +0000683}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000684
John McCall17001972009-10-18 01:05:36 +0000685void TypeLocWriter::VisitDecltypeTypeLoc(DecltypeTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000686 Record.AddSourceLocation(TL.getNameLoc());
John McCall17001972009-10-18 01:05:36 +0000687}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000688
Alexis Hunte852b102011-05-24 22:41:36 +0000689void TypeLocWriter::VisitUnaryTransformTypeLoc(UnaryTransformTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000690 Record.AddSourceLocation(TL.getKWLoc());
691 Record.AddSourceLocation(TL.getLParenLoc());
692 Record.AddSourceLocation(TL.getRParenLoc());
693 Record.AddTypeSourceInfo(TL.getUnderlyingTInfo());
Alexis Hunte852b102011-05-24 22:41:36 +0000694}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000695
Richard Smith30482bc2011-02-20 03:19:35 +0000696void TypeLocWriter::VisitAutoTypeLoc(AutoTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000697 Record.AddSourceLocation(TL.getNameLoc());
Richard Smith30482bc2011-02-20 03:19:35 +0000698}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000699
Richard Smith600b5262017-01-26 20:40:47 +0000700void TypeLocWriter::VisitDeducedTemplateSpecializationTypeLoc(
701 DeducedTemplateSpecializationTypeLoc TL) {
702 Record.AddSourceLocation(TL.getTemplateNameLoc());
703}
704
John McCall17001972009-10-18 01:05:36 +0000705void TypeLocWriter::VisitRecordTypeLoc(RecordTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000706 Record.AddSourceLocation(TL.getNameLoc());
John McCall17001972009-10-18 01:05:36 +0000707}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000708
John McCall17001972009-10-18 01:05:36 +0000709void TypeLocWriter::VisitEnumTypeLoc(EnumTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000710 Record.AddSourceLocation(TL.getNameLoc());
John McCall17001972009-10-18 01:05:36 +0000711}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000712
John McCall81904512011-01-06 01:58:22 +0000713void TypeLocWriter::VisitAttributedTypeLoc(AttributedTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000714 Record.AddSourceLocation(TL.getAttrNameLoc());
John McCall81904512011-01-06 01:58:22 +0000715 if (TL.hasAttrOperand()) {
716 SourceRange range = TL.getAttrOperandParensRange();
Richard Smith69c82bf2016-04-01 22:52:03 +0000717 Record.AddSourceLocation(range.getBegin());
718 Record.AddSourceLocation(range.getEnd());
John McCall81904512011-01-06 01:58:22 +0000719 }
720 if (TL.hasAttrExprOperand()) {
721 Expr *operand = TL.getAttrExprOperand();
722 Record.push_back(operand ? 1 : 0);
Richard Smith290d8012016-04-06 17:06:00 +0000723 if (operand) Record.AddStmt(operand);
John McCall81904512011-01-06 01:58:22 +0000724 } else if (TL.hasAttrEnumOperand()) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000725 Record.AddSourceLocation(TL.getAttrEnumOperandLoc());
John McCall81904512011-01-06 01:58:22 +0000726 }
727}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000728
John McCall17001972009-10-18 01:05:36 +0000729void TypeLocWriter::VisitTemplateTypeParmTypeLoc(TemplateTypeParmTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000730 Record.AddSourceLocation(TL.getNameLoc());
John McCall17001972009-10-18 01:05:36 +0000731}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000732
John McCallcebee162009-10-18 09:09:24 +0000733void TypeLocWriter::VisitSubstTemplateTypeParmTypeLoc(
734 SubstTemplateTypeParmTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000735 Record.AddSourceLocation(TL.getNameLoc());
John McCallcebee162009-10-18 09:09:24 +0000736}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000737
Douglas Gregorada4b792011-01-14 02:55:32 +0000738void TypeLocWriter::VisitSubstTemplateTypeParmPackTypeLoc(
739 SubstTemplateTypeParmPackTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000740 Record.AddSourceLocation(TL.getNameLoc());
Douglas Gregorada4b792011-01-14 02:55:32 +0000741}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000742
John McCall17001972009-10-18 01:05:36 +0000743void TypeLocWriter::VisitTemplateSpecializationTypeLoc(
744 TemplateSpecializationTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000745 Record.AddSourceLocation(TL.getTemplateKeywordLoc());
746 Record.AddSourceLocation(TL.getTemplateNameLoc());
747 Record.AddSourceLocation(TL.getLAngleLoc());
748 Record.AddSourceLocation(TL.getRAngleLoc());
John McCall0ad16662009-10-29 08:12:44 +0000749 for (unsigned i = 0, e = TL.getNumArgs(); i != e; ++i)
Richard Smith69c82bf2016-04-01 22:52:03 +0000750 Record.AddTemplateArgumentLocInfo(TL.getArgLoc(i).getArgument().getKind(),
751 TL.getArgLoc(i).getLocInfo());
John McCall17001972009-10-18 01:05:36 +0000752}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000753
Abramo Bagnara924a8f32010-12-10 16:29:40 +0000754void TypeLocWriter::VisitParenTypeLoc(ParenTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000755 Record.AddSourceLocation(TL.getLParenLoc());
756 Record.AddSourceLocation(TL.getRParenLoc());
Abramo Bagnara924a8f32010-12-10 16:29:40 +0000757}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000758
Abramo Bagnara6150c882010-05-11 21:36:43 +0000759void TypeLocWriter::VisitElaboratedTypeLoc(ElaboratedTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000760 Record.AddSourceLocation(TL.getElaboratedKeywordLoc());
761 Record.AddNestedNameSpecifierLoc(TL.getQualifierLoc());
John McCall17001972009-10-18 01:05:36 +0000762}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000763
John McCalle78aac42010-03-10 03:28:59 +0000764void TypeLocWriter::VisitInjectedClassNameTypeLoc(InjectedClassNameTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000765 Record.AddSourceLocation(TL.getNameLoc());
John McCalle78aac42010-03-10 03:28:59 +0000766}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000767
Douglas Gregorc1d2d8a2010-03-31 17:34:00 +0000768void TypeLocWriter::VisitDependentNameTypeLoc(DependentNameTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000769 Record.AddSourceLocation(TL.getElaboratedKeywordLoc());
770 Record.AddNestedNameSpecifierLoc(TL.getQualifierLoc());
771 Record.AddSourceLocation(TL.getNameLoc());
John McCall17001972009-10-18 01:05:36 +0000772}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000773
John McCallc392f372010-06-11 00:33:02 +0000774void TypeLocWriter::VisitDependentTemplateSpecializationTypeLoc(
775 DependentTemplateSpecializationTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000776 Record.AddSourceLocation(TL.getElaboratedKeywordLoc());
777 Record.AddNestedNameSpecifierLoc(TL.getQualifierLoc());
778 Record.AddSourceLocation(TL.getTemplateKeywordLoc());
779 Record.AddSourceLocation(TL.getTemplateNameLoc());
780 Record.AddSourceLocation(TL.getLAngleLoc());
781 Record.AddSourceLocation(TL.getRAngleLoc());
John McCallc392f372010-06-11 00:33:02 +0000782 for (unsigned I = 0, E = TL.getNumArgs(); I != E; ++I)
Richard Smith69c82bf2016-04-01 22:52:03 +0000783 Record.AddTemplateArgumentLocInfo(TL.getArgLoc(I).getArgument().getKind(),
784 TL.getArgLoc(I).getLocInfo());
John McCallc392f372010-06-11 00:33:02 +0000785}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000786
Douglas Gregord2fa7662010-12-20 02:24:11 +0000787void TypeLocWriter::VisitPackExpansionTypeLoc(PackExpansionTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000788 Record.AddSourceLocation(TL.getEllipsisLoc());
Douglas Gregord2fa7662010-12-20 02:24:11 +0000789}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000790
John McCall17001972009-10-18 01:05:36 +0000791void TypeLocWriter::VisitObjCInterfaceTypeLoc(ObjCInterfaceTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000792 Record.AddSourceLocation(TL.getNameLoc());
John McCall8b07ec22010-05-15 11:32:37 +0000793}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000794
John McCall8b07ec22010-05-15 11:32:37 +0000795void TypeLocWriter::VisitObjCObjectTypeLoc(ObjCObjectTypeLoc TL) {
796 Record.push_back(TL.hasBaseTypeAsWritten());
Richard Smith69c82bf2016-04-01 22:52:03 +0000797 Record.AddSourceLocation(TL.getTypeArgsLAngleLoc());
798 Record.AddSourceLocation(TL.getTypeArgsRAngleLoc());
Douglas Gregore9d95f12015-07-07 03:57:35 +0000799 for (unsigned i = 0, e = TL.getNumTypeArgs(); i != e; ++i)
Richard Smith69c82bf2016-04-01 22:52:03 +0000800 Record.AddTypeSourceInfo(TL.getTypeArgTInfo(i));
801 Record.AddSourceLocation(TL.getProtocolLAngleLoc());
802 Record.AddSourceLocation(TL.getProtocolRAngleLoc());
John McCall17001972009-10-18 01:05:36 +0000803 for (unsigned i = 0, e = TL.getNumProtocols(); i != e; ++i)
Richard Smith69c82bf2016-04-01 22:52:03 +0000804 Record.AddSourceLocation(TL.getProtocolLoc(i));
John McCall8f115c62009-10-16 21:56:05 +0000805}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000806
John McCallfc93cf92009-10-22 22:37:11 +0000807void TypeLocWriter::VisitObjCObjectPointerTypeLoc(ObjCObjectPointerTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000808 Record.AddSourceLocation(TL.getStarLoc());
John McCallfc93cf92009-10-22 22:37:11 +0000809}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000810
Eli Friedman0dfb8892011-10-06 23:00:33 +0000811void TypeLocWriter::VisitAtomicTypeLoc(AtomicTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000812 Record.AddSourceLocation(TL.getKWLoc());
813 Record.AddSourceLocation(TL.getLParenLoc());
814 Record.AddSourceLocation(TL.getRParenLoc());
Eli Friedman0dfb8892011-10-06 23:00:33 +0000815}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000816
Xiuli Pan9c14e282016-01-09 12:53:17 +0000817void TypeLocWriter::VisitPipeTypeLoc(PipeTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000818 Record.AddSourceLocation(TL.getKWLoc());
Xiuli Pan9c14e282016-01-09 12:53:17 +0000819}
John McCall8f115c62009-10-16 21:56:05 +0000820
Richard Smith01b2cb42014-07-26 06:37:51 +0000821void ASTWriter::WriteTypeAbbrevs() {
822 using namespace llvm;
823
David Blaikieb44f0bf2017-01-04 22:36:43 +0000824 std::shared_ptr<BitCodeAbbrev> Abv;
Richard Smith01b2cb42014-07-26 06:37:51 +0000825
826 // Abbreviation for TYPE_EXT_QUAL
David Blaikieb44f0bf2017-01-04 22:36:43 +0000827 Abv = std::make_shared<BitCodeAbbrev>();
Richard Smith01b2cb42014-07-26 06:37:51 +0000828 Abv->Add(BitCodeAbbrevOp(serialization::TYPE_EXT_QUAL));
829 Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Type
830 Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 3)); // Quals
David Blaikieb44f0bf2017-01-04 22:36:43 +0000831 TypeExtQualAbbrev = Stream.EmitAbbrev(std::move(Abv));
Richard Smith01b2cb42014-07-26 06:37:51 +0000832
833 // Abbreviation for TYPE_FUNCTION_PROTO
David Blaikieb44f0bf2017-01-04 22:36:43 +0000834 Abv = std::make_shared<BitCodeAbbrev>();
Richard Smith01b2cb42014-07-26 06:37:51 +0000835 Abv->Add(BitCodeAbbrevOp(serialization::TYPE_FUNCTION_PROTO));
836 // FunctionType
837 Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // ReturnType
838 Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // NoReturn
839 Abv->Add(BitCodeAbbrevOp(0)); // HasRegParm
840 Abv->Add(BitCodeAbbrevOp(0)); // RegParm
841 Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 4)); // CC
842 Abv->Add(BitCodeAbbrevOp(0)); // ProducesResult
Oren Ben Simhon318a6ea2017-04-27 12:01:00 +0000843 Abv->Add(BitCodeAbbrevOp(0)); // NoCallerSavedRegs
Richard Smith01b2cb42014-07-26 06:37:51 +0000844 // FunctionProtoType
845 Abv->Add(BitCodeAbbrevOp(0)); // IsVariadic
846 Abv->Add(BitCodeAbbrevOp(0)); // HasTrailingReturn
847 Abv->Add(BitCodeAbbrevOp(0)); // TypeQuals
848 Abv->Add(BitCodeAbbrevOp(0)); // RefQualifier
849 Abv->Add(BitCodeAbbrevOp(EST_None)); // ExceptionSpec
850 Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // NumParams
851 Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
852 Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Params
David Blaikieb44f0bf2017-01-04 22:36:43 +0000853 TypeFunctionProtoAbbrev = Stream.EmitAbbrev(std::move(Abv));
Richard Smith01b2cb42014-07-26 06:37:51 +0000854}
855
Chris Lattner19cea4e2009-04-22 05:57:30 +0000856//===----------------------------------------------------------------------===//
Sebastian Redl55c0ad52010-08-18 23:56:21 +0000857// ASTWriter Implementation
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000858//===----------------------------------------------------------------------===//
859
Chris Lattner28fa4e62009-04-26 22:26:21 +0000860static void EmitBlockID(unsigned ID, const char *Name,
861 llvm::BitstreamWriter &Stream,
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +0000862 ASTWriter::RecordDataImpl &Record) {
Chris Lattner28fa4e62009-04-26 22:26:21 +0000863 Record.clear();
864 Record.push_back(ID);
865 Stream.EmitRecord(llvm::bitc::BLOCKINFO_CODE_SETBID, Record);
866
867 // Emit the block name if present.
Craig Toppera13603a2014-05-22 05:54:18 +0000868 if (!Name || Name[0] == 0)
869 return;
Chris Lattner28fa4e62009-04-26 22:26:21 +0000870 Record.clear();
871 while (*Name)
872 Record.push_back(*Name++);
873 Stream.EmitRecord(llvm::bitc::BLOCKINFO_CODE_BLOCKNAME, Record);
874}
875
876static void EmitRecordID(unsigned ID, const char *Name,
877 llvm::BitstreamWriter &Stream,
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +0000878 ASTWriter::RecordDataImpl &Record) {
Chris Lattner28fa4e62009-04-26 22:26:21 +0000879 Record.clear();
880 Record.push_back(ID);
881 while (*Name)
882 Record.push_back(*Name++);
883 Stream.EmitRecord(llvm::bitc::BLOCKINFO_CODE_SETRECORDNAME, Record);
Chris Lattnerccac3a62009-04-27 00:49:53 +0000884}
885
886static void AddStmtsExprs(llvm::BitstreamWriter &Stream,
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +0000887 ASTWriter::RecordDataImpl &Record) {
Sebastian Redl539c5062010-08-18 23:57:32 +0000888#define RECORD(X) EmitRecordID(X, #X, Stream, Record)
Chris Lattnerccac3a62009-04-27 00:49:53 +0000889 RECORD(STMT_STOP);
890 RECORD(STMT_NULL_PTR);
Richard Smith01b2cb42014-07-26 06:37:51 +0000891 RECORD(STMT_REF_PTR);
Chris Lattnerccac3a62009-04-27 00:49:53 +0000892 RECORD(STMT_NULL);
893 RECORD(STMT_COMPOUND);
894 RECORD(STMT_CASE);
895 RECORD(STMT_DEFAULT);
896 RECORD(STMT_LABEL);
Richard Smithc202b282012-04-14 00:33:13 +0000897 RECORD(STMT_ATTRIBUTED);
Chris Lattnerccac3a62009-04-27 00:49:53 +0000898 RECORD(STMT_IF);
899 RECORD(STMT_SWITCH);
900 RECORD(STMT_WHILE);
901 RECORD(STMT_DO);
902 RECORD(STMT_FOR);
903 RECORD(STMT_GOTO);
904 RECORD(STMT_INDIRECT_GOTO);
905 RECORD(STMT_CONTINUE);
906 RECORD(STMT_BREAK);
907 RECORD(STMT_RETURN);
908 RECORD(STMT_DECL);
Chad Rosierde70e0e2012-08-25 00:11:56 +0000909 RECORD(STMT_GCCASM);
Chad Rosiere30d4992012-08-24 23:51:02 +0000910 RECORD(STMT_MSASM);
Chris Lattnerccac3a62009-04-27 00:49:53 +0000911 RECORD(EXPR_PREDEFINED);
912 RECORD(EXPR_DECL_REF);
913 RECORD(EXPR_INTEGER_LITERAL);
914 RECORD(EXPR_FLOATING_LITERAL);
915 RECORD(EXPR_IMAGINARY_LITERAL);
916 RECORD(EXPR_STRING_LITERAL);
917 RECORD(EXPR_CHARACTER_LITERAL);
918 RECORD(EXPR_PAREN);
Richard Smithf1b4b8b2014-07-27 04:29:04 +0000919 RECORD(EXPR_PAREN_LIST);
Chris Lattnerccac3a62009-04-27 00:49:53 +0000920 RECORD(EXPR_UNARY_OPERATOR);
921 RECORD(EXPR_SIZEOF_ALIGN_OF);
922 RECORD(EXPR_ARRAY_SUBSCRIPT);
923 RECORD(EXPR_CALL);
924 RECORD(EXPR_MEMBER);
925 RECORD(EXPR_BINARY_OPERATOR);
926 RECORD(EXPR_COMPOUND_ASSIGN_OPERATOR);
927 RECORD(EXPR_CONDITIONAL_OPERATOR);
928 RECORD(EXPR_IMPLICIT_CAST);
929 RECORD(EXPR_CSTYLE_CAST);
930 RECORD(EXPR_COMPOUND_LITERAL);
931 RECORD(EXPR_EXT_VECTOR_ELEMENT);
932 RECORD(EXPR_INIT_LIST);
933 RECORD(EXPR_DESIGNATED_INIT);
Yunzhong Gaocb779302015-06-10 00:27:52 +0000934 RECORD(EXPR_DESIGNATED_INIT_UPDATE);
Chris Lattnerccac3a62009-04-27 00:49:53 +0000935 RECORD(EXPR_IMPLICIT_VALUE_INIT);
Yunzhong Gaocb779302015-06-10 00:27:52 +0000936 RECORD(EXPR_NO_INIT);
Chris Lattnerccac3a62009-04-27 00:49:53 +0000937 RECORD(EXPR_VA_ARG);
938 RECORD(EXPR_ADDR_LABEL);
939 RECORD(EXPR_STMT);
Chris Lattnerccac3a62009-04-27 00:49:53 +0000940 RECORD(EXPR_CHOOSE);
941 RECORD(EXPR_GNU_NULL);
942 RECORD(EXPR_SHUFFLE_VECTOR);
943 RECORD(EXPR_BLOCK);
Peter Collingbourne91147592011-04-15 00:35:48 +0000944 RECORD(EXPR_GENERIC_SELECTION);
Chris Lattnerccac3a62009-04-27 00:49:53 +0000945 RECORD(EXPR_OBJC_STRING_LITERAL);
Patrick Beard0caa3942012-04-19 00:25:12 +0000946 RECORD(EXPR_OBJC_BOXED_EXPRESSION);
Ted Kremeneke65b0862012-03-06 20:05:56 +0000947 RECORD(EXPR_OBJC_ARRAY_LITERAL);
948 RECORD(EXPR_OBJC_DICTIONARY_LITERAL);
Chris Lattnerccac3a62009-04-27 00:49:53 +0000949 RECORD(EXPR_OBJC_ENCODE);
950 RECORD(EXPR_OBJC_SELECTOR_EXPR);
951 RECORD(EXPR_OBJC_PROTOCOL_EXPR);
952 RECORD(EXPR_OBJC_IVAR_REF_EXPR);
953 RECORD(EXPR_OBJC_PROPERTY_REF_EXPR);
954 RECORD(EXPR_OBJC_KVC_REF_EXPR);
955 RECORD(EXPR_OBJC_MESSAGE_EXPR);
Chris Lattnerccac3a62009-04-27 00:49:53 +0000956 RECORD(STMT_OBJC_FOR_COLLECTION);
957 RECORD(STMT_OBJC_CATCH);
958 RECORD(STMT_OBJC_FINALLY);
959 RECORD(STMT_OBJC_AT_TRY);
960 RECORD(STMT_OBJC_AT_SYNCHRONIZED);
961 RECORD(STMT_OBJC_AT_THROW);
Ted Kremeneke65b0862012-03-06 20:05:56 +0000962 RECORD(EXPR_OBJC_BOOL_LITERAL);
Richard Smith01b2cb42014-07-26 06:37:51 +0000963 RECORD(STMT_CXX_CATCH);
964 RECORD(STMT_CXX_TRY);
965 RECORD(STMT_CXX_FOR_RANGE);
Sam Weinige83b3ac2010-02-07 06:32:43 +0000966 RECORD(EXPR_CXX_OPERATOR_CALL);
Richard Smithf1b4b8b2014-07-27 04:29:04 +0000967 RECORD(EXPR_CXX_MEMBER_CALL);
Sam Weinige83b3ac2010-02-07 06:32:43 +0000968 RECORD(EXPR_CXX_CONSTRUCT);
Richard Smithf1b4b8b2014-07-27 04:29:04 +0000969 RECORD(EXPR_CXX_TEMPORARY_OBJECT);
Sam Weinige83b3ac2010-02-07 06:32:43 +0000970 RECORD(EXPR_CXX_STATIC_CAST);
971 RECORD(EXPR_CXX_DYNAMIC_CAST);
972 RECORD(EXPR_CXX_REINTERPRET_CAST);
973 RECORD(EXPR_CXX_CONST_CAST);
974 RECORD(EXPR_CXX_FUNCTIONAL_CAST);
Richard Smithc67fdd42012-03-07 08:35:16 +0000975 RECORD(EXPR_USER_DEFINED_LITERAL);
Richard Smithcc1b96d2013-06-12 22:31:48 +0000976 RECORD(EXPR_CXX_STD_INITIALIZER_LIST);
Sam Weinige83b3ac2010-02-07 06:32:43 +0000977 RECORD(EXPR_CXX_BOOL_LITERAL);
978 RECORD(EXPR_CXX_NULL_PTR_LITERAL);
Douglas Gregor0beaec02011-02-08 16:34:17 +0000979 RECORD(EXPR_CXX_TYPEID_EXPR);
980 RECORD(EXPR_CXX_TYPEID_TYPE);
Douglas Gregor0beaec02011-02-08 16:34:17 +0000981 RECORD(EXPR_CXX_THIS);
982 RECORD(EXPR_CXX_THROW);
983 RECORD(EXPR_CXX_DEFAULT_ARG);
Richard Smith01b2cb42014-07-26 06:37:51 +0000984 RECORD(EXPR_CXX_DEFAULT_INIT);
Douglas Gregor0beaec02011-02-08 16:34:17 +0000985 RECORD(EXPR_CXX_BIND_TEMPORARY);
986 RECORD(EXPR_CXX_SCALAR_VALUE_INIT);
987 RECORD(EXPR_CXX_NEW);
988 RECORD(EXPR_CXX_DELETE);
989 RECORD(EXPR_CXX_PSEUDO_DESTRUCTOR);
990 RECORD(EXPR_EXPR_WITH_CLEANUPS);
991 RECORD(EXPR_CXX_DEPENDENT_SCOPE_MEMBER);
992 RECORD(EXPR_CXX_DEPENDENT_SCOPE_DECL_REF);
993 RECORD(EXPR_CXX_UNRESOLVED_CONSTRUCT);
994 RECORD(EXPR_CXX_UNRESOLVED_MEMBER);
995 RECORD(EXPR_CXX_UNRESOLVED_LOOKUP);
Richard Smith01b2cb42014-07-26 06:37:51 +0000996 RECORD(EXPR_CXX_EXPRESSION_TRAIT);
Douglas Gregor0beaec02011-02-08 16:34:17 +0000997 RECORD(EXPR_CXX_NOEXCEPT);
998 RECORD(EXPR_OPAQUE_VALUE);
Richard Smith01b2cb42014-07-26 06:37:51 +0000999 RECORD(EXPR_BINARY_CONDITIONAL_OPERATOR);
1000 RECORD(EXPR_TYPE_TRAIT);
1001 RECORD(EXPR_ARRAY_TYPE_TRAIT);
Douglas Gregor0beaec02011-02-08 16:34:17 +00001002 RECORD(EXPR_PACK_EXPANSION);
1003 RECORD(EXPR_SIZEOF_PACK);
Richard Smith01b2cb42014-07-26 06:37:51 +00001004 RECORD(EXPR_SUBST_NON_TYPE_TEMPLATE_PARM);
Douglas Gregor0beaec02011-02-08 16:34:17 +00001005 RECORD(EXPR_SUBST_NON_TYPE_TEMPLATE_PARM_PACK);
Richard Smith01b2cb42014-07-26 06:37:51 +00001006 RECORD(EXPR_FUNCTION_PARM_PACK);
1007 RECORD(EXPR_MATERIALIZE_TEMPORARY);
Peter Collingbourne41f85462011-02-09 21:07:24 +00001008 RECORD(EXPR_CUDA_KERNEL_CALL);
Richard Smith01b2cb42014-07-26 06:37:51 +00001009 RECORD(EXPR_CXX_UUIDOF_EXPR);
1010 RECORD(EXPR_CXX_UUIDOF_TYPE);
1011 RECORD(EXPR_LAMBDA);
Chris Lattnerccac3a62009-04-27 00:49:53 +00001012#undef RECORD
Chris Lattner28fa4e62009-04-26 22:26:21 +00001013}
Mike Stump11289f42009-09-09 15:08:12 +00001014
Sebastian Redl55c0ad52010-08-18 23:56:21 +00001015void ASTWriter::WriteBlockInfoBlock() {
Chris Lattner28fa4e62009-04-26 22:26:21 +00001016 RecordData Record;
Peter Collingbourned3a6c702016-11-01 01:18:57 +00001017 Stream.EnterBlockInfoBlock();
Mike Stump11289f42009-09-09 15:08:12 +00001018
Sebastian Redl539c5062010-08-18 23:57:32 +00001019#define BLOCK(X) EmitBlockID(X ## _ID, #X, Stream, Record)
1020#define RECORD(X) EmitRecordID(X, #X, Stream, Record)
Mike Stump11289f42009-09-09 15:08:12 +00001021
Douglas Gregor0aa21c92012-10-18 18:27:37 +00001022 // Control Block.
1023 BLOCK(CONTROL_BLOCK);
1024 RECORD(METADATA);
Ben Langmuirbeee15e2014-04-14 18:00:01 +00001025 RECORD(MODULE_NAME);
Richard Smithfa715652015-08-31 22:43:10 +00001026 RECORD(MODULE_DIRECTORY);
Ben Langmuirbeee15e2014-04-14 18:00:01 +00001027 RECORD(MODULE_MAP_FILE);
Douglas Gregor0aa21c92012-10-18 18:27:37 +00001028 RECORD(IMPORTS);
Douglas Gregorfad10d82012-10-18 18:36:53 +00001029 RECORD(ORIGINAL_FILE);
Douglas Gregor0aa21c92012-10-18 18:27:37 +00001030 RECORD(ORIGINAL_PCH_DIR);
Argyrios Kyrtzidis52595242012-11-15 18:57:27 +00001031 RECORD(ORIGINAL_FILE_ID);
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001032 RECORD(INPUT_FILE_OFFSETS);
Richard Smith0516b182015-09-08 19:40:14 +00001033
1034 BLOCK(OPTIONS_BLOCK);
1035 RECORD(LANGUAGE_OPTIONS);
1036 RECORD(TARGET_OPTIONS);
Douglas Gregorc6317db2012-10-24 15:49:58 +00001037 RECORD(FILE_SYSTEM_OPTIONS);
Douglas Gregor2d302362012-10-24 16:50:34 +00001038 RECORD(HEADER_SEARCH_OPTIONS);
Douglas Gregorb6af6c22012-10-24 20:05:57 +00001039 RECORD(PREPROCESSOR_OPTIONS);
1040
Douglas Gregor108cb222012-10-19 00:45:00 +00001041 BLOCK(INPUT_FILES_BLOCK);
1042 RECORD(INPUT_FILE);
1043
Douglas Gregor0aa21c92012-10-18 18:27:37 +00001044 // AST Top-Level Block.
1045 BLOCK(AST_BLOCK);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001046 RECORD(TYPE_OFFSET);
1047 RECORD(DECL_OFFSET);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001048 RECORD(IDENTIFIER_OFFSET);
1049 RECORD(IDENTIFIER_TABLE);
Ben Langmuir332aafe2014-01-31 01:06:56 +00001050 RECORD(EAGERLY_DESERIALIZED_DECLS);
David Blaikie9ffe5a32017-01-30 05:00:26 +00001051 RECORD(MODULAR_CODEGEN_DECLS);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001052 RECORD(SPECIAL_TYPES);
1053 RECORD(STATISTICS);
1054 RECORD(TENTATIVE_DEFINITIONS);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001055 RECORD(SELECTOR_OFFSETS);
1056 RECORD(METHOD_POOL);
1057 RECORD(PP_COUNTER_VALUE);
Douglas Gregor258ae542009-04-27 06:38:32 +00001058 RECORD(SOURCE_LOCATION_OFFSETS);
1059 RECORD(SOURCE_LOCATION_PRELOADS);
Douglas Gregor61cac2b2009-04-27 20:06:05 +00001060 RECORD(EXT_VECTOR_DECLS);
Richard Smithfa715652015-08-31 22:43:10 +00001061 RECORD(UNUSED_FILESCOPED_DECLS);
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00001062 RECORD(PPD_ENTITIES_OFFSETS);
Richard Smithfa715652015-08-31 22:43:10 +00001063 RECORD(VTABLE_USES);
Fariborz Jahanianc51609a2010-07-23 19:11:11 +00001064 RECORD(REFERENCED_SELECTOR_POOL);
Douglas Gregor0beaec02011-02-08 16:34:17 +00001065 RECORD(TU_UPDATE_LEXICAL);
Douglas Gregor0beaec02011-02-08 16:34:17 +00001066 RECORD(SEMA_DECL_REFS);
1067 RECORD(WEAK_UNDECLARED_IDENTIFIERS);
1068 RECORD(PENDING_IMPLICIT_INSTANTIATIONS);
Douglas Gregor0beaec02011-02-08 16:34:17 +00001069 RECORD(UPDATE_VISIBLE);
1070 RECORD(DECL_UPDATE_OFFSETS);
1071 RECORD(DECL_UPDATES);
Peter Collingbourne5df20e02011-02-15 19:46:30 +00001072 RECORD(CUDA_SPECIAL_DECL_REFS);
Douglas Gregor09b69892011-02-10 17:09:37 +00001073 RECORD(HEADER_SEARCH_TABLE);
Peter Collingbourne5df20e02011-02-15 19:46:30 +00001074 RECORD(FP_PRAGMA_OPTIONS);
1075 RECORD(OPENCL_EXTENSIONS);
Yaxun Liu5b746652016-12-18 05:18:55 +00001076 RECORD(OPENCL_EXTENSION_TYPES);
1077 RECORD(OPENCL_EXTENSION_DECLS);
Alexis Hunt27a761d2011-05-04 23:29:54 +00001078 RECORD(DELEGATING_CTORS);
Douglas Gregorc2fa1692011-06-28 16:20:02 +00001079 RECORD(KNOWN_NAMESPACES);
Douglas Gregor78d0b572011-08-04 16:39:39 +00001080 RECORD(MODULE_OFFSET_MAP);
1081 RECORD(SOURCE_MANAGER_LINE_TABLE);
Douglas Gregor404cdde2012-01-27 01:47:08 +00001082 RECORD(OBJC_CATEGORIES_MAP);
Douglas Gregor66e4add2011-12-19 21:09:25 +00001083 RECORD(FILE_SORTED_DECLS);
1084 RECORD(IMPORTED_MODULES);
Douglas Gregor404cdde2012-01-27 01:47:08 +00001085 RECORD(OBJC_CATEGORIES);
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00001086 RECORD(MACRO_OFFSET);
Richard Smithfa715652015-08-31 22:43:10 +00001087 RECORD(INTERESTING_IDENTIFIERS);
1088 RECORD(UNDEFINED_BUT_USED);
Richard Smithe40f2ba2013-08-07 21:41:30 +00001089 RECORD(LATE_PARSED_TEMPLATE);
Dario Domizioli13a0a382014-05-23 12:13:25 +00001090 RECORD(OPTIMIZE_PRAGMA_OPTIONS);
Nico Weber779355f2016-03-02 23:22:00 +00001091 RECORD(MSSTRUCT_PRAGMA_OPTIONS);
Nico Weber42932312016-03-03 00:17:35 +00001092 RECORD(POINTERS_TO_MEMBERS_PRAGMA_OPTIONS);
Richard Smithfa715652015-08-31 22:43:10 +00001093 RECORD(UNUSED_LOCAL_TYPEDEF_NAME_CANDIDATES);
Richard Smithfa715652015-08-31 22:43:10 +00001094 RECORD(DELETE_EXPRS_TO_ANALYZE);
Justin Lebar67a78a62016-10-08 22:15:58 +00001095 RECORD(CUDA_PRAGMA_FORCE_HOST_DEVICE_DEPTH);
Erik Verbruggenb34c79f2017-05-30 11:54:55 +00001096 RECORD(PP_CONDITIONAL_STACK);
Douglas Gregor358cd442012-01-15 16:58:34 +00001097
Chris Lattner28fa4e62009-04-26 22:26:21 +00001098 // SourceManager Block.
Chris Lattner64031982009-04-27 00:40:25 +00001099 BLOCK(SOURCE_MANAGER_BLOCK);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001100 RECORD(SM_SLOC_FILE_ENTRY);
1101 RECORD(SM_SLOC_BUFFER_ENTRY);
1102 RECORD(SM_SLOC_BUFFER_BLOB);
Richard Smithaada85c2016-02-06 02:06:43 +00001103 RECORD(SM_SLOC_BUFFER_BLOB_COMPRESSED);
Chandler Carruthf92ac9e2011-07-15 07:25:21 +00001104 RECORD(SM_SLOC_EXPANSION_ENTRY);
Mike Stump11289f42009-09-09 15:08:12 +00001105
Chris Lattner28fa4e62009-04-26 22:26:21 +00001106 // Preprocessor Block.
Chris Lattner64031982009-04-27 00:40:25 +00001107 BLOCK(PREPROCESSOR_BLOCK);
Richard Smithec216502015-02-13 19:48:37 +00001108 RECORD(PP_MACRO_DIRECTIVE_HISTORY);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001109 RECORD(PP_MACRO_FUNCTION_LIKE);
Richard Smithd7329392015-04-21 21:46:32 +00001110 RECORD(PP_MACRO_OBJECT_LIKE);
1111 RECORD(PP_MODULE_MACRO);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001112 RECORD(PP_TOKEN);
Richard Smithec216502015-02-13 19:48:37 +00001113
Richard Smithfa715652015-08-31 22:43:10 +00001114 // Submodule Block.
1115 BLOCK(SUBMODULE_BLOCK);
1116 RECORD(SUBMODULE_METADATA);
1117 RECORD(SUBMODULE_DEFINITION);
1118 RECORD(SUBMODULE_UMBRELLA_HEADER);
1119 RECORD(SUBMODULE_HEADER);
1120 RECORD(SUBMODULE_TOPHEADER);
1121 RECORD(SUBMODULE_UMBRELLA_DIR);
1122 RECORD(SUBMODULE_IMPORTS);
1123 RECORD(SUBMODULE_EXPORTS);
1124 RECORD(SUBMODULE_REQUIRES);
1125 RECORD(SUBMODULE_EXCLUDED_HEADER);
1126 RECORD(SUBMODULE_LINK_LIBRARY);
1127 RECORD(SUBMODULE_CONFIG_MACRO);
1128 RECORD(SUBMODULE_CONFLICT);
1129 RECORD(SUBMODULE_PRIVATE_HEADER);
1130 RECORD(SUBMODULE_TEXTUAL_HEADER);
1131 RECORD(SUBMODULE_PRIVATE_TEXTUAL_HEADER);
Richard Smithdc1f0422016-07-20 19:10:16 +00001132 RECORD(SUBMODULE_INITIALIZERS);
Douglas Gregorf0b11de2017-09-14 23:38:44 +00001133 RECORD(SUBMODULE_EXPORT_AS);
Richard Smithfa715652015-08-31 22:43:10 +00001134
1135 // Comments Block.
1136 BLOCK(COMMENTS_BLOCK);
1137 RECORD(COMMENTS_RAW_COMMENT);
1138
Douglas Gregor12bfa382009-10-17 00:13:19 +00001139 // Decls and Types block.
1140 BLOCK(DECLTYPES_BLOCK);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001141 RECORD(TYPE_EXT_QUAL);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001142 RECORD(TYPE_COMPLEX);
1143 RECORD(TYPE_POINTER);
1144 RECORD(TYPE_BLOCK_POINTER);
1145 RECORD(TYPE_LVALUE_REFERENCE);
1146 RECORD(TYPE_RVALUE_REFERENCE);
1147 RECORD(TYPE_MEMBER_POINTER);
1148 RECORD(TYPE_CONSTANT_ARRAY);
1149 RECORD(TYPE_INCOMPLETE_ARRAY);
1150 RECORD(TYPE_VARIABLE_ARRAY);
1151 RECORD(TYPE_VECTOR);
1152 RECORD(TYPE_EXT_VECTOR);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001153 RECORD(TYPE_FUNCTION_NO_PROTO);
Richard Smithf1b4b8b2014-07-27 04:29:04 +00001154 RECORD(TYPE_FUNCTION_PROTO);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001155 RECORD(TYPE_TYPEDEF);
1156 RECORD(TYPE_TYPEOF_EXPR);
1157 RECORD(TYPE_TYPEOF);
1158 RECORD(TYPE_RECORD);
1159 RECORD(TYPE_ENUM);
1160 RECORD(TYPE_OBJC_INTERFACE);
Steve Narofffb4330f2009-06-17 22:40:22 +00001161 RECORD(TYPE_OBJC_OBJECT_POINTER);
Douglas Gregor0beaec02011-02-08 16:34:17 +00001162 RECORD(TYPE_DECLTYPE);
1163 RECORD(TYPE_ELABORATED);
1164 RECORD(TYPE_SUBST_TEMPLATE_TYPE_PARM);
1165 RECORD(TYPE_UNRESOLVED_USING);
1166 RECORD(TYPE_INJECTED_CLASS_NAME);
1167 RECORD(TYPE_OBJC_OBJECT);
1168 RECORD(TYPE_TEMPLATE_TYPE_PARM);
1169 RECORD(TYPE_TEMPLATE_SPECIALIZATION);
1170 RECORD(TYPE_DEPENDENT_NAME);
1171 RECORD(TYPE_DEPENDENT_TEMPLATE_SPECIALIZATION);
1172 RECORD(TYPE_DEPENDENT_SIZED_ARRAY);
1173 RECORD(TYPE_PAREN);
1174 RECORD(TYPE_PACK_EXPANSION);
1175 RECORD(TYPE_ATTRIBUTED);
1176 RECORD(TYPE_SUBST_TEMPLATE_TYPE_PARM_PACK);
Richard Smithf1b4b8b2014-07-27 04:29:04 +00001177 RECORD(TYPE_AUTO);
1178 RECORD(TYPE_UNARY_TRANSFORM);
Eli Friedman0dfb8892011-10-06 23:00:33 +00001179 RECORD(TYPE_ATOMIC);
Richard Smithf1b4b8b2014-07-27 04:29:04 +00001180 RECORD(TYPE_DECAYED);
1181 RECORD(TYPE_ADJUSTED);
Manman Rene6be26c2016-09-13 17:25:08 +00001182 RECORD(TYPE_OBJC_TYPE_PARAM);
Richard Smithd61d4ac2015-08-22 20:13:39 +00001183 RECORD(LOCAL_REDECLARATIONS);
Chris Lattnerdb397b62009-04-26 22:32:16 +00001184 RECORD(DECL_TYPEDEF);
Richard Smith01b2cb42014-07-26 06:37:51 +00001185 RECORD(DECL_TYPEALIAS);
Chris Lattnerdb397b62009-04-26 22:32:16 +00001186 RECORD(DECL_ENUM);
1187 RECORD(DECL_RECORD);
1188 RECORD(DECL_ENUM_CONSTANT);
1189 RECORD(DECL_FUNCTION);
1190 RECORD(DECL_OBJC_METHOD);
1191 RECORD(DECL_OBJC_INTERFACE);
1192 RECORD(DECL_OBJC_PROTOCOL);
1193 RECORD(DECL_OBJC_IVAR);
1194 RECORD(DECL_OBJC_AT_DEFS_FIELD);
Chris Lattnerdb397b62009-04-26 22:32:16 +00001195 RECORD(DECL_OBJC_CATEGORY);
1196 RECORD(DECL_OBJC_CATEGORY_IMPL);
1197 RECORD(DECL_OBJC_IMPLEMENTATION);
1198 RECORD(DECL_OBJC_COMPATIBLE_ALIAS);
1199 RECORD(DECL_OBJC_PROPERTY);
1200 RECORD(DECL_OBJC_PROPERTY_IMPL);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001201 RECORD(DECL_FIELD);
John McCall5e77d762013-04-16 07:28:30 +00001202 RECORD(DECL_MS_PROPERTY);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001203 RECORD(DECL_VAR);
Chris Lattnerdb397b62009-04-26 22:32:16 +00001204 RECORD(DECL_IMPLICIT_PARAM);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001205 RECORD(DECL_PARM_VAR);
Chris Lattnerdb397b62009-04-26 22:32:16 +00001206 RECORD(DECL_FILE_SCOPE_ASM);
1207 RECORD(DECL_BLOCK);
1208 RECORD(DECL_CONTEXT_LEXICAL);
1209 RECORD(DECL_CONTEXT_VISIBLE);
Douglas Gregor0beaec02011-02-08 16:34:17 +00001210 RECORD(DECL_NAMESPACE);
1211 RECORD(DECL_NAMESPACE_ALIAS);
1212 RECORD(DECL_USING);
1213 RECORD(DECL_USING_SHADOW);
1214 RECORD(DECL_USING_DIRECTIVE);
1215 RECORD(DECL_UNRESOLVED_USING_VALUE);
1216 RECORD(DECL_UNRESOLVED_USING_TYPENAME);
1217 RECORD(DECL_LINKAGE_SPEC);
1218 RECORD(DECL_CXX_RECORD);
1219 RECORD(DECL_CXX_METHOD);
1220 RECORD(DECL_CXX_CONSTRUCTOR);
Richard Smith5179eb72016-06-28 19:03:57 +00001221 RECORD(DECL_CXX_INHERITED_CONSTRUCTOR);
Douglas Gregor0beaec02011-02-08 16:34:17 +00001222 RECORD(DECL_CXX_DESTRUCTOR);
1223 RECORD(DECL_CXX_CONVERSION);
1224 RECORD(DECL_ACCESS_SPEC);
1225 RECORD(DECL_FRIEND);
1226 RECORD(DECL_FRIEND_TEMPLATE);
1227 RECORD(DECL_CLASS_TEMPLATE);
1228 RECORD(DECL_CLASS_TEMPLATE_SPECIALIZATION);
1229 RECORD(DECL_CLASS_TEMPLATE_PARTIAL_SPECIALIZATION);
Larisse Voufo39a1e502013-08-06 01:03:05 +00001230 RECORD(DECL_VAR_TEMPLATE);
1231 RECORD(DECL_VAR_TEMPLATE_SPECIALIZATION);
1232 RECORD(DECL_VAR_TEMPLATE_PARTIAL_SPECIALIZATION);
Douglas Gregor0beaec02011-02-08 16:34:17 +00001233 RECORD(DECL_FUNCTION_TEMPLATE);
1234 RECORD(DECL_TEMPLATE_TYPE_PARM);
1235 RECORD(DECL_NON_TYPE_TEMPLATE_PARM);
1236 RECORD(DECL_TEMPLATE_TEMPLATE_PARM);
Richard Smithefc884a2016-04-13 07:41:35 +00001237 RECORD(DECL_TYPE_ALIAS_TEMPLATE);
Douglas Gregor0beaec02011-02-08 16:34:17 +00001238 RECORD(DECL_STATIC_ASSERT);
1239 RECORD(DECL_CXX_BASE_SPECIFIERS);
Richard Smithefc884a2016-04-13 07:41:35 +00001240 RECORD(DECL_CXX_CTOR_INITIALIZERS);
Douglas Gregor0beaec02011-02-08 16:34:17 +00001241 RECORD(DECL_INDIRECTFIELD);
1242 RECORD(DECL_EXPANDED_NON_TYPE_TEMPLATE_PARM_PACK);
Richard Smithefc884a2016-04-13 07:41:35 +00001243 RECORD(DECL_EXPANDED_TEMPLATE_TEMPLATE_PARM_PACK);
1244 RECORD(DECL_CLASS_SCOPE_FUNCTION_SPECIALIZATION);
1245 RECORD(DECL_IMPORT);
1246 RECORD(DECL_OMP_THREADPRIVATE);
1247 RECORD(DECL_EMPTY);
1248 RECORD(DECL_OBJC_TYPE_PARAM);
1249 RECORD(DECL_OMP_CAPTUREDEXPR);
1250 RECORD(DECL_PRAGMA_COMMENT);
1251 RECORD(DECL_PRAGMA_DETECT_MISMATCH);
1252 RECORD(DECL_OMP_DECLARE_REDUCTION);
Douglas Gregor0beaec02011-02-08 16:34:17 +00001253
Douglas Gregor03412ba2011-06-03 02:27:19 +00001254 // Statements and Exprs can occur in the Decls and Types block.
1255 AddStmtsExprs(Stream, Record);
1256
Douglas Gregor92a96f52011-02-08 21:58:10 +00001257 BLOCK(PREPROCESSOR_DETAIL_BLOCK);
Chandler Carruthf92ac9e2011-07-15 07:25:21 +00001258 RECORD(PPD_MACRO_EXPANSION);
Douglas Gregor92a96f52011-02-08 21:58:10 +00001259 RECORD(PPD_MACRO_DEFINITION);
1260 RECORD(PPD_INCLUSION_DIRECTIVE);
Douglas Gregor6623e1f2015-11-03 18:33:07 +00001261
1262 // Decls and Types block.
1263 BLOCK(EXTENSION_BLOCK);
1264 RECORD(EXTENSION_METADATA);
1265
Duncan P. N. Exon Smith60fa2882017-03-13 18:45:08 +00001266 BLOCK(UNHASHED_CONTROL_BLOCK);
1267 RECORD(SIGNATURE);
1268 RECORD(DIAGNOSTIC_OPTIONS);
1269 RECORD(DIAG_PRAGMA_MAPPINGS);
1270
Chris Lattner28fa4e62009-04-26 22:26:21 +00001271#undef RECORD
1272#undef BLOCK
1273 Stream.ExitBlock();
1274}
1275
Richard Smith54cc3c22014-12-11 20:50:24 +00001276/// \brief Prepares a path for being written to an AST file by converting it
1277/// to an absolute path and removing nested './'s.
1278///
1279/// \return \c true if the path was changed.
Benjamin Kramer6a96ae52015-02-06 18:36:04 +00001280static bool cleanPathForOutput(FileManager &FileMgr,
1281 SmallVectorImpl<char> &Path) {
Argyrios Kyrtzidis403cbcb2015-07-31 01:39:23 +00001282 bool Changed = FileMgr.makeAbsolutePath(Path);
Mike Aizatskyaeb9dd92015-11-09 19:12:18 +00001283 return Changed | llvm::sys::path::remove_dots(Path);
Richard Smith54cc3c22014-12-11 20:50:24 +00001284}
1285
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001286/// \brief Adjusts the given filename to only write out the portion of the
1287/// filename that is not part of the system root directory.
Mike Stump11289f42009-09-09 15:08:12 +00001288///
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001289/// \param Filename the file name to adjust.
1290///
Richard Smith7ed1bc92014-12-05 22:42:13 +00001291/// \param BaseDir When non-NULL, the PCH file is a relocatable AST file and
1292/// the returned filename will be adjusted by this root directory.
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001293///
1294/// \returns either the original filename (if it needs no adjustment) or the
1295/// adjusted filename (which points into the @p Filename parameter).
Mike Stump11289f42009-09-09 15:08:12 +00001296static const char *
Richard Smith7ed1bc92014-12-05 22:42:13 +00001297adjustFilenameForRelocatableAST(const char *Filename, StringRef BaseDir) {
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001298 assert(Filename && "No file name to adjust?");
Mike Stump11289f42009-09-09 15:08:12 +00001299
Richard Smith7ed1bc92014-12-05 22:42:13 +00001300 if (BaseDir.empty())
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001301 return Filename;
Mike Stump11289f42009-09-09 15:08:12 +00001302
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001303 // Verify that the filename and the system root have the same prefix.
1304 unsigned Pos = 0;
Richard Smith7ed1bc92014-12-05 22:42:13 +00001305 for (; Filename[Pos] && Pos < BaseDir.size(); ++Pos)
1306 if (Filename[Pos] != BaseDir[Pos])
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001307 return Filename; // Prefixes don't match.
Mike Stump11289f42009-09-09 15:08:12 +00001308
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001309 // We hit the end of the filename before we hit the end of the system root.
1310 if (!Filename[Pos])
1311 return Filename;
Mike Stump11289f42009-09-09 15:08:12 +00001312
Richard Smith7ed1bc92014-12-05 22:42:13 +00001313 // If there's not a path separator at the end of the base directory nor
1314 // immediately after it, then this isn't within the base directory.
1315 if (!llvm::sys::path::is_separator(Filename[Pos])) {
1316 if (!llvm::sys::path::is_separator(BaseDir.back()))
1317 return Filename;
1318 } else {
1319 // If the file name has a '/' at the current position, skip over the '/'.
1320 // We distinguish relative paths from absolute paths by the
1321 // absence of '/' at the beginning of relative paths.
1322 //
1323 // FIXME: This is wrong. We distinguish them by asking if the path is
1324 // absolute, which isn't the same thing. And there might be multiple '/'s
1325 // in a row. Use a better mechanism to indicate whether we have emitted an
1326 // absolute or relative path.
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001327 ++Pos;
Richard Smith7ed1bc92014-12-05 22:42:13 +00001328 }
Mike Stump11289f42009-09-09 15:08:12 +00001329
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001330 return Filename + Pos;
1331}
Chris Lattner28fa4e62009-04-26 22:26:21 +00001332
Duncan P. N. Exon Smith60fa2882017-03-13 18:45:08 +00001333ASTFileSignature ASTWriter::createSignature(StringRef Bytes) {
1334 // Calculate the hash till start of UNHASHED_CONTROL_BLOCK.
1335 llvm::SHA1 Hasher;
1336 Hasher.update(ArrayRef<uint8_t>(Bytes.bytes_begin(), Bytes.size()));
1337 auto Hash = Hasher.result();
1338
1339 // Convert to an array [5*i32].
1340 ASTFileSignature Signature;
1341 auto LShift = [&](unsigned char Val, unsigned Shift) {
1342 return (uint32_t)Val << Shift;
1343 };
1344 for (int I = 0; I != 5; ++I)
1345 Signature[I] = LShift(Hash[I * 4 + 0], 24) | LShift(Hash[I * 4 + 1], 16) |
1346 LShift(Hash[I * 4 + 2], 8) | LShift(Hash[I * 4 + 3], 0);
1347
1348 return Signature;
1349}
1350
1351ASTFileSignature ASTWriter::writeUnhashedControlBlock(Preprocessor &PP,
1352 ASTContext &Context) {
1353 // Flush first to prepare the PCM hash (signature).
1354 Stream.FlushToWord();
1355 auto StartOfUnhashedControl = Stream.GetCurrentBitNo() >> 3;
1356
1357 // Enter the block and prepare to write records.
1358 RecordData Record;
1359 Stream.EnterSubblock(UNHASHED_CONTROL_BLOCK_ID, 5);
1360
1361 // For implicit modules, write the hash of the PCM as its signature.
1362 ASTFileSignature Signature;
1363 if (WritingModule &&
1364 PP.getHeaderSearchInfo().getHeaderSearchOpts().ModulesHashContent) {
1365 Signature = createSignature(StringRef(Buffer.begin(), StartOfUnhashedControl));
1366 Record.append(Signature.begin(), Signature.end());
1367 Stream.EmitRecord(SIGNATURE, Record);
1368 Record.clear();
Ben Langmuir487ea142014-10-23 18:05:36 +00001369 }
Duncan P. N. Exon Smith60fa2882017-03-13 18:45:08 +00001370
1371 // Diagnostic options.
1372 const auto &Diags = Context.getDiagnostics();
1373 const DiagnosticOptions &DiagOpts = Diags.getDiagnosticOptions();
1374#define DIAGOPT(Name, Bits, Default) Record.push_back(DiagOpts.Name);
1375#define ENUM_DIAGOPT(Name, Type, Bits, Default) \
1376 Record.push_back(static_cast<unsigned>(DiagOpts.get##Name()));
1377#include "clang/Basic/DiagnosticOptions.def"
1378 Record.push_back(DiagOpts.Warnings.size());
1379 for (unsigned I = 0, N = DiagOpts.Warnings.size(); I != N; ++I)
1380 AddString(DiagOpts.Warnings[I], Record);
1381 Record.push_back(DiagOpts.Remarks.size());
1382 for (unsigned I = 0, N = DiagOpts.Remarks.size(); I != N; ++I)
1383 AddString(DiagOpts.Remarks[I], Record);
1384 // Note: we don't serialize the log or serialization file names, because they
1385 // are generally transient files and will almost always be overridden.
1386 Stream.EmitRecord(DIAGNOSTIC_OPTIONS, Record);
1387
1388 // Write out the diagnostic/pragma mappings.
1389 WritePragmaDiagnosticMappings(Diags, /* IsModule = */ WritingModule);
1390
1391 // Leave the options block.
1392 Stream.ExitBlock();
1393 return Signature;
Ben Langmuir487ea142014-10-23 18:05:36 +00001394}
1395
Douglas Gregor112b9072012-10-18 05:31:06 +00001396/// \brief Write the control block.
Duncan P. N. Exon Smith60fa2882017-03-13 18:45:08 +00001397void ASTWriter::WriteControlBlock(Preprocessor &PP, ASTContext &Context,
1398 StringRef isysroot,
1399 const std::string &OutputFile) {
Douglas Gregorbfbde532009-04-10 21:16:55 +00001400 using namespace llvm;
Douglas Gregor0aa21c92012-10-18 18:27:37 +00001401 Stream.EnterSubblock(CONTROL_BLOCK_ID, 5);
Mehdi Amini5ae4a852015-09-09 20:35:37 +00001402 RecordData Record;
1403
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001404 // Metadata
David Blaikieb44f0bf2017-01-04 22:36:43 +00001405 auto MetadataAbbrev = std::make_shared<BitCodeAbbrev>();
Douglas Gregor0aa21c92012-10-18 18:27:37 +00001406 MetadataAbbrev->Add(BitCodeAbbrevOp(METADATA));
1407 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 16)); // Major
1408 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 16)); // Minor
1409 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 16)); // Clang maj.
1410 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 16)); // Clang min.
1411 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Relocatable
Richard Smithe75ee0f2015-08-17 07:13:32 +00001412 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Timestamps
Douglas Gregor0aa21c92012-10-18 18:27:37 +00001413 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Errors
1414 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // SVN branch/tag
David Blaikieb44f0bf2017-01-04 22:36:43 +00001415 unsigned MetadataAbbrevCode = Stream.EmitAbbrev(std::move(MetadataAbbrev));
Richard Smith7ed1bc92014-12-05 22:42:13 +00001416 assert((!WritingModule || isysroot.empty()) &&
1417 "writing module as a relocatable PCH?");
Mehdi Amini57a41912015-09-10 01:46:39 +00001418 {
1419 RecordData::value_type Record[] = {METADATA, VERSION_MAJOR, VERSION_MINOR,
1420 CLANG_VERSION_MAJOR, CLANG_VERSION_MINOR,
1421 !isysroot.empty(), IncludeTimestamps,
1422 ASTHasCompilerErrors};
1423 Stream.EmitRecordWithBlob(MetadataAbbrevCode, Record,
1424 getClangFullRepositoryVersion());
1425 }
Chandler Carruth885e78c2015-03-24 21:18:10 +00001426
Richard Smith8b706102017-05-31 20:56:55 +00001427 if (WritingModule) {
Richard Smith7ed1bc92014-12-05 22:42:13 +00001428 // Module name
David Blaikieb44f0bf2017-01-04 22:36:43 +00001429 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Ben Langmuirbeee15e2014-04-14 18:00:01 +00001430 Abbrev->Add(BitCodeAbbrevOp(MODULE_NAME));
1431 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
David Blaikieb44f0bf2017-01-04 22:36:43 +00001432 unsigned AbbrevCode = Stream.EmitAbbrev(std::move(Abbrev));
Mehdi Amini57a41912015-09-10 01:46:39 +00001433 RecordData::value_type Record[] = {MODULE_NAME};
Ben Langmuirbeee15e2014-04-14 18:00:01 +00001434 Stream.EmitRecordWithBlob(AbbrevCode, Record, WritingModule->Name);
1435 }
1436
Richard Smith7ed1bc92014-12-05 22:42:13 +00001437 if (WritingModule && WritingModule->Directory) {
Richard Smith7ed1bc92014-12-05 22:42:13 +00001438 SmallString<128> BaseDir(WritingModule->Directory->getName());
Richard Smith54cc3c22014-12-11 20:50:24 +00001439 cleanPathForOutput(Context.getSourceManager().getFileManager(), BaseDir);
Richard Smithf7b41372015-08-13 23:47:44 +00001440
1441 // If the home of the module is the current working directory, then we
1442 // want to pick up the cwd of the build process loading the module, not
1443 // our cwd, when we load this module.
1444 if (!PP.getHeaderSearchInfo()
1445 .getHeaderSearchOpts()
1446 .ModuleMapFileHomeIsCwd ||
1447 WritingModule->Directory->getName() != StringRef(".")) {
1448 // Module directory.
David Blaikieb44f0bf2017-01-04 22:36:43 +00001449 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Richard Smithf7b41372015-08-13 23:47:44 +00001450 Abbrev->Add(BitCodeAbbrevOp(MODULE_DIRECTORY));
1451 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Directory
David Blaikieb44f0bf2017-01-04 22:36:43 +00001452 unsigned AbbrevCode = Stream.EmitAbbrev(std::move(Abbrev));
Richard Smithf7b41372015-08-13 23:47:44 +00001453
Mehdi Amini57a41912015-09-10 01:46:39 +00001454 RecordData::value_type Record[] = {MODULE_DIRECTORY};
Richard Smithf7b41372015-08-13 23:47:44 +00001455 Stream.EmitRecordWithBlob(AbbrevCode, Record, BaseDir);
1456 }
Richard Smith7ed1bc92014-12-05 22:42:13 +00001457
1458 // Write out all other paths relative to the base directory if possible.
1459 BaseDirectory.assign(BaseDir.begin(), BaseDir.end());
1460 } else if (!isysroot.empty()) {
1461 // Write out paths relative to the sysroot if possible.
1462 BaseDirectory = isysroot;
1463 }
1464
Ben Langmuirbeee15e2014-04-14 18:00:01 +00001465 // Module map file
Richard Smithd19389a2017-07-05 07:47:11 +00001466 if (WritingModule && WritingModule->Kind == Module::ModuleMapModule) {
Mehdi Amini5ae4a852015-09-09 20:35:37 +00001467 Record.clear();
Ben Langmuirbeee15e2014-04-14 18:00:01 +00001468
Ben Langmuir4b8a9e92014-08-12 16:42:33 +00001469 auto &Map = PP.getHeaderSearchInfo().getModuleMap();
Richard Smith8b706102017-05-31 20:56:55 +00001470 AddPath(WritingModule->PresumedModuleMapFile.empty()
1471 ? Map.getModuleMapFileForUniquing(WritingModule)->getName()
1472 : StringRef(WritingModule->PresumedModuleMapFile),
1473 Record);
Ben Langmuir4b8a9e92014-08-12 16:42:33 +00001474
1475 // Additional module map files.
Richard Smith7ed1bc92014-12-05 22:42:13 +00001476 if (auto *AdditionalModMaps =
1477 Map.getAdditionalModuleMapFiles(WritingModule)) {
Ben Langmuir4b8a9e92014-08-12 16:42:33 +00001478 Record.push_back(AdditionalModMaps->size());
1479 for (const FileEntry *F : *AdditionalModMaps)
Richard Smith7ed1bc92014-12-05 22:42:13 +00001480 AddPath(F->getName(), Record);
Ben Langmuir4b8a9e92014-08-12 16:42:33 +00001481 } else {
1482 Record.push_back(0);
1483 }
1484
1485 Stream.EmitRecord(MODULE_MAP_FILE, Record);
Ben Langmuirbeee15e2014-04-14 18:00:01 +00001486 }
1487
Douglas Gregor112b9072012-10-18 05:31:06 +00001488 // Imports
Douglas Gregor29cc6422011-08-17 21:07:30 +00001489 if (Chain) {
Douglas Gregor29cc6422011-08-17 21:07:30 +00001490 serialization::ModuleManager &Mgr = Chain->getModuleManager();
Mehdi Amini5ae4a852015-09-09 20:35:37 +00001491 Record.clear();
Douglas Gregordf0c1512011-08-18 04:12:04 +00001492
Duncan P. N. Exon Smith96a06e02017-01-28 22:15:22 +00001493 for (ModuleFile &M : Mgr) {
Douglas Gregordf0c1512011-08-18 04:12:04 +00001494 // Skip modules that weren't directly imported.
Duncan P. N. Exon Smith96a06e02017-01-28 22:15:22 +00001495 if (!M.isDirectlyImported())
Douglas Gregordf0c1512011-08-18 04:12:04 +00001496 continue;
1497
Duncan P. N. Exon Smith96a06e02017-01-28 22:15:22 +00001498 Record.push_back((unsigned)M.Kind); // FIXME: Stable encoding
1499 AddSourceLocation(M.ImportLoc, Record);
Duncan P. N. Exon Smith60fa2882017-03-13 18:45:08 +00001500
1501 // If we have calculated signature, there is no need to store
1502 // the size or timestamp.
1503 Record.push_back(M.Signature ? 0 : M.File->getSize());
1504 Record.push_back(M.Signature ? 0 : getTimestampForOutput(M.File));
1505
1506 for (auto I : M.Signature)
1507 Record.push_back(I);
1508
Boris Kolpackovd30446f2017-08-31 06:26:43 +00001509 AddString(M.ModuleName, Record);
Duncan P. N. Exon Smith96a06e02017-01-28 22:15:22 +00001510 AddPath(M.FileName, Record);
Douglas Gregordf0c1512011-08-18 04:12:04 +00001511 }
Douglas Gregor29cc6422011-08-17 21:07:30 +00001512 Stream.EmitRecord(IMPORTS, Record);
1513 }
Mike Stump11289f42009-09-09 15:08:12 +00001514
Richard Smith0516b182015-09-08 19:40:14 +00001515 // Write the options block.
1516 Stream.EnterSubblock(OPTIONS_BLOCK_ID, 4);
1517
Douglas Gregor112b9072012-10-18 05:31:06 +00001518 // Language options.
Mehdi Amini5ae4a852015-09-09 20:35:37 +00001519 Record.clear();
Douglas Gregor112b9072012-10-18 05:31:06 +00001520 const LangOptions &LangOpts = Context.getLangOpts();
1521#define LANGOPT(Name, Bits, Default, Description) \
1522 Record.push_back(LangOpts.Name);
1523#define ENUM_LANGOPT(Name, Type, Bits, Default, Description) \
1524 Record.push_back(static_cast<unsigned>(LangOpts.get##Name()));
Alexey Samsonovedf99a92014-11-07 22:29:38 +00001525#include "clang/Basic/LangOptions.def"
1526#define SANITIZER(NAME, ID) \
1527 Record.push_back(LangOpts.Sanitize.has(SanitizerKind::ID));
Will Dietzf54319c2013-01-18 11:30:38 +00001528#include "clang/Basic/Sanitizers.def"
Douglas Gregor112b9072012-10-18 05:31:06 +00001529
Ben Langmuircd98cb72015-06-23 18:20:18 +00001530 Record.push_back(LangOpts.ModuleFeatures.size());
1531 for (StringRef Feature : LangOpts.ModuleFeatures)
1532 AddString(Feature, Record);
1533
Douglas Gregor112b9072012-10-18 05:31:06 +00001534 Record.push_back((unsigned) LangOpts.ObjCRuntime.getKind());
1535 AddVersionTuple(LangOpts.ObjCRuntime.getVersion(), Record);
Ben Langmuird4a667a2015-06-23 18:20:23 +00001536
1537 AddString(LangOpts.CurrentModule, Record);
Dmitri Gribenkoacf2e782013-02-22 14:21:27 +00001538
1539 // Comment options.
1540 Record.push_back(LangOpts.CommentOpts.BlockCommandNames.size());
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00001541 for (const auto &I : LangOpts.CommentOpts.BlockCommandNames) {
1542 AddString(I, Record);
Dmitri Gribenkoacf2e782013-02-22 14:21:27 +00001543 }
Dmitri Gribenkoa7d16ce2013-04-10 15:35:17 +00001544 Record.push_back(LangOpts.CommentOpts.ParseAllComments);
Dmitri Gribenkoacf2e782013-02-22 14:21:27 +00001545
Samuel Antaoee8fb302016-01-06 13:42:12 +00001546 // OpenMP offloading options.
1547 Record.push_back(LangOpts.OMPTargetTriples.size());
1548 for (auto &T : LangOpts.OMPTargetTriples)
1549 AddString(T.getTriple(), Record);
1550
1551 AddString(LangOpts.OMPHostIRFile, Record);
1552
Douglas Gregor112b9072012-10-18 05:31:06 +00001553 Stream.EmitRecord(LANGUAGE_OPTIONS, Record);
1554
Douglas Gregor4d3611c2012-10-18 17:58:09 +00001555 // Target options.
1556 Record.clear();
Douglas Gregor0aa21c92012-10-18 18:27:37 +00001557 const TargetInfo &Target = Context.getTargetInfo();
1558 const TargetOptions &TargetOpts = Target.getTargetOpts();
Douglas Gregor4d3611c2012-10-18 17:58:09 +00001559 AddString(TargetOpts.Triple, Record);
1560 AddString(TargetOpts.CPU, Record);
1561 AddString(TargetOpts.ABI, Record);
Douglas Gregor4d3611c2012-10-18 17:58:09 +00001562 Record.push_back(TargetOpts.FeaturesAsWritten.size());
1563 for (unsigned I = 0, N = TargetOpts.FeaturesAsWritten.size(); I != N; ++I) {
1564 AddString(TargetOpts.FeaturesAsWritten[I], Record);
1565 }
1566 Record.push_back(TargetOpts.Features.size());
1567 for (unsigned I = 0, N = TargetOpts.Features.size(); I != N; ++I) {
1568 AddString(TargetOpts.Features[I], Record);
1569 }
1570 Stream.EmitRecord(TARGET_OPTIONS, Record);
1571
Douglas Gregorc6317db2012-10-24 15:49:58 +00001572 // File system options.
1573 Record.clear();
Yaron Keren8dec46c2015-08-26 08:10:22 +00001574 const FileSystemOptions &FSOpts =
1575 Context.getSourceManager().getFileManager().getFileSystemOpts();
Douglas Gregorc6317db2012-10-24 15:49:58 +00001576 AddString(FSOpts.WorkingDir, Record);
1577 Stream.EmitRecord(FILE_SYSTEM_OPTIONS, Record);
1578
Douglas Gregor2d302362012-10-24 16:50:34 +00001579 // Header search options.
1580 Record.clear();
1581 const HeaderSearchOptions &HSOpts
1582 = PP.getHeaderSearchInfo().getHeaderSearchOpts();
1583 AddString(HSOpts.Sysroot, Record);
1584
1585 // Include entries.
1586 Record.push_back(HSOpts.UserEntries.size());
1587 for (unsigned I = 0, N = HSOpts.UserEntries.size(); I != N; ++I) {
1588 const HeaderSearchOptions::Entry &Entry = HSOpts.UserEntries[I];
1589 AddString(Entry.Path, Record);
1590 Record.push_back(static_cast<unsigned>(Entry.Group));
Douglas Gregor2d302362012-10-24 16:50:34 +00001591 Record.push_back(Entry.IsFramework);
1592 Record.push_back(Entry.IgnoreSysRoot);
Douglas Gregor2d302362012-10-24 16:50:34 +00001593 }
1594
1595 // System header prefixes.
1596 Record.push_back(HSOpts.SystemHeaderPrefixes.size());
1597 for (unsigned I = 0, N = HSOpts.SystemHeaderPrefixes.size(); I != N; ++I) {
1598 AddString(HSOpts.SystemHeaderPrefixes[I].Prefix, Record);
1599 Record.push_back(HSOpts.SystemHeaderPrefixes[I].IsSystemHeader);
1600 }
1601
1602 AddString(HSOpts.ResourceDir, Record);
1603 AddString(HSOpts.ModuleCachePath, Record);
Argyrios Kyrtzidis1594c152014-03-03 08:12:05 +00001604 AddString(HSOpts.ModuleUserBuildPath, Record);
Douglas Gregor2d302362012-10-24 16:50:34 +00001605 Record.push_back(HSOpts.DisableModuleHash);
Richard Smith18934752017-06-06 00:32:01 +00001606 Record.push_back(HSOpts.ImplicitModuleMaps);
1607 Record.push_back(HSOpts.ModuleMapFileHomeIsCwd);
Douglas Gregor2d302362012-10-24 16:50:34 +00001608 Record.push_back(HSOpts.UseBuiltinIncludes);
1609 Record.push_back(HSOpts.UseStandardSystemIncludes);
1610 Record.push_back(HSOpts.UseStandardCXXIncludes);
1611 Record.push_back(HSOpts.UseLibcxx);
Argyrios Kyrtzidisbd0b6512015-02-19 20:12:20 +00001612 // Write out the specific module cache path that contains the module files.
1613 AddString(PP.getHeaderSearchInfo().getModuleCachePath(), Record);
Douglas Gregor2d302362012-10-24 16:50:34 +00001614 Stream.EmitRecord(HEADER_SEARCH_OPTIONS, Record);
1615
Douglas Gregorb6af6c22012-10-24 20:05:57 +00001616 // Preprocessor options.
1617 Record.clear();
1618 const PreprocessorOptions &PPOpts = PP.getPreprocessorOpts();
1619
1620 // Macro definitions.
1621 Record.push_back(PPOpts.Macros.size());
1622 for (unsigned I = 0, N = PPOpts.Macros.size(); I != N; ++I) {
1623 AddString(PPOpts.Macros[I].first, Record);
1624 Record.push_back(PPOpts.Macros[I].second);
1625 }
1626
1627 // Includes
1628 Record.push_back(PPOpts.Includes.size());
1629 for (unsigned I = 0, N = PPOpts.Includes.size(); I != N; ++I)
1630 AddString(PPOpts.Includes[I], Record);
1631
1632 // Macro includes
1633 Record.push_back(PPOpts.MacroIncludes.size());
1634 for (unsigned I = 0, N = PPOpts.MacroIncludes.size(); I != N; ++I)
1635 AddString(PPOpts.MacroIncludes[I], Record);
1636
Douglas Gregorb6368752012-10-24 23:41:50 +00001637 Record.push_back(PPOpts.UsePredefines);
Argyrios Kyrtzidisd3afa0c2013-04-26 21:33:40 +00001638 // Detailed record is important since it is used for the module cache hash.
1639 Record.push_back(PPOpts.DetailedRecord);
Douglas Gregorb6af6c22012-10-24 20:05:57 +00001640 AddString(PPOpts.ImplicitPCHInclude, Record);
1641 AddString(PPOpts.ImplicitPTHInclude, Record);
1642 Record.push_back(static_cast<unsigned>(PPOpts.ObjCXXARCStandardLibrary));
1643 Stream.EmitRecord(PREPROCESSOR_OPTIONS, Record);
1644
Richard Smith0516b182015-09-08 19:40:14 +00001645 // Leave the options block.
1646 Stream.ExitBlock();
1647
Douglas Gregora3b20262011-05-06 21:43:30 +00001648 // Original file name and file ID
Douglas Gregor45fe0362009-05-12 01:31:05 +00001649 SourceManager &SM = Context.getSourceManager();
1650 if (const FileEntry *MainFile = SM.getFileEntryForID(SM.getMainFileID())) {
David Blaikieb44f0bf2017-01-04 22:36:43 +00001651 auto FileAbbrev = std::make_shared<BitCodeAbbrev>();
Douglas Gregorfad10d82012-10-18 18:36:53 +00001652 FileAbbrev->Add(BitCodeAbbrevOp(ORIGINAL_FILE));
1653 FileAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // File ID
Douglas Gregor45fe0362009-05-12 01:31:05 +00001654 FileAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // File name
David Blaikieb44f0bf2017-01-04 22:36:43 +00001655 unsigned FileAbbrevCode = Stream.EmitAbbrev(std::move(FileAbbrev));
Douglas Gregor45fe0362009-05-12 01:31:05 +00001656
Douglas Gregorb6af6c22012-10-24 20:05:57 +00001657 Record.clear();
Douglas Gregorfad10d82012-10-18 18:36:53 +00001658 Record.push_back(ORIGINAL_FILE);
Douglas Gregora3b20262011-05-06 21:43:30 +00001659 Record.push_back(SM.getMainFileID().getOpaqueValue());
Richard Smith7ed1bc92014-12-05 22:42:13 +00001660 EmitRecordWithPath(FileAbbrevCode, Record, MainFile->getName());
Douglas Gregor45fe0362009-05-12 01:31:05 +00001661 }
Kovarththanan Rajaratnama9c81a82010-03-14 07:06:50 +00001662
Argyrios Kyrtzidis52595242012-11-15 18:57:27 +00001663 Record.clear();
1664 Record.push_back(SM.getMainFileID().getOpaqueValue());
1665 Stream.EmitRecord(ORIGINAL_FILE_ID, Record);
1666
Argyrios Kyrtzidis10b23682011-02-15 17:54:22 +00001667 // Original PCH directory
1668 if (!OutputFile.empty() && OutputFile != "-") {
David Blaikieb44f0bf2017-01-04 22:36:43 +00001669 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Argyrios Kyrtzidis10b23682011-02-15 17:54:22 +00001670 Abbrev->Add(BitCodeAbbrevOp(ORIGINAL_PCH_DIR));
1671 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // File name
David Blaikieb44f0bf2017-01-04 22:36:43 +00001672 unsigned AbbrevCode = Stream.EmitAbbrev(std::move(Abbrev));
Argyrios Kyrtzidis10b23682011-02-15 17:54:22 +00001673
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00001674 SmallString<128> OutputPath(OutputFile);
Argyrios Kyrtzidis10b23682011-02-15 17:54:22 +00001675
Argyrios Kyrtzidisc56419e2015-07-31 00:58:32 +00001676 SM.getFileManager().makeAbsolutePath(OutputPath);
Argyrios Kyrtzidis10b23682011-02-15 17:54:22 +00001677 StringRef origDir = llvm::sys::path::parent_path(OutputPath);
1678
Mehdi Amini57a41912015-09-10 01:46:39 +00001679 RecordData::value_type Record[] = {ORIGINAL_PCH_DIR};
Argyrios Kyrtzidis10b23682011-02-15 17:54:22 +00001680 Stream.EmitRecordWithBlob(AbbrevCode, Record, origDir);
1681 }
1682
Douglas Gregor49491f72013-03-15 22:15:07 +00001683 WriteInputFiles(Context.SourceMgr,
1684 PP.getHeaderSearchInfo().getHeaderSearchOpts(),
Douglas Gregora3dd9002013-07-22 20:48:33 +00001685 PP.getLangOpts().Modules);
Douglas Gregor72be3902012-10-19 00:38:02 +00001686 Stream.ExitBlock();
1687}
1688
Douglas Gregor49491f72013-03-15 22:15:07 +00001689namespace {
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +00001690
Douglas Gregor49491f72013-03-15 22:15:07 +00001691 /// \brief An input file.
1692 struct InputFileEntry {
1693 const FileEntry *File;
1694 bool IsSystemFile;
Richard Smitha8cfffa2015-11-26 02:04:16 +00001695 bool IsTransient;
Douglas Gregor49491f72013-03-15 22:15:07 +00001696 bool BufferOverridden;
Richard Smithf3f84612017-06-29 02:19:42 +00001697 bool IsTopLevelModuleMap;
Douglas Gregor49491f72013-03-15 22:15:07 +00001698 };
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +00001699
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00001700} // end anonymous namespace
Douglas Gregor49491f72013-03-15 22:15:07 +00001701
1702void ASTWriter::WriteInputFiles(SourceManager &SourceMgr,
1703 HeaderSearchOptions &HSOpts,
Douglas Gregora3dd9002013-07-22 20:48:33 +00001704 bool Modules) {
Douglas Gregor72be3902012-10-19 00:38:02 +00001705 using namespace llvm;
1706 Stream.EnterSubblock(INPUT_FILES_BLOCK_ID, 4);
Mehdi Amini57a41912015-09-10 01:46:39 +00001707
Douglas Gregor72be3902012-10-19 00:38:02 +00001708 // Create input-file abbreviation.
David Blaikieb44f0bf2017-01-04 22:36:43 +00001709 auto IFAbbrev = std::make_shared<BitCodeAbbrev>();
Douglas Gregor72be3902012-10-19 00:38:02 +00001710 IFAbbrev->Add(BitCodeAbbrevOp(INPUT_FILE));
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001711 IFAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // ID
Douglas Gregor72be3902012-10-19 00:38:02 +00001712 IFAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 12)); // Size
1713 IFAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 32)); // Modification time
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001714 IFAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Overridden
Richard Smitha8cfffa2015-11-26 02:04:16 +00001715 IFAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Transient
Richard Smithf3f84612017-06-29 02:19:42 +00001716 IFAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Module map
Douglas Gregor72be3902012-10-19 00:38:02 +00001717 IFAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // File name
David Blaikieb44f0bf2017-01-04 22:36:43 +00001718 unsigned IFAbbrevCode = Stream.EmitAbbrev(std::move(IFAbbrev));
Douglas Gregor72be3902012-10-19 00:38:02 +00001719
Argyrios Kyrtzidis7d238572013-03-06 18:12:50 +00001720 // Get all ContentCache objects for files, sorted by whether the file is a
1721 // system one or not. System files go at the back, users files at the front.
Douglas Gregor49491f72013-03-15 22:15:07 +00001722 std::deque<InputFileEntry> SortedFiles;
Douglas Gregor72be3902012-10-19 00:38:02 +00001723 for (unsigned I = 1, N = SourceMgr.local_sloc_entry_size(); I != N; ++I) {
1724 // Get this source location entry.
1725 const SrcMgr::SLocEntry *SLoc = &SourceMgr.getLocalSLocEntry(I);
NAKAMURA Takumideca50f2012-10-19 01:53:57 +00001726 assert(&SourceMgr.getSLocEntry(FileID::get(I)) == SLoc);
Douglas Gregor72be3902012-10-19 00:38:02 +00001727
1728 // We only care about file entries that were not overridden.
1729 if (!SLoc->isFile())
1730 continue;
Richard Smithf3f84612017-06-29 02:19:42 +00001731 const SrcMgr::FileInfo &File = SLoc->getFile();
1732 const SrcMgr::ContentCache *Cache = File.getContentCache();
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001733 if (!Cache->OrigEntry)
Douglas Gregor72be3902012-10-19 00:38:02 +00001734 continue;
1735
Douglas Gregor49491f72013-03-15 22:15:07 +00001736 InputFileEntry Entry;
1737 Entry.File = Cache->OrigEntry;
1738 Entry.IsSystemFile = Cache->IsSystemFile;
Richard Smitha8cfffa2015-11-26 02:04:16 +00001739 Entry.IsTransient = Cache->IsTransient;
Douglas Gregor49491f72013-03-15 22:15:07 +00001740 Entry.BufferOverridden = Cache->BufferOverridden;
Richard Smithf3f84612017-06-29 02:19:42 +00001741 Entry.IsTopLevelModuleMap = isModuleMap(File.getFileCharacteristic()) &&
1742 File.getIncludeLoc().isInvalid();
Argyrios Kyrtzidis7d238572013-03-06 18:12:50 +00001743 if (Cache->IsSystemFile)
Douglas Gregor49491f72013-03-15 22:15:07 +00001744 SortedFiles.push_back(Entry);
Argyrios Kyrtzidis7d238572013-03-06 18:12:50 +00001745 else
Douglas Gregor49491f72013-03-15 22:15:07 +00001746 SortedFiles.push_front(Entry);
1747 }
1748
Argyrios Kyrtzidis7d238572013-03-06 18:12:50 +00001749 unsigned UserFilesNum = 0;
1750 // Write out all of the input files.
Richard Smithec216502015-02-13 19:48:37 +00001751 std::vector<uint64_t> InputFileOffsets;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00001752 for (const auto &Entry : SortedFiles) {
Douglas Gregor49491f72013-03-15 22:15:07 +00001753 uint32_t &InputFileID = InputFileIDs[Entry.File];
Argyrios Kyrtzidise65856f2012-12-11 07:48:08 +00001754 if (InputFileID != 0)
1755 continue; // already recorded this file.
1756
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001757 // Record this entry's offset.
1758 InputFileOffsets.push_back(Stream.GetCurrentBitNo());
Argyrios Kyrtzidise65856f2012-12-11 07:48:08 +00001759
1760 InputFileID = InputFileOffsets.size();
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001761
Douglas Gregor49491f72013-03-15 22:15:07 +00001762 if (!Entry.IsSystemFile)
Argyrios Kyrtzidis7d238572013-03-06 18:12:50 +00001763 ++UserFilesNum;
1764
Douglas Gregor72be3902012-10-19 00:38:02 +00001765 // Emit size/modification time for this file.
Mehdi Amini57a41912015-09-10 01:46:39 +00001766 // And whether this file was overridden.
1767 RecordData::value_type Record[] = {
Richard Smitha8cfffa2015-11-26 02:04:16 +00001768 INPUT_FILE,
1769 InputFileOffsets.size(),
1770 (uint64_t)Entry.File->getSize(),
1771 (uint64_t)getTimestampForOutput(Entry.File),
1772 Entry.BufferOverridden,
Richard Smithf3f84612017-06-29 02:19:42 +00001773 Entry.IsTransient,
1774 Entry.IsTopLevelModuleMap};
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001775
Richard Smith7ed1bc92014-12-05 22:42:13 +00001776 EmitRecordWithPath(IFAbbrevCode, Record, Entry.File->getName());
1777 }
Douglas Gregor49491f72013-03-15 22:15:07 +00001778
Douglas Gregor112b9072012-10-18 05:31:06 +00001779 Stream.ExitBlock();
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001780
1781 // Create input file offsets abbreviation.
David Blaikieb44f0bf2017-01-04 22:36:43 +00001782 auto OffsetsAbbrev = std::make_shared<BitCodeAbbrev>();
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001783 OffsetsAbbrev->Add(BitCodeAbbrevOp(INPUT_FILE_OFFSETS));
1784 OffsetsAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // # input files
Argyrios Kyrtzidis7d238572013-03-06 18:12:50 +00001785 OffsetsAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // # non-system
1786 // input files
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001787 OffsetsAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Array
David Blaikieb44f0bf2017-01-04 22:36:43 +00001788 unsigned OffsetsAbbrevCode = Stream.EmitAbbrev(std::move(OffsetsAbbrev));
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001789
1790 // Write input file offsets.
Mehdi Amini57a41912015-09-10 01:46:39 +00001791 RecordData::value_type Record[] = {INPUT_FILE_OFFSETS,
1792 InputFileOffsets.size(), UserFilesNum};
Reid Kleckner012665e2015-05-21 00:13:09 +00001793 Stream.EmitRecordWithBlob(OffsetsAbbrevCode, Record, bytes(InputFileOffsets));
Douglas Gregor55abb232009-04-10 20:39:37 +00001794}
1795
Douglas Gregora7f71a92009-04-10 03:52:48 +00001796//===----------------------------------------------------------------------===//
1797// Source Manager Serialization
1798//===----------------------------------------------------------------------===//
1799
1800/// \brief Create an abbreviation for the SLocEntry that refers to a
1801/// file.
Douglas Gregor8f45df52009-04-16 22:23:12 +00001802static unsigned CreateSLocFileAbbrev(llvm::BitstreamWriter &Stream) {
Douglas Gregora7f71a92009-04-10 03:52:48 +00001803 using namespace llvm;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00001804
David Blaikieb44f0bf2017-01-04 22:36:43 +00001805 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Sebastian Redl539c5062010-08-18 23:57:32 +00001806 Abbrev->Add(BitCodeAbbrevOp(SM_SLOC_FILE_ENTRY));
Douglas Gregora7f71a92009-04-10 03:52:48 +00001807 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Offset
1808 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Include location
Richard Smithf3f84612017-06-29 02:19:42 +00001809 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 3)); // Characteristic
Douglas Gregora7f71a92009-04-10 03:52:48 +00001810 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Line directives
Douglas Gregorb41ca8f2010-03-21 22:49:54 +00001811 // FileEntry fields.
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001812 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Input File ID
Argyrios Kyrtzidis61ef3db2011-08-21 23:33:04 +00001813 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // NumCreatedFIDs
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00001814 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 24)); // FirstDeclIndex
1815 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // NumDecls
David Blaikieb44f0bf2017-01-04 22:36:43 +00001816 return Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregora7f71a92009-04-10 03:52:48 +00001817}
1818
1819/// \brief Create an abbreviation for the SLocEntry that refers to a
1820/// buffer.
Douglas Gregor8f45df52009-04-16 22:23:12 +00001821static unsigned CreateSLocBufferAbbrev(llvm::BitstreamWriter &Stream) {
Douglas Gregora7f71a92009-04-10 03:52:48 +00001822 using namespace llvm;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00001823
David Blaikieb44f0bf2017-01-04 22:36:43 +00001824 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Sebastian Redl539c5062010-08-18 23:57:32 +00001825 Abbrev->Add(BitCodeAbbrevOp(SM_SLOC_BUFFER_ENTRY));
Douglas Gregora7f71a92009-04-10 03:52:48 +00001826 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Offset
1827 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Include location
Richard Smithf3f84612017-06-29 02:19:42 +00001828 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 3)); // Characteristic
Douglas Gregora7f71a92009-04-10 03:52:48 +00001829 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Line directives
1830 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Buffer name blob
David Blaikieb44f0bf2017-01-04 22:36:43 +00001831 return Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregora7f71a92009-04-10 03:52:48 +00001832}
1833
1834/// \brief Create an abbreviation for the SLocEntry that refers to a
1835/// buffer's blob.
Richard Smithaada85c2016-02-06 02:06:43 +00001836static unsigned CreateSLocBufferBlobAbbrev(llvm::BitstreamWriter &Stream,
1837 bool Compressed) {
Douglas Gregora7f71a92009-04-10 03:52:48 +00001838 using namespace llvm;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00001839
David Blaikieb44f0bf2017-01-04 22:36:43 +00001840 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Richard Smithaada85c2016-02-06 02:06:43 +00001841 Abbrev->Add(BitCodeAbbrevOp(Compressed ? SM_SLOC_BUFFER_BLOB_COMPRESSED
1842 : SM_SLOC_BUFFER_BLOB));
1843 if (Compressed)
1844 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Uncompressed size
Douglas Gregora7f71a92009-04-10 03:52:48 +00001845 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Blob
David Blaikieb44f0bf2017-01-04 22:36:43 +00001846 return Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregora7f71a92009-04-10 03:52:48 +00001847}
1848
Chandler Carruthf92ac9e2011-07-15 07:25:21 +00001849/// \brief Create an abbreviation for the SLocEntry that refers to a macro
1850/// expansion.
1851static unsigned CreateSLocExpansionAbbrev(llvm::BitstreamWriter &Stream) {
Douglas Gregora7f71a92009-04-10 03:52:48 +00001852 using namespace llvm;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00001853
David Blaikieb44f0bf2017-01-04 22:36:43 +00001854 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Chandler Carruthf92ac9e2011-07-15 07:25:21 +00001855 Abbrev->Add(BitCodeAbbrevOp(SM_SLOC_EXPANSION_ENTRY));
Douglas Gregora7f71a92009-04-10 03:52:48 +00001856 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Offset
1857 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Spelling location
1858 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Start location
1859 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // End location
Douglas Gregor83243272009-04-15 18:05:10 +00001860 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Token length
David Blaikieb44f0bf2017-01-04 22:36:43 +00001861 return Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregora7f71a92009-04-10 03:52:48 +00001862}
1863
Douglas Gregor09b69892011-02-10 17:09:37 +00001864namespace {
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +00001865
Douglas Gregor09b69892011-02-10 17:09:37 +00001866 // Trait used for the on-disk hash table of header search information.
1867 class HeaderFileInfoTrait {
1868 ASTWriter &Writer;
Douglas Gregor09b69892011-02-10 17:09:37 +00001869
Douglas Gregor4b123cb2011-07-28 04:50:02 +00001870 // Keep track of the framework names we've used during serialization.
1871 SmallVector<char, 128> FrameworkStringData;
1872 llvm::StringMap<unsigned> FrameworkNameOffset;
1873
Douglas Gregor09b69892011-02-10 17:09:37 +00001874 public:
Richard Smith040e1262017-06-02 01:55:39 +00001875 HeaderFileInfoTrait(ASTWriter &Writer) : Writer(Writer) {}
1876
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +00001877 struct key_type {
Mehdi Amini004b9c72016-10-10 22:52:47 +00001878 StringRef Filename;
Richard Smith040e1262017-06-02 01:55:39 +00001879 off_t Size;
1880 time_t ModTime;
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +00001881 };
1882 typedef const key_type &key_type_ref;
Richard Smith040e1262017-06-02 01:55:39 +00001883
1884 using UnresolvedModule =
1885 llvm::PointerIntPair<Module *, 2, ModuleMap::ModuleHeaderRole>;
Douglas Gregor09b69892011-02-10 17:09:37 +00001886
Richard Smith040e1262017-06-02 01:55:39 +00001887 struct data_type {
1888 const HeaderFileInfo &HFI;
1889 ArrayRef<ModuleMap::KnownHeader> KnownHeaders;
1890 UnresolvedModule Unresolved;
1891 };
Douglas Gregor09b69892011-02-10 17:09:37 +00001892 typedef const data_type &data_type_ref;
Richard Smith040e1262017-06-02 01:55:39 +00001893
Justin Bogner25463f12014-04-18 20:27:24 +00001894 typedef unsigned hash_value_type;
1895 typedef unsigned offset_type;
Douglas Gregor09b69892011-02-10 17:09:37 +00001896
Richard Smithe75ee0f2015-08-17 07:13:32 +00001897 hash_value_type ComputeHash(key_type_ref key) {
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +00001898 // The hash is based only on size/time of the file, so that the reader can
1899 // match even when symlinking or excess path elements ("foo/../", "../")
1900 // change the form of the name. However, complete path is still the key.
Richard Smith040e1262017-06-02 01:55:39 +00001901 return llvm::hash_combine(key.Size, key.ModTime);
Douglas Gregor09b69892011-02-10 17:09:37 +00001902 }
1903
1904 std::pair<unsigned,unsigned>
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +00001905 EmitKeyDataLength(raw_ostream& Out, key_type_ref key, data_type_ref Data) {
Justin Bognere1c147c2014-03-28 22:03:19 +00001906 using namespace llvm::support;
Richard Smith386bb072015-08-18 23:42:23 +00001907 endian::Writer<little> LE(Out);
Mehdi Amini004b9c72016-10-10 22:52:47 +00001908 unsigned KeyLen = key.Filename.size() + 1 + 8 + 8;
Richard Smith386bb072015-08-18 23:42:23 +00001909 LE.write<uint16_t>(KeyLen);
Douglas Gregor4b123cb2011-07-28 04:50:02 +00001910 unsigned DataLen = 1 + 2 + 4 + 4;
Richard Smith040e1262017-06-02 01:55:39 +00001911 for (auto ModInfo : Data.KnownHeaders)
Richard Smith386bb072015-08-18 23:42:23 +00001912 if (Writer.getLocalOrImportedSubmoduleID(ModInfo.getModule()))
1913 DataLen += 4;
Richard Smith040e1262017-06-02 01:55:39 +00001914 if (Data.Unresolved.getPointer())
1915 DataLen += 4;
Richard Smith386bb072015-08-18 23:42:23 +00001916 LE.write<uint8_t>(DataLen);
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +00001917 return std::make_pair(KeyLen, DataLen);
Douglas Gregor09b69892011-02-10 17:09:37 +00001918 }
Richard Smith040e1262017-06-02 01:55:39 +00001919
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +00001920 void EmitKey(raw_ostream& Out, key_type_ref key, unsigned KeyLen) {
Justin Bognere1c147c2014-03-28 22:03:19 +00001921 using namespace llvm::support;
1922 endian::Writer<little> LE(Out);
Richard Smith040e1262017-06-02 01:55:39 +00001923 LE.write<uint64_t>(key.Size);
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +00001924 KeyLen -= 8;
Richard Smith040e1262017-06-02 01:55:39 +00001925 LE.write<uint64_t>(key.ModTime);
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +00001926 KeyLen -= 8;
Mehdi Amini004b9c72016-10-10 22:52:47 +00001927 Out.write(key.Filename.data(), KeyLen);
Douglas Gregor09b69892011-02-10 17:09:37 +00001928 }
Richard Smith040e1262017-06-02 01:55:39 +00001929
Argyrios Kyrtzidisb146baa2013-03-13 21:13:51 +00001930 void EmitData(raw_ostream &Out, key_type_ref key,
Douglas Gregor09b69892011-02-10 17:09:37 +00001931 data_type_ref Data, unsigned DataLen) {
Justin Bognere1c147c2014-03-28 22:03:19 +00001932 using namespace llvm::support;
1933 endian::Writer<little> LE(Out);
Douglas Gregor09b69892011-02-10 17:09:37 +00001934 uint64_t Start = Out.tell(); (void)Start;
1935
Richard Smithf3f84612017-06-29 02:19:42 +00001936 unsigned char Flags = (Data.HFI.isImport << 5)
1937 | (Data.HFI.isPragmaOnce << 4)
Richard Smith040e1262017-06-02 01:55:39 +00001938 | (Data.HFI.DirInfo << 1)
1939 | Data.HFI.IndexHeaderMapHeader;
Justin Bognere1c147c2014-03-28 22:03:19 +00001940 LE.write<uint8_t>(Flags);
Richard Smith040e1262017-06-02 01:55:39 +00001941 LE.write<uint16_t>(Data.HFI.NumIncludes);
Douglas Gregor09b69892011-02-10 17:09:37 +00001942
Richard Smith040e1262017-06-02 01:55:39 +00001943 if (!Data.HFI.ControllingMacro)
1944 LE.write<uint32_t>(Data.HFI.ControllingMacroID);
Douglas Gregor09b69892011-02-10 17:09:37 +00001945 else
Richard Smith040e1262017-06-02 01:55:39 +00001946 LE.write<uint32_t>(Writer.getIdentifierRef(Data.HFI.ControllingMacro));
1947
Douglas Gregor4b123cb2011-07-28 04:50:02 +00001948 unsigned Offset = 0;
Richard Smith040e1262017-06-02 01:55:39 +00001949 if (!Data.HFI.Framework.empty()) {
Douglas Gregor4b123cb2011-07-28 04:50:02 +00001950 // If this header refers into a framework, save the framework name.
1951 llvm::StringMap<unsigned>::iterator Pos
Richard Smith040e1262017-06-02 01:55:39 +00001952 = FrameworkNameOffset.find(Data.HFI.Framework);
Douglas Gregor4b123cb2011-07-28 04:50:02 +00001953 if (Pos == FrameworkNameOffset.end()) {
1954 Offset = FrameworkStringData.size() + 1;
Richard Smith040e1262017-06-02 01:55:39 +00001955 FrameworkStringData.append(Data.HFI.Framework.begin(),
1956 Data.HFI.Framework.end());
Douglas Gregor4b123cb2011-07-28 04:50:02 +00001957 FrameworkStringData.push_back(0);
1958
Richard Smith040e1262017-06-02 01:55:39 +00001959 FrameworkNameOffset[Data.HFI.Framework] = Offset;
Douglas Gregor4b123cb2011-07-28 04:50:02 +00001960 } else
1961 Offset = Pos->second;
1962 }
Justin Bognere1c147c2014-03-28 22:03:19 +00001963 LE.write<uint32_t>(Offset);
Argyrios Kyrtzidisb146baa2013-03-13 21:13:51 +00001964
Richard Smith040e1262017-06-02 01:55:39 +00001965 auto EmitModule = [&](Module *M, ModuleMap::ModuleHeaderRole Role) {
1966 if (uint32_t ModID = Writer.getLocalOrImportedSubmoduleID(M)) {
1967 uint32_t Value = (ModID << 2) | (unsigned)Role;
Richard Smith386bb072015-08-18 23:42:23 +00001968 assert((Value >> 2) == ModID && "overflow in header module info");
1969 LE.write<uint32_t>(Value);
1970 }
Richard Smith040e1262017-06-02 01:55:39 +00001971 };
1972
1973 // FIXME: If the header is excluded, we should write out some
1974 // record of that fact.
1975 for (auto ModInfo : Data.KnownHeaders)
1976 EmitModule(ModInfo.getModule(), ModInfo.getRole());
1977 if (Data.Unresolved.getPointer())
1978 EmitModule(Data.Unresolved.getPointer(), Data.Unresolved.getInt());
Argyrios Kyrtzidisb146baa2013-03-13 21:13:51 +00001979
Douglas Gregor09b69892011-02-10 17:09:37 +00001980 assert(Out.tell() - Start == DataLen && "Wrong data length");
1981 }
Douglas Gregor4b123cb2011-07-28 04:50:02 +00001982
1983 const char *strings_begin() const { return FrameworkStringData.begin(); }
1984 const char *strings_end() const { return FrameworkStringData.end(); }
Douglas Gregor09b69892011-02-10 17:09:37 +00001985 };
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +00001986
Douglas Gregor09b69892011-02-10 17:09:37 +00001987} // end anonymous namespace
1988
1989/// \brief Write the header search block for the list of files that
1990///
1991/// \param HS The header search structure to save.
Richard Smith7ed1bc92014-12-05 22:42:13 +00001992void ASTWriter::WriteHeaderSearch(const HeaderSearch &HS) {
Richard Smith040e1262017-06-02 01:55:39 +00001993 HeaderFileInfoTrait GeneratorTrait(*this);
1994 llvm::OnDiskChainedHashTableGenerator<HeaderFileInfoTrait> Generator;
1995 SmallVector<const char *, 4> SavedStrings;
1996 unsigned NumHeaderSearchEntries = 0;
1997
1998 // Find all unresolved headers for the current module. We generally will
1999 // have resolved them before we get here, but not necessarily: we might be
2000 // compiling a preprocessed module, where there is no requirement for the
2001 // original files to exist any more.
Benjamin Krameree021d52017-06-02 17:30:24 +00002002 const HeaderFileInfo Empty; // So we can take a reference.
Richard Smith040e1262017-06-02 01:55:39 +00002003 if (WritingModule) {
2004 llvm::SmallVector<Module *, 16> Worklist(1, WritingModule);
2005 while (!Worklist.empty()) {
2006 Module *M = Worklist.pop_back_val();
2007 if (!M->isAvailable())
2008 continue;
2009
2010 // Map to disk files where possible, to pick up any missing stat
2011 // information. This also means we don't need to check the unresolved
2012 // headers list when emitting resolved headers in the first loop below.
2013 // FIXME: It'd be preferable to avoid doing this if we were given
2014 // sufficient stat information in the module map.
2015 HS.getModuleMap().resolveHeaderDirectives(M);
2016
2017 // If the file didn't exist, we can still create a module if we were given
2018 // enough information in the module map.
2019 for (auto U : M->MissingHeaders) {
2020 // Check that we were given enough information to build a module
2021 // without this file existing on disk.
2022 if (!U.Size || (!U.ModTime && IncludeTimestamps)) {
2023 PP->Diag(U.FileNameLoc, diag::err_module_no_size_mtime_for_header)
2024 << WritingModule->getFullModuleName() << U.Size.hasValue()
2025 << U.FileName;
2026 continue;
2027 }
2028
2029 // Form the effective relative pathname for the file.
2030 SmallString<128> Filename(M->Directory->getName());
2031 llvm::sys::path::append(Filename, U.FileName);
2032 PreparePathForOutput(Filename);
2033
2034 StringRef FilenameDup = strdup(Filename.c_str());
2035 SavedStrings.push_back(FilenameDup.data());
2036
2037 HeaderFileInfoTrait::key_type Key = {
2038 FilenameDup, *U.Size, IncludeTimestamps ? *U.ModTime : 0
2039 };
2040 HeaderFileInfoTrait::data_type Data = {
Benjamin Krameree021d52017-06-02 17:30:24 +00002041 Empty, {}, {M, ModuleMap::headerKindToRole(U.Kind)}
Richard Smith040e1262017-06-02 01:55:39 +00002042 };
2043 // FIXME: Deal with cases where there are multiple unresolved header
2044 // directives in different submodules for the same header.
2045 Generator.insert(Key, Data, GeneratorTrait);
2046 ++NumHeaderSearchEntries;
2047 }
2048
2049 Worklist.append(M->submodule_begin(), M->submodule_end());
2050 }
2051 }
2052
Chris Lattner0e62c1c2011-07-23 10:55:15 +00002053 SmallVector<const FileEntry *, 16> FilesByUID;
Douglas Gregor09b69892011-02-10 17:09:37 +00002054 HS.getFileMgr().GetUniqueIDMapping(FilesByUID);
2055
2056 if (FilesByUID.size() > HS.header_file_size())
2057 FilesByUID.resize(HS.header_file_size());
Richard Smith040e1262017-06-02 01:55:39 +00002058
Douglas Gregor09b69892011-02-10 17:09:37 +00002059 for (unsigned UID = 0, LastUID = FilesByUID.size(); UID != LastUID; ++UID) {
2060 const FileEntry *File = FilesByUID[UID];
2061 if (!File)
2062 continue;
2063
Richard Smith386bb072015-08-18 23:42:23 +00002064 // Get the file info. This will load info from the external source if
2065 // necessary. Skip emitting this file if we have no information on it
2066 // as a header file (in which case HFI will be null) or if it hasn't
2067 // changed since it was loaded. Also skip it if it's for a modular header
2068 // from a different module; in that case, we rely on the module(s)
2069 // containing the header to provide this information.
Richard Smithd8879c82015-08-24 21:59:32 +00002070 const HeaderFileInfo *HFI =
2071 HS.getExistingFileInfo(File, /*WantExternal*/!Chain);
2072 if (!HFI || (HFI->isModuleHeader && !HFI->isCompilingModuleHeader))
Argyrios Kyrtzidis6f722b42013-05-08 23:46:46 +00002073 continue;
Douglas Gregor09b69892011-02-10 17:09:37 +00002074
Richard Smith7ed1bc92014-12-05 22:42:13 +00002075 // Massage the file path into an appropriate form.
Mehdi Amini004b9c72016-10-10 22:52:47 +00002076 StringRef Filename = File->getName();
Richard Smith7ed1bc92014-12-05 22:42:13 +00002077 SmallString<128> FilenameTmp(Filename);
2078 if (PreparePathForOutput(FilenameTmp)) {
2079 // If we performed any translation on the file name at all, we need to
2080 // save this string, since the generator will refer to it later.
Mehdi Amini004b9c72016-10-10 22:52:47 +00002081 Filename = StringRef(strdup(FilenameTmp.c_str()));
2082 SavedStrings.push_back(Filename.data());
Douglas Gregor09b69892011-02-10 17:09:37 +00002083 }
Richard Smith7ed1bc92014-12-05 22:42:13 +00002084
Richard Smith040e1262017-06-02 01:55:39 +00002085 HeaderFileInfoTrait::key_type Key = {
2086 Filename, File->getSize(), getTimestampForOutput(File)
2087 };
2088 HeaderFileInfoTrait::data_type Data = {
2089 *HFI, HS.getModuleMap().findAllModulesForHeader(File), {}
2090 };
2091 Generator.insert(Key, Data, GeneratorTrait);
Douglas Gregor09b69892011-02-10 17:09:37 +00002092 ++NumHeaderSearchEntries;
2093 }
Richard Smith040e1262017-06-02 01:55:39 +00002094
Douglas Gregor09b69892011-02-10 17:09:37 +00002095 // Create the on-disk hash table in a buffer.
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00002096 SmallString<4096> TableData;
Douglas Gregor09b69892011-02-10 17:09:37 +00002097 uint32_t BucketOffset;
2098 {
Justin Bognere1c147c2014-03-28 22:03:19 +00002099 using namespace llvm::support;
Douglas Gregor09b69892011-02-10 17:09:37 +00002100 llvm::raw_svector_ostream Out(TableData);
2101 // Make sure that no bucket is at offset 0
Justin Bognere1c147c2014-03-28 22:03:19 +00002102 endian::Writer<little>(Out).write<uint32_t>(0);
Douglas Gregor09b69892011-02-10 17:09:37 +00002103 BucketOffset = Generator.Emit(Out, GeneratorTrait);
2104 }
2105
2106 // Create a blob abbreviation
2107 using namespace llvm;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002108
David Blaikieb44f0bf2017-01-04 22:36:43 +00002109 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Douglas Gregor09b69892011-02-10 17:09:37 +00002110 Abbrev->Add(BitCodeAbbrevOp(HEADER_SEARCH_TABLE));
2111 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
2112 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
Douglas Gregor4b123cb2011-07-28 04:50:02 +00002113 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
Douglas Gregor09b69892011-02-10 17:09:37 +00002114 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
David Blaikieb44f0bf2017-01-04 22:36:43 +00002115 unsigned TableAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregor09b69892011-02-10 17:09:37 +00002116
Douglas Gregor4b123cb2011-07-28 04:50:02 +00002117 // Write the header search table
Mehdi Amini57a41912015-09-10 01:46:39 +00002118 RecordData::value_type Record[] = {HEADER_SEARCH_TABLE, BucketOffset,
2119 NumHeaderSearchEntries, TableData.size()};
Douglas Gregor4b123cb2011-07-28 04:50:02 +00002120 TableData.append(GeneratorTrait.strings_begin(),GeneratorTrait.strings_end());
Yaron Keren92e1b622015-03-18 10:17:07 +00002121 Stream.EmitRecordWithBlob(TableAbbrev, Record, TableData);
Douglas Gregor09b69892011-02-10 17:09:37 +00002122
2123 // Free all of the strings we had to duplicate.
2124 for (unsigned I = 0, N = SavedStrings.size(); I != N; ++I)
David Greenebae0e352013-01-15 22:09:43 +00002125 free(const_cast<char *>(SavedStrings[I]));
Douglas Gregor09b69892011-02-10 17:09:37 +00002126}
2127
George Rimarc39f5492017-01-17 15:45:31 +00002128static void emitBlob(llvm::BitstreamWriter &Stream, StringRef Blob,
2129 unsigned SLocBufferBlobCompressedAbbrv,
2130 unsigned SLocBufferBlobAbbrv) {
2131 typedef ASTWriter::RecordData::value_type RecordDataType;
2132
2133 // Compress the buffer if possible. We expect that almost all PCM
2134 // consumers will not want its contents.
2135 SmallString<0> CompressedBuffer;
2136 if (llvm::zlib::isAvailable()) {
2137 llvm::Error E = llvm::zlib::compress(Blob.drop_back(1), CompressedBuffer);
2138 if (!E) {
2139 RecordDataType Record[] = {SM_SLOC_BUFFER_BLOB_COMPRESSED,
2140 Blob.size() - 1};
2141 Stream.EmitRecordWithBlob(SLocBufferBlobCompressedAbbrv, Record,
2142 CompressedBuffer);
2143 return;
2144 }
2145 llvm::consumeError(std::move(E));
2146 }
2147
2148 RecordDataType Record[] = {SM_SLOC_BUFFER_BLOB};
2149 Stream.EmitRecordWithBlob(SLocBufferBlobAbbrv, Record, Blob);
2150}
2151
Douglas Gregora7f71a92009-04-10 03:52:48 +00002152/// \brief Writes the block containing the serialized form of the
2153/// source manager.
2154///
2155/// TODO: We should probably use an on-disk hash table (stored in a
2156/// blob), indexed based on the file name, so that we only create
2157/// entries for files that we actually need. In the common case (no
2158/// errors), we probably won't have to create file entries for any of
2159/// the files in the AST.
Sebastian Redl55c0ad52010-08-18 23:56:21 +00002160void ASTWriter::WriteSourceManagerBlock(SourceManager &SourceMgr,
Richard Smith7ed1bc92014-12-05 22:42:13 +00002161 const Preprocessor &PP) {
Douglas Gregor258ae542009-04-27 06:38:32 +00002162 RecordData Record;
2163
Chris Lattner0910e3b2009-04-10 17:16:57 +00002164 // Enter the source manager block.
Richard Smithaada85c2016-02-06 02:06:43 +00002165 Stream.EnterSubblock(SOURCE_MANAGER_BLOCK_ID, 4);
Douglas Gregora7f71a92009-04-10 03:52:48 +00002166
2167 // Abbreviations for the various kinds of source-location entries.
Chris Lattnerc4976c732009-04-27 19:03:22 +00002168 unsigned SLocFileAbbrv = CreateSLocFileAbbrev(Stream);
2169 unsigned SLocBufferAbbrv = CreateSLocBufferAbbrev(Stream);
Richard Smithaada85c2016-02-06 02:06:43 +00002170 unsigned SLocBufferBlobAbbrv = CreateSLocBufferBlobAbbrev(Stream, false);
2171 unsigned SLocBufferBlobCompressedAbbrv =
2172 CreateSLocBufferBlobAbbrev(Stream, true);
Chandler Carruthf92ac9e2011-07-15 07:25:21 +00002173 unsigned SLocExpansionAbbrv = CreateSLocExpansionAbbrev(Stream);
Douglas Gregora7f71a92009-04-10 03:52:48 +00002174
Douglas Gregor258ae542009-04-27 06:38:32 +00002175 // Write out the source location entry table. We skip the first
2176 // entry, which is always the same dummy entry.
Chris Lattner12d61d32009-04-27 19:01:47 +00002177 std::vector<uint32_t> SLocEntryOffsets;
Douglas Gregor258ae542009-04-27 06:38:32 +00002178 RecordData PreloadSLocs;
Douglas Gregor925296b2011-07-19 16:10:42 +00002179 SLocEntryOffsets.reserve(SourceMgr.local_sloc_entry_size() - 1);
2180 for (unsigned I = 1, N = SourceMgr.local_sloc_entry_size();
Sebastian Redl5c415f32010-07-22 17:01:13 +00002181 I != N; ++I) {
Douglas Gregor8655e882009-10-16 22:46:09 +00002182 // Get this source location entry.
Douglas Gregor925296b2011-07-19 16:10:42 +00002183 const SrcMgr::SLocEntry *SLoc = &SourceMgr.getLocalSLocEntry(I);
Argyrios Kyrtzidis4db774a2012-10-02 21:09:17 +00002184 FileID FID = FileID::get(I);
2185 assert(&SourceMgr.getSLocEntry(FID) == SLoc);
Kovarththanan Rajaratnama9c81a82010-03-14 07:06:50 +00002186
Douglas Gregor258ae542009-04-27 06:38:32 +00002187 // Record the offset of this source-location entry.
2188 SLocEntryOffsets.push_back(Stream.GetCurrentBitNo());
2189
2190 // Figure out which record code to use.
2191 unsigned Code;
2192 if (SLoc->isFile()) {
Douglas Gregor9dc32122011-11-16 20:05:18 +00002193 const SrcMgr::ContentCache *Cache = SLoc->getFile().getContentCache();
2194 if (Cache->OrigEntry) {
Sebastian Redl539c5062010-08-18 23:57:32 +00002195 Code = SM_SLOC_FILE_ENTRY;
Argyrios Kyrtzidis92dd4662011-06-02 20:01:46 +00002196 } else
Sebastian Redl539c5062010-08-18 23:57:32 +00002197 Code = SM_SLOC_BUFFER_ENTRY;
Douglas Gregor258ae542009-04-27 06:38:32 +00002198 } else
Chandler Carruthf92ac9e2011-07-15 07:25:21 +00002199 Code = SM_SLOC_EXPANSION_ENTRY;
Douglas Gregor258ae542009-04-27 06:38:32 +00002200 Record.clear();
2201 Record.push_back(Code);
2202
Douglas Gregor925296b2011-07-19 16:10:42 +00002203 // Starting offset of this entry within this module, so skip the dummy.
2204 Record.push_back(SLoc->getOffset() - 2);
Douglas Gregor258ae542009-04-27 06:38:32 +00002205 if (SLoc->isFile()) {
2206 const SrcMgr::FileInfo &File = SLoc->getFile();
Richard Smithb22a1d12016-03-27 20:13:24 +00002207 AddSourceLocation(File.getIncludeLoc(), Record);
Douglas Gregor258ae542009-04-27 06:38:32 +00002208 Record.push_back(File.getFileCharacteristic()); // FIXME: stable encoding
2209 Record.push_back(File.hasLineDirectives());
2210
2211 const SrcMgr::ContentCache *Content = File.getContentCache();
Richard Smithaada85c2016-02-06 02:06:43 +00002212 bool EmitBlob = false;
Argyrios Kyrtzidis11e6f0a2011-03-05 01:03:53 +00002213 if (Content->OrigEntry) {
2214 assert(Content->OrigEntry == Content->ContentsEntry &&
Douglas Gregor9dc32122011-11-16 20:05:18 +00002215 "Writing to AST an overridden file is not supported");
Argyrios Kyrtzidis11e6f0a2011-03-05 01:03:53 +00002216
Douglas Gregor3120d2c2012-10-22 18:42:04 +00002217 // The source location entry is a file. Emit input file ID.
2218 assert(InputFileIDs[Content->OrigEntry] != 0 && "Missed file entry");
2219 Record.push_back(InputFileIDs[Content->OrigEntry]);
Mike Stump11289f42009-09-09 15:08:12 +00002220
Argyrios Kyrtzidis61ef3db2011-08-21 23:33:04 +00002221 Record.push_back(File.NumCreatedFIDs);
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00002222
Argyrios Kyrtzidis4db774a2012-10-02 21:09:17 +00002223 FileDeclIDsTy::iterator FDI = FileDeclIDs.find(FID);
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00002224 if (FDI != FileDeclIDs.end()) {
2225 Record.push_back(FDI->second->FirstDeclIndex);
2226 Record.push_back(FDI->second->DeclIDs.size());
2227 } else {
2228 Record.push_back(0);
2229 Record.push_back(0);
2230 }
Mehdi Amini5ae4a852015-09-09 20:35:37 +00002231
2232 Stream.EmitRecordWithAbbrev(SLocFileAbbrv, Record);
2233
Richard Smithaada85c2016-02-06 02:06:43 +00002234 if (Content->BufferOverridden || Content->IsTransient)
2235 EmitBlob = true;
Douglas Gregor258ae542009-04-27 06:38:32 +00002236 } else {
2237 // The source location entry is a buffer. The blob associated
2238 // with this entry contains the contents of the buffer.
2239
2240 // We add one to the size so that we capture the trailing NULL
2241 // that is required by llvm::MemoryBuffer::getMemBuffer (on
2242 // the reader side).
Douglas Gregor874cc622010-03-16 00:35:39 +00002243 const llvm::MemoryBuffer *Buffer
Chris Lattnerfb24a3a2010-04-20 20:35:58 +00002244 = Content->getBuffer(PP.getDiagnostics(), PP.getSourceManager());
Mehdi Amini99d1b292016-10-01 16:38:28 +00002245 StringRef Name = Buffer->getBufferIdentifier();
Mehdi Amini5ae4a852015-09-09 20:35:37 +00002246 Stream.EmitRecordWithBlob(SLocBufferAbbrv, Record,
Mehdi Amini99d1b292016-10-01 16:38:28 +00002247 StringRef(Name.data(), Name.size() + 1));
Richard Smithaada85c2016-02-06 02:06:43 +00002248 EmitBlob = true;
Douglas Gregor258ae542009-04-27 06:38:32 +00002249
Mehdi Amini99d1b292016-10-01 16:38:28 +00002250 if (Name == "<built-in>")
Douglas Gregor925296b2011-07-19 16:10:42 +00002251 PreloadSLocs.push_back(SLocEntryOffsets.size());
Douglas Gregor258ae542009-04-27 06:38:32 +00002252 }
Richard Smithaada85c2016-02-06 02:06:43 +00002253
2254 if (EmitBlob) {
2255 // Include the implicit terminating null character in the on-disk buffer
2256 // if we're writing it uncompressed.
2257 const llvm::MemoryBuffer *Buffer =
2258 Content->getBuffer(PP.getDiagnostics(), PP.getSourceManager());
2259 StringRef Blob(Buffer->getBufferStart(), Buffer->getBufferSize() + 1);
George Rimarc39f5492017-01-17 15:45:31 +00002260 emitBlob(Stream, Blob, SLocBufferBlobCompressedAbbrv,
2261 SLocBufferBlobAbbrv);
Richard Smithaada85c2016-02-06 02:06:43 +00002262 }
Douglas Gregor258ae542009-04-27 06:38:32 +00002263 } else {
Chandler Carruthf92ac9e2011-07-15 07:25:21 +00002264 // The source location entry is a macro expansion.
Chandler Carruthee4c1d12011-07-26 04:56:51 +00002265 const SrcMgr::ExpansionInfo &Expansion = SLoc->getExpansion();
Richard Smithb22a1d12016-03-27 20:13:24 +00002266 AddSourceLocation(Expansion.getSpellingLoc(), Record);
2267 AddSourceLocation(Expansion.getExpansionLocStart(), Record);
2268 AddSourceLocation(Expansion.isMacroArgExpansion()
2269 ? SourceLocation()
2270 : Expansion.getExpansionLocEnd(),
2271 Record);
Douglas Gregor258ae542009-04-27 06:38:32 +00002272
2273 // Compute the token length for this macro expansion.
Douglas Gregor925296b2011-07-19 16:10:42 +00002274 unsigned NextOffset = SourceMgr.getNextLocalOffset();
Douglas Gregor8655e882009-10-16 22:46:09 +00002275 if (I + 1 != N)
Douglas Gregor925296b2011-07-19 16:10:42 +00002276 NextOffset = SourceMgr.getLocalSLocEntry(I + 1).getOffset();
Douglas Gregor258ae542009-04-27 06:38:32 +00002277 Record.push_back(NextOffset - SLoc->getOffset() - 1);
Mehdi Amini5ae4a852015-09-09 20:35:37 +00002278 Stream.EmitRecordWithAbbrev(SLocExpansionAbbrv, Record);
Douglas Gregor258ae542009-04-27 06:38:32 +00002279 }
2280 }
2281
Douglas Gregor8f45df52009-04-16 22:23:12 +00002282 Stream.ExitBlock();
Douglas Gregor258ae542009-04-27 06:38:32 +00002283
2284 if (SLocEntryOffsets.empty())
2285 return;
2286
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00002287 // Write the source-location offsets table into the AST block. This
Douglas Gregor258ae542009-04-27 06:38:32 +00002288 // table is used for lazily loading source-location information.
2289 using namespace llvm;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002290
David Blaikieb44f0bf2017-01-04 22:36:43 +00002291 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Sebastian Redl539c5062010-08-18 23:57:32 +00002292 Abbrev->Add(BitCodeAbbrevOp(SOURCE_LOCATION_OFFSETS));
Douglas Gregor258ae542009-04-27 06:38:32 +00002293 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 16)); // # of slocs
Douglas Gregor925296b2011-07-19 16:10:42 +00002294 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 16)); // total size
Douglas Gregor258ae542009-04-27 06:38:32 +00002295 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // offsets
David Blaikieb44f0bf2017-01-04 22:36:43 +00002296 unsigned SLocOffsetsAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Mehdi Amini57a41912015-09-10 01:46:39 +00002297 {
2298 RecordData::value_type Record[] = {
2299 SOURCE_LOCATION_OFFSETS, SLocEntryOffsets.size(),
2300 SourceMgr.getNextLocalOffset() - 1 /* skip dummy */};
2301 Stream.EmitRecordWithBlob(SLocOffsetsAbbrev, Record,
2302 bytes(SLocEntryOffsets));
2303 }
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00002304 // Write the source location entry preloads array, telling the AST
Douglas Gregor258ae542009-04-27 06:38:32 +00002305 // reader which source locations entries it should load eagerly.
Sebastian Redl539c5062010-08-18 23:57:32 +00002306 Stream.EmitRecord(SOURCE_LOCATION_PRELOADS, PreloadSLocs);
Douglas Gregor925296b2011-07-19 16:10:42 +00002307
2308 // Write the line table. It depends on remapping working, so it must come
2309 // after the source location offsets.
2310 if (SourceMgr.hasLineTable()) {
2311 LineTableInfo &LineTable = SourceMgr.getLineTable();
2312
2313 Record.clear();
Richard Smith63078492015-09-01 07:41:55 +00002314
2315 // Emit the needed file names.
2316 llvm::DenseMap<int, int> FilenameMap;
2317 for (const auto &L : LineTable) {
2318 if (L.first.ID < 0)
2319 continue;
2320 for (auto &LE : L.second) {
2321 if (FilenameMap.insert(std::make_pair(LE.FilenameID,
2322 FilenameMap.size())).second)
2323 AddPath(LineTable.getFilename(LE.FilenameID), Record);
2324 }
2325 }
2326 Record.push_back(0);
Douglas Gregor925296b2011-07-19 16:10:42 +00002327
2328 // Emit the line entries
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002329 for (const auto &L : LineTable) {
Douglas Gregor925296b2011-07-19 16:10:42 +00002330 // Only emit entries for local files.
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002331 if (L.first.ID < 0)
Douglas Gregor925296b2011-07-19 16:10:42 +00002332 continue;
2333
2334 // Emit the file ID
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002335 Record.push_back(L.first.ID);
Douglas Gregor925296b2011-07-19 16:10:42 +00002336
2337 // Emit the line entries
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002338 Record.push_back(L.second.size());
2339 for (const auto &LE : L.second) {
2340 Record.push_back(LE.FileOffset);
2341 Record.push_back(LE.LineNo);
2342 Record.push_back(FilenameMap[LE.FilenameID]);
2343 Record.push_back((unsigned)LE.FileKind);
2344 Record.push_back(LE.IncludeOffset);
Douglas Gregor925296b2011-07-19 16:10:42 +00002345 }
2346 }
Richard Smith63078492015-09-01 07:41:55 +00002347
Douglas Gregor925296b2011-07-19 16:10:42 +00002348 Stream.EmitRecord(SOURCE_MANAGER_LINE_TABLE, Record);
2349 }
Douglas Gregora7f71a92009-04-10 03:52:48 +00002350}
2351
Douglas Gregorc5046832009-04-27 18:38:38 +00002352//===----------------------------------------------------------------------===//
2353// Preprocessor Serialization
2354//===----------------------------------------------------------------------===//
2355
Argyrios Kyrtzidis0aef0f02013-03-15 22:43:10 +00002356static bool shouldIgnoreMacro(MacroDirective *MD, bool IsModule,
2357 const Preprocessor &PP) {
Argyrios Kyrtzidisb6210df2013-03-26 17:17:01 +00002358 if (MacroInfo *MI = MD->getMacroInfo())
2359 if (MI->isBuiltinMacro())
2360 return true;
Argyrios Kyrtzidis0aef0f02013-03-15 22:43:10 +00002361
2362 if (IsModule) {
2363 SourceLocation Loc = MD->getLocation();
2364 if (Loc.isInvalid())
2365 return true;
2366 if (PP.getSourceManager().getFileID(Loc) == PP.getPredefinesFileID())
2367 return true;
2368 }
2369
2370 return false;
2371}
2372
Chris Lattnereeffaef2009-04-10 17:15:23 +00002373/// \brief Writes the block containing the serialized form of the
2374/// preprocessor.
2375///
Douglas Gregor4a69c2e2011-09-01 17:04:32 +00002376void ASTWriter::WritePreprocessor(const Preprocessor &PP, bool IsModule) {
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002377 PreprocessingRecord *PPRec = PP.getPreprocessingRecord();
2378 if (PPRec)
2379 WritePreprocessorDetail(*PPRec);
2380
Chris Lattnerbaa52f42009-04-10 18:00:12 +00002381 RecordData Record;
Richard Smithd7329392015-04-21 21:46:32 +00002382 RecordData ModuleMacroRecord;
Chris Lattner0910e3b2009-04-10 17:16:57 +00002383
Chris Lattner0af3ba12009-04-13 01:29:17 +00002384 // If the preprocessor __COUNTER__ value has been bumped, remember it.
2385 if (PP.getCounterValue() != 0) {
Mehdi Amini57a41912015-09-10 01:46:39 +00002386 RecordData::value_type Record[] = {PP.getCounterValue()};
Sebastian Redl539c5062010-08-18 23:57:32 +00002387 Stream.EmitRecord(PP_COUNTER_VALUE, Record);
Douglas Gregoreda6a892009-04-26 00:07:37 +00002388 }
2389
Erik Verbruggenb34c79f2017-05-30 11:54:55 +00002390 if (PP.isRecordingPreamble() && PP.hasRecordedPreamble()) {
2391 assert(!IsModule);
2392 for (const auto &Cond : PP.getPreambleConditionalStack()) {
2393 AddSourceLocation(Cond.IfLoc, Record);
2394 Record.push_back(Cond.WasSkipping);
2395 Record.push_back(Cond.FoundNonSkip);
2396 Record.push_back(Cond.FoundElse);
2397 }
2398 Stream.EmitRecord(PP_CONDITIONAL_STACK, Record);
2399 Record.clear();
2400 }
2401
Douglas Gregoreda6a892009-04-26 00:07:37 +00002402 // Enter the preprocessor block.
Douglas Gregor796d76a2010-10-20 22:00:55 +00002403 Stream.EnterSubblock(PREPROCESSOR_BLOCK_ID, 3);
Mike Stump11289f42009-09-09 15:08:12 +00002404
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00002405 // If the AST file contains __DATE__ or __TIME__ emit a warning about this.
Richard Smithb5aaf5a2015-09-01 02:35:58 +00002406 // FIXME: Include a location for the use, and say which one was used.
Douglas Gregoreda6a892009-04-26 00:07:37 +00002407 if (PP.SawDateOrTime())
Richard Smithb5aaf5a2015-09-01 02:35:58 +00002408 PP.Diag(SourceLocation(), diag::warn_module_uses_date_time) << IsModule;
Douglas Gregor796d76a2010-10-20 22:00:55 +00002409
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002410 // Loop over all the macro directives that are live at the end of the file,
Chris Lattnerbaa52f42009-04-10 18:00:12 +00002411 // emitting each to the PP section.
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00002412
Richard Smithee977932015-05-01 21:22:17 +00002413 // Construct the list of identifiers with macro directives that need to be
2414 // serialized.
2415 SmallVector<const IdentifierInfo *, 128> MacroIdentifiers;
2416 for (auto &Id : PP.getIdentifierTable())
2417 if (Id.second->hadMacroDefinition() &&
2418 (!Id.second->isFromAST() ||
2419 Id.second->hasChangedSinceDeserialization()))
2420 MacroIdentifiers.push_back(Id.second);
Douglas Gregor2e5571d2011-02-10 18:20:09 +00002421 // Sort the set of macro definitions that need to be serialized by the
2422 // name of the macro, to provide a stable ordering.
Richard Smithee977932015-05-01 21:22:17 +00002423 std::sort(MacroIdentifiers.begin(), MacroIdentifiers.end(),
2424 llvm::less_ptr<IdentifierInfo>());
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002425
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002426 // Emit the macro directives as a list and associate the offset with the
2427 // identifier they belong to.
Richard Smithee977932015-05-01 21:22:17 +00002428 for (const IdentifierInfo *Name : MacroIdentifiers) {
2429 MacroDirective *MD = PP.getLocalMacroDirectiveHistory(Name);
Richard Smithd7329392015-04-21 21:46:32 +00002430 auto StartOffset = Stream.GetCurrentBitNo();
2431
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002432 // Emit the macro directives in reverse source order.
2433 for (; MD; MD = MD->getPrevious()) {
Richard Smithd7329392015-04-21 21:46:32 +00002434 // Once we hit an ignored macro, we're done: the rest of the chain
2435 // will all be ignored macros.
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002436 if (shouldIgnoreMacro(MD, IsModule, PP))
Richard Smithd7329392015-04-21 21:46:32 +00002437 break;
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002438
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002439 AddSourceLocation(MD->getLocation(), Record);
Argyrios Kyrtzidisb6210df2013-03-26 17:17:01 +00002440 Record.push_back(MD->getKind());
Richard Smithdaa69e02014-07-25 04:40:03 +00002441 if (auto *DefMD = dyn_cast<DefMacroDirective>(MD)) {
Richard Smith3981b172015-04-30 02:16:23 +00002442 Record.push_back(getMacroRef(DefMD->getInfo(), Name));
Richard Smith713369b2015-04-23 20:40:50 +00002443 } else if (auto *VisMD = dyn_cast<VisibilityMacroDirective>(MD)) {
Argyrios Kyrtzidisb6210df2013-03-26 17:17:01 +00002444 Record.push_back(VisMD->isPublic());
2445 }
Richard Smithb8b2ed62015-04-23 18:18:26 +00002446 }
Richard Smithd7329392015-04-21 21:46:32 +00002447
Richard Smithb8b2ed62015-04-23 18:18:26 +00002448 // Write out any exported module macros.
Richard Smithee977932015-05-01 21:22:17 +00002449 bool EmittedModuleMacros = false;
Manman Ren33d80292016-05-31 18:19:32 +00002450 // We write out exported module macros for PCH as well.
2451 auto Leafs = PP.getLeafModuleMacros(Name);
2452 SmallVector<ModuleMacro*, 8> Worklist(Leafs.begin(), Leafs.end());
2453 llvm::DenseMap<ModuleMacro*, unsigned> Visits;
2454 while (!Worklist.empty()) {
2455 auto *Macro = Worklist.pop_back_val();
Richard Smithd7329392015-04-21 21:46:32 +00002456
Manman Ren33d80292016-05-31 18:19:32 +00002457 // Emit a record indicating this submodule exports this macro.
2458 ModuleMacroRecord.push_back(
2459 getSubmoduleID(Macro->getOwningModule()));
2460 ModuleMacroRecord.push_back(getMacroRef(Macro->getMacroInfo(), Name));
2461 for (auto *M : Macro->overrides())
2462 ModuleMacroRecord.push_back(getSubmoduleID(M->getOwningModule()));
Richard Smithd7329392015-04-21 21:46:32 +00002463
Manman Ren33d80292016-05-31 18:19:32 +00002464 Stream.EmitRecord(PP_MODULE_MACRO, ModuleMacroRecord);
2465 ModuleMacroRecord.clear();
Richard Smithd7329392015-04-21 21:46:32 +00002466
Manman Ren33d80292016-05-31 18:19:32 +00002467 // Enqueue overridden macros once we've visited all their ancestors.
2468 for (auto *M : Macro->overrides())
2469 if (++Visits[M] == M->getNumOverridingMacros())
2470 Worklist.push_back(M);
Richard Smithee977932015-05-01 21:22:17 +00002471
Manman Ren33d80292016-05-31 18:19:32 +00002472 EmittedModuleMacros = true;
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002473 }
Richard Smithd7329392015-04-21 21:46:32 +00002474
Richard Smithee977932015-05-01 21:22:17 +00002475 if (Record.empty() && !EmittedModuleMacros)
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002476 continue;
2477
Richard Smithd7329392015-04-21 21:46:32 +00002478 IdentMacroDirectivesOffsetMap[Name] = StartOffset;
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002479 Stream.EmitRecord(PP_MACRO_DIRECTIVE_HISTORY, Record);
2480 Record.clear();
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002481 }
Alexander Kornienko1d26c022012-09-25 17:18:14 +00002482
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00002483 /// \brief Offsets of each of the macros into the bitstream, indexed by
2484 /// the local macro ID
2485 ///
2486 /// For each identifier that is associated with a macro, this map
2487 /// provides the offset into the bitstream where that macro is
2488 /// defined.
2489 std::vector<uint32_t> MacroOffsets;
2490
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002491 for (unsigned I = 0, N = MacroInfosToEmit.size(); I != N; ++I) {
2492 const IdentifierInfo *Name = MacroInfosToEmit[I].Name;
2493 MacroInfo *MI = MacroInfosToEmit[I].MI;
2494 MacroID ID = MacroInfosToEmit[I].ID;
Douglas Gregoreb114da2010-10-01 01:03:07 +00002495
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002496 if (ID < FirstMacroID) {
2497 assert(0 && "Loaded MacroInfo entered MacroInfosToEmit ?");
2498 continue;
Chris Lattner2199f5b2009-04-10 18:08:30 +00002499 }
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002500
2501 // Record the local offset of this macro.
2502 unsigned Index = ID - FirstMacroID;
2503 if (Index == MacroOffsets.size())
2504 MacroOffsets.push_back(Stream.GetCurrentBitNo());
2505 else {
2506 if (Index > MacroOffsets.size())
2507 MacroOffsets.resize(Index + 1);
2508
2509 MacroOffsets[Index] = Stream.GetCurrentBitNo();
2510 }
2511
2512 AddIdentifierRef(Name, Record);
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002513 AddSourceLocation(MI->getDefinitionLoc(), Record);
2514 AddSourceLocation(MI->getDefinitionEndLoc(), Record);
2515 Record.push_back(MI->isUsed());
Argyrios Kyrtzidis9ef53ce2014-04-09 18:21:23 +00002516 Record.push_back(MI->isUsedForHeaderGuard());
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002517 unsigned Code;
2518 if (MI->isObjectLike()) {
2519 Code = PP_MACRO_OBJECT_LIKE;
2520 } else {
2521 Code = PP_MACRO_FUNCTION_LIKE;
2522
2523 Record.push_back(MI->isC99Varargs());
2524 Record.push_back(MI->isGNUVarargs());
2525 Record.push_back(MI->hasCommaPasting());
Faisal Valiac506d72017-07-17 17:18:43 +00002526 Record.push_back(MI->getNumParams());
2527 for (const IdentifierInfo *Param : MI->params())
2528 AddIdentifierRef(Param, Record);
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002529 }
2530
2531 // If we have a detailed preprocessing record, record the macro definition
2532 // ID that corresponds to this macro.
2533 if (PPRec)
2534 Record.push_back(MacroDefinitions[PPRec->findMacroDefinition(MI)]);
2535
2536 Stream.EmitRecord(Code, Record);
2537 Record.clear();
2538
2539 // Emit the tokens array.
2540 for (unsigned TokNo = 0, e = MI->getNumTokens(); TokNo != e; ++TokNo) {
2541 // Note that we know that the preprocessor does not have any annotation
2542 // tokens in it because they are created by the parser, and thus can't
2543 // be in a macro definition.
2544 const Token &Tok = MI->getReplacementToken(TokNo);
John McCallf413f5e2013-05-03 00:10:13 +00002545 AddToken(Tok, Record);
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002546 Stream.EmitRecord(PP_TOKEN, Record);
2547 Record.clear();
2548 }
2549 ++NumMacros;
Chris Lattnerbaa52f42009-04-10 18:00:12 +00002550 }
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002551
Douglas Gregor92a96f52011-02-08 21:58:10 +00002552 Stream.ExitBlock();
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00002553
2554 // Write the offsets table for macro IDs.
2555 using namespace llvm;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002556
David Blaikieb44f0bf2017-01-04 22:36:43 +00002557 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00002558 Abbrev->Add(BitCodeAbbrevOp(MACRO_OFFSET));
2559 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // # of macros
2560 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // first ID
2561 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
2562
David Blaikieb44f0bf2017-01-04 22:36:43 +00002563 unsigned MacroOffsetAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Mehdi Amini57a41912015-09-10 01:46:39 +00002564 {
2565 RecordData::value_type Record[] = {MACRO_OFFSET, MacroOffsets.size(),
2566 FirstMacroID - NUM_PREDEF_MACRO_IDS};
2567 Stream.EmitRecordWithBlob(MacroOffsetAbbrev, Record, bytes(MacroOffsets));
2568 }
Douglas Gregor92a96f52011-02-08 21:58:10 +00002569}
2570
2571void ASTWriter::WritePreprocessorDetail(PreprocessingRecord &PPRec) {
Argyrios Kyrtzidis7f448362011-09-19 20:40:42 +00002572 if (PPRec.local_begin() == PPRec.local_end())
Douglas Gregor92a96f52011-02-08 21:58:10 +00002573 return;
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002574
Argyrios Kyrtzidis64f63812011-09-19 20:40:25 +00002575 SmallVector<PPEntityOffset, 64> PreprocessedEntityOffsets;
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002576
Douglas Gregor92a96f52011-02-08 21:58:10 +00002577 // Enter the preprocessor block.
2578 Stream.EnterSubblock(PREPROCESSOR_DETAIL_BLOCK_ID, 3);
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00002579
Douglas Gregoraae92242010-03-19 21:51:54 +00002580 // If the preprocessor has a preprocessing record, emit it.
2581 unsigned NumPreprocessingRecords = 0;
Douglas Gregor92a96f52011-02-08 21:58:10 +00002582 using namespace llvm;
2583
2584 // Set up the abbreviation for
2585 unsigned InclusionAbbrev = 0;
2586 {
David Blaikieb44f0bf2017-01-04 22:36:43 +00002587 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Douglas Gregor92a96f52011-02-08 21:58:10 +00002588 Abbrev->Add(BitCodeAbbrevOp(PPD_INCLUSION_DIRECTIVE));
Douglas Gregor92a96f52011-02-08 21:58:10 +00002589 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // filename length
2590 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // in quotes
2591 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 2)); // kind
Argyrios Kyrtzidisf590e092012-10-02 16:10:46 +00002592 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // imported module
Douglas Gregor92a96f52011-02-08 21:58:10 +00002593 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
David Blaikieb44f0bf2017-01-04 22:36:43 +00002594 InclusionAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregor92a96f52011-02-08 21:58:10 +00002595 }
2596
Douglas Gregor2f555fc2011-08-04 18:56:47 +00002597 unsigned FirstPreprocessorEntityID
2598 = (Chain ? PPRec.getNumLoadedPreprocessedEntities() : 0)
2599 + NUM_PREDEF_PP_ENTITY_IDS;
2600 unsigned NextPreprocessorEntityID = FirstPreprocessorEntityID;
Douglas Gregor92a96f52011-02-08 21:58:10 +00002601 RecordData Record;
Argyrios Kyrtzidis7f448362011-09-19 20:40:42 +00002602 for (PreprocessingRecord::iterator E = PPRec.local_begin(),
2603 EEnd = PPRec.local_end();
Douglas Gregor0d4b4312011-08-04 17:06:18 +00002604 E != EEnd;
2605 (void)++E, ++NumPreprocessingRecords, ++NextPreprocessorEntityID) {
Douglas Gregor92a96f52011-02-08 21:58:10 +00002606 Record.clear();
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00002607
Richard Smith66a81862015-05-04 02:25:31 +00002608 PreprocessedEntityOffsets.push_back(
2609 PPEntityOffset((*E)->getSourceRange(), Stream.GetCurrentBitNo()));
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002610
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002611 if (auto *MD = dyn_cast<MacroDefinitionRecord>(*E)) {
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002612 // Record this macro definition's ID.
2613 MacroDefinitions[MD] = NextPreprocessorEntityID;
Richard Smith66a81862015-05-04 02:25:31 +00002614
Douglas Gregor92a96f52011-02-08 21:58:10 +00002615 AddIdentifierRef(MD->getName(), Record);
Douglas Gregor92a96f52011-02-08 21:58:10 +00002616 Stream.EmitRecord(PPD_MACRO_DEFINITION, Record);
2617 continue;
Douglas Gregoraae92242010-03-19 21:51:54 +00002618 }
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00002619
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002620 if (auto *ME = dyn_cast<MacroExpansion>(*E)) {
Argyrios Kyrtzidis80f78b92011-09-08 17:18:41 +00002621 Record.push_back(ME->isBuiltinMacro());
2622 if (ME->isBuiltinMacro())
2623 AddIdentifierRef(ME->getName(), Record);
2624 else
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002625 Record.push_back(MacroDefinitions[ME->getDefinition()]);
Chandler Carruthf92ac9e2011-07-15 07:25:21 +00002626 Stream.EmitRecord(PPD_MACRO_EXPANSION, Record);
Douglas Gregor92a96f52011-02-08 21:58:10 +00002627 continue;
2628 }
2629
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002630 if (auto *ID = dyn_cast<InclusionDirective>(*E)) {
Douglas Gregor92a96f52011-02-08 21:58:10 +00002631 Record.push_back(PPD_INCLUSION_DIRECTIVE);
Douglas Gregor92a96f52011-02-08 21:58:10 +00002632 Record.push_back(ID->getFileName().size());
2633 Record.push_back(ID->wasInQuotes());
2634 Record.push_back(static_cast<unsigned>(ID->getKind()));
Argyrios Kyrtzidisf590e092012-10-02 16:10:46 +00002635 Record.push_back(ID->importedModule());
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00002636 SmallString<64> Buffer;
Douglas Gregor92a96f52011-02-08 21:58:10 +00002637 Buffer += ID->getFileName();
Argyrios Kyrtzidis8dbcfc32012-03-08 01:08:28 +00002638 // Check that the FileEntry is not null because it was not resolved and
2639 // we create a PCH even with compiler errors.
2640 if (ID->getFile())
2641 Buffer += ID->getFile()->getName();
Mehdi Amini5ae4a852015-09-09 20:35:37 +00002642 Stream.EmitRecordWithBlob(InclusionAbbrev, Record, Buffer);
Douglas Gregor92a96f52011-02-08 21:58:10 +00002643 continue;
2644 }
2645
2646 llvm_unreachable("Unhandled PreprocessedEntity in ASTWriter");
2647 }
Douglas Gregor8f45df52009-04-16 22:23:12 +00002648 Stream.ExitBlock();
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00002649
Douglas Gregoraae92242010-03-19 21:51:54 +00002650 // Write the offsets table for the preprocessing record.
2651 if (NumPreprocessingRecords > 0) {
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002652 assert(PreprocessedEntityOffsets.size() == NumPreprocessingRecords);
2653
Douglas Gregoraae92242010-03-19 21:51:54 +00002654 // Write the offsets table for identifier IDs.
2655 using namespace llvm;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002656
David Blaikieb44f0bf2017-01-04 22:36:43 +00002657 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002658 Abbrev->Add(BitCodeAbbrevOp(PPD_ENTITIES_OFFSETS));
Douglas Gregor2f555fc2011-08-04 18:56:47 +00002659 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // first pp entity
Douglas Gregoraae92242010-03-19 21:51:54 +00002660 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
David Blaikieb44f0bf2017-01-04 22:36:43 +00002661 unsigned PPEOffsetAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00002662
Mehdi Amini57a41912015-09-10 01:46:39 +00002663 RecordData::value_type Record[] = {PPD_ENTITIES_OFFSETS,
2664 FirstPreprocessorEntityID -
2665 NUM_PREDEF_PP_ENTITY_IDS};
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002666 Stream.EmitRecordWithBlob(PPEOffsetAbbrev, Record,
Reid Kleckner012665e2015-05-21 00:13:09 +00002667 bytes(PreprocessedEntityOffsets));
Douglas Gregoraae92242010-03-19 21:51:54 +00002668 }
Chris Lattnereeffaef2009-04-10 17:15:23 +00002669}
2670
Richard Smith386bb072015-08-18 23:42:23 +00002671unsigned ASTWriter::getLocalOrImportedSubmoduleID(Module *Mod) {
Richard Smith080056b2015-08-18 21:53:42 +00002672 if (!Mod)
2673 return 0;
2674
Douglas Gregora89c5ac2011-12-06 01:10:29 +00002675 llvm::DenseMap<Module *, unsigned>::iterator Known = SubmoduleIDs.find(Mod);
2676 if (Known != SubmoduleIDs.end())
2677 return Known->second;
Richard Smith386bb072015-08-18 23:42:23 +00002678
Richard Smithdc1f0422016-07-20 19:10:16 +00002679 auto *Top = Mod->getTopLevelModule();
2680 if (Top != WritingModule &&
Bruno Cardoso Lopes17da34d2017-02-07 21:54:57 +00002681 (getLangOpts().CompilingPCH ||
2682 !Top->fullModuleNameIs(StringRef(getLangOpts().CurrentModule))))
Richard Smith386bb072015-08-18 23:42:23 +00002683 return 0;
2684
Douglas Gregora89c5ac2011-12-06 01:10:29 +00002685 return SubmoduleIDs[Mod] = NextSubmoduleID++;
2686}
2687
Richard Smith386bb072015-08-18 23:42:23 +00002688unsigned ASTWriter::getSubmoduleID(Module *Mod) {
2689 // FIXME: This can easily happen, if we have a reference to a submodule that
2690 // did not result in us loading a module file for that submodule. For
2691 // instance, a cross-top-level-module 'conflict' declaration will hit this.
2692 unsigned ID = getLocalOrImportedSubmoduleID(Mod);
2693 assert((ID || !Mod) &&
2694 "asked for module ID for non-local, non-imported module");
2695 return ID;
Argyrios Kyrtzidisb146baa2013-03-13 21:13:51 +00002696}
2697
Douglas Gregor253eefe2011-12-01 00:59:36 +00002698/// \brief Compute the number of modules within the given tree (including the
2699/// given module).
2700static unsigned getNumberOfModules(Module *Mod) {
2701 unsigned ChildModules = 0;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002702 for (auto Sub = Mod->submodule_begin(), SubEnd = Mod->submodule_end();
Douglas Gregor253eefe2011-12-01 00:59:36 +00002703 Sub != SubEnd; ++Sub)
Douglas Gregoreb90e832012-01-04 23:32:19 +00002704 ChildModules += getNumberOfModules(*Sub);
Douglas Gregor253eefe2011-12-01 00:59:36 +00002705
2706 return ChildModules + 1;
2707}
2708
Douglas Gregorde3ef502011-11-30 23:21:26 +00002709void ASTWriter::WriteSubmodules(Module *WritingModule) {
Douglas Gregor69021972011-11-30 17:33:56 +00002710 // Enter the submodule description block.
Richard Smith202210b2014-10-24 20:23:01 +00002711 Stream.EnterSubblock(SUBMODULE_BLOCK_ID, /*bits for abbreviations*/5);
Douglas Gregor69021972011-11-30 17:33:56 +00002712
2713 // Write the abbreviations needed for the submodules block.
2714 using namespace llvm;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002715
David Blaikieb44f0bf2017-01-04 22:36:43 +00002716 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Douglas Gregor69021972011-11-30 17:33:56 +00002717 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_DEFINITION));
Douglas Gregora89c5ac2011-12-06 01:10:29 +00002718 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // ID
Douglas Gregor69021972011-11-30 17:33:56 +00002719 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Parent
Richard Smithdd8b5332017-09-04 05:37:53 +00002720 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 2)); // Kind
Douglas Gregor69021972011-11-30 17:33:56 +00002721 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // IsFramework
2722 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // IsExplicit
Richard Smith9bca2982014-03-08 00:03:56 +00002723 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // IsSystem
2724 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // IsExternC
Douglas Gregora686e1b2012-01-27 19:52:33 +00002725 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // InferSubmodules...
Douglas Gregor73441092011-12-05 22:27:44 +00002726 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // InferExplicit...
Douglas Gregor73441092011-12-05 22:27:44 +00002727 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // InferExportWild...
Douglas Gregor35b13ec2013-03-20 00:22:05 +00002728 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // ConfigMacrosExh...
Douglas Gregor69021972011-11-30 17:33:56 +00002729 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
David Blaikieb44f0bf2017-01-04 22:36:43 +00002730 unsigned DefinitionAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregor69021972011-11-30 17:33:56 +00002731
David Blaikieb44f0bf2017-01-04 22:36:43 +00002732 Abbrev = std::make_shared<BitCodeAbbrev>();
Douglas Gregor524e33e2011-12-08 19:11:24 +00002733 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_UMBRELLA_HEADER));
Douglas Gregor69021972011-11-30 17:33:56 +00002734 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
David Blaikieb44f0bf2017-01-04 22:36:43 +00002735 unsigned UmbrellaAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregor69021972011-11-30 17:33:56 +00002736
David Blaikieb44f0bf2017-01-04 22:36:43 +00002737 Abbrev = std::make_shared<BitCodeAbbrev>();
Douglas Gregor69021972011-11-30 17:33:56 +00002738 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_HEADER));
2739 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
David Blaikieb44f0bf2017-01-04 22:36:43 +00002740 unsigned HeaderAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregor524e33e2011-12-08 19:11:24 +00002741
David Blaikieb44f0bf2017-01-04 22:36:43 +00002742 Abbrev = std::make_shared<BitCodeAbbrev>();
Argyrios Kyrtzidisc597c8c2012-10-05 00:22:33 +00002743 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_TOPHEADER));
2744 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
David Blaikieb44f0bf2017-01-04 22:36:43 +00002745 unsigned TopHeaderAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Argyrios Kyrtzidisc597c8c2012-10-05 00:22:33 +00002746
David Blaikieb44f0bf2017-01-04 22:36:43 +00002747 Abbrev = std::make_shared<BitCodeAbbrev>();
Douglas Gregor524e33e2011-12-08 19:11:24 +00002748 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_UMBRELLA_DIR));
2749 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
David Blaikieb44f0bf2017-01-04 22:36:43 +00002750 unsigned UmbrellaDirAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregor524e33e2011-12-08 19:11:24 +00002751
David Blaikieb44f0bf2017-01-04 22:36:43 +00002752 Abbrev = std::make_shared<BitCodeAbbrev>();
Douglas Gregor1fb5c3a2011-12-31 04:05:44 +00002753 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_REQUIRES));
Richard Smitha3feee22013-10-28 22:18:19 +00002754 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // State
2755 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Feature
David Blaikieb44f0bf2017-01-04 22:36:43 +00002756 unsigned RequiresAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregor1fb5c3a2011-12-31 04:05:44 +00002757
David Blaikieb44f0bf2017-01-04 22:36:43 +00002758 Abbrev = std::make_shared<BitCodeAbbrev>();
Douglas Gregor59527662012-10-15 06:28:11 +00002759 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_EXCLUDED_HEADER));
2760 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
David Blaikieb44f0bf2017-01-04 22:36:43 +00002761 unsigned ExcludedHeaderAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregor59527662012-10-15 06:28:11 +00002762
David Blaikieb44f0bf2017-01-04 22:36:43 +00002763 Abbrev = std::make_shared<BitCodeAbbrev>();
Richard Smith306d8922014-10-22 23:50:56 +00002764 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_TEXTUAL_HEADER));
2765 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
David Blaikieb44f0bf2017-01-04 22:36:43 +00002766 unsigned TextualHeaderAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Richard Smith306d8922014-10-22 23:50:56 +00002767
David Blaikieb44f0bf2017-01-04 22:36:43 +00002768 Abbrev = std::make_shared<BitCodeAbbrev>();
Lawrence Crowlb53e5482013-06-20 21:14:14 +00002769 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_PRIVATE_HEADER));
2770 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
David Blaikieb44f0bf2017-01-04 22:36:43 +00002771 unsigned PrivateHeaderAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Lawrence Crowlb53e5482013-06-20 21:14:14 +00002772
David Blaikieb44f0bf2017-01-04 22:36:43 +00002773 Abbrev = std::make_shared<BitCodeAbbrev>();
Richard Smith202210b2014-10-24 20:23:01 +00002774 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_PRIVATE_TEXTUAL_HEADER));
2775 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
David Blaikieb44f0bf2017-01-04 22:36:43 +00002776 unsigned PrivateTextualHeaderAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Richard Smith202210b2014-10-24 20:23:01 +00002777
David Blaikieb44f0bf2017-01-04 22:36:43 +00002778 Abbrev = std::make_shared<BitCodeAbbrev>();
Douglas Gregor6ddfca92013-01-14 17:21:00 +00002779 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_LINK_LIBRARY));
2780 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // IsFramework
2781 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
David Blaikieb44f0bf2017-01-04 22:36:43 +00002782 unsigned LinkLibraryAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregor6ddfca92013-01-14 17:21:00 +00002783
David Blaikieb44f0bf2017-01-04 22:36:43 +00002784 Abbrev = std::make_shared<BitCodeAbbrev>();
Douglas Gregor35b13ec2013-03-20 00:22:05 +00002785 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_CONFIG_MACRO));
2786 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Macro name
David Blaikieb44f0bf2017-01-04 22:36:43 +00002787 unsigned ConfigMacroAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregor35b13ec2013-03-20 00:22:05 +00002788
David Blaikieb44f0bf2017-01-04 22:36:43 +00002789 Abbrev = std::make_shared<BitCodeAbbrev>();
Douglas Gregorfb912652013-03-20 21:10:35 +00002790 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_CONFLICT));
2791 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Other module
2792 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Message
David Blaikieb44f0bf2017-01-04 22:36:43 +00002793 unsigned ConflictAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregorfb912652013-03-20 21:10:35 +00002794
Douglas Gregorf0b11de2017-09-14 23:38:44 +00002795 Abbrev = std::make_shared<BitCodeAbbrev>();
2796 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_EXPORT_AS));
2797 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Macro name
2798 unsigned ExportAsAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
2799
Douglas Gregor253eefe2011-12-01 00:59:36 +00002800 // Write the submodule metadata block.
Richard Smith145e15a2017-04-24 23:12:30 +00002801 RecordData::value_type Record[] = {
2802 getNumberOfModules(WritingModule),
Richard Smithdd8b5332017-09-04 05:37:53 +00002803 FirstSubmoduleID - NUM_PREDEF_SUBMODULE_IDS};
Douglas Gregor253eefe2011-12-01 00:59:36 +00002804 Stream.EmitRecord(SUBMODULE_METADATA, Record);
2805
Douglas Gregor69021972011-11-30 17:33:56 +00002806 // Write all of the submodules.
Douglas Gregorde3ef502011-11-30 23:21:26 +00002807 std::queue<Module *> Q;
Douglas Gregor69021972011-11-30 17:33:56 +00002808 Q.push(WritingModule);
Douglas Gregor69021972011-11-30 17:33:56 +00002809 while (!Q.empty()) {
Douglas Gregorde3ef502011-11-30 23:21:26 +00002810 Module *Mod = Q.front();
Douglas Gregor69021972011-11-30 17:33:56 +00002811 Q.pop();
Douglas Gregora89c5ac2011-12-06 01:10:29 +00002812 unsigned ID = getSubmoduleID(Mod);
Mehdi Amini57a41912015-09-10 01:46:39 +00002813
2814 uint64_t ParentID = 0;
Douglas Gregor69021972011-11-30 17:33:56 +00002815 if (Mod->Parent) {
2816 assert(SubmoduleIDs[Mod->Parent] && "Submodule parent not written?");
Mehdi Amini57a41912015-09-10 01:46:39 +00002817 ParentID = SubmoduleIDs[Mod->Parent];
Douglas Gregor69021972011-11-30 17:33:56 +00002818 }
Mehdi Amini57a41912015-09-10 01:46:39 +00002819
2820 // Emit the definition of the block.
2821 {
David Blaikie9ffe5a32017-01-30 05:00:26 +00002822 RecordData::value_type Record[] = {SUBMODULE_DEFINITION,
2823 ID,
2824 ParentID,
Simon Pilgrimf331a662017-09-04 10:54:39 +00002825 (RecordData::value_type)Mod->Kind,
David Blaikie9ffe5a32017-01-30 05:00:26 +00002826 Mod->IsFramework,
2827 Mod->IsExplicit,
2828 Mod->IsSystem,
2829 Mod->IsExternC,
2830 Mod->InferSubmodules,
2831 Mod->InferExplicitSubmodules,
2832 Mod->InferExportWildcard,
David Blaikiee6b7c282017-04-11 20:46:34 +00002833 Mod->ConfigMacrosExhaustive};
Mehdi Amini57a41912015-09-10 01:46:39 +00002834 Stream.EmitRecordWithBlob(DefinitionAbbrev, Record, Mod->Name);
2835 }
2836
Douglas Gregor1fb5c3a2011-12-31 04:05:44 +00002837 // Emit the requirements.
Richard Smith080056b2015-08-18 21:53:42 +00002838 for (const auto &R : Mod->Requirements) {
Mehdi Amini57a41912015-09-10 01:46:39 +00002839 RecordData::value_type Record[] = {SUBMODULE_REQUIRES, R.second};
Richard Smith080056b2015-08-18 21:53:42 +00002840 Stream.EmitRecordWithBlob(RequiresAbbrev, Record, R.first);
Douglas Gregor1fb5c3a2011-12-31 04:05:44 +00002841 }
2842
Douglas Gregor69021972011-11-30 17:33:56 +00002843 // Emit the umbrella header, if there is one.
Richard Smith2b63d152015-05-16 02:28:53 +00002844 if (auto UmbrellaHeader = Mod->getUmbrellaHeader()) {
Mehdi Amini57a41912015-09-10 01:46:39 +00002845 RecordData::value_type Record[] = {SUBMODULE_UMBRELLA_HEADER};
Richard Smith2b63d152015-05-16 02:28:53 +00002846 Stream.EmitRecordWithBlob(UmbrellaAbbrev, Record,
2847 UmbrellaHeader.NameAsWritten);
2848 } else if (auto UmbrellaDir = Mod->getUmbrellaDir()) {
Mehdi Amini57a41912015-09-10 01:46:39 +00002849 RecordData::value_type Record[] = {SUBMODULE_UMBRELLA_DIR};
2850 Stream.EmitRecordWithBlob(UmbrellaDirAbbrev, Record,
Richard Smith2b63d152015-05-16 02:28:53 +00002851 UmbrellaDir.NameAsWritten);
Douglas Gregor69021972011-11-30 17:33:56 +00002852 }
Richard Smith306d8922014-10-22 23:50:56 +00002853
Douglas Gregor69021972011-11-30 17:33:56 +00002854 // Emit the headers.
Richard Smith202210b2014-10-24 20:23:01 +00002855 struct {
Richard Smith3c1a41a2014-12-02 00:08:08 +00002856 unsigned RecordKind;
Richard Smith202210b2014-10-24 20:23:01 +00002857 unsigned Abbrev;
Richard Smith3c1a41a2014-12-02 00:08:08 +00002858 Module::HeaderKind HeaderKind;
Richard Smith202210b2014-10-24 20:23:01 +00002859 } HeaderLists[] = {
Richard Smith3c1a41a2014-12-02 00:08:08 +00002860 {SUBMODULE_HEADER, HeaderAbbrev, Module::HK_Normal},
2861 {SUBMODULE_TEXTUAL_HEADER, TextualHeaderAbbrev, Module::HK_Textual},
2862 {SUBMODULE_PRIVATE_HEADER, PrivateHeaderAbbrev, Module::HK_Private},
Richard Smith202210b2014-10-24 20:23:01 +00002863 {SUBMODULE_PRIVATE_TEXTUAL_HEADER, PrivateTextualHeaderAbbrev,
Richard Smith3c1a41a2014-12-02 00:08:08 +00002864 Module::HK_PrivateTextual},
2865 {SUBMODULE_EXCLUDED_HEADER, ExcludedHeaderAbbrev, Module::HK_Excluded}
Richard Smith202210b2014-10-24 20:23:01 +00002866 };
2867 for (auto &HL : HeaderLists) {
Mehdi Amini57a41912015-09-10 01:46:39 +00002868 RecordData::value_type Record[] = {HL.RecordKind};
Richard Smith3c1a41a2014-12-02 00:08:08 +00002869 for (auto &H : Mod->Headers[HL.HeaderKind])
2870 Stream.EmitRecordWithBlob(HL.Abbrev, Record, H.NameAsWritten);
2871 }
2872
2873 // Emit the top headers.
2874 {
2875 auto TopHeaders = Mod->getTopHeaders(PP->getFileManager());
Mehdi Amini57a41912015-09-10 01:46:39 +00002876 RecordData::value_type Record[] = {SUBMODULE_TOPHEADER};
Richard Smith3c1a41a2014-12-02 00:08:08 +00002877 for (auto *H : TopHeaders)
2878 Stream.EmitRecordWithBlob(TopHeaderAbbrev, Record, H->getName());
Argyrios Kyrtzidisc597c8c2012-10-05 00:22:33 +00002879 }
Douglas Gregor0093b3c2011-12-05 16:33:54 +00002880
2881 // Emit the imports.
2882 if (!Mod->Imports.empty()) {
Mehdi Amini57a41912015-09-10 01:46:39 +00002883 RecordData Record;
Richard Smith080056b2015-08-18 21:53:42 +00002884 for (auto *I : Mod->Imports)
2885 Record.push_back(getSubmoduleID(I));
Douglas Gregor0093b3c2011-12-05 16:33:54 +00002886 Stream.EmitRecord(SUBMODULE_IMPORTS, Record);
2887 }
2888
Douglas Gregor24bb9232011-12-02 18:58:38 +00002889 // Emit the exports.
2890 if (!Mod->Exports.empty()) {
Mehdi Amini57a41912015-09-10 01:46:39 +00002891 RecordData Record;
Richard Smith080056b2015-08-18 21:53:42 +00002892 for (const auto &E : Mod->Exports) {
2893 // FIXME: This may fail; we don't require that all exported modules
2894 // are local or imported.
2895 Record.push_back(getSubmoduleID(E.getPointer()));
2896 Record.push_back(E.getInt());
Douglas Gregor24bb9232011-12-02 18:58:38 +00002897 }
2898 Stream.EmitRecord(SUBMODULE_EXPORTS, Record);
2899 }
Douglas Gregor6ddfca92013-01-14 17:21:00 +00002900
Daniel Jasperba7f2f72013-09-24 09:14:14 +00002901 //FIXME: How do we emit the 'use'd modules? They may not be submodules.
2902 // Might be unnecessary as use declarations are only used to build the
2903 // module itself.
2904
Douglas Gregor6ddfca92013-01-14 17:21:00 +00002905 // Emit the link libraries.
Richard Smith080056b2015-08-18 21:53:42 +00002906 for (const auto &LL : Mod->LinkLibraries) {
Mehdi Amini57a41912015-09-10 01:46:39 +00002907 RecordData::value_type Record[] = {SUBMODULE_LINK_LIBRARY,
2908 LL.IsFramework};
Richard Smith080056b2015-08-18 21:53:42 +00002909 Stream.EmitRecordWithBlob(LinkLibraryAbbrev, Record, LL.Library);
Douglas Gregor6ddfca92013-01-14 17:21:00 +00002910 }
2911
Douglas Gregorfb912652013-03-20 21:10:35 +00002912 // Emit the conflicts.
Richard Smith080056b2015-08-18 21:53:42 +00002913 for (const auto &C : Mod->Conflicts) {
Richard Smith080056b2015-08-18 21:53:42 +00002914 // FIXME: This may fail; we don't require that all conflicting modules
2915 // are local or imported.
Mehdi Amini57a41912015-09-10 01:46:39 +00002916 RecordData::value_type Record[] = {SUBMODULE_CONFLICT,
2917 getSubmoduleID(C.Other)};
Richard Smith080056b2015-08-18 21:53:42 +00002918 Stream.EmitRecordWithBlob(ConflictAbbrev, Record, C.Message);
Douglas Gregorfb912652013-03-20 21:10:35 +00002919 }
2920
Douglas Gregor35b13ec2013-03-20 00:22:05 +00002921 // Emit the configuration macros.
Richard Smith080056b2015-08-18 21:53:42 +00002922 for (const auto &CM : Mod->ConfigMacros) {
Mehdi Amini57a41912015-09-10 01:46:39 +00002923 RecordData::value_type Record[] = {SUBMODULE_CONFIG_MACRO};
Richard Smith080056b2015-08-18 21:53:42 +00002924 Stream.EmitRecordWithBlob(ConfigMacroAbbrev, Record, CM);
Douglas Gregor35b13ec2013-03-20 00:22:05 +00002925 }
2926
Richard Smithdc1f0422016-07-20 19:10:16 +00002927 // Emit the initializers, if any.
2928 RecordData Inits;
2929 for (Decl *D : Context->getModuleInitializers(Mod))
2930 Inits.push_back(GetDeclRef(D));
2931 if (!Inits.empty())
2932 Stream.EmitRecord(SUBMODULE_INITIALIZERS, Inits);
2933
Douglas Gregorf0b11de2017-09-14 23:38:44 +00002934 // Emit the name of the re-exported module, if any.
2935 if (!Mod->ExportAsModule.empty()) {
2936 RecordData::value_type Record[] = {SUBMODULE_EXPORT_AS};
2937 Stream.EmitRecordWithBlob(ExportAsAbbrev, Record, Mod->ExportAsModule);
2938 }
2939
Douglas Gregor69021972011-11-30 17:33:56 +00002940 // Queue up the submodules of this module.
Richard Smith080056b2015-08-18 21:53:42 +00002941 for (auto *M : Mod->submodules())
2942 Q.push(M);
Douglas Gregor69021972011-11-30 17:33:56 +00002943 }
2944
2945 Stream.ExitBlock();
Richard Smith23d8d032015-05-14 00:45:20 +00002946
Richard Smith23d8d032015-05-14 00:45:20 +00002947 assert((NextSubmoduleID - FirstSubmoduleID ==
2948 getNumberOfModules(WritingModule)) &&
2949 "Wrong # of submodules; found a reference to a non-local, "
2950 "non-imported submodule?");
Douglas Gregor69021972011-11-30 17:33:56 +00002951}
2952
Argyrios Kyrtzidis0f06b982013-03-27 17:17:23 +00002953void ASTWriter::WritePragmaDiagnosticMappings(const DiagnosticsEngine &Diag,
2954 bool isModule) {
Argyrios Kyrtzidisefaa54a2012-10-30 00:27:21 +00002955 llvm::SmallDenseMap<const DiagnosticsEngine::DiagState *, unsigned, 64>
2956 DiagStateIDMap;
2957 unsigned CurrID = 0;
Argyrios Kyrtzidis452707c2010-11-05 22:10:18 +00002958 RecordData Record;
Argyrios Kyrtzidis243aedb2011-01-14 20:54:07 +00002959
Richard Smithe37391c2017-05-03 00:28:49 +00002960 auto EncodeDiagStateFlags =
2961 [](const DiagnosticsEngine::DiagState *DS) -> unsigned {
2962 unsigned Result = (unsigned)DS->ExtBehavior;
2963 for (unsigned Val :
Daniel Jasperba9aefc2017-05-03 07:48:27 +00002964 {(unsigned)DS->IgnoreAllWarnings, (unsigned)DS->EnableAllWarnings,
2965 (unsigned)DS->WarningsAsErrors, (unsigned)DS->ErrorsAsFatal,
2966 (unsigned)DS->SuppressSystemWarnings})
Richard Smithe37391c2017-05-03 00:28:49 +00002967 Result = (Result << 1) | Val;
2968 return Result;
2969 };
2970
2971 unsigned Flags = EncodeDiagStateFlags(Diag.DiagStatesByLoc.FirstDiagState);
2972 Record.push_back(Flags);
2973
Richard Smithd230de22017-01-26 01:01:01 +00002974 auto AddDiagState = [&](const DiagnosticsEngine::DiagState *State,
2975 bool IncludeNonPragmaStates) {
Richard Smithe37391c2017-05-03 00:28:49 +00002976 // Ensure that the diagnostic state wasn't modified since it was created.
2977 // We will not correctly round-trip this information otherwise.
2978 assert(Flags == EncodeDiagStateFlags(State) &&
2979 "diag state flags vary in single AST file");
2980
Richard Smithd230de22017-01-26 01:01:01 +00002981 unsigned &DiagStateID = DiagStateIDMap[State];
Argyrios Kyrtzidisefaa54a2012-10-30 00:27:21 +00002982 Record.push_back(DiagStateID);
Richard Smithd230de22017-01-26 01:01:01 +00002983
Argyrios Kyrtzidisefaa54a2012-10-30 00:27:21 +00002984 if (DiagStateID == 0) {
2985 DiagStateID = ++CurrID;
Duncan P. N. Exon Smith3cb183b2017-03-14 19:31:27 +00002986
2987 // Add a placeholder for the number of mappings.
2988 auto SizeIdx = Record.size();
2989 Record.emplace_back();
Richard Smithd230de22017-01-26 01:01:01 +00002990 for (const auto &I : *State) {
2991 if (I.second.isPragma() || IncludeNonPragmaStates) {
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002992 Record.push_back(I.first);
Richard Smithe37391c2017-05-03 00:28:49 +00002993 Record.push_back(I.second.serialize());
Argyrios Kyrtzidisefaa54a2012-10-30 00:27:21 +00002994 }
Argyrios Kyrtzidis243aedb2011-01-14 20:54:07 +00002995 }
Duncan P. N. Exon Smith3cb183b2017-03-14 19:31:27 +00002996 // Update the placeholder.
2997 Record[SizeIdx] = (Record.size() - SizeIdx) / 2;
Richard Smithd230de22017-01-26 01:01:01 +00002998 }
2999 };
3000
3001 AddDiagState(Diag.DiagStatesByLoc.FirstDiagState, isModule);
Richard Smithd230de22017-01-26 01:01:01 +00003002
Duncan P. N. Exon Smitha351c102017-04-12 03:45:32 +00003003 // Reserve a spot for the number of locations with state transitions.
3004 auto NumLocationsIdx = Record.size();
3005 Record.emplace_back();
3006
3007 // Emit the state transitions.
3008 unsigned NumLocations = 0;
Richard Smithd230de22017-01-26 01:01:01 +00003009 for (auto &FileIDAndFile : Diag.DiagStatesByLoc.Files) {
3010 if (!FileIDAndFile.first.isValid() ||
3011 !FileIDAndFile.second.HasLocalTransitions)
3012 continue;
Duncan P. N. Exon Smitha351c102017-04-12 03:45:32 +00003013 ++NumLocations;
Richard Smithd230de22017-01-26 01:01:01 +00003014 AddSourceLocation(Diag.SourceMgr->getLocForStartOfFile(FileIDAndFile.first),
3015 Record);
3016 Record.push_back(FileIDAndFile.second.StateTransitions.size());
3017 for (auto &StatePoint : FileIDAndFile.second.StateTransitions) {
3018 Record.push_back(StatePoint.Offset);
3019 AddDiagState(StatePoint.State, false);
Argyrios Kyrtzidis452707c2010-11-05 22:10:18 +00003020 }
3021 }
3022
Duncan P. N. Exon Smitha351c102017-04-12 03:45:32 +00003023 // Backpatch the number of locations.
3024 Record[NumLocationsIdx] = NumLocations;
3025
3026 // Emit CurDiagStateLoc. Do it last in order to match source order.
Duncan P. N. Exon Smith900f8172017-04-12 03:58:58 +00003027 //
3028 // This also protects against a hypothetical corner case with simulating
3029 // -Werror settings for implicit modules in the ASTReader, where reading
3030 // CurDiagState out of context could change whether warning pragmas are
3031 // treated as errors.
Duncan P. N. Exon Smitha351c102017-04-12 03:45:32 +00003032 AddSourceLocation(Diag.DiagStatesByLoc.CurDiagStateLoc, Record);
3033 AddDiagState(Diag.DiagStatesByLoc.CurDiagState, false);
3034
Duncan P. N. Exon Smithf2435b92017-04-12 02:31:17 +00003035 Stream.EmitRecord(DIAG_PRAGMA_MAPPINGS, Record);
Argyrios Kyrtzidis452707c2010-11-05 22:10:18 +00003036}
3037
Douglas Gregorc5046832009-04-27 18:38:38 +00003038//===----------------------------------------------------------------------===//
3039// Type Serialization
3040//===----------------------------------------------------------------------===//
Chris Lattnereeffaef2009-04-10 17:15:23 +00003041
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00003042/// \brief Write the representation of a type to the AST stream.
Sebastian Redl55c0ad52010-08-18 23:56:21 +00003043void ASTWriter::WriteType(QualType T) {
Richard Smith290d8012016-04-06 17:06:00 +00003044 TypeIdx &IdxRef = TypeIdxs[T];
3045 if (IdxRef.getIndex() == 0) // we haven't seen this type before.
3046 IdxRef = TypeIdx(NextTypeID++);
3047 TypeIdx Idx = IdxRef;
Mike Stump11289f42009-09-09 15:08:12 +00003048
Douglas Gregor9b3932c2010-10-05 18:37:06 +00003049 assert(Idx.getIndex() >= FirstTypeID && "Re-writing a type from a prior AST");
Douglas Gregordc72caa2010-10-04 18:21:45 +00003050
Douglas Gregoref84c4b2009-04-09 22:27:44 +00003051 RecordData Record;
Mike Stump11289f42009-09-09 15:08:12 +00003052
Douglas Gregoref84c4b2009-04-09 22:27:44 +00003053 // Emit the type's representation.
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00003054 ASTTypeWriter W(*this, Record);
Richard Smith290d8012016-04-06 17:06:00 +00003055 W.Visit(T);
3056 uint64_t Offset = W.Emit();
John McCall8ccfcb52009-09-24 19:53:00 +00003057
Richard Smith290d8012016-04-06 17:06:00 +00003058 // Record the offset for this type.
3059 unsigned Index = Idx.getIndex() - FirstTypeID;
3060 if (TypeOffsets.size() == Index)
3061 TypeOffsets.push_back(Offset);
3062 else if (TypeOffsets.size() < Index) {
3063 TypeOffsets.resize(Index + 1);
3064 TypeOffsets[Index] = Offset;
John McCall8ccfcb52009-09-24 19:53:00 +00003065 } else {
Richard Smith290d8012016-04-06 17:06:00 +00003066 llvm_unreachable("Types emitted in wrong order");
Douglas Gregoref84c4b2009-04-09 22:27:44 +00003067 }
Douglas Gregoref84c4b2009-04-09 22:27:44 +00003068}
3069
Douglas Gregorc5046832009-04-27 18:38:38 +00003070//===----------------------------------------------------------------------===//
3071// Declaration Serialization
3072//===----------------------------------------------------------------------===//
3073
Douglas Gregoref84c4b2009-04-09 22:27:44 +00003074/// \brief Write the block containing all of the declaration IDs
3075/// lexically declared within the given DeclContext.
3076///
3077/// \returns the offset of the DECL_CONTEXT_LEXICAL block within the
3078/// bistream, or 0 if no block was written.
Sebastian Redl55c0ad52010-08-18 23:56:21 +00003079uint64_t ASTWriter::WriteDeclContextLexicalBlock(ASTContext &Context,
Douglas Gregoref84c4b2009-04-09 22:27:44 +00003080 DeclContext *DC) {
Argyrios Kyrtzidiscfbfe782009-06-30 02:36:12 +00003081 if (DC->decls_empty())
Douglas Gregoref84c4b2009-04-09 22:27:44 +00003082 return 0;
3083
Douglas Gregor8f45df52009-04-16 22:23:12 +00003084 uint64_t Offset = Stream.GetCurrentBitNo();
Richard Smith82f8fcd2015-08-06 22:07:25 +00003085 SmallVector<uint32_t, 128> KindDeclPairs;
3086 for (const auto *D : DC->decls()) {
3087 KindDeclPairs.push_back(D->getKind());
3088 KindDeclPairs.push_back(GetDeclRef(D));
3089 }
Douglas Gregoref84c4b2009-04-09 22:27:44 +00003090
Douglas Gregora57c3ab2009-04-22 22:34:57 +00003091 ++NumLexicalDeclContexts;
Mehdi Amini57a41912015-09-10 01:46:39 +00003092 RecordData::value_type Record[] = {DECL_CONTEXT_LEXICAL};
Richard Smith82f8fcd2015-08-06 22:07:25 +00003093 Stream.EmitRecordWithBlob(DeclContextLexicalAbbrev, Record,
3094 bytes(KindDeclPairs));
Douglas Gregoref84c4b2009-04-09 22:27:44 +00003095 return Offset;
3096}
3097
Sebastian Redl55c0ad52010-08-18 23:56:21 +00003098void ASTWriter::WriteTypeDeclOffsets() {
Sebastian Redl1ea025b2010-07-16 16:36:56 +00003099 using namespace llvm;
Sebastian Redl1ea025b2010-07-16 16:36:56 +00003100
3101 // Write the type offsets array
David Blaikieb44f0bf2017-01-04 22:36:43 +00003102 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Sebastian Redl539c5062010-08-18 23:57:32 +00003103 Abbrev->Add(BitCodeAbbrevOp(TYPE_OFFSET));
Sebastian Redl1ea025b2010-07-16 16:36:56 +00003104 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // # of types
Douglas Gregor5204bde2011-08-02 16:26:37 +00003105 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // base type index
Sebastian Redl1ea025b2010-07-16 16:36:56 +00003106 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // types block
David Blaikieb44f0bf2017-01-04 22:36:43 +00003107 unsigned TypeOffsetAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Mehdi Amini57a41912015-09-10 01:46:39 +00003108 {
3109 RecordData::value_type Record[] = {TYPE_OFFSET, TypeOffsets.size(),
3110 FirstTypeID - NUM_PREDEF_TYPE_IDS};
3111 Stream.EmitRecordWithBlob(TypeOffsetAbbrev, Record, bytes(TypeOffsets));
3112 }
Sebastian Redl1ea025b2010-07-16 16:36:56 +00003113
3114 // Write the declaration offsets array
David Blaikieb44f0bf2017-01-04 22:36:43 +00003115 Abbrev = std::make_shared<BitCodeAbbrev>();
Sebastian Redl539c5062010-08-18 23:57:32 +00003116 Abbrev->Add(BitCodeAbbrevOp(DECL_OFFSET));
Sebastian Redl1ea025b2010-07-16 16:36:56 +00003117 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // # of declarations
Douglas Gregorf7180622011-08-03 15:48:04 +00003118 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // base decl ID
Sebastian Redl1ea025b2010-07-16 16:36:56 +00003119 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // declarations block
David Blaikieb44f0bf2017-01-04 22:36:43 +00003120 unsigned DeclOffsetAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Mehdi Amini57a41912015-09-10 01:46:39 +00003121 {
3122 RecordData::value_type Record[] = {DECL_OFFSET, DeclOffsets.size(),
3123 FirstDeclID - NUM_PREDEF_DECL_IDS};
3124 Stream.EmitRecordWithBlob(DeclOffsetAbbrev, Record, bytes(DeclOffsets));
3125 }
Sebastian Redl1ea025b2010-07-16 16:36:56 +00003126}
3127
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00003128void ASTWriter::WriteFileDeclIDsMap() {
3129 using namespace llvm;
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00003130
Chandler Carruthb306d732015-03-27 00:31:20 +00003131 SmallVector<std::pair<FileID, DeclIDInFileInfo *>, 64> SortedFileDeclIDs(
3132 FileDeclIDs.begin(), FileDeclIDs.end());
3133 std::sort(SortedFileDeclIDs.begin(), SortedFileDeclIDs.end(),
3134 llvm::less_first());
3135
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00003136 // Join the vectors of DeclIDs from all files.
Chandler Carruthb306d732015-03-27 00:31:20 +00003137 SmallVector<DeclID, 256> FileGroupedDeclIDs;
3138 for (auto &FileDeclEntry : SortedFileDeclIDs) {
3139 DeclIDInFileInfo &Info = *FileDeclEntry.second;
3140 Info.FirstDeclIndex = FileGroupedDeclIDs.size();
3141 for (auto &LocDeclEntry : Info.DeclIDs)
3142 FileGroupedDeclIDs.push_back(LocDeclEntry.second);
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00003143 }
3144
David Blaikieb44f0bf2017-01-04 22:36:43 +00003145 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00003146 Abbrev->Add(BitCodeAbbrevOp(FILE_SORTED_DECLS));
Argyrios Kyrtzidis10e78462012-10-02 21:09:13 +00003147 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00003148 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
David Blaikieb44f0bf2017-01-04 22:36:43 +00003149 unsigned AbbrevCode = Stream.EmitAbbrev(std::move(Abbrev));
Mehdi Amini57a41912015-09-10 01:46:39 +00003150 RecordData::value_type Record[] = {FILE_SORTED_DECLS,
3151 FileGroupedDeclIDs.size()};
Reid Kleckner012665e2015-05-21 00:13:09 +00003152 Stream.EmitRecordWithBlob(AbbrevCode, Record, bytes(FileGroupedDeclIDs));
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00003153}
3154
Dmitri Gribenkoaab83832012-06-20 00:34:58 +00003155void ASTWriter::WriteComments() {
3156 Stream.EnterSubblock(COMMENTS_BLOCK_ID, 3);
Dmitri Gribenko7dd29d42012-07-06 18:19:34 +00003157 ArrayRef<RawComment *> RawComments = Context->Comments.getComments();
Dmitri Gribenkoaab83832012-06-20 00:34:58 +00003158 RecordData Record;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00003159 for (const auto *I : RawComments) {
Dmitri Gribenkoaab83832012-06-20 00:34:58 +00003160 Record.clear();
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00003161 AddSourceRange(I->getSourceRange(), Record);
3162 Record.push_back(I->getKind());
3163 Record.push_back(I->isTrailingComment());
3164 Record.push_back(I->isAlmostTrailingComment());
Dmitri Gribenkoaab83832012-06-20 00:34:58 +00003165 Stream.EmitRecord(COMMENTS_RAW_COMMENT, Record);
3166 }
3167 Stream.ExitBlock();
3168}
3169
Douglas Gregorc5046832009-04-27 18:38:38 +00003170//===----------------------------------------------------------------------===//
3171// Global Method Pool and Selector Serialization
3172//===----------------------------------------------------------------------===//
3173
Douglas Gregore84a9da2009-04-20 20:36:09 +00003174namespace {
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +00003175
Douglas Gregorc78d3462009-04-24 21:10:55 +00003176// Trait used for the on-disk hash table used in the method pool.
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00003177class ASTMethodPoolTrait {
Sebastian Redl55c0ad52010-08-18 23:56:21 +00003178 ASTWriter &Writer;
Douglas Gregorc78d3462009-04-24 21:10:55 +00003179
3180public:
3181 typedef Selector key_type;
3182 typedef key_type key_type_ref;
Mike Stump11289f42009-09-09 15:08:12 +00003183
Sebastian Redl834bb972010-08-04 17:20:04 +00003184 struct data_type {
Sebastian Redl539c5062010-08-18 23:57:32 +00003185 SelectorID ID;
Sebastian Redl834bb972010-08-04 17:20:04 +00003186 ObjCMethodList Instance, Factory;
3187 };
Douglas Gregorc78d3462009-04-24 21:10:55 +00003188 typedef const data_type& data_type_ref;
3189
Justin Bogner25463f12014-04-18 20:27:24 +00003190 typedef unsigned hash_value_type;
3191 typedef unsigned offset_type;
3192
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00003193 explicit ASTMethodPoolTrait(ASTWriter &Writer) : Writer(Writer) { }
Mike Stump11289f42009-09-09 15:08:12 +00003194
Justin Bogner25463f12014-04-18 20:27:24 +00003195 static hash_value_type ComputeHash(Selector Sel) {
Argyrios Kyrtzidis4bd97102010-08-20 16:03:52 +00003196 return serialization::ComputeHash(Sel);
Douglas Gregorc78d3462009-04-24 21:10:55 +00003197 }
Mike Stump11289f42009-09-09 15:08:12 +00003198
3199 std::pair<unsigned,unsigned>
Chris Lattner0e62c1c2011-07-23 10:55:15 +00003200 EmitKeyDataLength(raw_ostream& Out, Selector Sel,
Douglas Gregorc78d3462009-04-24 21:10:55 +00003201 data_type_ref Methods) {
Justin Bognere1c147c2014-03-28 22:03:19 +00003202 using namespace llvm::support;
3203 endian::Writer<little> LE(Out);
Douglas Gregorc78d3462009-04-24 21:10:55 +00003204 unsigned KeyLen = 2 + (Sel.getNumArgs()? Sel.getNumArgs() * 4 : 4);
Justin Bognere1c147c2014-03-28 22:03:19 +00003205 LE.write<uint16_t>(KeyLen);
Sebastian Redl834bb972010-08-04 17:20:04 +00003206 unsigned DataLen = 4 + 2 + 2; // 2 bytes for each of the method counts
3207 for (const ObjCMethodList *Method = &Methods.Instance; Method;
Argyrios Kyrtzidisd3da6e02013-04-17 00:08:58 +00003208 Method = Method->getNext())
Nico Weber2e0c8f72014-12-27 03:58:08 +00003209 if (Method->getMethod())
Douglas Gregorc78d3462009-04-24 21:10:55 +00003210 DataLen += 4;
Sebastian Redl834bb972010-08-04 17:20:04 +00003211 for (const ObjCMethodList *Method = &Methods.Factory; Method;
Argyrios Kyrtzidisd3da6e02013-04-17 00:08:58 +00003212 Method = Method->getNext())
Nico Weber2e0c8f72014-12-27 03:58:08 +00003213 if (Method->getMethod())
Douglas Gregorc78d3462009-04-24 21:10:55 +00003214 DataLen += 4;
Justin Bognere1c147c2014-03-28 22:03:19 +00003215 LE.write<uint16_t>(DataLen);
Douglas Gregorc78d3462009-04-24 21:10:55 +00003216 return std::make_pair(KeyLen, DataLen);
3217 }
Mike Stump11289f42009-09-09 15:08:12 +00003218
Chris Lattner0e62c1c2011-07-23 10:55:15 +00003219 void EmitKey(raw_ostream& Out, Selector Sel, unsigned) {
Justin Bognere1c147c2014-03-28 22:03:19 +00003220 using namespace llvm::support;
3221 endian::Writer<little> LE(Out);
Mike Stump11289f42009-09-09 15:08:12 +00003222 uint64_t Start = Out.tell();
Douglas Gregor95c13f52009-04-25 17:48:32 +00003223 assert((Start >> 32) == 0 && "Selector key offset too large");
3224 Writer.SetSelectorOffset(Sel, Start);
Douglas Gregorc78d3462009-04-24 21:10:55 +00003225 unsigned N = Sel.getNumArgs();
Justin Bognere1c147c2014-03-28 22:03:19 +00003226 LE.write<uint16_t>(N);
Douglas Gregorc78d3462009-04-24 21:10:55 +00003227 if (N == 0)
3228 N = 1;
3229 for (unsigned I = 0; I != N; ++I)
Justin Bognere1c147c2014-03-28 22:03:19 +00003230 LE.write<uint32_t>(
3231 Writer.getIdentifierRef(Sel.getIdentifierInfoForSlot(I)));
Douglas Gregorc78d3462009-04-24 21:10:55 +00003232 }
Mike Stump11289f42009-09-09 15:08:12 +00003233
Chris Lattner0e62c1c2011-07-23 10:55:15 +00003234 void EmitData(raw_ostream& Out, key_type_ref,
Douglas Gregor4647cfa2009-04-24 21:49:02 +00003235 data_type_ref Methods, unsigned DataLen) {
Justin Bognere1c147c2014-03-28 22:03:19 +00003236 using namespace llvm::support;
3237 endian::Writer<little> LE(Out);
Douglas Gregor4647cfa2009-04-24 21:49:02 +00003238 uint64_t Start = Out.tell(); (void)Start;
Justin Bognere1c147c2014-03-28 22:03:19 +00003239 LE.write<uint32_t>(Methods.ID);
Douglas Gregorc78d3462009-04-24 21:10:55 +00003240 unsigned NumInstanceMethods = 0;
Sebastian Redl834bb972010-08-04 17:20:04 +00003241 for (const ObjCMethodList *Method = &Methods.Instance; Method;
Argyrios Kyrtzidisd3da6e02013-04-17 00:08:58 +00003242 Method = Method->getNext())
Nico Weber2e0c8f72014-12-27 03:58:08 +00003243 if (Method->getMethod())
Douglas Gregorc78d3462009-04-24 21:10:55 +00003244 ++NumInstanceMethods;
3245
3246 unsigned NumFactoryMethods = 0;
Sebastian Redl834bb972010-08-04 17:20:04 +00003247 for (const ObjCMethodList *Method = &Methods.Factory; Method;
Argyrios Kyrtzidisd3da6e02013-04-17 00:08:58 +00003248 Method = Method->getNext())
Nico Weber2e0c8f72014-12-27 03:58:08 +00003249 if (Method->getMethod())
Douglas Gregorc78d3462009-04-24 21:10:55 +00003250 ++NumFactoryMethods;
3251
Argyrios Kyrtzidisd3da6e02013-04-17 00:08:58 +00003252 unsigned InstanceBits = Methods.Instance.getBits();
3253 assert(InstanceBits < 4);
Nico Weberff4b35e2014-12-27 22:14:15 +00003254 unsigned InstanceHasMoreThanOneDeclBit =
3255 Methods.Instance.hasMoreThanOneDecl();
3256 unsigned FullInstanceBits = (NumInstanceMethods << 3) |
3257 (InstanceHasMoreThanOneDeclBit << 2) |
3258 InstanceBits;
Argyrios Kyrtzidisd3da6e02013-04-17 00:08:58 +00003259 unsigned FactoryBits = Methods.Factory.getBits();
3260 assert(FactoryBits < 4);
Nico Weberff4b35e2014-12-27 22:14:15 +00003261 unsigned FactoryHasMoreThanOneDeclBit =
3262 Methods.Factory.hasMoreThanOneDecl();
3263 unsigned FullFactoryBits = (NumFactoryMethods << 3) |
3264 (FactoryHasMoreThanOneDeclBit << 2) |
3265 FactoryBits;
3266 LE.write<uint16_t>(FullInstanceBits);
3267 LE.write<uint16_t>(FullFactoryBits);
Sebastian Redl834bb972010-08-04 17:20:04 +00003268 for (const ObjCMethodList *Method = &Methods.Instance; Method;
Argyrios Kyrtzidisd3da6e02013-04-17 00:08:58 +00003269 Method = Method->getNext())
Nico Weber2e0c8f72014-12-27 03:58:08 +00003270 if (Method->getMethod())
3271 LE.write<uint32_t>(Writer.getDeclID(Method->getMethod()));
Sebastian Redl834bb972010-08-04 17:20:04 +00003272 for (const ObjCMethodList *Method = &Methods.Factory; Method;
Argyrios Kyrtzidisd3da6e02013-04-17 00:08:58 +00003273 Method = Method->getNext())
Nico Weber2e0c8f72014-12-27 03:58:08 +00003274 if (Method->getMethod())
3275 LE.write<uint32_t>(Writer.getDeclID(Method->getMethod()));
Douglas Gregor4647cfa2009-04-24 21:49:02 +00003276
3277 assert(Out.tell() - Start == DataLen && "Data length is wrong");
Douglas Gregorc78d3462009-04-24 21:10:55 +00003278 }
3279};
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +00003280
Douglas Gregorc78d3462009-04-24 21:10:55 +00003281} // end anonymous namespace
3282
Sebastian Redla19a67f2010-08-03 21:58:15 +00003283/// \brief Write ObjC data: selectors and the method pool.
Douglas Gregorc78d3462009-04-24 21:10:55 +00003284///
3285/// The method pool contains both instance and factory methods, stored
Sebastian Redla19a67f2010-08-03 21:58:15 +00003286/// in an on-disk hash table indexed by the selector. The hash table also
3287/// contains an empty entry for every other selector known to Sema.
Sebastian Redl55c0ad52010-08-18 23:56:21 +00003288void ASTWriter::WriteSelectors(Sema &SemaRef) {
Douglas Gregorc78d3462009-04-24 21:10:55 +00003289 using namespace llvm;
3290
Sebastian Redla19a67f2010-08-03 21:58:15 +00003291 // Do we have to do anything at all?
Sebastian Redl834bb972010-08-04 17:20:04 +00003292 if (SemaRef.MethodPool.empty() && SelectorIDs.empty())
Sebastian Redla19a67f2010-08-03 21:58:15 +00003293 return;
Sebastian Redld95a56e2010-08-04 18:21:41 +00003294 unsigned NumTableEntries = 0;
Sebastian Redla19a67f2010-08-03 21:58:15 +00003295 // Create and write out the blob that contains selectors and the method pool.
Douglas Gregorc78d3462009-04-24 21:10:55 +00003296 {
Justin Bognerbb094f02014-04-18 19:57:06 +00003297 llvm::OnDiskChainedHashTableGenerator<ASTMethodPoolTrait> Generator;
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003298 ASTMethodPoolTrait Trait(*this);
Mike Stump11289f42009-09-09 15:08:12 +00003299
Sebastian Redla19a67f2010-08-03 21:58:15 +00003300 // Create the on-disk hash table representation. We walk through every
3301 // selector we've seen and look it up in the method pool.
Sebastian Redld95a56e2010-08-04 18:21:41 +00003302 SelectorOffsets.resize(NextSelectorID - FirstSelectorID);
Chandler Carruthacbbeb92015-03-27 00:47:43 +00003303 for (auto &SelectorAndID : SelectorIDs) {
3304 Selector S = SelectorAndID.first;
3305 SelectorID ID = SelectorAndID.second;
Sebastian Redla19a67f2010-08-03 21:58:15 +00003306 Sema::GlobalMethodPool::iterator F = SemaRef.MethodPool.find(S);
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00003307 ASTMethodPoolTrait::data_type Data = {
Chandler Carruthacbbeb92015-03-27 00:47:43 +00003308 ID,
Sebastian Redl834bb972010-08-04 17:20:04 +00003309 ObjCMethodList(),
3310 ObjCMethodList()
3311 };
3312 if (F != SemaRef.MethodPool.end()) {
3313 Data.Instance = F->second.first;
3314 Data.Factory = F->second.second;
3315 }
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00003316 // Only write this selector if it's not in an existing AST or something
Sebastian Redld95a56e2010-08-04 18:21:41 +00003317 // changed.
Chandler Carruthacbbeb92015-03-27 00:47:43 +00003318 if (Chain && ID < FirstSelectorID) {
Sebastian Redld95a56e2010-08-04 18:21:41 +00003319 // Selector already exists. Did it change?
3320 bool changed = false;
Nico Weber2e0c8f72014-12-27 03:58:08 +00003321 for (ObjCMethodList *M = &Data.Instance;
3322 !changed && M && M->getMethod(); M = M->getNext()) {
3323 if (!M->getMethod()->isFromASTFile())
Sebastian Redld95a56e2010-08-04 18:21:41 +00003324 changed = true;
3325 }
Nico Weber2e0c8f72014-12-27 03:58:08 +00003326 for (ObjCMethodList *M = &Data.Factory; !changed && M && M->getMethod();
Argyrios Kyrtzidisd3da6e02013-04-17 00:08:58 +00003327 M = M->getNext()) {
Nico Weber2e0c8f72014-12-27 03:58:08 +00003328 if (!M->getMethod()->isFromASTFile())
Sebastian Redld95a56e2010-08-04 18:21:41 +00003329 changed = true;
3330 }
3331 if (!changed)
3332 continue;
Nico Weber2e0c8f72014-12-27 03:58:08 +00003333 } else if (Data.Instance.getMethod() || Data.Factory.getMethod()) {
Sebastian Redl6e1a2a02010-08-04 21:22:45 +00003334 // A new method pool entry.
3335 ++NumTableEntries;
Sebastian Redld95a56e2010-08-04 18:21:41 +00003336 }
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003337 Generator.insert(S, Data, Trait);
Douglas Gregorc78d3462009-04-24 21:10:55 +00003338 }
3339
Douglas Gregorc78d3462009-04-24 21:10:55 +00003340 // Create the on-disk hash table in a buffer.
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00003341 SmallString<4096> MethodPool;
Douglas Gregorc78d3462009-04-24 21:10:55 +00003342 uint32_t BucketOffset;
3343 {
Justin Bognere1c147c2014-03-28 22:03:19 +00003344 using namespace llvm::support;
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00003345 ASTMethodPoolTrait Trait(*this);
Douglas Gregorc78d3462009-04-24 21:10:55 +00003346 llvm::raw_svector_ostream Out(MethodPool);
3347 // Make sure that no bucket is at offset 0
Justin Bognere1c147c2014-03-28 22:03:19 +00003348 endian::Writer<little>(Out).write<uint32_t>(0);
Douglas Gregorc78d3462009-04-24 21:10:55 +00003349 BucketOffset = Generator.Emit(Out, Trait);
3350 }
3351
3352 // Create a blob abbreviation
David Blaikieb44f0bf2017-01-04 22:36:43 +00003353 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Sebastian Redl539c5062010-08-18 23:57:32 +00003354 Abbrev->Add(BitCodeAbbrevOp(METHOD_POOL));
Douglas Gregorc78d3462009-04-24 21:10:55 +00003355 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
Douglas Gregor95c13f52009-04-25 17:48:32 +00003356 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
Douglas Gregorc78d3462009-04-24 21:10:55 +00003357 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
David Blaikieb44f0bf2017-01-04 22:36:43 +00003358 unsigned MethodPoolAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregorc78d3462009-04-24 21:10:55 +00003359
Douglas Gregor95c13f52009-04-25 17:48:32 +00003360 // Write the method pool
Mehdi Amini57a41912015-09-10 01:46:39 +00003361 {
3362 RecordData::value_type Record[] = {METHOD_POOL, BucketOffset,
3363 NumTableEntries};
3364 Stream.EmitRecordWithBlob(MethodPoolAbbrev, Record, MethodPool);
3365 }
Douglas Gregor95c13f52009-04-25 17:48:32 +00003366
3367 // Create a blob abbreviation for the selector table offsets.
David Blaikieb44f0bf2017-01-04 22:36:43 +00003368 Abbrev = std::make_shared<BitCodeAbbrev>();
Sebastian Redl539c5062010-08-18 23:57:32 +00003369 Abbrev->Add(BitCodeAbbrevOp(SELECTOR_OFFSETS));
Douglas Gregord4c5ed02010-10-29 22:39:52 +00003370 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // size
Douglas Gregor8f364fb2011-08-03 23:28:44 +00003371 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // first ID
Douglas Gregor95c13f52009-04-25 17:48:32 +00003372 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
David Blaikieb44f0bf2017-01-04 22:36:43 +00003373 unsigned SelectorOffsetAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregor95c13f52009-04-25 17:48:32 +00003374
3375 // Write the selector offsets table.
Mehdi Amini57a41912015-09-10 01:46:39 +00003376 {
3377 RecordData::value_type Record[] = {
3378 SELECTOR_OFFSETS, SelectorOffsets.size(),
3379 FirstSelectorID - NUM_PREDEF_SELECTOR_IDS};
3380 Stream.EmitRecordWithBlob(SelectorOffsetAbbrev, Record,
3381 bytes(SelectorOffsets));
3382 }
Douglas Gregorc78d3462009-04-24 21:10:55 +00003383 }
3384}
3385
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00003386/// \brief Write the selectors referenced in @selector expression into AST file.
Sebastian Redl55c0ad52010-08-18 23:56:21 +00003387void ASTWriter::WriteReferencedSelectorsPool(Sema &SemaRef) {
Fariborz Jahanianc51609a2010-07-23 19:11:11 +00003388 using namespace llvm;
3389 if (SemaRef.ReferencedSelectors.empty())
3390 return;
Sebastian Redlada023c2010-08-04 20:40:17 +00003391
Fariborz Jahanianc51609a2010-07-23 19:11:11 +00003392 RecordData Record;
Richard Smithe64e7452016-04-18 21:54:58 +00003393 ASTRecordWriter Writer(*this, Record);
Sebastian Redlada023c2010-08-04 20:40:17 +00003394
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00003395 // Note: this writes out all references even for a dependent AST. But it is
Sebastian Redl51c79d82010-08-04 22:21:29 +00003396 // very tricky to fix, and given that @selector shouldn't really appear in
3397 // headers, probably not worth it. It's not a correctness issue.
Chandler Carruth12c8f652015-03-27 00:55:05 +00003398 for (auto &SelectorAndLocation : SemaRef.ReferencedSelectors) {
3399 Selector Sel = SelectorAndLocation.first;
3400 SourceLocation Loc = SelectorAndLocation.second;
Richard Smithe64e7452016-04-18 21:54:58 +00003401 Writer.AddSelectorRef(Sel);
3402 Writer.AddSourceLocation(Loc);
Fariborz Jahanianc51609a2010-07-23 19:11:11 +00003403 }
Richard Smithe64e7452016-04-18 21:54:58 +00003404 Writer.Emit(REFERENCED_SELECTOR_POOL);
Fariborz Jahanianc51609a2010-07-23 19:11:11 +00003405}
3406
Douglas Gregorc5046832009-04-27 18:38:38 +00003407//===----------------------------------------------------------------------===//
3408// Identifier Table Serialization
3409//===----------------------------------------------------------------------===//
3410
Richard Smithb3761912015-02-05 23:08:52 +00003411/// Determine the declaration that should be put into the name lookup table to
3412/// represent the given declaration in this module. This is usually D itself,
3413/// but if D was imported and merged into a local declaration, we want the most
3414/// recent local declaration instead. The chosen declaration will be the most
3415/// recent declaration in any module that imports this one.
3416static NamedDecl *getDeclForLocalLookup(const LangOptions &LangOpts,
3417 NamedDecl *D) {
3418 if (!LangOpts.Modules || !D->isFromASTFile())
3419 return D;
3420
3421 if (Decl *Redecl = D->getPreviousDecl()) {
3422 // For Redeclarable decls, a prior declaration might be local.
3423 for (; Redecl; Redecl = Redecl->getPreviousDecl()) {
Richard Smithd49941b2016-04-26 23:40:43 +00003424 // If we find a local decl, we're done.
3425 if (!Redecl->isFromASTFile()) {
3426 // Exception: in very rare cases (for injected-class-names), not all
3427 // redeclarations are in the same semantic context. Skip ones in a
3428 // different context. They don't go in this lookup table at all.
3429 if (!Redecl->getDeclContext()->getRedeclContext()->Equals(
3430 D->getDeclContext()->getRedeclContext()))
3431 continue;
Richard Smithb3761912015-02-05 23:08:52 +00003432 return cast<NamedDecl>(Redecl);
Richard Smithd49941b2016-04-26 23:40:43 +00003433 }
3434
Richard Smithfe620d22015-03-05 23:24:12 +00003435 // If we find a decl from a (chained-)PCH stop since we won't find a
Richard Smithb3761912015-02-05 23:08:52 +00003436 // local one.
Richard Smithd49941b2016-04-26 23:40:43 +00003437 if (Redecl->getOwningModuleID() == 0)
Richard Smithb3761912015-02-05 23:08:52 +00003438 break;
3439 }
3440 } else if (Decl *First = D->getCanonicalDecl()) {
3441 // For Mergeable decls, the first decl might be local.
3442 if (!First->isFromASTFile())
3443 return cast<NamedDecl>(First);
3444 }
3445
3446 // All declarations are imported. Our most recent declaration will also be
3447 // the most recent one in anyone who imports us.
3448 return D;
3449}
3450
Douglas Gregorc78d3462009-04-24 21:10:55 +00003451namespace {
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +00003452
Richard Smithcf97cf62015-04-19 01:34:23 +00003453class ASTIdentifierTableTrait {
3454 ASTWriter &Writer;
3455 Preprocessor &PP;
3456 IdentifierResolver &IdResolver;
Richard Smith9c254182015-07-19 21:41:12 +00003457 bool IsModule;
Richard Smitha534a312015-07-21 23:54:07 +00003458 bool NeedDecls;
Richard Smith33e0f7e2015-07-22 02:08:40 +00003459 ASTWriter::RecordData *InterestingIdentifierOffsets;
Richard Smithcf97cf62015-04-19 01:34:23 +00003460
3461 /// \brief Determines whether this is an "interesting" identifier that needs a
3462 /// full IdentifierInfo structure written into the hash table. Notably, this
3463 /// doesn't check whether the name has macros defined; use PublicMacroIterator
3464 /// to check that.
Richard Smith9c254182015-07-19 21:41:12 +00003465 bool isInterestingIdentifier(const IdentifierInfo *II, uint64_t MacroOffset) {
Richard Smithd7329392015-04-21 21:46:32 +00003466 if (MacroOffset ||
3467 II->isPoisoned() ||
Richard Smith9c254182015-07-19 21:41:12 +00003468 (IsModule ? II->hasRevertedBuiltin() : II->getObjCOrBuiltinID()) ||
Richard Smithcf97cf62015-04-19 01:34:23 +00003469 II->hasRevertedTokenIDToIdentifier() ||
Richard Smitha534a312015-07-21 23:54:07 +00003470 (NeedDecls && II->getFETokenInfo<void>()))
Richard Smithcf97cf62015-04-19 01:34:23 +00003471 return true;
3472
3473 return false;
3474 }
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00003475
Douglas Gregore84a9da2009-04-20 20:36:09 +00003476public:
Douglas Gregor4a69c2e2011-09-01 17:04:32 +00003477 typedef IdentifierInfo* key_type;
Douglas Gregore84a9da2009-04-20 20:36:09 +00003478 typedef key_type key_type_ref;
Mike Stump11289f42009-09-09 15:08:12 +00003479
Sebastian Redl539c5062010-08-18 23:57:32 +00003480 typedef IdentID data_type;
Douglas Gregore84a9da2009-04-20 20:36:09 +00003481 typedef data_type data_type_ref;
Mike Stump11289f42009-09-09 15:08:12 +00003482
Justin Bogner25463f12014-04-18 20:27:24 +00003483 typedef unsigned hash_value_type;
3484 typedef unsigned offset_type;
3485
Richard Smithd7329392015-04-21 21:46:32 +00003486 ASTIdentifierTableTrait(ASTWriter &Writer, Preprocessor &PP,
Richard Smith33e0f7e2015-07-22 02:08:40 +00003487 IdentifierResolver &IdResolver, bool IsModule,
3488 ASTWriter::RecordData *InterestingIdentifierOffsets)
Richard Smitha534a312015-07-21 23:54:07 +00003489 : Writer(Writer), PP(PP), IdResolver(IdResolver), IsModule(IsModule),
Richard Smith33e0f7e2015-07-22 02:08:40 +00003490 NeedDecls(!IsModule || !Writer.getLangOpts().CPlusPlus),
3491 InterestingIdentifierOffsets(InterestingIdentifierOffsets) {}
Douglas Gregore84a9da2009-04-20 20:36:09 +00003492
Richard Smithd79514e2016-02-05 19:03:40 +00003493 bool needDecls() const { return NeedDecls; }
3494
Justin Bogner25463f12014-04-18 20:27:24 +00003495 static hash_value_type ComputeHash(const IdentifierInfo* II) {
Daniel Dunbarf8502d52009-10-17 23:52:28 +00003496 return llvm::HashString(II->getName());
Douglas Gregore84a9da2009-04-20 20:36:09 +00003497 }
Mike Stump11289f42009-09-09 15:08:12 +00003498
Richard Smith33e0f7e2015-07-22 02:08:40 +00003499 bool isInterestingIdentifier(const IdentifierInfo *II) {
3500 auto MacroOffset = Writer.getMacroDirectivesOffset(II);
3501 return isInterestingIdentifier(II, MacroOffset);
3502 }
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +00003503
Richard Smith9c254182015-07-19 21:41:12 +00003504 bool isInterestingNonMacroIdentifier(const IdentifierInfo *II) {
3505 return isInterestingIdentifier(II, 0);
3506 }
3507
Mike Stump11289f42009-09-09 15:08:12 +00003508 std::pair<unsigned,unsigned>
Douglas Gregor935bc7a22011-10-27 09:33:13 +00003509 EmitKeyDataLength(raw_ostream& Out, IdentifierInfo* II, IdentID ID) {
Daniel Dunbar2c422dc92009-10-18 20:26:12 +00003510 unsigned KeyLen = II->getLength() + 1;
Douglas Gregor1d583f22009-04-28 21:18:29 +00003511 unsigned DataLen = 4; // 4 bytes for the persistent ID << 1
Richard Smithd7329392015-04-21 21:46:32 +00003512 auto MacroOffset = Writer.getMacroDirectivesOffset(II);
3513 if (isInterestingIdentifier(II, MacroOffset)) {
Alexander Kornienko1d26c022012-09-25 17:18:14 +00003514 DataLen += 2; // 2 bytes for builtin ID
3515 DataLen += 2; // 2 bytes for flags
Richard Smithd7329392015-04-21 21:46:32 +00003516 if (MacroOffset)
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00003517 DataLen += 4; // MacroDirectives offset.
Alexander Kornienko1d26c022012-09-25 17:18:14 +00003518
Richard Smitha534a312015-07-21 23:54:07 +00003519 if (NeedDecls) {
3520 for (IdentifierResolver::iterator D = IdResolver.begin(II),
3521 DEnd = IdResolver.end();
3522 D != DEnd; ++D)
3523 DataLen += 4;
3524 }
Douglas Gregor1d583f22009-04-28 21:18:29 +00003525 }
Justin Bognere1c147c2014-03-28 22:03:19 +00003526 using namespace llvm::support;
3527 endian::Writer<little> LE(Out);
3528
Richard Smithdf8a8312015-03-13 04:05:01 +00003529 assert((uint16_t)DataLen == DataLen && (uint16_t)KeyLen == KeyLen);
Justin Bognere1c147c2014-03-28 22:03:19 +00003530 LE.write<uint16_t>(DataLen);
Douglas Gregorab4df582009-04-28 20:01:51 +00003531 // We emit the key length after the data length so that every
3532 // string is preceded by a 16-bit length. This matches the PTH
3533 // format for storing identifiers.
Justin Bognere1c147c2014-03-28 22:03:19 +00003534 LE.write<uint16_t>(KeyLen);
Douglas Gregore84a9da2009-04-20 20:36:09 +00003535 return std::make_pair(KeyLen, DataLen);
3536 }
Mike Stump11289f42009-09-09 15:08:12 +00003537
Chris Lattner0e62c1c2011-07-23 10:55:15 +00003538 void EmitKey(raw_ostream& Out, const IdentifierInfo* II,
Douglas Gregore84a9da2009-04-20 20:36:09 +00003539 unsigned KeyLen) {
3540 // Record the location of the key data. This is used when generating
3541 // the mapping from persistent IDs to strings.
3542 Writer.SetIdentifierOffset(II, Out.tell());
Richard Smith33e0f7e2015-07-22 02:08:40 +00003543
3544 // Emit the offset of the key/data length information to the interesting
3545 // identifiers table if necessary.
3546 if (InterestingIdentifierOffsets && isInterestingIdentifier(II))
3547 InterestingIdentifierOffsets->push_back(Out.tell() - 4);
3548
Daniel Dunbar2c422dc92009-10-18 20:26:12 +00003549 Out.write(II->getNameStart(), KeyLen);
Douglas Gregore84a9da2009-04-20 20:36:09 +00003550 }
Mike Stump11289f42009-09-09 15:08:12 +00003551
Douglas Gregor4a69c2e2011-09-01 17:04:32 +00003552 void EmitData(raw_ostream& Out, IdentifierInfo* II,
Sebastian Redl539c5062010-08-18 23:57:32 +00003553 IdentID ID, unsigned) {
Justin Bognere1c147c2014-03-28 22:03:19 +00003554 using namespace llvm::support;
3555 endian::Writer<little> LE(Out);
Richard Smithcf97cf62015-04-19 01:34:23 +00003556
Richard Smithd7329392015-04-21 21:46:32 +00003557 auto MacroOffset = Writer.getMacroDirectivesOffset(II);
3558 if (!isInterestingIdentifier(II, MacroOffset)) {
Justin Bognere1c147c2014-03-28 22:03:19 +00003559 LE.write<uint32_t>(ID << 1);
Douglas Gregor1d583f22009-04-28 21:18:29 +00003560 return;
3561 }
Douglas Gregorb9256522009-04-28 21:32:13 +00003562
Justin Bognere1c147c2014-03-28 22:03:19 +00003563 LE.write<uint32_t>((ID << 1) | 0x01);
Alexander Kornienko1d26c022012-09-25 17:18:14 +00003564 uint32_t Bits = (uint32_t)II->getObjCOrBuiltinID();
3565 assert((Bits & 0xffff) == Bits && "ObjCOrBuiltinID too big for ASTReader.");
Justin Bognere1c147c2014-03-28 22:03:19 +00003566 LE.write<uint16_t>(Bits);
Alexander Kornienko1d26c022012-09-25 17:18:14 +00003567 Bits = 0;
Richard Smithd7329392015-04-21 21:46:32 +00003568 bool HadMacroDefinition = MacroOffset != 0;
Alexander Kornienko1d26c022012-09-25 17:18:14 +00003569 Bits = (Bits << 1) | unsigned(HadMacroDefinition);
Daniel Dunbar91b640a2009-12-18 20:58:47 +00003570 Bits = (Bits << 1) | unsigned(II->isExtensionToken());
3571 Bits = (Bits << 1) | unsigned(II->isPoisoned());
Richard Smith9c254182015-07-19 21:41:12 +00003572 Bits = (Bits << 1) | unsigned(II->hasRevertedBuiltin());
Argyrios Kyrtzidis3084a612010-08-11 22:55:12 +00003573 Bits = (Bits << 1) | unsigned(II->hasRevertedTokenIDToIdentifier());
Daniel Dunbar91b640a2009-12-18 20:58:47 +00003574 Bits = (Bits << 1) | unsigned(II->isCPlusPlusOperatorKeyword());
Justin Bognere1c147c2014-03-28 22:03:19 +00003575 LE.write<uint16_t>(Bits);
Douglas Gregore84a9da2009-04-20 20:36:09 +00003576
Richard Smithd7329392015-04-21 21:46:32 +00003577 if (HadMacroDefinition)
3578 LE.write<uint32_t>(MacroOffset);
Alexander Kornienko1d26c022012-09-25 17:18:14 +00003579
Richard Smitha534a312015-07-21 23:54:07 +00003580 if (NeedDecls) {
3581 // Emit the declaration IDs in reverse order, because the
3582 // IdentifierResolver provides the declarations as they would be
3583 // visible (e.g., the function "stat" would come before the struct
3584 // "stat"), but the ASTReader adds declarations to the end of the list
3585 // (so we need to see the struct "stat" before the function "stat").
3586 // Only emit declarations that aren't from a chained PCH, though.
3587 SmallVector<NamedDecl *, 16> Decls(IdResolver.begin(II),
3588 IdResolver.end());
3589 for (SmallVectorImpl<NamedDecl *>::reverse_iterator D = Decls.rbegin(),
3590 DEnd = Decls.rend();
3591 D != DEnd; ++D)
3592 LE.write<uint32_t>(
3593 Writer.getDeclID(getDeclForLocalLookup(PP.getLangOpts(), *D)));
3594 }
Douglas Gregore84a9da2009-04-20 20:36:09 +00003595 }
3596};
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +00003597
Douglas Gregore84a9da2009-04-20 20:36:09 +00003598} // end anonymous namespace
3599
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00003600/// \brief Write the identifier table into the AST file.
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00003601///
3602/// The identifier table consists of a blob containing string data
3603/// (the actual identifiers themselves) and a separate "offsets" index
3604/// that maps identifier IDs to locations within the blob.
Douglas Gregor935bc7a22011-10-27 09:33:13 +00003605void ASTWriter::WriteIdentifierTable(Preprocessor &PP,
3606 IdentifierResolver &IdResolver,
3607 bool IsModule) {
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00003608 using namespace llvm;
3609
Richard Smith33e0f7e2015-07-22 02:08:40 +00003610 RecordData InterestingIdents;
3611
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00003612 // Create and write out the blob that contains the identifier
3613 // strings.
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00003614 {
Justin Bognerbb094f02014-04-18 19:57:06 +00003615 llvm::OnDiskChainedHashTableGenerator<ASTIdentifierTableTrait> Generator;
Richard Smith33e0f7e2015-07-22 02:08:40 +00003616 ASTIdentifierTableTrait Trait(
3617 *this, PP, IdResolver, IsModule,
3618 (getLangOpts().CPlusPlus && IsModule) ? &InterestingIdents : nullptr);
Mike Stump11289f42009-09-09 15:08:12 +00003619
Douglas Gregore6648fb2009-04-28 20:33:11 +00003620 // Look for any identifiers that were named while processing the
3621 // headers, but are otherwise not needed. We add these to the hash
3622 // table to enable checking of the predefines buffer in the case
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00003623 // where the user adds new macro definitions when building the AST
Douglas Gregore6648fb2009-04-28 20:33:11 +00003624 // file.
Chandler Carruth8440c982015-03-26 23:54:15 +00003625 SmallVector<const IdentifierInfo *, 128> IIs;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00003626 for (const auto &ID : PP.getIdentifierTable())
3627 IIs.push_back(ID.second);
Chandler Carruth8440c982015-03-26 23:54:15 +00003628 // Sort the identifiers lexicographically before getting them references so
3629 // that their order is stable.
3630 std::sort(IIs.begin(), IIs.end(), llvm::less_ptr<IdentifierInfo>());
3631 for (const IdentifierInfo *II : IIs)
Richard Smith9c254182015-07-19 21:41:12 +00003632 if (Trait.isInterestingNonMacroIdentifier(II))
3633 getIdentifierRef(II);
Douglas Gregore6648fb2009-04-28 20:33:11 +00003634
Sebastian Redlff4a2952010-07-23 23:49:55 +00003635 // Create the on-disk hash table representation. We only store offsets
3636 // for identifiers that appear here for the first time.
3637 IdentifierOffsets.resize(NextIdentID - FirstIdentID);
Chandler Carruth885e78c2015-03-24 21:18:10 +00003638 for (auto IdentIDPair : IdentifierIDs) {
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00003639 auto *II = const_cast<IdentifierInfo *>(IdentIDPair.first);
Chandler Carruth885e78c2015-03-24 21:18:10 +00003640 IdentID ID = IdentIDPair.second;
3641 assert(II && "NULL identifier in identifier table");
Vassil Vassilev262f41e2016-03-30 20:16:03 +00003642 // Write out identifiers if either the ID is local or the identifier has
3643 // changed since it was loaded.
3644 if (ID >= FirstIdentID || !Chain || !II->isFromAST()
3645 || II->hasChangedSinceDeserialization() ||
Richard Smithd79514e2016-02-05 19:03:40 +00003646 (Trait.needDecls() &&
3647 II->hasFETokenInfoChangedSinceDeserialization()))
Chandler Carruth885e78c2015-03-24 21:18:10 +00003648 Generator.insert(II, ID, Trait);
Douglas Gregore84a9da2009-04-20 20:36:09 +00003649 }
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00003650
Douglas Gregore84a9da2009-04-20 20:36:09 +00003651 // Create the on-disk hash table in a buffer.
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00003652 SmallString<4096> IdentifierTable;
Douglas Gregora868bbd2009-04-21 22:25:48 +00003653 uint32_t BucketOffset;
Douglas Gregore84a9da2009-04-20 20:36:09 +00003654 {
Justin Bognere1c147c2014-03-28 22:03:19 +00003655 using namespace llvm::support;
Douglas Gregore84a9da2009-04-20 20:36:09 +00003656 llvm::raw_svector_ostream Out(IdentifierTable);
Douglas Gregorc78d3462009-04-24 21:10:55 +00003657 // Make sure that no bucket is at offset 0
Justin Bognere1c147c2014-03-28 22:03:19 +00003658 endian::Writer<little>(Out).write<uint32_t>(0);
Douglas Gregora868bbd2009-04-21 22:25:48 +00003659 BucketOffset = Generator.Emit(Out, Trait);
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00003660 }
3661
3662 // Create a blob abbreviation
David Blaikieb44f0bf2017-01-04 22:36:43 +00003663 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Sebastian Redl539c5062010-08-18 23:57:32 +00003664 Abbrev->Add(BitCodeAbbrevOp(IDENTIFIER_TABLE));
Douglas Gregora868bbd2009-04-21 22:25:48 +00003665 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
Douglas Gregore84a9da2009-04-20 20:36:09 +00003666 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
David Blaikieb44f0bf2017-01-04 22:36:43 +00003667 unsigned IDTableAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00003668
3669 // Write the identifier table
Mehdi Amini57a41912015-09-10 01:46:39 +00003670 RecordData::value_type Record[] = {IDENTIFIER_TABLE, BucketOffset};
Yaron Keren92e1b622015-03-18 10:17:07 +00003671 Stream.EmitRecordWithBlob(IDTableAbbrev, Record, IdentifierTable);
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00003672 }
3673
3674 // Write the offsets table for identifier IDs.
David Blaikieb44f0bf2017-01-04 22:36:43 +00003675 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Sebastian Redl539c5062010-08-18 23:57:32 +00003676 Abbrev->Add(BitCodeAbbrevOp(IDENTIFIER_OFFSET));
Douglas Gregor0e149972009-04-25 19:10:14 +00003677 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // # of identifiers
Douglas Gregor1ab036c2011-08-03 21:49:18 +00003678 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // first ID
Douglas Gregor0e149972009-04-25 19:10:14 +00003679 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
David Blaikieb44f0bf2017-01-04 22:36:43 +00003680 unsigned IdentifierOffsetAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregor0e149972009-04-25 19:10:14 +00003681
Douglas Gregor8d7edce2013-02-08 21:30:59 +00003682#ifndef NDEBUG
3683 for (unsigned I = 0, N = IdentifierOffsets.size(); I != N; ++I)
3684 assert(IdentifierOffsets[I] && "Missing identifier offset?");
3685#endif
Mehdi Amini57a41912015-09-10 01:46:39 +00003686
3687 RecordData::value_type Record[] = {IDENTIFIER_OFFSET,
3688 IdentifierOffsets.size(),
3689 FirstIdentID - NUM_PREDEF_IDENT_IDS};
Douglas Gregor0e149972009-04-25 19:10:14 +00003690 Stream.EmitRecordWithBlob(IdentifierOffsetAbbrev, Record,
Reid Kleckner012665e2015-05-21 00:13:09 +00003691 bytes(IdentifierOffsets));
Richard Smith33e0f7e2015-07-22 02:08:40 +00003692
3693 // In C++, write the list of interesting identifiers (those that are
3694 // defined as macros, poisoned, or similar unusual things).
3695 if (!InterestingIdents.empty())
3696 Stream.EmitRecord(INTERESTING_IDENTIFIERS, InterestingIdents);
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00003697}
3698
Douglas Gregorc5046832009-04-27 18:38:38 +00003699//===----------------------------------------------------------------------===//
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003700// DeclContext's Name Lookup Table Serialization
3701//===----------------------------------------------------------------------===//
3702
3703namespace {
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +00003704
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003705// Trait used for the on-disk hash table used in the method pool.
3706class ASTDeclContextNameLookupTrait {
3707 ASTWriter &Writer;
Richard Smithd88a7f12015-09-01 20:35:42 +00003708 llvm::SmallVector<DeclID, 64> DeclIDs;
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003709
3710public:
Richard Smitha06c7e62015-08-26 23:55:49 +00003711 typedef DeclarationNameKey key_type;
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003712 typedef key_type key_type_ref;
3713
Richard Smithd88a7f12015-09-01 20:35:42 +00003714 /// A start and end index into DeclIDs, representing a sequence of decls.
3715 typedef std::pair<unsigned, unsigned> data_type;
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003716 typedef const data_type& data_type_ref;
3717
Justin Bogner25463f12014-04-18 20:27:24 +00003718 typedef unsigned hash_value_type;
3719 typedef unsigned offset_type;
3720
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003721 explicit ASTDeclContextNameLookupTrait(ASTWriter &Writer) : Writer(Writer) { }
3722
Richard Smithd88a7f12015-09-01 20:35:42 +00003723 template<typename Coll>
3724 data_type getData(const Coll &Decls) {
3725 unsigned Start = DeclIDs.size();
3726 for (NamedDecl *D : Decls) {
3727 DeclIDs.push_back(
3728 Writer.GetDeclRef(getDeclForLocalLookup(Writer.getLangOpts(), D)));
3729 }
3730 return std::make_pair(Start, DeclIDs.size());
3731 }
3732
3733 data_type ImportData(const reader::ASTDeclContextNameLookupTrait::data_type &FromReader) {
3734 unsigned Start = DeclIDs.size();
3735 for (auto ID : FromReader)
3736 DeclIDs.push_back(ID);
3737 return std::make_pair(Start, DeclIDs.size());
3738 }
3739
3740 static bool EqualKey(key_type_ref a, key_type_ref b) {
3741 return a == b;
3742 }
3743
Richard Smitha06c7e62015-08-26 23:55:49 +00003744 hash_value_type ComputeHash(DeclarationNameKey Name) {
3745 return Name.getHash();
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003746 }
3747
Richard Smithd88a7f12015-09-01 20:35:42 +00003748 void EmitFileRef(raw_ostream &Out, ModuleFile *F) const {
3749 assert(Writer.hasChain() &&
3750 "have reference to loaded module file but no chain?");
3751
3752 using namespace llvm::support;
3753 endian::Writer<little>(Out)
3754 .write<uint32_t>(Writer.getChain()->getModuleFileID(F));
3755 }
3756
Richard Smitha06c7e62015-08-26 23:55:49 +00003757 std::pair<unsigned, unsigned> EmitKeyDataLength(raw_ostream &Out,
3758 DeclarationNameKey Name,
3759 data_type_ref Lookup) {
Justin Bognere1c147c2014-03-28 22:03:19 +00003760 using namespace llvm::support;
3761 endian::Writer<little> LE(Out);
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003762 unsigned KeyLen = 1;
Richard Smitha06c7e62015-08-26 23:55:49 +00003763 switch (Name.getKind()) {
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003764 case DeclarationName::Identifier:
3765 case DeclarationName::ObjCZeroArgSelector:
3766 case DeclarationName::ObjCOneArgSelector:
3767 case DeclarationName::ObjCMultiArgSelector:
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003768 case DeclarationName::CXXLiteralOperatorName:
Richard Smith35845152017-02-07 01:37:30 +00003769 case DeclarationName::CXXDeductionGuideName:
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003770 KeyLen += 4;
3771 break;
3772 case DeclarationName::CXXOperatorName:
3773 KeyLen += 1;
3774 break;
Douglas Gregor3b65ed02011-08-02 18:32:54 +00003775 case DeclarationName::CXXConstructorName:
3776 case DeclarationName::CXXDestructorName:
3777 case DeclarationName::CXXConversionFunctionName:
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003778 case DeclarationName::CXXUsingDirective:
3779 break;
3780 }
Justin Bognere1c147c2014-03-28 22:03:19 +00003781 LE.write<uint16_t>(KeyLen);
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003782
Richard Smithf02662d2015-07-30 03:17:16 +00003783 // 4 bytes for each DeclID.
Richard Smithd88a7f12015-09-01 20:35:42 +00003784 unsigned DataLen = 4 * (Lookup.second - Lookup.first);
3785 assert(uint16_t(DataLen) == DataLen &&
3786 "too many decls for serialized lookup result");
Justin Bognere1c147c2014-03-28 22:03:19 +00003787 LE.write<uint16_t>(DataLen);
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003788
3789 return std::make_pair(KeyLen, DataLen);
3790 }
3791
Richard Smitha06c7e62015-08-26 23:55:49 +00003792 void EmitKey(raw_ostream &Out, DeclarationNameKey Name, unsigned) {
Justin Bognere1c147c2014-03-28 22:03:19 +00003793 using namespace llvm::support;
3794 endian::Writer<little> LE(Out);
Richard Smitha06c7e62015-08-26 23:55:49 +00003795 LE.write<uint8_t>(Name.getKind());
3796 switch (Name.getKind()) {
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003797 case DeclarationName::Identifier:
Richard Smitha06c7e62015-08-26 23:55:49 +00003798 case DeclarationName::CXXLiteralOperatorName:
Richard Smith35845152017-02-07 01:37:30 +00003799 case DeclarationName::CXXDeductionGuideName:
Richard Smitha06c7e62015-08-26 23:55:49 +00003800 LE.write<uint32_t>(Writer.getIdentifierRef(Name.getIdentifier()));
Benjamin Kramer53750b12012-09-19 13:40:40 +00003801 return;
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003802 case DeclarationName::ObjCZeroArgSelector:
3803 case DeclarationName::ObjCOneArgSelector:
3804 case DeclarationName::ObjCMultiArgSelector:
Richard Smitha06c7e62015-08-26 23:55:49 +00003805 LE.write<uint32_t>(Writer.getSelectorRef(Name.getSelector()));
Benjamin Kramer53750b12012-09-19 13:40:40 +00003806 return;
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003807 case DeclarationName::CXXOperatorName:
Richard Smitha06c7e62015-08-26 23:55:49 +00003808 assert(Name.getOperatorKind() < NUM_OVERLOADED_OPERATORS &&
Benjamin Kramer53750b12012-09-19 13:40:40 +00003809 "Invalid operator?");
Richard Smitha06c7e62015-08-26 23:55:49 +00003810 LE.write<uint8_t>(Name.getOperatorKind());
Benjamin Kramer53750b12012-09-19 13:40:40 +00003811 return;
Douglas Gregor3b65ed02011-08-02 18:32:54 +00003812 case DeclarationName::CXXConstructorName:
3813 case DeclarationName::CXXDestructorName:
3814 case DeclarationName::CXXConversionFunctionName:
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003815 case DeclarationName::CXXUsingDirective:
Benjamin Kramer53750b12012-09-19 13:40:40 +00003816 return;
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003817 }
Benjamin Kramer53750b12012-09-19 13:40:40 +00003818
3819 llvm_unreachable("Invalid name kind?");
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003820 }
3821
Richard Smitha06c7e62015-08-26 23:55:49 +00003822 void EmitData(raw_ostream &Out, key_type_ref, data_type Lookup,
3823 unsigned DataLen) {
Justin Bognere1c147c2014-03-28 22:03:19 +00003824 using namespace llvm::support;
3825 endian::Writer<little> LE(Out);
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003826 uint64_t Start = Out.tell(); (void)Start;
Richard Smithd88a7f12015-09-01 20:35:42 +00003827 for (unsigned I = Lookup.first, N = Lookup.second; I != N; ++I)
3828 LE.write<uint32_t>(DeclIDs[I]);
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003829 assert(Out.tell() - Start == DataLen && "Data length is wrong");
3830 }
3831};
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +00003832
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003833} // end anonymous namespace
3834
Chandler Carruthe972c362015-03-26 03:11:40 +00003835bool ASTWriter::isLookupResultExternal(StoredDeclsList &Result,
3836 DeclContext *DC) {
3837 return Result.hasExternalDecls() && DC->NeedToReconcileExternalVisibleStorage;
3838}
3839
3840bool ASTWriter::isLookupResultEntirelyExternal(StoredDeclsList &Result,
3841 DeclContext *DC) {
3842 for (auto *D : Result.getLookupResult())
3843 if (!getDeclForLocalLookup(getLangOpts(), D)->isFromASTFile())
3844 return false;
3845
3846 return true;
3847}
3848
Richard Smithd88a7f12015-09-01 20:35:42 +00003849void
Chandler Carruthe972c362015-03-26 03:11:40 +00003850ASTWriter::GenerateNameLookupTable(const DeclContext *ConstDC,
Richard Smithcd45dbc2014-04-19 03:48:30 +00003851 llvm::SmallVectorImpl<char> &LookupTable) {
Chandler Carruthe972c362015-03-26 03:11:40 +00003852 assert(!ConstDC->HasLazyLocalLexicalLookups &&
3853 !ConstDC->HasLazyExternalLexicalLookups &&
Richard Smith9e2341d2015-03-23 03:25:59 +00003854 "must call buildLookups first");
Richard Smithcd45dbc2014-04-19 03:48:30 +00003855
Chandler Carruthe972c362015-03-26 03:11:40 +00003856 // FIXME: We need to build the lookups table, which is logically const.
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00003857 auto *DC = const_cast<DeclContext*>(ConstDC);
Chandler Carruthe972c362015-03-26 03:11:40 +00003858 assert(DC == DC->getPrimaryContext() && "only primary DC has lookup table");
3859
3860 // Create the on-disk hash table representation.
Richard Smithd88a7f12015-09-01 20:35:42 +00003861 MultiOnDiskHashTableGenerator<reader::ASTDeclContextNameLookupTrait,
3862 ASTDeclContextNameLookupTrait> Generator;
Richard Smithcd45dbc2014-04-19 03:48:30 +00003863 ASTDeclContextNameLookupTrait Trait(*this);
3864
Chandler Carruthe972c362015-03-26 03:11:40 +00003865 // The first step is to collect the declaration names which we need to
3866 // serialize into the name lookup table, and to collect them in a stable
3867 // order.
3868 SmallVector<DeclarationName, 16> Names;
Richard Smithcd45dbc2014-04-19 03:48:30 +00003869
Chandler Carruthe972c362015-03-26 03:11:40 +00003870 // We also build up small sets of the constructor and conversion function
3871 // names which are visible.
3872 llvm::SmallSet<DeclarationName, 8> ConstructorNameSet, ConversionNameSet;
Richard Smithcd45dbc2014-04-19 03:48:30 +00003873
Chandler Carruthe972c362015-03-26 03:11:40 +00003874 for (auto &Lookup : *DC->buildLookup()) {
3875 auto &Name = Lookup.first;
3876 auto &Result = Lookup.second;
3877
Douglas Gregor7dd37e52015-11-03 01:20:54 +00003878 // If there are no local declarations in our lookup result, we
3879 // don't need to write an entry for the name at all. If we can't
3880 // write out a lookup set without performing more deserialization,
3881 // just skip this entry.
3882 if (isLookupResultExternal(Result, DC) &&
Chandler Carruthe972c362015-03-26 03:11:40 +00003883 isLookupResultEntirelyExternal(Result, DC))
3884 continue;
3885
3886 // We also skip empty results. If any of the results could be external and
3887 // the currently available results are empty, then all of the results are
3888 // external and we skip it above. So the only way we get here with an empty
3889 // results is when no results could have been external *and* we have
3890 // external results.
3891 //
3892 // FIXME: While we might want to start emitting on-disk entries for negative
3893 // lookups into a decl context as an optimization, today we *have* to skip
3894 // them because there are names with empty lookup results in decl contexts
3895 // which we can't emit in any stable ordering: we lookup constructors and
3896 // conversion functions in the enclosing namespace scope creating empty
3897 // results for them. This in almost certainly a bug in Clang's name lookup,
3898 // but that is likely to be hard or impossible to fix and so we tolerate it
3899 // here by omitting lookups with empty results.
3900 if (Lookup.second.getLookupResult().empty())
3901 continue;
3902
3903 switch (Lookup.first.getNameKind()) {
3904 default:
3905 Names.push_back(Lookup.first);
3906 break;
3907
Richard Smithcd45dbc2014-04-19 03:48:30 +00003908 case DeclarationName::CXXConstructorName:
Chandler Carruthe972c362015-03-26 03:11:40 +00003909 assert(isa<CXXRecordDecl>(DC) &&
3910 "Cannot have a constructor name outside of a class!");
3911 ConstructorNameSet.insert(Name);
3912 break;
Richard Smithcd45dbc2014-04-19 03:48:30 +00003913
3914 case DeclarationName::CXXConversionFunctionName:
Chandler Carruthe972c362015-03-26 03:11:40 +00003915 assert(isa<CXXRecordDecl>(DC) &&
3916 "Cannot have a conversion function name outside of a class!");
3917 ConversionNameSet.insert(Name);
Rafael Espindolac606b3e2015-03-25 04:43:15 +00003918 break;
Richard Smithcd45dbc2014-04-19 03:48:30 +00003919 }
Chandler Carruth75c9f132015-03-25 00:34:51 +00003920 }
Chandler Carruth75c9f132015-03-25 00:34:51 +00003921
Chandler Carruthe972c362015-03-26 03:11:40 +00003922 // Sort the names into a stable order.
3923 std::sort(Names.begin(), Names.end());
3924
Chandler Carruthffbf7052015-03-26 22:27:09 +00003925 if (auto *D = dyn_cast<CXXRecordDecl>(DC)) {
Chandler Carruthe972c362015-03-26 03:11:40 +00003926 // We need to establish an ordering of constructor and conversion function
Chandler Carruthffbf7052015-03-26 22:27:09 +00003927 // names, and they don't have an intrinsic ordering.
Chandler Carruthe972c362015-03-26 03:11:40 +00003928
Chandler Carruthffbf7052015-03-26 22:27:09 +00003929 // First we try the easy case by forming the current context's constructor
3930 // name and adding that name first. This is a very useful optimization to
3931 // avoid walking the lexical declarations in many cases, and it also
3932 // handles the only case where a constructor name can come from some other
3933 // lexical context -- when that name is an implicit constructor merged from
3934 // another declaration in the redecl chain. Any non-implicit constructor or
3935 // conversion function which doesn't occur in all the lexical contexts
3936 // would be an ODR violation.
3937 auto ImplicitCtorName = Context->DeclarationNames.getCXXConstructorName(
3938 Context->getCanonicalType(Context->getRecordType(D)));
3939 if (ConstructorNameSet.erase(ImplicitCtorName))
3940 Names.push_back(ImplicitCtorName);
Chandler Carruthe972c362015-03-26 03:11:40 +00003941
Chandler Carruthffbf7052015-03-26 22:27:09 +00003942 // If we still have constructors or conversion functions, we walk all the
3943 // names in the decl and add the constructors and conversion functions
3944 // which are visible in the order they lexically occur within the context.
3945 if (!ConstructorNameSet.empty() || !ConversionNameSet.empty())
3946 for (Decl *ChildD : cast<CXXRecordDecl>(DC)->decls())
3947 if (auto *ChildND = dyn_cast<NamedDecl>(ChildD)) {
3948 auto Name = ChildND->getDeclName();
3949 switch (Name.getNameKind()) {
3950 default:
3951 continue;
3952
3953 case DeclarationName::CXXConstructorName:
3954 if (ConstructorNameSet.erase(Name))
3955 Names.push_back(Name);
3956 break;
3957
3958 case DeclarationName::CXXConversionFunctionName:
3959 if (ConversionNameSet.erase(Name))
3960 Names.push_back(Name);
3961 break;
3962 }
3963
3964 if (ConstructorNameSet.empty() && ConversionNameSet.empty())
3965 break;
Chandler Carruthe972c362015-03-26 03:11:40 +00003966 }
3967
Chandler Carruthe972c362015-03-26 03:11:40 +00003968 assert(ConstructorNameSet.empty() && "Failed to find all of the visible "
3969 "constructors by walking all the "
3970 "lexical members of the context.");
3971 assert(ConversionNameSet.empty() && "Failed to find all of the visible "
3972 "conversion functions by walking all "
3973 "the lexical members of the context.");
Richard Smith961eae52014-03-25 01:14:22 +00003974 }
3975
Chandler Carruthe972c362015-03-26 03:11:40 +00003976 // Next we need to do a lookup with each name into this decl context to fully
3977 // populate any results from external sources. We don't actually use the
3978 // results of these lookups because we only want to use the results after all
3979 // results have been loaded and the pointers into them will be stable.
3980 for (auto &Name : Names)
3981 DC->lookup(Name);
3982
3983 // Now we need to insert the results for each name into the hash table. For
3984 // constructor names and conversion function names, we actually need to merge
3985 // all of the results for them into one list of results each and insert
3986 // those.
3987 SmallVector<NamedDecl *, 8> ConstructorDecls;
3988 SmallVector<NamedDecl *, 8> ConversionDecls;
3989
3990 // Now loop over the names, either inserting them or appending for the two
3991 // special cases.
3992 for (auto &Name : Names) {
3993 DeclContext::lookup_result Result = DC->noload_lookup(Name);
3994
3995 switch (Name.getNameKind()) {
3996 default:
Richard Smithd88a7f12015-09-01 20:35:42 +00003997 Generator.insert(Name, Trait.getData(Result), Trait);
Chandler Carruthe972c362015-03-26 03:11:40 +00003998 break;
3999
4000 case DeclarationName::CXXConstructorName:
4001 ConstructorDecls.append(Result.begin(), Result.end());
4002 break;
4003
4004 case DeclarationName::CXXConversionFunctionName:
4005 ConversionDecls.append(Result.begin(), Result.end());
4006 break;
4007 }
4008 }
4009
4010 // Handle our two special cases if we ended up having any. We arbitrarily use
4011 // the first declaration's name here because the name itself isn't part of
4012 // the key, only the kind of name is used.
4013 if (!ConstructorDecls.empty())
4014 Generator.insert(ConstructorDecls.front()->getDeclName(),
Richard Smithd88a7f12015-09-01 20:35:42 +00004015 Trait.getData(ConstructorDecls), Trait);
Chandler Carruthe972c362015-03-26 03:11:40 +00004016 if (!ConversionDecls.empty())
4017 Generator.insert(ConversionDecls.front()->getDeclName(),
Richard Smithd88a7f12015-09-01 20:35:42 +00004018 Trait.getData(ConversionDecls), Trait);
Chandler Carruthe972c362015-03-26 03:11:40 +00004019
Richard Smithd88a7f12015-09-01 20:35:42 +00004020 // Create the on-disk hash table. Also emit the existing imported and
4021 // merged table if there is one.
4022 auto *Lookups = Chain ? Chain->getLoadedLookupTables(DC) : nullptr;
4023 Generator.emit(LookupTable, Trait, Lookups ? &Lookups->Table : nullptr);
Richard Smith961eae52014-03-25 01:14:22 +00004024}
4025
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00004026/// \brief Write the block containing all of the declaration IDs
4027/// visible from the given DeclContext.
4028///
4029/// \returns the offset of the DECL_CONTEXT_VISIBLE block within the
Sebastian Redla4071b42010-08-24 00:50:09 +00004030/// bitstream, or 0 if no block was written.
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00004031uint64_t ASTWriter::WriteDeclContextVisibleBlock(ASTContext &Context,
4032 DeclContext *DC) {
Richard Smith5fc18a92015-07-12 23:43:21 +00004033 // If we imported a key declaration of this namespace, write the visible
4034 // lookup results as an update record for it rather than including them
4035 // on this declaration. We will only look at key declarations on reload.
4036 if (isa<NamespaceDecl>(DC) && Chain &&
4037 Chain->getKeyDeclaration(cast<Decl>(DC))->isFromASTFile()) {
4038 // Only do this once, for the first local declaration of the namespace.
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00004039 for (auto *Prev = cast<NamespaceDecl>(DC)->getPreviousDecl(); Prev;
Richard Smith5fc18a92015-07-12 23:43:21 +00004040 Prev = Prev->getPreviousDecl())
4041 if (!Prev->isFromASTFile())
4042 return 0;
4043
4044 // Note that we need to emit an update record for the primary context.
4045 UpdatedDeclContexts.insert(DC->getPrimaryContext());
4046
4047 // Make sure all visible decls are written. They will be recorded later. We
4048 // do this using a side data structure so we can sort the names into
4049 // a deterministic order.
4050 StoredDeclsMap *Map = DC->getPrimaryContext()->buildLookup();
4051 SmallVector<std::pair<DeclarationName, DeclContext::lookup_result>, 16>
4052 LookupResults;
4053 if (Map) {
4054 LookupResults.reserve(Map->size());
4055 for (auto &Entry : *Map)
4056 LookupResults.push_back(
4057 std::make_pair(Entry.first, Entry.second.getLookupResult()));
4058 }
4059
4060 std::sort(LookupResults.begin(), LookupResults.end(), llvm::less_first());
4061 for (auto &NameAndResult : LookupResults) {
4062 DeclarationName Name = NameAndResult.first;
4063 DeclContext::lookup_result Result = NameAndResult.second;
4064 if (Name.getNameKind() == DeclarationName::CXXConstructorName ||
4065 Name.getNameKind() == DeclarationName::CXXConversionFunctionName) {
4066 // We have to work around a name lookup bug here where negative lookup
4067 // results for these names get cached in namespace lookup tables (these
4068 // names should never be looked up in a namespace).
4069 assert(Result.empty() && "Cannot have a constructor or conversion "
4070 "function name in a namespace!");
4071 continue;
4072 }
4073
4074 for (NamedDecl *ND : Result)
4075 if (!ND->isFromASTFile())
4076 GetDeclRef(ND);
4077 }
4078
4079 return 0;
4080 }
4081
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00004082 if (DC->getPrimaryContext() != DC)
4083 return 0;
4084
Chandler Carruthe972c362015-03-26 03:11:40 +00004085 // Skip contexts which don't support name lookup.
4086 if (!DC->isLookupContext())
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00004087 return 0;
4088
4089 // If not in C++, we perform name lookup for the translation unit via the
4090 // IdentifierInfo chains, don't bother to build a visible-declarations table.
David Blaikiebbafb8a2012-03-11 07:00:24 +00004091 if (DC->isTranslationUnit() && !Context.getLangOpts().CPlusPlus)
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00004092 return 0;
4093
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00004094 // Serialize the contents of the mapping used for lookup. Note that,
4095 // although we have two very different code paths, the serialized
4096 // representation is the same for both cases: a declaration name,
4097 // followed by a size, followed by references to the visible
4098 // declarations that have that name.
4099 uint64_t Offset = Stream.GetCurrentBitNo();
Richard Smithf634c902012-03-16 06:12:59 +00004100 StoredDeclsMap *Map = DC->buildLookup();
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00004101 if (!Map || Map->empty())
4102 return 0;
4103
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00004104 // Create the on-disk hash table in a buffer.
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00004105 SmallString<4096> LookupTable;
Richard Smithd88a7f12015-09-01 20:35:42 +00004106 GenerateNameLookupTable(DC, LookupTable);
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00004107
4108 // Write the lookup table
Mehdi Amini57a41912015-09-10 01:46:39 +00004109 RecordData::value_type Record[] = {DECL_CONTEXT_VISIBLE};
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00004110 Stream.EmitRecordWithBlob(DeclContextVisibleLookupAbbrev, Record,
Yaron Keren92e1b622015-03-18 10:17:07 +00004111 LookupTable);
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00004112 ++NumVisibleDeclContexts;
4113 return Offset;
4114}
4115
Sebastian Redla4071b42010-08-24 00:50:09 +00004116/// \brief Write an UPDATE_VISIBLE block for the given context.
4117///
4118/// UPDATE_VISIBLE blocks contain the declarations that are added to an existing
4119/// DeclContext in a dependent AST file. As such, they only exist for the TU
Richard Smithf634c902012-03-16 06:12:59 +00004120/// (in C++), for namespaces, and for classes with forward-declared unscoped
4121/// enumeration members (in C++11).
Sebastian Redla4071b42010-08-24 00:50:09 +00004122void ASTWriter::WriteDeclContextVisibleUpdate(const DeclContext *DC) {
Richard Smith961eae52014-03-25 01:14:22 +00004123 StoredDeclsMap *Map = DC->getLookupPtr();
Sebastian Redla4071b42010-08-24 00:50:09 +00004124 if (!Map || Map->empty())
4125 return;
4126
Sebastian Redla4071b42010-08-24 00:50:09 +00004127 // Create the on-disk hash table in a buffer.
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00004128 SmallString<4096> LookupTable;
Richard Smithd88a7f12015-09-01 20:35:42 +00004129 GenerateNameLookupTable(DC, LookupTable);
Sebastian Redla4071b42010-08-24 00:50:09 +00004130
Richard Smith5fc18a92015-07-12 23:43:21 +00004131 // If we're updating a namespace, select a key declaration as the key for the
4132 // update record; those are the only ones that will be checked on reload.
4133 if (isa<NamespaceDecl>(DC))
4134 DC = cast<DeclContext>(Chain->getKeyDeclaration(cast<Decl>(DC)));
4135
Sebastian Redla4071b42010-08-24 00:50:09 +00004136 // Write the lookup table
Mehdi Amini57a41912015-09-10 01:46:39 +00004137 RecordData::value_type Record[] = {UPDATE_VISIBLE, getDeclID(cast<Decl>(DC))};
Yaron Keren92e1b622015-03-18 10:17:07 +00004138 Stream.EmitRecordWithBlob(UpdateVisibleAbbrev, Record, LookupTable);
Sebastian Redla4071b42010-08-24 00:50:09 +00004139}
4140
Peter Collingbourne5df20e02011-02-15 19:46:30 +00004141/// \brief Write an FP_PRAGMA_OPTIONS block for the given FPOptions.
4142void ASTWriter::WriteFPPragmaOptions(const FPOptions &Opts) {
Adam Nemet484aa452017-03-27 19:17:25 +00004143 RecordData::value_type Record[] = {Opts.getInt()};
Peter Collingbourne5df20e02011-02-15 19:46:30 +00004144 Stream.EmitRecord(FP_PRAGMA_OPTIONS, Record);
4145}
4146
4147/// \brief Write an OPENCL_EXTENSIONS block for the given OpenCLOptions.
4148void ASTWriter::WriteOpenCLExtensions(Sema &SemaRef) {
David Blaikiebbafb8a2012-03-11 07:00:24 +00004149 if (!SemaRef.Context.getLangOpts().OpenCL)
Peter Collingbourne5df20e02011-02-15 19:46:30 +00004150 return;
4151
4152 const OpenCLOptions &Opts = SemaRef.getOpenCLOptions();
4153 RecordData Record;
Yaxun Liu5b746652016-12-18 05:18:55 +00004154 for (const auto &I:Opts.OptMap) {
4155 AddString(I.getKey(), Record);
4156 auto V = I.getValue();
Yaxun Liucc2741c2016-12-18 06:35:06 +00004157 Record.push_back(V.Supported ? 1 : 0);
4158 Record.push_back(V.Enabled ? 1 : 0);
Yaxun Liu5b746652016-12-18 05:18:55 +00004159 Record.push_back(V.Avail);
4160 Record.push_back(V.Core);
4161 }
Peter Collingbourne5df20e02011-02-15 19:46:30 +00004162 Stream.EmitRecord(OPENCL_EXTENSIONS, Record);
4163}
4164
Yaxun Liu5b746652016-12-18 05:18:55 +00004165void ASTWriter::WriteOpenCLExtensionTypes(Sema &SemaRef) {
4166 if (!SemaRef.Context.getLangOpts().OpenCL)
4167 return;
4168
4169 RecordData Record;
4170 for (const auto &I : SemaRef.OpenCLTypeExtMap) {
4171 Record.push_back(
4172 static_cast<unsigned>(getTypeID(I.first->getCanonicalTypeInternal())));
4173 Record.push_back(I.second.size());
4174 for (auto Ext : I.second)
4175 AddString(Ext, Record);
4176 }
4177 Stream.EmitRecord(OPENCL_EXTENSION_TYPES, Record);
4178}
4179
4180void ASTWriter::WriteOpenCLExtensionDecls(Sema &SemaRef) {
4181 if (!SemaRef.Context.getLangOpts().OpenCL)
4182 return;
4183
4184 RecordData Record;
4185 for (const auto &I : SemaRef.OpenCLDeclExtMap) {
4186 Record.push_back(getDeclID(I.first));
4187 Record.push_back(static_cast<unsigned>(I.second.size()));
4188 for (auto Ext : I.second)
4189 AddString(Ext, Record);
4190 }
4191 Stream.EmitRecord(OPENCL_EXTENSION_DECLS, Record);
4192}
4193
Justin Lebar67a78a62016-10-08 22:15:58 +00004194void ASTWriter::WriteCUDAPragmas(Sema &SemaRef) {
4195 if (SemaRef.ForceCUDAHostDeviceDepth > 0) {
4196 RecordData::value_type Record[] = {SemaRef.ForceCUDAHostDeviceDepth};
4197 Stream.EmitRecord(CUDA_PRAGMA_FORCE_HOST_DEVICE_DEPTH, Record);
4198 }
4199}
4200
Douglas Gregor404cdde2012-01-27 01:47:08 +00004201void ASTWriter::WriteObjCCategories() {
Dmitri Gribenkof8579502013-01-12 19:30:44 +00004202 SmallVector<ObjCCategoriesInfo, 2> CategoriesMap;
Douglas Gregor404cdde2012-01-27 01:47:08 +00004203 RecordData Categories;
4204
4205 for (unsigned I = 0, N = ObjCClassesWithCategories.size(); I != N; ++I) {
4206 unsigned Size = 0;
4207 unsigned StartIndex = Categories.size();
4208
4209 ObjCInterfaceDecl *Class = ObjCClassesWithCategories[I];
4210
4211 // Allocate space for the size.
4212 Categories.push_back(0);
4213
4214 // Add the categories.
Douglas Gregor048fbfa2013-01-16 23:00:23 +00004215 for (ObjCInterfaceDecl::known_categories_iterator
4216 Cat = Class->known_categories_begin(),
4217 CatEnd = Class->known_categories_end();
4218 Cat != CatEnd; ++Cat, ++Size) {
4219 assert(getDeclID(*Cat) != 0 && "Bogus category");
4220 AddDeclRef(*Cat, Categories);
Douglas Gregor404cdde2012-01-27 01:47:08 +00004221 }
4222
4223 // Update the size.
4224 Categories[StartIndex] = Size;
4225
4226 // Record this interface -> category map.
4227 ObjCCategoriesInfo CatInfo = { getDeclID(Class), StartIndex };
4228 CategoriesMap.push_back(CatInfo);
4229 }
4230
4231 // Sort the categories map by the definition ID, since the reader will be
4232 // performing binary searches on this information.
4233 llvm::array_pod_sort(CategoriesMap.begin(), CategoriesMap.end());
4234
4235 // Emit the categories map.
4236 using namespace llvm;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00004237
David Blaikieb44f0bf2017-01-04 22:36:43 +00004238 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Douglas Gregor404cdde2012-01-27 01:47:08 +00004239 Abbrev->Add(BitCodeAbbrevOp(OBJC_CATEGORIES_MAP));
4240 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // # of entries
4241 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
David Blaikieb44f0bf2017-01-04 22:36:43 +00004242 unsigned AbbrevID = Stream.EmitAbbrev(std::move(Abbrev));
Mehdi Amini57a41912015-09-10 01:46:39 +00004243
4244 RecordData::value_type Record[] = {OBJC_CATEGORIES_MAP, CategoriesMap.size()};
4245 Stream.EmitRecordWithBlob(AbbrevID, Record,
4246 reinterpret_cast<char *>(CategoriesMap.data()),
Douglas Gregor404cdde2012-01-27 01:47:08 +00004247 CategoriesMap.size() * sizeof(ObjCCategoriesInfo));
Mehdi Amini57a41912015-09-10 01:46:39 +00004248
Douglas Gregor404cdde2012-01-27 01:47:08 +00004249 // Emit the category lists.
4250 Stream.EmitRecord(OBJC_CATEGORIES, Categories);
4251}
4252
Richard Smithe40f2ba2013-08-07 21:41:30 +00004253void ASTWriter::WriteLateParsedTemplates(Sema &SemaRef) {
4254 Sema::LateParsedTemplateMapT &LPTMap = SemaRef.LateParsedTemplateMap;
4255
4256 if (LPTMap.empty())
4257 return;
4258
4259 RecordData Record;
Justin Lebar28f09c52016-10-10 16:26:08 +00004260 for (auto &LPTMapEntry : LPTMap) {
Chandler Carruth52cee4d2015-03-26 09:08:15 +00004261 const FunctionDecl *FD = LPTMapEntry.first;
Justin Lebar28f09c52016-10-10 16:26:08 +00004262 LateParsedTemplate &LPT = *LPTMapEntry.second;
Chandler Carruth52cee4d2015-03-26 09:08:15 +00004263 AddDeclRef(FD, Record);
Justin Lebar28f09c52016-10-10 16:26:08 +00004264 AddDeclRef(LPT.D, Record);
4265 Record.push_back(LPT.Toks.size());
Richard Smithe40f2ba2013-08-07 21:41:30 +00004266
Justin Lebar28f09c52016-10-10 16:26:08 +00004267 for (const auto &Tok : LPT.Toks) {
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00004268 AddToken(Tok, Record);
Richard Smithe40f2ba2013-08-07 21:41:30 +00004269 }
4270 }
4271 Stream.EmitRecord(LATE_PARSED_TEMPLATE, Record);
4272}
4273
Dario Domizioli13a0a382014-05-23 12:13:25 +00004274/// \brief Write the state of 'pragma clang optimize' at the end of the module.
4275void ASTWriter::WriteOptimizePragmaOptions(Sema &SemaRef) {
4276 RecordData Record;
4277 SourceLocation PragmaLoc = SemaRef.getOptimizeOffPragmaLocation();
4278 AddSourceLocation(PragmaLoc, Record);
4279 Stream.EmitRecord(OPTIMIZE_PRAGMA_OPTIONS, Record);
4280}
4281
Nico Weber779355f2016-03-02 23:22:00 +00004282/// \brief Write the state of 'pragma ms_struct' at the end of the module.
4283void ASTWriter::WriteMSStructPragmaOptions(Sema &SemaRef) {
4284 RecordData Record;
4285 Record.push_back(SemaRef.MSStructPragmaOn ? PMSST_ON : PMSST_OFF);
4286 Stream.EmitRecord(MSSTRUCT_PRAGMA_OPTIONS, Record);
4287}
4288
Nico Weber42932312016-03-03 00:17:35 +00004289/// \brief Write the state of 'pragma pointers_to_members' at the end of the
4290//module.
4291void ASTWriter::WriteMSPointersToMembersPragmaOptions(Sema &SemaRef) {
4292 RecordData Record;
4293 Record.push_back(SemaRef.MSPointerToMemberRepresentationMethod);
4294 AddSourceLocation(SemaRef.ImplicitMSInheritanceAttrLoc, Record);
4295 Stream.EmitRecord(POINTERS_TO_MEMBERS_PRAGMA_OPTIONS, Record);
4296}
4297
Alex Lorenz7d7e1e02017-03-31 15:36:21 +00004298/// \brief Write the state of 'pragma pack' at the end of the module.
4299void ASTWriter::WritePackPragmaOptions(Sema &SemaRef) {
Duncan P. N. Exon Smith03df14c2017-04-15 00:07:57 +00004300 // Don't serialize pragma pack state for modules, since it should only take
4301 // effect on a per-submodule basis.
4302 if (WritingModule)
4303 return;
4304
Alex Lorenz7d7e1e02017-03-31 15:36:21 +00004305 RecordData Record;
4306 Record.push_back(SemaRef.PackStack.CurrentValue);
4307 AddSourceLocation(SemaRef.PackStack.CurrentPragmaLocation, Record);
4308 Record.push_back(SemaRef.PackStack.Stack.size());
4309 for (const auto &StackEntry : SemaRef.PackStack.Stack) {
4310 Record.push_back(StackEntry.Value);
4311 AddSourceLocation(StackEntry.PragmaLocation, Record);
Alex Lorenz45b40142017-07-28 14:41:21 +00004312 AddSourceLocation(StackEntry.PragmaPushLocation, Record);
Alex Lorenz7d7e1e02017-03-31 15:36:21 +00004313 AddString(StackEntry.StackSlotLabel, Record);
4314 }
4315 Stream.EmitRecord(PACK_PRAGMA_OPTIONS, Record);
4316}
4317
Douglas Gregor8f64ca12015-12-08 22:43:32 +00004318void ASTWriter::WriteModuleFileExtension(Sema &SemaRef,
4319 ModuleFileExtensionWriter &Writer) {
Douglas Gregor6623e1f2015-11-03 18:33:07 +00004320 // Enter the extension block.
4321 Stream.EnterSubblock(EXTENSION_BLOCK_ID, 4);
4322
4323 // Emit the metadata record abbreviation.
David Blaikieb44f0bf2017-01-04 22:36:43 +00004324 auto Abv = std::make_shared<llvm::BitCodeAbbrev>();
Douglas Gregor6623e1f2015-11-03 18:33:07 +00004325 Abv->Add(llvm::BitCodeAbbrevOp(EXTENSION_METADATA));
4326 Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::VBR, 6));
4327 Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::VBR, 6));
4328 Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::VBR, 6));
4329 Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::VBR, 6));
4330 Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::Blob));
David Blaikieb44f0bf2017-01-04 22:36:43 +00004331 unsigned Abbrev = Stream.EmitAbbrev(std::move(Abv));
Douglas Gregor6623e1f2015-11-03 18:33:07 +00004332
4333 // Emit the metadata record.
4334 RecordData Record;
4335 auto Metadata = Writer.getExtension()->getExtensionMetadata();
4336 Record.push_back(EXTENSION_METADATA);
4337 Record.push_back(Metadata.MajorVersion);
4338 Record.push_back(Metadata.MinorVersion);
4339 Record.push_back(Metadata.BlockName.size());
4340 Record.push_back(Metadata.UserInfo.size());
4341 SmallString<64> Buffer;
4342 Buffer += Metadata.BlockName;
4343 Buffer += Metadata.UserInfo;
4344 Stream.EmitRecordWithBlob(Abbrev, Record, Buffer);
4345
4346 // Emit the contents of the extension block.
Douglas Gregor8f64ca12015-12-08 22:43:32 +00004347 Writer.writeExtensionContents(SemaRef, Stream);
Douglas Gregor6623e1f2015-11-03 18:33:07 +00004348
4349 // Exit the extension block.
4350 Stream.ExitBlock();
4351}
4352
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00004353//===----------------------------------------------------------------------===//
Douglas Gregorc5046832009-04-27 18:38:38 +00004354// General Serialization Routines
4355//===----------------------------------------------------------------------===//
4356
Richard Smith69c82bf2016-04-01 22:52:03 +00004357/// \brief Emit the list of attributes to the specified record.
Richard Smith290d8012016-04-06 17:06:00 +00004358void ASTRecordWriter::AddAttributes(ArrayRef<const Attr *> Attrs) {
4359 auto &Record = *this;
Argyrios Kyrtzidis9beef8e2010-10-18 19:20:11 +00004360 Record.push_back(Attrs.size());
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00004361 for (const auto *A : Attrs) {
Alexis Huntdcfba7b2010-08-18 23:23:40 +00004362 Record.push_back(A->getKind()); // FIXME: stable encoding, target attrs
Richard Smith290d8012016-04-06 17:06:00 +00004363 Record.AddSourceRange(A->getRange());
Douglas Gregorbc8a78d52009-04-15 21:30:51 +00004364
Alexis Huntdcfba7b2010-08-18 23:23:40 +00004365#include "clang/Serialization/AttrPCHWrite.inc"
Daniel Dunbarfc6507e2010-05-27 02:25:39 +00004366
Douglas Gregorbc8a78d52009-04-15 21:30:51 +00004367 }
Douglas Gregorbc8a78d52009-04-15 21:30:51 +00004368}
4369
John McCallf413f5e2013-05-03 00:10:13 +00004370void ASTWriter::AddToken(const Token &Tok, RecordDataImpl &Record) {
4371 AddSourceLocation(Tok.getLocation(), Record);
4372 Record.push_back(Tok.getLength());
4373
4374 // FIXME: When reading literal tokens, reconstruct the literal pointer
4375 // if it is needed.
4376 AddIdentifierRef(Tok.getIdentifierInfo(), Record);
4377 // FIXME: Should translate token kind to a stable encoding.
4378 Record.push_back(Tok.getKind());
4379 // FIXME: Should translate token flags to a stable encoding.
4380 Record.push_back(Tok.getFlags());
4381}
4382
Chris Lattner0e62c1c2011-07-23 10:55:15 +00004383void ASTWriter::AddString(StringRef Str, RecordDataImpl &Record) {
Douglas Gregorbc8a78d52009-04-15 21:30:51 +00004384 Record.push_back(Str.size());
4385 Record.insert(Record.end(), Str.begin(), Str.end());
4386}
4387
Richard Smith7ed1bc92014-12-05 22:42:13 +00004388bool ASTWriter::PreparePathForOutput(SmallVectorImpl<char> &Path) {
Richard Smith54cc3c22014-12-11 20:50:24 +00004389 assert(Context && "should have context when outputting path");
Richard Smith7ed1bc92014-12-05 22:42:13 +00004390
Richard Smith54cc3c22014-12-11 20:50:24 +00004391 bool Changed =
4392 cleanPathForOutput(Context->getSourceManager().getFileManager(), Path);
Richard Smith7ed1bc92014-12-05 22:42:13 +00004393
4394 // Remove a prefix to make the path relative, if relevant.
4395 const char *PathBegin = Path.data();
4396 const char *PathPtr =
4397 adjustFilenameForRelocatableAST(PathBegin, BaseDirectory);
4398 if (PathPtr != PathBegin) {
4399 Path.erase(Path.begin(), Path.begin() + (PathPtr - PathBegin));
4400 Changed = true;
4401 }
4402
4403 return Changed;
4404}
4405
4406void ASTWriter::AddPath(StringRef Path, RecordDataImpl &Record) {
4407 SmallString<128> FilePath(Path);
4408 PreparePathForOutput(FilePath);
4409 AddString(FilePath, Record);
4410}
4411
Mehdi Amini57a41912015-09-10 01:46:39 +00004412void ASTWriter::EmitRecordWithPath(unsigned Abbrev, RecordDataRef Record,
Richard Smith7ed1bc92014-12-05 22:42:13 +00004413 StringRef Path) {
4414 SmallString<128> FilePath(Path);
4415 PreparePathForOutput(FilePath);
4416 Stream.EmitRecordWithBlob(Abbrev, Record, FilePath);
4417}
4418
Douglas Gregor20b2ebd2011-03-23 00:50:03 +00004419void ASTWriter::AddVersionTuple(const VersionTuple &Version,
4420 RecordDataImpl &Record) {
4421 Record.push_back(Version.getMajor());
David Blaikie05785d12013-02-20 22:23:23 +00004422 if (Optional<unsigned> Minor = Version.getMinor())
Douglas Gregor20b2ebd2011-03-23 00:50:03 +00004423 Record.push_back(*Minor + 1);
4424 else
4425 Record.push_back(0);
David Blaikie05785d12013-02-20 22:23:23 +00004426 if (Optional<unsigned> Subminor = Version.getSubminor())
Douglas Gregor20b2ebd2011-03-23 00:50:03 +00004427 Record.push_back(*Subminor + 1);
4428 else
4429 Record.push_back(0);
4430}
4431
Douglas Gregore84a9da2009-04-20 20:36:09 +00004432/// \brief Note that the identifier II occurs at the given offset
4433/// within the identifier table.
Sebastian Redl55c0ad52010-08-18 23:56:21 +00004434void ASTWriter::SetIdentifierOffset(const IdentifierInfo *II, uint32_t Offset) {
Sebastian Redl539c5062010-08-18 23:57:32 +00004435 IdentID ID = IdentifierIDs[II];
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00004436 // Only store offsets new to this AST file. Other identifier names are looked
Sebastian Redlff4a2952010-07-23 23:49:55 +00004437 // up earlier in the chain and thus don't need an offset.
4438 if (ID >= FirstIdentID)
4439 IdentifierOffsets[ID - FirstIdentID] = Offset;
Douglas Gregore84a9da2009-04-20 20:36:09 +00004440}
4441
Douglas Gregor95c13f52009-04-25 17:48:32 +00004442/// \brief Note that the selector Sel occurs at the given offset
4443/// within the method pool/selector table.
Sebastian Redl55c0ad52010-08-18 23:56:21 +00004444void ASTWriter::SetSelectorOffset(Selector Sel, uint32_t Offset) {
Douglas Gregor95c13f52009-04-25 17:48:32 +00004445 unsigned ID = SelectorIDs[Sel];
4446 assert(ID && "Unknown selector");
Sebastian Redld95a56e2010-08-04 18:21:41 +00004447 // Don't record offsets for selectors that are also available in a different
4448 // file.
4449 if (ID < FirstSelectorID)
4450 return;
4451 SelectorOffsets[ID - FirstSelectorID] = Offset;
Douglas Gregor95c13f52009-04-25 17:48:32 +00004452}
4453
David Blaikie61137e12017-01-05 18:23:18 +00004454ASTWriter::ASTWriter(llvm::BitstreamWriter &Stream,
Duncan P. N. Exon Smith030d7d62017-03-20 17:58:26 +00004455 SmallVectorImpl<char> &Buffer, MemoryBufferCache &PCMCache,
David Blaikie61137e12017-01-05 18:23:18 +00004456 ArrayRef<std::shared_ptr<ModuleFileExtension>> Extensions,
4457 bool IncludeTimestamps)
Duncan P. N. Exon Smith030d7d62017-03-20 17:58:26 +00004458 : Stream(Stream), Buffer(Buffer), PCMCache(PCMCache),
4459 IncludeTimestamps(IncludeTimestamps) {
Douglas Gregor6623e1f2015-11-03 18:33:07 +00004460 for (const auto &Ext : Extensions) {
4461 if (auto Writer = Ext->createExtensionWriter(*this))
4462 ModuleFileExtensionWriters.push_back(std::move(Writer));
4463 }
4464}
Douglas Gregoref84c4b2009-04-09 22:27:44 +00004465
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00004466ASTWriter::~ASTWriter() {
Reid Kleckner588c9372014-02-19 23:44:52 +00004467 llvm::DeleteContainerSeconds(FileDeclIDs);
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00004468}
4469
Richard Smithb3761912015-02-05 23:08:52 +00004470const LangOptions &ASTWriter::getLangOpts() const {
4471 assert(WritingAST && "can't determine lang opts when not writing AST");
4472 return Context->getLangOpts();
4473}
4474
Richard Smithe75ee0f2015-08-17 07:13:32 +00004475time_t ASTWriter::getTimestampForOutput(const FileEntry *E) const {
4476 return IncludeTimestamps ? E->getModificationTime() : 0;
4477}
4478
Duncan P. N. Exon Smith60fa2882017-03-13 18:45:08 +00004479ASTFileSignature ASTWriter::WriteAST(Sema &SemaRef,
4480 const std::string &OutputFile,
4481 Module *WritingModule, StringRef isysroot,
4482 bool hasErrors) {
Douglas Gregor2fd3d402011-09-17 00:05:03 +00004483 WritingAST = true;
Adrian Prantladbd2b12015-09-22 23:26:31 +00004484
Argyrios Kyrtzidis4a280ff2012-03-07 01:51:17 +00004485 ASTHasCompilerErrors = hasErrors;
4486
Douglas Gregoref84c4b2009-04-09 22:27:44 +00004487 // Emit the file header.
Douglas Gregor8f45df52009-04-16 22:23:12 +00004488 Stream.Emit((unsigned)'C', 8);
4489 Stream.Emit((unsigned)'P', 8);
4490 Stream.Emit((unsigned)'C', 8);
4491 Stream.Emit((unsigned)'H', 8);
Mike Stump11289f42009-09-09 15:08:12 +00004492
Chris Lattner28fa4e62009-04-26 22:26:21 +00004493 WriteBlockInfoBlock();
Douglas Gregoref84c4b2009-04-09 22:27:44 +00004494
Douglas Gregoreda8e122011-08-09 15:13:55 +00004495 Context = &SemaRef.Context;
Douglas Gregora28bcdd2011-12-01 02:07:58 +00004496 PP = &SemaRef.PP;
Douglas Gregora89c5ac2011-12-06 01:10:29 +00004497 this->WritingModule = WritingModule;
Adrian Prantladbd2b12015-09-22 23:26:31 +00004498 ASTFileSignature Signature =
4499 WriteASTCore(SemaRef, isysroot, OutputFile, WritingModule);
Craig Toppera13603a2014-05-22 05:54:18 +00004500 Context = nullptr;
4501 PP = nullptr;
4502 this->WritingModule = nullptr;
Richard Smith7ed1bc92014-12-05 22:42:13 +00004503 this->BaseDirectory.clear();
Craig Toppera13603a2014-05-22 05:54:18 +00004504
Douglas Gregor2fd3d402011-09-17 00:05:03 +00004505 WritingAST = false;
Duncan P. N. Exon Smith030d7d62017-03-20 17:58:26 +00004506 if (SemaRef.Context.getLangOpts().ImplicitModules && WritingModule) {
4507 // Construct MemoryBuffer and update buffer manager.
4508 PCMCache.addBuffer(OutputFile,
4509 llvm::MemoryBuffer::getMemBufferCopy(
4510 StringRef(Buffer.begin(), Buffer.size())));
4511 }
Adrian Prantladbd2b12015-09-22 23:26:31 +00004512 return Signature;
Sebastian Redl143413f2010-07-12 22:02:52 +00004513}
4514
Douglas Gregora94a1542011-07-27 21:45:57 +00004515template<typename Vector>
4516static void AddLazyVectorDecls(ASTWriter &Writer, Vector &Vec,
4517 ASTWriter::RecordData &Record) {
Craig Toppera13603a2014-05-22 05:54:18 +00004518 for (typename Vector::iterator I = Vec.begin(nullptr, true), E = Vec.end();
4519 I != E; ++I) {
Douglas Gregora94a1542011-07-27 21:45:57 +00004520 Writer.AddDeclRef(*I, Record);
4521 }
4522}
4523
Duncan P. N. Exon Smith60fa2882017-03-13 18:45:08 +00004524ASTFileSignature ASTWriter::WriteASTCore(Sema &SemaRef, StringRef isysroot,
4525 const std::string &OutputFile,
4526 Module *WritingModule) {
Sebastian Redl143413f2010-07-12 22:02:52 +00004527 using namespace llvm;
4528
Craig Toppera13603a2014-05-22 05:54:18 +00004529 bool isModule = WritingModule != nullptr;
Argyrios Kyrtzidisffb35582013-03-14 04:44:56 +00004530
Douglas Gregorcf68c582011-12-01 22:20:10 +00004531 // Make sure that the AST reader knows to finalize itself.
4532 if (Chain)
4533 Chain->finalizeForWriting();
4534
Sebastian Redl143413f2010-07-12 22:02:52 +00004535 ASTContext &Context = SemaRef.Context;
4536 Preprocessor &PP = SemaRef.PP;
4537
Douglas Gregordab42432011-08-12 00:15:20 +00004538 // Set up predefined declaration IDs.
Richard Smith5fc18a92015-07-12 23:43:21 +00004539 auto RegisterPredefDecl = [&] (Decl *D, PredefinedDeclIDs ID) {
4540 if (D) {
4541 assert(D->isCanonicalDecl() && "predefined decl is not canonical");
4542 DeclIDs[D] = ID;
Richard Smith5fc18a92015-07-12 23:43:21 +00004543 }
4544 };
4545 RegisterPredefDecl(Context.getTranslationUnitDecl(),
4546 PREDEF_DECL_TRANSLATION_UNIT_ID);
4547 RegisterPredefDecl(Context.ObjCIdDecl, PREDEF_DECL_OBJC_ID_ID);
4548 RegisterPredefDecl(Context.ObjCSelDecl, PREDEF_DECL_OBJC_SEL_ID);
4549 RegisterPredefDecl(Context.ObjCClassDecl, PREDEF_DECL_OBJC_CLASS_ID);
4550 RegisterPredefDecl(Context.ObjCProtocolClassDecl,
4551 PREDEF_DECL_OBJC_PROTOCOL_ID);
4552 RegisterPredefDecl(Context.Int128Decl, PREDEF_DECL_INT_128_ID);
4553 RegisterPredefDecl(Context.UInt128Decl, PREDEF_DECL_UNSIGNED_INT_128_ID);
4554 RegisterPredefDecl(Context.ObjCInstanceTypeDecl,
4555 PREDEF_DECL_OBJC_INSTANCETYPE_ID);
4556 RegisterPredefDecl(Context.BuiltinVaListDecl, PREDEF_DECL_BUILTIN_VA_LIST_ID);
Richard Smith9b88a4c2015-07-27 05:40:23 +00004557 RegisterPredefDecl(Context.VaListTagDecl, PREDEF_DECL_VA_LIST_TAG);
Charles Davisc7d5c942015-09-17 20:55:33 +00004558 RegisterPredefDecl(Context.BuiltinMSVaListDecl,
4559 PREDEF_DECL_BUILTIN_MS_VA_LIST_ID);
Richard Smith5fc18a92015-07-12 23:43:21 +00004560 RegisterPredefDecl(Context.ExternCContext, PREDEF_DECL_EXTERN_C_CONTEXT_ID);
David Majnemerd9b1a4f2015-11-04 03:40:30 +00004561 RegisterPredefDecl(Context.MakeIntegerSeqDecl,
4562 PREDEF_DECL_MAKE_INTEGER_SEQ_ID);
Quentin Colombet043406b2016-02-03 22:41:00 +00004563 RegisterPredefDecl(Context.CFConstantStringTypeDecl,
4564 PREDEF_DECL_CF_CONSTANT_STRING_ID);
Ben Langmuirf5416742016-02-04 00:55:24 +00004565 RegisterPredefDecl(Context.CFConstantStringTagDecl,
4566 PREDEF_DECL_CF_CONSTANT_STRING_TAG_ID);
Eric Fiselier6ad68552016-07-01 01:24:09 +00004567 RegisterPredefDecl(Context.TypePackElementDecl,
4568 PREDEF_DECL_TYPE_PACK_ELEMENT_ID);
Meador Inge5d3fb222012-06-16 03:34:49 +00004569
Chris Lattner0c797362009-09-08 18:19:27 +00004570 // Build a record containing all of the tentative definitions in this file, in
Sebastian Redl35351a92010-01-31 22:27:38 +00004571 // TentativeDefinitions order. Generally, this record will be empty for
Chris Lattner0c797362009-09-08 18:19:27 +00004572 // headers.
Douglas Gregord4df8652009-04-22 22:02:47 +00004573 RecordData TentativeDefinitions;
Douglas Gregora94a1542011-07-27 21:45:57 +00004574 AddLazyVectorDecls(*this, SemaRef.TentativeDefinitions, TentativeDefinitions);
Douglas Gregoreb08bd42011-07-27 20:58:46 +00004575
Argyrios Kyrtzidis35672e72010-08-13 18:42:17 +00004576 // Build a record containing all of the file scoped decls in this file.
4577 RecordData UnusedFileScopedDecls;
Argyrios Kyrtzidis59852362013-03-14 04:45:00 +00004578 if (!isModule)
4579 AddLazyVectorDecls(*this, SemaRef.UnusedFileScopedDecls,
4580 UnusedFileScopedDecls);
Sebastian Redl08aca90252010-08-05 18:21:25 +00004581
Douglas Gregor851443c2011-08-12 01:39:19 +00004582 // Build a record containing all of the delegating constructors we still need
4583 // to resolve.
Alexis Hunt27a761d2011-05-04 23:29:54 +00004584 RecordData DelegatingCtorDecls;
Argyrios Kyrtzidisffb35582013-03-14 04:44:56 +00004585 if (!isModule)
4586 AddLazyVectorDecls(*this, SemaRef.DelegatingCtorDecls, DelegatingCtorDecls);
Alexis Hunt27a761d2011-05-04 23:29:54 +00004587
Douglas Gregor851443c2011-08-12 01:39:19 +00004588 // Write the set of weak, undeclared identifiers. We always write the
4589 // entire table, since later PCH files in a PCH chain are only interested in
4590 // the results at the end of the chain.
Argyrios Kyrtzidisee1afa32010-08-05 09:48:08 +00004591 RecordData WeakUndeclaredIdentifiers;
Chandler Carruthf85d9822015-03-26 08:32:49 +00004592 for (auto &WeakUndeclaredIdentifier : SemaRef.WeakUndeclaredIdentifiers) {
4593 IdentifierInfo *II = WeakUndeclaredIdentifier.first;
4594 WeakInfo &WI = WeakUndeclaredIdentifier.second;
4595 AddIdentifierRef(II, WeakUndeclaredIdentifiers);
4596 AddIdentifierRef(WI.getAlias(), WeakUndeclaredIdentifiers);
4597 AddSourceLocation(WI.getLocation(), WeakUndeclaredIdentifiers);
4598 WeakUndeclaredIdentifiers.push_back(WI.getUsed());
Argyrios Kyrtzidisee1afa32010-08-05 09:48:08 +00004599 }
Kovarththanan Rajaratnama9c81a82010-03-14 07:06:50 +00004600
Douglas Gregor61cac2b2009-04-27 20:06:05 +00004601 // Build a record containing all of the ext_vector declarations.
4602 RecordData ExtVectorDecls;
Douglas Gregorb7098a32011-07-28 00:39:29 +00004603 AddLazyVectorDecls(*this, SemaRef.ExtVectorDecls, ExtVectorDecls);
Douglas Gregor61cac2b2009-04-27 20:06:05 +00004604
Argyrios Kyrtzidisaf2eac22010-07-06 15:37:04 +00004605 // Build a record containing all of the VTable uses information.
4606 RecordData VTableUses;
Argyrios Kyrtzidisedee67f2010-08-03 17:29:52 +00004607 if (!SemaRef.VTableUses.empty()) {
Argyrios Kyrtzidisedee67f2010-08-03 17:29:52 +00004608 for (unsigned I = 0, N = SemaRef.VTableUses.size(); I != N; ++I) {
4609 AddDeclRef(SemaRef.VTableUses[I].first, VTableUses);
4610 AddSourceLocation(SemaRef.VTableUses[I].second, VTableUses);
4611 VTableUses.push_back(SemaRef.VTablesUsed[SemaRef.VTableUses[I].first]);
4612 }
Argyrios Kyrtzidisaf2eac22010-07-06 15:37:04 +00004613 }
4614
Nico Weber72889432014-09-06 01:25:55 +00004615 // Build a record containing all of the UnusedLocalTypedefNameCandidates.
4616 RecordData UnusedLocalTypedefNameCandidates;
4617 for (const TypedefNameDecl *TD : SemaRef.UnusedLocalTypedefNameCandidates)
4618 AddDeclRef(TD, UnusedLocalTypedefNameCandidates);
4619
Argyrios Kyrtzidis7f76d112010-08-05 09:48:16 +00004620 // Build a record containing all of pending implicit instantiations.
Chandler Carruth54080172010-08-25 08:44:16 +00004621 RecordData PendingInstantiations;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00004622 for (const auto &I : SemaRef.PendingInstantiations) {
4623 AddDeclRef(I.first, PendingInstantiations);
4624 AddSourceLocation(I.second, PendingInstantiations);
Argyrios Kyrtzidis7f76d112010-08-05 09:48:16 +00004625 }
4626 assert(SemaRef.PendingLocalImplicitInstantiations.empty() &&
4627 "There are local ones at end of translation unit!");
4628
Argyrios Kyrtzidis2d688102010-08-02 07:14:54 +00004629 // Build a record containing some declaration references.
4630 RecordData SemaDeclRefs;
Richard Smith96269c52016-09-29 22:49:46 +00004631 if (SemaRef.StdNamespace || SemaRef.StdBadAlloc || SemaRef.StdAlignValT) {
Argyrios Kyrtzidis2d688102010-08-02 07:14:54 +00004632 AddDeclRef(SemaRef.getStdNamespace(), SemaDeclRefs);
4633 AddDeclRef(SemaRef.getStdBadAlloc(), SemaDeclRefs);
Richard Smith96269c52016-09-29 22:49:46 +00004634 AddDeclRef(SemaRef.getStdAlignValT(), SemaDeclRefs);
Argyrios Kyrtzidis2d688102010-08-02 07:14:54 +00004635 }
4636
Peter Collingbourne9e2c81f2011-02-09 21:04:32 +00004637 RecordData CUDASpecialDeclRefs;
4638 if (Context.getcudaConfigureCallDecl()) {
4639 AddDeclRef(Context.getcudaConfigureCallDecl(), CUDASpecialDeclRefs);
4640 }
4641
Douglas Gregorc2fa1692011-06-28 16:20:02 +00004642 // Build a record containing all of the known namespaces.
4643 RecordData KnownNamespaces;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00004644 for (const auto &I : SemaRef.KnownNamespaces) {
4645 if (!I.second)
4646 AddDeclRef(I.first, KnownNamespaces);
Douglas Gregorc2fa1692011-06-28 16:20:02 +00004647 }
Douglas Gregor112b9072012-10-18 05:31:06 +00004648
Nick Lewycky9c7eb1d2013-02-01 08:13:20 +00004649 // Build a record of all used, undefined objects that require definitions.
4650 RecordData UndefinedButUsed;
Nick Lewyckyf0f56162013-01-31 03:23:57 +00004651
4652 SmallVector<std::pair<NamedDecl *, SourceLocation>, 16> Undefined;
Nick Lewycky9c7eb1d2013-02-01 08:13:20 +00004653 SemaRef.getUndefinedButUsed(Undefined);
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00004654 for (const auto &I : Undefined) {
4655 AddDeclRef(I.first, UndefinedButUsed);
4656 AddSourceLocation(I.second, UndefinedButUsed);
Nick Lewycky8334af82013-01-26 00:35:08 +00004657 }
4658
Ismail Pazarbasie5768d12015-05-18 19:59:11 +00004659 // Build a record containing all delete-expressions that we would like to
4660 // analyze later in AST.
4661 RecordData DeleteExprsToAnalyze;
4662
4663 for (const auto &DeleteExprsInfo :
4664 SemaRef.getMismatchingDeleteExpressions()) {
4665 AddDeclRef(DeleteExprsInfo.first, DeleteExprsToAnalyze);
4666 DeleteExprsToAnalyze.push_back(DeleteExprsInfo.second.size());
4667 for (const auto &DeleteLoc : DeleteExprsInfo.second) {
4668 AddSourceLocation(DeleteLoc.first, DeleteExprsToAnalyze);
4669 DeleteExprsToAnalyze.push_back(DeleteLoc.second);
4670 }
4671 }
4672
Douglas Gregor112b9072012-10-18 05:31:06 +00004673 // Write the control block
Duncan P. N. Exon Smith60fa2882017-03-13 18:45:08 +00004674 WriteControlBlock(PP, Context, isysroot, OutputFile);
Douglas Gregor112b9072012-10-18 05:31:06 +00004675
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00004676 // Write the remaining AST contents.
Sebastian Redl539c5062010-08-18 23:57:32 +00004677 Stream.EnterSubblock(AST_BLOCK_ID, 5);
Douglas Gregor851443c2011-08-12 01:39:19 +00004678
Argyrios Kyrtzidis39605402012-12-13 21:38:23 +00004679 // This is so that older clang versions, before the introduction
4680 // of the control block, can read and reject the newer PCH format.
Mehdi Amini57a41912015-09-10 01:46:39 +00004681 {
4682 RecordData Record = {VERSION_MAJOR};
4683 Stream.EmitRecord(METADATA_OLD_FORMAT, Record);
4684 }
Argyrios Kyrtzidis39605402012-12-13 21:38:23 +00004685
Douglas Gregor851443c2011-08-12 01:39:19 +00004686 // Create a lexical update block containing all of the declarations in the
4687 // translation unit that do not come from other AST files.
4688 const TranslationUnitDecl *TU = Context.getTranslationUnitDecl();
Richard Smith82f8fcd2015-08-06 22:07:25 +00004689 SmallVector<uint32_t, 128> NewGlobalKindDeclPairs;
4690 for (const auto *D : TU->noload_decls()) {
4691 if (!D->isFromASTFile()) {
4692 NewGlobalKindDeclPairs.push_back(D->getKind());
4693 NewGlobalKindDeclPairs.push_back(GetDeclRef(D));
4694 }
Douglas Gregor851443c2011-08-12 01:39:19 +00004695 }
4696
David Blaikieb44f0bf2017-01-04 22:36:43 +00004697 auto Abv = std::make_shared<BitCodeAbbrev>();
Douglas Gregor851443c2011-08-12 01:39:19 +00004698 Abv->Add(llvm::BitCodeAbbrevOp(TU_UPDATE_LEXICAL));
4699 Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::Blob));
David Blaikieb44f0bf2017-01-04 22:36:43 +00004700 unsigned TuUpdateLexicalAbbrev = Stream.EmitAbbrev(std::move(Abv));
Mehdi Amini57a41912015-09-10 01:46:39 +00004701 {
4702 RecordData::value_type Record[] = {TU_UPDATE_LEXICAL};
4703 Stream.EmitRecordWithBlob(TuUpdateLexicalAbbrev, Record,
4704 bytes(NewGlobalKindDeclPairs));
4705 }
4706
Douglas Gregor851443c2011-08-12 01:39:19 +00004707 // And a visible updates block for the translation unit.
David Blaikieb44f0bf2017-01-04 22:36:43 +00004708 Abv = std::make_shared<BitCodeAbbrev>();
Douglas Gregor851443c2011-08-12 01:39:19 +00004709 Abv->Add(llvm::BitCodeAbbrevOp(UPDATE_VISIBLE));
4710 Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::VBR, 6));
Douglas Gregor851443c2011-08-12 01:39:19 +00004711 Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::Blob));
David Blaikieb44f0bf2017-01-04 22:36:43 +00004712 UpdateVisibleAbbrev = Stream.EmitAbbrev(std::move(Abv));
Douglas Gregor851443c2011-08-12 01:39:19 +00004713 WriteDeclContextVisibleUpdate(TU);
Richard Smithf19e1272015-03-07 00:04:49 +00004714
4715 // If we have any extern "C" names, write out a visible update for them.
4716 if (Context.ExternCContext)
4717 WriteDeclContextVisibleUpdate(Context.ExternCContext);
Douglas Gregor851443c2011-08-12 01:39:19 +00004718
4719 // If the translation unit has an anonymous namespace, and we don't already
4720 // have an update block for it, write it as an update block.
Richard Smith6ef42932014-03-20 21:02:00 +00004721 // FIXME: Why do we not do this if there's already an update block?
Douglas Gregor851443c2011-08-12 01:39:19 +00004722 if (NamespaceDecl *NS = TU->getAnonymousNamespace()) {
4723 ASTWriter::UpdateRecord &Record = DeclUpdates[TU];
Richard Smith6ef42932014-03-20 21:02:00 +00004724 if (Record.empty())
Aaron Ballman4f45b712014-03-21 15:22:56 +00004725 Record.push_back(DeclUpdate(UPD_CXX_ADDED_ANONYMOUS_NAMESPACE, NS));
Douglas Gregor851443c2011-08-12 01:39:19 +00004726 }
Argyrios Kyrtzidis442dd802012-07-02 19:19:01 +00004727
Richard Smith5652c0f2014-03-21 01:48:23 +00004728 // Add update records for all mangling numbers and static local numbers.
4729 // These aren't really update records, but this is a convenient way of
4730 // tagging this rare extra data onto the declarations.
4731 for (const auto &Number : Context.MangleNumbers)
4732 if (!Number.first->isFromASTFile())
Aaron Ballman4f45b712014-03-21 15:22:56 +00004733 DeclUpdates[Number.first].push_back(DeclUpdate(UPD_MANGLING_NUMBER,
4734 Number.second));
Richard Smith5652c0f2014-03-21 01:48:23 +00004735 for (const auto &Number : Context.StaticLocalNumbers)
4736 if (!Number.first->isFromASTFile())
Aaron Ballman4f45b712014-03-21 15:22:56 +00004737 DeclUpdates[Number.first].push_back(DeclUpdate(UPD_STATIC_LOCAL_NUMBER,
4738 Number.second));
Richard Smith5652c0f2014-03-21 01:48:23 +00004739
Argyrios Kyrtzidis442dd802012-07-02 19:19:01 +00004740 // Make sure visible decls, added to DeclContexts previously loaded from
Richard Smithc26d9742016-10-06 20:30:51 +00004741 // an AST file, are registered for serialization. Likewise for template
4742 // specializations added to imported templates.
4743 for (const auto *I : DeclsToEmitEvenIfUnreferenced) {
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00004744 GetDeclRef(I);
Argyrios Kyrtzidis442dd802012-07-02 19:19:01 +00004745 }
4746
Argyrios Kyrtzidisacfbbd72013-08-07 21:17:33 +00004747 // Make sure all decls associated with an identifier are registered for
Richard Smith79bf9202015-08-24 03:33:22 +00004748 // serialization, if we're storing decls with identifiers.
4749 if (!WritingModule || !getLangOpts().CPlusPlus) {
4750 llvm::SmallVector<const IdentifierInfo*, 256> IIs;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00004751 for (const auto &ID : PP.getIdentifierTable()) {
4752 const IdentifierInfo *II = ID.second;
Richard Smith79bf9202015-08-24 03:33:22 +00004753 if (!Chain || !II->isFromAST() || II->hasChangedSinceDeserialization())
4754 IIs.push_back(II);
4755 }
4756 // Sort the identifiers to visit based on their name.
4757 std::sort(IIs.begin(), IIs.end(), llvm::less_ptr<IdentifierInfo>());
4758 for (const IdentifierInfo *II : IIs) {
4759 for (IdentifierResolver::iterator D = SemaRef.IdResolver.begin(II),
4760 DEnd = SemaRef.IdResolver.end();
4761 D != DEnd; ++D) {
4762 GetDeclRef(*D);
4763 }
Argyrios Kyrtzidisacfbbd72013-08-07 21:17:33 +00004764 }
4765 }
4766
Manman Rena0f31a02016-04-29 19:04:05 +00004767 // For method pool in the module, if it contains an entry for a selector,
4768 // the entry should be complete, containing everything introduced by that
4769 // module and all modules it imports. It's possible that the entry is out of
4770 // date, so we need to pull in the new content here.
4771
4772 // It's possible that updateOutOfDateSelector can update SelectorIDs. To be
4773 // safe, we copy all selectors out.
4774 llvm::SmallVector<Selector, 256> AllSelectors;
4775 for (auto &SelectorAndID : SelectorIDs)
4776 AllSelectors.push_back(SelectorAndID.first);
4777 for (auto &Selector : AllSelectors)
4778 SemaRef.updateOutOfDateSelector(Selector);
4779
Douglas Gregor5204bde2011-08-02 16:26:37 +00004780 // Form the record of special types.
4781 RecordData SpecialTypes;
Douglas Gregor5204bde2011-08-02 16:26:37 +00004782 AddTypeRef(Context.getRawCFConstantStringType(), SpecialTypes);
Douglas Gregor5204bde2011-08-02 16:26:37 +00004783 AddTypeRef(Context.getFILEType(), SpecialTypes);
4784 AddTypeRef(Context.getjmp_bufType(), SpecialTypes);
4785 AddTypeRef(Context.getsigjmp_bufType(), SpecialTypes);
4786 AddTypeRef(Context.ObjCIdRedefinitionType, SpecialTypes);
4787 AddTypeRef(Context.ObjCClassRedefinitionType, SpecialTypes);
Douglas Gregor5204bde2011-08-02 16:26:37 +00004788 AddTypeRef(Context.ObjCSelRedefinitionType, SpecialTypes);
Rafael Espindola6cfa82b2011-11-13 21:51:09 +00004789 AddTypeRef(Context.getucontext_tType(), SpecialTypes);
Douglas Gregora28bcdd2011-12-01 02:07:58 +00004790
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00004791 if (Chain) {
4792 // Write the mapping information describing our module dependencies and how
4793 // each of those modules were mapped into our own offset/ID space, so that
4794 // the reader can build the appropriate mapping to its own offset/ID space.
4795 // The map consists solely of a blob with the following format:
Boris Kolpackovd30446f2017-08-31 06:26:43 +00004796 // *(module-kind:i8
4797 // module-name-len:i16 module-name:len*i8
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00004798 // source-location-offset:i32
4799 // identifier-id:i32
4800 // preprocessed-entity-id:i32
4801 // macro-definition-id:i32
Douglas Gregor253eefe2011-12-01 00:59:36 +00004802 // submodule-id:i32
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00004803 // selector-id:i32
4804 // declaration-id:i32
4805 // c++-base-specifiers-id:i32
4806 // type-id:i32)
4807 //
Boris Kolpackovd30446f2017-08-31 06:26:43 +00004808 // module-kind is the ModuleKind enum value. If it is MK_PrebuiltModule or
4809 // MK_ExplicitModule, then the module-name is the module name. Otherwise,
4810 // it is the module file name.
4811 //
David Blaikieb44f0bf2017-01-04 22:36:43 +00004812 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00004813 Abbrev->Add(BitCodeAbbrevOp(MODULE_OFFSET_MAP));
4814 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
David Blaikieb44f0bf2017-01-04 22:36:43 +00004815 unsigned ModuleOffsetMapAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00004816 SmallString<2048> Buffer;
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00004817 {
4818 llvm::raw_svector_ostream Out(Buffer);
Duncan P. N. Exon Smith96a06e02017-01-28 22:15:22 +00004819 for (ModuleFile &M : Chain->ModuleMgr) {
Justin Bognere1c147c2014-03-28 22:03:19 +00004820 using namespace llvm::support;
4821 endian::Writer<little> LE(Out);
Boris Kolpackovd30446f2017-08-31 06:26:43 +00004822 LE.write<uint8_t>(static_cast<uint8_t>(M.Kind));
4823 StringRef Name =
4824 M.Kind == MK_PrebuiltModule || M.Kind == MK_ExplicitModule
4825 ? M.ModuleName
4826 : M.FileName;
4827 LE.write<uint16_t>(Name.size());
4828 Out.write(Name.data(), Name.size());
Ben Langmuirfe971d92014-08-16 04:54:18 +00004829
Ben Langmuir785180e2014-10-20 16:27:30 +00004830 // Note: if a base ID was uint max, it would not be possible to load
4831 // another module after it or have more than one entity inside it.
4832 uint32_t None = std::numeric_limits<uint32_t>::max();
4833
4834 auto writeBaseIDOrNone = [&](uint32_t BaseID, bool ShouldWrite) {
4835 assert(BaseID < std::numeric_limits<uint32_t>::max() && "base id too high");
4836 if (ShouldWrite)
4837 LE.write<uint32_t>(BaseID);
4838 else
4839 LE.write<uint32_t>(None);
4840 };
4841
Ben Langmuirfe971d92014-08-16 04:54:18 +00004842 // These values should be unique within a chain, since they will be read
4843 // as keys into ContinuousRangeMaps.
Duncan P. N. Exon Smith96a06e02017-01-28 22:15:22 +00004844 writeBaseIDOrNone(M.SLocEntryBaseOffset, M.LocalNumSLocEntries);
4845 writeBaseIDOrNone(M.BaseIdentifierID, M.LocalNumIdentifiers);
4846 writeBaseIDOrNone(M.BaseMacroID, M.LocalNumMacros);
4847 writeBaseIDOrNone(M.BasePreprocessedEntityID,
4848 M.NumPreprocessedEntities);
4849 writeBaseIDOrNone(M.BaseSubmoduleID, M.LocalNumSubmodules);
4850 writeBaseIDOrNone(M.BaseSelectorID, M.LocalNumSelectors);
4851 writeBaseIDOrNone(M.BaseDeclID, M.LocalNumDecls);
4852 writeBaseIDOrNone(M.BaseTypeIndex, M.LocalNumTypes);
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00004853 }
4854 }
Mehdi Amini57a41912015-09-10 01:46:39 +00004855 RecordData::value_type Record[] = {MODULE_OFFSET_MAP};
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00004856 Stream.EmitRecordWithBlob(ModuleOffsetMapAbbrev, Record,
4857 Buffer.data(), Buffer.size());
4858 }
Richard Smithb9eab6d2014-03-20 19:44:17 +00004859
Richard Smithb9eab6d2014-03-20 19:44:17 +00004860 RecordData DeclUpdatesOffsetsRecord;
4861
Richard Smith59442b42014-03-20 20:07:19 +00004862 // Keep writing types, declarations, and declaration update records
4863 // until we've emitted all of them.
Richard Smith01b2cb42014-07-26 06:37:51 +00004864 Stream.EnterSubblock(DECLTYPES_BLOCK_ID, /*bits for abbreviations*/5);
4865 WriteTypeAbbrevs();
4866 WriteDeclAbbrevs();
Richard Smith59442b42014-03-20 20:07:19 +00004867 do {
4868 WriteDeclUpdatesBlocks(DeclUpdatesOffsetsRecord);
4869 while (!DeclTypesToEmit.empty()) {
4870 DeclOrType DOT = DeclTypesToEmit.front();
4871 DeclTypesToEmit.pop();
4872 if (DOT.isType())
4873 WriteType(DOT.getType());
4874 else
4875 WriteDecl(Context, DOT.getDecl());
4876 }
4877 } while (!DeclUpdates.empty());
Richard Smithb9eab6d2014-03-20 19:44:17 +00004878 Stream.ExitBlock();
4879
Richard Smithb9eab6d2014-03-20 19:44:17 +00004880 DoneWritingDeclsAndTypes = true;
4881
4882 // These things can only be done once we've written out decls and types.
4883 WriteTypeDeclOffsets();
Richard Smith5652c0f2014-03-21 01:48:23 +00004884 if (!DeclUpdatesOffsetsRecord.empty())
4885 Stream.EmitRecord(DECL_UPDATE_OFFSETS, DeclUpdatesOffsetsRecord);
Richard Smithb9eab6d2014-03-20 19:44:17 +00004886 WriteFileDeclIDsMap();
Richard Smith7ed1bc92014-12-05 22:42:13 +00004887 WriteSourceManagerBlock(Context.getSourceManager(), PP);
Richard Smithb9eab6d2014-03-20 19:44:17 +00004888 WriteComments();
Argyrios Kyrtzidisffb35582013-03-14 04:44:56 +00004889 WritePreprocessor(PP, isModule);
Richard Smith7ed1bc92014-12-05 22:42:13 +00004890 WriteHeaderSearch(PP.getHeaderSearchInfo());
Sebastian Redla19a67f2010-08-03 21:58:15 +00004891 WriteSelectors(SemaRef);
Fariborz Jahanianc51609a2010-07-23 19:11:11 +00004892 WriteReferencedSelectorsPool(SemaRef);
Richard Smith9c254182015-07-19 21:41:12 +00004893 WriteLateParsedTemplates(SemaRef);
Argyrios Kyrtzidisffb35582013-03-14 04:44:56 +00004894 WriteIdentifierTable(PP, SemaRef.IdResolver, isModule);
Peter Collingbourne5df20e02011-02-15 19:46:30 +00004895 WriteFPPragmaOptions(SemaRef.getFPOptions());
4896 WriteOpenCLExtensions(SemaRef);
Yaxun Liu5b746652016-12-18 05:18:55 +00004897 WriteOpenCLExtensionTypes(SemaRef);
4898 WriteOpenCLExtensionDecls(SemaRef);
Justin Lebar67a78a62016-10-08 22:15:58 +00004899 WriteCUDAPragmas(SemaRef);
Douglas Gregor652d82a2009-04-18 05:55:16 +00004900
Douglas Gregora89c5ac2011-12-06 01:10:29 +00004901 // If we're emitting a module, write out the submodule information.
4902 if (WritingModule)
4903 WriteSubmodules(WritingModule);
4904
Douglas Gregor5204bde2011-08-02 16:26:37 +00004905 Stream.EmitRecord(SPECIAL_TYPES, SpecialTypes);
4906
Douglas Gregord4df8652009-04-22 22:02:47 +00004907 // Write the record containing external, unnamed definitions.
Ben Langmuir332aafe2014-01-31 01:06:56 +00004908 if (!EagerlyDeserializedDecls.empty())
4909 Stream.EmitRecord(EAGERLY_DESERIALIZED_DECLS, EagerlyDeserializedDecls);
Douglas Gregord4df8652009-04-22 22:02:47 +00004910
David Blaikief63556d2017-04-12 20:58:33 +00004911 if (!ModularCodegenDecls.empty())
David Blaikie9ffe5a32017-01-30 05:00:26 +00004912 Stream.EmitRecord(MODULAR_CODEGEN_DECLS, ModularCodegenDecls);
4913
Douglas Gregord4df8652009-04-22 22:02:47 +00004914 // Write the record containing tentative definitions.
4915 if (!TentativeDefinitions.empty())
Sebastian Redl539c5062010-08-18 23:57:32 +00004916 Stream.EmitRecord(TENTATIVE_DEFINITIONS, TentativeDefinitions);
Douglas Gregoracfc76c2009-04-22 22:18:58 +00004917
Argyrios Kyrtzidis35672e72010-08-13 18:42:17 +00004918 // Write the record containing unused file scoped decls.
4919 if (!UnusedFileScopedDecls.empty())
Sebastian Redl539c5062010-08-18 23:57:32 +00004920 Stream.EmitRecord(UNUSED_FILESCOPED_DECLS, UnusedFileScopedDecls);
Kovarththanan Rajaratnama9c81a82010-03-14 07:06:50 +00004921
Argyrios Kyrtzidisee1afa32010-08-05 09:48:08 +00004922 // Write the record containing weak undeclared identifiers.
4923 if (!WeakUndeclaredIdentifiers.empty())
Sebastian Redl539c5062010-08-18 23:57:32 +00004924 Stream.EmitRecord(WEAK_UNDECLARED_IDENTIFIERS,
Argyrios Kyrtzidisee1afa32010-08-05 09:48:08 +00004925 WeakUndeclaredIdentifiers);
4926
Douglas Gregor61cac2b2009-04-27 20:06:05 +00004927 // Write the record containing ext_vector type names.
4928 if (!ExtVectorDecls.empty())
Sebastian Redl539c5062010-08-18 23:57:32 +00004929 Stream.EmitRecord(EXT_VECTOR_DECLS, ExtVectorDecls);
Mike Stump11289f42009-09-09 15:08:12 +00004930
Argyrios Kyrtzidisaf2eac22010-07-06 15:37:04 +00004931 // Write the record containing VTable uses information.
4932 if (!VTableUses.empty())
Sebastian Redl539c5062010-08-18 23:57:32 +00004933 Stream.EmitRecord(VTABLE_USES, VTableUses);
Argyrios Kyrtzidisaf2eac22010-07-06 15:37:04 +00004934
Nico Weber72889432014-09-06 01:25:55 +00004935 // Write the record containing potentially unused local typedefs.
4936 if (!UnusedLocalTypedefNameCandidates.empty())
4937 Stream.EmitRecord(UNUSED_LOCAL_TYPEDEF_NAME_CANDIDATES,
4938 UnusedLocalTypedefNameCandidates);
4939
Argyrios Kyrtzidis7f76d112010-08-05 09:48:16 +00004940 // Write the record containing pending implicit instantiations.
Chandler Carruth54080172010-08-25 08:44:16 +00004941 if (!PendingInstantiations.empty())
4942 Stream.EmitRecord(PENDING_IMPLICIT_INSTANTIATIONS, PendingInstantiations);
Argyrios Kyrtzidis7f76d112010-08-05 09:48:16 +00004943
Argyrios Kyrtzidis2d688102010-08-02 07:14:54 +00004944 // Write the record containing declaration references of Sema.
4945 if (!SemaDeclRefs.empty())
Sebastian Redl539c5062010-08-18 23:57:32 +00004946 Stream.EmitRecord(SEMA_DECL_REFS, SemaDeclRefs);
Argyrios Kyrtzidis2d688102010-08-02 07:14:54 +00004947
Peter Collingbourne9e2c81f2011-02-09 21:04:32 +00004948 // Write the record containing CUDA-specific declaration references.
4949 if (!CUDASpecialDeclRefs.empty())
4950 Stream.EmitRecord(CUDA_SPECIAL_DECL_REFS, CUDASpecialDeclRefs);
Alexis Hunt27a761d2011-05-04 23:29:54 +00004951
4952 // Write the delegating constructors.
4953 if (!DelegatingCtorDecls.empty())
4954 Stream.EmitRecord(DELEGATING_CTORS, DelegatingCtorDecls);
Peter Collingbourne9e2c81f2011-02-09 21:04:32 +00004955
Douglas Gregorc2fa1692011-06-28 16:20:02 +00004956 // Write the known namespaces.
4957 if (!KnownNamespaces.empty())
4958 Stream.EmitRecord(KNOWN_NAMESPACES, KnownNamespaces);
Nick Lewycky8334af82013-01-26 00:35:08 +00004959
Nick Lewycky9c7eb1d2013-02-01 08:13:20 +00004960 // Write the undefined internal functions and variables, and inline functions.
4961 if (!UndefinedButUsed.empty())
4962 Stream.EmitRecord(UNDEFINED_BUT_USED, UndefinedButUsed);
Ismail Pazarbasie5768d12015-05-18 19:59:11 +00004963
4964 if (!DeleteExprsToAnalyze.empty())
4965 Stream.EmitRecord(DELETE_EXPRS_TO_ANALYZE, DeleteExprsToAnalyze);
4966
Douglas Gregor851443c2011-08-12 01:39:19 +00004967 // Write the visible updates to DeclContexts.
Richard Smithcd45dbc2014-04-19 03:48:30 +00004968 for (auto *DC : UpdatedDeclContexts)
4969 WriteDeclContextVisibleUpdate(DC);
Douglas Gregor851443c2011-08-12 01:39:19 +00004970
Douglas Gregor959bb062011-12-03 01:15:29 +00004971 if (!WritingModule) {
4972 // Write the submodules that were imported, if any.
Aaron Ballman4f45b712014-03-21 15:22:56 +00004973 struct ModuleInfo {
4974 uint64_t ID;
4975 Module *M;
4976 ModuleInfo(uint64_t ID, Module *M) : ID(ID), M(M) {}
4977 };
Richard Smith56be7542014-03-21 00:33:59 +00004978 llvm::SmallVector<ModuleInfo, 64> Imports;
Aaron Ballmanbbc31212014-03-14 20:59:21 +00004979 for (const auto *I : Context.local_imports()) {
Douglas Gregor959bb062011-12-03 01:15:29 +00004980 assert(SubmoduleIDs.find(I->getImportedModule()) != SubmoduleIDs.end());
Aaron Ballman4f45b712014-03-21 15:22:56 +00004981 Imports.push_back(ModuleInfo(SubmoduleIDs[I->getImportedModule()],
4982 I->getImportedModule()));
Douglas Gregor959bb062011-12-03 01:15:29 +00004983 }
Richard Smith56be7542014-03-21 00:33:59 +00004984
4985 if (!Imports.empty()) {
4986 auto Cmp = [](const ModuleInfo &A, const ModuleInfo &B) {
4987 return A.ID < B.ID;
4988 };
Ben Langmuir5f95c8f2014-09-08 20:36:26 +00004989 auto Eq = [](const ModuleInfo &A, const ModuleInfo &B) {
4990 return A.ID == B.ID;
4991 };
Richard Smith56be7542014-03-21 00:33:59 +00004992
4993 // Sort and deduplicate module IDs.
4994 std::sort(Imports.begin(), Imports.end(), Cmp);
Ben Langmuir5f95c8f2014-09-08 20:36:26 +00004995 Imports.erase(std::unique(Imports.begin(), Imports.end(), Eq),
Richard Smith56be7542014-03-21 00:33:59 +00004996 Imports.end());
4997
4998 RecordData ImportedModules;
4999 for (const auto &Import : Imports) {
5000 ImportedModules.push_back(Import.ID);
5001 // FIXME: If the module has macros imported then later has declarations
5002 // imported, this location won't be the right one as a location for the
5003 // declaration imports.
Richard Smith10434f32015-05-02 02:08:26 +00005004 AddSourceLocation(PP.getModuleImportLoc(Import.M), ImportedModules);
Richard Smith56be7542014-03-21 00:33:59 +00005005 }
5006
Douglas Gregor959bb062011-12-03 01:15:29 +00005007 Stream.EmitRecord(IMPORTED_MODULES, ImportedModules);
5008 }
Douglas Gregor0a839132011-12-03 00:59:55 +00005009 }
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00005010
Douglas Gregor404cdde2012-01-27 01:47:08 +00005011 WriteObjCCategories();
Nico Weber779355f2016-03-02 23:22:00 +00005012 if(!WritingModule) {
Dario Domizioli13a0a382014-05-23 12:13:25 +00005013 WriteOptimizePragmaOptions(SemaRef);
Nico Weber779355f2016-03-02 23:22:00 +00005014 WriteMSStructPragmaOptions(SemaRef);
Nico Weber42932312016-03-03 00:17:35 +00005015 WriteMSPointersToMembersPragmaOptions(SemaRef);
Nico Weber779355f2016-03-02 23:22:00 +00005016 }
Alex Lorenz7d7e1e02017-03-31 15:36:21 +00005017 WritePackPragmaOptions(SemaRef);
Richard Smithe40f2ba2013-08-07 21:41:30 +00005018
Douglas Gregor08f01292009-04-17 22:13:46 +00005019 // Some simple statistics
Mehdi Amini57a41912015-09-10 01:46:39 +00005020 RecordData::value_type Record[] = {
5021 NumStatements, NumMacros, NumLexicalDeclContexts, NumVisibleDeclContexts};
Sebastian Redl539c5062010-08-18 23:57:32 +00005022 Stream.EmitRecord(STATISTICS, Record);
Douglas Gregor8f45df52009-04-16 22:23:12 +00005023 Stream.ExitBlock();
Adrian Prantladbd2b12015-09-22 23:26:31 +00005024
Douglas Gregor6623e1f2015-11-03 18:33:07 +00005025 // Write the module file extension blocks.
5026 for (const auto &ExtWriter : ModuleFileExtensionWriters)
Douglas Gregor8f64ca12015-12-08 22:43:32 +00005027 WriteModuleFileExtension(SemaRef, *ExtWriter);
Douglas Gregor6623e1f2015-11-03 18:33:07 +00005028
Duncan P. N. Exon Smith60fa2882017-03-13 18:45:08 +00005029 return writeUnhashedControlBlock(PP, Context);
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005030}
5031
Richard Smithb9eab6d2014-03-20 19:44:17 +00005032void ASTWriter::WriteDeclUpdatesBlocks(RecordDataImpl &OffsetsRecord) {
Argyrios Kyrtzidis65ad5692010-10-24 17:26:36 +00005033 if (DeclUpdates.empty())
5034 return;
5035
Richard Smith59442b42014-03-20 20:07:19 +00005036 DeclUpdateMap LocalUpdates;
5037 LocalUpdates.swap(DeclUpdates);
5038
Richard Smith6ef42932014-03-20 21:02:00 +00005039 for (auto &DeclUpdate : LocalUpdates) {
5040 const Decl *D = DeclUpdate.first;
Argyrios Kyrtzidis3ba70b82010-10-24 17:26:46 +00005041
Richard Smithd28ac5b2014-03-22 23:33:22 +00005042 bool HasUpdatedBody = false;
Richard Smith69c82bf2016-04-01 22:52:03 +00005043 RecordData RecordData;
5044 ASTRecordWriter Record(*this, RecordData);
Richard Smith6ef42932014-03-20 21:02:00 +00005045 for (auto &Update : DeclUpdate.second) {
5046 DeclUpdateKind Kind = (DeclUpdateKind)Update.getKind();
5047
Richard Smith69c82bf2016-04-01 22:52:03 +00005048 // An updated body is emitted last, so that the reader doesn't need
5049 // to skip over the lazy body to reach statements for other records.
5050 if (Kind == UPD_CXX_ADDED_FUNCTION_DEFINITION)
5051 HasUpdatedBody = true;
5052 else
5053 Record.push_back(Kind);
5054
Richard Smith6ef42932014-03-20 21:02:00 +00005055 switch (Kind) {
5056 case UPD_CXX_ADDED_IMPLICIT_MEMBER:
5057 case UPD_CXX_ADDED_TEMPLATE_SPECIALIZATION:
5058 case UPD_CXX_ADDED_ANONYMOUS_NAMESPACE:
Richard Smithcd45dbc2014-04-19 03:48:30 +00005059 assert(Update.getDecl() && "no decl to add?");
Richard Smith6ef42932014-03-20 21:02:00 +00005060 Record.push_back(GetDeclRef(Update.getDecl()));
5061 break;
5062
Richard Smith4d235792014-08-07 18:53:08 +00005063 case UPD_CXX_ADDED_FUNCTION_DEFINITION:
Richard Smithd28ac5b2014-03-22 23:33:22 +00005064 break;
5065
Richard Smith05a21352017-06-22 22:18:46 +00005066 case UPD_CXX_INSTANTIATED_STATIC_DATA_MEMBER: {
5067 const VarDecl *VD = cast<VarDecl>(D);
Richard Smith69c82bf2016-04-01 22:52:03 +00005068 Record.AddSourceLocation(Update.getLoc());
Richard Smith05a21352017-06-22 22:18:46 +00005069 if (VD->getInit()) {
5070 Record.push_back(!VD->isInitKnownICE() ? 1
5071 : (VD->isInitICE() ? 3 : 2));
5072 Record.AddStmt(const_cast<Expr*>(VD->getInit()));
5073 } else {
5074 Record.push_back(0);
5075 }
Richard Smith4d235792014-08-07 18:53:08 +00005076 break;
Richard Smith05a21352017-06-22 22:18:46 +00005077 }
Richard Smith4d235792014-08-07 18:53:08 +00005078
John McCall32791cc2016-01-06 22:34:54 +00005079 case UPD_CXX_INSTANTIATED_DEFAULT_ARGUMENT:
Richard Smith290d8012016-04-06 17:06:00 +00005080 Record.AddStmt(const_cast<Expr *>(
5081 cast<ParmVarDecl>(Update.getDecl())->getDefaultArg()));
John McCall32791cc2016-01-06 22:34:54 +00005082 break;
5083
Richard Smith4b054b22016-08-24 21:25:37 +00005084 case UPD_CXX_INSTANTIATED_DEFAULT_MEMBER_INITIALIZER:
5085 Record.AddStmt(
5086 cast<FieldDecl>(Update.getDecl())->getInClassInitializer());
5087 break;
5088
Richard Smithcd45dbc2014-04-19 03:48:30 +00005089 case UPD_CXX_INSTANTIATED_CLASS_DEFINITION: {
5090 auto *RD = cast<CXXRecordDecl>(D);
Chandler Carruth8a3d24d2015-03-26 04:27:10 +00005091 UpdatedDeclContexts.insert(RD->getPrimaryContext());
Richard Smith69c82bf2016-04-01 22:52:03 +00005092 Record.AddCXXDefinitionData(RD);
Richard Smith72e50fe2016-04-14 00:50:18 +00005093 Record.AddOffset(WriteDeclContextLexicalBlock(
Richard Smithcd45dbc2014-04-19 03:48:30 +00005094 *Context, const_cast<CXXRecordDecl *>(RD)));
5095
5096 // This state is sometimes updated by template instantiation, when we
5097 // switch from the specialization referring to the template declaration
5098 // to it referring to the template definition.
5099 if (auto *MSInfo = RD->getMemberSpecializationInfo()) {
5100 Record.push_back(MSInfo->getTemplateSpecializationKind());
Richard Smith69c82bf2016-04-01 22:52:03 +00005101 Record.AddSourceLocation(MSInfo->getPointOfInstantiation());
Richard Smithcd45dbc2014-04-19 03:48:30 +00005102 } else {
5103 auto *Spec = cast<ClassTemplateSpecializationDecl>(RD);
5104 Record.push_back(Spec->getTemplateSpecializationKind());
Richard Smith69c82bf2016-04-01 22:52:03 +00005105 Record.AddSourceLocation(Spec->getPointOfInstantiation());
Richard Smithdf352052014-05-22 20:59:29 +00005106
5107 // The instantiation might have been resolved to a partial
5108 // specialization. If so, record which one.
5109 auto From = Spec->getInstantiatedFrom();
5110 if (auto PartialSpec =
5111 From.dyn_cast<ClassTemplatePartialSpecializationDecl*>()) {
5112 Record.push_back(true);
Richard Smith69c82bf2016-04-01 22:52:03 +00005113 Record.AddDeclRef(PartialSpec);
5114 Record.AddTemplateArgumentList(
5115 &Spec->getTemplateInstantiationArgs());
Richard Smithdf352052014-05-22 20:59:29 +00005116 } else {
5117 Record.push_back(false);
5118 }
Richard Smithcd45dbc2014-04-19 03:48:30 +00005119 }
5120 Record.push_back(RD->getTagKind());
Richard Smith69c82bf2016-04-01 22:52:03 +00005121 Record.AddSourceLocation(RD->getLocation());
5122 Record.AddSourceLocation(RD->getLocStart());
Argyrios Kyrtzidisd798c052016-07-15 18:11:33 +00005123 Record.AddSourceRange(RD->getBraceRange());
Richard Smithcd45dbc2014-04-19 03:48:30 +00005124
5125 // Instantiation may change attributes; write them all out afresh.
5126 Record.push_back(D->hasAttrs());
Richard Smith69c82bf2016-04-01 22:52:03 +00005127 if (D->hasAttrs())
5128 Record.AddAttributes(D->getAttrs());
Richard Smithcd45dbc2014-04-19 03:48:30 +00005129
5130 // FIXME: Ensure we don't get here for explicit instantiations.
5131 break;
5132 }
5133
Richard Smithf8134002015-03-10 01:41:22 +00005134 case UPD_CXX_RESOLVED_DTOR_DELETE:
Richard Smith69c82bf2016-04-01 22:52:03 +00005135 Record.AddDeclRef(Update.getDecl());
Richard Smithf8134002015-03-10 01:41:22 +00005136 break;
5137
Richard Smith564417a2014-03-20 21:47:22 +00005138 case UPD_CXX_RESOLVED_EXCEPTION_SPEC:
5139 addExceptionSpec(
Richard Smith564417a2014-03-20 21:47:22 +00005140 cast<FunctionDecl>(D)->getType()->castAs<FunctionProtoType>(),
5141 Record);
5142 break;
5143
Richard Smith6ef42932014-03-20 21:02:00 +00005144 case UPD_CXX_DEDUCED_RETURN_TYPE:
5145 Record.push_back(GetOrCreateTypeID(Update.getType()));
5146 break;
5147
5148 case UPD_DECL_MARKED_USED:
5149 break;
Richard Smith5652c0f2014-03-21 01:48:23 +00005150
5151 case UPD_MANGLING_NUMBER:
5152 case UPD_STATIC_LOCAL_NUMBER:
5153 Record.push_back(Update.getNumber());
5154 break;
Richard Smith65ebb4a2015-03-26 04:09:53 +00005155
Alexey Bataev97720002014-11-11 04:05:39 +00005156 case UPD_DECL_MARKED_OPENMP_THREADPRIVATE:
Richard Smith69c82bf2016-04-01 22:52:03 +00005157 Record.AddSourceRange(
5158 D->getAttr<OMPThreadPrivateDeclAttr>()->getRange());
Alexey Bataev97720002014-11-11 04:05:39 +00005159 break;
Richard Smith65ebb4a2015-03-26 04:09:53 +00005160
Dmitry Polukhin0b0da292016-04-06 11:38:59 +00005161 case UPD_DECL_MARKED_OPENMP_DECLARETARGET:
5162 Record.AddSourceRange(
5163 D->getAttr<OMPDeclareTargetDeclAttr>()->getRange());
5164 break;
5165
Richard Smith65ebb4a2015-03-26 04:09:53 +00005166 case UPD_DECL_EXPORTED:
Richard Smith4caa4492015-05-15 02:34:32 +00005167 Record.push_back(getSubmoduleID(Update.getModule()));
Richard Smith65ebb4a2015-03-26 04:09:53 +00005168 break;
Alex Denisovfde64952015-06-26 05:28:36 +00005169
5170 case UPD_ADDED_ATTR_TO_RECORD:
Richard Smith69c82bf2016-04-01 22:52:03 +00005171 Record.AddAttributes(llvm::makeArrayRef(Update.getAttr()));
Alex Denisovfde64952015-06-26 05:28:36 +00005172 break;
Richard Smith6ef42932014-03-20 21:02:00 +00005173 }
5174 }
5175
Richard Smithd28ac5b2014-03-22 23:33:22 +00005176 if (HasUpdatedBody) {
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00005177 const auto *Def = cast<FunctionDecl>(D);
Richard Smith4d235792014-08-07 18:53:08 +00005178 Record.push_back(UPD_CXX_ADDED_FUNCTION_DEFINITION);
Richard Smithd28ac5b2014-03-22 23:33:22 +00005179 Record.push_back(Def->isInlined());
Richard Smith69c82bf2016-04-01 22:52:03 +00005180 Record.AddSourceLocation(Def->getInnerLocStart());
Richard Smith290d8012016-04-06 17:06:00 +00005181 Record.AddFunctionDefinition(Def);
Richard Smithd28ac5b2014-03-22 23:33:22 +00005182 }
5183
Richard Smithcd45dbc2014-04-19 03:48:30 +00005184 OffsetsRecord.push_back(GetDeclRef(D));
Richard Smith69c82bf2016-04-01 22:52:03 +00005185 OffsetsRecord.push_back(Record.Emit(DECL_UPDATES));
Argyrios Kyrtzidis65ad5692010-10-24 17:26:36 +00005186 }
Argyrios Kyrtzidis65ad5692010-10-24 17:26:36 +00005187}
5188
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00005189void ASTWriter::AddSourceLocation(SourceLocation Loc, RecordDataImpl &Record) {
Richard Smithb22a1d12016-03-27 20:13:24 +00005190 uint32_t Raw = Loc.getRawEncoding();
5191 Record.push_back((Raw << 1) | (Raw >> 31));
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005192}
5193
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00005194void ASTWriter::AddSourceRange(SourceRange Range, RecordDataImpl &Record) {
Chris Lattnerca025db2010-05-07 21:43:38 +00005195 AddSourceLocation(Range.getBegin(), Record);
5196 AddSourceLocation(Range.getEnd(), Record);
5197}
5198
Richard Smithf144b542016-04-08 21:54:32 +00005199void ASTRecordWriter::AddAPInt(const llvm::APInt &Value) {
5200 Record->push_back(Value.getBitWidth());
Benjamin Kramer25f9ea62010-09-06 23:43:28 +00005201 const uint64_t *Words = Value.getRawData();
Richard Smithf144b542016-04-08 21:54:32 +00005202 Record->append(Words, Words + Value.getNumWords());
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005203}
5204
Richard Smithf144b542016-04-08 21:54:32 +00005205void ASTRecordWriter::AddAPSInt(const llvm::APSInt &Value) {
5206 Record->push_back(Value.isUnsigned());
5207 AddAPInt(Value);
Douglas Gregor1daeb692009-04-13 18:14:40 +00005208}
5209
Richard Smithf144b542016-04-08 21:54:32 +00005210void ASTRecordWriter::AddAPFloat(const llvm::APFloat &Value) {
5211 AddAPInt(Value.bitcastToAPInt());
Douglas Gregore0a3a512009-04-14 21:55:33 +00005212}
5213
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00005214void ASTWriter::AddIdentifierRef(const IdentifierInfo *II, RecordDataImpl &Record) {
Douglas Gregor4621c6a2009-04-22 18:49:13 +00005215 Record.push_back(getIdentifierRef(II));
5216}
5217
Sebastian Redl539c5062010-08-18 23:57:32 +00005218IdentID ASTWriter::getIdentifierRef(const IdentifierInfo *II) {
Craig Toppera13603a2014-05-22 05:54:18 +00005219 if (!II)
Douglas Gregor4621c6a2009-04-22 18:49:13 +00005220 return 0;
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00005221
Sebastian Redl539c5062010-08-18 23:57:32 +00005222 IdentID &ID = IdentifierIDs[II];
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00005223 if (ID == 0)
Sebastian Redlff4a2952010-07-23 23:49:55 +00005224 ID = NextIdentID++;
Douglas Gregor4621c6a2009-04-22 18:49:13 +00005225 return ID;
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005226}
5227
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00005228MacroID ASTWriter::getMacroRef(MacroInfo *MI, const IdentifierInfo *Name) {
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00005229 // Don't emit builtin macros like __LINE__ to the AST file unless they
5230 // have been redefined by the header (in which case they are not
5231 // isBuiltinMacro).
Craig Toppera13603a2014-05-22 05:54:18 +00005232 if (!MI || MI->isBuiltinMacro())
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00005233 return 0;
5234
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00005235 MacroID &ID = MacroIDs[MI];
5236 if (ID == 0) {
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00005237 ID = NextMacroID++;
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00005238 MacroInfoToEmitData Info = { Name, MI, ID };
5239 MacroInfosToEmit.push_back(Info);
5240 }
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00005241 return ID;
5242}
5243
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00005244MacroID ASTWriter::getMacroID(MacroInfo *MI) {
Craig Toppera13603a2014-05-22 05:54:18 +00005245 if (!MI || MI->isBuiltinMacro())
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00005246 return 0;
5247
5248 assert(MacroIDs.find(MI) != MacroIDs.end() && "Macro not emitted!");
5249 return MacroIDs[MI];
5250}
5251
5252uint64_t ASTWriter::getMacroDirectivesOffset(const IdentifierInfo *Name) {
Richard Smithd7329392015-04-21 21:46:32 +00005253 return IdentMacroDirectivesOffsetMap.lookup(Name);
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00005254}
5255
Richard Smithe64e7452016-04-18 21:54:58 +00005256void ASTRecordWriter::AddSelectorRef(const Selector SelRef) {
5257 Record->push_back(Writer->getSelectorRef(SelRef));
Sebastian Redl834bb972010-08-04 17:20:04 +00005258}
5259
Sebastian Redl539c5062010-08-18 23:57:32 +00005260SelectorID ASTWriter::getSelectorRef(Selector Sel) {
Craig Toppera13603a2014-05-22 05:54:18 +00005261 if (Sel.getAsOpaquePtr() == nullptr) {
Sebastian Redl834bb972010-08-04 17:20:04 +00005262 return 0;
Steve Naroff2ddea052009-04-23 10:39:46 +00005263 }
5264
Douglas Gregor8d7edce2013-02-08 21:30:59 +00005265 SelectorID SID = SelectorIDs[Sel];
Sebastian Redld95a56e2010-08-04 18:21:41 +00005266 if (SID == 0 && Chain) {
5267 // This might trigger a ReadSelector callback, which will set the ID for
5268 // this selector.
5269 Chain->LoadSelector(Sel);
Douglas Gregor8d7edce2013-02-08 21:30:59 +00005270 SID = SelectorIDs[Sel];
Sebastian Redld95a56e2010-08-04 18:21:41 +00005271 }
Steve Naroff2ddea052009-04-23 10:39:46 +00005272 if (SID == 0) {
Sebastian Redld95a56e2010-08-04 18:21:41 +00005273 SID = NextSelectorID++;
Douglas Gregor8d7edce2013-02-08 21:30:59 +00005274 SelectorIDs[Sel] = SID;
Steve Naroff2ddea052009-04-23 10:39:46 +00005275 }
Sebastian Redl834bb972010-08-04 17:20:04 +00005276 return SID;
Steve Naroff2ddea052009-04-23 10:39:46 +00005277}
5278
Richard Smithe64e7452016-04-18 21:54:58 +00005279void ASTRecordWriter::AddCXXTemporary(const CXXTemporary *Temp) {
5280 AddDeclRef(Temp->getDestructor());
Chris Lattnercba86142010-05-10 00:25:06 +00005281}
5282
Richard Smith290d8012016-04-06 17:06:00 +00005283void ASTRecordWriter::AddTemplateArgumentLocInfo(
5284 TemplateArgument::ArgKind Kind, const TemplateArgumentLocInfo &Arg) {
Argyrios Kyrtzidisae85e242010-06-22 09:54:59 +00005285 switch (Kind) {
John McCall0ad16662009-10-29 08:12:44 +00005286 case TemplateArgument::Expression:
Argyrios Kyrtzidisae85e242010-06-22 09:54:59 +00005287 AddStmt(Arg.getAsExpr());
John McCall0ad16662009-10-29 08:12:44 +00005288 break;
5289 case TemplateArgument::Type:
Richard Smith290d8012016-04-06 17:06:00 +00005290 AddTypeSourceInfo(Arg.getAsTypeSourceInfo());
John McCall0ad16662009-10-29 08:12:44 +00005291 break;
Douglas Gregor9167f8b2009-11-11 01:00:40 +00005292 case TemplateArgument::Template:
Richard Smith290d8012016-04-06 17:06:00 +00005293 AddNestedNameSpecifierLoc(Arg.getTemplateQualifierLoc());
5294 AddSourceLocation(Arg.getTemplateNameLoc());
Douglas Gregore4ff4b52011-01-05 18:58:31 +00005295 break;
5296 case TemplateArgument::TemplateExpansion:
Richard Smith290d8012016-04-06 17:06:00 +00005297 AddNestedNameSpecifierLoc(Arg.getTemplateQualifierLoc());
5298 AddSourceLocation(Arg.getTemplateNameLoc());
5299 AddSourceLocation(Arg.getTemplateEllipsisLoc());
Douglas Gregor9167f8b2009-11-11 01:00:40 +00005300 break;
John McCall0ad16662009-10-29 08:12:44 +00005301 case TemplateArgument::Null:
5302 case TemplateArgument::Integral:
5303 case TemplateArgument::Declaration:
Eli Friedmanb826a002012-09-26 02:36:12 +00005304 case TemplateArgument::NullPtr:
John McCall0ad16662009-10-29 08:12:44 +00005305 case TemplateArgument::Pack:
Eli Friedmanb826a002012-09-26 02:36:12 +00005306 // FIXME: Is this right?
John McCall0ad16662009-10-29 08:12:44 +00005307 break;
5308 }
5309}
5310
Richard Smith290d8012016-04-06 17:06:00 +00005311void ASTRecordWriter::AddTemplateArgumentLoc(const TemplateArgumentLoc &Arg) {
5312 AddTemplateArgument(Arg.getArgument());
Argyrios Kyrtzidisddf5f212010-06-28 09:31:42 +00005313
5314 if (Arg.getArgument().getKind() == TemplateArgument::Expression) {
5315 bool InfoHasSameExpr
5316 = Arg.getArgument().getAsExpr() == Arg.getLocInfo().getAsExpr();
Richard Smith290d8012016-04-06 17:06:00 +00005317 Record->push_back(InfoHasSameExpr);
Argyrios Kyrtzidisddf5f212010-06-28 09:31:42 +00005318 if (InfoHasSameExpr)
5319 return; // Avoid storing the same expr twice.
5320 }
Richard Smith290d8012016-04-06 17:06:00 +00005321 AddTemplateArgumentLocInfo(Arg.getArgument().getKind(), Arg.getLocInfo());
Argyrios Kyrtzidisae85e242010-06-22 09:54:59 +00005322}
5323
Richard Smith290d8012016-04-06 17:06:00 +00005324void ASTRecordWriter::AddTypeSourceInfo(TypeSourceInfo *TInfo) {
Craig Toppera13603a2014-05-22 05:54:18 +00005325 if (!TInfo) {
Richard Smith290d8012016-04-06 17:06:00 +00005326 AddTypeRef(QualType());
John McCall8f115c62009-10-16 21:56:05 +00005327 return;
5328 }
5329
Richard Smith290d8012016-04-06 17:06:00 +00005330 AddTypeLoc(TInfo->getTypeLoc());
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005331}
5332
Richard Smith290d8012016-04-06 17:06:00 +00005333void ASTRecordWriter::AddTypeLoc(TypeLoc TL) {
5334 AddTypeRef(TL.getType());
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005335
Richard Smith290d8012016-04-06 17:06:00 +00005336 TypeLocWriter TLW(*this);
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005337 for (; !TL.isNull(); TL = TL.getNextTypeLoc())
Kovarththanan Rajaratnama9c81a82010-03-14 07:06:50 +00005338 TLW.Visit(TL);
John McCall8f115c62009-10-16 21:56:05 +00005339}
5340
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00005341void ASTWriter::AddTypeRef(QualType T, RecordDataImpl &Record) {
Argyrios Kyrtzidis9ab44ea2010-08-20 16:04:14 +00005342 Record.push_back(GetOrCreateTypeID(T));
5343}
5344
Richard Smith2095ffe2015-03-16 20:11:03 +00005345TypeID ASTWriter::GetOrCreateTypeID(QualType T) {
Richard Smith1fa5d642013-05-11 05:45:24 +00005346 assert(Context);
Richard Smith2095ffe2015-03-16 20:11:03 +00005347 return MakeTypeID(*Context, T, [&](QualType T) -> TypeIdx {
5348 if (T.isNull())
5349 return TypeIdx();
5350 assert(!T.getLocalFastQualifiers());
5351
5352 TypeIdx &Idx = TypeIdxs[T];
5353 if (Idx.getIndex() == 0) {
5354 if (DoneWritingDeclsAndTypes) {
5355 assert(0 && "New type seen after serializing all the types to emit!");
5356 return TypeIdx();
5357 }
5358
5359 // We haven't seen this type before. Assign it a new ID and put it
5360 // into the queue of types to emit.
5361 Idx = TypeIdx(NextTypeID++);
5362 DeclTypesToEmit.push(T);
5363 }
5364 return Idx;
5365 });
Argyrios Kyrtzidis082e4612010-08-20 16:04:20 +00005366}
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005367
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00005368TypeID ASTWriter::getTypeID(QualType T) const {
Richard Smith1fa5d642013-05-11 05:45:24 +00005369 assert(Context);
Richard Smith2095ffe2015-03-16 20:11:03 +00005370 return MakeTypeID(*Context, T, [&](QualType T) -> TypeIdx {
5371 if (T.isNull())
Argyrios Kyrtzidis442dd802012-07-02 19:19:01 +00005372 return TypeIdx();
Richard Smith2095ffe2015-03-16 20:11:03 +00005373 assert(!T.getLocalFastQualifiers());
Argyrios Kyrtzidis442dd802012-07-02 19:19:01 +00005374
Richard Smith2095ffe2015-03-16 20:11:03 +00005375 TypeIdxMap::const_iterator I = TypeIdxs.find(T);
5376 assert(I != TypeIdxs.end() && "Type not emitted!");
5377 return I->second;
5378 });
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005379}
5380
Argyrios Kyrtzidis65ad5692010-10-24 17:26:36 +00005381void ASTWriter::AddDeclRef(const Decl *D, RecordDataImpl &Record) {
Sebastian Redl66c5eef2010-07-27 00:17:23 +00005382 Record.push_back(GetDeclRef(D));
5383}
5384
Sebastian Redl539c5062010-08-18 23:57:32 +00005385DeclID ASTWriter::GetDeclRef(const Decl *D) {
Douglas Gregor2fd3d402011-09-17 00:05:03 +00005386 assert(WritingAST && "Cannot request a declaration ID before AST writing");
Craig Toppera13603a2014-05-22 05:54:18 +00005387
5388 if (!D) {
Sebastian Redl66c5eef2010-07-27 00:17:23 +00005389 return 0;
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005390 }
Douglas Gregorb3163e52012-01-05 22:33:30 +00005391
5392 // If D comes from an AST file, its declaration ID is already known and
5393 // fixed.
5394 if (D->isFromASTFile())
5395 return D->getGlobalID();
5396
Douglas Gregor9b3932c2010-10-05 18:37:06 +00005397 assert(!(reinterpret_cast<uintptr_t>(D) & 0x01) && "Invalid decl pointer");
Sebastian Redl539c5062010-08-18 23:57:32 +00005398 DeclID &ID = DeclIDs[D];
Mike Stump11289f42009-09-09 15:08:12 +00005399 if (ID == 0) {
Argyrios Kyrtzidis442dd802012-07-02 19:19:01 +00005400 if (DoneWritingDeclsAndTypes) {
5401 assert(0 && "New decl seen after serializing all the decls to emit!");
5402 return 0;
5403 }
5404
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005405 // We haven't seen this declaration before. Give it a new ID and
5406 // enqueue it in the list of declarations to emit.
Sebastian Redlff4a2952010-07-23 23:49:55 +00005407 ID = NextDeclID++;
Douglas Gregor12bfa382009-10-17 00:13:19 +00005408 DeclTypesToEmit.push(const_cast<Decl *>(D));
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005409 }
5410
Sebastian Redl66c5eef2010-07-27 00:17:23 +00005411 return ID;
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005412}
5413
Sebastian Redl539c5062010-08-18 23:57:32 +00005414DeclID ASTWriter::getDeclID(const Decl *D) {
Craig Toppera13603a2014-05-22 05:54:18 +00005415 if (!D)
Douglas Gregore84a9da2009-04-20 20:36:09 +00005416 return 0;
5417
Douglas Gregorb3163e52012-01-05 22:33:30 +00005418 // If D comes from an AST file, its declaration ID is already known and
5419 // fixed.
5420 if (D->isFromASTFile())
5421 return D->getGlobalID();
5422
Douglas Gregore84a9da2009-04-20 20:36:09 +00005423 assert(DeclIDs.find(D) != DeclIDs.end() && "Declaration not emitted!");
5424 return DeclIDs[D];
5425}
5426
Argyrios Kyrtzidisdf53da82011-10-28 23:57:43 +00005427void ASTWriter::associateDeclWithFile(const Decl *D, DeclID ID) {
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005428 assert(ID);
Argyrios Kyrtzidisdf53da82011-10-28 23:57:43 +00005429 assert(D);
5430
5431 SourceLocation Loc = D->getLocation();
5432 if (Loc.isInvalid())
5433 return;
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005434
5435 // We only keep track of the file-level declarations of each file.
5436 if (!D->getLexicalDeclContext()->isFileContext())
5437 return;
Argyrios Kyrtzidise1bc99e2012-02-24 19:45:46 +00005438 // FIXME: ParmVarDecls that are part of a function type of a parameter of
5439 // a function/objc method, should not have TU as lexical context.
Argyrios Kyrtzidisffe055a82012-02-24 01:12:38 +00005440 if (isa<ParmVarDecl>(D))
5441 return;
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005442
5443 SourceManager &SM = Context->getSourceManager();
Argyrios Kyrtzidisdf53da82011-10-28 23:57:43 +00005444 SourceLocation FileLoc = SM.getFileLoc(Loc);
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005445 assert(SM.isLocalSourceLocation(FileLoc));
Argyrios Kyrtzidis7362e9b2011-10-28 23:57:47 +00005446 FileID FID;
5447 unsigned Offset;
Benjamin Kramer867ea1d2014-03-02 13:01:17 +00005448 std::tie(FID, Offset) = SM.getDecomposedLoc(FileLoc);
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005449 if (FID.isInvalid())
5450 return;
Argyrios Kyrtzidis4db774a2012-10-02 21:09:17 +00005451 assert(SM.getSLocEntry(FID).isFile());
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005452
Argyrios Kyrtzidis4db774a2012-10-02 21:09:17 +00005453 DeclIDInFileInfo *&Info = FileDeclIDs[FID];
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005454 if (!Info)
5455 Info = new DeclIDInFileInfo();
5456
Argyrios Kyrtzidis7362e9b2011-10-28 23:57:47 +00005457 std::pair<unsigned, serialization::DeclID> LocDecl(Offset, ID);
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005458 LocDeclIDsTy &Decls = Info->DeclIDs;
5459
Argyrios Kyrtzidis7362e9b2011-10-28 23:57:47 +00005460 if (Decls.empty() || Decls.back().first <= Offset) {
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005461 Decls.push_back(LocDecl);
5462 return;
5463 }
5464
Benjamin Kramer45025c02013-08-24 13:22:59 +00005465 LocDeclIDsTy::iterator I =
5466 std::upper_bound(Decls.begin(), Decls.end(), LocDecl, llvm::less_first());
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005467
5468 Decls.insert(I, LocDecl);
5469}
5470
Richard Smithe64e7452016-04-18 21:54:58 +00005471void ASTRecordWriter::AddDeclarationName(DeclarationName Name) {
Chris Lattner258172e2009-04-27 07:35:58 +00005472 // FIXME: Emit a stable enum for NameKind. 0 = Identifier etc.
Richard Smithe64e7452016-04-18 21:54:58 +00005473 Record->push_back(Name.getNameKind());
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005474 switch (Name.getNameKind()) {
5475 case DeclarationName::Identifier:
Richard Smithe64e7452016-04-18 21:54:58 +00005476 AddIdentifierRef(Name.getAsIdentifierInfo());
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005477 break;
5478
5479 case DeclarationName::ObjCZeroArgSelector:
5480 case DeclarationName::ObjCOneArgSelector:
5481 case DeclarationName::ObjCMultiArgSelector:
Richard Smithe64e7452016-04-18 21:54:58 +00005482 AddSelectorRef(Name.getObjCSelector());
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005483 break;
5484
5485 case DeclarationName::CXXConstructorName:
5486 case DeclarationName::CXXDestructorName:
5487 case DeclarationName::CXXConversionFunctionName:
Richard Smithe64e7452016-04-18 21:54:58 +00005488 AddTypeRef(Name.getCXXNameType());
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005489 break;
5490
Richard Smith35845152017-02-07 01:37:30 +00005491 case DeclarationName::CXXDeductionGuideName:
5492 AddDeclRef(Name.getCXXDeductionGuideTemplate());
5493 break;
5494
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005495 case DeclarationName::CXXOperatorName:
Richard Smithe64e7452016-04-18 21:54:58 +00005496 Record->push_back(Name.getCXXOverloadedOperator());
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005497 break;
5498
Alexis Hunt3d221f22009-11-29 07:34:05 +00005499 case DeclarationName::CXXLiteralOperatorName:
Richard Smithe64e7452016-04-18 21:54:58 +00005500 AddIdentifierRef(Name.getCXXLiteralIdentifier());
Alexis Hunt3d221f22009-11-29 07:34:05 +00005501 break;
5502
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005503 case DeclarationName::CXXUsingDirective:
5504 // No extra data to emit
5505 break;
5506 }
5507}
Chris Lattnerca025db2010-05-07 21:43:38 +00005508
Richard Smithd08aeb62014-08-28 01:33:39 +00005509unsigned ASTWriter::getAnonymousDeclarationNumber(const NamedDecl *D) {
5510 assert(needsAnonymousDeclarationNumber(D) &&
5511 "expected an anonymous declaration");
5512
5513 // Number the anonymous declarations within this context, if we've not
5514 // already done so.
5515 auto It = AnonymousDeclarationNumbers.find(D);
5516 if (It == AnonymousDeclarationNumbers.end()) {
Richard Smith2b560572015-02-07 03:11:11 +00005517 auto *DC = D->getLexicalDeclContext();
5518 numberAnonymousDeclsWithin(DC, [&](const NamedDecl *ND, unsigned Number) {
5519 AnonymousDeclarationNumbers[ND] = Number;
5520 });
Richard Smithd08aeb62014-08-28 01:33:39 +00005521
5522 It = AnonymousDeclarationNumbers.find(D);
5523 assert(It != AnonymousDeclarationNumbers.end() &&
5524 "declaration not found within its lexical context");
5525 }
5526
5527 return It->second;
5528}
5529
Richard Smith290d8012016-04-06 17:06:00 +00005530void ASTRecordWriter::AddDeclarationNameLoc(const DeclarationNameLoc &DNLoc,
5531 DeclarationName Name) {
Argyrios Kyrtzidis434383d2010-10-15 18:21:24 +00005532 switch (Name.getNameKind()) {
5533 case DeclarationName::CXXConstructorName:
5534 case DeclarationName::CXXDestructorName:
5535 case DeclarationName::CXXConversionFunctionName:
Richard Smith290d8012016-04-06 17:06:00 +00005536 AddTypeSourceInfo(DNLoc.NamedType.TInfo);
Argyrios Kyrtzidis434383d2010-10-15 18:21:24 +00005537 break;
5538
5539 case DeclarationName::CXXOperatorName:
Richard Smith290d8012016-04-06 17:06:00 +00005540 AddSourceLocation(SourceLocation::getFromRawEncoding(
5541 DNLoc.CXXOperatorName.BeginOpNameLoc));
Argyrios Kyrtzidis434383d2010-10-15 18:21:24 +00005542 AddSourceLocation(
Richard Smith290d8012016-04-06 17:06:00 +00005543 SourceLocation::getFromRawEncoding(DNLoc.CXXOperatorName.EndOpNameLoc));
Argyrios Kyrtzidis434383d2010-10-15 18:21:24 +00005544 break;
5545
5546 case DeclarationName::CXXLiteralOperatorName:
Richard Smith290d8012016-04-06 17:06:00 +00005547 AddSourceLocation(SourceLocation::getFromRawEncoding(
5548 DNLoc.CXXLiteralOperatorName.OpNameLoc));
Argyrios Kyrtzidis434383d2010-10-15 18:21:24 +00005549 break;
5550
5551 case DeclarationName::Identifier:
5552 case DeclarationName::ObjCZeroArgSelector:
5553 case DeclarationName::ObjCOneArgSelector:
5554 case DeclarationName::ObjCMultiArgSelector:
5555 case DeclarationName::CXXUsingDirective:
Richard Smith35845152017-02-07 01:37:30 +00005556 case DeclarationName::CXXDeductionGuideName:
Argyrios Kyrtzidis434383d2010-10-15 18:21:24 +00005557 break;
5558 }
5559}
5560
Richard Smith290d8012016-04-06 17:06:00 +00005561void ASTRecordWriter::AddDeclarationNameInfo(
5562 const DeclarationNameInfo &NameInfo) {
5563 AddDeclarationName(NameInfo.getName());
5564 AddSourceLocation(NameInfo.getLoc());
5565 AddDeclarationNameLoc(NameInfo.getInfo(), NameInfo.getName());
Argyrios Kyrtzidis434383d2010-10-15 18:21:24 +00005566}
5567
Richard Smith290d8012016-04-06 17:06:00 +00005568void ASTRecordWriter::AddQualifierInfo(const QualifierInfo &Info) {
5569 AddNestedNameSpecifierLoc(Info.QualifierLoc);
5570 Record->push_back(Info.NumTemplParamLists);
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +00005571 for (unsigned i = 0, e = Info.NumTemplParamLists; i != e; ++i)
Richard Smith290d8012016-04-06 17:06:00 +00005572 AddTemplateParameterList(Info.TemplParamLists[i]);
Argyrios Kyrtzidis434383d2010-10-15 18:21:24 +00005573}
5574
Richard Smithe64e7452016-04-18 21:54:58 +00005575void ASTRecordWriter::AddNestedNameSpecifier(NestedNameSpecifier *NNS) {
Chris Lattnerca025db2010-05-07 21:43:38 +00005576 // Nested name specifiers usually aren't too long. I think that 8 would
Chris Lattner57540c52011-04-15 05:22:18 +00005577 // typically accommodate the vast majority.
Chris Lattner0e62c1c2011-07-23 10:55:15 +00005578 SmallVector<NestedNameSpecifier *, 8> NestedNames;
Chris Lattnerca025db2010-05-07 21:43:38 +00005579
5580 // Push each of the NNS's onto a stack for serialization in reverse order.
5581 while (NNS) {
5582 NestedNames.push_back(NNS);
5583 NNS = NNS->getPrefix();
5584 }
5585
Richard Smithe64e7452016-04-18 21:54:58 +00005586 Record->push_back(NestedNames.size());
Chris Lattnerca025db2010-05-07 21:43:38 +00005587 while(!NestedNames.empty()) {
5588 NNS = NestedNames.pop_back_val();
5589 NestedNameSpecifier::SpecifierKind Kind = NNS->getKind();
Richard Smithe64e7452016-04-18 21:54:58 +00005590 Record->push_back(Kind);
Chris Lattnerca025db2010-05-07 21:43:38 +00005591 switch (Kind) {
5592 case NestedNameSpecifier::Identifier:
Richard Smithe64e7452016-04-18 21:54:58 +00005593 AddIdentifierRef(NNS->getAsIdentifier());
Chris Lattnerca025db2010-05-07 21:43:38 +00005594 break;
5595
5596 case NestedNameSpecifier::Namespace:
Richard Smithe64e7452016-04-18 21:54:58 +00005597 AddDeclRef(NNS->getAsNamespace());
Chris Lattnerca025db2010-05-07 21:43:38 +00005598 break;
5599
Douglas Gregor7b26ff92011-02-24 02:36:08 +00005600 case NestedNameSpecifier::NamespaceAlias:
Richard Smithe64e7452016-04-18 21:54:58 +00005601 AddDeclRef(NNS->getAsNamespaceAlias());
Douglas Gregor7b26ff92011-02-24 02:36:08 +00005602 break;
5603
Chris Lattnerca025db2010-05-07 21:43:38 +00005604 case NestedNameSpecifier::TypeSpec:
5605 case NestedNameSpecifier::TypeSpecWithTemplate:
Richard Smithe64e7452016-04-18 21:54:58 +00005606 AddTypeRef(QualType(NNS->getAsType(), 0));
5607 Record->push_back(Kind == NestedNameSpecifier::TypeSpecWithTemplate);
Chris Lattnerca025db2010-05-07 21:43:38 +00005608 break;
5609
5610 case NestedNameSpecifier::Global:
5611 // Don't need to write an associated value.
5612 break;
Nikola Smiljanic67860242014-09-26 00:28:20 +00005613
5614 case NestedNameSpecifier::Super:
Richard Smithe64e7452016-04-18 21:54:58 +00005615 AddDeclRef(NNS->getAsRecordDecl());
Nikola Smiljanic67860242014-09-26 00:28:20 +00005616 break;
Chris Lattnerca025db2010-05-07 21:43:38 +00005617 }
5618 }
5619}
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005620
Richard Smith290d8012016-04-06 17:06:00 +00005621void ASTRecordWriter::AddNestedNameSpecifierLoc(NestedNameSpecifierLoc NNS) {
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005622 // Nested name specifiers usually aren't too long. I think that 8 would
Chris Lattner57540c52011-04-15 05:22:18 +00005623 // typically accommodate the vast majority.
Chris Lattner0e62c1c2011-07-23 10:55:15 +00005624 SmallVector<NestedNameSpecifierLoc , 8> NestedNames;
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005625
5626 // Push each of the nested-name-specifiers's onto a stack for
5627 // serialization in reverse order.
5628 while (NNS) {
5629 NestedNames.push_back(NNS);
5630 NNS = NNS.getPrefix();
5631 }
5632
Richard Smith290d8012016-04-06 17:06:00 +00005633 Record->push_back(NestedNames.size());
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005634 while(!NestedNames.empty()) {
5635 NNS = NestedNames.pop_back_val();
5636 NestedNameSpecifier::SpecifierKind Kind
5637 = NNS.getNestedNameSpecifier()->getKind();
Richard Smith290d8012016-04-06 17:06:00 +00005638 Record->push_back(Kind);
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005639 switch (Kind) {
5640 case NestedNameSpecifier::Identifier:
Richard Smith290d8012016-04-06 17:06:00 +00005641 AddIdentifierRef(NNS.getNestedNameSpecifier()->getAsIdentifier());
5642 AddSourceRange(NNS.getLocalSourceRange());
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005643 break;
5644
5645 case NestedNameSpecifier::Namespace:
Richard Smith290d8012016-04-06 17:06:00 +00005646 AddDeclRef(NNS.getNestedNameSpecifier()->getAsNamespace());
5647 AddSourceRange(NNS.getLocalSourceRange());
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005648 break;
5649
5650 case NestedNameSpecifier::NamespaceAlias:
Richard Smith290d8012016-04-06 17:06:00 +00005651 AddDeclRef(NNS.getNestedNameSpecifier()->getAsNamespaceAlias());
5652 AddSourceRange(NNS.getLocalSourceRange());
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005653 break;
5654
5655 case NestedNameSpecifier::TypeSpec:
5656 case NestedNameSpecifier::TypeSpecWithTemplate:
Richard Smith290d8012016-04-06 17:06:00 +00005657 Record->push_back(Kind == NestedNameSpecifier::TypeSpecWithTemplate);
5658 AddTypeLoc(NNS.getTypeLoc());
5659 AddSourceLocation(NNS.getLocalSourceRange().getEnd());
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005660 break;
5661
5662 case NestedNameSpecifier::Global:
Richard Smith290d8012016-04-06 17:06:00 +00005663 AddSourceLocation(NNS.getLocalSourceRange().getEnd());
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005664 break;
Nikola Smiljanic67860242014-09-26 00:28:20 +00005665
5666 case NestedNameSpecifier::Super:
Richard Smith290d8012016-04-06 17:06:00 +00005667 AddDeclRef(NNS.getNestedNameSpecifier()->getAsRecordDecl());
5668 AddSourceRange(NNS.getLocalSourceRange());
Nikola Smiljanic67860242014-09-26 00:28:20 +00005669 break;
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005670 }
5671 }
5672}
5673
Richard Smith290d8012016-04-06 17:06:00 +00005674void ASTRecordWriter::AddTemplateName(TemplateName Name) {
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00005675 TemplateName::NameKind Kind = Name.getKind();
Richard Smith290d8012016-04-06 17:06:00 +00005676 Record->push_back(Kind);
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005677 switch (Kind) {
5678 case TemplateName::Template:
Richard Smith290d8012016-04-06 17:06:00 +00005679 AddDeclRef(Name.getAsTemplateDecl());
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005680 break;
5681
5682 case TemplateName::OverloadedTemplate: {
5683 OverloadedTemplateStorage *OvT = Name.getAsOverloadedTemplate();
Richard Smith290d8012016-04-06 17:06:00 +00005684 Record->push_back(OvT->size());
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00005685 for (const auto &I : *OvT)
Richard Smith290d8012016-04-06 17:06:00 +00005686 AddDeclRef(I);
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005687 break;
5688 }
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00005689
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005690 case TemplateName::QualifiedTemplate: {
5691 QualifiedTemplateName *QualT = Name.getAsQualifiedTemplateName();
Richard Smith290d8012016-04-06 17:06:00 +00005692 AddNestedNameSpecifier(QualT->getQualifier());
5693 Record->push_back(QualT->hasTemplateKeyword());
5694 AddDeclRef(QualT->getTemplateDecl());
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005695 break;
5696 }
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00005697
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005698 case TemplateName::DependentTemplate: {
5699 DependentTemplateName *DepT = Name.getAsDependentTemplateName();
Richard Smith290d8012016-04-06 17:06:00 +00005700 AddNestedNameSpecifier(DepT->getQualifier());
5701 Record->push_back(DepT->isIdentifier());
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005702 if (DepT->isIdentifier())
Richard Smith290d8012016-04-06 17:06:00 +00005703 AddIdentifierRef(DepT->getIdentifier());
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005704 else
Richard Smith290d8012016-04-06 17:06:00 +00005705 Record->push_back(DepT->getOperator());
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005706 break;
5707 }
John McCalld9dfe3a2011-06-30 08:33:18 +00005708
5709 case TemplateName::SubstTemplateTemplateParm: {
5710 SubstTemplateTemplateParmStorage *subst
5711 = Name.getAsSubstTemplateTemplateParm();
Richard Smith290d8012016-04-06 17:06:00 +00005712 AddDeclRef(subst->getParameter());
5713 AddTemplateName(subst->getReplacement());
John McCalld9dfe3a2011-06-30 08:33:18 +00005714 break;
5715 }
Douglas Gregor5590be02011-01-15 06:45:20 +00005716
5717 case TemplateName::SubstTemplateTemplateParmPack: {
5718 SubstTemplateTemplateParmPackStorage *SubstPack
5719 = Name.getAsSubstTemplateTemplateParmPack();
Richard Smith290d8012016-04-06 17:06:00 +00005720 AddDeclRef(SubstPack->getParameterPack());
5721 AddTemplateArgument(SubstPack->getArgumentPack());
Douglas Gregor5590be02011-01-15 06:45:20 +00005722 break;
5723 }
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005724 }
5725}
5726
Richard Smith290d8012016-04-06 17:06:00 +00005727void ASTRecordWriter::AddTemplateArgument(const TemplateArgument &Arg) {
5728 Record->push_back(Arg.getKind());
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005729 switch (Arg.getKind()) {
5730 case TemplateArgument::Null:
5731 break;
5732 case TemplateArgument::Type:
Richard Smith290d8012016-04-06 17:06:00 +00005733 AddTypeRef(Arg.getAsType());
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005734 break;
5735 case TemplateArgument::Declaration:
Richard Smith290d8012016-04-06 17:06:00 +00005736 AddDeclRef(Arg.getAsDecl());
5737 AddTypeRef(Arg.getParamTypeForDecl());
Eli Friedmanb826a002012-09-26 02:36:12 +00005738 break;
5739 case TemplateArgument::NullPtr:
Richard Smith290d8012016-04-06 17:06:00 +00005740 AddTypeRef(Arg.getNullPtrType());
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005741 break;
5742 case TemplateArgument::Integral:
Richard Smith290d8012016-04-06 17:06:00 +00005743 AddAPSInt(Arg.getAsIntegral());
5744 AddTypeRef(Arg.getIntegralType());
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005745 break;
5746 case TemplateArgument::Template:
Richard Smith290d8012016-04-06 17:06:00 +00005747 AddTemplateName(Arg.getAsTemplateOrTemplatePattern());
Douglas Gregore1d60df2011-01-14 23:41:42 +00005748 break;
Douglas Gregore4ff4b52011-01-05 18:58:31 +00005749 case TemplateArgument::TemplateExpansion:
Richard Smith290d8012016-04-06 17:06:00 +00005750 AddTemplateName(Arg.getAsTemplateOrTemplatePattern());
David Blaikie05785d12013-02-20 22:23:23 +00005751 if (Optional<unsigned> NumExpansions = Arg.getNumTemplateExpansions())
Richard Smith290d8012016-04-06 17:06:00 +00005752 Record->push_back(*NumExpansions + 1);
Douglas Gregore1d60df2011-01-14 23:41:42 +00005753 else
Richard Smith290d8012016-04-06 17:06:00 +00005754 Record->push_back(0);
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005755 break;
5756 case TemplateArgument::Expression:
5757 AddStmt(Arg.getAsExpr());
5758 break;
5759 case TemplateArgument::Pack:
Richard Smith290d8012016-04-06 17:06:00 +00005760 Record->push_back(Arg.pack_size());
Aaron Ballman2a89e852014-07-15 21:32:31 +00005761 for (const auto &P : Arg.pack_elements())
Richard Smith290d8012016-04-06 17:06:00 +00005762 AddTemplateArgument(P);
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005763 break;
5764 }
5765}
Argyrios Kyrtzidis818c5db2010-06-23 13:48:30 +00005766
Richard Smithe64e7452016-04-18 21:54:58 +00005767void ASTRecordWriter::AddTemplateParameterList(
5768 const TemplateParameterList *TemplateParams) {
Argyrios Kyrtzidis818c5db2010-06-23 13:48:30 +00005769 assert(TemplateParams && "No TemplateParams!");
Richard Smithe64e7452016-04-18 21:54:58 +00005770 AddSourceLocation(TemplateParams->getTemplateLoc());
5771 AddSourceLocation(TemplateParams->getLAngleLoc());
5772 AddSourceLocation(TemplateParams->getRAngleLoc());
Hubert Tonge4a0c0e2016-07-30 22:33:34 +00005773 // TODO: Concepts
Richard Smithe64e7452016-04-18 21:54:58 +00005774 Record->push_back(TemplateParams->size());
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00005775 for (const auto &P : *TemplateParams)
Richard Smithe64e7452016-04-18 21:54:58 +00005776 AddDeclRef(P);
Argyrios Kyrtzidis818c5db2010-06-23 13:48:30 +00005777}
5778
5779/// \brief Emit a template argument list.
Richard Smith290d8012016-04-06 17:06:00 +00005780void ASTRecordWriter::AddTemplateArgumentList(
5781 const TemplateArgumentList *TemplateArgs) {
Argyrios Kyrtzidis818c5db2010-06-23 13:48:30 +00005782 assert(TemplateArgs && "No TemplateArgs!");
Richard Smith290d8012016-04-06 17:06:00 +00005783 Record->push_back(TemplateArgs->size());
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +00005784 for (int i = 0, e = TemplateArgs->size(); i != e; ++i)
Richard Smith290d8012016-04-06 17:06:00 +00005785 AddTemplateArgument(TemplateArgs->get(i));
Argyrios Kyrtzidis818c5db2010-06-23 13:48:30 +00005786}
Argyrios Kyrtzidis2c2167a2010-07-02 11:55:32 +00005787
Richard Smith290d8012016-04-06 17:06:00 +00005788void ASTRecordWriter::AddASTTemplateArgumentListInfo(
5789 const ASTTemplateArgumentListInfo *ASTTemplArgList) {
Enea Zaffanella6dbe1872013-08-10 07:24:53 +00005790 assert(ASTTemplArgList && "No ASTTemplArgList!");
Richard Smith290d8012016-04-06 17:06:00 +00005791 AddSourceLocation(ASTTemplArgList->LAngleLoc);
5792 AddSourceLocation(ASTTemplArgList->RAngleLoc);
5793 Record->push_back(ASTTemplArgList->NumTemplateArgs);
Enea Zaffanella6dbe1872013-08-10 07:24:53 +00005794 const TemplateArgumentLoc *TemplArgs = ASTTemplArgList->getTemplateArgs();
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +00005795 for (int i = 0, e = ASTTemplArgList->NumTemplateArgs; i != e; ++i)
Richard Smith290d8012016-04-06 17:06:00 +00005796 AddTemplateArgumentLoc(TemplArgs[i]);
Enea Zaffanella6dbe1872013-08-10 07:24:53 +00005797}
Argyrios Kyrtzidis2c2167a2010-07-02 11:55:32 +00005798
Richard Smithe64e7452016-04-18 21:54:58 +00005799void ASTRecordWriter::AddUnresolvedSet(const ASTUnresolvedSet &Set) {
5800 Record->push_back(Set.size());
Argyrios Kyrtzidis0f05fb92012-11-28 03:56:16 +00005801 for (ASTUnresolvedSet::const_iterator
Argyrios Kyrtzidis2c2167a2010-07-02 11:55:32 +00005802 I = Set.begin(), E = Set.end(); I != E; ++I) {
Richard Smithe64e7452016-04-18 21:54:58 +00005803 AddDeclRef(I.getDecl());
5804 Record->push_back(I.getAccess());
Argyrios Kyrtzidis2c2167a2010-07-02 11:55:32 +00005805 }
5806}
Argyrios Kyrtzidis3701fcd2010-07-02 23:30:27 +00005807
Richard Smith290d8012016-04-06 17:06:00 +00005808// FIXME: Move this out of the main ASTRecordWriter interface.
5809void ASTRecordWriter::AddCXXBaseSpecifier(const CXXBaseSpecifier &Base) {
5810 Record->push_back(Base.isVirtual());
5811 Record->push_back(Base.isBaseOfClass());
5812 Record->push_back(Base.getAccessSpecifierAsWritten());
5813 Record->push_back(Base.getInheritConstructors());
5814 AddTypeSourceInfo(Base.getTypeSourceInfo());
5815 AddSourceRange(Base.getSourceRange());
Douglas Gregor752a5952011-01-03 22:36:02 +00005816 AddSourceLocation(Base.isPackExpansion()? Base.getEllipsisLoc()
Richard Smith290d8012016-04-06 17:06:00 +00005817 : SourceLocation());
Argyrios Kyrtzidis3701fcd2010-07-02 23:30:27 +00005818}
Sebastian Redl85b2a6a2010-07-14 23:45:08 +00005819
Richard Smith645d2cf2016-04-14 00:29:55 +00005820static uint64_t EmitCXXBaseSpecifiers(ASTWriter &W,
5821 ArrayRef<CXXBaseSpecifier> Bases) {
5822 ASTWriter::RecordData Record;
5823 ASTRecordWriter Writer(W, Record);
5824 Writer.push_back(Bases.size());
Dmitry Polukhin790b5402016-04-06 10:01:46 +00005825
Richard Smith645d2cf2016-04-14 00:29:55 +00005826 for (auto &Base : Bases)
5827 Writer.AddCXXBaseSpecifier(Base);
Richard Smith290d8012016-04-06 17:06:00 +00005828
Richard Smith645d2cf2016-04-14 00:29:55 +00005829 return Writer.Emit(serialization::DECL_CXX_BASE_SPECIFIERS);
Douglas Gregord4c5ed02010-10-29 22:39:52 +00005830}
5831
Richard Smith290d8012016-04-06 17:06:00 +00005832// FIXME: Move this out of the main ASTRecordWriter interface.
Richard Smith645d2cf2016-04-14 00:29:55 +00005833void ASTRecordWriter::AddCXXBaseSpecifiers(ArrayRef<CXXBaseSpecifier> Bases) {
5834 AddOffset(EmitCXXBaseSpecifiers(*Writer, Bases));
5835}
5836
Richard Smithaa165cf2016-04-13 21:57:08 +00005837static uint64_t
5838EmitCXXCtorInitializers(ASTWriter &W,
5839 ArrayRef<CXXCtorInitializer *> CtorInits) {
5840 ASTWriter::RecordData Record;
5841 ASTRecordWriter Writer(W, Record);
5842 Writer.push_back(CtorInits.size());
Argyrios Kyrtzidis5b6a03f2010-08-09 10:54:12 +00005843
Richard Smithaa165cf2016-04-13 21:57:08 +00005844 for (auto *Init : CtorInits) {
Argyrios Kyrtzidis5b6a03f2010-08-09 10:54:12 +00005845 if (Init->isBaseInitializer()) {
Richard Smithaa165cf2016-04-13 21:57:08 +00005846 Writer.push_back(CTOR_INITIALIZER_BASE);
5847 Writer.AddTypeSourceInfo(Init->getTypeSourceInfo());
5848 Writer.push_back(Init->isBaseVirtual());
Alexis Hunt37a477f2011-05-04 01:19:08 +00005849 } else if (Init->isDelegatingInitializer()) {
Richard Smithaa165cf2016-04-13 21:57:08 +00005850 Writer.push_back(CTOR_INITIALIZER_DELEGATING);
5851 Writer.AddTypeSourceInfo(Init->getTypeSourceInfo());
Alexis Hunt37a477f2011-05-04 01:19:08 +00005852 } else if (Init->isMemberInitializer()){
Richard Smithaa165cf2016-04-13 21:57:08 +00005853 Writer.push_back(CTOR_INITIALIZER_MEMBER);
5854 Writer.AddDeclRef(Init->getMember());
Argyrios Kyrtzidis5b6a03f2010-08-09 10:54:12 +00005855 } else {
Richard Smithaa165cf2016-04-13 21:57:08 +00005856 Writer.push_back(CTOR_INITIALIZER_INDIRECT_MEMBER);
5857 Writer.AddDeclRef(Init->getIndirectMember());
Argyrios Kyrtzidis5b6a03f2010-08-09 10:54:12 +00005858 }
Francois Pichetd583da02010-12-04 09:14:42 +00005859
Richard Smithaa165cf2016-04-13 21:57:08 +00005860 Writer.AddSourceLocation(Init->getMemberLocation());
5861 Writer.AddStmt(Init->getInit());
5862 Writer.AddSourceLocation(Init->getLParenLoc());
5863 Writer.AddSourceLocation(Init->getRParenLoc());
5864 Writer.push_back(Init->isWritten());
Richard Smith30e304e2016-12-14 00:03:17 +00005865 if (Init->isWritten())
Richard Smithaa165cf2016-04-13 21:57:08 +00005866 Writer.push_back(Init->getSourceOrder());
Argyrios Kyrtzidis5b6a03f2010-08-09 10:54:12 +00005867 }
Richard Smithaa165cf2016-04-13 21:57:08 +00005868
5869 return Writer.Emit(serialization::DECL_CXX_CTOR_INITIALIZERS);
Argyrios Kyrtzidis5b6a03f2010-08-09 10:54:12 +00005870}
5871
Richard Smithaa165cf2016-04-13 21:57:08 +00005872// FIXME: Move this out of the main ASTRecordWriter interface.
5873void ASTRecordWriter::AddCXXCtorInitializers(
5874 ArrayRef<CXXCtorInitializer *> CtorInits) {
5875 AddOffset(EmitCXXCtorInitializers(*Writer, CtorInits));
Richard Smithc2bb8182015-03-24 06:36:48 +00005876}
5877
Richard Smith290d8012016-04-06 17:06:00 +00005878void ASTRecordWriter::AddCXXDefinitionData(const CXXRecordDecl *D) {
Richard Smith053f6c62014-05-16 23:01:30 +00005879 auto &Data = D->data();
Richard Smith290d8012016-04-06 17:06:00 +00005880 Record->push_back(Data.IsLambda);
5881 Record->push_back(Data.UserDeclaredConstructor);
5882 Record->push_back(Data.UserDeclaredSpecialMembers);
5883 Record->push_back(Data.Aggregate);
5884 Record->push_back(Data.PlainOldData);
5885 Record->push_back(Data.Empty);
5886 Record->push_back(Data.Polymorphic);
5887 Record->push_back(Data.Abstract);
5888 Record->push_back(Data.IsStandardLayout);
5889 Record->push_back(Data.HasNoNonEmptyBases);
5890 Record->push_back(Data.HasPrivateFields);
5891 Record->push_back(Data.HasProtectedFields);
5892 Record->push_back(Data.HasPublicFields);
5893 Record->push_back(Data.HasMutableFields);
5894 Record->push_back(Data.HasVariantMembers);
5895 Record->push_back(Data.HasOnlyCMembers);
5896 Record->push_back(Data.HasInClassInitializer);
5897 Record->push_back(Data.HasUninitializedReferenceMember);
5898 Record->push_back(Data.HasUninitializedFields);
Richard Smith12e79312016-05-13 06:47:56 +00005899 Record->push_back(Data.HasInheritedConstructor);
5900 Record->push_back(Data.HasInheritedAssignment);
Richard Smith96cd6712017-08-16 01:49:53 +00005901 Record->push_back(Data.NeedOverloadResolutionForCopyConstructor);
Richard Smith290d8012016-04-06 17:06:00 +00005902 Record->push_back(Data.NeedOverloadResolutionForMoveConstructor);
5903 Record->push_back(Data.NeedOverloadResolutionForMoveAssignment);
5904 Record->push_back(Data.NeedOverloadResolutionForDestructor);
Richard Smith96cd6712017-08-16 01:49:53 +00005905 Record->push_back(Data.DefaultedCopyConstructorIsDeleted);
Richard Smith290d8012016-04-06 17:06:00 +00005906 Record->push_back(Data.DefaultedMoveConstructorIsDeleted);
5907 Record->push_back(Data.DefaultedMoveAssignmentIsDeleted);
5908 Record->push_back(Data.DefaultedDestructorIsDeleted);
5909 Record->push_back(Data.HasTrivialSpecialMembers);
5910 Record->push_back(Data.DeclaredNonTrivialSpecialMembers);
5911 Record->push_back(Data.HasIrrelevantDestructor);
5912 Record->push_back(Data.HasConstexprNonCopyMoveConstructor);
5913 Record->push_back(Data.HasDefaultedDefaultConstructor);
Richard Smith96cd6712017-08-16 01:49:53 +00005914 Record->push_back(Data.CanPassInRegisters);
Richard Smith290d8012016-04-06 17:06:00 +00005915 Record->push_back(Data.DefaultedDefaultConstructorIsConstexpr);
5916 Record->push_back(Data.HasConstexprDefaultConstructor);
5917 Record->push_back(Data.HasNonLiteralTypeFieldsOrBases);
5918 Record->push_back(Data.ComputedVisibleConversions);
5919 Record->push_back(Data.UserProvidedDefaultConstructor);
5920 Record->push_back(Data.DeclaredSpecialMembers);
Richard Smithdf054d32017-02-25 23:53:05 +00005921 Record->push_back(Data.ImplicitCopyConstructorCanHaveConstParamForVBase);
5922 Record->push_back(Data.ImplicitCopyConstructorCanHaveConstParamForNonVBase);
Richard Smith290d8012016-04-06 17:06:00 +00005923 Record->push_back(Data.ImplicitCopyAssignmentHasConstParam);
5924 Record->push_back(Data.HasDeclaredCopyConstructorWithConstParam);
5925 Record->push_back(Data.HasDeclaredCopyAssignmentWithConstParam);
Richard Trieufd1acbb2017-04-11 21:31:00 +00005926
5927 // getODRHash will compute the ODRHash if it has not been previously computed.
5928 Record->push_back(D->getODRHash());
David Blaikief63556d2017-04-12 20:58:33 +00005929 bool ModulesDebugInfo = Writer->Context->getLangOpts().ModulesDebugInfo &&
5930 Writer->WritingModule && !D->isDependentType();
5931 Record->push_back(ModulesDebugInfo);
5932 if (ModulesDebugInfo)
David Blaikie1ac9c982017-04-11 21:13:37 +00005933 Writer->ModularCodegenDecls.push_back(Writer->GetDeclRef(D));
5934
Richard Smith561fb152012-02-25 07:33:38 +00005935 // IsLambda bit is already saved.
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00005936
Richard Smith290d8012016-04-06 17:06:00 +00005937 Record->push_back(Data.NumBases);
Douglas Gregord4c5ed02010-10-29 22:39:52 +00005938 if (Data.NumBases > 0)
Richard Smith645d2cf2016-04-14 00:29:55 +00005939 AddCXXBaseSpecifiers(Data.bases());
5940
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00005941 // FIXME: Make VBases lazily computed when needed to avoid storing them.
Richard Smith290d8012016-04-06 17:06:00 +00005942 Record->push_back(Data.NumVBases);
Douglas Gregord4c5ed02010-10-29 22:39:52 +00005943 if (Data.NumVBases > 0)
Richard Smith645d2cf2016-04-14 00:29:55 +00005944 AddCXXBaseSpecifiers(Data.vbases());
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00005945
Richard Smith290d8012016-04-06 17:06:00 +00005946 AddUnresolvedSet(Data.Conversions.get(*Writer->Context));
5947 AddUnresolvedSet(Data.VisibleConversions.get(*Writer->Context));
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00005948 // Data.Definition is the owning decl, no need to write it.
Richard Smith290d8012016-04-06 17:06:00 +00005949 AddDeclRef(D->getFirstFriend());
Douglas Gregor99ae8062012-02-14 17:54:36 +00005950
5951 // Add lambda-specific data.
5952 if (Data.IsLambda) {
Richard Smith053f6c62014-05-16 23:01:30 +00005953 auto &Lambda = D->getLambdaData();
Richard Smith290d8012016-04-06 17:06:00 +00005954 Record->push_back(Lambda.Dependent);
5955 Record->push_back(Lambda.IsGenericLambda);
5956 Record->push_back(Lambda.CaptureDefault);
5957 Record->push_back(Lambda.NumCaptures);
5958 Record->push_back(Lambda.NumExplicitCaptures);
5959 Record->push_back(Lambda.ManglingNumber);
Richard Smith0bae6242016-08-25 00:34:00 +00005960 AddDeclRef(D->getLambdaContextDecl());
Richard Smith290d8012016-04-06 17:06:00 +00005961 AddTypeSourceInfo(Lambda.MethodTyInfo);
Douglas Gregor99ae8062012-02-14 17:54:36 +00005962 for (unsigned I = 0, N = Lambda.NumCaptures; I != N; ++I) {
Benjamin Kramerf3ca26982014-05-10 16:31:55 +00005963 const LambdaCapture &Capture = Lambda.Captures[I];
Richard Smith290d8012016-04-06 17:06:00 +00005964 AddSourceLocation(Capture.getLocation());
5965 Record->push_back(Capture.isImplicit());
5966 Record->push_back(Capture.getCaptureKind());
Richard Smithba71c082013-05-16 06:20:58 +00005967 switch (Capture.getCaptureKind()) {
Faisal Validc6b5962016-03-21 09:25:37 +00005968 case LCK_StarThis:
Richard Smithba71c082013-05-16 06:20:58 +00005969 case LCK_This:
Alexey Bataev39c81e22014-08-28 04:28:19 +00005970 case LCK_VLAType:
Richard Smithba71c082013-05-16 06:20:58 +00005971 break;
5972 case LCK_ByCopy:
Richard Smithbb13c9a2013-09-28 04:02:39 +00005973 case LCK_ByRef:
Richard Smithba71c082013-05-16 06:20:58 +00005974 VarDecl *Var =
Craig Toppera13603a2014-05-22 05:54:18 +00005975 Capture.capturesVariable() ? Capture.getCapturedVar() : nullptr;
Richard Smith290d8012016-04-06 17:06:00 +00005976 AddDeclRef(Var);
Richard Smithba71c082013-05-16 06:20:58 +00005977 AddSourceLocation(Capture.isPackExpansion() ? Capture.getEllipsisLoc()
Richard Smith290d8012016-04-06 17:06:00 +00005978 : SourceLocation());
Richard Smithba71c082013-05-16 06:20:58 +00005979 break;
5980 }
Douglas Gregor99ae8062012-02-14 17:54:36 +00005981 }
5982 }
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00005983}
5984
Argyrios Kyrtzidis65ad5692010-10-24 17:26:36 +00005985void ASTWriter::ReaderInitialized(ASTReader *Reader) {
Sebastian Redl07a89a82010-07-30 00:29:29 +00005986 assert(Reader && "Cannot remove chain");
Douglas Gregordf0c1512011-08-18 04:12:04 +00005987 assert((!Chain || Chain == Reader) && "Cannot replace chain");
Sebastian Redl07a89a82010-07-30 00:29:29 +00005988 assert(FirstDeclID == NextDeclID &&
5989 FirstTypeID == NextTypeID &&
5990 FirstIdentID == NextIdentID &&
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00005991 FirstMacroID == NextMacroID &&
Douglas Gregor253eefe2011-12-01 00:59:36 +00005992 FirstSubmoduleID == NextSubmoduleID &&
Sebastian Redld95a56e2010-08-04 18:21:41 +00005993 FirstSelectorID == NextSelectorID &&
Sebastian Redl07a89a82010-07-30 00:29:29 +00005994 "Setting chain after writing has started.");
Douglas Gregor925296b2011-07-19 16:10:42 +00005995
Sebastian Redl07a89a82010-07-30 00:29:29 +00005996 Chain = Reader;
Argyrios Kyrtzidis65ad5692010-10-24 17:26:36 +00005997
Richard Smith7f330cd2015-03-18 01:42:29 +00005998 // Note, this will get called multiple times, once one the reader starts up
5999 // and again each time it's done reading a PCH or module.
Douglas Gregordf0c1512011-08-18 04:12:04 +00006000 FirstDeclID = NUM_PREDEF_DECL_IDS + Chain->getTotalNumDecls();
6001 FirstTypeID = NUM_PREDEF_TYPE_IDS + Chain->getTotalNumTypes();
6002 FirstIdentID = NUM_PREDEF_IDENT_IDS + Chain->getTotalNumIdentifiers();
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00006003 FirstMacroID = NUM_PREDEF_MACRO_IDS + Chain->getTotalNumMacros();
Douglas Gregor253eefe2011-12-01 00:59:36 +00006004 FirstSubmoduleID = NUM_PREDEF_SUBMODULE_IDS + Chain->getTotalNumSubmodules();
Douglas Gregordf0c1512011-08-18 04:12:04 +00006005 FirstSelectorID = NUM_PREDEF_SELECTOR_IDS + Chain->getTotalNumSelectors();
Argyrios Kyrtzidis65ad5692010-10-24 17:26:36 +00006006 NextDeclID = FirstDeclID;
6007 NextTypeID = FirstTypeID;
6008 NextIdentID = FirstIdentID;
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00006009 NextMacroID = FirstMacroID;
Argyrios Kyrtzidis65ad5692010-10-24 17:26:36 +00006010 NextSelectorID = FirstSelectorID;
Douglas Gregor253eefe2011-12-01 00:59:36 +00006011 NextSubmoduleID = FirstSubmoduleID;
Sebastian Redl07a89a82010-07-30 00:29:29 +00006012}
6013
Sebastian Redl539c5062010-08-18 23:57:32 +00006014void ASTWriter::IdentifierRead(IdentID ID, IdentifierInfo *II) {
Douglas Gregor8d7edce2013-02-08 21:30:59 +00006015 // Always keep the highest ID. See \p TypeRead() for more information.
6016 IdentID &StoredID = IdentifierIDs[II];
6017 if (ID > StoredID)
6018 StoredID = ID;
Sebastian Redlff4a2952010-07-23 23:49:55 +00006019}
6020
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00006021void ASTWriter::MacroRead(serialization::MacroID ID, MacroInfo *MI) {
Douglas Gregor8d7edce2013-02-08 21:30:59 +00006022 // Always keep the highest ID. See \p TypeRead() for more information.
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00006023 MacroID &StoredID = MacroIDs[MI];
Douglas Gregor8d7edce2013-02-08 21:30:59 +00006024 if (ID > StoredID)
6025 StoredID = ID;
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00006026}
6027
Argyrios Kyrtzidisbb5c7eae2010-08-20 16:03:59 +00006028void ASTWriter::TypeRead(TypeIdx Idx, QualType T) {
Douglas Gregor9b3932c2010-10-05 18:37:06 +00006029 // Always take the highest-numbered type index. This copes with an interesting
6030 // case for chained AST writing where we schedule writing the type and then,
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00006031 // later, deserialize the type from another AST. In this case, we want to
Douglas Gregor9b3932c2010-10-05 18:37:06 +00006032 // keep the higher-numbered entry so that we can properly write it out to
6033 // the AST file.
6034 TypeIdx &StoredIdx = TypeIdxs[T];
6035 if (Idx.getIndex() >= StoredIdx.getIndex())
6036 StoredIdx = Idx;
Sebastian Redl85b2a6a2010-07-14 23:45:08 +00006037}
6038
Sebastian Redl539c5062010-08-18 23:57:32 +00006039void ASTWriter::SelectorRead(SelectorID ID, Selector S) {
Douglas Gregor8d7edce2013-02-08 21:30:59 +00006040 // Always keep the highest ID. See \p TypeRead() for more information.
6041 SelectorID &StoredID = SelectorIDs[S];
6042 if (ID > StoredID)
6043 StoredID = ID;
Sebastian Redl834bb972010-08-04 17:20:04 +00006044}
Douglas Gregor91096292010-10-02 19:29:26 +00006045
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00006046void ASTWriter::MacroDefinitionRead(serialization::PreprocessedEntityID ID,
Richard Smith66a81862015-05-04 02:25:31 +00006047 MacroDefinitionRecord *MD) {
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00006048 assert(MacroDefinitions.find(MD) == MacroDefinitions.end());
Douglas Gregor91096292010-10-02 19:29:26 +00006049 MacroDefinitions[MD] = ID;
6050}
Argyrios Kyrtzidisd170d842010-10-24 17:26:50 +00006051
Douglas Gregore37a85a2011-12-02 17:30:13 +00006052void ASTWriter::ModuleRead(serialization::SubmoduleID ID, Module *Mod) {
6053 assert(SubmoduleIDs.find(Mod) == SubmoduleIDs.end());
6054 SubmoduleIDs[Mod] = ID;
6055}
6056
Argyrios Kyrtzidisd170d842010-10-24 17:26:50 +00006057void ASTWriter::CompletedTagDefinition(const TagDecl *D) {
Vassil Vassilev19765fb2016-07-22 21:08:24 +00006058 if (Chain && Chain->isProcessingUpdateRecords()) return;
John McCallf937c022011-10-07 06:10:15 +00006059 assert(D->isCompleteDefinition());
Douglas Gregor2fd3d402011-09-17 00:05:03 +00006060 assert(!WritingAST && "Already writing the AST!");
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00006061 if (auto *RD = dyn_cast<CXXRecordDecl>(D)) {
Argyrios Kyrtzidisd170d842010-10-24 17:26:50 +00006062 // We are interested when a PCH decl is modified.
Douglas Gregorb3722e22011-09-09 23:01:35 +00006063 if (RD->isFromASTFile()) {
Argyrios Kyrtzidisd170d842010-10-24 17:26:50 +00006064 // A forward reference was mutated into a definition. Rewrite it.
6065 // FIXME: This happens during template instantiation, should we
6066 // have created a new definition decl instead ?
Richard Smithcd45dbc2014-04-19 03:48:30 +00006067 assert(isTemplateInstantiation(RD->getTemplateSpecializationKind()) &&
6068 "completed a tag from another module but not by instantiation?");
6069 DeclUpdates[RD].push_back(
6070 DeclUpdate(UPD_CXX_INSTANTIATED_CLASS_DEFINITION));
Argyrios Kyrtzidisd170d842010-10-24 17:26:50 +00006071 }
Argyrios Kyrtzidisd170d842010-10-24 17:26:50 +00006072 }
6073}
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00006074
Richard Smithf983f7f2015-10-13 00:23:25 +00006075static bool isImportedDeclContext(ASTReader *Chain, const Decl *D) {
6076 if (D->isFromASTFile())
6077 return true;
6078
Richard Smithf983f7f2015-10-13 00:23:25 +00006079 // The predefined __va_list_tag struct is imported if we imported any decls.
6080 // FIXME: This is a gross hack.
6081 return D == D->getASTContext().getVaListTagDecl();
6082}
6083
Argyrios Kyrtzidis01c2df42010-10-28 07:38:51 +00006084void ASTWriter::AddedVisibleDecl(const DeclContext *DC, const Decl *D) {
Vassil Vassilev19765fb2016-07-22 21:08:24 +00006085 if (Chain && Chain->isProcessingUpdateRecords()) return;
6086 assert(DC->isLookupContext() &&
Vassil Vassilev71eafde2016-04-06 20:56:03 +00006087 "Should not add lookup results to non-lookup contexts!");
6088
Vassil Vassilev632eac32016-03-16 11:17:04 +00006089 // TU is handled elsewhere.
6090 if (isa<TranslationUnitDecl>(DC))
6091 return;
6092
6093 // Namespaces are handled elsewhere, except for template instantiations of
6094 // FunctionTemplateDecls in namespaces. We are interested in cases where the
6095 // local instantiations are added to an imported context. Only happens when
6096 // adding ADL lookup candidates, for example templated friends.
6097 if (isa<NamespaceDecl>(DC) && D->getFriendObjectKind() == Decl::FOK_None &&
6098 !isa<FunctionTemplateDecl>(D))
Argyrios Kyrtzidis01c2df42010-10-28 07:38:51 +00006099 return;
6100
Richard Smithf983f7f2015-10-13 00:23:25 +00006101 // We're only interested in cases where a local declaration is added to an
6102 // imported context.
6103 if (D->isFromASTFile() || !isImportedDeclContext(Chain, cast<Decl>(DC)))
6104 return;
Argyrios Kyrtzidis01c2df42010-10-28 07:38:51 +00006105
Richard Smith0f4e2c42015-08-06 04:23:48 +00006106 assert(DC == DC->getPrimaryContext() && "added to non-primary context");
Douglas Gregor9f782892013-01-21 15:25:38 +00006107 assert(!getDefinitiveDeclContext(DC) && "DeclContext not definitive!");
Richard Smithe9a8bc32014-09-30 00:45:29 +00006108 assert(!WritingAST && "Already writing the AST!");
Richard Smithf983f7f2015-10-13 00:23:25 +00006109 if (UpdatedDeclContexts.insert(DC) && !cast<Decl>(DC)->isFromASTFile()) {
6110 // We're adding a visible declaration to a predefined decl context. Ensure
6111 // that we write out all of its lookup results so we don't get a nasty
6112 // surprise when we try to emit its lookup table.
6113 for (auto *Child : DC->decls())
Richard Smithc26d9742016-10-06 20:30:51 +00006114 DeclsToEmitEvenIfUnreferenced.push_back(Child);
Richard Smithf983f7f2015-10-13 00:23:25 +00006115 }
Richard Smithc26d9742016-10-06 20:30:51 +00006116 DeclsToEmitEvenIfUnreferenced.push_back(D);
Argyrios Kyrtzidis01c2df42010-10-28 07:38:51 +00006117}
Argyrios Kyrtzidise16a5302010-10-24 17:26:54 +00006118
6119void ASTWriter::AddedCXXImplicitMember(const CXXRecordDecl *RD, const Decl *D) {
Vassil Vassilev19765fb2016-07-22 21:08:24 +00006120 if (Chain && Chain->isProcessingUpdateRecords()) return;
Argyrios Kyrtzidise16a5302010-10-24 17:26:54 +00006121 assert(D->isImplicit());
Richard Smithf983f7f2015-10-13 00:23:25 +00006122
6123 // We're only interested in cases where a local declaration is added to an
6124 // imported context.
6125 if (D->isFromASTFile() || !isImportedDeclContext(Chain, RD))
6126 return;
6127
Argyrios Kyrtzidise16a5302010-10-24 17:26:54 +00006128 if (!isa<CXXMethodDecl>(D))
Richard Smithf983f7f2015-10-13 00:23:25 +00006129 return;
Argyrios Kyrtzidise16a5302010-10-24 17:26:54 +00006130
6131 // A decl coming from PCH was modified.
John McCallf937c022011-10-07 06:10:15 +00006132 assert(RD->isCompleteDefinition());
Richard Smithe9a8bc32014-09-30 00:45:29 +00006133 assert(!WritingAST && "Already writing the AST!");
Aaron Ballman4f45b712014-03-21 15:22:56 +00006134 DeclUpdates[RD].push_back(DeclUpdate(UPD_CXX_ADDED_IMPLICIT_MEMBER, D));
Argyrios Kyrtzidise16a5302010-10-24 17:26:54 +00006135}
Argyrios Kyrtzidis402dbbb2010-10-28 07:38:42 +00006136
Richard Smith564417a2014-03-20 21:47:22 +00006137void ASTWriter::ResolvedExceptionSpec(const FunctionDecl *FD) {
Vassil Vassilev19765fb2016-07-22 21:08:24 +00006138 if (Chain && Chain->isProcessingUpdateRecords()) return;
Richard Smith9e2341d2015-03-23 03:25:59 +00006139 assert(!DoneWritingDeclsAndTypes && "Already done writing updates!");
6140 if (!Chain) return;
Richard Smith5fc18a92015-07-12 23:43:21 +00006141 Chain->forEachImportedKeyDecl(FD, [&](const Decl *D) {
Richard Smith9e2341d2015-03-23 03:25:59 +00006142 // If we don't already know the exception specification for this redecl
6143 // chain, add an update record for it.
6144 if (isUnresolvedExceptionSpec(cast<FunctionDecl>(D)
6145 ->getType()
6146 ->castAs<FunctionProtoType>()
6147 ->getExceptionSpecType()))
6148 DeclUpdates[D].push_back(UPD_CXX_RESOLVED_EXCEPTION_SPEC);
6149 });
Richard Smith564417a2014-03-20 21:47:22 +00006150}
6151
Richard Smith1fa5d642013-05-11 05:45:24 +00006152void ASTWriter::DeducedReturnType(const FunctionDecl *FD, QualType ReturnType) {
Vassil Vassilev19765fb2016-07-22 21:08:24 +00006153 if (Chain && Chain->isProcessingUpdateRecords()) return;
Richard Smith1fa5d642013-05-11 05:45:24 +00006154 assert(!WritingAST && "Already writing the AST!");
Richard Smith9e2341d2015-03-23 03:25:59 +00006155 if (!Chain) return;
Richard Smith5fc18a92015-07-12 23:43:21 +00006156 Chain->forEachImportedKeyDecl(FD, [&](const Decl *D) {
Richard Smith9e2341d2015-03-23 03:25:59 +00006157 DeclUpdates[D].push_back(
6158 DeclUpdate(UPD_CXX_DEDUCED_RETURN_TYPE, ReturnType));
6159 });
Richard Smith1fa5d642013-05-11 05:45:24 +00006160}
6161
Richard Smithf8134002015-03-10 01:41:22 +00006162void ASTWriter::ResolvedOperatorDelete(const CXXDestructorDecl *DD,
6163 const FunctionDecl *Delete) {
Vassil Vassilev19765fb2016-07-22 21:08:24 +00006164 if (Chain && Chain->isProcessingUpdateRecords()) return;
Richard Smithf8134002015-03-10 01:41:22 +00006165 assert(!WritingAST && "Already writing the AST!");
6166 assert(Delete && "Not given an operator delete");
Richard Smith9e2341d2015-03-23 03:25:59 +00006167 if (!Chain) return;
Richard Smith5fc18a92015-07-12 23:43:21 +00006168 Chain->forEachImportedKeyDecl(DD, [&](const Decl *D) {
Richard Smith9e2341d2015-03-23 03:25:59 +00006169 DeclUpdates[D].push_back(DeclUpdate(UPD_CXX_RESOLVED_DTOR_DELETE, Delete));
6170 });
Richard Smithf8134002015-03-10 01:41:22 +00006171}
6172
Sebastian Redlab238a72011-04-24 16:28:06 +00006173void ASTWriter::CompletedImplicitDefinition(const FunctionDecl *D) {
Vassil Vassilev19765fb2016-07-22 21:08:24 +00006174 if (Chain && Chain->isProcessingUpdateRecords()) return;
Douglas Gregor2fd3d402011-09-17 00:05:03 +00006175 assert(!WritingAST && "Already writing the AST!");
Douglas Gregorb3722e22011-09-09 23:01:35 +00006176 if (!D->isFromASTFile())
Sebastian Redlab238a72011-04-24 16:28:06 +00006177 return; // Declaration not imported from PCH.
6178
Richard Smith4d235792014-08-07 18:53:08 +00006179 // Implicit function decl from a PCH was defined.
6180 DeclUpdates[D].push_back(DeclUpdate(UPD_CXX_ADDED_FUNCTION_DEFINITION));
Sebastian Redlab238a72011-04-24 16:28:06 +00006181}
6182
Richard Smithd28ac5b2014-03-22 23:33:22 +00006183void ASTWriter::FunctionDefinitionInstantiated(const FunctionDecl *D) {
Vassil Vassilev19765fb2016-07-22 21:08:24 +00006184 if (Chain && Chain->isProcessingUpdateRecords()) return;
Richard Smithd28ac5b2014-03-22 23:33:22 +00006185 assert(!WritingAST && "Already writing the AST!");
6186 if (!D->isFromASTFile())
6187 return;
6188
Richard Smith9e2341d2015-03-23 03:25:59 +00006189 DeclUpdates[D].push_back(DeclUpdate(UPD_CXX_ADDED_FUNCTION_DEFINITION));
Richard Smithd28ac5b2014-03-22 23:33:22 +00006190}
6191
Sebastian Redl2ac2c722011-04-29 08:19:30 +00006192void ASTWriter::StaticDataMemberInstantiated(const VarDecl *D) {
Vassil Vassilev19765fb2016-07-22 21:08:24 +00006193 if (Chain && Chain->isProcessingUpdateRecords()) return;
Douglas Gregor2fd3d402011-09-17 00:05:03 +00006194 assert(!WritingAST && "Already writing the AST!");
Douglas Gregorb3722e22011-09-09 23:01:35 +00006195 if (!D->isFromASTFile())
Sebastian Redl2ac2c722011-04-29 08:19:30 +00006196 return;
6197
6198 // Since the actual instantiation is delayed, this really means that we need
6199 // to update the instantiation location.
Richard Smith6ef42932014-03-20 21:02:00 +00006200 DeclUpdates[D].push_back(
Aaron Ballman4f45b712014-03-21 15:22:56 +00006201 DeclUpdate(UPD_CXX_INSTANTIATED_STATIC_DATA_MEMBER,
6202 D->getMemberSpecializationInfo()->getPointOfInstantiation()));
Sebastian Redl2ac2c722011-04-29 08:19:30 +00006203}
6204
John McCall32791cc2016-01-06 22:34:54 +00006205void ASTWriter::DefaultArgumentInstantiated(const ParmVarDecl *D) {
Vassil Vassilev19765fb2016-07-22 21:08:24 +00006206 if (Chain && Chain->isProcessingUpdateRecords()) return;
John McCall32791cc2016-01-06 22:34:54 +00006207 assert(!WritingAST && "Already writing the AST!");
6208 if (!D->isFromASTFile())
6209 return;
6210
6211 DeclUpdates[D].push_back(
6212 DeclUpdate(UPD_CXX_INSTANTIATED_DEFAULT_ARGUMENT, D));
6213}
6214
Richard Smith4b054b22016-08-24 21:25:37 +00006215void ASTWriter::DefaultMemberInitializerInstantiated(const FieldDecl *D) {
6216 assert(!WritingAST && "Already writing the AST!");
6217 if (!D->isFromASTFile())
6218 return;
6219
6220 DeclUpdates[D].push_back(
6221 DeclUpdate(UPD_CXX_INSTANTIATED_DEFAULT_MEMBER_INITIALIZER, D));
6222}
6223
Argyrios Kyrtzidis7d847c92011-09-01 00:58:55 +00006224void ASTWriter::AddedObjCCategoryToInterface(const ObjCCategoryDecl *CatD,
6225 const ObjCInterfaceDecl *IFD) {
Vassil Vassilev19765fb2016-07-22 21:08:24 +00006226 if (Chain && Chain->isProcessingUpdateRecords()) return;
Douglas Gregor2fd3d402011-09-17 00:05:03 +00006227 assert(!WritingAST && "Already writing the AST!");
Douglas Gregorb3722e22011-09-09 23:01:35 +00006228 if (!IFD->isFromASTFile())
Argyrios Kyrtzidis7d847c92011-09-01 00:58:55 +00006229 return; // Declaration not imported from PCH.
Douglas Gregor404cdde2012-01-27 01:47:08 +00006230
6231 assert(IFD->getDefinition() && "Category on a class without a definition?");
6232 ObjCClassesWithCategories.insert(
6233 const_cast<ObjCInterfaceDecl *>(IFD->getDefinition()));
Argyrios Kyrtzidis7d847c92011-09-01 00:58:55 +00006234}
Argyrios Kyrtzidisb97a4022011-11-12 21:07:46 +00006235
Eli Friedman276dd182013-09-05 00:02:25 +00006236void ASTWriter::DeclarationMarkedUsed(const Decl *D) {
Vassil Vassilev19765fb2016-07-22 21:08:24 +00006237 if (Chain && Chain->isProcessingUpdateRecords()) return;
Eli Friedman276dd182013-09-05 00:02:25 +00006238 assert(!WritingAST && "Already writing the AST!");
Vassil Vassilev928c8252016-04-28 14:13:28 +00006239
6240 // If there is *any* declaration of the entity that's not from an AST file,
6241 // we can skip writing the update record. We make sure that isUsed() triggers
6242 // completion of the redeclaration chain of the entity.
6243 for (auto Prev = D->getMostRecentDecl(); Prev; Prev = Prev->getPreviousDecl())
6244 if (IsLocalDecl(Prev))
6245 return;
Eli Friedman276dd182013-09-05 00:02:25 +00006246
Aaron Ballman4f45b712014-03-21 15:22:56 +00006247 DeclUpdates[D].push_back(DeclUpdate(UPD_DECL_MARKED_USED));
Eli Friedman276dd182013-09-05 00:02:25 +00006248}
Alexey Bataev97720002014-11-11 04:05:39 +00006249
6250void ASTWriter::DeclarationMarkedOpenMPThreadPrivate(const Decl *D) {
Vassil Vassilev19765fb2016-07-22 21:08:24 +00006251 if (Chain && Chain->isProcessingUpdateRecords()) return;
Alexey Bataev97720002014-11-11 04:05:39 +00006252 assert(!WritingAST && "Already writing the AST!");
6253 if (!D->isFromASTFile())
6254 return;
6255
6256 DeclUpdates[D].push_back(DeclUpdate(UPD_DECL_MARKED_OPENMP_THREADPRIVATE));
6257}
Richard Smith65ebb4a2015-03-26 04:09:53 +00006258
Dmitry Polukhind69b5052016-05-09 14:59:13 +00006259void ASTWriter::DeclarationMarkedOpenMPDeclareTarget(const Decl *D,
6260 const Attr *Attr) {
Vassil Vassilev19765fb2016-07-22 21:08:24 +00006261 if (Chain && Chain->isProcessingUpdateRecords()) return;
Dmitry Polukhin0b0da292016-04-06 11:38:59 +00006262 assert(!WritingAST && "Already writing the AST!");
6263 if (!D->isFromASTFile())
6264 return;
6265
Dmitry Polukhind69b5052016-05-09 14:59:13 +00006266 DeclUpdates[D].push_back(
6267 DeclUpdate(UPD_DECL_MARKED_OPENMP_DECLARETARGET, Attr));
Dmitry Polukhin0b0da292016-04-06 11:38:59 +00006268}
6269
Richard Smith4caa4492015-05-15 02:34:32 +00006270void ASTWriter::RedefinedHiddenDefinition(const NamedDecl *D, Module *M) {
Vassil Vassilev19765fb2016-07-22 21:08:24 +00006271 if (Chain && Chain->isProcessingUpdateRecords()) return;
Richard Smith65ebb4a2015-03-26 04:09:53 +00006272 assert(!WritingAST && "Already writing the AST!");
6273 assert(D->isHidden() && "expected a hidden declaration");
Richard Smith4caa4492015-05-15 02:34:32 +00006274 DeclUpdates[D].push_back(DeclUpdate(UPD_DECL_EXPORTED, M));
Richard Smith65ebb4a2015-03-26 04:09:53 +00006275}
Alex Denisovfde64952015-06-26 05:28:36 +00006276
6277void ASTWriter::AddedAttributeToRecord(const Attr *Attr,
6278 const RecordDecl *Record) {
Vassil Vassilev19765fb2016-07-22 21:08:24 +00006279 if (Chain && Chain->isProcessingUpdateRecords()) return;
Alex Denisovfde64952015-06-26 05:28:36 +00006280 assert(!WritingAST && "Already writing the AST!");
6281 if (!Record->isFromASTFile())
6282 return;
6283 DeclUpdates[Record].push_back(DeclUpdate(UPD_ADDED_ATTR_TO_RECORD, Attr));
6284}
Richard Smithc26d9742016-10-06 20:30:51 +00006285
6286void ASTWriter::AddedCXXTemplateSpecialization(
6287 const ClassTemplateDecl *TD, const ClassTemplateSpecializationDecl *D) {
6288 assert(!WritingAST && "Already writing the AST!");
6289
6290 if (!TD->getFirstDecl()->isFromASTFile())
6291 return;
6292 if (Chain && Chain->isProcessingUpdateRecords())
6293 return;
6294
6295 DeclsToEmitEvenIfUnreferenced.push_back(D);
6296}
6297
6298void ASTWriter::AddedCXXTemplateSpecialization(
6299 const VarTemplateDecl *TD, const VarTemplateSpecializationDecl *D) {
6300 assert(!WritingAST && "Already writing the AST!");
6301
6302 if (!TD->getFirstDecl()->isFromASTFile())
6303 return;
6304 if (Chain && Chain->isProcessingUpdateRecords())
6305 return;
6306
6307 DeclsToEmitEvenIfUnreferenced.push_back(D);
6308}
6309
6310void ASTWriter::AddedCXXTemplateSpecialization(const FunctionTemplateDecl *TD,
6311 const FunctionDecl *D) {
6312 assert(!WritingAST && "Already writing the AST!");
6313
6314 if (!TD->getFirstDecl()->isFromASTFile())
6315 return;
6316 if (Chain && Chain->isProcessingUpdateRecords())
6317 return;
6318
6319 DeclsToEmitEvenIfUnreferenced.push_back(D);
6320}