blob: f2d20ddf3a305322d12d27c3f0d64eec0ec90ecc [file] [log] [blame]
Eugene Zelenkob7d89102017-11-11 00:08:50 +00001//===- ASTWriter.cpp - AST File Writer ------------------------------------===//
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
Sebastian Redl55c0ad52010-08-18 23:56:21 +000010// This file defines the ASTWriter class, which writes AST files.
Douglas Gregoref84c4b2009-04-09 22:27:44 +000011//
12//===----------------------------------------------------------------------===//
13
Sebastian Redl1914c6f2010-08-18 23:56:37 +000014#include "clang/Serialization/ASTWriter.h"
Argyrios Kyrtzidis4bd97102010-08-20 16:03:52 +000015#include "ASTCommon.h"
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"
Eugene Zelenkob7d89102017-11-11 00:08:50 +000020#include "clang/AST/Attr.h"
Douglas Gregoref84c4b2009-04-09 22:27:44 +000021#include "clang/AST/Decl.h"
Eugene Zelenkob7d89102017-11-11 00:08:50 +000022#include "clang/AST/DeclBase.h"
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +000023#include "clang/AST/DeclCXX.h"
Duncan P. N. Exon Smith60fa2882017-03-13 18:45:08 +000024#include "clang/AST/DeclContextInternals.h"
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +000025#include "clang/AST/DeclFriend.h"
Eugene Zelenkob7d89102017-11-11 00:08:50 +000026#include "clang/AST/DeclObjC.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000027#include "clang/AST/DeclTemplate.h"
Eugene Zelenkob7d89102017-11-11 00:08:50 +000028#include "clang/AST/DeclarationName.h"
Douglas Gregorfeb84b02009-04-14 21:18:50 +000029#include "clang/AST/Expr.h"
John McCallbfd822c2010-08-24 07:32:53 +000030#include "clang/AST/ExprCXX.h"
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +000031#include "clang/AST/LambdaCapture.h"
32#include "clang/AST/NestedNameSpecifier.h"
33#include "clang/AST/RawCommentList.h"
34#include "clang/AST/TemplateName.h"
Douglas Gregoref84c4b2009-04-09 22:27:44 +000035#include "clang/AST/Type.h"
John McCall8f115c62009-10-16 21:56:05 +000036#include "clang/AST/TypeLocVisitor.h"
Eugene Zelenkob7d89102017-11-11 00:08:50 +000037#include "clang/Basic/Diagnostic.h"
Benjamin Kramerf3ca26982014-05-10 16:31:55 +000038#include "clang/Basic/DiagnosticOptions.h"
Douglas Gregora7f71a92009-04-10 03:52:48 +000039#include "clang/Basic/FileManager.h"
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +000040#include "clang/Basic/FileSystemOptions.h"
Eugene Zelenkob7d89102017-11-11 00:08:50 +000041#include "clang/Basic/IdentifierTable.h"
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +000042#include "clang/Basic/LLVM.h"
Eugene Zelenkob7d89102017-11-11 00:08:50 +000043#include "clang/Basic/Lambda.h"
Duncan P. N. Exon Smith60fa2882017-03-13 18:45:08 +000044#include "clang/Basic/LangOptions.h"
Duncan P. N. Exon Smith030d7d62017-03-20 17:58:26 +000045#include "clang/Basic/MemoryBufferCache.h"
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +000046#include "clang/Basic/Module.h"
47#include "clang/Basic/ObjCRuntime.h"
Eugene Zelenkob7d89102017-11-11 00:08:50 +000048#include "clang/Basic/OpenCLOptions.h"
49#include "clang/Basic/SourceLocation.h"
Douglas Gregora7f71a92009-04-10 03:52:48 +000050#include "clang/Basic/SourceManager.h"
Douglas Gregor4c7626e2009-04-13 16:31:14 +000051#include "clang/Basic/SourceManagerInternals.h"
Eugene Zelenkob7d89102017-11-11 00:08:50 +000052#include "clang/Basic/Specifiers.h"
Douglas Gregorbfbde532009-04-10 21:16:55 +000053#include "clang/Basic/TargetInfo.h"
Douglas Gregorcb177f12012-10-16 23:40:58 +000054#include "clang/Basic/TargetOptions.h"
Douglas Gregor7b71e632009-04-27 22:23:34 +000055#include "clang/Basic/Version.h"
Douglas Gregor20b2ebd2011-03-23 00:50:03 +000056#include "clang/Basic/VersionTuple.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000057#include "clang/Lex/HeaderSearch.h"
58#include "clang/Lex/HeaderSearchOptions.h"
59#include "clang/Lex/MacroInfo.h"
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +000060#include "clang/Lex/ModuleMap.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000061#include "clang/Lex/PreprocessingRecord.h"
62#include "clang/Lex/Preprocessor.h"
63#include "clang/Lex/PreprocessorOptions.h"
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +000064#include "clang/Lex/Token.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000065#include "clang/Sema/IdentifierResolver.h"
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +000066#include "clang/Sema/ObjCMethodList.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000067#include "clang/Sema/Sema.h"
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +000068#include "clang/Sema/Weak.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000069#include "clang/Serialization/ASTReader.h"
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +000070#include "clang/Serialization/Module.h"
Mehdi Amini9670f842016-07-18 19:02:11 +000071#include "clang/Serialization/ModuleFileExtension.h"
Richard Smithb5aaf5a2015-09-01 02:35:58 +000072#include "clang/Serialization/SerializationDiagnostic.h"
Douglas Gregore0a3a512009-04-14 21:55:33 +000073#include "llvm/ADT/APFloat.h"
74#include "llvm/ADT/APInt.h"
Eugene Zelenkob7d89102017-11-11 00:08:50 +000075#include "llvm/ADT/APSInt.h"
76#include "llvm/ADT/ArrayRef.h"
77#include "llvm/ADT/DenseMap.h"
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +000078#include "llvm/ADT/Hashing.h"
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +000079#include "llvm/ADT/Optional.h"
Eugene Zelenkob7d89102017-11-11 00:08:50 +000080#include "llvm/ADT/PointerIntPair.h"
Duncan P. N. Exon Smith60fa2882017-03-13 18:45:08 +000081#include "llvm/ADT/STLExtras.h"
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +000082#include "llvm/ADT/SmallSet.h"
83#include "llvm/ADT/SmallString.h"
Eugene Zelenkob7d89102017-11-11 00:08:50 +000084#include "llvm/ADT/SmallVector.h"
Eugene Zelenkob7d89102017-11-11 00:08:50 +000085#include "llvm/ADT/StringMap.h"
86#include "llvm/ADT/StringRef.h"
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +000087#include "llvm/Bitcode/BitCodes.h"
Douglas Gregoref84c4b2009-04-09 22:27:44 +000088#include "llvm/Bitcode/BitstreamWriter.h"
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +000089#include "llvm/Support/Casting.h"
Richard Smithaada85c2016-02-06 02:06:43 +000090#include "llvm/Support/Compression.h"
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +000091#include "llvm/Support/DJB.h"
Eugene Zelenkob7d89102017-11-11 00:08:50 +000092#include "llvm/Support/Endian.h"
Justin Bognere1c147c2014-03-28 22:03:19 +000093#include "llvm/Support/EndianStream.h"
George Rimarc39f5492017-01-17 15:45:31 +000094#include "llvm/Support/Error.h"
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +000095#include "llvm/Support/ErrorHandling.h"
Douglas Gregora7f71a92009-04-10 03:52:48 +000096#include "llvm/Support/MemoryBuffer.h"
Justin Bognerbb094f02014-04-18 19:57:06 +000097#include "llvm/Support/OnDiskHashTable.h"
Michael J. Spencer8aaf4992010-11-29 18:12:39 +000098#include "llvm/Support/Path.h"
Duncan P. N. Exon Smith60fa2882017-03-13 18:45:08 +000099#include "llvm/Support/SHA1.h"
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000100#include "llvm/Support/raw_ostream.h"
Douglas Gregor925296b2011-07-19 16:10:42 +0000101#include <algorithm>
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000102#include <cassert>
103#include <cstdint>
104#include <cstdlib>
105#include <cstring>
Eugene Zelenkob7d89102017-11-11 00:08:50 +0000106#include <ctime>
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000107#include <deque>
108#include <limits>
Eugene Zelenkob7d89102017-11-11 00:08:50 +0000109#include <memory>
110#include <queue>
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000111#include <tuple>
Douglas Gregor925296b2011-07-19 16:10:42 +0000112#include <utility>
Eugene Zelenkob7d89102017-11-11 00:08:50 +0000113#include <vector>
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +0000114
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000115using namespace clang;
Sebastian Redl539c5062010-08-18 23:57:32 +0000116using namespace clang::serialization;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000117
Sebastian Redl3df5a082010-07-30 17:03:48 +0000118template <typename T, typename Allocator>
Reid Kleckner012665e2015-05-21 00:13:09 +0000119static StringRef bytes(const std::vector<T, Allocator> &v) {
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000120 if (v.empty()) return StringRef();
121 return StringRef(reinterpret_cast<const char*>(&v[0]),
Benjamin Kramerd47a12a2011-04-24 17:44:50 +0000122 sizeof(T) * v.size());
Sebastian Redl3df5a082010-07-30 17:03:48 +0000123}
Benjamin Kramerd47a12a2011-04-24 17:44:50 +0000124
125template <typename T>
Reid Kleckner012665e2015-05-21 00:13:09 +0000126static StringRef bytes(const SmallVectorImpl<T> &v) {
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000127 return StringRef(reinterpret_cast<const char*>(v.data()),
Benjamin Kramerd47a12a2011-04-24 17:44:50 +0000128 sizeof(T) * v.size());
Sebastian Redl3df5a082010-07-30 17:03:48 +0000129}
130
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000131//===----------------------------------------------------------------------===//
132// Type serialization
133//===----------------------------------------------------------------------===//
Chris Lattner7099dbc2009-04-27 06:16:06 +0000134
Richard Smith290d8012016-04-06 17:06:00 +0000135namespace clang {
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000136
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000137 class ASTTypeWriter {
Sebastian Redl55c0ad52010-08-18 23:56:21 +0000138 ASTWriter &Writer;
Richard Smith69c82bf2016-04-01 22:52:03 +0000139 ASTRecordWriter Record;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000140
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000141 /// \brief Type code that corresponds to the record generated.
Eugene Zelenkob7d89102017-11-11 00:08:50 +0000142 TypeCode Code = static_cast<TypeCode>(0);
143
Richard Smith01b2cb42014-07-26 06:37:51 +0000144 /// \brief Abbreviation to use for the record, if any.
Eugene Zelenkob7d89102017-11-11 00:08:50 +0000145 unsigned AbbrevToUse = 0;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000146
Richard Smith290d8012016-04-06 17:06:00 +0000147 public:
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +0000148 ASTTypeWriter(ASTWriter &Writer, ASTWriter::RecordDataImpl &Record)
Eugene Zelenkob7d89102017-11-11 00:08:50 +0000149 : Writer(Writer), Record(Writer, Record) {}
Richard Smith290d8012016-04-06 17:06:00 +0000150
151 uint64_t Emit() {
152 return Record.Emit(Code, AbbrevToUse);
153 }
154
155 void Visit(QualType T) {
156 if (T.hasLocalNonFastQualifiers()) {
157 Qualifiers Qs = T.getLocalQualifiers();
158 Record.AddTypeRef(T.getLocalUnqualifiedType());
159 Record.push_back(Qs.getAsOpaqueValue());
160 Code = TYPE_EXT_QUAL;
161 AbbrevToUse = Writer.TypeExtQualAbbrev;
162 } else {
163 switch (T->getTypeClass()) {
164 // For all of the concrete, non-dependent types, call the
165 // appropriate visitor function.
166#define TYPE(Class, Base) \
167 case Type::Class: Visit##Class##Type(cast<Class##Type>(T)); break;
168#define ABSTRACT_TYPE(Class, Base)
169#include "clang/AST/TypeNodes.def"
170 }
171 }
172 }
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000173
174 void VisitArrayType(const ArrayType *T);
175 void VisitFunctionType(const FunctionType *T);
176 void VisitTagType(const TagType *T);
177
178#define TYPE(Class, Base) void Visit##Class##Type(const Class##Type *T);
179#define ABSTRACT_TYPE(Class, Base)
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000180#include "clang/AST/TypeNodes.def"
181 };
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000182
Eugene Zelenkob7d89102017-11-11 00:08:50 +0000183} // namespace clang
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000184
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000185void ASTTypeWriter::VisitBuiltinType(const BuiltinType *T) {
David Blaikie83d382b2011-09-23 05:06:16 +0000186 llvm_unreachable("Built-in types are never serialized");
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000187}
188
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000189void ASTTypeWriter::VisitComplexType(const ComplexType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000190 Record.AddTypeRef(T->getElementType());
Sebastian Redl539c5062010-08-18 23:57:32 +0000191 Code = TYPE_COMPLEX;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000192}
193
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000194void ASTTypeWriter::VisitPointerType(const PointerType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000195 Record.AddTypeRef(T->getPointeeType());
Sebastian Redl539c5062010-08-18 23:57:32 +0000196 Code = TYPE_POINTER;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000197}
198
Reid Kleckner8a365022013-06-24 17:51:48 +0000199void ASTTypeWriter::VisitDecayedType(const DecayedType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000200 Record.AddTypeRef(T->getOriginalType());
Reid Kleckner8a365022013-06-24 17:51:48 +0000201 Code = TYPE_DECAYED;
202}
203
Reid Kleckner0503a872013-12-05 01:23:43 +0000204void ASTTypeWriter::VisitAdjustedType(const AdjustedType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000205 Record.AddTypeRef(T->getOriginalType());
206 Record.AddTypeRef(T->getAdjustedType());
Reid Kleckner0503a872013-12-05 01:23:43 +0000207 Code = TYPE_ADJUSTED;
208}
209
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000210void ASTTypeWriter::VisitBlockPointerType(const BlockPointerType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000211 Record.AddTypeRef(T->getPointeeType());
Sebastian Redl539c5062010-08-18 23:57:32 +0000212 Code = TYPE_BLOCK_POINTER;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000213}
214
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000215void ASTTypeWriter::VisitLValueReferenceType(const LValueReferenceType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000216 Record.AddTypeRef(T->getPointeeTypeAsWritten());
Richard Smith0f538462011-04-12 10:38:03 +0000217 Record.push_back(T->isSpelledAsLValue());
Sebastian Redl539c5062010-08-18 23:57:32 +0000218 Code = TYPE_LVALUE_REFERENCE;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000219}
220
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000221void ASTTypeWriter::VisitRValueReferenceType(const RValueReferenceType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000222 Record.AddTypeRef(T->getPointeeTypeAsWritten());
Sebastian Redl539c5062010-08-18 23:57:32 +0000223 Code = TYPE_RVALUE_REFERENCE;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000224}
225
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000226void ASTTypeWriter::VisitMemberPointerType(const MemberPointerType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000227 Record.AddTypeRef(T->getPointeeType());
228 Record.AddTypeRef(QualType(T->getClass(), 0));
Sebastian Redl539c5062010-08-18 23:57:32 +0000229 Code = TYPE_MEMBER_POINTER;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000230}
231
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000232void ASTTypeWriter::VisitArrayType(const ArrayType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000233 Record.AddTypeRef(T->getElementType());
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000234 Record.push_back(T->getSizeModifier()); // FIXME: stable values
John McCall8ccfcb52009-09-24 19:53:00 +0000235 Record.push_back(T->getIndexTypeCVRQualifiers()); // FIXME: stable values
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000236}
237
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000238void ASTTypeWriter::VisitConstantArrayType(const ConstantArrayType *T) {
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000239 VisitArrayType(T);
Richard Smith69c82bf2016-04-01 22:52:03 +0000240 Record.AddAPInt(T->getSize());
Sebastian Redl539c5062010-08-18 23:57:32 +0000241 Code = TYPE_CONSTANT_ARRAY;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000242}
243
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000244void ASTTypeWriter::VisitIncompleteArrayType(const IncompleteArrayType *T) {
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000245 VisitArrayType(T);
Sebastian Redl539c5062010-08-18 23:57:32 +0000246 Code = TYPE_INCOMPLETE_ARRAY;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000247}
248
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000249void ASTTypeWriter::VisitVariableArrayType(const VariableArrayType *T) {
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000250 VisitArrayType(T);
Richard Smith69c82bf2016-04-01 22:52:03 +0000251 Record.AddSourceLocation(T->getLBracketLoc());
252 Record.AddSourceLocation(T->getRBracketLoc());
Richard Smith290d8012016-04-06 17:06:00 +0000253 Record.AddStmt(T->getSizeExpr());
Sebastian Redl539c5062010-08-18 23:57:32 +0000254 Code = TYPE_VARIABLE_ARRAY;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000255}
256
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000257void ASTTypeWriter::VisitVectorType(const VectorType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000258 Record.AddTypeRef(T->getElementType());
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000259 Record.push_back(T->getNumElements());
Bob Wilsonaeb56442010-11-10 21:56:12 +0000260 Record.push_back(T->getVectorKind());
Sebastian Redl539c5062010-08-18 23:57:32 +0000261 Code = TYPE_VECTOR;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000262}
263
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000264void ASTTypeWriter::VisitExtVectorType(const ExtVectorType *T) {
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000265 VisitVectorType(T);
Sebastian Redl539c5062010-08-18 23:57:32 +0000266 Code = TYPE_EXT_VECTOR;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000267}
268
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000269void ASTTypeWriter::VisitFunctionType(const FunctionType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000270 Record.AddTypeRef(T->getReturnType());
Rafael Espindolac50c27c2010-03-30 20:24:48 +0000271 FunctionType::ExtInfo C = T->getExtInfo();
272 Record.push_back(C.getNoReturn());
Eli Friedmanc5b20b52011-04-09 08:18:08 +0000273 Record.push_back(C.getHasRegParm());
Rafael Espindola49b85ab2010-03-30 22:15:11 +0000274 Record.push_back(C.getRegParm());
Douglas Gregor8c940862010-01-18 17:14:39 +0000275 // FIXME: need to stabilize encoding of calling convention...
Rafael Espindolac50c27c2010-03-30 20:24:48 +0000276 Record.push_back(C.getCC());
John McCall31168b02011-06-15 23:02:42 +0000277 Record.push_back(C.getProducesResult());
Oren Ben Simhon318a6ea2017-04-27 12:01:00 +0000278 Record.push_back(C.getNoCallerSavedRegs());
Oren Ben Simhon220671a2018-03-17 13:31:35 +0000279 Record.push_back(C.getNoCfCheck());
Richard Smith01b2cb42014-07-26 06:37:51 +0000280
281 if (C.getHasRegParm() || C.getRegParm() || C.getProducesResult())
282 AbbrevToUse = 0;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000283}
284
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000285void ASTTypeWriter::VisitFunctionNoProtoType(const FunctionNoProtoType *T) {
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000286 VisitFunctionType(T);
Sebastian Redl539c5062010-08-18 23:57:32 +0000287 Code = TYPE_FUNCTION_NO_PROTO;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000288}
289
Richard Smith290d8012016-04-06 17:06:00 +0000290static void addExceptionSpec(const FunctionProtoType *T,
291 ASTRecordWriter &Record) {
Sebastian Redlfa453cf2011-03-12 11:50:43 +0000292 Record.push_back(T->getExceptionSpecType());
293 if (T->getExceptionSpecType() == EST_Dynamic) {
294 Record.push_back(T->getNumExceptions());
295 for (unsigned I = 0, N = T->getNumExceptions(); I != N; ++I)
Richard Smith69c82bf2016-04-01 22:52:03 +0000296 Record.AddTypeRef(T->getExceptionType(I));
Sebastian Redlfa453cf2011-03-12 11:50:43 +0000297 } else if (T->getExceptionSpecType() == EST_ComputedNoexcept) {
Richard Smith290d8012016-04-06 17:06:00 +0000298 Record.AddStmt(T->getNoexceptExpr());
Richard Smith8b987a92012-04-21 17:47:47 +0000299 } else if (T->getExceptionSpecType() == EST_Uninstantiated) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000300 Record.AddDeclRef(T->getExceptionSpecDecl());
301 Record.AddDeclRef(T->getExceptionSpecTemplate());
Richard Smithd3b5c9082012-07-27 04:22:15 +0000302 } else if (T->getExceptionSpecType() == EST_Unevaluated) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000303 Record.AddDeclRef(T->getExceptionSpecDecl());
Sebastian Redlfa453cf2011-03-12 11:50:43 +0000304 }
Richard Smith564417a2014-03-20 21:47:22 +0000305}
306
307void ASTTypeWriter::VisitFunctionProtoType(const FunctionProtoType *T) {
308 VisitFunctionType(T);
Richard Smith01b2cb42014-07-26 06:37:51 +0000309
Richard Smith564417a2014-03-20 21:47:22 +0000310 Record.push_back(T->isVariadic());
311 Record.push_back(T->hasTrailingReturn());
312 Record.push_back(T->getTypeQuals());
313 Record.push_back(static_cast<unsigned>(T->getRefQualifier()));
Richard Smith290d8012016-04-06 17:06:00 +0000314 addExceptionSpec(T, Record);
Richard Smith01b2cb42014-07-26 06:37:51 +0000315
316 Record.push_back(T->getNumParams());
317 for (unsigned I = 0, N = T->getNumParams(); I != N; ++I)
Richard Smith69c82bf2016-04-01 22:52:03 +0000318 Record.AddTypeRef(T->getParamType(I));
Richard Smith01b2cb42014-07-26 06:37:51 +0000319
John McCall18afab72016-03-01 00:49:02 +0000320 if (T->hasExtParameterInfos()) {
321 for (unsigned I = 0, N = T->getNumParams(); I != N; ++I)
322 Record.push_back(T->getExtParameterInfo(I).getOpaqueValue());
323 }
324
Richard Smith01b2cb42014-07-26 06:37:51 +0000325 if (T->isVariadic() || T->hasTrailingReturn() || T->getTypeQuals() ||
John McCall18afab72016-03-01 00:49:02 +0000326 T->getRefQualifier() || T->getExceptionSpecType() != EST_None ||
327 T->hasExtParameterInfos())
Richard Smith01b2cb42014-07-26 06:37:51 +0000328 AbbrevToUse = 0;
329
Sebastian Redl539c5062010-08-18 23:57:32 +0000330 Code = TYPE_FUNCTION_PROTO;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000331}
332
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000333void ASTTypeWriter::VisitUnresolvedUsingType(const UnresolvedUsingType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000334 Record.AddDeclRef(T->getDecl());
Sebastian Redl539c5062010-08-18 23:57:32 +0000335 Code = TYPE_UNRESOLVED_USING;
John McCallb96ec562009-12-04 22:46:56 +0000336}
John McCallb96ec562009-12-04 22:46:56 +0000337
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000338void ASTTypeWriter::VisitTypedefType(const TypedefType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000339 Record.AddDeclRef(T->getDecl());
Argyrios Kyrtzidis45a83f92010-07-02 11:55:11 +0000340 assert(!T->isCanonicalUnqualified() && "Invalid typedef ?");
Richard Smith69c82bf2016-04-01 22:52:03 +0000341 Record.AddTypeRef(T->getCanonicalTypeInternal());
Sebastian Redl539c5062010-08-18 23:57:32 +0000342 Code = TYPE_TYPEDEF;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000343}
344
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000345void ASTTypeWriter::VisitTypeOfExprType(const TypeOfExprType *T) {
Richard Smith290d8012016-04-06 17:06:00 +0000346 Record.AddStmt(T->getUnderlyingExpr());
Sebastian Redl539c5062010-08-18 23:57:32 +0000347 Code = TYPE_TYPEOF_EXPR;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000348}
349
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000350void ASTTypeWriter::VisitTypeOfType(const TypeOfType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000351 Record.AddTypeRef(T->getUnderlyingType());
Sebastian Redl539c5062010-08-18 23:57:32 +0000352 Code = TYPE_TYPEOF;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000353}
354
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000355void ASTTypeWriter::VisitDecltypeType(const DecltypeType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000356 Record.AddTypeRef(T->getUnderlyingType());
Richard Smith290d8012016-04-06 17:06:00 +0000357 Record.AddStmt(T->getUnderlyingExpr());
Sebastian Redl539c5062010-08-18 23:57:32 +0000358 Code = TYPE_DECLTYPE;
Anders Carlsson81df7b82009-06-24 19:06:50 +0000359}
360
Alexis Hunte852b102011-05-24 22:41:36 +0000361void ASTTypeWriter::VisitUnaryTransformType(const UnaryTransformType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000362 Record.AddTypeRef(T->getBaseType());
363 Record.AddTypeRef(T->getUnderlyingType());
Alexis Hunte852b102011-05-24 22:41:36 +0000364 Record.push_back(T->getUTTKind());
365 Code = TYPE_UNARY_TRANSFORM;
366}
367
Richard Smith30482bc2011-02-20 03:19:35 +0000368void ASTTypeWriter::VisitAutoType(const AutoType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000369 Record.AddTypeRef(T->getDeducedType());
Richard Smithe301ba22015-11-11 02:02:15 +0000370 Record.push_back((unsigned)T->getKeyword());
Richard Smith27d807c2013-04-30 13:56:41 +0000371 if (T->getDeducedType().isNull())
372 Record.push_back(T->isDependentType());
Richard Smith30482bc2011-02-20 03:19:35 +0000373 Code = TYPE_AUTO;
374}
375
Richard Smith600b5262017-01-26 20:40:47 +0000376void ASTTypeWriter::VisitDeducedTemplateSpecializationType(
377 const DeducedTemplateSpecializationType *T) {
378 Record.AddTemplateName(T->getTemplateName());
379 Record.AddTypeRef(T->getDeducedType());
380 if (T->getDeducedType().isNull())
381 Record.push_back(T->isDependentType());
382 Code = TYPE_DEDUCED_TEMPLATE_SPECIALIZATION;
383}
384
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000385void ASTTypeWriter::VisitTagType(const TagType *T) {
Argyrios Kyrtzidisa4ed1812010-07-08 13:09:53 +0000386 Record.push_back(T->isDependentType());
Richard Smith69c82bf2016-04-01 22:52:03 +0000387 Record.AddDeclRef(T->getDecl()->getCanonicalDecl());
Mike Stump11289f42009-09-09 15:08:12 +0000388 assert(!T->isBeingDefined() &&
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000389 "Cannot serialize in the middle of a type definition");
390}
391
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000392void ASTTypeWriter::VisitRecordType(const RecordType *T) {
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000393 VisitTagType(T);
Sebastian Redl539c5062010-08-18 23:57:32 +0000394 Code = TYPE_RECORD;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000395}
396
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000397void ASTTypeWriter::VisitEnumType(const EnumType *T) {
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000398 VisitTagType(T);
Sebastian Redl539c5062010-08-18 23:57:32 +0000399 Code = TYPE_ENUM;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000400}
401
John McCall81904512011-01-06 01:58:22 +0000402void ASTTypeWriter::VisitAttributedType(const AttributedType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000403 Record.AddTypeRef(T->getModifiedType());
404 Record.AddTypeRef(T->getEquivalentType());
John McCall81904512011-01-06 01:58:22 +0000405 Record.push_back(T->getAttrKind());
406 Code = TYPE_ATTRIBUTED;
407}
408
Mike Stump11289f42009-09-09 15:08:12 +0000409void
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000410ASTTypeWriter::VisitSubstTemplateTypeParmType(
John McCallcebee162009-10-18 09:09:24 +0000411 const SubstTemplateTypeParmType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000412 Record.AddTypeRef(QualType(T->getReplacedParameter(), 0));
413 Record.AddTypeRef(T->getReplacementType());
Sebastian Redl539c5062010-08-18 23:57:32 +0000414 Code = TYPE_SUBST_TEMPLATE_TYPE_PARM;
John McCallcebee162009-10-18 09:09:24 +0000415}
416
417void
Douglas Gregorada4b792011-01-14 02:55:32 +0000418ASTTypeWriter::VisitSubstTemplateTypeParmPackType(
419 const SubstTemplateTypeParmPackType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000420 Record.AddTypeRef(QualType(T->getReplacedParameter(), 0));
421 Record.AddTemplateArgument(T->getArgumentPack());
Douglas Gregorada4b792011-01-14 02:55:32 +0000422 Code = TYPE_SUBST_TEMPLATE_TYPE_PARM_PACK;
423}
424
425void
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000426ASTTypeWriter::VisitTemplateSpecializationType(
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000427 const TemplateSpecializationType *T) {
Argyrios Kyrtzidisa4ed1812010-07-08 13:09:53 +0000428 Record.push_back(T->isDependentType());
Richard Smith69c82bf2016-04-01 22:52:03 +0000429 Record.AddTemplateName(T->getTemplateName());
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +0000430 Record.push_back(T->getNumArgs());
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +0000431 for (const auto &ArgI : *T)
Richard Smith69c82bf2016-04-01 22:52:03 +0000432 Record.AddTemplateArgument(ArgI);
433 Record.AddTypeRef(T->isTypeAlias() ? T->getAliasedType()
434 : T->isCanonicalUnqualified()
435 ? QualType()
436 : T->getCanonicalTypeInternal());
Sebastian Redl539c5062010-08-18 23:57:32 +0000437 Code = TYPE_TEMPLATE_SPECIALIZATION;
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +0000438}
439
440void
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000441ASTTypeWriter::VisitDependentSizedArrayType(const DependentSizedArrayType *T) {
Argyrios Kyrtzidis4a57bd02010-06-30 08:49:25 +0000442 VisitArrayType(T);
Richard Smith290d8012016-04-06 17:06:00 +0000443 Record.AddStmt(T->getSizeExpr());
Richard Smith69c82bf2016-04-01 22:52:03 +0000444 Record.AddSourceRange(T->getBracketsRange());
Sebastian Redl539c5062010-08-18 23:57:32 +0000445 Code = TYPE_DEPENDENT_SIZED_ARRAY;
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +0000446}
447
448void
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000449ASTTypeWriter::VisitDependentSizedExtVectorType(
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +0000450 const DependentSizedExtVectorType *T) {
Alex Lorenz00aee432017-03-22 10:04:48 +0000451 Record.AddTypeRef(T->getElementType());
452 Record.AddStmt(T->getSizeExpr());
453 Record.AddSourceLocation(T->getAttributeLoc());
454 Code = TYPE_DEPENDENT_SIZED_EXT_VECTOR;
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +0000455}
456
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +0000457void
Andrew Gozillon572bbb02017-10-02 06:25:51 +0000458ASTTypeWriter::VisitDependentAddressSpaceType(
459 const DependentAddressSpaceType *T) {
460 Record.AddTypeRef(T->getPointeeType());
461 Record.AddStmt(T->getAddrSpaceExpr());
462 Record.AddSourceLocation(T->getAttributeLoc());
463 Code = TYPE_DEPENDENT_ADDRESS_SPACE;
464}
465
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +0000466void
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000467ASTTypeWriter::VisitTemplateTypeParmType(const TemplateTypeParmType *T) {
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +0000468 Record.push_back(T->getDepth());
469 Record.push_back(T->getIndex());
470 Record.push_back(T->isParameterPack());
Richard Smith69c82bf2016-04-01 22:52:03 +0000471 Record.AddDeclRef(T->getDecl());
Sebastian Redl539c5062010-08-18 23:57:32 +0000472 Code = TYPE_TEMPLATE_TYPE_PARM;
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +0000473}
474
475void
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000476ASTTypeWriter::VisitDependentNameType(const DependentNameType *T) {
Argyrios Kyrtzidisbfcacee2010-06-24 08:57:31 +0000477 Record.push_back(T->getKeyword());
Richard Smith69c82bf2016-04-01 22:52:03 +0000478 Record.AddNestedNameSpecifier(T->getQualifier());
479 Record.AddIdentifierRef(T->getIdentifier());
480 Record.AddTypeRef(
481 T->isCanonicalUnqualified() ? QualType() : T->getCanonicalTypeInternal());
Sebastian Redl539c5062010-08-18 23:57:32 +0000482 Code = TYPE_DEPENDENT_NAME;
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +0000483}
484
485void
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000486ASTTypeWriter::VisitDependentTemplateSpecializationType(
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +0000487 const DependentTemplateSpecializationType *T) {
Argyrios Kyrtzidisf0f7a792010-06-25 16:24:58 +0000488 Record.push_back(T->getKeyword());
Richard Smith69c82bf2016-04-01 22:52:03 +0000489 Record.AddNestedNameSpecifier(T->getQualifier());
490 Record.AddIdentifierRef(T->getIdentifier());
Argyrios Kyrtzidisf0f7a792010-06-25 16:24:58 +0000491 Record.push_back(T->getNumArgs());
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +0000492 for (const auto &I : *T)
Richard Smith69c82bf2016-04-01 22:52:03 +0000493 Record.AddTemplateArgument(I);
Sebastian Redl539c5062010-08-18 23:57:32 +0000494 Code = TYPE_DEPENDENT_TEMPLATE_SPECIALIZATION;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000495}
496
Douglas Gregord2fa7662010-12-20 02:24:11 +0000497void ASTTypeWriter::VisitPackExpansionType(const PackExpansionType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000498 Record.AddTypeRef(T->getPattern());
David Blaikie05785d12013-02-20 22:23:23 +0000499 if (Optional<unsigned> NumExpansions = T->getNumExpansions())
Douglas Gregor0dca5fd2011-01-14 17:04:44 +0000500 Record.push_back(*NumExpansions + 1);
501 else
502 Record.push_back(0);
Douglas Gregord2fa7662010-12-20 02:24:11 +0000503 Code = TYPE_PACK_EXPANSION;
504}
505
Abramo Bagnara924a8f32010-12-10 16:29:40 +0000506void ASTTypeWriter::VisitParenType(const ParenType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000507 Record.AddTypeRef(T->getInnerType());
Abramo Bagnara924a8f32010-12-10 16:29:40 +0000508 Code = TYPE_PAREN;
509}
510
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000511void ASTTypeWriter::VisitElaboratedType(const ElaboratedType *T) {
Abramo Bagnara6150c882010-05-11 21:36:43 +0000512 Record.push_back(T->getKeyword());
Richard Smith69c82bf2016-04-01 22:52:03 +0000513 Record.AddNestedNameSpecifier(T->getQualifier());
514 Record.AddTypeRef(T->getNamedType());
Sebastian Redl539c5062010-08-18 23:57:32 +0000515 Code = TYPE_ELABORATED;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000516}
517
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000518void ASTTypeWriter::VisitInjectedClassNameType(const InjectedClassNameType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000519 Record.AddDeclRef(T->getDecl()->getCanonicalDecl());
520 Record.AddTypeRef(T->getInjectedSpecializationType());
Sebastian Redl539c5062010-08-18 23:57:32 +0000521 Code = TYPE_INJECTED_CLASS_NAME;
John McCalle78aac42010-03-10 03:28:59 +0000522}
523
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000524void ASTTypeWriter::VisitObjCInterfaceType(const ObjCInterfaceType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000525 Record.AddDeclRef(T->getDecl()->getCanonicalDecl());
Sebastian Redl539c5062010-08-18 23:57:32 +0000526 Code = TYPE_OBJC_INTERFACE;
John McCall8b07ec22010-05-15 11:32:37 +0000527}
528
Manman Rene6be26c2016-09-13 17:25:08 +0000529void ASTTypeWriter::VisitObjCTypeParamType(const ObjCTypeParamType *T) {
530 Record.AddDeclRef(T->getDecl());
531 Record.push_back(T->getNumProtocols());
532 for (const auto *I : T->quals())
533 Record.AddDeclRef(I);
534 Code = TYPE_OBJC_TYPE_PARAM;
535}
536
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000537void ASTTypeWriter::VisitObjCObjectType(const ObjCObjectType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000538 Record.AddTypeRef(T->getBaseType());
Douglas Gregore83b9562015-07-07 03:57:53 +0000539 Record.push_back(T->getTypeArgsAsWritten().size());
540 for (auto TypeArg : T->getTypeArgsAsWritten())
Richard Smith69c82bf2016-04-01 22:52:03 +0000541 Record.AddTypeRef(TypeArg);
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000542 Record.push_back(T->getNumProtocols());
Aaron Ballman1683f7b2014-03-17 15:55:30 +0000543 for (const auto *I : T->quals())
Richard Smith69c82bf2016-04-01 22:52:03 +0000544 Record.AddDeclRef(I);
Douglas Gregorab209d82015-07-07 03:58:42 +0000545 Record.push_back(T->isKindOfTypeAsWritten());
Sebastian Redl539c5062010-08-18 23:57:32 +0000546 Code = TYPE_OBJC_OBJECT;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000547}
548
Steve Narofffb4330f2009-06-17 22:40:22 +0000549void
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000550ASTTypeWriter::VisitObjCObjectPointerType(const ObjCObjectPointerType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000551 Record.AddTypeRef(T->getPointeeType());
Sebastian Redl539c5062010-08-18 23:57:32 +0000552 Code = TYPE_OBJC_OBJECT_POINTER;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000553}
554
Eli Friedman0dfb8892011-10-06 23:00:33 +0000555void
556ASTTypeWriter::VisitAtomicType(const AtomicType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000557 Record.AddTypeRef(T->getValueType());
Eli Friedman0dfb8892011-10-06 23:00:33 +0000558 Code = TYPE_ATOMIC;
559}
560
Xiuli Pan9c14e282016-01-09 12:53:17 +0000561void
562ASTTypeWriter::VisitPipeType(const PipeType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000563 Record.AddTypeRef(T->getElementType());
Joey Goulye3c85de2016-12-01 11:30:49 +0000564 Record.push_back(T->isReadOnly());
565 Code = TYPE_PIPE;
Xiuli Pan9c14e282016-01-09 12:53:17 +0000566}
567
John McCall8f115c62009-10-16 21:56:05 +0000568namespace {
569
570class TypeLocWriter : public TypeLocVisitor<TypeLocWriter> {
Richard Smith290d8012016-04-06 17:06:00 +0000571 ASTRecordWriter &Record;
John McCall8f115c62009-10-16 21:56:05 +0000572
573public:
Eugene Zelenkob7d89102017-11-11 00:08:50 +0000574 TypeLocWriter(ASTRecordWriter &Record) : Record(Record) {}
John McCall8f115c62009-10-16 21:56:05 +0000575
John McCall17001972009-10-18 01:05:36 +0000576#define ABSTRACT_TYPELOC(CLASS, PARENT)
John McCall8f115c62009-10-16 21:56:05 +0000577#define TYPELOC(CLASS, PARENT) \
John McCall17001972009-10-18 01:05:36 +0000578 void Visit##CLASS##TypeLoc(CLASS##TypeLoc TyLoc);
John McCall8f115c62009-10-16 21:56:05 +0000579#include "clang/AST/TypeLocNodes.def"
580
John McCall17001972009-10-18 01:05:36 +0000581 void VisitArrayTypeLoc(ArrayTypeLoc TyLoc);
582 void VisitFunctionTypeLoc(FunctionTypeLoc TyLoc);
John McCall8f115c62009-10-16 21:56:05 +0000583};
584
Eugene Zelenkob7d89102017-11-11 00:08:50 +0000585} // namespace
John McCall8f115c62009-10-16 21:56:05 +0000586
John McCall17001972009-10-18 01:05:36 +0000587void TypeLocWriter::VisitQualifiedTypeLoc(QualifiedTypeLoc TL) {
588 // nothing to do
John McCall8f115c62009-10-16 21:56:05 +0000589}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000590
John McCall17001972009-10-18 01:05:36 +0000591void TypeLocWriter::VisitBuiltinTypeLoc(BuiltinTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000592 Record.AddSourceLocation(TL.getBuiltinLoc());
Douglas Gregorc9b7a592010-01-18 18:04:31 +0000593 if (TL.needsExtraLocalData()) {
Faisal Vali090da2d2018-01-01 18:23:28 +0000594 Record.push_back(TL.getWrittenTypeSpec());
595 Record.push_back(TL.getWrittenSignSpec());
596 Record.push_back(TL.getWrittenWidthSpec());
Douglas Gregorc9b7a592010-01-18 18:04:31 +0000597 Record.push_back(TL.hasModeAttr());
598 }
John McCall8f115c62009-10-16 21:56:05 +0000599}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000600
John McCall17001972009-10-18 01:05:36 +0000601void TypeLocWriter::VisitComplexTypeLoc(ComplexTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000602 Record.AddSourceLocation(TL.getNameLoc());
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::VisitPointerTypeLoc(PointerTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000606 Record.AddSourceLocation(TL.getStarLoc());
John McCall8f115c62009-10-16 21:56:05 +0000607}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000608
Reid Kleckner8a365022013-06-24 17:51:48 +0000609void TypeLocWriter::VisitDecayedTypeLoc(DecayedTypeLoc TL) {
610 // nothing to do
611}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000612
Reid Kleckner0503a872013-12-05 01:23:43 +0000613void TypeLocWriter::VisitAdjustedTypeLoc(AdjustedTypeLoc TL) {
614 // nothing to do
615}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000616
John McCall17001972009-10-18 01:05:36 +0000617void TypeLocWriter::VisitBlockPointerTypeLoc(BlockPointerTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000618 Record.AddSourceLocation(TL.getCaretLoc());
John McCall8f115c62009-10-16 21:56:05 +0000619}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000620
John McCall17001972009-10-18 01:05:36 +0000621void TypeLocWriter::VisitLValueReferenceTypeLoc(LValueReferenceTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000622 Record.AddSourceLocation(TL.getAmpLoc());
John McCall8f115c62009-10-16 21:56:05 +0000623}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000624
John McCall17001972009-10-18 01:05:36 +0000625void TypeLocWriter::VisitRValueReferenceTypeLoc(RValueReferenceTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000626 Record.AddSourceLocation(TL.getAmpAmpLoc());
John McCall8f115c62009-10-16 21:56:05 +0000627}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000628
John McCall17001972009-10-18 01:05:36 +0000629void TypeLocWriter::VisitMemberPointerTypeLoc(MemberPointerTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000630 Record.AddSourceLocation(TL.getStarLoc());
631 Record.AddTypeSourceInfo(TL.getClassTInfo());
John McCall8f115c62009-10-16 21:56:05 +0000632}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000633
John McCall17001972009-10-18 01:05:36 +0000634void TypeLocWriter::VisitArrayTypeLoc(ArrayTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000635 Record.AddSourceLocation(TL.getLBracketLoc());
636 Record.AddSourceLocation(TL.getRBracketLoc());
John McCall17001972009-10-18 01:05:36 +0000637 Record.push_back(TL.getSizeExpr() ? 1 : 0);
638 if (TL.getSizeExpr())
Richard Smith290d8012016-04-06 17:06:00 +0000639 Record.AddStmt(TL.getSizeExpr());
John McCall8f115c62009-10-16 21:56:05 +0000640}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000641
John McCall17001972009-10-18 01:05:36 +0000642void TypeLocWriter::VisitConstantArrayTypeLoc(ConstantArrayTypeLoc TL) {
643 VisitArrayTypeLoc(TL);
644}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000645
John McCall17001972009-10-18 01:05:36 +0000646void TypeLocWriter::VisitIncompleteArrayTypeLoc(IncompleteArrayTypeLoc TL) {
647 VisitArrayTypeLoc(TL);
648}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000649
John McCall17001972009-10-18 01:05:36 +0000650void TypeLocWriter::VisitVariableArrayTypeLoc(VariableArrayTypeLoc TL) {
651 VisitArrayTypeLoc(TL);
652}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000653
John McCall17001972009-10-18 01:05:36 +0000654void TypeLocWriter::VisitDependentSizedArrayTypeLoc(
655 DependentSizedArrayTypeLoc TL) {
656 VisitArrayTypeLoc(TL);
657}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000658
Andrew Gozillon572bbb02017-10-02 06:25:51 +0000659void TypeLocWriter::VisitDependentAddressSpaceTypeLoc(
660 DependentAddressSpaceTypeLoc TL) {
661 Record.AddSourceLocation(TL.getAttrNameLoc());
662 SourceRange range = TL.getAttrOperandParensRange();
663 Record.AddSourceLocation(range.getBegin());
664 Record.AddSourceLocation(range.getEnd());
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +0000665 Record.AddStmt(TL.getAttrExprOperand());
Andrew Gozillon572bbb02017-10-02 06:25:51 +0000666}
667
John McCall17001972009-10-18 01:05:36 +0000668void TypeLocWriter::VisitDependentSizedExtVectorTypeLoc(
669 DependentSizedExtVectorTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000670 Record.AddSourceLocation(TL.getNameLoc());
John McCall17001972009-10-18 01:05:36 +0000671}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000672
John McCall17001972009-10-18 01:05:36 +0000673void TypeLocWriter::VisitVectorTypeLoc(VectorTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000674 Record.AddSourceLocation(TL.getNameLoc());
John McCall17001972009-10-18 01:05:36 +0000675}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000676
John McCall17001972009-10-18 01:05:36 +0000677void TypeLocWriter::VisitExtVectorTypeLoc(ExtVectorTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000678 Record.AddSourceLocation(TL.getNameLoc());
John McCall17001972009-10-18 01:05:36 +0000679}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000680
John McCall17001972009-10-18 01:05:36 +0000681void TypeLocWriter::VisitFunctionTypeLoc(FunctionTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000682 Record.AddSourceLocation(TL.getLocalRangeBegin());
683 Record.AddSourceLocation(TL.getLParenLoc());
684 Record.AddSourceLocation(TL.getRParenLoc());
Malcolm Parsonsa3220ce2017-01-12 16:11:28 +0000685 Record.AddSourceRange(TL.getExceptionSpecRange());
Richard Smith69c82bf2016-04-01 22:52:03 +0000686 Record.AddSourceLocation(TL.getLocalRangeEnd());
Alp Tokerb3fd5cf2014-01-21 00:32:38 +0000687 for (unsigned i = 0, e = TL.getNumParams(); i != e; ++i)
Richard Smith69c82bf2016-04-01 22:52:03 +0000688 Record.AddDeclRef(TL.getParam(i));
John McCall17001972009-10-18 01:05:36 +0000689}
Eugene Zelenkob7d89102017-11-11 00:08:50 +0000690
John McCall17001972009-10-18 01:05:36 +0000691void TypeLocWriter::VisitFunctionProtoTypeLoc(FunctionProtoTypeLoc TL) {
692 VisitFunctionTypeLoc(TL);
693}
Eugene Zelenkob7d89102017-11-11 00:08:50 +0000694
John McCall17001972009-10-18 01:05:36 +0000695void TypeLocWriter::VisitFunctionNoProtoTypeLoc(FunctionNoProtoTypeLoc TL) {
696 VisitFunctionTypeLoc(TL);
697}
Eugene Zelenkob7d89102017-11-11 00:08:50 +0000698
John McCallb96ec562009-12-04 22:46:56 +0000699void TypeLocWriter::VisitUnresolvedUsingTypeLoc(UnresolvedUsingTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000700 Record.AddSourceLocation(TL.getNameLoc());
John McCallb96ec562009-12-04 22:46:56 +0000701}
Eugene Zelenkob7d89102017-11-11 00:08:50 +0000702
John McCall17001972009-10-18 01:05:36 +0000703void TypeLocWriter::VisitTypedefTypeLoc(TypedefTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000704 Record.AddSourceLocation(TL.getNameLoc());
John McCall17001972009-10-18 01:05:36 +0000705}
Eugene Zelenkob7d89102017-11-11 00:08:50 +0000706
Manman Rene6be26c2016-09-13 17:25:08 +0000707void TypeLocWriter::VisitObjCTypeParamTypeLoc(ObjCTypeParamTypeLoc TL) {
708 if (TL.getNumProtocols()) {
709 Record.AddSourceLocation(TL.getProtocolLAngleLoc());
710 Record.AddSourceLocation(TL.getProtocolRAngleLoc());
711 }
712 for (unsigned i = 0, e = TL.getNumProtocols(); i != e; ++i)
713 Record.AddSourceLocation(TL.getProtocolLoc(i));
714}
Eugene Zelenkob7d89102017-11-11 00:08:50 +0000715
John McCall17001972009-10-18 01:05:36 +0000716void TypeLocWriter::VisitTypeOfExprTypeLoc(TypeOfExprTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000717 Record.AddSourceLocation(TL.getTypeofLoc());
718 Record.AddSourceLocation(TL.getLParenLoc());
719 Record.AddSourceLocation(TL.getRParenLoc());
John McCall17001972009-10-18 01:05:36 +0000720}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000721
John McCall17001972009-10-18 01:05:36 +0000722void TypeLocWriter::VisitTypeOfTypeLoc(TypeOfTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000723 Record.AddSourceLocation(TL.getTypeofLoc());
724 Record.AddSourceLocation(TL.getLParenLoc());
725 Record.AddSourceLocation(TL.getRParenLoc());
726 Record.AddTypeSourceInfo(TL.getUnderlyingTInfo());
John McCall17001972009-10-18 01:05:36 +0000727}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000728
John McCall17001972009-10-18 01:05:36 +0000729void TypeLocWriter::VisitDecltypeTypeLoc(DecltypeTypeLoc 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
Alexis Hunte852b102011-05-24 22:41:36 +0000733void TypeLocWriter::VisitUnaryTransformTypeLoc(UnaryTransformTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000734 Record.AddSourceLocation(TL.getKWLoc());
735 Record.AddSourceLocation(TL.getLParenLoc());
736 Record.AddSourceLocation(TL.getRParenLoc());
737 Record.AddTypeSourceInfo(TL.getUnderlyingTInfo());
Alexis Hunte852b102011-05-24 22:41:36 +0000738}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000739
Richard Smith30482bc2011-02-20 03:19:35 +0000740void TypeLocWriter::VisitAutoTypeLoc(AutoTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000741 Record.AddSourceLocation(TL.getNameLoc());
Richard Smith30482bc2011-02-20 03:19:35 +0000742}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000743
Richard Smith600b5262017-01-26 20:40:47 +0000744void TypeLocWriter::VisitDeducedTemplateSpecializationTypeLoc(
745 DeducedTemplateSpecializationTypeLoc TL) {
746 Record.AddSourceLocation(TL.getTemplateNameLoc());
747}
748
John McCall17001972009-10-18 01:05:36 +0000749void TypeLocWriter::VisitRecordTypeLoc(RecordTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000750 Record.AddSourceLocation(TL.getNameLoc());
John McCall17001972009-10-18 01:05:36 +0000751}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000752
John McCall17001972009-10-18 01:05:36 +0000753void TypeLocWriter::VisitEnumTypeLoc(EnumTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000754 Record.AddSourceLocation(TL.getNameLoc());
John McCall17001972009-10-18 01:05:36 +0000755}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000756
John McCall81904512011-01-06 01:58:22 +0000757void TypeLocWriter::VisitAttributedTypeLoc(AttributedTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000758 Record.AddSourceLocation(TL.getAttrNameLoc());
John McCall81904512011-01-06 01:58:22 +0000759 if (TL.hasAttrOperand()) {
760 SourceRange range = TL.getAttrOperandParensRange();
Richard Smith69c82bf2016-04-01 22:52:03 +0000761 Record.AddSourceLocation(range.getBegin());
762 Record.AddSourceLocation(range.getEnd());
John McCall81904512011-01-06 01:58:22 +0000763 }
764 if (TL.hasAttrExprOperand()) {
765 Expr *operand = TL.getAttrExprOperand();
766 Record.push_back(operand ? 1 : 0);
Richard Smith290d8012016-04-06 17:06:00 +0000767 if (operand) Record.AddStmt(operand);
John McCall81904512011-01-06 01:58:22 +0000768 } else if (TL.hasAttrEnumOperand()) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000769 Record.AddSourceLocation(TL.getAttrEnumOperandLoc());
John McCall81904512011-01-06 01:58:22 +0000770 }
771}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000772
John McCall17001972009-10-18 01:05:36 +0000773void TypeLocWriter::VisitTemplateTypeParmTypeLoc(TemplateTypeParmTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000774 Record.AddSourceLocation(TL.getNameLoc());
John McCall17001972009-10-18 01:05:36 +0000775}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000776
John McCallcebee162009-10-18 09:09:24 +0000777void TypeLocWriter::VisitSubstTemplateTypeParmTypeLoc(
778 SubstTemplateTypeParmTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000779 Record.AddSourceLocation(TL.getNameLoc());
John McCallcebee162009-10-18 09:09:24 +0000780}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000781
Douglas Gregorada4b792011-01-14 02:55:32 +0000782void TypeLocWriter::VisitSubstTemplateTypeParmPackTypeLoc(
783 SubstTemplateTypeParmPackTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000784 Record.AddSourceLocation(TL.getNameLoc());
Douglas Gregorada4b792011-01-14 02:55:32 +0000785}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000786
John McCall17001972009-10-18 01:05:36 +0000787void TypeLocWriter::VisitTemplateSpecializationTypeLoc(
788 TemplateSpecializationTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000789 Record.AddSourceLocation(TL.getTemplateKeywordLoc());
790 Record.AddSourceLocation(TL.getTemplateNameLoc());
791 Record.AddSourceLocation(TL.getLAngleLoc());
792 Record.AddSourceLocation(TL.getRAngleLoc());
John McCall0ad16662009-10-29 08:12:44 +0000793 for (unsigned i = 0, e = TL.getNumArgs(); i != e; ++i)
Richard Smith69c82bf2016-04-01 22:52:03 +0000794 Record.AddTemplateArgumentLocInfo(TL.getArgLoc(i).getArgument().getKind(),
795 TL.getArgLoc(i).getLocInfo());
John McCall17001972009-10-18 01:05:36 +0000796}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000797
Abramo Bagnara924a8f32010-12-10 16:29:40 +0000798void TypeLocWriter::VisitParenTypeLoc(ParenTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000799 Record.AddSourceLocation(TL.getLParenLoc());
800 Record.AddSourceLocation(TL.getRParenLoc());
Abramo Bagnara924a8f32010-12-10 16:29:40 +0000801}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000802
Abramo Bagnara6150c882010-05-11 21:36:43 +0000803void TypeLocWriter::VisitElaboratedTypeLoc(ElaboratedTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000804 Record.AddSourceLocation(TL.getElaboratedKeywordLoc());
805 Record.AddNestedNameSpecifierLoc(TL.getQualifierLoc());
John McCall17001972009-10-18 01:05:36 +0000806}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000807
John McCalle78aac42010-03-10 03:28:59 +0000808void TypeLocWriter::VisitInjectedClassNameTypeLoc(InjectedClassNameTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000809 Record.AddSourceLocation(TL.getNameLoc());
John McCalle78aac42010-03-10 03:28:59 +0000810}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000811
Douglas Gregorc1d2d8a2010-03-31 17:34:00 +0000812void TypeLocWriter::VisitDependentNameTypeLoc(DependentNameTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000813 Record.AddSourceLocation(TL.getElaboratedKeywordLoc());
814 Record.AddNestedNameSpecifierLoc(TL.getQualifierLoc());
815 Record.AddSourceLocation(TL.getNameLoc());
John McCall17001972009-10-18 01:05:36 +0000816}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000817
John McCallc392f372010-06-11 00:33:02 +0000818void TypeLocWriter::VisitDependentTemplateSpecializationTypeLoc(
819 DependentTemplateSpecializationTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000820 Record.AddSourceLocation(TL.getElaboratedKeywordLoc());
821 Record.AddNestedNameSpecifierLoc(TL.getQualifierLoc());
822 Record.AddSourceLocation(TL.getTemplateKeywordLoc());
823 Record.AddSourceLocation(TL.getTemplateNameLoc());
824 Record.AddSourceLocation(TL.getLAngleLoc());
825 Record.AddSourceLocation(TL.getRAngleLoc());
John McCallc392f372010-06-11 00:33:02 +0000826 for (unsigned I = 0, E = TL.getNumArgs(); I != E; ++I)
Richard Smith69c82bf2016-04-01 22:52:03 +0000827 Record.AddTemplateArgumentLocInfo(TL.getArgLoc(I).getArgument().getKind(),
828 TL.getArgLoc(I).getLocInfo());
John McCallc392f372010-06-11 00:33:02 +0000829}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000830
Douglas Gregord2fa7662010-12-20 02:24:11 +0000831void TypeLocWriter::VisitPackExpansionTypeLoc(PackExpansionTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000832 Record.AddSourceLocation(TL.getEllipsisLoc());
Douglas Gregord2fa7662010-12-20 02:24:11 +0000833}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000834
John McCall17001972009-10-18 01:05:36 +0000835void TypeLocWriter::VisitObjCInterfaceTypeLoc(ObjCInterfaceTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000836 Record.AddSourceLocation(TL.getNameLoc());
John McCall8b07ec22010-05-15 11:32:37 +0000837}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000838
John McCall8b07ec22010-05-15 11:32:37 +0000839void TypeLocWriter::VisitObjCObjectTypeLoc(ObjCObjectTypeLoc TL) {
840 Record.push_back(TL.hasBaseTypeAsWritten());
Richard Smith69c82bf2016-04-01 22:52:03 +0000841 Record.AddSourceLocation(TL.getTypeArgsLAngleLoc());
842 Record.AddSourceLocation(TL.getTypeArgsRAngleLoc());
Douglas Gregore9d95f12015-07-07 03:57:35 +0000843 for (unsigned i = 0, e = TL.getNumTypeArgs(); i != e; ++i)
Richard Smith69c82bf2016-04-01 22:52:03 +0000844 Record.AddTypeSourceInfo(TL.getTypeArgTInfo(i));
845 Record.AddSourceLocation(TL.getProtocolLAngleLoc());
846 Record.AddSourceLocation(TL.getProtocolRAngleLoc());
John McCall17001972009-10-18 01:05:36 +0000847 for (unsigned i = 0, e = TL.getNumProtocols(); i != e; ++i)
Richard Smith69c82bf2016-04-01 22:52:03 +0000848 Record.AddSourceLocation(TL.getProtocolLoc(i));
John McCall8f115c62009-10-16 21:56:05 +0000849}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000850
John McCallfc93cf92009-10-22 22:37:11 +0000851void TypeLocWriter::VisitObjCObjectPointerTypeLoc(ObjCObjectPointerTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000852 Record.AddSourceLocation(TL.getStarLoc());
John McCallfc93cf92009-10-22 22:37:11 +0000853}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000854
Eli Friedman0dfb8892011-10-06 23:00:33 +0000855void TypeLocWriter::VisitAtomicTypeLoc(AtomicTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000856 Record.AddSourceLocation(TL.getKWLoc());
857 Record.AddSourceLocation(TL.getLParenLoc());
858 Record.AddSourceLocation(TL.getRParenLoc());
Eli Friedman0dfb8892011-10-06 23:00:33 +0000859}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000860
Xiuli Pan9c14e282016-01-09 12:53:17 +0000861void TypeLocWriter::VisitPipeTypeLoc(PipeTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000862 Record.AddSourceLocation(TL.getKWLoc());
Xiuli Pan9c14e282016-01-09 12:53:17 +0000863}
John McCall8f115c62009-10-16 21:56:05 +0000864
Richard Smith01b2cb42014-07-26 06:37:51 +0000865void ASTWriter::WriteTypeAbbrevs() {
866 using namespace llvm;
867
David Blaikieb44f0bf2017-01-04 22:36:43 +0000868 std::shared_ptr<BitCodeAbbrev> Abv;
Richard Smith01b2cb42014-07-26 06:37:51 +0000869
870 // Abbreviation for TYPE_EXT_QUAL
David Blaikieb44f0bf2017-01-04 22:36:43 +0000871 Abv = std::make_shared<BitCodeAbbrev>();
Richard Smith01b2cb42014-07-26 06:37:51 +0000872 Abv->Add(BitCodeAbbrevOp(serialization::TYPE_EXT_QUAL));
873 Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Type
874 Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 3)); // Quals
David Blaikieb44f0bf2017-01-04 22:36:43 +0000875 TypeExtQualAbbrev = Stream.EmitAbbrev(std::move(Abv));
Richard Smith01b2cb42014-07-26 06:37:51 +0000876
877 // Abbreviation for TYPE_FUNCTION_PROTO
David Blaikieb44f0bf2017-01-04 22:36:43 +0000878 Abv = std::make_shared<BitCodeAbbrev>();
Richard Smith01b2cb42014-07-26 06:37:51 +0000879 Abv->Add(BitCodeAbbrevOp(serialization::TYPE_FUNCTION_PROTO));
880 // FunctionType
881 Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // ReturnType
882 Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // NoReturn
883 Abv->Add(BitCodeAbbrevOp(0)); // HasRegParm
884 Abv->Add(BitCodeAbbrevOp(0)); // RegParm
885 Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 4)); // CC
886 Abv->Add(BitCodeAbbrevOp(0)); // ProducesResult
Oren Ben Simhon318a6ea2017-04-27 12:01:00 +0000887 Abv->Add(BitCodeAbbrevOp(0)); // NoCallerSavedRegs
Oren Ben Simhon220671a2018-03-17 13:31:35 +0000888 Abv->Add(BitCodeAbbrevOp(0)); // NoCfCheck
Richard Smith01b2cb42014-07-26 06:37:51 +0000889 // FunctionProtoType
890 Abv->Add(BitCodeAbbrevOp(0)); // IsVariadic
891 Abv->Add(BitCodeAbbrevOp(0)); // HasTrailingReturn
892 Abv->Add(BitCodeAbbrevOp(0)); // TypeQuals
893 Abv->Add(BitCodeAbbrevOp(0)); // RefQualifier
894 Abv->Add(BitCodeAbbrevOp(EST_None)); // ExceptionSpec
895 Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // NumParams
896 Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
897 Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Params
David Blaikieb44f0bf2017-01-04 22:36:43 +0000898 TypeFunctionProtoAbbrev = Stream.EmitAbbrev(std::move(Abv));
Richard Smith01b2cb42014-07-26 06:37:51 +0000899}
900
Chris Lattner19cea4e2009-04-22 05:57:30 +0000901//===----------------------------------------------------------------------===//
Sebastian Redl55c0ad52010-08-18 23:56:21 +0000902// ASTWriter Implementation
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000903//===----------------------------------------------------------------------===//
904
Chris Lattner28fa4e62009-04-26 22:26:21 +0000905static void EmitBlockID(unsigned ID, const char *Name,
906 llvm::BitstreamWriter &Stream,
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +0000907 ASTWriter::RecordDataImpl &Record) {
Chris Lattner28fa4e62009-04-26 22:26:21 +0000908 Record.clear();
909 Record.push_back(ID);
910 Stream.EmitRecord(llvm::bitc::BLOCKINFO_CODE_SETBID, Record);
911
912 // Emit the block name if present.
Craig Toppera13603a2014-05-22 05:54:18 +0000913 if (!Name || Name[0] == 0)
914 return;
Chris Lattner28fa4e62009-04-26 22:26:21 +0000915 Record.clear();
916 while (*Name)
917 Record.push_back(*Name++);
918 Stream.EmitRecord(llvm::bitc::BLOCKINFO_CODE_BLOCKNAME, Record);
919}
920
921static void EmitRecordID(unsigned ID, const char *Name,
922 llvm::BitstreamWriter &Stream,
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +0000923 ASTWriter::RecordDataImpl &Record) {
Chris Lattner28fa4e62009-04-26 22:26:21 +0000924 Record.clear();
925 Record.push_back(ID);
926 while (*Name)
927 Record.push_back(*Name++);
928 Stream.EmitRecord(llvm::bitc::BLOCKINFO_CODE_SETRECORDNAME, Record);
Chris Lattnerccac3a62009-04-27 00:49:53 +0000929}
930
931static void AddStmtsExprs(llvm::BitstreamWriter &Stream,
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +0000932 ASTWriter::RecordDataImpl &Record) {
Sebastian Redl539c5062010-08-18 23:57:32 +0000933#define RECORD(X) EmitRecordID(X, #X, Stream, Record)
Chris Lattnerccac3a62009-04-27 00:49:53 +0000934 RECORD(STMT_STOP);
935 RECORD(STMT_NULL_PTR);
Richard Smith01b2cb42014-07-26 06:37:51 +0000936 RECORD(STMT_REF_PTR);
Chris Lattnerccac3a62009-04-27 00:49:53 +0000937 RECORD(STMT_NULL);
938 RECORD(STMT_COMPOUND);
939 RECORD(STMT_CASE);
940 RECORD(STMT_DEFAULT);
941 RECORD(STMT_LABEL);
Richard Smithc202b282012-04-14 00:33:13 +0000942 RECORD(STMT_ATTRIBUTED);
Chris Lattnerccac3a62009-04-27 00:49:53 +0000943 RECORD(STMT_IF);
944 RECORD(STMT_SWITCH);
945 RECORD(STMT_WHILE);
946 RECORD(STMT_DO);
947 RECORD(STMT_FOR);
948 RECORD(STMT_GOTO);
949 RECORD(STMT_INDIRECT_GOTO);
950 RECORD(STMT_CONTINUE);
951 RECORD(STMT_BREAK);
952 RECORD(STMT_RETURN);
953 RECORD(STMT_DECL);
Chad Rosierde70e0e2012-08-25 00:11:56 +0000954 RECORD(STMT_GCCASM);
Chad Rosiere30d4992012-08-24 23:51:02 +0000955 RECORD(STMT_MSASM);
Chris Lattnerccac3a62009-04-27 00:49:53 +0000956 RECORD(EXPR_PREDEFINED);
957 RECORD(EXPR_DECL_REF);
958 RECORD(EXPR_INTEGER_LITERAL);
959 RECORD(EXPR_FLOATING_LITERAL);
960 RECORD(EXPR_IMAGINARY_LITERAL);
961 RECORD(EXPR_STRING_LITERAL);
962 RECORD(EXPR_CHARACTER_LITERAL);
963 RECORD(EXPR_PAREN);
Richard Smithf1b4b8b2014-07-27 04:29:04 +0000964 RECORD(EXPR_PAREN_LIST);
Chris Lattnerccac3a62009-04-27 00:49:53 +0000965 RECORD(EXPR_UNARY_OPERATOR);
966 RECORD(EXPR_SIZEOF_ALIGN_OF);
967 RECORD(EXPR_ARRAY_SUBSCRIPT);
968 RECORD(EXPR_CALL);
969 RECORD(EXPR_MEMBER);
970 RECORD(EXPR_BINARY_OPERATOR);
971 RECORD(EXPR_COMPOUND_ASSIGN_OPERATOR);
972 RECORD(EXPR_CONDITIONAL_OPERATOR);
973 RECORD(EXPR_IMPLICIT_CAST);
974 RECORD(EXPR_CSTYLE_CAST);
975 RECORD(EXPR_COMPOUND_LITERAL);
976 RECORD(EXPR_EXT_VECTOR_ELEMENT);
977 RECORD(EXPR_INIT_LIST);
978 RECORD(EXPR_DESIGNATED_INIT);
Yunzhong Gaocb779302015-06-10 00:27:52 +0000979 RECORD(EXPR_DESIGNATED_INIT_UPDATE);
Chris Lattnerccac3a62009-04-27 00:49:53 +0000980 RECORD(EXPR_IMPLICIT_VALUE_INIT);
Yunzhong Gaocb779302015-06-10 00:27:52 +0000981 RECORD(EXPR_NO_INIT);
Chris Lattnerccac3a62009-04-27 00:49:53 +0000982 RECORD(EXPR_VA_ARG);
983 RECORD(EXPR_ADDR_LABEL);
984 RECORD(EXPR_STMT);
Chris Lattnerccac3a62009-04-27 00:49:53 +0000985 RECORD(EXPR_CHOOSE);
986 RECORD(EXPR_GNU_NULL);
987 RECORD(EXPR_SHUFFLE_VECTOR);
988 RECORD(EXPR_BLOCK);
Peter Collingbourne91147592011-04-15 00:35:48 +0000989 RECORD(EXPR_GENERIC_SELECTION);
Chris Lattnerccac3a62009-04-27 00:49:53 +0000990 RECORD(EXPR_OBJC_STRING_LITERAL);
Patrick Beard0caa3942012-04-19 00:25:12 +0000991 RECORD(EXPR_OBJC_BOXED_EXPRESSION);
Ted Kremeneke65b0862012-03-06 20:05:56 +0000992 RECORD(EXPR_OBJC_ARRAY_LITERAL);
993 RECORD(EXPR_OBJC_DICTIONARY_LITERAL);
Chris Lattnerccac3a62009-04-27 00:49:53 +0000994 RECORD(EXPR_OBJC_ENCODE);
995 RECORD(EXPR_OBJC_SELECTOR_EXPR);
996 RECORD(EXPR_OBJC_PROTOCOL_EXPR);
997 RECORD(EXPR_OBJC_IVAR_REF_EXPR);
998 RECORD(EXPR_OBJC_PROPERTY_REF_EXPR);
999 RECORD(EXPR_OBJC_KVC_REF_EXPR);
1000 RECORD(EXPR_OBJC_MESSAGE_EXPR);
Chris Lattnerccac3a62009-04-27 00:49:53 +00001001 RECORD(STMT_OBJC_FOR_COLLECTION);
1002 RECORD(STMT_OBJC_CATCH);
1003 RECORD(STMT_OBJC_FINALLY);
1004 RECORD(STMT_OBJC_AT_TRY);
1005 RECORD(STMT_OBJC_AT_SYNCHRONIZED);
1006 RECORD(STMT_OBJC_AT_THROW);
Ted Kremeneke65b0862012-03-06 20:05:56 +00001007 RECORD(EXPR_OBJC_BOOL_LITERAL);
Richard Smith01b2cb42014-07-26 06:37:51 +00001008 RECORD(STMT_CXX_CATCH);
1009 RECORD(STMT_CXX_TRY);
1010 RECORD(STMT_CXX_FOR_RANGE);
Sam Weinige83b3ac2010-02-07 06:32:43 +00001011 RECORD(EXPR_CXX_OPERATOR_CALL);
Richard Smithf1b4b8b2014-07-27 04:29:04 +00001012 RECORD(EXPR_CXX_MEMBER_CALL);
Sam Weinige83b3ac2010-02-07 06:32:43 +00001013 RECORD(EXPR_CXX_CONSTRUCT);
Richard Smithf1b4b8b2014-07-27 04:29:04 +00001014 RECORD(EXPR_CXX_TEMPORARY_OBJECT);
Sam Weinige83b3ac2010-02-07 06:32:43 +00001015 RECORD(EXPR_CXX_STATIC_CAST);
1016 RECORD(EXPR_CXX_DYNAMIC_CAST);
1017 RECORD(EXPR_CXX_REINTERPRET_CAST);
1018 RECORD(EXPR_CXX_CONST_CAST);
1019 RECORD(EXPR_CXX_FUNCTIONAL_CAST);
Richard Smithc67fdd42012-03-07 08:35:16 +00001020 RECORD(EXPR_USER_DEFINED_LITERAL);
Richard Smithcc1b96d2013-06-12 22:31:48 +00001021 RECORD(EXPR_CXX_STD_INITIALIZER_LIST);
Sam Weinige83b3ac2010-02-07 06:32:43 +00001022 RECORD(EXPR_CXX_BOOL_LITERAL);
1023 RECORD(EXPR_CXX_NULL_PTR_LITERAL);
Douglas Gregor0beaec02011-02-08 16:34:17 +00001024 RECORD(EXPR_CXX_TYPEID_EXPR);
1025 RECORD(EXPR_CXX_TYPEID_TYPE);
Douglas Gregor0beaec02011-02-08 16:34:17 +00001026 RECORD(EXPR_CXX_THIS);
1027 RECORD(EXPR_CXX_THROW);
1028 RECORD(EXPR_CXX_DEFAULT_ARG);
Richard Smith01b2cb42014-07-26 06:37:51 +00001029 RECORD(EXPR_CXX_DEFAULT_INIT);
Douglas Gregor0beaec02011-02-08 16:34:17 +00001030 RECORD(EXPR_CXX_BIND_TEMPORARY);
1031 RECORD(EXPR_CXX_SCALAR_VALUE_INIT);
1032 RECORD(EXPR_CXX_NEW);
1033 RECORD(EXPR_CXX_DELETE);
1034 RECORD(EXPR_CXX_PSEUDO_DESTRUCTOR);
1035 RECORD(EXPR_EXPR_WITH_CLEANUPS);
1036 RECORD(EXPR_CXX_DEPENDENT_SCOPE_MEMBER);
1037 RECORD(EXPR_CXX_DEPENDENT_SCOPE_DECL_REF);
1038 RECORD(EXPR_CXX_UNRESOLVED_CONSTRUCT);
1039 RECORD(EXPR_CXX_UNRESOLVED_MEMBER);
1040 RECORD(EXPR_CXX_UNRESOLVED_LOOKUP);
Richard Smith01b2cb42014-07-26 06:37:51 +00001041 RECORD(EXPR_CXX_EXPRESSION_TRAIT);
Douglas Gregor0beaec02011-02-08 16:34:17 +00001042 RECORD(EXPR_CXX_NOEXCEPT);
1043 RECORD(EXPR_OPAQUE_VALUE);
Richard Smith01b2cb42014-07-26 06:37:51 +00001044 RECORD(EXPR_BINARY_CONDITIONAL_OPERATOR);
1045 RECORD(EXPR_TYPE_TRAIT);
1046 RECORD(EXPR_ARRAY_TYPE_TRAIT);
Douglas Gregor0beaec02011-02-08 16:34:17 +00001047 RECORD(EXPR_PACK_EXPANSION);
1048 RECORD(EXPR_SIZEOF_PACK);
Richard Smith01b2cb42014-07-26 06:37:51 +00001049 RECORD(EXPR_SUBST_NON_TYPE_TEMPLATE_PARM);
Douglas Gregor0beaec02011-02-08 16:34:17 +00001050 RECORD(EXPR_SUBST_NON_TYPE_TEMPLATE_PARM_PACK);
Richard Smith01b2cb42014-07-26 06:37:51 +00001051 RECORD(EXPR_FUNCTION_PARM_PACK);
1052 RECORD(EXPR_MATERIALIZE_TEMPORARY);
Peter Collingbourne41f85462011-02-09 21:07:24 +00001053 RECORD(EXPR_CUDA_KERNEL_CALL);
Richard Smith01b2cb42014-07-26 06:37:51 +00001054 RECORD(EXPR_CXX_UUIDOF_EXPR);
1055 RECORD(EXPR_CXX_UUIDOF_TYPE);
1056 RECORD(EXPR_LAMBDA);
Chris Lattnerccac3a62009-04-27 00:49:53 +00001057#undef RECORD
Chris Lattner28fa4e62009-04-26 22:26:21 +00001058}
Mike Stump11289f42009-09-09 15:08:12 +00001059
Sebastian Redl55c0ad52010-08-18 23:56:21 +00001060void ASTWriter::WriteBlockInfoBlock() {
Chris Lattner28fa4e62009-04-26 22:26:21 +00001061 RecordData Record;
Peter Collingbourned3a6c702016-11-01 01:18:57 +00001062 Stream.EnterBlockInfoBlock();
Mike Stump11289f42009-09-09 15:08:12 +00001063
Sebastian Redl539c5062010-08-18 23:57:32 +00001064#define BLOCK(X) EmitBlockID(X ## _ID, #X, Stream, Record)
1065#define RECORD(X) EmitRecordID(X, #X, Stream, Record)
Mike Stump11289f42009-09-09 15:08:12 +00001066
Douglas Gregor0aa21c92012-10-18 18:27:37 +00001067 // Control Block.
1068 BLOCK(CONTROL_BLOCK);
1069 RECORD(METADATA);
Ben Langmuirbeee15e2014-04-14 18:00:01 +00001070 RECORD(MODULE_NAME);
Richard Smithfa715652015-08-31 22:43:10 +00001071 RECORD(MODULE_DIRECTORY);
Ben Langmuirbeee15e2014-04-14 18:00:01 +00001072 RECORD(MODULE_MAP_FILE);
Douglas Gregor0aa21c92012-10-18 18:27:37 +00001073 RECORD(IMPORTS);
Douglas Gregorfad10d82012-10-18 18:36:53 +00001074 RECORD(ORIGINAL_FILE);
Douglas Gregor0aa21c92012-10-18 18:27:37 +00001075 RECORD(ORIGINAL_PCH_DIR);
Argyrios Kyrtzidis52595242012-11-15 18:57:27 +00001076 RECORD(ORIGINAL_FILE_ID);
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001077 RECORD(INPUT_FILE_OFFSETS);
Richard Smith0516b182015-09-08 19:40:14 +00001078
1079 BLOCK(OPTIONS_BLOCK);
1080 RECORD(LANGUAGE_OPTIONS);
1081 RECORD(TARGET_OPTIONS);
Douglas Gregorc6317db2012-10-24 15:49:58 +00001082 RECORD(FILE_SYSTEM_OPTIONS);
Douglas Gregor2d302362012-10-24 16:50:34 +00001083 RECORD(HEADER_SEARCH_OPTIONS);
Douglas Gregorb6af6c22012-10-24 20:05:57 +00001084 RECORD(PREPROCESSOR_OPTIONS);
1085
Douglas Gregor108cb222012-10-19 00:45:00 +00001086 BLOCK(INPUT_FILES_BLOCK);
1087 RECORD(INPUT_FILE);
1088
Douglas Gregor0aa21c92012-10-18 18:27:37 +00001089 // AST Top-Level Block.
1090 BLOCK(AST_BLOCK);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001091 RECORD(TYPE_OFFSET);
1092 RECORD(DECL_OFFSET);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001093 RECORD(IDENTIFIER_OFFSET);
1094 RECORD(IDENTIFIER_TABLE);
Ben Langmuir332aafe2014-01-31 01:06:56 +00001095 RECORD(EAGERLY_DESERIALIZED_DECLS);
David Blaikie9ffe5a32017-01-30 05:00:26 +00001096 RECORD(MODULAR_CODEGEN_DECLS);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001097 RECORD(SPECIAL_TYPES);
1098 RECORD(STATISTICS);
1099 RECORD(TENTATIVE_DEFINITIONS);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001100 RECORD(SELECTOR_OFFSETS);
1101 RECORD(METHOD_POOL);
1102 RECORD(PP_COUNTER_VALUE);
Douglas Gregor258ae542009-04-27 06:38:32 +00001103 RECORD(SOURCE_LOCATION_OFFSETS);
1104 RECORD(SOURCE_LOCATION_PRELOADS);
Douglas Gregor61cac2b2009-04-27 20:06:05 +00001105 RECORD(EXT_VECTOR_DECLS);
Richard Smithfa715652015-08-31 22:43:10 +00001106 RECORD(UNUSED_FILESCOPED_DECLS);
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00001107 RECORD(PPD_ENTITIES_OFFSETS);
Richard Smithfa715652015-08-31 22:43:10 +00001108 RECORD(VTABLE_USES);
Cameron Desrochersb60f1b62018-01-15 19:14:16 +00001109 RECORD(PPD_SKIPPED_RANGES);
Fariborz Jahanianc51609a2010-07-23 19:11:11 +00001110 RECORD(REFERENCED_SELECTOR_POOL);
Douglas Gregor0beaec02011-02-08 16:34:17 +00001111 RECORD(TU_UPDATE_LEXICAL);
Douglas Gregor0beaec02011-02-08 16:34:17 +00001112 RECORD(SEMA_DECL_REFS);
1113 RECORD(WEAK_UNDECLARED_IDENTIFIERS);
1114 RECORD(PENDING_IMPLICIT_INSTANTIATIONS);
Douglas Gregor0beaec02011-02-08 16:34:17 +00001115 RECORD(UPDATE_VISIBLE);
1116 RECORD(DECL_UPDATE_OFFSETS);
1117 RECORD(DECL_UPDATES);
Peter Collingbourne5df20e02011-02-15 19:46:30 +00001118 RECORD(CUDA_SPECIAL_DECL_REFS);
Douglas Gregor09b69892011-02-10 17:09:37 +00001119 RECORD(HEADER_SEARCH_TABLE);
Peter Collingbourne5df20e02011-02-15 19:46:30 +00001120 RECORD(FP_PRAGMA_OPTIONS);
1121 RECORD(OPENCL_EXTENSIONS);
Yaxun Liu5b746652016-12-18 05:18:55 +00001122 RECORD(OPENCL_EXTENSION_TYPES);
1123 RECORD(OPENCL_EXTENSION_DECLS);
Alexis Hunt27a761d2011-05-04 23:29:54 +00001124 RECORD(DELEGATING_CTORS);
Douglas Gregorc2fa1692011-06-28 16:20:02 +00001125 RECORD(KNOWN_NAMESPACES);
Douglas Gregor78d0b572011-08-04 16:39:39 +00001126 RECORD(MODULE_OFFSET_MAP);
1127 RECORD(SOURCE_MANAGER_LINE_TABLE);
Douglas Gregor404cdde2012-01-27 01:47:08 +00001128 RECORD(OBJC_CATEGORIES_MAP);
Douglas Gregor66e4add2011-12-19 21:09:25 +00001129 RECORD(FILE_SORTED_DECLS);
1130 RECORD(IMPORTED_MODULES);
Douglas Gregor404cdde2012-01-27 01:47:08 +00001131 RECORD(OBJC_CATEGORIES);
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00001132 RECORD(MACRO_OFFSET);
Richard Smithfa715652015-08-31 22:43:10 +00001133 RECORD(INTERESTING_IDENTIFIERS);
1134 RECORD(UNDEFINED_BUT_USED);
Richard Smithe40f2ba2013-08-07 21:41:30 +00001135 RECORD(LATE_PARSED_TEMPLATE);
Dario Domizioli13a0a382014-05-23 12:13:25 +00001136 RECORD(OPTIMIZE_PRAGMA_OPTIONS);
Nico Weber779355f2016-03-02 23:22:00 +00001137 RECORD(MSSTRUCT_PRAGMA_OPTIONS);
Nico Weber42932312016-03-03 00:17:35 +00001138 RECORD(POINTERS_TO_MEMBERS_PRAGMA_OPTIONS);
Richard Smithfa715652015-08-31 22:43:10 +00001139 RECORD(UNUSED_LOCAL_TYPEDEF_NAME_CANDIDATES);
Richard Smithfa715652015-08-31 22:43:10 +00001140 RECORD(DELETE_EXPRS_TO_ANALYZE);
Justin Lebar67a78a62016-10-08 22:15:58 +00001141 RECORD(CUDA_PRAGMA_FORCE_HOST_DEVICE_DEPTH);
Erik Verbruggenb34c79f2017-05-30 11:54:55 +00001142 RECORD(PP_CONDITIONAL_STACK);
Douglas Gregor358cd442012-01-15 16:58:34 +00001143
Chris Lattner28fa4e62009-04-26 22:26:21 +00001144 // SourceManager Block.
Chris Lattner64031982009-04-27 00:40:25 +00001145 BLOCK(SOURCE_MANAGER_BLOCK);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001146 RECORD(SM_SLOC_FILE_ENTRY);
1147 RECORD(SM_SLOC_BUFFER_ENTRY);
1148 RECORD(SM_SLOC_BUFFER_BLOB);
Richard Smithaada85c2016-02-06 02:06:43 +00001149 RECORD(SM_SLOC_BUFFER_BLOB_COMPRESSED);
Chandler Carruthf92ac9e2011-07-15 07:25:21 +00001150 RECORD(SM_SLOC_EXPANSION_ENTRY);
Mike Stump11289f42009-09-09 15:08:12 +00001151
Chris Lattner28fa4e62009-04-26 22:26:21 +00001152 // Preprocessor Block.
Chris Lattner64031982009-04-27 00:40:25 +00001153 BLOCK(PREPROCESSOR_BLOCK);
Richard Smithec216502015-02-13 19:48:37 +00001154 RECORD(PP_MACRO_DIRECTIVE_HISTORY);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001155 RECORD(PP_MACRO_FUNCTION_LIKE);
Richard Smithd7329392015-04-21 21:46:32 +00001156 RECORD(PP_MACRO_OBJECT_LIKE);
1157 RECORD(PP_MODULE_MACRO);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001158 RECORD(PP_TOKEN);
Richard Smithec216502015-02-13 19:48:37 +00001159
Richard Smithfa715652015-08-31 22:43:10 +00001160 // Submodule Block.
1161 BLOCK(SUBMODULE_BLOCK);
1162 RECORD(SUBMODULE_METADATA);
1163 RECORD(SUBMODULE_DEFINITION);
1164 RECORD(SUBMODULE_UMBRELLA_HEADER);
1165 RECORD(SUBMODULE_HEADER);
1166 RECORD(SUBMODULE_TOPHEADER);
1167 RECORD(SUBMODULE_UMBRELLA_DIR);
1168 RECORD(SUBMODULE_IMPORTS);
1169 RECORD(SUBMODULE_EXPORTS);
1170 RECORD(SUBMODULE_REQUIRES);
1171 RECORD(SUBMODULE_EXCLUDED_HEADER);
1172 RECORD(SUBMODULE_LINK_LIBRARY);
1173 RECORD(SUBMODULE_CONFIG_MACRO);
1174 RECORD(SUBMODULE_CONFLICT);
1175 RECORD(SUBMODULE_PRIVATE_HEADER);
1176 RECORD(SUBMODULE_TEXTUAL_HEADER);
1177 RECORD(SUBMODULE_PRIVATE_TEXTUAL_HEADER);
Richard Smithdc1f0422016-07-20 19:10:16 +00001178 RECORD(SUBMODULE_INITIALIZERS);
Douglas Gregorf0b11de2017-09-14 23:38:44 +00001179 RECORD(SUBMODULE_EXPORT_AS);
Richard Smithfa715652015-08-31 22:43:10 +00001180
1181 // Comments Block.
1182 BLOCK(COMMENTS_BLOCK);
1183 RECORD(COMMENTS_RAW_COMMENT);
1184
Douglas Gregor12bfa382009-10-17 00:13:19 +00001185 // Decls and Types block.
1186 BLOCK(DECLTYPES_BLOCK);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001187 RECORD(TYPE_EXT_QUAL);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001188 RECORD(TYPE_COMPLEX);
1189 RECORD(TYPE_POINTER);
1190 RECORD(TYPE_BLOCK_POINTER);
1191 RECORD(TYPE_LVALUE_REFERENCE);
1192 RECORD(TYPE_RVALUE_REFERENCE);
1193 RECORD(TYPE_MEMBER_POINTER);
1194 RECORD(TYPE_CONSTANT_ARRAY);
1195 RECORD(TYPE_INCOMPLETE_ARRAY);
1196 RECORD(TYPE_VARIABLE_ARRAY);
1197 RECORD(TYPE_VECTOR);
1198 RECORD(TYPE_EXT_VECTOR);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001199 RECORD(TYPE_FUNCTION_NO_PROTO);
Richard Smithf1b4b8b2014-07-27 04:29:04 +00001200 RECORD(TYPE_FUNCTION_PROTO);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001201 RECORD(TYPE_TYPEDEF);
1202 RECORD(TYPE_TYPEOF_EXPR);
1203 RECORD(TYPE_TYPEOF);
1204 RECORD(TYPE_RECORD);
1205 RECORD(TYPE_ENUM);
1206 RECORD(TYPE_OBJC_INTERFACE);
Steve Narofffb4330f2009-06-17 22:40:22 +00001207 RECORD(TYPE_OBJC_OBJECT_POINTER);
Douglas Gregor0beaec02011-02-08 16:34:17 +00001208 RECORD(TYPE_DECLTYPE);
1209 RECORD(TYPE_ELABORATED);
1210 RECORD(TYPE_SUBST_TEMPLATE_TYPE_PARM);
1211 RECORD(TYPE_UNRESOLVED_USING);
1212 RECORD(TYPE_INJECTED_CLASS_NAME);
1213 RECORD(TYPE_OBJC_OBJECT);
1214 RECORD(TYPE_TEMPLATE_TYPE_PARM);
1215 RECORD(TYPE_TEMPLATE_SPECIALIZATION);
1216 RECORD(TYPE_DEPENDENT_NAME);
1217 RECORD(TYPE_DEPENDENT_TEMPLATE_SPECIALIZATION);
1218 RECORD(TYPE_DEPENDENT_SIZED_ARRAY);
1219 RECORD(TYPE_PAREN);
1220 RECORD(TYPE_PACK_EXPANSION);
1221 RECORD(TYPE_ATTRIBUTED);
1222 RECORD(TYPE_SUBST_TEMPLATE_TYPE_PARM_PACK);
Richard Smithf1b4b8b2014-07-27 04:29:04 +00001223 RECORD(TYPE_AUTO);
1224 RECORD(TYPE_UNARY_TRANSFORM);
Eli Friedman0dfb8892011-10-06 23:00:33 +00001225 RECORD(TYPE_ATOMIC);
Richard Smithf1b4b8b2014-07-27 04:29:04 +00001226 RECORD(TYPE_DECAYED);
1227 RECORD(TYPE_ADJUSTED);
Manman Rene6be26c2016-09-13 17:25:08 +00001228 RECORD(TYPE_OBJC_TYPE_PARAM);
Richard Smithd61d4ac2015-08-22 20:13:39 +00001229 RECORD(LOCAL_REDECLARATIONS);
Chris Lattnerdb397b62009-04-26 22:32:16 +00001230 RECORD(DECL_TYPEDEF);
Richard Smith01b2cb42014-07-26 06:37:51 +00001231 RECORD(DECL_TYPEALIAS);
Chris Lattnerdb397b62009-04-26 22:32:16 +00001232 RECORD(DECL_ENUM);
1233 RECORD(DECL_RECORD);
1234 RECORD(DECL_ENUM_CONSTANT);
1235 RECORD(DECL_FUNCTION);
1236 RECORD(DECL_OBJC_METHOD);
1237 RECORD(DECL_OBJC_INTERFACE);
1238 RECORD(DECL_OBJC_PROTOCOL);
1239 RECORD(DECL_OBJC_IVAR);
1240 RECORD(DECL_OBJC_AT_DEFS_FIELD);
Chris Lattnerdb397b62009-04-26 22:32:16 +00001241 RECORD(DECL_OBJC_CATEGORY);
1242 RECORD(DECL_OBJC_CATEGORY_IMPL);
1243 RECORD(DECL_OBJC_IMPLEMENTATION);
1244 RECORD(DECL_OBJC_COMPATIBLE_ALIAS);
1245 RECORD(DECL_OBJC_PROPERTY);
1246 RECORD(DECL_OBJC_PROPERTY_IMPL);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001247 RECORD(DECL_FIELD);
John McCall5e77d762013-04-16 07:28:30 +00001248 RECORD(DECL_MS_PROPERTY);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001249 RECORD(DECL_VAR);
Chris Lattnerdb397b62009-04-26 22:32:16 +00001250 RECORD(DECL_IMPLICIT_PARAM);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001251 RECORD(DECL_PARM_VAR);
Chris Lattnerdb397b62009-04-26 22:32:16 +00001252 RECORD(DECL_FILE_SCOPE_ASM);
1253 RECORD(DECL_BLOCK);
1254 RECORD(DECL_CONTEXT_LEXICAL);
1255 RECORD(DECL_CONTEXT_VISIBLE);
Douglas Gregor0beaec02011-02-08 16:34:17 +00001256 RECORD(DECL_NAMESPACE);
1257 RECORD(DECL_NAMESPACE_ALIAS);
1258 RECORD(DECL_USING);
1259 RECORD(DECL_USING_SHADOW);
1260 RECORD(DECL_USING_DIRECTIVE);
1261 RECORD(DECL_UNRESOLVED_USING_VALUE);
1262 RECORD(DECL_UNRESOLVED_USING_TYPENAME);
1263 RECORD(DECL_LINKAGE_SPEC);
1264 RECORD(DECL_CXX_RECORD);
1265 RECORD(DECL_CXX_METHOD);
1266 RECORD(DECL_CXX_CONSTRUCTOR);
Richard Smith5179eb72016-06-28 19:03:57 +00001267 RECORD(DECL_CXX_INHERITED_CONSTRUCTOR);
Douglas Gregor0beaec02011-02-08 16:34:17 +00001268 RECORD(DECL_CXX_DESTRUCTOR);
1269 RECORD(DECL_CXX_CONVERSION);
1270 RECORD(DECL_ACCESS_SPEC);
1271 RECORD(DECL_FRIEND);
1272 RECORD(DECL_FRIEND_TEMPLATE);
1273 RECORD(DECL_CLASS_TEMPLATE);
1274 RECORD(DECL_CLASS_TEMPLATE_SPECIALIZATION);
1275 RECORD(DECL_CLASS_TEMPLATE_PARTIAL_SPECIALIZATION);
Larisse Voufo39a1e502013-08-06 01:03:05 +00001276 RECORD(DECL_VAR_TEMPLATE);
1277 RECORD(DECL_VAR_TEMPLATE_SPECIALIZATION);
1278 RECORD(DECL_VAR_TEMPLATE_PARTIAL_SPECIALIZATION);
Douglas Gregor0beaec02011-02-08 16:34:17 +00001279 RECORD(DECL_FUNCTION_TEMPLATE);
1280 RECORD(DECL_TEMPLATE_TYPE_PARM);
1281 RECORD(DECL_NON_TYPE_TEMPLATE_PARM);
1282 RECORD(DECL_TEMPLATE_TEMPLATE_PARM);
Richard Smithefc884a2016-04-13 07:41:35 +00001283 RECORD(DECL_TYPE_ALIAS_TEMPLATE);
Douglas Gregor0beaec02011-02-08 16:34:17 +00001284 RECORD(DECL_STATIC_ASSERT);
1285 RECORD(DECL_CXX_BASE_SPECIFIERS);
Richard Smithefc884a2016-04-13 07:41:35 +00001286 RECORD(DECL_CXX_CTOR_INITIALIZERS);
Douglas Gregor0beaec02011-02-08 16:34:17 +00001287 RECORD(DECL_INDIRECTFIELD);
1288 RECORD(DECL_EXPANDED_NON_TYPE_TEMPLATE_PARM_PACK);
Richard Smithefc884a2016-04-13 07:41:35 +00001289 RECORD(DECL_EXPANDED_TEMPLATE_TEMPLATE_PARM_PACK);
1290 RECORD(DECL_CLASS_SCOPE_FUNCTION_SPECIALIZATION);
1291 RECORD(DECL_IMPORT);
1292 RECORD(DECL_OMP_THREADPRIVATE);
1293 RECORD(DECL_EMPTY);
1294 RECORD(DECL_OBJC_TYPE_PARAM);
1295 RECORD(DECL_OMP_CAPTUREDEXPR);
1296 RECORD(DECL_PRAGMA_COMMENT);
1297 RECORD(DECL_PRAGMA_DETECT_MISMATCH);
1298 RECORD(DECL_OMP_DECLARE_REDUCTION);
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00001299
Douglas Gregor03412ba2011-06-03 02:27:19 +00001300 // Statements and Exprs can occur in the Decls and Types block.
1301 AddStmtsExprs(Stream, Record);
1302
Douglas Gregor92a96f52011-02-08 21:58:10 +00001303 BLOCK(PREPROCESSOR_DETAIL_BLOCK);
Chandler Carruthf92ac9e2011-07-15 07:25:21 +00001304 RECORD(PPD_MACRO_EXPANSION);
Douglas Gregor92a96f52011-02-08 21:58:10 +00001305 RECORD(PPD_MACRO_DEFINITION);
1306 RECORD(PPD_INCLUSION_DIRECTIVE);
Douglas Gregor6623e1f2015-11-03 18:33:07 +00001307
1308 // Decls and Types block.
1309 BLOCK(EXTENSION_BLOCK);
1310 RECORD(EXTENSION_METADATA);
1311
Duncan P. N. Exon Smith60fa2882017-03-13 18:45:08 +00001312 BLOCK(UNHASHED_CONTROL_BLOCK);
1313 RECORD(SIGNATURE);
1314 RECORD(DIAGNOSTIC_OPTIONS);
1315 RECORD(DIAG_PRAGMA_MAPPINGS);
1316
Chris Lattner28fa4e62009-04-26 22:26:21 +00001317#undef RECORD
1318#undef BLOCK
1319 Stream.ExitBlock();
1320}
1321
Richard Smith54cc3c22014-12-11 20:50:24 +00001322/// \brief Prepares a path for being written to an AST file by converting it
1323/// to an absolute path and removing nested './'s.
1324///
1325/// \return \c true if the path was changed.
Benjamin Kramer6a96ae52015-02-06 18:36:04 +00001326static bool cleanPathForOutput(FileManager &FileMgr,
1327 SmallVectorImpl<char> &Path) {
Argyrios Kyrtzidis403cbcb2015-07-31 01:39:23 +00001328 bool Changed = FileMgr.makeAbsolutePath(Path);
Mike Aizatskyaeb9dd92015-11-09 19:12:18 +00001329 return Changed | llvm::sys::path::remove_dots(Path);
Richard Smith54cc3c22014-12-11 20:50:24 +00001330}
1331
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001332/// \brief Adjusts the given filename to only write out the portion of the
1333/// filename that is not part of the system root directory.
Mike Stump11289f42009-09-09 15:08:12 +00001334///
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001335/// \param Filename the file name to adjust.
1336///
Richard Smith7ed1bc92014-12-05 22:42:13 +00001337/// \param BaseDir When non-NULL, the PCH file is a relocatable AST file and
1338/// the returned filename will be adjusted by this root directory.
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001339///
1340/// \returns either the original filename (if it needs no adjustment) or the
1341/// adjusted filename (which points into the @p Filename parameter).
Mike Stump11289f42009-09-09 15:08:12 +00001342static const char *
Richard Smith7ed1bc92014-12-05 22:42:13 +00001343adjustFilenameForRelocatableAST(const char *Filename, StringRef BaseDir) {
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001344 assert(Filename && "No file name to adjust?");
Mike Stump11289f42009-09-09 15:08:12 +00001345
Richard Smith7ed1bc92014-12-05 22:42:13 +00001346 if (BaseDir.empty())
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001347 return Filename;
Mike Stump11289f42009-09-09 15:08:12 +00001348
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001349 // Verify that the filename and the system root have the same prefix.
1350 unsigned Pos = 0;
Richard Smith7ed1bc92014-12-05 22:42:13 +00001351 for (; Filename[Pos] && Pos < BaseDir.size(); ++Pos)
1352 if (Filename[Pos] != BaseDir[Pos])
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001353 return Filename; // Prefixes don't match.
Mike Stump11289f42009-09-09 15:08:12 +00001354
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001355 // We hit the end of the filename before we hit the end of the system root.
1356 if (!Filename[Pos])
1357 return Filename;
Mike Stump11289f42009-09-09 15:08:12 +00001358
Richard Smith7ed1bc92014-12-05 22:42:13 +00001359 // If there's not a path separator at the end of the base directory nor
1360 // immediately after it, then this isn't within the base directory.
1361 if (!llvm::sys::path::is_separator(Filename[Pos])) {
1362 if (!llvm::sys::path::is_separator(BaseDir.back()))
1363 return Filename;
1364 } else {
1365 // If the file name has a '/' at the current position, skip over the '/'.
1366 // We distinguish relative paths from absolute paths by the
1367 // absence of '/' at the beginning of relative paths.
1368 //
1369 // FIXME: This is wrong. We distinguish them by asking if the path is
1370 // absolute, which isn't the same thing. And there might be multiple '/'s
1371 // in a row. Use a better mechanism to indicate whether we have emitted an
1372 // absolute or relative path.
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001373 ++Pos;
Richard Smith7ed1bc92014-12-05 22:42:13 +00001374 }
Mike Stump11289f42009-09-09 15:08:12 +00001375
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001376 return Filename + Pos;
1377}
Chris Lattner28fa4e62009-04-26 22:26:21 +00001378
Duncan P. N. Exon Smith60fa2882017-03-13 18:45:08 +00001379ASTFileSignature ASTWriter::createSignature(StringRef Bytes) {
1380 // Calculate the hash till start of UNHASHED_CONTROL_BLOCK.
1381 llvm::SHA1 Hasher;
1382 Hasher.update(ArrayRef<uint8_t>(Bytes.bytes_begin(), Bytes.size()));
1383 auto Hash = Hasher.result();
1384
1385 // Convert to an array [5*i32].
1386 ASTFileSignature Signature;
1387 auto LShift = [&](unsigned char Val, unsigned Shift) {
1388 return (uint32_t)Val << Shift;
1389 };
1390 for (int I = 0; I != 5; ++I)
1391 Signature[I] = LShift(Hash[I * 4 + 0], 24) | LShift(Hash[I * 4 + 1], 16) |
1392 LShift(Hash[I * 4 + 2], 8) | LShift(Hash[I * 4 + 3], 0);
1393
1394 return Signature;
1395}
1396
1397ASTFileSignature ASTWriter::writeUnhashedControlBlock(Preprocessor &PP,
1398 ASTContext &Context) {
1399 // Flush first to prepare the PCM hash (signature).
1400 Stream.FlushToWord();
1401 auto StartOfUnhashedControl = Stream.GetCurrentBitNo() >> 3;
1402
1403 // Enter the block and prepare to write records.
1404 RecordData Record;
1405 Stream.EnterSubblock(UNHASHED_CONTROL_BLOCK_ID, 5);
1406
1407 // For implicit modules, write the hash of the PCM as its signature.
1408 ASTFileSignature Signature;
1409 if (WritingModule &&
1410 PP.getHeaderSearchInfo().getHeaderSearchOpts().ModulesHashContent) {
1411 Signature = createSignature(StringRef(Buffer.begin(), StartOfUnhashedControl));
1412 Record.append(Signature.begin(), Signature.end());
1413 Stream.EmitRecord(SIGNATURE, Record);
1414 Record.clear();
Ben Langmuir487ea142014-10-23 18:05:36 +00001415 }
Duncan P. N. Exon Smith60fa2882017-03-13 18:45:08 +00001416
1417 // Diagnostic options.
1418 const auto &Diags = Context.getDiagnostics();
1419 const DiagnosticOptions &DiagOpts = Diags.getDiagnosticOptions();
1420#define DIAGOPT(Name, Bits, Default) Record.push_back(DiagOpts.Name);
1421#define ENUM_DIAGOPT(Name, Type, Bits, Default) \
1422 Record.push_back(static_cast<unsigned>(DiagOpts.get##Name()));
1423#include "clang/Basic/DiagnosticOptions.def"
1424 Record.push_back(DiagOpts.Warnings.size());
1425 for (unsigned I = 0, N = DiagOpts.Warnings.size(); I != N; ++I)
1426 AddString(DiagOpts.Warnings[I], Record);
1427 Record.push_back(DiagOpts.Remarks.size());
1428 for (unsigned I = 0, N = DiagOpts.Remarks.size(); I != N; ++I)
1429 AddString(DiagOpts.Remarks[I], Record);
1430 // Note: we don't serialize the log or serialization file names, because they
1431 // are generally transient files and will almost always be overridden.
1432 Stream.EmitRecord(DIAGNOSTIC_OPTIONS, Record);
1433
1434 // Write out the diagnostic/pragma mappings.
1435 WritePragmaDiagnosticMappings(Diags, /* IsModule = */ WritingModule);
1436
1437 // Leave the options block.
1438 Stream.ExitBlock();
1439 return Signature;
Ben Langmuir487ea142014-10-23 18:05:36 +00001440}
1441
Douglas Gregor112b9072012-10-18 05:31:06 +00001442/// \brief Write the control block.
Duncan P. N. Exon Smith60fa2882017-03-13 18:45:08 +00001443void ASTWriter::WriteControlBlock(Preprocessor &PP, ASTContext &Context,
1444 StringRef isysroot,
1445 const std::string &OutputFile) {
Douglas Gregorbfbde532009-04-10 21:16:55 +00001446 using namespace llvm;
Eugene Zelenkob7d89102017-11-11 00:08:50 +00001447
Douglas Gregor0aa21c92012-10-18 18:27:37 +00001448 Stream.EnterSubblock(CONTROL_BLOCK_ID, 5);
Mehdi Amini5ae4a852015-09-09 20:35:37 +00001449 RecordData Record;
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00001450
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001451 // Metadata
David Blaikieb44f0bf2017-01-04 22:36:43 +00001452 auto MetadataAbbrev = std::make_shared<BitCodeAbbrev>();
Douglas Gregor0aa21c92012-10-18 18:27:37 +00001453 MetadataAbbrev->Add(BitCodeAbbrevOp(METADATA));
1454 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 16)); // Major
1455 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 16)); // Minor
1456 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 16)); // Clang maj.
1457 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 16)); // Clang min.
1458 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Relocatable
Richard Smithe75ee0f2015-08-17 07:13:32 +00001459 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Timestamps
Douglas Gregor0aa21c92012-10-18 18:27:37 +00001460 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Errors
1461 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // SVN branch/tag
David Blaikieb44f0bf2017-01-04 22:36:43 +00001462 unsigned MetadataAbbrevCode = Stream.EmitAbbrev(std::move(MetadataAbbrev));
Richard Smith7ed1bc92014-12-05 22:42:13 +00001463 assert((!WritingModule || isysroot.empty()) &&
1464 "writing module as a relocatable PCH?");
Mehdi Amini57a41912015-09-10 01:46:39 +00001465 {
1466 RecordData::value_type Record[] = {METADATA, VERSION_MAJOR, VERSION_MINOR,
1467 CLANG_VERSION_MAJOR, CLANG_VERSION_MINOR,
1468 !isysroot.empty(), IncludeTimestamps,
1469 ASTHasCompilerErrors};
1470 Stream.EmitRecordWithBlob(MetadataAbbrevCode, Record,
1471 getClangFullRepositoryVersion());
1472 }
Chandler Carruth885e78c2015-03-24 21:18:10 +00001473
Richard Smith8b706102017-05-31 20:56:55 +00001474 if (WritingModule) {
Richard Smith7ed1bc92014-12-05 22:42:13 +00001475 // Module name
David Blaikieb44f0bf2017-01-04 22:36:43 +00001476 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Ben Langmuirbeee15e2014-04-14 18:00:01 +00001477 Abbrev->Add(BitCodeAbbrevOp(MODULE_NAME));
1478 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
David Blaikieb44f0bf2017-01-04 22:36:43 +00001479 unsigned AbbrevCode = Stream.EmitAbbrev(std::move(Abbrev));
Mehdi Amini57a41912015-09-10 01:46:39 +00001480 RecordData::value_type Record[] = {MODULE_NAME};
Ben Langmuirbeee15e2014-04-14 18:00:01 +00001481 Stream.EmitRecordWithBlob(AbbrevCode, Record, WritingModule->Name);
1482 }
1483
Richard Smith7ed1bc92014-12-05 22:42:13 +00001484 if (WritingModule && WritingModule->Directory) {
Richard Smith7ed1bc92014-12-05 22:42:13 +00001485 SmallString<128> BaseDir(WritingModule->Directory->getName());
Richard Smith54cc3c22014-12-11 20:50:24 +00001486 cleanPathForOutput(Context.getSourceManager().getFileManager(), BaseDir);
Richard Smithf7b41372015-08-13 23:47:44 +00001487
1488 // If the home of the module is the current working directory, then we
1489 // want to pick up the cwd of the build process loading the module, not
1490 // our cwd, when we load this module.
1491 if (!PP.getHeaderSearchInfo()
1492 .getHeaderSearchOpts()
1493 .ModuleMapFileHomeIsCwd ||
1494 WritingModule->Directory->getName() != StringRef(".")) {
1495 // Module directory.
David Blaikieb44f0bf2017-01-04 22:36:43 +00001496 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Richard Smithf7b41372015-08-13 23:47:44 +00001497 Abbrev->Add(BitCodeAbbrevOp(MODULE_DIRECTORY));
1498 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Directory
David Blaikieb44f0bf2017-01-04 22:36:43 +00001499 unsigned AbbrevCode = Stream.EmitAbbrev(std::move(Abbrev));
Richard Smithf7b41372015-08-13 23:47:44 +00001500
Mehdi Amini57a41912015-09-10 01:46:39 +00001501 RecordData::value_type Record[] = {MODULE_DIRECTORY};
Richard Smithf7b41372015-08-13 23:47:44 +00001502 Stream.EmitRecordWithBlob(AbbrevCode, Record, BaseDir);
1503 }
Richard Smith7ed1bc92014-12-05 22:42:13 +00001504
1505 // Write out all other paths relative to the base directory if possible.
1506 BaseDirectory.assign(BaseDir.begin(), BaseDir.end());
1507 } else if (!isysroot.empty()) {
1508 // Write out paths relative to the sysroot if possible.
1509 BaseDirectory = isysroot;
1510 }
1511
Ben Langmuirbeee15e2014-04-14 18:00:01 +00001512 // Module map file
Richard Smithd19389a2017-07-05 07:47:11 +00001513 if (WritingModule && WritingModule->Kind == Module::ModuleMapModule) {
Mehdi Amini5ae4a852015-09-09 20:35:37 +00001514 Record.clear();
Ben Langmuirbeee15e2014-04-14 18:00:01 +00001515
Ben Langmuir4b8a9e92014-08-12 16:42:33 +00001516 auto &Map = PP.getHeaderSearchInfo().getModuleMap();
Richard Smith8b706102017-05-31 20:56:55 +00001517 AddPath(WritingModule->PresumedModuleMapFile.empty()
1518 ? Map.getModuleMapFileForUniquing(WritingModule)->getName()
1519 : StringRef(WritingModule->PresumedModuleMapFile),
1520 Record);
Ben Langmuir4b8a9e92014-08-12 16:42:33 +00001521
1522 // Additional module map files.
Richard Smith7ed1bc92014-12-05 22:42:13 +00001523 if (auto *AdditionalModMaps =
1524 Map.getAdditionalModuleMapFiles(WritingModule)) {
Ben Langmuir4b8a9e92014-08-12 16:42:33 +00001525 Record.push_back(AdditionalModMaps->size());
1526 for (const FileEntry *F : *AdditionalModMaps)
Richard Smith7ed1bc92014-12-05 22:42:13 +00001527 AddPath(F->getName(), Record);
Ben Langmuir4b8a9e92014-08-12 16:42:33 +00001528 } else {
1529 Record.push_back(0);
1530 }
1531
1532 Stream.EmitRecord(MODULE_MAP_FILE, Record);
Ben Langmuirbeee15e2014-04-14 18:00:01 +00001533 }
1534
Douglas Gregor112b9072012-10-18 05:31:06 +00001535 // Imports
Douglas Gregor29cc6422011-08-17 21:07:30 +00001536 if (Chain) {
Douglas Gregor29cc6422011-08-17 21:07:30 +00001537 serialization::ModuleManager &Mgr = Chain->getModuleManager();
Mehdi Amini5ae4a852015-09-09 20:35:37 +00001538 Record.clear();
Douglas Gregordf0c1512011-08-18 04:12:04 +00001539
Duncan P. N. Exon Smith96a06e02017-01-28 22:15:22 +00001540 for (ModuleFile &M : Mgr) {
Douglas Gregordf0c1512011-08-18 04:12:04 +00001541 // Skip modules that weren't directly imported.
Duncan P. N. Exon Smith96a06e02017-01-28 22:15:22 +00001542 if (!M.isDirectlyImported())
Douglas Gregordf0c1512011-08-18 04:12:04 +00001543 continue;
1544
Duncan P. N. Exon Smith96a06e02017-01-28 22:15:22 +00001545 Record.push_back((unsigned)M.Kind); // FIXME: Stable encoding
1546 AddSourceLocation(M.ImportLoc, Record);
Duncan P. N. Exon Smith60fa2882017-03-13 18:45:08 +00001547
1548 // If we have calculated signature, there is no need to store
1549 // the size or timestamp.
1550 Record.push_back(M.Signature ? 0 : M.File->getSize());
1551 Record.push_back(M.Signature ? 0 : getTimestampForOutput(M.File));
1552
1553 for (auto I : M.Signature)
1554 Record.push_back(I);
1555
Boris Kolpackovd30446f2017-08-31 06:26:43 +00001556 AddString(M.ModuleName, Record);
Duncan P. N. Exon Smith96a06e02017-01-28 22:15:22 +00001557 AddPath(M.FileName, Record);
Douglas Gregordf0c1512011-08-18 04:12:04 +00001558 }
Douglas Gregor29cc6422011-08-17 21:07:30 +00001559 Stream.EmitRecord(IMPORTS, Record);
1560 }
Mike Stump11289f42009-09-09 15:08:12 +00001561
Richard Smith0516b182015-09-08 19:40:14 +00001562 // Write the options block.
1563 Stream.EnterSubblock(OPTIONS_BLOCK_ID, 4);
1564
Douglas Gregor112b9072012-10-18 05:31:06 +00001565 // Language options.
Mehdi Amini5ae4a852015-09-09 20:35:37 +00001566 Record.clear();
Douglas Gregor112b9072012-10-18 05:31:06 +00001567 const LangOptions &LangOpts = Context.getLangOpts();
1568#define LANGOPT(Name, Bits, Default, Description) \
1569 Record.push_back(LangOpts.Name);
1570#define ENUM_LANGOPT(Name, Type, Bits, Default, Description) \
1571 Record.push_back(static_cast<unsigned>(LangOpts.get##Name()));
Alexey Samsonovedf99a92014-11-07 22:29:38 +00001572#include "clang/Basic/LangOptions.def"
1573#define SANITIZER(NAME, ID) \
1574 Record.push_back(LangOpts.Sanitize.has(SanitizerKind::ID));
Will Dietzf54319c2013-01-18 11:30:38 +00001575#include "clang/Basic/Sanitizers.def"
Douglas Gregor112b9072012-10-18 05:31:06 +00001576
Ben Langmuircd98cb72015-06-23 18:20:18 +00001577 Record.push_back(LangOpts.ModuleFeatures.size());
1578 for (StringRef Feature : LangOpts.ModuleFeatures)
1579 AddString(Feature, Record);
1580
Douglas Gregor112b9072012-10-18 05:31:06 +00001581 Record.push_back((unsigned) LangOpts.ObjCRuntime.getKind());
1582 AddVersionTuple(LangOpts.ObjCRuntime.getVersion(), Record);
Ben Langmuird4a667a2015-06-23 18:20:23 +00001583
1584 AddString(LangOpts.CurrentModule, Record);
Dmitri Gribenkoacf2e782013-02-22 14:21:27 +00001585
1586 // Comment options.
1587 Record.push_back(LangOpts.CommentOpts.BlockCommandNames.size());
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00001588 for (const auto &I : LangOpts.CommentOpts.BlockCommandNames) {
1589 AddString(I, Record);
Dmitri Gribenkoacf2e782013-02-22 14:21:27 +00001590 }
Dmitri Gribenkoa7d16ce2013-04-10 15:35:17 +00001591 Record.push_back(LangOpts.CommentOpts.ParseAllComments);
Dmitri Gribenkoacf2e782013-02-22 14:21:27 +00001592
Samuel Antaoee8fb302016-01-06 13:42:12 +00001593 // OpenMP offloading options.
1594 Record.push_back(LangOpts.OMPTargetTriples.size());
1595 for (auto &T : LangOpts.OMPTargetTriples)
1596 AddString(T.getTriple(), Record);
1597
1598 AddString(LangOpts.OMPHostIRFile, Record);
1599
Douglas Gregor112b9072012-10-18 05:31:06 +00001600 Stream.EmitRecord(LANGUAGE_OPTIONS, Record);
1601
Douglas Gregor4d3611c2012-10-18 17:58:09 +00001602 // Target options.
1603 Record.clear();
Douglas Gregor0aa21c92012-10-18 18:27:37 +00001604 const TargetInfo &Target = Context.getTargetInfo();
1605 const TargetOptions &TargetOpts = Target.getTargetOpts();
Douglas Gregor4d3611c2012-10-18 17:58:09 +00001606 AddString(TargetOpts.Triple, Record);
1607 AddString(TargetOpts.CPU, Record);
1608 AddString(TargetOpts.ABI, Record);
Douglas Gregor4d3611c2012-10-18 17:58:09 +00001609 Record.push_back(TargetOpts.FeaturesAsWritten.size());
1610 for (unsigned I = 0, N = TargetOpts.FeaturesAsWritten.size(); I != N; ++I) {
1611 AddString(TargetOpts.FeaturesAsWritten[I], Record);
1612 }
1613 Record.push_back(TargetOpts.Features.size());
1614 for (unsigned I = 0, N = TargetOpts.Features.size(); I != N; ++I) {
1615 AddString(TargetOpts.Features[I], Record);
1616 }
1617 Stream.EmitRecord(TARGET_OPTIONS, Record);
1618
Douglas Gregorc6317db2012-10-24 15:49:58 +00001619 // File system options.
1620 Record.clear();
Yaron Keren8dec46c2015-08-26 08:10:22 +00001621 const FileSystemOptions &FSOpts =
1622 Context.getSourceManager().getFileManager().getFileSystemOpts();
Douglas Gregorc6317db2012-10-24 15:49:58 +00001623 AddString(FSOpts.WorkingDir, Record);
1624 Stream.EmitRecord(FILE_SYSTEM_OPTIONS, Record);
1625
Douglas Gregor2d302362012-10-24 16:50:34 +00001626 // Header search options.
1627 Record.clear();
1628 const HeaderSearchOptions &HSOpts
1629 = PP.getHeaderSearchInfo().getHeaderSearchOpts();
1630 AddString(HSOpts.Sysroot, Record);
1631
1632 // Include entries.
1633 Record.push_back(HSOpts.UserEntries.size());
1634 for (unsigned I = 0, N = HSOpts.UserEntries.size(); I != N; ++I) {
1635 const HeaderSearchOptions::Entry &Entry = HSOpts.UserEntries[I];
1636 AddString(Entry.Path, Record);
1637 Record.push_back(static_cast<unsigned>(Entry.Group));
Douglas Gregor2d302362012-10-24 16:50:34 +00001638 Record.push_back(Entry.IsFramework);
1639 Record.push_back(Entry.IgnoreSysRoot);
Douglas Gregor2d302362012-10-24 16:50:34 +00001640 }
1641
1642 // System header prefixes.
1643 Record.push_back(HSOpts.SystemHeaderPrefixes.size());
1644 for (unsigned I = 0, N = HSOpts.SystemHeaderPrefixes.size(); I != N; ++I) {
1645 AddString(HSOpts.SystemHeaderPrefixes[I].Prefix, Record);
1646 Record.push_back(HSOpts.SystemHeaderPrefixes[I].IsSystemHeader);
1647 }
1648
1649 AddString(HSOpts.ResourceDir, Record);
1650 AddString(HSOpts.ModuleCachePath, Record);
Argyrios Kyrtzidis1594c152014-03-03 08:12:05 +00001651 AddString(HSOpts.ModuleUserBuildPath, Record);
Douglas Gregor2d302362012-10-24 16:50:34 +00001652 Record.push_back(HSOpts.DisableModuleHash);
Richard Smith18934752017-06-06 00:32:01 +00001653 Record.push_back(HSOpts.ImplicitModuleMaps);
1654 Record.push_back(HSOpts.ModuleMapFileHomeIsCwd);
Douglas Gregor2d302362012-10-24 16:50:34 +00001655 Record.push_back(HSOpts.UseBuiltinIncludes);
1656 Record.push_back(HSOpts.UseStandardSystemIncludes);
1657 Record.push_back(HSOpts.UseStandardCXXIncludes);
1658 Record.push_back(HSOpts.UseLibcxx);
Argyrios Kyrtzidisbd0b6512015-02-19 20:12:20 +00001659 // Write out the specific module cache path that contains the module files.
1660 AddString(PP.getHeaderSearchInfo().getModuleCachePath(), Record);
Douglas Gregor2d302362012-10-24 16:50:34 +00001661 Stream.EmitRecord(HEADER_SEARCH_OPTIONS, Record);
1662
Douglas Gregorb6af6c22012-10-24 20:05:57 +00001663 // Preprocessor options.
1664 Record.clear();
1665 const PreprocessorOptions &PPOpts = PP.getPreprocessorOpts();
1666
1667 // Macro definitions.
1668 Record.push_back(PPOpts.Macros.size());
1669 for (unsigned I = 0, N = PPOpts.Macros.size(); I != N; ++I) {
1670 AddString(PPOpts.Macros[I].first, Record);
1671 Record.push_back(PPOpts.Macros[I].second);
1672 }
1673
1674 // Includes
1675 Record.push_back(PPOpts.Includes.size());
1676 for (unsigned I = 0, N = PPOpts.Includes.size(); I != N; ++I)
1677 AddString(PPOpts.Includes[I], Record);
1678
1679 // Macro includes
1680 Record.push_back(PPOpts.MacroIncludes.size());
1681 for (unsigned I = 0, N = PPOpts.MacroIncludes.size(); I != N; ++I)
1682 AddString(PPOpts.MacroIncludes[I], Record);
1683
Douglas Gregorb6368752012-10-24 23:41:50 +00001684 Record.push_back(PPOpts.UsePredefines);
Argyrios Kyrtzidisd3afa0c2013-04-26 21:33:40 +00001685 // Detailed record is important since it is used for the module cache hash.
1686 Record.push_back(PPOpts.DetailedRecord);
Douglas Gregorb6af6c22012-10-24 20:05:57 +00001687 AddString(PPOpts.ImplicitPCHInclude, Record);
1688 AddString(PPOpts.ImplicitPTHInclude, Record);
1689 Record.push_back(static_cast<unsigned>(PPOpts.ObjCXXARCStandardLibrary));
1690 Stream.EmitRecord(PREPROCESSOR_OPTIONS, Record);
1691
Richard Smith0516b182015-09-08 19:40:14 +00001692 // Leave the options block.
1693 Stream.ExitBlock();
1694
Douglas Gregora3b20262011-05-06 21:43:30 +00001695 // Original file name and file ID
Douglas Gregor45fe0362009-05-12 01:31:05 +00001696 SourceManager &SM = Context.getSourceManager();
1697 if (const FileEntry *MainFile = SM.getFileEntryForID(SM.getMainFileID())) {
David Blaikieb44f0bf2017-01-04 22:36:43 +00001698 auto FileAbbrev = std::make_shared<BitCodeAbbrev>();
Douglas Gregorfad10d82012-10-18 18:36:53 +00001699 FileAbbrev->Add(BitCodeAbbrevOp(ORIGINAL_FILE));
1700 FileAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // File ID
Douglas Gregor45fe0362009-05-12 01:31:05 +00001701 FileAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // File name
David Blaikieb44f0bf2017-01-04 22:36:43 +00001702 unsigned FileAbbrevCode = Stream.EmitAbbrev(std::move(FileAbbrev));
Douglas Gregor45fe0362009-05-12 01:31:05 +00001703
Douglas Gregorb6af6c22012-10-24 20:05:57 +00001704 Record.clear();
Douglas Gregorfad10d82012-10-18 18:36:53 +00001705 Record.push_back(ORIGINAL_FILE);
Douglas Gregora3b20262011-05-06 21:43:30 +00001706 Record.push_back(SM.getMainFileID().getOpaqueValue());
Richard Smith7ed1bc92014-12-05 22:42:13 +00001707 EmitRecordWithPath(FileAbbrevCode, Record, MainFile->getName());
Douglas Gregor45fe0362009-05-12 01:31:05 +00001708 }
Kovarththanan Rajaratnama9c81a82010-03-14 07:06:50 +00001709
Argyrios Kyrtzidis52595242012-11-15 18:57:27 +00001710 Record.clear();
1711 Record.push_back(SM.getMainFileID().getOpaqueValue());
1712 Stream.EmitRecord(ORIGINAL_FILE_ID, Record);
1713
Argyrios Kyrtzidis10b23682011-02-15 17:54:22 +00001714 // Original PCH directory
1715 if (!OutputFile.empty() && OutputFile != "-") {
David Blaikieb44f0bf2017-01-04 22:36:43 +00001716 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Argyrios Kyrtzidis10b23682011-02-15 17:54:22 +00001717 Abbrev->Add(BitCodeAbbrevOp(ORIGINAL_PCH_DIR));
1718 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // File name
David Blaikieb44f0bf2017-01-04 22:36:43 +00001719 unsigned AbbrevCode = Stream.EmitAbbrev(std::move(Abbrev));
Argyrios Kyrtzidis10b23682011-02-15 17:54:22 +00001720
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00001721 SmallString<128> OutputPath(OutputFile);
Argyrios Kyrtzidis10b23682011-02-15 17:54:22 +00001722
Argyrios Kyrtzidisc56419e2015-07-31 00:58:32 +00001723 SM.getFileManager().makeAbsolutePath(OutputPath);
Argyrios Kyrtzidis10b23682011-02-15 17:54:22 +00001724 StringRef origDir = llvm::sys::path::parent_path(OutputPath);
1725
Mehdi Amini57a41912015-09-10 01:46:39 +00001726 RecordData::value_type Record[] = {ORIGINAL_PCH_DIR};
Argyrios Kyrtzidis10b23682011-02-15 17:54:22 +00001727 Stream.EmitRecordWithBlob(AbbrevCode, Record, origDir);
1728 }
1729
Douglas Gregor49491f72013-03-15 22:15:07 +00001730 WriteInputFiles(Context.SourceMgr,
1731 PP.getHeaderSearchInfo().getHeaderSearchOpts(),
Douglas Gregora3dd9002013-07-22 20:48:33 +00001732 PP.getLangOpts().Modules);
Douglas Gregor72be3902012-10-19 00:38:02 +00001733 Stream.ExitBlock();
1734}
1735
Douglas Gregor49491f72013-03-15 22:15:07 +00001736namespace {
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +00001737
Eugene Zelenkob7d89102017-11-11 00:08:50 +00001738/// \brief An input file.
1739struct InputFileEntry {
1740 const FileEntry *File;
1741 bool IsSystemFile;
1742 bool IsTransient;
1743 bool BufferOverridden;
1744 bool IsTopLevelModuleMap;
1745};
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +00001746
Eugene Zelenkob7d89102017-11-11 00:08:50 +00001747} // namespace
Douglas Gregor49491f72013-03-15 22:15:07 +00001748
1749void ASTWriter::WriteInputFiles(SourceManager &SourceMgr,
1750 HeaderSearchOptions &HSOpts,
Douglas Gregora3dd9002013-07-22 20:48:33 +00001751 bool Modules) {
Douglas Gregor72be3902012-10-19 00:38:02 +00001752 using namespace llvm;
Eugene Zelenkob7d89102017-11-11 00:08:50 +00001753
Douglas Gregor72be3902012-10-19 00:38:02 +00001754 Stream.EnterSubblock(INPUT_FILES_BLOCK_ID, 4);
Mehdi Amini57a41912015-09-10 01:46:39 +00001755
Douglas Gregor72be3902012-10-19 00:38:02 +00001756 // Create input-file abbreviation.
David Blaikieb44f0bf2017-01-04 22:36:43 +00001757 auto IFAbbrev = std::make_shared<BitCodeAbbrev>();
Douglas Gregor72be3902012-10-19 00:38:02 +00001758 IFAbbrev->Add(BitCodeAbbrevOp(INPUT_FILE));
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001759 IFAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // ID
Douglas Gregor72be3902012-10-19 00:38:02 +00001760 IFAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 12)); // Size
1761 IFAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 32)); // Modification time
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001762 IFAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Overridden
Richard Smitha8cfffa2015-11-26 02:04:16 +00001763 IFAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Transient
Richard Smithf3f84612017-06-29 02:19:42 +00001764 IFAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Module map
Douglas Gregor72be3902012-10-19 00:38:02 +00001765 IFAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // File name
David Blaikieb44f0bf2017-01-04 22:36:43 +00001766 unsigned IFAbbrevCode = Stream.EmitAbbrev(std::move(IFAbbrev));
Douglas Gregor72be3902012-10-19 00:38:02 +00001767
Argyrios Kyrtzidis7d238572013-03-06 18:12:50 +00001768 // Get all ContentCache objects for files, sorted by whether the file is a
1769 // system one or not. System files go at the back, users files at the front.
Douglas Gregor49491f72013-03-15 22:15:07 +00001770 std::deque<InputFileEntry> SortedFiles;
Douglas Gregor72be3902012-10-19 00:38:02 +00001771 for (unsigned I = 1, N = SourceMgr.local_sloc_entry_size(); I != N; ++I) {
1772 // Get this source location entry.
1773 const SrcMgr::SLocEntry *SLoc = &SourceMgr.getLocalSLocEntry(I);
NAKAMURA Takumideca50f2012-10-19 01:53:57 +00001774 assert(&SourceMgr.getSLocEntry(FileID::get(I)) == SLoc);
Douglas Gregor72be3902012-10-19 00:38:02 +00001775
1776 // We only care about file entries that were not overridden.
1777 if (!SLoc->isFile())
1778 continue;
Richard Smithf3f84612017-06-29 02:19:42 +00001779 const SrcMgr::FileInfo &File = SLoc->getFile();
1780 const SrcMgr::ContentCache *Cache = File.getContentCache();
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001781 if (!Cache->OrigEntry)
Douglas Gregor72be3902012-10-19 00:38:02 +00001782 continue;
1783
Douglas Gregor49491f72013-03-15 22:15:07 +00001784 InputFileEntry Entry;
1785 Entry.File = Cache->OrigEntry;
1786 Entry.IsSystemFile = Cache->IsSystemFile;
Richard Smitha8cfffa2015-11-26 02:04:16 +00001787 Entry.IsTransient = Cache->IsTransient;
Douglas Gregor49491f72013-03-15 22:15:07 +00001788 Entry.BufferOverridden = Cache->BufferOverridden;
Richard Smithf3f84612017-06-29 02:19:42 +00001789 Entry.IsTopLevelModuleMap = isModuleMap(File.getFileCharacteristic()) &&
1790 File.getIncludeLoc().isInvalid();
Argyrios Kyrtzidis7d238572013-03-06 18:12:50 +00001791 if (Cache->IsSystemFile)
Douglas Gregor49491f72013-03-15 22:15:07 +00001792 SortedFiles.push_back(Entry);
Argyrios Kyrtzidis7d238572013-03-06 18:12:50 +00001793 else
Douglas Gregor49491f72013-03-15 22:15:07 +00001794 SortedFiles.push_front(Entry);
1795 }
1796
Argyrios Kyrtzidis7d238572013-03-06 18:12:50 +00001797 unsigned UserFilesNum = 0;
1798 // Write out all of the input files.
Richard Smithec216502015-02-13 19:48:37 +00001799 std::vector<uint64_t> InputFileOffsets;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00001800 for (const auto &Entry : SortedFiles) {
Douglas Gregor49491f72013-03-15 22:15:07 +00001801 uint32_t &InputFileID = InputFileIDs[Entry.File];
Argyrios Kyrtzidise65856f2012-12-11 07:48:08 +00001802 if (InputFileID != 0)
1803 continue; // already recorded this file.
1804
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001805 // Record this entry's offset.
1806 InputFileOffsets.push_back(Stream.GetCurrentBitNo());
Argyrios Kyrtzidise65856f2012-12-11 07:48:08 +00001807
1808 InputFileID = InputFileOffsets.size();
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001809
Douglas Gregor49491f72013-03-15 22:15:07 +00001810 if (!Entry.IsSystemFile)
Argyrios Kyrtzidis7d238572013-03-06 18:12:50 +00001811 ++UserFilesNum;
1812
Douglas Gregor72be3902012-10-19 00:38:02 +00001813 // Emit size/modification time for this file.
Mehdi Amini57a41912015-09-10 01:46:39 +00001814 // And whether this file was overridden.
1815 RecordData::value_type Record[] = {
Richard Smitha8cfffa2015-11-26 02:04:16 +00001816 INPUT_FILE,
1817 InputFileOffsets.size(),
1818 (uint64_t)Entry.File->getSize(),
1819 (uint64_t)getTimestampForOutput(Entry.File),
1820 Entry.BufferOverridden,
Richard Smithf3f84612017-06-29 02:19:42 +00001821 Entry.IsTransient,
1822 Entry.IsTopLevelModuleMap};
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001823
Richard Smith7ed1bc92014-12-05 22:42:13 +00001824 EmitRecordWithPath(IFAbbrevCode, Record, Entry.File->getName());
1825 }
Douglas Gregor49491f72013-03-15 22:15:07 +00001826
Douglas Gregor112b9072012-10-18 05:31:06 +00001827 Stream.ExitBlock();
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001828
1829 // Create input file offsets abbreviation.
David Blaikieb44f0bf2017-01-04 22:36:43 +00001830 auto OffsetsAbbrev = std::make_shared<BitCodeAbbrev>();
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001831 OffsetsAbbrev->Add(BitCodeAbbrevOp(INPUT_FILE_OFFSETS));
1832 OffsetsAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // # input files
Argyrios Kyrtzidis7d238572013-03-06 18:12:50 +00001833 OffsetsAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // # non-system
1834 // input files
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001835 OffsetsAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Array
David Blaikieb44f0bf2017-01-04 22:36:43 +00001836 unsigned OffsetsAbbrevCode = Stream.EmitAbbrev(std::move(OffsetsAbbrev));
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001837
1838 // Write input file offsets.
Mehdi Amini57a41912015-09-10 01:46:39 +00001839 RecordData::value_type Record[] = {INPUT_FILE_OFFSETS,
1840 InputFileOffsets.size(), UserFilesNum};
Reid Kleckner012665e2015-05-21 00:13:09 +00001841 Stream.EmitRecordWithBlob(OffsetsAbbrevCode, Record, bytes(InputFileOffsets));
Douglas Gregor55abb232009-04-10 20:39:37 +00001842}
1843
Douglas Gregora7f71a92009-04-10 03:52:48 +00001844//===----------------------------------------------------------------------===//
1845// Source Manager Serialization
1846//===----------------------------------------------------------------------===//
1847
1848/// \brief Create an abbreviation for the SLocEntry that refers to a
1849/// file.
Douglas Gregor8f45df52009-04-16 22:23:12 +00001850static unsigned CreateSLocFileAbbrev(llvm::BitstreamWriter &Stream) {
Douglas Gregora7f71a92009-04-10 03:52:48 +00001851 using namespace llvm;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00001852
David Blaikieb44f0bf2017-01-04 22:36:43 +00001853 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Sebastian Redl539c5062010-08-18 23:57:32 +00001854 Abbrev->Add(BitCodeAbbrevOp(SM_SLOC_FILE_ENTRY));
Douglas Gregora7f71a92009-04-10 03:52:48 +00001855 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Offset
1856 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Include location
Richard Smithf3f84612017-06-29 02:19:42 +00001857 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 3)); // Characteristic
Douglas Gregora7f71a92009-04-10 03:52:48 +00001858 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Line directives
Douglas Gregorb41ca8f2010-03-21 22:49:54 +00001859 // FileEntry fields.
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001860 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Input File ID
Argyrios Kyrtzidis61ef3db2011-08-21 23:33:04 +00001861 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // NumCreatedFIDs
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00001862 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 24)); // FirstDeclIndex
1863 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // NumDecls
David Blaikieb44f0bf2017-01-04 22:36:43 +00001864 return Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregora7f71a92009-04-10 03:52:48 +00001865}
1866
1867/// \brief Create an abbreviation for the SLocEntry that refers to a
1868/// buffer.
Douglas Gregor8f45df52009-04-16 22:23:12 +00001869static unsigned CreateSLocBufferAbbrev(llvm::BitstreamWriter &Stream) {
Douglas Gregora7f71a92009-04-10 03:52:48 +00001870 using namespace llvm;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00001871
David Blaikieb44f0bf2017-01-04 22:36:43 +00001872 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Sebastian Redl539c5062010-08-18 23:57:32 +00001873 Abbrev->Add(BitCodeAbbrevOp(SM_SLOC_BUFFER_ENTRY));
Douglas Gregora7f71a92009-04-10 03:52:48 +00001874 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Offset
1875 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Include location
Richard Smithf3f84612017-06-29 02:19:42 +00001876 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 3)); // Characteristic
Douglas Gregora7f71a92009-04-10 03:52:48 +00001877 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Line directives
1878 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Buffer name blob
David Blaikieb44f0bf2017-01-04 22:36:43 +00001879 return Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregora7f71a92009-04-10 03:52:48 +00001880}
1881
1882/// \brief Create an abbreviation for the SLocEntry that refers to a
1883/// buffer's blob.
Richard Smithaada85c2016-02-06 02:06:43 +00001884static unsigned CreateSLocBufferBlobAbbrev(llvm::BitstreamWriter &Stream,
1885 bool Compressed) {
Douglas Gregora7f71a92009-04-10 03:52:48 +00001886 using namespace llvm;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00001887
David Blaikieb44f0bf2017-01-04 22:36:43 +00001888 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Richard Smithaada85c2016-02-06 02:06:43 +00001889 Abbrev->Add(BitCodeAbbrevOp(Compressed ? SM_SLOC_BUFFER_BLOB_COMPRESSED
1890 : SM_SLOC_BUFFER_BLOB));
1891 if (Compressed)
1892 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Uncompressed size
Douglas Gregora7f71a92009-04-10 03:52:48 +00001893 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Blob
David Blaikieb44f0bf2017-01-04 22:36:43 +00001894 return Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregora7f71a92009-04-10 03:52:48 +00001895}
1896
Chandler Carruthf92ac9e2011-07-15 07:25:21 +00001897/// \brief Create an abbreviation for the SLocEntry that refers to a macro
1898/// expansion.
1899static unsigned CreateSLocExpansionAbbrev(llvm::BitstreamWriter &Stream) {
Douglas Gregora7f71a92009-04-10 03:52:48 +00001900 using namespace llvm;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00001901
David Blaikieb44f0bf2017-01-04 22:36:43 +00001902 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Chandler Carruthf92ac9e2011-07-15 07:25:21 +00001903 Abbrev->Add(BitCodeAbbrevOp(SM_SLOC_EXPANSION_ENTRY));
Douglas Gregora7f71a92009-04-10 03:52:48 +00001904 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Offset
1905 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Spelling location
1906 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Start location
1907 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // End location
Douglas Gregor83243272009-04-15 18:05:10 +00001908 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Token length
David Blaikieb44f0bf2017-01-04 22:36:43 +00001909 return Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregora7f71a92009-04-10 03:52:48 +00001910}
1911
Douglas Gregor09b69892011-02-10 17:09:37 +00001912namespace {
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +00001913
Douglas Gregor09b69892011-02-10 17:09:37 +00001914 // Trait used for the on-disk hash table of header search information.
1915 class HeaderFileInfoTrait {
1916 ASTWriter &Writer;
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00001917
Douglas Gregor4b123cb2011-07-28 04:50:02 +00001918 // Keep track of the framework names we've used during serialization.
1919 SmallVector<char, 128> FrameworkStringData;
1920 llvm::StringMap<unsigned> FrameworkNameOffset;
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00001921
Douglas Gregor09b69892011-02-10 17:09:37 +00001922 public:
Richard Smith040e1262017-06-02 01:55:39 +00001923 HeaderFileInfoTrait(ASTWriter &Writer) : Writer(Writer) {}
1924
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +00001925 struct key_type {
Mehdi Amini004b9c72016-10-10 22:52:47 +00001926 StringRef Filename;
Richard Smith040e1262017-06-02 01:55:39 +00001927 off_t Size;
1928 time_t ModTime;
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +00001929 };
Eugene Zelenkob7d89102017-11-11 00:08:50 +00001930 using key_type_ref = const key_type &;
Richard Smith040e1262017-06-02 01:55:39 +00001931
1932 using UnresolvedModule =
1933 llvm::PointerIntPair<Module *, 2, ModuleMap::ModuleHeaderRole>;
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00001934
Richard Smith040e1262017-06-02 01:55:39 +00001935 struct data_type {
1936 const HeaderFileInfo &HFI;
1937 ArrayRef<ModuleMap::KnownHeader> KnownHeaders;
1938 UnresolvedModule Unresolved;
1939 };
Eugene Zelenkob7d89102017-11-11 00:08:50 +00001940 using data_type_ref = const data_type &;
Richard Smith040e1262017-06-02 01:55:39 +00001941
Eugene Zelenkob7d89102017-11-11 00:08:50 +00001942 using hash_value_type = unsigned;
1943 using offset_type = unsigned;
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00001944
Richard Smithe75ee0f2015-08-17 07:13:32 +00001945 hash_value_type ComputeHash(key_type_ref key) {
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +00001946 // The hash is based only on size/time of the file, so that the reader can
1947 // match even when symlinking or excess path elements ("foo/../", "../")
1948 // change the form of the name. However, complete path is still the key.
Richard Smith040e1262017-06-02 01:55:39 +00001949 return llvm::hash_combine(key.Size, key.ModTime);
Douglas Gregor09b69892011-02-10 17:09:37 +00001950 }
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00001951
Eugene Zelenkob7d89102017-11-11 00:08:50 +00001952 std::pair<unsigned, unsigned>
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +00001953 EmitKeyDataLength(raw_ostream& Out, key_type_ref key, data_type_ref Data) {
Justin Bognere1c147c2014-03-28 22:03:19 +00001954 using namespace llvm::support;
Eugene Zelenkob7d89102017-11-11 00:08:50 +00001955
Richard Smith386bb072015-08-18 23:42:23 +00001956 endian::Writer<little> LE(Out);
Mehdi Amini004b9c72016-10-10 22:52:47 +00001957 unsigned KeyLen = key.Filename.size() + 1 + 8 + 8;
Richard Smith386bb072015-08-18 23:42:23 +00001958 LE.write<uint16_t>(KeyLen);
Douglas Gregor4b123cb2011-07-28 04:50:02 +00001959 unsigned DataLen = 1 + 2 + 4 + 4;
Richard Smith040e1262017-06-02 01:55:39 +00001960 for (auto ModInfo : Data.KnownHeaders)
Richard Smith386bb072015-08-18 23:42:23 +00001961 if (Writer.getLocalOrImportedSubmoduleID(ModInfo.getModule()))
1962 DataLen += 4;
Richard Smith040e1262017-06-02 01:55:39 +00001963 if (Data.Unresolved.getPointer())
1964 DataLen += 4;
Richard Smith386bb072015-08-18 23:42:23 +00001965 LE.write<uint8_t>(DataLen);
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +00001966 return std::make_pair(KeyLen, DataLen);
Douglas Gregor09b69892011-02-10 17:09:37 +00001967 }
Richard Smith040e1262017-06-02 01:55:39 +00001968
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +00001969 void EmitKey(raw_ostream& Out, key_type_ref key, unsigned KeyLen) {
Justin Bognere1c147c2014-03-28 22:03:19 +00001970 using namespace llvm::support;
Eugene Zelenkob7d89102017-11-11 00:08:50 +00001971
Justin Bognere1c147c2014-03-28 22:03:19 +00001972 endian::Writer<little> LE(Out);
Richard Smith040e1262017-06-02 01:55:39 +00001973 LE.write<uint64_t>(key.Size);
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +00001974 KeyLen -= 8;
Richard Smith040e1262017-06-02 01:55:39 +00001975 LE.write<uint64_t>(key.ModTime);
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +00001976 KeyLen -= 8;
Mehdi Amini004b9c72016-10-10 22:52:47 +00001977 Out.write(key.Filename.data(), KeyLen);
Douglas Gregor09b69892011-02-10 17:09:37 +00001978 }
Richard Smith040e1262017-06-02 01:55:39 +00001979
Argyrios Kyrtzidisb146baa2013-03-13 21:13:51 +00001980 void EmitData(raw_ostream &Out, key_type_ref key,
Douglas Gregor09b69892011-02-10 17:09:37 +00001981 data_type_ref Data, unsigned DataLen) {
Justin Bognere1c147c2014-03-28 22:03:19 +00001982 using namespace llvm::support;
Eugene Zelenkob7d89102017-11-11 00:08:50 +00001983
Justin Bognere1c147c2014-03-28 22:03:19 +00001984 endian::Writer<little> LE(Out);
Douglas Gregor09b69892011-02-10 17:09:37 +00001985 uint64_t Start = Out.tell(); (void)Start;
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00001986
Richard Smithf3f84612017-06-29 02:19:42 +00001987 unsigned char Flags = (Data.HFI.isImport << 5)
1988 | (Data.HFI.isPragmaOnce << 4)
Richard Smith040e1262017-06-02 01:55:39 +00001989 | (Data.HFI.DirInfo << 1)
1990 | Data.HFI.IndexHeaderMapHeader;
Justin Bognere1c147c2014-03-28 22:03:19 +00001991 LE.write<uint8_t>(Flags);
Richard Smith040e1262017-06-02 01:55:39 +00001992 LE.write<uint16_t>(Data.HFI.NumIncludes);
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00001993
Richard Smith040e1262017-06-02 01:55:39 +00001994 if (!Data.HFI.ControllingMacro)
1995 LE.write<uint32_t>(Data.HFI.ControllingMacroID);
Douglas Gregor09b69892011-02-10 17:09:37 +00001996 else
Richard Smith040e1262017-06-02 01:55:39 +00001997 LE.write<uint32_t>(Writer.getIdentifierRef(Data.HFI.ControllingMacro));
1998
Douglas Gregor4b123cb2011-07-28 04:50:02 +00001999 unsigned Offset = 0;
Richard Smith040e1262017-06-02 01:55:39 +00002000 if (!Data.HFI.Framework.empty()) {
Douglas Gregor4b123cb2011-07-28 04:50:02 +00002001 // If this header refers into a framework, save the framework name.
2002 llvm::StringMap<unsigned>::iterator Pos
Richard Smith040e1262017-06-02 01:55:39 +00002003 = FrameworkNameOffset.find(Data.HFI.Framework);
Douglas Gregor4b123cb2011-07-28 04:50:02 +00002004 if (Pos == FrameworkNameOffset.end()) {
2005 Offset = FrameworkStringData.size() + 1;
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00002006 FrameworkStringData.append(Data.HFI.Framework.begin(),
Richard Smith040e1262017-06-02 01:55:39 +00002007 Data.HFI.Framework.end());
Douglas Gregor4b123cb2011-07-28 04:50:02 +00002008 FrameworkStringData.push_back(0);
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00002009
Richard Smith040e1262017-06-02 01:55:39 +00002010 FrameworkNameOffset[Data.HFI.Framework] = Offset;
Douglas Gregor4b123cb2011-07-28 04:50:02 +00002011 } else
2012 Offset = Pos->second;
2013 }
Justin Bognere1c147c2014-03-28 22:03:19 +00002014 LE.write<uint32_t>(Offset);
Argyrios Kyrtzidisb146baa2013-03-13 21:13:51 +00002015
Richard Smith040e1262017-06-02 01:55:39 +00002016 auto EmitModule = [&](Module *M, ModuleMap::ModuleHeaderRole Role) {
2017 if (uint32_t ModID = Writer.getLocalOrImportedSubmoduleID(M)) {
2018 uint32_t Value = (ModID << 2) | (unsigned)Role;
Richard Smith386bb072015-08-18 23:42:23 +00002019 assert((Value >> 2) == ModID && "overflow in header module info");
2020 LE.write<uint32_t>(Value);
2021 }
Richard Smith040e1262017-06-02 01:55:39 +00002022 };
2023
2024 // FIXME: If the header is excluded, we should write out some
2025 // record of that fact.
2026 for (auto ModInfo : Data.KnownHeaders)
2027 EmitModule(ModInfo.getModule(), ModInfo.getRole());
2028 if (Data.Unresolved.getPointer())
2029 EmitModule(Data.Unresolved.getPointer(), Data.Unresolved.getInt());
Argyrios Kyrtzidisb146baa2013-03-13 21:13:51 +00002030
Douglas Gregor09b69892011-02-10 17:09:37 +00002031 assert(Out.tell() - Start == DataLen && "Wrong data length");
2032 }
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00002033
Douglas Gregor4b123cb2011-07-28 04:50:02 +00002034 const char *strings_begin() const { return FrameworkStringData.begin(); }
2035 const char *strings_end() const { return FrameworkStringData.end(); }
Douglas Gregor09b69892011-02-10 17:09:37 +00002036 };
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +00002037
Eugene Zelenkob7d89102017-11-11 00:08:50 +00002038} // namespace
Douglas Gregor09b69892011-02-10 17:09:37 +00002039
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00002040/// \brief Write the header search block for the list of files that
Douglas Gregor09b69892011-02-10 17:09:37 +00002041///
2042/// \param HS The header search structure to save.
Richard Smith7ed1bc92014-12-05 22:42:13 +00002043void ASTWriter::WriteHeaderSearch(const HeaderSearch &HS) {
Richard Smith040e1262017-06-02 01:55:39 +00002044 HeaderFileInfoTrait GeneratorTrait(*this);
2045 llvm::OnDiskChainedHashTableGenerator<HeaderFileInfoTrait> Generator;
2046 SmallVector<const char *, 4> SavedStrings;
2047 unsigned NumHeaderSearchEntries = 0;
2048
2049 // Find all unresolved headers for the current module. We generally will
2050 // have resolved them before we get here, but not necessarily: we might be
2051 // compiling a preprocessed module, where there is no requirement for the
2052 // original files to exist any more.
Benjamin Krameree021d52017-06-02 17:30:24 +00002053 const HeaderFileInfo Empty; // So we can take a reference.
Richard Smith040e1262017-06-02 01:55:39 +00002054 if (WritingModule) {
2055 llvm::SmallVector<Module *, 16> Worklist(1, WritingModule);
2056 while (!Worklist.empty()) {
2057 Module *M = Worklist.pop_back_val();
2058 if (!M->isAvailable())
2059 continue;
2060
2061 // Map to disk files where possible, to pick up any missing stat
2062 // information. This also means we don't need to check the unresolved
2063 // headers list when emitting resolved headers in the first loop below.
2064 // FIXME: It'd be preferable to avoid doing this if we were given
2065 // sufficient stat information in the module map.
2066 HS.getModuleMap().resolveHeaderDirectives(M);
2067
2068 // If the file didn't exist, we can still create a module if we were given
2069 // enough information in the module map.
2070 for (auto U : M->MissingHeaders) {
2071 // Check that we were given enough information to build a module
2072 // without this file existing on disk.
2073 if (!U.Size || (!U.ModTime && IncludeTimestamps)) {
2074 PP->Diag(U.FileNameLoc, diag::err_module_no_size_mtime_for_header)
2075 << WritingModule->getFullModuleName() << U.Size.hasValue()
2076 << U.FileName;
2077 continue;
2078 }
2079
2080 // Form the effective relative pathname for the file.
2081 SmallString<128> Filename(M->Directory->getName());
2082 llvm::sys::path::append(Filename, U.FileName);
2083 PreparePathForOutput(Filename);
2084
2085 StringRef FilenameDup = strdup(Filename.c_str());
2086 SavedStrings.push_back(FilenameDup.data());
2087
2088 HeaderFileInfoTrait::key_type Key = {
2089 FilenameDup, *U.Size, IncludeTimestamps ? *U.ModTime : 0
2090 };
2091 HeaderFileInfoTrait::data_type Data = {
Benjamin Krameree021d52017-06-02 17:30:24 +00002092 Empty, {}, {M, ModuleMap::headerKindToRole(U.Kind)}
Richard Smith040e1262017-06-02 01:55:39 +00002093 };
2094 // FIXME: Deal with cases where there are multiple unresolved header
2095 // directives in different submodules for the same header.
2096 Generator.insert(Key, Data, GeneratorTrait);
2097 ++NumHeaderSearchEntries;
2098 }
2099
2100 Worklist.append(M->submodule_begin(), M->submodule_end());
2101 }
2102 }
2103
Chris Lattner0e62c1c2011-07-23 10:55:15 +00002104 SmallVector<const FileEntry *, 16> FilesByUID;
Douglas Gregor09b69892011-02-10 17:09:37 +00002105 HS.getFileMgr().GetUniqueIDMapping(FilesByUID);
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00002106
Douglas Gregor09b69892011-02-10 17:09:37 +00002107 if (FilesByUID.size() > HS.header_file_size())
2108 FilesByUID.resize(HS.header_file_size());
Richard Smith040e1262017-06-02 01:55:39 +00002109
Douglas Gregor09b69892011-02-10 17:09:37 +00002110 for (unsigned UID = 0, LastUID = FilesByUID.size(); UID != LastUID; ++UID) {
2111 const FileEntry *File = FilesByUID[UID];
2112 if (!File)
2113 continue;
2114
Richard Smith386bb072015-08-18 23:42:23 +00002115 // Get the file info. This will load info from the external source if
2116 // necessary. Skip emitting this file if we have no information on it
2117 // as a header file (in which case HFI will be null) or if it hasn't
2118 // changed since it was loaded. Also skip it if it's for a modular header
2119 // from a different module; in that case, we rely on the module(s)
2120 // containing the header to provide this information.
Richard Smithd8879c82015-08-24 21:59:32 +00002121 const HeaderFileInfo *HFI =
2122 HS.getExistingFileInfo(File, /*WantExternal*/!Chain);
2123 if (!HFI || (HFI->isModuleHeader && !HFI->isCompilingModuleHeader))
Argyrios Kyrtzidis6f722b42013-05-08 23:46:46 +00002124 continue;
Douglas Gregor09b69892011-02-10 17:09:37 +00002125
Richard Smith7ed1bc92014-12-05 22:42:13 +00002126 // Massage the file path into an appropriate form.
Mehdi Amini004b9c72016-10-10 22:52:47 +00002127 StringRef Filename = File->getName();
Richard Smith7ed1bc92014-12-05 22:42:13 +00002128 SmallString<128> FilenameTmp(Filename);
2129 if (PreparePathForOutput(FilenameTmp)) {
2130 // If we performed any translation on the file name at all, we need to
2131 // save this string, since the generator will refer to it later.
Mehdi Amini004b9c72016-10-10 22:52:47 +00002132 Filename = StringRef(strdup(FilenameTmp.c_str()));
2133 SavedStrings.push_back(Filename.data());
Douglas Gregor09b69892011-02-10 17:09:37 +00002134 }
Richard Smith7ed1bc92014-12-05 22:42:13 +00002135
Richard Smith040e1262017-06-02 01:55:39 +00002136 HeaderFileInfoTrait::key_type Key = {
2137 Filename, File->getSize(), getTimestampForOutput(File)
2138 };
2139 HeaderFileInfoTrait::data_type Data = {
2140 *HFI, HS.getModuleMap().findAllModulesForHeader(File), {}
2141 };
2142 Generator.insert(Key, Data, GeneratorTrait);
Douglas Gregor09b69892011-02-10 17:09:37 +00002143 ++NumHeaderSearchEntries;
2144 }
Richard Smith040e1262017-06-02 01:55:39 +00002145
Douglas Gregor09b69892011-02-10 17:09:37 +00002146 // Create the on-disk hash table in a buffer.
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00002147 SmallString<4096> TableData;
Douglas Gregor09b69892011-02-10 17:09:37 +00002148 uint32_t BucketOffset;
2149 {
Justin Bognere1c147c2014-03-28 22:03:19 +00002150 using namespace llvm::support;
Eugene Zelenkob7d89102017-11-11 00:08:50 +00002151
Douglas Gregor09b69892011-02-10 17:09:37 +00002152 llvm::raw_svector_ostream Out(TableData);
2153 // Make sure that no bucket is at offset 0
Justin Bognere1c147c2014-03-28 22:03:19 +00002154 endian::Writer<little>(Out).write<uint32_t>(0);
Douglas Gregor09b69892011-02-10 17:09:37 +00002155 BucketOffset = Generator.Emit(Out, GeneratorTrait);
2156 }
2157
2158 // Create a blob abbreviation
2159 using namespace llvm;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002160
David Blaikieb44f0bf2017-01-04 22:36:43 +00002161 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Douglas Gregor09b69892011-02-10 17:09:37 +00002162 Abbrev->Add(BitCodeAbbrevOp(HEADER_SEARCH_TABLE));
2163 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
2164 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
Douglas Gregor4b123cb2011-07-28 04:50:02 +00002165 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
Douglas Gregor09b69892011-02-10 17:09:37 +00002166 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
David Blaikieb44f0bf2017-01-04 22:36:43 +00002167 unsigned TableAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00002168
Douglas Gregor4b123cb2011-07-28 04:50:02 +00002169 // Write the header search table
Mehdi Amini57a41912015-09-10 01:46:39 +00002170 RecordData::value_type Record[] = {HEADER_SEARCH_TABLE, BucketOffset,
2171 NumHeaderSearchEntries, TableData.size()};
Douglas Gregor4b123cb2011-07-28 04:50:02 +00002172 TableData.append(GeneratorTrait.strings_begin(),GeneratorTrait.strings_end());
Yaron Keren92e1b622015-03-18 10:17:07 +00002173 Stream.EmitRecordWithBlob(TableAbbrev, Record, TableData);
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00002174
Douglas Gregor09b69892011-02-10 17:09:37 +00002175 // Free all of the strings we had to duplicate.
2176 for (unsigned I = 0, N = SavedStrings.size(); I != N; ++I)
David Greenebae0e352013-01-15 22:09:43 +00002177 free(const_cast<char *>(SavedStrings[I]));
Douglas Gregor09b69892011-02-10 17:09:37 +00002178}
2179
George Rimarc39f5492017-01-17 15:45:31 +00002180static void emitBlob(llvm::BitstreamWriter &Stream, StringRef Blob,
2181 unsigned SLocBufferBlobCompressedAbbrv,
2182 unsigned SLocBufferBlobAbbrv) {
Eugene Zelenkob7d89102017-11-11 00:08:50 +00002183 using RecordDataType = ASTWriter::RecordData::value_type;
George Rimarc39f5492017-01-17 15:45:31 +00002184
2185 // Compress the buffer if possible. We expect that almost all PCM
2186 // consumers will not want its contents.
2187 SmallString<0> CompressedBuffer;
2188 if (llvm::zlib::isAvailable()) {
2189 llvm::Error E = llvm::zlib::compress(Blob.drop_back(1), CompressedBuffer);
2190 if (!E) {
2191 RecordDataType Record[] = {SM_SLOC_BUFFER_BLOB_COMPRESSED,
2192 Blob.size() - 1};
2193 Stream.EmitRecordWithBlob(SLocBufferBlobCompressedAbbrv, Record,
2194 CompressedBuffer);
2195 return;
2196 }
2197 llvm::consumeError(std::move(E));
2198 }
2199
2200 RecordDataType Record[] = {SM_SLOC_BUFFER_BLOB};
2201 Stream.EmitRecordWithBlob(SLocBufferBlobAbbrv, Record, Blob);
2202}
2203
Douglas Gregora7f71a92009-04-10 03:52:48 +00002204/// \brief Writes the block containing the serialized form of the
2205/// source manager.
2206///
2207/// TODO: We should probably use an on-disk hash table (stored in a
2208/// blob), indexed based on the file name, so that we only create
2209/// entries for files that we actually need. In the common case (no
2210/// errors), we probably won't have to create file entries for any of
2211/// the files in the AST.
Sebastian Redl55c0ad52010-08-18 23:56:21 +00002212void ASTWriter::WriteSourceManagerBlock(SourceManager &SourceMgr,
Richard Smith7ed1bc92014-12-05 22:42:13 +00002213 const Preprocessor &PP) {
Douglas Gregor258ae542009-04-27 06:38:32 +00002214 RecordData Record;
2215
Chris Lattner0910e3b2009-04-10 17:16:57 +00002216 // Enter the source manager block.
Richard Smithaada85c2016-02-06 02:06:43 +00002217 Stream.EnterSubblock(SOURCE_MANAGER_BLOCK_ID, 4);
Douglas Gregora7f71a92009-04-10 03:52:48 +00002218
2219 // Abbreviations for the various kinds of source-location entries.
Chris Lattnerc4976c732009-04-27 19:03:22 +00002220 unsigned SLocFileAbbrv = CreateSLocFileAbbrev(Stream);
2221 unsigned SLocBufferAbbrv = CreateSLocBufferAbbrev(Stream);
Richard Smithaada85c2016-02-06 02:06:43 +00002222 unsigned SLocBufferBlobAbbrv = CreateSLocBufferBlobAbbrev(Stream, false);
2223 unsigned SLocBufferBlobCompressedAbbrv =
2224 CreateSLocBufferBlobAbbrev(Stream, true);
Chandler Carruthf92ac9e2011-07-15 07:25:21 +00002225 unsigned SLocExpansionAbbrv = CreateSLocExpansionAbbrev(Stream);
Douglas Gregora7f71a92009-04-10 03:52:48 +00002226
Douglas Gregor258ae542009-04-27 06:38:32 +00002227 // Write out the source location entry table. We skip the first
2228 // entry, which is always the same dummy entry.
Chris Lattner12d61d32009-04-27 19:01:47 +00002229 std::vector<uint32_t> SLocEntryOffsets;
Douglas Gregor258ae542009-04-27 06:38:32 +00002230 RecordData PreloadSLocs;
Douglas Gregor925296b2011-07-19 16:10:42 +00002231 SLocEntryOffsets.reserve(SourceMgr.local_sloc_entry_size() - 1);
2232 for (unsigned I = 1, N = SourceMgr.local_sloc_entry_size();
Sebastian Redl5c415f32010-07-22 17:01:13 +00002233 I != N; ++I) {
Douglas Gregor8655e882009-10-16 22:46:09 +00002234 // Get this source location entry.
Douglas Gregor925296b2011-07-19 16:10:42 +00002235 const SrcMgr::SLocEntry *SLoc = &SourceMgr.getLocalSLocEntry(I);
Argyrios Kyrtzidis4db774a2012-10-02 21:09:17 +00002236 FileID FID = FileID::get(I);
2237 assert(&SourceMgr.getSLocEntry(FID) == SLoc);
Kovarththanan Rajaratnama9c81a82010-03-14 07:06:50 +00002238
Douglas Gregor258ae542009-04-27 06:38:32 +00002239 // Record the offset of this source-location entry.
2240 SLocEntryOffsets.push_back(Stream.GetCurrentBitNo());
2241
2242 // Figure out which record code to use.
2243 unsigned Code;
2244 if (SLoc->isFile()) {
Douglas Gregor9dc32122011-11-16 20:05:18 +00002245 const SrcMgr::ContentCache *Cache = SLoc->getFile().getContentCache();
2246 if (Cache->OrigEntry) {
Sebastian Redl539c5062010-08-18 23:57:32 +00002247 Code = SM_SLOC_FILE_ENTRY;
Argyrios Kyrtzidis92dd4662011-06-02 20:01:46 +00002248 } else
Sebastian Redl539c5062010-08-18 23:57:32 +00002249 Code = SM_SLOC_BUFFER_ENTRY;
Douglas Gregor258ae542009-04-27 06:38:32 +00002250 } else
Chandler Carruthf92ac9e2011-07-15 07:25:21 +00002251 Code = SM_SLOC_EXPANSION_ENTRY;
Douglas Gregor258ae542009-04-27 06:38:32 +00002252 Record.clear();
2253 Record.push_back(Code);
2254
Douglas Gregor925296b2011-07-19 16:10:42 +00002255 // Starting offset of this entry within this module, so skip the dummy.
2256 Record.push_back(SLoc->getOffset() - 2);
Douglas Gregor258ae542009-04-27 06:38:32 +00002257 if (SLoc->isFile()) {
2258 const SrcMgr::FileInfo &File = SLoc->getFile();
Richard Smithb22a1d12016-03-27 20:13:24 +00002259 AddSourceLocation(File.getIncludeLoc(), Record);
Douglas Gregor258ae542009-04-27 06:38:32 +00002260 Record.push_back(File.getFileCharacteristic()); // FIXME: stable encoding
2261 Record.push_back(File.hasLineDirectives());
2262
2263 const SrcMgr::ContentCache *Content = File.getContentCache();
Richard Smithaada85c2016-02-06 02:06:43 +00002264 bool EmitBlob = false;
Argyrios Kyrtzidis11e6f0a2011-03-05 01:03:53 +00002265 if (Content->OrigEntry) {
2266 assert(Content->OrigEntry == Content->ContentsEntry &&
Douglas Gregor9dc32122011-11-16 20:05:18 +00002267 "Writing to AST an overridden file is not supported");
Argyrios Kyrtzidis11e6f0a2011-03-05 01:03:53 +00002268
Douglas Gregor3120d2c2012-10-22 18:42:04 +00002269 // The source location entry is a file. Emit input file ID.
2270 assert(InputFileIDs[Content->OrigEntry] != 0 && "Missed file entry");
2271 Record.push_back(InputFileIDs[Content->OrigEntry]);
Mike Stump11289f42009-09-09 15:08:12 +00002272
Argyrios Kyrtzidis61ef3db2011-08-21 23:33:04 +00002273 Record.push_back(File.NumCreatedFIDs);
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00002274
Argyrios Kyrtzidis4db774a2012-10-02 21:09:17 +00002275 FileDeclIDsTy::iterator FDI = FileDeclIDs.find(FID);
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00002276 if (FDI != FileDeclIDs.end()) {
2277 Record.push_back(FDI->second->FirstDeclIndex);
2278 Record.push_back(FDI->second->DeclIDs.size());
2279 } else {
2280 Record.push_back(0);
2281 Record.push_back(0);
2282 }
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00002283
Mehdi Amini5ae4a852015-09-09 20:35:37 +00002284 Stream.EmitRecordWithAbbrev(SLocFileAbbrv, Record);
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00002285
Richard Smithaada85c2016-02-06 02:06:43 +00002286 if (Content->BufferOverridden || Content->IsTransient)
2287 EmitBlob = true;
Douglas Gregor258ae542009-04-27 06:38:32 +00002288 } else {
2289 // The source location entry is a buffer. The blob associated
2290 // with this entry contains the contents of the buffer.
2291
2292 // We add one to the size so that we capture the trailing NULL
2293 // that is required by llvm::MemoryBuffer::getMemBuffer (on
2294 // the reader side).
Douglas Gregor874cc622010-03-16 00:35:39 +00002295 const llvm::MemoryBuffer *Buffer
Chris Lattnerfb24a3a2010-04-20 20:35:58 +00002296 = Content->getBuffer(PP.getDiagnostics(), PP.getSourceManager());
Mehdi Amini99d1b292016-10-01 16:38:28 +00002297 StringRef Name = Buffer->getBufferIdentifier();
Mehdi Amini5ae4a852015-09-09 20:35:37 +00002298 Stream.EmitRecordWithBlob(SLocBufferAbbrv, Record,
Mehdi Amini99d1b292016-10-01 16:38:28 +00002299 StringRef(Name.data(), Name.size() + 1));
Richard Smithaada85c2016-02-06 02:06:43 +00002300 EmitBlob = true;
Douglas Gregor258ae542009-04-27 06:38:32 +00002301
Mehdi Amini99d1b292016-10-01 16:38:28 +00002302 if (Name == "<built-in>")
Douglas Gregor925296b2011-07-19 16:10:42 +00002303 PreloadSLocs.push_back(SLocEntryOffsets.size());
Douglas Gregor258ae542009-04-27 06:38:32 +00002304 }
Richard Smithaada85c2016-02-06 02:06:43 +00002305
2306 if (EmitBlob) {
2307 // Include the implicit terminating null character in the on-disk buffer
2308 // if we're writing it uncompressed.
2309 const llvm::MemoryBuffer *Buffer =
2310 Content->getBuffer(PP.getDiagnostics(), PP.getSourceManager());
2311 StringRef Blob(Buffer->getBufferStart(), Buffer->getBufferSize() + 1);
George Rimarc39f5492017-01-17 15:45:31 +00002312 emitBlob(Stream, Blob, SLocBufferBlobCompressedAbbrv,
2313 SLocBufferBlobAbbrv);
Richard Smithaada85c2016-02-06 02:06:43 +00002314 }
Douglas Gregor258ae542009-04-27 06:38:32 +00002315 } else {
Chandler Carruthf92ac9e2011-07-15 07:25:21 +00002316 // The source location entry is a macro expansion.
Chandler Carruthee4c1d12011-07-26 04:56:51 +00002317 const SrcMgr::ExpansionInfo &Expansion = SLoc->getExpansion();
Richard Smithb22a1d12016-03-27 20:13:24 +00002318 AddSourceLocation(Expansion.getSpellingLoc(), Record);
2319 AddSourceLocation(Expansion.getExpansionLocStart(), Record);
2320 AddSourceLocation(Expansion.isMacroArgExpansion()
2321 ? SourceLocation()
2322 : Expansion.getExpansionLocEnd(),
2323 Record);
Douglas Gregor258ae542009-04-27 06:38:32 +00002324
2325 // Compute the token length for this macro expansion.
Douglas Gregor925296b2011-07-19 16:10:42 +00002326 unsigned NextOffset = SourceMgr.getNextLocalOffset();
Douglas Gregor8655e882009-10-16 22:46:09 +00002327 if (I + 1 != N)
Douglas Gregor925296b2011-07-19 16:10:42 +00002328 NextOffset = SourceMgr.getLocalSLocEntry(I + 1).getOffset();
Douglas Gregor258ae542009-04-27 06:38:32 +00002329 Record.push_back(NextOffset - SLoc->getOffset() - 1);
Mehdi Amini5ae4a852015-09-09 20:35:37 +00002330 Stream.EmitRecordWithAbbrev(SLocExpansionAbbrv, Record);
Douglas Gregor258ae542009-04-27 06:38:32 +00002331 }
2332 }
2333
Douglas Gregor8f45df52009-04-16 22:23:12 +00002334 Stream.ExitBlock();
Douglas Gregor258ae542009-04-27 06:38:32 +00002335
2336 if (SLocEntryOffsets.empty())
2337 return;
2338
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00002339 // Write the source-location offsets table into the AST block. This
Douglas Gregor258ae542009-04-27 06:38:32 +00002340 // table is used for lazily loading source-location information.
2341 using namespace llvm;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002342
David Blaikieb44f0bf2017-01-04 22:36:43 +00002343 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Sebastian Redl539c5062010-08-18 23:57:32 +00002344 Abbrev->Add(BitCodeAbbrevOp(SOURCE_LOCATION_OFFSETS));
Douglas Gregor258ae542009-04-27 06:38:32 +00002345 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 16)); // # of slocs
Douglas Gregor925296b2011-07-19 16:10:42 +00002346 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 16)); // total size
Douglas Gregor258ae542009-04-27 06:38:32 +00002347 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // offsets
David Blaikieb44f0bf2017-01-04 22:36:43 +00002348 unsigned SLocOffsetsAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Mehdi Amini57a41912015-09-10 01:46:39 +00002349 {
2350 RecordData::value_type Record[] = {
2351 SOURCE_LOCATION_OFFSETS, SLocEntryOffsets.size(),
2352 SourceMgr.getNextLocalOffset() - 1 /* skip dummy */};
2353 Stream.EmitRecordWithBlob(SLocOffsetsAbbrev, Record,
2354 bytes(SLocEntryOffsets));
2355 }
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00002356 // Write the source location entry preloads array, telling the AST
Douglas Gregor258ae542009-04-27 06:38:32 +00002357 // reader which source locations entries it should load eagerly.
Sebastian Redl539c5062010-08-18 23:57:32 +00002358 Stream.EmitRecord(SOURCE_LOCATION_PRELOADS, PreloadSLocs);
Douglas Gregor925296b2011-07-19 16:10:42 +00002359
2360 // Write the line table. It depends on remapping working, so it must come
2361 // after the source location offsets.
2362 if (SourceMgr.hasLineTable()) {
2363 LineTableInfo &LineTable = SourceMgr.getLineTable();
2364
2365 Record.clear();
Richard Smith63078492015-09-01 07:41:55 +00002366
2367 // Emit the needed file names.
2368 llvm::DenseMap<int, int> FilenameMap;
Hans Wennborg14487362017-12-04 22:28:45 +00002369 FilenameMap[-1] = -1; // For unspecified filenames.
Richard Smith63078492015-09-01 07:41:55 +00002370 for (const auto &L : LineTable) {
2371 if (L.first.ID < 0)
2372 continue;
2373 for (auto &LE : L.second) {
2374 if (FilenameMap.insert(std::make_pair(LE.FilenameID,
Hans Wennborg14487362017-12-04 22:28:45 +00002375 FilenameMap.size() - 1)).second)
Richard Smith63078492015-09-01 07:41:55 +00002376 AddPath(LineTable.getFilename(LE.FilenameID), Record);
2377 }
2378 }
2379 Record.push_back(0);
Douglas Gregor925296b2011-07-19 16:10:42 +00002380
2381 // Emit the line entries
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002382 for (const auto &L : LineTable) {
Douglas Gregor925296b2011-07-19 16:10:42 +00002383 // Only emit entries for local files.
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002384 if (L.first.ID < 0)
Douglas Gregor925296b2011-07-19 16:10:42 +00002385 continue;
2386
2387 // Emit the file ID
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002388 Record.push_back(L.first.ID);
Douglas Gregor925296b2011-07-19 16:10:42 +00002389
2390 // Emit the line entries
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002391 Record.push_back(L.second.size());
2392 for (const auto &LE : L.second) {
2393 Record.push_back(LE.FileOffset);
2394 Record.push_back(LE.LineNo);
2395 Record.push_back(FilenameMap[LE.FilenameID]);
2396 Record.push_back((unsigned)LE.FileKind);
2397 Record.push_back(LE.IncludeOffset);
Douglas Gregor925296b2011-07-19 16:10:42 +00002398 }
2399 }
Richard Smith63078492015-09-01 07:41:55 +00002400
Douglas Gregor925296b2011-07-19 16:10:42 +00002401 Stream.EmitRecord(SOURCE_MANAGER_LINE_TABLE, Record);
2402 }
Douglas Gregora7f71a92009-04-10 03:52:48 +00002403}
2404
Douglas Gregorc5046832009-04-27 18:38:38 +00002405//===----------------------------------------------------------------------===//
2406// Preprocessor Serialization
2407//===----------------------------------------------------------------------===//
2408
Argyrios Kyrtzidis0aef0f02013-03-15 22:43:10 +00002409static bool shouldIgnoreMacro(MacroDirective *MD, bool IsModule,
2410 const Preprocessor &PP) {
Argyrios Kyrtzidisb6210df2013-03-26 17:17:01 +00002411 if (MacroInfo *MI = MD->getMacroInfo())
2412 if (MI->isBuiltinMacro())
2413 return true;
Argyrios Kyrtzidis0aef0f02013-03-15 22:43:10 +00002414
2415 if (IsModule) {
2416 SourceLocation Loc = MD->getLocation();
2417 if (Loc.isInvalid())
2418 return true;
2419 if (PP.getSourceManager().getFileID(Loc) == PP.getPredefinesFileID())
2420 return true;
2421 }
2422
2423 return false;
2424}
2425
Chris Lattnereeffaef2009-04-10 17:15:23 +00002426/// \brief Writes the block containing the serialized form of the
2427/// preprocessor.
Douglas Gregor4a69c2e2011-09-01 17:04:32 +00002428void ASTWriter::WritePreprocessor(const Preprocessor &PP, bool IsModule) {
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002429 PreprocessingRecord *PPRec = PP.getPreprocessingRecord();
2430 if (PPRec)
2431 WritePreprocessorDetail(*PPRec);
2432
Chris Lattnerbaa52f42009-04-10 18:00:12 +00002433 RecordData Record;
Richard Smithd7329392015-04-21 21:46:32 +00002434 RecordData ModuleMacroRecord;
Chris Lattner0910e3b2009-04-10 17:16:57 +00002435
Chris Lattner0af3ba12009-04-13 01:29:17 +00002436 // If the preprocessor __COUNTER__ value has been bumped, remember it.
2437 if (PP.getCounterValue() != 0) {
Mehdi Amini57a41912015-09-10 01:46:39 +00002438 RecordData::value_type Record[] = {PP.getCounterValue()};
Sebastian Redl539c5062010-08-18 23:57:32 +00002439 Stream.EmitRecord(PP_COUNTER_VALUE, Record);
Douglas Gregoreda6a892009-04-26 00:07:37 +00002440 }
2441
Erik Verbruggenb34c79f2017-05-30 11:54:55 +00002442 if (PP.isRecordingPreamble() && PP.hasRecordedPreamble()) {
2443 assert(!IsModule);
Erik Verbruggen4d1eb2d2017-11-03 09:40:07 +00002444 auto SkipInfo = PP.getPreambleSkipInfo();
2445 if (SkipInfo.hasValue()) {
2446 Record.push_back(true);
2447 AddSourceLocation(SkipInfo->HashTokenLoc, Record);
2448 AddSourceLocation(SkipInfo->IfTokenLoc, Record);
2449 Record.push_back(SkipInfo->FoundNonSkipPortion);
2450 Record.push_back(SkipInfo->FoundElse);
2451 AddSourceLocation(SkipInfo->ElseLoc, Record);
2452 } else {
2453 Record.push_back(false);
2454 }
Erik Verbruggenb34c79f2017-05-30 11:54:55 +00002455 for (const auto &Cond : PP.getPreambleConditionalStack()) {
2456 AddSourceLocation(Cond.IfLoc, Record);
2457 Record.push_back(Cond.WasSkipping);
2458 Record.push_back(Cond.FoundNonSkip);
2459 Record.push_back(Cond.FoundElse);
2460 }
2461 Stream.EmitRecord(PP_CONDITIONAL_STACK, Record);
2462 Record.clear();
2463 }
2464
Douglas Gregoreda6a892009-04-26 00:07:37 +00002465 // Enter the preprocessor block.
Douglas Gregor796d76a2010-10-20 22:00:55 +00002466 Stream.EnterSubblock(PREPROCESSOR_BLOCK_ID, 3);
Mike Stump11289f42009-09-09 15:08:12 +00002467
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00002468 // If the AST file contains __DATE__ or __TIME__ emit a warning about this.
Richard Smithb5aaf5a2015-09-01 02:35:58 +00002469 // FIXME: Include a location for the use, and say which one was used.
Douglas Gregoreda6a892009-04-26 00:07:37 +00002470 if (PP.SawDateOrTime())
Richard Smithb5aaf5a2015-09-01 02:35:58 +00002471 PP.Diag(SourceLocation(), diag::warn_module_uses_date_time) << IsModule;
Douglas Gregor796d76a2010-10-20 22:00:55 +00002472
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002473 // Loop over all the macro directives that are live at the end of the file,
Chris Lattnerbaa52f42009-04-10 18:00:12 +00002474 // emitting each to the PP section.
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00002475
Richard Smithee977932015-05-01 21:22:17 +00002476 // Construct the list of identifiers with macro directives that need to be
2477 // serialized.
2478 SmallVector<const IdentifierInfo *, 128> MacroIdentifiers;
2479 for (auto &Id : PP.getIdentifierTable())
2480 if (Id.second->hadMacroDefinition() &&
2481 (!Id.second->isFromAST() ||
2482 Id.second->hasChangedSinceDeserialization()))
2483 MacroIdentifiers.push_back(Id.second);
Douglas Gregor2e5571d2011-02-10 18:20:09 +00002484 // Sort the set of macro definitions that need to be serialized by the
2485 // name of the macro, to provide a stable ordering.
Mandeep Singh Grangc205d8c2018-03-27 16:50:00 +00002486 llvm::sort(MacroIdentifiers.begin(), MacroIdentifiers.end(),
2487 llvm::less_ptr<IdentifierInfo>());
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002488
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002489 // Emit the macro directives as a list and associate the offset with the
2490 // identifier they belong to.
Richard Smithee977932015-05-01 21:22:17 +00002491 for (const IdentifierInfo *Name : MacroIdentifiers) {
2492 MacroDirective *MD = PP.getLocalMacroDirectiveHistory(Name);
Richard Smithd7329392015-04-21 21:46:32 +00002493 auto StartOffset = Stream.GetCurrentBitNo();
2494
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002495 // Emit the macro directives in reverse source order.
2496 for (; MD; MD = MD->getPrevious()) {
Richard Smithd7329392015-04-21 21:46:32 +00002497 // Once we hit an ignored macro, we're done: the rest of the chain
2498 // will all be ignored macros.
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002499 if (shouldIgnoreMacro(MD, IsModule, PP))
Richard Smithd7329392015-04-21 21:46:32 +00002500 break;
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002501
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002502 AddSourceLocation(MD->getLocation(), Record);
Argyrios Kyrtzidisb6210df2013-03-26 17:17:01 +00002503 Record.push_back(MD->getKind());
Richard Smithdaa69e02014-07-25 04:40:03 +00002504 if (auto *DefMD = dyn_cast<DefMacroDirective>(MD)) {
Richard Smith3981b172015-04-30 02:16:23 +00002505 Record.push_back(getMacroRef(DefMD->getInfo(), Name));
Richard Smith713369b2015-04-23 20:40:50 +00002506 } else if (auto *VisMD = dyn_cast<VisibilityMacroDirective>(MD)) {
Argyrios Kyrtzidisb6210df2013-03-26 17:17:01 +00002507 Record.push_back(VisMD->isPublic());
2508 }
Richard Smithb8b2ed62015-04-23 18:18:26 +00002509 }
Richard Smithd7329392015-04-21 21:46:32 +00002510
Richard Smithb8b2ed62015-04-23 18:18:26 +00002511 // Write out any exported module macros.
Richard Smithee977932015-05-01 21:22:17 +00002512 bool EmittedModuleMacros = false;
Manman Ren33d80292016-05-31 18:19:32 +00002513 // We write out exported module macros for PCH as well.
2514 auto Leafs = PP.getLeafModuleMacros(Name);
2515 SmallVector<ModuleMacro*, 8> Worklist(Leafs.begin(), Leafs.end());
2516 llvm::DenseMap<ModuleMacro*, unsigned> Visits;
2517 while (!Worklist.empty()) {
2518 auto *Macro = Worklist.pop_back_val();
Richard Smithd7329392015-04-21 21:46:32 +00002519
Manman Ren33d80292016-05-31 18:19:32 +00002520 // Emit a record indicating this submodule exports this macro.
2521 ModuleMacroRecord.push_back(
2522 getSubmoduleID(Macro->getOwningModule()));
2523 ModuleMacroRecord.push_back(getMacroRef(Macro->getMacroInfo(), Name));
2524 for (auto *M : Macro->overrides())
2525 ModuleMacroRecord.push_back(getSubmoduleID(M->getOwningModule()));
Richard Smithd7329392015-04-21 21:46:32 +00002526
Manman Ren33d80292016-05-31 18:19:32 +00002527 Stream.EmitRecord(PP_MODULE_MACRO, ModuleMacroRecord);
2528 ModuleMacroRecord.clear();
Richard Smithd7329392015-04-21 21:46:32 +00002529
Manman Ren33d80292016-05-31 18:19:32 +00002530 // Enqueue overridden macros once we've visited all their ancestors.
2531 for (auto *M : Macro->overrides())
2532 if (++Visits[M] == M->getNumOverridingMacros())
2533 Worklist.push_back(M);
Richard Smithee977932015-05-01 21:22:17 +00002534
Manman Ren33d80292016-05-31 18:19:32 +00002535 EmittedModuleMacros = true;
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002536 }
Richard Smithd7329392015-04-21 21:46:32 +00002537
Richard Smithee977932015-05-01 21:22:17 +00002538 if (Record.empty() && !EmittedModuleMacros)
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002539 continue;
2540
Richard Smithd7329392015-04-21 21:46:32 +00002541 IdentMacroDirectivesOffsetMap[Name] = StartOffset;
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002542 Stream.EmitRecord(PP_MACRO_DIRECTIVE_HISTORY, Record);
2543 Record.clear();
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002544 }
Alexander Kornienko1d26c022012-09-25 17:18:14 +00002545
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00002546 /// \brief Offsets of each of the macros into the bitstream, indexed by
2547 /// the local macro ID
2548 ///
2549 /// For each identifier that is associated with a macro, this map
2550 /// provides the offset into the bitstream where that macro is
2551 /// defined.
2552 std::vector<uint32_t> MacroOffsets;
2553
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002554 for (unsigned I = 0, N = MacroInfosToEmit.size(); I != N; ++I) {
2555 const IdentifierInfo *Name = MacroInfosToEmit[I].Name;
2556 MacroInfo *MI = MacroInfosToEmit[I].MI;
2557 MacroID ID = MacroInfosToEmit[I].ID;
Douglas Gregoreb114da2010-10-01 01:03:07 +00002558
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002559 if (ID < FirstMacroID) {
2560 assert(0 && "Loaded MacroInfo entered MacroInfosToEmit ?");
2561 continue;
Chris Lattner2199f5b2009-04-10 18:08:30 +00002562 }
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002563
2564 // Record the local offset of this macro.
2565 unsigned Index = ID - FirstMacroID;
2566 if (Index == MacroOffsets.size())
2567 MacroOffsets.push_back(Stream.GetCurrentBitNo());
2568 else {
2569 if (Index > MacroOffsets.size())
2570 MacroOffsets.resize(Index + 1);
2571
2572 MacroOffsets[Index] = Stream.GetCurrentBitNo();
2573 }
2574
2575 AddIdentifierRef(Name, Record);
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002576 AddSourceLocation(MI->getDefinitionLoc(), Record);
2577 AddSourceLocation(MI->getDefinitionEndLoc(), Record);
2578 Record.push_back(MI->isUsed());
Argyrios Kyrtzidis9ef53ce2014-04-09 18:21:23 +00002579 Record.push_back(MI->isUsedForHeaderGuard());
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002580 unsigned Code;
2581 if (MI->isObjectLike()) {
2582 Code = PP_MACRO_OBJECT_LIKE;
2583 } else {
2584 Code = PP_MACRO_FUNCTION_LIKE;
2585
2586 Record.push_back(MI->isC99Varargs());
2587 Record.push_back(MI->isGNUVarargs());
2588 Record.push_back(MI->hasCommaPasting());
Faisal Valiac506d72017-07-17 17:18:43 +00002589 Record.push_back(MI->getNumParams());
2590 for (const IdentifierInfo *Param : MI->params())
2591 AddIdentifierRef(Param, Record);
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002592 }
2593
2594 // If we have a detailed preprocessing record, record the macro definition
2595 // ID that corresponds to this macro.
2596 if (PPRec)
2597 Record.push_back(MacroDefinitions[PPRec->findMacroDefinition(MI)]);
2598
2599 Stream.EmitRecord(Code, Record);
2600 Record.clear();
2601
2602 // Emit the tokens array.
2603 for (unsigned TokNo = 0, e = MI->getNumTokens(); TokNo != e; ++TokNo) {
2604 // Note that we know that the preprocessor does not have any annotation
2605 // tokens in it because they are created by the parser, and thus can't
2606 // be in a macro definition.
2607 const Token &Tok = MI->getReplacementToken(TokNo);
John McCallf413f5e2013-05-03 00:10:13 +00002608 AddToken(Tok, Record);
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002609 Stream.EmitRecord(PP_TOKEN, Record);
2610 Record.clear();
2611 }
2612 ++NumMacros;
Chris Lattnerbaa52f42009-04-10 18:00:12 +00002613 }
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002614
Douglas Gregor92a96f52011-02-08 21:58:10 +00002615 Stream.ExitBlock();
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00002616
2617 // Write the offsets table for macro IDs.
2618 using namespace llvm;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002619
David Blaikieb44f0bf2017-01-04 22:36:43 +00002620 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00002621 Abbrev->Add(BitCodeAbbrevOp(MACRO_OFFSET));
2622 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // # of macros
2623 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // first ID
2624 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
2625
David Blaikieb44f0bf2017-01-04 22:36:43 +00002626 unsigned MacroOffsetAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Mehdi Amini57a41912015-09-10 01:46:39 +00002627 {
2628 RecordData::value_type Record[] = {MACRO_OFFSET, MacroOffsets.size(),
2629 FirstMacroID - NUM_PREDEF_MACRO_IDS};
2630 Stream.EmitRecordWithBlob(MacroOffsetAbbrev, Record, bytes(MacroOffsets));
2631 }
Douglas Gregor92a96f52011-02-08 21:58:10 +00002632}
2633
2634void ASTWriter::WritePreprocessorDetail(PreprocessingRecord &PPRec) {
Argyrios Kyrtzidis7f448362011-09-19 20:40:42 +00002635 if (PPRec.local_begin() == PPRec.local_end())
Douglas Gregor92a96f52011-02-08 21:58:10 +00002636 return;
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002637
Argyrios Kyrtzidis64f63812011-09-19 20:40:25 +00002638 SmallVector<PPEntityOffset, 64> PreprocessedEntityOffsets;
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002639
Douglas Gregor92a96f52011-02-08 21:58:10 +00002640 // Enter the preprocessor block.
2641 Stream.EnterSubblock(PREPROCESSOR_DETAIL_BLOCK_ID, 3);
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00002642
Douglas Gregoraae92242010-03-19 21:51:54 +00002643 // If the preprocessor has a preprocessing record, emit it.
2644 unsigned NumPreprocessingRecords = 0;
Douglas Gregor92a96f52011-02-08 21:58:10 +00002645 using namespace llvm;
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00002646
2647 // Set up the abbreviation for
Douglas Gregor92a96f52011-02-08 21:58:10 +00002648 unsigned InclusionAbbrev = 0;
2649 {
David Blaikieb44f0bf2017-01-04 22:36:43 +00002650 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Douglas Gregor92a96f52011-02-08 21:58:10 +00002651 Abbrev->Add(BitCodeAbbrevOp(PPD_INCLUSION_DIRECTIVE));
Douglas Gregor92a96f52011-02-08 21:58:10 +00002652 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // filename length
2653 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // in quotes
2654 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 2)); // kind
Argyrios Kyrtzidisf590e092012-10-02 16:10:46 +00002655 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // imported module
Douglas Gregor92a96f52011-02-08 21:58:10 +00002656 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
David Blaikieb44f0bf2017-01-04 22:36:43 +00002657 InclusionAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregor92a96f52011-02-08 21:58:10 +00002658 }
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00002659
2660 unsigned FirstPreprocessorEntityID
2661 = (Chain ? PPRec.getNumLoadedPreprocessedEntities() : 0)
Douglas Gregor2f555fc2011-08-04 18:56:47 +00002662 + NUM_PREDEF_PP_ENTITY_IDS;
2663 unsigned NextPreprocessorEntityID = FirstPreprocessorEntityID;
Douglas Gregor92a96f52011-02-08 21:58:10 +00002664 RecordData Record;
Argyrios Kyrtzidis7f448362011-09-19 20:40:42 +00002665 for (PreprocessingRecord::iterator E = PPRec.local_begin(),
2666 EEnd = PPRec.local_end();
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00002667 E != EEnd;
Douglas Gregor0d4b4312011-08-04 17:06:18 +00002668 (void)++E, ++NumPreprocessingRecords, ++NextPreprocessorEntityID) {
Douglas Gregor92a96f52011-02-08 21:58:10 +00002669 Record.clear();
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00002670
Richard Smith66a81862015-05-04 02:25:31 +00002671 PreprocessedEntityOffsets.push_back(
2672 PPEntityOffset((*E)->getSourceRange(), Stream.GetCurrentBitNo()));
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002673
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002674 if (auto *MD = dyn_cast<MacroDefinitionRecord>(*E)) {
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002675 // Record this macro definition's ID.
2676 MacroDefinitions[MD] = NextPreprocessorEntityID;
Richard Smith66a81862015-05-04 02:25:31 +00002677
Douglas Gregor92a96f52011-02-08 21:58:10 +00002678 AddIdentifierRef(MD->getName(), Record);
Douglas Gregor92a96f52011-02-08 21:58:10 +00002679 Stream.EmitRecord(PPD_MACRO_DEFINITION, Record);
2680 continue;
Douglas Gregoraae92242010-03-19 21:51:54 +00002681 }
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00002682
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002683 if (auto *ME = dyn_cast<MacroExpansion>(*E)) {
Argyrios Kyrtzidis80f78b92011-09-08 17:18:41 +00002684 Record.push_back(ME->isBuiltinMacro());
2685 if (ME->isBuiltinMacro())
2686 AddIdentifierRef(ME->getName(), Record);
2687 else
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002688 Record.push_back(MacroDefinitions[ME->getDefinition()]);
Chandler Carruthf92ac9e2011-07-15 07:25:21 +00002689 Stream.EmitRecord(PPD_MACRO_EXPANSION, Record);
Douglas Gregor92a96f52011-02-08 21:58:10 +00002690 continue;
2691 }
2692
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002693 if (auto *ID = dyn_cast<InclusionDirective>(*E)) {
Douglas Gregor92a96f52011-02-08 21:58:10 +00002694 Record.push_back(PPD_INCLUSION_DIRECTIVE);
Douglas Gregor92a96f52011-02-08 21:58:10 +00002695 Record.push_back(ID->getFileName().size());
2696 Record.push_back(ID->wasInQuotes());
2697 Record.push_back(static_cast<unsigned>(ID->getKind()));
Argyrios Kyrtzidisf590e092012-10-02 16:10:46 +00002698 Record.push_back(ID->importedModule());
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00002699 SmallString<64> Buffer;
Douglas Gregor92a96f52011-02-08 21:58:10 +00002700 Buffer += ID->getFileName();
Argyrios Kyrtzidis8dbcfc32012-03-08 01:08:28 +00002701 // Check that the FileEntry is not null because it was not resolved and
2702 // we create a PCH even with compiler errors.
2703 if (ID->getFile())
2704 Buffer += ID->getFile()->getName();
Mehdi Amini5ae4a852015-09-09 20:35:37 +00002705 Stream.EmitRecordWithBlob(InclusionAbbrev, Record, Buffer);
Douglas Gregor92a96f52011-02-08 21:58:10 +00002706 continue;
2707 }
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00002708
Douglas Gregor92a96f52011-02-08 21:58:10 +00002709 llvm_unreachable("Unhandled PreprocessedEntity in ASTWriter");
2710 }
Douglas Gregor8f45df52009-04-16 22:23:12 +00002711 Stream.ExitBlock();
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00002712
Douglas Gregoraae92242010-03-19 21:51:54 +00002713 // Write the offsets table for the preprocessing record.
2714 if (NumPreprocessingRecords > 0) {
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002715 assert(PreprocessedEntityOffsets.size() == NumPreprocessingRecords);
2716
Douglas Gregoraae92242010-03-19 21:51:54 +00002717 // Write the offsets table for identifier IDs.
2718 using namespace llvm;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002719
David Blaikieb44f0bf2017-01-04 22:36:43 +00002720 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002721 Abbrev->Add(BitCodeAbbrevOp(PPD_ENTITIES_OFFSETS));
Douglas Gregor2f555fc2011-08-04 18:56:47 +00002722 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // first pp entity
Douglas Gregoraae92242010-03-19 21:51:54 +00002723 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
David Blaikieb44f0bf2017-01-04 22:36:43 +00002724 unsigned PPEOffsetAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00002725
Mehdi Amini57a41912015-09-10 01:46:39 +00002726 RecordData::value_type Record[] = {PPD_ENTITIES_OFFSETS,
2727 FirstPreprocessorEntityID -
2728 NUM_PREDEF_PP_ENTITY_IDS};
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002729 Stream.EmitRecordWithBlob(PPEOffsetAbbrev, Record,
Reid Kleckner012665e2015-05-21 00:13:09 +00002730 bytes(PreprocessedEntityOffsets));
Douglas Gregoraae92242010-03-19 21:51:54 +00002731 }
Cameron Desrochersb60f1b62018-01-15 19:14:16 +00002732
2733 // Write the skipped region table for the preprocessing record.
2734 ArrayRef<SourceRange> SkippedRanges = PPRec.getSkippedRanges();
2735 if (SkippedRanges.size() > 0) {
2736 std::vector<PPSkippedRange> SerializedSkippedRanges;
2737 SerializedSkippedRanges.reserve(SkippedRanges.size());
2738 for (auto const& Range : SkippedRanges)
2739 SerializedSkippedRanges.emplace_back(Range);
2740
2741 using namespace llvm;
2742 auto Abbrev = std::make_shared<BitCodeAbbrev>();
2743 Abbrev->Add(BitCodeAbbrevOp(PPD_SKIPPED_RANGES));
2744 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
2745 unsigned PPESkippedRangeAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
2746
2747 Record.clear();
2748 Record.push_back(PPD_SKIPPED_RANGES);
2749 Stream.EmitRecordWithBlob(PPESkippedRangeAbbrev, Record,
2750 bytes(SerializedSkippedRanges));
2751 }
Chris Lattnereeffaef2009-04-10 17:15:23 +00002752}
2753
Richard Smith386bb072015-08-18 23:42:23 +00002754unsigned ASTWriter::getLocalOrImportedSubmoduleID(Module *Mod) {
Richard Smith080056b2015-08-18 21:53:42 +00002755 if (!Mod)
2756 return 0;
2757
Douglas Gregora89c5ac2011-12-06 01:10:29 +00002758 llvm::DenseMap<Module *, unsigned>::iterator Known = SubmoduleIDs.find(Mod);
2759 if (Known != SubmoduleIDs.end())
2760 return Known->second;
Richard Smith386bb072015-08-18 23:42:23 +00002761
Richard Smithdc1f0422016-07-20 19:10:16 +00002762 auto *Top = Mod->getTopLevelModule();
2763 if (Top != WritingModule &&
Bruno Cardoso Lopes17da34d2017-02-07 21:54:57 +00002764 (getLangOpts().CompilingPCH ||
2765 !Top->fullModuleNameIs(StringRef(getLangOpts().CurrentModule))))
Richard Smith386bb072015-08-18 23:42:23 +00002766 return 0;
2767
Douglas Gregora89c5ac2011-12-06 01:10:29 +00002768 return SubmoduleIDs[Mod] = NextSubmoduleID++;
2769}
2770
Richard Smith386bb072015-08-18 23:42:23 +00002771unsigned ASTWriter::getSubmoduleID(Module *Mod) {
2772 // FIXME: This can easily happen, if we have a reference to a submodule that
2773 // did not result in us loading a module file for that submodule. For
2774 // instance, a cross-top-level-module 'conflict' declaration will hit this.
2775 unsigned ID = getLocalOrImportedSubmoduleID(Mod);
2776 assert((ID || !Mod) &&
2777 "asked for module ID for non-local, non-imported module");
2778 return ID;
Argyrios Kyrtzidisb146baa2013-03-13 21:13:51 +00002779}
2780
Douglas Gregor253eefe2011-12-01 00:59:36 +00002781/// \brief Compute the number of modules within the given tree (including the
2782/// given module).
2783static unsigned getNumberOfModules(Module *Mod) {
2784 unsigned ChildModules = 0;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002785 for (auto Sub = Mod->submodule_begin(), SubEnd = Mod->submodule_end();
Douglas Gregor253eefe2011-12-01 00:59:36 +00002786 Sub != SubEnd; ++Sub)
Douglas Gregoreb90e832012-01-04 23:32:19 +00002787 ChildModules += getNumberOfModules(*Sub);
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00002788
Douglas Gregor253eefe2011-12-01 00:59:36 +00002789 return ChildModules + 1;
2790}
2791
Douglas Gregorde3ef502011-11-30 23:21:26 +00002792void ASTWriter::WriteSubmodules(Module *WritingModule) {
Douglas Gregor69021972011-11-30 17:33:56 +00002793 // Enter the submodule description block.
Richard Smith202210b2014-10-24 20:23:01 +00002794 Stream.EnterSubblock(SUBMODULE_BLOCK_ID, /*bits for abbreviations*/5);
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00002795
Douglas Gregor69021972011-11-30 17:33:56 +00002796 // Write the abbreviations needed for the submodules block.
2797 using namespace llvm;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002798
David Blaikieb44f0bf2017-01-04 22:36:43 +00002799 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Douglas Gregor69021972011-11-30 17:33:56 +00002800 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_DEFINITION));
Douglas Gregora89c5ac2011-12-06 01:10:29 +00002801 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // ID
Douglas Gregor69021972011-11-30 17:33:56 +00002802 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Parent
Richard Smithdd8b5332017-09-04 05:37:53 +00002803 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 2)); // Kind
Douglas Gregor69021972011-11-30 17:33:56 +00002804 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // IsFramework
2805 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // IsExplicit
Richard Smith9bca2982014-03-08 00:03:56 +00002806 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // IsSystem
2807 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // IsExternC
Douglas Gregora686e1b2012-01-27 19:52:33 +00002808 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // InferSubmodules...
Douglas Gregor73441092011-12-05 22:27:44 +00002809 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // InferExplicit...
Douglas Gregor73441092011-12-05 22:27:44 +00002810 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // InferExportWild...
Douglas Gregor35b13ec2013-03-20 00:22:05 +00002811 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // ConfigMacrosExh...
Douglas Gregor69021972011-11-30 17:33:56 +00002812 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
David Blaikieb44f0bf2017-01-04 22:36:43 +00002813 unsigned DefinitionAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregor69021972011-11-30 17:33:56 +00002814
David Blaikieb44f0bf2017-01-04 22:36:43 +00002815 Abbrev = std::make_shared<BitCodeAbbrev>();
Douglas Gregor524e33e2011-12-08 19:11:24 +00002816 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_UMBRELLA_HEADER));
Douglas Gregor69021972011-11-30 17:33:56 +00002817 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
David Blaikieb44f0bf2017-01-04 22:36:43 +00002818 unsigned UmbrellaAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregor69021972011-11-30 17:33:56 +00002819
David Blaikieb44f0bf2017-01-04 22:36:43 +00002820 Abbrev = std::make_shared<BitCodeAbbrev>();
Douglas Gregor69021972011-11-30 17:33:56 +00002821 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_HEADER));
2822 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
David Blaikieb44f0bf2017-01-04 22:36:43 +00002823 unsigned HeaderAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregor524e33e2011-12-08 19:11:24 +00002824
David Blaikieb44f0bf2017-01-04 22:36:43 +00002825 Abbrev = std::make_shared<BitCodeAbbrev>();
Argyrios Kyrtzidisc597c8c2012-10-05 00:22:33 +00002826 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_TOPHEADER));
2827 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
David Blaikieb44f0bf2017-01-04 22:36:43 +00002828 unsigned TopHeaderAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Argyrios Kyrtzidisc597c8c2012-10-05 00:22:33 +00002829
David Blaikieb44f0bf2017-01-04 22:36:43 +00002830 Abbrev = std::make_shared<BitCodeAbbrev>();
Douglas Gregor524e33e2011-12-08 19:11:24 +00002831 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_UMBRELLA_DIR));
2832 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
David Blaikieb44f0bf2017-01-04 22:36:43 +00002833 unsigned UmbrellaDirAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregor524e33e2011-12-08 19:11:24 +00002834
David Blaikieb44f0bf2017-01-04 22:36:43 +00002835 Abbrev = std::make_shared<BitCodeAbbrev>();
Douglas Gregor1fb5c3a2011-12-31 04:05:44 +00002836 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_REQUIRES));
Richard Smitha3feee22013-10-28 22:18:19 +00002837 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // State
2838 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Feature
David Blaikieb44f0bf2017-01-04 22:36:43 +00002839 unsigned RequiresAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregor1fb5c3a2011-12-31 04:05:44 +00002840
David Blaikieb44f0bf2017-01-04 22:36:43 +00002841 Abbrev = std::make_shared<BitCodeAbbrev>();
Douglas Gregor59527662012-10-15 06:28:11 +00002842 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_EXCLUDED_HEADER));
2843 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
David Blaikieb44f0bf2017-01-04 22:36:43 +00002844 unsigned ExcludedHeaderAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregor59527662012-10-15 06:28:11 +00002845
David Blaikieb44f0bf2017-01-04 22:36:43 +00002846 Abbrev = std::make_shared<BitCodeAbbrev>();
Richard Smith306d8922014-10-22 23:50:56 +00002847 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_TEXTUAL_HEADER));
2848 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
David Blaikieb44f0bf2017-01-04 22:36:43 +00002849 unsigned TextualHeaderAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Richard Smith306d8922014-10-22 23:50:56 +00002850
David Blaikieb44f0bf2017-01-04 22:36:43 +00002851 Abbrev = std::make_shared<BitCodeAbbrev>();
Lawrence Crowlb53e5482013-06-20 21:14:14 +00002852 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_PRIVATE_HEADER));
2853 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
David Blaikieb44f0bf2017-01-04 22:36:43 +00002854 unsigned PrivateHeaderAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Lawrence Crowlb53e5482013-06-20 21:14:14 +00002855
David Blaikieb44f0bf2017-01-04 22:36:43 +00002856 Abbrev = std::make_shared<BitCodeAbbrev>();
Richard Smith202210b2014-10-24 20:23:01 +00002857 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_PRIVATE_TEXTUAL_HEADER));
2858 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
David Blaikieb44f0bf2017-01-04 22:36:43 +00002859 unsigned PrivateTextualHeaderAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Richard Smith202210b2014-10-24 20:23:01 +00002860
David Blaikieb44f0bf2017-01-04 22:36:43 +00002861 Abbrev = std::make_shared<BitCodeAbbrev>();
Douglas Gregor6ddfca92013-01-14 17:21:00 +00002862 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_LINK_LIBRARY));
2863 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // IsFramework
2864 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
David Blaikieb44f0bf2017-01-04 22:36:43 +00002865 unsigned LinkLibraryAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregor6ddfca92013-01-14 17:21:00 +00002866
David Blaikieb44f0bf2017-01-04 22:36:43 +00002867 Abbrev = std::make_shared<BitCodeAbbrev>();
Douglas Gregor35b13ec2013-03-20 00:22:05 +00002868 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_CONFIG_MACRO));
2869 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Macro name
David Blaikieb44f0bf2017-01-04 22:36:43 +00002870 unsigned ConfigMacroAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregor35b13ec2013-03-20 00:22:05 +00002871
David Blaikieb44f0bf2017-01-04 22:36:43 +00002872 Abbrev = std::make_shared<BitCodeAbbrev>();
Douglas Gregorfb912652013-03-20 21:10:35 +00002873 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_CONFLICT));
2874 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Other module
2875 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Message
David Blaikieb44f0bf2017-01-04 22:36:43 +00002876 unsigned ConflictAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregorfb912652013-03-20 21:10:35 +00002877
Douglas Gregorf0b11de2017-09-14 23:38:44 +00002878 Abbrev = std::make_shared<BitCodeAbbrev>();
2879 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_EXPORT_AS));
2880 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Macro name
2881 unsigned ExportAsAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
2882
Douglas Gregor253eefe2011-12-01 00:59:36 +00002883 // Write the submodule metadata block.
Richard Smith145e15a2017-04-24 23:12:30 +00002884 RecordData::value_type Record[] = {
2885 getNumberOfModules(WritingModule),
Richard Smithdd8b5332017-09-04 05:37:53 +00002886 FirstSubmoduleID - NUM_PREDEF_SUBMODULE_IDS};
Douglas Gregor253eefe2011-12-01 00:59:36 +00002887 Stream.EmitRecord(SUBMODULE_METADATA, Record);
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00002888
Douglas Gregor69021972011-11-30 17:33:56 +00002889 // Write all of the submodules.
Douglas Gregorde3ef502011-11-30 23:21:26 +00002890 std::queue<Module *> Q;
Douglas Gregor69021972011-11-30 17:33:56 +00002891 Q.push(WritingModule);
Douglas Gregor69021972011-11-30 17:33:56 +00002892 while (!Q.empty()) {
Douglas Gregorde3ef502011-11-30 23:21:26 +00002893 Module *Mod = Q.front();
Douglas Gregor69021972011-11-30 17:33:56 +00002894 Q.pop();
Douglas Gregora89c5ac2011-12-06 01:10:29 +00002895 unsigned ID = getSubmoduleID(Mod);
Mehdi Amini57a41912015-09-10 01:46:39 +00002896
2897 uint64_t ParentID = 0;
Douglas Gregor69021972011-11-30 17:33:56 +00002898 if (Mod->Parent) {
2899 assert(SubmoduleIDs[Mod->Parent] && "Submodule parent not written?");
Mehdi Amini57a41912015-09-10 01:46:39 +00002900 ParentID = SubmoduleIDs[Mod->Parent];
Douglas Gregor69021972011-11-30 17:33:56 +00002901 }
Mehdi Amini57a41912015-09-10 01:46:39 +00002902
2903 // Emit the definition of the block.
2904 {
David Blaikie9ffe5a32017-01-30 05:00:26 +00002905 RecordData::value_type Record[] = {SUBMODULE_DEFINITION,
2906 ID,
2907 ParentID,
Simon Pilgrimf331a662017-09-04 10:54:39 +00002908 (RecordData::value_type)Mod->Kind,
David Blaikie9ffe5a32017-01-30 05:00:26 +00002909 Mod->IsFramework,
2910 Mod->IsExplicit,
2911 Mod->IsSystem,
2912 Mod->IsExternC,
2913 Mod->InferSubmodules,
2914 Mod->InferExplicitSubmodules,
2915 Mod->InferExportWildcard,
David Blaikiee6b7c282017-04-11 20:46:34 +00002916 Mod->ConfigMacrosExhaustive};
Mehdi Amini57a41912015-09-10 01:46:39 +00002917 Stream.EmitRecordWithBlob(DefinitionAbbrev, Record, Mod->Name);
2918 }
2919
Douglas Gregor1fb5c3a2011-12-31 04:05:44 +00002920 // Emit the requirements.
Richard Smith080056b2015-08-18 21:53:42 +00002921 for (const auto &R : Mod->Requirements) {
Mehdi Amini57a41912015-09-10 01:46:39 +00002922 RecordData::value_type Record[] = {SUBMODULE_REQUIRES, R.second};
Richard Smith080056b2015-08-18 21:53:42 +00002923 Stream.EmitRecordWithBlob(RequiresAbbrev, Record, R.first);
Douglas Gregor1fb5c3a2011-12-31 04:05:44 +00002924 }
2925
Douglas Gregor69021972011-11-30 17:33:56 +00002926 // Emit the umbrella header, if there is one.
Richard Smith2b63d152015-05-16 02:28:53 +00002927 if (auto UmbrellaHeader = Mod->getUmbrellaHeader()) {
Mehdi Amini57a41912015-09-10 01:46:39 +00002928 RecordData::value_type Record[] = {SUBMODULE_UMBRELLA_HEADER};
Richard Smith2b63d152015-05-16 02:28:53 +00002929 Stream.EmitRecordWithBlob(UmbrellaAbbrev, Record,
2930 UmbrellaHeader.NameAsWritten);
2931 } else if (auto UmbrellaDir = Mod->getUmbrellaDir()) {
Mehdi Amini57a41912015-09-10 01:46:39 +00002932 RecordData::value_type Record[] = {SUBMODULE_UMBRELLA_DIR};
2933 Stream.EmitRecordWithBlob(UmbrellaDirAbbrev, Record,
Richard Smith2b63d152015-05-16 02:28:53 +00002934 UmbrellaDir.NameAsWritten);
Douglas Gregor69021972011-11-30 17:33:56 +00002935 }
Richard Smith306d8922014-10-22 23:50:56 +00002936
Douglas Gregor69021972011-11-30 17:33:56 +00002937 // Emit the headers.
Richard Smith202210b2014-10-24 20:23:01 +00002938 struct {
Richard Smith3c1a41a2014-12-02 00:08:08 +00002939 unsigned RecordKind;
Richard Smith202210b2014-10-24 20:23:01 +00002940 unsigned Abbrev;
Richard Smith3c1a41a2014-12-02 00:08:08 +00002941 Module::HeaderKind HeaderKind;
Richard Smith202210b2014-10-24 20:23:01 +00002942 } HeaderLists[] = {
Richard Smith3c1a41a2014-12-02 00:08:08 +00002943 {SUBMODULE_HEADER, HeaderAbbrev, Module::HK_Normal},
2944 {SUBMODULE_TEXTUAL_HEADER, TextualHeaderAbbrev, Module::HK_Textual},
2945 {SUBMODULE_PRIVATE_HEADER, PrivateHeaderAbbrev, Module::HK_Private},
Richard Smith202210b2014-10-24 20:23:01 +00002946 {SUBMODULE_PRIVATE_TEXTUAL_HEADER, PrivateTextualHeaderAbbrev,
Richard Smith3c1a41a2014-12-02 00:08:08 +00002947 Module::HK_PrivateTextual},
2948 {SUBMODULE_EXCLUDED_HEADER, ExcludedHeaderAbbrev, Module::HK_Excluded}
Richard Smith202210b2014-10-24 20:23:01 +00002949 };
2950 for (auto &HL : HeaderLists) {
Mehdi Amini57a41912015-09-10 01:46:39 +00002951 RecordData::value_type Record[] = {HL.RecordKind};
Richard Smith3c1a41a2014-12-02 00:08:08 +00002952 for (auto &H : Mod->Headers[HL.HeaderKind])
2953 Stream.EmitRecordWithBlob(HL.Abbrev, Record, H.NameAsWritten);
2954 }
2955
2956 // Emit the top headers.
2957 {
2958 auto TopHeaders = Mod->getTopHeaders(PP->getFileManager());
Mehdi Amini57a41912015-09-10 01:46:39 +00002959 RecordData::value_type Record[] = {SUBMODULE_TOPHEADER};
Richard Smith3c1a41a2014-12-02 00:08:08 +00002960 for (auto *H : TopHeaders)
2961 Stream.EmitRecordWithBlob(TopHeaderAbbrev, Record, H->getName());
Argyrios Kyrtzidisc597c8c2012-10-05 00:22:33 +00002962 }
Douglas Gregor0093b3c2011-12-05 16:33:54 +00002963
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00002964 // Emit the imports.
Douglas Gregor0093b3c2011-12-05 16:33:54 +00002965 if (!Mod->Imports.empty()) {
Mehdi Amini57a41912015-09-10 01:46:39 +00002966 RecordData Record;
Richard Smith080056b2015-08-18 21:53:42 +00002967 for (auto *I : Mod->Imports)
2968 Record.push_back(getSubmoduleID(I));
Douglas Gregor0093b3c2011-12-05 16:33:54 +00002969 Stream.EmitRecord(SUBMODULE_IMPORTS, Record);
2970 }
2971
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00002972 // Emit the exports.
Douglas Gregor24bb9232011-12-02 18:58:38 +00002973 if (!Mod->Exports.empty()) {
Mehdi Amini57a41912015-09-10 01:46:39 +00002974 RecordData Record;
Richard Smith080056b2015-08-18 21:53:42 +00002975 for (const auto &E : Mod->Exports) {
2976 // FIXME: This may fail; we don't require that all exported modules
2977 // are local or imported.
2978 Record.push_back(getSubmoduleID(E.getPointer()));
2979 Record.push_back(E.getInt());
Douglas Gregor24bb9232011-12-02 18:58:38 +00002980 }
2981 Stream.EmitRecord(SUBMODULE_EXPORTS, Record);
2982 }
Douglas Gregor6ddfca92013-01-14 17:21:00 +00002983
Daniel Jasperba7f2f72013-09-24 09:14:14 +00002984 //FIXME: How do we emit the 'use'd modules? They may not be submodules.
2985 // Might be unnecessary as use declarations are only used to build the
2986 // module itself.
2987
Douglas Gregor6ddfca92013-01-14 17:21:00 +00002988 // Emit the link libraries.
Richard Smith080056b2015-08-18 21:53:42 +00002989 for (const auto &LL : Mod->LinkLibraries) {
Mehdi Amini57a41912015-09-10 01:46:39 +00002990 RecordData::value_type Record[] = {SUBMODULE_LINK_LIBRARY,
2991 LL.IsFramework};
Richard Smith080056b2015-08-18 21:53:42 +00002992 Stream.EmitRecordWithBlob(LinkLibraryAbbrev, Record, LL.Library);
Douglas Gregor6ddfca92013-01-14 17:21:00 +00002993 }
2994
Douglas Gregorfb912652013-03-20 21:10:35 +00002995 // Emit the conflicts.
Richard Smith080056b2015-08-18 21:53:42 +00002996 for (const auto &C : Mod->Conflicts) {
Richard Smith080056b2015-08-18 21:53:42 +00002997 // FIXME: This may fail; we don't require that all conflicting modules
2998 // are local or imported.
Mehdi Amini57a41912015-09-10 01:46:39 +00002999 RecordData::value_type Record[] = {SUBMODULE_CONFLICT,
3000 getSubmoduleID(C.Other)};
Richard Smith080056b2015-08-18 21:53:42 +00003001 Stream.EmitRecordWithBlob(ConflictAbbrev, Record, C.Message);
Douglas Gregorfb912652013-03-20 21:10:35 +00003002 }
3003
Douglas Gregor35b13ec2013-03-20 00:22:05 +00003004 // Emit the configuration macros.
Richard Smith080056b2015-08-18 21:53:42 +00003005 for (const auto &CM : Mod->ConfigMacros) {
Mehdi Amini57a41912015-09-10 01:46:39 +00003006 RecordData::value_type Record[] = {SUBMODULE_CONFIG_MACRO};
Richard Smith080056b2015-08-18 21:53:42 +00003007 Stream.EmitRecordWithBlob(ConfigMacroAbbrev, Record, CM);
Douglas Gregor35b13ec2013-03-20 00:22:05 +00003008 }
3009
Richard Smithdc1f0422016-07-20 19:10:16 +00003010 // Emit the initializers, if any.
3011 RecordData Inits;
3012 for (Decl *D : Context->getModuleInitializers(Mod))
3013 Inits.push_back(GetDeclRef(D));
3014 if (!Inits.empty())
3015 Stream.EmitRecord(SUBMODULE_INITIALIZERS, Inits);
3016
Douglas Gregorf0b11de2017-09-14 23:38:44 +00003017 // Emit the name of the re-exported module, if any.
3018 if (!Mod->ExportAsModule.empty()) {
3019 RecordData::value_type Record[] = {SUBMODULE_EXPORT_AS};
3020 Stream.EmitRecordWithBlob(ExportAsAbbrev, Record, Mod->ExportAsModule);
3021 }
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00003022
Douglas Gregor69021972011-11-30 17:33:56 +00003023 // Queue up the submodules of this module.
Richard Smith080056b2015-08-18 21:53:42 +00003024 for (auto *M : Mod->submodules())
3025 Q.push(M);
Douglas Gregor69021972011-11-30 17:33:56 +00003026 }
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00003027
Douglas Gregor69021972011-11-30 17:33:56 +00003028 Stream.ExitBlock();
Richard Smith23d8d032015-05-14 00:45:20 +00003029
Richard Smith23d8d032015-05-14 00:45:20 +00003030 assert((NextSubmoduleID - FirstSubmoduleID ==
3031 getNumberOfModules(WritingModule)) &&
3032 "Wrong # of submodules; found a reference to a non-local, "
3033 "non-imported submodule?");
Douglas Gregor69021972011-11-30 17:33:56 +00003034}
3035
Argyrios Kyrtzidis0f06b982013-03-27 17:17:23 +00003036void ASTWriter::WritePragmaDiagnosticMappings(const DiagnosticsEngine &Diag,
3037 bool isModule) {
Argyrios Kyrtzidisefaa54a2012-10-30 00:27:21 +00003038 llvm::SmallDenseMap<const DiagnosticsEngine::DiagState *, unsigned, 64>
3039 DiagStateIDMap;
3040 unsigned CurrID = 0;
Argyrios Kyrtzidis452707c2010-11-05 22:10:18 +00003041 RecordData Record;
Argyrios Kyrtzidis243aedb2011-01-14 20:54:07 +00003042
Richard Smithe37391c2017-05-03 00:28:49 +00003043 auto EncodeDiagStateFlags =
3044 [](const DiagnosticsEngine::DiagState *DS) -> unsigned {
3045 unsigned Result = (unsigned)DS->ExtBehavior;
3046 for (unsigned Val :
Daniel Jasperba9aefc2017-05-03 07:48:27 +00003047 {(unsigned)DS->IgnoreAllWarnings, (unsigned)DS->EnableAllWarnings,
3048 (unsigned)DS->WarningsAsErrors, (unsigned)DS->ErrorsAsFatal,
3049 (unsigned)DS->SuppressSystemWarnings})
Richard Smithe37391c2017-05-03 00:28:49 +00003050 Result = (Result << 1) | Val;
3051 return Result;
3052 };
3053
3054 unsigned Flags = EncodeDiagStateFlags(Diag.DiagStatesByLoc.FirstDiagState);
3055 Record.push_back(Flags);
3056
Richard Smithd230de22017-01-26 01:01:01 +00003057 auto AddDiagState = [&](const DiagnosticsEngine::DiagState *State,
3058 bool IncludeNonPragmaStates) {
Richard Smithe37391c2017-05-03 00:28:49 +00003059 // Ensure that the diagnostic state wasn't modified since it was created.
3060 // We will not correctly round-trip this information otherwise.
3061 assert(Flags == EncodeDiagStateFlags(State) &&
3062 "diag state flags vary in single AST file");
3063
Richard Smithd230de22017-01-26 01:01:01 +00003064 unsigned &DiagStateID = DiagStateIDMap[State];
Argyrios Kyrtzidisefaa54a2012-10-30 00:27:21 +00003065 Record.push_back(DiagStateID);
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00003066
Argyrios Kyrtzidisefaa54a2012-10-30 00:27:21 +00003067 if (DiagStateID == 0) {
3068 DiagStateID = ++CurrID;
Duncan P. N. Exon Smith3cb183b2017-03-14 19:31:27 +00003069
3070 // Add a placeholder for the number of mappings.
3071 auto SizeIdx = Record.size();
3072 Record.emplace_back();
Richard Smithd230de22017-01-26 01:01:01 +00003073 for (const auto &I : *State) {
3074 if (I.second.isPragma() || IncludeNonPragmaStates) {
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00003075 Record.push_back(I.first);
Richard Smithe37391c2017-05-03 00:28:49 +00003076 Record.push_back(I.second.serialize());
Argyrios Kyrtzidisefaa54a2012-10-30 00:27:21 +00003077 }
Argyrios Kyrtzidis243aedb2011-01-14 20:54:07 +00003078 }
Duncan P. N. Exon Smith3cb183b2017-03-14 19:31:27 +00003079 // Update the placeholder.
3080 Record[SizeIdx] = (Record.size() - SizeIdx) / 2;
Richard Smithd230de22017-01-26 01:01:01 +00003081 }
3082 };
3083
3084 AddDiagState(Diag.DiagStatesByLoc.FirstDiagState, isModule);
Richard Smithd230de22017-01-26 01:01:01 +00003085
Duncan P. N. Exon Smitha351c102017-04-12 03:45:32 +00003086 // Reserve a spot for the number of locations with state transitions.
3087 auto NumLocationsIdx = Record.size();
3088 Record.emplace_back();
3089
3090 // Emit the state transitions.
3091 unsigned NumLocations = 0;
Richard Smithd230de22017-01-26 01:01:01 +00003092 for (auto &FileIDAndFile : Diag.DiagStatesByLoc.Files) {
3093 if (!FileIDAndFile.first.isValid() ||
3094 !FileIDAndFile.second.HasLocalTransitions)
3095 continue;
Duncan P. N. Exon Smitha351c102017-04-12 03:45:32 +00003096 ++NumLocations;
Richard Smith6c2b5a82018-02-09 01:15:13 +00003097
3098 SourceLocation Loc = Diag.SourceMgr->getComposedLoc(FileIDAndFile.first, 0);
3099 assert(!Loc.isInvalid() && "start loc for valid FileID is invalid");
3100 AddSourceLocation(Loc, Record);
3101
Richard Smithd230de22017-01-26 01:01:01 +00003102 Record.push_back(FileIDAndFile.second.StateTransitions.size());
3103 for (auto &StatePoint : FileIDAndFile.second.StateTransitions) {
3104 Record.push_back(StatePoint.Offset);
3105 AddDiagState(StatePoint.State, false);
Argyrios Kyrtzidis452707c2010-11-05 22:10:18 +00003106 }
3107 }
3108
Duncan P. N. Exon Smitha351c102017-04-12 03:45:32 +00003109 // Backpatch the number of locations.
3110 Record[NumLocationsIdx] = NumLocations;
3111
3112 // Emit CurDiagStateLoc. Do it last in order to match source order.
Duncan P. N. Exon Smith900f8172017-04-12 03:58:58 +00003113 //
3114 // This also protects against a hypothetical corner case with simulating
3115 // -Werror settings for implicit modules in the ASTReader, where reading
3116 // CurDiagState out of context could change whether warning pragmas are
3117 // treated as errors.
Duncan P. N. Exon Smitha351c102017-04-12 03:45:32 +00003118 AddSourceLocation(Diag.DiagStatesByLoc.CurDiagStateLoc, Record);
3119 AddDiagState(Diag.DiagStatesByLoc.CurDiagState, false);
3120
Duncan P. N. Exon Smithf2435b92017-04-12 02:31:17 +00003121 Stream.EmitRecord(DIAG_PRAGMA_MAPPINGS, Record);
Argyrios Kyrtzidis452707c2010-11-05 22:10:18 +00003122}
3123
Douglas Gregorc5046832009-04-27 18:38:38 +00003124//===----------------------------------------------------------------------===//
3125// Type Serialization
3126//===----------------------------------------------------------------------===//
Chris Lattnereeffaef2009-04-10 17:15:23 +00003127
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00003128/// \brief Write the representation of a type to the AST stream.
Sebastian Redl55c0ad52010-08-18 23:56:21 +00003129void ASTWriter::WriteType(QualType T) {
Richard Smith290d8012016-04-06 17:06:00 +00003130 TypeIdx &IdxRef = TypeIdxs[T];
3131 if (IdxRef.getIndex() == 0) // we haven't seen this type before.
3132 IdxRef = TypeIdx(NextTypeID++);
3133 TypeIdx Idx = IdxRef;
Mike Stump11289f42009-09-09 15:08:12 +00003134
Douglas Gregor9b3932c2010-10-05 18:37:06 +00003135 assert(Idx.getIndex() >= FirstTypeID && "Re-writing a type from a prior AST");
Douglas Gregordc72caa2010-10-04 18:21:45 +00003136
Douglas Gregoref84c4b2009-04-09 22:27:44 +00003137 RecordData Record;
Mike Stump11289f42009-09-09 15:08:12 +00003138
Douglas Gregoref84c4b2009-04-09 22:27:44 +00003139 // Emit the type's representation.
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00003140 ASTTypeWriter W(*this, Record);
Richard Smith290d8012016-04-06 17:06:00 +00003141 W.Visit(T);
3142 uint64_t Offset = W.Emit();
John McCall8ccfcb52009-09-24 19:53:00 +00003143
Richard Smith290d8012016-04-06 17:06:00 +00003144 // Record the offset for this type.
3145 unsigned Index = Idx.getIndex() - FirstTypeID;
3146 if (TypeOffsets.size() == Index)
3147 TypeOffsets.push_back(Offset);
3148 else if (TypeOffsets.size() < Index) {
3149 TypeOffsets.resize(Index + 1);
3150 TypeOffsets[Index] = Offset;
John McCall8ccfcb52009-09-24 19:53:00 +00003151 } else {
Richard Smith290d8012016-04-06 17:06:00 +00003152 llvm_unreachable("Types emitted in wrong order");
Douglas Gregoref84c4b2009-04-09 22:27:44 +00003153 }
Douglas Gregoref84c4b2009-04-09 22:27:44 +00003154}
3155
Douglas Gregorc5046832009-04-27 18:38:38 +00003156//===----------------------------------------------------------------------===//
3157// Declaration Serialization
3158//===----------------------------------------------------------------------===//
3159
Douglas Gregoref84c4b2009-04-09 22:27:44 +00003160/// \brief Write the block containing all of the declaration IDs
3161/// lexically declared within the given DeclContext.
3162///
3163/// \returns the offset of the DECL_CONTEXT_LEXICAL block within the
3164/// bistream, or 0 if no block was written.
Sebastian Redl55c0ad52010-08-18 23:56:21 +00003165uint64_t ASTWriter::WriteDeclContextLexicalBlock(ASTContext &Context,
Douglas Gregoref84c4b2009-04-09 22:27:44 +00003166 DeclContext *DC) {
Argyrios Kyrtzidiscfbfe782009-06-30 02:36:12 +00003167 if (DC->decls_empty())
Douglas Gregoref84c4b2009-04-09 22:27:44 +00003168 return 0;
3169
Douglas Gregor8f45df52009-04-16 22:23:12 +00003170 uint64_t Offset = Stream.GetCurrentBitNo();
Richard Smith82f8fcd2015-08-06 22:07:25 +00003171 SmallVector<uint32_t, 128> KindDeclPairs;
3172 for (const auto *D : DC->decls()) {
3173 KindDeclPairs.push_back(D->getKind());
3174 KindDeclPairs.push_back(GetDeclRef(D));
3175 }
Douglas Gregoref84c4b2009-04-09 22:27:44 +00003176
Douglas Gregora57c3ab2009-04-22 22:34:57 +00003177 ++NumLexicalDeclContexts;
Mehdi Amini57a41912015-09-10 01:46:39 +00003178 RecordData::value_type Record[] = {DECL_CONTEXT_LEXICAL};
Richard Smith82f8fcd2015-08-06 22:07:25 +00003179 Stream.EmitRecordWithBlob(DeclContextLexicalAbbrev, Record,
3180 bytes(KindDeclPairs));
Douglas Gregoref84c4b2009-04-09 22:27:44 +00003181 return Offset;
3182}
3183
Sebastian Redl55c0ad52010-08-18 23:56:21 +00003184void ASTWriter::WriteTypeDeclOffsets() {
Sebastian Redl1ea025b2010-07-16 16:36:56 +00003185 using namespace llvm;
Sebastian Redl1ea025b2010-07-16 16:36:56 +00003186
3187 // Write the type offsets array
David Blaikieb44f0bf2017-01-04 22:36:43 +00003188 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Sebastian Redl539c5062010-08-18 23:57:32 +00003189 Abbrev->Add(BitCodeAbbrevOp(TYPE_OFFSET));
Sebastian Redl1ea025b2010-07-16 16:36:56 +00003190 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // # of types
Douglas Gregor5204bde2011-08-02 16:26:37 +00003191 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // base type index
Sebastian Redl1ea025b2010-07-16 16:36:56 +00003192 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // types block
David Blaikieb44f0bf2017-01-04 22:36:43 +00003193 unsigned TypeOffsetAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Mehdi Amini57a41912015-09-10 01:46:39 +00003194 {
3195 RecordData::value_type Record[] = {TYPE_OFFSET, TypeOffsets.size(),
3196 FirstTypeID - NUM_PREDEF_TYPE_IDS};
3197 Stream.EmitRecordWithBlob(TypeOffsetAbbrev, Record, bytes(TypeOffsets));
3198 }
Sebastian Redl1ea025b2010-07-16 16:36:56 +00003199
3200 // Write the declaration offsets array
David Blaikieb44f0bf2017-01-04 22:36:43 +00003201 Abbrev = std::make_shared<BitCodeAbbrev>();
Sebastian Redl539c5062010-08-18 23:57:32 +00003202 Abbrev->Add(BitCodeAbbrevOp(DECL_OFFSET));
Sebastian Redl1ea025b2010-07-16 16:36:56 +00003203 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // # of declarations
Douglas Gregorf7180622011-08-03 15:48:04 +00003204 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // base decl ID
Sebastian Redl1ea025b2010-07-16 16:36:56 +00003205 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // declarations block
David Blaikieb44f0bf2017-01-04 22:36:43 +00003206 unsigned DeclOffsetAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Mehdi Amini57a41912015-09-10 01:46:39 +00003207 {
3208 RecordData::value_type Record[] = {DECL_OFFSET, DeclOffsets.size(),
3209 FirstDeclID - NUM_PREDEF_DECL_IDS};
3210 Stream.EmitRecordWithBlob(DeclOffsetAbbrev, Record, bytes(DeclOffsets));
3211 }
Sebastian Redl1ea025b2010-07-16 16:36:56 +00003212}
3213
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00003214void ASTWriter::WriteFileDeclIDsMap() {
3215 using namespace llvm;
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00003216
Chandler Carruthb306d732015-03-27 00:31:20 +00003217 SmallVector<std::pair<FileID, DeclIDInFileInfo *>, 64> SortedFileDeclIDs(
3218 FileDeclIDs.begin(), FileDeclIDs.end());
Mandeep Singh Grangc205d8c2018-03-27 16:50:00 +00003219 llvm::sort(SortedFileDeclIDs.begin(), SortedFileDeclIDs.end(),
3220 llvm::less_first());
Chandler Carruthb306d732015-03-27 00:31:20 +00003221
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00003222 // Join the vectors of DeclIDs from all files.
Chandler Carruthb306d732015-03-27 00:31:20 +00003223 SmallVector<DeclID, 256> FileGroupedDeclIDs;
3224 for (auto &FileDeclEntry : SortedFileDeclIDs) {
3225 DeclIDInFileInfo &Info = *FileDeclEntry.second;
3226 Info.FirstDeclIndex = FileGroupedDeclIDs.size();
3227 for (auto &LocDeclEntry : Info.DeclIDs)
3228 FileGroupedDeclIDs.push_back(LocDeclEntry.second);
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00003229 }
3230
David Blaikieb44f0bf2017-01-04 22:36:43 +00003231 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00003232 Abbrev->Add(BitCodeAbbrevOp(FILE_SORTED_DECLS));
Argyrios Kyrtzidis10e78462012-10-02 21:09:13 +00003233 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00003234 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
David Blaikieb44f0bf2017-01-04 22:36:43 +00003235 unsigned AbbrevCode = Stream.EmitAbbrev(std::move(Abbrev));
Mehdi Amini57a41912015-09-10 01:46:39 +00003236 RecordData::value_type Record[] = {FILE_SORTED_DECLS,
3237 FileGroupedDeclIDs.size()};
Reid Kleckner012665e2015-05-21 00:13:09 +00003238 Stream.EmitRecordWithBlob(AbbrevCode, Record, bytes(FileGroupedDeclIDs));
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00003239}
3240
Dmitri Gribenkoaab83832012-06-20 00:34:58 +00003241void ASTWriter::WriteComments() {
3242 Stream.EnterSubblock(COMMENTS_BLOCK_ID, 3);
Dmitri Gribenko7dd29d42012-07-06 18:19:34 +00003243 ArrayRef<RawComment *> RawComments = Context->Comments.getComments();
Dmitri Gribenkoaab83832012-06-20 00:34:58 +00003244 RecordData Record;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00003245 for (const auto *I : RawComments) {
Dmitri Gribenkoaab83832012-06-20 00:34:58 +00003246 Record.clear();
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00003247 AddSourceRange(I->getSourceRange(), Record);
3248 Record.push_back(I->getKind());
3249 Record.push_back(I->isTrailingComment());
3250 Record.push_back(I->isAlmostTrailingComment());
Dmitri Gribenkoaab83832012-06-20 00:34:58 +00003251 Stream.EmitRecord(COMMENTS_RAW_COMMENT, Record);
3252 }
3253 Stream.ExitBlock();
3254}
3255
Douglas Gregorc5046832009-04-27 18:38:38 +00003256//===----------------------------------------------------------------------===//
3257// Global Method Pool and Selector Serialization
3258//===----------------------------------------------------------------------===//
3259
Douglas Gregore84a9da2009-04-20 20:36:09 +00003260namespace {
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +00003261
Douglas Gregorc78d3462009-04-24 21:10:55 +00003262// Trait used for the on-disk hash table used in the method pool.
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00003263class ASTMethodPoolTrait {
Sebastian Redl55c0ad52010-08-18 23:56:21 +00003264 ASTWriter &Writer;
Douglas Gregorc78d3462009-04-24 21:10:55 +00003265
3266public:
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003267 using key_type = Selector;
3268 using key_type_ref = key_type;
Mike Stump11289f42009-09-09 15:08:12 +00003269
Sebastian Redl834bb972010-08-04 17:20:04 +00003270 struct data_type {
Sebastian Redl539c5062010-08-18 23:57:32 +00003271 SelectorID ID;
Sebastian Redl834bb972010-08-04 17:20:04 +00003272 ObjCMethodList Instance, Factory;
3273 };
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003274 using data_type_ref = const data_type &;
Douglas Gregorc78d3462009-04-24 21:10:55 +00003275
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003276 using hash_value_type = unsigned;
3277 using offset_type = unsigned;
Justin Bogner25463f12014-04-18 20:27:24 +00003278
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003279 explicit ASTMethodPoolTrait(ASTWriter &Writer) : Writer(Writer) {}
Mike Stump11289f42009-09-09 15:08:12 +00003280
Justin Bogner25463f12014-04-18 20:27:24 +00003281 static hash_value_type ComputeHash(Selector Sel) {
Argyrios Kyrtzidis4bd97102010-08-20 16:03:52 +00003282 return serialization::ComputeHash(Sel);
Douglas Gregorc78d3462009-04-24 21:10:55 +00003283 }
Mike Stump11289f42009-09-09 15:08:12 +00003284
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003285 std::pair<unsigned, unsigned>
Chris Lattner0e62c1c2011-07-23 10:55:15 +00003286 EmitKeyDataLength(raw_ostream& Out, Selector Sel,
Douglas Gregorc78d3462009-04-24 21:10:55 +00003287 data_type_ref Methods) {
Justin Bognere1c147c2014-03-28 22:03:19 +00003288 using namespace llvm::support;
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003289
Justin Bognere1c147c2014-03-28 22:03:19 +00003290 endian::Writer<little> LE(Out);
Douglas Gregorc78d3462009-04-24 21:10:55 +00003291 unsigned KeyLen = 2 + (Sel.getNumArgs()? Sel.getNumArgs() * 4 : 4);
Justin Bognere1c147c2014-03-28 22:03:19 +00003292 LE.write<uint16_t>(KeyLen);
Sebastian Redl834bb972010-08-04 17:20:04 +00003293 unsigned DataLen = 4 + 2 + 2; // 2 bytes for each of the method counts
3294 for (const ObjCMethodList *Method = &Methods.Instance; Method;
Argyrios Kyrtzidisd3da6e02013-04-17 00:08:58 +00003295 Method = Method->getNext())
Nico Weber2e0c8f72014-12-27 03:58:08 +00003296 if (Method->getMethod())
Douglas Gregorc78d3462009-04-24 21:10:55 +00003297 DataLen += 4;
Sebastian Redl834bb972010-08-04 17:20:04 +00003298 for (const ObjCMethodList *Method = &Methods.Factory; Method;
Argyrios Kyrtzidisd3da6e02013-04-17 00:08:58 +00003299 Method = Method->getNext())
Nico Weber2e0c8f72014-12-27 03:58:08 +00003300 if (Method->getMethod())
Douglas Gregorc78d3462009-04-24 21:10:55 +00003301 DataLen += 4;
Justin Bognere1c147c2014-03-28 22:03:19 +00003302 LE.write<uint16_t>(DataLen);
Douglas Gregorc78d3462009-04-24 21:10:55 +00003303 return std::make_pair(KeyLen, DataLen);
3304 }
Mike Stump11289f42009-09-09 15:08:12 +00003305
Chris Lattner0e62c1c2011-07-23 10:55:15 +00003306 void EmitKey(raw_ostream& Out, Selector Sel, unsigned) {
Justin Bognere1c147c2014-03-28 22:03:19 +00003307 using namespace llvm::support;
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003308
Justin Bognere1c147c2014-03-28 22:03:19 +00003309 endian::Writer<little> LE(Out);
Mike Stump11289f42009-09-09 15:08:12 +00003310 uint64_t Start = Out.tell();
Douglas Gregor95c13f52009-04-25 17:48:32 +00003311 assert((Start >> 32) == 0 && "Selector key offset too large");
3312 Writer.SetSelectorOffset(Sel, Start);
Douglas Gregorc78d3462009-04-24 21:10:55 +00003313 unsigned N = Sel.getNumArgs();
Justin Bognere1c147c2014-03-28 22:03:19 +00003314 LE.write<uint16_t>(N);
Douglas Gregorc78d3462009-04-24 21:10:55 +00003315 if (N == 0)
3316 N = 1;
3317 for (unsigned I = 0; I != N; ++I)
Justin Bognere1c147c2014-03-28 22:03:19 +00003318 LE.write<uint32_t>(
3319 Writer.getIdentifierRef(Sel.getIdentifierInfoForSlot(I)));
Douglas Gregorc78d3462009-04-24 21:10:55 +00003320 }
Mike Stump11289f42009-09-09 15:08:12 +00003321
Chris Lattner0e62c1c2011-07-23 10:55:15 +00003322 void EmitData(raw_ostream& Out, key_type_ref,
Douglas Gregor4647cfa2009-04-24 21:49:02 +00003323 data_type_ref Methods, unsigned DataLen) {
Justin Bognere1c147c2014-03-28 22:03:19 +00003324 using namespace llvm::support;
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003325
Justin Bognere1c147c2014-03-28 22:03:19 +00003326 endian::Writer<little> LE(Out);
Douglas Gregor4647cfa2009-04-24 21:49:02 +00003327 uint64_t Start = Out.tell(); (void)Start;
Justin Bognere1c147c2014-03-28 22:03:19 +00003328 LE.write<uint32_t>(Methods.ID);
Douglas Gregorc78d3462009-04-24 21:10:55 +00003329 unsigned NumInstanceMethods = 0;
Sebastian Redl834bb972010-08-04 17:20:04 +00003330 for (const ObjCMethodList *Method = &Methods.Instance; Method;
Argyrios Kyrtzidisd3da6e02013-04-17 00:08:58 +00003331 Method = Method->getNext())
Nico Weber2e0c8f72014-12-27 03:58:08 +00003332 if (Method->getMethod())
Douglas Gregorc78d3462009-04-24 21:10:55 +00003333 ++NumInstanceMethods;
3334
3335 unsigned NumFactoryMethods = 0;
Sebastian Redl834bb972010-08-04 17:20:04 +00003336 for (const ObjCMethodList *Method = &Methods.Factory; Method;
Argyrios Kyrtzidisd3da6e02013-04-17 00:08:58 +00003337 Method = Method->getNext())
Nico Weber2e0c8f72014-12-27 03:58:08 +00003338 if (Method->getMethod())
Douglas Gregorc78d3462009-04-24 21:10:55 +00003339 ++NumFactoryMethods;
3340
Argyrios Kyrtzidisd3da6e02013-04-17 00:08:58 +00003341 unsigned InstanceBits = Methods.Instance.getBits();
3342 assert(InstanceBits < 4);
Nico Weberff4b35e2014-12-27 22:14:15 +00003343 unsigned InstanceHasMoreThanOneDeclBit =
3344 Methods.Instance.hasMoreThanOneDecl();
3345 unsigned FullInstanceBits = (NumInstanceMethods << 3) |
3346 (InstanceHasMoreThanOneDeclBit << 2) |
3347 InstanceBits;
Argyrios Kyrtzidisd3da6e02013-04-17 00:08:58 +00003348 unsigned FactoryBits = Methods.Factory.getBits();
3349 assert(FactoryBits < 4);
Nico Weberff4b35e2014-12-27 22:14:15 +00003350 unsigned FactoryHasMoreThanOneDeclBit =
3351 Methods.Factory.hasMoreThanOneDecl();
3352 unsigned FullFactoryBits = (NumFactoryMethods << 3) |
3353 (FactoryHasMoreThanOneDeclBit << 2) |
3354 FactoryBits;
3355 LE.write<uint16_t>(FullInstanceBits);
3356 LE.write<uint16_t>(FullFactoryBits);
Sebastian Redl834bb972010-08-04 17:20:04 +00003357 for (const ObjCMethodList *Method = &Methods.Instance; Method;
Argyrios Kyrtzidisd3da6e02013-04-17 00:08:58 +00003358 Method = Method->getNext())
Nico Weber2e0c8f72014-12-27 03:58:08 +00003359 if (Method->getMethod())
3360 LE.write<uint32_t>(Writer.getDeclID(Method->getMethod()));
Sebastian Redl834bb972010-08-04 17:20:04 +00003361 for (const ObjCMethodList *Method = &Methods.Factory; Method;
Argyrios Kyrtzidisd3da6e02013-04-17 00:08:58 +00003362 Method = Method->getNext())
Nico Weber2e0c8f72014-12-27 03:58:08 +00003363 if (Method->getMethod())
3364 LE.write<uint32_t>(Writer.getDeclID(Method->getMethod()));
Douglas Gregor4647cfa2009-04-24 21:49:02 +00003365
3366 assert(Out.tell() - Start == DataLen && "Data length is wrong");
Douglas Gregorc78d3462009-04-24 21:10:55 +00003367 }
3368};
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +00003369
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003370} // namespace
Douglas Gregorc78d3462009-04-24 21:10:55 +00003371
Sebastian Redla19a67f2010-08-03 21:58:15 +00003372/// \brief Write ObjC data: selectors and the method pool.
Douglas Gregorc78d3462009-04-24 21:10:55 +00003373///
3374/// The method pool contains both instance and factory methods, stored
Sebastian Redla19a67f2010-08-03 21:58:15 +00003375/// in an on-disk hash table indexed by the selector. The hash table also
3376/// contains an empty entry for every other selector known to Sema.
Sebastian Redl55c0ad52010-08-18 23:56:21 +00003377void ASTWriter::WriteSelectors(Sema &SemaRef) {
Douglas Gregorc78d3462009-04-24 21:10:55 +00003378 using namespace llvm;
3379
Sebastian Redla19a67f2010-08-03 21:58:15 +00003380 // Do we have to do anything at all?
Sebastian Redl834bb972010-08-04 17:20:04 +00003381 if (SemaRef.MethodPool.empty() && SelectorIDs.empty())
Sebastian Redla19a67f2010-08-03 21:58:15 +00003382 return;
Sebastian Redld95a56e2010-08-04 18:21:41 +00003383 unsigned NumTableEntries = 0;
Sebastian Redla19a67f2010-08-03 21:58:15 +00003384 // Create and write out the blob that contains selectors and the method pool.
Douglas Gregorc78d3462009-04-24 21:10:55 +00003385 {
Justin Bognerbb094f02014-04-18 19:57:06 +00003386 llvm::OnDiskChainedHashTableGenerator<ASTMethodPoolTrait> Generator;
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003387 ASTMethodPoolTrait Trait(*this);
Mike Stump11289f42009-09-09 15:08:12 +00003388
Sebastian Redla19a67f2010-08-03 21:58:15 +00003389 // Create the on-disk hash table representation. We walk through every
3390 // selector we've seen and look it up in the method pool.
Sebastian Redld95a56e2010-08-04 18:21:41 +00003391 SelectorOffsets.resize(NextSelectorID - FirstSelectorID);
Chandler Carruthacbbeb92015-03-27 00:47:43 +00003392 for (auto &SelectorAndID : SelectorIDs) {
3393 Selector S = SelectorAndID.first;
3394 SelectorID ID = SelectorAndID.second;
Sebastian Redla19a67f2010-08-03 21:58:15 +00003395 Sema::GlobalMethodPool::iterator F = SemaRef.MethodPool.find(S);
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00003396 ASTMethodPoolTrait::data_type Data = {
Chandler Carruthacbbeb92015-03-27 00:47:43 +00003397 ID,
Sebastian Redl834bb972010-08-04 17:20:04 +00003398 ObjCMethodList(),
3399 ObjCMethodList()
3400 };
3401 if (F != SemaRef.MethodPool.end()) {
3402 Data.Instance = F->second.first;
3403 Data.Factory = F->second.second;
3404 }
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00003405 // Only write this selector if it's not in an existing AST or something
Sebastian Redld95a56e2010-08-04 18:21:41 +00003406 // changed.
Chandler Carruthacbbeb92015-03-27 00:47:43 +00003407 if (Chain && ID < FirstSelectorID) {
Sebastian Redld95a56e2010-08-04 18:21:41 +00003408 // Selector already exists. Did it change?
3409 bool changed = false;
Nico Weber2e0c8f72014-12-27 03:58:08 +00003410 for (ObjCMethodList *M = &Data.Instance;
3411 !changed && M && M->getMethod(); M = M->getNext()) {
3412 if (!M->getMethod()->isFromASTFile())
Sebastian Redld95a56e2010-08-04 18:21:41 +00003413 changed = true;
3414 }
Nico Weber2e0c8f72014-12-27 03:58:08 +00003415 for (ObjCMethodList *M = &Data.Factory; !changed && M && M->getMethod();
Argyrios Kyrtzidisd3da6e02013-04-17 00:08:58 +00003416 M = M->getNext()) {
Nico Weber2e0c8f72014-12-27 03:58:08 +00003417 if (!M->getMethod()->isFromASTFile())
Sebastian Redld95a56e2010-08-04 18:21:41 +00003418 changed = true;
3419 }
3420 if (!changed)
3421 continue;
Nico Weber2e0c8f72014-12-27 03:58:08 +00003422 } else if (Data.Instance.getMethod() || Data.Factory.getMethod()) {
Sebastian Redl6e1a2a02010-08-04 21:22:45 +00003423 // A new method pool entry.
3424 ++NumTableEntries;
Sebastian Redld95a56e2010-08-04 18:21:41 +00003425 }
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003426 Generator.insert(S, Data, Trait);
Douglas Gregorc78d3462009-04-24 21:10:55 +00003427 }
3428
Douglas Gregorc78d3462009-04-24 21:10:55 +00003429 // Create the on-disk hash table in a buffer.
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00003430 SmallString<4096> MethodPool;
Douglas Gregorc78d3462009-04-24 21:10:55 +00003431 uint32_t BucketOffset;
3432 {
Justin Bognere1c147c2014-03-28 22:03:19 +00003433 using namespace llvm::support;
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003434
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00003435 ASTMethodPoolTrait Trait(*this);
Douglas Gregorc78d3462009-04-24 21:10:55 +00003436 llvm::raw_svector_ostream Out(MethodPool);
3437 // Make sure that no bucket is at offset 0
Justin Bognere1c147c2014-03-28 22:03:19 +00003438 endian::Writer<little>(Out).write<uint32_t>(0);
Douglas Gregorc78d3462009-04-24 21:10:55 +00003439 BucketOffset = Generator.Emit(Out, Trait);
3440 }
3441
3442 // Create a blob abbreviation
David Blaikieb44f0bf2017-01-04 22:36:43 +00003443 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Sebastian Redl539c5062010-08-18 23:57:32 +00003444 Abbrev->Add(BitCodeAbbrevOp(METHOD_POOL));
Douglas Gregorc78d3462009-04-24 21:10:55 +00003445 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
Douglas Gregor95c13f52009-04-25 17:48:32 +00003446 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
Douglas Gregorc78d3462009-04-24 21:10:55 +00003447 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
David Blaikieb44f0bf2017-01-04 22:36:43 +00003448 unsigned MethodPoolAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregorc78d3462009-04-24 21:10:55 +00003449
Douglas Gregor95c13f52009-04-25 17:48:32 +00003450 // Write the method pool
Mehdi Amini57a41912015-09-10 01:46:39 +00003451 {
3452 RecordData::value_type Record[] = {METHOD_POOL, BucketOffset,
3453 NumTableEntries};
3454 Stream.EmitRecordWithBlob(MethodPoolAbbrev, Record, MethodPool);
3455 }
Douglas Gregor95c13f52009-04-25 17:48:32 +00003456
3457 // Create a blob abbreviation for the selector table offsets.
David Blaikieb44f0bf2017-01-04 22:36:43 +00003458 Abbrev = std::make_shared<BitCodeAbbrev>();
Sebastian Redl539c5062010-08-18 23:57:32 +00003459 Abbrev->Add(BitCodeAbbrevOp(SELECTOR_OFFSETS));
Douglas Gregord4c5ed02010-10-29 22:39:52 +00003460 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // size
Douglas Gregor8f364fb2011-08-03 23:28:44 +00003461 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // first ID
Douglas Gregor95c13f52009-04-25 17:48:32 +00003462 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
David Blaikieb44f0bf2017-01-04 22:36:43 +00003463 unsigned SelectorOffsetAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregor95c13f52009-04-25 17:48:32 +00003464
3465 // Write the selector offsets table.
Mehdi Amini57a41912015-09-10 01:46:39 +00003466 {
3467 RecordData::value_type Record[] = {
3468 SELECTOR_OFFSETS, SelectorOffsets.size(),
3469 FirstSelectorID - NUM_PREDEF_SELECTOR_IDS};
3470 Stream.EmitRecordWithBlob(SelectorOffsetAbbrev, Record,
3471 bytes(SelectorOffsets));
3472 }
Douglas Gregorc78d3462009-04-24 21:10:55 +00003473 }
3474}
3475
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00003476/// \brief Write the selectors referenced in @selector expression into AST file.
Sebastian Redl55c0ad52010-08-18 23:56:21 +00003477void ASTWriter::WriteReferencedSelectorsPool(Sema &SemaRef) {
Fariborz Jahanianc51609a2010-07-23 19:11:11 +00003478 using namespace llvm;
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003479
Fariborz Jahanianc51609a2010-07-23 19:11:11 +00003480 if (SemaRef.ReferencedSelectors.empty())
3481 return;
Sebastian Redlada023c2010-08-04 20:40:17 +00003482
Fariborz Jahanianc51609a2010-07-23 19:11:11 +00003483 RecordData Record;
Richard Smithe64e7452016-04-18 21:54:58 +00003484 ASTRecordWriter Writer(*this, Record);
Sebastian Redlada023c2010-08-04 20:40:17 +00003485
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00003486 // Note: this writes out all references even for a dependent AST. But it is
Sebastian Redl51c79d82010-08-04 22:21:29 +00003487 // very tricky to fix, and given that @selector shouldn't really appear in
3488 // headers, probably not worth it. It's not a correctness issue.
Chandler Carruth12c8f652015-03-27 00:55:05 +00003489 for (auto &SelectorAndLocation : SemaRef.ReferencedSelectors) {
3490 Selector Sel = SelectorAndLocation.first;
3491 SourceLocation Loc = SelectorAndLocation.second;
Richard Smithe64e7452016-04-18 21:54:58 +00003492 Writer.AddSelectorRef(Sel);
3493 Writer.AddSourceLocation(Loc);
Fariborz Jahanianc51609a2010-07-23 19:11:11 +00003494 }
Richard Smithe64e7452016-04-18 21:54:58 +00003495 Writer.Emit(REFERENCED_SELECTOR_POOL);
Fariborz Jahanianc51609a2010-07-23 19:11:11 +00003496}
3497
Douglas Gregorc5046832009-04-27 18:38:38 +00003498//===----------------------------------------------------------------------===//
3499// Identifier Table Serialization
3500//===----------------------------------------------------------------------===//
3501
Richard Smithb3761912015-02-05 23:08:52 +00003502/// Determine the declaration that should be put into the name lookup table to
3503/// represent the given declaration in this module. This is usually D itself,
3504/// but if D was imported and merged into a local declaration, we want the most
3505/// recent local declaration instead. The chosen declaration will be the most
3506/// recent declaration in any module that imports this one.
3507static NamedDecl *getDeclForLocalLookup(const LangOptions &LangOpts,
3508 NamedDecl *D) {
3509 if (!LangOpts.Modules || !D->isFromASTFile())
3510 return D;
3511
3512 if (Decl *Redecl = D->getPreviousDecl()) {
3513 // For Redeclarable decls, a prior declaration might be local.
3514 for (; Redecl; Redecl = Redecl->getPreviousDecl()) {
Richard Smithd49941b2016-04-26 23:40:43 +00003515 // If we find a local decl, we're done.
3516 if (!Redecl->isFromASTFile()) {
3517 // Exception: in very rare cases (for injected-class-names), not all
3518 // redeclarations are in the same semantic context. Skip ones in a
3519 // different context. They don't go in this lookup table at all.
3520 if (!Redecl->getDeclContext()->getRedeclContext()->Equals(
3521 D->getDeclContext()->getRedeclContext()))
3522 continue;
Richard Smithb3761912015-02-05 23:08:52 +00003523 return cast<NamedDecl>(Redecl);
Richard Smithd49941b2016-04-26 23:40:43 +00003524 }
3525
Richard Smithfe620d22015-03-05 23:24:12 +00003526 // If we find a decl from a (chained-)PCH stop since we won't find a
Richard Smithb3761912015-02-05 23:08:52 +00003527 // local one.
Richard Smithd49941b2016-04-26 23:40:43 +00003528 if (Redecl->getOwningModuleID() == 0)
Richard Smithb3761912015-02-05 23:08:52 +00003529 break;
3530 }
3531 } else if (Decl *First = D->getCanonicalDecl()) {
3532 // For Mergeable decls, the first decl might be local.
3533 if (!First->isFromASTFile())
3534 return cast<NamedDecl>(First);
3535 }
3536
3537 // All declarations are imported. Our most recent declaration will also be
3538 // the most recent one in anyone who imports us.
3539 return D;
3540}
3541
Douglas Gregorc78d3462009-04-24 21:10:55 +00003542namespace {
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +00003543
Richard Smithcf97cf62015-04-19 01:34:23 +00003544class ASTIdentifierTableTrait {
3545 ASTWriter &Writer;
3546 Preprocessor &PP;
3547 IdentifierResolver &IdResolver;
Richard Smith9c254182015-07-19 21:41:12 +00003548 bool IsModule;
Richard Smitha534a312015-07-21 23:54:07 +00003549 bool NeedDecls;
Richard Smith33e0f7e2015-07-22 02:08:40 +00003550 ASTWriter::RecordData *InterestingIdentifierOffsets;
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00003551
Richard Smithcf97cf62015-04-19 01:34:23 +00003552 /// \brief Determines whether this is an "interesting" identifier that needs a
3553 /// full IdentifierInfo structure written into the hash table. Notably, this
3554 /// doesn't check whether the name has macros defined; use PublicMacroIterator
3555 /// to check that.
Richard Smith9c254182015-07-19 21:41:12 +00003556 bool isInterestingIdentifier(const IdentifierInfo *II, uint64_t MacroOffset) {
Richard Smithd7329392015-04-21 21:46:32 +00003557 if (MacroOffset ||
3558 II->isPoisoned() ||
Richard Smith9c254182015-07-19 21:41:12 +00003559 (IsModule ? II->hasRevertedBuiltin() : II->getObjCOrBuiltinID()) ||
Richard Smithcf97cf62015-04-19 01:34:23 +00003560 II->hasRevertedTokenIDToIdentifier() ||
Richard Smitha534a312015-07-21 23:54:07 +00003561 (NeedDecls && II->getFETokenInfo<void>()))
Richard Smithcf97cf62015-04-19 01:34:23 +00003562 return true;
3563
3564 return false;
3565 }
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00003566
Douglas Gregore84a9da2009-04-20 20:36:09 +00003567public:
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003568 using key_type = IdentifierInfo *;
3569 using key_type_ref = key_type;
Mike Stump11289f42009-09-09 15:08:12 +00003570
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003571 using data_type = IdentID;
3572 using data_type_ref = data_type;
Mike Stump11289f42009-09-09 15:08:12 +00003573
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003574 using hash_value_type = unsigned;
3575 using offset_type = unsigned;
Justin Bogner25463f12014-04-18 20:27:24 +00003576
Richard Smithd7329392015-04-21 21:46:32 +00003577 ASTIdentifierTableTrait(ASTWriter &Writer, Preprocessor &PP,
Richard Smith33e0f7e2015-07-22 02:08:40 +00003578 IdentifierResolver &IdResolver, bool IsModule,
3579 ASTWriter::RecordData *InterestingIdentifierOffsets)
Richard Smitha534a312015-07-21 23:54:07 +00003580 : Writer(Writer), PP(PP), IdResolver(IdResolver), IsModule(IsModule),
Richard Smith33e0f7e2015-07-22 02:08:40 +00003581 NeedDecls(!IsModule || !Writer.getLangOpts().CPlusPlus),
3582 InterestingIdentifierOffsets(InterestingIdentifierOffsets) {}
Douglas Gregore84a9da2009-04-20 20:36:09 +00003583
Richard Smithd79514e2016-02-05 19:03:40 +00003584 bool needDecls() const { return NeedDecls; }
3585
Justin Bogner25463f12014-04-18 20:27:24 +00003586 static hash_value_type ComputeHash(const IdentifierInfo* II) {
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00003587 return llvm::djbHash(II->getName());
Douglas Gregore84a9da2009-04-20 20:36:09 +00003588 }
Mike Stump11289f42009-09-09 15:08:12 +00003589
Richard Smith33e0f7e2015-07-22 02:08:40 +00003590 bool isInterestingIdentifier(const IdentifierInfo *II) {
3591 auto MacroOffset = Writer.getMacroDirectivesOffset(II);
3592 return isInterestingIdentifier(II, MacroOffset);
3593 }
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +00003594
Richard Smith9c254182015-07-19 21:41:12 +00003595 bool isInterestingNonMacroIdentifier(const IdentifierInfo *II) {
3596 return isInterestingIdentifier(II, 0);
3597 }
3598
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003599 std::pair<unsigned, unsigned>
Douglas Gregor935bc7a22011-10-27 09:33:13 +00003600 EmitKeyDataLength(raw_ostream& Out, IdentifierInfo* II, IdentID ID) {
Daniel Dunbar2c422dc92009-10-18 20:26:12 +00003601 unsigned KeyLen = II->getLength() + 1;
Douglas Gregor1d583f22009-04-28 21:18:29 +00003602 unsigned DataLen = 4; // 4 bytes for the persistent ID << 1
Richard Smithd7329392015-04-21 21:46:32 +00003603 auto MacroOffset = Writer.getMacroDirectivesOffset(II);
3604 if (isInterestingIdentifier(II, MacroOffset)) {
Alexander Kornienko1d26c022012-09-25 17:18:14 +00003605 DataLen += 2; // 2 bytes for builtin ID
3606 DataLen += 2; // 2 bytes for flags
Richard Smithd7329392015-04-21 21:46:32 +00003607 if (MacroOffset)
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00003608 DataLen += 4; // MacroDirectives offset.
Alexander Kornienko1d26c022012-09-25 17:18:14 +00003609
Richard Smitha534a312015-07-21 23:54:07 +00003610 if (NeedDecls) {
3611 for (IdentifierResolver::iterator D = IdResolver.begin(II),
3612 DEnd = IdResolver.end();
3613 D != DEnd; ++D)
3614 DataLen += 4;
3615 }
Douglas Gregor1d583f22009-04-28 21:18:29 +00003616 }
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003617
Justin Bognere1c147c2014-03-28 22:03:19 +00003618 using namespace llvm::support;
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003619
Justin Bognere1c147c2014-03-28 22:03:19 +00003620 endian::Writer<little> LE(Out);
3621
Richard Smithdf8a8312015-03-13 04:05:01 +00003622 assert((uint16_t)DataLen == DataLen && (uint16_t)KeyLen == KeyLen);
Justin Bognere1c147c2014-03-28 22:03:19 +00003623 LE.write<uint16_t>(DataLen);
Douglas Gregorab4df582009-04-28 20:01:51 +00003624 // We emit the key length after the data length so that every
3625 // string is preceded by a 16-bit length. This matches the PTH
3626 // format for storing identifiers.
Justin Bognere1c147c2014-03-28 22:03:19 +00003627 LE.write<uint16_t>(KeyLen);
Douglas Gregore84a9da2009-04-20 20:36:09 +00003628 return std::make_pair(KeyLen, DataLen);
3629 }
Mike Stump11289f42009-09-09 15:08:12 +00003630
Chris Lattner0e62c1c2011-07-23 10:55:15 +00003631 void EmitKey(raw_ostream& Out, const IdentifierInfo* II,
Douglas Gregore84a9da2009-04-20 20:36:09 +00003632 unsigned KeyLen) {
3633 // Record the location of the key data. This is used when generating
3634 // the mapping from persistent IDs to strings.
3635 Writer.SetIdentifierOffset(II, Out.tell());
Richard Smith33e0f7e2015-07-22 02:08:40 +00003636
3637 // Emit the offset of the key/data length information to the interesting
3638 // identifiers table if necessary.
3639 if (InterestingIdentifierOffsets && isInterestingIdentifier(II))
3640 InterestingIdentifierOffsets->push_back(Out.tell() - 4);
3641
Daniel Dunbar2c422dc92009-10-18 20:26:12 +00003642 Out.write(II->getNameStart(), KeyLen);
Douglas Gregore84a9da2009-04-20 20:36:09 +00003643 }
Mike Stump11289f42009-09-09 15:08:12 +00003644
Douglas Gregor4a69c2e2011-09-01 17:04:32 +00003645 void EmitData(raw_ostream& Out, IdentifierInfo* II,
Sebastian Redl539c5062010-08-18 23:57:32 +00003646 IdentID ID, unsigned) {
Justin Bognere1c147c2014-03-28 22:03:19 +00003647 using namespace llvm::support;
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003648
Justin Bognere1c147c2014-03-28 22:03:19 +00003649 endian::Writer<little> LE(Out);
Richard Smithcf97cf62015-04-19 01:34:23 +00003650
Richard Smithd7329392015-04-21 21:46:32 +00003651 auto MacroOffset = Writer.getMacroDirectivesOffset(II);
3652 if (!isInterestingIdentifier(II, MacroOffset)) {
Justin Bognere1c147c2014-03-28 22:03:19 +00003653 LE.write<uint32_t>(ID << 1);
Douglas Gregor1d583f22009-04-28 21:18:29 +00003654 return;
3655 }
Douglas Gregorb9256522009-04-28 21:32:13 +00003656
Justin Bognere1c147c2014-03-28 22:03:19 +00003657 LE.write<uint32_t>((ID << 1) | 0x01);
Alexander Kornienko1d26c022012-09-25 17:18:14 +00003658 uint32_t Bits = (uint32_t)II->getObjCOrBuiltinID();
3659 assert((Bits & 0xffff) == Bits && "ObjCOrBuiltinID too big for ASTReader.");
Justin Bognere1c147c2014-03-28 22:03:19 +00003660 LE.write<uint16_t>(Bits);
Alexander Kornienko1d26c022012-09-25 17:18:14 +00003661 Bits = 0;
Richard Smithd7329392015-04-21 21:46:32 +00003662 bool HadMacroDefinition = MacroOffset != 0;
Alexander Kornienko1d26c022012-09-25 17:18:14 +00003663 Bits = (Bits << 1) | unsigned(HadMacroDefinition);
Daniel Dunbar91b640a2009-12-18 20:58:47 +00003664 Bits = (Bits << 1) | unsigned(II->isExtensionToken());
3665 Bits = (Bits << 1) | unsigned(II->isPoisoned());
Richard Smith9c254182015-07-19 21:41:12 +00003666 Bits = (Bits << 1) | unsigned(II->hasRevertedBuiltin());
Argyrios Kyrtzidis3084a612010-08-11 22:55:12 +00003667 Bits = (Bits << 1) | unsigned(II->hasRevertedTokenIDToIdentifier());
Daniel Dunbar91b640a2009-12-18 20:58:47 +00003668 Bits = (Bits << 1) | unsigned(II->isCPlusPlusOperatorKeyword());
Justin Bognere1c147c2014-03-28 22:03:19 +00003669 LE.write<uint16_t>(Bits);
Douglas Gregore84a9da2009-04-20 20:36:09 +00003670
Richard Smithd7329392015-04-21 21:46:32 +00003671 if (HadMacroDefinition)
3672 LE.write<uint32_t>(MacroOffset);
Alexander Kornienko1d26c022012-09-25 17:18:14 +00003673
Richard Smitha534a312015-07-21 23:54:07 +00003674 if (NeedDecls) {
3675 // Emit the declaration IDs in reverse order, because the
3676 // IdentifierResolver provides the declarations as they would be
3677 // visible (e.g., the function "stat" would come before the struct
3678 // "stat"), but the ASTReader adds declarations to the end of the list
3679 // (so we need to see the struct "stat" before the function "stat").
3680 // Only emit declarations that aren't from a chained PCH, though.
3681 SmallVector<NamedDecl *, 16> Decls(IdResolver.begin(II),
3682 IdResolver.end());
3683 for (SmallVectorImpl<NamedDecl *>::reverse_iterator D = Decls.rbegin(),
3684 DEnd = Decls.rend();
3685 D != DEnd; ++D)
3686 LE.write<uint32_t>(
3687 Writer.getDeclID(getDeclForLocalLookup(PP.getLangOpts(), *D)));
3688 }
Douglas Gregore84a9da2009-04-20 20:36:09 +00003689 }
3690};
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +00003691
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003692} // namespace
Douglas Gregore84a9da2009-04-20 20:36:09 +00003693
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00003694/// \brief Write the identifier table into the AST file.
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00003695///
3696/// The identifier table consists of a blob containing string data
3697/// (the actual identifiers themselves) and a separate "offsets" index
3698/// that maps identifier IDs to locations within the blob.
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00003699void ASTWriter::WriteIdentifierTable(Preprocessor &PP,
Douglas Gregor935bc7a22011-10-27 09:33:13 +00003700 IdentifierResolver &IdResolver,
3701 bool IsModule) {
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00003702 using namespace llvm;
3703
Richard Smith33e0f7e2015-07-22 02:08:40 +00003704 RecordData InterestingIdents;
3705
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00003706 // Create and write out the blob that contains the identifier
3707 // strings.
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00003708 {
Justin Bognerbb094f02014-04-18 19:57:06 +00003709 llvm::OnDiskChainedHashTableGenerator<ASTIdentifierTableTrait> Generator;
Richard Smith33e0f7e2015-07-22 02:08:40 +00003710 ASTIdentifierTableTrait Trait(
3711 *this, PP, IdResolver, IsModule,
3712 (getLangOpts().CPlusPlus && IsModule) ? &InterestingIdents : nullptr);
Mike Stump11289f42009-09-09 15:08:12 +00003713
Douglas Gregore6648fb2009-04-28 20:33:11 +00003714 // Look for any identifiers that were named while processing the
3715 // headers, but are otherwise not needed. We add these to the hash
3716 // table to enable checking of the predefines buffer in the case
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00003717 // where the user adds new macro definitions when building the AST
Douglas Gregore6648fb2009-04-28 20:33:11 +00003718 // file.
Chandler Carruth8440c982015-03-26 23:54:15 +00003719 SmallVector<const IdentifierInfo *, 128> IIs;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00003720 for (const auto &ID : PP.getIdentifierTable())
3721 IIs.push_back(ID.second);
Chandler Carruth8440c982015-03-26 23:54:15 +00003722 // Sort the identifiers lexicographically before getting them references so
3723 // that their order is stable.
Mandeep Singh Grangc205d8c2018-03-27 16:50:00 +00003724 llvm::sort(IIs.begin(), IIs.end(), llvm::less_ptr<IdentifierInfo>());
Chandler Carruth8440c982015-03-26 23:54:15 +00003725 for (const IdentifierInfo *II : IIs)
Richard Smith9c254182015-07-19 21:41:12 +00003726 if (Trait.isInterestingNonMacroIdentifier(II))
3727 getIdentifierRef(II);
Douglas Gregore6648fb2009-04-28 20:33:11 +00003728
Sebastian Redlff4a2952010-07-23 23:49:55 +00003729 // Create the on-disk hash table representation. We only store offsets
3730 // for identifiers that appear here for the first time.
3731 IdentifierOffsets.resize(NextIdentID - FirstIdentID);
Chandler Carruth885e78c2015-03-24 21:18:10 +00003732 for (auto IdentIDPair : IdentifierIDs) {
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00003733 auto *II = const_cast<IdentifierInfo *>(IdentIDPair.first);
Chandler Carruth885e78c2015-03-24 21:18:10 +00003734 IdentID ID = IdentIDPair.second;
3735 assert(II && "NULL identifier in identifier table");
Vassil Vassilev262f41e2016-03-30 20:16:03 +00003736 // Write out identifiers if either the ID is local or the identifier has
3737 // changed since it was loaded.
3738 if (ID >= FirstIdentID || !Chain || !II->isFromAST()
3739 || II->hasChangedSinceDeserialization() ||
Richard Smithd79514e2016-02-05 19:03:40 +00003740 (Trait.needDecls() &&
3741 II->hasFETokenInfoChangedSinceDeserialization()))
Chandler Carruth885e78c2015-03-24 21:18:10 +00003742 Generator.insert(II, ID, Trait);
Douglas Gregore84a9da2009-04-20 20:36:09 +00003743 }
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00003744
Douglas Gregore84a9da2009-04-20 20:36:09 +00003745 // Create the on-disk hash table in a buffer.
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00003746 SmallString<4096> IdentifierTable;
Douglas Gregora868bbd2009-04-21 22:25:48 +00003747 uint32_t BucketOffset;
Douglas Gregore84a9da2009-04-20 20:36:09 +00003748 {
Justin Bognere1c147c2014-03-28 22:03:19 +00003749 using namespace llvm::support;
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003750
Douglas Gregore84a9da2009-04-20 20:36:09 +00003751 llvm::raw_svector_ostream Out(IdentifierTable);
Douglas Gregorc78d3462009-04-24 21:10:55 +00003752 // Make sure that no bucket is at offset 0
Justin Bognere1c147c2014-03-28 22:03:19 +00003753 endian::Writer<little>(Out).write<uint32_t>(0);
Douglas Gregora868bbd2009-04-21 22:25:48 +00003754 BucketOffset = Generator.Emit(Out, Trait);
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00003755 }
3756
3757 // Create a blob abbreviation
David Blaikieb44f0bf2017-01-04 22:36:43 +00003758 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Sebastian Redl539c5062010-08-18 23:57:32 +00003759 Abbrev->Add(BitCodeAbbrevOp(IDENTIFIER_TABLE));
Douglas Gregora868bbd2009-04-21 22:25:48 +00003760 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
Douglas Gregore84a9da2009-04-20 20:36:09 +00003761 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
David Blaikieb44f0bf2017-01-04 22:36:43 +00003762 unsigned IDTableAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00003763
3764 // Write the identifier table
Mehdi Amini57a41912015-09-10 01:46:39 +00003765 RecordData::value_type Record[] = {IDENTIFIER_TABLE, BucketOffset};
Yaron Keren92e1b622015-03-18 10:17:07 +00003766 Stream.EmitRecordWithBlob(IDTableAbbrev, Record, IdentifierTable);
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00003767 }
3768
3769 // Write the offsets table for identifier IDs.
David Blaikieb44f0bf2017-01-04 22:36:43 +00003770 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Sebastian Redl539c5062010-08-18 23:57:32 +00003771 Abbrev->Add(BitCodeAbbrevOp(IDENTIFIER_OFFSET));
Douglas Gregor0e149972009-04-25 19:10:14 +00003772 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // # of identifiers
Douglas Gregor1ab036c2011-08-03 21:49:18 +00003773 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // first ID
Douglas Gregor0e149972009-04-25 19:10:14 +00003774 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
David Blaikieb44f0bf2017-01-04 22:36:43 +00003775 unsigned IdentifierOffsetAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregor0e149972009-04-25 19:10:14 +00003776
Douglas Gregor8d7edce2013-02-08 21:30:59 +00003777#ifndef NDEBUG
3778 for (unsigned I = 0, N = IdentifierOffsets.size(); I != N; ++I)
3779 assert(IdentifierOffsets[I] && "Missing identifier offset?");
3780#endif
Mehdi Amini57a41912015-09-10 01:46:39 +00003781
3782 RecordData::value_type Record[] = {IDENTIFIER_OFFSET,
3783 IdentifierOffsets.size(),
3784 FirstIdentID - NUM_PREDEF_IDENT_IDS};
Douglas Gregor0e149972009-04-25 19:10:14 +00003785 Stream.EmitRecordWithBlob(IdentifierOffsetAbbrev, Record,
Reid Kleckner012665e2015-05-21 00:13:09 +00003786 bytes(IdentifierOffsets));
Richard Smith33e0f7e2015-07-22 02:08:40 +00003787
3788 // In C++, write the list of interesting identifiers (those that are
3789 // defined as macros, poisoned, or similar unusual things).
3790 if (!InterestingIdents.empty())
3791 Stream.EmitRecord(INTERESTING_IDENTIFIERS, InterestingIdents);
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00003792}
3793
Douglas Gregorc5046832009-04-27 18:38:38 +00003794//===----------------------------------------------------------------------===//
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003795// DeclContext's Name Lookup Table Serialization
3796//===----------------------------------------------------------------------===//
3797
3798namespace {
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +00003799
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003800// Trait used for the on-disk hash table used in the method pool.
3801class ASTDeclContextNameLookupTrait {
3802 ASTWriter &Writer;
Richard Smithd88a7f12015-09-01 20:35:42 +00003803 llvm::SmallVector<DeclID, 64> DeclIDs;
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003804
3805public:
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003806 using key_type = DeclarationNameKey;
3807 using key_type_ref = key_type;
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003808
Richard Smithd88a7f12015-09-01 20:35:42 +00003809 /// A start and end index into DeclIDs, representing a sequence of decls.
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003810 using data_type = std::pair<unsigned, unsigned>;
3811 using data_type_ref = const data_type &;
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003812
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003813 using hash_value_type = unsigned;
3814 using offset_type = unsigned;
Justin Bogner25463f12014-04-18 20:27:24 +00003815
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003816 explicit ASTDeclContextNameLookupTrait(ASTWriter &Writer) : Writer(Writer) {}
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003817
Richard Smithd88a7f12015-09-01 20:35:42 +00003818 template<typename Coll>
3819 data_type getData(const Coll &Decls) {
3820 unsigned Start = DeclIDs.size();
3821 for (NamedDecl *D : Decls) {
3822 DeclIDs.push_back(
3823 Writer.GetDeclRef(getDeclForLocalLookup(Writer.getLangOpts(), D)));
3824 }
3825 return std::make_pair(Start, DeclIDs.size());
3826 }
3827
3828 data_type ImportData(const reader::ASTDeclContextNameLookupTrait::data_type &FromReader) {
3829 unsigned Start = DeclIDs.size();
3830 for (auto ID : FromReader)
3831 DeclIDs.push_back(ID);
3832 return std::make_pair(Start, DeclIDs.size());
3833 }
3834
3835 static bool EqualKey(key_type_ref a, key_type_ref b) {
3836 return a == b;
3837 }
3838
Richard Smitha06c7e62015-08-26 23:55:49 +00003839 hash_value_type ComputeHash(DeclarationNameKey Name) {
3840 return Name.getHash();
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003841 }
3842
Richard Smithd88a7f12015-09-01 20:35:42 +00003843 void EmitFileRef(raw_ostream &Out, ModuleFile *F) const {
3844 assert(Writer.hasChain() &&
3845 "have reference to loaded module file but no chain?");
3846
3847 using namespace llvm::support;
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003848
Richard Smithd88a7f12015-09-01 20:35:42 +00003849 endian::Writer<little>(Out)
3850 .write<uint32_t>(Writer.getChain()->getModuleFileID(F));
3851 }
3852
Richard Smitha06c7e62015-08-26 23:55:49 +00003853 std::pair<unsigned, unsigned> EmitKeyDataLength(raw_ostream &Out,
3854 DeclarationNameKey Name,
3855 data_type_ref Lookup) {
Justin Bognere1c147c2014-03-28 22:03:19 +00003856 using namespace llvm::support;
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003857
Justin Bognere1c147c2014-03-28 22:03:19 +00003858 endian::Writer<little> LE(Out);
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003859 unsigned KeyLen = 1;
Richard Smitha06c7e62015-08-26 23:55:49 +00003860 switch (Name.getKind()) {
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003861 case DeclarationName::Identifier:
3862 case DeclarationName::ObjCZeroArgSelector:
3863 case DeclarationName::ObjCOneArgSelector:
3864 case DeclarationName::ObjCMultiArgSelector:
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003865 case DeclarationName::CXXLiteralOperatorName:
Richard Smith35845152017-02-07 01:37:30 +00003866 case DeclarationName::CXXDeductionGuideName:
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003867 KeyLen += 4;
3868 break;
3869 case DeclarationName::CXXOperatorName:
3870 KeyLen += 1;
3871 break;
Douglas Gregor3b65ed02011-08-02 18:32:54 +00003872 case DeclarationName::CXXConstructorName:
3873 case DeclarationName::CXXDestructorName:
3874 case DeclarationName::CXXConversionFunctionName:
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003875 case DeclarationName::CXXUsingDirective:
3876 break;
3877 }
Justin Bognere1c147c2014-03-28 22:03:19 +00003878 LE.write<uint16_t>(KeyLen);
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003879
Richard Smithf02662d2015-07-30 03:17:16 +00003880 // 4 bytes for each DeclID.
Richard Smithd88a7f12015-09-01 20:35:42 +00003881 unsigned DataLen = 4 * (Lookup.second - Lookup.first);
3882 assert(uint16_t(DataLen) == DataLen &&
3883 "too many decls for serialized lookup result");
Justin Bognere1c147c2014-03-28 22:03:19 +00003884 LE.write<uint16_t>(DataLen);
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003885
3886 return std::make_pair(KeyLen, DataLen);
3887 }
3888
Richard Smitha06c7e62015-08-26 23:55:49 +00003889 void EmitKey(raw_ostream &Out, DeclarationNameKey Name, unsigned) {
Justin Bognere1c147c2014-03-28 22:03:19 +00003890 using namespace llvm::support;
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003891
Justin Bognere1c147c2014-03-28 22:03:19 +00003892 endian::Writer<little> LE(Out);
Richard Smitha06c7e62015-08-26 23:55:49 +00003893 LE.write<uint8_t>(Name.getKind());
3894 switch (Name.getKind()) {
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003895 case DeclarationName::Identifier:
Richard Smitha06c7e62015-08-26 23:55:49 +00003896 case DeclarationName::CXXLiteralOperatorName:
Richard Smith35845152017-02-07 01:37:30 +00003897 case DeclarationName::CXXDeductionGuideName:
Richard Smitha06c7e62015-08-26 23:55:49 +00003898 LE.write<uint32_t>(Writer.getIdentifierRef(Name.getIdentifier()));
Benjamin Kramer53750b12012-09-19 13:40:40 +00003899 return;
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003900 case DeclarationName::ObjCZeroArgSelector:
3901 case DeclarationName::ObjCOneArgSelector:
3902 case DeclarationName::ObjCMultiArgSelector:
Richard Smitha06c7e62015-08-26 23:55:49 +00003903 LE.write<uint32_t>(Writer.getSelectorRef(Name.getSelector()));
Benjamin Kramer53750b12012-09-19 13:40:40 +00003904 return;
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003905 case DeclarationName::CXXOperatorName:
Richard Smitha06c7e62015-08-26 23:55:49 +00003906 assert(Name.getOperatorKind() < NUM_OVERLOADED_OPERATORS &&
Benjamin Kramer53750b12012-09-19 13:40:40 +00003907 "Invalid operator?");
Richard Smitha06c7e62015-08-26 23:55:49 +00003908 LE.write<uint8_t>(Name.getOperatorKind());
Benjamin Kramer53750b12012-09-19 13:40:40 +00003909 return;
Douglas Gregor3b65ed02011-08-02 18:32:54 +00003910 case DeclarationName::CXXConstructorName:
3911 case DeclarationName::CXXDestructorName:
3912 case DeclarationName::CXXConversionFunctionName:
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003913 case DeclarationName::CXXUsingDirective:
Benjamin Kramer53750b12012-09-19 13:40:40 +00003914 return;
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003915 }
Benjamin Kramer53750b12012-09-19 13:40:40 +00003916
3917 llvm_unreachable("Invalid name kind?");
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003918 }
3919
Richard Smitha06c7e62015-08-26 23:55:49 +00003920 void EmitData(raw_ostream &Out, key_type_ref, data_type Lookup,
3921 unsigned DataLen) {
Justin Bognere1c147c2014-03-28 22:03:19 +00003922 using namespace llvm::support;
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003923
Justin Bognere1c147c2014-03-28 22:03:19 +00003924 endian::Writer<little> LE(Out);
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003925 uint64_t Start = Out.tell(); (void)Start;
Richard Smithd88a7f12015-09-01 20:35:42 +00003926 for (unsigned I = Lookup.first, N = Lookup.second; I != N; ++I)
3927 LE.write<uint32_t>(DeclIDs[I]);
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003928 assert(Out.tell() - Start == DataLen && "Data length is wrong");
3929 }
3930};
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +00003931
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003932} // namespace
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003933
Chandler Carruthe972c362015-03-26 03:11:40 +00003934bool ASTWriter::isLookupResultExternal(StoredDeclsList &Result,
3935 DeclContext *DC) {
3936 return Result.hasExternalDecls() && DC->NeedToReconcileExternalVisibleStorage;
3937}
3938
3939bool ASTWriter::isLookupResultEntirelyExternal(StoredDeclsList &Result,
3940 DeclContext *DC) {
3941 for (auto *D : Result.getLookupResult())
3942 if (!getDeclForLocalLookup(getLangOpts(), D)->isFromASTFile())
3943 return false;
3944
3945 return true;
3946}
3947
Richard Smithd88a7f12015-09-01 20:35:42 +00003948void
Chandler Carruthe972c362015-03-26 03:11:40 +00003949ASTWriter::GenerateNameLookupTable(const DeclContext *ConstDC,
Richard Smithcd45dbc2014-04-19 03:48:30 +00003950 llvm::SmallVectorImpl<char> &LookupTable) {
Chandler Carruthe972c362015-03-26 03:11:40 +00003951 assert(!ConstDC->HasLazyLocalLexicalLookups &&
3952 !ConstDC->HasLazyExternalLexicalLookups &&
Richard Smith9e2341d2015-03-23 03:25:59 +00003953 "must call buildLookups first");
Richard Smithcd45dbc2014-04-19 03:48:30 +00003954
Chandler Carruthe972c362015-03-26 03:11:40 +00003955 // FIXME: We need to build the lookups table, which is logically const.
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00003956 auto *DC = const_cast<DeclContext*>(ConstDC);
Chandler Carruthe972c362015-03-26 03:11:40 +00003957 assert(DC == DC->getPrimaryContext() && "only primary DC has lookup table");
3958
3959 // Create the on-disk hash table representation.
Richard Smithd88a7f12015-09-01 20:35:42 +00003960 MultiOnDiskHashTableGenerator<reader::ASTDeclContextNameLookupTrait,
3961 ASTDeclContextNameLookupTrait> Generator;
Richard Smithcd45dbc2014-04-19 03:48:30 +00003962 ASTDeclContextNameLookupTrait Trait(*this);
3963
Chandler Carruthe972c362015-03-26 03:11:40 +00003964 // The first step is to collect the declaration names which we need to
3965 // serialize into the name lookup table, and to collect them in a stable
3966 // order.
3967 SmallVector<DeclarationName, 16> Names;
Richard Smithcd45dbc2014-04-19 03:48:30 +00003968
Chandler Carruthe972c362015-03-26 03:11:40 +00003969 // We also build up small sets of the constructor and conversion function
3970 // names which are visible.
3971 llvm::SmallSet<DeclarationName, 8> ConstructorNameSet, ConversionNameSet;
Richard Smithcd45dbc2014-04-19 03:48:30 +00003972
Chandler Carruthe972c362015-03-26 03:11:40 +00003973 for (auto &Lookup : *DC->buildLookup()) {
3974 auto &Name = Lookup.first;
3975 auto &Result = Lookup.second;
3976
Douglas Gregor7dd37e52015-11-03 01:20:54 +00003977 // If there are no local declarations in our lookup result, we
3978 // don't need to write an entry for the name at all. If we can't
3979 // write out a lookup set without performing more deserialization,
3980 // just skip this entry.
3981 if (isLookupResultExternal(Result, DC) &&
Chandler Carruthe972c362015-03-26 03:11:40 +00003982 isLookupResultEntirelyExternal(Result, DC))
3983 continue;
3984
3985 // We also skip empty results. If any of the results could be external and
3986 // the currently available results are empty, then all of the results are
3987 // external and we skip it above. So the only way we get here with an empty
3988 // results is when no results could have been external *and* we have
3989 // external results.
3990 //
3991 // FIXME: While we might want to start emitting on-disk entries for negative
3992 // lookups into a decl context as an optimization, today we *have* to skip
3993 // them because there are names with empty lookup results in decl contexts
3994 // which we can't emit in any stable ordering: we lookup constructors and
3995 // conversion functions in the enclosing namespace scope creating empty
3996 // results for them. This in almost certainly a bug in Clang's name lookup,
3997 // but that is likely to be hard or impossible to fix and so we tolerate it
3998 // here by omitting lookups with empty results.
3999 if (Lookup.second.getLookupResult().empty())
4000 continue;
4001
4002 switch (Lookup.first.getNameKind()) {
4003 default:
4004 Names.push_back(Lookup.first);
4005 break;
4006
Richard Smithcd45dbc2014-04-19 03:48:30 +00004007 case DeclarationName::CXXConstructorName:
Chandler Carruthe972c362015-03-26 03:11:40 +00004008 assert(isa<CXXRecordDecl>(DC) &&
4009 "Cannot have a constructor name outside of a class!");
4010 ConstructorNameSet.insert(Name);
4011 break;
Richard Smithcd45dbc2014-04-19 03:48:30 +00004012
4013 case DeclarationName::CXXConversionFunctionName:
Chandler Carruthe972c362015-03-26 03:11:40 +00004014 assert(isa<CXXRecordDecl>(DC) &&
4015 "Cannot have a conversion function name outside of a class!");
4016 ConversionNameSet.insert(Name);
Rafael Espindolac606b3e2015-03-25 04:43:15 +00004017 break;
Richard Smithcd45dbc2014-04-19 03:48:30 +00004018 }
Chandler Carruth75c9f132015-03-25 00:34:51 +00004019 }
Chandler Carruth75c9f132015-03-25 00:34:51 +00004020
Chandler Carruthe972c362015-03-26 03:11:40 +00004021 // Sort the names into a stable order.
Mandeep Singh Grangc205d8c2018-03-27 16:50:00 +00004022 llvm::sort(Names.begin(), Names.end());
Chandler Carruthe972c362015-03-26 03:11:40 +00004023
Chandler Carruthffbf7052015-03-26 22:27:09 +00004024 if (auto *D = dyn_cast<CXXRecordDecl>(DC)) {
Chandler Carruthe972c362015-03-26 03:11:40 +00004025 // We need to establish an ordering of constructor and conversion function
Chandler Carruthffbf7052015-03-26 22:27:09 +00004026 // names, and they don't have an intrinsic ordering.
Chandler Carruthe972c362015-03-26 03:11:40 +00004027
Chandler Carruthffbf7052015-03-26 22:27:09 +00004028 // First we try the easy case by forming the current context's constructor
4029 // name and adding that name first. This is a very useful optimization to
4030 // avoid walking the lexical declarations in many cases, and it also
4031 // handles the only case where a constructor name can come from some other
4032 // lexical context -- when that name is an implicit constructor merged from
4033 // another declaration in the redecl chain. Any non-implicit constructor or
4034 // conversion function which doesn't occur in all the lexical contexts
4035 // would be an ODR violation.
4036 auto ImplicitCtorName = Context->DeclarationNames.getCXXConstructorName(
4037 Context->getCanonicalType(Context->getRecordType(D)));
4038 if (ConstructorNameSet.erase(ImplicitCtorName))
4039 Names.push_back(ImplicitCtorName);
Chandler Carruthe972c362015-03-26 03:11:40 +00004040
Chandler Carruthffbf7052015-03-26 22:27:09 +00004041 // If we still have constructors or conversion functions, we walk all the
4042 // names in the decl and add the constructors and conversion functions
4043 // which are visible in the order they lexically occur within the context.
4044 if (!ConstructorNameSet.empty() || !ConversionNameSet.empty())
4045 for (Decl *ChildD : cast<CXXRecordDecl>(DC)->decls())
4046 if (auto *ChildND = dyn_cast<NamedDecl>(ChildD)) {
4047 auto Name = ChildND->getDeclName();
4048 switch (Name.getNameKind()) {
4049 default:
4050 continue;
4051
4052 case DeclarationName::CXXConstructorName:
4053 if (ConstructorNameSet.erase(Name))
4054 Names.push_back(Name);
4055 break;
4056
4057 case DeclarationName::CXXConversionFunctionName:
4058 if (ConversionNameSet.erase(Name))
4059 Names.push_back(Name);
4060 break;
4061 }
4062
4063 if (ConstructorNameSet.empty() && ConversionNameSet.empty())
4064 break;
Chandler Carruthe972c362015-03-26 03:11:40 +00004065 }
4066
Chandler Carruthe972c362015-03-26 03:11:40 +00004067 assert(ConstructorNameSet.empty() && "Failed to find all of the visible "
4068 "constructors by walking all the "
4069 "lexical members of the context.");
4070 assert(ConversionNameSet.empty() && "Failed to find all of the visible "
4071 "conversion functions by walking all "
4072 "the lexical members of the context.");
Richard Smith961eae52014-03-25 01:14:22 +00004073 }
4074
Chandler Carruthe972c362015-03-26 03:11:40 +00004075 // Next we need to do a lookup with each name into this decl context to fully
4076 // populate any results from external sources. We don't actually use the
4077 // results of these lookups because we only want to use the results after all
4078 // results have been loaded and the pointers into them will be stable.
4079 for (auto &Name : Names)
4080 DC->lookup(Name);
4081
4082 // Now we need to insert the results for each name into the hash table. For
4083 // constructor names and conversion function names, we actually need to merge
4084 // all of the results for them into one list of results each and insert
4085 // those.
4086 SmallVector<NamedDecl *, 8> ConstructorDecls;
4087 SmallVector<NamedDecl *, 8> ConversionDecls;
4088
4089 // Now loop over the names, either inserting them or appending for the two
4090 // special cases.
4091 for (auto &Name : Names) {
4092 DeclContext::lookup_result Result = DC->noload_lookup(Name);
4093
4094 switch (Name.getNameKind()) {
4095 default:
Richard Smithd88a7f12015-09-01 20:35:42 +00004096 Generator.insert(Name, Trait.getData(Result), Trait);
Chandler Carruthe972c362015-03-26 03:11:40 +00004097 break;
4098
4099 case DeclarationName::CXXConstructorName:
4100 ConstructorDecls.append(Result.begin(), Result.end());
4101 break;
4102
4103 case DeclarationName::CXXConversionFunctionName:
4104 ConversionDecls.append(Result.begin(), Result.end());
4105 break;
4106 }
4107 }
4108
4109 // Handle our two special cases if we ended up having any. We arbitrarily use
4110 // the first declaration's name here because the name itself isn't part of
4111 // the key, only the kind of name is used.
4112 if (!ConstructorDecls.empty())
4113 Generator.insert(ConstructorDecls.front()->getDeclName(),
Richard Smithd88a7f12015-09-01 20:35:42 +00004114 Trait.getData(ConstructorDecls), Trait);
Chandler Carruthe972c362015-03-26 03:11:40 +00004115 if (!ConversionDecls.empty())
4116 Generator.insert(ConversionDecls.front()->getDeclName(),
Richard Smithd88a7f12015-09-01 20:35:42 +00004117 Trait.getData(ConversionDecls), Trait);
Chandler Carruthe972c362015-03-26 03:11:40 +00004118
Richard Smithd88a7f12015-09-01 20:35:42 +00004119 // Create the on-disk hash table. Also emit the existing imported and
4120 // merged table if there is one.
4121 auto *Lookups = Chain ? Chain->getLoadedLookupTables(DC) : nullptr;
4122 Generator.emit(LookupTable, Trait, Lookups ? &Lookups->Table : nullptr);
Richard Smith961eae52014-03-25 01:14:22 +00004123}
4124
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00004125/// \brief Write the block containing all of the declaration IDs
4126/// visible from the given DeclContext.
4127///
4128/// \returns the offset of the DECL_CONTEXT_VISIBLE block within the
Sebastian Redla4071b42010-08-24 00:50:09 +00004129/// bitstream, or 0 if no block was written.
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00004130uint64_t ASTWriter::WriteDeclContextVisibleBlock(ASTContext &Context,
4131 DeclContext *DC) {
Richard Smith5fc18a92015-07-12 23:43:21 +00004132 // If we imported a key declaration of this namespace, write the visible
4133 // lookup results as an update record for it rather than including them
4134 // on this declaration. We will only look at key declarations on reload.
4135 if (isa<NamespaceDecl>(DC) && Chain &&
4136 Chain->getKeyDeclaration(cast<Decl>(DC))->isFromASTFile()) {
4137 // Only do this once, for the first local declaration of the namespace.
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00004138 for (auto *Prev = cast<NamespaceDecl>(DC)->getPreviousDecl(); Prev;
Richard Smith5fc18a92015-07-12 23:43:21 +00004139 Prev = Prev->getPreviousDecl())
4140 if (!Prev->isFromASTFile())
4141 return 0;
4142
4143 // Note that we need to emit an update record for the primary context.
4144 UpdatedDeclContexts.insert(DC->getPrimaryContext());
4145
4146 // Make sure all visible decls are written. They will be recorded later. We
4147 // do this using a side data structure so we can sort the names into
4148 // a deterministic order.
4149 StoredDeclsMap *Map = DC->getPrimaryContext()->buildLookup();
4150 SmallVector<std::pair<DeclarationName, DeclContext::lookup_result>, 16>
4151 LookupResults;
4152 if (Map) {
4153 LookupResults.reserve(Map->size());
4154 for (auto &Entry : *Map)
4155 LookupResults.push_back(
4156 std::make_pair(Entry.first, Entry.second.getLookupResult()));
4157 }
4158
Mandeep Singh Grangc205d8c2018-03-27 16:50:00 +00004159 llvm::sort(LookupResults.begin(), LookupResults.end(), llvm::less_first());
Richard Smith5fc18a92015-07-12 23:43:21 +00004160 for (auto &NameAndResult : LookupResults) {
4161 DeclarationName Name = NameAndResult.first;
4162 DeclContext::lookup_result Result = NameAndResult.second;
4163 if (Name.getNameKind() == DeclarationName::CXXConstructorName ||
4164 Name.getNameKind() == DeclarationName::CXXConversionFunctionName) {
4165 // We have to work around a name lookup bug here where negative lookup
4166 // results for these names get cached in namespace lookup tables (these
4167 // names should never be looked up in a namespace).
4168 assert(Result.empty() && "Cannot have a constructor or conversion "
4169 "function name in a namespace!");
4170 continue;
4171 }
4172
4173 for (NamedDecl *ND : Result)
4174 if (!ND->isFromASTFile())
4175 GetDeclRef(ND);
4176 }
4177
4178 return 0;
4179 }
4180
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00004181 if (DC->getPrimaryContext() != DC)
4182 return 0;
4183
Chandler Carruthe972c362015-03-26 03:11:40 +00004184 // Skip contexts which don't support name lookup.
4185 if (!DC->isLookupContext())
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00004186 return 0;
4187
4188 // If not in C++, we perform name lookup for the translation unit via the
4189 // IdentifierInfo chains, don't bother to build a visible-declarations table.
David Blaikiebbafb8a2012-03-11 07:00:24 +00004190 if (DC->isTranslationUnit() && !Context.getLangOpts().CPlusPlus)
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00004191 return 0;
4192
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00004193 // Serialize the contents of the mapping used for lookup. Note that,
4194 // although we have two very different code paths, the serialized
4195 // representation is the same for both cases: a declaration name,
4196 // followed by a size, followed by references to the visible
4197 // declarations that have that name.
4198 uint64_t Offset = Stream.GetCurrentBitNo();
Richard Smithf634c902012-03-16 06:12:59 +00004199 StoredDeclsMap *Map = DC->buildLookup();
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00004200 if (!Map || Map->empty())
4201 return 0;
4202
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00004203 // Create the on-disk hash table in a buffer.
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00004204 SmallString<4096> LookupTable;
Richard Smithd88a7f12015-09-01 20:35:42 +00004205 GenerateNameLookupTable(DC, LookupTable);
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00004206
4207 // Write the lookup table
Mehdi Amini57a41912015-09-10 01:46:39 +00004208 RecordData::value_type Record[] = {DECL_CONTEXT_VISIBLE};
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00004209 Stream.EmitRecordWithBlob(DeclContextVisibleLookupAbbrev, Record,
Yaron Keren92e1b622015-03-18 10:17:07 +00004210 LookupTable);
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00004211 ++NumVisibleDeclContexts;
4212 return Offset;
4213}
4214
Sebastian Redla4071b42010-08-24 00:50:09 +00004215/// \brief Write an UPDATE_VISIBLE block for the given context.
4216///
4217/// UPDATE_VISIBLE blocks contain the declarations that are added to an existing
4218/// DeclContext in a dependent AST file. As such, they only exist for the TU
Richard Smithf634c902012-03-16 06:12:59 +00004219/// (in C++), for namespaces, and for classes with forward-declared unscoped
4220/// enumeration members (in C++11).
Sebastian Redla4071b42010-08-24 00:50:09 +00004221void ASTWriter::WriteDeclContextVisibleUpdate(const DeclContext *DC) {
Richard Smith961eae52014-03-25 01:14:22 +00004222 StoredDeclsMap *Map = DC->getLookupPtr();
Sebastian Redla4071b42010-08-24 00:50:09 +00004223 if (!Map || Map->empty())
4224 return;
4225
Sebastian Redla4071b42010-08-24 00:50:09 +00004226 // Create the on-disk hash table in a buffer.
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00004227 SmallString<4096> LookupTable;
Richard Smithd88a7f12015-09-01 20:35:42 +00004228 GenerateNameLookupTable(DC, LookupTable);
Sebastian Redla4071b42010-08-24 00:50:09 +00004229
Richard Smith5fc18a92015-07-12 23:43:21 +00004230 // If we're updating a namespace, select a key declaration as the key for the
4231 // update record; those are the only ones that will be checked on reload.
4232 if (isa<NamespaceDecl>(DC))
4233 DC = cast<DeclContext>(Chain->getKeyDeclaration(cast<Decl>(DC)));
4234
Sebastian Redla4071b42010-08-24 00:50:09 +00004235 // Write the lookup table
Mehdi Amini57a41912015-09-10 01:46:39 +00004236 RecordData::value_type Record[] = {UPDATE_VISIBLE, getDeclID(cast<Decl>(DC))};
Yaron Keren92e1b622015-03-18 10:17:07 +00004237 Stream.EmitRecordWithBlob(UpdateVisibleAbbrev, Record, LookupTable);
Sebastian Redla4071b42010-08-24 00:50:09 +00004238}
4239
Peter Collingbourne5df20e02011-02-15 19:46:30 +00004240/// \brief Write an FP_PRAGMA_OPTIONS block for the given FPOptions.
4241void ASTWriter::WriteFPPragmaOptions(const FPOptions &Opts) {
Adam Nemet484aa452017-03-27 19:17:25 +00004242 RecordData::value_type Record[] = {Opts.getInt()};
Peter Collingbourne5df20e02011-02-15 19:46:30 +00004243 Stream.EmitRecord(FP_PRAGMA_OPTIONS, Record);
4244}
4245
4246/// \brief Write an OPENCL_EXTENSIONS block for the given OpenCLOptions.
4247void ASTWriter::WriteOpenCLExtensions(Sema &SemaRef) {
David Blaikiebbafb8a2012-03-11 07:00:24 +00004248 if (!SemaRef.Context.getLangOpts().OpenCL)
Peter Collingbourne5df20e02011-02-15 19:46:30 +00004249 return;
4250
4251 const OpenCLOptions &Opts = SemaRef.getOpenCLOptions();
4252 RecordData Record;
Yaxun Liu5b746652016-12-18 05:18:55 +00004253 for (const auto &I:Opts.OptMap) {
4254 AddString(I.getKey(), Record);
4255 auto V = I.getValue();
Yaxun Liucc2741c2016-12-18 06:35:06 +00004256 Record.push_back(V.Supported ? 1 : 0);
4257 Record.push_back(V.Enabled ? 1 : 0);
Yaxun Liu5b746652016-12-18 05:18:55 +00004258 Record.push_back(V.Avail);
4259 Record.push_back(V.Core);
4260 }
Peter Collingbourne5df20e02011-02-15 19:46:30 +00004261 Stream.EmitRecord(OPENCL_EXTENSIONS, Record);
4262}
4263
Yaxun Liu5b746652016-12-18 05:18:55 +00004264void ASTWriter::WriteOpenCLExtensionTypes(Sema &SemaRef) {
4265 if (!SemaRef.Context.getLangOpts().OpenCL)
4266 return;
4267
4268 RecordData Record;
4269 for (const auto &I : SemaRef.OpenCLTypeExtMap) {
4270 Record.push_back(
4271 static_cast<unsigned>(getTypeID(I.first->getCanonicalTypeInternal())));
4272 Record.push_back(I.second.size());
4273 for (auto Ext : I.second)
4274 AddString(Ext, Record);
4275 }
4276 Stream.EmitRecord(OPENCL_EXTENSION_TYPES, Record);
4277}
4278
4279void ASTWriter::WriteOpenCLExtensionDecls(Sema &SemaRef) {
4280 if (!SemaRef.Context.getLangOpts().OpenCL)
4281 return;
4282
4283 RecordData Record;
4284 for (const auto &I : SemaRef.OpenCLDeclExtMap) {
4285 Record.push_back(getDeclID(I.first));
4286 Record.push_back(static_cast<unsigned>(I.second.size()));
4287 for (auto Ext : I.second)
4288 AddString(Ext, Record);
4289 }
4290 Stream.EmitRecord(OPENCL_EXTENSION_DECLS, Record);
4291}
4292
Justin Lebar67a78a62016-10-08 22:15:58 +00004293void ASTWriter::WriteCUDAPragmas(Sema &SemaRef) {
4294 if (SemaRef.ForceCUDAHostDeviceDepth > 0) {
4295 RecordData::value_type Record[] = {SemaRef.ForceCUDAHostDeviceDepth};
4296 Stream.EmitRecord(CUDA_PRAGMA_FORCE_HOST_DEVICE_DEPTH, Record);
4297 }
4298}
4299
Douglas Gregor404cdde2012-01-27 01:47:08 +00004300void ASTWriter::WriteObjCCategories() {
Dmitri Gribenkof8579502013-01-12 19:30:44 +00004301 SmallVector<ObjCCategoriesInfo, 2> CategoriesMap;
Douglas Gregor404cdde2012-01-27 01:47:08 +00004302 RecordData Categories;
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00004303
Douglas Gregor404cdde2012-01-27 01:47:08 +00004304 for (unsigned I = 0, N = ObjCClassesWithCategories.size(); I != N; ++I) {
4305 unsigned Size = 0;
4306 unsigned StartIndex = Categories.size();
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00004307
Douglas Gregor404cdde2012-01-27 01:47:08 +00004308 ObjCInterfaceDecl *Class = ObjCClassesWithCategories[I];
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00004309
Douglas Gregor404cdde2012-01-27 01:47:08 +00004310 // Allocate space for the size.
4311 Categories.push_back(0);
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00004312
Douglas Gregor404cdde2012-01-27 01:47:08 +00004313 // Add the categories.
Douglas Gregor048fbfa2013-01-16 23:00:23 +00004314 for (ObjCInterfaceDecl::known_categories_iterator
4315 Cat = Class->known_categories_begin(),
4316 CatEnd = Class->known_categories_end();
4317 Cat != CatEnd; ++Cat, ++Size) {
4318 assert(getDeclID(*Cat) != 0 && "Bogus category");
4319 AddDeclRef(*Cat, Categories);
Douglas Gregor404cdde2012-01-27 01:47:08 +00004320 }
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00004321
Douglas Gregor404cdde2012-01-27 01:47:08 +00004322 // Update the size.
4323 Categories[StartIndex] = Size;
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00004324
Douglas Gregor404cdde2012-01-27 01:47:08 +00004325 // Record this interface -> category map.
4326 ObjCCategoriesInfo CatInfo = { getDeclID(Class), StartIndex };
4327 CategoriesMap.push_back(CatInfo);
4328 }
4329
4330 // Sort the categories map by the definition ID, since the reader will be
4331 // performing binary searches on this information.
4332 llvm::array_pod_sort(CategoriesMap.begin(), CategoriesMap.end());
4333
4334 // Emit the categories map.
4335 using namespace llvm;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00004336
David Blaikieb44f0bf2017-01-04 22:36:43 +00004337 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Douglas Gregor404cdde2012-01-27 01:47:08 +00004338 Abbrev->Add(BitCodeAbbrevOp(OBJC_CATEGORIES_MAP));
4339 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // # of entries
4340 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
David Blaikieb44f0bf2017-01-04 22:36:43 +00004341 unsigned AbbrevID = Stream.EmitAbbrev(std::move(Abbrev));
Mehdi Amini57a41912015-09-10 01:46:39 +00004342
4343 RecordData::value_type Record[] = {OBJC_CATEGORIES_MAP, CategoriesMap.size()};
4344 Stream.EmitRecordWithBlob(AbbrevID, Record,
4345 reinterpret_cast<char *>(CategoriesMap.data()),
Douglas Gregor404cdde2012-01-27 01:47:08 +00004346 CategoriesMap.size() * sizeof(ObjCCategoriesInfo));
Mehdi Amini57a41912015-09-10 01:46:39 +00004347
Douglas Gregor404cdde2012-01-27 01:47:08 +00004348 // Emit the category lists.
4349 Stream.EmitRecord(OBJC_CATEGORIES, Categories);
4350}
4351
Richard Smithe40f2ba2013-08-07 21:41:30 +00004352void ASTWriter::WriteLateParsedTemplates(Sema &SemaRef) {
4353 Sema::LateParsedTemplateMapT &LPTMap = SemaRef.LateParsedTemplateMap;
4354
4355 if (LPTMap.empty())
4356 return;
4357
4358 RecordData Record;
Justin Lebar28f09c52016-10-10 16:26:08 +00004359 for (auto &LPTMapEntry : LPTMap) {
Chandler Carruth52cee4d2015-03-26 09:08:15 +00004360 const FunctionDecl *FD = LPTMapEntry.first;
Justin Lebar28f09c52016-10-10 16:26:08 +00004361 LateParsedTemplate &LPT = *LPTMapEntry.second;
Chandler Carruth52cee4d2015-03-26 09:08:15 +00004362 AddDeclRef(FD, Record);
Justin Lebar28f09c52016-10-10 16:26:08 +00004363 AddDeclRef(LPT.D, Record);
4364 Record.push_back(LPT.Toks.size());
Richard Smithe40f2ba2013-08-07 21:41:30 +00004365
Justin Lebar28f09c52016-10-10 16:26:08 +00004366 for (const auto &Tok : LPT.Toks) {
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00004367 AddToken(Tok, Record);
Richard Smithe40f2ba2013-08-07 21:41:30 +00004368 }
4369 }
4370 Stream.EmitRecord(LATE_PARSED_TEMPLATE, Record);
4371}
4372
Dario Domizioli13a0a382014-05-23 12:13:25 +00004373/// \brief Write the state of 'pragma clang optimize' at the end of the module.
4374void ASTWriter::WriteOptimizePragmaOptions(Sema &SemaRef) {
4375 RecordData Record;
4376 SourceLocation PragmaLoc = SemaRef.getOptimizeOffPragmaLocation();
4377 AddSourceLocation(PragmaLoc, Record);
4378 Stream.EmitRecord(OPTIMIZE_PRAGMA_OPTIONS, Record);
4379}
4380
Nico Weber779355f2016-03-02 23:22:00 +00004381/// \brief Write the state of 'pragma ms_struct' at the end of the module.
4382void ASTWriter::WriteMSStructPragmaOptions(Sema &SemaRef) {
4383 RecordData Record;
4384 Record.push_back(SemaRef.MSStructPragmaOn ? PMSST_ON : PMSST_OFF);
4385 Stream.EmitRecord(MSSTRUCT_PRAGMA_OPTIONS, Record);
4386}
4387
Nico Weber42932312016-03-03 00:17:35 +00004388/// \brief Write the state of 'pragma pointers_to_members' at the end of the
4389//module.
4390void ASTWriter::WriteMSPointersToMembersPragmaOptions(Sema &SemaRef) {
4391 RecordData Record;
4392 Record.push_back(SemaRef.MSPointerToMemberRepresentationMethod);
4393 AddSourceLocation(SemaRef.ImplicitMSInheritanceAttrLoc, Record);
4394 Stream.EmitRecord(POINTERS_TO_MEMBERS_PRAGMA_OPTIONS, Record);
4395}
4396
Alex Lorenz7d7e1e02017-03-31 15:36:21 +00004397/// \brief Write the state of 'pragma pack' at the end of the module.
4398void ASTWriter::WritePackPragmaOptions(Sema &SemaRef) {
Duncan P. N. Exon Smith03df14c2017-04-15 00:07:57 +00004399 // Don't serialize pragma pack state for modules, since it should only take
4400 // effect on a per-submodule basis.
4401 if (WritingModule)
4402 return;
4403
Alex Lorenz7d7e1e02017-03-31 15:36:21 +00004404 RecordData Record;
4405 Record.push_back(SemaRef.PackStack.CurrentValue);
4406 AddSourceLocation(SemaRef.PackStack.CurrentPragmaLocation, Record);
4407 Record.push_back(SemaRef.PackStack.Stack.size());
4408 for (const auto &StackEntry : SemaRef.PackStack.Stack) {
4409 Record.push_back(StackEntry.Value);
4410 AddSourceLocation(StackEntry.PragmaLocation, Record);
Alex Lorenz45b40142017-07-28 14:41:21 +00004411 AddSourceLocation(StackEntry.PragmaPushLocation, Record);
Alex Lorenz7d7e1e02017-03-31 15:36:21 +00004412 AddString(StackEntry.StackSlotLabel, Record);
4413 }
4414 Stream.EmitRecord(PACK_PRAGMA_OPTIONS, Record);
4415}
4416
Douglas Gregor8f64ca12015-12-08 22:43:32 +00004417void ASTWriter::WriteModuleFileExtension(Sema &SemaRef,
4418 ModuleFileExtensionWriter &Writer) {
Douglas Gregor6623e1f2015-11-03 18:33:07 +00004419 // Enter the extension block.
4420 Stream.EnterSubblock(EXTENSION_BLOCK_ID, 4);
4421
4422 // Emit the metadata record abbreviation.
David Blaikieb44f0bf2017-01-04 22:36:43 +00004423 auto Abv = std::make_shared<llvm::BitCodeAbbrev>();
Douglas Gregor6623e1f2015-11-03 18:33:07 +00004424 Abv->Add(llvm::BitCodeAbbrevOp(EXTENSION_METADATA));
4425 Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::VBR, 6));
4426 Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::VBR, 6));
4427 Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::VBR, 6));
4428 Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::VBR, 6));
4429 Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::Blob));
David Blaikieb44f0bf2017-01-04 22:36:43 +00004430 unsigned Abbrev = Stream.EmitAbbrev(std::move(Abv));
Douglas Gregor6623e1f2015-11-03 18:33:07 +00004431
4432 // Emit the metadata record.
4433 RecordData Record;
4434 auto Metadata = Writer.getExtension()->getExtensionMetadata();
4435 Record.push_back(EXTENSION_METADATA);
4436 Record.push_back(Metadata.MajorVersion);
4437 Record.push_back(Metadata.MinorVersion);
4438 Record.push_back(Metadata.BlockName.size());
4439 Record.push_back(Metadata.UserInfo.size());
4440 SmallString<64> Buffer;
4441 Buffer += Metadata.BlockName;
4442 Buffer += Metadata.UserInfo;
4443 Stream.EmitRecordWithBlob(Abbrev, Record, Buffer);
4444
4445 // Emit the contents of the extension block.
Douglas Gregor8f64ca12015-12-08 22:43:32 +00004446 Writer.writeExtensionContents(SemaRef, Stream);
Douglas Gregor6623e1f2015-11-03 18:33:07 +00004447
4448 // Exit the extension block.
4449 Stream.ExitBlock();
4450}
4451
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00004452//===----------------------------------------------------------------------===//
Douglas Gregorc5046832009-04-27 18:38:38 +00004453// General Serialization Routines
4454//===----------------------------------------------------------------------===//
4455
Richard Smith69c82bf2016-04-01 22:52:03 +00004456/// \brief Emit the list of attributes to the specified record.
Richard Smith290d8012016-04-06 17:06:00 +00004457void ASTRecordWriter::AddAttributes(ArrayRef<const Attr *> Attrs) {
4458 auto &Record = *this;
Argyrios Kyrtzidis9beef8e2010-10-18 19:20:11 +00004459 Record.push_back(Attrs.size());
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00004460 for (const auto *A : Attrs) {
Alexis Huntdcfba7b2010-08-18 23:23:40 +00004461 Record.push_back(A->getKind()); // FIXME: stable encoding, target attrs
Richard Smith290d8012016-04-06 17:06:00 +00004462 Record.AddSourceRange(A->getRange());
Douglas Gregorbc8a78d52009-04-15 21:30:51 +00004463
Alexis Huntdcfba7b2010-08-18 23:23:40 +00004464#include "clang/Serialization/AttrPCHWrite.inc"
Douglas Gregorbc8a78d52009-04-15 21:30:51 +00004465 }
Douglas Gregorbc8a78d52009-04-15 21:30:51 +00004466}
4467
John McCallf413f5e2013-05-03 00:10:13 +00004468void ASTWriter::AddToken(const Token &Tok, RecordDataImpl &Record) {
4469 AddSourceLocation(Tok.getLocation(), Record);
4470 Record.push_back(Tok.getLength());
4471
4472 // FIXME: When reading literal tokens, reconstruct the literal pointer
4473 // if it is needed.
4474 AddIdentifierRef(Tok.getIdentifierInfo(), Record);
4475 // FIXME: Should translate token kind to a stable encoding.
4476 Record.push_back(Tok.getKind());
4477 // FIXME: Should translate token flags to a stable encoding.
4478 Record.push_back(Tok.getFlags());
4479}
4480
Chris Lattner0e62c1c2011-07-23 10:55:15 +00004481void ASTWriter::AddString(StringRef Str, RecordDataImpl &Record) {
Douglas Gregorbc8a78d52009-04-15 21:30:51 +00004482 Record.push_back(Str.size());
4483 Record.insert(Record.end(), Str.begin(), Str.end());
4484}
4485
Richard Smith7ed1bc92014-12-05 22:42:13 +00004486bool ASTWriter::PreparePathForOutput(SmallVectorImpl<char> &Path) {
Richard Smith54cc3c22014-12-11 20:50:24 +00004487 assert(Context && "should have context when outputting path");
Richard Smith7ed1bc92014-12-05 22:42:13 +00004488
Richard Smith54cc3c22014-12-11 20:50:24 +00004489 bool Changed =
4490 cleanPathForOutput(Context->getSourceManager().getFileManager(), Path);
Richard Smith7ed1bc92014-12-05 22:42:13 +00004491
4492 // Remove a prefix to make the path relative, if relevant.
4493 const char *PathBegin = Path.data();
4494 const char *PathPtr =
4495 adjustFilenameForRelocatableAST(PathBegin, BaseDirectory);
4496 if (PathPtr != PathBegin) {
4497 Path.erase(Path.begin(), Path.begin() + (PathPtr - PathBegin));
4498 Changed = true;
4499 }
4500
4501 return Changed;
4502}
4503
4504void ASTWriter::AddPath(StringRef Path, RecordDataImpl &Record) {
4505 SmallString<128> FilePath(Path);
4506 PreparePathForOutput(FilePath);
4507 AddString(FilePath, Record);
4508}
4509
Mehdi Amini57a41912015-09-10 01:46:39 +00004510void ASTWriter::EmitRecordWithPath(unsigned Abbrev, RecordDataRef Record,
Richard Smith7ed1bc92014-12-05 22:42:13 +00004511 StringRef Path) {
4512 SmallString<128> FilePath(Path);
4513 PreparePathForOutput(FilePath);
4514 Stream.EmitRecordWithBlob(Abbrev, Record, FilePath);
4515}
4516
Douglas Gregor20b2ebd2011-03-23 00:50:03 +00004517void ASTWriter::AddVersionTuple(const VersionTuple &Version,
4518 RecordDataImpl &Record) {
4519 Record.push_back(Version.getMajor());
David Blaikie05785d12013-02-20 22:23:23 +00004520 if (Optional<unsigned> Minor = Version.getMinor())
Douglas Gregor20b2ebd2011-03-23 00:50:03 +00004521 Record.push_back(*Minor + 1);
4522 else
4523 Record.push_back(0);
David Blaikie05785d12013-02-20 22:23:23 +00004524 if (Optional<unsigned> Subminor = Version.getSubminor())
Douglas Gregor20b2ebd2011-03-23 00:50:03 +00004525 Record.push_back(*Subminor + 1);
4526 else
4527 Record.push_back(0);
4528}
4529
Douglas Gregore84a9da2009-04-20 20:36:09 +00004530/// \brief Note that the identifier II occurs at the given offset
4531/// within the identifier table.
Sebastian Redl55c0ad52010-08-18 23:56:21 +00004532void ASTWriter::SetIdentifierOffset(const IdentifierInfo *II, uint32_t Offset) {
Sebastian Redl539c5062010-08-18 23:57:32 +00004533 IdentID ID = IdentifierIDs[II];
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00004534 // Only store offsets new to this AST file. Other identifier names are looked
Sebastian Redlff4a2952010-07-23 23:49:55 +00004535 // up earlier in the chain and thus don't need an offset.
4536 if (ID >= FirstIdentID)
4537 IdentifierOffsets[ID - FirstIdentID] = Offset;
Douglas Gregore84a9da2009-04-20 20:36:09 +00004538}
4539
Douglas Gregor95c13f52009-04-25 17:48:32 +00004540/// \brief Note that the selector Sel occurs at the given offset
4541/// within the method pool/selector table.
Sebastian Redl55c0ad52010-08-18 23:56:21 +00004542void ASTWriter::SetSelectorOffset(Selector Sel, uint32_t Offset) {
Douglas Gregor95c13f52009-04-25 17:48:32 +00004543 unsigned ID = SelectorIDs[Sel];
4544 assert(ID && "Unknown selector");
Sebastian Redld95a56e2010-08-04 18:21:41 +00004545 // Don't record offsets for selectors that are also available in a different
4546 // file.
4547 if (ID < FirstSelectorID)
4548 return;
4549 SelectorOffsets[ID - FirstSelectorID] = Offset;
Douglas Gregor95c13f52009-04-25 17:48:32 +00004550}
4551
David Blaikie61137e12017-01-05 18:23:18 +00004552ASTWriter::ASTWriter(llvm::BitstreamWriter &Stream,
Duncan P. N. Exon Smith030d7d62017-03-20 17:58:26 +00004553 SmallVectorImpl<char> &Buffer, MemoryBufferCache &PCMCache,
David Blaikie61137e12017-01-05 18:23:18 +00004554 ArrayRef<std::shared_ptr<ModuleFileExtension>> Extensions,
4555 bool IncludeTimestamps)
Duncan P. N. Exon Smith030d7d62017-03-20 17:58:26 +00004556 : Stream(Stream), Buffer(Buffer), PCMCache(PCMCache),
4557 IncludeTimestamps(IncludeTimestamps) {
Douglas Gregor6623e1f2015-11-03 18:33:07 +00004558 for (const auto &Ext : Extensions) {
4559 if (auto Writer = Ext->createExtensionWriter(*this))
4560 ModuleFileExtensionWriters.push_back(std::move(Writer));
4561 }
4562}
Douglas Gregoref84c4b2009-04-09 22:27:44 +00004563
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00004564ASTWriter::~ASTWriter() {
Reid Kleckner588c9372014-02-19 23:44:52 +00004565 llvm::DeleteContainerSeconds(FileDeclIDs);
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00004566}
4567
Richard Smithb3761912015-02-05 23:08:52 +00004568const LangOptions &ASTWriter::getLangOpts() const {
4569 assert(WritingAST && "can't determine lang opts when not writing AST");
4570 return Context->getLangOpts();
4571}
4572
Richard Smithe75ee0f2015-08-17 07:13:32 +00004573time_t ASTWriter::getTimestampForOutput(const FileEntry *E) const {
4574 return IncludeTimestamps ? E->getModificationTime() : 0;
4575}
4576
Duncan P. N. Exon Smith60fa2882017-03-13 18:45:08 +00004577ASTFileSignature ASTWriter::WriteAST(Sema &SemaRef,
4578 const std::string &OutputFile,
4579 Module *WritingModule, StringRef isysroot,
4580 bool hasErrors) {
Douglas Gregor2fd3d402011-09-17 00:05:03 +00004581 WritingAST = true;
Adrian Prantladbd2b12015-09-22 23:26:31 +00004582
Argyrios Kyrtzidis4a280ff2012-03-07 01:51:17 +00004583 ASTHasCompilerErrors = hasErrors;
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00004584
Douglas Gregoref84c4b2009-04-09 22:27:44 +00004585 // Emit the file header.
Douglas Gregor8f45df52009-04-16 22:23:12 +00004586 Stream.Emit((unsigned)'C', 8);
4587 Stream.Emit((unsigned)'P', 8);
4588 Stream.Emit((unsigned)'C', 8);
4589 Stream.Emit((unsigned)'H', 8);
Mike Stump11289f42009-09-09 15:08:12 +00004590
Chris Lattner28fa4e62009-04-26 22:26:21 +00004591 WriteBlockInfoBlock();
Douglas Gregoref84c4b2009-04-09 22:27:44 +00004592
Douglas Gregoreda8e122011-08-09 15:13:55 +00004593 Context = &SemaRef.Context;
Douglas Gregora28bcdd2011-12-01 02:07:58 +00004594 PP = &SemaRef.PP;
Douglas Gregora89c5ac2011-12-06 01:10:29 +00004595 this->WritingModule = WritingModule;
Adrian Prantladbd2b12015-09-22 23:26:31 +00004596 ASTFileSignature Signature =
4597 WriteASTCore(SemaRef, isysroot, OutputFile, WritingModule);
Craig Toppera13603a2014-05-22 05:54:18 +00004598 Context = nullptr;
4599 PP = nullptr;
4600 this->WritingModule = nullptr;
Richard Smith7ed1bc92014-12-05 22:42:13 +00004601 this->BaseDirectory.clear();
Craig Toppera13603a2014-05-22 05:54:18 +00004602
Douglas Gregor2fd3d402011-09-17 00:05:03 +00004603 WritingAST = false;
Duncan P. N. Exon Smith030d7d62017-03-20 17:58:26 +00004604 if (SemaRef.Context.getLangOpts().ImplicitModules && WritingModule) {
4605 // Construct MemoryBuffer and update buffer manager.
4606 PCMCache.addBuffer(OutputFile,
4607 llvm::MemoryBuffer::getMemBufferCopy(
4608 StringRef(Buffer.begin(), Buffer.size())));
4609 }
Adrian Prantladbd2b12015-09-22 23:26:31 +00004610 return Signature;
Sebastian Redl143413f2010-07-12 22:02:52 +00004611}
4612
Douglas Gregora94a1542011-07-27 21:45:57 +00004613template<typename Vector>
4614static void AddLazyVectorDecls(ASTWriter &Writer, Vector &Vec,
4615 ASTWriter::RecordData &Record) {
Craig Toppera13603a2014-05-22 05:54:18 +00004616 for (typename Vector::iterator I = Vec.begin(nullptr, true), E = Vec.end();
4617 I != E; ++I) {
Douglas Gregora94a1542011-07-27 21:45:57 +00004618 Writer.AddDeclRef(*I, Record);
4619 }
4620}
4621
Duncan P. N. Exon Smith60fa2882017-03-13 18:45:08 +00004622ASTFileSignature ASTWriter::WriteASTCore(Sema &SemaRef, StringRef isysroot,
4623 const std::string &OutputFile,
4624 Module *WritingModule) {
Sebastian Redl143413f2010-07-12 22:02:52 +00004625 using namespace llvm;
4626
Craig Toppera13603a2014-05-22 05:54:18 +00004627 bool isModule = WritingModule != nullptr;
Argyrios Kyrtzidisffb35582013-03-14 04:44:56 +00004628
Douglas Gregorcf68c582011-12-01 22:20:10 +00004629 // Make sure that the AST reader knows to finalize itself.
4630 if (Chain)
4631 Chain->finalizeForWriting();
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00004632
Sebastian Redl143413f2010-07-12 22:02:52 +00004633 ASTContext &Context = SemaRef.Context;
4634 Preprocessor &PP = SemaRef.PP;
4635
Douglas Gregordab42432011-08-12 00:15:20 +00004636 // Set up predefined declaration IDs.
Richard Smith5fc18a92015-07-12 23:43:21 +00004637 auto RegisterPredefDecl = [&] (Decl *D, PredefinedDeclIDs ID) {
4638 if (D) {
4639 assert(D->isCanonicalDecl() && "predefined decl is not canonical");
4640 DeclIDs[D] = ID;
Richard Smith5fc18a92015-07-12 23:43:21 +00004641 }
4642 };
4643 RegisterPredefDecl(Context.getTranslationUnitDecl(),
4644 PREDEF_DECL_TRANSLATION_UNIT_ID);
4645 RegisterPredefDecl(Context.ObjCIdDecl, PREDEF_DECL_OBJC_ID_ID);
4646 RegisterPredefDecl(Context.ObjCSelDecl, PREDEF_DECL_OBJC_SEL_ID);
4647 RegisterPredefDecl(Context.ObjCClassDecl, PREDEF_DECL_OBJC_CLASS_ID);
4648 RegisterPredefDecl(Context.ObjCProtocolClassDecl,
4649 PREDEF_DECL_OBJC_PROTOCOL_ID);
4650 RegisterPredefDecl(Context.Int128Decl, PREDEF_DECL_INT_128_ID);
4651 RegisterPredefDecl(Context.UInt128Decl, PREDEF_DECL_UNSIGNED_INT_128_ID);
4652 RegisterPredefDecl(Context.ObjCInstanceTypeDecl,
4653 PREDEF_DECL_OBJC_INSTANCETYPE_ID);
4654 RegisterPredefDecl(Context.BuiltinVaListDecl, PREDEF_DECL_BUILTIN_VA_LIST_ID);
Richard Smith9b88a4c2015-07-27 05:40:23 +00004655 RegisterPredefDecl(Context.VaListTagDecl, PREDEF_DECL_VA_LIST_TAG);
Charles Davisc7d5c942015-09-17 20:55:33 +00004656 RegisterPredefDecl(Context.BuiltinMSVaListDecl,
4657 PREDEF_DECL_BUILTIN_MS_VA_LIST_ID);
Richard Smith5fc18a92015-07-12 23:43:21 +00004658 RegisterPredefDecl(Context.ExternCContext, PREDEF_DECL_EXTERN_C_CONTEXT_ID);
David Majnemerd9b1a4f2015-11-04 03:40:30 +00004659 RegisterPredefDecl(Context.MakeIntegerSeqDecl,
4660 PREDEF_DECL_MAKE_INTEGER_SEQ_ID);
Quentin Colombet043406b2016-02-03 22:41:00 +00004661 RegisterPredefDecl(Context.CFConstantStringTypeDecl,
4662 PREDEF_DECL_CF_CONSTANT_STRING_ID);
Ben Langmuirf5416742016-02-04 00:55:24 +00004663 RegisterPredefDecl(Context.CFConstantStringTagDecl,
4664 PREDEF_DECL_CF_CONSTANT_STRING_TAG_ID);
Eric Fiselier6ad68552016-07-01 01:24:09 +00004665 RegisterPredefDecl(Context.TypePackElementDecl,
4666 PREDEF_DECL_TYPE_PACK_ELEMENT_ID);
Meador Inge5d3fb222012-06-16 03:34:49 +00004667
Chris Lattner0c797362009-09-08 18:19:27 +00004668 // Build a record containing all of the tentative definitions in this file, in
Sebastian Redl35351a92010-01-31 22:27:38 +00004669 // TentativeDefinitions order. Generally, this record will be empty for
Chris Lattner0c797362009-09-08 18:19:27 +00004670 // headers.
Douglas Gregord4df8652009-04-22 22:02:47 +00004671 RecordData TentativeDefinitions;
Douglas Gregora94a1542011-07-27 21:45:57 +00004672 AddLazyVectorDecls(*this, SemaRef.TentativeDefinitions, TentativeDefinitions);
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00004673
Argyrios Kyrtzidis35672e72010-08-13 18:42:17 +00004674 // Build a record containing all of the file scoped decls in this file.
4675 RecordData UnusedFileScopedDecls;
Argyrios Kyrtzidis59852362013-03-14 04:45:00 +00004676 if (!isModule)
4677 AddLazyVectorDecls(*this, SemaRef.UnusedFileScopedDecls,
4678 UnusedFileScopedDecls);
Sebastian Redl08aca90252010-08-05 18:21:25 +00004679
Douglas Gregor851443c2011-08-12 01:39:19 +00004680 // Build a record containing all of the delegating constructors we still need
4681 // to resolve.
Alexis Hunt27a761d2011-05-04 23:29:54 +00004682 RecordData DelegatingCtorDecls;
Argyrios Kyrtzidisffb35582013-03-14 04:44:56 +00004683 if (!isModule)
4684 AddLazyVectorDecls(*this, SemaRef.DelegatingCtorDecls, DelegatingCtorDecls);
Alexis Hunt27a761d2011-05-04 23:29:54 +00004685
Douglas Gregor851443c2011-08-12 01:39:19 +00004686 // Write the set of weak, undeclared identifiers. We always write the
4687 // entire table, since later PCH files in a PCH chain are only interested in
4688 // the results at the end of the chain.
Argyrios Kyrtzidisee1afa32010-08-05 09:48:08 +00004689 RecordData WeakUndeclaredIdentifiers;
Chandler Carruthf85d9822015-03-26 08:32:49 +00004690 for (auto &WeakUndeclaredIdentifier : SemaRef.WeakUndeclaredIdentifiers) {
4691 IdentifierInfo *II = WeakUndeclaredIdentifier.first;
4692 WeakInfo &WI = WeakUndeclaredIdentifier.second;
4693 AddIdentifierRef(II, WeakUndeclaredIdentifiers);
4694 AddIdentifierRef(WI.getAlias(), WeakUndeclaredIdentifiers);
4695 AddSourceLocation(WI.getLocation(), WeakUndeclaredIdentifiers);
4696 WeakUndeclaredIdentifiers.push_back(WI.getUsed());
Argyrios Kyrtzidisee1afa32010-08-05 09:48:08 +00004697 }
Kovarththanan Rajaratnama9c81a82010-03-14 07:06:50 +00004698
Douglas Gregor61cac2b2009-04-27 20:06:05 +00004699 // Build a record containing all of the ext_vector declarations.
4700 RecordData ExtVectorDecls;
Douglas Gregorb7098a32011-07-28 00:39:29 +00004701 AddLazyVectorDecls(*this, SemaRef.ExtVectorDecls, ExtVectorDecls);
Douglas Gregor61cac2b2009-04-27 20:06:05 +00004702
Argyrios Kyrtzidisaf2eac22010-07-06 15:37:04 +00004703 // Build a record containing all of the VTable uses information.
4704 RecordData VTableUses;
Argyrios Kyrtzidisedee67f2010-08-03 17:29:52 +00004705 if (!SemaRef.VTableUses.empty()) {
Argyrios Kyrtzidisedee67f2010-08-03 17:29:52 +00004706 for (unsigned I = 0, N = SemaRef.VTableUses.size(); I != N; ++I) {
4707 AddDeclRef(SemaRef.VTableUses[I].first, VTableUses);
4708 AddSourceLocation(SemaRef.VTableUses[I].second, VTableUses);
4709 VTableUses.push_back(SemaRef.VTablesUsed[SemaRef.VTableUses[I].first]);
4710 }
Argyrios Kyrtzidisaf2eac22010-07-06 15:37:04 +00004711 }
4712
Nico Weber72889432014-09-06 01:25:55 +00004713 // Build a record containing all of the UnusedLocalTypedefNameCandidates.
4714 RecordData UnusedLocalTypedefNameCandidates;
4715 for (const TypedefNameDecl *TD : SemaRef.UnusedLocalTypedefNameCandidates)
4716 AddDeclRef(TD, UnusedLocalTypedefNameCandidates);
4717
Argyrios Kyrtzidis7f76d112010-08-05 09:48:16 +00004718 // Build a record containing all of pending implicit instantiations.
Chandler Carruth54080172010-08-25 08:44:16 +00004719 RecordData PendingInstantiations;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00004720 for (const auto &I : SemaRef.PendingInstantiations) {
4721 AddDeclRef(I.first, PendingInstantiations);
4722 AddSourceLocation(I.second, PendingInstantiations);
Argyrios Kyrtzidis7f76d112010-08-05 09:48:16 +00004723 }
4724 assert(SemaRef.PendingLocalImplicitInstantiations.empty() &&
4725 "There are local ones at end of translation unit!");
4726
Argyrios Kyrtzidis2d688102010-08-02 07:14:54 +00004727 // Build a record containing some declaration references.
4728 RecordData SemaDeclRefs;
Richard Smith96269c52016-09-29 22:49:46 +00004729 if (SemaRef.StdNamespace || SemaRef.StdBadAlloc || SemaRef.StdAlignValT) {
Argyrios Kyrtzidis2d688102010-08-02 07:14:54 +00004730 AddDeclRef(SemaRef.getStdNamespace(), SemaDeclRefs);
4731 AddDeclRef(SemaRef.getStdBadAlloc(), SemaDeclRefs);
Richard Smith96269c52016-09-29 22:49:46 +00004732 AddDeclRef(SemaRef.getStdAlignValT(), SemaDeclRefs);
Argyrios Kyrtzidis2d688102010-08-02 07:14:54 +00004733 }
4734
Peter Collingbourne9e2c81f2011-02-09 21:04:32 +00004735 RecordData CUDASpecialDeclRefs;
4736 if (Context.getcudaConfigureCallDecl()) {
4737 AddDeclRef(Context.getcudaConfigureCallDecl(), CUDASpecialDeclRefs);
4738 }
4739
Douglas Gregorc2fa1692011-06-28 16:20:02 +00004740 // Build a record containing all of the known namespaces.
4741 RecordData KnownNamespaces;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00004742 for (const auto &I : SemaRef.KnownNamespaces) {
4743 if (!I.second)
4744 AddDeclRef(I.first, KnownNamespaces);
Douglas Gregorc2fa1692011-06-28 16:20:02 +00004745 }
Douglas Gregor112b9072012-10-18 05:31:06 +00004746
Nick Lewycky9c7eb1d2013-02-01 08:13:20 +00004747 // Build a record of all used, undefined objects that require definitions.
4748 RecordData UndefinedButUsed;
Nick Lewyckyf0f56162013-01-31 03:23:57 +00004749
4750 SmallVector<std::pair<NamedDecl *, SourceLocation>, 16> Undefined;
Nick Lewycky9c7eb1d2013-02-01 08:13:20 +00004751 SemaRef.getUndefinedButUsed(Undefined);
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00004752 for (const auto &I : Undefined) {
4753 AddDeclRef(I.first, UndefinedButUsed);
4754 AddSourceLocation(I.second, UndefinedButUsed);
Nick Lewycky8334af82013-01-26 00:35:08 +00004755 }
4756
Ismail Pazarbasie5768d12015-05-18 19:59:11 +00004757 // Build a record containing all delete-expressions that we would like to
4758 // analyze later in AST.
4759 RecordData DeleteExprsToAnalyze;
4760
4761 for (const auto &DeleteExprsInfo :
4762 SemaRef.getMismatchingDeleteExpressions()) {
4763 AddDeclRef(DeleteExprsInfo.first, DeleteExprsToAnalyze);
4764 DeleteExprsToAnalyze.push_back(DeleteExprsInfo.second.size());
4765 for (const auto &DeleteLoc : DeleteExprsInfo.second) {
4766 AddSourceLocation(DeleteLoc.first, DeleteExprsToAnalyze);
4767 DeleteExprsToAnalyze.push_back(DeleteLoc.second);
4768 }
4769 }
4770
Douglas Gregor112b9072012-10-18 05:31:06 +00004771 // Write the control block
Duncan P. N. Exon Smith60fa2882017-03-13 18:45:08 +00004772 WriteControlBlock(PP, Context, isysroot, OutputFile);
Douglas Gregor112b9072012-10-18 05:31:06 +00004773
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00004774 // Write the remaining AST contents.
Sebastian Redl539c5062010-08-18 23:57:32 +00004775 Stream.EnterSubblock(AST_BLOCK_ID, 5);
Douglas Gregor851443c2011-08-12 01:39:19 +00004776
Argyrios Kyrtzidis39605402012-12-13 21:38:23 +00004777 // This is so that older clang versions, before the introduction
4778 // of the control block, can read and reject the newer PCH format.
Mehdi Amini57a41912015-09-10 01:46:39 +00004779 {
4780 RecordData Record = {VERSION_MAJOR};
4781 Stream.EmitRecord(METADATA_OLD_FORMAT, Record);
4782 }
Argyrios Kyrtzidis39605402012-12-13 21:38:23 +00004783
Douglas Gregor851443c2011-08-12 01:39:19 +00004784 // Create a lexical update block containing all of the declarations in the
4785 // translation unit that do not come from other AST files.
4786 const TranslationUnitDecl *TU = Context.getTranslationUnitDecl();
Richard Smith82f8fcd2015-08-06 22:07:25 +00004787 SmallVector<uint32_t, 128> NewGlobalKindDeclPairs;
4788 for (const auto *D : TU->noload_decls()) {
4789 if (!D->isFromASTFile()) {
4790 NewGlobalKindDeclPairs.push_back(D->getKind());
4791 NewGlobalKindDeclPairs.push_back(GetDeclRef(D));
4792 }
Douglas Gregor851443c2011-08-12 01:39:19 +00004793 }
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00004794
David Blaikieb44f0bf2017-01-04 22:36:43 +00004795 auto Abv = std::make_shared<BitCodeAbbrev>();
Douglas Gregor851443c2011-08-12 01:39:19 +00004796 Abv->Add(llvm::BitCodeAbbrevOp(TU_UPDATE_LEXICAL));
4797 Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::Blob));
David Blaikieb44f0bf2017-01-04 22:36:43 +00004798 unsigned TuUpdateLexicalAbbrev = Stream.EmitAbbrev(std::move(Abv));
Mehdi Amini57a41912015-09-10 01:46:39 +00004799 {
4800 RecordData::value_type Record[] = {TU_UPDATE_LEXICAL};
4801 Stream.EmitRecordWithBlob(TuUpdateLexicalAbbrev, Record,
4802 bytes(NewGlobalKindDeclPairs));
4803 }
4804
Douglas Gregor851443c2011-08-12 01:39:19 +00004805 // And a visible updates block for the translation unit.
David Blaikieb44f0bf2017-01-04 22:36:43 +00004806 Abv = std::make_shared<BitCodeAbbrev>();
Douglas Gregor851443c2011-08-12 01:39:19 +00004807 Abv->Add(llvm::BitCodeAbbrevOp(UPDATE_VISIBLE));
4808 Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::VBR, 6));
Douglas Gregor851443c2011-08-12 01:39:19 +00004809 Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::Blob));
David Blaikieb44f0bf2017-01-04 22:36:43 +00004810 UpdateVisibleAbbrev = Stream.EmitAbbrev(std::move(Abv));
Douglas Gregor851443c2011-08-12 01:39:19 +00004811 WriteDeclContextVisibleUpdate(TU);
Richard Smithf19e1272015-03-07 00:04:49 +00004812
4813 // If we have any extern "C" names, write out a visible update for them.
4814 if (Context.ExternCContext)
4815 WriteDeclContextVisibleUpdate(Context.ExternCContext);
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00004816
Douglas Gregor851443c2011-08-12 01:39:19 +00004817 // If the translation unit has an anonymous namespace, and we don't already
4818 // have an update block for it, write it as an update block.
Richard Smith6ef42932014-03-20 21:02:00 +00004819 // FIXME: Why do we not do this if there's already an update block?
Douglas Gregor851443c2011-08-12 01:39:19 +00004820 if (NamespaceDecl *NS = TU->getAnonymousNamespace()) {
4821 ASTWriter::UpdateRecord &Record = DeclUpdates[TU];
Richard Smith6ef42932014-03-20 21:02:00 +00004822 if (Record.empty())
Aaron Ballman4f45b712014-03-21 15:22:56 +00004823 Record.push_back(DeclUpdate(UPD_CXX_ADDED_ANONYMOUS_NAMESPACE, NS));
Douglas Gregor851443c2011-08-12 01:39:19 +00004824 }
Argyrios Kyrtzidis442dd802012-07-02 19:19:01 +00004825
Richard Smith5652c0f2014-03-21 01:48:23 +00004826 // Add update records for all mangling numbers and static local numbers.
4827 // These aren't really update records, but this is a convenient way of
4828 // tagging this rare extra data onto the declarations.
4829 for (const auto &Number : Context.MangleNumbers)
4830 if (!Number.first->isFromASTFile())
Aaron Ballman4f45b712014-03-21 15:22:56 +00004831 DeclUpdates[Number.first].push_back(DeclUpdate(UPD_MANGLING_NUMBER,
4832 Number.second));
Richard Smith5652c0f2014-03-21 01:48:23 +00004833 for (const auto &Number : Context.StaticLocalNumbers)
4834 if (!Number.first->isFromASTFile())
Aaron Ballman4f45b712014-03-21 15:22:56 +00004835 DeclUpdates[Number.first].push_back(DeclUpdate(UPD_STATIC_LOCAL_NUMBER,
4836 Number.second));
Richard Smith5652c0f2014-03-21 01:48:23 +00004837
Argyrios Kyrtzidis442dd802012-07-02 19:19:01 +00004838 // Make sure visible decls, added to DeclContexts previously loaded from
Richard Smithc26d9742016-10-06 20:30:51 +00004839 // an AST file, are registered for serialization. Likewise for template
4840 // specializations added to imported templates.
4841 for (const auto *I : DeclsToEmitEvenIfUnreferenced) {
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00004842 GetDeclRef(I);
Argyrios Kyrtzidis442dd802012-07-02 19:19:01 +00004843 }
4844
Argyrios Kyrtzidisacfbbd72013-08-07 21:17:33 +00004845 // Make sure all decls associated with an identifier are registered for
Richard Smith79bf9202015-08-24 03:33:22 +00004846 // serialization, if we're storing decls with identifiers.
4847 if (!WritingModule || !getLangOpts().CPlusPlus) {
4848 llvm::SmallVector<const IdentifierInfo*, 256> IIs;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00004849 for (const auto &ID : PP.getIdentifierTable()) {
4850 const IdentifierInfo *II = ID.second;
Richard Smith79bf9202015-08-24 03:33:22 +00004851 if (!Chain || !II->isFromAST() || II->hasChangedSinceDeserialization())
4852 IIs.push_back(II);
4853 }
4854 // Sort the identifiers to visit based on their name.
Mandeep Singh Grangc205d8c2018-03-27 16:50:00 +00004855 llvm::sort(IIs.begin(), IIs.end(), llvm::less_ptr<IdentifierInfo>());
Richard Smith79bf9202015-08-24 03:33:22 +00004856 for (const IdentifierInfo *II : IIs) {
4857 for (IdentifierResolver::iterator D = SemaRef.IdResolver.begin(II),
4858 DEnd = SemaRef.IdResolver.end();
4859 D != DEnd; ++D) {
4860 GetDeclRef(*D);
4861 }
Argyrios Kyrtzidisacfbbd72013-08-07 21:17:33 +00004862 }
4863 }
4864
Manman Rena0f31a02016-04-29 19:04:05 +00004865 // For method pool in the module, if it contains an entry for a selector,
4866 // the entry should be complete, containing everything introduced by that
4867 // module and all modules it imports. It's possible that the entry is out of
4868 // date, so we need to pull in the new content here.
4869
4870 // It's possible that updateOutOfDateSelector can update SelectorIDs. To be
4871 // safe, we copy all selectors out.
4872 llvm::SmallVector<Selector, 256> AllSelectors;
4873 for (auto &SelectorAndID : SelectorIDs)
4874 AllSelectors.push_back(SelectorAndID.first);
4875 for (auto &Selector : AllSelectors)
4876 SemaRef.updateOutOfDateSelector(Selector);
4877
Douglas Gregor5204bde2011-08-02 16:26:37 +00004878 // Form the record of special types.
4879 RecordData SpecialTypes;
Douglas Gregor5204bde2011-08-02 16:26:37 +00004880 AddTypeRef(Context.getRawCFConstantStringType(), SpecialTypes);
Douglas Gregor5204bde2011-08-02 16:26:37 +00004881 AddTypeRef(Context.getFILEType(), SpecialTypes);
4882 AddTypeRef(Context.getjmp_bufType(), SpecialTypes);
4883 AddTypeRef(Context.getsigjmp_bufType(), SpecialTypes);
4884 AddTypeRef(Context.ObjCIdRedefinitionType, SpecialTypes);
4885 AddTypeRef(Context.ObjCClassRedefinitionType, SpecialTypes);
Douglas Gregor5204bde2011-08-02 16:26:37 +00004886 AddTypeRef(Context.ObjCSelRedefinitionType, SpecialTypes);
Rafael Espindola6cfa82b2011-11-13 21:51:09 +00004887 AddTypeRef(Context.getucontext_tType(), SpecialTypes);
Douglas Gregora28bcdd2011-12-01 02:07:58 +00004888
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00004889 if (Chain) {
4890 // Write the mapping information describing our module dependencies and how
4891 // each of those modules were mapped into our own offset/ID space, so that
4892 // the reader can build the appropriate mapping to its own offset/ID space.
4893 // The map consists solely of a blob with the following format:
Boris Kolpackovd30446f2017-08-31 06:26:43 +00004894 // *(module-kind:i8
4895 // module-name-len:i16 module-name:len*i8
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00004896 // source-location-offset:i32
4897 // identifier-id:i32
4898 // preprocessed-entity-id:i32
4899 // macro-definition-id:i32
Douglas Gregor253eefe2011-12-01 00:59:36 +00004900 // submodule-id:i32
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00004901 // selector-id:i32
4902 // declaration-id:i32
4903 // c++-base-specifiers-id:i32
4904 // type-id:i32)
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00004905 //
Boris Kolpackovd30446f2017-08-31 06:26:43 +00004906 // module-kind is the ModuleKind enum value. If it is MK_PrebuiltModule or
4907 // MK_ExplicitModule, then the module-name is the module name. Otherwise,
4908 // it is the module file name.
David Blaikieb44f0bf2017-01-04 22:36:43 +00004909 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00004910 Abbrev->Add(BitCodeAbbrevOp(MODULE_OFFSET_MAP));
4911 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
David Blaikieb44f0bf2017-01-04 22:36:43 +00004912 unsigned ModuleOffsetMapAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00004913 SmallString<2048> Buffer;
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00004914 {
4915 llvm::raw_svector_ostream Out(Buffer);
Duncan P. N. Exon Smith96a06e02017-01-28 22:15:22 +00004916 for (ModuleFile &M : Chain->ModuleMgr) {
Justin Bognere1c147c2014-03-28 22:03:19 +00004917 using namespace llvm::support;
Eugene Zelenkob7d89102017-11-11 00:08:50 +00004918
Justin Bognere1c147c2014-03-28 22:03:19 +00004919 endian::Writer<little> LE(Out);
Boris Kolpackovd30446f2017-08-31 06:26:43 +00004920 LE.write<uint8_t>(static_cast<uint8_t>(M.Kind));
4921 StringRef Name =
4922 M.Kind == MK_PrebuiltModule || M.Kind == MK_ExplicitModule
4923 ? M.ModuleName
4924 : M.FileName;
4925 LE.write<uint16_t>(Name.size());
4926 Out.write(Name.data(), Name.size());
Ben Langmuirfe971d92014-08-16 04:54:18 +00004927
Ben Langmuir785180e2014-10-20 16:27:30 +00004928 // Note: if a base ID was uint max, it would not be possible to load
4929 // another module after it or have more than one entity inside it.
4930 uint32_t None = std::numeric_limits<uint32_t>::max();
4931
4932 auto writeBaseIDOrNone = [&](uint32_t BaseID, bool ShouldWrite) {
4933 assert(BaseID < std::numeric_limits<uint32_t>::max() && "base id too high");
4934 if (ShouldWrite)
4935 LE.write<uint32_t>(BaseID);
4936 else
4937 LE.write<uint32_t>(None);
4938 };
4939
Ben Langmuirfe971d92014-08-16 04:54:18 +00004940 // These values should be unique within a chain, since they will be read
4941 // as keys into ContinuousRangeMaps.
Duncan P. N. Exon Smith96a06e02017-01-28 22:15:22 +00004942 writeBaseIDOrNone(M.SLocEntryBaseOffset, M.LocalNumSLocEntries);
4943 writeBaseIDOrNone(M.BaseIdentifierID, M.LocalNumIdentifiers);
4944 writeBaseIDOrNone(M.BaseMacroID, M.LocalNumMacros);
4945 writeBaseIDOrNone(M.BasePreprocessedEntityID,
4946 M.NumPreprocessedEntities);
4947 writeBaseIDOrNone(M.BaseSubmoduleID, M.LocalNumSubmodules);
4948 writeBaseIDOrNone(M.BaseSelectorID, M.LocalNumSelectors);
4949 writeBaseIDOrNone(M.BaseDeclID, M.LocalNumDecls);
4950 writeBaseIDOrNone(M.BaseTypeIndex, M.LocalNumTypes);
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00004951 }
4952 }
Mehdi Amini57a41912015-09-10 01:46:39 +00004953 RecordData::value_type Record[] = {MODULE_OFFSET_MAP};
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00004954 Stream.EmitRecordWithBlob(ModuleOffsetMapAbbrev, Record,
4955 Buffer.data(), Buffer.size());
4956 }
Richard Smithb9eab6d2014-03-20 19:44:17 +00004957
Richard Smithb9eab6d2014-03-20 19:44:17 +00004958 RecordData DeclUpdatesOffsetsRecord;
4959
Richard Smith59442b42014-03-20 20:07:19 +00004960 // Keep writing types, declarations, and declaration update records
4961 // until we've emitted all of them.
Richard Smith01b2cb42014-07-26 06:37:51 +00004962 Stream.EnterSubblock(DECLTYPES_BLOCK_ID, /*bits for abbreviations*/5);
4963 WriteTypeAbbrevs();
4964 WriteDeclAbbrevs();
Richard Smith59442b42014-03-20 20:07:19 +00004965 do {
4966 WriteDeclUpdatesBlocks(DeclUpdatesOffsetsRecord);
4967 while (!DeclTypesToEmit.empty()) {
4968 DeclOrType DOT = DeclTypesToEmit.front();
4969 DeclTypesToEmit.pop();
4970 if (DOT.isType())
4971 WriteType(DOT.getType());
4972 else
4973 WriteDecl(Context, DOT.getDecl());
4974 }
4975 } while (!DeclUpdates.empty());
Richard Smithb9eab6d2014-03-20 19:44:17 +00004976 Stream.ExitBlock();
4977
Richard Smithb9eab6d2014-03-20 19:44:17 +00004978 DoneWritingDeclsAndTypes = true;
4979
4980 // These things can only be done once we've written out decls and types.
4981 WriteTypeDeclOffsets();
Richard Smith5652c0f2014-03-21 01:48:23 +00004982 if (!DeclUpdatesOffsetsRecord.empty())
4983 Stream.EmitRecord(DECL_UPDATE_OFFSETS, DeclUpdatesOffsetsRecord);
Richard Smithb9eab6d2014-03-20 19:44:17 +00004984 WriteFileDeclIDsMap();
Richard Smith7ed1bc92014-12-05 22:42:13 +00004985 WriteSourceManagerBlock(Context.getSourceManager(), PP);
Richard Smithb9eab6d2014-03-20 19:44:17 +00004986 WriteComments();
Argyrios Kyrtzidisffb35582013-03-14 04:44:56 +00004987 WritePreprocessor(PP, isModule);
Richard Smith7ed1bc92014-12-05 22:42:13 +00004988 WriteHeaderSearch(PP.getHeaderSearchInfo());
Sebastian Redla19a67f2010-08-03 21:58:15 +00004989 WriteSelectors(SemaRef);
Fariborz Jahanianc51609a2010-07-23 19:11:11 +00004990 WriteReferencedSelectorsPool(SemaRef);
Richard Smith9c254182015-07-19 21:41:12 +00004991 WriteLateParsedTemplates(SemaRef);
Argyrios Kyrtzidisffb35582013-03-14 04:44:56 +00004992 WriteIdentifierTable(PP, SemaRef.IdResolver, isModule);
Peter Collingbourne5df20e02011-02-15 19:46:30 +00004993 WriteFPPragmaOptions(SemaRef.getFPOptions());
4994 WriteOpenCLExtensions(SemaRef);
Yaxun Liu5b746652016-12-18 05:18:55 +00004995 WriteOpenCLExtensionTypes(SemaRef);
4996 WriteOpenCLExtensionDecls(SemaRef);
Justin Lebar67a78a62016-10-08 22:15:58 +00004997 WriteCUDAPragmas(SemaRef);
Douglas Gregor652d82a2009-04-18 05:55:16 +00004998
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00004999 // If we're emitting a module, write out the submodule information.
Douglas Gregora89c5ac2011-12-06 01:10:29 +00005000 if (WritingModule)
5001 WriteSubmodules(WritingModule);
5002
Douglas Gregor5204bde2011-08-02 16:26:37 +00005003 Stream.EmitRecord(SPECIAL_TYPES, SpecialTypes);
5004
Douglas Gregord4df8652009-04-22 22:02:47 +00005005 // Write the record containing external, unnamed definitions.
Ben Langmuir332aafe2014-01-31 01:06:56 +00005006 if (!EagerlyDeserializedDecls.empty())
5007 Stream.EmitRecord(EAGERLY_DESERIALIZED_DECLS, EagerlyDeserializedDecls);
Douglas Gregord4df8652009-04-22 22:02:47 +00005008
David Blaikief63556d2017-04-12 20:58:33 +00005009 if (!ModularCodegenDecls.empty())
David Blaikie9ffe5a32017-01-30 05:00:26 +00005010 Stream.EmitRecord(MODULAR_CODEGEN_DECLS, ModularCodegenDecls);
5011
Douglas Gregord4df8652009-04-22 22:02:47 +00005012 // Write the record containing tentative definitions.
5013 if (!TentativeDefinitions.empty())
Sebastian Redl539c5062010-08-18 23:57:32 +00005014 Stream.EmitRecord(TENTATIVE_DEFINITIONS, TentativeDefinitions);
Douglas Gregoracfc76c2009-04-22 22:18:58 +00005015
Argyrios Kyrtzidis35672e72010-08-13 18:42:17 +00005016 // Write the record containing unused file scoped decls.
5017 if (!UnusedFileScopedDecls.empty())
Sebastian Redl539c5062010-08-18 23:57:32 +00005018 Stream.EmitRecord(UNUSED_FILESCOPED_DECLS, UnusedFileScopedDecls);
Kovarththanan Rajaratnama9c81a82010-03-14 07:06:50 +00005019
Argyrios Kyrtzidisee1afa32010-08-05 09:48:08 +00005020 // Write the record containing weak undeclared identifiers.
5021 if (!WeakUndeclaredIdentifiers.empty())
Sebastian Redl539c5062010-08-18 23:57:32 +00005022 Stream.EmitRecord(WEAK_UNDECLARED_IDENTIFIERS,
Argyrios Kyrtzidisee1afa32010-08-05 09:48:08 +00005023 WeakUndeclaredIdentifiers);
5024
Douglas Gregor61cac2b2009-04-27 20:06:05 +00005025 // Write the record containing ext_vector type names.
5026 if (!ExtVectorDecls.empty())
Sebastian Redl539c5062010-08-18 23:57:32 +00005027 Stream.EmitRecord(EXT_VECTOR_DECLS, ExtVectorDecls);
Mike Stump11289f42009-09-09 15:08:12 +00005028
Argyrios Kyrtzidisaf2eac22010-07-06 15:37:04 +00005029 // Write the record containing VTable uses information.
5030 if (!VTableUses.empty())
Sebastian Redl539c5062010-08-18 23:57:32 +00005031 Stream.EmitRecord(VTABLE_USES, VTableUses);
Argyrios Kyrtzidisaf2eac22010-07-06 15:37:04 +00005032
Nico Weber72889432014-09-06 01:25:55 +00005033 // Write the record containing potentially unused local typedefs.
5034 if (!UnusedLocalTypedefNameCandidates.empty())
5035 Stream.EmitRecord(UNUSED_LOCAL_TYPEDEF_NAME_CANDIDATES,
5036 UnusedLocalTypedefNameCandidates);
5037
Argyrios Kyrtzidis7f76d112010-08-05 09:48:16 +00005038 // Write the record containing pending implicit instantiations.
Chandler Carruth54080172010-08-25 08:44:16 +00005039 if (!PendingInstantiations.empty())
5040 Stream.EmitRecord(PENDING_IMPLICIT_INSTANTIATIONS, PendingInstantiations);
Argyrios Kyrtzidis7f76d112010-08-05 09:48:16 +00005041
Argyrios Kyrtzidis2d688102010-08-02 07:14:54 +00005042 // Write the record containing declaration references of Sema.
5043 if (!SemaDeclRefs.empty())
Sebastian Redl539c5062010-08-18 23:57:32 +00005044 Stream.EmitRecord(SEMA_DECL_REFS, SemaDeclRefs);
Argyrios Kyrtzidis2d688102010-08-02 07:14:54 +00005045
Peter Collingbourne9e2c81f2011-02-09 21:04:32 +00005046 // Write the record containing CUDA-specific declaration references.
5047 if (!CUDASpecialDeclRefs.empty())
5048 Stream.EmitRecord(CUDA_SPECIAL_DECL_REFS, CUDASpecialDeclRefs);
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00005049
Alexis Hunt27a761d2011-05-04 23:29:54 +00005050 // Write the delegating constructors.
5051 if (!DelegatingCtorDecls.empty())
5052 Stream.EmitRecord(DELEGATING_CTORS, DelegatingCtorDecls);
Peter Collingbourne9e2c81f2011-02-09 21:04:32 +00005053
Douglas Gregorc2fa1692011-06-28 16:20:02 +00005054 // Write the known namespaces.
5055 if (!KnownNamespaces.empty())
5056 Stream.EmitRecord(KNOWN_NAMESPACES, KnownNamespaces);
Nick Lewycky8334af82013-01-26 00:35:08 +00005057
Nick Lewycky9c7eb1d2013-02-01 08:13:20 +00005058 // Write the undefined internal functions and variables, and inline functions.
5059 if (!UndefinedButUsed.empty())
5060 Stream.EmitRecord(UNDEFINED_BUT_USED, UndefinedButUsed);
Ismail Pazarbasie5768d12015-05-18 19:59:11 +00005061
5062 if (!DeleteExprsToAnalyze.empty())
5063 Stream.EmitRecord(DELETE_EXPRS_TO_ANALYZE, DeleteExprsToAnalyze);
5064
Douglas Gregor851443c2011-08-12 01:39:19 +00005065 // Write the visible updates to DeclContexts.
Richard Smithcd45dbc2014-04-19 03:48:30 +00005066 for (auto *DC : UpdatedDeclContexts)
5067 WriteDeclContextVisibleUpdate(DC);
Douglas Gregor851443c2011-08-12 01:39:19 +00005068
Douglas Gregor959bb062011-12-03 01:15:29 +00005069 if (!WritingModule) {
5070 // Write the submodules that were imported, if any.
Aaron Ballman4f45b712014-03-21 15:22:56 +00005071 struct ModuleInfo {
5072 uint64_t ID;
5073 Module *M;
5074 ModuleInfo(uint64_t ID, Module *M) : ID(ID), M(M) {}
5075 };
Richard Smith56be7542014-03-21 00:33:59 +00005076 llvm::SmallVector<ModuleInfo, 64> Imports;
Aaron Ballmanbbc31212014-03-14 20:59:21 +00005077 for (const auto *I : Context.local_imports()) {
Douglas Gregor959bb062011-12-03 01:15:29 +00005078 assert(SubmoduleIDs.find(I->getImportedModule()) != SubmoduleIDs.end());
Aaron Ballman4f45b712014-03-21 15:22:56 +00005079 Imports.push_back(ModuleInfo(SubmoduleIDs[I->getImportedModule()],
5080 I->getImportedModule()));
Douglas Gregor959bb062011-12-03 01:15:29 +00005081 }
Richard Smith56be7542014-03-21 00:33:59 +00005082
5083 if (!Imports.empty()) {
5084 auto Cmp = [](const ModuleInfo &A, const ModuleInfo &B) {
5085 return A.ID < B.ID;
5086 };
Ben Langmuir5f95c8f2014-09-08 20:36:26 +00005087 auto Eq = [](const ModuleInfo &A, const ModuleInfo &B) {
5088 return A.ID == B.ID;
5089 };
Richard Smith56be7542014-03-21 00:33:59 +00005090
5091 // Sort and deduplicate module IDs.
Mandeep Singh Grangc205d8c2018-03-27 16:50:00 +00005092 llvm::sort(Imports.begin(), Imports.end(), Cmp);
Ben Langmuir5f95c8f2014-09-08 20:36:26 +00005093 Imports.erase(std::unique(Imports.begin(), Imports.end(), Eq),
Richard Smith56be7542014-03-21 00:33:59 +00005094 Imports.end());
5095
5096 RecordData ImportedModules;
5097 for (const auto &Import : Imports) {
5098 ImportedModules.push_back(Import.ID);
5099 // FIXME: If the module has macros imported then later has declarations
5100 // imported, this location won't be the right one as a location for the
5101 // declaration imports.
Richard Smith10434f32015-05-02 02:08:26 +00005102 AddSourceLocation(PP.getModuleImportLoc(Import.M), ImportedModules);
Richard Smith56be7542014-03-21 00:33:59 +00005103 }
5104
Douglas Gregor959bb062011-12-03 01:15:29 +00005105 Stream.EmitRecord(IMPORTED_MODULES, ImportedModules);
5106 }
Douglas Gregor0a839132011-12-03 00:59:55 +00005107 }
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00005108
Douglas Gregor404cdde2012-01-27 01:47:08 +00005109 WriteObjCCategories();
Nico Weber779355f2016-03-02 23:22:00 +00005110 if(!WritingModule) {
Dario Domizioli13a0a382014-05-23 12:13:25 +00005111 WriteOptimizePragmaOptions(SemaRef);
Nico Weber779355f2016-03-02 23:22:00 +00005112 WriteMSStructPragmaOptions(SemaRef);
Nico Weber42932312016-03-03 00:17:35 +00005113 WriteMSPointersToMembersPragmaOptions(SemaRef);
Nico Weber779355f2016-03-02 23:22:00 +00005114 }
Alex Lorenz7d7e1e02017-03-31 15:36:21 +00005115 WritePackPragmaOptions(SemaRef);
Richard Smithe40f2ba2013-08-07 21:41:30 +00005116
Douglas Gregor08f01292009-04-17 22:13:46 +00005117 // Some simple statistics
Mehdi Amini57a41912015-09-10 01:46:39 +00005118 RecordData::value_type Record[] = {
5119 NumStatements, NumMacros, NumLexicalDeclContexts, NumVisibleDeclContexts};
Sebastian Redl539c5062010-08-18 23:57:32 +00005120 Stream.EmitRecord(STATISTICS, Record);
Douglas Gregor8f45df52009-04-16 22:23:12 +00005121 Stream.ExitBlock();
Adrian Prantladbd2b12015-09-22 23:26:31 +00005122
Douglas Gregor6623e1f2015-11-03 18:33:07 +00005123 // Write the module file extension blocks.
5124 for (const auto &ExtWriter : ModuleFileExtensionWriters)
Douglas Gregor8f64ca12015-12-08 22:43:32 +00005125 WriteModuleFileExtension(SemaRef, *ExtWriter);
Douglas Gregor6623e1f2015-11-03 18:33:07 +00005126
Duncan P. N. Exon Smith60fa2882017-03-13 18:45:08 +00005127 return writeUnhashedControlBlock(PP, Context);
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005128}
5129
Richard Smithb9eab6d2014-03-20 19:44:17 +00005130void ASTWriter::WriteDeclUpdatesBlocks(RecordDataImpl &OffsetsRecord) {
Argyrios Kyrtzidis65ad5692010-10-24 17:26:36 +00005131 if (DeclUpdates.empty())
5132 return;
5133
Richard Smith59442b42014-03-20 20:07:19 +00005134 DeclUpdateMap LocalUpdates;
5135 LocalUpdates.swap(DeclUpdates);
5136
Richard Smith6ef42932014-03-20 21:02:00 +00005137 for (auto &DeclUpdate : LocalUpdates) {
5138 const Decl *D = DeclUpdate.first;
Argyrios Kyrtzidis3ba70b82010-10-24 17:26:46 +00005139
Richard Smithd28ac5b2014-03-22 23:33:22 +00005140 bool HasUpdatedBody = false;
Richard Smith69c82bf2016-04-01 22:52:03 +00005141 RecordData RecordData;
5142 ASTRecordWriter Record(*this, RecordData);
Richard Smith6ef42932014-03-20 21:02:00 +00005143 for (auto &Update : DeclUpdate.second) {
5144 DeclUpdateKind Kind = (DeclUpdateKind)Update.getKind();
5145
Richard Smith69c82bf2016-04-01 22:52:03 +00005146 // An updated body is emitted last, so that the reader doesn't need
5147 // to skip over the lazy body to reach statements for other records.
5148 if (Kind == UPD_CXX_ADDED_FUNCTION_DEFINITION)
5149 HasUpdatedBody = true;
5150 else
5151 Record.push_back(Kind);
5152
Richard Smith6ef42932014-03-20 21:02:00 +00005153 switch (Kind) {
5154 case UPD_CXX_ADDED_IMPLICIT_MEMBER:
5155 case UPD_CXX_ADDED_TEMPLATE_SPECIALIZATION:
5156 case UPD_CXX_ADDED_ANONYMOUS_NAMESPACE:
Richard Smithcd45dbc2014-04-19 03:48:30 +00005157 assert(Update.getDecl() && "no decl to add?");
Richard Smith6ef42932014-03-20 21:02:00 +00005158 Record.push_back(GetDeclRef(Update.getDecl()));
5159 break;
5160
Richard Smith4d235792014-08-07 18:53:08 +00005161 case UPD_CXX_ADDED_FUNCTION_DEFINITION:
Richard Smithd28ac5b2014-03-22 23:33:22 +00005162 break;
5163
Richard Smith891fc7f2017-12-05 01:31:47 +00005164 case UPD_CXX_POINT_OF_INSTANTIATION:
5165 // FIXME: Do we need to also save the template specialization kind here?
Richard Smith69c82bf2016-04-01 22:52:03 +00005166 Record.AddSourceLocation(Update.getLoc());
Richard Smith891fc7f2017-12-05 01:31:47 +00005167 break;
5168
5169 case UPD_CXX_ADDED_VAR_DEFINITION: {
5170 const VarDecl *VD = cast<VarDecl>(D);
Richard Smithf5017592017-11-02 01:06:00 +00005171 Record.push_back(VD->isInline());
5172 Record.push_back(VD->isInlineSpecified());
Richard Smith05a21352017-06-22 22:18:46 +00005173 if (VD->getInit()) {
5174 Record.push_back(!VD->isInitKnownICE() ? 1
5175 : (VD->isInitICE() ? 3 : 2));
5176 Record.AddStmt(const_cast<Expr*>(VD->getInit()));
5177 } else {
5178 Record.push_back(0);
5179 }
Richard Smith4d235792014-08-07 18:53:08 +00005180 break;
Richard Smith05a21352017-06-22 22:18:46 +00005181 }
Richard Smith4d235792014-08-07 18:53:08 +00005182
John McCall32791cc2016-01-06 22:34:54 +00005183 case UPD_CXX_INSTANTIATED_DEFAULT_ARGUMENT:
Richard Smith290d8012016-04-06 17:06:00 +00005184 Record.AddStmt(const_cast<Expr *>(
5185 cast<ParmVarDecl>(Update.getDecl())->getDefaultArg()));
John McCall32791cc2016-01-06 22:34:54 +00005186 break;
5187
Richard Smith4b054b22016-08-24 21:25:37 +00005188 case UPD_CXX_INSTANTIATED_DEFAULT_MEMBER_INITIALIZER:
5189 Record.AddStmt(
5190 cast<FieldDecl>(Update.getDecl())->getInClassInitializer());
5191 break;
5192
Richard Smithcd45dbc2014-04-19 03:48:30 +00005193 case UPD_CXX_INSTANTIATED_CLASS_DEFINITION: {
5194 auto *RD = cast<CXXRecordDecl>(D);
Chandler Carruth8a3d24d2015-03-26 04:27:10 +00005195 UpdatedDeclContexts.insert(RD->getPrimaryContext());
Akira Hatanakad791e922018-03-19 17:38:40 +00005196 Record.push_back(RD->canPassInRegisters());
Richard Smith69c82bf2016-04-01 22:52:03 +00005197 Record.AddCXXDefinitionData(RD);
Richard Smith72e50fe2016-04-14 00:50:18 +00005198 Record.AddOffset(WriteDeclContextLexicalBlock(
Richard Smithcd45dbc2014-04-19 03:48:30 +00005199 *Context, const_cast<CXXRecordDecl *>(RD)));
5200
5201 // This state is sometimes updated by template instantiation, when we
5202 // switch from the specialization referring to the template declaration
5203 // to it referring to the template definition.
5204 if (auto *MSInfo = RD->getMemberSpecializationInfo()) {
5205 Record.push_back(MSInfo->getTemplateSpecializationKind());
Richard Smith69c82bf2016-04-01 22:52:03 +00005206 Record.AddSourceLocation(MSInfo->getPointOfInstantiation());
Richard Smithcd45dbc2014-04-19 03:48:30 +00005207 } else {
5208 auto *Spec = cast<ClassTemplateSpecializationDecl>(RD);
5209 Record.push_back(Spec->getTemplateSpecializationKind());
Richard Smith69c82bf2016-04-01 22:52:03 +00005210 Record.AddSourceLocation(Spec->getPointOfInstantiation());
Richard Smithdf352052014-05-22 20:59:29 +00005211
5212 // The instantiation might have been resolved to a partial
5213 // specialization. If so, record which one.
5214 auto From = Spec->getInstantiatedFrom();
5215 if (auto PartialSpec =
5216 From.dyn_cast<ClassTemplatePartialSpecializationDecl*>()) {
5217 Record.push_back(true);
Richard Smith69c82bf2016-04-01 22:52:03 +00005218 Record.AddDeclRef(PartialSpec);
5219 Record.AddTemplateArgumentList(
5220 &Spec->getTemplateInstantiationArgs());
Richard Smithdf352052014-05-22 20:59:29 +00005221 } else {
5222 Record.push_back(false);
5223 }
Richard Smithcd45dbc2014-04-19 03:48:30 +00005224 }
5225 Record.push_back(RD->getTagKind());
Richard Smith69c82bf2016-04-01 22:52:03 +00005226 Record.AddSourceLocation(RD->getLocation());
5227 Record.AddSourceLocation(RD->getLocStart());
Argyrios Kyrtzidisd798c052016-07-15 18:11:33 +00005228 Record.AddSourceRange(RD->getBraceRange());
Richard Smithcd45dbc2014-04-19 03:48:30 +00005229
5230 // Instantiation may change attributes; write them all out afresh.
5231 Record.push_back(D->hasAttrs());
Richard Smith69c82bf2016-04-01 22:52:03 +00005232 if (D->hasAttrs())
5233 Record.AddAttributes(D->getAttrs());
Richard Smithcd45dbc2014-04-19 03:48:30 +00005234
5235 // FIXME: Ensure we don't get here for explicit instantiations.
5236 break;
5237 }
5238
Richard Smithf8134002015-03-10 01:41:22 +00005239 case UPD_CXX_RESOLVED_DTOR_DELETE:
Richard Smith69c82bf2016-04-01 22:52:03 +00005240 Record.AddDeclRef(Update.getDecl());
Richard Smith5b349582017-10-13 01:55:36 +00005241 Record.AddStmt(cast<CXXDestructorDecl>(D)->getOperatorDeleteThisArg());
Richard Smithf8134002015-03-10 01:41:22 +00005242 break;
5243
Richard Smith564417a2014-03-20 21:47:22 +00005244 case UPD_CXX_RESOLVED_EXCEPTION_SPEC:
5245 addExceptionSpec(
Richard Smith564417a2014-03-20 21:47:22 +00005246 cast<FunctionDecl>(D)->getType()->castAs<FunctionProtoType>(),
5247 Record);
5248 break;
5249
Richard Smith6ef42932014-03-20 21:02:00 +00005250 case UPD_CXX_DEDUCED_RETURN_TYPE:
5251 Record.push_back(GetOrCreateTypeID(Update.getType()));
5252 break;
5253
5254 case UPD_DECL_MARKED_USED:
5255 break;
Richard Smith5652c0f2014-03-21 01:48:23 +00005256
5257 case UPD_MANGLING_NUMBER:
5258 case UPD_STATIC_LOCAL_NUMBER:
5259 Record.push_back(Update.getNumber());
5260 break;
Richard Smith65ebb4a2015-03-26 04:09:53 +00005261
Alexey Bataev97720002014-11-11 04:05:39 +00005262 case UPD_DECL_MARKED_OPENMP_THREADPRIVATE:
Richard Smith69c82bf2016-04-01 22:52:03 +00005263 Record.AddSourceRange(
5264 D->getAttr<OMPThreadPrivateDeclAttr>()->getRange());
Alexey Bataev97720002014-11-11 04:05:39 +00005265 break;
Richard Smith65ebb4a2015-03-26 04:09:53 +00005266
Dmitry Polukhin0b0da292016-04-06 11:38:59 +00005267 case UPD_DECL_MARKED_OPENMP_DECLARETARGET:
5268 Record.AddSourceRange(
5269 D->getAttr<OMPDeclareTargetDeclAttr>()->getRange());
5270 break;
5271
Richard Smith65ebb4a2015-03-26 04:09:53 +00005272 case UPD_DECL_EXPORTED:
Richard Smith4caa4492015-05-15 02:34:32 +00005273 Record.push_back(getSubmoduleID(Update.getModule()));
Richard Smith65ebb4a2015-03-26 04:09:53 +00005274 break;
Alex Denisovfde64952015-06-26 05:28:36 +00005275
5276 case UPD_ADDED_ATTR_TO_RECORD:
Richard Smith69c82bf2016-04-01 22:52:03 +00005277 Record.AddAttributes(llvm::makeArrayRef(Update.getAttr()));
Alex Denisovfde64952015-06-26 05:28:36 +00005278 break;
Richard Smith6ef42932014-03-20 21:02:00 +00005279 }
5280 }
5281
Richard Smithd28ac5b2014-03-22 23:33:22 +00005282 if (HasUpdatedBody) {
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00005283 const auto *Def = cast<FunctionDecl>(D);
Richard Smith4d235792014-08-07 18:53:08 +00005284 Record.push_back(UPD_CXX_ADDED_FUNCTION_DEFINITION);
Richard Smithd28ac5b2014-03-22 23:33:22 +00005285 Record.push_back(Def->isInlined());
Richard Smith69c82bf2016-04-01 22:52:03 +00005286 Record.AddSourceLocation(Def->getInnerLocStart());
Richard Smith290d8012016-04-06 17:06:00 +00005287 Record.AddFunctionDefinition(Def);
Richard Smithd28ac5b2014-03-22 23:33:22 +00005288 }
5289
Richard Smithcd45dbc2014-04-19 03:48:30 +00005290 OffsetsRecord.push_back(GetDeclRef(D));
Richard Smith69c82bf2016-04-01 22:52:03 +00005291 OffsetsRecord.push_back(Record.Emit(DECL_UPDATES));
Argyrios Kyrtzidis65ad5692010-10-24 17:26:36 +00005292 }
Argyrios Kyrtzidis65ad5692010-10-24 17:26:36 +00005293}
5294
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00005295void ASTWriter::AddSourceLocation(SourceLocation Loc, RecordDataImpl &Record) {
Richard Smithb22a1d12016-03-27 20:13:24 +00005296 uint32_t Raw = Loc.getRawEncoding();
5297 Record.push_back((Raw << 1) | (Raw >> 31));
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005298}
5299
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00005300void ASTWriter::AddSourceRange(SourceRange Range, RecordDataImpl &Record) {
Chris Lattnerca025db2010-05-07 21:43:38 +00005301 AddSourceLocation(Range.getBegin(), Record);
5302 AddSourceLocation(Range.getEnd(), Record);
5303}
5304
Richard Smithf144b542016-04-08 21:54:32 +00005305void ASTRecordWriter::AddAPInt(const llvm::APInt &Value) {
5306 Record->push_back(Value.getBitWidth());
Benjamin Kramer25f9ea62010-09-06 23:43:28 +00005307 const uint64_t *Words = Value.getRawData();
Richard Smithf144b542016-04-08 21:54:32 +00005308 Record->append(Words, Words + Value.getNumWords());
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005309}
5310
Richard Smithf144b542016-04-08 21:54:32 +00005311void ASTRecordWriter::AddAPSInt(const llvm::APSInt &Value) {
5312 Record->push_back(Value.isUnsigned());
5313 AddAPInt(Value);
Douglas Gregor1daeb692009-04-13 18:14:40 +00005314}
5315
Richard Smithf144b542016-04-08 21:54:32 +00005316void ASTRecordWriter::AddAPFloat(const llvm::APFloat &Value) {
5317 AddAPInt(Value.bitcastToAPInt());
Douglas Gregore0a3a512009-04-14 21:55:33 +00005318}
5319
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00005320void ASTWriter::AddIdentifierRef(const IdentifierInfo *II, RecordDataImpl &Record) {
Douglas Gregor4621c6a2009-04-22 18:49:13 +00005321 Record.push_back(getIdentifierRef(II));
5322}
5323
Sebastian Redl539c5062010-08-18 23:57:32 +00005324IdentID ASTWriter::getIdentifierRef(const IdentifierInfo *II) {
Craig Toppera13603a2014-05-22 05:54:18 +00005325 if (!II)
Douglas Gregor4621c6a2009-04-22 18:49:13 +00005326 return 0;
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00005327
Sebastian Redl539c5062010-08-18 23:57:32 +00005328 IdentID &ID = IdentifierIDs[II];
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00005329 if (ID == 0)
Sebastian Redlff4a2952010-07-23 23:49:55 +00005330 ID = NextIdentID++;
Douglas Gregor4621c6a2009-04-22 18:49:13 +00005331 return ID;
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005332}
5333
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00005334MacroID ASTWriter::getMacroRef(MacroInfo *MI, const IdentifierInfo *Name) {
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00005335 // Don't emit builtin macros like __LINE__ to the AST file unless they
5336 // have been redefined by the header (in which case they are not
5337 // isBuiltinMacro).
Craig Toppera13603a2014-05-22 05:54:18 +00005338 if (!MI || MI->isBuiltinMacro())
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00005339 return 0;
5340
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00005341 MacroID &ID = MacroIDs[MI];
5342 if (ID == 0) {
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00005343 ID = NextMacroID++;
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00005344 MacroInfoToEmitData Info = { Name, MI, ID };
5345 MacroInfosToEmit.push_back(Info);
5346 }
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00005347 return ID;
5348}
5349
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00005350MacroID ASTWriter::getMacroID(MacroInfo *MI) {
Craig Toppera13603a2014-05-22 05:54:18 +00005351 if (!MI || MI->isBuiltinMacro())
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00005352 return 0;
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00005353
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00005354 assert(MacroIDs.find(MI) != MacroIDs.end() && "Macro not emitted!");
5355 return MacroIDs[MI];
5356}
5357
5358uint64_t ASTWriter::getMacroDirectivesOffset(const IdentifierInfo *Name) {
Richard Smithd7329392015-04-21 21:46:32 +00005359 return IdentMacroDirectivesOffsetMap.lookup(Name);
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00005360}
5361
Richard Smithe64e7452016-04-18 21:54:58 +00005362void ASTRecordWriter::AddSelectorRef(const Selector SelRef) {
5363 Record->push_back(Writer->getSelectorRef(SelRef));
Sebastian Redl834bb972010-08-04 17:20:04 +00005364}
5365
Sebastian Redl539c5062010-08-18 23:57:32 +00005366SelectorID ASTWriter::getSelectorRef(Selector Sel) {
Craig Toppera13603a2014-05-22 05:54:18 +00005367 if (Sel.getAsOpaquePtr() == nullptr) {
Sebastian Redl834bb972010-08-04 17:20:04 +00005368 return 0;
Steve Naroff2ddea052009-04-23 10:39:46 +00005369 }
5370
Douglas Gregor8d7edce2013-02-08 21:30:59 +00005371 SelectorID SID = SelectorIDs[Sel];
Sebastian Redld95a56e2010-08-04 18:21:41 +00005372 if (SID == 0 && Chain) {
5373 // This might trigger a ReadSelector callback, which will set the ID for
5374 // this selector.
5375 Chain->LoadSelector(Sel);
Douglas Gregor8d7edce2013-02-08 21:30:59 +00005376 SID = SelectorIDs[Sel];
Sebastian Redld95a56e2010-08-04 18:21:41 +00005377 }
Steve Naroff2ddea052009-04-23 10:39:46 +00005378 if (SID == 0) {
Sebastian Redld95a56e2010-08-04 18:21:41 +00005379 SID = NextSelectorID++;
Douglas Gregor8d7edce2013-02-08 21:30:59 +00005380 SelectorIDs[Sel] = SID;
Steve Naroff2ddea052009-04-23 10:39:46 +00005381 }
Sebastian Redl834bb972010-08-04 17:20:04 +00005382 return SID;
Steve Naroff2ddea052009-04-23 10:39:46 +00005383}
5384
Richard Smithe64e7452016-04-18 21:54:58 +00005385void ASTRecordWriter::AddCXXTemporary(const CXXTemporary *Temp) {
5386 AddDeclRef(Temp->getDestructor());
Chris Lattnercba86142010-05-10 00:25:06 +00005387}
5388
Richard Smith290d8012016-04-06 17:06:00 +00005389void ASTRecordWriter::AddTemplateArgumentLocInfo(
5390 TemplateArgument::ArgKind Kind, const TemplateArgumentLocInfo &Arg) {
Argyrios Kyrtzidisae85e242010-06-22 09:54:59 +00005391 switch (Kind) {
John McCall0ad16662009-10-29 08:12:44 +00005392 case TemplateArgument::Expression:
Argyrios Kyrtzidisae85e242010-06-22 09:54:59 +00005393 AddStmt(Arg.getAsExpr());
John McCall0ad16662009-10-29 08:12:44 +00005394 break;
5395 case TemplateArgument::Type:
Richard Smith290d8012016-04-06 17:06:00 +00005396 AddTypeSourceInfo(Arg.getAsTypeSourceInfo());
John McCall0ad16662009-10-29 08:12:44 +00005397 break;
Douglas Gregor9167f8b2009-11-11 01:00:40 +00005398 case TemplateArgument::Template:
Richard Smith290d8012016-04-06 17:06:00 +00005399 AddNestedNameSpecifierLoc(Arg.getTemplateQualifierLoc());
5400 AddSourceLocation(Arg.getTemplateNameLoc());
Douglas Gregore4ff4b52011-01-05 18:58:31 +00005401 break;
5402 case TemplateArgument::TemplateExpansion:
Richard Smith290d8012016-04-06 17:06:00 +00005403 AddNestedNameSpecifierLoc(Arg.getTemplateQualifierLoc());
5404 AddSourceLocation(Arg.getTemplateNameLoc());
5405 AddSourceLocation(Arg.getTemplateEllipsisLoc());
Douglas Gregor9167f8b2009-11-11 01:00:40 +00005406 break;
John McCall0ad16662009-10-29 08:12:44 +00005407 case TemplateArgument::Null:
5408 case TemplateArgument::Integral:
5409 case TemplateArgument::Declaration:
Eli Friedmanb826a002012-09-26 02:36:12 +00005410 case TemplateArgument::NullPtr:
John McCall0ad16662009-10-29 08:12:44 +00005411 case TemplateArgument::Pack:
Eli Friedmanb826a002012-09-26 02:36:12 +00005412 // FIXME: Is this right?
John McCall0ad16662009-10-29 08:12:44 +00005413 break;
5414 }
5415}
5416
Richard Smith290d8012016-04-06 17:06:00 +00005417void ASTRecordWriter::AddTemplateArgumentLoc(const TemplateArgumentLoc &Arg) {
5418 AddTemplateArgument(Arg.getArgument());
Argyrios Kyrtzidisddf5f212010-06-28 09:31:42 +00005419
5420 if (Arg.getArgument().getKind() == TemplateArgument::Expression) {
5421 bool InfoHasSameExpr
5422 = Arg.getArgument().getAsExpr() == Arg.getLocInfo().getAsExpr();
Richard Smith290d8012016-04-06 17:06:00 +00005423 Record->push_back(InfoHasSameExpr);
Argyrios Kyrtzidisddf5f212010-06-28 09:31:42 +00005424 if (InfoHasSameExpr)
5425 return; // Avoid storing the same expr twice.
5426 }
Richard Smith290d8012016-04-06 17:06:00 +00005427 AddTemplateArgumentLocInfo(Arg.getArgument().getKind(), Arg.getLocInfo());
Argyrios Kyrtzidisae85e242010-06-22 09:54:59 +00005428}
5429
Richard Smith290d8012016-04-06 17:06:00 +00005430void ASTRecordWriter::AddTypeSourceInfo(TypeSourceInfo *TInfo) {
Craig Toppera13603a2014-05-22 05:54:18 +00005431 if (!TInfo) {
Richard Smith290d8012016-04-06 17:06:00 +00005432 AddTypeRef(QualType());
John McCall8f115c62009-10-16 21:56:05 +00005433 return;
5434 }
5435
Richard Smith290d8012016-04-06 17:06:00 +00005436 AddTypeLoc(TInfo->getTypeLoc());
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005437}
5438
Richard Smith290d8012016-04-06 17:06:00 +00005439void ASTRecordWriter::AddTypeLoc(TypeLoc TL) {
5440 AddTypeRef(TL.getType());
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005441
Richard Smith290d8012016-04-06 17:06:00 +00005442 TypeLocWriter TLW(*this);
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005443 for (; !TL.isNull(); TL = TL.getNextTypeLoc())
Kovarththanan Rajaratnama9c81a82010-03-14 07:06:50 +00005444 TLW.Visit(TL);
John McCall8f115c62009-10-16 21:56:05 +00005445}
5446
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00005447void ASTWriter::AddTypeRef(QualType T, RecordDataImpl &Record) {
Argyrios Kyrtzidis9ab44ea2010-08-20 16:04:14 +00005448 Record.push_back(GetOrCreateTypeID(T));
5449}
5450
Richard Smith2095ffe2015-03-16 20:11:03 +00005451TypeID ASTWriter::GetOrCreateTypeID(QualType T) {
Richard Smith1fa5d642013-05-11 05:45:24 +00005452 assert(Context);
Richard Smith2095ffe2015-03-16 20:11:03 +00005453 return MakeTypeID(*Context, T, [&](QualType T) -> TypeIdx {
5454 if (T.isNull())
5455 return TypeIdx();
5456 assert(!T.getLocalFastQualifiers());
5457
5458 TypeIdx &Idx = TypeIdxs[T];
5459 if (Idx.getIndex() == 0) {
5460 if (DoneWritingDeclsAndTypes) {
5461 assert(0 && "New type seen after serializing all the types to emit!");
5462 return TypeIdx();
5463 }
5464
5465 // We haven't seen this type before. Assign it a new ID and put it
5466 // into the queue of types to emit.
5467 Idx = TypeIdx(NextTypeID++);
5468 DeclTypesToEmit.push(T);
5469 }
5470 return Idx;
5471 });
Argyrios Kyrtzidis082e4612010-08-20 16:04:20 +00005472}
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005473
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00005474TypeID ASTWriter::getTypeID(QualType T) const {
Richard Smith1fa5d642013-05-11 05:45:24 +00005475 assert(Context);
Richard Smith2095ffe2015-03-16 20:11:03 +00005476 return MakeTypeID(*Context, T, [&](QualType T) -> TypeIdx {
5477 if (T.isNull())
Argyrios Kyrtzidis442dd802012-07-02 19:19:01 +00005478 return TypeIdx();
Richard Smith2095ffe2015-03-16 20:11:03 +00005479 assert(!T.getLocalFastQualifiers());
Argyrios Kyrtzidis442dd802012-07-02 19:19:01 +00005480
Richard Smith2095ffe2015-03-16 20:11:03 +00005481 TypeIdxMap::const_iterator I = TypeIdxs.find(T);
5482 assert(I != TypeIdxs.end() && "Type not emitted!");
5483 return I->second;
5484 });
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005485}
5486
Argyrios Kyrtzidis65ad5692010-10-24 17:26:36 +00005487void ASTWriter::AddDeclRef(const Decl *D, RecordDataImpl &Record) {
Sebastian Redl66c5eef2010-07-27 00:17:23 +00005488 Record.push_back(GetDeclRef(D));
5489}
5490
Sebastian Redl539c5062010-08-18 23:57:32 +00005491DeclID ASTWriter::GetDeclRef(const Decl *D) {
Douglas Gregor2fd3d402011-09-17 00:05:03 +00005492 assert(WritingAST && "Cannot request a declaration ID before AST writing");
Craig Toppera13603a2014-05-22 05:54:18 +00005493
5494 if (!D) {
Sebastian Redl66c5eef2010-07-27 00:17:23 +00005495 return 0;
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005496 }
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00005497
Douglas Gregorb3163e52012-01-05 22:33:30 +00005498 // If D comes from an AST file, its declaration ID is already known and
5499 // fixed.
5500 if (D->isFromASTFile())
5501 return D->getGlobalID();
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00005502
Douglas Gregor9b3932c2010-10-05 18:37:06 +00005503 assert(!(reinterpret_cast<uintptr_t>(D) & 0x01) && "Invalid decl pointer");
Sebastian Redl539c5062010-08-18 23:57:32 +00005504 DeclID &ID = DeclIDs[D];
Mike Stump11289f42009-09-09 15:08:12 +00005505 if (ID == 0) {
Argyrios Kyrtzidis442dd802012-07-02 19:19:01 +00005506 if (DoneWritingDeclsAndTypes) {
5507 assert(0 && "New decl seen after serializing all the decls to emit!");
5508 return 0;
5509 }
5510
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005511 // We haven't seen this declaration before. Give it a new ID and
5512 // enqueue it in the list of declarations to emit.
Sebastian Redlff4a2952010-07-23 23:49:55 +00005513 ID = NextDeclID++;
Douglas Gregor12bfa382009-10-17 00:13:19 +00005514 DeclTypesToEmit.push(const_cast<Decl *>(D));
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005515 }
5516
Sebastian Redl66c5eef2010-07-27 00:17:23 +00005517 return ID;
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005518}
5519
Sebastian Redl539c5062010-08-18 23:57:32 +00005520DeclID ASTWriter::getDeclID(const Decl *D) {
Craig Toppera13603a2014-05-22 05:54:18 +00005521 if (!D)
Douglas Gregore84a9da2009-04-20 20:36:09 +00005522 return 0;
5523
Douglas Gregorb3163e52012-01-05 22:33:30 +00005524 // If D comes from an AST file, its declaration ID is already known and
5525 // fixed.
5526 if (D->isFromASTFile())
5527 return D->getGlobalID();
5528
Douglas Gregore84a9da2009-04-20 20:36:09 +00005529 assert(DeclIDs.find(D) != DeclIDs.end() && "Declaration not emitted!");
5530 return DeclIDs[D];
5531}
5532
Argyrios Kyrtzidisdf53da82011-10-28 23:57:43 +00005533void ASTWriter::associateDeclWithFile(const Decl *D, DeclID ID) {
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005534 assert(ID);
Argyrios Kyrtzidisdf53da82011-10-28 23:57:43 +00005535 assert(D);
5536
5537 SourceLocation Loc = D->getLocation();
5538 if (Loc.isInvalid())
5539 return;
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005540
5541 // We only keep track of the file-level declarations of each file.
5542 if (!D->getLexicalDeclContext()->isFileContext())
5543 return;
Argyrios Kyrtzidise1bc99e2012-02-24 19:45:46 +00005544 // FIXME: ParmVarDecls that are part of a function type of a parameter of
5545 // a function/objc method, should not have TU as lexical context.
Argyrios Kyrtzidis71b74eb2018-01-26 19:26:12 +00005546 // TemplateTemplateParmDecls that are part of an alias template, should not
5547 // have TU as lexical context.
5548 if (isa<ParmVarDecl>(D) || isa<TemplateTemplateParmDecl>(D))
Argyrios Kyrtzidisffe055a82012-02-24 01:12:38 +00005549 return;
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005550
5551 SourceManager &SM = Context->getSourceManager();
Argyrios Kyrtzidisdf53da82011-10-28 23:57:43 +00005552 SourceLocation FileLoc = SM.getFileLoc(Loc);
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005553 assert(SM.isLocalSourceLocation(FileLoc));
Argyrios Kyrtzidis7362e9b2011-10-28 23:57:47 +00005554 FileID FID;
5555 unsigned Offset;
Benjamin Kramer867ea1d2014-03-02 13:01:17 +00005556 std::tie(FID, Offset) = SM.getDecomposedLoc(FileLoc);
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005557 if (FID.isInvalid())
5558 return;
Argyrios Kyrtzidis4db774a2012-10-02 21:09:17 +00005559 assert(SM.getSLocEntry(FID).isFile());
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005560
Argyrios Kyrtzidis4db774a2012-10-02 21:09:17 +00005561 DeclIDInFileInfo *&Info = FileDeclIDs[FID];
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005562 if (!Info)
5563 Info = new DeclIDInFileInfo();
5564
Argyrios Kyrtzidis7362e9b2011-10-28 23:57:47 +00005565 std::pair<unsigned, serialization::DeclID> LocDecl(Offset, ID);
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005566 LocDeclIDsTy &Decls = Info->DeclIDs;
5567
Argyrios Kyrtzidis7362e9b2011-10-28 23:57:47 +00005568 if (Decls.empty() || Decls.back().first <= Offset) {
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005569 Decls.push_back(LocDecl);
5570 return;
5571 }
5572
Benjamin Kramer45025c02013-08-24 13:22:59 +00005573 LocDeclIDsTy::iterator I =
5574 std::upper_bound(Decls.begin(), Decls.end(), LocDecl, llvm::less_first());
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005575
5576 Decls.insert(I, LocDecl);
5577}
5578
Richard Smithe64e7452016-04-18 21:54:58 +00005579void ASTRecordWriter::AddDeclarationName(DeclarationName Name) {
Chris Lattner258172e2009-04-27 07:35:58 +00005580 // FIXME: Emit a stable enum for NameKind. 0 = Identifier etc.
Richard Smithe64e7452016-04-18 21:54:58 +00005581 Record->push_back(Name.getNameKind());
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005582 switch (Name.getNameKind()) {
5583 case DeclarationName::Identifier:
Richard Smithe64e7452016-04-18 21:54:58 +00005584 AddIdentifierRef(Name.getAsIdentifierInfo());
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005585 break;
5586
5587 case DeclarationName::ObjCZeroArgSelector:
5588 case DeclarationName::ObjCOneArgSelector:
5589 case DeclarationName::ObjCMultiArgSelector:
Richard Smithe64e7452016-04-18 21:54:58 +00005590 AddSelectorRef(Name.getObjCSelector());
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005591 break;
5592
5593 case DeclarationName::CXXConstructorName:
5594 case DeclarationName::CXXDestructorName:
5595 case DeclarationName::CXXConversionFunctionName:
Richard Smithe64e7452016-04-18 21:54:58 +00005596 AddTypeRef(Name.getCXXNameType());
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005597 break;
5598
Richard Smith35845152017-02-07 01:37:30 +00005599 case DeclarationName::CXXDeductionGuideName:
5600 AddDeclRef(Name.getCXXDeductionGuideTemplate());
5601 break;
5602
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005603 case DeclarationName::CXXOperatorName:
Richard Smithe64e7452016-04-18 21:54:58 +00005604 Record->push_back(Name.getCXXOverloadedOperator());
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005605 break;
5606
Alexis Hunt3d221f22009-11-29 07:34:05 +00005607 case DeclarationName::CXXLiteralOperatorName:
Richard Smithe64e7452016-04-18 21:54:58 +00005608 AddIdentifierRef(Name.getCXXLiteralIdentifier());
Alexis Hunt3d221f22009-11-29 07:34:05 +00005609 break;
5610
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005611 case DeclarationName::CXXUsingDirective:
5612 // No extra data to emit
5613 break;
5614 }
5615}
Chris Lattnerca025db2010-05-07 21:43:38 +00005616
Richard Smithd08aeb62014-08-28 01:33:39 +00005617unsigned ASTWriter::getAnonymousDeclarationNumber(const NamedDecl *D) {
5618 assert(needsAnonymousDeclarationNumber(D) &&
5619 "expected an anonymous declaration");
5620
5621 // Number the anonymous declarations within this context, if we've not
5622 // already done so.
5623 auto It = AnonymousDeclarationNumbers.find(D);
5624 if (It == AnonymousDeclarationNumbers.end()) {
Richard Smith2b560572015-02-07 03:11:11 +00005625 auto *DC = D->getLexicalDeclContext();
5626 numberAnonymousDeclsWithin(DC, [&](const NamedDecl *ND, unsigned Number) {
5627 AnonymousDeclarationNumbers[ND] = Number;
5628 });
Richard Smithd08aeb62014-08-28 01:33:39 +00005629
5630 It = AnonymousDeclarationNumbers.find(D);
5631 assert(It != AnonymousDeclarationNumbers.end() &&
5632 "declaration not found within its lexical context");
5633 }
5634
5635 return It->second;
5636}
5637
Richard Smith290d8012016-04-06 17:06:00 +00005638void ASTRecordWriter::AddDeclarationNameLoc(const DeclarationNameLoc &DNLoc,
5639 DeclarationName Name) {
Argyrios Kyrtzidis434383d2010-10-15 18:21:24 +00005640 switch (Name.getNameKind()) {
5641 case DeclarationName::CXXConstructorName:
5642 case DeclarationName::CXXDestructorName:
5643 case DeclarationName::CXXConversionFunctionName:
Richard Smith290d8012016-04-06 17:06:00 +00005644 AddTypeSourceInfo(DNLoc.NamedType.TInfo);
Argyrios Kyrtzidis434383d2010-10-15 18:21:24 +00005645 break;
5646
5647 case DeclarationName::CXXOperatorName:
Richard Smith290d8012016-04-06 17:06:00 +00005648 AddSourceLocation(SourceLocation::getFromRawEncoding(
5649 DNLoc.CXXOperatorName.BeginOpNameLoc));
Argyrios Kyrtzidis434383d2010-10-15 18:21:24 +00005650 AddSourceLocation(
Richard Smith290d8012016-04-06 17:06:00 +00005651 SourceLocation::getFromRawEncoding(DNLoc.CXXOperatorName.EndOpNameLoc));
Argyrios Kyrtzidis434383d2010-10-15 18:21:24 +00005652 break;
5653
5654 case DeclarationName::CXXLiteralOperatorName:
Richard Smith290d8012016-04-06 17:06:00 +00005655 AddSourceLocation(SourceLocation::getFromRawEncoding(
5656 DNLoc.CXXLiteralOperatorName.OpNameLoc));
Argyrios Kyrtzidis434383d2010-10-15 18:21:24 +00005657 break;
5658
5659 case DeclarationName::Identifier:
5660 case DeclarationName::ObjCZeroArgSelector:
5661 case DeclarationName::ObjCOneArgSelector:
5662 case DeclarationName::ObjCMultiArgSelector:
5663 case DeclarationName::CXXUsingDirective:
Richard Smith35845152017-02-07 01:37:30 +00005664 case DeclarationName::CXXDeductionGuideName:
Argyrios Kyrtzidis434383d2010-10-15 18:21:24 +00005665 break;
5666 }
5667}
5668
Richard Smith290d8012016-04-06 17:06:00 +00005669void ASTRecordWriter::AddDeclarationNameInfo(
5670 const DeclarationNameInfo &NameInfo) {
5671 AddDeclarationName(NameInfo.getName());
5672 AddSourceLocation(NameInfo.getLoc());
5673 AddDeclarationNameLoc(NameInfo.getInfo(), NameInfo.getName());
Argyrios Kyrtzidis434383d2010-10-15 18:21:24 +00005674}
5675
Richard Smith290d8012016-04-06 17:06:00 +00005676void ASTRecordWriter::AddQualifierInfo(const QualifierInfo &Info) {
5677 AddNestedNameSpecifierLoc(Info.QualifierLoc);
5678 Record->push_back(Info.NumTemplParamLists);
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +00005679 for (unsigned i = 0, e = Info.NumTemplParamLists; i != e; ++i)
Richard Smith290d8012016-04-06 17:06:00 +00005680 AddTemplateParameterList(Info.TemplParamLists[i]);
Argyrios Kyrtzidis434383d2010-10-15 18:21:24 +00005681}
5682
Richard Smithe64e7452016-04-18 21:54:58 +00005683void ASTRecordWriter::AddNestedNameSpecifier(NestedNameSpecifier *NNS) {
Chris Lattnerca025db2010-05-07 21:43:38 +00005684 // Nested name specifiers usually aren't too long. I think that 8 would
Chris Lattner57540c52011-04-15 05:22:18 +00005685 // typically accommodate the vast majority.
Chris Lattner0e62c1c2011-07-23 10:55:15 +00005686 SmallVector<NestedNameSpecifier *, 8> NestedNames;
Chris Lattnerca025db2010-05-07 21:43:38 +00005687
5688 // Push each of the NNS's onto a stack for serialization in reverse order.
5689 while (NNS) {
5690 NestedNames.push_back(NNS);
5691 NNS = NNS->getPrefix();
5692 }
5693
Richard Smithe64e7452016-04-18 21:54:58 +00005694 Record->push_back(NestedNames.size());
Chris Lattnerca025db2010-05-07 21:43:38 +00005695 while(!NestedNames.empty()) {
5696 NNS = NestedNames.pop_back_val();
5697 NestedNameSpecifier::SpecifierKind Kind = NNS->getKind();
Richard Smithe64e7452016-04-18 21:54:58 +00005698 Record->push_back(Kind);
Chris Lattnerca025db2010-05-07 21:43:38 +00005699 switch (Kind) {
5700 case NestedNameSpecifier::Identifier:
Richard Smithe64e7452016-04-18 21:54:58 +00005701 AddIdentifierRef(NNS->getAsIdentifier());
Chris Lattnerca025db2010-05-07 21:43:38 +00005702 break;
5703
5704 case NestedNameSpecifier::Namespace:
Richard Smithe64e7452016-04-18 21:54:58 +00005705 AddDeclRef(NNS->getAsNamespace());
Chris Lattnerca025db2010-05-07 21:43:38 +00005706 break;
5707
Douglas Gregor7b26ff92011-02-24 02:36:08 +00005708 case NestedNameSpecifier::NamespaceAlias:
Richard Smithe64e7452016-04-18 21:54:58 +00005709 AddDeclRef(NNS->getAsNamespaceAlias());
Douglas Gregor7b26ff92011-02-24 02:36:08 +00005710 break;
5711
Chris Lattnerca025db2010-05-07 21:43:38 +00005712 case NestedNameSpecifier::TypeSpec:
5713 case NestedNameSpecifier::TypeSpecWithTemplate:
Richard Smithe64e7452016-04-18 21:54:58 +00005714 AddTypeRef(QualType(NNS->getAsType(), 0));
5715 Record->push_back(Kind == NestedNameSpecifier::TypeSpecWithTemplate);
Chris Lattnerca025db2010-05-07 21:43:38 +00005716 break;
5717
5718 case NestedNameSpecifier::Global:
5719 // Don't need to write an associated value.
5720 break;
Nikola Smiljanic67860242014-09-26 00:28:20 +00005721
5722 case NestedNameSpecifier::Super:
Richard Smithe64e7452016-04-18 21:54:58 +00005723 AddDeclRef(NNS->getAsRecordDecl());
Nikola Smiljanic67860242014-09-26 00:28:20 +00005724 break;
Chris Lattnerca025db2010-05-07 21:43:38 +00005725 }
5726 }
5727}
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005728
Richard Smith290d8012016-04-06 17:06:00 +00005729void ASTRecordWriter::AddNestedNameSpecifierLoc(NestedNameSpecifierLoc NNS) {
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005730 // Nested name specifiers usually aren't too long. I think that 8 would
Chris Lattner57540c52011-04-15 05:22:18 +00005731 // typically accommodate the vast majority.
Chris Lattner0e62c1c2011-07-23 10:55:15 +00005732 SmallVector<NestedNameSpecifierLoc , 8> NestedNames;
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005733
5734 // Push each of the nested-name-specifiers's onto a stack for
5735 // serialization in reverse order.
5736 while (NNS) {
5737 NestedNames.push_back(NNS);
5738 NNS = NNS.getPrefix();
5739 }
5740
Richard Smith290d8012016-04-06 17:06:00 +00005741 Record->push_back(NestedNames.size());
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005742 while(!NestedNames.empty()) {
5743 NNS = NestedNames.pop_back_val();
5744 NestedNameSpecifier::SpecifierKind Kind
5745 = NNS.getNestedNameSpecifier()->getKind();
Richard Smith290d8012016-04-06 17:06:00 +00005746 Record->push_back(Kind);
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005747 switch (Kind) {
5748 case NestedNameSpecifier::Identifier:
Richard Smith290d8012016-04-06 17:06:00 +00005749 AddIdentifierRef(NNS.getNestedNameSpecifier()->getAsIdentifier());
5750 AddSourceRange(NNS.getLocalSourceRange());
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005751 break;
5752
5753 case NestedNameSpecifier::Namespace:
Richard Smith290d8012016-04-06 17:06:00 +00005754 AddDeclRef(NNS.getNestedNameSpecifier()->getAsNamespace());
5755 AddSourceRange(NNS.getLocalSourceRange());
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005756 break;
5757
5758 case NestedNameSpecifier::NamespaceAlias:
Richard Smith290d8012016-04-06 17:06:00 +00005759 AddDeclRef(NNS.getNestedNameSpecifier()->getAsNamespaceAlias());
5760 AddSourceRange(NNS.getLocalSourceRange());
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005761 break;
5762
5763 case NestedNameSpecifier::TypeSpec:
5764 case NestedNameSpecifier::TypeSpecWithTemplate:
Richard Smith290d8012016-04-06 17:06:00 +00005765 Record->push_back(Kind == NestedNameSpecifier::TypeSpecWithTemplate);
5766 AddTypeLoc(NNS.getTypeLoc());
5767 AddSourceLocation(NNS.getLocalSourceRange().getEnd());
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005768 break;
5769
5770 case NestedNameSpecifier::Global:
Richard Smith290d8012016-04-06 17:06:00 +00005771 AddSourceLocation(NNS.getLocalSourceRange().getEnd());
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005772 break;
Nikola Smiljanic67860242014-09-26 00:28:20 +00005773
5774 case NestedNameSpecifier::Super:
Richard Smith290d8012016-04-06 17:06:00 +00005775 AddDeclRef(NNS.getNestedNameSpecifier()->getAsRecordDecl());
5776 AddSourceRange(NNS.getLocalSourceRange());
Nikola Smiljanic67860242014-09-26 00:28:20 +00005777 break;
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005778 }
5779 }
5780}
5781
Richard Smith290d8012016-04-06 17:06:00 +00005782void ASTRecordWriter::AddTemplateName(TemplateName Name) {
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00005783 TemplateName::NameKind Kind = Name.getKind();
Richard Smith290d8012016-04-06 17:06:00 +00005784 Record->push_back(Kind);
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005785 switch (Kind) {
5786 case TemplateName::Template:
Richard Smith290d8012016-04-06 17:06:00 +00005787 AddDeclRef(Name.getAsTemplateDecl());
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005788 break;
5789
5790 case TemplateName::OverloadedTemplate: {
5791 OverloadedTemplateStorage *OvT = Name.getAsOverloadedTemplate();
Richard Smith290d8012016-04-06 17:06:00 +00005792 Record->push_back(OvT->size());
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00005793 for (const auto &I : *OvT)
Richard Smith290d8012016-04-06 17:06:00 +00005794 AddDeclRef(I);
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005795 break;
5796 }
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00005797
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005798 case TemplateName::QualifiedTemplate: {
5799 QualifiedTemplateName *QualT = Name.getAsQualifiedTemplateName();
Richard Smith290d8012016-04-06 17:06:00 +00005800 AddNestedNameSpecifier(QualT->getQualifier());
5801 Record->push_back(QualT->hasTemplateKeyword());
5802 AddDeclRef(QualT->getTemplateDecl());
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005803 break;
5804 }
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00005805
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005806 case TemplateName::DependentTemplate: {
5807 DependentTemplateName *DepT = Name.getAsDependentTemplateName();
Richard Smith290d8012016-04-06 17:06:00 +00005808 AddNestedNameSpecifier(DepT->getQualifier());
5809 Record->push_back(DepT->isIdentifier());
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005810 if (DepT->isIdentifier())
Richard Smith290d8012016-04-06 17:06:00 +00005811 AddIdentifierRef(DepT->getIdentifier());
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005812 else
Richard Smith290d8012016-04-06 17:06:00 +00005813 Record->push_back(DepT->getOperator());
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005814 break;
5815 }
John McCalld9dfe3a2011-06-30 08:33:18 +00005816
5817 case TemplateName::SubstTemplateTemplateParm: {
5818 SubstTemplateTemplateParmStorage *subst
5819 = Name.getAsSubstTemplateTemplateParm();
Richard Smith290d8012016-04-06 17:06:00 +00005820 AddDeclRef(subst->getParameter());
5821 AddTemplateName(subst->getReplacement());
John McCalld9dfe3a2011-06-30 08:33:18 +00005822 break;
5823 }
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00005824
Douglas Gregor5590be02011-01-15 06:45:20 +00005825 case TemplateName::SubstTemplateTemplateParmPack: {
5826 SubstTemplateTemplateParmPackStorage *SubstPack
5827 = Name.getAsSubstTemplateTemplateParmPack();
Richard Smith290d8012016-04-06 17:06:00 +00005828 AddDeclRef(SubstPack->getParameterPack());
5829 AddTemplateArgument(SubstPack->getArgumentPack());
Douglas Gregor5590be02011-01-15 06:45:20 +00005830 break;
5831 }
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005832 }
5833}
5834
Richard Smith290d8012016-04-06 17:06:00 +00005835void ASTRecordWriter::AddTemplateArgument(const TemplateArgument &Arg) {
5836 Record->push_back(Arg.getKind());
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005837 switch (Arg.getKind()) {
5838 case TemplateArgument::Null:
5839 break;
5840 case TemplateArgument::Type:
Richard Smith290d8012016-04-06 17:06:00 +00005841 AddTypeRef(Arg.getAsType());
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005842 break;
5843 case TemplateArgument::Declaration:
Richard Smith290d8012016-04-06 17:06:00 +00005844 AddDeclRef(Arg.getAsDecl());
5845 AddTypeRef(Arg.getParamTypeForDecl());
Eli Friedmanb826a002012-09-26 02:36:12 +00005846 break;
5847 case TemplateArgument::NullPtr:
Richard Smith290d8012016-04-06 17:06:00 +00005848 AddTypeRef(Arg.getNullPtrType());
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005849 break;
5850 case TemplateArgument::Integral:
Richard Smith290d8012016-04-06 17:06:00 +00005851 AddAPSInt(Arg.getAsIntegral());
5852 AddTypeRef(Arg.getIntegralType());
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005853 break;
5854 case TemplateArgument::Template:
Richard Smith290d8012016-04-06 17:06:00 +00005855 AddTemplateName(Arg.getAsTemplateOrTemplatePattern());
Douglas Gregore1d60df2011-01-14 23:41:42 +00005856 break;
Douglas Gregore4ff4b52011-01-05 18:58:31 +00005857 case TemplateArgument::TemplateExpansion:
Richard Smith290d8012016-04-06 17:06:00 +00005858 AddTemplateName(Arg.getAsTemplateOrTemplatePattern());
David Blaikie05785d12013-02-20 22:23:23 +00005859 if (Optional<unsigned> NumExpansions = Arg.getNumTemplateExpansions())
Richard Smith290d8012016-04-06 17:06:00 +00005860 Record->push_back(*NumExpansions + 1);
Douglas Gregore1d60df2011-01-14 23:41:42 +00005861 else
Richard Smith290d8012016-04-06 17:06:00 +00005862 Record->push_back(0);
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005863 break;
5864 case TemplateArgument::Expression:
5865 AddStmt(Arg.getAsExpr());
5866 break;
5867 case TemplateArgument::Pack:
Richard Smith290d8012016-04-06 17:06:00 +00005868 Record->push_back(Arg.pack_size());
Aaron Ballman2a89e852014-07-15 21:32:31 +00005869 for (const auto &P : Arg.pack_elements())
Richard Smith290d8012016-04-06 17:06:00 +00005870 AddTemplateArgument(P);
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005871 break;
5872 }
5873}
Argyrios Kyrtzidis818c5db2010-06-23 13:48:30 +00005874
Richard Smithe64e7452016-04-18 21:54:58 +00005875void ASTRecordWriter::AddTemplateParameterList(
5876 const TemplateParameterList *TemplateParams) {
Argyrios Kyrtzidis818c5db2010-06-23 13:48:30 +00005877 assert(TemplateParams && "No TemplateParams!");
Richard Smithe64e7452016-04-18 21:54:58 +00005878 AddSourceLocation(TemplateParams->getTemplateLoc());
5879 AddSourceLocation(TemplateParams->getLAngleLoc());
5880 AddSourceLocation(TemplateParams->getRAngleLoc());
Hubert Tonge4a0c0e2016-07-30 22:33:34 +00005881 // TODO: Concepts
Richard Smithe64e7452016-04-18 21:54:58 +00005882 Record->push_back(TemplateParams->size());
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00005883 for (const auto &P : *TemplateParams)
Richard Smithe64e7452016-04-18 21:54:58 +00005884 AddDeclRef(P);
Argyrios Kyrtzidis818c5db2010-06-23 13:48:30 +00005885}
5886
5887/// \brief Emit a template argument list.
Richard Smith290d8012016-04-06 17:06:00 +00005888void ASTRecordWriter::AddTemplateArgumentList(
5889 const TemplateArgumentList *TemplateArgs) {
Argyrios Kyrtzidis818c5db2010-06-23 13:48:30 +00005890 assert(TemplateArgs && "No TemplateArgs!");
Richard Smith290d8012016-04-06 17:06:00 +00005891 Record->push_back(TemplateArgs->size());
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +00005892 for (int i = 0, e = TemplateArgs->size(); i != e; ++i)
Richard Smith290d8012016-04-06 17:06:00 +00005893 AddTemplateArgument(TemplateArgs->get(i));
Argyrios Kyrtzidis818c5db2010-06-23 13:48:30 +00005894}
Argyrios Kyrtzidis2c2167a2010-07-02 11:55:32 +00005895
Richard Smith290d8012016-04-06 17:06:00 +00005896void ASTRecordWriter::AddASTTemplateArgumentListInfo(
5897 const ASTTemplateArgumentListInfo *ASTTemplArgList) {
Enea Zaffanella6dbe1872013-08-10 07:24:53 +00005898 assert(ASTTemplArgList && "No ASTTemplArgList!");
Richard Smith290d8012016-04-06 17:06:00 +00005899 AddSourceLocation(ASTTemplArgList->LAngleLoc);
5900 AddSourceLocation(ASTTemplArgList->RAngleLoc);
5901 Record->push_back(ASTTemplArgList->NumTemplateArgs);
Enea Zaffanella6dbe1872013-08-10 07:24:53 +00005902 const TemplateArgumentLoc *TemplArgs = ASTTemplArgList->getTemplateArgs();
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +00005903 for (int i = 0, e = ASTTemplArgList->NumTemplateArgs; i != e; ++i)
Richard Smith290d8012016-04-06 17:06:00 +00005904 AddTemplateArgumentLoc(TemplArgs[i]);
Enea Zaffanella6dbe1872013-08-10 07:24:53 +00005905}
Argyrios Kyrtzidis2c2167a2010-07-02 11:55:32 +00005906
Richard Smithe64e7452016-04-18 21:54:58 +00005907void ASTRecordWriter::AddUnresolvedSet(const ASTUnresolvedSet &Set) {
5908 Record->push_back(Set.size());
Argyrios Kyrtzidis0f05fb92012-11-28 03:56:16 +00005909 for (ASTUnresolvedSet::const_iterator
Argyrios Kyrtzidis2c2167a2010-07-02 11:55:32 +00005910 I = Set.begin(), E = Set.end(); I != E; ++I) {
Richard Smithe64e7452016-04-18 21:54:58 +00005911 AddDeclRef(I.getDecl());
5912 Record->push_back(I.getAccess());
Argyrios Kyrtzidis2c2167a2010-07-02 11:55:32 +00005913 }
5914}
Argyrios Kyrtzidis3701fcd2010-07-02 23:30:27 +00005915
Richard Smith290d8012016-04-06 17:06:00 +00005916// FIXME: Move this out of the main ASTRecordWriter interface.
5917void ASTRecordWriter::AddCXXBaseSpecifier(const CXXBaseSpecifier &Base) {
5918 Record->push_back(Base.isVirtual());
5919 Record->push_back(Base.isBaseOfClass());
5920 Record->push_back(Base.getAccessSpecifierAsWritten());
5921 Record->push_back(Base.getInheritConstructors());
5922 AddTypeSourceInfo(Base.getTypeSourceInfo());
5923 AddSourceRange(Base.getSourceRange());
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00005924 AddSourceLocation(Base.isPackExpansion()? Base.getEllipsisLoc()
Richard Smith290d8012016-04-06 17:06:00 +00005925 : SourceLocation());
Argyrios Kyrtzidis3701fcd2010-07-02 23:30:27 +00005926}
Sebastian Redl85b2a6a2010-07-14 23:45:08 +00005927
Richard Smith645d2cf2016-04-14 00:29:55 +00005928static uint64_t EmitCXXBaseSpecifiers(ASTWriter &W,
5929 ArrayRef<CXXBaseSpecifier> Bases) {
5930 ASTWriter::RecordData Record;
5931 ASTRecordWriter Writer(W, Record);
5932 Writer.push_back(Bases.size());
Dmitry Polukhin790b5402016-04-06 10:01:46 +00005933
Richard Smith645d2cf2016-04-14 00:29:55 +00005934 for (auto &Base : Bases)
5935 Writer.AddCXXBaseSpecifier(Base);
Richard Smith290d8012016-04-06 17:06:00 +00005936
Richard Smith645d2cf2016-04-14 00:29:55 +00005937 return Writer.Emit(serialization::DECL_CXX_BASE_SPECIFIERS);
Douglas Gregord4c5ed02010-10-29 22:39:52 +00005938}
5939
Richard Smith290d8012016-04-06 17:06:00 +00005940// FIXME: Move this out of the main ASTRecordWriter interface.
Richard Smith645d2cf2016-04-14 00:29:55 +00005941void ASTRecordWriter::AddCXXBaseSpecifiers(ArrayRef<CXXBaseSpecifier> Bases) {
5942 AddOffset(EmitCXXBaseSpecifiers(*Writer, Bases));
5943}
5944
Richard Smithaa165cf2016-04-13 21:57:08 +00005945static uint64_t
5946EmitCXXCtorInitializers(ASTWriter &W,
5947 ArrayRef<CXXCtorInitializer *> CtorInits) {
5948 ASTWriter::RecordData Record;
5949 ASTRecordWriter Writer(W, Record);
5950 Writer.push_back(CtorInits.size());
Argyrios Kyrtzidis5b6a03f2010-08-09 10:54:12 +00005951
Richard Smithaa165cf2016-04-13 21:57:08 +00005952 for (auto *Init : CtorInits) {
Argyrios Kyrtzidis5b6a03f2010-08-09 10:54:12 +00005953 if (Init->isBaseInitializer()) {
Richard Smithaa165cf2016-04-13 21:57:08 +00005954 Writer.push_back(CTOR_INITIALIZER_BASE);
5955 Writer.AddTypeSourceInfo(Init->getTypeSourceInfo());
5956 Writer.push_back(Init->isBaseVirtual());
Alexis Hunt37a477f2011-05-04 01:19:08 +00005957 } else if (Init->isDelegatingInitializer()) {
Richard Smithaa165cf2016-04-13 21:57:08 +00005958 Writer.push_back(CTOR_INITIALIZER_DELEGATING);
5959 Writer.AddTypeSourceInfo(Init->getTypeSourceInfo());
Alexis Hunt37a477f2011-05-04 01:19:08 +00005960 } else if (Init->isMemberInitializer()){
Richard Smithaa165cf2016-04-13 21:57:08 +00005961 Writer.push_back(CTOR_INITIALIZER_MEMBER);
5962 Writer.AddDeclRef(Init->getMember());
Argyrios Kyrtzidis5b6a03f2010-08-09 10:54:12 +00005963 } else {
Richard Smithaa165cf2016-04-13 21:57:08 +00005964 Writer.push_back(CTOR_INITIALIZER_INDIRECT_MEMBER);
5965 Writer.AddDeclRef(Init->getIndirectMember());
Argyrios Kyrtzidis5b6a03f2010-08-09 10:54:12 +00005966 }
Francois Pichetd583da02010-12-04 09:14:42 +00005967
Richard Smithaa165cf2016-04-13 21:57:08 +00005968 Writer.AddSourceLocation(Init->getMemberLocation());
5969 Writer.AddStmt(Init->getInit());
5970 Writer.AddSourceLocation(Init->getLParenLoc());
5971 Writer.AddSourceLocation(Init->getRParenLoc());
5972 Writer.push_back(Init->isWritten());
Richard Smith30e304e2016-12-14 00:03:17 +00005973 if (Init->isWritten())
Richard Smithaa165cf2016-04-13 21:57:08 +00005974 Writer.push_back(Init->getSourceOrder());
Argyrios Kyrtzidis5b6a03f2010-08-09 10:54:12 +00005975 }
Richard Smithaa165cf2016-04-13 21:57:08 +00005976
5977 return Writer.Emit(serialization::DECL_CXX_CTOR_INITIALIZERS);
Argyrios Kyrtzidis5b6a03f2010-08-09 10:54:12 +00005978}
5979
Richard Smithaa165cf2016-04-13 21:57:08 +00005980// FIXME: Move this out of the main ASTRecordWriter interface.
5981void ASTRecordWriter::AddCXXCtorInitializers(
5982 ArrayRef<CXXCtorInitializer *> CtorInits) {
5983 AddOffset(EmitCXXCtorInitializers(*Writer, CtorInits));
Richard Smithc2bb8182015-03-24 06:36:48 +00005984}
5985
Richard Smith290d8012016-04-06 17:06:00 +00005986void ASTRecordWriter::AddCXXDefinitionData(const CXXRecordDecl *D) {
Richard Smith053f6c62014-05-16 23:01:30 +00005987 auto &Data = D->data();
Richard Smith290d8012016-04-06 17:06:00 +00005988 Record->push_back(Data.IsLambda);
5989 Record->push_back(Data.UserDeclaredConstructor);
5990 Record->push_back(Data.UserDeclaredSpecialMembers);
5991 Record->push_back(Data.Aggregate);
5992 Record->push_back(Data.PlainOldData);
5993 Record->push_back(Data.Empty);
5994 Record->push_back(Data.Polymorphic);
5995 Record->push_back(Data.Abstract);
5996 Record->push_back(Data.IsStandardLayout);
5997 Record->push_back(Data.HasNoNonEmptyBases);
5998 Record->push_back(Data.HasPrivateFields);
5999 Record->push_back(Data.HasProtectedFields);
6000 Record->push_back(Data.HasPublicFields);
6001 Record->push_back(Data.HasMutableFields);
6002 Record->push_back(Data.HasVariantMembers);
6003 Record->push_back(Data.HasOnlyCMembers);
6004 Record->push_back(Data.HasInClassInitializer);
6005 Record->push_back(Data.HasUninitializedReferenceMember);
6006 Record->push_back(Data.HasUninitializedFields);
Richard Smith12e79312016-05-13 06:47:56 +00006007 Record->push_back(Data.HasInheritedConstructor);
6008 Record->push_back(Data.HasInheritedAssignment);
Richard Smith96cd6712017-08-16 01:49:53 +00006009 Record->push_back(Data.NeedOverloadResolutionForCopyConstructor);
Richard Smith290d8012016-04-06 17:06:00 +00006010 Record->push_back(Data.NeedOverloadResolutionForMoveConstructor);
6011 Record->push_back(Data.NeedOverloadResolutionForMoveAssignment);
6012 Record->push_back(Data.NeedOverloadResolutionForDestructor);
Richard Smith96cd6712017-08-16 01:49:53 +00006013 Record->push_back(Data.DefaultedCopyConstructorIsDeleted);
Richard Smith290d8012016-04-06 17:06:00 +00006014 Record->push_back(Data.DefaultedMoveConstructorIsDeleted);
6015 Record->push_back(Data.DefaultedMoveAssignmentIsDeleted);
6016 Record->push_back(Data.DefaultedDestructorIsDeleted);
6017 Record->push_back(Data.HasTrivialSpecialMembers);
Akira Hatanaka02914dc2018-02-05 20:23:22 +00006018 Record->push_back(Data.HasTrivialSpecialMembersForCall);
Richard Smith290d8012016-04-06 17:06:00 +00006019 Record->push_back(Data.DeclaredNonTrivialSpecialMembers);
Akira Hatanaka02914dc2018-02-05 20:23:22 +00006020 Record->push_back(Data.DeclaredNonTrivialSpecialMembersForCall);
Richard Smith290d8012016-04-06 17:06:00 +00006021 Record->push_back(Data.HasIrrelevantDestructor);
6022 Record->push_back(Data.HasConstexprNonCopyMoveConstructor);
6023 Record->push_back(Data.HasDefaultedDefaultConstructor);
6024 Record->push_back(Data.DefaultedDefaultConstructorIsConstexpr);
6025 Record->push_back(Data.HasConstexprDefaultConstructor);
6026 Record->push_back(Data.HasNonLiteralTypeFieldsOrBases);
6027 Record->push_back(Data.ComputedVisibleConversions);
6028 Record->push_back(Data.UserProvidedDefaultConstructor);
6029 Record->push_back(Data.DeclaredSpecialMembers);
Richard Smithdf054d32017-02-25 23:53:05 +00006030 Record->push_back(Data.ImplicitCopyConstructorCanHaveConstParamForVBase);
6031 Record->push_back(Data.ImplicitCopyConstructorCanHaveConstParamForNonVBase);
Richard Smith290d8012016-04-06 17:06:00 +00006032 Record->push_back(Data.ImplicitCopyAssignmentHasConstParam);
6033 Record->push_back(Data.HasDeclaredCopyConstructorWithConstParam);
6034 Record->push_back(Data.HasDeclaredCopyAssignmentWithConstParam);
Richard Trieufd1acbb2017-04-11 21:31:00 +00006035
6036 // getODRHash will compute the ODRHash if it has not been previously computed.
6037 Record->push_back(D->getODRHash());
David Blaikief63556d2017-04-12 20:58:33 +00006038 bool ModulesDebugInfo = Writer->Context->getLangOpts().ModulesDebugInfo &&
6039 Writer->WritingModule && !D->isDependentType();
6040 Record->push_back(ModulesDebugInfo);
6041 if (ModulesDebugInfo)
David Blaikie1ac9c982017-04-11 21:13:37 +00006042 Writer->ModularCodegenDecls.push_back(Writer->GetDeclRef(D));
6043
Richard Smith561fb152012-02-25 07:33:38 +00006044 // IsLambda bit is already saved.
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00006045
Richard Smith290d8012016-04-06 17:06:00 +00006046 Record->push_back(Data.NumBases);
Douglas Gregord4c5ed02010-10-29 22:39:52 +00006047 if (Data.NumBases > 0)
Richard Smith645d2cf2016-04-14 00:29:55 +00006048 AddCXXBaseSpecifiers(Data.bases());
6049
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00006050 // FIXME: Make VBases lazily computed when needed to avoid storing them.
Richard Smith290d8012016-04-06 17:06:00 +00006051 Record->push_back(Data.NumVBases);
Douglas Gregord4c5ed02010-10-29 22:39:52 +00006052 if (Data.NumVBases > 0)
Richard Smith645d2cf2016-04-14 00:29:55 +00006053 AddCXXBaseSpecifiers(Data.vbases());
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00006054
Richard Smith290d8012016-04-06 17:06:00 +00006055 AddUnresolvedSet(Data.Conversions.get(*Writer->Context));
6056 AddUnresolvedSet(Data.VisibleConversions.get(*Writer->Context));
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00006057 // Data.Definition is the owning decl, no need to write it.
Richard Smith290d8012016-04-06 17:06:00 +00006058 AddDeclRef(D->getFirstFriend());
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00006059
Douglas Gregor99ae8062012-02-14 17:54:36 +00006060 // Add lambda-specific data.
6061 if (Data.IsLambda) {
Richard Smith053f6c62014-05-16 23:01:30 +00006062 auto &Lambda = D->getLambdaData();
Richard Smith290d8012016-04-06 17:06:00 +00006063 Record->push_back(Lambda.Dependent);
6064 Record->push_back(Lambda.IsGenericLambda);
6065 Record->push_back(Lambda.CaptureDefault);
6066 Record->push_back(Lambda.NumCaptures);
6067 Record->push_back(Lambda.NumExplicitCaptures);
6068 Record->push_back(Lambda.ManglingNumber);
Richard Smith0bae6242016-08-25 00:34:00 +00006069 AddDeclRef(D->getLambdaContextDecl());
Richard Smith290d8012016-04-06 17:06:00 +00006070 AddTypeSourceInfo(Lambda.MethodTyInfo);
Douglas Gregor99ae8062012-02-14 17:54:36 +00006071 for (unsigned I = 0, N = Lambda.NumCaptures; I != N; ++I) {
Benjamin Kramerf3ca26982014-05-10 16:31:55 +00006072 const LambdaCapture &Capture = Lambda.Captures[I];
Richard Smith290d8012016-04-06 17:06:00 +00006073 AddSourceLocation(Capture.getLocation());
6074 Record->push_back(Capture.isImplicit());
6075 Record->push_back(Capture.getCaptureKind());
Richard Smithba71c082013-05-16 06:20:58 +00006076 switch (Capture.getCaptureKind()) {
Faisal Validc6b5962016-03-21 09:25:37 +00006077 case LCK_StarThis:
Richard Smithba71c082013-05-16 06:20:58 +00006078 case LCK_This:
Alexey Bataev39c81e22014-08-28 04:28:19 +00006079 case LCK_VLAType:
Richard Smithba71c082013-05-16 06:20:58 +00006080 break;
6081 case LCK_ByCopy:
Richard Smithbb13c9a2013-09-28 04:02:39 +00006082 case LCK_ByRef:
Richard Smithba71c082013-05-16 06:20:58 +00006083 VarDecl *Var =
Craig Toppera13603a2014-05-22 05:54:18 +00006084 Capture.capturesVariable() ? Capture.getCapturedVar() : nullptr;
Richard Smith290d8012016-04-06 17:06:00 +00006085 AddDeclRef(Var);
Richard Smithba71c082013-05-16 06:20:58 +00006086 AddSourceLocation(Capture.isPackExpansion() ? Capture.getEllipsisLoc()
Richard Smith290d8012016-04-06 17:06:00 +00006087 : SourceLocation());
Richard Smithba71c082013-05-16 06:20:58 +00006088 break;
6089 }
Douglas Gregor99ae8062012-02-14 17:54:36 +00006090 }
6091 }
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00006092}
6093
Argyrios Kyrtzidis65ad5692010-10-24 17:26:36 +00006094void ASTWriter::ReaderInitialized(ASTReader *Reader) {
Sebastian Redl07a89a82010-07-30 00:29:29 +00006095 assert(Reader && "Cannot remove chain");
Douglas Gregordf0c1512011-08-18 04:12:04 +00006096 assert((!Chain || Chain == Reader) && "Cannot replace chain");
Sebastian Redl07a89a82010-07-30 00:29:29 +00006097 assert(FirstDeclID == NextDeclID &&
6098 FirstTypeID == NextTypeID &&
6099 FirstIdentID == NextIdentID &&
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00006100 FirstMacroID == NextMacroID &&
Douglas Gregor253eefe2011-12-01 00:59:36 +00006101 FirstSubmoduleID == NextSubmoduleID &&
Sebastian Redld95a56e2010-08-04 18:21:41 +00006102 FirstSelectorID == NextSelectorID &&
Sebastian Redl07a89a82010-07-30 00:29:29 +00006103 "Setting chain after writing has started.");
Douglas Gregor925296b2011-07-19 16:10:42 +00006104
Sebastian Redl07a89a82010-07-30 00:29:29 +00006105 Chain = Reader;
Argyrios Kyrtzidis65ad5692010-10-24 17:26:36 +00006106
Richard Smith7f330cd2015-03-18 01:42:29 +00006107 // Note, this will get called multiple times, once one the reader starts up
6108 // and again each time it's done reading a PCH or module.
Douglas Gregordf0c1512011-08-18 04:12:04 +00006109 FirstDeclID = NUM_PREDEF_DECL_IDS + Chain->getTotalNumDecls();
6110 FirstTypeID = NUM_PREDEF_TYPE_IDS + Chain->getTotalNumTypes();
6111 FirstIdentID = NUM_PREDEF_IDENT_IDS + Chain->getTotalNumIdentifiers();
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00006112 FirstMacroID = NUM_PREDEF_MACRO_IDS + Chain->getTotalNumMacros();
Douglas Gregor253eefe2011-12-01 00:59:36 +00006113 FirstSubmoduleID = NUM_PREDEF_SUBMODULE_IDS + Chain->getTotalNumSubmodules();
Douglas Gregordf0c1512011-08-18 04:12:04 +00006114 FirstSelectorID = NUM_PREDEF_SELECTOR_IDS + Chain->getTotalNumSelectors();
Argyrios Kyrtzidis65ad5692010-10-24 17:26:36 +00006115 NextDeclID = FirstDeclID;
6116 NextTypeID = FirstTypeID;
6117 NextIdentID = FirstIdentID;
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00006118 NextMacroID = FirstMacroID;
Argyrios Kyrtzidis65ad5692010-10-24 17:26:36 +00006119 NextSelectorID = FirstSelectorID;
Douglas Gregor253eefe2011-12-01 00:59:36 +00006120 NextSubmoduleID = FirstSubmoduleID;
Sebastian Redl07a89a82010-07-30 00:29:29 +00006121}
6122
Sebastian Redl539c5062010-08-18 23:57:32 +00006123void ASTWriter::IdentifierRead(IdentID ID, IdentifierInfo *II) {
Douglas Gregor8d7edce2013-02-08 21:30:59 +00006124 // Always keep the highest ID. See \p TypeRead() for more information.
6125 IdentID &StoredID = IdentifierIDs[II];
6126 if (ID > StoredID)
6127 StoredID = ID;
Sebastian Redlff4a2952010-07-23 23:49:55 +00006128}
6129
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00006130void ASTWriter::MacroRead(serialization::MacroID ID, MacroInfo *MI) {
Douglas Gregor8d7edce2013-02-08 21:30:59 +00006131 // Always keep the highest ID. See \p TypeRead() for more information.
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00006132 MacroID &StoredID = MacroIDs[MI];
Douglas Gregor8d7edce2013-02-08 21:30:59 +00006133 if (ID > StoredID)
6134 StoredID = ID;
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00006135}
6136
Argyrios Kyrtzidisbb5c7eae2010-08-20 16:03:59 +00006137void ASTWriter::TypeRead(TypeIdx Idx, QualType T) {
Douglas Gregor9b3932c2010-10-05 18:37:06 +00006138 // Always take the highest-numbered type index. This copes with an interesting
6139 // case for chained AST writing where we schedule writing the type and then,
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00006140 // later, deserialize the type from another AST. In this case, we want to
Douglas Gregor9b3932c2010-10-05 18:37:06 +00006141 // keep the higher-numbered entry so that we can properly write it out to
6142 // the AST file.
6143 TypeIdx &StoredIdx = TypeIdxs[T];
6144 if (Idx.getIndex() >= StoredIdx.getIndex())
6145 StoredIdx = Idx;
Sebastian Redl85b2a6a2010-07-14 23:45:08 +00006146}
6147
Sebastian Redl539c5062010-08-18 23:57:32 +00006148void ASTWriter::SelectorRead(SelectorID ID, Selector S) {
Douglas Gregor8d7edce2013-02-08 21:30:59 +00006149 // Always keep the highest ID. See \p TypeRead() for more information.
6150 SelectorID &StoredID = SelectorIDs[S];
6151 if (ID > StoredID)
6152 StoredID = ID;
Sebastian Redl834bb972010-08-04 17:20:04 +00006153}
Douglas Gregor91096292010-10-02 19:29:26 +00006154
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00006155void ASTWriter::MacroDefinitionRead(serialization::PreprocessedEntityID ID,
Richard Smith66a81862015-05-04 02:25:31 +00006156 MacroDefinitionRecord *MD) {
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00006157 assert(MacroDefinitions.find(MD) == MacroDefinitions.end());
Douglas Gregor91096292010-10-02 19:29:26 +00006158 MacroDefinitions[MD] = ID;
6159}
Argyrios Kyrtzidisd170d842010-10-24 17:26:50 +00006160
Douglas Gregore37a85a2011-12-02 17:30:13 +00006161void ASTWriter::ModuleRead(serialization::SubmoduleID ID, Module *Mod) {
6162 assert(SubmoduleIDs.find(Mod) == SubmoduleIDs.end());
6163 SubmoduleIDs[Mod] = ID;
6164}
6165
Argyrios Kyrtzidisd170d842010-10-24 17:26:50 +00006166void ASTWriter::CompletedTagDefinition(const TagDecl *D) {
Vassil Vassilev19765fb2016-07-22 21:08:24 +00006167 if (Chain && Chain->isProcessingUpdateRecords()) return;
John McCallf937c022011-10-07 06:10:15 +00006168 assert(D->isCompleteDefinition());
Douglas Gregor2fd3d402011-09-17 00:05:03 +00006169 assert(!WritingAST && "Already writing the AST!");
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00006170 if (auto *RD = dyn_cast<CXXRecordDecl>(D)) {
Argyrios Kyrtzidisd170d842010-10-24 17:26:50 +00006171 // We are interested when a PCH decl is modified.
Douglas Gregorb3722e22011-09-09 23:01:35 +00006172 if (RD->isFromASTFile()) {
Argyrios Kyrtzidisd170d842010-10-24 17:26:50 +00006173 // A forward reference was mutated into a definition. Rewrite it.
6174 // FIXME: This happens during template instantiation, should we
6175 // have created a new definition decl instead ?
Richard Smithcd45dbc2014-04-19 03:48:30 +00006176 assert(isTemplateInstantiation(RD->getTemplateSpecializationKind()) &&
6177 "completed a tag from another module but not by instantiation?");
6178 DeclUpdates[RD].push_back(
6179 DeclUpdate(UPD_CXX_INSTANTIATED_CLASS_DEFINITION));
Argyrios Kyrtzidisd170d842010-10-24 17:26:50 +00006180 }
Argyrios Kyrtzidisd170d842010-10-24 17:26:50 +00006181 }
6182}
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00006183
Richard Smithf983f7f2015-10-13 00:23:25 +00006184static bool isImportedDeclContext(ASTReader *Chain, const Decl *D) {
6185 if (D->isFromASTFile())
6186 return true;
6187
Richard Smithf983f7f2015-10-13 00:23:25 +00006188 // The predefined __va_list_tag struct is imported if we imported any decls.
6189 // FIXME: This is a gross hack.
6190 return D == D->getASTContext().getVaListTagDecl();
6191}
6192
Argyrios Kyrtzidis01c2df42010-10-28 07:38:51 +00006193void ASTWriter::AddedVisibleDecl(const DeclContext *DC, const Decl *D) {
Vassil Vassilev19765fb2016-07-22 21:08:24 +00006194 if (Chain && Chain->isProcessingUpdateRecords()) return;
6195 assert(DC->isLookupContext() &&
Vassil Vassilev71eafde2016-04-06 20:56:03 +00006196 "Should not add lookup results to non-lookup contexts!");
6197
Vassil Vassilev632eac32016-03-16 11:17:04 +00006198 // TU is handled elsewhere.
6199 if (isa<TranslationUnitDecl>(DC))
6200 return;
6201
6202 // Namespaces are handled elsewhere, except for template instantiations of
6203 // FunctionTemplateDecls in namespaces. We are interested in cases where the
6204 // local instantiations are added to an imported context. Only happens when
6205 // adding ADL lookup candidates, for example templated friends.
6206 if (isa<NamespaceDecl>(DC) && D->getFriendObjectKind() == Decl::FOK_None &&
6207 !isa<FunctionTemplateDecl>(D))
Argyrios Kyrtzidis01c2df42010-10-28 07:38:51 +00006208 return;
6209
Richard Smithf983f7f2015-10-13 00:23:25 +00006210 // We're only interested in cases where a local declaration is added to an
6211 // imported context.
6212 if (D->isFromASTFile() || !isImportedDeclContext(Chain, cast<Decl>(DC)))
6213 return;
Argyrios Kyrtzidis01c2df42010-10-28 07:38:51 +00006214
Richard Smith0f4e2c42015-08-06 04:23:48 +00006215 assert(DC == DC->getPrimaryContext() && "added to non-primary context");
Douglas Gregor9f782892013-01-21 15:25:38 +00006216 assert(!getDefinitiveDeclContext(DC) && "DeclContext not definitive!");
Richard Smithe9a8bc32014-09-30 00:45:29 +00006217 assert(!WritingAST && "Already writing the AST!");
Richard Smithf983f7f2015-10-13 00:23:25 +00006218 if (UpdatedDeclContexts.insert(DC) && !cast<Decl>(DC)->isFromASTFile()) {
6219 // We're adding a visible declaration to a predefined decl context. Ensure
6220 // that we write out all of its lookup results so we don't get a nasty
6221 // surprise when we try to emit its lookup table.
6222 for (auto *Child : DC->decls())
Richard Smithc26d9742016-10-06 20:30:51 +00006223 DeclsToEmitEvenIfUnreferenced.push_back(Child);
Richard Smithf983f7f2015-10-13 00:23:25 +00006224 }
Richard Smithc26d9742016-10-06 20:30:51 +00006225 DeclsToEmitEvenIfUnreferenced.push_back(D);
Argyrios Kyrtzidis01c2df42010-10-28 07:38:51 +00006226}
Argyrios Kyrtzidise16a5302010-10-24 17:26:54 +00006227
6228void ASTWriter::AddedCXXImplicitMember(const CXXRecordDecl *RD, const Decl *D) {
Vassil Vassilev19765fb2016-07-22 21:08:24 +00006229 if (Chain && Chain->isProcessingUpdateRecords()) return;
Argyrios Kyrtzidise16a5302010-10-24 17:26:54 +00006230 assert(D->isImplicit());
Richard Smithf983f7f2015-10-13 00:23:25 +00006231
6232 // We're only interested in cases where a local declaration is added to an
6233 // imported context.
6234 if (D->isFromASTFile() || !isImportedDeclContext(Chain, RD))
6235 return;
6236
Argyrios Kyrtzidise16a5302010-10-24 17:26:54 +00006237 if (!isa<CXXMethodDecl>(D))
Richard Smithf983f7f2015-10-13 00:23:25 +00006238 return;
Argyrios Kyrtzidise16a5302010-10-24 17:26:54 +00006239
6240 // A decl coming from PCH was modified.
John McCallf937c022011-10-07 06:10:15 +00006241 assert(RD->isCompleteDefinition());
Richard Smithe9a8bc32014-09-30 00:45:29 +00006242 assert(!WritingAST && "Already writing the AST!");
Aaron Ballman4f45b712014-03-21 15:22:56 +00006243 DeclUpdates[RD].push_back(DeclUpdate(UPD_CXX_ADDED_IMPLICIT_MEMBER, D));
Argyrios Kyrtzidise16a5302010-10-24 17:26:54 +00006244}
Argyrios Kyrtzidis402dbbb2010-10-28 07:38:42 +00006245
Richard Smith564417a2014-03-20 21:47:22 +00006246void ASTWriter::ResolvedExceptionSpec(const FunctionDecl *FD) {
Vassil Vassilev19765fb2016-07-22 21:08:24 +00006247 if (Chain && Chain->isProcessingUpdateRecords()) return;
Richard Smith9e2341d2015-03-23 03:25:59 +00006248 assert(!DoneWritingDeclsAndTypes && "Already done writing updates!");
6249 if (!Chain) return;
Richard Smith5fc18a92015-07-12 23:43:21 +00006250 Chain->forEachImportedKeyDecl(FD, [&](const Decl *D) {
Richard Smith9e2341d2015-03-23 03:25:59 +00006251 // If we don't already know the exception specification for this redecl
6252 // chain, add an update record for it.
6253 if (isUnresolvedExceptionSpec(cast<FunctionDecl>(D)
6254 ->getType()
6255 ->castAs<FunctionProtoType>()
6256 ->getExceptionSpecType()))
6257 DeclUpdates[D].push_back(UPD_CXX_RESOLVED_EXCEPTION_SPEC);
6258 });
Richard Smith564417a2014-03-20 21:47:22 +00006259}
6260
Richard Smith1fa5d642013-05-11 05:45:24 +00006261void ASTWriter::DeducedReturnType(const FunctionDecl *FD, QualType ReturnType) {
Vassil Vassilev19765fb2016-07-22 21:08:24 +00006262 if (Chain && Chain->isProcessingUpdateRecords()) return;
Richard Smith1fa5d642013-05-11 05:45:24 +00006263 assert(!WritingAST && "Already writing the AST!");
Richard Smith9e2341d2015-03-23 03:25:59 +00006264 if (!Chain) return;
Richard Smith5fc18a92015-07-12 23:43:21 +00006265 Chain->forEachImportedKeyDecl(FD, [&](const Decl *D) {
Richard Smith9e2341d2015-03-23 03:25:59 +00006266 DeclUpdates[D].push_back(
6267 DeclUpdate(UPD_CXX_DEDUCED_RETURN_TYPE, ReturnType));
6268 });
Richard Smith1fa5d642013-05-11 05:45:24 +00006269}
6270
Richard Smithf8134002015-03-10 01:41:22 +00006271void ASTWriter::ResolvedOperatorDelete(const CXXDestructorDecl *DD,
Richard Smith5b349582017-10-13 01:55:36 +00006272 const FunctionDecl *Delete,
6273 Expr *ThisArg) {
Vassil Vassilev19765fb2016-07-22 21:08:24 +00006274 if (Chain && Chain->isProcessingUpdateRecords()) return;
Richard Smithf8134002015-03-10 01:41:22 +00006275 assert(!WritingAST && "Already writing the AST!");
6276 assert(Delete && "Not given an operator delete");
Richard Smith9e2341d2015-03-23 03:25:59 +00006277 if (!Chain) return;
Richard Smith5fc18a92015-07-12 23:43:21 +00006278 Chain->forEachImportedKeyDecl(DD, [&](const Decl *D) {
Richard Smith9e2341d2015-03-23 03:25:59 +00006279 DeclUpdates[D].push_back(DeclUpdate(UPD_CXX_RESOLVED_DTOR_DELETE, Delete));
6280 });
Richard Smithf8134002015-03-10 01:41:22 +00006281}
6282
Sebastian Redlab238a72011-04-24 16:28:06 +00006283void ASTWriter::CompletedImplicitDefinition(const FunctionDecl *D) {
Vassil Vassilev19765fb2016-07-22 21:08:24 +00006284 if (Chain && Chain->isProcessingUpdateRecords()) return;
Douglas Gregor2fd3d402011-09-17 00:05:03 +00006285 assert(!WritingAST && "Already writing the AST!");
Douglas Gregorb3722e22011-09-09 23:01:35 +00006286 if (!D->isFromASTFile())
Sebastian Redlab238a72011-04-24 16:28:06 +00006287 return; // Declaration not imported from PCH.
6288
Richard Smith4d235792014-08-07 18:53:08 +00006289 // Implicit function decl from a PCH was defined.
6290 DeclUpdates[D].push_back(DeclUpdate(UPD_CXX_ADDED_FUNCTION_DEFINITION));
Sebastian Redlab238a72011-04-24 16:28:06 +00006291}
6292
Richard Smith891fc7f2017-12-05 01:31:47 +00006293void ASTWriter::VariableDefinitionInstantiated(const VarDecl *D) {
6294 if (Chain && Chain->isProcessingUpdateRecords()) return;
6295 assert(!WritingAST && "Already writing the AST!");
6296 if (!D->isFromASTFile())
6297 return;
6298
6299 DeclUpdates[D].push_back(DeclUpdate(UPD_CXX_ADDED_VAR_DEFINITION));
6300}
6301
Richard Smithd28ac5b2014-03-22 23:33:22 +00006302void ASTWriter::FunctionDefinitionInstantiated(const FunctionDecl *D) {
Vassil Vassilev19765fb2016-07-22 21:08:24 +00006303 if (Chain && Chain->isProcessingUpdateRecords()) return;
Richard Smithd28ac5b2014-03-22 23:33:22 +00006304 assert(!WritingAST && "Already writing the AST!");
6305 if (!D->isFromASTFile())
6306 return;
6307
Richard Smith9e2341d2015-03-23 03:25:59 +00006308 DeclUpdates[D].push_back(DeclUpdate(UPD_CXX_ADDED_FUNCTION_DEFINITION));
Richard Smithd28ac5b2014-03-22 23:33:22 +00006309}
6310
Richard Smith891fc7f2017-12-05 01:31:47 +00006311void ASTWriter::InstantiationRequested(const ValueDecl *D) {
Vassil Vassilev19765fb2016-07-22 21:08:24 +00006312 if (Chain && Chain->isProcessingUpdateRecords()) return;
Douglas Gregor2fd3d402011-09-17 00:05:03 +00006313 assert(!WritingAST && "Already writing the AST!");
Douglas Gregorb3722e22011-09-09 23:01:35 +00006314 if (!D->isFromASTFile())
Sebastian Redl2ac2c722011-04-29 08:19:30 +00006315 return;
6316
6317 // Since the actual instantiation is delayed, this really means that we need
6318 // to update the instantiation location.
Richard Smith891fc7f2017-12-05 01:31:47 +00006319 SourceLocation POI;
6320 if (auto *VD = dyn_cast<VarDecl>(D))
6321 POI = VD->getPointOfInstantiation();
6322 else
6323 POI = cast<FunctionDecl>(D)->getPointOfInstantiation();
6324 DeclUpdates[D].push_back(DeclUpdate(UPD_CXX_POINT_OF_INSTANTIATION, POI));
Sebastian Redl2ac2c722011-04-29 08:19:30 +00006325}
6326
John McCall32791cc2016-01-06 22:34:54 +00006327void ASTWriter::DefaultArgumentInstantiated(const ParmVarDecl *D) {
Vassil Vassilev19765fb2016-07-22 21:08:24 +00006328 if (Chain && Chain->isProcessingUpdateRecords()) return;
John McCall32791cc2016-01-06 22:34:54 +00006329 assert(!WritingAST && "Already writing the AST!");
6330 if (!D->isFromASTFile())
6331 return;
6332
6333 DeclUpdates[D].push_back(
6334 DeclUpdate(UPD_CXX_INSTANTIATED_DEFAULT_ARGUMENT, D));
6335}
6336
Richard Smith4b054b22016-08-24 21:25:37 +00006337void ASTWriter::DefaultMemberInitializerInstantiated(const FieldDecl *D) {
6338 assert(!WritingAST && "Already writing the AST!");
6339 if (!D->isFromASTFile())
6340 return;
6341
6342 DeclUpdates[D].push_back(
6343 DeclUpdate(UPD_CXX_INSTANTIATED_DEFAULT_MEMBER_INITIALIZER, D));
6344}
6345
Argyrios Kyrtzidis7d847c92011-09-01 00:58:55 +00006346void ASTWriter::AddedObjCCategoryToInterface(const ObjCCategoryDecl *CatD,
6347 const ObjCInterfaceDecl *IFD) {
Vassil Vassilev19765fb2016-07-22 21:08:24 +00006348 if (Chain && Chain->isProcessingUpdateRecords()) return;
Douglas Gregor2fd3d402011-09-17 00:05:03 +00006349 assert(!WritingAST && "Already writing the AST!");
Douglas Gregorb3722e22011-09-09 23:01:35 +00006350 if (!IFD->isFromASTFile())
Argyrios Kyrtzidis7d847c92011-09-01 00:58:55 +00006351 return; // Declaration not imported from PCH.
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00006352
Douglas Gregor404cdde2012-01-27 01:47:08 +00006353 assert(IFD->getDefinition() && "Category on a class without a definition?");
6354 ObjCClassesWithCategories.insert(
6355 const_cast<ObjCInterfaceDecl *>(IFD->getDefinition()));
Argyrios Kyrtzidis7d847c92011-09-01 00:58:55 +00006356}
Argyrios Kyrtzidisb97a4022011-11-12 21:07:46 +00006357
Eli Friedman276dd182013-09-05 00:02:25 +00006358void ASTWriter::DeclarationMarkedUsed(const Decl *D) {
Vassil Vassilev19765fb2016-07-22 21:08:24 +00006359 if (Chain && Chain->isProcessingUpdateRecords()) return;
Eli Friedman276dd182013-09-05 00:02:25 +00006360 assert(!WritingAST && "Already writing the AST!");
Vassil Vassilev928c8252016-04-28 14:13:28 +00006361
6362 // If there is *any* declaration of the entity that's not from an AST file,
6363 // we can skip writing the update record. We make sure that isUsed() triggers
6364 // completion of the redeclaration chain of the entity.
6365 for (auto Prev = D->getMostRecentDecl(); Prev; Prev = Prev->getPreviousDecl())
6366 if (IsLocalDecl(Prev))
6367 return;
Eli Friedman276dd182013-09-05 00:02:25 +00006368
Aaron Ballman4f45b712014-03-21 15:22:56 +00006369 DeclUpdates[D].push_back(DeclUpdate(UPD_DECL_MARKED_USED));
Eli Friedman276dd182013-09-05 00:02:25 +00006370}
Alexey Bataev97720002014-11-11 04:05:39 +00006371
6372void ASTWriter::DeclarationMarkedOpenMPThreadPrivate(const Decl *D) {
Vassil Vassilev19765fb2016-07-22 21:08:24 +00006373 if (Chain && Chain->isProcessingUpdateRecords()) return;
Alexey Bataev97720002014-11-11 04:05:39 +00006374 assert(!WritingAST && "Already writing the AST!");
6375 if (!D->isFromASTFile())
6376 return;
6377
6378 DeclUpdates[D].push_back(DeclUpdate(UPD_DECL_MARKED_OPENMP_THREADPRIVATE));
6379}
Richard Smith65ebb4a2015-03-26 04:09:53 +00006380
Dmitry Polukhind69b5052016-05-09 14:59:13 +00006381void ASTWriter::DeclarationMarkedOpenMPDeclareTarget(const Decl *D,
6382 const Attr *Attr) {
Vassil Vassilev19765fb2016-07-22 21:08:24 +00006383 if (Chain && Chain->isProcessingUpdateRecords()) return;
Dmitry Polukhin0b0da292016-04-06 11:38:59 +00006384 assert(!WritingAST && "Already writing the AST!");
6385 if (!D->isFromASTFile())
6386 return;
6387
Dmitry Polukhind69b5052016-05-09 14:59:13 +00006388 DeclUpdates[D].push_back(
6389 DeclUpdate(UPD_DECL_MARKED_OPENMP_DECLARETARGET, Attr));
Dmitry Polukhin0b0da292016-04-06 11:38:59 +00006390}
6391
Richard Smith4caa4492015-05-15 02:34:32 +00006392void ASTWriter::RedefinedHiddenDefinition(const NamedDecl *D, Module *M) {
Vassil Vassilev19765fb2016-07-22 21:08:24 +00006393 if (Chain && Chain->isProcessingUpdateRecords()) return;
Richard Smith65ebb4a2015-03-26 04:09:53 +00006394 assert(!WritingAST && "Already writing the AST!");
6395 assert(D->isHidden() && "expected a hidden declaration");
Richard Smith4caa4492015-05-15 02:34:32 +00006396 DeclUpdates[D].push_back(DeclUpdate(UPD_DECL_EXPORTED, M));
Richard Smith65ebb4a2015-03-26 04:09:53 +00006397}
Alex Denisovfde64952015-06-26 05:28:36 +00006398
6399void ASTWriter::AddedAttributeToRecord(const Attr *Attr,
6400 const RecordDecl *Record) {
Vassil Vassilev19765fb2016-07-22 21:08:24 +00006401 if (Chain && Chain->isProcessingUpdateRecords()) return;
Alex Denisovfde64952015-06-26 05:28:36 +00006402 assert(!WritingAST && "Already writing the AST!");
6403 if (!Record->isFromASTFile())
6404 return;
6405 DeclUpdates[Record].push_back(DeclUpdate(UPD_ADDED_ATTR_TO_RECORD, Attr));
6406}
Richard Smithc26d9742016-10-06 20:30:51 +00006407
6408void ASTWriter::AddedCXXTemplateSpecialization(
6409 const ClassTemplateDecl *TD, const ClassTemplateSpecializationDecl *D) {
6410 assert(!WritingAST && "Already writing the AST!");
6411
6412 if (!TD->getFirstDecl()->isFromASTFile())
6413 return;
6414 if (Chain && Chain->isProcessingUpdateRecords())
6415 return;
6416
6417 DeclsToEmitEvenIfUnreferenced.push_back(D);
6418}
6419
6420void ASTWriter::AddedCXXTemplateSpecialization(
6421 const VarTemplateDecl *TD, const VarTemplateSpecializationDecl *D) {
6422 assert(!WritingAST && "Already writing the AST!");
6423
6424 if (!TD->getFirstDecl()->isFromASTFile())
6425 return;
6426 if (Chain && Chain->isProcessingUpdateRecords())
6427 return;
6428
6429 DeclsToEmitEvenIfUnreferenced.push_back(D);
6430}
6431
6432void ASTWriter::AddedCXXTemplateSpecialization(const FunctionTemplateDecl *TD,
6433 const FunctionDecl *D) {
6434 assert(!WritingAST && "Already writing the AST!");
6435
6436 if (!TD->getFirstDecl()->isFromASTFile())
6437 return;
6438 if (Chain && Chain->isProcessingUpdateRecords())
6439 return;
6440
6441 DeclsToEmitEvenIfUnreferenced.push_back(D);
6442}