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.
11 //
12 //===----------------------------------------------------------------------===//
13 
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"
22 
23 using namespace llvm;
24 
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");
31 
32   // Set line and column.
33   assert(Column < (1u << 16) && "Expected 16-bit column");
34 
35   SubclassData32 = Line;
36   SubclassData16 = Column;
37 
38   setImplicitCode(ImplicitCode);
39 }
40 
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;
45 }
46 
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);
53 
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");
63   }
64 
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);
72 }
73 
74 const DILocation *DILocation::getMergedLocation(const DILocation *LocA,
75                                                 const DILocation *LocB) {
76   if (!LocA || !LocB)
77     return nullptr;
78 
79   if (LocA == LocB)
80     return LocA;
81 
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();
94     }
95   }
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();
106     }
107   }
108 
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);
114 }
115 
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);
121 }
122 
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"
129   }
130   return "";
131 }
132 
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;
146   }
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;
155   }
156   if ((Flags & FlagIndirectVirtualBase) == FlagIndirectVirtualBase) {
157     Flags &= ~FlagIndirectVirtualBase;
158     SplitFlags.push_back(FlagIndirectVirtualBase);
159   }
160 
161 #define HANDLE_DI_FLAG(ID, NAME)                                               \
162   if (DIFlags Bit = Flags & Flag##NAME) {                                      \
163     SplitFlags.push_back(Bit);                                                 \
164     Flags &= ~Bit;                                                             \
165   }
166 #include "llvm/IR/DebugInfoFlags.def"
167   return Flags;
168 }
169 
170 DIScopeRef DIScope::getScope() const {
171   if (auto *T = dyn_cast<DIType>(this))
172     return T->getScope();
173 
174   if (auto *SP = dyn_cast<DISubprogram>(this))
175     return SP->getScope();
176 
177   if (auto *LB = dyn_cast<DILexicalBlockBase>(this))
178     return LB->getScope();
179 
180   if (auto *NS = dyn_cast<DINamespace>(this))
181     return NS->getScope();
182 
183   if (auto *M = dyn_cast<DIModule>(this))
184     return M->getScope();
185 
186   assert((isa<DIFile>(this) || isa<DICompileUnit>(this)) &&
187          "Unhandled type of scope.");
188   return nullptr;
189 }
190 
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 "";
204 }
205 
206 #ifndef NDEBUG
207 static bool isCanonical(const MDString *S) {
208   return !S || !S->getString().empty();
209 }
210 #endif
211 
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");
226   }
227 
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);
234 }
235 
236 void GenericDINode::recalculateHash() {
237   setHash(GenericDINodeInfo::KeyTy::calculateHash(this));
238 }
239 
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");               \
253     }                                                                          \
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)
269 
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);
275 }
276 
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);
283 }
284 
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);
292 }
293 
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);
305 }
306 
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;
317   }
318 }
319 
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);
335 }
336 
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");
345 
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);
357 }
358 
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);
374 
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;
379 
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;
392 }
393 
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;
410 }
411 
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);
418 }
419 
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);
427 }
428 
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"
434 };
435 
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];
442 }
443 
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);
449 }
450 
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);
464 }
465 
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");
478 
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);
488 }
489 
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);
498 }
499 
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);
507 }
508 
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";
515   }
516   return nullptr;
517 }
518 
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";
527   }
528   return nullptr;
529 }
530 
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));
535 }
536 
537 DILocalScope *DILocalScope::getNonLexicalBlockFileScope() const {
538   if (auto *File = dyn_cast<DILexicalBlockFile>(this))
539     return File->getScope()->getNonLexicalBlockFileScope();
540   return const_cast<DILocalScope *>(this);
541 }
542 
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();
567     }
568   }
569   DEFINE_GETIMPL_STORE_N(DISubprogram,
570                          (Line, ScopeLine, Virtuality, VirtualIndex,
571                           ThisAdjustment, Flags, IsLocalToUnit, IsDefinition,
572                           IsOptimized),
573                          Ops, Ops.size());
574 }
575 
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;
584 }
585 
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);
592 
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);
597 }
598 
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);
608 }
609 
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);
618 }
619 
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);
629 }
630 
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);
640 }
641 
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);
649 }
650 
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                           uint32_t AlignInBits, StorageType Storage,
657                           bool ShouldCreate) {
658   assert(isCanonical(Name) && "Expected canonical MDString");
659   assert(isCanonical(LinkageName) && "Expected canonical MDString");
660   DEFINE_GETIMPL_LOOKUP(DIGlobalVariable,
661                         (Scope, Name, LinkageName, File, Line, Type,
662                          IsLocalToUnit, IsDefinition,
663                          StaticDataMemberDeclaration, AlignInBits));
664   Metadata *Ops[] = {
665       Scope, Name, File, Type, Name, LinkageName, StaticDataMemberDeclaration};
666   DEFINE_GETIMPL_STORE(DIGlobalVariable,
667                        (Line, IsLocalToUnit, IsDefinition, AlignInBits),
668                        Ops);
669 }
670 
671 DILocalVariable *DILocalVariable::getImpl(LLVMContext &Context, Metadata *Scope,
672                                           MDString *Name, Metadata *File,
673                                           unsigned Line, Metadata *Type,
674                                           unsigned Arg, DIFlags Flags,
675                                           uint32_t AlignInBits,
676                                           StorageType Storage,
677                                           bool ShouldCreate) {
678   // 64K ought to be enough for any frontend.
679   assert(Arg <= UINT16_MAX && "Expected argument number to fit in 16-bits");
680 
681   assert(Scope && "Expected scope");
682   assert(isCanonical(Name) && "Expected canonical MDString");
683   DEFINE_GETIMPL_LOOKUP(DILocalVariable,
684                         (Scope, Name, File, Line, Type, Arg, Flags,
685                          AlignInBits));
686   Metadata *Ops[] = {Scope, Name, File, Type};
687   DEFINE_GETIMPL_STORE(DILocalVariable, (Line, Arg, Flags, AlignInBits), Ops);
688 }
689 
690 Optional<uint64_t> DIVariable::getSizeInBits() const {
691   // This is used by the Verifier so be mindful of broken types.
692   const Metadata *RawType = getRawType();
693   while (RawType) {
694     // Try to get the size directly.
695     if (auto *T = dyn_cast<DIType>(RawType))
696       if (uint64_t Size = T->getSizeInBits())
697         return Size;
698 
699     if (auto *DT = dyn_cast<DIDerivedType>(RawType)) {
700       // Look at the base type.
701       RawType = DT->getRawBaseType();
702       continue;
703     }
704 
705     // Missing type or size.
706     break;
707   }
708 
709   // Fail gracefully.
710   return None;
711 }
712 
713 DILabel *DILabel::getImpl(LLVMContext &Context, Metadata *Scope,
714                           MDString *Name, Metadata *File, unsigned Line,
715                           StorageType Storage,
716                           bool ShouldCreate) {
717   assert(Scope && "Expected scope");
718   assert(isCanonical(Name) && "Expected canonical MDString");
719   DEFINE_GETIMPL_LOOKUP(DILabel,
720                         (Scope, Name, File, Line));
721   Metadata *Ops[] = {Scope, Name, File};
722   DEFINE_GETIMPL_STORE(DILabel, (Line), Ops);
723 }
724 
725 DIExpression *DIExpression::getImpl(LLVMContext &Context,
726                                     ArrayRef<uint64_t> Elements,
727                                     StorageType Storage, bool ShouldCreate) {
728   DEFINE_GETIMPL_LOOKUP(DIExpression, (Elements));
729   DEFINE_GETIMPL_STORE_NO_OPS(DIExpression, (Elements));
730 }
731 
732 unsigned DIExpression::ExprOperand::getSize() const {
733   switch (getOp()) {
734   case dwarf::DW_OP_LLVM_fragment:
735     return 3;
736   case dwarf::DW_OP_constu:
737   case dwarf::DW_OP_plus_uconst:
738     return 2;
739   default:
740     return 1;
741   }
742 }
743 
744 bool DIExpression::isValid() const {
745   for (auto I = expr_op_begin(), E = expr_op_end(); I != E; ++I) {
746     // Check that there's space for the operand.
747     if (I->get() + I->getSize() > E->get())
748       return false;
749 
750     // Check that the operand is valid.
751     switch (I->getOp()) {
752     default:
753       return false;
754     case dwarf::DW_OP_LLVM_fragment:
755       // A fragment operator must appear at the end.
756       return I->get() + I->getSize() == E->get();
757     case dwarf::DW_OP_stack_value: {
758       // Must be the last one or followed by a DW_OP_LLVM_fragment.
759       if (I->get() + I->getSize() == E->get())
760         break;
761       auto J = I;
762       if ((++J)->getOp() != dwarf::DW_OP_LLVM_fragment)
763         return false;
764       break;
765     }
766     case dwarf::DW_OP_swap: {
767       // Must be more than one implicit element on the stack.
768 
769       // FIXME: A better way to implement this would be to add a local variable
770       // that keeps track of the stack depth and introduce something like a
771       // DW_LLVM_OP_implicit_location as a placeholder for the location this
772       // DIExpression is attached to, or else pass the number of implicit stack
773       // elements into isValid.
774       if (getNumElements() == 1)
775         return false;
776       break;
777     }
778     case dwarf::DW_OP_constu:
779     case dwarf::DW_OP_plus_uconst:
780     case dwarf::DW_OP_plus:
781     case dwarf::DW_OP_minus:
782     case dwarf::DW_OP_mul:
783     case dwarf::DW_OP_div:
784     case dwarf::DW_OP_mod:
785     case dwarf::DW_OP_or:
786     case dwarf::DW_OP_and:
787     case dwarf::DW_OP_xor:
788     case dwarf::DW_OP_shl:
789     case dwarf::DW_OP_shr:
790     case dwarf::DW_OP_shra:
791     case dwarf::DW_OP_deref:
792     case dwarf::DW_OP_xderef:
793     case dwarf::DW_OP_lit0:
794     case dwarf::DW_OP_not:
795     case dwarf::DW_OP_dup:
796       break;
797     }
798   }
799   return true;
800 }
801 
802 Optional<DIExpression::FragmentInfo>
803 DIExpression::getFragmentInfo(expr_op_iterator Start, expr_op_iterator End) {
804   for (auto I = Start; I != End; ++I)
805     if (I->getOp() == dwarf::DW_OP_LLVM_fragment) {
806       DIExpression::FragmentInfo Info = {I->getArg(1), I->getArg(0)};
807       return Info;
808     }
809   return None;
810 }
811 
812 void DIExpression::appendOffset(SmallVectorImpl<uint64_t> &Ops,
813                                 int64_t Offset) {
814   if (Offset > 0) {
815     Ops.push_back(dwarf::DW_OP_plus_uconst);
816     Ops.push_back(Offset);
817   } else if (Offset < 0) {
818     Ops.push_back(dwarf::DW_OP_constu);
819     Ops.push_back(-Offset);
820     Ops.push_back(dwarf::DW_OP_minus);
821   }
822 }
823 
824 bool DIExpression::extractIfOffset(int64_t &Offset) const {
825   if (getNumElements() == 0) {
826     Offset = 0;
827     return true;
828   }
829 
830   if (getNumElements() == 2 && Elements[0] == dwarf::DW_OP_plus_uconst) {
831     Offset = Elements[1];
832     return true;
833   }
834 
835   if (getNumElements() == 3 && Elements[0] == dwarf::DW_OP_constu) {
836     if (Elements[2] == dwarf::DW_OP_plus) {
837       Offset = Elements[1];
838       return true;
839     }
840     if (Elements[2] == dwarf::DW_OP_minus) {
841       Offset = -Elements[1];
842       return true;
843     }
844   }
845 
846   return false;
847 }
848 
849 DIExpression *DIExpression::prepend(const DIExpression *Expr, bool DerefBefore,
850                                     int64_t Offset, bool DerefAfter,
851                                     bool StackValue) {
852   SmallVector<uint64_t, 8> Ops;
853   if (DerefBefore)
854     Ops.push_back(dwarf::DW_OP_deref);
855 
856   appendOffset(Ops, Offset);
857   if (DerefAfter)
858     Ops.push_back(dwarf::DW_OP_deref);
859 
860   return prependOpcodes(Expr, Ops, StackValue);
861 }
862 
863 DIExpression *DIExpression::prependOpcodes(const DIExpression *Expr,
864                                            SmallVectorImpl<uint64_t> &Ops,
865                                            bool StackValue) {
866   assert(Expr && "Can't prepend ops to this expression");
867 
868   // If there are no ops to prepend, do not even add the DW_OP_stack_value.
869   if (Ops.empty())
870     StackValue = false;
871   for (auto Op : Expr->expr_ops()) {
872     // A DW_OP_stack_value comes at the end, but before a DW_OP_LLVM_fragment.
873     if (StackValue) {
874       if (Op.getOp() == dwarf::DW_OP_stack_value)
875         StackValue = false;
876       else if (Op.getOp() == dwarf::DW_OP_LLVM_fragment) {
877         Ops.push_back(dwarf::DW_OP_stack_value);
878         StackValue = false;
879       }
880     }
881     Op.appendToVector(Ops);
882   }
883   if (StackValue)
884     Ops.push_back(dwarf::DW_OP_stack_value);
885   return DIExpression::get(Expr->getContext(), Ops);
886 }
887 
888 DIExpression *DIExpression::append(const DIExpression *Expr,
889                                    ArrayRef<uint64_t> Ops) {
890   assert(Expr && !Ops.empty() && "Can't append ops to this expression");
891 
892   // Copy Expr's current op list.
893   SmallVector<uint64_t, 16> NewOps;
894   for (auto Op : Expr->expr_ops()) {
895     // Append new opcodes before DW_OP_{stack_value, LLVM_fragment}.
896     if (Op.getOp() == dwarf::DW_OP_stack_value ||
897         Op.getOp() == dwarf::DW_OP_LLVM_fragment) {
898       NewOps.append(Ops.begin(), Ops.end());
899 
900       // Ensure that the new opcodes are only appended once.
901       Ops = None;
902     }
903     Op.appendToVector(NewOps);
904   }
905 
906   NewOps.append(Ops.begin(), Ops.end());
907   return DIExpression::get(Expr->getContext(), NewOps);
908 }
909 
910 DIExpression *DIExpression::appendToStack(const DIExpression *Expr,
911                                           ArrayRef<uint64_t> Ops) {
912   assert(Expr && !Ops.empty() && "Can't append ops to this expression");
913   assert(none_of(Ops,
914                  [](uint64_t Op) {
915                    return Op == dwarf::DW_OP_stack_value ||
916                           Op == dwarf::DW_OP_LLVM_fragment;
917                  }) &&
918          "Can't append this op");
919 
920   // Append a DW_OP_deref after Expr's current op list if it's non-empty and
921   // has no DW_OP_stack_value.
922   //
923   // Match .* DW_OP_stack_value (DW_OP_LLVM_fragment A B)?.
924   Optional<FragmentInfo> FI = Expr->getFragmentInfo();
925   unsigned DropUntilStackValue = FI.hasValue() ? 3 : 0;
926   ArrayRef<uint64_t> ExprOpsBeforeFragment =
927       Expr->getElements().drop_back(DropUntilStackValue);
928   bool NeedsDeref = (Expr->getNumElements() > DropUntilStackValue) &&
929                     (ExprOpsBeforeFragment.back() != dwarf::DW_OP_stack_value);
930   bool NeedsStackValue = NeedsDeref || ExprOpsBeforeFragment.empty();
931 
932   // Append a DW_OP_deref after Expr's current op list if needed, then append
933   // the new ops, and finally ensure that a single DW_OP_stack_value is present.
934   SmallVector<uint64_t, 16> NewOps;
935   if (NeedsDeref)
936     NewOps.push_back(dwarf::DW_OP_deref);
937   NewOps.append(Ops.begin(), Ops.end());
938   if (NeedsStackValue)
939     NewOps.push_back(dwarf::DW_OP_stack_value);
940   return DIExpression::append(Expr, NewOps);
941 }
942 
943 Optional<DIExpression *> DIExpression::createFragmentExpression(
944     const DIExpression *Expr, unsigned OffsetInBits, unsigned SizeInBits) {
945   SmallVector<uint64_t, 8> Ops;
946   // Copy over the expression, but leave off any trailing DW_OP_LLVM_fragment.
947   if (Expr) {
948     for (auto Op : Expr->expr_ops()) {
949       switch (Op.getOp()) {
950       default: break;
951       case dwarf::DW_OP_plus:
952       case dwarf::DW_OP_minus:
953         // We can't safely split arithmetic into multiple fragments because we
954         // can't express carry-over between fragments.
955         //
956         // FIXME: We *could* preserve the lowest fragment of a constant offset
957         // operation if the offset fits into SizeInBits.
958         return None;
959       case dwarf::DW_OP_LLVM_fragment: {
960         // Make the new offset point into the existing fragment.
961         uint64_t FragmentOffsetInBits = Op.getArg(0);
962         uint64_t FragmentSizeInBits = Op.getArg(1);
963         (void)FragmentSizeInBits;
964         assert((OffsetInBits + SizeInBits <= FragmentSizeInBits) &&
965                "new fragment outside of original fragment");
966         OffsetInBits += FragmentOffsetInBits;
967         continue;
968       }
969       }
970       Op.appendToVector(Ops);
971     }
972   }
973   Ops.push_back(dwarf::DW_OP_LLVM_fragment);
974   Ops.push_back(OffsetInBits);
975   Ops.push_back(SizeInBits);
976   return DIExpression::get(Expr->getContext(), Ops);
977 }
978 
979 bool DIExpression::isConstant() const {
980   // Recognize DW_OP_constu C DW_OP_stack_value (DW_OP_LLVM_fragment Len Ofs)?.
981   if (getNumElements() != 3 && getNumElements() != 6)
982     return false;
983   if (getElement(0) != dwarf::DW_OP_constu ||
984       getElement(2) != dwarf::DW_OP_stack_value)
985     return false;
986   if (getNumElements() == 6 && getElement(3) != dwarf::DW_OP_LLVM_fragment)
987     return false;
988   return true;
989 }
990 
991 DIGlobalVariableExpression *
992 DIGlobalVariableExpression::getImpl(LLVMContext &Context, Metadata *Variable,
993                                     Metadata *Expression, StorageType Storage,
994                                     bool ShouldCreate) {
995   DEFINE_GETIMPL_LOOKUP(DIGlobalVariableExpression, (Variable, Expression));
996   Metadata *Ops[] = {Variable, Expression};
997   DEFINE_GETIMPL_STORE_NO_CONSTRUCTOR_ARGS(DIGlobalVariableExpression, Ops);
998 }
999 
1000 DIObjCProperty *DIObjCProperty::getImpl(
1001     LLVMContext &Context, MDString *Name, Metadata *File, unsigned Line,
1002     MDString *GetterName, MDString *SetterName, unsigned Attributes,
1003     Metadata *Type, StorageType Storage, bool ShouldCreate) {
1004   assert(isCanonical(Name) && "Expected canonical MDString");
1005   assert(isCanonical(GetterName) && "Expected canonical MDString");
1006   assert(isCanonical(SetterName) && "Expected canonical MDString");
1007   DEFINE_GETIMPL_LOOKUP(DIObjCProperty, (Name, File, Line, GetterName,
1008                                          SetterName, Attributes, Type));
1009   Metadata *Ops[] = {Name, File, GetterName, SetterName, Type};
1010   DEFINE_GETIMPL_STORE(DIObjCProperty, (Line, Attributes), Ops);
1011 }
1012 
1013 DIImportedEntity *DIImportedEntity::getImpl(LLVMContext &Context, unsigned Tag,
1014                                             Metadata *Scope, Metadata *Entity,
1015                                             Metadata *File, unsigned Line,
1016                                             MDString *Name, StorageType Storage,
1017                                             bool ShouldCreate) {
1018   assert(isCanonical(Name) && "Expected canonical MDString");
1019   DEFINE_GETIMPL_LOOKUP(DIImportedEntity,
1020                         (Tag, Scope, Entity, File, Line, Name));
1021   Metadata *Ops[] = {Scope, Entity, Name, File};
1022   DEFINE_GETIMPL_STORE(DIImportedEntity, (Tag, Line), Ops);
1023 }
1024 
1025 DIMacro *DIMacro::getImpl(LLVMContext &Context, unsigned MIType,
1026                           unsigned Line, MDString *Name, MDString *Value,
1027                           StorageType Storage, bool ShouldCreate) {
1028   assert(isCanonical(Name) && "Expected canonical MDString");
1029   DEFINE_GETIMPL_LOOKUP(DIMacro, (MIType, Line, Name, Value));
1030   Metadata *Ops[] = { Name, Value };
1031   DEFINE_GETIMPL_STORE(DIMacro, (MIType, Line), Ops);
1032 }
1033 
1034 DIMacroFile *DIMacroFile::getImpl(LLVMContext &Context, unsigned MIType,
1035                                   unsigned Line, Metadata *File,
1036                                   Metadata *Elements, StorageType Storage,
1037                                   bool ShouldCreate) {
1038   DEFINE_GETIMPL_LOOKUP(DIMacroFile,
1039                         (MIType, Line, File, Elements));
1040   Metadata *Ops[] = { File, Elements };
1041   DEFINE_GETIMPL_STORE(DIMacroFile, (MIType, Line), Ops);
1042 }
1043