[llvm-exegesis] Fix missing std::move.
[llvm-complete.git] / lib / IR / DebugInfoMetadata.cpp
blobbb49cb2109a5dee8733d04d52a1576247ccabd85
1 //===- 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.
12 //===----------------------------------------------------------------------===//
14 #include "llvm/IR/DebugInfoMetadata.h"
15 #include "LLVMContextImpl.h"
16 #include "MetadataImpl.h"
17 #include "llvm/ADT/SmallSet.h"
18 #include "llvm/ADT/StringSwitch.h"
19 #include "llvm/IR/DIBuilder.h"
20 #include "llvm/IR/Function.h"
21 #include "llvm/IR/Instructions.h"
23 using namespace llvm;
25 DILocation::DILocation(LLVMContext &C, StorageType Storage, unsigned Line,
26 unsigned Column, ArrayRef<Metadata *> MDs,
27 bool ImplicitCode)
28 : MDNode(C, DILocationKind, Storage, MDs) {
29 assert((MDs.size() == 1 || MDs.size() == 2) &&
30 "Expected a scope and optional inlined-at");
32 // Set line and column.
33 assert(Column < (1u << 16) && "Expected 16-bit column");
35 SubclassData32 = Line;
36 SubclassData16 = Column;
38 setImplicitCode(ImplicitCode);
41 static void adjustColumn(unsigned &Column) {
42 // Set to unknown on overflow. We only have 16 bits to play with here.
43 if (Column >= (1u << 16))
44 Column = 0;
47 DILocation *DILocation::getImpl(LLVMContext &Context, unsigned Line,
48 unsigned Column, Metadata *Scope,
49 Metadata *InlinedAt, bool ImplicitCode,
50 StorageType Storage, bool ShouldCreate) {
51 // Fixup column.
52 adjustColumn(Column);
54 if (Storage == Uniqued) {
55 if (auto *N = getUniqued(Context.pImpl->DILocations,
56 DILocationInfo::KeyTy(Line, Column, Scope,
57 InlinedAt, ImplicitCode)))
58 return N;
59 if (!ShouldCreate)
60 return nullptr;
61 } else {
62 assert(ShouldCreate && "Expected non-uniqued nodes to always be created");
65 SmallVector<Metadata *, 2> Ops;
66 Ops.push_back(Scope);
67 if (InlinedAt)
68 Ops.push_back(InlinedAt);
69 return storeImpl(new (Ops.size()) DILocation(Context, Storage, Line, Column,
70 Ops, ImplicitCode),
71 Storage, Context.pImpl->DILocations);
74 const DILocation *DILocation::getMergedLocation(const DILocation *LocA,
75 const DILocation *LocB) {
76 if (!LocA || !LocB)
77 return nullptr;
79 if (LocA == LocB)
80 return LocA;
82 SmallPtrSet<DILocation *, 5> InlinedLocationsA;
83 for (DILocation *L = LocA->getInlinedAt(); L; L = L->getInlinedAt())
84 InlinedLocationsA.insert(L);
85 SmallSet<std::pair<DIScope *, DILocation *>, 5> Locations;
86 DIScope *S = LocA->getScope();
87 DILocation *L = LocA->getInlinedAt();
88 while (S) {
89 Locations.insert(std::make_pair(S, L));
90 S = S->getScope().resolve();
91 if (!S && L) {
92 S = L->getScope();
93 L = L->getInlinedAt();
96 const DILocation *Result = LocB;
97 S = LocB->getScope();
98 L = LocB->getInlinedAt();
99 while (S) {
100 if (Locations.count(std::make_pair(S, L)))
101 break;
102 S = S->getScope().resolve();
103 if (!S && L) {
104 S = L->getScope();
105 L = L->getInlinedAt();
109 // If the two locations are irreconsilable, just pick one. This is misleading,
110 // but on the other hand, it's a "line 0" location.
111 if (!S || !isa<DILocalScope>(S))
112 S = LocA->getScope();
113 return DILocation::get(Result->getContext(), 0, 0, S, L);
116 DINode::DIFlags DINode::getFlag(StringRef Flag) {
117 return StringSwitch<DIFlags>(Flag)
118 #define HANDLE_DI_FLAG(ID, NAME) .Case("DIFlag" #NAME, Flag##NAME)
119 #include "llvm/IR/DebugInfoFlags.def"
120 .Default(DINode::FlagZero);
123 StringRef DINode::getFlagString(DIFlags Flag) {
124 switch (Flag) {
125 #define HANDLE_DI_FLAG(ID, NAME) \
126 case Flag##NAME: \
127 return "DIFlag" #NAME;
128 #include "llvm/IR/DebugInfoFlags.def"
130 return "";
133 DINode::DIFlags DINode::splitFlags(DIFlags Flags,
134 SmallVectorImpl<DIFlags> &SplitFlags) {
135 // Flags that are packed together need to be specially handled, so
136 // that, for example, we emit "DIFlagPublic" and not
137 // "DIFlagPrivate | DIFlagProtected".
138 if (DIFlags A = Flags & FlagAccessibility) {
139 if (A == FlagPrivate)
140 SplitFlags.push_back(FlagPrivate);
141 else if (A == FlagProtected)
142 SplitFlags.push_back(FlagProtected);
143 else
144 SplitFlags.push_back(FlagPublic);
145 Flags &= ~A;
147 if (DIFlags R = Flags & FlagPtrToMemberRep) {
148 if (R == FlagSingleInheritance)
149 SplitFlags.push_back(FlagSingleInheritance);
150 else if (R == FlagMultipleInheritance)
151 SplitFlags.push_back(FlagMultipleInheritance);
152 else
153 SplitFlags.push_back(FlagVirtualInheritance);
154 Flags &= ~R;
156 if ((Flags & FlagIndirectVirtualBase) == FlagIndirectVirtualBase) {
157 Flags &= ~FlagIndirectVirtualBase;
158 SplitFlags.push_back(FlagIndirectVirtualBase);
161 #define HANDLE_DI_FLAG(ID, NAME) \
162 if (DIFlags Bit = Flags & Flag##NAME) { \
163 SplitFlags.push_back(Bit); \
164 Flags &= ~Bit; \
166 #include "llvm/IR/DebugInfoFlags.def"
167 return Flags;
170 DIScopeRef DIScope::getScope() const {
171 if (auto *T = dyn_cast<DIType>(this))
172 return T->getScope();
174 if (auto *SP = dyn_cast<DISubprogram>(this))
175 return SP->getScope();
177 if (auto *LB = dyn_cast<DILexicalBlockBase>(this))
178 return LB->getScope();
180 if (auto *NS = dyn_cast<DINamespace>(this))
181 return NS->getScope();
183 if (auto *M = dyn_cast<DIModule>(this))
184 return M->getScope();
186 assert((isa<DIFile>(this) || isa<DICompileUnit>(this)) &&
187 "Unhandled type of scope.");
188 return nullptr;
191 StringRef DIScope::getName() const {
192 if (auto *T = dyn_cast<DIType>(this))
193 return T->getName();
194 if (auto *SP = dyn_cast<DISubprogram>(this))
195 return SP->getName();
196 if (auto *NS = dyn_cast<DINamespace>(this))
197 return NS->getName();
198 if (auto *M = dyn_cast<DIModule>(this))
199 return M->getName();
200 assert((isa<DILexicalBlockBase>(this) || isa<DIFile>(this) ||
201 isa<DICompileUnit>(this)) &&
202 "Unhandled type of scope.");
203 return "";
206 #ifndef NDEBUG
207 static bool isCanonical(const MDString *S) {
208 return !S || !S->getString().empty();
210 #endif
212 GenericDINode *GenericDINode::getImpl(LLVMContext &Context, unsigned Tag,
213 MDString *Header,
214 ArrayRef<Metadata *> DwarfOps,
215 StorageType Storage, bool ShouldCreate) {
216 unsigned Hash = 0;
217 if (Storage == Uniqued) {
218 GenericDINodeInfo::KeyTy Key(Tag, Header, DwarfOps);
219 if (auto *N = getUniqued(Context.pImpl->GenericDINodes, Key))
220 return N;
221 if (!ShouldCreate)
222 return nullptr;
223 Hash = Key.getHash();
224 } else {
225 assert(ShouldCreate && "Expected non-uniqued nodes to always be created");
228 // Use a nullptr for empty headers.
229 assert(isCanonical(Header) && "Expected canonical MDString");
230 Metadata *PreOps[] = {Header};
231 return storeImpl(new (DwarfOps.size() + 1) GenericDINode(
232 Context, Storage, Hash, Tag, PreOps, DwarfOps),
233 Storage, Context.pImpl->GenericDINodes);
236 void GenericDINode::recalculateHash() {
237 setHash(GenericDINodeInfo::KeyTy::calculateHash(this));
240 #define UNWRAP_ARGS_IMPL(...) __VA_ARGS__
241 #define UNWRAP_ARGS(ARGS) UNWRAP_ARGS_IMPL ARGS
242 #define DEFINE_GETIMPL_LOOKUP(CLASS, ARGS) \
243 do { \
244 if (Storage == Uniqued) { \
245 if (auto *N = getUniqued(Context.pImpl->CLASS##s, \
246 CLASS##Info::KeyTy(UNWRAP_ARGS(ARGS)))) \
247 return N; \
248 if (!ShouldCreate) \
249 return nullptr; \
250 } else { \
251 assert(ShouldCreate && \
252 "Expected non-uniqued nodes to always be created"); \
254 } while (false)
255 #define DEFINE_GETIMPL_STORE(CLASS, ARGS, OPS) \
256 return storeImpl(new (array_lengthof(OPS)) \
257 CLASS(Context, Storage, UNWRAP_ARGS(ARGS), OPS), \
258 Storage, Context.pImpl->CLASS##s)
259 #define DEFINE_GETIMPL_STORE_NO_OPS(CLASS, ARGS) \
260 return storeImpl(new (0u) CLASS(Context, Storage, UNWRAP_ARGS(ARGS)), \
261 Storage, Context.pImpl->CLASS##s)
262 #define DEFINE_GETIMPL_STORE_NO_CONSTRUCTOR_ARGS(CLASS, OPS) \
263 return storeImpl(new (array_lengthof(OPS)) CLASS(Context, Storage, OPS), \
264 Storage, Context.pImpl->CLASS##s)
265 #define DEFINE_GETIMPL_STORE_N(CLASS, ARGS, OPS, NUM_OPS) \
266 return storeImpl(new (NUM_OPS) \
267 CLASS(Context, Storage, UNWRAP_ARGS(ARGS), OPS), \
268 Storage, Context.pImpl->CLASS##s)
270 DISubrange *DISubrange::getImpl(LLVMContext &Context, int64_t Count, int64_t Lo,
271 StorageType Storage, bool ShouldCreate) {
272 auto *CountNode = ConstantAsMetadata::get(
273 ConstantInt::getSigned(Type::getInt64Ty(Context), Count));
274 return getImpl(Context, CountNode, Lo, Storage, ShouldCreate);
277 DISubrange *DISubrange::getImpl(LLVMContext &Context, Metadata *CountNode,
278 int64_t Lo, StorageType Storage,
279 bool ShouldCreate) {
280 DEFINE_GETIMPL_LOOKUP(DISubrange, (CountNode, Lo));
281 Metadata *Ops[] = { CountNode };
282 DEFINE_GETIMPL_STORE(DISubrange, (CountNode, Lo), Ops);
285 DIEnumerator *DIEnumerator::getImpl(LLVMContext &Context, int64_t Value,
286 bool IsUnsigned, MDString *Name,
287 StorageType Storage, bool ShouldCreate) {
288 assert(isCanonical(Name) && "Expected canonical MDString");
289 DEFINE_GETIMPL_LOOKUP(DIEnumerator, (Value, IsUnsigned, Name));
290 Metadata *Ops[] = {Name};
291 DEFINE_GETIMPL_STORE(DIEnumerator, (Value, IsUnsigned), Ops);
294 DIBasicType *DIBasicType::getImpl(LLVMContext &Context, unsigned Tag,
295 MDString *Name, uint64_t SizeInBits,
296 uint32_t AlignInBits, unsigned Encoding,
297 DIFlags Flags, StorageType Storage,
298 bool ShouldCreate) {
299 assert(isCanonical(Name) && "Expected canonical MDString");
300 DEFINE_GETIMPL_LOOKUP(DIBasicType,
301 (Tag, Name, SizeInBits, AlignInBits, Encoding, Flags));
302 Metadata *Ops[] = {nullptr, nullptr, Name};
303 DEFINE_GETIMPL_STORE(DIBasicType, (Tag, SizeInBits, AlignInBits, Encoding,
304 Flags), Ops);
307 Optional<DIBasicType::Signedness> DIBasicType::getSignedness() const {
308 switch (getEncoding()) {
309 case dwarf::DW_ATE_signed:
310 case dwarf::DW_ATE_signed_char:
311 return Signedness::Signed;
312 case dwarf::DW_ATE_unsigned:
313 case dwarf::DW_ATE_unsigned_char:
314 return Signedness::Unsigned;
315 default:
316 return None;
320 DIDerivedType *DIDerivedType::getImpl(
321 LLVMContext &Context, unsigned Tag, MDString *Name, Metadata *File,
322 unsigned Line, Metadata *Scope, Metadata *BaseType, uint64_t SizeInBits,
323 uint32_t AlignInBits, uint64_t OffsetInBits,
324 Optional<unsigned> DWARFAddressSpace, DIFlags Flags, Metadata *ExtraData,
325 StorageType Storage, bool ShouldCreate) {
326 assert(isCanonical(Name) && "Expected canonical MDString");
327 DEFINE_GETIMPL_LOOKUP(DIDerivedType,
328 (Tag, Name, File, Line, Scope, BaseType, SizeInBits,
329 AlignInBits, OffsetInBits, DWARFAddressSpace, Flags,
330 ExtraData));
331 Metadata *Ops[] = {File, Scope, Name, BaseType, ExtraData};
332 DEFINE_GETIMPL_STORE(
333 DIDerivedType, (Tag, Line, SizeInBits, AlignInBits, OffsetInBits,
334 DWARFAddressSpace, Flags), Ops);
337 DICompositeType *DICompositeType::getImpl(
338 LLVMContext &Context, unsigned Tag, MDString *Name, Metadata *File,
339 unsigned Line, Metadata *Scope, Metadata *BaseType, uint64_t SizeInBits,
340 uint32_t AlignInBits, uint64_t OffsetInBits, DIFlags Flags,
341 Metadata *Elements, unsigned RuntimeLang, Metadata *VTableHolder,
342 Metadata *TemplateParams, MDString *Identifier, Metadata *Discriminator,
343 StorageType Storage, bool ShouldCreate) {
344 assert(isCanonical(Name) && "Expected canonical MDString");
346 // Keep this in sync with buildODRType.
347 DEFINE_GETIMPL_LOOKUP(
348 DICompositeType, (Tag, Name, File, Line, Scope, BaseType, SizeInBits,
349 AlignInBits, OffsetInBits, Flags, Elements, RuntimeLang,
350 VTableHolder, TemplateParams, Identifier, Discriminator));
351 Metadata *Ops[] = {File, Scope, Name, BaseType,
352 Elements, VTableHolder, TemplateParams, Identifier,
353 Discriminator};
354 DEFINE_GETIMPL_STORE(DICompositeType, (Tag, Line, RuntimeLang, SizeInBits,
355 AlignInBits, OffsetInBits, Flags),
356 Ops);
359 DICompositeType *DICompositeType::buildODRType(
360 LLVMContext &Context, MDString &Identifier, unsigned Tag, MDString *Name,
361 Metadata *File, unsigned Line, Metadata *Scope, Metadata *BaseType,
362 uint64_t SizeInBits, uint32_t AlignInBits, uint64_t OffsetInBits,
363 DIFlags Flags, Metadata *Elements, unsigned RuntimeLang,
364 Metadata *VTableHolder, Metadata *TemplateParams, Metadata *Discriminator) {
365 assert(!Identifier.getString().empty() && "Expected valid identifier");
366 if (!Context.isODRUniquingDebugTypes())
367 return nullptr;
368 auto *&CT = (*Context.pImpl->DITypeMap)[&Identifier];
369 if (!CT)
370 return CT = DICompositeType::getDistinct(
371 Context, Tag, Name, File, Line, Scope, BaseType, SizeInBits,
372 AlignInBits, OffsetInBits, Flags, Elements, RuntimeLang,
373 VTableHolder, TemplateParams, &Identifier, Discriminator);
375 // Only mutate CT if it's a forward declaration and the new operands aren't.
376 assert(CT->getRawIdentifier() == &Identifier && "Wrong ODR identifier?");
377 if (!CT->isForwardDecl() || (Flags & DINode::FlagFwdDecl))
378 return CT;
380 // Mutate CT in place. Keep this in sync with getImpl.
381 CT->mutate(Tag, Line, RuntimeLang, SizeInBits, AlignInBits, OffsetInBits,
382 Flags);
383 Metadata *Ops[] = {File, Scope, Name, BaseType,
384 Elements, VTableHolder, TemplateParams, &Identifier,
385 Discriminator};
386 assert((std::end(Ops) - std::begin(Ops)) == (int)CT->getNumOperands() &&
387 "Mismatched number of operands");
388 for (unsigned I = 0, E = CT->getNumOperands(); I != E; ++I)
389 if (Ops[I] != CT->getOperand(I))
390 CT->setOperand(I, Ops[I]);
391 return CT;
394 DICompositeType *DICompositeType::getODRType(
395 LLVMContext &Context, MDString &Identifier, unsigned Tag, MDString *Name,
396 Metadata *File, unsigned Line, Metadata *Scope, Metadata *BaseType,
397 uint64_t SizeInBits, uint32_t AlignInBits, uint64_t OffsetInBits,
398 DIFlags Flags, Metadata *Elements, unsigned RuntimeLang,
399 Metadata *VTableHolder, Metadata *TemplateParams, Metadata *Discriminator) {
400 assert(!Identifier.getString().empty() && "Expected valid identifier");
401 if (!Context.isODRUniquingDebugTypes())
402 return nullptr;
403 auto *&CT = (*Context.pImpl->DITypeMap)[&Identifier];
404 if (!CT)
405 CT = DICompositeType::getDistinct(
406 Context, Tag, Name, File, Line, Scope, BaseType, SizeInBits,
407 AlignInBits, OffsetInBits, Flags, Elements, RuntimeLang, VTableHolder,
408 TemplateParams, &Identifier, Discriminator);
409 return CT;
412 DICompositeType *DICompositeType::getODRTypeIfExists(LLVMContext &Context,
413 MDString &Identifier) {
414 assert(!Identifier.getString().empty() && "Expected valid identifier");
415 if (!Context.isODRUniquingDebugTypes())
416 return nullptr;
417 return Context.pImpl->DITypeMap->lookup(&Identifier);
420 DISubroutineType *DISubroutineType::getImpl(LLVMContext &Context, DIFlags Flags,
421 uint8_t CC, Metadata *TypeArray,
422 StorageType Storage,
423 bool ShouldCreate) {
424 DEFINE_GETIMPL_LOOKUP(DISubroutineType, (Flags, CC, TypeArray));
425 Metadata *Ops[] = {nullptr, nullptr, nullptr, TypeArray};
426 DEFINE_GETIMPL_STORE(DISubroutineType, (Flags, CC), Ops);
429 // FIXME: Implement this string-enum correspondence with a .def file and macros,
430 // so that the association is explicit rather than implied.
431 static const char *ChecksumKindName[DIFile::CSK_Last] = {
432 "CSK_MD5",
433 "CSK_SHA1"
436 StringRef DIFile::getChecksumKindAsString(ChecksumKind CSKind) {
437 assert(CSKind <= DIFile::CSK_Last && "Invalid checksum kind");
438 // The first space was originally the CSK_None variant, which is now
439 // obsolete, but the space is still reserved in ChecksumKind, so we account
440 // for it here.
441 return ChecksumKindName[CSKind - 1];
444 Optional<DIFile::ChecksumKind> DIFile::getChecksumKind(StringRef CSKindStr) {
445 return StringSwitch<Optional<DIFile::ChecksumKind>>(CSKindStr)
446 .Case("CSK_MD5", DIFile::CSK_MD5)
447 .Case("CSK_SHA1", DIFile::CSK_SHA1)
448 .Default(None);
451 DIFile *DIFile::getImpl(LLVMContext &Context, MDString *Filename,
452 MDString *Directory,
453 Optional<DIFile::ChecksumInfo<MDString *>> CS,
454 Optional<MDString *> Source, StorageType Storage,
455 bool ShouldCreate) {
456 assert(isCanonical(Filename) && "Expected canonical MDString");
457 assert(isCanonical(Directory) && "Expected canonical MDString");
458 assert((!CS || isCanonical(CS->Value)) && "Expected canonical MDString");
459 assert((!Source || isCanonical(*Source)) && "Expected canonical MDString");
460 DEFINE_GETIMPL_LOOKUP(DIFile, (Filename, Directory, CS, Source));
461 Metadata *Ops[] = {Filename, Directory, CS ? CS->Value : nullptr,
462 Source.getValueOr(nullptr)};
463 DEFINE_GETIMPL_STORE(DIFile, (CS, Source), Ops);
466 DICompileUnit *DICompileUnit::getImpl(
467 LLVMContext &Context, unsigned SourceLanguage, Metadata *File,
468 MDString *Producer, bool IsOptimized, MDString *Flags,
469 unsigned RuntimeVersion, MDString *SplitDebugFilename,
470 unsigned EmissionKind, Metadata *EnumTypes, Metadata *RetainedTypes,
471 Metadata *GlobalVariables, Metadata *ImportedEntities, Metadata *Macros,
472 uint64_t DWOId, bool SplitDebugInlining, bool DebugInfoForProfiling,
473 unsigned NameTableKind, StorageType Storage, bool ShouldCreate) {
474 assert(Storage != Uniqued && "Cannot unique DICompileUnit");
475 assert(isCanonical(Producer) && "Expected canonical MDString");
476 assert(isCanonical(Flags) && "Expected canonical MDString");
477 assert(isCanonical(SplitDebugFilename) && "Expected canonical MDString");
479 Metadata *Ops[] = {
480 File, Producer, Flags, SplitDebugFilename,
481 EnumTypes, RetainedTypes, GlobalVariables, ImportedEntities,
482 Macros};
483 return storeImpl(new (array_lengthof(Ops)) DICompileUnit(
484 Context, Storage, SourceLanguage, IsOptimized,
485 RuntimeVersion, EmissionKind, DWOId, SplitDebugInlining,
486 DebugInfoForProfiling, NameTableKind, Ops),
487 Storage);
490 Optional<DICompileUnit::DebugEmissionKind>
491 DICompileUnit::getEmissionKind(StringRef Str) {
492 return StringSwitch<Optional<DebugEmissionKind>>(Str)
493 .Case("NoDebug", NoDebug)
494 .Case("FullDebug", FullDebug)
495 .Case("LineTablesOnly", LineTablesOnly)
496 .Case("DebugDirectivesOnly", DebugDirectivesOnly)
497 .Default(None);
500 Optional<DICompileUnit::DebugNameTableKind>
501 DICompileUnit::getNameTableKind(StringRef Str) {
502 return StringSwitch<Optional<DebugNameTableKind>>(Str)
503 .Case("Default", DebugNameTableKind::Default)
504 .Case("GNU", DebugNameTableKind::GNU)
505 .Case("None", DebugNameTableKind::None)
506 .Default(None);
509 const char *DICompileUnit::emissionKindString(DebugEmissionKind EK) {
510 switch (EK) {
511 case NoDebug: return "NoDebug";
512 case FullDebug: return "FullDebug";
513 case LineTablesOnly: return "LineTablesOnly";
514 case DebugDirectivesOnly: return "DebugDirectivesOnly";
516 return nullptr;
519 const char *DICompileUnit::nameTableKindString(DebugNameTableKind NTK) {
520 switch (NTK) {
521 case DebugNameTableKind::Default:
522 return nullptr;
523 case DebugNameTableKind::GNU:
524 return "GNU";
525 case DebugNameTableKind::None:
526 return "None";
528 return nullptr;
531 DISubprogram *DILocalScope::getSubprogram() const {
532 if (auto *Block = dyn_cast<DILexicalBlockBase>(this))
533 return Block->getScope()->getSubprogram();
534 return const_cast<DISubprogram *>(cast<DISubprogram>(this));
537 DILocalScope *DILocalScope::getNonLexicalBlockFileScope() const {
538 if (auto *File = dyn_cast<DILexicalBlockFile>(this))
539 return File->getScope()->getNonLexicalBlockFileScope();
540 return const_cast<DILocalScope *>(this);
543 DISubprogram *DISubprogram::getImpl(
544 LLVMContext &Context, Metadata *Scope, MDString *Name,
545 MDString *LinkageName, Metadata *File, unsigned Line, Metadata *Type,
546 bool IsLocalToUnit, bool IsDefinition, unsigned ScopeLine,
547 Metadata *ContainingType, unsigned Virtuality, unsigned VirtualIndex,
548 int ThisAdjustment, DIFlags Flags, bool IsOptimized, Metadata *Unit,
549 Metadata *TemplateParams, Metadata *Declaration, Metadata *RetainedNodes,
550 Metadata *ThrownTypes, StorageType Storage, bool ShouldCreate) {
551 assert(isCanonical(Name) && "Expected canonical MDString");
552 assert(isCanonical(LinkageName) && "Expected canonical MDString");
553 DEFINE_GETIMPL_LOOKUP(
554 DISubprogram, (Scope, Name, LinkageName, File, Line, Type, IsLocalToUnit,
555 IsDefinition, ScopeLine, ContainingType, Virtuality,
556 VirtualIndex, ThisAdjustment, Flags, IsOptimized, Unit,
557 TemplateParams, Declaration, RetainedNodes, ThrownTypes));
558 SmallVector<Metadata *, 11> Ops = {
559 File, Scope, Name, LinkageName, Type, Unit,
560 Declaration, RetainedNodes, ContainingType, TemplateParams, ThrownTypes};
561 if (!ThrownTypes) {
562 Ops.pop_back();
563 if (!TemplateParams) {
564 Ops.pop_back();
565 if (!ContainingType)
566 Ops.pop_back();
569 DEFINE_GETIMPL_STORE_N(DISubprogram,
570 (Line, ScopeLine, Virtuality, VirtualIndex,
571 ThisAdjustment, Flags, IsLocalToUnit, IsDefinition,
572 IsOptimized),
573 Ops, Ops.size());
576 bool DISubprogram::describes(const Function *F) const {
577 assert(F && "Invalid function");
578 if (F->getSubprogram() == this)
579 return true;
580 StringRef Name = getLinkageName();
581 if (Name.empty())
582 Name = getName();
583 return F->getName() == Name;
586 DILexicalBlock *DILexicalBlock::getImpl(LLVMContext &Context, Metadata *Scope,
587 Metadata *File, unsigned Line,
588 unsigned Column, StorageType Storage,
589 bool ShouldCreate) {
590 // Fixup column.
591 adjustColumn(Column);
593 assert(Scope && "Expected scope");
594 DEFINE_GETIMPL_LOOKUP(DILexicalBlock, (Scope, File, Line, Column));
595 Metadata *Ops[] = {File, Scope};
596 DEFINE_GETIMPL_STORE(DILexicalBlock, (Line, Column), Ops);
599 DILexicalBlockFile *DILexicalBlockFile::getImpl(LLVMContext &Context,
600 Metadata *Scope, Metadata *File,
601 unsigned Discriminator,
602 StorageType Storage,
603 bool ShouldCreate) {
604 assert(Scope && "Expected scope");
605 DEFINE_GETIMPL_LOOKUP(DILexicalBlockFile, (Scope, File, Discriminator));
606 Metadata *Ops[] = {File, Scope};
607 DEFINE_GETIMPL_STORE(DILexicalBlockFile, (Discriminator), Ops);
610 DINamespace *DINamespace::getImpl(LLVMContext &Context, Metadata *Scope,
611 MDString *Name, bool ExportSymbols,
612 StorageType Storage, bool ShouldCreate) {
613 assert(isCanonical(Name) && "Expected canonical MDString");
614 DEFINE_GETIMPL_LOOKUP(DINamespace, (Scope, Name, ExportSymbols));
615 // The nullptr is for DIScope's File operand. This should be refactored.
616 Metadata *Ops[] = {nullptr, Scope, Name};
617 DEFINE_GETIMPL_STORE(DINamespace, (ExportSymbols), Ops);
620 DIModule *DIModule::getImpl(LLVMContext &Context, Metadata *Scope,
621 MDString *Name, MDString *ConfigurationMacros,
622 MDString *IncludePath, MDString *ISysRoot,
623 StorageType Storage, bool ShouldCreate) {
624 assert(isCanonical(Name) && "Expected canonical MDString");
625 DEFINE_GETIMPL_LOOKUP(
626 DIModule, (Scope, Name, ConfigurationMacros, IncludePath, ISysRoot));
627 Metadata *Ops[] = {Scope, Name, ConfigurationMacros, IncludePath, ISysRoot};
628 DEFINE_GETIMPL_STORE_NO_CONSTRUCTOR_ARGS(DIModule, Ops);
631 DITemplateTypeParameter *DITemplateTypeParameter::getImpl(LLVMContext &Context,
632 MDString *Name,
633 Metadata *Type,
634 StorageType Storage,
635 bool ShouldCreate) {
636 assert(isCanonical(Name) && "Expected canonical MDString");
637 DEFINE_GETIMPL_LOOKUP(DITemplateTypeParameter, (Name, Type));
638 Metadata *Ops[] = {Name, Type};
639 DEFINE_GETIMPL_STORE_NO_CONSTRUCTOR_ARGS(DITemplateTypeParameter, Ops);
642 DITemplateValueParameter *DITemplateValueParameter::getImpl(
643 LLVMContext &Context, unsigned Tag, MDString *Name, Metadata *Type,
644 Metadata *Value, StorageType Storage, bool ShouldCreate) {
645 assert(isCanonical(Name) && "Expected canonical MDString");
646 DEFINE_GETIMPL_LOOKUP(DITemplateValueParameter, (Tag, Name, Type, Value));
647 Metadata *Ops[] = {Name, Type, Value};
648 DEFINE_GETIMPL_STORE(DITemplateValueParameter, (Tag), Ops);
651 DIGlobalVariable *
652 DIGlobalVariable::getImpl(LLVMContext &Context, Metadata *Scope, MDString *Name,
653 MDString *LinkageName, Metadata *File, unsigned Line,
654 Metadata *Type, bool IsLocalToUnit, bool IsDefinition,
655 Metadata *StaticDataMemberDeclaration,
656 Metadata *TemplateParams, uint32_t AlignInBits,
657 StorageType Storage, bool ShouldCreate) {
658 assert(isCanonical(Name) && "Expected canonical MDString");
659 assert(isCanonical(LinkageName) && "Expected canonical MDString");
660 DEFINE_GETIMPL_LOOKUP(DIGlobalVariable, (Scope, Name, LinkageName, File, Line,
661 Type, IsLocalToUnit, IsDefinition,
662 StaticDataMemberDeclaration,
663 TemplateParams, AlignInBits));
664 Metadata *Ops[] = {Scope,
665 Name,
666 File,
667 Type,
668 Name,
669 LinkageName,
670 StaticDataMemberDeclaration,
671 TemplateParams};
672 DEFINE_GETIMPL_STORE(DIGlobalVariable,
673 (Line, IsLocalToUnit, IsDefinition, AlignInBits), Ops);
676 DILocalVariable *DILocalVariable::getImpl(LLVMContext &Context, Metadata *Scope,
677 MDString *Name, Metadata *File,
678 unsigned Line, Metadata *Type,
679 unsigned Arg, DIFlags Flags,
680 uint32_t AlignInBits,
681 StorageType Storage,
682 bool ShouldCreate) {
683 // 64K ought to be enough for any frontend.
684 assert(Arg <= UINT16_MAX && "Expected argument number to fit in 16-bits");
686 assert(Scope && "Expected scope");
687 assert(isCanonical(Name) && "Expected canonical MDString");
688 DEFINE_GETIMPL_LOOKUP(DILocalVariable,
689 (Scope, Name, File, Line, Type, Arg, Flags,
690 AlignInBits));
691 Metadata *Ops[] = {Scope, Name, File, Type};
692 DEFINE_GETIMPL_STORE(DILocalVariable, (Line, Arg, Flags, AlignInBits), Ops);
695 Optional<uint64_t> DIVariable::getSizeInBits() const {
696 // This is used by the Verifier so be mindful of broken types.
697 const Metadata *RawType = getRawType();
698 while (RawType) {
699 // Try to get the size directly.
700 if (auto *T = dyn_cast<DIType>(RawType))
701 if (uint64_t Size = T->getSizeInBits())
702 return Size;
704 if (auto *DT = dyn_cast<DIDerivedType>(RawType)) {
705 // Look at the base type.
706 RawType = DT->getRawBaseType();
707 continue;
710 // Missing type or size.
711 break;
714 // Fail gracefully.
715 return None;
718 DILabel *DILabel::getImpl(LLVMContext &Context, Metadata *Scope,
719 MDString *Name, Metadata *File, unsigned Line,
720 StorageType Storage,
721 bool ShouldCreate) {
722 assert(Scope && "Expected scope");
723 assert(isCanonical(Name) && "Expected canonical MDString");
724 DEFINE_GETIMPL_LOOKUP(DILabel,
725 (Scope, Name, File, Line));
726 Metadata *Ops[] = {Scope, Name, File};
727 DEFINE_GETIMPL_STORE(DILabel, (Line), Ops);
730 DIExpression *DIExpression::getImpl(LLVMContext &Context,
731 ArrayRef<uint64_t> Elements,
732 StorageType Storage, bool ShouldCreate) {
733 DEFINE_GETIMPL_LOOKUP(DIExpression, (Elements));
734 DEFINE_GETIMPL_STORE_NO_OPS(DIExpression, (Elements));
737 unsigned DIExpression::ExprOperand::getSize() const {
738 switch (getOp()) {
739 case dwarf::DW_OP_LLVM_fragment:
740 return 3;
741 case dwarf::DW_OP_constu:
742 case dwarf::DW_OP_plus_uconst:
743 return 2;
744 default:
745 return 1;
749 bool DIExpression::isValid() const {
750 for (auto I = expr_op_begin(), E = expr_op_end(); I != E; ++I) {
751 // Check that there's space for the operand.
752 if (I->get() + I->getSize() > E->get())
753 return false;
755 // Check that the operand is valid.
756 switch (I->getOp()) {
757 default:
758 return false;
759 case dwarf::DW_OP_LLVM_fragment:
760 // A fragment operator must appear at the end.
761 return I->get() + I->getSize() == E->get();
762 case dwarf::DW_OP_stack_value: {
763 // Must be the last one or followed by a DW_OP_LLVM_fragment.
764 if (I->get() + I->getSize() == E->get())
765 break;
766 auto J = I;
767 if ((++J)->getOp() != dwarf::DW_OP_LLVM_fragment)
768 return false;
769 break;
771 case dwarf::DW_OP_swap: {
772 // Must be more than one implicit element on the stack.
774 // FIXME: A better way to implement this would be to add a local variable
775 // that keeps track of the stack depth and introduce something like a
776 // DW_LLVM_OP_implicit_location as a placeholder for the location this
777 // DIExpression is attached to, or else pass the number of implicit stack
778 // elements into isValid.
779 if (getNumElements() == 1)
780 return false;
781 break;
783 case dwarf::DW_OP_constu:
784 case dwarf::DW_OP_plus_uconst:
785 case dwarf::DW_OP_plus:
786 case dwarf::DW_OP_minus:
787 case dwarf::DW_OP_mul:
788 case dwarf::DW_OP_div:
789 case dwarf::DW_OP_mod:
790 case dwarf::DW_OP_or:
791 case dwarf::DW_OP_and:
792 case dwarf::DW_OP_xor:
793 case dwarf::DW_OP_shl:
794 case dwarf::DW_OP_shr:
795 case dwarf::DW_OP_shra:
796 case dwarf::DW_OP_deref:
797 case dwarf::DW_OP_xderef:
798 case dwarf::DW_OP_lit0:
799 case dwarf::DW_OP_not:
800 case dwarf::DW_OP_dup:
801 break;
804 return true;
807 Optional<DIExpression::FragmentInfo>
808 DIExpression::getFragmentInfo(expr_op_iterator Start, expr_op_iterator End) {
809 for (auto I = Start; I != End; ++I)
810 if (I->getOp() == dwarf::DW_OP_LLVM_fragment) {
811 DIExpression::FragmentInfo Info = {I->getArg(1), I->getArg(0)};
812 return Info;
814 return None;
817 void DIExpression::appendOffset(SmallVectorImpl<uint64_t> &Ops,
818 int64_t Offset) {
819 if (Offset > 0) {
820 Ops.push_back(dwarf::DW_OP_plus_uconst);
821 Ops.push_back(Offset);
822 } else if (Offset < 0) {
823 Ops.push_back(dwarf::DW_OP_constu);
824 Ops.push_back(-Offset);
825 Ops.push_back(dwarf::DW_OP_minus);
829 bool DIExpression::extractIfOffset(int64_t &Offset) const {
830 if (getNumElements() == 0) {
831 Offset = 0;
832 return true;
835 if (getNumElements() == 2 && Elements[0] == dwarf::DW_OP_plus_uconst) {
836 Offset = Elements[1];
837 return true;
840 if (getNumElements() == 3 && Elements[0] == dwarf::DW_OP_constu) {
841 if (Elements[2] == dwarf::DW_OP_plus) {
842 Offset = Elements[1];
843 return true;
845 if (Elements[2] == dwarf::DW_OP_minus) {
846 Offset = -Elements[1];
847 return true;
851 return false;
854 DIExpression *DIExpression::prepend(const DIExpression *Expr, bool DerefBefore,
855 int64_t Offset, bool DerefAfter,
856 bool StackValue) {
857 SmallVector<uint64_t, 8> Ops;
858 if (DerefBefore)
859 Ops.push_back(dwarf::DW_OP_deref);
861 appendOffset(Ops, Offset);
862 if (DerefAfter)
863 Ops.push_back(dwarf::DW_OP_deref);
865 return prependOpcodes(Expr, Ops, StackValue);
868 DIExpression *DIExpression::prependOpcodes(const DIExpression *Expr,
869 SmallVectorImpl<uint64_t> &Ops,
870 bool StackValue) {
871 assert(Expr && "Can't prepend ops to this expression");
873 // If there are no ops to prepend, do not even add the DW_OP_stack_value.
874 if (Ops.empty())
875 StackValue = false;
876 for (auto Op : Expr->expr_ops()) {
877 // A DW_OP_stack_value comes at the end, but before a DW_OP_LLVM_fragment.
878 if (StackValue) {
879 if (Op.getOp() == dwarf::DW_OP_stack_value)
880 StackValue = false;
881 else if (Op.getOp() == dwarf::DW_OP_LLVM_fragment) {
882 Ops.push_back(dwarf::DW_OP_stack_value);
883 StackValue = false;
886 Op.appendToVector(Ops);
888 if (StackValue)
889 Ops.push_back(dwarf::DW_OP_stack_value);
890 return DIExpression::get(Expr->getContext(), Ops);
893 DIExpression *DIExpression::append(const DIExpression *Expr,
894 ArrayRef<uint64_t> Ops) {
895 assert(Expr && !Ops.empty() && "Can't append ops to this expression");
897 // Copy Expr's current op list.
898 SmallVector<uint64_t, 16> NewOps;
899 for (auto Op : Expr->expr_ops()) {
900 // Append new opcodes before DW_OP_{stack_value, LLVM_fragment}.
901 if (Op.getOp() == dwarf::DW_OP_stack_value ||
902 Op.getOp() == dwarf::DW_OP_LLVM_fragment) {
903 NewOps.append(Ops.begin(), Ops.end());
905 // Ensure that the new opcodes are only appended once.
906 Ops = None;
908 Op.appendToVector(NewOps);
911 NewOps.append(Ops.begin(), Ops.end());
912 return DIExpression::get(Expr->getContext(), NewOps);
915 DIExpression *DIExpression::appendToStack(const DIExpression *Expr,
916 ArrayRef<uint64_t> Ops) {
917 assert(Expr && !Ops.empty() && "Can't append ops to this expression");
918 assert(none_of(Ops,
919 [](uint64_t Op) {
920 return Op == dwarf::DW_OP_stack_value ||
921 Op == dwarf::DW_OP_LLVM_fragment;
922 }) &&
923 "Can't append this op");
925 // Append a DW_OP_deref after Expr's current op list if it's non-empty and
926 // has no DW_OP_stack_value.
928 // Match .* DW_OP_stack_value (DW_OP_LLVM_fragment A B)?.
929 Optional<FragmentInfo> FI = Expr->getFragmentInfo();
930 unsigned DropUntilStackValue = FI.hasValue() ? 3 : 0;
931 ArrayRef<uint64_t> ExprOpsBeforeFragment =
932 Expr->getElements().drop_back(DropUntilStackValue);
933 bool NeedsDeref = (Expr->getNumElements() > DropUntilStackValue) &&
934 (ExprOpsBeforeFragment.back() != dwarf::DW_OP_stack_value);
935 bool NeedsStackValue = NeedsDeref || ExprOpsBeforeFragment.empty();
937 // Append a DW_OP_deref after Expr's current op list if needed, then append
938 // the new ops, and finally ensure that a single DW_OP_stack_value is present.
939 SmallVector<uint64_t, 16> NewOps;
940 if (NeedsDeref)
941 NewOps.push_back(dwarf::DW_OP_deref);
942 NewOps.append(Ops.begin(), Ops.end());
943 if (NeedsStackValue)
944 NewOps.push_back(dwarf::DW_OP_stack_value);
945 return DIExpression::append(Expr, NewOps);
948 Optional<DIExpression *> DIExpression::createFragmentExpression(
949 const DIExpression *Expr, unsigned OffsetInBits, unsigned SizeInBits) {
950 SmallVector<uint64_t, 8> Ops;
951 // Copy over the expression, but leave off any trailing DW_OP_LLVM_fragment.
952 if (Expr) {
953 for (auto Op : Expr->expr_ops()) {
954 switch (Op.getOp()) {
955 default: break;
956 case dwarf::DW_OP_plus:
957 case dwarf::DW_OP_minus:
958 // We can't safely split arithmetic into multiple fragments because we
959 // can't express carry-over between fragments.
961 // FIXME: We *could* preserve the lowest fragment of a constant offset
962 // operation if the offset fits into SizeInBits.
963 return None;
964 case dwarf::DW_OP_LLVM_fragment: {
965 // Make the new offset point into the existing fragment.
966 uint64_t FragmentOffsetInBits = Op.getArg(0);
967 uint64_t FragmentSizeInBits = Op.getArg(1);
968 (void)FragmentSizeInBits;
969 assert((OffsetInBits + SizeInBits <= FragmentSizeInBits) &&
970 "new fragment outside of original fragment");
971 OffsetInBits += FragmentOffsetInBits;
972 continue;
975 Op.appendToVector(Ops);
978 Ops.push_back(dwarf::DW_OP_LLVM_fragment);
979 Ops.push_back(OffsetInBits);
980 Ops.push_back(SizeInBits);
981 return DIExpression::get(Expr->getContext(), Ops);
984 bool DIExpression::isConstant() const {
985 // Recognize DW_OP_constu C DW_OP_stack_value (DW_OP_LLVM_fragment Len Ofs)?.
986 if (getNumElements() != 3 && getNumElements() != 6)
987 return false;
988 if (getElement(0) != dwarf::DW_OP_constu ||
989 getElement(2) != dwarf::DW_OP_stack_value)
990 return false;
991 if (getNumElements() == 6 && getElement(3) != dwarf::DW_OP_LLVM_fragment)
992 return false;
993 return true;
996 DIGlobalVariableExpression *
997 DIGlobalVariableExpression::getImpl(LLVMContext &Context, Metadata *Variable,
998 Metadata *Expression, StorageType Storage,
999 bool ShouldCreate) {
1000 DEFINE_GETIMPL_LOOKUP(DIGlobalVariableExpression, (Variable, Expression));
1001 Metadata *Ops[] = {Variable, Expression};
1002 DEFINE_GETIMPL_STORE_NO_CONSTRUCTOR_ARGS(DIGlobalVariableExpression, Ops);
1005 DIObjCProperty *DIObjCProperty::getImpl(
1006 LLVMContext &Context, MDString *Name, Metadata *File, unsigned Line,
1007 MDString *GetterName, MDString *SetterName, unsigned Attributes,
1008 Metadata *Type, StorageType Storage, bool ShouldCreate) {
1009 assert(isCanonical(Name) && "Expected canonical MDString");
1010 assert(isCanonical(GetterName) && "Expected canonical MDString");
1011 assert(isCanonical(SetterName) && "Expected canonical MDString");
1012 DEFINE_GETIMPL_LOOKUP(DIObjCProperty, (Name, File, Line, GetterName,
1013 SetterName, Attributes, Type));
1014 Metadata *Ops[] = {Name, File, GetterName, SetterName, Type};
1015 DEFINE_GETIMPL_STORE(DIObjCProperty, (Line, Attributes), Ops);
1018 DIImportedEntity *DIImportedEntity::getImpl(LLVMContext &Context, unsigned Tag,
1019 Metadata *Scope, Metadata *Entity,
1020 Metadata *File, unsigned Line,
1021 MDString *Name, StorageType Storage,
1022 bool ShouldCreate) {
1023 assert(isCanonical(Name) && "Expected canonical MDString");
1024 DEFINE_GETIMPL_LOOKUP(DIImportedEntity,
1025 (Tag, Scope, Entity, File, Line, Name));
1026 Metadata *Ops[] = {Scope, Entity, Name, File};
1027 DEFINE_GETIMPL_STORE(DIImportedEntity, (Tag, Line), Ops);
1030 DIMacro *DIMacro::getImpl(LLVMContext &Context, unsigned MIType,
1031 unsigned Line, MDString *Name, MDString *Value,
1032 StorageType Storage, bool ShouldCreate) {
1033 assert(isCanonical(Name) && "Expected canonical MDString");
1034 DEFINE_GETIMPL_LOOKUP(DIMacro, (MIType, Line, Name, Value));
1035 Metadata *Ops[] = { Name, Value };
1036 DEFINE_GETIMPL_STORE(DIMacro, (MIType, Line), Ops);
1039 DIMacroFile *DIMacroFile::getImpl(LLVMContext &Context, unsigned MIType,
1040 unsigned Line, Metadata *File,
1041 Metadata *Elements, StorageType Storage,
1042 bool ShouldCreate) {
1043 DEFINE_GETIMPL_LOOKUP(DIMacroFile,
1044 (MIType, Line, File, Elements));
1045 Metadata *Ops[] = { File, Elements };
1046 DEFINE_GETIMPL_STORE(DIMacroFile, (MIType, Line), Ops);