blob: 1e76c328a1f54b7b5e332a96262c6796039251af [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)
John McCall36b12a82019-10-02 06:35:23 +0000169#include "clang/AST/TypeNodes.inc"
Richard Smith290d8012016-04-06 17:06:00 +0000170 }
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)
John McCall36b12a82019-10-02 06:35:23 +0000180#include "clang/AST/TypeNodes.inc"
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000181 };
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());
Richard Smith772e2662019-10-04 01:25:59 +0000241 Record.AddStmt(const_cast<Expr*>(T->getSizeExpr()));
Sebastian Redl539c5062010-08-18 23:57:32 +0000242 Code = TYPE_CONSTANT_ARRAY;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000243}
244
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000245void ASTTypeWriter::VisitIncompleteArrayType(const IncompleteArrayType *T) {
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000246 VisitArrayType(T);
Sebastian Redl539c5062010-08-18 23:57:32 +0000247 Code = TYPE_INCOMPLETE_ARRAY;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000248}
249
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000250void ASTTypeWriter::VisitVariableArrayType(const VariableArrayType *T) {
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000251 VisitArrayType(T);
Richard Smith69c82bf2016-04-01 22:52:03 +0000252 Record.AddSourceLocation(T->getLBracketLoc());
253 Record.AddSourceLocation(T->getRBracketLoc());
Richard Smith290d8012016-04-06 17:06:00 +0000254 Record.AddStmt(T->getSizeExpr());
Sebastian Redl539c5062010-08-18 23:57:32 +0000255 Code = TYPE_VARIABLE_ARRAY;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000256}
257
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000258void ASTTypeWriter::VisitVectorType(const VectorType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000259 Record.AddTypeRef(T->getElementType());
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000260 Record.push_back(T->getNumElements());
Bob Wilsonaeb56442010-11-10 21:56:12 +0000261 Record.push_back(T->getVectorKind());
Sebastian Redl539c5062010-08-18 23:57:32 +0000262 Code = TYPE_VECTOR;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000263}
264
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000265void ASTTypeWriter::VisitExtVectorType(const ExtVectorType *T) {
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000266 VisitVectorType(T);
Sebastian Redl539c5062010-08-18 23:57:32 +0000267 Code = TYPE_EXT_VECTOR;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000268}
269
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000270void ASTTypeWriter::VisitFunctionType(const FunctionType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000271 Record.AddTypeRef(T->getReturnType());
Rafael Espindolac50c27c2010-03-30 20:24:48 +0000272 FunctionType::ExtInfo C = T->getExtInfo();
273 Record.push_back(C.getNoReturn());
Eli Friedmanc5b20b52011-04-09 08:18:08 +0000274 Record.push_back(C.getHasRegParm());
Rafael Espindola49b85ab2010-03-30 22:15:11 +0000275 Record.push_back(C.getRegParm());
Douglas Gregor8c940862010-01-18 17:14:39 +0000276 // FIXME: need to stabilize encoding of calling convention...
Rafael Espindolac50c27c2010-03-30 20:24:48 +0000277 Record.push_back(C.getCC());
John McCall31168b02011-06-15 23:02:42 +0000278 Record.push_back(C.getProducesResult());
Oren Ben Simhon318a6ea2017-04-27 12:01:00 +0000279 Record.push_back(C.getNoCallerSavedRegs());
Oren Ben Simhon220671a2018-03-17 13:31:35 +0000280 Record.push_back(C.getNoCfCheck());
Richard Smith01b2cb42014-07-26 06:37:51 +0000281
282 if (C.getHasRegParm() || C.getRegParm() || C.getProducesResult())
283 AbbrevToUse = 0;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000284}
285
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000286void ASTTypeWriter::VisitFunctionNoProtoType(const FunctionNoProtoType *T) {
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000287 VisitFunctionType(T);
Sebastian Redl539c5062010-08-18 23:57:32 +0000288 Code = TYPE_FUNCTION_NO_PROTO;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000289}
290
Richard Smith290d8012016-04-06 17:06:00 +0000291static void addExceptionSpec(const FunctionProtoType *T,
292 ASTRecordWriter &Record) {
Sebastian Redlfa453cf2011-03-12 11:50:43 +0000293 Record.push_back(T->getExceptionSpecType());
294 if (T->getExceptionSpecType() == EST_Dynamic) {
295 Record.push_back(T->getNumExceptions());
296 for (unsigned I = 0, N = T->getNumExceptions(); I != N; ++I)
Richard Smith69c82bf2016-04-01 22:52:03 +0000297 Record.AddTypeRef(T->getExceptionType(I));
Richard Smitheaf11ad2018-05-03 03:58:32 +0000298 } else if (isComputedNoexcept(T->getExceptionSpecType())) {
Richard Smith290d8012016-04-06 17:06:00 +0000299 Record.AddStmt(T->getNoexceptExpr());
Richard Smith8b987a92012-04-21 17:47:47 +0000300 } else if (T->getExceptionSpecType() == EST_Uninstantiated) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000301 Record.AddDeclRef(T->getExceptionSpecDecl());
302 Record.AddDeclRef(T->getExceptionSpecTemplate());
Richard Smithd3b5c9082012-07-27 04:22:15 +0000303 } else if (T->getExceptionSpecType() == EST_Unevaluated) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000304 Record.AddDeclRef(T->getExceptionSpecDecl());
Sebastian Redlfa453cf2011-03-12 11:50:43 +0000305 }
Richard Smith564417a2014-03-20 21:47:22 +0000306}
307
308void ASTTypeWriter::VisitFunctionProtoType(const FunctionProtoType *T) {
309 VisitFunctionType(T);
Richard Smith01b2cb42014-07-26 06:37:51 +0000310
Richard Smith564417a2014-03-20 21:47:22 +0000311 Record.push_back(T->isVariadic());
312 Record.push_back(T->hasTrailingReturn());
Anastasia Stulovac61eaa52019-01-28 11:37:49 +0000313 Record.push_back(T->getMethodQuals().getAsOpaqueValue());
Richard Smith564417a2014-03-20 21:47:22 +0000314 Record.push_back(static_cast<unsigned>(T->getRefQualifier()));
Richard Smith290d8012016-04-06 17:06:00 +0000315 addExceptionSpec(T, Record);
Richard Smith01b2cb42014-07-26 06:37:51 +0000316
317 Record.push_back(T->getNumParams());
318 for (unsigned I = 0, N = T->getNumParams(); I != N; ++I)
Richard Smith69c82bf2016-04-01 22:52:03 +0000319 Record.AddTypeRef(T->getParamType(I));
Richard Smith01b2cb42014-07-26 06:37:51 +0000320
John McCall18afab72016-03-01 00:49:02 +0000321 if (T->hasExtParameterInfos()) {
322 for (unsigned I = 0, N = T->getNumParams(); I != N; ++I)
323 Record.push_back(T->getExtParameterInfo(I).getOpaqueValue());
324 }
325
Anastasia Stulovac61eaa52019-01-28 11:37:49 +0000326 if (T->isVariadic() || T->hasTrailingReturn() || T->getMethodQuals() ||
John McCall18afab72016-03-01 00:49:02 +0000327 T->getRefQualifier() || T->getExceptionSpecType() != EST_None ||
328 T->hasExtParameterInfos())
Richard Smith01b2cb42014-07-26 06:37:51 +0000329 AbbrevToUse = 0;
330
Sebastian Redl539c5062010-08-18 23:57:32 +0000331 Code = TYPE_FUNCTION_PROTO;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000332}
333
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000334void ASTTypeWriter::VisitUnresolvedUsingType(const UnresolvedUsingType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000335 Record.AddDeclRef(T->getDecl());
Sebastian Redl539c5062010-08-18 23:57:32 +0000336 Code = TYPE_UNRESOLVED_USING;
John McCallb96ec562009-12-04 22:46:56 +0000337}
John McCallb96ec562009-12-04 22:46:56 +0000338
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000339void ASTTypeWriter::VisitTypedefType(const TypedefType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000340 Record.AddDeclRef(T->getDecl());
Argyrios Kyrtzidis45a83f92010-07-02 11:55:11 +0000341 assert(!T->isCanonicalUnqualified() && "Invalid typedef ?");
Richard Smith69c82bf2016-04-01 22:52:03 +0000342 Record.AddTypeRef(T->getCanonicalTypeInternal());
Sebastian Redl539c5062010-08-18 23:57:32 +0000343 Code = TYPE_TYPEDEF;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000344}
345
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000346void ASTTypeWriter::VisitTypeOfExprType(const TypeOfExprType *T) {
Richard Smith290d8012016-04-06 17:06:00 +0000347 Record.AddStmt(T->getUnderlyingExpr());
Sebastian Redl539c5062010-08-18 23:57:32 +0000348 Code = TYPE_TYPEOF_EXPR;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000349}
350
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000351void ASTTypeWriter::VisitTypeOfType(const TypeOfType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000352 Record.AddTypeRef(T->getUnderlyingType());
Sebastian Redl539c5062010-08-18 23:57:32 +0000353 Code = TYPE_TYPEOF;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000354}
355
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000356void ASTTypeWriter::VisitDecltypeType(const DecltypeType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000357 Record.AddTypeRef(T->getUnderlyingType());
Richard Smith290d8012016-04-06 17:06:00 +0000358 Record.AddStmt(T->getUnderlyingExpr());
Sebastian Redl539c5062010-08-18 23:57:32 +0000359 Code = TYPE_DECLTYPE;
Anders Carlsson81df7b82009-06-24 19:06:50 +0000360}
361
Alexis Hunte852b102011-05-24 22:41:36 +0000362void ASTTypeWriter::VisitUnaryTransformType(const UnaryTransformType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000363 Record.AddTypeRef(T->getBaseType());
364 Record.AddTypeRef(T->getUnderlyingType());
Alexis Hunte852b102011-05-24 22:41:36 +0000365 Record.push_back(T->getUTTKind());
366 Code = TYPE_UNARY_TRANSFORM;
367}
368
Richard Smith30482bc2011-02-20 03:19:35 +0000369void ASTTypeWriter::VisitAutoType(const AutoType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000370 Record.AddTypeRef(T->getDeducedType());
Richard Smithe301ba22015-11-11 02:02:15 +0000371 Record.push_back((unsigned)T->getKeyword());
Richard Smith27d807c2013-04-30 13:56:41 +0000372 if (T->getDeducedType().isNull())
Richard Smithb2997f52019-05-21 20:10:50 +0000373 Record.push_back(T->containsUnexpandedParameterPack() ? 2 :
374 T->isDependentType() ? 1 : 0);
Richard Smith30482bc2011-02-20 03:19:35 +0000375 Code = TYPE_AUTO;
376}
377
Richard Smith600b5262017-01-26 20:40:47 +0000378void ASTTypeWriter::VisitDeducedTemplateSpecializationType(
379 const DeducedTemplateSpecializationType *T) {
380 Record.AddTemplateName(T->getTemplateName());
381 Record.AddTypeRef(T->getDeducedType());
382 if (T->getDeducedType().isNull())
383 Record.push_back(T->isDependentType());
384 Code = TYPE_DEDUCED_TEMPLATE_SPECIALIZATION;
385}
386
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000387void ASTTypeWriter::VisitTagType(const TagType *T) {
Argyrios Kyrtzidisa4ed1812010-07-08 13:09:53 +0000388 Record.push_back(T->isDependentType());
Richard Smith69c82bf2016-04-01 22:52:03 +0000389 Record.AddDeclRef(T->getDecl()->getCanonicalDecl());
Mike Stump11289f42009-09-09 15:08:12 +0000390 assert(!T->isBeingDefined() &&
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000391 "Cannot serialize in the middle of a type definition");
392}
393
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000394void ASTTypeWriter::VisitRecordType(const RecordType *T) {
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000395 VisitTagType(T);
Sebastian Redl539c5062010-08-18 23:57:32 +0000396 Code = TYPE_RECORD;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000397}
398
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000399void ASTTypeWriter::VisitEnumType(const EnumType *T) {
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000400 VisitTagType(T);
Sebastian Redl539c5062010-08-18 23:57:32 +0000401 Code = TYPE_ENUM;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000402}
403
John McCall81904512011-01-06 01:58:22 +0000404void ASTTypeWriter::VisitAttributedType(const AttributedType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000405 Record.AddTypeRef(T->getModifiedType());
406 Record.AddTypeRef(T->getEquivalentType());
John McCall81904512011-01-06 01:58:22 +0000407 Record.push_back(T->getAttrKind());
408 Code = TYPE_ATTRIBUTED;
409}
410
Mike Stump11289f42009-09-09 15:08:12 +0000411void
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000412ASTTypeWriter::VisitSubstTemplateTypeParmType(
John McCallcebee162009-10-18 09:09:24 +0000413 const SubstTemplateTypeParmType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000414 Record.AddTypeRef(QualType(T->getReplacedParameter(), 0));
415 Record.AddTypeRef(T->getReplacementType());
Sebastian Redl539c5062010-08-18 23:57:32 +0000416 Code = TYPE_SUBST_TEMPLATE_TYPE_PARM;
John McCallcebee162009-10-18 09:09:24 +0000417}
418
419void
Douglas Gregorada4b792011-01-14 02:55:32 +0000420ASTTypeWriter::VisitSubstTemplateTypeParmPackType(
421 const SubstTemplateTypeParmPackType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000422 Record.AddTypeRef(QualType(T->getReplacedParameter(), 0));
423 Record.AddTemplateArgument(T->getArgumentPack());
Douglas Gregorada4b792011-01-14 02:55:32 +0000424 Code = TYPE_SUBST_TEMPLATE_TYPE_PARM_PACK;
425}
426
427void
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000428ASTTypeWriter::VisitTemplateSpecializationType(
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000429 const TemplateSpecializationType *T) {
Argyrios Kyrtzidisa4ed1812010-07-08 13:09:53 +0000430 Record.push_back(T->isDependentType());
Richard Smith69c82bf2016-04-01 22:52:03 +0000431 Record.AddTemplateName(T->getTemplateName());
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +0000432 Record.push_back(T->getNumArgs());
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +0000433 for (const auto &ArgI : *T)
Richard Smith69c82bf2016-04-01 22:52:03 +0000434 Record.AddTemplateArgument(ArgI);
435 Record.AddTypeRef(T->isTypeAlias() ? T->getAliasedType()
436 : T->isCanonicalUnqualified()
437 ? QualType()
438 : T->getCanonicalTypeInternal());
Sebastian Redl539c5062010-08-18 23:57:32 +0000439 Code = TYPE_TEMPLATE_SPECIALIZATION;
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +0000440}
441
442void
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000443ASTTypeWriter::VisitDependentSizedArrayType(const DependentSizedArrayType *T) {
Argyrios Kyrtzidis4a57bd02010-06-30 08:49:25 +0000444 VisitArrayType(T);
Richard Smith290d8012016-04-06 17:06:00 +0000445 Record.AddStmt(T->getSizeExpr());
Richard Smith69c82bf2016-04-01 22:52:03 +0000446 Record.AddSourceRange(T->getBracketsRange());
Sebastian Redl539c5062010-08-18 23:57:32 +0000447 Code = TYPE_DEPENDENT_SIZED_ARRAY;
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +0000448}
449
450void
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000451ASTTypeWriter::VisitDependentSizedExtVectorType(
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +0000452 const DependentSizedExtVectorType *T) {
Alex Lorenz00aee432017-03-22 10:04:48 +0000453 Record.AddTypeRef(T->getElementType());
454 Record.AddStmt(T->getSizeExpr());
455 Record.AddSourceLocation(T->getAttributeLoc());
456 Code = TYPE_DEPENDENT_SIZED_EXT_VECTOR;
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +0000457}
458
Erich Keanef702b022018-07-13 19:46:04 +0000459void ASTTypeWriter::VisitDependentVectorType(const DependentVectorType *T) {
460 Record.AddTypeRef(T->getElementType());
461 Record.AddStmt(const_cast<Expr*>(T->getSizeExpr()));
462 Record.AddSourceLocation(T->getAttributeLoc());
463 Record.push_back(T->getVectorKind());
464 Code = TYPE_DEPENDENT_SIZED_VECTOR;
465}
466
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +0000467void
Andrew Gozillon572bbb02017-10-02 06:25:51 +0000468ASTTypeWriter::VisitDependentAddressSpaceType(
469 const DependentAddressSpaceType *T) {
470 Record.AddTypeRef(T->getPointeeType());
471 Record.AddStmt(T->getAddrSpaceExpr());
472 Record.AddSourceLocation(T->getAttributeLoc());
473 Code = TYPE_DEPENDENT_ADDRESS_SPACE;
474}
475
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +0000476void
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000477ASTTypeWriter::VisitTemplateTypeParmType(const TemplateTypeParmType *T) {
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +0000478 Record.push_back(T->getDepth());
479 Record.push_back(T->getIndex());
480 Record.push_back(T->isParameterPack());
Richard Smith69c82bf2016-04-01 22:52:03 +0000481 Record.AddDeclRef(T->getDecl());
Sebastian Redl539c5062010-08-18 23:57:32 +0000482 Code = TYPE_TEMPLATE_TYPE_PARM;
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +0000483}
484
485void
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000486ASTTypeWriter::VisitDependentNameType(const DependentNameType *T) {
Argyrios Kyrtzidisbfcacee2010-06-24 08:57:31 +0000487 Record.push_back(T->getKeyword());
Richard Smith69c82bf2016-04-01 22:52:03 +0000488 Record.AddNestedNameSpecifier(T->getQualifier());
489 Record.AddIdentifierRef(T->getIdentifier());
490 Record.AddTypeRef(
491 T->isCanonicalUnqualified() ? QualType() : T->getCanonicalTypeInternal());
Sebastian Redl539c5062010-08-18 23:57:32 +0000492 Code = TYPE_DEPENDENT_NAME;
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +0000493}
494
495void
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000496ASTTypeWriter::VisitDependentTemplateSpecializationType(
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +0000497 const DependentTemplateSpecializationType *T) {
Argyrios Kyrtzidisf0f7a792010-06-25 16:24:58 +0000498 Record.push_back(T->getKeyword());
Richard Smith69c82bf2016-04-01 22:52:03 +0000499 Record.AddNestedNameSpecifier(T->getQualifier());
500 Record.AddIdentifierRef(T->getIdentifier());
Argyrios Kyrtzidisf0f7a792010-06-25 16:24:58 +0000501 Record.push_back(T->getNumArgs());
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +0000502 for (const auto &I : *T)
Richard Smith69c82bf2016-04-01 22:52:03 +0000503 Record.AddTemplateArgument(I);
Sebastian Redl539c5062010-08-18 23:57:32 +0000504 Code = TYPE_DEPENDENT_TEMPLATE_SPECIALIZATION;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000505}
506
Douglas Gregord2fa7662010-12-20 02:24:11 +0000507void ASTTypeWriter::VisitPackExpansionType(const PackExpansionType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000508 Record.AddTypeRef(T->getPattern());
David Blaikie05785d12013-02-20 22:23:23 +0000509 if (Optional<unsigned> NumExpansions = T->getNumExpansions())
Douglas Gregor0dca5fd2011-01-14 17:04:44 +0000510 Record.push_back(*NumExpansions + 1);
511 else
512 Record.push_back(0);
Douglas Gregord2fa7662010-12-20 02:24:11 +0000513 Code = TYPE_PACK_EXPANSION;
514}
515
Abramo Bagnara924a8f32010-12-10 16:29:40 +0000516void ASTTypeWriter::VisitParenType(const ParenType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000517 Record.AddTypeRef(T->getInnerType());
Abramo Bagnara924a8f32010-12-10 16:29:40 +0000518 Code = TYPE_PAREN;
519}
520
Leonard Chanc72aaf62019-05-07 03:20:17 +0000521void ASTTypeWriter::VisitMacroQualifiedType(const MacroQualifiedType *T) {
522 Record.AddTypeRef(T->getUnderlyingType());
523 Record.AddIdentifierRef(T->getMacroIdentifier());
524 Code = TYPE_MACRO_QUALIFIED;
525}
526
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000527void ASTTypeWriter::VisitElaboratedType(const ElaboratedType *T) {
Abramo Bagnara6150c882010-05-11 21:36:43 +0000528 Record.push_back(T->getKeyword());
Richard Smith69c82bf2016-04-01 22:52:03 +0000529 Record.AddNestedNameSpecifier(T->getQualifier());
530 Record.AddTypeRef(T->getNamedType());
Joel E. Denny7509a2f2018-05-14 19:36:45 +0000531 Record.AddDeclRef(T->getOwnedTagDecl());
Sebastian Redl539c5062010-08-18 23:57:32 +0000532 Code = TYPE_ELABORATED;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000533}
534
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000535void ASTTypeWriter::VisitInjectedClassNameType(const InjectedClassNameType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000536 Record.AddDeclRef(T->getDecl()->getCanonicalDecl());
537 Record.AddTypeRef(T->getInjectedSpecializationType());
Sebastian Redl539c5062010-08-18 23:57:32 +0000538 Code = TYPE_INJECTED_CLASS_NAME;
John McCalle78aac42010-03-10 03:28:59 +0000539}
540
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000541void ASTTypeWriter::VisitObjCInterfaceType(const ObjCInterfaceType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000542 Record.AddDeclRef(T->getDecl()->getCanonicalDecl());
Sebastian Redl539c5062010-08-18 23:57:32 +0000543 Code = TYPE_OBJC_INTERFACE;
John McCall8b07ec22010-05-15 11:32:37 +0000544}
545
Manman Rene6be26c2016-09-13 17:25:08 +0000546void ASTTypeWriter::VisitObjCTypeParamType(const ObjCTypeParamType *T) {
547 Record.AddDeclRef(T->getDecl());
548 Record.push_back(T->getNumProtocols());
549 for (const auto *I : T->quals())
550 Record.AddDeclRef(I);
551 Code = TYPE_OBJC_TYPE_PARAM;
552}
553
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000554void ASTTypeWriter::VisitObjCObjectType(const ObjCObjectType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000555 Record.AddTypeRef(T->getBaseType());
Douglas Gregore83b9562015-07-07 03:57:53 +0000556 Record.push_back(T->getTypeArgsAsWritten().size());
557 for (auto TypeArg : T->getTypeArgsAsWritten())
Richard Smith69c82bf2016-04-01 22:52:03 +0000558 Record.AddTypeRef(TypeArg);
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000559 Record.push_back(T->getNumProtocols());
Aaron Ballman1683f7b2014-03-17 15:55:30 +0000560 for (const auto *I : T->quals())
Richard Smith69c82bf2016-04-01 22:52:03 +0000561 Record.AddDeclRef(I);
Douglas Gregorab209d82015-07-07 03:58:42 +0000562 Record.push_back(T->isKindOfTypeAsWritten());
Sebastian Redl539c5062010-08-18 23:57:32 +0000563 Code = TYPE_OBJC_OBJECT;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000564}
565
Steve Narofffb4330f2009-06-17 22:40:22 +0000566void
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000567ASTTypeWriter::VisitObjCObjectPointerType(const ObjCObjectPointerType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000568 Record.AddTypeRef(T->getPointeeType());
Sebastian Redl539c5062010-08-18 23:57:32 +0000569 Code = TYPE_OBJC_OBJECT_POINTER;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000570}
571
Eli Friedman0dfb8892011-10-06 23:00:33 +0000572void
573ASTTypeWriter::VisitAtomicType(const AtomicType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000574 Record.AddTypeRef(T->getValueType());
Eli Friedman0dfb8892011-10-06 23:00:33 +0000575 Code = TYPE_ATOMIC;
576}
577
Xiuli Pan9c14e282016-01-09 12:53:17 +0000578void
579ASTTypeWriter::VisitPipeType(const PipeType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000580 Record.AddTypeRef(T->getElementType());
Joey Goulye3c85de2016-12-01 11:30:49 +0000581 Record.push_back(T->isReadOnly());
582 Code = TYPE_PIPE;
Xiuli Pan9c14e282016-01-09 12:53:17 +0000583}
584
John McCall8f115c62009-10-16 21:56:05 +0000585namespace {
586
587class TypeLocWriter : public TypeLocVisitor<TypeLocWriter> {
Richard Smith290d8012016-04-06 17:06:00 +0000588 ASTRecordWriter &Record;
John McCall8f115c62009-10-16 21:56:05 +0000589
590public:
Eugene Zelenkob7d89102017-11-11 00:08:50 +0000591 TypeLocWriter(ASTRecordWriter &Record) : Record(Record) {}
John McCall8f115c62009-10-16 21:56:05 +0000592
John McCall17001972009-10-18 01:05:36 +0000593#define ABSTRACT_TYPELOC(CLASS, PARENT)
John McCall8f115c62009-10-16 21:56:05 +0000594#define TYPELOC(CLASS, PARENT) \
John McCall17001972009-10-18 01:05:36 +0000595 void Visit##CLASS##TypeLoc(CLASS##TypeLoc TyLoc);
John McCall8f115c62009-10-16 21:56:05 +0000596#include "clang/AST/TypeLocNodes.def"
597
John McCall17001972009-10-18 01:05:36 +0000598 void VisitArrayTypeLoc(ArrayTypeLoc TyLoc);
599 void VisitFunctionTypeLoc(FunctionTypeLoc TyLoc);
John McCall8f115c62009-10-16 21:56:05 +0000600};
601
Eugene Zelenkob7d89102017-11-11 00:08:50 +0000602} // namespace
John McCall8f115c62009-10-16 21:56:05 +0000603
John McCall17001972009-10-18 01:05:36 +0000604void TypeLocWriter::VisitQualifiedTypeLoc(QualifiedTypeLoc TL) {
605 // nothing to do
John McCall8f115c62009-10-16 21:56:05 +0000606}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000607
John McCall17001972009-10-18 01:05:36 +0000608void TypeLocWriter::VisitBuiltinTypeLoc(BuiltinTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000609 Record.AddSourceLocation(TL.getBuiltinLoc());
Douglas Gregorc9b7a592010-01-18 18:04:31 +0000610 if (TL.needsExtraLocalData()) {
Faisal Vali090da2d2018-01-01 18:23:28 +0000611 Record.push_back(TL.getWrittenTypeSpec());
612 Record.push_back(TL.getWrittenSignSpec());
613 Record.push_back(TL.getWrittenWidthSpec());
Douglas Gregorc9b7a592010-01-18 18:04:31 +0000614 Record.push_back(TL.hasModeAttr());
615 }
John McCall8f115c62009-10-16 21:56:05 +0000616}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000617
John McCall17001972009-10-18 01:05:36 +0000618void TypeLocWriter::VisitComplexTypeLoc(ComplexTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000619 Record.AddSourceLocation(TL.getNameLoc());
John McCall8f115c62009-10-16 21:56:05 +0000620}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000621
John McCall17001972009-10-18 01:05:36 +0000622void TypeLocWriter::VisitPointerTypeLoc(PointerTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000623 Record.AddSourceLocation(TL.getStarLoc());
John McCall8f115c62009-10-16 21:56:05 +0000624}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000625
Reid Kleckner8a365022013-06-24 17:51:48 +0000626void TypeLocWriter::VisitDecayedTypeLoc(DecayedTypeLoc TL) {
627 // nothing to do
628}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000629
Reid Kleckner0503a872013-12-05 01:23:43 +0000630void TypeLocWriter::VisitAdjustedTypeLoc(AdjustedTypeLoc TL) {
631 // nothing to do
632}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000633
John McCall17001972009-10-18 01:05:36 +0000634void TypeLocWriter::VisitBlockPointerTypeLoc(BlockPointerTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000635 Record.AddSourceLocation(TL.getCaretLoc());
John McCall8f115c62009-10-16 21:56:05 +0000636}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000637
John McCall17001972009-10-18 01:05:36 +0000638void TypeLocWriter::VisitLValueReferenceTypeLoc(LValueReferenceTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000639 Record.AddSourceLocation(TL.getAmpLoc());
John McCall8f115c62009-10-16 21:56:05 +0000640}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000641
John McCall17001972009-10-18 01:05:36 +0000642void TypeLocWriter::VisitRValueReferenceTypeLoc(RValueReferenceTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000643 Record.AddSourceLocation(TL.getAmpAmpLoc());
John McCall8f115c62009-10-16 21:56:05 +0000644}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000645
John McCall17001972009-10-18 01:05:36 +0000646void TypeLocWriter::VisitMemberPointerTypeLoc(MemberPointerTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000647 Record.AddSourceLocation(TL.getStarLoc());
648 Record.AddTypeSourceInfo(TL.getClassTInfo());
John McCall8f115c62009-10-16 21:56:05 +0000649}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000650
John McCall17001972009-10-18 01:05:36 +0000651void TypeLocWriter::VisitArrayTypeLoc(ArrayTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000652 Record.AddSourceLocation(TL.getLBracketLoc());
653 Record.AddSourceLocation(TL.getRBracketLoc());
John McCall17001972009-10-18 01:05:36 +0000654 Record.push_back(TL.getSizeExpr() ? 1 : 0);
655 if (TL.getSizeExpr())
Richard Smith290d8012016-04-06 17:06:00 +0000656 Record.AddStmt(TL.getSizeExpr());
John McCall8f115c62009-10-16 21:56:05 +0000657}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000658
John McCall17001972009-10-18 01:05:36 +0000659void TypeLocWriter::VisitConstantArrayTypeLoc(ConstantArrayTypeLoc TL) {
660 VisitArrayTypeLoc(TL);
661}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000662
John McCall17001972009-10-18 01:05:36 +0000663void TypeLocWriter::VisitIncompleteArrayTypeLoc(IncompleteArrayTypeLoc TL) {
664 VisitArrayTypeLoc(TL);
665}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000666
John McCall17001972009-10-18 01:05:36 +0000667void TypeLocWriter::VisitVariableArrayTypeLoc(VariableArrayTypeLoc TL) {
668 VisitArrayTypeLoc(TL);
669}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000670
John McCall17001972009-10-18 01:05:36 +0000671void TypeLocWriter::VisitDependentSizedArrayTypeLoc(
672 DependentSizedArrayTypeLoc TL) {
673 VisitArrayTypeLoc(TL);
674}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000675
Andrew Gozillon572bbb02017-10-02 06:25:51 +0000676void TypeLocWriter::VisitDependentAddressSpaceTypeLoc(
677 DependentAddressSpaceTypeLoc TL) {
678 Record.AddSourceLocation(TL.getAttrNameLoc());
679 SourceRange range = TL.getAttrOperandParensRange();
680 Record.AddSourceLocation(range.getBegin());
681 Record.AddSourceLocation(range.getEnd());
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +0000682 Record.AddStmt(TL.getAttrExprOperand());
Andrew Gozillon572bbb02017-10-02 06:25:51 +0000683}
684
John McCall17001972009-10-18 01:05:36 +0000685void TypeLocWriter::VisitDependentSizedExtVectorTypeLoc(
686 DependentSizedExtVectorTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000687 Record.AddSourceLocation(TL.getNameLoc());
John McCall17001972009-10-18 01:05:36 +0000688}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000689
John McCall17001972009-10-18 01:05:36 +0000690void TypeLocWriter::VisitVectorTypeLoc(VectorTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000691 Record.AddSourceLocation(TL.getNameLoc());
John McCall17001972009-10-18 01:05:36 +0000692}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000693
Erich Keanef702b022018-07-13 19:46:04 +0000694void TypeLocWriter::VisitDependentVectorTypeLoc(
695 DependentVectorTypeLoc TL) {
696 Record.AddSourceLocation(TL.getNameLoc());
697}
698
John McCall17001972009-10-18 01:05:36 +0000699void TypeLocWriter::VisitExtVectorTypeLoc(ExtVectorTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000700 Record.AddSourceLocation(TL.getNameLoc());
John McCall17001972009-10-18 01:05:36 +0000701}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000702
John McCall17001972009-10-18 01:05:36 +0000703void TypeLocWriter::VisitFunctionTypeLoc(FunctionTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000704 Record.AddSourceLocation(TL.getLocalRangeBegin());
705 Record.AddSourceLocation(TL.getLParenLoc());
706 Record.AddSourceLocation(TL.getRParenLoc());
Malcolm Parsonsa3220ce2017-01-12 16:11:28 +0000707 Record.AddSourceRange(TL.getExceptionSpecRange());
Richard Smith69c82bf2016-04-01 22:52:03 +0000708 Record.AddSourceLocation(TL.getLocalRangeEnd());
Alp Tokerb3fd5cf2014-01-21 00:32:38 +0000709 for (unsigned i = 0, e = TL.getNumParams(); i != e; ++i)
Richard Smith69c82bf2016-04-01 22:52:03 +0000710 Record.AddDeclRef(TL.getParam(i));
John McCall17001972009-10-18 01:05:36 +0000711}
Eugene Zelenkob7d89102017-11-11 00:08:50 +0000712
John McCall17001972009-10-18 01:05:36 +0000713void TypeLocWriter::VisitFunctionProtoTypeLoc(FunctionProtoTypeLoc TL) {
714 VisitFunctionTypeLoc(TL);
715}
Eugene Zelenkob7d89102017-11-11 00:08:50 +0000716
John McCall17001972009-10-18 01:05:36 +0000717void TypeLocWriter::VisitFunctionNoProtoTypeLoc(FunctionNoProtoTypeLoc TL) {
718 VisitFunctionTypeLoc(TL);
719}
Eugene Zelenkob7d89102017-11-11 00:08:50 +0000720
John McCallb96ec562009-12-04 22:46:56 +0000721void TypeLocWriter::VisitUnresolvedUsingTypeLoc(UnresolvedUsingTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000722 Record.AddSourceLocation(TL.getNameLoc());
John McCallb96ec562009-12-04 22:46:56 +0000723}
Eugene Zelenkob7d89102017-11-11 00:08:50 +0000724
John McCall17001972009-10-18 01:05:36 +0000725void TypeLocWriter::VisitTypedefTypeLoc(TypedefTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000726 Record.AddSourceLocation(TL.getNameLoc());
John McCall17001972009-10-18 01:05:36 +0000727}
Eugene Zelenkob7d89102017-11-11 00:08:50 +0000728
Manman Rene6be26c2016-09-13 17:25:08 +0000729void TypeLocWriter::VisitObjCTypeParamTypeLoc(ObjCTypeParamTypeLoc TL) {
730 if (TL.getNumProtocols()) {
731 Record.AddSourceLocation(TL.getProtocolLAngleLoc());
732 Record.AddSourceLocation(TL.getProtocolRAngleLoc());
733 }
734 for (unsigned i = 0, e = TL.getNumProtocols(); i != e; ++i)
735 Record.AddSourceLocation(TL.getProtocolLoc(i));
736}
Eugene Zelenkob7d89102017-11-11 00:08:50 +0000737
John McCall17001972009-10-18 01:05:36 +0000738void TypeLocWriter::VisitTypeOfExprTypeLoc(TypeOfExprTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000739 Record.AddSourceLocation(TL.getTypeofLoc());
740 Record.AddSourceLocation(TL.getLParenLoc());
741 Record.AddSourceLocation(TL.getRParenLoc());
John McCall17001972009-10-18 01:05:36 +0000742}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000743
John McCall17001972009-10-18 01:05:36 +0000744void TypeLocWriter::VisitTypeOfTypeLoc(TypeOfTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000745 Record.AddSourceLocation(TL.getTypeofLoc());
746 Record.AddSourceLocation(TL.getLParenLoc());
747 Record.AddSourceLocation(TL.getRParenLoc());
748 Record.AddTypeSourceInfo(TL.getUnderlyingTInfo());
John McCall17001972009-10-18 01:05:36 +0000749}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000750
John McCall17001972009-10-18 01:05:36 +0000751void TypeLocWriter::VisitDecltypeTypeLoc(DecltypeTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000752 Record.AddSourceLocation(TL.getNameLoc());
John McCall17001972009-10-18 01:05:36 +0000753}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000754
Alexis Hunte852b102011-05-24 22:41:36 +0000755void TypeLocWriter::VisitUnaryTransformTypeLoc(UnaryTransformTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000756 Record.AddSourceLocation(TL.getKWLoc());
757 Record.AddSourceLocation(TL.getLParenLoc());
758 Record.AddSourceLocation(TL.getRParenLoc());
759 Record.AddTypeSourceInfo(TL.getUnderlyingTInfo());
Alexis Hunte852b102011-05-24 22:41:36 +0000760}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000761
Richard Smith30482bc2011-02-20 03:19:35 +0000762void TypeLocWriter::VisitAutoTypeLoc(AutoTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000763 Record.AddSourceLocation(TL.getNameLoc());
Richard Smith30482bc2011-02-20 03:19:35 +0000764}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000765
Richard Smith600b5262017-01-26 20:40:47 +0000766void TypeLocWriter::VisitDeducedTemplateSpecializationTypeLoc(
767 DeducedTemplateSpecializationTypeLoc TL) {
768 Record.AddSourceLocation(TL.getTemplateNameLoc());
769}
770
John McCall17001972009-10-18 01:05:36 +0000771void TypeLocWriter::VisitRecordTypeLoc(RecordTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000772 Record.AddSourceLocation(TL.getNameLoc());
John McCall17001972009-10-18 01:05:36 +0000773}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000774
John McCall17001972009-10-18 01:05:36 +0000775void TypeLocWriter::VisitEnumTypeLoc(EnumTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000776 Record.AddSourceLocation(TL.getNameLoc());
John McCall17001972009-10-18 01:05:36 +0000777}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000778
John McCall81904512011-01-06 01:58:22 +0000779void TypeLocWriter::VisitAttributedTypeLoc(AttributedTypeLoc TL) {
Richard Smithe43e2b32018-08-20 21:47:29 +0000780 Record.AddAttr(TL.getAttr());
John McCall81904512011-01-06 01:58:22 +0000781}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000782
John McCall17001972009-10-18 01:05:36 +0000783void TypeLocWriter::VisitTemplateTypeParmTypeLoc(TemplateTypeParmTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000784 Record.AddSourceLocation(TL.getNameLoc());
John McCall17001972009-10-18 01:05:36 +0000785}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000786
John McCallcebee162009-10-18 09:09:24 +0000787void TypeLocWriter::VisitSubstTemplateTypeParmTypeLoc(
788 SubstTemplateTypeParmTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000789 Record.AddSourceLocation(TL.getNameLoc());
John McCallcebee162009-10-18 09:09:24 +0000790}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000791
Douglas Gregorada4b792011-01-14 02:55:32 +0000792void TypeLocWriter::VisitSubstTemplateTypeParmPackTypeLoc(
793 SubstTemplateTypeParmPackTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000794 Record.AddSourceLocation(TL.getNameLoc());
Douglas Gregorada4b792011-01-14 02:55:32 +0000795}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000796
John McCall17001972009-10-18 01:05:36 +0000797void TypeLocWriter::VisitTemplateSpecializationTypeLoc(
798 TemplateSpecializationTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000799 Record.AddSourceLocation(TL.getTemplateKeywordLoc());
800 Record.AddSourceLocation(TL.getTemplateNameLoc());
801 Record.AddSourceLocation(TL.getLAngleLoc());
802 Record.AddSourceLocation(TL.getRAngleLoc());
John McCall0ad16662009-10-29 08:12:44 +0000803 for (unsigned i = 0, e = TL.getNumArgs(); i != e; ++i)
Richard Smith69c82bf2016-04-01 22:52:03 +0000804 Record.AddTemplateArgumentLocInfo(TL.getArgLoc(i).getArgument().getKind(),
805 TL.getArgLoc(i).getLocInfo());
John McCall17001972009-10-18 01:05:36 +0000806}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000807
Abramo Bagnara924a8f32010-12-10 16:29:40 +0000808void TypeLocWriter::VisitParenTypeLoc(ParenTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000809 Record.AddSourceLocation(TL.getLParenLoc());
810 Record.AddSourceLocation(TL.getRParenLoc());
Abramo Bagnara924a8f32010-12-10 16:29:40 +0000811}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000812
Leonard Chanc72aaf62019-05-07 03:20:17 +0000813void TypeLocWriter::VisitMacroQualifiedTypeLoc(MacroQualifiedTypeLoc TL) {
814 Record.AddSourceLocation(TL.getExpansionLoc());
815}
816
Abramo Bagnara6150c882010-05-11 21:36:43 +0000817void TypeLocWriter::VisitElaboratedTypeLoc(ElaboratedTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000818 Record.AddSourceLocation(TL.getElaboratedKeywordLoc());
819 Record.AddNestedNameSpecifierLoc(TL.getQualifierLoc());
John McCall17001972009-10-18 01:05:36 +0000820}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000821
John McCalle78aac42010-03-10 03:28:59 +0000822void TypeLocWriter::VisitInjectedClassNameTypeLoc(InjectedClassNameTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000823 Record.AddSourceLocation(TL.getNameLoc());
John McCalle78aac42010-03-10 03:28:59 +0000824}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000825
Douglas Gregorc1d2d8a2010-03-31 17:34:00 +0000826void TypeLocWriter::VisitDependentNameTypeLoc(DependentNameTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000827 Record.AddSourceLocation(TL.getElaboratedKeywordLoc());
828 Record.AddNestedNameSpecifierLoc(TL.getQualifierLoc());
829 Record.AddSourceLocation(TL.getNameLoc());
John McCall17001972009-10-18 01:05:36 +0000830}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000831
John McCallc392f372010-06-11 00:33:02 +0000832void TypeLocWriter::VisitDependentTemplateSpecializationTypeLoc(
833 DependentTemplateSpecializationTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000834 Record.AddSourceLocation(TL.getElaboratedKeywordLoc());
835 Record.AddNestedNameSpecifierLoc(TL.getQualifierLoc());
836 Record.AddSourceLocation(TL.getTemplateKeywordLoc());
837 Record.AddSourceLocation(TL.getTemplateNameLoc());
838 Record.AddSourceLocation(TL.getLAngleLoc());
839 Record.AddSourceLocation(TL.getRAngleLoc());
John McCallc392f372010-06-11 00:33:02 +0000840 for (unsigned I = 0, E = TL.getNumArgs(); I != E; ++I)
Richard Smith69c82bf2016-04-01 22:52:03 +0000841 Record.AddTemplateArgumentLocInfo(TL.getArgLoc(I).getArgument().getKind(),
842 TL.getArgLoc(I).getLocInfo());
John McCallc392f372010-06-11 00:33:02 +0000843}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000844
Douglas Gregord2fa7662010-12-20 02:24:11 +0000845void TypeLocWriter::VisitPackExpansionTypeLoc(PackExpansionTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000846 Record.AddSourceLocation(TL.getEllipsisLoc());
Douglas Gregord2fa7662010-12-20 02:24:11 +0000847}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000848
John McCall17001972009-10-18 01:05:36 +0000849void TypeLocWriter::VisitObjCInterfaceTypeLoc(ObjCInterfaceTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000850 Record.AddSourceLocation(TL.getNameLoc());
John McCall8b07ec22010-05-15 11:32:37 +0000851}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000852
John McCall8b07ec22010-05-15 11:32:37 +0000853void TypeLocWriter::VisitObjCObjectTypeLoc(ObjCObjectTypeLoc TL) {
854 Record.push_back(TL.hasBaseTypeAsWritten());
Richard Smith69c82bf2016-04-01 22:52:03 +0000855 Record.AddSourceLocation(TL.getTypeArgsLAngleLoc());
856 Record.AddSourceLocation(TL.getTypeArgsRAngleLoc());
Douglas Gregore9d95f12015-07-07 03:57:35 +0000857 for (unsigned i = 0, e = TL.getNumTypeArgs(); i != e; ++i)
Richard Smith69c82bf2016-04-01 22:52:03 +0000858 Record.AddTypeSourceInfo(TL.getTypeArgTInfo(i));
859 Record.AddSourceLocation(TL.getProtocolLAngleLoc());
860 Record.AddSourceLocation(TL.getProtocolRAngleLoc());
John McCall17001972009-10-18 01:05:36 +0000861 for (unsigned i = 0, e = TL.getNumProtocols(); i != e; ++i)
Richard Smith69c82bf2016-04-01 22:52:03 +0000862 Record.AddSourceLocation(TL.getProtocolLoc(i));
John McCall8f115c62009-10-16 21:56:05 +0000863}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000864
John McCallfc93cf92009-10-22 22:37:11 +0000865void TypeLocWriter::VisitObjCObjectPointerTypeLoc(ObjCObjectPointerTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000866 Record.AddSourceLocation(TL.getStarLoc());
John McCallfc93cf92009-10-22 22:37:11 +0000867}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000868
Eli Friedman0dfb8892011-10-06 23:00:33 +0000869void TypeLocWriter::VisitAtomicTypeLoc(AtomicTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000870 Record.AddSourceLocation(TL.getKWLoc());
871 Record.AddSourceLocation(TL.getLParenLoc());
872 Record.AddSourceLocation(TL.getRParenLoc());
Eli Friedman0dfb8892011-10-06 23:00:33 +0000873}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000874
Xiuli Pan9c14e282016-01-09 12:53:17 +0000875void TypeLocWriter::VisitPipeTypeLoc(PipeTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000876 Record.AddSourceLocation(TL.getKWLoc());
Xiuli Pan9c14e282016-01-09 12:53:17 +0000877}
John McCall8f115c62009-10-16 21:56:05 +0000878
Richard Smith01b2cb42014-07-26 06:37:51 +0000879void ASTWriter::WriteTypeAbbrevs() {
880 using namespace llvm;
881
David Blaikieb44f0bf2017-01-04 22:36:43 +0000882 std::shared_ptr<BitCodeAbbrev> Abv;
Richard Smith01b2cb42014-07-26 06:37:51 +0000883
884 // Abbreviation for TYPE_EXT_QUAL
David Blaikieb44f0bf2017-01-04 22:36:43 +0000885 Abv = std::make_shared<BitCodeAbbrev>();
Richard Smith01b2cb42014-07-26 06:37:51 +0000886 Abv->Add(BitCodeAbbrevOp(serialization::TYPE_EXT_QUAL));
887 Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Type
888 Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 3)); // Quals
David Blaikieb44f0bf2017-01-04 22:36:43 +0000889 TypeExtQualAbbrev = Stream.EmitAbbrev(std::move(Abv));
Richard Smith01b2cb42014-07-26 06:37:51 +0000890
891 // Abbreviation for TYPE_FUNCTION_PROTO
David Blaikieb44f0bf2017-01-04 22:36:43 +0000892 Abv = std::make_shared<BitCodeAbbrev>();
Richard Smith01b2cb42014-07-26 06:37:51 +0000893 Abv->Add(BitCodeAbbrevOp(serialization::TYPE_FUNCTION_PROTO));
894 // FunctionType
895 Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // ReturnType
896 Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // NoReturn
897 Abv->Add(BitCodeAbbrevOp(0)); // HasRegParm
898 Abv->Add(BitCodeAbbrevOp(0)); // RegParm
899 Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 4)); // CC
900 Abv->Add(BitCodeAbbrevOp(0)); // ProducesResult
Oren Ben Simhon318a6ea2017-04-27 12:01:00 +0000901 Abv->Add(BitCodeAbbrevOp(0)); // NoCallerSavedRegs
Oren Ben Simhon220671a2018-03-17 13:31:35 +0000902 Abv->Add(BitCodeAbbrevOp(0)); // NoCfCheck
Richard Smith01b2cb42014-07-26 06:37:51 +0000903 // FunctionProtoType
904 Abv->Add(BitCodeAbbrevOp(0)); // IsVariadic
905 Abv->Add(BitCodeAbbrevOp(0)); // HasTrailingReturn
906 Abv->Add(BitCodeAbbrevOp(0)); // TypeQuals
907 Abv->Add(BitCodeAbbrevOp(0)); // RefQualifier
908 Abv->Add(BitCodeAbbrevOp(EST_None)); // ExceptionSpec
909 Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // NumParams
910 Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
911 Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Params
David Blaikieb44f0bf2017-01-04 22:36:43 +0000912 TypeFunctionProtoAbbrev = Stream.EmitAbbrev(std::move(Abv));
Richard Smith01b2cb42014-07-26 06:37:51 +0000913}
914
Chris Lattner19cea4e2009-04-22 05:57:30 +0000915//===----------------------------------------------------------------------===//
Sebastian Redl55c0ad52010-08-18 23:56:21 +0000916// ASTWriter Implementation
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000917//===----------------------------------------------------------------------===//
918
Chris Lattner28fa4e62009-04-26 22:26:21 +0000919static void EmitBlockID(unsigned ID, const char *Name,
920 llvm::BitstreamWriter &Stream,
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +0000921 ASTWriter::RecordDataImpl &Record) {
Chris Lattner28fa4e62009-04-26 22:26:21 +0000922 Record.clear();
923 Record.push_back(ID);
924 Stream.EmitRecord(llvm::bitc::BLOCKINFO_CODE_SETBID, Record);
925
926 // Emit the block name if present.
Craig Toppera13603a2014-05-22 05:54:18 +0000927 if (!Name || Name[0] == 0)
928 return;
Chris Lattner28fa4e62009-04-26 22:26:21 +0000929 Record.clear();
930 while (*Name)
931 Record.push_back(*Name++);
932 Stream.EmitRecord(llvm::bitc::BLOCKINFO_CODE_BLOCKNAME, Record);
933}
934
935static void EmitRecordID(unsigned ID, const char *Name,
936 llvm::BitstreamWriter &Stream,
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +0000937 ASTWriter::RecordDataImpl &Record) {
Chris Lattner28fa4e62009-04-26 22:26:21 +0000938 Record.clear();
939 Record.push_back(ID);
940 while (*Name)
941 Record.push_back(*Name++);
942 Stream.EmitRecord(llvm::bitc::BLOCKINFO_CODE_SETRECORDNAME, Record);
Chris Lattnerccac3a62009-04-27 00:49:53 +0000943}
944
945static void AddStmtsExprs(llvm::BitstreamWriter &Stream,
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +0000946 ASTWriter::RecordDataImpl &Record) {
Sebastian Redl539c5062010-08-18 23:57:32 +0000947#define RECORD(X) EmitRecordID(X, #X, Stream, Record)
Chris Lattnerccac3a62009-04-27 00:49:53 +0000948 RECORD(STMT_STOP);
949 RECORD(STMT_NULL_PTR);
Richard Smith01b2cb42014-07-26 06:37:51 +0000950 RECORD(STMT_REF_PTR);
Chris Lattnerccac3a62009-04-27 00:49:53 +0000951 RECORD(STMT_NULL);
952 RECORD(STMT_COMPOUND);
953 RECORD(STMT_CASE);
954 RECORD(STMT_DEFAULT);
955 RECORD(STMT_LABEL);
Richard Smithc202b282012-04-14 00:33:13 +0000956 RECORD(STMT_ATTRIBUTED);
Chris Lattnerccac3a62009-04-27 00:49:53 +0000957 RECORD(STMT_IF);
958 RECORD(STMT_SWITCH);
959 RECORD(STMT_WHILE);
960 RECORD(STMT_DO);
961 RECORD(STMT_FOR);
962 RECORD(STMT_GOTO);
963 RECORD(STMT_INDIRECT_GOTO);
964 RECORD(STMT_CONTINUE);
965 RECORD(STMT_BREAK);
966 RECORD(STMT_RETURN);
967 RECORD(STMT_DECL);
Chad Rosierde70e0e2012-08-25 00:11:56 +0000968 RECORD(STMT_GCCASM);
Chad Rosiere30d4992012-08-24 23:51:02 +0000969 RECORD(STMT_MSASM);
Chris Lattnerccac3a62009-04-27 00:49:53 +0000970 RECORD(EXPR_PREDEFINED);
971 RECORD(EXPR_DECL_REF);
972 RECORD(EXPR_INTEGER_LITERAL);
973 RECORD(EXPR_FLOATING_LITERAL);
974 RECORD(EXPR_IMAGINARY_LITERAL);
975 RECORD(EXPR_STRING_LITERAL);
976 RECORD(EXPR_CHARACTER_LITERAL);
977 RECORD(EXPR_PAREN);
Richard Smithf1b4b8b2014-07-27 04:29:04 +0000978 RECORD(EXPR_PAREN_LIST);
Chris Lattnerccac3a62009-04-27 00:49:53 +0000979 RECORD(EXPR_UNARY_OPERATOR);
980 RECORD(EXPR_SIZEOF_ALIGN_OF);
981 RECORD(EXPR_ARRAY_SUBSCRIPT);
982 RECORD(EXPR_CALL);
983 RECORD(EXPR_MEMBER);
984 RECORD(EXPR_BINARY_OPERATOR);
985 RECORD(EXPR_COMPOUND_ASSIGN_OPERATOR);
986 RECORD(EXPR_CONDITIONAL_OPERATOR);
987 RECORD(EXPR_IMPLICIT_CAST);
988 RECORD(EXPR_CSTYLE_CAST);
989 RECORD(EXPR_COMPOUND_LITERAL);
990 RECORD(EXPR_EXT_VECTOR_ELEMENT);
991 RECORD(EXPR_INIT_LIST);
992 RECORD(EXPR_DESIGNATED_INIT);
Yunzhong Gaocb779302015-06-10 00:27:52 +0000993 RECORD(EXPR_DESIGNATED_INIT_UPDATE);
Chris Lattnerccac3a62009-04-27 00:49:53 +0000994 RECORD(EXPR_IMPLICIT_VALUE_INIT);
Yunzhong Gaocb779302015-06-10 00:27:52 +0000995 RECORD(EXPR_NO_INIT);
Chris Lattnerccac3a62009-04-27 00:49:53 +0000996 RECORD(EXPR_VA_ARG);
997 RECORD(EXPR_ADDR_LABEL);
998 RECORD(EXPR_STMT);
Chris Lattnerccac3a62009-04-27 00:49:53 +0000999 RECORD(EXPR_CHOOSE);
1000 RECORD(EXPR_GNU_NULL);
1001 RECORD(EXPR_SHUFFLE_VECTOR);
1002 RECORD(EXPR_BLOCK);
Peter Collingbourne91147592011-04-15 00:35:48 +00001003 RECORD(EXPR_GENERIC_SELECTION);
Chris Lattnerccac3a62009-04-27 00:49:53 +00001004 RECORD(EXPR_OBJC_STRING_LITERAL);
Patrick Beard0caa3942012-04-19 00:25:12 +00001005 RECORD(EXPR_OBJC_BOXED_EXPRESSION);
Ted Kremeneke65b0862012-03-06 20:05:56 +00001006 RECORD(EXPR_OBJC_ARRAY_LITERAL);
1007 RECORD(EXPR_OBJC_DICTIONARY_LITERAL);
Chris Lattnerccac3a62009-04-27 00:49:53 +00001008 RECORD(EXPR_OBJC_ENCODE);
1009 RECORD(EXPR_OBJC_SELECTOR_EXPR);
1010 RECORD(EXPR_OBJC_PROTOCOL_EXPR);
1011 RECORD(EXPR_OBJC_IVAR_REF_EXPR);
1012 RECORD(EXPR_OBJC_PROPERTY_REF_EXPR);
1013 RECORD(EXPR_OBJC_KVC_REF_EXPR);
1014 RECORD(EXPR_OBJC_MESSAGE_EXPR);
Chris Lattnerccac3a62009-04-27 00:49:53 +00001015 RECORD(STMT_OBJC_FOR_COLLECTION);
1016 RECORD(STMT_OBJC_CATCH);
1017 RECORD(STMT_OBJC_FINALLY);
1018 RECORD(STMT_OBJC_AT_TRY);
1019 RECORD(STMT_OBJC_AT_SYNCHRONIZED);
1020 RECORD(STMT_OBJC_AT_THROW);
Ted Kremeneke65b0862012-03-06 20:05:56 +00001021 RECORD(EXPR_OBJC_BOOL_LITERAL);
Richard Smith01b2cb42014-07-26 06:37:51 +00001022 RECORD(STMT_CXX_CATCH);
1023 RECORD(STMT_CXX_TRY);
1024 RECORD(STMT_CXX_FOR_RANGE);
Sam Weinige83b3ac2010-02-07 06:32:43 +00001025 RECORD(EXPR_CXX_OPERATOR_CALL);
Richard Smithf1b4b8b2014-07-27 04:29:04 +00001026 RECORD(EXPR_CXX_MEMBER_CALL);
Sam Weinige83b3ac2010-02-07 06:32:43 +00001027 RECORD(EXPR_CXX_CONSTRUCT);
Richard Smithf1b4b8b2014-07-27 04:29:04 +00001028 RECORD(EXPR_CXX_TEMPORARY_OBJECT);
Sam Weinige83b3ac2010-02-07 06:32:43 +00001029 RECORD(EXPR_CXX_STATIC_CAST);
1030 RECORD(EXPR_CXX_DYNAMIC_CAST);
1031 RECORD(EXPR_CXX_REINTERPRET_CAST);
1032 RECORD(EXPR_CXX_CONST_CAST);
1033 RECORD(EXPR_CXX_FUNCTIONAL_CAST);
Richard Smithc67fdd42012-03-07 08:35:16 +00001034 RECORD(EXPR_USER_DEFINED_LITERAL);
Richard Smithcc1b96d2013-06-12 22:31:48 +00001035 RECORD(EXPR_CXX_STD_INITIALIZER_LIST);
Sam Weinige83b3ac2010-02-07 06:32:43 +00001036 RECORD(EXPR_CXX_BOOL_LITERAL);
1037 RECORD(EXPR_CXX_NULL_PTR_LITERAL);
Douglas Gregor0beaec02011-02-08 16:34:17 +00001038 RECORD(EXPR_CXX_TYPEID_EXPR);
1039 RECORD(EXPR_CXX_TYPEID_TYPE);
Douglas Gregor0beaec02011-02-08 16:34:17 +00001040 RECORD(EXPR_CXX_THIS);
1041 RECORD(EXPR_CXX_THROW);
1042 RECORD(EXPR_CXX_DEFAULT_ARG);
Richard Smith01b2cb42014-07-26 06:37:51 +00001043 RECORD(EXPR_CXX_DEFAULT_INIT);
Douglas Gregor0beaec02011-02-08 16:34:17 +00001044 RECORD(EXPR_CXX_BIND_TEMPORARY);
1045 RECORD(EXPR_CXX_SCALAR_VALUE_INIT);
1046 RECORD(EXPR_CXX_NEW);
1047 RECORD(EXPR_CXX_DELETE);
1048 RECORD(EXPR_CXX_PSEUDO_DESTRUCTOR);
1049 RECORD(EXPR_EXPR_WITH_CLEANUPS);
1050 RECORD(EXPR_CXX_DEPENDENT_SCOPE_MEMBER);
1051 RECORD(EXPR_CXX_DEPENDENT_SCOPE_DECL_REF);
1052 RECORD(EXPR_CXX_UNRESOLVED_CONSTRUCT);
1053 RECORD(EXPR_CXX_UNRESOLVED_MEMBER);
1054 RECORD(EXPR_CXX_UNRESOLVED_LOOKUP);
Richard Smith01b2cb42014-07-26 06:37:51 +00001055 RECORD(EXPR_CXX_EXPRESSION_TRAIT);
Douglas Gregor0beaec02011-02-08 16:34:17 +00001056 RECORD(EXPR_CXX_NOEXCEPT);
1057 RECORD(EXPR_OPAQUE_VALUE);
Richard Smith01b2cb42014-07-26 06:37:51 +00001058 RECORD(EXPR_BINARY_CONDITIONAL_OPERATOR);
1059 RECORD(EXPR_TYPE_TRAIT);
1060 RECORD(EXPR_ARRAY_TYPE_TRAIT);
Douglas Gregor0beaec02011-02-08 16:34:17 +00001061 RECORD(EXPR_PACK_EXPANSION);
1062 RECORD(EXPR_SIZEOF_PACK);
Richard Smith01b2cb42014-07-26 06:37:51 +00001063 RECORD(EXPR_SUBST_NON_TYPE_TEMPLATE_PARM);
Douglas Gregor0beaec02011-02-08 16:34:17 +00001064 RECORD(EXPR_SUBST_NON_TYPE_TEMPLATE_PARM_PACK);
Richard Smith01b2cb42014-07-26 06:37:51 +00001065 RECORD(EXPR_FUNCTION_PARM_PACK);
1066 RECORD(EXPR_MATERIALIZE_TEMPORARY);
Peter Collingbourne41f85462011-02-09 21:07:24 +00001067 RECORD(EXPR_CUDA_KERNEL_CALL);
Richard Smith01b2cb42014-07-26 06:37:51 +00001068 RECORD(EXPR_CXX_UUIDOF_EXPR);
1069 RECORD(EXPR_CXX_UUIDOF_TYPE);
1070 RECORD(EXPR_LAMBDA);
Chris Lattnerccac3a62009-04-27 00:49:53 +00001071#undef RECORD
Chris Lattner28fa4e62009-04-26 22:26:21 +00001072}
Mike Stump11289f42009-09-09 15:08:12 +00001073
Sebastian Redl55c0ad52010-08-18 23:56:21 +00001074void ASTWriter::WriteBlockInfoBlock() {
Chris Lattner28fa4e62009-04-26 22:26:21 +00001075 RecordData Record;
Peter Collingbourned3a6c702016-11-01 01:18:57 +00001076 Stream.EnterBlockInfoBlock();
Mike Stump11289f42009-09-09 15:08:12 +00001077
Sebastian Redl539c5062010-08-18 23:57:32 +00001078#define BLOCK(X) EmitBlockID(X ## _ID, #X, Stream, Record)
1079#define RECORD(X) EmitRecordID(X, #X, Stream, Record)
Mike Stump11289f42009-09-09 15:08:12 +00001080
Douglas Gregor0aa21c92012-10-18 18:27:37 +00001081 // Control Block.
1082 BLOCK(CONTROL_BLOCK);
1083 RECORD(METADATA);
Ben Langmuirbeee15e2014-04-14 18:00:01 +00001084 RECORD(MODULE_NAME);
Richard Smithfa715652015-08-31 22:43:10 +00001085 RECORD(MODULE_DIRECTORY);
Ben Langmuirbeee15e2014-04-14 18:00:01 +00001086 RECORD(MODULE_MAP_FILE);
Douglas Gregor0aa21c92012-10-18 18:27:37 +00001087 RECORD(IMPORTS);
Douglas Gregorfad10d82012-10-18 18:36:53 +00001088 RECORD(ORIGINAL_FILE);
Douglas Gregor0aa21c92012-10-18 18:27:37 +00001089 RECORD(ORIGINAL_PCH_DIR);
Argyrios Kyrtzidis52595242012-11-15 18:57:27 +00001090 RECORD(ORIGINAL_FILE_ID);
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001091 RECORD(INPUT_FILE_OFFSETS);
Richard Smith0516b182015-09-08 19:40:14 +00001092
1093 BLOCK(OPTIONS_BLOCK);
1094 RECORD(LANGUAGE_OPTIONS);
1095 RECORD(TARGET_OPTIONS);
Douglas Gregorc6317db2012-10-24 15:49:58 +00001096 RECORD(FILE_SYSTEM_OPTIONS);
Douglas Gregor2d302362012-10-24 16:50:34 +00001097 RECORD(HEADER_SEARCH_OPTIONS);
Douglas Gregorb6af6c22012-10-24 20:05:57 +00001098 RECORD(PREPROCESSOR_OPTIONS);
1099
Douglas Gregor108cb222012-10-19 00:45:00 +00001100 BLOCK(INPUT_FILES_BLOCK);
1101 RECORD(INPUT_FILE);
Bruno Cardoso Lopes1731fc82019-10-15 14:23:55 +00001102 RECORD(INPUT_FILE_HASH);
Douglas Gregor108cb222012-10-19 00:45:00 +00001103
Douglas Gregor0aa21c92012-10-18 18:27:37 +00001104 // AST Top-Level Block.
1105 BLOCK(AST_BLOCK);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001106 RECORD(TYPE_OFFSET);
1107 RECORD(DECL_OFFSET);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001108 RECORD(IDENTIFIER_OFFSET);
1109 RECORD(IDENTIFIER_TABLE);
Ben Langmuir332aafe2014-01-31 01:06:56 +00001110 RECORD(EAGERLY_DESERIALIZED_DECLS);
David Blaikie9ffe5a32017-01-30 05:00:26 +00001111 RECORD(MODULAR_CODEGEN_DECLS);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001112 RECORD(SPECIAL_TYPES);
1113 RECORD(STATISTICS);
1114 RECORD(TENTATIVE_DEFINITIONS);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001115 RECORD(SELECTOR_OFFSETS);
1116 RECORD(METHOD_POOL);
1117 RECORD(PP_COUNTER_VALUE);
Douglas Gregor258ae542009-04-27 06:38:32 +00001118 RECORD(SOURCE_LOCATION_OFFSETS);
1119 RECORD(SOURCE_LOCATION_PRELOADS);
Douglas Gregor61cac2b2009-04-27 20:06:05 +00001120 RECORD(EXT_VECTOR_DECLS);
Richard Smithfa715652015-08-31 22:43:10 +00001121 RECORD(UNUSED_FILESCOPED_DECLS);
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00001122 RECORD(PPD_ENTITIES_OFFSETS);
Richard Smithfa715652015-08-31 22:43:10 +00001123 RECORD(VTABLE_USES);
Cameron Desrochersb60f1b62018-01-15 19:14:16 +00001124 RECORD(PPD_SKIPPED_RANGES);
Fariborz Jahanianc51609a2010-07-23 19:11:11 +00001125 RECORD(REFERENCED_SELECTOR_POOL);
Douglas Gregor0beaec02011-02-08 16:34:17 +00001126 RECORD(TU_UPDATE_LEXICAL);
Douglas Gregor0beaec02011-02-08 16:34:17 +00001127 RECORD(SEMA_DECL_REFS);
1128 RECORD(WEAK_UNDECLARED_IDENTIFIERS);
1129 RECORD(PENDING_IMPLICIT_INSTANTIATIONS);
Douglas Gregor0beaec02011-02-08 16:34:17 +00001130 RECORD(UPDATE_VISIBLE);
1131 RECORD(DECL_UPDATE_OFFSETS);
1132 RECORD(DECL_UPDATES);
Peter Collingbourne5df20e02011-02-15 19:46:30 +00001133 RECORD(CUDA_SPECIAL_DECL_REFS);
Douglas Gregor09b69892011-02-10 17:09:37 +00001134 RECORD(HEADER_SEARCH_TABLE);
Peter Collingbourne5df20e02011-02-15 19:46:30 +00001135 RECORD(FP_PRAGMA_OPTIONS);
1136 RECORD(OPENCL_EXTENSIONS);
Yaxun Liu5b746652016-12-18 05:18:55 +00001137 RECORD(OPENCL_EXTENSION_TYPES);
1138 RECORD(OPENCL_EXTENSION_DECLS);
Alexis Hunt27a761d2011-05-04 23:29:54 +00001139 RECORD(DELEGATING_CTORS);
Douglas Gregorc2fa1692011-06-28 16:20:02 +00001140 RECORD(KNOWN_NAMESPACES);
Douglas Gregor78d0b572011-08-04 16:39:39 +00001141 RECORD(MODULE_OFFSET_MAP);
1142 RECORD(SOURCE_MANAGER_LINE_TABLE);
Douglas Gregor404cdde2012-01-27 01:47:08 +00001143 RECORD(OBJC_CATEGORIES_MAP);
Douglas Gregor66e4add2011-12-19 21:09:25 +00001144 RECORD(FILE_SORTED_DECLS);
1145 RECORD(IMPORTED_MODULES);
Douglas Gregor404cdde2012-01-27 01:47:08 +00001146 RECORD(OBJC_CATEGORIES);
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00001147 RECORD(MACRO_OFFSET);
Richard Smithfa715652015-08-31 22:43:10 +00001148 RECORD(INTERESTING_IDENTIFIERS);
1149 RECORD(UNDEFINED_BUT_USED);
Richard Smithe40f2ba2013-08-07 21:41:30 +00001150 RECORD(LATE_PARSED_TEMPLATE);
Dario Domizioli13a0a382014-05-23 12:13:25 +00001151 RECORD(OPTIMIZE_PRAGMA_OPTIONS);
Nico Weber779355f2016-03-02 23:22:00 +00001152 RECORD(MSSTRUCT_PRAGMA_OPTIONS);
Nico Weber42932312016-03-03 00:17:35 +00001153 RECORD(POINTERS_TO_MEMBERS_PRAGMA_OPTIONS);
Richard Smithfa715652015-08-31 22:43:10 +00001154 RECORD(UNUSED_LOCAL_TYPEDEF_NAME_CANDIDATES);
Richard Smithfa715652015-08-31 22:43:10 +00001155 RECORD(DELETE_EXPRS_TO_ANALYZE);
Justin Lebar67a78a62016-10-08 22:15:58 +00001156 RECORD(CUDA_PRAGMA_FORCE_HOST_DEVICE_DEPTH);
Erik Verbruggenb34c79f2017-05-30 11:54:55 +00001157 RECORD(PP_CONDITIONAL_STACK);
Douglas Gregor358cd442012-01-15 16:58:34 +00001158
Chris Lattner28fa4e62009-04-26 22:26:21 +00001159 // SourceManager Block.
Chris Lattner64031982009-04-27 00:40:25 +00001160 BLOCK(SOURCE_MANAGER_BLOCK);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001161 RECORD(SM_SLOC_FILE_ENTRY);
1162 RECORD(SM_SLOC_BUFFER_ENTRY);
1163 RECORD(SM_SLOC_BUFFER_BLOB);
Richard Smithaada85c2016-02-06 02:06:43 +00001164 RECORD(SM_SLOC_BUFFER_BLOB_COMPRESSED);
Chandler Carruthf92ac9e2011-07-15 07:25:21 +00001165 RECORD(SM_SLOC_EXPANSION_ENTRY);
Mike Stump11289f42009-09-09 15:08:12 +00001166
Chris Lattner28fa4e62009-04-26 22:26:21 +00001167 // Preprocessor Block.
Chris Lattner64031982009-04-27 00:40:25 +00001168 BLOCK(PREPROCESSOR_BLOCK);
Richard Smithec216502015-02-13 19:48:37 +00001169 RECORD(PP_MACRO_DIRECTIVE_HISTORY);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001170 RECORD(PP_MACRO_FUNCTION_LIKE);
Richard Smithd7329392015-04-21 21:46:32 +00001171 RECORD(PP_MACRO_OBJECT_LIKE);
1172 RECORD(PP_MODULE_MACRO);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001173 RECORD(PP_TOKEN);
Richard Smithec216502015-02-13 19:48:37 +00001174
Richard Smithfa715652015-08-31 22:43:10 +00001175 // Submodule Block.
1176 BLOCK(SUBMODULE_BLOCK);
1177 RECORD(SUBMODULE_METADATA);
1178 RECORD(SUBMODULE_DEFINITION);
1179 RECORD(SUBMODULE_UMBRELLA_HEADER);
1180 RECORD(SUBMODULE_HEADER);
1181 RECORD(SUBMODULE_TOPHEADER);
1182 RECORD(SUBMODULE_UMBRELLA_DIR);
1183 RECORD(SUBMODULE_IMPORTS);
1184 RECORD(SUBMODULE_EXPORTS);
1185 RECORD(SUBMODULE_REQUIRES);
1186 RECORD(SUBMODULE_EXCLUDED_HEADER);
1187 RECORD(SUBMODULE_LINK_LIBRARY);
1188 RECORD(SUBMODULE_CONFIG_MACRO);
1189 RECORD(SUBMODULE_CONFLICT);
1190 RECORD(SUBMODULE_PRIVATE_HEADER);
1191 RECORD(SUBMODULE_TEXTUAL_HEADER);
1192 RECORD(SUBMODULE_PRIVATE_TEXTUAL_HEADER);
Richard Smithdc1f0422016-07-20 19:10:16 +00001193 RECORD(SUBMODULE_INITIALIZERS);
Douglas Gregorf0b11de2017-09-14 23:38:44 +00001194 RECORD(SUBMODULE_EXPORT_AS);
Richard Smithfa715652015-08-31 22:43:10 +00001195
1196 // Comments Block.
1197 BLOCK(COMMENTS_BLOCK);
1198 RECORD(COMMENTS_RAW_COMMENT);
1199
Douglas Gregor12bfa382009-10-17 00:13:19 +00001200 // Decls and Types block.
1201 BLOCK(DECLTYPES_BLOCK);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001202 RECORD(TYPE_EXT_QUAL);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001203 RECORD(TYPE_COMPLEX);
1204 RECORD(TYPE_POINTER);
1205 RECORD(TYPE_BLOCK_POINTER);
1206 RECORD(TYPE_LVALUE_REFERENCE);
1207 RECORD(TYPE_RVALUE_REFERENCE);
1208 RECORD(TYPE_MEMBER_POINTER);
1209 RECORD(TYPE_CONSTANT_ARRAY);
1210 RECORD(TYPE_INCOMPLETE_ARRAY);
1211 RECORD(TYPE_VARIABLE_ARRAY);
1212 RECORD(TYPE_VECTOR);
1213 RECORD(TYPE_EXT_VECTOR);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001214 RECORD(TYPE_FUNCTION_NO_PROTO);
Richard Smithf1b4b8b2014-07-27 04:29:04 +00001215 RECORD(TYPE_FUNCTION_PROTO);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001216 RECORD(TYPE_TYPEDEF);
1217 RECORD(TYPE_TYPEOF_EXPR);
1218 RECORD(TYPE_TYPEOF);
1219 RECORD(TYPE_RECORD);
1220 RECORD(TYPE_ENUM);
1221 RECORD(TYPE_OBJC_INTERFACE);
Steve Narofffb4330f2009-06-17 22:40:22 +00001222 RECORD(TYPE_OBJC_OBJECT_POINTER);
Douglas Gregor0beaec02011-02-08 16:34:17 +00001223 RECORD(TYPE_DECLTYPE);
1224 RECORD(TYPE_ELABORATED);
1225 RECORD(TYPE_SUBST_TEMPLATE_TYPE_PARM);
1226 RECORD(TYPE_UNRESOLVED_USING);
1227 RECORD(TYPE_INJECTED_CLASS_NAME);
1228 RECORD(TYPE_OBJC_OBJECT);
1229 RECORD(TYPE_TEMPLATE_TYPE_PARM);
1230 RECORD(TYPE_TEMPLATE_SPECIALIZATION);
1231 RECORD(TYPE_DEPENDENT_NAME);
1232 RECORD(TYPE_DEPENDENT_TEMPLATE_SPECIALIZATION);
1233 RECORD(TYPE_DEPENDENT_SIZED_ARRAY);
1234 RECORD(TYPE_PAREN);
Leonard Chanc72aaf62019-05-07 03:20:17 +00001235 RECORD(TYPE_MACRO_QUALIFIED);
Douglas Gregor0beaec02011-02-08 16:34:17 +00001236 RECORD(TYPE_PACK_EXPANSION);
1237 RECORD(TYPE_ATTRIBUTED);
1238 RECORD(TYPE_SUBST_TEMPLATE_TYPE_PARM_PACK);
Richard Smithf1b4b8b2014-07-27 04:29:04 +00001239 RECORD(TYPE_AUTO);
1240 RECORD(TYPE_UNARY_TRANSFORM);
Eli Friedman0dfb8892011-10-06 23:00:33 +00001241 RECORD(TYPE_ATOMIC);
Richard Smithf1b4b8b2014-07-27 04:29:04 +00001242 RECORD(TYPE_DECAYED);
1243 RECORD(TYPE_ADJUSTED);
Manman Rene6be26c2016-09-13 17:25:08 +00001244 RECORD(TYPE_OBJC_TYPE_PARAM);
Richard Smithd61d4ac2015-08-22 20:13:39 +00001245 RECORD(LOCAL_REDECLARATIONS);
Chris Lattnerdb397b62009-04-26 22:32:16 +00001246 RECORD(DECL_TYPEDEF);
Richard Smith01b2cb42014-07-26 06:37:51 +00001247 RECORD(DECL_TYPEALIAS);
Chris Lattnerdb397b62009-04-26 22:32:16 +00001248 RECORD(DECL_ENUM);
1249 RECORD(DECL_RECORD);
1250 RECORD(DECL_ENUM_CONSTANT);
1251 RECORD(DECL_FUNCTION);
1252 RECORD(DECL_OBJC_METHOD);
1253 RECORD(DECL_OBJC_INTERFACE);
1254 RECORD(DECL_OBJC_PROTOCOL);
1255 RECORD(DECL_OBJC_IVAR);
1256 RECORD(DECL_OBJC_AT_DEFS_FIELD);
Chris Lattnerdb397b62009-04-26 22:32:16 +00001257 RECORD(DECL_OBJC_CATEGORY);
1258 RECORD(DECL_OBJC_CATEGORY_IMPL);
1259 RECORD(DECL_OBJC_IMPLEMENTATION);
1260 RECORD(DECL_OBJC_COMPATIBLE_ALIAS);
1261 RECORD(DECL_OBJC_PROPERTY);
1262 RECORD(DECL_OBJC_PROPERTY_IMPL);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001263 RECORD(DECL_FIELD);
John McCall5e77d762013-04-16 07:28:30 +00001264 RECORD(DECL_MS_PROPERTY);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001265 RECORD(DECL_VAR);
Chris Lattnerdb397b62009-04-26 22:32:16 +00001266 RECORD(DECL_IMPLICIT_PARAM);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001267 RECORD(DECL_PARM_VAR);
Chris Lattnerdb397b62009-04-26 22:32:16 +00001268 RECORD(DECL_FILE_SCOPE_ASM);
1269 RECORD(DECL_BLOCK);
1270 RECORD(DECL_CONTEXT_LEXICAL);
1271 RECORD(DECL_CONTEXT_VISIBLE);
Douglas Gregor0beaec02011-02-08 16:34:17 +00001272 RECORD(DECL_NAMESPACE);
1273 RECORD(DECL_NAMESPACE_ALIAS);
1274 RECORD(DECL_USING);
1275 RECORD(DECL_USING_SHADOW);
1276 RECORD(DECL_USING_DIRECTIVE);
1277 RECORD(DECL_UNRESOLVED_USING_VALUE);
1278 RECORD(DECL_UNRESOLVED_USING_TYPENAME);
1279 RECORD(DECL_LINKAGE_SPEC);
1280 RECORD(DECL_CXX_RECORD);
1281 RECORD(DECL_CXX_METHOD);
1282 RECORD(DECL_CXX_CONSTRUCTOR);
1283 RECORD(DECL_CXX_DESTRUCTOR);
1284 RECORD(DECL_CXX_CONVERSION);
1285 RECORD(DECL_ACCESS_SPEC);
1286 RECORD(DECL_FRIEND);
1287 RECORD(DECL_FRIEND_TEMPLATE);
1288 RECORD(DECL_CLASS_TEMPLATE);
1289 RECORD(DECL_CLASS_TEMPLATE_SPECIALIZATION);
1290 RECORD(DECL_CLASS_TEMPLATE_PARTIAL_SPECIALIZATION);
Larisse Voufo39a1e502013-08-06 01:03:05 +00001291 RECORD(DECL_VAR_TEMPLATE);
1292 RECORD(DECL_VAR_TEMPLATE_SPECIALIZATION);
1293 RECORD(DECL_VAR_TEMPLATE_PARTIAL_SPECIALIZATION);
Douglas Gregor0beaec02011-02-08 16:34:17 +00001294 RECORD(DECL_FUNCTION_TEMPLATE);
1295 RECORD(DECL_TEMPLATE_TYPE_PARM);
1296 RECORD(DECL_NON_TYPE_TEMPLATE_PARM);
1297 RECORD(DECL_TEMPLATE_TEMPLATE_PARM);
Saar Razd7aae332019-07-10 21:25:49 +00001298 RECORD(DECL_CONCEPT);
Richard Smithefc884a2016-04-13 07:41:35 +00001299 RECORD(DECL_TYPE_ALIAS_TEMPLATE);
Douglas Gregor0beaec02011-02-08 16:34:17 +00001300 RECORD(DECL_STATIC_ASSERT);
1301 RECORD(DECL_CXX_BASE_SPECIFIERS);
Richard Smithefc884a2016-04-13 07:41:35 +00001302 RECORD(DECL_CXX_CTOR_INITIALIZERS);
Douglas Gregor0beaec02011-02-08 16:34:17 +00001303 RECORD(DECL_INDIRECTFIELD);
1304 RECORD(DECL_EXPANDED_NON_TYPE_TEMPLATE_PARM_PACK);
Richard Smithefc884a2016-04-13 07:41:35 +00001305 RECORD(DECL_EXPANDED_TEMPLATE_TEMPLATE_PARM_PACK);
1306 RECORD(DECL_CLASS_SCOPE_FUNCTION_SPECIALIZATION);
1307 RECORD(DECL_IMPORT);
1308 RECORD(DECL_OMP_THREADPRIVATE);
1309 RECORD(DECL_EMPTY);
1310 RECORD(DECL_OBJC_TYPE_PARAM);
1311 RECORD(DECL_OMP_CAPTUREDEXPR);
1312 RECORD(DECL_PRAGMA_COMMENT);
1313 RECORD(DECL_PRAGMA_DETECT_MISMATCH);
1314 RECORD(DECL_OMP_DECLARE_REDUCTION);
Alexey Bataev25ed0c02019-03-07 17:54:44 +00001315 RECORD(DECL_OMP_ALLOCATE);
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00001316
Douglas Gregor03412ba2011-06-03 02:27:19 +00001317 // Statements and Exprs can occur in the Decls and Types block.
1318 AddStmtsExprs(Stream, Record);
1319
Douglas Gregor92a96f52011-02-08 21:58:10 +00001320 BLOCK(PREPROCESSOR_DETAIL_BLOCK);
Chandler Carruthf92ac9e2011-07-15 07:25:21 +00001321 RECORD(PPD_MACRO_EXPANSION);
Douglas Gregor92a96f52011-02-08 21:58:10 +00001322 RECORD(PPD_MACRO_DEFINITION);
1323 RECORD(PPD_INCLUSION_DIRECTIVE);
Douglas Gregor6623e1f2015-11-03 18:33:07 +00001324
1325 // Decls and Types block.
1326 BLOCK(EXTENSION_BLOCK);
1327 RECORD(EXTENSION_METADATA);
1328
Duncan P. N. Exon Smith60fa2882017-03-13 18:45:08 +00001329 BLOCK(UNHASHED_CONTROL_BLOCK);
1330 RECORD(SIGNATURE);
1331 RECORD(DIAGNOSTIC_OPTIONS);
1332 RECORD(DIAG_PRAGMA_MAPPINGS);
1333
Chris Lattner28fa4e62009-04-26 22:26:21 +00001334#undef RECORD
1335#undef BLOCK
1336 Stream.ExitBlock();
1337}
1338
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001339/// Prepares a path for being written to an AST file by converting it
Richard Smith54cc3c22014-12-11 20:50:24 +00001340/// to an absolute path and removing nested './'s.
1341///
1342/// \return \c true if the path was changed.
Benjamin Kramer6a96ae52015-02-06 18:36:04 +00001343static bool cleanPathForOutput(FileManager &FileMgr,
1344 SmallVectorImpl<char> &Path) {
Argyrios Kyrtzidis403cbcb2015-07-31 01:39:23 +00001345 bool Changed = FileMgr.makeAbsolutePath(Path);
Mike Aizatskyaeb9dd92015-11-09 19:12:18 +00001346 return Changed | llvm::sys::path::remove_dots(Path);
Richard Smith54cc3c22014-12-11 20:50:24 +00001347}
1348
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001349/// Adjusts the given filename to only write out the portion of the
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001350/// filename that is not part of the system root directory.
Mike Stump11289f42009-09-09 15:08:12 +00001351///
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001352/// \param Filename the file name to adjust.
1353///
Richard Smith7ed1bc92014-12-05 22:42:13 +00001354/// \param BaseDir When non-NULL, the PCH file is a relocatable AST file and
1355/// the returned filename will be adjusted by this root directory.
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001356///
1357/// \returns either the original filename (if it needs no adjustment) or the
1358/// adjusted filename (which points into the @p Filename parameter).
Mike Stump11289f42009-09-09 15:08:12 +00001359static const char *
Richard Smith7ed1bc92014-12-05 22:42:13 +00001360adjustFilenameForRelocatableAST(const char *Filename, StringRef BaseDir) {
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001361 assert(Filename && "No file name to adjust?");
Mike Stump11289f42009-09-09 15:08:12 +00001362
Richard Smith7ed1bc92014-12-05 22:42:13 +00001363 if (BaseDir.empty())
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001364 return Filename;
Mike Stump11289f42009-09-09 15:08:12 +00001365
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001366 // Verify that the filename and the system root have the same prefix.
1367 unsigned Pos = 0;
Richard Smith7ed1bc92014-12-05 22:42:13 +00001368 for (; Filename[Pos] && Pos < BaseDir.size(); ++Pos)
1369 if (Filename[Pos] != BaseDir[Pos])
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001370 return Filename; // Prefixes don't match.
Mike Stump11289f42009-09-09 15:08:12 +00001371
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001372 // We hit the end of the filename before we hit the end of the system root.
1373 if (!Filename[Pos])
1374 return Filename;
Mike Stump11289f42009-09-09 15:08:12 +00001375
Richard Smith7ed1bc92014-12-05 22:42:13 +00001376 // If there's not a path separator at the end of the base directory nor
1377 // immediately after it, then this isn't within the base directory.
1378 if (!llvm::sys::path::is_separator(Filename[Pos])) {
1379 if (!llvm::sys::path::is_separator(BaseDir.back()))
1380 return Filename;
1381 } else {
1382 // If the file name has a '/' at the current position, skip over the '/'.
1383 // We distinguish relative paths from absolute paths by the
1384 // absence of '/' at the beginning of relative paths.
1385 //
1386 // FIXME: This is wrong. We distinguish them by asking if the path is
1387 // absolute, which isn't the same thing. And there might be multiple '/'s
1388 // in a row. Use a better mechanism to indicate whether we have emitted an
1389 // absolute or relative path.
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001390 ++Pos;
Richard Smith7ed1bc92014-12-05 22:42:13 +00001391 }
Mike Stump11289f42009-09-09 15:08:12 +00001392
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001393 return Filename + Pos;
1394}
Chris Lattner28fa4e62009-04-26 22:26:21 +00001395
Duncan P. N. Exon Smith60fa2882017-03-13 18:45:08 +00001396ASTFileSignature ASTWriter::createSignature(StringRef Bytes) {
1397 // Calculate the hash till start of UNHASHED_CONTROL_BLOCK.
1398 llvm::SHA1 Hasher;
1399 Hasher.update(ArrayRef<uint8_t>(Bytes.bytes_begin(), Bytes.size()));
1400 auto Hash = Hasher.result();
1401
1402 // Convert to an array [5*i32].
1403 ASTFileSignature Signature;
1404 auto LShift = [&](unsigned char Val, unsigned Shift) {
1405 return (uint32_t)Val << Shift;
1406 };
1407 for (int I = 0; I != 5; ++I)
1408 Signature[I] = LShift(Hash[I * 4 + 0], 24) | LShift(Hash[I * 4 + 1], 16) |
1409 LShift(Hash[I * 4 + 2], 8) | LShift(Hash[I * 4 + 3], 0);
1410
1411 return Signature;
1412}
1413
1414ASTFileSignature ASTWriter::writeUnhashedControlBlock(Preprocessor &PP,
1415 ASTContext &Context) {
1416 // Flush first to prepare the PCM hash (signature).
1417 Stream.FlushToWord();
1418 auto StartOfUnhashedControl = Stream.GetCurrentBitNo() >> 3;
1419
1420 // Enter the block and prepare to write records.
1421 RecordData Record;
1422 Stream.EnterSubblock(UNHASHED_CONTROL_BLOCK_ID, 5);
1423
1424 // For implicit modules, write the hash of the PCM as its signature.
1425 ASTFileSignature Signature;
1426 if (WritingModule &&
1427 PP.getHeaderSearchInfo().getHeaderSearchOpts().ModulesHashContent) {
1428 Signature = createSignature(StringRef(Buffer.begin(), StartOfUnhashedControl));
1429 Record.append(Signature.begin(), Signature.end());
1430 Stream.EmitRecord(SIGNATURE, Record);
1431 Record.clear();
Ben Langmuir487ea142014-10-23 18:05:36 +00001432 }
Duncan P. N. Exon Smith60fa2882017-03-13 18:45:08 +00001433
1434 // Diagnostic options.
1435 const auto &Diags = Context.getDiagnostics();
1436 const DiagnosticOptions &DiagOpts = Diags.getDiagnosticOptions();
1437#define DIAGOPT(Name, Bits, Default) Record.push_back(DiagOpts.Name);
1438#define ENUM_DIAGOPT(Name, Type, Bits, Default) \
1439 Record.push_back(static_cast<unsigned>(DiagOpts.get##Name()));
1440#include "clang/Basic/DiagnosticOptions.def"
1441 Record.push_back(DiagOpts.Warnings.size());
1442 for (unsigned I = 0, N = DiagOpts.Warnings.size(); I != N; ++I)
1443 AddString(DiagOpts.Warnings[I], Record);
1444 Record.push_back(DiagOpts.Remarks.size());
1445 for (unsigned I = 0, N = DiagOpts.Remarks.size(); I != N; ++I)
1446 AddString(DiagOpts.Remarks[I], Record);
1447 // Note: we don't serialize the log or serialization file names, because they
1448 // are generally transient files and will almost always be overridden.
1449 Stream.EmitRecord(DIAGNOSTIC_OPTIONS, Record);
1450
1451 // Write out the diagnostic/pragma mappings.
Rui Ueyama49a3ad22019-07-16 04:46:31 +00001452 WritePragmaDiagnosticMappings(Diags, /* isModule = */ WritingModule);
Duncan P. N. Exon Smith60fa2882017-03-13 18:45:08 +00001453
1454 // Leave the options block.
1455 Stream.ExitBlock();
1456 return Signature;
Ben Langmuir487ea142014-10-23 18:05:36 +00001457}
1458
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001459/// Write the control block.
Duncan P. N. Exon Smith60fa2882017-03-13 18:45:08 +00001460void ASTWriter::WriteControlBlock(Preprocessor &PP, ASTContext &Context,
1461 StringRef isysroot,
1462 const std::string &OutputFile) {
Douglas Gregorbfbde532009-04-10 21:16:55 +00001463 using namespace llvm;
Eugene Zelenkob7d89102017-11-11 00:08:50 +00001464
Douglas Gregor0aa21c92012-10-18 18:27:37 +00001465 Stream.EnterSubblock(CONTROL_BLOCK_ID, 5);
Mehdi Amini5ae4a852015-09-09 20:35:37 +00001466 RecordData Record;
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00001467
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001468 // Metadata
David Blaikieb44f0bf2017-01-04 22:36:43 +00001469 auto MetadataAbbrev = std::make_shared<BitCodeAbbrev>();
Douglas Gregor0aa21c92012-10-18 18:27:37 +00001470 MetadataAbbrev->Add(BitCodeAbbrevOp(METADATA));
1471 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 16)); // Major
1472 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 16)); // Minor
1473 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 16)); // Clang maj.
1474 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 16)); // Clang min.
1475 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Relocatable
Richard Smithe75ee0f2015-08-17 07:13:32 +00001476 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Timestamps
Hans Wennborg08c5a7b2018-06-25 13:23:49 +00001477 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // PCHHasObjectFile
Douglas Gregor0aa21c92012-10-18 18:27:37 +00001478 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Errors
1479 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // SVN branch/tag
David Blaikieb44f0bf2017-01-04 22:36:43 +00001480 unsigned MetadataAbbrevCode = Stream.EmitAbbrev(std::move(MetadataAbbrev));
Richard Smith7ed1bc92014-12-05 22:42:13 +00001481 assert((!WritingModule || isysroot.empty()) &&
1482 "writing module as a relocatable PCH?");
Mehdi Amini57a41912015-09-10 01:46:39 +00001483 {
Hans Wennborg08c5a7b2018-06-25 13:23:49 +00001484 RecordData::value_type Record[] = {
1485 METADATA,
1486 VERSION_MAJOR,
1487 VERSION_MINOR,
1488 CLANG_VERSION_MAJOR,
1489 CLANG_VERSION_MINOR,
1490 !isysroot.empty(),
1491 IncludeTimestamps,
1492 Context.getLangOpts().BuildingPCHWithObjectFile,
1493 ASTHasCompilerErrors};
Mehdi Amini57a41912015-09-10 01:46:39 +00001494 Stream.EmitRecordWithBlob(MetadataAbbrevCode, Record,
1495 getClangFullRepositoryVersion());
1496 }
Chandler Carruth885e78c2015-03-24 21:18:10 +00001497
Richard Smith8b706102017-05-31 20:56:55 +00001498 if (WritingModule) {
Richard Smith7ed1bc92014-12-05 22:42:13 +00001499 // Module name
David Blaikieb44f0bf2017-01-04 22:36:43 +00001500 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Ben Langmuirbeee15e2014-04-14 18:00:01 +00001501 Abbrev->Add(BitCodeAbbrevOp(MODULE_NAME));
1502 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
David Blaikieb44f0bf2017-01-04 22:36:43 +00001503 unsigned AbbrevCode = Stream.EmitAbbrev(std::move(Abbrev));
Mehdi Amini57a41912015-09-10 01:46:39 +00001504 RecordData::value_type Record[] = {MODULE_NAME};
Ben Langmuirbeee15e2014-04-14 18:00:01 +00001505 Stream.EmitRecordWithBlob(AbbrevCode, Record, WritingModule->Name);
1506 }
1507
Richard Smith7ed1bc92014-12-05 22:42:13 +00001508 if (WritingModule && WritingModule->Directory) {
Richard Smith7ed1bc92014-12-05 22:42:13 +00001509 SmallString<128> BaseDir(WritingModule->Directory->getName());
Richard Smith54cc3c22014-12-11 20:50:24 +00001510 cleanPathForOutput(Context.getSourceManager().getFileManager(), BaseDir);
Richard Smithf7b41372015-08-13 23:47:44 +00001511
1512 // If the home of the module is the current working directory, then we
1513 // want to pick up the cwd of the build process loading the module, not
1514 // our cwd, when we load this module.
1515 if (!PP.getHeaderSearchInfo()
1516 .getHeaderSearchOpts()
1517 .ModuleMapFileHomeIsCwd ||
1518 WritingModule->Directory->getName() != StringRef(".")) {
1519 // Module directory.
David Blaikieb44f0bf2017-01-04 22:36:43 +00001520 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Richard Smithf7b41372015-08-13 23:47:44 +00001521 Abbrev->Add(BitCodeAbbrevOp(MODULE_DIRECTORY));
1522 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Directory
David Blaikieb44f0bf2017-01-04 22:36:43 +00001523 unsigned AbbrevCode = Stream.EmitAbbrev(std::move(Abbrev));
Richard Smithf7b41372015-08-13 23:47:44 +00001524
Mehdi Amini57a41912015-09-10 01:46:39 +00001525 RecordData::value_type Record[] = {MODULE_DIRECTORY};
Richard Smithf7b41372015-08-13 23:47:44 +00001526 Stream.EmitRecordWithBlob(AbbrevCode, Record, BaseDir);
1527 }
Richard Smith7ed1bc92014-12-05 22:42:13 +00001528
1529 // Write out all other paths relative to the base directory if possible.
1530 BaseDirectory.assign(BaseDir.begin(), BaseDir.end());
1531 } else if (!isysroot.empty()) {
1532 // Write out paths relative to the sysroot if possible.
1533 BaseDirectory = isysroot;
1534 }
1535
Ben Langmuirbeee15e2014-04-14 18:00:01 +00001536 // Module map file
Richard Smithd19389a2017-07-05 07:47:11 +00001537 if (WritingModule && WritingModule->Kind == Module::ModuleMapModule) {
Mehdi Amini5ae4a852015-09-09 20:35:37 +00001538 Record.clear();
Ben Langmuirbeee15e2014-04-14 18:00:01 +00001539
Ben Langmuir4b8a9e92014-08-12 16:42:33 +00001540 auto &Map = PP.getHeaderSearchInfo().getModuleMap();
Richard Smith8b706102017-05-31 20:56:55 +00001541 AddPath(WritingModule->PresumedModuleMapFile.empty()
1542 ? Map.getModuleMapFileForUniquing(WritingModule)->getName()
1543 : StringRef(WritingModule->PresumedModuleMapFile),
1544 Record);
Ben Langmuir4b8a9e92014-08-12 16:42:33 +00001545
1546 // Additional module map files.
Richard Smith7ed1bc92014-12-05 22:42:13 +00001547 if (auto *AdditionalModMaps =
1548 Map.getAdditionalModuleMapFiles(WritingModule)) {
Ben Langmuir4b8a9e92014-08-12 16:42:33 +00001549 Record.push_back(AdditionalModMaps->size());
1550 for (const FileEntry *F : *AdditionalModMaps)
Richard Smith7ed1bc92014-12-05 22:42:13 +00001551 AddPath(F->getName(), Record);
Ben Langmuir4b8a9e92014-08-12 16:42:33 +00001552 } else {
1553 Record.push_back(0);
1554 }
1555
1556 Stream.EmitRecord(MODULE_MAP_FILE, Record);
Ben Langmuirbeee15e2014-04-14 18:00:01 +00001557 }
1558
Douglas Gregor112b9072012-10-18 05:31:06 +00001559 // Imports
Douglas Gregor29cc6422011-08-17 21:07:30 +00001560 if (Chain) {
Douglas Gregor29cc6422011-08-17 21:07:30 +00001561 serialization::ModuleManager &Mgr = Chain->getModuleManager();
Mehdi Amini5ae4a852015-09-09 20:35:37 +00001562 Record.clear();
Douglas Gregordf0c1512011-08-18 04:12:04 +00001563
Duncan P. N. Exon Smith96a06e02017-01-28 22:15:22 +00001564 for (ModuleFile &M : Mgr) {
Douglas Gregordf0c1512011-08-18 04:12:04 +00001565 // Skip modules that weren't directly imported.
Duncan P. N. Exon Smith96a06e02017-01-28 22:15:22 +00001566 if (!M.isDirectlyImported())
Douglas Gregordf0c1512011-08-18 04:12:04 +00001567 continue;
1568
Duncan P. N. Exon Smith96a06e02017-01-28 22:15:22 +00001569 Record.push_back((unsigned)M.Kind); // FIXME: Stable encoding
1570 AddSourceLocation(M.ImportLoc, Record);
Duncan P. N. Exon Smith60fa2882017-03-13 18:45:08 +00001571
1572 // If we have calculated signature, there is no need to store
1573 // the size or timestamp.
1574 Record.push_back(M.Signature ? 0 : M.File->getSize());
1575 Record.push_back(M.Signature ? 0 : getTimestampForOutput(M.File));
1576
1577 for (auto I : M.Signature)
1578 Record.push_back(I);
1579
Boris Kolpackovd30446f2017-08-31 06:26:43 +00001580 AddString(M.ModuleName, Record);
Duncan P. N. Exon Smith96a06e02017-01-28 22:15:22 +00001581 AddPath(M.FileName, Record);
Douglas Gregordf0c1512011-08-18 04:12:04 +00001582 }
Douglas Gregor29cc6422011-08-17 21:07:30 +00001583 Stream.EmitRecord(IMPORTS, Record);
1584 }
Mike Stump11289f42009-09-09 15:08:12 +00001585
Richard Smith0516b182015-09-08 19:40:14 +00001586 // Write the options block.
1587 Stream.EnterSubblock(OPTIONS_BLOCK_ID, 4);
1588
Douglas Gregor112b9072012-10-18 05:31:06 +00001589 // Language options.
Mehdi Amini5ae4a852015-09-09 20:35:37 +00001590 Record.clear();
Douglas Gregor112b9072012-10-18 05:31:06 +00001591 const LangOptions &LangOpts = Context.getLangOpts();
1592#define LANGOPT(Name, Bits, Default, Description) \
1593 Record.push_back(LangOpts.Name);
1594#define ENUM_LANGOPT(Name, Type, Bits, Default, Description) \
1595 Record.push_back(static_cast<unsigned>(LangOpts.get##Name()));
Alexey Samsonovedf99a92014-11-07 22:29:38 +00001596#include "clang/Basic/LangOptions.def"
1597#define SANITIZER(NAME, ID) \
1598 Record.push_back(LangOpts.Sanitize.has(SanitizerKind::ID));
Will Dietzf54319c2013-01-18 11:30:38 +00001599#include "clang/Basic/Sanitizers.def"
Douglas Gregor112b9072012-10-18 05:31:06 +00001600
Ben Langmuircd98cb72015-06-23 18:20:18 +00001601 Record.push_back(LangOpts.ModuleFeatures.size());
1602 for (StringRef Feature : LangOpts.ModuleFeatures)
1603 AddString(Feature, Record);
1604
Douglas Gregor112b9072012-10-18 05:31:06 +00001605 Record.push_back((unsigned) LangOpts.ObjCRuntime.getKind());
1606 AddVersionTuple(LangOpts.ObjCRuntime.getVersion(), Record);
Ben Langmuird4a667a2015-06-23 18:20:23 +00001607
1608 AddString(LangOpts.CurrentModule, Record);
Dmitri Gribenkoacf2e782013-02-22 14:21:27 +00001609
1610 // Comment options.
1611 Record.push_back(LangOpts.CommentOpts.BlockCommandNames.size());
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00001612 for (const auto &I : LangOpts.CommentOpts.BlockCommandNames) {
1613 AddString(I, Record);
Dmitri Gribenkoacf2e782013-02-22 14:21:27 +00001614 }
Dmitri Gribenkoa7d16ce2013-04-10 15:35:17 +00001615 Record.push_back(LangOpts.CommentOpts.ParseAllComments);
Dmitri Gribenkoacf2e782013-02-22 14:21:27 +00001616
Samuel Antaoee8fb302016-01-06 13:42:12 +00001617 // OpenMP offloading options.
1618 Record.push_back(LangOpts.OMPTargetTriples.size());
1619 for (auto &T : LangOpts.OMPTargetTriples)
1620 AddString(T.getTriple(), Record);
1621
1622 AddString(LangOpts.OMPHostIRFile, Record);
1623
Douglas Gregor112b9072012-10-18 05:31:06 +00001624 Stream.EmitRecord(LANGUAGE_OPTIONS, Record);
1625
Douglas Gregor4d3611c2012-10-18 17:58:09 +00001626 // Target options.
1627 Record.clear();
Douglas Gregor0aa21c92012-10-18 18:27:37 +00001628 const TargetInfo &Target = Context.getTargetInfo();
1629 const TargetOptions &TargetOpts = Target.getTargetOpts();
Douglas Gregor4d3611c2012-10-18 17:58:09 +00001630 AddString(TargetOpts.Triple, Record);
1631 AddString(TargetOpts.CPU, Record);
1632 AddString(TargetOpts.ABI, Record);
Douglas Gregor4d3611c2012-10-18 17:58:09 +00001633 Record.push_back(TargetOpts.FeaturesAsWritten.size());
1634 for (unsigned I = 0, N = TargetOpts.FeaturesAsWritten.size(); I != N; ++I) {
1635 AddString(TargetOpts.FeaturesAsWritten[I], Record);
1636 }
1637 Record.push_back(TargetOpts.Features.size());
1638 for (unsigned I = 0, N = TargetOpts.Features.size(); I != N; ++I) {
1639 AddString(TargetOpts.Features[I], Record);
1640 }
1641 Stream.EmitRecord(TARGET_OPTIONS, Record);
1642
Douglas Gregorc6317db2012-10-24 15:49:58 +00001643 // File system options.
1644 Record.clear();
Yaron Keren8dec46c2015-08-26 08:10:22 +00001645 const FileSystemOptions &FSOpts =
1646 Context.getSourceManager().getFileManager().getFileSystemOpts();
Douglas Gregorc6317db2012-10-24 15:49:58 +00001647 AddString(FSOpts.WorkingDir, Record);
1648 Stream.EmitRecord(FILE_SYSTEM_OPTIONS, Record);
1649
Douglas Gregor2d302362012-10-24 16:50:34 +00001650 // Header search options.
1651 Record.clear();
1652 const HeaderSearchOptions &HSOpts
1653 = PP.getHeaderSearchInfo().getHeaderSearchOpts();
1654 AddString(HSOpts.Sysroot, Record);
1655
1656 // Include entries.
1657 Record.push_back(HSOpts.UserEntries.size());
1658 for (unsigned I = 0, N = HSOpts.UserEntries.size(); I != N; ++I) {
1659 const HeaderSearchOptions::Entry &Entry = HSOpts.UserEntries[I];
1660 AddString(Entry.Path, Record);
1661 Record.push_back(static_cast<unsigned>(Entry.Group));
Douglas Gregor2d302362012-10-24 16:50:34 +00001662 Record.push_back(Entry.IsFramework);
1663 Record.push_back(Entry.IgnoreSysRoot);
Douglas Gregor2d302362012-10-24 16:50:34 +00001664 }
1665
1666 // System header prefixes.
1667 Record.push_back(HSOpts.SystemHeaderPrefixes.size());
1668 for (unsigned I = 0, N = HSOpts.SystemHeaderPrefixes.size(); I != N; ++I) {
1669 AddString(HSOpts.SystemHeaderPrefixes[I].Prefix, Record);
1670 Record.push_back(HSOpts.SystemHeaderPrefixes[I].IsSystemHeader);
1671 }
1672
1673 AddString(HSOpts.ResourceDir, Record);
1674 AddString(HSOpts.ModuleCachePath, Record);
Argyrios Kyrtzidis1594c152014-03-03 08:12:05 +00001675 AddString(HSOpts.ModuleUserBuildPath, Record);
Douglas Gregor2d302362012-10-24 16:50:34 +00001676 Record.push_back(HSOpts.DisableModuleHash);
Richard Smith18934752017-06-06 00:32:01 +00001677 Record.push_back(HSOpts.ImplicitModuleMaps);
1678 Record.push_back(HSOpts.ModuleMapFileHomeIsCwd);
Douglas Gregor2d302362012-10-24 16:50:34 +00001679 Record.push_back(HSOpts.UseBuiltinIncludes);
1680 Record.push_back(HSOpts.UseStandardSystemIncludes);
1681 Record.push_back(HSOpts.UseStandardCXXIncludes);
1682 Record.push_back(HSOpts.UseLibcxx);
Argyrios Kyrtzidisbd0b6512015-02-19 20:12:20 +00001683 // Write out the specific module cache path that contains the module files.
1684 AddString(PP.getHeaderSearchInfo().getModuleCachePath(), Record);
Douglas Gregor2d302362012-10-24 16:50:34 +00001685 Stream.EmitRecord(HEADER_SEARCH_OPTIONS, Record);
1686
Douglas Gregorb6af6c22012-10-24 20:05:57 +00001687 // Preprocessor options.
1688 Record.clear();
1689 const PreprocessorOptions &PPOpts = PP.getPreprocessorOpts();
1690
1691 // Macro definitions.
1692 Record.push_back(PPOpts.Macros.size());
1693 for (unsigned I = 0, N = PPOpts.Macros.size(); I != N; ++I) {
1694 AddString(PPOpts.Macros[I].first, Record);
1695 Record.push_back(PPOpts.Macros[I].second);
1696 }
1697
1698 // Includes
1699 Record.push_back(PPOpts.Includes.size());
1700 for (unsigned I = 0, N = PPOpts.Includes.size(); I != N; ++I)
1701 AddString(PPOpts.Includes[I], Record);
1702
1703 // Macro includes
1704 Record.push_back(PPOpts.MacroIncludes.size());
1705 for (unsigned I = 0, N = PPOpts.MacroIncludes.size(); I != N; ++I)
1706 AddString(PPOpts.MacroIncludes[I], Record);
1707
Douglas Gregorb6368752012-10-24 23:41:50 +00001708 Record.push_back(PPOpts.UsePredefines);
Argyrios Kyrtzidisd3afa0c2013-04-26 21:33:40 +00001709 // Detailed record is important since it is used for the module cache hash.
1710 Record.push_back(PPOpts.DetailedRecord);
Douglas Gregorb6af6c22012-10-24 20:05:57 +00001711 AddString(PPOpts.ImplicitPCHInclude, Record);
Douglas Gregorb6af6c22012-10-24 20:05:57 +00001712 Record.push_back(static_cast<unsigned>(PPOpts.ObjCXXARCStandardLibrary));
1713 Stream.EmitRecord(PREPROCESSOR_OPTIONS, Record);
1714
Richard Smith0516b182015-09-08 19:40:14 +00001715 // Leave the options block.
1716 Stream.ExitBlock();
1717
Douglas Gregora3b20262011-05-06 21:43:30 +00001718 // Original file name and file ID
Douglas Gregor45fe0362009-05-12 01:31:05 +00001719 SourceManager &SM = Context.getSourceManager();
1720 if (const FileEntry *MainFile = SM.getFileEntryForID(SM.getMainFileID())) {
David Blaikieb44f0bf2017-01-04 22:36:43 +00001721 auto FileAbbrev = std::make_shared<BitCodeAbbrev>();
Douglas Gregorfad10d82012-10-18 18:36:53 +00001722 FileAbbrev->Add(BitCodeAbbrevOp(ORIGINAL_FILE));
1723 FileAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // File ID
Douglas Gregor45fe0362009-05-12 01:31:05 +00001724 FileAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // File name
David Blaikieb44f0bf2017-01-04 22:36:43 +00001725 unsigned FileAbbrevCode = Stream.EmitAbbrev(std::move(FileAbbrev));
Douglas Gregor45fe0362009-05-12 01:31:05 +00001726
Douglas Gregorb6af6c22012-10-24 20:05:57 +00001727 Record.clear();
Douglas Gregorfad10d82012-10-18 18:36:53 +00001728 Record.push_back(ORIGINAL_FILE);
Douglas Gregora3b20262011-05-06 21:43:30 +00001729 Record.push_back(SM.getMainFileID().getOpaqueValue());
Richard Smith7ed1bc92014-12-05 22:42:13 +00001730 EmitRecordWithPath(FileAbbrevCode, Record, MainFile->getName());
Douglas Gregor45fe0362009-05-12 01:31:05 +00001731 }
Kovarththanan Rajaratnama9c81a82010-03-14 07:06:50 +00001732
Argyrios Kyrtzidis52595242012-11-15 18:57:27 +00001733 Record.clear();
1734 Record.push_back(SM.getMainFileID().getOpaqueValue());
1735 Stream.EmitRecord(ORIGINAL_FILE_ID, Record);
1736
Argyrios Kyrtzidis10b23682011-02-15 17:54:22 +00001737 // Original PCH directory
1738 if (!OutputFile.empty() && OutputFile != "-") {
David Blaikieb44f0bf2017-01-04 22:36:43 +00001739 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Argyrios Kyrtzidis10b23682011-02-15 17:54:22 +00001740 Abbrev->Add(BitCodeAbbrevOp(ORIGINAL_PCH_DIR));
1741 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // File name
David Blaikieb44f0bf2017-01-04 22:36:43 +00001742 unsigned AbbrevCode = Stream.EmitAbbrev(std::move(Abbrev));
Argyrios Kyrtzidis10b23682011-02-15 17:54:22 +00001743
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00001744 SmallString<128> OutputPath(OutputFile);
Argyrios Kyrtzidis10b23682011-02-15 17:54:22 +00001745
Argyrios Kyrtzidisc56419e2015-07-31 00:58:32 +00001746 SM.getFileManager().makeAbsolutePath(OutputPath);
Argyrios Kyrtzidis10b23682011-02-15 17:54:22 +00001747 StringRef origDir = llvm::sys::path::parent_path(OutputPath);
1748
Mehdi Amini57a41912015-09-10 01:46:39 +00001749 RecordData::value_type Record[] = {ORIGINAL_PCH_DIR};
Argyrios Kyrtzidis10b23682011-02-15 17:54:22 +00001750 Stream.EmitRecordWithBlob(AbbrevCode, Record, origDir);
1751 }
1752
Douglas Gregor49491f72013-03-15 22:15:07 +00001753 WriteInputFiles(Context.SourceMgr,
1754 PP.getHeaderSearchInfo().getHeaderSearchOpts(),
Douglas Gregora3dd9002013-07-22 20:48:33 +00001755 PP.getLangOpts().Modules);
Douglas Gregor72be3902012-10-19 00:38:02 +00001756 Stream.ExitBlock();
1757}
1758
Douglas Gregor49491f72013-03-15 22:15:07 +00001759namespace {
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +00001760
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001761/// An input file.
Eugene Zelenkob7d89102017-11-11 00:08:50 +00001762struct InputFileEntry {
1763 const FileEntry *File;
1764 bool IsSystemFile;
1765 bool IsTransient;
1766 bool BufferOverridden;
1767 bool IsTopLevelModuleMap;
Bruno Cardoso Lopes1731fc82019-10-15 14:23:55 +00001768 uint32_t ContentHash[2];
Eugene Zelenkob7d89102017-11-11 00:08:50 +00001769};
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +00001770
Eugene Zelenkob7d89102017-11-11 00:08:50 +00001771} // namespace
Douglas Gregor49491f72013-03-15 22:15:07 +00001772
1773void ASTWriter::WriteInputFiles(SourceManager &SourceMgr,
1774 HeaderSearchOptions &HSOpts,
Douglas Gregora3dd9002013-07-22 20:48:33 +00001775 bool Modules) {
Douglas Gregor72be3902012-10-19 00:38:02 +00001776 using namespace llvm;
Eugene Zelenkob7d89102017-11-11 00:08:50 +00001777
Douglas Gregor72be3902012-10-19 00:38:02 +00001778 Stream.EnterSubblock(INPUT_FILES_BLOCK_ID, 4);
Mehdi Amini57a41912015-09-10 01:46:39 +00001779
Douglas Gregor72be3902012-10-19 00:38:02 +00001780 // Create input-file abbreviation.
David Blaikieb44f0bf2017-01-04 22:36:43 +00001781 auto IFAbbrev = std::make_shared<BitCodeAbbrev>();
Douglas Gregor72be3902012-10-19 00:38:02 +00001782 IFAbbrev->Add(BitCodeAbbrevOp(INPUT_FILE));
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001783 IFAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // ID
Douglas Gregor72be3902012-10-19 00:38:02 +00001784 IFAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 12)); // Size
1785 IFAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 32)); // Modification time
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001786 IFAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Overridden
Richard Smitha8cfffa2015-11-26 02:04:16 +00001787 IFAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Transient
Richard Smithf3f84612017-06-29 02:19:42 +00001788 IFAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Module map
Douglas Gregor72be3902012-10-19 00:38:02 +00001789 IFAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // File name
David Blaikieb44f0bf2017-01-04 22:36:43 +00001790 unsigned IFAbbrevCode = Stream.EmitAbbrev(std::move(IFAbbrev));
Douglas Gregor72be3902012-10-19 00:38:02 +00001791
Bruno Cardoso Lopes1731fc82019-10-15 14:23:55 +00001792 // Create input file hash abbreviation.
1793 auto IFHAbbrev = std::make_shared<BitCodeAbbrev>();
1794 IFHAbbrev->Add(BitCodeAbbrevOp(INPUT_FILE_HASH));
1795 IFHAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
1796 IFHAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
1797 unsigned IFHAbbrevCode = Stream.EmitAbbrev(std::move(IFHAbbrev));
1798
Argyrios Kyrtzidis7d238572013-03-06 18:12:50 +00001799 // Get all ContentCache objects for files, sorted by whether the file is a
1800 // system one or not. System files go at the back, users files at the front.
Douglas Gregor49491f72013-03-15 22:15:07 +00001801 std::deque<InputFileEntry> SortedFiles;
Douglas Gregor72be3902012-10-19 00:38:02 +00001802 for (unsigned I = 1, N = SourceMgr.local_sloc_entry_size(); I != N; ++I) {
1803 // Get this source location entry.
1804 const SrcMgr::SLocEntry *SLoc = &SourceMgr.getLocalSLocEntry(I);
NAKAMURA Takumideca50f2012-10-19 01:53:57 +00001805 assert(&SourceMgr.getSLocEntry(FileID::get(I)) == SLoc);
Douglas Gregor72be3902012-10-19 00:38:02 +00001806
1807 // We only care about file entries that were not overridden.
1808 if (!SLoc->isFile())
1809 continue;
Richard Smithf3f84612017-06-29 02:19:42 +00001810 const SrcMgr::FileInfo &File = SLoc->getFile();
1811 const SrcMgr::ContentCache *Cache = File.getContentCache();
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001812 if (!Cache->OrigEntry)
Douglas Gregor72be3902012-10-19 00:38:02 +00001813 continue;
1814
Douglas Gregor49491f72013-03-15 22:15:07 +00001815 InputFileEntry Entry;
1816 Entry.File = Cache->OrigEntry;
Duncan P. N. Exon Smithf5848192019-08-26 20:32:05 +00001817 Entry.IsSystemFile = isSystem(File.getFileCharacteristic());
Richard Smitha8cfffa2015-11-26 02:04:16 +00001818 Entry.IsTransient = Cache->IsTransient;
Douglas Gregor49491f72013-03-15 22:15:07 +00001819 Entry.BufferOverridden = Cache->BufferOverridden;
Richard Smithf3f84612017-06-29 02:19:42 +00001820 Entry.IsTopLevelModuleMap = isModuleMap(File.getFileCharacteristic()) &&
1821 File.getIncludeLoc().isInvalid();
Bruno Cardoso Lopes1731fc82019-10-15 14:23:55 +00001822
1823 auto ContentHash = hash_code(-1);
1824 if (PP->getHeaderSearchInfo()
1825 .getHeaderSearchOpts()
1826 .ValidateASTInputFilesContent) {
1827 auto *MemBuff = Cache->getRawBuffer();
1828 if (MemBuff)
1829 ContentHash = hash_value(MemBuff->getBuffer());
1830 else
1831 // FIXME: The path should be taken from the FileEntryRef.
1832 PP->Diag(SourceLocation(), diag::err_module_unable_to_hash_content)
1833 << Entry.File->getName();
1834 }
1835 auto CH = llvm::APInt(64, ContentHash);
1836 Entry.ContentHash[0] =
1837 static_cast<uint32_t>(CH.getLoBits(32).getZExtValue());
1838 Entry.ContentHash[1] =
1839 static_cast<uint32_t>(CH.getHiBits(32).getZExtValue());
1840
Duncan P. N. Exon Smithf5848192019-08-26 20:32:05 +00001841 if (Entry.IsSystemFile)
Douglas Gregor49491f72013-03-15 22:15:07 +00001842 SortedFiles.push_back(Entry);
Argyrios Kyrtzidis7d238572013-03-06 18:12:50 +00001843 else
Douglas Gregor49491f72013-03-15 22:15:07 +00001844 SortedFiles.push_front(Entry);
1845 }
1846
Argyrios Kyrtzidis7d238572013-03-06 18:12:50 +00001847 unsigned UserFilesNum = 0;
1848 // Write out all of the input files.
Richard Smithec216502015-02-13 19:48:37 +00001849 std::vector<uint64_t> InputFileOffsets;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00001850 for (const auto &Entry : SortedFiles) {
Douglas Gregor49491f72013-03-15 22:15:07 +00001851 uint32_t &InputFileID = InputFileIDs[Entry.File];
Argyrios Kyrtzidise65856f2012-12-11 07:48:08 +00001852 if (InputFileID != 0)
1853 continue; // already recorded this file.
1854
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001855 // Record this entry's offset.
1856 InputFileOffsets.push_back(Stream.GetCurrentBitNo());
Argyrios Kyrtzidise65856f2012-12-11 07:48:08 +00001857
1858 InputFileID = InputFileOffsets.size();
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001859
Douglas Gregor49491f72013-03-15 22:15:07 +00001860 if (!Entry.IsSystemFile)
Argyrios Kyrtzidis7d238572013-03-06 18:12:50 +00001861 ++UserFilesNum;
1862
Douglas Gregor72be3902012-10-19 00:38:02 +00001863 // Emit size/modification time for this file.
Mehdi Amini57a41912015-09-10 01:46:39 +00001864 // And whether this file was overridden.
Bruno Cardoso Lopes1731fc82019-10-15 14:23:55 +00001865 {
1866 RecordData::value_type Record[] = {
1867 INPUT_FILE,
1868 InputFileOffsets.size(),
1869 (uint64_t)Entry.File->getSize(),
1870 (uint64_t)getTimestampForOutput(Entry.File),
1871 Entry.BufferOverridden,
1872 Entry.IsTransient,
1873 Entry.IsTopLevelModuleMap};
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001874
Bruno Cardoso Lopes1731fc82019-10-15 14:23:55 +00001875 // FIXME: The path should be taken from the FileEntryRef.
1876 EmitRecordWithPath(IFAbbrevCode, Record, Entry.File->getName());
1877 }
1878
1879 // Emit content hash for this file.
1880 {
1881 RecordData::value_type Record[] = {INPUT_FILE_HASH, Entry.ContentHash[0],
1882 Entry.ContentHash[1]};
1883 Stream.EmitRecordWithAbbrev(IFHAbbrevCode, Record);
1884 }
Richard Smith7ed1bc92014-12-05 22:42:13 +00001885 }
Douglas Gregor49491f72013-03-15 22:15:07 +00001886
Douglas Gregor112b9072012-10-18 05:31:06 +00001887 Stream.ExitBlock();
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001888
1889 // Create input file offsets abbreviation.
David Blaikieb44f0bf2017-01-04 22:36:43 +00001890 auto OffsetsAbbrev = std::make_shared<BitCodeAbbrev>();
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001891 OffsetsAbbrev->Add(BitCodeAbbrevOp(INPUT_FILE_OFFSETS));
1892 OffsetsAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // # input files
Argyrios Kyrtzidis7d238572013-03-06 18:12:50 +00001893 OffsetsAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // # non-system
1894 // input files
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001895 OffsetsAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Array
David Blaikieb44f0bf2017-01-04 22:36:43 +00001896 unsigned OffsetsAbbrevCode = Stream.EmitAbbrev(std::move(OffsetsAbbrev));
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001897
1898 // Write input file offsets.
Mehdi Amini57a41912015-09-10 01:46:39 +00001899 RecordData::value_type Record[] = {INPUT_FILE_OFFSETS,
1900 InputFileOffsets.size(), UserFilesNum};
Reid Kleckner012665e2015-05-21 00:13:09 +00001901 Stream.EmitRecordWithBlob(OffsetsAbbrevCode, Record, bytes(InputFileOffsets));
Douglas Gregor55abb232009-04-10 20:39:37 +00001902}
1903
Douglas Gregora7f71a92009-04-10 03:52:48 +00001904//===----------------------------------------------------------------------===//
1905// Source Manager Serialization
1906//===----------------------------------------------------------------------===//
1907
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001908/// Create an abbreviation for the SLocEntry that refers to a
Douglas Gregora7f71a92009-04-10 03:52:48 +00001909/// file.
Douglas Gregor8f45df52009-04-16 22:23:12 +00001910static unsigned CreateSLocFileAbbrev(llvm::BitstreamWriter &Stream) {
Douglas Gregora7f71a92009-04-10 03:52:48 +00001911 using namespace llvm;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00001912
David Blaikieb44f0bf2017-01-04 22:36:43 +00001913 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Sebastian Redl539c5062010-08-18 23:57:32 +00001914 Abbrev->Add(BitCodeAbbrevOp(SM_SLOC_FILE_ENTRY));
Douglas Gregora7f71a92009-04-10 03:52:48 +00001915 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Offset
1916 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Include location
Richard Smithf3f84612017-06-29 02:19:42 +00001917 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 3)); // Characteristic
Douglas Gregora7f71a92009-04-10 03:52:48 +00001918 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Line directives
Douglas Gregorb41ca8f2010-03-21 22:49:54 +00001919 // FileEntry fields.
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001920 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Input File ID
Argyrios Kyrtzidis61ef3db2011-08-21 23:33:04 +00001921 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // NumCreatedFIDs
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00001922 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 24)); // FirstDeclIndex
1923 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // NumDecls
David Blaikieb44f0bf2017-01-04 22:36:43 +00001924 return Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregora7f71a92009-04-10 03:52:48 +00001925}
1926
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001927/// Create an abbreviation for the SLocEntry that refers to a
Douglas Gregora7f71a92009-04-10 03:52:48 +00001928/// buffer.
Douglas Gregor8f45df52009-04-16 22:23:12 +00001929static unsigned CreateSLocBufferAbbrev(llvm::BitstreamWriter &Stream) {
Douglas Gregora7f71a92009-04-10 03:52:48 +00001930 using namespace llvm;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00001931
David Blaikieb44f0bf2017-01-04 22:36:43 +00001932 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Sebastian Redl539c5062010-08-18 23:57:32 +00001933 Abbrev->Add(BitCodeAbbrevOp(SM_SLOC_BUFFER_ENTRY));
Douglas Gregora7f71a92009-04-10 03:52:48 +00001934 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Offset
1935 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Include location
Richard Smithf3f84612017-06-29 02:19:42 +00001936 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 3)); // Characteristic
Douglas Gregora7f71a92009-04-10 03:52:48 +00001937 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Line directives
1938 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Buffer name blob
David Blaikieb44f0bf2017-01-04 22:36:43 +00001939 return Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregora7f71a92009-04-10 03:52:48 +00001940}
1941
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001942/// Create an abbreviation for the SLocEntry that refers to a
Douglas Gregora7f71a92009-04-10 03:52:48 +00001943/// buffer's blob.
Richard Smithaada85c2016-02-06 02:06:43 +00001944static unsigned CreateSLocBufferBlobAbbrev(llvm::BitstreamWriter &Stream,
1945 bool Compressed) {
Douglas Gregora7f71a92009-04-10 03:52:48 +00001946 using namespace llvm;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00001947
David Blaikieb44f0bf2017-01-04 22:36:43 +00001948 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Richard Smithaada85c2016-02-06 02:06:43 +00001949 Abbrev->Add(BitCodeAbbrevOp(Compressed ? SM_SLOC_BUFFER_BLOB_COMPRESSED
1950 : SM_SLOC_BUFFER_BLOB));
1951 if (Compressed)
1952 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Uncompressed size
Douglas Gregora7f71a92009-04-10 03:52:48 +00001953 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Blob
David Blaikieb44f0bf2017-01-04 22:36:43 +00001954 return Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregora7f71a92009-04-10 03:52:48 +00001955}
1956
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001957/// Create an abbreviation for the SLocEntry that refers to a macro
Chandler Carruthf92ac9e2011-07-15 07:25:21 +00001958/// expansion.
1959static unsigned CreateSLocExpansionAbbrev(llvm::BitstreamWriter &Stream) {
Douglas Gregora7f71a92009-04-10 03:52:48 +00001960 using namespace llvm;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00001961
David Blaikieb44f0bf2017-01-04 22:36:43 +00001962 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Chandler Carruthf92ac9e2011-07-15 07:25:21 +00001963 Abbrev->Add(BitCodeAbbrevOp(SM_SLOC_EXPANSION_ENTRY));
Douglas Gregora7f71a92009-04-10 03:52:48 +00001964 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Offset
1965 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Spelling location
1966 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Start location
1967 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // End location
Richard Smithb5f81712018-04-30 05:25:48 +00001968 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Is token range
Douglas Gregor83243272009-04-15 18:05:10 +00001969 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Token length
David Blaikieb44f0bf2017-01-04 22:36:43 +00001970 return Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregora7f71a92009-04-10 03:52:48 +00001971}
1972
Douglas Gregor09b69892011-02-10 17:09:37 +00001973namespace {
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +00001974
Douglas Gregor09b69892011-02-10 17:09:37 +00001975 // Trait used for the on-disk hash table of header search information.
1976 class HeaderFileInfoTrait {
1977 ASTWriter &Writer;
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00001978
Douglas Gregor4b123cb2011-07-28 04:50:02 +00001979 // Keep track of the framework names we've used during serialization.
1980 SmallVector<char, 128> FrameworkStringData;
1981 llvm::StringMap<unsigned> FrameworkNameOffset;
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00001982
Douglas Gregor09b69892011-02-10 17:09:37 +00001983 public:
Richard Smith040e1262017-06-02 01:55:39 +00001984 HeaderFileInfoTrait(ASTWriter &Writer) : Writer(Writer) {}
1985
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +00001986 struct key_type {
Mehdi Amini004b9c72016-10-10 22:52:47 +00001987 StringRef Filename;
Richard Smith040e1262017-06-02 01:55:39 +00001988 off_t Size;
1989 time_t ModTime;
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +00001990 };
Eugene Zelenkob7d89102017-11-11 00:08:50 +00001991 using key_type_ref = const key_type &;
Richard Smith040e1262017-06-02 01:55:39 +00001992
1993 using UnresolvedModule =
1994 llvm::PointerIntPair<Module *, 2, ModuleMap::ModuleHeaderRole>;
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00001995
Richard Smith040e1262017-06-02 01:55:39 +00001996 struct data_type {
1997 const HeaderFileInfo &HFI;
1998 ArrayRef<ModuleMap::KnownHeader> KnownHeaders;
1999 UnresolvedModule Unresolved;
2000 };
Eugene Zelenkob7d89102017-11-11 00:08:50 +00002001 using data_type_ref = const data_type &;
Richard Smith040e1262017-06-02 01:55:39 +00002002
Eugene Zelenkob7d89102017-11-11 00:08:50 +00002003 using hash_value_type = unsigned;
2004 using offset_type = unsigned;
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00002005
Richard Smithe75ee0f2015-08-17 07:13:32 +00002006 hash_value_type ComputeHash(key_type_ref key) {
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +00002007 // The hash is based only on size/time of the file, so that the reader can
2008 // match even when symlinking or excess path elements ("foo/../", "../")
2009 // change the form of the name. However, complete path is still the key.
Richard Smith040e1262017-06-02 01:55:39 +00002010 return llvm::hash_combine(key.Size, key.ModTime);
Douglas Gregor09b69892011-02-10 17:09:37 +00002011 }
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00002012
Eugene Zelenkob7d89102017-11-11 00:08:50 +00002013 std::pair<unsigned, unsigned>
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +00002014 EmitKeyDataLength(raw_ostream& Out, key_type_ref key, data_type_ref Data) {
Justin Bognere1c147c2014-03-28 22:03:19 +00002015 using namespace llvm::support;
Eugene Zelenkob7d89102017-11-11 00:08:50 +00002016
Peter Collingbournee3f65292018-05-18 19:46:24 +00002017 endian::Writer LE(Out, little);
Mehdi Amini004b9c72016-10-10 22:52:47 +00002018 unsigned KeyLen = key.Filename.size() + 1 + 8 + 8;
Richard Smith386bb072015-08-18 23:42:23 +00002019 LE.write<uint16_t>(KeyLen);
Douglas Gregor4b123cb2011-07-28 04:50:02 +00002020 unsigned DataLen = 1 + 2 + 4 + 4;
Richard Smith040e1262017-06-02 01:55:39 +00002021 for (auto ModInfo : Data.KnownHeaders)
Richard Smith386bb072015-08-18 23:42:23 +00002022 if (Writer.getLocalOrImportedSubmoduleID(ModInfo.getModule()))
2023 DataLen += 4;
Richard Smith040e1262017-06-02 01:55:39 +00002024 if (Data.Unresolved.getPointer())
2025 DataLen += 4;
Richard Smith386bb072015-08-18 23:42:23 +00002026 LE.write<uint8_t>(DataLen);
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +00002027 return std::make_pair(KeyLen, DataLen);
Douglas Gregor09b69892011-02-10 17:09:37 +00002028 }
Richard Smith040e1262017-06-02 01:55:39 +00002029
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +00002030 void EmitKey(raw_ostream& Out, key_type_ref key, unsigned KeyLen) {
Justin Bognere1c147c2014-03-28 22:03:19 +00002031 using namespace llvm::support;
Eugene Zelenkob7d89102017-11-11 00:08:50 +00002032
Peter Collingbournee3f65292018-05-18 19:46:24 +00002033 endian::Writer LE(Out, little);
Richard Smith040e1262017-06-02 01:55:39 +00002034 LE.write<uint64_t>(key.Size);
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +00002035 KeyLen -= 8;
Richard Smith040e1262017-06-02 01:55:39 +00002036 LE.write<uint64_t>(key.ModTime);
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +00002037 KeyLen -= 8;
Mehdi Amini004b9c72016-10-10 22:52:47 +00002038 Out.write(key.Filename.data(), KeyLen);
Douglas Gregor09b69892011-02-10 17:09:37 +00002039 }
Richard Smith040e1262017-06-02 01:55:39 +00002040
Argyrios Kyrtzidisb146baa2013-03-13 21:13:51 +00002041 void EmitData(raw_ostream &Out, key_type_ref key,
Douglas Gregor09b69892011-02-10 17:09:37 +00002042 data_type_ref Data, unsigned DataLen) {
Justin Bognere1c147c2014-03-28 22:03:19 +00002043 using namespace llvm::support;
Eugene Zelenkob7d89102017-11-11 00:08:50 +00002044
Peter Collingbournee3f65292018-05-18 19:46:24 +00002045 endian::Writer LE(Out, little);
Douglas Gregor09b69892011-02-10 17:09:37 +00002046 uint64_t Start = Out.tell(); (void)Start;
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00002047
Richard Smithf3f84612017-06-29 02:19:42 +00002048 unsigned char Flags = (Data.HFI.isImport << 5)
2049 | (Data.HFI.isPragmaOnce << 4)
Richard Smith040e1262017-06-02 01:55:39 +00002050 | (Data.HFI.DirInfo << 1)
2051 | Data.HFI.IndexHeaderMapHeader;
Justin Bognere1c147c2014-03-28 22:03:19 +00002052 LE.write<uint8_t>(Flags);
Richard Smith040e1262017-06-02 01:55:39 +00002053 LE.write<uint16_t>(Data.HFI.NumIncludes);
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00002054
Richard Smith040e1262017-06-02 01:55:39 +00002055 if (!Data.HFI.ControllingMacro)
2056 LE.write<uint32_t>(Data.HFI.ControllingMacroID);
Douglas Gregor09b69892011-02-10 17:09:37 +00002057 else
Richard Smith040e1262017-06-02 01:55:39 +00002058 LE.write<uint32_t>(Writer.getIdentifierRef(Data.HFI.ControllingMacro));
2059
Douglas Gregor4b123cb2011-07-28 04:50:02 +00002060 unsigned Offset = 0;
Richard Smith040e1262017-06-02 01:55:39 +00002061 if (!Data.HFI.Framework.empty()) {
Douglas Gregor4b123cb2011-07-28 04:50:02 +00002062 // If this header refers into a framework, save the framework name.
2063 llvm::StringMap<unsigned>::iterator Pos
Richard Smith040e1262017-06-02 01:55:39 +00002064 = FrameworkNameOffset.find(Data.HFI.Framework);
Douglas Gregor4b123cb2011-07-28 04:50:02 +00002065 if (Pos == FrameworkNameOffset.end()) {
2066 Offset = FrameworkStringData.size() + 1;
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00002067 FrameworkStringData.append(Data.HFI.Framework.begin(),
Richard Smith040e1262017-06-02 01:55:39 +00002068 Data.HFI.Framework.end());
Douglas Gregor4b123cb2011-07-28 04:50:02 +00002069 FrameworkStringData.push_back(0);
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00002070
Richard Smith040e1262017-06-02 01:55:39 +00002071 FrameworkNameOffset[Data.HFI.Framework] = Offset;
Douglas Gregor4b123cb2011-07-28 04:50:02 +00002072 } else
2073 Offset = Pos->second;
2074 }
Justin Bognere1c147c2014-03-28 22:03:19 +00002075 LE.write<uint32_t>(Offset);
Argyrios Kyrtzidisb146baa2013-03-13 21:13:51 +00002076
Richard Smith040e1262017-06-02 01:55:39 +00002077 auto EmitModule = [&](Module *M, ModuleMap::ModuleHeaderRole Role) {
2078 if (uint32_t ModID = Writer.getLocalOrImportedSubmoduleID(M)) {
2079 uint32_t Value = (ModID << 2) | (unsigned)Role;
Richard Smith386bb072015-08-18 23:42:23 +00002080 assert((Value >> 2) == ModID && "overflow in header module info");
2081 LE.write<uint32_t>(Value);
2082 }
Richard Smith040e1262017-06-02 01:55:39 +00002083 };
2084
2085 // FIXME: If the header is excluded, we should write out some
2086 // record of that fact.
2087 for (auto ModInfo : Data.KnownHeaders)
2088 EmitModule(ModInfo.getModule(), ModInfo.getRole());
2089 if (Data.Unresolved.getPointer())
2090 EmitModule(Data.Unresolved.getPointer(), Data.Unresolved.getInt());
Argyrios Kyrtzidisb146baa2013-03-13 21:13:51 +00002091
Douglas Gregor09b69892011-02-10 17:09:37 +00002092 assert(Out.tell() - Start == DataLen && "Wrong data length");
2093 }
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00002094
Douglas Gregor4b123cb2011-07-28 04:50:02 +00002095 const char *strings_begin() const { return FrameworkStringData.begin(); }
2096 const char *strings_end() const { return FrameworkStringData.end(); }
Douglas Gregor09b69892011-02-10 17:09:37 +00002097 };
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +00002098
Eugene Zelenkob7d89102017-11-11 00:08:50 +00002099} // namespace
Douglas Gregor09b69892011-02-10 17:09:37 +00002100
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00002101/// Write the header search block for the list of files that
Douglas Gregor09b69892011-02-10 17:09:37 +00002102///
2103/// \param HS The header search structure to save.
Richard Smith7ed1bc92014-12-05 22:42:13 +00002104void ASTWriter::WriteHeaderSearch(const HeaderSearch &HS) {
Richard Smith040e1262017-06-02 01:55:39 +00002105 HeaderFileInfoTrait GeneratorTrait(*this);
2106 llvm::OnDiskChainedHashTableGenerator<HeaderFileInfoTrait> Generator;
2107 SmallVector<const char *, 4> SavedStrings;
2108 unsigned NumHeaderSearchEntries = 0;
2109
2110 // Find all unresolved headers for the current module. We generally will
2111 // have resolved them before we get here, but not necessarily: we might be
2112 // compiling a preprocessed module, where there is no requirement for the
2113 // original files to exist any more.
Benjamin Krameree021d52017-06-02 17:30:24 +00002114 const HeaderFileInfo Empty; // So we can take a reference.
Richard Smith040e1262017-06-02 01:55:39 +00002115 if (WritingModule) {
2116 llvm::SmallVector<Module *, 16> Worklist(1, WritingModule);
2117 while (!Worklist.empty()) {
2118 Module *M = Worklist.pop_back_val();
2119 if (!M->isAvailable())
2120 continue;
2121
2122 // Map to disk files where possible, to pick up any missing stat
2123 // information. This also means we don't need to check the unresolved
2124 // headers list when emitting resolved headers in the first loop below.
2125 // FIXME: It'd be preferable to avoid doing this if we were given
2126 // sufficient stat information in the module map.
2127 HS.getModuleMap().resolveHeaderDirectives(M);
2128
2129 // If the file didn't exist, we can still create a module if we were given
2130 // enough information in the module map.
2131 for (auto U : M->MissingHeaders) {
2132 // Check that we were given enough information to build a module
2133 // without this file existing on disk.
2134 if (!U.Size || (!U.ModTime && IncludeTimestamps)) {
2135 PP->Diag(U.FileNameLoc, diag::err_module_no_size_mtime_for_header)
2136 << WritingModule->getFullModuleName() << U.Size.hasValue()
2137 << U.FileName;
2138 continue;
2139 }
2140
2141 // Form the effective relative pathname for the file.
2142 SmallString<128> Filename(M->Directory->getName());
2143 llvm::sys::path::append(Filename, U.FileName);
2144 PreparePathForOutput(Filename);
2145
2146 StringRef FilenameDup = strdup(Filename.c_str());
2147 SavedStrings.push_back(FilenameDup.data());
2148
2149 HeaderFileInfoTrait::key_type Key = {
2150 FilenameDup, *U.Size, IncludeTimestamps ? *U.ModTime : 0
2151 };
2152 HeaderFileInfoTrait::data_type Data = {
Benjamin Krameree021d52017-06-02 17:30:24 +00002153 Empty, {}, {M, ModuleMap::headerKindToRole(U.Kind)}
Richard Smith040e1262017-06-02 01:55:39 +00002154 };
2155 // FIXME: Deal with cases where there are multiple unresolved header
2156 // directives in different submodules for the same header.
2157 Generator.insert(Key, Data, GeneratorTrait);
2158 ++NumHeaderSearchEntries;
2159 }
2160
2161 Worklist.append(M->submodule_begin(), M->submodule_end());
2162 }
2163 }
2164
Chris Lattner0e62c1c2011-07-23 10:55:15 +00002165 SmallVector<const FileEntry *, 16> FilesByUID;
Douglas Gregor09b69892011-02-10 17:09:37 +00002166 HS.getFileMgr().GetUniqueIDMapping(FilesByUID);
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00002167
Douglas Gregor09b69892011-02-10 17:09:37 +00002168 if (FilesByUID.size() > HS.header_file_size())
2169 FilesByUID.resize(HS.header_file_size());
Richard Smith040e1262017-06-02 01:55:39 +00002170
Douglas Gregor09b69892011-02-10 17:09:37 +00002171 for (unsigned UID = 0, LastUID = FilesByUID.size(); UID != LastUID; ++UID) {
2172 const FileEntry *File = FilesByUID[UID];
2173 if (!File)
2174 continue;
2175
Richard Smith386bb072015-08-18 23:42:23 +00002176 // Get the file info. This will load info from the external source if
2177 // necessary. Skip emitting this file if we have no information on it
2178 // as a header file (in which case HFI will be null) or if it hasn't
2179 // changed since it was loaded. Also skip it if it's for a modular header
2180 // from a different module; in that case, we rely on the module(s)
2181 // containing the header to provide this information.
Richard Smithd8879c82015-08-24 21:59:32 +00002182 const HeaderFileInfo *HFI =
2183 HS.getExistingFileInfo(File, /*WantExternal*/!Chain);
2184 if (!HFI || (HFI->isModuleHeader && !HFI->isCompilingModuleHeader))
Argyrios Kyrtzidis6f722b42013-05-08 23:46:46 +00002185 continue;
Douglas Gregor09b69892011-02-10 17:09:37 +00002186
Richard Smith7ed1bc92014-12-05 22:42:13 +00002187 // Massage the file path into an appropriate form.
Mehdi Amini004b9c72016-10-10 22:52:47 +00002188 StringRef Filename = File->getName();
Richard Smith7ed1bc92014-12-05 22:42:13 +00002189 SmallString<128> FilenameTmp(Filename);
2190 if (PreparePathForOutput(FilenameTmp)) {
2191 // If we performed any translation on the file name at all, we need to
2192 // save this string, since the generator will refer to it later.
Mehdi Amini004b9c72016-10-10 22:52:47 +00002193 Filename = StringRef(strdup(FilenameTmp.c_str()));
2194 SavedStrings.push_back(Filename.data());
Douglas Gregor09b69892011-02-10 17:09:37 +00002195 }
Richard Smith7ed1bc92014-12-05 22:42:13 +00002196
Richard Smith040e1262017-06-02 01:55:39 +00002197 HeaderFileInfoTrait::key_type Key = {
2198 Filename, File->getSize(), getTimestampForOutput(File)
2199 };
2200 HeaderFileInfoTrait::data_type Data = {
2201 *HFI, HS.getModuleMap().findAllModulesForHeader(File), {}
2202 };
2203 Generator.insert(Key, Data, GeneratorTrait);
Douglas Gregor09b69892011-02-10 17:09:37 +00002204 ++NumHeaderSearchEntries;
2205 }
Richard Smith040e1262017-06-02 01:55:39 +00002206
Douglas Gregor09b69892011-02-10 17:09:37 +00002207 // Create the on-disk hash table in a buffer.
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00002208 SmallString<4096> TableData;
Douglas Gregor09b69892011-02-10 17:09:37 +00002209 uint32_t BucketOffset;
2210 {
Justin Bognere1c147c2014-03-28 22:03:19 +00002211 using namespace llvm::support;
Eugene Zelenkob7d89102017-11-11 00:08:50 +00002212
Douglas Gregor09b69892011-02-10 17:09:37 +00002213 llvm::raw_svector_ostream Out(TableData);
2214 // Make sure that no bucket is at offset 0
Peter Collingbournee3f65292018-05-18 19:46:24 +00002215 endian::write<uint32_t>(Out, 0, little);
Douglas Gregor09b69892011-02-10 17:09:37 +00002216 BucketOffset = Generator.Emit(Out, GeneratorTrait);
2217 }
2218
2219 // Create a blob abbreviation
2220 using namespace llvm;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002221
David Blaikieb44f0bf2017-01-04 22:36:43 +00002222 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Douglas Gregor09b69892011-02-10 17:09:37 +00002223 Abbrev->Add(BitCodeAbbrevOp(HEADER_SEARCH_TABLE));
2224 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
2225 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
Douglas Gregor4b123cb2011-07-28 04:50:02 +00002226 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
Douglas Gregor09b69892011-02-10 17:09:37 +00002227 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
David Blaikieb44f0bf2017-01-04 22:36:43 +00002228 unsigned TableAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00002229
Douglas Gregor4b123cb2011-07-28 04:50:02 +00002230 // Write the header search table
Mehdi Amini57a41912015-09-10 01:46:39 +00002231 RecordData::value_type Record[] = {HEADER_SEARCH_TABLE, BucketOffset,
2232 NumHeaderSearchEntries, TableData.size()};
Douglas Gregor4b123cb2011-07-28 04:50:02 +00002233 TableData.append(GeneratorTrait.strings_begin(),GeneratorTrait.strings_end());
Yaron Keren92e1b622015-03-18 10:17:07 +00002234 Stream.EmitRecordWithBlob(TableAbbrev, Record, TableData);
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00002235
Douglas Gregor09b69892011-02-10 17:09:37 +00002236 // Free all of the strings we had to duplicate.
2237 for (unsigned I = 0, N = SavedStrings.size(); I != N; ++I)
David Greenebae0e352013-01-15 22:09:43 +00002238 free(const_cast<char *>(SavedStrings[I]));
Douglas Gregor09b69892011-02-10 17:09:37 +00002239}
2240
George Rimarc39f5492017-01-17 15:45:31 +00002241static void emitBlob(llvm::BitstreamWriter &Stream, StringRef Blob,
2242 unsigned SLocBufferBlobCompressedAbbrv,
2243 unsigned SLocBufferBlobAbbrv) {
Eugene Zelenkob7d89102017-11-11 00:08:50 +00002244 using RecordDataType = ASTWriter::RecordData::value_type;
George Rimarc39f5492017-01-17 15:45:31 +00002245
2246 // Compress the buffer if possible. We expect that almost all PCM
2247 // consumers will not want its contents.
2248 SmallString<0> CompressedBuffer;
2249 if (llvm::zlib::isAvailable()) {
2250 llvm::Error E = llvm::zlib::compress(Blob.drop_back(1), CompressedBuffer);
2251 if (!E) {
2252 RecordDataType Record[] = {SM_SLOC_BUFFER_BLOB_COMPRESSED,
2253 Blob.size() - 1};
2254 Stream.EmitRecordWithBlob(SLocBufferBlobCompressedAbbrv, Record,
2255 CompressedBuffer);
2256 return;
2257 }
2258 llvm::consumeError(std::move(E));
2259 }
2260
2261 RecordDataType Record[] = {SM_SLOC_BUFFER_BLOB};
2262 Stream.EmitRecordWithBlob(SLocBufferBlobAbbrv, Record, Blob);
2263}
2264
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00002265/// Writes the block containing the serialized form of the
Douglas Gregora7f71a92009-04-10 03:52:48 +00002266/// source manager.
2267///
2268/// TODO: We should probably use an on-disk hash table (stored in a
2269/// blob), indexed based on the file name, so that we only create
2270/// entries for files that we actually need. In the common case (no
2271/// errors), we probably won't have to create file entries for any of
2272/// the files in the AST.
Sebastian Redl55c0ad52010-08-18 23:56:21 +00002273void ASTWriter::WriteSourceManagerBlock(SourceManager &SourceMgr,
Richard Smith7ed1bc92014-12-05 22:42:13 +00002274 const Preprocessor &PP) {
Douglas Gregor258ae542009-04-27 06:38:32 +00002275 RecordData Record;
2276
Chris Lattner0910e3b2009-04-10 17:16:57 +00002277 // Enter the source manager block.
Richard Smithaada85c2016-02-06 02:06:43 +00002278 Stream.EnterSubblock(SOURCE_MANAGER_BLOCK_ID, 4);
Douglas Gregora7f71a92009-04-10 03:52:48 +00002279
2280 // Abbreviations for the various kinds of source-location entries.
Chris Lattnerc4976c732009-04-27 19:03:22 +00002281 unsigned SLocFileAbbrv = CreateSLocFileAbbrev(Stream);
2282 unsigned SLocBufferAbbrv = CreateSLocBufferAbbrev(Stream);
Richard Smithaada85c2016-02-06 02:06:43 +00002283 unsigned SLocBufferBlobAbbrv = CreateSLocBufferBlobAbbrev(Stream, false);
2284 unsigned SLocBufferBlobCompressedAbbrv =
2285 CreateSLocBufferBlobAbbrev(Stream, true);
Chandler Carruthf92ac9e2011-07-15 07:25:21 +00002286 unsigned SLocExpansionAbbrv = CreateSLocExpansionAbbrev(Stream);
Douglas Gregora7f71a92009-04-10 03:52:48 +00002287
Douglas Gregor258ae542009-04-27 06:38:32 +00002288 // Write out the source location entry table. We skip the first
2289 // entry, which is always the same dummy entry.
Chris Lattner12d61d32009-04-27 19:01:47 +00002290 std::vector<uint32_t> SLocEntryOffsets;
Douglas Gregor258ae542009-04-27 06:38:32 +00002291 RecordData PreloadSLocs;
Douglas Gregor925296b2011-07-19 16:10:42 +00002292 SLocEntryOffsets.reserve(SourceMgr.local_sloc_entry_size() - 1);
2293 for (unsigned I = 1, N = SourceMgr.local_sloc_entry_size();
Sebastian Redl5c415f32010-07-22 17:01:13 +00002294 I != N; ++I) {
Douglas Gregor8655e882009-10-16 22:46:09 +00002295 // Get this source location entry.
Douglas Gregor925296b2011-07-19 16:10:42 +00002296 const SrcMgr::SLocEntry *SLoc = &SourceMgr.getLocalSLocEntry(I);
Argyrios Kyrtzidis4db774a2012-10-02 21:09:17 +00002297 FileID FID = FileID::get(I);
2298 assert(&SourceMgr.getSLocEntry(FID) == SLoc);
Kovarththanan Rajaratnama9c81a82010-03-14 07:06:50 +00002299
Douglas Gregor258ae542009-04-27 06:38:32 +00002300 // Record the offset of this source-location entry.
2301 SLocEntryOffsets.push_back(Stream.GetCurrentBitNo());
2302
2303 // Figure out which record code to use.
2304 unsigned Code;
2305 if (SLoc->isFile()) {
Douglas Gregor9dc32122011-11-16 20:05:18 +00002306 const SrcMgr::ContentCache *Cache = SLoc->getFile().getContentCache();
2307 if (Cache->OrigEntry) {
Sebastian Redl539c5062010-08-18 23:57:32 +00002308 Code = SM_SLOC_FILE_ENTRY;
Argyrios Kyrtzidis92dd4662011-06-02 20:01:46 +00002309 } else
Sebastian Redl539c5062010-08-18 23:57:32 +00002310 Code = SM_SLOC_BUFFER_ENTRY;
Douglas Gregor258ae542009-04-27 06:38:32 +00002311 } else
Chandler Carruthf92ac9e2011-07-15 07:25:21 +00002312 Code = SM_SLOC_EXPANSION_ENTRY;
Douglas Gregor258ae542009-04-27 06:38:32 +00002313 Record.clear();
2314 Record.push_back(Code);
2315
Douglas Gregor925296b2011-07-19 16:10:42 +00002316 // Starting offset of this entry within this module, so skip the dummy.
2317 Record.push_back(SLoc->getOffset() - 2);
Douglas Gregor258ae542009-04-27 06:38:32 +00002318 if (SLoc->isFile()) {
2319 const SrcMgr::FileInfo &File = SLoc->getFile();
Richard Smithb22a1d12016-03-27 20:13:24 +00002320 AddSourceLocation(File.getIncludeLoc(), Record);
Douglas Gregor258ae542009-04-27 06:38:32 +00002321 Record.push_back(File.getFileCharacteristic()); // FIXME: stable encoding
2322 Record.push_back(File.hasLineDirectives());
2323
2324 const SrcMgr::ContentCache *Content = File.getContentCache();
Richard Smithaada85c2016-02-06 02:06:43 +00002325 bool EmitBlob = false;
Argyrios Kyrtzidis11e6f0a2011-03-05 01:03:53 +00002326 if (Content->OrigEntry) {
2327 assert(Content->OrigEntry == Content->ContentsEntry &&
Douglas Gregor9dc32122011-11-16 20:05:18 +00002328 "Writing to AST an overridden file is not supported");
Argyrios Kyrtzidis11e6f0a2011-03-05 01:03:53 +00002329
Douglas Gregor3120d2c2012-10-22 18:42:04 +00002330 // The source location entry is a file. Emit input file ID.
2331 assert(InputFileIDs[Content->OrigEntry] != 0 && "Missed file entry");
2332 Record.push_back(InputFileIDs[Content->OrigEntry]);
Mike Stump11289f42009-09-09 15:08:12 +00002333
Argyrios Kyrtzidis61ef3db2011-08-21 23:33:04 +00002334 Record.push_back(File.NumCreatedFIDs);
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00002335
Argyrios Kyrtzidis4db774a2012-10-02 21:09:17 +00002336 FileDeclIDsTy::iterator FDI = FileDeclIDs.find(FID);
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00002337 if (FDI != FileDeclIDs.end()) {
2338 Record.push_back(FDI->second->FirstDeclIndex);
2339 Record.push_back(FDI->second->DeclIDs.size());
2340 } else {
2341 Record.push_back(0);
2342 Record.push_back(0);
2343 }
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00002344
Mehdi Amini5ae4a852015-09-09 20:35:37 +00002345 Stream.EmitRecordWithAbbrev(SLocFileAbbrv, Record);
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00002346
Richard Smithaada85c2016-02-06 02:06:43 +00002347 if (Content->BufferOverridden || Content->IsTransient)
2348 EmitBlob = true;
Douglas Gregor258ae542009-04-27 06:38:32 +00002349 } else {
2350 // The source location entry is a buffer. The blob associated
2351 // with this entry contains the contents of the buffer.
2352
2353 // We add one to the size so that we capture the trailing NULL
2354 // that is required by llvm::MemoryBuffer::getMemBuffer (on
2355 // the reader side).
Duncan P. N. Exon Smithf5848192019-08-26 20:32:05 +00002356 const llvm::MemoryBuffer *Buffer =
2357 Content->getBuffer(PP.getDiagnostics(), PP.getFileManager());
Mehdi Amini99d1b292016-10-01 16:38:28 +00002358 StringRef Name = Buffer->getBufferIdentifier();
Mehdi Amini5ae4a852015-09-09 20:35:37 +00002359 Stream.EmitRecordWithBlob(SLocBufferAbbrv, Record,
Mehdi Amini99d1b292016-10-01 16:38:28 +00002360 StringRef(Name.data(), Name.size() + 1));
Richard Smithaada85c2016-02-06 02:06:43 +00002361 EmitBlob = true;
Douglas Gregor258ae542009-04-27 06:38:32 +00002362
Mehdi Amini99d1b292016-10-01 16:38:28 +00002363 if (Name == "<built-in>")
Douglas Gregor925296b2011-07-19 16:10:42 +00002364 PreloadSLocs.push_back(SLocEntryOffsets.size());
Douglas Gregor258ae542009-04-27 06:38:32 +00002365 }
Richard Smithaada85c2016-02-06 02:06:43 +00002366
2367 if (EmitBlob) {
2368 // Include the implicit terminating null character in the on-disk buffer
2369 // if we're writing it uncompressed.
2370 const llvm::MemoryBuffer *Buffer =
Duncan P. N. Exon Smithf5848192019-08-26 20:32:05 +00002371 Content->getBuffer(PP.getDiagnostics(), PP.getFileManager());
Richard Smithaada85c2016-02-06 02:06:43 +00002372 StringRef Blob(Buffer->getBufferStart(), Buffer->getBufferSize() + 1);
George Rimarc39f5492017-01-17 15:45:31 +00002373 emitBlob(Stream, Blob, SLocBufferBlobCompressedAbbrv,
2374 SLocBufferBlobAbbrv);
Richard Smithaada85c2016-02-06 02:06:43 +00002375 }
Douglas Gregor258ae542009-04-27 06:38:32 +00002376 } else {
Chandler Carruthf92ac9e2011-07-15 07:25:21 +00002377 // The source location entry is a macro expansion.
Chandler Carruthee4c1d12011-07-26 04:56:51 +00002378 const SrcMgr::ExpansionInfo &Expansion = SLoc->getExpansion();
Richard Smithb22a1d12016-03-27 20:13:24 +00002379 AddSourceLocation(Expansion.getSpellingLoc(), Record);
2380 AddSourceLocation(Expansion.getExpansionLocStart(), Record);
2381 AddSourceLocation(Expansion.isMacroArgExpansion()
2382 ? SourceLocation()
2383 : Expansion.getExpansionLocEnd(),
2384 Record);
Richard Smithb5f81712018-04-30 05:25:48 +00002385 Record.push_back(Expansion.isExpansionTokenRange());
Douglas Gregor258ae542009-04-27 06:38:32 +00002386
2387 // Compute the token length for this macro expansion.
Douglas Gregor925296b2011-07-19 16:10:42 +00002388 unsigned NextOffset = SourceMgr.getNextLocalOffset();
Douglas Gregor8655e882009-10-16 22:46:09 +00002389 if (I + 1 != N)
Douglas Gregor925296b2011-07-19 16:10:42 +00002390 NextOffset = SourceMgr.getLocalSLocEntry(I + 1).getOffset();
Douglas Gregor258ae542009-04-27 06:38:32 +00002391 Record.push_back(NextOffset - SLoc->getOffset() - 1);
Mehdi Amini5ae4a852015-09-09 20:35:37 +00002392 Stream.EmitRecordWithAbbrev(SLocExpansionAbbrv, Record);
Douglas Gregor258ae542009-04-27 06:38:32 +00002393 }
2394 }
2395
Douglas Gregor8f45df52009-04-16 22:23:12 +00002396 Stream.ExitBlock();
Douglas Gregor258ae542009-04-27 06:38:32 +00002397
2398 if (SLocEntryOffsets.empty())
2399 return;
2400
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00002401 // Write the source-location offsets table into the AST block. This
Douglas Gregor258ae542009-04-27 06:38:32 +00002402 // table is used for lazily loading source-location information.
2403 using namespace llvm;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002404
David Blaikieb44f0bf2017-01-04 22:36:43 +00002405 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Sebastian Redl539c5062010-08-18 23:57:32 +00002406 Abbrev->Add(BitCodeAbbrevOp(SOURCE_LOCATION_OFFSETS));
Douglas Gregor258ae542009-04-27 06:38:32 +00002407 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 16)); // # of slocs
Douglas Gregor925296b2011-07-19 16:10:42 +00002408 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 16)); // total size
Douglas Gregor258ae542009-04-27 06:38:32 +00002409 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // offsets
David Blaikieb44f0bf2017-01-04 22:36:43 +00002410 unsigned SLocOffsetsAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Mehdi Amini57a41912015-09-10 01:46:39 +00002411 {
2412 RecordData::value_type Record[] = {
2413 SOURCE_LOCATION_OFFSETS, SLocEntryOffsets.size(),
2414 SourceMgr.getNextLocalOffset() - 1 /* skip dummy */};
2415 Stream.EmitRecordWithBlob(SLocOffsetsAbbrev, Record,
2416 bytes(SLocEntryOffsets));
2417 }
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00002418 // Write the source location entry preloads array, telling the AST
Douglas Gregor258ae542009-04-27 06:38:32 +00002419 // reader which source locations entries it should load eagerly.
Sebastian Redl539c5062010-08-18 23:57:32 +00002420 Stream.EmitRecord(SOURCE_LOCATION_PRELOADS, PreloadSLocs);
Douglas Gregor925296b2011-07-19 16:10:42 +00002421
2422 // Write the line table. It depends on remapping working, so it must come
2423 // after the source location offsets.
2424 if (SourceMgr.hasLineTable()) {
2425 LineTableInfo &LineTable = SourceMgr.getLineTable();
2426
2427 Record.clear();
Richard Smith63078492015-09-01 07:41:55 +00002428
2429 // Emit the needed file names.
2430 llvm::DenseMap<int, int> FilenameMap;
Hans Wennborg14487362017-12-04 22:28:45 +00002431 FilenameMap[-1] = -1; // For unspecified filenames.
Richard Smith63078492015-09-01 07:41:55 +00002432 for (const auto &L : LineTable) {
2433 if (L.first.ID < 0)
2434 continue;
2435 for (auto &LE : L.second) {
2436 if (FilenameMap.insert(std::make_pair(LE.FilenameID,
Hans Wennborg14487362017-12-04 22:28:45 +00002437 FilenameMap.size() - 1)).second)
Richard Smith63078492015-09-01 07:41:55 +00002438 AddPath(LineTable.getFilename(LE.FilenameID), Record);
2439 }
2440 }
2441 Record.push_back(0);
Douglas Gregor925296b2011-07-19 16:10:42 +00002442
2443 // Emit the line entries
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002444 for (const auto &L : LineTable) {
Douglas Gregor925296b2011-07-19 16:10:42 +00002445 // Only emit entries for local files.
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002446 if (L.first.ID < 0)
Douglas Gregor925296b2011-07-19 16:10:42 +00002447 continue;
2448
2449 // Emit the file ID
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002450 Record.push_back(L.first.ID);
Douglas Gregor925296b2011-07-19 16:10:42 +00002451
2452 // Emit the line entries
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002453 Record.push_back(L.second.size());
2454 for (const auto &LE : L.second) {
2455 Record.push_back(LE.FileOffset);
2456 Record.push_back(LE.LineNo);
2457 Record.push_back(FilenameMap[LE.FilenameID]);
2458 Record.push_back((unsigned)LE.FileKind);
2459 Record.push_back(LE.IncludeOffset);
Douglas Gregor925296b2011-07-19 16:10:42 +00002460 }
2461 }
Richard Smith63078492015-09-01 07:41:55 +00002462
Douglas Gregor925296b2011-07-19 16:10:42 +00002463 Stream.EmitRecord(SOURCE_MANAGER_LINE_TABLE, Record);
2464 }
Douglas Gregora7f71a92009-04-10 03:52:48 +00002465}
2466
Douglas Gregorc5046832009-04-27 18:38:38 +00002467//===----------------------------------------------------------------------===//
2468// Preprocessor Serialization
2469//===----------------------------------------------------------------------===//
2470
Argyrios Kyrtzidis0aef0f02013-03-15 22:43:10 +00002471static bool shouldIgnoreMacro(MacroDirective *MD, bool IsModule,
2472 const Preprocessor &PP) {
Argyrios Kyrtzidisb6210df2013-03-26 17:17:01 +00002473 if (MacroInfo *MI = MD->getMacroInfo())
2474 if (MI->isBuiltinMacro())
2475 return true;
Argyrios Kyrtzidis0aef0f02013-03-15 22:43:10 +00002476
2477 if (IsModule) {
2478 SourceLocation Loc = MD->getLocation();
2479 if (Loc.isInvalid())
2480 return true;
2481 if (PP.getSourceManager().getFileID(Loc) == PP.getPredefinesFileID())
2482 return true;
2483 }
2484
2485 return false;
2486}
2487
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00002488/// Writes the block containing the serialized form of the
Chris Lattnereeffaef2009-04-10 17:15:23 +00002489/// preprocessor.
Douglas Gregor4a69c2e2011-09-01 17:04:32 +00002490void ASTWriter::WritePreprocessor(const Preprocessor &PP, bool IsModule) {
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002491 PreprocessingRecord *PPRec = PP.getPreprocessingRecord();
2492 if (PPRec)
2493 WritePreprocessorDetail(*PPRec);
2494
Chris Lattnerbaa52f42009-04-10 18:00:12 +00002495 RecordData Record;
Richard Smithd7329392015-04-21 21:46:32 +00002496 RecordData ModuleMacroRecord;
Chris Lattner0910e3b2009-04-10 17:16:57 +00002497
Chris Lattner0af3ba12009-04-13 01:29:17 +00002498 // If the preprocessor __COUNTER__ value has been bumped, remember it.
2499 if (PP.getCounterValue() != 0) {
Mehdi Amini57a41912015-09-10 01:46:39 +00002500 RecordData::value_type Record[] = {PP.getCounterValue()};
Sebastian Redl539c5062010-08-18 23:57:32 +00002501 Stream.EmitRecord(PP_COUNTER_VALUE, Record);
Douglas Gregoreda6a892009-04-26 00:07:37 +00002502 }
2503
Erik Verbruggenb34c79f2017-05-30 11:54:55 +00002504 if (PP.isRecordingPreamble() && PP.hasRecordedPreamble()) {
2505 assert(!IsModule);
Erik Verbruggen4d1eb2d2017-11-03 09:40:07 +00002506 auto SkipInfo = PP.getPreambleSkipInfo();
2507 if (SkipInfo.hasValue()) {
2508 Record.push_back(true);
2509 AddSourceLocation(SkipInfo->HashTokenLoc, Record);
2510 AddSourceLocation(SkipInfo->IfTokenLoc, Record);
2511 Record.push_back(SkipInfo->FoundNonSkipPortion);
2512 Record.push_back(SkipInfo->FoundElse);
2513 AddSourceLocation(SkipInfo->ElseLoc, Record);
2514 } else {
2515 Record.push_back(false);
2516 }
Erik Verbruggenb34c79f2017-05-30 11:54:55 +00002517 for (const auto &Cond : PP.getPreambleConditionalStack()) {
2518 AddSourceLocation(Cond.IfLoc, Record);
2519 Record.push_back(Cond.WasSkipping);
2520 Record.push_back(Cond.FoundNonSkip);
2521 Record.push_back(Cond.FoundElse);
2522 }
2523 Stream.EmitRecord(PP_CONDITIONAL_STACK, Record);
2524 Record.clear();
2525 }
2526
Douglas Gregoreda6a892009-04-26 00:07:37 +00002527 // Enter the preprocessor block.
Douglas Gregor796d76a2010-10-20 22:00:55 +00002528 Stream.EnterSubblock(PREPROCESSOR_BLOCK_ID, 3);
Mike Stump11289f42009-09-09 15:08:12 +00002529
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00002530 // If the AST file contains __DATE__ or __TIME__ emit a warning about this.
Richard Smithb5aaf5a2015-09-01 02:35:58 +00002531 // FIXME: Include a location for the use, and say which one was used.
Douglas Gregoreda6a892009-04-26 00:07:37 +00002532 if (PP.SawDateOrTime())
Richard Smithb5aaf5a2015-09-01 02:35:58 +00002533 PP.Diag(SourceLocation(), diag::warn_module_uses_date_time) << IsModule;
Douglas Gregor796d76a2010-10-20 22:00:55 +00002534
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002535 // Loop over all the macro directives that are live at the end of the file,
Chris Lattnerbaa52f42009-04-10 18:00:12 +00002536 // emitting each to the PP section.
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00002537
Richard Smithee977932015-05-01 21:22:17 +00002538 // Construct the list of identifiers with macro directives that need to be
2539 // serialized.
2540 SmallVector<const IdentifierInfo *, 128> MacroIdentifiers;
2541 for (auto &Id : PP.getIdentifierTable())
2542 if (Id.second->hadMacroDefinition() &&
2543 (!Id.second->isFromAST() ||
2544 Id.second->hasChangedSinceDeserialization()))
2545 MacroIdentifiers.push_back(Id.second);
Douglas Gregor2e5571d2011-02-10 18:20:09 +00002546 // Sort the set of macro definitions that need to be serialized by the
2547 // name of the macro, to provide a stable ordering.
Benjamin Kramercd2bae32019-08-22 17:32:16 +00002548 llvm::sort(MacroIdentifiers, llvm::deref<std::less<>>());
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002549
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002550 // Emit the macro directives as a list and associate the offset with the
2551 // identifier they belong to.
Richard Smithee977932015-05-01 21:22:17 +00002552 for (const IdentifierInfo *Name : MacroIdentifiers) {
2553 MacroDirective *MD = PP.getLocalMacroDirectiveHistory(Name);
Richard Smithd7329392015-04-21 21:46:32 +00002554 auto StartOffset = Stream.GetCurrentBitNo();
2555
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002556 // Emit the macro directives in reverse source order.
2557 for (; MD; MD = MD->getPrevious()) {
Richard Smithd7329392015-04-21 21:46:32 +00002558 // Once we hit an ignored macro, we're done: the rest of the chain
2559 // will all be ignored macros.
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002560 if (shouldIgnoreMacro(MD, IsModule, PP))
Richard Smithd7329392015-04-21 21:46:32 +00002561 break;
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002562
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002563 AddSourceLocation(MD->getLocation(), Record);
Argyrios Kyrtzidisb6210df2013-03-26 17:17:01 +00002564 Record.push_back(MD->getKind());
Richard Smithdaa69e02014-07-25 04:40:03 +00002565 if (auto *DefMD = dyn_cast<DefMacroDirective>(MD)) {
Richard Smith3981b172015-04-30 02:16:23 +00002566 Record.push_back(getMacroRef(DefMD->getInfo(), Name));
Richard Smith713369b2015-04-23 20:40:50 +00002567 } else if (auto *VisMD = dyn_cast<VisibilityMacroDirective>(MD)) {
Argyrios Kyrtzidisb6210df2013-03-26 17:17:01 +00002568 Record.push_back(VisMD->isPublic());
2569 }
Richard Smithb8b2ed62015-04-23 18:18:26 +00002570 }
Richard Smithd7329392015-04-21 21:46:32 +00002571
Richard Smithb8b2ed62015-04-23 18:18:26 +00002572 // Write out any exported module macros.
Richard Smithee977932015-05-01 21:22:17 +00002573 bool EmittedModuleMacros = false;
Manman Ren33d80292016-05-31 18:19:32 +00002574 // We write out exported module macros for PCH as well.
2575 auto Leafs = PP.getLeafModuleMacros(Name);
2576 SmallVector<ModuleMacro*, 8> Worklist(Leafs.begin(), Leafs.end());
2577 llvm::DenseMap<ModuleMacro*, unsigned> Visits;
2578 while (!Worklist.empty()) {
2579 auto *Macro = Worklist.pop_back_val();
Richard Smithd7329392015-04-21 21:46:32 +00002580
Manman Ren33d80292016-05-31 18:19:32 +00002581 // Emit a record indicating this submodule exports this macro.
2582 ModuleMacroRecord.push_back(
2583 getSubmoduleID(Macro->getOwningModule()));
2584 ModuleMacroRecord.push_back(getMacroRef(Macro->getMacroInfo(), Name));
2585 for (auto *M : Macro->overrides())
2586 ModuleMacroRecord.push_back(getSubmoduleID(M->getOwningModule()));
Richard Smithd7329392015-04-21 21:46:32 +00002587
Manman Ren33d80292016-05-31 18:19:32 +00002588 Stream.EmitRecord(PP_MODULE_MACRO, ModuleMacroRecord);
2589 ModuleMacroRecord.clear();
Richard Smithd7329392015-04-21 21:46:32 +00002590
Manman Ren33d80292016-05-31 18:19:32 +00002591 // Enqueue overridden macros once we've visited all their ancestors.
2592 for (auto *M : Macro->overrides())
2593 if (++Visits[M] == M->getNumOverridingMacros())
2594 Worklist.push_back(M);
Richard Smithee977932015-05-01 21:22:17 +00002595
Manman Ren33d80292016-05-31 18:19:32 +00002596 EmittedModuleMacros = true;
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002597 }
Richard Smithd7329392015-04-21 21:46:32 +00002598
Richard Smithee977932015-05-01 21:22:17 +00002599 if (Record.empty() && !EmittedModuleMacros)
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002600 continue;
2601
Richard Smithd7329392015-04-21 21:46:32 +00002602 IdentMacroDirectivesOffsetMap[Name] = StartOffset;
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002603 Stream.EmitRecord(PP_MACRO_DIRECTIVE_HISTORY, Record);
2604 Record.clear();
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002605 }
Alexander Kornienko1d26c022012-09-25 17:18:14 +00002606
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00002607 /// Offsets of each of the macros into the bitstream, indexed by
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00002608 /// the local macro ID
2609 ///
2610 /// For each identifier that is associated with a macro, this map
2611 /// provides the offset into the bitstream where that macro is
2612 /// defined.
2613 std::vector<uint32_t> MacroOffsets;
2614
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002615 for (unsigned I = 0, N = MacroInfosToEmit.size(); I != N; ++I) {
2616 const IdentifierInfo *Name = MacroInfosToEmit[I].Name;
2617 MacroInfo *MI = MacroInfosToEmit[I].MI;
2618 MacroID ID = MacroInfosToEmit[I].ID;
Douglas Gregoreb114da2010-10-01 01:03:07 +00002619
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002620 if (ID < FirstMacroID) {
2621 assert(0 && "Loaded MacroInfo entered MacroInfosToEmit ?");
2622 continue;
Chris Lattner2199f5b2009-04-10 18:08:30 +00002623 }
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002624
2625 // Record the local offset of this macro.
2626 unsigned Index = ID - FirstMacroID;
2627 if (Index == MacroOffsets.size())
2628 MacroOffsets.push_back(Stream.GetCurrentBitNo());
2629 else {
2630 if (Index > MacroOffsets.size())
2631 MacroOffsets.resize(Index + 1);
2632
2633 MacroOffsets[Index] = Stream.GetCurrentBitNo();
2634 }
2635
2636 AddIdentifierRef(Name, Record);
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002637 AddSourceLocation(MI->getDefinitionLoc(), Record);
2638 AddSourceLocation(MI->getDefinitionEndLoc(), Record);
2639 Record.push_back(MI->isUsed());
Argyrios Kyrtzidis9ef53ce2014-04-09 18:21:23 +00002640 Record.push_back(MI->isUsedForHeaderGuard());
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002641 unsigned Code;
2642 if (MI->isObjectLike()) {
2643 Code = PP_MACRO_OBJECT_LIKE;
2644 } else {
2645 Code = PP_MACRO_FUNCTION_LIKE;
2646
2647 Record.push_back(MI->isC99Varargs());
2648 Record.push_back(MI->isGNUVarargs());
2649 Record.push_back(MI->hasCommaPasting());
Faisal Valiac506d72017-07-17 17:18:43 +00002650 Record.push_back(MI->getNumParams());
2651 for (const IdentifierInfo *Param : MI->params())
2652 AddIdentifierRef(Param, Record);
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002653 }
2654
2655 // If we have a detailed preprocessing record, record the macro definition
2656 // ID that corresponds to this macro.
2657 if (PPRec)
2658 Record.push_back(MacroDefinitions[PPRec->findMacroDefinition(MI)]);
2659
2660 Stream.EmitRecord(Code, Record);
2661 Record.clear();
2662
2663 // Emit the tokens array.
2664 for (unsigned TokNo = 0, e = MI->getNumTokens(); TokNo != e; ++TokNo) {
2665 // Note that we know that the preprocessor does not have any annotation
2666 // tokens in it because they are created by the parser, and thus can't
2667 // be in a macro definition.
2668 const Token &Tok = MI->getReplacementToken(TokNo);
John McCallf413f5e2013-05-03 00:10:13 +00002669 AddToken(Tok, Record);
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002670 Stream.EmitRecord(PP_TOKEN, Record);
2671 Record.clear();
2672 }
2673 ++NumMacros;
Chris Lattnerbaa52f42009-04-10 18:00:12 +00002674 }
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002675
Douglas Gregor92a96f52011-02-08 21:58:10 +00002676 Stream.ExitBlock();
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00002677
2678 // Write the offsets table for macro IDs.
2679 using namespace llvm;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002680
David Blaikieb44f0bf2017-01-04 22:36:43 +00002681 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00002682 Abbrev->Add(BitCodeAbbrevOp(MACRO_OFFSET));
2683 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // # of macros
2684 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // first ID
2685 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
2686
David Blaikieb44f0bf2017-01-04 22:36:43 +00002687 unsigned MacroOffsetAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Mehdi Amini57a41912015-09-10 01:46:39 +00002688 {
2689 RecordData::value_type Record[] = {MACRO_OFFSET, MacroOffsets.size(),
2690 FirstMacroID - NUM_PREDEF_MACRO_IDS};
2691 Stream.EmitRecordWithBlob(MacroOffsetAbbrev, Record, bytes(MacroOffsets));
2692 }
Douglas Gregor92a96f52011-02-08 21:58:10 +00002693}
2694
2695void ASTWriter::WritePreprocessorDetail(PreprocessingRecord &PPRec) {
Argyrios Kyrtzidis7f448362011-09-19 20:40:42 +00002696 if (PPRec.local_begin() == PPRec.local_end())
Douglas Gregor92a96f52011-02-08 21:58:10 +00002697 return;
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002698
Argyrios Kyrtzidis64f63812011-09-19 20:40:25 +00002699 SmallVector<PPEntityOffset, 64> PreprocessedEntityOffsets;
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002700
Douglas Gregor92a96f52011-02-08 21:58:10 +00002701 // Enter the preprocessor block.
2702 Stream.EnterSubblock(PREPROCESSOR_DETAIL_BLOCK_ID, 3);
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00002703
Douglas Gregoraae92242010-03-19 21:51:54 +00002704 // If the preprocessor has a preprocessing record, emit it.
2705 unsigned NumPreprocessingRecords = 0;
Douglas Gregor92a96f52011-02-08 21:58:10 +00002706 using namespace llvm;
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00002707
2708 // Set up the abbreviation for
Douglas Gregor92a96f52011-02-08 21:58:10 +00002709 unsigned InclusionAbbrev = 0;
2710 {
David Blaikieb44f0bf2017-01-04 22:36:43 +00002711 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Douglas Gregor92a96f52011-02-08 21:58:10 +00002712 Abbrev->Add(BitCodeAbbrevOp(PPD_INCLUSION_DIRECTIVE));
Douglas Gregor92a96f52011-02-08 21:58:10 +00002713 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // filename length
2714 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // in quotes
2715 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 2)); // kind
Argyrios Kyrtzidisf590e092012-10-02 16:10:46 +00002716 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // imported module
Douglas Gregor92a96f52011-02-08 21:58:10 +00002717 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
David Blaikieb44f0bf2017-01-04 22:36:43 +00002718 InclusionAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregor92a96f52011-02-08 21:58:10 +00002719 }
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00002720
2721 unsigned FirstPreprocessorEntityID
2722 = (Chain ? PPRec.getNumLoadedPreprocessedEntities() : 0)
Douglas Gregor2f555fc2011-08-04 18:56:47 +00002723 + NUM_PREDEF_PP_ENTITY_IDS;
2724 unsigned NextPreprocessorEntityID = FirstPreprocessorEntityID;
Douglas Gregor92a96f52011-02-08 21:58:10 +00002725 RecordData Record;
Argyrios Kyrtzidis7f448362011-09-19 20:40:42 +00002726 for (PreprocessingRecord::iterator E = PPRec.local_begin(),
2727 EEnd = PPRec.local_end();
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00002728 E != EEnd;
Douglas Gregor0d4b4312011-08-04 17:06:18 +00002729 (void)++E, ++NumPreprocessingRecords, ++NextPreprocessorEntityID) {
Douglas Gregor92a96f52011-02-08 21:58:10 +00002730 Record.clear();
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00002731
Richard Smith66a81862015-05-04 02:25:31 +00002732 PreprocessedEntityOffsets.push_back(
2733 PPEntityOffset((*E)->getSourceRange(), Stream.GetCurrentBitNo()));
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002734
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002735 if (auto *MD = dyn_cast<MacroDefinitionRecord>(*E)) {
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002736 // Record this macro definition's ID.
2737 MacroDefinitions[MD] = NextPreprocessorEntityID;
Richard Smith66a81862015-05-04 02:25:31 +00002738
Douglas Gregor92a96f52011-02-08 21:58:10 +00002739 AddIdentifierRef(MD->getName(), Record);
Douglas Gregor92a96f52011-02-08 21:58:10 +00002740 Stream.EmitRecord(PPD_MACRO_DEFINITION, Record);
2741 continue;
Douglas Gregoraae92242010-03-19 21:51:54 +00002742 }
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00002743
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002744 if (auto *ME = dyn_cast<MacroExpansion>(*E)) {
Argyrios Kyrtzidis80f78b92011-09-08 17:18:41 +00002745 Record.push_back(ME->isBuiltinMacro());
2746 if (ME->isBuiltinMacro())
2747 AddIdentifierRef(ME->getName(), Record);
2748 else
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002749 Record.push_back(MacroDefinitions[ME->getDefinition()]);
Chandler Carruthf92ac9e2011-07-15 07:25:21 +00002750 Stream.EmitRecord(PPD_MACRO_EXPANSION, Record);
Douglas Gregor92a96f52011-02-08 21:58:10 +00002751 continue;
2752 }
2753
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002754 if (auto *ID = dyn_cast<InclusionDirective>(*E)) {
Douglas Gregor92a96f52011-02-08 21:58:10 +00002755 Record.push_back(PPD_INCLUSION_DIRECTIVE);
Douglas Gregor92a96f52011-02-08 21:58:10 +00002756 Record.push_back(ID->getFileName().size());
2757 Record.push_back(ID->wasInQuotes());
2758 Record.push_back(static_cast<unsigned>(ID->getKind()));
Argyrios Kyrtzidisf590e092012-10-02 16:10:46 +00002759 Record.push_back(ID->importedModule());
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00002760 SmallString<64> Buffer;
Douglas Gregor92a96f52011-02-08 21:58:10 +00002761 Buffer += ID->getFileName();
Argyrios Kyrtzidis8dbcfc32012-03-08 01:08:28 +00002762 // Check that the FileEntry is not null because it was not resolved and
2763 // we create a PCH even with compiler errors.
2764 if (ID->getFile())
2765 Buffer += ID->getFile()->getName();
Mehdi Amini5ae4a852015-09-09 20:35:37 +00002766 Stream.EmitRecordWithBlob(InclusionAbbrev, Record, Buffer);
Douglas Gregor92a96f52011-02-08 21:58:10 +00002767 continue;
2768 }
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00002769
Douglas Gregor92a96f52011-02-08 21:58:10 +00002770 llvm_unreachable("Unhandled PreprocessedEntity in ASTWriter");
2771 }
Douglas Gregor8f45df52009-04-16 22:23:12 +00002772 Stream.ExitBlock();
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00002773
Douglas Gregoraae92242010-03-19 21:51:54 +00002774 // Write the offsets table for the preprocessing record.
2775 if (NumPreprocessingRecords > 0) {
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002776 assert(PreprocessedEntityOffsets.size() == NumPreprocessingRecords);
2777
Douglas Gregoraae92242010-03-19 21:51:54 +00002778 // Write the offsets table for identifier IDs.
2779 using namespace llvm;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002780
David Blaikieb44f0bf2017-01-04 22:36:43 +00002781 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002782 Abbrev->Add(BitCodeAbbrevOp(PPD_ENTITIES_OFFSETS));
Douglas Gregor2f555fc2011-08-04 18:56:47 +00002783 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // first pp entity
Douglas Gregoraae92242010-03-19 21:51:54 +00002784 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
David Blaikieb44f0bf2017-01-04 22:36:43 +00002785 unsigned PPEOffsetAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00002786
Mehdi Amini57a41912015-09-10 01:46:39 +00002787 RecordData::value_type Record[] = {PPD_ENTITIES_OFFSETS,
2788 FirstPreprocessorEntityID -
2789 NUM_PREDEF_PP_ENTITY_IDS};
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002790 Stream.EmitRecordWithBlob(PPEOffsetAbbrev, Record,
Reid Kleckner012665e2015-05-21 00:13:09 +00002791 bytes(PreprocessedEntityOffsets));
Douglas Gregoraae92242010-03-19 21:51:54 +00002792 }
Cameron Desrochersb60f1b62018-01-15 19:14:16 +00002793
2794 // Write the skipped region table for the preprocessing record.
2795 ArrayRef<SourceRange> SkippedRanges = PPRec.getSkippedRanges();
2796 if (SkippedRanges.size() > 0) {
2797 std::vector<PPSkippedRange> SerializedSkippedRanges;
2798 SerializedSkippedRanges.reserve(SkippedRanges.size());
2799 for (auto const& Range : SkippedRanges)
2800 SerializedSkippedRanges.emplace_back(Range);
2801
2802 using namespace llvm;
2803 auto Abbrev = std::make_shared<BitCodeAbbrev>();
2804 Abbrev->Add(BitCodeAbbrevOp(PPD_SKIPPED_RANGES));
2805 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
2806 unsigned PPESkippedRangeAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
2807
2808 Record.clear();
2809 Record.push_back(PPD_SKIPPED_RANGES);
2810 Stream.EmitRecordWithBlob(PPESkippedRangeAbbrev, Record,
2811 bytes(SerializedSkippedRanges));
2812 }
Chris Lattnereeffaef2009-04-10 17:15:23 +00002813}
2814
Richard Smith386bb072015-08-18 23:42:23 +00002815unsigned ASTWriter::getLocalOrImportedSubmoduleID(Module *Mod) {
Richard Smith080056b2015-08-18 21:53:42 +00002816 if (!Mod)
2817 return 0;
2818
Douglas Gregora89c5ac2011-12-06 01:10:29 +00002819 llvm::DenseMap<Module *, unsigned>::iterator Known = SubmoduleIDs.find(Mod);
2820 if (Known != SubmoduleIDs.end())
2821 return Known->second;
Richard Smith386bb072015-08-18 23:42:23 +00002822
Richard Smithdc1f0422016-07-20 19:10:16 +00002823 auto *Top = Mod->getTopLevelModule();
2824 if (Top != WritingModule &&
Bruno Cardoso Lopes17da34d2017-02-07 21:54:57 +00002825 (getLangOpts().CompilingPCH ||
2826 !Top->fullModuleNameIs(StringRef(getLangOpts().CurrentModule))))
Richard Smith386bb072015-08-18 23:42:23 +00002827 return 0;
2828
Douglas Gregora89c5ac2011-12-06 01:10:29 +00002829 return SubmoduleIDs[Mod] = NextSubmoduleID++;
2830}
2831
Richard Smith386bb072015-08-18 23:42:23 +00002832unsigned ASTWriter::getSubmoduleID(Module *Mod) {
2833 // FIXME: This can easily happen, if we have a reference to a submodule that
2834 // did not result in us loading a module file for that submodule. For
2835 // instance, a cross-top-level-module 'conflict' declaration will hit this.
2836 unsigned ID = getLocalOrImportedSubmoduleID(Mod);
2837 assert((ID || !Mod) &&
2838 "asked for module ID for non-local, non-imported module");
2839 return ID;
Argyrios Kyrtzidisb146baa2013-03-13 21:13:51 +00002840}
2841
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00002842/// Compute the number of modules within the given tree (including the
Douglas Gregor253eefe2011-12-01 00:59:36 +00002843/// given module).
2844static unsigned getNumberOfModules(Module *Mod) {
2845 unsigned ChildModules = 0;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002846 for (auto Sub = Mod->submodule_begin(), SubEnd = Mod->submodule_end();
Douglas Gregor253eefe2011-12-01 00:59:36 +00002847 Sub != SubEnd; ++Sub)
Douglas Gregoreb90e832012-01-04 23:32:19 +00002848 ChildModules += getNumberOfModules(*Sub);
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00002849
Douglas Gregor253eefe2011-12-01 00:59:36 +00002850 return ChildModules + 1;
2851}
2852
Douglas Gregorde3ef502011-11-30 23:21:26 +00002853void ASTWriter::WriteSubmodules(Module *WritingModule) {
Douglas Gregor69021972011-11-30 17:33:56 +00002854 // Enter the submodule description block.
Richard Smith202210b2014-10-24 20:23:01 +00002855 Stream.EnterSubblock(SUBMODULE_BLOCK_ID, /*bits for abbreviations*/5);
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00002856
Douglas Gregor69021972011-11-30 17:33:56 +00002857 // Write the abbreviations needed for the submodules block.
2858 using namespace llvm;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002859
David Blaikieb44f0bf2017-01-04 22:36:43 +00002860 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Douglas Gregor69021972011-11-30 17:33:56 +00002861 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_DEFINITION));
Douglas Gregora89c5ac2011-12-06 01:10:29 +00002862 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // ID
Douglas Gregor69021972011-11-30 17:33:56 +00002863 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Parent
Richard Smithdd8b5332017-09-04 05:37:53 +00002864 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 2)); // Kind
Douglas Gregor69021972011-11-30 17:33:56 +00002865 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // IsFramework
2866 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // IsExplicit
Richard Smith9bca2982014-03-08 00:03:56 +00002867 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // IsSystem
2868 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // IsExternC
Douglas Gregora686e1b2012-01-27 19:52:33 +00002869 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // InferSubmodules...
Douglas Gregor73441092011-12-05 22:27:44 +00002870 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // InferExplicit...
Douglas Gregor73441092011-12-05 22:27:44 +00002871 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // InferExportWild...
Douglas Gregor35b13ec2013-03-20 00:22:05 +00002872 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // ConfigMacrosExh...
Jordan Rose90b0a1f2018-04-20 17:16:04 +00002873 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // ModuleMapIsPriv...
Douglas Gregor69021972011-11-30 17:33:56 +00002874 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
David Blaikieb44f0bf2017-01-04 22:36:43 +00002875 unsigned DefinitionAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregor69021972011-11-30 17:33:56 +00002876
David Blaikieb44f0bf2017-01-04 22:36:43 +00002877 Abbrev = std::make_shared<BitCodeAbbrev>();
Douglas Gregor524e33e2011-12-08 19:11:24 +00002878 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_UMBRELLA_HEADER));
Douglas Gregor69021972011-11-30 17:33:56 +00002879 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
David Blaikieb44f0bf2017-01-04 22:36:43 +00002880 unsigned UmbrellaAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregor69021972011-11-30 17:33:56 +00002881
David Blaikieb44f0bf2017-01-04 22:36:43 +00002882 Abbrev = std::make_shared<BitCodeAbbrev>();
Douglas Gregor69021972011-11-30 17:33:56 +00002883 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_HEADER));
2884 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
David Blaikieb44f0bf2017-01-04 22:36:43 +00002885 unsigned HeaderAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregor524e33e2011-12-08 19:11:24 +00002886
David Blaikieb44f0bf2017-01-04 22:36:43 +00002887 Abbrev = std::make_shared<BitCodeAbbrev>();
Argyrios Kyrtzidisc597c8c2012-10-05 00:22:33 +00002888 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_TOPHEADER));
2889 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
David Blaikieb44f0bf2017-01-04 22:36:43 +00002890 unsigned TopHeaderAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Argyrios Kyrtzidisc597c8c2012-10-05 00:22:33 +00002891
David Blaikieb44f0bf2017-01-04 22:36:43 +00002892 Abbrev = std::make_shared<BitCodeAbbrev>();
Douglas Gregor524e33e2011-12-08 19:11:24 +00002893 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_UMBRELLA_DIR));
2894 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
David Blaikieb44f0bf2017-01-04 22:36:43 +00002895 unsigned UmbrellaDirAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregor524e33e2011-12-08 19:11:24 +00002896
David Blaikieb44f0bf2017-01-04 22:36:43 +00002897 Abbrev = std::make_shared<BitCodeAbbrev>();
Douglas Gregor1fb5c3a2011-12-31 04:05:44 +00002898 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_REQUIRES));
Richard Smitha3feee22013-10-28 22:18:19 +00002899 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // State
2900 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Feature
David Blaikieb44f0bf2017-01-04 22:36:43 +00002901 unsigned RequiresAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregor1fb5c3a2011-12-31 04:05:44 +00002902
David Blaikieb44f0bf2017-01-04 22:36:43 +00002903 Abbrev = std::make_shared<BitCodeAbbrev>();
Douglas Gregor59527662012-10-15 06:28:11 +00002904 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_EXCLUDED_HEADER));
2905 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
David Blaikieb44f0bf2017-01-04 22:36:43 +00002906 unsigned ExcludedHeaderAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregor59527662012-10-15 06:28:11 +00002907
David Blaikieb44f0bf2017-01-04 22:36:43 +00002908 Abbrev = std::make_shared<BitCodeAbbrev>();
Richard Smith306d8922014-10-22 23:50:56 +00002909 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_TEXTUAL_HEADER));
2910 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
David Blaikieb44f0bf2017-01-04 22:36:43 +00002911 unsigned TextualHeaderAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Richard Smith306d8922014-10-22 23:50:56 +00002912
David Blaikieb44f0bf2017-01-04 22:36:43 +00002913 Abbrev = std::make_shared<BitCodeAbbrev>();
Lawrence Crowlb53e5482013-06-20 21:14:14 +00002914 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_PRIVATE_HEADER));
2915 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
David Blaikieb44f0bf2017-01-04 22:36:43 +00002916 unsigned PrivateHeaderAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Lawrence Crowlb53e5482013-06-20 21:14:14 +00002917
David Blaikieb44f0bf2017-01-04 22:36:43 +00002918 Abbrev = std::make_shared<BitCodeAbbrev>();
Richard Smith202210b2014-10-24 20:23:01 +00002919 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_PRIVATE_TEXTUAL_HEADER));
2920 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
David Blaikieb44f0bf2017-01-04 22:36:43 +00002921 unsigned PrivateTextualHeaderAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Richard Smith202210b2014-10-24 20:23:01 +00002922
David Blaikieb44f0bf2017-01-04 22:36:43 +00002923 Abbrev = std::make_shared<BitCodeAbbrev>();
Douglas Gregor6ddfca92013-01-14 17:21:00 +00002924 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_LINK_LIBRARY));
2925 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // IsFramework
2926 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
David Blaikieb44f0bf2017-01-04 22:36:43 +00002927 unsigned LinkLibraryAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregor6ddfca92013-01-14 17:21:00 +00002928
David Blaikieb44f0bf2017-01-04 22:36:43 +00002929 Abbrev = std::make_shared<BitCodeAbbrev>();
Douglas Gregor35b13ec2013-03-20 00:22:05 +00002930 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_CONFIG_MACRO));
2931 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Macro name
David Blaikieb44f0bf2017-01-04 22:36:43 +00002932 unsigned ConfigMacroAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregor35b13ec2013-03-20 00:22:05 +00002933
David Blaikieb44f0bf2017-01-04 22:36:43 +00002934 Abbrev = std::make_shared<BitCodeAbbrev>();
Douglas Gregorfb912652013-03-20 21:10:35 +00002935 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_CONFLICT));
2936 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Other module
2937 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Message
David Blaikieb44f0bf2017-01-04 22:36:43 +00002938 unsigned ConflictAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregorfb912652013-03-20 21:10:35 +00002939
Douglas Gregorf0b11de2017-09-14 23:38:44 +00002940 Abbrev = std::make_shared<BitCodeAbbrev>();
2941 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_EXPORT_AS));
2942 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Macro name
2943 unsigned ExportAsAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
2944
Douglas Gregor253eefe2011-12-01 00:59:36 +00002945 // Write the submodule metadata block.
Richard Smith145e15a2017-04-24 23:12:30 +00002946 RecordData::value_type Record[] = {
2947 getNumberOfModules(WritingModule),
Richard Smithdd8b5332017-09-04 05:37:53 +00002948 FirstSubmoduleID - NUM_PREDEF_SUBMODULE_IDS};
Douglas Gregor253eefe2011-12-01 00:59:36 +00002949 Stream.EmitRecord(SUBMODULE_METADATA, Record);
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00002950
Douglas Gregor69021972011-11-30 17:33:56 +00002951 // Write all of the submodules.
Douglas Gregorde3ef502011-11-30 23:21:26 +00002952 std::queue<Module *> Q;
Douglas Gregor69021972011-11-30 17:33:56 +00002953 Q.push(WritingModule);
Douglas Gregor69021972011-11-30 17:33:56 +00002954 while (!Q.empty()) {
Douglas Gregorde3ef502011-11-30 23:21:26 +00002955 Module *Mod = Q.front();
Douglas Gregor69021972011-11-30 17:33:56 +00002956 Q.pop();
Douglas Gregora89c5ac2011-12-06 01:10:29 +00002957 unsigned ID = getSubmoduleID(Mod);
Mehdi Amini57a41912015-09-10 01:46:39 +00002958
2959 uint64_t ParentID = 0;
Douglas Gregor69021972011-11-30 17:33:56 +00002960 if (Mod->Parent) {
2961 assert(SubmoduleIDs[Mod->Parent] && "Submodule parent not written?");
Mehdi Amini57a41912015-09-10 01:46:39 +00002962 ParentID = SubmoduleIDs[Mod->Parent];
Douglas Gregor69021972011-11-30 17:33:56 +00002963 }
Mehdi Amini57a41912015-09-10 01:46:39 +00002964
2965 // Emit the definition of the block.
2966 {
David Blaikie9ffe5a32017-01-30 05:00:26 +00002967 RecordData::value_type Record[] = {SUBMODULE_DEFINITION,
2968 ID,
2969 ParentID,
Simon Pilgrimf331a662017-09-04 10:54:39 +00002970 (RecordData::value_type)Mod->Kind,
David Blaikie9ffe5a32017-01-30 05:00:26 +00002971 Mod->IsFramework,
2972 Mod->IsExplicit,
2973 Mod->IsSystem,
2974 Mod->IsExternC,
2975 Mod->InferSubmodules,
2976 Mod->InferExplicitSubmodules,
2977 Mod->InferExportWildcard,
Jordan Rose90b0a1f2018-04-20 17:16:04 +00002978 Mod->ConfigMacrosExhaustive,
2979 Mod->ModuleMapIsPrivate};
Mehdi Amini57a41912015-09-10 01:46:39 +00002980 Stream.EmitRecordWithBlob(DefinitionAbbrev, Record, Mod->Name);
2981 }
2982
Douglas Gregor1fb5c3a2011-12-31 04:05:44 +00002983 // Emit the requirements.
Richard Smith080056b2015-08-18 21:53:42 +00002984 for (const auto &R : Mod->Requirements) {
Mehdi Amini57a41912015-09-10 01:46:39 +00002985 RecordData::value_type Record[] = {SUBMODULE_REQUIRES, R.second};
Richard Smith080056b2015-08-18 21:53:42 +00002986 Stream.EmitRecordWithBlob(RequiresAbbrev, Record, R.first);
Douglas Gregor1fb5c3a2011-12-31 04:05:44 +00002987 }
2988
Douglas Gregor69021972011-11-30 17:33:56 +00002989 // Emit the umbrella header, if there is one.
Richard Smith2b63d152015-05-16 02:28:53 +00002990 if (auto UmbrellaHeader = Mod->getUmbrellaHeader()) {
Mehdi Amini57a41912015-09-10 01:46:39 +00002991 RecordData::value_type Record[] = {SUBMODULE_UMBRELLA_HEADER};
Richard Smith2b63d152015-05-16 02:28:53 +00002992 Stream.EmitRecordWithBlob(UmbrellaAbbrev, Record,
2993 UmbrellaHeader.NameAsWritten);
2994 } else if (auto UmbrellaDir = Mod->getUmbrellaDir()) {
Mehdi Amini57a41912015-09-10 01:46:39 +00002995 RecordData::value_type Record[] = {SUBMODULE_UMBRELLA_DIR};
2996 Stream.EmitRecordWithBlob(UmbrellaDirAbbrev, Record,
Richard Smith2b63d152015-05-16 02:28:53 +00002997 UmbrellaDir.NameAsWritten);
Douglas Gregor69021972011-11-30 17:33:56 +00002998 }
Richard Smith306d8922014-10-22 23:50:56 +00002999
Douglas Gregor69021972011-11-30 17:33:56 +00003000 // Emit the headers.
Richard Smith202210b2014-10-24 20:23:01 +00003001 struct {
Richard Smith3c1a41a2014-12-02 00:08:08 +00003002 unsigned RecordKind;
Richard Smith202210b2014-10-24 20:23:01 +00003003 unsigned Abbrev;
Richard Smith3c1a41a2014-12-02 00:08:08 +00003004 Module::HeaderKind HeaderKind;
Richard Smith202210b2014-10-24 20:23:01 +00003005 } HeaderLists[] = {
Richard Smith3c1a41a2014-12-02 00:08:08 +00003006 {SUBMODULE_HEADER, HeaderAbbrev, Module::HK_Normal},
3007 {SUBMODULE_TEXTUAL_HEADER, TextualHeaderAbbrev, Module::HK_Textual},
3008 {SUBMODULE_PRIVATE_HEADER, PrivateHeaderAbbrev, Module::HK_Private},
Richard Smith202210b2014-10-24 20:23:01 +00003009 {SUBMODULE_PRIVATE_TEXTUAL_HEADER, PrivateTextualHeaderAbbrev,
Richard Smith3c1a41a2014-12-02 00:08:08 +00003010 Module::HK_PrivateTextual},
3011 {SUBMODULE_EXCLUDED_HEADER, ExcludedHeaderAbbrev, Module::HK_Excluded}
Richard Smith202210b2014-10-24 20:23:01 +00003012 };
3013 for (auto &HL : HeaderLists) {
Mehdi Amini57a41912015-09-10 01:46:39 +00003014 RecordData::value_type Record[] = {HL.RecordKind};
Richard Smith3c1a41a2014-12-02 00:08:08 +00003015 for (auto &H : Mod->Headers[HL.HeaderKind])
3016 Stream.EmitRecordWithBlob(HL.Abbrev, Record, H.NameAsWritten);
3017 }
3018
3019 // Emit the top headers.
3020 {
3021 auto TopHeaders = Mod->getTopHeaders(PP->getFileManager());
Mehdi Amini57a41912015-09-10 01:46:39 +00003022 RecordData::value_type Record[] = {SUBMODULE_TOPHEADER};
Richard Smith3c1a41a2014-12-02 00:08:08 +00003023 for (auto *H : TopHeaders)
3024 Stream.EmitRecordWithBlob(TopHeaderAbbrev, Record, H->getName());
Argyrios Kyrtzidisc597c8c2012-10-05 00:22:33 +00003025 }
Douglas Gregor0093b3c2011-12-05 16:33:54 +00003026
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00003027 // Emit the imports.
Douglas Gregor0093b3c2011-12-05 16:33:54 +00003028 if (!Mod->Imports.empty()) {
Mehdi Amini57a41912015-09-10 01:46:39 +00003029 RecordData Record;
Richard Smith080056b2015-08-18 21:53:42 +00003030 for (auto *I : Mod->Imports)
3031 Record.push_back(getSubmoduleID(I));
Douglas Gregor0093b3c2011-12-05 16:33:54 +00003032 Stream.EmitRecord(SUBMODULE_IMPORTS, Record);
3033 }
3034
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00003035 // Emit the exports.
Douglas Gregor24bb9232011-12-02 18:58:38 +00003036 if (!Mod->Exports.empty()) {
Mehdi Amini57a41912015-09-10 01:46:39 +00003037 RecordData Record;
Richard Smith080056b2015-08-18 21:53:42 +00003038 for (const auto &E : Mod->Exports) {
3039 // FIXME: This may fail; we don't require that all exported modules
3040 // are local or imported.
3041 Record.push_back(getSubmoduleID(E.getPointer()));
3042 Record.push_back(E.getInt());
Douglas Gregor24bb9232011-12-02 18:58:38 +00003043 }
3044 Stream.EmitRecord(SUBMODULE_EXPORTS, Record);
3045 }
Douglas Gregor6ddfca92013-01-14 17:21:00 +00003046
Daniel Jasperba7f2f72013-09-24 09:14:14 +00003047 //FIXME: How do we emit the 'use'd modules? They may not be submodules.
3048 // Might be unnecessary as use declarations are only used to build the
3049 // module itself.
3050
Douglas Gregor6ddfca92013-01-14 17:21:00 +00003051 // Emit the link libraries.
Richard Smith080056b2015-08-18 21:53:42 +00003052 for (const auto &LL : Mod->LinkLibraries) {
Mehdi Amini57a41912015-09-10 01:46:39 +00003053 RecordData::value_type Record[] = {SUBMODULE_LINK_LIBRARY,
3054 LL.IsFramework};
Richard Smith080056b2015-08-18 21:53:42 +00003055 Stream.EmitRecordWithBlob(LinkLibraryAbbrev, Record, LL.Library);
Douglas Gregor6ddfca92013-01-14 17:21:00 +00003056 }
3057
Douglas Gregorfb912652013-03-20 21:10:35 +00003058 // Emit the conflicts.
Richard Smith080056b2015-08-18 21:53:42 +00003059 for (const auto &C : Mod->Conflicts) {
Richard Smith080056b2015-08-18 21:53:42 +00003060 // FIXME: This may fail; we don't require that all conflicting modules
3061 // are local or imported.
Mehdi Amini57a41912015-09-10 01:46:39 +00003062 RecordData::value_type Record[] = {SUBMODULE_CONFLICT,
3063 getSubmoduleID(C.Other)};
Richard Smith080056b2015-08-18 21:53:42 +00003064 Stream.EmitRecordWithBlob(ConflictAbbrev, Record, C.Message);
Douglas Gregorfb912652013-03-20 21:10:35 +00003065 }
3066
Douglas Gregor35b13ec2013-03-20 00:22:05 +00003067 // Emit the configuration macros.
Richard Smith080056b2015-08-18 21:53:42 +00003068 for (const auto &CM : Mod->ConfigMacros) {
Mehdi Amini57a41912015-09-10 01:46:39 +00003069 RecordData::value_type Record[] = {SUBMODULE_CONFIG_MACRO};
Richard Smith080056b2015-08-18 21:53:42 +00003070 Stream.EmitRecordWithBlob(ConfigMacroAbbrev, Record, CM);
Douglas Gregor35b13ec2013-03-20 00:22:05 +00003071 }
3072
Richard Smithdc1f0422016-07-20 19:10:16 +00003073 // Emit the initializers, if any.
3074 RecordData Inits;
3075 for (Decl *D : Context->getModuleInitializers(Mod))
3076 Inits.push_back(GetDeclRef(D));
3077 if (!Inits.empty())
3078 Stream.EmitRecord(SUBMODULE_INITIALIZERS, Inits);
3079
Douglas Gregorf0b11de2017-09-14 23:38:44 +00003080 // Emit the name of the re-exported module, if any.
3081 if (!Mod->ExportAsModule.empty()) {
3082 RecordData::value_type Record[] = {SUBMODULE_EXPORT_AS};
3083 Stream.EmitRecordWithBlob(ExportAsAbbrev, Record, Mod->ExportAsModule);
3084 }
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00003085
Douglas Gregor69021972011-11-30 17:33:56 +00003086 // Queue up the submodules of this module.
Richard Smith080056b2015-08-18 21:53:42 +00003087 for (auto *M : Mod->submodules())
3088 Q.push(M);
Douglas Gregor69021972011-11-30 17:33:56 +00003089 }
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00003090
Douglas Gregor69021972011-11-30 17:33:56 +00003091 Stream.ExitBlock();
Richard Smith23d8d032015-05-14 00:45:20 +00003092
Richard Smith23d8d032015-05-14 00:45:20 +00003093 assert((NextSubmoduleID - FirstSubmoduleID ==
3094 getNumberOfModules(WritingModule)) &&
3095 "Wrong # of submodules; found a reference to a non-local, "
3096 "non-imported submodule?");
Douglas Gregor69021972011-11-30 17:33:56 +00003097}
3098
Argyrios Kyrtzidis0f06b982013-03-27 17:17:23 +00003099void ASTWriter::WritePragmaDiagnosticMappings(const DiagnosticsEngine &Diag,
3100 bool isModule) {
Argyrios Kyrtzidisefaa54a2012-10-30 00:27:21 +00003101 llvm::SmallDenseMap<const DiagnosticsEngine::DiagState *, unsigned, 64>
3102 DiagStateIDMap;
3103 unsigned CurrID = 0;
Argyrios Kyrtzidis452707c2010-11-05 22:10:18 +00003104 RecordData Record;
Argyrios Kyrtzidis243aedb2011-01-14 20:54:07 +00003105
Richard Smithe37391c2017-05-03 00:28:49 +00003106 auto EncodeDiagStateFlags =
3107 [](const DiagnosticsEngine::DiagState *DS) -> unsigned {
3108 unsigned Result = (unsigned)DS->ExtBehavior;
3109 for (unsigned Val :
Daniel Jasperba9aefc2017-05-03 07:48:27 +00003110 {(unsigned)DS->IgnoreAllWarnings, (unsigned)DS->EnableAllWarnings,
3111 (unsigned)DS->WarningsAsErrors, (unsigned)DS->ErrorsAsFatal,
3112 (unsigned)DS->SuppressSystemWarnings})
Richard Smithe37391c2017-05-03 00:28:49 +00003113 Result = (Result << 1) | Val;
3114 return Result;
3115 };
3116
3117 unsigned Flags = EncodeDiagStateFlags(Diag.DiagStatesByLoc.FirstDiagState);
3118 Record.push_back(Flags);
3119
Richard Smithd230de22017-01-26 01:01:01 +00003120 auto AddDiagState = [&](const DiagnosticsEngine::DiagState *State,
3121 bool IncludeNonPragmaStates) {
Richard Smithe37391c2017-05-03 00:28:49 +00003122 // Ensure that the diagnostic state wasn't modified since it was created.
3123 // We will not correctly round-trip this information otherwise.
3124 assert(Flags == EncodeDiagStateFlags(State) &&
3125 "diag state flags vary in single AST file");
3126
Richard Smithd230de22017-01-26 01:01:01 +00003127 unsigned &DiagStateID = DiagStateIDMap[State];
Argyrios Kyrtzidisefaa54a2012-10-30 00:27:21 +00003128 Record.push_back(DiagStateID);
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00003129
Argyrios Kyrtzidisefaa54a2012-10-30 00:27:21 +00003130 if (DiagStateID == 0) {
3131 DiagStateID = ++CurrID;
Duncan P. N. Exon Smith3cb183b2017-03-14 19:31:27 +00003132
3133 // Add a placeholder for the number of mappings.
3134 auto SizeIdx = Record.size();
3135 Record.emplace_back();
Richard Smithd230de22017-01-26 01:01:01 +00003136 for (const auto &I : *State) {
3137 if (I.second.isPragma() || IncludeNonPragmaStates) {
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00003138 Record.push_back(I.first);
Richard Smithe37391c2017-05-03 00:28:49 +00003139 Record.push_back(I.second.serialize());
Argyrios Kyrtzidisefaa54a2012-10-30 00:27:21 +00003140 }
Argyrios Kyrtzidis243aedb2011-01-14 20:54:07 +00003141 }
Duncan P. N. Exon Smith3cb183b2017-03-14 19:31:27 +00003142 // Update the placeholder.
3143 Record[SizeIdx] = (Record.size() - SizeIdx) / 2;
Richard Smithd230de22017-01-26 01:01:01 +00003144 }
3145 };
3146
3147 AddDiagState(Diag.DiagStatesByLoc.FirstDiagState, isModule);
Richard Smithd230de22017-01-26 01:01:01 +00003148
Duncan P. N. Exon Smitha351c102017-04-12 03:45:32 +00003149 // Reserve a spot for the number of locations with state transitions.
3150 auto NumLocationsIdx = Record.size();
3151 Record.emplace_back();
3152
3153 // Emit the state transitions.
3154 unsigned NumLocations = 0;
Richard Smithd230de22017-01-26 01:01:01 +00003155 for (auto &FileIDAndFile : Diag.DiagStatesByLoc.Files) {
3156 if (!FileIDAndFile.first.isValid() ||
3157 !FileIDAndFile.second.HasLocalTransitions)
3158 continue;
Duncan P. N. Exon Smitha351c102017-04-12 03:45:32 +00003159 ++NumLocations;
Richard Smith6c2b5a82018-02-09 01:15:13 +00003160
3161 SourceLocation Loc = Diag.SourceMgr->getComposedLoc(FileIDAndFile.first, 0);
3162 assert(!Loc.isInvalid() && "start loc for valid FileID is invalid");
3163 AddSourceLocation(Loc, Record);
3164
Richard Smithd230de22017-01-26 01:01:01 +00003165 Record.push_back(FileIDAndFile.second.StateTransitions.size());
3166 for (auto &StatePoint : FileIDAndFile.second.StateTransitions) {
3167 Record.push_back(StatePoint.Offset);
3168 AddDiagState(StatePoint.State, false);
Argyrios Kyrtzidis452707c2010-11-05 22:10:18 +00003169 }
3170 }
3171
Duncan P. N. Exon Smitha351c102017-04-12 03:45:32 +00003172 // Backpatch the number of locations.
3173 Record[NumLocationsIdx] = NumLocations;
3174
3175 // Emit CurDiagStateLoc. Do it last in order to match source order.
Duncan P. N. Exon Smith900f8172017-04-12 03:58:58 +00003176 //
3177 // This also protects against a hypothetical corner case with simulating
3178 // -Werror settings for implicit modules in the ASTReader, where reading
3179 // CurDiagState out of context could change whether warning pragmas are
3180 // treated as errors.
Duncan P. N. Exon Smitha351c102017-04-12 03:45:32 +00003181 AddSourceLocation(Diag.DiagStatesByLoc.CurDiagStateLoc, Record);
3182 AddDiagState(Diag.DiagStatesByLoc.CurDiagState, false);
3183
Duncan P. N. Exon Smithf2435b92017-04-12 02:31:17 +00003184 Stream.EmitRecord(DIAG_PRAGMA_MAPPINGS, Record);
Argyrios Kyrtzidis452707c2010-11-05 22:10:18 +00003185}
3186
Douglas Gregorc5046832009-04-27 18:38:38 +00003187//===----------------------------------------------------------------------===//
3188// Type Serialization
3189//===----------------------------------------------------------------------===//
Chris Lattnereeffaef2009-04-10 17:15:23 +00003190
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003191/// Write the representation of a type to the AST stream.
Sebastian Redl55c0ad52010-08-18 23:56:21 +00003192void ASTWriter::WriteType(QualType T) {
Richard Smith290d8012016-04-06 17:06:00 +00003193 TypeIdx &IdxRef = TypeIdxs[T];
3194 if (IdxRef.getIndex() == 0) // we haven't seen this type before.
3195 IdxRef = TypeIdx(NextTypeID++);
3196 TypeIdx Idx = IdxRef;
Mike Stump11289f42009-09-09 15:08:12 +00003197
Douglas Gregor9b3932c2010-10-05 18:37:06 +00003198 assert(Idx.getIndex() >= FirstTypeID && "Re-writing a type from a prior AST");
Douglas Gregordc72caa2010-10-04 18:21:45 +00003199
Douglas Gregoref84c4b2009-04-09 22:27:44 +00003200 RecordData Record;
Mike Stump11289f42009-09-09 15:08:12 +00003201
Douglas Gregoref84c4b2009-04-09 22:27:44 +00003202 // Emit the type's representation.
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00003203 ASTTypeWriter W(*this, Record);
Richard Smith290d8012016-04-06 17:06:00 +00003204 W.Visit(T);
3205 uint64_t Offset = W.Emit();
John McCall8ccfcb52009-09-24 19:53:00 +00003206
Richard Smith290d8012016-04-06 17:06:00 +00003207 // Record the offset for this type.
3208 unsigned Index = Idx.getIndex() - FirstTypeID;
3209 if (TypeOffsets.size() == Index)
3210 TypeOffsets.push_back(Offset);
3211 else if (TypeOffsets.size() < Index) {
3212 TypeOffsets.resize(Index + 1);
3213 TypeOffsets[Index] = Offset;
John McCall8ccfcb52009-09-24 19:53:00 +00003214 } else {
Richard Smith290d8012016-04-06 17:06:00 +00003215 llvm_unreachable("Types emitted in wrong order");
Douglas Gregoref84c4b2009-04-09 22:27:44 +00003216 }
Douglas Gregoref84c4b2009-04-09 22:27:44 +00003217}
3218
Douglas Gregorc5046832009-04-27 18:38:38 +00003219//===----------------------------------------------------------------------===//
3220// Declaration Serialization
3221//===----------------------------------------------------------------------===//
3222
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003223/// Write the block containing all of the declaration IDs
Douglas Gregoref84c4b2009-04-09 22:27:44 +00003224/// lexically declared within the given DeclContext.
3225///
3226/// \returns the offset of the DECL_CONTEXT_LEXICAL block within the
Alexander Kornienko2a8c18d2018-04-06 15:14:32 +00003227/// bitstream, or 0 if no block was written.
Sebastian Redl55c0ad52010-08-18 23:56:21 +00003228uint64_t ASTWriter::WriteDeclContextLexicalBlock(ASTContext &Context,
Douglas Gregoref84c4b2009-04-09 22:27:44 +00003229 DeclContext *DC) {
Argyrios Kyrtzidiscfbfe782009-06-30 02:36:12 +00003230 if (DC->decls_empty())
Douglas Gregoref84c4b2009-04-09 22:27:44 +00003231 return 0;
3232
Douglas Gregor8f45df52009-04-16 22:23:12 +00003233 uint64_t Offset = Stream.GetCurrentBitNo();
Richard Smith82f8fcd2015-08-06 22:07:25 +00003234 SmallVector<uint32_t, 128> KindDeclPairs;
3235 for (const auto *D : DC->decls()) {
3236 KindDeclPairs.push_back(D->getKind());
3237 KindDeclPairs.push_back(GetDeclRef(D));
3238 }
Douglas Gregoref84c4b2009-04-09 22:27:44 +00003239
Douglas Gregora57c3ab2009-04-22 22:34:57 +00003240 ++NumLexicalDeclContexts;
Mehdi Amini57a41912015-09-10 01:46:39 +00003241 RecordData::value_type Record[] = {DECL_CONTEXT_LEXICAL};
Richard Smith82f8fcd2015-08-06 22:07:25 +00003242 Stream.EmitRecordWithBlob(DeclContextLexicalAbbrev, Record,
3243 bytes(KindDeclPairs));
Douglas Gregoref84c4b2009-04-09 22:27:44 +00003244 return Offset;
3245}
3246
Sebastian Redl55c0ad52010-08-18 23:56:21 +00003247void ASTWriter::WriteTypeDeclOffsets() {
Sebastian Redl1ea025b2010-07-16 16:36:56 +00003248 using namespace llvm;
Sebastian Redl1ea025b2010-07-16 16:36:56 +00003249
3250 // Write the type offsets array
David Blaikieb44f0bf2017-01-04 22:36:43 +00003251 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Sebastian Redl539c5062010-08-18 23:57:32 +00003252 Abbrev->Add(BitCodeAbbrevOp(TYPE_OFFSET));
Sebastian Redl1ea025b2010-07-16 16:36:56 +00003253 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // # of types
Douglas Gregor5204bde2011-08-02 16:26:37 +00003254 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // base type index
Sebastian Redl1ea025b2010-07-16 16:36:56 +00003255 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // types block
David Blaikieb44f0bf2017-01-04 22:36:43 +00003256 unsigned TypeOffsetAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Mehdi Amini57a41912015-09-10 01:46:39 +00003257 {
3258 RecordData::value_type Record[] = {TYPE_OFFSET, TypeOffsets.size(),
3259 FirstTypeID - NUM_PREDEF_TYPE_IDS};
3260 Stream.EmitRecordWithBlob(TypeOffsetAbbrev, Record, bytes(TypeOffsets));
3261 }
Sebastian Redl1ea025b2010-07-16 16:36:56 +00003262
3263 // Write the declaration offsets array
David Blaikieb44f0bf2017-01-04 22:36:43 +00003264 Abbrev = std::make_shared<BitCodeAbbrev>();
Sebastian Redl539c5062010-08-18 23:57:32 +00003265 Abbrev->Add(BitCodeAbbrevOp(DECL_OFFSET));
Sebastian Redl1ea025b2010-07-16 16:36:56 +00003266 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // # of declarations
Douglas Gregorf7180622011-08-03 15:48:04 +00003267 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // base decl ID
Sebastian Redl1ea025b2010-07-16 16:36:56 +00003268 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // declarations block
David Blaikieb44f0bf2017-01-04 22:36:43 +00003269 unsigned DeclOffsetAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Mehdi Amini57a41912015-09-10 01:46:39 +00003270 {
3271 RecordData::value_type Record[] = {DECL_OFFSET, DeclOffsets.size(),
3272 FirstDeclID - NUM_PREDEF_DECL_IDS};
3273 Stream.EmitRecordWithBlob(DeclOffsetAbbrev, Record, bytes(DeclOffsets));
3274 }
Sebastian Redl1ea025b2010-07-16 16:36:56 +00003275}
3276
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00003277void ASTWriter::WriteFileDeclIDsMap() {
3278 using namespace llvm;
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00003279
Chandler Carruthb306d732015-03-27 00:31:20 +00003280 SmallVector<std::pair<FileID, DeclIDInFileInfo *>, 64> SortedFileDeclIDs(
3281 FileDeclIDs.begin(), FileDeclIDs.end());
Fangrui Song55fab262018-09-26 22:16:28 +00003282 llvm::sort(SortedFileDeclIDs, llvm::less_first());
Chandler Carruthb306d732015-03-27 00:31:20 +00003283
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00003284 // Join the vectors of DeclIDs from all files.
Chandler Carruthb306d732015-03-27 00:31:20 +00003285 SmallVector<DeclID, 256> FileGroupedDeclIDs;
3286 for (auto &FileDeclEntry : SortedFileDeclIDs) {
3287 DeclIDInFileInfo &Info = *FileDeclEntry.second;
3288 Info.FirstDeclIndex = FileGroupedDeclIDs.size();
3289 for (auto &LocDeclEntry : Info.DeclIDs)
3290 FileGroupedDeclIDs.push_back(LocDeclEntry.second);
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00003291 }
3292
David Blaikieb44f0bf2017-01-04 22:36:43 +00003293 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00003294 Abbrev->Add(BitCodeAbbrevOp(FILE_SORTED_DECLS));
Argyrios Kyrtzidis10e78462012-10-02 21:09:13 +00003295 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00003296 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
David Blaikieb44f0bf2017-01-04 22:36:43 +00003297 unsigned AbbrevCode = Stream.EmitAbbrev(std::move(Abbrev));
Mehdi Amini57a41912015-09-10 01:46:39 +00003298 RecordData::value_type Record[] = {FILE_SORTED_DECLS,
3299 FileGroupedDeclIDs.size()};
Reid Kleckner012665e2015-05-21 00:13:09 +00003300 Stream.EmitRecordWithBlob(AbbrevCode, Record, bytes(FileGroupedDeclIDs));
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00003301}
3302
Dmitri Gribenkoaab83832012-06-20 00:34:58 +00003303void ASTWriter::WriteComments() {
3304 Stream.EnterSubblock(COMMENTS_BLOCK_ID, 3);
Ilya Biryukov45643102018-07-09 11:33:23 +00003305 auto _ = llvm::make_scope_exit([this] { Stream.ExitBlock(); });
3306 if (!PP->getPreprocessorOpts().WriteCommentListToPCH)
3307 return;
Dmitri Gribenkoaab83832012-06-20 00:34:58 +00003308 RecordData Record;
Jan Korousf31d8df2019-08-13 18:11:44 +00003309 for (const auto &FO : Context->Comments.OrderedComments) {
3310 for (const auto &OC : FO.second) {
3311 const RawComment *I = OC.second;
3312 Record.clear();
3313 AddSourceRange(I->getSourceRange(), Record);
3314 Record.push_back(I->getKind());
3315 Record.push_back(I->isTrailingComment());
3316 Record.push_back(I->isAlmostTrailingComment());
3317 Stream.EmitRecord(COMMENTS_RAW_COMMENT, Record);
3318 }
Dmitri Gribenkoaab83832012-06-20 00:34:58 +00003319 }
Dmitri Gribenkoaab83832012-06-20 00:34:58 +00003320}
3321
Douglas Gregorc5046832009-04-27 18:38:38 +00003322//===----------------------------------------------------------------------===//
3323// Global Method Pool and Selector Serialization
3324//===----------------------------------------------------------------------===//
3325
Douglas Gregore84a9da2009-04-20 20:36:09 +00003326namespace {
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +00003327
Douglas Gregorc78d3462009-04-24 21:10:55 +00003328// Trait used for the on-disk hash table used in the method pool.
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00003329class ASTMethodPoolTrait {
Sebastian Redl55c0ad52010-08-18 23:56:21 +00003330 ASTWriter &Writer;
Douglas Gregorc78d3462009-04-24 21:10:55 +00003331
3332public:
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003333 using key_type = Selector;
3334 using key_type_ref = key_type;
Mike Stump11289f42009-09-09 15:08:12 +00003335
Sebastian Redl834bb972010-08-04 17:20:04 +00003336 struct data_type {
Sebastian Redl539c5062010-08-18 23:57:32 +00003337 SelectorID ID;
Sebastian Redl834bb972010-08-04 17:20:04 +00003338 ObjCMethodList Instance, Factory;
3339 };
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003340 using data_type_ref = const data_type &;
Douglas Gregorc78d3462009-04-24 21:10:55 +00003341
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003342 using hash_value_type = unsigned;
3343 using offset_type = unsigned;
Justin Bogner25463f12014-04-18 20:27:24 +00003344
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003345 explicit ASTMethodPoolTrait(ASTWriter &Writer) : Writer(Writer) {}
Mike Stump11289f42009-09-09 15:08:12 +00003346
Justin Bogner25463f12014-04-18 20:27:24 +00003347 static hash_value_type ComputeHash(Selector Sel) {
Argyrios Kyrtzidis4bd97102010-08-20 16:03:52 +00003348 return serialization::ComputeHash(Sel);
Douglas Gregorc78d3462009-04-24 21:10:55 +00003349 }
Mike Stump11289f42009-09-09 15:08:12 +00003350
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003351 std::pair<unsigned, unsigned>
Chris Lattner0e62c1c2011-07-23 10:55:15 +00003352 EmitKeyDataLength(raw_ostream& Out, Selector Sel,
Douglas Gregorc78d3462009-04-24 21:10:55 +00003353 data_type_ref Methods) {
Justin Bognere1c147c2014-03-28 22:03:19 +00003354 using namespace llvm::support;
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003355
Peter Collingbournee3f65292018-05-18 19:46:24 +00003356 endian::Writer LE(Out, little);
Douglas Gregorc78d3462009-04-24 21:10:55 +00003357 unsigned KeyLen = 2 + (Sel.getNumArgs()? Sel.getNumArgs() * 4 : 4);
Justin Bognere1c147c2014-03-28 22:03:19 +00003358 LE.write<uint16_t>(KeyLen);
Sebastian Redl834bb972010-08-04 17:20:04 +00003359 unsigned DataLen = 4 + 2 + 2; // 2 bytes for each of the method counts
3360 for (const ObjCMethodList *Method = &Methods.Instance; Method;
Argyrios Kyrtzidisd3da6e02013-04-17 00:08:58 +00003361 Method = Method->getNext())
Nico Weber2e0c8f72014-12-27 03:58:08 +00003362 if (Method->getMethod())
Douglas Gregorc78d3462009-04-24 21:10:55 +00003363 DataLen += 4;
Sebastian Redl834bb972010-08-04 17:20:04 +00003364 for (const ObjCMethodList *Method = &Methods.Factory; Method;
Argyrios Kyrtzidisd3da6e02013-04-17 00:08:58 +00003365 Method = Method->getNext())
Nico Weber2e0c8f72014-12-27 03:58:08 +00003366 if (Method->getMethod())
Douglas Gregorc78d3462009-04-24 21:10:55 +00003367 DataLen += 4;
Justin Bognere1c147c2014-03-28 22:03:19 +00003368 LE.write<uint16_t>(DataLen);
Douglas Gregorc78d3462009-04-24 21:10:55 +00003369 return std::make_pair(KeyLen, DataLen);
3370 }
Mike Stump11289f42009-09-09 15:08:12 +00003371
Chris Lattner0e62c1c2011-07-23 10:55:15 +00003372 void EmitKey(raw_ostream& Out, Selector Sel, unsigned) {
Justin Bognere1c147c2014-03-28 22:03:19 +00003373 using namespace llvm::support;
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003374
Peter Collingbournee3f65292018-05-18 19:46:24 +00003375 endian::Writer LE(Out, little);
Mike Stump11289f42009-09-09 15:08:12 +00003376 uint64_t Start = Out.tell();
Douglas Gregor95c13f52009-04-25 17:48:32 +00003377 assert((Start >> 32) == 0 && "Selector key offset too large");
3378 Writer.SetSelectorOffset(Sel, Start);
Douglas Gregorc78d3462009-04-24 21:10:55 +00003379 unsigned N = Sel.getNumArgs();
Justin Bognere1c147c2014-03-28 22:03:19 +00003380 LE.write<uint16_t>(N);
Douglas Gregorc78d3462009-04-24 21:10:55 +00003381 if (N == 0)
3382 N = 1;
3383 for (unsigned I = 0; I != N; ++I)
Justin Bognere1c147c2014-03-28 22:03:19 +00003384 LE.write<uint32_t>(
3385 Writer.getIdentifierRef(Sel.getIdentifierInfoForSlot(I)));
Douglas Gregorc78d3462009-04-24 21:10:55 +00003386 }
Mike Stump11289f42009-09-09 15:08:12 +00003387
Chris Lattner0e62c1c2011-07-23 10:55:15 +00003388 void EmitData(raw_ostream& Out, key_type_ref,
Douglas Gregor4647cfa2009-04-24 21:49:02 +00003389 data_type_ref Methods, unsigned DataLen) {
Justin Bognere1c147c2014-03-28 22:03:19 +00003390 using namespace llvm::support;
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003391
Peter Collingbournee3f65292018-05-18 19:46:24 +00003392 endian::Writer LE(Out, little);
Douglas Gregor4647cfa2009-04-24 21:49:02 +00003393 uint64_t Start = Out.tell(); (void)Start;
Justin Bognere1c147c2014-03-28 22:03:19 +00003394 LE.write<uint32_t>(Methods.ID);
Douglas Gregorc78d3462009-04-24 21:10:55 +00003395 unsigned NumInstanceMethods = 0;
Sebastian Redl834bb972010-08-04 17:20:04 +00003396 for (const ObjCMethodList *Method = &Methods.Instance; Method;
Argyrios Kyrtzidisd3da6e02013-04-17 00:08:58 +00003397 Method = Method->getNext())
Nico Weber2e0c8f72014-12-27 03:58:08 +00003398 if (Method->getMethod())
Douglas Gregorc78d3462009-04-24 21:10:55 +00003399 ++NumInstanceMethods;
3400
3401 unsigned NumFactoryMethods = 0;
Sebastian Redl834bb972010-08-04 17:20:04 +00003402 for (const ObjCMethodList *Method = &Methods.Factory; Method;
Argyrios Kyrtzidisd3da6e02013-04-17 00:08:58 +00003403 Method = Method->getNext())
Nico Weber2e0c8f72014-12-27 03:58:08 +00003404 if (Method->getMethod())
Douglas Gregorc78d3462009-04-24 21:10:55 +00003405 ++NumFactoryMethods;
3406
Argyrios Kyrtzidisd3da6e02013-04-17 00:08:58 +00003407 unsigned InstanceBits = Methods.Instance.getBits();
3408 assert(InstanceBits < 4);
Nico Weberff4b35e2014-12-27 22:14:15 +00003409 unsigned InstanceHasMoreThanOneDeclBit =
3410 Methods.Instance.hasMoreThanOneDecl();
3411 unsigned FullInstanceBits = (NumInstanceMethods << 3) |
3412 (InstanceHasMoreThanOneDeclBit << 2) |
3413 InstanceBits;
Argyrios Kyrtzidisd3da6e02013-04-17 00:08:58 +00003414 unsigned FactoryBits = Methods.Factory.getBits();
3415 assert(FactoryBits < 4);
Nico Weberff4b35e2014-12-27 22:14:15 +00003416 unsigned FactoryHasMoreThanOneDeclBit =
3417 Methods.Factory.hasMoreThanOneDecl();
3418 unsigned FullFactoryBits = (NumFactoryMethods << 3) |
3419 (FactoryHasMoreThanOneDeclBit << 2) |
3420 FactoryBits;
3421 LE.write<uint16_t>(FullInstanceBits);
3422 LE.write<uint16_t>(FullFactoryBits);
Sebastian Redl834bb972010-08-04 17:20:04 +00003423 for (const ObjCMethodList *Method = &Methods.Instance; Method;
Argyrios Kyrtzidisd3da6e02013-04-17 00:08:58 +00003424 Method = Method->getNext())
Nico Weber2e0c8f72014-12-27 03:58:08 +00003425 if (Method->getMethod())
3426 LE.write<uint32_t>(Writer.getDeclID(Method->getMethod()));
Sebastian Redl834bb972010-08-04 17:20:04 +00003427 for (const ObjCMethodList *Method = &Methods.Factory; Method;
Argyrios Kyrtzidisd3da6e02013-04-17 00:08:58 +00003428 Method = Method->getNext())
Nico Weber2e0c8f72014-12-27 03:58:08 +00003429 if (Method->getMethod())
3430 LE.write<uint32_t>(Writer.getDeclID(Method->getMethod()));
Douglas Gregor4647cfa2009-04-24 21:49:02 +00003431
3432 assert(Out.tell() - Start == DataLen && "Data length is wrong");
Douglas Gregorc78d3462009-04-24 21:10:55 +00003433 }
3434};
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +00003435
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003436} // namespace
Douglas Gregorc78d3462009-04-24 21:10:55 +00003437
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003438/// Write ObjC data: selectors and the method pool.
Douglas Gregorc78d3462009-04-24 21:10:55 +00003439///
3440/// The method pool contains both instance and factory methods, stored
Sebastian Redla19a67f2010-08-03 21:58:15 +00003441/// in an on-disk hash table indexed by the selector. The hash table also
3442/// contains an empty entry for every other selector known to Sema.
Sebastian Redl55c0ad52010-08-18 23:56:21 +00003443void ASTWriter::WriteSelectors(Sema &SemaRef) {
Douglas Gregorc78d3462009-04-24 21:10:55 +00003444 using namespace llvm;
3445
Sebastian Redla19a67f2010-08-03 21:58:15 +00003446 // Do we have to do anything at all?
Sebastian Redl834bb972010-08-04 17:20:04 +00003447 if (SemaRef.MethodPool.empty() && SelectorIDs.empty())
Sebastian Redla19a67f2010-08-03 21:58:15 +00003448 return;
Sebastian Redld95a56e2010-08-04 18:21:41 +00003449 unsigned NumTableEntries = 0;
Sebastian Redla19a67f2010-08-03 21:58:15 +00003450 // Create and write out the blob that contains selectors and the method pool.
Douglas Gregorc78d3462009-04-24 21:10:55 +00003451 {
Justin Bognerbb094f02014-04-18 19:57:06 +00003452 llvm::OnDiskChainedHashTableGenerator<ASTMethodPoolTrait> Generator;
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003453 ASTMethodPoolTrait Trait(*this);
Mike Stump11289f42009-09-09 15:08:12 +00003454
Sebastian Redla19a67f2010-08-03 21:58:15 +00003455 // Create the on-disk hash table representation. We walk through every
3456 // selector we've seen and look it up in the method pool.
Sebastian Redld95a56e2010-08-04 18:21:41 +00003457 SelectorOffsets.resize(NextSelectorID - FirstSelectorID);
Chandler Carruthacbbeb92015-03-27 00:47:43 +00003458 for (auto &SelectorAndID : SelectorIDs) {
3459 Selector S = SelectorAndID.first;
3460 SelectorID ID = SelectorAndID.second;
Sebastian Redla19a67f2010-08-03 21:58:15 +00003461 Sema::GlobalMethodPool::iterator F = SemaRef.MethodPool.find(S);
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00003462 ASTMethodPoolTrait::data_type Data = {
Chandler Carruthacbbeb92015-03-27 00:47:43 +00003463 ID,
Sebastian Redl834bb972010-08-04 17:20:04 +00003464 ObjCMethodList(),
3465 ObjCMethodList()
3466 };
3467 if (F != SemaRef.MethodPool.end()) {
3468 Data.Instance = F->second.first;
3469 Data.Factory = F->second.second;
3470 }
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00003471 // Only write this selector if it's not in an existing AST or something
Sebastian Redld95a56e2010-08-04 18:21:41 +00003472 // changed.
Chandler Carruthacbbeb92015-03-27 00:47:43 +00003473 if (Chain && ID < FirstSelectorID) {
Sebastian Redld95a56e2010-08-04 18:21:41 +00003474 // Selector already exists. Did it change?
3475 bool changed = false;
Nico Weber2e0c8f72014-12-27 03:58:08 +00003476 for (ObjCMethodList *M = &Data.Instance;
3477 !changed && M && M->getMethod(); M = M->getNext()) {
3478 if (!M->getMethod()->isFromASTFile())
Sebastian Redld95a56e2010-08-04 18:21:41 +00003479 changed = true;
3480 }
Nico Weber2e0c8f72014-12-27 03:58:08 +00003481 for (ObjCMethodList *M = &Data.Factory; !changed && M && M->getMethod();
Argyrios Kyrtzidisd3da6e02013-04-17 00:08:58 +00003482 M = M->getNext()) {
Nico Weber2e0c8f72014-12-27 03:58:08 +00003483 if (!M->getMethod()->isFromASTFile())
Sebastian Redld95a56e2010-08-04 18:21:41 +00003484 changed = true;
3485 }
3486 if (!changed)
3487 continue;
Nico Weber2e0c8f72014-12-27 03:58:08 +00003488 } else if (Data.Instance.getMethod() || Data.Factory.getMethod()) {
Sebastian Redl6e1a2a02010-08-04 21:22:45 +00003489 // A new method pool entry.
3490 ++NumTableEntries;
Sebastian Redld95a56e2010-08-04 18:21:41 +00003491 }
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003492 Generator.insert(S, Data, Trait);
Douglas Gregorc78d3462009-04-24 21:10:55 +00003493 }
3494
Douglas Gregorc78d3462009-04-24 21:10:55 +00003495 // Create the on-disk hash table in a buffer.
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00003496 SmallString<4096> MethodPool;
Douglas Gregorc78d3462009-04-24 21:10:55 +00003497 uint32_t BucketOffset;
3498 {
Justin Bognere1c147c2014-03-28 22:03:19 +00003499 using namespace llvm::support;
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003500
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00003501 ASTMethodPoolTrait Trait(*this);
Douglas Gregorc78d3462009-04-24 21:10:55 +00003502 llvm::raw_svector_ostream Out(MethodPool);
3503 // Make sure that no bucket is at offset 0
Peter Collingbournee3f65292018-05-18 19:46:24 +00003504 endian::write<uint32_t>(Out, 0, little);
Douglas Gregorc78d3462009-04-24 21:10:55 +00003505 BucketOffset = Generator.Emit(Out, Trait);
3506 }
3507
3508 // Create a blob abbreviation
David Blaikieb44f0bf2017-01-04 22:36:43 +00003509 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Sebastian Redl539c5062010-08-18 23:57:32 +00003510 Abbrev->Add(BitCodeAbbrevOp(METHOD_POOL));
Douglas Gregorc78d3462009-04-24 21:10:55 +00003511 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
Douglas Gregor95c13f52009-04-25 17:48:32 +00003512 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
Douglas Gregorc78d3462009-04-24 21:10:55 +00003513 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
David Blaikieb44f0bf2017-01-04 22:36:43 +00003514 unsigned MethodPoolAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregorc78d3462009-04-24 21:10:55 +00003515
Douglas Gregor95c13f52009-04-25 17:48:32 +00003516 // Write the method pool
Mehdi Amini57a41912015-09-10 01:46:39 +00003517 {
3518 RecordData::value_type Record[] = {METHOD_POOL, BucketOffset,
3519 NumTableEntries};
3520 Stream.EmitRecordWithBlob(MethodPoolAbbrev, Record, MethodPool);
3521 }
Douglas Gregor95c13f52009-04-25 17:48:32 +00003522
3523 // Create a blob abbreviation for the selector table offsets.
David Blaikieb44f0bf2017-01-04 22:36:43 +00003524 Abbrev = std::make_shared<BitCodeAbbrev>();
Sebastian Redl539c5062010-08-18 23:57:32 +00003525 Abbrev->Add(BitCodeAbbrevOp(SELECTOR_OFFSETS));
Douglas Gregord4c5ed02010-10-29 22:39:52 +00003526 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // size
Douglas Gregor8f364fb2011-08-03 23:28:44 +00003527 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // first ID
Douglas Gregor95c13f52009-04-25 17:48:32 +00003528 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
David Blaikieb44f0bf2017-01-04 22:36:43 +00003529 unsigned SelectorOffsetAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregor95c13f52009-04-25 17:48:32 +00003530
3531 // Write the selector offsets table.
Mehdi Amini57a41912015-09-10 01:46:39 +00003532 {
3533 RecordData::value_type Record[] = {
3534 SELECTOR_OFFSETS, SelectorOffsets.size(),
3535 FirstSelectorID - NUM_PREDEF_SELECTOR_IDS};
3536 Stream.EmitRecordWithBlob(SelectorOffsetAbbrev, Record,
3537 bytes(SelectorOffsets));
3538 }
Douglas Gregorc78d3462009-04-24 21:10:55 +00003539 }
3540}
3541
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003542/// Write the selectors referenced in @selector expression into AST file.
Sebastian Redl55c0ad52010-08-18 23:56:21 +00003543void ASTWriter::WriteReferencedSelectorsPool(Sema &SemaRef) {
Fariborz Jahanianc51609a2010-07-23 19:11:11 +00003544 using namespace llvm;
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003545
Fariborz Jahanianc51609a2010-07-23 19:11:11 +00003546 if (SemaRef.ReferencedSelectors.empty())
3547 return;
Sebastian Redlada023c2010-08-04 20:40:17 +00003548
Fariborz Jahanianc51609a2010-07-23 19:11:11 +00003549 RecordData Record;
Richard Smithe64e7452016-04-18 21:54:58 +00003550 ASTRecordWriter Writer(*this, Record);
Sebastian Redlada023c2010-08-04 20:40:17 +00003551
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00003552 // Note: this writes out all references even for a dependent AST. But it is
Sebastian Redl51c79d82010-08-04 22:21:29 +00003553 // very tricky to fix, and given that @selector shouldn't really appear in
3554 // headers, probably not worth it. It's not a correctness issue.
Chandler Carruth12c8f652015-03-27 00:55:05 +00003555 for (auto &SelectorAndLocation : SemaRef.ReferencedSelectors) {
3556 Selector Sel = SelectorAndLocation.first;
3557 SourceLocation Loc = SelectorAndLocation.second;
Richard Smithe64e7452016-04-18 21:54:58 +00003558 Writer.AddSelectorRef(Sel);
3559 Writer.AddSourceLocation(Loc);
Fariborz Jahanianc51609a2010-07-23 19:11:11 +00003560 }
Richard Smithe64e7452016-04-18 21:54:58 +00003561 Writer.Emit(REFERENCED_SELECTOR_POOL);
Fariborz Jahanianc51609a2010-07-23 19:11:11 +00003562}
3563
Douglas Gregorc5046832009-04-27 18:38:38 +00003564//===----------------------------------------------------------------------===//
3565// Identifier Table Serialization
3566//===----------------------------------------------------------------------===//
3567
Richard Smithb3761912015-02-05 23:08:52 +00003568/// Determine the declaration that should be put into the name lookup table to
3569/// represent the given declaration in this module. This is usually D itself,
3570/// but if D was imported and merged into a local declaration, we want the most
3571/// recent local declaration instead. The chosen declaration will be the most
3572/// recent declaration in any module that imports this one.
3573static NamedDecl *getDeclForLocalLookup(const LangOptions &LangOpts,
3574 NamedDecl *D) {
3575 if (!LangOpts.Modules || !D->isFromASTFile())
3576 return D;
3577
3578 if (Decl *Redecl = D->getPreviousDecl()) {
3579 // For Redeclarable decls, a prior declaration might be local.
3580 for (; Redecl; Redecl = Redecl->getPreviousDecl()) {
Richard Smithd49941b2016-04-26 23:40:43 +00003581 // If we find a local decl, we're done.
3582 if (!Redecl->isFromASTFile()) {
3583 // Exception: in very rare cases (for injected-class-names), not all
3584 // redeclarations are in the same semantic context. Skip ones in a
3585 // different context. They don't go in this lookup table at all.
3586 if (!Redecl->getDeclContext()->getRedeclContext()->Equals(
3587 D->getDeclContext()->getRedeclContext()))
3588 continue;
Richard Smithb3761912015-02-05 23:08:52 +00003589 return cast<NamedDecl>(Redecl);
Richard Smithd49941b2016-04-26 23:40:43 +00003590 }
3591
Richard Smithfe620d22015-03-05 23:24:12 +00003592 // If we find a decl from a (chained-)PCH stop since we won't find a
Richard Smithb3761912015-02-05 23:08:52 +00003593 // local one.
Richard Smithd49941b2016-04-26 23:40:43 +00003594 if (Redecl->getOwningModuleID() == 0)
Richard Smithb3761912015-02-05 23:08:52 +00003595 break;
3596 }
3597 } else if (Decl *First = D->getCanonicalDecl()) {
3598 // For Mergeable decls, the first decl might be local.
3599 if (!First->isFromASTFile())
3600 return cast<NamedDecl>(First);
3601 }
3602
3603 // All declarations are imported. Our most recent declaration will also be
3604 // the most recent one in anyone who imports us.
3605 return D;
3606}
3607
Douglas Gregorc78d3462009-04-24 21:10:55 +00003608namespace {
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +00003609
Richard Smithcf97cf62015-04-19 01:34:23 +00003610class ASTIdentifierTableTrait {
3611 ASTWriter &Writer;
3612 Preprocessor &PP;
3613 IdentifierResolver &IdResolver;
Richard Smith9c254182015-07-19 21:41:12 +00003614 bool IsModule;
Richard Smitha534a312015-07-21 23:54:07 +00003615 bool NeedDecls;
Richard Smith33e0f7e2015-07-22 02:08:40 +00003616 ASTWriter::RecordData *InterestingIdentifierOffsets;
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00003617
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003618 /// Determines whether this is an "interesting" identifier that needs a
Richard Smithcf97cf62015-04-19 01:34:23 +00003619 /// full IdentifierInfo structure written into the hash table. Notably, this
3620 /// doesn't check whether the name has macros defined; use PublicMacroIterator
3621 /// to check that.
Richard Smith9c254182015-07-19 21:41:12 +00003622 bool isInterestingIdentifier(const IdentifierInfo *II, uint64_t MacroOffset) {
Richard Smithd7329392015-04-21 21:46:32 +00003623 if (MacroOffset ||
3624 II->isPoisoned() ||
Richard Smith9c254182015-07-19 21:41:12 +00003625 (IsModule ? II->hasRevertedBuiltin() : II->getObjCOrBuiltinID()) ||
Richard Smithcf97cf62015-04-19 01:34:23 +00003626 II->hasRevertedTokenIDToIdentifier() ||
Bruno Ricci366ba732018-09-21 12:53:22 +00003627 (NeedDecls && II->getFETokenInfo()))
Richard Smithcf97cf62015-04-19 01:34:23 +00003628 return true;
3629
3630 return false;
3631 }
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00003632
Douglas Gregore84a9da2009-04-20 20:36:09 +00003633public:
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003634 using key_type = IdentifierInfo *;
3635 using key_type_ref = key_type;
Mike Stump11289f42009-09-09 15:08:12 +00003636
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003637 using data_type = IdentID;
3638 using data_type_ref = data_type;
Mike Stump11289f42009-09-09 15:08:12 +00003639
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003640 using hash_value_type = unsigned;
3641 using offset_type = unsigned;
Justin Bogner25463f12014-04-18 20:27:24 +00003642
Richard Smithd7329392015-04-21 21:46:32 +00003643 ASTIdentifierTableTrait(ASTWriter &Writer, Preprocessor &PP,
Richard Smith33e0f7e2015-07-22 02:08:40 +00003644 IdentifierResolver &IdResolver, bool IsModule,
3645 ASTWriter::RecordData *InterestingIdentifierOffsets)
Richard Smitha534a312015-07-21 23:54:07 +00003646 : Writer(Writer), PP(PP), IdResolver(IdResolver), IsModule(IsModule),
Richard Smith33e0f7e2015-07-22 02:08:40 +00003647 NeedDecls(!IsModule || !Writer.getLangOpts().CPlusPlus),
3648 InterestingIdentifierOffsets(InterestingIdentifierOffsets) {}
Douglas Gregore84a9da2009-04-20 20:36:09 +00003649
Richard Smithd79514e2016-02-05 19:03:40 +00003650 bool needDecls() const { return NeedDecls; }
3651
Justin Bogner25463f12014-04-18 20:27:24 +00003652 static hash_value_type ComputeHash(const IdentifierInfo* II) {
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00003653 return llvm::djbHash(II->getName());
Douglas Gregore84a9da2009-04-20 20:36:09 +00003654 }
Mike Stump11289f42009-09-09 15:08:12 +00003655
Richard Smith33e0f7e2015-07-22 02:08:40 +00003656 bool isInterestingIdentifier(const IdentifierInfo *II) {
3657 auto MacroOffset = Writer.getMacroDirectivesOffset(II);
3658 return isInterestingIdentifier(II, MacroOffset);
3659 }
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +00003660
Richard Smith9c254182015-07-19 21:41:12 +00003661 bool isInterestingNonMacroIdentifier(const IdentifierInfo *II) {
3662 return isInterestingIdentifier(II, 0);
3663 }
3664
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003665 std::pair<unsigned, unsigned>
Douglas Gregor935bc7a22011-10-27 09:33:13 +00003666 EmitKeyDataLength(raw_ostream& Out, IdentifierInfo* II, IdentID ID) {
Daniel Dunbar2c422dc92009-10-18 20:26:12 +00003667 unsigned KeyLen = II->getLength() + 1;
Douglas Gregor1d583f22009-04-28 21:18:29 +00003668 unsigned DataLen = 4; // 4 bytes for the persistent ID << 1
Richard Smithd7329392015-04-21 21:46:32 +00003669 auto MacroOffset = Writer.getMacroDirectivesOffset(II);
3670 if (isInterestingIdentifier(II, MacroOffset)) {
Alexander Kornienko1d26c022012-09-25 17:18:14 +00003671 DataLen += 2; // 2 bytes for builtin ID
3672 DataLen += 2; // 2 bytes for flags
Richard Smithd7329392015-04-21 21:46:32 +00003673 if (MacroOffset)
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00003674 DataLen += 4; // MacroDirectives offset.
Alexander Kornienko1d26c022012-09-25 17:18:14 +00003675
Richard Smitha534a312015-07-21 23:54:07 +00003676 if (NeedDecls) {
3677 for (IdentifierResolver::iterator D = IdResolver.begin(II),
3678 DEnd = IdResolver.end();
3679 D != DEnd; ++D)
3680 DataLen += 4;
3681 }
Douglas Gregor1d583f22009-04-28 21:18:29 +00003682 }
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003683
Justin Bognere1c147c2014-03-28 22:03:19 +00003684 using namespace llvm::support;
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003685
Peter Collingbournee3f65292018-05-18 19:46:24 +00003686 endian::Writer LE(Out, little);
Justin Bognere1c147c2014-03-28 22:03:19 +00003687
Richard Smithdf8a8312015-03-13 04:05:01 +00003688 assert((uint16_t)DataLen == DataLen && (uint16_t)KeyLen == KeyLen);
Justin Bognere1c147c2014-03-28 22:03:19 +00003689 LE.write<uint16_t>(DataLen);
Douglas Gregorab4df582009-04-28 20:01:51 +00003690 // We emit the key length after the data length so that every
3691 // string is preceded by a 16-bit length. This matches the PTH
3692 // format for storing identifiers.
Justin Bognere1c147c2014-03-28 22:03:19 +00003693 LE.write<uint16_t>(KeyLen);
Douglas Gregore84a9da2009-04-20 20:36:09 +00003694 return std::make_pair(KeyLen, DataLen);
3695 }
Mike Stump11289f42009-09-09 15:08:12 +00003696
Chris Lattner0e62c1c2011-07-23 10:55:15 +00003697 void EmitKey(raw_ostream& Out, const IdentifierInfo* II,
Douglas Gregore84a9da2009-04-20 20:36:09 +00003698 unsigned KeyLen) {
3699 // Record the location of the key data. This is used when generating
3700 // the mapping from persistent IDs to strings.
3701 Writer.SetIdentifierOffset(II, Out.tell());
Richard Smith33e0f7e2015-07-22 02:08:40 +00003702
3703 // Emit the offset of the key/data length information to the interesting
3704 // identifiers table if necessary.
3705 if (InterestingIdentifierOffsets && isInterestingIdentifier(II))
3706 InterestingIdentifierOffsets->push_back(Out.tell() - 4);
3707
Daniel Dunbar2c422dc92009-10-18 20:26:12 +00003708 Out.write(II->getNameStart(), KeyLen);
Douglas Gregore84a9da2009-04-20 20:36:09 +00003709 }
Mike Stump11289f42009-09-09 15:08:12 +00003710
Douglas Gregor4a69c2e2011-09-01 17:04:32 +00003711 void EmitData(raw_ostream& Out, IdentifierInfo* II,
Sebastian Redl539c5062010-08-18 23:57:32 +00003712 IdentID ID, unsigned) {
Justin Bognere1c147c2014-03-28 22:03:19 +00003713 using namespace llvm::support;
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003714
Peter Collingbournee3f65292018-05-18 19:46:24 +00003715 endian::Writer LE(Out, little);
Richard Smithcf97cf62015-04-19 01:34:23 +00003716
Richard Smithd7329392015-04-21 21:46:32 +00003717 auto MacroOffset = Writer.getMacroDirectivesOffset(II);
3718 if (!isInterestingIdentifier(II, MacroOffset)) {
Justin Bognere1c147c2014-03-28 22:03:19 +00003719 LE.write<uint32_t>(ID << 1);
Douglas Gregor1d583f22009-04-28 21:18:29 +00003720 return;
3721 }
Douglas Gregorb9256522009-04-28 21:32:13 +00003722
Justin Bognere1c147c2014-03-28 22:03:19 +00003723 LE.write<uint32_t>((ID << 1) | 0x01);
Alexander Kornienko1d26c022012-09-25 17:18:14 +00003724 uint32_t Bits = (uint32_t)II->getObjCOrBuiltinID();
3725 assert((Bits & 0xffff) == Bits && "ObjCOrBuiltinID too big for ASTReader.");
Justin Bognere1c147c2014-03-28 22:03:19 +00003726 LE.write<uint16_t>(Bits);
Alexander Kornienko1d26c022012-09-25 17:18:14 +00003727 Bits = 0;
Richard Smithd7329392015-04-21 21:46:32 +00003728 bool HadMacroDefinition = MacroOffset != 0;
Alexander Kornienko1d26c022012-09-25 17:18:14 +00003729 Bits = (Bits << 1) | unsigned(HadMacroDefinition);
Daniel Dunbar91b640a2009-12-18 20:58:47 +00003730 Bits = (Bits << 1) | unsigned(II->isExtensionToken());
3731 Bits = (Bits << 1) | unsigned(II->isPoisoned());
Richard Smith9c254182015-07-19 21:41:12 +00003732 Bits = (Bits << 1) | unsigned(II->hasRevertedBuiltin());
Argyrios Kyrtzidis3084a612010-08-11 22:55:12 +00003733 Bits = (Bits << 1) | unsigned(II->hasRevertedTokenIDToIdentifier());
Daniel Dunbar91b640a2009-12-18 20:58:47 +00003734 Bits = (Bits << 1) | unsigned(II->isCPlusPlusOperatorKeyword());
Justin Bognere1c147c2014-03-28 22:03:19 +00003735 LE.write<uint16_t>(Bits);
Douglas Gregore84a9da2009-04-20 20:36:09 +00003736
Richard Smithd7329392015-04-21 21:46:32 +00003737 if (HadMacroDefinition)
3738 LE.write<uint32_t>(MacroOffset);
Alexander Kornienko1d26c022012-09-25 17:18:14 +00003739
Richard Smitha534a312015-07-21 23:54:07 +00003740 if (NeedDecls) {
3741 // Emit the declaration IDs in reverse order, because the
3742 // IdentifierResolver provides the declarations as they would be
3743 // visible (e.g., the function "stat" would come before the struct
3744 // "stat"), but the ASTReader adds declarations to the end of the list
3745 // (so we need to see the struct "stat" before the function "stat").
3746 // Only emit declarations that aren't from a chained PCH, though.
3747 SmallVector<NamedDecl *, 16> Decls(IdResolver.begin(II),
3748 IdResolver.end());
3749 for (SmallVectorImpl<NamedDecl *>::reverse_iterator D = Decls.rbegin(),
3750 DEnd = Decls.rend();
3751 D != DEnd; ++D)
3752 LE.write<uint32_t>(
3753 Writer.getDeclID(getDeclForLocalLookup(PP.getLangOpts(), *D)));
3754 }
Douglas Gregore84a9da2009-04-20 20:36:09 +00003755 }
3756};
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +00003757
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003758} // namespace
Douglas Gregore84a9da2009-04-20 20:36:09 +00003759
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003760/// Write the identifier table into the AST file.
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00003761///
3762/// The identifier table consists of a blob containing string data
3763/// (the actual identifiers themselves) and a separate "offsets" index
3764/// that maps identifier IDs to locations within the blob.
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00003765void ASTWriter::WriteIdentifierTable(Preprocessor &PP,
Douglas Gregor935bc7a22011-10-27 09:33:13 +00003766 IdentifierResolver &IdResolver,
3767 bool IsModule) {
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00003768 using namespace llvm;
3769
Richard Smith33e0f7e2015-07-22 02:08:40 +00003770 RecordData InterestingIdents;
3771
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00003772 // Create and write out the blob that contains the identifier
3773 // strings.
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00003774 {
Justin Bognerbb094f02014-04-18 19:57:06 +00003775 llvm::OnDiskChainedHashTableGenerator<ASTIdentifierTableTrait> Generator;
Richard Smith33e0f7e2015-07-22 02:08:40 +00003776 ASTIdentifierTableTrait Trait(
3777 *this, PP, IdResolver, IsModule,
3778 (getLangOpts().CPlusPlus && IsModule) ? &InterestingIdents : nullptr);
Mike Stump11289f42009-09-09 15:08:12 +00003779
Douglas Gregore6648fb2009-04-28 20:33:11 +00003780 // Look for any identifiers that were named while processing the
3781 // headers, but are otherwise not needed. We add these to the hash
3782 // table to enable checking of the predefines buffer in the case
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00003783 // where the user adds new macro definitions when building the AST
Douglas Gregore6648fb2009-04-28 20:33:11 +00003784 // file.
Chandler Carruth8440c982015-03-26 23:54:15 +00003785 SmallVector<const IdentifierInfo *, 128> IIs;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00003786 for (const auto &ID : PP.getIdentifierTable())
3787 IIs.push_back(ID.second);
Chandler Carruth8440c982015-03-26 23:54:15 +00003788 // Sort the identifiers lexicographically before getting them references so
3789 // that their order is stable.
Benjamin Kramercd2bae32019-08-22 17:32:16 +00003790 llvm::sort(IIs, llvm::deref<std::less<>>());
Chandler Carruth8440c982015-03-26 23:54:15 +00003791 for (const IdentifierInfo *II : IIs)
Richard Smith9c254182015-07-19 21:41:12 +00003792 if (Trait.isInterestingNonMacroIdentifier(II))
3793 getIdentifierRef(II);
Douglas Gregore6648fb2009-04-28 20:33:11 +00003794
Sebastian Redlff4a2952010-07-23 23:49:55 +00003795 // Create the on-disk hash table representation. We only store offsets
3796 // for identifiers that appear here for the first time.
3797 IdentifierOffsets.resize(NextIdentID - FirstIdentID);
Chandler Carruth885e78c2015-03-24 21:18:10 +00003798 for (auto IdentIDPair : IdentifierIDs) {
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00003799 auto *II = const_cast<IdentifierInfo *>(IdentIDPair.first);
Chandler Carruth885e78c2015-03-24 21:18:10 +00003800 IdentID ID = IdentIDPair.second;
3801 assert(II && "NULL identifier in identifier table");
Vassil Vassilev262f41e2016-03-30 20:16:03 +00003802 // Write out identifiers if either the ID is local or the identifier has
3803 // changed since it was loaded.
3804 if (ID >= FirstIdentID || !Chain || !II->isFromAST()
3805 || II->hasChangedSinceDeserialization() ||
Richard Smithd79514e2016-02-05 19:03:40 +00003806 (Trait.needDecls() &&
3807 II->hasFETokenInfoChangedSinceDeserialization()))
Chandler Carruth885e78c2015-03-24 21:18:10 +00003808 Generator.insert(II, ID, Trait);
Douglas Gregore84a9da2009-04-20 20:36:09 +00003809 }
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00003810
Douglas Gregore84a9da2009-04-20 20:36:09 +00003811 // Create the on-disk hash table in a buffer.
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00003812 SmallString<4096> IdentifierTable;
Douglas Gregora868bbd2009-04-21 22:25:48 +00003813 uint32_t BucketOffset;
Douglas Gregore84a9da2009-04-20 20:36:09 +00003814 {
Justin Bognere1c147c2014-03-28 22:03:19 +00003815 using namespace llvm::support;
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003816
Douglas Gregore84a9da2009-04-20 20:36:09 +00003817 llvm::raw_svector_ostream Out(IdentifierTable);
Douglas Gregorc78d3462009-04-24 21:10:55 +00003818 // Make sure that no bucket is at offset 0
Peter Collingbournee3f65292018-05-18 19:46:24 +00003819 endian::write<uint32_t>(Out, 0, little);
Douglas Gregora868bbd2009-04-21 22:25:48 +00003820 BucketOffset = Generator.Emit(Out, Trait);
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00003821 }
3822
3823 // Create a blob abbreviation
David Blaikieb44f0bf2017-01-04 22:36:43 +00003824 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Sebastian Redl539c5062010-08-18 23:57:32 +00003825 Abbrev->Add(BitCodeAbbrevOp(IDENTIFIER_TABLE));
Douglas Gregora868bbd2009-04-21 22:25:48 +00003826 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
Douglas Gregore84a9da2009-04-20 20:36:09 +00003827 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
David Blaikieb44f0bf2017-01-04 22:36:43 +00003828 unsigned IDTableAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00003829
3830 // Write the identifier table
Mehdi Amini57a41912015-09-10 01:46:39 +00003831 RecordData::value_type Record[] = {IDENTIFIER_TABLE, BucketOffset};
Yaron Keren92e1b622015-03-18 10:17:07 +00003832 Stream.EmitRecordWithBlob(IDTableAbbrev, Record, IdentifierTable);
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00003833 }
3834
3835 // Write the offsets table for identifier IDs.
David Blaikieb44f0bf2017-01-04 22:36:43 +00003836 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Sebastian Redl539c5062010-08-18 23:57:32 +00003837 Abbrev->Add(BitCodeAbbrevOp(IDENTIFIER_OFFSET));
Douglas Gregor0e149972009-04-25 19:10:14 +00003838 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // # of identifiers
Douglas Gregor1ab036c2011-08-03 21:49:18 +00003839 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // first ID
Douglas Gregor0e149972009-04-25 19:10:14 +00003840 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
David Blaikieb44f0bf2017-01-04 22:36:43 +00003841 unsigned IdentifierOffsetAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregor0e149972009-04-25 19:10:14 +00003842
Douglas Gregor8d7edce2013-02-08 21:30:59 +00003843#ifndef NDEBUG
3844 for (unsigned I = 0, N = IdentifierOffsets.size(); I != N; ++I)
3845 assert(IdentifierOffsets[I] && "Missing identifier offset?");
3846#endif
Mehdi Amini57a41912015-09-10 01:46:39 +00003847
3848 RecordData::value_type Record[] = {IDENTIFIER_OFFSET,
3849 IdentifierOffsets.size(),
3850 FirstIdentID - NUM_PREDEF_IDENT_IDS};
Douglas Gregor0e149972009-04-25 19:10:14 +00003851 Stream.EmitRecordWithBlob(IdentifierOffsetAbbrev, Record,
Reid Kleckner012665e2015-05-21 00:13:09 +00003852 bytes(IdentifierOffsets));
Richard Smith33e0f7e2015-07-22 02:08:40 +00003853
3854 // In C++, write the list of interesting identifiers (those that are
3855 // defined as macros, poisoned, or similar unusual things).
3856 if (!InterestingIdents.empty())
3857 Stream.EmitRecord(INTERESTING_IDENTIFIERS, InterestingIdents);
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00003858}
3859
Douglas Gregorc5046832009-04-27 18:38:38 +00003860//===----------------------------------------------------------------------===//
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003861// DeclContext's Name Lookup Table Serialization
3862//===----------------------------------------------------------------------===//
3863
3864namespace {
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +00003865
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003866// Trait used for the on-disk hash table used in the method pool.
3867class ASTDeclContextNameLookupTrait {
3868 ASTWriter &Writer;
Richard Smithd88a7f12015-09-01 20:35:42 +00003869 llvm::SmallVector<DeclID, 64> DeclIDs;
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003870
3871public:
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003872 using key_type = DeclarationNameKey;
3873 using key_type_ref = key_type;
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003874
Richard Smithd88a7f12015-09-01 20:35:42 +00003875 /// A start and end index into DeclIDs, representing a sequence of decls.
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003876 using data_type = std::pair<unsigned, unsigned>;
3877 using data_type_ref = const data_type &;
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003878
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003879 using hash_value_type = unsigned;
3880 using offset_type = unsigned;
Justin Bogner25463f12014-04-18 20:27:24 +00003881
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003882 explicit ASTDeclContextNameLookupTrait(ASTWriter &Writer) : Writer(Writer) {}
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003883
Richard Smithd88a7f12015-09-01 20:35:42 +00003884 template<typename Coll>
3885 data_type getData(const Coll &Decls) {
3886 unsigned Start = DeclIDs.size();
3887 for (NamedDecl *D : Decls) {
3888 DeclIDs.push_back(
3889 Writer.GetDeclRef(getDeclForLocalLookup(Writer.getLangOpts(), D)));
3890 }
3891 return std::make_pair(Start, DeclIDs.size());
3892 }
3893
3894 data_type ImportData(const reader::ASTDeclContextNameLookupTrait::data_type &FromReader) {
3895 unsigned Start = DeclIDs.size();
3896 for (auto ID : FromReader)
3897 DeclIDs.push_back(ID);
3898 return std::make_pair(Start, DeclIDs.size());
3899 }
3900
3901 static bool EqualKey(key_type_ref a, key_type_ref b) {
3902 return a == b;
3903 }
3904
Richard Smitha06c7e62015-08-26 23:55:49 +00003905 hash_value_type ComputeHash(DeclarationNameKey Name) {
3906 return Name.getHash();
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003907 }
3908
Richard Smithd88a7f12015-09-01 20:35:42 +00003909 void EmitFileRef(raw_ostream &Out, ModuleFile *F) const {
3910 assert(Writer.hasChain() &&
3911 "have reference to loaded module file but no chain?");
3912
3913 using namespace llvm::support;
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003914
Peter Collingbournee3f65292018-05-18 19:46:24 +00003915 endian::write<uint32_t>(Out, Writer.getChain()->getModuleFileID(F), little);
Richard Smithd88a7f12015-09-01 20:35:42 +00003916 }
3917
Richard Smitha06c7e62015-08-26 23:55:49 +00003918 std::pair<unsigned, unsigned> EmitKeyDataLength(raw_ostream &Out,
3919 DeclarationNameKey Name,
3920 data_type_ref Lookup) {
Justin Bognere1c147c2014-03-28 22:03:19 +00003921 using namespace llvm::support;
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003922
Peter Collingbournee3f65292018-05-18 19:46:24 +00003923 endian::Writer LE(Out, little);
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003924 unsigned KeyLen = 1;
Richard Smitha06c7e62015-08-26 23:55:49 +00003925 switch (Name.getKind()) {
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003926 case DeclarationName::Identifier:
3927 case DeclarationName::ObjCZeroArgSelector:
3928 case DeclarationName::ObjCOneArgSelector:
3929 case DeclarationName::ObjCMultiArgSelector:
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003930 case DeclarationName::CXXLiteralOperatorName:
Richard Smith35845152017-02-07 01:37:30 +00003931 case DeclarationName::CXXDeductionGuideName:
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003932 KeyLen += 4;
3933 break;
3934 case DeclarationName::CXXOperatorName:
3935 KeyLen += 1;
3936 break;
Douglas Gregor3b65ed02011-08-02 18:32:54 +00003937 case DeclarationName::CXXConstructorName:
3938 case DeclarationName::CXXDestructorName:
3939 case DeclarationName::CXXConversionFunctionName:
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003940 case DeclarationName::CXXUsingDirective:
3941 break;
3942 }
Justin Bognere1c147c2014-03-28 22:03:19 +00003943 LE.write<uint16_t>(KeyLen);
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003944
Richard Smithf02662d2015-07-30 03:17:16 +00003945 // 4 bytes for each DeclID.
Richard Smithd88a7f12015-09-01 20:35:42 +00003946 unsigned DataLen = 4 * (Lookup.second - Lookup.first);
3947 assert(uint16_t(DataLen) == DataLen &&
3948 "too many decls for serialized lookup result");
Justin Bognere1c147c2014-03-28 22:03:19 +00003949 LE.write<uint16_t>(DataLen);
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003950
3951 return std::make_pair(KeyLen, DataLen);
3952 }
3953
Richard Smitha06c7e62015-08-26 23:55:49 +00003954 void EmitKey(raw_ostream &Out, DeclarationNameKey Name, unsigned) {
Justin Bognere1c147c2014-03-28 22:03:19 +00003955 using namespace llvm::support;
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003956
Peter Collingbournee3f65292018-05-18 19:46:24 +00003957 endian::Writer LE(Out, little);
Richard Smitha06c7e62015-08-26 23:55:49 +00003958 LE.write<uint8_t>(Name.getKind());
3959 switch (Name.getKind()) {
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003960 case DeclarationName::Identifier:
Richard Smitha06c7e62015-08-26 23:55:49 +00003961 case DeclarationName::CXXLiteralOperatorName:
Richard Smith35845152017-02-07 01:37:30 +00003962 case DeclarationName::CXXDeductionGuideName:
Richard Smitha06c7e62015-08-26 23:55:49 +00003963 LE.write<uint32_t>(Writer.getIdentifierRef(Name.getIdentifier()));
Benjamin Kramer53750b12012-09-19 13:40:40 +00003964 return;
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003965 case DeclarationName::ObjCZeroArgSelector:
3966 case DeclarationName::ObjCOneArgSelector:
3967 case DeclarationName::ObjCMultiArgSelector:
Richard Smitha06c7e62015-08-26 23:55:49 +00003968 LE.write<uint32_t>(Writer.getSelectorRef(Name.getSelector()));
Benjamin Kramer53750b12012-09-19 13:40:40 +00003969 return;
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003970 case DeclarationName::CXXOperatorName:
Richard Smitha06c7e62015-08-26 23:55:49 +00003971 assert(Name.getOperatorKind() < NUM_OVERLOADED_OPERATORS &&
Benjamin Kramer53750b12012-09-19 13:40:40 +00003972 "Invalid operator?");
Richard Smitha06c7e62015-08-26 23:55:49 +00003973 LE.write<uint8_t>(Name.getOperatorKind());
Benjamin Kramer53750b12012-09-19 13:40:40 +00003974 return;
Douglas Gregor3b65ed02011-08-02 18:32:54 +00003975 case DeclarationName::CXXConstructorName:
3976 case DeclarationName::CXXDestructorName:
3977 case DeclarationName::CXXConversionFunctionName:
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003978 case DeclarationName::CXXUsingDirective:
Benjamin Kramer53750b12012-09-19 13:40:40 +00003979 return;
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003980 }
Benjamin Kramer53750b12012-09-19 13:40:40 +00003981
3982 llvm_unreachable("Invalid name kind?");
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003983 }
3984
Richard Smitha06c7e62015-08-26 23:55:49 +00003985 void EmitData(raw_ostream &Out, key_type_ref, data_type Lookup,
3986 unsigned DataLen) {
Justin Bognere1c147c2014-03-28 22:03:19 +00003987 using namespace llvm::support;
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003988
Peter Collingbournee3f65292018-05-18 19:46:24 +00003989 endian::Writer LE(Out, little);
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003990 uint64_t Start = Out.tell(); (void)Start;
Richard Smithd88a7f12015-09-01 20:35:42 +00003991 for (unsigned I = Lookup.first, N = Lookup.second; I != N; ++I)
3992 LE.write<uint32_t>(DeclIDs[I]);
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003993 assert(Out.tell() - Start == DataLen && "Data length is wrong");
3994 }
3995};
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +00003996
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003997} // namespace
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003998
Chandler Carruthe972c362015-03-26 03:11:40 +00003999bool ASTWriter::isLookupResultExternal(StoredDeclsList &Result,
4000 DeclContext *DC) {
Erich Keanef92f31c2018-08-01 20:48:16 +00004001 return Result.hasExternalDecls() &&
4002 DC->hasNeedToReconcileExternalVisibleStorage();
Chandler Carruthe972c362015-03-26 03:11:40 +00004003}
4004
4005bool ASTWriter::isLookupResultEntirelyExternal(StoredDeclsList &Result,
4006 DeclContext *DC) {
4007 for (auto *D : Result.getLookupResult())
4008 if (!getDeclForLocalLookup(getLangOpts(), D)->isFromASTFile())
4009 return false;
4010
4011 return true;
4012}
4013
Richard Smithd88a7f12015-09-01 20:35:42 +00004014void
Chandler Carruthe972c362015-03-26 03:11:40 +00004015ASTWriter::GenerateNameLookupTable(const DeclContext *ConstDC,
Richard Smithcd45dbc2014-04-19 03:48:30 +00004016 llvm::SmallVectorImpl<char> &LookupTable) {
Erich Keanef92f31c2018-08-01 20:48:16 +00004017 assert(!ConstDC->hasLazyLocalLexicalLookups() &&
4018 !ConstDC->hasLazyExternalLexicalLookups() &&
Richard Smith9e2341d2015-03-23 03:25:59 +00004019 "must call buildLookups first");
Richard Smithcd45dbc2014-04-19 03:48:30 +00004020
Chandler Carruthe972c362015-03-26 03:11:40 +00004021 // FIXME: We need to build the lookups table, which is logically const.
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00004022 auto *DC = const_cast<DeclContext*>(ConstDC);
Chandler Carruthe972c362015-03-26 03:11:40 +00004023 assert(DC == DC->getPrimaryContext() && "only primary DC has lookup table");
4024
4025 // Create the on-disk hash table representation.
Richard Smithd88a7f12015-09-01 20:35:42 +00004026 MultiOnDiskHashTableGenerator<reader::ASTDeclContextNameLookupTrait,
4027 ASTDeclContextNameLookupTrait> Generator;
Richard Smithcd45dbc2014-04-19 03:48:30 +00004028 ASTDeclContextNameLookupTrait Trait(*this);
4029
Chandler Carruthe972c362015-03-26 03:11:40 +00004030 // The first step is to collect the declaration names which we need to
4031 // serialize into the name lookup table, and to collect them in a stable
4032 // order.
4033 SmallVector<DeclarationName, 16> Names;
Richard Smithcd45dbc2014-04-19 03:48:30 +00004034
Chandler Carruthe972c362015-03-26 03:11:40 +00004035 // We also build up small sets of the constructor and conversion function
4036 // names which are visible.
4037 llvm::SmallSet<DeclarationName, 8> ConstructorNameSet, ConversionNameSet;
Richard Smithcd45dbc2014-04-19 03:48:30 +00004038
Chandler Carruthe972c362015-03-26 03:11:40 +00004039 for (auto &Lookup : *DC->buildLookup()) {
4040 auto &Name = Lookup.first;
4041 auto &Result = Lookup.second;
4042
Douglas Gregor7dd37e52015-11-03 01:20:54 +00004043 // If there are no local declarations in our lookup result, we
4044 // don't need to write an entry for the name at all. If we can't
4045 // write out a lookup set without performing more deserialization,
4046 // just skip this entry.
4047 if (isLookupResultExternal(Result, DC) &&
Chandler Carruthe972c362015-03-26 03:11:40 +00004048 isLookupResultEntirelyExternal(Result, DC))
4049 continue;
4050
4051 // We also skip empty results. If any of the results could be external and
4052 // the currently available results are empty, then all of the results are
4053 // external and we skip it above. So the only way we get here with an empty
4054 // results is when no results could have been external *and* we have
4055 // external results.
4056 //
4057 // FIXME: While we might want to start emitting on-disk entries for negative
4058 // lookups into a decl context as an optimization, today we *have* to skip
4059 // them because there are names with empty lookup results in decl contexts
4060 // which we can't emit in any stable ordering: we lookup constructors and
4061 // conversion functions in the enclosing namespace scope creating empty
4062 // results for them. This in almost certainly a bug in Clang's name lookup,
4063 // but that is likely to be hard or impossible to fix and so we tolerate it
4064 // here by omitting lookups with empty results.
4065 if (Lookup.second.getLookupResult().empty())
4066 continue;
4067
4068 switch (Lookup.first.getNameKind()) {
4069 default:
4070 Names.push_back(Lookup.first);
4071 break;
4072
Richard Smithcd45dbc2014-04-19 03:48:30 +00004073 case DeclarationName::CXXConstructorName:
Chandler Carruthe972c362015-03-26 03:11:40 +00004074 assert(isa<CXXRecordDecl>(DC) &&
4075 "Cannot have a constructor name outside of a class!");
4076 ConstructorNameSet.insert(Name);
4077 break;
Richard Smithcd45dbc2014-04-19 03:48:30 +00004078
4079 case DeclarationName::CXXConversionFunctionName:
Chandler Carruthe972c362015-03-26 03:11:40 +00004080 assert(isa<CXXRecordDecl>(DC) &&
4081 "Cannot have a conversion function name outside of a class!");
4082 ConversionNameSet.insert(Name);
Rafael Espindolac606b3e2015-03-25 04:43:15 +00004083 break;
Richard Smithcd45dbc2014-04-19 03:48:30 +00004084 }
Chandler Carruth75c9f132015-03-25 00:34:51 +00004085 }
Chandler Carruth75c9f132015-03-25 00:34:51 +00004086
Chandler Carruthe972c362015-03-26 03:11:40 +00004087 // Sort the names into a stable order.
Fangrui Song55fab262018-09-26 22:16:28 +00004088 llvm::sort(Names);
Chandler Carruthe972c362015-03-26 03:11:40 +00004089
Chandler Carruthffbf7052015-03-26 22:27:09 +00004090 if (auto *D = dyn_cast<CXXRecordDecl>(DC)) {
Chandler Carruthe972c362015-03-26 03:11:40 +00004091 // We need to establish an ordering of constructor and conversion function
Chandler Carruthffbf7052015-03-26 22:27:09 +00004092 // names, and they don't have an intrinsic ordering.
Chandler Carruthe972c362015-03-26 03:11:40 +00004093
Chandler Carruthffbf7052015-03-26 22:27:09 +00004094 // First we try the easy case by forming the current context's constructor
4095 // name and adding that name first. This is a very useful optimization to
4096 // avoid walking the lexical declarations in many cases, and it also
4097 // handles the only case where a constructor name can come from some other
4098 // lexical context -- when that name is an implicit constructor merged from
4099 // another declaration in the redecl chain. Any non-implicit constructor or
4100 // conversion function which doesn't occur in all the lexical contexts
4101 // would be an ODR violation.
4102 auto ImplicitCtorName = Context->DeclarationNames.getCXXConstructorName(
4103 Context->getCanonicalType(Context->getRecordType(D)));
4104 if (ConstructorNameSet.erase(ImplicitCtorName))
4105 Names.push_back(ImplicitCtorName);
Chandler Carruthe972c362015-03-26 03:11:40 +00004106
Chandler Carruthffbf7052015-03-26 22:27:09 +00004107 // If we still have constructors or conversion functions, we walk all the
4108 // names in the decl and add the constructors and conversion functions
4109 // which are visible in the order they lexically occur within the context.
4110 if (!ConstructorNameSet.empty() || !ConversionNameSet.empty())
4111 for (Decl *ChildD : cast<CXXRecordDecl>(DC)->decls())
4112 if (auto *ChildND = dyn_cast<NamedDecl>(ChildD)) {
4113 auto Name = ChildND->getDeclName();
4114 switch (Name.getNameKind()) {
4115 default:
4116 continue;
4117
4118 case DeclarationName::CXXConstructorName:
4119 if (ConstructorNameSet.erase(Name))
4120 Names.push_back(Name);
4121 break;
4122
4123 case DeclarationName::CXXConversionFunctionName:
4124 if (ConversionNameSet.erase(Name))
4125 Names.push_back(Name);
4126 break;
4127 }
4128
4129 if (ConstructorNameSet.empty() && ConversionNameSet.empty())
4130 break;
Chandler Carruthe972c362015-03-26 03:11:40 +00004131 }
4132
Chandler Carruthe972c362015-03-26 03:11:40 +00004133 assert(ConstructorNameSet.empty() && "Failed to find all of the visible "
4134 "constructors by walking all the "
4135 "lexical members of the context.");
4136 assert(ConversionNameSet.empty() && "Failed to find all of the visible "
4137 "conversion functions by walking all "
4138 "the lexical members of the context.");
Richard Smith961eae52014-03-25 01:14:22 +00004139 }
4140
Chandler Carruthe972c362015-03-26 03:11:40 +00004141 // Next we need to do a lookup with each name into this decl context to fully
4142 // populate any results from external sources. We don't actually use the
4143 // results of these lookups because we only want to use the results after all
4144 // results have been loaded and the pointers into them will be stable.
4145 for (auto &Name : Names)
4146 DC->lookup(Name);
4147
4148 // Now we need to insert the results for each name into the hash table. For
4149 // constructor names and conversion function names, we actually need to merge
4150 // all of the results for them into one list of results each and insert
4151 // those.
4152 SmallVector<NamedDecl *, 8> ConstructorDecls;
4153 SmallVector<NamedDecl *, 8> ConversionDecls;
4154
4155 // Now loop over the names, either inserting them or appending for the two
4156 // special cases.
4157 for (auto &Name : Names) {
4158 DeclContext::lookup_result Result = DC->noload_lookup(Name);
4159
4160 switch (Name.getNameKind()) {
4161 default:
Richard Smithd88a7f12015-09-01 20:35:42 +00004162 Generator.insert(Name, Trait.getData(Result), Trait);
Chandler Carruthe972c362015-03-26 03:11:40 +00004163 break;
4164
4165 case DeclarationName::CXXConstructorName:
4166 ConstructorDecls.append(Result.begin(), Result.end());
4167 break;
4168
4169 case DeclarationName::CXXConversionFunctionName:
4170 ConversionDecls.append(Result.begin(), Result.end());
4171 break;
4172 }
4173 }
4174
4175 // Handle our two special cases if we ended up having any. We arbitrarily use
4176 // the first declaration's name here because the name itself isn't part of
4177 // the key, only the kind of name is used.
4178 if (!ConstructorDecls.empty())
4179 Generator.insert(ConstructorDecls.front()->getDeclName(),
Richard Smithd88a7f12015-09-01 20:35:42 +00004180 Trait.getData(ConstructorDecls), Trait);
Chandler Carruthe972c362015-03-26 03:11:40 +00004181 if (!ConversionDecls.empty())
4182 Generator.insert(ConversionDecls.front()->getDeclName(),
Richard Smithd88a7f12015-09-01 20:35:42 +00004183 Trait.getData(ConversionDecls), Trait);
Chandler Carruthe972c362015-03-26 03:11:40 +00004184
Richard Smithd88a7f12015-09-01 20:35:42 +00004185 // Create the on-disk hash table. Also emit the existing imported and
4186 // merged table if there is one.
4187 auto *Lookups = Chain ? Chain->getLoadedLookupTables(DC) : nullptr;
4188 Generator.emit(LookupTable, Trait, Lookups ? &Lookups->Table : nullptr);
Richard Smith961eae52014-03-25 01:14:22 +00004189}
4190
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00004191/// Write the block containing all of the declaration IDs
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00004192/// visible from the given DeclContext.
4193///
4194/// \returns the offset of the DECL_CONTEXT_VISIBLE block within the
Sebastian Redla4071b42010-08-24 00:50:09 +00004195/// bitstream, or 0 if no block was written.
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00004196uint64_t ASTWriter::WriteDeclContextVisibleBlock(ASTContext &Context,
4197 DeclContext *DC) {
Richard Smith5fc18a92015-07-12 23:43:21 +00004198 // If we imported a key declaration of this namespace, write the visible
4199 // lookup results as an update record for it rather than including them
4200 // on this declaration. We will only look at key declarations on reload.
4201 if (isa<NamespaceDecl>(DC) && Chain &&
4202 Chain->getKeyDeclaration(cast<Decl>(DC))->isFromASTFile()) {
4203 // Only do this once, for the first local declaration of the namespace.
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00004204 for (auto *Prev = cast<NamespaceDecl>(DC)->getPreviousDecl(); Prev;
Richard Smith5fc18a92015-07-12 23:43:21 +00004205 Prev = Prev->getPreviousDecl())
4206 if (!Prev->isFromASTFile())
4207 return 0;
4208
4209 // Note that we need to emit an update record for the primary context.
4210 UpdatedDeclContexts.insert(DC->getPrimaryContext());
4211
4212 // Make sure all visible decls are written. They will be recorded later. We
4213 // do this using a side data structure so we can sort the names into
4214 // a deterministic order.
4215 StoredDeclsMap *Map = DC->getPrimaryContext()->buildLookup();
4216 SmallVector<std::pair<DeclarationName, DeclContext::lookup_result>, 16>
4217 LookupResults;
4218 if (Map) {
4219 LookupResults.reserve(Map->size());
4220 for (auto &Entry : *Map)
4221 LookupResults.push_back(
4222 std::make_pair(Entry.first, Entry.second.getLookupResult()));
4223 }
4224
Fangrui Song55fab262018-09-26 22:16:28 +00004225 llvm::sort(LookupResults, llvm::less_first());
Richard Smith5fc18a92015-07-12 23:43:21 +00004226 for (auto &NameAndResult : LookupResults) {
4227 DeclarationName Name = NameAndResult.first;
4228 DeclContext::lookup_result Result = NameAndResult.second;
4229 if (Name.getNameKind() == DeclarationName::CXXConstructorName ||
4230 Name.getNameKind() == DeclarationName::CXXConversionFunctionName) {
4231 // We have to work around a name lookup bug here where negative lookup
4232 // results for these names get cached in namespace lookup tables (these
4233 // names should never be looked up in a namespace).
4234 assert(Result.empty() && "Cannot have a constructor or conversion "
4235 "function name in a namespace!");
4236 continue;
4237 }
4238
4239 for (NamedDecl *ND : Result)
4240 if (!ND->isFromASTFile())
4241 GetDeclRef(ND);
4242 }
4243
4244 return 0;
4245 }
4246
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00004247 if (DC->getPrimaryContext() != DC)
4248 return 0;
4249
Chandler Carruthe972c362015-03-26 03:11:40 +00004250 // Skip contexts which don't support name lookup.
4251 if (!DC->isLookupContext())
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00004252 return 0;
4253
4254 // If not in C++, we perform name lookup for the translation unit via the
4255 // IdentifierInfo chains, don't bother to build a visible-declarations table.
David Blaikiebbafb8a2012-03-11 07:00:24 +00004256 if (DC->isTranslationUnit() && !Context.getLangOpts().CPlusPlus)
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00004257 return 0;
4258
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00004259 // Serialize the contents of the mapping used for lookup. Note that,
4260 // although we have two very different code paths, the serialized
4261 // representation is the same for both cases: a declaration name,
4262 // followed by a size, followed by references to the visible
4263 // declarations that have that name.
4264 uint64_t Offset = Stream.GetCurrentBitNo();
Richard Smithf634c902012-03-16 06:12:59 +00004265 StoredDeclsMap *Map = DC->buildLookup();
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00004266 if (!Map || Map->empty())
4267 return 0;
4268
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00004269 // Create the on-disk hash table in a buffer.
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00004270 SmallString<4096> LookupTable;
Richard Smithd88a7f12015-09-01 20:35:42 +00004271 GenerateNameLookupTable(DC, LookupTable);
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00004272
4273 // Write the lookup table
Mehdi Amini57a41912015-09-10 01:46:39 +00004274 RecordData::value_type Record[] = {DECL_CONTEXT_VISIBLE};
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00004275 Stream.EmitRecordWithBlob(DeclContextVisibleLookupAbbrev, Record,
Yaron Keren92e1b622015-03-18 10:17:07 +00004276 LookupTable);
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00004277 ++NumVisibleDeclContexts;
4278 return Offset;
4279}
4280
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00004281/// Write an UPDATE_VISIBLE block for the given context.
Sebastian Redla4071b42010-08-24 00:50:09 +00004282///
4283/// UPDATE_VISIBLE blocks contain the declarations that are added to an existing
4284/// DeclContext in a dependent AST file. As such, they only exist for the TU
Richard Smithf634c902012-03-16 06:12:59 +00004285/// (in C++), for namespaces, and for classes with forward-declared unscoped
4286/// enumeration members (in C++11).
Sebastian Redla4071b42010-08-24 00:50:09 +00004287void ASTWriter::WriteDeclContextVisibleUpdate(const DeclContext *DC) {
Richard Smith961eae52014-03-25 01:14:22 +00004288 StoredDeclsMap *Map = DC->getLookupPtr();
Sebastian Redla4071b42010-08-24 00:50:09 +00004289 if (!Map || Map->empty())
4290 return;
4291
Sebastian Redla4071b42010-08-24 00:50:09 +00004292 // Create the on-disk hash table in a buffer.
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00004293 SmallString<4096> LookupTable;
Richard Smithd88a7f12015-09-01 20:35:42 +00004294 GenerateNameLookupTable(DC, LookupTable);
Sebastian Redla4071b42010-08-24 00:50:09 +00004295
Richard Smith5fc18a92015-07-12 23:43:21 +00004296 // If we're updating a namespace, select a key declaration as the key for the
4297 // update record; those are the only ones that will be checked on reload.
4298 if (isa<NamespaceDecl>(DC))
4299 DC = cast<DeclContext>(Chain->getKeyDeclaration(cast<Decl>(DC)));
4300
Sebastian Redla4071b42010-08-24 00:50:09 +00004301 // Write the lookup table
Mehdi Amini57a41912015-09-10 01:46:39 +00004302 RecordData::value_type Record[] = {UPDATE_VISIBLE, getDeclID(cast<Decl>(DC))};
Yaron Keren92e1b622015-03-18 10:17:07 +00004303 Stream.EmitRecordWithBlob(UpdateVisibleAbbrev, Record, LookupTable);
Sebastian Redla4071b42010-08-24 00:50:09 +00004304}
4305
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00004306/// Write an FP_PRAGMA_OPTIONS block for the given FPOptions.
Peter Collingbourne5df20e02011-02-15 19:46:30 +00004307void ASTWriter::WriteFPPragmaOptions(const FPOptions &Opts) {
Adam Nemet484aa452017-03-27 19:17:25 +00004308 RecordData::value_type Record[] = {Opts.getInt()};
Peter Collingbourne5df20e02011-02-15 19:46:30 +00004309 Stream.EmitRecord(FP_PRAGMA_OPTIONS, Record);
4310}
4311
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00004312/// Write an OPENCL_EXTENSIONS block for the given OpenCLOptions.
Peter Collingbourne5df20e02011-02-15 19:46:30 +00004313void ASTWriter::WriteOpenCLExtensions(Sema &SemaRef) {
David Blaikiebbafb8a2012-03-11 07:00:24 +00004314 if (!SemaRef.Context.getLangOpts().OpenCL)
Peter Collingbourne5df20e02011-02-15 19:46:30 +00004315 return;
4316
4317 const OpenCLOptions &Opts = SemaRef.getOpenCLOptions();
4318 RecordData Record;
Yaxun Liu5b746652016-12-18 05:18:55 +00004319 for (const auto &I:Opts.OptMap) {
4320 AddString(I.getKey(), Record);
4321 auto V = I.getValue();
Yaxun Liucc2741c2016-12-18 06:35:06 +00004322 Record.push_back(V.Supported ? 1 : 0);
4323 Record.push_back(V.Enabled ? 1 : 0);
Yaxun Liu5b746652016-12-18 05:18:55 +00004324 Record.push_back(V.Avail);
4325 Record.push_back(V.Core);
4326 }
Peter Collingbourne5df20e02011-02-15 19:46:30 +00004327 Stream.EmitRecord(OPENCL_EXTENSIONS, Record);
4328}
4329
Yaxun Liu5b746652016-12-18 05:18:55 +00004330void ASTWriter::WriteOpenCLExtensionTypes(Sema &SemaRef) {
4331 if (!SemaRef.Context.getLangOpts().OpenCL)
4332 return;
4333
Bruno Ricci2751b692019-04-18 15:13:27 +00004334 // Sort the elements of the map OpenCLTypeExtMap by TypeIDs,
4335 // without copying them.
4336 const llvm::DenseMap<const Type *, std::set<std::string>> &OpenCLTypeExtMap =
4337 SemaRef.OpenCLTypeExtMap;
4338 using ElementTy = std::pair<TypeID, const std::set<std::string> *>;
4339 llvm::SmallVector<ElementTy, 8> StableOpenCLTypeExtMap;
4340 StableOpenCLTypeExtMap.reserve(OpenCLTypeExtMap.size());
4341
4342 for (const auto &I : OpenCLTypeExtMap)
4343 StableOpenCLTypeExtMap.emplace_back(
4344 getTypeID(I.first->getCanonicalTypeInternal()), &I.second);
4345
4346 auto CompareByTypeID = [](const ElementTy &E1, const ElementTy &E2) -> bool {
4347 return E1.first < E2.first;
4348 };
4349 llvm::sort(StableOpenCLTypeExtMap, CompareByTypeID);
4350
Yaxun Liu5b746652016-12-18 05:18:55 +00004351 RecordData Record;
Bruno Ricci2751b692019-04-18 15:13:27 +00004352 for (const ElementTy &E : StableOpenCLTypeExtMap) {
4353 Record.push_back(E.first); // TypeID
4354 const std::set<std::string> *ExtSet = E.second;
4355 Record.push_back(static_cast<unsigned>(ExtSet->size()));
4356 for (const std::string &Ext : *ExtSet)
Yaxun Liu5b746652016-12-18 05:18:55 +00004357 AddString(Ext, Record);
4358 }
Bruno Ricci2751b692019-04-18 15:13:27 +00004359
Yaxun Liu5b746652016-12-18 05:18:55 +00004360 Stream.EmitRecord(OPENCL_EXTENSION_TYPES, Record);
4361}
4362
4363void ASTWriter::WriteOpenCLExtensionDecls(Sema &SemaRef) {
4364 if (!SemaRef.Context.getLangOpts().OpenCL)
4365 return;
4366
Bruno Ricci2751b692019-04-18 15:13:27 +00004367 // Sort the elements of the map OpenCLDeclExtMap by DeclIDs,
4368 // without copying them.
4369 const llvm::DenseMap<const Decl *, std::set<std::string>> &OpenCLDeclExtMap =
4370 SemaRef.OpenCLDeclExtMap;
4371 using ElementTy = std::pair<DeclID, const std::set<std::string> *>;
4372 llvm::SmallVector<ElementTy, 8> StableOpenCLDeclExtMap;
4373 StableOpenCLDeclExtMap.reserve(OpenCLDeclExtMap.size());
4374
4375 for (const auto &I : OpenCLDeclExtMap)
4376 StableOpenCLDeclExtMap.emplace_back(getDeclID(I.first), &I.second);
4377
4378 auto CompareByDeclID = [](const ElementTy &E1, const ElementTy &E2) -> bool {
4379 return E1.first < E2.first;
4380 };
4381 llvm::sort(StableOpenCLDeclExtMap, CompareByDeclID);
4382
Yaxun Liu5b746652016-12-18 05:18:55 +00004383 RecordData Record;
Bruno Ricci2751b692019-04-18 15:13:27 +00004384 for (const ElementTy &E : StableOpenCLDeclExtMap) {
4385 Record.push_back(E.first); // DeclID
4386 const std::set<std::string> *ExtSet = E.second;
4387 Record.push_back(static_cast<unsigned>(ExtSet->size()));
4388 for (const std::string &Ext : *ExtSet)
Yaxun Liu5b746652016-12-18 05:18:55 +00004389 AddString(Ext, Record);
4390 }
Bruno Ricci2751b692019-04-18 15:13:27 +00004391
Yaxun Liu5b746652016-12-18 05:18:55 +00004392 Stream.EmitRecord(OPENCL_EXTENSION_DECLS, Record);
4393}
4394
Justin Lebar67a78a62016-10-08 22:15:58 +00004395void ASTWriter::WriteCUDAPragmas(Sema &SemaRef) {
4396 if (SemaRef.ForceCUDAHostDeviceDepth > 0) {
4397 RecordData::value_type Record[] = {SemaRef.ForceCUDAHostDeviceDepth};
4398 Stream.EmitRecord(CUDA_PRAGMA_FORCE_HOST_DEVICE_DEPTH, Record);
4399 }
4400}
4401
Douglas Gregor404cdde2012-01-27 01:47:08 +00004402void ASTWriter::WriteObjCCategories() {
Dmitri Gribenkof8579502013-01-12 19:30:44 +00004403 SmallVector<ObjCCategoriesInfo, 2> CategoriesMap;
Douglas Gregor404cdde2012-01-27 01:47:08 +00004404 RecordData Categories;
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00004405
Douglas Gregor404cdde2012-01-27 01:47:08 +00004406 for (unsigned I = 0, N = ObjCClassesWithCategories.size(); I != N; ++I) {
4407 unsigned Size = 0;
4408 unsigned StartIndex = Categories.size();
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00004409
Douglas Gregor404cdde2012-01-27 01:47:08 +00004410 ObjCInterfaceDecl *Class = ObjCClassesWithCategories[I];
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00004411
Douglas Gregor404cdde2012-01-27 01:47:08 +00004412 // Allocate space for the size.
4413 Categories.push_back(0);
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00004414
Douglas Gregor404cdde2012-01-27 01:47:08 +00004415 // Add the categories.
Douglas Gregor048fbfa2013-01-16 23:00:23 +00004416 for (ObjCInterfaceDecl::known_categories_iterator
4417 Cat = Class->known_categories_begin(),
4418 CatEnd = Class->known_categories_end();
4419 Cat != CatEnd; ++Cat, ++Size) {
4420 assert(getDeclID(*Cat) != 0 && "Bogus category");
4421 AddDeclRef(*Cat, Categories);
Douglas Gregor404cdde2012-01-27 01:47:08 +00004422 }
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00004423
Douglas Gregor404cdde2012-01-27 01:47:08 +00004424 // Update the size.
4425 Categories[StartIndex] = Size;
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00004426
Douglas Gregor404cdde2012-01-27 01:47:08 +00004427 // Record this interface -> category map.
4428 ObjCCategoriesInfo CatInfo = { getDeclID(Class), StartIndex };
4429 CategoriesMap.push_back(CatInfo);
4430 }
4431
4432 // Sort the categories map by the definition ID, since the reader will be
4433 // performing binary searches on this information.
4434 llvm::array_pod_sort(CategoriesMap.begin(), CategoriesMap.end());
4435
4436 // Emit the categories map.
4437 using namespace llvm;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00004438
David Blaikieb44f0bf2017-01-04 22:36:43 +00004439 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Douglas Gregor404cdde2012-01-27 01:47:08 +00004440 Abbrev->Add(BitCodeAbbrevOp(OBJC_CATEGORIES_MAP));
4441 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // # of entries
4442 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
David Blaikieb44f0bf2017-01-04 22:36:43 +00004443 unsigned AbbrevID = Stream.EmitAbbrev(std::move(Abbrev));
Mehdi Amini57a41912015-09-10 01:46:39 +00004444
4445 RecordData::value_type Record[] = {OBJC_CATEGORIES_MAP, CategoriesMap.size()};
4446 Stream.EmitRecordWithBlob(AbbrevID, Record,
4447 reinterpret_cast<char *>(CategoriesMap.data()),
Douglas Gregor404cdde2012-01-27 01:47:08 +00004448 CategoriesMap.size() * sizeof(ObjCCategoriesInfo));
Mehdi Amini57a41912015-09-10 01:46:39 +00004449
Douglas Gregor404cdde2012-01-27 01:47:08 +00004450 // Emit the category lists.
4451 Stream.EmitRecord(OBJC_CATEGORIES, Categories);
4452}
4453
Richard Smithe40f2ba2013-08-07 21:41:30 +00004454void ASTWriter::WriteLateParsedTemplates(Sema &SemaRef) {
4455 Sema::LateParsedTemplateMapT &LPTMap = SemaRef.LateParsedTemplateMap;
4456
4457 if (LPTMap.empty())
4458 return;
4459
4460 RecordData Record;
Justin Lebar28f09c52016-10-10 16:26:08 +00004461 for (auto &LPTMapEntry : LPTMap) {
Chandler Carruth52cee4d2015-03-26 09:08:15 +00004462 const FunctionDecl *FD = LPTMapEntry.first;
Justin Lebar28f09c52016-10-10 16:26:08 +00004463 LateParsedTemplate &LPT = *LPTMapEntry.second;
Chandler Carruth52cee4d2015-03-26 09:08:15 +00004464 AddDeclRef(FD, Record);
Justin Lebar28f09c52016-10-10 16:26:08 +00004465 AddDeclRef(LPT.D, Record);
4466 Record.push_back(LPT.Toks.size());
Richard Smithe40f2ba2013-08-07 21:41:30 +00004467
Justin Lebar28f09c52016-10-10 16:26:08 +00004468 for (const auto &Tok : LPT.Toks) {
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00004469 AddToken(Tok, Record);
Richard Smithe40f2ba2013-08-07 21:41:30 +00004470 }
4471 }
4472 Stream.EmitRecord(LATE_PARSED_TEMPLATE, Record);
4473}
4474
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00004475/// Write the state of 'pragma clang optimize' at the end of the module.
Dario Domizioli13a0a382014-05-23 12:13:25 +00004476void ASTWriter::WriteOptimizePragmaOptions(Sema &SemaRef) {
4477 RecordData Record;
4478 SourceLocation PragmaLoc = SemaRef.getOptimizeOffPragmaLocation();
4479 AddSourceLocation(PragmaLoc, Record);
4480 Stream.EmitRecord(OPTIMIZE_PRAGMA_OPTIONS, Record);
4481}
4482
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00004483/// Write the state of 'pragma ms_struct' at the end of the module.
Nico Weber779355f2016-03-02 23:22:00 +00004484void ASTWriter::WriteMSStructPragmaOptions(Sema &SemaRef) {
4485 RecordData Record;
4486 Record.push_back(SemaRef.MSStructPragmaOn ? PMSST_ON : PMSST_OFF);
4487 Stream.EmitRecord(MSSTRUCT_PRAGMA_OPTIONS, Record);
4488}
4489
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00004490/// Write the state of 'pragma pointers_to_members' at the end of the
Nico Weber42932312016-03-03 00:17:35 +00004491//module.
4492void ASTWriter::WriteMSPointersToMembersPragmaOptions(Sema &SemaRef) {
4493 RecordData Record;
4494 Record.push_back(SemaRef.MSPointerToMemberRepresentationMethod);
4495 AddSourceLocation(SemaRef.ImplicitMSInheritanceAttrLoc, Record);
4496 Stream.EmitRecord(POINTERS_TO_MEMBERS_PRAGMA_OPTIONS, Record);
4497}
4498
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00004499/// Write the state of 'pragma pack' at the end of the module.
Alex Lorenz7d7e1e02017-03-31 15:36:21 +00004500void ASTWriter::WritePackPragmaOptions(Sema &SemaRef) {
Duncan P. N. Exon Smith03df14c2017-04-15 00:07:57 +00004501 // Don't serialize pragma pack state for modules, since it should only take
4502 // effect on a per-submodule basis.
4503 if (WritingModule)
4504 return;
4505
Alex Lorenz7d7e1e02017-03-31 15:36:21 +00004506 RecordData Record;
4507 Record.push_back(SemaRef.PackStack.CurrentValue);
4508 AddSourceLocation(SemaRef.PackStack.CurrentPragmaLocation, Record);
4509 Record.push_back(SemaRef.PackStack.Stack.size());
4510 for (const auto &StackEntry : SemaRef.PackStack.Stack) {
4511 Record.push_back(StackEntry.Value);
4512 AddSourceLocation(StackEntry.PragmaLocation, Record);
Alex Lorenz45b40142017-07-28 14:41:21 +00004513 AddSourceLocation(StackEntry.PragmaPushLocation, Record);
Alex Lorenz7d7e1e02017-03-31 15:36:21 +00004514 AddString(StackEntry.StackSlotLabel, Record);
4515 }
4516 Stream.EmitRecord(PACK_PRAGMA_OPTIONS, Record);
4517}
4518
Douglas Gregor8f64ca12015-12-08 22:43:32 +00004519void ASTWriter::WriteModuleFileExtension(Sema &SemaRef,
4520 ModuleFileExtensionWriter &Writer) {
Douglas Gregor6623e1f2015-11-03 18:33:07 +00004521 // Enter the extension block.
4522 Stream.EnterSubblock(EXTENSION_BLOCK_ID, 4);
4523
4524 // Emit the metadata record abbreviation.
David Blaikieb44f0bf2017-01-04 22:36:43 +00004525 auto Abv = std::make_shared<llvm::BitCodeAbbrev>();
Douglas Gregor6623e1f2015-11-03 18:33:07 +00004526 Abv->Add(llvm::BitCodeAbbrevOp(EXTENSION_METADATA));
4527 Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::VBR, 6));
4528 Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::VBR, 6));
4529 Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::VBR, 6));
4530 Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::VBR, 6));
4531 Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::Blob));
David Blaikieb44f0bf2017-01-04 22:36:43 +00004532 unsigned Abbrev = Stream.EmitAbbrev(std::move(Abv));
Douglas Gregor6623e1f2015-11-03 18:33:07 +00004533
4534 // Emit the metadata record.
4535 RecordData Record;
4536 auto Metadata = Writer.getExtension()->getExtensionMetadata();
4537 Record.push_back(EXTENSION_METADATA);
4538 Record.push_back(Metadata.MajorVersion);
4539 Record.push_back(Metadata.MinorVersion);
4540 Record.push_back(Metadata.BlockName.size());
4541 Record.push_back(Metadata.UserInfo.size());
4542 SmallString<64> Buffer;
4543 Buffer += Metadata.BlockName;
4544 Buffer += Metadata.UserInfo;
4545 Stream.EmitRecordWithBlob(Abbrev, Record, Buffer);
4546
4547 // Emit the contents of the extension block.
Douglas Gregor8f64ca12015-12-08 22:43:32 +00004548 Writer.writeExtensionContents(SemaRef, Stream);
Douglas Gregor6623e1f2015-11-03 18:33:07 +00004549
4550 // Exit the extension block.
4551 Stream.ExitBlock();
4552}
4553
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00004554//===----------------------------------------------------------------------===//
Douglas Gregorc5046832009-04-27 18:38:38 +00004555// General Serialization Routines
4556//===----------------------------------------------------------------------===//
4557
Richard Smithe43e2b32018-08-20 21:47:29 +00004558void ASTRecordWriter::AddAttr(const Attr *A) {
Reid Kleckner11f9f8a2018-08-14 01:55:37 +00004559 auto &Record = *this;
Richard Smithe43e2b32018-08-20 21:47:29 +00004560 if (!A)
4561 return Record.push_back(0);
4562 Record.push_back(A->getKind() + 1); // FIXME: stable encoding, target attrs
Erich Keane6a24e802019-09-13 17:39:31 +00004563
4564 Record.AddIdentifierRef(A->getAttrName());
4565 Record.AddIdentifierRef(A->getScopeName());
Richard Smithe43e2b32018-08-20 21:47:29 +00004566 Record.AddSourceRange(A->getRange());
Erich Keane6a24e802019-09-13 17:39:31 +00004567 Record.AddSourceLocation(A->getScopeLoc());
4568 Record.push_back(A->getParsedKind());
4569 Record.push_back(A->getSyntax());
4570 Record.push_back(A->getAttributeSpellingListIndexRaw());
Reid Kleckner11f9f8a2018-08-14 01:55:37 +00004571
4572#include "clang/Serialization/AttrPCHWrite.inc"
Richard Smithe43e2b32018-08-20 21:47:29 +00004573}
4574
4575/// Emit the list of attributes to the specified record.
4576void ASTRecordWriter::AddAttributes(ArrayRef<const Attr *> Attrs) {
4577 push_back(Attrs.size());
4578 for (const auto *A : Attrs)
4579 AddAttr(A);
Douglas Gregorbc8a78d52009-04-15 21:30:51 +00004580}
4581
John McCallf413f5e2013-05-03 00:10:13 +00004582void ASTWriter::AddToken(const Token &Tok, RecordDataImpl &Record) {
4583 AddSourceLocation(Tok.getLocation(), Record);
4584 Record.push_back(Tok.getLength());
4585
4586 // FIXME: When reading literal tokens, reconstruct the literal pointer
4587 // if it is needed.
4588 AddIdentifierRef(Tok.getIdentifierInfo(), Record);
4589 // FIXME: Should translate token kind to a stable encoding.
4590 Record.push_back(Tok.getKind());
4591 // FIXME: Should translate token flags to a stable encoding.
4592 Record.push_back(Tok.getFlags());
4593}
4594
Chris Lattner0e62c1c2011-07-23 10:55:15 +00004595void ASTWriter::AddString(StringRef Str, RecordDataImpl &Record) {
Douglas Gregorbc8a78d52009-04-15 21:30:51 +00004596 Record.push_back(Str.size());
4597 Record.insert(Record.end(), Str.begin(), Str.end());
4598}
4599
Richard Smith7ed1bc92014-12-05 22:42:13 +00004600bool ASTWriter::PreparePathForOutput(SmallVectorImpl<char> &Path) {
Richard Smith54cc3c22014-12-11 20:50:24 +00004601 assert(Context && "should have context when outputting path");
Richard Smith7ed1bc92014-12-05 22:42:13 +00004602
Richard Smith54cc3c22014-12-11 20:50:24 +00004603 bool Changed =
4604 cleanPathForOutput(Context->getSourceManager().getFileManager(), Path);
Richard Smith7ed1bc92014-12-05 22:42:13 +00004605
4606 // Remove a prefix to make the path relative, if relevant.
4607 const char *PathBegin = Path.data();
4608 const char *PathPtr =
4609 adjustFilenameForRelocatableAST(PathBegin, BaseDirectory);
4610 if (PathPtr != PathBegin) {
4611 Path.erase(Path.begin(), Path.begin() + (PathPtr - PathBegin));
4612 Changed = true;
4613 }
4614
4615 return Changed;
4616}
4617
4618void ASTWriter::AddPath(StringRef Path, RecordDataImpl &Record) {
4619 SmallString<128> FilePath(Path);
4620 PreparePathForOutput(FilePath);
4621 AddString(FilePath, Record);
4622}
4623
Mehdi Amini57a41912015-09-10 01:46:39 +00004624void ASTWriter::EmitRecordWithPath(unsigned Abbrev, RecordDataRef Record,
Richard Smith7ed1bc92014-12-05 22:42:13 +00004625 StringRef Path) {
4626 SmallString<128> FilePath(Path);
4627 PreparePathForOutput(FilePath);
4628 Stream.EmitRecordWithBlob(Abbrev, Record, FilePath);
4629}
4630
Douglas Gregor20b2ebd2011-03-23 00:50:03 +00004631void ASTWriter::AddVersionTuple(const VersionTuple &Version,
4632 RecordDataImpl &Record) {
4633 Record.push_back(Version.getMajor());
David Blaikie05785d12013-02-20 22:23:23 +00004634 if (Optional<unsigned> Minor = Version.getMinor())
Douglas Gregor20b2ebd2011-03-23 00:50:03 +00004635 Record.push_back(*Minor + 1);
4636 else
4637 Record.push_back(0);
David Blaikie05785d12013-02-20 22:23:23 +00004638 if (Optional<unsigned> Subminor = Version.getSubminor())
Douglas Gregor20b2ebd2011-03-23 00:50:03 +00004639 Record.push_back(*Subminor + 1);
4640 else
4641 Record.push_back(0);
4642}
4643
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00004644/// Note that the identifier II occurs at the given offset
Douglas Gregore84a9da2009-04-20 20:36:09 +00004645/// within the identifier table.
Sebastian Redl55c0ad52010-08-18 23:56:21 +00004646void ASTWriter::SetIdentifierOffset(const IdentifierInfo *II, uint32_t Offset) {
Sebastian Redl539c5062010-08-18 23:57:32 +00004647 IdentID ID = IdentifierIDs[II];
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00004648 // Only store offsets new to this AST file. Other identifier names are looked
Sebastian Redlff4a2952010-07-23 23:49:55 +00004649 // up earlier in the chain and thus don't need an offset.
4650 if (ID >= FirstIdentID)
4651 IdentifierOffsets[ID - FirstIdentID] = Offset;
Douglas Gregore84a9da2009-04-20 20:36:09 +00004652}
4653
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00004654/// Note that the selector Sel occurs at the given offset
Douglas Gregor95c13f52009-04-25 17:48:32 +00004655/// within the method pool/selector table.
Sebastian Redl55c0ad52010-08-18 23:56:21 +00004656void ASTWriter::SetSelectorOffset(Selector Sel, uint32_t Offset) {
Douglas Gregor95c13f52009-04-25 17:48:32 +00004657 unsigned ID = SelectorIDs[Sel];
4658 assert(ID && "Unknown selector");
Sebastian Redld95a56e2010-08-04 18:21:41 +00004659 // Don't record offsets for selectors that are also available in a different
4660 // file.
4661 if (ID < FirstSelectorID)
4662 return;
4663 SelectorOffsets[ID - FirstSelectorID] = Offset;
Douglas Gregor95c13f52009-04-25 17:48:32 +00004664}
4665
David Blaikie61137e12017-01-05 18:23:18 +00004666ASTWriter::ASTWriter(llvm::BitstreamWriter &Stream,
Duncan P. N. Exon Smith8bef5cd2019-03-09 17:33:56 +00004667 SmallVectorImpl<char> &Buffer,
4668 InMemoryModuleCache &ModuleCache,
David Blaikie61137e12017-01-05 18:23:18 +00004669 ArrayRef<std::shared_ptr<ModuleFileExtension>> Extensions,
4670 bool IncludeTimestamps)
Duncan P. N. Exon Smith8bef5cd2019-03-09 17:33:56 +00004671 : Stream(Stream), Buffer(Buffer), ModuleCache(ModuleCache),
Duncan P. N. Exon Smith030d7d62017-03-20 17:58:26 +00004672 IncludeTimestamps(IncludeTimestamps) {
Douglas Gregor6623e1f2015-11-03 18:33:07 +00004673 for (const auto &Ext : Extensions) {
4674 if (auto Writer = Ext->createExtensionWriter(*this))
4675 ModuleFileExtensionWriters.push_back(std::move(Writer));
4676 }
4677}
Douglas Gregoref84c4b2009-04-09 22:27:44 +00004678
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00004679ASTWriter::~ASTWriter() {
Reid Kleckner588c9372014-02-19 23:44:52 +00004680 llvm::DeleteContainerSeconds(FileDeclIDs);
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00004681}
4682
Richard Smithb3761912015-02-05 23:08:52 +00004683const LangOptions &ASTWriter::getLangOpts() const {
4684 assert(WritingAST && "can't determine lang opts when not writing AST");
4685 return Context->getLangOpts();
4686}
4687
Richard Smithe75ee0f2015-08-17 07:13:32 +00004688time_t ASTWriter::getTimestampForOutput(const FileEntry *E) const {
4689 return IncludeTimestamps ? E->getModificationTime() : 0;
4690}
4691
Duncan P. N. Exon Smith60fa2882017-03-13 18:45:08 +00004692ASTFileSignature ASTWriter::WriteAST(Sema &SemaRef,
4693 const std::string &OutputFile,
4694 Module *WritingModule, StringRef isysroot,
Duncan P. N. Exon Smith70d759b2019-03-12 18:38:04 +00004695 bool hasErrors,
4696 bool ShouldCacheASTInMemory) {
Douglas Gregor2fd3d402011-09-17 00:05:03 +00004697 WritingAST = true;
Adrian Prantladbd2b12015-09-22 23:26:31 +00004698
Argyrios Kyrtzidis4a280ff2012-03-07 01:51:17 +00004699 ASTHasCompilerErrors = hasErrors;
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00004700
Douglas Gregoref84c4b2009-04-09 22:27:44 +00004701 // Emit the file header.
Douglas Gregor8f45df52009-04-16 22:23:12 +00004702 Stream.Emit((unsigned)'C', 8);
4703 Stream.Emit((unsigned)'P', 8);
4704 Stream.Emit((unsigned)'C', 8);
4705 Stream.Emit((unsigned)'H', 8);
Mike Stump11289f42009-09-09 15:08:12 +00004706
Chris Lattner28fa4e62009-04-26 22:26:21 +00004707 WriteBlockInfoBlock();
Douglas Gregoref84c4b2009-04-09 22:27:44 +00004708
Douglas Gregoreda8e122011-08-09 15:13:55 +00004709 Context = &SemaRef.Context;
Douglas Gregora28bcdd2011-12-01 02:07:58 +00004710 PP = &SemaRef.PP;
Douglas Gregora89c5ac2011-12-06 01:10:29 +00004711 this->WritingModule = WritingModule;
Adrian Prantladbd2b12015-09-22 23:26:31 +00004712 ASTFileSignature Signature =
4713 WriteASTCore(SemaRef, isysroot, OutputFile, WritingModule);
Craig Toppera13603a2014-05-22 05:54:18 +00004714 Context = nullptr;
4715 PP = nullptr;
4716 this->WritingModule = nullptr;
Richard Smith7ed1bc92014-12-05 22:42:13 +00004717 this->BaseDirectory.clear();
Craig Toppera13603a2014-05-22 05:54:18 +00004718
Douglas Gregor2fd3d402011-09-17 00:05:03 +00004719 WritingAST = false;
Duncan P. N. Exon Smith70d759b2019-03-12 18:38:04 +00004720 if (ShouldCacheASTInMemory) {
Duncan P. N. Exon Smith030d7d62017-03-20 17:58:26 +00004721 // Construct MemoryBuffer and update buffer manager.
Duncan P. N. Exon Smith0a2be462019-03-09 17:44:01 +00004722 ModuleCache.addBuiltPCM(OutputFile,
4723 llvm::MemoryBuffer::getMemBufferCopy(
4724 StringRef(Buffer.begin(), Buffer.size())));
Duncan P. N. Exon Smith030d7d62017-03-20 17:58:26 +00004725 }
Adrian Prantladbd2b12015-09-22 23:26:31 +00004726 return Signature;
Sebastian Redl143413f2010-07-12 22:02:52 +00004727}
4728
Douglas Gregora94a1542011-07-27 21:45:57 +00004729template<typename Vector>
4730static void AddLazyVectorDecls(ASTWriter &Writer, Vector &Vec,
4731 ASTWriter::RecordData &Record) {
Craig Toppera13603a2014-05-22 05:54:18 +00004732 for (typename Vector::iterator I = Vec.begin(nullptr, true), E = Vec.end();
4733 I != E; ++I) {
Douglas Gregora94a1542011-07-27 21:45:57 +00004734 Writer.AddDeclRef(*I, Record);
4735 }
4736}
4737
Duncan P. N. Exon Smith60fa2882017-03-13 18:45:08 +00004738ASTFileSignature ASTWriter::WriteASTCore(Sema &SemaRef, StringRef isysroot,
4739 const std::string &OutputFile,
4740 Module *WritingModule) {
Sebastian Redl143413f2010-07-12 22:02:52 +00004741 using namespace llvm;
4742
Craig Toppera13603a2014-05-22 05:54:18 +00004743 bool isModule = WritingModule != nullptr;
Argyrios Kyrtzidisffb35582013-03-14 04:44:56 +00004744
Douglas Gregorcf68c582011-12-01 22:20:10 +00004745 // Make sure that the AST reader knows to finalize itself.
4746 if (Chain)
4747 Chain->finalizeForWriting();
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00004748
Sebastian Redl143413f2010-07-12 22:02:52 +00004749 ASTContext &Context = SemaRef.Context;
4750 Preprocessor &PP = SemaRef.PP;
4751
Douglas Gregordab42432011-08-12 00:15:20 +00004752 // Set up predefined declaration IDs.
Richard Smith5fc18a92015-07-12 23:43:21 +00004753 auto RegisterPredefDecl = [&] (Decl *D, PredefinedDeclIDs ID) {
4754 if (D) {
4755 assert(D->isCanonicalDecl() && "predefined decl is not canonical");
4756 DeclIDs[D] = ID;
Richard Smith5fc18a92015-07-12 23:43:21 +00004757 }
4758 };
4759 RegisterPredefDecl(Context.getTranslationUnitDecl(),
4760 PREDEF_DECL_TRANSLATION_UNIT_ID);
4761 RegisterPredefDecl(Context.ObjCIdDecl, PREDEF_DECL_OBJC_ID_ID);
4762 RegisterPredefDecl(Context.ObjCSelDecl, PREDEF_DECL_OBJC_SEL_ID);
4763 RegisterPredefDecl(Context.ObjCClassDecl, PREDEF_DECL_OBJC_CLASS_ID);
4764 RegisterPredefDecl(Context.ObjCProtocolClassDecl,
4765 PREDEF_DECL_OBJC_PROTOCOL_ID);
4766 RegisterPredefDecl(Context.Int128Decl, PREDEF_DECL_INT_128_ID);
4767 RegisterPredefDecl(Context.UInt128Decl, PREDEF_DECL_UNSIGNED_INT_128_ID);
4768 RegisterPredefDecl(Context.ObjCInstanceTypeDecl,
4769 PREDEF_DECL_OBJC_INSTANCETYPE_ID);
4770 RegisterPredefDecl(Context.BuiltinVaListDecl, PREDEF_DECL_BUILTIN_VA_LIST_ID);
Richard Smith9b88a4c2015-07-27 05:40:23 +00004771 RegisterPredefDecl(Context.VaListTagDecl, PREDEF_DECL_VA_LIST_TAG);
Charles Davisc7d5c942015-09-17 20:55:33 +00004772 RegisterPredefDecl(Context.BuiltinMSVaListDecl,
4773 PREDEF_DECL_BUILTIN_MS_VA_LIST_ID);
Richard Smith5fc18a92015-07-12 23:43:21 +00004774 RegisterPredefDecl(Context.ExternCContext, PREDEF_DECL_EXTERN_C_CONTEXT_ID);
David Majnemerd9b1a4f2015-11-04 03:40:30 +00004775 RegisterPredefDecl(Context.MakeIntegerSeqDecl,
4776 PREDEF_DECL_MAKE_INTEGER_SEQ_ID);
Quentin Colombet043406b2016-02-03 22:41:00 +00004777 RegisterPredefDecl(Context.CFConstantStringTypeDecl,
4778 PREDEF_DECL_CF_CONSTANT_STRING_ID);
Ben Langmuirf5416742016-02-04 00:55:24 +00004779 RegisterPredefDecl(Context.CFConstantStringTagDecl,
4780 PREDEF_DECL_CF_CONSTANT_STRING_TAG_ID);
Eric Fiselier6ad68552016-07-01 01:24:09 +00004781 RegisterPredefDecl(Context.TypePackElementDecl,
4782 PREDEF_DECL_TYPE_PACK_ELEMENT_ID);
Meador Inge5d3fb222012-06-16 03:34:49 +00004783
Chris Lattner0c797362009-09-08 18:19:27 +00004784 // Build a record containing all of the tentative definitions in this file, in
Sebastian Redl35351a92010-01-31 22:27:38 +00004785 // TentativeDefinitions order. Generally, this record will be empty for
Chris Lattner0c797362009-09-08 18:19:27 +00004786 // headers.
Douglas Gregord4df8652009-04-22 22:02:47 +00004787 RecordData TentativeDefinitions;
Douglas Gregora94a1542011-07-27 21:45:57 +00004788 AddLazyVectorDecls(*this, SemaRef.TentativeDefinitions, TentativeDefinitions);
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00004789
Argyrios Kyrtzidis35672e72010-08-13 18:42:17 +00004790 // Build a record containing all of the file scoped decls in this file.
4791 RecordData UnusedFileScopedDecls;
Argyrios Kyrtzidis59852362013-03-14 04:45:00 +00004792 if (!isModule)
4793 AddLazyVectorDecls(*this, SemaRef.UnusedFileScopedDecls,
4794 UnusedFileScopedDecls);
Sebastian Redl08aca90252010-08-05 18:21:25 +00004795
Douglas Gregor851443c2011-08-12 01:39:19 +00004796 // Build a record containing all of the delegating constructors we still need
4797 // to resolve.
Alexis Hunt27a761d2011-05-04 23:29:54 +00004798 RecordData DelegatingCtorDecls;
Argyrios Kyrtzidisffb35582013-03-14 04:44:56 +00004799 if (!isModule)
4800 AddLazyVectorDecls(*this, SemaRef.DelegatingCtorDecls, DelegatingCtorDecls);
Alexis Hunt27a761d2011-05-04 23:29:54 +00004801
Douglas Gregor851443c2011-08-12 01:39:19 +00004802 // Write the set of weak, undeclared identifiers. We always write the
4803 // entire table, since later PCH files in a PCH chain are only interested in
4804 // the results at the end of the chain.
Argyrios Kyrtzidisee1afa32010-08-05 09:48:08 +00004805 RecordData WeakUndeclaredIdentifiers;
Chandler Carruthf85d9822015-03-26 08:32:49 +00004806 for (auto &WeakUndeclaredIdentifier : SemaRef.WeakUndeclaredIdentifiers) {
4807 IdentifierInfo *II = WeakUndeclaredIdentifier.first;
4808 WeakInfo &WI = WeakUndeclaredIdentifier.second;
4809 AddIdentifierRef(II, WeakUndeclaredIdentifiers);
4810 AddIdentifierRef(WI.getAlias(), WeakUndeclaredIdentifiers);
4811 AddSourceLocation(WI.getLocation(), WeakUndeclaredIdentifiers);
4812 WeakUndeclaredIdentifiers.push_back(WI.getUsed());
Argyrios Kyrtzidisee1afa32010-08-05 09:48:08 +00004813 }
Kovarththanan Rajaratnama9c81a82010-03-14 07:06:50 +00004814
Douglas Gregor61cac2b2009-04-27 20:06:05 +00004815 // Build a record containing all of the ext_vector declarations.
4816 RecordData ExtVectorDecls;
Douglas Gregorb7098a32011-07-28 00:39:29 +00004817 AddLazyVectorDecls(*this, SemaRef.ExtVectorDecls, ExtVectorDecls);
Douglas Gregor61cac2b2009-04-27 20:06:05 +00004818
Argyrios Kyrtzidisaf2eac22010-07-06 15:37:04 +00004819 // Build a record containing all of the VTable uses information.
4820 RecordData VTableUses;
Argyrios Kyrtzidisedee67f2010-08-03 17:29:52 +00004821 if (!SemaRef.VTableUses.empty()) {
Argyrios Kyrtzidisedee67f2010-08-03 17:29:52 +00004822 for (unsigned I = 0, N = SemaRef.VTableUses.size(); I != N; ++I) {
4823 AddDeclRef(SemaRef.VTableUses[I].first, VTableUses);
4824 AddSourceLocation(SemaRef.VTableUses[I].second, VTableUses);
4825 VTableUses.push_back(SemaRef.VTablesUsed[SemaRef.VTableUses[I].first]);
4826 }
Argyrios Kyrtzidisaf2eac22010-07-06 15:37:04 +00004827 }
4828
Nico Weber72889432014-09-06 01:25:55 +00004829 // Build a record containing all of the UnusedLocalTypedefNameCandidates.
4830 RecordData UnusedLocalTypedefNameCandidates;
4831 for (const TypedefNameDecl *TD : SemaRef.UnusedLocalTypedefNameCandidates)
4832 AddDeclRef(TD, UnusedLocalTypedefNameCandidates);
4833
Argyrios Kyrtzidis7f76d112010-08-05 09:48:16 +00004834 // Build a record containing all of pending implicit instantiations.
Chandler Carruth54080172010-08-25 08:44:16 +00004835 RecordData PendingInstantiations;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00004836 for (const auto &I : SemaRef.PendingInstantiations) {
4837 AddDeclRef(I.first, PendingInstantiations);
4838 AddSourceLocation(I.second, PendingInstantiations);
Argyrios Kyrtzidis7f76d112010-08-05 09:48:16 +00004839 }
4840 assert(SemaRef.PendingLocalImplicitInstantiations.empty() &&
4841 "There are local ones at end of translation unit!");
4842
Argyrios Kyrtzidis2d688102010-08-02 07:14:54 +00004843 // Build a record containing some declaration references.
4844 RecordData SemaDeclRefs;
Richard Smith96269c52016-09-29 22:49:46 +00004845 if (SemaRef.StdNamespace || SemaRef.StdBadAlloc || SemaRef.StdAlignValT) {
Argyrios Kyrtzidis2d688102010-08-02 07:14:54 +00004846 AddDeclRef(SemaRef.getStdNamespace(), SemaDeclRefs);
4847 AddDeclRef(SemaRef.getStdBadAlloc(), SemaDeclRefs);
Richard Smith96269c52016-09-29 22:49:46 +00004848 AddDeclRef(SemaRef.getStdAlignValT(), SemaDeclRefs);
Argyrios Kyrtzidis2d688102010-08-02 07:14:54 +00004849 }
4850
Peter Collingbourne9e2c81f2011-02-09 21:04:32 +00004851 RecordData CUDASpecialDeclRefs;
4852 if (Context.getcudaConfigureCallDecl()) {
4853 AddDeclRef(Context.getcudaConfigureCallDecl(), CUDASpecialDeclRefs);
4854 }
4855
Douglas Gregorc2fa1692011-06-28 16:20:02 +00004856 // Build a record containing all of the known namespaces.
4857 RecordData KnownNamespaces;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00004858 for (const auto &I : SemaRef.KnownNamespaces) {
4859 if (!I.second)
4860 AddDeclRef(I.first, KnownNamespaces);
Douglas Gregorc2fa1692011-06-28 16:20:02 +00004861 }
Douglas Gregor112b9072012-10-18 05:31:06 +00004862
Nick Lewycky9c7eb1d2013-02-01 08:13:20 +00004863 // Build a record of all used, undefined objects that require definitions.
4864 RecordData UndefinedButUsed;
Nick Lewyckyf0f56162013-01-31 03:23:57 +00004865
4866 SmallVector<std::pair<NamedDecl *, SourceLocation>, 16> Undefined;
Nick Lewycky9c7eb1d2013-02-01 08:13:20 +00004867 SemaRef.getUndefinedButUsed(Undefined);
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00004868 for (const auto &I : Undefined) {
4869 AddDeclRef(I.first, UndefinedButUsed);
4870 AddSourceLocation(I.second, UndefinedButUsed);
Nick Lewycky8334af82013-01-26 00:35:08 +00004871 }
4872
Ismail Pazarbasie5768d12015-05-18 19:59:11 +00004873 // Build a record containing all delete-expressions that we would like to
4874 // analyze later in AST.
4875 RecordData DeleteExprsToAnalyze;
4876
Richard Smithf5262c62018-06-28 01:57:04 +00004877 if (!isModule) {
4878 for (const auto &DeleteExprsInfo :
4879 SemaRef.getMismatchingDeleteExpressions()) {
4880 AddDeclRef(DeleteExprsInfo.first, DeleteExprsToAnalyze);
4881 DeleteExprsToAnalyze.push_back(DeleteExprsInfo.second.size());
4882 for (const auto &DeleteLoc : DeleteExprsInfo.second) {
4883 AddSourceLocation(DeleteLoc.first, DeleteExprsToAnalyze);
4884 DeleteExprsToAnalyze.push_back(DeleteLoc.second);
4885 }
Ismail Pazarbasie5768d12015-05-18 19:59:11 +00004886 }
4887 }
4888
Douglas Gregor112b9072012-10-18 05:31:06 +00004889 // Write the control block
Duncan P. N. Exon Smith60fa2882017-03-13 18:45:08 +00004890 WriteControlBlock(PP, Context, isysroot, OutputFile);
Douglas Gregor112b9072012-10-18 05:31:06 +00004891
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00004892 // Write the remaining AST contents.
Sebastian Redl539c5062010-08-18 23:57:32 +00004893 Stream.EnterSubblock(AST_BLOCK_ID, 5);
Douglas Gregor851443c2011-08-12 01:39:19 +00004894
Argyrios Kyrtzidis39605402012-12-13 21:38:23 +00004895 // This is so that older clang versions, before the introduction
4896 // of the control block, can read and reject the newer PCH format.
Mehdi Amini57a41912015-09-10 01:46:39 +00004897 {
4898 RecordData Record = {VERSION_MAJOR};
4899 Stream.EmitRecord(METADATA_OLD_FORMAT, Record);
4900 }
Argyrios Kyrtzidis39605402012-12-13 21:38:23 +00004901
Douglas Gregor851443c2011-08-12 01:39:19 +00004902 // Create a lexical update block containing all of the declarations in the
4903 // translation unit that do not come from other AST files.
4904 const TranslationUnitDecl *TU = Context.getTranslationUnitDecl();
Richard Smith82f8fcd2015-08-06 22:07:25 +00004905 SmallVector<uint32_t, 128> NewGlobalKindDeclPairs;
4906 for (const auto *D : TU->noload_decls()) {
4907 if (!D->isFromASTFile()) {
4908 NewGlobalKindDeclPairs.push_back(D->getKind());
4909 NewGlobalKindDeclPairs.push_back(GetDeclRef(D));
4910 }
Douglas Gregor851443c2011-08-12 01:39:19 +00004911 }
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00004912
David Blaikieb44f0bf2017-01-04 22:36:43 +00004913 auto Abv = std::make_shared<BitCodeAbbrev>();
Douglas Gregor851443c2011-08-12 01:39:19 +00004914 Abv->Add(llvm::BitCodeAbbrevOp(TU_UPDATE_LEXICAL));
4915 Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::Blob));
David Blaikieb44f0bf2017-01-04 22:36:43 +00004916 unsigned TuUpdateLexicalAbbrev = Stream.EmitAbbrev(std::move(Abv));
Mehdi Amini57a41912015-09-10 01:46:39 +00004917 {
4918 RecordData::value_type Record[] = {TU_UPDATE_LEXICAL};
4919 Stream.EmitRecordWithBlob(TuUpdateLexicalAbbrev, Record,
4920 bytes(NewGlobalKindDeclPairs));
4921 }
4922
Douglas Gregor851443c2011-08-12 01:39:19 +00004923 // And a visible updates block for the translation unit.
David Blaikieb44f0bf2017-01-04 22:36:43 +00004924 Abv = std::make_shared<BitCodeAbbrev>();
Douglas Gregor851443c2011-08-12 01:39:19 +00004925 Abv->Add(llvm::BitCodeAbbrevOp(UPDATE_VISIBLE));
4926 Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::VBR, 6));
Douglas Gregor851443c2011-08-12 01:39:19 +00004927 Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::Blob));
David Blaikieb44f0bf2017-01-04 22:36:43 +00004928 UpdateVisibleAbbrev = Stream.EmitAbbrev(std::move(Abv));
Douglas Gregor851443c2011-08-12 01:39:19 +00004929 WriteDeclContextVisibleUpdate(TU);
Richard Smithf19e1272015-03-07 00:04:49 +00004930
4931 // If we have any extern "C" names, write out a visible update for them.
4932 if (Context.ExternCContext)
4933 WriteDeclContextVisibleUpdate(Context.ExternCContext);
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00004934
Douglas Gregor851443c2011-08-12 01:39:19 +00004935 // If the translation unit has an anonymous namespace, and we don't already
4936 // have an update block for it, write it as an update block.
Richard Smith6ef42932014-03-20 21:02:00 +00004937 // FIXME: Why do we not do this if there's already an update block?
Douglas Gregor851443c2011-08-12 01:39:19 +00004938 if (NamespaceDecl *NS = TU->getAnonymousNamespace()) {
4939 ASTWriter::UpdateRecord &Record = DeclUpdates[TU];
Richard Smith6ef42932014-03-20 21:02:00 +00004940 if (Record.empty())
Aaron Ballman4f45b712014-03-21 15:22:56 +00004941 Record.push_back(DeclUpdate(UPD_CXX_ADDED_ANONYMOUS_NAMESPACE, NS));
Douglas Gregor851443c2011-08-12 01:39:19 +00004942 }
Argyrios Kyrtzidis442dd802012-07-02 19:19:01 +00004943
Richard Smith5652c0f2014-03-21 01:48:23 +00004944 // Add update records for all mangling numbers and static local numbers.
4945 // These aren't really update records, but this is a convenient way of
4946 // tagging this rare extra data onto the declarations.
4947 for (const auto &Number : Context.MangleNumbers)
4948 if (!Number.first->isFromASTFile())
Aaron Ballman4f45b712014-03-21 15:22:56 +00004949 DeclUpdates[Number.first].push_back(DeclUpdate(UPD_MANGLING_NUMBER,
4950 Number.second));
Richard Smith5652c0f2014-03-21 01:48:23 +00004951 for (const auto &Number : Context.StaticLocalNumbers)
4952 if (!Number.first->isFromASTFile())
Aaron Ballman4f45b712014-03-21 15:22:56 +00004953 DeclUpdates[Number.first].push_back(DeclUpdate(UPD_STATIC_LOCAL_NUMBER,
4954 Number.second));
Richard Smith5652c0f2014-03-21 01:48:23 +00004955
Argyrios Kyrtzidis442dd802012-07-02 19:19:01 +00004956 // Make sure visible decls, added to DeclContexts previously loaded from
Richard Smithc26d9742016-10-06 20:30:51 +00004957 // an AST file, are registered for serialization. Likewise for template
4958 // specializations added to imported templates.
4959 for (const auto *I : DeclsToEmitEvenIfUnreferenced) {
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00004960 GetDeclRef(I);
Argyrios Kyrtzidis442dd802012-07-02 19:19:01 +00004961 }
4962
Argyrios Kyrtzidisacfbbd72013-08-07 21:17:33 +00004963 // Make sure all decls associated with an identifier are registered for
Richard Smith79bf9202015-08-24 03:33:22 +00004964 // serialization, if we're storing decls with identifiers.
4965 if (!WritingModule || !getLangOpts().CPlusPlus) {
4966 llvm::SmallVector<const IdentifierInfo*, 256> IIs;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00004967 for (const auto &ID : PP.getIdentifierTable()) {
4968 const IdentifierInfo *II = ID.second;
Richard Smith79bf9202015-08-24 03:33:22 +00004969 if (!Chain || !II->isFromAST() || II->hasChangedSinceDeserialization())
4970 IIs.push_back(II);
4971 }
4972 // Sort the identifiers to visit based on their name.
Benjamin Kramercd2bae32019-08-22 17:32:16 +00004973 llvm::sort(IIs, llvm::deref<std::less<>>());
Richard Smith79bf9202015-08-24 03:33:22 +00004974 for (const IdentifierInfo *II : IIs) {
4975 for (IdentifierResolver::iterator D = SemaRef.IdResolver.begin(II),
4976 DEnd = SemaRef.IdResolver.end();
4977 D != DEnd; ++D) {
4978 GetDeclRef(*D);
4979 }
Argyrios Kyrtzidisacfbbd72013-08-07 21:17:33 +00004980 }
4981 }
4982
Manman Rena0f31a02016-04-29 19:04:05 +00004983 // For method pool in the module, if it contains an entry for a selector,
4984 // the entry should be complete, containing everything introduced by that
4985 // module and all modules it imports. It's possible that the entry is out of
4986 // date, so we need to pull in the new content here.
4987
4988 // It's possible that updateOutOfDateSelector can update SelectorIDs. To be
4989 // safe, we copy all selectors out.
4990 llvm::SmallVector<Selector, 256> AllSelectors;
4991 for (auto &SelectorAndID : SelectorIDs)
4992 AllSelectors.push_back(SelectorAndID.first);
4993 for (auto &Selector : AllSelectors)
4994 SemaRef.updateOutOfDateSelector(Selector);
4995
Douglas Gregor5204bde2011-08-02 16:26:37 +00004996 // Form the record of special types.
4997 RecordData SpecialTypes;
Douglas Gregor5204bde2011-08-02 16:26:37 +00004998 AddTypeRef(Context.getRawCFConstantStringType(), SpecialTypes);
Douglas Gregor5204bde2011-08-02 16:26:37 +00004999 AddTypeRef(Context.getFILEType(), SpecialTypes);
5000 AddTypeRef(Context.getjmp_bufType(), SpecialTypes);
5001 AddTypeRef(Context.getsigjmp_bufType(), SpecialTypes);
5002 AddTypeRef(Context.ObjCIdRedefinitionType, SpecialTypes);
5003 AddTypeRef(Context.ObjCClassRedefinitionType, SpecialTypes);
Douglas Gregor5204bde2011-08-02 16:26:37 +00005004 AddTypeRef(Context.ObjCSelRedefinitionType, SpecialTypes);
Rafael Espindola6cfa82b2011-11-13 21:51:09 +00005005 AddTypeRef(Context.getucontext_tType(), SpecialTypes);
Douglas Gregora28bcdd2011-12-01 02:07:58 +00005006
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005007 if (Chain) {
5008 // Write the mapping information describing our module dependencies and how
5009 // each of those modules were mapped into our own offset/ID space, so that
5010 // the reader can build the appropriate mapping to its own offset/ID space.
5011 // The map consists solely of a blob with the following format:
Boris Kolpackovd30446f2017-08-31 06:26:43 +00005012 // *(module-kind:i8
5013 // module-name-len:i16 module-name:len*i8
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005014 // source-location-offset:i32
5015 // identifier-id:i32
5016 // preprocessed-entity-id:i32
5017 // macro-definition-id:i32
Douglas Gregor253eefe2011-12-01 00:59:36 +00005018 // submodule-id:i32
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005019 // selector-id:i32
5020 // declaration-id:i32
5021 // c++-base-specifiers-id:i32
5022 // type-id:i32)
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00005023 //
Boris Kolpackovd30446f2017-08-31 06:26:43 +00005024 // module-kind is the ModuleKind enum value. If it is MK_PrebuiltModule or
5025 // MK_ExplicitModule, then the module-name is the module name. Otherwise,
5026 // it is the module file name.
David Blaikieb44f0bf2017-01-04 22:36:43 +00005027 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005028 Abbrev->Add(BitCodeAbbrevOp(MODULE_OFFSET_MAP));
5029 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
David Blaikieb44f0bf2017-01-04 22:36:43 +00005030 unsigned ModuleOffsetMapAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00005031 SmallString<2048> Buffer;
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005032 {
5033 llvm::raw_svector_ostream Out(Buffer);
Duncan P. N. Exon Smith96a06e02017-01-28 22:15:22 +00005034 for (ModuleFile &M : Chain->ModuleMgr) {
Justin Bognere1c147c2014-03-28 22:03:19 +00005035 using namespace llvm::support;
Eugene Zelenkob7d89102017-11-11 00:08:50 +00005036
Peter Collingbournee3f65292018-05-18 19:46:24 +00005037 endian::Writer LE(Out, little);
Boris Kolpackovd30446f2017-08-31 06:26:43 +00005038 LE.write<uint8_t>(static_cast<uint8_t>(M.Kind));
5039 StringRef Name =
5040 M.Kind == MK_PrebuiltModule || M.Kind == MK_ExplicitModule
5041 ? M.ModuleName
5042 : M.FileName;
5043 LE.write<uint16_t>(Name.size());
5044 Out.write(Name.data(), Name.size());
Ben Langmuirfe971d92014-08-16 04:54:18 +00005045
Ben Langmuir785180e2014-10-20 16:27:30 +00005046 // Note: if a base ID was uint max, it would not be possible to load
5047 // another module after it or have more than one entity inside it.
5048 uint32_t None = std::numeric_limits<uint32_t>::max();
5049
5050 auto writeBaseIDOrNone = [&](uint32_t BaseID, bool ShouldWrite) {
5051 assert(BaseID < std::numeric_limits<uint32_t>::max() && "base id too high");
5052 if (ShouldWrite)
5053 LE.write<uint32_t>(BaseID);
5054 else
5055 LE.write<uint32_t>(None);
5056 };
5057
Ben Langmuirfe971d92014-08-16 04:54:18 +00005058 // These values should be unique within a chain, since they will be read
5059 // as keys into ContinuousRangeMaps.
Duncan P. N. Exon Smith96a06e02017-01-28 22:15:22 +00005060 writeBaseIDOrNone(M.SLocEntryBaseOffset, M.LocalNumSLocEntries);
5061 writeBaseIDOrNone(M.BaseIdentifierID, M.LocalNumIdentifiers);
5062 writeBaseIDOrNone(M.BaseMacroID, M.LocalNumMacros);
5063 writeBaseIDOrNone(M.BasePreprocessedEntityID,
5064 M.NumPreprocessedEntities);
5065 writeBaseIDOrNone(M.BaseSubmoduleID, M.LocalNumSubmodules);
5066 writeBaseIDOrNone(M.BaseSelectorID, M.LocalNumSelectors);
5067 writeBaseIDOrNone(M.BaseDeclID, M.LocalNumDecls);
5068 writeBaseIDOrNone(M.BaseTypeIndex, M.LocalNumTypes);
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005069 }
5070 }
Mehdi Amini57a41912015-09-10 01:46:39 +00005071 RecordData::value_type Record[] = {MODULE_OFFSET_MAP};
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005072 Stream.EmitRecordWithBlob(ModuleOffsetMapAbbrev, Record,
5073 Buffer.data(), Buffer.size());
5074 }
Richard Smithb9eab6d2014-03-20 19:44:17 +00005075
Richard Smithb9eab6d2014-03-20 19:44:17 +00005076 RecordData DeclUpdatesOffsetsRecord;
5077
Richard Smith59442b42014-03-20 20:07:19 +00005078 // Keep writing types, declarations, and declaration update records
5079 // until we've emitted all of them.
Richard Smith01b2cb42014-07-26 06:37:51 +00005080 Stream.EnterSubblock(DECLTYPES_BLOCK_ID, /*bits for abbreviations*/5);
5081 WriteTypeAbbrevs();
5082 WriteDeclAbbrevs();
Richard Smith59442b42014-03-20 20:07:19 +00005083 do {
5084 WriteDeclUpdatesBlocks(DeclUpdatesOffsetsRecord);
5085 while (!DeclTypesToEmit.empty()) {
5086 DeclOrType DOT = DeclTypesToEmit.front();
5087 DeclTypesToEmit.pop();
5088 if (DOT.isType())
5089 WriteType(DOT.getType());
5090 else
5091 WriteDecl(Context, DOT.getDecl());
5092 }
5093 } while (!DeclUpdates.empty());
Richard Smithb9eab6d2014-03-20 19:44:17 +00005094 Stream.ExitBlock();
5095
Richard Smithb9eab6d2014-03-20 19:44:17 +00005096 DoneWritingDeclsAndTypes = true;
5097
5098 // These things can only be done once we've written out decls and types.
5099 WriteTypeDeclOffsets();
Richard Smith5652c0f2014-03-21 01:48:23 +00005100 if (!DeclUpdatesOffsetsRecord.empty())
5101 Stream.EmitRecord(DECL_UPDATE_OFFSETS, DeclUpdatesOffsetsRecord);
Richard Smithb9eab6d2014-03-20 19:44:17 +00005102 WriteFileDeclIDsMap();
Richard Smith7ed1bc92014-12-05 22:42:13 +00005103 WriteSourceManagerBlock(Context.getSourceManager(), PP);
Richard Smithb9eab6d2014-03-20 19:44:17 +00005104 WriteComments();
Argyrios Kyrtzidisffb35582013-03-14 04:44:56 +00005105 WritePreprocessor(PP, isModule);
Richard Smith7ed1bc92014-12-05 22:42:13 +00005106 WriteHeaderSearch(PP.getHeaderSearchInfo());
Sebastian Redla19a67f2010-08-03 21:58:15 +00005107 WriteSelectors(SemaRef);
Fariborz Jahanianc51609a2010-07-23 19:11:11 +00005108 WriteReferencedSelectorsPool(SemaRef);
Richard Smith9c254182015-07-19 21:41:12 +00005109 WriteLateParsedTemplates(SemaRef);
Argyrios Kyrtzidisffb35582013-03-14 04:44:56 +00005110 WriteIdentifierTable(PP, SemaRef.IdResolver, isModule);
Peter Collingbourne5df20e02011-02-15 19:46:30 +00005111 WriteFPPragmaOptions(SemaRef.getFPOptions());
5112 WriteOpenCLExtensions(SemaRef);
Yaxun Liu5b746652016-12-18 05:18:55 +00005113 WriteOpenCLExtensionTypes(SemaRef);
Justin Lebar67a78a62016-10-08 22:15:58 +00005114 WriteCUDAPragmas(SemaRef);
Douglas Gregor652d82a2009-04-18 05:55:16 +00005115
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00005116 // If we're emitting a module, write out the submodule information.
Douglas Gregora89c5ac2011-12-06 01:10:29 +00005117 if (WritingModule)
5118 WriteSubmodules(WritingModule);
5119
Andrew Savonichev52d674d2018-10-29 11:14:01 +00005120 // We need to have information about submodules to correctly deserialize
5121 // decls from OpenCLExtensionDecls block
5122 WriteOpenCLExtensionDecls(SemaRef);
5123
Douglas Gregor5204bde2011-08-02 16:26:37 +00005124 Stream.EmitRecord(SPECIAL_TYPES, SpecialTypes);
5125
Douglas Gregord4df8652009-04-22 22:02:47 +00005126 // Write the record containing external, unnamed definitions.
Ben Langmuir332aafe2014-01-31 01:06:56 +00005127 if (!EagerlyDeserializedDecls.empty())
5128 Stream.EmitRecord(EAGERLY_DESERIALIZED_DECLS, EagerlyDeserializedDecls);
Douglas Gregord4df8652009-04-22 22:02:47 +00005129
David Blaikief63556d2017-04-12 20:58:33 +00005130 if (!ModularCodegenDecls.empty())
David Blaikie9ffe5a32017-01-30 05:00:26 +00005131 Stream.EmitRecord(MODULAR_CODEGEN_DECLS, ModularCodegenDecls);
5132
Douglas Gregord4df8652009-04-22 22:02:47 +00005133 // Write the record containing tentative definitions.
5134 if (!TentativeDefinitions.empty())
Sebastian Redl539c5062010-08-18 23:57:32 +00005135 Stream.EmitRecord(TENTATIVE_DEFINITIONS, TentativeDefinitions);
Douglas Gregoracfc76c2009-04-22 22:18:58 +00005136
Argyrios Kyrtzidis35672e72010-08-13 18:42:17 +00005137 // Write the record containing unused file scoped decls.
5138 if (!UnusedFileScopedDecls.empty())
Sebastian Redl539c5062010-08-18 23:57:32 +00005139 Stream.EmitRecord(UNUSED_FILESCOPED_DECLS, UnusedFileScopedDecls);
Kovarththanan Rajaratnama9c81a82010-03-14 07:06:50 +00005140
Argyrios Kyrtzidisee1afa32010-08-05 09:48:08 +00005141 // Write the record containing weak undeclared identifiers.
5142 if (!WeakUndeclaredIdentifiers.empty())
Sebastian Redl539c5062010-08-18 23:57:32 +00005143 Stream.EmitRecord(WEAK_UNDECLARED_IDENTIFIERS,
Argyrios Kyrtzidisee1afa32010-08-05 09:48:08 +00005144 WeakUndeclaredIdentifiers);
5145
Douglas Gregor61cac2b2009-04-27 20:06:05 +00005146 // Write the record containing ext_vector type names.
5147 if (!ExtVectorDecls.empty())
Sebastian Redl539c5062010-08-18 23:57:32 +00005148 Stream.EmitRecord(EXT_VECTOR_DECLS, ExtVectorDecls);
Mike Stump11289f42009-09-09 15:08:12 +00005149
Argyrios Kyrtzidisaf2eac22010-07-06 15:37:04 +00005150 // Write the record containing VTable uses information.
5151 if (!VTableUses.empty())
Sebastian Redl539c5062010-08-18 23:57:32 +00005152 Stream.EmitRecord(VTABLE_USES, VTableUses);
Argyrios Kyrtzidisaf2eac22010-07-06 15:37:04 +00005153
Nico Weber72889432014-09-06 01:25:55 +00005154 // Write the record containing potentially unused local typedefs.
5155 if (!UnusedLocalTypedefNameCandidates.empty())
5156 Stream.EmitRecord(UNUSED_LOCAL_TYPEDEF_NAME_CANDIDATES,
5157 UnusedLocalTypedefNameCandidates);
5158
Argyrios Kyrtzidis7f76d112010-08-05 09:48:16 +00005159 // Write the record containing pending implicit instantiations.
Chandler Carruth54080172010-08-25 08:44:16 +00005160 if (!PendingInstantiations.empty())
5161 Stream.EmitRecord(PENDING_IMPLICIT_INSTANTIATIONS, PendingInstantiations);
Argyrios Kyrtzidis7f76d112010-08-05 09:48:16 +00005162
Argyrios Kyrtzidis2d688102010-08-02 07:14:54 +00005163 // Write the record containing declaration references of Sema.
5164 if (!SemaDeclRefs.empty())
Sebastian Redl539c5062010-08-18 23:57:32 +00005165 Stream.EmitRecord(SEMA_DECL_REFS, SemaDeclRefs);
Argyrios Kyrtzidis2d688102010-08-02 07:14:54 +00005166
Peter Collingbourne9e2c81f2011-02-09 21:04:32 +00005167 // Write the record containing CUDA-specific declaration references.
5168 if (!CUDASpecialDeclRefs.empty())
5169 Stream.EmitRecord(CUDA_SPECIAL_DECL_REFS, CUDASpecialDeclRefs);
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00005170
Alexis Hunt27a761d2011-05-04 23:29:54 +00005171 // Write the delegating constructors.
5172 if (!DelegatingCtorDecls.empty())
5173 Stream.EmitRecord(DELEGATING_CTORS, DelegatingCtorDecls);
Peter Collingbourne9e2c81f2011-02-09 21:04:32 +00005174
Douglas Gregorc2fa1692011-06-28 16:20:02 +00005175 // Write the known namespaces.
5176 if (!KnownNamespaces.empty())
5177 Stream.EmitRecord(KNOWN_NAMESPACES, KnownNamespaces);
Nick Lewycky8334af82013-01-26 00:35:08 +00005178
Nick Lewycky9c7eb1d2013-02-01 08:13:20 +00005179 // Write the undefined internal functions and variables, and inline functions.
5180 if (!UndefinedButUsed.empty())
5181 Stream.EmitRecord(UNDEFINED_BUT_USED, UndefinedButUsed);
Ismail Pazarbasie5768d12015-05-18 19:59:11 +00005182
5183 if (!DeleteExprsToAnalyze.empty())
5184 Stream.EmitRecord(DELETE_EXPRS_TO_ANALYZE, DeleteExprsToAnalyze);
5185
Douglas Gregor851443c2011-08-12 01:39:19 +00005186 // Write the visible updates to DeclContexts.
Richard Smithcd45dbc2014-04-19 03:48:30 +00005187 for (auto *DC : UpdatedDeclContexts)
5188 WriteDeclContextVisibleUpdate(DC);
Douglas Gregor851443c2011-08-12 01:39:19 +00005189
Douglas Gregor959bb062011-12-03 01:15:29 +00005190 if (!WritingModule) {
5191 // Write the submodules that were imported, if any.
Aaron Ballman4f45b712014-03-21 15:22:56 +00005192 struct ModuleInfo {
5193 uint64_t ID;
5194 Module *M;
5195 ModuleInfo(uint64_t ID, Module *M) : ID(ID), M(M) {}
5196 };
Richard Smith56be7542014-03-21 00:33:59 +00005197 llvm::SmallVector<ModuleInfo, 64> Imports;
Aaron Ballmanbbc31212014-03-14 20:59:21 +00005198 for (const auto *I : Context.local_imports()) {
Douglas Gregor959bb062011-12-03 01:15:29 +00005199 assert(SubmoduleIDs.find(I->getImportedModule()) != SubmoduleIDs.end());
Aaron Ballman4f45b712014-03-21 15:22:56 +00005200 Imports.push_back(ModuleInfo(SubmoduleIDs[I->getImportedModule()],
5201 I->getImportedModule()));
Douglas Gregor959bb062011-12-03 01:15:29 +00005202 }
Richard Smith56be7542014-03-21 00:33:59 +00005203
5204 if (!Imports.empty()) {
5205 auto Cmp = [](const ModuleInfo &A, const ModuleInfo &B) {
5206 return A.ID < B.ID;
5207 };
Ben Langmuir5f95c8f2014-09-08 20:36:26 +00005208 auto Eq = [](const ModuleInfo &A, const ModuleInfo &B) {
5209 return A.ID == B.ID;
5210 };
Richard Smith56be7542014-03-21 00:33:59 +00005211
5212 // Sort and deduplicate module IDs.
Fangrui Song55fab262018-09-26 22:16:28 +00005213 llvm::sort(Imports, Cmp);
Ben Langmuir5f95c8f2014-09-08 20:36:26 +00005214 Imports.erase(std::unique(Imports.begin(), Imports.end(), Eq),
Richard Smith56be7542014-03-21 00:33:59 +00005215 Imports.end());
5216
5217 RecordData ImportedModules;
5218 for (const auto &Import : Imports) {
5219 ImportedModules.push_back(Import.ID);
5220 // FIXME: If the module has macros imported then later has declarations
5221 // imported, this location won't be the right one as a location for the
5222 // declaration imports.
Richard Smith10434f32015-05-02 02:08:26 +00005223 AddSourceLocation(PP.getModuleImportLoc(Import.M), ImportedModules);
Richard Smith56be7542014-03-21 00:33:59 +00005224 }
5225
Douglas Gregor959bb062011-12-03 01:15:29 +00005226 Stream.EmitRecord(IMPORTED_MODULES, ImportedModules);
5227 }
Douglas Gregor0a839132011-12-03 00:59:55 +00005228 }
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00005229
Douglas Gregor404cdde2012-01-27 01:47:08 +00005230 WriteObjCCategories();
Nico Weber779355f2016-03-02 23:22:00 +00005231 if(!WritingModule) {
Dario Domizioli13a0a382014-05-23 12:13:25 +00005232 WriteOptimizePragmaOptions(SemaRef);
Nico Weber779355f2016-03-02 23:22:00 +00005233 WriteMSStructPragmaOptions(SemaRef);
Nico Weber42932312016-03-03 00:17:35 +00005234 WriteMSPointersToMembersPragmaOptions(SemaRef);
Nico Weber779355f2016-03-02 23:22:00 +00005235 }
Alex Lorenz7d7e1e02017-03-31 15:36:21 +00005236 WritePackPragmaOptions(SemaRef);
Richard Smithe40f2ba2013-08-07 21:41:30 +00005237
Douglas Gregor08f01292009-04-17 22:13:46 +00005238 // Some simple statistics
Mehdi Amini57a41912015-09-10 01:46:39 +00005239 RecordData::value_type Record[] = {
5240 NumStatements, NumMacros, NumLexicalDeclContexts, NumVisibleDeclContexts};
Sebastian Redl539c5062010-08-18 23:57:32 +00005241 Stream.EmitRecord(STATISTICS, Record);
Douglas Gregor8f45df52009-04-16 22:23:12 +00005242 Stream.ExitBlock();
Adrian Prantladbd2b12015-09-22 23:26:31 +00005243
Douglas Gregor6623e1f2015-11-03 18:33:07 +00005244 // Write the module file extension blocks.
5245 for (const auto &ExtWriter : ModuleFileExtensionWriters)
Douglas Gregor8f64ca12015-12-08 22:43:32 +00005246 WriteModuleFileExtension(SemaRef, *ExtWriter);
Douglas Gregor6623e1f2015-11-03 18:33:07 +00005247
Duncan P. N. Exon Smith60fa2882017-03-13 18:45:08 +00005248 return writeUnhashedControlBlock(PP, Context);
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005249}
5250
Richard Smithb9eab6d2014-03-20 19:44:17 +00005251void ASTWriter::WriteDeclUpdatesBlocks(RecordDataImpl &OffsetsRecord) {
Argyrios Kyrtzidis65ad5692010-10-24 17:26:36 +00005252 if (DeclUpdates.empty())
5253 return;
5254
Richard Smith59442b42014-03-20 20:07:19 +00005255 DeclUpdateMap LocalUpdates;
5256 LocalUpdates.swap(DeclUpdates);
5257
Richard Smith6ef42932014-03-20 21:02:00 +00005258 for (auto &DeclUpdate : LocalUpdates) {
5259 const Decl *D = DeclUpdate.first;
Argyrios Kyrtzidis3ba70b82010-10-24 17:26:46 +00005260
Richard Smithd28ac5b2014-03-22 23:33:22 +00005261 bool HasUpdatedBody = false;
Richard Smith69c82bf2016-04-01 22:52:03 +00005262 RecordData RecordData;
5263 ASTRecordWriter Record(*this, RecordData);
Richard Smith6ef42932014-03-20 21:02:00 +00005264 for (auto &Update : DeclUpdate.second) {
5265 DeclUpdateKind Kind = (DeclUpdateKind)Update.getKind();
5266
Richard Smith69c82bf2016-04-01 22:52:03 +00005267 // An updated body is emitted last, so that the reader doesn't need
5268 // to skip over the lazy body to reach statements for other records.
5269 if (Kind == UPD_CXX_ADDED_FUNCTION_DEFINITION)
5270 HasUpdatedBody = true;
5271 else
5272 Record.push_back(Kind);
5273
Richard Smith6ef42932014-03-20 21:02:00 +00005274 switch (Kind) {
5275 case UPD_CXX_ADDED_IMPLICIT_MEMBER:
5276 case UPD_CXX_ADDED_TEMPLATE_SPECIALIZATION:
5277 case UPD_CXX_ADDED_ANONYMOUS_NAMESPACE:
Richard Smithcd45dbc2014-04-19 03:48:30 +00005278 assert(Update.getDecl() && "no decl to add?");
Richard Smith6ef42932014-03-20 21:02:00 +00005279 Record.push_back(GetDeclRef(Update.getDecl()));
5280 break;
5281
Richard Smith4d235792014-08-07 18:53:08 +00005282 case UPD_CXX_ADDED_FUNCTION_DEFINITION:
Richard Smithd28ac5b2014-03-22 23:33:22 +00005283 break;
5284
Richard Smith891fc7f2017-12-05 01:31:47 +00005285 case UPD_CXX_POINT_OF_INSTANTIATION:
5286 // FIXME: Do we need to also save the template specialization kind here?
Richard Smith69c82bf2016-04-01 22:52:03 +00005287 Record.AddSourceLocation(Update.getLoc());
Richard Smith891fc7f2017-12-05 01:31:47 +00005288 break;
5289
5290 case UPD_CXX_ADDED_VAR_DEFINITION: {
5291 const VarDecl *VD = cast<VarDecl>(D);
Richard Smithf5017592017-11-02 01:06:00 +00005292 Record.push_back(VD->isInline());
5293 Record.push_back(VD->isInlineSpecified());
Richard Smith05a21352017-06-22 22:18:46 +00005294 if (VD->getInit()) {
5295 Record.push_back(!VD->isInitKnownICE() ? 1
5296 : (VD->isInitICE() ? 3 : 2));
5297 Record.AddStmt(const_cast<Expr*>(VD->getInit()));
5298 } else {
5299 Record.push_back(0);
5300 }
Richard Smith4d235792014-08-07 18:53:08 +00005301 break;
Richard Smith05a21352017-06-22 22:18:46 +00005302 }
Richard Smith4d235792014-08-07 18:53:08 +00005303
John McCall32791cc2016-01-06 22:34:54 +00005304 case UPD_CXX_INSTANTIATED_DEFAULT_ARGUMENT:
Richard Smith290d8012016-04-06 17:06:00 +00005305 Record.AddStmt(const_cast<Expr *>(
5306 cast<ParmVarDecl>(Update.getDecl())->getDefaultArg()));
John McCall32791cc2016-01-06 22:34:54 +00005307 break;
5308
Richard Smith4b054b22016-08-24 21:25:37 +00005309 case UPD_CXX_INSTANTIATED_DEFAULT_MEMBER_INITIALIZER:
5310 Record.AddStmt(
5311 cast<FieldDecl>(Update.getDecl())->getInClassInitializer());
5312 break;
5313
Richard Smithcd45dbc2014-04-19 03:48:30 +00005314 case UPD_CXX_INSTANTIATED_CLASS_DEFINITION: {
5315 auto *RD = cast<CXXRecordDecl>(D);
Chandler Carruth8a3d24d2015-03-26 04:27:10 +00005316 UpdatedDeclContexts.insert(RD->getPrimaryContext());
Akira Hatanakafcbe17c2018-03-28 21:13:14 +00005317 Record.push_back(RD->isParamDestroyedInCallee());
Akira Hatanakae6313ac2018-04-09 22:48:22 +00005318 Record.push_back(RD->getArgPassingRestrictions());
Richard Smith69c82bf2016-04-01 22:52:03 +00005319 Record.AddCXXDefinitionData(RD);
Richard Smith72e50fe2016-04-14 00:50:18 +00005320 Record.AddOffset(WriteDeclContextLexicalBlock(
Richard Smithcd45dbc2014-04-19 03:48:30 +00005321 *Context, const_cast<CXXRecordDecl *>(RD)));
5322
5323 // This state is sometimes updated by template instantiation, when we
5324 // switch from the specialization referring to the template declaration
5325 // to it referring to the template definition.
5326 if (auto *MSInfo = RD->getMemberSpecializationInfo()) {
5327 Record.push_back(MSInfo->getTemplateSpecializationKind());
Richard Smith69c82bf2016-04-01 22:52:03 +00005328 Record.AddSourceLocation(MSInfo->getPointOfInstantiation());
Richard Smithcd45dbc2014-04-19 03:48:30 +00005329 } else {
5330 auto *Spec = cast<ClassTemplateSpecializationDecl>(RD);
5331 Record.push_back(Spec->getTemplateSpecializationKind());
Richard Smith69c82bf2016-04-01 22:52:03 +00005332 Record.AddSourceLocation(Spec->getPointOfInstantiation());
Richard Smithdf352052014-05-22 20:59:29 +00005333
5334 // The instantiation might have been resolved to a partial
5335 // specialization. If so, record which one.
5336 auto From = Spec->getInstantiatedFrom();
5337 if (auto PartialSpec =
5338 From.dyn_cast<ClassTemplatePartialSpecializationDecl*>()) {
5339 Record.push_back(true);
Richard Smith69c82bf2016-04-01 22:52:03 +00005340 Record.AddDeclRef(PartialSpec);
5341 Record.AddTemplateArgumentList(
5342 &Spec->getTemplateInstantiationArgs());
Richard Smithdf352052014-05-22 20:59:29 +00005343 } else {
5344 Record.push_back(false);
5345 }
Richard Smithcd45dbc2014-04-19 03:48:30 +00005346 }
5347 Record.push_back(RD->getTagKind());
Richard Smith69c82bf2016-04-01 22:52:03 +00005348 Record.AddSourceLocation(RD->getLocation());
Stephen Kellyf2ceec42018-08-09 21:08:08 +00005349 Record.AddSourceLocation(RD->getBeginLoc());
Argyrios Kyrtzidisd798c052016-07-15 18:11:33 +00005350 Record.AddSourceRange(RD->getBraceRange());
Richard Smithcd45dbc2014-04-19 03:48:30 +00005351
5352 // Instantiation may change attributes; write them all out afresh.
5353 Record.push_back(D->hasAttrs());
Richard Smith69c82bf2016-04-01 22:52:03 +00005354 if (D->hasAttrs())
5355 Record.AddAttributes(D->getAttrs());
Richard Smithcd45dbc2014-04-19 03:48:30 +00005356
5357 // FIXME: Ensure we don't get here for explicit instantiations.
5358 break;
5359 }
5360
Richard Smithf8134002015-03-10 01:41:22 +00005361 case UPD_CXX_RESOLVED_DTOR_DELETE:
Richard Smith69c82bf2016-04-01 22:52:03 +00005362 Record.AddDeclRef(Update.getDecl());
Richard Smith5b349582017-10-13 01:55:36 +00005363 Record.AddStmt(cast<CXXDestructorDecl>(D)->getOperatorDeleteThisArg());
Richard Smithf8134002015-03-10 01:41:22 +00005364 break;
5365
Richard Smith564417a2014-03-20 21:47:22 +00005366 case UPD_CXX_RESOLVED_EXCEPTION_SPEC:
5367 addExceptionSpec(
Richard Smith564417a2014-03-20 21:47:22 +00005368 cast<FunctionDecl>(D)->getType()->castAs<FunctionProtoType>(),
5369 Record);
5370 break;
5371
Richard Smith6ef42932014-03-20 21:02:00 +00005372 case UPD_CXX_DEDUCED_RETURN_TYPE:
5373 Record.push_back(GetOrCreateTypeID(Update.getType()));
5374 break;
5375
5376 case UPD_DECL_MARKED_USED:
5377 break;
Richard Smith5652c0f2014-03-21 01:48:23 +00005378
5379 case UPD_MANGLING_NUMBER:
5380 case UPD_STATIC_LOCAL_NUMBER:
5381 Record.push_back(Update.getNumber());
5382 break;
Richard Smith65ebb4a2015-03-26 04:09:53 +00005383
Alexey Bataev97720002014-11-11 04:05:39 +00005384 case UPD_DECL_MARKED_OPENMP_THREADPRIVATE:
Richard Smith69c82bf2016-04-01 22:52:03 +00005385 Record.AddSourceRange(
5386 D->getAttr<OMPThreadPrivateDeclAttr>()->getRange());
Alexey Bataev97720002014-11-11 04:05:39 +00005387 break;
Richard Smith65ebb4a2015-03-26 04:09:53 +00005388
Alexey Bataev27ef9512019-03-20 20:14:22 +00005389 case UPD_DECL_MARKED_OPENMP_ALLOCATE: {
5390 auto *A = D->getAttr<OMPAllocateDeclAttr>();
5391 Record.push_back(A->getAllocatorType());
5392 Record.AddStmt(A->getAllocator());
5393 Record.AddSourceRange(A->getRange());
Alexey Bataev25ed0c02019-03-07 17:54:44 +00005394 break;
Alexey Bataev27ef9512019-03-20 20:14:22 +00005395 }
Alexey Bataev25ed0c02019-03-07 17:54:44 +00005396
Dmitry Polukhin0b0da292016-04-06 11:38:59 +00005397 case UPD_DECL_MARKED_OPENMP_DECLARETARGET:
Alexey Bataevd01b7492018-08-15 19:45:12 +00005398 Record.push_back(D->getAttr<OMPDeclareTargetDeclAttr>()->getMapType());
Dmitry Polukhin0b0da292016-04-06 11:38:59 +00005399 Record.AddSourceRange(
5400 D->getAttr<OMPDeclareTargetDeclAttr>()->getRange());
5401 break;
5402
Richard Smith65ebb4a2015-03-26 04:09:53 +00005403 case UPD_DECL_EXPORTED:
Richard Smith4caa4492015-05-15 02:34:32 +00005404 Record.push_back(getSubmoduleID(Update.getModule()));
Richard Smith65ebb4a2015-03-26 04:09:53 +00005405 break;
Alex Denisovfde64952015-06-26 05:28:36 +00005406
5407 case UPD_ADDED_ATTR_TO_RECORD:
Richard Smith69c82bf2016-04-01 22:52:03 +00005408 Record.AddAttributes(llvm::makeArrayRef(Update.getAttr()));
Alex Denisovfde64952015-06-26 05:28:36 +00005409 break;
Richard Smith6ef42932014-03-20 21:02:00 +00005410 }
5411 }
5412
Richard Smithd28ac5b2014-03-22 23:33:22 +00005413 if (HasUpdatedBody) {
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00005414 const auto *Def = cast<FunctionDecl>(D);
Richard Smith4d235792014-08-07 18:53:08 +00005415 Record.push_back(UPD_CXX_ADDED_FUNCTION_DEFINITION);
Richard Smithd28ac5b2014-03-22 23:33:22 +00005416 Record.push_back(Def->isInlined());
Richard Smith69c82bf2016-04-01 22:52:03 +00005417 Record.AddSourceLocation(Def->getInnerLocStart());
Richard Smith290d8012016-04-06 17:06:00 +00005418 Record.AddFunctionDefinition(Def);
Richard Smithd28ac5b2014-03-22 23:33:22 +00005419 }
5420
Richard Smithcd45dbc2014-04-19 03:48:30 +00005421 OffsetsRecord.push_back(GetDeclRef(D));
Richard Smith69c82bf2016-04-01 22:52:03 +00005422 OffsetsRecord.push_back(Record.Emit(DECL_UPDATES));
Argyrios Kyrtzidis65ad5692010-10-24 17:26:36 +00005423 }
Argyrios Kyrtzidis65ad5692010-10-24 17:26:36 +00005424}
5425
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00005426void ASTWriter::AddSourceLocation(SourceLocation Loc, RecordDataImpl &Record) {
Richard Smithb22a1d12016-03-27 20:13:24 +00005427 uint32_t Raw = Loc.getRawEncoding();
5428 Record.push_back((Raw << 1) | (Raw >> 31));
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005429}
5430
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00005431void ASTWriter::AddSourceRange(SourceRange Range, RecordDataImpl &Record) {
Chris Lattnerca025db2010-05-07 21:43:38 +00005432 AddSourceLocation(Range.getBegin(), Record);
5433 AddSourceLocation(Range.getEnd(), Record);
5434}
5435
Richard Smithf144b542016-04-08 21:54:32 +00005436void ASTRecordWriter::AddAPInt(const llvm::APInt &Value) {
5437 Record->push_back(Value.getBitWidth());
Benjamin Kramer25f9ea62010-09-06 23:43:28 +00005438 const uint64_t *Words = Value.getRawData();
Richard Smithf144b542016-04-08 21:54:32 +00005439 Record->append(Words, Words + Value.getNumWords());
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005440}
5441
Richard Smithf144b542016-04-08 21:54:32 +00005442void ASTRecordWriter::AddAPSInt(const llvm::APSInt &Value) {
5443 Record->push_back(Value.isUnsigned());
5444 AddAPInt(Value);
Douglas Gregor1daeb692009-04-13 18:14:40 +00005445}
5446
Richard Smithf144b542016-04-08 21:54:32 +00005447void ASTRecordWriter::AddAPFloat(const llvm::APFloat &Value) {
5448 AddAPInt(Value.bitcastToAPInt());
Douglas Gregore0a3a512009-04-14 21:55:33 +00005449}
5450
Gauthier Harnisch83c7b612019-06-15 10:24:47 +00005451static void WriteFixedPointSemantics(ASTRecordWriter &Record,
5452 FixedPointSemantics FPSema) {
5453 Record.push_back(FPSema.getWidth());
5454 Record.push_back(FPSema.getScale());
5455 Record.push_back(FPSema.isSigned() | FPSema.isSaturated() << 1 |
5456 FPSema.hasUnsignedPadding() << 2);
5457}
5458
5459void ASTRecordWriter::AddAPValue(const APValue &Value) {
5460 APValue::ValueKind Kind = Value.getKind();
5461 push_back(static_cast<uint64_t>(Kind));
5462 switch (Kind) {
5463 case APValue::None:
5464 case APValue::Indeterminate:
5465 return;
5466 case APValue::Int:
5467 AddAPSInt(Value.getInt());
5468 return;
5469 case APValue::Float:
5470 push_back(static_cast<uint64_t>(
5471 llvm::APFloatBase::SemanticsToEnum(Value.getFloat().getSemantics())));
5472 AddAPFloat(Value.getFloat());
5473 return;
5474 case APValue::FixedPoint: {
5475 WriteFixedPointSemantics(*this, Value.getFixedPoint().getSemantics());
5476 AddAPSInt(Value.getFixedPoint().getValue());
5477 return;
5478 }
5479 case APValue::ComplexInt: {
5480 AddAPSInt(Value.getComplexIntReal());
5481 AddAPSInt(Value.getComplexIntImag());
5482 return;
5483 }
5484 case APValue::ComplexFloat: {
5485 push_back(static_cast<uint64_t>(llvm::APFloatBase::SemanticsToEnum(
5486 Value.getComplexFloatReal().getSemantics())));
5487 AddAPFloat(Value.getComplexFloatReal());
5488 push_back(static_cast<uint64_t>(llvm::APFloatBase::SemanticsToEnum(
5489 Value.getComplexFloatImag().getSemantics())));
5490 AddAPFloat(Value.getComplexFloatImag());
5491 return;
5492 }
5493 case APValue::LValue:
5494 case APValue::Vector:
5495 case APValue::Array:
5496 case APValue::Struct:
5497 case APValue::Union:
5498 case APValue::MemberPointer:
5499 case APValue::AddrLabelDiff:
5500 // TODO : Handle all these APValue::ValueKind.
5501 return;
5502 }
5503 llvm_unreachable("Invalid APValue::ValueKind");
5504}
5505
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00005506void ASTWriter::AddIdentifierRef(const IdentifierInfo *II, RecordDataImpl &Record) {
Douglas Gregor4621c6a2009-04-22 18:49:13 +00005507 Record.push_back(getIdentifierRef(II));
5508}
5509
Sebastian Redl539c5062010-08-18 23:57:32 +00005510IdentID ASTWriter::getIdentifierRef(const IdentifierInfo *II) {
Craig Toppera13603a2014-05-22 05:54:18 +00005511 if (!II)
Douglas Gregor4621c6a2009-04-22 18:49:13 +00005512 return 0;
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00005513
Sebastian Redl539c5062010-08-18 23:57:32 +00005514 IdentID &ID = IdentifierIDs[II];
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00005515 if (ID == 0)
Sebastian Redlff4a2952010-07-23 23:49:55 +00005516 ID = NextIdentID++;
Douglas Gregor4621c6a2009-04-22 18:49:13 +00005517 return ID;
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005518}
5519
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00005520MacroID ASTWriter::getMacroRef(MacroInfo *MI, const IdentifierInfo *Name) {
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00005521 // Don't emit builtin macros like __LINE__ to the AST file unless they
5522 // have been redefined by the header (in which case they are not
5523 // isBuiltinMacro).
Craig Toppera13603a2014-05-22 05:54:18 +00005524 if (!MI || MI->isBuiltinMacro())
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00005525 return 0;
5526
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00005527 MacroID &ID = MacroIDs[MI];
5528 if (ID == 0) {
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00005529 ID = NextMacroID++;
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00005530 MacroInfoToEmitData Info = { Name, MI, ID };
5531 MacroInfosToEmit.push_back(Info);
5532 }
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00005533 return ID;
5534}
5535
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00005536MacroID ASTWriter::getMacroID(MacroInfo *MI) {
Craig Toppera13603a2014-05-22 05:54:18 +00005537 if (!MI || MI->isBuiltinMacro())
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00005538 return 0;
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00005539
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00005540 assert(MacroIDs.find(MI) != MacroIDs.end() && "Macro not emitted!");
5541 return MacroIDs[MI];
5542}
5543
5544uint64_t ASTWriter::getMacroDirectivesOffset(const IdentifierInfo *Name) {
Richard Smithd7329392015-04-21 21:46:32 +00005545 return IdentMacroDirectivesOffsetMap.lookup(Name);
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00005546}
5547
Richard Smithe64e7452016-04-18 21:54:58 +00005548void ASTRecordWriter::AddSelectorRef(const Selector SelRef) {
5549 Record->push_back(Writer->getSelectorRef(SelRef));
Sebastian Redl834bb972010-08-04 17:20:04 +00005550}
5551
Sebastian Redl539c5062010-08-18 23:57:32 +00005552SelectorID ASTWriter::getSelectorRef(Selector Sel) {
Craig Toppera13603a2014-05-22 05:54:18 +00005553 if (Sel.getAsOpaquePtr() == nullptr) {
Sebastian Redl834bb972010-08-04 17:20:04 +00005554 return 0;
Steve Naroff2ddea052009-04-23 10:39:46 +00005555 }
5556
Douglas Gregor8d7edce2013-02-08 21:30:59 +00005557 SelectorID SID = SelectorIDs[Sel];
Sebastian Redld95a56e2010-08-04 18:21:41 +00005558 if (SID == 0 && Chain) {
5559 // This might trigger a ReadSelector callback, which will set the ID for
5560 // this selector.
5561 Chain->LoadSelector(Sel);
Douglas Gregor8d7edce2013-02-08 21:30:59 +00005562 SID = SelectorIDs[Sel];
Sebastian Redld95a56e2010-08-04 18:21:41 +00005563 }
Steve Naroff2ddea052009-04-23 10:39:46 +00005564 if (SID == 0) {
Sebastian Redld95a56e2010-08-04 18:21:41 +00005565 SID = NextSelectorID++;
Douglas Gregor8d7edce2013-02-08 21:30:59 +00005566 SelectorIDs[Sel] = SID;
Steve Naroff2ddea052009-04-23 10:39:46 +00005567 }
Sebastian Redl834bb972010-08-04 17:20:04 +00005568 return SID;
Steve Naroff2ddea052009-04-23 10:39:46 +00005569}
5570
Richard Smithe64e7452016-04-18 21:54:58 +00005571void ASTRecordWriter::AddCXXTemporary(const CXXTemporary *Temp) {
5572 AddDeclRef(Temp->getDestructor());
Chris Lattnercba86142010-05-10 00:25:06 +00005573}
5574
Richard Smith290d8012016-04-06 17:06:00 +00005575void ASTRecordWriter::AddTemplateArgumentLocInfo(
5576 TemplateArgument::ArgKind Kind, const TemplateArgumentLocInfo &Arg) {
Argyrios Kyrtzidisae85e242010-06-22 09:54:59 +00005577 switch (Kind) {
John McCall0ad16662009-10-29 08:12:44 +00005578 case TemplateArgument::Expression:
Argyrios Kyrtzidisae85e242010-06-22 09:54:59 +00005579 AddStmt(Arg.getAsExpr());
John McCall0ad16662009-10-29 08:12:44 +00005580 break;
5581 case TemplateArgument::Type:
Richard Smith290d8012016-04-06 17:06:00 +00005582 AddTypeSourceInfo(Arg.getAsTypeSourceInfo());
John McCall0ad16662009-10-29 08:12:44 +00005583 break;
Douglas Gregor9167f8b2009-11-11 01:00:40 +00005584 case TemplateArgument::Template:
Richard Smith290d8012016-04-06 17:06:00 +00005585 AddNestedNameSpecifierLoc(Arg.getTemplateQualifierLoc());
5586 AddSourceLocation(Arg.getTemplateNameLoc());
Douglas Gregore4ff4b52011-01-05 18:58:31 +00005587 break;
5588 case TemplateArgument::TemplateExpansion:
Richard Smith290d8012016-04-06 17:06:00 +00005589 AddNestedNameSpecifierLoc(Arg.getTemplateQualifierLoc());
5590 AddSourceLocation(Arg.getTemplateNameLoc());
5591 AddSourceLocation(Arg.getTemplateEllipsisLoc());
Douglas Gregor9167f8b2009-11-11 01:00:40 +00005592 break;
John McCall0ad16662009-10-29 08:12:44 +00005593 case TemplateArgument::Null:
5594 case TemplateArgument::Integral:
5595 case TemplateArgument::Declaration:
Eli Friedmanb826a002012-09-26 02:36:12 +00005596 case TemplateArgument::NullPtr:
John McCall0ad16662009-10-29 08:12:44 +00005597 case TemplateArgument::Pack:
Eli Friedmanb826a002012-09-26 02:36:12 +00005598 // FIXME: Is this right?
John McCall0ad16662009-10-29 08:12:44 +00005599 break;
5600 }
5601}
5602
Richard Smith290d8012016-04-06 17:06:00 +00005603void ASTRecordWriter::AddTemplateArgumentLoc(const TemplateArgumentLoc &Arg) {
5604 AddTemplateArgument(Arg.getArgument());
Argyrios Kyrtzidisddf5f212010-06-28 09:31:42 +00005605
5606 if (Arg.getArgument().getKind() == TemplateArgument::Expression) {
5607 bool InfoHasSameExpr
5608 = Arg.getArgument().getAsExpr() == Arg.getLocInfo().getAsExpr();
Richard Smith290d8012016-04-06 17:06:00 +00005609 Record->push_back(InfoHasSameExpr);
Argyrios Kyrtzidisddf5f212010-06-28 09:31:42 +00005610 if (InfoHasSameExpr)
5611 return; // Avoid storing the same expr twice.
5612 }
Richard Smith290d8012016-04-06 17:06:00 +00005613 AddTemplateArgumentLocInfo(Arg.getArgument().getKind(), Arg.getLocInfo());
Argyrios Kyrtzidisae85e242010-06-22 09:54:59 +00005614}
5615
Richard Smith290d8012016-04-06 17:06:00 +00005616void ASTRecordWriter::AddTypeSourceInfo(TypeSourceInfo *TInfo) {
Craig Toppera13603a2014-05-22 05:54:18 +00005617 if (!TInfo) {
Richard Smith290d8012016-04-06 17:06:00 +00005618 AddTypeRef(QualType());
John McCall8f115c62009-10-16 21:56:05 +00005619 return;
5620 }
5621
Richard Smithc23d7342018-06-29 20:46:25 +00005622 AddTypeRef(TInfo->getType());
Richard Smith290d8012016-04-06 17:06:00 +00005623 AddTypeLoc(TInfo->getTypeLoc());
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005624}
5625
Richard Smith290d8012016-04-06 17:06:00 +00005626void ASTRecordWriter::AddTypeLoc(TypeLoc TL) {
Richard Smith290d8012016-04-06 17:06:00 +00005627 TypeLocWriter TLW(*this);
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005628 for (; !TL.isNull(); TL = TL.getNextTypeLoc())
Kovarththanan Rajaratnama9c81a82010-03-14 07:06:50 +00005629 TLW.Visit(TL);
John McCall8f115c62009-10-16 21:56:05 +00005630}
5631
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00005632void ASTWriter::AddTypeRef(QualType T, RecordDataImpl &Record) {
Argyrios Kyrtzidis9ab44ea2010-08-20 16:04:14 +00005633 Record.push_back(GetOrCreateTypeID(T));
5634}
5635
Richard Smith2095ffe2015-03-16 20:11:03 +00005636TypeID ASTWriter::GetOrCreateTypeID(QualType T) {
Richard Smith1fa5d642013-05-11 05:45:24 +00005637 assert(Context);
Richard Smith2095ffe2015-03-16 20:11:03 +00005638 return MakeTypeID(*Context, T, [&](QualType T) -> TypeIdx {
5639 if (T.isNull())
5640 return TypeIdx();
5641 assert(!T.getLocalFastQualifiers());
5642
5643 TypeIdx &Idx = TypeIdxs[T];
5644 if (Idx.getIndex() == 0) {
5645 if (DoneWritingDeclsAndTypes) {
5646 assert(0 && "New type seen after serializing all the types to emit!");
5647 return TypeIdx();
5648 }
5649
5650 // We haven't seen this type before. Assign it a new ID and put it
5651 // into the queue of types to emit.
5652 Idx = TypeIdx(NextTypeID++);
5653 DeclTypesToEmit.push(T);
5654 }
5655 return Idx;
5656 });
Argyrios Kyrtzidis082e4612010-08-20 16:04:20 +00005657}
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005658
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00005659TypeID ASTWriter::getTypeID(QualType T) const {
Richard Smith1fa5d642013-05-11 05:45:24 +00005660 assert(Context);
Richard Smith2095ffe2015-03-16 20:11:03 +00005661 return MakeTypeID(*Context, T, [&](QualType T) -> TypeIdx {
5662 if (T.isNull())
Argyrios Kyrtzidis442dd802012-07-02 19:19:01 +00005663 return TypeIdx();
Richard Smith2095ffe2015-03-16 20:11:03 +00005664 assert(!T.getLocalFastQualifiers());
Argyrios Kyrtzidis442dd802012-07-02 19:19:01 +00005665
Richard Smith2095ffe2015-03-16 20:11:03 +00005666 TypeIdxMap::const_iterator I = TypeIdxs.find(T);
5667 assert(I != TypeIdxs.end() && "Type not emitted!");
5668 return I->second;
5669 });
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005670}
5671
Argyrios Kyrtzidis65ad5692010-10-24 17:26:36 +00005672void ASTWriter::AddDeclRef(const Decl *D, RecordDataImpl &Record) {
Sebastian Redl66c5eef2010-07-27 00:17:23 +00005673 Record.push_back(GetDeclRef(D));
5674}
5675
Sebastian Redl539c5062010-08-18 23:57:32 +00005676DeclID ASTWriter::GetDeclRef(const Decl *D) {
Douglas Gregor2fd3d402011-09-17 00:05:03 +00005677 assert(WritingAST && "Cannot request a declaration ID before AST writing");
Craig Toppera13603a2014-05-22 05:54:18 +00005678
5679 if (!D) {
Sebastian Redl66c5eef2010-07-27 00:17:23 +00005680 return 0;
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005681 }
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00005682
Douglas Gregorb3163e52012-01-05 22:33:30 +00005683 // If D comes from an AST file, its declaration ID is already known and
5684 // fixed.
5685 if (D->isFromASTFile())
5686 return D->getGlobalID();
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00005687
Douglas Gregor9b3932c2010-10-05 18:37:06 +00005688 assert(!(reinterpret_cast<uintptr_t>(D) & 0x01) && "Invalid decl pointer");
Sebastian Redl539c5062010-08-18 23:57:32 +00005689 DeclID &ID = DeclIDs[D];
Mike Stump11289f42009-09-09 15:08:12 +00005690 if (ID == 0) {
Argyrios Kyrtzidis442dd802012-07-02 19:19:01 +00005691 if (DoneWritingDeclsAndTypes) {
5692 assert(0 && "New decl seen after serializing all the decls to emit!");
5693 return 0;
5694 }
5695
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005696 // We haven't seen this declaration before. Give it a new ID and
5697 // enqueue it in the list of declarations to emit.
Sebastian Redlff4a2952010-07-23 23:49:55 +00005698 ID = NextDeclID++;
Douglas Gregor12bfa382009-10-17 00:13:19 +00005699 DeclTypesToEmit.push(const_cast<Decl *>(D));
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005700 }
5701
Sebastian Redl66c5eef2010-07-27 00:17:23 +00005702 return ID;
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005703}
5704
Sebastian Redl539c5062010-08-18 23:57:32 +00005705DeclID ASTWriter::getDeclID(const Decl *D) {
Craig Toppera13603a2014-05-22 05:54:18 +00005706 if (!D)
Douglas Gregore84a9da2009-04-20 20:36:09 +00005707 return 0;
5708
Douglas Gregorb3163e52012-01-05 22:33:30 +00005709 // If D comes from an AST file, its declaration ID is already known and
5710 // fixed.
5711 if (D->isFromASTFile())
5712 return D->getGlobalID();
5713
Douglas Gregore84a9da2009-04-20 20:36:09 +00005714 assert(DeclIDs.find(D) != DeclIDs.end() && "Declaration not emitted!");
5715 return DeclIDs[D];
5716}
5717
Argyrios Kyrtzidisdf53da82011-10-28 23:57:43 +00005718void ASTWriter::associateDeclWithFile(const Decl *D, DeclID ID) {
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005719 assert(ID);
Argyrios Kyrtzidisdf53da82011-10-28 23:57:43 +00005720 assert(D);
5721
5722 SourceLocation Loc = D->getLocation();
5723 if (Loc.isInvalid())
5724 return;
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005725
5726 // We only keep track of the file-level declarations of each file.
5727 if (!D->getLexicalDeclContext()->isFileContext())
5728 return;
Argyrios Kyrtzidise1bc99e2012-02-24 19:45:46 +00005729 // FIXME: ParmVarDecls that are part of a function type of a parameter of
5730 // a function/objc method, should not have TU as lexical context.
Argyrios Kyrtzidis71b74eb2018-01-26 19:26:12 +00005731 // TemplateTemplateParmDecls that are part of an alias template, should not
5732 // have TU as lexical context.
5733 if (isa<ParmVarDecl>(D) || isa<TemplateTemplateParmDecl>(D))
Argyrios Kyrtzidisffe055a82012-02-24 01:12:38 +00005734 return;
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005735
5736 SourceManager &SM = Context->getSourceManager();
Argyrios Kyrtzidisdf53da82011-10-28 23:57:43 +00005737 SourceLocation FileLoc = SM.getFileLoc(Loc);
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005738 assert(SM.isLocalSourceLocation(FileLoc));
Argyrios Kyrtzidis7362e9b2011-10-28 23:57:47 +00005739 FileID FID;
5740 unsigned Offset;
Benjamin Kramer867ea1d2014-03-02 13:01:17 +00005741 std::tie(FID, Offset) = SM.getDecomposedLoc(FileLoc);
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005742 if (FID.isInvalid())
5743 return;
Argyrios Kyrtzidis4db774a2012-10-02 21:09:17 +00005744 assert(SM.getSLocEntry(FID).isFile());
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005745
Argyrios Kyrtzidis4db774a2012-10-02 21:09:17 +00005746 DeclIDInFileInfo *&Info = FileDeclIDs[FID];
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005747 if (!Info)
5748 Info = new DeclIDInFileInfo();
5749
Argyrios Kyrtzidis7362e9b2011-10-28 23:57:47 +00005750 std::pair<unsigned, serialization::DeclID> LocDecl(Offset, ID);
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005751 LocDeclIDsTy &Decls = Info->DeclIDs;
5752
Argyrios Kyrtzidis7362e9b2011-10-28 23:57:47 +00005753 if (Decls.empty() || Decls.back().first <= Offset) {
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005754 Decls.push_back(LocDecl);
5755 return;
5756 }
5757
Benjamin Kramer45025c02013-08-24 13:22:59 +00005758 LocDeclIDsTy::iterator I =
Fangrui Song7264a472019-07-03 08:13:17 +00005759 llvm::upper_bound(Decls, LocDecl, llvm::less_first());
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005760
5761 Decls.insert(I, LocDecl);
5762}
5763
Richard Smithe64e7452016-04-18 21:54:58 +00005764void ASTRecordWriter::AddDeclarationName(DeclarationName Name) {
Chris Lattner258172e2009-04-27 07:35:58 +00005765 // FIXME: Emit a stable enum for NameKind. 0 = Identifier etc.
Richard Smithe64e7452016-04-18 21:54:58 +00005766 Record->push_back(Name.getNameKind());
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005767 switch (Name.getNameKind()) {
5768 case DeclarationName::Identifier:
Richard Smithe64e7452016-04-18 21:54:58 +00005769 AddIdentifierRef(Name.getAsIdentifierInfo());
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005770 break;
5771
5772 case DeclarationName::ObjCZeroArgSelector:
5773 case DeclarationName::ObjCOneArgSelector:
5774 case DeclarationName::ObjCMultiArgSelector:
Richard Smithe64e7452016-04-18 21:54:58 +00005775 AddSelectorRef(Name.getObjCSelector());
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005776 break;
5777
5778 case DeclarationName::CXXConstructorName:
5779 case DeclarationName::CXXDestructorName:
5780 case DeclarationName::CXXConversionFunctionName:
Richard Smithe64e7452016-04-18 21:54:58 +00005781 AddTypeRef(Name.getCXXNameType());
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005782 break;
5783
Richard Smith35845152017-02-07 01:37:30 +00005784 case DeclarationName::CXXDeductionGuideName:
5785 AddDeclRef(Name.getCXXDeductionGuideTemplate());
5786 break;
5787
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005788 case DeclarationName::CXXOperatorName:
Richard Smithe64e7452016-04-18 21:54:58 +00005789 Record->push_back(Name.getCXXOverloadedOperator());
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005790 break;
5791
Alexis Hunt3d221f22009-11-29 07:34:05 +00005792 case DeclarationName::CXXLiteralOperatorName:
Richard Smithe64e7452016-04-18 21:54:58 +00005793 AddIdentifierRef(Name.getCXXLiteralIdentifier());
Alexis Hunt3d221f22009-11-29 07:34:05 +00005794 break;
5795
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005796 case DeclarationName::CXXUsingDirective:
5797 // No extra data to emit
5798 break;
5799 }
5800}
Chris Lattnerca025db2010-05-07 21:43:38 +00005801
Richard Smithd08aeb62014-08-28 01:33:39 +00005802unsigned ASTWriter::getAnonymousDeclarationNumber(const NamedDecl *D) {
5803 assert(needsAnonymousDeclarationNumber(D) &&
5804 "expected an anonymous declaration");
5805
5806 // Number the anonymous declarations within this context, if we've not
5807 // already done so.
5808 auto It = AnonymousDeclarationNumbers.find(D);
5809 if (It == AnonymousDeclarationNumbers.end()) {
Richard Smith2b560572015-02-07 03:11:11 +00005810 auto *DC = D->getLexicalDeclContext();
5811 numberAnonymousDeclsWithin(DC, [&](const NamedDecl *ND, unsigned Number) {
5812 AnonymousDeclarationNumbers[ND] = Number;
5813 });
Richard Smithd08aeb62014-08-28 01:33:39 +00005814
5815 It = AnonymousDeclarationNumbers.find(D);
5816 assert(It != AnonymousDeclarationNumbers.end() &&
5817 "declaration not found within its lexical context");
5818 }
5819
5820 return It->second;
5821}
5822
Richard Smith290d8012016-04-06 17:06:00 +00005823void ASTRecordWriter::AddDeclarationNameLoc(const DeclarationNameLoc &DNLoc,
5824 DeclarationName Name) {
Argyrios Kyrtzidis434383d2010-10-15 18:21:24 +00005825 switch (Name.getNameKind()) {
5826 case DeclarationName::CXXConstructorName:
5827 case DeclarationName::CXXDestructorName:
5828 case DeclarationName::CXXConversionFunctionName:
Richard Smith290d8012016-04-06 17:06:00 +00005829 AddTypeSourceInfo(DNLoc.NamedType.TInfo);
Argyrios Kyrtzidis434383d2010-10-15 18:21:24 +00005830 break;
5831
5832 case DeclarationName::CXXOperatorName:
Richard Smith290d8012016-04-06 17:06:00 +00005833 AddSourceLocation(SourceLocation::getFromRawEncoding(
5834 DNLoc.CXXOperatorName.BeginOpNameLoc));
Argyrios Kyrtzidis434383d2010-10-15 18:21:24 +00005835 AddSourceLocation(
Richard Smith290d8012016-04-06 17:06:00 +00005836 SourceLocation::getFromRawEncoding(DNLoc.CXXOperatorName.EndOpNameLoc));
Argyrios Kyrtzidis434383d2010-10-15 18:21:24 +00005837 break;
5838
5839 case DeclarationName::CXXLiteralOperatorName:
Richard Smith290d8012016-04-06 17:06:00 +00005840 AddSourceLocation(SourceLocation::getFromRawEncoding(
5841 DNLoc.CXXLiteralOperatorName.OpNameLoc));
Argyrios Kyrtzidis434383d2010-10-15 18:21:24 +00005842 break;
5843
5844 case DeclarationName::Identifier:
5845 case DeclarationName::ObjCZeroArgSelector:
5846 case DeclarationName::ObjCOneArgSelector:
5847 case DeclarationName::ObjCMultiArgSelector:
5848 case DeclarationName::CXXUsingDirective:
Richard Smith35845152017-02-07 01:37:30 +00005849 case DeclarationName::CXXDeductionGuideName:
Argyrios Kyrtzidis434383d2010-10-15 18:21:24 +00005850 break;
5851 }
5852}
5853
Richard Smith290d8012016-04-06 17:06:00 +00005854void ASTRecordWriter::AddDeclarationNameInfo(
5855 const DeclarationNameInfo &NameInfo) {
5856 AddDeclarationName(NameInfo.getName());
5857 AddSourceLocation(NameInfo.getLoc());
5858 AddDeclarationNameLoc(NameInfo.getInfo(), NameInfo.getName());
Argyrios Kyrtzidis434383d2010-10-15 18:21:24 +00005859}
5860
Richard Smith290d8012016-04-06 17:06:00 +00005861void ASTRecordWriter::AddQualifierInfo(const QualifierInfo &Info) {
5862 AddNestedNameSpecifierLoc(Info.QualifierLoc);
5863 Record->push_back(Info.NumTemplParamLists);
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +00005864 for (unsigned i = 0, e = Info.NumTemplParamLists; i != e; ++i)
Richard Smith290d8012016-04-06 17:06:00 +00005865 AddTemplateParameterList(Info.TemplParamLists[i]);
Argyrios Kyrtzidis434383d2010-10-15 18:21:24 +00005866}
5867
Richard Smithe64e7452016-04-18 21:54:58 +00005868void ASTRecordWriter::AddNestedNameSpecifier(NestedNameSpecifier *NNS) {
Chris Lattnerca025db2010-05-07 21:43:38 +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<NestedNameSpecifier *, 8> NestedNames;
Chris Lattnerca025db2010-05-07 21:43:38 +00005872
5873 // Push each of the NNS's onto a stack for serialization in reverse order.
5874 while (NNS) {
5875 NestedNames.push_back(NNS);
5876 NNS = NNS->getPrefix();
5877 }
5878
Richard Smithe64e7452016-04-18 21:54:58 +00005879 Record->push_back(NestedNames.size());
Chris Lattnerca025db2010-05-07 21:43:38 +00005880 while(!NestedNames.empty()) {
5881 NNS = NestedNames.pop_back_val();
5882 NestedNameSpecifier::SpecifierKind Kind = NNS->getKind();
Richard Smithe64e7452016-04-18 21:54:58 +00005883 Record->push_back(Kind);
Chris Lattnerca025db2010-05-07 21:43:38 +00005884 switch (Kind) {
5885 case NestedNameSpecifier::Identifier:
Richard Smithe64e7452016-04-18 21:54:58 +00005886 AddIdentifierRef(NNS->getAsIdentifier());
Chris Lattnerca025db2010-05-07 21:43:38 +00005887 break;
5888
5889 case NestedNameSpecifier::Namespace:
Richard Smithe64e7452016-04-18 21:54:58 +00005890 AddDeclRef(NNS->getAsNamespace());
Chris Lattnerca025db2010-05-07 21:43:38 +00005891 break;
5892
Douglas Gregor7b26ff92011-02-24 02:36:08 +00005893 case NestedNameSpecifier::NamespaceAlias:
Richard Smithe64e7452016-04-18 21:54:58 +00005894 AddDeclRef(NNS->getAsNamespaceAlias());
Douglas Gregor7b26ff92011-02-24 02:36:08 +00005895 break;
5896
Chris Lattnerca025db2010-05-07 21:43:38 +00005897 case NestedNameSpecifier::TypeSpec:
5898 case NestedNameSpecifier::TypeSpecWithTemplate:
Richard Smithe64e7452016-04-18 21:54:58 +00005899 AddTypeRef(QualType(NNS->getAsType(), 0));
5900 Record->push_back(Kind == NestedNameSpecifier::TypeSpecWithTemplate);
Chris Lattnerca025db2010-05-07 21:43:38 +00005901 break;
5902
5903 case NestedNameSpecifier::Global:
5904 // Don't need to write an associated value.
5905 break;
Nikola Smiljanic67860242014-09-26 00:28:20 +00005906
5907 case NestedNameSpecifier::Super:
Richard Smithe64e7452016-04-18 21:54:58 +00005908 AddDeclRef(NNS->getAsRecordDecl());
Nikola Smiljanic67860242014-09-26 00:28:20 +00005909 break;
Chris Lattnerca025db2010-05-07 21:43:38 +00005910 }
5911 }
5912}
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005913
Richard Smith290d8012016-04-06 17:06:00 +00005914void ASTRecordWriter::AddNestedNameSpecifierLoc(NestedNameSpecifierLoc NNS) {
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005915 // Nested name specifiers usually aren't too long. I think that 8 would
Chris Lattner57540c52011-04-15 05:22:18 +00005916 // typically accommodate the vast majority.
Chris Lattner0e62c1c2011-07-23 10:55:15 +00005917 SmallVector<NestedNameSpecifierLoc , 8> NestedNames;
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005918
5919 // Push each of the nested-name-specifiers's onto a stack for
5920 // serialization in reverse order.
5921 while (NNS) {
5922 NestedNames.push_back(NNS);
5923 NNS = NNS.getPrefix();
5924 }
5925
Richard Smith290d8012016-04-06 17:06:00 +00005926 Record->push_back(NestedNames.size());
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005927 while(!NestedNames.empty()) {
5928 NNS = NestedNames.pop_back_val();
5929 NestedNameSpecifier::SpecifierKind Kind
5930 = NNS.getNestedNameSpecifier()->getKind();
Richard Smith290d8012016-04-06 17:06:00 +00005931 Record->push_back(Kind);
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005932 switch (Kind) {
5933 case NestedNameSpecifier::Identifier:
Richard Smith290d8012016-04-06 17:06:00 +00005934 AddIdentifierRef(NNS.getNestedNameSpecifier()->getAsIdentifier());
5935 AddSourceRange(NNS.getLocalSourceRange());
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005936 break;
5937
5938 case NestedNameSpecifier::Namespace:
Richard Smith290d8012016-04-06 17:06:00 +00005939 AddDeclRef(NNS.getNestedNameSpecifier()->getAsNamespace());
5940 AddSourceRange(NNS.getLocalSourceRange());
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005941 break;
5942
5943 case NestedNameSpecifier::NamespaceAlias:
Richard Smith290d8012016-04-06 17:06:00 +00005944 AddDeclRef(NNS.getNestedNameSpecifier()->getAsNamespaceAlias());
5945 AddSourceRange(NNS.getLocalSourceRange());
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005946 break;
5947
5948 case NestedNameSpecifier::TypeSpec:
5949 case NestedNameSpecifier::TypeSpecWithTemplate:
Richard Smith290d8012016-04-06 17:06:00 +00005950 Record->push_back(Kind == NestedNameSpecifier::TypeSpecWithTemplate);
Richard Smithc23d7342018-06-29 20:46:25 +00005951 AddTypeRef(NNS.getTypeLoc().getType());
Richard Smith290d8012016-04-06 17:06:00 +00005952 AddTypeLoc(NNS.getTypeLoc());
5953 AddSourceLocation(NNS.getLocalSourceRange().getEnd());
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005954 break;
5955
5956 case NestedNameSpecifier::Global:
Richard Smith290d8012016-04-06 17:06:00 +00005957 AddSourceLocation(NNS.getLocalSourceRange().getEnd());
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005958 break;
Nikola Smiljanic67860242014-09-26 00:28:20 +00005959
5960 case NestedNameSpecifier::Super:
Richard Smith290d8012016-04-06 17:06:00 +00005961 AddDeclRef(NNS.getNestedNameSpecifier()->getAsRecordDecl());
5962 AddSourceRange(NNS.getLocalSourceRange());
Nikola Smiljanic67860242014-09-26 00:28:20 +00005963 break;
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005964 }
5965 }
5966}
5967
Richard Smith290d8012016-04-06 17:06:00 +00005968void ASTRecordWriter::AddTemplateName(TemplateName Name) {
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00005969 TemplateName::NameKind Kind = Name.getKind();
Richard Smith290d8012016-04-06 17:06:00 +00005970 Record->push_back(Kind);
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005971 switch (Kind) {
5972 case TemplateName::Template:
Richard Smith290d8012016-04-06 17:06:00 +00005973 AddDeclRef(Name.getAsTemplateDecl());
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005974 break;
5975
5976 case TemplateName::OverloadedTemplate: {
5977 OverloadedTemplateStorage *OvT = Name.getAsOverloadedTemplate();
Richard Smith290d8012016-04-06 17:06:00 +00005978 Record->push_back(OvT->size());
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00005979 for (const auto &I : *OvT)
Richard Smith290d8012016-04-06 17:06:00 +00005980 AddDeclRef(I);
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005981 break;
5982 }
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00005983
Richard Smithb23c5e82019-05-09 03:31:27 +00005984 case TemplateName::AssumedTemplate: {
5985 AssumedTemplateStorage *ADLT = Name.getAsAssumedTemplateName();
5986 AddDeclarationName(ADLT->getDeclName());
5987 break;
5988 }
5989
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005990 case TemplateName::QualifiedTemplate: {
5991 QualifiedTemplateName *QualT = Name.getAsQualifiedTemplateName();
Richard Smith290d8012016-04-06 17:06:00 +00005992 AddNestedNameSpecifier(QualT->getQualifier());
5993 Record->push_back(QualT->hasTemplateKeyword());
5994 AddDeclRef(QualT->getTemplateDecl());
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005995 break;
5996 }
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00005997
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005998 case TemplateName::DependentTemplate: {
5999 DependentTemplateName *DepT = Name.getAsDependentTemplateName();
Richard Smith290d8012016-04-06 17:06:00 +00006000 AddNestedNameSpecifier(DepT->getQualifier());
6001 Record->push_back(DepT->isIdentifier());
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00006002 if (DepT->isIdentifier())
Richard Smith290d8012016-04-06 17:06:00 +00006003 AddIdentifierRef(DepT->getIdentifier());
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00006004 else
Richard Smith290d8012016-04-06 17:06:00 +00006005 Record->push_back(DepT->getOperator());
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00006006 break;
6007 }
John McCalld9dfe3a2011-06-30 08:33:18 +00006008
6009 case TemplateName::SubstTemplateTemplateParm: {
6010 SubstTemplateTemplateParmStorage *subst
6011 = Name.getAsSubstTemplateTemplateParm();
Richard Smith290d8012016-04-06 17:06:00 +00006012 AddDeclRef(subst->getParameter());
6013 AddTemplateName(subst->getReplacement());
John McCalld9dfe3a2011-06-30 08:33:18 +00006014 break;
6015 }
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00006016
Douglas Gregor5590be02011-01-15 06:45:20 +00006017 case TemplateName::SubstTemplateTemplateParmPack: {
6018 SubstTemplateTemplateParmPackStorage *SubstPack
6019 = Name.getAsSubstTemplateTemplateParmPack();
Richard Smith290d8012016-04-06 17:06:00 +00006020 AddDeclRef(SubstPack->getParameterPack());
6021 AddTemplateArgument(SubstPack->getArgumentPack());
Douglas Gregor5590be02011-01-15 06:45:20 +00006022 break;
6023 }
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00006024 }
6025}
6026
Richard Smith290d8012016-04-06 17:06:00 +00006027void ASTRecordWriter::AddTemplateArgument(const TemplateArgument &Arg) {
6028 Record->push_back(Arg.getKind());
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00006029 switch (Arg.getKind()) {
6030 case TemplateArgument::Null:
6031 break;
6032 case TemplateArgument::Type:
Richard Smith290d8012016-04-06 17:06:00 +00006033 AddTypeRef(Arg.getAsType());
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00006034 break;
6035 case TemplateArgument::Declaration:
Richard Smith290d8012016-04-06 17:06:00 +00006036 AddDeclRef(Arg.getAsDecl());
6037 AddTypeRef(Arg.getParamTypeForDecl());
Eli Friedmanb826a002012-09-26 02:36:12 +00006038 break;
6039 case TemplateArgument::NullPtr:
Richard Smith290d8012016-04-06 17:06:00 +00006040 AddTypeRef(Arg.getNullPtrType());
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00006041 break;
6042 case TemplateArgument::Integral:
Richard Smith290d8012016-04-06 17:06:00 +00006043 AddAPSInt(Arg.getAsIntegral());
6044 AddTypeRef(Arg.getIntegralType());
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00006045 break;
6046 case TemplateArgument::Template:
Richard Smith290d8012016-04-06 17:06:00 +00006047 AddTemplateName(Arg.getAsTemplateOrTemplatePattern());
Douglas Gregore1d60df2011-01-14 23:41:42 +00006048 break;
Douglas Gregore4ff4b52011-01-05 18:58:31 +00006049 case TemplateArgument::TemplateExpansion:
Richard Smith290d8012016-04-06 17:06:00 +00006050 AddTemplateName(Arg.getAsTemplateOrTemplatePattern());
David Blaikie05785d12013-02-20 22:23:23 +00006051 if (Optional<unsigned> NumExpansions = Arg.getNumTemplateExpansions())
Richard Smith290d8012016-04-06 17:06:00 +00006052 Record->push_back(*NumExpansions + 1);
Douglas Gregore1d60df2011-01-14 23:41:42 +00006053 else
Richard Smith290d8012016-04-06 17:06:00 +00006054 Record->push_back(0);
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00006055 break;
6056 case TemplateArgument::Expression:
6057 AddStmt(Arg.getAsExpr());
6058 break;
6059 case TemplateArgument::Pack:
Richard Smith290d8012016-04-06 17:06:00 +00006060 Record->push_back(Arg.pack_size());
Aaron Ballman2a89e852014-07-15 21:32:31 +00006061 for (const auto &P : Arg.pack_elements())
Richard Smith290d8012016-04-06 17:06:00 +00006062 AddTemplateArgument(P);
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00006063 break;
6064 }
6065}
Argyrios Kyrtzidis818c5db2010-06-23 13:48:30 +00006066
Richard Smithe64e7452016-04-18 21:54:58 +00006067void ASTRecordWriter::AddTemplateParameterList(
6068 const TemplateParameterList *TemplateParams) {
Argyrios Kyrtzidis818c5db2010-06-23 13:48:30 +00006069 assert(TemplateParams && "No TemplateParams!");
Richard Smithe64e7452016-04-18 21:54:58 +00006070 AddSourceLocation(TemplateParams->getTemplateLoc());
6071 AddSourceLocation(TemplateParams->getLAngleLoc());
6072 AddSourceLocation(TemplateParams->getRAngleLoc());
Saar Raz0330fba2019-10-15 18:44:06 +00006073
Richard Smithe64e7452016-04-18 21:54:58 +00006074 Record->push_back(TemplateParams->size());
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00006075 for (const auto &P : *TemplateParams)
Richard Smithe64e7452016-04-18 21:54:58 +00006076 AddDeclRef(P);
Saar Raz0330fba2019-10-15 18:44:06 +00006077 if (const Expr *RequiresClause = TemplateParams->getRequiresClause()) {
6078 Record->push_back(true);
6079 AddStmt(const_cast<Expr*>(RequiresClause));
6080 } else {
6081 Record->push_back(false);
6082 }
Argyrios Kyrtzidis818c5db2010-06-23 13:48:30 +00006083}
6084
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00006085/// Emit a template argument list.
Richard Smith290d8012016-04-06 17:06:00 +00006086void ASTRecordWriter::AddTemplateArgumentList(
6087 const TemplateArgumentList *TemplateArgs) {
Argyrios Kyrtzidis818c5db2010-06-23 13:48:30 +00006088 assert(TemplateArgs && "No TemplateArgs!");
Richard Smith290d8012016-04-06 17:06:00 +00006089 Record->push_back(TemplateArgs->size());
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +00006090 for (int i = 0, e = TemplateArgs->size(); i != e; ++i)
Richard Smith290d8012016-04-06 17:06:00 +00006091 AddTemplateArgument(TemplateArgs->get(i));
Argyrios Kyrtzidis818c5db2010-06-23 13:48:30 +00006092}
Argyrios Kyrtzidis2c2167a2010-07-02 11:55:32 +00006093
Richard Smith290d8012016-04-06 17:06:00 +00006094void ASTRecordWriter::AddASTTemplateArgumentListInfo(
6095 const ASTTemplateArgumentListInfo *ASTTemplArgList) {
Enea Zaffanella6dbe1872013-08-10 07:24:53 +00006096 assert(ASTTemplArgList && "No ASTTemplArgList!");
Richard Smith290d8012016-04-06 17:06:00 +00006097 AddSourceLocation(ASTTemplArgList->LAngleLoc);
6098 AddSourceLocation(ASTTemplArgList->RAngleLoc);
6099 Record->push_back(ASTTemplArgList->NumTemplateArgs);
Enea Zaffanella6dbe1872013-08-10 07:24:53 +00006100 const TemplateArgumentLoc *TemplArgs = ASTTemplArgList->getTemplateArgs();
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +00006101 for (int i = 0, e = ASTTemplArgList->NumTemplateArgs; i != e; ++i)
Richard Smith290d8012016-04-06 17:06:00 +00006102 AddTemplateArgumentLoc(TemplArgs[i]);
Enea Zaffanella6dbe1872013-08-10 07:24:53 +00006103}
Argyrios Kyrtzidis2c2167a2010-07-02 11:55:32 +00006104
Richard Smithe64e7452016-04-18 21:54:58 +00006105void ASTRecordWriter::AddUnresolvedSet(const ASTUnresolvedSet &Set) {
6106 Record->push_back(Set.size());
Argyrios Kyrtzidis0f05fb92012-11-28 03:56:16 +00006107 for (ASTUnresolvedSet::const_iterator
Argyrios Kyrtzidis2c2167a2010-07-02 11:55:32 +00006108 I = Set.begin(), E = Set.end(); I != E; ++I) {
Richard Smithe64e7452016-04-18 21:54:58 +00006109 AddDeclRef(I.getDecl());
6110 Record->push_back(I.getAccess());
Argyrios Kyrtzidis2c2167a2010-07-02 11:55:32 +00006111 }
6112}
Argyrios Kyrtzidis3701fcd2010-07-02 23:30:27 +00006113
Richard Smith290d8012016-04-06 17:06:00 +00006114// FIXME: Move this out of the main ASTRecordWriter interface.
6115void ASTRecordWriter::AddCXXBaseSpecifier(const CXXBaseSpecifier &Base) {
6116 Record->push_back(Base.isVirtual());
6117 Record->push_back(Base.isBaseOfClass());
6118 Record->push_back(Base.getAccessSpecifierAsWritten());
6119 Record->push_back(Base.getInheritConstructors());
6120 AddTypeSourceInfo(Base.getTypeSourceInfo());
6121 AddSourceRange(Base.getSourceRange());
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00006122 AddSourceLocation(Base.isPackExpansion()? Base.getEllipsisLoc()
Richard Smith290d8012016-04-06 17:06:00 +00006123 : SourceLocation());
Argyrios Kyrtzidis3701fcd2010-07-02 23:30:27 +00006124}
Sebastian Redl85b2a6a2010-07-14 23:45:08 +00006125
Richard Smith645d2cf2016-04-14 00:29:55 +00006126static uint64_t EmitCXXBaseSpecifiers(ASTWriter &W,
6127 ArrayRef<CXXBaseSpecifier> Bases) {
6128 ASTWriter::RecordData Record;
6129 ASTRecordWriter Writer(W, Record);
6130 Writer.push_back(Bases.size());
Dmitry Polukhin790b5402016-04-06 10:01:46 +00006131
Richard Smith645d2cf2016-04-14 00:29:55 +00006132 for (auto &Base : Bases)
6133 Writer.AddCXXBaseSpecifier(Base);
Richard Smith290d8012016-04-06 17:06:00 +00006134
Richard Smith645d2cf2016-04-14 00:29:55 +00006135 return Writer.Emit(serialization::DECL_CXX_BASE_SPECIFIERS);
Douglas Gregord4c5ed02010-10-29 22:39:52 +00006136}
6137
Richard Smith290d8012016-04-06 17:06:00 +00006138// FIXME: Move this out of the main ASTRecordWriter interface.
Richard Smith645d2cf2016-04-14 00:29:55 +00006139void ASTRecordWriter::AddCXXBaseSpecifiers(ArrayRef<CXXBaseSpecifier> Bases) {
6140 AddOffset(EmitCXXBaseSpecifiers(*Writer, Bases));
6141}
6142
Richard Smithaa165cf2016-04-13 21:57:08 +00006143static uint64_t
6144EmitCXXCtorInitializers(ASTWriter &W,
6145 ArrayRef<CXXCtorInitializer *> CtorInits) {
6146 ASTWriter::RecordData Record;
6147 ASTRecordWriter Writer(W, Record);
6148 Writer.push_back(CtorInits.size());
Argyrios Kyrtzidis5b6a03f2010-08-09 10:54:12 +00006149
Richard Smithaa165cf2016-04-13 21:57:08 +00006150 for (auto *Init : CtorInits) {
Argyrios Kyrtzidis5b6a03f2010-08-09 10:54:12 +00006151 if (Init->isBaseInitializer()) {
Richard Smithaa165cf2016-04-13 21:57:08 +00006152 Writer.push_back(CTOR_INITIALIZER_BASE);
6153 Writer.AddTypeSourceInfo(Init->getTypeSourceInfo());
6154 Writer.push_back(Init->isBaseVirtual());
Alexis Hunt37a477f2011-05-04 01:19:08 +00006155 } else if (Init->isDelegatingInitializer()) {
Richard Smithaa165cf2016-04-13 21:57:08 +00006156 Writer.push_back(CTOR_INITIALIZER_DELEGATING);
6157 Writer.AddTypeSourceInfo(Init->getTypeSourceInfo());
Alexis Hunt37a477f2011-05-04 01:19:08 +00006158 } else if (Init->isMemberInitializer()){
Richard Smithaa165cf2016-04-13 21:57:08 +00006159 Writer.push_back(CTOR_INITIALIZER_MEMBER);
6160 Writer.AddDeclRef(Init->getMember());
Argyrios Kyrtzidis5b6a03f2010-08-09 10:54:12 +00006161 } else {
Richard Smithaa165cf2016-04-13 21:57:08 +00006162 Writer.push_back(CTOR_INITIALIZER_INDIRECT_MEMBER);
6163 Writer.AddDeclRef(Init->getIndirectMember());
Argyrios Kyrtzidis5b6a03f2010-08-09 10:54:12 +00006164 }
Francois Pichetd583da02010-12-04 09:14:42 +00006165
Richard Smithaa165cf2016-04-13 21:57:08 +00006166 Writer.AddSourceLocation(Init->getMemberLocation());
6167 Writer.AddStmt(Init->getInit());
6168 Writer.AddSourceLocation(Init->getLParenLoc());
6169 Writer.AddSourceLocation(Init->getRParenLoc());
6170 Writer.push_back(Init->isWritten());
Richard Smith30e304e2016-12-14 00:03:17 +00006171 if (Init->isWritten())
Richard Smithaa165cf2016-04-13 21:57:08 +00006172 Writer.push_back(Init->getSourceOrder());
Argyrios Kyrtzidis5b6a03f2010-08-09 10:54:12 +00006173 }
Richard Smithaa165cf2016-04-13 21:57:08 +00006174
6175 return Writer.Emit(serialization::DECL_CXX_CTOR_INITIALIZERS);
Argyrios Kyrtzidis5b6a03f2010-08-09 10:54:12 +00006176}
6177
Richard Smithaa165cf2016-04-13 21:57:08 +00006178// FIXME: Move this out of the main ASTRecordWriter interface.
6179void ASTRecordWriter::AddCXXCtorInitializers(
6180 ArrayRef<CXXCtorInitializer *> CtorInits) {
6181 AddOffset(EmitCXXCtorInitializers(*Writer, CtorInits));
Richard Smithc2bb8182015-03-24 06:36:48 +00006182}
6183
Richard Smith290d8012016-04-06 17:06:00 +00006184void ASTRecordWriter::AddCXXDefinitionData(const CXXRecordDecl *D) {
Richard Smith053f6c62014-05-16 23:01:30 +00006185 auto &Data = D->data();
Richard Smith290d8012016-04-06 17:06:00 +00006186 Record->push_back(Data.IsLambda);
Richard Smith91aeacc2019-10-11 00:29:04 +00006187
6188 #define FIELD(Name, Width, Merge) \
6189 Record->push_back(Data.Name);
6190 #include "clang/AST/CXXRecordDeclDefinitionBits.def"
Richard Trieufd1acbb2017-04-11 21:31:00 +00006191
6192 // getODRHash will compute the ODRHash if it has not been previously computed.
6193 Record->push_back(D->getODRHash());
David Blaikief63556d2017-04-12 20:58:33 +00006194 bool ModulesDebugInfo = Writer->Context->getLangOpts().ModulesDebugInfo &&
6195 Writer->WritingModule && !D->isDependentType();
6196 Record->push_back(ModulesDebugInfo);
6197 if (ModulesDebugInfo)
David Blaikie1ac9c982017-04-11 21:13:37 +00006198 Writer->ModularCodegenDecls.push_back(Writer->GetDeclRef(D));
6199
Richard Smith561fb152012-02-25 07:33:38 +00006200 // IsLambda bit is already saved.
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00006201
Richard Smith290d8012016-04-06 17:06:00 +00006202 Record->push_back(Data.NumBases);
Douglas Gregord4c5ed02010-10-29 22:39:52 +00006203 if (Data.NumBases > 0)
Richard Smith645d2cf2016-04-14 00:29:55 +00006204 AddCXXBaseSpecifiers(Data.bases());
6205
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00006206 // FIXME: Make VBases lazily computed when needed to avoid storing them.
Richard Smith290d8012016-04-06 17:06:00 +00006207 Record->push_back(Data.NumVBases);
Douglas Gregord4c5ed02010-10-29 22:39:52 +00006208 if (Data.NumVBases > 0)
Richard Smith645d2cf2016-04-14 00:29:55 +00006209 AddCXXBaseSpecifiers(Data.vbases());
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00006210
Richard Smith290d8012016-04-06 17:06:00 +00006211 AddUnresolvedSet(Data.Conversions.get(*Writer->Context));
Richard Smith91aeacc2019-10-11 00:29:04 +00006212 Record->push_back(Data.ComputedVisibleConversions);
6213 if (Data.ComputedVisibleConversions)
6214 AddUnresolvedSet(Data.VisibleConversions.get(*Writer->Context));
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00006215 // Data.Definition is the owning decl, no need to write it.
Richard Smith290d8012016-04-06 17:06:00 +00006216 AddDeclRef(D->getFirstFriend());
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00006217
Douglas Gregor99ae8062012-02-14 17:54:36 +00006218 // Add lambda-specific data.
6219 if (Data.IsLambda) {
Richard Smith053f6c62014-05-16 23:01:30 +00006220 auto &Lambda = D->getLambdaData();
Richard Smith290d8012016-04-06 17:06:00 +00006221 Record->push_back(Lambda.Dependent);
6222 Record->push_back(Lambda.IsGenericLambda);
6223 Record->push_back(Lambda.CaptureDefault);
6224 Record->push_back(Lambda.NumCaptures);
6225 Record->push_back(Lambda.NumExplicitCaptures);
6226 Record->push_back(Lambda.ManglingNumber);
Richard Smith0bae6242016-08-25 00:34:00 +00006227 AddDeclRef(D->getLambdaContextDecl());
Richard Smith290d8012016-04-06 17:06:00 +00006228 AddTypeSourceInfo(Lambda.MethodTyInfo);
Douglas Gregor99ae8062012-02-14 17:54:36 +00006229 for (unsigned I = 0, N = Lambda.NumCaptures; I != N; ++I) {
Benjamin Kramerf3ca26982014-05-10 16:31:55 +00006230 const LambdaCapture &Capture = Lambda.Captures[I];
Richard Smith290d8012016-04-06 17:06:00 +00006231 AddSourceLocation(Capture.getLocation());
6232 Record->push_back(Capture.isImplicit());
6233 Record->push_back(Capture.getCaptureKind());
Richard Smithba71c082013-05-16 06:20:58 +00006234 switch (Capture.getCaptureKind()) {
Faisal Validc6b5962016-03-21 09:25:37 +00006235 case LCK_StarThis:
Richard Smithba71c082013-05-16 06:20:58 +00006236 case LCK_This:
Alexey Bataev39c81e22014-08-28 04:28:19 +00006237 case LCK_VLAType:
Richard Smithba71c082013-05-16 06:20:58 +00006238 break;
6239 case LCK_ByCopy:
Richard Smithbb13c9a2013-09-28 04:02:39 +00006240 case LCK_ByRef:
Richard Smithba71c082013-05-16 06:20:58 +00006241 VarDecl *Var =
Craig Toppera13603a2014-05-22 05:54:18 +00006242 Capture.capturesVariable() ? Capture.getCapturedVar() : nullptr;
Richard Smith290d8012016-04-06 17:06:00 +00006243 AddDeclRef(Var);
Richard Smithba71c082013-05-16 06:20:58 +00006244 AddSourceLocation(Capture.isPackExpansion() ? Capture.getEllipsisLoc()
Richard Smith290d8012016-04-06 17:06:00 +00006245 : SourceLocation());
Richard Smithba71c082013-05-16 06:20:58 +00006246 break;
6247 }
Douglas Gregor99ae8062012-02-14 17:54:36 +00006248 }
6249 }
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00006250}
6251
Argyrios Kyrtzidis65ad5692010-10-24 17:26:36 +00006252void ASTWriter::ReaderInitialized(ASTReader *Reader) {
Sebastian Redl07a89a82010-07-30 00:29:29 +00006253 assert(Reader && "Cannot remove chain");
Douglas Gregordf0c1512011-08-18 04:12:04 +00006254 assert((!Chain || Chain == Reader) && "Cannot replace chain");
Sebastian Redl07a89a82010-07-30 00:29:29 +00006255 assert(FirstDeclID == NextDeclID &&
6256 FirstTypeID == NextTypeID &&
6257 FirstIdentID == NextIdentID &&
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00006258 FirstMacroID == NextMacroID &&
Douglas Gregor253eefe2011-12-01 00:59:36 +00006259 FirstSubmoduleID == NextSubmoduleID &&
Sebastian Redld95a56e2010-08-04 18:21:41 +00006260 FirstSelectorID == NextSelectorID &&
Sebastian Redl07a89a82010-07-30 00:29:29 +00006261 "Setting chain after writing has started.");
Douglas Gregor925296b2011-07-19 16:10:42 +00006262
Sebastian Redl07a89a82010-07-30 00:29:29 +00006263 Chain = Reader;
Argyrios Kyrtzidis65ad5692010-10-24 17:26:36 +00006264
Richard Smith7f330cd2015-03-18 01:42:29 +00006265 // Note, this will get called multiple times, once one the reader starts up
6266 // and again each time it's done reading a PCH or module.
Douglas Gregordf0c1512011-08-18 04:12:04 +00006267 FirstDeclID = NUM_PREDEF_DECL_IDS + Chain->getTotalNumDecls();
6268 FirstTypeID = NUM_PREDEF_TYPE_IDS + Chain->getTotalNumTypes();
6269 FirstIdentID = NUM_PREDEF_IDENT_IDS + Chain->getTotalNumIdentifiers();
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00006270 FirstMacroID = NUM_PREDEF_MACRO_IDS + Chain->getTotalNumMacros();
Douglas Gregor253eefe2011-12-01 00:59:36 +00006271 FirstSubmoduleID = NUM_PREDEF_SUBMODULE_IDS + Chain->getTotalNumSubmodules();
Douglas Gregordf0c1512011-08-18 04:12:04 +00006272 FirstSelectorID = NUM_PREDEF_SELECTOR_IDS + Chain->getTotalNumSelectors();
Argyrios Kyrtzidis65ad5692010-10-24 17:26:36 +00006273 NextDeclID = FirstDeclID;
6274 NextTypeID = FirstTypeID;
6275 NextIdentID = FirstIdentID;
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00006276 NextMacroID = FirstMacroID;
Argyrios Kyrtzidis65ad5692010-10-24 17:26:36 +00006277 NextSelectorID = FirstSelectorID;
Douglas Gregor253eefe2011-12-01 00:59:36 +00006278 NextSubmoduleID = FirstSubmoduleID;
Sebastian Redl07a89a82010-07-30 00:29:29 +00006279}
6280
Sebastian Redl539c5062010-08-18 23:57:32 +00006281void ASTWriter::IdentifierRead(IdentID ID, IdentifierInfo *II) {
Douglas Gregor8d7edce2013-02-08 21:30:59 +00006282 // Always keep the highest ID. See \p TypeRead() for more information.
6283 IdentID &StoredID = IdentifierIDs[II];
6284 if (ID > StoredID)
6285 StoredID = ID;
Sebastian Redlff4a2952010-07-23 23:49:55 +00006286}
6287
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00006288void ASTWriter::MacroRead(serialization::MacroID ID, MacroInfo *MI) {
Douglas Gregor8d7edce2013-02-08 21:30:59 +00006289 // Always keep the highest ID. See \p TypeRead() for more information.
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00006290 MacroID &StoredID = MacroIDs[MI];
Douglas Gregor8d7edce2013-02-08 21:30:59 +00006291 if (ID > StoredID)
6292 StoredID = ID;
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00006293}
6294
Argyrios Kyrtzidisbb5c7eae2010-08-20 16:03:59 +00006295void ASTWriter::TypeRead(TypeIdx Idx, QualType T) {
Douglas Gregor9b3932c2010-10-05 18:37:06 +00006296 // Always take the highest-numbered type index. This copes with an interesting
6297 // case for chained AST writing where we schedule writing the type and then,
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00006298 // later, deserialize the type from another AST. In this case, we want to
Douglas Gregor9b3932c2010-10-05 18:37:06 +00006299 // keep the higher-numbered entry so that we can properly write it out to
6300 // the AST file.
6301 TypeIdx &StoredIdx = TypeIdxs[T];
6302 if (Idx.getIndex() >= StoredIdx.getIndex())
6303 StoredIdx = Idx;
Sebastian Redl85b2a6a2010-07-14 23:45:08 +00006304}
6305
Sebastian Redl539c5062010-08-18 23:57:32 +00006306void ASTWriter::SelectorRead(SelectorID ID, Selector S) {
Douglas Gregor8d7edce2013-02-08 21:30:59 +00006307 // Always keep the highest ID. See \p TypeRead() for more information.
6308 SelectorID &StoredID = SelectorIDs[S];
6309 if (ID > StoredID)
6310 StoredID = ID;
Sebastian Redl834bb972010-08-04 17:20:04 +00006311}
Douglas Gregor91096292010-10-02 19:29:26 +00006312
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00006313void ASTWriter::MacroDefinitionRead(serialization::PreprocessedEntityID ID,
Richard Smith66a81862015-05-04 02:25:31 +00006314 MacroDefinitionRecord *MD) {
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00006315 assert(MacroDefinitions.find(MD) == MacroDefinitions.end());
Douglas Gregor91096292010-10-02 19:29:26 +00006316 MacroDefinitions[MD] = ID;
6317}
Argyrios Kyrtzidisd170d842010-10-24 17:26:50 +00006318
Douglas Gregore37a85a2011-12-02 17:30:13 +00006319void ASTWriter::ModuleRead(serialization::SubmoduleID ID, Module *Mod) {
6320 assert(SubmoduleIDs.find(Mod) == SubmoduleIDs.end());
6321 SubmoduleIDs[Mod] = ID;
6322}
6323
Argyrios Kyrtzidisd170d842010-10-24 17:26:50 +00006324void ASTWriter::CompletedTagDefinition(const TagDecl *D) {
Vassil Vassilev19765fb2016-07-22 21:08:24 +00006325 if (Chain && Chain->isProcessingUpdateRecords()) return;
John McCallf937c022011-10-07 06:10:15 +00006326 assert(D->isCompleteDefinition());
Douglas Gregor2fd3d402011-09-17 00:05:03 +00006327 assert(!WritingAST && "Already writing the AST!");
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00006328 if (auto *RD = dyn_cast<CXXRecordDecl>(D)) {
Argyrios Kyrtzidisd170d842010-10-24 17:26:50 +00006329 // We are interested when a PCH decl is modified.
Douglas Gregorb3722e22011-09-09 23:01:35 +00006330 if (RD->isFromASTFile()) {
Argyrios Kyrtzidisd170d842010-10-24 17:26:50 +00006331 // A forward reference was mutated into a definition. Rewrite it.
6332 // FIXME: This happens during template instantiation, should we
6333 // have created a new definition decl instead ?
Richard Smithcd45dbc2014-04-19 03:48:30 +00006334 assert(isTemplateInstantiation(RD->getTemplateSpecializationKind()) &&
6335 "completed a tag from another module but not by instantiation?");
6336 DeclUpdates[RD].push_back(
6337 DeclUpdate(UPD_CXX_INSTANTIATED_CLASS_DEFINITION));
Argyrios Kyrtzidisd170d842010-10-24 17:26:50 +00006338 }
Argyrios Kyrtzidisd170d842010-10-24 17:26:50 +00006339 }
6340}
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00006341
Richard Smithf983f7f2015-10-13 00:23:25 +00006342static bool isImportedDeclContext(ASTReader *Chain, const Decl *D) {
6343 if (D->isFromASTFile())
6344 return true;
6345
Richard Smithf983f7f2015-10-13 00:23:25 +00006346 // The predefined __va_list_tag struct is imported if we imported any decls.
6347 // FIXME: This is a gross hack.
6348 return D == D->getASTContext().getVaListTagDecl();
6349}
6350
Argyrios Kyrtzidis01c2df42010-10-28 07:38:51 +00006351void ASTWriter::AddedVisibleDecl(const DeclContext *DC, const Decl *D) {
Vassil Vassilev19765fb2016-07-22 21:08:24 +00006352 if (Chain && Chain->isProcessingUpdateRecords()) return;
6353 assert(DC->isLookupContext() &&
Vassil Vassilev71eafde2016-04-06 20:56:03 +00006354 "Should not add lookup results to non-lookup contexts!");
6355
Vassil Vassilev632eac32016-03-16 11:17:04 +00006356 // TU is handled elsewhere.
6357 if (isa<TranslationUnitDecl>(DC))
6358 return;
6359
6360 // Namespaces are handled elsewhere, except for template instantiations of
6361 // FunctionTemplateDecls in namespaces. We are interested in cases where the
6362 // local instantiations are added to an imported context. Only happens when
6363 // adding ADL lookup candidates, for example templated friends.
6364 if (isa<NamespaceDecl>(DC) && D->getFriendObjectKind() == Decl::FOK_None &&
6365 !isa<FunctionTemplateDecl>(D))
Argyrios Kyrtzidis01c2df42010-10-28 07:38:51 +00006366 return;
6367
Richard Smithf983f7f2015-10-13 00:23:25 +00006368 // We're only interested in cases where a local declaration is added to an
6369 // imported context.
6370 if (D->isFromASTFile() || !isImportedDeclContext(Chain, cast<Decl>(DC)))
6371 return;
Argyrios Kyrtzidis01c2df42010-10-28 07:38:51 +00006372
Richard Smith0f4e2c42015-08-06 04:23:48 +00006373 assert(DC == DC->getPrimaryContext() && "added to non-primary context");
Douglas Gregor9f782892013-01-21 15:25:38 +00006374 assert(!getDefinitiveDeclContext(DC) && "DeclContext not definitive!");
Richard Smithe9a8bc32014-09-30 00:45:29 +00006375 assert(!WritingAST && "Already writing the AST!");
Richard Smithf983f7f2015-10-13 00:23:25 +00006376 if (UpdatedDeclContexts.insert(DC) && !cast<Decl>(DC)->isFromASTFile()) {
6377 // We're adding a visible declaration to a predefined decl context. Ensure
6378 // that we write out all of its lookup results so we don't get a nasty
6379 // surprise when we try to emit its lookup table.
6380 for (auto *Child : DC->decls())
Richard Smithc26d9742016-10-06 20:30:51 +00006381 DeclsToEmitEvenIfUnreferenced.push_back(Child);
Richard Smithf983f7f2015-10-13 00:23:25 +00006382 }
Richard Smithc26d9742016-10-06 20:30:51 +00006383 DeclsToEmitEvenIfUnreferenced.push_back(D);
Argyrios Kyrtzidis01c2df42010-10-28 07:38:51 +00006384}
Argyrios Kyrtzidise16a5302010-10-24 17:26:54 +00006385
6386void ASTWriter::AddedCXXImplicitMember(const CXXRecordDecl *RD, const Decl *D) {
Vassil Vassilev19765fb2016-07-22 21:08:24 +00006387 if (Chain && Chain->isProcessingUpdateRecords()) return;
Argyrios Kyrtzidise16a5302010-10-24 17:26:54 +00006388 assert(D->isImplicit());
Richard Smithf983f7f2015-10-13 00:23:25 +00006389
6390 // We're only interested in cases where a local declaration is added to an
6391 // imported context.
6392 if (D->isFromASTFile() || !isImportedDeclContext(Chain, RD))
6393 return;
6394
Argyrios Kyrtzidise16a5302010-10-24 17:26:54 +00006395 if (!isa<CXXMethodDecl>(D))
Richard Smithf983f7f2015-10-13 00:23:25 +00006396 return;
Argyrios Kyrtzidise16a5302010-10-24 17:26:54 +00006397
6398 // A decl coming from PCH was modified.
John McCallf937c022011-10-07 06:10:15 +00006399 assert(RD->isCompleteDefinition());
Richard Smithe9a8bc32014-09-30 00:45:29 +00006400 assert(!WritingAST && "Already writing the AST!");
Aaron Ballman4f45b712014-03-21 15:22:56 +00006401 DeclUpdates[RD].push_back(DeclUpdate(UPD_CXX_ADDED_IMPLICIT_MEMBER, D));
Argyrios Kyrtzidise16a5302010-10-24 17:26:54 +00006402}
Argyrios Kyrtzidis402dbbb2010-10-28 07:38:42 +00006403
Richard Smith564417a2014-03-20 21:47:22 +00006404void ASTWriter::ResolvedExceptionSpec(const FunctionDecl *FD) {
Vassil Vassilev19765fb2016-07-22 21:08:24 +00006405 if (Chain && Chain->isProcessingUpdateRecords()) return;
Richard Smith9e2341d2015-03-23 03:25:59 +00006406 assert(!DoneWritingDeclsAndTypes && "Already done writing updates!");
6407 if (!Chain) return;
Richard Smith5fc18a92015-07-12 23:43:21 +00006408 Chain->forEachImportedKeyDecl(FD, [&](const Decl *D) {
Richard Smith9e2341d2015-03-23 03:25:59 +00006409 // If we don't already know the exception specification for this redecl
6410 // chain, add an update record for it.
6411 if (isUnresolvedExceptionSpec(cast<FunctionDecl>(D)
6412 ->getType()
6413 ->castAs<FunctionProtoType>()
6414 ->getExceptionSpecType()))
6415 DeclUpdates[D].push_back(UPD_CXX_RESOLVED_EXCEPTION_SPEC);
6416 });
Richard Smith564417a2014-03-20 21:47:22 +00006417}
6418
Richard Smith1fa5d642013-05-11 05:45:24 +00006419void ASTWriter::DeducedReturnType(const FunctionDecl *FD, QualType ReturnType) {
Vassil Vassilev19765fb2016-07-22 21:08:24 +00006420 if (Chain && Chain->isProcessingUpdateRecords()) return;
Richard Smith1fa5d642013-05-11 05:45:24 +00006421 assert(!WritingAST && "Already writing the AST!");
Richard Smith9e2341d2015-03-23 03:25:59 +00006422 if (!Chain) return;
Richard Smith5fc18a92015-07-12 23:43:21 +00006423 Chain->forEachImportedKeyDecl(FD, [&](const Decl *D) {
Richard Smith9e2341d2015-03-23 03:25:59 +00006424 DeclUpdates[D].push_back(
6425 DeclUpdate(UPD_CXX_DEDUCED_RETURN_TYPE, ReturnType));
6426 });
Richard Smith1fa5d642013-05-11 05:45:24 +00006427}
6428
Richard Smithf8134002015-03-10 01:41:22 +00006429void ASTWriter::ResolvedOperatorDelete(const CXXDestructorDecl *DD,
Richard Smith5b349582017-10-13 01:55:36 +00006430 const FunctionDecl *Delete,
6431 Expr *ThisArg) {
Vassil Vassilev19765fb2016-07-22 21:08:24 +00006432 if (Chain && Chain->isProcessingUpdateRecords()) return;
Richard Smithf8134002015-03-10 01:41:22 +00006433 assert(!WritingAST && "Already writing the AST!");
6434 assert(Delete && "Not given an operator delete");
Richard Smith9e2341d2015-03-23 03:25:59 +00006435 if (!Chain) return;
Richard Smith5fc18a92015-07-12 23:43:21 +00006436 Chain->forEachImportedKeyDecl(DD, [&](const Decl *D) {
Richard Smith9e2341d2015-03-23 03:25:59 +00006437 DeclUpdates[D].push_back(DeclUpdate(UPD_CXX_RESOLVED_DTOR_DELETE, Delete));
6438 });
Richard Smithf8134002015-03-10 01:41:22 +00006439}
6440
Sebastian Redlab238a72011-04-24 16:28:06 +00006441void ASTWriter::CompletedImplicitDefinition(const FunctionDecl *D) {
Vassil Vassilev19765fb2016-07-22 21:08:24 +00006442 if (Chain && Chain->isProcessingUpdateRecords()) return;
Douglas Gregor2fd3d402011-09-17 00:05:03 +00006443 assert(!WritingAST && "Already writing the AST!");
Douglas Gregorb3722e22011-09-09 23:01:35 +00006444 if (!D->isFromASTFile())
Sebastian Redlab238a72011-04-24 16:28:06 +00006445 return; // Declaration not imported from PCH.
6446
Richard Smith4d235792014-08-07 18:53:08 +00006447 // Implicit function decl from a PCH was defined.
6448 DeclUpdates[D].push_back(DeclUpdate(UPD_CXX_ADDED_FUNCTION_DEFINITION));
Sebastian Redlab238a72011-04-24 16:28:06 +00006449}
6450
Richard Smith891fc7f2017-12-05 01:31:47 +00006451void ASTWriter::VariableDefinitionInstantiated(const VarDecl *D) {
6452 if (Chain && Chain->isProcessingUpdateRecords()) return;
6453 assert(!WritingAST && "Already writing the AST!");
6454 if (!D->isFromASTFile())
6455 return;
6456
6457 DeclUpdates[D].push_back(DeclUpdate(UPD_CXX_ADDED_VAR_DEFINITION));
6458}
6459
Richard Smithd28ac5b2014-03-22 23:33:22 +00006460void ASTWriter::FunctionDefinitionInstantiated(const FunctionDecl *D) {
Vassil Vassilev19765fb2016-07-22 21:08:24 +00006461 if (Chain && Chain->isProcessingUpdateRecords()) return;
Richard Smithd28ac5b2014-03-22 23:33:22 +00006462 assert(!WritingAST && "Already writing the AST!");
6463 if (!D->isFromASTFile())
6464 return;
6465
Richard Smith9e2341d2015-03-23 03:25:59 +00006466 DeclUpdates[D].push_back(DeclUpdate(UPD_CXX_ADDED_FUNCTION_DEFINITION));
Richard Smithd28ac5b2014-03-22 23:33:22 +00006467}
6468
Richard Smith891fc7f2017-12-05 01:31:47 +00006469void ASTWriter::InstantiationRequested(const ValueDecl *D) {
Vassil Vassilev19765fb2016-07-22 21:08:24 +00006470 if (Chain && Chain->isProcessingUpdateRecords()) return;
Douglas Gregor2fd3d402011-09-17 00:05:03 +00006471 assert(!WritingAST && "Already writing the AST!");
Douglas Gregorb3722e22011-09-09 23:01:35 +00006472 if (!D->isFromASTFile())
Sebastian Redl2ac2c722011-04-29 08:19:30 +00006473 return;
6474
6475 // Since the actual instantiation is delayed, this really means that we need
6476 // to update the instantiation location.
Richard Smith891fc7f2017-12-05 01:31:47 +00006477 SourceLocation POI;
6478 if (auto *VD = dyn_cast<VarDecl>(D))
6479 POI = VD->getPointOfInstantiation();
6480 else
6481 POI = cast<FunctionDecl>(D)->getPointOfInstantiation();
6482 DeclUpdates[D].push_back(DeclUpdate(UPD_CXX_POINT_OF_INSTANTIATION, POI));
Sebastian Redl2ac2c722011-04-29 08:19:30 +00006483}
6484
John McCall32791cc2016-01-06 22:34:54 +00006485void ASTWriter::DefaultArgumentInstantiated(const ParmVarDecl *D) {
Vassil Vassilev19765fb2016-07-22 21:08:24 +00006486 if (Chain && Chain->isProcessingUpdateRecords()) return;
John McCall32791cc2016-01-06 22:34:54 +00006487 assert(!WritingAST && "Already writing the AST!");
6488 if (!D->isFromASTFile())
6489 return;
6490
6491 DeclUpdates[D].push_back(
6492 DeclUpdate(UPD_CXX_INSTANTIATED_DEFAULT_ARGUMENT, D));
6493}
6494
Richard Smith4b054b22016-08-24 21:25:37 +00006495void ASTWriter::DefaultMemberInitializerInstantiated(const FieldDecl *D) {
6496 assert(!WritingAST && "Already writing the AST!");
6497 if (!D->isFromASTFile())
6498 return;
6499
6500 DeclUpdates[D].push_back(
6501 DeclUpdate(UPD_CXX_INSTANTIATED_DEFAULT_MEMBER_INITIALIZER, D));
6502}
6503
Argyrios Kyrtzidis7d847c92011-09-01 00:58:55 +00006504void ASTWriter::AddedObjCCategoryToInterface(const ObjCCategoryDecl *CatD,
6505 const ObjCInterfaceDecl *IFD) {
Vassil Vassilev19765fb2016-07-22 21:08:24 +00006506 if (Chain && Chain->isProcessingUpdateRecords()) return;
Douglas Gregor2fd3d402011-09-17 00:05:03 +00006507 assert(!WritingAST && "Already writing the AST!");
Douglas Gregorb3722e22011-09-09 23:01:35 +00006508 if (!IFD->isFromASTFile())
Argyrios Kyrtzidis7d847c92011-09-01 00:58:55 +00006509 return; // Declaration not imported from PCH.
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00006510
Douglas Gregor404cdde2012-01-27 01:47:08 +00006511 assert(IFD->getDefinition() && "Category on a class without a definition?");
6512 ObjCClassesWithCategories.insert(
6513 const_cast<ObjCInterfaceDecl *>(IFD->getDefinition()));
Argyrios Kyrtzidis7d847c92011-09-01 00:58:55 +00006514}
Argyrios Kyrtzidisb97a4022011-11-12 21:07:46 +00006515
Eli Friedman276dd182013-09-05 00:02:25 +00006516void ASTWriter::DeclarationMarkedUsed(const Decl *D) {
Vassil Vassilev19765fb2016-07-22 21:08:24 +00006517 if (Chain && Chain->isProcessingUpdateRecords()) return;
Eli Friedman276dd182013-09-05 00:02:25 +00006518 assert(!WritingAST && "Already writing the AST!");
Vassil Vassilev928c8252016-04-28 14:13:28 +00006519
6520 // If there is *any* declaration of the entity that's not from an AST file,
6521 // we can skip writing the update record. We make sure that isUsed() triggers
6522 // completion of the redeclaration chain of the entity.
6523 for (auto Prev = D->getMostRecentDecl(); Prev; Prev = Prev->getPreviousDecl())
6524 if (IsLocalDecl(Prev))
6525 return;
Eli Friedman276dd182013-09-05 00:02:25 +00006526
Aaron Ballman4f45b712014-03-21 15:22:56 +00006527 DeclUpdates[D].push_back(DeclUpdate(UPD_DECL_MARKED_USED));
Eli Friedman276dd182013-09-05 00:02:25 +00006528}
Alexey Bataev97720002014-11-11 04:05:39 +00006529
6530void ASTWriter::DeclarationMarkedOpenMPThreadPrivate(const Decl *D) {
Vassil Vassilev19765fb2016-07-22 21:08:24 +00006531 if (Chain && Chain->isProcessingUpdateRecords()) return;
Alexey Bataev97720002014-11-11 04:05:39 +00006532 assert(!WritingAST && "Already writing the AST!");
6533 if (!D->isFromASTFile())
6534 return;
6535
6536 DeclUpdates[D].push_back(DeclUpdate(UPD_DECL_MARKED_OPENMP_THREADPRIVATE));
6537}
Richard Smith65ebb4a2015-03-26 04:09:53 +00006538
Alexey Bataev25ed0c02019-03-07 17:54:44 +00006539void ASTWriter::DeclarationMarkedOpenMPAllocate(const Decl *D, const Attr *A) {
6540 if (Chain && Chain->isProcessingUpdateRecords()) return;
6541 assert(!WritingAST && "Already writing the AST!");
6542 if (!D->isFromASTFile())
6543 return;
6544
6545 DeclUpdates[D].push_back(DeclUpdate(UPD_DECL_MARKED_OPENMP_ALLOCATE, A));
6546}
6547
Dmitry Polukhind69b5052016-05-09 14:59:13 +00006548void ASTWriter::DeclarationMarkedOpenMPDeclareTarget(const Decl *D,
6549 const Attr *Attr) {
Vassil Vassilev19765fb2016-07-22 21:08:24 +00006550 if (Chain && Chain->isProcessingUpdateRecords()) return;
Dmitry Polukhin0b0da292016-04-06 11:38:59 +00006551 assert(!WritingAST && "Already writing the AST!");
6552 if (!D->isFromASTFile())
6553 return;
6554
Dmitry Polukhind69b5052016-05-09 14:59:13 +00006555 DeclUpdates[D].push_back(
6556 DeclUpdate(UPD_DECL_MARKED_OPENMP_DECLARETARGET, Attr));
Dmitry Polukhin0b0da292016-04-06 11:38:59 +00006557}
6558
Richard Smith4caa4492015-05-15 02:34:32 +00006559void ASTWriter::RedefinedHiddenDefinition(const NamedDecl *D, Module *M) {
Vassil Vassilev19765fb2016-07-22 21:08:24 +00006560 if (Chain && Chain->isProcessingUpdateRecords()) return;
Richard Smith65ebb4a2015-03-26 04:09:53 +00006561 assert(!WritingAST && "Already writing the AST!");
6562 assert(D->isHidden() && "expected a hidden declaration");
Richard Smith4caa4492015-05-15 02:34:32 +00006563 DeclUpdates[D].push_back(DeclUpdate(UPD_DECL_EXPORTED, M));
Richard Smith65ebb4a2015-03-26 04:09:53 +00006564}
Alex Denisovfde64952015-06-26 05:28:36 +00006565
6566void ASTWriter::AddedAttributeToRecord(const Attr *Attr,
6567 const RecordDecl *Record) {
Vassil Vassilev19765fb2016-07-22 21:08:24 +00006568 if (Chain && Chain->isProcessingUpdateRecords()) return;
Alex Denisovfde64952015-06-26 05:28:36 +00006569 assert(!WritingAST && "Already writing the AST!");
6570 if (!Record->isFromASTFile())
6571 return;
6572 DeclUpdates[Record].push_back(DeclUpdate(UPD_ADDED_ATTR_TO_RECORD, Attr));
6573}
Richard Smithc26d9742016-10-06 20:30:51 +00006574
6575void ASTWriter::AddedCXXTemplateSpecialization(
6576 const ClassTemplateDecl *TD, const ClassTemplateSpecializationDecl *D) {
6577 assert(!WritingAST && "Already writing the AST!");
6578
6579 if (!TD->getFirstDecl()->isFromASTFile())
6580 return;
6581 if (Chain && Chain->isProcessingUpdateRecords())
6582 return;
6583
6584 DeclsToEmitEvenIfUnreferenced.push_back(D);
6585}
6586
6587void ASTWriter::AddedCXXTemplateSpecialization(
6588 const VarTemplateDecl *TD, const VarTemplateSpecializationDecl *D) {
6589 assert(!WritingAST && "Already writing the AST!");
6590
6591 if (!TD->getFirstDecl()->isFromASTFile())
6592 return;
6593 if (Chain && Chain->isProcessingUpdateRecords())
6594 return;
6595
6596 DeclsToEmitEvenIfUnreferenced.push_back(D);
6597}
6598
6599void ASTWriter::AddedCXXTemplateSpecialization(const FunctionTemplateDecl *TD,
6600 const FunctionDecl *D) {
6601 assert(!WritingAST && "Already writing the AST!");
6602
6603 if (!TD->getFirstDecl()->isFromASTFile())
6604 return;
6605 if (Chain && Chain->isProcessingUpdateRecords())
6606 return;
6607
6608 DeclsToEmitEvenIfUnreferenced.push_back(D);
6609}
Kelvin Libe286f52018-09-15 13:54:15 +00006610
6611//===----------------------------------------------------------------------===//
6612//// OMPClause Serialization
6613////===----------------------------------------------------------------------===//
6614
6615void OMPClauseWriter::writeClause(OMPClause *C) {
6616 Record.push_back(C->getClauseKind());
6617 Visit(C);
6618 Record.AddSourceLocation(C->getBeginLoc());
6619 Record.AddSourceLocation(C->getEndLoc());
6620}
6621
6622void OMPClauseWriter::VisitOMPClauseWithPreInit(OMPClauseWithPreInit *C) {
6623 Record.push_back(C->getCaptureRegion());
6624 Record.AddStmt(C->getPreInitStmt());
6625}
6626
6627void OMPClauseWriter::VisitOMPClauseWithPostUpdate(OMPClauseWithPostUpdate *C) {
6628 VisitOMPClauseWithPreInit(C);
6629 Record.AddStmt(C->getPostUpdateExpr());
6630}
6631
6632void OMPClauseWriter::VisitOMPIfClause(OMPIfClause *C) {
6633 VisitOMPClauseWithPreInit(C);
6634 Record.push_back(C->getNameModifier());
6635 Record.AddSourceLocation(C->getNameModifierLoc());
6636 Record.AddSourceLocation(C->getColonLoc());
6637 Record.AddStmt(C->getCondition());
6638 Record.AddSourceLocation(C->getLParenLoc());
6639}
6640
6641void OMPClauseWriter::VisitOMPFinalClause(OMPFinalClause *C) {
Alexey Bataev3a842ec2019-10-15 19:37:05 +00006642 VisitOMPClauseWithPreInit(C);
Kelvin Libe286f52018-09-15 13:54:15 +00006643 Record.AddStmt(C->getCondition());
6644 Record.AddSourceLocation(C->getLParenLoc());
6645}
6646
6647void OMPClauseWriter::VisitOMPNumThreadsClause(OMPNumThreadsClause *C) {
6648 VisitOMPClauseWithPreInit(C);
6649 Record.AddStmt(C->getNumThreads());
6650 Record.AddSourceLocation(C->getLParenLoc());
6651}
6652
6653void OMPClauseWriter::VisitOMPSafelenClause(OMPSafelenClause *C) {
6654 Record.AddStmt(C->getSafelen());
6655 Record.AddSourceLocation(C->getLParenLoc());
6656}
6657
6658void OMPClauseWriter::VisitOMPSimdlenClause(OMPSimdlenClause *C) {
6659 Record.AddStmt(C->getSimdlen());
6660 Record.AddSourceLocation(C->getLParenLoc());
6661}
6662
Alexey Bataev9cc10fc2019-03-12 18:52:33 +00006663void OMPClauseWriter::VisitOMPAllocatorClause(OMPAllocatorClause *C) {
6664 Record.AddStmt(C->getAllocator());
6665 Record.AddSourceLocation(C->getLParenLoc());
6666}
6667
Kelvin Libe286f52018-09-15 13:54:15 +00006668void OMPClauseWriter::VisitOMPCollapseClause(OMPCollapseClause *C) {
6669 Record.AddStmt(C->getNumForLoops());
6670 Record.AddSourceLocation(C->getLParenLoc());
6671}
6672
6673void OMPClauseWriter::VisitOMPDefaultClause(OMPDefaultClause *C) {
6674 Record.push_back(C->getDefaultKind());
6675 Record.AddSourceLocation(C->getLParenLoc());
6676 Record.AddSourceLocation(C->getDefaultKindKwLoc());
6677}
6678
6679void OMPClauseWriter::VisitOMPProcBindClause(OMPProcBindClause *C) {
6680 Record.push_back(C->getProcBindKind());
6681 Record.AddSourceLocation(C->getLParenLoc());
6682 Record.AddSourceLocation(C->getProcBindKindKwLoc());
6683}
6684
6685void OMPClauseWriter::VisitOMPScheduleClause(OMPScheduleClause *C) {
6686 VisitOMPClauseWithPreInit(C);
6687 Record.push_back(C->getScheduleKind());
6688 Record.push_back(C->getFirstScheduleModifier());
6689 Record.push_back(C->getSecondScheduleModifier());
6690 Record.AddStmt(C->getChunkSize());
6691 Record.AddSourceLocation(C->getLParenLoc());
6692 Record.AddSourceLocation(C->getFirstScheduleModifierLoc());
6693 Record.AddSourceLocation(C->getSecondScheduleModifierLoc());
6694 Record.AddSourceLocation(C->getScheduleKindLoc());
6695 Record.AddSourceLocation(C->getCommaLoc());
6696}
6697
6698void OMPClauseWriter::VisitOMPOrderedClause(OMPOrderedClause *C) {
6699 Record.push_back(C->getLoopNumIterations().size());
6700 Record.AddStmt(C->getNumForLoops());
6701 for (Expr *NumIter : C->getLoopNumIterations())
6702 Record.AddStmt(NumIter);
6703 for (unsigned I = 0, E = C->getLoopNumIterations().size(); I <E; ++I)
Mike Rice0ed46662018-09-20 17:19:41 +00006704 Record.AddStmt(C->getLoopCounter(I));
Kelvin Libe286f52018-09-15 13:54:15 +00006705 Record.AddSourceLocation(C->getLParenLoc());
6706}
6707
6708void OMPClauseWriter::VisitOMPNowaitClause(OMPNowaitClause *) {}
6709
6710void OMPClauseWriter::VisitOMPUntiedClause(OMPUntiedClause *) {}
6711
6712void OMPClauseWriter::VisitOMPMergeableClause(OMPMergeableClause *) {}
6713
6714void OMPClauseWriter::VisitOMPReadClause(OMPReadClause *) {}
6715
6716void OMPClauseWriter::VisitOMPWriteClause(OMPWriteClause *) {}
6717
6718void OMPClauseWriter::VisitOMPUpdateClause(OMPUpdateClause *) {}
6719
6720void OMPClauseWriter::VisitOMPCaptureClause(OMPCaptureClause *) {}
6721
6722void OMPClauseWriter::VisitOMPSeqCstClause(OMPSeqCstClause *) {}
6723
6724void OMPClauseWriter::VisitOMPThreadsClause(OMPThreadsClause *) {}
6725
6726void OMPClauseWriter::VisitOMPSIMDClause(OMPSIMDClause *) {}
6727
6728void OMPClauseWriter::VisitOMPNogroupClause(OMPNogroupClause *) {}
6729
6730void OMPClauseWriter::VisitOMPPrivateClause(OMPPrivateClause *C) {
6731 Record.push_back(C->varlist_size());
6732 Record.AddSourceLocation(C->getLParenLoc());
6733 for (auto *VE : C->varlists()) {
6734 Record.AddStmt(VE);
6735 }
6736 for (auto *VE : C->private_copies()) {
6737 Record.AddStmt(VE);
6738 }
6739}
6740
6741void OMPClauseWriter::VisitOMPFirstprivateClause(OMPFirstprivateClause *C) {
6742 Record.push_back(C->varlist_size());
6743 VisitOMPClauseWithPreInit(C);
6744 Record.AddSourceLocation(C->getLParenLoc());
6745 for (auto *VE : C->varlists()) {
6746 Record.AddStmt(VE);
6747 }
6748 for (auto *VE : C->private_copies()) {
6749 Record.AddStmt(VE);
6750 }
6751 for (auto *VE : C->inits()) {
6752 Record.AddStmt(VE);
6753 }
6754}
6755
6756void OMPClauseWriter::VisitOMPLastprivateClause(OMPLastprivateClause *C) {
6757 Record.push_back(C->varlist_size());
6758 VisitOMPClauseWithPostUpdate(C);
6759 Record.AddSourceLocation(C->getLParenLoc());
6760 for (auto *VE : C->varlists())
6761 Record.AddStmt(VE);
6762 for (auto *E : C->private_copies())
6763 Record.AddStmt(E);
6764 for (auto *E : C->source_exprs())
6765 Record.AddStmt(E);
6766 for (auto *E : C->destination_exprs())
6767 Record.AddStmt(E);
6768 for (auto *E : C->assignment_ops())
6769 Record.AddStmt(E);
6770}
6771
6772void OMPClauseWriter::VisitOMPSharedClause(OMPSharedClause *C) {
6773 Record.push_back(C->varlist_size());
6774 Record.AddSourceLocation(C->getLParenLoc());
6775 for (auto *VE : C->varlists())
6776 Record.AddStmt(VE);
6777}
6778
6779void OMPClauseWriter::VisitOMPReductionClause(OMPReductionClause *C) {
6780 Record.push_back(C->varlist_size());
6781 VisitOMPClauseWithPostUpdate(C);
6782 Record.AddSourceLocation(C->getLParenLoc());
6783 Record.AddSourceLocation(C->getColonLoc());
6784 Record.AddNestedNameSpecifierLoc(C->getQualifierLoc());
6785 Record.AddDeclarationNameInfo(C->getNameInfo());
6786 for (auto *VE : C->varlists())
6787 Record.AddStmt(VE);
6788 for (auto *VE : C->privates())
6789 Record.AddStmt(VE);
6790 for (auto *E : C->lhs_exprs())
6791 Record.AddStmt(E);
6792 for (auto *E : C->rhs_exprs())
6793 Record.AddStmt(E);
6794 for (auto *E : C->reduction_ops())
6795 Record.AddStmt(E);
6796}
6797
6798void OMPClauseWriter::VisitOMPTaskReductionClause(OMPTaskReductionClause *C) {
6799 Record.push_back(C->varlist_size());
6800 VisitOMPClauseWithPostUpdate(C);
6801 Record.AddSourceLocation(C->getLParenLoc());
6802 Record.AddSourceLocation(C->getColonLoc());
6803 Record.AddNestedNameSpecifierLoc(C->getQualifierLoc());
6804 Record.AddDeclarationNameInfo(C->getNameInfo());
6805 for (auto *VE : C->varlists())
6806 Record.AddStmt(VE);
6807 for (auto *VE : C->privates())
6808 Record.AddStmt(VE);
6809 for (auto *E : C->lhs_exprs())
6810 Record.AddStmt(E);
6811 for (auto *E : C->rhs_exprs())
6812 Record.AddStmt(E);
6813 for (auto *E : C->reduction_ops())
6814 Record.AddStmt(E);
6815}
6816
6817void OMPClauseWriter::VisitOMPInReductionClause(OMPInReductionClause *C) {
6818 Record.push_back(C->varlist_size());
6819 VisitOMPClauseWithPostUpdate(C);
6820 Record.AddSourceLocation(C->getLParenLoc());
6821 Record.AddSourceLocation(C->getColonLoc());
6822 Record.AddNestedNameSpecifierLoc(C->getQualifierLoc());
6823 Record.AddDeclarationNameInfo(C->getNameInfo());
6824 for (auto *VE : C->varlists())
6825 Record.AddStmt(VE);
6826 for (auto *VE : C->privates())
6827 Record.AddStmt(VE);
6828 for (auto *E : C->lhs_exprs())
6829 Record.AddStmt(E);
6830 for (auto *E : C->rhs_exprs())
6831 Record.AddStmt(E);
6832 for (auto *E : C->reduction_ops())
6833 Record.AddStmt(E);
6834 for (auto *E : C->taskgroup_descriptors())
6835 Record.AddStmt(E);
6836}
6837
6838void OMPClauseWriter::VisitOMPLinearClause(OMPLinearClause *C) {
6839 Record.push_back(C->varlist_size());
6840 VisitOMPClauseWithPostUpdate(C);
6841 Record.AddSourceLocation(C->getLParenLoc());
6842 Record.AddSourceLocation(C->getColonLoc());
6843 Record.push_back(C->getModifier());
6844 Record.AddSourceLocation(C->getModifierLoc());
6845 for (auto *VE : C->varlists()) {
6846 Record.AddStmt(VE);
6847 }
6848 for (auto *VE : C->privates()) {
6849 Record.AddStmt(VE);
6850 }
6851 for (auto *VE : C->inits()) {
6852 Record.AddStmt(VE);
6853 }
6854 for (auto *VE : C->updates()) {
6855 Record.AddStmt(VE);
6856 }
6857 for (auto *VE : C->finals()) {
6858 Record.AddStmt(VE);
6859 }
6860 Record.AddStmt(C->getStep());
6861 Record.AddStmt(C->getCalcStep());
Alexey Bataev195ae902019-08-08 13:42:45 +00006862 for (auto *VE : C->used_expressions())
6863 Record.AddStmt(VE);
Kelvin Libe286f52018-09-15 13:54:15 +00006864}
6865
6866void OMPClauseWriter::VisitOMPAlignedClause(OMPAlignedClause *C) {
6867 Record.push_back(C->varlist_size());
6868 Record.AddSourceLocation(C->getLParenLoc());
6869 Record.AddSourceLocation(C->getColonLoc());
6870 for (auto *VE : C->varlists())
6871 Record.AddStmt(VE);
6872 Record.AddStmt(C->getAlignment());
6873}
6874
6875void OMPClauseWriter::VisitOMPCopyinClause(OMPCopyinClause *C) {
6876 Record.push_back(C->varlist_size());
6877 Record.AddSourceLocation(C->getLParenLoc());
6878 for (auto *VE : C->varlists())
6879 Record.AddStmt(VE);
6880 for (auto *E : C->source_exprs())
6881 Record.AddStmt(E);
6882 for (auto *E : C->destination_exprs())
6883 Record.AddStmt(E);
6884 for (auto *E : C->assignment_ops())
6885 Record.AddStmt(E);
6886}
6887
6888void OMPClauseWriter::VisitOMPCopyprivateClause(OMPCopyprivateClause *C) {
6889 Record.push_back(C->varlist_size());
6890 Record.AddSourceLocation(C->getLParenLoc());
6891 for (auto *VE : C->varlists())
6892 Record.AddStmt(VE);
6893 for (auto *E : C->source_exprs())
6894 Record.AddStmt(E);
6895 for (auto *E : C->destination_exprs())
6896 Record.AddStmt(E);
6897 for (auto *E : C->assignment_ops())
6898 Record.AddStmt(E);
6899}
6900
6901void OMPClauseWriter::VisitOMPFlushClause(OMPFlushClause *C) {
6902 Record.push_back(C->varlist_size());
6903 Record.AddSourceLocation(C->getLParenLoc());
6904 for (auto *VE : C->varlists())
6905 Record.AddStmt(VE);
6906}
6907
6908void OMPClauseWriter::VisitOMPDependClause(OMPDependClause *C) {
6909 Record.push_back(C->varlist_size());
6910 Record.push_back(C->getNumLoops());
6911 Record.AddSourceLocation(C->getLParenLoc());
6912 Record.push_back(C->getDependencyKind());
6913 Record.AddSourceLocation(C->getDependencyLoc());
6914 Record.AddSourceLocation(C->getColonLoc());
6915 for (auto *VE : C->varlists())
6916 Record.AddStmt(VE);
6917 for (unsigned I = 0, E = C->getNumLoops(); I < E; ++I)
6918 Record.AddStmt(C->getLoopData(I));
6919}
6920
6921void OMPClauseWriter::VisitOMPDeviceClause(OMPDeviceClause *C) {
6922 VisitOMPClauseWithPreInit(C);
6923 Record.AddStmt(C->getDevice());
6924 Record.AddSourceLocation(C->getLParenLoc());
6925}
6926
6927void OMPClauseWriter::VisitOMPMapClause(OMPMapClause *C) {
6928 Record.push_back(C->varlist_size());
6929 Record.push_back(C->getUniqueDeclarationsNum());
6930 Record.push_back(C->getTotalComponentListNum());
6931 Record.push_back(C->getTotalComponentsNum());
6932 Record.AddSourceLocation(C->getLParenLoc());
Kelvin Lief579432018-12-18 22:18:41 +00006933 for (unsigned I = 0; I < OMPMapClause::NumberOfModifiers; ++I) {
6934 Record.push_back(C->getMapTypeModifier(I));
6935 Record.AddSourceLocation(C->getMapTypeModifierLoc(I));
6936 }
Michael Kruse4304e9d2019-02-19 16:38:20 +00006937 Record.AddNestedNameSpecifierLoc(C->getMapperQualifierLoc());
6938 Record.AddDeclarationNameInfo(C->getMapperIdInfo());
Kelvin Libe286f52018-09-15 13:54:15 +00006939 Record.push_back(C->getMapType());
6940 Record.AddSourceLocation(C->getMapLoc());
6941 Record.AddSourceLocation(C->getColonLoc());
6942 for (auto *E : C->varlists())
6943 Record.AddStmt(E);
Michael Kruse4304e9d2019-02-19 16:38:20 +00006944 for (auto *E : C->mapperlists())
6945 Record.AddStmt(E);
Kelvin Libe286f52018-09-15 13:54:15 +00006946 for (auto *D : C->all_decls())
6947 Record.AddDeclRef(D);
6948 for (auto N : C->all_num_lists())
6949 Record.push_back(N);
6950 for (auto N : C->all_lists_sizes())
6951 Record.push_back(N);
6952 for (auto &M : C->all_components()) {
6953 Record.AddStmt(M.getAssociatedExpression());
6954 Record.AddDeclRef(M.getAssociatedDeclaration());
6955 }
6956}
6957
Alexey Bataeve04483e2019-03-27 14:14:31 +00006958void OMPClauseWriter::VisitOMPAllocateClause(OMPAllocateClause *C) {
6959 Record.push_back(C->varlist_size());
6960 Record.AddSourceLocation(C->getLParenLoc());
6961 Record.AddSourceLocation(C->getColonLoc());
6962 Record.AddStmt(C->getAllocator());
6963 for (auto *VE : C->varlists())
6964 Record.AddStmt(VE);
6965}
6966
Kelvin Libe286f52018-09-15 13:54:15 +00006967void OMPClauseWriter::VisitOMPNumTeamsClause(OMPNumTeamsClause *C) {
6968 VisitOMPClauseWithPreInit(C);
6969 Record.AddStmt(C->getNumTeams());
6970 Record.AddSourceLocation(C->getLParenLoc());
6971}
6972
6973void OMPClauseWriter::VisitOMPThreadLimitClause(OMPThreadLimitClause *C) {
6974 VisitOMPClauseWithPreInit(C);
6975 Record.AddStmt(C->getThreadLimit());
6976 Record.AddSourceLocation(C->getLParenLoc());
6977}
6978
6979void OMPClauseWriter::VisitOMPPriorityClause(OMPPriorityClause *C) {
6980 Record.AddStmt(C->getPriority());
6981 Record.AddSourceLocation(C->getLParenLoc());
6982}
6983
6984void OMPClauseWriter::VisitOMPGrainsizeClause(OMPGrainsizeClause *C) {
Alexey Bataevb9c55e22019-10-14 19:29:52 +00006985 VisitOMPClauseWithPreInit(C);
Kelvin Libe286f52018-09-15 13:54:15 +00006986 Record.AddStmt(C->getGrainsize());
6987 Record.AddSourceLocation(C->getLParenLoc());
6988}
6989
6990void OMPClauseWriter::VisitOMPNumTasksClause(OMPNumTasksClause *C) {
Alexey Bataevd88c7de2019-10-14 20:44:34 +00006991 VisitOMPClauseWithPreInit(C);
Kelvin Libe286f52018-09-15 13:54:15 +00006992 Record.AddStmt(C->getNumTasks());
6993 Record.AddSourceLocation(C->getLParenLoc());
6994}
6995
6996void OMPClauseWriter::VisitOMPHintClause(OMPHintClause *C) {
6997 Record.AddStmt(C->getHint());
6998 Record.AddSourceLocation(C->getLParenLoc());
6999}
7000
7001void OMPClauseWriter::VisitOMPDistScheduleClause(OMPDistScheduleClause *C) {
7002 VisitOMPClauseWithPreInit(C);
7003 Record.push_back(C->getDistScheduleKind());
7004 Record.AddStmt(C->getChunkSize());
7005 Record.AddSourceLocation(C->getLParenLoc());
7006 Record.AddSourceLocation(C->getDistScheduleKindLoc());
7007 Record.AddSourceLocation(C->getCommaLoc());
7008}
7009
7010void OMPClauseWriter::VisitOMPDefaultmapClause(OMPDefaultmapClause *C) {
7011 Record.push_back(C->getDefaultmapKind());
7012 Record.push_back(C->getDefaultmapModifier());
7013 Record.AddSourceLocation(C->getLParenLoc());
7014 Record.AddSourceLocation(C->getDefaultmapModifierLoc());
7015 Record.AddSourceLocation(C->getDefaultmapKindLoc());
7016}
7017
7018void OMPClauseWriter::VisitOMPToClause(OMPToClause *C) {
7019 Record.push_back(C->varlist_size());
7020 Record.push_back(C->getUniqueDeclarationsNum());
7021 Record.push_back(C->getTotalComponentListNum());
7022 Record.push_back(C->getTotalComponentsNum());
7023 Record.AddSourceLocation(C->getLParenLoc());
Michael Kruse01f670d2019-02-22 22:29:42 +00007024 Record.AddNestedNameSpecifierLoc(C->getMapperQualifierLoc());
7025 Record.AddDeclarationNameInfo(C->getMapperIdInfo());
Kelvin Libe286f52018-09-15 13:54:15 +00007026 for (auto *E : C->varlists())
7027 Record.AddStmt(E);
Michael Kruse01f670d2019-02-22 22:29:42 +00007028 for (auto *E : C->mapperlists())
7029 Record.AddStmt(E);
Kelvin Libe286f52018-09-15 13:54:15 +00007030 for (auto *D : C->all_decls())
7031 Record.AddDeclRef(D);
7032 for (auto N : C->all_num_lists())
7033 Record.push_back(N);
7034 for (auto N : C->all_lists_sizes())
7035 Record.push_back(N);
7036 for (auto &M : C->all_components()) {
7037 Record.AddStmt(M.getAssociatedExpression());
7038 Record.AddDeclRef(M.getAssociatedDeclaration());
7039 }
7040}
7041
7042void OMPClauseWriter::VisitOMPFromClause(OMPFromClause *C) {
7043 Record.push_back(C->varlist_size());
7044 Record.push_back(C->getUniqueDeclarationsNum());
7045 Record.push_back(C->getTotalComponentListNum());
7046 Record.push_back(C->getTotalComponentsNum());
7047 Record.AddSourceLocation(C->getLParenLoc());
Michael Kruse0336c752019-02-25 20:34:15 +00007048 Record.AddNestedNameSpecifierLoc(C->getMapperQualifierLoc());
7049 Record.AddDeclarationNameInfo(C->getMapperIdInfo());
Kelvin Libe286f52018-09-15 13:54:15 +00007050 for (auto *E : C->varlists())
7051 Record.AddStmt(E);
Michael Kruse0336c752019-02-25 20:34:15 +00007052 for (auto *E : C->mapperlists())
7053 Record.AddStmt(E);
Kelvin Libe286f52018-09-15 13:54:15 +00007054 for (auto *D : C->all_decls())
7055 Record.AddDeclRef(D);
7056 for (auto N : C->all_num_lists())
7057 Record.push_back(N);
7058 for (auto N : C->all_lists_sizes())
7059 Record.push_back(N);
7060 for (auto &M : C->all_components()) {
7061 Record.AddStmt(M.getAssociatedExpression());
7062 Record.AddDeclRef(M.getAssociatedDeclaration());
7063 }
7064}
7065
7066void OMPClauseWriter::VisitOMPUseDevicePtrClause(OMPUseDevicePtrClause *C) {
7067 Record.push_back(C->varlist_size());
7068 Record.push_back(C->getUniqueDeclarationsNum());
7069 Record.push_back(C->getTotalComponentListNum());
7070 Record.push_back(C->getTotalComponentsNum());
7071 Record.AddSourceLocation(C->getLParenLoc());
7072 for (auto *E : C->varlists())
7073 Record.AddStmt(E);
7074 for (auto *VE : C->private_copies())
7075 Record.AddStmt(VE);
7076 for (auto *VE : C->inits())
7077 Record.AddStmt(VE);
7078 for (auto *D : C->all_decls())
7079 Record.AddDeclRef(D);
7080 for (auto N : C->all_num_lists())
7081 Record.push_back(N);
7082 for (auto N : C->all_lists_sizes())
7083 Record.push_back(N);
7084 for (auto &M : C->all_components()) {
7085 Record.AddStmt(M.getAssociatedExpression());
7086 Record.AddDeclRef(M.getAssociatedDeclaration());
7087 }
7088}
7089
7090void OMPClauseWriter::VisitOMPIsDevicePtrClause(OMPIsDevicePtrClause *C) {
7091 Record.push_back(C->varlist_size());
7092 Record.push_back(C->getUniqueDeclarationsNum());
7093 Record.push_back(C->getTotalComponentListNum());
7094 Record.push_back(C->getTotalComponentsNum());
7095 Record.AddSourceLocation(C->getLParenLoc());
7096 for (auto *E : C->varlists())
7097 Record.AddStmt(E);
7098 for (auto *D : C->all_decls())
7099 Record.AddDeclRef(D);
7100 for (auto N : C->all_num_lists())
7101 Record.push_back(N);
7102 for (auto N : C->all_lists_sizes())
7103 Record.push_back(N);
7104 for (auto &M : C->all_components()) {
7105 Record.AddStmt(M.getAssociatedExpression());
7106 Record.AddDeclRef(M.getAssociatedDeclaration());
7107 }
7108}
Kelvin Li1408f912018-09-26 04:28:39 +00007109
7110void OMPClauseWriter::VisitOMPUnifiedAddressClause(OMPUnifiedAddressClause *) {}
Patrick Lyster4a370b92018-10-01 13:47:43 +00007111
7112void OMPClauseWriter::VisitOMPUnifiedSharedMemoryClause(
7113 OMPUnifiedSharedMemoryClause *) {}
Patrick Lyster6bdf63b2018-10-03 20:07:58 +00007114
7115void OMPClauseWriter::VisitOMPReverseOffloadClause(OMPReverseOffloadClause *) {}
Patrick Lyster3fe9e392018-10-11 14:41:10 +00007116
7117void
7118OMPClauseWriter::VisitOMPDynamicAllocatorsClause(OMPDynamicAllocatorsClause *) {
7119}
Patrick Lyster7a2a27c2018-11-02 12:18:11 +00007120
7121void OMPClauseWriter::VisitOMPAtomicDefaultMemOrderClause(
7122 OMPAtomicDefaultMemOrderClause *C) {
7123 Record.push_back(C->getAtomicDefaultMemOrderKind());
7124 Record.AddSourceLocation(C->getLParenLoc());
7125 Record.AddSourceLocation(C->getAtomicDefaultMemOrderKindKwLoc());
7126}