blob: 019042a1308a7324401e94636960ccb24e1e3158 [file] [log] [blame]
Eugene Zelenkob7d89102017-11-11 00:08:50 +00001//===- ASTWriter.cpp - AST File Writer ------------------------------------===//
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002//
Chandler Carruth2946cd72019-01-19 08:50:56 +00003// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
Douglas Gregoref84c4b2009-04-09 22:27:44 +00006//
7//===----------------------------------------------------------------------===//
8//
Sebastian Redl55c0ad52010-08-18 23:56:21 +00009// This file defines the ASTWriter class, which writes AST files.
Douglas Gregoref84c4b2009-04-09 22:27:44 +000010//
11//===----------------------------------------------------------------------===//
12
Sebastian Redl1914c6f2010-08-18 23:56:37 +000013#include "clang/Serialization/ASTWriter.h"
Argyrios Kyrtzidis4bd97102010-08-20 16:03:52 +000014#include "ASTCommon.h"
Richard Smithd88a7f12015-09-01 20:35:42 +000015#include "ASTReaderInternals.h"
16#include "MultiOnDiskHashTable.h"
Douglas Gregoref84c4b2009-04-09 22:27:44 +000017#include "clang/AST/ASTContext.h"
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +000018#include "clang/AST/ASTUnresolvedSet.h"
Eugene Zelenkob7d89102017-11-11 00:08:50 +000019#include "clang/AST/Attr.h"
Douglas Gregoref84c4b2009-04-09 22:27:44 +000020#include "clang/AST/Decl.h"
Eugene Zelenkob7d89102017-11-11 00:08:50 +000021#include "clang/AST/DeclBase.h"
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +000022#include "clang/AST/DeclCXX.h"
Duncan P. N. Exon Smith60fa2882017-03-13 18:45:08 +000023#include "clang/AST/DeclContextInternals.h"
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +000024#include "clang/AST/DeclFriend.h"
Eugene Zelenkob7d89102017-11-11 00:08:50 +000025#include "clang/AST/DeclObjC.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000026#include "clang/AST/DeclTemplate.h"
Eugene Zelenkob7d89102017-11-11 00:08:50 +000027#include "clang/AST/DeclarationName.h"
Douglas Gregorfeb84b02009-04-14 21:18:50 +000028#include "clang/AST/Expr.h"
John McCallbfd822c2010-08-24 07:32:53 +000029#include "clang/AST/ExprCXX.h"
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +000030#include "clang/AST/LambdaCapture.h"
31#include "clang/AST/NestedNameSpecifier.h"
32#include "clang/AST/RawCommentList.h"
33#include "clang/AST/TemplateName.h"
Douglas Gregoref84c4b2009-04-09 22:27:44 +000034#include "clang/AST/Type.h"
John McCall8f115c62009-10-16 21:56:05 +000035#include "clang/AST/TypeLocVisitor.h"
Eugene Zelenkob7d89102017-11-11 00:08:50 +000036#include "clang/Basic/Diagnostic.h"
Benjamin Kramerf3ca26982014-05-10 16:31:55 +000037#include "clang/Basic/DiagnosticOptions.h"
Douglas Gregora7f71a92009-04-10 03:52:48 +000038#include "clang/Basic/FileManager.h"
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +000039#include "clang/Basic/FileSystemOptions.h"
Eugene Zelenkob7d89102017-11-11 00:08:50 +000040#include "clang/Basic/IdentifierTable.h"
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +000041#include "clang/Basic/LLVM.h"
Eugene Zelenkob7d89102017-11-11 00:08:50 +000042#include "clang/Basic/Lambda.h"
Duncan P. N. Exon Smith60fa2882017-03-13 18:45:08 +000043#include "clang/Basic/LangOptions.h"
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +000044#include "clang/Basic/Module.h"
45#include "clang/Basic/ObjCRuntime.h"
Eugene Zelenkob7d89102017-11-11 00:08:50 +000046#include "clang/Basic/OpenCLOptions.h"
47#include "clang/Basic/SourceLocation.h"
Douglas Gregora7f71a92009-04-10 03:52:48 +000048#include "clang/Basic/SourceManager.h"
Douglas Gregor4c7626e2009-04-13 16:31:14 +000049#include "clang/Basic/SourceManagerInternals.h"
Eugene Zelenkob7d89102017-11-11 00:08:50 +000050#include "clang/Basic/Specifiers.h"
Douglas Gregorbfbde532009-04-10 21:16:55 +000051#include "clang/Basic/TargetInfo.h"
Douglas Gregorcb177f12012-10-16 23:40:58 +000052#include "clang/Basic/TargetOptions.h"
Douglas Gregor7b71e632009-04-27 22:23:34 +000053#include "clang/Basic/Version.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000054#include "clang/Lex/HeaderSearch.h"
55#include "clang/Lex/HeaderSearchOptions.h"
56#include "clang/Lex/MacroInfo.h"
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +000057#include "clang/Lex/ModuleMap.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000058#include "clang/Lex/PreprocessingRecord.h"
59#include "clang/Lex/Preprocessor.h"
60#include "clang/Lex/PreprocessorOptions.h"
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +000061#include "clang/Lex/Token.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000062#include "clang/Sema/IdentifierResolver.h"
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +000063#include "clang/Sema/ObjCMethodList.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000064#include "clang/Sema/Sema.h"
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +000065#include "clang/Sema/Weak.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000066#include "clang/Serialization/ASTReader.h"
Duncan P. N. Exon Smith8bef5cd2019-03-09 17:33:56 +000067#include "clang/Serialization/InMemoryModuleCache.h"
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +000068#include "clang/Serialization/Module.h"
Mehdi Amini9670f842016-07-18 19:02:11 +000069#include "clang/Serialization/ModuleFileExtension.h"
Richard Smithb5aaf5a2015-09-01 02:35:58 +000070#include "clang/Serialization/SerializationDiagnostic.h"
Douglas Gregore0a3a512009-04-14 21:55:33 +000071#include "llvm/ADT/APFloat.h"
72#include "llvm/ADT/APInt.h"
Eugene Zelenkob7d89102017-11-11 00:08:50 +000073#include "llvm/ADT/APSInt.h"
74#include "llvm/ADT/ArrayRef.h"
75#include "llvm/ADT/DenseMap.h"
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +000076#include "llvm/ADT/Hashing.h"
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +000077#include "llvm/ADT/Optional.h"
Eugene Zelenkob7d89102017-11-11 00:08:50 +000078#include "llvm/ADT/PointerIntPair.h"
Duncan P. N. Exon Smith60fa2882017-03-13 18:45:08 +000079#include "llvm/ADT/STLExtras.h"
Ilya Biryukov45643102018-07-09 11:33:23 +000080#include "llvm/ADT/ScopeExit.h"
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +000081#include "llvm/ADT/SmallSet.h"
82#include "llvm/ADT/SmallString.h"
Eugene Zelenkob7d89102017-11-11 00:08:50 +000083#include "llvm/ADT/SmallVector.h"
Eugene Zelenkob7d89102017-11-11 00:08:50 +000084#include "llvm/ADT/StringMap.h"
85#include "llvm/ADT/StringRef.h"
Francis Visoiu Mistrihe0308272019-07-03 22:40:07 +000086#include "llvm/Bitstream/BitCodes.h"
87#include "llvm/Bitstream/BitstreamWriter.h"
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +000088#include "llvm/Support/Casting.h"
Richard Smithaada85c2016-02-06 02:06:43 +000089#include "llvm/Support/Compression.h"
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +000090#include "llvm/Support/DJB.h"
Eugene Zelenkob7d89102017-11-11 00:08:50 +000091#include "llvm/Support/Endian.h"
Justin Bognere1c147c2014-03-28 22:03:19 +000092#include "llvm/Support/EndianStream.h"
George Rimarc39f5492017-01-17 15:45:31 +000093#include "llvm/Support/Error.h"
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +000094#include "llvm/Support/ErrorHandling.h"
Douglas Gregora7f71a92009-04-10 03:52:48 +000095#include "llvm/Support/MemoryBuffer.h"
Justin Bognerbb094f02014-04-18 19:57:06 +000096#include "llvm/Support/OnDiskHashTable.h"
Michael J. Spencer8aaf4992010-11-29 18:12:39 +000097#include "llvm/Support/Path.h"
Duncan P. N. Exon Smith60fa2882017-03-13 18:45:08 +000098#include "llvm/Support/SHA1.h"
Pavel Labathd8c62902018-06-11 10:28:04 +000099#include "llvm/Support/VersionTuple.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
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000141 /// Type code that corresponds to the record generated.
Eugene Zelenkob7d89102017-11-11 00:08:50 +0000142 TypeCode Code = static_cast<TypeCode>(0);
143
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000144 /// 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));
Richard Smitheaf11ad2018-05-03 03:58:32 +0000297 } else if (isComputedNoexcept(T->getExceptionSpecType())) {
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());
Anastasia Stulovac61eaa52019-01-28 11:37:49 +0000312 Record.push_back(T->getMethodQuals().getAsOpaqueValue());
Richard Smith564417a2014-03-20 21:47:22 +0000313 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
Anastasia Stulovac61eaa52019-01-28 11:37:49 +0000325 if (T->isVariadic() || T->hasTrailingReturn() || T->getMethodQuals() ||
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())
Richard Smithb2997f52019-05-21 20:10:50 +0000372 Record.push_back(T->containsUnexpandedParameterPack() ? 2 :
373 T->isDependentType() ? 1 : 0);
Richard Smith30482bc2011-02-20 03:19:35 +0000374 Code = TYPE_AUTO;
375}
376
Richard Smith600b5262017-01-26 20:40:47 +0000377void ASTTypeWriter::VisitDeducedTemplateSpecializationType(
378 const DeducedTemplateSpecializationType *T) {
379 Record.AddTemplateName(T->getTemplateName());
380 Record.AddTypeRef(T->getDeducedType());
381 if (T->getDeducedType().isNull())
382 Record.push_back(T->isDependentType());
383 Code = TYPE_DEDUCED_TEMPLATE_SPECIALIZATION;
384}
385
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000386void ASTTypeWriter::VisitTagType(const TagType *T) {
Argyrios Kyrtzidisa4ed1812010-07-08 13:09:53 +0000387 Record.push_back(T->isDependentType());
Richard Smith69c82bf2016-04-01 22:52:03 +0000388 Record.AddDeclRef(T->getDecl()->getCanonicalDecl());
Mike Stump11289f42009-09-09 15:08:12 +0000389 assert(!T->isBeingDefined() &&
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000390 "Cannot serialize in the middle of a type definition");
391}
392
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000393void ASTTypeWriter::VisitRecordType(const RecordType *T) {
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000394 VisitTagType(T);
Sebastian Redl539c5062010-08-18 23:57:32 +0000395 Code = TYPE_RECORD;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000396}
397
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000398void ASTTypeWriter::VisitEnumType(const EnumType *T) {
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000399 VisitTagType(T);
Sebastian Redl539c5062010-08-18 23:57:32 +0000400 Code = TYPE_ENUM;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000401}
402
John McCall81904512011-01-06 01:58:22 +0000403void ASTTypeWriter::VisitAttributedType(const AttributedType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000404 Record.AddTypeRef(T->getModifiedType());
405 Record.AddTypeRef(T->getEquivalentType());
John McCall81904512011-01-06 01:58:22 +0000406 Record.push_back(T->getAttrKind());
407 Code = TYPE_ATTRIBUTED;
408}
409
Mike Stump11289f42009-09-09 15:08:12 +0000410void
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000411ASTTypeWriter::VisitSubstTemplateTypeParmType(
John McCallcebee162009-10-18 09:09:24 +0000412 const SubstTemplateTypeParmType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000413 Record.AddTypeRef(QualType(T->getReplacedParameter(), 0));
414 Record.AddTypeRef(T->getReplacementType());
Sebastian Redl539c5062010-08-18 23:57:32 +0000415 Code = TYPE_SUBST_TEMPLATE_TYPE_PARM;
John McCallcebee162009-10-18 09:09:24 +0000416}
417
418void
Douglas Gregorada4b792011-01-14 02:55:32 +0000419ASTTypeWriter::VisitSubstTemplateTypeParmPackType(
420 const SubstTemplateTypeParmPackType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000421 Record.AddTypeRef(QualType(T->getReplacedParameter(), 0));
422 Record.AddTemplateArgument(T->getArgumentPack());
Douglas Gregorada4b792011-01-14 02:55:32 +0000423 Code = TYPE_SUBST_TEMPLATE_TYPE_PARM_PACK;
424}
425
426void
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000427ASTTypeWriter::VisitTemplateSpecializationType(
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000428 const TemplateSpecializationType *T) {
Argyrios Kyrtzidisa4ed1812010-07-08 13:09:53 +0000429 Record.push_back(T->isDependentType());
Richard Smith69c82bf2016-04-01 22:52:03 +0000430 Record.AddTemplateName(T->getTemplateName());
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +0000431 Record.push_back(T->getNumArgs());
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +0000432 for (const auto &ArgI : *T)
Richard Smith69c82bf2016-04-01 22:52:03 +0000433 Record.AddTemplateArgument(ArgI);
434 Record.AddTypeRef(T->isTypeAlias() ? T->getAliasedType()
435 : T->isCanonicalUnqualified()
436 ? QualType()
437 : T->getCanonicalTypeInternal());
Sebastian Redl539c5062010-08-18 23:57:32 +0000438 Code = TYPE_TEMPLATE_SPECIALIZATION;
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +0000439}
440
441void
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000442ASTTypeWriter::VisitDependentSizedArrayType(const DependentSizedArrayType *T) {
Argyrios Kyrtzidis4a57bd02010-06-30 08:49:25 +0000443 VisitArrayType(T);
Richard Smith290d8012016-04-06 17:06:00 +0000444 Record.AddStmt(T->getSizeExpr());
Richard Smith69c82bf2016-04-01 22:52:03 +0000445 Record.AddSourceRange(T->getBracketsRange());
Sebastian Redl539c5062010-08-18 23:57:32 +0000446 Code = TYPE_DEPENDENT_SIZED_ARRAY;
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +0000447}
448
449void
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000450ASTTypeWriter::VisitDependentSizedExtVectorType(
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +0000451 const DependentSizedExtVectorType *T) {
Alex Lorenz00aee432017-03-22 10:04:48 +0000452 Record.AddTypeRef(T->getElementType());
453 Record.AddStmt(T->getSizeExpr());
454 Record.AddSourceLocation(T->getAttributeLoc());
455 Code = TYPE_DEPENDENT_SIZED_EXT_VECTOR;
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +0000456}
457
Erich Keanef702b022018-07-13 19:46:04 +0000458void ASTTypeWriter::VisitDependentVectorType(const DependentVectorType *T) {
459 Record.AddTypeRef(T->getElementType());
460 Record.AddStmt(const_cast<Expr*>(T->getSizeExpr()));
461 Record.AddSourceLocation(T->getAttributeLoc());
462 Record.push_back(T->getVectorKind());
463 Code = TYPE_DEPENDENT_SIZED_VECTOR;
464}
465
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +0000466void
Andrew Gozillon572bbb02017-10-02 06:25:51 +0000467ASTTypeWriter::VisitDependentAddressSpaceType(
468 const DependentAddressSpaceType *T) {
469 Record.AddTypeRef(T->getPointeeType());
470 Record.AddStmt(T->getAddrSpaceExpr());
471 Record.AddSourceLocation(T->getAttributeLoc());
472 Code = TYPE_DEPENDENT_ADDRESS_SPACE;
473}
474
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +0000475void
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000476ASTTypeWriter::VisitTemplateTypeParmType(const TemplateTypeParmType *T) {
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +0000477 Record.push_back(T->getDepth());
478 Record.push_back(T->getIndex());
479 Record.push_back(T->isParameterPack());
Richard Smith69c82bf2016-04-01 22:52:03 +0000480 Record.AddDeclRef(T->getDecl());
Sebastian Redl539c5062010-08-18 23:57:32 +0000481 Code = TYPE_TEMPLATE_TYPE_PARM;
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +0000482}
483
484void
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000485ASTTypeWriter::VisitDependentNameType(const DependentNameType *T) {
Argyrios Kyrtzidisbfcacee2010-06-24 08:57:31 +0000486 Record.push_back(T->getKeyword());
Richard Smith69c82bf2016-04-01 22:52:03 +0000487 Record.AddNestedNameSpecifier(T->getQualifier());
488 Record.AddIdentifierRef(T->getIdentifier());
489 Record.AddTypeRef(
490 T->isCanonicalUnqualified() ? QualType() : T->getCanonicalTypeInternal());
Sebastian Redl539c5062010-08-18 23:57:32 +0000491 Code = TYPE_DEPENDENT_NAME;
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +0000492}
493
494void
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000495ASTTypeWriter::VisitDependentTemplateSpecializationType(
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +0000496 const DependentTemplateSpecializationType *T) {
Argyrios Kyrtzidisf0f7a792010-06-25 16:24:58 +0000497 Record.push_back(T->getKeyword());
Richard Smith69c82bf2016-04-01 22:52:03 +0000498 Record.AddNestedNameSpecifier(T->getQualifier());
499 Record.AddIdentifierRef(T->getIdentifier());
Argyrios Kyrtzidisf0f7a792010-06-25 16:24:58 +0000500 Record.push_back(T->getNumArgs());
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +0000501 for (const auto &I : *T)
Richard Smith69c82bf2016-04-01 22:52:03 +0000502 Record.AddTemplateArgument(I);
Sebastian Redl539c5062010-08-18 23:57:32 +0000503 Code = TYPE_DEPENDENT_TEMPLATE_SPECIALIZATION;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000504}
505
Douglas Gregord2fa7662010-12-20 02:24:11 +0000506void ASTTypeWriter::VisitPackExpansionType(const PackExpansionType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000507 Record.AddTypeRef(T->getPattern());
David Blaikie05785d12013-02-20 22:23:23 +0000508 if (Optional<unsigned> NumExpansions = T->getNumExpansions())
Douglas Gregor0dca5fd2011-01-14 17:04:44 +0000509 Record.push_back(*NumExpansions + 1);
510 else
511 Record.push_back(0);
Douglas Gregord2fa7662010-12-20 02:24:11 +0000512 Code = TYPE_PACK_EXPANSION;
513}
514
Abramo Bagnara924a8f32010-12-10 16:29:40 +0000515void ASTTypeWriter::VisitParenType(const ParenType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000516 Record.AddTypeRef(T->getInnerType());
Abramo Bagnara924a8f32010-12-10 16:29:40 +0000517 Code = TYPE_PAREN;
518}
519
Leonard Chanc72aaf62019-05-07 03:20:17 +0000520void ASTTypeWriter::VisitMacroQualifiedType(const MacroQualifiedType *T) {
521 Record.AddTypeRef(T->getUnderlyingType());
522 Record.AddIdentifierRef(T->getMacroIdentifier());
523 Code = TYPE_MACRO_QUALIFIED;
524}
525
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000526void ASTTypeWriter::VisitElaboratedType(const ElaboratedType *T) {
Abramo Bagnara6150c882010-05-11 21:36:43 +0000527 Record.push_back(T->getKeyword());
Richard Smith69c82bf2016-04-01 22:52:03 +0000528 Record.AddNestedNameSpecifier(T->getQualifier());
529 Record.AddTypeRef(T->getNamedType());
Joel E. Denny7509a2f2018-05-14 19:36:45 +0000530 Record.AddDeclRef(T->getOwnedTagDecl());
Sebastian Redl539c5062010-08-18 23:57:32 +0000531 Code = TYPE_ELABORATED;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000532}
533
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000534void ASTTypeWriter::VisitInjectedClassNameType(const InjectedClassNameType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000535 Record.AddDeclRef(T->getDecl()->getCanonicalDecl());
536 Record.AddTypeRef(T->getInjectedSpecializationType());
Sebastian Redl539c5062010-08-18 23:57:32 +0000537 Code = TYPE_INJECTED_CLASS_NAME;
John McCalle78aac42010-03-10 03:28:59 +0000538}
539
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000540void ASTTypeWriter::VisitObjCInterfaceType(const ObjCInterfaceType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000541 Record.AddDeclRef(T->getDecl()->getCanonicalDecl());
Sebastian Redl539c5062010-08-18 23:57:32 +0000542 Code = TYPE_OBJC_INTERFACE;
John McCall8b07ec22010-05-15 11:32:37 +0000543}
544
Manman Rene6be26c2016-09-13 17:25:08 +0000545void ASTTypeWriter::VisitObjCTypeParamType(const ObjCTypeParamType *T) {
546 Record.AddDeclRef(T->getDecl());
547 Record.push_back(T->getNumProtocols());
548 for (const auto *I : T->quals())
549 Record.AddDeclRef(I);
550 Code = TYPE_OBJC_TYPE_PARAM;
551}
552
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000553void ASTTypeWriter::VisitObjCObjectType(const ObjCObjectType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000554 Record.AddTypeRef(T->getBaseType());
Douglas Gregore83b9562015-07-07 03:57:53 +0000555 Record.push_back(T->getTypeArgsAsWritten().size());
556 for (auto TypeArg : T->getTypeArgsAsWritten())
Richard Smith69c82bf2016-04-01 22:52:03 +0000557 Record.AddTypeRef(TypeArg);
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000558 Record.push_back(T->getNumProtocols());
Aaron Ballman1683f7b2014-03-17 15:55:30 +0000559 for (const auto *I : T->quals())
Richard Smith69c82bf2016-04-01 22:52:03 +0000560 Record.AddDeclRef(I);
Douglas Gregorab209d82015-07-07 03:58:42 +0000561 Record.push_back(T->isKindOfTypeAsWritten());
Sebastian Redl539c5062010-08-18 23:57:32 +0000562 Code = TYPE_OBJC_OBJECT;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000563}
564
Steve Narofffb4330f2009-06-17 22:40:22 +0000565void
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000566ASTTypeWriter::VisitObjCObjectPointerType(const ObjCObjectPointerType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000567 Record.AddTypeRef(T->getPointeeType());
Sebastian Redl539c5062010-08-18 23:57:32 +0000568 Code = TYPE_OBJC_OBJECT_POINTER;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000569}
570
Eli Friedman0dfb8892011-10-06 23:00:33 +0000571void
572ASTTypeWriter::VisitAtomicType(const AtomicType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000573 Record.AddTypeRef(T->getValueType());
Eli Friedman0dfb8892011-10-06 23:00:33 +0000574 Code = TYPE_ATOMIC;
575}
576
Xiuli Pan9c14e282016-01-09 12:53:17 +0000577void
578ASTTypeWriter::VisitPipeType(const PipeType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000579 Record.AddTypeRef(T->getElementType());
Joey Goulye3c85de2016-12-01 11:30:49 +0000580 Record.push_back(T->isReadOnly());
581 Code = TYPE_PIPE;
Xiuli Pan9c14e282016-01-09 12:53:17 +0000582}
583
John McCall8f115c62009-10-16 21:56:05 +0000584namespace {
585
586class TypeLocWriter : public TypeLocVisitor<TypeLocWriter> {
Richard Smith290d8012016-04-06 17:06:00 +0000587 ASTRecordWriter &Record;
John McCall8f115c62009-10-16 21:56:05 +0000588
589public:
Eugene Zelenkob7d89102017-11-11 00:08:50 +0000590 TypeLocWriter(ASTRecordWriter &Record) : Record(Record) {}
John McCall8f115c62009-10-16 21:56:05 +0000591
John McCall17001972009-10-18 01:05:36 +0000592#define ABSTRACT_TYPELOC(CLASS, PARENT)
John McCall8f115c62009-10-16 21:56:05 +0000593#define TYPELOC(CLASS, PARENT) \
John McCall17001972009-10-18 01:05:36 +0000594 void Visit##CLASS##TypeLoc(CLASS##TypeLoc TyLoc);
John McCall8f115c62009-10-16 21:56:05 +0000595#include "clang/AST/TypeLocNodes.def"
596
John McCall17001972009-10-18 01:05:36 +0000597 void VisitArrayTypeLoc(ArrayTypeLoc TyLoc);
598 void VisitFunctionTypeLoc(FunctionTypeLoc TyLoc);
John McCall8f115c62009-10-16 21:56:05 +0000599};
600
Eugene Zelenkob7d89102017-11-11 00:08:50 +0000601} // namespace
John McCall8f115c62009-10-16 21:56:05 +0000602
John McCall17001972009-10-18 01:05:36 +0000603void TypeLocWriter::VisitQualifiedTypeLoc(QualifiedTypeLoc TL) {
604 // nothing to do
John McCall8f115c62009-10-16 21:56:05 +0000605}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000606
John McCall17001972009-10-18 01:05:36 +0000607void TypeLocWriter::VisitBuiltinTypeLoc(BuiltinTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000608 Record.AddSourceLocation(TL.getBuiltinLoc());
Douglas Gregorc9b7a592010-01-18 18:04:31 +0000609 if (TL.needsExtraLocalData()) {
Faisal Vali090da2d2018-01-01 18:23:28 +0000610 Record.push_back(TL.getWrittenTypeSpec());
611 Record.push_back(TL.getWrittenSignSpec());
612 Record.push_back(TL.getWrittenWidthSpec());
Douglas Gregorc9b7a592010-01-18 18:04:31 +0000613 Record.push_back(TL.hasModeAttr());
614 }
John McCall8f115c62009-10-16 21:56:05 +0000615}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000616
John McCall17001972009-10-18 01:05:36 +0000617void TypeLocWriter::VisitComplexTypeLoc(ComplexTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000618 Record.AddSourceLocation(TL.getNameLoc());
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::VisitPointerTypeLoc(PointerTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000622 Record.AddSourceLocation(TL.getStarLoc());
John McCall8f115c62009-10-16 21:56:05 +0000623}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000624
Reid Kleckner8a365022013-06-24 17:51:48 +0000625void TypeLocWriter::VisitDecayedTypeLoc(DecayedTypeLoc TL) {
626 // nothing to do
627}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000628
Reid Kleckner0503a872013-12-05 01:23:43 +0000629void TypeLocWriter::VisitAdjustedTypeLoc(AdjustedTypeLoc TL) {
630 // nothing to do
631}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000632
John McCall17001972009-10-18 01:05:36 +0000633void TypeLocWriter::VisitBlockPointerTypeLoc(BlockPointerTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000634 Record.AddSourceLocation(TL.getCaretLoc());
John McCall8f115c62009-10-16 21:56:05 +0000635}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000636
John McCall17001972009-10-18 01:05:36 +0000637void TypeLocWriter::VisitLValueReferenceTypeLoc(LValueReferenceTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000638 Record.AddSourceLocation(TL.getAmpLoc());
John McCall8f115c62009-10-16 21:56:05 +0000639}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000640
John McCall17001972009-10-18 01:05:36 +0000641void TypeLocWriter::VisitRValueReferenceTypeLoc(RValueReferenceTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000642 Record.AddSourceLocation(TL.getAmpAmpLoc());
John McCall8f115c62009-10-16 21:56:05 +0000643}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000644
John McCall17001972009-10-18 01:05:36 +0000645void TypeLocWriter::VisitMemberPointerTypeLoc(MemberPointerTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000646 Record.AddSourceLocation(TL.getStarLoc());
647 Record.AddTypeSourceInfo(TL.getClassTInfo());
John McCall8f115c62009-10-16 21:56:05 +0000648}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000649
John McCall17001972009-10-18 01:05:36 +0000650void TypeLocWriter::VisitArrayTypeLoc(ArrayTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000651 Record.AddSourceLocation(TL.getLBracketLoc());
652 Record.AddSourceLocation(TL.getRBracketLoc());
John McCall17001972009-10-18 01:05:36 +0000653 Record.push_back(TL.getSizeExpr() ? 1 : 0);
654 if (TL.getSizeExpr())
Richard Smith290d8012016-04-06 17:06:00 +0000655 Record.AddStmt(TL.getSizeExpr());
John McCall8f115c62009-10-16 21:56:05 +0000656}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000657
John McCall17001972009-10-18 01:05:36 +0000658void TypeLocWriter::VisitConstantArrayTypeLoc(ConstantArrayTypeLoc TL) {
659 VisitArrayTypeLoc(TL);
660}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000661
John McCall17001972009-10-18 01:05:36 +0000662void TypeLocWriter::VisitIncompleteArrayTypeLoc(IncompleteArrayTypeLoc TL) {
663 VisitArrayTypeLoc(TL);
664}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000665
John McCall17001972009-10-18 01:05:36 +0000666void TypeLocWriter::VisitVariableArrayTypeLoc(VariableArrayTypeLoc TL) {
667 VisitArrayTypeLoc(TL);
668}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000669
John McCall17001972009-10-18 01:05:36 +0000670void TypeLocWriter::VisitDependentSizedArrayTypeLoc(
671 DependentSizedArrayTypeLoc TL) {
672 VisitArrayTypeLoc(TL);
673}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000674
Andrew Gozillon572bbb02017-10-02 06:25:51 +0000675void TypeLocWriter::VisitDependentAddressSpaceTypeLoc(
676 DependentAddressSpaceTypeLoc TL) {
677 Record.AddSourceLocation(TL.getAttrNameLoc());
678 SourceRange range = TL.getAttrOperandParensRange();
679 Record.AddSourceLocation(range.getBegin());
680 Record.AddSourceLocation(range.getEnd());
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +0000681 Record.AddStmt(TL.getAttrExprOperand());
Andrew Gozillon572bbb02017-10-02 06:25:51 +0000682}
683
John McCall17001972009-10-18 01:05:36 +0000684void TypeLocWriter::VisitDependentSizedExtVectorTypeLoc(
685 DependentSizedExtVectorTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000686 Record.AddSourceLocation(TL.getNameLoc());
John McCall17001972009-10-18 01:05:36 +0000687}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000688
John McCall17001972009-10-18 01:05:36 +0000689void TypeLocWriter::VisitVectorTypeLoc(VectorTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000690 Record.AddSourceLocation(TL.getNameLoc());
John McCall17001972009-10-18 01:05:36 +0000691}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000692
Erich Keanef702b022018-07-13 19:46:04 +0000693void TypeLocWriter::VisitDependentVectorTypeLoc(
694 DependentVectorTypeLoc TL) {
695 Record.AddSourceLocation(TL.getNameLoc());
696}
697
John McCall17001972009-10-18 01:05:36 +0000698void TypeLocWriter::VisitExtVectorTypeLoc(ExtVectorTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000699 Record.AddSourceLocation(TL.getNameLoc());
John McCall17001972009-10-18 01:05:36 +0000700}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000701
John McCall17001972009-10-18 01:05:36 +0000702void TypeLocWriter::VisitFunctionTypeLoc(FunctionTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000703 Record.AddSourceLocation(TL.getLocalRangeBegin());
704 Record.AddSourceLocation(TL.getLParenLoc());
705 Record.AddSourceLocation(TL.getRParenLoc());
Malcolm Parsonsa3220ce2017-01-12 16:11:28 +0000706 Record.AddSourceRange(TL.getExceptionSpecRange());
Richard Smith69c82bf2016-04-01 22:52:03 +0000707 Record.AddSourceLocation(TL.getLocalRangeEnd());
Alp Tokerb3fd5cf2014-01-21 00:32:38 +0000708 for (unsigned i = 0, e = TL.getNumParams(); i != e; ++i)
Richard Smith69c82bf2016-04-01 22:52:03 +0000709 Record.AddDeclRef(TL.getParam(i));
John McCall17001972009-10-18 01:05:36 +0000710}
Eugene Zelenkob7d89102017-11-11 00:08:50 +0000711
John McCall17001972009-10-18 01:05:36 +0000712void TypeLocWriter::VisitFunctionProtoTypeLoc(FunctionProtoTypeLoc TL) {
713 VisitFunctionTypeLoc(TL);
714}
Eugene Zelenkob7d89102017-11-11 00:08:50 +0000715
John McCall17001972009-10-18 01:05:36 +0000716void TypeLocWriter::VisitFunctionNoProtoTypeLoc(FunctionNoProtoTypeLoc TL) {
717 VisitFunctionTypeLoc(TL);
718}
Eugene Zelenkob7d89102017-11-11 00:08:50 +0000719
John McCallb96ec562009-12-04 22:46:56 +0000720void TypeLocWriter::VisitUnresolvedUsingTypeLoc(UnresolvedUsingTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000721 Record.AddSourceLocation(TL.getNameLoc());
John McCallb96ec562009-12-04 22:46:56 +0000722}
Eugene Zelenkob7d89102017-11-11 00:08:50 +0000723
John McCall17001972009-10-18 01:05:36 +0000724void TypeLocWriter::VisitTypedefTypeLoc(TypedefTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000725 Record.AddSourceLocation(TL.getNameLoc());
John McCall17001972009-10-18 01:05:36 +0000726}
Eugene Zelenkob7d89102017-11-11 00:08:50 +0000727
Manman Rene6be26c2016-09-13 17:25:08 +0000728void TypeLocWriter::VisitObjCTypeParamTypeLoc(ObjCTypeParamTypeLoc TL) {
729 if (TL.getNumProtocols()) {
730 Record.AddSourceLocation(TL.getProtocolLAngleLoc());
731 Record.AddSourceLocation(TL.getProtocolRAngleLoc());
732 }
733 for (unsigned i = 0, e = TL.getNumProtocols(); i != e; ++i)
734 Record.AddSourceLocation(TL.getProtocolLoc(i));
735}
Eugene Zelenkob7d89102017-11-11 00:08:50 +0000736
John McCall17001972009-10-18 01:05:36 +0000737void TypeLocWriter::VisitTypeOfExprTypeLoc(TypeOfExprTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000738 Record.AddSourceLocation(TL.getTypeofLoc());
739 Record.AddSourceLocation(TL.getLParenLoc());
740 Record.AddSourceLocation(TL.getRParenLoc());
John McCall17001972009-10-18 01:05:36 +0000741}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000742
John McCall17001972009-10-18 01:05:36 +0000743void TypeLocWriter::VisitTypeOfTypeLoc(TypeOfTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000744 Record.AddSourceLocation(TL.getTypeofLoc());
745 Record.AddSourceLocation(TL.getLParenLoc());
746 Record.AddSourceLocation(TL.getRParenLoc());
747 Record.AddTypeSourceInfo(TL.getUnderlyingTInfo());
John McCall17001972009-10-18 01:05:36 +0000748}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000749
John McCall17001972009-10-18 01:05:36 +0000750void TypeLocWriter::VisitDecltypeTypeLoc(DecltypeTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000751 Record.AddSourceLocation(TL.getNameLoc());
John McCall17001972009-10-18 01:05:36 +0000752}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000753
Alexis Hunte852b102011-05-24 22:41:36 +0000754void TypeLocWriter::VisitUnaryTransformTypeLoc(UnaryTransformTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000755 Record.AddSourceLocation(TL.getKWLoc());
756 Record.AddSourceLocation(TL.getLParenLoc());
757 Record.AddSourceLocation(TL.getRParenLoc());
758 Record.AddTypeSourceInfo(TL.getUnderlyingTInfo());
Alexis Hunte852b102011-05-24 22:41:36 +0000759}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000760
Richard Smith30482bc2011-02-20 03:19:35 +0000761void TypeLocWriter::VisitAutoTypeLoc(AutoTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000762 Record.AddSourceLocation(TL.getNameLoc());
Richard Smith30482bc2011-02-20 03:19:35 +0000763}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000764
Richard Smith600b5262017-01-26 20:40:47 +0000765void TypeLocWriter::VisitDeducedTemplateSpecializationTypeLoc(
766 DeducedTemplateSpecializationTypeLoc TL) {
767 Record.AddSourceLocation(TL.getTemplateNameLoc());
768}
769
John McCall17001972009-10-18 01:05:36 +0000770void TypeLocWriter::VisitRecordTypeLoc(RecordTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000771 Record.AddSourceLocation(TL.getNameLoc());
John McCall17001972009-10-18 01:05:36 +0000772}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000773
John McCall17001972009-10-18 01:05:36 +0000774void TypeLocWriter::VisitEnumTypeLoc(EnumTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000775 Record.AddSourceLocation(TL.getNameLoc());
John McCall17001972009-10-18 01:05:36 +0000776}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000777
John McCall81904512011-01-06 01:58:22 +0000778void TypeLocWriter::VisitAttributedTypeLoc(AttributedTypeLoc TL) {
Richard Smithe43e2b32018-08-20 21:47:29 +0000779 Record.AddAttr(TL.getAttr());
John McCall81904512011-01-06 01:58:22 +0000780}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000781
John McCall17001972009-10-18 01:05:36 +0000782void TypeLocWriter::VisitTemplateTypeParmTypeLoc(TemplateTypeParmTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000783 Record.AddSourceLocation(TL.getNameLoc());
John McCall17001972009-10-18 01:05:36 +0000784}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000785
John McCallcebee162009-10-18 09:09:24 +0000786void TypeLocWriter::VisitSubstTemplateTypeParmTypeLoc(
787 SubstTemplateTypeParmTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000788 Record.AddSourceLocation(TL.getNameLoc());
John McCallcebee162009-10-18 09:09:24 +0000789}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000790
Douglas Gregorada4b792011-01-14 02:55:32 +0000791void TypeLocWriter::VisitSubstTemplateTypeParmPackTypeLoc(
792 SubstTemplateTypeParmPackTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000793 Record.AddSourceLocation(TL.getNameLoc());
Douglas Gregorada4b792011-01-14 02:55:32 +0000794}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000795
John McCall17001972009-10-18 01:05:36 +0000796void TypeLocWriter::VisitTemplateSpecializationTypeLoc(
797 TemplateSpecializationTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000798 Record.AddSourceLocation(TL.getTemplateKeywordLoc());
799 Record.AddSourceLocation(TL.getTemplateNameLoc());
800 Record.AddSourceLocation(TL.getLAngleLoc());
801 Record.AddSourceLocation(TL.getRAngleLoc());
John McCall0ad16662009-10-29 08:12:44 +0000802 for (unsigned i = 0, e = TL.getNumArgs(); i != e; ++i)
Richard Smith69c82bf2016-04-01 22:52:03 +0000803 Record.AddTemplateArgumentLocInfo(TL.getArgLoc(i).getArgument().getKind(),
804 TL.getArgLoc(i).getLocInfo());
John McCall17001972009-10-18 01:05:36 +0000805}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000806
Abramo Bagnara924a8f32010-12-10 16:29:40 +0000807void TypeLocWriter::VisitParenTypeLoc(ParenTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000808 Record.AddSourceLocation(TL.getLParenLoc());
809 Record.AddSourceLocation(TL.getRParenLoc());
Abramo Bagnara924a8f32010-12-10 16:29:40 +0000810}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000811
Leonard Chanc72aaf62019-05-07 03:20:17 +0000812void TypeLocWriter::VisitMacroQualifiedTypeLoc(MacroQualifiedTypeLoc TL) {
813 Record.AddSourceLocation(TL.getExpansionLoc());
814}
815
Abramo Bagnara6150c882010-05-11 21:36:43 +0000816void TypeLocWriter::VisitElaboratedTypeLoc(ElaboratedTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000817 Record.AddSourceLocation(TL.getElaboratedKeywordLoc());
818 Record.AddNestedNameSpecifierLoc(TL.getQualifierLoc());
John McCall17001972009-10-18 01:05:36 +0000819}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000820
John McCalle78aac42010-03-10 03:28:59 +0000821void TypeLocWriter::VisitInjectedClassNameTypeLoc(InjectedClassNameTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000822 Record.AddSourceLocation(TL.getNameLoc());
John McCalle78aac42010-03-10 03:28:59 +0000823}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000824
Douglas Gregorc1d2d8a2010-03-31 17:34:00 +0000825void TypeLocWriter::VisitDependentNameTypeLoc(DependentNameTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000826 Record.AddSourceLocation(TL.getElaboratedKeywordLoc());
827 Record.AddNestedNameSpecifierLoc(TL.getQualifierLoc());
828 Record.AddSourceLocation(TL.getNameLoc());
John McCall17001972009-10-18 01:05:36 +0000829}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000830
John McCallc392f372010-06-11 00:33:02 +0000831void TypeLocWriter::VisitDependentTemplateSpecializationTypeLoc(
832 DependentTemplateSpecializationTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000833 Record.AddSourceLocation(TL.getElaboratedKeywordLoc());
834 Record.AddNestedNameSpecifierLoc(TL.getQualifierLoc());
835 Record.AddSourceLocation(TL.getTemplateKeywordLoc());
836 Record.AddSourceLocation(TL.getTemplateNameLoc());
837 Record.AddSourceLocation(TL.getLAngleLoc());
838 Record.AddSourceLocation(TL.getRAngleLoc());
John McCallc392f372010-06-11 00:33:02 +0000839 for (unsigned I = 0, E = TL.getNumArgs(); I != E; ++I)
Richard Smith69c82bf2016-04-01 22:52:03 +0000840 Record.AddTemplateArgumentLocInfo(TL.getArgLoc(I).getArgument().getKind(),
841 TL.getArgLoc(I).getLocInfo());
John McCallc392f372010-06-11 00:33:02 +0000842}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000843
Douglas Gregord2fa7662010-12-20 02:24:11 +0000844void TypeLocWriter::VisitPackExpansionTypeLoc(PackExpansionTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000845 Record.AddSourceLocation(TL.getEllipsisLoc());
Douglas Gregord2fa7662010-12-20 02:24:11 +0000846}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000847
John McCall17001972009-10-18 01:05:36 +0000848void TypeLocWriter::VisitObjCInterfaceTypeLoc(ObjCInterfaceTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000849 Record.AddSourceLocation(TL.getNameLoc());
John McCall8b07ec22010-05-15 11:32:37 +0000850}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000851
John McCall8b07ec22010-05-15 11:32:37 +0000852void TypeLocWriter::VisitObjCObjectTypeLoc(ObjCObjectTypeLoc TL) {
853 Record.push_back(TL.hasBaseTypeAsWritten());
Richard Smith69c82bf2016-04-01 22:52:03 +0000854 Record.AddSourceLocation(TL.getTypeArgsLAngleLoc());
855 Record.AddSourceLocation(TL.getTypeArgsRAngleLoc());
Douglas Gregore9d95f12015-07-07 03:57:35 +0000856 for (unsigned i = 0, e = TL.getNumTypeArgs(); i != e; ++i)
Richard Smith69c82bf2016-04-01 22:52:03 +0000857 Record.AddTypeSourceInfo(TL.getTypeArgTInfo(i));
858 Record.AddSourceLocation(TL.getProtocolLAngleLoc());
859 Record.AddSourceLocation(TL.getProtocolRAngleLoc());
John McCall17001972009-10-18 01:05:36 +0000860 for (unsigned i = 0, e = TL.getNumProtocols(); i != e; ++i)
Richard Smith69c82bf2016-04-01 22:52:03 +0000861 Record.AddSourceLocation(TL.getProtocolLoc(i));
John McCall8f115c62009-10-16 21:56:05 +0000862}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000863
John McCallfc93cf92009-10-22 22:37:11 +0000864void TypeLocWriter::VisitObjCObjectPointerTypeLoc(ObjCObjectPointerTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000865 Record.AddSourceLocation(TL.getStarLoc());
John McCallfc93cf92009-10-22 22:37:11 +0000866}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000867
Eli Friedman0dfb8892011-10-06 23:00:33 +0000868void TypeLocWriter::VisitAtomicTypeLoc(AtomicTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000869 Record.AddSourceLocation(TL.getKWLoc());
870 Record.AddSourceLocation(TL.getLParenLoc());
871 Record.AddSourceLocation(TL.getRParenLoc());
Eli Friedman0dfb8892011-10-06 23:00:33 +0000872}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000873
Xiuli Pan9c14e282016-01-09 12:53:17 +0000874void TypeLocWriter::VisitPipeTypeLoc(PipeTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000875 Record.AddSourceLocation(TL.getKWLoc());
Xiuli Pan9c14e282016-01-09 12:53:17 +0000876}
John McCall8f115c62009-10-16 21:56:05 +0000877
Richard Smith01b2cb42014-07-26 06:37:51 +0000878void ASTWriter::WriteTypeAbbrevs() {
879 using namespace llvm;
880
David Blaikieb44f0bf2017-01-04 22:36:43 +0000881 std::shared_ptr<BitCodeAbbrev> Abv;
Richard Smith01b2cb42014-07-26 06:37:51 +0000882
883 // Abbreviation for TYPE_EXT_QUAL
David Blaikieb44f0bf2017-01-04 22:36:43 +0000884 Abv = std::make_shared<BitCodeAbbrev>();
Richard Smith01b2cb42014-07-26 06:37:51 +0000885 Abv->Add(BitCodeAbbrevOp(serialization::TYPE_EXT_QUAL));
886 Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Type
887 Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 3)); // Quals
David Blaikieb44f0bf2017-01-04 22:36:43 +0000888 TypeExtQualAbbrev = Stream.EmitAbbrev(std::move(Abv));
Richard Smith01b2cb42014-07-26 06:37:51 +0000889
890 // Abbreviation for TYPE_FUNCTION_PROTO
David Blaikieb44f0bf2017-01-04 22:36:43 +0000891 Abv = std::make_shared<BitCodeAbbrev>();
Richard Smith01b2cb42014-07-26 06:37:51 +0000892 Abv->Add(BitCodeAbbrevOp(serialization::TYPE_FUNCTION_PROTO));
893 // FunctionType
894 Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // ReturnType
895 Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // NoReturn
896 Abv->Add(BitCodeAbbrevOp(0)); // HasRegParm
897 Abv->Add(BitCodeAbbrevOp(0)); // RegParm
898 Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 4)); // CC
899 Abv->Add(BitCodeAbbrevOp(0)); // ProducesResult
Oren Ben Simhon318a6ea2017-04-27 12:01:00 +0000900 Abv->Add(BitCodeAbbrevOp(0)); // NoCallerSavedRegs
Oren Ben Simhon220671a2018-03-17 13:31:35 +0000901 Abv->Add(BitCodeAbbrevOp(0)); // NoCfCheck
Richard Smith01b2cb42014-07-26 06:37:51 +0000902 // FunctionProtoType
903 Abv->Add(BitCodeAbbrevOp(0)); // IsVariadic
904 Abv->Add(BitCodeAbbrevOp(0)); // HasTrailingReturn
905 Abv->Add(BitCodeAbbrevOp(0)); // TypeQuals
906 Abv->Add(BitCodeAbbrevOp(0)); // RefQualifier
907 Abv->Add(BitCodeAbbrevOp(EST_None)); // ExceptionSpec
908 Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // NumParams
909 Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
910 Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Params
David Blaikieb44f0bf2017-01-04 22:36:43 +0000911 TypeFunctionProtoAbbrev = Stream.EmitAbbrev(std::move(Abv));
Richard Smith01b2cb42014-07-26 06:37:51 +0000912}
913
Chris Lattner19cea4e2009-04-22 05:57:30 +0000914//===----------------------------------------------------------------------===//
Sebastian Redl55c0ad52010-08-18 23:56:21 +0000915// ASTWriter Implementation
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000916//===----------------------------------------------------------------------===//
917
Chris Lattner28fa4e62009-04-26 22:26:21 +0000918static void EmitBlockID(unsigned ID, const char *Name,
919 llvm::BitstreamWriter &Stream,
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +0000920 ASTWriter::RecordDataImpl &Record) {
Chris Lattner28fa4e62009-04-26 22:26:21 +0000921 Record.clear();
922 Record.push_back(ID);
923 Stream.EmitRecord(llvm::bitc::BLOCKINFO_CODE_SETBID, Record);
924
925 // Emit the block name if present.
Craig Toppera13603a2014-05-22 05:54:18 +0000926 if (!Name || Name[0] == 0)
927 return;
Chris Lattner28fa4e62009-04-26 22:26:21 +0000928 Record.clear();
929 while (*Name)
930 Record.push_back(*Name++);
931 Stream.EmitRecord(llvm::bitc::BLOCKINFO_CODE_BLOCKNAME, Record);
932}
933
934static void EmitRecordID(unsigned ID, const char *Name,
935 llvm::BitstreamWriter &Stream,
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +0000936 ASTWriter::RecordDataImpl &Record) {
Chris Lattner28fa4e62009-04-26 22:26:21 +0000937 Record.clear();
938 Record.push_back(ID);
939 while (*Name)
940 Record.push_back(*Name++);
941 Stream.EmitRecord(llvm::bitc::BLOCKINFO_CODE_SETRECORDNAME, Record);
Chris Lattnerccac3a62009-04-27 00:49:53 +0000942}
943
944static void AddStmtsExprs(llvm::BitstreamWriter &Stream,
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +0000945 ASTWriter::RecordDataImpl &Record) {
Sebastian Redl539c5062010-08-18 23:57:32 +0000946#define RECORD(X) EmitRecordID(X, #X, Stream, Record)
Chris Lattnerccac3a62009-04-27 00:49:53 +0000947 RECORD(STMT_STOP);
948 RECORD(STMT_NULL_PTR);
Richard Smith01b2cb42014-07-26 06:37:51 +0000949 RECORD(STMT_REF_PTR);
Chris Lattnerccac3a62009-04-27 00:49:53 +0000950 RECORD(STMT_NULL);
951 RECORD(STMT_COMPOUND);
952 RECORD(STMT_CASE);
953 RECORD(STMT_DEFAULT);
954 RECORD(STMT_LABEL);
Richard Smithc202b282012-04-14 00:33:13 +0000955 RECORD(STMT_ATTRIBUTED);
Chris Lattnerccac3a62009-04-27 00:49:53 +0000956 RECORD(STMT_IF);
957 RECORD(STMT_SWITCH);
958 RECORD(STMT_WHILE);
959 RECORD(STMT_DO);
960 RECORD(STMT_FOR);
961 RECORD(STMT_GOTO);
962 RECORD(STMT_INDIRECT_GOTO);
963 RECORD(STMT_CONTINUE);
964 RECORD(STMT_BREAK);
965 RECORD(STMT_RETURN);
966 RECORD(STMT_DECL);
Chad Rosierde70e0e2012-08-25 00:11:56 +0000967 RECORD(STMT_GCCASM);
Chad Rosiere30d4992012-08-24 23:51:02 +0000968 RECORD(STMT_MSASM);
Chris Lattnerccac3a62009-04-27 00:49:53 +0000969 RECORD(EXPR_PREDEFINED);
970 RECORD(EXPR_DECL_REF);
971 RECORD(EXPR_INTEGER_LITERAL);
972 RECORD(EXPR_FLOATING_LITERAL);
973 RECORD(EXPR_IMAGINARY_LITERAL);
974 RECORD(EXPR_STRING_LITERAL);
975 RECORD(EXPR_CHARACTER_LITERAL);
976 RECORD(EXPR_PAREN);
Richard Smithf1b4b8b2014-07-27 04:29:04 +0000977 RECORD(EXPR_PAREN_LIST);
Chris Lattnerccac3a62009-04-27 00:49:53 +0000978 RECORD(EXPR_UNARY_OPERATOR);
979 RECORD(EXPR_SIZEOF_ALIGN_OF);
980 RECORD(EXPR_ARRAY_SUBSCRIPT);
981 RECORD(EXPR_CALL);
982 RECORD(EXPR_MEMBER);
983 RECORD(EXPR_BINARY_OPERATOR);
984 RECORD(EXPR_COMPOUND_ASSIGN_OPERATOR);
985 RECORD(EXPR_CONDITIONAL_OPERATOR);
986 RECORD(EXPR_IMPLICIT_CAST);
987 RECORD(EXPR_CSTYLE_CAST);
988 RECORD(EXPR_COMPOUND_LITERAL);
989 RECORD(EXPR_EXT_VECTOR_ELEMENT);
990 RECORD(EXPR_INIT_LIST);
991 RECORD(EXPR_DESIGNATED_INIT);
Yunzhong Gaocb779302015-06-10 00:27:52 +0000992 RECORD(EXPR_DESIGNATED_INIT_UPDATE);
Chris Lattnerccac3a62009-04-27 00:49:53 +0000993 RECORD(EXPR_IMPLICIT_VALUE_INIT);
Yunzhong Gaocb779302015-06-10 00:27:52 +0000994 RECORD(EXPR_NO_INIT);
Chris Lattnerccac3a62009-04-27 00:49:53 +0000995 RECORD(EXPR_VA_ARG);
996 RECORD(EXPR_ADDR_LABEL);
997 RECORD(EXPR_STMT);
Chris Lattnerccac3a62009-04-27 00:49:53 +0000998 RECORD(EXPR_CHOOSE);
999 RECORD(EXPR_GNU_NULL);
1000 RECORD(EXPR_SHUFFLE_VECTOR);
1001 RECORD(EXPR_BLOCK);
Peter Collingbourne91147592011-04-15 00:35:48 +00001002 RECORD(EXPR_GENERIC_SELECTION);
Chris Lattnerccac3a62009-04-27 00:49:53 +00001003 RECORD(EXPR_OBJC_STRING_LITERAL);
Patrick Beard0caa3942012-04-19 00:25:12 +00001004 RECORD(EXPR_OBJC_BOXED_EXPRESSION);
Ted Kremeneke65b0862012-03-06 20:05:56 +00001005 RECORD(EXPR_OBJC_ARRAY_LITERAL);
1006 RECORD(EXPR_OBJC_DICTIONARY_LITERAL);
Chris Lattnerccac3a62009-04-27 00:49:53 +00001007 RECORD(EXPR_OBJC_ENCODE);
1008 RECORD(EXPR_OBJC_SELECTOR_EXPR);
1009 RECORD(EXPR_OBJC_PROTOCOL_EXPR);
1010 RECORD(EXPR_OBJC_IVAR_REF_EXPR);
1011 RECORD(EXPR_OBJC_PROPERTY_REF_EXPR);
1012 RECORD(EXPR_OBJC_KVC_REF_EXPR);
1013 RECORD(EXPR_OBJC_MESSAGE_EXPR);
Chris Lattnerccac3a62009-04-27 00:49:53 +00001014 RECORD(STMT_OBJC_FOR_COLLECTION);
1015 RECORD(STMT_OBJC_CATCH);
1016 RECORD(STMT_OBJC_FINALLY);
1017 RECORD(STMT_OBJC_AT_TRY);
1018 RECORD(STMT_OBJC_AT_SYNCHRONIZED);
1019 RECORD(STMT_OBJC_AT_THROW);
Ted Kremeneke65b0862012-03-06 20:05:56 +00001020 RECORD(EXPR_OBJC_BOOL_LITERAL);
Richard Smith01b2cb42014-07-26 06:37:51 +00001021 RECORD(STMT_CXX_CATCH);
1022 RECORD(STMT_CXX_TRY);
1023 RECORD(STMT_CXX_FOR_RANGE);
Sam Weinige83b3ac2010-02-07 06:32:43 +00001024 RECORD(EXPR_CXX_OPERATOR_CALL);
Richard Smithf1b4b8b2014-07-27 04:29:04 +00001025 RECORD(EXPR_CXX_MEMBER_CALL);
Sam Weinige83b3ac2010-02-07 06:32:43 +00001026 RECORD(EXPR_CXX_CONSTRUCT);
Richard Smithf1b4b8b2014-07-27 04:29:04 +00001027 RECORD(EXPR_CXX_TEMPORARY_OBJECT);
Sam Weinige83b3ac2010-02-07 06:32:43 +00001028 RECORD(EXPR_CXX_STATIC_CAST);
1029 RECORD(EXPR_CXX_DYNAMIC_CAST);
1030 RECORD(EXPR_CXX_REINTERPRET_CAST);
1031 RECORD(EXPR_CXX_CONST_CAST);
1032 RECORD(EXPR_CXX_FUNCTIONAL_CAST);
Richard Smithc67fdd42012-03-07 08:35:16 +00001033 RECORD(EXPR_USER_DEFINED_LITERAL);
Richard Smithcc1b96d2013-06-12 22:31:48 +00001034 RECORD(EXPR_CXX_STD_INITIALIZER_LIST);
Sam Weinige83b3ac2010-02-07 06:32:43 +00001035 RECORD(EXPR_CXX_BOOL_LITERAL);
1036 RECORD(EXPR_CXX_NULL_PTR_LITERAL);
Douglas Gregor0beaec02011-02-08 16:34:17 +00001037 RECORD(EXPR_CXX_TYPEID_EXPR);
1038 RECORD(EXPR_CXX_TYPEID_TYPE);
Douglas Gregor0beaec02011-02-08 16:34:17 +00001039 RECORD(EXPR_CXX_THIS);
1040 RECORD(EXPR_CXX_THROW);
1041 RECORD(EXPR_CXX_DEFAULT_ARG);
Richard Smith01b2cb42014-07-26 06:37:51 +00001042 RECORD(EXPR_CXX_DEFAULT_INIT);
Douglas Gregor0beaec02011-02-08 16:34:17 +00001043 RECORD(EXPR_CXX_BIND_TEMPORARY);
1044 RECORD(EXPR_CXX_SCALAR_VALUE_INIT);
1045 RECORD(EXPR_CXX_NEW);
1046 RECORD(EXPR_CXX_DELETE);
1047 RECORD(EXPR_CXX_PSEUDO_DESTRUCTOR);
1048 RECORD(EXPR_EXPR_WITH_CLEANUPS);
1049 RECORD(EXPR_CXX_DEPENDENT_SCOPE_MEMBER);
1050 RECORD(EXPR_CXX_DEPENDENT_SCOPE_DECL_REF);
1051 RECORD(EXPR_CXX_UNRESOLVED_CONSTRUCT);
1052 RECORD(EXPR_CXX_UNRESOLVED_MEMBER);
1053 RECORD(EXPR_CXX_UNRESOLVED_LOOKUP);
Richard Smith01b2cb42014-07-26 06:37:51 +00001054 RECORD(EXPR_CXX_EXPRESSION_TRAIT);
Douglas Gregor0beaec02011-02-08 16:34:17 +00001055 RECORD(EXPR_CXX_NOEXCEPT);
1056 RECORD(EXPR_OPAQUE_VALUE);
Richard Smith01b2cb42014-07-26 06:37:51 +00001057 RECORD(EXPR_BINARY_CONDITIONAL_OPERATOR);
1058 RECORD(EXPR_TYPE_TRAIT);
1059 RECORD(EXPR_ARRAY_TYPE_TRAIT);
Douglas Gregor0beaec02011-02-08 16:34:17 +00001060 RECORD(EXPR_PACK_EXPANSION);
1061 RECORD(EXPR_SIZEOF_PACK);
Richard Smith01b2cb42014-07-26 06:37:51 +00001062 RECORD(EXPR_SUBST_NON_TYPE_TEMPLATE_PARM);
Douglas Gregor0beaec02011-02-08 16:34:17 +00001063 RECORD(EXPR_SUBST_NON_TYPE_TEMPLATE_PARM_PACK);
Richard Smith01b2cb42014-07-26 06:37:51 +00001064 RECORD(EXPR_FUNCTION_PARM_PACK);
1065 RECORD(EXPR_MATERIALIZE_TEMPORARY);
Peter Collingbourne41f85462011-02-09 21:07:24 +00001066 RECORD(EXPR_CUDA_KERNEL_CALL);
Richard Smith01b2cb42014-07-26 06:37:51 +00001067 RECORD(EXPR_CXX_UUIDOF_EXPR);
1068 RECORD(EXPR_CXX_UUIDOF_TYPE);
1069 RECORD(EXPR_LAMBDA);
Chris Lattnerccac3a62009-04-27 00:49:53 +00001070#undef RECORD
Chris Lattner28fa4e62009-04-26 22:26:21 +00001071}
Mike Stump11289f42009-09-09 15:08:12 +00001072
Sebastian Redl55c0ad52010-08-18 23:56:21 +00001073void ASTWriter::WriteBlockInfoBlock() {
Chris Lattner28fa4e62009-04-26 22:26:21 +00001074 RecordData Record;
Peter Collingbourned3a6c702016-11-01 01:18:57 +00001075 Stream.EnterBlockInfoBlock();
Mike Stump11289f42009-09-09 15:08:12 +00001076
Sebastian Redl539c5062010-08-18 23:57:32 +00001077#define BLOCK(X) EmitBlockID(X ## _ID, #X, Stream, Record)
1078#define RECORD(X) EmitRecordID(X, #X, Stream, Record)
Mike Stump11289f42009-09-09 15:08:12 +00001079
Douglas Gregor0aa21c92012-10-18 18:27:37 +00001080 // Control Block.
1081 BLOCK(CONTROL_BLOCK);
1082 RECORD(METADATA);
Ben Langmuirbeee15e2014-04-14 18:00:01 +00001083 RECORD(MODULE_NAME);
Richard Smithfa715652015-08-31 22:43:10 +00001084 RECORD(MODULE_DIRECTORY);
Ben Langmuirbeee15e2014-04-14 18:00:01 +00001085 RECORD(MODULE_MAP_FILE);
Douglas Gregor0aa21c92012-10-18 18:27:37 +00001086 RECORD(IMPORTS);
Douglas Gregorfad10d82012-10-18 18:36:53 +00001087 RECORD(ORIGINAL_FILE);
Douglas Gregor0aa21c92012-10-18 18:27:37 +00001088 RECORD(ORIGINAL_PCH_DIR);
Argyrios Kyrtzidis52595242012-11-15 18:57:27 +00001089 RECORD(ORIGINAL_FILE_ID);
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001090 RECORD(INPUT_FILE_OFFSETS);
Richard Smith0516b182015-09-08 19:40:14 +00001091
1092 BLOCK(OPTIONS_BLOCK);
1093 RECORD(LANGUAGE_OPTIONS);
1094 RECORD(TARGET_OPTIONS);
Douglas Gregorc6317db2012-10-24 15:49:58 +00001095 RECORD(FILE_SYSTEM_OPTIONS);
Douglas Gregor2d302362012-10-24 16:50:34 +00001096 RECORD(HEADER_SEARCH_OPTIONS);
Douglas Gregorb6af6c22012-10-24 20:05:57 +00001097 RECORD(PREPROCESSOR_OPTIONS);
1098
Douglas Gregor108cb222012-10-19 00:45:00 +00001099 BLOCK(INPUT_FILES_BLOCK);
1100 RECORD(INPUT_FILE);
1101
Douglas Gregor0aa21c92012-10-18 18:27:37 +00001102 // AST Top-Level Block.
1103 BLOCK(AST_BLOCK);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001104 RECORD(TYPE_OFFSET);
1105 RECORD(DECL_OFFSET);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001106 RECORD(IDENTIFIER_OFFSET);
1107 RECORD(IDENTIFIER_TABLE);
Ben Langmuir332aafe2014-01-31 01:06:56 +00001108 RECORD(EAGERLY_DESERIALIZED_DECLS);
David Blaikie9ffe5a32017-01-30 05:00:26 +00001109 RECORD(MODULAR_CODEGEN_DECLS);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001110 RECORD(SPECIAL_TYPES);
1111 RECORD(STATISTICS);
1112 RECORD(TENTATIVE_DEFINITIONS);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001113 RECORD(SELECTOR_OFFSETS);
1114 RECORD(METHOD_POOL);
1115 RECORD(PP_COUNTER_VALUE);
Douglas Gregor258ae542009-04-27 06:38:32 +00001116 RECORD(SOURCE_LOCATION_OFFSETS);
1117 RECORD(SOURCE_LOCATION_PRELOADS);
Douglas Gregor61cac2b2009-04-27 20:06:05 +00001118 RECORD(EXT_VECTOR_DECLS);
Richard Smithfa715652015-08-31 22:43:10 +00001119 RECORD(UNUSED_FILESCOPED_DECLS);
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00001120 RECORD(PPD_ENTITIES_OFFSETS);
Richard Smithfa715652015-08-31 22:43:10 +00001121 RECORD(VTABLE_USES);
Cameron Desrochersb60f1b62018-01-15 19:14:16 +00001122 RECORD(PPD_SKIPPED_RANGES);
Fariborz Jahanianc51609a2010-07-23 19:11:11 +00001123 RECORD(REFERENCED_SELECTOR_POOL);
Douglas Gregor0beaec02011-02-08 16:34:17 +00001124 RECORD(TU_UPDATE_LEXICAL);
Douglas Gregor0beaec02011-02-08 16:34:17 +00001125 RECORD(SEMA_DECL_REFS);
1126 RECORD(WEAK_UNDECLARED_IDENTIFIERS);
1127 RECORD(PENDING_IMPLICIT_INSTANTIATIONS);
Douglas Gregor0beaec02011-02-08 16:34:17 +00001128 RECORD(UPDATE_VISIBLE);
1129 RECORD(DECL_UPDATE_OFFSETS);
1130 RECORD(DECL_UPDATES);
Peter Collingbourne5df20e02011-02-15 19:46:30 +00001131 RECORD(CUDA_SPECIAL_DECL_REFS);
Douglas Gregor09b69892011-02-10 17:09:37 +00001132 RECORD(HEADER_SEARCH_TABLE);
Peter Collingbourne5df20e02011-02-15 19:46:30 +00001133 RECORD(FP_PRAGMA_OPTIONS);
1134 RECORD(OPENCL_EXTENSIONS);
Yaxun Liu5b746652016-12-18 05:18:55 +00001135 RECORD(OPENCL_EXTENSION_TYPES);
1136 RECORD(OPENCL_EXTENSION_DECLS);
Alexis Hunt27a761d2011-05-04 23:29:54 +00001137 RECORD(DELEGATING_CTORS);
Douglas Gregorc2fa1692011-06-28 16:20:02 +00001138 RECORD(KNOWN_NAMESPACES);
Douglas Gregor78d0b572011-08-04 16:39:39 +00001139 RECORD(MODULE_OFFSET_MAP);
1140 RECORD(SOURCE_MANAGER_LINE_TABLE);
Douglas Gregor404cdde2012-01-27 01:47:08 +00001141 RECORD(OBJC_CATEGORIES_MAP);
Douglas Gregor66e4add2011-12-19 21:09:25 +00001142 RECORD(FILE_SORTED_DECLS);
1143 RECORD(IMPORTED_MODULES);
Douglas Gregor404cdde2012-01-27 01:47:08 +00001144 RECORD(OBJC_CATEGORIES);
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00001145 RECORD(MACRO_OFFSET);
Richard Smithfa715652015-08-31 22:43:10 +00001146 RECORD(INTERESTING_IDENTIFIERS);
1147 RECORD(UNDEFINED_BUT_USED);
Richard Smithe40f2ba2013-08-07 21:41:30 +00001148 RECORD(LATE_PARSED_TEMPLATE);
Dario Domizioli13a0a382014-05-23 12:13:25 +00001149 RECORD(OPTIMIZE_PRAGMA_OPTIONS);
Nico Weber779355f2016-03-02 23:22:00 +00001150 RECORD(MSSTRUCT_PRAGMA_OPTIONS);
Nico Weber42932312016-03-03 00:17:35 +00001151 RECORD(POINTERS_TO_MEMBERS_PRAGMA_OPTIONS);
Richard Smithfa715652015-08-31 22:43:10 +00001152 RECORD(UNUSED_LOCAL_TYPEDEF_NAME_CANDIDATES);
Richard Smithfa715652015-08-31 22:43:10 +00001153 RECORD(DELETE_EXPRS_TO_ANALYZE);
Justin Lebar67a78a62016-10-08 22:15:58 +00001154 RECORD(CUDA_PRAGMA_FORCE_HOST_DEVICE_DEPTH);
Erik Verbruggenb34c79f2017-05-30 11:54:55 +00001155 RECORD(PP_CONDITIONAL_STACK);
Douglas Gregor358cd442012-01-15 16:58:34 +00001156
Chris Lattner28fa4e62009-04-26 22:26:21 +00001157 // SourceManager Block.
Chris Lattner64031982009-04-27 00:40:25 +00001158 BLOCK(SOURCE_MANAGER_BLOCK);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001159 RECORD(SM_SLOC_FILE_ENTRY);
1160 RECORD(SM_SLOC_BUFFER_ENTRY);
1161 RECORD(SM_SLOC_BUFFER_BLOB);
Richard Smithaada85c2016-02-06 02:06:43 +00001162 RECORD(SM_SLOC_BUFFER_BLOB_COMPRESSED);
Chandler Carruthf92ac9e2011-07-15 07:25:21 +00001163 RECORD(SM_SLOC_EXPANSION_ENTRY);
Mike Stump11289f42009-09-09 15:08:12 +00001164
Chris Lattner28fa4e62009-04-26 22:26:21 +00001165 // Preprocessor Block.
Chris Lattner64031982009-04-27 00:40:25 +00001166 BLOCK(PREPROCESSOR_BLOCK);
Richard Smithec216502015-02-13 19:48:37 +00001167 RECORD(PP_MACRO_DIRECTIVE_HISTORY);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001168 RECORD(PP_MACRO_FUNCTION_LIKE);
Richard Smithd7329392015-04-21 21:46:32 +00001169 RECORD(PP_MACRO_OBJECT_LIKE);
1170 RECORD(PP_MODULE_MACRO);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001171 RECORD(PP_TOKEN);
Richard Smithec216502015-02-13 19:48:37 +00001172
Richard Smithfa715652015-08-31 22:43:10 +00001173 // Submodule Block.
1174 BLOCK(SUBMODULE_BLOCK);
1175 RECORD(SUBMODULE_METADATA);
1176 RECORD(SUBMODULE_DEFINITION);
1177 RECORD(SUBMODULE_UMBRELLA_HEADER);
1178 RECORD(SUBMODULE_HEADER);
1179 RECORD(SUBMODULE_TOPHEADER);
1180 RECORD(SUBMODULE_UMBRELLA_DIR);
1181 RECORD(SUBMODULE_IMPORTS);
1182 RECORD(SUBMODULE_EXPORTS);
1183 RECORD(SUBMODULE_REQUIRES);
1184 RECORD(SUBMODULE_EXCLUDED_HEADER);
1185 RECORD(SUBMODULE_LINK_LIBRARY);
1186 RECORD(SUBMODULE_CONFIG_MACRO);
1187 RECORD(SUBMODULE_CONFLICT);
1188 RECORD(SUBMODULE_PRIVATE_HEADER);
1189 RECORD(SUBMODULE_TEXTUAL_HEADER);
1190 RECORD(SUBMODULE_PRIVATE_TEXTUAL_HEADER);
Richard Smithdc1f0422016-07-20 19:10:16 +00001191 RECORD(SUBMODULE_INITIALIZERS);
Douglas Gregorf0b11de2017-09-14 23:38:44 +00001192 RECORD(SUBMODULE_EXPORT_AS);
Richard Smithfa715652015-08-31 22:43:10 +00001193
1194 // Comments Block.
1195 BLOCK(COMMENTS_BLOCK);
1196 RECORD(COMMENTS_RAW_COMMENT);
1197
Douglas Gregor12bfa382009-10-17 00:13:19 +00001198 // Decls and Types block.
1199 BLOCK(DECLTYPES_BLOCK);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001200 RECORD(TYPE_EXT_QUAL);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001201 RECORD(TYPE_COMPLEX);
1202 RECORD(TYPE_POINTER);
1203 RECORD(TYPE_BLOCK_POINTER);
1204 RECORD(TYPE_LVALUE_REFERENCE);
1205 RECORD(TYPE_RVALUE_REFERENCE);
1206 RECORD(TYPE_MEMBER_POINTER);
1207 RECORD(TYPE_CONSTANT_ARRAY);
1208 RECORD(TYPE_INCOMPLETE_ARRAY);
1209 RECORD(TYPE_VARIABLE_ARRAY);
1210 RECORD(TYPE_VECTOR);
1211 RECORD(TYPE_EXT_VECTOR);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001212 RECORD(TYPE_FUNCTION_NO_PROTO);
Richard Smithf1b4b8b2014-07-27 04:29:04 +00001213 RECORD(TYPE_FUNCTION_PROTO);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001214 RECORD(TYPE_TYPEDEF);
1215 RECORD(TYPE_TYPEOF_EXPR);
1216 RECORD(TYPE_TYPEOF);
1217 RECORD(TYPE_RECORD);
1218 RECORD(TYPE_ENUM);
1219 RECORD(TYPE_OBJC_INTERFACE);
Steve Narofffb4330f2009-06-17 22:40:22 +00001220 RECORD(TYPE_OBJC_OBJECT_POINTER);
Douglas Gregor0beaec02011-02-08 16:34:17 +00001221 RECORD(TYPE_DECLTYPE);
1222 RECORD(TYPE_ELABORATED);
1223 RECORD(TYPE_SUBST_TEMPLATE_TYPE_PARM);
1224 RECORD(TYPE_UNRESOLVED_USING);
1225 RECORD(TYPE_INJECTED_CLASS_NAME);
1226 RECORD(TYPE_OBJC_OBJECT);
1227 RECORD(TYPE_TEMPLATE_TYPE_PARM);
1228 RECORD(TYPE_TEMPLATE_SPECIALIZATION);
1229 RECORD(TYPE_DEPENDENT_NAME);
1230 RECORD(TYPE_DEPENDENT_TEMPLATE_SPECIALIZATION);
1231 RECORD(TYPE_DEPENDENT_SIZED_ARRAY);
1232 RECORD(TYPE_PAREN);
Leonard Chanc72aaf62019-05-07 03:20:17 +00001233 RECORD(TYPE_MACRO_QUALIFIED);
Douglas Gregor0beaec02011-02-08 16:34:17 +00001234 RECORD(TYPE_PACK_EXPANSION);
1235 RECORD(TYPE_ATTRIBUTED);
1236 RECORD(TYPE_SUBST_TEMPLATE_TYPE_PARM_PACK);
Richard Smithf1b4b8b2014-07-27 04:29:04 +00001237 RECORD(TYPE_AUTO);
1238 RECORD(TYPE_UNARY_TRANSFORM);
Eli Friedman0dfb8892011-10-06 23:00:33 +00001239 RECORD(TYPE_ATOMIC);
Richard Smithf1b4b8b2014-07-27 04:29:04 +00001240 RECORD(TYPE_DECAYED);
1241 RECORD(TYPE_ADJUSTED);
Manman Rene6be26c2016-09-13 17:25:08 +00001242 RECORD(TYPE_OBJC_TYPE_PARAM);
Richard Smithd61d4ac2015-08-22 20:13:39 +00001243 RECORD(LOCAL_REDECLARATIONS);
Chris Lattnerdb397b62009-04-26 22:32:16 +00001244 RECORD(DECL_TYPEDEF);
Richard Smith01b2cb42014-07-26 06:37:51 +00001245 RECORD(DECL_TYPEALIAS);
Chris Lattnerdb397b62009-04-26 22:32:16 +00001246 RECORD(DECL_ENUM);
1247 RECORD(DECL_RECORD);
1248 RECORD(DECL_ENUM_CONSTANT);
1249 RECORD(DECL_FUNCTION);
1250 RECORD(DECL_OBJC_METHOD);
1251 RECORD(DECL_OBJC_INTERFACE);
1252 RECORD(DECL_OBJC_PROTOCOL);
1253 RECORD(DECL_OBJC_IVAR);
1254 RECORD(DECL_OBJC_AT_DEFS_FIELD);
Chris Lattnerdb397b62009-04-26 22:32:16 +00001255 RECORD(DECL_OBJC_CATEGORY);
1256 RECORD(DECL_OBJC_CATEGORY_IMPL);
1257 RECORD(DECL_OBJC_IMPLEMENTATION);
1258 RECORD(DECL_OBJC_COMPATIBLE_ALIAS);
1259 RECORD(DECL_OBJC_PROPERTY);
1260 RECORD(DECL_OBJC_PROPERTY_IMPL);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001261 RECORD(DECL_FIELD);
John McCall5e77d762013-04-16 07:28:30 +00001262 RECORD(DECL_MS_PROPERTY);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001263 RECORD(DECL_VAR);
Chris Lattnerdb397b62009-04-26 22:32:16 +00001264 RECORD(DECL_IMPLICIT_PARAM);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001265 RECORD(DECL_PARM_VAR);
Chris Lattnerdb397b62009-04-26 22:32:16 +00001266 RECORD(DECL_FILE_SCOPE_ASM);
1267 RECORD(DECL_BLOCK);
1268 RECORD(DECL_CONTEXT_LEXICAL);
1269 RECORD(DECL_CONTEXT_VISIBLE);
Douglas Gregor0beaec02011-02-08 16:34:17 +00001270 RECORD(DECL_NAMESPACE);
1271 RECORD(DECL_NAMESPACE_ALIAS);
1272 RECORD(DECL_USING);
1273 RECORD(DECL_USING_SHADOW);
1274 RECORD(DECL_USING_DIRECTIVE);
1275 RECORD(DECL_UNRESOLVED_USING_VALUE);
1276 RECORD(DECL_UNRESOLVED_USING_TYPENAME);
1277 RECORD(DECL_LINKAGE_SPEC);
1278 RECORD(DECL_CXX_RECORD);
1279 RECORD(DECL_CXX_METHOD);
1280 RECORD(DECL_CXX_CONSTRUCTOR);
1281 RECORD(DECL_CXX_DESTRUCTOR);
1282 RECORD(DECL_CXX_CONVERSION);
1283 RECORD(DECL_ACCESS_SPEC);
1284 RECORD(DECL_FRIEND);
1285 RECORD(DECL_FRIEND_TEMPLATE);
1286 RECORD(DECL_CLASS_TEMPLATE);
1287 RECORD(DECL_CLASS_TEMPLATE_SPECIALIZATION);
1288 RECORD(DECL_CLASS_TEMPLATE_PARTIAL_SPECIALIZATION);
Larisse Voufo39a1e502013-08-06 01:03:05 +00001289 RECORD(DECL_VAR_TEMPLATE);
1290 RECORD(DECL_VAR_TEMPLATE_SPECIALIZATION);
1291 RECORD(DECL_VAR_TEMPLATE_PARTIAL_SPECIALIZATION);
Douglas Gregor0beaec02011-02-08 16:34:17 +00001292 RECORD(DECL_FUNCTION_TEMPLATE);
1293 RECORD(DECL_TEMPLATE_TYPE_PARM);
1294 RECORD(DECL_NON_TYPE_TEMPLATE_PARM);
1295 RECORD(DECL_TEMPLATE_TEMPLATE_PARM);
Saar Razd7aae332019-07-10 21:25:49 +00001296 RECORD(DECL_CONCEPT);
Richard Smithefc884a2016-04-13 07:41:35 +00001297 RECORD(DECL_TYPE_ALIAS_TEMPLATE);
Douglas Gregor0beaec02011-02-08 16:34:17 +00001298 RECORD(DECL_STATIC_ASSERT);
1299 RECORD(DECL_CXX_BASE_SPECIFIERS);
Richard Smithefc884a2016-04-13 07:41:35 +00001300 RECORD(DECL_CXX_CTOR_INITIALIZERS);
Douglas Gregor0beaec02011-02-08 16:34:17 +00001301 RECORD(DECL_INDIRECTFIELD);
1302 RECORD(DECL_EXPANDED_NON_TYPE_TEMPLATE_PARM_PACK);
Richard Smithefc884a2016-04-13 07:41:35 +00001303 RECORD(DECL_EXPANDED_TEMPLATE_TEMPLATE_PARM_PACK);
1304 RECORD(DECL_CLASS_SCOPE_FUNCTION_SPECIALIZATION);
1305 RECORD(DECL_IMPORT);
1306 RECORD(DECL_OMP_THREADPRIVATE);
1307 RECORD(DECL_EMPTY);
1308 RECORD(DECL_OBJC_TYPE_PARAM);
1309 RECORD(DECL_OMP_CAPTUREDEXPR);
1310 RECORD(DECL_PRAGMA_COMMENT);
1311 RECORD(DECL_PRAGMA_DETECT_MISMATCH);
1312 RECORD(DECL_OMP_DECLARE_REDUCTION);
Alexey Bataev25ed0c02019-03-07 17:54:44 +00001313 RECORD(DECL_OMP_ALLOCATE);
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00001314
Douglas Gregor03412ba2011-06-03 02:27:19 +00001315 // Statements and Exprs can occur in the Decls and Types block.
1316 AddStmtsExprs(Stream, Record);
1317
Douglas Gregor92a96f52011-02-08 21:58:10 +00001318 BLOCK(PREPROCESSOR_DETAIL_BLOCK);
Chandler Carruthf92ac9e2011-07-15 07:25:21 +00001319 RECORD(PPD_MACRO_EXPANSION);
Douglas Gregor92a96f52011-02-08 21:58:10 +00001320 RECORD(PPD_MACRO_DEFINITION);
1321 RECORD(PPD_INCLUSION_DIRECTIVE);
Douglas Gregor6623e1f2015-11-03 18:33:07 +00001322
1323 // Decls and Types block.
1324 BLOCK(EXTENSION_BLOCK);
1325 RECORD(EXTENSION_METADATA);
1326
Duncan P. N. Exon Smith60fa2882017-03-13 18:45:08 +00001327 BLOCK(UNHASHED_CONTROL_BLOCK);
1328 RECORD(SIGNATURE);
1329 RECORD(DIAGNOSTIC_OPTIONS);
1330 RECORD(DIAG_PRAGMA_MAPPINGS);
1331
Chris Lattner28fa4e62009-04-26 22:26:21 +00001332#undef RECORD
1333#undef BLOCK
1334 Stream.ExitBlock();
1335}
1336
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001337/// Prepares a path for being written to an AST file by converting it
Richard Smith54cc3c22014-12-11 20:50:24 +00001338/// to an absolute path and removing nested './'s.
1339///
1340/// \return \c true if the path was changed.
Benjamin Kramer6a96ae52015-02-06 18:36:04 +00001341static bool cleanPathForOutput(FileManager &FileMgr,
1342 SmallVectorImpl<char> &Path) {
Argyrios Kyrtzidis403cbcb2015-07-31 01:39:23 +00001343 bool Changed = FileMgr.makeAbsolutePath(Path);
Mike Aizatskyaeb9dd92015-11-09 19:12:18 +00001344 return Changed | llvm::sys::path::remove_dots(Path);
Richard Smith54cc3c22014-12-11 20:50:24 +00001345}
1346
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001347/// Adjusts the given filename to only write out the portion of the
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001348/// filename that is not part of the system root directory.
Mike Stump11289f42009-09-09 15:08:12 +00001349///
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001350/// \param Filename the file name to adjust.
1351///
Richard Smith7ed1bc92014-12-05 22:42:13 +00001352/// \param BaseDir When non-NULL, the PCH file is a relocatable AST file and
1353/// the returned filename will be adjusted by this root directory.
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001354///
1355/// \returns either the original filename (if it needs no adjustment) or the
1356/// adjusted filename (which points into the @p Filename parameter).
Mike Stump11289f42009-09-09 15:08:12 +00001357static const char *
Richard Smith7ed1bc92014-12-05 22:42:13 +00001358adjustFilenameForRelocatableAST(const char *Filename, StringRef BaseDir) {
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001359 assert(Filename && "No file name to adjust?");
Mike Stump11289f42009-09-09 15:08:12 +00001360
Richard Smith7ed1bc92014-12-05 22:42:13 +00001361 if (BaseDir.empty())
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001362 return Filename;
Mike Stump11289f42009-09-09 15:08:12 +00001363
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001364 // Verify that the filename and the system root have the same prefix.
1365 unsigned Pos = 0;
Richard Smith7ed1bc92014-12-05 22:42:13 +00001366 for (; Filename[Pos] && Pos < BaseDir.size(); ++Pos)
1367 if (Filename[Pos] != BaseDir[Pos])
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001368 return Filename; // Prefixes don't match.
Mike Stump11289f42009-09-09 15:08:12 +00001369
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001370 // We hit the end of the filename before we hit the end of the system root.
1371 if (!Filename[Pos])
1372 return Filename;
Mike Stump11289f42009-09-09 15:08:12 +00001373
Richard Smith7ed1bc92014-12-05 22:42:13 +00001374 // If there's not a path separator at the end of the base directory nor
1375 // immediately after it, then this isn't within the base directory.
1376 if (!llvm::sys::path::is_separator(Filename[Pos])) {
1377 if (!llvm::sys::path::is_separator(BaseDir.back()))
1378 return Filename;
1379 } else {
1380 // If the file name has a '/' at the current position, skip over the '/'.
1381 // We distinguish relative paths from absolute paths by the
1382 // absence of '/' at the beginning of relative paths.
1383 //
1384 // FIXME: This is wrong. We distinguish them by asking if the path is
1385 // absolute, which isn't the same thing. And there might be multiple '/'s
1386 // in a row. Use a better mechanism to indicate whether we have emitted an
1387 // absolute or relative path.
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001388 ++Pos;
Richard Smith7ed1bc92014-12-05 22:42:13 +00001389 }
Mike Stump11289f42009-09-09 15:08:12 +00001390
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001391 return Filename + Pos;
1392}
Chris Lattner28fa4e62009-04-26 22:26:21 +00001393
Duncan P. N. Exon Smith60fa2882017-03-13 18:45:08 +00001394ASTFileSignature ASTWriter::createSignature(StringRef Bytes) {
1395 // Calculate the hash till start of UNHASHED_CONTROL_BLOCK.
1396 llvm::SHA1 Hasher;
1397 Hasher.update(ArrayRef<uint8_t>(Bytes.bytes_begin(), Bytes.size()));
1398 auto Hash = Hasher.result();
1399
1400 // Convert to an array [5*i32].
1401 ASTFileSignature Signature;
1402 auto LShift = [&](unsigned char Val, unsigned Shift) {
1403 return (uint32_t)Val << Shift;
1404 };
1405 for (int I = 0; I != 5; ++I)
1406 Signature[I] = LShift(Hash[I * 4 + 0], 24) | LShift(Hash[I * 4 + 1], 16) |
1407 LShift(Hash[I * 4 + 2], 8) | LShift(Hash[I * 4 + 3], 0);
1408
1409 return Signature;
1410}
1411
1412ASTFileSignature ASTWriter::writeUnhashedControlBlock(Preprocessor &PP,
1413 ASTContext &Context) {
1414 // Flush first to prepare the PCM hash (signature).
1415 Stream.FlushToWord();
1416 auto StartOfUnhashedControl = Stream.GetCurrentBitNo() >> 3;
1417
1418 // Enter the block and prepare to write records.
1419 RecordData Record;
1420 Stream.EnterSubblock(UNHASHED_CONTROL_BLOCK_ID, 5);
1421
1422 // For implicit modules, write the hash of the PCM as its signature.
1423 ASTFileSignature Signature;
1424 if (WritingModule &&
1425 PP.getHeaderSearchInfo().getHeaderSearchOpts().ModulesHashContent) {
1426 Signature = createSignature(StringRef(Buffer.begin(), StartOfUnhashedControl));
1427 Record.append(Signature.begin(), Signature.end());
1428 Stream.EmitRecord(SIGNATURE, Record);
1429 Record.clear();
Ben Langmuir487ea142014-10-23 18:05:36 +00001430 }
Duncan P. N. Exon Smith60fa2882017-03-13 18:45:08 +00001431
1432 // Diagnostic options.
1433 const auto &Diags = Context.getDiagnostics();
1434 const DiagnosticOptions &DiagOpts = Diags.getDiagnosticOptions();
1435#define DIAGOPT(Name, Bits, Default) Record.push_back(DiagOpts.Name);
1436#define ENUM_DIAGOPT(Name, Type, Bits, Default) \
1437 Record.push_back(static_cast<unsigned>(DiagOpts.get##Name()));
1438#include "clang/Basic/DiagnosticOptions.def"
1439 Record.push_back(DiagOpts.Warnings.size());
1440 for (unsigned I = 0, N = DiagOpts.Warnings.size(); I != N; ++I)
1441 AddString(DiagOpts.Warnings[I], Record);
1442 Record.push_back(DiagOpts.Remarks.size());
1443 for (unsigned I = 0, N = DiagOpts.Remarks.size(); I != N; ++I)
1444 AddString(DiagOpts.Remarks[I], Record);
1445 // Note: we don't serialize the log or serialization file names, because they
1446 // are generally transient files and will almost always be overridden.
1447 Stream.EmitRecord(DIAGNOSTIC_OPTIONS, Record);
1448
1449 // Write out the diagnostic/pragma mappings.
Rui Ueyama49a3ad22019-07-16 04:46:31 +00001450 WritePragmaDiagnosticMappings(Diags, /* isModule = */ WritingModule);
Duncan P. N. Exon Smith60fa2882017-03-13 18:45:08 +00001451
1452 // Leave the options block.
1453 Stream.ExitBlock();
1454 return Signature;
Ben Langmuir487ea142014-10-23 18:05:36 +00001455}
1456
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001457/// Write the control block.
Duncan P. N. Exon Smith60fa2882017-03-13 18:45:08 +00001458void ASTWriter::WriteControlBlock(Preprocessor &PP, ASTContext &Context,
1459 StringRef isysroot,
1460 const std::string &OutputFile) {
Douglas Gregorbfbde532009-04-10 21:16:55 +00001461 using namespace llvm;
Eugene Zelenkob7d89102017-11-11 00:08:50 +00001462
Douglas Gregor0aa21c92012-10-18 18:27:37 +00001463 Stream.EnterSubblock(CONTROL_BLOCK_ID, 5);
Mehdi Amini5ae4a852015-09-09 20:35:37 +00001464 RecordData Record;
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00001465
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001466 // Metadata
David Blaikieb44f0bf2017-01-04 22:36:43 +00001467 auto MetadataAbbrev = std::make_shared<BitCodeAbbrev>();
Douglas Gregor0aa21c92012-10-18 18:27:37 +00001468 MetadataAbbrev->Add(BitCodeAbbrevOp(METADATA));
1469 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 16)); // Major
1470 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 16)); // Minor
1471 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 16)); // Clang maj.
1472 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 16)); // Clang min.
1473 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Relocatable
Richard Smithe75ee0f2015-08-17 07:13:32 +00001474 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Timestamps
Hans Wennborg08c5a7b2018-06-25 13:23:49 +00001475 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // PCHHasObjectFile
Douglas Gregor0aa21c92012-10-18 18:27:37 +00001476 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Errors
1477 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // SVN branch/tag
David Blaikieb44f0bf2017-01-04 22:36:43 +00001478 unsigned MetadataAbbrevCode = Stream.EmitAbbrev(std::move(MetadataAbbrev));
Richard Smith7ed1bc92014-12-05 22:42:13 +00001479 assert((!WritingModule || isysroot.empty()) &&
1480 "writing module as a relocatable PCH?");
Mehdi Amini57a41912015-09-10 01:46:39 +00001481 {
Hans Wennborg08c5a7b2018-06-25 13:23:49 +00001482 RecordData::value_type Record[] = {
1483 METADATA,
1484 VERSION_MAJOR,
1485 VERSION_MINOR,
1486 CLANG_VERSION_MAJOR,
1487 CLANG_VERSION_MINOR,
1488 !isysroot.empty(),
1489 IncludeTimestamps,
1490 Context.getLangOpts().BuildingPCHWithObjectFile,
1491 ASTHasCompilerErrors};
Mehdi Amini57a41912015-09-10 01:46:39 +00001492 Stream.EmitRecordWithBlob(MetadataAbbrevCode, Record,
1493 getClangFullRepositoryVersion());
1494 }
Chandler Carruth885e78c2015-03-24 21:18:10 +00001495
Richard Smith8b706102017-05-31 20:56:55 +00001496 if (WritingModule) {
Richard Smith7ed1bc92014-12-05 22:42:13 +00001497 // Module name
David Blaikieb44f0bf2017-01-04 22:36:43 +00001498 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Ben Langmuirbeee15e2014-04-14 18:00:01 +00001499 Abbrev->Add(BitCodeAbbrevOp(MODULE_NAME));
1500 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
David Blaikieb44f0bf2017-01-04 22:36:43 +00001501 unsigned AbbrevCode = Stream.EmitAbbrev(std::move(Abbrev));
Mehdi Amini57a41912015-09-10 01:46:39 +00001502 RecordData::value_type Record[] = {MODULE_NAME};
Ben Langmuirbeee15e2014-04-14 18:00:01 +00001503 Stream.EmitRecordWithBlob(AbbrevCode, Record, WritingModule->Name);
1504 }
1505
Richard Smith7ed1bc92014-12-05 22:42:13 +00001506 if (WritingModule && WritingModule->Directory) {
Richard Smith7ed1bc92014-12-05 22:42:13 +00001507 SmallString<128> BaseDir(WritingModule->Directory->getName());
Richard Smith54cc3c22014-12-11 20:50:24 +00001508 cleanPathForOutput(Context.getSourceManager().getFileManager(), BaseDir);
Richard Smithf7b41372015-08-13 23:47:44 +00001509
1510 // If the home of the module is the current working directory, then we
1511 // want to pick up the cwd of the build process loading the module, not
1512 // our cwd, when we load this module.
1513 if (!PP.getHeaderSearchInfo()
1514 .getHeaderSearchOpts()
1515 .ModuleMapFileHomeIsCwd ||
1516 WritingModule->Directory->getName() != StringRef(".")) {
1517 // Module directory.
David Blaikieb44f0bf2017-01-04 22:36:43 +00001518 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Richard Smithf7b41372015-08-13 23:47:44 +00001519 Abbrev->Add(BitCodeAbbrevOp(MODULE_DIRECTORY));
1520 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Directory
David Blaikieb44f0bf2017-01-04 22:36:43 +00001521 unsigned AbbrevCode = Stream.EmitAbbrev(std::move(Abbrev));
Richard Smithf7b41372015-08-13 23:47:44 +00001522
Mehdi Amini57a41912015-09-10 01:46:39 +00001523 RecordData::value_type Record[] = {MODULE_DIRECTORY};
Richard Smithf7b41372015-08-13 23:47:44 +00001524 Stream.EmitRecordWithBlob(AbbrevCode, Record, BaseDir);
1525 }
Richard Smith7ed1bc92014-12-05 22:42:13 +00001526
1527 // Write out all other paths relative to the base directory if possible.
1528 BaseDirectory.assign(BaseDir.begin(), BaseDir.end());
1529 } else if (!isysroot.empty()) {
1530 // Write out paths relative to the sysroot if possible.
1531 BaseDirectory = isysroot;
1532 }
1533
Ben Langmuirbeee15e2014-04-14 18:00:01 +00001534 // Module map file
Richard Smithd19389a2017-07-05 07:47:11 +00001535 if (WritingModule && WritingModule->Kind == Module::ModuleMapModule) {
Mehdi Amini5ae4a852015-09-09 20:35:37 +00001536 Record.clear();
Ben Langmuirbeee15e2014-04-14 18:00:01 +00001537
Ben Langmuir4b8a9e92014-08-12 16:42:33 +00001538 auto &Map = PP.getHeaderSearchInfo().getModuleMap();
Richard Smith8b706102017-05-31 20:56:55 +00001539 AddPath(WritingModule->PresumedModuleMapFile.empty()
1540 ? Map.getModuleMapFileForUniquing(WritingModule)->getName()
1541 : StringRef(WritingModule->PresumedModuleMapFile),
1542 Record);
Ben Langmuir4b8a9e92014-08-12 16:42:33 +00001543
1544 // Additional module map files.
Richard Smith7ed1bc92014-12-05 22:42:13 +00001545 if (auto *AdditionalModMaps =
1546 Map.getAdditionalModuleMapFiles(WritingModule)) {
Ben Langmuir4b8a9e92014-08-12 16:42:33 +00001547 Record.push_back(AdditionalModMaps->size());
1548 for (const FileEntry *F : *AdditionalModMaps)
Richard Smith7ed1bc92014-12-05 22:42:13 +00001549 AddPath(F->getName(), Record);
Ben Langmuir4b8a9e92014-08-12 16:42:33 +00001550 } else {
1551 Record.push_back(0);
1552 }
1553
1554 Stream.EmitRecord(MODULE_MAP_FILE, Record);
Ben Langmuirbeee15e2014-04-14 18:00:01 +00001555 }
1556
Douglas Gregor112b9072012-10-18 05:31:06 +00001557 // Imports
Douglas Gregor29cc6422011-08-17 21:07:30 +00001558 if (Chain) {
Douglas Gregor29cc6422011-08-17 21:07:30 +00001559 serialization::ModuleManager &Mgr = Chain->getModuleManager();
Mehdi Amini5ae4a852015-09-09 20:35:37 +00001560 Record.clear();
Douglas Gregordf0c1512011-08-18 04:12:04 +00001561
Duncan P. N. Exon Smith96a06e02017-01-28 22:15:22 +00001562 for (ModuleFile &M : Mgr) {
Douglas Gregordf0c1512011-08-18 04:12:04 +00001563 // Skip modules that weren't directly imported.
Duncan P. N. Exon Smith96a06e02017-01-28 22:15:22 +00001564 if (!M.isDirectlyImported())
Douglas Gregordf0c1512011-08-18 04:12:04 +00001565 continue;
1566
Duncan P. N. Exon Smith96a06e02017-01-28 22:15:22 +00001567 Record.push_back((unsigned)M.Kind); // FIXME: Stable encoding
1568 AddSourceLocation(M.ImportLoc, Record);
Duncan P. N. Exon Smith60fa2882017-03-13 18:45:08 +00001569
1570 // If we have calculated signature, there is no need to store
1571 // the size or timestamp.
1572 Record.push_back(M.Signature ? 0 : M.File->getSize());
1573 Record.push_back(M.Signature ? 0 : getTimestampForOutput(M.File));
1574
1575 for (auto I : M.Signature)
1576 Record.push_back(I);
1577
Boris Kolpackovd30446f2017-08-31 06:26:43 +00001578 AddString(M.ModuleName, Record);
Duncan P. N. Exon Smith96a06e02017-01-28 22:15:22 +00001579 AddPath(M.FileName, Record);
Douglas Gregordf0c1512011-08-18 04:12:04 +00001580 }
Douglas Gregor29cc6422011-08-17 21:07:30 +00001581 Stream.EmitRecord(IMPORTS, Record);
1582 }
Mike Stump11289f42009-09-09 15:08:12 +00001583
Richard Smith0516b182015-09-08 19:40:14 +00001584 // Write the options block.
1585 Stream.EnterSubblock(OPTIONS_BLOCK_ID, 4);
1586
Douglas Gregor112b9072012-10-18 05:31:06 +00001587 // Language options.
Mehdi Amini5ae4a852015-09-09 20:35:37 +00001588 Record.clear();
Douglas Gregor112b9072012-10-18 05:31:06 +00001589 const LangOptions &LangOpts = Context.getLangOpts();
1590#define LANGOPT(Name, Bits, Default, Description) \
1591 Record.push_back(LangOpts.Name);
1592#define ENUM_LANGOPT(Name, Type, Bits, Default, Description) \
1593 Record.push_back(static_cast<unsigned>(LangOpts.get##Name()));
Alexey Samsonovedf99a92014-11-07 22:29:38 +00001594#include "clang/Basic/LangOptions.def"
1595#define SANITIZER(NAME, ID) \
1596 Record.push_back(LangOpts.Sanitize.has(SanitizerKind::ID));
Will Dietzf54319c2013-01-18 11:30:38 +00001597#include "clang/Basic/Sanitizers.def"
Douglas Gregor112b9072012-10-18 05:31:06 +00001598
Ben Langmuircd98cb72015-06-23 18:20:18 +00001599 Record.push_back(LangOpts.ModuleFeatures.size());
1600 for (StringRef Feature : LangOpts.ModuleFeatures)
1601 AddString(Feature, Record);
1602
Douglas Gregor112b9072012-10-18 05:31:06 +00001603 Record.push_back((unsigned) LangOpts.ObjCRuntime.getKind());
1604 AddVersionTuple(LangOpts.ObjCRuntime.getVersion(), Record);
Ben Langmuird4a667a2015-06-23 18:20:23 +00001605
1606 AddString(LangOpts.CurrentModule, Record);
Dmitri Gribenkoacf2e782013-02-22 14:21:27 +00001607
1608 // Comment options.
1609 Record.push_back(LangOpts.CommentOpts.BlockCommandNames.size());
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00001610 for (const auto &I : LangOpts.CommentOpts.BlockCommandNames) {
1611 AddString(I, Record);
Dmitri Gribenkoacf2e782013-02-22 14:21:27 +00001612 }
Dmitri Gribenkoa7d16ce2013-04-10 15:35:17 +00001613 Record.push_back(LangOpts.CommentOpts.ParseAllComments);
Dmitri Gribenkoacf2e782013-02-22 14:21:27 +00001614
Samuel Antaoee8fb302016-01-06 13:42:12 +00001615 // OpenMP offloading options.
1616 Record.push_back(LangOpts.OMPTargetTriples.size());
1617 for (auto &T : LangOpts.OMPTargetTriples)
1618 AddString(T.getTriple(), Record);
1619
1620 AddString(LangOpts.OMPHostIRFile, Record);
1621
Douglas Gregor112b9072012-10-18 05:31:06 +00001622 Stream.EmitRecord(LANGUAGE_OPTIONS, Record);
1623
Douglas Gregor4d3611c2012-10-18 17:58:09 +00001624 // Target options.
1625 Record.clear();
Douglas Gregor0aa21c92012-10-18 18:27:37 +00001626 const TargetInfo &Target = Context.getTargetInfo();
1627 const TargetOptions &TargetOpts = Target.getTargetOpts();
Douglas Gregor4d3611c2012-10-18 17:58:09 +00001628 AddString(TargetOpts.Triple, Record);
1629 AddString(TargetOpts.CPU, Record);
1630 AddString(TargetOpts.ABI, Record);
Douglas Gregor4d3611c2012-10-18 17:58:09 +00001631 Record.push_back(TargetOpts.FeaturesAsWritten.size());
1632 for (unsigned I = 0, N = TargetOpts.FeaturesAsWritten.size(); I != N; ++I) {
1633 AddString(TargetOpts.FeaturesAsWritten[I], Record);
1634 }
1635 Record.push_back(TargetOpts.Features.size());
1636 for (unsigned I = 0, N = TargetOpts.Features.size(); I != N; ++I) {
1637 AddString(TargetOpts.Features[I], Record);
1638 }
1639 Stream.EmitRecord(TARGET_OPTIONS, Record);
1640
Douglas Gregorc6317db2012-10-24 15:49:58 +00001641 // File system options.
1642 Record.clear();
Yaron Keren8dec46c2015-08-26 08:10:22 +00001643 const FileSystemOptions &FSOpts =
1644 Context.getSourceManager().getFileManager().getFileSystemOpts();
Douglas Gregorc6317db2012-10-24 15:49:58 +00001645 AddString(FSOpts.WorkingDir, Record);
1646 Stream.EmitRecord(FILE_SYSTEM_OPTIONS, Record);
1647
Douglas Gregor2d302362012-10-24 16:50:34 +00001648 // Header search options.
1649 Record.clear();
1650 const HeaderSearchOptions &HSOpts
1651 = PP.getHeaderSearchInfo().getHeaderSearchOpts();
1652 AddString(HSOpts.Sysroot, Record);
1653
1654 // Include entries.
1655 Record.push_back(HSOpts.UserEntries.size());
1656 for (unsigned I = 0, N = HSOpts.UserEntries.size(); I != N; ++I) {
1657 const HeaderSearchOptions::Entry &Entry = HSOpts.UserEntries[I];
1658 AddString(Entry.Path, Record);
1659 Record.push_back(static_cast<unsigned>(Entry.Group));
Douglas Gregor2d302362012-10-24 16:50:34 +00001660 Record.push_back(Entry.IsFramework);
1661 Record.push_back(Entry.IgnoreSysRoot);
Douglas Gregor2d302362012-10-24 16:50:34 +00001662 }
1663
1664 // System header prefixes.
1665 Record.push_back(HSOpts.SystemHeaderPrefixes.size());
1666 for (unsigned I = 0, N = HSOpts.SystemHeaderPrefixes.size(); I != N; ++I) {
1667 AddString(HSOpts.SystemHeaderPrefixes[I].Prefix, Record);
1668 Record.push_back(HSOpts.SystemHeaderPrefixes[I].IsSystemHeader);
1669 }
1670
1671 AddString(HSOpts.ResourceDir, Record);
1672 AddString(HSOpts.ModuleCachePath, Record);
Argyrios Kyrtzidis1594c152014-03-03 08:12:05 +00001673 AddString(HSOpts.ModuleUserBuildPath, Record);
Douglas Gregor2d302362012-10-24 16:50:34 +00001674 Record.push_back(HSOpts.DisableModuleHash);
Richard Smith18934752017-06-06 00:32:01 +00001675 Record.push_back(HSOpts.ImplicitModuleMaps);
1676 Record.push_back(HSOpts.ModuleMapFileHomeIsCwd);
Douglas Gregor2d302362012-10-24 16:50:34 +00001677 Record.push_back(HSOpts.UseBuiltinIncludes);
1678 Record.push_back(HSOpts.UseStandardSystemIncludes);
1679 Record.push_back(HSOpts.UseStandardCXXIncludes);
1680 Record.push_back(HSOpts.UseLibcxx);
Argyrios Kyrtzidisbd0b6512015-02-19 20:12:20 +00001681 // Write out the specific module cache path that contains the module files.
1682 AddString(PP.getHeaderSearchInfo().getModuleCachePath(), Record);
Douglas Gregor2d302362012-10-24 16:50:34 +00001683 Stream.EmitRecord(HEADER_SEARCH_OPTIONS, Record);
1684
Douglas Gregorb6af6c22012-10-24 20:05:57 +00001685 // Preprocessor options.
1686 Record.clear();
1687 const PreprocessorOptions &PPOpts = PP.getPreprocessorOpts();
1688
1689 // Macro definitions.
1690 Record.push_back(PPOpts.Macros.size());
1691 for (unsigned I = 0, N = PPOpts.Macros.size(); I != N; ++I) {
1692 AddString(PPOpts.Macros[I].first, Record);
1693 Record.push_back(PPOpts.Macros[I].second);
1694 }
1695
1696 // Includes
1697 Record.push_back(PPOpts.Includes.size());
1698 for (unsigned I = 0, N = PPOpts.Includes.size(); I != N; ++I)
1699 AddString(PPOpts.Includes[I], Record);
1700
1701 // Macro includes
1702 Record.push_back(PPOpts.MacroIncludes.size());
1703 for (unsigned I = 0, N = PPOpts.MacroIncludes.size(); I != N; ++I)
1704 AddString(PPOpts.MacroIncludes[I], Record);
1705
Douglas Gregorb6368752012-10-24 23:41:50 +00001706 Record.push_back(PPOpts.UsePredefines);
Argyrios Kyrtzidisd3afa0c2013-04-26 21:33:40 +00001707 // Detailed record is important since it is used for the module cache hash.
1708 Record.push_back(PPOpts.DetailedRecord);
Douglas Gregorb6af6c22012-10-24 20:05:57 +00001709 AddString(PPOpts.ImplicitPCHInclude, Record);
Douglas Gregorb6af6c22012-10-24 20:05:57 +00001710 Record.push_back(static_cast<unsigned>(PPOpts.ObjCXXARCStandardLibrary));
1711 Stream.EmitRecord(PREPROCESSOR_OPTIONS, Record);
1712
Richard Smith0516b182015-09-08 19:40:14 +00001713 // Leave the options block.
1714 Stream.ExitBlock();
1715
Douglas Gregora3b20262011-05-06 21:43:30 +00001716 // Original file name and file ID
Douglas Gregor45fe0362009-05-12 01:31:05 +00001717 SourceManager &SM = Context.getSourceManager();
1718 if (const FileEntry *MainFile = SM.getFileEntryForID(SM.getMainFileID())) {
David Blaikieb44f0bf2017-01-04 22:36:43 +00001719 auto FileAbbrev = std::make_shared<BitCodeAbbrev>();
Douglas Gregorfad10d82012-10-18 18:36:53 +00001720 FileAbbrev->Add(BitCodeAbbrevOp(ORIGINAL_FILE));
1721 FileAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // File ID
Douglas Gregor45fe0362009-05-12 01:31:05 +00001722 FileAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // File name
David Blaikieb44f0bf2017-01-04 22:36:43 +00001723 unsigned FileAbbrevCode = Stream.EmitAbbrev(std::move(FileAbbrev));
Douglas Gregor45fe0362009-05-12 01:31:05 +00001724
Douglas Gregorb6af6c22012-10-24 20:05:57 +00001725 Record.clear();
Douglas Gregorfad10d82012-10-18 18:36:53 +00001726 Record.push_back(ORIGINAL_FILE);
Douglas Gregora3b20262011-05-06 21:43:30 +00001727 Record.push_back(SM.getMainFileID().getOpaqueValue());
Richard Smith7ed1bc92014-12-05 22:42:13 +00001728 EmitRecordWithPath(FileAbbrevCode, Record, MainFile->getName());
Douglas Gregor45fe0362009-05-12 01:31:05 +00001729 }
Kovarththanan Rajaratnama9c81a82010-03-14 07:06:50 +00001730
Argyrios Kyrtzidis52595242012-11-15 18:57:27 +00001731 Record.clear();
1732 Record.push_back(SM.getMainFileID().getOpaqueValue());
1733 Stream.EmitRecord(ORIGINAL_FILE_ID, Record);
1734
Argyrios Kyrtzidis10b23682011-02-15 17:54:22 +00001735 // Original PCH directory
1736 if (!OutputFile.empty() && OutputFile != "-") {
David Blaikieb44f0bf2017-01-04 22:36:43 +00001737 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Argyrios Kyrtzidis10b23682011-02-15 17:54:22 +00001738 Abbrev->Add(BitCodeAbbrevOp(ORIGINAL_PCH_DIR));
1739 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // File name
David Blaikieb44f0bf2017-01-04 22:36:43 +00001740 unsigned AbbrevCode = Stream.EmitAbbrev(std::move(Abbrev));
Argyrios Kyrtzidis10b23682011-02-15 17:54:22 +00001741
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00001742 SmallString<128> OutputPath(OutputFile);
Argyrios Kyrtzidis10b23682011-02-15 17:54:22 +00001743
Argyrios Kyrtzidisc56419e2015-07-31 00:58:32 +00001744 SM.getFileManager().makeAbsolutePath(OutputPath);
Argyrios Kyrtzidis10b23682011-02-15 17:54:22 +00001745 StringRef origDir = llvm::sys::path::parent_path(OutputPath);
1746
Mehdi Amini57a41912015-09-10 01:46:39 +00001747 RecordData::value_type Record[] = {ORIGINAL_PCH_DIR};
Argyrios Kyrtzidis10b23682011-02-15 17:54:22 +00001748 Stream.EmitRecordWithBlob(AbbrevCode, Record, origDir);
1749 }
1750
Douglas Gregor49491f72013-03-15 22:15:07 +00001751 WriteInputFiles(Context.SourceMgr,
1752 PP.getHeaderSearchInfo().getHeaderSearchOpts(),
Douglas Gregora3dd9002013-07-22 20:48:33 +00001753 PP.getLangOpts().Modules);
Douglas Gregor72be3902012-10-19 00:38:02 +00001754 Stream.ExitBlock();
1755}
1756
Douglas Gregor49491f72013-03-15 22:15:07 +00001757namespace {
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +00001758
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001759/// An input file.
Eugene Zelenkob7d89102017-11-11 00:08:50 +00001760struct InputFileEntry {
1761 const FileEntry *File;
1762 bool IsSystemFile;
1763 bool IsTransient;
1764 bool BufferOverridden;
1765 bool IsTopLevelModuleMap;
1766};
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +00001767
Eugene Zelenkob7d89102017-11-11 00:08:50 +00001768} // namespace
Douglas Gregor49491f72013-03-15 22:15:07 +00001769
1770void ASTWriter::WriteInputFiles(SourceManager &SourceMgr,
1771 HeaderSearchOptions &HSOpts,
Douglas Gregora3dd9002013-07-22 20:48:33 +00001772 bool Modules) {
Douglas Gregor72be3902012-10-19 00:38:02 +00001773 using namespace llvm;
Eugene Zelenkob7d89102017-11-11 00:08:50 +00001774
Douglas Gregor72be3902012-10-19 00:38:02 +00001775 Stream.EnterSubblock(INPUT_FILES_BLOCK_ID, 4);
Mehdi Amini57a41912015-09-10 01:46:39 +00001776
Douglas Gregor72be3902012-10-19 00:38:02 +00001777 // Create input-file abbreviation.
David Blaikieb44f0bf2017-01-04 22:36:43 +00001778 auto IFAbbrev = std::make_shared<BitCodeAbbrev>();
Douglas Gregor72be3902012-10-19 00:38:02 +00001779 IFAbbrev->Add(BitCodeAbbrevOp(INPUT_FILE));
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001780 IFAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // ID
Douglas Gregor72be3902012-10-19 00:38:02 +00001781 IFAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 12)); // Size
1782 IFAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 32)); // Modification time
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001783 IFAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Overridden
Richard Smitha8cfffa2015-11-26 02:04:16 +00001784 IFAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Transient
Richard Smithf3f84612017-06-29 02:19:42 +00001785 IFAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Module map
Douglas Gregor72be3902012-10-19 00:38:02 +00001786 IFAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // File name
David Blaikieb44f0bf2017-01-04 22:36:43 +00001787 unsigned IFAbbrevCode = Stream.EmitAbbrev(std::move(IFAbbrev));
Douglas Gregor72be3902012-10-19 00:38:02 +00001788
Argyrios Kyrtzidis7d238572013-03-06 18:12:50 +00001789 // Get all ContentCache objects for files, sorted by whether the file is a
1790 // system one or not. System files go at the back, users files at the front.
Douglas Gregor49491f72013-03-15 22:15:07 +00001791 std::deque<InputFileEntry> SortedFiles;
Douglas Gregor72be3902012-10-19 00:38:02 +00001792 for (unsigned I = 1, N = SourceMgr.local_sloc_entry_size(); I != N; ++I) {
1793 // Get this source location entry.
1794 const SrcMgr::SLocEntry *SLoc = &SourceMgr.getLocalSLocEntry(I);
NAKAMURA Takumideca50f2012-10-19 01:53:57 +00001795 assert(&SourceMgr.getSLocEntry(FileID::get(I)) == SLoc);
Douglas Gregor72be3902012-10-19 00:38:02 +00001796
1797 // We only care about file entries that were not overridden.
1798 if (!SLoc->isFile())
1799 continue;
Richard Smithf3f84612017-06-29 02:19:42 +00001800 const SrcMgr::FileInfo &File = SLoc->getFile();
1801 const SrcMgr::ContentCache *Cache = File.getContentCache();
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001802 if (!Cache->OrigEntry)
Douglas Gregor72be3902012-10-19 00:38:02 +00001803 continue;
1804
Douglas Gregor49491f72013-03-15 22:15:07 +00001805 InputFileEntry Entry;
1806 Entry.File = Cache->OrigEntry;
1807 Entry.IsSystemFile = Cache->IsSystemFile;
Richard Smitha8cfffa2015-11-26 02:04:16 +00001808 Entry.IsTransient = Cache->IsTransient;
Douglas Gregor49491f72013-03-15 22:15:07 +00001809 Entry.BufferOverridden = Cache->BufferOverridden;
Richard Smithf3f84612017-06-29 02:19:42 +00001810 Entry.IsTopLevelModuleMap = isModuleMap(File.getFileCharacteristic()) &&
1811 File.getIncludeLoc().isInvalid();
Argyrios Kyrtzidis7d238572013-03-06 18:12:50 +00001812 if (Cache->IsSystemFile)
Douglas Gregor49491f72013-03-15 22:15:07 +00001813 SortedFiles.push_back(Entry);
Argyrios Kyrtzidis7d238572013-03-06 18:12:50 +00001814 else
Douglas Gregor49491f72013-03-15 22:15:07 +00001815 SortedFiles.push_front(Entry);
1816 }
1817
Argyrios Kyrtzidis7d238572013-03-06 18:12:50 +00001818 unsigned UserFilesNum = 0;
1819 // Write out all of the input files.
Richard Smithec216502015-02-13 19:48:37 +00001820 std::vector<uint64_t> InputFileOffsets;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00001821 for (const auto &Entry : SortedFiles) {
Douglas Gregor49491f72013-03-15 22:15:07 +00001822 uint32_t &InputFileID = InputFileIDs[Entry.File];
Argyrios Kyrtzidise65856f2012-12-11 07:48:08 +00001823 if (InputFileID != 0)
1824 continue; // already recorded this file.
1825
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001826 // Record this entry's offset.
1827 InputFileOffsets.push_back(Stream.GetCurrentBitNo());
Argyrios Kyrtzidise65856f2012-12-11 07:48:08 +00001828
1829 InputFileID = InputFileOffsets.size();
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001830
Douglas Gregor49491f72013-03-15 22:15:07 +00001831 if (!Entry.IsSystemFile)
Argyrios Kyrtzidis7d238572013-03-06 18:12:50 +00001832 ++UserFilesNum;
1833
Douglas Gregor72be3902012-10-19 00:38:02 +00001834 // Emit size/modification time for this file.
Mehdi Amini57a41912015-09-10 01:46:39 +00001835 // And whether this file was overridden.
1836 RecordData::value_type Record[] = {
Richard Smitha8cfffa2015-11-26 02:04:16 +00001837 INPUT_FILE,
1838 InputFileOffsets.size(),
1839 (uint64_t)Entry.File->getSize(),
1840 (uint64_t)getTimestampForOutput(Entry.File),
1841 Entry.BufferOverridden,
Richard Smithf3f84612017-06-29 02:19:42 +00001842 Entry.IsTransient,
1843 Entry.IsTopLevelModuleMap};
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001844
Richard Smith7ed1bc92014-12-05 22:42:13 +00001845 EmitRecordWithPath(IFAbbrevCode, Record, Entry.File->getName());
1846 }
Douglas Gregor49491f72013-03-15 22:15:07 +00001847
Douglas Gregor112b9072012-10-18 05:31:06 +00001848 Stream.ExitBlock();
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001849
1850 // Create input file offsets abbreviation.
David Blaikieb44f0bf2017-01-04 22:36:43 +00001851 auto OffsetsAbbrev = std::make_shared<BitCodeAbbrev>();
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001852 OffsetsAbbrev->Add(BitCodeAbbrevOp(INPUT_FILE_OFFSETS));
1853 OffsetsAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // # input files
Argyrios Kyrtzidis7d238572013-03-06 18:12:50 +00001854 OffsetsAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // # non-system
1855 // input files
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001856 OffsetsAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Array
David Blaikieb44f0bf2017-01-04 22:36:43 +00001857 unsigned OffsetsAbbrevCode = Stream.EmitAbbrev(std::move(OffsetsAbbrev));
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001858
1859 // Write input file offsets.
Mehdi Amini57a41912015-09-10 01:46:39 +00001860 RecordData::value_type Record[] = {INPUT_FILE_OFFSETS,
1861 InputFileOffsets.size(), UserFilesNum};
Reid Kleckner012665e2015-05-21 00:13:09 +00001862 Stream.EmitRecordWithBlob(OffsetsAbbrevCode, Record, bytes(InputFileOffsets));
Douglas Gregor55abb232009-04-10 20:39:37 +00001863}
1864
Douglas Gregora7f71a92009-04-10 03:52:48 +00001865//===----------------------------------------------------------------------===//
1866// Source Manager Serialization
1867//===----------------------------------------------------------------------===//
1868
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001869/// Create an abbreviation for the SLocEntry that refers to a
Douglas Gregora7f71a92009-04-10 03:52:48 +00001870/// file.
Douglas Gregor8f45df52009-04-16 22:23:12 +00001871static unsigned CreateSLocFileAbbrev(llvm::BitstreamWriter &Stream) {
Douglas Gregora7f71a92009-04-10 03:52:48 +00001872 using namespace llvm;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00001873
David Blaikieb44f0bf2017-01-04 22:36:43 +00001874 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Sebastian Redl539c5062010-08-18 23:57:32 +00001875 Abbrev->Add(BitCodeAbbrevOp(SM_SLOC_FILE_ENTRY));
Douglas Gregora7f71a92009-04-10 03:52:48 +00001876 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Offset
1877 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Include location
Richard Smithf3f84612017-06-29 02:19:42 +00001878 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 3)); // Characteristic
Douglas Gregora7f71a92009-04-10 03:52:48 +00001879 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Line directives
Douglas Gregorb41ca8f2010-03-21 22:49:54 +00001880 // FileEntry fields.
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001881 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Input File ID
Argyrios Kyrtzidis61ef3db2011-08-21 23:33:04 +00001882 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // NumCreatedFIDs
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00001883 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 24)); // FirstDeclIndex
1884 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // NumDecls
David Blaikieb44f0bf2017-01-04 22:36:43 +00001885 return Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregora7f71a92009-04-10 03:52:48 +00001886}
1887
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001888/// Create an abbreviation for the SLocEntry that refers to a
Douglas Gregora7f71a92009-04-10 03:52:48 +00001889/// buffer.
Douglas Gregor8f45df52009-04-16 22:23:12 +00001890static unsigned CreateSLocBufferAbbrev(llvm::BitstreamWriter &Stream) {
Douglas Gregora7f71a92009-04-10 03:52:48 +00001891 using namespace llvm;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00001892
David Blaikieb44f0bf2017-01-04 22:36:43 +00001893 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Sebastian Redl539c5062010-08-18 23:57:32 +00001894 Abbrev->Add(BitCodeAbbrevOp(SM_SLOC_BUFFER_ENTRY));
Douglas Gregora7f71a92009-04-10 03:52:48 +00001895 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Offset
1896 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Include location
Richard Smithf3f84612017-06-29 02:19:42 +00001897 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 3)); // Characteristic
Douglas Gregora7f71a92009-04-10 03:52:48 +00001898 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Line directives
1899 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Buffer name blob
David Blaikieb44f0bf2017-01-04 22:36:43 +00001900 return Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregora7f71a92009-04-10 03:52:48 +00001901}
1902
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001903/// Create an abbreviation for the SLocEntry that refers to a
Douglas Gregora7f71a92009-04-10 03:52:48 +00001904/// buffer's blob.
Richard Smithaada85c2016-02-06 02:06:43 +00001905static unsigned CreateSLocBufferBlobAbbrev(llvm::BitstreamWriter &Stream,
1906 bool Compressed) {
Douglas Gregora7f71a92009-04-10 03:52:48 +00001907 using namespace llvm;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00001908
David Blaikieb44f0bf2017-01-04 22:36:43 +00001909 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Richard Smithaada85c2016-02-06 02:06:43 +00001910 Abbrev->Add(BitCodeAbbrevOp(Compressed ? SM_SLOC_BUFFER_BLOB_COMPRESSED
1911 : SM_SLOC_BUFFER_BLOB));
1912 if (Compressed)
1913 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Uncompressed size
Douglas Gregora7f71a92009-04-10 03:52:48 +00001914 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Blob
David Blaikieb44f0bf2017-01-04 22:36:43 +00001915 return Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregora7f71a92009-04-10 03:52:48 +00001916}
1917
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001918/// Create an abbreviation for the SLocEntry that refers to a macro
Chandler Carruthf92ac9e2011-07-15 07:25:21 +00001919/// expansion.
1920static unsigned CreateSLocExpansionAbbrev(llvm::BitstreamWriter &Stream) {
Douglas Gregora7f71a92009-04-10 03:52:48 +00001921 using namespace llvm;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00001922
David Blaikieb44f0bf2017-01-04 22:36:43 +00001923 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Chandler Carruthf92ac9e2011-07-15 07:25:21 +00001924 Abbrev->Add(BitCodeAbbrevOp(SM_SLOC_EXPANSION_ENTRY));
Douglas Gregora7f71a92009-04-10 03:52:48 +00001925 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Offset
1926 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Spelling location
1927 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Start location
1928 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // End location
Richard Smithb5f81712018-04-30 05:25:48 +00001929 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Is token range
Douglas Gregor83243272009-04-15 18:05:10 +00001930 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Token length
David Blaikieb44f0bf2017-01-04 22:36:43 +00001931 return Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregora7f71a92009-04-10 03:52:48 +00001932}
1933
Douglas Gregor09b69892011-02-10 17:09:37 +00001934namespace {
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +00001935
Douglas Gregor09b69892011-02-10 17:09:37 +00001936 // Trait used for the on-disk hash table of header search information.
1937 class HeaderFileInfoTrait {
1938 ASTWriter &Writer;
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00001939
Douglas Gregor4b123cb2011-07-28 04:50:02 +00001940 // Keep track of the framework names we've used during serialization.
1941 SmallVector<char, 128> FrameworkStringData;
1942 llvm::StringMap<unsigned> FrameworkNameOffset;
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00001943
Douglas Gregor09b69892011-02-10 17:09:37 +00001944 public:
Richard Smith040e1262017-06-02 01:55:39 +00001945 HeaderFileInfoTrait(ASTWriter &Writer) : Writer(Writer) {}
1946
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +00001947 struct key_type {
Mehdi Amini004b9c72016-10-10 22:52:47 +00001948 StringRef Filename;
Richard Smith040e1262017-06-02 01:55:39 +00001949 off_t Size;
1950 time_t ModTime;
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +00001951 };
Eugene Zelenkob7d89102017-11-11 00:08:50 +00001952 using key_type_ref = const key_type &;
Richard Smith040e1262017-06-02 01:55:39 +00001953
1954 using UnresolvedModule =
1955 llvm::PointerIntPair<Module *, 2, ModuleMap::ModuleHeaderRole>;
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00001956
Richard Smith040e1262017-06-02 01:55:39 +00001957 struct data_type {
1958 const HeaderFileInfo &HFI;
1959 ArrayRef<ModuleMap::KnownHeader> KnownHeaders;
1960 UnresolvedModule Unresolved;
1961 };
Eugene Zelenkob7d89102017-11-11 00:08:50 +00001962 using data_type_ref = const data_type &;
Richard Smith040e1262017-06-02 01:55:39 +00001963
Eugene Zelenkob7d89102017-11-11 00:08:50 +00001964 using hash_value_type = unsigned;
1965 using offset_type = unsigned;
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00001966
Richard Smithe75ee0f2015-08-17 07:13:32 +00001967 hash_value_type ComputeHash(key_type_ref key) {
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +00001968 // The hash is based only on size/time of the file, so that the reader can
1969 // match even when symlinking or excess path elements ("foo/../", "../")
1970 // change the form of the name. However, complete path is still the key.
Richard Smith040e1262017-06-02 01:55:39 +00001971 return llvm::hash_combine(key.Size, key.ModTime);
Douglas Gregor09b69892011-02-10 17:09:37 +00001972 }
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00001973
Eugene Zelenkob7d89102017-11-11 00:08:50 +00001974 std::pair<unsigned, unsigned>
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +00001975 EmitKeyDataLength(raw_ostream& Out, key_type_ref key, data_type_ref Data) {
Justin Bognere1c147c2014-03-28 22:03:19 +00001976 using namespace llvm::support;
Eugene Zelenkob7d89102017-11-11 00:08:50 +00001977
Peter Collingbournee3f65292018-05-18 19:46:24 +00001978 endian::Writer LE(Out, little);
Mehdi Amini004b9c72016-10-10 22:52:47 +00001979 unsigned KeyLen = key.Filename.size() + 1 + 8 + 8;
Richard Smith386bb072015-08-18 23:42:23 +00001980 LE.write<uint16_t>(KeyLen);
Douglas Gregor4b123cb2011-07-28 04:50:02 +00001981 unsigned DataLen = 1 + 2 + 4 + 4;
Richard Smith040e1262017-06-02 01:55:39 +00001982 for (auto ModInfo : Data.KnownHeaders)
Richard Smith386bb072015-08-18 23:42:23 +00001983 if (Writer.getLocalOrImportedSubmoduleID(ModInfo.getModule()))
1984 DataLen += 4;
Richard Smith040e1262017-06-02 01:55:39 +00001985 if (Data.Unresolved.getPointer())
1986 DataLen += 4;
Richard Smith386bb072015-08-18 23:42:23 +00001987 LE.write<uint8_t>(DataLen);
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +00001988 return std::make_pair(KeyLen, DataLen);
Douglas Gregor09b69892011-02-10 17:09:37 +00001989 }
Richard Smith040e1262017-06-02 01:55:39 +00001990
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +00001991 void EmitKey(raw_ostream& Out, key_type_ref key, unsigned KeyLen) {
Justin Bognere1c147c2014-03-28 22:03:19 +00001992 using namespace llvm::support;
Eugene Zelenkob7d89102017-11-11 00:08:50 +00001993
Peter Collingbournee3f65292018-05-18 19:46:24 +00001994 endian::Writer LE(Out, little);
Richard Smith040e1262017-06-02 01:55:39 +00001995 LE.write<uint64_t>(key.Size);
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +00001996 KeyLen -= 8;
Richard Smith040e1262017-06-02 01:55:39 +00001997 LE.write<uint64_t>(key.ModTime);
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +00001998 KeyLen -= 8;
Mehdi Amini004b9c72016-10-10 22:52:47 +00001999 Out.write(key.Filename.data(), KeyLen);
Douglas Gregor09b69892011-02-10 17:09:37 +00002000 }
Richard Smith040e1262017-06-02 01:55:39 +00002001
Argyrios Kyrtzidisb146baa2013-03-13 21:13:51 +00002002 void EmitData(raw_ostream &Out, key_type_ref key,
Douglas Gregor09b69892011-02-10 17:09:37 +00002003 data_type_ref Data, unsigned DataLen) {
Justin Bognere1c147c2014-03-28 22:03:19 +00002004 using namespace llvm::support;
Eugene Zelenkob7d89102017-11-11 00:08:50 +00002005
Peter Collingbournee3f65292018-05-18 19:46:24 +00002006 endian::Writer LE(Out, little);
Douglas Gregor09b69892011-02-10 17:09:37 +00002007 uint64_t Start = Out.tell(); (void)Start;
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00002008
Richard Smithf3f84612017-06-29 02:19:42 +00002009 unsigned char Flags = (Data.HFI.isImport << 5)
2010 | (Data.HFI.isPragmaOnce << 4)
Richard Smith040e1262017-06-02 01:55:39 +00002011 | (Data.HFI.DirInfo << 1)
2012 | Data.HFI.IndexHeaderMapHeader;
Justin Bognere1c147c2014-03-28 22:03:19 +00002013 LE.write<uint8_t>(Flags);
Richard Smith040e1262017-06-02 01:55:39 +00002014 LE.write<uint16_t>(Data.HFI.NumIncludes);
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00002015
Richard Smith040e1262017-06-02 01:55:39 +00002016 if (!Data.HFI.ControllingMacro)
2017 LE.write<uint32_t>(Data.HFI.ControllingMacroID);
Douglas Gregor09b69892011-02-10 17:09:37 +00002018 else
Richard Smith040e1262017-06-02 01:55:39 +00002019 LE.write<uint32_t>(Writer.getIdentifierRef(Data.HFI.ControllingMacro));
2020
Douglas Gregor4b123cb2011-07-28 04:50:02 +00002021 unsigned Offset = 0;
Richard Smith040e1262017-06-02 01:55:39 +00002022 if (!Data.HFI.Framework.empty()) {
Douglas Gregor4b123cb2011-07-28 04:50:02 +00002023 // If this header refers into a framework, save the framework name.
2024 llvm::StringMap<unsigned>::iterator Pos
Richard Smith040e1262017-06-02 01:55:39 +00002025 = FrameworkNameOffset.find(Data.HFI.Framework);
Douglas Gregor4b123cb2011-07-28 04:50:02 +00002026 if (Pos == FrameworkNameOffset.end()) {
2027 Offset = FrameworkStringData.size() + 1;
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00002028 FrameworkStringData.append(Data.HFI.Framework.begin(),
Richard Smith040e1262017-06-02 01:55:39 +00002029 Data.HFI.Framework.end());
Douglas Gregor4b123cb2011-07-28 04:50:02 +00002030 FrameworkStringData.push_back(0);
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00002031
Richard Smith040e1262017-06-02 01:55:39 +00002032 FrameworkNameOffset[Data.HFI.Framework] = Offset;
Douglas Gregor4b123cb2011-07-28 04:50:02 +00002033 } else
2034 Offset = Pos->second;
2035 }
Justin Bognere1c147c2014-03-28 22:03:19 +00002036 LE.write<uint32_t>(Offset);
Argyrios Kyrtzidisb146baa2013-03-13 21:13:51 +00002037
Richard Smith040e1262017-06-02 01:55:39 +00002038 auto EmitModule = [&](Module *M, ModuleMap::ModuleHeaderRole Role) {
2039 if (uint32_t ModID = Writer.getLocalOrImportedSubmoduleID(M)) {
2040 uint32_t Value = (ModID << 2) | (unsigned)Role;
Richard Smith386bb072015-08-18 23:42:23 +00002041 assert((Value >> 2) == ModID && "overflow in header module info");
2042 LE.write<uint32_t>(Value);
2043 }
Richard Smith040e1262017-06-02 01:55:39 +00002044 };
2045
2046 // FIXME: If the header is excluded, we should write out some
2047 // record of that fact.
2048 for (auto ModInfo : Data.KnownHeaders)
2049 EmitModule(ModInfo.getModule(), ModInfo.getRole());
2050 if (Data.Unresolved.getPointer())
2051 EmitModule(Data.Unresolved.getPointer(), Data.Unresolved.getInt());
Argyrios Kyrtzidisb146baa2013-03-13 21:13:51 +00002052
Douglas Gregor09b69892011-02-10 17:09:37 +00002053 assert(Out.tell() - Start == DataLen && "Wrong data length");
2054 }
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00002055
Douglas Gregor4b123cb2011-07-28 04:50:02 +00002056 const char *strings_begin() const { return FrameworkStringData.begin(); }
2057 const char *strings_end() const { return FrameworkStringData.end(); }
Douglas Gregor09b69892011-02-10 17:09:37 +00002058 };
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +00002059
Eugene Zelenkob7d89102017-11-11 00:08:50 +00002060} // namespace
Douglas Gregor09b69892011-02-10 17:09:37 +00002061
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00002062/// Write the header search block for the list of files that
Douglas Gregor09b69892011-02-10 17:09:37 +00002063///
2064/// \param HS The header search structure to save.
Richard Smith7ed1bc92014-12-05 22:42:13 +00002065void ASTWriter::WriteHeaderSearch(const HeaderSearch &HS) {
Richard Smith040e1262017-06-02 01:55:39 +00002066 HeaderFileInfoTrait GeneratorTrait(*this);
2067 llvm::OnDiskChainedHashTableGenerator<HeaderFileInfoTrait> Generator;
2068 SmallVector<const char *, 4> SavedStrings;
2069 unsigned NumHeaderSearchEntries = 0;
2070
2071 // Find all unresolved headers for the current module. We generally will
2072 // have resolved them before we get here, but not necessarily: we might be
2073 // compiling a preprocessed module, where there is no requirement for the
2074 // original files to exist any more.
Benjamin Krameree021d52017-06-02 17:30:24 +00002075 const HeaderFileInfo Empty; // So we can take a reference.
Richard Smith040e1262017-06-02 01:55:39 +00002076 if (WritingModule) {
2077 llvm::SmallVector<Module *, 16> Worklist(1, WritingModule);
2078 while (!Worklist.empty()) {
2079 Module *M = Worklist.pop_back_val();
2080 if (!M->isAvailable())
2081 continue;
2082
2083 // Map to disk files where possible, to pick up any missing stat
2084 // information. This also means we don't need to check the unresolved
2085 // headers list when emitting resolved headers in the first loop below.
2086 // FIXME: It'd be preferable to avoid doing this if we were given
2087 // sufficient stat information in the module map.
2088 HS.getModuleMap().resolveHeaderDirectives(M);
2089
2090 // If the file didn't exist, we can still create a module if we were given
2091 // enough information in the module map.
2092 for (auto U : M->MissingHeaders) {
2093 // Check that we were given enough information to build a module
2094 // without this file existing on disk.
2095 if (!U.Size || (!U.ModTime && IncludeTimestamps)) {
2096 PP->Diag(U.FileNameLoc, diag::err_module_no_size_mtime_for_header)
2097 << WritingModule->getFullModuleName() << U.Size.hasValue()
2098 << U.FileName;
2099 continue;
2100 }
2101
2102 // Form the effective relative pathname for the file.
2103 SmallString<128> Filename(M->Directory->getName());
2104 llvm::sys::path::append(Filename, U.FileName);
2105 PreparePathForOutput(Filename);
2106
2107 StringRef FilenameDup = strdup(Filename.c_str());
2108 SavedStrings.push_back(FilenameDup.data());
2109
2110 HeaderFileInfoTrait::key_type Key = {
2111 FilenameDup, *U.Size, IncludeTimestamps ? *U.ModTime : 0
2112 };
2113 HeaderFileInfoTrait::data_type Data = {
Benjamin Krameree021d52017-06-02 17:30:24 +00002114 Empty, {}, {M, ModuleMap::headerKindToRole(U.Kind)}
Richard Smith040e1262017-06-02 01:55:39 +00002115 };
2116 // FIXME: Deal with cases where there are multiple unresolved header
2117 // directives in different submodules for the same header.
2118 Generator.insert(Key, Data, GeneratorTrait);
2119 ++NumHeaderSearchEntries;
2120 }
2121
2122 Worklist.append(M->submodule_begin(), M->submodule_end());
2123 }
2124 }
2125
Chris Lattner0e62c1c2011-07-23 10:55:15 +00002126 SmallVector<const FileEntry *, 16> FilesByUID;
Douglas Gregor09b69892011-02-10 17:09:37 +00002127 HS.getFileMgr().GetUniqueIDMapping(FilesByUID);
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00002128
Douglas Gregor09b69892011-02-10 17:09:37 +00002129 if (FilesByUID.size() > HS.header_file_size())
2130 FilesByUID.resize(HS.header_file_size());
Richard Smith040e1262017-06-02 01:55:39 +00002131
Douglas Gregor09b69892011-02-10 17:09:37 +00002132 for (unsigned UID = 0, LastUID = FilesByUID.size(); UID != LastUID; ++UID) {
2133 const FileEntry *File = FilesByUID[UID];
2134 if (!File)
2135 continue;
2136
Richard Smith386bb072015-08-18 23:42:23 +00002137 // Get the file info. This will load info from the external source if
2138 // necessary. Skip emitting this file if we have no information on it
2139 // as a header file (in which case HFI will be null) or if it hasn't
2140 // changed since it was loaded. Also skip it if it's for a modular header
2141 // from a different module; in that case, we rely on the module(s)
2142 // containing the header to provide this information.
Richard Smithd8879c82015-08-24 21:59:32 +00002143 const HeaderFileInfo *HFI =
2144 HS.getExistingFileInfo(File, /*WantExternal*/!Chain);
2145 if (!HFI || (HFI->isModuleHeader && !HFI->isCompilingModuleHeader))
Argyrios Kyrtzidis6f722b42013-05-08 23:46:46 +00002146 continue;
Douglas Gregor09b69892011-02-10 17:09:37 +00002147
Richard Smith7ed1bc92014-12-05 22:42:13 +00002148 // Massage the file path into an appropriate form.
Mehdi Amini004b9c72016-10-10 22:52:47 +00002149 StringRef Filename = File->getName();
Richard Smith7ed1bc92014-12-05 22:42:13 +00002150 SmallString<128> FilenameTmp(Filename);
2151 if (PreparePathForOutput(FilenameTmp)) {
2152 // If we performed any translation on the file name at all, we need to
2153 // save this string, since the generator will refer to it later.
Mehdi Amini004b9c72016-10-10 22:52:47 +00002154 Filename = StringRef(strdup(FilenameTmp.c_str()));
2155 SavedStrings.push_back(Filename.data());
Douglas Gregor09b69892011-02-10 17:09:37 +00002156 }
Richard Smith7ed1bc92014-12-05 22:42:13 +00002157
Richard Smith040e1262017-06-02 01:55:39 +00002158 HeaderFileInfoTrait::key_type Key = {
2159 Filename, File->getSize(), getTimestampForOutput(File)
2160 };
2161 HeaderFileInfoTrait::data_type Data = {
2162 *HFI, HS.getModuleMap().findAllModulesForHeader(File), {}
2163 };
2164 Generator.insert(Key, Data, GeneratorTrait);
Douglas Gregor09b69892011-02-10 17:09:37 +00002165 ++NumHeaderSearchEntries;
2166 }
Richard Smith040e1262017-06-02 01:55:39 +00002167
Douglas Gregor09b69892011-02-10 17:09:37 +00002168 // Create the on-disk hash table in a buffer.
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00002169 SmallString<4096> TableData;
Douglas Gregor09b69892011-02-10 17:09:37 +00002170 uint32_t BucketOffset;
2171 {
Justin Bognere1c147c2014-03-28 22:03:19 +00002172 using namespace llvm::support;
Eugene Zelenkob7d89102017-11-11 00:08:50 +00002173
Douglas Gregor09b69892011-02-10 17:09:37 +00002174 llvm::raw_svector_ostream Out(TableData);
2175 // Make sure that no bucket is at offset 0
Peter Collingbournee3f65292018-05-18 19:46:24 +00002176 endian::write<uint32_t>(Out, 0, little);
Douglas Gregor09b69892011-02-10 17:09:37 +00002177 BucketOffset = Generator.Emit(Out, GeneratorTrait);
2178 }
2179
2180 // Create a blob abbreviation
2181 using namespace llvm;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002182
David Blaikieb44f0bf2017-01-04 22:36:43 +00002183 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Douglas Gregor09b69892011-02-10 17:09:37 +00002184 Abbrev->Add(BitCodeAbbrevOp(HEADER_SEARCH_TABLE));
2185 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
2186 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
Douglas Gregor4b123cb2011-07-28 04:50:02 +00002187 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
Douglas Gregor09b69892011-02-10 17:09:37 +00002188 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
David Blaikieb44f0bf2017-01-04 22:36:43 +00002189 unsigned TableAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00002190
Douglas Gregor4b123cb2011-07-28 04:50:02 +00002191 // Write the header search table
Mehdi Amini57a41912015-09-10 01:46:39 +00002192 RecordData::value_type Record[] = {HEADER_SEARCH_TABLE, BucketOffset,
2193 NumHeaderSearchEntries, TableData.size()};
Douglas Gregor4b123cb2011-07-28 04:50:02 +00002194 TableData.append(GeneratorTrait.strings_begin(),GeneratorTrait.strings_end());
Yaron Keren92e1b622015-03-18 10:17:07 +00002195 Stream.EmitRecordWithBlob(TableAbbrev, Record, TableData);
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00002196
Douglas Gregor09b69892011-02-10 17:09:37 +00002197 // Free all of the strings we had to duplicate.
2198 for (unsigned I = 0, N = SavedStrings.size(); I != N; ++I)
David Greenebae0e352013-01-15 22:09:43 +00002199 free(const_cast<char *>(SavedStrings[I]));
Douglas Gregor09b69892011-02-10 17:09:37 +00002200}
2201
George Rimarc39f5492017-01-17 15:45:31 +00002202static void emitBlob(llvm::BitstreamWriter &Stream, StringRef Blob,
2203 unsigned SLocBufferBlobCompressedAbbrv,
2204 unsigned SLocBufferBlobAbbrv) {
Eugene Zelenkob7d89102017-11-11 00:08:50 +00002205 using RecordDataType = ASTWriter::RecordData::value_type;
George Rimarc39f5492017-01-17 15:45:31 +00002206
2207 // Compress the buffer if possible. We expect that almost all PCM
2208 // consumers will not want its contents.
2209 SmallString<0> CompressedBuffer;
2210 if (llvm::zlib::isAvailable()) {
2211 llvm::Error E = llvm::zlib::compress(Blob.drop_back(1), CompressedBuffer);
2212 if (!E) {
2213 RecordDataType Record[] = {SM_SLOC_BUFFER_BLOB_COMPRESSED,
2214 Blob.size() - 1};
2215 Stream.EmitRecordWithBlob(SLocBufferBlobCompressedAbbrv, Record,
2216 CompressedBuffer);
2217 return;
2218 }
2219 llvm::consumeError(std::move(E));
2220 }
2221
2222 RecordDataType Record[] = {SM_SLOC_BUFFER_BLOB};
2223 Stream.EmitRecordWithBlob(SLocBufferBlobAbbrv, Record, Blob);
2224}
2225
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00002226/// Writes the block containing the serialized form of the
Douglas Gregora7f71a92009-04-10 03:52:48 +00002227/// source manager.
2228///
2229/// TODO: We should probably use an on-disk hash table (stored in a
2230/// blob), indexed based on the file name, so that we only create
2231/// entries for files that we actually need. In the common case (no
2232/// errors), we probably won't have to create file entries for any of
2233/// the files in the AST.
Sebastian Redl55c0ad52010-08-18 23:56:21 +00002234void ASTWriter::WriteSourceManagerBlock(SourceManager &SourceMgr,
Richard Smith7ed1bc92014-12-05 22:42:13 +00002235 const Preprocessor &PP) {
Douglas Gregor258ae542009-04-27 06:38:32 +00002236 RecordData Record;
2237
Chris Lattner0910e3b2009-04-10 17:16:57 +00002238 // Enter the source manager block.
Richard Smithaada85c2016-02-06 02:06:43 +00002239 Stream.EnterSubblock(SOURCE_MANAGER_BLOCK_ID, 4);
Douglas Gregora7f71a92009-04-10 03:52:48 +00002240
2241 // Abbreviations for the various kinds of source-location entries.
Chris Lattnerc4976c732009-04-27 19:03:22 +00002242 unsigned SLocFileAbbrv = CreateSLocFileAbbrev(Stream);
2243 unsigned SLocBufferAbbrv = CreateSLocBufferAbbrev(Stream);
Richard Smithaada85c2016-02-06 02:06:43 +00002244 unsigned SLocBufferBlobAbbrv = CreateSLocBufferBlobAbbrev(Stream, false);
2245 unsigned SLocBufferBlobCompressedAbbrv =
2246 CreateSLocBufferBlobAbbrev(Stream, true);
Chandler Carruthf92ac9e2011-07-15 07:25:21 +00002247 unsigned SLocExpansionAbbrv = CreateSLocExpansionAbbrev(Stream);
Douglas Gregora7f71a92009-04-10 03:52:48 +00002248
Douglas Gregor258ae542009-04-27 06:38:32 +00002249 // Write out the source location entry table. We skip the first
2250 // entry, which is always the same dummy entry.
Chris Lattner12d61d32009-04-27 19:01:47 +00002251 std::vector<uint32_t> SLocEntryOffsets;
Douglas Gregor258ae542009-04-27 06:38:32 +00002252 RecordData PreloadSLocs;
Douglas Gregor925296b2011-07-19 16:10:42 +00002253 SLocEntryOffsets.reserve(SourceMgr.local_sloc_entry_size() - 1);
2254 for (unsigned I = 1, N = SourceMgr.local_sloc_entry_size();
Sebastian Redl5c415f32010-07-22 17:01:13 +00002255 I != N; ++I) {
Douglas Gregor8655e882009-10-16 22:46:09 +00002256 // Get this source location entry.
Douglas Gregor925296b2011-07-19 16:10:42 +00002257 const SrcMgr::SLocEntry *SLoc = &SourceMgr.getLocalSLocEntry(I);
Argyrios Kyrtzidis4db774a2012-10-02 21:09:17 +00002258 FileID FID = FileID::get(I);
2259 assert(&SourceMgr.getSLocEntry(FID) == SLoc);
Kovarththanan Rajaratnama9c81a82010-03-14 07:06:50 +00002260
Douglas Gregor258ae542009-04-27 06:38:32 +00002261 // Record the offset of this source-location entry.
2262 SLocEntryOffsets.push_back(Stream.GetCurrentBitNo());
2263
2264 // Figure out which record code to use.
2265 unsigned Code;
2266 if (SLoc->isFile()) {
Douglas Gregor9dc32122011-11-16 20:05:18 +00002267 const SrcMgr::ContentCache *Cache = SLoc->getFile().getContentCache();
2268 if (Cache->OrigEntry) {
Sebastian Redl539c5062010-08-18 23:57:32 +00002269 Code = SM_SLOC_FILE_ENTRY;
Argyrios Kyrtzidis92dd4662011-06-02 20:01:46 +00002270 } else
Sebastian Redl539c5062010-08-18 23:57:32 +00002271 Code = SM_SLOC_BUFFER_ENTRY;
Douglas Gregor258ae542009-04-27 06:38:32 +00002272 } else
Chandler Carruthf92ac9e2011-07-15 07:25:21 +00002273 Code = SM_SLOC_EXPANSION_ENTRY;
Douglas Gregor258ae542009-04-27 06:38:32 +00002274 Record.clear();
2275 Record.push_back(Code);
2276
Douglas Gregor925296b2011-07-19 16:10:42 +00002277 // Starting offset of this entry within this module, so skip the dummy.
2278 Record.push_back(SLoc->getOffset() - 2);
Douglas Gregor258ae542009-04-27 06:38:32 +00002279 if (SLoc->isFile()) {
2280 const SrcMgr::FileInfo &File = SLoc->getFile();
Richard Smithb22a1d12016-03-27 20:13:24 +00002281 AddSourceLocation(File.getIncludeLoc(), Record);
Douglas Gregor258ae542009-04-27 06:38:32 +00002282 Record.push_back(File.getFileCharacteristic()); // FIXME: stable encoding
2283 Record.push_back(File.hasLineDirectives());
2284
2285 const SrcMgr::ContentCache *Content = File.getContentCache();
Richard Smithaada85c2016-02-06 02:06:43 +00002286 bool EmitBlob = false;
Argyrios Kyrtzidis11e6f0a2011-03-05 01:03:53 +00002287 if (Content->OrigEntry) {
2288 assert(Content->OrigEntry == Content->ContentsEntry &&
Douglas Gregor9dc32122011-11-16 20:05:18 +00002289 "Writing to AST an overridden file is not supported");
Argyrios Kyrtzidis11e6f0a2011-03-05 01:03:53 +00002290
Douglas Gregor3120d2c2012-10-22 18:42:04 +00002291 // The source location entry is a file. Emit input file ID.
2292 assert(InputFileIDs[Content->OrigEntry] != 0 && "Missed file entry");
2293 Record.push_back(InputFileIDs[Content->OrigEntry]);
Mike Stump11289f42009-09-09 15:08:12 +00002294
Argyrios Kyrtzidis61ef3db2011-08-21 23:33:04 +00002295 Record.push_back(File.NumCreatedFIDs);
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00002296
Argyrios Kyrtzidis4db774a2012-10-02 21:09:17 +00002297 FileDeclIDsTy::iterator FDI = FileDeclIDs.find(FID);
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00002298 if (FDI != FileDeclIDs.end()) {
2299 Record.push_back(FDI->second->FirstDeclIndex);
2300 Record.push_back(FDI->second->DeclIDs.size());
2301 } else {
2302 Record.push_back(0);
2303 Record.push_back(0);
2304 }
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00002305
Mehdi Amini5ae4a852015-09-09 20:35:37 +00002306 Stream.EmitRecordWithAbbrev(SLocFileAbbrv, Record);
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00002307
Richard Smithaada85c2016-02-06 02:06:43 +00002308 if (Content->BufferOverridden || Content->IsTransient)
2309 EmitBlob = true;
Douglas Gregor258ae542009-04-27 06:38:32 +00002310 } else {
2311 // The source location entry is a buffer. The blob associated
2312 // with this entry contains the contents of the buffer.
2313
2314 // We add one to the size so that we capture the trailing NULL
2315 // that is required by llvm::MemoryBuffer::getMemBuffer (on
2316 // the reader side).
Douglas Gregor874cc622010-03-16 00:35:39 +00002317 const llvm::MemoryBuffer *Buffer
Chris Lattnerfb24a3a2010-04-20 20:35:58 +00002318 = Content->getBuffer(PP.getDiagnostics(), PP.getSourceManager());
Mehdi Amini99d1b292016-10-01 16:38:28 +00002319 StringRef Name = Buffer->getBufferIdentifier();
Mehdi Amini5ae4a852015-09-09 20:35:37 +00002320 Stream.EmitRecordWithBlob(SLocBufferAbbrv, Record,
Mehdi Amini99d1b292016-10-01 16:38:28 +00002321 StringRef(Name.data(), Name.size() + 1));
Richard Smithaada85c2016-02-06 02:06:43 +00002322 EmitBlob = true;
Douglas Gregor258ae542009-04-27 06:38:32 +00002323
Mehdi Amini99d1b292016-10-01 16:38:28 +00002324 if (Name == "<built-in>")
Douglas Gregor925296b2011-07-19 16:10:42 +00002325 PreloadSLocs.push_back(SLocEntryOffsets.size());
Douglas Gregor258ae542009-04-27 06:38:32 +00002326 }
Richard Smithaada85c2016-02-06 02:06:43 +00002327
2328 if (EmitBlob) {
2329 // Include the implicit terminating null character in the on-disk buffer
2330 // if we're writing it uncompressed.
2331 const llvm::MemoryBuffer *Buffer =
2332 Content->getBuffer(PP.getDiagnostics(), PP.getSourceManager());
2333 StringRef Blob(Buffer->getBufferStart(), Buffer->getBufferSize() + 1);
George Rimarc39f5492017-01-17 15:45:31 +00002334 emitBlob(Stream, Blob, SLocBufferBlobCompressedAbbrv,
2335 SLocBufferBlobAbbrv);
Richard Smithaada85c2016-02-06 02:06:43 +00002336 }
Douglas Gregor258ae542009-04-27 06:38:32 +00002337 } else {
Chandler Carruthf92ac9e2011-07-15 07:25:21 +00002338 // The source location entry is a macro expansion.
Chandler Carruthee4c1d12011-07-26 04:56:51 +00002339 const SrcMgr::ExpansionInfo &Expansion = SLoc->getExpansion();
Richard Smithb22a1d12016-03-27 20:13:24 +00002340 AddSourceLocation(Expansion.getSpellingLoc(), Record);
2341 AddSourceLocation(Expansion.getExpansionLocStart(), Record);
2342 AddSourceLocation(Expansion.isMacroArgExpansion()
2343 ? SourceLocation()
2344 : Expansion.getExpansionLocEnd(),
2345 Record);
Richard Smithb5f81712018-04-30 05:25:48 +00002346 Record.push_back(Expansion.isExpansionTokenRange());
Douglas Gregor258ae542009-04-27 06:38:32 +00002347
2348 // Compute the token length for this macro expansion.
Douglas Gregor925296b2011-07-19 16:10:42 +00002349 unsigned NextOffset = SourceMgr.getNextLocalOffset();
Douglas Gregor8655e882009-10-16 22:46:09 +00002350 if (I + 1 != N)
Douglas Gregor925296b2011-07-19 16:10:42 +00002351 NextOffset = SourceMgr.getLocalSLocEntry(I + 1).getOffset();
Douglas Gregor258ae542009-04-27 06:38:32 +00002352 Record.push_back(NextOffset - SLoc->getOffset() - 1);
Mehdi Amini5ae4a852015-09-09 20:35:37 +00002353 Stream.EmitRecordWithAbbrev(SLocExpansionAbbrv, Record);
Douglas Gregor258ae542009-04-27 06:38:32 +00002354 }
2355 }
2356
Douglas Gregor8f45df52009-04-16 22:23:12 +00002357 Stream.ExitBlock();
Douglas Gregor258ae542009-04-27 06:38:32 +00002358
2359 if (SLocEntryOffsets.empty())
2360 return;
2361
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00002362 // Write the source-location offsets table into the AST block. This
Douglas Gregor258ae542009-04-27 06:38:32 +00002363 // table is used for lazily loading source-location information.
2364 using namespace llvm;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002365
David Blaikieb44f0bf2017-01-04 22:36:43 +00002366 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Sebastian Redl539c5062010-08-18 23:57:32 +00002367 Abbrev->Add(BitCodeAbbrevOp(SOURCE_LOCATION_OFFSETS));
Douglas Gregor258ae542009-04-27 06:38:32 +00002368 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 16)); // # of slocs
Douglas Gregor925296b2011-07-19 16:10:42 +00002369 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 16)); // total size
Douglas Gregor258ae542009-04-27 06:38:32 +00002370 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // offsets
David Blaikieb44f0bf2017-01-04 22:36:43 +00002371 unsigned SLocOffsetsAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Mehdi Amini57a41912015-09-10 01:46:39 +00002372 {
2373 RecordData::value_type Record[] = {
2374 SOURCE_LOCATION_OFFSETS, SLocEntryOffsets.size(),
2375 SourceMgr.getNextLocalOffset() - 1 /* skip dummy */};
2376 Stream.EmitRecordWithBlob(SLocOffsetsAbbrev, Record,
2377 bytes(SLocEntryOffsets));
2378 }
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00002379 // Write the source location entry preloads array, telling the AST
Douglas Gregor258ae542009-04-27 06:38:32 +00002380 // reader which source locations entries it should load eagerly.
Sebastian Redl539c5062010-08-18 23:57:32 +00002381 Stream.EmitRecord(SOURCE_LOCATION_PRELOADS, PreloadSLocs);
Douglas Gregor925296b2011-07-19 16:10:42 +00002382
2383 // Write the line table. It depends on remapping working, so it must come
2384 // after the source location offsets.
2385 if (SourceMgr.hasLineTable()) {
2386 LineTableInfo &LineTable = SourceMgr.getLineTable();
2387
2388 Record.clear();
Richard Smith63078492015-09-01 07:41:55 +00002389
2390 // Emit the needed file names.
2391 llvm::DenseMap<int, int> FilenameMap;
Hans Wennborg14487362017-12-04 22:28:45 +00002392 FilenameMap[-1] = -1; // For unspecified filenames.
Richard Smith63078492015-09-01 07:41:55 +00002393 for (const auto &L : LineTable) {
2394 if (L.first.ID < 0)
2395 continue;
2396 for (auto &LE : L.second) {
2397 if (FilenameMap.insert(std::make_pair(LE.FilenameID,
Hans Wennborg14487362017-12-04 22:28:45 +00002398 FilenameMap.size() - 1)).second)
Richard Smith63078492015-09-01 07:41:55 +00002399 AddPath(LineTable.getFilename(LE.FilenameID), Record);
2400 }
2401 }
2402 Record.push_back(0);
Douglas Gregor925296b2011-07-19 16:10:42 +00002403
2404 // Emit the line entries
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002405 for (const auto &L : LineTable) {
Douglas Gregor925296b2011-07-19 16:10:42 +00002406 // Only emit entries for local files.
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002407 if (L.first.ID < 0)
Douglas Gregor925296b2011-07-19 16:10:42 +00002408 continue;
2409
2410 // Emit the file ID
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002411 Record.push_back(L.first.ID);
Douglas Gregor925296b2011-07-19 16:10:42 +00002412
2413 // Emit the line entries
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002414 Record.push_back(L.second.size());
2415 for (const auto &LE : L.second) {
2416 Record.push_back(LE.FileOffset);
2417 Record.push_back(LE.LineNo);
2418 Record.push_back(FilenameMap[LE.FilenameID]);
2419 Record.push_back((unsigned)LE.FileKind);
2420 Record.push_back(LE.IncludeOffset);
Douglas Gregor925296b2011-07-19 16:10:42 +00002421 }
2422 }
Richard Smith63078492015-09-01 07:41:55 +00002423
Douglas Gregor925296b2011-07-19 16:10:42 +00002424 Stream.EmitRecord(SOURCE_MANAGER_LINE_TABLE, Record);
2425 }
Douglas Gregora7f71a92009-04-10 03:52:48 +00002426}
2427
Douglas Gregorc5046832009-04-27 18:38:38 +00002428//===----------------------------------------------------------------------===//
2429// Preprocessor Serialization
2430//===----------------------------------------------------------------------===//
2431
Argyrios Kyrtzidis0aef0f02013-03-15 22:43:10 +00002432static bool shouldIgnoreMacro(MacroDirective *MD, bool IsModule,
2433 const Preprocessor &PP) {
Argyrios Kyrtzidisb6210df2013-03-26 17:17:01 +00002434 if (MacroInfo *MI = MD->getMacroInfo())
2435 if (MI->isBuiltinMacro())
2436 return true;
Argyrios Kyrtzidis0aef0f02013-03-15 22:43:10 +00002437
2438 if (IsModule) {
2439 SourceLocation Loc = MD->getLocation();
2440 if (Loc.isInvalid())
2441 return true;
2442 if (PP.getSourceManager().getFileID(Loc) == PP.getPredefinesFileID())
2443 return true;
2444 }
2445
2446 return false;
2447}
2448
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00002449/// Writes the block containing the serialized form of the
Chris Lattnereeffaef2009-04-10 17:15:23 +00002450/// preprocessor.
Douglas Gregor4a69c2e2011-09-01 17:04:32 +00002451void ASTWriter::WritePreprocessor(const Preprocessor &PP, bool IsModule) {
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002452 PreprocessingRecord *PPRec = PP.getPreprocessingRecord();
2453 if (PPRec)
2454 WritePreprocessorDetail(*PPRec);
2455
Chris Lattnerbaa52f42009-04-10 18:00:12 +00002456 RecordData Record;
Richard Smithd7329392015-04-21 21:46:32 +00002457 RecordData ModuleMacroRecord;
Chris Lattner0910e3b2009-04-10 17:16:57 +00002458
Chris Lattner0af3ba12009-04-13 01:29:17 +00002459 // If the preprocessor __COUNTER__ value has been bumped, remember it.
2460 if (PP.getCounterValue() != 0) {
Mehdi Amini57a41912015-09-10 01:46:39 +00002461 RecordData::value_type Record[] = {PP.getCounterValue()};
Sebastian Redl539c5062010-08-18 23:57:32 +00002462 Stream.EmitRecord(PP_COUNTER_VALUE, Record);
Douglas Gregoreda6a892009-04-26 00:07:37 +00002463 }
2464
Erik Verbruggenb34c79f2017-05-30 11:54:55 +00002465 if (PP.isRecordingPreamble() && PP.hasRecordedPreamble()) {
2466 assert(!IsModule);
Erik Verbruggen4d1eb2d2017-11-03 09:40:07 +00002467 auto SkipInfo = PP.getPreambleSkipInfo();
2468 if (SkipInfo.hasValue()) {
2469 Record.push_back(true);
2470 AddSourceLocation(SkipInfo->HashTokenLoc, Record);
2471 AddSourceLocation(SkipInfo->IfTokenLoc, Record);
2472 Record.push_back(SkipInfo->FoundNonSkipPortion);
2473 Record.push_back(SkipInfo->FoundElse);
2474 AddSourceLocation(SkipInfo->ElseLoc, Record);
2475 } else {
2476 Record.push_back(false);
2477 }
Erik Verbruggenb34c79f2017-05-30 11:54:55 +00002478 for (const auto &Cond : PP.getPreambleConditionalStack()) {
2479 AddSourceLocation(Cond.IfLoc, Record);
2480 Record.push_back(Cond.WasSkipping);
2481 Record.push_back(Cond.FoundNonSkip);
2482 Record.push_back(Cond.FoundElse);
2483 }
2484 Stream.EmitRecord(PP_CONDITIONAL_STACK, Record);
2485 Record.clear();
2486 }
2487
Douglas Gregoreda6a892009-04-26 00:07:37 +00002488 // Enter the preprocessor block.
Douglas Gregor796d76a2010-10-20 22:00:55 +00002489 Stream.EnterSubblock(PREPROCESSOR_BLOCK_ID, 3);
Mike Stump11289f42009-09-09 15:08:12 +00002490
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00002491 // If the AST file contains __DATE__ or __TIME__ emit a warning about this.
Richard Smithb5aaf5a2015-09-01 02:35:58 +00002492 // FIXME: Include a location for the use, and say which one was used.
Douglas Gregoreda6a892009-04-26 00:07:37 +00002493 if (PP.SawDateOrTime())
Richard Smithb5aaf5a2015-09-01 02:35:58 +00002494 PP.Diag(SourceLocation(), diag::warn_module_uses_date_time) << IsModule;
Douglas Gregor796d76a2010-10-20 22:00:55 +00002495
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002496 // Loop over all the macro directives that are live at the end of the file,
Chris Lattnerbaa52f42009-04-10 18:00:12 +00002497 // emitting each to the PP section.
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00002498
Richard Smithee977932015-05-01 21:22:17 +00002499 // Construct the list of identifiers with macro directives that need to be
2500 // serialized.
2501 SmallVector<const IdentifierInfo *, 128> MacroIdentifiers;
2502 for (auto &Id : PP.getIdentifierTable())
2503 if (Id.second->hadMacroDefinition() &&
2504 (!Id.second->isFromAST() ||
2505 Id.second->hasChangedSinceDeserialization()))
2506 MacroIdentifiers.push_back(Id.second);
Douglas Gregor2e5571d2011-02-10 18:20:09 +00002507 // Sort the set of macro definitions that need to be serialized by the
2508 // name of the macro, to provide a stable ordering.
Benjamin Kramercd2bae32019-08-22 17:32:16 +00002509 llvm::sort(MacroIdentifiers, llvm::deref<std::less<>>());
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002510
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002511 // Emit the macro directives as a list and associate the offset with the
2512 // identifier they belong to.
Richard Smithee977932015-05-01 21:22:17 +00002513 for (const IdentifierInfo *Name : MacroIdentifiers) {
2514 MacroDirective *MD = PP.getLocalMacroDirectiveHistory(Name);
Richard Smithd7329392015-04-21 21:46:32 +00002515 auto StartOffset = Stream.GetCurrentBitNo();
2516
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002517 // Emit the macro directives in reverse source order.
2518 for (; MD; MD = MD->getPrevious()) {
Richard Smithd7329392015-04-21 21:46:32 +00002519 // Once we hit an ignored macro, we're done: the rest of the chain
2520 // will all be ignored macros.
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002521 if (shouldIgnoreMacro(MD, IsModule, PP))
Richard Smithd7329392015-04-21 21:46:32 +00002522 break;
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002523
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002524 AddSourceLocation(MD->getLocation(), Record);
Argyrios Kyrtzidisb6210df2013-03-26 17:17:01 +00002525 Record.push_back(MD->getKind());
Richard Smithdaa69e02014-07-25 04:40:03 +00002526 if (auto *DefMD = dyn_cast<DefMacroDirective>(MD)) {
Richard Smith3981b172015-04-30 02:16:23 +00002527 Record.push_back(getMacroRef(DefMD->getInfo(), Name));
Richard Smith713369b2015-04-23 20:40:50 +00002528 } else if (auto *VisMD = dyn_cast<VisibilityMacroDirective>(MD)) {
Argyrios Kyrtzidisb6210df2013-03-26 17:17:01 +00002529 Record.push_back(VisMD->isPublic());
2530 }
Richard Smithb8b2ed62015-04-23 18:18:26 +00002531 }
Richard Smithd7329392015-04-21 21:46:32 +00002532
Richard Smithb8b2ed62015-04-23 18:18:26 +00002533 // Write out any exported module macros.
Richard Smithee977932015-05-01 21:22:17 +00002534 bool EmittedModuleMacros = false;
Manman Ren33d80292016-05-31 18:19:32 +00002535 // We write out exported module macros for PCH as well.
2536 auto Leafs = PP.getLeafModuleMacros(Name);
2537 SmallVector<ModuleMacro*, 8> Worklist(Leafs.begin(), Leafs.end());
2538 llvm::DenseMap<ModuleMacro*, unsigned> Visits;
2539 while (!Worklist.empty()) {
2540 auto *Macro = Worklist.pop_back_val();
Richard Smithd7329392015-04-21 21:46:32 +00002541
Manman Ren33d80292016-05-31 18:19:32 +00002542 // Emit a record indicating this submodule exports this macro.
2543 ModuleMacroRecord.push_back(
2544 getSubmoduleID(Macro->getOwningModule()));
2545 ModuleMacroRecord.push_back(getMacroRef(Macro->getMacroInfo(), Name));
2546 for (auto *M : Macro->overrides())
2547 ModuleMacroRecord.push_back(getSubmoduleID(M->getOwningModule()));
Richard Smithd7329392015-04-21 21:46:32 +00002548
Manman Ren33d80292016-05-31 18:19:32 +00002549 Stream.EmitRecord(PP_MODULE_MACRO, ModuleMacroRecord);
2550 ModuleMacroRecord.clear();
Richard Smithd7329392015-04-21 21:46:32 +00002551
Manman Ren33d80292016-05-31 18:19:32 +00002552 // Enqueue overridden macros once we've visited all their ancestors.
2553 for (auto *M : Macro->overrides())
2554 if (++Visits[M] == M->getNumOverridingMacros())
2555 Worklist.push_back(M);
Richard Smithee977932015-05-01 21:22:17 +00002556
Manman Ren33d80292016-05-31 18:19:32 +00002557 EmittedModuleMacros = true;
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002558 }
Richard Smithd7329392015-04-21 21:46:32 +00002559
Richard Smithee977932015-05-01 21:22:17 +00002560 if (Record.empty() && !EmittedModuleMacros)
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002561 continue;
2562
Richard Smithd7329392015-04-21 21:46:32 +00002563 IdentMacroDirectivesOffsetMap[Name] = StartOffset;
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002564 Stream.EmitRecord(PP_MACRO_DIRECTIVE_HISTORY, Record);
2565 Record.clear();
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002566 }
Alexander Kornienko1d26c022012-09-25 17:18:14 +00002567
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00002568 /// Offsets of each of the macros into the bitstream, indexed by
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00002569 /// the local macro ID
2570 ///
2571 /// For each identifier that is associated with a macro, this map
2572 /// provides the offset into the bitstream where that macro is
2573 /// defined.
2574 std::vector<uint32_t> MacroOffsets;
2575
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002576 for (unsigned I = 0, N = MacroInfosToEmit.size(); I != N; ++I) {
2577 const IdentifierInfo *Name = MacroInfosToEmit[I].Name;
2578 MacroInfo *MI = MacroInfosToEmit[I].MI;
2579 MacroID ID = MacroInfosToEmit[I].ID;
Douglas Gregoreb114da2010-10-01 01:03:07 +00002580
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002581 if (ID < FirstMacroID) {
2582 assert(0 && "Loaded MacroInfo entered MacroInfosToEmit ?");
2583 continue;
Chris Lattner2199f5b2009-04-10 18:08:30 +00002584 }
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002585
2586 // Record the local offset of this macro.
2587 unsigned Index = ID - FirstMacroID;
2588 if (Index == MacroOffsets.size())
2589 MacroOffsets.push_back(Stream.GetCurrentBitNo());
2590 else {
2591 if (Index > MacroOffsets.size())
2592 MacroOffsets.resize(Index + 1);
2593
2594 MacroOffsets[Index] = Stream.GetCurrentBitNo();
2595 }
2596
2597 AddIdentifierRef(Name, Record);
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002598 AddSourceLocation(MI->getDefinitionLoc(), Record);
2599 AddSourceLocation(MI->getDefinitionEndLoc(), Record);
2600 Record.push_back(MI->isUsed());
Argyrios Kyrtzidis9ef53ce2014-04-09 18:21:23 +00002601 Record.push_back(MI->isUsedForHeaderGuard());
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002602 unsigned Code;
2603 if (MI->isObjectLike()) {
2604 Code = PP_MACRO_OBJECT_LIKE;
2605 } else {
2606 Code = PP_MACRO_FUNCTION_LIKE;
2607
2608 Record.push_back(MI->isC99Varargs());
2609 Record.push_back(MI->isGNUVarargs());
2610 Record.push_back(MI->hasCommaPasting());
Faisal Valiac506d72017-07-17 17:18:43 +00002611 Record.push_back(MI->getNumParams());
2612 for (const IdentifierInfo *Param : MI->params())
2613 AddIdentifierRef(Param, Record);
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002614 }
2615
2616 // If we have a detailed preprocessing record, record the macro definition
2617 // ID that corresponds to this macro.
2618 if (PPRec)
2619 Record.push_back(MacroDefinitions[PPRec->findMacroDefinition(MI)]);
2620
2621 Stream.EmitRecord(Code, Record);
2622 Record.clear();
2623
2624 // Emit the tokens array.
2625 for (unsigned TokNo = 0, e = MI->getNumTokens(); TokNo != e; ++TokNo) {
2626 // Note that we know that the preprocessor does not have any annotation
2627 // tokens in it because they are created by the parser, and thus can't
2628 // be in a macro definition.
2629 const Token &Tok = MI->getReplacementToken(TokNo);
John McCallf413f5e2013-05-03 00:10:13 +00002630 AddToken(Tok, Record);
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002631 Stream.EmitRecord(PP_TOKEN, Record);
2632 Record.clear();
2633 }
2634 ++NumMacros;
Chris Lattnerbaa52f42009-04-10 18:00:12 +00002635 }
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002636
Douglas Gregor92a96f52011-02-08 21:58:10 +00002637 Stream.ExitBlock();
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00002638
2639 // Write the offsets table for macro IDs.
2640 using namespace llvm;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002641
David Blaikieb44f0bf2017-01-04 22:36:43 +00002642 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00002643 Abbrev->Add(BitCodeAbbrevOp(MACRO_OFFSET));
2644 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // # of macros
2645 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // first ID
2646 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
2647
David Blaikieb44f0bf2017-01-04 22:36:43 +00002648 unsigned MacroOffsetAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Mehdi Amini57a41912015-09-10 01:46:39 +00002649 {
2650 RecordData::value_type Record[] = {MACRO_OFFSET, MacroOffsets.size(),
2651 FirstMacroID - NUM_PREDEF_MACRO_IDS};
2652 Stream.EmitRecordWithBlob(MacroOffsetAbbrev, Record, bytes(MacroOffsets));
2653 }
Douglas Gregor92a96f52011-02-08 21:58:10 +00002654}
2655
2656void ASTWriter::WritePreprocessorDetail(PreprocessingRecord &PPRec) {
Argyrios Kyrtzidis7f448362011-09-19 20:40:42 +00002657 if (PPRec.local_begin() == PPRec.local_end())
Douglas Gregor92a96f52011-02-08 21:58:10 +00002658 return;
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002659
Argyrios Kyrtzidis64f63812011-09-19 20:40:25 +00002660 SmallVector<PPEntityOffset, 64> PreprocessedEntityOffsets;
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002661
Douglas Gregor92a96f52011-02-08 21:58:10 +00002662 // Enter the preprocessor block.
2663 Stream.EnterSubblock(PREPROCESSOR_DETAIL_BLOCK_ID, 3);
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00002664
Douglas Gregoraae92242010-03-19 21:51:54 +00002665 // If the preprocessor has a preprocessing record, emit it.
2666 unsigned NumPreprocessingRecords = 0;
Douglas Gregor92a96f52011-02-08 21:58:10 +00002667 using namespace llvm;
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00002668
2669 // Set up the abbreviation for
Douglas Gregor92a96f52011-02-08 21:58:10 +00002670 unsigned InclusionAbbrev = 0;
2671 {
David Blaikieb44f0bf2017-01-04 22:36:43 +00002672 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Douglas Gregor92a96f52011-02-08 21:58:10 +00002673 Abbrev->Add(BitCodeAbbrevOp(PPD_INCLUSION_DIRECTIVE));
Douglas Gregor92a96f52011-02-08 21:58:10 +00002674 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // filename length
2675 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // in quotes
2676 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 2)); // kind
Argyrios Kyrtzidisf590e092012-10-02 16:10:46 +00002677 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // imported module
Douglas Gregor92a96f52011-02-08 21:58:10 +00002678 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
David Blaikieb44f0bf2017-01-04 22:36:43 +00002679 InclusionAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregor92a96f52011-02-08 21:58:10 +00002680 }
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00002681
2682 unsigned FirstPreprocessorEntityID
2683 = (Chain ? PPRec.getNumLoadedPreprocessedEntities() : 0)
Douglas Gregor2f555fc2011-08-04 18:56:47 +00002684 + NUM_PREDEF_PP_ENTITY_IDS;
2685 unsigned NextPreprocessorEntityID = FirstPreprocessorEntityID;
Douglas Gregor92a96f52011-02-08 21:58:10 +00002686 RecordData Record;
Argyrios Kyrtzidis7f448362011-09-19 20:40:42 +00002687 for (PreprocessingRecord::iterator E = PPRec.local_begin(),
2688 EEnd = PPRec.local_end();
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00002689 E != EEnd;
Douglas Gregor0d4b4312011-08-04 17:06:18 +00002690 (void)++E, ++NumPreprocessingRecords, ++NextPreprocessorEntityID) {
Douglas Gregor92a96f52011-02-08 21:58:10 +00002691 Record.clear();
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00002692
Richard Smith66a81862015-05-04 02:25:31 +00002693 PreprocessedEntityOffsets.push_back(
2694 PPEntityOffset((*E)->getSourceRange(), Stream.GetCurrentBitNo()));
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002695
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002696 if (auto *MD = dyn_cast<MacroDefinitionRecord>(*E)) {
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002697 // Record this macro definition's ID.
2698 MacroDefinitions[MD] = NextPreprocessorEntityID;
Richard Smith66a81862015-05-04 02:25:31 +00002699
Douglas Gregor92a96f52011-02-08 21:58:10 +00002700 AddIdentifierRef(MD->getName(), Record);
Douglas Gregor92a96f52011-02-08 21:58:10 +00002701 Stream.EmitRecord(PPD_MACRO_DEFINITION, Record);
2702 continue;
Douglas Gregoraae92242010-03-19 21:51:54 +00002703 }
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00002704
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002705 if (auto *ME = dyn_cast<MacroExpansion>(*E)) {
Argyrios Kyrtzidis80f78b92011-09-08 17:18:41 +00002706 Record.push_back(ME->isBuiltinMacro());
2707 if (ME->isBuiltinMacro())
2708 AddIdentifierRef(ME->getName(), Record);
2709 else
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002710 Record.push_back(MacroDefinitions[ME->getDefinition()]);
Chandler Carruthf92ac9e2011-07-15 07:25:21 +00002711 Stream.EmitRecord(PPD_MACRO_EXPANSION, Record);
Douglas Gregor92a96f52011-02-08 21:58:10 +00002712 continue;
2713 }
2714
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002715 if (auto *ID = dyn_cast<InclusionDirective>(*E)) {
Douglas Gregor92a96f52011-02-08 21:58:10 +00002716 Record.push_back(PPD_INCLUSION_DIRECTIVE);
Douglas Gregor92a96f52011-02-08 21:58:10 +00002717 Record.push_back(ID->getFileName().size());
2718 Record.push_back(ID->wasInQuotes());
2719 Record.push_back(static_cast<unsigned>(ID->getKind()));
Argyrios Kyrtzidisf590e092012-10-02 16:10:46 +00002720 Record.push_back(ID->importedModule());
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00002721 SmallString<64> Buffer;
Douglas Gregor92a96f52011-02-08 21:58:10 +00002722 Buffer += ID->getFileName();
Argyrios Kyrtzidis8dbcfc32012-03-08 01:08:28 +00002723 // Check that the FileEntry is not null because it was not resolved and
2724 // we create a PCH even with compiler errors.
2725 if (ID->getFile())
2726 Buffer += ID->getFile()->getName();
Mehdi Amini5ae4a852015-09-09 20:35:37 +00002727 Stream.EmitRecordWithBlob(InclusionAbbrev, Record, Buffer);
Douglas Gregor92a96f52011-02-08 21:58:10 +00002728 continue;
2729 }
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00002730
Douglas Gregor92a96f52011-02-08 21:58:10 +00002731 llvm_unreachable("Unhandled PreprocessedEntity in ASTWriter");
2732 }
Douglas Gregor8f45df52009-04-16 22:23:12 +00002733 Stream.ExitBlock();
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00002734
Douglas Gregoraae92242010-03-19 21:51:54 +00002735 // Write the offsets table for the preprocessing record.
2736 if (NumPreprocessingRecords > 0) {
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002737 assert(PreprocessedEntityOffsets.size() == NumPreprocessingRecords);
2738
Douglas Gregoraae92242010-03-19 21:51:54 +00002739 // Write the offsets table for identifier IDs.
2740 using namespace llvm;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002741
David Blaikieb44f0bf2017-01-04 22:36:43 +00002742 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002743 Abbrev->Add(BitCodeAbbrevOp(PPD_ENTITIES_OFFSETS));
Douglas Gregor2f555fc2011-08-04 18:56:47 +00002744 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // first pp entity
Douglas Gregoraae92242010-03-19 21:51:54 +00002745 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
David Blaikieb44f0bf2017-01-04 22:36:43 +00002746 unsigned PPEOffsetAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00002747
Mehdi Amini57a41912015-09-10 01:46:39 +00002748 RecordData::value_type Record[] = {PPD_ENTITIES_OFFSETS,
2749 FirstPreprocessorEntityID -
2750 NUM_PREDEF_PP_ENTITY_IDS};
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002751 Stream.EmitRecordWithBlob(PPEOffsetAbbrev, Record,
Reid Kleckner012665e2015-05-21 00:13:09 +00002752 bytes(PreprocessedEntityOffsets));
Douglas Gregoraae92242010-03-19 21:51:54 +00002753 }
Cameron Desrochersb60f1b62018-01-15 19:14:16 +00002754
2755 // Write the skipped region table for the preprocessing record.
2756 ArrayRef<SourceRange> SkippedRanges = PPRec.getSkippedRanges();
2757 if (SkippedRanges.size() > 0) {
2758 std::vector<PPSkippedRange> SerializedSkippedRanges;
2759 SerializedSkippedRanges.reserve(SkippedRanges.size());
2760 for (auto const& Range : SkippedRanges)
2761 SerializedSkippedRanges.emplace_back(Range);
2762
2763 using namespace llvm;
2764 auto Abbrev = std::make_shared<BitCodeAbbrev>();
2765 Abbrev->Add(BitCodeAbbrevOp(PPD_SKIPPED_RANGES));
2766 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
2767 unsigned PPESkippedRangeAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
2768
2769 Record.clear();
2770 Record.push_back(PPD_SKIPPED_RANGES);
2771 Stream.EmitRecordWithBlob(PPESkippedRangeAbbrev, Record,
2772 bytes(SerializedSkippedRanges));
2773 }
Chris Lattnereeffaef2009-04-10 17:15:23 +00002774}
2775
Richard Smith386bb072015-08-18 23:42:23 +00002776unsigned ASTWriter::getLocalOrImportedSubmoduleID(Module *Mod) {
Richard Smith080056b2015-08-18 21:53:42 +00002777 if (!Mod)
2778 return 0;
2779
Douglas Gregora89c5ac2011-12-06 01:10:29 +00002780 llvm::DenseMap<Module *, unsigned>::iterator Known = SubmoduleIDs.find(Mod);
2781 if (Known != SubmoduleIDs.end())
2782 return Known->second;
Richard Smith386bb072015-08-18 23:42:23 +00002783
Richard Smithdc1f0422016-07-20 19:10:16 +00002784 auto *Top = Mod->getTopLevelModule();
2785 if (Top != WritingModule &&
Bruno Cardoso Lopes17da34d2017-02-07 21:54:57 +00002786 (getLangOpts().CompilingPCH ||
2787 !Top->fullModuleNameIs(StringRef(getLangOpts().CurrentModule))))
Richard Smith386bb072015-08-18 23:42:23 +00002788 return 0;
2789
Douglas Gregora89c5ac2011-12-06 01:10:29 +00002790 return SubmoduleIDs[Mod] = NextSubmoduleID++;
2791}
2792
Richard Smith386bb072015-08-18 23:42:23 +00002793unsigned ASTWriter::getSubmoduleID(Module *Mod) {
2794 // FIXME: This can easily happen, if we have a reference to a submodule that
2795 // did not result in us loading a module file for that submodule. For
2796 // instance, a cross-top-level-module 'conflict' declaration will hit this.
2797 unsigned ID = getLocalOrImportedSubmoduleID(Mod);
2798 assert((ID || !Mod) &&
2799 "asked for module ID for non-local, non-imported module");
2800 return ID;
Argyrios Kyrtzidisb146baa2013-03-13 21:13:51 +00002801}
2802
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00002803/// Compute the number of modules within the given tree (including the
Douglas Gregor253eefe2011-12-01 00:59:36 +00002804/// given module).
2805static unsigned getNumberOfModules(Module *Mod) {
2806 unsigned ChildModules = 0;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002807 for (auto Sub = Mod->submodule_begin(), SubEnd = Mod->submodule_end();
Douglas Gregor253eefe2011-12-01 00:59:36 +00002808 Sub != SubEnd; ++Sub)
Douglas Gregoreb90e832012-01-04 23:32:19 +00002809 ChildModules += getNumberOfModules(*Sub);
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00002810
Douglas Gregor253eefe2011-12-01 00:59:36 +00002811 return ChildModules + 1;
2812}
2813
Douglas Gregorde3ef502011-11-30 23:21:26 +00002814void ASTWriter::WriteSubmodules(Module *WritingModule) {
Douglas Gregor69021972011-11-30 17:33:56 +00002815 // Enter the submodule description block.
Richard Smith202210b2014-10-24 20:23:01 +00002816 Stream.EnterSubblock(SUBMODULE_BLOCK_ID, /*bits for abbreviations*/5);
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00002817
Douglas Gregor69021972011-11-30 17:33:56 +00002818 // Write the abbreviations needed for the submodules block.
2819 using namespace llvm;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002820
David Blaikieb44f0bf2017-01-04 22:36:43 +00002821 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Douglas Gregor69021972011-11-30 17:33:56 +00002822 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_DEFINITION));
Douglas Gregora89c5ac2011-12-06 01:10:29 +00002823 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // ID
Douglas Gregor69021972011-11-30 17:33:56 +00002824 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Parent
Richard Smithdd8b5332017-09-04 05:37:53 +00002825 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 2)); // Kind
Douglas Gregor69021972011-11-30 17:33:56 +00002826 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // IsFramework
2827 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // IsExplicit
Richard Smith9bca2982014-03-08 00:03:56 +00002828 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // IsSystem
2829 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // IsExternC
Douglas Gregora686e1b2012-01-27 19:52:33 +00002830 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // InferSubmodules...
Douglas Gregor73441092011-12-05 22:27:44 +00002831 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // InferExplicit...
Douglas Gregor73441092011-12-05 22:27:44 +00002832 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // InferExportWild...
Douglas Gregor35b13ec2013-03-20 00:22:05 +00002833 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // ConfigMacrosExh...
Jordan Rose90b0a1f2018-04-20 17:16:04 +00002834 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // ModuleMapIsPriv...
Douglas Gregor69021972011-11-30 17:33:56 +00002835 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
David Blaikieb44f0bf2017-01-04 22:36:43 +00002836 unsigned DefinitionAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregor69021972011-11-30 17:33:56 +00002837
David Blaikieb44f0bf2017-01-04 22:36:43 +00002838 Abbrev = std::make_shared<BitCodeAbbrev>();
Douglas Gregor524e33e2011-12-08 19:11:24 +00002839 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_UMBRELLA_HEADER));
Douglas Gregor69021972011-11-30 17:33:56 +00002840 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
David Blaikieb44f0bf2017-01-04 22:36:43 +00002841 unsigned UmbrellaAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregor69021972011-11-30 17:33:56 +00002842
David Blaikieb44f0bf2017-01-04 22:36:43 +00002843 Abbrev = std::make_shared<BitCodeAbbrev>();
Douglas Gregor69021972011-11-30 17:33:56 +00002844 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_HEADER));
2845 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
David Blaikieb44f0bf2017-01-04 22:36:43 +00002846 unsigned HeaderAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregor524e33e2011-12-08 19:11:24 +00002847
David Blaikieb44f0bf2017-01-04 22:36:43 +00002848 Abbrev = std::make_shared<BitCodeAbbrev>();
Argyrios Kyrtzidisc597c8c2012-10-05 00:22:33 +00002849 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_TOPHEADER));
2850 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
David Blaikieb44f0bf2017-01-04 22:36:43 +00002851 unsigned TopHeaderAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Argyrios Kyrtzidisc597c8c2012-10-05 00:22:33 +00002852
David Blaikieb44f0bf2017-01-04 22:36:43 +00002853 Abbrev = std::make_shared<BitCodeAbbrev>();
Douglas Gregor524e33e2011-12-08 19:11:24 +00002854 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_UMBRELLA_DIR));
2855 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
David Blaikieb44f0bf2017-01-04 22:36:43 +00002856 unsigned UmbrellaDirAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregor524e33e2011-12-08 19:11:24 +00002857
David Blaikieb44f0bf2017-01-04 22:36:43 +00002858 Abbrev = std::make_shared<BitCodeAbbrev>();
Douglas Gregor1fb5c3a2011-12-31 04:05:44 +00002859 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_REQUIRES));
Richard Smitha3feee22013-10-28 22:18:19 +00002860 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // State
2861 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Feature
David Blaikieb44f0bf2017-01-04 22:36:43 +00002862 unsigned RequiresAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregor1fb5c3a2011-12-31 04:05:44 +00002863
David Blaikieb44f0bf2017-01-04 22:36:43 +00002864 Abbrev = std::make_shared<BitCodeAbbrev>();
Douglas Gregor59527662012-10-15 06:28:11 +00002865 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_EXCLUDED_HEADER));
2866 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
David Blaikieb44f0bf2017-01-04 22:36:43 +00002867 unsigned ExcludedHeaderAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregor59527662012-10-15 06:28:11 +00002868
David Blaikieb44f0bf2017-01-04 22:36:43 +00002869 Abbrev = std::make_shared<BitCodeAbbrev>();
Richard Smith306d8922014-10-22 23:50:56 +00002870 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_TEXTUAL_HEADER));
2871 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
David Blaikieb44f0bf2017-01-04 22:36:43 +00002872 unsigned TextualHeaderAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Richard Smith306d8922014-10-22 23:50:56 +00002873
David Blaikieb44f0bf2017-01-04 22:36:43 +00002874 Abbrev = std::make_shared<BitCodeAbbrev>();
Lawrence Crowlb53e5482013-06-20 21:14:14 +00002875 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_PRIVATE_HEADER));
2876 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
David Blaikieb44f0bf2017-01-04 22:36:43 +00002877 unsigned PrivateHeaderAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Lawrence Crowlb53e5482013-06-20 21:14:14 +00002878
David Blaikieb44f0bf2017-01-04 22:36:43 +00002879 Abbrev = std::make_shared<BitCodeAbbrev>();
Richard Smith202210b2014-10-24 20:23:01 +00002880 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_PRIVATE_TEXTUAL_HEADER));
2881 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
David Blaikieb44f0bf2017-01-04 22:36:43 +00002882 unsigned PrivateTextualHeaderAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Richard Smith202210b2014-10-24 20:23:01 +00002883
David Blaikieb44f0bf2017-01-04 22:36:43 +00002884 Abbrev = std::make_shared<BitCodeAbbrev>();
Douglas Gregor6ddfca92013-01-14 17:21:00 +00002885 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_LINK_LIBRARY));
2886 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // IsFramework
2887 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
David Blaikieb44f0bf2017-01-04 22:36:43 +00002888 unsigned LinkLibraryAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregor6ddfca92013-01-14 17:21:00 +00002889
David Blaikieb44f0bf2017-01-04 22:36:43 +00002890 Abbrev = std::make_shared<BitCodeAbbrev>();
Douglas Gregor35b13ec2013-03-20 00:22:05 +00002891 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_CONFIG_MACRO));
2892 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Macro name
David Blaikieb44f0bf2017-01-04 22:36:43 +00002893 unsigned ConfigMacroAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregor35b13ec2013-03-20 00:22:05 +00002894
David Blaikieb44f0bf2017-01-04 22:36:43 +00002895 Abbrev = std::make_shared<BitCodeAbbrev>();
Douglas Gregorfb912652013-03-20 21:10:35 +00002896 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_CONFLICT));
2897 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Other module
2898 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Message
David Blaikieb44f0bf2017-01-04 22:36:43 +00002899 unsigned ConflictAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregorfb912652013-03-20 21:10:35 +00002900
Douglas Gregorf0b11de2017-09-14 23:38:44 +00002901 Abbrev = std::make_shared<BitCodeAbbrev>();
2902 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_EXPORT_AS));
2903 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Macro name
2904 unsigned ExportAsAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
2905
Douglas Gregor253eefe2011-12-01 00:59:36 +00002906 // Write the submodule metadata block.
Richard Smith145e15a2017-04-24 23:12:30 +00002907 RecordData::value_type Record[] = {
2908 getNumberOfModules(WritingModule),
Richard Smithdd8b5332017-09-04 05:37:53 +00002909 FirstSubmoduleID - NUM_PREDEF_SUBMODULE_IDS};
Douglas Gregor253eefe2011-12-01 00:59:36 +00002910 Stream.EmitRecord(SUBMODULE_METADATA, Record);
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00002911
Douglas Gregor69021972011-11-30 17:33:56 +00002912 // Write all of the submodules.
Douglas Gregorde3ef502011-11-30 23:21:26 +00002913 std::queue<Module *> Q;
Douglas Gregor69021972011-11-30 17:33:56 +00002914 Q.push(WritingModule);
Douglas Gregor69021972011-11-30 17:33:56 +00002915 while (!Q.empty()) {
Douglas Gregorde3ef502011-11-30 23:21:26 +00002916 Module *Mod = Q.front();
Douglas Gregor69021972011-11-30 17:33:56 +00002917 Q.pop();
Douglas Gregora89c5ac2011-12-06 01:10:29 +00002918 unsigned ID = getSubmoduleID(Mod);
Mehdi Amini57a41912015-09-10 01:46:39 +00002919
2920 uint64_t ParentID = 0;
Douglas Gregor69021972011-11-30 17:33:56 +00002921 if (Mod->Parent) {
2922 assert(SubmoduleIDs[Mod->Parent] && "Submodule parent not written?");
Mehdi Amini57a41912015-09-10 01:46:39 +00002923 ParentID = SubmoduleIDs[Mod->Parent];
Douglas Gregor69021972011-11-30 17:33:56 +00002924 }
Mehdi Amini57a41912015-09-10 01:46:39 +00002925
2926 // Emit the definition of the block.
2927 {
David Blaikie9ffe5a32017-01-30 05:00:26 +00002928 RecordData::value_type Record[] = {SUBMODULE_DEFINITION,
2929 ID,
2930 ParentID,
Simon Pilgrimf331a662017-09-04 10:54:39 +00002931 (RecordData::value_type)Mod->Kind,
David Blaikie9ffe5a32017-01-30 05:00:26 +00002932 Mod->IsFramework,
2933 Mod->IsExplicit,
2934 Mod->IsSystem,
2935 Mod->IsExternC,
2936 Mod->InferSubmodules,
2937 Mod->InferExplicitSubmodules,
2938 Mod->InferExportWildcard,
Jordan Rose90b0a1f2018-04-20 17:16:04 +00002939 Mod->ConfigMacrosExhaustive,
2940 Mod->ModuleMapIsPrivate};
Mehdi Amini57a41912015-09-10 01:46:39 +00002941 Stream.EmitRecordWithBlob(DefinitionAbbrev, Record, Mod->Name);
2942 }
2943
Douglas Gregor1fb5c3a2011-12-31 04:05:44 +00002944 // Emit the requirements.
Richard Smith080056b2015-08-18 21:53:42 +00002945 for (const auto &R : Mod->Requirements) {
Mehdi Amini57a41912015-09-10 01:46:39 +00002946 RecordData::value_type Record[] = {SUBMODULE_REQUIRES, R.second};
Richard Smith080056b2015-08-18 21:53:42 +00002947 Stream.EmitRecordWithBlob(RequiresAbbrev, Record, R.first);
Douglas Gregor1fb5c3a2011-12-31 04:05:44 +00002948 }
2949
Douglas Gregor69021972011-11-30 17:33:56 +00002950 // Emit the umbrella header, if there is one.
Richard Smith2b63d152015-05-16 02:28:53 +00002951 if (auto UmbrellaHeader = Mod->getUmbrellaHeader()) {
Mehdi Amini57a41912015-09-10 01:46:39 +00002952 RecordData::value_type Record[] = {SUBMODULE_UMBRELLA_HEADER};
Richard Smith2b63d152015-05-16 02:28:53 +00002953 Stream.EmitRecordWithBlob(UmbrellaAbbrev, Record,
2954 UmbrellaHeader.NameAsWritten);
2955 } else if (auto UmbrellaDir = Mod->getUmbrellaDir()) {
Mehdi Amini57a41912015-09-10 01:46:39 +00002956 RecordData::value_type Record[] = {SUBMODULE_UMBRELLA_DIR};
2957 Stream.EmitRecordWithBlob(UmbrellaDirAbbrev, Record,
Richard Smith2b63d152015-05-16 02:28:53 +00002958 UmbrellaDir.NameAsWritten);
Douglas Gregor69021972011-11-30 17:33:56 +00002959 }
Richard Smith306d8922014-10-22 23:50:56 +00002960
Douglas Gregor69021972011-11-30 17:33:56 +00002961 // Emit the headers.
Richard Smith202210b2014-10-24 20:23:01 +00002962 struct {
Richard Smith3c1a41a2014-12-02 00:08:08 +00002963 unsigned RecordKind;
Richard Smith202210b2014-10-24 20:23:01 +00002964 unsigned Abbrev;
Richard Smith3c1a41a2014-12-02 00:08:08 +00002965 Module::HeaderKind HeaderKind;
Richard Smith202210b2014-10-24 20:23:01 +00002966 } HeaderLists[] = {
Richard Smith3c1a41a2014-12-02 00:08:08 +00002967 {SUBMODULE_HEADER, HeaderAbbrev, Module::HK_Normal},
2968 {SUBMODULE_TEXTUAL_HEADER, TextualHeaderAbbrev, Module::HK_Textual},
2969 {SUBMODULE_PRIVATE_HEADER, PrivateHeaderAbbrev, Module::HK_Private},
Richard Smith202210b2014-10-24 20:23:01 +00002970 {SUBMODULE_PRIVATE_TEXTUAL_HEADER, PrivateTextualHeaderAbbrev,
Richard Smith3c1a41a2014-12-02 00:08:08 +00002971 Module::HK_PrivateTextual},
2972 {SUBMODULE_EXCLUDED_HEADER, ExcludedHeaderAbbrev, Module::HK_Excluded}
Richard Smith202210b2014-10-24 20:23:01 +00002973 };
2974 for (auto &HL : HeaderLists) {
Mehdi Amini57a41912015-09-10 01:46:39 +00002975 RecordData::value_type Record[] = {HL.RecordKind};
Richard Smith3c1a41a2014-12-02 00:08:08 +00002976 for (auto &H : Mod->Headers[HL.HeaderKind])
2977 Stream.EmitRecordWithBlob(HL.Abbrev, Record, H.NameAsWritten);
2978 }
2979
2980 // Emit the top headers.
2981 {
2982 auto TopHeaders = Mod->getTopHeaders(PP->getFileManager());
Mehdi Amini57a41912015-09-10 01:46:39 +00002983 RecordData::value_type Record[] = {SUBMODULE_TOPHEADER};
Richard Smith3c1a41a2014-12-02 00:08:08 +00002984 for (auto *H : TopHeaders)
2985 Stream.EmitRecordWithBlob(TopHeaderAbbrev, Record, H->getName());
Argyrios Kyrtzidisc597c8c2012-10-05 00:22:33 +00002986 }
Douglas Gregor0093b3c2011-12-05 16:33:54 +00002987
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00002988 // Emit the imports.
Douglas Gregor0093b3c2011-12-05 16:33:54 +00002989 if (!Mod->Imports.empty()) {
Mehdi Amini57a41912015-09-10 01:46:39 +00002990 RecordData Record;
Richard Smith080056b2015-08-18 21:53:42 +00002991 for (auto *I : Mod->Imports)
2992 Record.push_back(getSubmoduleID(I));
Douglas Gregor0093b3c2011-12-05 16:33:54 +00002993 Stream.EmitRecord(SUBMODULE_IMPORTS, Record);
2994 }
2995
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00002996 // Emit the exports.
Douglas Gregor24bb9232011-12-02 18:58:38 +00002997 if (!Mod->Exports.empty()) {
Mehdi Amini57a41912015-09-10 01:46:39 +00002998 RecordData Record;
Richard Smith080056b2015-08-18 21:53:42 +00002999 for (const auto &E : Mod->Exports) {
3000 // FIXME: This may fail; we don't require that all exported modules
3001 // are local or imported.
3002 Record.push_back(getSubmoduleID(E.getPointer()));
3003 Record.push_back(E.getInt());
Douglas Gregor24bb9232011-12-02 18:58:38 +00003004 }
3005 Stream.EmitRecord(SUBMODULE_EXPORTS, Record);
3006 }
Douglas Gregor6ddfca92013-01-14 17:21:00 +00003007
Daniel Jasperba7f2f72013-09-24 09:14:14 +00003008 //FIXME: How do we emit the 'use'd modules? They may not be submodules.
3009 // Might be unnecessary as use declarations are only used to build the
3010 // module itself.
3011
Douglas Gregor6ddfca92013-01-14 17:21:00 +00003012 // Emit the link libraries.
Richard Smith080056b2015-08-18 21:53:42 +00003013 for (const auto &LL : Mod->LinkLibraries) {
Mehdi Amini57a41912015-09-10 01:46:39 +00003014 RecordData::value_type Record[] = {SUBMODULE_LINK_LIBRARY,
3015 LL.IsFramework};
Richard Smith080056b2015-08-18 21:53:42 +00003016 Stream.EmitRecordWithBlob(LinkLibraryAbbrev, Record, LL.Library);
Douglas Gregor6ddfca92013-01-14 17:21:00 +00003017 }
3018
Douglas Gregorfb912652013-03-20 21:10:35 +00003019 // Emit the conflicts.
Richard Smith080056b2015-08-18 21:53:42 +00003020 for (const auto &C : Mod->Conflicts) {
Richard Smith080056b2015-08-18 21:53:42 +00003021 // FIXME: This may fail; we don't require that all conflicting modules
3022 // are local or imported.
Mehdi Amini57a41912015-09-10 01:46:39 +00003023 RecordData::value_type Record[] = {SUBMODULE_CONFLICT,
3024 getSubmoduleID(C.Other)};
Richard Smith080056b2015-08-18 21:53:42 +00003025 Stream.EmitRecordWithBlob(ConflictAbbrev, Record, C.Message);
Douglas Gregorfb912652013-03-20 21:10:35 +00003026 }
3027
Douglas Gregor35b13ec2013-03-20 00:22:05 +00003028 // Emit the configuration macros.
Richard Smith080056b2015-08-18 21:53:42 +00003029 for (const auto &CM : Mod->ConfigMacros) {
Mehdi Amini57a41912015-09-10 01:46:39 +00003030 RecordData::value_type Record[] = {SUBMODULE_CONFIG_MACRO};
Richard Smith080056b2015-08-18 21:53:42 +00003031 Stream.EmitRecordWithBlob(ConfigMacroAbbrev, Record, CM);
Douglas Gregor35b13ec2013-03-20 00:22:05 +00003032 }
3033
Richard Smithdc1f0422016-07-20 19:10:16 +00003034 // Emit the initializers, if any.
3035 RecordData Inits;
3036 for (Decl *D : Context->getModuleInitializers(Mod))
3037 Inits.push_back(GetDeclRef(D));
3038 if (!Inits.empty())
3039 Stream.EmitRecord(SUBMODULE_INITIALIZERS, Inits);
3040
Douglas Gregorf0b11de2017-09-14 23:38:44 +00003041 // Emit the name of the re-exported module, if any.
3042 if (!Mod->ExportAsModule.empty()) {
3043 RecordData::value_type Record[] = {SUBMODULE_EXPORT_AS};
3044 Stream.EmitRecordWithBlob(ExportAsAbbrev, Record, Mod->ExportAsModule);
3045 }
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00003046
Douglas Gregor69021972011-11-30 17:33:56 +00003047 // Queue up the submodules of this module.
Richard Smith080056b2015-08-18 21:53:42 +00003048 for (auto *M : Mod->submodules())
3049 Q.push(M);
Douglas Gregor69021972011-11-30 17:33:56 +00003050 }
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00003051
Douglas Gregor69021972011-11-30 17:33:56 +00003052 Stream.ExitBlock();
Richard Smith23d8d032015-05-14 00:45:20 +00003053
Richard Smith23d8d032015-05-14 00:45:20 +00003054 assert((NextSubmoduleID - FirstSubmoduleID ==
3055 getNumberOfModules(WritingModule)) &&
3056 "Wrong # of submodules; found a reference to a non-local, "
3057 "non-imported submodule?");
Douglas Gregor69021972011-11-30 17:33:56 +00003058}
3059
Argyrios Kyrtzidis0f06b982013-03-27 17:17:23 +00003060void ASTWriter::WritePragmaDiagnosticMappings(const DiagnosticsEngine &Diag,
3061 bool isModule) {
Argyrios Kyrtzidisefaa54a2012-10-30 00:27:21 +00003062 llvm::SmallDenseMap<const DiagnosticsEngine::DiagState *, unsigned, 64>
3063 DiagStateIDMap;
3064 unsigned CurrID = 0;
Argyrios Kyrtzidis452707c2010-11-05 22:10:18 +00003065 RecordData Record;
Argyrios Kyrtzidis243aedb2011-01-14 20:54:07 +00003066
Richard Smithe37391c2017-05-03 00:28:49 +00003067 auto EncodeDiagStateFlags =
3068 [](const DiagnosticsEngine::DiagState *DS) -> unsigned {
3069 unsigned Result = (unsigned)DS->ExtBehavior;
3070 for (unsigned Val :
Daniel Jasperba9aefc2017-05-03 07:48:27 +00003071 {(unsigned)DS->IgnoreAllWarnings, (unsigned)DS->EnableAllWarnings,
3072 (unsigned)DS->WarningsAsErrors, (unsigned)DS->ErrorsAsFatal,
3073 (unsigned)DS->SuppressSystemWarnings})
Richard Smithe37391c2017-05-03 00:28:49 +00003074 Result = (Result << 1) | Val;
3075 return Result;
3076 };
3077
3078 unsigned Flags = EncodeDiagStateFlags(Diag.DiagStatesByLoc.FirstDiagState);
3079 Record.push_back(Flags);
3080
Richard Smithd230de22017-01-26 01:01:01 +00003081 auto AddDiagState = [&](const DiagnosticsEngine::DiagState *State,
3082 bool IncludeNonPragmaStates) {
Richard Smithe37391c2017-05-03 00:28:49 +00003083 // Ensure that the diagnostic state wasn't modified since it was created.
3084 // We will not correctly round-trip this information otherwise.
3085 assert(Flags == EncodeDiagStateFlags(State) &&
3086 "diag state flags vary in single AST file");
3087
Richard Smithd230de22017-01-26 01:01:01 +00003088 unsigned &DiagStateID = DiagStateIDMap[State];
Argyrios Kyrtzidisefaa54a2012-10-30 00:27:21 +00003089 Record.push_back(DiagStateID);
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00003090
Argyrios Kyrtzidisefaa54a2012-10-30 00:27:21 +00003091 if (DiagStateID == 0) {
3092 DiagStateID = ++CurrID;
Duncan P. N. Exon Smith3cb183b2017-03-14 19:31:27 +00003093
3094 // Add a placeholder for the number of mappings.
3095 auto SizeIdx = Record.size();
3096 Record.emplace_back();
Richard Smithd230de22017-01-26 01:01:01 +00003097 for (const auto &I : *State) {
3098 if (I.second.isPragma() || IncludeNonPragmaStates) {
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00003099 Record.push_back(I.first);
Richard Smithe37391c2017-05-03 00:28:49 +00003100 Record.push_back(I.second.serialize());
Argyrios Kyrtzidisefaa54a2012-10-30 00:27:21 +00003101 }
Argyrios Kyrtzidis243aedb2011-01-14 20:54:07 +00003102 }
Duncan P. N. Exon Smith3cb183b2017-03-14 19:31:27 +00003103 // Update the placeholder.
3104 Record[SizeIdx] = (Record.size() - SizeIdx) / 2;
Richard Smithd230de22017-01-26 01:01:01 +00003105 }
3106 };
3107
3108 AddDiagState(Diag.DiagStatesByLoc.FirstDiagState, isModule);
Richard Smithd230de22017-01-26 01:01:01 +00003109
Duncan P. N. Exon Smitha351c102017-04-12 03:45:32 +00003110 // Reserve a spot for the number of locations with state transitions.
3111 auto NumLocationsIdx = Record.size();
3112 Record.emplace_back();
3113
3114 // Emit the state transitions.
3115 unsigned NumLocations = 0;
Richard Smithd230de22017-01-26 01:01:01 +00003116 for (auto &FileIDAndFile : Diag.DiagStatesByLoc.Files) {
3117 if (!FileIDAndFile.first.isValid() ||
3118 !FileIDAndFile.second.HasLocalTransitions)
3119 continue;
Duncan P. N. Exon Smitha351c102017-04-12 03:45:32 +00003120 ++NumLocations;
Richard Smith6c2b5a82018-02-09 01:15:13 +00003121
3122 SourceLocation Loc = Diag.SourceMgr->getComposedLoc(FileIDAndFile.first, 0);
3123 assert(!Loc.isInvalid() && "start loc for valid FileID is invalid");
3124 AddSourceLocation(Loc, Record);
3125
Richard Smithd230de22017-01-26 01:01:01 +00003126 Record.push_back(FileIDAndFile.second.StateTransitions.size());
3127 for (auto &StatePoint : FileIDAndFile.second.StateTransitions) {
3128 Record.push_back(StatePoint.Offset);
3129 AddDiagState(StatePoint.State, false);
Argyrios Kyrtzidis452707c2010-11-05 22:10:18 +00003130 }
3131 }
3132
Duncan P. N. Exon Smitha351c102017-04-12 03:45:32 +00003133 // Backpatch the number of locations.
3134 Record[NumLocationsIdx] = NumLocations;
3135
3136 // Emit CurDiagStateLoc. Do it last in order to match source order.
Duncan P. N. Exon Smith900f8172017-04-12 03:58:58 +00003137 //
3138 // This also protects against a hypothetical corner case with simulating
3139 // -Werror settings for implicit modules in the ASTReader, where reading
3140 // CurDiagState out of context could change whether warning pragmas are
3141 // treated as errors.
Duncan P. N. Exon Smitha351c102017-04-12 03:45:32 +00003142 AddSourceLocation(Diag.DiagStatesByLoc.CurDiagStateLoc, Record);
3143 AddDiagState(Diag.DiagStatesByLoc.CurDiagState, false);
3144
Duncan P. N. Exon Smithf2435b92017-04-12 02:31:17 +00003145 Stream.EmitRecord(DIAG_PRAGMA_MAPPINGS, Record);
Argyrios Kyrtzidis452707c2010-11-05 22:10:18 +00003146}
3147
Douglas Gregorc5046832009-04-27 18:38:38 +00003148//===----------------------------------------------------------------------===//
3149// Type Serialization
3150//===----------------------------------------------------------------------===//
Chris Lattnereeffaef2009-04-10 17:15:23 +00003151
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003152/// Write the representation of a type to the AST stream.
Sebastian Redl55c0ad52010-08-18 23:56:21 +00003153void ASTWriter::WriteType(QualType T) {
Richard Smith290d8012016-04-06 17:06:00 +00003154 TypeIdx &IdxRef = TypeIdxs[T];
3155 if (IdxRef.getIndex() == 0) // we haven't seen this type before.
3156 IdxRef = TypeIdx(NextTypeID++);
3157 TypeIdx Idx = IdxRef;
Mike Stump11289f42009-09-09 15:08:12 +00003158
Douglas Gregor9b3932c2010-10-05 18:37:06 +00003159 assert(Idx.getIndex() >= FirstTypeID && "Re-writing a type from a prior AST");
Douglas Gregordc72caa2010-10-04 18:21:45 +00003160
Douglas Gregoref84c4b2009-04-09 22:27:44 +00003161 RecordData Record;
Mike Stump11289f42009-09-09 15:08:12 +00003162
Douglas Gregoref84c4b2009-04-09 22:27:44 +00003163 // Emit the type's representation.
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00003164 ASTTypeWriter W(*this, Record);
Richard Smith290d8012016-04-06 17:06:00 +00003165 W.Visit(T);
3166 uint64_t Offset = W.Emit();
John McCall8ccfcb52009-09-24 19:53:00 +00003167
Richard Smith290d8012016-04-06 17:06:00 +00003168 // Record the offset for this type.
3169 unsigned Index = Idx.getIndex() - FirstTypeID;
3170 if (TypeOffsets.size() == Index)
3171 TypeOffsets.push_back(Offset);
3172 else if (TypeOffsets.size() < Index) {
3173 TypeOffsets.resize(Index + 1);
3174 TypeOffsets[Index] = Offset;
John McCall8ccfcb52009-09-24 19:53:00 +00003175 } else {
Richard Smith290d8012016-04-06 17:06:00 +00003176 llvm_unreachable("Types emitted in wrong order");
Douglas Gregoref84c4b2009-04-09 22:27:44 +00003177 }
Douglas Gregoref84c4b2009-04-09 22:27:44 +00003178}
3179
Douglas Gregorc5046832009-04-27 18:38:38 +00003180//===----------------------------------------------------------------------===//
3181// Declaration Serialization
3182//===----------------------------------------------------------------------===//
3183
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003184/// Write the block containing all of the declaration IDs
Douglas Gregoref84c4b2009-04-09 22:27:44 +00003185/// lexically declared within the given DeclContext.
3186///
3187/// \returns the offset of the DECL_CONTEXT_LEXICAL block within the
Alexander Kornienko2a8c18d2018-04-06 15:14:32 +00003188/// bitstream, or 0 if no block was written.
Sebastian Redl55c0ad52010-08-18 23:56:21 +00003189uint64_t ASTWriter::WriteDeclContextLexicalBlock(ASTContext &Context,
Douglas Gregoref84c4b2009-04-09 22:27:44 +00003190 DeclContext *DC) {
Argyrios Kyrtzidiscfbfe782009-06-30 02:36:12 +00003191 if (DC->decls_empty())
Douglas Gregoref84c4b2009-04-09 22:27:44 +00003192 return 0;
3193
Douglas Gregor8f45df52009-04-16 22:23:12 +00003194 uint64_t Offset = Stream.GetCurrentBitNo();
Richard Smith82f8fcd2015-08-06 22:07:25 +00003195 SmallVector<uint32_t, 128> KindDeclPairs;
3196 for (const auto *D : DC->decls()) {
3197 KindDeclPairs.push_back(D->getKind());
3198 KindDeclPairs.push_back(GetDeclRef(D));
3199 }
Douglas Gregoref84c4b2009-04-09 22:27:44 +00003200
Douglas Gregora57c3ab2009-04-22 22:34:57 +00003201 ++NumLexicalDeclContexts;
Mehdi Amini57a41912015-09-10 01:46:39 +00003202 RecordData::value_type Record[] = {DECL_CONTEXT_LEXICAL};
Richard Smith82f8fcd2015-08-06 22:07:25 +00003203 Stream.EmitRecordWithBlob(DeclContextLexicalAbbrev, Record,
3204 bytes(KindDeclPairs));
Douglas Gregoref84c4b2009-04-09 22:27:44 +00003205 return Offset;
3206}
3207
Sebastian Redl55c0ad52010-08-18 23:56:21 +00003208void ASTWriter::WriteTypeDeclOffsets() {
Sebastian Redl1ea025b2010-07-16 16:36:56 +00003209 using namespace llvm;
Sebastian Redl1ea025b2010-07-16 16:36:56 +00003210
3211 // Write the type offsets array
David Blaikieb44f0bf2017-01-04 22:36:43 +00003212 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Sebastian Redl539c5062010-08-18 23:57:32 +00003213 Abbrev->Add(BitCodeAbbrevOp(TYPE_OFFSET));
Sebastian Redl1ea025b2010-07-16 16:36:56 +00003214 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // # of types
Douglas Gregor5204bde2011-08-02 16:26:37 +00003215 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // base type index
Sebastian Redl1ea025b2010-07-16 16:36:56 +00003216 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // types block
David Blaikieb44f0bf2017-01-04 22:36:43 +00003217 unsigned TypeOffsetAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Mehdi Amini57a41912015-09-10 01:46:39 +00003218 {
3219 RecordData::value_type Record[] = {TYPE_OFFSET, TypeOffsets.size(),
3220 FirstTypeID - NUM_PREDEF_TYPE_IDS};
3221 Stream.EmitRecordWithBlob(TypeOffsetAbbrev, Record, bytes(TypeOffsets));
3222 }
Sebastian Redl1ea025b2010-07-16 16:36:56 +00003223
3224 // Write the declaration offsets array
David Blaikieb44f0bf2017-01-04 22:36:43 +00003225 Abbrev = std::make_shared<BitCodeAbbrev>();
Sebastian Redl539c5062010-08-18 23:57:32 +00003226 Abbrev->Add(BitCodeAbbrevOp(DECL_OFFSET));
Sebastian Redl1ea025b2010-07-16 16:36:56 +00003227 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // # of declarations
Douglas Gregorf7180622011-08-03 15:48:04 +00003228 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // base decl ID
Sebastian Redl1ea025b2010-07-16 16:36:56 +00003229 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // declarations block
David Blaikieb44f0bf2017-01-04 22:36:43 +00003230 unsigned DeclOffsetAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Mehdi Amini57a41912015-09-10 01:46:39 +00003231 {
3232 RecordData::value_type Record[] = {DECL_OFFSET, DeclOffsets.size(),
3233 FirstDeclID - NUM_PREDEF_DECL_IDS};
3234 Stream.EmitRecordWithBlob(DeclOffsetAbbrev, Record, bytes(DeclOffsets));
3235 }
Sebastian Redl1ea025b2010-07-16 16:36:56 +00003236}
3237
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00003238void ASTWriter::WriteFileDeclIDsMap() {
3239 using namespace llvm;
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00003240
Chandler Carruthb306d732015-03-27 00:31:20 +00003241 SmallVector<std::pair<FileID, DeclIDInFileInfo *>, 64> SortedFileDeclIDs(
3242 FileDeclIDs.begin(), FileDeclIDs.end());
Fangrui Song55fab262018-09-26 22:16:28 +00003243 llvm::sort(SortedFileDeclIDs, llvm::less_first());
Chandler Carruthb306d732015-03-27 00:31:20 +00003244
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00003245 // Join the vectors of DeclIDs from all files.
Chandler Carruthb306d732015-03-27 00:31:20 +00003246 SmallVector<DeclID, 256> FileGroupedDeclIDs;
3247 for (auto &FileDeclEntry : SortedFileDeclIDs) {
3248 DeclIDInFileInfo &Info = *FileDeclEntry.second;
3249 Info.FirstDeclIndex = FileGroupedDeclIDs.size();
3250 for (auto &LocDeclEntry : Info.DeclIDs)
3251 FileGroupedDeclIDs.push_back(LocDeclEntry.second);
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00003252 }
3253
David Blaikieb44f0bf2017-01-04 22:36:43 +00003254 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00003255 Abbrev->Add(BitCodeAbbrevOp(FILE_SORTED_DECLS));
Argyrios Kyrtzidis10e78462012-10-02 21:09:13 +00003256 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00003257 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
David Blaikieb44f0bf2017-01-04 22:36:43 +00003258 unsigned AbbrevCode = Stream.EmitAbbrev(std::move(Abbrev));
Mehdi Amini57a41912015-09-10 01:46:39 +00003259 RecordData::value_type Record[] = {FILE_SORTED_DECLS,
3260 FileGroupedDeclIDs.size()};
Reid Kleckner012665e2015-05-21 00:13:09 +00003261 Stream.EmitRecordWithBlob(AbbrevCode, Record, bytes(FileGroupedDeclIDs));
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00003262}
3263
Dmitri Gribenkoaab83832012-06-20 00:34:58 +00003264void ASTWriter::WriteComments() {
3265 Stream.EnterSubblock(COMMENTS_BLOCK_ID, 3);
Ilya Biryukov45643102018-07-09 11:33:23 +00003266 auto _ = llvm::make_scope_exit([this] { Stream.ExitBlock(); });
3267 if (!PP->getPreprocessorOpts().WriteCommentListToPCH)
3268 return;
Dmitri Gribenkoaab83832012-06-20 00:34:58 +00003269 RecordData Record;
Jan Korousf31d8df2019-08-13 18:11:44 +00003270 for (const auto &FO : Context->Comments.OrderedComments) {
3271 for (const auto &OC : FO.second) {
3272 const RawComment *I = OC.second;
3273 Record.clear();
3274 AddSourceRange(I->getSourceRange(), Record);
3275 Record.push_back(I->getKind());
3276 Record.push_back(I->isTrailingComment());
3277 Record.push_back(I->isAlmostTrailingComment());
3278 Stream.EmitRecord(COMMENTS_RAW_COMMENT, Record);
3279 }
Dmitri Gribenkoaab83832012-06-20 00:34:58 +00003280 }
Dmitri Gribenkoaab83832012-06-20 00:34:58 +00003281}
3282
Douglas Gregorc5046832009-04-27 18:38:38 +00003283//===----------------------------------------------------------------------===//
3284// Global Method Pool and Selector Serialization
3285//===----------------------------------------------------------------------===//
3286
Douglas Gregore84a9da2009-04-20 20:36:09 +00003287namespace {
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +00003288
Douglas Gregorc78d3462009-04-24 21:10:55 +00003289// Trait used for the on-disk hash table used in the method pool.
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00003290class ASTMethodPoolTrait {
Sebastian Redl55c0ad52010-08-18 23:56:21 +00003291 ASTWriter &Writer;
Douglas Gregorc78d3462009-04-24 21:10:55 +00003292
3293public:
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003294 using key_type = Selector;
3295 using key_type_ref = key_type;
Mike Stump11289f42009-09-09 15:08:12 +00003296
Sebastian Redl834bb972010-08-04 17:20:04 +00003297 struct data_type {
Sebastian Redl539c5062010-08-18 23:57:32 +00003298 SelectorID ID;
Sebastian Redl834bb972010-08-04 17:20:04 +00003299 ObjCMethodList Instance, Factory;
3300 };
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003301 using data_type_ref = const data_type &;
Douglas Gregorc78d3462009-04-24 21:10:55 +00003302
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003303 using hash_value_type = unsigned;
3304 using offset_type = unsigned;
Justin Bogner25463f12014-04-18 20:27:24 +00003305
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003306 explicit ASTMethodPoolTrait(ASTWriter &Writer) : Writer(Writer) {}
Mike Stump11289f42009-09-09 15:08:12 +00003307
Justin Bogner25463f12014-04-18 20:27:24 +00003308 static hash_value_type ComputeHash(Selector Sel) {
Argyrios Kyrtzidis4bd97102010-08-20 16:03:52 +00003309 return serialization::ComputeHash(Sel);
Douglas Gregorc78d3462009-04-24 21:10:55 +00003310 }
Mike Stump11289f42009-09-09 15:08:12 +00003311
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003312 std::pair<unsigned, unsigned>
Chris Lattner0e62c1c2011-07-23 10:55:15 +00003313 EmitKeyDataLength(raw_ostream& Out, Selector Sel,
Douglas Gregorc78d3462009-04-24 21:10:55 +00003314 data_type_ref Methods) {
Justin Bognere1c147c2014-03-28 22:03:19 +00003315 using namespace llvm::support;
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003316
Peter Collingbournee3f65292018-05-18 19:46:24 +00003317 endian::Writer LE(Out, little);
Douglas Gregorc78d3462009-04-24 21:10:55 +00003318 unsigned KeyLen = 2 + (Sel.getNumArgs()? Sel.getNumArgs() * 4 : 4);
Justin Bognere1c147c2014-03-28 22:03:19 +00003319 LE.write<uint16_t>(KeyLen);
Sebastian Redl834bb972010-08-04 17:20:04 +00003320 unsigned DataLen = 4 + 2 + 2; // 2 bytes for each of the method counts
3321 for (const ObjCMethodList *Method = &Methods.Instance; Method;
Argyrios Kyrtzidisd3da6e02013-04-17 00:08:58 +00003322 Method = Method->getNext())
Nico Weber2e0c8f72014-12-27 03:58:08 +00003323 if (Method->getMethod())
Douglas Gregorc78d3462009-04-24 21:10:55 +00003324 DataLen += 4;
Sebastian Redl834bb972010-08-04 17:20:04 +00003325 for (const ObjCMethodList *Method = &Methods.Factory; Method;
Argyrios Kyrtzidisd3da6e02013-04-17 00:08:58 +00003326 Method = Method->getNext())
Nico Weber2e0c8f72014-12-27 03:58:08 +00003327 if (Method->getMethod())
Douglas Gregorc78d3462009-04-24 21:10:55 +00003328 DataLen += 4;
Justin Bognere1c147c2014-03-28 22:03:19 +00003329 LE.write<uint16_t>(DataLen);
Douglas Gregorc78d3462009-04-24 21:10:55 +00003330 return std::make_pair(KeyLen, DataLen);
3331 }
Mike Stump11289f42009-09-09 15:08:12 +00003332
Chris Lattner0e62c1c2011-07-23 10:55:15 +00003333 void EmitKey(raw_ostream& Out, Selector Sel, unsigned) {
Justin Bognere1c147c2014-03-28 22:03:19 +00003334 using namespace llvm::support;
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003335
Peter Collingbournee3f65292018-05-18 19:46:24 +00003336 endian::Writer LE(Out, little);
Mike Stump11289f42009-09-09 15:08:12 +00003337 uint64_t Start = Out.tell();
Douglas Gregor95c13f52009-04-25 17:48:32 +00003338 assert((Start >> 32) == 0 && "Selector key offset too large");
3339 Writer.SetSelectorOffset(Sel, Start);
Douglas Gregorc78d3462009-04-24 21:10:55 +00003340 unsigned N = Sel.getNumArgs();
Justin Bognere1c147c2014-03-28 22:03:19 +00003341 LE.write<uint16_t>(N);
Douglas Gregorc78d3462009-04-24 21:10:55 +00003342 if (N == 0)
3343 N = 1;
3344 for (unsigned I = 0; I != N; ++I)
Justin Bognere1c147c2014-03-28 22:03:19 +00003345 LE.write<uint32_t>(
3346 Writer.getIdentifierRef(Sel.getIdentifierInfoForSlot(I)));
Douglas Gregorc78d3462009-04-24 21:10:55 +00003347 }
Mike Stump11289f42009-09-09 15:08:12 +00003348
Chris Lattner0e62c1c2011-07-23 10:55:15 +00003349 void EmitData(raw_ostream& Out, key_type_ref,
Douglas Gregor4647cfa2009-04-24 21:49:02 +00003350 data_type_ref Methods, unsigned DataLen) {
Justin Bognere1c147c2014-03-28 22:03:19 +00003351 using namespace llvm::support;
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003352
Peter Collingbournee3f65292018-05-18 19:46:24 +00003353 endian::Writer LE(Out, little);
Douglas Gregor4647cfa2009-04-24 21:49:02 +00003354 uint64_t Start = Out.tell(); (void)Start;
Justin Bognere1c147c2014-03-28 22:03:19 +00003355 LE.write<uint32_t>(Methods.ID);
Douglas Gregorc78d3462009-04-24 21:10:55 +00003356 unsigned NumInstanceMethods = 0;
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())
Douglas Gregorc78d3462009-04-24 21:10:55 +00003360 ++NumInstanceMethods;
3361
3362 unsigned NumFactoryMethods = 0;
Sebastian Redl834bb972010-08-04 17:20:04 +00003363 for (const ObjCMethodList *Method = &Methods.Factory; Method;
Argyrios Kyrtzidisd3da6e02013-04-17 00:08:58 +00003364 Method = Method->getNext())
Nico Weber2e0c8f72014-12-27 03:58:08 +00003365 if (Method->getMethod())
Douglas Gregorc78d3462009-04-24 21:10:55 +00003366 ++NumFactoryMethods;
3367
Argyrios Kyrtzidisd3da6e02013-04-17 00:08:58 +00003368 unsigned InstanceBits = Methods.Instance.getBits();
3369 assert(InstanceBits < 4);
Nico Weberff4b35e2014-12-27 22:14:15 +00003370 unsigned InstanceHasMoreThanOneDeclBit =
3371 Methods.Instance.hasMoreThanOneDecl();
3372 unsigned FullInstanceBits = (NumInstanceMethods << 3) |
3373 (InstanceHasMoreThanOneDeclBit << 2) |
3374 InstanceBits;
Argyrios Kyrtzidisd3da6e02013-04-17 00:08:58 +00003375 unsigned FactoryBits = Methods.Factory.getBits();
3376 assert(FactoryBits < 4);
Nico Weberff4b35e2014-12-27 22:14:15 +00003377 unsigned FactoryHasMoreThanOneDeclBit =
3378 Methods.Factory.hasMoreThanOneDecl();
3379 unsigned FullFactoryBits = (NumFactoryMethods << 3) |
3380 (FactoryHasMoreThanOneDeclBit << 2) |
3381 FactoryBits;
3382 LE.write<uint16_t>(FullInstanceBits);
3383 LE.write<uint16_t>(FullFactoryBits);
Sebastian Redl834bb972010-08-04 17:20:04 +00003384 for (const ObjCMethodList *Method = &Methods.Instance; Method;
Argyrios Kyrtzidisd3da6e02013-04-17 00:08:58 +00003385 Method = Method->getNext())
Nico Weber2e0c8f72014-12-27 03:58:08 +00003386 if (Method->getMethod())
3387 LE.write<uint32_t>(Writer.getDeclID(Method->getMethod()));
Sebastian Redl834bb972010-08-04 17:20:04 +00003388 for (const ObjCMethodList *Method = &Methods.Factory; Method;
Argyrios Kyrtzidisd3da6e02013-04-17 00:08:58 +00003389 Method = Method->getNext())
Nico Weber2e0c8f72014-12-27 03:58:08 +00003390 if (Method->getMethod())
3391 LE.write<uint32_t>(Writer.getDeclID(Method->getMethod()));
Douglas Gregor4647cfa2009-04-24 21:49:02 +00003392
3393 assert(Out.tell() - Start == DataLen && "Data length is wrong");
Douglas Gregorc78d3462009-04-24 21:10:55 +00003394 }
3395};
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +00003396
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003397} // namespace
Douglas Gregorc78d3462009-04-24 21:10:55 +00003398
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003399/// Write ObjC data: selectors and the method pool.
Douglas Gregorc78d3462009-04-24 21:10:55 +00003400///
3401/// The method pool contains both instance and factory methods, stored
Sebastian Redla19a67f2010-08-03 21:58:15 +00003402/// in an on-disk hash table indexed by the selector. The hash table also
3403/// contains an empty entry for every other selector known to Sema.
Sebastian Redl55c0ad52010-08-18 23:56:21 +00003404void ASTWriter::WriteSelectors(Sema &SemaRef) {
Douglas Gregorc78d3462009-04-24 21:10:55 +00003405 using namespace llvm;
3406
Sebastian Redla19a67f2010-08-03 21:58:15 +00003407 // Do we have to do anything at all?
Sebastian Redl834bb972010-08-04 17:20:04 +00003408 if (SemaRef.MethodPool.empty() && SelectorIDs.empty())
Sebastian Redla19a67f2010-08-03 21:58:15 +00003409 return;
Sebastian Redld95a56e2010-08-04 18:21:41 +00003410 unsigned NumTableEntries = 0;
Sebastian Redla19a67f2010-08-03 21:58:15 +00003411 // Create and write out the blob that contains selectors and the method pool.
Douglas Gregorc78d3462009-04-24 21:10:55 +00003412 {
Justin Bognerbb094f02014-04-18 19:57:06 +00003413 llvm::OnDiskChainedHashTableGenerator<ASTMethodPoolTrait> Generator;
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003414 ASTMethodPoolTrait Trait(*this);
Mike Stump11289f42009-09-09 15:08:12 +00003415
Sebastian Redla19a67f2010-08-03 21:58:15 +00003416 // Create the on-disk hash table representation. We walk through every
3417 // selector we've seen and look it up in the method pool.
Sebastian Redld95a56e2010-08-04 18:21:41 +00003418 SelectorOffsets.resize(NextSelectorID - FirstSelectorID);
Chandler Carruthacbbeb92015-03-27 00:47:43 +00003419 for (auto &SelectorAndID : SelectorIDs) {
3420 Selector S = SelectorAndID.first;
3421 SelectorID ID = SelectorAndID.second;
Sebastian Redla19a67f2010-08-03 21:58:15 +00003422 Sema::GlobalMethodPool::iterator F = SemaRef.MethodPool.find(S);
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00003423 ASTMethodPoolTrait::data_type Data = {
Chandler Carruthacbbeb92015-03-27 00:47:43 +00003424 ID,
Sebastian Redl834bb972010-08-04 17:20:04 +00003425 ObjCMethodList(),
3426 ObjCMethodList()
3427 };
3428 if (F != SemaRef.MethodPool.end()) {
3429 Data.Instance = F->second.first;
3430 Data.Factory = F->second.second;
3431 }
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00003432 // Only write this selector if it's not in an existing AST or something
Sebastian Redld95a56e2010-08-04 18:21:41 +00003433 // changed.
Chandler Carruthacbbeb92015-03-27 00:47:43 +00003434 if (Chain && ID < FirstSelectorID) {
Sebastian Redld95a56e2010-08-04 18:21:41 +00003435 // Selector already exists. Did it change?
3436 bool changed = false;
Nico Weber2e0c8f72014-12-27 03:58:08 +00003437 for (ObjCMethodList *M = &Data.Instance;
3438 !changed && M && M->getMethod(); M = M->getNext()) {
3439 if (!M->getMethod()->isFromASTFile())
Sebastian Redld95a56e2010-08-04 18:21:41 +00003440 changed = true;
3441 }
Nico Weber2e0c8f72014-12-27 03:58:08 +00003442 for (ObjCMethodList *M = &Data.Factory; !changed && M && M->getMethod();
Argyrios Kyrtzidisd3da6e02013-04-17 00:08:58 +00003443 M = M->getNext()) {
Nico Weber2e0c8f72014-12-27 03:58:08 +00003444 if (!M->getMethod()->isFromASTFile())
Sebastian Redld95a56e2010-08-04 18:21:41 +00003445 changed = true;
3446 }
3447 if (!changed)
3448 continue;
Nico Weber2e0c8f72014-12-27 03:58:08 +00003449 } else if (Data.Instance.getMethod() || Data.Factory.getMethod()) {
Sebastian Redl6e1a2a02010-08-04 21:22:45 +00003450 // A new method pool entry.
3451 ++NumTableEntries;
Sebastian Redld95a56e2010-08-04 18:21:41 +00003452 }
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003453 Generator.insert(S, Data, Trait);
Douglas Gregorc78d3462009-04-24 21:10:55 +00003454 }
3455
Douglas Gregorc78d3462009-04-24 21:10:55 +00003456 // Create the on-disk hash table in a buffer.
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00003457 SmallString<4096> MethodPool;
Douglas Gregorc78d3462009-04-24 21:10:55 +00003458 uint32_t BucketOffset;
3459 {
Justin Bognere1c147c2014-03-28 22:03:19 +00003460 using namespace llvm::support;
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003461
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00003462 ASTMethodPoolTrait Trait(*this);
Douglas Gregorc78d3462009-04-24 21:10:55 +00003463 llvm::raw_svector_ostream Out(MethodPool);
3464 // Make sure that no bucket is at offset 0
Peter Collingbournee3f65292018-05-18 19:46:24 +00003465 endian::write<uint32_t>(Out, 0, little);
Douglas Gregorc78d3462009-04-24 21:10:55 +00003466 BucketOffset = Generator.Emit(Out, Trait);
3467 }
3468
3469 // Create a blob abbreviation
David Blaikieb44f0bf2017-01-04 22:36:43 +00003470 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Sebastian Redl539c5062010-08-18 23:57:32 +00003471 Abbrev->Add(BitCodeAbbrevOp(METHOD_POOL));
Douglas Gregorc78d3462009-04-24 21:10:55 +00003472 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
Douglas Gregor95c13f52009-04-25 17:48:32 +00003473 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
Douglas Gregorc78d3462009-04-24 21:10:55 +00003474 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
David Blaikieb44f0bf2017-01-04 22:36:43 +00003475 unsigned MethodPoolAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregorc78d3462009-04-24 21:10:55 +00003476
Douglas Gregor95c13f52009-04-25 17:48:32 +00003477 // Write the method pool
Mehdi Amini57a41912015-09-10 01:46:39 +00003478 {
3479 RecordData::value_type Record[] = {METHOD_POOL, BucketOffset,
3480 NumTableEntries};
3481 Stream.EmitRecordWithBlob(MethodPoolAbbrev, Record, MethodPool);
3482 }
Douglas Gregor95c13f52009-04-25 17:48:32 +00003483
3484 // Create a blob abbreviation for the selector table offsets.
David Blaikieb44f0bf2017-01-04 22:36:43 +00003485 Abbrev = std::make_shared<BitCodeAbbrev>();
Sebastian Redl539c5062010-08-18 23:57:32 +00003486 Abbrev->Add(BitCodeAbbrevOp(SELECTOR_OFFSETS));
Douglas Gregord4c5ed02010-10-29 22:39:52 +00003487 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // size
Douglas Gregor8f364fb2011-08-03 23:28:44 +00003488 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // first ID
Douglas Gregor95c13f52009-04-25 17:48:32 +00003489 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
David Blaikieb44f0bf2017-01-04 22:36:43 +00003490 unsigned SelectorOffsetAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregor95c13f52009-04-25 17:48:32 +00003491
3492 // Write the selector offsets table.
Mehdi Amini57a41912015-09-10 01:46:39 +00003493 {
3494 RecordData::value_type Record[] = {
3495 SELECTOR_OFFSETS, SelectorOffsets.size(),
3496 FirstSelectorID - NUM_PREDEF_SELECTOR_IDS};
3497 Stream.EmitRecordWithBlob(SelectorOffsetAbbrev, Record,
3498 bytes(SelectorOffsets));
3499 }
Douglas Gregorc78d3462009-04-24 21:10:55 +00003500 }
3501}
3502
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003503/// Write the selectors referenced in @selector expression into AST file.
Sebastian Redl55c0ad52010-08-18 23:56:21 +00003504void ASTWriter::WriteReferencedSelectorsPool(Sema &SemaRef) {
Fariborz Jahanianc51609a2010-07-23 19:11:11 +00003505 using namespace llvm;
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003506
Fariborz Jahanianc51609a2010-07-23 19:11:11 +00003507 if (SemaRef.ReferencedSelectors.empty())
3508 return;
Sebastian Redlada023c2010-08-04 20:40:17 +00003509
Fariborz Jahanianc51609a2010-07-23 19:11:11 +00003510 RecordData Record;
Richard Smithe64e7452016-04-18 21:54:58 +00003511 ASTRecordWriter Writer(*this, Record);
Sebastian Redlada023c2010-08-04 20:40:17 +00003512
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00003513 // Note: this writes out all references even for a dependent AST. But it is
Sebastian Redl51c79d82010-08-04 22:21:29 +00003514 // very tricky to fix, and given that @selector shouldn't really appear in
3515 // headers, probably not worth it. It's not a correctness issue.
Chandler Carruth12c8f652015-03-27 00:55:05 +00003516 for (auto &SelectorAndLocation : SemaRef.ReferencedSelectors) {
3517 Selector Sel = SelectorAndLocation.first;
3518 SourceLocation Loc = SelectorAndLocation.second;
Richard Smithe64e7452016-04-18 21:54:58 +00003519 Writer.AddSelectorRef(Sel);
3520 Writer.AddSourceLocation(Loc);
Fariborz Jahanianc51609a2010-07-23 19:11:11 +00003521 }
Richard Smithe64e7452016-04-18 21:54:58 +00003522 Writer.Emit(REFERENCED_SELECTOR_POOL);
Fariborz Jahanianc51609a2010-07-23 19:11:11 +00003523}
3524
Douglas Gregorc5046832009-04-27 18:38:38 +00003525//===----------------------------------------------------------------------===//
3526// Identifier Table Serialization
3527//===----------------------------------------------------------------------===//
3528
Richard Smithb3761912015-02-05 23:08:52 +00003529/// Determine the declaration that should be put into the name lookup table to
3530/// represent the given declaration in this module. This is usually D itself,
3531/// but if D was imported and merged into a local declaration, we want the most
3532/// recent local declaration instead. The chosen declaration will be the most
3533/// recent declaration in any module that imports this one.
3534static NamedDecl *getDeclForLocalLookup(const LangOptions &LangOpts,
3535 NamedDecl *D) {
3536 if (!LangOpts.Modules || !D->isFromASTFile())
3537 return D;
3538
3539 if (Decl *Redecl = D->getPreviousDecl()) {
3540 // For Redeclarable decls, a prior declaration might be local.
3541 for (; Redecl; Redecl = Redecl->getPreviousDecl()) {
Richard Smithd49941b2016-04-26 23:40:43 +00003542 // If we find a local decl, we're done.
3543 if (!Redecl->isFromASTFile()) {
3544 // Exception: in very rare cases (for injected-class-names), not all
3545 // redeclarations are in the same semantic context. Skip ones in a
3546 // different context. They don't go in this lookup table at all.
3547 if (!Redecl->getDeclContext()->getRedeclContext()->Equals(
3548 D->getDeclContext()->getRedeclContext()))
3549 continue;
Richard Smithb3761912015-02-05 23:08:52 +00003550 return cast<NamedDecl>(Redecl);
Richard Smithd49941b2016-04-26 23:40:43 +00003551 }
3552
Richard Smithfe620d22015-03-05 23:24:12 +00003553 // If we find a decl from a (chained-)PCH stop since we won't find a
Richard Smithb3761912015-02-05 23:08:52 +00003554 // local one.
Richard Smithd49941b2016-04-26 23:40:43 +00003555 if (Redecl->getOwningModuleID() == 0)
Richard Smithb3761912015-02-05 23:08:52 +00003556 break;
3557 }
3558 } else if (Decl *First = D->getCanonicalDecl()) {
3559 // For Mergeable decls, the first decl might be local.
3560 if (!First->isFromASTFile())
3561 return cast<NamedDecl>(First);
3562 }
3563
3564 // All declarations are imported. Our most recent declaration will also be
3565 // the most recent one in anyone who imports us.
3566 return D;
3567}
3568
Douglas Gregorc78d3462009-04-24 21:10:55 +00003569namespace {
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +00003570
Richard Smithcf97cf62015-04-19 01:34:23 +00003571class ASTIdentifierTableTrait {
3572 ASTWriter &Writer;
3573 Preprocessor &PP;
3574 IdentifierResolver &IdResolver;
Richard Smith9c254182015-07-19 21:41:12 +00003575 bool IsModule;
Richard Smitha534a312015-07-21 23:54:07 +00003576 bool NeedDecls;
Richard Smith33e0f7e2015-07-22 02:08:40 +00003577 ASTWriter::RecordData *InterestingIdentifierOffsets;
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00003578
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003579 /// Determines whether this is an "interesting" identifier that needs a
Richard Smithcf97cf62015-04-19 01:34:23 +00003580 /// full IdentifierInfo structure written into the hash table. Notably, this
3581 /// doesn't check whether the name has macros defined; use PublicMacroIterator
3582 /// to check that.
Richard Smith9c254182015-07-19 21:41:12 +00003583 bool isInterestingIdentifier(const IdentifierInfo *II, uint64_t MacroOffset) {
Richard Smithd7329392015-04-21 21:46:32 +00003584 if (MacroOffset ||
3585 II->isPoisoned() ||
Richard Smith9c254182015-07-19 21:41:12 +00003586 (IsModule ? II->hasRevertedBuiltin() : II->getObjCOrBuiltinID()) ||
Richard Smithcf97cf62015-04-19 01:34:23 +00003587 II->hasRevertedTokenIDToIdentifier() ||
Bruno Ricci366ba732018-09-21 12:53:22 +00003588 (NeedDecls && II->getFETokenInfo()))
Richard Smithcf97cf62015-04-19 01:34:23 +00003589 return true;
3590
3591 return false;
3592 }
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00003593
Douglas Gregore84a9da2009-04-20 20:36:09 +00003594public:
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003595 using key_type = IdentifierInfo *;
3596 using key_type_ref = key_type;
Mike Stump11289f42009-09-09 15:08:12 +00003597
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003598 using data_type = IdentID;
3599 using data_type_ref = data_type;
Mike Stump11289f42009-09-09 15:08:12 +00003600
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003601 using hash_value_type = unsigned;
3602 using offset_type = unsigned;
Justin Bogner25463f12014-04-18 20:27:24 +00003603
Richard Smithd7329392015-04-21 21:46:32 +00003604 ASTIdentifierTableTrait(ASTWriter &Writer, Preprocessor &PP,
Richard Smith33e0f7e2015-07-22 02:08:40 +00003605 IdentifierResolver &IdResolver, bool IsModule,
3606 ASTWriter::RecordData *InterestingIdentifierOffsets)
Richard Smitha534a312015-07-21 23:54:07 +00003607 : Writer(Writer), PP(PP), IdResolver(IdResolver), IsModule(IsModule),
Richard Smith33e0f7e2015-07-22 02:08:40 +00003608 NeedDecls(!IsModule || !Writer.getLangOpts().CPlusPlus),
3609 InterestingIdentifierOffsets(InterestingIdentifierOffsets) {}
Douglas Gregore84a9da2009-04-20 20:36:09 +00003610
Richard Smithd79514e2016-02-05 19:03:40 +00003611 bool needDecls() const { return NeedDecls; }
3612
Justin Bogner25463f12014-04-18 20:27:24 +00003613 static hash_value_type ComputeHash(const IdentifierInfo* II) {
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00003614 return llvm::djbHash(II->getName());
Douglas Gregore84a9da2009-04-20 20:36:09 +00003615 }
Mike Stump11289f42009-09-09 15:08:12 +00003616
Richard Smith33e0f7e2015-07-22 02:08:40 +00003617 bool isInterestingIdentifier(const IdentifierInfo *II) {
3618 auto MacroOffset = Writer.getMacroDirectivesOffset(II);
3619 return isInterestingIdentifier(II, MacroOffset);
3620 }
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +00003621
Richard Smith9c254182015-07-19 21:41:12 +00003622 bool isInterestingNonMacroIdentifier(const IdentifierInfo *II) {
3623 return isInterestingIdentifier(II, 0);
3624 }
3625
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003626 std::pair<unsigned, unsigned>
Douglas Gregor935bc7a22011-10-27 09:33:13 +00003627 EmitKeyDataLength(raw_ostream& Out, IdentifierInfo* II, IdentID ID) {
Daniel Dunbar2c422dc92009-10-18 20:26:12 +00003628 unsigned KeyLen = II->getLength() + 1;
Douglas Gregor1d583f22009-04-28 21:18:29 +00003629 unsigned DataLen = 4; // 4 bytes for the persistent ID << 1
Richard Smithd7329392015-04-21 21:46:32 +00003630 auto MacroOffset = Writer.getMacroDirectivesOffset(II);
3631 if (isInterestingIdentifier(II, MacroOffset)) {
Alexander Kornienko1d26c022012-09-25 17:18:14 +00003632 DataLen += 2; // 2 bytes for builtin ID
3633 DataLen += 2; // 2 bytes for flags
Richard Smithd7329392015-04-21 21:46:32 +00003634 if (MacroOffset)
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00003635 DataLen += 4; // MacroDirectives offset.
Alexander Kornienko1d26c022012-09-25 17:18:14 +00003636
Richard Smitha534a312015-07-21 23:54:07 +00003637 if (NeedDecls) {
3638 for (IdentifierResolver::iterator D = IdResolver.begin(II),
3639 DEnd = IdResolver.end();
3640 D != DEnd; ++D)
3641 DataLen += 4;
3642 }
Douglas Gregor1d583f22009-04-28 21:18:29 +00003643 }
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003644
Justin Bognere1c147c2014-03-28 22:03:19 +00003645 using namespace llvm::support;
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003646
Peter Collingbournee3f65292018-05-18 19:46:24 +00003647 endian::Writer LE(Out, little);
Justin Bognere1c147c2014-03-28 22:03:19 +00003648
Richard Smithdf8a8312015-03-13 04:05:01 +00003649 assert((uint16_t)DataLen == DataLen && (uint16_t)KeyLen == KeyLen);
Justin Bognere1c147c2014-03-28 22:03:19 +00003650 LE.write<uint16_t>(DataLen);
Douglas Gregorab4df582009-04-28 20:01:51 +00003651 // We emit the key length after the data length so that every
3652 // string is preceded by a 16-bit length. This matches the PTH
3653 // format for storing identifiers.
Justin Bognere1c147c2014-03-28 22:03:19 +00003654 LE.write<uint16_t>(KeyLen);
Douglas Gregore84a9da2009-04-20 20:36:09 +00003655 return std::make_pair(KeyLen, DataLen);
3656 }
Mike Stump11289f42009-09-09 15:08:12 +00003657
Chris Lattner0e62c1c2011-07-23 10:55:15 +00003658 void EmitKey(raw_ostream& Out, const IdentifierInfo* II,
Douglas Gregore84a9da2009-04-20 20:36:09 +00003659 unsigned KeyLen) {
3660 // Record the location of the key data. This is used when generating
3661 // the mapping from persistent IDs to strings.
3662 Writer.SetIdentifierOffset(II, Out.tell());
Richard Smith33e0f7e2015-07-22 02:08:40 +00003663
3664 // Emit the offset of the key/data length information to the interesting
3665 // identifiers table if necessary.
3666 if (InterestingIdentifierOffsets && isInterestingIdentifier(II))
3667 InterestingIdentifierOffsets->push_back(Out.tell() - 4);
3668
Daniel Dunbar2c422dc92009-10-18 20:26:12 +00003669 Out.write(II->getNameStart(), KeyLen);
Douglas Gregore84a9da2009-04-20 20:36:09 +00003670 }
Mike Stump11289f42009-09-09 15:08:12 +00003671
Douglas Gregor4a69c2e2011-09-01 17:04:32 +00003672 void EmitData(raw_ostream& Out, IdentifierInfo* II,
Sebastian Redl539c5062010-08-18 23:57:32 +00003673 IdentID ID, unsigned) {
Justin Bognere1c147c2014-03-28 22:03:19 +00003674 using namespace llvm::support;
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003675
Peter Collingbournee3f65292018-05-18 19:46:24 +00003676 endian::Writer LE(Out, little);
Richard Smithcf97cf62015-04-19 01:34:23 +00003677
Richard Smithd7329392015-04-21 21:46:32 +00003678 auto MacroOffset = Writer.getMacroDirectivesOffset(II);
3679 if (!isInterestingIdentifier(II, MacroOffset)) {
Justin Bognere1c147c2014-03-28 22:03:19 +00003680 LE.write<uint32_t>(ID << 1);
Douglas Gregor1d583f22009-04-28 21:18:29 +00003681 return;
3682 }
Douglas Gregorb9256522009-04-28 21:32:13 +00003683
Justin Bognere1c147c2014-03-28 22:03:19 +00003684 LE.write<uint32_t>((ID << 1) | 0x01);
Alexander Kornienko1d26c022012-09-25 17:18:14 +00003685 uint32_t Bits = (uint32_t)II->getObjCOrBuiltinID();
3686 assert((Bits & 0xffff) == Bits && "ObjCOrBuiltinID too big for ASTReader.");
Justin Bognere1c147c2014-03-28 22:03:19 +00003687 LE.write<uint16_t>(Bits);
Alexander Kornienko1d26c022012-09-25 17:18:14 +00003688 Bits = 0;
Richard Smithd7329392015-04-21 21:46:32 +00003689 bool HadMacroDefinition = MacroOffset != 0;
Alexander Kornienko1d26c022012-09-25 17:18:14 +00003690 Bits = (Bits << 1) | unsigned(HadMacroDefinition);
Daniel Dunbar91b640a2009-12-18 20:58:47 +00003691 Bits = (Bits << 1) | unsigned(II->isExtensionToken());
3692 Bits = (Bits << 1) | unsigned(II->isPoisoned());
Richard Smith9c254182015-07-19 21:41:12 +00003693 Bits = (Bits << 1) | unsigned(II->hasRevertedBuiltin());
Argyrios Kyrtzidis3084a612010-08-11 22:55:12 +00003694 Bits = (Bits << 1) | unsigned(II->hasRevertedTokenIDToIdentifier());
Daniel Dunbar91b640a2009-12-18 20:58:47 +00003695 Bits = (Bits << 1) | unsigned(II->isCPlusPlusOperatorKeyword());
Justin Bognere1c147c2014-03-28 22:03:19 +00003696 LE.write<uint16_t>(Bits);
Douglas Gregore84a9da2009-04-20 20:36:09 +00003697
Richard Smithd7329392015-04-21 21:46:32 +00003698 if (HadMacroDefinition)
3699 LE.write<uint32_t>(MacroOffset);
Alexander Kornienko1d26c022012-09-25 17:18:14 +00003700
Richard Smitha534a312015-07-21 23:54:07 +00003701 if (NeedDecls) {
3702 // Emit the declaration IDs in reverse order, because the
3703 // IdentifierResolver provides the declarations as they would be
3704 // visible (e.g., the function "stat" would come before the struct
3705 // "stat"), but the ASTReader adds declarations to the end of the list
3706 // (so we need to see the struct "stat" before the function "stat").
3707 // Only emit declarations that aren't from a chained PCH, though.
3708 SmallVector<NamedDecl *, 16> Decls(IdResolver.begin(II),
3709 IdResolver.end());
3710 for (SmallVectorImpl<NamedDecl *>::reverse_iterator D = Decls.rbegin(),
3711 DEnd = Decls.rend();
3712 D != DEnd; ++D)
3713 LE.write<uint32_t>(
3714 Writer.getDeclID(getDeclForLocalLookup(PP.getLangOpts(), *D)));
3715 }
Douglas Gregore84a9da2009-04-20 20:36:09 +00003716 }
3717};
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +00003718
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003719} // namespace
Douglas Gregore84a9da2009-04-20 20:36:09 +00003720
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003721/// Write the identifier table into the AST file.
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00003722///
3723/// The identifier table consists of a blob containing string data
3724/// (the actual identifiers themselves) and a separate "offsets" index
3725/// that maps identifier IDs to locations within the blob.
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00003726void ASTWriter::WriteIdentifierTable(Preprocessor &PP,
Douglas Gregor935bc7a22011-10-27 09:33:13 +00003727 IdentifierResolver &IdResolver,
3728 bool IsModule) {
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00003729 using namespace llvm;
3730
Richard Smith33e0f7e2015-07-22 02:08:40 +00003731 RecordData InterestingIdents;
3732
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00003733 // Create and write out the blob that contains the identifier
3734 // strings.
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00003735 {
Justin Bognerbb094f02014-04-18 19:57:06 +00003736 llvm::OnDiskChainedHashTableGenerator<ASTIdentifierTableTrait> Generator;
Richard Smith33e0f7e2015-07-22 02:08:40 +00003737 ASTIdentifierTableTrait Trait(
3738 *this, PP, IdResolver, IsModule,
3739 (getLangOpts().CPlusPlus && IsModule) ? &InterestingIdents : nullptr);
Mike Stump11289f42009-09-09 15:08:12 +00003740
Douglas Gregore6648fb2009-04-28 20:33:11 +00003741 // Look for any identifiers that were named while processing the
3742 // headers, but are otherwise not needed. We add these to the hash
3743 // table to enable checking of the predefines buffer in the case
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00003744 // where the user adds new macro definitions when building the AST
Douglas Gregore6648fb2009-04-28 20:33:11 +00003745 // file.
Chandler Carruth8440c982015-03-26 23:54:15 +00003746 SmallVector<const IdentifierInfo *, 128> IIs;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00003747 for (const auto &ID : PP.getIdentifierTable())
3748 IIs.push_back(ID.second);
Chandler Carruth8440c982015-03-26 23:54:15 +00003749 // Sort the identifiers lexicographically before getting them references so
3750 // that their order is stable.
Benjamin Kramercd2bae32019-08-22 17:32:16 +00003751 llvm::sort(IIs, llvm::deref<std::less<>>());
Chandler Carruth8440c982015-03-26 23:54:15 +00003752 for (const IdentifierInfo *II : IIs)
Richard Smith9c254182015-07-19 21:41:12 +00003753 if (Trait.isInterestingNonMacroIdentifier(II))
3754 getIdentifierRef(II);
Douglas Gregore6648fb2009-04-28 20:33:11 +00003755
Sebastian Redlff4a2952010-07-23 23:49:55 +00003756 // Create the on-disk hash table representation. We only store offsets
3757 // for identifiers that appear here for the first time.
3758 IdentifierOffsets.resize(NextIdentID - FirstIdentID);
Chandler Carruth885e78c2015-03-24 21:18:10 +00003759 for (auto IdentIDPair : IdentifierIDs) {
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00003760 auto *II = const_cast<IdentifierInfo *>(IdentIDPair.first);
Chandler Carruth885e78c2015-03-24 21:18:10 +00003761 IdentID ID = IdentIDPair.second;
3762 assert(II && "NULL identifier in identifier table");
Vassil Vassilev262f41e2016-03-30 20:16:03 +00003763 // Write out identifiers if either the ID is local or the identifier has
3764 // changed since it was loaded.
3765 if (ID >= FirstIdentID || !Chain || !II->isFromAST()
3766 || II->hasChangedSinceDeserialization() ||
Richard Smithd79514e2016-02-05 19:03:40 +00003767 (Trait.needDecls() &&
3768 II->hasFETokenInfoChangedSinceDeserialization()))
Chandler Carruth885e78c2015-03-24 21:18:10 +00003769 Generator.insert(II, ID, Trait);
Douglas Gregore84a9da2009-04-20 20:36:09 +00003770 }
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00003771
Douglas Gregore84a9da2009-04-20 20:36:09 +00003772 // Create the on-disk hash table in a buffer.
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00003773 SmallString<4096> IdentifierTable;
Douglas Gregora868bbd2009-04-21 22:25:48 +00003774 uint32_t BucketOffset;
Douglas Gregore84a9da2009-04-20 20:36:09 +00003775 {
Justin Bognere1c147c2014-03-28 22:03:19 +00003776 using namespace llvm::support;
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003777
Douglas Gregore84a9da2009-04-20 20:36:09 +00003778 llvm::raw_svector_ostream Out(IdentifierTable);
Douglas Gregorc78d3462009-04-24 21:10:55 +00003779 // Make sure that no bucket is at offset 0
Peter Collingbournee3f65292018-05-18 19:46:24 +00003780 endian::write<uint32_t>(Out, 0, little);
Douglas Gregora868bbd2009-04-21 22:25:48 +00003781 BucketOffset = Generator.Emit(Out, Trait);
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00003782 }
3783
3784 // Create a blob abbreviation
David Blaikieb44f0bf2017-01-04 22:36:43 +00003785 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Sebastian Redl539c5062010-08-18 23:57:32 +00003786 Abbrev->Add(BitCodeAbbrevOp(IDENTIFIER_TABLE));
Douglas Gregora868bbd2009-04-21 22:25:48 +00003787 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
Douglas Gregore84a9da2009-04-20 20:36:09 +00003788 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
David Blaikieb44f0bf2017-01-04 22:36:43 +00003789 unsigned IDTableAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00003790
3791 // Write the identifier table
Mehdi Amini57a41912015-09-10 01:46:39 +00003792 RecordData::value_type Record[] = {IDENTIFIER_TABLE, BucketOffset};
Yaron Keren92e1b622015-03-18 10:17:07 +00003793 Stream.EmitRecordWithBlob(IDTableAbbrev, Record, IdentifierTable);
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00003794 }
3795
3796 // Write the offsets table for identifier IDs.
David Blaikieb44f0bf2017-01-04 22:36:43 +00003797 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Sebastian Redl539c5062010-08-18 23:57:32 +00003798 Abbrev->Add(BitCodeAbbrevOp(IDENTIFIER_OFFSET));
Douglas Gregor0e149972009-04-25 19:10:14 +00003799 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // # of identifiers
Douglas Gregor1ab036c2011-08-03 21:49:18 +00003800 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // first ID
Douglas Gregor0e149972009-04-25 19:10:14 +00003801 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
David Blaikieb44f0bf2017-01-04 22:36:43 +00003802 unsigned IdentifierOffsetAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregor0e149972009-04-25 19:10:14 +00003803
Douglas Gregor8d7edce2013-02-08 21:30:59 +00003804#ifndef NDEBUG
3805 for (unsigned I = 0, N = IdentifierOffsets.size(); I != N; ++I)
3806 assert(IdentifierOffsets[I] && "Missing identifier offset?");
3807#endif
Mehdi Amini57a41912015-09-10 01:46:39 +00003808
3809 RecordData::value_type Record[] = {IDENTIFIER_OFFSET,
3810 IdentifierOffsets.size(),
3811 FirstIdentID - NUM_PREDEF_IDENT_IDS};
Douglas Gregor0e149972009-04-25 19:10:14 +00003812 Stream.EmitRecordWithBlob(IdentifierOffsetAbbrev, Record,
Reid Kleckner012665e2015-05-21 00:13:09 +00003813 bytes(IdentifierOffsets));
Richard Smith33e0f7e2015-07-22 02:08:40 +00003814
3815 // In C++, write the list of interesting identifiers (those that are
3816 // defined as macros, poisoned, or similar unusual things).
3817 if (!InterestingIdents.empty())
3818 Stream.EmitRecord(INTERESTING_IDENTIFIERS, InterestingIdents);
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00003819}
3820
Douglas Gregorc5046832009-04-27 18:38:38 +00003821//===----------------------------------------------------------------------===//
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003822// DeclContext's Name Lookup Table Serialization
3823//===----------------------------------------------------------------------===//
3824
3825namespace {
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +00003826
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003827// Trait used for the on-disk hash table used in the method pool.
3828class ASTDeclContextNameLookupTrait {
3829 ASTWriter &Writer;
Richard Smithd88a7f12015-09-01 20:35:42 +00003830 llvm::SmallVector<DeclID, 64> DeclIDs;
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003831
3832public:
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003833 using key_type = DeclarationNameKey;
3834 using key_type_ref = key_type;
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003835
Richard Smithd88a7f12015-09-01 20:35:42 +00003836 /// A start and end index into DeclIDs, representing a sequence of decls.
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003837 using data_type = std::pair<unsigned, unsigned>;
3838 using data_type_ref = const data_type &;
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003839
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003840 using hash_value_type = unsigned;
3841 using offset_type = unsigned;
Justin Bogner25463f12014-04-18 20:27:24 +00003842
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003843 explicit ASTDeclContextNameLookupTrait(ASTWriter &Writer) : Writer(Writer) {}
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003844
Richard Smithd88a7f12015-09-01 20:35:42 +00003845 template<typename Coll>
3846 data_type getData(const Coll &Decls) {
3847 unsigned Start = DeclIDs.size();
3848 for (NamedDecl *D : Decls) {
3849 DeclIDs.push_back(
3850 Writer.GetDeclRef(getDeclForLocalLookup(Writer.getLangOpts(), D)));
3851 }
3852 return std::make_pair(Start, DeclIDs.size());
3853 }
3854
3855 data_type ImportData(const reader::ASTDeclContextNameLookupTrait::data_type &FromReader) {
3856 unsigned Start = DeclIDs.size();
3857 for (auto ID : FromReader)
3858 DeclIDs.push_back(ID);
3859 return std::make_pair(Start, DeclIDs.size());
3860 }
3861
3862 static bool EqualKey(key_type_ref a, key_type_ref b) {
3863 return a == b;
3864 }
3865
Richard Smitha06c7e62015-08-26 23:55:49 +00003866 hash_value_type ComputeHash(DeclarationNameKey Name) {
3867 return Name.getHash();
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003868 }
3869
Richard Smithd88a7f12015-09-01 20:35:42 +00003870 void EmitFileRef(raw_ostream &Out, ModuleFile *F) const {
3871 assert(Writer.hasChain() &&
3872 "have reference to loaded module file but no chain?");
3873
3874 using namespace llvm::support;
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003875
Peter Collingbournee3f65292018-05-18 19:46:24 +00003876 endian::write<uint32_t>(Out, Writer.getChain()->getModuleFileID(F), little);
Richard Smithd88a7f12015-09-01 20:35:42 +00003877 }
3878
Richard Smitha06c7e62015-08-26 23:55:49 +00003879 std::pair<unsigned, unsigned> EmitKeyDataLength(raw_ostream &Out,
3880 DeclarationNameKey Name,
3881 data_type_ref Lookup) {
Justin Bognere1c147c2014-03-28 22:03:19 +00003882 using namespace llvm::support;
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003883
Peter Collingbournee3f65292018-05-18 19:46:24 +00003884 endian::Writer LE(Out, little);
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003885 unsigned KeyLen = 1;
Richard Smitha06c7e62015-08-26 23:55:49 +00003886 switch (Name.getKind()) {
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003887 case DeclarationName::Identifier:
3888 case DeclarationName::ObjCZeroArgSelector:
3889 case DeclarationName::ObjCOneArgSelector:
3890 case DeclarationName::ObjCMultiArgSelector:
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003891 case DeclarationName::CXXLiteralOperatorName:
Richard Smith35845152017-02-07 01:37:30 +00003892 case DeclarationName::CXXDeductionGuideName:
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003893 KeyLen += 4;
3894 break;
3895 case DeclarationName::CXXOperatorName:
3896 KeyLen += 1;
3897 break;
Douglas Gregor3b65ed02011-08-02 18:32:54 +00003898 case DeclarationName::CXXConstructorName:
3899 case DeclarationName::CXXDestructorName:
3900 case DeclarationName::CXXConversionFunctionName:
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003901 case DeclarationName::CXXUsingDirective:
3902 break;
3903 }
Justin Bognere1c147c2014-03-28 22:03:19 +00003904 LE.write<uint16_t>(KeyLen);
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003905
Richard Smithf02662d2015-07-30 03:17:16 +00003906 // 4 bytes for each DeclID.
Richard Smithd88a7f12015-09-01 20:35:42 +00003907 unsigned DataLen = 4 * (Lookup.second - Lookup.first);
3908 assert(uint16_t(DataLen) == DataLen &&
3909 "too many decls for serialized lookup result");
Justin Bognere1c147c2014-03-28 22:03:19 +00003910 LE.write<uint16_t>(DataLen);
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003911
3912 return std::make_pair(KeyLen, DataLen);
3913 }
3914
Richard Smitha06c7e62015-08-26 23:55:49 +00003915 void EmitKey(raw_ostream &Out, DeclarationNameKey Name, unsigned) {
Justin Bognere1c147c2014-03-28 22:03:19 +00003916 using namespace llvm::support;
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003917
Peter Collingbournee3f65292018-05-18 19:46:24 +00003918 endian::Writer LE(Out, little);
Richard Smitha06c7e62015-08-26 23:55:49 +00003919 LE.write<uint8_t>(Name.getKind());
3920 switch (Name.getKind()) {
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003921 case DeclarationName::Identifier:
Richard Smitha06c7e62015-08-26 23:55:49 +00003922 case DeclarationName::CXXLiteralOperatorName:
Richard Smith35845152017-02-07 01:37:30 +00003923 case DeclarationName::CXXDeductionGuideName:
Richard Smitha06c7e62015-08-26 23:55:49 +00003924 LE.write<uint32_t>(Writer.getIdentifierRef(Name.getIdentifier()));
Benjamin Kramer53750b12012-09-19 13:40:40 +00003925 return;
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003926 case DeclarationName::ObjCZeroArgSelector:
3927 case DeclarationName::ObjCOneArgSelector:
3928 case DeclarationName::ObjCMultiArgSelector:
Richard Smitha06c7e62015-08-26 23:55:49 +00003929 LE.write<uint32_t>(Writer.getSelectorRef(Name.getSelector()));
Benjamin Kramer53750b12012-09-19 13:40:40 +00003930 return;
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003931 case DeclarationName::CXXOperatorName:
Richard Smitha06c7e62015-08-26 23:55:49 +00003932 assert(Name.getOperatorKind() < NUM_OVERLOADED_OPERATORS &&
Benjamin Kramer53750b12012-09-19 13:40:40 +00003933 "Invalid operator?");
Richard Smitha06c7e62015-08-26 23:55:49 +00003934 LE.write<uint8_t>(Name.getOperatorKind());
Benjamin Kramer53750b12012-09-19 13:40:40 +00003935 return;
Douglas Gregor3b65ed02011-08-02 18:32:54 +00003936 case DeclarationName::CXXConstructorName:
3937 case DeclarationName::CXXDestructorName:
3938 case DeclarationName::CXXConversionFunctionName:
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003939 case DeclarationName::CXXUsingDirective:
Benjamin Kramer53750b12012-09-19 13:40:40 +00003940 return;
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003941 }
Benjamin Kramer53750b12012-09-19 13:40:40 +00003942
3943 llvm_unreachable("Invalid name kind?");
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003944 }
3945
Richard Smitha06c7e62015-08-26 23:55:49 +00003946 void EmitData(raw_ostream &Out, key_type_ref, data_type Lookup,
3947 unsigned DataLen) {
Justin Bognere1c147c2014-03-28 22:03:19 +00003948 using namespace llvm::support;
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003949
Peter Collingbournee3f65292018-05-18 19:46:24 +00003950 endian::Writer LE(Out, little);
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003951 uint64_t Start = Out.tell(); (void)Start;
Richard Smithd88a7f12015-09-01 20:35:42 +00003952 for (unsigned I = Lookup.first, N = Lookup.second; I != N; ++I)
3953 LE.write<uint32_t>(DeclIDs[I]);
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003954 assert(Out.tell() - Start == DataLen && "Data length is wrong");
3955 }
3956};
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +00003957
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003958} // namespace
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003959
Chandler Carruthe972c362015-03-26 03:11:40 +00003960bool ASTWriter::isLookupResultExternal(StoredDeclsList &Result,
3961 DeclContext *DC) {
Erich Keanef92f31c2018-08-01 20:48:16 +00003962 return Result.hasExternalDecls() &&
3963 DC->hasNeedToReconcileExternalVisibleStorage();
Chandler Carruthe972c362015-03-26 03:11:40 +00003964}
3965
3966bool ASTWriter::isLookupResultEntirelyExternal(StoredDeclsList &Result,
3967 DeclContext *DC) {
3968 for (auto *D : Result.getLookupResult())
3969 if (!getDeclForLocalLookup(getLangOpts(), D)->isFromASTFile())
3970 return false;
3971
3972 return true;
3973}
3974
Richard Smithd88a7f12015-09-01 20:35:42 +00003975void
Chandler Carruthe972c362015-03-26 03:11:40 +00003976ASTWriter::GenerateNameLookupTable(const DeclContext *ConstDC,
Richard Smithcd45dbc2014-04-19 03:48:30 +00003977 llvm::SmallVectorImpl<char> &LookupTable) {
Erich Keanef92f31c2018-08-01 20:48:16 +00003978 assert(!ConstDC->hasLazyLocalLexicalLookups() &&
3979 !ConstDC->hasLazyExternalLexicalLookups() &&
Richard Smith9e2341d2015-03-23 03:25:59 +00003980 "must call buildLookups first");
Richard Smithcd45dbc2014-04-19 03:48:30 +00003981
Chandler Carruthe972c362015-03-26 03:11:40 +00003982 // FIXME: We need to build the lookups table, which is logically const.
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00003983 auto *DC = const_cast<DeclContext*>(ConstDC);
Chandler Carruthe972c362015-03-26 03:11:40 +00003984 assert(DC == DC->getPrimaryContext() && "only primary DC has lookup table");
3985
3986 // Create the on-disk hash table representation.
Richard Smithd88a7f12015-09-01 20:35:42 +00003987 MultiOnDiskHashTableGenerator<reader::ASTDeclContextNameLookupTrait,
3988 ASTDeclContextNameLookupTrait> Generator;
Richard Smithcd45dbc2014-04-19 03:48:30 +00003989 ASTDeclContextNameLookupTrait Trait(*this);
3990
Chandler Carruthe972c362015-03-26 03:11:40 +00003991 // The first step is to collect the declaration names which we need to
3992 // serialize into the name lookup table, and to collect them in a stable
3993 // order.
3994 SmallVector<DeclarationName, 16> Names;
Richard Smithcd45dbc2014-04-19 03:48:30 +00003995
Chandler Carruthe972c362015-03-26 03:11:40 +00003996 // We also build up small sets of the constructor and conversion function
3997 // names which are visible.
3998 llvm::SmallSet<DeclarationName, 8> ConstructorNameSet, ConversionNameSet;
Richard Smithcd45dbc2014-04-19 03:48:30 +00003999
Chandler Carruthe972c362015-03-26 03:11:40 +00004000 for (auto &Lookup : *DC->buildLookup()) {
4001 auto &Name = Lookup.first;
4002 auto &Result = Lookup.second;
4003
Douglas Gregor7dd37e52015-11-03 01:20:54 +00004004 // If there are no local declarations in our lookup result, we
4005 // don't need to write an entry for the name at all. If we can't
4006 // write out a lookup set without performing more deserialization,
4007 // just skip this entry.
4008 if (isLookupResultExternal(Result, DC) &&
Chandler Carruthe972c362015-03-26 03:11:40 +00004009 isLookupResultEntirelyExternal(Result, DC))
4010 continue;
4011
4012 // We also skip empty results. If any of the results could be external and
4013 // the currently available results are empty, then all of the results are
4014 // external and we skip it above. So the only way we get here with an empty
4015 // results is when no results could have been external *and* we have
4016 // external results.
4017 //
4018 // FIXME: While we might want to start emitting on-disk entries for negative
4019 // lookups into a decl context as an optimization, today we *have* to skip
4020 // them because there are names with empty lookup results in decl contexts
4021 // which we can't emit in any stable ordering: we lookup constructors and
4022 // conversion functions in the enclosing namespace scope creating empty
4023 // results for them. This in almost certainly a bug in Clang's name lookup,
4024 // but that is likely to be hard or impossible to fix and so we tolerate it
4025 // here by omitting lookups with empty results.
4026 if (Lookup.second.getLookupResult().empty())
4027 continue;
4028
4029 switch (Lookup.first.getNameKind()) {
4030 default:
4031 Names.push_back(Lookup.first);
4032 break;
4033
Richard Smithcd45dbc2014-04-19 03:48:30 +00004034 case DeclarationName::CXXConstructorName:
Chandler Carruthe972c362015-03-26 03:11:40 +00004035 assert(isa<CXXRecordDecl>(DC) &&
4036 "Cannot have a constructor name outside of a class!");
4037 ConstructorNameSet.insert(Name);
4038 break;
Richard Smithcd45dbc2014-04-19 03:48:30 +00004039
4040 case DeclarationName::CXXConversionFunctionName:
Chandler Carruthe972c362015-03-26 03:11:40 +00004041 assert(isa<CXXRecordDecl>(DC) &&
4042 "Cannot have a conversion function name outside of a class!");
4043 ConversionNameSet.insert(Name);
Rafael Espindolac606b3e2015-03-25 04:43:15 +00004044 break;
Richard Smithcd45dbc2014-04-19 03:48:30 +00004045 }
Chandler Carruth75c9f132015-03-25 00:34:51 +00004046 }
Chandler Carruth75c9f132015-03-25 00:34:51 +00004047
Chandler Carruthe972c362015-03-26 03:11:40 +00004048 // Sort the names into a stable order.
Fangrui Song55fab262018-09-26 22:16:28 +00004049 llvm::sort(Names);
Chandler Carruthe972c362015-03-26 03:11:40 +00004050
Chandler Carruthffbf7052015-03-26 22:27:09 +00004051 if (auto *D = dyn_cast<CXXRecordDecl>(DC)) {
Chandler Carruthe972c362015-03-26 03:11:40 +00004052 // We need to establish an ordering of constructor and conversion function
Chandler Carruthffbf7052015-03-26 22:27:09 +00004053 // names, and they don't have an intrinsic ordering.
Chandler Carruthe972c362015-03-26 03:11:40 +00004054
Chandler Carruthffbf7052015-03-26 22:27:09 +00004055 // First we try the easy case by forming the current context's constructor
4056 // name and adding that name first. This is a very useful optimization to
4057 // avoid walking the lexical declarations in many cases, and it also
4058 // handles the only case where a constructor name can come from some other
4059 // lexical context -- when that name is an implicit constructor merged from
4060 // another declaration in the redecl chain. Any non-implicit constructor or
4061 // conversion function which doesn't occur in all the lexical contexts
4062 // would be an ODR violation.
4063 auto ImplicitCtorName = Context->DeclarationNames.getCXXConstructorName(
4064 Context->getCanonicalType(Context->getRecordType(D)));
4065 if (ConstructorNameSet.erase(ImplicitCtorName))
4066 Names.push_back(ImplicitCtorName);
Chandler Carruthe972c362015-03-26 03:11:40 +00004067
Chandler Carruthffbf7052015-03-26 22:27:09 +00004068 // If we still have constructors or conversion functions, we walk all the
4069 // names in the decl and add the constructors and conversion functions
4070 // which are visible in the order they lexically occur within the context.
4071 if (!ConstructorNameSet.empty() || !ConversionNameSet.empty())
4072 for (Decl *ChildD : cast<CXXRecordDecl>(DC)->decls())
4073 if (auto *ChildND = dyn_cast<NamedDecl>(ChildD)) {
4074 auto Name = ChildND->getDeclName();
4075 switch (Name.getNameKind()) {
4076 default:
4077 continue;
4078
4079 case DeclarationName::CXXConstructorName:
4080 if (ConstructorNameSet.erase(Name))
4081 Names.push_back(Name);
4082 break;
4083
4084 case DeclarationName::CXXConversionFunctionName:
4085 if (ConversionNameSet.erase(Name))
4086 Names.push_back(Name);
4087 break;
4088 }
4089
4090 if (ConstructorNameSet.empty() && ConversionNameSet.empty())
4091 break;
Chandler Carruthe972c362015-03-26 03:11:40 +00004092 }
4093
Chandler Carruthe972c362015-03-26 03:11:40 +00004094 assert(ConstructorNameSet.empty() && "Failed to find all of the visible "
4095 "constructors by walking all the "
4096 "lexical members of the context.");
4097 assert(ConversionNameSet.empty() && "Failed to find all of the visible "
4098 "conversion functions by walking all "
4099 "the lexical members of the context.");
Richard Smith961eae52014-03-25 01:14:22 +00004100 }
4101
Chandler Carruthe972c362015-03-26 03:11:40 +00004102 // Next we need to do a lookup with each name into this decl context to fully
4103 // populate any results from external sources. We don't actually use the
4104 // results of these lookups because we only want to use the results after all
4105 // results have been loaded and the pointers into them will be stable.
4106 for (auto &Name : Names)
4107 DC->lookup(Name);
4108
4109 // Now we need to insert the results for each name into the hash table. For
4110 // constructor names and conversion function names, we actually need to merge
4111 // all of the results for them into one list of results each and insert
4112 // those.
4113 SmallVector<NamedDecl *, 8> ConstructorDecls;
4114 SmallVector<NamedDecl *, 8> ConversionDecls;
4115
4116 // Now loop over the names, either inserting them or appending for the two
4117 // special cases.
4118 for (auto &Name : Names) {
4119 DeclContext::lookup_result Result = DC->noload_lookup(Name);
4120
4121 switch (Name.getNameKind()) {
4122 default:
Richard Smithd88a7f12015-09-01 20:35:42 +00004123 Generator.insert(Name, Trait.getData(Result), Trait);
Chandler Carruthe972c362015-03-26 03:11:40 +00004124 break;
4125
4126 case DeclarationName::CXXConstructorName:
4127 ConstructorDecls.append(Result.begin(), Result.end());
4128 break;
4129
4130 case DeclarationName::CXXConversionFunctionName:
4131 ConversionDecls.append(Result.begin(), Result.end());
4132 break;
4133 }
4134 }
4135
4136 // Handle our two special cases if we ended up having any. We arbitrarily use
4137 // the first declaration's name here because the name itself isn't part of
4138 // the key, only the kind of name is used.
4139 if (!ConstructorDecls.empty())
4140 Generator.insert(ConstructorDecls.front()->getDeclName(),
Richard Smithd88a7f12015-09-01 20:35:42 +00004141 Trait.getData(ConstructorDecls), Trait);
Chandler Carruthe972c362015-03-26 03:11:40 +00004142 if (!ConversionDecls.empty())
4143 Generator.insert(ConversionDecls.front()->getDeclName(),
Richard Smithd88a7f12015-09-01 20:35:42 +00004144 Trait.getData(ConversionDecls), Trait);
Chandler Carruthe972c362015-03-26 03:11:40 +00004145
Richard Smithd88a7f12015-09-01 20:35:42 +00004146 // Create the on-disk hash table. Also emit the existing imported and
4147 // merged table if there is one.
4148 auto *Lookups = Chain ? Chain->getLoadedLookupTables(DC) : nullptr;
4149 Generator.emit(LookupTable, Trait, Lookups ? &Lookups->Table : nullptr);
Richard Smith961eae52014-03-25 01:14:22 +00004150}
4151
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00004152/// Write the block containing all of the declaration IDs
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00004153/// visible from the given DeclContext.
4154///
4155/// \returns the offset of the DECL_CONTEXT_VISIBLE block within the
Sebastian Redla4071b42010-08-24 00:50:09 +00004156/// bitstream, or 0 if no block was written.
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00004157uint64_t ASTWriter::WriteDeclContextVisibleBlock(ASTContext &Context,
4158 DeclContext *DC) {
Richard Smith5fc18a92015-07-12 23:43:21 +00004159 // If we imported a key declaration of this namespace, write the visible
4160 // lookup results as an update record for it rather than including them
4161 // on this declaration. We will only look at key declarations on reload.
4162 if (isa<NamespaceDecl>(DC) && Chain &&
4163 Chain->getKeyDeclaration(cast<Decl>(DC))->isFromASTFile()) {
4164 // Only do this once, for the first local declaration of the namespace.
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00004165 for (auto *Prev = cast<NamespaceDecl>(DC)->getPreviousDecl(); Prev;
Richard Smith5fc18a92015-07-12 23:43:21 +00004166 Prev = Prev->getPreviousDecl())
4167 if (!Prev->isFromASTFile())
4168 return 0;
4169
4170 // Note that we need to emit an update record for the primary context.
4171 UpdatedDeclContexts.insert(DC->getPrimaryContext());
4172
4173 // Make sure all visible decls are written. They will be recorded later. We
4174 // do this using a side data structure so we can sort the names into
4175 // a deterministic order.
4176 StoredDeclsMap *Map = DC->getPrimaryContext()->buildLookup();
4177 SmallVector<std::pair<DeclarationName, DeclContext::lookup_result>, 16>
4178 LookupResults;
4179 if (Map) {
4180 LookupResults.reserve(Map->size());
4181 for (auto &Entry : *Map)
4182 LookupResults.push_back(
4183 std::make_pair(Entry.first, Entry.second.getLookupResult()));
4184 }
4185
Fangrui Song55fab262018-09-26 22:16:28 +00004186 llvm::sort(LookupResults, llvm::less_first());
Richard Smith5fc18a92015-07-12 23:43:21 +00004187 for (auto &NameAndResult : LookupResults) {
4188 DeclarationName Name = NameAndResult.first;
4189 DeclContext::lookup_result Result = NameAndResult.second;
4190 if (Name.getNameKind() == DeclarationName::CXXConstructorName ||
4191 Name.getNameKind() == DeclarationName::CXXConversionFunctionName) {
4192 // We have to work around a name lookup bug here where negative lookup
4193 // results for these names get cached in namespace lookup tables (these
4194 // names should never be looked up in a namespace).
4195 assert(Result.empty() && "Cannot have a constructor or conversion "
4196 "function name in a namespace!");
4197 continue;
4198 }
4199
4200 for (NamedDecl *ND : Result)
4201 if (!ND->isFromASTFile())
4202 GetDeclRef(ND);
4203 }
4204
4205 return 0;
4206 }
4207
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00004208 if (DC->getPrimaryContext() != DC)
4209 return 0;
4210
Chandler Carruthe972c362015-03-26 03:11:40 +00004211 // Skip contexts which don't support name lookup.
4212 if (!DC->isLookupContext())
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00004213 return 0;
4214
4215 // If not in C++, we perform name lookup for the translation unit via the
4216 // IdentifierInfo chains, don't bother to build a visible-declarations table.
David Blaikiebbafb8a2012-03-11 07:00:24 +00004217 if (DC->isTranslationUnit() && !Context.getLangOpts().CPlusPlus)
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00004218 return 0;
4219
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00004220 // Serialize the contents of the mapping used for lookup. Note that,
4221 // although we have two very different code paths, the serialized
4222 // representation is the same for both cases: a declaration name,
4223 // followed by a size, followed by references to the visible
4224 // declarations that have that name.
4225 uint64_t Offset = Stream.GetCurrentBitNo();
Richard Smithf634c902012-03-16 06:12:59 +00004226 StoredDeclsMap *Map = DC->buildLookup();
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00004227 if (!Map || Map->empty())
4228 return 0;
4229
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00004230 // Create the on-disk hash table in a buffer.
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00004231 SmallString<4096> LookupTable;
Richard Smithd88a7f12015-09-01 20:35:42 +00004232 GenerateNameLookupTable(DC, LookupTable);
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00004233
4234 // Write the lookup table
Mehdi Amini57a41912015-09-10 01:46:39 +00004235 RecordData::value_type Record[] = {DECL_CONTEXT_VISIBLE};
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00004236 Stream.EmitRecordWithBlob(DeclContextVisibleLookupAbbrev, Record,
Yaron Keren92e1b622015-03-18 10:17:07 +00004237 LookupTable);
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00004238 ++NumVisibleDeclContexts;
4239 return Offset;
4240}
4241
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00004242/// Write an UPDATE_VISIBLE block for the given context.
Sebastian Redla4071b42010-08-24 00:50:09 +00004243///
4244/// UPDATE_VISIBLE blocks contain the declarations that are added to an existing
4245/// DeclContext in a dependent AST file. As such, they only exist for the TU
Richard Smithf634c902012-03-16 06:12:59 +00004246/// (in C++), for namespaces, and for classes with forward-declared unscoped
4247/// enumeration members (in C++11).
Sebastian Redla4071b42010-08-24 00:50:09 +00004248void ASTWriter::WriteDeclContextVisibleUpdate(const DeclContext *DC) {
Richard Smith961eae52014-03-25 01:14:22 +00004249 StoredDeclsMap *Map = DC->getLookupPtr();
Sebastian Redla4071b42010-08-24 00:50:09 +00004250 if (!Map || Map->empty())
4251 return;
4252
Sebastian Redla4071b42010-08-24 00:50:09 +00004253 // Create the on-disk hash table in a buffer.
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00004254 SmallString<4096> LookupTable;
Richard Smithd88a7f12015-09-01 20:35:42 +00004255 GenerateNameLookupTable(DC, LookupTable);
Sebastian Redla4071b42010-08-24 00:50:09 +00004256
Richard Smith5fc18a92015-07-12 23:43:21 +00004257 // If we're updating a namespace, select a key declaration as the key for the
4258 // update record; those are the only ones that will be checked on reload.
4259 if (isa<NamespaceDecl>(DC))
4260 DC = cast<DeclContext>(Chain->getKeyDeclaration(cast<Decl>(DC)));
4261
Sebastian Redla4071b42010-08-24 00:50:09 +00004262 // Write the lookup table
Mehdi Amini57a41912015-09-10 01:46:39 +00004263 RecordData::value_type Record[] = {UPDATE_VISIBLE, getDeclID(cast<Decl>(DC))};
Yaron Keren92e1b622015-03-18 10:17:07 +00004264 Stream.EmitRecordWithBlob(UpdateVisibleAbbrev, Record, LookupTable);
Sebastian Redla4071b42010-08-24 00:50:09 +00004265}
4266
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00004267/// Write an FP_PRAGMA_OPTIONS block for the given FPOptions.
Peter Collingbourne5df20e02011-02-15 19:46:30 +00004268void ASTWriter::WriteFPPragmaOptions(const FPOptions &Opts) {
Adam Nemet484aa452017-03-27 19:17:25 +00004269 RecordData::value_type Record[] = {Opts.getInt()};
Peter Collingbourne5df20e02011-02-15 19:46:30 +00004270 Stream.EmitRecord(FP_PRAGMA_OPTIONS, Record);
4271}
4272
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00004273/// Write an OPENCL_EXTENSIONS block for the given OpenCLOptions.
Peter Collingbourne5df20e02011-02-15 19:46:30 +00004274void ASTWriter::WriteOpenCLExtensions(Sema &SemaRef) {
David Blaikiebbafb8a2012-03-11 07:00:24 +00004275 if (!SemaRef.Context.getLangOpts().OpenCL)
Peter Collingbourne5df20e02011-02-15 19:46:30 +00004276 return;
4277
4278 const OpenCLOptions &Opts = SemaRef.getOpenCLOptions();
4279 RecordData Record;
Yaxun Liu5b746652016-12-18 05:18:55 +00004280 for (const auto &I:Opts.OptMap) {
4281 AddString(I.getKey(), Record);
4282 auto V = I.getValue();
Yaxun Liucc2741c2016-12-18 06:35:06 +00004283 Record.push_back(V.Supported ? 1 : 0);
4284 Record.push_back(V.Enabled ? 1 : 0);
Yaxun Liu5b746652016-12-18 05:18:55 +00004285 Record.push_back(V.Avail);
4286 Record.push_back(V.Core);
4287 }
Peter Collingbourne5df20e02011-02-15 19:46:30 +00004288 Stream.EmitRecord(OPENCL_EXTENSIONS, Record);
4289}
4290
Yaxun Liu5b746652016-12-18 05:18:55 +00004291void ASTWriter::WriteOpenCLExtensionTypes(Sema &SemaRef) {
4292 if (!SemaRef.Context.getLangOpts().OpenCL)
4293 return;
4294
Bruno Ricci2751b692019-04-18 15:13:27 +00004295 // Sort the elements of the map OpenCLTypeExtMap by TypeIDs,
4296 // without copying them.
4297 const llvm::DenseMap<const Type *, std::set<std::string>> &OpenCLTypeExtMap =
4298 SemaRef.OpenCLTypeExtMap;
4299 using ElementTy = std::pair<TypeID, const std::set<std::string> *>;
4300 llvm::SmallVector<ElementTy, 8> StableOpenCLTypeExtMap;
4301 StableOpenCLTypeExtMap.reserve(OpenCLTypeExtMap.size());
4302
4303 for (const auto &I : OpenCLTypeExtMap)
4304 StableOpenCLTypeExtMap.emplace_back(
4305 getTypeID(I.first->getCanonicalTypeInternal()), &I.second);
4306
4307 auto CompareByTypeID = [](const ElementTy &E1, const ElementTy &E2) -> bool {
4308 return E1.first < E2.first;
4309 };
4310 llvm::sort(StableOpenCLTypeExtMap, CompareByTypeID);
4311
Yaxun Liu5b746652016-12-18 05:18:55 +00004312 RecordData Record;
Bruno Ricci2751b692019-04-18 15:13:27 +00004313 for (const ElementTy &E : StableOpenCLTypeExtMap) {
4314 Record.push_back(E.first); // TypeID
4315 const std::set<std::string> *ExtSet = E.second;
4316 Record.push_back(static_cast<unsigned>(ExtSet->size()));
4317 for (const std::string &Ext : *ExtSet)
Yaxun Liu5b746652016-12-18 05:18:55 +00004318 AddString(Ext, Record);
4319 }
Bruno Ricci2751b692019-04-18 15:13:27 +00004320
Yaxun Liu5b746652016-12-18 05:18:55 +00004321 Stream.EmitRecord(OPENCL_EXTENSION_TYPES, Record);
4322}
4323
4324void ASTWriter::WriteOpenCLExtensionDecls(Sema &SemaRef) {
4325 if (!SemaRef.Context.getLangOpts().OpenCL)
4326 return;
4327
Bruno Ricci2751b692019-04-18 15:13:27 +00004328 // Sort the elements of the map OpenCLDeclExtMap by DeclIDs,
4329 // without copying them.
4330 const llvm::DenseMap<const Decl *, std::set<std::string>> &OpenCLDeclExtMap =
4331 SemaRef.OpenCLDeclExtMap;
4332 using ElementTy = std::pair<DeclID, const std::set<std::string> *>;
4333 llvm::SmallVector<ElementTy, 8> StableOpenCLDeclExtMap;
4334 StableOpenCLDeclExtMap.reserve(OpenCLDeclExtMap.size());
4335
4336 for (const auto &I : OpenCLDeclExtMap)
4337 StableOpenCLDeclExtMap.emplace_back(getDeclID(I.first), &I.second);
4338
4339 auto CompareByDeclID = [](const ElementTy &E1, const ElementTy &E2) -> bool {
4340 return E1.first < E2.first;
4341 };
4342 llvm::sort(StableOpenCLDeclExtMap, CompareByDeclID);
4343
Yaxun Liu5b746652016-12-18 05:18:55 +00004344 RecordData Record;
Bruno Ricci2751b692019-04-18 15:13:27 +00004345 for (const ElementTy &E : StableOpenCLDeclExtMap) {
4346 Record.push_back(E.first); // DeclID
4347 const std::set<std::string> *ExtSet = E.second;
4348 Record.push_back(static_cast<unsigned>(ExtSet->size()));
4349 for (const std::string &Ext : *ExtSet)
Yaxun Liu5b746652016-12-18 05:18:55 +00004350 AddString(Ext, Record);
4351 }
Bruno Ricci2751b692019-04-18 15:13:27 +00004352
Yaxun Liu5b746652016-12-18 05:18:55 +00004353 Stream.EmitRecord(OPENCL_EXTENSION_DECLS, Record);
4354}
4355
Justin Lebar67a78a62016-10-08 22:15:58 +00004356void ASTWriter::WriteCUDAPragmas(Sema &SemaRef) {
4357 if (SemaRef.ForceCUDAHostDeviceDepth > 0) {
4358 RecordData::value_type Record[] = {SemaRef.ForceCUDAHostDeviceDepth};
4359 Stream.EmitRecord(CUDA_PRAGMA_FORCE_HOST_DEVICE_DEPTH, Record);
4360 }
4361}
4362
Douglas Gregor404cdde2012-01-27 01:47:08 +00004363void ASTWriter::WriteObjCCategories() {
Dmitri Gribenkof8579502013-01-12 19:30:44 +00004364 SmallVector<ObjCCategoriesInfo, 2> CategoriesMap;
Douglas Gregor404cdde2012-01-27 01:47:08 +00004365 RecordData Categories;
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00004366
Douglas Gregor404cdde2012-01-27 01:47:08 +00004367 for (unsigned I = 0, N = ObjCClassesWithCategories.size(); I != N; ++I) {
4368 unsigned Size = 0;
4369 unsigned StartIndex = Categories.size();
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00004370
Douglas Gregor404cdde2012-01-27 01:47:08 +00004371 ObjCInterfaceDecl *Class = ObjCClassesWithCategories[I];
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00004372
Douglas Gregor404cdde2012-01-27 01:47:08 +00004373 // Allocate space for the size.
4374 Categories.push_back(0);
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00004375
Douglas Gregor404cdde2012-01-27 01:47:08 +00004376 // Add the categories.
Douglas Gregor048fbfa2013-01-16 23:00:23 +00004377 for (ObjCInterfaceDecl::known_categories_iterator
4378 Cat = Class->known_categories_begin(),
4379 CatEnd = Class->known_categories_end();
4380 Cat != CatEnd; ++Cat, ++Size) {
4381 assert(getDeclID(*Cat) != 0 && "Bogus category");
4382 AddDeclRef(*Cat, Categories);
Douglas Gregor404cdde2012-01-27 01:47:08 +00004383 }
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00004384
Douglas Gregor404cdde2012-01-27 01:47:08 +00004385 // Update the size.
4386 Categories[StartIndex] = Size;
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00004387
Douglas Gregor404cdde2012-01-27 01:47:08 +00004388 // Record this interface -> category map.
4389 ObjCCategoriesInfo CatInfo = { getDeclID(Class), StartIndex };
4390 CategoriesMap.push_back(CatInfo);
4391 }
4392
4393 // Sort the categories map by the definition ID, since the reader will be
4394 // performing binary searches on this information.
4395 llvm::array_pod_sort(CategoriesMap.begin(), CategoriesMap.end());
4396
4397 // Emit the categories map.
4398 using namespace llvm;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00004399
David Blaikieb44f0bf2017-01-04 22:36:43 +00004400 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Douglas Gregor404cdde2012-01-27 01:47:08 +00004401 Abbrev->Add(BitCodeAbbrevOp(OBJC_CATEGORIES_MAP));
4402 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // # of entries
4403 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
David Blaikieb44f0bf2017-01-04 22:36:43 +00004404 unsigned AbbrevID = Stream.EmitAbbrev(std::move(Abbrev));
Mehdi Amini57a41912015-09-10 01:46:39 +00004405
4406 RecordData::value_type Record[] = {OBJC_CATEGORIES_MAP, CategoriesMap.size()};
4407 Stream.EmitRecordWithBlob(AbbrevID, Record,
4408 reinterpret_cast<char *>(CategoriesMap.data()),
Douglas Gregor404cdde2012-01-27 01:47:08 +00004409 CategoriesMap.size() * sizeof(ObjCCategoriesInfo));
Mehdi Amini57a41912015-09-10 01:46:39 +00004410
Douglas Gregor404cdde2012-01-27 01:47:08 +00004411 // Emit the category lists.
4412 Stream.EmitRecord(OBJC_CATEGORIES, Categories);
4413}
4414
Richard Smithe40f2ba2013-08-07 21:41:30 +00004415void ASTWriter::WriteLateParsedTemplates(Sema &SemaRef) {
4416 Sema::LateParsedTemplateMapT &LPTMap = SemaRef.LateParsedTemplateMap;
4417
4418 if (LPTMap.empty())
4419 return;
4420
4421 RecordData Record;
Justin Lebar28f09c52016-10-10 16:26:08 +00004422 for (auto &LPTMapEntry : LPTMap) {
Chandler Carruth52cee4d2015-03-26 09:08:15 +00004423 const FunctionDecl *FD = LPTMapEntry.first;
Justin Lebar28f09c52016-10-10 16:26:08 +00004424 LateParsedTemplate &LPT = *LPTMapEntry.second;
Chandler Carruth52cee4d2015-03-26 09:08:15 +00004425 AddDeclRef(FD, Record);
Justin Lebar28f09c52016-10-10 16:26:08 +00004426 AddDeclRef(LPT.D, Record);
4427 Record.push_back(LPT.Toks.size());
Richard Smithe40f2ba2013-08-07 21:41:30 +00004428
Justin Lebar28f09c52016-10-10 16:26:08 +00004429 for (const auto &Tok : LPT.Toks) {
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00004430 AddToken(Tok, Record);
Richard Smithe40f2ba2013-08-07 21:41:30 +00004431 }
4432 }
4433 Stream.EmitRecord(LATE_PARSED_TEMPLATE, Record);
4434}
4435
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00004436/// Write the state of 'pragma clang optimize' at the end of the module.
Dario Domizioli13a0a382014-05-23 12:13:25 +00004437void ASTWriter::WriteOptimizePragmaOptions(Sema &SemaRef) {
4438 RecordData Record;
4439 SourceLocation PragmaLoc = SemaRef.getOptimizeOffPragmaLocation();
4440 AddSourceLocation(PragmaLoc, Record);
4441 Stream.EmitRecord(OPTIMIZE_PRAGMA_OPTIONS, Record);
4442}
4443
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00004444/// Write the state of 'pragma ms_struct' at the end of the module.
Nico Weber779355f2016-03-02 23:22:00 +00004445void ASTWriter::WriteMSStructPragmaOptions(Sema &SemaRef) {
4446 RecordData Record;
4447 Record.push_back(SemaRef.MSStructPragmaOn ? PMSST_ON : PMSST_OFF);
4448 Stream.EmitRecord(MSSTRUCT_PRAGMA_OPTIONS, Record);
4449}
4450
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00004451/// Write the state of 'pragma pointers_to_members' at the end of the
Nico Weber42932312016-03-03 00:17:35 +00004452//module.
4453void ASTWriter::WriteMSPointersToMembersPragmaOptions(Sema &SemaRef) {
4454 RecordData Record;
4455 Record.push_back(SemaRef.MSPointerToMemberRepresentationMethod);
4456 AddSourceLocation(SemaRef.ImplicitMSInheritanceAttrLoc, Record);
4457 Stream.EmitRecord(POINTERS_TO_MEMBERS_PRAGMA_OPTIONS, Record);
4458}
4459
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00004460/// Write the state of 'pragma pack' at the end of the module.
Alex Lorenz7d7e1e02017-03-31 15:36:21 +00004461void ASTWriter::WritePackPragmaOptions(Sema &SemaRef) {
Duncan P. N. Exon Smith03df14c2017-04-15 00:07:57 +00004462 // Don't serialize pragma pack state for modules, since it should only take
4463 // effect on a per-submodule basis.
4464 if (WritingModule)
4465 return;
4466
Alex Lorenz7d7e1e02017-03-31 15:36:21 +00004467 RecordData Record;
4468 Record.push_back(SemaRef.PackStack.CurrentValue);
4469 AddSourceLocation(SemaRef.PackStack.CurrentPragmaLocation, Record);
4470 Record.push_back(SemaRef.PackStack.Stack.size());
4471 for (const auto &StackEntry : SemaRef.PackStack.Stack) {
4472 Record.push_back(StackEntry.Value);
4473 AddSourceLocation(StackEntry.PragmaLocation, Record);
Alex Lorenz45b40142017-07-28 14:41:21 +00004474 AddSourceLocation(StackEntry.PragmaPushLocation, Record);
Alex Lorenz7d7e1e02017-03-31 15:36:21 +00004475 AddString(StackEntry.StackSlotLabel, Record);
4476 }
4477 Stream.EmitRecord(PACK_PRAGMA_OPTIONS, Record);
4478}
4479
Douglas Gregor8f64ca12015-12-08 22:43:32 +00004480void ASTWriter::WriteModuleFileExtension(Sema &SemaRef,
4481 ModuleFileExtensionWriter &Writer) {
Douglas Gregor6623e1f2015-11-03 18:33:07 +00004482 // Enter the extension block.
4483 Stream.EnterSubblock(EXTENSION_BLOCK_ID, 4);
4484
4485 // Emit the metadata record abbreviation.
David Blaikieb44f0bf2017-01-04 22:36:43 +00004486 auto Abv = std::make_shared<llvm::BitCodeAbbrev>();
Douglas Gregor6623e1f2015-11-03 18:33:07 +00004487 Abv->Add(llvm::BitCodeAbbrevOp(EXTENSION_METADATA));
4488 Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::VBR, 6));
4489 Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::VBR, 6));
4490 Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::VBR, 6));
4491 Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::VBR, 6));
4492 Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::Blob));
David Blaikieb44f0bf2017-01-04 22:36:43 +00004493 unsigned Abbrev = Stream.EmitAbbrev(std::move(Abv));
Douglas Gregor6623e1f2015-11-03 18:33:07 +00004494
4495 // Emit the metadata record.
4496 RecordData Record;
4497 auto Metadata = Writer.getExtension()->getExtensionMetadata();
4498 Record.push_back(EXTENSION_METADATA);
4499 Record.push_back(Metadata.MajorVersion);
4500 Record.push_back(Metadata.MinorVersion);
4501 Record.push_back(Metadata.BlockName.size());
4502 Record.push_back(Metadata.UserInfo.size());
4503 SmallString<64> Buffer;
4504 Buffer += Metadata.BlockName;
4505 Buffer += Metadata.UserInfo;
4506 Stream.EmitRecordWithBlob(Abbrev, Record, Buffer);
4507
4508 // Emit the contents of the extension block.
Douglas Gregor8f64ca12015-12-08 22:43:32 +00004509 Writer.writeExtensionContents(SemaRef, Stream);
Douglas Gregor6623e1f2015-11-03 18:33:07 +00004510
4511 // Exit the extension block.
4512 Stream.ExitBlock();
4513}
4514
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00004515//===----------------------------------------------------------------------===//
Douglas Gregorc5046832009-04-27 18:38:38 +00004516// General Serialization Routines
4517//===----------------------------------------------------------------------===//
4518
Richard Smithe43e2b32018-08-20 21:47:29 +00004519void ASTRecordWriter::AddAttr(const Attr *A) {
Reid Kleckner11f9f8a2018-08-14 01:55:37 +00004520 auto &Record = *this;
Richard Smithe43e2b32018-08-20 21:47:29 +00004521 if (!A)
4522 return Record.push_back(0);
4523 Record.push_back(A->getKind() + 1); // FIXME: stable encoding, target attrs
4524 Record.AddSourceRange(A->getRange());
Reid Kleckner11f9f8a2018-08-14 01:55:37 +00004525
4526#include "clang/Serialization/AttrPCHWrite.inc"
Richard Smithe43e2b32018-08-20 21:47:29 +00004527}
4528
4529/// Emit the list of attributes to the specified record.
4530void ASTRecordWriter::AddAttributes(ArrayRef<const Attr *> Attrs) {
4531 push_back(Attrs.size());
4532 for (const auto *A : Attrs)
4533 AddAttr(A);
Douglas Gregorbc8a78d52009-04-15 21:30:51 +00004534}
4535
John McCallf413f5e2013-05-03 00:10:13 +00004536void ASTWriter::AddToken(const Token &Tok, RecordDataImpl &Record) {
4537 AddSourceLocation(Tok.getLocation(), Record);
4538 Record.push_back(Tok.getLength());
4539
4540 // FIXME: When reading literal tokens, reconstruct the literal pointer
4541 // if it is needed.
4542 AddIdentifierRef(Tok.getIdentifierInfo(), Record);
4543 // FIXME: Should translate token kind to a stable encoding.
4544 Record.push_back(Tok.getKind());
4545 // FIXME: Should translate token flags to a stable encoding.
4546 Record.push_back(Tok.getFlags());
4547}
4548
Chris Lattner0e62c1c2011-07-23 10:55:15 +00004549void ASTWriter::AddString(StringRef Str, RecordDataImpl &Record) {
Douglas Gregorbc8a78d52009-04-15 21:30:51 +00004550 Record.push_back(Str.size());
4551 Record.insert(Record.end(), Str.begin(), Str.end());
4552}
4553
Richard Smith7ed1bc92014-12-05 22:42:13 +00004554bool ASTWriter::PreparePathForOutput(SmallVectorImpl<char> &Path) {
Richard Smith54cc3c22014-12-11 20:50:24 +00004555 assert(Context && "should have context when outputting path");
Richard Smith7ed1bc92014-12-05 22:42:13 +00004556
Richard Smith54cc3c22014-12-11 20:50:24 +00004557 bool Changed =
4558 cleanPathForOutput(Context->getSourceManager().getFileManager(), Path);
Richard Smith7ed1bc92014-12-05 22:42:13 +00004559
4560 // Remove a prefix to make the path relative, if relevant.
4561 const char *PathBegin = Path.data();
4562 const char *PathPtr =
4563 adjustFilenameForRelocatableAST(PathBegin, BaseDirectory);
4564 if (PathPtr != PathBegin) {
4565 Path.erase(Path.begin(), Path.begin() + (PathPtr - PathBegin));
4566 Changed = true;
4567 }
4568
4569 return Changed;
4570}
4571
4572void ASTWriter::AddPath(StringRef Path, RecordDataImpl &Record) {
4573 SmallString<128> FilePath(Path);
4574 PreparePathForOutput(FilePath);
4575 AddString(FilePath, Record);
4576}
4577
Mehdi Amini57a41912015-09-10 01:46:39 +00004578void ASTWriter::EmitRecordWithPath(unsigned Abbrev, RecordDataRef Record,
Richard Smith7ed1bc92014-12-05 22:42:13 +00004579 StringRef Path) {
4580 SmallString<128> FilePath(Path);
4581 PreparePathForOutput(FilePath);
4582 Stream.EmitRecordWithBlob(Abbrev, Record, FilePath);
4583}
4584
Douglas Gregor20b2ebd2011-03-23 00:50:03 +00004585void ASTWriter::AddVersionTuple(const VersionTuple &Version,
4586 RecordDataImpl &Record) {
4587 Record.push_back(Version.getMajor());
David Blaikie05785d12013-02-20 22:23:23 +00004588 if (Optional<unsigned> Minor = Version.getMinor())
Douglas Gregor20b2ebd2011-03-23 00:50:03 +00004589 Record.push_back(*Minor + 1);
4590 else
4591 Record.push_back(0);
David Blaikie05785d12013-02-20 22:23:23 +00004592 if (Optional<unsigned> Subminor = Version.getSubminor())
Douglas Gregor20b2ebd2011-03-23 00:50:03 +00004593 Record.push_back(*Subminor + 1);
4594 else
4595 Record.push_back(0);
4596}
4597
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00004598/// Note that the identifier II occurs at the given offset
Douglas Gregore84a9da2009-04-20 20:36:09 +00004599/// within the identifier table.
Sebastian Redl55c0ad52010-08-18 23:56:21 +00004600void ASTWriter::SetIdentifierOffset(const IdentifierInfo *II, uint32_t Offset) {
Sebastian Redl539c5062010-08-18 23:57:32 +00004601 IdentID ID = IdentifierIDs[II];
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00004602 // Only store offsets new to this AST file. Other identifier names are looked
Sebastian Redlff4a2952010-07-23 23:49:55 +00004603 // up earlier in the chain and thus don't need an offset.
4604 if (ID >= FirstIdentID)
4605 IdentifierOffsets[ID - FirstIdentID] = Offset;
Douglas Gregore84a9da2009-04-20 20:36:09 +00004606}
4607
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00004608/// Note that the selector Sel occurs at the given offset
Douglas Gregor95c13f52009-04-25 17:48:32 +00004609/// within the method pool/selector table.
Sebastian Redl55c0ad52010-08-18 23:56:21 +00004610void ASTWriter::SetSelectorOffset(Selector Sel, uint32_t Offset) {
Douglas Gregor95c13f52009-04-25 17:48:32 +00004611 unsigned ID = SelectorIDs[Sel];
4612 assert(ID && "Unknown selector");
Sebastian Redld95a56e2010-08-04 18:21:41 +00004613 // Don't record offsets for selectors that are also available in a different
4614 // file.
4615 if (ID < FirstSelectorID)
4616 return;
4617 SelectorOffsets[ID - FirstSelectorID] = Offset;
Douglas Gregor95c13f52009-04-25 17:48:32 +00004618}
4619
David Blaikie61137e12017-01-05 18:23:18 +00004620ASTWriter::ASTWriter(llvm::BitstreamWriter &Stream,
Duncan P. N. Exon Smith8bef5cd2019-03-09 17:33:56 +00004621 SmallVectorImpl<char> &Buffer,
4622 InMemoryModuleCache &ModuleCache,
David Blaikie61137e12017-01-05 18:23:18 +00004623 ArrayRef<std::shared_ptr<ModuleFileExtension>> Extensions,
4624 bool IncludeTimestamps)
Duncan P. N. Exon Smith8bef5cd2019-03-09 17:33:56 +00004625 : Stream(Stream), Buffer(Buffer), ModuleCache(ModuleCache),
Duncan P. N. Exon Smith030d7d62017-03-20 17:58:26 +00004626 IncludeTimestamps(IncludeTimestamps) {
Douglas Gregor6623e1f2015-11-03 18:33:07 +00004627 for (const auto &Ext : Extensions) {
4628 if (auto Writer = Ext->createExtensionWriter(*this))
4629 ModuleFileExtensionWriters.push_back(std::move(Writer));
4630 }
4631}
Douglas Gregoref84c4b2009-04-09 22:27:44 +00004632
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00004633ASTWriter::~ASTWriter() {
Reid Kleckner588c9372014-02-19 23:44:52 +00004634 llvm::DeleteContainerSeconds(FileDeclIDs);
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00004635}
4636
Richard Smithb3761912015-02-05 23:08:52 +00004637const LangOptions &ASTWriter::getLangOpts() const {
4638 assert(WritingAST && "can't determine lang opts when not writing AST");
4639 return Context->getLangOpts();
4640}
4641
Richard Smithe75ee0f2015-08-17 07:13:32 +00004642time_t ASTWriter::getTimestampForOutput(const FileEntry *E) const {
4643 return IncludeTimestamps ? E->getModificationTime() : 0;
4644}
4645
Duncan P. N. Exon Smith60fa2882017-03-13 18:45:08 +00004646ASTFileSignature ASTWriter::WriteAST(Sema &SemaRef,
4647 const std::string &OutputFile,
4648 Module *WritingModule, StringRef isysroot,
Duncan P. N. Exon Smith70d759b2019-03-12 18:38:04 +00004649 bool hasErrors,
4650 bool ShouldCacheASTInMemory) {
Douglas Gregor2fd3d402011-09-17 00:05:03 +00004651 WritingAST = true;
Adrian Prantladbd2b12015-09-22 23:26:31 +00004652
Argyrios Kyrtzidis4a280ff2012-03-07 01:51:17 +00004653 ASTHasCompilerErrors = hasErrors;
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00004654
Douglas Gregoref84c4b2009-04-09 22:27:44 +00004655 // Emit the file header.
Douglas Gregor8f45df52009-04-16 22:23:12 +00004656 Stream.Emit((unsigned)'C', 8);
4657 Stream.Emit((unsigned)'P', 8);
4658 Stream.Emit((unsigned)'C', 8);
4659 Stream.Emit((unsigned)'H', 8);
Mike Stump11289f42009-09-09 15:08:12 +00004660
Chris Lattner28fa4e62009-04-26 22:26:21 +00004661 WriteBlockInfoBlock();
Douglas Gregoref84c4b2009-04-09 22:27:44 +00004662
Douglas Gregoreda8e122011-08-09 15:13:55 +00004663 Context = &SemaRef.Context;
Douglas Gregora28bcdd2011-12-01 02:07:58 +00004664 PP = &SemaRef.PP;
Douglas Gregora89c5ac2011-12-06 01:10:29 +00004665 this->WritingModule = WritingModule;
Adrian Prantladbd2b12015-09-22 23:26:31 +00004666 ASTFileSignature Signature =
4667 WriteASTCore(SemaRef, isysroot, OutputFile, WritingModule);
Craig Toppera13603a2014-05-22 05:54:18 +00004668 Context = nullptr;
4669 PP = nullptr;
4670 this->WritingModule = nullptr;
Richard Smith7ed1bc92014-12-05 22:42:13 +00004671 this->BaseDirectory.clear();
Craig Toppera13603a2014-05-22 05:54:18 +00004672
Douglas Gregor2fd3d402011-09-17 00:05:03 +00004673 WritingAST = false;
Duncan P. N. Exon Smith70d759b2019-03-12 18:38:04 +00004674 if (ShouldCacheASTInMemory) {
Duncan P. N. Exon Smith030d7d62017-03-20 17:58:26 +00004675 // Construct MemoryBuffer and update buffer manager.
Duncan P. N. Exon Smith0a2be462019-03-09 17:44:01 +00004676 ModuleCache.addBuiltPCM(OutputFile,
4677 llvm::MemoryBuffer::getMemBufferCopy(
4678 StringRef(Buffer.begin(), Buffer.size())));
Duncan P. N. Exon Smith030d7d62017-03-20 17:58:26 +00004679 }
Adrian Prantladbd2b12015-09-22 23:26:31 +00004680 return Signature;
Sebastian Redl143413f2010-07-12 22:02:52 +00004681}
4682
Douglas Gregora94a1542011-07-27 21:45:57 +00004683template<typename Vector>
4684static void AddLazyVectorDecls(ASTWriter &Writer, Vector &Vec,
4685 ASTWriter::RecordData &Record) {
Craig Toppera13603a2014-05-22 05:54:18 +00004686 for (typename Vector::iterator I = Vec.begin(nullptr, true), E = Vec.end();
4687 I != E; ++I) {
Douglas Gregora94a1542011-07-27 21:45:57 +00004688 Writer.AddDeclRef(*I, Record);
4689 }
4690}
4691
Duncan P. N. Exon Smith60fa2882017-03-13 18:45:08 +00004692ASTFileSignature ASTWriter::WriteASTCore(Sema &SemaRef, StringRef isysroot,
4693 const std::string &OutputFile,
4694 Module *WritingModule) {
Sebastian Redl143413f2010-07-12 22:02:52 +00004695 using namespace llvm;
4696
Craig Toppera13603a2014-05-22 05:54:18 +00004697 bool isModule = WritingModule != nullptr;
Argyrios Kyrtzidisffb35582013-03-14 04:44:56 +00004698
Douglas Gregorcf68c582011-12-01 22:20:10 +00004699 // Make sure that the AST reader knows to finalize itself.
4700 if (Chain)
4701 Chain->finalizeForWriting();
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00004702
Sebastian Redl143413f2010-07-12 22:02:52 +00004703 ASTContext &Context = SemaRef.Context;
4704 Preprocessor &PP = SemaRef.PP;
4705
Douglas Gregordab42432011-08-12 00:15:20 +00004706 // Set up predefined declaration IDs.
Richard Smith5fc18a92015-07-12 23:43:21 +00004707 auto RegisterPredefDecl = [&] (Decl *D, PredefinedDeclIDs ID) {
4708 if (D) {
4709 assert(D->isCanonicalDecl() && "predefined decl is not canonical");
4710 DeclIDs[D] = ID;
Richard Smith5fc18a92015-07-12 23:43:21 +00004711 }
4712 };
4713 RegisterPredefDecl(Context.getTranslationUnitDecl(),
4714 PREDEF_DECL_TRANSLATION_UNIT_ID);
4715 RegisterPredefDecl(Context.ObjCIdDecl, PREDEF_DECL_OBJC_ID_ID);
4716 RegisterPredefDecl(Context.ObjCSelDecl, PREDEF_DECL_OBJC_SEL_ID);
4717 RegisterPredefDecl(Context.ObjCClassDecl, PREDEF_DECL_OBJC_CLASS_ID);
4718 RegisterPredefDecl(Context.ObjCProtocolClassDecl,
4719 PREDEF_DECL_OBJC_PROTOCOL_ID);
4720 RegisterPredefDecl(Context.Int128Decl, PREDEF_DECL_INT_128_ID);
4721 RegisterPredefDecl(Context.UInt128Decl, PREDEF_DECL_UNSIGNED_INT_128_ID);
4722 RegisterPredefDecl(Context.ObjCInstanceTypeDecl,
4723 PREDEF_DECL_OBJC_INSTANCETYPE_ID);
4724 RegisterPredefDecl(Context.BuiltinVaListDecl, PREDEF_DECL_BUILTIN_VA_LIST_ID);
Richard Smith9b88a4c2015-07-27 05:40:23 +00004725 RegisterPredefDecl(Context.VaListTagDecl, PREDEF_DECL_VA_LIST_TAG);
Charles Davisc7d5c942015-09-17 20:55:33 +00004726 RegisterPredefDecl(Context.BuiltinMSVaListDecl,
4727 PREDEF_DECL_BUILTIN_MS_VA_LIST_ID);
Richard Smith5fc18a92015-07-12 23:43:21 +00004728 RegisterPredefDecl(Context.ExternCContext, PREDEF_DECL_EXTERN_C_CONTEXT_ID);
David Majnemerd9b1a4f2015-11-04 03:40:30 +00004729 RegisterPredefDecl(Context.MakeIntegerSeqDecl,
4730 PREDEF_DECL_MAKE_INTEGER_SEQ_ID);
Quentin Colombet043406b2016-02-03 22:41:00 +00004731 RegisterPredefDecl(Context.CFConstantStringTypeDecl,
4732 PREDEF_DECL_CF_CONSTANT_STRING_ID);
Ben Langmuirf5416742016-02-04 00:55:24 +00004733 RegisterPredefDecl(Context.CFConstantStringTagDecl,
4734 PREDEF_DECL_CF_CONSTANT_STRING_TAG_ID);
Eric Fiselier6ad68552016-07-01 01:24:09 +00004735 RegisterPredefDecl(Context.TypePackElementDecl,
4736 PREDEF_DECL_TYPE_PACK_ELEMENT_ID);
Meador Inge5d3fb222012-06-16 03:34:49 +00004737
Chris Lattner0c797362009-09-08 18:19:27 +00004738 // Build a record containing all of the tentative definitions in this file, in
Sebastian Redl35351a92010-01-31 22:27:38 +00004739 // TentativeDefinitions order. Generally, this record will be empty for
Chris Lattner0c797362009-09-08 18:19:27 +00004740 // headers.
Douglas Gregord4df8652009-04-22 22:02:47 +00004741 RecordData TentativeDefinitions;
Douglas Gregora94a1542011-07-27 21:45:57 +00004742 AddLazyVectorDecls(*this, SemaRef.TentativeDefinitions, TentativeDefinitions);
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00004743
Argyrios Kyrtzidis35672e72010-08-13 18:42:17 +00004744 // Build a record containing all of the file scoped decls in this file.
4745 RecordData UnusedFileScopedDecls;
Argyrios Kyrtzidis59852362013-03-14 04:45:00 +00004746 if (!isModule)
4747 AddLazyVectorDecls(*this, SemaRef.UnusedFileScopedDecls,
4748 UnusedFileScopedDecls);
Sebastian Redl08aca90252010-08-05 18:21:25 +00004749
Douglas Gregor851443c2011-08-12 01:39:19 +00004750 // Build a record containing all of the delegating constructors we still need
4751 // to resolve.
Alexis Hunt27a761d2011-05-04 23:29:54 +00004752 RecordData DelegatingCtorDecls;
Argyrios Kyrtzidisffb35582013-03-14 04:44:56 +00004753 if (!isModule)
4754 AddLazyVectorDecls(*this, SemaRef.DelegatingCtorDecls, DelegatingCtorDecls);
Alexis Hunt27a761d2011-05-04 23:29:54 +00004755
Douglas Gregor851443c2011-08-12 01:39:19 +00004756 // Write the set of weak, undeclared identifiers. We always write the
4757 // entire table, since later PCH files in a PCH chain are only interested in
4758 // the results at the end of the chain.
Argyrios Kyrtzidisee1afa32010-08-05 09:48:08 +00004759 RecordData WeakUndeclaredIdentifiers;
Chandler Carruthf85d9822015-03-26 08:32:49 +00004760 for (auto &WeakUndeclaredIdentifier : SemaRef.WeakUndeclaredIdentifiers) {
4761 IdentifierInfo *II = WeakUndeclaredIdentifier.first;
4762 WeakInfo &WI = WeakUndeclaredIdentifier.second;
4763 AddIdentifierRef(II, WeakUndeclaredIdentifiers);
4764 AddIdentifierRef(WI.getAlias(), WeakUndeclaredIdentifiers);
4765 AddSourceLocation(WI.getLocation(), WeakUndeclaredIdentifiers);
4766 WeakUndeclaredIdentifiers.push_back(WI.getUsed());
Argyrios Kyrtzidisee1afa32010-08-05 09:48:08 +00004767 }
Kovarththanan Rajaratnama9c81a82010-03-14 07:06:50 +00004768
Douglas Gregor61cac2b2009-04-27 20:06:05 +00004769 // Build a record containing all of the ext_vector declarations.
4770 RecordData ExtVectorDecls;
Douglas Gregorb7098a32011-07-28 00:39:29 +00004771 AddLazyVectorDecls(*this, SemaRef.ExtVectorDecls, ExtVectorDecls);
Douglas Gregor61cac2b2009-04-27 20:06:05 +00004772
Argyrios Kyrtzidisaf2eac22010-07-06 15:37:04 +00004773 // Build a record containing all of the VTable uses information.
4774 RecordData VTableUses;
Argyrios Kyrtzidisedee67f2010-08-03 17:29:52 +00004775 if (!SemaRef.VTableUses.empty()) {
Argyrios Kyrtzidisedee67f2010-08-03 17:29:52 +00004776 for (unsigned I = 0, N = SemaRef.VTableUses.size(); I != N; ++I) {
4777 AddDeclRef(SemaRef.VTableUses[I].first, VTableUses);
4778 AddSourceLocation(SemaRef.VTableUses[I].second, VTableUses);
4779 VTableUses.push_back(SemaRef.VTablesUsed[SemaRef.VTableUses[I].first]);
4780 }
Argyrios Kyrtzidisaf2eac22010-07-06 15:37:04 +00004781 }
4782
Nico Weber72889432014-09-06 01:25:55 +00004783 // Build a record containing all of the UnusedLocalTypedefNameCandidates.
4784 RecordData UnusedLocalTypedefNameCandidates;
4785 for (const TypedefNameDecl *TD : SemaRef.UnusedLocalTypedefNameCandidates)
4786 AddDeclRef(TD, UnusedLocalTypedefNameCandidates);
4787
Argyrios Kyrtzidis7f76d112010-08-05 09:48:16 +00004788 // Build a record containing all of pending implicit instantiations.
Chandler Carruth54080172010-08-25 08:44:16 +00004789 RecordData PendingInstantiations;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00004790 for (const auto &I : SemaRef.PendingInstantiations) {
4791 AddDeclRef(I.first, PendingInstantiations);
4792 AddSourceLocation(I.second, PendingInstantiations);
Argyrios Kyrtzidis7f76d112010-08-05 09:48:16 +00004793 }
4794 assert(SemaRef.PendingLocalImplicitInstantiations.empty() &&
4795 "There are local ones at end of translation unit!");
4796
Argyrios Kyrtzidis2d688102010-08-02 07:14:54 +00004797 // Build a record containing some declaration references.
4798 RecordData SemaDeclRefs;
Richard Smith96269c52016-09-29 22:49:46 +00004799 if (SemaRef.StdNamespace || SemaRef.StdBadAlloc || SemaRef.StdAlignValT) {
Argyrios Kyrtzidis2d688102010-08-02 07:14:54 +00004800 AddDeclRef(SemaRef.getStdNamespace(), SemaDeclRefs);
4801 AddDeclRef(SemaRef.getStdBadAlloc(), SemaDeclRefs);
Richard Smith96269c52016-09-29 22:49:46 +00004802 AddDeclRef(SemaRef.getStdAlignValT(), SemaDeclRefs);
Argyrios Kyrtzidis2d688102010-08-02 07:14:54 +00004803 }
4804
Peter Collingbourne9e2c81f2011-02-09 21:04:32 +00004805 RecordData CUDASpecialDeclRefs;
4806 if (Context.getcudaConfigureCallDecl()) {
4807 AddDeclRef(Context.getcudaConfigureCallDecl(), CUDASpecialDeclRefs);
4808 }
4809
Douglas Gregorc2fa1692011-06-28 16:20:02 +00004810 // Build a record containing all of the known namespaces.
4811 RecordData KnownNamespaces;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00004812 for (const auto &I : SemaRef.KnownNamespaces) {
4813 if (!I.second)
4814 AddDeclRef(I.first, KnownNamespaces);
Douglas Gregorc2fa1692011-06-28 16:20:02 +00004815 }
Douglas Gregor112b9072012-10-18 05:31:06 +00004816
Nick Lewycky9c7eb1d2013-02-01 08:13:20 +00004817 // Build a record of all used, undefined objects that require definitions.
4818 RecordData UndefinedButUsed;
Nick Lewyckyf0f56162013-01-31 03:23:57 +00004819
4820 SmallVector<std::pair<NamedDecl *, SourceLocation>, 16> Undefined;
Nick Lewycky9c7eb1d2013-02-01 08:13:20 +00004821 SemaRef.getUndefinedButUsed(Undefined);
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00004822 for (const auto &I : Undefined) {
4823 AddDeclRef(I.first, UndefinedButUsed);
4824 AddSourceLocation(I.second, UndefinedButUsed);
Nick Lewycky8334af82013-01-26 00:35:08 +00004825 }
4826
Ismail Pazarbasie5768d12015-05-18 19:59:11 +00004827 // Build a record containing all delete-expressions that we would like to
4828 // analyze later in AST.
4829 RecordData DeleteExprsToAnalyze;
4830
Richard Smithf5262c62018-06-28 01:57:04 +00004831 if (!isModule) {
4832 for (const auto &DeleteExprsInfo :
4833 SemaRef.getMismatchingDeleteExpressions()) {
4834 AddDeclRef(DeleteExprsInfo.first, DeleteExprsToAnalyze);
4835 DeleteExprsToAnalyze.push_back(DeleteExprsInfo.second.size());
4836 for (const auto &DeleteLoc : DeleteExprsInfo.second) {
4837 AddSourceLocation(DeleteLoc.first, DeleteExprsToAnalyze);
4838 DeleteExprsToAnalyze.push_back(DeleteLoc.second);
4839 }
Ismail Pazarbasie5768d12015-05-18 19:59:11 +00004840 }
4841 }
4842
Douglas Gregor112b9072012-10-18 05:31:06 +00004843 // Write the control block
Duncan P. N. Exon Smith60fa2882017-03-13 18:45:08 +00004844 WriteControlBlock(PP, Context, isysroot, OutputFile);
Douglas Gregor112b9072012-10-18 05:31:06 +00004845
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00004846 // Write the remaining AST contents.
Sebastian Redl539c5062010-08-18 23:57:32 +00004847 Stream.EnterSubblock(AST_BLOCK_ID, 5);
Douglas Gregor851443c2011-08-12 01:39:19 +00004848
Argyrios Kyrtzidis39605402012-12-13 21:38:23 +00004849 // This is so that older clang versions, before the introduction
4850 // of the control block, can read and reject the newer PCH format.
Mehdi Amini57a41912015-09-10 01:46:39 +00004851 {
4852 RecordData Record = {VERSION_MAJOR};
4853 Stream.EmitRecord(METADATA_OLD_FORMAT, Record);
4854 }
Argyrios Kyrtzidis39605402012-12-13 21:38:23 +00004855
Douglas Gregor851443c2011-08-12 01:39:19 +00004856 // Create a lexical update block containing all of the declarations in the
4857 // translation unit that do not come from other AST files.
4858 const TranslationUnitDecl *TU = Context.getTranslationUnitDecl();
Richard Smith82f8fcd2015-08-06 22:07:25 +00004859 SmallVector<uint32_t, 128> NewGlobalKindDeclPairs;
4860 for (const auto *D : TU->noload_decls()) {
4861 if (!D->isFromASTFile()) {
4862 NewGlobalKindDeclPairs.push_back(D->getKind());
4863 NewGlobalKindDeclPairs.push_back(GetDeclRef(D));
4864 }
Douglas Gregor851443c2011-08-12 01:39:19 +00004865 }
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00004866
David Blaikieb44f0bf2017-01-04 22:36:43 +00004867 auto Abv = std::make_shared<BitCodeAbbrev>();
Douglas Gregor851443c2011-08-12 01:39:19 +00004868 Abv->Add(llvm::BitCodeAbbrevOp(TU_UPDATE_LEXICAL));
4869 Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::Blob));
David Blaikieb44f0bf2017-01-04 22:36:43 +00004870 unsigned TuUpdateLexicalAbbrev = Stream.EmitAbbrev(std::move(Abv));
Mehdi Amini57a41912015-09-10 01:46:39 +00004871 {
4872 RecordData::value_type Record[] = {TU_UPDATE_LEXICAL};
4873 Stream.EmitRecordWithBlob(TuUpdateLexicalAbbrev, Record,
4874 bytes(NewGlobalKindDeclPairs));
4875 }
4876
Douglas Gregor851443c2011-08-12 01:39:19 +00004877 // And a visible updates block for the translation unit.
David Blaikieb44f0bf2017-01-04 22:36:43 +00004878 Abv = std::make_shared<BitCodeAbbrev>();
Douglas Gregor851443c2011-08-12 01:39:19 +00004879 Abv->Add(llvm::BitCodeAbbrevOp(UPDATE_VISIBLE));
4880 Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::VBR, 6));
Douglas Gregor851443c2011-08-12 01:39:19 +00004881 Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::Blob));
David Blaikieb44f0bf2017-01-04 22:36:43 +00004882 UpdateVisibleAbbrev = Stream.EmitAbbrev(std::move(Abv));
Douglas Gregor851443c2011-08-12 01:39:19 +00004883 WriteDeclContextVisibleUpdate(TU);
Richard Smithf19e1272015-03-07 00:04:49 +00004884
4885 // If we have any extern "C" names, write out a visible update for them.
4886 if (Context.ExternCContext)
4887 WriteDeclContextVisibleUpdate(Context.ExternCContext);
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00004888
Douglas Gregor851443c2011-08-12 01:39:19 +00004889 // If the translation unit has an anonymous namespace, and we don't already
4890 // have an update block for it, write it as an update block.
Richard Smith6ef42932014-03-20 21:02:00 +00004891 // FIXME: Why do we not do this if there's already an update block?
Douglas Gregor851443c2011-08-12 01:39:19 +00004892 if (NamespaceDecl *NS = TU->getAnonymousNamespace()) {
4893 ASTWriter::UpdateRecord &Record = DeclUpdates[TU];
Richard Smith6ef42932014-03-20 21:02:00 +00004894 if (Record.empty())
Aaron Ballman4f45b712014-03-21 15:22:56 +00004895 Record.push_back(DeclUpdate(UPD_CXX_ADDED_ANONYMOUS_NAMESPACE, NS));
Douglas Gregor851443c2011-08-12 01:39:19 +00004896 }
Argyrios Kyrtzidis442dd802012-07-02 19:19:01 +00004897
Richard Smith5652c0f2014-03-21 01:48:23 +00004898 // Add update records for all mangling numbers and static local numbers.
4899 // These aren't really update records, but this is a convenient way of
4900 // tagging this rare extra data onto the declarations.
4901 for (const auto &Number : Context.MangleNumbers)
4902 if (!Number.first->isFromASTFile())
Aaron Ballman4f45b712014-03-21 15:22:56 +00004903 DeclUpdates[Number.first].push_back(DeclUpdate(UPD_MANGLING_NUMBER,
4904 Number.second));
Richard Smith5652c0f2014-03-21 01:48:23 +00004905 for (const auto &Number : Context.StaticLocalNumbers)
4906 if (!Number.first->isFromASTFile())
Aaron Ballman4f45b712014-03-21 15:22:56 +00004907 DeclUpdates[Number.first].push_back(DeclUpdate(UPD_STATIC_LOCAL_NUMBER,
4908 Number.second));
Richard Smith5652c0f2014-03-21 01:48:23 +00004909
Argyrios Kyrtzidis442dd802012-07-02 19:19:01 +00004910 // Make sure visible decls, added to DeclContexts previously loaded from
Richard Smithc26d9742016-10-06 20:30:51 +00004911 // an AST file, are registered for serialization. Likewise for template
4912 // specializations added to imported templates.
4913 for (const auto *I : DeclsToEmitEvenIfUnreferenced) {
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00004914 GetDeclRef(I);
Argyrios Kyrtzidis442dd802012-07-02 19:19:01 +00004915 }
4916
Argyrios Kyrtzidisacfbbd72013-08-07 21:17:33 +00004917 // Make sure all decls associated with an identifier are registered for
Richard Smith79bf9202015-08-24 03:33:22 +00004918 // serialization, if we're storing decls with identifiers.
4919 if (!WritingModule || !getLangOpts().CPlusPlus) {
4920 llvm::SmallVector<const IdentifierInfo*, 256> IIs;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00004921 for (const auto &ID : PP.getIdentifierTable()) {
4922 const IdentifierInfo *II = ID.second;
Richard Smith79bf9202015-08-24 03:33:22 +00004923 if (!Chain || !II->isFromAST() || II->hasChangedSinceDeserialization())
4924 IIs.push_back(II);
4925 }
4926 // Sort the identifiers to visit based on their name.
Benjamin Kramercd2bae32019-08-22 17:32:16 +00004927 llvm::sort(IIs, llvm::deref<std::less<>>());
Richard Smith79bf9202015-08-24 03:33:22 +00004928 for (const IdentifierInfo *II : IIs) {
4929 for (IdentifierResolver::iterator D = SemaRef.IdResolver.begin(II),
4930 DEnd = SemaRef.IdResolver.end();
4931 D != DEnd; ++D) {
4932 GetDeclRef(*D);
4933 }
Argyrios Kyrtzidisacfbbd72013-08-07 21:17:33 +00004934 }
4935 }
4936
Manman Rena0f31a02016-04-29 19:04:05 +00004937 // For method pool in the module, if it contains an entry for a selector,
4938 // the entry should be complete, containing everything introduced by that
4939 // module and all modules it imports. It's possible that the entry is out of
4940 // date, so we need to pull in the new content here.
4941
4942 // It's possible that updateOutOfDateSelector can update SelectorIDs. To be
4943 // safe, we copy all selectors out.
4944 llvm::SmallVector<Selector, 256> AllSelectors;
4945 for (auto &SelectorAndID : SelectorIDs)
4946 AllSelectors.push_back(SelectorAndID.first);
4947 for (auto &Selector : AllSelectors)
4948 SemaRef.updateOutOfDateSelector(Selector);
4949
Douglas Gregor5204bde2011-08-02 16:26:37 +00004950 // Form the record of special types.
4951 RecordData SpecialTypes;
Douglas Gregor5204bde2011-08-02 16:26:37 +00004952 AddTypeRef(Context.getRawCFConstantStringType(), SpecialTypes);
Douglas Gregor5204bde2011-08-02 16:26:37 +00004953 AddTypeRef(Context.getFILEType(), SpecialTypes);
4954 AddTypeRef(Context.getjmp_bufType(), SpecialTypes);
4955 AddTypeRef(Context.getsigjmp_bufType(), SpecialTypes);
4956 AddTypeRef(Context.ObjCIdRedefinitionType, SpecialTypes);
4957 AddTypeRef(Context.ObjCClassRedefinitionType, SpecialTypes);
Douglas Gregor5204bde2011-08-02 16:26:37 +00004958 AddTypeRef(Context.ObjCSelRedefinitionType, SpecialTypes);
Rafael Espindola6cfa82b2011-11-13 21:51:09 +00004959 AddTypeRef(Context.getucontext_tType(), SpecialTypes);
Douglas Gregora28bcdd2011-12-01 02:07:58 +00004960
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00004961 if (Chain) {
4962 // Write the mapping information describing our module dependencies and how
4963 // each of those modules were mapped into our own offset/ID space, so that
4964 // the reader can build the appropriate mapping to its own offset/ID space.
4965 // The map consists solely of a blob with the following format:
Boris Kolpackovd30446f2017-08-31 06:26:43 +00004966 // *(module-kind:i8
4967 // module-name-len:i16 module-name:len*i8
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00004968 // source-location-offset:i32
4969 // identifier-id:i32
4970 // preprocessed-entity-id:i32
4971 // macro-definition-id:i32
Douglas Gregor253eefe2011-12-01 00:59:36 +00004972 // submodule-id:i32
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00004973 // selector-id:i32
4974 // declaration-id:i32
4975 // c++-base-specifiers-id:i32
4976 // type-id:i32)
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00004977 //
Boris Kolpackovd30446f2017-08-31 06:26:43 +00004978 // module-kind is the ModuleKind enum value. If it is MK_PrebuiltModule or
4979 // MK_ExplicitModule, then the module-name is the module name. Otherwise,
4980 // it is the module file name.
David Blaikieb44f0bf2017-01-04 22:36:43 +00004981 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00004982 Abbrev->Add(BitCodeAbbrevOp(MODULE_OFFSET_MAP));
4983 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
David Blaikieb44f0bf2017-01-04 22:36:43 +00004984 unsigned ModuleOffsetMapAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00004985 SmallString<2048> Buffer;
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00004986 {
4987 llvm::raw_svector_ostream Out(Buffer);
Duncan P. N. Exon Smith96a06e02017-01-28 22:15:22 +00004988 for (ModuleFile &M : Chain->ModuleMgr) {
Justin Bognere1c147c2014-03-28 22:03:19 +00004989 using namespace llvm::support;
Eugene Zelenkob7d89102017-11-11 00:08:50 +00004990
Peter Collingbournee3f65292018-05-18 19:46:24 +00004991 endian::Writer LE(Out, little);
Boris Kolpackovd30446f2017-08-31 06:26:43 +00004992 LE.write<uint8_t>(static_cast<uint8_t>(M.Kind));
4993 StringRef Name =
4994 M.Kind == MK_PrebuiltModule || M.Kind == MK_ExplicitModule
4995 ? M.ModuleName
4996 : M.FileName;
4997 LE.write<uint16_t>(Name.size());
4998 Out.write(Name.data(), Name.size());
Ben Langmuirfe971d92014-08-16 04:54:18 +00004999
Ben Langmuir785180e2014-10-20 16:27:30 +00005000 // Note: if a base ID was uint max, it would not be possible to load
5001 // another module after it or have more than one entity inside it.
5002 uint32_t None = std::numeric_limits<uint32_t>::max();
5003
5004 auto writeBaseIDOrNone = [&](uint32_t BaseID, bool ShouldWrite) {
5005 assert(BaseID < std::numeric_limits<uint32_t>::max() && "base id too high");
5006 if (ShouldWrite)
5007 LE.write<uint32_t>(BaseID);
5008 else
5009 LE.write<uint32_t>(None);
5010 };
5011
Ben Langmuirfe971d92014-08-16 04:54:18 +00005012 // These values should be unique within a chain, since they will be read
5013 // as keys into ContinuousRangeMaps.
Duncan P. N. Exon Smith96a06e02017-01-28 22:15:22 +00005014 writeBaseIDOrNone(M.SLocEntryBaseOffset, M.LocalNumSLocEntries);
5015 writeBaseIDOrNone(M.BaseIdentifierID, M.LocalNumIdentifiers);
5016 writeBaseIDOrNone(M.BaseMacroID, M.LocalNumMacros);
5017 writeBaseIDOrNone(M.BasePreprocessedEntityID,
5018 M.NumPreprocessedEntities);
5019 writeBaseIDOrNone(M.BaseSubmoduleID, M.LocalNumSubmodules);
5020 writeBaseIDOrNone(M.BaseSelectorID, M.LocalNumSelectors);
5021 writeBaseIDOrNone(M.BaseDeclID, M.LocalNumDecls);
5022 writeBaseIDOrNone(M.BaseTypeIndex, M.LocalNumTypes);
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005023 }
5024 }
Mehdi Amini57a41912015-09-10 01:46:39 +00005025 RecordData::value_type Record[] = {MODULE_OFFSET_MAP};
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005026 Stream.EmitRecordWithBlob(ModuleOffsetMapAbbrev, Record,
5027 Buffer.data(), Buffer.size());
5028 }
Richard Smithb9eab6d2014-03-20 19:44:17 +00005029
Richard Smithb9eab6d2014-03-20 19:44:17 +00005030 RecordData DeclUpdatesOffsetsRecord;
5031
Richard Smith59442b42014-03-20 20:07:19 +00005032 // Keep writing types, declarations, and declaration update records
5033 // until we've emitted all of them.
Richard Smith01b2cb42014-07-26 06:37:51 +00005034 Stream.EnterSubblock(DECLTYPES_BLOCK_ID, /*bits for abbreviations*/5);
5035 WriteTypeAbbrevs();
5036 WriteDeclAbbrevs();
Richard Smith59442b42014-03-20 20:07:19 +00005037 do {
5038 WriteDeclUpdatesBlocks(DeclUpdatesOffsetsRecord);
5039 while (!DeclTypesToEmit.empty()) {
5040 DeclOrType DOT = DeclTypesToEmit.front();
5041 DeclTypesToEmit.pop();
5042 if (DOT.isType())
5043 WriteType(DOT.getType());
5044 else
5045 WriteDecl(Context, DOT.getDecl());
5046 }
5047 } while (!DeclUpdates.empty());
Richard Smithb9eab6d2014-03-20 19:44:17 +00005048 Stream.ExitBlock();
5049
Richard Smithb9eab6d2014-03-20 19:44:17 +00005050 DoneWritingDeclsAndTypes = true;
5051
5052 // These things can only be done once we've written out decls and types.
5053 WriteTypeDeclOffsets();
Richard Smith5652c0f2014-03-21 01:48:23 +00005054 if (!DeclUpdatesOffsetsRecord.empty())
5055 Stream.EmitRecord(DECL_UPDATE_OFFSETS, DeclUpdatesOffsetsRecord);
Richard Smithb9eab6d2014-03-20 19:44:17 +00005056 WriteFileDeclIDsMap();
Richard Smith7ed1bc92014-12-05 22:42:13 +00005057 WriteSourceManagerBlock(Context.getSourceManager(), PP);
Richard Smithb9eab6d2014-03-20 19:44:17 +00005058 WriteComments();
Argyrios Kyrtzidisffb35582013-03-14 04:44:56 +00005059 WritePreprocessor(PP, isModule);
Richard Smith7ed1bc92014-12-05 22:42:13 +00005060 WriteHeaderSearch(PP.getHeaderSearchInfo());
Sebastian Redla19a67f2010-08-03 21:58:15 +00005061 WriteSelectors(SemaRef);
Fariborz Jahanianc51609a2010-07-23 19:11:11 +00005062 WriteReferencedSelectorsPool(SemaRef);
Richard Smith9c254182015-07-19 21:41:12 +00005063 WriteLateParsedTemplates(SemaRef);
Argyrios Kyrtzidisffb35582013-03-14 04:44:56 +00005064 WriteIdentifierTable(PP, SemaRef.IdResolver, isModule);
Peter Collingbourne5df20e02011-02-15 19:46:30 +00005065 WriteFPPragmaOptions(SemaRef.getFPOptions());
5066 WriteOpenCLExtensions(SemaRef);
Yaxun Liu5b746652016-12-18 05:18:55 +00005067 WriteOpenCLExtensionTypes(SemaRef);
Justin Lebar67a78a62016-10-08 22:15:58 +00005068 WriteCUDAPragmas(SemaRef);
Douglas Gregor652d82a2009-04-18 05:55:16 +00005069
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00005070 // If we're emitting a module, write out the submodule information.
Douglas Gregora89c5ac2011-12-06 01:10:29 +00005071 if (WritingModule)
5072 WriteSubmodules(WritingModule);
5073
Andrew Savonichev52d674d2018-10-29 11:14:01 +00005074 // We need to have information about submodules to correctly deserialize
5075 // decls from OpenCLExtensionDecls block
5076 WriteOpenCLExtensionDecls(SemaRef);
5077
Douglas Gregor5204bde2011-08-02 16:26:37 +00005078 Stream.EmitRecord(SPECIAL_TYPES, SpecialTypes);
5079
Douglas Gregord4df8652009-04-22 22:02:47 +00005080 // Write the record containing external, unnamed definitions.
Ben Langmuir332aafe2014-01-31 01:06:56 +00005081 if (!EagerlyDeserializedDecls.empty())
5082 Stream.EmitRecord(EAGERLY_DESERIALIZED_DECLS, EagerlyDeserializedDecls);
Douglas Gregord4df8652009-04-22 22:02:47 +00005083
David Blaikief63556d2017-04-12 20:58:33 +00005084 if (!ModularCodegenDecls.empty())
David Blaikie9ffe5a32017-01-30 05:00:26 +00005085 Stream.EmitRecord(MODULAR_CODEGEN_DECLS, ModularCodegenDecls);
5086
Douglas Gregord4df8652009-04-22 22:02:47 +00005087 // Write the record containing tentative definitions.
5088 if (!TentativeDefinitions.empty())
Sebastian Redl539c5062010-08-18 23:57:32 +00005089 Stream.EmitRecord(TENTATIVE_DEFINITIONS, TentativeDefinitions);
Douglas Gregoracfc76c2009-04-22 22:18:58 +00005090
Argyrios Kyrtzidis35672e72010-08-13 18:42:17 +00005091 // Write the record containing unused file scoped decls.
5092 if (!UnusedFileScopedDecls.empty())
Sebastian Redl539c5062010-08-18 23:57:32 +00005093 Stream.EmitRecord(UNUSED_FILESCOPED_DECLS, UnusedFileScopedDecls);
Kovarththanan Rajaratnama9c81a82010-03-14 07:06:50 +00005094
Argyrios Kyrtzidisee1afa32010-08-05 09:48:08 +00005095 // Write the record containing weak undeclared identifiers.
5096 if (!WeakUndeclaredIdentifiers.empty())
Sebastian Redl539c5062010-08-18 23:57:32 +00005097 Stream.EmitRecord(WEAK_UNDECLARED_IDENTIFIERS,
Argyrios Kyrtzidisee1afa32010-08-05 09:48:08 +00005098 WeakUndeclaredIdentifiers);
5099
Douglas Gregor61cac2b2009-04-27 20:06:05 +00005100 // Write the record containing ext_vector type names.
5101 if (!ExtVectorDecls.empty())
Sebastian Redl539c5062010-08-18 23:57:32 +00005102 Stream.EmitRecord(EXT_VECTOR_DECLS, ExtVectorDecls);
Mike Stump11289f42009-09-09 15:08:12 +00005103
Argyrios Kyrtzidisaf2eac22010-07-06 15:37:04 +00005104 // Write the record containing VTable uses information.
5105 if (!VTableUses.empty())
Sebastian Redl539c5062010-08-18 23:57:32 +00005106 Stream.EmitRecord(VTABLE_USES, VTableUses);
Argyrios Kyrtzidisaf2eac22010-07-06 15:37:04 +00005107
Nico Weber72889432014-09-06 01:25:55 +00005108 // Write the record containing potentially unused local typedefs.
5109 if (!UnusedLocalTypedefNameCandidates.empty())
5110 Stream.EmitRecord(UNUSED_LOCAL_TYPEDEF_NAME_CANDIDATES,
5111 UnusedLocalTypedefNameCandidates);
5112
Argyrios Kyrtzidis7f76d112010-08-05 09:48:16 +00005113 // Write the record containing pending implicit instantiations.
Chandler Carruth54080172010-08-25 08:44:16 +00005114 if (!PendingInstantiations.empty())
5115 Stream.EmitRecord(PENDING_IMPLICIT_INSTANTIATIONS, PendingInstantiations);
Argyrios Kyrtzidis7f76d112010-08-05 09:48:16 +00005116
Argyrios Kyrtzidis2d688102010-08-02 07:14:54 +00005117 // Write the record containing declaration references of Sema.
5118 if (!SemaDeclRefs.empty())
Sebastian Redl539c5062010-08-18 23:57:32 +00005119 Stream.EmitRecord(SEMA_DECL_REFS, SemaDeclRefs);
Argyrios Kyrtzidis2d688102010-08-02 07:14:54 +00005120
Peter Collingbourne9e2c81f2011-02-09 21:04:32 +00005121 // Write the record containing CUDA-specific declaration references.
5122 if (!CUDASpecialDeclRefs.empty())
5123 Stream.EmitRecord(CUDA_SPECIAL_DECL_REFS, CUDASpecialDeclRefs);
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00005124
Alexis Hunt27a761d2011-05-04 23:29:54 +00005125 // Write the delegating constructors.
5126 if (!DelegatingCtorDecls.empty())
5127 Stream.EmitRecord(DELEGATING_CTORS, DelegatingCtorDecls);
Peter Collingbourne9e2c81f2011-02-09 21:04:32 +00005128
Douglas Gregorc2fa1692011-06-28 16:20:02 +00005129 // Write the known namespaces.
5130 if (!KnownNamespaces.empty())
5131 Stream.EmitRecord(KNOWN_NAMESPACES, KnownNamespaces);
Nick Lewycky8334af82013-01-26 00:35:08 +00005132
Nick Lewycky9c7eb1d2013-02-01 08:13:20 +00005133 // Write the undefined internal functions and variables, and inline functions.
5134 if (!UndefinedButUsed.empty())
5135 Stream.EmitRecord(UNDEFINED_BUT_USED, UndefinedButUsed);
Ismail Pazarbasie5768d12015-05-18 19:59:11 +00005136
5137 if (!DeleteExprsToAnalyze.empty())
5138 Stream.EmitRecord(DELETE_EXPRS_TO_ANALYZE, DeleteExprsToAnalyze);
5139
Douglas Gregor851443c2011-08-12 01:39:19 +00005140 // Write the visible updates to DeclContexts.
Richard Smithcd45dbc2014-04-19 03:48:30 +00005141 for (auto *DC : UpdatedDeclContexts)
5142 WriteDeclContextVisibleUpdate(DC);
Douglas Gregor851443c2011-08-12 01:39:19 +00005143
Douglas Gregor959bb062011-12-03 01:15:29 +00005144 if (!WritingModule) {
5145 // Write the submodules that were imported, if any.
Aaron Ballman4f45b712014-03-21 15:22:56 +00005146 struct ModuleInfo {
5147 uint64_t ID;
5148 Module *M;
5149 ModuleInfo(uint64_t ID, Module *M) : ID(ID), M(M) {}
5150 };
Richard Smith56be7542014-03-21 00:33:59 +00005151 llvm::SmallVector<ModuleInfo, 64> Imports;
Aaron Ballmanbbc31212014-03-14 20:59:21 +00005152 for (const auto *I : Context.local_imports()) {
Douglas Gregor959bb062011-12-03 01:15:29 +00005153 assert(SubmoduleIDs.find(I->getImportedModule()) != SubmoduleIDs.end());
Aaron Ballman4f45b712014-03-21 15:22:56 +00005154 Imports.push_back(ModuleInfo(SubmoduleIDs[I->getImportedModule()],
5155 I->getImportedModule()));
Douglas Gregor959bb062011-12-03 01:15:29 +00005156 }
Richard Smith56be7542014-03-21 00:33:59 +00005157
5158 if (!Imports.empty()) {
5159 auto Cmp = [](const ModuleInfo &A, const ModuleInfo &B) {
5160 return A.ID < B.ID;
5161 };
Ben Langmuir5f95c8f2014-09-08 20:36:26 +00005162 auto Eq = [](const ModuleInfo &A, const ModuleInfo &B) {
5163 return A.ID == B.ID;
5164 };
Richard Smith56be7542014-03-21 00:33:59 +00005165
5166 // Sort and deduplicate module IDs.
Fangrui Song55fab262018-09-26 22:16:28 +00005167 llvm::sort(Imports, Cmp);
Ben Langmuir5f95c8f2014-09-08 20:36:26 +00005168 Imports.erase(std::unique(Imports.begin(), Imports.end(), Eq),
Richard Smith56be7542014-03-21 00:33:59 +00005169 Imports.end());
5170
5171 RecordData ImportedModules;
5172 for (const auto &Import : Imports) {
5173 ImportedModules.push_back(Import.ID);
5174 // FIXME: If the module has macros imported then later has declarations
5175 // imported, this location won't be the right one as a location for the
5176 // declaration imports.
Richard Smith10434f32015-05-02 02:08:26 +00005177 AddSourceLocation(PP.getModuleImportLoc(Import.M), ImportedModules);
Richard Smith56be7542014-03-21 00:33:59 +00005178 }
5179
Douglas Gregor959bb062011-12-03 01:15:29 +00005180 Stream.EmitRecord(IMPORTED_MODULES, ImportedModules);
5181 }
Douglas Gregor0a839132011-12-03 00:59:55 +00005182 }
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00005183
Douglas Gregor404cdde2012-01-27 01:47:08 +00005184 WriteObjCCategories();
Nico Weber779355f2016-03-02 23:22:00 +00005185 if(!WritingModule) {
Dario Domizioli13a0a382014-05-23 12:13:25 +00005186 WriteOptimizePragmaOptions(SemaRef);
Nico Weber779355f2016-03-02 23:22:00 +00005187 WriteMSStructPragmaOptions(SemaRef);
Nico Weber42932312016-03-03 00:17:35 +00005188 WriteMSPointersToMembersPragmaOptions(SemaRef);
Nico Weber779355f2016-03-02 23:22:00 +00005189 }
Alex Lorenz7d7e1e02017-03-31 15:36:21 +00005190 WritePackPragmaOptions(SemaRef);
Richard Smithe40f2ba2013-08-07 21:41:30 +00005191
Douglas Gregor08f01292009-04-17 22:13:46 +00005192 // Some simple statistics
Mehdi Amini57a41912015-09-10 01:46:39 +00005193 RecordData::value_type Record[] = {
5194 NumStatements, NumMacros, NumLexicalDeclContexts, NumVisibleDeclContexts};
Sebastian Redl539c5062010-08-18 23:57:32 +00005195 Stream.EmitRecord(STATISTICS, Record);
Douglas Gregor8f45df52009-04-16 22:23:12 +00005196 Stream.ExitBlock();
Adrian Prantladbd2b12015-09-22 23:26:31 +00005197
Douglas Gregor6623e1f2015-11-03 18:33:07 +00005198 // Write the module file extension blocks.
5199 for (const auto &ExtWriter : ModuleFileExtensionWriters)
Douglas Gregor8f64ca12015-12-08 22:43:32 +00005200 WriteModuleFileExtension(SemaRef, *ExtWriter);
Douglas Gregor6623e1f2015-11-03 18:33:07 +00005201
Duncan P. N. Exon Smith60fa2882017-03-13 18:45:08 +00005202 return writeUnhashedControlBlock(PP, Context);
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005203}
5204
Richard Smithb9eab6d2014-03-20 19:44:17 +00005205void ASTWriter::WriteDeclUpdatesBlocks(RecordDataImpl &OffsetsRecord) {
Argyrios Kyrtzidis65ad5692010-10-24 17:26:36 +00005206 if (DeclUpdates.empty())
5207 return;
5208
Richard Smith59442b42014-03-20 20:07:19 +00005209 DeclUpdateMap LocalUpdates;
5210 LocalUpdates.swap(DeclUpdates);
5211
Richard Smith6ef42932014-03-20 21:02:00 +00005212 for (auto &DeclUpdate : LocalUpdates) {
5213 const Decl *D = DeclUpdate.first;
Argyrios Kyrtzidis3ba70b82010-10-24 17:26:46 +00005214
Richard Smithd28ac5b2014-03-22 23:33:22 +00005215 bool HasUpdatedBody = false;
Richard Smith69c82bf2016-04-01 22:52:03 +00005216 RecordData RecordData;
5217 ASTRecordWriter Record(*this, RecordData);
Richard Smith6ef42932014-03-20 21:02:00 +00005218 for (auto &Update : DeclUpdate.second) {
5219 DeclUpdateKind Kind = (DeclUpdateKind)Update.getKind();
5220
Richard Smith69c82bf2016-04-01 22:52:03 +00005221 // An updated body is emitted last, so that the reader doesn't need
5222 // to skip over the lazy body to reach statements for other records.
5223 if (Kind == UPD_CXX_ADDED_FUNCTION_DEFINITION)
5224 HasUpdatedBody = true;
5225 else
5226 Record.push_back(Kind);
5227
Richard Smith6ef42932014-03-20 21:02:00 +00005228 switch (Kind) {
5229 case UPD_CXX_ADDED_IMPLICIT_MEMBER:
5230 case UPD_CXX_ADDED_TEMPLATE_SPECIALIZATION:
5231 case UPD_CXX_ADDED_ANONYMOUS_NAMESPACE:
Richard Smithcd45dbc2014-04-19 03:48:30 +00005232 assert(Update.getDecl() && "no decl to add?");
Richard Smith6ef42932014-03-20 21:02:00 +00005233 Record.push_back(GetDeclRef(Update.getDecl()));
5234 break;
5235
Richard Smith4d235792014-08-07 18:53:08 +00005236 case UPD_CXX_ADDED_FUNCTION_DEFINITION:
Richard Smithd28ac5b2014-03-22 23:33:22 +00005237 break;
5238
Richard Smith891fc7f2017-12-05 01:31:47 +00005239 case UPD_CXX_POINT_OF_INSTANTIATION:
5240 // FIXME: Do we need to also save the template specialization kind here?
Richard Smith69c82bf2016-04-01 22:52:03 +00005241 Record.AddSourceLocation(Update.getLoc());
Richard Smith891fc7f2017-12-05 01:31:47 +00005242 break;
5243
5244 case UPD_CXX_ADDED_VAR_DEFINITION: {
5245 const VarDecl *VD = cast<VarDecl>(D);
Richard Smithf5017592017-11-02 01:06:00 +00005246 Record.push_back(VD->isInline());
5247 Record.push_back(VD->isInlineSpecified());
Richard Smith05a21352017-06-22 22:18:46 +00005248 if (VD->getInit()) {
5249 Record.push_back(!VD->isInitKnownICE() ? 1
5250 : (VD->isInitICE() ? 3 : 2));
5251 Record.AddStmt(const_cast<Expr*>(VD->getInit()));
5252 } else {
5253 Record.push_back(0);
5254 }
Richard Smith4d235792014-08-07 18:53:08 +00005255 break;
Richard Smith05a21352017-06-22 22:18:46 +00005256 }
Richard Smith4d235792014-08-07 18:53:08 +00005257
John McCall32791cc2016-01-06 22:34:54 +00005258 case UPD_CXX_INSTANTIATED_DEFAULT_ARGUMENT:
Richard Smith290d8012016-04-06 17:06:00 +00005259 Record.AddStmt(const_cast<Expr *>(
5260 cast<ParmVarDecl>(Update.getDecl())->getDefaultArg()));
John McCall32791cc2016-01-06 22:34:54 +00005261 break;
5262
Richard Smith4b054b22016-08-24 21:25:37 +00005263 case UPD_CXX_INSTANTIATED_DEFAULT_MEMBER_INITIALIZER:
5264 Record.AddStmt(
5265 cast<FieldDecl>(Update.getDecl())->getInClassInitializer());
5266 break;
5267
Richard Smithcd45dbc2014-04-19 03:48:30 +00005268 case UPD_CXX_INSTANTIATED_CLASS_DEFINITION: {
5269 auto *RD = cast<CXXRecordDecl>(D);
Chandler Carruth8a3d24d2015-03-26 04:27:10 +00005270 UpdatedDeclContexts.insert(RD->getPrimaryContext());
Akira Hatanakafcbe17c2018-03-28 21:13:14 +00005271 Record.push_back(RD->isParamDestroyedInCallee());
Akira Hatanakae6313ac2018-04-09 22:48:22 +00005272 Record.push_back(RD->getArgPassingRestrictions());
Richard Smith69c82bf2016-04-01 22:52:03 +00005273 Record.AddCXXDefinitionData(RD);
Richard Smith72e50fe2016-04-14 00:50:18 +00005274 Record.AddOffset(WriteDeclContextLexicalBlock(
Richard Smithcd45dbc2014-04-19 03:48:30 +00005275 *Context, const_cast<CXXRecordDecl *>(RD)));
5276
5277 // This state is sometimes updated by template instantiation, when we
5278 // switch from the specialization referring to the template declaration
5279 // to it referring to the template definition.
5280 if (auto *MSInfo = RD->getMemberSpecializationInfo()) {
5281 Record.push_back(MSInfo->getTemplateSpecializationKind());
Richard Smith69c82bf2016-04-01 22:52:03 +00005282 Record.AddSourceLocation(MSInfo->getPointOfInstantiation());
Richard Smithcd45dbc2014-04-19 03:48:30 +00005283 } else {
5284 auto *Spec = cast<ClassTemplateSpecializationDecl>(RD);
5285 Record.push_back(Spec->getTemplateSpecializationKind());
Richard Smith69c82bf2016-04-01 22:52:03 +00005286 Record.AddSourceLocation(Spec->getPointOfInstantiation());
Richard Smithdf352052014-05-22 20:59:29 +00005287
5288 // The instantiation might have been resolved to a partial
5289 // specialization. If so, record which one.
5290 auto From = Spec->getInstantiatedFrom();
5291 if (auto PartialSpec =
5292 From.dyn_cast<ClassTemplatePartialSpecializationDecl*>()) {
5293 Record.push_back(true);
Richard Smith69c82bf2016-04-01 22:52:03 +00005294 Record.AddDeclRef(PartialSpec);
5295 Record.AddTemplateArgumentList(
5296 &Spec->getTemplateInstantiationArgs());
Richard Smithdf352052014-05-22 20:59:29 +00005297 } else {
5298 Record.push_back(false);
5299 }
Richard Smithcd45dbc2014-04-19 03:48:30 +00005300 }
5301 Record.push_back(RD->getTagKind());
Richard Smith69c82bf2016-04-01 22:52:03 +00005302 Record.AddSourceLocation(RD->getLocation());
Stephen Kellyf2ceec42018-08-09 21:08:08 +00005303 Record.AddSourceLocation(RD->getBeginLoc());
Argyrios Kyrtzidisd798c052016-07-15 18:11:33 +00005304 Record.AddSourceRange(RD->getBraceRange());
Richard Smithcd45dbc2014-04-19 03:48:30 +00005305
5306 // Instantiation may change attributes; write them all out afresh.
5307 Record.push_back(D->hasAttrs());
Richard Smith69c82bf2016-04-01 22:52:03 +00005308 if (D->hasAttrs())
5309 Record.AddAttributes(D->getAttrs());
Richard Smithcd45dbc2014-04-19 03:48:30 +00005310
5311 // FIXME: Ensure we don't get here for explicit instantiations.
5312 break;
5313 }
5314
Richard Smithf8134002015-03-10 01:41:22 +00005315 case UPD_CXX_RESOLVED_DTOR_DELETE:
Richard Smith69c82bf2016-04-01 22:52:03 +00005316 Record.AddDeclRef(Update.getDecl());
Richard Smith5b349582017-10-13 01:55:36 +00005317 Record.AddStmt(cast<CXXDestructorDecl>(D)->getOperatorDeleteThisArg());
Richard Smithf8134002015-03-10 01:41:22 +00005318 break;
5319
Richard Smith564417a2014-03-20 21:47:22 +00005320 case UPD_CXX_RESOLVED_EXCEPTION_SPEC:
5321 addExceptionSpec(
Richard Smith564417a2014-03-20 21:47:22 +00005322 cast<FunctionDecl>(D)->getType()->castAs<FunctionProtoType>(),
5323 Record);
5324 break;
5325
Richard Smith6ef42932014-03-20 21:02:00 +00005326 case UPD_CXX_DEDUCED_RETURN_TYPE:
5327 Record.push_back(GetOrCreateTypeID(Update.getType()));
5328 break;
5329
5330 case UPD_DECL_MARKED_USED:
5331 break;
Richard Smith5652c0f2014-03-21 01:48:23 +00005332
5333 case UPD_MANGLING_NUMBER:
5334 case UPD_STATIC_LOCAL_NUMBER:
5335 Record.push_back(Update.getNumber());
5336 break;
Richard Smith65ebb4a2015-03-26 04:09:53 +00005337
Alexey Bataev97720002014-11-11 04:05:39 +00005338 case UPD_DECL_MARKED_OPENMP_THREADPRIVATE:
Richard Smith69c82bf2016-04-01 22:52:03 +00005339 Record.AddSourceRange(
5340 D->getAttr<OMPThreadPrivateDeclAttr>()->getRange());
Alexey Bataev97720002014-11-11 04:05:39 +00005341 break;
Richard Smith65ebb4a2015-03-26 04:09:53 +00005342
Alexey Bataev27ef9512019-03-20 20:14:22 +00005343 case UPD_DECL_MARKED_OPENMP_ALLOCATE: {
5344 auto *A = D->getAttr<OMPAllocateDeclAttr>();
5345 Record.push_back(A->getAllocatorType());
5346 Record.AddStmt(A->getAllocator());
5347 Record.AddSourceRange(A->getRange());
Alexey Bataev25ed0c02019-03-07 17:54:44 +00005348 break;
Alexey Bataev27ef9512019-03-20 20:14:22 +00005349 }
Alexey Bataev25ed0c02019-03-07 17:54:44 +00005350
Dmitry Polukhin0b0da292016-04-06 11:38:59 +00005351 case UPD_DECL_MARKED_OPENMP_DECLARETARGET:
Alexey Bataevd01b7492018-08-15 19:45:12 +00005352 Record.push_back(D->getAttr<OMPDeclareTargetDeclAttr>()->getMapType());
Dmitry Polukhin0b0da292016-04-06 11:38:59 +00005353 Record.AddSourceRange(
5354 D->getAttr<OMPDeclareTargetDeclAttr>()->getRange());
5355 break;
5356
Richard Smith65ebb4a2015-03-26 04:09:53 +00005357 case UPD_DECL_EXPORTED:
Richard Smith4caa4492015-05-15 02:34:32 +00005358 Record.push_back(getSubmoduleID(Update.getModule()));
Richard Smith65ebb4a2015-03-26 04:09:53 +00005359 break;
Alex Denisovfde64952015-06-26 05:28:36 +00005360
5361 case UPD_ADDED_ATTR_TO_RECORD:
Richard Smith69c82bf2016-04-01 22:52:03 +00005362 Record.AddAttributes(llvm::makeArrayRef(Update.getAttr()));
Alex Denisovfde64952015-06-26 05:28:36 +00005363 break;
Richard Smith6ef42932014-03-20 21:02:00 +00005364 }
5365 }
5366
Richard Smithd28ac5b2014-03-22 23:33:22 +00005367 if (HasUpdatedBody) {
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00005368 const auto *Def = cast<FunctionDecl>(D);
Richard Smith4d235792014-08-07 18:53:08 +00005369 Record.push_back(UPD_CXX_ADDED_FUNCTION_DEFINITION);
Richard Smithd28ac5b2014-03-22 23:33:22 +00005370 Record.push_back(Def->isInlined());
Richard Smith69c82bf2016-04-01 22:52:03 +00005371 Record.AddSourceLocation(Def->getInnerLocStart());
Richard Smith290d8012016-04-06 17:06:00 +00005372 Record.AddFunctionDefinition(Def);
Richard Smithd28ac5b2014-03-22 23:33:22 +00005373 }
5374
Richard Smithcd45dbc2014-04-19 03:48:30 +00005375 OffsetsRecord.push_back(GetDeclRef(D));
Richard Smith69c82bf2016-04-01 22:52:03 +00005376 OffsetsRecord.push_back(Record.Emit(DECL_UPDATES));
Argyrios Kyrtzidis65ad5692010-10-24 17:26:36 +00005377 }
Argyrios Kyrtzidis65ad5692010-10-24 17:26:36 +00005378}
5379
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00005380void ASTWriter::AddSourceLocation(SourceLocation Loc, RecordDataImpl &Record) {
Richard Smithb22a1d12016-03-27 20:13:24 +00005381 uint32_t Raw = Loc.getRawEncoding();
5382 Record.push_back((Raw << 1) | (Raw >> 31));
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005383}
5384
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00005385void ASTWriter::AddSourceRange(SourceRange Range, RecordDataImpl &Record) {
Chris Lattnerca025db2010-05-07 21:43:38 +00005386 AddSourceLocation(Range.getBegin(), Record);
5387 AddSourceLocation(Range.getEnd(), Record);
5388}
5389
Richard Smithf144b542016-04-08 21:54:32 +00005390void ASTRecordWriter::AddAPInt(const llvm::APInt &Value) {
5391 Record->push_back(Value.getBitWidth());
Benjamin Kramer25f9ea62010-09-06 23:43:28 +00005392 const uint64_t *Words = Value.getRawData();
Richard Smithf144b542016-04-08 21:54:32 +00005393 Record->append(Words, Words + Value.getNumWords());
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005394}
5395
Richard Smithf144b542016-04-08 21:54:32 +00005396void ASTRecordWriter::AddAPSInt(const llvm::APSInt &Value) {
5397 Record->push_back(Value.isUnsigned());
5398 AddAPInt(Value);
Douglas Gregor1daeb692009-04-13 18:14:40 +00005399}
5400
Richard Smithf144b542016-04-08 21:54:32 +00005401void ASTRecordWriter::AddAPFloat(const llvm::APFloat &Value) {
5402 AddAPInt(Value.bitcastToAPInt());
Douglas Gregore0a3a512009-04-14 21:55:33 +00005403}
5404
Gauthier Harnisch83c7b612019-06-15 10:24:47 +00005405static void WriteFixedPointSemantics(ASTRecordWriter &Record,
5406 FixedPointSemantics FPSema) {
5407 Record.push_back(FPSema.getWidth());
5408 Record.push_back(FPSema.getScale());
5409 Record.push_back(FPSema.isSigned() | FPSema.isSaturated() << 1 |
5410 FPSema.hasUnsignedPadding() << 2);
5411}
5412
5413void ASTRecordWriter::AddAPValue(const APValue &Value) {
5414 APValue::ValueKind Kind = Value.getKind();
5415 push_back(static_cast<uint64_t>(Kind));
5416 switch (Kind) {
5417 case APValue::None:
5418 case APValue::Indeterminate:
5419 return;
5420 case APValue::Int:
5421 AddAPSInt(Value.getInt());
5422 return;
5423 case APValue::Float:
5424 push_back(static_cast<uint64_t>(
5425 llvm::APFloatBase::SemanticsToEnum(Value.getFloat().getSemantics())));
5426 AddAPFloat(Value.getFloat());
5427 return;
5428 case APValue::FixedPoint: {
5429 WriteFixedPointSemantics(*this, Value.getFixedPoint().getSemantics());
5430 AddAPSInt(Value.getFixedPoint().getValue());
5431 return;
5432 }
5433 case APValue::ComplexInt: {
5434 AddAPSInt(Value.getComplexIntReal());
5435 AddAPSInt(Value.getComplexIntImag());
5436 return;
5437 }
5438 case APValue::ComplexFloat: {
5439 push_back(static_cast<uint64_t>(llvm::APFloatBase::SemanticsToEnum(
5440 Value.getComplexFloatReal().getSemantics())));
5441 AddAPFloat(Value.getComplexFloatReal());
5442 push_back(static_cast<uint64_t>(llvm::APFloatBase::SemanticsToEnum(
5443 Value.getComplexFloatImag().getSemantics())));
5444 AddAPFloat(Value.getComplexFloatImag());
5445 return;
5446 }
5447 case APValue::LValue:
5448 case APValue::Vector:
5449 case APValue::Array:
5450 case APValue::Struct:
5451 case APValue::Union:
5452 case APValue::MemberPointer:
5453 case APValue::AddrLabelDiff:
5454 // TODO : Handle all these APValue::ValueKind.
5455 return;
5456 }
5457 llvm_unreachable("Invalid APValue::ValueKind");
5458}
5459
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00005460void ASTWriter::AddIdentifierRef(const IdentifierInfo *II, RecordDataImpl &Record) {
Douglas Gregor4621c6a2009-04-22 18:49:13 +00005461 Record.push_back(getIdentifierRef(II));
5462}
5463
Sebastian Redl539c5062010-08-18 23:57:32 +00005464IdentID ASTWriter::getIdentifierRef(const IdentifierInfo *II) {
Craig Toppera13603a2014-05-22 05:54:18 +00005465 if (!II)
Douglas Gregor4621c6a2009-04-22 18:49:13 +00005466 return 0;
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00005467
Sebastian Redl539c5062010-08-18 23:57:32 +00005468 IdentID &ID = IdentifierIDs[II];
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00005469 if (ID == 0)
Sebastian Redlff4a2952010-07-23 23:49:55 +00005470 ID = NextIdentID++;
Douglas Gregor4621c6a2009-04-22 18:49:13 +00005471 return ID;
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005472}
5473
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00005474MacroID ASTWriter::getMacroRef(MacroInfo *MI, const IdentifierInfo *Name) {
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00005475 // Don't emit builtin macros like __LINE__ to the AST file unless they
5476 // have been redefined by the header (in which case they are not
5477 // isBuiltinMacro).
Craig Toppera13603a2014-05-22 05:54:18 +00005478 if (!MI || MI->isBuiltinMacro())
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00005479 return 0;
5480
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00005481 MacroID &ID = MacroIDs[MI];
5482 if (ID == 0) {
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00005483 ID = NextMacroID++;
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00005484 MacroInfoToEmitData Info = { Name, MI, ID };
5485 MacroInfosToEmit.push_back(Info);
5486 }
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00005487 return ID;
5488}
5489
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00005490MacroID ASTWriter::getMacroID(MacroInfo *MI) {
Craig Toppera13603a2014-05-22 05:54:18 +00005491 if (!MI || MI->isBuiltinMacro())
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00005492 return 0;
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00005493
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00005494 assert(MacroIDs.find(MI) != MacroIDs.end() && "Macro not emitted!");
5495 return MacroIDs[MI];
5496}
5497
5498uint64_t ASTWriter::getMacroDirectivesOffset(const IdentifierInfo *Name) {
Richard Smithd7329392015-04-21 21:46:32 +00005499 return IdentMacroDirectivesOffsetMap.lookup(Name);
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00005500}
5501
Richard Smithe64e7452016-04-18 21:54:58 +00005502void ASTRecordWriter::AddSelectorRef(const Selector SelRef) {
5503 Record->push_back(Writer->getSelectorRef(SelRef));
Sebastian Redl834bb972010-08-04 17:20:04 +00005504}
5505
Sebastian Redl539c5062010-08-18 23:57:32 +00005506SelectorID ASTWriter::getSelectorRef(Selector Sel) {
Craig Toppera13603a2014-05-22 05:54:18 +00005507 if (Sel.getAsOpaquePtr() == nullptr) {
Sebastian Redl834bb972010-08-04 17:20:04 +00005508 return 0;
Steve Naroff2ddea052009-04-23 10:39:46 +00005509 }
5510
Douglas Gregor8d7edce2013-02-08 21:30:59 +00005511 SelectorID SID = SelectorIDs[Sel];
Sebastian Redld95a56e2010-08-04 18:21:41 +00005512 if (SID == 0 && Chain) {
5513 // This might trigger a ReadSelector callback, which will set the ID for
5514 // this selector.
5515 Chain->LoadSelector(Sel);
Douglas Gregor8d7edce2013-02-08 21:30:59 +00005516 SID = SelectorIDs[Sel];
Sebastian Redld95a56e2010-08-04 18:21:41 +00005517 }
Steve Naroff2ddea052009-04-23 10:39:46 +00005518 if (SID == 0) {
Sebastian Redld95a56e2010-08-04 18:21:41 +00005519 SID = NextSelectorID++;
Douglas Gregor8d7edce2013-02-08 21:30:59 +00005520 SelectorIDs[Sel] = SID;
Steve Naroff2ddea052009-04-23 10:39:46 +00005521 }
Sebastian Redl834bb972010-08-04 17:20:04 +00005522 return SID;
Steve Naroff2ddea052009-04-23 10:39:46 +00005523}
5524
Richard Smithe64e7452016-04-18 21:54:58 +00005525void ASTRecordWriter::AddCXXTemporary(const CXXTemporary *Temp) {
5526 AddDeclRef(Temp->getDestructor());
Chris Lattnercba86142010-05-10 00:25:06 +00005527}
5528
Richard Smith290d8012016-04-06 17:06:00 +00005529void ASTRecordWriter::AddTemplateArgumentLocInfo(
5530 TemplateArgument::ArgKind Kind, const TemplateArgumentLocInfo &Arg) {
Argyrios Kyrtzidisae85e242010-06-22 09:54:59 +00005531 switch (Kind) {
John McCall0ad16662009-10-29 08:12:44 +00005532 case TemplateArgument::Expression:
Argyrios Kyrtzidisae85e242010-06-22 09:54:59 +00005533 AddStmt(Arg.getAsExpr());
John McCall0ad16662009-10-29 08:12:44 +00005534 break;
5535 case TemplateArgument::Type:
Richard Smith290d8012016-04-06 17:06:00 +00005536 AddTypeSourceInfo(Arg.getAsTypeSourceInfo());
John McCall0ad16662009-10-29 08:12:44 +00005537 break;
Douglas Gregor9167f8b2009-11-11 01:00:40 +00005538 case TemplateArgument::Template:
Richard Smith290d8012016-04-06 17:06:00 +00005539 AddNestedNameSpecifierLoc(Arg.getTemplateQualifierLoc());
5540 AddSourceLocation(Arg.getTemplateNameLoc());
Douglas Gregore4ff4b52011-01-05 18:58:31 +00005541 break;
5542 case TemplateArgument::TemplateExpansion:
Richard Smith290d8012016-04-06 17:06:00 +00005543 AddNestedNameSpecifierLoc(Arg.getTemplateQualifierLoc());
5544 AddSourceLocation(Arg.getTemplateNameLoc());
5545 AddSourceLocation(Arg.getTemplateEllipsisLoc());
Douglas Gregor9167f8b2009-11-11 01:00:40 +00005546 break;
John McCall0ad16662009-10-29 08:12:44 +00005547 case TemplateArgument::Null:
5548 case TemplateArgument::Integral:
5549 case TemplateArgument::Declaration:
Eli Friedmanb826a002012-09-26 02:36:12 +00005550 case TemplateArgument::NullPtr:
John McCall0ad16662009-10-29 08:12:44 +00005551 case TemplateArgument::Pack:
Eli Friedmanb826a002012-09-26 02:36:12 +00005552 // FIXME: Is this right?
John McCall0ad16662009-10-29 08:12:44 +00005553 break;
5554 }
5555}
5556
Richard Smith290d8012016-04-06 17:06:00 +00005557void ASTRecordWriter::AddTemplateArgumentLoc(const TemplateArgumentLoc &Arg) {
5558 AddTemplateArgument(Arg.getArgument());
Argyrios Kyrtzidisddf5f212010-06-28 09:31:42 +00005559
5560 if (Arg.getArgument().getKind() == TemplateArgument::Expression) {
5561 bool InfoHasSameExpr
5562 = Arg.getArgument().getAsExpr() == Arg.getLocInfo().getAsExpr();
Richard Smith290d8012016-04-06 17:06:00 +00005563 Record->push_back(InfoHasSameExpr);
Argyrios Kyrtzidisddf5f212010-06-28 09:31:42 +00005564 if (InfoHasSameExpr)
5565 return; // Avoid storing the same expr twice.
5566 }
Richard Smith290d8012016-04-06 17:06:00 +00005567 AddTemplateArgumentLocInfo(Arg.getArgument().getKind(), Arg.getLocInfo());
Argyrios Kyrtzidisae85e242010-06-22 09:54:59 +00005568}
5569
Richard Smith290d8012016-04-06 17:06:00 +00005570void ASTRecordWriter::AddTypeSourceInfo(TypeSourceInfo *TInfo) {
Craig Toppera13603a2014-05-22 05:54:18 +00005571 if (!TInfo) {
Richard Smith290d8012016-04-06 17:06:00 +00005572 AddTypeRef(QualType());
John McCall8f115c62009-10-16 21:56:05 +00005573 return;
5574 }
5575
Richard Smithc23d7342018-06-29 20:46:25 +00005576 AddTypeRef(TInfo->getType());
Richard Smith290d8012016-04-06 17:06:00 +00005577 AddTypeLoc(TInfo->getTypeLoc());
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005578}
5579
Richard Smith290d8012016-04-06 17:06:00 +00005580void ASTRecordWriter::AddTypeLoc(TypeLoc TL) {
Richard Smith290d8012016-04-06 17:06:00 +00005581 TypeLocWriter TLW(*this);
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005582 for (; !TL.isNull(); TL = TL.getNextTypeLoc())
Kovarththanan Rajaratnama9c81a82010-03-14 07:06:50 +00005583 TLW.Visit(TL);
John McCall8f115c62009-10-16 21:56:05 +00005584}
5585
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00005586void ASTWriter::AddTypeRef(QualType T, RecordDataImpl &Record) {
Argyrios Kyrtzidis9ab44ea2010-08-20 16:04:14 +00005587 Record.push_back(GetOrCreateTypeID(T));
5588}
5589
Richard Smith2095ffe2015-03-16 20:11:03 +00005590TypeID ASTWriter::GetOrCreateTypeID(QualType T) {
Richard Smith1fa5d642013-05-11 05:45:24 +00005591 assert(Context);
Richard Smith2095ffe2015-03-16 20:11:03 +00005592 return MakeTypeID(*Context, T, [&](QualType T) -> TypeIdx {
5593 if (T.isNull())
5594 return TypeIdx();
5595 assert(!T.getLocalFastQualifiers());
5596
5597 TypeIdx &Idx = TypeIdxs[T];
5598 if (Idx.getIndex() == 0) {
5599 if (DoneWritingDeclsAndTypes) {
5600 assert(0 && "New type seen after serializing all the types to emit!");
5601 return TypeIdx();
5602 }
5603
5604 // We haven't seen this type before. Assign it a new ID and put it
5605 // into the queue of types to emit.
5606 Idx = TypeIdx(NextTypeID++);
5607 DeclTypesToEmit.push(T);
5608 }
5609 return Idx;
5610 });
Argyrios Kyrtzidis082e4612010-08-20 16:04:20 +00005611}
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005612
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00005613TypeID ASTWriter::getTypeID(QualType T) const {
Richard Smith1fa5d642013-05-11 05:45:24 +00005614 assert(Context);
Richard Smith2095ffe2015-03-16 20:11:03 +00005615 return MakeTypeID(*Context, T, [&](QualType T) -> TypeIdx {
5616 if (T.isNull())
Argyrios Kyrtzidis442dd802012-07-02 19:19:01 +00005617 return TypeIdx();
Richard Smith2095ffe2015-03-16 20:11:03 +00005618 assert(!T.getLocalFastQualifiers());
Argyrios Kyrtzidis442dd802012-07-02 19:19:01 +00005619
Richard Smith2095ffe2015-03-16 20:11:03 +00005620 TypeIdxMap::const_iterator I = TypeIdxs.find(T);
5621 assert(I != TypeIdxs.end() && "Type not emitted!");
5622 return I->second;
5623 });
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005624}
5625
Argyrios Kyrtzidis65ad5692010-10-24 17:26:36 +00005626void ASTWriter::AddDeclRef(const Decl *D, RecordDataImpl &Record) {
Sebastian Redl66c5eef2010-07-27 00:17:23 +00005627 Record.push_back(GetDeclRef(D));
5628}
5629
Sebastian Redl539c5062010-08-18 23:57:32 +00005630DeclID ASTWriter::GetDeclRef(const Decl *D) {
Douglas Gregor2fd3d402011-09-17 00:05:03 +00005631 assert(WritingAST && "Cannot request a declaration ID before AST writing");
Craig Toppera13603a2014-05-22 05:54:18 +00005632
5633 if (!D) {
Sebastian Redl66c5eef2010-07-27 00:17:23 +00005634 return 0;
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005635 }
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00005636
Douglas Gregorb3163e52012-01-05 22:33:30 +00005637 // If D comes from an AST file, its declaration ID is already known and
5638 // fixed.
5639 if (D->isFromASTFile())
5640 return D->getGlobalID();
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00005641
Douglas Gregor9b3932c2010-10-05 18:37:06 +00005642 assert(!(reinterpret_cast<uintptr_t>(D) & 0x01) && "Invalid decl pointer");
Sebastian Redl539c5062010-08-18 23:57:32 +00005643 DeclID &ID = DeclIDs[D];
Mike Stump11289f42009-09-09 15:08:12 +00005644 if (ID == 0) {
Argyrios Kyrtzidis442dd802012-07-02 19:19:01 +00005645 if (DoneWritingDeclsAndTypes) {
5646 assert(0 && "New decl seen after serializing all the decls to emit!");
5647 return 0;
5648 }
5649
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005650 // We haven't seen this declaration before. Give it a new ID and
5651 // enqueue it in the list of declarations to emit.
Sebastian Redlff4a2952010-07-23 23:49:55 +00005652 ID = NextDeclID++;
Douglas Gregor12bfa382009-10-17 00:13:19 +00005653 DeclTypesToEmit.push(const_cast<Decl *>(D));
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005654 }
5655
Sebastian Redl66c5eef2010-07-27 00:17:23 +00005656 return ID;
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005657}
5658
Sebastian Redl539c5062010-08-18 23:57:32 +00005659DeclID ASTWriter::getDeclID(const Decl *D) {
Craig Toppera13603a2014-05-22 05:54:18 +00005660 if (!D)
Douglas Gregore84a9da2009-04-20 20:36:09 +00005661 return 0;
5662
Douglas Gregorb3163e52012-01-05 22:33:30 +00005663 // If D comes from an AST file, its declaration ID is already known and
5664 // fixed.
5665 if (D->isFromASTFile())
5666 return D->getGlobalID();
5667
Douglas Gregore84a9da2009-04-20 20:36:09 +00005668 assert(DeclIDs.find(D) != DeclIDs.end() && "Declaration not emitted!");
5669 return DeclIDs[D];
5670}
5671
Argyrios Kyrtzidisdf53da82011-10-28 23:57:43 +00005672void ASTWriter::associateDeclWithFile(const Decl *D, DeclID ID) {
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005673 assert(ID);
Argyrios Kyrtzidisdf53da82011-10-28 23:57:43 +00005674 assert(D);
5675
5676 SourceLocation Loc = D->getLocation();
5677 if (Loc.isInvalid())
5678 return;
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005679
5680 // We only keep track of the file-level declarations of each file.
5681 if (!D->getLexicalDeclContext()->isFileContext())
5682 return;
Argyrios Kyrtzidise1bc99e2012-02-24 19:45:46 +00005683 // FIXME: ParmVarDecls that are part of a function type of a parameter of
5684 // a function/objc method, should not have TU as lexical context.
Argyrios Kyrtzidis71b74eb2018-01-26 19:26:12 +00005685 // TemplateTemplateParmDecls that are part of an alias template, should not
5686 // have TU as lexical context.
5687 if (isa<ParmVarDecl>(D) || isa<TemplateTemplateParmDecl>(D))
Argyrios Kyrtzidisffe055a82012-02-24 01:12:38 +00005688 return;
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005689
5690 SourceManager &SM = Context->getSourceManager();
Argyrios Kyrtzidisdf53da82011-10-28 23:57:43 +00005691 SourceLocation FileLoc = SM.getFileLoc(Loc);
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005692 assert(SM.isLocalSourceLocation(FileLoc));
Argyrios Kyrtzidis7362e9b2011-10-28 23:57:47 +00005693 FileID FID;
5694 unsigned Offset;
Benjamin Kramer867ea1d2014-03-02 13:01:17 +00005695 std::tie(FID, Offset) = SM.getDecomposedLoc(FileLoc);
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005696 if (FID.isInvalid())
5697 return;
Argyrios Kyrtzidis4db774a2012-10-02 21:09:17 +00005698 assert(SM.getSLocEntry(FID).isFile());
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005699
Argyrios Kyrtzidis4db774a2012-10-02 21:09:17 +00005700 DeclIDInFileInfo *&Info = FileDeclIDs[FID];
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005701 if (!Info)
5702 Info = new DeclIDInFileInfo();
5703
Argyrios Kyrtzidis7362e9b2011-10-28 23:57:47 +00005704 std::pair<unsigned, serialization::DeclID> LocDecl(Offset, ID);
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005705 LocDeclIDsTy &Decls = Info->DeclIDs;
5706
Argyrios Kyrtzidis7362e9b2011-10-28 23:57:47 +00005707 if (Decls.empty() || Decls.back().first <= Offset) {
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005708 Decls.push_back(LocDecl);
5709 return;
5710 }
5711
Benjamin Kramer45025c02013-08-24 13:22:59 +00005712 LocDeclIDsTy::iterator I =
Fangrui Song7264a472019-07-03 08:13:17 +00005713 llvm::upper_bound(Decls, LocDecl, llvm::less_first());
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005714
5715 Decls.insert(I, LocDecl);
5716}
5717
Richard Smithe64e7452016-04-18 21:54:58 +00005718void ASTRecordWriter::AddDeclarationName(DeclarationName Name) {
Chris Lattner258172e2009-04-27 07:35:58 +00005719 // FIXME: Emit a stable enum for NameKind. 0 = Identifier etc.
Richard Smithe64e7452016-04-18 21:54:58 +00005720 Record->push_back(Name.getNameKind());
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005721 switch (Name.getNameKind()) {
5722 case DeclarationName::Identifier:
Richard Smithe64e7452016-04-18 21:54:58 +00005723 AddIdentifierRef(Name.getAsIdentifierInfo());
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005724 break;
5725
5726 case DeclarationName::ObjCZeroArgSelector:
5727 case DeclarationName::ObjCOneArgSelector:
5728 case DeclarationName::ObjCMultiArgSelector:
Richard Smithe64e7452016-04-18 21:54:58 +00005729 AddSelectorRef(Name.getObjCSelector());
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005730 break;
5731
5732 case DeclarationName::CXXConstructorName:
5733 case DeclarationName::CXXDestructorName:
5734 case DeclarationName::CXXConversionFunctionName:
Richard Smithe64e7452016-04-18 21:54:58 +00005735 AddTypeRef(Name.getCXXNameType());
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005736 break;
5737
Richard Smith35845152017-02-07 01:37:30 +00005738 case DeclarationName::CXXDeductionGuideName:
5739 AddDeclRef(Name.getCXXDeductionGuideTemplate());
5740 break;
5741
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005742 case DeclarationName::CXXOperatorName:
Richard Smithe64e7452016-04-18 21:54:58 +00005743 Record->push_back(Name.getCXXOverloadedOperator());
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005744 break;
5745
Alexis Hunt3d221f22009-11-29 07:34:05 +00005746 case DeclarationName::CXXLiteralOperatorName:
Richard Smithe64e7452016-04-18 21:54:58 +00005747 AddIdentifierRef(Name.getCXXLiteralIdentifier());
Alexis Hunt3d221f22009-11-29 07:34:05 +00005748 break;
5749
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005750 case DeclarationName::CXXUsingDirective:
5751 // No extra data to emit
5752 break;
5753 }
5754}
Chris Lattnerca025db2010-05-07 21:43:38 +00005755
Richard Smithd08aeb62014-08-28 01:33:39 +00005756unsigned ASTWriter::getAnonymousDeclarationNumber(const NamedDecl *D) {
5757 assert(needsAnonymousDeclarationNumber(D) &&
5758 "expected an anonymous declaration");
5759
5760 // Number the anonymous declarations within this context, if we've not
5761 // already done so.
5762 auto It = AnonymousDeclarationNumbers.find(D);
5763 if (It == AnonymousDeclarationNumbers.end()) {
Richard Smith2b560572015-02-07 03:11:11 +00005764 auto *DC = D->getLexicalDeclContext();
5765 numberAnonymousDeclsWithin(DC, [&](const NamedDecl *ND, unsigned Number) {
5766 AnonymousDeclarationNumbers[ND] = Number;
5767 });
Richard Smithd08aeb62014-08-28 01:33:39 +00005768
5769 It = AnonymousDeclarationNumbers.find(D);
5770 assert(It != AnonymousDeclarationNumbers.end() &&
5771 "declaration not found within its lexical context");
5772 }
5773
5774 return It->second;
5775}
5776
Richard Smith290d8012016-04-06 17:06:00 +00005777void ASTRecordWriter::AddDeclarationNameLoc(const DeclarationNameLoc &DNLoc,
5778 DeclarationName Name) {
Argyrios Kyrtzidis434383d2010-10-15 18:21:24 +00005779 switch (Name.getNameKind()) {
5780 case DeclarationName::CXXConstructorName:
5781 case DeclarationName::CXXDestructorName:
5782 case DeclarationName::CXXConversionFunctionName:
Richard Smith290d8012016-04-06 17:06:00 +00005783 AddTypeSourceInfo(DNLoc.NamedType.TInfo);
Argyrios Kyrtzidis434383d2010-10-15 18:21:24 +00005784 break;
5785
5786 case DeclarationName::CXXOperatorName:
Richard Smith290d8012016-04-06 17:06:00 +00005787 AddSourceLocation(SourceLocation::getFromRawEncoding(
5788 DNLoc.CXXOperatorName.BeginOpNameLoc));
Argyrios Kyrtzidis434383d2010-10-15 18:21:24 +00005789 AddSourceLocation(
Richard Smith290d8012016-04-06 17:06:00 +00005790 SourceLocation::getFromRawEncoding(DNLoc.CXXOperatorName.EndOpNameLoc));
Argyrios Kyrtzidis434383d2010-10-15 18:21:24 +00005791 break;
5792
5793 case DeclarationName::CXXLiteralOperatorName:
Richard Smith290d8012016-04-06 17:06:00 +00005794 AddSourceLocation(SourceLocation::getFromRawEncoding(
5795 DNLoc.CXXLiteralOperatorName.OpNameLoc));
Argyrios Kyrtzidis434383d2010-10-15 18:21:24 +00005796 break;
5797
5798 case DeclarationName::Identifier:
5799 case DeclarationName::ObjCZeroArgSelector:
5800 case DeclarationName::ObjCOneArgSelector:
5801 case DeclarationName::ObjCMultiArgSelector:
5802 case DeclarationName::CXXUsingDirective:
Richard Smith35845152017-02-07 01:37:30 +00005803 case DeclarationName::CXXDeductionGuideName:
Argyrios Kyrtzidis434383d2010-10-15 18:21:24 +00005804 break;
5805 }
5806}
5807
Richard Smith290d8012016-04-06 17:06:00 +00005808void ASTRecordWriter::AddDeclarationNameInfo(
5809 const DeclarationNameInfo &NameInfo) {
5810 AddDeclarationName(NameInfo.getName());
5811 AddSourceLocation(NameInfo.getLoc());
5812 AddDeclarationNameLoc(NameInfo.getInfo(), NameInfo.getName());
Argyrios Kyrtzidis434383d2010-10-15 18:21:24 +00005813}
5814
Richard Smith290d8012016-04-06 17:06:00 +00005815void ASTRecordWriter::AddQualifierInfo(const QualifierInfo &Info) {
5816 AddNestedNameSpecifierLoc(Info.QualifierLoc);
5817 Record->push_back(Info.NumTemplParamLists);
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +00005818 for (unsigned i = 0, e = Info.NumTemplParamLists; i != e; ++i)
Richard Smith290d8012016-04-06 17:06:00 +00005819 AddTemplateParameterList(Info.TemplParamLists[i]);
Argyrios Kyrtzidis434383d2010-10-15 18:21:24 +00005820}
5821
Richard Smithe64e7452016-04-18 21:54:58 +00005822void ASTRecordWriter::AddNestedNameSpecifier(NestedNameSpecifier *NNS) {
Chris Lattnerca025db2010-05-07 21:43:38 +00005823 // Nested name specifiers usually aren't too long. I think that 8 would
Chris Lattner57540c52011-04-15 05:22:18 +00005824 // typically accommodate the vast majority.
Chris Lattner0e62c1c2011-07-23 10:55:15 +00005825 SmallVector<NestedNameSpecifier *, 8> NestedNames;
Chris Lattnerca025db2010-05-07 21:43:38 +00005826
5827 // Push each of the NNS's onto a stack for serialization in reverse order.
5828 while (NNS) {
5829 NestedNames.push_back(NNS);
5830 NNS = NNS->getPrefix();
5831 }
5832
Richard Smithe64e7452016-04-18 21:54:58 +00005833 Record->push_back(NestedNames.size());
Chris Lattnerca025db2010-05-07 21:43:38 +00005834 while(!NestedNames.empty()) {
5835 NNS = NestedNames.pop_back_val();
5836 NestedNameSpecifier::SpecifierKind Kind = NNS->getKind();
Richard Smithe64e7452016-04-18 21:54:58 +00005837 Record->push_back(Kind);
Chris Lattnerca025db2010-05-07 21:43:38 +00005838 switch (Kind) {
5839 case NestedNameSpecifier::Identifier:
Richard Smithe64e7452016-04-18 21:54:58 +00005840 AddIdentifierRef(NNS->getAsIdentifier());
Chris Lattnerca025db2010-05-07 21:43:38 +00005841 break;
5842
5843 case NestedNameSpecifier::Namespace:
Richard Smithe64e7452016-04-18 21:54:58 +00005844 AddDeclRef(NNS->getAsNamespace());
Chris Lattnerca025db2010-05-07 21:43:38 +00005845 break;
5846
Douglas Gregor7b26ff92011-02-24 02:36:08 +00005847 case NestedNameSpecifier::NamespaceAlias:
Richard Smithe64e7452016-04-18 21:54:58 +00005848 AddDeclRef(NNS->getAsNamespaceAlias());
Douglas Gregor7b26ff92011-02-24 02:36:08 +00005849 break;
5850
Chris Lattnerca025db2010-05-07 21:43:38 +00005851 case NestedNameSpecifier::TypeSpec:
5852 case NestedNameSpecifier::TypeSpecWithTemplate:
Richard Smithe64e7452016-04-18 21:54:58 +00005853 AddTypeRef(QualType(NNS->getAsType(), 0));
5854 Record->push_back(Kind == NestedNameSpecifier::TypeSpecWithTemplate);
Chris Lattnerca025db2010-05-07 21:43:38 +00005855 break;
5856
5857 case NestedNameSpecifier::Global:
5858 // Don't need to write an associated value.
5859 break;
Nikola Smiljanic67860242014-09-26 00:28:20 +00005860
5861 case NestedNameSpecifier::Super:
Richard Smithe64e7452016-04-18 21:54:58 +00005862 AddDeclRef(NNS->getAsRecordDecl());
Nikola Smiljanic67860242014-09-26 00:28:20 +00005863 break;
Chris Lattnerca025db2010-05-07 21:43:38 +00005864 }
5865 }
5866}
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005867
Richard Smith290d8012016-04-06 17:06:00 +00005868void ASTRecordWriter::AddNestedNameSpecifierLoc(NestedNameSpecifierLoc NNS) {
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005869 // Nested name specifiers usually aren't too long. I think that 8 would
Chris Lattner57540c52011-04-15 05:22:18 +00005870 // typically accommodate the vast majority.
Chris Lattner0e62c1c2011-07-23 10:55:15 +00005871 SmallVector<NestedNameSpecifierLoc , 8> NestedNames;
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005872
5873 // Push each of the nested-name-specifiers's onto a stack for
5874 // serialization in reverse order.
5875 while (NNS) {
5876 NestedNames.push_back(NNS);
5877 NNS = NNS.getPrefix();
5878 }
5879
Richard Smith290d8012016-04-06 17:06:00 +00005880 Record->push_back(NestedNames.size());
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005881 while(!NestedNames.empty()) {
5882 NNS = NestedNames.pop_back_val();
5883 NestedNameSpecifier::SpecifierKind Kind
5884 = NNS.getNestedNameSpecifier()->getKind();
Richard Smith290d8012016-04-06 17:06:00 +00005885 Record->push_back(Kind);
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005886 switch (Kind) {
5887 case NestedNameSpecifier::Identifier:
Richard Smith290d8012016-04-06 17:06:00 +00005888 AddIdentifierRef(NNS.getNestedNameSpecifier()->getAsIdentifier());
5889 AddSourceRange(NNS.getLocalSourceRange());
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005890 break;
5891
5892 case NestedNameSpecifier::Namespace:
Richard Smith290d8012016-04-06 17:06:00 +00005893 AddDeclRef(NNS.getNestedNameSpecifier()->getAsNamespace());
5894 AddSourceRange(NNS.getLocalSourceRange());
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005895 break;
5896
5897 case NestedNameSpecifier::NamespaceAlias:
Richard Smith290d8012016-04-06 17:06:00 +00005898 AddDeclRef(NNS.getNestedNameSpecifier()->getAsNamespaceAlias());
5899 AddSourceRange(NNS.getLocalSourceRange());
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005900 break;
5901
5902 case NestedNameSpecifier::TypeSpec:
5903 case NestedNameSpecifier::TypeSpecWithTemplate:
Richard Smith290d8012016-04-06 17:06:00 +00005904 Record->push_back(Kind == NestedNameSpecifier::TypeSpecWithTemplate);
Richard Smithc23d7342018-06-29 20:46:25 +00005905 AddTypeRef(NNS.getTypeLoc().getType());
Richard Smith290d8012016-04-06 17:06:00 +00005906 AddTypeLoc(NNS.getTypeLoc());
5907 AddSourceLocation(NNS.getLocalSourceRange().getEnd());
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005908 break;
5909
5910 case NestedNameSpecifier::Global:
Richard Smith290d8012016-04-06 17:06:00 +00005911 AddSourceLocation(NNS.getLocalSourceRange().getEnd());
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005912 break;
Nikola Smiljanic67860242014-09-26 00:28:20 +00005913
5914 case NestedNameSpecifier::Super:
Richard Smith290d8012016-04-06 17:06:00 +00005915 AddDeclRef(NNS.getNestedNameSpecifier()->getAsRecordDecl());
5916 AddSourceRange(NNS.getLocalSourceRange());
Nikola Smiljanic67860242014-09-26 00:28:20 +00005917 break;
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005918 }
5919 }
5920}
5921
Richard Smith290d8012016-04-06 17:06:00 +00005922void ASTRecordWriter::AddTemplateName(TemplateName Name) {
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00005923 TemplateName::NameKind Kind = Name.getKind();
Richard Smith290d8012016-04-06 17:06:00 +00005924 Record->push_back(Kind);
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005925 switch (Kind) {
5926 case TemplateName::Template:
Richard Smith290d8012016-04-06 17:06:00 +00005927 AddDeclRef(Name.getAsTemplateDecl());
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005928 break;
5929
5930 case TemplateName::OverloadedTemplate: {
5931 OverloadedTemplateStorage *OvT = Name.getAsOverloadedTemplate();
Richard Smith290d8012016-04-06 17:06:00 +00005932 Record->push_back(OvT->size());
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00005933 for (const auto &I : *OvT)
Richard Smith290d8012016-04-06 17:06:00 +00005934 AddDeclRef(I);
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005935 break;
5936 }
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00005937
Richard Smithb23c5e82019-05-09 03:31:27 +00005938 case TemplateName::AssumedTemplate: {
5939 AssumedTemplateStorage *ADLT = Name.getAsAssumedTemplateName();
5940 AddDeclarationName(ADLT->getDeclName());
5941 break;
5942 }
5943
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005944 case TemplateName::QualifiedTemplate: {
5945 QualifiedTemplateName *QualT = Name.getAsQualifiedTemplateName();
Richard Smith290d8012016-04-06 17:06:00 +00005946 AddNestedNameSpecifier(QualT->getQualifier());
5947 Record->push_back(QualT->hasTemplateKeyword());
5948 AddDeclRef(QualT->getTemplateDecl());
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005949 break;
5950 }
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00005951
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005952 case TemplateName::DependentTemplate: {
5953 DependentTemplateName *DepT = Name.getAsDependentTemplateName();
Richard Smith290d8012016-04-06 17:06:00 +00005954 AddNestedNameSpecifier(DepT->getQualifier());
5955 Record->push_back(DepT->isIdentifier());
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005956 if (DepT->isIdentifier())
Richard Smith290d8012016-04-06 17:06:00 +00005957 AddIdentifierRef(DepT->getIdentifier());
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005958 else
Richard Smith290d8012016-04-06 17:06:00 +00005959 Record->push_back(DepT->getOperator());
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005960 break;
5961 }
John McCalld9dfe3a2011-06-30 08:33:18 +00005962
5963 case TemplateName::SubstTemplateTemplateParm: {
5964 SubstTemplateTemplateParmStorage *subst
5965 = Name.getAsSubstTemplateTemplateParm();
Richard Smith290d8012016-04-06 17:06:00 +00005966 AddDeclRef(subst->getParameter());
5967 AddTemplateName(subst->getReplacement());
John McCalld9dfe3a2011-06-30 08:33:18 +00005968 break;
5969 }
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00005970
Douglas Gregor5590be02011-01-15 06:45:20 +00005971 case TemplateName::SubstTemplateTemplateParmPack: {
5972 SubstTemplateTemplateParmPackStorage *SubstPack
5973 = Name.getAsSubstTemplateTemplateParmPack();
Richard Smith290d8012016-04-06 17:06:00 +00005974 AddDeclRef(SubstPack->getParameterPack());
5975 AddTemplateArgument(SubstPack->getArgumentPack());
Douglas Gregor5590be02011-01-15 06:45:20 +00005976 break;
5977 }
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005978 }
5979}
5980
Richard Smith290d8012016-04-06 17:06:00 +00005981void ASTRecordWriter::AddTemplateArgument(const TemplateArgument &Arg) {
5982 Record->push_back(Arg.getKind());
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005983 switch (Arg.getKind()) {
5984 case TemplateArgument::Null:
5985 break;
5986 case TemplateArgument::Type:
Richard Smith290d8012016-04-06 17:06:00 +00005987 AddTypeRef(Arg.getAsType());
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005988 break;
5989 case TemplateArgument::Declaration:
Richard Smith290d8012016-04-06 17:06:00 +00005990 AddDeclRef(Arg.getAsDecl());
5991 AddTypeRef(Arg.getParamTypeForDecl());
Eli Friedmanb826a002012-09-26 02:36:12 +00005992 break;
5993 case TemplateArgument::NullPtr:
Richard Smith290d8012016-04-06 17:06:00 +00005994 AddTypeRef(Arg.getNullPtrType());
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005995 break;
5996 case TemplateArgument::Integral:
Richard Smith290d8012016-04-06 17:06:00 +00005997 AddAPSInt(Arg.getAsIntegral());
5998 AddTypeRef(Arg.getIntegralType());
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005999 break;
6000 case TemplateArgument::Template:
Richard Smith290d8012016-04-06 17:06:00 +00006001 AddTemplateName(Arg.getAsTemplateOrTemplatePattern());
Douglas Gregore1d60df2011-01-14 23:41:42 +00006002 break;
Douglas Gregore4ff4b52011-01-05 18:58:31 +00006003 case TemplateArgument::TemplateExpansion:
Richard Smith290d8012016-04-06 17:06:00 +00006004 AddTemplateName(Arg.getAsTemplateOrTemplatePattern());
David Blaikie05785d12013-02-20 22:23:23 +00006005 if (Optional<unsigned> NumExpansions = Arg.getNumTemplateExpansions())
Richard Smith290d8012016-04-06 17:06:00 +00006006 Record->push_back(*NumExpansions + 1);
Douglas Gregore1d60df2011-01-14 23:41:42 +00006007 else
Richard Smith290d8012016-04-06 17:06:00 +00006008 Record->push_back(0);
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00006009 break;
6010 case TemplateArgument::Expression:
6011 AddStmt(Arg.getAsExpr());
6012 break;
6013 case TemplateArgument::Pack:
Richard Smith290d8012016-04-06 17:06:00 +00006014 Record->push_back(Arg.pack_size());
Aaron Ballman2a89e852014-07-15 21:32:31 +00006015 for (const auto &P : Arg.pack_elements())
Richard Smith290d8012016-04-06 17:06:00 +00006016 AddTemplateArgument(P);
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00006017 break;
6018 }
6019}
Argyrios Kyrtzidis818c5db2010-06-23 13:48:30 +00006020
Richard Smithe64e7452016-04-18 21:54:58 +00006021void ASTRecordWriter::AddTemplateParameterList(
6022 const TemplateParameterList *TemplateParams) {
Argyrios Kyrtzidis818c5db2010-06-23 13:48:30 +00006023 assert(TemplateParams && "No TemplateParams!");
Richard Smithe64e7452016-04-18 21:54:58 +00006024 AddSourceLocation(TemplateParams->getTemplateLoc());
6025 AddSourceLocation(TemplateParams->getLAngleLoc());
6026 AddSourceLocation(TemplateParams->getRAngleLoc());
Hubert Tonge4a0c0e2016-07-30 22:33:34 +00006027 // TODO: Concepts
Richard Smithe64e7452016-04-18 21:54:58 +00006028 Record->push_back(TemplateParams->size());
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00006029 for (const auto &P : *TemplateParams)
Richard Smithe64e7452016-04-18 21:54:58 +00006030 AddDeclRef(P);
Argyrios Kyrtzidis818c5db2010-06-23 13:48:30 +00006031}
6032
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00006033/// Emit a template argument list.
Richard Smith290d8012016-04-06 17:06:00 +00006034void ASTRecordWriter::AddTemplateArgumentList(
6035 const TemplateArgumentList *TemplateArgs) {
Argyrios Kyrtzidis818c5db2010-06-23 13:48:30 +00006036 assert(TemplateArgs && "No TemplateArgs!");
Richard Smith290d8012016-04-06 17:06:00 +00006037 Record->push_back(TemplateArgs->size());
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +00006038 for (int i = 0, e = TemplateArgs->size(); i != e; ++i)
Richard Smith290d8012016-04-06 17:06:00 +00006039 AddTemplateArgument(TemplateArgs->get(i));
Argyrios Kyrtzidis818c5db2010-06-23 13:48:30 +00006040}
Argyrios Kyrtzidis2c2167a2010-07-02 11:55:32 +00006041
Richard Smith290d8012016-04-06 17:06:00 +00006042void ASTRecordWriter::AddASTTemplateArgumentListInfo(
6043 const ASTTemplateArgumentListInfo *ASTTemplArgList) {
Enea Zaffanella6dbe1872013-08-10 07:24:53 +00006044 assert(ASTTemplArgList && "No ASTTemplArgList!");
Richard Smith290d8012016-04-06 17:06:00 +00006045 AddSourceLocation(ASTTemplArgList->LAngleLoc);
6046 AddSourceLocation(ASTTemplArgList->RAngleLoc);
6047 Record->push_back(ASTTemplArgList->NumTemplateArgs);
Enea Zaffanella6dbe1872013-08-10 07:24:53 +00006048 const TemplateArgumentLoc *TemplArgs = ASTTemplArgList->getTemplateArgs();
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +00006049 for (int i = 0, e = ASTTemplArgList->NumTemplateArgs; i != e; ++i)
Richard Smith290d8012016-04-06 17:06:00 +00006050 AddTemplateArgumentLoc(TemplArgs[i]);
Enea Zaffanella6dbe1872013-08-10 07:24:53 +00006051}
Argyrios Kyrtzidis2c2167a2010-07-02 11:55:32 +00006052
Richard Smithe64e7452016-04-18 21:54:58 +00006053void ASTRecordWriter::AddUnresolvedSet(const ASTUnresolvedSet &Set) {
6054 Record->push_back(Set.size());
Argyrios Kyrtzidis0f05fb92012-11-28 03:56:16 +00006055 for (ASTUnresolvedSet::const_iterator
Argyrios Kyrtzidis2c2167a2010-07-02 11:55:32 +00006056 I = Set.begin(), E = Set.end(); I != E; ++I) {
Richard Smithe64e7452016-04-18 21:54:58 +00006057 AddDeclRef(I.getDecl());
6058 Record->push_back(I.getAccess());
Argyrios Kyrtzidis2c2167a2010-07-02 11:55:32 +00006059 }
6060}
Argyrios Kyrtzidis3701fcd2010-07-02 23:30:27 +00006061
Richard Smith290d8012016-04-06 17:06:00 +00006062// FIXME: Move this out of the main ASTRecordWriter interface.
6063void ASTRecordWriter::AddCXXBaseSpecifier(const CXXBaseSpecifier &Base) {
6064 Record->push_back(Base.isVirtual());
6065 Record->push_back(Base.isBaseOfClass());
6066 Record->push_back(Base.getAccessSpecifierAsWritten());
6067 Record->push_back(Base.getInheritConstructors());
6068 AddTypeSourceInfo(Base.getTypeSourceInfo());
6069 AddSourceRange(Base.getSourceRange());
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00006070 AddSourceLocation(Base.isPackExpansion()? Base.getEllipsisLoc()
Richard Smith290d8012016-04-06 17:06:00 +00006071 : SourceLocation());
Argyrios Kyrtzidis3701fcd2010-07-02 23:30:27 +00006072}
Sebastian Redl85b2a6a2010-07-14 23:45:08 +00006073
Richard Smith645d2cf2016-04-14 00:29:55 +00006074static uint64_t EmitCXXBaseSpecifiers(ASTWriter &W,
6075 ArrayRef<CXXBaseSpecifier> Bases) {
6076 ASTWriter::RecordData Record;
6077 ASTRecordWriter Writer(W, Record);
6078 Writer.push_back(Bases.size());
Dmitry Polukhin790b5402016-04-06 10:01:46 +00006079
Richard Smith645d2cf2016-04-14 00:29:55 +00006080 for (auto &Base : Bases)
6081 Writer.AddCXXBaseSpecifier(Base);
Richard Smith290d8012016-04-06 17:06:00 +00006082
Richard Smith645d2cf2016-04-14 00:29:55 +00006083 return Writer.Emit(serialization::DECL_CXX_BASE_SPECIFIERS);
Douglas Gregord4c5ed02010-10-29 22:39:52 +00006084}
6085
Richard Smith290d8012016-04-06 17:06:00 +00006086// FIXME: Move this out of the main ASTRecordWriter interface.
Richard Smith645d2cf2016-04-14 00:29:55 +00006087void ASTRecordWriter::AddCXXBaseSpecifiers(ArrayRef<CXXBaseSpecifier> Bases) {
6088 AddOffset(EmitCXXBaseSpecifiers(*Writer, Bases));
6089}
6090
Richard Smithaa165cf2016-04-13 21:57:08 +00006091static uint64_t
6092EmitCXXCtorInitializers(ASTWriter &W,
6093 ArrayRef<CXXCtorInitializer *> CtorInits) {
6094 ASTWriter::RecordData Record;
6095 ASTRecordWriter Writer(W, Record);
6096 Writer.push_back(CtorInits.size());
Argyrios Kyrtzidis5b6a03f2010-08-09 10:54:12 +00006097
Richard Smithaa165cf2016-04-13 21:57:08 +00006098 for (auto *Init : CtorInits) {
Argyrios Kyrtzidis5b6a03f2010-08-09 10:54:12 +00006099 if (Init->isBaseInitializer()) {
Richard Smithaa165cf2016-04-13 21:57:08 +00006100 Writer.push_back(CTOR_INITIALIZER_BASE);
6101 Writer.AddTypeSourceInfo(Init->getTypeSourceInfo());
6102 Writer.push_back(Init->isBaseVirtual());
Alexis Hunt37a477f2011-05-04 01:19:08 +00006103 } else if (Init->isDelegatingInitializer()) {
Richard Smithaa165cf2016-04-13 21:57:08 +00006104 Writer.push_back(CTOR_INITIALIZER_DELEGATING);
6105 Writer.AddTypeSourceInfo(Init->getTypeSourceInfo());
Alexis Hunt37a477f2011-05-04 01:19:08 +00006106 } else if (Init->isMemberInitializer()){
Richard Smithaa165cf2016-04-13 21:57:08 +00006107 Writer.push_back(CTOR_INITIALIZER_MEMBER);
6108 Writer.AddDeclRef(Init->getMember());
Argyrios Kyrtzidis5b6a03f2010-08-09 10:54:12 +00006109 } else {
Richard Smithaa165cf2016-04-13 21:57:08 +00006110 Writer.push_back(CTOR_INITIALIZER_INDIRECT_MEMBER);
6111 Writer.AddDeclRef(Init->getIndirectMember());
Argyrios Kyrtzidis5b6a03f2010-08-09 10:54:12 +00006112 }
Francois Pichetd583da02010-12-04 09:14:42 +00006113
Richard Smithaa165cf2016-04-13 21:57:08 +00006114 Writer.AddSourceLocation(Init->getMemberLocation());
6115 Writer.AddStmt(Init->getInit());
6116 Writer.AddSourceLocation(Init->getLParenLoc());
6117 Writer.AddSourceLocation(Init->getRParenLoc());
6118 Writer.push_back(Init->isWritten());
Richard Smith30e304e2016-12-14 00:03:17 +00006119 if (Init->isWritten())
Richard Smithaa165cf2016-04-13 21:57:08 +00006120 Writer.push_back(Init->getSourceOrder());
Argyrios Kyrtzidis5b6a03f2010-08-09 10:54:12 +00006121 }
Richard Smithaa165cf2016-04-13 21:57:08 +00006122
6123 return Writer.Emit(serialization::DECL_CXX_CTOR_INITIALIZERS);
Argyrios Kyrtzidis5b6a03f2010-08-09 10:54:12 +00006124}
6125
Richard Smithaa165cf2016-04-13 21:57:08 +00006126// FIXME: Move this out of the main ASTRecordWriter interface.
6127void ASTRecordWriter::AddCXXCtorInitializers(
6128 ArrayRef<CXXCtorInitializer *> CtorInits) {
6129 AddOffset(EmitCXXCtorInitializers(*Writer, CtorInits));
Richard Smithc2bb8182015-03-24 06:36:48 +00006130}
6131
Richard Smith290d8012016-04-06 17:06:00 +00006132void ASTRecordWriter::AddCXXDefinitionData(const CXXRecordDecl *D) {
Richard Smith053f6c62014-05-16 23:01:30 +00006133 auto &Data = D->data();
Richard Smith290d8012016-04-06 17:06:00 +00006134 Record->push_back(Data.IsLambda);
6135 Record->push_back(Data.UserDeclaredConstructor);
6136 Record->push_back(Data.UserDeclaredSpecialMembers);
6137 Record->push_back(Data.Aggregate);
6138 Record->push_back(Data.PlainOldData);
6139 Record->push_back(Data.Empty);
6140 Record->push_back(Data.Polymorphic);
6141 Record->push_back(Data.Abstract);
6142 Record->push_back(Data.IsStandardLayout);
Richard Smithb6070db2018-04-05 18:55:37 +00006143 Record->push_back(Data.IsCXX11StandardLayout);
6144 Record->push_back(Data.HasBasesWithFields);
6145 Record->push_back(Data.HasBasesWithNonStaticDataMembers);
Richard Smith290d8012016-04-06 17:06:00 +00006146 Record->push_back(Data.HasPrivateFields);
6147 Record->push_back(Data.HasProtectedFields);
6148 Record->push_back(Data.HasPublicFields);
6149 Record->push_back(Data.HasMutableFields);
6150 Record->push_back(Data.HasVariantMembers);
6151 Record->push_back(Data.HasOnlyCMembers);
6152 Record->push_back(Data.HasInClassInitializer);
6153 Record->push_back(Data.HasUninitializedReferenceMember);
6154 Record->push_back(Data.HasUninitializedFields);
Richard Smith12e79312016-05-13 06:47:56 +00006155 Record->push_back(Data.HasInheritedConstructor);
6156 Record->push_back(Data.HasInheritedAssignment);
Richard Smith96cd6712017-08-16 01:49:53 +00006157 Record->push_back(Data.NeedOverloadResolutionForCopyConstructor);
Richard Smith290d8012016-04-06 17:06:00 +00006158 Record->push_back(Data.NeedOverloadResolutionForMoveConstructor);
6159 Record->push_back(Data.NeedOverloadResolutionForMoveAssignment);
6160 Record->push_back(Data.NeedOverloadResolutionForDestructor);
Richard Smith96cd6712017-08-16 01:49:53 +00006161 Record->push_back(Data.DefaultedCopyConstructorIsDeleted);
Richard Smith290d8012016-04-06 17:06:00 +00006162 Record->push_back(Data.DefaultedMoveConstructorIsDeleted);
6163 Record->push_back(Data.DefaultedMoveAssignmentIsDeleted);
6164 Record->push_back(Data.DefaultedDestructorIsDeleted);
6165 Record->push_back(Data.HasTrivialSpecialMembers);
Akira Hatanaka02914dc2018-02-05 20:23:22 +00006166 Record->push_back(Data.HasTrivialSpecialMembersForCall);
Richard Smith290d8012016-04-06 17:06:00 +00006167 Record->push_back(Data.DeclaredNonTrivialSpecialMembers);
Akira Hatanaka02914dc2018-02-05 20:23:22 +00006168 Record->push_back(Data.DeclaredNonTrivialSpecialMembersForCall);
Richard Smith290d8012016-04-06 17:06:00 +00006169 Record->push_back(Data.HasIrrelevantDestructor);
6170 Record->push_back(Data.HasConstexprNonCopyMoveConstructor);
6171 Record->push_back(Data.HasDefaultedDefaultConstructor);
6172 Record->push_back(Data.DefaultedDefaultConstructorIsConstexpr);
6173 Record->push_back(Data.HasConstexprDefaultConstructor);
6174 Record->push_back(Data.HasNonLiteralTypeFieldsOrBases);
6175 Record->push_back(Data.ComputedVisibleConversions);
6176 Record->push_back(Data.UserProvidedDefaultConstructor);
6177 Record->push_back(Data.DeclaredSpecialMembers);
Richard Smithdf054d32017-02-25 23:53:05 +00006178 Record->push_back(Data.ImplicitCopyConstructorCanHaveConstParamForVBase);
6179 Record->push_back(Data.ImplicitCopyConstructorCanHaveConstParamForNonVBase);
Richard Smith290d8012016-04-06 17:06:00 +00006180 Record->push_back(Data.ImplicitCopyAssignmentHasConstParam);
6181 Record->push_back(Data.HasDeclaredCopyConstructorWithConstParam);
6182 Record->push_back(Data.HasDeclaredCopyAssignmentWithConstParam);
Richard Trieufd1acbb2017-04-11 21:31:00 +00006183
6184 // getODRHash will compute the ODRHash if it has not been previously computed.
6185 Record->push_back(D->getODRHash());
David Blaikief63556d2017-04-12 20:58:33 +00006186 bool ModulesDebugInfo = Writer->Context->getLangOpts().ModulesDebugInfo &&
6187 Writer->WritingModule && !D->isDependentType();
6188 Record->push_back(ModulesDebugInfo);
6189 if (ModulesDebugInfo)
David Blaikie1ac9c982017-04-11 21:13:37 +00006190 Writer->ModularCodegenDecls.push_back(Writer->GetDeclRef(D));
6191
Richard Smith561fb152012-02-25 07:33:38 +00006192 // IsLambda bit is already saved.
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00006193
Richard Smith290d8012016-04-06 17:06:00 +00006194 Record->push_back(Data.NumBases);
Douglas Gregord4c5ed02010-10-29 22:39:52 +00006195 if (Data.NumBases > 0)
Richard Smith645d2cf2016-04-14 00:29:55 +00006196 AddCXXBaseSpecifiers(Data.bases());
6197
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00006198 // FIXME: Make VBases lazily computed when needed to avoid storing them.
Richard Smith290d8012016-04-06 17:06:00 +00006199 Record->push_back(Data.NumVBases);
Douglas Gregord4c5ed02010-10-29 22:39:52 +00006200 if (Data.NumVBases > 0)
Richard Smith645d2cf2016-04-14 00:29:55 +00006201 AddCXXBaseSpecifiers(Data.vbases());
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00006202
Richard Smith290d8012016-04-06 17:06:00 +00006203 AddUnresolvedSet(Data.Conversions.get(*Writer->Context));
6204 AddUnresolvedSet(Data.VisibleConversions.get(*Writer->Context));
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00006205 // Data.Definition is the owning decl, no need to write it.
Richard Smith290d8012016-04-06 17:06:00 +00006206 AddDeclRef(D->getFirstFriend());
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00006207
Douglas Gregor99ae8062012-02-14 17:54:36 +00006208 // Add lambda-specific data.
6209 if (Data.IsLambda) {
Richard Smith053f6c62014-05-16 23:01:30 +00006210 auto &Lambda = D->getLambdaData();
Richard Smith290d8012016-04-06 17:06:00 +00006211 Record->push_back(Lambda.Dependent);
6212 Record->push_back(Lambda.IsGenericLambda);
6213 Record->push_back(Lambda.CaptureDefault);
6214 Record->push_back(Lambda.NumCaptures);
6215 Record->push_back(Lambda.NumExplicitCaptures);
6216 Record->push_back(Lambda.ManglingNumber);
Richard Smith0bae6242016-08-25 00:34:00 +00006217 AddDeclRef(D->getLambdaContextDecl());
Richard Smith290d8012016-04-06 17:06:00 +00006218 AddTypeSourceInfo(Lambda.MethodTyInfo);
Douglas Gregor99ae8062012-02-14 17:54:36 +00006219 for (unsigned I = 0, N = Lambda.NumCaptures; I != N; ++I) {
Benjamin Kramerf3ca26982014-05-10 16:31:55 +00006220 const LambdaCapture &Capture = Lambda.Captures[I];
Richard Smith290d8012016-04-06 17:06:00 +00006221 AddSourceLocation(Capture.getLocation());
6222 Record->push_back(Capture.isImplicit());
6223 Record->push_back(Capture.getCaptureKind());
Richard Smithba71c082013-05-16 06:20:58 +00006224 switch (Capture.getCaptureKind()) {
Faisal Validc6b5962016-03-21 09:25:37 +00006225 case LCK_StarThis:
Richard Smithba71c082013-05-16 06:20:58 +00006226 case LCK_This:
Alexey Bataev39c81e22014-08-28 04:28:19 +00006227 case LCK_VLAType:
Richard Smithba71c082013-05-16 06:20:58 +00006228 break;
6229 case LCK_ByCopy:
Richard Smithbb13c9a2013-09-28 04:02:39 +00006230 case LCK_ByRef:
Richard Smithba71c082013-05-16 06:20:58 +00006231 VarDecl *Var =
Craig Toppera13603a2014-05-22 05:54:18 +00006232 Capture.capturesVariable() ? Capture.getCapturedVar() : nullptr;
Richard Smith290d8012016-04-06 17:06:00 +00006233 AddDeclRef(Var);
Richard Smithba71c082013-05-16 06:20:58 +00006234 AddSourceLocation(Capture.isPackExpansion() ? Capture.getEllipsisLoc()
Richard Smith290d8012016-04-06 17:06:00 +00006235 : SourceLocation());
Richard Smithba71c082013-05-16 06:20:58 +00006236 break;
6237 }
Douglas Gregor99ae8062012-02-14 17:54:36 +00006238 }
6239 }
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00006240}
6241
Argyrios Kyrtzidis65ad5692010-10-24 17:26:36 +00006242void ASTWriter::ReaderInitialized(ASTReader *Reader) {
Sebastian Redl07a89a82010-07-30 00:29:29 +00006243 assert(Reader && "Cannot remove chain");
Douglas Gregordf0c1512011-08-18 04:12:04 +00006244 assert((!Chain || Chain == Reader) && "Cannot replace chain");
Sebastian Redl07a89a82010-07-30 00:29:29 +00006245 assert(FirstDeclID == NextDeclID &&
6246 FirstTypeID == NextTypeID &&
6247 FirstIdentID == NextIdentID &&
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00006248 FirstMacroID == NextMacroID &&
Douglas Gregor253eefe2011-12-01 00:59:36 +00006249 FirstSubmoduleID == NextSubmoduleID &&
Sebastian Redld95a56e2010-08-04 18:21:41 +00006250 FirstSelectorID == NextSelectorID &&
Sebastian Redl07a89a82010-07-30 00:29:29 +00006251 "Setting chain after writing has started.");
Douglas Gregor925296b2011-07-19 16:10:42 +00006252
Sebastian Redl07a89a82010-07-30 00:29:29 +00006253 Chain = Reader;
Argyrios Kyrtzidis65ad5692010-10-24 17:26:36 +00006254
Richard Smith7f330cd2015-03-18 01:42:29 +00006255 // Note, this will get called multiple times, once one the reader starts up
6256 // and again each time it's done reading a PCH or module.
Douglas Gregordf0c1512011-08-18 04:12:04 +00006257 FirstDeclID = NUM_PREDEF_DECL_IDS + Chain->getTotalNumDecls();
6258 FirstTypeID = NUM_PREDEF_TYPE_IDS + Chain->getTotalNumTypes();
6259 FirstIdentID = NUM_PREDEF_IDENT_IDS + Chain->getTotalNumIdentifiers();
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00006260 FirstMacroID = NUM_PREDEF_MACRO_IDS + Chain->getTotalNumMacros();
Douglas Gregor253eefe2011-12-01 00:59:36 +00006261 FirstSubmoduleID = NUM_PREDEF_SUBMODULE_IDS + Chain->getTotalNumSubmodules();
Douglas Gregordf0c1512011-08-18 04:12:04 +00006262 FirstSelectorID = NUM_PREDEF_SELECTOR_IDS + Chain->getTotalNumSelectors();
Argyrios Kyrtzidis65ad5692010-10-24 17:26:36 +00006263 NextDeclID = FirstDeclID;
6264 NextTypeID = FirstTypeID;
6265 NextIdentID = FirstIdentID;
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00006266 NextMacroID = FirstMacroID;
Argyrios Kyrtzidis65ad5692010-10-24 17:26:36 +00006267 NextSelectorID = FirstSelectorID;
Douglas Gregor253eefe2011-12-01 00:59:36 +00006268 NextSubmoduleID = FirstSubmoduleID;
Sebastian Redl07a89a82010-07-30 00:29:29 +00006269}
6270
Sebastian Redl539c5062010-08-18 23:57:32 +00006271void ASTWriter::IdentifierRead(IdentID ID, IdentifierInfo *II) {
Douglas Gregor8d7edce2013-02-08 21:30:59 +00006272 // Always keep the highest ID. See \p TypeRead() for more information.
6273 IdentID &StoredID = IdentifierIDs[II];
6274 if (ID > StoredID)
6275 StoredID = ID;
Sebastian Redlff4a2952010-07-23 23:49:55 +00006276}
6277
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00006278void ASTWriter::MacroRead(serialization::MacroID ID, MacroInfo *MI) {
Douglas Gregor8d7edce2013-02-08 21:30:59 +00006279 // Always keep the highest ID. See \p TypeRead() for more information.
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00006280 MacroID &StoredID = MacroIDs[MI];
Douglas Gregor8d7edce2013-02-08 21:30:59 +00006281 if (ID > StoredID)
6282 StoredID = ID;
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00006283}
6284
Argyrios Kyrtzidisbb5c7eae2010-08-20 16:03:59 +00006285void ASTWriter::TypeRead(TypeIdx Idx, QualType T) {
Douglas Gregor9b3932c2010-10-05 18:37:06 +00006286 // Always take the highest-numbered type index. This copes with an interesting
6287 // case for chained AST writing where we schedule writing the type and then,
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00006288 // later, deserialize the type from another AST. In this case, we want to
Douglas Gregor9b3932c2010-10-05 18:37:06 +00006289 // keep the higher-numbered entry so that we can properly write it out to
6290 // the AST file.
6291 TypeIdx &StoredIdx = TypeIdxs[T];
6292 if (Idx.getIndex() >= StoredIdx.getIndex())
6293 StoredIdx = Idx;
Sebastian Redl85b2a6a2010-07-14 23:45:08 +00006294}
6295
Sebastian Redl539c5062010-08-18 23:57:32 +00006296void ASTWriter::SelectorRead(SelectorID ID, Selector S) {
Douglas Gregor8d7edce2013-02-08 21:30:59 +00006297 // Always keep the highest ID. See \p TypeRead() for more information.
6298 SelectorID &StoredID = SelectorIDs[S];
6299 if (ID > StoredID)
6300 StoredID = ID;
Sebastian Redl834bb972010-08-04 17:20:04 +00006301}
Douglas Gregor91096292010-10-02 19:29:26 +00006302
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00006303void ASTWriter::MacroDefinitionRead(serialization::PreprocessedEntityID ID,
Richard Smith66a81862015-05-04 02:25:31 +00006304 MacroDefinitionRecord *MD) {
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00006305 assert(MacroDefinitions.find(MD) == MacroDefinitions.end());
Douglas Gregor91096292010-10-02 19:29:26 +00006306 MacroDefinitions[MD] = ID;
6307}
Argyrios Kyrtzidisd170d842010-10-24 17:26:50 +00006308
Douglas Gregore37a85a2011-12-02 17:30:13 +00006309void ASTWriter::ModuleRead(serialization::SubmoduleID ID, Module *Mod) {
6310 assert(SubmoduleIDs.find(Mod) == SubmoduleIDs.end());
6311 SubmoduleIDs[Mod] = ID;
6312}
6313
Argyrios Kyrtzidisd170d842010-10-24 17:26:50 +00006314void ASTWriter::CompletedTagDefinition(const TagDecl *D) {
Vassil Vassilev19765fb2016-07-22 21:08:24 +00006315 if (Chain && Chain->isProcessingUpdateRecords()) return;
John McCallf937c022011-10-07 06:10:15 +00006316 assert(D->isCompleteDefinition());
Douglas Gregor2fd3d402011-09-17 00:05:03 +00006317 assert(!WritingAST && "Already writing the AST!");
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00006318 if (auto *RD = dyn_cast<CXXRecordDecl>(D)) {
Argyrios Kyrtzidisd170d842010-10-24 17:26:50 +00006319 // We are interested when a PCH decl is modified.
Douglas Gregorb3722e22011-09-09 23:01:35 +00006320 if (RD->isFromASTFile()) {
Argyrios Kyrtzidisd170d842010-10-24 17:26:50 +00006321 // A forward reference was mutated into a definition. Rewrite it.
6322 // FIXME: This happens during template instantiation, should we
6323 // have created a new definition decl instead ?
Richard Smithcd45dbc2014-04-19 03:48:30 +00006324 assert(isTemplateInstantiation(RD->getTemplateSpecializationKind()) &&
6325 "completed a tag from another module but not by instantiation?");
6326 DeclUpdates[RD].push_back(
6327 DeclUpdate(UPD_CXX_INSTANTIATED_CLASS_DEFINITION));
Argyrios Kyrtzidisd170d842010-10-24 17:26:50 +00006328 }
Argyrios Kyrtzidisd170d842010-10-24 17:26:50 +00006329 }
6330}
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00006331
Richard Smithf983f7f2015-10-13 00:23:25 +00006332static bool isImportedDeclContext(ASTReader *Chain, const Decl *D) {
6333 if (D->isFromASTFile())
6334 return true;
6335
Richard Smithf983f7f2015-10-13 00:23:25 +00006336 // The predefined __va_list_tag struct is imported if we imported any decls.
6337 // FIXME: This is a gross hack.
6338 return D == D->getASTContext().getVaListTagDecl();
6339}
6340
Argyrios Kyrtzidis01c2df42010-10-28 07:38:51 +00006341void ASTWriter::AddedVisibleDecl(const DeclContext *DC, const Decl *D) {
Vassil Vassilev19765fb2016-07-22 21:08:24 +00006342 if (Chain && Chain->isProcessingUpdateRecords()) return;
6343 assert(DC->isLookupContext() &&
Vassil Vassilev71eafde2016-04-06 20:56:03 +00006344 "Should not add lookup results to non-lookup contexts!");
6345
Vassil Vassilev632eac32016-03-16 11:17:04 +00006346 // TU is handled elsewhere.
6347 if (isa<TranslationUnitDecl>(DC))
6348 return;
6349
6350 // Namespaces are handled elsewhere, except for template instantiations of
6351 // FunctionTemplateDecls in namespaces. We are interested in cases where the
6352 // local instantiations are added to an imported context. Only happens when
6353 // adding ADL lookup candidates, for example templated friends.
6354 if (isa<NamespaceDecl>(DC) && D->getFriendObjectKind() == Decl::FOK_None &&
6355 !isa<FunctionTemplateDecl>(D))
Argyrios Kyrtzidis01c2df42010-10-28 07:38:51 +00006356 return;
6357
Richard Smithf983f7f2015-10-13 00:23:25 +00006358 // We're only interested in cases where a local declaration is added to an
6359 // imported context.
6360 if (D->isFromASTFile() || !isImportedDeclContext(Chain, cast<Decl>(DC)))
6361 return;
Argyrios Kyrtzidis01c2df42010-10-28 07:38:51 +00006362
Richard Smith0f4e2c42015-08-06 04:23:48 +00006363 assert(DC == DC->getPrimaryContext() && "added to non-primary context");
Douglas Gregor9f782892013-01-21 15:25:38 +00006364 assert(!getDefinitiveDeclContext(DC) && "DeclContext not definitive!");
Richard Smithe9a8bc32014-09-30 00:45:29 +00006365 assert(!WritingAST && "Already writing the AST!");
Richard Smithf983f7f2015-10-13 00:23:25 +00006366 if (UpdatedDeclContexts.insert(DC) && !cast<Decl>(DC)->isFromASTFile()) {
6367 // We're adding a visible declaration to a predefined decl context. Ensure
6368 // that we write out all of its lookup results so we don't get a nasty
6369 // surprise when we try to emit its lookup table.
6370 for (auto *Child : DC->decls())
Richard Smithc26d9742016-10-06 20:30:51 +00006371 DeclsToEmitEvenIfUnreferenced.push_back(Child);
Richard Smithf983f7f2015-10-13 00:23:25 +00006372 }
Richard Smithc26d9742016-10-06 20:30:51 +00006373 DeclsToEmitEvenIfUnreferenced.push_back(D);
Argyrios Kyrtzidis01c2df42010-10-28 07:38:51 +00006374}
Argyrios Kyrtzidise16a5302010-10-24 17:26:54 +00006375
6376void ASTWriter::AddedCXXImplicitMember(const CXXRecordDecl *RD, const Decl *D) {
Vassil Vassilev19765fb2016-07-22 21:08:24 +00006377 if (Chain && Chain->isProcessingUpdateRecords()) return;
Argyrios Kyrtzidise16a5302010-10-24 17:26:54 +00006378 assert(D->isImplicit());
Richard Smithf983f7f2015-10-13 00:23:25 +00006379
6380 // We're only interested in cases where a local declaration is added to an
6381 // imported context.
6382 if (D->isFromASTFile() || !isImportedDeclContext(Chain, RD))
6383 return;
6384
Argyrios Kyrtzidise16a5302010-10-24 17:26:54 +00006385 if (!isa<CXXMethodDecl>(D))
Richard Smithf983f7f2015-10-13 00:23:25 +00006386 return;
Argyrios Kyrtzidise16a5302010-10-24 17:26:54 +00006387
6388 // A decl coming from PCH was modified.
John McCallf937c022011-10-07 06:10:15 +00006389 assert(RD->isCompleteDefinition());
Richard Smithe9a8bc32014-09-30 00:45:29 +00006390 assert(!WritingAST && "Already writing the AST!");
Aaron Ballman4f45b712014-03-21 15:22:56 +00006391 DeclUpdates[RD].push_back(DeclUpdate(UPD_CXX_ADDED_IMPLICIT_MEMBER, D));
Argyrios Kyrtzidise16a5302010-10-24 17:26:54 +00006392}
Argyrios Kyrtzidis402dbbb2010-10-28 07:38:42 +00006393
Richard Smith564417a2014-03-20 21:47:22 +00006394void ASTWriter::ResolvedExceptionSpec(const FunctionDecl *FD) {
Vassil Vassilev19765fb2016-07-22 21:08:24 +00006395 if (Chain && Chain->isProcessingUpdateRecords()) return;
Richard Smith9e2341d2015-03-23 03:25:59 +00006396 assert(!DoneWritingDeclsAndTypes && "Already done writing updates!");
6397 if (!Chain) return;
Richard Smith5fc18a92015-07-12 23:43:21 +00006398 Chain->forEachImportedKeyDecl(FD, [&](const Decl *D) {
Richard Smith9e2341d2015-03-23 03:25:59 +00006399 // If we don't already know the exception specification for this redecl
6400 // chain, add an update record for it.
6401 if (isUnresolvedExceptionSpec(cast<FunctionDecl>(D)
6402 ->getType()
6403 ->castAs<FunctionProtoType>()
6404 ->getExceptionSpecType()))
6405 DeclUpdates[D].push_back(UPD_CXX_RESOLVED_EXCEPTION_SPEC);
6406 });
Richard Smith564417a2014-03-20 21:47:22 +00006407}
6408
Richard Smith1fa5d642013-05-11 05:45:24 +00006409void ASTWriter::DeducedReturnType(const FunctionDecl *FD, QualType ReturnType) {
Vassil Vassilev19765fb2016-07-22 21:08:24 +00006410 if (Chain && Chain->isProcessingUpdateRecords()) return;
Richard Smith1fa5d642013-05-11 05:45:24 +00006411 assert(!WritingAST && "Already writing the AST!");
Richard Smith9e2341d2015-03-23 03:25:59 +00006412 if (!Chain) return;
Richard Smith5fc18a92015-07-12 23:43:21 +00006413 Chain->forEachImportedKeyDecl(FD, [&](const Decl *D) {
Richard Smith9e2341d2015-03-23 03:25:59 +00006414 DeclUpdates[D].push_back(
6415 DeclUpdate(UPD_CXX_DEDUCED_RETURN_TYPE, ReturnType));
6416 });
Richard Smith1fa5d642013-05-11 05:45:24 +00006417}
6418
Richard Smithf8134002015-03-10 01:41:22 +00006419void ASTWriter::ResolvedOperatorDelete(const CXXDestructorDecl *DD,
Richard Smith5b349582017-10-13 01:55:36 +00006420 const FunctionDecl *Delete,
6421 Expr *ThisArg) {
Vassil Vassilev19765fb2016-07-22 21:08:24 +00006422 if (Chain && Chain->isProcessingUpdateRecords()) return;
Richard Smithf8134002015-03-10 01:41:22 +00006423 assert(!WritingAST && "Already writing the AST!");
6424 assert(Delete && "Not given an operator delete");
Richard Smith9e2341d2015-03-23 03:25:59 +00006425 if (!Chain) return;
Richard Smith5fc18a92015-07-12 23:43:21 +00006426 Chain->forEachImportedKeyDecl(DD, [&](const Decl *D) {
Richard Smith9e2341d2015-03-23 03:25:59 +00006427 DeclUpdates[D].push_back(DeclUpdate(UPD_CXX_RESOLVED_DTOR_DELETE, Delete));
6428 });
Richard Smithf8134002015-03-10 01:41:22 +00006429}
6430
Sebastian Redlab238a72011-04-24 16:28:06 +00006431void ASTWriter::CompletedImplicitDefinition(const FunctionDecl *D) {
Vassil Vassilev19765fb2016-07-22 21:08:24 +00006432 if (Chain && Chain->isProcessingUpdateRecords()) return;
Douglas Gregor2fd3d402011-09-17 00:05:03 +00006433 assert(!WritingAST && "Already writing the AST!");
Douglas Gregorb3722e22011-09-09 23:01:35 +00006434 if (!D->isFromASTFile())
Sebastian Redlab238a72011-04-24 16:28:06 +00006435 return; // Declaration not imported from PCH.
6436
Richard Smith4d235792014-08-07 18:53:08 +00006437 // Implicit function decl from a PCH was defined.
6438 DeclUpdates[D].push_back(DeclUpdate(UPD_CXX_ADDED_FUNCTION_DEFINITION));
Sebastian Redlab238a72011-04-24 16:28:06 +00006439}
6440
Richard Smith891fc7f2017-12-05 01:31:47 +00006441void ASTWriter::VariableDefinitionInstantiated(const VarDecl *D) {
6442 if (Chain && Chain->isProcessingUpdateRecords()) return;
6443 assert(!WritingAST && "Already writing the AST!");
6444 if (!D->isFromASTFile())
6445 return;
6446
6447 DeclUpdates[D].push_back(DeclUpdate(UPD_CXX_ADDED_VAR_DEFINITION));
6448}
6449
Richard Smithd28ac5b2014-03-22 23:33:22 +00006450void ASTWriter::FunctionDefinitionInstantiated(const FunctionDecl *D) {
Vassil Vassilev19765fb2016-07-22 21:08:24 +00006451 if (Chain && Chain->isProcessingUpdateRecords()) return;
Richard Smithd28ac5b2014-03-22 23:33:22 +00006452 assert(!WritingAST && "Already writing the AST!");
6453 if (!D->isFromASTFile())
6454 return;
6455
Richard Smith9e2341d2015-03-23 03:25:59 +00006456 DeclUpdates[D].push_back(DeclUpdate(UPD_CXX_ADDED_FUNCTION_DEFINITION));
Richard Smithd28ac5b2014-03-22 23:33:22 +00006457}
6458
Richard Smith891fc7f2017-12-05 01:31:47 +00006459void ASTWriter::InstantiationRequested(const ValueDecl *D) {
Vassil Vassilev19765fb2016-07-22 21:08:24 +00006460 if (Chain && Chain->isProcessingUpdateRecords()) return;
Douglas Gregor2fd3d402011-09-17 00:05:03 +00006461 assert(!WritingAST && "Already writing the AST!");
Douglas Gregorb3722e22011-09-09 23:01:35 +00006462 if (!D->isFromASTFile())
Sebastian Redl2ac2c722011-04-29 08:19:30 +00006463 return;
6464
6465 // Since the actual instantiation is delayed, this really means that we need
6466 // to update the instantiation location.
Richard Smith891fc7f2017-12-05 01:31:47 +00006467 SourceLocation POI;
6468 if (auto *VD = dyn_cast<VarDecl>(D))
6469 POI = VD->getPointOfInstantiation();
6470 else
6471 POI = cast<FunctionDecl>(D)->getPointOfInstantiation();
6472 DeclUpdates[D].push_back(DeclUpdate(UPD_CXX_POINT_OF_INSTANTIATION, POI));
Sebastian Redl2ac2c722011-04-29 08:19:30 +00006473}
6474
John McCall32791cc2016-01-06 22:34:54 +00006475void ASTWriter::DefaultArgumentInstantiated(const ParmVarDecl *D) {
Vassil Vassilev19765fb2016-07-22 21:08:24 +00006476 if (Chain && Chain->isProcessingUpdateRecords()) return;
John McCall32791cc2016-01-06 22:34:54 +00006477 assert(!WritingAST && "Already writing the AST!");
6478 if (!D->isFromASTFile())
6479 return;
6480
6481 DeclUpdates[D].push_back(
6482 DeclUpdate(UPD_CXX_INSTANTIATED_DEFAULT_ARGUMENT, D));
6483}
6484
Richard Smith4b054b22016-08-24 21:25:37 +00006485void ASTWriter::DefaultMemberInitializerInstantiated(const FieldDecl *D) {
6486 assert(!WritingAST && "Already writing the AST!");
6487 if (!D->isFromASTFile())
6488 return;
6489
6490 DeclUpdates[D].push_back(
6491 DeclUpdate(UPD_CXX_INSTANTIATED_DEFAULT_MEMBER_INITIALIZER, D));
6492}
6493
Argyrios Kyrtzidis7d847c92011-09-01 00:58:55 +00006494void ASTWriter::AddedObjCCategoryToInterface(const ObjCCategoryDecl *CatD,
6495 const ObjCInterfaceDecl *IFD) {
Vassil Vassilev19765fb2016-07-22 21:08:24 +00006496 if (Chain && Chain->isProcessingUpdateRecords()) return;
Douglas Gregor2fd3d402011-09-17 00:05:03 +00006497 assert(!WritingAST && "Already writing the AST!");
Douglas Gregorb3722e22011-09-09 23:01:35 +00006498 if (!IFD->isFromASTFile())
Argyrios Kyrtzidis7d847c92011-09-01 00:58:55 +00006499 return; // Declaration not imported from PCH.
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00006500
Douglas Gregor404cdde2012-01-27 01:47:08 +00006501 assert(IFD->getDefinition() && "Category on a class without a definition?");
6502 ObjCClassesWithCategories.insert(
6503 const_cast<ObjCInterfaceDecl *>(IFD->getDefinition()));
Argyrios Kyrtzidis7d847c92011-09-01 00:58:55 +00006504}
Argyrios Kyrtzidisb97a4022011-11-12 21:07:46 +00006505
Eli Friedman276dd182013-09-05 00:02:25 +00006506void ASTWriter::DeclarationMarkedUsed(const Decl *D) {
Vassil Vassilev19765fb2016-07-22 21:08:24 +00006507 if (Chain && Chain->isProcessingUpdateRecords()) return;
Eli Friedman276dd182013-09-05 00:02:25 +00006508 assert(!WritingAST && "Already writing the AST!");
Vassil Vassilev928c8252016-04-28 14:13:28 +00006509
6510 // If there is *any* declaration of the entity that's not from an AST file,
6511 // we can skip writing the update record. We make sure that isUsed() triggers
6512 // completion of the redeclaration chain of the entity.
6513 for (auto Prev = D->getMostRecentDecl(); Prev; Prev = Prev->getPreviousDecl())
6514 if (IsLocalDecl(Prev))
6515 return;
Eli Friedman276dd182013-09-05 00:02:25 +00006516
Aaron Ballman4f45b712014-03-21 15:22:56 +00006517 DeclUpdates[D].push_back(DeclUpdate(UPD_DECL_MARKED_USED));
Eli Friedman276dd182013-09-05 00:02:25 +00006518}
Alexey Bataev97720002014-11-11 04:05:39 +00006519
6520void ASTWriter::DeclarationMarkedOpenMPThreadPrivate(const Decl *D) {
Vassil Vassilev19765fb2016-07-22 21:08:24 +00006521 if (Chain && Chain->isProcessingUpdateRecords()) return;
Alexey Bataev97720002014-11-11 04:05:39 +00006522 assert(!WritingAST && "Already writing the AST!");
6523 if (!D->isFromASTFile())
6524 return;
6525
6526 DeclUpdates[D].push_back(DeclUpdate(UPD_DECL_MARKED_OPENMP_THREADPRIVATE));
6527}
Richard Smith65ebb4a2015-03-26 04:09:53 +00006528
Alexey Bataev25ed0c02019-03-07 17:54:44 +00006529void ASTWriter::DeclarationMarkedOpenMPAllocate(const Decl *D, const Attr *A) {
6530 if (Chain && Chain->isProcessingUpdateRecords()) return;
6531 assert(!WritingAST && "Already writing the AST!");
6532 if (!D->isFromASTFile())
6533 return;
6534
6535 DeclUpdates[D].push_back(DeclUpdate(UPD_DECL_MARKED_OPENMP_ALLOCATE, A));
6536}
6537
Dmitry Polukhind69b5052016-05-09 14:59:13 +00006538void ASTWriter::DeclarationMarkedOpenMPDeclareTarget(const Decl *D,
6539 const Attr *Attr) {
Vassil Vassilev19765fb2016-07-22 21:08:24 +00006540 if (Chain && Chain->isProcessingUpdateRecords()) return;
Dmitry Polukhin0b0da292016-04-06 11:38:59 +00006541 assert(!WritingAST && "Already writing the AST!");
6542 if (!D->isFromASTFile())
6543 return;
6544
Dmitry Polukhind69b5052016-05-09 14:59:13 +00006545 DeclUpdates[D].push_back(
6546 DeclUpdate(UPD_DECL_MARKED_OPENMP_DECLARETARGET, Attr));
Dmitry Polukhin0b0da292016-04-06 11:38:59 +00006547}
6548
Richard Smith4caa4492015-05-15 02:34:32 +00006549void ASTWriter::RedefinedHiddenDefinition(const NamedDecl *D, Module *M) {
Vassil Vassilev19765fb2016-07-22 21:08:24 +00006550 if (Chain && Chain->isProcessingUpdateRecords()) return;
Richard Smith65ebb4a2015-03-26 04:09:53 +00006551 assert(!WritingAST && "Already writing the AST!");
6552 assert(D->isHidden() && "expected a hidden declaration");
Richard Smith4caa4492015-05-15 02:34:32 +00006553 DeclUpdates[D].push_back(DeclUpdate(UPD_DECL_EXPORTED, M));
Richard Smith65ebb4a2015-03-26 04:09:53 +00006554}
Alex Denisovfde64952015-06-26 05:28:36 +00006555
6556void ASTWriter::AddedAttributeToRecord(const Attr *Attr,
6557 const RecordDecl *Record) {
Vassil Vassilev19765fb2016-07-22 21:08:24 +00006558 if (Chain && Chain->isProcessingUpdateRecords()) return;
Alex Denisovfde64952015-06-26 05:28:36 +00006559 assert(!WritingAST && "Already writing the AST!");
6560 if (!Record->isFromASTFile())
6561 return;
6562 DeclUpdates[Record].push_back(DeclUpdate(UPD_ADDED_ATTR_TO_RECORD, Attr));
6563}
Richard Smithc26d9742016-10-06 20:30:51 +00006564
6565void ASTWriter::AddedCXXTemplateSpecialization(
6566 const ClassTemplateDecl *TD, const ClassTemplateSpecializationDecl *D) {
6567 assert(!WritingAST && "Already writing the AST!");
6568
6569 if (!TD->getFirstDecl()->isFromASTFile())
6570 return;
6571 if (Chain && Chain->isProcessingUpdateRecords())
6572 return;
6573
6574 DeclsToEmitEvenIfUnreferenced.push_back(D);
6575}
6576
6577void ASTWriter::AddedCXXTemplateSpecialization(
6578 const VarTemplateDecl *TD, const VarTemplateSpecializationDecl *D) {
6579 assert(!WritingAST && "Already writing the AST!");
6580
6581 if (!TD->getFirstDecl()->isFromASTFile())
6582 return;
6583 if (Chain && Chain->isProcessingUpdateRecords())
6584 return;
6585
6586 DeclsToEmitEvenIfUnreferenced.push_back(D);
6587}
6588
6589void ASTWriter::AddedCXXTemplateSpecialization(const FunctionTemplateDecl *TD,
6590 const FunctionDecl *D) {
6591 assert(!WritingAST && "Already writing the AST!");
6592
6593 if (!TD->getFirstDecl()->isFromASTFile())
6594 return;
6595 if (Chain && Chain->isProcessingUpdateRecords())
6596 return;
6597
6598 DeclsToEmitEvenIfUnreferenced.push_back(D);
6599}
Kelvin Libe286f52018-09-15 13:54:15 +00006600
6601//===----------------------------------------------------------------------===//
6602//// OMPClause Serialization
6603////===----------------------------------------------------------------------===//
6604
6605void OMPClauseWriter::writeClause(OMPClause *C) {
6606 Record.push_back(C->getClauseKind());
6607 Visit(C);
6608 Record.AddSourceLocation(C->getBeginLoc());
6609 Record.AddSourceLocation(C->getEndLoc());
6610}
6611
6612void OMPClauseWriter::VisitOMPClauseWithPreInit(OMPClauseWithPreInit *C) {
6613 Record.push_back(C->getCaptureRegion());
6614 Record.AddStmt(C->getPreInitStmt());
6615}
6616
6617void OMPClauseWriter::VisitOMPClauseWithPostUpdate(OMPClauseWithPostUpdate *C) {
6618 VisitOMPClauseWithPreInit(C);
6619 Record.AddStmt(C->getPostUpdateExpr());
6620}
6621
6622void OMPClauseWriter::VisitOMPIfClause(OMPIfClause *C) {
6623 VisitOMPClauseWithPreInit(C);
6624 Record.push_back(C->getNameModifier());
6625 Record.AddSourceLocation(C->getNameModifierLoc());
6626 Record.AddSourceLocation(C->getColonLoc());
6627 Record.AddStmt(C->getCondition());
6628 Record.AddSourceLocation(C->getLParenLoc());
6629}
6630
6631void OMPClauseWriter::VisitOMPFinalClause(OMPFinalClause *C) {
6632 Record.AddStmt(C->getCondition());
6633 Record.AddSourceLocation(C->getLParenLoc());
6634}
6635
6636void OMPClauseWriter::VisitOMPNumThreadsClause(OMPNumThreadsClause *C) {
6637 VisitOMPClauseWithPreInit(C);
6638 Record.AddStmt(C->getNumThreads());
6639 Record.AddSourceLocation(C->getLParenLoc());
6640}
6641
6642void OMPClauseWriter::VisitOMPSafelenClause(OMPSafelenClause *C) {
6643 Record.AddStmt(C->getSafelen());
6644 Record.AddSourceLocation(C->getLParenLoc());
6645}
6646
6647void OMPClauseWriter::VisitOMPSimdlenClause(OMPSimdlenClause *C) {
6648 Record.AddStmt(C->getSimdlen());
6649 Record.AddSourceLocation(C->getLParenLoc());
6650}
6651
Alexey Bataev9cc10fc2019-03-12 18:52:33 +00006652void OMPClauseWriter::VisitOMPAllocatorClause(OMPAllocatorClause *C) {
6653 Record.AddStmt(C->getAllocator());
6654 Record.AddSourceLocation(C->getLParenLoc());
6655}
6656
Kelvin Libe286f52018-09-15 13:54:15 +00006657void OMPClauseWriter::VisitOMPCollapseClause(OMPCollapseClause *C) {
6658 Record.AddStmt(C->getNumForLoops());
6659 Record.AddSourceLocation(C->getLParenLoc());
6660}
6661
6662void OMPClauseWriter::VisitOMPDefaultClause(OMPDefaultClause *C) {
6663 Record.push_back(C->getDefaultKind());
6664 Record.AddSourceLocation(C->getLParenLoc());
6665 Record.AddSourceLocation(C->getDefaultKindKwLoc());
6666}
6667
6668void OMPClauseWriter::VisitOMPProcBindClause(OMPProcBindClause *C) {
6669 Record.push_back(C->getProcBindKind());
6670 Record.AddSourceLocation(C->getLParenLoc());
6671 Record.AddSourceLocation(C->getProcBindKindKwLoc());
6672}
6673
6674void OMPClauseWriter::VisitOMPScheduleClause(OMPScheduleClause *C) {
6675 VisitOMPClauseWithPreInit(C);
6676 Record.push_back(C->getScheduleKind());
6677 Record.push_back(C->getFirstScheduleModifier());
6678 Record.push_back(C->getSecondScheduleModifier());
6679 Record.AddStmt(C->getChunkSize());
6680 Record.AddSourceLocation(C->getLParenLoc());
6681 Record.AddSourceLocation(C->getFirstScheduleModifierLoc());
6682 Record.AddSourceLocation(C->getSecondScheduleModifierLoc());
6683 Record.AddSourceLocation(C->getScheduleKindLoc());
6684 Record.AddSourceLocation(C->getCommaLoc());
6685}
6686
6687void OMPClauseWriter::VisitOMPOrderedClause(OMPOrderedClause *C) {
6688 Record.push_back(C->getLoopNumIterations().size());
6689 Record.AddStmt(C->getNumForLoops());
6690 for (Expr *NumIter : C->getLoopNumIterations())
6691 Record.AddStmt(NumIter);
6692 for (unsigned I = 0, E = C->getLoopNumIterations().size(); I <E; ++I)
Mike Rice0ed46662018-09-20 17:19:41 +00006693 Record.AddStmt(C->getLoopCounter(I));
Kelvin Libe286f52018-09-15 13:54:15 +00006694 Record.AddSourceLocation(C->getLParenLoc());
6695}
6696
6697void OMPClauseWriter::VisitOMPNowaitClause(OMPNowaitClause *) {}
6698
6699void OMPClauseWriter::VisitOMPUntiedClause(OMPUntiedClause *) {}
6700
6701void OMPClauseWriter::VisitOMPMergeableClause(OMPMergeableClause *) {}
6702
6703void OMPClauseWriter::VisitOMPReadClause(OMPReadClause *) {}
6704
6705void OMPClauseWriter::VisitOMPWriteClause(OMPWriteClause *) {}
6706
6707void OMPClauseWriter::VisitOMPUpdateClause(OMPUpdateClause *) {}
6708
6709void OMPClauseWriter::VisitOMPCaptureClause(OMPCaptureClause *) {}
6710
6711void OMPClauseWriter::VisitOMPSeqCstClause(OMPSeqCstClause *) {}
6712
6713void OMPClauseWriter::VisitOMPThreadsClause(OMPThreadsClause *) {}
6714
6715void OMPClauseWriter::VisitOMPSIMDClause(OMPSIMDClause *) {}
6716
6717void OMPClauseWriter::VisitOMPNogroupClause(OMPNogroupClause *) {}
6718
6719void OMPClauseWriter::VisitOMPPrivateClause(OMPPrivateClause *C) {
6720 Record.push_back(C->varlist_size());
6721 Record.AddSourceLocation(C->getLParenLoc());
6722 for (auto *VE : C->varlists()) {
6723 Record.AddStmt(VE);
6724 }
6725 for (auto *VE : C->private_copies()) {
6726 Record.AddStmt(VE);
6727 }
6728}
6729
6730void OMPClauseWriter::VisitOMPFirstprivateClause(OMPFirstprivateClause *C) {
6731 Record.push_back(C->varlist_size());
6732 VisitOMPClauseWithPreInit(C);
6733 Record.AddSourceLocation(C->getLParenLoc());
6734 for (auto *VE : C->varlists()) {
6735 Record.AddStmt(VE);
6736 }
6737 for (auto *VE : C->private_copies()) {
6738 Record.AddStmt(VE);
6739 }
6740 for (auto *VE : C->inits()) {
6741 Record.AddStmt(VE);
6742 }
6743}
6744
6745void OMPClauseWriter::VisitOMPLastprivateClause(OMPLastprivateClause *C) {
6746 Record.push_back(C->varlist_size());
6747 VisitOMPClauseWithPostUpdate(C);
6748 Record.AddSourceLocation(C->getLParenLoc());
6749 for (auto *VE : C->varlists())
6750 Record.AddStmt(VE);
6751 for (auto *E : C->private_copies())
6752 Record.AddStmt(E);
6753 for (auto *E : C->source_exprs())
6754 Record.AddStmt(E);
6755 for (auto *E : C->destination_exprs())
6756 Record.AddStmt(E);
6757 for (auto *E : C->assignment_ops())
6758 Record.AddStmt(E);
6759}
6760
6761void OMPClauseWriter::VisitOMPSharedClause(OMPSharedClause *C) {
6762 Record.push_back(C->varlist_size());
6763 Record.AddSourceLocation(C->getLParenLoc());
6764 for (auto *VE : C->varlists())
6765 Record.AddStmt(VE);
6766}
6767
6768void OMPClauseWriter::VisitOMPReductionClause(OMPReductionClause *C) {
6769 Record.push_back(C->varlist_size());
6770 VisitOMPClauseWithPostUpdate(C);
6771 Record.AddSourceLocation(C->getLParenLoc());
6772 Record.AddSourceLocation(C->getColonLoc());
6773 Record.AddNestedNameSpecifierLoc(C->getQualifierLoc());
6774 Record.AddDeclarationNameInfo(C->getNameInfo());
6775 for (auto *VE : C->varlists())
6776 Record.AddStmt(VE);
6777 for (auto *VE : C->privates())
6778 Record.AddStmt(VE);
6779 for (auto *E : C->lhs_exprs())
6780 Record.AddStmt(E);
6781 for (auto *E : C->rhs_exprs())
6782 Record.AddStmt(E);
6783 for (auto *E : C->reduction_ops())
6784 Record.AddStmt(E);
6785}
6786
6787void OMPClauseWriter::VisitOMPTaskReductionClause(OMPTaskReductionClause *C) {
6788 Record.push_back(C->varlist_size());
6789 VisitOMPClauseWithPostUpdate(C);
6790 Record.AddSourceLocation(C->getLParenLoc());
6791 Record.AddSourceLocation(C->getColonLoc());
6792 Record.AddNestedNameSpecifierLoc(C->getQualifierLoc());
6793 Record.AddDeclarationNameInfo(C->getNameInfo());
6794 for (auto *VE : C->varlists())
6795 Record.AddStmt(VE);
6796 for (auto *VE : C->privates())
6797 Record.AddStmt(VE);
6798 for (auto *E : C->lhs_exprs())
6799 Record.AddStmt(E);
6800 for (auto *E : C->rhs_exprs())
6801 Record.AddStmt(E);
6802 for (auto *E : C->reduction_ops())
6803 Record.AddStmt(E);
6804}
6805
6806void OMPClauseWriter::VisitOMPInReductionClause(OMPInReductionClause *C) {
6807 Record.push_back(C->varlist_size());
6808 VisitOMPClauseWithPostUpdate(C);
6809 Record.AddSourceLocation(C->getLParenLoc());
6810 Record.AddSourceLocation(C->getColonLoc());
6811 Record.AddNestedNameSpecifierLoc(C->getQualifierLoc());
6812 Record.AddDeclarationNameInfo(C->getNameInfo());
6813 for (auto *VE : C->varlists())
6814 Record.AddStmt(VE);
6815 for (auto *VE : C->privates())
6816 Record.AddStmt(VE);
6817 for (auto *E : C->lhs_exprs())
6818 Record.AddStmt(E);
6819 for (auto *E : C->rhs_exprs())
6820 Record.AddStmt(E);
6821 for (auto *E : C->reduction_ops())
6822 Record.AddStmt(E);
6823 for (auto *E : C->taskgroup_descriptors())
6824 Record.AddStmt(E);
6825}
6826
6827void OMPClauseWriter::VisitOMPLinearClause(OMPLinearClause *C) {
6828 Record.push_back(C->varlist_size());
6829 VisitOMPClauseWithPostUpdate(C);
6830 Record.AddSourceLocation(C->getLParenLoc());
6831 Record.AddSourceLocation(C->getColonLoc());
6832 Record.push_back(C->getModifier());
6833 Record.AddSourceLocation(C->getModifierLoc());
6834 for (auto *VE : C->varlists()) {
6835 Record.AddStmt(VE);
6836 }
6837 for (auto *VE : C->privates()) {
6838 Record.AddStmt(VE);
6839 }
6840 for (auto *VE : C->inits()) {
6841 Record.AddStmt(VE);
6842 }
6843 for (auto *VE : C->updates()) {
6844 Record.AddStmt(VE);
6845 }
6846 for (auto *VE : C->finals()) {
6847 Record.AddStmt(VE);
6848 }
6849 Record.AddStmt(C->getStep());
6850 Record.AddStmt(C->getCalcStep());
Alexey Bataev195ae902019-08-08 13:42:45 +00006851 for (auto *VE : C->used_expressions())
6852 Record.AddStmt(VE);
Kelvin Libe286f52018-09-15 13:54:15 +00006853}
6854
6855void OMPClauseWriter::VisitOMPAlignedClause(OMPAlignedClause *C) {
6856 Record.push_back(C->varlist_size());
6857 Record.AddSourceLocation(C->getLParenLoc());
6858 Record.AddSourceLocation(C->getColonLoc());
6859 for (auto *VE : C->varlists())
6860 Record.AddStmt(VE);
6861 Record.AddStmt(C->getAlignment());
6862}
6863
6864void OMPClauseWriter::VisitOMPCopyinClause(OMPCopyinClause *C) {
6865 Record.push_back(C->varlist_size());
6866 Record.AddSourceLocation(C->getLParenLoc());
6867 for (auto *VE : C->varlists())
6868 Record.AddStmt(VE);
6869 for (auto *E : C->source_exprs())
6870 Record.AddStmt(E);
6871 for (auto *E : C->destination_exprs())
6872 Record.AddStmt(E);
6873 for (auto *E : C->assignment_ops())
6874 Record.AddStmt(E);
6875}
6876
6877void OMPClauseWriter::VisitOMPCopyprivateClause(OMPCopyprivateClause *C) {
6878 Record.push_back(C->varlist_size());
6879 Record.AddSourceLocation(C->getLParenLoc());
6880 for (auto *VE : C->varlists())
6881 Record.AddStmt(VE);
6882 for (auto *E : C->source_exprs())
6883 Record.AddStmt(E);
6884 for (auto *E : C->destination_exprs())
6885 Record.AddStmt(E);
6886 for (auto *E : C->assignment_ops())
6887 Record.AddStmt(E);
6888}
6889
6890void OMPClauseWriter::VisitOMPFlushClause(OMPFlushClause *C) {
6891 Record.push_back(C->varlist_size());
6892 Record.AddSourceLocation(C->getLParenLoc());
6893 for (auto *VE : C->varlists())
6894 Record.AddStmt(VE);
6895}
6896
6897void OMPClauseWriter::VisitOMPDependClause(OMPDependClause *C) {
6898 Record.push_back(C->varlist_size());
6899 Record.push_back(C->getNumLoops());
6900 Record.AddSourceLocation(C->getLParenLoc());
6901 Record.push_back(C->getDependencyKind());
6902 Record.AddSourceLocation(C->getDependencyLoc());
6903 Record.AddSourceLocation(C->getColonLoc());
6904 for (auto *VE : C->varlists())
6905 Record.AddStmt(VE);
6906 for (unsigned I = 0, E = C->getNumLoops(); I < E; ++I)
6907 Record.AddStmt(C->getLoopData(I));
6908}
6909
6910void OMPClauseWriter::VisitOMPDeviceClause(OMPDeviceClause *C) {
6911 VisitOMPClauseWithPreInit(C);
6912 Record.AddStmt(C->getDevice());
6913 Record.AddSourceLocation(C->getLParenLoc());
6914}
6915
6916void OMPClauseWriter::VisitOMPMapClause(OMPMapClause *C) {
6917 Record.push_back(C->varlist_size());
6918 Record.push_back(C->getUniqueDeclarationsNum());
6919 Record.push_back(C->getTotalComponentListNum());
6920 Record.push_back(C->getTotalComponentsNum());
6921 Record.AddSourceLocation(C->getLParenLoc());
Kelvin Lief579432018-12-18 22:18:41 +00006922 for (unsigned I = 0; I < OMPMapClause::NumberOfModifiers; ++I) {
6923 Record.push_back(C->getMapTypeModifier(I));
6924 Record.AddSourceLocation(C->getMapTypeModifierLoc(I));
6925 }
Michael Kruse4304e9d2019-02-19 16:38:20 +00006926 Record.AddNestedNameSpecifierLoc(C->getMapperQualifierLoc());
6927 Record.AddDeclarationNameInfo(C->getMapperIdInfo());
Kelvin Libe286f52018-09-15 13:54:15 +00006928 Record.push_back(C->getMapType());
6929 Record.AddSourceLocation(C->getMapLoc());
6930 Record.AddSourceLocation(C->getColonLoc());
6931 for (auto *E : C->varlists())
6932 Record.AddStmt(E);
Michael Kruse4304e9d2019-02-19 16:38:20 +00006933 for (auto *E : C->mapperlists())
6934 Record.AddStmt(E);
Kelvin Libe286f52018-09-15 13:54:15 +00006935 for (auto *D : C->all_decls())
6936 Record.AddDeclRef(D);
6937 for (auto N : C->all_num_lists())
6938 Record.push_back(N);
6939 for (auto N : C->all_lists_sizes())
6940 Record.push_back(N);
6941 for (auto &M : C->all_components()) {
6942 Record.AddStmt(M.getAssociatedExpression());
6943 Record.AddDeclRef(M.getAssociatedDeclaration());
6944 }
6945}
6946
Alexey Bataeve04483e2019-03-27 14:14:31 +00006947void OMPClauseWriter::VisitOMPAllocateClause(OMPAllocateClause *C) {
6948 Record.push_back(C->varlist_size());
6949 Record.AddSourceLocation(C->getLParenLoc());
6950 Record.AddSourceLocation(C->getColonLoc());
6951 Record.AddStmt(C->getAllocator());
6952 for (auto *VE : C->varlists())
6953 Record.AddStmt(VE);
6954}
6955
Kelvin Libe286f52018-09-15 13:54:15 +00006956void OMPClauseWriter::VisitOMPNumTeamsClause(OMPNumTeamsClause *C) {
6957 VisitOMPClauseWithPreInit(C);
6958 Record.AddStmt(C->getNumTeams());
6959 Record.AddSourceLocation(C->getLParenLoc());
6960}
6961
6962void OMPClauseWriter::VisitOMPThreadLimitClause(OMPThreadLimitClause *C) {
6963 VisitOMPClauseWithPreInit(C);
6964 Record.AddStmt(C->getThreadLimit());
6965 Record.AddSourceLocation(C->getLParenLoc());
6966}
6967
6968void OMPClauseWriter::VisitOMPPriorityClause(OMPPriorityClause *C) {
6969 Record.AddStmt(C->getPriority());
6970 Record.AddSourceLocation(C->getLParenLoc());
6971}
6972
6973void OMPClauseWriter::VisitOMPGrainsizeClause(OMPGrainsizeClause *C) {
6974 Record.AddStmt(C->getGrainsize());
6975 Record.AddSourceLocation(C->getLParenLoc());
6976}
6977
6978void OMPClauseWriter::VisitOMPNumTasksClause(OMPNumTasksClause *C) {
6979 Record.AddStmt(C->getNumTasks());
6980 Record.AddSourceLocation(C->getLParenLoc());
6981}
6982
6983void OMPClauseWriter::VisitOMPHintClause(OMPHintClause *C) {
6984 Record.AddStmt(C->getHint());
6985 Record.AddSourceLocation(C->getLParenLoc());
6986}
6987
6988void OMPClauseWriter::VisitOMPDistScheduleClause(OMPDistScheduleClause *C) {
6989 VisitOMPClauseWithPreInit(C);
6990 Record.push_back(C->getDistScheduleKind());
6991 Record.AddStmt(C->getChunkSize());
6992 Record.AddSourceLocation(C->getLParenLoc());
6993 Record.AddSourceLocation(C->getDistScheduleKindLoc());
6994 Record.AddSourceLocation(C->getCommaLoc());
6995}
6996
6997void OMPClauseWriter::VisitOMPDefaultmapClause(OMPDefaultmapClause *C) {
6998 Record.push_back(C->getDefaultmapKind());
6999 Record.push_back(C->getDefaultmapModifier());
7000 Record.AddSourceLocation(C->getLParenLoc());
7001 Record.AddSourceLocation(C->getDefaultmapModifierLoc());
7002 Record.AddSourceLocation(C->getDefaultmapKindLoc());
7003}
7004
7005void OMPClauseWriter::VisitOMPToClause(OMPToClause *C) {
7006 Record.push_back(C->varlist_size());
7007 Record.push_back(C->getUniqueDeclarationsNum());
7008 Record.push_back(C->getTotalComponentListNum());
7009 Record.push_back(C->getTotalComponentsNum());
7010 Record.AddSourceLocation(C->getLParenLoc());
Michael Kruse01f670d2019-02-22 22:29:42 +00007011 Record.AddNestedNameSpecifierLoc(C->getMapperQualifierLoc());
7012 Record.AddDeclarationNameInfo(C->getMapperIdInfo());
Kelvin Libe286f52018-09-15 13:54:15 +00007013 for (auto *E : C->varlists())
7014 Record.AddStmt(E);
Michael Kruse01f670d2019-02-22 22:29:42 +00007015 for (auto *E : C->mapperlists())
7016 Record.AddStmt(E);
Kelvin Libe286f52018-09-15 13:54:15 +00007017 for (auto *D : C->all_decls())
7018 Record.AddDeclRef(D);
7019 for (auto N : C->all_num_lists())
7020 Record.push_back(N);
7021 for (auto N : C->all_lists_sizes())
7022 Record.push_back(N);
7023 for (auto &M : C->all_components()) {
7024 Record.AddStmt(M.getAssociatedExpression());
7025 Record.AddDeclRef(M.getAssociatedDeclaration());
7026 }
7027}
7028
7029void OMPClauseWriter::VisitOMPFromClause(OMPFromClause *C) {
7030 Record.push_back(C->varlist_size());
7031 Record.push_back(C->getUniqueDeclarationsNum());
7032 Record.push_back(C->getTotalComponentListNum());
7033 Record.push_back(C->getTotalComponentsNum());
7034 Record.AddSourceLocation(C->getLParenLoc());
Michael Kruse0336c752019-02-25 20:34:15 +00007035 Record.AddNestedNameSpecifierLoc(C->getMapperQualifierLoc());
7036 Record.AddDeclarationNameInfo(C->getMapperIdInfo());
Kelvin Libe286f52018-09-15 13:54:15 +00007037 for (auto *E : C->varlists())
7038 Record.AddStmt(E);
Michael Kruse0336c752019-02-25 20:34:15 +00007039 for (auto *E : C->mapperlists())
7040 Record.AddStmt(E);
Kelvin Libe286f52018-09-15 13:54:15 +00007041 for (auto *D : C->all_decls())
7042 Record.AddDeclRef(D);
7043 for (auto N : C->all_num_lists())
7044 Record.push_back(N);
7045 for (auto N : C->all_lists_sizes())
7046 Record.push_back(N);
7047 for (auto &M : C->all_components()) {
7048 Record.AddStmt(M.getAssociatedExpression());
7049 Record.AddDeclRef(M.getAssociatedDeclaration());
7050 }
7051}
7052
7053void OMPClauseWriter::VisitOMPUseDevicePtrClause(OMPUseDevicePtrClause *C) {
7054 Record.push_back(C->varlist_size());
7055 Record.push_back(C->getUniqueDeclarationsNum());
7056 Record.push_back(C->getTotalComponentListNum());
7057 Record.push_back(C->getTotalComponentsNum());
7058 Record.AddSourceLocation(C->getLParenLoc());
7059 for (auto *E : C->varlists())
7060 Record.AddStmt(E);
7061 for (auto *VE : C->private_copies())
7062 Record.AddStmt(VE);
7063 for (auto *VE : C->inits())
7064 Record.AddStmt(VE);
7065 for (auto *D : C->all_decls())
7066 Record.AddDeclRef(D);
7067 for (auto N : C->all_num_lists())
7068 Record.push_back(N);
7069 for (auto N : C->all_lists_sizes())
7070 Record.push_back(N);
7071 for (auto &M : C->all_components()) {
7072 Record.AddStmt(M.getAssociatedExpression());
7073 Record.AddDeclRef(M.getAssociatedDeclaration());
7074 }
7075}
7076
7077void OMPClauseWriter::VisitOMPIsDevicePtrClause(OMPIsDevicePtrClause *C) {
7078 Record.push_back(C->varlist_size());
7079 Record.push_back(C->getUniqueDeclarationsNum());
7080 Record.push_back(C->getTotalComponentListNum());
7081 Record.push_back(C->getTotalComponentsNum());
7082 Record.AddSourceLocation(C->getLParenLoc());
7083 for (auto *E : C->varlists())
7084 Record.AddStmt(E);
7085 for (auto *D : C->all_decls())
7086 Record.AddDeclRef(D);
7087 for (auto N : C->all_num_lists())
7088 Record.push_back(N);
7089 for (auto N : C->all_lists_sizes())
7090 Record.push_back(N);
7091 for (auto &M : C->all_components()) {
7092 Record.AddStmt(M.getAssociatedExpression());
7093 Record.AddDeclRef(M.getAssociatedDeclaration());
7094 }
7095}
Kelvin Li1408f912018-09-26 04:28:39 +00007096
7097void OMPClauseWriter::VisitOMPUnifiedAddressClause(OMPUnifiedAddressClause *) {}
Patrick Lyster4a370b92018-10-01 13:47:43 +00007098
7099void OMPClauseWriter::VisitOMPUnifiedSharedMemoryClause(
7100 OMPUnifiedSharedMemoryClause *) {}
Patrick Lyster6bdf63b2018-10-03 20:07:58 +00007101
7102void OMPClauseWriter::VisitOMPReverseOffloadClause(OMPReverseOffloadClause *) {}
Patrick Lyster3fe9e392018-10-11 14:41:10 +00007103
7104void
7105OMPClauseWriter::VisitOMPDynamicAllocatorsClause(OMPDynamicAllocatorsClause *) {
7106}
Patrick Lyster7a2a27c2018-11-02 12:18:11 +00007107
7108void OMPClauseWriter::VisitOMPAtomicDefaultMemOrderClause(
7109 OMPAtomicDefaultMemOrderClause *C) {
7110 Record.push_back(C->getAtomicDefaultMemOrderKind());
7111 Record.AddSourceLocation(C->getLParenLoc());
7112 Record.AddSourceLocation(C->getAtomicDefaultMemOrderKindKwLoc());
7113}