LLVM  9.0.0svn
DebugInfoMetadata.cpp
Go to the documentation of this file.
1 //===- DebugInfoMetadata.cpp - Implement debug info metadata --------------===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 // This file implements the debug info Metadata classes.
10 //
11 //===----------------------------------------------------------------------===//
12 
14 #include "LLVMContextImpl.h"
15 #include "MetadataImpl.h"
16 #include "llvm/ADT/SmallSet.h"
17 #include "llvm/ADT/StringSwitch.h"
18 #include "llvm/IR/DIBuilder.h"
19 #include "llvm/IR/Function.h"
20 #include "llvm/IR/Instructions.h"
21 
22 #include <numeric>
23 
24 using namespace llvm;
25 
26 DILocation::DILocation(LLVMContext &C, StorageType Storage, unsigned Line,
27  unsigned Column, ArrayRef<Metadata *> MDs,
28  bool ImplicitCode)
29  : MDNode(C, DILocationKind, Storage, MDs) {
30  assert((MDs.size() == 1 || MDs.size() == 2) &&
31  "Expected a scope and optional inlined-at");
32 
33  // Set line and column.
34  assert(Column < (1u << 16) && "Expected 16-bit column");
35 
36  SubclassData32 = Line;
37  SubclassData16 = Column;
38 
39  setImplicitCode(ImplicitCode);
40 }
41 
42 static void adjustColumn(unsigned &Column) {
43  // Set to unknown on overflow. We only have 16 bits to play with here.
44  if (Column >= (1u << 16))
45  Column = 0;
46 }
47 
49  unsigned Column, Metadata *Scope,
50  Metadata *InlinedAt, bool ImplicitCode,
51  StorageType Storage, bool ShouldCreate) {
52  // Fixup column.
53  adjustColumn(Column);
54 
55  if (Storage == Uniqued) {
56  if (auto *N = getUniqued(Context.pImpl->DILocations,
57  DILocationInfo::KeyTy(Line, Column, Scope,
58  InlinedAt, ImplicitCode)))
59  return N;
60  if (!ShouldCreate)
61  return nullptr;
62  } else {
63  assert(ShouldCreate && "Expected non-uniqued nodes to always be created");
64  }
65 
67  Ops.push_back(Scope);
68  if (InlinedAt)
69  Ops.push_back(InlinedAt);
70  return storeImpl(new (Ops.size()) DILocation(Context, Storage, Line, Column,
71  Ops, ImplicitCode),
72  Storage, Context.pImpl->DILocations);
73 }
74 
76  const DILocation *LocB) {
77  if (!LocA || !LocB)
78  return nullptr;
79 
80  if (LocA == LocB)
81  return LocA;
82 
83  SmallPtrSet<DILocation *, 5> InlinedLocationsA;
84  for (DILocation *L = LocA->getInlinedAt(); L; L = L->getInlinedAt())
85  InlinedLocationsA.insert(L);
87  DIScope *S = LocA->getScope();
88  DILocation *L = LocA->getInlinedAt();
89  while (S) {
90  Locations.insert(std::make_pair(S, L));
91  S = S->getScope().resolve();
92  if (!S && L) {
93  S = L->getScope();
94  L = L->getInlinedAt();
95  }
96  }
97  const DILocation *Result = LocB;
98  S = LocB->getScope();
99  L = LocB->getInlinedAt();
100  while (S) {
101  if (Locations.count(std::make_pair(S, L)))
102  break;
103  S = S->getScope().resolve();
104  if (!S && L) {
105  S = L->getScope();
106  L = L->getInlinedAt();
107  }
108  }
109 
110  // If the two locations are irreconsilable, just pick one. This is misleading,
111  // but on the other hand, it's a "line 0" location.
112  if (!S || !isa<DILocalScope>(S))
113  S = LocA->getScope();
114  return DILocation::get(Result->getContext(), 0, 0, S, L);
115 }
116 
117 Optional<unsigned> DILocation::encodeDiscriminator(unsigned BD, unsigned DF, unsigned CI) {
118  SmallVector<unsigned, 3> Components = {BD, DF, CI};
119  uint64_t RemainingWork = 0U;
120  // We use RemainingWork to figure out if we have no remaining components to
121  // encode. For example: if BD != 0 but DF == 0 && CI == 0, we don't need to
122  // encode anything for the latter 2.
123  // Since any of the input components is at most 32 bits, their sum will be
124  // less than 34 bits, and thus RemainingWork won't overflow.
125  RemainingWork = std::accumulate(Components.begin(), Components.end(), RemainingWork);
126 
127  int I = 0;
128  unsigned Ret = 0;
129  unsigned NextBitInsertionIndex = 0;
130  while (RemainingWork > 0) {
131  unsigned C = Components[I++];
132  RemainingWork -= C;
133  unsigned EC = encodeComponent(C);
134  Ret |= (EC << NextBitInsertionIndex);
135  NextBitInsertionIndex += encodingBits(C);
136  }
137 
138  // Encoding may be unsuccessful because of overflow. We determine success by
139  // checking equivalence of components before & after encoding. Alternatively,
140  // we could determine Success during encoding, but the current alternative is
141  // simpler.
142  unsigned TBD, TDF, TCI = 0;
143  decodeDiscriminator(Ret, TBD, TDF, TCI);
144  if (TBD == BD && TDF == DF && TCI == CI)
145  return Ret;
146  return None;
147 }
148 
149 void DILocation::decodeDiscriminator(unsigned D, unsigned &BD, unsigned &DF,
150  unsigned &CI) {
151  BD = getUnsignedFromPrefixEncoding(D);
152  DF = getUnsignedFromPrefixEncoding(getNextComponentInDiscriminator(D));
153  CI = getUnsignedFromPrefixEncoding(
154  getNextComponentInDiscriminator(getNextComponentInDiscriminator(D)));
155 }
156 
157 
160 #define HANDLE_DI_FLAG(ID, NAME) .Case("DIFlag" #NAME, Flag##NAME)
161 #include "llvm/IR/DebugInfoFlags.def"
162  .Default(DINode::FlagZero);
163 }
164 
166  switch (Flag) {
167 #define HANDLE_DI_FLAG(ID, NAME) \
168  case Flag##NAME: \
169  return "DIFlag" #NAME;
170 #include "llvm/IR/DebugInfoFlags.def"
171  }
172  return "";
173 }
174 
176  SmallVectorImpl<DIFlags> &SplitFlags) {
177  // Flags that are packed together need to be specially handled, so
178  // that, for example, we emit "DIFlagPublic" and not
179  // "DIFlagPrivate | DIFlagProtected".
180  if (DIFlags A = Flags & FlagAccessibility) {
181  if (A == FlagPrivate)
182  SplitFlags.push_back(FlagPrivate);
183  else if (A == FlagProtected)
184  SplitFlags.push_back(FlagProtected);
185  else
186  SplitFlags.push_back(FlagPublic);
187  Flags &= ~A;
188  }
189  if (DIFlags R = Flags & FlagPtrToMemberRep) {
190  if (R == FlagSingleInheritance)
191  SplitFlags.push_back(FlagSingleInheritance);
192  else if (R == FlagMultipleInheritance)
193  SplitFlags.push_back(FlagMultipleInheritance);
194  else
195  SplitFlags.push_back(FlagVirtualInheritance);
196  Flags &= ~R;
197  }
198  if ((Flags & FlagIndirectVirtualBase) == FlagIndirectVirtualBase) {
199  Flags &= ~FlagIndirectVirtualBase;
200  SplitFlags.push_back(FlagIndirectVirtualBase);
201  }
202 
203 #define HANDLE_DI_FLAG(ID, NAME) \
204  if (DIFlags Bit = Flags & Flag##NAME) { \
205  SplitFlags.push_back(Bit); \
206  Flags &= ~Bit; \
207  }
208 #include "llvm/IR/DebugInfoFlags.def"
209  return Flags;
210 }
211 
213  if (auto *T = dyn_cast<DIType>(this))
214  return T->getScope();
215 
216  if (auto *SP = dyn_cast<DISubprogram>(this))
217  return SP->getScope();
218 
219  if (auto *LB = dyn_cast<DILexicalBlockBase>(this))
220  return LB->getScope();
221 
222  if (auto *NS = dyn_cast<DINamespace>(this))
223  return NS->getScope();
224 
225  if (auto *M = dyn_cast<DIModule>(this))
226  return M->getScope();
227 
228  assert((isa<DIFile>(this) || isa<DICompileUnit>(this)) &&
229  "Unhandled type of scope.");
230  return nullptr;
231 }
232 
234  if (auto *T = dyn_cast<DIType>(this))
235  return T->getName();
236  if (auto *SP = dyn_cast<DISubprogram>(this))
237  return SP->getName();
238  if (auto *NS = dyn_cast<DINamespace>(this))
239  return NS->getName();
240  if (auto *M = dyn_cast<DIModule>(this))
241  return M->getName();
242  assert((isa<DILexicalBlockBase>(this) || isa<DIFile>(this) ||
243  isa<DICompileUnit>(this)) &&
244  "Unhandled type of scope.");
245  return "";
246 }
247 
248 #ifndef NDEBUG
249 static bool isCanonical(const MDString *S) {
250  return !S || !S->getString().empty();
251 }
252 #endif
253 
254 GenericDINode *GenericDINode::getImpl(LLVMContext &Context, unsigned Tag,
255  MDString *Header,
256  ArrayRef<Metadata *> DwarfOps,
257  StorageType Storage, bool ShouldCreate) {
258  unsigned Hash = 0;
259  if (Storage == Uniqued) {
260  GenericDINodeInfo::KeyTy Key(Tag, Header, DwarfOps);
261  if (auto *N = getUniqued(Context.pImpl->GenericDINodes, Key))
262  return N;
263  if (!ShouldCreate)
264  return nullptr;
265  Hash = Key.getHash();
266  } else {
267  assert(ShouldCreate && "Expected non-uniqued nodes to always be created");
268  }
269 
270  // Use a nullptr for empty headers.
271  assert(isCanonical(Header) && "Expected canonical MDString");
272  Metadata *PreOps[] = {Header};
273  return storeImpl(new (DwarfOps.size() + 1) GenericDINode(
274  Context, Storage, Hash, Tag, PreOps, DwarfOps),
275  Storage, Context.pImpl->GenericDINodes);
276 }
277 
278 void GenericDINode::recalculateHash() {
279  setHash(GenericDINodeInfo::KeyTy::calculateHash(this));
280 }
281 
282 #define UNWRAP_ARGS_IMPL(...) __VA_ARGS__
283 #define UNWRAP_ARGS(ARGS) UNWRAP_ARGS_IMPL ARGS
284 #define DEFINE_GETIMPL_LOOKUP(CLASS, ARGS) \
285  do { \
286  if (Storage == Uniqued) { \
287  if (auto *N = getUniqued(Context.pImpl->CLASS##s, \
288  CLASS##Info::KeyTy(UNWRAP_ARGS(ARGS)))) \
289  return N; \
290  if (!ShouldCreate) \
291  return nullptr; \
292  } else { \
293  assert(ShouldCreate && \
294  "Expected non-uniqued nodes to always be created"); \
295  } \
296  } while (false)
297 #define DEFINE_GETIMPL_STORE(CLASS, ARGS, OPS) \
298  return storeImpl(new (array_lengthof(OPS)) \
299  CLASS(Context, Storage, UNWRAP_ARGS(ARGS), OPS), \
300  Storage, Context.pImpl->CLASS##s)
301 #define DEFINE_GETIMPL_STORE_NO_OPS(CLASS, ARGS) \
302  return storeImpl(new (0u) CLASS(Context, Storage, UNWRAP_ARGS(ARGS)), \
303  Storage, Context.pImpl->CLASS##s)
304 #define DEFINE_GETIMPL_STORE_NO_CONSTRUCTOR_ARGS(CLASS, OPS) \
305  return storeImpl(new (array_lengthof(OPS)) CLASS(Context, Storage, OPS), \
306  Storage, Context.pImpl->CLASS##s)
307 #define DEFINE_GETIMPL_STORE_N(CLASS, ARGS, OPS, NUM_OPS) \
308  return storeImpl(new (NUM_OPS) \
309  CLASS(Context, Storage, UNWRAP_ARGS(ARGS), OPS), \
310  Storage, Context.pImpl->CLASS##s)
311 
312 DISubrange *DISubrange::getImpl(LLVMContext &Context, int64_t Count, int64_t Lo,
313  StorageType Storage, bool ShouldCreate) {
314  auto *CountNode = ConstantAsMetadata::get(
315  ConstantInt::getSigned(Type::getInt64Ty(Context), Count));
316  return getImpl(Context, CountNode, Lo, Storage, ShouldCreate);
317 }
318 
319 DISubrange *DISubrange::getImpl(LLVMContext &Context, Metadata *CountNode,
320  int64_t Lo, StorageType Storage,
321  bool ShouldCreate) {
322  DEFINE_GETIMPL_LOOKUP(DISubrange, (CountNode, Lo));
323  Metadata *Ops[] = { CountNode };
324  DEFINE_GETIMPL_STORE(DISubrange, (CountNode, Lo), Ops);
325 }
326 
327 DIEnumerator *DIEnumerator::getImpl(LLVMContext &Context, int64_t Value,
328  bool IsUnsigned, MDString *Name,
329  StorageType Storage, bool ShouldCreate) {
330  assert(isCanonical(Name) && "Expected canonical MDString");
331  DEFINE_GETIMPL_LOOKUP(DIEnumerator, (Value, IsUnsigned, Name));
332  Metadata *Ops[] = {Name};
333  DEFINE_GETIMPL_STORE(DIEnumerator, (Value, IsUnsigned), Ops);
334 }
335 
336 DIBasicType *DIBasicType::getImpl(LLVMContext &Context, unsigned Tag,
337  MDString *Name, uint64_t SizeInBits,
338  uint32_t AlignInBits, unsigned Encoding,
339  DIFlags Flags, StorageType Storage,
340  bool ShouldCreate) {
341  assert(isCanonical(Name) && "Expected canonical MDString");
343  (Tag, Name, SizeInBits, AlignInBits, Encoding, Flags));
344  Metadata *Ops[] = {nullptr, nullptr, Name};
345  DEFINE_GETIMPL_STORE(DIBasicType, (Tag, SizeInBits, AlignInBits, Encoding,
346  Flags), Ops);
347 }
348 
350  switch (getEncoding()) {
351  case dwarf::DW_ATE_signed:
352  case dwarf::DW_ATE_signed_char:
353  return Signedness::Signed;
354  case dwarf::DW_ATE_unsigned:
355  case dwarf::DW_ATE_unsigned_char:
356  return Signedness::Unsigned;
357  default:
358  return None;
359  }
360 }
361 
362 DIDerivedType *DIDerivedType::getImpl(
363  LLVMContext &Context, unsigned Tag, MDString *Name, Metadata *File,
364  unsigned Line, Metadata *Scope, Metadata *BaseType, uint64_t SizeInBits,
365  uint32_t AlignInBits, uint64_t OffsetInBits,
366  Optional<unsigned> DWARFAddressSpace, DIFlags Flags, Metadata *ExtraData,
367  StorageType Storage, bool ShouldCreate) {
368  assert(isCanonical(Name) && "Expected canonical MDString");
370  (Tag, Name, File, Line, Scope, BaseType, SizeInBits,
371  AlignInBits, OffsetInBits, DWARFAddressSpace, Flags,
372  ExtraData));
373  Metadata *Ops[] = {File, Scope, Name, BaseType, ExtraData};
375  DIDerivedType, (Tag, Line, SizeInBits, AlignInBits, OffsetInBits,
376  DWARFAddressSpace, Flags), Ops);
377 }
378 
379 DICompositeType *DICompositeType::getImpl(
380  LLVMContext &Context, unsigned Tag, MDString *Name, Metadata *File,
381  unsigned Line, Metadata *Scope, Metadata *BaseType, uint64_t SizeInBits,
382  uint32_t AlignInBits, uint64_t OffsetInBits, DIFlags Flags,
383  Metadata *Elements, unsigned RuntimeLang, Metadata *VTableHolder,
384  Metadata *TemplateParams, MDString *Identifier, Metadata *Discriminator,
385  StorageType Storage, bool ShouldCreate) {
386  assert(isCanonical(Name) && "Expected canonical MDString");
387 
388  // Keep this in sync with buildODRType.
390  DICompositeType, (Tag, Name, File, Line, Scope, BaseType, SizeInBits,
391  AlignInBits, OffsetInBits, Flags, Elements, RuntimeLang,
392  VTableHolder, TemplateParams, Identifier, Discriminator));
393  Metadata *Ops[] = {File, Scope, Name, BaseType,
394  Elements, VTableHolder, TemplateParams, Identifier,
395  Discriminator};
396  DEFINE_GETIMPL_STORE(DICompositeType, (Tag, Line, RuntimeLang, SizeInBits,
397  AlignInBits, OffsetInBits, Flags),
398  Ops);
399 }
400 
402  LLVMContext &Context, MDString &Identifier, unsigned Tag, MDString *Name,
403  Metadata *File, unsigned Line, Metadata *Scope, Metadata *BaseType,
404  uint64_t SizeInBits, uint32_t AlignInBits, uint64_t OffsetInBits,
405  DIFlags Flags, Metadata *Elements, unsigned RuntimeLang,
406  Metadata *VTableHolder, Metadata *TemplateParams, Metadata *Discriminator) {
407  assert(!Identifier.getString().empty() && "Expected valid identifier");
408  if (!Context.isODRUniquingDebugTypes())
409  return nullptr;
410  auto *&CT = (*Context.pImpl->DITypeMap)[&Identifier];
411  if (!CT)
412  return CT = DICompositeType::getDistinct(
413  Context, Tag, Name, File, Line, Scope, BaseType, SizeInBits,
414  AlignInBits, OffsetInBits, Flags, Elements, RuntimeLang,
415  VTableHolder, TemplateParams, &Identifier, Discriminator);
416 
417  // Only mutate CT if it's a forward declaration and the new operands aren't.
418  assert(CT->getRawIdentifier() == &Identifier && "Wrong ODR identifier?");
419  if (!CT->isForwardDecl() || (Flags & DINode::FlagFwdDecl))
420  return CT;
421 
422  // Mutate CT in place. Keep this in sync with getImpl.
423  CT->mutate(Tag, Line, RuntimeLang, SizeInBits, AlignInBits, OffsetInBits,
424  Flags);
425  Metadata *Ops[] = {File, Scope, Name, BaseType,
426  Elements, VTableHolder, TemplateParams, &Identifier,
427  Discriminator};
428  assert((std::end(Ops) - std::begin(Ops)) == (int)CT->getNumOperands() &&
429  "Mismatched number of operands");
430  for (unsigned I = 0, E = CT->getNumOperands(); I != E; ++I)
431  if (Ops[I] != CT->getOperand(I))
432  CT->setOperand(I, Ops[I]);
433  return CT;
434 }
435 
436 DICompositeType *DICompositeType::getODRType(
437  LLVMContext &Context, MDString &Identifier, unsigned Tag, MDString *Name,
438  Metadata *File, unsigned Line, Metadata *Scope, Metadata *BaseType,
439  uint64_t SizeInBits, uint32_t AlignInBits, uint64_t OffsetInBits,
440  DIFlags Flags, Metadata *Elements, unsigned RuntimeLang,
441  Metadata *VTableHolder, Metadata *TemplateParams, Metadata *Discriminator) {
442  assert(!Identifier.getString().empty() && "Expected valid identifier");
443  if (!Context.isODRUniquingDebugTypes())
444  return nullptr;
445  auto *&CT = (*Context.pImpl->DITypeMap)[&Identifier];
446  if (!CT)
448  Context, Tag, Name, File, Line, Scope, BaseType, SizeInBits,
449  AlignInBits, OffsetInBits, Flags, Elements, RuntimeLang, VTableHolder,
450  TemplateParams, &Identifier, Discriminator);
451  return CT;
452 }
453 
455  MDString &Identifier) {
456  assert(!Identifier.getString().empty() && "Expected valid identifier");
457  if (!Context.isODRUniquingDebugTypes())
458  return nullptr;
459  return Context.pImpl->DITypeMap->lookup(&Identifier);
460 }
461 
462 DISubroutineType *DISubroutineType::getImpl(LLVMContext &Context, DIFlags Flags,
463  uint8_t CC, Metadata *TypeArray,
464  StorageType Storage,
465  bool ShouldCreate) {
466  DEFINE_GETIMPL_LOOKUP(DISubroutineType, (Flags, CC, TypeArray));
467  Metadata *Ops[] = {nullptr, nullptr, nullptr, TypeArray};
468  DEFINE_GETIMPL_STORE(DISubroutineType, (Flags, CC), Ops);
469 }
470 
471 // FIXME: Implement this string-enum correspondence with a .def file and macros,
472 // so that the association is explicit rather than implied.
473 static const char *ChecksumKindName[DIFile::CSK_Last] = {
474  "CSK_MD5",
475  "CSK_SHA1"
476 };
477 
478 StringRef DIFile::getChecksumKindAsString(ChecksumKind CSKind) {
479  assert(CSKind <= DIFile::CSK_Last && "Invalid checksum kind");
480  // The first space was originally the CSK_None variant, which is now
481  // obsolete, but the space is still reserved in ChecksumKind, so we account
482  // for it here.
483  return ChecksumKindName[CSKind - 1];
484 }
485 
488  .Case("CSK_MD5", DIFile::CSK_MD5)
489  .Case("CSK_SHA1", DIFile::CSK_SHA1)
490  .Default(None);
491 }
492 
493 DIFile *DIFile::getImpl(LLVMContext &Context, MDString *Filename,
494  MDString *Directory,
497  bool ShouldCreate) {
498  assert(isCanonical(Filename) && "Expected canonical MDString");
499  assert(isCanonical(Directory) && "Expected canonical MDString");
500  assert((!CS || isCanonical(CS->Value)) && "Expected canonical MDString");
501  assert((!Source || isCanonical(*Source)) && "Expected canonical MDString");
502  DEFINE_GETIMPL_LOOKUP(DIFile, (Filename, Directory, CS, Source));
503  Metadata *Ops[] = {Filename, Directory, CS ? CS->Value : nullptr,
504  Source.getValueOr(nullptr)};
505  DEFINE_GETIMPL_STORE(DIFile, (CS, Source), Ops);
506 }
507 
508 DICompileUnit *DICompileUnit::getImpl(
509  LLVMContext &Context, unsigned SourceLanguage, Metadata *File,
510  MDString *Producer, bool IsOptimized, MDString *Flags,
511  unsigned RuntimeVersion, MDString *SplitDebugFilename,
512  unsigned EmissionKind, Metadata *EnumTypes, Metadata *RetainedTypes,
513  Metadata *GlobalVariables, Metadata *ImportedEntities, Metadata *Macros,
514  uint64_t DWOId, bool SplitDebugInlining, bool DebugInfoForProfiling,
515  unsigned NameTableKind, bool RangesBaseAddress, StorageType Storage,
516  bool ShouldCreate) {
517  assert(Storage != Uniqued && "Cannot unique DICompileUnit");
518  assert(isCanonical(Producer) && "Expected canonical MDString");
519  assert(isCanonical(Flags) && "Expected canonical MDString");
520  assert(isCanonical(SplitDebugFilename) && "Expected canonical MDString");
521 
522  Metadata *Ops[] = {
523  File, Producer, Flags, SplitDebugFilename,
524  EnumTypes, RetainedTypes, GlobalVariables, ImportedEntities,
525  Macros};
526  return storeImpl(new (array_lengthof(Ops)) DICompileUnit(
527  Context, Storage, SourceLanguage, IsOptimized,
528  RuntimeVersion, EmissionKind, DWOId, SplitDebugInlining,
529  DebugInfoForProfiling, NameTableKind, RangesBaseAddress,
530  Ops),
531  Storage);
532 }
533 
537  .Case("NoDebug", NoDebug)
538  .Case("FullDebug", FullDebug)
539  .Case("LineTablesOnly", LineTablesOnly)
540  .Case("DebugDirectivesOnly", DebugDirectivesOnly)
541  .Default(None);
542 }
543 
547  .Case("Default", DebugNameTableKind::Default)
550  .Default(None);
551 }
552 
554  switch (EK) {
555  case NoDebug: return "NoDebug";
556  case FullDebug: return "FullDebug";
557  case LineTablesOnly: return "LineTablesOnly";
558  case DebugDirectivesOnly: return "DebugDirectivesOnly";
559  }
560  return nullptr;
561 }
562 
564  switch (NTK) {
566  return nullptr;
568  return "GNU";
570  return "None";
571  }
572  return nullptr;
573 }
574 
576  if (auto *Block = dyn_cast<DILexicalBlockBase>(this))
577  return Block->getScope()->getSubprogram();
578  return const_cast<DISubprogram *>(cast<DISubprogram>(this));
579 }
580 
582  if (auto *File = dyn_cast<DILexicalBlockFile>(this))
583  return File->getScope()->getNonLexicalBlockFileScope();
584  return const_cast<DILocalScope *>(this);
585 }
586 
589 #define HANDLE_DISP_FLAG(ID, NAME) .Case("DISPFlag" #NAME, SPFlag##NAME)
590 #include "llvm/IR/DebugInfoFlags.def"
591  .Default(SPFlagZero);
592 }
593 
595  switch (Flag) {
596  // Appease a warning.
597  case SPFlagVirtuality:
598  return "";
599 #define HANDLE_DISP_FLAG(ID, NAME) \
600  case SPFlag##NAME: \
601  return "DISPFlag" #NAME;
602 #include "llvm/IR/DebugInfoFlags.def"
603  }
604  return "";
605 }
606 
609  SmallVectorImpl<DISPFlags> &SplitFlags) {
610  // Multi-bit fields can require special handling. In our case, however, the
611  // only multi-bit field is virtuality, and all its values happen to be
612  // single-bit values, so the right behavior just falls out.
613 #define HANDLE_DISP_FLAG(ID, NAME) \
614  if (DISPFlags Bit = Flags & SPFlag##NAME) { \
615  SplitFlags.push_back(Bit); \
616  Flags &= ~Bit; \
617  }
618 #include "llvm/IR/DebugInfoFlags.def"
619  return Flags;
620 }
621 
622 DISubprogram *DISubprogram::getImpl(
623  LLVMContext &Context, Metadata *Scope, MDString *Name,
624  MDString *LinkageName, Metadata *File, unsigned Line, Metadata *Type,
625  unsigned ScopeLine, Metadata *ContainingType, unsigned VirtualIndex,
626  int ThisAdjustment, DIFlags Flags, DISPFlags SPFlags, Metadata *Unit,
627  Metadata *TemplateParams, Metadata *Declaration, Metadata *RetainedNodes,
628  Metadata *ThrownTypes, StorageType Storage, bool ShouldCreate) {
629  assert(isCanonical(Name) && "Expected canonical MDString");
630  assert(isCanonical(LinkageName) && "Expected canonical MDString");
632  (Scope, Name, LinkageName, File, Line, Type, ScopeLine,
633  ContainingType, VirtualIndex, ThisAdjustment, Flags,
634  SPFlags, Unit, TemplateParams, Declaration,
635  RetainedNodes, ThrownTypes));
637  File, Scope, Name, LinkageName, Type, Unit,
638  Declaration, RetainedNodes, ContainingType, TemplateParams, ThrownTypes};
639  if (!ThrownTypes) {
640  Ops.pop_back();
641  if (!TemplateParams) {
642  Ops.pop_back();
643  if (!ContainingType)
644  Ops.pop_back();
645  }
646  }
648  DISubprogram,
649  (Line, ScopeLine, VirtualIndex, ThisAdjustment, Flags, SPFlags), Ops,
650  Ops.size());
651 }
652 
653 bool DISubprogram::describes(const Function *F) const {
654  assert(F && "Invalid function");
655  if (F->getSubprogram() == this)
656  return true;
657  StringRef Name = getLinkageName();
658  if (Name.empty())
659  Name = getName();
660  return F->getName() == Name;
661 }
662 
663 DILexicalBlock *DILexicalBlock::getImpl(LLVMContext &Context, Metadata *Scope,
664  Metadata *File, unsigned Line,
665  unsigned Column, StorageType Storage,
666  bool ShouldCreate) {
667  // Fixup column.
668  adjustColumn(Column);
669 
670  assert(Scope && "Expected scope");
671  DEFINE_GETIMPL_LOOKUP(DILexicalBlock, (Scope, File, Line, Column));
672  Metadata *Ops[] = {File, Scope};
673  DEFINE_GETIMPL_STORE(DILexicalBlock, (Line, Column), Ops);
674 }
675 
676 DILexicalBlockFile *DILexicalBlockFile::getImpl(LLVMContext &Context,
677  Metadata *Scope, Metadata *File,
678  unsigned Discriminator,
679  StorageType Storage,
680  bool ShouldCreate) {
681  assert(Scope && "Expected scope");
682  DEFINE_GETIMPL_LOOKUP(DILexicalBlockFile, (Scope, File, Discriminator));
683  Metadata *Ops[] = {File, Scope};
684  DEFINE_GETIMPL_STORE(DILexicalBlockFile, (Discriminator), Ops);
685 }
686 
687 DINamespace *DINamespace::getImpl(LLVMContext &Context, Metadata *Scope,
688  MDString *Name, bool ExportSymbols,
689  StorageType Storage, bool ShouldCreate) {
690  assert(isCanonical(Name) && "Expected canonical MDString");
691  DEFINE_GETIMPL_LOOKUP(DINamespace, (Scope, Name, ExportSymbols));
692  // The nullptr is for DIScope's File operand. This should be refactored.
693  Metadata *Ops[] = {nullptr, Scope, Name};
694  DEFINE_GETIMPL_STORE(DINamespace, (ExportSymbols), Ops);
695 }
696 
697 DIModule *DIModule::getImpl(LLVMContext &Context, Metadata *Scope,
698  MDString *Name, MDString *ConfigurationMacros,
699  MDString *IncludePath, MDString *ISysRoot,
700  StorageType Storage, bool ShouldCreate) {
701  assert(isCanonical(Name) && "Expected canonical MDString");
703  DIModule, (Scope, Name, ConfigurationMacros, IncludePath, ISysRoot));
704  Metadata *Ops[] = {Scope, Name, ConfigurationMacros, IncludePath, ISysRoot};
706 }
707 
708 DITemplateTypeParameter *DITemplateTypeParameter::getImpl(LLVMContext &Context,
709  MDString *Name,
710  Metadata *Type,
711  StorageType Storage,
712  bool ShouldCreate) {
713  assert(isCanonical(Name) && "Expected canonical MDString");
715  Metadata *Ops[] = {Name, Type};
717 }
718 
719 DITemplateValueParameter *DITemplateValueParameter::getImpl(
720  LLVMContext &Context, unsigned Tag, MDString *Name, Metadata *Type,
721  Metadata *Value, StorageType Storage, bool ShouldCreate) {
722  assert(isCanonical(Name) && "Expected canonical MDString");
723  DEFINE_GETIMPL_LOOKUP(DITemplateValueParameter, (Tag, Name, Type, Value));
724  Metadata *Ops[] = {Name, Type, Value};
726 }
727 
729 DIGlobalVariable::getImpl(LLVMContext &Context, Metadata *Scope, MDString *Name,
730  MDString *LinkageName, Metadata *File, unsigned Line,
731  Metadata *Type, bool IsLocalToUnit, bool IsDefinition,
732  Metadata *StaticDataMemberDeclaration,
733  Metadata *TemplateParams, uint32_t AlignInBits,
734  StorageType Storage, bool ShouldCreate) {
735  assert(isCanonical(Name) && "Expected canonical MDString");
736  assert(isCanonical(LinkageName) && "Expected canonical MDString");
737  DEFINE_GETIMPL_LOOKUP(DIGlobalVariable, (Scope, Name, LinkageName, File, Line,
738  Type, IsLocalToUnit, IsDefinition,
739  StaticDataMemberDeclaration,
740  TemplateParams, AlignInBits));
741  Metadata *Ops[] = {Scope,
742  Name,
743  File,
744  Type,
745  Name,
746  LinkageName,
747  StaticDataMemberDeclaration,
748  TemplateParams};
750  (Line, IsLocalToUnit, IsDefinition, AlignInBits), Ops);
751 }
752 
753 DILocalVariable *DILocalVariable::getImpl(LLVMContext &Context, Metadata *Scope,
754  MDString *Name, Metadata *File,
755  unsigned Line, Metadata *Type,
756  unsigned Arg, DIFlags Flags,
757  uint32_t AlignInBits,
758  StorageType Storage,
759  bool ShouldCreate) {
760  // 64K ought to be enough for any frontend.
761  assert(Arg <= UINT16_MAX && "Expected argument number to fit in 16-bits");
762 
763  assert(Scope && "Expected scope");
764  assert(isCanonical(Name) && "Expected canonical MDString");
766  (Scope, Name, File, Line, Type, Arg, Flags,
767  AlignInBits));
768  Metadata *Ops[] = {Scope, Name, File, Type};
769  DEFINE_GETIMPL_STORE(DILocalVariable, (Line, Arg, Flags, AlignInBits), Ops);
770 }
771 
773  // This is used by the Verifier so be mindful of broken types.
774  const Metadata *RawType = getRawType();
775  while (RawType) {
776  // Try to get the size directly.
777  if (auto *T = dyn_cast<DIType>(RawType))
778  if (uint64_t Size = T->getSizeInBits())
779  return Size;
780 
781  if (auto *DT = dyn_cast<DIDerivedType>(RawType)) {
782  // Look at the base type.
783  RawType = DT->getRawBaseType();
784  continue;
785  }
786 
787  // Missing type or size.
788  break;
789  }
790 
791  // Fail gracefully.
792  return None;
793 }
794 
795 DILabel *DILabel::getImpl(LLVMContext &Context, Metadata *Scope,
796  MDString *Name, Metadata *File, unsigned Line,
797  StorageType Storage,
798  bool ShouldCreate) {
799  assert(Scope && "Expected scope");
800  assert(isCanonical(Name) && "Expected canonical MDString");
802  (Scope, Name, File, Line));
803  Metadata *Ops[] = {Scope, Name, File};
804  DEFINE_GETIMPL_STORE(DILabel, (Line), Ops);
805 }
806 
807 DIExpression *DIExpression::getImpl(LLVMContext &Context,
808  ArrayRef<uint64_t> Elements,
809  StorageType Storage, bool ShouldCreate) {
810  DEFINE_GETIMPL_LOOKUP(DIExpression, (Elements));
812 }
813 
815  switch (getOp()) {
817  return 3;
818  case dwarf::DW_OP_constu:
819  case dwarf::DW_OP_plus_uconst:
820  return 2;
821  default:
822  return 1;
823  }
824 }
825 
826 bool DIExpression::isValid() const {
827  for (auto I = expr_op_begin(), E = expr_op_end(); I != E; ++I) {
828  // Check that there's space for the operand.
829  if (I->get() + I->getSize() > E->get())
830  return false;
831 
832  // Check that the operand is valid.
833  switch (I->getOp()) {
834  default:
835  return false;
837  // A fragment operator must appear at the end.
838  return I->get() + I->getSize() == E->get();
839  case dwarf::DW_OP_stack_value: {
840  // Must be the last one or followed by a DW_OP_LLVM_fragment.
841  if (I->get() + I->getSize() == E->get())
842  break;
843  auto J = I;
844  if ((++J)->getOp() != dwarf::DW_OP_LLVM_fragment)
845  return false;
846  break;
847  }
848  case dwarf::DW_OP_swap: {
849  // Must be more than one implicit element on the stack.
850 
851  // FIXME: A better way to implement this would be to add a local variable
852  // that keeps track of the stack depth and introduce something like a
853  // DW_LLVM_OP_implicit_location as a placeholder for the location this
854  // DIExpression is attached to, or else pass the number of implicit stack
855  // elements into isValid.
856  if (getNumElements() == 1)
857  return false;
858  break;
859  }
860  case dwarf::DW_OP_constu:
861  case dwarf::DW_OP_plus_uconst:
862  case dwarf::DW_OP_plus:
863  case dwarf::DW_OP_minus:
864  case dwarf::DW_OP_mul:
865  case dwarf::DW_OP_div:
866  case dwarf::DW_OP_mod:
867  case dwarf::DW_OP_or:
868  case dwarf::DW_OP_and:
869  case dwarf::DW_OP_xor:
870  case dwarf::DW_OP_shl:
871  case dwarf::DW_OP_shr:
872  case dwarf::DW_OP_shra:
873  case dwarf::DW_OP_deref:
874  case dwarf::DW_OP_xderef:
875  case dwarf::DW_OP_lit0:
876  case dwarf::DW_OP_not:
877  case dwarf::DW_OP_dup:
878  break;
879  }
880  }
881  return true;
882 }
883 
886  for (auto I = Start; I != End; ++I)
887  if (I->getOp() == dwarf::DW_OP_LLVM_fragment) {
888  DIExpression::FragmentInfo Info = {I->getArg(1), I->getArg(0)};
889  return Info;
890  }
891  return None;
892 }
893 
895  int64_t Offset) {
896  if (Offset > 0) {
897  Ops.push_back(dwarf::DW_OP_plus_uconst);
898  Ops.push_back(Offset);
899  } else if (Offset < 0) {
900  Ops.push_back(dwarf::DW_OP_constu);
901  Ops.push_back(-Offset);
902  Ops.push_back(dwarf::DW_OP_minus);
903  }
904 }
905 
906 bool DIExpression::extractIfOffset(int64_t &Offset) const {
907  if (getNumElements() == 0) {
908  Offset = 0;
909  return true;
910  }
911 
912  if (getNumElements() == 2 && Elements[0] == dwarf::DW_OP_plus_uconst) {
913  Offset = Elements[1];
914  return true;
915  }
916 
917  if (getNumElements() == 3 && Elements[0] == dwarf::DW_OP_constu) {
918  if (Elements[2] == dwarf::DW_OP_plus) {
919  Offset = Elements[1];
920  return true;
921  }
922  if (Elements[2] == dwarf::DW_OP_minus) {
923  Offset = -Elements[1];
924  return true;
925  }
926  }
927 
928  return false;
929 }
930 
932  unsigned &AddrClass) {
933  const unsigned PatternSize = 4;
934  if (Expr->Elements.size() >= PatternSize &&
935  Expr->Elements[PatternSize - 4] == dwarf::DW_OP_constu &&
936  Expr->Elements[PatternSize - 2] == dwarf::DW_OP_swap &&
937  Expr->Elements[PatternSize - 1] == dwarf::DW_OP_xderef) {
938  AddrClass = Expr->Elements[PatternSize - 3];
939 
940  if (Expr->Elements.size() == PatternSize)
941  return nullptr;
942  return DIExpression::get(Expr->getContext(),
943  makeArrayRef(&*Expr->Elements.begin(),
944  Expr->Elements.size() - PatternSize));
945  }
946  return Expr;
947 }
948 
949 DIExpression *DIExpression::prepend(const DIExpression *Expr, bool DerefBefore,
950  int64_t Offset, bool DerefAfter,
951  bool StackValue) {
953  if (DerefBefore)
954  Ops.push_back(dwarf::DW_OP_deref);
955 
956  appendOffset(Ops, Offset);
957  if (DerefAfter)
958  Ops.push_back(dwarf::DW_OP_deref);
959 
960  return prependOpcodes(Expr, Ops, StackValue);
961 }
962 
965  bool StackValue) {
966  assert(Expr && "Can't prepend ops to this expression");
967 
968  // If there are no ops to prepend, do not even add the DW_OP_stack_value.
969  if (Ops.empty())
970  StackValue = false;
971  for (auto Op : Expr->expr_ops()) {
972  // A DW_OP_stack_value comes at the end, but before a DW_OP_LLVM_fragment.
973  if (StackValue) {
974  if (Op.getOp() == dwarf::DW_OP_stack_value)
975  StackValue = false;
976  else if (Op.getOp() == dwarf::DW_OP_LLVM_fragment) {
977  Ops.push_back(dwarf::DW_OP_stack_value);
978  StackValue = false;
979  }
980  }
981  Op.appendToVector(Ops);
982  }
983  if (StackValue)
984  Ops.push_back(dwarf::DW_OP_stack_value);
985  return DIExpression::get(Expr->getContext(), Ops);
986 }
987 
989  ArrayRef<uint64_t> Ops) {
990  assert(Expr && !Ops.empty() && "Can't append ops to this expression");
991 
992  // Copy Expr's current op list.
994  for (auto Op : Expr->expr_ops()) {
995  // Append new opcodes before DW_OP_{stack_value, LLVM_fragment}.
996  if (Op.getOp() == dwarf::DW_OP_stack_value ||
997  Op.getOp() == dwarf::DW_OP_LLVM_fragment) {
998  NewOps.append(Ops.begin(), Ops.end());
999 
1000  // Ensure that the new opcodes are only appended once.
1001  Ops = None;
1002  }
1003  Op.appendToVector(NewOps);
1004  }
1005 
1006  NewOps.append(Ops.begin(), Ops.end());
1007  return DIExpression::get(Expr->getContext(), NewOps);
1008 }
1009 
1011  ArrayRef<uint64_t> Ops) {
1012  assert(Expr && !Ops.empty() && "Can't append ops to this expression");
1013  assert(none_of(Ops,
1014  [](uint64_t Op) {
1015  return Op == dwarf::DW_OP_stack_value ||
1017  }) &&
1018  "Can't append this op");
1019 
1020  // Append a DW_OP_deref after Expr's current op list if it's non-empty and
1021  // has no DW_OP_stack_value.
1022  //
1023  // Match .* DW_OP_stack_value (DW_OP_LLVM_fragment A B)?.
1025  unsigned DropUntilStackValue = FI.hasValue() ? 3 : 0;
1026  ArrayRef<uint64_t> ExprOpsBeforeFragment =
1027  Expr->getElements().drop_back(DropUntilStackValue);
1028  bool NeedsDeref = (Expr->getNumElements() > DropUntilStackValue) &&
1029  (ExprOpsBeforeFragment.back() != dwarf::DW_OP_stack_value);
1030  bool NeedsStackValue = NeedsDeref || ExprOpsBeforeFragment.empty();
1031 
1032  // Append a DW_OP_deref after Expr's current op list if needed, then append
1033  // the new ops, and finally ensure that a single DW_OP_stack_value is present.
1035  if (NeedsDeref)
1036  NewOps.push_back(dwarf::DW_OP_deref);
1037  NewOps.append(Ops.begin(), Ops.end());
1038  if (NeedsStackValue)
1039  NewOps.push_back(dwarf::DW_OP_stack_value);
1040  return DIExpression::append(Expr, NewOps);
1041 }
1042 
1044  const DIExpression *Expr, unsigned OffsetInBits, unsigned SizeInBits) {
1046  // Copy over the expression, but leave off any trailing DW_OP_LLVM_fragment.
1047  if (Expr) {
1048  for (auto Op : Expr->expr_ops()) {
1049  switch (Op.getOp()) {
1050  default: break;
1051  case dwarf::DW_OP_plus:
1052  case dwarf::DW_OP_minus:
1053  // We can't safely split arithmetic into multiple fragments because we
1054  // can't express carry-over between fragments.
1055  //
1056  // FIXME: We *could* preserve the lowest fragment of a constant offset
1057  // operation if the offset fits into SizeInBits.
1058  return None;
1060  // Make the new offset point into the existing fragment.
1061  uint64_t FragmentOffsetInBits = Op.getArg(0);
1062  uint64_t FragmentSizeInBits = Op.getArg(1);
1063  (void)FragmentSizeInBits;
1064  assert((OffsetInBits + SizeInBits <= FragmentSizeInBits) &&
1065  "new fragment outside of original fragment");
1066  OffsetInBits += FragmentOffsetInBits;
1067  continue;
1068  }
1069  }
1070  Op.appendToVector(Ops);
1071  }
1072  }
1074  Ops.push_back(OffsetInBits);
1075  Ops.push_back(SizeInBits);
1076  return DIExpression::get(Expr->getContext(), Ops);
1077 }
1078 
1080  // Recognize DW_OP_constu C DW_OP_stack_value (DW_OP_LLVM_fragment Len Ofs)?.
1081  if (getNumElements() != 3 && getNumElements() != 6)
1082  return false;
1083  if (getElement(0) != dwarf::DW_OP_constu ||
1084  getElement(2) != dwarf::DW_OP_stack_value)
1085  return false;
1086  if (getNumElements() == 6 && getElement(3) != dwarf::DW_OP_LLVM_fragment)
1087  return false;
1088  return true;
1089 }
1090 
1092 DIGlobalVariableExpression::getImpl(LLVMContext &Context, Metadata *Variable,
1093  Metadata *Expression, StorageType Storage,
1094  bool ShouldCreate) {
1095  DEFINE_GETIMPL_LOOKUP(DIGlobalVariableExpression, (Variable, Expression));
1096  Metadata *Ops[] = {Variable, Expression};
1098 }
1099 
1100 DIObjCProperty *DIObjCProperty::getImpl(
1101  LLVMContext &Context, MDString *Name, Metadata *File, unsigned Line,
1102  MDString *GetterName, MDString *SetterName, unsigned Attributes,
1103  Metadata *Type, StorageType Storage, bool ShouldCreate) {
1104  assert(isCanonical(Name) && "Expected canonical MDString");
1105  assert(isCanonical(GetterName) && "Expected canonical MDString");
1106  assert(isCanonical(SetterName) && "Expected canonical MDString");
1107  DEFINE_GETIMPL_LOOKUP(DIObjCProperty, (Name, File, Line, GetterName,
1108  SetterName, Attributes, Type));
1109  Metadata *Ops[] = {Name, File, GetterName, SetterName, Type};
1110  DEFINE_GETIMPL_STORE(DIObjCProperty, (Line, Attributes), Ops);
1111 }
1112 
1113 DIImportedEntity *DIImportedEntity::getImpl(LLVMContext &Context, unsigned Tag,
1114  Metadata *Scope, Metadata *Entity,
1115  Metadata *File, unsigned Line,
1116  MDString *Name, StorageType Storage,
1117  bool ShouldCreate) {
1118  assert(isCanonical(Name) && "Expected canonical MDString");
1120  (Tag, Scope, Entity, File, Line, Name));
1121  Metadata *Ops[] = {Scope, Entity, Name, File};
1122  DEFINE_GETIMPL_STORE(DIImportedEntity, (Tag, Line), Ops);
1123 }
1124 
1125 DIMacro *DIMacro::getImpl(LLVMContext &Context, unsigned MIType,
1126  unsigned Line, MDString *Name, MDString *Value,
1127  StorageType Storage, bool ShouldCreate) {
1128  assert(isCanonical(Name) && "Expected canonical MDString");
1129  DEFINE_GETIMPL_LOOKUP(DIMacro, (MIType, Line, Name, Value));
1130  Metadata *Ops[] = { Name, Value };
1131  DEFINE_GETIMPL_STORE(DIMacro, (MIType, Line), Ops);
1132 }
1133 
1134 DIMacroFile *DIMacroFile::getImpl(LLVMContext &Context, unsigned MIType,
1135  unsigned Line, Metadata *File,
1136  Metadata *Elements, StorageType Storage,
1137  bool ShouldCreate) {
1139  (MIType, Line, File, Elements));
1140  Metadata *Ops[] = { File, Elements };
1141  DEFINE_GETIMPL_STORE(DIMacroFile, (MIType, Line), Ops);
1142 }
static void appendOffset(SmallVectorImpl< uint64_t > &Ops, int64_t Offset)
Append Ops with operations to apply the Offset.
uint64_t CallInst * C
const_iterator end(StringRef path)
Get end iterator over path.
Definition: Path.cpp:258
unsigned char Storage
Storage flag for non-uniqued, otherwise unowned, metadata.
Definition: Metadata.h:68
ArrayRef< uint64_t > getElements() const
bool isConstant() const
Determine whether this represents a standalone constant value.
static std::string getLinkageName(GlobalValue::LinkageTypes LT)
Definition: AsmWriter.cpp:2850
LLVMContext & Context
const T & back() const
back - Get the last element.
Definition: ArrayRef.h:157
const_iterator begin(StringRef path, Style style=Style::native)
Get begin iterator over path.
Definition: Path.cpp:249
static DICompositeType * getODRTypeIfExists(LLVMContext &Context, MDString &Identifier)
This class represents lattice values for constants.
Definition: AllocatorList.h:23
iterator begin() const
Definition: ArrayRef.h:136
static const DILocation * getMergedLocation(const DILocation *LocA, const DILocation *LocB)
When two instructions are combined into a single instruction we also need to combine the original loc...
amdgpu Simplify well known AMD library false FunctionCallee Value const Twine & Name
constexpr T getValueOr(U &&value) const LLVM_LVALUE_FUNCTION
Definition: Optional.h:173
#define DEFINE_GETIMPL_STORE_N(CLASS, ARGS, OPS, NUM_OPS)
unsigned getSize() const
Return the size of the operand.
static bool isCanonical(const MDString *S)
Optional< Signedness > getSignedness() const
Return the signedness of this type, or None if this type is neither signed nor unsigned.
Metadata node.
Definition: Metadata.h:863
F(f)
static T * storeImpl(T *N, StorageType Storage, StoreT &Store)
Definition: MetadataImpl.h:42
static IntegerType * getInt64Ty(LLVMContext &C)
Definition: Type.cpp:176
StringSwitch & Case(StringLiteral S, T Value)
Definition: StringSwitch.h:67
static Optional< ChecksumKind > getChecksumKind(StringRef CSKindStr)
A scope for locals.
#define DEFINE_GETIMPL_LOOKUP(CLASS, ARGS)
static DIExpression * prepend(const DIExpression *Expr, bool DerefBefore, int64_t Offset=0, bool DerefAfter=false, bool StackValue=false)
Prepend DIExpr with a deref and offset operation and optionally turn it into a stack value...
static DIExpression * prependOpcodes(const DIExpression *Expr, SmallVectorImpl< uint64_t > &Ops, bool StackValue=false)
Prepend DIExpr with the given opcodes and optionally turn it into a stack value.
static DISPFlags splitFlags(DISPFlags Flags, SmallVectorImpl< DISPFlags > &SplitFlags)
Split up a flags bitfield for easier printing.
ArrayRef< T > makeArrayRef(const T &OneElt)
Construct an ArrayRef from a single element.
Definition: ArrayRef.h:450
static StringRef getFlagString(DISPFlags Flag)
Array subrange.
This class consists of common code factored out of the SmallVector class to reduce code duplication b...
Definition: APFloat.h:41
LLVM_NODISCARD R Default(T Value)
Definition: StringSwitch.h:181
bool none_of(R &&Range, UnaryPredicate P)
Provide wrappers to std::none_of which take ranges instead of having to pass begin/end explicitly...
Definition: STLExtras.h:1199
static StringRef getName(Value *V)
Only used in LLVM metadata.
Definition: Dwarf.h:132
Holds a subclass of DINode.
LLVM_NODISCARD bool empty() const
empty - Check if the string is empty.
Definition: StringRef.h:126
Subprogram description.
Key
PAL metadata keys.
#define HANDLE_DISP_FLAG(ID, NAME)
Holds the characteristics of one fragment of a larger variable.
static DIExpression * append(const DIExpression *Expr, ArrayRef< uint64_t > Ops)
Append the opcodes Ops to DIExpr.
LLVMContext & getContext() const
Definition: Metadata.h:923
Enumeration value.
ArrayRef - Represent a constant reference to an array (0 or more elements consecutively in memory)...
Definition: APInt.h:32
static Optional< FragmentInfo > getFragmentInfo(expr_op_iterator Start, expr_op_iterator End)
Retrieve the details of this fragment expression.
Debug location.
static ConstantAsMetadata * get(Constant *C)
Definition: Metadata.h:409
Analysis containing CSE Info
Definition: CSEInfo.cpp:20
Flag
These should be considered private to the implementation of the MCInstrDesc class.
Definition: MCInstrDesc.h:117
StringRef getString() const
Definition: Metadata.cpp:463
static StringRef getFlagString(DIFlags Flag)
static MDTuple * get(LLVMContext &Context, ArrayRef< Metadata *> MDs)
Definition: Metadata.h:1165
A switch()-like statement whose cases are string literals.
Definition: StringSwitch.h:42
static T * getUniqued(DenseSet< T *, InfoT > &Store, const typename InfoT::KeyTy &Key)
Definition: MetadataImpl.h:22
A single checksum, represented by a Kind and a Value (a string).
static Optional< unsigned > encodeDiscriminator(unsigned BD, unsigned DF, unsigned CI)
Raw encoding of the discriminator.
The instances of the Type class are immutable: once they are created, they are never changed...
Definition: Type.h:45
This is an important class for using LLVM in a threaded context.
Definition: LLVMContext.h:68
DISubprogram * getSubprogram() const
Get the attached subprogram.
Definition: Metadata.cpp:1507
size_t size() const
size - Get the array size.
Definition: ArrayRef.h:148
static GCRegistry::Add< CoreCLRGC > E("coreclr", "CoreCLR-compatible GC")
#define DEFINE_GETIMPL_STORE(CLASS, ARGS, OPS)
static MDTuple * getDistinct(LLVMContext &Context, ArrayRef< Metadata *> MDs)
Definition: Metadata.h:1173
SmallSet - This maintains a set of unique values, optimizing for the case when the set is small (less...
Definition: SmallSet.h:134
static void adjustColumn(unsigned &Column)
SourceLanguage
Definition: Dwarf.h:185
static const char * nameTableKindString(DebugNameTableKind PK)
std::pair< iterator, bool > insert(PtrType Ptr)
Inserts Ptr if and only if there is no element in the container equal to Ptr.
Definition: SmallPtrSet.h:370
StorageType
Active type of storage.
Definition: Metadata.h:65
bool isODRUniquingDebugTypes() const
Whether there is a string map for uniquing debug info identifiers across the context.
A pair of DIGlobalVariable and DIExpression.
static DIExpression * appendToStack(const DIExpression *Expr, ArrayRef< uint64_t > Ops)
Convert DIExpr into a stack value if it isn&#39;t one already by appending DW_OP_deref if needed...
Optional< FragmentInfo > getFragmentInfo() const
Retrieve the details of this fragment expression.
amdgpu Simplify well known AMD library false FunctionCallee Value * Arg
std::pair< NoneType, bool > insert(const T &V)
insert - Insert an element into the set if it isn&#39;t already there.
Definition: SmallSet.h:180
DebugNameTableKind getNameTableKind() const
size_t size() const
Definition: SmallVector.h:52
LLVMContextImpl *const pImpl
Definition: LLVMContext.h:70
An imported module (C++ using directive or similar).
DILocalScope * getNonLexicalBlockFileScope() const
Get the first non DILexicalBlockFile scope of this scope.
Base class for scope-like contexts.
iterator_range< expr_op_iterator > expr_ops() const
BaseType
A given derived pointer can have multiple base pointers through phi/selects.
#define DEFINE_GETIMPL_STORE_NO_OPS(CLASS, ARGS)
SmallPtrSet - This class implements a set which is optimized for holding SmallSize or less elements...
Definition: SmallPtrSet.h:417
static DISPFlags getFlag(StringRef Flag)
StringRef getName() const
Optional< uint64_t > getSizeInBits() const
Determines the size of the variable&#39;s type.
This is a &#39;vector&#39; (really, a variable-sized array), optimized for the case when the array is small...
Definition: SmallVector.h:839
constexpr size_t array_lengthof(T(&)[N])
Find the length of an array.
Definition: STLExtras.h:1043
static DIFlags splitFlags(DIFlags Flags, SmallVectorImpl< DIFlags > &SplitFlags)
Split up a flags bitfield.
iterator end() const
Definition: ArrayRef.h:137
static GCRegistry::Add< StatepointGC > D("statepoint-example", "an example strategy for statepoint")
static ConstantInt * getSigned(IntegerType *Ty, int64_t V)
Return a ConstantInt with the specified value for the specified type.
Definition: Constants.cpp:635
ArrayRef< T > drop_back(size_t N=1) const
Drop the last N elements of the array.
Definition: ArrayRef.h:193
DWARF expression.
DISubprogram * getSubprogram() const
Get the subprogram for this scope.
DebugEmissionKind getEmissionKind() const
static DIFlags getFlag(StringRef Flag)
A (clang) module that has been imported by the compile unit.
unsigned unsigned DILocalScope * Scope
Generic tagged DWARF-like metadata node.
unsigned getNumElements() const
void append(in_iter in_start, in_iter in_end)
Add the specified range to the end of the SmallVector.
Definition: SmallVector.h:386
#define HANDLE_DI_FLAG(ID, NAME)
Type array for a subprogram.
bool hasValue() const
Definition: Optional.h:166
static const char * ChecksumKindName[DIFile::CSK_Last]
DIFlags
Debug info flags.
LLVM_NODISCARD bool empty() const
Definition: SmallVector.h:55
StringRef getName() const
Return a constant reference to the value&#39;s name.
Definition: Value.cpp:214
#define I(x, y, z)
Definition: MD5.cpp:58
#define N
uint32_t Size
Definition: Profile.cpp:46
bool extractIfOffset(int64_t &Offset) const
If this is a constant offset, extract it.
DISPFlags
Debug info subprogram flags.
static DICompositeType * buildODRType(LLVMContext &Context, MDString &Identifier, unsigned Tag, MDString *Name, Metadata *File, unsigned Line, Metadata *Scope, Metadata *BaseType, uint64_t SizeInBits, uint32_t AlignInBits, uint64_t OffsetInBits, DIFlags Flags, Metadata *Elements, unsigned RuntimeLang, Metadata *VTableHolder, Metadata *TemplateParams, Metadata *Discriminator)
Build a DICompositeType with the given ODR identifier.
assert(ImpDefSCC.getReg()==AMDGPU::SCC &&ImpDefSCC.isDef())
LLVM Value Representation.
Definition: Value.h:72
#define DEFINE_GETIMPL_STORE_NO_CONSTRUCTOR_ARGS(CLASS, OPS)
An iterator for expression operands.
StringRef - Represent a constant reference to a string, i.e.
Definition: StringRef.h:48
A single uniqued string.
Definition: Metadata.h:603
static LazyValueInfoImpl & getImpl(void *&PImpl, AssumptionCache *AC, const DataLayout *DL, DominatorTree *DT=nullptr)
This lazily constructs the LazyValueInfoImpl.
static void decodeDiscriminator(unsigned D, unsigned &BD, unsigned &DF, unsigned &CI)
Raw decoder for values in an encoded discriminator D.
Optional< DenseMap< const MDString *, DICompositeType * > > DITypeMap
Root of the metadata hierarchy.
Definition: Metadata.h:57
static const char * emissionKindString(DebugEmissionKind EK)
bool empty() const
empty - Check if the array is empty.
Definition: ArrayRef.h:143
static const DIExpression * extractAddressClass(const DIExpression *Expr, unsigned &AddrClass)
Checks if the last 4 elements of the expression are DW_OP_constu <DWARF address="" space>=""> DW_OP_s...
static Optional< DIExpression * > createFragmentExpression(const DIExpression *Expr, unsigned OffsetInBits, unsigned SizeInBits)
Create a DIExpression to describe one part of an aggregate variable that is fragmented across multipl...
Basic type, like &#39;int&#39; or &#39;float&#39;.
DIScopeRef getScope() const
size_type count(const T &V) const
count - Return 1 if the element is in the set, 0 otherwise.
Definition: SmallSet.h:164