blob: 2bde4dc3946540fe0c729cfbac2c888b525e001e [file] [log] [blame]
Eugene Zelenkob7d89102017-11-11 00:08:50 +00001//===- ASTWriter.cpp - AST File Writer ------------------------------------===//
Douglas Gregoref84c4b2009-04-09 22:27:44 +00002//
3// The LLVM Compiler Infrastructure
4//
5// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
7//
8//===----------------------------------------------------------------------===//
9//
Sebastian Redl55c0ad52010-08-18 23:56:21 +000010// This file defines the ASTWriter class, which writes AST files.
Douglas Gregoref84c4b2009-04-09 22:27:44 +000011//
12//===----------------------------------------------------------------------===//
13
Sebastian Redl1914c6f2010-08-18 23:56:37 +000014#include "clang/Serialization/ASTWriter.h"
Argyrios Kyrtzidis4bd97102010-08-20 16:03:52 +000015#include "ASTCommon.h"
Richard Smithd88a7f12015-09-01 20:35:42 +000016#include "ASTReaderInternals.h"
17#include "MultiOnDiskHashTable.h"
Douglas Gregoref84c4b2009-04-09 22:27:44 +000018#include "clang/AST/ASTContext.h"
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +000019#include "clang/AST/ASTUnresolvedSet.h"
Eugene Zelenkob7d89102017-11-11 00:08:50 +000020#include "clang/AST/Attr.h"
Douglas Gregoref84c4b2009-04-09 22:27:44 +000021#include "clang/AST/Decl.h"
Eugene Zelenkob7d89102017-11-11 00:08:50 +000022#include "clang/AST/DeclBase.h"
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +000023#include "clang/AST/DeclCXX.h"
Duncan P. N. Exon Smith60fa2882017-03-13 18:45:08 +000024#include "clang/AST/DeclContextInternals.h"
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +000025#include "clang/AST/DeclFriend.h"
Eugene Zelenkob7d89102017-11-11 00:08:50 +000026#include "clang/AST/DeclObjC.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000027#include "clang/AST/DeclTemplate.h"
Eugene Zelenkob7d89102017-11-11 00:08:50 +000028#include "clang/AST/DeclarationName.h"
Douglas Gregorfeb84b02009-04-14 21:18:50 +000029#include "clang/AST/Expr.h"
John McCallbfd822c2010-08-24 07:32:53 +000030#include "clang/AST/ExprCXX.h"
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +000031#include "clang/AST/LambdaCapture.h"
32#include "clang/AST/NestedNameSpecifier.h"
33#include "clang/AST/RawCommentList.h"
34#include "clang/AST/TemplateName.h"
Douglas Gregoref84c4b2009-04-09 22:27:44 +000035#include "clang/AST/Type.h"
John McCall8f115c62009-10-16 21:56:05 +000036#include "clang/AST/TypeLocVisitor.h"
Eugene Zelenkob7d89102017-11-11 00:08:50 +000037#include "clang/Basic/Diagnostic.h"
Benjamin Kramerf3ca26982014-05-10 16:31:55 +000038#include "clang/Basic/DiagnosticOptions.h"
Douglas Gregora7f71a92009-04-10 03:52:48 +000039#include "clang/Basic/FileManager.h"
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +000040#include "clang/Basic/FileSystemOptions.h"
Eugene Zelenkob7d89102017-11-11 00:08:50 +000041#include "clang/Basic/IdentifierTable.h"
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +000042#include "clang/Basic/LLVM.h"
Eugene Zelenkob7d89102017-11-11 00:08:50 +000043#include "clang/Basic/Lambda.h"
Duncan P. N. Exon Smith60fa2882017-03-13 18:45:08 +000044#include "clang/Basic/LangOptions.h"
Duncan P. N. Exon Smith030d7d62017-03-20 17:58:26 +000045#include "clang/Basic/MemoryBufferCache.h"
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +000046#include "clang/Basic/Module.h"
47#include "clang/Basic/ObjCRuntime.h"
Eugene Zelenkob7d89102017-11-11 00:08:50 +000048#include "clang/Basic/OpenCLOptions.h"
49#include "clang/Basic/SourceLocation.h"
Douglas Gregora7f71a92009-04-10 03:52:48 +000050#include "clang/Basic/SourceManager.h"
Douglas Gregor4c7626e2009-04-13 16:31:14 +000051#include "clang/Basic/SourceManagerInternals.h"
Eugene Zelenkob7d89102017-11-11 00:08:50 +000052#include "clang/Basic/Specifiers.h"
Douglas Gregorbfbde532009-04-10 21:16:55 +000053#include "clang/Basic/TargetInfo.h"
Douglas Gregorcb177f12012-10-16 23:40:58 +000054#include "clang/Basic/TargetOptions.h"
Douglas Gregor7b71e632009-04-27 22:23:34 +000055#include "clang/Basic/Version.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000056#include "clang/Lex/HeaderSearch.h"
57#include "clang/Lex/HeaderSearchOptions.h"
58#include "clang/Lex/MacroInfo.h"
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +000059#include "clang/Lex/ModuleMap.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000060#include "clang/Lex/PreprocessingRecord.h"
61#include "clang/Lex/Preprocessor.h"
62#include "clang/Lex/PreprocessorOptions.h"
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +000063#include "clang/Lex/Token.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000064#include "clang/Sema/IdentifierResolver.h"
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +000065#include "clang/Sema/ObjCMethodList.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000066#include "clang/Sema/Sema.h"
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +000067#include "clang/Sema/Weak.h"
Chandler Carruth3a022472012-12-04 09:13:33 +000068#include "clang/Serialization/ASTReader.h"
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +000069#include "clang/Serialization/Module.h"
Mehdi Amini9670f842016-07-18 19:02:11 +000070#include "clang/Serialization/ModuleFileExtension.h"
Richard Smithb5aaf5a2015-09-01 02:35:58 +000071#include "clang/Serialization/SerializationDiagnostic.h"
Douglas Gregore0a3a512009-04-14 21:55:33 +000072#include "llvm/ADT/APFloat.h"
73#include "llvm/ADT/APInt.h"
Eugene Zelenkob7d89102017-11-11 00:08:50 +000074#include "llvm/ADT/APSInt.h"
75#include "llvm/ADT/ArrayRef.h"
76#include "llvm/ADT/DenseMap.h"
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +000077#include "llvm/ADT/Hashing.h"
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +000078#include "llvm/ADT/Optional.h"
Eugene Zelenkob7d89102017-11-11 00:08:50 +000079#include "llvm/ADT/PointerIntPair.h"
Duncan P. N. Exon Smith60fa2882017-03-13 18:45:08 +000080#include "llvm/ADT/STLExtras.h"
Ilya Biryukov45643102018-07-09 11:33:23 +000081#include "llvm/ADT/ScopeExit.h"
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +000082#include "llvm/ADT/SmallSet.h"
83#include "llvm/ADT/SmallString.h"
Eugene Zelenkob7d89102017-11-11 00:08:50 +000084#include "llvm/ADT/SmallVector.h"
Eugene Zelenkob7d89102017-11-11 00:08:50 +000085#include "llvm/ADT/StringMap.h"
86#include "llvm/ADT/StringRef.h"
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +000087#include "llvm/Bitcode/BitCodes.h"
Douglas Gregoref84c4b2009-04-09 22:27:44 +000088#include "llvm/Bitcode/BitstreamWriter.h"
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +000089#include "llvm/Support/Casting.h"
Richard Smithaada85c2016-02-06 02:06:43 +000090#include "llvm/Support/Compression.h"
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +000091#include "llvm/Support/DJB.h"
Eugene Zelenkob7d89102017-11-11 00:08:50 +000092#include "llvm/Support/Endian.h"
Justin Bognere1c147c2014-03-28 22:03:19 +000093#include "llvm/Support/EndianStream.h"
George Rimarc39f5492017-01-17 15:45:31 +000094#include "llvm/Support/Error.h"
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +000095#include "llvm/Support/ErrorHandling.h"
Douglas Gregora7f71a92009-04-10 03:52:48 +000096#include "llvm/Support/MemoryBuffer.h"
Justin Bognerbb094f02014-04-18 19:57:06 +000097#include "llvm/Support/OnDiskHashTable.h"
Michael J. Spencer8aaf4992010-11-29 18:12:39 +000098#include "llvm/Support/Path.h"
Duncan P. N. Exon Smith60fa2882017-03-13 18:45:08 +000099#include "llvm/Support/SHA1.h"
Pavel Labathd8c62902018-06-11 10:28:04 +0000100#include "llvm/Support/VersionTuple.h"
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000101#include "llvm/Support/raw_ostream.h"
Douglas Gregor925296b2011-07-19 16:10:42 +0000102#include <algorithm>
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000103#include <cassert>
104#include <cstdint>
105#include <cstdlib>
106#include <cstring>
Eugene Zelenkob7d89102017-11-11 00:08:50 +0000107#include <ctime>
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000108#include <deque>
109#include <limits>
Eugene Zelenkob7d89102017-11-11 00:08:50 +0000110#include <memory>
111#include <queue>
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000112#include <tuple>
Douglas Gregor925296b2011-07-19 16:10:42 +0000113#include <utility>
Eugene Zelenkob7d89102017-11-11 00:08:50 +0000114#include <vector>
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +0000115
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000116using namespace clang;
Sebastian Redl539c5062010-08-18 23:57:32 +0000117using namespace clang::serialization;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000118
Sebastian Redl3df5a082010-07-30 17:03:48 +0000119template <typename T, typename Allocator>
Reid Kleckner012665e2015-05-21 00:13:09 +0000120static StringRef bytes(const std::vector<T, Allocator> &v) {
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000121 if (v.empty()) return StringRef();
122 return StringRef(reinterpret_cast<const char*>(&v[0]),
Benjamin Kramerd47a12a2011-04-24 17:44:50 +0000123 sizeof(T) * v.size());
Sebastian Redl3df5a082010-07-30 17:03:48 +0000124}
Benjamin Kramerd47a12a2011-04-24 17:44:50 +0000125
126template <typename T>
Reid Kleckner012665e2015-05-21 00:13:09 +0000127static StringRef bytes(const SmallVectorImpl<T> &v) {
Chris Lattner0e62c1c2011-07-23 10:55:15 +0000128 return StringRef(reinterpret_cast<const char*>(v.data()),
Benjamin Kramerd47a12a2011-04-24 17:44:50 +0000129 sizeof(T) * v.size());
Sebastian Redl3df5a082010-07-30 17:03:48 +0000130}
131
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000132//===----------------------------------------------------------------------===//
133// Type serialization
134//===----------------------------------------------------------------------===//
Chris Lattner7099dbc2009-04-27 06:16:06 +0000135
Richard Smith290d8012016-04-06 17:06:00 +0000136namespace clang {
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000137
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000138 class ASTTypeWriter {
Sebastian Redl55c0ad52010-08-18 23:56:21 +0000139 ASTWriter &Writer;
Richard Smith69c82bf2016-04-01 22:52:03 +0000140 ASTRecordWriter Record;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000141
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000142 /// Type code that corresponds to the record generated.
Eugene Zelenkob7d89102017-11-11 00:08:50 +0000143 TypeCode Code = static_cast<TypeCode>(0);
144
Adrian Prantl9fc8faf2018-05-09 01:00:01 +0000145 /// Abbreviation to use for the record, if any.
Eugene Zelenkob7d89102017-11-11 00:08:50 +0000146 unsigned AbbrevToUse = 0;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000147
Richard Smith290d8012016-04-06 17:06:00 +0000148 public:
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +0000149 ASTTypeWriter(ASTWriter &Writer, ASTWriter::RecordDataImpl &Record)
Eugene Zelenkob7d89102017-11-11 00:08:50 +0000150 : Writer(Writer), Record(Writer, Record) {}
Richard Smith290d8012016-04-06 17:06:00 +0000151
152 uint64_t Emit() {
153 return Record.Emit(Code, AbbrevToUse);
154 }
155
156 void Visit(QualType T) {
157 if (T.hasLocalNonFastQualifiers()) {
158 Qualifiers Qs = T.getLocalQualifiers();
159 Record.AddTypeRef(T.getLocalUnqualifiedType());
160 Record.push_back(Qs.getAsOpaqueValue());
161 Code = TYPE_EXT_QUAL;
162 AbbrevToUse = Writer.TypeExtQualAbbrev;
163 } else {
164 switch (T->getTypeClass()) {
165 // For all of the concrete, non-dependent types, call the
166 // appropriate visitor function.
167#define TYPE(Class, Base) \
168 case Type::Class: Visit##Class##Type(cast<Class##Type>(T)); break;
169#define ABSTRACT_TYPE(Class, Base)
170#include "clang/AST/TypeNodes.def"
171 }
172 }
173 }
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000174
175 void VisitArrayType(const ArrayType *T);
176 void VisitFunctionType(const FunctionType *T);
177 void VisitTagType(const TagType *T);
178
179#define TYPE(Class, Base) void Visit##Class##Type(const Class##Type *T);
180#define ABSTRACT_TYPE(Class, Base)
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000181#include "clang/AST/TypeNodes.def"
182 };
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000183
Eugene Zelenkob7d89102017-11-11 00:08:50 +0000184} // namespace clang
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000185
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000186void ASTTypeWriter::VisitBuiltinType(const BuiltinType *T) {
David Blaikie83d382b2011-09-23 05:06:16 +0000187 llvm_unreachable("Built-in types are never serialized");
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000188}
189
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000190void ASTTypeWriter::VisitComplexType(const ComplexType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000191 Record.AddTypeRef(T->getElementType());
Sebastian Redl539c5062010-08-18 23:57:32 +0000192 Code = TYPE_COMPLEX;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000193}
194
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000195void ASTTypeWriter::VisitPointerType(const PointerType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000196 Record.AddTypeRef(T->getPointeeType());
Sebastian Redl539c5062010-08-18 23:57:32 +0000197 Code = TYPE_POINTER;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000198}
199
Reid Kleckner8a365022013-06-24 17:51:48 +0000200void ASTTypeWriter::VisitDecayedType(const DecayedType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000201 Record.AddTypeRef(T->getOriginalType());
Reid Kleckner8a365022013-06-24 17:51:48 +0000202 Code = TYPE_DECAYED;
203}
204
Reid Kleckner0503a872013-12-05 01:23:43 +0000205void ASTTypeWriter::VisitAdjustedType(const AdjustedType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000206 Record.AddTypeRef(T->getOriginalType());
207 Record.AddTypeRef(T->getAdjustedType());
Reid Kleckner0503a872013-12-05 01:23:43 +0000208 Code = TYPE_ADJUSTED;
209}
210
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000211void ASTTypeWriter::VisitBlockPointerType(const BlockPointerType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000212 Record.AddTypeRef(T->getPointeeType());
Sebastian Redl539c5062010-08-18 23:57:32 +0000213 Code = TYPE_BLOCK_POINTER;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000214}
215
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000216void ASTTypeWriter::VisitLValueReferenceType(const LValueReferenceType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000217 Record.AddTypeRef(T->getPointeeTypeAsWritten());
Richard Smith0f538462011-04-12 10:38:03 +0000218 Record.push_back(T->isSpelledAsLValue());
Sebastian Redl539c5062010-08-18 23:57:32 +0000219 Code = TYPE_LVALUE_REFERENCE;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000220}
221
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000222void ASTTypeWriter::VisitRValueReferenceType(const RValueReferenceType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000223 Record.AddTypeRef(T->getPointeeTypeAsWritten());
Sebastian Redl539c5062010-08-18 23:57:32 +0000224 Code = TYPE_RVALUE_REFERENCE;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000225}
226
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000227void ASTTypeWriter::VisitMemberPointerType(const MemberPointerType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000228 Record.AddTypeRef(T->getPointeeType());
229 Record.AddTypeRef(QualType(T->getClass(), 0));
Sebastian Redl539c5062010-08-18 23:57:32 +0000230 Code = TYPE_MEMBER_POINTER;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000231}
232
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000233void ASTTypeWriter::VisitArrayType(const ArrayType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000234 Record.AddTypeRef(T->getElementType());
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000235 Record.push_back(T->getSizeModifier()); // FIXME: stable values
John McCall8ccfcb52009-09-24 19:53:00 +0000236 Record.push_back(T->getIndexTypeCVRQualifiers()); // FIXME: stable values
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000237}
238
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000239void ASTTypeWriter::VisitConstantArrayType(const ConstantArrayType *T) {
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000240 VisitArrayType(T);
Richard Smith69c82bf2016-04-01 22:52:03 +0000241 Record.AddAPInt(T->getSize());
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());
313 Record.push_back(T->getTypeQuals());
314 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
Richard Smith01b2cb42014-07-26 06:37:51 +0000326 if (T->isVariadic() || T->hasTrailingReturn() || T->getTypeQuals() ||
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())
373 Record.push_back(T->isDependentType());
Richard Smith30482bc2011-02-20 03:19:35 +0000374 Code = TYPE_AUTO;
375}
376
Richard Smith600b5262017-01-26 20:40:47 +0000377void ASTTypeWriter::VisitDeducedTemplateSpecializationType(
378 const DeducedTemplateSpecializationType *T) {
379 Record.AddTemplateName(T->getTemplateName());
380 Record.AddTypeRef(T->getDeducedType());
381 if (T->getDeducedType().isNull())
382 Record.push_back(T->isDependentType());
383 Code = TYPE_DEDUCED_TEMPLATE_SPECIALIZATION;
384}
385
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000386void ASTTypeWriter::VisitTagType(const TagType *T) {
Argyrios Kyrtzidisa4ed1812010-07-08 13:09:53 +0000387 Record.push_back(T->isDependentType());
Richard Smith69c82bf2016-04-01 22:52:03 +0000388 Record.AddDeclRef(T->getDecl()->getCanonicalDecl());
Mike Stump11289f42009-09-09 15:08:12 +0000389 assert(!T->isBeingDefined() &&
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000390 "Cannot serialize in the middle of a type definition");
391}
392
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000393void ASTTypeWriter::VisitRecordType(const RecordType *T) {
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000394 VisitTagType(T);
Sebastian Redl539c5062010-08-18 23:57:32 +0000395 Code = TYPE_RECORD;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000396}
397
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000398void ASTTypeWriter::VisitEnumType(const EnumType *T) {
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000399 VisitTagType(T);
Sebastian Redl539c5062010-08-18 23:57:32 +0000400 Code = TYPE_ENUM;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000401}
402
John McCall81904512011-01-06 01:58:22 +0000403void ASTTypeWriter::VisitAttributedType(const AttributedType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000404 Record.AddTypeRef(T->getModifiedType());
405 Record.AddTypeRef(T->getEquivalentType());
John McCall81904512011-01-06 01:58:22 +0000406 Record.push_back(T->getAttrKind());
407 Code = TYPE_ATTRIBUTED;
408}
409
Mike Stump11289f42009-09-09 15:08:12 +0000410void
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000411ASTTypeWriter::VisitSubstTemplateTypeParmType(
John McCallcebee162009-10-18 09:09:24 +0000412 const SubstTemplateTypeParmType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000413 Record.AddTypeRef(QualType(T->getReplacedParameter(), 0));
414 Record.AddTypeRef(T->getReplacementType());
Sebastian Redl539c5062010-08-18 23:57:32 +0000415 Code = TYPE_SUBST_TEMPLATE_TYPE_PARM;
John McCallcebee162009-10-18 09:09:24 +0000416}
417
418void
Douglas Gregorada4b792011-01-14 02:55:32 +0000419ASTTypeWriter::VisitSubstTemplateTypeParmPackType(
420 const SubstTemplateTypeParmPackType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000421 Record.AddTypeRef(QualType(T->getReplacedParameter(), 0));
422 Record.AddTemplateArgument(T->getArgumentPack());
Douglas Gregorada4b792011-01-14 02:55:32 +0000423 Code = TYPE_SUBST_TEMPLATE_TYPE_PARM_PACK;
424}
425
426void
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000427ASTTypeWriter::VisitTemplateSpecializationType(
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000428 const TemplateSpecializationType *T) {
Argyrios Kyrtzidisa4ed1812010-07-08 13:09:53 +0000429 Record.push_back(T->isDependentType());
Richard Smith69c82bf2016-04-01 22:52:03 +0000430 Record.AddTemplateName(T->getTemplateName());
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +0000431 Record.push_back(T->getNumArgs());
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +0000432 for (const auto &ArgI : *T)
Richard Smith69c82bf2016-04-01 22:52:03 +0000433 Record.AddTemplateArgument(ArgI);
434 Record.AddTypeRef(T->isTypeAlias() ? T->getAliasedType()
435 : T->isCanonicalUnqualified()
436 ? QualType()
437 : T->getCanonicalTypeInternal());
Sebastian Redl539c5062010-08-18 23:57:32 +0000438 Code = TYPE_TEMPLATE_SPECIALIZATION;
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +0000439}
440
441void
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000442ASTTypeWriter::VisitDependentSizedArrayType(const DependentSizedArrayType *T) {
Argyrios Kyrtzidis4a57bd02010-06-30 08:49:25 +0000443 VisitArrayType(T);
Richard Smith290d8012016-04-06 17:06:00 +0000444 Record.AddStmt(T->getSizeExpr());
Richard Smith69c82bf2016-04-01 22:52:03 +0000445 Record.AddSourceRange(T->getBracketsRange());
Sebastian Redl539c5062010-08-18 23:57:32 +0000446 Code = TYPE_DEPENDENT_SIZED_ARRAY;
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +0000447}
448
449void
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000450ASTTypeWriter::VisitDependentSizedExtVectorType(
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +0000451 const DependentSizedExtVectorType *T) {
Alex Lorenz00aee432017-03-22 10:04:48 +0000452 Record.AddTypeRef(T->getElementType());
453 Record.AddStmt(T->getSizeExpr());
454 Record.AddSourceLocation(T->getAttributeLoc());
455 Code = TYPE_DEPENDENT_SIZED_EXT_VECTOR;
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +0000456}
457
Erich Keanef702b022018-07-13 19:46:04 +0000458void ASTTypeWriter::VisitDependentVectorType(const DependentVectorType *T) {
459 Record.AddTypeRef(T->getElementType());
460 Record.AddStmt(const_cast<Expr*>(T->getSizeExpr()));
461 Record.AddSourceLocation(T->getAttributeLoc());
462 Record.push_back(T->getVectorKind());
463 Code = TYPE_DEPENDENT_SIZED_VECTOR;
464}
465
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +0000466void
Andrew Gozillon572bbb02017-10-02 06:25:51 +0000467ASTTypeWriter::VisitDependentAddressSpaceType(
468 const DependentAddressSpaceType *T) {
469 Record.AddTypeRef(T->getPointeeType());
470 Record.AddStmt(T->getAddrSpaceExpr());
471 Record.AddSourceLocation(T->getAttributeLoc());
472 Code = TYPE_DEPENDENT_ADDRESS_SPACE;
473}
474
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +0000475void
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000476ASTTypeWriter::VisitTemplateTypeParmType(const TemplateTypeParmType *T) {
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +0000477 Record.push_back(T->getDepth());
478 Record.push_back(T->getIndex());
479 Record.push_back(T->isParameterPack());
Richard Smith69c82bf2016-04-01 22:52:03 +0000480 Record.AddDeclRef(T->getDecl());
Sebastian Redl539c5062010-08-18 23:57:32 +0000481 Code = TYPE_TEMPLATE_TYPE_PARM;
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +0000482}
483
484void
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000485ASTTypeWriter::VisitDependentNameType(const DependentNameType *T) {
Argyrios Kyrtzidisbfcacee2010-06-24 08:57:31 +0000486 Record.push_back(T->getKeyword());
Richard Smith69c82bf2016-04-01 22:52:03 +0000487 Record.AddNestedNameSpecifier(T->getQualifier());
488 Record.AddIdentifierRef(T->getIdentifier());
489 Record.AddTypeRef(
490 T->isCanonicalUnqualified() ? QualType() : T->getCanonicalTypeInternal());
Sebastian Redl539c5062010-08-18 23:57:32 +0000491 Code = TYPE_DEPENDENT_NAME;
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +0000492}
493
494void
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000495ASTTypeWriter::VisitDependentTemplateSpecializationType(
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +0000496 const DependentTemplateSpecializationType *T) {
Argyrios Kyrtzidisf0f7a792010-06-25 16:24:58 +0000497 Record.push_back(T->getKeyword());
Richard Smith69c82bf2016-04-01 22:52:03 +0000498 Record.AddNestedNameSpecifier(T->getQualifier());
499 Record.AddIdentifierRef(T->getIdentifier());
Argyrios Kyrtzidisf0f7a792010-06-25 16:24:58 +0000500 Record.push_back(T->getNumArgs());
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +0000501 for (const auto &I : *T)
Richard Smith69c82bf2016-04-01 22:52:03 +0000502 Record.AddTemplateArgument(I);
Sebastian Redl539c5062010-08-18 23:57:32 +0000503 Code = TYPE_DEPENDENT_TEMPLATE_SPECIALIZATION;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000504}
505
Douglas Gregord2fa7662010-12-20 02:24:11 +0000506void ASTTypeWriter::VisitPackExpansionType(const PackExpansionType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000507 Record.AddTypeRef(T->getPattern());
David Blaikie05785d12013-02-20 22:23:23 +0000508 if (Optional<unsigned> NumExpansions = T->getNumExpansions())
Douglas Gregor0dca5fd2011-01-14 17:04:44 +0000509 Record.push_back(*NumExpansions + 1);
510 else
511 Record.push_back(0);
Douglas Gregord2fa7662010-12-20 02:24:11 +0000512 Code = TYPE_PACK_EXPANSION;
513}
514
Abramo Bagnara924a8f32010-12-10 16:29:40 +0000515void ASTTypeWriter::VisitParenType(const ParenType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000516 Record.AddTypeRef(T->getInnerType());
Abramo Bagnara924a8f32010-12-10 16:29:40 +0000517 Code = TYPE_PAREN;
518}
519
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000520void ASTTypeWriter::VisitElaboratedType(const ElaboratedType *T) {
Abramo Bagnara6150c882010-05-11 21:36:43 +0000521 Record.push_back(T->getKeyword());
Richard Smith69c82bf2016-04-01 22:52:03 +0000522 Record.AddNestedNameSpecifier(T->getQualifier());
523 Record.AddTypeRef(T->getNamedType());
Joel E. Denny7509a2f2018-05-14 19:36:45 +0000524 Record.AddDeclRef(T->getOwnedTagDecl());
Sebastian Redl539c5062010-08-18 23:57:32 +0000525 Code = TYPE_ELABORATED;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000526}
527
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000528void ASTTypeWriter::VisitInjectedClassNameType(const InjectedClassNameType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000529 Record.AddDeclRef(T->getDecl()->getCanonicalDecl());
530 Record.AddTypeRef(T->getInjectedSpecializationType());
Sebastian Redl539c5062010-08-18 23:57:32 +0000531 Code = TYPE_INJECTED_CLASS_NAME;
John McCalle78aac42010-03-10 03:28:59 +0000532}
533
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000534void ASTTypeWriter::VisitObjCInterfaceType(const ObjCInterfaceType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000535 Record.AddDeclRef(T->getDecl()->getCanonicalDecl());
Sebastian Redl539c5062010-08-18 23:57:32 +0000536 Code = TYPE_OBJC_INTERFACE;
John McCall8b07ec22010-05-15 11:32:37 +0000537}
538
Manman Rene6be26c2016-09-13 17:25:08 +0000539void ASTTypeWriter::VisitObjCTypeParamType(const ObjCTypeParamType *T) {
540 Record.AddDeclRef(T->getDecl());
541 Record.push_back(T->getNumProtocols());
542 for (const auto *I : T->quals())
543 Record.AddDeclRef(I);
544 Code = TYPE_OBJC_TYPE_PARAM;
545}
546
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000547void ASTTypeWriter::VisitObjCObjectType(const ObjCObjectType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000548 Record.AddTypeRef(T->getBaseType());
Douglas Gregore83b9562015-07-07 03:57:53 +0000549 Record.push_back(T->getTypeArgsAsWritten().size());
550 for (auto TypeArg : T->getTypeArgsAsWritten())
Richard Smith69c82bf2016-04-01 22:52:03 +0000551 Record.AddTypeRef(TypeArg);
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000552 Record.push_back(T->getNumProtocols());
Aaron Ballman1683f7b2014-03-17 15:55:30 +0000553 for (const auto *I : T->quals())
Richard Smith69c82bf2016-04-01 22:52:03 +0000554 Record.AddDeclRef(I);
Douglas Gregorab209d82015-07-07 03:58:42 +0000555 Record.push_back(T->isKindOfTypeAsWritten());
Sebastian Redl539c5062010-08-18 23:57:32 +0000556 Code = TYPE_OBJC_OBJECT;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000557}
558
Steve Narofffb4330f2009-06-17 22:40:22 +0000559void
Sebastian Redl42a0f6a2010-08-18 23:56:27 +0000560ASTTypeWriter::VisitObjCObjectPointerType(const ObjCObjectPointerType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000561 Record.AddTypeRef(T->getPointeeType());
Sebastian Redl539c5062010-08-18 23:57:32 +0000562 Code = TYPE_OBJC_OBJECT_POINTER;
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000563}
564
Eli Friedman0dfb8892011-10-06 23:00:33 +0000565void
566ASTTypeWriter::VisitAtomicType(const AtomicType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000567 Record.AddTypeRef(T->getValueType());
Eli Friedman0dfb8892011-10-06 23:00:33 +0000568 Code = TYPE_ATOMIC;
569}
570
Xiuli Pan9c14e282016-01-09 12:53:17 +0000571void
572ASTTypeWriter::VisitPipeType(const PipeType *T) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000573 Record.AddTypeRef(T->getElementType());
Joey Goulye3c85de2016-12-01 11:30:49 +0000574 Record.push_back(T->isReadOnly());
575 Code = TYPE_PIPE;
Xiuli Pan9c14e282016-01-09 12:53:17 +0000576}
577
John McCall8f115c62009-10-16 21:56:05 +0000578namespace {
579
580class TypeLocWriter : public TypeLocVisitor<TypeLocWriter> {
Richard Smith290d8012016-04-06 17:06:00 +0000581 ASTRecordWriter &Record;
John McCall8f115c62009-10-16 21:56:05 +0000582
583public:
Eugene Zelenkob7d89102017-11-11 00:08:50 +0000584 TypeLocWriter(ASTRecordWriter &Record) : Record(Record) {}
John McCall8f115c62009-10-16 21:56:05 +0000585
John McCall17001972009-10-18 01:05:36 +0000586#define ABSTRACT_TYPELOC(CLASS, PARENT)
John McCall8f115c62009-10-16 21:56:05 +0000587#define TYPELOC(CLASS, PARENT) \
John McCall17001972009-10-18 01:05:36 +0000588 void Visit##CLASS##TypeLoc(CLASS##TypeLoc TyLoc);
John McCall8f115c62009-10-16 21:56:05 +0000589#include "clang/AST/TypeLocNodes.def"
590
John McCall17001972009-10-18 01:05:36 +0000591 void VisitArrayTypeLoc(ArrayTypeLoc TyLoc);
592 void VisitFunctionTypeLoc(FunctionTypeLoc TyLoc);
John McCall8f115c62009-10-16 21:56:05 +0000593};
594
Eugene Zelenkob7d89102017-11-11 00:08:50 +0000595} // namespace
John McCall8f115c62009-10-16 21:56:05 +0000596
John McCall17001972009-10-18 01:05:36 +0000597void TypeLocWriter::VisitQualifiedTypeLoc(QualifiedTypeLoc TL) {
598 // nothing to do
John McCall8f115c62009-10-16 21:56:05 +0000599}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000600
John McCall17001972009-10-18 01:05:36 +0000601void TypeLocWriter::VisitBuiltinTypeLoc(BuiltinTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000602 Record.AddSourceLocation(TL.getBuiltinLoc());
Douglas Gregorc9b7a592010-01-18 18:04:31 +0000603 if (TL.needsExtraLocalData()) {
Faisal Vali090da2d2018-01-01 18:23:28 +0000604 Record.push_back(TL.getWrittenTypeSpec());
605 Record.push_back(TL.getWrittenSignSpec());
606 Record.push_back(TL.getWrittenWidthSpec());
Douglas Gregorc9b7a592010-01-18 18:04:31 +0000607 Record.push_back(TL.hasModeAttr());
608 }
John McCall8f115c62009-10-16 21:56:05 +0000609}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000610
John McCall17001972009-10-18 01:05:36 +0000611void TypeLocWriter::VisitComplexTypeLoc(ComplexTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000612 Record.AddSourceLocation(TL.getNameLoc());
John McCall8f115c62009-10-16 21:56:05 +0000613}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000614
John McCall17001972009-10-18 01:05:36 +0000615void TypeLocWriter::VisitPointerTypeLoc(PointerTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000616 Record.AddSourceLocation(TL.getStarLoc());
John McCall8f115c62009-10-16 21:56:05 +0000617}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000618
Reid Kleckner8a365022013-06-24 17:51:48 +0000619void TypeLocWriter::VisitDecayedTypeLoc(DecayedTypeLoc TL) {
620 // nothing to do
621}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000622
Reid Kleckner0503a872013-12-05 01:23:43 +0000623void TypeLocWriter::VisitAdjustedTypeLoc(AdjustedTypeLoc TL) {
624 // nothing to do
625}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000626
John McCall17001972009-10-18 01:05:36 +0000627void TypeLocWriter::VisitBlockPointerTypeLoc(BlockPointerTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000628 Record.AddSourceLocation(TL.getCaretLoc());
John McCall8f115c62009-10-16 21:56:05 +0000629}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000630
John McCall17001972009-10-18 01:05:36 +0000631void TypeLocWriter::VisitLValueReferenceTypeLoc(LValueReferenceTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000632 Record.AddSourceLocation(TL.getAmpLoc());
John McCall8f115c62009-10-16 21:56:05 +0000633}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000634
John McCall17001972009-10-18 01:05:36 +0000635void TypeLocWriter::VisitRValueReferenceTypeLoc(RValueReferenceTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000636 Record.AddSourceLocation(TL.getAmpAmpLoc());
John McCall8f115c62009-10-16 21:56:05 +0000637}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000638
John McCall17001972009-10-18 01:05:36 +0000639void TypeLocWriter::VisitMemberPointerTypeLoc(MemberPointerTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000640 Record.AddSourceLocation(TL.getStarLoc());
641 Record.AddTypeSourceInfo(TL.getClassTInfo());
John McCall8f115c62009-10-16 21:56:05 +0000642}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000643
John McCall17001972009-10-18 01:05:36 +0000644void TypeLocWriter::VisitArrayTypeLoc(ArrayTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000645 Record.AddSourceLocation(TL.getLBracketLoc());
646 Record.AddSourceLocation(TL.getRBracketLoc());
John McCall17001972009-10-18 01:05:36 +0000647 Record.push_back(TL.getSizeExpr() ? 1 : 0);
648 if (TL.getSizeExpr())
Richard Smith290d8012016-04-06 17:06:00 +0000649 Record.AddStmt(TL.getSizeExpr());
John McCall8f115c62009-10-16 21:56:05 +0000650}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000651
John McCall17001972009-10-18 01:05:36 +0000652void TypeLocWriter::VisitConstantArrayTypeLoc(ConstantArrayTypeLoc TL) {
653 VisitArrayTypeLoc(TL);
654}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000655
John McCall17001972009-10-18 01:05:36 +0000656void TypeLocWriter::VisitIncompleteArrayTypeLoc(IncompleteArrayTypeLoc TL) {
657 VisitArrayTypeLoc(TL);
658}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000659
John McCall17001972009-10-18 01:05:36 +0000660void TypeLocWriter::VisitVariableArrayTypeLoc(VariableArrayTypeLoc TL) {
661 VisitArrayTypeLoc(TL);
662}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000663
John McCall17001972009-10-18 01:05:36 +0000664void TypeLocWriter::VisitDependentSizedArrayTypeLoc(
665 DependentSizedArrayTypeLoc TL) {
666 VisitArrayTypeLoc(TL);
667}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000668
Andrew Gozillon572bbb02017-10-02 06:25:51 +0000669void TypeLocWriter::VisitDependentAddressSpaceTypeLoc(
670 DependentAddressSpaceTypeLoc TL) {
671 Record.AddSourceLocation(TL.getAttrNameLoc());
672 SourceRange range = TL.getAttrOperandParensRange();
673 Record.AddSourceLocation(range.getBegin());
674 Record.AddSourceLocation(range.getEnd());
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +0000675 Record.AddStmt(TL.getAttrExprOperand());
Andrew Gozillon572bbb02017-10-02 06:25:51 +0000676}
677
John McCall17001972009-10-18 01:05:36 +0000678void TypeLocWriter::VisitDependentSizedExtVectorTypeLoc(
679 DependentSizedExtVectorTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000680 Record.AddSourceLocation(TL.getNameLoc());
John McCall17001972009-10-18 01:05:36 +0000681}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000682
John McCall17001972009-10-18 01:05:36 +0000683void TypeLocWriter::VisitVectorTypeLoc(VectorTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000684 Record.AddSourceLocation(TL.getNameLoc());
John McCall17001972009-10-18 01:05:36 +0000685}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000686
Erich Keanef702b022018-07-13 19:46:04 +0000687void TypeLocWriter::VisitDependentVectorTypeLoc(
688 DependentVectorTypeLoc TL) {
689 Record.AddSourceLocation(TL.getNameLoc());
690}
691
John McCall17001972009-10-18 01:05:36 +0000692void TypeLocWriter::VisitExtVectorTypeLoc(ExtVectorTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000693 Record.AddSourceLocation(TL.getNameLoc());
John McCall17001972009-10-18 01:05:36 +0000694}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000695
John McCall17001972009-10-18 01:05:36 +0000696void TypeLocWriter::VisitFunctionTypeLoc(FunctionTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000697 Record.AddSourceLocation(TL.getLocalRangeBegin());
698 Record.AddSourceLocation(TL.getLParenLoc());
699 Record.AddSourceLocation(TL.getRParenLoc());
Malcolm Parsonsa3220ce2017-01-12 16:11:28 +0000700 Record.AddSourceRange(TL.getExceptionSpecRange());
Richard Smith69c82bf2016-04-01 22:52:03 +0000701 Record.AddSourceLocation(TL.getLocalRangeEnd());
Alp Tokerb3fd5cf2014-01-21 00:32:38 +0000702 for (unsigned i = 0, e = TL.getNumParams(); i != e; ++i)
Richard Smith69c82bf2016-04-01 22:52:03 +0000703 Record.AddDeclRef(TL.getParam(i));
John McCall17001972009-10-18 01:05:36 +0000704}
Eugene Zelenkob7d89102017-11-11 00:08:50 +0000705
John McCall17001972009-10-18 01:05:36 +0000706void TypeLocWriter::VisitFunctionProtoTypeLoc(FunctionProtoTypeLoc TL) {
707 VisitFunctionTypeLoc(TL);
708}
Eugene Zelenkob7d89102017-11-11 00:08:50 +0000709
John McCall17001972009-10-18 01:05:36 +0000710void TypeLocWriter::VisitFunctionNoProtoTypeLoc(FunctionNoProtoTypeLoc TL) {
711 VisitFunctionTypeLoc(TL);
712}
Eugene Zelenkob7d89102017-11-11 00:08:50 +0000713
John McCallb96ec562009-12-04 22:46:56 +0000714void TypeLocWriter::VisitUnresolvedUsingTypeLoc(UnresolvedUsingTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000715 Record.AddSourceLocation(TL.getNameLoc());
John McCallb96ec562009-12-04 22:46:56 +0000716}
Eugene Zelenkob7d89102017-11-11 00:08:50 +0000717
John McCall17001972009-10-18 01:05:36 +0000718void TypeLocWriter::VisitTypedefTypeLoc(TypedefTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000719 Record.AddSourceLocation(TL.getNameLoc());
John McCall17001972009-10-18 01:05:36 +0000720}
Eugene Zelenkob7d89102017-11-11 00:08:50 +0000721
Manman Rene6be26c2016-09-13 17:25:08 +0000722void TypeLocWriter::VisitObjCTypeParamTypeLoc(ObjCTypeParamTypeLoc TL) {
723 if (TL.getNumProtocols()) {
724 Record.AddSourceLocation(TL.getProtocolLAngleLoc());
725 Record.AddSourceLocation(TL.getProtocolRAngleLoc());
726 }
727 for (unsigned i = 0, e = TL.getNumProtocols(); i != e; ++i)
728 Record.AddSourceLocation(TL.getProtocolLoc(i));
729}
Eugene Zelenkob7d89102017-11-11 00:08:50 +0000730
John McCall17001972009-10-18 01:05:36 +0000731void TypeLocWriter::VisitTypeOfExprTypeLoc(TypeOfExprTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000732 Record.AddSourceLocation(TL.getTypeofLoc());
733 Record.AddSourceLocation(TL.getLParenLoc());
734 Record.AddSourceLocation(TL.getRParenLoc());
John McCall17001972009-10-18 01:05:36 +0000735}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000736
John McCall17001972009-10-18 01:05:36 +0000737void TypeLocWriter::VisitTypeOfTypeLoc(TypeOfTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000738 Record.AddSourceLocation(TL.getTypeofLoc());
739 Record.AddSourceLocation(TL.getLParenLoc());
740 Record.AddSourceLocation(TL.getRParenLoc());
741 Record.AddTypeSourceInfo(TL.getUnderlyingTInfo());
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::VisitDecltypeTypeLoc(DecltypeTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000745 Record.AddSourceLocation(TL.getNameLoc());
John McCall17001972009-10-18 01:05:36 +0000746}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000747
Alexis Hunte852b102011-05-24 22:41:36 +0000748void TypeLocWriter::VisitUnaryTransformTypeLoc(UnaryTransformTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000749 Record.AddSourceLocation(TL.getKWLoc());
750 Record.AddSourceLocation(TL.getLParenLoc());
751 Record.AddSourceLocation(TL.getRParenLoc());
752 Record.AddTypeSourceInfo(TL.getUnderlyingTInfo());
Alexis Hunte852b102011-05-24 22:41:36 +0000753}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000754
Richard Smith30482bc2011-02-20 03:19:35 +0000755void TypeLocWriter::VisitAutoTypeLoc(AutoTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000756 Record.AddSourceLocation(TL.getNameLoc());
Richard Smith30482bc2011-02-20 03:19:35 +0000757}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000758
Richard Smith600b5262017-01-26 20:40:47 +0000759void TypeLocWriter::VisitDeducedTemplateSpecializationTypeLoc(
760 DeducedTemplateSpecializationTypeLoc TL) {
761 Record.AddSourceLocation(TL.getTemplateNameLoc());
762}
763
John McCall17001972009-10-18 01:05:36 +0000764void TypeLocWriter::VisitRecordTypeLoc(RecordTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000765 Record.AddSourceLocation(TL.getNameLoc());
John McCall17001972009-10-18 01:05:36 +0000766}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000767
John McCall17001972009-10-18 01:05:36 +0000768void TypeLocWriter::VisitEnumTypeLoc(EnumTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000769 Record.AddSourceLocation(TL.getNameLoc());
John McCall17001972009-10-18 01:05:36 +0000770}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000771
John McCall81904512011-01-06 01:58:22 +0000772void TypeLocWriter::VisitAttributedTypeLoc(AttributedTypeLoc TL) {
Richard Smithe43e2b32018-08-20 21:47:29 +0000773 Record.AddAttr(TL.getAttr());
John McCall81904512011-01-06 01:58:22 +0000774}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000775
John McCall17001972009-10-18 01:05:36 +0000776void TypeLocWriter::VisitTemplateTypeParmTypeLoc(TemplateTypeParmTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000777 Record.AddSourceLocation(TL.getNameLoc());
John McCall17001972009-10-18 01:05:36 +0000778}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000779
John McCallcebee162009-10-18 09:09:24 +0000780void TypeLocWriter::VisitSubstTemplateTypeParmTypeLoc(
781 SubstTemplateTypeParmTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000782 Record.AddSourceLocation(TL.getNameLoc());
John McCallcebee162009-10-18 09:09:24 +0000783}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000784
Douglas Gregorada4b792011-01-14 02:55:32 +0000785void TypeLocWriter::VisitSubstTemplateTypeParmPackTypeLoc(
786 SubstTemplateTypeParmPackTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000787 Record.AddSourceLocation(TL.getNameLoc());
Douglas Gregorada4b792011-01-14 02:55:32 +0000788}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000789
John McCall17001972009-10-18 01:05:36 +0000790void TypeLocWriter::VisitTemplateSpecializationTypeLoc(
791 TemplateSpecializationTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000792 Record.AddSourceLocation(TL.getTemplateKeywordLoc());
793 Record.AddSourceLocation(TL.getTemplateNameLoc());
794 Record.AddSourceLocation(TL.getLAngleLoc());
795 Record.AddSourceLocation(TL.getRAngleLoc());
John McCall0ad16662009-10-29 08:12:44 +0000796 for (unsigned i = 0, e = TL.getNumArgs(); i != e; ++i)
Richard Smith69c82bf2016-04-01 22:52:03 +0000797 Record.AddTemplateArgumentLocInfo(TL.getArgLoc(i).getArgument().getKind(),
798 TL.getArgLoc(i).getLocInfo());
John McCall17001972009-10-18 01:05:36 +0000799}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000800
Abramo Bagnara924a8f32010-12-10 16:29:40 +0000801void TypeLocWriter::VisitParenTypeLoc(ParenTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000802 Record.AddSourceLocation(TL.getLParenLoc());
803 Record.AddSourceLocation(TL.getRParenLoc());
Abramo Bagnara924a8f32010-12-10 16:29:40 +0000804}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000805
Abramo Bagnara6150c882010-05-11 21:36:43 +0000806void TypeLocWriter::VisitElaboratedTypeLoc(ElaboratedTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000807 Record.AddSourceLocation(TL.getElaboratedKeywordLoc());
808 Record.AddNestedNameSpecifierLoc(TL.getQualifierLoc());
John McCall17001972009-10-18 01:05:36 +0000809}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000810
John McCalle78aac42010-03-10 03:28:59 +0000811void TypeLocWriter::VisitInjectedClassNameTypeLoc(InjectedClassNameTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000812 Record.AddSourceLocation(TL.getNameLoc());
John McCalle78aac42010-03-10 03:28:59 +0000813}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000814
Douglas Gregorc1d2d8a2010-03-31 17:34:00 +0000815void TypeLocWriter::VisitDependentNameTypeLoc(DependentNameTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000816 Record.AddSourceLocation(TL.getElaboratedKeywordLoc());
817 Record.AddNestedNameSpecifierLoc(TL.getQualifierLoc());
818 Record.AddSourceLocation(TL.getNameLoc());
John McCall17001972009-10-18 01:05:36 +0000819}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000820
John McCallc392f372010-06-11 00:33:02 +0000821void TypeLocWriter::VisitDependentTemplateSpecializationTypeLoc(
822 DependentTemplateSpecializationTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000823 Record.AddSourceLocation(TL.getElaboratedKeywordLoc());
824 Record.AddNestedNameSpecifierLoc(TL.getQualifierLoc());
825 Record.AddSourceLocation(TL.getTemplateKeywordLoc());
826 Record.AddSourceLocation(TL.getTemplateNameLoc());
827 Record.AddSourceLocation(TL.getLAngleLoc());
828 Record.AddSourceLocation(TL.getRAngleLoc());
John McCallc392f372010-06-11 00:33:02 +0000829 for (unsigned I = 0, E = TL.getNumArgs(); I != E; ++I)
Richard Smith69c82bf2016-04-01 22:52:03 +0000830 Record.AddTemplateArgumentLocInfo(TL.getArgLoc(I).getArgument().getKind(),
831 TL.getArgLoc(I).getLocInfo());
John McCallc392f372010-06-11 00:33:02 +0000832}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000833
Douglas Gregord2fa7662010-12-20 02:24:11 +0000834void TypeLocWriter::VisitPackExpansionTypeLoc(PackExpansionTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000835 Record.AddSourceLocation(TL.getEllipsisLoc());
Douglas Gregord2fa7662010-12-20 02:24:11 +0000836}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000837
John McCall17001972009-10-18 01:05:36 +0000838void TypeLocWriter::VisitObjCInterfaceTypeLoc(ObjCInterfaceTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000839 Record.AddSourceLocation(TL.getNameLoc());
John McCall8b07ec22010-05-15 11:32:37 +0000840}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000841
John McCall8b07ec22010-05-15 11:32:37 +0000842void TypeLocWriter::VisitObjCObjectTypeLoc(ObjCObjectTypeLoc TL) {
843 Record.push_back(TL.hasBaseTypeAsWritten());
Richard Smith69c82bf2016-04-01 22:52:03 +0000844 Record.AddSourceLocation(TL.getTypeArgsLAngleLoc());
845 Record.AddSourceLocation(TL.getTypeArgsRAngleLoc());
Douglas Gregore9d95f12015-07-07 03:57:35 +0000846 for (unsigned i = 0, e = TL.getNumTypeArgs(); i != e; ++i)
Richard Smith69c82bf2016-04-01 22:52:03 +0000847 Record.AddTypeSourceInfo(TL.getTypeArgTInfo(i));
848 Record.AddSourceLocation(TL.getProtocolLAngleLoc());
849 Record.AddSourceLocation(TL.getProtocolRAngleLoc());
John McCall17001972009-10-18 01:05:36 +0000850 for (unsigned i = 0, e = TL.getNumProtocols(); i != e; ++i)
Richard Smith69c82bf2016-04-01 22:52:03 +0000851 Record.AddSourceLocation(TL.getProtocolLoc(i));
John McCall8f115c62009-10-16 21:56:05 +0000852}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000853
John McCallfc93cf92009-10-22 22:37:11 +0000854void TypeLocWriter::VisitObjCObjectPointerTypeLoc(ObjCObjectPointerTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000855 Record.AddSourceLocation(TL.getStarLoc());
John McCallfc93cf92009-10-22 22:37:11 +0000856}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000857
Eli Friedman0dfb8892011-10-06 23:00:33 +0000858void TypeLocWriter::VisitAtomicTypeLoc(AtomicTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000859 Record.AddSourceLocation(TL.getKWLoc());
860 Record.AddSourceLocation(TL.getLParenLoc());
861 Record.AddSourceLocation(TL.getRParenLoc());
Eli Friedman0dfb8892011-10-06 23:00:33 +0000862}
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +0000863
Xiuli Pan9c14e282016-01-09 12:53:17 +0000864void TypeLocWriter::VisitPipeTypeLoc(PipeTypeLoc TL) {
Richard Smith69c82bf2016-04-01 22:52:03 +0000865 Record.AddSourceLocation(TL.getKWLoc());
Xiuli Pan9c14e282016-01-09 12:53:17 +0000866}
John McCall8f115c62009-10-16 21:56:05 +0000867
Richard Smith01b2cb42014-07-26 06:37:51 +0000868void ASTWriter::WriteTypeAbbrevs() {
869 using namespace llvm;
870
David Blaikieb44f0bf2017-01-04 22:36:43 +0000871 std::shared_ptr<BitCodeAbbrev> Abv;
Richard Smith01b2cb42014-07-26 06:37:51 +0000872
873 // Abbreviation for TYPE_EXT_QUAL
David Blaikieb44f0bf2017-01-04 22:36:43 +0000874 Abv = std::make_shared<BitCodeAbbrev>();
Richard Smith01b2cb42014-07-26 06:37:51 +0000875 Abv->Add(BitCodeAbbrevOp(serialization::TYPE_EXT_QUAL));
876 Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Type
877 Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 3)); // Quals
David Blaikieb44f0bf2017-01-04 22:36:43 +0000878 TypeExtQualAbbrev = Stream.EmitAbbrev(std::move(Abv));
Richard Smith01b2cb42014-07-26 06:37:51 +0000879
880 // Abbreviation for TYPE_FUNCTION_PROTO
David Blaikieb44f0bf2017-01-04 22:36:43 +0000881 Abv = std::make_shared<BitCodeAbbrev>();
Richard Smith01b2cb42014-07-26 06:37:51 +0000882 Abv->Add(BitCodeAbbrevOp(serialization::TYPE_FUNCTION_PROTO));
883 // FunctionType
884 Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // ReturnType
885 Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // NoReturn
886 Abv->Add(BitCodeAbbrevOp(0)); // HasRegParm
887 Abv->Add(BitCodeAbbrevOp(0)); // RegParm
888 Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 4)); // CC
889 Abv->Add(BitCodeAbbrevOp(0)); // ProducesResult
Oren Ben Simhon318a6ea2017-04-27 12:01:00 +0000890 Abv->Add(BitCodeAbbrevOp(0)); // NoCallerSavedRegs
Oren Ben Simhon220671a2018-03-17 13:31:35 +0000891 Abv->Add(BitCodeAbbrevOp(0)); // NoCfCheck
Richard Smith01b2cb42014-07-26 06:37:51 +0000892 // FunctionProtoType
893 Abv->Add(BitCodeAbbrevOp(0)); // IsVariadic
894 Abv->Add(BitCodeAbbrevOp(0)); // HasTrailingReturn
895 Abv->Add(BitCodeAbbrevOp(0)); // TypeQuals
896 Abv->Add(BitCodeAbbrevOp(0)); // RefQualifier
897 Abv->Add(BitCodeAbbrevOp(EST_None)); // ExceptionSpec
898 Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // NumParams
899 Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Array));
900 Abv->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Params
David Blaikieb44f0bf2017-01-04 22:36:43 +0000901 TypeFunctionProtoAbbrev = Stream.EmitAbbrev(std::move(Abv));
Richard Smith01b2cb42014-07-26 06:37:51 +0000902}
903
Chris Lattner19cea4e2009-04-22 05:57:30 +0000904//===----------------------------------------------------------------------===//
Sebastian Redl55c0ad52010-08-18 23:56:21 +0000905// ASTWriter Implementation
Douglas Gregoref84c4b2009-04-09 22:27:44 +0000906//===----------------------------------------------------------------------===//
907
Chris Lattner28fa4e62009-04-26 22:26:21 +0000908static void EmitBlockID(unsigned ID, const char *Name,
909 llvm::BitstreamWriter &Stream,
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +0000910 ASTWriter::RecordDataImpl &Record) {
Chris Lattner28fa4e62009-04-26 22:26:21 +0000911 Record.clear();
912 Record.push_back(ID);
913 Stream.EmitRecord(llvm::bitc::BLOCKINFO_CODE_SETBID, Record);
914
915 // Emit the block name if present.
Craig Toppera13603a2014-05-22 05:54:18 +0000916 if (!Name || Name[0] == 0)
917 return;
Chris Lattner28fa4e62009-04-26 22:26:21 +0000918 Record.clear();
919 while (*Name)
920 Record.push_back(*Name++);
921 Stream.EmitRecord(llvm::bitc::BLOCKINFO_CODE_BLOCKNAME, Record);
922}
923
924static void EmitRecordID(unsigned ID, const char *Name,
925 llvm::BitstreamWriter &Stream,
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +0000926 ASTWriter::RecordDataImpl &Record) {
Chris Lattner28fa4e62009-04-26 22:26:21 +0000927 Record.clear();
928 Record.push_back(ID);
929 while (*Name)
930 Record.push_back(*Name++);
931 Stream.EmitRecord(llvm::bitc::BLOCKINFO_CODE_SETRECORDNAME, Record);
Chris Lattnerccac3a62009-04-27 00:49:53 +0000932}
933
934static void AddStmtsExprs(llvm::BitstreamWriter &Stream,
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +0000935 ASTWriter::RecordDataImpl &Record) {
Sebastian Redl539c5062010-08-18 23:57:32 +0000936#define RECORD(X) EmitRecordID(X, #X, Stream, Record)
Chris Lattnerccac3a62009-04-27 00:49:53 +0000937 RECORD(STMT_STOP);
938 RECORD(STMT_NULL_PTR);
Richard Smith01b2cb42014-07-26 06:37:51 +0000939 RECORD(STMT_REF_PTR);
Chris Lattnerccac3a62009-04-27 00:49:53 +0000940 RECORD(STMT_NULL);
941 RECORD(STMT_COMPOUND);
942 RECORD(STMT_CASE);
943 RECORD(STMT_DEFAULT);
944 RECORD(STMT_LABEL);
Richard Smithc202b282012-04-14 00:33:13 +0000945 RECORD(STMT_ATTRIBUTED);
Chris Lattnerccac3a62009-04-27 00:49:53 +0000946 RECORD(STMT_IF);
947 RECORD(STMT_SWITCH);
948 RECORD(STMT_WHILE);
949 RECORD(STMT_DO);
950 RECORD(STMT_FOR);
951 RECORD(STMT_GOTO);
952 RECORD(STMT_INDIRECT_GOTO);
953 RECORD(STMT_CONTINUE);
954 RECORD(STMT_BREAK);
955 RECORD(STMT_RETURN);
956 RECORD(STMT_DECL);
Chad Rosierde70e0e2012-08-25 00:11:56 +0000957 RECORD(STMT_GCCASM);
Chad Rosiere30d4992012-08-24 23:51:02 +0000958 RECORD(STMT_MSASM);
Chris Lattnerccac3a62009-04-27 00:49:53 +0000959 RECORD(EXPR_PREDEFINED);
960 RECORD(EXPR_DECL_REF);
961 RECORD(EXPR_INTEGER_LITERAL);
962 RECORD(EXPR_FLOATING_LITERAL);
963 RECORD(EXPR_IMAGINARY_LITERAL);
964 RECORD(EXPR_STRING_LITERAL);
965 RECORD(EXPR_CHARACTER_LITERAL);
966 RECORD(EXPR_PAREN);
Richard Smithf1b4b8b2014-07-27 04:29:04 +0000967 RECORD(EXPR_PAREN_LIST);
Chris Lattnerccac3a62009-04-27 00:49:53 +0000968 RECORD(EXPR_UNARY_OPERATOR);
969 RECORD(EXPR_SIZEOF_ALIGN_OF);
970 RECORD(EXPR_ARRAY_SUBSCRIPT);
971 RECORD(EXPR_CALL);
972 RECORD(EXPR_MEMBER);
973 RECORD(EXPR_BINARY_OPERATOR);
974 RECORD(EXPR_COMPOUND_ASSIGN_OPERATOR);
975 RECORD(EXPR_CONDITIONAL_OPERATOR);
976 RECORD(EXPR_IMPLICIT_CAST);
977 RECORD(EXPR_CSTYLE_CAST);
978 RECORD(EXPR_COMPOUND_LITERAL);
979 RECORD(EXPR_EXT_VECTOR_ELEMENT);
980 RECORD(EXPR_INIT_LIST);
981 RECORD(EXPR_DESIGNATED_INIT);
Yunzhong Gaocb779302015-06-10 00:27:52 +0000982 RECORD(EXPR_DESIGNATED_INIT_UPDATE);
Chris Lattnerccac3a62009-04-27 00:49:53 +0000983 RECORD(EXPR_IMPLICIT_VALUE_INIT);
Yunzhong Gaocb779302015-06-10 00:27:52 +0000984 RECORD(EXPR_NO_INIT);
Chris Lattnerccac3a62009-04-27 00:49:53 +0000985 RECORD(EXPR_VA_ARG);
986 RECORD(EXPR_ADDR_LABEL);
987 RECORD(EXPR_STMT);
Chris Lattnerccac3a62009-04-27 00:49:53 +0000988 RECORD(EXPR_CHOOSE);
989 RECORD(EXPR_GNU_NULL);
990 RECORD(EXPR_SHUFFLE_VECTOR);
991 RECORD(EXPR_BLOCK);
Peter Collingbourne91147592011-04-15 00:35:48 +0000992 RECORD(EXPR_GENERIC_SELECTION);
Chris Lattnerccac3a62009-04-27 00:49:53 +0000993 RECORD(EXPR_OBJC_STRING_LITERAL);
Patrick Beard0caa3942012-04-19 00:25:12 +0000994 RECORD(EXPR_OBJC_BOXED_EXPRESSION);
Ted Kremeneke65b0862012-03-06 20:05:56 +0000995 RECORD(EXPR_OBJC_ARRAY_LITERAL);
996 RECORD(EXPR_OBJC_DICTIONARY_LITERAL);
Chris Lattnerccac3a62009-04-27 00:49:53 +0000997 RECORD(EXPR_OBJC_ENCODE);
998 RECORD(EXPR_OBJC_SELECTOR_EXPR);
999 RECORD(EXPR_OBJC_PROTOCOL_EXPR);
1000 RECORD(EXPR_OBJC_IVAR_REF_EXPR);
1001 RECORD(EXPR_OBJC_PROPERTY_REF_EXPR);
1002 RECORD(EXPR_OBJC_KVC_REF_EXPR);
1003 RECORD(EXPR_OBJC_MESSAGE_EXPR);
Chris Lattnerccac3a62009-04-27 00:49:53 +00001004 RECORD(STMT_OBJC_FOR_COLLECTION);
1005 RECORD(STMT_OBJC_CATCH);
1006 RECORD(STMT_OBJC_FINALLY);
1007 RECORD(STMT_OBJC_AT_TRY);
1008 RECORD(STMT_OBJC_AT_SYNCHRONIZED);
1009 RECORD(STMT_OBJC_AT_THROW);
Ted Kremeneke65b0862012-03-06 20:05:56 +00001010 RECORD(EXPR_OBJC_BOOL_LITERAL);
Richard Smith01b2cb42014-07-26 06:37:51 +00001011 RECORD(STMT_CXX_CATCH);
1012 RECORD(STMT_CXX_TRY);
1013 RECORD(STMT_CXX_FOR_RANGE);
Sam Weinige83b3ac2010-02-07 06:32:43 +00001014 RECORD(EXPR_CXX_OPERATOR_CALL);
Richard Smithf1b4b8b2014-07-27 04:29:04 +00001015 RECORD(EXPR_CXX_MEMBER_CALL);
Sam Weinige83b3ac2010-02-07 06:32:43 +00001016 RECORD(EXPR_CXX_CONSTRUCT);
Richard Smithf1b4b8b2014-07-27 04:29:04 +00001017 RECORD(EXPR_CXX_TEMPORARY_OBJECT);
Sam Weinige83b3ac2010-02-07 06:32:43 +00001018 RECORD(EXPR_CXX_STATIC_CAST);
1019 RECORD(EXPR_CXX_DYNAMIC_CAST);
1020 RECORD(EXPR_CXX_REINTERPRET_CAST);
1021 RECORD(EXPR_CXX_CONST_CAST);
1022 RECORD(EXPR_CXX_FUNCTIONAL_CAST);
Richard Smithc67fdd42012-03-07 08:35:16 +00001023 RECORD(EXPR_USER_DEFINED_LITERAL);
Richard Smithcc1b96d2013-06-12 22:31:48 +00001024 RECORD(EXPR_CXX_STD_INITIALIZER_LIST);
Sam Weinige83b3ac2010-02-07 06:32:43 +00001025 RECORD(EXPR_CXX_BOOL_LITERAL);
1026 RECORD(EXPR_CXX_NULL_PTR_LITERAL);
Douglas Gregor0beaec02011-02-08 16:34:17 +00001027 RECORD(EXPR_CXX_TYPEID_EXPR);
1028 RECORD(EXPR_CXX_TYPEID_TYPE);
Douglas Gregor0beaec02011-02-08 16:34:17 +00001029 RECORD(EXPR_CXX_THIS);
1030 RECORD(EXPR_CXX_THROW);
1031 RECORD(EXPR_CXX_DEFAULT_ARG);
Richard Smith01b2cb42014-07-26 06:37:51 +00001032 RECORD(EXPR_CXX_DEFAULT_INIT);
Douglas Gregor0beaec02011-02-08 16:34:17 +00001033 RECORD(EXPR_CXX_BIND_TEMPORARY);
1034 RECORD(EXPR_CXX_SCALAR_VALUE_INIT);
1035 RECORD(EXPR_CXX_NEW);
1036 RECORD(EXPR_CXX_DELETE);
1037 RECORD(EXPR_CXX_PSEUDO_DESTRUCTOR);
1038 RECORD(EXPR_EXPR_WITH_CLEANUPS);
1039 RECORD(EXPR_CXX_DEPENDENT_SCOPE_MEMBER);
1040 RECORD(EXPR_CXX_DEPENDENT_SCOPE_DECL_REF);
1041 RECORD(EXPR_CXX_UNRESOLVED_CONSTRUCT);
1042 RECORD(EXPR_CXX_UNRESOLVED_MEMBER);
1043 RECORD(EXPR_CXX_UNRESOLVED_LOOKUP);
Richard Smith01b2cb42014-07-26 06:37:51 +00001044 RECORD(EXPR_CXX_EXPRESSION_TRAIT);
Douglas Gregor0beaec02011-02-08 16:34:17 +00001045 RECORD(EXPR_CXX_NOEXCEPT);
1046 RECORD(EXPR_OPAQUE_VALUE);
Richard Smith01b2cb42014-07-26 06:37:51 +00001047 RECORD(EXPR_BINARY_CONDITIONAL_OPERATOR);
1048 RECORD(EXPR_TYPE_TRAIT);
1049 RECORD(EXPR_ARRAY_TYPE_TRAIT);
Douglas Gregor0beaec02011-02-08 16:34:17 +00001050 RECORD(EXPR_PACK_EXPANSION);
1051 RECORD(EXPR_SIZEOF_PACK);
Richard Smith01b2cb42014-07-26 06:37:51 +00001052 RECORD(EXPR_SUBST_NON_TYPE_TEMPLATE_PARM);
Douglas Gregor0beaec02011-02-08 16:34:17 +00001053 RECORD(EXPR_SUBST_NON_TYPE_TEMPLATE_PARM_PACK);
Richard Smith01b2cb42014-07-26 06:37:51 +00001054 RECORD(EXPR_FUNCTION_PARM_PACK);
1055 RECORD(EXPR_MATERIALIZE_TEMPORARY);
Peter Collingbourne41f85462011-02-09 21:07:24 +00001056 RECORD(EXPR_CUDA_KERNEL_CALL);
Richard Smith01b2cb42014-07-26 06:37:51 +00001057 RECORD(EXPR_CXX_UUIDOF_EXPR);
1058 RECORD(EXPR_CXX_UUIDOF_TYPE);
1059 RECORD(EXPR_LAMBDA);
Chris Lattnerccac3a62009-04-27 00:49:53 +00001060#undef RECORD
Chris Lattner28fa4e62009-04-26 22:26:21 +00001061}
Mike Stump11289f42009-09-09 15:08:12 +00001062
Sebastian Redl55c0ad52010-08-18 23:56:21 +00001063void ASTWriter::WriteBlockInfoBlock() {
Chris Lattner28fa4e62009-04-26 22:26:21 +00001064 RecordData Record;
Peter Collingbourned3a6c702016-11-01 01:18:57 +00001065 Stream.EnterBlockInfoBlock();
Mike Stump11289f42009-09-09 15:08:12 +00001066
Sebastian Redl539c5062010-08-18 23:57:32 +00001067#define BLOCK(X) EmitBlockID(X ## _ID, #X, Stream, Record)
1068#define RECORD(X) EmitRecordID(X, #X, Stream, Record)
Mike Stump11289f42009-09-09 15:08:12 +00001069
Douglas Gregor0aa21c92012-10-18 18:27:37 +00001070 // Control Block.
1071 BLOCK(CONTROL_BLOCK);
1072 RECORD(METADATA);
Ben Langmuirbeee15e2014-04-14 18:00:01 +00001073 RECORD(MODULE_NAME);
Richard Smithfa715652015-08-31 22:43:10 +00001074 RECORD(MODULE_DIRECTORY);
Ben Langmuirbeee15e2014-04-14 18:00:01 +00001075 RECORD(MODULE_MAP_FILE);
Douglas Gregor0aa21c92012-10-18 18:27:37 +00001076 RECORD(IMPORTS);
Douglas Gregorfad10d82012-10-18 18:36:53 +00001077 RECORD(ORIGINAL_FILE);
Douglas Gregor0aa21c92012-10-18 18:27:37 +00001078 RECORD(ORIGINAL_PCH_DIR);
Argyrios Kyrtzidis52595242012-11-15 18:57:27 +00001079 RECORD(ORIGINAL_FILE_ID);
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001080 RECORD(INPUT_FILE_OFFSETS);
Richard Smith0516b182015-09-08 19:40:14 +00001081
1082 BLOCK(OPTIONS_BLOCK);
1083 RECORD(LANGUAGE_OPTIONS);
1084 RECORD(TARGET_OPTIONS);
Douglas Gregorc6317db2012-10-24 15:49:58 +00001085 RECORD(FILE_SYSTEM_OPTIONS);
Douglas Gregor2d302362012-10-24 16:50:34 +00001086 RECORD(HEADER_SEARCH_OPTIONS);
Douglas Gregorb6af6c22012-10-24 20:05:57 +00001087 RECORD(PREPROCESSOR_OPTIONS);
1088
Douglas Gregor108cb222012-10-19 00:45:00 +00001089 BLOCK(INPUT_FILES_BLOCK);
1090 RECORD(INPUT_FILE);
1091
Douglas Gregor0aa21c92012-10-18 18:27:37 +00001092 // AST Top-Level Block.
1093 BLOCK(AST_BLOCK);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001094 RECORD(TYPE_OFFSET);
1095 RECORD(DECL_OFFSET);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001096 RECORD(IDENTIFIER_OFFSET);
1097 RECORD(IDENTIFIER_TABLE);
Ben Langmuir332aafe2014-01-31 01:06:56 +00001098 RECORD(EAGERLY_DESERIALIZED_DECLS);
David Blaikie9ffe5a32017-01-30 05:00:26 +00001099 RECORD(MODULAR_CODEGEN_DECLS);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001100 RECORD(SPECIAL_TYPES);
1101 RECORD(STATISTICS);
1102 RECORD(TENTATIVE_DEFINITIONS);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001103 RECORD(SELECTOR_OFFSETS);
1104 RECORD(METHOD_POOL);
1105 RECORD(PP_COUNTER_VALUE);
Douglas Gregor258ae542009-04-27 06:38:32 +00001106 RECORD(SOURCE_LOCATION_OFFSETS);
1107 RECORD(SOURCE_LOCATION_PRELOADS);
Douglas Gregor61cac2b2009-04-27 20:06:05 +00001108 RECORD(EXT_VECTOR_DECLS);
Richard Smithfa715652015-08-31 22:43:10 +00001109 RECORD(UNUSED_FILESCOPED_DECLS);
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00001110 RECORD(PPD_ENTITIES_OFFSETS);
Richard Smithfa715652015-08-31 22:43:10 +00001111 RECORD(VTABLE_USES);
Cameron Desrochersb60f1b62018-01-15 19:14:16 +00001112 RECORD(PPD_SKIPPED_RANGES);
Fariborz Jahanianc51609a2010-07-23 19:11:11 +00001113 RECORD(REFERENCED_SELECTOR_POOL);
Douglas Gregor0beaec02011-02-08 16:34:17 +00001114 RECORD(TU_UPDATE_LEXICAL);
Douglas Gregor0beaec02011-02-08 16:34:17 +00001115 RECORD(SEMA_DECL_REFS);
1116 RECORD(WEAK_UNDECLARED_IDENTIFIERS);
1117 RECORD(PENDING_IMPLICIT_INSTANTIATIONS);
Douglas Gregor0beaec02011-02-08 16:34:17 +00001118 RECORD(UPDATE_VISIBLE);
1119 RECORD(DECL_UPDATE_OFFSETS);
1120 RECORD(DECL_UPDATES);
Peter Collingbourne5df20e02011-02-15 19:46:30 +00001121 RECORD(CUDA_SPECIAL_DECL_REFS);
Douglas Gregor09b69892011-02-10 17:09:37 +00001122 RECORD(HEADER_SEARCH_TABLE);
Peter Collingbourne5df20e02011-02-15 19:46:30 +00001123 RECORD(FP_PRAGMA_OPTIONS);
1124 RECORD(OPENCL_EXTENSIONS);
Yaxun Liu5b746652016-12-18 05:18:55 +00001125 RECORD(OPENCL_EXTENSION_TYPES);
1126 RECORD(OPENCL_EXTENSION_DECLS);
Alexis Hunt27a761d2011-05-04 23:29:54 +00001127 RECORD(DELEGATING_CTORS);
Douglas Gregorc2fa1692011-06-28 16:20:02 +00001128 RECORD(KNOWN_NAMESPACES);
Douglas Gregor78d0b572011-08-04 16:39:39 +00001129 RECORD(MODULE_OFFSET_MAP);
1130 RECORD(SOURCE_MANAGER_LINE_TABLE);
Douglas Gregor404cdde2012-01-27 01:47:08 +00001131 RECORD(OBJC_CATEGORIES_MAP);
Douglas Gregor66e4add2011-12-19 21:09:25 +00001132 RECORD(FILE_SORTED_DECLS);
1133 RECORD(IMPORTED_MODULES);
Douglas Gregor404cdde2012-01-27 01:47:08 +00001134 RECORD(OBJC_CATEGORIES);
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00001135 RECORD(MACRO_OFFSET);
Richard Smithfa715652015-08-31 22:43:10 +00001136 RECORD(INTERESTING_IDENTIFIERS);
1137 RECORD(UNDEFINED_BUT_USED);
Richard Smithe40f2ba2013-08-07 21:41:30 +00001138 RECORD(LATE_PARSED_TEMPLATE);
Dario Domizioli13a0a382014-05-23 12:13:25 +00001139 RECORD(OPTIMIZE_PRAGMA_OPTIONS);
Nico Weber779355f2016-03-02 23:22:00 +00001140 RECORD(MSSTRUCT_PRAGMA_OPTIONS);
Nico Weber42932312016-03-03 00:17:35 +00001141 RECORD(POINTERS_TO_MEMBERS_PRAGMA_OPTIONS);
Richard Smithfa715652015-08-31 22:43:10 +00001142 RECORD(UNUSED_LOCAL_TYPEDEF_NAME_CANDIDATES);
Richard Smithfa715652015-08-31 22:43:10 +00001143 RECORD(DELETE_EXPRS_TO_ANALYZE);
Justin Lebar67a78a62016-10-08 22:15:58 +00001144 RECORD(CUDA_PRAGMA_FORCE_HOST_DEVICE_DEPTH);
Erik Verbruggenb34c79f2017-05-30 11:54:55 +00001145 RECORD(PP_CONDITIONAL_STACK);
Douglas Gregor358cd442012-01-15 16:58:34 +00001146
Chris Lattner28fa4e62009-04-26 22:26:21 +00001147 // SourceManager Block.
Chris Lattner64031982009-04-27 00:40:25 +00001148 BLOCK(SOURCE_MANAGER_BLOCK);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001149 RECORD(SM_SLOC_FILE_ENTRY);
1150 RECORD(SM_SLOC_BUFFER_ENTRY);
1151 RECORD(SM_SLOC_BUFFER_BLOB);
Richard Smithaada85c2016-02-06 02:06:43 +00001152 RECORD(SM_SLOC_BUFFER_BLOB_COMPRESSED);
Chandler Carruthf92ac9e2011-07-15 07:25:21 +00001153 RECORD(SM_SLOC_EXPANSION_ENTRY);
Mike Stump11289f42009-09-09 15:08:12 +00001154
Chris Lattner28fa4e62009-04-26 22:26:21 +00001155 // Preprocessor Block.
Chris Lattner64031982009-04-27 00:40:25 +00001156 BLOCK(PREPROCESSOR_BLOCK);
Richard Smithec216502015-02-13 19:48:37 +00001157 RECORD(PP_MACRO_DIRECTIVE_HISTORY);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001158 RECORD(PP_MACRO_FUNCTION_LIKE);
Richard Smithd7329392015-04-21 21:46:32 +00001159 RECORD(PP_MACRO_OBJECT_LIKE);
1160 RECORD(PP_MODULE_MACRO);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001161 RECORD(PP_TOKEN);
Richard Smithec216502015-02-13 19:48:37 +00001162
Richard Smithfa715652015-08-31 22:43:10 +00001163 // Submodule Block.
1164 BLOCK(SUBMODULE_BLOCK);
1165 RECORD(SUBMODULE_METADATA);
1166 RECORD(SUBMODULE_DEFINITION);
1167 RECORD(SUBMODULE_UMBRELLA_HEADER);
1168 RECORD(SUBMODULE_HEADER);
1169 RECORD(SUBMODULE_TOPHEADER);
1170 RECORD(SUBMODULE_UMBRELLA_DIR);
1171 RECORD(SUBMODULE_IMPORTS);
1172 RECORD(SUBMODULE_EXPORTS);
1173 RECORD(SUBMODULE_REQUIRES);
1174 RECORD(SUBMODULE_EXCLUDED_HEADER);
1175 RECORD(SUBMODULE_LINK_LIBRARY);
1176 RECORD(SUBMODULE_CONFIG_MACRO);
1177 RECORD(SUBMODULE_CONFLICT);
1178 RECORD(SUBMODULE_PRIVATE_HEADER);
1179 RECORD(SUBMODULE_TEXTUAL_HEADER);
1180 RECORD(SUBMODULE_PRIVATE_TEXTUAL_HEADER);
Richard Smithdc1f0422016-07-20 19:10:16 +00001181 RECORD(SUBMODULE_INITIALIZERS);
Douglas Gregorf0b11de2017-09-14 23:38:44 +00001182 RECORD(SUBMODULE_EXPORT_AS);
Richard Smithfa715652015-08-31 22:43:10 +00001183
1184 // Comments Block.
1185 BLOCK(COMMENTS_BLOCK);
1186 RECORD(COMMENTS_RAW_COMMENT);
1187
Douglas Gregor12bfa382009-10-17 00:13:19 +00001188 // Decls and Types block.
1189 BLOCK(DECLTYPES_BLOCK);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001190 RECORD(TYPE_EXT_QUAL);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001191 RECORD(TYPE_COMPLEX);
1192 RECORD(TYPE_POINTER);
1193 RECORD(TYPE_BLOCK_POINTER);
1194 RECORD(TYPE_LVALUE_REFERENCE);
1195 RECORD(TYPE_RVALUE_REFERENCE);
1196 RECORD(TYPE_MEMBER_POINTER);
1197 RECORD(TYPE_CONSTANT_ARRAY);
1198 RECORD(TYPE_INCOMPLETE_ARRAY);
1199 RECORD(TYPE_VARIABLE_ARRAY);
1200 RECORD(TYPE_VECTOR);
1201 RECORD(TYPE_EXT_VECTOR);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001202 RECORD(TYPE_FUNCTION_NO_PROTO);
Richard Smithf1b4b8b2014-07-27 04:29:04 +00001203 RECORD(TYPE_FUNCTION_PROTO);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001204 RECORD(TYPE_TYPEDEF);
1205 RECORD(TYPE_TYPEOF_EXPR);
1206 RECORD(TYPE_TYPEOF);
1207 RECORD(TYPE_RECORD);
1208 RECORD(TYPE_ENUM);
1209 RECORD(TYPE_OBJC_INTERFACE);
Steve Narofffb4330f2009-06-17 22:40:22 +00001210 RECORD(TYPE_OBJC_OBJECT_POINTER);
Douglas Gregor0beaec02011-02-08 16:34:17 +00001211 RECORD(TYPE_DECLTYPE);
1212 RECORD(TYPE_ELABORATED);
1213 RECORD(TYPE_SUBST_TEMPLATE_TYPE_PARM);
1214 RECORD(TYPE_UNRESOLVED_USING);
1215 RECORD(TYPE_INJECTED_CLASS_NAME);
1216 RECORD(TYPE_OBJC_OBJECT);
1217 RECORD(TYPE_TEMPLATE_TYPE_PARM);
1218 RECORD(TYPE_TEMPLATE_SPECIALIZATION);
1219 RECORD(TYPE_DEPENDENT_NAME);
1220 RECORD(TYPE_DEPENDENT_TEMPLATE_SPECIALIZATION);
1221 RECORD(TYPE_DEPENDENT_SIZED_ARRAY);
1222 RECORD(TYPE_PAREN);
1223 RECORD(TYPE_PACK_EXPANSION);
1224 RECORD(TYPE_ATTRIBUTED);
1225 RECORD(TYPE_SUBST_TEMPLATE_TYPE_PARM_PACK);
Richard Smithf1b4b8b2014-07-27 04:29:04 +00001226 RECORD(TYPE_AUTO);
1227 RECORD(TYPE_UNARY_TRANSFORM);
Eli Friedman0dfb8892011-10-06 23:00:33 +00001228 RECORD(TYPE_ATOMIC);
Richard Smithf1b4b8b2014-07-27 04:29:04 +00001229 RECORD(TYPE_DECAYED);
1230 RECORD(TYPE_ADJUSTED);
Manman Rene6be26c2016-09-13 17:25:08 +00001231 RECORD(TYPE_OBJC_TYPE_PARAM);
Richard Smithd61d4ac2015-08-22 20:13:39 +00001232 RECORD(LOCAL_REDECLARATIONS);
Chris Lattnerdb397b62009-04-26 22:32:16 +00001233 RECORD(DECL_TYPEDEF);
Richard Smith01b2cb42014-07-26 06:37:51 +00001234 RECORD(DECL_TYPEALIAS);
Chris Lattnerdb397b62009-04-26 22:32:16 +00001235 RECORD(DECL_ENUM);
1236 RECORD(DECL_RECORD);
1237 RECORD(DECL_ENUM_CONSTANT);
1238 RECORD(DECL_FUNCTION);
1239 RECORD(DECL_OBJC_METHOD);
1240 RECORD(DECL_OBJC_INTERFACE);
1241 RECORD(DECL_OBJC_PROTOCOL);
1242 RECORD(DECL_OBJC_IVAR);
1243 RECORD(DECL_OBJC_AT_DEFS_FIELD);
Chris Lattnerdb397b62009-04-26 22:32:16 +00001244 RECORD(DECL_OBJC_CATEGORY);
1245 RECORD(DECL_OBJC_CATEGORY_IMPL);
1246 RECORD(DECL_OBJC_IMPLEMENTATION);
1247 RECORD(DECL_OBJC_COMPATIBLE_ALIAS);
1248 RECORD(DECL_OBJC_PROPERTY);
1249 RECORD(DECL_OBJC_PROPERTY_IMPL);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001250 RECORD(DECL_FIELD);
John McCall5e77d762013-04-16 07:28:30 +00001251 RECORD(DECL_MS_PROPERTY);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001252 RECORD(DECL_VAR);
Chris Lattnerdb397b62009-04-26 22:32:16 +00001253 RECORD(DECL_IMPLICIT_PARAM);
Chris Lattner28fa4e62009-04-26 22:26:21 +00001254 RECORD(DECL_PARM_VAR);
Chris Lattnerdb397b62009-04-26 22:32:16 +00001255 RECORD(DECL_FILE_SCOPE_ASM);
1256 RECORD(DECL_BLOCK);
1257 RECORD(DECL_CONTEXT_LEXICAL);
1258 RECORD(DECL_CONTEXT_VISIBLE);
Douglas Gregor0beaec02011-02-08 16:34:17 +00001259 RECORD(DECL_NAMESPACE);
1260 RECORD(DECL_NAMESPACE_ALIAS);
1261 RECORD(DECL_USING);
1262 RECORD(DECL_USING_SHADOW);
1263 RECORD(DECL_USING_DIRECTIVE);
1264 RECORD(DECL_UNRESOLVED_USING_VALUE);
1265 RECORD(DECL_UNRESOLVED_USING_TYPENAME);
1266 RECORD(DECL_LINKAGE_SPEC);
1267 RECORD(DECL_CXX_RECORD);
1268 RECORD(DECL_CXX_METHOD);
1269 RECORD(DECL_CXX_CONSTRUCTOR);
Richard Smith5179eb72016-06-28 19:03:57 +00001270 RECORD(DECL_CXX_INHERITED_CONSTRUCTOR);
Douglas Gregor0beaec02011-02-08 16:34:17 +00001271 RECORD(DECL_CXX_DESTRUCTOR);
1272 RECORD(DECL_CXX_CONVERSION);
1273 RECORD(DECL_ACCESS_SPEC);
1274 RECORD(DECL_FRIEND);
1275 RECORD(DECL_FRIEND_TEMPLATE);
1276 RECORD(DECL_CLASS_TEMPLATE);
1277 RECORD(DECL_CLASS_TEMPLATE_SPECIALIZATION);
1278 RECORD(DECL_CLASS_TEMPLATE_PARTIAL_SPECIALIZATION);
Larisse Voufo39a1e502013-08-06 01:03:05 +00001279 RECORD(DECL_VAR_TEMPLATE);
1280 RECORD(DECL_VAR_TEMPLATE_SPECIALIZATION);
1281 RECORD(DECL_VAR_TEMPLATE_PARTIAL_SPECIALIZATION);
Douglas Gregor0beaec02011-02-08 16:34:17 +00001282 RECORD(DECL_FUNCTION_TEMPLATE);
1283 RECORD(DECL_TEMPLATE_TYPE_PARM);
1284 RECORD(DECL_NON_TYPE_TEMPLATE_PARM);
1285 RECORD(DECL_TEMPLATE_TEMPLATE_PARM);
Richard Smithefc884a2016-04-13 07:41:35 +00001286 RECORD(DECL_TYPE_ALIAS_TEMPLATE);
Douglas Gregor0beaec02011-02-08 16:34:17 +00001287 RECORD(DECL_STATIC_ASSERT);
1288 RECORD(DECL_CXX_BASE_SPECIFIERS);
Richard Smithefc884a2016-04-13 07:41:35 +00001289 RECORD(DECL_CXX_CTOR_INITIALIZERS);
Douglas Gregor0beaec02011-02-08 16:34:17 +00001290 RECORD(DECL_INDIRECTFIELD);
1291 RECORD(DECL_EXPANDED_NON_TYPE_TEMPLATE_PARM_PACK);
Richard Smithefc884a2016-04-13 07:41:35 +00001292 RECORD(DECL_EXPANDED_TEMPLATE_TEMPLATE_PARM_PACK);
1293 RECORD(DECL_CLASS_SCOPE_FUNCTION_SPECIALIZATION);
1294 RECORD(DECL_IMPORT);
1295 RECORD(DECL_OMP_THREADPRIVATE);
1296 RECORD(DECL_EMPTY);
1297 RECORD(DECL_OBJC_TYPE_PARAM);
1298 RECORD(DECL_OMP_CAPTUREDEXPR);
1299 RECORD(DECL_PRAGMA_COMMENT);
1300 RECORD(DECL_PRAGMA_DETECT_MISMATCH);
1301 RECORD(DECL_OMP_DECLARE_REDUCTION);
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00001302
Douglas Gregor03412ba2011-06-03 02:27:19 +00001303 // Statements and Exprs can occur in the Decls and Types block.
1304 AddStmtsExprs(Stream, Record);
1305
Douglas Gregor92a96f52011-02-08 21:58:10 +00001306 BLOCK(PREPROCESSOR_DETAIL_BLOCK);
Chandler Carruthf92ac9e2011-07-15 07:25:21 +00001307 RECORD(PPD_MACRO_EXPANSION);
Douglas Gregor92a96f52011-02-08 21:58:10 +00001308 RECORD(PPD_MACRO_DEFINITION);
1309 RECORD(PPD_INCLUSION_DIRECTIVE);
Douglas Gregor6623e1f2015-11-03 18:33:07 +00001310
1311 // Decls and Types block.
1312 BLOCK(EXTENSION_BLOCK);
1313 RECORD(EXTENSION_METADATA);
1314
Duncan P. N. Exon Smith60fa2882017-03-13 18:45:08 +00001315 BLOCK(UNHASHED_CONTROL_BLOCK);
1316 RECORD(SIGNATURE);
1317 RECORD(DIAGNOSTIC_OPTIONS);
1318 RECORD(DIAG_PRAGMA_MAPPINGS);
1319
Chris Lattner28fa4e62009-04-26 22:26:21 +00001320#undef RECORD
1321#undef BLOCK
1322 Stream.ExitBlock();
1323}
1324
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001325/// Prepares a path for being written to an AST file by converting it
Richard Smith54cc3c22014-12-11 20:50:24 +00001326/// to an absolute path and removing nested './'s.
1327///
1328/// \return \c true if the path was changed.
Benjamin Kramer6a96ae52015-02-06 18:36:04 +00001329static bool cleanPathForOutput(FileManager &FileMgr,
1330 SmallVectorImpl<char> &Path) {
Argyrios Kyrtzidis403cbcb2015-07-31 01:39:23 +00001331 bool Changed = FileMgr.makeAbsolutePath(Path);
Mike Aizatskyaeb9dd92015-11-09 19:12:18 +00001332 return Changed | llvm::sys::path::remove_dots(Path);
Richard Smith54cc3c22014-12-11 20:50:24 +00001333}
1334
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001335/// Adjusts the given filename to only write out the portion of the
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001336/// filename that is not part of the system root directory.
Mike Stump11289f42009-09-09 15:08:12 +00001337///
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001338/// \param Filename the file name to adjust.
1339///
Richard Smith7ed1bc92014-12-05 22:42:13 +00001340/// \param BaseDir When non-NULL, the PCH file is a relocatable AST file and
1341/// the returned filename will be adjusted by this root directory.
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001342///
1343/// \returns either the original filename (if it needs no adjustment) or the
1344/// adjusted filename (which points into the @p Filename parameter).
Mike Stump11289f42009-09-09 15:08:12 +00001345static const char *
Richard Smith7ed1bc92014-12-05 22:42:13 +00001346adjustFilenameForRelocatableAST(const char *Filename, StringRef BaseDir) {
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001347 assert(Filename && "No file name to adjust?");
Mike Stump11289f42009-09-09 15:08:12 +00001348
Richard Smith7ed1bc92014-12-05 22:42:13 +00001349 if (BaseDir.empty())
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001350 return Filename;
Mike Stump11289f42009-09-09 15:08:12 +00001351
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001352 // Verify that the filename and the system root have the same prefix.
1353 unsigned Pos = 0;
Richard Smith7ed1bc92014-12-05 22:42:13 +00001354 for (; Filename[Pos] && Pos < BaseDir.size(); ++Pos)
1355 if (Filename[Pos] != BaseDir[Pos])
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001356 return Filename; // Prefixes don't match.
Mike Stump11289f42009-09-09 15:08:12 +00001357
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001358 // We hit the end of the filename before we hit the end of the system root.
1359 if (!Filename[Pos])
1360 return Filename;
Mike Stump11289f42009-09-09 15:08:12 +00001361
Richard Smith7ed1bc92014-12-05 22:42:13 +00001362 // If there's not a path separator at the end of the base directory nor
1363 // immediately after it, then this isn't within the base directory.
1364 if (!llvm::sys::path::is_separator(Filename[Pos])) {
1365 if (!llvm::sys::path::is_separator(BaseDir.back()))
1366 return Filename;
1367 } else {
1368 // If the file name has a '/' at the current position, skip over the '/'.
1369 // We distinguish relative paths from absolute paths by the
1370 // absence of '/' at the beginning of relative paths.
1371 //
1372 // FIXME: This is wrong. We distinguish them by asking if the path is
1373 // absolute, which isn't the same thing. And there might be multiple '/'s
1374 // in a row. Use a better mechanism to indicate whether we have emitted an
1375 // absolute or relative path.
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001376 ++Pos;
Richard Smith7ed1bc92014-12-05 22:42:13 +00001377 }
Mike Stump11289f42009-09-09 15:08:12 +00001378
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001379 return Filename + Pos;
1380}
Chris Lattner28fa4e62009-04-26 22:26:21 +00001381
Duncan P. N. Exon Smith60fa2882017-03-13 18:45:08 +00001382ASTFileSignature ASTWriter::createSignature(StringRef Bytes) {
1383 // Calculate the hash till start of UNHASHED_CONTROL_BLOCK.
1384 llvm::SHA1 Hasher;
1385 Hasher.update(ArrayRef<uint8_t>(Bytes.bytes_begin(), Bytes.size()));
1386 auto Hash = Hasher.result();
1387
1388 // Convert to an array [5*i32].
1389 ASTFileSignature Signature;
1390 auto LShift = [&](unsigned char Val, unsigned Shift) {
1391 return (uint32_t)Val << Shift;
1392 };
1393 for (int I = 0; I != 5; ++I)
1394 Signature[I] = LShift(Hash[I * 4 + 0], 24) | LShift(Hash[I * 4 + 1], 16) |
1395 LShift(Hash[I * 4 + 2], 8) | LShift(Hash[I * 4 + 3], 0);
1396
1397 return Signature;
1398}
1399
1400ASTFileSignature ASTWriter::writeUnhashedControlBlock(Preprocessor &PP,
1401 ASTContext &Context) {
1402 // Flush first to prepare the PCM hash (signature).
1403 Stream.FlushToWord();
1404 auto StartOfUnhashedControl = Stream.GetCurrentBitNo() >> 3;
1405
1406 // Enter the block and prepare to write records.
1407 RecordData Record;
1408 Stream.EnterSubblock(UNHASHED_CONTROL_BLOCK_ID, 5);
1409
1410 // For implicit modules, write the hash of the PCM as its signature.
1411 ASTFileSignature Signature;
1412 if (WritingModule &&
1413 PP.getHeaderSearchInfo().getHeaderSearchOpts().ModulesHashContent) {
1414 Signature = createSignature(StringRef(Buffer.begin(), StartOfUnhashedControl));
1415 Record.append(Signature.begin(), Signature.end());
1416 Stream.EmitRecord(SIGNATURE, Record);
1417 Record.clear();
Ben Langmuir487ea142014-10-23 18:05:36 +00001418 }
Duncan P. N. Exon Smith60fa2882017-03-13 18:45:08 +00001419
1420 // Diagnostic options.
1421 const auto &Diags = Context.getDiagnostics();
1422 const DiagnosticOptions &DiagOpts = Diags.getDiagnosticOptions();
1423#define DIAGOPT(Name, Bits, Default) Record.push_back(DiagOpts.Name);
1424#define ENUM_DIAGOPT(Name, Type, Bits, Default) \
1425 Record.push_back(static_cast<unsigned>(DiagOpts.get##Name()));
1426#include "clang/Basic/DiagnosticOptions.def"
1427 Record.push_back(DiagOpts.Warnings.size());
1428 for (unsigned I = 0, N = DiagOpts.Warnings.size(); I != N; ++I)
1429 AddString(DiagOpts.Warnings[I], Record);
1430 Record.push_back(DiagOpts.Remarks.size());
1431 for (unsigned I = 0, N = DiagOpts.Remarks.size(); I != N; ++I)
1432 AddString(DiagOpts.Remarks[I], Record);
1433 // Note: we don't serialize the log or serialization file names, because they
1434 // are generally transient files and will almost always be overridden.
1435 Stream.EmitRecord(DIAGNOSTIC_OPTIONS, Record);
1436
1437 // Write out the diagnostic/pragma mappings.
1438 WritePragmaDiagnosticMappings(Diags, /* IsModule = */ WritingModule);
1439
1440 // Leave the options block.
1441 Stream.ExitBlock();
1442 return Signature;
Ben Langmuir487ea142014-10-23 18:05:36 +00001443}
1444
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001445/// Write the control block.
Duncan P. N. Exon Smith60fa2882017-03-13 18:45:08 +00001446void ASTWriter::WriteControlBlock(Preprocessor &PP, ASTContext &Context,
1447 StringRef isysroot,
1448 const std::string &OutputFile) {
Douglas Gregorbfbde532009-04-10 21:16:55 +00001449 using namespace llvm;
Eugene Zelenkob7d89102017-11-11 00:08:50 +00001450
Douglas Gregor0aa21c92012-10-18 18:27:37 +00001451 Stream.EnterSubblock(CONTROL_BLOCK_ID, 5);
Mehdi Amini5ae4a852015-09-09 20:35:37 +00001452 RecordData Record;
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00001453
Douglas Gregor0086a5a2009-07-07 00:12:59 +00001454 // Metadata
David Blaikieb44f0bf2017-01-04 22:36:43 +00001455 auto MetadataAbbrev = std::make_shared<BitCodeAbbrev>();
Douglas Gregor0aa21c92012-10-18 18:27:37 +00001456 MetadataAbbrev->Add(BitCodeAbbrevOp(METADATA));
1457 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 16)); // Major
1458 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 16)); // Minor
1459 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 16)); // Clang maj.
1460 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 16)); // Clang min.
1461 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Relocatable
Richard Smithe75ee0f2015-08-17 07:13:32 +00001462 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Timestamps
Hans Wennborg08c5a7b2018-06-25 13:23:49 +00001463 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // PCHHasObjectFile
Douglas Gregor0aa21c92012-10-18 18:27:37 +00001464 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Errors
1465 MetadataAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // SVN branch/tag
David Blaikieb44f0bf2017-01-04 22:36:43 +00001466 unsigned MetadataAbbrevCode = Stream.EmitAbbrev(std::move(MetadataAbbrev));
Richard Smith7ed1bc92014-12-05 22:42:13 +00001467 assert((!WritingModule || isysroot.empty()) &&
1468 "writing module as a relocatable PCH?");
Mehdi Amini57a41912015-09-10 01:46:39 +00001469 {
Hans Wennborg08c5a7b2018-06-25 13:23:49 +00001470 RecordData::value_type Record[] = {
1471 METADATA,
1472 VERSION_MAJOR,
1473 VERSION_MINOR,
1474 CLANG_VERSION_MAJOR,
1475 CLANG_VERSION_MINOR,
1476 !isysroot.empty(),
1477 IncludeTimestamps,
1478 Context.getLangOpts().BuildingPCHWithObjectFile,
1479 ASTHasCompilerErrors};
Mehdi Amini57a41912015-09-10 01:46:39 +00001480 Stream.EmitRecordWithBlob(MetadataAbbrevCode, Record,
1481 getClangFullRepositoryVersion());
1482 }
Chandler Carruth885e78c2015-03-24 21:18:10 +00001483
Richard Smith8b706102017-05-31 20:56:55 +00001484 if (WritingModule) {
Richard Smith7ed1bc92014-12-05 22:42:13 +00001485 // Module name
David Blaikieb44f0bf2017-01-04 22:36:43 +00001486 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Ben Langmuirbeee15e2014-04-14 18:00:01 +00001487 Abbrev->Add(BitCodeAbbrevOp(MODULE_NAME));
1488 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
David Blaikieb44f0bf2017-01-04 22:36:43 +00001489 unsigned AbbrevCode = Stream.EmitAbbrev(std::move(Abbrev));
Mehdi Amini57a41912015-09-10 01:46:39 +00001490 RecordData::value_type Record[] = {MODULE_NAME};
Ben Langmuirbeee15e2014-04-14 18:00:01 +00001491 Stream.EmitRecordWithBlob(AbbrevCode, Record, WritingModule->Name);
1492 }
1493
Richard Smith7ed1bc92014-12-05 22:42:13 +00001494 if (WritingModule && WritingModule->Directory) {
Richard Smith7ed1bc92014-12-05 22:42:13 +00001495 SmallString<128> BaseDir(WritingModule->Directory->getName());
Richard Smith54cc3c22014-12-11 20:50:24 +00001496 cleanPathForOutput(Context.getSourceManager().getFileManager(), BaseDir);
Richard Smithf7b41372015-08-13 23:47:44 +00001497
1498 // If the home of the module is the current working directory, then we
1499 // want to pick up the cwd of the build process loading the module, not
1500 // our cwd, when we load this module.
1501 if (!PP.getHeaderSearchInfo()
1502 .getHeaderSearchOpts()
1503 .ModuleMapFileHomeIsCwd ||
1504 WritingModule->Directory->getName() != StringRef(".")) {
1505 // Module directory.
David Blaikieb44f0bf2017-01-04 22:36:43 +00001506 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Richard Smithf7b41372015-08-13 23:47:44 +00001507 Abbrev->Add(BitCodeAbbrevOp(MODULE_DIRECTORY));
1508 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Directory
David Blaikieb44f0bf2017-01-04 22:36:43 +00001509 unsigned AbbrevCode = Stream.EmitAbbrev(std::move(Abbrev));
Richard Smithf7b41372015-08-13 23:47:44 +00001510
Mehdi Amini57a41912015-09-10 01:46:39 +00001511 RecordData::value_type Record[] = {MODULE_DIRECTORY};
Richard Smithf7b41372015-08-13 23:47:44 +00001512 Stream.EmitRecordWithBlob(AbbrevCode, Record, BaseDir);
1513 }
Richard Smith7ed1bc92014-12-05 22:42:13 +00001514
1515 // Write out all other paths relative to the base directory if possible.
1516 BaseDirectory.assign(BaseDir.begin(), BaseDir.end());
1517 } else if (!isysroot.empty()) {
1518 // Write out paths relative to the sysroot if possible.
1519 BaseDirectory = isysroot;
1520 }
1521
Ben Langmuirbeee15e2014-04-14 18:00:01 +00001522 // Module map file
Richard Smithd19389a2017-07-05 07:47:11 +00001523 if (WritingModule && WritingModule->Kind == Module::ModuleMapModule) {
Mehdi Amini5ae4a852015-09-09 20:35:37 +00001524 Record.clear();
Ben Langmuirbeee15e2014-04-14 18:00:01 +00001525
Ben Langmuir4b8a9e92014-08-12 16:42:33 +00001526 auto &Map = PP.getHeaderSearchInfo().getModuleMap();
Richard Smith8b706102017-05-31 20:56:55 +00001527 AddPath(WritingModule->PresumedModuleMapFile.empty()
1528 ? Map.getModuleMapFileForUniquing(WritingModule)->getName()
1529 : StringRef(WritingModule->PresumedModuleMapFile),
1530 Record);
Ben Langmuir4b8a9e92014-08-12 16:42:33 +00001531
1532 // Additional module map files.
Richard Smith7ed1bc92014-12-05 22:42:13 +00001533 if (auto *AdditionalModMaps =
1534 Map.getAdditionalModuleMapFiles(WritingModule)) {
Ben Langmuir4b8a9e92014-08-12 16:42:33 +00001535 Record.push_back(AdditionalModMaps->size());
1536 for (const FileEntry *F : *AdditionalModMaps)
Richard Smith7ed1bc92014-12-05 22:42:13 +00001537 AddPath(F->getName(), Record);
Ben Langmuir4b8a9e92014-08-12 16:42:33 +00001538 } else {
1539 Record.push_back(0);
1540 }
1541
1542 Stream.EmitRecord(MODULE_MAP_FILE, Record);
Ben Langmuirbeee15e2014-04-14 18:00:01 +00001543 }
1544
Douglas Gregor112b9072012-10-18 05:31:06 +00001545 // Imports
Douglas Gregor29cc6422011-08-17 21:07:30 +00001546 if (Chain) {
Douglas Gregor29cc6422011-08-17 21:07:30 +00001547 serialization::ModuleManager &Mgr = Chain->getModuleManager();
Mehdi Amini5ae4a852015-09-09 20:35:37 +00001548 Record.clear();
Douglas Gregordf0c1512011-08-18 04:12:04 +00001549
Duncan P. N. Exon Smith96a06e02017-01-28 22:15:22 +00001550 for (ModuleFile &M : Mgr) {
Douglas Gregordf0c1512011-08-18 04:12:04 +00001551 // Skip modules that weren't directly imported.
Duncan P. N. Exon Smith96a06e02017-01-28 22:15:22 +00001552 if (!M.isDirectlyImported())
Douglas Gregordf0c1512011-08-18 04:12:04 +00001553 continue;
1554
Duncan P. N. Exon Smith96a06e02017-01-28 22:15:22 +00001555 Record.push_back((unsigned)M.Kind); // FIXME: Stable encoding
1556 AddSourceLocation(M.ImportLoc, Record);
Duncan P. N. Exon Smith60fa2882017-03-13 18:45:08 +00001557
1558 // If we have calculated signature, there is no need to store
1559 // the size or timestamp.
1560 Record.push_back(M.Signature ? 0 : M.File->getSize());
1561 Record.push_back(M.Signature ? 0 : getTimestampForOutput(M.File));
1562
1563 for (auto I : M.Signature)
1564 Record.push_back(I);
1565
Boris Kolpackovd30446f2017-08-31 06:26:43 +00001566 AddString(M.ModuleName, Record);
Duncan P. N. Exon Smith96a06e02017-01-28 22:15:22 +00001567 AddPath(M.FileName, Record);
Douglas Gregordf0c1512011-08-18 04:12:04 +00001568 }
Douglas Gregor29cc6422011-08-17 21:07:30 +00001569 Stream.EmitRecord(IMPORTS, Record);
1570 }
Mike Stump11289f42009-09-09 15:08:12 +00001571
Richard Smith0516b182015-09-08 19:40:14 +00001572 // Write the options block.
1573 Stream.EnterSubblock(OPTIONS_BLOCK_ID, 4);
1574
Douglas Gregor112b9072012-10-18 05:31:06 +00001575 // Language options.
Mehdi Amini5ae4a852015-09-09 20:35:37 +00001576 Record.clear();
Douglas Gregor112b9072012-10-18 05:31:06 +00001577 const LangOptions &LangOpts = Context.getLangOpts();
1578#define LANGOPT(Name, Bits, Default, Description) \
1579 Record.push_back(LangOpts.Name);
1580#define ENUM_LANGOPT(Name, Type, Bits, Default, Description) \
1581 Record.push_back(static_cast<unsigned>(LangOpts.get##Name()));
Alexey Samsonovedf99a92014-11-07 22:29:38 +00001582#include "clang/Basic/LangOptions.def"
1583#define SANITIZER(NAME, ID) \
1584 Record.push_back(LangOpts.Sanitize.has(SanitizerKind::ID));
Will Dietzf54319c2013-01-18 11:30:38 +00001585#include "clang/Basic/Sanitizers.def"
Douglas Gregor112b9072012-10-18 05:31:06 +00001586
Ben Langmuircd98cb72015-06-23 18:20:18 +00001587 Record.push_back(LangOpts.ModuleFeatures.size());
1588 for (StringRef Feature : LangOpts.ModuleFeatures)
1589 AddString(Feature, Record);
1590
Douglas Gregor112b9072012-10-18 05:31:06 +00001591 Record.push_back((unsigned) LangOpts.ObjCRuntime.getKind());
1592 AddVersionTuple(LangOpts.ObjCRuntime.getVersion(), Record);
Ben Langmuird4a667a2015-06-23 18:20:23 +00001593
1594 AddString(LangOpts.CurrentModule, Record);
Dmitri Gribenkoacf2e782013-02-22 14:21:27 +00001595
1596 // Comment options.
1597 Record.push_back(LangOpts.CommentOpts.BlockCommandNames.size());
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00001598 for (const auto &I : LangOpts.CommentOpts.BlockCommandNames) {
1599 AddString(I, Record);
Dmitri Gribenkoacf2e782013-02-22 14:21:27 +00001600 }
Dmitri Gribenkoa7d16ce2013-04-10 15:35:17 +00001601 Record.push_back(LangOpts.CommentOpts.ParseAllComments);
Dmitri Gribenkoacf2e782013-02-22 14:21:27 +00001602
Samuel Antaoee8fb302016-01-06 13:42:12 +00001603 // OpenMP offloading options.
1604 Record.push_back(LangOpts.OMPTargetTriples.size());
1605 for (auto &T : LangOpts.OMPTargetTriples)
1606 AddString(T.getTriple(), Record);
1607
1608 AddString(LangOpts.OMPHostIRFile, Record);
1609
Douglas Gregor112b9072012-10-18 05:31:06 +00001610 Stream.EmitRecord(LANGUAGE_OPTIONS, Record);
1611
Douglas Gregor4d3611c2012-10-18 17:58:09 +00001612 // Target options.
1613 Record.clear();
Douglas Gregor0aa21c92012-10-18 18:27:37 +00001614 const TargetInfo &Target = Context.getTargetInfo();
1615 const TargetOptions &TargetOpts = Target.getTargetOpts();
Douglas Gregor4d3611c2012-10-18 17:58:09 +00001616 AddString(TargetOpts.Triple, Record);
1617 AddString(TargetOpts.CPU, Record);
1618 AddString(TargetOpts.ABI, Record);
Douglas Gregor4d3611c2012-10-18 17:58:09 +00001619 Record.push_back(TargetOpts.FeaturesAsWritten.size());
1620 for (unsigned I = 0, N = TargetOpts.FeaturesAsWritten.size(); I != N; ++I) {
1621 AddString(TargetOpts.FeaturesAsWritten[I], Record);
1622 }
1623 Record.push_back(TargetOpts.Features.size());
1624 for (unsigned I = 0, N = TargetOpts.Features.size(); I != N; ++I) {
1625 AddString(TargetOpts.Features[I], Record);
1626 }
1627 Stream.EmitRecord(TARGET_OPTIONS, Record);
1628
Douglas Gregorc6317db2012-10-24 15:49:58 +00001629 // File system options.
1630 Record.clear();
Yaron Keren8dec46c2015-08-26 08:10:22 +00001631 const FileSystemOptions &FSOpts =
1632 Context.getSourceManager().getFileManager().getFileSystemOpts();
Douglas Gregorc6317db2012-10-24 15:49:58 +00001633 AddString(FSOpts.WorkingDir, Record);
1634 Stream.EmitRecord(FILE_SYSTEM_OPTIONS, Record);
1635
Douglas Gregor2d302362012-10-24 16:50:34 +00001636 // Header search options.
1637 Record.clear();
1638 const HeaderSearchOptions &HSOpts
1639 = PP.getHeaderSearchInfo().getHeaderSearchOpts();
1640 AddString(HSOpts.Sysroot, Record);
1641
1642 // Include entries.
1643 Record.push_back(HSOpts.UserEntries.size());
1644 for (unsigned I = 0, N = HSOpts.UserEntries.size(); I != N; ++I) {
1645 const HeaderSearchOptions::Entry &Entry = HSOpts.UserEntries[I];
1646 AddString(Entry.Path, Record);
1647 Record.push_back(static_cast<unsigned>(Entry.Group));
Douglas Gregor2d302362012-10-24 16:50:34 +00001648 Record.push_back(Entry.IsFramework);
1649 Record.push_back(Entry.IgnoreSysRoot);
Douglas Gregor2d302362012-10-24 16:50:34 +00001650 }
1651
1652 // System header prefixes.
1653 Record.push_back(HSOpts.SystemHeaderPrefixes.size());
1654 for (unsigned I = 0, N = HSOpts.SystemHeaderPrefixes.size(); I != N; ++I) {
1655 AddString(HSOpts.SystemHeaderPrefixes[I].Prefix, Record);
1656 Record.push_back(HSOpts.SystemHeaderPrefixes[I].IsSystemHeader);
1657 }
1658
1659 AddString(HSOpts.ResourceDir, Record);
1660 AddString(HSOpts.ModuleCachePath, Record);
Argyrios Kyrtzidis1594c152014-03-03 08:12:05 +00001661 AddString(HSOpts.ModuleUserBuildPath, Record);
Douglas Gregor2d302362012-10-24 16:50:34 +00001662 Record.push_back(HSOpts.DisableModuleHash);
Richard Smith18934752017-06-06 00:32:01 +00001663 Record.push_back(HSOpts.ImplicitModuleMaps);
1664 Record.push_back(HSOpts.ModuleMapFileHomeIsCwd);
Douglas Gregor2d302362012-10-24 16:50:34 +00001665 Record.push_back(HSOpts.UseBuiltinIncludes);
1666 Record.push_back(HSOpts.UseStandardSystemIncludes);
1667 Record.push_back(HSOpts.UseStandardCXXIncludes);
1668 Record.push_back(HSOpts.UseLibcxx);
Argyrios Kyrtzidisbd0b6512015-02-19 20:12:20 +00001669 // Write out the specific module cache path that contains the module files.
1670 AddString(PP.getHeaderSearchInfo().getModuleCachePath(), Record);
Douglas Gregor2d302362012-10-24 16:50:34 +00001671 Stream.EmitRecord(HEADER_SEARCH_OPTIONS, Record);
1672
Douglas Gregorb6af6c22012-10-24 20:05:57 +00001673 // Preprocessor options.
1674 Record.clear();
1675 const PreprocessorOptions &PPOpts = PP.getPreprocessorOpts();
1676
1677 // Macro definitions.
1678 Record.push_back(PPOpts.Macros.size());
1679 for (unsigned I = 0, N = PPOpts.Macros.size(); I != N; ++I) {
1680 AddString(PPOpts.Macros[I].first, Record);
1681 Record.push_back(PPOpts.Macros[I].second);
1682 }
1683
1684 // Includes
1685 Record.push_back(PPOpts.Includes.size());
1686 for (unsigned I = 0, N = PPOpts.Includes.size(); I != N; ++I)
1687 AddString(PPOpts.Includes[I], Record);
1688
1689 // Macro includes
1690 Record.push_back(PPOpts.MacroIncludes.size());
1691 for (unsigned I = 0, N = PPOpts.MacroIncludes.size(); I != N; ++I)
1692 AddString(PPOpts.MacroIncludes[I], Record);
1693
Douglas Gregorb6368752012-10-24 23:41:50 +00001694 Record.push_back(PPOpts.UsePredefines);
Argyrios Kyrtzidisd3afa0c2013-04-26 21:33:40 +00001695 // Detailed record is important since it is used for the module cache hash.
1696 Record.push_back(PPOpts.DetailedRecord);
Douglas Gregorb6af6c22012-10-24 20:05:57 +00001697 AddString(PPOpts.ImplicitPCHInclude, Record);
1698 AddString(PPOpts.ImplicitPTHInclude, Record);
1699 Record.push_back(static_cast<unsigned>(PPOpts.ObjCXXARCStandardLibrary));
1700 Stream.EmitRecord(PREPROCESSOR_OPTIONS, Record);
1701
Richard Smith0516b182015-09-08 19:40:14 +00001702 // Leave the options block.
1703 Stream.ExitBlock();
1704
Douglas Gregora3b20262011-05-06 21:43:30 +00001705 // Original file name and file ID
Douglas Gregor45fe0362009-05-12 01:31:05 +00001706 SourceManager &SM = Context.getSourceManager();
1707 if (const FileEntry *MainFile = SM.getFileEntryForID(SM.getMainFileID())) {
David Blaikieb44f0bf2017-01-04 22:36:43 +00001708 auto FileAbbrev = std::make_shared<BitCodeAbbrev>();
Douglas Gregorfad10d82012-10-18 18:36:53 +00001709 FileAbbrev->Add(BitCodeAbbrevOp(ORIGINAL_FILE));
1710 FileAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // File ID
Douglas Gregor45fe0362009-05-12 01:31:05 +00001711 FileAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // File name
David Blaikieb44f0bf2017-01-04 22:36:43 +00001712 unsigned FileAbbrevCode = Stream.EmitAbbrev(std::move(FileAbbrev));
Douglas Gregor45fe0362009-05-12 01:31:05 +00001713
Douglas Gregorb6af6c22012-10-24 20:05:57 +00001714 Record.clear();
Douglas Gregorfad10d82012-10-18 18:36:53 +00001715 Record.push_back(ORIGINAL_FILE);
Douglas Gregora3b20262011-05-06 21:43:30 +00001716 Record.push_back(SM.getMainFileID().getOpaqueValue());
Richard Smith7ed1bc92014-12-05 22:42:13 +00001717 EmitRecordWithPath(FileAbbrevCode, Record, MainFile->getName());
Douglas Gregor45fe0362009-05-12 01:31:05 +00001718 }
Kovarththanan Rajaratnama9c81a82010-03-14 07:06:50 +00001719
Argyrios Kyrtzidis52595242012-11-15 18:57:27 +00001720 Record.clear();
1721 Record.push_back(SM.getMainFileID().getOpaqueValue());
1722 Stream.EmitRecord(ORIGINAL_FILE_ID, Record);
1723
Argyrios Kyrtzidis10b23682011-02-15 17:54:22 +00001724 // Original PCH directory
1725 if (!OutputFile.empty() && OutputFile != "-") {
David Blaikieb44f0bf2017-01-04 22:36:43 +00001726 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Argyrios Kyrtzidis10b23682011-02-15 17:54:22 +00001727 Abbrev->Add(BitCodeAbbrevOp(ORIGINAL_PCH_DIR));
1728 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // File name
David Blaikieb44f0bf2017-01-04 22:36:43 +00001729 unsigned AbbrevCode = Stream.EmitAbbrev(std::move(Abbrev));
Argyrios Kyrtzidis10b23682011-02-15 17:54:22 +00001730
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00001731 SmallString<128> OutputPath(OutputFile);
Argyrios Kyrtzidis10b23682011-02-15 17:54:22 +00001732
Argyrios Kyrtzidisc56419e2015-07-31 00:58:32 +00001733 SM.getFileManager().makeAbsolutePath(OutputPath);
Argyrios Kyrtzidis10b23682011-02-15 17:54:22 +00001734 StringRef origDir = llvm::sys::path::parent_path(OutputPath);
1735
Mehdi Amini57a41912015-09-10 01:46:39 +00001736 RecordData::value_type Record[] = {ORIGINAL_PCH_DIR};
Argyrios Kyrtzidis10b23682011-02-15 17:54:22 +00001737 Stream.EmitRecordWithBlob(AbbrevCode, Record, origDir);
1738 }
1739
Douglas Gregor49491f72013-03-15 22:15:07 +00001740 WriteInputFiles(Context.SourceMgr,
1741 PP.getHeaderSearchInfo().getHeaderSearchOpts(),
Douglas Gregora3dd9002013-07-22 20:48:33 +00001742 PP.getLangOpts().Modules);
Douglas Gregor72be3902012-10-19 00:38:02 +00001743 Stream.ExitBlock();
1744}
1745
Douglas Gregor49491f72013-03-15 22:15:07 +00001746namespace {
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +00001747
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001748/// An input file.
Eugene Zelenkob7d89102017-11-11 00:08:50 +00001749struct InputFileEntry {
1750 const FileEntry *File;
1751 bool IsSystemFile;
1752 bool IsTransient;
1753 bool BufferOverridden;
1754 bool IsTopLevelModuleMap;
1755};
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +00001756
Eugene Zelenkob7d89102017-11-11 00:08:50 +00001757} // namespace
Douglas Gregor49491f72013-03-15 22:15:07 +00001758
1759void ASTWriter::WriteInputFiles(SourceManager &SourceMgr,
1760 HeaderSearchOptions &HSOpts,
Douglas Gregora3dd9002013-07-22 20:48:33 +00001761 bool Modules) {
Douglas Gregor72be3902012-10-19 00:38:02 +00001762 using namespace llvm;
Eugene Zelenkob7d89102017-11-11 00:08:50 +00001763
Douglas Gregor72be3902012-10-19 00:38:02 +00001764 Stream.EnterSubblock(INPUT_FILES_BLOCK_ID, 4);
Mehdi Amini57a41912015-09-10 01:46:39 +00001765
Douglas Gregor72be3902012-10-19 00:38:02 +00001766 // Create input-file abbreviation.
David Blaikieb44f0bf2017-01-04 22:36:43 +00001767 auto IFAbbrev = std::make_shared<BitCodeAbbrev>();
Douglas Gregor72be3902012-10-19 00:38:02 +00001768 IFAbbrev->Add(BitCodeAbbrevOp(INPUT_FILE));
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001769 IFAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // ID
Douglas Gregor72be3902012-10-19 00:38:02 +00001770 IFAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 12)); // Size
1771 IFAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 32)); // Modification time
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001772 IFAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Overridden
Richard Smitha8cfffa2015-11-26 02:04:16 +00001773 IFAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Transient
Richard Smithf3f84612017-06-29 02:19:42 +00001774 IFAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Module map
Douglas Gregor72be3902012-10-19 00:38:02 +00001775 IFAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // File name
David Blaikieb44f0bf2017-01-04 22:36:43 +00001776 unsigned IFAbbrevCode = Stream.EmitAbbrev(std::move(IFAbbrev));
Douglas Gregor72be3902012-10-19 00:38:02 +00001777
Argyrios Kyrtzidis7d238572013-03-06 18:12:50 +00001778 // Get all ContentCache objects for files, sorted by whether the file is a
1779 // system one or not. System files go at the back, users files at the front.
Douglas Gregor49491f72013-03-15 22:15:07 +00001780 std::deque<InputFileEntry> SortedFiles;
Douglas Gregor72be3902012-10-19 00:38:02 +00001781 for (unsigned I = 1, N = SourceMgr.local_sloc_entry_size(); I != N; ++I) {
1782 // Get this source location entry.
1783 const SrcMgr::SLocEntry *SLoc = &SourceMgr.getLocalSLocEntry(I);
NAKAMURA Takumideca50f2012-10-19 01:53:57 +00001784 assert(&SourceMgr.getSLocEntry(FileID::get(I)) == SLoc);
Douglas Gregor72be3902012-10-19 00:38:02 +00001785
1786 // We only care about file entries that were not overridden.
1787 if (!SLoc->isFile())
1788 continue;
Richard Smithf3f84612017-06-29 02:19:42 +00001789 const SrcMgr::FileInfo &File = SLoc->getFile();
1790 const SrcMgr::ContentCache *Cache = File.getContentCache();
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001791 if (!Cache->OrigEntry)
Douglas Gregor72be3902012-10-19 00:38:02 +00001792 continue;
1793
Douglas Gregor49491f72013-03-15 22:15:07 +00001794 InputFileEntry Entry;
1795 Entry.File = Cache->OrigEntry;
1796 Entry.IsSystemFile = Cache->IsSystemFile;
Richard Smitha8cfffa2015-11-26 02:04:16 +00001797 Entry.IsTransient = Cache->IsTransient;
Douglas Gregor49491f72013-03-15 22:15:07 +00001798 Entry.BufferOverridden = Cache->BufferOverridden;
Richard Smithf3f84612017-06-29 02:19:42 +00001799 Entry.IsTopLevelModuleMap = isModuleMap(File.getFileCharacteristic()) &&
1800 File.getIncludeLoc().isInvalid();
Argyrios Kyrtzidis7d238572013-03-06 18:12:50 +00001801 if (Cache->IsSystemFile)
Douglas Gregor49491f72013-03-15 22:15:07 +00001802 SortedFiles.push_back(Entry);
Argyrios Kyrtzidis7d238572013-03-06 18:12:50 +00001803 else
Douglas Gregor49491f72013-03-15 22:15:07 +00001804 SortedFiles.push_front(Entry);
1805 }
1806
Argyrios Kyrtzidis7d238572013-03-06 18:12:50 +00001807 unsigned UserFilesNum = 0;
1808 // Write out all of the input files.
Richard Smithec216502015-02-13 19:48:37 +00001809 std::vector<uint64_t> InputFileOffsets;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00001810 for (const auto &Entry : SortedFiles) {
Douglas Gregor49491f72013-03-15 22:15:07 +00001811 uint32_t &InputFileID = InputFileIDs[Entry.File];
Argyrios Kyrtzidise65856f2012-12-11 07:48:08 +00001812 if (InputFileID != 0)
1813 continue; // already recorded this file.
1814
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001815 // Record this entry's offset.
1816 InputFileOffsets.push_back(Stream.GetCurrentBitNo());
Argyrios Kyrtzidise65856f2012-12-11 07:48:08 +00001817
1818 InputFileID = InputFileOffsets.size();
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001819
Douglas Gregor49491f72013-03-15 22:15:07 +00001820 if (!Entry.IsSystemFile)
Argyrios Kyrtzidis7d238572013-03-06 18:12:50 +00001821 ++UserFilesNum;
1822
Douglas Gregor72be3902012-10-19 00:38:02 +00001823 // Emit size/modification time for this file.
Mehdi Amini57a41912015-09-10 01:46:39 +00001824 // And whether this file was overridden.
1825 RecordData::value_type Record[] = {
Richard Smitha8cfffa2015-11-26 02:04:16 +00001826 INPUT_FILE,
1827 InputFileOffsets.size(),
1828 (uint64_t)Entry.File->getSize(),
1829 (uint64_t)getTimestampForOutput(Entry.File),
1830 Entry.BufferOverridden,
Richard Smithf3f84612017-06-29 02:19:42 +00001831 Entry.IsTransient,
1832 Entry.IsTopLevelModuleMap};
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001833
Richard Smith7ed1bc92014-12-05 22:42:13 +00001834 EmitRecordWithPath(IFAbbrevCode, Record, Entry.File->getName());
1835 }
Douglas Gregor49491f72013-03-15 22:15:07 +00001836
Douglas Gregor112b9072012-10-18 05:31:06 +00001837 Stream.ExitBlock();
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001838
1839 // Create input file offsets abbreviation.
David Blaikieb44f0bf2017-01-04 22:36:43 +00001840 auto OffsetsAbbrev = std::make_shared<BitCodeAbbrev>();
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001841 OffsetsAbbrev->Add(BitCodeAbbrevOp(INPUT_FILE_OFFSETS));
1842 OffsetsAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // # input files
Argyrios Kyrtzidis7d238572013-03-06 18:12:50 +00001843 OffsetsAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // # non-system
1844 // input files
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001845 OffsetsAbbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Array
David Blaikieb44f0bf2017-01-04 22:36:43 +00001846 unsigned OffsetsAbbrevCode = Stream.EmitAbbrev(std::move(OffsetsAbbrev));
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001847
1848 // Write input file offsets.
Mehdi Amini57a41912015-09-10 01:46:39 +00001849 RecordData::value_type Record[] = {INPUT_FILE_OFFSETS,
1850 InputFileOffsets.size(), UserFilesNum};
Reid Kleckner012665e2015-05-21 00:13:09 +00001851 Stream.EmitRecordWithBlob(OffsetsAbbrevCode, Record, bytes(InputFileOffsets));
Douglas Gregor55abb232009-04-10 20:39:37 +00001852}
1853
Douglas Gregora7f71a92009-04-10 03:52:48 +00001854//===----------------------------------------------------------------------===//
1855// Source Manager Serialization
1856//===----------------------------------------------------------------------===//
1857
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001858/// Create an abbreviation for the SLocEntry that refers to a
Douglas Gregora7f71a92009-04-10 03:52:48 +00001859/// file.
Douglas Gregor8f45df52009-04-16 22:23:12 +00001860static unsigned CreateSLocFileAbbrev(llvm::BitstreamWriter &Stream) {
Douglas Gregora7f71a92009-04-10 03:52:48 +00001861 using namespace llvm;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00001862
David Blaikieb44f0bf2017-01-04 22:36:43 +00001863 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Sebastian Redl539c5062010-08-18 23:57:32 +00001864 Abbrev->Add(BitCodeAbbrevOp(SM_SLOC_FILE_ENTRY));
Douglas Gregora7f71a92009-04-10 03:52:48 +00001865 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Offset
1866 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Include location
Richard Smithf3f84612017-06-29 02:19:42 +00001867 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 3)); // Characteristic
Douglas Gregora7f71a92009-04-10 03:52:48 +00001868 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Line directives
Douglas Gregorb41ca8f2010-03-21 22:49:54 +00001869 // FileEntry fields.
Douglas Gregor3120d2c2012-10-22 18:42:04 +00001870 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Input File ID
Argyrios Kyrtzidis61ef3db2011-08-21 23:33:04 +00001871 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // NumCreatedFIDs
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00001872 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 24)); // FirstDeclIndex
1873 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // NumDecls
David Blaikieb44f0bf2017-01-04 22:36:43 +00001874 return Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregora7f71a92009-04-10 03:52:48 +00001875}
1876
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001877/// Create an abbreviation for the SLocEntry that refers to a
Douglas Gregora7f71a92009-04-10 03:52:48 +00001878/// buffer.
Douglas Gregor8f45df52009-04-16 22:23:12 +00001879static unsigned CreateSLocBufferAbbrev(llvm::BitstreamWriter &Stream) {
Douglas Gregora7f71a92009-04-10 03:52:48 +00001880 using namespace llvm;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00001881
David Blaikieb44f0bf2017-01-04 22:36:43 +00001882 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Sebastian Redl539c5062010-08-18 23:57:32 +00001883 Abbrev->Add(BitCodeAbbrevOp(SM_SLOC_BUFFER_ENTRY));
Douglas Gregora7f71a92009-04-10 03:52:48 +00001884 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Offset
1885 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Include location
Richard Smithf3f84612017-06-29 02:19:42 +00001886 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 3)); // Characteristic
Douglas Gregora7f71a92009-04-10 03:52:48 +00001887 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Line directives
1888 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Buffer name blob
David Blaikieb44f0bf2017-01-04 22:36:43 +00001889 return Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregora7f71a92009-04-10 03:52:48 +00001890}
1891
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001892/// Create an abbreviation for the SLocEntry that refers to a
Douglas Gregora7f71a92009-04-10 03:52:48 +00001893/// buffer's blob.
Richard Smithaada85c2016-02-06 02:06:43 +00001894static unsigned CreateSLocBufferBlobAbbrev(llvm::BitstreamWriter &Stream,
1895 bool Compressed) {
Douglas Gregora7f71a92009-04-10 03:52:48 +00001896 using namespace llvm;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00001897
David Blaikieb44f0bf2017-01-04 22:36:43 +00001898 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Richard Smithaada85c2016-02-06 02:06:43 +00001899 Abbrev->Add(BitCodeAbbrevOp(Compressed ? SM_SLOC_BUFFER_BLOB_COMPRESSED
1900 : SM_SLOC_BUFFER_BLOB));
1901 if (Compressed)
1902 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Uncompressed size
Douglas Gregora7f71a92009-04-10 03:52:48 +00001903 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Blob
David Blaikieb44f0bf2017-01-04 22:36:43 +00001904 return Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregora7f71a92009-04-10 03:52:48 +00001905}
1906
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00001907/// Create an abbreviation for the SLocEntry that refers to a macro
Chandler Carruthf92ac9e2011-07-15 07:25:21 +00001908/// expansion.
1909static unsigned CreateSLocExpansionAbbrev(llvm::BitstreamWriter &Stream) {
Douglas Gregora7f71a92009-04-10 03:52:48 +00001910 using namespace llvm;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00001911
David Blaikieb44f0bf2017-01-04 22:36:43 +00001912 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Chandler Carruthf92ac9e2011-07-15 07:25:21 +00001913 Abbrev->Add(BitCodeAbbrevOp(SM_SLOC_EXPANSION_ENTRY));
Douglas Gregora7f71a92009-04-10 03:52:48 +00001914 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Offset
1915 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Spelling location
1916 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // Start location
1917 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 8)); // End location
Richard Smithb5f81712018-04-30 05:25:48 +00001918 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // Is token range
Douglas Gregor83243272009-04-15 18:05:10 +00001919 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Token length
David Blaikieb44f0bf2017-01-04 22:36:43 +00001920 return Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregora7f71a92009-04-10 03:52:48 +00001921}
1922
Douglas Gregor09b69892011-02-10 17:09:37 +00001923namespace {
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +00001924
Douglas Gregor09b69892011-02-10 17:09:37 +00001925 // Trait used for the on-disk hash table of header search information.
1926 class HeaderFileInfoTrait {
1927 ASTWriter &Writer;
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00001928
Douglas Gregor4b123cb2011-07-28 04:50:02 +00001929 // Keep track of the framework names we've used during serialization.
1930 SmallVector<char, 128> FrameworkStringData;
1931 llvm::StringMap<unsigned> FrameworkNameOffset;
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00001932
Douglas Gregor09b69892011-02-10 17:09:37 +00001933 public:
Richard Smith040e1262017-06-02 01:55:39 +00001934 HeaderFileInfoTrait(ASTWriter &Writer) : Writer(Writer) {}
1935
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +00001936 struct key_type {
Mehdi Amini004b9c72016-10-10 22:52:47 +00001937 StringRef Filename;
Richard Smith040e1262017-06-02 01:55:39 +00001938 off_t Size;
1939 time_t ModTime;
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +00001940 };
Eugene Zelenkob7d89102017-11-11 00:08:50 +00001941 using key_type_ref = const key_type &;
Richard Smith040e1262017-06-02 01:55:39 +00001942
1943 using UnresolvedModule =
1944 llvm::PointerIntPair<Module *, 2, ModuleMap::ModuleHeaderRole>;
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00001945
Richard Smith040e1262017-06-02 01:55:39 +00001946 struct data_type {
1947 const HeaderFileInfo &HFI;
1948 ArrayRef<ModuleMap::KnownHeader> KnownHeaders;
1949 UnresolvedModule Unresolved;
1950 };
Eugene Zelenkob7d89102017-11-11 00:08:50 +00001951 using data_type_ref = const data_type &;
Richard Smith040e1262017-06-02 01:55:39 +00001952
Eugene Zelenkob7d89102017-11-11 00:08:50 +00001953 using hash_value_type = unsigned;
1954 using offset_type = unsigned;
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00001955
Richard Smithe75ee0f2015-08-17 07:13:32 +00001956 hash_value_type ComputeHash(key_type_ref key) {
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +00001957 // The hash is based only on size/time of the file, so that the reader can
1958 // match even when symlinking or excess path elements ("foo/../", "../")
1959 // change the form of the name. However, complete path is still the key.
Richard Smith040e1262017-06-02 01:55:39 +00001960 return llvm::hash_combine(key.Size, key.ModTime);
Douglas Gregor09b69892011-02-10 17:09:37 +00001961 }
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00001962
Eugene Zelenkob7d89102017-11-11 00:08:50 +00001963 std::pair<unsigned, unsigned>
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +00001964 EmitKeyDataLength(raw_ostream& Out, key_type_ref key, data_type_ref Data) {
Justin Bognere1c147c2014-03-28 22:03:19 +00001965 using namespace llvm::support;
Eugene Zelenkob7d89102017-11-11 00:08:50 +00001966
Peter Collingbournee3f65292018-05-18 19:46:24 +00001967 endian::Writer LE(Out, little);
Mehdi Amini004b9c72016-10-10 22:52:47 +00001968 unsigned KeyLen = key.Filename.size() + 1 + 8 + 8;
Richard Smith386bb072015-08-18 23:42:23 +00001969 LE.write<uint16_t>(KeyLen);
Douglas Gregor4b123cb2011-07-28 04:50:02 +00001970 unsigned DataLen = 1 + 2 + 4 + 4;
Richard Smith040e1262017-06-02 01:55:39 +00001971 for (auto ModInfo : Data.KnownHeaders)
Richard Smith386bb072015-08-18 23:42:23 +00001972 if (Writer.getLocalOrImportedSubmoduleID(ModInfo.getModule()))
1973 DataLen += 4;
Richard Smith040e1262017-06-02 01:55:39 +00001974 if (Data.Unresolved.getPointer())
1975 DataLen += 4;
Richard Smith386bb072015-08-18 23:42:23 +00001976 LE.write<uint8_t>(DataLen);
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +00001977 return std::make_pair(KeyLen, DataLen);
Douglas Gregor09b69892011-02-10 17:09:37 +00001978 }
Richard Smith040e1262017-06-02 01:55:39 +00001979
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +00001980 void EmitKey(raw_ostream& Out, key_type_ref key, unsigned KeyLen) {
Justin Bognere1c147c2014-03-28 22:03:19 +00001981 using namespace llvm::support;
Eugene Zelenkob7d89102017-11-11 00:08:50 +00001982
Peter Collingbournee3f65292018-05-18 19:46:24 +00001983 endian::Writer LE(Out, little);
Richard Smith040e1262017-06-02 01:55:39 +00001984 LE.write<uint64_t>(key.Size);
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +00001985 KeyLen -= 8;
Richard Smith040e1262017-06-02 01:55:39 +00001986 LE.write<uint64_t>(key.ModTime);
Argyrios Kyrtzidis5c2a3452013-03-06 18:12:47 +00001987 KeyLen -= 8;
Mehdi Amini004b9c72016-10-10 22:52:47 +00001988 Out.write(key.Filename.data(), KeyLen);
Douglas Gregor09b69892011-02-10 17:09:37 +00001989 }
Richard Smith040e1262017-06-02 01:55:39 +00001990
Argyrios Kyrtzidisb146baa2013-03-13 21:13:51 +00001991 void EmitData(raw_ostream &Out, key_type_ref key,
Douglas Gregor09b69892011-02-10 17:09:37 +00001992 data_type_ref Data, unsigned DataLen) {
Justin Bognere1c147c2014-03-28 22:03:19 +00001993 using namespace llvm::support;
Eugene Zelenkob7d89102017-11-11 00:08:50 +00001994
Peter Collingbournee3f65292018-05-18 19:46:24 +00001995 endian::Writer LE(Out, little);
Douglas Gregor09b69892011-02-10 17:09:37 +00001996 uint64_t Start = Out.tell(); (void)Start;
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00001997
Richard Smithf3f84612017-06-29 02:19:42 +00001998 unsigned char Flags = (Data.HFI.isImport << 5)
1999 | (Data.HFI.isPragmaOnce << 4)
Richard Smith040e1262017-06-02 01:55:39 +00002000 | (Data.HFI.DirInfo << 1)
2001 | Data.HFI.IndexHeaderMapHeader;
Justin Bognere1c147c2014-03-28 22:03:19 +00002002 LE.write<uint8_t>(Flags);
Richard Smith040e1262017-06-02 01:55:39 +00002003 LE.write<uint16_t>(Data.HFI.NumIncludes);
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00002004
Richard Smith040e1262017-06-02 01:55:39 +00002005 if (!Data.HFI.ControllingMacro)
2006 LE.write<uint32_t>(Data.HFI.ControllingMacroID);
Douglas Gregor09b69892011-02-10 17:09:37 +00002007 else
Richard Smith040e1262017-06-02 01:55:39 +00002008 LE.write<uint32_t>(Writer.getIdentifierRef(Data.HFI.ControllingMacro));
2009
Douglas Gregor4b123cb2011-07-28 04:50:02 +00002010 unsigned Offset = 0;
Richard Smith040e1262017-06-02 01:55:39 +00002011 if (!Data.HFI.Framework.empty()) {
Douglas Gregor4b123cb2011-07-28 04:50:02 +00002012 // If this header refers into a framework, save the framework name.
2013 llvm::StringMap<unsigned>::iterator Pos
Richard Smith040e1262017-06-02 01:55:39 +00002014 = FrameworkNameOffset.find(Data.HFI.Framework);
Douglas Gregor4b123cb2011-07-28 04:50:02 +00002015 if (Pos == FrameworkNameOffset.end()) {
2016 Offset = FrameworkStringData.size() + 1;
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00002017 FrameworkStringData.append(Data.HFI.Framework.begin(),
Richard Smith040e1262017-06-02 01:55:39 +00002018 Data.HFI.Framework.end());
Douglas Gregor4b123cb2011-07-28 04:50:02 +00002019 FrameworkStringData.push_back(0);
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00002020
Richard Smith040e1262017-06-02 01:55:39 +00002021 FrameworkNameOffset[Data.HFI.Framework] = Offset;
Douglas Gregor4b123cb2011-07-28 04:50:02 +00002022 } else
2023 Offset = Pos->second;
2024 }
Justin Bognere1c147c2014-03-28 22:03:19 +00002025 LE.write<uint32_t>(Offset);
Argyrios Kyrtzidisb146baa2013-03-13 21:13:51 +00002026
Richard Smith040e1262017-06-02 01:55:39 +00002027 auto EmitModule = [&](Module *M, ModuleMap::ModuleHeaderRole Role) {
2028 if (uint32_t ModID = Writer.getLocalOrImportedSubmoduleID(M)) {
2029 uint32_t Value = (ModID << 2) | (unsigned)Role;
Richard Smith386bb072015-08-18 23:42:23 +00002030 assert((Value >> 2) == ModID && "overflow in header module info");
2031 LE.write<uint32_t>(Value);
2032 }
Richard Smith040e1262017-06-02 01:55:39 +00002033 };
2034
2035 // FIXME: If the header is excluded, we should write out some
2036 // record of that fact.
2037 for (auto ModInfo : Data.KnownHeaders)
2038 EmitModule(ModInfo.getModule(), ModInfo.getRole());
2039 if (Data.Unresolved.getPointer())
2040 EmitModule(Data.Unresolved.getPointer(), Data.Unresolved.getInt());
Argyrios Kyrtzidisb146baa2013-03-13 21:13:51 +00002041
Douglas Gregor09b69892011-02-10 17:09:37 +00002042 assert(Out.tell() - Start == DataLen && "Wrong data length");
2043 }
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00002044
Douglas Gregor4b123cb2011-07-28 04:50:02 +00002045 const char *strings_begin() const { return FrameworkStringData.begin(); }
2046 const char *strings_end() const { return FrameworkStringData.end(); }
Douglas Gregor09b69892011-02-10 17:09:37 +00002047 };
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +00002048
Eugene Zelenkob7d89102017-11-11 00:08:50 +00002049} // namespace
Douglas Gregor09b69892011-02-10 17:09:37 +00002050
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00002051/// Write the header search block for the list of files that
Douglas Gregor09b69892011-02-10 17:09:37 +00002052///
2053/// \param HS The header search structure to save.
Richard Smith7ed1bc92014-12-05 22:42:13 +00002054void ASTWriter::WriteHeaderSearch(const HeaderSearch &HS) {
Richard Smith040e1262017-06-02 01:55:39 +00002055 HeaderFileInfoTrait GeneratorTrait(*this);
2056 llvm::OnDiskChainedHashTableGenerator<HeaderFileInfoTrait> Generator;
2057 SmallVector<const char *, 4> SavedStrings;
2058 unsigned NumHeaderSearchEntries = 0;
2059
2060 // Find all unresolved headers for the current module. We generally will
2061 // have resolved them before we get here, but not necessarily: we might be
2062 // compiling a preprocessed module, where there is no requirement for the
2063 // original files to exist any more.
Benjamin Krameree021d52017-06-02 17:30:24 +00002064 const HeaderFileInfo Empty; // So we can take a reference.
Richard Smith040e1262017-06-02 01:55:39 +00002065 if (WritingModule) {
2066 llvm::SmallVector<Module *, 16> Worklist(1, WritingModule);
2067 while (!Worklist.empty()) {
2068 Module *M = Worklist.pop_back_val();
2069 if (!M->isAvailable())
2070 continue;
2071
2072 // Map to disk files where possible, to pick up any missing stat
2073 // information. This also means we don't need to check the unresolved
2074 // headers list when emitting resolved headers in the first loop below.
2075 // FIXME: It'd be preferable to avoid doing this if we were given
2076 // sufficient stat information in the module map.
2077 HS.getModuleMap().resolveHeaderDirectives(M);
2078
2079 // If the file didn't exist, we can still create a module if we were given
2080 // enough information in the module map.
2081 for (auto U : M->MissingHeaders) {
2082 // Check that we were given enough information to build a module
2083 // without this file existing on disk.
2084 if (!U.Size || (!U.ModTime && IncludeTimestamps)) {
2085 PP->Diag(U.FileNameLoc, diag::err_module_no_size_mtime_for_header)
2086 << WritingModule->getFullModuleName() << U.Size.hasValue()
2087 << U.FileName;
2088 continue;
2089 }
2090
2091 // Form the effective relative pathname for the file.
2092 SmallString<128> Filename(M->Directory->getName());
2093 llvm::sys::path::append(Filename, U.FileName);
2094 PreparePathForOutput(Filename);
2095
2096 StringRef FilenameDup = strdup(Filename.c_str());
2097 SavedStrings.push_back(FilenameDup.data());
2098
2099 HeaderFileInfoTrait::key_type Key = {
2100 FilenameDup, *U.Size, IncludeTimestamps ? *U.ModTime : 0
2101 };
2102 HeaderFileInfoTrait::data_type Data = {
Benjamin Krameree021d52017-06-02 17:30:24 +00002103 Empty, {}, {M, ModuleMap::headerKindToRole(U.Kind)}
Richard Smith040e1262017-06-02 01:55:39 +00002104 };
2105 // FIXME: Deal with cases where there are multiple unresolved header
2106 // directives in different submodules for the same header.
2107 Generator.insert(Key, Data, GeneratorTrait);
2108 ++NumHeaderSearchEntries;
2109 }
2110
2111 Worklist.append(M->submodule_begin(), M->submodule_end());
2112 }
2113 }
2114
Chris Lattner0e62c1c2011-07-23 10:55:15 +00002115 SmallVector<const FileEntry *, 16> FilesByUID;
Douglas Gregor09b69892011-02-10 17:09:37 +00002116 HS.getFileMgr().GetUniqueIDMapping(FilesByUID);
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00002117
Douglas Gregor09b69892011-02-10 17:09:37 +00002118 if (FilesByUID.size() > HS.header_file_size())
2119 FilesByUID.resize(HS.header_file_size());
Richard Smith040e1262017-06-02 01:55:39 +00002120
Douglas Gregor09b69892011-02-10 17:09:37 +00002121 for (unsigned UID = 0, LastUID = FilesByUID.size(); UID != LastUID; ++UID) {
2122 const FileEntry *File = FilesByUID[UID];
2123 if (!File)
2124 continue;
2125
Richard Smith386bb072015-08-18 23:42:23 +00002126 // Get the file info. This will load info from the external source if
2127 // necessary. Skip emitting this file if we have no information on it
2128 // as a header file (in which case HFI will be null) or if it hasn't
2129 // changed since it was loaded. Also skip it if it's for a modular header
2130 // from a different module; in that case, we rely on the module(s)
2131 // containing the header to provide this information.
Richard Smithd8879c82015-08-24 21:59:32 +00002132 const HeaderFileInfo *HFI =
2133 HS.getExistingFileInfo(File, /*WantExternal*/!Chain);
2134 if (!HFI || (HFI->isModuleHeader && !HFI->isCompilingModuleHeader))
Argyrios Kyrtzidis6f722b42013-05-08 23:46:46 +00002135 continue;
Douglas Gregor09b69892011-02-10 17:09:37 +00002136
Richard Smith7ed1bc92014-12-05 22:42:13 +00002137 // Massage the file path into an appropriate form.
Mehdi Amini004b9c72016-10-10 22:52:47 +00002138 StringRef Filename = File->getName();
Richard Smith7ed1bc92014-12-05 22:42:13 +00002139 SmallString<128> FilenameTmp(Filename);
2140 if (PreparePathForOutput(FilenameTmp)) {
2141 // If we performed any translation on the file name at all, we need to
2142 // save this string, since the generator will refer to it later.
Mehdi Amini004b9c72016-10-10 22:52:47 +00002143 Filename = StringRef(strdup(FilenameTmp.c_str()));
2144 SavedStrings.push_back(Filename.data());
Douglas Gregor09b69892011-02-10 17:09:37 +00002145 }
Richard Smith7ed1bc92014-12-05 22:42:13 +00002146
Richard Smith040e1262017-06-02 01:55:39 +00002147 HeaderFileInfoTrait::key_type Key = {
2148 Filename, File->getSize(), getTimestampForOutput(File)
2149 };
2150 HeaderFileInfoTrait::data_type Data = {
2151 *HFI, HS.getModuleMap().findAllModulesForHeader(File), {}
2152 };
2153 Generator.insert(Key, Data, GeneratorTrait);
Douglas Gregor09b69892011-02-10 17:09:37 +00002154 ++NumHeaderSearchEntries;
2155 }
Richard Smith040e1262017-06-02 01:55:39 +00002156
Douglas Gregor09b69892011-02-10 17:09:37 +00002157 // Create the on-disk hash table in a buffer.
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00002158 SmallString<4096> TableData;
Douglas Gregor09b69892011-02-10 17:09:37 +00002159 uint32_t BucketOffset;
2160 {
Justin Bognere1c147c2014-03-28 22:03:19 +00002161 using namespace llvm::support;
Eugene Zelenkob7d89102017-11-11 00:08:50 +00002162
Douglas Gregor09b69892011-02-10 17:09:37 +00002163 llvm::raw_svector_ostream Out(TableData);
2164 // Make sure that no bucket is at offset 0
Peter Collingbournee3f65292018-05-18 19:46:24 +00002165 endian::write<uint32_t>(Out, 0, little);
Douglas Gregor09b69892011-02-10 17:09:37 +00002166 BucketOffset = Generator.Emit(Out, GeneratorTrait);
2167 }
2168
2169 // Create a blob abbreviation
2170 using namespace llvm;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002171
David Blaikieb44f0bf2017-01-04 22:36:43 +00002172 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Douglas Gregor09b69892011-02-10 17:09:37 +00002173 Abbrev->Add(BitCodeAbbrevOp(HEADER_SEARCH_TABLE));
2174 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
2175 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
Douglas Gregor4b123cb2011-07-28 04:50:02 +00002176 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
Douglas Gregor09b69892011-02-10 17:09:37 +00002177 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
David Blaikieb44f0bf2017-01-04 22:36:43 +00002178 unsigned TableAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00002179
Douglas Gregor4b123cb2011-07-28 04:50:02 +00002180 // Write the header search table
Mehdi Amini57a41912015-09-10 01:46:39 +00002181 RecordData::value_type Record[] = {HEADER_SEARCH_TABLE, BucketOffset,
2182 NumHeaderSearchEntries, TableData.size()};
Douglas Gregor4b123cb2011-07-28 04:50:02 +00002183 TableData.append(GeneratorTrait.strings_begin(),GeneratorTrait.strings_end());
Yaron Keren92e1b622015-03-18 10:17:07 +00002184 Stream.EmitRecordWithBlob(TableAbbrev, Record, TableData);
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00002185
Douglas Gregor09b69892011-02-10 17:09:37 +00002186 // Free all of the strings we had to duplicate.
2187 for (unsigned I = 0, N = SavedStrings.size(); I != N; ++I)
David Greenebae0e352013-01-15 22:09:43 +00002188 free(const_cast<char *>(SavedStrings[I]));
Douglas Gregor09b69892011-02-10 17:09:37 +00002189}
2190
George Rimarc39f5492017-01-17 15:45:31 +00002191static void emitBlob(llvm::BitstreamWriter &Stream, StringRef Blob,
2192 unsigned SLocBufferBlobCompressedAbbrv,
2193 unsigned SLocBufferBlobAbbrv) {
Eugene Zelenkob7d89102017-11-11 00:08:50 +00002194 using RecordDataType = ASTWriter::RecordData::value_type;
George Rimarc39f5492017-01-17 15:45:31 +00002195
2196 // Compress the buffer if possible. We expect that almost all PCM
2197 // consumers will not want its contents.
2198 SmallString<0> CompressedBuffer;
2199 if (llvm::zlib::isAvailable()) {
2200 llvm::Error E = llvm::zlib::compress(Blob.drop_back(1), CompressedBuffer);
2201 if (!E) {
2202 RecordDataType Record[] = {SM_SLOC_BUFFER_BLOB_COMPRESSED,
2203 Blob.size() - 1};
2204 Stream.EmitRecordWithBlob(SLocBufferBlobCompressedAbbrv, Record,
2205 CompressedBuffer);
2206 return;
2207 }
2208 llvm::consumeError(std::move(E));
2209 }
2210
2211 RecordDataType Record[] = {SM_SLOC_BUFFER_BLOB};
2212 Stream.EmitRecordWithBlob(SLocBufferBlobAbbrv, Record, Blob);
2213}
2214
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00002215/// Writes the block containing the serialized form of the
Douglas Gregora7f71a92009-04-10 03:52:48 +00002216/// source manager.
2217///
2218/// TODO: We should probably use an on-disk hash table (stored in a
2219/// blob), indexed based on the file name, so that we only create
2220/// entries for files that we actually need. In the common case (no
2221/// errors), we probably won't have to create file entries for any of
2222/// the files in the AST.
Sebastian Redl55c0ad52010-08-18 23:56:21 +00002223void ASTWriter::WriteSourceManagerBlock(SourceManager &SourceMgr,
Richard Smith7ed1bc92014-12-05 22:42:13 +00002224 const Preprocessor &PP) {
Douglas Gregor258ae542009-04-27 06:38:32 +00002225 RecordData Record;
2226
Chris Lattner0910e3b2009-04-10 17:16:57 +00002227 // Enter the source manager block.
Richard Smithaada85c2016-02-06 02:06:43 +00002228 Stream.EnterSubblock(SOURCE_MANAGER_BLOCK_ID, 4);
Douglas Gregora7f71a92009-04-10 03:52:48 +00002229
2230 // Abbreviations for the various kinds of source-location entries.
Chris Lattnerc4976c732009-04-27 19:03:22 +00002231 unsigned SLocFileAbbrv = CreateSLocFileAbbrev(Stream);
2232 unsigned SLocBufferAbbrv = CreateSLocBufferAbbrev(Stream);
Richard Smithaada85c2016-02-06 02:06:43 +00002233 unsigned SLocBufferBlobAbbrv = CreateSLocBufferBlobAbbrev(Stream, false);
2234 unsigned SLocBufferBlobCompressedAbbrv =
2235 CreateSLocBufferBlobAbbrev(Stream, true);
Chandler Carruthf92ac9e2011-07-15 07:25:21 +00002236 unsigned SLocExpansionAbbrv = CreateSLocExpansionAbbrev(Stream);
Douglas Gregora7f71a92009-04-10 03:52:48 +00002237
Douglas Gregor258ae542009-04-27 06:38:32 +00002238 // Write out the source location entry table. We skip the first
2239 // entry, which is always the same dummy entry.
Chris Lattner12d61d32009-04-27 19:01:47 +00002240 std::vector<uint32_t> SLocEntryOffsets;
Douglas Gregor258ae542009-04-27 06:38:32 +00002241 RecordData PreloadSLocs;
Douglas Gregor925296b2011-07-19 16:10:42 +00002242 SLocEntryOffsets.reserve(SourceMgr.local_sloc_entry_size() - 1);
2243 for (unsigned I = 1, N = SourceMgr.local_sloc_entry_size();
Sebastian Redl5c415f32010-07-22 17:01:13 +00002244 I != N; ++I) {
Douglas Gregor8655e882009-10-16 22:46:09 +00002245 // Get this source location entry.
Douglas Gregor925296b2011-07-19 16:10:42 +00002246 const SrcMgr::SLocEntry *SLoc = &SourceMgr.getLocalSLocEntry(I);
Argyrios Kyrtzidis4db774a2012-10-02 21:09:17 +00002247 FileID FID = FileID::get(I);
2248 assert(&SourceMgr.getSLocEntry(FID) == SLoc);
Kovarththanan Rajaratnama9c81a82010-03-14 07:06:50 +00002249
Douglas Gregor258ae542009-04-27 06:38:32 +00002250 // Record the offset of this source-location entry.
2251 SLocEntryOffsets.push_back(Stream.GetCurrentBitNo());
2252
2253 // Figure out which record code to use.
2254 unsigned Code;
2255 if (SLoc->isFile()) {
Douglas Gregor9dc32122011-11-16 20:05:18 +00002256 const SrcMgr::ContentCache *Cache = SLoc->getFile().getContentCache();
2257 if (Cache->OrigEntry) {
Sebastian Redl539c5062010-08-18 23:57:32 +00002258 Code = SM_SLOC_FILE_ENTRY;
Argyrios Kyrtzidis92dd4662011-06-02 20:01:46 +00002259 } else
Sebastian Redl539c5062010-08-18 23:57:32 +00002260 Code = SM_SLOC_BUFFER_ENTRY;
Douglas Gregor258ae542009-04-27 06:38:32 +00002261 } else
Chandler Carruthf92ac9e2011-07-15 07:25:21 +00002262 Code = SM_SLOC_EXPANSION_ENTRY;
Douglas Gregor258ae542009-04-27 06:38:32 +00002263 Record.clear();
2264 Record.push_back(Code);
2265
Douglas Gregor925296b2011-07-19 16:10:42 +00002266 // Starting offset of this entry within this module, so skip the dummy.
2267 Record.push_back(SLoc->getOffset() - 2);
Douglas Gregor258ae542009-04-27 06:38:32 +00002268 if (SLoc->isFile()) {
2269 const SrcMgr::FileInfo &File = SLoc->getFile();
Richard Smithb22a1d12016-03-27 20:13:24 +00002270 AddSourceLocation(File.getIncludeLoc(), Record);
Douglas Gregor258ae542009-04-27 06:38:32 +00002271 Record.push_back(File.getFileCharacteristic()); // FIXME: stable encoding
2272 Record.push_back(File.hasLineDirectives());
2273
2274 const SrcMgr::ContentCache *Content = File.getContentCache();
Richard Smithaada85c2016-02-06 02:06:43 +00002275 bool EmitBlob = false;
Argyrios Kyrtzidis11e6f0a2011-03-05 01:03:53 +00002276 if (Content->OrigEntry) {
2277 assert(Content->OrigEntry == Content->ContentsEntry &&
Douglas Gregor9dc32122011-11-16 20:05:18 +00002278 "Writing to AST an overridden file is not supported");
Argyrios Kyrtzidis11e6f0a2011-03-05 01:03:53 +00002279
Douglas Gregor3120d2c2012-10-22 18:42:04 +00002280 // The source location entry is a file. Emit input file ID.
2281 assert(InputFileIDs[Content->OrigEntry] != 0 && "Missed file entry");
2282 Record.push_back(InputFileIDs[Content->OrigEntry]);
Mike Stump11289f42009-09-09 15:08:12 +00002283
Argyrios Kyrtzidis61ef3db2011-08-21 23:33:04 +00002284 Record.push_back(File.NumCreatedFIDs);
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00002285
Argyrios Kyrtzidis4db774a2012-10-02 21:09:17 +00002286 FileDeclIDsTy::iterator FDI = FileDeclIDs.find(FID);
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00002287 if (FDI != FileDeclIDs.end()) {
2288 Record.push_back(FDI->second->FirstDeclIndex);
2289 Record.push_back(FDI->second->DeclIDs.size());
2290 } else {
2291 Record.push_back(0);
2292 Record.push_back(0);
2293 }
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00002294
Mehdi Amini5ae4a852015-09-09 20:35:37 +00002295 Stream.EmitRecordWithAbbrev(SLocFileAbbrv, Record);
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00002296
Richard Smithaada85c2016-02-06 02:06:43 +00002297 if (Content->BufferOverridden || Content->IsTransient)
2298 EmitBlob = true;
Douglas Gregor258ae542009-04-27 06:38:32 +00002299 } else {
2300 // The source location entry is a buffer. The blob associated
2301 // with this entry contains the contents of the buffer.
2302
2303 // We add one to the size so that we capture the trailing NULL
2304 // that is required by llvm::MemoryBuffer::getMemBuffer (on
2305 // the reader side).
Douglas Gregor874cc622010-03-16 00:35:39 +00002306 const llvm::MemoryBuffer *Buffer
Chris Lattnerfb24a3a2010-04-20 20:35:58 +00002307 = Content->getBuffer(PP.getDiagnostics(), PP.getSourceManager());
Mehdi Amini99d1b292016-10-01 16:38:28 +00002308 StringRef Name = Buffer->getBufferIdentifier();
Mehdi Amini5ae4a852015-09-09 20:35:37 +00002309 Stream.EmitRecordWithBlob(SLocBufferAbbrv, Record,
Mehdi Amini99d1b292016-10-01 16:38:28 +00002310 StringRef(Name.data(), Name.size() + 1));
Richard Smithaada85c2016-02-06 02:06:43 +00002311 EmitBlob = true;
Douglas Gregor258ae542009-04-27 06:38:32 +00002312
Mehdi Amini99d1b292016-10-01 16:38:28 +00002313 if (Name == "<built-in>")
Douglas Gregor925296b2011-07-19 16:10:42 +00002314 PreloadSLocs.push_back(SLocEntryOffsets.size());
Douglas Gregor258ae542009-04-27 06:38:32 +00002315 }
Richard Smithaada85c2016-02-06 02:06:43 +00002316
2317 if (EmitBlob) {
2318 // Include the implicit terminating null character in the on-disk buffer
2319 // if we're writing it uncompressed.
2320 const llvm::MemoryBuffer *Buffer =
2321 Content->getBuffer(PP.getDiagnostics(), PP.getSourceManager());
2322 StringRef Blob(Buffer->getBufferStart(), Buffer->getBufferSize() + 1);
George Rimarc39f5492017-01-17 15:45:31 +00002323 emitBlob(Stream, Blob, SLocBufferBlobCompressedAbbrv,
2324 SLocBufferBlobAbbrv);
Richard Smithaada85c2016-02-06 02:06:43 +00002325 }
Douglas Gregor258ae542009-04-27 06:38:32 +00002326 } else {
Chandler Carruthf92ac9e2011-07-15 07:25:21 +00002327 // The source location entry is a macro expansion.
Chandler Carruthee4c1d12011-07-26 04:56:51 +00002328 const SrcMgr::ExpansionInfo &Expansion = SLoc->getExpansion();
Richard Smithb22a1d12016-03-27 20:13:24 +00002329 AddSourceLocation(Expansion.getSpellingLoc(), Record);
2330 AddSourceLocation(Expansion.getExpansionLocStart(), Record);
2331 AddSourceLocation(Expansion.isMacroArgExpansion()
2332 ? SourceLocation()
2333 : Expansion.getExpansionLocEnd(),
2334 Record);
Richard Smithb5f81712018-04-30 05:25:48 +00002335 Record.push_back(Expansion.isExpansionTokenRange());
Douglas Gregor258ae542009-04-27 06:38:32 +00002336
2337 // Compute the token length for this macro expansion.
Douglas Gregor925296b2011-07-19 16:10:42 +00002338 unsigned NextOffset = SourceMgr.getNextLocalOffset();
Douglas Gregor8655e882009-10-16 22:46:09 +00002339 if (I + 1 != N)
Douglas Gregor925296b2011-07-19 16:10:42 +00002340 NextOffset = SourceMgr.getLocalSLocEntry(I + 1).getOffset();
Douglas Gregor258ae542009-04-27 06:38:32 +00002341 Record.push_back(NextOffset - SLoc->getOffset() - 1);
Mehdi Amini5ae4a852015-09-09 20:35:37 +00002342 Stream.EmitRecordWithAbbrev(SLocExpansionAbbrv, Record);
Douglas Gregor258ae542009-04-27 06:38:32 +00002343 }
2344 }
2345
Douglas Gregor8f45df52009-04-16 22:23:12 +00002346 Stream.ExitBlock();
Douglas Gregor258ae542009-04-27 06:38:32 +00002347
2348 if (SLocEntryOffsets.empty())
2349 return;
2350
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00002351 // Write the source-location offsets table into the AST block. This
Douglas Gregor258ae542009-04-27 06:38:32 +00002352 // table is used for lazily loading source-location information.
2353 using namespace llvm;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002354
David Blaikieb44f0bf2017-01-04 22:36:43 +00002355 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Sebastian Redl539c5062010-08-18 23:57:32 +00002356 Abbrev->Add(BitCodeAbbrevOp(SOURCE_LOCATION_OFFSETS));
Douglas Gregor258ae542009-04-27 06:38:32 +00002357 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 16)); // # of slocs
Douglas Gregor925296b2011-07-19 16:10:42 +00002358 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 16)); // total size
Douglas Gregor258ae542009-04-27 06:38:32 +00002359 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // offsets
David Blaikieb44f0bf2017-01-04 22:36:43 +00002360 unsigned SLocOffsetsAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Mehdi Amini57a41912015-09-10 01:46:39 +00002361 {
2362 RecordData::value_type Record[] = {
2363 SOURCE_LOCATION_OFFSETS, SLocEntryOffsets.size(),
2364 SourceMgr.getNextLocalOffset() - 1 /* skip dummy */};
2365 Stream.EmitRecordWithBlob(SLocOffsetsAbbrev, Record,
2366 bytes(SLocEntryOffsets));
2367 }
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00002368 // Write the source location entry preloads array, telling the AST
Douglas Gregor258ae542009-04-27 06:38:32 +00002369 // reader which source locations entries it should load eagerly.
Sebastian Redl539c5062010-08-18 23:57:32 +00002370 Stream.EmitRecord(SOURCE_LOCATION_PRELOADS, PreloadSLocs);
Douglas Gregor925296b2011-07-19 16:10:42 +00002371
2372 // Write the line table. It depends on remapping working, so it must come
2373 // after the source location offsets.
2374 if (SourceMgr.hasLineTable()) {
2375 LineTableInfo &LineTable = SourceMgr.getLineTable();
2376
2377 Record.clear();
Richard Smith63078492015-09-01 07:41:55 +00002378
2379 // Emit the needed file names.
2380 llvm::DenseMap<int, int> FilenameMap;
Hans Wennborg14487362017-12-04 22:28:45 +00002381 FilenameMap[-1] = -1; // For unspecified filenames.
Richard Smith63078492015-09-01 07:41:55 +00002382 for (const auto &L : LineTable) {
2383 if (L.first.ID < 0)
2384 continue;
2385 for (auto &LE : L.second) {
2386 if (FilenameMap.insert(std::make_pair(LE.FilenameID,
Hans Wennborg14487362017-12-04 22:28:45 +00002387 FilenameMap.size() - 1)).second)
Richard Smith63078492015-09-01 07:41:55 +00002388 AddPath(LineTable.getFilename(LE.FilenameID), Record);
2389 }
2390 }
2391 Record.push_back(0);
Douglas Gregor925296b2011-07-19 16:10:42 +00002392
2393 // Emit the line entries
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002394 for (const auto &L : LineTable) {
Douglas Gregor925296b2011-07-19 16:10:42 +00002395 // Only emit entries for local files.
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002396 if (L.first.ID < 0)
Douglas Gregor925296b2011-07-19 16:10:42 +00002397 continue;
2398
2399 // Emit the file ID
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002400 Record.push_back(L.first.ID);
Douglas Gregor925296b2011-07-19 16:10:42 +00002401
2402 // Emit the line entries
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002403 Record.push_back(L.second.size());
2404 for (const auto &LE : L.second) {
2405 Record.push_back(LE.FileOffset);
2406 Record.push_back(LE.LineNo);
2407 Record.push_back(FilenameMap[LE.FilenameID]);
2408 Record.push_back((unsigned)LE.FileKind);
2409 Record.push_back(LE.IncludeOffset);
Douglas Gregor925296b2011-07-19 16:10:42 +00002410 }
2411 }
Richard Smith63078492015-09-01 07:41:55 +00002412
Douglas Gregor925296b2011-07-19 16:10:42 +00002413 Stream.EmitRecord(SOURCE_MANAGER_LINE_TABLE, Record);
2414 }
Douglas Gregora7f71a92009-04-10 03:52:48 +00002415}
2416
Douglas Gregorc5046832009-04-27 18:38:38 +00002417//===----------------------------------------------------------------------===//
2418// Preprocessor Serialization
2419//===----------------------------------------------------------------------===//
2420
Argyrios Kyrtzidis0aef0f02013-03-15 22:43:10 +00002421static bool shouldIgnoreMacro(MacroDirective *MD, bool IsModule,
2422 const Preprocessor &PP) {
Argyrios Kyrtzidisb6210df2013-03-26 17:17:01 +00002423 if (MacroInfo *MI = MD->getMacroInfo())
2424 if (MI->isBuiltinMacro())
2425 return true;
Argyrios Kyrtzidis0aef0f02013-03-15 22:43:10 +00002426
2427 if (IsModule) {
2428 SourceLocation Loc = MD->getLocation();
2429 if (Loc.isInvalid())
2430 return true;
2431 if (PP.getSourceManager().getFileID(Loc) == PP.getPredefinesFileID())
2432 return true;
2433 }
2434
2435 return false;
2436}
2437
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00002438/// Writes the block containing the serialized form of the
Chris Lattnereeffaef2009-04-10 17:15:23 +00002439/// preprocessor.
Douglas Gregor4a69c2e2011-09-01 17:04:32 +00002440void ASTWriter::WritePreprocessor(const Preprocessor &PP, bool IsModule) {
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002441 PreprocessingRecord *PPRec = PP.getPreprocessingRecord();
2442 if (PPRec)
2443 WritePreprocessorDetail(*PPRec);
2444
Chris Lattnerbaa52f42009-04-10 18:00:12 +00002445 RecordData Record;
Richard Smithd7329392015-04-21 21:46:32 +00002446 RecordData ModuleMacroRecord;
Chris Lattner0910e3b2009-04-10 17:16:57 +00002447
Chris Lattner0af3ba12009-04-13 01:29:17 +00002448 // If the preprocessor __COUNTER__ value has been bumped, remember it.
2449 if (PP.getCounterValue() != 0) {
Mehdi Amini57a41912015-09-10 01:46:39 +00002450 RecordData::value_type Record[] = {PP.getCounterValue()};
Sebastian Redl539c5062010-08-18 23:57:32 +00002451 Stream.EmitRecord(PP_COUNTER_VALUE, Record);
Douglas Gregoreda6a892009-04-26 00:07:37 +00002452 }
2453
Erik Verbruggenb34c79f2017-05-30 11:54:55 +00002454 if (PP.isRecordingPreamble() && PP.hasRecordedPreamble()) {
2455 assert(!IsModule);
Erik Verbruggen4d1eb2d2017-11-03 09:40:07 +00002456 auto SkipInfo = PP.getPreambleSkipInfo();
2457 if (SkipInfo.hasValue()) {
2458 Record.push_back(true);
2459 AddSourceLocation(SkipInfo->HashTokenLoc, Record);
2460 AddSourceLocation(SkipInfo->IfTokenLoc, Record);
2461 Record.push_back(SkipInfo->FoundNonSkipPortion);
2462 Record.push_back(SkipInfo->FoundElse);
2463 AddSourceLocation(SkipInfo->ElseLoc, Record);
2464 } else {
2465 Record.push_back(false);
2466 }
Erik Verbruggenb34c79f2017-05-30 11:54:55 +00002467 for (const auto &Cond : PP.getPreambleConditionalStack()) {
2468 AddSourceLocation(Cond.IfLoc, Record);
2469 Record.push_back(Cond.WasSkipping);
2470 Record.push_back(Cond.FoundNonSkip);
2471 Record.push_back(Cond.FoundElse);
2472 }
2473 Stream.EmitRecord(PP_CONDITIONAL_STACK, Record);
2474 Record.clear();
2475 }
2476
Douglas Gregoreda6a892009-04-26 00:07:37 +00002477 // Enter the preprocessor block.
Douglas Gregor796d76a2010-10-20 22:00:55 +00002478 Stream.EnterSubblock(PREPROCESSOR_BLOCK_ID, 3);
Mike Stump11289f42009-09-09 15:08:12 +00002479
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00002480 // If the AST file contains __DATE__ or __TIME__ emit a warning about this.
Richard Smithb5aaf5a2015-09-01 02:35:58 +00002481 // FIXME: Include a location for the use, and say which one was used.
Douglas Gregoreda6a892009-04-26 00:07:37 +00002482 if (PP.SawDateOrTime())
Richard Smithb5aaf5a2015-09-01 02:35:58 +00002483 PP.Diag(SourceLocation(), diag::warn_module_uses_date_time) << IsModule;
Douglas Gregor796d76a2010-10-20 22:00:55 +00002484
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002485 // Loop over all the macro directives that are live at the end of the file,
Chris Lattnerbaa52f42009-04-10 18:00:12 +00002486 // emitting each to the PP section.
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00002487
Richard Smithee977932015-05-01 21:22:17 +00002488 // Construct the list of identifiers with macro directives that need to be
2489 // serialized.
2490 SmallVector<const IdentifierInfo *, 128> MacroIdentifiers;
2491 for (auto &Id : PP.getIdentifierTable())
2492 if (Id.second->hadMacroDefinition() &&
2493 (!Id.second->isFromAST() ||
2494 Id.second->hasChangedSinceDeserialization()))
2495 MacroIdentifiers.push_back(Id.second);
Douglas Gregor2e5571d2011-02-10 18:20:09 +00002496 // Sort the set of macro definitions that need to be serialized by the
2497 // name of the macro, to provide a stable ordering.
Fangrui Song55fab262018-09-26 22:16:28 +00002498 llvm::sort(MacroIdentifiers, llvm::less_ptr<IdentifierInfo>());
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002499
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002500 // Emit the macro directives as a list and associate the offset with the
2501 // identifier they belong to.
Richard Smithee977932015-05-01 21:22:17 +00002502 for (const IdentifierInfo *Name : MacroIdentifiers) {
2503 MacroDirective *MD = PP.getLocalMacroDirectiveHistory(Name);
Richard Smithd7329392015-04-21 21:46:32 +00002504 auto StartOffset = Stream.GetCurrentBitNo();
2505
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002506 // Emit the macro directives in reverse source order.
2507 for (; MD; MD = MD->getPrevious()) {
Richard Smithd7329392015-04-21 21:46:32 +00002508 // Once we hit an ignored macro, we're done: the rest of the chain
2509 // will all be ignored macros.
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002510 if (shouldIgnoreMacro(MD, IsModule, PP))
Richard Smithd7329392015-04-21 21:46:32 +00002511 break;
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002512
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002513 AddSourceLocation(MD->getLocation(), Record);
Argyrios Kyrtzidisb6210df2013-03-26 17:17:01 +00002514 Record.push_back(MD->getKind());
Richard Smithdaa69e02014-07-25 04:40:03 +00002515 if (auto *DefMD = dyn_cast<DefMacroDirective>(MD)) {
Richard Smith3981b172015-04-30 02:16:23 +00002516 Record.push_back(getMacroRef(DefMD->getInfo(), Name));
Richard Smith713369b2015-04-23 20:40:50 +00002517 } else if (auto *VisMD = dyn_cast<VisibilityMacroDirective>(MD)) {
Argyrios Kyrtzidisb6210df2013-03-26 17:17:01 +00002518 Record.push_back(VisMD->isPublic());
2519 }
Richard Smithb8b2ed62015-04-23 18:18:26 +00002520 }
Richard Smithd7329392015-04-21 21:46:32 +00002521
Richard Smithb8b2ed62015-04-23 18:18:26 +00002522 // Write out any exported module macros.
Richard Smithee977932015-05-01 21:22:17 +00002523 bool EmittedModuleMacros = false;
Manman Ren33d80292016-05-31 18:19:32 +00002524 // We write out exported module macros for PCH as well.
2525 auto Leafs = PP.getLeafModuleMacros(Name);
2526 SmallVector<ModuleMacro*, 8> Worklist(Leafs.begin(), Leafs.end());
2527 llvm::DenseMap<ModuleMacro*, unsigned> Visits;
2528 while (!Worklist.empty()) {
2529 auto *Macro = Worklist.pop_back_val();
Richard Smithd7329392015-04-21 21:46:32 +00002530
Manman Ren33d80292016-05-31 18:19:32 +00002531 // Emit a record indicating this submodule exports this macro.
2532 ModuleMacroRecord.push_back(
2533 getSubmoduleID(Macro->getOwningModule()));
2534 ModuleMacroRecord.push_back(getMacroRef(Macro->getMacroInfo(), Name));
2535 for (auto *M : Macro->overrides())
2536 ModuleMacroRecord.push_back(getSubmoduleID(M->getOwningModule()));
Richard Smithd7329392015-04-21 21:46:32 +00002537
Manman Ren33d80292016-05-31 18:19:32 +00002538 Stream.EmitRecord(PP_MODULE_MACRO, ModuleMacroRecord);
2539 ModuleMacroRecord.clear();
Richard Smithd7329392015-04-21 21:46:32 +00002540
Manman Ren33d80292016-05-31 18:19:32 +00002541 // Enqueue overridden macros once we've visited all their ancestors.
2542 for (auto *M : Macro->overrides())
2543 if (++Visits[M] == M->getNumOverridingMacros())
2544 Worklist.push_back(M);
Richard Smithee977932015-05-01 21:22:17 +00002545
Manman Ren33d80292016-05-31 18:19:32 +00002546 EmittedModuleMacros = true;
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002547 }
Richard Smithd7329392015-04-21 21:46:32 +00002548
Richard Smithee977932015-05-01 21:22:17 +00002549 if (Record.empty() && !EmittedModuleMacros)
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002550 continue;
2551
Richard Smithd7329392015-04-21 21:46:32 +00002552 IdentMacroDirectivesOffsetMap[Name] = StartOffset;
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002553 Stream.EmitRecord(PP_MACRO_DIRECTIVE_HISTORY, Record);
2554 Record.clear();
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002555 }
Alexander Kornienko1d26c022012-09-25 17:18:14 +00002556
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00002557 /// Offsets of each of the macros into the bitstream, indexed by
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00002558 /// the local macro ID
2559 ///
2560 /// For each identifier that is associated with a macro, this map
2561 /// provides the offset into the bitstream where that macro is
2562 /// defined.
2563 std::vector<uint32_t> MacroOffsets;
2564
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002565 for (unsigned I = 0, N = MacroInfosToEmit.size(); I != N; ++I) {
2566 const IdentifierInfo *Name = MacroInfosToEmit[I].Name;
2567 MacroInfo *MI = MacroInfosToEmit[I].MI;
2568 MacroID ID = MacroInfosToEmit[I].ID;
Douglas Gregoreb114da2010-10-01 01:03:07 +00002569
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002570 if (ID < FirstMacroID) {
2571 assert(0 && "Loaded MacroInfo entered MacroInfosToEmit ?");
2572 continue;
Chris Lattner2199f5b2009-04-10 18:08:30 +00002573 }
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002574
2575 // Record the local offset of this macro.
2576 unsigned Index = ID - FirstMacroID;
2577 if (Index == MacroOffsets.size())
2578 MacroOffsets.push_back(Stream.GetCurrentBitNo());
2579 else {
2580 if (Index > MacroOffsets.size())
2581 MacroOffsets.resize(Index + 1);
2582
2583 MacroOffsets[Index] = Stream.GetCurrentBitNo();
2584 }
2585
2586 AddIdentifierRef(Name, Record);
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002587 AddSourceLocation(MI->getDefinitionLoc(), Record);
2588 AddSourceLocation(MI->getDefinitionEndLoc(), Record);
2589 Record.push_back(MI->isUsed());
Argyrios Kyrtzidis9ef53ce2014-04-09 18:21:23 +00002590 Record.push_back(MI->isUsedForHeaderGuard());
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002591 unsigned Code;
2592 if (MI->isObjectLike()) {
2593 Code = PP_MACRO_OBJECT_LIKE;
2594 } else {
2595 Code = PP_MACRO_FUNCTION_LIKE;
2596
2597 Record.push_back(MI->isC99Varargs());
2598 Record.push_back(MI->isGNUVarargs());
2599 Record.push_back(MI->hasCommaPasting());
Faisal Valiac506d72017-07-17 17:18:43 +00002600 Record.push_back(MI->getNumParams());
2601 for (const IdentifierInfo *Param : MI->params())
2602 AddIdentifierRef(Param, Record);
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002603 }
2604
2605 // If we have a detailed preprocessing record, record the macro definition
2606 // ID that corresponds to this macro.
2607 if (PPRec)
2608 Record.push_back(MacroDefinitions[PPRec->findMacroDefinition(MI)]);
2609
2610 Stream.EmitRecord(Code, Record);
2611 Record.clear();
2612
2613 // Emit the tokens array.
2614 for (unsigned TokNo = 0, e = MI->getNumTokens(); TokNo != e; ++TokNo) {
2615 // Note that we know that the preprocessor does not have any annotation
2616 // tokens in it because they are created by the parser, and thus can't
2617 // be in a macro definition.
2618 const Token &Tok = MI->getReplacementToken(TokNo);
John McCallf413f5e2013-05-03 00:10:13 +00002619 AddToken(Tok, Record);
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002620 Stream.EmitRecord(PP_TOKEN, Record);
2621 Record.clear();
2622 }
2623 ++NumMacros;
Chris Lattnerbaa52f42009-04-10 18:00:12 +00002624 }
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00002625
Douglas Gregor92a96f52011-02-08 21:58:10 +00002626 Stream.ExitBlock();
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00002627
2628 // Write the offsets table for macro IDs.
2629 using namespace llvm;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002630
David Blaikieb44f0bf2017-01-04 22:36:43 +00002631 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00002632 Abbrev->Add(BitCodeAbbrevOp(MACRO_OFFSET));
2633 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // # of macros
2634 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // first ID
2635 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
2636
David Blaikieb44f0bf2017-01-04 22:36:43 +00002637 unsigned MacroOffsetAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Mehdi Amini57a41912015-09-10 01:46:39 +00002638 {
2639 RecordData::value_type Record[] = {MACRO_OFFSET, MacroOffsets.size(),
2640 FirstMacroID - NUM_PREDEF_MACRO_IDS};
2641 Stream.EmitRecordWithBlob(MacroOffsetAbbrev, Record, bytes(MacroOffsets));
2642 }
Douglas Gregor92a96f52011-02-08 21:58:10 +00002643}
2644
2645void ASTWriter::WritePreprocessorDetail(PreprocessingRecord &PPRec) {
Argyrios Kyrtzidis7f448362011-09-19 20:40:42 +00002646 if (PPRec.local_begin() == PPRec.local_end())
Douglas Gregor92a96f52011-02-08 21:58:10 +00002647 return;
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002648
Argyrios Kyrtzidis64f63812011-09-19 20:40:25 +00002649 SmallVector<PPEntityOffset, 64> PreprocessedEntityOffsets;
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002650
Douglas Gregor92a96f52011-02-08 21:58:10 +00002651 // Enter the preprocessor block.
2652 Stream.EnterSubblock(PREPROCESSOR_DETAIL_BLOCK_ID, 3);
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00002653
Douglas Gregoraae92242010-03-19 21:51:54 +00002654 // If the preprocessor has a preprocessing record, emit it.
2655 unsigned NumPreprocessingRecords = 0;
Douglas Gregor92a96f52011-02-08 21:58:10 +00002656 using namespace llvm;
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00002657
2658 // Set up the abbreviation for
Douglas Gregor92a96f52011-02-08 21:58:10 +00002659 unsigned InclusionAbbrev = 0;
2660 {
David Blaikieb44f0bf2017-01-04 22:36:43 +00002661 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Douglas Gregor92a96f52011-02-08 21:58:10 +00002662 Abbrev->Add(BitCodeAbbrevOp(PPD_INCLUSION_DIRECTIVE));
Douglas Gregor92a96f52011-02-08 21:58:10 +00002663 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // filename length
2664 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // in quotes
2665 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 2)); // kind
Argyrios Kyrtzidisf590e092012-10-02 16:10:46 +00002666 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // imported module
Douglas Gregor92a96f52011-02-08 21:58:10 +00002667 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
David Blaikieb44f0bf2017-01-04 22:36:43 +00002668 InclusionAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregor92a96f52011-02-08 21:58:10 +00002669 }
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00002670
2671 unsigned FirstPreprocessorEntityID
2672 = (Chain ? PPRec.getNumLoadedPreprocessedEntities() : 0)
Douglas Gregor2f555fc2011-08-04 18:56:47 +00002673 + NUM_PREDEF_PP_ENTITY_IDS;
2674 unsigned NextPreprocessorEntityID = FirstPreprocessorEntityID;
Douglas Gregor92a96f52011-02-08 21:58:10 +00002675 RecordData Record;
Argyrios Kyrtzidis7f448362011-09-19 20:40:42 +00002676 for (PreprocessingRecord::iterator E = PPRec.local_begin(),
2677 EEnd = PPRec.local_end();
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00002678 E != EEnd;
Douglas Gregor0d4b4312011-08-04 17:06:18 +00002679 (void)++E, ++NumPreprocessingRecords, ++NextPreprocessorEntityID) {
Douglas Gregor92a96f52011-02-08 21:58:10 +00002680 Record.clear();
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00002681
Richard Smith66a81862015-05-04 02:25:31 +00002682 PreprocessedEntityOffsets.push_back(
2683 PPEntityOffset((*E)->getSourceRange(), Stream.GetCurrentBitNo()));
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002684
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002685 if (auto *MD = dyn_cast<MacroDefinitionRecord>(*E)) {
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002686 // Record this macro definition's ID.
2687 MacroDefinitions[MD] = NextPreprocessorEntityID;
Richard Smith66a81862015-05-04 02:25:31 +00002688
Douglas Gregor92a96f52011-02-08 21:58:10 +00002689 AddIdentifierRef(MD->getName(), Record);
Douglas Gregor92a96f52011-02-08 21:58:10 +00002690 Stream.EmitRecord(PPD_MACRO_DEFINITION, Record);
2691 continue;
Douglas Gregoraae92242010-03-19 21:51:54 +00002692 }
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00002693
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002694 if (auto *ME = dyn_cast<MacroExpansion>(*E)) {
Argyrios Kyrtzidis80f78b92011-09-08 17:18:41 +00002695 Record.push_back(ME->isBuiltinMacro());
2696 if (ME->isBuiltinMacro())
2697 AddIdentifierRef(ME->getName(), Record);
2698 else
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002699 Record.push_back(MacroDefinitions[ME->getDefinition()]);
Chandler Carruthf92ac9e2011-07-15 07:25:21 +00002700 Stream.EmitRecord(PPD_MACRO_EXPANSION, Record);
Douglas Gregor92a96f52011-02-08 21:58:10 +00002701 continue;
2702 }
2703
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002704 if (auto *ID = dyn_cast<InclusionDirective>(*E)) {
Douglas Gregor92a96f52011-02-08 21:58:10 +00002705 Record.push_back(PPD_INCLUSION_DIRECTIVE);
Douglas Gregor92a96f52011-02-08 21:58:10 +00002706 Record.push_back(ID->getFileName().size());
2707 Record.push_back(ID->wasInQuotes());
2708 Record.push_back(static_cast<unsigned>(ID->getKind()));
Argyrios Kyrtzidisf590e092012-10-02 16:10:46 +00002709 Record.push_back(ID->importedModule());
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00002710 SmallString<64> Buffer;
Douglas Gregor92a96f52011-02-08 21:58:10 +00002711 Buffer += ID->getFileName();
Argyrios Kyrtzidis8dbcfc32012-03-08 01:08:28 +00002712 // Check that the FileEntry is not null because it was not resolved and
2713 // we create a PCH even with compiler errors.
2714 if (ID->getFile())
2715 Buffer += ID->getFile()->getName();
Mehdi Amini5ae4a852015-09-09 20:35:37 +00002716 Stream.EmitRecordWithBlob(InclusionAbbrev, Record, Buffer);
Douglas Gregor92a96f52011-02-08 21:58:10 +00002717 continue;
2718 }
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00002719
Douglas Gregor92a96f52011-02-08 21:58:10 +00002720 llvm_unreachable("Unhandled PreprocessedEntity in ASTWriter");
2721 }
Douglas Gregor8f45df52009-04-16 22:23:12 +00002722 Stream.ExitBlock();
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00002723
Douglas Gregoraae92242010-03-19 21:51:54 +00002724 // Write the offsets table for the preprocessing record.
2725 if (NumPreprocessingRecords > 0) {
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002726 assert(PreprocessedEntityOffsets.size() == NumPreprocessingRecords);
2727
Douglas Gregoraae92242010-03-19 21:51:54 +00002728 // Write the offsets table for identifier IDs.
2729 using namespace llvm;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002730
David Blaikieb44f0bf2017-01-04 22:36:43 +00002731 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002732 Abbrev->Add(BitCodeAbbrevOp(PPD_ENTITIES_OFFSETS));
Douglas Gregor2f555fc2011-08-04 18:56:47 +00002733 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // first pp entity
Douglas Gregoraae92242010-03-19 21:51:54 +00002734 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
David Blaikieb44f0bf2017-01-04 22:36:43 +00002735 unsigned PPEOffsetAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00002736
Mehdi Amini57a41912015-09-10 01:46:39 +00002737 RecordData::value_type Record[] = {PPD_ENTITIES_OFFSETS,
2738 FirstPreprocessorEntityID -
2739 NUM_PREDEF_PP_ENTITY_IDS};
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00002740 Stream.EmitRecordWithBlob(PPEOffsetAbbrev, Record,
Reid Kleckner012665e2015-05-21 00:13:09 +00002741 bytes(PreprocessedEntityOffsets));
Douglas Gregoraae92242010-03-19 21:51:54 +00002742 }
Cameron Desrochersb60f1b62018-01-15 19:14:16 +00002743
2744 // Write the skipped region table for the preprocessing record.
2745 ArrayRef<SourceRange> SkippedRanges = PPRec.getSkippedRanges();
2746 if (SkippedRanges.size() > 0) {
2747 std::vector<PPSkippedRange> SerializedSkippedRanges;
2748 SerializedSkippedRanges.reserve(SkippedRanges.size());
2749 for (auto const& Range : SkippedRanges)
2750 SerializedSkippedRanges.emplace_back(Range);
2751
2752 using namespace llvm;
2753 auto Abbrev = std::make_shared<BitCodeAbbrev>();
2754 Abbrev->Add(BitCodeAbbrevOp(PPD_SKIPPED_RANGES));
2755 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
2756 unsigned PPESkippedRangeAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
2757
2758 Record.clear();
2759 Record.push_back(PPD_SKIPPED_RANGES);
2760 Stream.EmitRecordWithBlob(PPESkippedRangeAbbrev, Record,
2761 bytes(SerializedSkippedRanges));
2762 }
Chris Lattnereeffaef2009-04-10 17:15:23 +00002763}
2764
Richard Smith386bb072015-08-18 23:42:23 +00002765unsigned ASTWriter::getLocalOrImportedSubmoduleID(Module *Mod) {
Richard Smith080056b2015-08-18 21:53:42 +00002766 if (!Mod)
2767 return 0;
2768
Douglas Gregora89c5ac2011-12-06 01:10:29 +00002769 llvm::DenseMap<Module *, unsigned>::iterator Known = SubmoduleIDs.find(Mod);
2770 if (Known != SubmoduleIDs.end())
2771 return Known->second;
Richard Smith386bb072015-08-18 23:42:23 +00002772
Richard Smithdc1f0422016-07-20 19:10:16 +00002773 auto *Top = Mod->getTopLevelModule();
2774 if (Top != WritingModule &&
Bruno Cardoso Lopes17da34d2017-02-07 21:54:57 +00002775 (getLangOpts().CompilingPCH ||
2776 !Top->fullModuleNameIs(StringRef(getLangOpts().CurrentModule))))
Richard Smith386bb072015-08-18 23:42:23 +00002777 return 0;
2778
Douglas Gregora89c5ac2011-12-06 01:10:29 +00002779 return SubmoduleIDs[Mod] = NextSubmoduleID++;
2780}
2781
Richard Smith386bb072015-08-18 23:42:23 +00002782unsigned ASTWriter::getSubmoduleID(Module *Mod) {
2783 // FIXME: This can easily happen, if we have a reference to a submodule that
2784 // did not result in us loading a module file for that submodule. For
2785 // instance, a cross-top-level-module 'conflict' declaration will hit this.
2786 unsigned ID = getLocalOrImportedSubmoduleID(Mod);
2787 assert((ID || !Mod) &&
2788 "asked for module ID for non-local, non-imported module");
2789 return ID;
Argyrios Kyrtzidisb146baa2013-03-13 21:13:51 +00002790}
2791
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00002792/// Compute the number of modules within the given tree (including the
Douglas Gregor253eefe2011-12-01 00:59:36 +00002793/// given module).
2794static unsigned getNumberOfModules(Module *Mod) {
2795 unsigned ChildModules = 0;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002796 for (auto Sub = Mod->submodule_begin(), SubEnd = Mod->submodule_end();
Douglas Gregor253eefe2011-12-01 00:59:36 +00002797 Sub != SubEnd; ++Sub)
Douglas Gregoreb90e832012-01-04 23:32:19 +00002798 ChildModules += getNumberOfModules(*Sub);
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00002799
Douglas Gregor253eefe2011-12-01 00:59:36 +00002800 return ChildModules + 1;
2801}
2802
Douglas Gregorde3ef502011-11-30 23:21:26 +00002803void ASTWriter::WriteSubmodules(Module *WritingModule) {
Douglas Gregor69021972011-11-30 17:33:56 +00002804 // Enter the submodule description block.
Richard Smith202210b2014-10-24 20:23:01 +00002805 Stream.EnterSubblock(SUBMODULE_BLOCK_ID, /*bits for abbreviations*/5);
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00002806
Douglas Gregor69021972011-11-30 17:33:56 +00002807 // Write the abbreviations needed for the submodules block.
2808 using namespace llvm;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00002809
David Blaikieb44f0bf2017-01-04 22:36:43 +00002810 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Douglas Gregor69021972011-11-30 17:33:56 +00002811 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_DEFINITION));
Douglas Gregora89c5ac2011-12-06 01:10:29 +00002812 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // ID
Douglas Gregor69021972011-11-30 17:33:56 +00002813 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Parent
Richard Smithdd8b5332017-09-04 05:37:53 +00002814 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 2)); // Kind
Douglas Gregor69021972011-11-30 17:33:56 +00002815 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // IsFramework
2816 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // IsExplicit
Richard Smith9bca2982014-03-08 00:03:56 +00002817 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // IsSystem
2818 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // IsExternC
Douglas Gregora686e1b2012-01-27 19:52:33 +00002819 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // InferSubmodules...
Douglas Gregor73441092011-12-05 22:27:44 +00002820 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // InferExplicit...
Douglas Gregor73441092011-12-05 22:27:44 +00002821 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // InferExportWild...
Douglas Gregor35b13ec2013-03-20 00:22:05 +00002822 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // ConfigMacrosExh...
Jordan Rose90b0a1f2018-04-20 17:16:04 +00002823 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // ModuleMapIsPriv...
Douglas Gregor69021972011-11-30 17:33:56 +00002824 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
David Blaikieb44f0bf2017-01-04 22:36:43 +00002825 unsigned DefinitionAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregor69021972011-11-30 17:33:56 +00002826
David Blaikieb44f0bf2017-01-04 22:36:43 +00002827 Abbrev = std::make_shared<BitCodeAbbrev>();
Douglas Gregor524e33e2011-12-08 19:11:24 +00002828 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_UMBRELLA_HEADER));
Douglas Gregor69021972011-11-30 17:33:56 +00002829 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
David Blaikieb44f0bf2017-01-04 22:36:43 +00002830 unsigned UmbrellaAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregor69021972011-11-30 17:33:56 +00002831
David Blaikieb44f0bf2017-01-04 22:36:43 +00002832 Abbrev = std::make_shared<BitCodeAbbrev>();
Douglas Gregor69021972011-11-30 17:33:56 +00002833 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_HEADER));
2834 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
David Blaikieb44f0bf2017-01-04 22:36:43 +00002835 unsigned HeaderAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregor524e33e2011-12-08 19:11:24 +00002836
David Blaikieb44f0bf2017-01-04 22:36:43 +00002837 Abbrev = std::make_shared<BitCodeAbbrev>();
Argyrios Kyrtzidisc597c8c2012-10-05 00:22:33 +00002838 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_TOPHEADER));
2839 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
David Blaikieb44f0bf2017-01-04 22:36:43 +00002840 unsigned TopHeaderAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Argyrios Kyrtzidisc597c8c2012-10-05 00:22:33 +00002841
David Blaikieb44f0bf2017-01-04 22:36:43 +00002842 Abbrev = std::make_shared<BitCodeAbbrev>();
Douglas Gregor524e33e2011-12-08 19:11:24 +00002843 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_UMBRELLA_DIR));
2844 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
David Blaikieb44f0bf2017-01-04 22:36:43 +00002845 unsigned UmbrellaDirAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregor524e33e2011-12-08 19:11:24 +00002846
David Blaikieb44f0bf2017-01-04 22:36:43 +00002847 Abbrev = std::make_shared<BitCodeAbbrev>();
Douglas Gregor1fb5c3a2011-12-31 04:05:44 +00002848 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_REQUIRES));
Richard Smitha3feee22013-10-28 22:18:19 +00002849 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // State
2850 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Feature
David Blaikieb44f0bf2017-01-04 22:36:43 +00002851 unsigned RequiresAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregor1fb5c3a2011-12-31 04:05:44 +00002852
David Blaikieb44f0bf2017-01-04 22:36:43 +00002853 Abbrev = std::make_shared<BitCodeAbbrev>();
Douglas Gregor59527662012-10-15 06:28:11 +00002854 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_EXCLUDED_HEADER));
2855 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
David Blaikieb44f0bf2017-01-04 22:36:43 +00002856 unsigned ExcludedHeaderAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregor59527662012-10-15 06:28:11 +00002857
David Blaikieb44f0bf2017-01-04 22:36:43 +00002858 Abbrev = std::make_shared<BitCodeAbbrev>();
Richard Smith306d8922014-10-22 23:50:56 +00002859 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_TEXTUAL_HEADER));
2860 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
David Blaikieb44f0bf2017-01-04 22:36:43 +00002861 unsigned TextualHeaderAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Richard Smith306d8922014-10-22 23:50:56 +00002862
David Blaikieb44f0bf2017-01-04 22:36:43 +00002863 Abbrev = std::make_shared<BitCodeAbbrev>();
Lawrence Crowlb53e5482013-06-20 21:14:14 +00002864 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_PRIVATE_HEADER));
2865 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
David Blaikieb44f0bf2017-01-04 22:36:43 +00002866 unsigned PrivateHeaderAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Lawrence Crowlb53e5482013-06-20 21:14:14 +00002867
David Blaikieb44f0bf2017-01-04 22:36:43 +00002868 Abbrev = std::make_shared<BitCodeAbbrev>();
Richard Smith202210b2014-10-24 20:23:01 +00002869 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_PRIVATE_TEXTUAL_HEADER));
2870 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
David Blaikieb44f0bf2017-01-04 22:36:43 +00002871 unsigned PrivateTextualHeaderAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Richard Smith202210b2014-10-24 20:23:01 +00002872
David Blaikieb44f0bf2017-01-04 22:36:43 +00002873 Abbrev = std::make_shared<BitCodeAbbrev>();
Douglas Gregor6ddfca92013-01-14 17:21:00 +00002874 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_LINK_LIBRARY));
2875 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 1)); // IsFramework
2876 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Name
David Blaikieb44f0bf2017-01-04 22:36:43 +00002877 unsigned LinkLibraryAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregor6ddfca92013-01-14 17:21:00 +00002878
David Blaikieb44f0bf2017-01-04 22:36:43 +00002879 Abbrev = std::make_shared<BitCodeAbbrev>();
Douglas Gregor35b13ec2013-03-20 00:22:05 +00002880 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_CONFIG_MACRO));
2881 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Macro name
David Blaikieb44f0bf2017-01-04 22:36:43 +00002882 unsigned ConfigMacroAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregor35b13ec2013-03-20 00:22:05 +00002883
David Blaikieb44f0bf2017-01-04 22:36:43 +00002884 Abbrev = std::make_shared<BitCodeAbbrev>();
Douglas Gregorfb912652013-03-20 21:10:35 +00002885 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_CONFLICT));
2886 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // Other module
2887 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Message
David Blaikieb44f0bf2017-01-04 22:36:43 +00002888 unsigned ConflictAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregorfb912652013-03-20 21:10:35 +00002889
Douglas Gregorf0b11de2017-09-14 23:38:44 +00002890 Abbrev = std::make_shared<BitCodeAbbrev>();
2891 Abbrev->Add(BitCodeAbbrevOp(SUBMODULE_EXPORT_AS));
2892 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // Macro name
2893 unsigned ExportAsAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
2894
Douglas Gregor253eefe2011-12-01 00:59:36 +00002895 // Write the submodule metadata block.
Richard Smith145e15a2017-04-24 23:12:30 +00002896 RecordData::value_type Record[] = {
2897 getNumberOfModules(WritingModule),
Richard Smithdd8b5332017-09-04 05:37:53 +00002898 FirstSubmoduleID - NUM_PREDEF_SUBMODULE_IDS};
Douglas Gregor253eefe2011-12-01 00:59:36 +00002899 Stream.EmitRecord(SUBMODULE_METADATA, Record);
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00002900
Douglas Gregor69021972011-11-30 17:33:56 +00002901 // Write all of the submodules.
Douglas Gregorde3ef502011-11-30 23:21:26 +00002902 std::queue<Module *> Q;
Douglas Gregor69021972011-11-30 17:33:56 +00002903 Q.push(WritingModule);
Douglas Gregor69021972011-11-30 17:33:56 +00002904 while (!Q.empty()) {
Douglas Gregorde3ef502011-11-30 23:21:26 +00002905 Module *Mod = Q.front();
Douglas Gregor69021972011-11-30 17:33:56 +00002906 Q.pop();
Douglas Gregora89c5ac2011-12-06 01:10:29 +00002907 unsigned ID = getSubmoduleID(Mod);
Mehdi Amini57a41912015-09-10 01:46:39 +00002908
2909 uint64_t ParentID = 0;
Douglas Gregor69021972011-11-30 17:33:56 +00002910 if (Mod->Parent) {
2911 assert(SubmoduleIDs[Mod->Parent] && "Submodule parent not written?");
Mehdi Amini57a41912015-09-10 01:46:39 +00002912 ParentID = SubmoduleIDs[Mod->Parent];
Douglas Gregor69021972011-11-30 17:33:56 +00002913 }
Mehdi Amini57a41912015-09-10 01:46:39 +00002914
2915 // Emit the definition of the block.
2916 {
David Blaikie9ffe5a32017-01-30 05:00:26 +00002917 RecordData::value_type Record[] = {SUBMODULE_DEFINITION,
2918 ID,
2919 ParentID,
Simon Pilgrimf331a662017-09-04 10:54:39 +00002920 (RecordData::value_type)Mod->Kind,
David Blaikie9ffe5a32017-01-30 05:00:26 +00002921 Mod->IsFramework,
2922 Mod->IsExplicit,
2923 Mod->IsSystem,
2924 Mod->IsExternC,
2925 Mod->InferSubmodules,
2926 Mod->InferExplicitSubmodules,
2927 Mod->InferExportWildcard,
Jordan Rose90b0a1f2018-04-20 17:16:04 +00002928 Mod->ConfigMacrosExhaustive,
2929 Mod->ModuleMapIsPrivate};
Mehdi Amini57a41912015-09-10 01:46:39 +00002930 Stream.EmitRecordWithBlob(DefinitionAbbrev, Record, Mod->Name);
2931 }
2932
Douglas Gregor1fb5c3a2011-12-31 04:05:44 +00002933 // Emit the requirements.
Richard Smith080056b2015-08-18 21:53:42 +00002934 for (const auto &R : Mod->Requirements) {
Mehdi Amini57a41912015-09-10 01:46:39 +00002935 RecordData::value_type Record[] = {SUBMODULE_REQUIRES, R.second};
Richard Smith080056b2015-08-18 21:53:42 +00002936 Stream.EmitRecordWithBlob(RequiresAbbrev, Record, R.first);
Douglas Gregor1fb5c3a2011-12-31 04:05:44 +00002937 }
2938
Douglas Gregor69021972011-11-30 17:33:56 +00002939 // Emit the umbrella header, if there is one.
Richard Smith2b63d152015-05-16 02:28:53 +00002940 if (auto UmbrellaHeader = Mod->getUmbrellaHeader()) {
Mehdi Amini57a41912015-09-10 01:46:39 +00002941 RecordData::value_type Record[] = {SUBMODULE_UMBRELLA_HEADER};
Richard Smith2b63d152015-05-16 02:28:53 +00002942 Stream.EmitRecordWithBlob(UmbrellaAbbrev, Record,
2943 UmbrellaHeader.NameAsWritten);
2944 } else if (auto UmbrellaDir = Mod->getUmbrellaDir()) {
Mehdi Amini57a41912015-09-10 01:46:39 +00002945 RecordData::value_type Record[] = {SUBMODULE_UMBRELLA_DIR};
2946 Stream.EmitRecordWithBlob(UmbrellaDirAbbrev, Record,
Richard Smith2b63d152015-05-16 02:28:53 +00002947 UmbrellaDir.NameAsWritten);
Douglas Gregor69021972011-11-30 17:33:56 +00002948 }
Richard Smith306d8922014-10-22 23:50:56 +00002949
Douglas Gregor69021972011-11-30 17:33:56 +00002950 // Emit the headers.
Richard Smith202210b2014-10-24 20:23:01 +00002951 struct {
Richard Smith3c1a41a2014-12-02 00:08:08 +00002952 unsigned RecordKind;
Richard Smith202210b2014-10-24 20:23:01 +00002953 unsigned Abbrev;
Richard Smith3c1a41a2014-12-02 00:08:08 +00002954 Module::HeaderKind HeaderKind;
Richard Smith202210b2014-10-24 20:23:01 +00002955 } HeaderLists[] = {
Richard Smith3c1a41a2014-12-02 00:08:08 +00002956 {SUBMODULE_HEADER, HeaderAbbrev, Module::HK_Normal},
2957 {SUBMODULE_TEXTUAL_HEADER, TextualHeaderAbbrev, Module::HK_Textual},
2958 {SUBMODULE_PRIVATE_HEADER, PrivateHeaderAbbrev, Module::HK_Private},
Richard Smith202210b2014-10-24 20:23:01 +00002959 {SUBMODULE_PRIVATE_TEXTUAL_HEADER, PrivateTextualHeaderAbbrev,
Richard Smith3c1a41a2014-12-02 00:08:08 +00002960 Module::HK_PrivateTextual},
2961 {SUBMODULE_EXCLUDED_HEADER, ExcludedHeaderAbbrev, Module::HK_Excluded}
Richard Smith202210b2014-10-24 20:23:01 +00002962 };
2963 for (auto &HL : HeaderLists) {
Mehdi Amini57a41912015-09-10 01:46:39 +00002964 RecordData::value_type Record[] = {HL.RecordKind};
Richard Smith3c1a41a2014-12-02 00:08:08 +00002965 for (auto &H : Mod->Headers[HL.HeaderKind])
2966 Stream.EmitRecordWithBlob(HL.Abbrev, Record, H.NameAsWritten);
2967 }
2968
2969 // Emit the top headers.
2970 {
2971 auto TopHeaders = Mod->getTopHeaders(PP->getFileManager());
Mehdi Amini57a41912015-09-10 01:46:39 +00002972 RecordData::value_type Record[] = {SUBMODULE_TOPHEADER};
Richard Smith3c1a41a2014-12-02 00:08:08 +00002973 for (auto *H : TopHeaders)
2974 Stream.EmitRecordWithBlob(TopHeaderAbbrev, Record, H->getName());
Argyrios Kyrtzidisc597c8c2012-10-05 00:22:33 +00002975 }
Douglas Gregor0093b3c2011-12-05 16:33:54 +00002976
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00002977 // Emit the imports.
Douglas Gregor0093b3c2011-12-05 16:33:54 +00002978 if (!Mod->Imports.empty()) {
Mehdi Amini57a41912015-09-10 01:46:39 +00002979 RecordData Record;
Richard Smith080056b2015-08-18 21:53:42 +00002980 for (auto *I : Mod->Imports)
2981 Record.push_back(getSubmoduleID(I));
Douglas Gregor0093b3c2011-12-05 16:33:54 +00002982 Stream.EmitRecord(SUBMODULE_IMPORTS, Record);
2983 }
2984
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00002985 // Emit the exports.
Douglas Gregor24bb9232011-12-02 18:58:38 +00002986 if (!Mod->Exports.empty()) {
Mehdi Amini57a41912015-09-10 01:46:39 +00002987 RecordData Record;
Richard Smith080056b2015-08-18 21:53:42 +00002988 for (const auto &E : Mod->Exports) {
2989 // FIXME: This may fail; we don't require that all exported modules
2990 // are local or imported.
2991 Record.push_back(getSubmoduleID(E.getPointer()));
2992 Record.push_back(E.getInt());
Douglas Gregor24bb9232011-12-02 18:58:38 +00002993 }
2994 Stream.EmitRecord(SUBMODULE_EXPORTS, Record);
2995 }
Douglas Gregor6ddfca92013-01-14 17:21:00 +00002996
Daniel Jasperba7f2f72013-09-24 09:14:14 +00002997 //FIXME: How do we emit the 'use'd modules? They may not be submodules.
2998 // Might be unnecessary as use declarations are only used to build the
2999 // module itself.
3000
Douglas Gregor6ddfca92013-01-14 17:21:00 +00003001 // Emit the link libraries.
Richard Smith080056b2015-08-18 21:53:42 +00003002 for (const auto &LL : Mod->LinkLibraries) {
Mehdi Amini57a41912015-09-10 01:46:39 +00003003 RecordData::value_type Record[] = {SUBMODULE_LINK_LIBRARY,
3004 LL.IsFramework};
Richard Smith080056b2015-08-18 21:53:42 +00003005 Stream.EmitRecordWithBlob(LinkLibraryAbbrev, Record, LL.Library);
Douglas Gregor6ddfca92013-01-14 17:21:00 +00003006 }
3007
Douglas Gregorfb912652013-03-20 21:10:35 +00003008 // Emit the conflicts.
Richard Smith080056b2015-08-18 21:53:42 +00003009 for (const auto &C : Mod->Conflicts) {
Richard Smith080056b2015-08-18 21:53:42 +00003010 // FIXME: This may fail; we don't require that all conflicting modules
3011 // are local or imported.
Mehdi Amini57a41912015-09-10 01:46:39 +00003012 RecordData::value_type Record[] = {SUBMODULE_CONFLICT,
3013 getSubmoduleID(C.Other)};
Richard Smith080056b2015-08-18 21:53:42 +00003014 Stream.EmitRecordWithBlob(ConflictAbbrev, Record, C.Message);
Douglas Gregorfb912652013-03-20 21:10:35 +00003015 }
3016
Douglas Gregor35b13ec2013-03-20 00:22:05 +00003017 // Emit the configuration macros.
Richard Smith080056b2015-08-18 21:53:42 +00003018 for (const auto &CM : Mod->ConfigMacros) {
Mehdi Amini57a41912015-09-10 01:46:39 +00003019 RecordData::value_type Record[] = {SUBMODULE_CONFIG_MACRO};
Richard Smith080056b2015-08-18 21:53:42 +00003020 Stream.EmitRecordWithBlob(ConfigMacroAbbrev, Record, CM);
Douglas Gregor35b13ec2013-03-20 00:22:05 +00003021 }
3022
Richard Smithdc1f0422016-07-20 19:10:16 +00003023 // Emit the initializers, if any.
3024 RecordData Inits;
3025 for (Decl *D : Context->getModuleInitializers(Mod))
3026 Inits.push_back(GetDeclRef(D));
3027 if (!Inits.empty())
3028 Stream.EmitRecord(SUBMODULE_INITIALIZERS, Inits);
3029
Douglas Gregorf0b11de2017-09-14 23:38:44 +00003030 // Emit the name of the re-exported module, if any.
3031 if (!Mod->ExportAsModule.empty()) {
3032 RecordData::value_type Record[] = {SUBMODULE_EXPORT_AS};
3033 Stream.EmitRecordWithBlob(ExportAsAbbrev, Record, Mod->ExportAsModule);
3034 }
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00003035
Douglas Gregor69021972011-11-30 17:33:56 +00003036 // Queue up the submodules of this module.
Richard Smith080056b2015-08-18 21:53:42 +00003037 for (auto *M : Mod->submodules())
3038 Q.push(M);
Douglas Gregor69021972011-11-30 17:33:56 +00003039 }
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00003040
Douglas Gregor69021972011-11-30 17:33:56 +00003041 Stream.ExitBlock();
Richard Smith23d8d032015-05-14 00:45:20 +00003042
Richard Smith23d8d032015-05-14 00:45:20 +00003043 assert((NextSubmoduleID - FirstSubmoduleID ==
3044 getNumberOfModules(WritingModule)) &&
3045 "Wrong # of submodules; found a reference to a non-local, "
3046 "non-imported submodule?");
Douglas Gregor69021972011-11-30 17:33:56 +00003047}
3048
Argyrios Kyrtzidis0f06b982013-03-27 17:17:23 +00003049void ASTWriter::WritePragmaDiagnosticMappings(const DiagnosticsEngine &Diag,
3050 bool isModule) {
Argyrios Kyrtzidisefaa54a2012-10-30 00:27:21 +00003051 llvm::SmallDenseMap<const DiagnosticsEngine::DiagState *, unsigned, 64>
3052 DiagStateIDMap;
3053 unsigned CurrID = 0;
Argyrios Kyrtzidis452707c2010-11-05 22:10:18 +00003054 RecordData Record;
Argyrios Kyrtzidis243aedb2011-01-14 20:54:07 +00003055
Richard Smithe37391c2017-05-03 00:28:49 +00003056 auto EncodeDiagStateFlags =
3057 [](const DiagnosticsEngine::DiagState *DS) -> unsigned {
3058 unsigned Result = (unsigned)DS->ExtBehavior;
3059 for (unsigned Val :
Daniel Jasperba9aefc2017-05-03 07:48:27 +00003060 {(unsigned)DS->IgnoreAllWarnings, (unsigned)DS->EnableAllWarnings,
3061 (unsigned)DS->WarningsAsErrors, (unsigned)DS->ErrorsAsFatal,
3062 (unsigned)DS->SuppressSystemWarnings})
Richard Smithe37391c2017-05-03 00:28:49 +00003063 Result = (Result << 1) | Val;
3064 return Result;
3065 };
3066
3067 unsigned Flags = EncodeDiagStateFlags(Diag.DiagStatesByLoc.FirstDiagState);
3068 Record.push_back(Flags);
3069
Richard Smithd230de22017-01-26 01:01:01 +00003070 auto AddDiagState = [&](const DiagnosticsEngine::DiagState *State,
3071 bool IncludeNonPragmaStates) {
Richard Smithe37391c2017-05-03 00:28:49 +00003072 // Ensure that the diagnostic state wasn't modified since it was created.
3073 // We will not correctly round-trip this information otherwise.
3074 assert(Flags == EncodeDiagStateFlags(State) &&
3075 "diag state flags vary in single AST file");
3076
Richard Smithd230de22017-01-26 01:01:01 +00003077 unsigned &DiagStateID = DiagStateIDMap[State];
Argyrios Kyrtzidisefaa54a2012-10-30 00:27:21 +00003078 Record.push_back(DiagStateID);
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00003079
Argyrios Kyrtzidisefaa54a2012-10-30 00:27:21 +00003080 if (DiagStateID == 0) {
3081 DiagStateID = ++CurrID;
Duncan P. N. Exon Smith3cb183b2017-03-14 19:31:27 +00003082
3083 // Add a placeholder for the number of mappings.
3084 auto SizeIdx = Record.size();
3085 Record.emplace_back();
Richard Smithd230de22017-01-26 01:01:01 +00003086 for (const auto &I : *State) {
3087 if (I.second.isPragma() || IncludeNonPragmaStates) {
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00003088 Record.push_back(I.first);
Richard Smithe37391c2017-05-03 00:28:49 +00003089 Record.push_back(I.second.serialize());
Argyrios Kyrtzidisefaa54a2012-10-30 00:27:21 +00003090 }
Argyrios Kyrtzidis243aedb2011-01-14 20:54:07 +00003091 }
Duncan P. N. Exon Smith3cb183b2017-03-14 19:31:27 +00003092 // Update the placeholder.
3093 Record[SizeIdx] = (Record.size() - SizeIdx) / 2;
Richard Smithd230de22017-01-26 01:01:01 +00003094 }
3095 };
3096
3097 AddDiagState(Diag.DiagStatesByLoc.FirstDiagState, isModule);
Richard Smithd230de22017-01-26 01:01:01 +00003098
Duncan P. N. Exon Smitha351c102017-04-12 03:45:32 +00003099 // Reserve a spot for the number of locations with state transitions.
3100 auto NumLocationsIdx = Record.size();
3101 Record.emplace_back();
3102
3103 // Emit the state transitions.
3104 unsigned NumLocations = 0;
Richard Smithd230de22017-01-26 01:01:01 +00003105 for (auto &FileIDAndFile : Diag.DiagStatesByLoc.Files) {
3106 if (!FileIDAndFile.first.isValid() ||
3107 !FileIDAndFile.second.HasLocalTransitions)
3108 continue;
Duncan P. N. Exon Smitha351c102017-04-12 03:45:32 +00003109 ++NumLocations;
Richard Smith6c2b5a82018-02-09 01:15:13 +00003110
3111 SourceLocation Loc = Diag.SourceMgr->getComposedLoc(FileIDAndFile.first, 0);
3112 assert(!Loc.isInvalid() && "start loc for valid FileID is invalid");
3113 AddSourceLocation(Loc, Record);
3114
Richard Smithd230de22017-01-26 01:01:01 +00003115 Record.push_back(FileIDAndFile.second.StateTransitions.size());
3116 for (auto &StatePoint : FileIDAndFile.second.StateTransitions) {
3117 Record.push_back(StatePoint.Offset);
3118 AddDiagState(StatePoint.State, false);
Argyrios Kyrtzidis452707c2010-11-05 22:10:18 +00003119 }
3120 }
3121
Duncan P. N. Exon Smitha351c102017-04-12 03:45:32 +00003122 // Backpatch the number of locations.
3123 Record[NumLocationsIdx] = NumLocations;
3124
3125 // Emit CurDiagStateLoc. Do it last in order to match source order.
Duncan P. N. Exon Smith900f8172017-04-12 03:58:58 +00003126 //
3127 // This also protects against a hypothetical corner case with simulating
3128 // -Werror settings for implicit modules in the ASTReader, where reading
3129 // CurDiagState out of context could change whether warning pragmas are
3130 // treated as errors.
Duncan P. N. Exon Smitha351c102017-04-12 03:45:32 +00003131 AddSourceLocation(Diag.DiagStatesByLoc.CurDiagStateLoc, Record);
3132 AddDiagState(Diag.DiagStatesByLoc.CurDiagState, false);
3133
Duncan P. N. Exon Smithf2435b92017-04-12 02:31:17 +00003134 Stream.EmitRecord(DIAG_PRAGMA_MAPPINGS, Record);
Argyrios Kyrtzidis452707c2010-11-05 22:10:18 +00003135}
3136
Douglas Gregorc5046832009-04-27 18:38:38 +00003137//===----------------------------------------------------------------------===//
3138// Type Serialization
3139//===----------------------------------------------------------------------===//
Chris Lattnereeffaef2009-04-10 17:15:23 +00003140
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003141/// Write the representation of a type to the AST stream.
Sebastian Redl55c0ad52010-08-18 23:56:21 +00003142void ASTWriter::WriteType(QualType T) {
Richard Smith290d8012016-04-06 17:06:00 +00003143 TypeIdx &IdxRef = TypeIdxs[T];
3144 if (IdxRef.getIndex() == 0) // we haven't seen this type before.
3145 IdxRef = TypeIdx(NextTypeID++);
3146 TypeIdx Idx = IdxRef;
Mike Stump11289f42009-09-09 15:08:12 +00003147
Douglas Gregor9b3932c2010-10-05 18:37:06 +00003148 assert(Idx.getIndex() >= FirstTypeID && "Re-writing a type from a prior AST");
Douglas Gregordc72caa2010-10-04 18:21:45 +00003149
Douglas Gregoref84c4b2009-04-09 22:27:44 +00003150 RecordData Record;
Mike Stump11289f42009-09-09 15:08:12 +00003151
Douglas Gregoref84c4b2009-04-09 22:27:44 +00003152 // Emit the type's representation.
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00003153 ASTTypeWriter W(*this, Record);
Richard Smith290d8012016-04-06 17:06:00 +00003154 W.Visit(T);
3155 uint64_t Offset = W.Emit();
John McCall8ccfcb52009-09-24 19:53:00 +00003156
Richard Smith290d8012016-04-06 17:06:00 +00003157 // Record the offset for this type.
3158 unsigned Index = Idx.getIndex() - FirstTypeID;
3159 if (TypeOffsets.size() == Index)
3160 TypeOffsets.push_back(Offset);
3161 else if (TypeOffsets.size() < Index) {
3162 TypeOffsets.resize(Index + 1);
3163 TypeOffsets[Index] = Offset;
John McCall8ccfcb52009-09-24 19:53:00 +00003164 } else {
Richard Smith290d8012016-04-06 17:06:00 +00003165 llvm_unreachable("Types emitted in wrong order");
Douglas Gregoref84c4b2009-04-09 22:27:44 +00003166 }
Douglas Gregoref84c4b2009-04-09 22:27:44 +00003167}
3168
Douglas Gregorc5046832009-04-27 18:38:38 +00003169//===----------------------------------------------------------------------===//
3170// Declaration Serialization
3171//===----------------------------------------------------------------------===//
3172
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003173/// Write the block containing all of the declaration IDs
Douglas Gregoref84c4b2009-04-09 22:27:44 +00003174/// lexically declared within the given DeclContext.
3175///
3176/// \returns the offset of the DECL_CONTEXT_LEXICAL block within the
Alexander Kornienko2a8c18d2018-04-06 15:14:32 +00003177/// bitstream, or 0 if no block was written.
Sebastian Redl55c0ad52010-08-18 23:56:21 +00003178uint64_t ASTWriter::WriteDeclContextLexicalBlock(ASTContext &Context,
Douglas Gregoref84c4b2009-04-09 22:27:44 +00003179 DeclContext *DC) {
Argyrios Kyrtzidiscfbfe782009-06-30 02:36:12 +00003180 if (DC->decls_empty())
Douglas Gregoref84c4b2009-04-09 22:27:44 +00003181 return 0;
3182
Douglas Gregor8f45df52009-04-16 22:23:12 +00003183 uint64_t Offset = Stream.GetCurrentBitNo();
Richard Smith82f8fcd2015-08-06 22:07:25 +00003184 SmallVector<uint32_t, 128> KindDeclPairs;
3185 for (const auto *D : DC->decls()) {
3186 KindDeclPairs.push_back(D->getKind());
3187 KindDeclPairs.push_back(GetDeclRef(D));
3188 }
Douglas Gregoref84c4b2009-04-09 22:27:44 +00003189
Douglas Gregora57c3ab2009-04-22 22:34:57 +00003190 ++NumLexicalDeclContexts;
Mehdi Amini57a41912015-09-10 01:46:39 +00003191 RecordData::value_type Record[] = {DECL_CONTEXT_LEXICAL};
Richard Smith82f8fcd2015-08-06 22:07:25 +00003192 Stream.EmitRecordWithBlob(DeclContextLexicalAbbrev, Record,
3193 bytes(KindDeclPairs));
Douglas Gregoref84c4b2009-04-09 22:27:44 +00003194 return Offset;
3195}
3196
Sebastian Redl55c0ad52010-08-18 23:56:21 +00003197void ASTWriter::WriteTypeDeclOffsets() {
Sebastian Redl1ea025b2010-07-16 16:36:56 +00003198 using namespace llvm;
Sebastian Redl1ea025b2010-07-16 16:36:56 +00003199
3200 // Write the type offsets array
David Blaikieb44f0bf2017-01-04 22:36:43 +00003201 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Sebastian Redl539c5062010-08-18 23:57:32 +00003202 Abbrev->Add(BitCodeAbbrevOp(TYPE_OFFSET));
Sebastian Redl1ea025b2010-07-16 16:36:56 +00003203 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // # of types
Douglas Gregor5204bde2011-08-02 16:26:37 +00003204 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // base type index
Sebastian Redl1ea025b2010-07-16 16:36:56 +00003205 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // types block
David Blaikieb44f0bf2017-01-04 22:36:43 +00003206 unsigned TypeOffsetAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Mehdi Amini57a41912015-09-10 01:46:39 +00003207 {
3208 RecordData::value_type Record[] = {TYPE_OFFSET, TypeOffsets.size(),
3209 FirstTypeID - NUM_PREDEF_TYPE_IDS};
3210 Stream.EmitRecordWithBlob(TypeOffsetAbbrev, Record, bytes(TypeOffsets));
3211 }
Sebastian Redl1ea025b2010-07-16 16:36:56 +00003212
3213 // Write the declaration offsets array
David Blaikieb44f0bf2017-01-04 22:36:43 +00003214 Abbrev = std::make_shared<BitCodeAbbrev>();
Sebastian Redl539c5062010-08-18 23:57:32 +00003215 Abbrev->Add(BitCodeAbbrevOp(DECL_OFFSET));
Sebastian Redl1ea025b2010-07-16 16:36:56 +00003216 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // # of declarations
Douglas Gregorf7180622011-08-03 15:48:04 +00003217 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // base decl ID
Sebastian Redl1ea025b2010-07-16 16:36:56 +00003218 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob)); // declarations block
David Blaikieb44f0bf2017-01-04 22:36:43 +00003219 unsigned DeclOffsetAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Mehdi Amini57a41912015-09-10 01:46:39 +00003220 {
3221 RecordData::value_type Record[] = {DECL_OFFSET, DeclOffsets.size(),
3222 FirstDeclID - NUM_PREDEF_DECL_IDS};
3223 Stream.EmitRecordWithBlob(DeclOffsetAbbrev, Record, bytes(DeclOffsets));
3224 }
Sebastian Redl1ea025b2010-07-16 16:36:56 +00003225}
3226
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00003227void ASTWriter::WriteFileDeclIDsMap() {
3228 using namespace llvm;
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00003229
Chandler Carruthb306d732015-03-27 00:31:20 +00003230 SmallVector<std::pair<FileID, DeclIDInFileInfo *>, 64> SortedFileDeclIDs(
3231 FileDeclIDs.begin(), FileDeclIDs.end());
Fangrui Song55fab262018-09-26 22:16:28 +00003232 llvm::sort(SortedFileDeclIDs, llvm::less_first());
Chandler Carruthb306d732015-03-27 00:31:20 +00003233
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00003234 // Join the vectors of DeclIDs from all files.
Chandler Carruthb306d732015-03-27 00:31:20 +00003235 SmallVector<DeclID, 256> FileGroupedDeclIDs;
3236 for (auto &FileDeclEntry : SortedFileDeclIDs) {
3237 DeclIDInFileInfo &Info = *FileDeclEntry.second;
3238 Info.FirstDeclIndex = FileGroupedDeclIDs.size();
3239 for (auto &LocDeclEntry : Info.DeclIDs)
3240 FileGroupedDeclIDs.push_back(LocDeclEntry.second);
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00003241 }
3242
David Blaikieb44f0bf2017-01-04 22:36:43 +00003243 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00003244 Abbrev->Add(BitCodeAbbrevOp(FILE_SORTED_DECLS));
Argyrios Kyrtzidis10e78462012-10-02 21:09:13 +00003245 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00003246 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
David Blaikieb44f0bf2017-01-04 22:36:43 +00003247 unsigned AbbrevCode = Stream.EmitAbbrev(std::move(Abbrev));
Mehdi Amini57a41912015-09-10 01:46:39 +00003248 RecordData::value_type Record[] = {FILE_SORTED_DECLS,
3249 FileGroupedDeclIDs.size()};
Reid Kleckner012665e2015-05-21 00:13:09 +00003250 Stream.EmitRecordWithBlob(AbbrevCode, Record, bytes(FileGroupedDeclIDs));
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00003251}
3252
Dmitri Gribenkoaab83832012-06-20 00:34:58 +00003253void ASTWriter::WriteComments() {
3254 Stream.EnterSubblock(COMMENTS_BLOCK_ID, 3);
Ilya Biryukov45643102018-07-09 11:33:23 +00003255 auto _ = llvm::make_scope_exit([this] { Stream.ExitBlock(); });
3256 if (!PP->getPreprocessorOpts().WriteCommentListToPCH)
3257 return;
Dmitri Gribenko7dd29d42012-07-06 18:19:34 +00003258 ArrayRef<RawComment *> RawComments = Context->Comments.getComments();
Dmitri Gribenkoaab83832012-06-20 00:34:58 +00003259 RecordData Record;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00003260 for (const auto *I : RawComments) {
Dmitri Gribenkoaab83832012-06-20 00:34:58 +00003261 Record.clear();
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00003262 AddSourceRange(I->getSourceRange(), Record);
3263 Record.push_back(I->getKind());
3264 Record.push_back(I->isTrailingComment());
3265 Record.push_back(I->isAlmostTrailingComment());
Dmitri Gribenkoaab83832012-06-20 00:34:58 +00003266 Stream.EmitRecord(COMMENTS_RAW_COMMENT, Record);
3267 }
Dmitri Gribenkoaab83832012-06-20 00:34:58 +00003268}
3269
Douglas Gregorc5046832009-04-27 18:38:38 +00003270//===----------------------------------------------------------------------===//
3271// Global Method Pool and Selector Serialization
3272//===----------------------------------------------------------------------===//
3273
Douglas Gregore84a9da2009-04-20 20:36:09 +00003274namespace {
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +00003275
Douglas Gregorc78d3462009-04-24 21:10:55 +00003276// Trait used for the on-disk hash table used in the method pool.
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00003277class ASTMethodPoolTrait {
Sebastian Redl55c0ad52010-08-18 23:56:21 +00003278 ASTWriter &Writer;
Douglas Gregorc78d3462009-04-24 21:10:55 +00003279
3280public:
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003281 using key_type = Selector;
3282 using key_type_ref = key_type;
Mike Stump11289f42009-09-09 15:08:12 +00003283
Sebastian Redl834bb972010-08-04 17:20:04 +00003284 struct data_type {
Sebastian Redl539c5062010-08-18 23:57:32 +00003285 SelectorID ID;
Sebastian Redl834bb972010-08-04 17:20:04 +00003286 ObjCMethodList Instance, Factory;
3287 };
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003288 using data_type_ref = const data_type &;
Douglas Gregorc78d3462009-04-24 21:10:55 +00003289
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003290 using hash_value_type = unsigned;
3291 using offset_type = unsigned;
Justin Bogner25463f12014-04-18 20:27:24 +00003292
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003293 explicit ASTMethodPoolTrait(ASTWriter &Writer) : Writer(Writer) {}
Mike Stump11289f42009-09-09 15:08:12 +00003294
Justin Bogner25463f12014-04-18 20:27:24 +00003295 static hash_value_type ComputeHash(Selector Sel) {
Argyrios Kyrtzidis4bd97102010-08-20 16:03:52 +00003296 return serialization::ComputeHash(Sel);
Douglas Gregorc78d3462009-04-24 21:10:55 +00003297 }
Mike Stump11289f42009-09-09 15:08:12 +00003298
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003299 std::pair<unsigned, unsigned>
Chris Lattner0e62c1c2011-07-23 10:55:15 +00003300 EmitKeyDataLength(raw_ostream& Out, Selector Sel,
Douglas Gregorc78d3462009-04-24 21:10:55 +00003301 data_type_ref Methods) {
Justin Bognere1c147c2014-03-28 22:03:19 +00003302 using namespace llvm::support;
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003303
Peter Collingbournee3f65292018-05-18 19:46:24 +00003304 endian::Writer LE(Out, little);
Douglas Gregorc78d3462009-04-24 21:10:55 +00003305 unsigned KeyLen = 2 + (Sel.getNumArgs()? Sel.getNumArgs() * 4 : 4);
Justin Bognere1c147c2014-03-28 22:03:19 +00003306 LE.write<uint16_t>(KeyLen);
Sebastian Redl834bb972010-08-04 17:20:04 +00003307 unsigned DataLen = 4 + 2 + 2; // 2 bytes for each of the method counts
3308 for (const ObjCMethodList *Method = &Methods.Instance; Method;
Argyrios Kyrtzidisd3da6e02013-04-17 00:08:58 +00003309 Method = Method->getNext())
Nico Weber2e0c8f72014-12-27 03:58:08 +00003310 if (Method->getMethod())
Douglas Gregorc78d3462009-04-24 21:10:55 +00003311 DataLen += 4;
Sebastian Redl834bb972010-08-04 17:20:04 +00003312 for (const ObjCMethodList *Method = &Methods.Factory; Method;
Argyrios Kyrtzidisd3da6e02013-04-17 00:08:58 +00003313 Method = Method->getNext())
Nico Weber2e0c8f72014-12-27 03:58:08 +00003314 if (Method->getMethod())
Douglas Gregorc78d3462009-04-24 21:10:55 +00003315 DataLen += 4;
Justin Bognere1c147c2014-03-28 22:03:19 +00003316 LE.write<uint16_t>(DataLen);
Douglas Gregorc78d3462009-04-24 21:10:55 +00003317 return std::make_pair(KeyLen, DataLen);
3318 }
Mike Stump11289f42009-09-09 15:08:12 +00003319
Chris Lattner0e62c1c2011-07-23 10:55:15 +00003320 void EmitKey(raw_ostream& Out, Selector Sel, unsigned) {
Justin Bognere1c147c2014-03-28 22:03:19 +00003321 using namespace llvm::support;
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003322
Peter Collingbournee3f65292018-05-18 19:46:24 +00003323 endian::Writer LE(Out, little);
Mike Stump11289f42009-09-09 15:08:12 +00003324 uint64_t Start = Out.tell();
Douglas Gregor95c13f52009-04-25 17:48:32 +00003325 assert((Start >> 32) == 0 && "Selector key offset too large");
3326 Writer.SetSelectorOffset(Sel, Start);
Douglas Gregorc78d3462009-04-24 21:10:55 +00003327 unsigned N = Sel.getNumArgs();
Justin Bognere1c147c2014-03-28 22:03:19 +00003328 LE.write<uint16_t>(N);
Douglas Gregorc78d3462009-04-24 21:10:55 +00003329 if (N == 0)
3330 N = 1;
3331 for (unsigned I = 0; I != N; ++I)
Justin Bognere1c147c2014-03-28 22:03:19 +00003332 LE.write<uint32_t>(
3333 Writer.getIdentifierRef(Sel.getIdentifierInfoForSlot(I)));
Douglas Gregorc78d3462009-04-24 21:10:55 +00003334 }
Mike Stump11289f42009-09-09 15:08:12 +00003335
Chris Lattner0e62c1c2011-07-23 10:55:15 +00003336 void EmitData(raw_ostream& Out, key_type_ref,
Douglas Gregor4647cfa2009-04-24 21:49:02 +00003337 data_type_ref Methods, unsigned DataLen) {
Justin Bognere1c147c2014-03-28 22:03:19 +00003338 using namespace llvm::support;
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003339
Peter Collingbournee3f65292018-05-18 19:46:24 +00003340 endian::Writer LE(Out, little);
Douglas Gregor4647cfa2009-04-24 21:49:02 +00003341 uint64_t Start = Out.tell(); (void)Start;
Justin Bognere1c147c2014-03-28 22:03:19 +00003342 LE.write<uint32_t>(Methods.ID);
Douglas Gregorc78d3462009-04-24 21:10:55 +00003343 unsigned NumInstanceMethods = 0;
Sebastian Redl834bb972010-08-04 17:20:04 +00003344 for (const ObjCMethodList *Method = &Methods.Instance; Method;
Argyrios Kyrtzidisd3da6e02013-04-17 00:08:58 +00003345 Method = Method->getNext())
Nico Weber2e0c8f72014-12-27 03:58:08 +00003346 if (Method->getMethod())
Douglas Gregorc78d3462009-04-24 21:10:55 +00003347 ++NumInstanceMethods;
3348
3349 unsigned NumFactoryMethods = 0;
Sebastian Redl834bb972010-08-04 17:20:04 +00003350 for (const ObjCMethodList *Method = &Methods.Factory; Method;
Argyrios Kyrtzidisd3da6e02013-04-17 00:08:58 +00003351 Method = Method->getNext())
Nico Weber2e0c8f72014-12-27 03:58:08 +00003352 if (Method->getMethod())
Douglas Gregorc78d3462009-04-24 21:10:55 +00003353 ++NumFactoryMethods;
3354
Argyrios Kyrtzidisd3da6e02013-04-17 00:08:58 +00003355 unsigned InstanceBits = Methods.Instance.getBits();
3356 assert(InstanceBits < 4);
Nico Weberff4b35e2014-12-27 22:14:15 +00003357 unsigned InstanceHasMoreThanOneDeclBit =
3358 Methods.Instance.hasMoreThanOneDecl();
3359 unsigned FullInstanceBits = (NumInstanceMethods << 3) |
3360 (InstanceHasMoreThanOneDeclBit << 2) |
3361 InstanceBits;
Argyrios Kyrtzidisd3da6e02013-04-17 00:08:58 +00003362 unsigned FactoryBits = Methods.Factory.getBits();
3363 assert(FactoryBits < 4);
Nico Weberff4b35e2014-12-27 22:14:15 +00003364 unsigned FactoryHasMoreThanOneDeclBit =
3365 Methods.Factory.hasMoreThanOneDecl();
3366 unsigned FullFactoryBits = (NumFactoryMethods << 3) |
3367 (FactoryHasMoreThanOneDeclBit << 2) |
3368 FactoryBits;
3369 LE.write<uint16_t>(FullInstanceBits);
3370 LE.write<uint16_t>(FullFactoryBits);
Sebastian Redl834bb972010-08-04 17:20:04 +00003371 for (const ObjCMethodList *Method = &Methods.Instance; Method;
Argyrios Kyrtzidisd3da6e02013-04-17 00:08:58 +00003372 Method = Method->getNext())
Nico Weber2e0c8f72014-12-27 03:58:08 +00003373 if (Method->getMethod())
3374 LE.write<uint32_t>(Writer.getDeclID(Method->getMethod()));
Sebastian Redl834bb972010-08-04 17:20:04 +00003375 for (const ObjCMethodList *Method = &Methods.Factory; Method;
Argyrios Kyrtzidisd3da6e02013-04-17 00:08:58 +00003376 Method = Method->getNext())
Nico Weber2e0c8f72014-12-27 03:58:08 +00003377 if (Method->getMethod())
3378 LE.write<uint32_t>(Writer.getDeclID(Method->getMethod()));
Douglas Gregor4647cfa2009-04-24 21:49:02 +00003379
3380 assert(Out.tell() - Start == DataLen && "Data length is wrong");
Douglas Gregorc78d3462009-04-24 21:10:55 +00003381 }
3382};
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +00003383
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003384} // namespace
Douglas Gregorc78d3462009-04-24 21:10:55 +00003385
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003386/// Write ObjC data: selectors and the method pool.
Douglas Gregorc78d3462009-04-24 21:10:55 +00003387///
3388/// The method pool contains both instance and factory methods, stored
Sebastian Redla19a67f2010-08-03 21:58:15 +00003389/// in an on-disk hash table indexed by the selector. The hash table also
3390/// contains an empty entry for every other selector known to Sema.
Sebastian Redl55c0ad52010-08-18 23:56:21 +00003391void ASTWriter::WriteSelectors(Sema &SemaRef) {
Douglas Gregorc78d3462009-04-24 21:10:55 +00003392 using namespace llvm;
3393
Sebastian Redla19a67f2010-08-03 21:58:15 +00003394 // Do we have to do anything at all?
Sebastian Redl834bb972010-08-04 17:20:04 +00003395 if (SemaRef.MethodPool.empty() && SelectorIDs.empty())
Sebastian Redla19a67f2010-08-03 21:58:15 +00003396 return;
Sebastian Redld95a56e2010-08-04 18:21:41 +00003397 unsigned NumTableEntries = 0;
Sebastian Redla19a67f2010-08-03 21:58:15 +00003398 // Create and write out the blob that contains selectors and the method pool.
Douglas Gregorc78d3462009-04-24 21:10:55 +00003399 {
Justin Bognerbb094f02014-04-18 19:57:06 +00003400 llvm::OnDiskChainedHashTableGenerator<ASTMethodPoolTrait> Generator;
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003401 ASTMethodPoolTrait Trait(*this);
Mike Stump11289f42009-09-09 15:08:12 +00003402
Sebastian Redla19a67f2010-08-03 21:58:15 +00003403 // Create the on-disk hash table representation. We walk through every
3404 // selector we've seen and look it up in the method pool.
Sebastian Redld95a56e2010-08-04 18:21:41 +00003405 SelectorOffsets.resize(NextSelectorID - FirstSelectorID);
Chandler Carruthacbbeb92015-03-27 00:47:43 +00003406 for (auto &SelectorAndID : SelectorIDs) {
3407 Selector S = SelectorAndID.first;
3408 SelectorID ID = SelectorAndID.second;
Sebastian Redla19a67f2010-08-03 21:58:15 +00003409 Sema::GlobalMethodPool::iterator F = SemaRef.MethodPool.find(S);
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00003410 ASTMethodPoolTrait::data_type Data = {
Chandler Carruthacbbeb92015-03-27 00:47:43 +00003411 ID,
Sebastian Redl834bb972010-08-04 17:20:04 +00003412 ObjCMethodList(),
3413 ObjCMethodList()
3414 };
3415 if (F != SemaRef.MethodPool.end()) {
3416 Data.Instance = F->second.first;
3417 Data.Factory = F->second.second;
3418 }
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00003419 // Only write this selector if it's not in an existing AST or something
Sebastian Redld95a56e2010-08-04 18:21:41 +00003420 // changed.
Chandler Carruthacbbeb92015-03-27 00:47:43 +00003421 if (Chain && ID < FirstSelectorID) {
Sebastian Redld95a56e2010-08-04 18:21:41 +00003422 // Selector already exists. Did it change?
3423 bool changed = false;
Nico Weber2e0c8f72014-12-27 03:58:08 +00003424 for (ObjCMethodList *M = &Data.Instance;
3425 !changed && M && M->getMethod(); M = M->getNext()) {
3426 if (!M->getMethod()->isFromASTFile())
Sebastian Redld95a56e2010-08-04 18:21:41 +00003427 changed = true;
3428 }
Nico Weber2e0c8f72014-12-27 03:58:08 +00003429 for (ObjCMethodList *M = &Data.Factory; !changed && M && M->getMethod();
Argyrios Kyrtzidisd3da6e02013-04-17 00:08:58 +00003430 M = M->getNext()) {
Nico Weber2e0c8f72014-12-27 03:58:08 +00003431 if (!M->getMethod()->isFromASTFile())
Sebastian Redld95a56e2010-08-04 18:21:41 +00003432 changed = true;
3433 }
3434 if (!changed)
3435 continue;
Nico Weber2e0c8f72014-12-27 03:58:08 +00003436 } else if (Data.Instance.getMethod() || Data.Factory.getMethod()) {
Sebastian Redl6e1a2a02010-08-04 21:22:45 +00003437 // A new method pool entry.
3438 ++NumTableEntries;
Sebastian Redld95a56e2010-08-04 18:21:41 +00003439 }
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003440 Generator.insert(S, Data, Trait);
Douglas Gregorc78d3462009-04-24 21:10:55 +00003441 }
3442
Douglas Gregorc78d3462009-04-24 21:10:55 +00003443 // Create the on-disk hash table in a buffer.
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00003444 SmallString<4096> MethodPool;
Douglas Gregorc78d3462009-04-24 21:10:55 +00003445 uint32_t BucketOffset;
3446 {
Justin Bognere1c147c2014-03-28 22:03:19 +00003447 using namespace llvm::support;
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003448
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00003449 ASTMethodPoolTrait Trait(*this);
Douglas Gregorc78d3462009-04-24 21:10:55 +00003450 llvm::raw_svector_ostream Out(MethodPool);
3451 // Make sure that no bucket is at offset 0
Peter Collingbournee3f65292018-05-18 19:46:24 +00003452 endian::write<uint32_t>(Out, 0, little);
Douglas Gregorc78d3462009-04-24 21:10:55 +00003453 BucketOffset = Generator.Emit(Out, Trait);
3454 }
3455
3456 // Create a blob abbreviation
David Blaikieb44f0bf2017-01-04 22:36:43 +00003457 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Sebastian Redl539c5062010-08-18 23:57:32 +00003458 Abbrev->Add(BitCodeAbbrevOp(METHOD_POOL));
Douglas Gregorc78d3462009-04-24 21:10:55 +00003459 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
Douglas Gregor95c13f52009-04-25 17:48:32 +00003460 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
Douglas Gregorc78d3462009-04-24 21:10:55 +00003461 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
David Blaikieb44f0bf2017-01-04 22:36:43 +00003462 unsigned MethodPoolAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregorc78d3462009-04-24 21:10:55 +00003463
Douglas Gregor95c13f52009-04-25 17:48:32 +00003464 // Write the method pool
Mehdi Amini57a41912015-09-10 01:46:39 +00003465 {
3466 RecordData::value_type Record[] = {METHOD_POOL, BucketOffset,
3467 NumTableEntries};
3468 Stream.EmitRecordWithBlob(MethodPoolAbbrev, Record, MethodPool);
3469 }
Douglas Gregor95c13f52009-04-25 17:48:32 +00003470
3471 // Create a blob abbreviation for the selector table offsets.
David Blaikieb44f0bf2017-01-04 22:36:43 +00003472 Abbrev = std::make_shared<BitCodeAbbrev>();
Sebastian Redl539c5062010-08-18 23:57:32 +00003473 Abbrev->Add(BitCodeAbbrevOp(SELECTOR_OFFSETS));
Douglas Gregord4c5ed02010-10-29 22:39:52 +00003474 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // size
Douglas Gregor8f364fb2011-08-03 23:28:44 +00003475 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // first ID
Douglas Gregor95c13f52009-04-25 17:48:32 +00003476 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
David Blaikieb44f0bf2017-01-04 22:36:43 +00003477 unsigned SelectorOffsetAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregor95c13f52009-04-25 17:48:32 +00003478
3479 // Write the selector offsets table.
Mehdi Amini57a41912015-09-10 01:46:39 +00003480 {
3481 RecordData::value_type Record[] = {
3482 SELECTOR_OFFSETS, SelectorOffsets.size(),
3483 FirstSelectorID - NUM_PREDEF_SELECTOR_IDS};
3484 Stream.EmitRecordWithBlob(SelectorOffsetAbbrev, Record,
3485 bytes(SelectorOffsets));
3486 }
Douglas Gregorc78d3462009-04-24 21:10:55 +00003487 }
3488}
3489
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003490/// Write the selectors referenced in @selector expression into AST file.
Sebastian Redl55c0ad52010-08-18 23:56:21 +00003491void ASTWriter::WriteReferencedSelectorsPool(Sema &SemaRef) {
Fariborz Jahanianc51609a2010-07-23 19:11:11 +00003492 using namespace llvm;
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003493
Fariborz Jahanianc51609a2010-07-23 19:11:11 +00003494 if (SemaRef.ReferencedSelectors.empty())
3495 return;
Sebastian Redlada023c2010-08-04 20:40:17 +00003496
Fariborz Jahanianc51609a2010-07-23 19:11:11 +00003497 RecordData Record;
Richard Smithe64e7452016-04-18 21:54:58 +00003498 ASTRecordWriter Writer(*this, Record);
Sebastian Redlada023c2010-08-04 20:40:17 +00003499
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00003500 // Note: this writes out all references even for a dependent AST. But it is
Sebastian Redl51c79d82010-08-04 22:21:29 +00003501 // very tricky to fix, and given that @selector shouldn't really appear in
3502 // headers, probably not worth it. It's not a correctness issue.
Chandler Carruth12c8f652015-03-27 00:55:05 +00003503 for (auto &SelectorAndLocation : SemaRef.ReferencedSelectors) {
3504 Selector Sel = SelectorAndLocation.first;
3505 SourceLocation Loc = SelectorAndLocation.second;
Richard Smithe64e7452016-04-18 21:54:58 +00003506 Writer.AddSelectorRef(Sel);
3507 Writer.AddSourceLocation(Loc);
Fariborz Jahanianc51609a2010-07-23 19:11:11 +00003508 }
Richard Smithe64e7452016-04-18 21:54:58 +00003509 Writer.Emit(REFERENCED_SELECTOR_POOL);
Fariborz Jahanianc51609a2010-07-23 19:11:11 +00003510}
3511
Douglas Gregorc5046832009-04-27 18:38:38 +00003512//===----------------------------------------------------------------------===//
3513// Identifier Table Serialization
3514//===----------------------------------------------------------------------===//
3515
Richard Smithb3761912015-02-05 23:08:52 +00003516/// Determine the declaration that should be put into the name lookup table to
3517/// represent the given declaration in this module. This is usually D itself,
3518/// but if D was imported and merged into a local declaration, we want the most
3519/// recent local declaration instead. The chosen declaration will be the most
3520/// recent declaration in any module that imports this one.
3521static NamedDecl *getDeclForLocalLookup(const LangOptions &LangOpts,
3522 NamedDecl *D) {
3523 if (!LangOpts.Modules || !D->isFromASTFile())
3524 return D;
3525
3526 if (Decl *Redecl = D->getPreviousDecl()) {
3527 // For Redeclarable decls, a prior declaration might be local.
3528 for (; Redecl; Redecl = Redecl->getPreviousDecl()) {
Richard Smithd49941b2016-04-26 23:40:43 +00003529 // If we find a local decl, we're done.
3530 if (!Redecl->isFromASTFile()) {
3531 // Exception: in very rare cases (for injected-class-names), not all
3532 // redeclarations are in the same semantic context. Skip ones in a
3533 // different context. They don't go in this lookup table at all.
3534 if (!Redecl->getDeclContext()->getRedeclContext()->Equals(
3535 D->getDeclContext()->getRedeclContext()))
3536 continue;
Richard Smithb3761912015-02-05 23:08:52 +00003537 return cast<NamedDecl>(Redecl);
Richard Smithd49941b2016-04-26 23:40:43 +00003538 }
3539
Richard Smithfe620d22015-03-05 23:24:12 +00003540 // If we find a decl from a (chained-)PCH stop since we won't find a
Richard Smithb3761912015-02-05 23:08:52 +00003541 // local one.
Richard Smithd49941b2016-04-26 23:40:43 +00003542 if (Redecl->getOwningModuleID() == 0)
Richard Smithb3761912015-02-05 23:08:52 +00003543 break;
3544 }
3545 } else if (Decl *First = D->getCanonicalDecl()) {
3546 // For Mergeable decls, the first decl might be local.
3547 if (!First->isFromASTFile())
3548 return cast<NamedDecl>(First);
3549 }
3550
3551 // All declarations are imported. Our most recent declaration will also be
3552 // the most recent one in anyone who imports us.
3553 return D;
3554}
3555
Douglas Gregorc78d3462009-04-24 21:10:55 +00003556namespace {
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +00003557
Richard Smithcf97cf62015-04-19 01:34:23 +00003558class ASTIdentifierTableTrait {
3559 ASTWriter &Writer;
3560 Preprocessor &PP;
3561 IdentifierResolver &IdResolver;
Richard Smith9c254182015-07-19 21:41:12 +00003562 bool IsModule;
Richard Smitha534a312015-07-21 23:54:07 +00003563 bool NeedDecls;
Richard Smith33e0f7e2015-07-22 02:08:40 +00003564 ASTWriter::RecordData *InterestingIdentifierOffsets;
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00003565
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003566 /// Determines whether this is an "interesting" identifier that needs a
Richard Smithcf97cf62015-04-19 01:34:23 +00003567 /// full IdentifierInfo structure written into the hash table. Notably, this
3568 /// doesn't check whether the name has macros defined; use PublicMacroIterator
3569 /// to check that.
Richard Smith9c254182015-07-19 21:41:12 +00003570 bool isInterestingIdentifier(const IdentifierInfo *II, uint64_t MacroOffset) {
Richard Smithd7329392015-04-21 21:46:32 +00003571 if (MacroOffset ||
3572 II->isPoisoned() ||
Richard Smith9c254182015-07-19 21:41:12 +00003573 (IsModule ? II->hasRevertedBuiltin() : II->getObjCOrBuiltinID()) ||
Richard Smithcf97cf62015-04-19 01:34:23 +00003574 II->hasRevertedTokenIDToIdentifier() ||
Bruno Ricci366ba732018-09-21 12:53:22 +00003575 (NeedDecls && II->getFETokenInfo()))
Richard Smithcf97cf62015-04-19 01:34:23 +00003576 return true;
3577
3578 return false;
3579 }
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00003580
Douglas Gregore84a9da2009-04-20 20:36:09 +00003581public:
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003582 using key_type = IdentifierInfo *;
3583 using key_type_ref = key_type;
Mike Stump11289f42009-09-09 15:08:12 +00003584
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003585 using data_type = IdentID;
3586 using data_type_ref = data_type;
Mike Stump11289f42009-09-09 15:08:12 +00003587
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003588 using hash_value_type = unsigned;
3589 using offset_type = unsigned;
Justin Bogner25463f12014-04-18 20:27:24 +00003590
Richard Smithd7329392015-04-21 21:46:32 +00003591 ASTIdentifierTableTrait(ASTWriter &Writer, Preprocessor &PP,
Richard Smith33e0f7e2015-07-22 02:08:40 +00003592 IdentifierResolver &IdResolver, bool IsModule,
3593 ASTWriter::RecordData *InterestingIdentifierOffsets)
Richard Smitha534a312015-07-21 23:54:07 +00003594 : Writer(Writer), PP(PP), IdResolver(IdResolver), IsModule(IsModule),
Richard Smith33e0f7e2015-07-22 02:08:40 +00003595 NeedDecls(!IsModule || !Writer.getLangOpts().CPlusPlus),
3596 InterestingIdentifierOffsets(InterestingIdentifierOffsets) {}
Douglas Gregore84a9da2009-04-20 20:36:09 +00003597
Richard Smithd79514e2016-02-05 19:03:40 +00003598 bool needDecls() const { return NeedDecls; }
3599
Justin Bogner25463f12014-04-18 20:27:24 +00003600 static hash_value_type ComputeHash(const IdentifierInfo* II) {
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00003601 return llvm::djbHash(II->getName());
Douglas Gregore84a9da2009-04-20 20:36:09 +00003602 }
Mike Stump11289f42009-09-09 15:08:12 +00003603
Richard Smith33e0f7e2015-07-22 02:08:40 +00003604 bool isInterestingIdentifier(const IdentifierInfo *II) {
3605 auto MacroOffset = Writer.getMacroDirectivesOffset(II);
3606 return isInterestingIdentifier(II, MacroOffset);
3607 }
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +00003608
Richard Smith9c254182015-07-19 21:41:12 +00003609 bool isInterestingNonMacroIdentifier(const IdentifierInfo *II) {
3610 return isInterestingIdentifier(II, 0);
3611 }
3612
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003613 std::pair<unsigned, unsigned>
Douglas Gregor935bc7a22011-10-27 09:33:13 +00003614 EmitKeyDataLength(raw_ostream& Out, IdentifierInfo* II, IdentID ID) {
Daniel Dunbar2c422dc92009-10-18 20:26:12 +00003615 unsigned KeyLen = II->getLength() + 1;
Douglas Gregor1d583f22009-04-28 21:18:29 +00003616 unsigned DataLen = 4; // 4 bytes for the persistent ID << 1
Richard Smithd7329392015-04-21 21:46:32 +00003617 auto MacroOffset = Writer.getMacroDirectivesOffset(II);
3618 if (isInterestingIdentifier(II, MacroOffset)) {
Alexander Kornienko1d26c022012-09-25 17:18:14 +00003619 DataLen += 2; // 2 bytes for builtin ID
3620 DataLen += 2; // 2 bytes for flags
Richard Smithd7329392015-04-21 21:46:32 +00003621 if (MacroOffset)
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00003622 DataLen += 4; // MacroDirectives offset.
Alexander Kornienko1d26c022012-09-25 17:18:14 +00003623
Richard Smitha534a312015-07-21 23:54:07 +00003624 if (NeedDecls) {
3625 for (IdentifierResolver::iterator D = IdResolver.begin(II),
3626 DEnd = IdResolver.end();
3627 D != DEnd; ++D)
3628 DataLen += 4;
3629 }
Douglas Gregor1d583f22009-04-28 21:18:29 +00003630 }
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003631
Justin Bognere1c147c2014-03-28 22:03:19 +00003632 using namespace llvm::support;
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003633
Peter Collingbournee3f65292018-05-18 19:46:24 +00003634 endian::Writer LE(Out, little);
Justin Bognere1c147c2014-03-28 22:03:19 +00003635
Richard Smithdf8a8312015-03-13 04:05:01 +00003636 assert((uint16_t)DataLen == DataLen && (uint16_t)KeyLen == KeyLen);
Justin Bognere1c147c2014-03-28 22:03:19 +00003637 LE.write<uint16_t>(DataLen);
Douglas Gregorab4df582009-04-28 20:01:51 +00003638 // We emit the key length after the data length so that every
3639 // string is preceded by a 16-bit length. This matches the PTH
3640 // format for storing identifiers.
Justin Bognere1c147c2014-03-28 22:03:19 +00003641 LE.write<uint16_t>(KeyLen);
Douglas Gregore84a9da2009-04-20 20:36:09 +00003642 return std::make_pair(KeyLen, DataLen);
3643 }
Mike Stump11289f42009-09-09 15:08:12 +00003644
Chris Lattner0e62c1c2011-07-23 10:55:15 +00003645 void EmitKey(raw_ostream& Out, const IdentifierInfo* II,
Douglas Gregore84a9da2009-04-20 20:36:09 +00003646 unsigned KeyLen) {
3647 // Record the location of the key data. This is used when generating
3648 // the mapping from persistent IDs to strings.
3649 Writer.SetIdentifierOffset(II, Out.tell());
Richard Smith33e0f7e2015-07-22 02:08:40 +00003650
3651 // Emit the offset of the key/data length information to the interesting
3652 // identifiers table if necessary.
3653 if (InterestingIdentifierOffsets && isInterestingIdentifier(II))
3654 InterestingIdentifierOffsets->push_back(Out.tell() - 4);
3655
Daniel Dunbar2c422dc92009-10-18 20:26:12 +00003656 Out.write(II->getNameStart(), KeyLen);
Douglas Gregore84a9da2009-04-20 20:36:09 +00003657 }
Mike Stump11289f42009-09-09 15:08:12 +00003658
Douglas Gregor4a69c2e2011-09-01 17:04:32 +00003659 void EmitData(raw_ostream& Out, IdentifierInfo* II,
Sebastian Redl539c5062010-08-18 23:57:32 +00003660 IdentID ID, unsigned) {
Justin Bognere1c147c2014-03-28 22:03:19 +00003661 using namespace llvm::support;
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003662
Peter Collingbournee3f65292018-05-18 19:46:24 +00003663 endian::Writer LE(Out, little);
Richard Smithcf97cf62015-04-19 01:34:23 +00003664
Richard Smithd7329392015-04-21 21:46:32 +00003665 auto MacroOffset = Writer.getMacroDirectivesOffset(II);
3666 if (!isInterestingIdentifier(II, MacroOffset)) {
Justin Bognere1c147c2014-03-28 22:03:19 +00003667 LE.write<uint32_t>(ID << 1);
Douglas Gregor1d583f22009-04-28 21:18:29 +00003668 return;
3669 }
Douglas Gregorb9256522009-04-28 21:32:13 +00003670
Justin Bognere1c147c2014-03-28 22:03:19 +00003671 LE.write<uint32_t>((ID << 1) | 0x01);
Alexander Kornienko1d26c022012-09-25 17:18:14 +00003672 uint32_t Bits = (uint32_t)II->getObjCOrBuiltinID();
3673 assert((Bits & 0xffff) == Bits && "ObjCOrBuiltinID too big for ASTReader.");
Justin Bognere1c147c2014-03-28 22:03:19 +00003674 LE.write<uint16_t>(Bits);
Alexander Kornienko1d26c022012-09-25 17:18:14 +00003675 Bits = 0;
Richard Smithd7329392015-04-21 21:46:32 +00003676 bool HadMacroDefinition = MacroOffset != 0;
Alexander Kornienko1d26c022012-09-25 17:18:14 +00003677 Bits = (Bits << 1) | unsigned(HadMacroDefinition);
Daniel Dunbar91b640a2009-12-18 20:58:47 +00003678 Bits = (Bits << 1) | unsigned(II->isExtensionToken());
3679 Bits = (Bits << 1) | unsigned(II->isPoisoned());
Richard Smith9c254182015-07-19 21:41:12 +00003680 Bits = (Bits << 1) | unsigned(II->hasRevertedBuiltin());
Argyrios Kyrtzidis3084a612010-08-11 22:55:12 +00003681 Bits = (Bits << 1) | unsigned(II->hasRevertedTokenIDToIdentifier());
Daniel Dunbar91b640a2009-12-18 20:58:47 +00003682 Bits = (Bits << 1) | unsigned(II->isCPlusPlusOperatorKeyword());
Justin Bognere1c147c2014-03-28 22:03:19 +00003683 LE.write<uint16_t>(Bits);
Douglas Gregore84a9da2009-04-20 20:36:09 +00003684
Richard Smithd7329392015-04-21 21:46:32 +00003685 if (HadMacroDefinition)
3686 LE.write<uint32_t>(MacroOffset);
Alexander Kornienko1d26c022012-09-25 17:18:14 +00003687
Richard Smitha534a312015-07-21 23:54:07 +00003688 if (NeedDecls) {
3689 // Emit the declaration IDs in reverse order, because the
3690 // IdentifierResolver provides the declarations as they would be
3691 // visible (e.g., the function "stat" would come before the struct
3692 // "stat"), but the ASTReader adds declarations to the end of the list
3693 // (so we need to see the struct "stat" before the function "stat").
3694 // Only emit declarations that aren't from a chained PCH, though.
3695 SmallVector<NamedDecl *, 16> Decls(IdResolver.begin(II),
3696 IdResolver.end());
3697 for (SmallVectorImpl<NamedDecl *>::reverse_iterator D = Decls.rbegin(),
3698 DEnd = Decls.rend();
3699 D != DEnd; ++D)
3700 LE.write<uint32_t>(
3701 Writer.getDeclID(getDeclForLocalLookup(PP.getLangOpts(), *D)));
3702 }
Douglas Gregore84a9da2009-04-20 20:36:09 +00003703 }
3704};
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +00003705
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003706} // namespace
Douglas Gregore84a9da2009-04-20 20:36:09 +00003707
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00003708/// Write the identifier table into the AST file.
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00003709///
3710/// The identifier table consists of a blob containing string data
3711/// (the actual identifiers themselves) and a separate "offsets" index
3712/// that maps identifier IDs to locations within the blob.
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00003713void ASTWriter::WriteIdentifierTable(Preprocessor &PP,
Douglas Gregor935bc7a22011-10-27 09:33:13 +00003714 IdentifierResolver &IdResolver,
3715 bool IsModule) {
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00003716 using namespace llvm;
3717
Richard Smith33e0f7e2015-07-22 02:08:40 +00003718 RecordData InterestingIdents;
3719
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00003720 // Create and write out the blob that contains the identifier
3721 // strings.
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00003722 {
Justin Bognerbb094f02014-04-18 19:57:06 +00003723 llvm::OnDiskChainedHashTableGenerator<ASTIdentifierTableTrait> Generator;
Richard Smith33e0f7e2015-07-22 02:08:40 +00003724 ASTIdentifierTableTrait Trait(
3725 *this, PP, IdResolver, IsModule,
3726 (getLangOpts().CPlusPlus && IsModule) ? &InterestingIdents : nullptr);
Mike Stump11289f42009-09-09 15:08:12 +00003727
Douglas Gregore6648fb2009-04-28 20:33:11 +00003728 // Look for any identifiers that were named while processing the
3729 // headers, but are otherwise not needed. We add these to the hash
3730 // table to enable checking of the predefines buffer in the case
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00003731 // where the user adds new macro definitions when building the AST
Douglas Gregore6648fb2009-04-28 20:33:11 +00003732 // file.
Chandler Carruth8440c982015-03-26 23:54:15 +00003733 SmallVector<const IdentifierInfo *, 128> IIs;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00003734 for (const auto &ID : PP.getIdentifierTable())
3735 IIs.push_back(ID.second);
Chandler Carruth8440c982015-03-26 23:54:15 +00003736 // Sort the identifiers lexicographically before getting them references so
3737 // that their order is stable.
Fangrui Song55fab262018-09-26 22:16:28 +00003738 llvm::sort(IIs, llvm::less_ptr<IdentifierInfo>());
Chandler Carruth8440c982015-03-26 23:54:15 +00003739 for (const IdentifierInfo *II : IIs)
Richard Smith9c254182015-07-19 21:41:12 +00003740 if (Trait.isInterestingNonMacroIdentifier(II))
3741 getIdentifierRef(II);
Douglas Gregore6648fb2009-04-28 20:33:11 +00003742
Sebastian Redlff4a2952010-07-23 23:49:55 +00003743 // Create the on-disk hash table representation. We only store offsets
3744 // for identifiers that appear here for the first time.
3745 IdentifierOffsets.resize(NextIdentID - FirstIdentID);
Chandler Carruth885e78c2015-03-24 21:18:10 +00003746 for (auto IdentIDPair : IdentifierIDs) {
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00003747 auto *II = const_cast<IdentifierInfo *>(IdentIDPair.first);
Chandler Carruth885e78c2015-03-24 21:18:10 +00003748 IdentID ID = IdentIDPair.second;
3749 assert(II && "NULL identifier in identifier table");
Vassil Vassilev262f41e2016-03-30 20:16:03 +00003750 // Write out identifiers if either the ID is local or the identifier has
3751 // changed since it was loaded.
3752 if (ID >= FirstIdentID || !Chain || !II->isFromAST()
3753 || II->hasChangedSinceDeserialization() ||
Richard Smithd79514e2016-02-05 19:03:40 +00003754 (Trait.needDecls() &&
3755 II->hasFETokenInfoChangedSinceDeserialization()))
Chandler Carruth885e78c2015-03-24 21:18:10 +00003756 Generator.insert(II, ID, Trait);
Douglas Gregore84a9da2009-04-20 20:36:09 +00003757 }
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00003758
Douglas Gregore84a9da2009-04-20 20:36:09 +00003759 // Create the on-disk hash table in a buffer.
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00003760 SmallString<4096> IdentifierTable;
Douglas Gregora868bbd2009-04-21 22:25:48 +00003761 uint32_t BucketOffset;
Douglas Gregore84a9da2009-04-20 20:36:09 +00003762 {
Justin Bognere1c147c2014-03-28 22:03:19 +00003763 using namespace llvm::support;
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003764
Douglas Gregore84a9da2009-04-20 20:36:09 +00003765 llvm::raw_svector_ostream Out(IdentifierTable);
Douglas Gregorc78d3462009-04-24 21:10:55 +00003766 // Make sure that no bucket is at offset 0
Peter Collingbournee3f65292018-05-18 19:46:24 +00003767 endian::write<uint32_t>(Out, 0, little);
Douglas Gregora868bbd2009-04-21 22:25:48 +00003768 BucketOffset = Generator.Emit(Out, Trait);
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00003769 }
3770
3771 // Create a blob abbreviation
David Blaikieb44f0bf2017-01-04 22:36:43 +00003772 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Sebastian Redl539c5062010-08-18 23:57:32 +00003773 Abbrev->Add(BitCodeAbbrevOp(IDENTIFIER_TABLE));
Douglas Gregora868bbd2009-04-21 22:25:48 +00003774 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32));
Douglas Gregore84a9da2009-04-20 20:36:09 +00003775 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
David Blaikieb44f0bf2017-01-04 22:36:43 +00003776 unsigned IDTableAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00003777
3778 // Write the identifier table
Mehdi Amini57a41912015-09-10 01:46:39 +00003779 RecordData::value_type Record[] = {IDENTIFIER_TABLE, BucketOffset};
Yaron Keren92e1b622015-03-18 10:17:07 +00003780 Stream.EmitRecordWithBlob(IDTableAbbrev, Record, IdentifierTable);
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00003781 }
3782
3783 // Write the offsets table for identifier IDs.
David Blaikieb44f0bf2017-01-04 22:36:43 +00003784 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Sebastian Redl539c5062010-08-18 23:57:32 +00003785 Abbrev->Add(BitCodeAbbrevOp(IDENTIFIER_OFFSET));
Douglas Gregor0e149972009-04-25 19:10:14 +00003786 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // # of identifiers
Douglas Gregor1ab036c2011-08-03 21:49:18 +00003787 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Fixed, 32)); // first ID
Douglas Gregor0e149972009-04-25 19:10:14 +00003788 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
David Blaikieb44f0bf2017-01-04 22:36:43 +00003789 unsigned IdentifierOffsetAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Douglas Gregor0e149972009-04-25 19:10:14 +00003790
Douglas Gregor8d7edce2013-02-08 21:30:59 +00003791#ifndef NDEBUG
3792 for (unsigned I = 0, N = IdentifierOffsets.size(); I != N; ++I)
3793 assert(IdentifierOffsets[I] && "Missing identifier offset?");
3794#endif
Mehdi Amini57a41912015-09-10 01:46:39 +00003795
3796 RecordData::value_type Record[] = {IDENTIFIER_OFFSET,
3797 IdentifierOffsets.size(),
3798 FirstIdentID - NUM_PREDEF_IDENT_IDS};
Douglas Gregor0e149972009-04-25 19:10:14 +00003799 Stream.EmitRecordWithBlob(IdentifierOffsetAbbrev, Record,
Reid Kleckner012665e2015-05-21 00:13:09 +00003800 bytes(IdentifierOffsets));
Richard Smith33e0f7e2015-07-22 02:08:40 +00003801
3802 // In C++, write the list of interesting identifiers (those that are
3803 // defined as macros, poisoned, or similar unusual things).
3804 if (!InterestingIdents.empty())
3805 Stream.EmitRecord(INTERESTING_IDENTIFIERS, InterestingIdents);
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00003806}
3807
Douglas Gregorc5046832009-04-27 18:38:38 +00003808//===----------------------------------------------------------------------===//
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003809// DeclContext's Name Lookup Table Serialization
3810//===----------------------------------------------------------------------===//
3811
3812namespace {
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +00003813
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003814// Trait used for the on-disk hash table used in the method pool.
3815class ASTDeclContextNameLookupTrait {
3816 ASTWriter &Writer;
Richard Smithd88a7f12015-09-01 20:35:42 +00003817 llvm::SmallVector<DeclID, 64> DeclIDs;
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003818
3819public:
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003820 using key_type = DeclarationNameKey;
3821 using key_type_ref = key_type;
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003822
Richard Smithd88a7f12015-09-01 20:35:42 +00003823 /// A start and end index into DeclIDs, representing a sequence of decls.
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003824 using data_type = std::pair<unsigned, unsigned>;
3825 using data_type_ref = const data_type &;
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003826
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003827 using hash_value_type = unsigned;
3828 using offset_type = unsigned;
Justin Bogner25463f12014-04-18 20:27:24 +00003829
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003830 explicit ASTDeclContextNameLookupTrait(ASTWriter &Writer) : Writer(Writer) {}
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003831
Richard Smithd88a7f12015-09-01 20:35:42 +00003832 template<typename Coll>
3833 data_type getData(const Coll &Decls) {
3834 unsigned Start = DeclIDs.size();
3835 for (NamedDecl *D : Decls) {
3836 DeclIDs.push_back(
3837 Writer.GetDeclRef(getDeclForLocalLookup(Writer.getLangOpts(), D)));
3838 }
3839 return std::make_pair(Start, DeclIDs.size());
3840 }
3841
3842 data_type ImportData(const reader::ASTDeclContextNameLookupTrait::data_type &FromReader) {
3843 unsigned Start = DeclIDs.size();
3844 for (auto ID : FromReader)
3845 DeclIDs.push_back(ID);
3846 return std::make_pair(Start, DeclIDs.size());
3847 }
3848
3849 static bool EqualKey(key_type_ref a, key_type_ref b) {
3850 return a == b;
3851 }
3852
Richard Smitha06c7e62015-08-26 23:55:49 +00003853 hash_value_type ComputeHash(DeclarationNameKey Name) {
3854 return Name.getHash();
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003855 }
3856
Richard Smithd88a7f12015-09-01 20:35:42 +00003857 void EmitFileRef(raw_ostream &Out, ModuleFile *F) const {
3858 assert(Writer.hasChain() &&
3859 "have reference to loaded module file but no chain?");
3860
3861 using namespace llvm::support;
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003862
Peter Collingbournee3f65292018-05-18 19:46:24 +00003863 endian::write<uint32_t>(Out, Writer.getChain()->getModuleFileID(F), little);
Richard Smithd88a7f12015-09-01 20:35:42 +00003864 }
3865
Richard Smitha06c7e62015-08-26 23:55:49 +00003866 std::pair<unsigned, unsigned> EmitKeyDataLength(raw_ostream &Out,
3867 DeclarationNameKey Name,
3868 data_type_ref Lookup) {
Justin Bognere1c147c2014-03-28 22:03:19 +00003869 using namespace llvm::support;
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003870
Peter Collingbournee3f65292018-05-18 19:46:24 +00003871 endian::Writer LE(Out, little);
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003872 unsigned KeyLen = 1;
Richard Smitha06c7e62015-08-26 23:55:49 +00003873 switch (Name.getKind()) {
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003874 case DeclarationName::Identifier:
3875 case DeclarationName::ObjCZeroArgSelector:
3876 case DeclarationName::ObjCOneArgSelector:
3877 case DeclarationName::ObjCMultiArgSelector:
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003878 case DeclarationName::CXXLiteralOperatorName:
Richard Smith35845152017-02-07 01:37:30 +00003879 case DeclarationName::CXXDeductionGuideName:
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003880 KeyLen += 4;
3881 break;
3882 case DeclarationName::CXXOperatorName:
3883 KeyLen += 1;
3884 break;
Douglas Gregor3b65ed02011-08-02 18:32:54 +00003885 case DeclarationName::CXXConstructorName:
3886 case DeclarationName::CXXDestructorName:
3887 case DeclarationName::CXXConversionFunctionName:
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003888 case DeclarationName::CXXUsingDirective:
3889 break;
3890 }
Justin Bognere1c147c2014-03-28 22:03:19 +00003891 LE.write<uint16_t>(KeyLen);
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003892
Richard Smithf02662d2015-07-30 03:17:16 +00003893 // 4 bytes for each DeclID.
Richard Smithd88a7f12015-09-01 20:35:42 +00003894 unsigned DataLen = 4 * (Lookup.second - Lookup.first);
3895 assert(uint16_t(DataLen) == DataLen &&
3896 "too many decls for serialized lookup result");
Justin Bognere1c147c2014-03-28 22:03:19 +00003897 LE.write<uint16_t>(DataLen);
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003898
3899 return std::make_pair(KeyLen, DataLen);
3900 }
3901
Richard Smitha06c7e62015-08-26 23:55:49 +00003902 void EmitKey(raw_ostream &Out, DeclarationNameKey Name, unsigned) {
Justin Bognere1c147c2014-03-28 22:03:19 +00003903 using namespace llvm::support;
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003904
Peter Collingbournee3f65292018-05-18 19:46:24 +00003905 endian::Writer LE(Out, little);
Richard Smitha06c7e62015-08-26 23:55:49 +00003906 LE.write<uint8_t>(Name.getKind());
3907 switch (Name.getKind()) {
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003908 case DeclarationName::Identifier:
Richard Smitha06c7e62015-08-26 23:55:49 +00003909 case DeclarationName::CXXLiteralOperatorName:
Richard Smith35845152017-02-07 01:37:30 +00003910 case DeclarationName::CXXDeductionGuideName:
Richard Smitha06c7e62015-08-26 23:55:49 +00003911 LE.write<uint32_t>(Writer.getIdentifierRef(Name.getIdentifier()));
Benjamin Kramer53750b12012-09-19 13:40:40 +00003912 return;
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003913 case DeclarationName::ObjCZeroArgSelector:
3914 case DeclarationName::ObjCOneArgSelector:
3915 case DeclarationName::ObjCMultiArgSelector:
Richard Smitha06c7e62015-08-26 23:55:49 +00003916 LE.write<uint32_t>(Writer.getSelectorRef(Name.getSelector()));
Benjamin Kramer53750b12012-09-19 13:40:40 +00003917 return;
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003918 case DeclarationName::CXXOperatorName:
Richard Smitha06c7e62015-08-26 23:55:49 +00003919 assert(Name.getOperatorKind() < NUM_OVERLOADED_OPERATORS &&
Benjamin Kramer53750b12012-09-19 13:40:40 +00003920 "Invalid operator?");
Richard Smitha06c7e62015-08-26 23:55:49 +00003921 LE.write<uint8_t>(Name.getOperatorKind());
Benjamin Kramer53750b12012-09-19 13:40:40 +00003922 return;
Douglas Gregor3b65ed02011-08-02 18:32:54 +00003923 case DeclarationName::CXXConstructorName:
3924 case DeclarationName::CXXDestructorName:
3925 case DeclarationName::CXXConversionFunctionName:
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003926 case DeclarationName::CXXUsingDirective:
Benjamin Kramer53750b12012-09-19 13:40:40 +00003927 return;
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003928 }
Benjamin Kramer53750b12012-09-19 13:40:40 +00003929
3930 llvm_unreachable("Invalid name kind?");
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003931 }
3932
Richard Smitha06c7e62015-08-26 23:55:49 +00003933 void EmitData(raw_ostream &Out, key_type_ref, data_type Lookup,
3934 unsigned DataLen) {
Justin Bognere1c147c2014-03-28 22:03:19 +00003935 using namespace llvm::support;
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003936
Peter Collingbournee3f65292018-05-18 19:46:24 +00003937 endian::Writer LE(Out, little);
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003938 uint64_t Start = Out.tell(); (void)Start;
Richard Smithd88a7f12015-09-01 20:35:42 +00003939 for (unsigned I = Lookup.first, N = Lookup.second; I != N; ++I)
3940 LE.write<uint32_t>(DeclIDs[I]);
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003941 assert(Out.tell() - Start == DataLen && "Data length is wrong");
3942 }
3943};
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +00003944
Eugene Zelenkob7d89102017-11-11 00:08:50 +00003945} // namespace
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00003946
Chandler Carruthe972c362015-03-26 03:11:40 +00003947bool ASTWriter::isLookupResultExternal(StoredDeclsList &Result,
3948 DeclContext *DC) {
Erich Keanef92f31c2018-08-01 20:48:16 +00003949 return Result.hasExternalDecls() &&
3950 DC->hasNeedToReconcileExternalVisibleStorage();
Chandler Carruthe972c362015-03-26 03:11:40 +00003951}
3952
3953bool ASTWriter::isLookupResultEntirelyExternal(StoredDeclsList &Result,
3954 DeclContext *DC) {
3955 for (auto *D : Result.getLookupResult())
3956 if (!getDeclForLocalLookup(getLangOpts(), D)->isFromASTFile())
3957 return false;
3958
3959 return true;
3960}
3961
Richard Smithd88a7f12015-09-01 20:35:42 +00003962void
Chandler Carruthe972c362015-03-26 03:11:40 +00003963ASTWriter::GenerateNameLookupTable(const DeclContext *ConstDC,
Richard Smithcd45dbc2014-04-19 03:48:30 +00003964 llvm::SmallVectorImpl<char> &LookupTable) {
Erich Keanef92f31c2018-08-01 20:48:16 +00003965 assert(!ConstDC->hasLazyLocalLexicalLookups() &&
3966 !ConstDC->hasLazyExternalLexicalLookups() &&
Richard Smith9e2341d2015-03-23 03:25:59 +00003967 "must call buildLookups first");
Richard Smithcd45dbc2014-04-19 03:48:30 +00003968
Chandler Carruthe972c362015-03-26 03:11:40 +00003969 // FIXME: We need to build the lookups table, which is logically const.
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00003970 auto *DC = const_cast<DeclContext*>(ConstDC);
Chandler Carruthe972c362015-03-26 03:11:40 +00003971 assert(DC == DC->getPrimaryContext() && "only primary DC has lookup table");
3972
3973 // Create the on-disk hash table representation.
Richard Smithd88a7f12015-09-01 20:35:42 +00003974 MultiOnDiskHashTableGenerator<reader::ASTDeclContextNameLookupTrait,
3975 ASTDeclContextNameLookupTrait> Generator;
Richard Smithcd45dbc2014-04-19 03:48:30 +00003976 ASTDeclContextNameLookupTrait Trait(*this);
3977
Chandler Carruthe972c362015-03-26 03:11:40 +00003978 // The first step is to collect the declaration names which we need to
3979 // serialize into the name lookup table, and to collect them in a stable
3980 // order.
3981 SmallVector<DeclarationName, 16> Names;
Richard Smithcd45dbc2014-04-19 03:48:30 +00003982
Chandler Carruthe972c362015-03-26 03:11:40 +00003983 // We also build up small sets of the constructor and conversion function
3984 // names which are visible.
3985 llvm::SmallSet<DeclarationName, 8> ConstructorNameSet, ConversionNameSet;
Richard Smithcd45dbc2014-04-19 03:48:30 +00003986
Chandler Carruthe972c362015-03-26 03:11:40 +00003987 for (auto &Lookup : *DC->buildLookup()) {
3988 auto &Name = Lookup.first;
3989 auto &Result = Lookup.second;
3990
Douglas Gregor7dd37e52015-11-03 01:20:54 +00003991 // If there are no local declarations in our lookup result, we
3992 // don't need to write an entry for the name at all. If we can't
3993 // write out a lookup set without performing more deserialization,
3994 // just skip this entry.
3995 if (isLookupResultExternal(Result, DC) &&
Chandler Carruthe972c362015-03-26 03:11:40 +00003996 isLookupResultEntirelyExternal(Result, DC))
3997 continue;
3998
3999 // We also skip empty results. If any of the results could be external and
4000 // the currently available results are empty, then all of the results are
4001 // external and we skip it above. So the only way we get here with an empty
4002 // results is when no results could have been external *and* we have
4003 // external results.
4004 //
4005 // FIXME: While we might want to start emitting on-disk entries for negative
4006 // lookups into a decl context as an optimization, today we *have* to skip
4007 // them because there are names with empty lookup results in decl contexts
4008 // which we can't emit in any stable ordering: we lookup constructors and
4009 // conversion functions in the enclosing namespace scope creating empty
4010 // results for them. This in almost certainly a bug in Clang's name lookup,
4011 // but that is likely to be hard or impossible to fix and so we tolerate it
4012 // here by omitting lookups with empty results.
4013 if (Lookup.second.getLookupResult().empty())
4014 continue;
4015
4016 switch (Lookup.first.getNameKind()) {
4017 default:
4018 Names.push_back(Lookup.first);
4019 break;
4020
Richard Smithcd45dbc2014-04-19 03:48:30 +00004021 case DeclarationName::CXXConstructorName:
Chandler Carruthe972c362015-03-26 03:11:40 +00004022 assert(isa<CXXRecordDecl>(DC) &&
4023 "Cannot have a constructor name outside of a class!");
4024 ConstructorNameSet.insert(Name);
4025 break;
Richard Smithcd45dbc2014-04-19 03:48:30 +00004026
4027 case DeclarationName::CXXConversionFunctionName:
Chandler Carruthe972c362015-03-26 03:11:40 +00004028 assert(isa<CXXRecordDecl>(DC) &&
4029 "Cannot have a conversion function name outside of a class!");
4030 ConversionNameSet.insert(Name);
Rafael Espindolac606b3e2015-03-25 04:43:15 +00004031 break;
Richard Smithcd45dbc2014-04-19 03:48:30 +00004032 }
Chandler Carruth75c9f132015-03-25 00:34:51 +00004033 }
Chandler Carruth75c9f132015-03-25 00:34:51 +00004034
Chandler Carruthe972c362015-03-26 03:11:40 +00004035 // Sort the names into a stable order.
Fangrui Song55fab262018-09-26 22:16:28 +00004036 llvm::sort(Names);
Chandler Carruthe972c362015-03-26 03:11:40 +00004037
Chandler Carruthffbf7052015-03-26 22:27:09 +00004038 if (auto *D = dyn_cast<CXXRecordDecl>(DC)) {
Chandler Carruthe972c362015-03-26 03:11:40 +00004039 // We need to establish an ordering of constructor and conversion function
Chandler Carruthffbf7052015-03-26 22:27:09 +00004040 // names, and they don't have an intrinsic ordering.
Chandler Carruthe972c362015-03-26 03:11:40 +00004041
Chandler Carruthffbf7052015-03-26 22:27:09 +00004042 // First we try the easy case by forming the current context's constructor
4043 // name and adding that name first. This is a very useful optimization to
4044 // avoid walking the lexical declarations in many cases, and it also
4045 // handles the only case where a constructor name can come from some other
4046 // lexical context -- when that name is an implicit constructor merged from
4047 // another declaration in the redecl chain. Any non-implicit constructor or
4048 // conversion function which doesn't occur in all the lexical contexts
4049 // would be an ODR violation.
4050 auto ImplicitCtorName = Context->DeclarationNames.getCXXConstructorName(
4051 Context->getCanonicalType(Context->getRecordType(D)));
4052 if (ConstructorNameSet.erase(ImplicitCtorName))
4053 Names.push_back(ImplicitCtorName);
Chandler Carruthe972c362015-03-26 03:11:40 +00004054
Chandler Carruthffbf7052015-03-26 22:27:09 +00004055 // If we still have constructors or conversion functions, we walk all the
4056 // names in the decl and add the constructors and conversion functions
4057 // which are visible in the order they lexically occur within the context.
4058 if (!ConstructorNameSet.empty() || !ConversionNameSet.empty())
4059 for (Decl *ChildD : cast<CXXRecordDecl>(DC)->decls())
4060 if (auto *ChildND = dyn_cast<NamedDecl>(ChildD)) {
4061 auto Name = ChildND->getDeclName();
4062 switch (Name.getNameKind()) {
4063 default:
4064 continue;
4065
4066 case DeclarationName::CXXConstructorName:
4067 if (ConstructorNameSet.erase(Name))
4068 Names.push_back(Name);
4069 break;
4070
4071 case DeclarationName::CXXConversionFunctionName:
4072 if (ConversionNameSet.erase(Name))
4073 Names.push_back(Name);
4074 break;
4075 }
4076
4077 if (ConstructorNameSet.empty() && ConversionNameSet.empty())
4078 break;
Chandler Carruthe972c362015-03-26 03:11:40 +00004079 }
4080
Chandler Carruthe972c362015-03-26 03:11:40 +00004081 assert(ConstructorNameSet.empty() && "Failed to find all of the visible "
4082 "constructors by walking all the "
4083 "lexical members of the context.");
4084 assert(ConversionNameSet.empty() && "Failed to find all of the visible "
4085 "conversion functions by walking all "
4086 "the lexical members of the context.");
Richard Smith961eae52014-03-25 01:14:22 +00004087 }
4088
Chandler Carruthe972c362015-03-26 03:11:40 +00004089 // Next we need to do a lookup with each name into this decl context to fully
4090 // populate any results from external sources. We don't actually use the
4091 // results of these lookups because we only want to use the results after all
4092 // results have been loaded and the pointers into them will be stable.
4093 for (auto &Name : Names)
4094 DC->lookup(Name);
4095
4096 // Now we need to insert the results for each name into the hash table. For
4097 // constructor names and conversion function names, we actually need to merge
4098 // all of the results for them into one list of results each and insert
4099 // those.
4100 SmallVector<NamedDecl *, 8> ConstructorDecls;
4101 SmallVector<NamedDecl *, 8> ConversionDecls;
4102
4103 // Now loop over the names, either inserting them or appending for the two
4104 // special cases.
4105 for (auto &Name : Names) {
4106 DeclContext::lookup_result Result = DC->noload_lookup(Name);
4107
4108 switch (Name.getNameKind()) {
4109 default:
Richard Smithd88a7f12015-09-01 20:35:42 +00004110 Generator.insert(Name, Trait.getData(Result), Trait);
Chandler Carruthe972c362015-03-26 03:11:40 +00004111 break;
4112
4113 case DeclarationName::CXXConstructorName:
4114 ConstructorDecls.append(Result.begin(), Result.end());
4115 break;
4116
4117 case DeclarationName::CXXConversionFunctionName:
4118 ConversionDecls.append(Result.begin(), Result.end());
4119 break;
4120 }
4121 }
4122
4123 // Handle our two special cases if we ended up having any. We arbitrarily use
4124 // the first declaration's name here because the name itself isn't part of
4125 // the key, only the kind of name is used.
4126 if (!ConstructorDecls.empty())
4127 Generator.insert(ConstructorDecls.front()->getDeclName(),
Richard Smithd88a7f12015-09-01 20:35:42 +00004128 Trait.getData(ConstructorDecls), Trait);
Chandler Carruthe972c362015-03-26 03:11:40 +00004129 if (!ConversionDecls.empty())
4130 Generator.insert(ConversionDecls.front()->getDeclName(),
Richard Smithd88a7f12015-09-01 20:35:42 +00004131 Trait.getData(ConversionDecls), Trait);
Chandler Carruthe972c362015-03-26 03:11:40 +00004132
Richard Smithd88a7f12015-09-01 20:35:42 +00004133 // Create the on-disk hash table. Also emit the existing imported and
4134 // merged table if there is one.
4135 auto *Lookups = Chain ? Chain->getLoadedLookupTables(DC) : nullptr;
4136 Generator.emit(LookupTable, Trait, Lookups ? &Lookups->Table : nullptr);
Richard Smith961eae52014-03-25 01:14:22 +00004137}
4138
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00004139/// Write the block containing all of the declaration IDs
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00004140/// visible from the given DeclContext.
4141///
4142/// \returns the offset of the DECL_CONTEXT_VISIBLE block within the
Sebastian Redla4071b42010-08-24 00:50:09 +00004143/// bitstream, or 0 if no block was written.
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00004144uint64_t ASTWriter::WriteDeclContextVisibleBlock(ASTContext &Context,
4145 DeclContext *DC) {
Richard Smith5fc18a92015-07-12 23:43:21 +00004146 // If we imported a key declaration of this namespace, write the visible
4147 // lookup results as an update record for it rather than including them
4148 // on this declaration. We will only look at key declarations on reload.
4149 if (isa<NamespaceDecl>(DC) && Chain &&
4150 Chain->getKeyDeclaration(cast<Decl>(DC))->isFromASTFile()) {
4151 // Only do this once, for the first local declaration of the namespace.
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00004152 for (auto *Prev = cast<NamespaceDecl>(DC)->getPreviousDecl(); Prev;
Richard Smith5fc18a92015-07-12 23:43:21 +00004153 Prev = Prev->getPreviousDecl())
4154 if (!Prev->isFromASTFile())
4155 return 0;
4156
4157 // Note that we need to emit an update record for the primary context.
4158 UpdatedDeclContexts.insert(DC->getPrimaryContext());
4159
4160 // Make sure all visible decls are written. They will be recorded later. We
4161 // do this using a side data structure so we can sort the names into
4162 // a deterministic order.
4163 StoredDeclsMap *Map = DC->getPrimaryContext()->buildLookup();
4164 SmallVector<std::pair<DeclarationName, DeclContext::lookup_result>, 16>
4165 LookupResults;
4166 if (Map) {
4167 LookupResults.reserve(Map->size());
4168 for (auto &Entry : *Map)
4169 LookupResults.push_back(
4170 std::make_pair(Entry.first, Entry.second.getLookupResult()));
4171 }
4172
Fangrui Song55fab262018-09-26 22:16:28 +00004173 llvm::sort(LookupResults, llvm::less_first());
Richard Smith5fc18a92015-07-12 23:43:21 +00004174 for (auto &NameAndResult : LookupResults) {
4175 DeclarationName Name = NameAndResult.first;
4176 DeclContext::lookup_result Result = NameAndResult.second;
4177 if (Name.getNameKind() == DeclarationName::CXXConstructorName ||
4178 Name.getNameKind() == DeclarationName::CXXConversionFunctionName) {
4179 // We have to work around a name lookup bug here where negative lookup
4180 // results for these names get cached in namespace lookup tables (these
4181 // names should never be looked up in a namespace).
4182 assert(Result.empty() && "Cannot have a constructor or conversion "
4183 "function name in a namespace!");
4184 continue;
4185 }
4186
4187 for (NamedDecl *ND : Result)
4188 if (!ND->isFromASTFile())
4189 GetDeclRef(ND);
4190 }
4191
4192 return 0;
4193 }
4194
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00004195 if (DC->getPrimaryContext() != DC)
4196 return 0;
4197
Chandler Carruthe972c362015-03-26 03:11:40 +00004198 // Skip contexts which don't support name lookup.
4199 if (!DC->isLookupContext())
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00004200 return 0;
4201
4202 // If not in C++, we perform name lookup for the translation unit via the
4203 // IdentifierInfo chains, don't bother to build a visible-declarations table.
David Blaikiebbafb8a2012-03-11 07:00:24 +00004204 if (DC->isTranslationUnit() && !Context.getLangOpts().CPlusPlus)
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00004205 return 0;
4206
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00004207 // Serialize the contents of the mapping used for lookup. Note that,
4208 // although we have two very different code paths, the serialized
4209 // representation is the same for both cases: a declaration name,
4210 // followed by a size, followed by references to the visible
4211 // declarations that have that name.
4212 uint64_t Offset = Stream.GetCurrentBitNo();
Richard Smithf634c902012-03-16 06:12:59 +00004213 StoredDeclsMap *Map = DC->buildLookup();
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00004214 if (!Map || Map->empty())
4215 return 0;
4216
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00004217 // Create the on-disk hash table in a buffer.
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00004218 SmallString<4096> LookupTable;
Richard Smithd88a7f12015-09-01 20:35:42 +00004219 GenerateNameLookupTable(DC, LookupTable);
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00004220
4221 // Write the lookup table
Mehdi Amini57a41912015-09-10 01:46:39 +00004222 RecordData::value_type Record[] = {DECL_CONTEXT_VISIBLE};
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00004223 Stream.EmitRecordWithBlob(DeclContextVisibleLookupAbbrev, Record,
Yaron Keren92e1b622015-03-18 10:17:07 +00004224 LookupTable);
Argyrios Kyrtzidisba88bfa2010-08-20 16:04:35 +00004225 ++NumVisibleDeclContexts;
4226 return Offset;
4227}
4228
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00004229/// Write an UPDATE_VISIBLE block for the given context.
Sebastian Redla4071b42010-08-24 00:50:09 +00004230///
4231/// UPDATE_VISIBLE blocks contain the declarations that are added to an existing
4232/// DeclContext in a dependent AST file. As such, they only exist for the TU
Richard Smithf634c902012-03-16 06:12:59 +00004233/// (in C++), for namespaces, and for classes with forward-declared unscoped
4234/// enumeration members (in C++11).
Sebastian Redla4071b42010-08-24 00:50:09 +00004235void ASTWriter::WriteDeclContextVisibleUpdate(const DeclContext *DC) {
Richard Smith961eae52014-03-25 01:14:22 +00004236 StoredDeclsMap *Map = DC->getLookupPtr();
Sebastian Redla4071b42010-08-24 00:50:09 +00004237 if (!Map || Map->empty())
4238 return;
4239
Sebastian Redla4071b42010-08-24 00:50:09 +00004240 // Create the on-disk hash table in a buffer.
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00004241 SmallString<4096> LookupTable;
Richard Smithd88a7f12015-09-01 20:35:42 +00004242 GenerateNameLookupTable(DC, LookupTable);
Sebastian Redla4071b42010-08-24 00:50:09 +00004243
Richard Smith5fc18a92015-07-12 23:43:21 +00004244 // If we're updating a namespace, select a key declaration as the key for the
4245 // update record; those are the only ones that will be checked on reload.
4246 if (isa<NamespaceDecl>(DC))
4247 DC = cast<DeclContext>(Chain->getKeyDeclaration(cast<Decl>(DC)));
4248
Sebastian Redla4071b42010-08-24 00:50:09 +00004249 // Write the lookup table
Mehdi Amini57a41912015-09-10 01:46:39 +00004250 RecordData::value_type Record[] = {UPDATE_VISIBLE, getDeclID(cast<Decl>(DC))};
Yaron Keren92e1b622015-03-18 10:17:07 +00004251 Stream.EmitRecordWithBlob(UpdateVisibleAbbrev, Record, LookupTable);
Sebastian Redla4071b42010-08-24 00:50:09 +00004252}
4253
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00004254/// Write an FP_PRAGMA_OPTIONS block for the given FPOptions.
Peter Collingbourne5df20e02011-02-15 19:46:30 +00004255void ASTWriter::WriteFPPragmaOptions(const FPOptions &Opts) {
Adam Nemet484aa452017-03-27 19:17:25 +00004256 RecordData::value_type Record[] = {Opts.getInt()};
Peter Collingbourne5df20e02011-02-15 19:46:30 +00004257 Stream.EmitRecord(FP_PRAGMA_OPTIONS, Record);
4258}
4259
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00004260/// Write an OPENCL_EXTENSIONS block for the given OpenCLOptions.
Peter Collingbourne5df20e02011-02-15 19:46:30 +00004261void ASTWriter::WriteOpenCLExtensions(Sema &SemaRef) {
David Blaikiebbafb8a2012-03-11 07:00:24 +00004262 if (!SemaRef.Context.getLangOpts().OpenCL)
Peter Collingbourne5df20e02011-02-15 19:46:30 +00004263 return;
4264
4265 const OpenCLOptions &Opts = SemaRef.getOpenCLOptions();
4266 RecordData Record;
Yaxun Liu5b746652016-12-18 05:18:55 +00004267 for (const auto &I:Opts.OptMap) {
4268 AddString(I.getKey(), Record);
4269 auto V = I.getValue();
Yaxun Liucc2741c2016-12-18 06:35:06 +00004270 Record.push_back(V.Supported ? 1 : 0);
4271 Record.push_back(V.Enabled ? 1 : 0);
Yaxun Liu5b746652016-12-18 05:18:55 +00004272 Record.push_back(V.Avail);
4273 Record.push_back(V.Core);
4274 }
Peter Collingbourne5df20e02011-02-15 19:46:30 +00004275 Stream.EmitRecord(OPENCL_EXTENSIONS, Record);
4276}
4277
Yaxun Liu5b746652016-12-18 05:18:55 +00004278void ASTWriter::WriteOpenCLExtensionTypes(Sema &SemaRef) {
4279 if (!SemaRef.Context.getLangOpts().OpenCL)
4280 return;
4281
4282 RecordData Record;
4283 for (const auto &I : SemaRef.OpenCLTypeExtMap) {
4284 Record.push_back(
4285 static_cast<unsigned>(getTypeID(I.first->getCanonicalTypeInternal())));
4286 Record.push_back(I.second.size());
4287 for (auto Ext : I.second)
4288 AddString(Ext, Record);
4289 }
4290 Stream.EmitRecord(OPENCL_EXTENSION_TYPES, Record);
4291}
4292
4293void ASTWriter::WriteOpenCLExtensionDecls(Sema &SemaRef) {
4294 if (!SemaRef.Context.getLangOpts().OpenCL)
4295 return;
4296
4297 RecordData Record;
4298 for (const auto &I : SemaRef.OpenCLDeclExtMap) {
4299 Record.push_back(getDeclID(I.first));
4300 Record.push_back(static_cast<unsigned>(I.second.size()));
4301 for (auto Ext : I.second)
4302 AddString(Ext, Record);
4303 }
4304 Stream.EmitRecord(OPENCL_EXTENSION_DECLS, Record);
4305}
4306
Justin Lebar67a78a62016-10-08 22:15:58 +00004307void ASTWriter::WriteCUDAPragmas(Sema &SemaRef) {
4308 if (SemaRef.ForceCUDAHostDeviceDepth > 0) {
4309 RecordData::value_type Record[] = {SemaRef.ForceCUDAHostDeviceDepth};
4310 Stream.EmitRecord(CUDA_PRAGMA_FORCE_HOST_DEVICE_DEPTH, Record);
4311 }
4312}
4313
Douglas Gregor404cdde2012-01-27 01:47:08 +00004314void ASTWriter::WriteObjCCategories() {
Dmitri Gribenkof8579502013-01-12 19:30:44 +00004315 SmallVector<ObjCCategoriesInfo, 2> CategoriesMap;
Douglas Gregor404cdde2012-01-27 01:47:08 +00004316 RecordData Categories;
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00004317
Douglas Gregor404cdde2012-01-27 01:47:08 +00004318 for (unsigned I = 0, N = ObjCClassesWithCategories.size(); I != N; ++I) {
4319 unsigned Size = 0;
4320 unsigned StartIndex = Categories.size();
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00004321
Douglas Gregor404cdde2012-01-27 01:47:08 +00004322 ObjCInterfaceDecl *Class = ObjCClassesWithCategories[I];
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00004323
Douglas Gregor404cdde2012-01-27 01:47:08 +00004324 // Allocate space for the size.
4325 Categories.push_back(0);
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00004326
Douglas Gregor404cdde2012-01-27 01:47:08 +00004327 // Add the categories.
Douglas Gregor048fbfa2013-01-16 23:00:23 +00004328 for (ObjCInterfaceDecl::known_categories_iterator
4329 Cat = Class->known_categories_begin(),
4330 CatEnd = Class->known_categories_end();
4331 Cat != CatEnd; ++Cat, ++Size) {
4332 assert(getDeclID(*Cat) != 0 && "Bogus category");
4333 AddDeclRef(*Cat, Categories);
Douglas Gregor404cdde2012-01-27 01:47:08 +00004334 }
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00004335
Douglas Gregor404cdde2012-01-27 01:47:08 +00004336 // Update the size.
4337 Categories[StartIndex] = Size;
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00004338
Douglas Gregor404cdde2012-01-27 01:47:08 +00004339 // Record this interface -> category map.
4340 ObjCCategoriesInfo CatInfo = { getDeclID(Class), StartIndex };
4341 CategoriesMap.push_back(CatInfo);
4342 }
4343
4344 // Sort the categories map by the definition ID, since the reader will be
4345 // performing binary searches on this information.
4346 llvm::array_pod_sort(CategoriesMap.begin(), CategoriesMap.end());
4347
4348 // Emit the categories map.
4349 using namespace llvm;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00004350
David Blaikieb44f0bf2017-01-04 22:36:43 +00004351 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Douglas Gregor404cdde2012-01-27 01:47:08 +00004352 Abbrev->Add(BitCodeAbbrevOp(OBJC_CATEGORIES_MAP));
4353 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::VBR, 6)); // # of entries
4354 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
David Blaikieb44f0bf2017-01-04 22:36:43 +00004355 unsigned AbbrevID = Stream.EmitAbbrev(std::move(Abbrev));
Mehdi Amini57a41912015-09-10 01:46:39 +00004356
4357 RecordData::value_type Record[] = {OBJC_CATEGORIES_MAP, CategoriesMap.size()};
4358 Stream.EmitRecordWithBlob(AbbrevID, Record,
4359 reinterpret_cast<char *>(CategoriesMap.data()),
Douglas Gregor404cdde2012-01-27 01:47:08 +00004360 CategoriesMap.size() * sizeof(ObjCCategoriesInfo));
Mehdi Amini57a41912015-09-10 01:46:39 +00004361
Douglas Gregor404cdde2012-01-27 01:47:08 +00004362 // Emit the category lists.
4363 Stream.EmitRecord(OBJC_CATEGORIES, Categories);
4364}
4365
Richard Smithe40f2ba2013-08-07 21:41:30 +00004366void ASTWriter::WriteLateParsedTemplates(Sema &SemaRef) {
4367 Sema::LateParsedTemplateMapT &LPTMap = SemaRef.LateParsedTemplateMap;
4368
4369 if (LPTMap.empty())
4370 return;
4371
4372 RecordData Record;
Justin Lebar28f09c52016-10-10 16:26:08 +00004373 for (auto &LPTMapEntry : LPTMap) {
Chandler Carruth52cee4d2015-03-26 09:08:15 +00004374 const FunctionDecl *FD = LPTMapEntry.first;
Justin Lebar28f09c52016-10-10 16:26:08 +00004375 LateParsedTemplate &LPT = *LPTMapEntry.second;
Chandler Carruth52cee4d2015-03-26 09:08:15 +00004376 AddDeclRef(FD, Record);
Justin Lebar28f09c52016-10-10 16:26:08 +00004377 AddDeclRef(LPT.D, Record);
4378 Record.push_back(LPT.Toks.size());
Richard Smithe40f2ba2013-08-07 21:41:30 +00004379
Justin Lebar28f09c52016-10-10 16:26:08 +00004380 for (const auto &Tok : LPT.Toks) {
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00004381 AddToken(Tok, Record);
Richard Smithe40f2ba2013-08-07 21:41:30 +00004382 }
4383 }
4384 Stream.EmitRecord(LATE_PARSED_TEMPLATE, Record);
4385}
4386
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00004387/// Write the state of 'pragma clang optimize' at the end of the module.
Dario Domizioli13a0a382014-05-23 12:13:25 +00004388void ASTWriter::WriteOptimizePragmaOptions(Sema &SemaRef) {
4389 RecordData Record;
4390 SourceLocation PragmaLoc = SemaRef.getOptimizeOffPragmaLocation();
4391 AddSourceLocation(PragmaLoc, Record);
4392 Stream.EmitRecord(OPTIMIZE_PRAGMA_OPTIONS, Record);
4393}
4394
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00004395/// Write the state of 'pragma ms_struct' at the end of the module.
Nico Weber779355f2016-03-02 23:22:00 +00004396void ASTWriter::WriteMSStructPragmaOptions(Sema &SemaRef) {
4397 RecordData Record;
4398 Record.push_back(SemaRef.MSStructPragmaOn ? PMSST_ON : PMSST_OFF);
4399 Stream.EmitRecord(MSSTRUCT_PRAGMA_OPTIONS, Record);
4400}
4401
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00004402/// Write the state of 'pragma pointers_to_members' at the end of the
Nico Weber42932312016-03-03 00:17:35 +00004403//module.
4404void ASTWriter::WriteMSPointersToMembersPragmaOptions(Sema &SemaRef) {
4405 RecordData Record;
4406 Record.push_back(SemaRef.MSPointerToMemberRepresentationMethod);
4407 AddSourceLocation(SemaRef.ImplicitMSInheritanceAttrLoc, Record);
4408 Stream.EmitRecord(POINTERS_TO_MEMBERS_PRAGMA_OPTIONS, Record);
4409}
4410
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00004411/// Write the state of 'pragma pack' at the end of the module.
Alex Lorenz7d7e1e02017-03-31 15:36:21 +00004412void ASTWriter::WritePackPragmaOptions(Sema &SemaRef) {
Duncan P. N. Exon Smith03df14c2017-04-15 00:07:57 +00004413 // Don't serialize pragma pack state for modules, since it should only take
4414 // effect on a per-submodule basis.
4415 if (WritingModule)
4416 return;
4417
Alex Lorenz7d7e1e02017-03-31 15:36:21 +00004418 RecordData Record;
4419 Record.push_back(SemaRef.PackStack.CurrentValue);
4420 AddSourceLocation(SemaRef.PackStack.CurrentPragmaLocation, Record);
4421 Record.push_back(SemaRef.PackStack.Stack.size());
4422 for (const auto &StackEntry : SemaRef.PackStack.Stack) {
4423 Record.push_back(StackEntry.Value);
4424 AddSourceLocation(StackEntry.PragmaLocation, Record);
Alex Lorenz45b40142017-07-28 14:41:21 +00004425 AddSourceLocation(StackEntry.PragmaPushLocation, Record);
Alex Lorenz7d7e1e02017-03-31 15:36:21 +00004426 AddString(StackEntry.StackSlotLabel, Record);
4427 }
4428 Stream.EmitRecord(PACK_PRAGMA_OPTIONS, Record);
4429}
4430
Douglas Gregor8f64ca12015-12-08 22:43:32 +00004431void ASTWriter::WriteModuleFileExtension(Sema &SemaRef,
4432 ModuleFileExtensionWriter &Writer) {
Douglas Gregor6623e1f2015-11-03 18:33:07 +00004433 // Enter the extension block.
4434 Stream.EnterSubblock(EXTENSION_BLOCK_ID, 4);
4435
4436 // Emit the metadata record abbreviation.
David Blaikieb44f0bf2017-01-04 22:36:43 +00004437 auto Abv = std::make_shared<llvm::BitCodeAbbrev>();
Douglas Gregor6623e1f2015-11-03 18:33:07 +00004438 Abv->Add(llvm::BitCodeAbbrevOp(EXTENSION_METADATA));
4439 Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::VBR, 6));
4440 Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::VBR, 6));
4441 Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::VBR, 6));
4442 Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::VBR, 6));
4443 Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::Blob));
David Blaikieb44f0bf2017-01-04 22:36:43 +00004444 unsigned Abbrev = Stream.EmitAbbrev(std::move(Abv));
Douglas Gregor6623e1f2015-11-03 18:33:07 +00004445
4446 // Emit the metadata record.
4447 RecordData Record;
4448 auto Metadata = Writer.getExtension()->getExtensionMetadata();
4449 Record.push_back(EXTENSION_METADATA);
4450 Record.push_back(Metadata.MajorVersion);
4451 Record.push_back(Metadata.MinorVersion);
4452 Record.push_back(Metadata.BlockName.size());
4453 Record.push_back(Metadata.UserInfo.size());
4454 SmallString<64> Buffer;
4455 Buffer += Metadata.BlockName;
4456 Buffer += Metadata.UserInfo;
4457 Stream.EmitRecordWithBlob(Abbrev, Record, Buffer);
4458
4459 // Emit the contents of the extension block.
Douglas Gregor8f64ca12015-12-08 22:43:32 +00004460 Writer.writeExtensionContents(SemaRef, Stream);
Douglas Gregor6623e1f2015-11-03 18:33:07 +00004461
4462 // Exit the extension block.
4463 Stream.ExitBlock();
4464}
4465
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00004466//===----------------------------------------------------------------------===//
Douglas Gregorc5046832009-04-27 18:38:38 +00004467// General Serialization Routines
4468//===----------------------------------------------------------------------===//
4469
Richard Smithe43e2b32018-08-20 21:47:29 +00004470void ASTRecordWriter::AddAttr(const Attr *A) {
Reid Kleckner11f9f8a2018-08-14 01:55:37 +00004471 auto &Record = *this;
Richard Smithe43e2b32018-08-20 21:47:29 +00004472 if (!A)
4473 return Record.push_back(0);
4474 Record.push_back(A->getKind() + 1); // FIXME: stable encoding, target attrs
4475 Record.AddSourceRange(A->getRange());
Reid Kleckner11f9f8a2018-08-14 01:55:37 +00004476
4477#include "clang/Serialization/AttrPCHWrite.inc"
Richard Smithe43e2b32018-08-20 21:47:29 +00004478}
4479
4480/// Emit the list of attributes to the specified record.
4481void ASTRecordWriter::AddAttributes(ArrayRef<const Attr *> Attrs) {
4482 push_back(Attrs.size());
4483 for (const auto *A : Attrs)
4484 AddAttr(A);
Douglas Gregorbc8a78d52009-04-15 21:30:51 +00004485}
4486
John McCallf413f5e2013-05-03 00:10:13 +00004487void ASTWriter::AddToken(const Token &Tok, RecordDataImpl &Record) {
4488 AddSourceLocation(Tok.getLocation(), Record);
4489 Record.push_back(Tok.getLength());
4490
4491 // FIXME: When reading literal tokens, reconstruct the literal pointer
4492 // if it is needed.
4493 AddIdentifierRef(Tok.getIdentifierInfo(), Record);
4494 // FIXME: Should translate token kind to a stable encoding.
4495 Record.push_back(Tok.getKind());
4496 // FIXME: Should translate token flags to a stable encoding.
4497 Record.push_back(Tok.getFlags());
4498}
4499
Chris Lattner0e62c1c2011-07-23 10:55:15 +00004500void ASTWriter::AddString(StringRef Str, RecordDataImpl &Record) {
Douglas Gregorbc8a78d52009-04-15 21:30:51 +00004501 Record.push_back(Str.size());
4502 Record.insert(Record.end(), Str.begin(), Str.end());
4503}
4504
Richard Smith7ed1bc92014-12-05 22:42:13 +00004505bool ASTWriter::PreparePathForOutput(SmallVectorImpl<char> &Path) {
Richard Smith54cc3c22014-12-11 20:50:24 +00004506 assert(Context && "should have context when outputting path");
Richard Smith7ed1bc92014-12-05 22:42:13 +00004507
Richard Smith54cc3c22014-12-11 20:50:24 +00004508 bool Changed =
4509 cleanPathForOutput(Context->getSourceManager().getFileManager(), Path);
Richard Smith7ed1bc92014-12-05 22:42:13 +00004510
4511 // Remove a prefix to make the path relative, if relevant.
4512 const char *PathBegin = Path.data();
4513 const char *PathPtr =
4514 adjustFilenameForRelocatableAST(PathBegin, BaseDirectory);
4515 if (PathPtr != PathBegin) {
4516 Path.erase(Path.begin(), Path.begin() + (PathPtr - PathBegin));
4517 Changed = true;
4518 }
4519
4520 return Changed;
4521}
4522
4523void ASTWriter::AddPath(StringRef Path, RecordDataImpl &Record) {
4524 SmallString<128> FilePath(Path);
4525 PreparePathForOutput(FilePath);
4526 AddString(FilePath, Record);
4527}
4528
Mehdi Amini57a41912015-09-10 01:46:39 +00004529void ASTWriter::EmitRecordWithPath(unsigned Abbrev, RecordDataRef Record,
Richard Smith7ed1bc92014-12-05 22:42:13 +00004530 StringRef Path) {
4531 SmallString<128> FilePath(Path);
4532 PreparePathForOutput(FilePath);
4533 Stream.EmitRecordWithBlob(Abbrev, Record, FilePath);
4534}
4535
Douglas Gregor20b2ebd2011-03-23 00:50:03 +00004536void ASTWriter::AddVersionTuple(const VersionTuple &Version,
4537 RecordDataImpl &Record) {
4538 Record.push_back(Version.getMajor());
David Blaikie05785d12013-02-20 22:23:23 +00004539 if (Optional<unsigned> Minor = Version.getMinor())
Douglas Gregor20b2ebd2011-03-23 00:50:03 +00004540 Record.push_back(*Minor + 1);
4541 else
4542 Record.push_back(0);
David Blaikie05785d12013-02-20 22:23:23 +00004543 if (Optional<unsigned> Subminor = Version.getSubminor())
Douglas Gregor20b2ebd2011-03-23 00:50:03 +00004544 Record.push_back(*Subminor + 1);
4545 else
4546 Record.push_back(0);
4547}
4548
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00004549/// Note that the identifier II occurs at the given offset
Douglas Gregore84a9da2009-04-20 20:36:09 +00004550/// within the identifier table.
Sebastian Redl55c0ad52010-08-18 23:56:21 +00004551void ASTWriter::SetIdentifierOffset(const IdentifierInfo *II, uint32_t Offset) {
Sebastian Redl539c5062010-08-18 23:57:32 +00004552 IdentID ID = IdentifierIDs[II];
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00004553 // Only store offsets new to this AST file. Other identifier names are looked
Sebastian Redlff4a2952010-07-23 23:49:55 +00004554 // up earlier in the chain and thus don't need an offset.
4555 if (ID >= FirstIdentID)
4556 IdentifierOffsets[ID - FirstIdentID] = Offset;
Douglas Gregore84a9da2009-04-20 20:36:09 +00004557}
4558
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00004559/// Note that the selector Sel occurs at the given offset
Douglas Gregor95c13f52009-04-25 17:48:32 +00004560/// within the method pool/selector table.
Sebastian Redl55c0ad52010-08-18 23:56:21 +00004561void ASTWriter::SetSelectorOffset(Selector Sel, uint32_t Offset) {
Douglas Gregor95c13f52009-04-25 17:48:32 +00004562 unsigned ID = SelectorIDs[Sel];
4563 assert(ID && "Unknown selector");
Sebastian Redld95a56e2010-08-04 18:21:41 +00004564 // Don't record offsets for selectors that are also available in a different
4565 // file.
4566 if (ID < FirstSelectorID)
4567 return;
4568 SelectorOffsets[ID - FirstSelectorID] = Offset;
Douglas Gregor95c13f52009-04-25 17:48:32 +00004569}
4570
David Blaikie61137e12017-01-05 18:23:18 +00004571ASTWriter::ASTWriter(llvm::BitstreamWriter &Stream,
Duncan P. N. Exon Smith030d7d62017-03-20 17:58:26 +00004572 SmallVectorImpl<char> &Buffer, MemoryBufferCache &PCMCache,
David Blaikie61137e12017-01-05 18:23:18 +00004573 ArrayRef<std::shared_ptr<ModuleFileExtension>> Extensions,
4574 bool IncludeTimestamps)
Duncan P. N. Exon Smith030d7d62017-03-20 17:58:26 +00004575 : Stream(Stream), Buffer(Buffer), PCMCache(PCMCache),
4576 IncludeTimestamps(IncludeTimestamps) {
Douglas Gregor6623e1f2015-11-03 18:33:07 +00004577 for (const auto &Ext : Extensions) {
4578 if (auto Writer = Ext->createExtensionWriter(*this))
4579 ModuleFileExtensionWriters.push_back(std::move(Writer));
4580 }
4581}
Douglas Gregoref84c4b2009-04-09 22:27:44 +00004582
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00004583ASTWriter::~ASTWriter() {
Reid Kleckner588c9372014-02-19 23:44:52 +00004584 llvm::DeleteContainerSeconds(FileDeclIDs);
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00004585}
4586
Richard Smithb3761912015-02-05 23:08:52 +00004587const LangOptions &ASTWriter::getLangOpts() const {
4588 assert(WritingAST && "can't determine lang opts when not writing AST");
4589 return Context->getLangOpts();
4590}
4591
Richard Smithe75ee0f2015-08-17 07:13:32 +00004592time_t ASTWriter::getTimestampForOutput(const FileEntry *E) const {
4593 return IncludeTimestamps ? E->getModificationTime() : 0;
4594}
4595
Duncan P. N. Exon Smith60fa2882017-03-13 18:45:08 +00004596ASTFileSignature ASTWriter::WriteAST(Sema &SemaRef,
4597 const std::string &OutputFile,
4598 Module *WritingModule, StringRef isysroot,
4599 bool hasErrors) {
Douglas Gregor2fd3d402011-09-17 00:05:03 +00004600 WritingAST = true;
Adrian Prantladbd2b12015-09-22 23:26:31 +00004601
Argyrios Kyrtzidis4a280ff2012-03-07 01:51:17 +00004602 ASTHasCompilerErrors = hasErrors;
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00004603
Douglas Gregoref84c4b2009-04-09 22:27:44 +00004604 // Emit the file header.
Douglas Gregor8f45df52009-04-16 22:23:12 +00004605 Stream.Emit((unsigned)'C', 8);
4606 Stream.Emit((unsigned)'P', 8);
4607 Stream.Emit((unsigned)'C', 8);
4608 Stream.Emit((unsigned)'H', 8);
Mike Stump11289f42009-09-09 15:08:12 +00004609
Chris Lattner28fa4e62009-04-26 22:26:21 +00004610 WriteBlockInfoBlock();
Douglas Gregoref84c4b2009-04-09 22:27:44 +00004611
Douglas Gregoreda8e122011-08-09 15:13:55 +00004612 Context = &SemaRef.Context;
Douglas Gregora28bcdd2011-12-01 02:07:58 +00004613 PP = &SemaRef.PP;
Douglas Gregora89c5ac2011-12-06 01:10:29 +00004614 this->WritingModule = WritingModule;
Adrian Prantladbd2b12015-09-22 23:26:31 +00004615 ASTFileSignature Signature =
4616 WriteASTCore(SemaRef, isysroot, OutputFile, WritingModule);
Craig Toppera13603a2014-05-22 05:54:18 +00004617 Context = nullptr;
4618 PP = nullptr;
4619 this->WritingModule = nullptr;
Richard Smith7ed1bc92014-12-05 22:42:13 +00004620 this->BaseDirectory.clear();
Craig Toppera13603a2014-05-22 05:54:18 +00004621
Douglas Gregor2fd3d402011-09-17 00:05:03 +00004622 WritingAST = false;
Duncan P. N. Exon Smith030d7d62017-03-20 17:58:26 +00004623 if (SemaRef.Context.getLangOpts().ImplicitModules && WritingModule) {
4624 // Construct MemoryBuffer and update buffer manager.
4625 PCMCache.addBuffer(OutputFile,
4626 llvm::MemoryBuffer::getMemBufferCopy(
4627 StringRef(Buffer.begin(), Buffer.size())));
4628 }
Adrian Prantladbd2b12015-09-22 23:26:31 +00004629 return Signature;
Sebastian Redl143413f2010-07-12 22:02:52 +00004630}
4631
Douglas Gregora94a1542011-07-27 21:45:57 +00004632template<typename Vector>
4633static void AddLazyVectorDecls(ASTWriter &Writer, Vector &Vec,
4634 ASTWriter::RecordData &Record) {
Craig Toppera13603a2014-05-22 05:54:18 +00004635 for (typename Vector::iterator I = Vec.begin(nullptr, true), E = Vec.end();
4636 I != E; ++I) {
Douglas Gregora94a1542011-07-27 21:45:57 +00004637 Writer.AddDeclRef(*I, Record);
4638 }
4639}
4640
Duncan P. N. Exon Smith60fa2882017-03-13 18:45:08 +00004641ASTFileSignature ASTWriter::WriteASTCore(Sema &SemaRef, StringRef isysroot,
4642 const std::string &OutputFile,
4643 Module *WritingModule) {
Sebastian Redl143413f2010-07-12 22:02:52 +00004644 using namespace llvm;
4645
Craig Toppera13603a2014-05-22 05:54:18 +00004646 bool isModule = WritingModule != nullptr;
Argyrios Kyrtzidisffb35582013-03-14 04:44:56 +00004647
Douglas Gregorcf68c582011-12-01 22:20:10 +00004648 // Make sure that the AST reader knows to finalize itself.
4649 if (Chain)
4650 Chain->finalizeForWriting();
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00004651
Sebastian Redl143413f2010-07-12 22:02:52 +00004652 ASTContext &Context = SemaRef.Context;
4653 Preprocessor &PP = SemaRef.PP;
4654
Douglas Gregordab42432011-08-12 00:15:20 +00004655 // Set up predefined declaration IDs.
Richard Smith5fc18a92015-07-12 23:43:21 +00004656 auto RegisterPredefDecl = [&] (Decl *D, PredefinedDeclIDs ID) {
4657 if (D) {
4658 assert(D->isCanonicalDecl() && "predefined decl is not canonical");
4659 DeclIDs[D] = ID;
Richard Smith5fc18a92015-07-12 23:43:21 +00004660 }
4661 };
4662 RegisterPredefDecl(Context.getTranslationUnitDecl(),
4663 PREDEF_DECL_TRANSLATION_UNIT_ID);
4664 RegisterPredefDecl(Context.ObjCIdDecl, PREDEF_DECL_OBJC_ID_ID);
4665 RegisterPredefDecl(Context.ObjCSelDecl, PREDEF_DECL_OBJC_SEL_ID);
4666 RegisterPredefDecl(Context.ObjCClassDecl, PREDEF_DECL_OBJC_CLASS_ID);
4667 RegisterPredefDecl(Context.ObjCProtocolClassDecl,
4668 PREDEF_DECL_OBJC_PROTOCOL_ID);
4669 RegisterPredefDecl(Context.Int128Decl, PREDEF_DECL_INT_128_ID);
4670 RegisterPredefDecl(Context.UInt128Decl, PREDEF_DECL_UNSIGNED_INT_128_ID);
4671 RegisterPredefDecl(Context.ObjCInstanceTypeDecl,
4672 PREDEF_DECL_OBJC_INSTANCETYPE_ID);
4673 RegisterPredefDecl(Context.BuiltinVaListDecl, PREDEF_DECL_BUILTIN_VA_LIST_ID);
Richard Smith9b88a4c2015-07-27 05:40:23 +00004674 RegisterPredefDecl(Context.VaListTagDecl, PREDEF_DECL_VA_LIST_TAG);
Charles Davisc7d5c942015-09-17 20:55:33 +00004675 RegisterPredefDecl(Context.BuiltinMSVaListDecl,
4676 PREDEF_DECL_BUILTIN_MS_VA_LIST_ID);
Richard Smith5fc18a92015-07-12 23:43:21 +00004677 RegisterPredefDecl(Context.ExternCContext, PREDEF_DECL_EXTERN_C_CONTEXT_ID);
David Majnemerd9b1a4f2015-11-04 03:40:30 +00004678 RegisterPredefDecl(Context.MakeIntegerSeqDecl,
4679 PREDEF_DECL_MAKE_INTEGER_SEQ_ID);
Quentin Colombet043406b2016-02-03 22:41:00 +00004680 RegisterPredefDecl(Context.CFConstantStringTypeDecl,
4681 PREDEF_DECL_CF_CONSTANT_STRING_ID);
Ben Langmuirf5416742016-02-04 00:55:24 +00004682 RegisterPredefDecl(Context.CFConstantStringTagDecl,
4683 PREDEF_DECL_CF_CONSTANT_STRING_TAG_ID);
Eric Fiselier6ad68552016-07-01 01:24:09 +00004684 RegisterPredefDecl(Context.TypePackElementDecl,
4685 PREDEF_DECL_TYPE_PACK_ELEMENT_ID);
Meador Inge5d3fb222012-06-16 03:34:49 +00004686
Chris Lattner0c797362009-09-08 18:19:27 +00004687 // Build a record containing all of the tentative definitions in this file, in
Sebastian Redl35351a92010-01-31 22:27:38 +00004688 // TentativeDefinitions order. Generally, this record will be empty for
Chris Lattner0c797362009-09-08 18:19:27 +00004689 // headers.
Douglas Gregord4df8652009-04-22 22:02:47 +00004690 RecordData TentativeDefinitions;
Douglas Gregora94a1542011-07-27 21:45:57 +00004691 AddLazyVectorDecls(*this, SemaRef.TentativeDefinitions, TentativeDefinitions);
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00004692
Argyrios Kyrtzidis35672e72010-08-13 18:42:17 +00004693 // Build a record containing all of the file scoped decls in this file.
4694 RecordData UnusedFileScopedDecls;
Argyrios Kyrtzidis59852362013-03-14 04:45:00 +00004695 if (!isModule)
4696 AddLazyVectorDecls(*this, SemaRef.UnusedFileScopedDecls,
4697 UnusedFileScopedDecls);
Sebastian Redl08aca90252010-08-05 18:21:25 +00004698
Douglas Gregor851443c2011-08-12 01:39:19 +00004699 // Build a record containing all of the delegating constructors we still need
4700 // to resolve.
Alexis Hunt27a761d2011-05-04 23:29:54 +00004701 RecordData DelegatingCtorDecls;
Argyrios Kyrtzidisffb35582013-03-14 04:44:56 +00004702 if (!isModule)
4703 AddLazyVectorDecls(*this, SemaRef.DelegatingCtorDecls, DelegatingCtorDecls);
Alexis Hunt27a761d2011-05-04 23:29:54 +00004704
Douglas Gregor851443c2011-08-12 01:39:19 +00004705 // Write the set of weak, undeclared identifiers. We always write the
4706 // entire table, since later PCH files in a PCH chain are only interested in
4707 // the results at the end of the chain.
Argyrios Kyrtzidisee1afa32010-08-05 09:48:08 +00004708 RecordData WeakUndeclaredIdentifiers;
Chandler Carruthf85d9822015-03-26 08:32:49 +00004709 for (auto &WeakUndeclaredIdentifier : SemaRef.WeakUndeclaredIdentifiers) {
4710 IdentifierInfo *II = WeakUndeclaredIdentifier.first;
4711 WeakInfo &WI = WeakUndeclaredIdentifier.second;
4712 AddIdentifierRef(II, WeakUndeclaredIdentifiers);
4713 AddIdentifierRef(WI.getAlias(), WeakUndeclaredIdentifiers);
4714 AddSourceLocation(WI.getLocation(), WeakUndeclaredIdentifiers);
4715 WeakUndeclaredIdentifiers.push_back(WI.getUsed());
Argyrios Kyrtzidisee1afa32010-08-05 09:48:08 +00004716 }
Kovarththanan Rajaratnama9c81a82010-03-14 07:06:50 +00004717
Douglas Gregor61cac2b2009-04-27 20:06:05 +00004718 // Build a record containing all of the ext_vector declarations.
4719 RecordData ExtVectorDecls;
Douglas Gregorb7098a32011-07-28 00:39:29 +00004720 AddLazyVectorDecls(*this, SemaRef.ExtVectorDecls, ExtVectorDecls);
Douglas Gregor61cac2b2009-04-27 20:06:05 +00004721
Argyrios Kyrtzidisaf2eac22010-07-06 15:37:04 +00004722 // Build a record containing all of the VTable uses information.
4723 RecordData VTableUses;
Argyrios Kyrtzidisedee67f2010-08-03 17:29:52 +00004724 if (!SemaRef.VTableUses.empty()) {
Argyrios Kyrtzidisedee67f2010-08-03 17:29:52 +00004725 for (unsigned I = 0, N = SemaRef.VTableUses.size(); I != N; ++I) {
4726 AddDeclRef(SemaRef.VTableUses[I].first, VTableUses);
4727 AddSourceLocation(SemaRef.VTableUses[I].second, VTableUses);
4728 VTableUses.push_back(SemaRef.VTablesUsed[SemaRef.VTableUses[I].first]);
4729 }
Argyrios Kyrtzidisaf2eac22010-07-06 15:37:04 +00004730 }
4731
Nico Weber72889432014-09-06 01:25:55 +00004732 // Build a record containing all of the UnusedLocalTypedefNameCandidates.
4733 RecordData UnusedLocalTypedefNameCandidates;
4734 for (const TypedefNameDecl *TD : SemaRef.UnusedLocalTypedefNameCandidates)
4735 AddDeclRef(TD, UnusedLocalTypedefNameCandidates);
4736
Argyrios Kyrtzidis7f76d112010-08-05 09:48:16 +00004737 // Build a record containing all of pending implicit instantiations.
Chandler Carruth54080172010-08-25 08:44:16 +00004738 RecordData PendingInstantiations;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00004739 for (const auto &I : SemaRef.PendingInstantiations) {
4740 AddDeclRef(I.first, PendingInstantiations);
4741 AddSourceLocation(I.second, PendingInstantiations);
Argyrios Kyrtzidis7f76d112010-08-05 09:48:16 +00004742 }
4743 assert(SemaRef.PendingLocalImplicitInstantiations.empty() &&
4744 "There are local ones at end of translation unit!");
4745
Argyrios Kyrtzidis2d688102010-08-02 07:14:54 +00004746 // Build a record containing some declaration references.
4747 RecordData SemaDeclRefs;
Richard Smith96269c52016-09-29 22:49:46 +00004748 if (SemaRef.StdNamespace || SemaRef.StdBadAlloc || SemaRef.StdAlignValT) {
Argyrios Kyrtzidis2d688102010-08-02 07:14:54 +00004749 AddDeclRef(SemaRef.getStdNamespace(), SemaDeclRefs);
4750 AddDeclRef(SemaRef.getStdBadAlloc(), SemaDeclRefs);
Richard Smith96269c52016-09-29 22:49:46 +00004751 AddDeclRef(SemaRef.getStdAlignValT(), SemaDeclRefs);
Argyrios Kyrtzidis2d688102010-08-02 07:14:54 +00004752 }
4753
Peter Collingbourne9e2c81f2011-02-09 21:04:32 +00004754 RecordData CUDASpecialDeclRefs;
4755 if (Context.getcudaConfigureCallDecl()) {
4756 AddDeclRef(Context.getcudaConfigureCallDecl(), CUDASpecialDeclRefs);
4757 }
4758
Douglas Gregorc2fa1692011-06-28 16:20:02 +00004759 // Build a record containing all of the known namespaces.
4760 RecordData KnownNamespaces;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00004761 for (const auto &I : SemaRef.KnownNamespaces) {
4762 if (!I.second)
4763 AddDeclRef(I.first, KnownNamespaces);
Douglas Gregorc2fa1692011-06-28 16:20:02 +00004764 }
Douglas Gregor112b9072012-10-18 05:31:06 +00004765
Nick Lewycky9c7eb1d2013-02-01 08:13:20 +00004766 // Build a record of all used, undefined objects that require definitions.
4767 RecordData UndefinedButUsed;
Nick Lewyckyf0f56162013-01-31 03:23:57 +00004768
4769 SmallVector<std::pair<NamedDecl *, SourceLocation>, 16> Undefined;
Nick Lewycky9c7eb1d2013-02-01 08:13:20 +00004770 SemaRef.getUndefinedButUsed(Undefined);
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00004771 for (const auto &I : Undefined) {
4772 AddDeclRef(I.first, UndefinedButUsed);
4773 AddSourceLocation(I.second, UndefinedButUsed);
Nick Lewycky8334af82013-01-26 00:35:08 +00004774 }
4775
Ismail Pazarbasie5768d12015-05-18 19:59:11 +00004776 // Build a record containing all delete-expressions that we would like to
4777 // analyze later in AST.
4778 RecordData DeleteExprsToAnalyze;
4779
Richard Smithf5262c62018-06-28 01:57:04 +00004780 if (!isModule) {
4781 for (const auto &DeleteExprsInfo :
4782 SemaRef.getMismatchingDeleteExpressions()) {
4783 AddDeclRef(DeleteExprsInfo.first, DeleteExprsToAnalyze);
4784 DeleteExprsToAnalyze.push_back(DeleteExprsInfo.second.size());
4785 for (const auto &DeleteLoc : DeleteExprsInfo.second) {
4786 AddSourceLocation(DeleteLoc.first, DeleteExprsToAnalyze);
4787 DeleteExprsToAnalyze.push_back(DeleteLoc.second);
4788 }
Ismail Pazarbasie5768d12015-05-18 19:59:11 +00004789 }
4790 }
4791
Douglas Gregor112b9072012-10-18 05:31:06 +00004792 // Write the control block
Duncan P. N. Exon Smith60fa2882017-03-13 18:45:08 +00004793 WriteControlBlock(PP, Context, isysroot, OutputFile);
Douglas Gregor112b9072012-10-18 05:31:06 +00004794
Sebastian Redl42a0f6a2010-08-18 23:56:27 +00004795 // Write the remaining AST contents.
Sebastian Redl539c5062010-08-18 23:57:32 +00004796 Stream.EnterSubblock(AST_BLOCK_ID, 5);
Douglas Gregor851443c2011-08-12 01:39:19 +00004797
Argyrios Kyrtzidis39605402012-12-13 21:38:23 +00004798 // This is so that older clang versions, before the introduction
4799 // of the control block, can read and reject the newer PCH format.
Mehdi Amini57a41912015-09-10 01:46:39 +00004800 {
4801 RecordData Record = {VERSION_MAJOR};
4802 Stream.EmitRecord(METADATA_OLD_FORMAT, Record);
4803 }
Argyrios Kyrtzidis39605402012-12-13 21:38:23 +00004804
Douglas Gregor851443c2011-08-12 01:39:19 +00004805 // Create a lexical update block containing all of the declarations in the
4806 // translation unit that do not come from other AST files.
4807 const TranslationUnitDecl *TU = Context.getTranslationUnitDecl();
Richard Smith82f8fcd2015-08-06 22:07:25 +00004808 SmallVector<uint32_t, 128> NewGlobalKindDeclPairs;
4809 for (const auto *D : TU->noload_decls()) {
4810 if (!D->isFromASTFile()) {
4811 NewGlobalKindDeclPairs.push_back(D->getKind());
4812 NewGlobalKindDeclPairs.push_back(GetDeclRef(D));
4813 }
Douglas Gregor851443c2011-08-12 01:39:19 +00004814 }
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00004815
David Blaikieb44f0bf2017-01-04 22:36:43 +00004816 auto Abv = std::make_shared<BitCodeAbbrev>();
Douglas Gregor851443c2011-08-12 01:39:19 +00004817 Abv->Add(llvm::BitCodeAbbrevOp(TU_UPDATE_LEXICAL));
4818 Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::Blob));
David Blaikieb44f0bf2017-01-04 22:36:43 +00004819 unsigned TuUpdateLexicalAbbrev = Stream.EmitAbbrev(std::move(Abv));
Mehdi Amini57a41912015-09-10 01:46:39 +00004820 {
4821 RecordData::value_type Record[] = {TU_UPDATE_LEXICAL};
4822 Stream.EmitRecordWithBlob(TuUpdateLexicalAbbrev, Record,
4823 bytes(NewGlobalKindDeclPairs));
4824 }
4825
Douglas Gregor851443c2011-08-12 01:39:19 +00004826 // And a visible updates block for the translation unit.
David Blaikieb44f0bf2017-01-04 22:36:43 +00004827 Abv = std::make_shared<BitCodeAbbrev>();
Douglas Gregor851443c2011-08-12 01:39:19 +00004828 Abv->Add(llvm::BitCodeAbbrevOp(UPDATE_VISIBLE));
4829 Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::VBR, 6));
Douglas Gregor851443c2011-08-12 01:39:19 +00004830 Abv->Add(llvm::BitCodeAbbrevOp(llvm::BitCodeAbbrevOp::Blob));
David Blaikieb44f0bf2017-01-04 22:36:43 +00004831 UpdateVisibleAbbrev = Stream.EmitAbbrev(std::move(Abv));
Douglas Gregor851443c2011-08-12 01:39:19 +00004832 WriteDeclContextVisibleUpdate(TU);
Richard Smithf19e1272015-03-07 00:04:49 +00004833
4834 // If we have any extern "C" names, write out a visible update for them.
4835 if (Context.ExternCContext)
4836 WriteDeclContextVisibleUpdate(Context.ExternCContext);
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00004837
Douglas Gregor851443c2011-08-12 01:39:19 +00004838 // If the translation unit has an anonymous namespace, and we don't already
4839 // have an update block for it, write it as an update block.
Richard Smith6ef42932014-03-20 21:02:00 +00004840 // FIXME: Why do we not do this if there's already an update block?
Douglas Gregor851443c2011-08-12 01:39:19 +00004841 if (NamespaceDecl *NS = TU->getAnonymousNamespace()) {
4842 ASTWriter::UpdateRecord &Record = DeclUpdates[TU];
Richard Smith6ef42932014-03-20 21:02:00 +00004843 if (Record.empty())
Aaron Ballman4f45b712014-03-21 15:22:56 +00004844 Record.push_back(DeclUpdate(UPD_CXX_ADDED_ANONYMOUS_NAMESPACE, NS));
Douglas Gregor851443c2011-08-12 01:39:19 +00004845 }
Argyrios Kyrtzidis442dd802012-07-02 19:19:01 +00004846
Richard Smith5652c0f2014-03-21 01:48:23 +00004847 // Add update records for all mangling numbers and static local numbers.
4848 // These aren't really update records, but this is a convenient way of
4849 // tagging this rare extra data onto the declarations.
4850 for (const auto &Number : Context.MangleNumbers)
4851 if (!Number.first->isFromASTFile())
Aaron Ballman4f45b712014-03-21 15:22:56 +00004852 DeclUpdates[Number.first].push_back(DeclUpdate(UPD_MANGLING_NUMBER,
4853 Number.second));
Richard Smith5652c0f2014-03-21 01:48:23 +00004854 for (const auto &Number : Context.StaticLocalNumbers)
4855 if (!Number.first->isFromASTFile())
Aaron Ballman4f45b712014-03-21 15:22:56 +00004856 DeclUpdates[Number.first].push_back(DeclUpdate(UPD_STATIC_LOCAL_NUMBER,
4857 Number.second));
Richard Smith5652c0f2014-03-21 01:48:23 +00004858
Argyrios Kyrtzidis442dd802012-07-02 19:19:01 +00004859 // Make sure visible decls, added to DeclContexts previously loaded from
Richard Smithc26d9742016-10-06 20:30:51 +00004860 // an AST file, are registered for serialization. Likewise for template
4861 // specializations added to imported templates.
4862 for (const auto *I : DeclsToEmitEvenIfUnreferenced) {
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00004863 GetDeclRef(I);
Argyrios Kyrtzidis442dd802012-07-02 19:19:01 +00004864 }
4865
Argyrios Kyrtzidisacfbbd72013-08-07 21:17:33 +00004866 // Make sure all decls associated with an identifier are registered for
Richard Smith79bf9202015-08-24 03:33:22 +00004867 // serialization, if we're storing decls with identifiers.
4868 if (!WritingModule || !getLangOpts().CPlusPlus) {
4869 llvm::SmallVector<const IdentifierInfo*, 256> IIs;
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00004870 for (const auto &ID : PP.getIdentifierTable()) {
4871 const IdentifierInfo *II = ID.second;
Richard Smith79bf9202015-08-24 03:33:22 +00004872 if (!Chain || !II->isFromAST() || II->hasChangedSinceDeserialization())
4873 IIs.push_back(II);
4874 }
4875 // Sort the identifiers to visit based on their name.
Fangrui Song55fab262018-09-26 22:16:28 +00004876 llvm::sort(IIs, llvm::less_ptr<IdentifierInfo>());
Richard Smith79bf9202015-08-24 03:33:22 +00004877 for (const IdentifierInfo *II : IIs) {
4878 for (IdentifierResolver::iterator D = SemaRef.IdResolver.begin(II),
4879 DEnd = SemaRef.IdResolver.end();
4880 D != DEnd; ++D) {
4881 GetDeclRef(*D);
4882 }
Argyrios Kyrtzidisacfbbd72013-08-07 21:17:33 +00004883 }
4884 }
4885
Manman Rena0f31a02016-04-29 19:04:05 +00004886 // For method pool in the module, if it contains an entry for a selector,
4887 // the entry should be complete, containing everything introduced by that
4888 // module and all modules it imports. It's possible that the entry is out of
4889 // date, so we need to pull in the new content here.
4890
4891 // It's possible that updateOutOfDateSelector can update SelectorIDs. To be
4892 // safe, we copy all selectors out.
4893 llvm::SmallVector<Selector, 256> AllSelectors;
4894 for (auto &SelectorAndID : SelectorIDs)
4895 AllSelectors.push_back(SelectorAndID.first);
4896 for (auto &Selector : AllSelectors)
4897 SemaRef.updateOutOfDateSelector(Selector);
4898
Douglas Gregor5204bde2011-08-02 16:26:37 +00004899 // Form the record of special types.
4900 RecordData SpecialTypes;
Douglas Gregor5204bde2011-08-02 16:26:37 +00004901 AddTypeRef(Context.getRawCFConstantStringType(), SpecialTypes);
Douglas Gregor5204bde2011-08-02 16:26:37 +00004902 AddTypeRef(Context.getFILEType(), SpecialTypes);
4903 AddTypeRef(Context.getjmp_bufType(), SpecialTypes);
4904 AddTypeRef(Context.getsigjmp_bufType(), SpecialTypes);
4905 AddTypeRef(Context.ObjCIdRedefinitionType, SpecialTypes);
4906 AddTypeRef(Context.ObjCClassRedefinitionType, SpecialTypes);
Douglas Gregor5204bde2011-08-02 16:26:37 +00004907 AddTypeRef(Context.ObjCSelRedefinitionType, SpecialTypes);
Rafael Espindola6cfa82b2011-11-13 21:51:09 +00004908 AddTypeRef(Context.getucontext_tType(), SpecialTypes);
Douglas Gregora28bcdd2011-12-01 02:07:58 +00004909
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00004910 if (Chain) {
4911 // Write the mapping information describing our module dependencies and how
4912 // each of those modules were mapped into our own offset/ID space, so that
4913 // the reader can build the appropriate mapping to its own offset/ID space.
4914 // The map consists solely of a blob with the following format:
Boris Kolpackovd30446f2017-08-31 06:26:43 +00004915 // *(module-kind:i8
4916 // module-name-len:i16 module-name:len*i8
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00004917 // source-location-offset:i32
4918 // identifier-id:i32
4919 // preprocessed-entity-id:i32
4920 // macro-definition-id:i32
Douglas Gregor253eefe2011-12-01 00:59:36 +00004921 // submodule-id:i32
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00004922 // selector-id:i32
4923 // declaration-id:i32
4924 // c++-base-specifiers-id:i32
4925 // type-id:i32)
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00004926 //
Boris Kolpackovd30446f2017-08-31 06:26:43 +00004927 // module-kind is the ModuleKind enum value. If it is MK_PrebuiltModule or
4928 // MK_ExplicitModule, then the module-name is the module name. Otherwise,
4929 // it is the module file name.
David Blaikieb44f0bf2017-01-04 22:36:43 +00004930 auto Abbrev = std::make_shared<BitCodeAbbrev>();
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00004931 Abbrev->Add(BitCodeAbbrevOp(MODULE_OFFSET_MAP));
4932 Abbrev->Add(BitCodeAbbrevOp(BitCodeAbbrevOp::Blob));
David Blaikieb44f0bf2017-01-04 22:36:43 +00004933 unsigned ModuleOffsetMapAbbrev = Stream.EmitAbbrev(std::move(Abbrev));
Dylan Noblesmith2c1dd272012-02-05 02:13:05 +00004934 SmallString<2048> Buffer;
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00004935 {
4936 llvm::raw_svector_ostream Out(Buffer);
Duncan P. N. Exon Smith96a06e02017-01-28 22:15:22 +00004937 for (ModuleFile &M : Chain->ModuleMgr) {
Justin Bognere1c147c2014-03-28 22:03:19 +00004938 using namespace llvm::support;
Eugene Zelenkob7d89102017-11-11 00:08:50 +00004939
Peter Collingbournee3f65292018-05-18 19:46:24 +00004940 endian::Writer LE(Out, little);
Boris Kolpackovd30446f2017-08-31 06:26:43 +00004941 LE.write<uint8_t>(static_cast<uint8_t>(M.Kind));
4942 StringRef Name =
4943 M.Kind == MK_PrebuiltModule || M.Kind == MK_ExplicitModule
4944 ? M.ModuleName
4945 : M.FileName;
4946 LE.write<uint16_t>(Name.size());
4947 Out.write(Name.data(), Name.size());
Ben Langmuirfe971d92014-08-16 04:54:18 +00004948
Ben Langmuir785180e2014-10-20 16:27:30 +00004949 // Note: if a base ID was uint max, it would not be possible to load
4950 // another module after it or have more than one entity inside it.
4951 uint32_t None = std::numeric_limits<uint32_t>::max();
4952
4953 auto writeBaseIDOrNone = [&](uint32_t BaseID, bool ShouldWrite) {
4954 assert(BaseID < std::numeric_limits<uint32_t>::max() && "base id too high");
4955 if (ShouldWrite)
4956 LE.write<uint32_t>(BaseID);
4957 else
4958 LE.write<uint32_t>(None);
4959 };
4960
Ben Langmuirfe971d92014-08-16 04:54:18 +00004961 // These values should be unique within a chain, since they will be read
4962 // as keys into ContinuousRangeMaps.
Duncan P. N. Exon Smith96a06e02017-01-28 22:15:22 +00004963 writeBaseIDOrNone(M.SLocEntryBaseOffset, M.LocalNumSLocEntries);
4964 writeBaseIDOrNone(M.BaseIdentifierID, M.LocalNumIdentifiers);
4965 writeBaseIDOrNone(M.BaseMacroID, M.LocalNumMacros);
4966 writeBaseIDOrNone(M.BasePreprocessedEntityID,
4967 M.NumPreprocessedEntities);
4968 writeBaseIDOrNone(M.BaseSubmoduleID, M.LocalNumSubmodules);
4969 writeBaseIDOrNone(M.BaseSelectorID, M.LocalNumSelectors);
4970 writeBaseIDOrNone(M.BaseDeclID, M.LocalNumDecls);
4971 writeBaseIDOrNone(M.BaseTypeIndex, M.LocalNumTypes);
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00004972 }
4973 }
Mehdi Amini57a41912015-09-10 01:46:39 +00004974 RecordData::value_type Record[] = {MODULE_OFFSET_MAP};
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00004975 Stream.EmitRecordWithBlob(ModuleOffsetMapAbbrev, Record,
4976 Buffer.data(), Buffer.size());
4977 }
Richard Smithb9eab6d2014-03-20 19:44:17 +00004978
Richard Smithb9eab6d2014-03-20 19:44:17 +00004979 RecordData DeclUpdatesOffsetsRecord;
4980
Richard Smith59442b42014-03-20 20:07:19 +00004981 // Keep writing types, declarations, and declaration update records
4982 // until we've emitted all of them.
Richard Smith01b2cb42014-07-26 06:37:51 +00004983 Stream.EnterSubblock(DECLTYPES_BLOCK_ID, /*bits for abbreviations*/5);
4984 WriteTypeAbbrevs();
4985 WriteDeclAbbrevs();
Richard Smith59442b42014-03-20 20:07:19 +00004986 do {
4987 WriteDeclUpdatesBlocks(DeclUpdatesOffsetsRecord);
4988 while (!DeclTypesToEmit.empty()) {
4989 DeclOrType DOT = DeclTypesToEmit.front();
4990 DeclTypesToEmit.pop();
4991 if (DOT.isType())
4992 WriteType(DOT.getType());
4993 else
4994 WriteDecl(Context, DOT.getDecl());
4995 }
4996 } while (!DeclUpdates.empty());
Richard Smithb9eab6d2014-03-20 19:44:17 +00004997 Stream.ExitBlock();
4998
Richard Smithb9eab6d2014-03-20 19:44:17 +00004999 DoneWritingDeclsAndTypes = true;
5000
5001 // These things can only be done once we've written out decls and types.
5002 WriteTypeDeclOffsets();
Richard Smith5652c0f2014-03-21 01:48:23 +00005003 if (!DeclUpdatesOffsetsRecord.empty())
5004 Stream.EmitRecord(DECL_UPDATE_OFFSETS, DeclUpdatesOffsetsRecord);
Richard Smithb9eab6d2014-03-20 19:44:17 +00005005 WriteFileDeclIDsMap();
Richard Smith7ed1bc92014-12-05 22:42:13 +00005006 WriteSourceManagerBlock(Context.getSourceManager(), PP);
Richard Smithb9eab6d2014-03-20 19:44:17 +00005007 WriteComments();
Argyrios Kyrtzidisffb35582013-03-14 04:44:56 +00005008 WritePreprocessor(PP, isModule);
Richard Smith7ed1bc92014-12-05 22:42:13 +00005009 WriteHeaderSearch(PP.getHeaderSearchInfo());
Sebastian Redla19a67f2010-08-03 21:58:15 +00005010 WriteSelectors(SemaRef);
Fariborz Jahanianc51609a2010-07-23 19:11:11 +00005011 WriteReferencedSelectorsPool(SemaRef);
Richard Smith9c254182015-07-19 21:41:12 +00005012 WriteLateParsedTemplates(SemaRef);
Argyrios Kyrtzidisffb35582013-03-14 04:44:56 +00005013 WriteIdentifierTable(PP, SemaRef.IdResolver, isModule);
Peter Collingbourne5df20e02011-02-15 19:46:30 +00005014 WriteFPPragmaOptions(SemaRef.getFPOptions());
5015 WriteOpenCLExtensions(SemaRef);
Yaxun Liu5b746652016-12-18 05:18:55 +00005016 WriteOpenCLExtensionTypes(SemaRef);
Justin Lebar67a78a62016-10-08 22:15:58 +00005017 WriteCUDAPragmas(SemaRef);
Douglas Gregor652d82a2009-04-18 05:55:16 +00005018
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00005019 // If we're emitting a module, write out the submodule information.
Douglas Gregora89c5ac2011-12-06 01:10:29 +00005020 if (WritingModule)
5021 WriteSubmodules(WritingModule);
5022
Andrew Savonichev52d674d2018-10-29 11:14:01 +00005023 // We need to have information about submodules to correctly deserialize
5024 // decls from OpenCLExtensionDecls block
5025 WriteOpenCLExtensionDecls(SemaRef);
5026
Douglas Gregor5204bde2011-08-02 16:26:37 +00005027 Stream.EmitRecord(SPECIAL_TYPES, SpecialTypes);
5028
Douglas Gregord4df8652009-04-22 22:02:47 +00005029 // Write the record containing external, unnamed definitions.
Ben Langmuir332aafe2014-01-31 01:06:56 +00005030 if (!EagerlyDeserializedDecls.empty())
5031 Stream.EmitRecord(EAGERLY_DESERIALIZED_DECLS, EagerlyDeserializedDecls);
Douglas Gregord4df8652009-04-22 22:02:47 +00005032
David Blaikief63556d2017-04-12 20:58:33 +00005033 if (!ModularCodegenDecls.empty())
David Blaikie9ffe5a32017-01-30 05:00:26 +00005034 Stream.EmitRecord(MODULAR_CODEGEN_DECLS, ModularCodegenDecls);
5035
Douglas Gregord4df8652009-04-22 22:02:47 +00005036 // Write the record containing tentative definitions.
5037 if (!TentativeDefinitions.empty())
Sebastian Redl539c5062010-08-18 23:57:32 +00005038 Stream.EmitRecord(TENTATIVE_DEFINITIONS, TentativeDefinitions);
Douglas Gregoracfc76c2009-04-22 22:18:58 +00005039
Argyrios Kyrtzidis35672e72010-08-13 18:42:17 +00005040 // Write the record containing unused file scoped decls.
5041 if (!UnusedFileScopedDecls.empty())
Sebastian Redl539c5062010-08-18 23:57:32 +00005042 Stream.EmitRecord(UNUSED_FILESCOPED_DECLS, UnusedFileScopedDecls);
Kovarththanan Rajaratnama9c81a82010-03-14 07:06:50 +00005043
Argyrios Kyrtzidisee1afa32010-08-05 09:48:08 +00005044 // Write the record containing weak undeclared identifiers.
5045 if (!WeakUndeclaredIdentifiers.empty())
Sebastian Redl539c5062010-08-18 23:57:32 +00005046 Stream.EmitRecord(WEAK_UNDECLARED_IDENTIFIERS,
Argyrios Kyrtzidisee1afa32010-08-05 09:48:08 +00005047 WeakUndeclaredIdentifiers);
5048
Douglas Gregor61cac2b2009-04-27 20:06:05 +00005049 // Write the record containing ext_vector type names.
5050 if (!ExtVectorDecls.empty())
Sebastian Redl539c5062010-08-18 23:57:32 +00005051 Stream.EmitRecord(EXT_VECTOR_DECLS, ExtVectorDecls);
Mike Stump11289f42009-09-09 15:08:12 +00005052
Argyrios Kyrtzidisaf2eac22010-07-06 15:37:04 +00005053 // Write the record containing VTable uses information.
5054 if (!VTableUses.empty())
Sebastian Redl539c5062010-08-18 23:57:32 +00005055 Stream.EmitRecord(VTABLE_USES, VTableUses);
Argyrios Kyrtzidisaf2eac22010-07-06 15:37:04 +00005056
Nico Weber72889432014-09-06 01:25:55 +00005057 // Write the record containing potentially unused local typedefs.
5058 if (!UnusedLocalTypedefNameCandidates.empty())
5059 Stream.EmitRecord(UNUSED_LOCAL_TYPEDEF_NAME_CANDIDATES,
5060 UnusedLocalTypedefNameCandidates);
5061
Argyrios Kyrtzidis7f76d112010-08-05 09:48:16 +00005062 // Write the record containing pending implicit instantiations.
Chandler Carruth54080172010-08-25 08:44:16 +00005063 if (!PendingInstantiations.empty())
5064 Stream.EmitRecord(PENDING_IMPLICIT_INSTANTIATIONS, PendingInstantiations);
Argyrios Kyrtzidis7f76d112010-08-05 09:48:16 +00005065
Argyrios Kyrtzidis2d688102010-08-02 07:14:54 +00005066 // Write the record containing declaration references of Sema.
5067 if (!SemaDeclRefs.empty())
Sebastian Redl539c5062010-08-18 23:57:32 +00005068 Stream.EmitRecord(SEMA_DECL_REFS, SemaDeclRefs);
Argyrios Kyrtzidis2d688102010-08-02 07:14:54 +00005069
Peter Collingbourne9e2c81f2011-02-09 21:04:32 +00005070 // Write the record containing CUDA-specific declaration references.
5071 if (!CUDASpecialDeclRefs.empty())
5072 Stream.EmitRecord(CUDA_SPECIAL_DECL_REFS, CUDASpecialDeclRefs);
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00005073
Alexis Hunt27a761d2011-05-04 23:29:54 +00005074 // Write the delegating constructors.
5075 if (!DelegatingCtorDecls.empty())
5076 Stream.EmitRecord(DELEGATING_CTORS, DelegatingCtorDecls);
Peter Collingbourne9e2c81f2011-02-09 21:04:32 +00005077
Douglas Gregorc2fa1692011-06-28 16:20:02 +00005078 // Write the known namespaces.
5079 if (!KnownNamespaces.empty())
5080 Stream.EmitRecord(KNOWN_NAMESPACES, KnownNamespaces);
Nick Lewycky8334af82013-01-26 00:35:08 +00005081
Nick Lewycky9c7eb1d2013-02-01 08:13:20 +00005082 // Write the undefined internal functions and variables, and inline functions.
5083 if (!UndefinedButUsed.empty())
5084 Stream.EmitRecord(UNDEFINED_BUT_USED, UndefinedButUsed);
Ismail Pazarbasie5768d12015-05-18 19:59:11 +00005085
5086 if (!DeleteExprsToAnalyze.empty())
5087 Stream.EmitRecord(DELETE_EXPRS_TO_ANALYZE, DeleteExprsToAnalyze);
5088
Douglas Gregor851443c2011-08-12 01:39:19 +00005089 // Write the visible updates to DeclContexts.
Richard Smithcd45dbc2014-04-19 03:48:30 +00005090 for (auto *DC : UpdatedDeclContexts)
5091 WriteDeclContextVisibleUpdate(DC);
Douglas Gregor851443c2011-08-12 01:39:19 +00005092
Douglas Gregor959bb062011-12-03 01:15:29 +00005093 if (!WritingModule) {
5094 // Write the submodules that were imported, if any.
Aaron Ballman4f45b712014-03-21 15:22:56 +00005095 struct ModuleInfo {
5096 uint64_t ID;
5097 Module *M;
5098 ModuleInfo(uint64_t ID, Module *M) : ID(ID), M(M) {}
5099 };
Richard Smith56be7542014-03-21 00:33:59 +00005100 llvm::SmallVector<ModuleInfo, 64> Imports;
Aaron Ballmanbbc31212014-03-14 20:59:21 +00005101 for (const auto *I : Context.local_imports()) {
Douglas Gregor959bb062011-12-03 01:15:29 +00005102 assert(SubmoduleIDs.find(I->getImportedModule()) != SubmoduleIDs.end());
Aaron Ballman4f45b712014-03-21 15:22:56 +00005103 Imports.push_back(ModuleInfo(SubmoduleIDs[I->getImportedModule()],
5104 I->getImportedModule()));
Douglas Gregor959bb062011-12-03 01:15:29 +00005105 }
Richard Smith56be7542014-03-21 00:33:59 +00005106
5107 if (!Imports.empty()) {
5108 auto Cmp = [](const ModuleInfo &A, const ModuleInfo &B) {
5109 return A.ID < B.ID;
5110 };
Ben Langmuir5f95c8f2014-09-08 20:36:26 +00005111 auto Eq = [](const ModuleInfo &A, const ModuleInfo &B) {
5112 return A.ID == B.ID;
5113 };
Richard Smith56be7542014-03-21 00:33:59 +00005114
5115 // Sort and deduplicate module IDs.
Fangrui Song55fab262018-09-26 22:16:28 +00005116 llvm::sort(Imports, Cmp);
Ben Langmuir5f95c8f2014-09-08 20:36:26 +00005117 Imports.erase(std::unique(Imports.begin(), Imports.end(), Eq),
Richard Smith56be7542014-03-21 00:33:59 +00005118 Imports.end());
5119
5120 RecordData ImportedModules;
5121 for (const auto &Import : Imports) {
5122 ImportedModules.push_back(Import.ID);
5123 // FIXME: If the module has macros imported then later has declarations
5124 // imported, this location won't be the right one as a location for the
5125 // declaration imports.
Richard Smith10434f32015-05-02 02:08:26 +00005126 AddSourceLocation(PP.getModuleImportLoc(Import.M), ImportedModules);
Richard Smith56be7542014-03-21 00:33:59 +00005127 }
5128
Douglas Gregor959bb062011-12-03 01:15:29 +00005129 Stream.EmitRecord(IMPORTED_MODULES, ImportedModules);
5130 }
Douglas Gregor0a839132011-12-03 00:59:55 +00005131 }
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00005132
Douglas Gregor404cdde2012-01-27 01:47:08 +00005133 WriteObjCCategories();
Nico Weber779355f2016-03-02 23:22:00 +00005134 if(!WritingModule) {
Dario Domizioli13a0a382014-05-23 12:13:25 +00005135 WriteOptimizePragmaOptions(SemaRef);
Nico Weber779355f2016-03-02 23:22:00 +00005136 WriteMSStructPragmaOptions(SemaRef);
Nico Weber42932312016-03-03 00:17:35 +00005137 WriteMSPointersToMembersPragmaOptions(SemaRef);
Nico Weber779355f2016-03-02 23:22:00 +00005138 }
Alex Lorenz7d7e1e02017-03-31 15:36:21 +00005139 WritePackPragmaOptions(SemaRef);
Richard Smithe40f2ba2013-08-07 21:41:30 +00005140
Douglas Gregor08f01292009-04-17 22:13:46 +00005141 // Some simple statistics
Mehdi Amini57a41912015-09-10 01:46:39 +00005142 RecordData::value_type Record[] = {
5143 NumStatements, NumMacros, NumLexicalDeclContexts, NumVisibleDeclContexts};
Sebastian Redl539c5062010-08-18 23:57:32 +00005144 Stream.EmitRecord(STATISTICS, Record);
Douglas Gregor8f45df52009-04-16 22:23:12 +00005145 Stream.ExitBlock();
Adrian Prantladbd2b12015-09-22 23:26:31 +00005146
Douglas Gregor6623e1f2015-11-03 18:33:07 +00005147 // Write the module file extension blocks.
5148 for (const auto &ExtWriter : ModuleFileExtensionWriters)
Douglas Gregor8f64ca12015-12-08 22:43:32 +00005149 WriteModuleFileExtension(SemaRef, *ExtWriter);
Douglas Gregor6623e1f2015-11-03 18:33:07 +00005150
Duncan P. N. Exon Smith60fa2882017-03-13 18:45:08 +00005151 return writeUnhashedControlBlock(PP, Context);
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005152}
5153
Richard Smithb9eab6d2014-03-20 19:44:17 +00005154void ASTWriter::WriteDeclUpdatesBlocks(RecordDataImpl &OffsetsRecord) {
Argyrios Kyrtzidis65ad5692010-10-24 17:26:36 +00005155 if (DeclUpdates.empty())
5156 return;
5157
Richard Smith59442b42014-03-20 20:07:19 +00005158 DeclUpdateMap LocalUpdates;
5159 LocalUpdates.swap(DeclUpdates);
5160
Richard Smith6ef42932014-03-20 21:02:00 +00005161 for (auto &DeclUpdate : LocalUpdates) {
5162 const Decl *D = DeclUpdate.first;
Argyrios Kyrtzidis3ba70b82010-10-24 17:26:46 +00005163
Richard Smithd28ac5b2014-03-22 23:33:22 +00005164 bool HasUpdatedBody = false;
Richard Smith69c82bf2016-04-01 22:52:03 +00005165 RecordData RecordData;
5166 ASTRecordWriter Record(*this, RecordData);
Richard Smith6ef42932014-03-20 21:02:00 +00005167 for (auto &Update : DeclUpdate.second) {
5168 DeclUpdateKind Kind = (DeclUpdateKind)Update.getKind();
5169
Richard Smith69c82bf2016-04-01 22:52:03 +00005170 // An updated body is emitted last, so that the reader doesn't need
5171 // to skip over the lazy body to reach statements for other records.
5172 if (Kind == UPD_CXX_ADDED_FUNCTION_DEFINITION)
5173 HasUpdatedBody = true;
5174 else
5175 Record.push_back(Kind);
5176
Richard Smith6ef42932014-03-20 21:02:00 +00005177 switch (Kind) {
5178 case UPD_CXX_ADDED_IMPLICIT_MEMBER:
5179 case UPD_CXX_ADDED_TEMPLATE_SPECIALIZATION:
5180 case UPD_CXX_ADDED_ANONYMOUS_NAMESPACE:
Richard Smithcd45dbc2014-04-19 03:48:30 +00005181 assert(Update.getDecl() && "no decl to add?");
Richard Smith6ef42932014-03-20 21:02:00 +00005182 Record.push_back(GetDeclRef(Update.getDecl()));
5183 break;
5184
Richard Smith4d235792014-08-07 18:53:08 +00005185 case UPD_CXX_ADDED_FUNCTION_DEFINITION:
Richard Smithd28ac5b2014-03-22 23:33:22 +00005186 break;
5187
Richard Smith891fc7f2017-12-05 01:31:47 +00005188 case UPD_CXX_POINT_OF_INSTANTIATION:
5189 // FIXME: Do we need to also save the template specialization kind here?
Richard Smith69c82bf2016-04-01 22:52:03 +00005190 Record.AddSourceLocation(Update.getLoc());
Richard Smith891fc7f2017-12-05 01:31:47 +00005191 break;
5192
5193 case UPD_CXX_ADDED_VAR_DEFINITION: {
5194 const VarDecl *VD = cast<VarDecl>(D);
Richard Smithf5017592017-11-02 01:06:00 +00005195 Record.push_back(VD->isInline());
5196 Record.push_back(VD->isInlineSpecified());
Richard Smith05a21352017-06-22 22:18:46 +00005197 if (VD->getInit()) {
5198 Record.push_back(!VD->isInitKnownICE() ? 1
5199 : (VD->isInitICE() ? 3 : 2));
5200 Record.AddStmt(const_cast<Expr*>(VD->getInit()));
5201 } else {
5202 Record.push_back(0);
5203 }
Richard Smith4d235792014-08-07 18:53:08 +00005204 break;
Richard Smith05a21352017-06-22 22:18:46 +00005205 }
Richard Smith4d235792014-08-07 18:53:08 +00005206
John McCall32791cc2016-01-06 22:34:54 +00005207 case UPD_CXX_INSTANTIATED_DEFAULT_ARGUMENT:
Richard Smith290d8012016-04-06 17:06:00 +00005208 Record.AddStmt(const_cast<Expr *>(
5209 cast<ParmVarDecl>(Update.getDecl())->getDefaultArg()));
John McCall32791cc2016-01-06 22:34:54 +00005210 break;
5211
Richard Smith4b054b22016-08-24 21:25:37 +00005212 case UPD_CXX_INSTANTIATED_DEFAULT_MEMBER_INITIALIZER:
5213 Record.AddStmt(
5214 cast<FieldDecl>(Update.getDecl())->getInClassInitializer());
5215 break;
5216
Richard Smithcd45dbc2014-04-19 03:48:30 +00005217 case UPD_CXX_INSTANTIATED_CLASS_DEFINITION: {
5218 auto *RD = cast<CXXRecordDecl>(D);
Chandler Carruth8a3d24d2015-03-26 04:27:10 +00005219 UpdatedDeclContexts.insert(RD->getPrimaryContext());
Akira Hatanakafcbe17c2018-03-28 21:13:14 +00005220 Record.push_back(RD->isParamDestroyedInCallee());
Akira Hatanakae6313ac2018-04-09 22:48:22 +00005221 Record.push_back(RD->getArgPassingRestrictions());
Richard Smith69c82bf2016-04-01 22:52:03 +00005222 Record.AddCXXDefinitionData(RD);
Richard Smith72e50fe2016-04-14 00:50:18 +00005223 Record.AddOffset(WriteDeclContextLexicalBlock(
Richard Smithcd45dbc2014-04-19 03:48:30 +00005224 *Context, const_cast<CXXRecordDecl *>(RD)));
5225
5226 // This state is sometimes updated by template instantiation, when we
5227 // switch from the specialization referring to the template declaration
5228 // to it referring to the template definition.
5229 if (auto *MSInfo = RD->getMemberSpecializationInfo()) {
5230 Record.push_back(MSInfo->getTemplateSpecializationKind());
Richard Smith69c82bf2016-04-01 22:52:03 +00005231 Record.AddSourceLocation(MSInfo->getPointOfInstantiation());
Richard Smithcd45dbc2014-04-19 03:48:30 +00005232 } else {
5233 auto *Spec = cast<ClassTemplateSpecializationDecl>(RD);
5234 Record.push_back(Spec->getTemplateSpecializationKind());
Richard Smith69c82bf2016-04-01 22:52:03 +00005235 Record.AddSourceLocation(Spec->getPointOfInstantiation());
Richard Smithdf352052014-05-22 20:59:29 +00005236
5237 // The instantiation might have been resolved to a partial
5238 // specialization. If so, record which one.
5239 auto From = Spec->getInstantiatedFrom();
5240 if (auto PartialSpec =
5241 From.dyn_cast<ClassTemplatePartialSpecializationDecl*>()) {
5242 Record.push_back(true);
Richard Smith69c82bf2016-04-01 22:52:03 +00005243 Record.AddDeclRef(PartialSpec);
5244 Record.AddTemplateArgumentList(
5245 &Spec->getTemplateInstantiationArgs());
Richard Smithdf352052014-05-22 20:59:29 +00005246 } else {
5247 Record.push_back(false);
5248 }
Richard Smithcd45dbc2014-04-19 03:48:30 +00005249 }
5250 Record.push_back(RD->getTagKind());
Richard Smith69c82bf2016-04-01 22:52:03 +00005251 Record.AddSourceLocation(RD->getLocation());
Stephen Kellyf2ceec42018-08-09 21:08:08 +00005252 Record.AddSourceLocation(RD->getBeginLoc());
Argyrios Kyrtzidisd798c052016-07-15 18:11:33 +00005253 Record.AddSourceRange(RD->getBraceRange());
Richard Smithcd45dbc2014-04-19 03:48:30 +00005254
5255 // Instantiation may change attributes; write them all out afresh.
5256 Record.push_back(D->hasAttrs());
Richard Smith69c82bf2016-04-01 22:52:03 +00005257 if (D->hasAttrs())
5258 Record.AddAttributes(D->getAttrs());
Richard Smithcd45dbc2014-04-19 03:48:30 +00005259
5260 // FIXME: Ensure we don't get here for explicit instantiations.
5261 break;
5262 }
5263
Richard Smithf8134002015-03-10 01:41:22 +00005264 case UPD_CXX_RESOLVED_DTOR_DELETE:
Richard Smith69c82bf2016-04-01 22:52:03 +00005265 Record.AddDeclRef(Update.getDecl());
Richard Smith5b349582017-10-13 01:55:36 +00005266 Record.AddStmt(cast<CXXDestructorDecl>(D)->getOperatorDeleteThisArg());
Richard Smithf8134002015-03-10 01:41:22 +00005267 break;
5268
Richard Smith564417a2014-03-20 21:47:22 +00005269 case UPD_CXX_RESOLVED_EXCEPTION_SPEC:
5270 addExceptionSpec(
Richard Smith564417a2014-03-20 21:47:22 +00005271 cast<FunctionDecl>(D)->getType()->castAs<FunctionProtoType>(),
5272 Record);
5273 break;
5274
Richard Smith6ef42932014-03-20 21:02:00 +00005275 case UPD_CXX_DEDUCED_RETURN_TYPE:
5276 Record.push_back(GetOrCreateTypeID(Update.getType()));
5277 break;
5278
5279 case UPD_DECL_MARKED_USED:
5280 break;
Richard Smith5652c0f2014-03-21 01:48:23 +00005281
5282 case UPD_MANGLING_NUMBER:
5283 case UPD_STATIC_LOCAL_NUMBER:
5284 Record.push_back(Update.getNumber());
5285 break;
Richard Smith65ebb4a2015-03-26 04:09:53 +00005286
Alexey Bataev97720002014-11-11 04:05:39 +00005287 case UPD_DECL_MARKED_OPENMP_THREADPRIVATE:
Richard Smith69c82bf2016-04-01 22:52:03 +00005288 Record.AddSourceRange(
5289 D->getAttr<OMPThreadPrivateDeclAttr>()->getRange());
Alexey Bataev97720002014-11-11 04:05:39 +00005290 break;
Richard Smith65ebb4a2015-03-26 04:09:53 +00005291
Dmitry Polukhin0b0da292016-04-06 11:38:59 +00005292 case UPD_DECL_MARKED_OPENMP_DECLARETARGET:
Alexey Bataevd01b7492018-08-15 19:45:12 +00005293 Record.push_back(D->getAttr<OMPDeclareTargetDeclAttr>()->getMapType());
Dmitry Polukhin0b0da292016-04-06 11:38:59 +00005294 Record.AddSourceRange(
5295 D->getAttr<OMPDeclareTargetDeclAttr>()->getRange());
5296 break;
5297
Richard Smith65ebb4a2015-03-26 04:09:53 +00005298 case UPD_DECL_EXPORTED:
Richard Smith4caa4492015-05-15 02:34:32 +00005299 Record.push_back(getSubmoduleID(Update.getModule()));
Richard Smith65ebb4a2015-03-26 04:09:53 +00005300 break;
Alex Denisovfde64952015-06-26 05:28:36 +00005301
5302 case UPD_ADDED_ATTR_TO_RECORD:
Richard Smith69c82bf2016-04-01 22:52:03 +00005303 Record.AddAttributes(llvm::makeArrayRef(Update.getAttr()));
Alex Denisovfde64952015-06-26 05:28:36 +00005304 break;
Richard Smith6ef42932014-03-20 21:02:00 +00005305 }
5306 }
5307
Richard Smithd28ac5b2014-03-22 23:33:22 +00005308 if (HasUpdatedBody) {
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00005309 const auto *Def = cast<FunctionDecl>(D);
Richard Smith4d235792014-08-07 18:53:08 +00005310 Record.push_back(UPD_CXX_ADDED_FUNCTION_DEFINITION);
Richard Smithd28ac5b2014-03-22 23:33:22 +00005311 Record.push_back(Def->isInlined());
Richard Smith69c82bf2016-04-01 22:52:03 +00005312 Record.AddSourceLocation(Def->getInnerLocStart());
Richard Smith290d8012016-04-06 17:06:00 +00005313 Record.AddFunctionDefinition(Def);
Richard Smithd28ac5b2014-03-22 23:33:22 +00005314 }
5315
Richard Smithcd45dbc2014-04-19 03:48:30 +00005316 OffsetsRecord.push_back(GetDeclRef(D));
Richard Smith69c82bf2016-04-01 22:52:03 +00005317 OffsetsRecord.push_back(Record.Emit(DECL_UPDATES));
Argyrios Kyrtzidis65ad5692010-10-24 17:26:36 +00005318 }
Argyrios Kyrtzidis65ad5692010-10-24 17:26:36 +00005319}
5320
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00005321void ASTWriter::AddSourceLocation(SourceLocation Loc, RecordDataImpl &Record) {
Richard Smithb22a1d12016-03-27 20:13:24 +00005322 uint32_t Raw = Loc.getRawEncoding();
5323 Record.push_back((Raw << 1) | (Raw >> 31));
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005324}
5325
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00005326void ASTWriter::AddSourceRange(SourceRange Range, RecordDataImpl &Record) {
Chris Lattnerca025db2010-05-07 21:43:38 +00005327 AddSourceLocation(Range.getBegin(), Record);
5328 AddSourceLocation(Range.getEnd(), Record);
5329}
5330
Richard Smithf144b542016-04-08 21:54:32 +00005331void ASTRecordWriter::AddAPInt(const llvm::APInt &Value) {
5332 Record->push_back(Value.getBitWidth());
Benjamin Kramer25f9ea62010-09-06 23:43:28 +00005333 const uint64_t *Words = Value.getRawData();
Richard Smithf144b542016-04-08 21:54:32 +00005334 Record->append(Words, Words + Value.getNumWords());
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005335}
5336
Richard Smithf144b542016-04-08 21:54:32 +00005337void ASTRecordWriter::AddAPSInt(const llvm::APSInt &Value) {
5338 Record->push_back(Value.isUnsigned());
5339 AddAPInt(Value);
Douglas Gregor1daeb692009-04-13 18:14:40 +00005340}
5341
Richard Smithf144b542016-04-08 21:54:32 +00005342void ASTRecordWriter::AddAPFloat(const llvm::APFloat &Value) {
5343 AddAPInt(Value.bitcastToAPInt());
Douglas Gregore0a3a512009-04-14 21:55:33 +00005344}
5345
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00005346void ASTWriter::AddIdentifierRef(const IdentifierInfo *II, RecordDataImpl &Record) {
Douglas Gregor4621c6a2009-04-22 18:49:13 +00005347 Record.push_back(getIdentifierRef(II));
5348}
5349
Sebastian Redl539c5062010-08-18 23:57:32 +00005350IdentID ASTWriter::getIdentifierRef(const IdentifierInfo *II) {
Craig Toppera13603a2014-05-22 05:54:18 +00005351 if (!II)
Douglas Gregor4621c6a2009-04-22 18:49:13 +00005352 return 0;
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00005353
Sebastian Redl539c5062010-08-18 23:57:32 +00005354 IdentID &ID = IdentifierIDs[II];
Douglas Gregor3ed42cb2009-04-11 00:14:32 +00005355 if (ID == 0)
Sebastian Redlff4a2952010-07-23 23:49:55 +00005356 ID = NextIdentID++;
Douglas Gregor4621c6a2009-04-22 18:49:13 +00005357 return ID;
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005358}
5359
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00005360MacroID ASTWriter::getMacroRef(MacroInfo *MI, const IdentifierInfo *Name) {
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00005361 // Don't emit builtin macros like __LINE__ to the AST file unless they
5362 // have been redefined by the header (in which case they are not
5363 // isBuiltinMacro).
Craig Toppera13603a2014-05-22 05:54:18 +00005364 if (!MI || MI->isBuiltinMacro())
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00005365 return 0;
5366
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00005367 MacroID &ID = MacroIDs[MI];
5368 if (ID == 0) {
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00005369 ID = NextMacroID++;
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00005370 MacroInfoToEmitData Info = { Name, MI, ID };
5371 MacroInfosToEmit.push_back(Info);
5372 }
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00005373 return ID;
5374}
5375
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00005376MacroID ASTWriter::getMacroID(MacroInfo *MI) {
Craig Toppera13603a2014-05-22 05:54:18 +00005377 if (!MI || MI->isBuiltinMacro())
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00005378 return 0;
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00005379
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00005380 assert(MacroIDs.find(MI) != MacroIDs.end() && "Macro not emitted!");
5381 return MacroIDs[MI];
5382}
5383
5384uint64_t ASTWriter::getMacroDirectivesOffset(const IdentifierInfo *Name) {
Richard Smithd7329392015-04-21 21:46:32 +00005385 return IdentMacroDirectivesOffsetMap.lookup(Name);
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00005386}
5387
Richard Smithe64e7452016-04-18 21:54:58 +00005388void ASTRecordWriter::AddSelectorRef(const Selector SelRef) {
5389 Record->push_back(Writer->getSelectorRef(SelRef));
Sebastian Redl834bb972010-08-04 17:20:04 +00005390}
5391
Sebastian Redl539c5062010-08-18 23:57:32 +00005392SelectorID ASTWriter::getSelectorRef(Selector Sel) {
Craig Toppera13603a2014-05-22 05:54:18 +00005393 if (Sel.getAsOpaquePtr() == nullptr) {
Sebastian Redl834bb972010-08-04 17:20:04 +00005394 return 0;
Steve Naroff2ddea052009-04-23 10:39:46 +00005395 }
5396
Douglas Gregor8d7edce2013-02-08 21:30:59 +00005397 SelectorID SID = SelectorIDs[Sel];
Sebastian Redld95a56e2010-08-04 18:21:41 +00005398 if (SID == 0 && Chain) {
5399 // This might trigger a ReadSelector callback, which will set the ID for
5400 // this selector.
5401 Chain->LoadSelector(Sel);
Douglas Gregor8d7edce2013-02-08 21:30:59 +00005402 SID = SelectorIDs[Sel];
Sebastian Redld95a56e2010-08-04 18:21:41 +00005403 }
Steve Naroff2ddea052009-04-23 10:39:46 +00005404 if (SID == 0) {
Sebastian Redld95a56e2010-08-04 18:21:41 +00005405 SID = NextSelectorID++;
Douglas Gregor8d7edce2013-02-08 21:30:59 +00005406 SelectorIDs[Sel] = SID;
Steve Naroff2ddea052009-04-23 10:39:46 +00005407 }
Sebastian Redl834bb972010-08-04 17:20:04 +00005408 return SID;
Steve Naroff2ddea052009-04-23 10:39:46 +00005409}
5410
Richard Smithe64e7452016-04-18 21:54:58 +00005411void ASTRecordWriter::AddCXXTemporary(const CXXTemporary *Temp) {
5412 AddDeclRef(Temp->getDestructor());
Chris Lattnercba86142010-05-10 00:25:06 +00005413}
5414
Richard Smith290d8012016-04-06 17:06:00 +00005415void ASTRecordWriter::AddTemplateArgumentLocInfo(
5416 TemplateArgument::ArgKind Kind, const TemplateArgumentLocInfo &Arg) {
Argyrios Kyrtzidisae85e242010-06-22 09:54:59 +00005417 switch (Kind) {
John McCall0ad16662009-10-29 08:12:44 +00005418 case TemplateArgument::Expression:
Argyrios Kyrtzidisae85e242010-06-22 09:54:59 +00005419 AddStmt(Arg.getAsExpr());
John McCall0ad16662009-10-29 08:12:44 +00005420 break;
5421 case TemplateArgument::Type:
Richard Smith290d8012016-04-06 17:06:00 +00005422 AddTypeSourceInfo(Arg.getAsTypeSourceInfo());
John McCall0ad16662009-10-29 08:12:44 +00005423 break;
Douglas Gregor9167f8b2009-11-11 01:00:40 +00005424 case TemplateArgument::Template:
Richard Smith290d8012016-04-06 17:06:00 +00005425 AddNestedNameSpecifierLoc(Arg.getTemplateQualifierLoc());
5426 AddSourceLocation(Arg.getTemplateNameLoc());
Douglas Gregore4ff4b52011-01-05 18:58:31 +00005427 break;
5428 case TemplateArgument::TemplateExpansion:
Richard Smith290d8012016-04-06 17:06:00 +00005429 AddNestedNameSpecifierLoc(Arg.getTemplateQualifierLoc());
5430 AddSourceLocation(Arg.getTemplateNameLoc());
5431 AddSourceLocation(Arg.getTemplateEllipsisLoc());
Douglas Gregor9167f8b2009-11-11 01:00:40 +00005432 break;
John McCall0ad16662009-10-29 08:12:44 +00005433 case TemplateArgument::Null:
5434 case TemplateArgument::Integral:
5435 case TemplateArgument::Declaration:
Eli Friedmanb826a002012-09-26 02:36:12 +00005436 case TemplateArgument::NullPtr:
John McCall0ad16662009-10-29 08:12:44 +00005437 case TemplateArgument::Pack:
Eli Friedmanb826a002012-09-26 02:36:12 +00005438 // FIXME: Is this right?
John McCall0ad16662009-10-29 08:12:44 +00005439 break;
5440 }
5441}
5442
Richard Smith290d8012016-04-06 17:06:00 +00005443void ASTRecordWriter::AddTemplateArgumentLoc(const TemplateArgumentLoc &Arg) {
5444 AddTemplateArgument(Arg.getArgument());
Argyrios Kyrtzidisddf5f212010-06-28 09:31:42 +00005445
5446 if (Arg.getArgument().getKind() == TemplateArgument::Expression) {
5447 bool InfoHasSameExpr
5448 = Arg.getArgument().getAsExpr() == Arg.getLocInfo().getAsExpr();
Richard Smith290d8012016-04-06 17:06:00 +00005449 Record->push_back(InfoHasSameExpr);
Argyrios Kyrtzidisddf5f212010-06-28 09:31:42 +00005450 if (InfoHasSameExpr)
5451 return; // Avoid storing the same expr twice.
5452 }
Richard Smith290d8012016-04-06 17:06:00 +00005453 AddTemplateArgumentLocInfo(Arg.getArgument().getKind(), Arg.getLocInfo());
Argyrios Kyrtzidisae85e242010-06-22 09:54:59 +00005454}
5455
Richard Smith290d8012016-04-06 17:06:00 +00005456void ASTRecordWriter::AddTypeSourceInfo(TypeSourceInfo *TInfo) {
Craig Toppera13603a2014-05-22 05:54:18 +00005457 if (!TInfo) {
Richard Smith290d8012016-04-06 17:06:00 +00005458 AddTypeRef(QualType());
John McCall8f115c62009-10-16 21:56:05 +00005459 return;
5460 }
5461
Richard Smithc23d7342018-06-29 20:46:25 +00005462 AddTypeRef(TInfo->getType());
Richard Smith290d8012016-04-06 17:06:00 +00005463 AddTypeLoc(TInfo->getTypeLoc());
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005464}
5465
Richard Smith290d8012016-04-06 17:06:00 +00005466void ASTRecordWriter::AddTypeLoc(TypeLoc TL) {
Richard Smith290d8012016-04-06 17:06:00 +00005467 TypeLocWriter TLW(*this);
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005468 for (; !TL.isNull(); TL = TL.getNextTypeLoc())
Kovarththanan Rajaratnama9c81a82010-03-14 07:06:50 +00005469 TLW.Visit(TL);
John McCall8f115c62009-10-16 21:56:05 +00005470}
5471
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00005472void ASTWriter::AddTypeRef(QualType T, RecordDataImpl &Record) {
Argyrios Kyrtzidis9ab44ea2010-08-20 16:04:14 +00005473 Record.push_back(GetOrCreateTypeID(T));
5474}
5475
Richard Smith2095ffe2015-03-16 20:11:03 +00005476TypeID ASTWriter::GetOrCreateTypeID(QualType T) {
Richard Smith1fa5d642013-05-11 05:45:24 +00005477 assert(Context);
Richard Smith2095ffe2015-03-16 20:11:03 +00005478 return MakeTypeID(*Context, T, [&](QualType T) -> TypeIdx {
5479 if (T.isNull())
5480 return TypeIdx();
5481 assert(!T.getLocalFastQualifiers());
5482
5483 TypeIdx &Idx = TypeIdxs[T];
5484 if (Idx.getIndex() == 0) {
5485 if (DoneWritingDeclsAndTypes) {
5486 assert(0 && "New type seen after serializing all the types to emit!");
5487 return TypeIdx();
5488 }
5489
5490 // We haven't seen this type before. Assign it a new ID and put it
5491 // into the queue of types to emit.
5492 Idx = TypeIdx(NextTypeID++);
5493 DeclTypesToEmit.push(T);
5494 }
5495 return Idx;
5496 });
Argyrios Kyrtzidis082e4612010-08-20 16:04:20 +00005497}
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005498
Argyrios Kyrtzidis07347322010-08-20 16:04:27 +00005499TypeID ASTWriter::getTypeID(QualType T) const {
Richard Smith1fa5d642013-05-11 05:45:24 +00005500 assert(Context);
Richard Smith2095ffe2015-03-16 20:11:03 +00005501 return MakeTypeID(*Context, T, [&](QualType T) -> TypeIdx {
5502 if (T.isNull())
Argyrios Kyrtzidis442dd802012-07-02 19:19:01 +00005503 return TypeIdx();
Richard Smith2095ffe2015-03-16 20:11:03 +00005504 assert(!T.getLocalFastQualifiers());
Argyrios Kyrtzidis442dd802012-07-02 19:19:01 +00005505
Richard Smith2095ffe2015-03-16 20:11:03 +00005506 TypeIdxMap::const_iterator I = TypeIdxs.find(T);
5507 assert(I != TypeIdxs.end() && "Type not emitted!");
5508 return I->second;
5509 });
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005510}
5511
Argyrios Kyrtzidis65ad5692010-10-24 17:26:36 +00005512void ASTWriter::AddDeclRef(const Decl *D, RecordDataImpl &Record) {
Sebastian Redl66c5eef2010-07-27 00:17:23 +00005513 Record.push_back(GetDeclRef(D));
5514}
5515
Sebastian Redl539c5062010-08-18 23:57:32 +00005516DeclID ASTWriter::GetDeclRef(const Decl *D) {
Douglas Gregor2fd3d402011-09-17 00:05:03 +00005517 assert(WritingAST && "Cannot request a declaration ID before AST writing");
Craig Toppera13603a2014-05-22 05:54:18 +00005518
5519 if (!D) {
Sebastian Redl66c5eef2010-07-27 00:17:23 +00005520 return 0;
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005521 }
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00005522
Douglas Gregorb3163e52012-01-05 22:33:30 +00005523 // If D comes from an AST file, its declaration ID is already known and
5524 // fixed.
5525 if (D->isFromASTFile())
5526 return D->getGlobalID();
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00005527
Douglas Gregor9b3932c2010-10-05 18:37:06 +00005528 assert(!(reinterpret_cast<uintptr_t>(D) & 0x01) && "Invalid decl pointer");
Sebastian Redl539c5062010-08-18 23:57:32 +00005529 DeclID &ID = DeclIDs[D];
Mike Stump11289f42009-09-09 15:08:12 +00005530 if (ID == 0) {
Argyrios Kyrtzidis442dd802012-07-02 19:19:01 +00005531 if (DoneWritingDeclsAndTypes) {
5532 assert(0 && "New decl seen after serializing all the decls to emit!");
5533 return 0;
5534 }
5535
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005536 // We haven't seen this declaration before. Give it a new ID and
5537 // enqueue it in the list of declarations to emit.
Sebastian Redlff4a2952010-07-23 23:49:55 +00005538 ID = NextDeclID++;
Douglas Gregor12bfa382009-10-17 00:13:19 +00005539 DeclTypesToEmit.push(const_cast<Decl *>(D));
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005540 }
5541
Sebastian Redl66c5eef2010-07-27 00:17:23 +00005542 return ID;
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005543}
5544
Sebastian Redl539c5062010-08-18 23:57:32 +00005545DeclID ASTWriter::getDeclID(const Decl *D) {
Craig Toppera13603a2014-05-22 05:54:18 +00005546 if (!D)
Douglas Gregore84a9da2009-04-20 20:36:09 +00005547 return 0;
5548
Douglas Gregorb3163e52012-01-05 22:33:30 +00005549 // If D comes from an AST file, its declaration ID is already known and
5550 // fixed.
5551 if (D->isFromASTFile())
5552 return D->getGlobalID();
5553
Douglas Gregore84a9da2009-04-20 20:36:09 +00005554 assert(DeclIDs.find(D) != DeclIDs.end() && "Declaration not emitted!");
5555 return DeclIDs[D];
5556}
5557
Argyrios Kyrtzidisdf53da82011-10-28 23:57:43 +00005558void ASTWriter::associateDeclWithFile(const Decl *D, DeclID ID) {
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005559 assert(ID);
Argyrios Kyrtzidisdf53da82011-10-28 23:57:43 +00005560 assert(D);
5561
5562 SourceLocation Loc = D->getLocation();
5563 if (Loc.isInvalid())
5564 return;
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005565
5566 // We only keep track of the file-level declarations of each file.
5567 if (!D->getLexicalDeclContext()->isFileContext())
5568 return;
Argyrios Kyrtzidise1bc99e2012-02-24 19:45:46 +00005569 // FIXME: ParmVarDecls that are part of a function type of a parameter of
5570 // a function/objc method, should not have TU as lexical context.
Argyrios Kyrtzidis71b74eb2018-01-26 19:26:12 +00005571 // TemplateTemplateParmDecls that are part of an alias template, should not
5572 // have TU as lexical context.
5573 if (isa<ParmVarDecl>(D) || isa<TemplateTemplateParmDecl>(D))
Argyrios Kyrtzidisffe055a82012-02-24 01:12:38 +00005574 return;
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005575
5576 SourceManager &SM = Context->getSourceManager();
Argyrios Kyrtzidisdf53da82011-10-28 23:57:43 +00005577 SourceLocation FileLoc = SM.getFileLoc(Loc);
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005578 assert(SM.isLocalSourceLocation(FileLoc));
Argyrios Kyrtzidis7362e9b2011-10-28 23:57:47 +00005579 FileID FID;
5580 unsigned Offset;
Benjamin Kramer867ea1d2014-03-02 13:01:17 +00005581 std::tie(FID, Offset) = SM.getDecomposedLoc(FileLoc);
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005582 if (FID.isInvalid())
5583 return;
Argyrios Kyrtzidis4db774a2012-10-02 21:09:17 +00005584 assert(SM.getSLocEntry(FID).isFile());
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005585
Argyrios Kyrtzidis4db774a2012-10-02 21:09:17 +00005586 DeclIDInFileInfo *&Info = FileDeclIDs[FID];
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005587 if (!Info)
5588 Info = new DeclIDInFileInfo();
5589
Argyrios Kyrtzidis7362e9b2011-10-28 23:57:47 +00005590 std::pair<unsigned, serialization::DeclID> LocDecl(Offset, ID);
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005591 LocDeclIDsTy &Decls = Info->DeclIDs;
5592
Argyrios Kyrtzidis7362e9b2011-10-28 23:57:47 +00005593 if (Decls.empty() || Decls.back().first <= Offset) {
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005594 Decls.push_back(LocDecl);
5595 return;
5596 }
5597
Benjamin Kramer45025c02013-08-24 13:22:59 +00005598 LocDeclIDsTy::iterator I =
5599 std::upper_bound(Decls.begin(), Decls.end(), LocDecl, llvm::less_first());
Argyrios Kyrtzidis5fc727a2011-10-28 22:54:21 +00005600
5601 Decls.insert(I, LocDecl);
5602}
5603
Richard Smithe64e7452016-04-18 21:54:58 +00005604void ASTRecordWriter::AddDeclarationName(DeclarationName Name) {
Chris Lattner258172e2009-04-27 07:35:58 +00005605 // FIXME: Emit a stable enum for NameKind. 0 = Identifier etc.
Richard Smithe64e7452016-04-18 21:54:58 +00005606 Record->push_back(Name.getNameKind());
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005607 switch (Name.getNameKind()) {
5608 case DeclarationName::Identifier:
Richard Smithe64e7452016-04-18 21:54:58 +00005609 AddIdentifierRef(Name.getAsIdentifierInfo());
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005610 break;
5611
5612 case DeclarationName::ObjCZeroArgSelector:
5613 case DeclarationName::ObjCOneArgSelector:
5614 case DeclarationName::ObjCMultiArgSelector:
Richard Smithe64e7452016-04-18 21:54:58 +00005615 AddSelectorRef(Name.getObjCSelector());
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005616 break;
5617
5618 case DeclarationName::CXXConstructorName:
5619 case DeclarationName::CXXDestructorName:
5620 case DeclarationName::CXXConversionFunctionName:
Richard Smithe64e7452016-04-18 21:54:58 +00005621 AddTypeRef(Name.getCXXNameType());
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005622 break;
5623
Richard Smith35845152017-02-07 01:37:30 +00005624 case DeclarationName::CXXDeductionGuideName:
5625 AddDeclRef(Name.getCXXDeductionGuideTemplate());
5626 break;
5627
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005628 case DeclarationName::CXXOperatorName:
Richard Smithe64e7452016-04-18 21:54:58 +00005629 Record->push_back(Name.getCXXOverloadedOperator());
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005630 break;
5631
Alexis Hunt3d221f22009-11-29 07:34:05 +00005632 case DeclarationName::CXXLiteralOperatorName:
Richard Smithe64e7452016-04-18 21:54:58 +00005633 AddIdentifierRef(Name.getCXXLiteralIdentifier());
Alexis Hunt3d221f22009-11-29 07:34:05 +00005634 break;
5635
Douglas Gregoref84c4b2009-04-09 22:27:44 +00005636 case DeclarationName::CXXUsingDirective:
5637 // No extra data to emit
5638 break;
5639 }
5640}
Chris Lattnerca025db2010-05-07 21:43:38 +00005641
Richard Smithd08aeb62014-08-28 01:33:39 +00005642unsigned ASTWriter::getAnonymousDeclarationNumber(const NamedDecl *D) {
5643 assert(needsAnonymousDeclarationNumber(D) &&
5644 "expected an anonymous declaration");
5645
5646 // Number the anonymous declarations within this context, if we've not
5647 // already done so.
5648 auto It = AnonymousDeclarationNumbers.find(D);
5649 if (It == AnonymousDeclarationNumbers.end()) {
Richard Smith2b560572015-02-07 03:11:11 +00005650 auto *DC = D->getLexicalDeclContext();
5651 numberAnonymousDeclsWithin(DC, [&](const NamedDecl *ND, unsigned Number) {
5652 AnonymousDeclarationNumbers[ND] = Number;
5653 });
Richard Smithd08aeb62014-08-28 01:33:39 +00005654
5655 It = AnonymousDeclarationNumbers.find(D);
5656 assert(It != AnonymousDeclarationNumbers.end() &&
5657 "declaration not found within its lexical context");
5658 }
5659
5660 return It->second;
5661}
5662
Richard Smith290d8012016-04-06 17:06:00 +00005663void ASTRecordWriter::AddDeclarationNameLoc(const DeclarationNameLoc &DNLoc,
5664 DeclarationName Name) {
Argyrios Kyrtzidis434383d2010-10-15 18:21:24 +00005665 switch (Name.getNameKind()) {
5666 case DeclarationName::CXXConstructorName:
5667 case DeclarationName::CXXDestructorName:
5668 case DeclarationName::CXXConversionFunctionName:
Richard Smith290d8012016-04-06 17:06:00 +00005669 AddTypeSourceInfo(DNLoc.NamedType.TInfo);
Argyrios Kyrtzidis434383d2010-10-15 18:21:24 +00005670 break;
5671
5672 case DeclarationName::CXXOperatorName:
Richard Smith290d8012016-04-06 17:06:00 +00005673 AddSourceLocation(SourceLocation::getFromRawEncoding(
5674 DNLoc.CXXOperatorName.BeginOpNameLoc));
Argyrios Kyrtzidis434383d2010-10-15 18:21:24 +00005675 AddSourceLocation(
Richard Smith290d8012016-04-06 17:06:00 +00005676 SourceLocation::getFromRawEncoding(DNLoc.CXXOperatorName.EndOpNameLoc));
Argyrios Kyrtzidis434383d2010-10-15 18:21:24 +00005677 break;
5678
5679 case DeclarationName::CXXLiteralOperatorName:
Richard Smith290d8012016-04-06 17:06:00 +00005680 AddSourceLocation(SourceLocation::getFromRawEncoding(
5681 DNLoc.CXXLiteralOperatorName.OpNameLoc));
Argyrios Kyrtzidis434383d2010-10-15 18:21:24 +00005682 break;
5683
5684 case DeclarationName::Identifier:
5685 case DeclarationName::ObjCZeroArgSelector:
5686 case DeclarationName::ObjCOneArgSelector:
5687 case DeclarationName::ObjCMultiArgSelector:
5688 case DeclarationName::CXXUsingDirective:
Richard Smith35845152017-02-07 01:37:30 +00005689 case DeclarationName::CXXDeductionGuideName:
Argyrios Kyrtzidis434383d2010-10-15 18:21:24 +00005690 break;
5691 }
5692}
5693
Richard Smith290d8012016-04-06 17:06:00 +00005694void ASTRecordWriter::AddDeclarationNameInfo(
5695 const DeclarationNameInfo &NameInfo) {
5696 AddDeclarationName(NameInfo.getName());
5697 AddSourceLocation(NameInfo.getLoc());
5698 AddDeclarationNameLoc(NameInfo.getInfo(), NameInfo.getName());
Argyrios Kyrtzidis434383d2010-10-15 18:21:24 +00005699}
5700
Richard Smith290d8012016-04-06 17:06:00 +00005701void ASTRecordWriter::AddQualifierInfo(const QualifierInfo &Info) {
5702 AddNestedNameSpecifierLoc(Info.QualifierLoc);
5703 Record->push_back(Info.NumTemplParamLists);
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +00005704 for (unsigned i = 0, e = Info.NumTemplParamLists; i != e; ++i)
Richard Smith290d8012016-04-06 17:06:00 +00005705 AddTemplateParameterList(Info.TemplParamLists[i]);
Argyrios Kyrtzidis434383d2010-10-15 18:21:24 +00005706}
5707
Richard Smithe64e7452016-04-18 21:54:58 +00005708void ASTRecordWriter::AddNestedNameSpecifier(NestedNameSpecifier *NNS) {
Chris Lattnerca025db2010-05-07 21:43:38 +00005709 // Nested name specifiers usually aren't too long. I think that 8 would
Chris Lattner57540c52011-04-15 05:22:18 +00005710 // typically accommodate the vast majority.
Chris Lattner0e62c1c2011-07-23 10:55:15 +00005711 SmallVector<NestedNameSpecifier *, 8> NestedNames;
Chris Lattnerca025db2010-05-07 21:43:38 +00005712
5713 // Push each of the NNS's onto a stack for serialization in reverse order.
5714 while (NNS) {
5715 NestedNames.push_back(NNS);
5716 NNS = NNS->getPrefix();
5717 }
5718
Richard Smithe64e7452016-04-18 21:54:58 +00005719 Record->push_back(NestedNames.size());
Chris Lattnerca025db2010-05-07 21:43:38 +00005720 while(!NestedNames.empty()) {
5721 NNS = NestedNames.pop_back_val();
5722 NestedNameSpecifier::SpecifierKind Kind = NNS->getKind();
Richard Smithe64e7452016-04-18 21:54:58 +00005723 Record->push_back(Kind);
Chris Lattnerca025db2010-05-07 21:43:38 +00005724 switch (Kind) {
5725 case NestedNameSpecifier::Identifier:
Richard Smithe64e7452016-04-18 21:54:58 +00005726 AddIdentifierRef(NNS->getAsIdentifier());
Chris Lattnerca025db2010-05-07 21:43:38 +00005727 break;
5728
5729 case NestedNameSpecifier::Namespace:
Richard Smithe64e7452016-04-18 21:54:58 +00005730 AddDeclRef(NNS->getAsNamespace());
Chris Lattnerca025db2010-05-07 21:43:38 +00005731 break;
5732
Douglas Gregor7b26ff92011-02-24 02:36:08 +00005733 case NestedNameSpecifier::NamespaceAlias:
Richard Smithe64e7452016-04-18 21:54:58 +00005734 AddDeclRef(NNS->getAsNamespaceAlias());
Douglas Gregor7b26ff92011-02-24 02:36:08 +00005735 break;
5736
Chris Lattnerca025db2010-05-07 21:43:38 +00005737 case NestedNameSpecifier::TypeSpec:
5738 case NestedNameSpecifier::TypeSpecWithTemplate:
Richard Smithe64e7452016-04-18 21:54:58 +00005739 AddTypeRef(QualType(NNS->getAsType(), 0));
5740 Record->push_back(Kind == NestedNameSpecifier::TypeSpecWithTemplate);
Chris Lattnerca025db2010-05-07 21:43:38 +00005741 break;
5742
5743 case NestedNameSpecifier::Global:
5744 // Don't need to write an associated value.
5745 break;
Nikola Smiljanic67860242014-09-26 00:28:20 +00005746
5747 case NestedNameSpecifier::Super:
Richard Smithe64e7452016-04-18 21:54:58 +00005748 AddDeclRef(NNS->getAsRecordDecl());
Nikola Smiljanic67860242014-09-26 00:28:20 +00005749 break;
Chris Lattnerca025db2010-05-07 21:43:38 +00005750 }
5751 }
5752}
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005753
Richard Smith290d8012016-04-06 17:06:00 +00005754void ASTRecordWriter::AddNestedNameSpecifierLoc(NestedNameSpecifierLoc NNS) {
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005755 // Nested name specifiers usually aren't too long. I think that 8 would
Chris Lattner57540c52011-04-15 05:22:18 +00005756 // typically accommodate the vast majority.
Chris Lattner0e62c1c2011-07-23 10:55:15 +00005757 SmallVector<NestedNameSpecifierLoc , 8> NestedNames;
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005758
5759 // Push each of the nested-name-specifiers's onto a stack for
5760 // serialization in reverse order.
5761 while (NNS) {
5762 NestedNames.push_back(NNS);
5763 NNS = NNS.getPrefix();
5764 }
5765
Richard Smith290d8012016-04-06 17:06:00 +00005766 Record->push_back(NestedNames.size());
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005767 while(!NestedNames.empty()) {
5768 NNS = NestedNames.pop_back_val();
5769 NestedNameSpecifier::SpecifierKind Kind
5770 = NNS.getNestedNameSpecifier()->getKind();
Richard Smith290d8012016-04-06 17:06:00 +00005771 Record->push_back(Kind);
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005772 switch (Kind) {
5773 case NestedNameSpecifier::Identifier:
Richard Smith290d8012016-04-06 17:06:00 +00005774 AddIdentifierRef(NNS.getNestedNameSpecifier()->getAsIdentifier());
5775 AddSourceRange(NNS.getLocalSourceRange());
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005776 break;
5777
5778 case NestedNameSpecifier::Namespace:
Richard Smith290d8012016-04-06 17:06:00 +00005779 AddDeclRef(NNS.getNestedNameSpecifier()->getAsNamespace());
5780 AddSourceRange(NNS.getLocalSourceRange());
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005781 break;
5782
5783 case NestedNameSpecifier::NamespaceAlias:
Richard Smith290d8012016-04-06 17:06:00 +00005784 AddDeclRef(NNS.getNestedNameSpecifier()->getAsNamespaceAlias());
5785 AddSourceRange(NNS.getLocalSourceRange());
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005786 break;
5787
5788 case NestedNameSpecifier::TypeSpec:
5789 case NestedNameSpecifier::TypeSpecWithTemplate:
Richard Smith290d8012016-04-06 17:06:00 +00005790 Record->push_back(Kind == NestedNameSpecifier::TypeSpecWithTemplate);
Richard Smithc23d7342018-06-29 20:46:25 +00005791 AddTypeRef(NNS.getTypeLoc().getType());
Richard Smith290d8012016-04-06 17:06:00 +00005792 AddTypeLoc(NNS.getTypeLoc());
5793 AddSourceLocation(NNS.getLocalSourceRange().getEnd());
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005794 break;
5795
5796 case NestedNameSpecifier::Global:
Richard Smith290d8012016-04-06 17:06:00 +00005797 AddSourceLocation(NNS.getLocalSourceRange().getEnd());
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005798 break;
Nikola Smiljanic67860242014-09-26 00:28:20 +00005799
5800 case NestedNameSpecifier::Super:
Richard Smith290d8012016-04-06 17:06:00 +00005801 AddDeclRef(NNS.getNestedNameSpecifier()->getAsRecordDecl());
5802 AddSourceRange(NNS.getLocalSourceRange());
Nikola Smiljanic67860242014-09-26 00:28:20 +00005803 break;
Douglas Gregora9d87bc2011-02-25 00:36:19 +00005804 }
5805 }
5806}
5807
Richard Smith290d8012016-04-06 17:06:00 +00005808void ASTRecordWriter::AddTemplateName(TemplateName Name) {
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00005809 TemplateName::NameKind Kind = Name.getKind();
Richard Smith290d8012016-04-06 17:06:00 +00005810 Record->push_back(Kind);
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005811 switch (Kind) {
5812 case TemplateName::Template:
Richard Smith290d8012016-04-06 17:06:00 +00005813 AddDeclRef(Name.getAsTemplateDecl());
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005814 break;
5815
5816 case TemplateName::OverloadedTemplate: {
5817 OverloadedTemplateStorage *OvT = Name.getAsOverloadedTemplate();
Richard Smith290d8012016-04-06 17:06:00 +00005818 Record->push_back(OvT->size());
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00005819 for (const auto &I : *OvT)
Richard Smith290d8012016-04-06 17:06:00 +00005820 AddDeclRef(I);
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005821 break;
5822 }
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00005823
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005824 case TemplateName::QualifiedTemplate: {
5825 QualifiedTemplateName *QualT = Name.getAsQualifiedTemplateName();
Richard Smith290d8012016-04-06 17:06:00 +00005826 AddNestedNameSpecifier(QualT->getQualifier());
5827 Record->push_back(QualT->hasTemplateKeyword());
5828 AddDeclRef(QualT->getTemplateDecl());
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005829 break;
5830 }
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00005831
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005832 case TemplateName::DependentTemplate: {
5833 DependentTemplateName *DepT = Name.getAsDependentTemplateName();
Richard Smith290d8012016-04-06 17:06:00 +00005834 AddNestedNameSpecifier(DepT->getQualifier());
5835 Record->push_back(DepT->isIdentifier());
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005836 if (DepT->isIdentifier())
Richard Smith290d8012016-04-06 17:06:00 +00005837 AddIdentifierRef(DepT->getIdentifier());
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005838 else
Richard Smith290d8012016-04-06 17:06:00 +00005839 Record->push_back(DepT->getOperator());
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005840 break;
5841 }
John McCalld9dfe3a2011-06-30 08:33:18 +00005842
5843 case TemplateName::SubstTemplateTemplateParm: {
5844 SubstTemplateTemplateParmStorage *subst
5845 = Name.getAsSubstTemplateTemplateParm();
Richard Smith290d8012016-04-06 17:06:00 +00005846 AddDeclRef(subst->getParameter());
5847 AddTemplateName(subst->getReplacement());
John McCalld9dfe3a2011-06-30 08:33:18 +00005848 break;
5849 }
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00005850
Douglas Gregor5590be02011-01-15 06:45:20 +00005851 case TemplateName::SubstTemplateTemplateParmPack: {
5852 SubstTemplateTemplateParmPackStorage *SubstPack
5853 = Name.getAsSubstTemplateTemplateParmPack();
Richard Smith290d8012016-04-06 17:06:00 +00005854 AddDeclRef(SubstPack->getParameterPack());
5855 AddTemplateArgument(SubstPack->getArgumentPack());
Douglas Gregor5590be02011-01-15 06:45:20 +00005856 break;
5857 }
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005858 }
5859}
5860
Richard Smith290d8012016-04-06 17:06:00 +00005861void ASTRecordWriter::AddTemplateArgument(const TemplateArgument &Arg) {
5862 Record->push_back(Arg.getKind());
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005863 switch (Arg.getKind()) {
5864 case TemplateArgument::Null:
5865 break;
5866 case TemplateArgument::Type:
Richard Smith290d8012016-04-06 17:06:00 +00005867 AddTypeRef(Arg.getAsType());
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005868 break;
5869 case TemplateArgument::Declaration:
Richard Smith290d8012016-04-06 17:06:00 +00005870 AddDeclRef(Arg.getAsDecl());
5871 AddTypeRef(Arg.getParamTypeForDecl());
Eli Friedmanb826a002012-09-26 02:36:12 +00005872 break;
5873 case TemplateArgument::NullPtr:
Richard Smith290d8012016-04-06 17:06:00 +00005874 AddTypeRef(Arg.getNullPtrType());
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005875 break;
5876 case TemplateArgument::Integral:
Richard Smith290d8012016-04-06 17:06:00 +00005877 AddAPSInt(Arg.getAsIntegral());
5878 AddTypeRef(Arg.getIntegralType());
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005879 break;
5880 case TemplateArgument::Template:
Richard Smith290d8012016-04-06 17:06:00 +00005881 AddTemplateName(Arg.getAsTemplateOrTemplatePattern());
Douglas Gregore1d60df2011-01-14 23:41:42 +00005882 break;
Douglas Gregore4ff4b52011-01-05 18:58:31 +00005883 case TemplateArgument::TemplateExpansion:
Richard Smith290d8012016-04-06 17:06:00 +00005884 AddTemplateName(Arg.getAsTemplateOrTemplatePattern());
David Blaikie05785d12013-02-20 22:23:23 +00005885 if (Optional<unsigned> NumExpansions = Arg.getNumTemplateExpansions())
Richard Smith290d8012016-04-06 17:06:00 +00005886 Record->push_back(*NumExpansions + 1);
Douglas Gregore1d60df2011-01-14 23:41:42 +00005887 else
Richard Smith290d8012016-04-06 17:06:00 +00005888 Record->push_back(0);
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005889 break;
5890 case TemplateArgument::Expression:
5891 AddStmt(Arg.getAsExpr());
5892 break;
5893 case TemplateArgument::Pack:
Richard Smith290d8012016-04-06 17:06:00 +00005894 Record->push_back(Arg.pack_size());
Aaron Ballman2a89e852014-07-15 21:32:31 +00005895 for (const auto &P : Arg.pack_elements())
Richard Smith290d8012016-04-06 17:06:00 +00005896 AddTemplateArgument(P);
Argyrios Kyrtzidis106caf922010-06-19 19:28:53 +00005897 break;
5898 }
5899}
Argyrios Kyrtzidis818c5db2010-06-23 13:48:30 +00005900
Richard Smithe64e7452016-04-18 21:54:58 +00005901void ASTRecordWriter::AddTemplateParameterList(
5902 const TemplateParameterList *TemplateParams) {
Argyrios Kyrtzidis818c5db2010-06-23 13:48:30 +00005903 assert(TemplateParams && "No TemplateParams!");
Richard Smithe64e7452016-04-18 21:54:58 +00005904 AddSourceLocation(TemplateParams->getTemplateLoc());
5905 AddSourceLocation(TemplateParams->getLAngleLoc());
5906 AddSourceLocation(TemplateParams->getRAngleLoc());
Hubert Tonge4a0c0e2016-07-30 22:33:34 +00005907 // TODO: Concepts
Richard Smithe64e7452016-04-18 21:54:58 +00005908 Record->push_back(TemplateParams->size());
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00005909 for (const auto &P : *TemplateParams)
Richard Smithe64e7452016-04-18 21:54:58 +00005910 AddDeclRef(P);
Argyrios Kyrtzidis818c5db2010-06-23 13:48:30 +00005911}
5912
Adrian Prantl9fc8faf2018-05-09 01:00:01 +00005913/// Emit a template argument list.
Richard Smith290d8012016-04-06 17:06:00 +00005914void ASTRecordWriter::AddTemplateArgumentList(
5915 const TemplateArgumentList *TemplateArgs) {
Argyrios Kyrtzidis818c5db2010-06-23 13:48:30 +00005916 assert(TemplateArgs && "No TemplateArgs!");
Richard Smith290d8012016-04-06 17:06:00 +00005917 Record->push_back(TemplateArgs->size());
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +00005918 for (int i = 0, e = TemplateArgs->size(); i != e; ++i)
Richard Smith290d8012016-04-06 17:06:00 +00005919 AddTemplateArgument(TemplateArgs->get(i));
Argyrios Kyrtzidis818c5db2010-06-23 13:48:30 +00005920}
Argyrios Kyrtzidis2c2167a2010-07-02 11:55:32 +00005921
Richard Smith290d8012016-04-06 17:06:00 +00005922void ASTRecordWriter::AddASTTemplateArgumentListInfo(
5923 const ASTTemplateArgumentListInfo *ASTTemplArgList) {
Enea Zaffanella6dbe1872013-08-10 07:24:53 +00005924 assert(ASTTemplArgList && "No ASTTemplArgList!");
Richard Smith290d8012016-04-06 17:06:00 +00005925 AddSourceLocation(ASTTemplArgList->LAngleLoc);
5926 AddSourceLocation(ASTTemplArgList->RAngleLoc);
5927 Record->push_back(ASTTemplArgList->NumTemplateArgs);
Enea Zaffanella6dbe1872013-08-10 07:24:53 +00005928 const TemplateArgumentLoc *TemplArgs = ASTTemplArgList->getTemplateArgs();
Eugene Zelenkoe95e7d52016-09-07 21:53:17 +00005929 for (int i = 0, e = ASTTemplArgList->NumTemplateArgs; i != e; ++i)
Richard Smith290d8012016-04-06 17:06:00 +00005930 AddTemplateArgumentLoc(TemplArgs[i]);
Enea Zaffanella6dbe1872013-08-10 07:24:53 +00005931}
Argyrios Kyrtzidis2c2167a2010-07-02 11:55:32 +00005932
Richard Smithe64e7452016-04-18 21:54:58 +00005933void ASTRecordWriter::AddUnresolvedSet(const ASTUnresolvedSet &Set) {
5934 Record->push_back(Set.size());
Argyrios Kyrtzidis0f05fb92012-11-28 03:56:16 +00005935 for (ASTUnresolvedSet::const_iterator
Argyrios Kyrtzidis2c2167a2010-07-02 11:55:32 +00005936 I = Set.begin(), E = Set.end(); I != E; ++I) {
Richard Smithe64e7452016-04-18 21:54:58 +00005937 AddDeclRef(I.getDecl());
5938 Record->push_back(I.getAccess());
Argyrios Kyrtzidis2c2167a2010-07-02 11:55:32 +00005939 }
5940}
Argyrios Kyrtzidis3701fcd2010-07-02 23:30:27 +00005941
Richard Smith290d8012016-04-06 17:06:00 +00005942// FIXME: Move this out of the main ASTRecordWriter interface.
5943void ASTRecordWriter::AddCXXBaseSpecifier(const CXXBaseSpecifier &Base) {
5944 Record->push_back(Base.isVirtual());
5945 Record->push_back(Base.isBaseOfClass());
5946 Record->push_back(Base.getAccessSpecifierAsWritten());
5947 Record->push_back(Base.getInheritConstructors());
5948 AddTypeSourceInfo(Base.getTypeSourceInfo());
5949 AddSourceRange(Base.getSourceRange());
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00005950 AddSourceLocation(Base.isPackExpansion()? Base.getEllipsisLoc()
Richard Smith290d8012016-04-06 17:06:00 +00005951 : SourceLocation());
Argyrios Kyrtzidis3701fcd2010-07-02 23:30:27 +00005952}
Sebastian Redl85b2a6a2010-07-14 23:45:08 +00005953
Richard Smith645d2cf2016-04-14 00:29:55 +00005954static uint64_t EmitCXXBaseSpecifiers(ASTWriter &W,
5955 ArrayRef<CXXBaseSpecifier> Bases) {
5956 ASTWriter::RecordData Record;
5957 ASTRecordWriter Writer(W, Record);
5958 Writer.push_back(Bases.size());
Dmitry Polukhin790b5402016-04-06 10:01:46 +00005959
Richard Smith645d2cf2016-04-14 00:29:55 +00005960 for (auto &Base : Bases)
5961 Writer.AddCXXBaseSpecifier(Base);
Richard Smith290d8012016-04-06 17:06:00 +00005962
Richard Smith645d2cf2016-04-14 00:29:55 +00005963 return Writer.Emit(serialization::DECL_CXX_BASE_SPECIFIERS);
Douglas Gregord4c5ed02010-10-29 22:39:52 +00005964}
5965
Richard Smith290d8012016-04-06 17:06:00 +00005966// FIXME: Move this out of the main ASTRecordWriter interface.
Richard Smith645d2cf2016-04-14 00:29:55 +00005967void ASTRecordWriter::AddCXXBaseSpecifiers(ArrayRef<CXXBaseSpecifier> Bases) {
5968 AddOffset(EmitCXXBaseSpecifiers(*Writer, Bases));
5969}
5970
Richard Smithaa165cf2016-04-13 21:57:08 +00005971static uint64_t
5972EmitCXXCtorInitializers(ASTWriter &W,
5973 ArrayRef<CXXCtorInitializer *> CtorInits) {
5974 ASTWriter::RecordData Record;
5975 ASTRecordWriter Writer(W, Record);
5976 Writer.push_back(CtorInits.size());
Argyrios Kyrtzidis5b6a03f2010-08-09 10:54:12 +00005977
Richard Smithaa165cf2016-04-13 21:57:08 +00005978 for (auto *Init : CtorInits) {
Argyrios Kyrtzidis5b6a03f2010-08-09 10:54:12 +00005979 if (Init->isBaseInitializer()) {
Richard Smithaa165cf2016-04-13 21:57:08 +00005980 Writer.push_back(CTOR_INITIALIZER_BASE);
5981 Writer.AddTypeSourceInfo(Init->getTypeSourceInfo());
5982 Writer.push_back(Init->isBaseVirtual());
Alexis Hunt37a477f2011-05-04 01:19:08 +00005983 } else if (Init->isDelegatingInitializer()) {
Richard Smithaa165cf2016-04-13 21:57:08 +00005984 Writer.push_back(CTOR_INITIALIZER_DELEGATING);
5985 Writer.AddTypeSourceInfo(Init->getTypeSourceInfo());
Alexis Hunt37a477f2011-05-04 01:19:08 +00005986 } else if (Init->isMemberInitializer()){
Richard Smithaa165cf2016-04-13 21:57:08 +00005987 Writer.push_back(CTOR_INITIALIZER_MEMBER);
5988 Writer.AddDeclRef(Init->getMember());
Argyrios Kyrtzidis5b6a03f2010-08-09 10:54:12 +00005989 } else {
Richard Smithaa165cf2016-04-13 21:57:08 +00005990 Writer.push_back(CTOR_INITIALIZER_INDIRECT_MEMBER);
5991 Writer.AddDeclRef(Init->getIndirectMember());
Argyrios Kyrtzidis5b6a03f2010-08-09 10:54:12 +00005992 }
Francois Pichetd583da02010-12-04 09:14:42 +00005993
Richard Smithaa165cf2016-04-13 21:57:08 +00005994 Writer.AddSourceLocation(Init->getMemberLocation());
5995 Writer.AddStmt(Init->getInit());
5996 Writer.AddSourceLocation(Init->getLParenLoc());
5997 Writer.AddSourceLocation(Init->getRParenLoc());
5998 Writer.push_back(Init->isWritten());
Richard Smith30e304e2016-12-14 00:03:17 +00005999 if (Init->isWritten())
Richard Smithaa165cf2016-04-13 21:57:08 +00006000 Writer.push_back(Init->getSourceOrder());
Argyrios Kyrtzidis5b6a03f2010-08-09 10:54:12 +00006001 }
Richard Smithaa165cf2016-04-13 21:57:08 +00006002
6003 return Writer.Emit(serialization::DECL_CXX_CTOR_INITIALIZERS);
Argyrios Kyrtzidis5b6a03f2010-08-09 10:54:12 +00006004}
6005
Richard Smithaa165cf2016-04-13 21:57:08 +00006006// FIXME: Move this out of the main ASTRecordWriter interface.
6007void ASTRecordWriter::AddCXXCtorInitializers(
6008 ArrayRef<CXXCtorInitializer *> CtorInits) {
6009 AddOffset(EmitCXXCtorInitializers(*Writer, CtorInits));
Richard Smithc2bb8182015-03-24 06:36:48 +00006010}
6011
Richard Smith290d8012016-04-06 17:06:00 +00006012void ASTRecordWriter::AddCXXDefinitionData(const CXXRecordDecl *D) {
Richard Smith053f6c62014-05-16 23:01:30 +00006013 auto &Data = D->data();
Richard Smith290d8012016-04-06 17:06:00 +00006014 Record->push_back(Data.IsLambda);
6015 Record->push_back(Data.UserDeclaredConstructor);
6016 Record->push_back(Data.UserDeclaredSpecialMembers);
6017 Record->push_back(Data.Aggregate);
6018 Record->push_back(Data.PlainOldData);
6019 Record->push_back(Data.Empty);
6020 Record->push_back(Data.Polymorphic);
6021 Record->push_back(Data.Abstract);
6022 Record->push_back(Data.IsStandardLayout);
Richard Smithb6070db2018-04-05 18:55:37 +00006023 Record->push_back(Data.IsCXX11StandardLayout);
6024 Record->push_back(Data.HasBasesWithFields);
6025 Record->push_back(Data.HasBasesWithNonStaticDataMembers);
Richard Smith290d8012016-04-06 17:06:00 +00006026 Record->push_back(Data.HasPrivateFields);
6027 Record->push_back(Data.HasProtectedFields);
6028 Record->push_back(Data.HasPublicFields);
6029 Record->push_back(Data.HasMutableFields);
6030 Record->push_back(Data.HasVariantMembers);
6031 Record->push_back(Data.HasOnlyCMembers);
6032 Record->push_back(Data.HasInClassInitializer);
6033 Record->push_back(Data.HasUninitializedReferenceMember);
6034 Record->push_back(Data.HasUninitializedFields);
Richard Smith12e79312016-05-13 06:47:56 +00006035 Record->push_back(Data.HasInheritedConstructor);
6036 Record->push_back(Data.HasInheritedAssignment);
Richard Smith96cd6712017-08-16 01:49:53 +00006037 Record->push_back(Data.NeedOverloadResolutionForCopyConstructor);
Richard Smith290d8012016-04-06 17:06:00 +00006038 Record->push_back(Data.NeedOverloadResolutionForMoveConstructor);
6039 Record->push_back(Data.NeedOverloadResolutionForMoveAssignment);
6040 Record->push_back(Data.NeedOverloadResolutionForDestructor);
Richard Smith96cd6712017-08-16 01:49:53 +00006041 Record->push_back(Data.DefaultedCopyConstructorIsDeleted);
Richard Smith290d8012016-04-06 17:06:00 +00006042 Record->push_back(Data.DefaultedMoveConstructorIsDeleted);
6043 Record->push_back(Data.DefaultedMoveAssignmentIsDeleted);
6044 Record->push_back(Data.DefaultedDestructorIsDeleted);
6045 Record->push_back(Data.HasTrivialSpecialMembers);
Akira Hatanaka02914dc2018-02-05 20:23:22 +00006046 Record->push_back(Data.HasTrivialSpecialMembersForCall);
Richard Smith290d8012016-04-06 17:06:00 +00006047 Record->push_back(Data.DeclaredNonTrivialSpecialMembers);
Akira Hatanaka02914dc2018-02-05 20:23:22 +00006048 Record->push_back(Data.DeclaredNonTrivialSpecialMembersForCall);
Richard Smith290d8012016-04-06 17:06:00 +00006049 Record->push_back(Data.HasIrrelevantDestructor);
6050 Record->push_back(Data.HasConstexprNonCopyMoveConstructor);
6051 Record->push_back(Data.HasDefaultedDefaultConstructor);
6052 Record->push_back(Data.DefaultedDefaultConstructorIsConstexpr);
6053 Record->push_back(Data.HasConstexprDefaultConstructor);
6054 Record->push_back(Data.HasNonLiteralTypeFieldsOrBases);
6055 Record->push_back(Data.ComputedVisibleConversions);
6056 Record->push_back(Data.UserProvidedDefaultConstructor);
6057 Record->push_back(Data.DeclaredSpecialMembers);
Richard Smithdf054d32017-02-25 23:53:05 +00006058 Record->push_back(Data.ImplicitCopyConstructorCanHaveConstParamForVBase);
6059 Record->push_back(Data.ImplicitCopyConstructorCanHaveConstParamForNonVBase);
Richard Smith290d8012016-04-06 17:06:00 +00006060 Record->push_back(Data.ImplicitCopyAssignmentHasConstParam);
6061 Record->push_back(Data.HasDeclaredCopyConstructorWithConstParam);
6062 Record->push_back(Data.HasDeclaredCopyAssignmentWithConstParam);
Richard Trieufd1acbb2017-04-11 21:31:00 +00006063
6064 // getODRHash will compute the ODRHash if it has not been previously computed.
6065 Record->push_back(D->getODRHash());
David Blaikief63556d2017-04-12 20:58:33 +00006066 bool ModulesDebugInfo = Writer->Context->getLangOpts().ModulesDebugInfo &&
6067 Writer->WritingModule && !D->isDependentType();
6068 Record->push_back(ModulesDebugInfo);
6069 if (ModulesDebugInfo)
David Blaikie1ac9c982017-04-11 21:13:37 +00006070 Writer->ModularCodegenDecls.push_back(Writer->GetDeclRef(D));
6071
Richard Smith561fb152012-02-25 07:33:38 +00006072 // IsLambda bit is already saved.
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00006073
Richard Smith290d8012016-04-06 17:06:00 +00006074 Record->push_back(Data.NumBases);
Douglas Gregord4c5ed02010-10-29 22:39:52 +00006075 if (Data.NumBases > 0)
Richard Smith645d2cf2016-04-14 00:29:55 +00006076 AddCXXBaseSpecifiers(Data.bases());
6077
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00006078 // FIXME: Make VBases lazily computed when needed to avoid storing them.
Richard Smith290d8012016-04-06 17:06:00 +00006079 Record->push_back(Data.NumVBases);
Douglas Gregord4c5ed02010-10-29 22:39:52 +00006080 if (Data.NumVBases > 0)
Richard Smith645d2cf2016-04-14 00:29:55 +00006081 AddCXXBaseSpecifiers(Data.vbases());
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00006082
Richard Smith290d8012016-04-06 17:06:00 +00006083 AddUnresolvedSet(Data.Conversions.get(*Writer->Context));
6084 AddUnresolvedSet(Data.VisibleConversions.get(*Writer->Context));
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00006085 // Data.Definition is the owning decl, no need to write it.
Richard Smith290d8012016-04-06 17:06:00 +00006086 AddDeclRef(D->getFirstFriend());
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00006087
Douglas Gregor99ae8062012-02-14 17:54:36 +00006088 // Add lambda-specific data.
6089 if (Data.IsLambda) {
Richard Smith053f6c62014-05-16 23:01:30 +00006090 auto &Lambda = D->getLambdaData();
Richard Smith290d8012016-04-06 17:06:00 +00006091 Record->push_back(Lambda.Dependent);
6092 Record->push_back(Lambda.IsGenericLambda);
6093 Record->push_back(Lambda.CaptureDefault);
6094 Record->push_back(Lambda.NumCaptures);
6095 Record->push_back(Lambda.NumExplicitCaptures);
6096 Record->push_back(Lambda.ManglingNumber);
Richard Smith0bae6242016-08-25 00:34:00 +00006097 AddDeclRef(D->getLambdaContextDecl());
Richard Smith290d8012016-04-06 17:06:00 +00006098 AddTypeSourceInfo(Lambda.MethodTyInfo);
Douglas Gregor99ae8062012-02-14 17:54:36 +00006099 for (unsigned I = 0, N = Lambda.NumCaptures; I != N; ++I) {
Benjamin Kramerf3ca26982014-05-10 16:31:55 +00006100 const LambdaCapture &Capture = Lambda.Captures[I];
Richard Smith290d8012016-04-06 17:06:00 +00006101 AddSourceLocation(Capture.getLocation());
6102 Record->push_back(Capture.isImplicit());
6103 Record->push_back(Capture.getCaptureKind());
Richard Smithba71c082013-05-16 06:20:58 +00006104 switch (Capture.getCaptureKind()) {
Faisal Validc6b5962016-03-21 09:25:37 +00006105 case LCK_StarThis:
Richard Smithba71c082013-05-16 06:20:58 +00006106 case LCK_This:
Alexey Bataev39c81e22014-08-28 04:28:19 +00006107 case LCK_VLAType:
Richard Smithba71c082013-05-16 06:20:58 +00006108 break;
6109 case LCK_ByCopy:
Richard Smithbb13c9a2013-09-28 04:02:39 +00006110 case LCK_ByRef:
Richard Smithba71c082013-05-16 06:20:58 +00006111 VarDecl *Var =
Craig Toppera13603a2014-05-22 05:54:18 +00006112 Capture.capturesVariable() ? Capture.getCapturedVar() : nullptr;
Richard Smith290d8012016-04-06 17:06:00 +00006113 AddDeclRef(Var);
Richard Smithba71c082013-05-16 06:20:58 +00006114 AddSourceLocation(Capture.isPackExpansion() ? Capture.getEllipsisLoc()
Richard Smith290d8012016-04-06 17:06:00 +00006115 : SourceLocation());
Richard Smithba71c082013-05-16 06:20:58 +00006116 break;
6117 }
Douglas Gregor99ae8062012-02-14 17:54:36 +00006118 }
6119 }
Argyrios Kyrtzidiseb39d9a2010-10-24 17:26:40 +00006120}
6121
Argyrios Kyrtzidis65ad5692010-10-24 17:26:36 +00006122void ASTWriter::ReaderInitialized(ASTReader *Reader) {
Sebastian Redl07a89a82010-07-30 00:29:29 +00006123 assert(Reader && "Cannot remove chain");
Douglas Gregordf0c1512011-08-18 04:12:04 +00006124 assert((!Chain || Chain == Reader) && "Cannot replace chain");
Sebastian Redl07a89a82010-07-30 00:29:29 +00006125 assert(FirstDeclID == NextDeclID &&
6126 FirstTypeID == NextTypeID &&
6127 FirstIdentID == NextIdentID &&
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00006128 FirstMacroID == NextMacroID &&
Douglas Gregor253eefe2011-12-01 00:59:36 +00006129 FirstSubmoduleID == NextSubmoduleID &&
Sebastian Redld95a56e2010-08-04 18:21:41 +00006130 FirstSelectorID == NextSelectorID &&
Sebastian Redl07a89a82010-07-30 00:29:29 +00006131 "Setting chain after writing has started.");
Douglas Gregor925296b2011-07-19 16:10:42 +00006132
Sebastian Redl07a89a82010-07-30 00:29:29 +00006133 Chain = Reader;
Argyrios Kyrtzidis65ad5692010-10-24 17:26:36 +00006134
Richard Smith7f330cd2015-03-18 01:42:29 +00006135 // Note, this will get called multiple times, once one the reader starts up
6136 // and again each time it's done reading a PCH or module.
Douglas Gregordf0c1512011-08-18 04:12:04 +00006137 FirstDeclID = NUM_PREDEF_DECL_IDS + Chain->getTotalNumDecls();
6138 FirstTypeID = NUM_PREDEF_TYPE_IDS + Chain->getTotalNumTypes();
6139 FirstIdentID = NUM_PREDEF_IDENT_IDS + Chain->getTotalNumIdentifiers();
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00006140 FirstMacroID = NUM_PREDEF_MACRO_IDS + Chain->getTotalNumMacros();
Douglas Gregor253eefe2011-12-01 00:59:36 +00006141 FirstSubmoduleID = NUM_PREDEF_SUBMODULE_IDS + Chain->getTotalNumSubmodules();
Douglas Gregordf0c1512011-08-18 04:12:04 +00006142 FirstSelectorID = NUM_PREDEF_SELECTOR_IDS + Chain->getTotalNumSelectors();
Argyrios Kyrtzidis65ad5692010-10-24 17:26:36 +00006143 NextDeclID = FirstDeclID;
6144 NextTypeID = FirstTypeID;
6145 NextIdentID = FirstIdentID;
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00006146 NextMacroID = FirstMacroID;
Argyrios Kyrtzidis65ad5692010-10-24 17:26:36 +00006147 NextSelectorID = FirstSelectorID;
Douglas Gregor253eefe2011-12-01 00:59:36 +00006148 NextSubmoduleID = FirstSubmoduleID;
Sebastian Redl07a89a82010-07-30 00:29:29 +00006149}
6150
Sebastian Redl539c5062010-08-18 23:57:32 +00006151void ASTWriter::IdentifierRead(IdentID ID, IdentifierInfo *II) {
Douglas Gregor8d7edce2013-02-08 21:30:59 +00006152 // Always keep the highest ID. See \p TypeRead() for more information.
6153 IdentID &StoredID = IdentifierIDs[II];
6154 if (ID > StoredID)
6155 StoredID = ID;
Sebastian Redlff4a2952010-07-23 23:49:55 +00006156}
6157
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00006158void ASTWriter::MacroRead(serialization::MacroID ID, MacroInfo *MI) {
Douglas Gregor8d7edce2013-02-08 21:30:59 +00006159 // Always keep the highest ID. See \p TypeRead() for more information.
Argyrios Kyrtzidiseb663da2013-03-22 21:12:57 +00006160 MacroID &StoredID = MacroIDs[MI];
Douglas Gregor8d7edce2013-02-08 21:30:59 +00006161 if (ID > StoredID)
6162 StoredID = ID;
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00006163}
6164
Argyrios Kyrtzidisbb5c7eae2010-08-20 16:03:59 +00006165void ASTWriter::TypeRead(TypeIdx Idx, QualType T) {
Douglas Gregor9b3932c2010-10-05 18:37:06 +00006166 // Always take the highest-numbered type index. This copes with an interesting
6167 // case for chained AST writing where we schedule writing the type and then,
Michael J. Spencer4c0ffa82010-10-21 03:16:25 +00006168 // later, deserialize the type from another AST. In this case, we want to
Douglas Gregor9b3932c2010-10-05 18:37:06 +00006169 // keep the higher-numbered entry so that we can properly write it out to
6170 // the AST file.
6171 TypeIdx &StoredIdx = TypeIdxs[T];
6172 if (Idx.getIndex() >= StoredIdx.getIndex())
6173 StoredIdx = Idx;
Sebastian Redl85b2a6a2010-07-14 23:45:08 +00006174}
6175
Sebastian Redl539c5062010-08-18 23:57:32 +00006176void ASTWriter::SelectorRead(SelectorID ID, Selector S) {
Douglas Gregor8d7edce2013-02-08 21:30:59 +00006177 // Always keep the highest ID. See \p TypeRead() for more information.
6178 SelectorID &StoredID = SelectorIDs[S];
6179 if (ID > StoredID)
6180 StoredID = ID;
Sebastian Redl834bb972010-08-04 17:20:04 +00006181}
Douglas Gregor91096292010-10-02 19:29:26 +00006182
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00006183void ASTWriter::MacroDefinitionRead(serialization::PreprocessedEntityID ID,
Richard Smith66a81862015-05-04 02:25:31 +00006184 MacroDefinitionRecord *MD) {
Argyrios Kyrtzidis03c40c52011-09-15 18:02:56 +00006185 assert(MacroDefinitions.find(MD) == MacroDefinitions.end());
Douglas Gregor91096292010-10-02 19:29:26 +00006186 MacroDefinitions[MD] = ID;
6187}
Argyrios Kyrtzidisd170d842010-10-24 17:26:50 +00006188
Douglas Gregore37a85a2011-12-02 17:30:13 +00006189void ASTWriter::ModuleRead(serialization::SubmoduleID ID, Module *Mod) {
6190 assert(SubmoduleIDs.find(Mod) == SubmoduleIDs.end());
6191 SubmoduleIDs[Mod] = ID;
6192}
6193
Argyrios Kyrtzidisd170d842010-10-24 17:26:50 +00006194void ASTWriter::CompletedTagDefinition(const TagDecl *D) {
Vassil Vassilev19765fb2016-07-22 21:08:24 +00006195 if (Chain && Chain->isProcessingUpdateRecords()) return;
John McCallf937c022011-10-07 06:10:15 +00006196 assert(D->isCompleteDefinition());
Douglas Gregor2fd3d402011-09-17 00:05:03 +00006197 assert(!WritingAST && "Already writing the AST!");
Eugene Zelenkoddaa4b42015-12-08 18:00:11 +00006198 if (auto *RD = dyn_cast<CXXRecordDecl>(D)) {
Argyrios Kyrtzidisd170d842010-10-24 17:26:50 +00006199 // We are interested when a PCH decl is modified.
Douglas Gregorb3722e22011-09-09 23:01:35 +00006200 if (RD->isFromASTFile()) {
Argyrios Kyrtzidisd170d842010-10-24 17:26:50 +00006201 // A forward reference was mutated into a definition. Rewrite it.
6202 // FIXME: This happens during template instantiation, should we
6203 // have created a new definition decl instead ?
Richard Smithcd45dbc2014-04-19 03:48:30 +00006204 assert(isTemplateInstantiation(RD->getTemplateSpecializationKind()) &&
6205 "completed a tag from another module but not by instantiation?");
6206 DeclUpdates[RD].push_back(
6207 DeclUpdate(UPD_CXX_INSTANTIATED_CLASS_DEFINITION));
Argyrios Kyrtzidisd170d842010-10-24 17:26:50 +00006208 }
Argyrios Kyrtzidisd170d842010-10-24 17:26:50 +00006209 }
6210}
Douglas Gregorcb28f9d2012-10-09 23:05:51 +00006211
Richard Smithf983f7f2015-10-13 00:23:25 +00006212static bool isImportedDeclContext(ASTReader *Chain, const Decl *D) {
6213 if (D->isFromASTFile())
6214 return true;
6215
Richard Smithf983f7f2015-10-13 00:23:25 +00006216 // The predefined __va_list_tag struct is imported if we imported any decls.
6217 // FIXME: This is a gross hack.
6218 return D == D->getASTContext().getVaListTagDecl();
6219}
6220
Argyrios Kyrtzidis01c2df42010-10-28 07:38:51 +00006221void ASTWriter::AddedVisibleDecl(const DeclContext *DC, const Decl *D) {
Vassil Vassilev19765fb2016-07-22 21:08:24 +00006222 if (Chain && Chain->isProcessingUpdateRecords()) return;
6223 assert(DC->isLookupContext() &&
Vassil Vassilev71eafde2016-04-06 20:56:03 +00006224 "Should not add lookup results to non-lookup contexts!");
6225
Vassil Vassilev632eac32016-03-16 11:17:04 +00006226 // TU is handled elsewhere.
6227 if (isa<TranslationUnitDecl>(DC))
6228 return;
6229
6230 // Namespaces are handled elsewhere, except for template instantiations of
6231 // FunctionTemplateDecls in namespaces. We are interested in cases where the
6232 // local instantiations are added to an imported context. Only happens when
6233 // adding ADL lookup candidates, for example templated friends.
6234 if (isa<NamespaceDecl>(DC) && D->getFriendObjectKind() == Decl::FOK_None &&
6235 !isa<FunctionTemplateDecl>(D))
Argyrios Kyrtzidis01c2df42010-10-28 07:38:51 +00006236 return;
6237
Richard Smithf983f7f2015-10-13 00:23:25 +00006238 // We're only interested in cases where a local declaration is added to an
6239 // imported context.
6240 if (D->isFromASTFile() || !isImportedDeclContext(Chain, cast<Decl>(DC)))
6241 return;
Argyrios Kyrtzidis01c2df42010-10-28 07:38:51 +00006242
Richard Smith0f4e2c42015-08-06 04:23:48 +00006243 assert(DC == DC->getPrimaryContext() && "added to non-primary context");
Douglas Gregor9f782892013-01-21 15:25:38 +00006244 assert(!getDefinitiveDeclContext(DC) && "DeclContext not definitive!");
Richard Smithe9a8bc32014-09-30 00:45:29 +00006245 assert(!WritingAST && "Already writing the AST!");
Richard Smithf983f7f2015-10-13 00:23:25 +00006246 if (UpdatedDeclContexts.insert(DC) && !cast<Decl>(DC)->isFromASTFile()) {
6247 // We're adding a visible declaration to a predefined decl context. Ensure
6248 // that we write out all of its lookup results so we don't get a nasty
6249 // surprise when we try to emit its lookup table.
6250 for (auto *Child : DC->decls())
Richard Smithc26d9742016-10-06 20:30:51 +00006251 DeclsToEmitEvenIfUnreferenced.push_back(Child);
Richard Smithf983f7f2015-10-13 00:23:25 +00006252 }
Richard Smithc26d9742016-10-06 20:30:51 +00006253 DeclsToEmitEvenIfUnreferenced.push_back(D);
Argyrios Kyrtzidis01c2df42010-10-28 07:38:51 +00006254}
Argyrios Kyrtzidise16a5302010-10-24 17:26:54 +00006255
6256void ASTWriter::AddedCXXImplicitMember(const CXXRecordDecl *RD, const Decl *D) {
Vassil Vassilev19765fb2016-07-22 21:08:24 +00006257 if (Chain && Chain->isProcessingUpdateRecords()) return;
Argyrios Kyrtzidise16a5302010-10-24 17:26:54 +00006258 assert(D->isImplicit());
Richard Smithf983f7f2015-10-13 00:23:25 +00006259
6260 // We're only interested in cases where a local declaration is added to an
6261 // imported context.
6262 if (D->isFromASTFile() || !isImportedDeclContext(Chain, RD))
6263 return;
6264
Argyrios Kyrtzidise16a5302010-10-24 17:26:54 +00006265 if (!isa<CXXMethodDecl>(D))
Richard Smithf983f7f2015-10-13 00:23:25 +00006266 return;
Argyrios Kyrtzidise16a5302010-10-24 17:26:54 +00006267
6268 // A decl coming from PCH was modified.
John McCallf937c022011-10-07 06:10:15 +00006269 assert(RD->isCompleteDefinition());
Richard Smithe9a8bc32014-09-30 00:45:29 +00006270 assert(!WritingAST && "Already writing the AST!");
Aaron Ballman4f45b712014-03-21 15:22:56 +00006271 DeclUpdates[RD].push_back(DeclUpdate(UPD_CXX_ADDED_IMPLICIT_MEMBER, D));
Argyrios Kyrtzidise16a5302010-10-24 17:26:54 +00006272}
Argyrios Kyrtzidis402dbbb2010-10-28 07:38:42 +00006273
Richard Smith564417a2014-03-20 21:47:22 +00006274void ASTWriter::ResolvedExceptionSpec(const FunctionDecl *FD) {
Vassil Vassilev19765fb2016-07-22 21:08:24 +00006275 if (Chain && Chain->isProcessingUpdateRecords()) return;
Richard Smith9e2341d2015-03-23 03:25:59 +00006276 assert(!DoneWritingDeclsAndTypes && "Already done writing updates!");
6277 if (!Chain) return;
Richard Smith5fc18a92015-07-12 23:43:21 +00006278 Chain->forEachImportedKeyDecl(FD, [&](const Decl *D) {
Richard Smith9e2341d2015-03-23 03:25:59 +00006279 // If we don't already know the exception specification for this redecl
6280 // chain, add an update record for it.
6281 if (isUnresolvedExceptionSpec(cast<FunctionDecl>(D)
6282 ->getType()
6283 ->castAs<FunctionProtoType>()
6284 ->getExceptionSpecType()))
6285 DeclUpdates[D].push_back(UPD_CXX_RESOLVED_EXCEPTION_SPEC);
6286 });
Richard Smith564417a2014-03-20 21:47:22 +00006287}
6288
Richard Smith1fa5d642013-05-11 05:45:24 +00006289void ASTWriter::DeducedReturnType(const FunctionDecl *FD, QualType ReturnType) {
Vassil Vassilev19765fb2016-07-22 21:08:24 +00006290 if (Chain && Chain->isProcessingUpdateRecords()) return;
Richard Smith1fa5d642013-05-11 05:45:24 +00006291 assert(!WritingAST && "Already writing the AST!");
Richard Smith9e2341d2015-03-23 03:25:59 +00006292 if (!Chain) return;
Richard Smith5fc18a92015-07-12 23:43:21 +00006293 Chain->forEachImportedKeyDecl(FD, [&](const Decl *D) {
Richard Smith9e2341d2015-03-23 03:25:59 +00006294 DeclUpdates[D].push_back(
6295 DeclUpdate(UPD_CXX_DEDUCED_RETURN_TYPE, ReturnType));
6296 });
Richard Smith1fa5d642013-05-11 05:45:24 +00006297}
6298
Richard Smithf8134002015-03-10 01:41:22 +00006299void ASTWriter::ResolvedOperatorDelete(const CXXDestructorDecl *DD,
Richard Smith5b349582017-10-13 01:55:36 +00006300 const FunctionDecl *Delete,
6301 Expr *ThisArg) {
Vassil Vassilev19765fb2016-07-22 21:08:24 +00006302 if (Chain && Chain->isProcessingUpdateRecords()) return;
Richard Smithf8134002015-03-10 01:41:22 +00006303 assert(!WritingAST && "Already writing the AST!");
6304 assert(Delete && "Not given an operator delete");
Richard Smith9e2341d2015-03-23 03:25:59 +00006305 if (!Chain) return;
Richard Smith5fc18a92015-07-12 23:43:21 +00006306 Chain->forEachImportedKeyDecl(DD, [&](const Decl *D) {
Richard Smith9e2341d2015-03-23 03:25:59 +00006307 DeclUpdates[D].push_back(DeclUpdate(UPD_CXX_RESOLVED_DTOR_DELETE, Delete));
6308 });
Richard Smithf8134002015-03-10 01:41:22 +00006309}
6310
Sebastian Redlab238a72011-04-24 16:28:06 +00006311void ASTWriter::CompletedImplicitDefinition(const FunctionDecl *D) {
Vassil Vassilev19765fb2016-07-22 21:08:24 +00006312 if (Chain && Chain->isProcessingUpdateRecords()) return;
Douglas Gregor2fd3d402011-09-17 00:05:03 +00006313 assert(!WritingAST && "Already writing the AST!");
Douglas Gregorb3722e22011-09-09 23:01:35 +00006314 if (!D->isFromASTFile())
Sebastian Redlab238a72011-04-24 16:28:06 +00006315 return; // Declaration not imported from PCH.
6316
Richard Smith4d235792014-08-07 18:53:08 +00006317 // Implicit function decl from a PCH was defined.
6318 DeclUpdates[D].push_back(DeclUpdate(UPD_CXX_ADDED_FUNCTION_DEFINITION));
Sebastian Redlab238a72011-04-24 16:28:06 +00006319}
6320
Richard Smith891fc7f2017-12-05 01:31:47 +00006321void ASTWriter::VariableDefinitionInstantiated(const VarDecl *D) {
6322 if (Chain && Chain->isProcessingUpdateRecords()) return;
6323 assert(!WritingAST && "Already writing the AST!");
6324 if (!D->isFromASTFile())
6325 return;
6326
6327 DeclUpdates[D].push_back(DeclUpdate(UPD_CXX_ADDED_VAR_DEFINITION));
6328}
6329
Richard Smithd28ac5b2014-03-22 23:33:22 +00006330void ASTWriter::FunctionDefinitionInstantiated(const FunctionDecl *D) {
Vassil Vassilev19765fb2016-07-22 21:08:24 +00006331 if (Chain && Chain->isProcessingUpdateRecords()) return;
Richard Smithd28ac5b2014-03-22 23:33:22 +00006332 assert(!WritingAST && "Already writing the AST!");
6333 if (!D->isFromASTFile())
6334 return;
6335
Richard Smith9e2341d2015-03-23 03:25:59 +00006336 DeclUpdates[D].push_back(DeclUpdate(UPD_CXX_ADDED_FUNCTION_DEFINITION));
Richard Smithd28ac5b2014-03-22 23:33:22 +00006337}
6338
Richard Smith891fc7f2017-12-05 01:31:47 +00006339void ASTWriter::InstantiationRequested(const ValueDecl *D) {
Vassil Vassilev19765fb2016-07-22 21:08:24 +00006340 if (Chain && Chain->isProcessingUpdateRecords()) return;
Douglas Gregor2fd3d402011-09-17 00:05:03 +00006341 assert(!WritingAST && "Already writing the AST!");
Douglas Gregorb3722e22011-09-09 23:01:35 +00006342 if (!D->isFromASTFile())
Sebastian Redl2ac2c722011-04-29 08:19:30 +00006343 return;
6344
6345 // Since the actual instantiation is delayed, this really means that we need
6346 // to update the instantiation location.
Richard Smith891fc7f2017-12-05 01:31:47 +00006347 SourceLocation POI;
6348 if (auto *VD = dyn_cast<VarDecl>(D))
6349 POI = VD->getPointOfInstantiation();
6350 else
6351 POI = cast<FunctionDecl>(D)->getPointOfInstantiation();
6352 DeclUpdates[D].push_back(DeclUpdate(UPD_CXX_POINT_OF_INSTANTIATION, POI));
Sebastian Redl2ac2c722011-04-29 08:19:30 +00006353}
6354
John McCall32791cc2016-01-06 22:34:54 +00006355void ASTWriter::DefaultArgumentInstantiated(const ParmVarDecl *D) {
Vassil Vassilev19765fb2016-07-22 21:08:24 +00006356 if (Chain && Chain->isProcessingUpdateRecords()) return;
John McCall32791cc2016-01-06 22:34:54 +00006357 assert(!WritingAST && "Already writing the AST!");
6358 if (!D->isFromASTFile())
6359 return;
6360
6361 DeclUpdates[D].push_back(
6362 DeclUpdate(UPD_CXX_INSTANTIATED_DEFAULT_ARGUMENT, D));
6363}
6364
Richard Smith4b054b22016-08-24 21:25:37 +00006365void ASTWriter::DefaultMemberInitializerInstantiated(const FieldDecl *D) {
6366 assert(!WritingAST && "Already writing the AST!");
6367 if (!D->isFromASTFile())
6368 return;
6369
6370 DeclUpdates[D].push_back(
6371 DeclUpdate(UPD_CXX_INSTANTIATED_DEFAULT_MEMBER_INITIALIZER, D));
6372}
6373
Argyrios Kyrtzidis7d847c92011-09-01 00:58:55 +00006374void ASTWriter::AddedObjCCategoryToInterface(const ObjCCategoryDecl *CatD,
6375 const ObjCInterfaceDecl *IFD) {
Vassil Vassilev19765fb2016-07-22 21:08:24 +00006376 if (Chain && Chain->isProcessingUpdateRecords()) return;
Douglas Gregor2fd3d402011-09-17 00:05:03 +00006377 assert(!WritingAST && "Already writing the AST!");
Douglas Gregorb3722e22011-09-09 23:01:35 +00006378 if (!IFD->isFromASTFile())
Argyrios Kyrtzidis7d847c92011-09-01 00:58:55 +00006379 return; // Declaration not imported from PCH.
Jonas Devlieghere560ce2c2018-02-26 15:16:42 +00006380
Douglas Gregor404cdde2012-01-27 01:47:08 +00006381 assert(IFD->getDefinition() && "Category on a class without a definition?");
6382 ObjCClassesWithCategories.insert(
6383 const_cast<ObjCInterfaceDecl *>(IFD->getDefinition()));
Argyrios Kyrtzidis7d847c92011-09-01 00:58:55 +00006384}
Argyrios Kyrtzidisb97a4022011-11-12 21:07:46 +00006385
Eli Friedman276dd182013-09-05 00:02:25 +00006386void ASTWriter::DeclarationMarkedUsed(const Decl *D) {
Vassil Vassilev19765fb2016-07-22 21:08:24 +00006387 if (Chain && Chain->isProcessingUpdateRecords()) return;
Eli Friedman276dd182013-09-05 00:02:25 +00006388 assert(!WritingAST && "Already writing the AST!");
Vassil Vassilev928c8252016-04-28 14:13:28 +00006389
6390 // If there is *any* declaration of the entity that's not from an AST file,
6391 // we can skip writing the update record. We make sure that isUsed() triggers
6392 // completion of the redeclaration chain of the entity.
6393 for (auto Prev = D->getMostRecentDecl(); Prev; Prev = Prev->getPreviousDecl())
6394 if (IsLocalDecl(Prev))
6395 return;
Eli Friedman276dd182013-09-05 00:02:25 +00006396
Aaron Ballman4f45b712014-03-21 15:22:56 +00006397 DeclUpdates[D].push_back(DeclUpdate(UPD_DECL_MARKED_USED));
Eli Friedman276dd182013-09-05 00:02:25 +00006398}
Alexey Bataev97720002014-11-11 04:05:39 +00006399
6400void ASTWriter::DeclarationMarkedOpenMPThreadPrivate(const Decl *D) {
Vassil Vassilev19765fb2016-07-22 21:08:24 +00006401 if (Chain && Chain->isProcessingUpdateRecords()) return;
Alexey Bataev97720002014-11-11 04:05:39 +00006402 assert(!WritingAST && "Already writing the AST!");
6403 if (!D->isFromASTFile())
6404 return;
6405
6406 DeclUpdates[D].push_back(DeclUpdate(UPD_DECL_MARKED_OPENMP_THREADPRIVATE));
6407}
Richard Smith65ebb4a2015-03-26 04:09:53 +00006408
Dmitry Polukhind69b5052016-05-09 14:59:13 +00006409void ASTWriter::DeclarationMarkedOpenMPDeclareTarget(const Decl *D,
6410 const Attr *Attr) {
Vassil Vassilev19765fb2016-07-22 21:08:24 +00006411 if (Chain && Chain->isProcessingUpdateRecords()) return;
Dmitry Polukhin0b0da292016-04-06 11:38:59 +00006412 assert(!WritingAST && "Already writing the AST!");
6413 if (!D->isFromASTFile())
6414 return;
6415
Dmitry Polukhind69b5052016-05-09 14:59:13 +00006416 DeclUpdates[D].push_back(
6417 DeclUpdate(UPD_DECL_MARKED_OPENMP_DECLARETARGET, Attr));
Dmitry Polukhin0b0da292016-04-06 11:38:59 +00006418}
6419
Richard Smith4caa4492015-05-15 02:34:32 +00006420void ASTWriter::RedefinedHiddenDefinition(const NamedDecl *D, Module *M) {
Vassil Vassilev19765fb2016-07-22 21:08:24 +00006421 if (Chain && Chain->isProcessingUpdateRecords()) return;
Richard Smith65ebb4a2015-03-26 04:09:53 +00006422 assert(!WritingAST && "Already writing the AST!");
6423 assert(D->isHidden() && "expected a hidden declaration");
Richard Smith4caa4492015-05-15 02:34:32 +00006424 DeclUpdates[D].push_back(DeclUpdate(UPD_DECL_EXPORTED, M));
Richard Smith65ebb4a2015-03-26 04:09:53 +00006425}
Alex Denisovfde64952015-06-26 05:28:36 +00006426
6427void ASTWriter::AddedAttributeToRecord(const Attr *Attr,
6428 const RecordDecl *Record) {
Vassil Vassilev19765fb2016-07-22 21:08:24 +00006429 if (Chain && Chain->isProcessingUpdateRecords()) return;
Alex Denisovfde64952015-06-26 05:28:36 +00006430 assert(!WritingAST && "Already writing the AST!");
6431 if (!Record->isFromASTFile())
6432 return;
6433 DeclUpdates[Record].push_back(DeclUpdate(UPD_ADDED_ATTR_TO_RECORD, Attr));
6434}
Richard Smithc26d9742016-10-06 20:30:51 +00006435
6436void ASTWriter::AddedCXXTemplateSpecialization(
6437 const ClassTemplateDecl *TD, const ClassTemplateSpecializationDecl *D) {
6438 assert(!WritingAST && "Already writing the AST!");
6439
6440 if (!TD->getFirstDecl()->isFromASTFile())
6441 return;
6442 if (Chain && Chain->isProcessingUpdateRecords())
6443 return;
6444
6445 DeclsToEmitEvenIfUnreferenced.push_back(D);
6446}
6447
6448void ASTWriter::AddedCXXTemplateSpecialization(
6449 const VarTemplateDecl *TD, const VarTemplateSpecializationDecl *D) {
6450 assert(!WritingAST && "Already writing the AST!");
6451
6452 if (!TD->getFirstDecl()->isFromASTFile())
6453 return;
6454 if (Chain && Chain->isProcessingUpdateRecords())
6455 return;
6456
6457 DeclsToEmitEvenIfUnreferenced.push_back(D);
6458}
6459
6460void ASTWriter::AddedCXXTemplateSpecialization(const FunctionTemplateDecl *TD,
6461 const FunctionDecl *D) {
6462 assert(!WritingAST && "Already writing the AST!");
6463
6464 if (!TD->getFirstDecl()->isFromASTFile())
6465 return;
6466 if (Chain && Chain->isProcessingUpdateRecords())
6467 return;
6468
6469 DeclsToEmitEvenIfUnreferenced.push_back(D);
6470}
Kelvin Libe286f52018-09-15 13:54:15 +00006471
6472//===----------------------------------------------------------------------===//
6473//// OMPClause Serialization
6474////===----------------------------------------------------------------------===//
6475
6476void OMPClauseWriter::writeClause(OMPClause *C) {
6477 Record.push_back(C->getClauseKind());
6478 Visit(C);
6479 Record.AddSourceLocation(C->getBeginLoc());
6480 Record.AddSourceLocation(C->getEndLoc());
6481}
6482
6483void OMPClauseWriter::VisitOMPClauseWithPreInit(OMPClauseWithPreInit *C) {
6484 Record.push_back(C->getCaptureRegion());
6485 Record.AddStmt(C->getPreInitStmt());
6486}
6487
6488void OMPClauseWriter::VisitOMPClauseWithPostUpdate(OMPClauseWithPostUpdate *C) {
6489 VisitOMPClauseWithPreInit(C);
6490 Record.AddStmt(C->getPostUpdateExpr());
6491}
6492
6493void OMPClauseWriter::VisitOMPIfClause(OMPIfClause *C) {
6494 VisitOMPClauseWithPreInit(C);
6495 Record.push_back(C->getNameModifier());
6496 Record.AddSourceLocation(C->getNameModifierLoc());
6497 Record.AddSourceLocation(C->getColonLoc());
6498 Record.AddStmt(C->getCondition());
6499 Record.AddSourceLocation(C->getLParenLoc());
6500}
6501
6502void OMPClauseWriter::VisitOMPFinalClause(OMPFinalClause *C) {
6503 Record.AddStmt(C->getCondition());
6504 Record.AddSourceLocation(C->getLParenLoc());
6505}
6506
6507void OMPClauseWriter::VisitOMPNumThreadsClause(OMPNumThreadsClause *C) {
6508 VisitOMPClauseWithPreInit(C);
6509 Record.AddStmt(C->getNumThreads());
6510 Record.AddSourceLocation(C->getLParenLoc());
6511}
6512
6513void OMPClauseWriter::VisitOMPSafelenClause(OMPSafelenClause *C) {
6514 Record.AddStmt(C->getSafelen());
6515 Record.AddSourceLocation(C->getLParenLoc());
6516}
6517
6518void OMPClauseWriter::VisitOMPSimdlenClause(OMPSimdlenClause *C) {
6519 Record.AddStmt(C->getSimdlen());
6520 Record.AddSourceLocation(C->getLParenLoc());
6521}
6522
6523void OMPClauseWriter::VisitOMPCollapseClause(OMPCollapseClause *C) {
6524 Record.AddStmt(C->getNumForLoops());
6525 Record.AddSourceLocation(C->getLParenLoc());
6526}
6527
6528void OMPClauseWriter::VisitOMPDefaultClause(OMPDefaultClause *C) {
6529 Record.push_back(C->getDefaultKind());
6530 Record.AddSourceLocation(C->getLParenLoc());
6531 Record.AddSourceLocation(C->getDefaultKindKwLoc());
6532}
6533
6534void OMPClauseWriter::VisitOMPProcBindClause(OMPProcBindClause *C) {
6535 Record.push_back(C->getProcBindKind());
6536 Record.AddSourceLocation(C->getLParenLoc());
6537 Record.AddSourceLocation(C->getProcBindKindKwLoc());
6538}
6539
6540void OMPClauseWriter::VisitOMPScheduleClause(OMPScheduleClause *C) {
6541 VisitOMPClauseWithPreInit(C);
6542 Record.push_back(C->getScheduleKind());
6543 Record.push_back(C->getFirstScheduleModifier());
6544 Record.push_back(C->getSecondScheduleModifier());
6545 Record.AddStmt(C->getChunkSize());
6546 Record.AddSourceLocation(C->getLParenLoc());
6547 Record.AddSourceLocation(C->getFirstScheduleModifierLoc());
6548 Record.AddSourceLocation(C->getSecondScheduleModifierLoc());
6549 Record.AddSourceLocation(C->getScheduleKindLoc());
6550 Record.AddSourceLocation(C->getCommaLoc());
6551}
6552
6553void OMPClauseWriter::VisitOMPOrderedClause(OMPOrderedClause *C) {
6554 Record.push_back(C->getLoopNumIterations().size());
6555 Record.AddStmt(C->getNumForLoops());
6556 for (Expr *NumIter : C->getLoopNumIterations())
6557 Record.AddStmt(NumIter);
6558 for (unsigned I = 0, E = C->getLoopNumIterations().size(); I <E; ++I)
Mike Rice0ed46662018-09-20 17:19:41 +00006559 Record.AddStmt(C->getLoopCounter(I));
Kelvin Libe286f52018-09-15 13:54:15 +00006560 Record.AddSourceLocation(C->getLParenLoc());
6561}
6562
6563void OMPClauseWriter::VisitOMPNowaitClause(OMPNowaitClause *) {}
6564
6565void OMPClauseWriter::VisitOMPUntiedClause(OMPUntiedClause *) {}
6566
6567void OMPClauseWriter::VisitOMPMergeableClause(OMPMergeableClause *) {}
6568
6569void OMPClauseWriter::VisitOMPReadClause(OMPReadClause *) {}
6570
6571void OMPClauseWriter::VisitOMPWriteClause(OMPWriteClause *) {}
6572
6573void OMPClauseWriter::VisitOMPUpdateClause(OMPUpdateClause *) {}
6574
6575void OMPClauseWriter::VisitOMPCaptureClause(OMPCaptureClause *) {}
6576
6577void OMPClauseWriter::VisitOMPSeqCstClause(OMPSeqCstClause *) {}
6578
6579void OMPClauseWriter::VisitOMPThreadsClause(OMPThreadsClause *) {}
6580
6581void OMPClauseWriter::VisitOMPSIMDClause(OMPSIMDClause *) {}
6582
6583void OMPClauseWriter::VisitOMPNogroupClause(OMPNogroupClause *) {}
6584
6585void OMPClauseWriter::VisitOMPPrivateClause(OMPPrivateClause *C) {
6586 Record.push_back(C->varlist_size());
6587 Record.AddSourceLocation(C->getLParenLoc());
6588 for (auto *VE : C->varlists()) {
6589 Record.AddStmt(VE);
6590 }
6591 for (auto *VE : C->private_copies()) {
6592 Record.AddStmt(VE);
6593 }
6594}
6595
6596void OMPClauseWriter::VisitOMPFirstprivateClause(OMPFirstprivateClause *C) {
6597 Record.push_back(C->varlist_size());
6598 VisitOMPClauseWithPreInit(C);
6599 Record.AddSourceLocation(C->getLParenLoc());
6600 for (auto *VE : C->varlists()) {
6601 Record.AddStmt(VE);
6602 }
6603 for (auto *VE : C->private_copies()) {
6604 Record.AddStmt(VE);
6605 }
6606 for (auto *VE : C->inits()) {
6607 Record.AddStmt(VE);
6608 }
6609}
6610
6611void OMPClauseWriter::VisitOMPLastprivateClause(OMPLastprivateClause *C) {
6612 Record.push_back(C->varlist_size());
6613 VisitOMPClauseWithPostUpdate(C);
6614 Record.AddSourceLocation(C->getLParenLoc());
6615 for (auto *VE : C->varlists())
6616 Record.AddStmt(VE);
6617 for (auto *E : C->private_copies())
6618 Record.AddStmt(E);
6619 for (auto *E : C->source_exprs())
6620 Record.AddStmt(E);
6621 for (auto *E : C->destination_exprs())
6622 Record.AddStmt(E);
6623 for (auto *E : C->assignment_ops())
6624 Record.AddStmt(E);
6625}
6626
6627void OMPClauseWriter::VisitOMPSharedClause(OMPSharedClause *C) {
6628 Record.push_back(C->varlist_size());
6629 Record.AddSourceLocation(C->getLParenLoc());
6630 for (auto *VE : C->varlists())
6631 Record.AddStmt(VE);
6632}
6633
6634void OMPClauseWriter::VisitOMPReductionClause(OMPReductionClause *C) {
6635 Record.push_back(C->varlist_size());
6636 VisitOMPClauseWithPostUpdate(C);
6637 Record.AddSourceLocation(C->getLParenLoc());
6638 Record.AddSourceLocation(C->getColonLoc());
6639 Record.AddNestedNameSpecifierLoc(C->getQualifierLoc());
6640 Record.AddDeclarationNameInfo(C->getNameInfo());
6641 for (auto *VE : C->varlists())
6642 Record.AddStmt(VE);
6643 for (auto *VE : C->privates())
6644 Record.AddStmt(VE);
6645 for (auto *E : C->lhs_exprs())
6646 Record.AddStmt(E);
6647 for (auto *E : C->rhs_exprs())
6648 Record.AddStmt(E);
6649 for (auto *E : C->reduction_ops())
6650 Record.AddStmt(E);
6651}
6652
6653void OMPClauseWriter::VisitOMPTaskReductionClause(OMPTaskReductionClause *C) {
6654 Record.push_back(C->varlist_size());
6655 VisitOMPClauseWithPostUpdate(C);
6656 Record.AddSourceLocation(C->getLParenLoc());
6657 Record.AddSourceLocation(C->getColonLoc());
6658 Record.AddNestedNameSpecifierLoc(C->getQualifierLoc());
6659 Record.AddDeclarationNameInfo(C->getNameInfo());
6660 for (auto *VE : C->varlists())
6661 Record.AddStmt(VE);
6662 for (auto *VE : C->privates())
6663 Record.AddStmt(VE);
6664 for (auto *E : C->lhs_exprs())
6665 Record.AddStmt(E);
6666 for (auto *E : C->rhs_exprs())
6667 Record.AddStmt(E);
6668 for (auto *E : C->reduction_ops())
6669 Record.AddStmt(E);
6670}
6671
6672void OMPClauseWriter::VisitOMPInReductionClause(OMPInReductionClause *C) {
6673 Record.push_back(C->varlist_size());
6674 VisitOMPClauseWithPostUpdate(C);
6675 Record.AddSourceLocation(C->getLParenLoc());
6676 Record.AddSourceLocation(C->getColonLoc());
6677 Record.AddNestedNameSpecifierLoc(C->getQualifierLoc());
6678 Record.AddDeclarationNameInfo(C->getNameInfo());
6679 for (auto *VE : C->varlists())
6680 Record.AddStmt(VE);
6681 for (auto *VE : C->privates())
6682 Record.AddStmt(VE);
6683 for (auto *E : C->lhs_exprs())
6684 Record.AddStmt(E);
6685 for (auto *E : C->rhs_exprs())
6686 Record.AddStmt(E);
6687 for (auto *E : C->reduction_ops())
6688 Record.AddStmt(E);
6689 for (auto *E : C->taskgroup_descriptors())
6690 Record.AddStmt(E);
6691}
6692
6693void OMPClauseWriter::VisitOMPLinearClause(OMPLinearClause *C) {
6694 Record.push_back(C->varlist_size());
6695 VisitOMPClauseWithPostUpdate(C);
6696 Record.AddSourceLocation(C->getLParenLoc());
6697 Record.AddSourceLocation(C->getColonLoc());
6698 Record.push_back(C->getModifier());
6699 Record.AddSourceLocation(C->getModifierLoc());
6700 for (auto *VE : C->varlists()) {
6701 Record.AddStmt(VE);
6702 }
6703 for (auto *VE : C->privates()) {
6704 Record.AddStmt(VE);
6705 }
6706 for (auto *VE : C->inits()) {
6707 Record.AddStmt(VE);
6708 }
6709 for (auto *VE : C->updates()) {
6710 Record.AddStmt(VE);
6711 }
6712 for (auto *VE : C->finals()) {
6713 Record.AddStmt(VE);
6714 }
6715 Record.AddStmt(C->getStep());
6716 Record.AddStmt(C->getCalcStep());
6717}
6718
6719void OMPClauseWriter::VisitOMPAlignedClause(OMPAlignedClause *C) {
6720 Record.push_back(C->varlist_size());
6721 Record.AddSourceLocation(C->getLParenLoc());
6722 Record.AddSourceLocation(C->getColonLoc());
6723 for (auto *VE : C->varlists())
6724 Record.AddStmt(VE);
6725 Record.AddStmt(C->getAlignment());
6726}
6727
6728void OMPClauseWriter::VisitOMPCopyinClause(OMPCopyinClause *C) {
6729 Record.push_back(C->varlist_size());
6730 Record.AddSourceLocation(C->getLParenLoc());
6731 for (auto *VE : C->varlists())
6732 Record.AddStmt(VE);
6733 for (auto *E : C->source_exprs())
6734 Record.AddStmt(E);
6735 for (auto *E : C->destination_exprs())
6736 Record.AddStmt(E);
6737 for (auto *E : C->assignment_ops())
6738 Record.AddStmt(E);
6739}
6740
6741void OMPClauseWriter::VisitOMPCopyprivateClause(OMPCopyprivateClause *C) {
6742 Record.push_back(C->varlist_size());
6743 Record.AddSourceLocation(C->getLParenLoc());
6744 for (auto *VE : C->varlists())
6745 Record.AddStmt(VE);
6746 for (auto *E : C->source_exprs())
6747 Record.AddStmt(E);
6748 for (auto *E : C->destination_exprs())
6749 Record.AddStmt(E);
6750 for (auto *E : C->assignment_ops())
6751 Record.AddStmt(E);
6752}
6753
6754void OMPClauseWriter::VisitOMPFlushClause(OMPFlushClause *C) {
6755 Record.push_back(C->varlist_size());
6756 Record.AddSourceLocation(C->getLParenLoc());
6757 for (auto *VE : C->varlists())
6758 Record.AddStmt(VE);
6759}
6760
6761void OMPClauseWriter::VisitOMPDependClause(OMPDependClause *C) {
6762 Record.push_back(C->varlist_size());
6763 Record.push_back(C->getNumLoops());
6764 Record.AddSourceLocation(C->getLParenLoc());
6765 Record.push_back(C->getDependencyKind());
6766 Record.AddSourceLocation(C->getDependencyLoc());
6767 Record.AddSourceLocation(C->getColonLoc());
6768 for (auto *VE : C->varlists())
6769 Record.AddStmt(VE);
6770 for (unsigned I = 0, E = C->getNumLoops(); I < E; ++I)
6771 Record.AddStmt(C->getLoopData(I));
6772}
6773
6774void OMPClauseWriter::VisitOMPDeviceClause(OMPDeviceClause *C) {
6775 VisitOMPClauseWithPreInit(C);
6776 Record.AddStmt(C->getDevice());
6777 Record.AddSourceLocation(C->getLParenLoc());
6778}
6779
6780void OMPClauseWriter::VisitOMPMapClause(OMPMapClause *C) {
6781 Record.push_back(C->varlist_size());
6782 Record.push_back(C->getUniqueDeclarationsNum());
6783 Record.push_back(C->getTotalComponentListNum());
6784 Record.push_back(C->getTotalComponentsNum());
6785 Record.AddSourceLocation(C->getLParenLoc());
6786 Record.push_back(C->getMapTypeModifier());
6787 Record.push_back(C->getMapType());
6788 Record.AddSourceLocation(C->getMapLoc());
6789 Record.AddSourceLocation(C->getColonLoc());
6790 for (auto *E : C->varlists())
6791 Record.AddStmt(E);
6792 for (auto *D : C->all_decls())
6793 Record.AddDeclRef(D);
6794 for (auto N : C->all_num_lists())
6795 Record.push_back(N);
6796 for (auto N : C->all_lists_sizes())
6797 Record.push_back(N);
6798 for (auto &M : C->all_components()) {
6799 Record.AddStmt(M.getAssociatedExpression());
6800 Record.AddDeclRef(M.getAssociatedDeclaration());
6801 }
6802}
6803
6804void OMPClauseWriter::VisitOMPNumTeamsClause(OMPNumTeamsClause *C) {
6805 VisitOMPClauseWithPreInit(C);
6806 Record.AddStmt(C->getNumTeams());
6807 Record.AddSourceLocation(C->getLParenLoc());
6808}
6809
6810void OMPClauseWriter::VisitOMPThreadLimitClause(OMPThreadLimitClause *C) {
6811 VisitOMPClauseWithPreInit(C);
6812 Record.AddStmt(C->getThreadLimit());
6813 Record.AddSourceLocation(C->getLParenLoc());
6814}
6815
6816void OMPClauseWriter::VisitOMPPriorityClause(OMPPriorityClause *C) {
6817 Record.AddStmt(C->getPriority());
6818 Record.AddSourceLocation(C->getLParenLoc());
6819}
6820
6821void OMPClauseWriter::VisitOMPGrainsizeClause(OMPGrainsizeClause *C) {
6822 Record.AddStmt(C->getGrainsize());
6823 Record.AddSourceLocation(C->getLParenLoc());
6824}
6825
6826void OMPClauseWriter::VisitOMPNumTasksClause(OMPNumTasksClause *C) {
6827 Record.AddStmt(C->getNumTasks());
6828 Record.AddSourceLocation(C->getLParenLoc());
6829}
6830
6831void OMPClauseWriter::VisitOMPHintClause(OMPHintClause *C) {
6832 Record.AddStmt(C->getHint());
6833 Record.AddSourceLocation(C->getLParenLoc());
6834}
6835
6836void OMPClauseWriter::VisitOMPDistScheduleClause(OMPDistScheduleClause *C) {
6837 VisitOMPClauseWithPreInit(C);
6838 Record.push_back(C->getDistScheduleKind());
6839 Record.AddStmt(C->getChunkSize());
6840 Record.AddSourceLocation(C->getLParenLoc());
6841 Record.AddSourceLocation(C->getDistScheduleKindLoc());
6842 Record.AddSourceLocation(C->getCommaLoc());
6843}
6844
6845void OMPClauseWriter::VisitOMPDefaultmapClause(OMPDefaultmapClause *C) {
6846 Record.push_back(C->getDefaultmapKind());
6847 Record.push_back(C->getDefaultmapModifier());
6848 Record.AddSourceLocation(C->getLParenLoc());
6849 Record.AddSourceLocation(C->getDefaultmapModifierLoc());
6850 Record.AddSourceLocation(C->getDefaultmapKindLoc());
6851}
6852
6853void OMPClauseWriter::VisitOMPToClause(OMPToClause *C) {
6854 Record.push_back(C->varlist_size());
6855 Record.push_back(C->getUniqueDeclarationsNum());
6856 Record.push_back(C->getTotalComponentListNum());
6857 Record.push_back(C->getTotalComponentsNum());
6858 Record.AddSourceLocation(C->getLParenLoc());
6859 for (auto *E : C->varlists())
6860 Record.AddStmt(E);
6861 for (auto *D : C->all_decls())
6862 Record.AddDeclRef(D);
6863 for (auto N : C->all_num_lists())
6864 Record.push_back(N);
6865 for (auto N : C->all_lists_sizes())
6866 Record.push_back(N);
6867 for (auto &M : C->all_components()) {
6868 Record.AddStmt(M.getAssociatedExpression());
6869 Record.AddDeclRef(M.getAssociatedDeclaration());
6870 }
6871}
6872
6873void OMPClauseWriter::VisitOMPFromClause(OMPFromClause *C) {
6874 Record.push_back(C->varlist_size());
6875 Record.push_back(C->getUniqueDeclarationsNum());
6876 Record.push_back(C->getTotalComponentListNum());
6877 Record.push_back(C->getTotalComponentsNum());
6878 Record.AddSourceLocation(C->getLParenLoc());
6879 for (auto *E : C->varlists())
6880 Record.AddStmt(E);
6881 for (auto *D : C->all_decls())
6882 Record.AddDeclRef(D);
6883 for (auto N : C->all_num_lists())
6884 Record.push_back(N);
6885 for (auto N : C->all_lists_sizes())
6886 Record.push_back(N);
6887 for (auto &M : C->all_components()) {
6888 Record.AddStmt(M.getAssociatedExpression());
6889 Record.AddDeclRef(M.getAssociatedDeclaration());
6890 }
6891}
6892
6893void OMPClauseWriter::VisitOMPUseDevicePtrClause(OMPUseDevicePtrClause *C) {
6894 Record.push_back(C->varlist_size());
6895 Record.push_back(C->getUniqueDeclarationsNum());
6896 Record.push_back(C->getTotalComponentListNum());
6897 Record.push_back(C->getTotalComponentsNum());
6898 Record.AddSourceLocation(C->getLParenLoc());
6899 for (auto *E : C->varlists())
6900 Record.AddStmt(E);
6901 for (auto *VE : C->private_copies())
6902 Record.AddStmt(VE);
6903 for (auto *VE : C->inits())
6904 Record.AddStmt(VE);
6905 for (auto *D : C->all_decls())
6906 Record.AddDeclRef(D);
6907 for (auto N : C->all_num_lists())
6908 Record.push_back(N);
6909 for (auto N : C->all_lists_sizes())
6910 Record.push_back(N);
6911 for (auto &M : C->all_components()) {
6912 Record.AddStmt(M.getAssociatedExpression());
6913 Record.AddDeclRef(M.getAssociatedDeclaration());
6914 }
6915}
6916
6917void OMPClauseWriter::VisitOMPIsDevicePtrClause(OMPIsDevicePtrClause *C) {
6918 Record.push_back(C->varlist_size());
6919 Record.push_back(C->getUniqueDeclarationsNum());
6920 Record.push_back(C->getTotalComponentListNum());
6921 Record.push_back(C->getTotalComponentsNum());
6922 Record.AddSourceLocation(C->getLParenLoc());
6923 for (auto *E : C->varlists())
6924 Record.AddStmt(E);
6925 for (auto *D : C->all_decls())
6926 Record.AddDeclRef(D);
6927 for (auto N : C->all_num_lists())
6928 Record.push_back(N);
6929 for (auto N : C->all_lists_sizes())
6930 Record.push_back(N);
6931 for (auto &M : C->all_components()) {
6932 Record.AddStmt(M.getAssociatedExpression());
6933 Record.AddDeclRef(M.getAssociatedDeclaration());
6934 }
6935}
Kelvin Li1408f912018-09-26 04:28:39 +00006936
6937void OMPClauseWriter::VisitOMPUnifiedAddressClause(OMPUnifiedAddressClause *) {}
Patrick Lyster4a370b92018-10-01 13:47:43 +00006938
6939void OMPClauseWriter::VisitOMPUnifiedSharedMemoryClause(
6940 OMPUnifiedSharedMemoryClause *) {}
Patrick Lyster6bdf63b2018-10-03 20:07:58 +00006941
6942void OMPClauseWriter::VisitOMPReverseOffloadClause(OMPReverseOffloadClause *) {}
Patrick Lyster3fe9e392018-10-11 14:41:10 +00006943
6944void
6945OMPClauseWriter::VisitOMPDynamicAllocatorsClause(OMPDynamicAllocatorsClause *) {
6946}
Patrick Lyster7a2a27c2018-11-02 12:18:11 +00006947
6948void OMPClauseWriter::VisitOMPAtomicDefaultMemOrderClause(
6949 OMPAtomicDefaultMemOrderClause *C) {
6950 Record.push_back(C->getAtomicDefaultMemOrderKind());
6951 Record.AddSourceLocation(C->getLParenLoc());
6952 Record.AddSourceLocation(C->getAtomicDefaultMemOrderKindKwLoc());
6953}