blob: 3e6400785fdecc34b8c009a69eca523028e321d1 [file] [log] [blame]
Duncan P. N. Exon Smithd9901ff2015-02-02 18:53:21 +00001//===- DebugInfoMetadata.cpp - Implement debug info metadata --------------===//
2//
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//
10// This file implements the debug info Metadata classes.
11//
12//===----------------------------------------------------------------------===//
13
14#include "llvm/IR/DebugInfoMetadata.h"
15#include "LLVMContextImpl.h"
16#include "MetadataImpl.h"
Duncan P. N. Exon Smith5261e4b2015-04-07 01:21:40 +000017#include "llvm/ADT/StringSwitch.h"
Duncan P. N. Exon Smithdf523492015-02-18 20:32:57 +000018#include "llvm/IR/Function.h"
Duncan P. N. Exon Smithd9901ff2015-02-02 18:53:21 +000019
20using namespace llvm;
21
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +000022DILocation::DILocation(LLVMContext &C, StorageType Storage, unsigned Line,
Duncan P. N. Exon Smithd9901ff2015-02-02 18:53:21 +000023 unsigned Column, ArrayRef<Metadata *> MDs)
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +000024 : MDNode(C, DILocationKind, Storage, MDs) {
Duncan P. N. Exon Smithd9901ff2015-02-02 18:53:21 +000025 assert((MDs.size() == 1 || MDs.size() == 2) &&
26 "Expected a scope and optional inlined-at");
27
28 // Set line and column.
Duncan P. N. Exon Smithd9901ff2015-02-02 18:53:21 +000029 assert(Column < (1u << 16) && "Expected 16-bit column");
30
31 SubclassData32 = Line;
32 SubclassData16 = Column;
33}
34
Duncan P. N. Exon Smithd9901ff2015-02-02 18:53:21 +000035static void adjustColumn(unsigned &Column) {
36 // Set to unknown on overflow. We only have 16 bits to play with here.
37 if (Column >= (1u << 16))
38 Column = 0;
39}
40
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +000041DILocation *DILocation::getImpl(LLVMContext &Context, unsigned Line,
Duncan P. N. Exon Smithd9901ff2015-02-02 18:53:21 +000042 unsigned Column, Metadata *Scope,
43 Metadata *InlinedAt, StorageType Storage,
44 bool ShouldCreate) {
Duncan P. N. Exon Smithaf677eb2015-02-06 22:50:13 +000045 // Fixup column.
Duncan P. N. Exon Smithd9901ff2015-02-02 18:53:21 +000046 adjustColumn(Column);
47
Duncan P. N. Exon Smithe2c61d92015-03-27 17:56:39 +000048 assert(Scope && "Expected scope");
Duncan P. N. Exon Smithd9901ff2015-02-02 18:53:21 +000049 if (Storage == Uniqued) {
50 if (auto *N =
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +000051 getUniqued(Context.pImpl->DILocations,
52 DILocationInfo::KeyTy(Line, Column, Scope, InlinedAt)))
Duncan P. N. Exon Smithd9901ff2015-02-02 18:53:21 +000053 return N;
54 if (!ShouldCreate)
55 return nullptr;
56 } else {
57 assert(ShouldCreate && "Expected non-uniqued nodes to always be created");
58 }
59
60 SmallVector<Metadata *, 2> Ops;
61 Ops.push_back(Scope);
62 if (InlinedAt)
63 Ops.push_back(InlinedAt);
64 return storeImpl(new (Ops.size())
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +000065 DILocation(Context, Storage, Line, Column, Ops),
66 Storage, Context.pImpl->DILocations);
Duncan P. N. Exon Smithd9901ff2015-02-02 18:53:21 +000067}
68
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +000069unsigned DINode::getFlag(StringRef Flag) {
Duncan P. N. Exon Smith5261e4b2015-04-07 01:21:40 +000070 return StringSwitch<unsigned>(Flag)
71#define HANDLE_DI_FLAG(ID, NAME) .Case("DIFlag" #NAME, Flag##NAME)
72#include "llvm/IR/DebugInfoFlags.def"
73 .Default(0);
74}
75
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +000076const char *DINode::getFlagString(unsigned Flag) {
Duncan P. N. Exon Smith5261e4b2015-04-07 01:21:40 +000077 switch (Flag) {
78 default:
79 return "";
80#define HANDLE_DI_FLAG(ID, NAME) \
81 case Flag##NAME: \
82 return "DIFlag" #NAME;
83#include "llvm/IR/DebugInfoFlags.def"
84 }
85}
86
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +000087unsigned DINode::splitFlags(unsigned Flags,
88 SmallVectorImpl<unsigned> &SplitFlags) {
Duncan P. N. Exon Smith5261e4b2015-04-07 01:21:40 +000089 // Accessibility flags need to be specially handled, since they're packed
90 // together.
91 if (unsigned A = Flags & FlagAccessibility) {
92 if (A == FlagPrivate)
93 SplitFlags.push_back(FlagPrivate);
94 else if (A == FlagProtected)
95 SplitFlags.push_back(FlagProtected);
96 else
97 SplitFlags.push_back(FlagPublic);
98 Flags &= ~A;
99 }
100
101#define HANDLE_DI_FLAG(ID, NAME) \
102 if (unsigned Bit = Flags & ID) { \
103 SplitFlags.push_back(Bit); \
104 Flags &= ~Bit; \
105 }
106#include "llvm/IR/DebugInfoFlags.def"
107
108 return Flags;
109}
110
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000111DIScopeRef DIScope::getScope() const {
112 if (auto *T = dyn_cast<DIType>(this))
Duncan P. N. Exon Smithf0d81a52015-04-11 17:37:23 +0000113 return T->getScope();
114
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000115 if (auto *SP = dyn_cast<DISubprogram>(this))
Duncan P. N. Exon Smithf0d81a52015-04-11 17:37:23 +0000116 return SP->getScope();
117
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000118 if (auto *LB = dyn_cast<DILexicalBlockBase>(this))
119 return DIScopeRef(LB->getScope());
Duncan P. N. Exon Smithf0d81a52015-04-11 17:37:23 +0000120
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000121 if (auto *NS = dyn_cast<DINamespace>(this))
122 return DIScopeRef(NS->getScope());
Duncan P. N. Exon Smithf0d81a52015-04-11 17:37:23 +0000123
Adrian Prantlab1243f2015-06-29 23:03:47 +0000124 if (auto *M = dyn_cast<DIModule>(this))
125 return DIScopeRef(M->getScope());
126
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000127 assert((isa<DIFile>(this) || isa<DICompileUnit>(this)) &&
Duncan P. N. Exon Smithf0d81a52015-04-11 17:37:23 +0000128 "Unhandled type of scope.");
129 return nullptr;
130}
131
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000132StringRef DIScope::getName() const {
133 if (auto *T = dyn_cast<DIType>(this))
Duncan P. N. Exon Smithf0d81a52015-04-11 17:37:23 +0000134 return T->getName();
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000135 if (auto *SP = dyn_cast<DISubprogram>(this))
Duncan P. N. Exon Smithf0d81a52015-04-11 17:37:23 +0000136 return SP->getName();
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000137 if (auto *NS = dyn_cast<DINamespace>(this))
Duncan P. N. Exon Smithf0d81a52015-04-11 17:37:23 +0000138 return NS->getName();
Adrian Prantlab1243f2015-06-29 23:03:47 +0000139 if (auto *M = dyn_cast<DIModule>(this))
140 return M->getName();
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000141 assert((isa<DILexicalBlockBase>(this) || isa<DIFile>(this) ||
142 isa<DICompileUnit>(this)) &&
Duncan P. N. Exon Smithf0d81a52015-04-11 17:37:23 +0000143 "Unhandled type of scope.");
144 return "";
145}
Duncan P. N. Exon Smith5261e4b2015-04-07 01:21:40 +0000146
Duncan P. N. Exon Smithc7e08132015-02-02 20:20:56 +0000147#ifndef NDEBUG
Duncan P. N. Exon Smith9146fc82015-02-02 20:01:03 +0000148static bool isCanonical(const MDString *S) {
149 return !S || !S->getString().empty();
Duncan P. N. Exon Smith442ec022015-02-02 19:54:05 +0000150}
Duncan P. N. Exon Smithc7e08132015-02-02 20:20:56 +0000151#endif
Duncan P. N. Exon Smith442ec022015-02-02 19:54:05 +0000152
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000153GenericDINode *GenericDINode::getImpl(LLVMContext &Context, unsigned Tag,
154 MDString *Header,
155 ArrayRef<Metadata *> DwarfOps,
156 StorageType Storage, bool ShouldCreate) {
Duncan P. N. Exon Smithd9901ff2015-02-02 18:53:21 +0000157 unsigned Hash = 0;
158 if (Storage == Uniqued) {
Mehdi Amini5d99c4e2016-03-19 01:02:34 +0000159 GenericDINodeInfo::KeyTy Key(Tag, Header, DwarfOps);
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000160 if (auto *N = getUniqued(Context.pImpl->GenericDINodes, Key))
Duncan P. N. Exon Smithd9901ff2015-02-02 18:53:21 +0000161 return N;
162 if (!ShouldCreate)
163 return nullptr;
164 Hash = Key.getHash();
165 } else {
166 assert(ShouldCreate && "Expected non-uniqued nodes to always be created");
167 }
168
169 // Use a nullptr for empty headers.
Duncan P. N. Exon Smith9146fc82015-02-02 20:01:03 +0000170 assert(isCanonical(Header) && "Expected canonical MDString");
171 Metadata *PreOps[] = {Header};
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000172 return storeImpl(new (DwarfOps.size() + 1) GenericDINode(
Duncan P. N. Exon Smithd9901ff2015-02-02 18:53:21 +0000173 Context, Storage, Hash, Tag, PreOps, DwarfOps),
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000174 Storage, Context.pImpl->GenericDINodes);
Duncan P. N. Exon Smithd9901ff2015-02-02 18:53:21 +0000175}
176
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000177void GenericDINode::recalculateHash() {
178 setHash(GenericDINodeInfo::KeyTy::calculateHash(this));
Duncan P. N. Exon Smithd9901ff2015-02-02 18:53:21 +0000179}
Duncan P. N. Exon Smith01fc1762015-02-10 00:52:32 +0000180
181#define UNWRAP_ARGS_IMPL(...) __VA_ARGS__
182#define UNWRAP_ARGS(ARGS) UNWRAP_ARGS_IMPL ARGS
183#define DEFINE_GETIMPL_LOOKUP(CLASS, ARGS) \
184 do { \
185 if (Storage == Uniqued) { \
186 if (auto *N = getUniqued(Context.pImpl->CLASS##s, \
187 CLASS##Info::KeyTy(UNWRAP_ARGS(ARGS)))) \
188 return N; \
189 if (!ShouldCreate) \
190 return nullptr; \
191 } else { \
192 assert(ShouldCreate && \
193 "Expected non-uniqued nodes to always be created"); \
194 } \
195 } while (false)
196#define DEFINE_GETIMPL_STORE(CLASS, ARGS, OPS) \
David Blaikie6662d6a2016-04-13 17:42:56 +0000197 return storeImpl(new (array_lengthof(OPS)) \
Duncan P. N. Exon Smith01fc1762015-02-10 00:52:32 +0000198 CLASS(Context, Storage, UNWRAP_ARGS(ARGS), OPS), \
199 Storage, Context.pImpl->CLASS##s)
200#define DEFINE_GETIMPL_STORE_NO_OPS(CLASS, ARGS) \
201 return storeImpl(new (0u) CLASS(Context, Storage, UNWRAP_ARGS(ARGS)), \
202 Storage, Context.pImpl->CLASS##s)
Duncan P. N. Exon Smithbd33d372015-02-10 01:59:57 +0000203#define DEFINE_GETIMPL_STORE_NO_CONSTRUCTOR_ARGS(CLASS, OPS) \
David Blaikie6662d6a2016-04-13 17:42:56 +0000204 return storeImpl(new (array_lengthof(OPS)) CLASS(Context, Storage, OPS), \
Duncan P. N. Exon Smithbd33d372015-02-10 01:59:57 +0000205 Storage, Context.pImpl->CLASS##s)
Duncan P. N. Exon Smith01fc1762015-02-10 00:52:32 +0000206
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000207DISubrange *DISubrange::getImpl(LLVMContext &Context, int64_t Count, int64_t Lo,
Duncan P. N. Exon Smith01fc1762015-02-10 00:52:32 +0000208 StorageType Storage, bool ShouldCreate) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000209 DEFINE_GETIMPL_LOOKUP(DISubrange, (Count, Lo));
210 DEFINE_GETIMPL_STORE_NO_OPS(DISubrange, (Count, Lo));
Duncan P. N. Exon Smith01fc1762015-02-10 00:52:32 +0000211}
212
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000213DIEnumerator *DIEnumerator::getImpl(LLVMContext &Context, int64_t Value,
Duncan P. N. Exon Smith01fc1762015-02-10 00:52:32 +0000214 MDString *Name, StorageType Storage,
215 bool ShouldCreate) {
216 assert(isCanonical(Name) && "Expected canonical MDString");
Mehdi Amini5d99c4e2016-03-19 01:02:34 +0000217 DEFINE_GETIMPL_LOOKUP(DIEnumerator, (Value, Name));
Duncan P. N. Exon Smith01fc1762015-02-10 00:52:32 +0000218 Metadata *Ops[] = {Name};
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000219 DEFINE_GETIMPL_STORE(DIEnumerator, (Value), Ops);
Duncan P. N. Exon Smith01fc1762015-02-10 00:52:32 +0000220}
221
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000222DIBasicType *DIBasicType::getImpl(LLVMContext &Context, unsigned Tag,
Duncan P. N. Exon Smithd34db172015-02-19 23:56:07 +0000223 MDString *Name, uint64_t SizeInBits,
224 uint64_t AlignInBits, unsigned Encoding,
Duncan P. N. Exon Smith01fc1762015-02-10 00:52:32 +0000225 StorageType Storage, bool ShouldCreate) {
226 assert(isCanonical(Name) && "Expected canonical MDString");
Mehdi Amini5d99c4e2016-03-19 01:02:34 +0000227 DEFINE_GETIMPL_LOOKUP(DIBasicType,
228 (Tag, Name, SizeInBits, AlignInBits, Encoding));
Duncan P. N. Exon Smith01fc1762015-02-10 00:52:32 +0000229 Metadata *Ops[] = {nullptr, nullptr, Name};
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000230 DEFINE_GETIMPL_STORE(DIBasicType, (Tag, SizeInBits, AlignInBits, Encoding),
Duncan P. N. Exon Smith01fc1762015-02-10 00:52:32 +0000231 Ops);
232}
233
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000234DIDerivedType *DIDerivedType::getImpl(
Duncan P. N. Exon Smith01fc1762015-02-10 00:52:32 +0000235 LLVMContext &Context, unsigned Tag, MDString *Name, Metadata *File,
Duncan P. N. Exon Smithd34db172015-02-19 23:56:07 +0000236 unsigned Line, Metadata *Scope, Metadata *BaseType, uint64_t SizeInBits,
237 uint64_t AlignInBits, uint64_t OffsetInBits, unsigned Flags,
Duncan P. N. Exon Smith01fc1762015-02-10 00:52:32 +0000238 Metadata *ExtraData, StorageType Storage, bool ShouldCreate) {
239 assert(isCanonical(Name) && "Expected canonical MDString");
Mehdi Amini5d99c4e2016-03-19 01:02:34 +0000240 DEFINE_GETIMPL_LOOKUP(DIDerivedType,
241 (Tag, Name, File, Line, Scope, BaseType, SizeInBits,
242 AlignInBits, OffsetInBits, Flags, ExtraData));
Duncan P. N. Exon Smith01fc1762015-02-10 00:52:32 +0000243 Metadata *Ops[] = {File, Scope, Name, BaseType, ExtraData};
244 DEFINE_GETIMPL_STORE(
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000245 DIDerivedType, (Tag, Line, SizeInBits, AlignInBits, OffsetInBits, Flags),
Duncan P. N. Exon Smith01fc1762015-02-10 00:52:32 +0000246 Ops);
247}
248
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000249DICompositeType *DICompositeType::getImpl(
Duncan P. N. Exon Smith01fc1762015-02-10 00:52:32 +0000250 LLVMContext &Context, unsigned Tag, MDString *Name, Metadata *File,
Duncan P. N. Exon Smithd34db172015-02-19 23:56:07 +0000251 unsigned Line, Metadata *Scope, Metadata *BaseType, uint64_t SizeInBits,
252 uint64_t AlignInBits, uint64_t OffsetInBits, unsigned Flags,
Duncan P. N. Exon Smith01fc1762015-02-10 00:52:32 +0000253 Metadata *Elements, unsigned RuntimeLang, Metadata *VTableHolder,
254 Metadata *TemplateParams, MDString *Identifier, StorageType Storage,
255 bool ShouldCreate) {
256 assert(isCanonical(Name) && "Expected canonical MDString");
Duncan P. N. Exon Smith5ab2be02016-04-17 03:58:21 +0000257
Mehdi Amini5d99c4e2016-03-19 01:02:34 +0000258 DEFINE_GETIMPL_LOOKUP(
259 DICompositeType, (Tag, Name, File, Line, Scope, BaseType, SizeInBits,
260 AlignInBits, OffsetInBits, Flags, Elements, RuntimeLang,
261 VTableHolder, TemplateParams, Identifier));
Duncan P. N. Exon Smith01fc1762015-02-10 00:52:32 +0000262 Metadata *Ops[] = {File, Scope, Name, BaseType,
263 Elements, VTableHolder, TemplateParams, Identifier};
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000264 DEFINE_GETIMPL_STORE(DICompositeType, (Tag, Line, RuntimeLang, SizeInBits,
Duncan P. N. Exon Smith01fc1762015-02-10 00:52:32 +0000265 AlignInBits, OffsetInBits, Flags),
266 Ops);
267}
268
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000269DISubroutineType *DISubroutineType::getImpl(LLVMContext &Context,
Duncan P. N. Exon Smith01fc1762015-02-10 00:52:32 +0000270 unsigned Flags, Metadata *TypeArray,
271 StorageType Storage,
272 bool ShouldCreate) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000273 DEFINE_GETIMPL_LOOKUP(DISubroutineType, (Flags, TypeArray));
Duncan P. N. Exon Smithb9e045a2015-07-24 20:56:36 +0000274 Metadata *Ops[] = {nullptr, nullptr, nullptr, TypeArray};
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000275 DEFINE_GETIMPL_STORE(DISubroutineType, (Flags), Ops);
Duncan P. N. Exon Smith01fc1762015-02-10 00:52:32 +0000276}
277
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000278DIFile *DIFile::getImpl(LLVMContext &Context, MDString *Filename,
Duncan P. N. Exon Smith01fc1762015-02-10 00:52:32 +0000279 MDString *Directory, StorageType Storage,
280 bool ShouldCreate) {
281 assert(isCanonical(Filename) && "Expected canonical MDString");
282 assert(isCanonical(Directory) && "Expected canonical MDString");
Mehdi Amini5d99c4e2016-03-19 01:02:34 +0000283 DEFINE_GETIMPL_LOOKUP(DIFile, (Filename, Directory));
Duncan P. N. Exon Smitha5c57cc2015-02-20 20:35:17 +0000284 Metadata *Ops[] = {Filename, Directory};
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000285 DEFINE_GETIMPL_STORE_NO_CONSTRUCTOR_ARGS(DIFile, Ops);
Duncan P. N. Exon Smith01fc1762015-02-10 00:52:32 +0000286}
287
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000288DICompileUnit *DICompileUnit::getImpl(
Duncan P. N. Exon Smith01fc1762015-02-10 00:52:32 +0000289 LLVMContext &Context, unsigned SourceLanguage, Metadata *File,
290 MDString *Producer, bool IsOptimized, MDString *Flags,
291 unsigned RuntimeVersion, MDString *SplitDebugFilename,
292 unsigned EmissionKind, Metadata *EnumTypes, Metadata *RetainedTypes,
Adrian Prantl75819ae2016-04-15 15:57:41 +0000293 Metadata *GlobalVariables, Metadata *ImportedEntities, Metadata *Macros,
294 uint64_t DWOId, StorageType Storage, bool ShouldCreate) {
Duncan P. N. Exon Smith55ca9642015-08-03 17:26:41 +0000295 assert(Storage != Uniqued && "Cannot unique DICompileUnit");
Duncan P. N. Exon Smith01fc1762015-02-10 00:52:32 +0000296 assert(isCanonical(Producer) && "Expected canonical MDString");
297 assert(isCanonical(Flags) && "Expected canonical MDString");
298 assert(isCanonical(SplitDebugFilename) && "Expected canonical MDString");
Duncan P. N. Exon Smith55ca9642015-08-03 17:26:41 +0000299
Adrian Prantl75819ae2016-04-15 15:57:41 +0000300 Metadata *Ops[] = {
301 File, Producer, Flags, SplitDebugFilename,
302 EnumTypes, RetainedTypes, GlobalVariables, ImportedEntities,
303 Macros};
David Blaikie6662d6a2016-04-13 17:42:56 +0000304 return storeImpl(new (array_lengthof(Ops)) DICompileUnit(
Duncan P. N. Exon Smith55ca9642015-08-03 17:26:41 +0000305 Context, Storage, SourceLanguage, IsOptimized,
306 RuntimeVersion, EmissionKind, DWOId, Ops),
307 Storage);
Duncan P. N. Exon Smith01fc1762015-02-10 00:52:32 +0000308}
309
Adrian Prantlb939a252016-03-31 23:56:58 +0000310Optional<DICompileUnit::DebugEmissionKind>
311DICompileUnit::getEmissionKind(StringRef Str) {
312 return StringSwitch<Optional<DebugEmissionKind>>(Str)
313 .Case("NoDebug", NoDebug)
314 .Case("FullDebug", FullDebug)
315 .Case("LineTablesOnly", LineTablesOnly)
316 .Default(None);
317}
318
319const char *DICompileUnit::EmissionKindString(DebugEmissionKind EK) {
320 switch (EK) {
321 case NoDebug: return "NoDebug";
322 case FullDebug: return "FullDebug";
323 case LineTablesOnly: return "LineTablesOnly";
324 }
325 return nullptr;
326}
327
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000328DISubprogram *DILocalScope::getSubprogram() const {
329 if (auto *Block = dyn_cast<DILexicalBlockBase>(this))
Duncan P. N. Exon Smithfd07a2a2015-03-30 21:32:28 +0000330 return Block->getScope()->getSubprogram();
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000331 return const_cast<DISubprogram *>(cast<DISubprogram>(this));
Duncan P. N. Exon Smithfd07a2a2015-03-30 21:32:28 +0000332}
333
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000334DISubprogram *DISubprogram::getImpl(
Duncan P. N. Exon Smith01fc1762015-02-10 00:52:32 +0000335 LLVMContext &Context, Metadata *Scope, MDString *Name,
336 MDString *LinkageName, Metadata *File, unsigned Line, Metadata *Type,
337 bool IsLocalToUnit, bool IsDefinition, unsigned ScopeLine,
338 Metadata *ContainingType, unsigned Virtuality, unsigned VirtualIndex,
Adrian Prantl75819ae2016-04-15 15:57:41 +0000339 unsigned Flags, bool IsOptimized, Metadata *Unit, Metadata *TemplateParams,
Peter Collingbourned4bff302015-11-05 22:03:56 +0000340 Metadata *Declaration, Metadata *Variables, StorageType Storage,
341 bool ShouldCreate) {
Duncan P. N. Exon Smith01fc1762015-02-10 00:52:32 +0000342 assert(isCanonical(Name) && "Expected canonical MDString");
343 assert(isCanonical(LinkageName) && "Expected canonical MDString");
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000344 DEFINE_GETIMPL_LOOKUP(DISubprogram,
Mehdi Amini5d99c4e2016-03-19 01:02:34 +0000345 (Scope, Name, LinkageName, File, Line, Type,
346 IsLocalToUnit, IsDefinition, ScopeLine, ContainingType,
Adrian Prantl75819ae2016-04-15 15:57:41 +0000347 Virtuality, VirtualIndex, Flags, IsOptimized, Unit,
Mehdi Amini5d99c4e2016-03-19 01:02:34 +0000348 TemplateParams, Declaration, Variables));
Adrian Prantl75819ae2016-04-15 15:57:41 +0000349 Metadata *Ops[] = {File, Scope, Name, Name,
350 LinkageName, Type, ContainingType, Unit,
351 TemplateParams, Declaration, Variables};
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000352 DEFINE_GETIMPL_STORE(DISubprogram,
Duncan P. N. Exon Smith01fc1762015-02-10 00:52:32 +0000353 (Line, ScopeLine, Virtuality, VirtualIndex, Flags,
354 IsLocalToUnit, IsDefinition, IsOptimized),
355 Ops);
356}
357
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000358bool DISubprogram::describes(const Function *F) const {
Duncan P. N. Exon Smith3c2d7042015-04-13 19:07:27 +0000359 assert(F && "Invalid function");
Peter Collingbourned4bff302015-11-05 22:03:56 +0000360 if (F->getSubprogram() == this)
Duncan P. N. Exon Smith3c2d7042015-04-13 19:07:27 +0000361 return true;
362 StringRef Name = getLinkageName();
363 if (Name.empty())
364 Name = getName();
365 return F->getName() == Name;
366}
367
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000368DILexicalBlock *DILexicalBlock::getImpl(LLVMContext &Context, Metadata *Scope,
Duncan P. N. Exon Smith01fc1762015-02-10 00:52:32 +0000369 Metadata *File, unsigned Line,
370 unsigned Column, StorageType Storage,
371 bool ShouldCreate) {
Duncan P. N. Exon Smithb09eb9f2015-08-28 22:58:50 +0000372 // Fixup column.
373 adjustColumn(Column);
374
Duncan P. N. Exon Smith0e202b92015-03-30 16:37:48 +0000375 assert(Scope && "Expected scope");
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000376 DEFINE_GETIMPL_LOOKUP(DILexicalBlock, (Scope, File, Line, Column));
Duncan P. N. Exon Smith01fc1762015-02-10 00:52:32 +0000377 Metadata *Ops[] = {File, Scope};
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000378 DEFINE_GETIMPL_STORE(DILexicalBlock, (Line, Column), Ops);
Duncan P. N. Exon Smith01fc1762015-02-10 00:52:32 +0000379}
380
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000381DILexicalBlockFile *DILexicalBlockFile::getImpl(LLVMContext &Context,
Duncan P. N. Exon Smith01fc1762015-02-10 00:52:32 +0000382 Metadata *Scope, Metadata *File,
383 unsigned Discriminator,
384 StorageType Storage,
385 bool ShouldCreate) {
Duncan P. N. Exon Smith0e202b92015-03-30 16:37:48 +0000386 assert(Scope && "Expected scope");
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000387 DEFINE_GETIMPL_LOOKUP(DILexicalBlockFile, (Scope, File, Discriminator));
Duncan P. N. Exon Smith01fc1762015-02-10 00:52:32 +0000388 Metadata *Ops[] = {File, Scope};
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000389 DEFINE_GETIMPL_STORE(DILexicalBlockFile, (Discriminator), Ops);
Duncan P. N. Exon Smith01fc1762015-02-10 00:52:32 +0000390}
391
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000392DINamespace *DINamespace::getImpl(LLVMContext &Context, Metadata *Scope,
Duncan P. N. Exon Smith01fc1762015-02-10 00:52:32 +0000393 Metadata *File, MDString *Name, unsigned Line,
394 StorageType Storage, bool ShouldCreate) {
395 assert(isCanonical(Name) && "Expected canonical MDString");
Mehdi Amini5d99c4e2016-03-19 01:02:34 +0000396 DEFINE_GETIMPL_LOOKUP(DINamespace, (Scope, File, Name, Line));
Duncan P. N. Exon Smith01fc1762015-02-10 00:52:32 +0000397 Metadata *Ops[] = {File, Scope, Name};
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000398 DEFINE_GETIMPL_STORE(DINamespace, (Line), Ops);
Duncan P. N. Exon Smith01fc1762015-02-10 00:52:32 +0000399}
400
Adrian Prantlab1243f2015-06-29 23:03:47 +0000401DIModule *DIModule::getImpl(LLVMContext &Context, Metadata *Scope,
402 MDString *Name, MDString *ConfigurationMacros,
403 MDString *IncludePath, MDString *ISysRoot,
404 StorageType Storage, bool ShouldCreate) {
405 assert(isCanonical(Name) && "Expected canonical MDString");
Mehdi Amini5d99c4e2016-03-19 01:02:34 +0000406 DEFINE_GETIMPL_LOOKUP(
407 DIModule, (Scope, Name, ConfigurationMacros, IncludePath, ISysRoot));
Adrian Prantlab1243f2015-06-29 23:03:47 +0000408 Metadata *Ops[] = {Scope, Name, ConfigurationMacros, IncludePath, ISysRoot};
409 DEFINE_GETIMPL_STORE_NO_CONSTRUCTOR_ARGS(DIModule, Ops);
410}
411
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000412DITemplateTypeParameter *DITemplateTypeParameter::getImpl(LLVMContext &Context,
Duncan P. N. Exon Smith3d62bba2015-02-19 00:37:21 +0000413 MDString *Name,
414 Metadata *Type,
415 StorageType Storage,
416 bool ShouldCreate) {
Duncan P. N. Exon Smith01fc1762015-02-10 00:52:32 +0000417 assert(isCanonical(Name) && "Expected canonical MDString");
Mehdi Amini5d99c4e2016-03-19 01:02:34 +0000418 DEFINE_GETIMPL_LOOKUP(DITemplateTypeParameter, (Name, Type));
Duncan P. N. Exon Smith3d62bba2015-02-19 00:37:21 +0000419 Metadata *Ops[] = {Name, Type};
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000420 DEFINE_GETIMPL_STORE_NO_CONSTRUCTOR_ARGS(DITemplateTypeParameter, Ops);
Duncan P. N. Exon Smith01fc1762015-02-10 00:52:32 +0000421}
422
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000423DITemplateValueParameter *DITemplateValueParameter::getImpl(
Duncan P. N. Exon Smith3d62bba2015-02-19 00:37:21 +0000424 LLVMContext &Context, unsigned Tag, MDString *Name, Metadata *Type,
425 Metadata *Value, StorageType Storage, bool ShouldCreate) {
Duncan P. N. Exon Smith01fc1762015-02-10 00:52:32 +0000426 assert(isCanonical(Name) && "Expected canonical MDString");
Mehdi Amini5d99c4e2016-03-19 01:02:34 +0000427 DEFINE_GETIMPL_LOOKUP(DITemplateValueParameter, (Tag, Name, Type, Value));
Duncan P. N. Exon Smith3d62bba2015-02-19 00:37:21 +0000428 Metadata *Ops[] = {Name, Type, Value};
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000429 DEFINE_GETIMPL_STORE(DITemplateValueParameter, (Tag), Ops);
Duncan P. N. Exon Smith01fc1762015-02-10 00:52:32 +0000430}
431
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000432DIGlobalVariable *
433DIGlobalVariable::getImpl(LLVMContext &Context, Metadata *Scope, MDString *Name,
Duncan P. N. Exon Smith01fc1762015-02-10 00:52:32 +0000434 MDString *LinkageName, Metadata *File, unsigned Line,
435 Metadata *Type, bool IsLocalToUnit, bool IsDefinition,
436 Metadata *Variable,
437 Metadata *StaticDataMemberDeclaration,
438 StorageType Storage, bool ShouldCreate) {
439 assert(isCanonical(Name) && "Expected canonical MDString");
440 assert(isCanonical(LinkageName) && "Expected canonical MDString");
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000441 DEFINE_GETIMPL_LOOKUP(DIGlobalVariable,
Mehdi Amini5d99c4e2016-03-19 01:02:34 +0000442 (Scope, Name, LinkageName, File, Line, Type,
443 IsLocalToUnit, IsDefinition, Variable,
Duncan P. N. Exon Smith01fc1762015-02-10 00:52:32 +0000444 StaticDataMemberDeclaration));
445 Metadata *Ops[] = {Scope, Name, File, Type,
446 Name, LinkageName, Variable, StaticDataMemberDeclaration};
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000447 DEFINE_GETIMPL_STORE(DIGlobalVariable, (Line, IsLocalToUnit, IsDefinition),
Duncan P. N. Exon Smith01fc1762015-02-10 00:52:32 +0000448 Ops);
449}
450
Duncan P. N. Exon Smithed013cd2015-07-31 18:58:39 +0000451DILocalVariable *DILocalVariable::getImpl(LLVMContext &Context, Metadata *Scope,
452 MDString *Name, Metadata *File,
453 unsigned Line, Metadata *Type,
454 unsigned Arg, unsigned Flags,
455 StorageType Storage,
Duncan P. N. Exon Smith62e0f452015-04-15 22:29:27 +0000456 bool ShouldCreate) {
Duncan P. N. Exon Smith1ec75ae2015-04-28 01:07:33 +0000457 // 64K ought to be enough for any frontend.
458 assert(Arg <= UINT16_MAX && "Expected argument number to fit in 16-bits");
Duncan P. N. Exon Smith72fe2d02015-02-13 01:39:44 +0000459
Duncan P. N. Exon Smithe2c61d92015-03-27 17:56:39 +0000460 assert(Scope && "Expected scope");
Duncan P. N. Exon Smith01fc1762015-02-10 00:52:32 +0000461 assert(isCanonical(Name) && "Expected canonical MDString");
Duncan P. N. Exon Smithed013cd2015-07-31 18:58:39 +0000462 DEFINE_GETIMPL_LOOKUP(DILocalVariable,
Mehdi Amini5d99c4e2016-03-19 01:02:34 +0000463 (Scope, Name, File, Line, Type, Arg, Flags));
Duncan P. N. Exon Smith62e0f452015-04-15 22:29:27 +0000464 Metadata *Ops[] = {Scope, Name, File, Type};
Duncan P. N. Exon Smithed013cd2015-07-31 18:58:39 +0000465 DEFINE_GETIMPL_STORE(DILocalVariable, (Line, Arg, Flags), Ops);
Duncan P. N. Exon Smith01fc1762015-02-10 00:52:32 +0000466}
467
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000468DIExpression *DIExpression::getImpl(LLVMContext &Context,
Duncan P. N. Exon Smith01fc1762015-02-10 00:52:32 +0000469 ArrayRef<uint64_t> Elements,
470 StorageType Storage, bool ShouldCreate) {
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000471 DEFINE_GETIMPL_LOOKUP(DIExpression, (Elements));
472 DEFINE_GETIMPL_STORE_NO_OPS(DIExpression, (Elements));
Duncan P. N. Exon Smith01fc1762015-02-10 00:52:32 +0000473}
474
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000475unsigned DIExpression::ExprOperand::getSize() const {
Duncan P. N. Exon Smith193a4fd2015-02-13 01:07:46 +0000476 switch (getOp()) {
477 case dwarf::DW_OP_bit_piece:
478 return 3;
479 case dwarf::DW_OP_plus:
Evgeniy Stepanovf6081112015-09-30 19:55:43 +0000480 case dwarf::DW_OP_minus:
Duncan P. N. Exon Smith193a4fd2015-02-13 01:07:46 +0000481 return 2;
482 default:
483 return 1;
484 }
485}
486
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000487bool DIExpression::isValid() const {
Duncan P. N. Exon Smith193a4fd2015-02-13 01:07:46 +0000488 for (auto I = expr_op_begin(), E = expr_op_end(); I != E; ++I) {
489 // Check that there's space for the operand.
490 if (I->get() + I->getSize() > E->get())
491 return false;
492
493 // Check that the operand is valid.
494 switch (I->getOp()) {
495 default:
496 return false;
497 case dwarf::DW_OP_bit_piece:
498 // Piece expressions must be at the end.
499 return I->get() + I->getSize() == E->get();
500 case dwarf::DW_OP_plus:
Evgeniy Stepanovf6081112015-09-30 19:55:43 +0000501 case dwarf::DW_OP_minus:
Duncan P. N. Exon Smith193a4fd2015-02-13 01:07:46 +0000502 case dwarf::DW_OP_deref:
503 break;
504 }
505 }
506 return true;
507}
508
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000509bool DIExpression::isBitPiece() const {
Duncan P. N. Exon Smith86cc3322015-04-07 03:49:59 +0000510 assert(isValid() && "Expected valid expression");
511 if (unsigned N = getNumElements())
512 if (N >= 3)
513 return getElement(N - 3) == dwarf::DW_OP_bit_piece;
514 return false;
515}
516
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000517uint64_t DIExpression::getBitPieceOffset() const {
Duncan P. N. Exon Smith86cc3322015-04-07 03:49:59 +0000518 assert(isBitPiece() && "Expected bit piece");
519 return getElement(getNumElements() - 2);
520}
521
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000522uint64_t DIExpression::getBitPieceSize() const {
Duncan P. N. Exon Smith86cc3322015-04-07 03:49:59 +0000523 assert(isBitPiece() && "Expected bit piece");
524 return getElement(getNumElements() - 1);
525}
526
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000527DIObjCProperty *DIObjCProperty::getImpl(
Duncan P. N. Exon Smith01fc1762015-02-10 00:52:32 +0000528 LLVMContext &Context, MDString *Name, Metadata *File, unsigned Line,
529 MDString *GetterName, MDString *SetterName, unsigned Attributes,
530 Metadata *Type, StorageType Storage, bool ShouldCreate) {
531 assert(isCanonical(Name) && "Expected canonical MDString");
532 assert(isCanonical(GetterName) && "Expected canonical MDString");
533 assert(isCanonical(SetterName) && "Expected canonical MDString");
Mehdi Amini5d99c4e2016-03-19 01:02:34 +0000534 DEFINE_GETIMPL_LOOKUP(DIObjCProperty, (Name, File, Line, GetterName,
535 SetterName, Attributes, Type));
Duncan P. N. Exon Smith01fc1762015-02-10 00:52:32 +0000536 Metadata *Ops[] = {Name, File, GetterName, SetterName, Type};
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000537 DEFINE_GETIMPL_STORE(DIObjCProperty, (Line, Attributes), Ops);
Duncan P. N. Exon Smith01fc1762015-02-10 00:52:32 +0000538}
539
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000540DIImportedEntity *DIImportedEntity::getImpl(LLVMContext &Context, unsigned Tag,
Duncan P. N. Exon Smith01fc1762015-02-10 00:52:32 +0000541 Metadata *Scope, Metadata *Entity,
542 unsigned Line, MDString *Name,
543 StorageType Storage,
544 bool ShouldCreate) {
545 assert(isCanonical(Name) && "Expected canonical MDString");
Mehdi Amini5d99c4e2016-03-19 01:02:34 +0000546 DEFINE_GETIMPL_LOOKUP(DIImportedEntity, (Tag, Scope, Entity, Line, Name));
Duncan P. N. Exon Smith01fc1762015-02-10 00:52:32 +0000547 Metadata *Ops[] = {Scope, Entity, Name};
Duncan P. N. Exon Smitha9308c42015-04-29 16:38:44 +0000548 DEFINE_GETIMPL_STORE(DIImportedEntity, (Tag, Line), Ops);
Duncan P. N. Exon Smith01fc1762015-02-10 00:52:32 +0000549}
Amjad Abouda9bcf162015-12-10 12:56:35 +0000550
551DIMacro *DIMacro::getImpl(LLVMContext &Context, unsigned MIType,
552 unsigned Line, MDString *Name, MDString *Value,
553 StorageType Storage, bool ShouldCreate) {
554 assert(isCanonical(Name) && "Expected canonical MDString");
Mehdi Amini5d99c4e2016-03-19 01:02:34 +0000555 DEFINE_GETIMPL_LOOKUP(DIMacro, (MIType, Line, Name, Value));
Amjad Abouda9bcf162015-12-10 12:56:35 +0000556 Metadata *Ops[] = { Name, Value };
557 DEFINE_GETIMPL_STORE(DIMacro, (MIType, Line), Ops);
558}
559
560DIMacroFile *DIMacroFile::getImpl(LLVMContext &Context, unsigned MIType,
561 unsigned Line, Metadata *File,
562 Metadata *Elements, StorageType Storage,
563 bool ShouldCreate) {
564 DEFINE_GETIMPL_LOOKUP(DIMacroFile,
565 (MIType, Line, File, Elements));
566 Metadata *Ops[] = { File, Elements };
567 DEFINE_GETIMPL_STORE(DIMacroFile, (MIType, Line), Ops);
568}
569