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