blob: 2d0a643877c284ae04b998af6af2fcac8b037e3d [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);
1102
Douglas Gregor0aa21c92012-10-18 18:27:37 +00001103 // AST Top-Level Block.
1104 BLOCK(AST_BLOCK);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001105 RECORD(TYPE_OFFSET);
1106 RECORD(DECL_OFFSET);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001107 RECORD(IDENTIFIER_OFFSET);
1108 RECORD(IDENTIFIER_TABLE);
Ben Langmuir332aafe2014-01-31 01:06:56 +00001109 RECORD(EAGERLY_DESERIALIZED_DECLS);
David Blaikie9ffe5a32017-01-30 05:00:26 +00001110 RECORD(MODULAR_CODEGEN_DECLS);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001111 RECORD(SPECIAL_TYPES);
1112 RECORD(STATISTICS);
1113 RECORD(TENTATIVE_DEFINITIONS);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001114 RECORD(SELECTOR_OFFSETS);
1115 RECORD(METHOD_POOL);
1116 RECORD(PP_COUNTER_VALUE);
Douglas Gregor258ae542009-04-27 06:38:32 +00001117 RECORD(SOURCE_LOCATION_OFFSETS);
1118 RECORD(SOURCE_LOCATION_PRELOADS);
Douglas Gregor61cac2b2009-04-27 20:06:05 +00001119 RECORD(EXT_VECTOR_DECLS);
Richard Smithfa715652015-08-31 22:43:10 +00001120 RECORD(UNUSED_FILESCOPED_DECLS);
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00001121 RECORD(PPD_ENTITIES_OFFSETS);
Richard Smithfa715652015-08-31 22:43:10 +00001122 RECORD(VTABLE_USES);
Cameron Desrochersb60f1b62018-01-15 19:14:16 +00001123 RECORD(PPD_SKIPPED_RANGES);
Fariborz Jahanianc51609a2010-07-23 19:11:11 +00001124 RECORD(REFERENCED_SELECTOR_POOL);
Douglas Gregor0beaec02011-02-08 16:34:17 +00001125 RECORD(TU_UPDATE_LEXICAL);
Douglas Gregor0beaec02011-02-08 16:34:17 +00001126 RECORD(SEMA_DECL_REFS);
1127 RECORD(WEAK_UNDECLARED_IDENTIFIERS);
1128 RECORD(PENDING_IMPLICIT_INSTANTIATIONS);
Douglas Gregor0beaec02011-02-08 16:34:17 +00001129 RECORD(UPDATE_VISIBLE);
1130 RECORD(DECL_UPDATE_OFFSETS);
1131 RECORD(DECL_UPDATES);
Peter Collingbourne5df20e02011-02-15 19:46:30 +00001132 RECORD(CUDA_SPECIAL_DECL_REFS);
Douglas Gregor09b69892011-02-10 17:09:37 +00001133 RECORD(HEADER_SEARCH_TABLE);
Peter Collingbourne5df20e02011-02-15 19:46:30 +00001134 RECORD(FP_PRAGMA_OPTIONS);
1135 RECORD(OPENCL_EXTENSIONS);
Yaxun Liu5b746652016-12-18 05:18:55 +00001136 RECORD(OPENCL_EXTENSION_TYPES);
1137 RECORD(OPENCL_EXTENSION_DECLS);
Alexis Hunt27a761d2011-05-04 23:29:54 +00001138 RECORD(DELEGATING_CTORS);
Douglas Gregorc2fa1692011-06-28 16:20:02 +00001139 RECORD(KNOWN_NAMESPACES);
Douglas Gregor78d0b572011-08-04 16:39:39 +00001140 RECORD(MODULE_OFFSET_MAP);
1141 RECORD(SOURCE_MANAGER_LINE_TABLE);
Douglas Gregor404cdde2012-01-27 01:47:08 +00001142 RECORD(OBJC_CATEGORIES_MAP);
Douglas Gregor66e4add2011-12-19 21:09:25 +00001143 RECORD(FILE_SORTED_DECLS);
1144 RECORD(IMPORTED_MODULES);
Douglas Gregor404cdde2012-01-27 01:47:08 +00001145 RECORD(OBJC_CATEGORIES);
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00001146 RECORD(MACRO_OFFSET);
Richard Smithfa715652015-08-31 22:43:10 +00001147 RECORD(INTERESTING_IDENTIFIERS);
1148 RECORD(UNDEFINED_BUT_USED);
Richard Smithe40f2ba2013-08-07 21:41:30 +00001149 RECORD(LATE_PARSED_TEMPLATE);
Dario Domizioli13a0a382014-05-23 12:13:25 +00001150 RECORD(OPTIMIZE_PRAGMA_OPTIONS);
Nico Weber779355f2016-03-02 23:22:00 +00001151 RECORD(MSSTRUCT_PRAGMA_OPTIONS);
Nico Weber42932312016-03-03 00:17:35 +00001152 RECORD(POINTERS_TO_MEMBERS_PRAGMA_OPTIONS);
Richard Smithfa715652015-08-31 22:43:10 +00001153 RECORD(UNUSED_LOCAL_TYPEDEF_NAME_CANDIDATES);
Richard Smithfa715652015-08-31 22:43:10 +00001154 RECORD(DELETE_EXPRS_TO_ANALYZE);
Justin Lebar67a78a62016-10-08 22:15:58 +00001155 RECORD(CUDA_PRAGMA_FORCE_HOST_DEVICE_DEPTH);
Erik Verbruggenb34c79f2017-05-30 11:54:55 +00001156 RECORD(PP_CONDITIONAL_STACK);
Douglas Gregor358cd442012-01-15 16:58:34 +00001157
Chris Lattner28fa4e62009-04-26 22:26:21 +00001158 // SourceManager Block.
Chris Lattner64031982009-04-27 00:40:25 +00001159 BLOCK(SOURCE_MANAGER_BLOCK);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001160 RECORD(SM_SLOC_FILE_ENTRY);
1161 RECORD(SM_SLOC_BUFFER_ENTRY);
1162 RECORD(SM_SLOC_BUFFER_BLOB);
Richard Smithaada85c2016-02-06 02:06:43 +00001163 RECORD(SM_SLOC_BUFFER_BLOB_COMPRESSED);
Chandler Carruthf92ac9e2011-07-15 07:25:21 +00001164 RECORD(SM_SLOC_EXPANSION_ENTRY);
Mike Stump11289f42009-09-09 15:08:12 +00001165
Chris Lattner28fa4e62009-04-26 22:26:21 +00001166 // Preprocessor Block.
Chris Lattner64031982009-04-27 00:40:25 +00001167 BLOCK(PREPROCESSOR_BLOCK);
Richard Smithec216502015-02-13 19:48:37 +00001168 RECORD(PP_MACRO_DIRECTIVE_HISTORY);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001169 RECORD(PP_MACRO_FUNCTION_LIKE);
Richard Smithd7329392015-04-21 21:46:32 +00001170 RECORD(PP_MACRO_OBJECT_LIKE);
1171 RECORD(PP_MODULE_MACRO);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001172 RECORD(PP_TOKEN);
Richard Smithec216502015-02-13 19:48:37 +00001173
Richard Smithfa715652015-08-31 22:43:10 +00001174 // Submodule Block.
1175 BLOCK(SUBMODULE_BLOCK);
1176 RECORD(SUBMODULE_METADATA);
1177 RECORD(SUBMODULE_DEFINITION);
1178 RECORD(SUBMODULE_UMBRELLA_HEADER);
1179 RECORD(SUBMODULE_HEADER);
1180 RECORD(SUBMODULE_TOPHEADER);
1181 RECORD(SUBMODULE_UMBRELLA_DIR);
1182 RECORD(SUBMODULE_IMPORTS);
1183 RECORD(SUBMODULE_EXPORTS);
1184 RECORD(SUBMODULE_REQUIRES);
1185 RECORD(SUBMODULE_EXCLUDED_HEADER);
1186 RECORD(SUBMODULE_LINK_LIBRARY);
1187 RECORD(SUBMODULE_CONFIG_MACRO);
1188 RECORD(SUBMODULE_CONFLICT);
1189 RECORD(SUBMODULE_PRIVATE_HEADER);
1190 RECORD(SUBMODULE_TEXTUAL_HEADER);
1191 RECORD(SUBMODULE_PRIVATE_TEXTUAL_HEADER);
Richard Smithdc1f0422016-07-20 19:10:16 +00001192 RECORD(SUBMODULE_INITIALIZERS);
Douglas Gregorf0b11de2017-09-14 23:38:44 +00001193 RECORD(SUBMODULE_EXPORT_AS);
Richard Smithfa715652015-08-31 22:43:10 +00001194
1195 // Comments Block.
1196 BLOCK(COMMENTS_BLOCK);
1197 RECORD(COMMENTS_RAW_COMMENT);
1198
Douglas Gregor12bfa382009-10-17 00:13:19 +00001199 // Decls and Types block.
1200 BLOCK(DECLTYPES_BLOCK);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001201 RECORD(TYPE_EXT_QUAL);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001202 RECORD(TYPE_COMPLEX);
1203 RECORD(TYPE_POINTER);
1204 RECORD(TYPE_BLOCK_POINTER);
1205 RECORD(TYPE_LVALUE_REFERENCE);
1206 RECORD(TYPE_RVALUE_REFERENCE);
1207 RECORD(TYPE_MEMBER_POINTER);
1208 RECORD(TYPE_CONSTANT_ARRAY);
1209 RECORD(TYPE_INCOMPLETE_ARRAY);
1210 RECORD(TYPE_VARIABLE_ARRAY);
1211 RECORD(TYPE_VECTOR);
1212 RECORD(TYPE_EXT_VECTOR);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001213 RECORD(TYPE_FUNCTION_NO_PROTO);
Richard Smithf1b4b8b2014-07-27 04:29:04 +00001214 RECORD(TYPE_FUNCTION_PROTO);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001215 RECORD(TYPE_TYPEDEF);
1216 RECORD(TYPE_TYPEOF_EXPR);
1217 RECORD(TYPE_TYPEOF);
1218 RECORD(TYPE_RECORD);
1219 RECORD(TYPE_ENUM);
1220 RECORD(TYPE_OBJC_INTERFACE);
Steve Narofffb4330f2009-06-17 22:40:22 +00001221 RECORD(TYPE_OBJC_OBJECT_POINTER);
Douglas Gregor0beaec02011-02-08 16:34:17 +00001222 RECORD(TYPE_DECLTYPE);
1223 RECORD(TYPE_ELABORATED);
1224 RECORD(TYPE_SUBST_TEMPLATE_TYPE_PARM);
1225 RECORD(TYPE_UNRESOLVED_USING);
1226 RECORD(TYPE_INJECTED_CLASS_NAME);
1227 RECORD(TYPE_OBJC_OBJECT);
1228 RECORD(TYPE_TEMPLATE_TYPE_PARM);
1229 RECORD(TYPE_TEMPLATE_SPECIALIZATION);
1230 RECORD(TYPE_DEPENDENT_NAME);
1231 RECORD(TYPE_DEPENDENT_TEMPLATE_SPECIALIZATION);
1232 RECORD(TYPE_DEPENDENT_SIZED_ARRAY);
1233 RECORD(TYPE_PAREN);
Leonard Chanc72aaf62019-05-07 03:20:17 +00001234 RECORD(TYPE_MACRO_QUALIFIED);
Douglas Gregor0beaec02011-02-08 16:34:17 +00001235 RECORD(TYPE_PACK_EXPANSION);
1236 RECORD(TYPE_ATTRIBUTED);
1237 RECORD(TYPE_SUBST_TEMPLATE_TYPE_PARM_PACK);
Richard Smithf1b4b8b2014-07-27 04:29:04 +00001238 RECORD(TYPE_AUTO);
1239 RECORD(TYPE_UNARY_TRANSFORM);
Eli Friedman0dfb8892011-10-06 23:00:33 +00001240 RECORD(TYPE_ATOMIC);
Richard Smithf1b4b8b2014-07-27 04:29:04 +00001241 RECORD(TYPE_DECAYED);
1242 RECORD(TYPE_ADJUSTED);
Manman Rene6be26c2016-09-13 17:25:08 +00001243 RECORD(TYPE_OBJC_TYPE_PARAM);
Richard Smithd61d4ac2015-08-22 20:13:39 +00001244 RECORD(LOCAL_REDECLARATIONS);
Chris Lattnerdb397b62009-04-26 22:32:16 +00001245 RECORD(DECL_TYPEDEF);
Richard Smith01b2cb42014-07-26 06:37:51 +00001246 RECORD(DECL_TYPEALIAS);
Chris Lattnerdb397b62009-04-26 22:32:16 +00001247 RECORD(DECL_ENUM);
1248 RECORD(DECL_RECORD);
1249 RECORD(DECL_ENUM_CONSTANT);
1250 RECORD(DECL_FUNCTION);
1251 RECORD(DECL_OBJC_METHOD);
1252 RECORD(DECL_OBJC_INTERFACE);
1253 RECORD(DECL_OBJC_PROTOCOL);
1254 RECORD(DECL_OBJC_IVAR);
1255 RECORD(DECL_OBJC_AT_DEFS_FIELD);
Chris Lattnerdb397b62009-04-26 22:32:16 +00001256 RECORD(DECL_OBJC_CATEGORY);
1257 RECORD(DECL_OBJC_CATEGORY_IMPL);
1258 RECORD(DECL_OBJC_IMPLEMENTATION);
1259 RECORD(DECL_OBJC_COMPATIBLE_ALIAS);
1260 RECORD(DECL_OBJC_PROPERTY);
1261 RECORD(DECL_OBJC_PROPERTY_IMPL);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001262 RECORD(DECL_FIELD);
John McCall5e77d762013-04-16 07:28:30 +00001263 RECORD(DECL_MS_PROPERTY);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001264 RECORD(DECL_VAR);
Chris Lattnerdb397b62009-04-26 22:32:16 +00001265 RECORD(DECL_IMPLICIT_PARAM);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001266 RECORD(DECL_PARM_VAR);
Chris Lattnerdb397b62009-04-26 22:32:16 +00001267 RECORD(DECL_FILE_SCOPE_ASM);
1268 RECORD(DECL_BLOCK);
1269 RECORD(DECL_CONTEXT_LEXICAL);
1270 RECORD(DECL_CONTEXT_VISIBLE);
Douglas Gregor0beaec02011-02-08 16:34:17 +00001271 RECORD(DECL_NAMESPACE);
1272 RECORD(DECL_NAMESPACE_ALIAS);
1273 RECORD(DECL_USING);
1274 RECORD(DECL_USING_SHADOW);
1275 RECORD(DECL_USING_DIRECTIVE);
1276 RECORD(DECL_UNRESOLVED_USING_VALUE);
1277 RECORD(DECL_UNRESOLVED_USING_TYPENAME);
1278 RECORD(DECL_LINKAGE_SPEC);
1279 RECORD(DECL_CXX_RECORD);
1280 RECORD(DECL_CXX_METHOD);
1281 RECORD(DECL_CXX_CONSTRUCTOR);
1282 RECORD(DECL_CXX_DESTRUCTOR);
1283 RECORD(DECL_CXX_CONVERSION);
1284 RECORD(DECL_ACCESS_SPEC);
1285 RECORD(DECL_FRIEND);
1286 RECORD(DECL_FRIEND_TEMPLATE);
1287 RECORD(DECL_CLASS_TEMPLATE);
1288 RECORD(DECL_CLASS_TEMPLATE_SPECIALIZATION);
1289 RECORD(DECL_CLASS_TEMPLATE_PARTIAL_SPECIALIZATION);
Larisse Voufo39a1e502013-08-06 01:03:05 +00001290 RECORD(DECL_VAR_TEMPLATE);
1291 RECORD(DECL_VAR_TEMPLATE_SPECIALIZATION);
1292 RECORD(DECL_VAR_TEMPLATE_PARTIAL_SPECIALIZATION);
Douglas Gregor0beaec02011-02-08 16:34:17 +00001293 RECORD(DECL_FUNCTION_TEMPLATE);
1294 RECORD(DECL_TEMPLATE_TYPE_PARM);
1295 RECORD(DECL_NON_TYPE_TEMPLATE_PARM);
1296 RECORD(DECL_TEMPLATE_TEMPLATE_PARM);
Saar Razd7aae332019-07-10 21:25:49 +00001297 RECORD(DECL_CONCEPT);
Richard Smithefc884a2016-04-13 07:41:35 +00001298 RECORD(DECL_TYPE_ALIAS_TEMPLATE);
Douglas Gregor0beaec02011-02-08 16:34:17 +00001299 RECORD(DECL_STATIC_ASSERT);
1300 RECORD(DECL_CXX_BASE_SPECIFIERS);
Richard Smithefc884a2016-04-13 07:41:35 +00001301 RECORD(DECL_CXX_CTOR_INITIALIZERS);
Douglas Gregor0beaec02011-02-08 16:34:17 +00001302 RECORD(DECL_INDIRECTFIELD);
1303 RECORD(DECL_EXPANDED_NON_TYPE_TEMPLATE_PARM_PACK);
Richard Smithefc884a2016-04-13 07:41:35 +00001304 RECORD(DECL_EXPANDED_TEMPLATE_TEMPLATE_PARM_PACK);
1305 RECORD(DECL_CLASS_SCOPE_FUNCTION_SPECIALIZATION);
1306 RECORD(DECL_IMPORT);
1307 RECORD(DECL_OMP_THREADPRIVATE);
1308 RECORD(DECL_EMPTY);
1309 RECORD(DECL_OBJC_TYPE_PARAM);
1310 RECORD(DECL_OMP_CAPTUREDEXPR);
1311 RECORD(DECL_PRAGMA_COMMENT);
1312 RECORD(DECL_PRAGMA_DETECT_MISMATCH);
1313 RECORD(DECL_OMP_DECLARE_REDUCTION);
Alexey Bataev25ed0c02019-03-07 17:54:44 +00001314 RECORD(DECL_OMP_ALLOCATE);
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00001315
Douglas Gregor03412ba2011-06-03 02:27:19 +00001316 // Statements and Exprs can occur in the Decls and Types block.
1317 AddStmtsExprs(Stream, Record);
1318
Douglas Gregor92a96f52011-02-08 21:58:10 +00001319 BLOCK(PREPROCESSOR_DETAIL_BLOCK);
Chandler Carruthf92ac9e2011-07-15 07:25:21 +00001320 RECORD(PPD_MACRO_EXPANSION);
Douglas Gregor92a96f52011-02-08 21:58:10 +00001321 RECORD(PPD_MACRO_DEFINITION);
1322 RECORD(PPD_INCLUSION_DIRECTIVE);
Douglas Gregor6623e1f2015-11-03 18:33:07 +00001323
1324 // Decls and Types block.
1325 BLOCK(EXTENSION_BLOCK);
1326 RECORD(EXTENSION_METADATA);
1327
Duncan P. N. Exon Smith60fa2882017-03-13 18:45:08 +00001328 BLOCK(UNHASHED_CONTROL_BLOCK);
1329 RECORD(SIGNATURE);
1330 RECORD(DIAGNOSTIC_OPTIONS);
1331 RECORD(DIAG_PRAGMA_MAPPINGS);
1332
Chris Lattner28fa4e62009-04-26 22:26:21 +00001333#undef RECORD
1334#undef BLOCK
1335 Stream.ExitBlock();
1336}
1337
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001338/// Prepares a path for being written to an AST file by converting it
Richard Smith54cc3c22014-12-11 20:50:24 +00001339/// to an absolute path and removing nested './'s.
1340///
1341/// \return \c true if the path was changed.
Benjamin Kramer6a96ae52015-02-06 18:36:04 +00001342static bool cleanPathForOutput(FileManager &FileMgr,
1343 SmallVectorImpl<char> &Path) {
Argyrios Kyrtzidis403cbcb2015-07-31 01:39:23 +00001344 bool Changed = FileMgr.makeAbsolutePath(Path);
Mike Aizatskyaeb9dd92015-11-09 19:12:18 +00001345 return Changed | llvm::sys::path::remove_dots(Path);
Richard Smith54cc3c22014-12-11 20:50:24 +00001346}
1347
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001348/// Adjusts the given filename to only write out the portion of the
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001349/// filename that is not part of the system root directory.
Mike Stump11289f42009-09-09 15:08:12 +00001350///
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001351/// \param Filename the file name to adjust.
1352///
Richard Smith7ed1bc92014-12-05 22:42:13 +00001353/// \param BaseDir When non-NULL, the PCH file is a relocatable AST file and
1354/// the returned filename will be adjusted by this root directory.
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001355///
1356/// \returns either the original filename (if it needs no adjustment) or the
1357/// adjusted filename (which points into the @p Filename parameter).
Mike Stump11289f42009-09-09 15:08:12 +00001358static const char *
Richard Smith7ed1bc92014-12-05 22:42:13 +00001359adjustFilenameForRelocatableAST(const char *Filename, StringRef BaseDir) {
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001360 assert(Filename && "No file name to adjust?");
Mike Stump11289f42009-09-09 15:08:12 +00001361
Richard Smith7ed1bc92014-12-05 22:42:13 +00001362 if (BaseDir.empty())
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001363 return Filename;
Mike Stump11289f42009-09-09 15:08:12 +00001364
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001365 // Verify that the filename and the system root have the same prefix.
1366 unsigned Pos = 0;
Richard Smith7ed1bc92014-12-05 22:42:13 +00001367 for (; Filename[Pos] && Pos < BaseDir.size(); ++Pos)
1368 if (Filename[Pos] != BaseDir[Pos])
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001369 return Filename; // Prefixes don't match.
Mike Stump11289f42009-09-09 15:08:12 +00001370
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001371 // We hit the end of the filename before we hit the end of the system root.
1372 if (!Filename[Pos])
1373 return Filename;
Mike Stump11289f42009-09-09 15:08:12 +00001374
Richard Smith7ed1bc92014-12-05 22:42:13 +00001375 // If there's not a path separator at the end of the base directory nor
1376 // immediately after it, then this isn't within the base directory.
1377 if (!llvm::sys::path::is_separator(Filename[Pos])) {
1378 if (!llvm::sys::path::is_separator(BaseDir.back()))
1379 return Filename;
1380 } else {
1381 // If the file name has a '/' at the current position, skip over the '/'.
1382 // We distinguish relative paths from absolute paths by the
1383 // absence of '/' at the beginning of relative paths.
1384 //
1385 // FIXME: This is wrong. We distinguish them by asking if the path is
1386 // absolute, which isn't the same thing. And there might be multiple '/'s
1387 // in a row. Use a better mechanism to indicate whether we have emitted an
1388 // absolute or relative path.
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001389 ++Pos;
Richard Smith7ed1bc92014-12-05 22:42:13 +00001390 }
Mike Stump11289f42009-09-09 15:08:12 +00001391
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001392 return Filename + Pos;
1393}
Chris Lattner28fa4e62009-04-26 22:26:21 +00001394
Duncan P. N. Exon Smith60fa2882017-03-13 18:45:08 +00001395ASTFileSignature ASTWriter::createSignature(StringRef Bytes) {
1396 // Calculate the hash till start of UNHASHED_CONTROL_BLOCK.
1397 llvm::SHA1 Hasher;
1398 Hasher.update(ArrayRef<uint8_t>(Bytes.bytes_begin(), Bytes.size()));
1399 auto Hash = Hasher.result();
1400
1401 // Convert to an array [5*i32].
1402 ASTFileSignature Signature;
1403 auto LShift = [&](unsigned char Val, unsigned Shift) {
1404 return (uint32_t)Val << Shift;
1405 };
1406 for (int I = 0; I != 5; ++I)
1407 Signature[I] = LShift(Hash[I * 4 + 0], 24) | LShift(Hash[I * 4 + 1], 16) |
1408 LShift(Hash[I * 4 + 2], 8) | LShift(Hash[I * 4 + 3], 0);
1409
1410 return Signature;
1411}
1412
1413ASTFileSignature ASTWriter::writeUnhashedControlBlock(Preprocessor &PP,
1414 ASTContext &Context) {
1415 // Flush first to prepare the PCM hash (signature).
1416 Stream.FlushToWord();
1417 auto StartOfUnhashedControl = Stream.GetCurrentBitNo() >> 3;
1418
1419 // Enter the block and prepare to write records.
1420 RecordData Record;
1421 Stream.EnterSubblock(UNHASHED_CONTROL_BLOCK_ID, 5);
1422
1423 // For implicit modules, write the hash of the PCM as its signature.
1424 ASTFileSignature Signature;
1425 if (WritingModule &&
1426 PP.getHeaderSearchInfo().getHeaderSearchOpts().ModulesHashContent) {
1427 Signature = createSignature(StringRef(Buffer.begin(), StartOfUnhashedControl));
1428 Record.append(Signature.begin(), Signature.end());
1429 Stream.EmitRecord(SIGNATURE, Record);
1430 Record.clear();
Ben Langmuir487ea142014-10-23 18:05:36 +00001431 }
Duncan P. N. Exon Smith60fa2882017-03-13 18:45:08 +00001432
1433 // Diagnostic options.
1434 const auto &Diags = Context.getDiagnostics();
1435 const DiagnosticOptions &DiagOpts = Diags.getDiagnosticOptions();
1436#define DIAGOPT(Name, Bits, Default) Record.push_back(DiagOpts.Name);
1437#define ENUM_DIAGOPT(Name, Type, Bits, Default) \
1438 Record.push_back(static_cast<unsigned>(DiagOpts.get##Name()));
1439#include "clang/Basic/DiagnosticOptions.def"
1440 Record.push_back(DiagOpts.Warnings.size());
1441 for (unsigned I = 0, N = DiagOpts.Warnings.size(); I != N; ++I)
1442 AddString(DiagOpts.Warnings[I], Record);
1443 Record.push_back(DiagOpts.Remarks.size());
1444 for (unsigned I = 0, N = DiagOpts.Remarks.size(); I != N; ++I)
1445 AddString(DiagOpts.Remarks[I], Record);
1446 // Note: we don't serialize the log or serialization file names, because they
1447 // are generally transient files and will almost always be overridden.
1448 Stream.EmitRecord(DIAGNOSTIC_OPTIONS, Record);
1449
1450 // Write out the diagnostic/pragma mappings.
Rui Ueyama49a3ad22019-07-16 04:46:31 +00001451 WritePragmaDiagnosticMappings(Diags, /* isModule = */ WritingModule);
Duncan P. N. Exon Smith60fa2882017-03-13 18:45:08 +00001452
1453 // Leave the options block.
1454 Stream.ExitBlock();
1455 return Signature;
Ben Langmuir487ea142014-10-23 18:05:36 +00001456}
1457
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001458/// Write the control block.
Duncan P. N. Exon Smith60fa2882017-03-13 18:45:08 +00001459void ASTWriter::WriteControlBlock(Preprocessor &PP, ASTContext &Context,
1460 StringRef isysroot,
1461 const std::string &OutputFile) {
Douglas Gregorbfbde532009-04-10 21:16:55 +00001462 using namespace llvm;
Eugene Zelenkob7d89102017-11-11 00:08:50 +00001463
Douglas Gregor0aa21c92012-10-18 18:27:37 +00001464 Stream.EnterSubblock(CONTROL_BLOCK_ID, 5);
Mehdi Amini5ae4a852015-09-09 20:35:37 +00001465 RecordData Record;
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00001466
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001467 // Metadata
David Blaikieb44f0bf2017-01-04 22:36:43 +00001468 auto MetadataAbbrev = std::make_shared<BitCodeAbbrev>();
Douglas Gregor0aa21c92012-10-18 18:27:37 +00001469 MetadataAbbrev->Add(BitCodeAbbrevOp(METADATA));
1470 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 16)); // Major
1471 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 16)); // Minor
1472 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 16)); // Clang maj.
1473 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 16)); // Clang min.
1474 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Relocatable
Richard Smithe75ee0f2015-08-17 07:13:32 +00001475 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Timestamps
Hans Wennborg08c5a7b2018-06-25 13:23:49 +00001476 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // PCHHasObjectFile
Douglas Gregor0aa21c92012-10-18 18:27:37 +00001477 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Errors
1478 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // SVN branch/tag
David Blaikieb44f0bf2017-01-04 22:36:43 +00001479 unsigned MetadataAbbrevCode = Stream.EmitAbbrev(std::move(MetadataAbbrev));
Richard Smith7ed1bc92014-12-05 22:42:13 +00001480 assert((!WritingModule || isysroot.empty()) &&
1481 "writing module as a relocatable PCH?");
Mehdi Amini57a41912015-09-10 01:46:39 +00001482 {
Hans Wennborg08c5a7b2018-06-25 13:23:49 +00001483 RecordData::value_type Record[] = {
1484 METADATA,
1485 VERSION_MAJOR,
1486 VERSION_MINOR,
1487 CLANG_VERSION_MAJOR,
1488 CLANG_VERSION_MINOR,
1489 !isysroot.empty(),
1490 IncludeTimestamps,
1491 Context.getLangOpts().BuildingPCHWithObjectFile,
1492 ASTHasCompilerErrors};
Mehdi Amini57a41912015-09-10 01:46:39 +00001493 Stream.EmitRecordWithBlob(MetadataAbbrevCode, Record,
1494 getClangFullRepositoryVersion());
1495 }
Chandler Carruth885e78c2015-03-24 21:18:10 +00001496
Richard Smith8b706102017-05-31 20:56:55 +00001497 if (WritingModule) {
Richard Smith7ed1bc92014-12-05 22:42:13 +00001498 // Module name
David Blaikieb44f0bf2017-01-04 22:36:43 +00001499 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Ben Langmuirbeee15e2014-04-14 18:00:01 +00001500 Abbrev->Add(BitCodeAbbrevOp(MODULE_NAME));
1501 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
David Blaikieb44f0bf2017-01-04 22:36:43 +00001502 unsigned AbbrevCode = Stream.EmitAbbrev(std::move(Abbrev));
Mehdi Amini57a41912015-09-10 01:46:39 +00001503 RecordData::value_type Record[] = {MODULE_NAME};
Ben Langmuirbeee15e2014-04-14 18:00:01 +00001504 Stream.EmitRecordWithBlob(AbbrevCode, Record, WritingModule->Name);
1505 }
1506
Richard Smith7ed1bc92014-12-05 22:42:13 +00001507 if (WritingModule && WritingModule->Directory) {
Richard Smith7ed1bc92014-12-05 22:42:13 +00001508 SmallString<128> BaseDir(WritingModule->Directory->getName());
Richard Smith54cc3c22014-12-11 20:50:24 +00001509 cleanPathForOutput(Context.getSourceManager().getFileManager(), BaseDir);
Richard Smithf7b41372015-08-13 23:47:44 +00001510
1511 // If the home of the module is the current working directory, then we
1512 // want to pick up the cwd of the build process loading the module, not
1513 // our cwd, when we load this module.
1514 if (!PP.getHeaderSearchInfo()
1515 .getHeaderSearchOpts()
1516 .ModuleMapFileHomeIsCwd ||
1517 WritingModule->Directory->getName() != StringRef(".")) {
1518 // Module directory.
David Blaikieb44f0bf2017-01-04 22:36:43 +00001519 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Richard Smithf7b41372015-08-13 23:47:44 +00001520 Abbrev->Add(BitCodeAbbrevOp(MODULE_DIRECTORY));
1521 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Directory
David Blaikieb44f0bf2017-01-04 22:36:43 +00001522 unsigned AbbrevCode = Stream.EmitAbbrev(std::move(Abbrev));
Richard Smithf7b41372015-08-13 23:47:44 +00001523
Mehdi Amini57a41912015-09-10 01:46:39 +00001524 RecordData::value_type Record[] = {MODULE_DIRECTORY};
Richard Smithf7b41372015-08-13 23:47:44 +00001525 Stream.EmitRecordWithBlob(AbbrevCode, Record, BaseDir);
1526 }
Richard Smith7ed1bc92014-12-05 22:42:13 +00001527
1528 // Write out all other paths relative to the base directory if possible.
1529 BaseDirectory.assign(BaseDir.begin(), BaseDir.end());
1530 } else if (!isysroot.empty()) {
1531 // Write out paths relative to the sysroot if possible.
1532 BaseDirectory = isysroot;
1533 }
1534
Ben Langmuirbeee15e2014-04-14 18:00:01 +00001535 // Module map file
Richard Smithd19389a2017-07-05 07:47:11 +00001536 if (WritingModule && WritingModule->Kind == Module::ModuleMapModule) {
Mehdi Amini5ae4a852015-09-09 20:35:37 +00001537 Record.clear();
Ben Langmuirbeee15e2014-04-14 18:00:01 +00001538
Ben Langmuir4b8a9e92014-08-12 16:42:33 +00001539 auto &Map = PP.getHeaderSearchInfo().getModuleMap();
Richard Smith8b706102017-05-31 20:56:55 +00001540 AddPath(WritingModule->PresumedModuleMapFile.empty()
1541 ? Map.getModuleMapFileForUniquing(WritingModule)->getName()
1542 : StringRef(WritingModule->PresumedModuleMapFile),
1543 Record);
Ben Langmuir4b8a9e92014-08-12 16:42:33 +00001544
1545 // Additional module map files.
Richard Smith7ed1bc92014-12-05 22:42:13 +00001546 if (auto *AdditionalModMaps =
1547 Map.getAdditionalModuleMapFiles(WritingModule)) {
Ben Langmuir4b8a9e92014-08-12 16:42:33 +00001548 Record.push_back(AdditionalModMaps->size());
1549 for (const FileEntry *F : *AdditionalModMaps)
Richard Smith7ed1bc92014-12-05 22:42:13 +00001550 AddPath(F->getName(), Record);
Ben Langmuir4b8a9e92014-08-12 16:42:33 +00001551 } else {
1552 Record.push_back(0);
1553 }
1554
1555 Stream.EmitRecord(MODULE_MAP_FILE, Record);
Ben Langmuirbeee15e2014-04-14 18:00:01 +00001556 }
1557
Douglas Gregor112b9072012-10-18 05:31:06 +00001558 // Imports
Douglas Gregor29cc6422011-08-17 21:07:30 +00001559 if (Chain) {
Douglas Gregor29cc6422011-08-17 21:07:30 +00001560 serialization::ModuleManager &Mgr = Chain->getModuleManager();
Mehdi Amini5ae4a852015-09-09 20:35:37 +00001561 Record.clear();
Douglas Gregordf0c1512011-08-18 04:12:04 +00001562
Duncan P. N. Exon Smith96a06e02017-01-28 22:15:22 +00001563 for (ModuleFile &M : Mgr) {
Douglas Gregordf0c1512011-08-18 04:12:04 +00001564 // Skip modules that weren't directly imported.
Duncan P. N. Exon Smith96a06e02017-01-28 22:15:22 +00001565 if (!M.isDirectlyImported())
Douglas Gregordf0c1512011-08-18 04:12:04 +00001566 continue;
1567
Duncan P. N. Exon Smith96a06e02017-01-28 22:15:22 +00001568 Record.push_back((unsigned)M.Kind); // FIXME: Stable encoding
1569 AddSourceLocation(M.ImportLoc, Record);
Duncan P. N. Exon Smith60fa2882017-03-13 18:45:08 +00001570
1571 // If we have calculated signature, there is no need to store
1572 // the size or timestamp.
1573 Record.push_back(M.Signature ? 0 : M.File->getSize());
1574 Record.push_back(M.Signature ? 0 : getTimestampForOutput(M.File));
1575
1576 for (auto I : M.Signature)
1577 Record.push_back(I);
1578
Boris Kolpackovd30446f2017-08-31 06:26:43 +00001579 AddString(M.ModuleName, Record);
Duncan P. N. Exon Smith96a06e02017-01-28 22:15:22 +00001580 AddPath(M.FileName, Record);
Douglas Gregordf0c1512011-08-18 04:12:04 +00001581 }
Douglas Gregor29cc6422011-08-17 21:07:30 +00001582 Stream.EmitRecord(IMPORTS, Record);
1583 }
Mike Stump11289f42009-09-09 15:08:12 +00001584
Richard Smith0516b182015-09-08 19:40:14 +00001585 // Write the options block.
1586 Stream.EnterSubblock(OPTIONS_BLOCK_ID, 4);
1587
Douglas Gregor112b9072012-10-18 05:31:06 +00001588 // Language options.
Mehdi Amini5ae4a852015-09-09 20:35:37 +00001589 Record.clear();
Douglas Gregor112b9072012-10-18 05:31:06 +00001590 const LangOptions &LangOpts = Context.getLangOpts();
1591#define LANGOPT(Name, Bits, Default, Description) \
1592 Record.push_back(LangOpts.Name);
1593#define ENUM_LANGOPT(Name, Type, Bits, Default, Description) \
1594 Record.push_back(static_cast<unsigned>(LangOpts.get##Name()));
Alexey Samsonovedf99a92014-11-07 22:29:38 +00001595#include "clang/Basic/LangOptions.def"
1596#define SANITIZER(NAME, ID) \
1597 Record.push_back(LangOpts.Sanitize.has(SanitizerKind::ID));
Will Dietzf54319c2013-01-18 11:30:38 +00001598#include "clang/Basic/Sanitizers.def"
Douglas Gregor112b9072012-10-18 05:31:06 +00001599
Ben Langmuircd98cb72015-06-23 18:20:18 +00001600 Record.push_back(LangOpts.ModuleFeatures.size());
1601 for (StringRef Feature : LangOpts.ModuleFeatures)
1602 AddString(Feature, Record);
1603
Douglas Gregor112b9072012-10-18 05:31:06 +00001604 Record.push_back((unsigned) LangOpts.ObjCRuntime.getKind());
1605 AddVersionTuple(LangOpts.ObjCRuntime.getVersion(), Record);
Ben Langmuird4a667a2015-06-23 18:20:23 +00001606
1607 AddString(LangOpts.CurrentModule, Record);
Dmitri Gribenkoacf2e782013-02-22 14:21:27 +00001608
1609 // Comment options.
1610 Record.push_back(LangOpts.CommentOpts.BlockCommandNames.size());
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00001611 for (const auto &I : LangOpts.CommentOpts.BlockCommandNames) {
1612 AddString(I, Record);
Dmitri Gribenkoacf2e782013-02-22 14:21:27 +00001613 }
Dmitri Gribenkoa7d16ce2013-04-10 15:35:17 +00001614 Record.push_back(LangOpts.CommentOpts.ParseAllComments);
Dmitri Gribenkoacf2e782013-02-22 14:21:27 +00001615
Samuel Antaoee8fb302016-01-06 13:42:12 +00001616 // OpenMP offloading options.
1617 Record.push_back(LangOpts.OMPTargetTriples.size());
1618 for (auto &T : LangOpts.OMPTargetTriples)
1619 AddString(T.getTriple(), Record);
1620
1621 AddString(LangOpts.OMPHostIRFile, Record);
1622
Douglas Gregor112b9072012-10-18 05:31:06 +00001623 Stream.EmitRecord(LANGUAGE_OPTIONS, Record);
1624
Douglas Gregor4d3611c2012-10-18 17:58:09 +00001625 // Target options.
1626 Record.clear();
Douglas Gregor0aa21c92012-10-18 18:27:37 +00001627 const TargetInfo &Target = Context.getTargetInfo();
1628 const TargetOptions &TargetOpts = Target.getTargetOpts();
Douglas Gregor4d3611c2012-10-18 17:58:09 +00001629 AddString(TargetOpts.Triple, Record);
1630 AddString(TargetOpts.CPU, Record);
1631 AddString(TargetOpts.ABI, Record);
Douglas Gregor4d3611c2012-10-18 17:58:09 +00001632 Record.push_back(TargetOpts.FeaturesAsWritten.size());
1633 for (unsigned I = 0, N = TargetOpts.FeaturesAsWritten.size(); I != N; ++I) {
1634 AddString(TargetOpts.FeaturesAsWritten[I], Record);
1635 }
1636 Record.push_back(TargetOpts.Features.size());
1637 for (unsigned I = 0, N = TargetOpts.Features.size(); I != N; ++I) {
1638 AddString(TargetOpts.Features[I], Record);
1639 }
1640 Stream.EmitRecord(TARGET_OPTIONS, Record);
1641
Douglas Gregorc6317db2012-10-24 15:49:58 +00001642 // File system options.
1643 Record.clear();
Yaron Keren8dec46c2015-08-26 08:10:22 +00001644 const FileSystemOptions &FSOpts =
1645 Context.getSourceManager().getFileManager().getFileSystemOpts();
Douglas Gregorc6317db2012-10-24 15:49:58 +00001646 AddString(FSOpts.WorkingDir, Record);
1647 Stream.EmitRecord(FILE_SYSTEM_OPTIONS, Record);
1648
Douglas Gregor2d302362012-10-24 16:50:34 +00001649 // Header search options.
1650 Record.clear();
1651 const HeaderSearchOptions &HSOpts
1652 = PP.getHeaderSearchInfo().getHeaderSearchOpts();
1653 AddString(HSOpts.Sysroot, Record);
1654
1655 // Include entries.
1656 Record.push_back(HSOpts.UserEntries.size());
1657 for (unsigned I = 0, N = HSOpts.UserEntries.size(); I != N; ++I) {
1658 const HeaderSearchOptions::Entry &Entry = HSOpts.UserEntries[I];
1659 AddString(Entry.Path, Record);
1660 Record.push_back(static_cast<unsigned>(Entry.Group));
Douglas Gregor2d302362012-10-24 16:50:34 +00001661 Record.push_back(Entry.IsFramework);
1662 Record.push_back(Entry.IgnoreSysRoot);
Douglas Gregor2d302362012-10-24 16:50:34 +00001663 }
1664
1665 // System header prefixes.
1666 Record.push_back(HSOpts.SystemHeaderPrefixes.size());
1667 for (unsigned I = 0, N = HSOpts.SystemHeaderPrefixes.size(); I != N; ++I) {
1668 AddString(HSOpts.SystemHeaderPrefixes[I].Prefix, Record);
1669 Record.push_back(HSOpts.SystemHeaderPrefixes[I].IsSystemHeader);
1670 }
1671
1672 AddString(HSOpts.ResourceDir, Record);
1673 AddString(HSOpts.ModuleCachePath, Record);
Argyrios Kyrtzidis1594c152014-03-03 08:12:05 +00001674 AddString(HSOpts.ModuleUserBuildPath, Record);
Douglas Gregor2d302362012-10-24 16:50:34 +00001675 Record.push_back(HSOpts.DisableModuleHash);
Richard Smith18934752017-06-06 00:32:01 +00001676 Record.push_back(HSOpts.ImplicitModuleMaps);
1677 Record.push_back(HSOpts.ModuleMapFileHomeIsCwd);
Douglas Gregor2d302362012-10-24 16:50:34 +00001678 Record.push_back(HSOpts.UseBuiltinIncludes);
1679 Record.push_back(HSOpts.UseStandardSystemIncludes);
1680 Record.push_back(HSOpts.UseStandardCXXIncludes);
1681 Record.push_back(HSOpts.UseLibcxx);
Argyrios Kyrtzidisbd0b6512015-02-19 20:12:20 +00001682 // Write out the specific module cache path that contains the module files.
1683 AddString(PP.getHeaderSearchInfo().getModuleCachePath(), Record);
Douglas Gregor2d302362012-10-24 16:50:34 +00001684 Stream.EmitRecord(HEADER_SEARCH_OPTIONS, Record);
1685
Douglas Gregorb6af6c22012-10-24 20:05:57 +00001686 // Preprocessor options.
1687 Record.clear();
1688 const PreprocessorOptions &PPOpts = PP.getPreprocessorOpts();
1689
1690 // Macro definitions.
1691 Record.push_back(PPOpts.Macros.size());
1692 for (unsigned I = 0, N = PPOpts.Macros.size(); I != N; ++I) {
1693 AddString(PPOpts.Macros[I].first, Record);
1694 Record.push_back(PPOpts.Macros[I].second);
1695 }
1696
1697 // Includes
1698 Record.push_back(PPOpts.Includes.size());
1699 for (unsigned I = 0, N = PPOpts.Includes.size(); I != N; ++I)
1700 AddString(PPOpts.Includes[I], Record);
1701
1702 // Macro includes
1703 Record.push_back(PPOpts.MacroIncludes.size());
1704 for (unsigned I = 0, N = PPOpts.MacroIncludes.size(); I != N; ++I)
1705 AddString(PPOpts.MacroIncludes[I], Record);
1706
Douglas Gregorb6368752012-10-24 23:41:50 +00001707 Record.push_back(PPOpts.UsePredefines);
Argyrios Kyrtzidisd3afa0c2013-04-26 21:33:40 +00001708 // Detailed record is important since it is used for the module cache hash.
1709 Record.push_back(PPOpts.DetailedRecord);
Douglas Gregorb6af6c22012-10-24 20:05:57 +00001710 AddString(PPOpts.ImplicitPCHInclude, Record);
Douglas Gregorb6af6c22012-10-24 20:05:57 +00001711 Record.push_back(static_cast<unsigned>(PPOpts.ObjCXXARCStandardLibrary));
1712 Stream.EmitRecord(PREPROCESSOR_OPTIONS, Record);
1713
Richard Smith0516b182015-09-08 19:40:14 +00001714 // Leave the options block.
1715 Stream.ExitBlock();
1716
Douglas Gregora3b20262011-05-06 21:43:30 +00001717 // Original file name and file ID
Douglas Gregor45fe0362009-05-12 01:31:05 +00001718 SourceManager &SM = Context.getSourceManager();
1719 if (const FileEntry *MainFile = SM.getFileEntryForID(SM.getMainFileID())) {
David Blaikieb44f0bf2017-01-04 22:36:43 +00001720 auto FileAbbrev = std::make_shared<BitCodeAbbrev>();
Douglas Gregorfad10d82012-10-18 18:36:53 +00001721 FileAbbrev->Add(BitCodeAbbrevOp(ORIGINAL_FILE));
1722 FileAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // File ID
Douglas Gregor45fe0362009-05-12 01:31:05 +00001723 FileAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // File name
David Blaikieb44f0bf2017-01-04 22:36:43 +00001724 unsigned FileAbbrevCode = Stream.EmitAbbrev(std::move(FileAbbrev));
Douglas Gregor45fe0362009-05-12 01:31:05 +00001725
Douglas Gregorb6af6c22012-10-24 20:05:57 +00001726 Record.clear();
Douglas Gregorfad10d82012-10-18 18:36:53 +00001727 Record.push_back(ORIGINAL_FILE);
Douglas Gregora3b20262011-05-06 21:43:30 +00001728 Record.push_back(SM.getMainFileID().getOpaqueValue());
Richard Smith7ed1bc92014-12-05 22:42:13 +00001729 EmitRecordWithPath(FileAbbrevCode, Record, MainFile->getName());
Douglas Gregor45fe0362009-05-12 01:31:05 +00001730 }
Kovarththanan Rajaratnama9c81a82010-03-14 07:06:50 +00001731
Argyrios Kyrtzidis52595242012-11-15 18:57:27 +00001732 Record.clear();
1733 Record.push_back(SM.getMainFileID().getOpaqueValue());
1734 Stream.EmitRecord(ORIGINAL_FILE_ID, Record);
1735
Argyrios Kyrtzidis10b23682011-02-15 17:54:22 +00001736 // Original PCH directory
1737 if (!OutputFile.empty() && OutputFile != "-") {
David Blaikieb44f0bf2017-01-04 22:36:43 +00001738 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Argyrios Kyrtzidis10b23682011-02-15 17:54:22 +00001739 Abbrev->Add(BitCodeAbbrevOp(ORIGINAL_PCH_DIR));
1740 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // File name
David Blaikieb44f0bf2017-01-04 22:36:43 +00001741 unsigned AbbrevCode = Stream.EmitAbbrev(std::move(Abbrev));
Argyrios Kyrtzidis10b23682011-02-15 17:54:22 +00001742
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00001743 SmallString<128> OutputPath(OutputFile);
Argyrios Kyrtzidis10b23682011-02-15 17:54:22 +00001744
Argyrios Kyrtzidisc56419e2015-07-31 00:58:32 +00001745 SM.getFileManager().makeAbsolutePath(OutputPath);
Argyrios Kyrtzidis10b23682011-02-15 17:54:22 +00001746 StringRef origDir = llvm::sys::path::parent_path(OutputPath);
1747
Mehdi Amini57a41912015-09-10 01:46:39 +00001748 RecordData::value_type Record[] = {ORIGINAL_PCH_DIR};
Argyrios Kyrtzidis10b23682011-02-15 17:54:22 +00001749 Stream.EmitRecordWithBlob(AbbrevCode, Record, origDir);
1750 }
1751
Douglas Gregor49491f72013-03-15 22:15:07 +00001752 WriteInputFiles(Context.SourceMgr,
1753 PP.getHeaderSearchInfo().getHeaderSearchOpts(),
Douglas Gregora3dd9002013-07-22 20:48:33 +00001754 PP.getLangOpts().Modules);
Douglas Gregor72be3902012-10-19 00:38:02 +00001755 Stream.ExitBlock();
1756}
1757
Douglas Gregor49491f72013-03-15 22:15:07 +00001758namespace {
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +00001759
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001760/// An input file.
Eugene Zelenkob7d89102017-11-11 00:08:50 +00001761struct InputFileEntry {
1762 const FileEntry *File;
1763 bool IsSystemFile;
1764 bool IsTransient;
1765 bool BufferOverridden;
1766 bool IsTopLevelModuleMap;
1767};
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +00001768
Eugene Zelenkob7d89102017-11-11 00:08:50 +00001769} // namespace
Douglas Gregor49491f72013-03-15 22:15:07 +00001770
1771void ASTWriter::WriteInputFiles(SourceManager &SourceMgr,
1772 HeaderSearchOptions &HSOpts,
Douglas Gregora3dd9002013-07-22 20:48:33 +00001773 bool Modules) {
Douglas Gregor72be3902012-10-19 00:38:02 +00001774 using namespace llvm;
Eugene Zelenkob7d89102017-11-11 00:08:50 +00001775
Douglas Gregor72be3902012-10-19 00:38:02 +00001776 Stream.EnterSubblock(INPUT_FILES_BLOCK_ID, 4);
Mehdi Amini57a41912015-09-10 01:46:39 +00001777
Douglas Gregor72be3902012-10-19 00:38:02 +00001778 // Create input-file abbreviation.
David Blaikieb44f0bf2017-01-04 22:36:43 +00001779 auto IFAbbrev = std::make_shared<BitCodeAbbrev>();
Douglas Gregor72be3902012-10-19 00:38:02 +00001780 IFAbbrev->Add(BitCodeAbbrevOp(INPUT_FILE));
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001781 IFAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // ID
Douglas Gregor72be3902012-10-19 00:38:02 +00001782 IFAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 12)); // Size
1783 IFAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 32)); // Modification time
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001784 IFAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Overridden
Richard Smitha8cfffa2015-11-26 02:04:16 +00001785 IFAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Transient
Richard Smithf3f84612017-06-29 02:19:42 +00001786 IFAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Module map
Douglas Gregor72be3902012-10-19 00:38:02 +00001787 IFAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // File name
David Blaikieb44f0bf2017-01-04 22:36:43 +00001788 unsigned IFAbbrevCode = Stream.EmitAbbrev(std::move(IFAbbrev));
Douglas Gregor72be3902012-10-19 00:38:02 +00001789
Argyrios Kyrtzidis7d238572013-03-06 18:12:50 +00001790 // Get all ContentCache objects for files, sorted by whether the file is a
1791 // system one or not. System files go at the back, users files at the front.
Douglas Gregor49491f72013-03-15 22:15:07 +00001792 std::deque<InputFileEntry> SortedFiles;
Douglas Gregor72be3902012-10-19 00:38:02 +00001793 for (unsigned I = 1, N = SourceMgr.local_sloc_entry_size(); I != N; ++I) {
1794 // Get this source location entry.
1795 const SrcMgr::SLocEntry *SLoc = &SourceMgr.getLocalSLocEntry(I);
NAKAMURA Takumideca50f2012-10-19 01:53:57 +00001796 assert(&SourceMgr.getSLocEntry(FileID::get(I)) == SLoc);
Douglas Gregor72be3902012-10-19 00:38:02 +00001797
1798 // We only care about file entries that were not overridden.
1799 if (!SLoc->isFile())
1800 continue;
Richard Smithf3f84612017-06-29 02:19:42 +00001801 const SrcMgr::FileInfo &File = SLoc->getFile();
1802 const SrcMgr::ContentCache *Cache = File.getContentCache();
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001803 if (!Cache->OrigEntry)
Douglas Gregor72be3902012-10-19 00:38:02 +00001804 continue;
1805
Douglas Gregor49491f72013-03-15 22:15:07 +00001806 InputFileEntry Entry;
1807 Entry.File = Cache->OrigEntry;
Duncan P. N. Exon Smithf5848192019-08-26 20:32:05 +00001808 Entry.IsSystemFile = isSystem(File.getFileCharacteristic());
Richard Smitha8cfffa2015-11-26 02:04:16 +00001809 Entry.IsTransient = Cache->IsTransient;
Douglas Gregor49491f72013-03-15 22:15:07 +00001810 Entry.BufferOverridden = Cache->BufferOverridden;
Richard Smithf3f84612017-06-29 02:19:42 +00001811 Entry.IsTopLevelModuleMap = isModuleMap(File.getFileCharacteristic()) &&
1812 File.getIncludeLoc().isInvalid();
Duncan P. N. Exon Smithf5848192019-08-26 20:32:05 +00001813 if (Entry.IsSystemFile)
Douglas Gregor49491f72013-03-15 22:15:07 +00001814 SortedFiles.push_back(Entry);
Argyrios Kyrtzidis7d238572013-03-06 18:12:50 +00001815 else
Douglas Gregor49491f72013-03-15 22:15:07 +00001816 SortedFiles.push_front(Entry);
1817 }
1818
Argyrios Kyrtzidis7d238572013-03-06 18:12:50 +00001819 unsigned UserFilesNum = 0;
1820 // Write out all of the input files.
Richard Smithec216502015-02-13 19:48:37 +00001821 std::vector<uint64_t> InputFileOffsets;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00001822 for (const auto &Entry : SortedFiles) {
Douglas Gregor49491f72013-03-15 22:15:07 +00001823 uint32_t &InputFileID = InputFileIDs[Entry.File];
Argyrios Kyrtzidise65856f2012-12-11 07:48:08 +00001824 if (InputFileID != 0)
1825 continue; // already recorded this file.
1826
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001827 // Record this entry's offset.
1828 InputFileOffsets.push_back(Stream.GetCurrentBitNo());
Argyrios Kyrtzidise65856f2012-12-11 07:48:08 +00001829
1830 InputFileID = InputFileOffsets.size();
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001831
Douglas Gregor49491f72013-03-15 22:15:07 +00001832 if (!Entry.IsSystemFile)
Argyrios Kyrtzidis7d238572013-03-06 18:12:50 +00001833 ++UserFilesNum;
1834
Douglas Gregor72be3902012-10-19 00:38:02 +00001835 // Emit size/modification time for this file.
Mehdi Amini57a41912015-09-10 01:46:39 +00001836 // And whether this file was overridden.
1837 RecordData::value_type Record[] = {
Richard Smitha8cfffa2015-11-26 02:04:16 +00001838 INPUT_FILE,
1839 InputFileOffsets.size(),
1840 (uint64_t)Entry.File->getSize(),
1841 (uint64_t)getTimestampForOutput(Entry.File),
1842 Entry.BufferOverridden,
Richard Smithf3f84612017-06-29 02:19:42 +00001843 Entry.IsTransient,
1844 Entry.IsTopLevelModuleMap};
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001845
Alex Lorenz4dc55732019-08-22 18:15:50 +00001846 // FIXME: The path should be taken from the FileEntryRef.
Richard Smith7ed1bc92014-12-05 22:42:13 +00001847 EmitRecordWithPath(IFAbbrevCode, Record, Entry.File->getName());
1848 }
Douglas Gregor49491f72013-03-15 22:15:07 +00001849
Douglas Gregor112b9072012-10-18 05:31:06 +00001850 Stream.ExitBlock();
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001851
1852 // Create input file offsets abbreviation.
David Blaikieb44f0bf2017-01-04 22:36:43 +00001853 auto OffsetsAbbrev = std::make_shared<BitCodeAbbrev>();
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001854 OffsetsAbbrev->Add(BitCodeAbbrevOp(INPUT_FILE_OFFSETS));
1855 OffsetsAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // # input files
Argyrios Kyrtzidis7d238572013-03-06 18:12:50 +00001856 OffsetsAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // # non-system
1857 // input files
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001858 OffsetsAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Array
David Blaikieb44f0bf2017-01-04 22:36:43 +00001859 unsigned OffsetsAbbrevCode = Stream.EmitAbbrev(std::move(OffsetsAbbrev));
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001860
1861 // Write input file offsets.
Mehdi Amini57a41912015-09-10 01:46:39 +00001862 RecordData::value_type Record[] = {INPUT_FILE_OFFSETS,
1863 InputFileOffsets.size(), UserFilesNum};
Reid Kleckner012665e2015-05-21 00:13:09 +00001864 Stream.EmitRecordWithBlob(OffsetsAbbrevCode, Record, bytes(InputFileOffsets));
Douglas Gregor55abb232009-04-10 20:39:37 +00001865}
1866
Douglas Gregora7f71a92009-04-10 03:52:48 +00001867//===----------------------------------------------------------------------===//
1868// Source Manager Serialization
1869//===----------------------------------------------------------------------===//
1870
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001871/// Create an abbreviation for the SLocEntry that refers to a
Douglas Gregora7f71a92009-04-10 03:52:48 +00001872/// file.
Douglas Gregor8f45df52009-04-16 22:23:12 +00001873static unsigned CreateSLocFileAbbrev(llvm::BitstreamWriter &Stream) {
Douglas Gregora7f71a92009-04-10 03:52:48 +00001874 using namespace llvm;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00001875
David Blaikieb44f0bf2017-01-04 22:36:43 +00001876 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Sebastian Redl539c5062010-08-18 23:57:32 +00001877 Abbrev->Add(BitCodeAbbrevOp(SM_SLOC_FILE_ENTRY));
Douglas Gregora7f71a92009-04-10 03:52:48 +00001878 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Offset
1879 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Include location
Richard Smithf3f84612017-06-29 02:19:42 +00001880 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 3)); // Characteristic
Douglas Gregora7f71a92009-04-10 03:52:48 +00001881 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Line directives
Douglas Gregorb41ca8f2010-03-21 22:49:54 +00001882 // FileEntry fields.
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001883 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Input File ID
Argyrios Kyrtzidis61ef3db2011-08-21 23:33:04 +00001884 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // NumCreatedFIDs
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00001885 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 24)); // FirstDeclIndex
1886 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // NumDecls
David Blaikieb44f0bf2017-01-04 22:36:43 +00001887 return Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregora7f71a92009-04-10 03:52:48 +00001888}
1889
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001890/// Create an abbreviation for the SLocEntry that refers to a
Douglas Gregora7f71a92009-04-10 03:52:48 +00001891/// buffer.
Douglas Gregor8f45df52009-04-16 22:23:12 +00001892static unsigned CreateSLocBufferAbbrev(llvm::BitstreamWriter &Stream) {
Douglas Gregora7f71a92009-04-10 03:52:48 +00001893 using namespace llvm;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00001894
David Blaikieb44f0bf2017-01-04 22:36:43 +00001895 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Sebastian Redl539c5062010-08-18 23:57:32 +00001896 Abbrev->Add(BitCodeAbbrevOp(SM_SLOC_BUFFER_ENTRY));
Douglas Gregora7f71a92009-04-10 03:52:48 +00001897 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Offset
1898 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Include location
Richard Smithf3f84612017-06-29 02:19:42 +00001899 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 3)); // Characteristic
Douglas Gregora7f71a92009-04-10 03:52:48 +00001900 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Line directives
1901 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Buffer name blob
David Blaikieb44f0bf2017-01-04 22:36:43 +00001902 return Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregora7f71a92009-04-10 03:52:48 +00001903}
1904
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001905/// Create an abbreviation for the SLocEntry that refers to a
Douglas Gregora7f71a92009-04-10 03:52:48 +00001906/// buffer's blob.
Richard Smithaada85c2016-02-06 02:06:43 +00001907static unsigned CreateSLocBufferBlobAbbrev(llvm::BitstreamWriter &Stream,
1908 bool Compressed) {
Douglas Gregora7f71a92009-04-10 03:52:48 +00001909 using namespace llvm;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00001910
David Blaikieb44f0bf2017-01-04 22:36:43 +00001911 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Richard Smithaada85c2016-02-06 02:06:43 +00001912 Abbrev->Add(BitCodeAbbrevOp(Compressed ? SM_SLOC_BUFFER_BLOB_COMPRESSED
1913 : SM_SLOC_BUFFER_BLOB));
1914 if (Compressed)
1915 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Uncompressed size
Douglas Gregora7f71a92009-04-10 03:52:48 +00001916 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Blob
David Blaikieb44f0bf2017-01-04 22:36:43 +00001917 return Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregora7f71a92009-04-10 03:52:48 +00001918}
1919
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001920/// Create an abbreviation for the SLocEntry that refers to a macro
Chandler Carruthf92ac9e2011-07-15 07:25:21 +00001921/// expansion.
1922static unsigned CreateSLocExpansionAbbrev(llvm::BitstreamWriter &Stream) {
Douglas Gregora7f71a92009-04-10 03:52:48 +00001923 using namespace llvm;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00001924
David Blaikieb44f0bf2017-01-04 22:36:43 +00001925 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Chandler Carruthf92ac9e2011-07-15 07:25:21 +00001926 Abbrev->Add(BitCodeAbbrevOp(SM_SLOC_EXPANSION_ENTRY));
Douglas Gregora7f71a92009-04-10 03:52:48 +00001927 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Offset
1928 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Spelling location
1929 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Start location
1930 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // End location
Richard Smithb5f81712018-04-30 05:25:48 +00001931 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Is token range
Douglas Gregor83243272009-04-15 18:05:10 +00001932 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Token length
David Blaikieb44f0bf2017-01-04 22:36:43 +00001933 return Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregora7f71a92009-04-10 03:52:48 +00001934}
1935
Douglas Gregor09b69892011-02-10 17:09:37 +00001936namespace {
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +00001937
Douglas Gregor09b69892011-02-10 17:09:37 +00001938 // Trait used for the on-disk hash table of header search information.
1939 class HeaderFileInfoTrait {
1940 ASTWriter &Writer;
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00001941
Douglas Gregor4b123cb2011-07-28 04:50:02 +00001942 // Keep track of the framework names we've used during serialization.
1943 SmallVector<char, 128> FrameworkStringData;
1944 llvm::StringMap<unsigned> FrameworkNameOffset;
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00001945
Douglas Gregor09b69892011-02-10 17:09:37 +00001946 public:
Richard Smith040e1262017-06-02 01:55:39 +00001947 HeaderFileInfoTrait(ASTWriter &Writer) : Writer(Writer) {}
1948
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +00001949 struct key_type {
Mehdi Amini004b9c72016-10-10 22:52:47 +00001950 StringRef Filename;
Richard Smith040e1262017-06-02 01:55:39 +00001951 off_t Size;
1952 time_t ModTime;
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +00001953 };
Eugene Zelenkob7d89102017-11-11 00:08:50 +00001954 using key_type_ref = const key_type &;
Richard Smith040e1262017-06-02 01:55:39 +00001955
1956 using UnresolvedModule =
1957 llvm::PointerIntPair<Module *, 2, ModuleMap::ModuleHeaderRole>;
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00001958
Richard Smith040e1262017-06-02 01:55:39 +00001959 struct data_type {
1960 const HeaderFileInfo &HFI;
1961 ArrayRef<ModuleMap::KnownHeader> KnownHeaders;
1962 UnresolvedModule Unresolved;
1963 };
Eugene Zelenkob7d89102017-11-11 00:08:50 +00001964 using data_type_ref = const data_type &;
Richard Smith040e1262017-06-02 01:55:39 +00001965
Eugene Zelenkob7d89102017-11-11 00:08:50 +00001966 using hash_value_type = unsigned;
1967 using offset_type = unsigned;
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00001968
Richard Smithe75ee0f2015-08-17 07:13:32 +00001969 hash_value_type ComputeHash(key_type_ref key) {
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +00001970 // The hash is based only on size/time of the file, so that the reader can
1971 // match even when symlinking or excess path elements ("foo/../", "../")
1972 // change the form of the name. However, complete path is still the key.
Richard Smith040e1262017-06-02 01:55:39 +00001973 return llvm::hash_combine(key.Size, key.ModTime);
Douglas Gregor09b69892011-02-10 17:09:37 +00001974 }
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00001975
Eugene Zelenkob7d89102017-11-11 00:08:50 +00001976 std::pair<unsigned, unsigned>
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +00001977 EmitKeyDataLength(raw_ostream& Out, key_type_ref key, data_type_ref Data) {
Justin Bognere1c147c2014-03-28 22:03:19 +00001978 using namespace llvm::support;
Eugene Zelenkob7d89102017-11-11 00:08:50 +00001979
Peter Collingbournee3f65292018-05-18 19:46:24 +00001980 endian::Writer LE(Out, little);
Mehdi Amini004b9c72016-10-10 22:52:47 +00001981 unsigned KeyLen = key.Filename.size() + 1 + 8 + 8;
Richard Smith386bb072015-08-18 23:42:23 +00001982 LE.write<uint16_t>(KeyLen);
Douglas Gregor4b123cb2011-07-28 04:50:02 +00001983 unsigned DataLen = 1 + 2 + 4 + 4;
Richard Smith040e1262017-06-02 01:55:39 +00001984 for (auto ModInfo : Data.KnownHeaders)
Richard Smith386bb072015-08-18 23:42:23 +00001985 if (Writer.getLocalOrImportedSubmoduleID(ModInfo.getModule()))
1986 DataLen += 4;
Richard Smith040e1262017-06-02 01:55:39 +00001987 if (Data.Unresolved.getPointer())
1988 DataLen += 4;
Richard Smith386bb072015-08-18 23:42:23 +00001989 LE.write<uint8_t>(DataLen);
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +00001990 return std::make_pair(KeyLen, DataLen);
Douglas Gregor09b69892011-02-10 17:09:37 +00001991 }
Richard Smith040e1262017-06-02 01:55:39 +00001992
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +00001993 void EmitKey(raw_ostream& Out, key_type_ref key, unsigned KeyLen) {
Justin Bognere1c147c2014-03-28 22:03:19 +00001994 using namespace llvm::support;
Eugene Zelenkob7d89102017-11-11 00:08:50 +00001995
Peter Collingbournee3f65292018-05-18 19:46:24 +00001996 endian::Writer LE(Out, little);
Richard Smith040e1262017-06-02 01:55:39 +00001997 LE.write<uint64_t>(key.Size);
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +00001998 KeyLen -= 8;
Richard Smith040e1262017-06-02 01:55:39 +00001999 LE.write<uint64_t>(key.ModTime);
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +00002000 KeyLen -= 8;
Mehdi Amini004b9c72016-10-10 22:52:47 +00002001 Out.write(key.Filename.data(), KeyLen);
Douglas Gregor09b69892011-02-10 17:09:37 +00002002 }
Richard Smith040e1262017-06-02 01:55:39 +00002003
Argyrios Kyrtzidisb146baa2013-03-13 21:13:51 +00002004 void EmitData(raw_ostream &Out, key_type_ref key,
Douglas Gregor09b69892011-02-10 17:09:37 +00002005 data_type_ref Data, unsigned DataLen) {
Justin Bognere1c147c2014-03-28 22:03:19 +00002006 using namespace llvm::support;
Eugene Zelenkob7d89102017-11-11 00:08:50 +00002007
Peter Collingbournee3f65292018-05-18 19:46:24 +00002008 endian::Writer LE(Out, little);
Douglas Gregor09b69892011-02-10 17:09:37 +00002009 uint64_t Start = Out.tell(); (void)Start;
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00002010
Richard Smithf3f84612017-06-29 02:19:42 +00002011 unsigned char Flags = (Data.HFI.isImport << 5)
2012 | (Data.HFI.isPragmaOnce << 4)
Richard Smith040e1262017-06-02 01:55:39 +00002013 | (Data.HFI.DirInfo << 1)
2014 | Data.HFI.IndexHeaderMapHeader;
Justin Bognere1c147c2014-03-28 22:03:19 +00002015 LE.write<uint8_t>(Flags);
Richard Smith040e1262017-06-02 01:55:39 +00002016 LE.write<uint16_t>(Data.HFI.NumIncludes);
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00002017
Richard Smith040e1262017-06-02 01:55:39 +00002018 if (!Data.HFI.ControllingMacro)
2019 LE.write<uint32_t>(Data.HFI.ControllingMacroID);
Douglas Gregor09b69892011-02-10 17:09:37 +00002020 else
Richard Smith040e1262017-06-02 01:55:39 +00002021 LE.write<uint32_t>(Writer.getIdentifierRef(Data.HFI.ControllingMacro));
2022
Douglas Gregor4b123cb2011-07-28 04:50:02 +00002023 unsigned Offset = 0;
Richard Smith040e1262017-06-02 01:55:39 +00002024 if (!Data.HFI.Framework.empty()) {
Douglas Gregor4b123cb2011-07-28 04:50:02 +00002025 // If this header refers into a framework, save the framework name.
2026 llvm::StringMap<unsigned>::iterator Pos
Richard Smith040e1262017-06-02 01:55:39 +00002027 = FrameworkNameOffset.find(Data.HFI.Framework);
Douglas Gregor4b123cb2011-07-28 04:50:02 +00002028 if (Pos == FrameworkNameOffset.end()) {
2029 Offset = FrameworkStringData.size() + 1;
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00002030 FrameworkStringData.append(Data.HFI.Framework.begin(),
Richard Smith040e1262017-06-02 01:55:39 +00002031 Data.HFI.Framework.end());
Douglas Gregor4b123cb2011-07-28 04:50:02 +00002032 FrameworkStringData.push_back(0);
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00002033
Richard Smith040e1262017-06-02 01:55:39 +00002034 FrameworkNameOffset[Data.HFI.Framework] = Offset;
Douglas Gregor4b123cb2011-07-28 04:50:02 +00002035 } else
2036 Offset = Pos->second;
2037 }
Justin Bognere1c147c2014-03-28 22:03:19 +00002038 LE.write<uint32_t>(Offset);
Argyrios Kyrtzidisb146baa2013-03-13 21:13:51 +00002039
Richard Smith040e1262017-06-02 01:55:39 +00002040 auto EmitModule = [&](Module *M, ModuleMap::ModuleHeaderRole Role) {
2041 if (uint32_t ModID = Writer.getLocalOrImportedSubmoduleID(M)) {
2042 uint32_t Value = (ModID << 2) | (unsigned)Role;
Richard Smith386bb072015-08-18 23:42:23 +00002043 assert((Value >> 2) == ModID && "overflow in header module info");
2044 LE.write<uint32_t>(Value);
2045 }
Richard Smith040e1262017-06-02 01:55:39 +00002046 };
2047
2048 // FIXME: If the header is excluded, we should write out some
2049 // record of that fact.
2050 for (auto ModInfo : Data.KnownHeaders)
2051 EmitModule(ModInfo.getModule(), ModInfo.getRole());
2052 if (Data.Unresolved.getPointer())
2053 EmitModule(Data.Unresolved.getPointer(), Data.Unresolved.getInt());
Argyrios Kyrtzidisb146baa2013-03-13 21:13:51 +00002054
Douglas Gregor09b69892011-02-10 17:09:37 +00002055 assert(Out.tell() - Start == DataLen && "Wrong data length");
2056 }
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00002057
Douglas Gregor4b123cb2011-07-28 04:50:02 +00002058 const char *strings_begin() const { return FrameworkStringData.begin(); }
2059 const char *strings_end() const { return FrameworkStringData.end(); }
Douglas Gregor09b69892011-02-10 17:09:37 +00002060 };
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +00002061
Eugene Zelenkob7d89102017-11-11 00:08:50 +00002062} // namespace
Douglas Gregor09b69892011-02-10 17:09:37 +00002063
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00002064/// Write the header search block for the list of files that
Douglas Gregor09b69892011-02-10 17:09:37 +00002065///
2066/// \param HS The header search structure to save.
Richard Smith7ed1bc92014-12-05 22:42:13 +00002067void ASTWriter::WriteHeaderSearch(const HeaderSearch &HS) {
Richard Smith040e1262017-06-02 01:55:39 +00002068 HeaderFileInfoTrait GeneratorTrait(*this);
2069 llvm::OnDiskChainedHashTableGenerator<HeaderFileInfoTrait> Generator;
2070 SmallVector<const char *, 4> SavedStrings;
2071 unsigned NumHeaderSearchEntries = 0;
2072
2073 // Find all unresolved headers for the current module. We generally will
2074 // have resolved them before we get here, but not necessarily: we might be
2075 // compiling a preprocessed module, where there is no requirement for the
2076 // original files to exist any more.
Benjamin Krameree021d52017-06-02 17:30:24 +00002077 const HeaderFileInfo Empty; // So we can take a reference.
Richard Smith040e1262017-06-02 01:55:39 +00002078 if (WritingModule) {
2079 llvm::SmallVector<Module *, 16> Worklist(1, WritingModule);
2080 while (!Worklist.empty()) {
2081 Module *M = Worklist.pop_back_val();
2082 if (!M->isAvailable())
2083 continue;
2084
2085 // Map to disk files where possible, to pick up any missing stat
2086 // information. This also means we don't need to check the unresolved
2087 // headers list when emitting resolved headers in the first loop below.
2088 // FIXME: It'd be preferable to avoid doing this if we were given
2089 // sufficient stat information in the module map.
2090 HS.getModuleMap().resolveHeaderDirectives(M);
2091
2092 // If the file didn't exist, we can still create a module if we were given
2093 // enough information in the module map.
2094 for (auto U : M->MissingHeaders) {
2095 // Check that we were given enough information to build a module
2096 // without this file existing on disk.
2097 if (!U.Size || (!U.ModTime && IncludeTimestamps)) {
2098 PP->Diag(U.FileNameLoc, diag::err_module_no_size_mtime_for_header)
2099 << WritingModule->getFullModuleName() << U.Size.hasValue()
2100 << U.FileName;
2101 continue;
2102 }
2103
2104 // Form the effective relative pathname for the file.
2105 SmallString<128> Filename(M->Directory->getName());
2106 llvm::sys::path::append(Filename, U.FileName);
2107 PreparePathForOutput(Filename);
2108
2109 StringRef FilenameDup = strdup(Filename.c_str());
2110 SavedStrings.push_back(FilenameDup.data());
2111
2112 HeaderFileInfoTrait::key_type Key = {
2113 FilenameDup, *U.Size, IncludeTimestamps ? *U.ModTime : 0
2114 };
2115 HeaderFileInfoTrait::data_type Data = {
Benjamin Krameree021d52017-06-02 17:30:24 +00002116 Empty, {}, {M, ModuleMap::headerKindToRole(U.Kind)}
Richard Smith040e1262017-06-02 01:55:39 +00002117 };
2118 // FIXME: Deal with cases where there are multiple unresolved header
2119 // directives in different submodules for the same header.
2120 Generator.insert(Key, Data, GeneratorTrait);
2121 ++NumHeaderSearchEntries;
2122 }
2123
2124 Worklist.append(M->submodule_begin(), M->submodule_end());
2125 }
2126 }
2127
Chris Lattner0e62c1c2011-07-23 10:55:15 +00002128 SmallVector<const FileEntry *, 16> FilesByUID;
Douglas Gregor09b69892011-02-10 17:09:37 +00002129 HS.getFileMgr().GetUniqueIDMapping(FilesByUID);
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00002130
Douglas Gregor09b69892011-02-10 17:09:37 +00002131 if (FilesByUID.size() > HS.header_file_size())
2132 FilesByUID.resize(HS.header_file_size());
Richard Smith040e1262017-06-02 01:55:39 +00002133
Douglas Gregor09b69892011-02-10 17:09:37 +00002134 for (unsigned UID = 0, LastUID = FilesByUID.size(); UID != LastUID; ++UID) {
2135 const FileEntry *File = FilesByUID[UID];
2136 if (!File)
2137 continue;
2138
Richard Smith386bb072015-08-18 23:42:23 +00002139 // Get the file info. This will load info from the external source if
2140 // necessary. Skip emitting this file if we have no information on it
2141 // as a header file (in which case HFI will be null) or if it hasn't
2142 // changed since it was loaded. Also skip it if it's for a modular header
2143 // from a different module; in that case, we rely on the module(s)
2144 // containing the header to provide this information.
Richard Smithd8879c82015-08-24 21:59:32 +00002145 const HeaderFileInfo *HFI =
2146 HS.getExistingFileInfo(File, /*WantExternal*/!Chain);
2147 if (!HFI || (HFI->isModuleHeader && !HFI->isCompilingModuleHeader))
Argyrios Kyrtzidis6f722b42013-05-08 23:46:46 +00002148 continue;
Douglas Gregor09b69892011-02-10 17:09:37 +00002149
Richard Smith7ed1bc92014-12-05 22:42:13 +00002150 // Massage the file path into an appropriate form.
Mehdi Amini004b9c72016-10-10 22:52:47 +00002151 StringRef Filename = File->getName();
Richard Smith7ed1bc92014-12-05 22:42:13 +00002152 SmallString<128> FilenameTmp(Filename);
2153 if (PreparePathForOutput(FilenameTmp)) {
2154 // If we performed any translation on the file name at all, we need to
2155 // save this string, since the generator will refer to it later.
Mehdi Amini004b9c72016-10-10 22:52:47 +00002156 Filename = StringRef(strdup(FilenameTmp.c_str()));
2157 SavedStrings.push_back(Filename.data());
Douglas Gregor09b69892011-02-10 17:09:37 +00002158 }
Richard Smith7ed1bc92014-12-05 22:42:13 +00002159
Richard Smith040e1262017-06-02 01:55:39 +00002160 HeaderFileInfoTrait::key_type Key = {
2161 Filename, File->getSize(), getTimestampForOutput(File)
2162 };
2163 HeaderFileInfoTrait::data_type Data = {
2164 *HFI, HS.getModuleMap().findAllModulesForHeader(File), {}
2165 };
2166 Generator.insert(Key, Data, GeneratorTrait);
Douglas Gregor09b69892011-02-10 17:09:37 +00002167 ++NumHeaderSearchEntries;
2168 }
Richard Smith040e1262017-06-02 01:55:39 +00002169
Douglas Gregor09b69892011-02-10 17:09:37 +00002170 // Create the on-disk hash table in a buffer.
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00002171 SmallString<4096> TableData;
Douglas Gregor09b69892011-02-10 17:09:37 +00002172 uint32_t BucketOffset;
2173 {
Justin Bognere1c147c2014-03-28 22:03:19 +00002174 using namespace llvm::support;
Eugene Zelenkob7d89102017-11-11 00:08:50 +00002175
Douglas Gregor09b69892011-02-10 17:09:37 +00002176 llvm::raw_svector_ostream Out(TableData);
2177 // Make sure that no bucket is at offset 0
Peter Collingbournee3f65292018-05-18 19:46:24 +00002178 endian::write<uint32_t>(Out, 0, little);
Douglas Gregor09b69892011-02-10 17:09:37 +00002179 BucketOffset = Generator.Emit(Out, GeneratorTrait);
2180 }
2181
2182 // Create a blob abbreviation
2183 using namespace llvm;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002184
David Blaikieb44f0bf2017-01-04 22:36:43 +00002185 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Douglas Gregor09b69892011-02-10 17:09:37 +00002186 Abbrev->Add(BitCodeAbbrevOp(HEADER_SEARCH_TABLE));
2187 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
2188 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
Douglas Gregor4b123cb2011-07-28 04:50:02 +00002189 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
Douglas Gregor09b69892011-02-10 17:09:37 +00002190 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
David Blaikieb44f0bf2017-01-04 22:36:43 +00002191 unsigned TableAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00002192
Douglas Gregor4b123cb2011-07-28 04:50:02 +00002193 // Write the header search table
Mehdi Amini57a41912015-09-10 01:46:39 +00002194 RecordData::value_type Record[] = {HEADER_SEARCH_TABLE, BucketOffset,
2195 NumHeaderSearchEntries, TableData.size()};
Douglas Gregor4b123cb2011-07-28 04:50:02 +00002196 TableData.append(GeneratorTrait.strings_begin(),GeneratorTrait.strings_end());
Yaron Keren92e1b622015-03-18 10:17:07 +00002197 Stream.EmitRecordWithBlob(TableAbbrev, Record, TableData);
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00002198
Douglas Gregor09b69892011-02-10 17:09:37 +00002199 // Free all of the strings we had to duplicate.
2200 for (unsigned I = 0, N = SavedStrings.size(); I != N; ++I)
David Greenebae0e352013-01-15 22:09:43 +00002201 free(const_cast<char *>(SavedStrings[I]));
Douglas Gregor09b69892011-02-10 17:09:37 +00002202}
2203
George Rimarc39f5492017-01-17 15:45:31 +00002204static void emitBlob(llvm::BitstreamWriter &Stream, StringRef Blob,
2205 unsigned SLocBufferBlobCompressedAbbrv,
2206 unsigned SLocBufferBlobAbbrv) {
Eugene Zelenkob7d89102017-11-11 00:08:50 +00002207 using RecordDataType = ASTWriter::RecordData::value_type;
George Rimarc39f5492017-01-17 15:45:31 +00002208
2209 // Compress the buffer if possible. We expect that almost all PCM
2210 // consumers will not want its contents.
2211 SmallString<0> CompressedBuffer;
2212 if (llvm::zlib::isAvailable()) {
2213 llvm::Error E = llvm::zlib::compress(Blob.drop_back(1), CompressedBuffer);
2214 if (!E) {
2215 RecordDataType Record[] = {SM_SLOC_BUFFER_BLOB_COMPRESSED,
2216 Blob.size() - 1};
2217 Stream.EmitRecordWithBlob(SLocBufferBlobCompressedAbbrv, Record,
2218 CompressedBuffer);
2219 return;
2220 }
2221 llvm::consumeError(std::move(E));
2222 }
2223
2224 RecordDataType Record[] = {SM_SLOC_BUFFER_BLOB};
2225 Stream.EmitRecordWithBlob(SLocBufferBlobAbbrv, Record, Blob);
2226}
2227
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00002228/// Writes the block containing the serialized form of the
Douglas Gregora7f71a92009-04-10 03:52:48 +00002229/// source manager.
2230///
2231/// TODO: We should probably use an on-disk hash table (stored in a
2232/// blob), indexed based on the file name, so that we only create
2233/// entries for files that we actually need. In the common case (no
2234/// errors), we probably won't have to create file entries for any of
2235/// the files in the AST.
Sebastian Redl55c0ad52010-08-18 23:56:21 +00002236void ASTWriter::WriteSourceManagerBlock(SourceManager &SourceMgr,
Richard Smith7ed1bc92014-12-05 22:42:13 +00002237 const Preprocessor &PP) {
Douglas Gregor258ae542009-04-27 06:38:32 +00002238 RecordData Record;
2239
Chris Lattner0910e3b2009-04-10 17:16:57 +00002240 // Enter the source manager block.
Richard Smithaada85c2016-02-06 02:06:43 +00002241 Stream.EnterSubblock(SOURCE_MANAGER_BLOCK_ID, 4);
Douglas Gregora7f71a92009-04-10 03:52:48 +00002242
2243 // Abbreviations for the various kinds of source-location entries.
Chris Lattnerc4976c732009-04-27 19:03:22 +00002244 unsigned SLocFileAbbrv = CreateSLocFileAbbrev(Stream);
2245 unsigned SLocBufferAbbrv = CreateSLocBufferAbbrev(Stream);
Richard Smithaada85c2016-02-06 02:06:43 +00002246 unsigned SLocBufferBlobAbbrv = CreateSLocBufferBlobAbbrev(Stream, false);
2247 unsigned SLocBufferBlobCompressedAbbrv =
2248 CreateSLocBufferBlobAbbrev(Stream, true);
Chandler Carruthf92ac9e2011-07-15 07:25:21 +00002249 unsigned SLocExpansionAbbrv = CreateSLocExpansionAbbrev(Stream);
Douglas Gregora7f71a92009-04-10 03:52:48 +00002250
Douglas Gregor258ae542009-04-27 06:38:32 +00002251 // Write out the source location entry table. We skip the first
2252 // entry, which is always the same dummy entry.
Chris Lattner12d61d32009-04-27 19:01:47 +00002253 std::vector<uint32_t> SLocEntryOffsets;
Douglas Gregor258ae542009-04-27 06:38:32 +00002254 RecordData PreloadSLocs;
Douglas Gregor925296b2011-07-19 16:10:42 +00002255 SLocEntryOffsets.reserve(SourceMgr.local_sloc_entry_size() - 1);
2256 for (unsigned I = 1, N = SourceMgr.local_sloc_entry_size();
Sebastian Redl5c415f32010-07-22 17:01:13 +00002257 I != N; ++I) {
Douglas Gregor8655e882009-10-16 22:46:09 +00002258 // Get this source location entry.
Douglas Gregor925296b2011-07-19 16:10:42 +00002259 const SrcMgr::SLocEntry *SLoc = &SourceMgr.getLocalSLocEntry(I);
Argyrios Kyrtzidis4db774a2012-10-02 21:09:17 +00002260 FileID FID = FileID::get(I);
2261 assert(&SourceMgr.getSLocEntry(FID) == SLoc);
Kovarththanan Rajaratnama9c81a82010-03-14 07:06:50 +00002262
Douglas Gregor258ae542009-04-27 06:38:32 +00002263 // Record the offset of this source-location entry.
2264 SLocEntryOffsets.push_back(Stream.GetCurrentBitNo());
2265
2266 // Figure out which record code to use.
2267 unsigned Code;
2268 if (SLoc->isFile()) {
Douglas Gregor9dc32122011-11-16 20:05:18 +00002269 const SrcMgr::ContentCache *Cache = SLoc->getFile().getContentCache();
2270 if (Cache->OrigEntry) {
Sebastian Redl539c5062010-08-18 23:57:32 +00002271 Code = SM_SLOC_FILE_ENTRY;
Argyrios Kyrtzidis92dd4662011-06-02 20:01:46 +00002272 } else
Sebastian Redl539c5062010-08-18 23:57:32 +00002273 Code = SM_SLOC_BUFFER_ENTRY;
Douglas Gregor258ae542009-04-27 06:38:32 +00002274 } else
Chandler Carruthf92ac9e2011-07-15 07:25:21 +00002275 Code = SM_SLOC_EXPANSION_ENTRY;
Douglas Gregor258ae542009-04-27 06:38:32 +00002276 Record.clear();
2277 Record.push_back(Code);
2278
Douglas Gregor925296b2011-07-19 16:10:42 +00002279 // Starting offset of this entry within this module, so skip the dummy.
2280 Record.push_back(SLoc->getOffset() - 2);
Douglas Gregor258ae542009-04-27 06:38:32 +00002281 if (SLoc->isFile()) {
2282 const SrcMgr::FileInfo &File = SLoc->getFile();
Richard Smithb22a1d12016-03-27 20:13:24 +00002283 AddSourceLocation(File.getIncludeLoc(), Record);
Douglas Gregor258ae542009-04-27 06:38:32 +00002284 Record.push_back(File.getFileCharacteristic()); // FIXME: stable encoding
2285 Record.push_back(File.hasLineDirectives());
2286
2287 const SrcMgr::ContentCache *Content = File.getContentCache();
Richard Smithaada85c2016-02-06 02:06:43 +00002288 bool EmitBlob = false;
Argyrios Kyrtzidis11e6f0a2011-03-05 01:03:53 +00002289 if (Content->OrigEntry) {
2290 assert(Content->OrigEntry == Content->ContentsEntry &&
Douglas Gregor9dc32122011-11-16 20:05:18 +00002291 "Writing to AST an overridden file is not supported");
Argyrios Kyrtzidis11e6f0a2011-03-05 01:03:53 +00002292
Douglas Gregor3120d2c2012-10-22 18:42:04 +00002293 // The source location entry is a file. Emit input file ID.
2294 assert(InputFileIDs[Content->OrigEntry] != 0 && "Missed file entry");
2295 Record.push_back(InputFileIDs[Content->OrigEntry]);
Mike Stump11289f42009-09-09 15:08:12 +00002296
Argyrios Kyrtzidis61ef3db2011-08-21 23:33:04 +00002297 Record.push_back(File.NumCreatedFIDs);
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00002298
Argyrios Kyrtzidis4db774a2012-10-02 21:09:17 +00002299 FileDeclIDsTy::iterator FDI = FileDeclIDs.find(FID);
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00002300 if (FDI != FileDeclIDs.end()) {
2301 Record.push_back(FDI->second->FirstDeclIndex);
2302 Record.push_back(FDI->second->DeclIDs.size());
2303 } else {
2304 Record.push_back(0);
2305 Record.push_back(0);
2306 }
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00002307
Mehdi Amini5ae4a852015-09-09 20:35:37 +00002308 Stream.EmitRecordWithAbbrev(SLocFileAbbrv, Record);
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00002309
Richard Smithaada85c2016-02-06 02:06:43 +00002310 if (Content->BufferOverridden || Content->IsTransient)
2311 EmitBlob = true;
Douglas Gregor258ae542009-04-27 06:38:32 +00002312 } else {
2313 // The source location entry is a buffer. The blob associated
2314 // with this entry contains the contents of the buffer.
2315
2316 // We add one to the size so that we capture the trailing NULL
2317 // that is required by llvm::MemoryBuffer::getMemBuffer (on
2318 // the reader side).
Duncan P. N. Exon Smithf5848192019-08-26 20:32:05 +00002319 const llvm::MemoryBuffer *Buffer =
2320 Content->getBuffer(PP.getDiagnostics(), PP.getFileManager());
Mehdi Amini99d1b292016-10-01 16:38:28 +00002321 StringRef Name = Buffer->getBufferIdentifier();
Mehdi Amini5ae4a852015-09-09 20:35:37 +00002322 Stream.EmitRecordWithBlob(SLocBufferAbbrv, Record,
Mehdi Amini99d1b292016-10-01 16:38:28 +00002323 StringRef(Name.data(), Name.size() + 1));
Richard Smithaada85c2016-02-06 02:06:43 +00002324 EmitBlob = true;
Douglas Gregor258ae542009-04-27 06:38:32 +00002325
Mehdi Amini99d1b292016-10-01 16:38:28 +00002326 if (Name == "<built-in>")
Douglas Gregor925296b2011-07-19 16:10:42 +00002327 PreloadSLocs.push_back(SLocEntryOffsets.size());
Douglas Gregor258ae542009-04-27 06:38:32 +00002328 }
Richard Smithaada85c2016-02-06 02:06:43 +00002329
2330 if (EmitBlob) {
2331 // Include the implicit terminating null character in the on-disk buffer
2332 // if we're writing it uncompressed.
2333 const llvm::MemoryBuffer *Buffer =
Duncan P. N. Exon Smithf5848192019-08-26 20:32:05 +00002334 Content->getBuffer(PP.getDiagnostics(), PP.getFileManager());
Richard Smithaada85c2016-02-06 02:06:43 +00002335 StringRef Blob(Buffer->getBufferStart(), Buffer->getBufferSize() + 1);
George Rimarc39f5492017-01-17 15:45:31 +00002336 emitBlob(Stream, Blob, SLocBufferBlobCompressedAbbrv,
2337 SLocBufferBlobAbbrv);
Richard Smithaada85c2016-02-06 02:06:43 +00002338 }
Douglas Gregor258ae542009-04-27 06:38:32 +00002339 } else {
Chandler Carruthf92ac9e2011-07-15 07:25:21 +00002340 // The source location entry is a macro expansion.
Chandler Carruthee4c1d12011-07-26 04:56:51 +00002341 const SrcMgr::ExpansionInfo &Expansion = SLoc->getExpansion();
Richard Smithb22a1d12016-03-27 20:13:24 +00002342 AddSourceLocation(Expansion.getSpellingLoc(), Record);
2343 AddSourceLocation(Expansion.getExpansionLocStart(), Record);
2344 AddSourceLocation(Expansion.isMacroArgExpansion()
2345 ? SourceLocation()
2346 : Expansion.getExpansionLocEnd(),
2347 Record);
Richard Smithb5f81712018-04-30 05:25:48 +00002348 Record.push_back(Expansion.isExpansionTokenRange());
Douglas Gregor258ae542009-04-27 06:38:32 +00002349
2350 // Compute the token length for this macro expansion.
Douglas Gregor925296b2011-07-19 16:10:42 +00002351 unsigned NextOffset = SourceMgr.getNextLocalOffset();
Douglas Gregor8655e882009-10-16 22:46:09 +00002352 if (I + 1 != N)
Douglas Gregor925296b2011-07-19 16:10:42 +00002353 NextOffset = SourceMgr.getLocalSLocEntry(I + 1).getOffset();
Douglas Gregor258ae542009-04-27 06:38:32 +00002354 Record.push_back(NextOffset - SLoc->getOffset() - 1);
Mehdi Amini5ae4a852015-09-09 20:35:37 +00002355 Stream.EmitRecordWithAbbrev(SLocExpansionAbbrv, Record);
Douglas Gregor258ae542009-04-27 06:38:32 +00002356 }
2357 }
2358
Douglas Gregor8f45df52009-04-16 22:23:12 +00002359 Stream.ExitBlock();
Douglas Gregor258ae542009-04-27 06:38:32 +00002360
2361 if (SLocEntryOffsets.empty())
2362 return;
2363
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00002364 // Write the source-location offsets table into the AST block. This
Douglas Gregor258ae542009-04-27 06:38:32 +00002365 // table is used for lazily loading source-location information.
2366 using namespace llvm;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002367
David Blaikieb44f0bf2017-01-04 22:36:43 +00002368 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Sebastian Redl539c5062010-08-18 23:57:32 +00002369 Abbrev->Add(BitCodeAbbrevOp(SOURCE_LOCATION_OFFSETS));
Douglas Gregor258ae542009-04-27 06:38:32 +00002370 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 16)); // # of slocs
Douglas Gregor925296b2011-07-19 16:10:42 +00002371 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 16)); // total size
Douglas Gregor258ae542009-04-27 06:38:32 +00002372 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // offsets
David Blaikieb44f0bf2017-01-04 22:36:43 +00002373 unsigned SLocOffsetsAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Mehdi Amini57a41912015-09-10 01:46:39 +00002374 {
2375 RecordData::value_type Record[] = {
2376 SOURCE_LOCATION_OFFSETS, SLocEntryOffsets.size(),
2377 SourceMgr.getNextLocalOffset() - 1 /* skip dummy */};
2378 Stream.EmitRecordWithBlob(SLocOffsetsAbbrev, Record,
2379 bytes(SLocEntryOffsets));
2380 }
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00002381 // Write the source location entry preloads array, telling the AST
Douglas Gregor258ae542009-04-27 06:38:32 +00002382 // reader which source locations entries it should load eagerly.
Sebastian Redl539c5062010-08-18 23:57:32 +00002383 Stream.EmitRecord(SOURCE_LOCATION_PRELOADS, PreloadSLocs);
Douglas Gregor925296b2011-07-19 16:10:42 +00002384
2385 // Write the line table. It depends on remapping working, so it must come
2386 // after the source location offsets.
2387 if (SourceMgr.hasLineTable()) {
2388 LineTableInfo &LineTable = SourceMgr.getLineTable();
2389
2390 Record.clear();
Richard Smith63078492015-09-01 07:41:55 +00002391
2392 // Emit the needed file names.
2393 llvm::DenseMap<int, int> FilenameMap;
Hans Wennborg14487362017-12-04 22:28:45 +00002394 FilenameMap[-1] = -1; // For unspecified filenames.
Richard Smith63078492015-09-01 07:41:55 +00002395 for (const auto &L : LineTable) {
2396 if (L.first.ID < 0)
2397 continue;
2398 for (auto &LE : L.second) {
2399 if (FilenameMap.insert(std::make_pair(LE.FilenameID,
Hans Wennborg14487362017-12-04 22:28:45 +00002400 FilenameMap.size() - 1)).second)
Richard Smith63078492015-09-01 07:41:55 +00002401 AddPath(LineTable.getFilename(LE.FilenameID), Record);
2402 }
2403 }
2404 Record.push_back(0);
Douglas Gregor925296b2011-07-19 16:10:42 +00002405
2406 // Emit the line entries
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002407 for (const auto &L : LineTable) {
Douglas Gregor925296b2011-07-19 16:10:42 +00002408 // Only emit entries for local files.
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002409 if (L.first.ID < 0)
Douglas Gregor925296b2011-07-19 16:10:42 +00002410 continue;
2411
2412 // Emit the file ID
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002413 Record.push_back(L.first.ID);
Douglas Gregor925296b2011-07-19 16:10:42 +00002414
2415 // Emit the line entries
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002416 Record.push_back(L.second.size());
2417 for (const auto &LE : L.second) {
2418 Record.push_back(LE.FileOffset);
2419 Record.push_back(LE.LineNo);
2420 Record.push_back(FilenameMap[LE.FilenameID]);
2421 Record.push_back((unsigned)LE.FileKind);
2422 Record.push_back(LE.IncludeOffset);
Douglas Gregor925296b2011-07-19 16:10:42 +00002423 }
2424 }
Richard Smith63078492015-09-01 07:41:55 +00002425
Douglas Gregor925296b2011-07-19 16:10:42 +00002426 Stream.EmitRecord(SOURCE_MANAGER_LINE_TABLE, Record);
2427 }
Douglas Gregora7f71a92009-04-10 03:52:48 +00002428}
2429
Douglas Gregorc5046832009-04-27 18:38:38 +00002430//===----------------------------------------------------------------------===//
2431// Preprocessor Serialization
2432//===----------------------------------------------------------------------===//
2433
Argyrios Kyrtzidis0aef0f02013-03-15 22:43:10 +00002434static bool shouldIgnoreMacro(MacroDirective *MD, bool IsModule,
2435 const Preprocessor &PP) {
Argyrios Kyrtzidisb6210df2013-03-26 17:17:01 +00002436 if (MacroInfo *MI = MD->getMacroInfo())
2437 if (MI->isBuiltinMacro())
2438 return true;
Argyrios Kyrtzidis0aef0f02013-03-15 22:43:10 +00002439
2440 if (IsModule) {
2441 SourceLocation Loc = MD->getLocation();
2442 if (Loc.isInvalid())
2443 return true;
2444 if (PP.getSourceManager().getFileID(Loc) == PP.getPredefinesFileID())
2445 return true;
2446 }
2447
2448 return false;
2449}
2450
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00002451/// Writes the block containing the serialized form of the
Chris Lattnereeffaef2009-04-10 17:15:23 +00002452/// preprocessor.
Douglas Gregor4a69c2e2011-09-01 17:04:32 +00002453void ASTWriter::WritePreprocessor(const Preprocessor &PP, bool IsModule) {
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002454 PreprocessingRecord *PPRec = PP.getPreprocessingRecord();
2455 if (PPRec)
2456 WritePreprocessorDetail(*PPRec);
2457
Chris Lattnerbaa52f42009-04-10 18:00:12 +00002458 RecordData Record;
Richard Smithd7329392015-04-21 21:46:32 +00002459 RecordData ModuleMacroRecord;
Chris Lattner0910e3b2009-04-10 17:16:57 +00002460
Chris Lattner0af3ba12009-04-13 01:29:17 +00002461 // If the preprocessor __COUNTER__ value has been bumped, remember it.
2462 if (PP.getCounterValue() != 0) {
Mehdi Amini57a41912015-09-10 01:46:39 +00002463 RecordData::value_type Record[] = {PP.getCounterValue()};
Sebastian Redl539c5062010-08-18 23:57:32 +00002464 Stream.EmitRecord(PP_COUNTER_VALUE, Record);
Douglas Gregoreda6a892009-04-26 00:07:37 +00002465 }
2466
Erik Verbruggenb34c79f2017-05-30 11:54:55 +00002467 if (PP.isRecordingPreamble() && PP.hasRecordedPreamble()) {
2468 assert(!IsModule);
Erik Verbruggen4d1eb2d2017-11-03 09:40:07 +00002469 auto SkipInfo = PP.getPreambleSkipInfo();
2470 if (SkipInfo.hasValue()) {
2471 Record.push_back(true);
2472 AddSourceLocation(SkipInfo->HashTokenLoc, Record);
2473 AddSourceLocation(SkipInfo->IfTokenLoc, Record);
2474 Record.push_back(SkipInfo->FoundNonSkipPortion);
2475 Record.push_back(SkipInfo->FoundElse);
2476 AddSourceLocation(SkipInfo->ElseLoc, Record);
2477 } else {
2478 Record.push_back(false);
2479 }
Erik Verbruggenb34c79f2017-05-30 11:54:55 +00002480 for (const auto &Cond : PP.getPreambleConditionalStack()) {
2481 AddSourceLocation(Cond.IfLoc, Record);
2482 Record.push_back(Cond.WasSkipping);
2483 Record.push_back(Cond.FoundNonSkip);
2484 Record.push_back(Cond.FoundElse);
2485 }
2486 Stream.EmitRecord(PP_CONDITIONAL_STACK, Record);
2487 Record.clear();
2488 }
2489
Douglas Gregoreda6a892009-04-26 00:07:37 +00002490 // Enter the preprocessor block.
Douglas Gregor796d76a2010-10-20 22:00:55 +00002491 Stream.EnterSubblock(PREPROCESSOR_BLOCK_ID, 3);
Mike Stump11289f42009-09-09 15:08:12 +00002492
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00002493 // If the AST file contains __DATE__ or __TIME__ emit a warning about this.
Richard Smithb5aaf5a2015-09-01 02:35:58 +00002494 // FIXME: Include a location for the use, and say which one was used.
Douglas Gregoreda6a892009-04-26 00:07:37 +00002495 if (PP.SawDateOrTime())
Richard Smithb5aaf5a2015-09-01 02:35:58 +00002496 PP.Diag(SourceLocation(), diag::warn_module_uses_date_time) << IsModule;
Douglas Gregor796d76a2010-10-20 22:00:55 +00002497
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002498 // Loop over all the macro directives that are live at the end of the file,
Chris Lattnerbaa52f42009-04-10 18:00:12 +00002499 // emitting each to the PP section.
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00002500
Richard Smithee977932015-05-01 21:22:17 +00002501 // Construct the list of identifiers with macro directives that need to be
2502 // serialized.
2503 SmallVector<const IdentifierInfo *, 128> MacroIdentifiers;
2504 for (auto &Id : PP.getIdentifierTable())
2505 if (Id.second->hadMacroDefinition() &&
2506 (!Id.second->isFromAST() ||
2507 Id.second->hasChangedSinceDeserialization()))
2508 MacroIdentifiers.push_back(Id.second);
Douglas Gregor2e5571d2011-02-10 18:20:09 +00002509 // Sort the set of macro definitions that need to be serialized by the
2510 // name of the macro, to provide a stable ordering.
Benjamin Kramercd2bae32019-08-22 17:32:16 +00002511 llvm::sort(MacroIdentifiers, llvm::deref<std::less<>>());
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002512
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002513 // Emit the macro directives as a list and associate the offset with the
2514 // identifier they belong to.
Richard Smithee977932015-05-01 21:22:17 +00002515 for (const IdentifierInfo *Name : MacroIdentifiers) {
2516 MacroDirective *MD = PP.getLocalMacroDirectiveHistory(Name);
Richard Smithd7329392015-04-21 21:46:32 +00002517 auto StartOffset = Stream.GetCurrentBitNo();
2518
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002519 // Emit the macro directives in reverse source order.
2520 for (; MD; MD = MD->getPrevious()) {
Richard Smithd7329392015-04-21 21:46:32 +00002521 // Once we hit an ignored macro, we're done: the rest of the chain
2522 // will all be ignored macros.
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002523 if (shouldIgnoreMacro(MD, IsModule, PP))
Richard Smithd7329392015-04-21 21:46:32 +00002524 break;
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002525
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002526 AddSourceLocation(MD->getLocation(), Record);
Argyrios Kyrtzidisb6210df2013-03-26 17:17:01 +00002527 Record.push_back(MD->getKind());
Richard Smithdaa69e02014-07-25 04:40:03 +00002528 if (auto *DefMD = dyn_cast<DefMacroDirective>(MD)) {
Richard Smith3981b172015-04-30 02:16:23 +00002529 Record.push_back(getMacroRef(DefMD->getInfo(), Name));
Richard Smith713369b2015-04-23 20:40:50 +00002530 } else if (auto *VisMD = dyn_cast<VisibilityMacroDirective>(MD)) {
Argyrios Kyrtzidisb6210df2013-03-26 17:17:01 +00002531 Record.push_back(VisMD->isPublic());
2532 }
Richard Smithb8b2ed62015-04-23 18:18:26 +00002533 }
Richard Smithd7329392015-04-21 21:46:32 +00002534
Richard Smithb8b2ed62015-04-23 18:18:26 +00002535 // Write out any exported module macros.
Richard Smithee977932015-05-01 21:22:17 +00002536 bool EmittedModuleMacros = false;
Manman Ren33d80292016-05-31 18:19:32 +00002537 // We write out exported module macros for PCH as well.
2538 auto Leafs = PP.getLeafModuleMacros(Name);
2539 SmallVector<ModuleMacro*, 8> Worklist(Leafs.begin(), Leafs.end());
2540 llvm::DenseMap<ModuleMacro*, unsigned> Visits;
2541 while (!Worklist.empty()) {
2542 auto *Macro = Worklist.pop_back_val();
Richard Smithd7329392015-04-21 21:46:32 +00002543
Manman Ren33d80292016-05-31 18:19:32 +00002544 // Emit a record indicating this submodule exports this macro.
2545 ModuleMacroRecord.push_back(
2546 getSubmoduleID(Macro->getOwningModule()));
2547 ModuleMacroRecord.push_back(getMacroRef(Macro->getMacroInfo(), Name));
2548 for (auto *M : Macro->overrides())
2549 ModuleMacroRecord.push_back(getSubmoduleID(M->getOwningModule()));
Richard Smithd7329392015-04-21 21:46:32 +00002550
Manman Ren33d80292016-05-31 18:19:32 +00002551 Stream.EmitRecord(PP_MODULE_MACRO, ModuleMacroRecord);
2552 ModuleMacroRecord.clear();
Richard Smithd7329392015-04-21 21:46:32 +00002553
Manman Ren33d80292016-05-31 18:19:32 +00002554 // Enqueue overridden macros once we've visited all their ancestors.
2555 for (auto *M : Macro->overrides())
2556 if (++Visits[M] == M->getNumOverridingMacros())
2557 Worklist.push_back(M);
Richard Smithee977932015-05-01 21:22:17 +00002558
Manman Ren33d80292016-05-31 18:19:32 +00002559 EmittedModuleMacros = true;
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002560 }
Richard Smithd7329392015-04-21 21:46:32 +00002561
Richard Smithee977932015-05-01 21:22:17 +00002562 if (Record.empty() && !EmittedModuleMacros)
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002563 continue;
2564
Richard Smithd7329392015-04-21 21:46:32 +00002565 IdentMacroDirectivesOffsetMap[Name] = StartOffset;
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002566 Stream.EmitRecord(PP_MACRO_DIRECTIVE_HISTORY, Record);
2567 Record.clear();
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002568 }
Alexander Kornienko1d26c022012-09-25 17:18:14 +00002569
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00002570 /// Offsets of each of the macros into the bitstream, indexed by
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00002571 /// the local macro ID
2572 ///
2573 /// For each identifier that is associated with a macro, this map
2574 /// provides the offset into the bitstream where that macro is
2575 /// defined.
2576 std::vector<uint32_t> MacroOffsets;
2577
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002578 for (unsigned I = 0, N = MacroInfosToEmit.size(); I != N; ++I) {
2579 const IdentifierInfo *Name = MacroInfosToEmit[I].Name;
2580 MacroInfo *MI = MacroInfosToEmit[I].MI;
2581 MacroID ID = MacroInfosToEmit[I].ID;
Douglas Gregoreb114da2010-10-01 01:03:07 +00002582
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002583 if (ID < FirstMacroID) {
2584 assert(0 && "Loaded MacroInfo entered MacroInfosToEmit ?");
2585 continue;
Chris Lattner2199f5b2009-04-10 18:08:30 +00002586 }
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002587
2588 // Record the local offset of this macro.
2589 unsigned Index = ID - FirstMacroID;
2590 if (Index == MacroOffsets.size())
2591 MacroOffsets.push_back(Stream.GetCurrentBitNo());
2592 else {
2593 if (Index > MacroOffsets.size())
2594 MacroOffsets.resize(Index + 1);
2595
2596 MacroOffsets[Index] = Stream.GetCurrentBitNo();
2597 }
2598
2599 AddIdentifierRef(Name, Record);
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002600 AddSourceLocation(MI->getDefinitionLoc(), Record);
2601 AddSourceLocation(MI->getDefinitionEndLoc(), Record);
2602 Record.push_back(MI->isUsed());
Argyrios Kyrtzidis9ef53ce2014-04-09 18:21:23 +00002603 Record.push_back(MI->isUsedForHeaderGuard());
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002604 unsigned Code;
2605 if (MI->isObjectLike()) {
2606 Code = PP_MACRO_OBJECT_LIKE;
2607 } else {
2608 Code = PP_MACRO_FUNCTION_LIKE;
2609
2610 Record.push_back(MI->isC99Varargs());
2611 Record.push_back(MI->isGNUVarargs());
2612 Record.push_back(MI->hasCommaPasting());
Faisal Valiac506d72017-07-17 17:18:43 +00002613 Record.push_back(MI->getNumParams());
2614 for (const IdentifierInfo *Param : MI->params())
2615 AddIdentifierRef(Param, Record);
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002616 }
2617
2618 // If we have a detailed preprocessing record, record the macro definition
2619 // ID that corresponds to this macro.
2620 if (PPRec)
2621 Record.push_back(MacroDefinitions[PPRec->findMacroDefinition(MI)]);
2622
2623 Stream.EmitRecord(Code, Record);
2624 Record.clear();
2625
2626 // Emit the tokens array.
2627 for (unsigned TokNo = 0, e = MI->getNumTokens(); TokNo != e; ++TokNo) {
2628 // Note that we know that the preprocessor does not have any annotation
2629 // tokens in it because they are created by the parser, and thus can't
2630 // be in a macro definition.
2631 const Token &Tok = MI->getReplacementToken(TokNo);
John McCallf413f5e2013-05-03 00:10:13 +00002632 AddToken(Tok, Record);
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002633 Stream.EmitRecord(PP_TOKEN, Record);
2634 Record.clear();
2635 }
2636 ++NumMacros;
Chris Lattnerbaa52f42009-04-10 18:00:12 +00002637 }
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002638
Douglas Gregor92a96f52011-02-08 21:58:10 +00002639 Stream.ExitBlock();
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00002640
2641 // Write the offsets table for macro IDs.
2642 using namespace llvm;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002643
David Blaikieb44f0bf2017-01-04 22:36:43 +00002644 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00002645 Abbrev->Add(BitCodeAbbrevOp(MACRO_OFFSET));
2646 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // # of macros
2647 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // first ID
2648 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
2649
David Blaikieb44f0bf2017-01-04 22:36:43 +00002650 unsigned MacroOffsetAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Mehdi Amini57a41912015-09-10 01:46:39 +00002651 {
2652 RecordData::value_type Record[] = {MACRO_OFFSET, MacroOffsets.size(),
2653 FirstMacroID - NUM_PREDEF_MACRO_IDS};
2654 Stream.EmitRecordWithBlob(MacroOffsetAbbrev, Record, bytes(MacroOffsets));
2655 }
Douglas Gregor92a96f52011-02-08 21:58:10 +00002656}
2657
2658void ASTWriter::WritePreprocessorDetail(PreprocessingRecord &PPRec) {
Argyrios Kyrtzidis7f448362011-09-19 20:40:42 +00002659 if (PPRec.local_begin() == PPRec.local_end())
Douglas Gregor92a96f52011-02-08 21:58:10 +00002660 return;
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002661
Argyrios Kyrtzidis64f63812011-09-19 20:40:25 +00002662 SmallVector<PPEntityOffset, 64> PreprocessedEntityOffsets;
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002663
Douglas Gregor92a96f52011-02-08 21:58:10 +00002664 // Enter the preprocessor block.
2665 Stream.EnterSubblock(PREPROCESSOR_DETAIL_BLOCK_ID, 3);
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00002666
Douglas Gregoraae92242010-03-19 21:51:54 +00002667 // If the preprocessor has a preprocessing record, emit it.
2668 unsigned NumPreprocessingRecords = 0;
Douglas Gregor92a96f52011-02-08 21:58:10 +00002669 using namespace llvm;
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00002670
2671 // Set up the abbreviation for
Douglas Gregor92a96f52011-02-08 21:58:10 +00002672 unsigned InclusionAbbrev = 0;
2673 {
David Blaikieb44f0bf2017-01-04 22:36:43 +00002674 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Douglas Gregor92a96f52011-02-08 21:58:10 +00002675 Abbrev->Add(BitCodeAbbrevOp(PPD_INCLUSION_DIRECTIVE));
Douglas Gregor92a96f52011-02-08 21:58:10 +00002676 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // filename length
2677 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // in quotes
2678 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 2)); // kind
Argyrios Kyrtzidisf590e092012-10-02 16:10:46 +00002679 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // imported module
Douglas Gregor92a96f52011-02-08 21:58:10 +00002680 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
David Blaikieb44f0bf2017-01-04 22:36:43 +00002681 InclusionAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregor92a96f52011-02-08 21:58:10 +00002682 }
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00002683
2684 unsigned FirstPreprocessorEntityID
2685 = (Chain ? PPRec.getNumLoadedPreprocessedEntities() : 0)
Douglas Gregor2f555fc2011-08-04 18:56:47 +00002686 + NUM_PREDEF_PP_ENTITY_IDS;
2687 unsigned NextPreprocessorEntityID = FirstPreprocessorEntityID;
Douglas Gregor92a96f52011-02-08 21:58:10 +00002688 RecordData Record;
Argyrios Kyrtzidis7f448362011-09-19 20:40:42 +00002689 for (PreprocessingRecord::iterator E = PPRec.local_begin(),
2690 EEnd = PPRec.local_end();
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00002691 E != EEnd;
Douglas Gregor0d4b4312011-08-04 17:06:18 +00002692 (void)++E, ++NumPreprocessingRecords, ++NextPreprocessorEntityID) {
Douglas Gregor92a96f52011-02-08 21:58:10 +00002693 Record.clear();
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00002694
Richard Smith66a81862015-05-04 02:25:31 +00002695 PreprocessedEntityOffsets.push_back(
2696 PPEntityOffset((*E)->getSourceRange(), Stream.GetCurrentBitNo()));
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002697
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002698 if (auto *MD = dyn_cast<MacroDefinitionRecord>(*E)) {
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002699 // Record this macro definition's ID.
2700 MacroDefinitions[MD] = NextPreprocessorEntityID;
Richard Smith66a81862015-05-04 02:25:31 +00002701
Douglas Gregor92a96f52011-02-08 21:58:10 +00002702 AddIdentifierRef(MD->getName(), Record);
Douglas Gregor92a96f52011-02-08 21:58:10 +00002703 Stream.EmitRecord(PPD_MACRO_DEFINITION, Record);
2704 continue;
Douglas Gregoraae92242010-03-19 21:51:54 +00002705 }
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00002706
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002707 if (auto *ME = dyn_cast<MacroExpansion>(*E)) {
Argyrios Kyrtzidis80f78b92011-09-08 17:18:41 +00002708 Record.push_back(ME->isBuiltinMacro());
2709 if (ME->isBuiltinMacro())
2710 AddIdentifierRef(ME->getName(), Record);
2711 else
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002712 Record.push_back(MacroDefinitions[ME->getDefinition()]);
Chandler Carruthf92ac9e2011-07-15 07:25:21 +00002713 Stream.EmitRecord(PPD_MACRO_EXPANSION, Record);
Douglas Gregor92a96f52011-02-08 21:58:10 +00002714 continue;
2715 }
2716
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002717 if (auto *ID = dyn_cast<InclusionDirective>(*E)) {
Douglas Gregor92a96f52011-02-08 21:58:10 +00002718 Record.push_back(PPD_INCLUSION_DIRECTIVE);
Douglas Gregor92a96f52011-02-08 21:58:10 +00002719 Record.push_back(ID->getFileName().size());
2720 Record.push_back(ID->wasInQuotes());
2721 Record.push_back(static_cast<unsigned>(ID->getKind()));
Argyrios Kyrtzidisf590e092012-10-02 16:10:46 +00002722 Record.push_back(ID->importedModule());
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00002723 SmallString<64> Buffer;
Douglas Gregor92a96f52011-02-08 21:58:10 +00002724 Buffer += ID->getFileName();
Argyrios Kyrtzidis8dbcfc32012-03-08 01:08:28 +00002725 // Check that the FileEntry is not null because it was not resolved and
2726 // we create a PCH even with compiler errors.
2727 if (ID->getFile())
2728 Buffer += ID->getFile()->getName();
Mehdi Amini5ae4a852015-09-09 20:35:37 +00002729 Stream.EmitRecordWithBlob(InclusionAbbrev, Record, Buffer);
Douglas Gregor92a96f52011-02-08 21:58:10 +00002730 continue;
2731 }
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00002732
Douglas Gregor92a96f52011-02-08 21:58:10 +00002733 llvm_unreachable("Unhandled PreprocessedEntity in ASTWriter");
2734 }
Douglas Gregor8f45df52009-04-16 22:23:12 +00002735 Stream.ExitBlock();
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00002736
Douglas Gregoraae92242010-03-19 21:51:54 +00002737 // Write the offsets table for the preprocessing record.
2738 if (NumPreprocessingRecords > 0) {
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002739 assert(PreprocessedEntityOffsets.size() == NumPreprocessingRecords);
2740
Douglas Gregoraae92242010-03-19 21:51:54 +00002741 // Write the offsets table for identifier IDs.
2742 using namespace llvm;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002743
David Blaikieb44f0bf2017-01-04 22:36:43 +00002744 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002745 Abbrev->Add(BitCodeAbbrevOp(PPD_ENTITIES_OFFSETS));
Douglas Gregor2f555fc2011-08-04 18:56:47 +00002746 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // first pp entity
Douglas Gregoraae92242010-03-19 21:51:54 +00002747 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
David Blaikieb44f0bf2017-01-04 22:36:43 +00002748 unsigned PPEOffsetAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00002749
Mehdi Amini57a41912015-09-10 01:46:39 +00002750 RecordData::value_type Record[] = {PPD_ENTITIES_OFFSETS,
2751 FirstPreprocessorEntityID -
2752 NUM_PREDEF_PP_ENTITY_IDS};
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002753 Stream.EmitRecordWithBlob(PPEOffsetAbbrev, Record,
Reid Kleckner012665e2015-05-21 00:13:09 +00002754 bytes(PreprocessedEntityOffsets));
Douglas Gregoraae92242010-03-19 21:51:54 +00002755 }
Cameron Desrochersb60f1b62018-01-15 19:14:16 +00002756
2757 // Write the skipped region table for the preprocessing record.
2758 ArrayRef<SourceRange> SkippedRanges = PPRec.getSkippedRanges();
2759 if (SkippedRanges.size() > 0) {
2760 std::vector<PPSkippedRange> SerializedSkippedRanges;
2761 SerializedSkippedRanges.reserve(SkippedRanges.size());
2762 for (auto const& Range : SkippedRanges)
2763 SerializedSkippedRanges.emplace_back(Range);
2764
2765 using namespace llvm;
2766 auto Abbrev = std::make_shared<BitCodeAbbrev>();
2767 Abbrev->Add(BitCodeAbbrevOp(PPD_SKIPPED_RANGES));
2768 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
2769 unsigned PPESkippedRangeAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
2770
2771 Record.clear();
2772 Record.push_back(PPD_SKIPPED_RANGES);
2773 Stream.EmitRecordWithBlob(PPESkippedRangeAbbrev, Record,
2774 bytes(SerializedSkippedRanges));
2775 }
Chris Lattnereeffaef2009-04-10 17:15:23 +00002776}
2777
Richard Smith386bb072015-08-18 23:42:23 +00002778unsigned ASTWriter::getLocalOrImportedSubmoduleID(Module *Mod) {
Richard Smith080056b2015-08-18 21:53:42 +00002779 if (!Mod)
2780 return 0;
2781
Douglas Gregora89c5ac2011-12-06 01:10:29 +00002782 llvm::DenseMap<Module *, unsigned>::iterator Known = SubmoduleIDs.find(Mod);
2783 if (Known != SubmoduleIDs.end())
2784 return Known->second;
Richard Smith386bb072015-08-18 23:42:23 +00002785
Richard Smithdc1f0422016-07-20 19:10:16 +00002786 auto *Top = Mod->getTopLevelModule();
2787 if (Top != WritingModule &&
Bruno Cardoso Lopes17da34d2017-02-07 21:54:57 +00002788 (getLangOpts().CompilingPCH ||
2789 !Top->fullModuleNameIs(StringRef(getLangOpts().CurrentModule))))
Richard Smith386bb072015-08-18 23:42:23 +00002790 return 0;
2791
Douglas Gregora89c5ac2011-12-06 01:10:29 +00002792 return SubmoduleIDs[Mod] = NextSubmoduleID++;
2793}
2794
Richard Smith386bb072015-08-18 23:42:23 +00002795unsigned ASTWriter::getSubmoduleID(Module *Mod) {
2796 // FIXME: This can easily happen, if we have a reference to a submodule that
2797 // did not result in us loading a module file for that submodule. For
2798 // instance, a cross-top-level-module 'conflict' declaration will hit this.
2799 unsigned ID = getLocalOrImportedSubmoduleID(Mod);
2800 assert((ID || !Mod) &&
2801 "asked for module ID for non-local, non-imported module");
2802 return ID;
Argyrios Kyrtzidisb146baa2013-03-13 21:13:51 +00002803}
2804
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00002805/// Compute the number of modules within the given tree (including the
Douglas Gregor253eefe2011-12-01 00:59:36 +00002806/// given module).
2807static unsigned getNumberOfModules(Module *Mod) {
2808 unsigned ChildModules = 0;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002809 for (auto Sub = Mod->submodule_begin(), SubEnd = Mod->submodule_end();
Douglas Gregor253eefe2011-12-01 00:59:36 +00002810 Sub != SubEnd; ++Sub)
Douglas Gregoreb90e832012-01-04 23:32:19 +00002811 ChildModules += getNumberOfModules(*Sub);
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00002812
Douglas Gregor253eefe2011-12-01 00:59:36 +00002813 return ChildModules + 1;
2814}
2815
Douglas Gregorde3ef502011-11-30 23:21:26 +00002816void ASTWriter::WriteSubmodules(Module *WritingModule) {
Douglas Gregor69021972011-11-30 17:33:56 +00002817 // Enter the submodule description block.
Richard Smith202210b2014-10-24 20:23:01 +00002818 Stream.EnterSubblock(SUBMODULE_BLOCK_ID, /*bits for abbreviations*/5);
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00002819
Douglas Gregor69021972011-11-30 17:33:56 +00002820 // Write the abbreviations needed for the submodules block.
2821 using namespace llvm;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002822
David Blaikieb44f0bf2017-01-04 22:36:43 +00002823 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Douglas Gregor69021972011-11-30 17:33:56 +00002824 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_DEFINITION));
Douglas Gregora89c5ac2011-12-06 01:10:29 +00002825 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // ID
Douglas Gregor69021972011-11-30 17:33:56 +00002826 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Parent
Richard Smithdd8b5332017-09-04 05:37:53 +00002827 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 2)); // Kind
Douglas Gregor69021972011-11-30 17:33:56 +00002828 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // IsFramework
2829 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // IsExplicit
Richard Smith9bca2982014-03-08 00:03:56 +00002830 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // IsSystem
2831 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // IsExternC
Douglas Gregora686e1b2012-01-27 19:52:33 +00002832 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // InferSubmodules...
Douglas Gregor73441092011-12-05 22:27:44 +00002833 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // InferExplicit...
Douglas Gregor73441092011-12-05 22:27:44 +00002834 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // InferExportWild...
Douglas Gregor35b13ec2013-03-20 00:22:05 +00002835 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // ConfigMacrosExh...
Jordan Rose90b0a1f2018-04-20 17:16:04 +00002836 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // ModuleMapIsPriv...
Douglas Gregor69021972011-11-30 17:33:56 +00002837 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
David Blaikieb44f0bf2017-01-04 22:36:43 +00002838 unsigned DefinitionAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregor69021972011-11-30 17:33:56 +00002839
David Blaikieb44f0bf2017-01-04 22:36:43 +00002840 Abbrev = std::make_shared<BitCodeAbbrev>();
Douglas Gregor524e33e2011-12-08 19:11:24 +00002841 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_UMBRELLA_HEADER));
Douglas Gregor69021972011-11-30 17:33:56 +00002842 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
David Blaikieb44f0bf2017-01-04 22:36:43 +00002843 unsigned UmbrellaAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregor69021972011-11-30 17:33:56 +00002844
David Blaikieb44f0bf2017-01-04 22:36:43 +00002845 Abbrev = std::make_shared<BitCodeAbbrev>();
Douglas Gregor69021972011-11-30 17:33:56 +00002846 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_HEADER));
2847 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
David Blaikieb44f0bf2017-01-04 22:36:43 +00002848 unsigned HeaderAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregor524e33e2011-12-08 19:11:24 +00002849
David Blaikieb44f0bf2017-01-04 22:36:43 +00002850 Abbrev = std::make_shared<BitCodeAbbrev>();
Argyrios Kyrtzidisc597c8c2012-10-05 00:22:33 +00002851 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_TOPHEADER));
2852 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
David Blaikieb44f0bf2017-01-04 22:36:43 +00002853 unsigned TopHeaderAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Argyrios Kyrtzidisc597c8c2012-10-05 00:22:33 +00002854
David Blaikieb44f0bf2017-01-04 22:36:43 +00002855 Abbrev = std::make_shared<BitCodeAbbrev>();
Douglas Gregor524e33e2011-12-08 19:11:24 +00002856 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_UMBRELLA_DIR));
2857 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
David Blaikieb44f0bf2017-01-04 22:36:43 +00002858 unsigned UmbrellaDirAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregor524e33e2011-12-08 19:11:24 +00002859
David Blaikieb44f0bf2017-01-04 22:36:43 +00002860 Abbrev = std::make_shared<BitCodeAbbrev>();
Douglas Gregor1fb5c3a2011-12-31 04:05:44 +00002861 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_REQUIRES));
Richard Smitha3feee22013-10-28 22:18:19 +00002862 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // State
2863 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Feature
David Blaikieb44f0bf2017-01-04 22:36:43 +00002864 unsigned RequiresAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregor1fb5c3a2011-12-31 04:05:44 +00002865
David Blaikieb44f0bf2017-01-04 22:36:43 +00002866 Abbrev = std::make_shared<BitCodeAbbrev>();
Douglas Gregor59527662012-10-15 06:28:11 +00002867 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_EXCLUDED_HEADER));
2868 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
David Blaikieb44f0bf2017-01-04 22:36:43 +00002869 unsigned ExcludedHeaderAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregor59527662012-10-15 06:28:11 +00002870
David Blaikieb44f0bf2017-01-04 22:36:43 +00002871 Abbrev = std::make_shared<BitCodeAbbrev>();
Richard Smith306d8922014-10-22 23:50:56 +00002872 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_TEXTUAL_HEADER));
2873 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
David Blaikieb44f0bf2017-01-04 22:36:43 +00002874 unsigned TextualHeaderAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Richard Smith306d8922014-10-22 23:50:56 +00002875
David Blaikieb44f0bf2017-01-04 22:36:43 +00002876 Abbrev = std::make_shared<BitCodeAbbrev>();
Lawrence Crowlb53e5482013-06-20 21:14:14 +00002877 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_PRIVATE_HEADER));
2878 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
David Blaikieb44f0bf2017-01-04 22:36:43 +00002879 unsigned PrivateHeaderAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Lawrence Crowlb53e5482013-06-20 21:14:14 +00002880
David Blaikieb44f0bf2017-01-04 22:36:43 +00002881 Abbrev = std::make_shared<BitCodeAbbrev>();
Richard Smith202210b2014-10-24 20:23:01 +00002882 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_PRIVATE_TEXTUAL_HEADER));
2883 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
David Blaikieb44f0bf2017-01-04 22:36:43 +00002884 unsigned PrivateTextualHeaderAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Richard Smith202210b2014-10-24 20:23:01 +00002885
David Blaikieb44f0bf2017-01-04 22:36:43 +00002886 Abbrev = std::make_shared<BitCodeAbbrev>();
Douglas Gregor6ddfca92013-01-14 17:21:00 +00002887 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_LINK_LIBRARY));
2888 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // IsFramework
2889 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
David Blaikieb44f0bf2017-01-04 22:36:43 +00002890 unsigned LinkLibraryAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregor6ddfca92013-01-14 17:21:00 +00002891
David Blaikieb44f0bf2017-01-04 22:36:43 +00002892 Abbrev = std::make_shared<BitCodeAbbrev>();
Douglas Gregor35b13ec2013-03-20 00:22:05 +00002893 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_CONFIG_MACRO));
2894 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Macro name
David Blaikieb44f0bf2017-01-04 22:36:43 +00002895 unsigned ConfigMacroAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregor35b13ec2013-03-20 00:22:05 +00002896
David Blaikieb44f0bf2017-01-04 22:36:43 +00002897 Abbrev = std::make_shared<BitCodeAbbrev>();
Douglas Gregorfb912652013-03-20 21:10:35 +00002898 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_CONFLICT));
2899 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Other module
2900 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Message
David Blaikieb44f0bf2017-01-04 22:36:43 +00002901 unsigned ConflictAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregorfb912652013-03-20 21:10:35 +00002902
Douglas Gregorf0b11de2017-09-14 23:38:44 +00002903 Abbrev = std::make_shared<BitCodeAbbrev>();
2904 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_EXPORT_AS));
2905 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Macro name
2906 unsigned ExportAsAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
2907
Douglas Gregor253eefe2011-12-01 00:59:36 +00002908 // Write the submodule metadata block.
Richard Smith145e15a2017-04-24 23:12:30 +00002909 RecordData::value_type Record[] = {
2910 getNumberOfModules(WritingModule),
Richard Smithdd8b5332017-09-04 05:37:53 +00002911 FirstSubmoduleID - NUM_PREDEF_SUBMODULE_IDS};
Douglas Gregor253eefe2011-12-01 00:59:36 +00002912 Stream.EmitRecord(SUBMODULE_METADATA, Record);
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00002913
Douglas Gregor69021972011-11-30 17:33:56 +00002914 // Write all of the submodules.
Douglas Gregorde3ef502011-11-30 23:21:26 +00002915 std::queue<Module *> Q;
Douglas Gregor69021972011-11-30 17:33:56 +00002916 Q.push(WritingModule);
Douglas Gregor69021972011-11-30 17:33:56 +00002917 while (!Q.empty()) {
Douglas Gregorde3ef502011-11-30 23:21:26 +00002918 Module *Mod = Q.front();
Douglas Gregor69021972011-11-30 17:33:56 +00002919 Q.pop();
Douglas Gregora89c5ac2011-12-06 01:10:29 +00002920 unsigned ID = getSubmoduleID(Mod);
Mehdi Amini57a41912015-09-10 01:46:39 +00002921
2922 uint64_t ParentID = 0;
Douglas Gregor69021972011-11-30 17:33:56 +00002923 if (Mod->Parent) {
2924 assert(SubmoduleIDs[Mod->Parent] && "Submodule parent not written?");
Mehdi Amini57a41912015-09-10 01:46:39 +00002925 ParentID = SubmoduleIDs[Mod->Parent];
Douglas Gregor69021972011-11-30 17:33:56 +00002926 }
Mehdi Amini57a41912015-09-10 01:46:39 +00002927
2928 // Emit the definition of the block.
2929 {
David Blaikie9ffe5a32017-01-30 05:00:26 +00002930 RecordData::value_type Record[] = {SUBMODULE_DEFINITION,
2931 ID,
2932 ParentID,
Simon Pilgrimf331a662017-09-04 10:54:39 +00002933 (RecordData::value_type)Mod->Kind,
David Blaikie9ffe5a32017-01-30 05:00:26 +00002934 Mod->IsFramework,
2935 Mod->IsExplicit,
2936 Mod->IsSystem,
2937 Mod->IsExternC,
2938 Mod->InferSubmodules,
2939 Mod->InferExplicitSubmodules,
2940 Mod->InferExportWildcard,
Jordan Rose90b0a1f2018-04-20 17:16:04 +00002941 Mod->ConfigMacrosExhaustive,
2942 Mod->ModuleMapIsPrivate};
Mehdi Amini57a41912015-09-10 01:46:39 +00002943 Stream.EmitRecordWithBlob(DefinitionAbbrev, Record, Mod->Name);
2944 }
2945
Douglas Gregor1fb5c3a2011-12-31 04:05:44 +00002946 // Emit the requirements.
Richard Smith080056b2015-08-18 21:53:42 +00002947 for (const auto &R : Mod->Requirements) {
Mehdi Amini57a41912015-09-10 01:46:39 +00002948 RecordData::value_type Record[] = {SUBMODULE_REQUIRES, R.second};
Richard Smith080056b2015-08-18 21:53:42 +00002949 Stream.EmitRecordWithBlob(RequiresAbbrev, Record, R.first);
Douglas Gregor1fb5c3a2011-12-31 04:05:44 +00002950 }
2951
Douglas Gregor69021972011-11-30 17:33:56 +00002952 // Emit the umbrella header, if there is one.
Richard Smith2b63d152015-05-16 02:28:53 +00002953 if (auto UmbrellaHeader = Mod->getUmbrellaHeader()) {
Mehdi Amini57a41912015-09-10 01:46:39 +00002954 RecordData::value_type Record[] = {SUBMODULE_UMBRELLA_HEADER};
Richard Smith2b63d152015-05-16 02:28:53 +00002955 Stream.EmitRecordWithBlob(UmbrellaAbbrev, Record,
2956 UmbrellaHeader.NameAsWritten);
2957 } else if (auto UmbrellaDir = Mod->getUmbrellaDir()) {
Mehdi Amini57a41912015-09-10 01:46:39 +00002958 RecordData::value_type Record[] = {SUBMODULE_UMBRELLA_DIR};
2959 Stream.EmitRecordWithBlob(UmbrellaDirAbbrev, Record,
Richard Smith2b63d152015-05-16 02:28:53 +00002960 UmbrellaDir.NameAsWritten);
Douglas Gregor69021972011-11-30 17:33:56 +00002961 }
Richard Smith306d8922014-10-22 23:50:56 +00002962
Douglas Gregor69021972011-11-30 17:33:56 +00002963 // Emit the headers.
Richard Smith202210b2014-10-24 20:23:01 +00002964 struct {
Richard Smith3c1a41a2014-12-02 00:08:08 +00002965 unsigned RecordKind;
Richard Smith202210b2014-10-24 20:23:01 +00002966 unsigned Abbrev;
Richard Smith3c1a41a2014-12-02 00:08:08 +00002967 Module::HeaderKind HeaderKind;
Richard Smith202210b2014-10-24 20:23:01 +00002968 } HeaderLists[] = {
Richard Smith3c1a41a2014-12-02 00:08:08 +00002969 {SUBMODULE_HEADER, HeaderAbbrev, Module::HK_Normal},
2970 {SUBMODULE_TEXTUAL_HEADER, TextualHeaderAbbrev, Module::HK_Textual},
2971 {SUBMODULE_PRIVATE_HEADER, PrivateHeaderAbbrev, Module::HK_Private},
Richard Smith202210b2014-10-24 20:23:01 +00002972 {SUBMODULE_PRIVATE_TEXTUAL_HEADER, PrivateTextualHeaderAbbrev,
Richard Smith3c1a41a2014-12-02 00:08:08 +00002973 Module::HK_PrivateTextual},
2974 {SUBMODULE_EXCLUDED_HEADER, ExcludedHeaderAbbrev, Module::HK_Excluded}
Richard Smith202210b2014-10-24 20:23:01 +00002975 };
2976 for (auto &HL : HeaderLists) {
Mehdi Amini57a41912015-09-10 01:46:39 +00002977 RecordData::value_type Record[] = {HL.RecordKind};
Richard Smith3c1a41a2014-12-02 00:08:08 +00002978 for (auto &H : Mod->Headers[HL.HeaderKind])
2979 Stream.EmitRecordWithBlob(HL.Abbrev, Record, H.NameAsWritten);
2980 }
2981
2982 // Emit the top headers.
2983 {
2984 auto TopHeaders = Mod->getTopHeaders(PP->getFileManager());
Mehdi Amini57a41912015-09-10 01:46:39 +00002985 RecordData::value_type Record[] = {SUBMODULE_TOPHEADER};
Richard Smith3c1a41a2014-12-02 00:08:08 +00002986 for (auto *H : TopHeaders)
2987 Stream.EmitRecordWithBlob(TopHeaderAbbrev, Record, H->getName());
Argyrios Kyrtzidisc597c8c2012-10-05 00:22:33 +00002988 }
Douglas Gregor0093b3c2011-12-05 16:33:54 +00002989
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00002990 // Emit the imports.
Douglas Gregor0093b3c2011-12-05 16:33:54 +00002991 if (!Mod->Imports.empty()) {
Mehdi Amini57a41912015-09-10 01:46:39 +00002992 RecordData Record;
Richard Smith080056b2015-08-18 21:53:42 +00002993 for (auto *I : Mod->Imports)
2994 Record.push_back(getSubmoduleID(I));
Douglas Gregor0093b3c2011-12-05 16:33:54 +00002995 Stream.EmitRecord(SUBMODULE_IMPORTS, Record);
2996 }
2997
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00002998 // Emit the exports.
Douglas Gregor24bb9232011-12-02 18:58:38 +00002999 if (!Mod->Exports.empty()) {
Mehdi Amini57a41912015-09-10 01:46:39 +00003000 RecordData Record;
Richard Smith080056b2015-08-18 21:53:42 +00003001 for (const auto &E : Mod->Exports) {
3002 // FIXME: This may fail; we don't require that all exported modules
3003 // are local or imported.
3004 Record.push_back(getSubmoduleID(E.getPointer()));
3005 Record.push_back(E.getInt());
Douglas Gregor24bb9232011-12-02 18:58:38 +00003006 }
3007 Stream.EmitRecord(SUBMODULE_EXPORTS, Record);
3008 }
Douglas Gregor6ddfca92013-01-14 17:21:00 +00003009
Daniel Jasperba7f2f72013-09-24 09:14:14 +00003010 //FIXME: How do we emit the 'use'd modules? They may not be submodules.
3011 // Might be unnecessary as use declarations are only used to build the
3012 // module itself.
3013
Douglas Gregor6ddfca92013-01-14 17:21:00 +00003014 // Emit the link libraries.
Richard Smith080056b2015-08-18 21:53:42 +00003015 for (const auto &LL : Mod->LinkLibraries) {
Mehdi Amini57a41912015-09-10 01:46:39 +00003016 RecordData::value_type Record[] = {SUBMODULE_LINK_LIBRARY,
3017 LL.IsFramework};
Richard Smith080056b2015-08-18 21:53:42 +00003018 Stream.EmitRecordWithBlob(LinkLibraryAbbrev, Record, LL.Library);
Douglas Gregor6ddfca92013-01-14 17:21:00 +00003019 }
3020
Douglas Gregorfb912652013-03-20 21:10:35 +00003021 // Emit the conflicts.
Richard Smith080056b2015-08-18 21:53:42 +00003022 for (const auto &C : Mod->Conflicts) {
Richard Smith080056b2015-08-18 21:53:42 +00003023 // FIXME: This may fail; we don't require that all conflicting modules
3024 // are local or imported.
Mehdi Amini57a41912015-09-10 01:46:39 +00003025 RecordData::value_type Record[] = {SUBMODULE_CONFLICT,
3026 getSubmoduleID(C.Other)};
Richard Smith080056b2015-08-18 21:53:42 +00003027 Stream.EmitRecordWithBlob(ConflictAbbrev, Record, C.Message);
Douglas Gregorfb912652013-03-20 21:10:35 +00003028 }
3029
Douglas Gregor35b13ec2013-03-20 00:22:05 +00003030 // Emit the configuration macros.
Richard Smith080056b2015-08-18 21:53:42 +00003031 for (const auto &CM : Mod->ConfigMacros) {
Mehdi Amini57a41912015-09-10 01:46:39 +00003032 RecordData::value_type Record[] = {SUBMODULE_CONFIG_MACRO};
Richard Smith080056b2015-08-18 21:53:42 +00003033 Stream.EmitRecordWithBlob(ConfigMacroAbbrev, Record, CM);
Douglas Gregor35b13ec2013-03-20 00:22:05 +00003034 }
3035
Richard Smithdc1f0422016-07-20 19:10:16 +00003036 // Emit the initializers, if any.
3037 RecordData Inits;
3038 for (Decl *D : Context->getModuleInitializers(Mod))
3039 Inits.push_back(GetDeclRef(D));
3040 if (!Inits.empty())
3041 Stream.EmitRecord(SUBMODULE_INITIALIZERS, Inits);
3042
Douglas Gregorf0b11de2017-09-14 23:38:44 +00003043 // Emit the name of the re-exported module, if any.
3044 if (!Mod->ExportAsModule.empty()) {
3045 RecordData::value_type Record[] = {SUBMODULE_EXPORT_AS};
3046 Stream.EmitRecordWithBlob(ExportAsAbbrev, Record, Mod->ExportAsModule);
3047 }
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00003048
Douglas Gregor69021972011-11-30 17:33:56 +00003049 // Queue up the submodules of this module.
Richard Smith080056b2015-08-18 21:53:42 +00003050 for (auto *M : Mod->submodules())
3051 Q.push(M);
Douglas Gregor69021972011-11-30 17:33:56 +00003052 }
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00003053
Douglas Gregor69021972011-11-30 17:33:56 +00003054 Stream.ExitBlock();
Richard Smith23d8d032015-05-14 00:45:20 +00003055
Richard Smith23d8d032015-05-14 00:45:20 +00003056 assert((NextSubmoduleID - FirstSubmoduleID ==
3057 getNumberOfModules(WritingModule)) &&
3058 "Wrong # of submodules; found a reference to a non-local, "
3059 "non-imported submodule?");
Douglas Gregor69021972011-11-30 17:33:56 +00003060}
3061
Argyrios Kyrtzidis0f06b982013-03-27 17:17:23 +00003062void ASTWriter::WritePragmaDiagnosticMappings(const DiagnosticsEngine &Diag,
3063 bool isModule) {
Argyrios Kyrtzidisefaa54a2012-10-30 00:27:21 +00003064 llvm::SmallDenseMap<const DiagnosticsEngine::DiagState *, unsigned, 64>
3065 DiagStateIDMap;
3066 unsigned CurrID = 0;
Argyrios Kyrtzidis452707c2010-11-05 22:10:18 +00003067 RecordData Record;
Argyrios Kyrtzidis243aedb2011-01-14 20:54:07 +00003068
Richard Smithe37391c2017-05-03 00:28:49 +00003069 auto EncodeDiagStateFlags =
3070 [](const DiagnosticsEngine::DiagState *DS) -> unsigned {
3071 unsigned Result = (unsigned)DS->ExtBehavior;
3072 for (unsigned Val :
Daniel Jasperba9aefc2017-05-03 07:48:27 +00003073 {(unsigned)DS->IgnoreAllWarnings, (unsigned)DS->EnableAllWarnings,
3074 (unsigned)DS->WarningsAsErrors, (unsigned)DS->ErrorsAsFatal,
3075 (unsigned)DS->SuppressSystemWarnings})
Richard Smithe37391c2017-05-03 00:28:49 +00003076 Result = (Result << 1) | Val;
3077 return Result;
3078 };
3079
3080 unsigned Flags = EncodeDiagStateFlags(Diag.DiagStatesByLoc.FirstDiagState);
3081 Record.push_back(Flags);
3082
Richard Smithd230de22017-01-26 01:01:01 +00003083 auto AddDiagState = [&](const DiagnosticsEngine::DiagState *State,
3084 bool IncludeNonPragmaStates) {
Richard Smithe37391c2017-05-03 00:28:49 +00003085 // Ensure that the diagnostic state wasn't modified since it was created.
3086 // We will not correctly round-trip this information otherwise.
3087 assert(Flags == EncodeDiagStateFlags(State) &&
3088 "diag state flags vary in single AST file");
3089
Richard Smithd230de22017-01-26 01:01:01 +00003090 unsigned &DiagStateID = DiagStateIDMap[State];
Argyrios Kyrtzidisefaa54a2012-10-30 00:27:21 +00003091 Record.push_back(DiagStateID);
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00003092
Argyrios Kyrtzidisefaa54a2012-10-30 00:27:21 +00003093 if (DiagStateID == 0) {
3094 DiagStateID = ++CurrID;
Duncan P. N. Exon Smith3cb183b2017-03-14 19:31:27 +00003095
3096 // Add a placeholder for the number of mappings.
3097 auto SizeIdx = Record.size();
3098 Record.emplace_back();
Richard Smithd230de22017-01-26 01:01:01 +00003099 for (const auto &I : *State) {
3100 if (I.second.isPragma() || IncludeNonPragmaStates) {
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00003101 Record.push_back(I.first);
Richard Smithe37391c2017-05-03 00:28:49 +00003102 Record.push_back(I.second.serialize());
Argyrios Kyrtzidisefaa54a2012-10-30 00:27:21 +00003103 }
Argyrios Kyrtzidis243aedb2011-01-14 20:54:07 +00003104 }
Duncan P. N. Exon Smith3cb183b2017-03-14 19:31:27 +00003105 // Update the placeholder.
3106 Record[SizeIdx] = (Record.size() - SizeIdx) / 2;
Richard Smithd230de22017-01-26 01:01:01 +00003107 }
3108 };
3109
3110 AddDiagState(Diag.DiagStatesByLoc.FirstDiagState, isModule);
Richard Smithd230de22017-01-26 01:01:01 +00003111
Duncan P. N. Exon Smitha351c102017-04-12 03:45:32 +00003112 // Reserve a spot for the number of locations with state transitions.
3113 auto NumLocationsIdx = Record.size();
3114 Record.emplace_back();
3115
3116 // Emit the state transitions.
3117 unsigned NumLocations = 0;
Richard Smithd230de22017-01-26 01:01:01 +00003118 for (auto &FileIDAndFile : Diag.DiagStatesByLoc.Files) {
3119 if (!FileIDAndFile.first.isValid() ||
3120 !FileIDAndFile.second.HasLocalTransitions)
3121 continue;
Duncan P. N. Exon Smitha351c102017-04-12 03:45:32 +00003122 ++NumLocations;
Richard Smith6c2b5a82018-02-09 01:15:13 +00003123
3124 SourceLocation Loc = Diag.SourceMgr->getComposedLoc(FileIDAndFile.first, 0);
3125 assert(!Loc.isInvalid() && "start loc for valid FileID is invalid");
3126 AddSourceLocation(Loc, Record);
3127
Richard Smithd230de22017-01-26 01:01:01 +00003128 Record.push_back(FileIDAndFile.second.StateTransitions.size());
3129 for (auto &StatePoint : FileIDAndFile.second.StateTransitions) {
3130 Record.push_back(StatePoint.Offset);
3131 AddDiagState(StatePoint.State, false);
Argyrios Kyrtzidis452707c2010-11-05 22:10:18 +00003132 }
3133 }
3134
Duncan P. N. Exon Smitha351c102017-04-12 03:45:32 +00003135 // Backpatch the number of locations.
3136 Record[NumLocationsIdx] = NumLocations;
3137
3138 // Emit CurDiagStateLoc. Do it last in order to match source order.
Duncan P. N. Exon Smith900f8172017-04-12 03:58:58 +00003139 //
3140 // This also protects against a hypothetical corner case with simulating
3141 // -Werror settings for implicit modules in the ASTReader, where reading
3142 // CurDiagState out of context could change whether warning pragmas are
3143 // treated as errors.
Duncan P. N. Exon Smitha351c102017-04-12 03:45:32 +00003144 AddSourceLocation(Diag.DiagStatesByLoc.CurDiagStateLoc, Record);
3145 AddDiagState(Diag.DiagStatesByLoc.CurDiagState, false);
3146
Duncan P. N. Exon Smithf2435b92017-04-12 02:31:17 +00003147 Stream.EmitRecord(DIAG_PRAGMA_MAPPINGS, Record);
Argyrios Kyrtzidis452707c2010-11-05 22:10:18 +00003148}
3149
Douglas Gregorc5046832009-04-27 18:38:38 +00003150//===----------------------------------------------------------------------===//
3151// Type Serialization
3152//===----------------------------------------------------------------------===//
Chris Lattnereeffaef2009-04-10 17:15:23 +00003153
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003154/// Write the representation of a type to the AST stream.
Sebastian Redl55c0ad52010-08-18 23:56:21 +00003155void ASTWriter::WriteType(QualType T) {
Richard Smith290d8012016-04-06 17:06:00 +00003156 TypeIdx &IdxRef = TypeIdxs[T];
3157 if (IdxRef.getIndex() == 0) // we haven't seen this type before.
3158 IdxRef = TypeIdx(NextTypeID++);
3159 TypeIdx Idx = IdxRef;
Mike Stump11289f42009-09-09 15:08:12 +00003160
Douglas Gregor9b3932c2010-10-05 18:37:06 +00003161 assert(Idx.getIndex() >= FirstTypeID && "Re-writing a type from a prior AST");
Douglas Gregordc72caa2010-10-04 18:21:45 +00003162
Douglas Gregoref84c4b2009-04-09 22:27:44 +00003163 RecordData Record;
Mike Stump11289f42009-09-09 15:08:12 +00003164
Douglas Gregoref84c4b2009-04-09 22:27:44 +00003165 // Emit the type's representation.
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00003166 ASTTypeWriter W(*this, Record);
Richard Smith290d8012016-04-06 17:06:00 +00003167 W.Visit(T);
3168 uint64_t Offset = W.Emit();
John McCall8ccfcb52009-09-24 19:53:00 +00003169
Richard Smith290d8012016-04-06 17:06:00 +00003170 // Record the offset for this type.
3171 unsigned Index = Idx.getIndex() - FirstTypeID;
3172 if (TypeOffsets.size() == Index)
3173 TypeOffsets.push_back(Offset);
3174 else if (TypeOffsets.size() < Index) {
3175 TypeOffsets.resize(Index + 1);
3176 TypeOffsets[Index] = Offset;
John McCall8ccfcb52009-09-24 19:53:00 +00003177 } else {
Richard Smith290d8012016-04-06 17:06:00 +00003178 llvm_unreachable("Types emitted in wrong order");
Douglas Gregoref84c4b2009-04-09 22:27:44 +00003179 }
Douglas Gregoref84c4b2009-04-09 22:27:44 +00003180}
3181
Douglas Gregorc5046832009-04-27 18:38:38 +00003182//===----------------------------------------------------------------------===//
3183// Declaration Serialization
3184//===----------------------------------------------------------------------===//
3185
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003186/// Write the block containing all of the declaration IDs
Douglas Gregoref84c4b2009-04-09 22:27:44 +00003187/// lexically declared within the given DeclContext.
3188///
3189/// \returns the offset of the DECL_CONTEXT_LEXICAL block within the
Alexander Kornienko2a8c18d2018-04-06 15:14:32 +00003190/// bitstream, or 0 if no block was written.
Sebastian Redl55c0ad52010-08-18 23:56:21 +00003191uint64_t ASTWriter::WriteDeclContextLexicalBlock(ASTContext &Context,
Douglas Gregoref84c4b2009-04-09 22:27:44 +00003192 DeclContext *DC) {
Argyrios Kyrtzidiscfbfe782009-06-30 02:36:12 +00003193 if (DC->decls_empty())
Douglas Gregoref84c4b2009-04-09 22:27:44 +00003194 return 0;
3195
Douglas Gregor8f45df52009-04-16 22:23:12 +00003196 uint64_t Offset = Stream.GetCurrentBitNo();
Richard Smith82f8fcd2015-08-06 22:07:25 +00003197 SmallVector<uint32_t, 128> KindDeclPairs;
3198 for (const auto *D : DC->decls()) {
3199 KindDeclPairs.push_back(D->getKind());
3200 KindDeclPairs.push_back(GetDeclRef(D));
3201 }
Douglas Gregoref84c4b2009-04-09 22:27:44 +00003202
Douglas Gregora57c3ab2009-04-22 22:34:57 +00003203 ++NumLexicalDeclContexts;
Mehdi Amini57a41912015-09-10 01:46:39 +00003204 RecordData::value_type Record[] = {DECL_CONTEXT_LEXICAL};
Richard Smith82f8fcd2015-08-06 22:07:25 +00003205 Stream.EmitRecordWithBlob(DeclContextLexicalAbbrev, Record,
3206 bytes(KindDeclPairs));
Douglas Gregoref84c4b2009-04-09 22:27:44 +00003207 return Offset;
3208}
3209
Sebastian Redl55c0ad52010-08-18 23:56:21 +00003210void ASTWriter::WriteTypeDeclOffsets() {
Sebastian Redl1ea025b2010-07-16 16:36:56 +00003211 using namespace llvm;
Sebastian Redl1ea025b2010-07-16 16:36:56 +00003212
3213 // Write the type offsets array
David Blaikieb44f0bf2017-01-04 22:36:43 +00003214 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Sebastian Redl539c5062010-08-18 23:57:32 +00003215 Abbrev->Add(BitCodeAbbrevOp(TYPE_OFFSET));
Sebastian Redl1ea025b2010-07-16 16:36:56 +00003216 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // # of types
Douglas Gregor5204bde2011-08-02 16:26:37 +00003217 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // base type index
Sebastian Redl1ea025b2010-07-16 16:36:56 +00003218 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // types block
David Blaikieb44f0bf2017-01-04 22:36:43 +00003219 unsigned TypeOffsetAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Mehdi Amini57a41912015-09-10 01:46:39 +00003220 {
3221 RecordData::value_type Record[] = {TYPE_OFFSET, TypeOffsets.size(),
3222 FirstTypeID - NUM_PREDEF_TYPE_IDS};
3223 Stream.EmitRecordWithBlob(TypeOffsetAbbrev, Record, bytes(TypeOffsets));
3224 }
Sebastian Redl1ea025b2010-07-16 16:36:56 +00003225
3226 // Write the declaration offsets array
David Blaikieb44f0bf2017-01-04 22:36:43 +00003227 Abbrev = std::make_shared<BitCodeAbbrev>();
Sebastian Redl539c5062010-08-18 23:57:32 +00003228 Abbrev->Add(BitCodeAbbrevOp(DECL_OFFSET));
Sebastian Redl1ea025b2010-07-16 16:36:56 +00003229 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // # of declarations
Douglas Gregorf7180622011-08-03 15:48:04 +00003230 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // base decl ID
Sebastian Redl1ea025b2010-07-16 16:36:56 +00003231 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // declarations block
David Blaikieb44f0bf2017-01-04 22:36:43 +00003232 unsigned DeclOffsetAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Mehdi Amini57a41912015-09-10 01:46:39 +00003233 {
3234 RecordData::value_type Record[] = {DECL_OFFSET, DeclOffsets.size(),
3235 FirstDeclID - NUM_PREDEF_DECL_IDS};
3236 Stream.EmitRecordWithBlob(DeclOffsetAbbrev, Record, bytes(DeclOffsets));
3237 }
Sebastian Redl1ea025b2010-07-16 16:36:56 +00003238}
3239
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00003240void ASTWriter::WriteFileDeclIDsMap() {
3241 using namespace llvm;
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00003242
Chandler Carruthb306d732015-03-27 00:31:20 +00003243 SmallVector<std::pair<FileID, DeclIDInFileInfo *>, 64> SortedFileDeclIDs(
3244 FileDeclIDs.begin(), FileDeclIDs.end());
Fangrui Song55fab262018-09-26 22:16:28 +00003245 llvm::sort(SortedFileDeclIDs, llvm::less_first());
Chandler Carruthb306d732015-03-27 00:31:20 +00003246
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00003247 // Join the vectors of DeclIDs from all files.
Chandler Carruthb306d732015-03-27 00:31:20 +00003248 SmallVector<DeclID, 256> FileGroupedDeclIDs;
3249 for (auto &FileDeclEntry : SortedFileDeclIDs) {
3250 DeclIDInFileInfo &Info = *FileDeclEntry.second;
3251 Info.FirstDeclIndex = FileGroupedDeclIDs.size();
3252 for (auto &LocDeclEntry : Info.DeclIDs)
3253 FileGroupedDeclIDs.push_back(LocDeclEntry.second);
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00003254 }
3255
David Blaikieb44f0bf2017-01-04 22:36:43 +00003256 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00003257 Abbrev->Add(BitCodeAbbrevOp(FILE_SORTED_DECLS));
Argyrios Kyrtzidis10e78462012-10-02 21:09:13 +00003258 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00003259 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
David Blaikieb44f0bf2017-01-04 22:36:43 +00003260 unsigned AbbrevCode = Stream.EmitAbbrev(std::move(Abbrev));
Mehdi Amini57a41912015-09-10 01:46:39 +00003261 RecordData::value_type Record[] = {FILE_SORTED_DECLS,
3262 FileGroupedDeclIDs.size()};
Reid Kleckner012665e2015-05-21 00:13:09 +00003263 Stream.EmitRecordWithBlob(AbbrevCode, Record, bytes(FileGroupedDeclIDs));
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00003264}
3265
Dmitri Gribenkoaab83832012-06-20 00:34:58 +00003266void ASTWriter::WriteComments() {
3267 Stream.EnterSubblock(COMMENTS_BLOCK_ID, 3);
Ilya Biryukov45643102018-07-09 11:33:23 +00003268 auto _ = llvm::make_scope_exit([this] { Stream.ExitBlock(); });
3269 if (!PP->getPreprocessorOpts().WriteCommentListToPCH)
3270 return;
Dmitri Gribenkoaab83832012-06-20 00:34:58 +00003271 RecordData Record;
Jan Korousf31d8df2019-08-13 18:11:44 +00003272 for (const auto &FO : Context->Comments.OrderedComments) {
3273 for (const auto &OC : FO.second) {
3274 const RawComment *I = OC.second;
3275 Record.clear();
3276 AddSourceRange(I->getSourceRange(), Record);
3277 Record.push_back(I->getKind());
3278 Record.push_back(I->isTrailingComment());
3279 Record.push_back(I->isAlmostTrailingComment());
3280 Stream.EmitRecord(COMMENTS_RAW_COMMENT, Record);
3281 }
Dmitri Gribenkoaab83832012-06-20 00:34:58 +00003282 }
Dmitri Gribenkoaab83832012-06-20 00:34:58 +00003283}
3284
Douglas Gregorc5046832009-04-27 18:38:38 +00003285//===----------------------------------------------------------------------===//
3286// Global Method Pool and Selector Serialization
3287//===----------------------------------------------------------------------===//
3288
Douglas Gregore84a9da2009-04-20 20:36:09 +00003289namespace {
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +00003290
Douglas Gregorc78d3462009-04-24 21:10:55 +00003291// Trait used for the on-disk hash table used in the method pool.
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00003292class ASTMethodPoolTrait {
Sebastian Redl55c0ad52010-08-18 23:56:21 +00003293 ASTWriter &Writer;
Douglas Gregorc78d3462009-04-24 21:10:55 +00003294
3295public:
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003296 using key_type = Selector;
3297 using key_type_ref = key_type;
Mike Stump11289f42009-09-09 15:08:12 +00003298
Sebastian Redl834bb972010-08-04 17:20:04 +00003299 struct data_type {
Sebastian Redl539c5062010-08-18 23:57:32 +00003300 SelectorID ID;
Sebastian Redl834bb972010-08-04 17:20:04 +00003301 ObjCMethodList Instance, Factory;
3302 };
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003303 using data_type_ref = const data_type &;
Douglas Gregorc78d3462009-04-24 21:10:55 +00003304
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003305 using hash_value_type = unsigned;
3306 using offset_type = unsigned;
Justin Bogner25463f12014-04-18 20:27:24 +00003307
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003308 explicit ASTMethodPoolTrait(ASTWriter &Writer) : Writer(Writer) {}
Mike Stump11289f42009-09-09 15:08:12 +00003309
Justin Bogner25463f12014-04-18 20:27:24 +00003310 static hash_value_type ComputeHash(Selector Sel) {
Argyrios Kyrtzidis4bd97102010-08-20 16:03:52 +00003311 return serialization::ComputeHash(Sel);
Douglas Gregorc78d3462009-04-24 21:10:55 +00003312 }
Mike Stump11289f42009-09-09 15:08:12 +00003313
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003314 std::pair<unsigned, unsigned>
Chris Lattner0e62c1c2011-07-23 10:55:15 +00003315 EmitKeyDataLength(raw_ostream& Out, Selector Sel,
Douglas Gregorc78d3462009-04-24 21:10:55 +00003316 data_type_ref Methods) {
Justin Bognere1c147c2014-03-28 22:03:19 +00003317 using namespace llvm::support;
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003318
Peter Collingbournee3f65292018-05-18 19:46:24 +00003319 endian::Writer LE(Out, little);
Douglas Gregorc78d3462009-04-24 21:10:55 +00003320 unsigned KeyLen = 2 + (Sel.getNumArgs()? Sel.getNumArgs() * 4 : 4);
Justin Bognere1c147c2014-03-28 22:03:19 +00003321 LE.write<uint16_t>(KeyLen);
Sebastian Redl834bb972010-08-04 17:20:04 +00003322 unsigned DataLen = 4 + 2 + 2; // 2 bytes for each of the method counts
3323 for (const ObjCMethodList *Method = &Methods.Instance; Method;
Argyrios Kyrtzidisd3da6e02013-04-17 00:08:58 +00003324 Method = Method->getNext())
Nico Weber2e0c8f72014-12-27 03:58:08 +00003325 if (Method->getMethod())
Douglas Gregorc78d3462009-04-24 21:10:55 +00003326 DataLen += 4;
Sebastian Redl834bb972010-08-04 17:20:04 +00003327 for (const ObjCMethodList *Method = &Methods.Factory; Method;
Argyrios Kyrtzidisd3da6e02013-04-17 00:08:58 +00003328 Method = Method->getNext())
Nico Weber2e0c8f72014-12-27 03:58:08 +00003329 if (Method->getMethod())
Douglas Gregorc78d3462009-04-24 21:10:55 +00003330 DataLen += 4;
Justin Bognere1c147c2014-03-28 22:03:19 +00003331 LE.write<uint16_t>(DataLen);
Douglas Gregorc78d3462009-04-24 21:10:55 +00003332 return std::make_pair(KeyLen, DataLen);
3333 }
Mike Stump11289f42009-09-09 15:08:12 +00003334
Chris Lattner0e62c1c2011-07-23 10:55:15 +00003335 void EmitKey(raw_ostream& Out, Selector Sel, unsigned) {
Justin Bognere1c147c2014-03-28 22:03:19 +00003336 using namespace llvm::support;
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003337
Peter Collingbournee3f65292018-05-18 19:46:24 +00003338 endian::Writer LE(Out, little);
Mike Stump11289f42009-09-09 15:08:12 +00003339 uint64_t Start = Out.tell();
Douglas Gregor95c13f52009-04-25 17:48:32 +00003340 assert((Start >> 32) == 0 && "Selector key offset too large");
3341 Writer.SetSelectorOffset(Sel, Start);
Douglas Gregorc78d3462009-04-24 21:10:55 +00003342 unsigned N = Sel.getNumArgs();
Justin Bognere1c147c2014-03-28 22:03:19 +00003343 LE.write<uint16_t>(N);
Douglas Gregorc78d3462009-04-24 21:10:55 +00003344 if (N == 0)
3345 N = 1;
3346 for (unsigned I = 0; I != N; ++I)
Justin Bognere1c147c2014-03-28 22:03:19 +00003347 LE.write<uint32_t>(
3348 Writer.getIdentifierRef(Sel.getIdentifierInfoForSlot(I)));
Douglas Gregorc78d3462009-04-24 21:10:55 +00003349 }
Mike Stump11289f42009-09-09 15:08:12 +00003350
Chris Lattner0e62c1c2011-07-23 10:55:15 +00003351 void EmitData(raw_ostream& Out, key_type_ref,
Douglas Gregor4647cfa2009-04-24 21:49:02 +00003352 data_type_ref Methods, unsigned DataLen) {
Justin Bognere1c147c2014-03-28 22:03:19 +00003353 using namespace llvm::support;
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003354
Peter Collingbournee3f65292018-05-18 19:46:24 +00003355 endian::Writer LE(Out, little);
Douglas Gregor4647cfa2009-04-24 21:49:02 +00003356 uint64_t Start = Out.tell(); (void)Start;
Justin Bognere1c147c2014-03-28 22:03:19 +00003357 LE.write<uint32_t>(Methods.ID);
Douglas Gregorc78d3462009-04-24 21:10:55 +00003358 unsigned NumInstanceMethods = 0;
Sebastian Redl834bb972010-08-04 17:20:04 +00003359 for (const ObjCMethodList *Method = &Methods.Instance; Method;
Argyrios Kyrtzidisd3da6e02013-04-17 00:08:58 +00003360 Method = Method->getNext())
Nico Weber2e0c8f72014-12-27 03:58:08 +00003361 if (Method->getMethod())
Douglas Gregorc78d3462009-04-24 21:10:55 +00003362 ++NumInstanceMethods;
3363
3364 unsigned NumFactoryMethods = 0;
Sebastian Redl834bb972010-08-04 17:20:04 +00003365 for (const ObjCMethodList *Method = &Methods.Factory; Method;
Argyrios Kyrtzidisd3da6e02013-04-17 00:08:58 +00003366 Method = Method->getNext())
Nico Weber2e0c8f72014-12-27 03:58:08 +00003367 if (Method->getMethod())
Douglas Gregorc78d3462009-04-24 21:10:55 +00003368 ++NumFactoryMethods;
3369
Argyrios Kyrtzidisd3da6e02013-04-17 00:08:58 +00003370 unsigned InstanceBits = Methods.Instance.getBits();
3371 assert(InstanceBits < 4);
Nico Weberff4b35e2014-12-27 22:14:15 +00003372 unsigned InstanceHasMoreThanOneDeclBit =
3373 Methods.Instance.hasMoreThanOneDecl();
3374 unsigned FullInstanceBits = (NumInstanceMethods << 3) |
3375 (InstanceHasMoreThanOneDeclBit << 2) |
3376 InstanceBits;
Argyrios Kyrtzidisd3da6e02013-04-17 00:08:58 +00003377 unsigned FactoryBits = Methods.Factory.getBits();
3378 assert(FactoryBits < 4);
Nico Weberff4b35e2014-12-27 22:14:15 +00003379 unsigned FactoryHasMoreThanOneDeclBit =
3380 Methods.Factory.hasMoreThanOneDecl();
3381 unsigned FullFactoryBits = (NumFactoryMethods << 3) |
3382 (FactoryHasMoreThanOneDeclBit << 2) |
3383 FactoryBits;
3384 LE.write<uint16_t>(FullInstanceBits);
3385 LE.write<uint16_t>(FullFactoryBits);
Sebastian Redl834bb972010-08-04 17:20:04 +00003386 for (const ObjCMethodList *Method = &Methods.Instance; Method;
Argyrios Kyrtzidisd3da6e02013-04-17 00:08:58 +00003387 Method = Method->getNext())
Nico Weber2e0c8f72014-12-27 03:58:08 +00003388 if (Method->getMethod())
3389 LE.write<uint32_t>(Writer.getDeclID(Method->getMethod()));
Sebastian Redl834bb972010-08-04 17:20:04 +00003390 for (const ObjCMethodList *Method = &Methods.Factory; Method;
Argyrios Kyrtzidisd3da6e02013-04-17 00:08:58 +00003391 Method = Method->getNext())
Nico Weber2e0c8f72014-12-27 03:58:08 +00003392 if (Method->getMethod())
3393 LE.write<uint32_t>(Writer.getDeclID(Method->getMethod()));
Douglas Gregor4647cfa2009-04-24 21:49:02 +00003394
3395 assert(Out.tell() - Start == DataLen && "Data length is wrong");
Douglas Gregorc78d3462009-04-24 21:10:55 +00003396 }
3397};
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +00003398
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003399} // namespace
Douglas Gregorc78d3462009-04-24 21:10:55 +00003400
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003401/// Write ObjC data: selectors and the method pool.
Douglas Gregorc78d3462009-04-24 21:10:55 +00003402///
3403/// The method pool contains both instance and factory methods, stored
Sebastian Redla19a67f2010-08-03 21:58:15 +00003404/// in an on-disk hash table indexed by the selector. The hash table also
3405/// contains an empty entry for every other selector known to Sema.
Sebastian Redl55c0ad52010-08-18 23:56:21 +00003406void ASTWriter::WriteSelectors(Sema &SemaRef) {
Douglas Gregorc78d3462009-04-24 21:10:55 +00003407 using namespace llvm;
3408
Sebastian Redla19a67f2010-08-03 21:58:15 +00003409 // Do we have to do anything at all?
Sebastian Redl834bb972010-08-04 17:20:04 +00003410 if (SemaRef.MethodPool.empty() && SelectorIDs.empty())
Sebastian Redla19a67f2010-08-03 21:58:15 +00003411 return;
Sebastian Redld95a56e2010-08-04 18:21:41 +00003412 unsigned NumTableEntries = 0;
Sebastian Redla19a67f2010-08-03 21:58:15 +00003413 // Create and write out the blob that contains selectors and the method pool.
Douglas Gregorc78d3462009-04-24 21:10:55 +00003414 {
Justin Bognerbb094f02014-04-18 19:57:06 +00003415 llvm::OnDiskChainedHashTableGenerator<ASTMethodPoolTrait> Generator;
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003416 ASTMethodPoolTrait Trait(*this);
Mike Stump11289f42009-09-09 15:08:12 +00003417
Sebastian Redla19a67f2010-08-03 21:58:15 +00003418 // Create the on-disk hash table representation. We walk through every
3419 // selector we've seen and look it up in the method pool.
Sebastian Redld95a56e2010-08-04 18:21:41 +00003420 SelectorOffsets.resize(NextSelectorID - FirstSelectorID);
Chandler Carruthacbbeb92015-03-27 00:47:43 +00003421 for (auto &SelectorAndID : SelectorIDs) {
3422 Selector S = SelectorAndID.first;
3423 SelectorID ID = SelectorAndID.second;
Sebastian Redla19a67f2010-08-03 21:58:15 +00003424 Sema::GlobalMethodPool::iterator F = SemaRef.MethodPool.find(S);
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00003425 ASTMethodPoolTrait::data_type Data = {
Chandler Carruthacbbeb92015-03-27 00:47:43 +00003426 ID,
Sebastian Redl834bb972010-08-04 17:20:04 +00003427 ObjCMethodList(),
3428 ObjCMethodList()
3429 };
3430 if (F != SemaRef.MethodPool.end()) {
3431 Data.Instance = F->second.first;
3432 Data.Factory = F->second.second;
3433 }
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00003434 // Only write this selector if it's not in an existing AST or something
Sebastian Redld95a56e2010-08-04 18:21:41 +00003435 // changed.
Chandler Carruthacbbeb92015-03-27 00:47:43 +00003436 if (Chain && ID < FirstSelectorID) {
Sebastian Redld95a56e2010-08-04 18:21:41 +00003437 // Selector already exists. Did it change?
3438 bool changed = false;
Nico Weber2e0c8f72014-12-27 03:58:08 +00003439 for (ObjCMethodList *M = &Data.Instance;
3440 !changed && M && M->getMethod(); M = M->getNext()) {
3441 if (!M->getMethod()->isFromASTFile())
Sebastian Redld95a56e2010-08-04 18:21:41 +00003442 changed = true;
3443 }
Nico Weber2e0c8f72014-12-27 03:58:08 +00003444 for (ObjCMethodList *M = &Data.Factory; !changed && M && M->getMethod();
Argyrios Kyrtzidisd3da6e02013-04-17 00:08:58 +00003445 M = M->getNext()) {
Nico Weber2e0c8f72014-12-27 03:58:08 +00003446 if (!M->getMethod()->isFromASTFile())
Sebastian Redld95a56e2010-08-04 18:21:41 +00003447 changed = true;
3448 }
3449 if (!changed)
3450 continue;
Nico Weber2e0c8f72014-12-27 03:58:08 +00003451 } else if (Data.Instance.getMethod() || Data.Factory.getMethod()) {
Sebastian Redl6e1a2a02010-08-04 21:22:45 +00003452 // A new method pool entry.
3453 ++NumTableEntries;
Sebastian Redld95a56e2010-08-04 18:21:41 +00003454 }
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003455 Generator.insert(S, Data, Trait);
Douglas Gregorc78d3462009-04-24 21:10:55 +00003456 }
3457
Douglas Gregorc78d3462009-04-24 21:10:55 +00003458 // Create the on-disk hash table in a buffer.
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00003459 SmallString<4096> MethodPool;
Douglas Gregorc78d3462009-04-24 21:10:55 +00003460 uint32_t BucketOffset;
3461 {
Justin Bognere1c147c2014-03-28 22:03:19 +00003462 using namespace llvm::support;
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003463
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00003464 ASTMethodPoolTrait Trait(*this);
Douglas Gregorc78d3462009-04-24 21:10:55 +00003465 llvm::raw_svector_ostream Out(MethodPool);
3466 // Make sure that no bucket is at offset 0
Peter Collingbournee3f65292018-05-18 19:46:24 +00003467 endian::write<uint32_t>(Out, 0, little);
Douglas Gregorc78d3462009-04-24 21:10:55 +00003468 BucketOffset = Generator.Emit(Out, Trait);
3469 }
3470
3471 // Create a blob abbreviation
David Blaikieb44f0bf2017-01-04 22:36:43 +00003472 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Sebastian Redl539c5062010-08-18 23:57:32 +00003473 Abbrev->Add(BitCodeAbbrevOp(METHOD_POOL));
Douglas Gregorc78d3462009-04-24 21:10:55 +00003474 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
Douglas Gregor95c13f52009-04-25 17:48:32 +00003475 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
Douglas Gregorc78d3462009-04-24 21:10:55 +00003476 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
David Blaikieb44f0bf2017-01-04 22:36:43 +00003477 unsigned MethodPoolAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregorc78d3462009-04-24 21:10:55 +00003478
Douglas Gregor95c13f52009-04-25 17:48:32 +00003479 // Write the method pool
Mehdi Amini57a41912015-09-10 01:46:39 +00003480 {
3481 RecordData::value_type Record[] = {METHOD_POOL, BucketOffset,
3482 NumTableEntries};
3483 Stream.EmitRecordWithBlob(MethodPoolAbbrev, Record, MethodPool);
3484 }
Douglas Gregor95c13f52009-04-25 17:48:32 +00003485
3486 // Create a blob abbreviation for the selector table offsets.
David Blaikieb44f0bf2017-01-04 22:36:43 +00003487 Abbrev = std::make_shared<BitCodeAbbrev>();
Sebastian Redl539c5062010-08-18 23:57:32 +00003488 Abbrev->Add(BitCodeAbbrevOp(SELECTOR_OFFSETS));
Douglas Gregord4c5ed02010-10-29 22:39:52 +00003489 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // size
Douglas Gregor8f364fb2011-08-03 23:28:44 +00003490 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // first ID
Douglas Gregor95c13f52009-04-25 17:48:32 +00003491 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
David Blaikieb44f0bf2017-01-04 22:36:43 +00003492 unsigned SelectorOffsetAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregor95c13f52009-04-25 17:48:32 +00003493
3494 // Write the selector offsets table.
Mehdi Amini57a41912015-09-10 01:46:39 +00003495 {
3496 RecordData::value_type Record[] = {
3497 SELECTOR_OFFSETS, SelectorOffsets.size(),
3498 FirstSelectorID - NUM_PREDEF_SELECTOR_IDS};
3499 Stream.EmitRecordWithBlob(SelectorOffsetAbbrev, Record,
3500 bytes(SelectorOffsets));
3501 }
Douglas Gregorc78d3462009-04-24 21:10:55 +00003502 }
3503}
3504
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003505/// Write the selectors referenced in @selector expression into AST file.
Sebastian Redl55c0ad52010-08-18 23:56:21 +00003506void ASTWriter::WriteReferencedSelectorsPool(Sema &SemaRef) {
Fariborz Jahanianc51609a2010-07-23 19:11:11 +00003507 using namespace llvm;
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003508
Fariborz Jahanianc51609a2010-07-23 19:11:11 +00003509 if (SemaRef.ReferencedSelectors.empty())
3510 return;
Sebastian Redlada023c2010-08-04 20:40:17 +00003511
Fariborz Jahanianc51609a2010-07-23 19:11:11 +00003512 RecordData Record;
Richard Smithe64e7452016-04-18 21:54:58 +00003513 ASTRecordWriter Writer(*this, Record);
Sebastian Redlada023c2010-08-04 20:40:17 +00003514
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00003515 // Note: this writes out all references even for a dependent AST. But it is
Sebastian Redl51c79d82010-08-04 22:21:29 +00003516 // very tricky to fix, and given that @selector shouldn't really appear in
3517 // headers, probably not worth it. It's not a correctness issue.
Chandler Carruth12c8f652015-03-27 00:55:05 +00003518 for (auto &SelectorAndLocation : SemaRef.ReferencedSelectors) {
3519 Selector Sel = SelectorAndLocation.first;
3520 SourceLocation Loc = SelectorAndLocation.second;
Richard Smithe64e7452016-04-18 21:54:58 +00003521 Writer.AddSelectorRef(Sel);
3522 Writer.AddSourceLocation(Loc);
Fariborz Jahanianc51609a2010-07-23 19:11:11 +00003523 }
Richard Smithe64e7452016-04-18 21:54:58 +00003524 Writer.Emit(REFERENCED_SELECTOR_POOL);
Fariborz Jahanianc51609a2010-07-23 19:11:11 +00003525}
3526
Douglas Gregorc5046832009-04-27 18:38:38 +00003527//===----------------------------------------------------------------------===//
3528// Identifier Table Serialization
3529//===----------------------------------------------------------------------===//
3530
Richard Smithb3761912015-02-05 23:08:52 +00003531/// Determine the declaration that should be put into the name lookup table to
3532/// represent the given declaration in this module. This is usually D itself,
3533/// but if D was imported and merged into a local declaration, we want the most
3534/// recent local declaration instead. The chosen declaration will be the most
3535/// recent declaration in any module that imports this one.
3536static NamedDecl *getDeclForLocalLookup(const LangOptions &LangOpts,
3537 NamedDecl *D) {
3538 if (!LangOpts.Modules || !D->isFromASTFile())
3539 return D;
3540
3541 if (Decl *Redecl = D->getPreviousDecl()) {
3542 // For Redeclarable decls, a prior declaration might be local.
3543 for (; Redecl; Redecl = Redecl->getPreviousDecl()) {
Richard Smithd49941b2016-04-26 23:40:43 +00003544 // If we find a local decl, we're done.
3545 if (!Redecl->isFromASTFile()) {
3546 // Exception: in very rare cases (for injected-class-names), not all
3547 // redeclarations are in the same semantic context. Skip ones in a
3548 // different context. They don't go in this lookup table at all.
3549 if (!Redecl->getDeclContext()->getRedeclContext()->Equals(
3550 D->getDeclContext()->getRedeclContext()))
3551 continue;
Richard Smithb3761912015-02-05 23:08:52 +00003552 return cast<NamedDecl>(Redecl);
Richard Smithd49941b2016-04-26 23:40:43 +00003553 }
3554
Richard Smithfe620d22015-03-05 23:24:12 +00003555 // If we find a decl from a (chained-)PCH stop since we won't find a
Richard Smithb3761912015-02-05 23:08:52 +00003556 // local one.
Richard Smithd49941b2016-04-26 23:40:43 +00003557 if (Redecl->getOwningModuleID() == 0)
Richard Smithb3761912015-02-05 23:08:52 +00003558 break;
3559 }
3560 } else if (Decl *First = D->getCanonicalDecl()) {
3561 // For Mergeable decls, the first decl might be local.
3562 if (!First->isFromASTFile())
3563 return cast<NamedDecl>(First);
3564 }
3565
3566 // All declarations are imported. Our most recent declaration will also be
3567 // the most recent one in anyone who imports us.
3568 return D;
3569}
3570
Douglas Gregorc78d3462009-04-24 21:10:55 +00003571namespace {
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +00003572
Richard Smithcf97cf62015-04-19 01:34:23 +00003573class ASTIdentifierTableTrait {
3574 ASTWriter &Writer;
3575 Preprocessor &PP;
3576 IdentifierResolver &IdResolver;
Richard Smith9c254182015-07-19 21:41:12 +00003577 bool IsModule;
Richard Smitha534a312015-07-21 23:54:07 +00003578 bool NeedDecls;
Richard Smith33e0f7e2015-07-22 02:08:40 +00003579 ASTWriter::RecordData *InterestingIdentifierOffsets;
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00003580
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003581 /// Determines whether this is an "interesting" identifier that needs a
Richard Smithcf97cf62015-04-19 01:34:23 +00003582 /// full IdentifierInfo structure written into the hash table. Notably, this
3583 /// doesn't check whether the name has macros defined; use PublicMacroIterator
3584 /// to check that.
Richard Smith9c254182015-07-19 21:41:12 +00003585 bool isInterestingIdentifier(const IdentifierInfo *II, uint64_t MacroOffset) {
Richard Smithd7329392015-04-21 21:46:32 +00003586 if (MacroOffset ||
3587 II->isPoisoned() ||
Richard Smith9c254182015-07-19 21:41:12 +00003588 (IsModule ? II->hasRevertedBuiltin() : II->getObjCOrBuiltinID()) ||
Richard Smithcf97cf62015-04-19 01:34:23 +00003589 II->hasRevertedTokenIDToIdentifier() ||
Bruno Ricci366ba732018-09-21 12:53:22 +00003590 (NeedDecls && II->getFETokenInfo()))
Richard Smithcf97cf62015-04-19 01:34:23 +00003591 return true;
3592
3593 return false;
3594 }
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00003595
Douglas Gregore84a9da2009-04-20 20:36:09 +00003596public:
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003597 using key_type = IdentifierInfo *;
3598 using key_type_ref = key_type;
Mike Stump11289f42009-09-09 15:08:12 +00003599
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003600 using data_type = IdentID;
3601 using data_type_ref = data_type;
Mike Stump11289f42009-09-09 15:08:12 +00003602
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003603 using hash_value_type = unsigned;
3604 using offset_type = unsigned;
Justin Bogner25463f12014-04-18 20:27:24 +00003605
Richard Smithd7329392015-04-21 21:46:32 +00003606 ASTIdentifierTableTrait(ASTWriter &Writer, Preprocessor &PP,
Richard Smith33e0f7e2015-07-22 02:08:40 +00003607 IdentifierResolver &IdResolver, bool IsModule,
3608 ASTWriter::RecordData *InterestingIdentifierOffsets)
Richard Smitha534a312015-07-21 23:54:07 +00003609 : Writer(Writer), PP(PP), IdResolver(IdResolver), IsModule(IsModule),
Richard Smith33e0f7e2015-07-22 02:08:40 +00003610 NeedDecls(!IsModule || !Writer.getLangOpts().CPlusPlus),
3611 InterestingIdentifierOffsets(InterestingIdentifierOffsets) {}
Douglas Gregore84a9da2009-04-20 20:36:09 +00003612
Richard Smithd79514e2016-02-05 19:03:40 +00003613 bool needDecls() const { return NeedDecls; }
3614
Justin Bogner25463f12014-04-18 20:27:24 +00003615 static hash_value_type ComputeHash(const IdentifierInfo* II) {
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00003616 return llvm::djbHash(II->getName());
Douglas Gregore84a9da2009-04-20 20:36:09 +00003617 }
Mike Stump11289f42009-09-09 15:08:12 +00003618
Richard Smith33e0f7e2015-07-22 02:08:40 +00003619 bool isInterestingIdentifier(const IdentifierInfo *II) {
3620 auto MacroOffset = Writer.getMacroDirectivesOffset(II);
3621 return isInterestingIdentifier(II, MacroOffset);
3622 }
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +00003623
Richard Smith9c254182015-07-19 21:41:12 +00003624 bool isInterestingNonMacroIdentifier(const IdentifierInfo *II) {
3625 return isInterestingIdentifier(II, 0);
3626 }
3627
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003628 std::pair<unsigned, unsigned>
Douglas Gregor935bc7a22011-10-27 09:33:13 +00003629 EmitKeyDataLength(raw_ostream& Out, IdentifierInfo* II, IdentID ID) {
Daniel Dunbar2c422dc92009-10-18 20:26:12 +00003630 unsigned KeyLen = II->getLength() + 1;
Douglas Gregor1d583f22009-04-28 21:18:29 +00003631 unsigned DataLen = 4; // 4 bytes for the persistent ID << 1
Richard Smithd7329392015-04-21 21:46:32 +00003632 auto MacroOffset = Writer.getMacroDirectivesOffset(II);
3633 if (isInterestingIdentifier(II, MacroOffset)) {
Alexander Kornienko1d26c022012-09-25 17:18:14 +00003634 DataLen += 2; // 2 bytes for builtin ID
3635 DataLen += 2; // 2 bytes for flags
Richard Smithd7329392015-04-21 21:46:32 +00003636 if (MacroOffset)
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00003637 DataLen += 4; // MacroDirectives offset.
Alexander Kornienko1d26c022012-09-25 17:18:14 +00003638
Richard Smitha534a312015-07-21 23:54:07 +00003639 if (NeedDecls) {
3640 for (IdentifierResolver::iterator D = IdResolver.begin(II),
3641 DEnd = IdResolver.end();
3642 D != DEnd; ++D)
3643 DataLen += 4;
3644 }
Douglas Gregor1d583f22009-04-28 21:18:29 +00003645 }
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003646
Justin Bognere1c147c2014-03-28 22:03:19 +00003647 using namespace llvm::support;
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003648
Peter Collingbournee3f65292018-05-18 19:46:24 +00003649 endian::Writer LE(Out, little);
Justin Bognere1c147c2014-03-28 22:03:19 +00003650
Richard Smithdf8a8312015-03-13 04:05:01 +00003651 assert((uint16_t)DataLen == DataLen && (uint16_t)KeyLen == KeyLen);
Justin Bognere1c147c2014-03-28 22:03:19 +00003652 LE.write<uint16_t>(DataLen);
Douglas Gregorab4df582009-04-28 20:01:51 +00003653 // We emit the key length after the data length so that every
3654 // string is preceded by a 16-bit length. This matches the PTH
3655 // format for storing identifiers.
Justin Bognere1c147c2014-03-28 22:03:19 +00003656 LE.write<uint16_t>(KeyLen);
Douglas Gregore84a9da2009-04-20 20:36:09 +00003657 return std::make_pair(KeyLen, DataLen);
3658 }
Mike Stump11289f42009-09-09 15:08:12 +00003659
Chris Lattner0e62c1c2011-07-23 10:55:15 +00003660 void EmitKey(raw_ostream& Out, const IdentifierInfo* II,
Douglas Gregore84a9da2009-04-20 20:36:09 +00003661 unsigned KeyLen) {
3662 // Record the location of the key data. This is used when generating
3663 // the mapping from persistent IDs to strings.
3664 Writer.SetIdentifierOffset(II, Out.tell());
Richard Smith33e0f7e2015-07-22 02:08:40 +00003665
3666 // Emit the offset of the key/data length information to the interesting
3667 // identifiers table if necessary.
3668 if (InterestingIdentifierOffsets && isInterestingIdentifier(II))
3669 InterestingIdentifierOffsets->push_back(Out.tell() - 4);
3670
Daniel Dunbar2c422dc92009-10-18 20:26:12 +00003671 Out.write(II->getNameStart(), KeyLen);
Douglas Gregore84a9da2009-04-20 20:36:09 +00003672 }
Mike Stump11289f42009-09-09 15:08:12 +00003673
Douglas Gregor4a69c2e2011-09-01 17:04:32 +00003674 void EmitData(raw_ostream& Out, IdentifierInfo* II,
Sebastian Redl539c5062010-08-18 23:57:32 +00003675 IdentID ID, unsigned) {
Justin Bognere1c147c2014-03-28 22:03:19 +00003676 using namespace llvm::support;
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003677
Peter Collingbournee3f65292018-05-18 19:46:24 +00003678 endian::Writer LE(Out, little);
Richard Smithcf97cf62015-04-19 01:34:23 +00003679
Richard Smithd7329392015-04-21 21:46:32 +00003680 auto MacroOffset = Writer.getMacroDirectivesOffset(II);
3681 if (!isInterestingIdentifier(II, MacroOffset)) {
Justin Bognere1c147c2014-03-28 22:03:19 +00003682 LE.write<uint32_t>(ID << 1);
Douglas Gregor1d583f22009-04-28 21:18:29 +00003683 return;
3684 }
Douglas Gregorb9256522009-04-28 21:32:13 +00003685
Justin Bognere1c147c2014-03-28 22:03:19 +00003686 LE.write<uint32_t>((ID << 1) | 0x01);
Alexander Kornienko1d26c022012-09-25 17:18:14 +00003687 uint32_t Bits = (uint32_t)II->getObjCOrBuiltinID();
3688 assert((Bits & 0xffff) == Bits && "ObjCOrBuiltinID too big for ASTReader.");
Justin Bognere1c147c2014-03-28 22:03:19 +00003689 LE.write<uint16_t>(Bits);
Alexander Kornienko1d26c022012-09-25 17:18:14 +00003690 Bits = 0;
Richard Smithd7329392015-04-21 21:46:32 +00003691 bool HadMacroDefinition = MacroOffset != 0;
Alexander Kornienko1d26c022012-09-25 17:18:14 +00003692 Bits = (Bits << 1) | unsigned(HadMacroDefinition);
Daniel Dunbar91b640a2009-12-18 20:58:47 +00003693 Bits = (Bits << 1) | unsigned(II->isExtensionToken());
3694 Bits = (Bits << 1) | unsigned(II->isPoisoned());
Richard Smith9c254182015-07-19 21:41:12 +00003695 Bits = (Bits << 1) | unsigned(II->hasRevertedBuiltin());
Argyrios Kyrtzidis3084a612010-08-11 22:55:12 +00003696 Bits = (Bits << 1) | unsigned(II->hasRevertedTokenIDToIdentifier());
Daniel Dunbar91b640a2009-12-18 20:58:47 +00003697 Bits = (Bits << 1) | unsigned(II->isCPlusPlusOperatorKeyword());
Justin Bognere1c147c2014-03-28 22:03:19 +00003698 LE.write<uint16_t>(Bits);
Douglas Gregore84a9da2009-04-20 20:36:09 +00003699
Richard Smithd7329392015-04-21 21:46:32 +00003700 if (HadMacroDefinition)
3701 LE.write<uint32_t>(MacroOffset);
Alexander Kornienko1d26c022012-09-25 17:18:14 +00003702
Richard Smitha534a312015-07-21 23:54:07 +00003703 if (NeedDecls) {
3704 // Emit the declaration IDs in reverse order, because the
3705 // IdentifierResolver provides the declarations as they would be
3706 // visible (e.g., the function "stat" would come before the struct
3707 // "stat"), but the ASTReader adds declarations to the end of the list
3708 // (so we need to see the struct "stat" before the function "stat").
3709 // Only emit declarations that aren't from a chained PCH, though.
3710 SmallVector<NamedDecl *, 16> Decls(IdResolver.begin(II),
3711 IdResolver.end());
3712 for (SmallVectorImpl<NamedDecl *>::reverse_iterator D = Decls.rbegin(),
3713 DEnd = Decls.rend();
3714 D != DEnd; ++D)
3715 LE.write<uint32_t>(
3716 Writer.getDeclID(getDeclForLocalLookup(PP.getLangOpts(), *D)));
3717 }
Douglas Gregore84a9da2009-04-20 20:36:09 +00003718 }
3719};
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +00003720
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003721} // namespace
Douglas Gregore84a9da2009-04-20 20:36:09 +00003722
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003723/// Write the identifier table into the AST file.
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00003724///
3725/// The identifier table consists of a blob containing string data
3726/// (the actual identifiers themselves) and a separate "offsets" index
3727/// that maps identifier IDs to locations within the blob.
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00003728void ASTWriter::WriteIdentifierTable(Preprocessor &PP,
Douglas Gregor935bc7a22011-10-27 09:33:13 +00003729 IdentifierResolver &IdResolver,
3730 bool IsModule) {
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00003731 using namespace llvm;
3732
Richard Smith33e0f7e2015-07-22 02:08:40 +00003733 RecordData InterestingIdents;
3734
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00003735 // Create and write out the blob that contains the identifier
3736 // strings.
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00003737 {
Justin Bognerbb094f02014-04-18 19:57:06 +00003738 llvm::OnDiskChainedHashTableGenerator<ASTIdentifierTableTrait> Generator;
Richard Smith33e0f7e2015-07-22 02:08:40 +00003739 ASTIdentifierTableTrait Trait(
3740 *this, PP, IdResolver, IsModule,
3741 (getLangOpts().CPlusPlus && IsModule) ? &InterestingIdents : nullptr);
Mike Stump11289f42009-09-09 15:08:12 +00003742
Douglas Gregore6648fb2009-04-28 20:33:11 +00003743 // Look for any identifiers that were named while processing the
3744 // headers, but are otherwise not needed. We add these to the hash
3745 // table to enable checking of the predefines buffer in the case
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00003746 // where the user adds new macro definitions when building the AST
Douglas Gregore6648fb2009-04-28 20:33:11 +00003747 // file.
Chandler Carruth8440c982015-03-26 23:54:15 +00003748 SmallVector<const IdentifierInfo *, 128> IIs;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00003749 for (const auto &ID : PP.getIdentifierTable())
3750 IIs.push_back(ID.second);
Chandler Carruth8440c982015-03-26 23:54:15 +00003751 // Sort the identifiers lexicographically before getting them references so
3752 // that their order is stable.
Benjamin Kramercd2bae32019-08-22 17:32:16 +00003753 llvm::sort(IIs, llvm::deref<std::less<>>());
Chandler Carruth8440c982015-03-26 23:54:15 +00003754 for (const IdentifierInfo *II : IIs)
Richard Smith9c254182015-07-19 21:41:12 +00003755 if (Trait.isInterestingNonMacroIdentifier(II))
3756 getIdentifierRef(II);
Douglas Gregore6648fb2009-04-28 20:33:11 +00003757
Sebastian Redlff4a2952010-07-23 23:49:55 +00003758 // Create the on-disk hash table representation. We only store offsets
3759 // for identifiers that appear here for the first time.
3760 IdentifierOffsets.resize(NextIdentID - FirstIdentID);
Chandler Carruth885e78c2015-03-24 21:18:10 +00003761 for (auto IdentIDPair : IdentifierIDs) {
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00003762 auto *II = const_cast<IdentifierInfo *>(IdentIDPair.first);
Chandler Carruth885e78c2015-03-24 21:18:10 +00003763 IdentID ID = IdentIDPair.second;
3764 assert(II && "NULL identifier in identifier table");
Vassil Vassilev262f41e2016-03-30 20:16:03 +00003765 // Write out identifiers if either the ID is local or the identifier has
3766 // changed since it was loaded.
3767 if (ID >= FirstIdentID || !Chain || !II->isFromAST()
3768 || II->hasChangedSinceDeserialization() ||
Richard Smithd79514e2016-02-05 19:03:40 +00003769 (Trait.needDecls() &&
3770 II->hasFETokenInfoChangedSinceDeserialization()))
Chandler Carruth885e78c2015-03-24 21:18:10 +00003771 Generator.insert(II, ID, Trait);
Douglas Gregore84a9da2009-04-20 20:36:09 +00003772 }
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00003773
Douglas Gregore84a9da2009-04-20 20:36:09 +00003774 // Create the on-disk hash table in a buffer.
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00003775 SmallString<4096> IdentifierTable;
Douglas Gregora868bbd2009-04-21 22:25:48 +00003776 uint32_t BucketOffset;
Douglas Gregore84a9da2009-04-20 20:36:09 +00003777 {
Justin Bognere1c147c2014-03-28 22:03:19 +00003778 using namespace llvm::support;
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003779
Douglas Gregore84a9da2009-04-20 20:36:09 +00003780 llvm::raw_svector_ostream Out(IdentifierTable);
Douglas Gregorc78d3462009-04-24 21:10:55 +00003781 // Make sure that no bucket is at offset 0
Peter Collingbournee3f65292018-05-18 19:46:24 +00003782 endian::write<uint32_t>(Out, 0, little);
Douglas Gregora868bbd2009-04-21 22:25:48 +00003783 BucketOffset = Generator.Emit(Out, Trait);
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00003784 }
3785
3786 // Create a blob abbreviation
David Blaikieb44f0bf2017-01-04 22:36:43 +00003787 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Sebastian Redl539c5062010-08-18 23:57:32 +00003788 Abbrev->Add(BitCodeAbbrevOp(IDENTIFIER_TABLE));
Douglas Gregora868bbd2009-04-21 22:25:48 +00003789 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
Douglas Gregore84a9da2009-04-20 20:36:09 +00003790 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
David Blaikieb44f0bf2017-01-04 22:36:43 +00003791 unsigned IDTableAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00003792
3793 // Write the identifier table
Mehdi Amini57a41912015-09-10 01:46:39 +00003794 RecordData::value_type Record[] = {IDENTIFIER_TABLE, BucketOffset};
Yaron Keren92e1b622015-03-18 10:17:07 +00003795 Stream.EmitRecordWithBlob(IDTableAbbrev, Record, IdentifierTable);
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00003796 }
3797
3798 // Write the offsets table for identifier IDs.
David Blaikieb44f0bf2017-01-04 22:36:43 +00003799 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Sebastian Redl539c5062010-08-18 23:57:32 +00003800 Abbrev->Add(BitCodeAbbrevOp(IDENTIFIER_OFFSET));
Douglas Gregor0e149972009-04-25 19:10:14 +00003801 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // # of identifiers
Douglas Gregor1ab036c2011-08-03 21:49:18 +00003802 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // first ID
Douglas Gregor0e149972009-04-25 19:10:14 +00003803 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
David Blaikieb44f0bf2017-01-04 22:36:43 +00003804 unsigned IdentifierOffsetAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregor0e149972009-04-25 19:10:14 +00003805
Douglas Gregor8d7edce2013-02-08 21:30:59 +00003806#ifndef NDEBUG
3807 for (unsigned I = 0, N = IdentifierOffsets.size(); I != N; ++I)
3808 assert(IdentifierOffsets[I] && "Missing identifier offset?");
3809#endif
Mehdi Amini57a41912015-09-10 01:46:39 +00003810
3811 RecordData::value_type Record[] = {IDENTIFIER_OFFSET,
3812 IdentifierOffsets.size(),
3813 FirstIdentID - NUM_PREDEF_IDENT_IDS};
Douglas Gregor0e149972009-04-25 19:10:14 +00003814 Stream.EmitRecordWithBlob(IdentifierOffsetAbbrev, Record,
Reid Kleckner012665e2015-05-21 00:13:09 +00003815 bytes(IdentifierOffsets));
Richard Smith33e0f7e2015-07-22 02:08:40 +00003816
3817 // In C++, write the list of interesting identifiers (those that are
3818 // defined as macros, poisoned, or similar unusual things).
3819 if (!InterestingIdents.empty())
3820 Stream.EmitRecord(INTERESTING_IDENTIFIERS, InterestingIdents);
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00003821}
3822
Douglas Gregorc5046832009-04-27 18:38:38 +00003823//===----------------------------------------------------------------------===//
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003824// DeclContext's Name Lookup Table Serialization
3825//===----------------------------------------------------------------------===//
3826
3827namespace {
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +00003828
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003829// Trait used for the on-disk hash table used in the method pool.
3830class ASTDeclContextNameLookupTrait {
3831 ASTWriter &Writer;
Richard Smithd88a7f12015-09-01 20:35:42 +00003832 llvm::SmallVector<DeclID, 64> DeclIDs;
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003833
3834public:
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003835 using key_type = DeclarationNameKey;
3836 using key_type_ref = key_type;
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003837
Richard Smithd88a7f12015-09-01 20:35:42 +00003838 /// A start and end index into DeclIDs, representing a sequence of decls.
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003839 using data_type = std::pair<unsigned, unsigned>;
3840 using data_type_ref = const data_type &;
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003841
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003842 using hash_value_type = unsigned;
3843 using offset_type = unsigned;
Justin Bogner25463f12014-04-18 20:27:24 +00003844
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003845 explicit ASTDeclContextNameLookupTrait(ASTWriter &Writer) : Writer(Writer) {}
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003846
Richard Smithd88a7f12015-09-01 20:35:42 +00003847 template<typename Coll>
3848 data_type getData(const Coll &Decls) {
3849 unsigned Start = DeclIDs.size();
3850 for (NamedDecl *D : Decls) {
3851 DeclIDs.push_back(
3852 Writer.GetDeclRef(getDeclForLocalLookup(Writer.getLangOpts(), D)));
3853 }
3854 return std::make_pair(Start, DeclIDs.size());
3855 }
3856
3857 data_type ImportData(const reader::ASTDeclContextNameLookupTrait::data_type &FromReader) {
3858 unsigned Start = DeclIDs.size();
3859 for (auto ID : FromReader)
3860 DeclIDs.push_back(ID);
3861 return std::make_pair(Start, DeclIDs.size());
3862 }
3863
3864 static bool EqualKey(key_type_ref a, key_type_ref b) {
3865 return a == b;
3866 }
3867
Richard Smitha06c7e62015-08-26 23:55:49 +00003868 hash_value_type ComputeHash(DeclarationNameKey Name) {
3869 return Name.getHash();
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003870 }
3871
Richard Smithd88a7f12015-09-01 20:35:42 +00003872 void EmitFileRef(raw_ostream &Out, ModuleFile *F) const {
3873 assert(Writer.hasChain() &&
3874 "have reference to loaded module file but no chain?");
3875
3876 using namespace llvm::support;
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003877
Peter Collingbournee3f65292018-05-18 19:46:24 +00003878 endian::write<uint32_t>(Out, Writer.getChain()->getModuleFileID(F), little);
Richard Smithd88a7f12015-09-01 20:35:42 +00003879 }
3880
Richard Smitha06c7e62015-08-26 23:55:49 +00003881 std::pair<unsigned, unsigned> EmitKeyDataLength(raw_ostream &Out,
3882 DeclarationNameKey Name,
3883 data_type_ref Lookup) {
Justin Bognere1c147c2014-03-28 22:03:19 +00003884 using namespace llvm::support;
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003885
Peter Collingbournee3f65292018-05-18 19:46:24 +00003886 endian::Writer LE(Out, little);
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003887 unsigned KeyLen = 1;
Richard Smitha06c7e62015-08-26 23:55:49 +00003888 switch (Name.getKind()) {
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003889 case DeclarationName::Identifier:
3890 case DeclarationName::ObjCZeroArgSelector:
3891 case DeclarationName::ObjCOneArgSelector:
3892 case DeclarationName::ObjCMultiArgSelector:
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003893 case DeclarationName::CXXLiteralOperatorName:
Richard Smith35845152017-02-07 01:37:30 +00003894 case DeclarationName::CXXDeductionGuideName:
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003895 KeyLen += 4;
3896 break;
3897 case DeclarationName::CXXOperatorName:
3898 KeyLen += 1;
3899 break;
Douglas Gregor3b65ed02011-08-02 18:32:54 +00003900 case DeclarationName::CXXConstructorName:
3901 case DeclarationName::CXXDestructorName:
3902 case DeclarationName::CXXConversionFunctionName:
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003903 case DeclarationName::CXXUsingDirective:
3904 break;
3905 }
Justin Bognere1c147c2014-03-28 22:03:19 +00003906 LE.write<uint16_t>(KeyLen);
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003907
Richard Smithf02662d2015-07-30 03:17:16 +00003908 // 4 bytes for each DeclID.
Richard Smithd88a7f12015-09-01 20:35:42 +00003909 unsigned DataLen = 4 * (Lookup.second - Lookup.first);
3910 assert(uint16_t(DataLen) == DataLen &&
3911 "too many decls for serialized lookup result");
Justin Bognere1c147c2014-03-28 22:03:19 +00003912 LE.write<uint16_t>(DataLen);
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003913
3914 return std::make_pair(KeyLen, DataLen);
3915 }
3916
Richard Smitha06c7e62015-08-26 23:55:49 +00003917 void EmitKey(raw_ostream &Out, DeclarationNameKey Name, unsigned) {
Justin Bognere1c147c2014-03-28 22:03:19 +00003918 using namespace llvm::support;
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003919
Peter Collingbournee3f65292018-05-18 19:46:24 +00003920 endian::Writer LE(Out, little);
Richard Smitha06c7e62015-08-26 23:55:49 +00003921 LE.write<uint8_t>(Name.getKind());
3922 switch (Name.getKind()) {
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003923 case DeclarationName::Identifier:
Richard Smitha06c7e62015-08-26 23:55:49 +00003924 case DeclarationName::CXXLiteralOperatorName:
Richard Smith35845152017-02-07 01:37:30 +00003925 case DeclarationName::CXXDeductionGuideName:
Richard Smitha06c7e62015-08-26 23:55:49 +00003926 LE.write<uint32_t>(Writer.getIdentifierRef(Name.getIdentifier()));
Benjamin Kramer53750b12012-09-19 13:40:40 +00003927 return;
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003928 case DeclarationName::ObjCZeroArgSelector:
3929 case DeclarationName::ObjCOneArgSelector:
3930 case DeclarationName::ObjCMultiArgSelector:
Richard Smitha06c7e62015-08-26 23:55:49 +00003931 LE.write<uint32_t>(Writer.getSelectorRef(Name.getSelector()));
Benjamin Kramer53750b12012-09-19 13:40:40 +00003932 return;
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003933 case DeclarationName::CXXOperatorName:
Richard Smitha06c7e62015-08-26 23:55:49 +00003934 assert(Name.getOperatorKind() < NUM_OVERLOADED_OPERATORS &&
Benjamin Kramer53750b12012-09-19 13:40:40 +00003935 "Invalid operator?");
Richard Smitha06c7e62015-08-26 23:55:49 +00003936 LE.write<uint8_t>(Name.getOperatorKind());
Benjamin Kramer53750b12012-09-19 13:40:40 +00003937 return;
Douglas Gregor3b65ed02011-08-02 18:32:54 +00003938 case DeclarationName::CXXConstructorName:
3939 case DeclarationName::CXXDestructorName:
3940 case DeclarationName::CXXConversionFunctionName:
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003941 case DeclarationName::CXXUsingDirective:
Benjamin Kramer53750b12012-09-19 13:40:40 +00003942 return;
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003943 }
Benjamin Kramer53750b12012-09-19 13:40:40 +00003944
3945 llvm_unreachable("Invalid name kind?");
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003946 }
3947
Richard Smitha06c7e62015-08-26 23:55:49 +00003948 void EmitData(raw_ostream &Out, key_type_ref, data_type Lookup,
3949 unsigned DataLen) {
Justin Bognere1c147c2014-03-28 22:03:19 +00003950 using namespace llvm::support;
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003951
Peter Collingbournee3f65292018-05-18 19:46:24 +00003952 endian::Writer LE(Out, little);
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003953 uint64_t Start = Out.tell(); (void)Start;
Richard Smithd88a7f12015-09-01 20:35:42 +00003954 for (unsigned I = Lookup.first, N = Lookup.second; I != N; ++I)
3955 LE.write<uint32_t>(DeclIDs[I]);
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003956 assert(Out.tell() - Start == DataLen && "Data length is wrong");
3957 }
3958};
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +00003959
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003960} // namespace
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003961
Chandler Carruthe972c362015-03-26 03:11:40 +00003962bool ASTWriter::isLookupResultExternal(StoredDeclsList &Result,
3963 DeclContext *DC) {
Erich Keanef92f31c2018-08-01 20:48:16 +00003964 return Result.hasExternalDecls() &&
3965 DC->hasNeedToReconcileExternalVisibleStorage();
Chandler Carruthe972c362015-03-26 03:11:40 +00003966}
3967
3968bool ASTWriter::isLookupResultEntirelyExternal(StoredDeclsList &Result,
3969 DeclContext *DC) {
3970 for (auto *D : Result.getLookupResult())
3971 if (!getDeclForLocalLookup(getLangOpts(), D)->isFromASTFile())
3972 return false;
3973
3974 return true;
3975}
3976
Richard Smithd88a7f12015-09-01 20:35:42 +00003977void
Chandler Carruthe972c362015-03-26 03:11:40 +00003978ASTWriter::GenerateNameLookupTable(const DeclContext *ConstDC,
Richard Smithcd45dbc2014-04-19 03:48:30 +00003979 llvm::SmallVectorImpl<char> &LookupTable) {
Erich Keanef92f31c2018-08-01 20:48:16 +00003980 assert(!ConstDC->hasLazyLocalLexicalLookups() &&
3981 !ConstDC->hasLazyExternalLexicalLookups() &&
Richard Smith9e2341d2015-03-23 03:25:59 +00003982 "must call buildLookups first");
Richard Smithcd45dbc2014-04-19 03:48:30 +00003983
Chandler Carruthe972c362015-03-26 03:11:40 +00003984 // FIXME: We need to build the lookups table, which is logically const.
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00003985 auto *DC = const_cast<DeclContext*>(ConstDC);
Chandler Carruthe972c362015-03-26 03:11:40 +00003986 assert(DC == DC->getPrimaryContext() && "only primary DC has lookup table");
3987
3988 // Create the on-disk hash table representation.
Richard Smithd88a7f12015-09-01 20:35:42 +00003989 MultiOnDiskHashTableGenerator<reader::ASTDeclContextNameLookupTrait,
3990 ASTDeclContextNameLookupTrait> Generator;
Richard Smithcd45dbc2014-04-19 03:48:30 +00003991 ASTDeclContextNameLookupTrait Trait(*this);
3992
Chandler Carruthe972c362015-03-26 03:11:40 +00003993 // The first step is to collect the declaration names which we need to
3994 // serialize into the name lookup table, and to collect them in a stable
3995 // order.
3996 SmallVector<DeclarationName, 16> Names;
Richard Smithcd45dbc2014-04-19 03:48:30 +00003997
Chandler Carruthe972c362015-03-26 03:11:40 +00003998 // We also build up small sets of the constructor and conversion function
3999 // names which are visible.
4000 llvm::SmallSet<DeclarationName, 8> ConstructorNameSet, ConversionNameSet;
Richard Smithcd45dbc2014-04-19 03:48:30 +00004001
Chandler Carruthe972c362015-03-26 03:11:40 +00004002 for (auto &Lookup : *DC->buildLookup()) {
4003 auto &Name = Lookup.first;
4004 auto &Result = Lookup.second;
4005
Douglas Gregor7dd37e52015-11-03 01:20:54 +00004006 // If there are no local declarations in our lookup result, we
4007 // don't need to write an entry for the name at all. If we can't
4008 // write out a lookup set without performing more deserialization,
4009 // just skip this entry.
4010 if (isLookupResultExternal(Result, DC) &&
Chandler Carruthe972c362015-03-26 03:11:40 +00004011 isLookupResultEntirelyExternal(Result, DC))
4012 continue;
4013
4014 // We also skip empty results. If any of the results could be external and
4015 // the currently available results are empty, then all of the results are
4016 // external and we skip it above. So the only way we get here with an empty
4017 // results is when no results could have been external *and* we have
4018 // external results.
4019 //
4020 // FIXME: While we might want to start emitting on-disk entries for negative
4021 // lookups into a decl context as an optimization, today we *have* to skip
4022 // them because there are names with empty lookup results in decl contexts
4023 // which we can't emit in any stable ordering: we lookup constructors and
4024 // conversion functions in the enclosing namespace scope creating empty
4025 // results for them. This in almost certainly a bug in Clang's name lookup,
4026 // but that is likely to be hard or impossible to fix and so we tolerate it
4027 // here by omitting lookups with empty results.
4028 if (Lookup.second.getLookupResult().empty())
4029 continue;
4030
4031 switch (Lookup.first.getNameKind()) {
4032 default:
4033 Names.push_back(Lookup.first);
4034 break;
4035
Richard Smithcd45dbc2014-04-19 03:48:30 +00004036 case DeclarationName::CXXConstructorName:
Chandler Carruthe972c362015-03-26 03:11:40 +00004037 assert(isa<CXXRecordDecl>(DC) &&
4038 "Cannot have a constructor name outside of a class!");
4039 ConstructorNameSet.insert(Name);
4040 break;
Richard Smithcd45dbc2014-04-19 03:48:30 +00004041
4042 case DeclarationName::CXXConversionFunctionName:
Chandler Carruthe972c362015-03-26 03:11:40 +00004043 assert(isa<CXXRecordDecl>(DC) &&
4044 "Cannot have a conversion function name outside of a class!");
4045 ConversionNameSet.insert(Name);
Rafael Espindolac606b3e2015-03-25 04:43:15 +00004046 break;
Richard Smithcd45dbc2014-04-19 03:48:30 +00004047 }
Chandler Carruth75c9f132015-03-25 00:34:51 +00004048 }
Chandler Carruth75c9f132015-03-25 00:34:51 +00004049
Chandler Carruthe972c362015-03-26 03:11:40 +00004050 // Sort the names into a stable order.
Fangrui Song55fab262018-09-26 22:16:28 +00004051 llvm::sort(Names);
Chandler Carruthe972c362015-03-26 03:11:40 +00004052
Chandler Carruthffbf7052015-03-26 22:27:09 +00004053 if (auto *D = dyn_cast<CXXRecordDecl>(DC)) {
Chandler Carruthe972c362015-03-26 03:11:40 +00004054 // We need to establish an ordering of constructor and conversion function
Chandler Carruthffbf7052015-03-26 22:27:09 +00004055 // names, and they don't have an intrinsic ordering.
Chandler Carruthe972c362015-03-26 03:11:40 +00004056
Chandler Carruthffbf7052015-03-26 22:27:09 +00004057 // First we try the easy case by forming the current context's constructor
4058 // name and adding that name first. This is a very useful optimization to
4059 // avoid walking the lexical declarations in many cases, and it also
4060 // handles the only case where a constructor name can come from some other
4061 // lexical context -- when that name is an implicit constructor merged from
4062 // another declaration in the redecl chain. Any non-implicit constructor or
4063 // conversion function which doesn't occur in all the lexical contexts
4064 // would be an ODR violation.
4065 auto ImplicitCtorName = Context->DeclarationNames.getCXXConstructorName(
4066 Context->getCanonicalType(Context->getRecordType(D)));
4067 if (ConstructorNameSet.erase(ImplicitCtorName))
4068 Names.push_back(ImplicitCtorName);
Chandler Carruthe972c362015-03-26 03:11:40 +00004069
Chandler Carruthffbf7052015-03-26 22:27:09 +00004070 // If we still have constructors or conversion functions, we walk all the
4071 // names in the decl and add the constructors and conversion functions
4072 // which are visible in the order they lexically occur within the context.
4073 if (!ConstructorNameSet.empty() || !ConversionNameSet.empty())
4074 for (Decl *ChildD : cast<CXXRecordDecl>(DC)->decls())
4075 if (auto *ChildND = dyn_cast<NamedDecl>(ChildD)) {
4076 auto Name = ChildND->getDeclName();
4077 switch (Name.getNameKind()) {
4078 default:
4079 continue;
4080
4081 case DeclarationName::CXXConstructorName:
4082 if (ConstructorNameSet.erase(Name))
4083 Names.push_back(Name);
4084 break;
4085
4086 case DeclarationName::CXXConversionFunctionName:
4087 if (ConversionNameSet.erase(Name))
4088 Names.push_back(Name);
4089 break;
4090 }
4091
4092 if (ConstructorNameSet.empty() && ConversionNameSet.empty())
4093 break;
Chandler Carruthe972c362015-03-26 03:11:40 +00004094 }
4095
Chandler Carruthe972c362015-03-26 03:11:40 +00004096 assert(ConstructorNameSet.empty() && "Failed to find all of the visible "
4097 "constructors by walking all the "
4098 "lexical members of the context.");
4099 assert(ConversionNameSet.empty() && "Failed to find all of the visible "
4100 "conversion functions by walking all "
4101 "the lexical members of the context.");
Richard Smith961eae52014-03-25 01:14:22 +00004102 }
4103
Chandler Carruthe972c362015-03-26 03:11:40 +00004104 // Next we need to do a lookup with each name into this decl context to fully
4105 // populate any results from external sources. We don't actually use the
4106 // results of these lookups because we only want to use the results after all
4107 // results have been loaded and the pointers into them will be stable.
4108 for (auto &Name : Names)
4109 DC->lookup(Name);
4110
4111 // Now we need to insert the results for each name into the hash table. For
4112 // constructor names and conversion function names, we actually need to merge
4113 // all of the results for them into one list of results each and insert
4114 // those.
4115 SmallVector<NamedDecl *, 8> ConstructorDecls;
4116 SmallVector<NamedDecl *, 8> ConversionDecls;
4117
4118 // Now loop over the names, either inserting them or appending for the two
4119 // special cases.
4120 for (auto &Name : Names) {
4121 DeclContext::lookup_result Result = DC->noload_lookup(Name);
4122
4123 switch (Name.getNameKind()) {
4124 default:
Richard Smithd88a7f12015-09-01 20:35:42 +00004125 Generator.insert(Name, Trait.getData(Result), Trait);
Chandler Carruthe972c362015-03-26 03:11:40 +00004126 break;
4127
4128 case DeclarationName::CXXConstructorName:
4129 ConstructorDecls.append(Result.begin(), Result.end());
4130 break;
4131
4132 case DeclarationName::CXXConversionFunctionName:
4133 ConversionDecls.append(Result.begin(), Result.end());
4134 break;
4135 }
4136 }
4137
4138 // Handle our two special cases if we ended up having any. We arbitrarily use
4139 // the first declaration's name here because the name itself isn't part of
4140 // the key, only the kind of name is used.
4141 if (!ConstructorDecls.empty())
4142 Generator.insert(ConstructorDecls.front()->getDeclName(),
Richard Smithd88a7f12015-09-01 20:35:42 +00004143 Trait.getData(ConstructorDecls), Trait);
Chandler Carruthe972c362015-03-26 03:11:40 +00004144 if (!ConversionDecls.empty())
4145 Generator.insert(ConversionDecls.front()->getDeclName(),
Richard Smithd88a7f12015-09-01 20:35:42 +00004146 Trait.getData(ConversionDecls), Trait);
Chandler Carruthe972c362015-03-26 03:11:40 +00004147
Richard Smithd88a7f12015-09-01 20:35:42 +00004148 // Create the on-disk hash table. Also emit the existing imported and
4149 // merged table if there is one.
4150 auto *Lookups = Chain ? Chain->getLoadedLookupTables(DC) : nullptr;
4151 Generator.emit(LookupTable, Trait, Lookups ? &Lookups->Table : nullptr);
Richard Smith961eae52014-03-25 01:14:22 +00004152}
4153
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00004154/// Write the block containing all of the declaration IDs
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00004155/// visible from the given DeclContext.
4156///
4157/// \returns the offset of the DECL_CONTEXT_VISIBLE block within the
Sebastian Redla4071b42010-08-24 00:50:09 +00004158/// bitstream, or 0 if no block was written.
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00004159uint64_t ASTWriter::WriteDeclContextVisibleBlock(ASTContext &Context,
4160 DeclContext *DC) {
Richard Smith5fc18a92015-07-12 23:43:21 +00004161 // If we imported a key declaration of this namespace, write the visible
4162 // lookup results as an update record for it rather than including them
4163 // on this declaration. We will only look at key declarations on reload.
4164 if (isa<NamespaceDecl>(DC) && Chain &&
4165 Chain->getKeyDeclaration(cast<Decl>(DC))->isFromASTFile()) {
4166 // Only do this once, for the first local declaration of the namespace.
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00004167 for (auto *Prev = cast<NamespaceDecl>(DC)->getPreviousDecl(); Prev;
Richard Smith5fc18a92015-07-12 23:43:21 +00004168 Prev = Prev->getPreviousDecl())
4169 if (!Prev->isFromASTFile())
4170 return 0;
4171
4172 // Note that we need to emit an update record for the primary context.
4173 UpdatedDeclContexts.insert(DC->getPrimaryContext());
4174
4175 // Make sure all visible decls are written. They will be recorded later. We
4176 // do this using a side data structure so we can sort the names into
4177 // a deterministic order.
4178 StoredDeclsMap *Map = DC->getPrimaryContext()->buildLookup();
4179 SmallVector<std::pair<DeclarationName, DeclContext::lookup_result>, 16>
4180 LookupResults;
4181 if (Map) {
4182 LookupResults.reserve(Map->size());
4183 for (auto &Entry : *Map)
4184 LookupResults.push_back(
4185 std::make_pair(Entry.first, Entry.second.getLookupResult()));
4186 }
4187
Fangrui Song55fab262018-09-26 22:16:28 +00004188 llvm::sort(LookupResults, llvm::less_first());
Richard Smith5fc18a92015-07-12 23:43:21 +00004189 for (auto &NameAndResult : LookupResults) {
4190 DeclarationName Name = NameAndResult.first;
4191 DeclContext::lookup_result Result = NameAndResult.second;
4192 if (Name.getNameKind() == DeclarationName::CXXConstructorName ||
4193 Name.getNameKind() == DeclarationName::CXXConversionFunctionName) {
4194 // We have to work around a name lookup bug here where negative lookup
4195 // results for these names get cached in namespace lookup tables (these
4196 // names should never be looked up in a namespace).
4197 assert(Result.empty() && "Cannot have a constructor or conversion "
4198 "function name in a namespace!");
4199 continue;
4200 }
4201
4202 for (NamedDecl *ND : Result)
4203 if (!ND->isFromASTFile())
4204 GetDeclRef(ND);
4205 }
4206
4207 return 0;
4208 }
4209
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00004210 if (DC->getPrimaryContext() != DC)
4211 return 0;
4212
Chandler Carruthe972c362015-03-26 03:11:40 +00004213 // Skip contexts which don't support name lookup.
4214 if (!DC->isLookupContext())
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00004215 return 0;
4216
4217 // If not in C++, we perform name lookup for the translation unit via the
4218 // IdentifierInfo chains, don't bother to build a visible-declarations table.
David Blaikiebbafb8a2012-03-11 07:00:24 +00004219 if (DC->isTranslationUnit() && !Context.getLangOpts().CPlusPlus)
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00004220 return 0;
4221
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00004222 // Serialize the contents of the mapping used for lookup. Note that,
4223 // although we have two very different code paths, the serialized
4224 // representation is the same for both cases: a declaration name,
4225 // followed by a size, followed by references to the visible
4226 // declarations that have that name.
4227 uint64_t Offset = Stream.GetCurrentBitNo();
Richard Smithf634c902012-03-16 06:12:59 +00004228 StoredDeclsMap *Map = DC->buildLookup();
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00004229 if (!Map || Map->empty())
4230 return 0;
4231
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00004232 // Create the on-disk hash table in a buffer.
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00004233 SmallString<4096> LookupTable;
Richard Smithd88a7f12015-09-01 20:35:42 +00004234 GenerateNameLookupTable(DC, LookupTable);
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00004235
4236 // Write the lookup table
Mehdi Amini57a41912015-09-10 01:46:39 +00004237 RecordData::value_type Record[] = {DECL_CONTEXT_VISIBLE};
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00004238 Stream.EmitRecordWithBlob(DeclContextVisibleLookupAbbrev, Record,
Yaron Keren92e1b622015-03-18 10:17:07 +00004239 LookupTable);
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00004240 ++NumVisibleDeclContexts;
4241 return Offset;
4242}
4243
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00004244/// Write an UPDATE_VISIBLE block for the given context.
Sebastian Redla4071b42010-08-24 00:50:09 +00004245///
4246/// UPDATE_VISIBLE blocks contain the declarations that are added to an existing
4247/// DeclContext in a dependent AST file. As such, they only exist for the TU
Richard Smithf634c902012-03-16 06:12:59 +00004248/// (in C++), for namespaces, and for classes with forward-declared unscoped
4249/// enumeration members (in C++11).
Sebastian Redla4071b42010-08-24 00:50:09 +00004250void ASTWriter::WriteDeclContextVisibleUpdate(const DeclContext *DC) {
Richard Smith961eae52014-03-25 01:14:22 +00004251 StoredDeclsMap *Map = DC->getLookupPtr();
Sebastian Redla4071b42010-08-24 00:50:09 +00004252 if (!Map || Map->empty())
4253 return;
4254
Sebastian Redla4071b42010-08-24 00:50:09 +00004255 // Create the on-disk hash table in a buffer.
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00004256 SmallString<4096> LookupTable;
Richard Smithd88a7f12015-09-01 20:35:42 +00004257 GenerateNameLookupTable(DC, LookupTable);
Sebastian Redla4071b42010-08-24 00:50:09 +00004258
Richard Smith5fc18a92015-07-12 23:43:21 +00004259 // If we're updating a namespace, select a key declaration as the key for the
4260 // update record; those are the only ones that will be checked on reload.
4261 if (isa<NamespaceDecl>(DC))
4262 DC = cast<DeclContext>(Chain->getKeyDeclaration(cast<Decl>(DC)));
4263
Sebastian Redla4071b42010-08-24 00:50:09 +00004264 // Write the lookup table
Mehdi Amini57a41912015-09-10 01:46:39 +00004265 RecordData::value_type Record[] = {UPDATE_VISIBLE, getDeclID(cast<Decl>(DC))};
Yaron Keren92e1b622015-03-18 10:17:07 +00004266 Stream.EmitRecordWithBlob(UpdateVisibleAbbrev, Record, LookupTable);
Sebastian Redla4071b42010-08-24 00:50:09 +00004267}
4268
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00004269/// Write an FP_PRAGMA_OPTIONS block for the given FPOptions.
Peter Collingbourne5df20e02011-02-15 19:46:30 +00004270void ASTWriter::WriteFPPragmaOptions(const FPOptions &Opts) {
Adam Nemet484aa452017-03-27 19:17:25 +00004271 RecordData::value_type Record[] = {Opts.getInt()};
Peter Collingbourne5df20e02011-02-15 19:46:30 +00004272 Stream.EmitRecord(FP_PRAGMA_OPTIONS, Record);
4273}
4274
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00004275/// Write an OPENCL_EXTENSIONS block for the given OpenCLOptions.
Peter Collingbourne5df20e02011-02-15 19:46:30 +00004276void ASTWriter::WriteOpenCLExtensions(Sema &SemaRef) {
David Blaikiebbafb8a2012-03-11 07:00:24 +00004277 if (!SemaRef.Context.getLangOpts().OpenCL)
Peter Collingbourne5df20e02011-02-15 19:46:30 +00004278 return;
4279
4280 const OpenCLOptions &Opts = SemaRef.getOpenCLOptions();
4281 RecordData Record;
Yaxun Liu5b746652016-12-18 05:18:55 +00004282 for (const auto &I:Opts.OptMap) {
4283 AddString(I.getKey(), Record);
4284 auto V = I.getValue();
Yaxun Liucc2741c2016-12-18 06:35:06 +00004285 Record.push_back(V.Supported ? 1 : 0);
4286 Record.push_back(V.Enabled ? 1 : 0);
Yaxun Liu5b746652016-12-18 05:18:55 +00004287 Record.push_back(V.Avail);
4288 Record.push_back(V.Core);
4289 }
Peter Collingbourne5df20e02011-02-15 19:46:30 +00004290 Stream.EmitRecord(OPENCL_EXTENSIONS, Record);
4291}
4292
Yaxun Liu5b746652016-12-18 05:18:55 +00004293void ASTWriter::WriteOpenCLExtensionTypes(Sema &SemaRef) {
4294 if (!SemaRef.Context.getLangOpts().OpenCL)
4295 return;
4296
Bruno Ricci2751b692019-04-18 15:13:27 +00004297 // Sort the elements of the map OpenCLTypeExtMap by TypeIDs,
4298 // without copying them.
4299 const llvm::DenseMap<const Type *, std::set<std::string>> &OpenCLTypeExtMap =
4300 SemaRef.OpenCLTypeExtMap;
4301 using ElementTy = std::pair<TypeID, const std::set<std::string> *>;
4302 llvm::SmallVector<ElementTy, 8> StableOpenCLTypeExtMap;
4303 StableOpenCLTypeExtMap.reserve(OpenCLTypeExtMap.size());
4304
4305 for (const auto &I : OpenCLTypeExtMap)
4306 StableOpenCLTypeExtMap.emplace_back(
4307 getTypeID(I.first->getCanonicalTypeInternal()), &I.second);
4308
4309 auto CompareByTypeID = [](const ElementTy &E1, const ElementTy &E2) -> bool {
4310 return E1.first < E2.first;
4311 };
4312 llvm::sort(StableOpenCLTypeExtMap, CompareByTypeID);
4313
Yaxun Liu5b746652016-12-18 05:18:55 +00004314 RecordData Record;
Bruno Ricci2751b692019-04-18 15:13:27 +00004315 for (const ElementTy &E : StableOpenCLTypeExtMap) {
4316 Record.push_back(E.first); // TypeID
4317 const std::set<std::string> *ExtSet = E.second;
4318 Record.push_back(static_cast<unsigned>(ExtSet->size()));
4319 for (const std::string &Ext : *ExtSet)
Yaxun Liu5b746652016-12-18 05:18:55 +00004320 AddString(Ext, Record);
4321 }
Bruno Ricci2751b692019-04-18 15:13:27 +00004322
Yaxun Liu5b746652016-12-18 05:18:55 +00004323 Stream.EmitRecord(OPENCL_EXTENSION_TYPES, Record);
4324}
4325
4326void ASTWriter::WriteOpenCLExtensionDecls(Sema &SemaRef) {
4327 if (!SemaRef.Context.getLangOpts().OpenCL)
4328 return;
4329
Bruno Ricci2751b692019-04-18 15:13:27 +00004330 // Sort the elements of the map OpenCLDeclExtMap by DeclIDs,
4331 // without copying them.
4332 const llvm::DenseMap<const Decl *, std::set<std::string>> &OpenCLDeclExtMap =
4333 SemaRef.OpenCLDeclExtMap;
4334 using ElementTy = std::pair<DeclID, const std::set<std::string> *>;
4335 llvm::SmallVector<ElementTy, 8> StableOpenCLDeclExtMap;
4336 StableOpenCLDeclExtMap.reserve(OpenCLDeclExtMap.size());
4337
4338 for (const auto &I : OpenCLDeclExtMap)
4339 StableOpenCLDeclExtMap.emplace_back(getDeclID(I.first), &I.second);
4340
4341 auto CompareByDeclID = [](const ElementTy &E1, const ElementTy &E2) -> bool {
4342 return E1.first < E2.first;
4343 };
4344 llvm::sort(StableOpenCLDeclExtMap, CompareByDeclID);
4345
Yaxun Liu5b746652016-12-18 05:18:55 +00004346 RecordData Record;
Bruno Ricci2751b692019-04-18 15:13:27 +00004347 for (const ElementTy &E : StableOpenCLDeclExtMap) {
4348 Record.push_back(E.first); // DeclID
4349 const std::set<std::string> *ExtSet = E.second;
4350 Record.push_back(static_cast<unsigned>(ExtSet->size()));
4351 for (const std::string &Ext : *ExtSet)
Yaxun Liu5b746652016-12-18 05:18:55 +00004352 AddString(Ext, Record);
4353 }
Bruno Ricci2751b692019-04-18 15:13:27 +00004354
Yaxun Liu5b746652016-12-18 05:18:55 +00004355 Stream.EmitRecord(OPENCL_EXTENSION_DECLS, Record);
4356}
4357
Justin Lebar67a78a62016-10-08 22:15:58 +00004358void ASTWriter::WriteCUDAPragmas(Sema &SemaRef) {
4359 if (SemaRef.ForceCUDAHostDeviceDepth > 0) {
4360 RecordData::value_type Record[] = {SemaRef.ForceCUDAHostDeviceDepth};
4361 Stream.EmitRecord(CUDA_PRAGMA_FORCE_HOST_DEVICE_DEPTH, Record);
4362 }
4363}
4364
Douglas Gregor404cdde2012-01-27 01:47:08 +00004365void ASTWriter::WriteObjCCategories() {
Dmitri Gribenkof8579502013-01-12 19:30:44 +00004366 SmallVector<ObjCCategoriesInfo, 2> CategoriesMap;
Douglas Gregor404cdde2012-01-27 01:47:08 +00004367 RecordData Categories;
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00004368
Douglas Gregor404cdde2012-01-27 01:47:08 +00004369 for (unsigned I = 0, N = ObjCClassesWithCategories.size(); I != N; ++I) {
4370 unsigned Size = 0;
4371 unsigned StartIndex = Categories.size();
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00004372
Douglas Gregor404cdde2012-01-27 01:47:08 +00004373 ObjCInterfaceDecl *Class = ObjCClassesWithCategories[I];
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00004374
Douglas Gregor404cdde2012-01-27 01:47:08 +00004375 // Allocate space for the size.
4376 Categories.push_back(0);
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00004377
Douglas Gregor404cdde2012-01-27 01:47:08 +00004378 // Add the categories.
Douglas Gregor048fbfa2013-01-16 23:00:23 +00004379 for (ObjCInterfaceDecl::known_categories_iterator
4380 Cat = Class->known_categories_begin(),
4381 CatEnd = Class->known_categories_end();
4382 Cat != CatEnd; ++Cat, ++Size) {
4383 assert(getDeclID(*Cat) != 0 && "Bogus category");
4384 AddDeclRef(*Cat, Categories);
Douglas Gregor404cdde2012-01-27 01:47:08 +00004385 }
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00004386
Douglas Gregor404cdde2012-01-27 01:47:08 +00004387 // Update the size.
4388 Categories[StartIndex] = Size;
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00004389
Douglas Gregor404cdde2012-01-27 01:47:08 +00004390 // Record this interface -> category map.
4391 ObjCCategoriesInfo CatInfo = { getDeclID(Class), StartIndex };
4392 CategoriesMap.push_back(CatInfo);
4393 }
4394
4395 // Sort the categories map by the definition ID, since the reader will be
4396 // performing binary searches on this information.
4397 llvm::array_pod_sort(CategoriesMap.begin(), CategoriesMap.end());
4398
4399 // Emit the categories map.
4400 using namespace llvm;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00004401
David Blaikieb44f0bf2017-01-04 22:36:43 +00004402 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Douglas Gregor404cdde2012-01-27 01:47:08 +00004403 Abbrev->Add(BitCodeAbbrevOp(OBJC_CATEGORIES_MAP));
4404 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // # of entries
4405 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
David Blaikieb44f0bf2017-01-04 22:36:43 +00004406 unsigned AbbrevID = Stream.EmitAbbrev(std::move(Abbrev));
Mehdi Amini57a41912015-09-10 01:46:39 +00004407
4408 RecordData::value_type Record[] = {OBJC_CATEGORIES_MAP, CategoriesMap.size()};
4409 Stream.EmitRecordWithBlob(AbbrevID, Record,
4410 reinterpret_cast<char *>(CategoriesMap.data()),
Douglas Gregor404cdde2012-01-27 01:47:08 +00004411 CategoriesMap.size() * sizeof(ObjCCategoriesInfo));
Mehdi Amini57a41912015-09-10 01:46:39 +00004412
Douglas Gregor404cdde2012-01-27 01:47:08 +00004413 // Emit the category lists.
4414 Stream.EmitRecord(OBJC_CATEGORIES, Categories);
4415}
4416
Richard Smithe40f2ba2013-08-07 21:41:30 +00004417void ASTWriter::WriteLateParsedTemplates(Sema &SemaRef) {
4418 Sema::LateParsedTemplateMapT &LPTMap = SemaRef.LateParsedTemplateMap;
4419
4420 if (LPTMap.empty())
4421 return;
4422
4423 RecordData Record;
Justin Lebar28f09c52016-10-10 16:26:08 +00004424 for (auto &LPTMapEntry : LPTMap) {
Chandler Carruth52cee4d2015-03-26 09:08:15 +00004425 const FunctionDecl *FD = LPTMapEntry.first;
Justin Lebar28f09c52016-10-10 16:26:08 +00004426 LateParsedTemplate &LPT = *LPTMapEntry.second;
Chandler Carruth52cee4d2015-03-26 09:08:15 +00004427 AddDeclRef(FD, Record);
Justin Lebar28f09c52016-10-10 16:26:08 +00004428 AddDeclRef(LPT.D, Record);
4429 Record.push_back(LPT.Toks.size());
Richard Smithe40f2ba2013-08-07 21:41:30 +00004430
Justin Lebar28f09c52016-10-10 16:26:08 +00004431 for (const auto &Tok : LPT.Toks) {
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00004432 AddToken(Tok, Record);
Richard Smithe40f2ba2013-08-07 21:41:30 +00004433 }
4434 }
4435 Stream.EmitRecord(LATE_PARSED_TEMPLATE, Record);
4436}
4437
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00004438/// Write the state of 'pragma clang optimize' at the end of the module.
Dario Domizioli13a0a382014-05-23 12:13:25 +00004439void ASTWriter::WriteOptimizePragmaOptions(Sema &SemaRef) {
4440 RecordData Record;
4441 SourceLocation PragmaLoc = SemaRef.getOptimizeOffPragmaLocation();
4442 AddSourceLocation(PragmaLoc, Record);
4443 Stream.EmitRecord(OPTIMIZE_PRAGMA_OPTIONS, Record);
4444}
4445
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00004446/// Write the state of 'pragma ms_struct' at the end of the module.
Nico Weber779355f2016-03-02 23:22:00 +00004447void ASTWriter::WriteMSStructPragmaOptions(Sema &SemaRef) {
4448 RecordData Record;
4449 Record.push_back(SemaRef.MSStructPragmaOn ? PMSST_ON : PMSST_OFF);
4450 Stream.EmitRecord(MSSTRUCT_PRAGMA_OPTIONS, Record);
4451}
4452
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00004453/// Write the state of 'pragma pointers_to_members' at the end of the
Nico Weber42932312016-03-03 00:17:35 +00004454//module.
4455void ASTWriter::WriteMSPointersToMembersPragmaOptions(Sema &SemaRef) {
4456 RecordData Record;
4457 Record.push_back(SemaRef.MSPointerToMemberRepresentationMethod);
4458 AddSourceLocation(SemaRef.ImplicitMSInheritanceAttrLoc, Record);
4459 Stream.EmitRecord(POINTERS_TO_MEMBERS_PRAGMA_OPTIONS, Record);
4460}
4461
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00004462/// Write the state of 'pragma pack' at the end of the module.
Alex Lorenz7d7e1e02017-03-31 15:36:21 +00004463void ASTWriter::WritePackPragmaOptions(Sema &SemaRef) {
Duncan P. N. Exon Smith03df14c2017-04-15 00:07:57 +00004464 // Don't serialize pragma pack state for modules, since it should only take
4465 // effect on a per-submodule basis.
4466 if (WritingModule)
4467 return;
4468
Alex Lorenz7d7e1e02017-03-31 15:36:21 +00004469 RecordData Record;
4470 Record.push_back(SemaRef.PackStack.CurrentValue);
4471 AddSourceLocation(SemaRef.PackStack.CurrentPragmaLocation, Record);
4472 Record.push_back(SemaRef.PackStack.Stack.size());
4473 for (const auto &StackEntry : SemaRef.PackStack.Stack) {
4474 Record.push_back(StackEntry.Value);
4475 AddSourceLocation(StackEntry.PragmaLocation, Record);
Alex Lorenz45b40142017-07-28 14:41:21 +00004476 AddSourceLocation(StackEntry.PragmaPushLocation, Record);
Alex Lorenz7d7e1e02017-03-31 15:36:21 +00004477 AddString(StackEntry.StackSlotLabel, Record);
4478 }
4479 Stream.EmitRecord(PACK_PRAGMA_OPTIONS, Record);
4480}
4481
Douglas Gregor8f64ca12015-12-08 22:43:32 +00004482void ASTWriter::WriteModuleFileExtension(Sema &SemaRef,
4483 ModuleFileExtensionWriter &Writer) {
Douglas Gregor6623e1f2015-11-03 18:33:07 +00004484 // Enter the extension block.
4485 Stream.EnterSubblock(EXTENSION_BLOCK_ID, 4);
4486
4487 // Emit the metadata record abbreviation.
David Blaikieb44f0bf2017-01-04 22:36:43 +00004488 auto Abv = std::make_shared<llvm::BitCodeAbbrev>();
Douglas Gregor6623e1f2015-11-03 18:33:07 +00004489 Abv->Add(llvm::BitCodeAbbrevOp(EXTENSION_METADATA));
4490 Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::VBR, 6));
4491 Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::VBR, 6));
4492 Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::VBR, 6));
4493 Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::VBR, 6));
4494 Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::Blob));
David Blaikieb44f0bf2017-01-04 22:36:43 +00004495 unsigned Abbrev = Stream.EmitAbbrev(std::move(Abv));
Douglas Gregor6623e1f2015-11-03 18:33:07 +00004496
4497 // Emit the metadata record.
4498 RecordData Record;
4499 auto Metadata = Writer.getExtension()->getExtensionMetadata();
4500 Record.push_back(EXTENSION_METADATA);
4501 Record.push_back(Metadata.MajorVersion);
4502 Record.push_back(Metadata.MinorVersion);
4503 Record.push_back(Metadata.BlockName.size());
4504 Record.push_back(Metadata.UserInfo.size());
4505 SmallString<64> Buffer;
4506 Buffer += Metadata.BlockName;
4507 Buffer += Metadata.UserInfo;
4508 Stream.EmitRecordWithBlob(Abbrev, Record, Buffer);
4509
4510 // Emit the contents of the extension block.
Douglas Gregor8f64ca12015-12-08 22:43:32 +00004511 Writer.writeExtensionContents(SemaRef, Stream);
Douglas Gregor6623e1f2015-11-03 18:33:07 +00004512
4513 // Exit the extension block.
4514 Stream.ExitBlock();
4515}
4516
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00004517//===----------------------------------------------------------------------===//
Douglas Gregorc5046832009-04-27 18:38:38 +00004518// General Serialization Routines
4519//===----------------------------------------------------------------------===//
4520
Richard Smithe43e2b32018-08-20 21:47:29 +00004521void ASTRecordWriter::AddAttr(const Attr *A) {
Reid Kleckner11f9f8a2018-08-14 01:55:37 +00004522 auto &Record = *this;
Richard Smithe43e2b32018-08-20 21:47:29 +00004523 if (!A)
4524 return Record.push_back(0);
4525 Record.push_back(A->getKind() + 1); // FIXME: stable encoding, target attrs
Erich Keane6a24e802019-09-13 17:39:31 +00004526
4527 Record.AddIdentifierRef(A->getAttrName());
4528 Record.AddIdentifierRef(A->getScopeName());
Richard Smithe43e2b32018-08-20 21:47:29 +00004529 Record.AddSourceRange(A->getRange());
Erich Keane6a24e802019-09-13 17:39:31 +00004530 Record.AddSourceLocation(A->getScopeLoc());
4531 Record.push_back(A->getParsedKind());
4532 Record.push_back(A->getSyntax());
4533 Record.push_back(A->getAttributeSpellingListIndexRaw());
Reid Kleckner11f9f8a2018-08-14 01:55:37 +00004534
4535#include "clang/Serialization/AttrPCHWrite.inc"
Richard Smithe43e2b32018-08-20 21:47:29 +00004536}
4537
4538/// Emit the list of attributes to the specified record.
4539void ASTRecordWriter::AddAttributes(ArrayRef<const Attr *> Attrs) {
4540 push_back(Attrs.size());
4541 for (const auto *A : Attrs)
4542 AddAttr(A);
Douglas Gregorbc8a78d52009-04-15 21:30:51 +00004543}
4544
John McCallf413f5e2013-05-03 00:10:13 +00004545void ASTWriter::AddToken(const Token &Tok, RecordDataImpl &Record) {
4546 AddSourceLocation(Tok.getLocation(), Record);
4547 Record.push_back(Tok.getLength());
4548
4549 // FIXME: When reading literal tokens, reconstruct the literal pointer
4550 // if it is needed.
4551 AddIdentifierRef(Tok.getIdentifierInfo(), Record);
4552 // FIXME: Should translate token kind to a stable encoding.
4553 Record.push_back(Tok.getKind());
4554 // FIXME: Should translate token flags to a stable encoding.
4555 Record.push_back(Tok.getFlags());
4556}
4557
Chris Lattner0e62c1c2011-07-23 10:55:15 +00004558void ASTWriter::AddString(StringRef Str, RecordDataImpl &Record) {
Douglas Gregorbc8a78d52009-04-15 21:30:51 +00004559 Record.push_back(Str.size());
4560 Record.insert(Record.end(), Str.begin(), Str.end());
4561}
4562
Richard Smith7ed1bc92014-12-05 22:42:13 +00004563bool ASTWriter::PreparePathForOutput(SmallVectorImpl<char> &Path) {
Richard Smith54cc3c22014-12-11 20:50:24 +00004564 assert(Context && "should have context when outputting path");
Richard Smith7ed1bc92014-12-05 22:42:13 +00004565
Richard Smith54cc3c22014-12-11 20:50:24 +00004566 bool Changed =
4567 cleanPathForOutput(Context->getSourceManager().getFileManager(), Path);
Richard Smith7ed1bc92014-12-05 22:42:13 +00004568
4569 // Remove a prefix to make the path relative, if relevant.
4570 const char *PathBegin = Path.data();
4571 const char *PathPtr =
4572 adjustFilenameForRelocatableAST(PathBegin, BaseDirectory);
4573 if (PathPtr != PathBegin) {
4574 Path.erase(Path.begin(), Path.begin() + (PathPtr - PathBegin));
4575 Changed = true;
4576 }
4577
4578 return Changed;
4579}
4580
4581void ASTWriter::AddPath(StringRef Path, RecordDataImpl &Record) {
4582 SmallString<128> FilePath(Path);
4583 PreparePathForOutput(FilePath);
4584 AddString(FilePath, Record);
4585}
4586
Mehdi Amini57a41912015-09-10 01:46:39 +00004587void ASTWriter::EmitRecordWithPath(unsigned Abbrev, RecordDataRef Record,
Richard Smith7ed1bc92014-12-05 22:42:13 +00004588 StringRef Path) {
4589 SmallString<128> FilePath(Path);
4590 PreparePathForOutput(FilePath);
4591 Stream.EmitRecordWithBlob(Abbrev, Record, FilePath);
4592}
4593
Douglas Gregor20b2ebd2011-03-23 00:50:03 +00004594void ASTWriter::AddVersionTuple(const VersionTuple &Version,
4595 RecordDataImpl &Record) {
4596 Record.push_back(Version.getMajor());
David Blaikie05785d12013-02-20 22:23:23 +00004597 if (Optional<unsigned> Minor = Version.getMinor())
Douglas Gregor20b2ebd2011-03-23 00:50:03 +00004598 Record.push_back(*Minor + 1);
4599 else
4600 Record.push_back(0);
David Blaikie05785d12013-02-20 22:23:23 +00004601 if (Optional<unsigned> Subminor = Version.getSubminor())
Douglas Gregor20b2ebd2011-03-23 00:50:03 +00004602 Record.push_back(*Subminor + 1);
4603 else
4604 Record.push_back(0);
4605}
4606
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00004607/// Note that the identifier II occurs at the given offset
Douglas Gregore84a9da2009-04-20 20:36:09 +00004608/// within the identifier table.
Sebastian Redl55c0ad52010-08-18 23:56:21 +00004609void ASTWriter::SetIdentifierOffset(const IdentifierInfo *II, uint32_t Offset) {
Sebastian Redl539c5062010-08-18 23:57:32 +00004610 IdentID ID = IdentifierIDs[II];
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00004611 // Only store offsets new to this AST file. Other identifier names are looked
Sebastian Redlff4a2952010-07-23 23:49:55 +00004612 // up earlier in the chain and thus don't need an offset.
4613 if (ID >= FirstIdentID)
4614 IdentifierOffsets[ID - FirstIdentID] = Offset;
Douglas Gregore84a9da2009-04-20 20:36:09 +00004615}
4616
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00004617/// Note that the selector Sel occurs at the given offset
Douglas Gregor95c13f52009-04-25 17:48:32 +00004618/// within the method pool/selector table.
Sebastian Redl55c0ad52010-08-18 23:56:21 +00004619void ASTWriter::SetSelectorOffset(Selector Sel, uint32_t Offset) {
Douglas Gregor95c13f52009-04-25 17:48:32 +00004620 unsigned ID = SelectorIDs[Sel];
4621 assert(ID && "Unknown selector");
Sebastian Redld95a56e2010-08-04 18:21:41 +00004622 // Don't record offsets for selectors that are also available in a different
4623 // file.
4624 if (ID < FirstSelectorID)
4625 return;
4626 SelectorOffsets[ID - FirstSelectorID] = Offset;
Douglas Gregor95c13f52009-04-25 17:48:32 +00004627}
4628
David Blaikie61137e12017-01-05 18:23:18 +00004629ASTWriter::ASTWriter(llvm::BitstreamWriter &Stream,
Duncan P. N. Exon Smith8bef5cd2019-03-09 17:33:56 +00004630 SmallVectorImpl<char> &Buffer,
4631 InMemoryModuleCache &ModuleCache,
David Blaikie61137e12017-01-05 18:23:18 +00004632 ArrayRef<std::shared_ptr<ModuleFileExtension>> Extensions,
4633 bool IncludeTimestamps)
Duncan P. N. Exon Smith8bef5cd2019-03-09 17:33:56 +00004634 : Stream(Stream), Buffer(Buffer), ModuleCache(ModuleCache),
Duncan P. N. Exon Smith030d7d62017-03-20 17:58:26 +00004635 IncludeTimestamps(IncludeTimestamps) {
Douglas Gregor6623e1f2015-11-03 18:33:07 +00004636 for (const auto &Ext : Extensions) {
4637 if (auto Writer = Ext->createExtensionWriter(*this))
4638 ModuleFileExtensionWriters.push_back(std::move(Writer));
4639 }
4640}
Douglas Gregoref84c4b2009-04-09 22:27:44 +00004641
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00004642ASTWriter::~ASTWriter() {
Reid Kleckner588c9372014-02-19 23:44:52 +00004643 llvm::DeleteContainerSeconds(FileDeclIDs);
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00004644}
4645
Richard Smithb3761912015-02-05 23:08:52 +00004646const LangOptions &ASTWriter::getLangOpts() const {
4647 assert(WritingAST && "can't determine lang opts when not writing AST");
4648 return Context->getLangOpts();
4649}
4650
Richard Smithe75ee0f2015-08-17 07:13:32 +00004651time_t ASTWriter::getTimestampForOutput(const FileEntry *E) const {
4652 return IncludeTimestamps ? E->getModificationTime() : 0;
4653}
4654
Duncan P. N. Exon Smith60fa2882017-03-13 18:45:08 +00004655ASTFileSignature ASTWriter::WriteAST(Sema &SemaRef,
4656 const std::string &OutputFile,
4657 Module *WritingModule, StringRef isysroot,
Duncan P. N. Exon Smith70d759b2019-03-12 18:38:04 +00004658 bool hasErrors,
4659 bool ShouldCacheASTInMemory) {
Douglas Gregor2fd3d402011-09-17 00:05:03 +00004660 WritingAST = true;
Adrian Prantladbd2b12015-09-22 23:26:31 +00004661
Argyrios Kyrtzidis4a280ff2012-03-07 01:51:17 +00004662 ASTHasCompilerErrors = hasErrors;
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00004663
Douglas Gregoref84c4b2009-04-09 22:27:44 +00004664 // Emit the file header.
Douglas Gregor8f45df52009-04-16 22:23:12 +00004665 Stream.Emit((unsigned)'C', 8);
4666 Stream.Emit((unsigned)'P', 8);
4667 Stream.Emit((unsigned)'C', 8);
4668 Stream.Emit((unsigned)'H', 8);
Mike Stump11289f42009-09-09 15:08:12 +00004669
Chris Lattner28fa4e62009-04-26 22:26:21 +00004670 WriteBlockInfoBlock();
Douglas Gregoref84c4b2009-04-09 22:27:44 +00004671
Douglas Gregoreda8e122011-08-09 15:13:55 +00004672 Context = &SemaRef.Context;
Douglas Gregora28bcdd2011-12-01 02:07:58 +00004673 PP = &SemaRef.PP;
Douglas Gregora89c5ac2011-12-06 01:10:29 +00004674 this->WritingModule = WritingModule;
Adrian Prantladbd2b12015-09-22 23:26:31 +00004675 ASTFileSignature Signature =
4676 WriteASTCore(SemaRef, isysroot, OutputFile, WritingModule);
Craig Toppera13603a2014-05-22 05:54:18 +00004677 Context = nullptr;
4678 PP = nullptr;
4679 this->WritingModule = nullptr;
Richard Smith7ed1bc92014-12-05 22:42:13 +00004680 this->BaseDirectory.clear();
Craig Toppera13603a2014-05-22 05:54:18 +00004681
Douglas Gregor2fd3d402011-09-17 00:05:03 +00004682 WritingAST = false;
Duncan P. N. Exon Smith70d759b2019-03-12 18:38:04 +00004683 if (ShouldCacheASTInMemory) {
Duncan P. N. Exon Smith030d7d62017-03-20 17:58:26 +00004684 // Construct MemoryBuffer and update buffer manager.
Duncan P. N. Exon Smith0a2be462019-03-09 17:44:01 +00004685 ModuleCache.addBuiltPCM(OutputFile,
4686 llvm::MemoryBuffer::getMemBufferCopy(
4687 StringRef(Buffer.begin(), Buffer.size())));
Duncan P. N. Exon Smith030d7d62017-03-20 17:58:26 +00004688 }
Adrian Prantladbd2b12015-09-22 23:26:31 +00004689 return Signature;
Sebastian Redl143413f2010-07-12 22:02:52 +00004690}
4691
Douglas Gregora94a1542011-07-27 21:45:57 +00004692template<typename Vector>
4693static void AddLazyVectorDecls(ASTWriter &Writer, Vector &Vec,
4694 ASTWriter::RecordData &Record) {
Craig Toppera13603a2014-05-22 05:54:18 +00004695 for (typename Vector::iterator I = Vec.begin(nullptr, true), E = Vec.end();
4696 I != E; ++I) {
Douglas Gregora94a1542011-07-27 21:45:57 +00004697 Writer.AddDeclRef(*I, Record);
4698 }
4699}
4700
Duncan P. N. Exon Smith60fa2882017-03-13 18:45:08 +00004701ASTFileSignature ASTWriter::WriteASTCore(Sema &SemaRef, StringRef isysroot,
4702 const std::string &OutputFile,
4703 Module *WritingModule) {
Sebastian Redl143413f2010-07-12 22:02:52 +00004704 using namespace llvm;
4705
Craig Toppera13603a2014-05-22 05:54:18 +00004706 bool isModule = WritingModule != nullptr;
Argyrios Kyrtzidisffb35582013-03-14 04:44:56 +00004707
Douglas Gregorcf68c582011-12-01 22:20:10 +00004708 // Make sure that the AST reader knows to finalize itself.
4709 if (Chain)
4710 Chain->finalizeForWriting();
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00004711
Sebastian Redl143413f2010-07-12 22:02:52 +00004712 ASTContext &Context = SemaRef.Context;
4713 Preprocessor &PP = SemaRef.PP;
4714
Douglas Gregordab42432011-08-12 00:15:20 +00004715 // Set up predefined declaration IDs.
Richard Smith5fc18a92015-07-12 23:43:21 +00004716 auto RegisterPredefDecl = [&] (Decl *D, PredefinedDeclIDs ID) {
4717 if (D) {
4718 assert(D->isCanonicalDecl() && "predefined decl is not canonical");
4719 DeclIDs[D] = ID;
Richard Smith5fc18a92015-07-12 23:43:21 +00004720 }
4721 };
4722 RegisterPredefDecl(Context.getTranslationUnitDecl(),
4723 PREDEF_DECL_TRANSLATION_UNIT_ID);
4724 RegisterPredefDecl(Context.ObjCIdDecl, PREDEF_DECL_OBJC_ID_ID);
4725 RegisterPredefDecl(Context.ObjCSelDecl, PREDEF_DECL_OBJC_SEL_ID);
4726 RegisterPredefDecl(Context.ObjCClassDecl, PREDEF_DECL_OBJC_CLASS_ID);
4727 RegisterPredefDecl(Context.ObjCProtocolClassDecl,
4728 PREDEF_DECL_OBJC_PROTOCOL_ID);
4729 RegisterPredefDecl(Context.Int128Decl, PREDEF_DECL_INT_128_ID);
4730 RegisterPredefDecl(Context.UInt128Decl, PREDEF_DECL_UNSIGNED_INT_128_ID);
4731 RegisterPredefDecl(Context.ObjCInstanceTypeDecl,
4732 PREDEF_DECL_OBJC_INSTANCETYPE_ID);
4733 RegisterPredefDecl(Context.BuiltinVaListDecl, PREDEF_DECL_BUILTIN_VA_LIST_ID);
Richard Smith9b88a4c2015-07-27 05:40:23 +00004734 RegisterPredefDecl(Context.VaListTagDecl, PREDEF_DECL_VA_LIST_TAG);
Charles Davisc7d5c942015-09-17 20:55:33 +00004735 RegisterPredefDecl(Context.BuiltinMSVaListDecl,
4736 PREDEF_DECL_BUILTIN_MS_VA_LIST_ID);
Richard Smith5fc18a92015-07-12 23:43:21 +00004737 RegisterPredefDecl(Context.ExternCContext, PREDEF_DECL_EXTERN_C_CONTEXT_ID);
David Majnemerd9b1a4f2015-11-04 03:40:30 +00004738 RegisterPredefDecl(Context.MakeIntegerSeqDecl,
4739 PREDEF_DECL_MAKE_INTEGER_SEQ_ID);
Quentin Colombet043406b2016-02-03 22:41:00 +00004740 RegisterPredefDecl(Context.CFConstantStringTypeDecl,
4741 PREDEF_DECL_CF_CONSTANT_STRING_ID);
Ben Langmuirf5416742016-02-04 00:55:24 +00004742 RegisterPredefDecl(Context.CFConstantStringTagDecl,
4743 PREDEF_DECL_CF_CONSTANT_STRING_TAG_ID);
Eric Fiselier6ad68552016-07-01 01:24:09 +00004744 RegisterPredefDecl(Context.TypePackElementDecl,
4745 PREDEF_DECL_TYPE_PACK_ELEMENT_ID);
Meador Inge5d3fb222012-06-16 03:34:49 +00004746
Chris Lattner0c797362009-09-08 18:19:27 +00004747 // Build a record containing all of the tentative definitions in this file, in
Sebastian Redl35351a92010-01-31 22:27:38 +00004748 // TentativeDefinitions order. Generally, this record will be empty for
Chris Lattner0c797362009-09-08 18:19:27 +00004749 // headers.
Douglas Gregord4df8652009-04-22 22:02:47 +00004750 RecordData TentativeDefinitions;
Douglas Gregora94a1542011-07-27 21:45:57 +00004751 AddLazyVectorDecls(*this, SemaRef.TentativeDefinitions, TentativeDefinitions);
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00004752
Argyrios Kyrtzidis35672e72010-08-13 18:42:17 +00004753 // Build a record containing all of the file scoped decls in this file.
4754 RecordData UnusedFileScopedDecls;
Argyrios Kyrtzidis59852362013-03-14 04:45:00 +00004755 if (!isModule)
4756 AddLazyVectorDecls(*this, SemaRef.UnusedFileScopedDecls,
4757 UnusedFileScopedDecls);
Sebastian Redl08aca90252010-08-05 18:21:25 +00004758
Douglas Gregor851443c2011-08-12 01:39:19 +00004759 // Build a record containing all of the delegating constructors we still need
4760 // to resolve.
Alexis Hunt27a761d2011-05-04 23:29:54 +00004761 RecordData DelegatingCtorDecls;
Argyrios Kyrtzidisffb35582013-03-14 04:44:56 +00004762 if (!isModule)
4763 AddLazyVectorDecls(*this, SemaRef.DelegatingCtorDecls, DelegatingCtorDecls);
Alexis Hunt27a761d2011-05-04 23:29:54 +00004764
Douglas Gregor851443c2011-08-12 01:39:19 +00004765 // Write the set of weak, undeclared identifiers. We always write the
4766 // entire table, since later PCH files in a PCH chain are only interested in
4767 // the results at the end of the chain.
Argyrios Kyrtzidisee1afa32010-08-05 09:48:08 +00004768 RecordData WeakUndeclaredIdentifiers;
Chandler Carruthf85d9822015-03-26 08:32:49 +00004769 for (auto &WeakUndeclaredIdentifier : SemaRef.WeakUndeclaredIdentifiers) {
4770 IdentifierInfo *II = WeakUndeclaredIdentifier.first;
4771 WeakInfo &WI = WeakUndeclaredIdentifier.second;
4772 AddIdentifierRef(II, WeakUndeclaredIdentifiers);
4773 AddIdentifierRef(WI.getAlias(), WeakUndeclaredIdentifiers);
4774 AddSourceLocation(WI.getLocation(), WeakUndeclaredIdentifiers);
4775 WeakUndeclaredIdentifiers.push_back(WI.getUsed());
Argyrios Kyrtzidisee1afa32010-08-05 09:48:08 +00004776 }
Kovarththanan Rajaratnama9c81a82010-03-14 07:06:50 +00004777
Douglas Gregor61cac2b2009-04-27 20:06:05 +00004778 // Build a record containing all of the ext_vector declarations.
4779 RecordData ExtVectorDecls;
Douglas Gregorb7098a32011-07-28 00:39:29 +00004780 AddLazyVectorDecls(*this, SemaRef.ExtVectorDecls, ExtVectorDecls);
Douglas Gregor61cac2b2009-04-27 20:06:05 +00004781
Argyrios Kyrtzidisaf2eac22010-07-06 15:37:04 +00004782 // Build a record containing all of the VTable uses information.
4783 RecordData VTableUses;
Argyrios Kyrtzidisedee67f2010-08-03 17:29:52 +00004784 if (!SemaRef.VTableUses.empty()) {
Argyrios Kyrtzidisedee67f2010-08-03 17:29:52 +00004785 for (unsigned I = 0, N = SemaRef.VTableUses.size(); I != N; ++I) {
4786 AddDeclRef(SemaRef.VTableUses[I].first, VTableUses);
4787 AddSourceLocation(SemaRef.VTableUses[I].second, VTableUses);
4788 VTableUses.push_back(SemaRef.VTablesUsed[SemaRef.VTableUses[I].first]);
4789 }
Argyrios Kyrtzidisaf2eac22010-07-06 15:37:04 +00004790 }
4791
Nico Weber72889432014-09-06 01:25:55 +00004792 // Build a record containing all of the UnusedLocalTypedefNameCandidates.
4793 RecordData UnusedLocalTypedefNameCandidates;
4794 for (const TypedefNameDecl *TD : SemaRef.UnusedLocalTypedefNameCandidates)
4795 AddDeclRef(TD, UnusedLocalTypedefNameCandidates);
4796
Argyrios Kyrtzidis7f76d112010-08-05 09:48:16 +00004797 // Build a record containing all of pending implicit instantiations.
Chandler Carruth54080172010-08-25 08:44:16 +00004798 RecordData PendingInstantiations;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00004799 for (const auto &I : SemaRef.PendingInstantiations) {
4800 AddDeclRef(I.first, PendingInstantiations);
4801 AddSourceLocation(I.second, PendingInstantiations);
Argyrios Kyrtzidis7f76d112010-08-05 09:48:16 +00004802 }
4803 assert(SemaRef.PendingLocalImplicitInstantiations.empty() &&
4804 "There are local ones at end of translation unit!");
4805
Argyrios Kyrtzidis2d688102010-08-02 07:14:54 +00004806 // Build a record containing some declaration references.
4807 RecordData SemaDeclRefs;
Richard Smith96269c52016-09-29 22:49:46 +00004808 if (SemaRef.StdNamespace || SemaRef.StdBadAlloc || SemaRef.StdAlignValT) {
Argyrios Kyrtzidis2d688102010-08-02 07:14:54 +00004809 AddDeclRef(SemaRef.getStdNamespace(), SemaDeclRefs);
4810 AddDeclRef(SemaRef.getStdBadAlloc(), SemaDeclRefs);
Richard Smith96269c52016-09-29 22:49:46 +00004811 AddDeclRef(SemaRef.getStdAlignValT(), SemaDeclRefs);
Argyrios Kyrtzidis2d688102010-08-02 07:14:54 +00004812 }
4813
Peter Collingbourne9e2c81f2011-02-09 21:04:32 +00004814 RecordData CUDASpecialDeclRefs;
4815 if (Context.getcudaConfigureCallDecl()) {
4816 AddDeclRef(Context.getcudaConfigureCallDecl(), CUDASpecialDeclRefs);
4817 }
4818
Douglas Gregorc2fa1692011-06-28 16:20:02 +00004819 // Build a record containing all of the known namespaces.
4820 RecordData KnownNamespaces;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00004821 for (const auto &I : SemaRef.KnownNamespaces) {
4822 if (!I.second)
4823 AddDeclRef(I.first, KnownNamespaces);
Douglas Gregorc2fa1692011-06-28 16:20:02 +00004824 }
Douglas Gregor112b9072012-10-18 05:31:06 +00004825
Nick Lewycky9c7eb1d2013-02-01 08:13:20 +00004826 // Build a record of all used, undefined objects that require definitions.
4827 RecordData UndefinedButUsed;
Nick Lewyckyf0f56162013-01-31 03:23:57 +00004828
4829 SmallVector<std::pair<NamedDecl *, SourceLocation>, 16> Undefined;
Nick Lewycky9c7eb1d2013-02-01 08:13:20 +00004830 SemaRef.getUndefinedButUsed(Undefined);
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00004831 for (const auto &I : Undefined) {
4832 AddDeclRef(I.first, UndefinedButUsed);
4833 AddSourceLocation(I.second, UndefinedButUsed);
Nick Lewycky8334af82013-01-26 00:35:08 +00004834 }
4835
Ismail Pazarbasie5768d12015-05-18 19:59:11 +00004836 // Build a record containing all delete-expressions that we would like to
4837 // analyze later in AST.
4838 RecordData DeleteExprsToAnalyze;
4839
Richard Smithf5262c62018-06-28 01:57:04 +00004840 if (!isModule) {
4841 for (const auto &DeleteExprsInfo :
4842 SemaRef.getMismatchingDeleteExpressions()) {
4843 AddDeclRef(DeleteExprsInfo.first, DeleteExprsToAnalyze);
4844 DeleteExprsToAnalyze.push_back(DeleteExprsInfo.second.size());
4845 for (const auto &DeleteLoc : DeleteExprsInfo.second) {
4846 AddSourceLocation(DeleteLoc.first, DeleteExprsToAnalyze);
4847 DeleteExprsToAnalyze.push_back(DeleteLoc.second);
4848 }
Ismail Pazarbasie5768d12015-05-18 19:59:11 +00004849 }
4850 }
4851
Douglas Gregor112b9072012-10-18 05:31:06 +00004852 // Write the control block
Duncan P. N. Exon Smith60fa2882017-03-13 18:45:08 +00004853 WriteControlBlock(PP, Context, isysroot, OutputFile);
Douglas Gregor112b9072012-10-18 05:31:06 +00004854
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00004855 // Write the remaining AST contents.
Sebastian Redl539c5062010-08-18 23:57:32 +00004856 Stream.EnterSubblock(AST_BLOCK_ID, 5);
Douglas Gregor851443c2011-08-12 01:39:19 +00004857
Argyrios Kyrtzidis39605402012-12-13 21:38:23 +00004858 // This is so that older clang versions, before the introduction
4859 // of the control block, can read and reject the newer PCH format.
Mehdi Amini57a41912015-09-10 01:46:39 +00004860 {
4861 RecordData Record = {VERSION_MAJOR};
4862 Stream.EmitRecord(METADATA_OLD_FORMAT, Record);
4863 }
Argyrios Kyrtzidis39605402012-12-13 21:38:23 +00004864
Douglas Gregor851443c2011-08-12 01:39:19 +00004865 // Create a lexical update block containing all of the declarations in the
4866 // translation unit that do not come from other AST files.
4867 const TranslationUnitDecl *TU = Context.getTranslationUnitDecl();
Richard Smith82f8fcd2015-08-06 22:07:25 +00004868 SmallVector<uint32_t, 128> NewGlobalKindDeclPairs;
4869 for (const auto *D : TU->noload_decls()) {
4870 if (!D->isFromASTFile()) {
4871 NewGlobalKindDeclPairs.push_back(D->getKind());
4872 NewGlobalKindDeclPairs.push_back(GetDeclRef(D));
4873 }
Douglas Gregor851443c2011-08-12 01:39:19 +00004874 }
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00004875
David Blaikieb44f0bf2017-01-04 22:36:43 +00004876 auto Abv = std::make_shared<BitCodeAbbrev>();
Douglas Gregor851443c2011-08-12 01:39:19 +00004877 Abv->Add(llvm::BitCodeAbbrevOp(TU_UPDATE_LEXICAL));
4878 Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::Blob));
David Blaikieb44f0bf2017-01-04 22:36:43 +00004879 unsigned TuUpdateLexicalAbbrev = Stream.EmitAbbrev(std::move(Abv));
Mehdi Amini57a41912015-09-10 01:46:39 +00004880 {
4881 RecordData::value_type Record[] = {TU_UPDATE_LEXICAL};
4882 Stream.EmitRecordWithBlob(TuUpdateLexicalAbbrev, Record,
4883 bytes(NewGlobalKindDeclPairs));
4884 }
4885
Douglas Gregor851443c2011-08-12 01:39:19 +00004886 // And a visible updates block for the translation unit.
David Blaikieb44f0bf2017-01-04 22:36:43 +00004887 Abv = std::make_shared<BitCodeAbbrev>();
Douglas Gregor851443c2011-08-12 01:39:19 +00004888 Abv->Add(llvm::BitCodeAbbrevOp(UPDATE_VISIBLE));
4889 Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::VBR, 6));
Douglas Gregor851443c2011-08-12 01:39:19 +00004890 Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::Blob));
David Blaikieb44f0bf2017-01-04 22:36:43 +00004891 UpdateVisibleAbbrev = Stream.EmitAbbrev(std::move(Abv));
Douglas Gregor851443c2011-08-12 01:39:19 +00004892 WriteDeclContextVisibleUpdate(TU);
Richard Smithf19e1272015-03-07 00:04:49 +00004893
4894 // If we have any extern "C" names, write out a visible update for them.
4895 if (Context.ExternCContext)
4896 WriteDeclContextVisibleUpdate(Context.ExternCContext);
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00004897
Douglas Gregor851443c2011-08-12 01:39:19 +00004898 // If the translation unit has an anonymous namespace, and we don't already
4899 // have an update block for it, write it as an update block.
Richard Smith6ef42932014-03-20 21:02:00 +00004900 // FIXME: Why do we not do this if there's already an update block?
Douglas Gregor851443c2011-08-12 01:39:19 +00004901 if (NamespaceDecl *NS = TU->getAnonymousNamespace()) {
4902 ASTWriter::UpdateRecord &Record = DeclUpdates[TU];
Richard Smith6ef42932014-03-20 21:02:00 +00004903 if (Record.empty())
Aaron Ballman4f45b712014-03-21 15:22:56 +00004904 Record.push_back(DeclUpdate(UPD_CXX_ADDED_ANONYMOUS_NAMESPACE, NS));
Douglas Gregor851443c2011-08-12 01:39:19 +00004905 }
Argyrios Kyrtzidis442dd802012-07-02 19:19:01 +00004906
Richard Smith5652c0f2014-03-21 01:48:23 +00004907 // Add update records for all mangling numbers and static local numbers.
4908 // These aren't really update records, but this is a convenient way of
4909 // tagging this rare extra data onto the declarations.
4910 for (const auto &Number : Context.MangleNumbers)
4911 if (!Number.first->isFromASTFile())
Aaron Ballman4f45b712014-03-21 15:22:56 +00004912 DeclUpdates[Number.first].push_back(DeclUpdate(UPD_MANGLING_NUMBER,
4913 Number.second));
Richard Smith5652c0f2014-03-21 01:48:23 +00004914 for (const auto &Number : Context.StaticLocalNumbers)
4915 if (!Number.first->isFromASTFile())
Aaron Ballman4f45b712014-03-21 15:22:56 +00004916 DeclUpdates[Number.first].push_back(DeclUpdate(UPD_STATIC_LOCAL_NUMBER,
4917 Number.second));
Richard Smith5652c0f2014-03-21 01:48:23 +00004918
Argyrios Kyrtzidis442dd802012-07-02 19:19:01 +00004919 // Make sure visible decls, added to DeclContexts previously loaded from
Richard Smithc26d9742016-10-06 20:30:51 +00004920 // an AST file, are registered for serialization. Likewise for template
4921 // specializations added to imported templates.
4922 for (const auto *I : DeclsToEmitEvenIfUnreferenced) {
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00004923 GetDeclRef(I);
Argyrios Kyrtzidis442dd802012-07-02 19:19:01 +00004924 }
4925
Argyrios Kyrtzidisacfbbd72013-08-07 21:17:33 +00004926 // Make sure all decls associated with an identifier are registered for
Richard Smith79bf9202015-08-24 03:33:22 +00004927 // serialization, if we're storing decls with identifiers.
4928 if (!WritingModule || !getLangOpts().CPlusPlus) {
4929 llvm::SmallVector<const IdentifierInfo*, 256> IIs;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00004930 for (const auto &ID : PP.getIdentifierTable()) {
4931 const IdentifierInfo *II = ID.second;
Richard Smith79bf9202015-08-24 03:33:22 +00004932 if (!Chain || !II->isFromAST() || II->hasChangedSinceDeserialization())
4933 IIs.push_back(II);
4934 }
4935 // Sort the identifiers to visit based on their name.
Benjamin Kramercd2bae32019-08-22 17:32:16 +00004936 llvm::sort(IIs, llvm::deref<std::less<>>());
Richard Smith79bf9202015-08-24 03:33:22 +00004937 for (const IdentifierInfo *II : IIs) {
4938 for (IdentifierResolver::iterator D = SemaRef.IdResolver.begin(II),
4939 DEnd = SemaRef.IdResolver.end();
4940 D != DEnd; ++D) {
4941 GetDeclRef(*D);
4942 }
Argyrios Kyrtzidisacfbbd72013-08-07 21:17:33 +00004943 }
4944 }
4945
Manman Rena0f31a02016-04-29 19:04:05 +00004946 // For method pool in the module, if it contains an entry for a selector,
4947 // the entry should be complete, containing everything introduced by that
4948 // module and all modules it imports. It's possible that the entry is out of
4949 // date, so we need to pull in the new content here.
4950
4951 // It's possible that updateOutOfDateSelector can update SelectorIDs. To be
4952 // safe, we copy all selectors out.
4953 llvm::SmallVector<Selector, 256> AllSelectors;
4954 for (auto &SelectorAndID : SelectorIDs)
4955 AllSelectors.push_back(SelectorAndID.first);
4956 for (auto &Selector : AllSelectors)
4957 SemaRef.updateOutOfDateSelector(Selector);
4958
Douglas Gregor5204bde2011-08-02 16:26:37 +00004959 // Form the record of special types.
4960 RecordData SpecialTypes;
Douglas Gregor5204bde2011-08-02 16:26:37 +00004961 AddTypeRef(Context.getRawCFConstantStringType(), SpecialTypes);
Douglas Gregor5204bde2011-08-02 16:26:37 +00004962 AddTypeRef(Context.getFILEType(), SpecialTypes);
4963 AddTypeRef(Context.getjmp_bufType(), SpecialTypes);
4964 AddTypeRef(Context.getsigjmp_bufType(), SpecialTypes);
4965 AddTypeRef(Context.ObjCIdRedefinitionType, SpecialTypes);
4966 AddTypeRef(Context.ObjCClassRedefinitionType, SpecialTypes);
Douglas Gregor5204bde2011-08-02 16:26:37 +00004967 AddTypeRef(Context.ObjCSelRedefinitionType, SpecialTypes);
Rafael Espindola6cfa82b2011-11-13 21:51:09 +00004968 AddTypeRef(Context.getucontext_tType(), SpecialTypes);
Douglas Gregora28bcdd2011-12-01 02:07:58 +00004969
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00004970 if (Chain) {
4971 // Write the mapping information describing our module dependencies and how
4972 // each of those modules were mapped into our own offset/ID space, so that
4973 // the reader can build the appropriate mapping to its own offset/ID space.
4974 // The map consists solely of a blob with the following format:
Boris Kolpackovd30446f2017-08-31 06:26:43 +00004975 // *(module-kind:i8
4976 // module-name-len:i16 module-name:len*i8
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00004977 // source-location-offset:i32
4978 // identifier-id:i32
4979 // preprocessed-entity-id:i32
4980 // macro-definition-id:i32
Douglas Gregor253eefe2011-12-01 00:59:36 +00004981 // submodule-id:i32
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00004982 // selector-id:i32
4983 // declaration-id:i32
4984 // c++-base-specifiers-id:i32
4985 // type-id:i32)
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00004986 //
Boris Kolpackovd30446f2017-08-31 06:26:43 +00004987 // module-kind is the ModuleKind enum value. If it is MK_PrebuiltModule or
4988 // MK_ExplicitModule, then the module-name is the module name. Otherwise,
4989 // it is the module file name.
David Blaikieb44f0bf2017-01-04 22:36:43 +00004990 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00004991 Abbrev->Add(BitCodeAbbrevOp(MODULE_OFFSET_MAP));
4992 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
David Blaikieb44f0bf2017-01-04 22:36:43 +00004993 unsigned ModuleOffsetMapAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00004994 SmallString<2048> Buffer;
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00004995 {
4996 llvm::raw_svector_ostream Out(Buffer);
Duncan P. N. Exon Smith96a06e02017-01-28 22:15:22 +00004997 for (ModuleFile &M : Chain->ModuleMgr) {
Justin Bognere1c147c2014-03-28 22:03:19 +00004998 using namespace llvm::support;
Eugene Zelenkob7d89102017-11-11 00:08:50 +00004999
Peter Collingbournee3f65292018-05-18 19:46:24 +00005000 endian::Writer LE(Out, little);
Boris Kolpackovd30446f2017-08-31 06:26:43 +00005001 LE.write<uint8_t>(static_cast<uint8_t>(M.Kind));
5002 StringRef Name =
5003 M.Kind == MK_PrebuiltModule || M.Kind == MK_ExplicitModule
5004 ? M.ModuleName
5005 : M.FileName;
5006 LE.write<uint16_t>(Name.size());
5007 Out.write(Name.data(), Name.size());
Ben Langmuirfe971d92014-08-16 04:54:18 +00005008
Ben Langmuir785180e2014-10-20 16:27:30 +00005009 // Note: if a base ID was uint max, it would not be possible to load
5010 // another module after it or have more than one entity inside it.
5011 uint32_t None = std::numeric_limits<uint32_t>::max();
5012
5013 auto writeBaseIDOrNone = [&](uint32_t BaseID, bool ShouldWrite) {
5014 assert(BaseID < std::numeric_limits<uint32_t>::max() && "base id too high");
5015 if (ShouldWrite)
5016 LE.write<uint32_t>(BaseID);
5017 else
5018 LE.write<uint32_t>(None);
5019 };
5020
Ben Langmuirfe971d92014-08-16 04:54:18 +00005021 // These values should be unique within a chain, since they will be read
5022 // as keys into ContinuousRangeMaps.
Duncan P. N. Exon Smith96a06e02017-01-28 22:15:22 +00005023 writeBaseIDOrNone(M.SLocEntryBaseOffset, M.LocalNumSLocEntries);
5024 writeBaseIDOrNone(M.BaseIdentifierID, M.LocalNumIdentifiers);
5025 writeBaseIDOrNone(M.BaseMacroID, M.LocalNumMacros);
5026 writeBaseIDOrNone(M.BasePreprocessedEntityID,
5027 M.NumPreprocessedEntities);
5028 writeBaseIDOrNone(M.BaseSubmoduleID, M.LocalNumSubmodules);
5029 writeBaseIDOrNone(M.BaseSelectorID, M.LocalNumSelectors);
5030 writeBaseIDOrNone(M.BaseDeclID, M.LocalNumDecls);
5031 writeBaseIDOrNone(M.BaseTypeIndex, M.LocalNumTypes);
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005032 }
5033 }
Mehdi Amini57a41912015-09-10 01:46:39 +00005034 RecordData::value_type Record[] = {MODULE_OFFSET_MAP};
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005035 Stream.EmitRecordWithBlob(ModuleOffsetMapAbbrev, Record,
5036 Buffer.data(), Buffer.size());
5037 }
Richard Smithb9eab6d2014-03-20 19:44:17 +00005038
Richard Smithb9eab6d2014-03-20 19:44:17 +00005039 RecordData DeclUpdatesOffsetsRecord;
5040
Richard Smith59442b42014-03-20 20:07:19 +00005041 // Keep writing types, declarations, and declaration update records
5042 // until we've emitted all of them.
Richard Smith01b2cb42014-07-26 06:37:51 +00005043 Stream.EnterSubblock(DECLTYPES_BLOCK_ID, /*bits for abbreviations*/5);
5044 WriteTypeAbbrevs();
5045 WriteDeclAbbrevs();
Richard Smith59442b42014-03-20 20:07:19 +00005046 do {
5047 WriteDeclUpdatesBlocks(DeclUpdatesOffsetsRecord);
5048 while (!DeclTypesToEmit.empty()) {
5049 DeclOrType DOT = DeclTypesToEmit.front();
5050 DeclTypesToEmit.pop();
5051 if (DOT.isType())
5052 WriteType(DOT.getType());
5053 else
5054 WriteDecl(Context, DOT.getDecl());
5055 }
5056 } while (!DeclUpdates.empty());
Richard Smithb9eab6d2014-03-20 19:44:17 +00005057 Stream.ExitBlock();
5058
Richard Smithb9eab6d2014-03-20 19:44:17 +00005059 DoneWritingDeclsAndTypes = true;
5060
5061 // These things can only be done once we've written out decls and types.
5062 WriteTypeDeclOffsets();
Richard Smith5652c0f2014-03-21 01:48:23 +00005063 if (!DeclUpdatesOffsetsRecord.empty())
5064 Stream.EmitRecord(DECL_UPDATE_OFFSETS, DeclUpdatesOffsetsRecord);
Richard Smithb9eab6d2014-03-20 19:44:17 +00005065 WriteFileDeclIDsMap();
Richard Smith7ed1bc92014-12-05 22:42:13 +00005066 WriteSourceManagerBlock(Context.getSourceManager(), PP);
Richard Smithb9eab6d2014-03-20 19:44:17 +00005067 WriteComments();
Argyrios Kyrtzidisffb35582013-03-14 04:44:56 +00005068 WritePreprocessor(PP, isModule);
Richard Smith7ed1bc92014-12-05 22:42:13 +00005069 WriteHeaderSearch(PP.getHeaderSearchInfo());
Sebastian Redla19a67f2010-08-03 21:58:15 +00005070 WriteSelectors(SemaRef);
Fariborz Jahanianc51609a2010-07-23 19:11:11 +00005071 WriteReferencedSelectorsPool(SemaRef);
Richard Smith9c254182015-07-19 21:41:12 +00005072 WriteLateParsedTemplates(SemaRef);
Argyrios Kyrtzidisffb35582013-03-14 04:44:56 +00005073 WriteIdentifierTable(PP, SemaRef.IdResolver, isModule);
Peter Collingbourne5df20e02011-02-15 19:46:30 +00005074 WriteFPPragmaOptions(SemaRef.getFPOptions());
5075 WriteOpenCLExtensions(SemaRef);
Yaxun Liu5b746652016-12-18 05:18:55 +00005076 WriteOpenCLExtensionTypes(SemaRef);
Justin Lebar67a78a62016-10-08 22:15:58 +00005077 WriteCUDAPragmas(SemaRef);
Douglas Gregor652d82a2009-04-18 05:55:16 +00005078
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00005079 // If we're emitting a module, write out the submodule information.
Douglas Gregora89c5ac2011-12-06 01:10:29 +00005080 if (WritingModule)
5081 WriteSubmodules(WritingModule);
5082
Andrew Savonichev52d674d2018-10-29 11:14:01 +00005083 // We need to have information about submodules to correctly deserialize
5084 // decls from OpenCLExtensionDecls block
5085 WriteOpenCLExtensionDecls(SemaRef);
5086
Douglas Gregor5204bde2011-08-02 16:26:37 +00005087 Stream.EmitRecord(SPECIAL_TYPES, SpecialTypes);
5088
Douglas Gregord4df8652009-04-22 22:02:47 +00005089 // Write the record containing external, unnamed definitions.
Ben Langmuir332aafe2014-01-31 01:06:56 +00005090 if (!EagerlyDeserializedDecls.empty())
5091 Stream.EmitRecord(EAGERLY_DESERIALIZED_DECLS, EagerlyDeserializedDecls);
Douglas Gregord4df8652009-04-22 22:02:47 +00005092
David Blaikief63556d2017-04-12 20:58:33 +00005093 if (!ModularCodegenDecls.empty())
David Blaikie9ffe5a32017-01-30 05:00:26 +00005094 Stream.EmitRecord(MODULAR_CODEGEN_DECLS, ModularCodegenDecls);
5095
Douglas Gregord4df8652009-04-22 22:02:47 +00005096 // Write the record containing tentative definitions.
5097 if (!TentativeDefinitions.empty())
Sebastian Redl539c5062010-08-18 23:57:32 +00005098 Stream.EmitRecord(TENTATIVE_DEFINITIONS, TentativeDefinitions);
Douglas Gregoracfc76c2009-04-22 22:18:58 +00005099
Argyrios Kyrtzidis35672e72010-08-13 18:42:17 +00005100 // Write the record containing unused file scoped decls.
5101 if (!UnusedFileScopedDecls.empty())
Sebastian Redl539c5062010-08-18 23:57:32 +00005102 Stream.EmitRecord(UNUSED_FILESCOPED_DECLS, UnusedFileScopedDecls);
Kovarththanan Rajaratnama9c81a82010-03-14 07:06:50 +00005103
Argyrios Kyrtzidisee1afa32010-08-05 09:48:08 +00005104 // Write the record containing weak undeclared identifiers.
5105 if (!WeakUndeclaredIdentifiers.empty())
Sebastian Redl539c5062010-08-18 23:57:32 +00005106 Stream.EmitRecord(WEAK_UNDECLARED_IDENTIFIERS,
Argyrios Kyrtzidisee1afa32010-08-05 09:48:08 +00005107 WeakUndeclaredIdentifiers);
5108
Douglas Gregor61cac2b2009-04-27 20:06:05 +00005109 // Write the record containing ext_vector type names.
5110 if (!ExtVectorDecls.empty())
Sebastian Redl539c5062010-08-18 23:57:32 +00005111 Stream.EmitRecord(EXT_VECTOR_DECLS, ExtVectorDecls);
Mike Stump11289f42009-09-09 15:08:12 +00005112
Argyrios Kyrtzidisaf2eac22010-07-06 15:37:04 +00005113 // Write the record containing VTable uses information.
5114 if (!VTableUses.empty())
Sebastian Redl539c5062010-08-18 23:57:32 +00005115 Stream.EmitRecord(VTABLE_USES, VTableUses);
Argyrios Kyrtzidisaf2eac22010-07-06 15:37:04 +00005116
Nico Weber72889432014-09-06 01:25:55 +00005117 // Write the record containing potentially unused local typedefs.
5118 if (!UnusedLocalTypedefNameCandidates.empty())
5119 Stream.EmitRecord(UNUSED_LOCAL_TYPEDEF_NAME_CANDIDATES,
5120 UnusedLocalTypedefNameCandidates);
5121
Argyrios Kyrtzidis7f76d112010-08-05 09:48:16 +00005122 // Write the record containing pending implicit instantiations.
Chandler Carruth54080172010-08-25 08:44:16 +00005123 if (!PendingInstantiations.empty())
5124 Stream.EmitRecord(PENDING_IMPLICIT_INSTANTIATIONS, PendingInstantiations);
Argyrios Kyrtzidis7f76d112010-08-05 09:48:16 +00005125
Argyrios Kyrtzidis2d688102010-08-02 07:14:54 +00005126 // Write the record containing declaration references of Sema.
5127 if (!SemaDeclRefs.empty())
Sebastian Redl539c5062010-08-18 23:57:32 +00005128 Stream.EmitRecord(SEMA_DECL_REFS, SemaDeclRefs);
Argyrios Kyrtzidis2d688102010-08-02 07:14:54 +00005129
Peter Collingbourne9e2c81f2011-02-09 21:04:32 +00005130 // Write the record containing CUDA-specific declaration references.
5131 if (!CUDASpecialDeclRefs.empty())
5132 Stream.EmitRecord(CUDA_SPECIAL_DECL_REFS, CUDASpecialDeclRefs);
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00005133
Alexis Hunt27a761d2011-05-04 23:29:54 +00005134 // Write the delegating constructors.
5135 if (!DelegatingCtorDecls.empty())
5136 Stream.EmitRecord(DELEGATING_CTORS, DelegatingCtorDecls);
Peter Collingbourne9e2c81f2011-02-09 21:04:32 +00005137
Douglas Gregorc2fa1692011-06-28 16:20:02 +00005138 // Write the known namespaces.
5139 if (!KnownNamespaces.empty())
5140 Stream.EmitRecord(KNOWN_NAMESPACES, KnownNamespaces);
Nick Lewycky8334af82013-01-26 00:35:08 +00005141
Nick Lewycky9c7eb1d2013-02-01 08:13:20 +00005142 // Write the undefined internal functions and variables, and inline functions.
5143 if (!UndefinedButUsed.empty())
5144 Stream.EmitRecord(UNDEFINED_BUT_USED, UndefinedButUsed);
Ismail Pazarbasie5768d12015-05-18 19:59:11 +00005145
5146 if (!DeleteExprsToAnalyze.empty())
5147 Stream.EmitRecord(DELETE_EXPRS_TO_ANALYZE, DeleteExprsToAnalyze);
5148
Douglas Gregor851443c2011-08-12 01:39:19 +00005149 // Write the visible updates to DeclContexts.
Richard Smithcd45dbc2014-04-19 03:48:30 +00005150 for (auto *DC : UpdatedDeclContexts)
5151 WriteDeclContextVisibleUpdate(DC);
Douglas Gregor851443c2011-08-12 01:39:19 +00005152
Douglas Gregor959bb062011-12-03 01:15:29 +00005153 if (!WritingModule) {
5154 // Write the submodules that were imported, if any.
Aaron Ballman4f45b712014-03-21 15:22:56 +00005155 struct ModuleInfo {
5156 uint64_t ID;
5157 Module *M;
5158 ModuleInfo(uint64_t ID, Module *M) : ID(ID), M(M) {}
5159 };
Richard Smith56be7542014-03-21 00:33:59 +00005160 llvm::SmallVector<ModuleInfo, 64> Imports;
Aaron Ballmanbbc31212014-03-14 20:59:21 +00005161 for (const auto *I : Context.local_imports()) {
Douglas Gregor959bb062011-12-03 01:15:29 +00005162 assert(SubmoduleIDs.find(I->getImportedModule()) != SubmoduleIDs.end());
Aaron Ballman4f45b712014-03-21 15:22:56 +00005163 Imports.push_back(ModuleInfo(SubmoduleIDs[I->getImportedModule()],
5164 I->getImportedModule()));
Douglas Gregor959bb062011-12-03 01:15:29 +00005165 }
Richard Smith56be7542014-03-21 00:33:59 +00005166
5167 if (!Imports.empty()) {
5168 auto Cmp = [](const ModuleInfo &A, const ModuleInfo &B) {
5169 return A.ID < B.ID;
5170 };
Ben Langmuir5f95c8f2014-09-08 20:36:26 +00005171 auto Eq = [](const ModuleInfo &A, const ModuleInfo &B) {
5172 return A.ID == B.ID;
5173 };
Richard Smith56be7542014-03-21 00:33:59 +00005174
5175 // Sort and deduplicate module IDs.
Fangrui Song55fab262018-09-26 22:16:28 +00005176 llvm::sort(Imports, Cmp);
Ben Langmuir5f95c8f2014-09-08 20:36:26 +00005177 Imports.erase(std::unique(Imports.begin(), Imports.end(), Eq),
Richard Smith56be7542014-03-21 00:33:59 +00005178 Imports.end());
5179
5180 RecordData ImportedModules;
5181 for (const auto &Import : Imports) {
5182 ImportedModules.push_back(Import.ID);
5183 // FIXME: If the module has macros imported then later has declarations
5184 // imported, this location won't be the right one as a location for the
5185 // declaration imports.
Richard Smith10434f32015-05-02 02:08:26 +00005186 AddSourceLocation(PP.getModuleImportLoc(Import.M), ImportedModules);
Richard Smith56be7542014-03-21 00:33:59 +00005187 }
5188
Douglas Gregor959bb062011-12-03 01:15:29 +00005189 Stream.EmitRecord(IMPORTED_MODULES, ImportedModules);
5190 }
Douglas Gregor0a839132011-12-03 00:59:55 +00005191 }
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00005192
Douglas Gregor404cdde2012-01-27 01:47:08 +00005193 WriteObjCCategories();
Nico Weber779355f2016-03-02 23:22:00 +00005194 if(!WritingModule) {
Dario Domizioli13a0a382014-05-23 12:13:25 +00005195 WriteOptimizePragmaOptions(SemaRef);
Nico Weber779355f2016-03-02 23:22:00 +00005196 WriteMSStructPragmaOptions(SemaRef);
Nico Weber42932312016-03-03 00:17:35 +00005197 WriteMSPointersToMembersPragmaOptions(SemaRef);
Nico Weber779355f2016-03-02 23:22:00 +00005198 }
Alex Lorenz7d7e1e02017-03-31 15:36:21 +00005199 WritePackPragmaOptions(SemaRef);
Richard Smithe40f2ba2013-08-07 21:41:30 +00005200
Douglas Gregor08f01292009-04-17 22:13:46 +00005201 // Some simple statistics
Mehdi Amini57a41912015-09-10 01:46:39 +00005202 RecordData::value_type Record[] = {
5203 NumStatements, NumMacros, NumLexicalDeclContexts, NumVisibleDeclContexts};
Sebastian Redl539c5062010-08-18 23:57:32 +00005204 Stream.EmitRecord(STATISTICS, Record);
Douglas Gregor8f45df52009-04-16 22:23:12 +00005205 Stream.ExitBlock();
Adrian Prantladbd2b12015-09-22 23:26:31 +00005206
Douglas Gregor6623e1f2015-11-03 18:33:07 +00005207 // Write the module file extension blocks.
5208 for (const auto &ExtWriter : ModuleFileExtensionWriters)
Douglas Gregor8f64ca12015-12-08 22:43:32 +00005209 WriteModuleFileExtension(SemaRef, *ExtWriter);
Douglas Gregor6623e1f2015-11-03 18:33:07 +00005210
Duncan P. N. Exon Smith60fa2882017-03-13 18:45:08 +00005211 return writeUnhashedControlBlock(PP, Context);
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005212}
5213
Richard Smithb9eab6d2014-03-20 19:44:17 +00005214void ASTWriter::WriteDeclUpdatesBlocks(RecordDataImpl &OffsetsRecord) {
Argyrios Kyrtzidis65ad5692010-10-24 17:26:36 +00005215 if (DeclUpdates.empty())
5216 return;
5217
Richard Smith59442b42014-03-20 20:07:19 +00005218 DeclUpdateMap LocalUpdates;
5219 LocalUpdates.swap(DeclUpdates);
5220
Richard Smith6ef42932014-03-20 21:02:00 +00005221 for (auto &DeclUpdate : LocalUpdates) {
5222 const Decl *D = DeclUpdate.first;
Argyrios Kyrtzidis3ba70b82010-10-24 17:26:46 +00005223
Richard Smithd28ac5b2014-03-22 23:33:22 +00005224 bool HasUpdatedBody = false;
Richard Smith69c82bf2016-04-01 22:52:03 +00005225 RecordData RecordData;
5226 ASTRecordWriter Record(*this, RecordData);
Richard Smith6ef42932014-03-20 21:02:00 +00005227 for (auto &Update : DeclUpdate.second) {
5228 DeclUpdateKind Kind = (DeclUpdateKind)Update.getKind();
5229
Richard Smith69c82bf2016-04-01 22:52:03 +00005230 // An updated body is emitted last, so that the reader doesn't need
5231 // to skip over the lazy body to reach statements for other records.
5232 if (Kind == UPD_CXX_ADDED_FUNCTION_DEFINITION)
5233 HasUpdatedBody = true;
5234 else
5235 Record.push_back(Kind);
5236
Richard Smith6ef42932014-03-20 21:02:00 +00005237 switch (Kind) {
5238 case UPD_CXX_ADDED_IMPLICIT_MEMBER:
5239 case UPD_CXX_ADDED_TEMPLATE_SPECIALIZATION:
5240 case UPD_CXX_ADDED_ANONYMOUS_NAMESPACE:
Richard Smithcd45dbc2014-04-19 03:48:30 +00005241 assert(Update.getDecl() && "no decl to add?");
Richard Smith6ef42932014-03-20 21:02:00 +00005242 Record.push_back(GetDeclRef(Update.getDecl()));
5243 break;
5244
Richard Smith4d235792014-08-07 18:53:08 +00005245 case UPD_CXX_ADDED_FUNCTION_DEFINITION:
Richard Smithd28ac5b2014-03-22 23:33:22 +00005246 break;
5247
Richard Smith891fc7f2017-12-05 01:31:47 +00005248 case UPD_CXX_POINT_OF_INSTANTIATION:
5249 // FIXME: Do we need to also save the template specialization kind here?
Richard Smith69c82bf2016-04-01 22:52:03 +00005250 Record.AddSourceLocation(Update.getLoc());
Richard Smith891fc7f2017-12-05 01:31:47 +00005251 break;
5252
5253 case UPD_CXX_ADDED_VAR_DEFINITION: {
5254 const VarDecl *VD = cast<VarDecl>(D);
Richard Smithf5017592017-11-02 01:06:00 +00005255 Record.push_back(VD->isInline());
5256 Record.push_back(VD->isInlineSpecified());
Richard Smith05a21352017-06-22 22:18:46 +00005257 if (VD->getInit()) {
5258 Record.push_back(!VD->isInitKnownICE() ? 1
5259 : (VD->isInitICE() ? 3 : 2));
5260 Record.AddStmt(const_cast<Expr*>(VD->getInit()));
5261 } else {
5262 Record.push_back(0);
5263 }
Richard Smith4d235792014-08-07 18:53:08 +00005264 break;
Richard Smith05a21352017-06-22 22:18:46 +00005265 }
Richard Smith4d235792014-08-07 18:53:08 +00005266
John McCall32791cc2016-01-06 22:34:54 +00005267 case UPD_CXX_INSTANTIATED_DEFAULT_ARGUMENT:
Richard Smith290d8012016-04-06 17:06:00 +00005268 Record.AddStmt(const_cast<Expr *>(
5269 cast<ParmVarDecl>(Update.getDecl())->getDefaultArg()));
John McCall32791cc2016-01-06 22:34:54 +00005270 break;
5271
Richard Smith4b054b22016-08-24 21:25:37 +00005272 case UPD_CXX_INSTANTIATED_DEFAULT_MEMBER_INITIALIZER:
5273 Record.AddStmt(
5274 cast<FieldDecl>(Update.getDecl())->getInClassInitializer());
5275 break;
5276
Richard Smithcd45dbc2014-04-19 03:48:30 +00005277 case UPD_CXX_INSTANTIATED_CLASS_DEFINITION: {
5278 auto *RD = cast<CXXRecordDecl>(D);
Chandler Carruth8a3d24d2015-03-26 04:27:10 +00005279 UpdatedDeclContexts.insert(RD->getPrimaryContext());
Akira Hatanakafcbe17c2018-03-28 21:13:14 +00005280 Record.push_back(RD->isParamDestroyedInCallee());
Akira Hatanakae6313ac2018-04-09 22:48:22 +00005281 Record.push_back(RD->getArgPassingRestrictions());
Richard Smith69c82bf2016-04-01 22:52:03 +00005282 Record.AddCXXDefinitionData(RD);
Richard Smith72e50fe2016-04-14 00:50:18 +00005283 Record.AddOffset(WriteDeclContextLexicalBlock(
Richard Smithcd45dbc2014-04-19 03:48:30 +00005284 *Context, const_cast<CXXRecordDecl *>(RD)));
5285
5286 // This state is sometimes updated by template instantiation, when we
5287 // switch from the specialization referring to the template declaration
5288 // to it referring to the template definition.
5289 if (auto *MSInfo = RD->getMemberSpecializationInfo()) {
5290 Record.push_back(MSInfo->getTemplateSpecializationKind());
Richard Smith69c82bf2016-04-01 22:52:03 +00005291 Record.AddSourceLocation(MSInfo->getPointOfInstantiation());
Richard Smithcd45dbc2014-04-19 03:48:30 +00005292 } else {
5293 auto *Spec = cast<ClassTemplateSpecializationDecl>(RD);
5294 Record.push_back(Spec->getTemplateSpecializationKind());
Richard Smith69c82bf2016-04-01 22:52:03 +00005295 Record.AddSourceLocation(Spec->getPointOfInstantiation());
Richard Smithdf352052014-05-22 20:59:29 +00005296
5297 // The instantiation might have been resolved to a partial
5298 // specialization. If so, record which one.
5299 auto From = Spec->getInstantiatedFrom();
5300 if (auto PartialSpec =
5301 From.dyn_cast<ClassTemplatePartialSpecializationDecl*>()) {
5302 Record.push_back(true);
Richard Smith69c82bf2016-04-01 22:52:03 +00005303 Record.AddDeclRef(PartialSpec);
5304 Record.AddTemplateArgumentList(
5305 &Spec->getTemplateInstantiationArgs());
Richard Smithdf352052014-05-22 20:59:29 +00005306 } else {
5307 Record.push_back(false);
5308 }
Richard Smithcd45dbc2014-04-19 03:48:30 +00005309 }
5310 Record.push_back(RD->getTagKind());
Richard Smith69c82bf2016-04-01 22:52:03 +00005311 Record.AddSourceLocation(RD->getLocation());
Stephen Kellyf2ceec42018-08-09 21:08:08 +00005312 Record.AddSourceLocation(RD->getBeginLoc());
Argyrios Kyrtzidisd798c052016-07-15 18:11:33 +00005313 Record.AddSourceRange(RD->getBraceRange());
Richard Smithcd45dbc2014-04-19 03:48:30 +00005314
5315 // Instantiation may change attributes; write them all out afresh.
5316 Record.push_back(D->hasAttrs());
Richard Smith69c82bf2016-04-01 22:52:03 +00005317 if (D->hasAttrs())
5318 Record.AddAttributes(D->getAttrs());
Richard Smithcd45dbc2014-04-19 03:48:30 +00005319
5320 // FIXME: Ensure we don't get here for explicit instantiations.
5321 break;
5322 }
5323
Richard Smithf8134002015-03-10 01:41:22 +00005324 case UPD_CXX_RESOLVED_DTOR_DELETE:
Richard Smith69c82bf2016-04-01 22:52:03 +00005325 Record.AddDeclRef(Update.getDecl());
Richard Smith5b349582017-10-13 01:55:36 +00005326 Record.AddStmt(cast<CXXDestructorDecl>(D)->getOperatorDeleteThisArg());
Richard Smithf8134002015-03-10 01:41:22 +00005327 break;
5328
Richard Smith564417a2014-03-20 21:47:22 +00005329 case UPD_CXX_RESOLVED_EXCEPTION_SPEC:
5330 addExceptionSpec(
Richard Smith564417a2014-03-20 21:47:22 +00005331 cast<FunctionDecl>(D)->getType()->castAs<FunctionProtoType>(),
5332 Record);
5333 break;
5334
Richard Smith6ef42932014-03-20 21:02:00 +00005335 case UPD_CXX_DEDUCED_RETURN_TYPE:
5336 Record.push_back(GetOrCreateTypeID(Update.getType()));
5337 break;
5338
5339 case UPD_DECL_MARKED_USED:
5340 break;
Richard Smith5652c0f2014-03-21 01:48:23 +00005341
5342 case UPD_MANGLING_NUMBER:
5343 case UPD_STATIC_LOCAL_NUMBER:
5344 Record.push_back(Update.getNumber());
5345 break;
Richard Smith65ebb4a2015-03-26 04:09:53 +00005346
Alexey Bataev97720002014-11-11 04:05:39 +00005347 case UPD_DECL_MARKED_OPENMP_THREADPRIVATE:
Richard Smith69c82bf2016-04-01 22:52:03 +00005348 Record.AddSourceRange(
5349 D->getAttr<OMPThreadPrivateDeclAttr>()->getRange());
Alexey Bataev97720002014-11-11 04:05:39 +00005350 break;
Richard Smith65ebb4a2015-03-26 04:09:53 +00005351
Alexey Bataev27ef9512019-03-20 20:14:22 +00005352 case UPD_DECL_MARKED_OPENMP_ALLOCATE: {
5353 auto *A = D->getAttr<OMPAllocateDeclAttr>();
5354 Record.push_back(A->getAllocatorType());
5355 Record.AddStmt(A->getAllocator());
5356 Record.AddSourceRange(A->getRange());
Alexey Bataev25ed0c02019-03-07 17:54:44 +00005357 break;
Alexey Bataev27ef9512019-03-20 20:14:22 +00005358 }
Alexey Bataev25ed0c02019-03-07 17:54:44 +00005359
Dmitry Polukhin0b0da292016-04-06 11:38:59 +00005360 case UPD_DECL_MARKED_OPENMP_DECLARETARGET:
Alexey Bataevd01b7492018-08-15 19:45:12 +00005361 Record.push_back(D->getAttr<OMPDeclareTargetDeclAttr>()->getMapType());
Dmitry Polukhin0b0da292016-04-06 11:38:59 +00005362 Record.AddSourceRange(
5363 D->getAttr<OMPDeclareTargetDeclAttr>()->getRange());
5364 break;
5365
Richard Smith65ebb4a2015-03-26 04:09:53 +00005366 case UPD_DECL_EXPORTED:
Richard Smith4caa4492015-05-15 02:34:32 +00005367 Record.push_back(getSubmoduleID(Update.getModule()));
Richard Smith65ebb4a2015-03-26 04:09:53 +00005368 break;
Alex Denisovfde64952015-06-26 05:28:36 +00005369
5370 case UPD_ADDED_ATTR_TO_RECORD:
Richard Smith69c82bf2016-04-01 22:52:03 +00005371 Record.AddAttributes(llvm::makeArrayRef(Update.getAttr()));
Alex Denisovfde64952015-06-26 05:28:36 +00005372 break;
Richard Smith6ef42932014-03-20 21:02:00 +00005373 }
5374 }
5375
Richard Smithd28ac5b2014-03-22 23:33:22 +00005376 if (HasUpdatedBody) {
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00005377 const auto *Def = cast<FunctionDecl>(D);
Richard Smith4d235792014-08-07 18:53:08 +00005378 Record.push_back(UPD_CXX_ADDED_FUNCTION_DEFINITION);
Richard Smithd28ac5b2014-03-22 23:33:22 +00005379 Record.push_back(Def->isInlined());
Richard Smith69c82bf2016-04-01 22:52:03 +00005380 Record.AddSourceLocation(Def->getInnerLocStart());
Richard Smith290d8012016-04-06 17:06:00 +00005381 Record.AddFunctionDefinition(Def);
Richard Smithd28ac5b2014-03-22 23:33:22 +00005382 }
5383
Richard Smithcd45dbc2014-04-19 03:48:30 +00005384 OffsetsRecord.push_back(GetDeclRef(D));
Richard Smith69c82bf2016-04-01 22:52:03 +00005385 OffsetsRecord.push_back(Record.Emit(DECL_UPDATES));
Argyrios Kyrtzidis65ad5692010-10-24 17:26:36 +00005386 }
Argyrios Kyrtzidis65ad5692010-10-24 17:26:36 +00005387}
5388
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00005389void ASTWriter::AddSourceLocation(SourceLocation Loc, RecordDataImpl &Record) {
Richard Smithb22a1d12016-03-27 20:13:24 +00005390 uint32_t Raw = Loc.getRawEncoding();
5391 Record.push_back((Raw << 1) | (Raw >> 31));
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005392}
5393
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00005394void ASTWriter::AddSourceRange(SourceRange Range, RecordDataImpl &Record) {
Chris Lattnerca025db2010-05-07 21:43:38 +00005395 AddSourceLocation(Range.getBegin(), Record);
5396 AddSourceLocation(Range.getEnd(), Record);
5397}
5398
Richard Smithf144b542016-04-08 21:54:32 +00005399void ASTRecordWriter::AddAPInt(const llvm::APInt &Value) {
5400 Record->push_back(Value.getBitWidth());
Benjamin Kramer25f9ea62010-09-06 23:43:28 +00005401 const uint64_t *Words = Value.getRawData();
Richard Smithf144b542016-04-08 21:54:32 +00005402 Record->append(Words, Words + Value.getNumWords());
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005403}
5404
Richard Smithf144b542016-04-08 21:54:32 +00005405void ASTRecordWriter::AddAPSInt(const llvm::APSInt &Value) {
5406 Record->push_back(Value.isUnsigned());
5407 AddAPInt(Value);
Douglas Gregor1daeb692009-04-13 18:14:40 +00005408}
5409
Richard Smithf144b542016-04-08 21:54:32 +00005410void ASTRecordWriter::AddAPFloat(const llvm::APFloat &Value) {
5411 AddAPInt(Value.bitcastToAPInt());
Douglas Gregore0a3a512009-04-14 21:55:33 +00005412}
5413
Gauthier Harnisch83c7b612019-06-15 10:24:47 +00005414static void WriteFixedPointSemantics(ASTRecordWriter &Record,
5415 FixedPointSemantics FPSema) {
5416 Record.push_back(FPSema.getWidth());
5417 Record.push_back(FPSema.getScale());
5418 Record.push_back(FPSema.isSigned() | FPSema.isSaturated() << 1 |
5419 FPSema.hasUnsignedPadding() << 2);
5420}
5421
5422void ASTRecordWriter::AddAPValue(const APValue &Value) {
5423 APValue::ValueKind Kind = Value.getKind();
5424 push_back(static_cast<uint64_t>(Kind));
5425 switch (Kind) {
5426 case APValue::None:
5427 case APValue::Indeterminate:
5428 return;
5429 case APValue::Int:
5430 AddAPSInt(Value.getInt());
5431 return;
5432 case APValue::Float:
5433 push_back(static_cast<uint64_t>(
5434 llvm::APFloatBase::SemanticsToEnum(Value.getFloat().getSemantics())));
5435 AddAPFloat(Value.getFloat());
5436 return;
5437 case APValue::FixedPoint: {
5438 WriteFixedPointSemantics(*this, Value.getFixedPoint().getSemantics());
5439 AddAPSInt(Value.getFixedPoint().getValue());
5440 return;
5441 }
5442 case APValue::ComplexInt: {
5443 AddAPSInt(Value.getComplexIntReal());
5444 AddAPSInt(Value.getComplexIntImag());
5445 return;
5446 }
5447 case APValue::ComplexFloat: {
5448 push_back(static_cast<uint64_t>(llvm::APFloatBase::SemanticsToEnum(
5449 Value.getComplexFloatReal().getSemantics())));
5450 AddAPFloat(Value.getComplexFloatReal());
5451 push_back(static_cast<uint64_t>(llvm::APFloatBase::SemanticsToEnum(
5452 Value.getComplexFloatImag().getSemantics())));
5453 AddAPFloat(Value.getComplexFloatImag());
5454 return;
5455 }
5456 case APValue::LValue:
5457 case APValue::Vector:
5458 case APValue::Array:
5459 case APValue::Struct:
5460 case APValue::Union:
5461 case APValue::MemberPointer:
5462 case APValue::AddrLabelDiff:
5463 // TODO : Handle all these APValue::ValueKind.
5464 return;
5465 }
5466 llvm_unreachable("Invalid APValue::ValueKind");
5467}
5468
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00005469void ASTWriter::AddIdentifierRef(const IdentifierInfo *II, RecordDataImpl &Record) {
Douglas Gregor4621c6a2009-04-22 18:49:13 +00005470 Record.push_back(getIdentifierRef(II));
5471}
5472
Sebastian Redl539c5062010-08-18 23:57:32 +00005473IdentID ASTWriter::getIdentifierRef(const IdentifierInfo *II) {
Craig Toppera13603a2014-05-22 05:54:18 +00005474 if (!II)
Douglas Gregor4621c6a2009-04-22 18:49:13 +00005475 return 0;
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00005476
Sebastian Redl539c5062010-08-18 23:57:32 +00005477 IdentID &ID = IdentifierIDs[II];
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00005478 if (ID == 0)
Sebastian Redlff4a2952010-07-23 23:49:55 +00005479 ID = NextIdentID++;
Douglas Gregor4621c6a2009-04-22 18:49:13 +00005480 return ID;
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005481}
5482
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00005483MacroID ASTWriter::getMacroRef(MacroInfo *MI, const IdentifierInfo *Name) {
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00005484 // Don't emit builtin macros like __LINE__ to the AST file unless they
5485 // have been redefined by the header (in which case they are not
5486 // isBuiltinMacro).
Craig Toppera13603a2014-05-22 05:54:18 +00005487 if (!MI || MI->isBuiltinMacro())
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00005488 return 0;
5489
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00005490 MacroID &ID = MacroIDs[MI];
5491 if (ID == 0) {
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00005492 ID = NextMacroID++;
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00005493 MacroInfoToEmitData Info = { Name, MI, ID };
5494 MacroInfosToEmit.push_back(Info);
5495 }
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00005496 return ID;
5497}
5498
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00005499MacroID ASTWriter::getMacroID(MacroInfo *MI) {
Craig Toppera13603a2014-05-22 05:54:18 +00005500 if (!MI || MI->isBuiltinMacro())
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00005501 return 0;
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00005502
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00005503 assert(MacroIDs.find(MI) != MacroIDs.end() && "Macro not emitted!");
5504 return MacroIDs[MI];
5505}
5506
5507uint64_t ASTWriter::getMacroDirectivesOffset(const IdentifierInfo *Name) {
Richard Smithd7329392015-04-21 21:46:32 +00005508 return IdentMacroDirectivesOffsetMap.lookup(Name);
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00005509}
5510
Richard Smithe64e7452016-04-18 21:54:58 +00005511void ASTRecordWriter::AddSelectorRef(const Selector SelRef) {
5512 Record->push_back(Writer->getSelectorRef(SelRef));
Sebastian Redl834bb972010-08-04 17:20:04 +00005513}
5514
Sebastian Redl539c5062010-08-18 23:57:32 +00005515SelectorID ASTWriter::getSelectorRef(Selector Sel) {
Craig Toppera13603a2014-05-22 05:54:18 +00005516 if (Sel.getAsOpaquePtr() == nullptr) {
Sebastian Redl834bb972010-08-04 17:20:04 +00005517 return 0;
Steve Naroff2ddea052009-04-23 10:39:46 +00005518 }
5519
Douglas Gregor8d7edce2013-02-08 21:30:59 +00005520 SelectorID SID = SelectorIDs[Sel];
Sebastian Redld95a56e2010-08-04 18:21:41 +00005521 if (SID == 0 && Chain) {
5522 // This might trigger a ReadSelector callback, which will set the ID for
5523 // this selector.
5524 Chain->LoadSelector(Sel);
Douglas Gregor8d7edce2013-02-08 21:30:59 +00005525 SID = SelectorIDs[Sel];
Sebastian Redld95a56e2010-08-04 18:21:41 +00005526 }
Steve Naroff2ddea052009-04-23 10:39:46 +00005527 if (SID == 0) {
Sebastian Redld95a56e2010-08-04 18:21:41 +00005528 SID = NextSelectorID++;
Douglas Gregor8d7edce2013-02-08 21:30:59 +00005529 SelectorIDs[Sel] = SID;
Steve Naroff2ddea052009-04-23 10:39:46 +00005530 }
Sebastian Redl834bb972010-08-04 17:20:04 +00005531 return SID;
Steve Naroff2ddea052009-04-23 10:39:46 +00005532}
5533
Richard Smithe64e7452016-04-18 21:54:58 +00005534void ASTRecordWriter::AddCXXTemporary(const CXXTemporary *Temp) {
5535 AddDeclRef(Temp->getDestructor());
Chris Lattnercba86142010-05-10 00:25:06 +00005536}
5537
Richard Smith290d8012016-04-06 17:06:00 +00005538void ASTRecordWriter::AddTemplateArgumentLocInfo(
5539 TemplateArgument::ArgKind Kind, const TemplateArgumentLocInfo &Arg) {
Argyrios Kyrtzidisae85e242010-06-22 09:54:59 +00005540 switch (Kind) {
John McCall0ad16662009-10-29 08:12:44 +00005541 case TemplateArgument::Expression:
Argyrios Kyrtzidisae85e242010-06-22 09:54:59 +00005542 AddStmt(Arg.getAsExpr());
John McCall0ad16662009-10-29 08:12:44 +00005543 break;
5544 case TemplateArgument::Type:
Richard Smith290d8012016-04-06 17:06:00 +00005545 AddTypeSourceInfo(Arg.getAsTypeSourceInfo());
John McCall0ad16662009-10-29 08:12:44 +00005546 break;
Douglas Gregor9167f8b2009-11-11 01:00:40 +00005547 case TemplateArgument::Template:
Richard Smith290d8012016-04-06 17:06:00 +00005548 AddNestedNameSpecifierLoc(Arg.getTemplateQualifierLoc());
5549 AddSourceLocation(Arg.getTemplateNameLoc());
Douglas Gregore4ff4b52011-01-05 18:58:31 +00005550 break;
5551 case TemplateArgument::TemplateExpansion:
Richard Smith290d8012016-04-06 17:06:00 +00005552 AddNestedNameSpecifierLoc(Arg.getTemplateQualifierLoc());
5553 AddSourceLocation(Arg.getTemplateNameLoc());
5554 AddSourceLocation(Arg.getTemplateEllipsisLoc());
Douglas Gregor9167f8b2009-11-11 01:00:40 +00005555 break;
John McCall0ad16662009-10-29 08:12:44 +00005556 case TemplateArgument::Null:
5557 case TemplateArgument::Integral:
5558 case TemplateArgument::Declaration:
Eli Friedmanb826a002012-09-26 02:36:12 +00005559 case TemplateArgument::NullPtr:
John McCall0ad16662009-10-29 08:12:44 +00005560 case TemplateArgument::Pack:
Eli Friedmanb826a002012-09-26 02:36:12 +00005561 // FIXME: Is this right?
John McCall0ad16662009-10-29 08:12:44 +00005562 break;
5563 }
5564}
5565
Richard Smith290d8012016-04-06 17:06:00 +00005566void ASTRecordWriter::AddTemplateArgumentLoc(const TemplateArgumentLoc &Arg) {
5567 AddTemplateArgument(Arg.getArgument());
Argyrios Kyrtzidisddf5f212010-06-28 09:31:42 +00005568
5569 if (Arg.getArgument().getKind() == TemplateArgument::Expression) {
5570 bool InfoHasSameExpr
5571 = Arg.getArgument().getAsExpr() == Arg.getLocInfo().getAsExpr();
Richard Smith290d8012016-04-06 17:06:00 +00005572 Record->push_back(InfoHasSameExpr);
Argyrios Kyrtzidisddf5f212010-06-28 09:31:42 +00005573 if (InfoHasSameExpr)
5574 return; // Avoid storing the same expr twice.
5575 }
Richard Smith290d8012016-04-06 17:06:00 +00005576 AddTemplateArgumentLocInfo(Arg.getArgument().getKind(), Arg.getLocInfo());
Argyrios Kyrtzidisae85e242010-06-22 09:54:59 +00005577}
5578
Richard Smith290d8012016-04-06 17:06:00 +00005579void ASTRecordWriter::AddTypeSourceInfo(TypeSourceInfo *TInfo) {
Craig Toppera13603a2014-05-22 05:54:18 +00005580 if (!TInfo) {
Richard Smith290d8012016-04-06 17:06:00 +00005581 AddTypeRef(QualType());
John McCall8f115c62009-10-16 21:56:05 +00005582 return;
5583 }
5584
Richard Smithc23d7342018-06-29 20:46:25 +00005585 AddTypeRef(TInfo->getType());
Richard Smith290d8012016-04-06 17:06:00 +00005586 AddTypeLoc(TInfo->getTypeLoc());
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005587}
5588
Richard Smith290d8012016-04-06 17:06:00 +00005589void ASTRecordWriter::AddTypeLoc(TypeLoc TL) {
Richard Smith290d8012016-04-06 17:06:00 +00005590 TypeLocWriter TLW(*this);
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005591 for (; !TL.isNull(); TL = TL.getNextTypeLoc())
Kovarththanan Rajaratnama9c81a82010-03-14 07:06:50 +00005592 TLW.Visit(TL);
John McCall8f115c62009-10-16 21:56:05 +00005593}
5594
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00005595void ASTWriter::AddTypeRef(QualType T, RecordDataImpl &Record) {
Argyrios Kyrtzidis9ab44ea2010-08-20 16:04:14 +00005596 Record.push_back(GetOrCreateTypeID(T));
5597}
5598
Richard Smith2095ffe2015-03-16 20:11:03 +00005599TypeID ASTWriter::GetOrCreateTypeID(QualType T) {
Richard Smith1fa5d642013-05-11 05:45:24 +00005600 assert(Context);
Richard Smith2095ffe2015-03-16 20:11:03 +00005601 return MakeTypeID(*Context, T, [&](QualType T) -> TypeIdx {
5602 if (T.isNull())
5603 return TypeIdx();
5604 assert(!T.getLocalFastQualifiers());
5605
5606 TypeIdx &Idx = TypeIdxs[T];
5607 if (Idx.getIndex() == 0) {
5608 if (DoneWritingDeclsAndTypes) {
5609 assert(0 && "New type seen after serializing all the types to emit!");
5610 return TypeIdx();
5611 }
5612
5613 // We haven't seen this type before. Assign it a new ID and put it
5614 // into the queue of types to emit.
5615 Idx = TypeIdx(NextTypeID++);
5616 DeclTypesToEmit.push(T);
5617 }
5618 return Idx;
5619 });
Argyrios Kyrtzidis082e4612010-08-20 16:04:20 +00005620}
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005621
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00005622TypeID ASTWriter::getTypeID(QualType T) const {
Richard Smith1fa5d642013-05-11 05:45:24 +00005623 assert(Context);
Richard Smith2095ffe2015-03-16 20:11:03 +00005624 return MakeTypeID(*Context, T, [&](QualType T) -> TypeIdx {
5625 if (T.isNull())
Argyrios Kyrtzidis442dd802012-07-02 19:19:01 +00005626 return TypeIdx();
Richard Smith2095ffe2015-03-16 20:11:03 +00005627 assert(!T.getLocalFastQualifiers());
Argyrios Kyrtzidis442dd802012-07-02 19:19:01 +00005628
Richard Smith2095ffe2015-03-16 20:11:03 +00005629 TypeIdxMap::const_iterator I = TypeIdxs.find(T);
5630 assert(I != TypeIdxs.end() && "Type not emitted!");
5631 return I->second;
5632 });
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005633}
5634
Argyrios Kyrtzidis65ad5692010-10-24 17:26:36 +00005635void ASTWriter::AddDeclRef(const Decl *D, RecordDataImpl &Record) {
Sebastian Redl66c5eef2010-07-27 00:17:23 +00005636 Record.push_back(GetDeclRef(D));
5637}
5638
Sebastian Redl539c5062010-08-18 23:57:32 +00005639DeclID ASTWriter::GetDeclRef(const Decl *D) {
Douglas Gregor2fd3d402011-09-17 00:05:03 +00005640 assert(WritingAST && "Cannot request a declaration ID before AST writing");
Craig Toppera13603a2014-05-22 05:54:18 +00005641
5642 if (!D) {
Sebastian Redl66c5eef2010-07-27 00:17:23 +00005643 return 0;
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005644 }
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00005645
Douglas Gregorb3163e52012-01-05 22:33:30 +00005646 // If D comes from an AST file, its declaration ID is already known and
5647 // fixed.
5648 if (D->isFromASTFile())
5649 return D->getGlobalID();
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00005650
Douglas Gregor9b3932c2010-10-05 18:37:06 +00005651 assert(!(reinterpret_cast<uintptr_t>(D) & 0x01) && "Invalid decl pointer");
Sebastian Redl539c5062010-08-18 23:57:32 +00005652 DeclID &ID = DeclIDs[D];
Mike Stump11289f42009-09-09 15:08:12 +00005653 if (ID == 0) {
Argyrios Kyrtzidis442dd802012-07-02 19:19:01 +00005654 if (DoneWritingDeclsAndTypes) {
5655 assert(0 && "New decl seen after serializing all the decls to emit!");
5656 return 0;
5657 }
5658
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005659 // We haven't seen this declaration before. Give it a new ID and
5660 // enqueue it in the list of declarations to emit.
Sebastian Redlff4a2952010-07-23 23:49:55 +00005661 ID = NextDeclID++;
Douglas Gregor12bfa382009-10-17 00:13:19 +00005662 DeclTypesToEmit.push(const_cast<Decl *>(D));
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005663 }
5664
Sebastian Redl66c5eef2010-07-27 00:17:23 +00005665 return ID;
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005666}
5667
Sebastian Redl539c5062010-08-18 23:57:32 +00005668DeclID ASTWriter::getDeclID(const Decl *D) {
Craig Toppera13603a2014-05-22 05:54:18 +00005669 if (!D)
Douglas Gregore84a9da2009-04-20 20:36:09 +00005670 return 0;
5671
Douglas Gregorb3163e52012-01-05 22:33:30 +00005672 // If D comes from an AST file, its declaration ID is already known and
5673 // fixed.
5674 if (D->isFromASTFile())
5675 return D->getGlobalID();
5676
Douglas Gregore84a9da2009-04-20 20:36:09 +00005677 assert(DeclIDs.find(D) != DeclIDs.end() && "Declaration not emitted!");
5678 return DeclIDs[D];
5679}
5680
Argyrios Kyrtzidisdf53da82011-10-28 23:57:43 +00005681void ASTWriter::associateDeclWithFile(const Decl *D, DeclID ID) {
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005682 assert(ID);
Argyrios Kyrtzidisdf53da82011-10-28 23:57:43 +00005683 assert(D);
5684
5685 SourceLocation Loc = D->getLocation();
5686 if (Loc.isInvalid())
5687 return;
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005688
5689 // We only keep track of the file-level declarations of each file.
5690 if (!D->getLexicalDeclContext()->isFileContext())
5691 return;
Argyrios Kyrtzidise1bc99e2012-02-24 19:45:46 +00005692 // FIXME: ParmVarDecls that are part of a function type of a parameter of
5693 // a function/objc method, should not have TU as lexical context.
Argyrios Kyrtzidis71b74eb2018-01-26 19:26:12 +00005694 // TemplateTemplateParmDecls that are part of an alias template, should not
5695 // have TU as lexical context.
5696 if (isa<ParmVarDecl>(D) || isa<TemplateTemplateParmDecl>(D))
Argyrios Kyrtzidisffe055a82012-02-24 01:12:38 +00005697 return;
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005698
5699 SourceManager &SM = Context->getSourceManager();
Argyrios Kyrtzidisdf53da82011-10-28 23:57:43 +00005700 SourceLocation FileLoc = SM.getFileLoc(Loc);
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005701 assert(SM.isLocalSourceLocation(FileLoc));
Argyrios Kyrtzidis7362e9b2011-10-28 23:57:47 +00005702 FileID FID;
5703 unsigned Offset;
Benjamin Kramer867ea1d2014-03-02 13:01:17 +00005704 std::tie(FID, Offset) = SM.getDecomposedLoc(FileLoc);
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005705 if (FID.isInvalid())
5706 return;
Argyrios Kyrtzidis4db774a2012-10-02 21:09:17 +00005707 assert(SM.getSLocEntry(FID).isFile());
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005708
Argyrios Kyrtzidis4db774a2012-10-02 21:09:17 +00005709 DeclIDInFileInfo *&Info = FileDeclIDs[FID];
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005710 if (!Info)
5711 Info = new DeclIDInFileInfo();
5712
Argyrios Kyrtzidis7362e9b2011-10-28 23:57:47 +00005713 std::pair<unsigned, serialization::DeclID> LocDecl(Offset, ID);
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005714 LocDeclIDsTy &Decls = Info->DeclIDs;
5715
Argyrios Kyrtzidis7362e9b2011-10-28 23:57:47 +00005716 if (Decls.empty() || Decls.back().first <= Offset) {
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005717 Decls.push_back(LocDecl);
5718 return;
5719 }
5720
Benjamin Kramer45025c02013-08-24 13:22:59 +00005721 LocDeclIDsTy::iterator I =
Fangrui Song7264a472019-07-03 08:13:17 +00005722 llvm::upper_bound(Decls, LocDecl, llvm::less_first());
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005723
5724 Decls.insert(I, LocDecl);
5725}
5726
Richard Smithe64e7452016-04-18 21:54:58 +00005727void ASTRecordWriter::AddDeclarationName(DeclarationName Name) {
Chris Lattner258172e2009-04-27 07:35:58 +00005728 // FIXME: Emit a stable enum for NameKind. 0 = Identifier etc.
Richard Smithe64e7452016-04-18 21:54:58 +00005729 Record->push_back(Name.getNameKind());
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005730 switch (Name.getNameKind()) {
5731 case DeclarationName::Identifier:
Richard Smithe64e7452016-04-18 21:54:58 +00005732 AddIdentifierRef(Name.getAsIdentifierInfo());
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005733 break;
5734
5735 case DeclarationName::ObjCZeroArgSelector:
5736 case DeclarationName::ObjCOneArgSelector:
5737 case DeclarationName::ObjCMultiArgSelector:
Richard Smithe64e7452016-04-18 21:54:58 +00005738 AddSelectorRef(Name.getObjCSelector());
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005739 break;
5740
5741 case DeclarationName::CXXConstructorName:
5742 case DeclarationName::CXXDestructorName:
5743 case DeclarationName::CXXConversionFunctionName:
Richard Smithe64e7452016-04-18 21:54:58 +00005744 AddTypeRef(Name.getCXXNameType());
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005745 break;
5746
Richard Smith35845152017-02-07 01:37:30 +00005747 case DeclarationName::CXXDeductionGuideName:
5748 AddDeclRef(Name.getCXXDeductionGuideTemplate());
5749 break;
5750
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005751 case DeclarationName::CXXOperatorName:
Richard Smithe64e7452016-04-18 21:54:58 +00005752 Record->push_back(Name.getCXXOverloadedOperator());
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005753 break;
5754
Alexis Hunt3d221f22009-11-29 07:34:05 +00005755 case DeclarationName::CXXLiteralOperatorName:
Richard Smithe64e7452016-04-18 21:54:58 +00005756 AddIdentifierRef(Name.getCXXLiteralIdentifier());
Alexis Hunt3d221f22009-11-29 07:34:05 +00005757 break;
5758
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005759 case DeclarationName::CXXUsingDirective:
5760 // No extra data to emit
5761 break;
5762 }
5763}
Chris Lattnerca025db2010-05-07 21:43:38 +00005764
Richard Smithd08aeb62014-08-28 01:33:39 +00005765unsigned ASTWriter::getAnonymousDeclarationNumber(const NamedDecl *D) {
5766 assert(needsAnonymousDeclarationNumber(D) &&
5767 "expected an anonymous declaration");
5768
5769 // Number the anonymous declarations within this context, if we've not
5770 // already done so.
5771 auto It = AnonymousDeclarationNumbers.find(D);
5772 if (It == AnonymousDeclarationNumbers.end()) {
Richard Smith2b560572015-02-07 03:11:11 +00005773 auto *DC = D->getLexicalDeclContext();
5774 numberAnonymousDeclsWithin(DC, [&](const NamedDecl *ND, unsigned Number) {
5775 AnonymousDeclarationNumbers[ND] = Number;
5776 });
Richard Smithd08aeb62014-08-28 01:33:39 +00005777
5778 It = AnonymousDeclarationNumbers.find(D);
5779 assert(It != AnonymousDeclarationNumbers.end() &&
5780 "declaration not found within its lexical context");
5781 }
5782
5783 return It->second;
5784}
5785
Richard Smith290d8012016-04-06 17:06:00 +00005786void ASTRecordWriter::AddDeclarationNameLoc(const DeclarationNameLoc &DNLoc,
5787 DeclarationName Name) {
Argyrios Kyrtzidis434383d2010-10-15 18:21:24 +00005788 switch (Name.getNameKind()) {
5789 case DeclarationName::CXXConstructorName:
5790 case DeclarationName::CXXDestructorName:
5791 case DeclarationName::CXXConversionFunctionName:
Richard Smith290d8012016-04-06 17:06:00 +00005792 AddTypeSourceInfo(DNLoc.NamedType.TInfo);
Argyrios Kyrtzidis434383d2010-10-15 18:21:24 +00005793 break;
5794
5795 case DeclarationName::CXXOperatorName:
Richard Smith290d8012016-04-06 17:06:00 +00005796 AddSourceLocation(SourceLocation::getFromRawEncoding(
5797 DNLoc.CXXOperatorName.BeginOpNameLoc));
Argyrios Kyrtzidis434383d2010-10-15 18:21:24 +00005798 AddSourceLocation(
Richard Smith290d8012016-04-06 17:06:00 +00005799 SourceLocation::getFromRawEncoding(DNLoc.CXXOperatorName.EndOpNameLoc));
Argyrios Kyrtzidis434383d2010-10-15 18:21:24 +00005800 break;
5801
5802 case DeclarationName::CXXLiteralOperatorName:
Richard Smith290d8012016-04-06 17:06:00 +00005803 AddSourceLocation(SourceLocation::getFromRawEncoding(
5804 DNLoc.CXXLiteralOperatorName.OpNameLoc));
Argyrios Kyrtzidis434383d2010-10-15 18:21:24 +00005805 break;
5806
5807 case DeclarationName::Identifier:
5808 case DeclarationName::ObjCZeroArgSelector:
5809 case DeclarationName::ObjCOneArgSelector:
5810 case DeclarationName::ObjCMultiArgSelector:
5811 case DeclarationName::CXXUsingDirective:
Richard Smith35845152017-02-07 01:37:30 +00005812 case DeclarationName::CXXDeductionGuideName:
Argyrios Kyrtzidis434383d2010-10-15 18:21:24 +00005813 break;
5814 }
5815}
5816
Richard Smith290d8012016-04-06 17:06:00 +00005817void ASTRecordWriter::AddDeclarationNameInfo(
5818 const DeclarationNameInfo &NameInfo) {
5819 AddDeclarationName(NameInfo.getName());
5820 AddSourceLocation(NameInfo.getLoc());
5821 AddDeclarationNameLoc(NameInfo.getInfo(), NameInfo.getName());
Argyrios Kyrtzidis434383d2010-10-15 18:21:24 +00005822}
5823
Richard Smith290d8012016-04-06 17:06:00 +00005824void ASTRecordWriter::AddQualifierInfo(const QualifierInfo &Info) {
5825 AddNestedNameSpecifierLoc(Info.QualifierLoc);
5826 Record->push_back(Info.NumTemplParamLists);
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +00005827 for (unsigned i = 0, e = Info.NumTemplParamLists; i != e; ++i)
Richard Smith290d8012016-04-06 17:06:00 +00005828 AddTemplateParameterList(Info.TemplParamLists[i]);
Argyrios Kyrtzidis434383d2010-10-15 18:21:24 +00005829}
5830
Richard Smithe64e7452016-04-18 21:54:58 +00005831void ASTRecordWriter::AddNestedNameSpecifier(NestedNameSpecifier *NNS) {
Chris Lattnerca025db2010-05-07 21:43:38 +00005832 // Nested name specifiers usually aren't too long. I think that 8 would
Chris Lattner57540c52011-04-15 05:22:18 +00005833 // typically accommodate the vast majority.
Chris Lattner0e62c1c2011-07-23 10:55:15 +00005834 SmallVector<NestedNameSpecifier *, 8> NestedNames;
Chris Lattnerca025db2010-05-07 21:43:38 +00005835
5836 // Push each of the NNS's onto a stack for serialization in reverse order.
5837 while (NNS) {
5838 NestedNames.push_back(NNS);
5839 NNS = NNS->getPrefix();
5840 }
5841
Richard Smithe64e7452016-04-18 21:54:58 +00005842 Record->push_back(NestedNames.size());
Chris Lattnerca025db2010-05-07 21:43:38 +00005843 while(!NestedNames.empty()) {
5844 NNS = NestedNames.pop_back_val();
5845 NestedNameSpecifier::SpecifierKind Kind = NNS->getKind();
Richard Smithe64e7452016-04-18 21:54:58 +00005846 Record->push_back(Kind);
Chris Lattnerca025db2010-05-07 21:43:38 +00005847 switch (Kind) {
5848 case NestedNameSpecifier::Identifier:
Richard Smithe64e7452016-04-18 21:54:58 +00005849 AddIdentifierRef(NNS->getAsIdentifier());
Chris Lattnerca025db2010-05-07 21:43:38 +00005850 break;
5851
5852 case NestedNameSpecifier::Namespace:
Richard Smithe64e7452016-04-18 21:54:58 +00005853 AddDeclRef(NNS->getAsNamespace());
Chris Lattnerca025db2010-05-07 21:43:38 +00005854 break;
5855
Douglas Gregor7b26ff92011-02-24 02:36:08 +00005856 case NestedNameSpecifier::NamespaceAlias:
Richard Smithe64e7452016-04-18 21:54:58 +00005857 AddDeclRef(NNS->getAsNamespaceAlias());
Douglas Gregor7b26ff92011-02-24 02:36:08 +00005858 break;
5859
Chris Lattnerca025db2010-05-07 21:43:38 +00005860 case NestedNameSpecifier::TypeSpec:
5861 case NestedNameSpecifier::TypeSpecWithTemplate:
Richard Smithe64e7452016-04-18 21:54:58 +00005862 AddTypeRef(QualType(NNS->getAsType(), 0));
5863 Record->push_back(Kind == NestedNameSpecifier::TypeSpecWithTemplate);
Chris Lattnerca025db2010-05-07 21:43:38 +00005864 break;
5865
5866 case NestedNameSpecifier::Global:
5867 // Don't need to write an associated value.
5868 break;
Nikola Smiljanic67860242014-09-26 00:28:20 +00005869
5870 case NestedNameSpecifier::Super:
Richard Smithe64e7452016-04-18 21:54:58 +00005871 AddDeclRef(NNS->getAsRecordDecl());
Nikola Smiljanic67860242014-09-26 00:28:20 +00005872 break;
Chris Lattnerca025db2010-05-07 21:43:38 +00005873 }
5874 }
5875}
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005876
Richard Smith290d8012016-04-06 17:06:00 +00005877void ASTRecordWriter::AddNestedNameSpecifierLoc(NestedNameSpecifierLoc NNS) {
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005878 // Nested name specifiers usually aren't too long. I think that 8 would
Chris Lattner57540c52011-04-15 05:22:18 +00005879 // typically accommodate the vast majority.
Chris Lattner0e62c1c2011-07-23 10:55:15 +00005880 SmallVector<NestedNameSpecifierLoc , 8> NestedNames;
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005881
5882 // Push each of the nested-name-specifiers's onto a stack for
5883 // serialization in reverse order.
5884 while (NNS) {
5885 NestedNames.push_back(NNS);
5886 NNS = NNS.getPrefix();
5887 }
5888
Richard Smith290d8012016-04-06 17:06:00 +00005889 Record->push_back(NestedNames.size());
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005890 while(!NestedNames.empty()) {
5891 NNS = NestedNames.pop_back_val();
5892 NestedNameSpecifier::SpecifierKind Kind
5893 = NNS.getNestedNameSpecifier()->getKind();
Richard Smith290d8012016-04-06 17:06:00 +00005894 Record->push_back(Kind);
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005895 switch (Kind) {
5896 case NestedNameSpecifier::Identifier:
Richard Smith290d8012016-04-06 17:06:00 +00005897 AddIdentifierRef(NNS.getNestedNameSpecifier()->getAsIdentifier());
5898 AddSourceRange(NNS.getLocalSourceRange());
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005899 break;
5900
5901 case NestedNameSpecifier::Namespace:
Richard Smith290d8012016-04-06 17:06:00 +00005902 AddDeclRef(NNS.getNestedNameSpecifier()->getAsNamespace());
5903 AddSourceRange(NNS.getLocalSourceRange());
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005904 break;
5905
5906 case NestedNameSpecifier::NamespaceAlias:
Richard Smith290d8012016-04-06 17:06:00 +00005907 AddDeclRef(NNS.getNestedNameSpecifier()->getAsNamespaceAlias());
5908 AddSourceRange(NNS.getLocalSourceRange());
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005909 break;
5910
5911 case NestedNameSpecifier::TypeSpec:
5912 case NestedNameSpecifier::TypeSpecWithTemplate:
Richard Smith290d8012016-04-06 17:06:00 +00005913 Record->push_back(Kind == NestedNameSpecifier::TypeSpecWithTemplate);
Richard Smithc23d7342018-06-29 20:46:25 +00005914 AddTypeRef(NNS.getTypeLoc().getType());
Richard Smith290d8012016-04-06 17:06:00 +00005915 AddTypeLoc(NNS.getTypeLoc());
5916 AddSourceLocation(NNS.getLocalSourceRange().getEnd());
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005917 break;
5918
5919 case NestedNameSpecifier::Global:
Richard Smith290d8012016-04-06 17:06:00 +00005920 AddSourceLocation(NNS.getLocalSourceRange().getEnd());
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005921 break;
Nikola Smiljanic67860242014-09-26 00:28:20 +00005922
5923 case NestedNameSpecifier::Super:
Richard Smith290d8012016-04-06 17:06:00 +00005924 AddDeclRef(NNS.getNestedNameSpecifier()->getAsRecordDecl());
5925 AddSourceRange(NNS.getLocalSourceRange());
Nikola Smiljanic67860242014-09-26 00:28:20 +00005926 break;
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005927 }
5928 }
5929}
5930
Richard Smith290d8012016-04-06 17:06:00 +00005931void ASTRecordWriter::AddTemplateName(TemplateName Name) {
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00005932 TemplateName::NameKind Kind = Name.getKind();
Richard Smith290d8012016-04-06 17:06:00 +00005933 Record->push_back(Kind);
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005934 switch (Kind) {
5935 case TemplateName::Template:
Richard Smith290d8012016-04-06 17:06:00 +00005936 AddDeclRef(Name.getAsTemplateDecl());
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005937 break;
5938
5939 case TemplateName::OverloadedTemplate: {
5940 OverloadedTemplateStorage *OvT = Name.getAsOverloadedTemplate();
Richard Smith290d8012016-04-06 17:06:00 +00005941 Record->push_back(OvT->size());
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00005942 for (const auto &I : *OvT)
Richard Smith290d8012016-04-06 17:06:00 +00005943 AddDeclRef(I);
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005944 break;
5945 }
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00005946
Richard Smithb23c5e82019-05-09 03:31:27 +00005947 case TemplateName::AssumedTemplate: {
5948 AssumedTemplateStorage *ADLT = Name.getAsAssumedTemplateName();
5949 AddDeclarationName(ADLT->getDeclName());
5950 break;
5951 }
5952
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005953 case TemplateName::QualifiedTemplate: {
5954 QualifiedTemplateName *QualT = Name.getAsQualifiedTemplateName();
Richard Smith290d8012016-04-06 17:06:00 +00005955 AddNestedNameSpecifier(QualT->getQualifier());
5956 Record->push_back(QualT->hasTemplateKeyword());
5957 AddDeclRef(QualT->getTemplateDecl());
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005958 break;
5959 }
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00005960
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005961 case TemplateName::DependentTemplate: {
5962 DependentTemplateName *DepT = Name.getAsDependentTemplateName();
Richard Smith290d8012016-04-06 17:06:00 +00005963 AddNestedNameSpecifier(DepT->getQualifier());
5964 Record->push_back(DepT->isIdentifier());
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005965 if (DepT->isIdentifier())
Richard Smith290d8012016-04-06 17:06:00 +00005966 AddIdentifierRef(DepT->getIdentifier());
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005967 else
Richard Smith290d8012016-04-06 17:06:00 +00005968 Record->push_back(DepT->getOperator());
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005969 break;
5970 }
John McCalld9dfe3a2011-06-30 08:33:18 +00005971
5972 case TemplateName::SubstTemplateTemplateParm: {
5973 SubstTemplateTemplateParmStorage *subst
5974 = Name.getAsSubstTemplateTemplateParm();
Richard Smith290d8012016-04-06 17:06:00 +00005975 AddDeclRef(subst->getParameter());
5976 AddTemplateName(subst->getReplacement());
John McCalld9dfe3a2011-06-30 08:33:18 +00005977 break;
5978 }
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00005979
Douglas Gregor5590be02011-01-15 06:45:20 +00005980 case TemplateName::SubstTemplateTemplateParmPack: {
5981 SubstTemplateTemplateParmPackStorage *SubstPack
5982 = Name.getAsSubstTemplateTemplateParmPack();
Richard Smith290d8012016-04-06 17:06:00 +00005983 AddDeclRef(SubstPack->getParameterPack());
5984 AddTemplateArgument(SubstPack->getArgumentPack());
Douglas Gregor5590be02011-01-15 06:45:20 +00005985 break;
5986 }
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005987 }
5988}
5989
Richard Smith290d8012016-04-06 17:06:00 +00005990void ASTRecordWriter::AddTemplateArgument(const TemplateArgument &Arg) {
5991 Record->push_back(Arg.getKind());
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005992 switch (Arg.getKind()) {
5993 case TemplateArgument::Null:
5994 break;
5995 case TemplateArgument::Type:
Richard Smith290d8012016-04-06 17:06:00 +00005996 AddTypeRef(Arg.getAsType());
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005997 break;
5998 case TemplateArgument::Declaration:
Richard Smith290d8012016-04-06 17:06:00 +00005999 AddDeclRef(Arg.getAsDecl());
6000 AddTypeRef(Arg.getParamTypeForDecl());
Eli Friedmanb826a002012-09-26 02:36:12 +00006001 break;
6002 case TemplateArgument::NullPtr:
Richard Smith290d8012016-04-06 17:06:00 +00006003 AddTypeRef(Arg.getNullPtrType());
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00006004 break;
6005 case TemplateArgument::Integral:
Richard Smith290d8012016-04-06 17:06:00 +00006006 AddAPSInt(Arg.getAsIntegral());
6007 AddTypeRef(Arg.getIntegralType());
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00006008 break;
6009 case TemplateArgument::Template:
Richard Smith290d8012016-04-06 17:06:00 +00006010 AddTemplateName(Arg.getAsTemplateOrTemplatePattern());
Douglas Gregore1d60df2011-01-14 23:41:42 +00006011 break;
Douglas Gregore4ff4b52011-01-05 18:58:31 +00006012 case TemplateArgument::TemplateExpansion:
Richard Smith290d8012016-04-06 17:06:00 +00006013 AddTemplateName(Arg.getAsTemplateOrTemplatePattern());
David Blaikie05785d12013-02-20 22:23:23 +00006014 if (Optional<unsigned> NumExpansions = Arg.getNumTemplateExpansions())
Richard Smith290d8012016-04-06 17:06:00 +00006015 Record->push_back(*NumExpansions + 1);
Douglas Gregore1d60df2011-01-14 23:41:42 +00006016 else
Richard Smith290d8012016-04-06 17:06:00 +00006017 Record->push_back(0);
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00006018 break;
6019 case TemplateArgument::Expression:
6020 AddStmt(Arg.getAsExpr());
6021 break;
6022 case TemplateArgument::Pack:
Richard Smith290d8012016-04-06 17:06:00 +00006023 Record->push_back(Arg.pack_size());
Aaron Ballman2a89e852014-07-15 21:32:31 +00006024 for (const auto &P : Arg.pack_elements())
Richard Smith290d8012016-04-06 17:06:00 +00006025 AddTemplateArgument(P);
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00006026 break;
6027 }
6028}
Argyrios Kyrtzidis818c5db2010-06-23 13:48:30 +00006029
Richard Smithe64e7452016-04-18 21:54:58 +00006030void ASTRecordWriter::AddTemplateParameterList(
6031 const TemplateParameterList *TemplateParams) {
Argyrios Kyrtzidis818c5db2010-06-23 13:48:30 +00006032 assert(TemplateParams && "No TemplateParams!");
Richard Smithe64e7452016-04-18 21:54:58 +00006033 AddSourceLocation(TemplateParams->getTemplateLoc());
6034 AddSourceLocation(TemplateParams->getLAngleLoc());
6035 AddSourceLocation(TemplateParams->getRAngleLoc());
Hubert Tonge4a0c0e2016-07-30 22:33:34 +00006036 // TODO: Concepts
Richard Smithe64e7452016-04-18 21:54:58 +00006037 Record->push_back(TemplateParams->size());
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00006038 for (const auto &P : *TemplateParams)
Richard Smithe64e7452016-04-18 21:54:58 +00006039 AddDeclRef(P);
Argyrios Kyrtzidis818c5db2010-06-23 13:48:30 +00006040}
6041
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00006042/// Emit a template argument list.
Richard Smith290d8012016-04-06 17:06:00 +00006043void ASTRecordWriter::AddTemplateArgumentList(
6044 const TemplateArgumentList *TemplateArgs) {
Argyrios Kyrtzidis818c5db2010-06-23 13:48:30 +00006045 assert(TemplateArgs && "No TemplateArgs!");
Richard Smith290d8012016-04-06 17:06:00 +00006046 Record->push_back(TemplateArgs->size());
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +00006047 for (int i = 0, e = TemplateArgs->size(); i != e; ++i)
Richard Smith290d8012016-04-06 17:06:00 +00006048 AddTemplateArgument(TemplateArgs->get(i));
Argyrios Kyrtzidis818c5db2010-06-23 13:48:30 +00006049}
Argyrios Kyrtzidis2c2167a2010-07-02 11:55:32 +00006050
Richard Smith290d8012016-04-06 17:06:00 +00006051void ASTRecordWriter::AddASTTemplateArgumentListInfo(
6052 const ASTTemplateArgumentListInfo *ASTTemplArgList) {
Enea Zaffanella6dbe1872013-08-10 07:24:53 +00006053 assert(ASTTemplArgList && "No ASTTemplArgList!");
Richard Smith290d8012016-04-06 17:06:00 +00006054 AddSourceLocation(ASTTemplArgList->LAngleLoc);
6055 AddSourceLocation(ASTTemplArgList->RAngleLoc);
6056 Record->push_back(ASTTemplArgList->NumTemplateArgs);
Enea Zaffanella6dbe1872013-08-10 07:24:53 +00006057 const TemplateArgumentLoc *TemplArgs = ASTTemplArgList->getTemplateArgs();
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +00006058 for (int i = 0, e = ASTTemplArgList->NumTemplateArgs; i != e; ++i)
Richard Smith290d8012016-04-06 17:06:00 +00006059 AddTemplateArgumentLoc(TemplArgs[i]);
Enea Zaffanella6dbe1872013-08-10 07:24:53 +00006060}
Argyrios Kyrtzidis2c2167a2010-07-02 11:55:32 +00006061
Richard Smithe64e7452016-04-18 21:54:58 +00006062void ASTRecordWriter::AddUnresolvedSet(const ASTUnresolvedSet &Set) {
6063 Record->push_back(Set.size());
Argyrios Kyrtzidis0f05fb92012-11-28 03:56:16 +00006064 for (ASTUnresolvedSet::const_iterator
Argyrios Kyrtzidis2c2167a2010-07-02 11:55:32 +00006065 I = Set.begin(), E = Set.end(); I != E; ++I) {
Richard Smithe64e7452016-04-18 21:54:58 +00006066 AddDeclRef(I.getDecl());
6067 Record->push_back(I.getAccess());
Argyrios Kyrtzidis2c2167a2010-07-02 11:55:32 +00006068 }
6069}
Argyrios Kyrtzidis3701fcd2010-07-02 23:30:27 +00006070
Richard Smith290d8012016-04-06 17:06:00 +00006071// FIXME: Move this out of the main ASTRecordWriter interface.
6072void ASTRecordWriter::AddCXXBaseSpecifier(const CXXBaseSpecifier &Base) {
6073 Record->push_back(Base.isVirtual());
6074 Record->push_back(Base.isBaseOfClass());
6075 Record->push_back(Base.getAccessSpecifierAsWritten());
6076 Record->push_back(Base.getInheritConstructors());
6077 AddTypeSourceInfo(Base.getTypeSourceInfo());
6078 AddSourceRange(Base.getSourceRange());
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00006079 AddSourceLocation(Base.isPackExpansion()? Base.getEllipsisLoc()
Richard Smith290d8012016-04-06 17:06:00 +00006080 : SourceLocation());
Argyrios Kyrtzidis3701fcd2010-07-02 23:30:27 +00006081}
Sebastian Redl85b2a6a2010-07-14 23:45:08 +00006082
Richard Smith645d2cf2016-04-14 00:29:55 +00006083static uint64_t EmitCXXBaseSpecifiers(ASTWriter &W,
6084 ArrayRef<CXXBaseSpecifier> Bases) {
6085 ASTWriter::RecordData Record;
6086 ASTRecordWriter Writer(W, Record);
6087 Writer.push_back(Bases.size());
Dmitry Polukhin790b5402016-04-06 10:01:46 +00006088
Richard Smith645d2cf2016-04-14 00:29:55 +00006089 for (auto &Base : Bases)
6090 Writer.AddCXXBaseSpecifier(Base);
Richard Smith290d8012016-04-06 17:06:00 +00006091
Richard Smith645d2cf2016-04-14 00:29:55 +00006092 return Writer.Emit(serialization::DECL_CXX_BASE_SPECIFIERS);
Douglas Gregord4c5ed02010-10-29 22:39:52 +00006093}
6094
Richard Smith290d8012016-04-06 17:06:00 +00006095// FIXME: Move this out of the main ASTRecordWriter interface.
Richard Smith645d2cf2016-04-14 00:29:55 +00006096void ASTRecordWriter::AddCXXBaseSpecifiers(ArrayRef<CXXBaseSpecifier> Bases) {
6097 AddOffset(EmitCXXBaseSpecifiers(*Writer, Bases));
6098}
6099
Richard Smithaa165cf2016-04-13 21:57:08 +00006100static uint64_t
6101EmitCXXCtorInitializers(ASTWriter &W,
6102 ArrayRef<CXXCtorInitializer *> CtorInits) {
6103 ASTWriter::RecordData Record;
6104 ASTRecordWriter Writer(W, Record);
6105 Writer.push_back(CtorInits.size());
Argyrios Kyrtzidis5b6a03f2010-08-09 10:54:12 +00006106
Richard Smithaa165cf2016-04-13 21:57:08 +00006107 for (auto *Init : CtorInits) {
Argyrios Kyrtzidis5b6a03f2010-08-09 10:54:12 +00006108 if (Init->isBaseInitializer()) {
Richard Smithaa165cf2016-04-13 21:57:08 +00006109 Writer.push_back(CTOR_INITIALIZER_BASE);
6110 Writer.AddTypeSourceInfo(Init->getTypeSourceInfo());
6111 Writer.push_back(Init->isBaseVirtual());
Alexis Hunt37a477f2011-05-04 01:19:08 +00006112 } else if (Init->isDelegatingInitializer()) {
Richard Smithaa165cf2016-04-13 21:57:08 +00006113 Writer.push_back(CTOR_INITIALIZER_DELEGATING);
6114 Writer.AddTypeSourceInfo(Init->getTypeSourceInfo());
Alexis Hunt37a477f2011-05-04 01:19:08 +00006115 } else if (Init->isMemberInitializer()){
Richard Smithaa165cf2016-04-13 21:57:08 +00006116 Writer.push_back(CTOR_INITIALIZER_MEMBER);
6117 Writer.AddDeclRef(Init->getMember());
Argyrios Kyrtzidis5b6a03f2010-08-09 10:54:12 +00006118 } else {
Richard Smithaa165cf2016-04-13 21:57:08 +00006119 Writer.push_back(CTOR_INITIALIZER_INDIRECT_MEMBER);
6120 Writer.AddDeclRef(Init->getIndirectMember());
Argyrios Kyrtzidis5b6a03f2010-08-09 10:54:12 +00006121 }
Francois Pichetd583da02010-12-04 09:14:42 +00006122
Richard Smithaa165cf2016-04-13 21:57:08 +00006123 Writer.AddSourceLocation(Init->getMemberLocation());
6124 Writer.AddStmt(Init->getInit());
6125 Writer.AddSourceLocation(Init->getLParenLoc());
6126 Writer.AddSourceLocation(Init->getRParenLoc());
6127 Writer.push_back(Init->isWritten());
Richard Smith30e304e2016-12-14 00:03:17 +00006128 if (Init->isWritten())
Richard Smithaa165cf2016-04-13 21:57:08 +00006129 Writer.push_back(Init->getSourceOrder());
Argyrios Kyrtzidis5b6a03f2010-08-09 10:54:12 +00006130 }
Richard Smithaa165cf2016-04-13 21:57:08 +00006131
6132 return Writer.Emit(serialization::DECL_CXX_CTOR_INITIALIZERS);
Argyrios Kyrtzidis5b6a03f2010-08-09 10:54:12 +00006133}
6134
Richard Smithaa165cf2016-04-13 21:57:08 +00006135// FIXME: Move this out of the main ASTRecordWriter interface.
6136void ASTRecordWriter::AddCXXCtorInitializers(
6137 ArrayRef<CXXCtorInitializer *> CtorInits) {
6138 AddOffset(EmitCXXCtorInitializers(*Writer, CtorInits));
Richard Smithc2bb8182015-03-24 06:36:48 +00006139}
6140
Richard Smith290d8012016-04-06 17:06:00 +00006141void ASTRecordWriter::AddCXXDefinitionData(const CXXRecordDecl *D) {
Richard Smith053f6c62014-05-16 23:01:30 +00006142 auto &Data = D->data();
Richard Smith290d8012016-04-06 17:06:00 +00006143 Record->push_back(Data.IsLambda);
6144 Record->push_back(Data.UserDeclaredConstructor);
6145 Record->push_back(Data.UserDeclaredSpecialMembers);
6146 Record->push_back(Data.Aggregate);
6147 Record->push_back(Data.PlainOldData);
6148 Record->push_back(Data.Empty);
6149 Record->push_back(Data.Polymorphic);
6150 Record->push_back(Data.Abstract);
6151 Record->push_back(Data.IsStandardLayout);
Richard Smithb6070db2018-04-05 18:55:37 +00006152 Record->push_back(Data.IsCXX11StandardLayout);
6153 Record->push_back(Data.HasBasesWithFields);
6154 Record->push_back(Data.HasBasesWithNonStaticDataMembers);
Richard Smith290d8012016-04-06 17:06:00 +00006155 Record->push_back(Data.HasPrivateFields);
6156 Record->push_back(Data.HasProtectedFields);
6157 Record->push_back(Data.HasPublicFields);
6158 Record->push_back(Data.HasMutableFields);
6159 Record->push_back(Data.HasVariantMembers);
6160 Record->push_back(Data.HasOnlyCMembers);
6161 Record->push_back(Data.HasInClassInitializer);
6162 Record->push_back(Data.HasUninitializedReferenceMember);
6163 Record->push_back(Data.HasUninitializedFields);
Richard Smith12e79312016-05-13 06:47:56 +00006164 Record->push_back(Data.HasInheritedConstructor);
6165 Record->push_back(Data.HasInheritedAssignment);
Richard Smith96cd6712017-08-16 01:49:53 +00006166 Record->push_back(Data.NeedOverloadResolutionForCopyConstructor);
Richard Smith290d8012016-04-06 17:06:00 +00006167 Record->push_back(Data.NeedOverloadResolutionForMoveConstructor);
6168 Record->push_back(Data.NeedOverloadResolutionForMoveAssignment);
6169 Record->push_back(Data.NeedOverloadResolutionForDestructor);
Richard Smith96cd6712017-08-16 01:49:53 +00006170 Record->push_back(Data.DefaultedCopyConstructorIsDeleted);
Richard Smith290d8012016-04-06 17:06:00 +00006171 Record->push_back(Data.DefaultedMoveConstructorIsDeleted);
6172 Record->push_back(Data.DefaultedMoveAssignmentIsDeleted);
6173 Record->push_back(Data.DefaultedDestructorIsDeleted);
6174 Record->push_back(Data.HasTrivialSpecialMembers);
Akira Hatanaka02914dc2018-02-05 20:23:22 +00006175 Record->push_back(Data.HasTrivialSpecialMembersForCall);
Richard Smith290d8012016-04-06 17:06:00 +00006176 Record->push_back(Data.DeclaredNonTrivialSpecialMembers);
Akira Hatanaka02914dc2018-02-05 20:23:22 +00006177 Record->push_back(Data.DeclaredNonTrivialSpecialMembersForCall);
Richard Smith290d8012016-04-06 17:06:00 +00006178 Record->push_back(Data.HasIrrelevantDestructor);
6179 Record->push_back(Data.HasConstexprNonCopyMoveConstructor);
6180 Record->push_back(Data.HasDefaultedDefaultConstructor);
6181 Record->push_back(Data.DefaultedDefaultConstructorIsConstexpr);
6182 Record->push_back(Data.HasConstexprDefaultConstructor);
6183 Record->push_back(Data.HasNonLiteralTypeFieldsOrBases);
6184 Record->push_back(Data.ComputedVisibleConversions);
6185 Record->push_back(Data.UserProvidedDefaultConstructor);
6186 Record->push_back(Data.DeclaredSpecialMembers);
Richard Smithdf054d32017-02-25 23:53:05 +00006187 Record->push_back(Data.ImplicitCopyConstructorCanHaveConstParamForVBase);
6188 Record->push_back(Data.ImplicitCopyConstructorCanHaveConstParamForNonVBase);
Richard Smith290d8012016-04-06 17:06:00 +00006189 Record->push_back(Data.ImplicitCopyAssignmentHasConstParam);
6190 Record->push_back(Data.HasDeclaredCopyConstructorWithConstParam);
6191 Record->push_back(Data.HasDeclaredCopyAssignmentWithConstParam);
Richard Trieufd1acbb2017-04-11 21:31:00 +00006192
6193 // getODRHash will compute the ODRHash if it has not been previously computed.
6194 Record->push_back(D->getODRHash());
David Blaikief63556d2017-04-12 20:58:33 +00006195 bool ModulesDebugInfo = Writer->Context->getLangOpts().ModulesDebugInfo &&
6196 Writer->WritingModule && !D->isDependentType();
6197 Record->push_back(ModulesDebugInfo);
6198 if (ModulesDebugInfo)
David Blaikie1ac9c982017-04-11 21:13:37 +00006199 Writer->ModularCodegenDecls.push_back(Writer->GetDeclRef(D));
6200
Richard Smith561fb152012-02-25 07:33:38 +00006201 // IsLambda bit is already saved.
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00006202
Richard Smith290d8012016-04-06 17:06:00 +00006203 Record->push_back(Data.NumBases);
Douglas Gregord4c5ed02010-10-29 22:39:52 +00006204 if (Data.NumBases > 0)
Richard Smith645d2cf2016-04-14 00:29:55 +00006205 AddCXXBaseSpecifiers(Data.bases());
6206
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00006207 // FIXME: Make VBases lazily computed when needed to avoid storing them.
Richard Smith290d8012016-04-06 17:06:00 +00006208 Record->push_back(Data.NumVBases);
Douglas Gregord4c5ed02010-10-29 22:39:52 +00006209 if (Data.NumVBases > 0)
Richard Smith645d2cf2016-04-14 00:29:55 +00006210 AddCXXBaseSpecifiers(Data.vbases());
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00006211
Richard Smith290d8012016-04-06 17:06:00 +00006212 AddUnresolvedSet(Data.Conversions.get(*Writer->Context));
6213 AddUnresolvedSet(Data.VisibleConversions.get(*Writer->Context));
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00006214 // Data.Definition is the owning decl, no need to write it.
Richard Smith290d8012016-04-06 17:06:00 +00006215 AddDeclRef(D->getFirstFriend());
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00006216
Douglas Gregor99ae8062012-02-14 17:54:36 +00006217 // Add lambda-specific data.
6218 if (Data.IsLambda) {
Richard Smith053f6c62014-05-16 23:01:30 +00006219 auto &Lambda = D->getLambdaData();
Richard Smith290d8012016-04-06 17:06:00 +00006220 Record->push_back(Lambda.Dependent);
6221 Record->push_back(Lambda.IsGenericLambda);
6222 Record->push_back(Lambda.CaptureDefault);
6223 Record->push_back(Lambda.NumCaptures);
6224 Record->push_back(Lambda.NumExplicitCaptures);
6225 Record->push_back(Lambda.ManglingNumber);
Richard Smith0bae6242016-08-25 00:34:00 +00006226 AddDeclRef(D->getLambdaContextDecl());
Richard Smith290d8012016-04-06 17:06:00 +00006227 AddTypeSourceInfo(Lambda.MethodTyInfo);
Douglas Gregor99ae8062012-02-14 17:54:36 +00006228 for (unsigned I = 0, N = Lambda.NumCaptures; I != N; ++I) {
Benjamin Kramerf3ca26982014-05-10 16:31:55 +00006229 const LambdaCapture &Capture = Lambda.Captures[I];
Richard Smith290d8012016-04-06 17:06:00 +00006230 AddSourceLocation(Capture.getLocation());
6231 Record->push_back(Capture.isImplicit());
6232 Record->push_back(Capture.getCaptureKind());
Richard Smithba71c082013-05-16 06:20:58 +00006233 switch (Capture.getCaptureKind()) {
Faisal Validc6b5962016-03-21 09:25:37 +00006234 case LCK_StarThis:
Richard Smithba71c082013-05-16 06:20:58 +00006235 case LCK_This:
Alexey Bataev39c81e22014-08-28 04:28:19 +00006236 case LCK_VLAType:
Richard Smithba71c082013-05-16 06:20:58 +00006237 break;
6238 case LCK_ByCopy:
Richard Smithbb13c9a2013-09-28 04:02:39 +00006239 case LCK_ByRef:
Richard Smithba71c082013-05-16 06:20:58 +00006240 VarDecl *Var =
Craig Toppera13603a2014-05-22 05:54:18 +00006241 Capture.capturesVariable() ? Capture.getCapturedVar() : nullptr;
Richard Smith290d8012016-04-06 17:06:00 +00006242 AddDeclRef(Var);
Richard Smithba71c082013-05-16 06:20:58 +00006243 AddSourceLocation(Capture.isPackExpansion() ? Capture.getEllipsisLoc()
Richard Smith290d8012016-04-06 17:06:00 +00006244 : SourceLocation());
Richard Smithba71c082013-05-16 06:20:58 +00006245 break;
6246 }
Douglas Gregor99ae8062012-02-14 17:54:36 +00006247 }
6248 }
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00006249}
6250
Argyrios Kyrtzidis65ad5692010-10-24 17:26:36 +00006251void ASTWriter::ReaderInitialized(ASTReader *Reader) {
Sebastian Redl07a89a82010-07-30 00:29:29 +00006252 assert(Reader && "Cannot remove chain");
Douglas Gregordf0c1512011-08-18 04:12:04 +00006253 assert((!Chain || Chain == Reader) && "Cannot replace chain");
Sebastian Redl07a89a82010-07-30 00:29:29 +00006254 assert(FirstDeclID == NextDeclID &&
6255 FirstTypeID == NextTypeID &&
6256 FirstIdentID == NextIdentID &&
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00006257 FirstMacroID == NextMacroID &&
Douglas Gregor253eefe2011-12-01 00:59:36 +00006258 FirstSubmoduleID == NextSubmoduleID &&
Sebastian Redld95a56e2010-08-04 18:21:41 +00006259 FirstSelectorID == NextSelectorID &&
Sebastian Redl07a89a82010-07-30 00:29:29 +00006260 "Setting chain after writing has started.");
Douglas Gregor925296b2011-07-19 16:10:42 +00006261
Sebastian Redl07a89a82010-07-30 00:29:29 +00006262 Chain = Reader;
Argyrios Kyrtzidis65ad5692010-10-24 17:26:36 +00006263
Richard Smith7f330cd2015-03-18 01:42:29 +00006264 // Note, this will get called multiple times, once one the reader starts up
6265 // and again each time it's done reading a PCH or module.
Douglas Gregordf0c1512011-08-18 04:12:04 +00006266 FirstDeclID = NUM_PREDEF_DECL_IDS + Chain->getTotalNumDecls();
6267 FirstTypeID = NUM_PREDEF_TYPE_IDS + Chain->getTotalNumTypes();
6268 FirstIdentID = NUM_PREDEF_IDENT_IDS + Chain->getTotalNumIdentifiers();
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00006269 FirstMacroID = NUM_PREDEF_MACRO_IDS + Chain->getTotalNumMacros();
Douglas Gregor253eefe2011-12-01 00:59:36 +00006270 FirstSubmoduleID = NUM_PREDEF_SUBMODULE_IDS + Chain->getTotalNumSubmodules();
Douglas Gregordf0c1512011-08-18 04:12:04 +00006271 FirstSelectorID = NUM_PREDEF_SELECTOR_IDS + Chain->getTotalNumSelectors();
Argyrios Kyrtzidis65ad5692010-10-24 17:26:36 +00006272 NextDeclID = FirstDeclID;
6273 NextTypeID = FirstTypeID;
6274 NextIdentID = FirstIdentID;
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00006275 NextMacroID = FirstMacroID;
Argyrios Kyrtzidis65ad5692010-10-24 17:26:36 +00006276 NextSelectorID = FirstSelectorID;
Douglas Gregor253eefe2011-12-01 00:59:36 +00006277 NextSubmoduleID = FirstSubmoduleID;
Sebastian Redl07a89a82010-07-30 00:29:29 +00006278}
6279
Sebastian Redl539c5062010-08-18 23:57:32 +00006280void ASTWriter::IdentifierRead(IdentID ID, IdentifierInfo *II) {
Douglas Gregor8d7edce2013-02-08 21:30:59 +00006281 // Always keep the highest ID. See \p TypeRead() for more information.
6282 IdentID &StoredID = IdentifierIDs[II];
6283 if (ID > StoredID)
6284 StoredID = ID;
Sebastian Redlff4a2952010-07-23 23:49:55 +00006285}
6286
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00006287void ASTWriter::MacroRead(serialization::MacroID ID, MacroInfo *MI) {
Douglas Gregor8d7edce2013-02-08 21:30:59 +00006288 // Always keep the highest ID. See \p TypeRead() for more information.
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00006289 MacroID &StoredID = MacroIDs[MI];
Douglas Gregor8d7edce2013-02-08 21:30:59 +00006290 if (ID > StoredID)
6291 StoredID = ID;
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00006292}
6293
Argyrios Kyrtzidisbb5c7eae2010-08-20 16:03:59 +00006294void ASTWriter::TypeRead(TypeIdx Idx, QualType T) {
Douglas Gregor9b3932c2010-10-05 18:37:06 +00006295 // Always take the highest-numbered type index. This copes with an interesting
6296 // case for chained AST writing where we schedule writing the type and then,
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00006297 // later, deserialize the type from another AST. In this case, we want to
Douglas Gregor9b3932c2010-10-05 18:37:06 +00006298 // keep the higher-numbered entry so that we can properly write it out to
6299 // the AST file.
6300 TypeIdx &StoredIdx = TypeIdxs[T];
6301 if (Idx.getIndex() >= StoredIdx.getIndex())
6302 StoredIdx = Idx;
Sebastian Redl85b2a6a2010-07-14 23:45:08 +00006303}
6304
Sebastian Redl539c5062010-08-18 23:57:32 +00006305void ASTWriter::SelectorRead(SelectorID ID, Selector S) {
Douglas Gregor8d7edce2013-02-08 21:30:59 +00006306 // Always keep the highest ID. See \p TypeRead() for more information.
6307 SelectorID &StoredID = SelectorIDs[S];
6308 if (ID > StoredID)
6309 StoredID = ID;
Sebastian Redl834bb972010-08-04 17:20:04 +00006310}
Douglas Gregor91096292010-10-02 19:29:26 +00006311
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00006312void ASTWriter::MacroDefinitionRead(serialization::PreprocessedEntityID ID,
Richard Smith66a81862015-05-04 02:25:31 +00006313 MacroDefinitionRecord *MD) {
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00006314 assert(MacroDefinitions.find(MD) == MacroDefinitions.end());
Douglas Gregor91096292010-10-02 19:29:26 +00006315 MacroDefinitions[MD] = ID;
6316}
Argyrios Kyrtzidisd170d842010-10-24 17:26:50 +00006317
Douglas Gregore37a85a2011-12-02 17:30:13 +00006318void ASTWriter::ModuleRead(serialization::SubmoduleID ID, Module *Mod) {
6319 assert(SubmoduleIDs.find(Mod) == SubmoduleIDs.end());
6320 SubmoduleIDs[Mod] = ID;
6321}
6322
Argyrios Kyrtzidisd170d842010-10-24 17:26:50 +00006323void ASTWriter::CompletedTagDefinition(const TagDecl *D) {
Vassil Vassilev19765fb2016-07-22 21:08:24 +00006324 if (Chain && Chain->isProcessingUpdateRecords()) return;
John McCallf937c022011-10-07 06:10:15 +00006325 assert(D->isCompleteDefinition());
Douglas Gregor2fd3d402011-09-17 00:05:03 +00006326 assert(!WritingAST && "Already writing the AST!");
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00006327 if (auto *RD = dyn_cast<CXXRecordDecl>(D)) {
Argyrios Kyrtzidisd170d842010-10-24 17:26:50 +00006328 // We are interested when a PCH decl is modified.
Douglas Gregorb3722e22011-09-09 23:01:35 +00006329 if (RD->isFromASTFile()) {
Argyrios Kyrtzidisd170d842010-10-24 17:26:50 +00006330 // A forward reference was mutated into a definition. Rewrite it.
6331 // FIXME: This happens during template instantiation, should we
6332 // have created a new definition decl instead ?
Richard Smithcd45dbc2014-04-19 03:48:30 +00006333 assert(isTemplateInstantiation(RD->getTemplateSpecializationKind()) &&
6334 "completed a tag from another module but not by instantiation?");
6335 DeclUpdates[RD].push_back(
6336 DeclUpdate(UPD_CXX_INSTANTIATED_CLASS_DEFINITION));
Argyrios Kyrtzidisd170d842010-10-24 17:26:50 +00006337 }
Argyrios Kyrtzidisd170d842010-10-24 17:26:50 +00006338 }
6339}
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00006340
Richard Smithf983f7f2015-10-13 00:23:25 +00006341static bool isImportedDeclContext(ASTReader *Chain, const Decl *D) {
6342 if (D->isFromASTFile())
6343 return true;
6344
Richard Smithf983f7f2015-10-13 00:23:25 +00006345 // The predefined __va_list_tag struct is imported if we imported any decls.
6346 // FIXME: This is a gross hack.
6347 return D == D->getASTContext().getVaListTagDecl();
6348}
6349
Argyrios Kyrtzidis01c2df42010-10-28 07:38:51 +00006350void ASTWriter::AddedVisibleDecl(const DeclContext *DC, const Decl *D) {
Vassil Vassilev19765fb2016-07-22 21:08:24 +00006351 if (Chain && Chain->isProcessingUpdateRecords()) return;
6352 assert(DC->isLookupContext() &&
Vassil Vassilev71eafde2016-04-06 20:56:03 +00006353 "Should not add lookup results to non-lookup contexts!");
6354
Vassil Vassilev632eac32016-03-16 11:17:04 +00006355 // TU is handled elsewhere.
6356 if (isa<TranslationUnitDecl>(DC))
6357 return;
6358
6359 // Namespaces are handled elsewhere, except for template instantiations of
6360 // FunctionTemplateDecls in namespaces. We are interested in cases where the
6361 // local instantiations are added to an imported context. Only happens when
6362 // adding ADL lookup candidates, for example templated friends.
6363 if (isa<NamespaceDecl>(DC) && D->getFriendObjectKind() == Decl::FOK_None &&
6364 !isa<FunctionTemplateDecl>(D))
Argyrios Kyrtzidis01c2df42010-10-28 07:38:51 +00006365 return;
6366
Richard Smithf983f7f2015-10-13 00:23:25 +00006367 // We're only interested in cases where a local declaration is added to an
6368 // imported context.
6369 if (D->isFromASTFile() || !isImportedDeclContext(Chain, cast<Decl>(DC)))
6370 return;
Argyrios Kyrtzidis01c2df42010-10-28 07:38:51 +00006371
Richard Smith0f4e2c42015-08-06 04:23:48 +00006372 assert(DC == DC->getPrimaryContext() && "added to non-primary context");
Douglas Gregor9f782892013-01-21 15:25:38 +00006373 assert(!getDefinitiveDeclContext(DC) && "DeclContext not definitive!");
Richard Smithe9a8bc32014-09-30 00:45:29 +00006374 assert(!WritingAST && "Already writing the AST!");
Richard Smithf983f7f2015-10-13 00:23:25 +00006375 if (UpdatedDeclContexts.insert(DC) && !cast<Decl>(DC)->isFromASTFile()) {
6376 // We're adding a visible declaration to a predefined decl context. Ensure
6377 // that we write out all of its lookup results so we don't get a nasty
6378 // surprise when we try to emit its lookup table.
6379 for (auto *Child : DC->decls())
Richard Smithc26d9742016-10-06 20:30:51 +00006380 DeclsToEmitEvenIfUnreferenced.push_back(Child);
Richard Smithf983f7f2015-10-13 00:23:25 +00006381 }
Richard Smithc26d9742016-10-06 20:30:51 +00006382 DeclsToEmitEvenIfUnreferenced.push_back(D);
Argyrios Kyrtzidis01c2df42010-10-28 07:38:51 +00006383}
Argyrios Kyrtzidise16a5302010-10-24 17:26:54 +00006384
6385void ASTWriter::AddedCXXImplicitMember(const CXXRecordDecl *RD, const Decl *D) {
Vassil Vassilev19765fb2016-07-22 21:08:24 +00006386 if (Chain && Chain->isProcessingUpdateRecords()) return;
Argyrios Kyrtzidise16a5302010-10-24 17:26:54 +00006387 assert(D->isImplicit());
Richard Smithf983f7f2015-10-13 00:23:25 +00006388
6389 // We're only interested in cases where a local declaration is added to an
6390 // imported context.
6391 if (D->isFromASTFile() || !isImportedDeclContext(Chain, RD))
6392 return;
6393
Argyrios Kyrtzidise16a5302010-10-24 17:26:54 +00006394 if (!isa<CXXMethodDecl>(D))
Richard Smithf983f7f2015-10-13 00:23:25 +00006395 return;
Argyrios Kyrtzidise16a5302010-10-24 17:26:54 +00006396
6397 // A decl coming from PCH was modified.
John McCallf937c022011-10-07 06:10:15 +00006398 assert(RD->isCompleteDefinition());
Richard Smithe9a8bc32014-09-30 00:45:29 +00006399 assert(!WritingAST && "Already writing the AST!");
Aaron Ballman4f45b712014-03-21 15:22:56 +00006400 DeclUpdates[RD].push_back(DeclUpdate(UPD_CXX_ADDED_IMPLICIT_MEMBER, D));
Argyrios Kyrtzidise16a5302010-10-24 17:26:54 +00006401}
Argyrios Kyrtzidis402dbbb2010-10-28 07:38:42 +00006402
Richard Smith564417a2014-03-20 21:47:22 +00006403void ASTWriter::ResolvedExceptionSpec(const FunctionDecl *FD) {
Vassil Vassilev19765fb2016-07-22 21:08:24 +00006404 if (Chain && Chain->isProcessingUpdateRecords()) return;
Richard Smith9e2341d2015-03-23 03:25:59 +00006405 assert(!DoneWritingDeclsAndTypes && "Already done writing updates!");
6406 if (!Chain) return;
Richard Smith5fc18a92015-07-12 23:43:21 +00006407 Chain->forEachImportedKeyDecl(FD, [&](const Decl *D) {
Richard Smith9e2341d2015-03-23 03:25:59 +00006408 // If we don't already know the exception specification for this redecl
6409 // chain, add an update record for it.
6410 if (isUnresolvedExceptionSpec(cast<FunctionDecl>(D)
6411 ->getType()
6412 ->castAs<FunctionProtoType>()
6413 ->getExceptionSpecType()))
6414 DeclUpdates[D].push_back(UPD_CXX_RESOLVED_EXCEPTION_SPEC);
6415 });
Richard Smith564417a2014-03-20 21:47:22 +00006416}
6417
Richard Smith1fa5d642013-05-11 05:45:24 +00006418void ASTWriter::DeducedReturnType(const FunctionDecl *FD, QualType ReturnType) {
Vassil Vassilev19765fb2016-07-22 21:08:24 +00006419 if (Chain && Chain->isProcessingUpdateRecords()) return;
Richard Smith1fa5d642013-05-11 05:45:24 +00006420 assert(!WritingAST && "Already writing the AST!");
Richard Smith9e2341d2015-03-23 03:25:59 +00006421 if (!Chain) return;
Richard Smith5fc18a92015-07-12 23:43:21 +00006422 Chain->forEachImportedKeyDecl(FD, [&](const Decl *D) {
Richard Smith9e2341d2015-03-23 03:25:59 +00006423 DeclUpdates[D].push_back(
6424 DeclUpdate(UPD_CXX_DEDUCED_RETURN_TYPE, ReturnType));
6425 });
Richard Smith1fa5d642013-05-11 05:45:24 +00006426}
6427
Richard Smithf8134002015-03-10 01:41:22 +00006428void ASTWriter::ResolvedOperatorDelete(const CXXDestructorDecl *DD,
Richard Smith5b349582017-10-13 01:55:36 +00006429 const FunctionDecl *Delete,
6430 Expr *ThisArg) {
Vassil Vassilev19765fb2016-07-22 21:08:24 +00006431 if (Chain && Chain->isProcessingUpdateRecords()) return;
Richard Smithf8134002015-03-10 01:41:22 +00006432 assert(!WritingAST && "Already writing the AST!");
6433 assert(Delete && "Not given an operator delete");
Richard Smith9e2341d2015-03-23 03:25:59 +00006434 if (!Chain) return;
Richard Smith5fc18a92015-07-12 23:43:21 +00006435 Chain->forEachImportedKeyDecl(DD, [&](const Decl *D) {
Richard Smith9e2341d2015-03-23 03:25:59 +00006436 DeclUpdates[D].push_back(DeclUpdate(UPD_CXX_RESOLVED_DTOR_DELETE, Delete));
6437 });
Richard Smithf8134002015-03-10 01:41:22 +00006438}
6439
Sebastian Redlab238a72011-04-24 16:28:06 +00006440void ASTWriter::CompletedImplicitDefinition(const FunctionDecl *D) {
Vassil Vassilev19765fb2016-07-22 21:08:24 +00006441 if (Chain && Chain->isProcessingUpdateRecords()) return;
Douglas Gregor2fd3d402011-09-17 00:05:03 +00006442 assert(!WritingAST && "Already writing the AST!");
Douglas Gregorb3722e22011-09-09 23:01:35 +00006443 if (!D->isFromASTFile())
Sebastian Redlab238a72011-04-24 16:28:06 +00006444 return; // Declaration not imported from PCH.
6445
Richard Smith4d235792014-08-07 18:53:08 +00006446 // Implicit function decl from a PCH was defined.
6447 DeclUpdates[D].push_back(DeclUpdate(UPD_CXX_ADDED_FUNCTION_DEFINITION));
Sebastian Redlab238a72011-04-24 16:28:06 +00006448}
6449
Richard Smith891fc7f2017-12-05 01:31:47 +00006450void ASTWriter::VariableDefinitionInstantiated(const VarDecl *D) {
6451 if (Chain && Chain->isProcessingUpdateRecords()) return;
6452 assert(!WritingAST && "Already writing the AST!");
6453 if (!D->isFromASTFile())
6454 return;
6455
6456 DeclUpdates[D].push_back(DeclUpdate(UPD_CXX_ADDED_VAR_DEFINITION));
6457}
6458
Richard Smithd28ac5b2014-03-22 23:33:22 +00006459void ASTWriter::FunctionDefinitionInstantiated(const FunctionDecl *D) {
Vassil Vassilev19765fb2016-07-22 21:08:24 +00006460 if (Chain && Chain->isProcessingUpdateRecords()) return;
Richard Smithd28ac5b2014-03-22 23:33:22 +00006461 assert(!WritingAST && "Already writing the AST!");
6462 if (!D->isFromASTFile())
6463 return;
6464
Richard Smith9e2341d2015-03-23 03:25:59 +00006465 DeclUpdates[D].push_back(DeclUpdate(UPD_CXX_ADDED_FUNCTION_DEFINITION));
Richard Smithd28ac5b2014-03-22 23:33:22 +00006466}
6467
Richard Smith891fc7f2017-12-05 01:31:47 +00006468void ASTWriter::InstantiationRequested(const ValueDecl *D) {
Vassil Vassilev19765fb2016-07-22 21:08:24 +00006469 if (Chain && Chain->isProcessingUpdateRecords()) return;
Douglas Gregor2fd3d402011-09-17 00:05:03 +00006470 assert(!WritingAST && "Already writing the AST!");
Douglas Gregorb3722e22011-09-09 23:01:35 +00006471 if (!D->isFromASTFile())
Sebastian Redl2ac2c722011-04-29 08:19:30 +00006472 return;
6473
6474 // Since the actual instantiation is delayed, this really means that we need
6475 // to update the instantiation location.
Richard Smith891fc7f2017-12-05 01:31:47 +00006476 SourceLocation POI;
6477 if (auto *VD = dyn_cast<VarDecl>(D))
6478 POI = VD->getPointOfInstantiation();
6479 else
6480 POI = cast<FunctionDecl>(D)->getPointOfInstantiation();
6481 DeclUpdates[D].push_back(DeclUpdate(UPD_CXX_POINT_OF_INSTANTIATION, POI));
Sebastian Redl2ac2c722011-04-29 08:19:30 +00006482}
6483
John McCall32791cc2016-01-06 22:34:54 +00006484void ASTWriter::DefaultArgumentInstantiated(const ParmVarDecl *D) {
Vassil Vassilev19765fb2016-07-22 21:08:24 +00006485 if (Chain && Chain->isProcessingUpdateRecords()) return;
John McCall32791cc2016-01-06 22:34:54 +00006486 assert(!WritingAST && "Already writing the AST!");
6487 if (!D->isFromASTFile())
6488 return;
6489
6490 DeclUpdates[D].push_back(
6491 DeclUpdate(UPD_CXX_INSTANTIATED_DEFAULT_ARGUMENT, D));
6492}
6493
Richard Smith4b054b22016-08-24 21:25:37 +00006494void ASTWriter::DefaultMemberInitializerInstantiated(const FieldDecl *D) {
6495 assert(!WritingAST && "Already writing the AST!");
6496 if (!D->isFromASTFile())
6497 return;
6498
6499 DeclUpdates[D].push_back(
6500 DeclUpdate(UPD_CXX_INSTANTIATED_DEFAULT_MEMBER_INITIALIZER, D));
6501}
6502
Argyrios Kyrtzidis7d847c92011-09-01 00:58:55 +00006503void ASTWriter::AddedObjCCategoryToInterface(const ObjCCategoryDecl *CatD,
6504 const ObjCInterfaceDecl *IFD) {
Vassil Vassilev19765fb2016-07-22 21:08:24 +00006505 if (Chain && Chain->isProcessingUpdateRecords()) return;
Douglas Gregor2fd3d402011-09-17 00:05:03 +00006506 assert(!WritingAST && "Already writing the AST!");
Douglas Gregorb3722e22011-09-09 23:01:35 +00006507 if (!IFD->isFromASTFile())
Argyrios Kyrtzidis7d847c92011-09-01 00:58:55 +00006508 return; // Declaration not imported from PCH.
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00006509
Douglas Gregor404cdde2012-01-27 01:47:08 +00006510 assert(IFD->getDefinition() && "Category on a class without a definition?");
6511 ObjCClassesWithCategories.insert(
6512 const_cast<ObjCInterfaceDecl *>(IFD->getDefinition()));
Argyrios Kyrtzidis7d847c92011-09-01 00:58:55 +00006513}
Argyrios Kyrtzidisb97a4022011-11-12 21:07:46 +00006514
Eli Friedman276dd182013-09-05 00:02:25 +00006515void ASTWriter::DeclarationMarkedUsed(const Decl *D) {
Vassil Vassilev19765fb2016-07-22 21:08:24 +00006516 if (Chain && Chain->isProcessingUpdateRecords()) return;
Eli Friedman276dd182013-09-05 00:02:25 +00006517 assert(!WritingAST && "Already writing the AST!");
Vassil Vassilev928c8252016-04-28 14:13:28 +00006518
6519 // If there is *any* declaration of the entity that's not from an AST file,
6520 // we can skip writing the update record. We make sure that isUsed() triggers
6521 // completion of the redeclaration chain of the entity.
6522 for (auto Prev = D->getMostRecentDecl(); Prev; Prev = Prev->getPreviousDecl())
6523 if (IsLocalDecl(Prev))
6524 return;
Eli Friedman276dd182013-09-05 00:02:25 +00006525
Aaron Ballman4f45b712014-03-21 15:22:56 +00006526 DeclUpdates[D].push_back(DeclUpdate(UPD_DECL_MARKED_USED));
Eli Friedman276dd182013-09-05 00:02:25 +00006527}
Alexey Bataev97720002014-11-11 04:05:39 +00006528
6529void ASTWriter::DeclarationMarkedOpenMPThreadPrivate(const Decl *D) {
Vassil Vassilev19765fb2016-07-22 21:08:24 +00006530 if (Chain && Chain->isProcessingUpdateRecords()) return;
Alexey Bataev97720002014-11-11 04:05:39 +00006531 assert(!WritingAST && "Already writing the AST!");
6532 if (!D->isFromASTFile())
6533 return;
6534
6535 DeclUpdates[D].push_back(DeclUpdate(UPD_DECL_MARKED_OPENMP_THREADPRIVATE));
6536}
Richard Smith65ebb4a2015-03-26 04:09:53 +00006537
Alexey Bataev25ed0c02019-03-07 17:54:44 +00006538void ASTWriter::DeclarationMarkedOpenMPAllocate(const Decl *D, const Attr *A) {
6539 if (Chain && Chain->isProcessingUpdateRecords()) return;
6540 assert(!WritingAST && "Already writing the AST!");
6541 if (!D->isFromASTFile())
6542 return;
6543
6544 DeclUpdates[D].push_back(DeclUpdate(UPD_DECL_MARKED_OPENMP_ALLOCATE, A));
6545}
6546
Dmitry Polukhind69b5052016-05-09 14:59:13 +00006547void ASTWriter::DeclarationMarkedOpenMPDeclareTarget(const Decl *D,
6548 const Attr *Attr) {
Vassil Vassilev19765fb2016-07-22 21:08:24 +00006549 if (Chain && Chain->isProcessingUpdateRecords()) return;
Dmitry Polukhin0b0da292016-04-06 11:38:59 +00006550 assert(!WritingAST && "Already writing the AST!");
6551 if (!D->isFromASTFile())
6552 return;
6553
Dmitry Polukhind69b5052016-05-09 14:59:13 +00006554 DeclUpdates[D].push_back(
6555 DeclUpdate(UPD_DECL_MARKED_OPENMP_DECLARETARGET, Attr));
Dmitry Polukhin0b0da292016-04-06 11:38:59 +00006556}
6557
Richard Smith4caa4492015-05-15 02:34:32 +00006558void ASTWriter::RedefinedHiddenDefinition(const NamedDecl *D, Module *M) {
Vassil Vassilev19765fb2016-07-22 21:08:24 +00006559 if (Chain && Chain->isProcessingUpdateRecords()) return;
Richard Smith65ebb4a2015-03-26 04:09:53 +00006560 assert(!WritingAST && "Already writing the AST!");
6561 assert(D->isHidden() && "expected a hidden declaration");
Richard Smith4caa4492015-05-15 02:34:32 +00006562 DeclUpdates[D].push_back(DeclUpdate(UPD_DECL_EXPORTED, M));
Richard Smith65ebb4a2015-03-26 04:09:53 +00006563}
Alex Denisovfde64952015-06-26 05:28:36 +00006564
6565void ASTWriter::AddedAttributeToRecord(const Attr *Attr,
6566 const RecordDecl *Record) {
Vassil Vassilev19765fb2016-07-22 21:08:24 +00006567 if (Chain && Chain->isProcessingUpdateRecords()) return;
Alex Denisovfde64952015-06-26 05:28:36 +00006568 assert(!WritingAST && "Already writing the AST!");
6569 if (!Record->isFromASTFile())
6570 return;
6571 DeclUpdates[Record].push_back(DeclUpdate(UPD_ADDED_ATTR_TO_RECORD, Attr));
6572}
Richard Smithc26d9742016-10-06 20:30:51 +00006573
6574void ASTWriter::AddedCXXTemplateSpecialization(
6575 const ClassTemplateDecl *TD, const ClassTemplateSpecializationDecl *D) {
6576 assert(!WritingAST && "Already writing the AST!");
6577
6578 if (!TD->getFirstDecl()->isFromASTFile())
6579 return;
6580 if (Chain && Chain->isProcessingUpdateRecords())
6581 return;
6582
6583 DeclsToEmitEvenIfUnreferenced.push_back(D);
6584}
6585
6586void ASTWriter::AddedCXXTemplateSpecialization(
6587 const VarTemplateDecl *TD, const VarTemplateSpecializationDecl *D) {
6588 assert(!WritingAST && "Already writing the AST!");
6589
6590 if (!TD->getFirstDecl()->isFromASTFile())
6591 return;
6592 if (Chain && Chain->isProcessingUpdateRecords())
6593 return;
6594
6595 DeclsToEmitEvenIfUnreferenced.push_back(D);
6596}
6597
6598void ASTWriter::AddedCXXTemplateSpecialization(const FunctionTemplateDecl *TD,
6599 const FunctionDecl *D) {
6600 assert(!WritingAST && "Already writing the AST!");
6601
6602 if (!TD->getFirstDecl()->isFromASTFile())
6603 return;
6604 if (Chain && Chain->isProcessingUpdateRecords())
6605 return;
6606
6607 DeclsToEmitEvenIfUnreferenced.push_back(D);
6608}
Kelvin Libe286f52018-09-15 13:54:15 +00006609
6610//===----------------------------------------------------------------------===//
6611//// OMPClause Serialization
6612////===----------------------------------------------------------------------===//
6613
6614void OMPClauseWriter::writeClause(OMPClause *C) {
6615 Record.push_back(C->getClauseKind());
6616 Visit(C);
6617 Record.AddSourceLocation(C->getBeginLoc());
6618 Record.AddSourceLocation(C->getEndLoc());
6619}
6620
6621void OMPClauseWriter::VisitOMPClauseWithPreInit(OMPClauseWithPreInit *C) {
6622 Record.push_back(C->getCaptureRegion());
6623 Record.AddStmt(C->getPreInitStmt());
6624}
6625
6626void OMPClauseWriter::VisitOMPClauseWithPostUpdate(OMPClauseWithPostUpdate *C) {
6627 VisitOMPClauseWithPreInit(C);
6628 Record.AddStmt(C->getPostUpdateExpr());
6629}
6630
6631void OMPClauseWriter::VisitOMPIfClause(OMPIfClause *C) {
6632 VisitOMPClauseWithPreInit(C);
6633 Record.push_back(C->getNameModifier());
6634 Record.AddSourceLocation(C->getNameModifierLoc());
6635 Record.AddSourceLocation(C->getColonLoc());
6636 Record.AddStmt(C->getCondition());
6637 Record.AddSourceLocation(C->getLParenLoc());
6638}
6639
6640void OMPClauseWriter::VisitOMPFinalClause(OMPFinalClause *C) {
6641 Record.AddStmt(C->getCondition());
6642 Record.AddSourceLocation(C->getLParenLoc());
6643}
6644
6645void OMPClauseWriter::VisitOMPNumThreadsClause(OMPNumThreadsClause *C) {
6646 VisitOMPClauseWithPreInit(C);
6647 Record.AddStmt(C->getNumThreads());
6648 Record.AddSourceLocation(C->getLParenLoc());
6649}
6650
6651void OMPClauseWriter::VisitOMPSafelenClause(OMPSafelenClause *C) {
6652 Record.AddStmt(C->getSafelen());
6653 Record.AddSourceLocation(C->getLParenLoc());
6654}
6655
6656void OMPClauseWriter::VisitOMPSimdlenClause(OMPSimdlenClause *C) {
6657 Record.AddStmt(C->getSimdlen());
6658 Record.AddSourceLocation(C->getLParenLoc());
6659}
6660
Alexey Bataev9cc10fc2019-03-12 18:52:33 +00006661void OMPClauseWriter::VisitOMPAllocatorClause(OMPAllocatorClause *C) {
6662 Record.AddStmt(C->getAllocator());
6663 Record.AddSourceLocation(C->getLParenLoc());
6664}
6665
Kelvin Libe286f52018-09-15 13:54:15 +00006666void OMPClauseWriter::VisitOMPCollapseClause(OMPCollapseClause *C) {
6667 Record.AddStmt(C->getNumForLoops());
6668 Record.AddSourceLocation(C->getLParenLoc());
6669}
6670
6671void OMPClauseWriter::VisitOMPDefaultClause(OMPDefaultClause *C) {
6672 Record.push_back(C->getDefaultKind());
6673 Record.AddSourceLocation(C->getLParenLoc());
6674 Record.AddSourceLocation(C->getDefaultKindKwLoc());
6675}
6676
6677void OMPClauseWriter::VisitOMPProcBindClause(OMPProcBindClause *C) {
6678 Record.push_back(C->getProcBindKind());
6679 Record.AddSourceLocation(C->getLParenLoc());
6680 Record.AddSourceLocation(C->getProcBindKindKwLoc());
6681}
6682
6683void OMPClauseWriter::VisitOMPScheduleClause(OMPScheduleClause *C) {
6684 VisitOMPClauseWithPreInit(C);
6685 Record.push_back(C->getScheduleKind());
6686 Record.push_back(C->getFirstScheduleModifier());
6687 Record.push_back(C->getSecondScheduleModifier());
6688 Record.AddStmt(C->getChunkSize());
6689 Record.AddSourceLocation(C->getLParenLoc());
6690 Record.AddSourceLocation(C->getFirstScheduleModifierLoc());
6691 Record.AddSourceLocation(C->getSecondScheduleModifierLoc());
6692 Record.AddSourceLocation(C->getScheduleKindLoc());
6693 Record.AddSourceLocation(C->getCommaLoc());
6694}
6695
6696void OMPClauseWriter::VisitOMPOrderedClause(OMPOrderedClause *C) {
6697 Record.push_back(C->getLoopNumIterations().size());
6698 Record.AddStmt(C->getNumForLoops());
6699 for (Expr *NumIter : C->getLoopNumIterations())
6700 Record.AddStmt(NumIter);
6701 for (unsigned I = 0, E = C->getLoopNumIterations().size(); I <E; ++I)
Mike Rice0ed46662018-09-20 17:19:41 +00006702 Record.AddStmt(C->getLoopCounter(I));
Kelvin Libe286f52018-09-15 13:54:15 +00006703 Record.AddSourceLocation(C->getLParenLoc());
6704}
6705
6706void OMPClauseWriter::VisitOMPNowaitClause(OMPNowaitClause *) {}
6707
6708void OMPClauseWriter::VisitOMPUntiedClause(OMPUntiedClause *) {}
6709
6710void OMPClauseWriter::VisitOMPMergeableClause(OMPMergeableClause *) {}
6711
6712void OMPClauseWriter::VisitOMPReadClause(OMPReadClause *) {}
6713
6714void OMPClauseWriter::VisitOMPWriteClause(OMPWriteClause *) {}
6715
6716void OMPClauseWriter::VisitOMPUpdateClause(OMPUpdateClause *) {}
6717
6718void OMPClauseWriter::VisitOMPCaptureClause(OMPCaptureClause *) {}
6719
6720void OMPClauseWriter::VisitOMPSeqCstClause(OMPSeqCstClause *) {}
6721
6722void OMPClauseWriter::VisitOMPThreadsClause(OMPThreadsClause *) {}
6723
6724void OMPClauseWriter::VisitOMPSIMDClause(OMPSIMDClause *) {}
6725
6726void OMPClauseWriter::VisitOMPNogroupClause(OMPNogroupClause *) {}
6727
6728void OMPClauseWriter::VisitOMPPrivateClause(OMPPrivateClause *C) {
6729 Record.push_back(C->varlist_size());
6730 Record.AddSourceLocation(C->getLParenLoc());
6731 for (auto *VE : C->varlists()) {
6732 Record.AddStmt(VE);
6733 }
6734 for (auto *VE : C->private_copies()) {
6735 Record.AddStmt(VE);
6736 }
6737}
6738
6739void OMPClauseWriter::VisitOMPFirstprivateClause(OMPFirstprivateClause *C) {
6740 Record.push_back(C->varlist_size());
6741 VisitOMPClauseWithPreInit(C);
6742 Record.AddSourceLocation(C->getLParenLoc());
6743 for (auto *VE : C->varlists()) {
6744 Record.AddStmt(VE);
6745 }
6746 for (auto *VE : C->private_copies()) {
6747 Record.AddStmt(VE);
6748 }
6749 for (auto *VE : C->inits()) {
6750 Record.AddStmt(VE);
6751 }
6752}
6753
6754void OMPClauseWriter::VisitOMPLastprivateClause(OMPLastprivateClause *C) {
6755 Record.push_back(C->varlist_size());
6756 VisitOMPClauseWithPostUpdate(C);
6757 Record.AddSourceLocation(C->getLParenLoc());
6758 for (auto *VE : C->varlists())
6759 Record.AddStmt(VE);
6760 for (auto *E : C->private_copies())
6761 Record.AddStmt(E);
6762 for (auto *E : C->source_exprs())
6763 Record.AddStmt(E);
6764 for (auto *E : C->destination_exprs())
6765 Record.AddStmt(E);
6766 for (auto *E : C->assignment_ops())
6767 Record.AddStmt(E);
6768}
6769
6770void OMPClauseWriter::VisitOMPSharedClause(OMPSharedClause *C) {
6771 Record.push_back(C->varlist_size());
6772 Record.AddSourceLocation(C->getLParenLoc());
6773 for (auto *VE : C->varlists())
6774 Record.AddStmt(VE);
6775}
6776
6777void OMPClauseWriter::VisitOMPReductionClause(OMPReductionClause *C) {
6778 Record.push_back(C->varlist_size());
6779 VisitOMPClauseWithPostUpdate(C);
6780 Record.AddSourceLocation(C->getLParenLoc());
6781 Record.AddSourceLocation(C->getColonLoc());
6782 Record.AddNestedNameSpecifierLoc(C->getQualifierLoc());
6783 Record.AddDeclarationNameInfo(C->getNameInfo());
6784 for (auto *VE : C->varlists())
6785 Record.AddStmt(VE);
6786 for (auto *VE : C->privates())
6787 Record.AddStmt(VE);
6788 for (auto *E : C->lhs_exprs())
6789 Record.AddStmt(E);
6790 for (auto *E : C->rhs_exprs())
6791 Record.AddStmt(E);
6792 for (auto *E : C->reduction_ops())
6793 Record.AddStmt(E);
6794}
6795
6796void OMPClauseWriter::VisitOMPTaskReductionClause(OMPTaskReductionClause *C) {
6797 Record.push_back(C->varlist_size());
6798 VisitOMPClauseWithPostUpdate(C);
6799 Record.AddSourceLocation(C->getLParenLoc());
6800 Record.AddSourceLocation(C->getColonLoc());
6801 Record.AddNestedNameSpecifierLoc(C->getQualifierLoc());
6802 Record.AddDeclarationNameInfo(C->getNameInfo());
6803 for (auto *VE : C->varlists())
6804 Record.AddStmt(VE);
6805 for (auto *VE : C->privates())
6806 Record.AddStmt(VE);
6807 for (auto *E : C->lhs_exprs())
6808 Record.AddStmt(E);
6809 for (auto *E : C->rhs_exprs())
6810 Record.AddStmt(E);
6811 for (auto *E : C->reduction_ops())
6812 Record.AddStmt(E);
6813}
6814
6815void OMPClauseWriter::VisitOMPInReductionClause(OMPInReductionClause *C) {
6816 Record.push_back(C->varlist_size());
6817 VisitOMPClauseWithPostUpdate(C);
6818 Record.AddSourceLocation(C->getLParenLoc());
6819 Record.AddSourceLocation(C->getColonLoc());
6820 Record.AddNestedNameSpecifierLoc(C->getQualifierLoc());
6821 Record.AddDeclarationNameInfo(C->getNameInfo());
6822 for (auto *VE : C->varlists())
6823 Record.AddStmt(VE);
6824 for (auto *VE : C->privates())
6825 Record.AddStmt(VE);
6826 for (auto *E : C->lhs_exprs())
6827 Record.AddStmt(E);
6828 for (auto *E : C->rhs_exprs())
6829 Record.AddStmt(E);
6830 for (auto *E : C->reduction_ops())
6831 Record.AddStmt(E);
6832 for (auto *E : C->taskgroup_descriptors())
6833 Record.AddStmt(E);
6834}
6835
6836void OMPClauseWriter::VisitOMPLinearClause(OMPLinearClause *C) {
6837 Record.push_back(C->varlist_size());
6838 VisitOMPClauseWithPostUpdate(C);
6839 Record.AddSourceLocation(C->getLParenLoc());
6840 Record.AddSourceLocation(C->getColonLoc());
6841 Record.push_back(C->getModifier());
6842 Record.AddSourceLocation(C->getModifierLoc());
6843 for (auto *VE : C->varlists()) {
6844 Record.AddStmt(VE);
6845 }
6846 for (auto *VE : C->privates()) {
6847 Record.AddStmt(VE);
6848 }
6849 for (auto *VE : C->inits()) {
6850 Record.AddStmt(VE);
6851 }
6852 for (auto *VE : C->updates()) {
6853 Record.AddStmt(VE);
6854 }
6855 for (auto *VE : C->finals()) {
6856 Record.AddStmt(VE);
6857 }
6858 Record.AddStmt(C->getStep());
6859 Record.AddStmt(C->getCalcStep());
Alexey Bataev195ae902019-08-08 13:42:45 +00006860 for (auto *VE : C->used_expressions())
6861 Record.AddStmt(VE);
Kelvin Libe286f52018-09-15 13:54:15 +00006862}
6863
6864void OMPClauseWriter::VisitOMPAlignedClause(OMPAlignedClause *C) {
6865 Record.push_back(C->varlist_size());
6866 Record.AddSourceLocation(C->getLParenLoc());
6867 Record.AddSourceLocation(C->getColonLoc());
6868 for (auto *VE : C->varlists())
6869 Record.AddStmt(VE);
6870 Record.AddStmt(C->getAlignment());
6871}
6872
6873void OMPClauseWriter::VisitOMPCopyinClause(OMPCopyinClause *C) {
6874 Record.push_back(C->varlist_size());
6875 Record.AddSourceLocation(C->getLParenLoc());
6876 for (auto *VE : C->varlists())
6877 Record.AddStmt(VE);
6878 for (auto *E : C->source_exprs())
6879 Record.AddStmt(E);
6880 for (auto *E : C->destination_exprs())
6881 Record.AddStmt(E);
6882 for (auto *E : C->assignment_ops())
6883 Record.AddStmt(E);
6884}
6885
6886void OMPClauseWriter::VisitOMPCopyprivateClause(OMPCopyprivateClause *C) {
6887 Record.push_back(C->varlist_size());
6888 Record.AddSourceLocation(C->getLParenLoc());
6889 for (auto *VE : C->varlists())
6890 Record.AddStmt(VE);
6891 for (auto *E : C->source_exprs())
6892 Record.AddStmt(E);
6893 for (auto *E : C->destination_exprs())
6894 Record.AddStmt(E);
6895 for (auto *E : C->assignment_ops())
6896 Record.AddStmt(E);
6897}
6898
6899void OMPClauseWriter::VisitOMPFlushClause(OMPFlushClause *C) {
6900 Record.push_back(C->varlist_size());
6901 Record.AddSourceLocation(C->getLParenLoc());
6902 for (auto *VE : C->varlists())
6903 Record.AddStmt(VE);
6904}
6905
6906void OMPClauseWriter::VisitOMPDependClause(OMPDependClause *C) {
6907 Record.push_back(C->varlist_size());
6908 Record.push_back(C->getNumLoops());
6909 Record.AddSourceLocation(C->getLParenLoc());
6910 Record.push_back(C->getDependencyKind());
6911 Record.AddSourceLocation(C->getDependencyLoc());
6912 Record.AddSourceLocation(C->getColonLoc());
6913 for (auto *VE : C->varlists())
6914 Record.AddStmt(VE);
6915 for (unsigned I = 0, E = C->getNumLoops(); I < E; ++I)
6916 Record.AddStmt(C->getLoopData(I));
6917}
6918
6919void OMPClauseWriter::VisitOMPDeviceClause(OMPDeviceClause *C) {
6920 VisitOMPClauseWithPreInit(C);
6921 Record.AddStmt(C->getDevice());
6922 Record.AddSourceLocation(C->getLParenLoc());
6923}
6924
6925void OMPClauseWriter::VisitOMPMapClause(OMPMapClause *C) {
6926 Record.push_back(C->varlist_size());
6927 Record.push_back(C->getUniqueDeclarationsNum());
6928 Record.push_back(C->getTotalComponentListNum());
6929 Record.push_back(C->getTotalComponentsNum());
6930 Record.AddSourceLocation(C->getLParenLoc());
Kelvin Lief579432018-12-18 22:18:41 +00006931 for (unsigned I = 0; I < OMPMapClause::NumberOfModifiers; ++I) {
6932 Record.push_back(C->getMapTypeModifier(I));
6933 Record.AddSourceLocation(C->getMapTypeModifierLoc(I));
6934 }
Michael Kruse4304e9d2019-02-19 16:38:20 +00006935 Record.AddNestedNameSpecifierLoc(C->getMapperQualifierLoc());
6936 Record.AddDeclarationNameInfo(C->getMapperIdInfo());
Kelvin Libe286f52018-09-15 13:54:15 +00006937 Record.push_back(C->getMapType());
6938 Record.AddSourceLocation(C->getMapLoc());
6939 Record.AddSourceLocation(C->getColonLoc());
6940 for (auto *E : C->varlists())
6941 Record.AddStmt(E);
Michael Kruse4304e9d2019-02-19 16:38:20 +00006942 for (auto *E : C->mapperlists())
6943 Record.AddStmt(E);
Kelvin Libe286f52018-09-15 13:54:15 +00006944 for (auto *D : C->all_decls())
6945 Record.AddDeclRef(D);
6946 for (auto N : C->all_num_lists())
6947 Record.push_back(N);
6948 for (auto N : C->all_lists_sizes())
6949 Record.push_back(N);
6950 for (auto &M : C->all_components()) {
6951 Record.AddStmt(M.getAssociatedExpression());
6952 Record.AddDeclRef(M.getAssociatedDeclaration());
6953 }
6954}
6955
Alexey Bataeve04483e2019-03-27 14:14:31 +00006956void OMPClauseWriter::VisitOMPAllocateClause(OMPAllocateClause *C) {
6957 Record.push_back(C->varlist_size());
6958 Record.AddSourceLocation(C->getLParenLoc());
6959 Record.AddSourceLocation(C->getColonLoc());
6960 Record.AddStmt(C->getAllocator());
6961 for (auto *VE : C->varlists())
6962 Record.AddStmt(VE);
6963}
6964
Kelvin Libe286f52018-09-15 13:54:15 +00006965void OMPClauseWriter::VisitOMPNumTeamsClause(OMPNumTeamsClause *C) {
6966 VisitOMPClauseWithPreInit(C);
6967 Record.AddStmt(C->getNumTeams());
6968 Record.AddSourceLocation(C->getLParenLoc());
6969}
6970
6971void OMPClauseWriter::VisitOMPThreadLimitClause(OMPThreadLimitClause *C) {
6972 VisitOMPClauseWithPreInit(C);
6973 Record.AddStmt(C->getThreadLimit());
6974 Record.AddSourceLocation(C->getLParenLoc());
6975}
6976
6977void OMPClauseWriter::VisitOMPPriorityClause(OMPPriorityClause *C) {
6978 Record.AddStmt(C->getPriority());
6979 Record.AddSourceLocation(C->getLParenLoc());
6980}
6981
6982void OMPClauseWriter::VisitOMPGrainsizeClause(OMPGrainsizeClause *C) {
6983 Record.AddStmt(C->getGrainsize());
6984 Record.AddSourceLocation(C->getLParenLoc());
6985}
6986
6987void OMPClauseWriter::VisitOMPNumTasksClause(OMPNumTasksClause *C) {
6988 Record.AddStmt(C->getNumTasks());
6989 Record.AddSourceLocation(C->getLParenLoc());
6990}
6991
6992void OMPClauseWriter::VisitOMPHintClause(OMPHintClause *C) {
6993 Record.AddStmt(C->getHint());
6994 Record.AddSourceLocation(C->getLParenLoc());
6995}
6996
6997void OMPClauseWriter::VisitOMPDistScheduleClause(OMPDistScheduleClause *C) {
6998 VisitOMPClauseWithPreInit(C);
6999 Record.push_back(C->getDistScheduleKind());
7000 Record.AddStmt(C->getChunkSize());
7001 Record.AddSourceLocation(C->getLParenLoc());
7002 Record.AddSourceLocation(C->getDistScheduleKindLoc());
7003 Record.AddSourceLocation(C->getCommaLoc());
7004}
7005
7006void OMPClauseWriter::VisitOMPDefaultmapClause(OMPDefaultmapClause *C) {
7007 Record.push_back(C->getDefaultmapKind());
7008 Record.push_back(C->getDefaultmapModifier());
7009 Record.AddSourceLocation(C->getLParenLoc());
7010 Record.AddSourceLocation(C->getDefaultmapModifierLoc());
7011 Record.AddSourceLocation(C->getDefaultmapKindLoc());
7012}
7013
7014void OMPClauseWriter::VisitOMPToClause(OMPToClause *C) {
7015 Record.push_back(C->varlist_size());
7016 Record.push_back(C->getUniqueDeclarationsNum());
7017 Record.push_back(C->getTotalComponentListNum());
7018 Record.push_back(C->getTotalComponentsNum());
7019 Record.AddSourceLocation(C->getLParenLoc());
Michael Kruse01f670d2019-02-22 22:29:42 +00007020 Record.AddNestedNameSpecifierLoc(C->getMapperQualifierLoc());
7021 Record.AddDeclarationNameInfo(C->getMapperIdInfo());
Kelvin Libe286f52018-09-15 13:54:15 +00007022 for (auto *E : C->varlists())
7023 Record.AddStmt(E);
Michael Kruse01f670d2019-02-22 22:29:42 +00007024 for (auto *E : C->mapperlists())
7025 Record.AddStmt(E);
Kelvin Libe286f52018-09-15 13:54:15 +00007026 for (auto *D : C->all_decls())
7027 Record.AddDeclRef(D);
7028 for (auto N : C->all_num_lists())
7029 Record.push_back(N);
7030 for (auto N : C->all_lists_sizes())
7031 Record.push_back(N);
7032 for (auto &M : C->all_components()) {
7033 Record.AddStmt(M.getAssociatedExpression());
7034 Record.AddDeclRef(M.getAssociatedDeclaration());
7035 }
7036}
7037
7038void OMPClauseWriter::VisitOMPFromClause(OMPFromClause *C) {
7039 Record.push_back(C->varlist_size());
7040 Record.push_back(C->getUniqueDeclarationsNum());
7041 Record.push_back(C->getTotalComponentListNum());
7042 Record.push_back(C->getTotalComponentsNum());
7043 Record.AddSourceLocation(C->getLParenLoc());
Michael Kruse0336c752019-02-25 20:34:15 +00007044 Record.AddNestedNameSpecifierLoc(C->getMapperQualifierLoc());
7045 Record.AddDeclarationNameInfo(C->getMapperIdInfo());
Kelvin Libe286f52018-09-15 13:54:15 +00007046 for (auto *E : C->varlists())
7047 Record.AddStmt(E);
Michael Kruse0336c752019-02-25 20:34:15 +00007048 for (auto *E : C->mapperlists())
7049 Record.AddStmt(E);
Kelvin Libe286f52018-09-15 13:54:15 +00007050 for (auto *D : C->all_decls())
7051 Record.AddDeclRef(D);
7052 for (auto N : C->all_num_lists())
7053 Record.push_back(N);
7054 for (auto N : C->all_lists_sizes())
7055 Record.push_back(N);
7056 for (auto &M : C->all_components()) {
7057 Record.AddStmt(M.getAssociatedExpression());
7058 Record.AddDeclRef(M.getAssociatedDeclaration());
7059 }
7060}
7061
7062void OMPClauseWriter::VisitOMPUseDevicePtrClause(OMPUseDevicePtrClause *C) {
7063 Record.push_back(C->varlist_size());
7064 Record.push_back(C->getUniqueDeclarationsNum());
7065 Record.push_back(C->getTotalComponentListNum());
7066 Record.push_back(C->getTotalComponentsNum());
7067 Record.AddSourceLocation(C->getLParenLoc());
7068 for (auto *E : C->varlists())
7069 Record.AddStmt(E);
7070 for (auto *VE : C->private_copies())
7071 Record.AddStmt(VE);
7072 for (auto *VE : C->inits())
7073 Record.AddStmt(VE);
7074 for (auto *D : C->all_decls())
7075 Record.AddDeclRef(D);
7076 for (auto N : C->all_num_lists())
7077 Record.push_back(N);
7078 for (auto N : C->all_lists_sizes())
7079 Record.push_back(N);
7080 for (auto &M : C->all_components()) {
7081 Record.AddStmt(M.getAssociatedExpression());
7082 Record.AddDeclRef(M.getAssociatedDeclaration());
7083 }
7084}
7085
7086void OMPClauseWriter::VisitOMPIsDevicePtrClause(OMPIsDevicePtrClause *C) {
7087 Record.push_back(C->varlist_size());
7088 Record.push_back(C->getUniqueDeclarationsNum());
7089 Record.push_back(C->getTotalComponentListNum());
7090 Record.push_back(C->getTotalComponentsNum());
7091 Record.AddSourceLocation(C->getLParenLoc());
7092 for (auto *E : C->varlists())
7093 Record.AddStmt(E);
7094 for (auto *D : C->all_decls())
7095 Record.AddDeclRef(D);
7096 for (auto N : C->all_num_lists())
7097 Record.push_back(N);
7098 for (auto N : C->all_lists_sizes())
7099 Record.push_back(N);
7100 for (auto &M : C->all_components()) {
7101 Record.AddStmt(M.getAssociatedExpression());
7102 Record.AddDeclRef(M.getAssociatedDeclaration());
7103 }
7104}
Kelvin Li1408f912018-09-26 04:28:39 +00007105
7106void OMPClauseWriter::VisitOMPUnifiedAddressClause(OMPUnifiedAddressClause *) {}
Patrick Lyster4a370b92018-10-01 13:47:43 +00007107
7108void OMPClauseWriter::VisitOMPUnifiedSharedMemoryClause(
7109 OMPUnifiedSharedMemoryClause *) {}
Patrick Lyster6bdf63b2018-10-03 20:07:58 +00007110
7111void OMPClauseWriter::VisitOMPReverseOffloadClause(OMPReverseOffloadClause *) {}
Patrick Lyster3fe9e392018-10-11 14:41:10 +00007112
7113void
7114OMPClauseWriter::VisitOMPDynamicAllocatorsClause(OMPDynamicAllocatorsClause *) {
7115}
Patrick Lyster7a2a27c2018-11-02 12:18:11 +00007116
7117void OMPClauseWriter::VisitOMPAtomicDefaultMemOrderClause(
7118 OMPAtomicDefaultMemOrderClause *C) {
7119 Record.push_back(C->getAtomicDefaultMemOrderKind());
7120 Record.AddSourceLocation(C->getLParenLoc());
7121 Record.AddSourceLocation(C->getAtomicDefaultMemOrderKindKwLoc());
7122}