include/llvm/IR/DebugInfoMetadata.h

   1 //===- llvm/IR/DebugInfoMetadata.h - Debug info metadata --------*- C++ -*-===//
   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 // Declarations for metadata specific to debug info.
  11 //
  12 //===----------------------------------------------------------------------===//
  13
  14 #ifndef LLVM_IR_DEBUGINFOMETADATA_H
  15 #define LLVM_IR_DEBUGINFOMETADATA_H
  16
  17 #include "llvm/IR/Metadata.h"
  18 #include "llvm/Support/Dwarf.h"
  19
  20 // Helper macros for defining get() overrides.
  21 #define DEFINE_MDNODE_GET_UNPACK_IMPL(...) __VA_ARGS__
  22 #define DEFINE_MDNODE_GET_UNPACK(ARGS) DEFINE_MDNODE_GET_UNPACK_IMPL ARGS
  23 #define DEFINE_MDNODE_GET_DISTINCT_TEMPORARY(CLASS, FORMAL, ARGS)              \
  24   static CLASS *getDistinct(LLVMContext &Context,                              \
  25                             DEFINE_MDNODE_GET_UNPACK(FORMAL)) {                \
  26     return getImpl(Context, DEFINE_MDNODE_GET_UNPACK(ARGS), Distinct);         \
  27   }                                                                            \
  28   static Temp##CLASS getTemporary(LLVMContext &Context,                        \
  29                                   DEFINE_MDNODE_GET_UNPACK(FORMAL)) {          \
  30     return Temp##CLASS(                                                        \
  31         getImpl(Context, DEFINE_MDNODE_GET_UNPACK(ARGS), Temporary));          \
  32   }
  33 #define DEFINE_MDNODE_GET(CLASS, FORMAL, ARGS)                                 \
  34   static CLASS *get(LLVMContext &Context, DEFINE_MDNODE_GET_UNPACK(FORMAL)) {  \
  35     return getImpl(Context, DEFINE_MDNODE_GET_UNPACK(ARGS), Uniqued);          \
  36   }                                                                            \
  37   static CLASS *getIfExists(LLVMContext &Context,                              \
  38                             DEFINE_MDNODE_GET_UNPACK(FORMAL)) {                \
  39     return getImpl(Context, DEFINE_MDNODE_GET_UNPACK(ARGS), Uniqued,           \
  40                    /* ShouldCreate */ false);                                  \
  41   }                                                                            \
  42   DEFINE_MDNODE_GET_DISTINCT_TEMPORARY(CLASS, FORMAL, ARGS)
  43
  44 namespace llvm {
  45
  46 /// \brief Pointer union between a subclass of DINode and MDString.
  47 ///
  48 /// \a DICompositeType can be referenced via an \a MDString unique identifier.
  49 /// This class allows some type safety in the face of that, requiring either a
  50 /// node of a particular type or an \a MDString.
  51 template <class T> class TypedDINodeRef {
  52   const Metadata *MD = nullptr;
  53
  54 public:
  55   TypedDINodeRef() = default;
  56   TypedDINodeRef(std::nullptr_t) {}
  57
  58   /// \brief Construct from a raw pointer.
  59   explicit TypedDINodeRef(const Metadata *MD) : MD(MD) {
  60     assert((!MD || isa<MDString>(MD) || isa<T>(MD)) && "Expected valid ref");
  61   }
  62
  63   template <class U>
  64   TypedDINodeRef(
  65       const TypedDINodeRef<U> &X,
  66       typename std::enable_if<std::is_convertible<U *, T *>::value>::type * =
  67           nullptr)
  68       : MD(X) {}
  69
  70   operator Metadata *() const { return const_cast<Metadata *>(MD); }
  71
  72   bool operator==(const TypedDINodeRef<T> &X) const { return MD == X.MD; }
  73   bool operator!=(const TypedDINodeRef<T> &X) const { return MD != X.MD; }
  74
  75   /// \brief Create a reference.
  76   ///
  77   /// Get a reference to \c N, using an \a MDString reference if available.
  78   static TypedDINodeRef get(const T *N);
  79
  80   template <class MapTy> T *resolve(const MapTy &Map) const {
  81     if (!MD)
  82       return nullptr;
  83
  84     if (auto *Typed = dyn_cast<T>(MD))
  85       return const_cast<T *>(Typed);
  86
  87     auto *S = cast<MDString>(MD);
  88     auto I = Map.find(S);
  89     assert(I != Map.end() && "Missing identifier in type map");
  90     return cast<T>(I->second);
  91   }
  92 };
  93
  94 typedef TypedDINodeRef<DINode> DINodeRef;
  95 typedef TypedDINodeRef<DIScope> DIScopeRef;
  96 typedef TypedDINodeRef<DIType> DITypeRef;
  97
  98 class DITypeRefArray {
  99   const MDTuple *N = nullptr;
 100
 101 public:
 102   DITypeRefArray() = default;
 103   DITypeRefArray(const MDTuple *N) : N(N) {}
 104
 105   explicit operator bool() const { return get(); }
 106   explicit operator MDTuple *() const { return get(); }
 107
 108   MDTuple *get() const { return const_cast<MDTuple *>(N); }
 109   MDTuple *operator->() const { return get(); }
 110   MDTuple &operator*() const { return *get(); }
 111
 112   // FIXME: Fix callers and remove condition on N.
 113   unsigned size() const { return N ? N->getNumOperands() : 0u; }
 114   DITypeRef operator[](unsigned I) const { return DITypeRef(N->getOperand(I)); }
 115
 116   class iterator : std::iterator<std::input_iterator_tag, DITypeRef,
 117                                  std::ptrdiff_t, void, DITypeRef> {
 118     MDNode::op_iterator I = nullptr;
 119
 120   public:
 121     iterator() = default;
 122     explicit iterator(MDNode::op_iterator I) : I(I) {}
 123     DITypeRef operator*() const { return DITypeRef(*I); }
 124     iterator &operator++() {
 125       ++I;
 126       return *this;
 127     }
 128     iterator operator++(int) {
 129       iterator Temp(*this);
 130       ++I;
 131       return Temp;
 132     }
 133     bool operator==(const iterator &X) const { return I == X.I; }
 134     bool operator!=(const iterator &X) const { return I != X.I; }
 135   };
 136
 137   // FIXME: Fix callers and remove condition on N.
 138   iterator begin() const { return N ? iterator(N->op_begin()) : iterator(); }
 139   iterator end() const { return N ? iterator(N->op_end()) : iterator(); }
 140 };
 141
 142 /// \brief Tagged DWARF-like metadata node.
 143 ///
 144 /// A metadata node with a DWARF tag (i.e., a constant named \c DW_TAG_*,
 145 /// defined in llvm/Support/Dwarf.h).  Called \a DINode because it's
 146 /// potentially used for non-DWARF output.
 147 class DINode : public MDNode {
 148   friend class LLVMContextImpl;
 149   friend class MDNode;
 150
 151 protected:
 152   DINode(LLVMContext &C, unsigned ID, StorageType Storage, unsigned Tag,
 153          ArrayRef<Metadata *> Ops1, ArrayRef<Metadata *> Ops2 = None)
 154       : MDNode(C, ID, Storage, Ops1, Ops2) {
 155     assert(Tag < 1u << 16);
 156     SubclassData16 = Tag;
 157   }
 158   ~DINode() = default;
 159
 160   template <class Ty> Ty *getOperandAs(unsigned I) const {
 161     return cast_or_null<Ty>(getOperand(I));
 162   }
 163
 164   StringRef getStringOperand(unsigned I) const {
 165     if (auto *S = getOperandAs<MDString>(I))
 166       return S->getString();
 167     return StringRef();
 168   }
 169
 170   static MDString *getCanonicalMDString(LLVMContext &Context, StringRef S) {
 171     if (S.empty())
 172       return nullptr;
 173     return MDString::get(Context, S);
 174   }
 175
 176 public:
 177   unsigned getTag() const { return SubclassData16; }
 178
 179   /// \brief Debug info flags.
 180   ///
 181   /// The three accessibility flags are mutually exclusive and rolled together
 182   /// in the first two bits.
 183   enum DIFlags {
 184 #define HANDLE_DI_FLAG(ID, NAME) Flag##NAME = ID,
 185 #include "llvm/IR/DebugInfoFlags.def"
 186     FlagAccessibility = FlagPrivate | FlagProtected | FlagPublic
 187   };
 188
 189   static unsigned getFlag(StringRef Flag);
 190   static const char *getFlagString(unsigned Flag);
 191
 192   /// \brief Split up a flags bitfield.
 193   ///
 194   /// Split \c Flags into \c SplitFlags, a vector of its components.  Returns
 195   /// any remaining (unrecognized) bits.
 196   static unsigned splitFlags(unsigned Flags,
 197                              SmallVectorImpl<unsigned> &SplitFlags);
 198
 199   DINodeRef getRef() const { return DINodeRef::get(this); }
 200
 201   static bool classof(const Metadata *MD) {
 202     switch (MD->getMetadataID()) {
 203     default:
 204       return false;
 205     case GenericDINodeKind:
 206     case DISubrangeKind:
 207     case DIEnumeratorKind:
 208     case DIBasicTypeKind:
 209     case DIDerivedTypeKind:
 210     case DICompositeTypeKind:
 211     case DISubroutineTypeKind:
 212     case DIFileKind:
 213     case DICompileUnitKind:
 214     case DISubprogramKind:
 215     case DILexicalBlockKind:
 216     case DILexicalBlockFileKind:
 217     case DINamespaceKind:
 218     case DITemplateTypeParameterKind:
 219     case DITemplateValueParameterKind:
 220     case DIGlobalVariableKind:
 221     case DILocalVariableKind:
 222     case DIObjCPropertyKind:
 223     case DIImportedEntityKind:
 224     case DIModuleKind:
 225       return true;
 226     }
 227   }
 228 };
 229
 230 template <class T> struct simplify_type<const TypedDINodeRef<T>> {
 231   typedef Metadata *SimpleType;
 232   static SimpleType getSimplifiedValue(const TypedDINodeRef<T> &MD) {
 233     return MD;
 234   }
 235 };
 236
 237 template <class T>
 238 struct simplify_type<TypedDINodeRef<T>>
 239     : simplify_type<const TypedDINodeRef<T>> {};
 240
 241 /// \brief Generic tagged DWARF-like metadata node.
 242 ///
 243 /// An un-specialized DWARF-like metadata node.  The first operand is a
 244 /// (possibly empty) null-separated \a MDString header that contains arbitrary
 245 /// fields.  The remaining operands are \a dwarf_operands(), and are pointers
 246 /// to other metadata.
 247 class GenericDINode : public DINode {
 248   friend class LLVMContextImpl;
 249   friend class MDNode;
 250
 251   GenericDINode(LLVMContext &C, StorageType Storage, unsigned Hash,
 252                 unsigned Tag, ArrayRef<Metadata *> Ops1,
 253                 ArrayRef<Metadata *> Ops2)
 254       : DINode(C, GenericDINodeKind, Storage, Tag, Ops1, Ops2) {
 255     setHash(Hash);
 256   }
 257   ~GenericDINode() { dropAllReferences(); }
 258
 259   void setHash(unsigned Hash) { SubclassData32 = Hash; }
 260   void recalculateHash();
 261
 262   static GenericDINode *getImpl(LLVMContext &Context, unsigned Tag,
 263                                 StringRef Header, ArrayRef<Metadata *> DwarfOps,
 264                                 StorageType Storage, bool ShouldCreate = true) {
 265     return getImpl(Context, Tag, getCanonicalMDString(Context, Header),
 266                    DwarfOps, Storage, ShouldCreate);
 267   }
 268
 269   static GenericDINode *getImpl(LLVMContext &Context, unsigned Tag,
 270                                 MDString *Header, ArrayRef<Metadata *> DwarfOps,
 271                                 StorageType Storage, bool ShouldCreate = true);
 272
 273   TempGenericDINode cloneImpl() const {
 274     return getTemporary(
 275         getContext(), getTag(), getHeader(),
 276         SmallVector<Metadata *, 4>(dwarf_op_begin(), dwarf_op_end()));
 277   }
 278
 279 public:
 280   unsigned getHash() const { return SubclassData32; }
 281
 282   DEFINE_MDNODE_GET(GenericDINode, (unsigned Tag, StringRef Header,
 283                                     ArrayRef<Metadata *> DwarfOps),
 284                     (Tag, Header, DwarfOps))
 285   DEFINE_MDNODE_GET(GenericDINode, (unsigned Tag, MDString *Header,
 286                                     ArrayRef<Metadata *> DwarfOps),
 287                     (Tag, Header, DwarfOps))
 288
 289   /// \brief Return a (temporary) clone of this.
 290   TempGenericDINode clone() const { return cloneImpl(); }
 291
 292   unsigned getTag() const { return SubclassData16; }
 293   StringRef getHeader() const { return getStringOperand(0); }
 294
 295   op_iterator dwarf_op_begin() const { return op_begin() + 1; }
 296   op_iterator dwarf_op_end() const { return op_end(); }
 297   op_range dwarf_operands() const {
 298     return op_range(dwarf_op_begin(), dwarf_op_end());
 299   }
 300
 301   unsigned getNumDwarfOperands() const { return getNumOperands() - 1; }
 302   const MDOperand &getDwarfOperand(unsigned I) const {
 303     return getOperand(I + 1);
 304   }
 305   void replaceDwarfOperandWith(unsigned I, Metadata *New) {
 306     replaceOperandWith(I + 1, New);
 307   }
 308
 309   static bool classof(const Metadata *MD) {
 310     return MD->getMetadataID() == GenericDINodeKind;
 311   }
 312 };
 313
 314 /// \brief Array subrange.
 315 ///
 316 /// TODO: Merge into node for DW_TAG_array_type, which should have a custom
 317 /// type.
 318 class DISubrange : public DINode {
 319   friend class LLVMContextImpl;
 320   friend class MDNode;
 321
 322   int64_t Count;
 323   int64_t LowerBound;
 324
 325   DISubrange(LLVMContext &C, StorageType Storage, int64_t Count,
 326              int64_t LowerBound)
 327       : DINode(C, DISubrangeKind, Storage, dwarf::DW_TAG_subrange_type, None),
 328         Count(Count), LowerBound(LowerBound) {}
 329   ~DISubrange() = default;
 330
 331   static DISubrange *getImpl(LLVMContext &Context, int64_t Count,
 332                              int64_t LowerBound, StorageType Storage,
 333                              bool ShouldCreate = true);
 334
 335   TempDISubrange cloneImpl() const {
 336     return getTemporary(getContext(), getCount(), getLowerBound());
 337   }
 338
 339 public:
 340   DEFINE_MDNODE_GET(DISubrange, (int64_t Count, int64_t LowerBound = 0),
 341                     (Count, LowerBound))
 342
 343   TempDISubrange clone() const { return cloneImpl(); }
 344
 345   int64_t getLowerBound() const { return LowerBound; }
 346   int64_t getCount() const { return Count; }
 347
 348   static bool classof(const Metadata *MD) {
 349     return MD->getMetadataID() == DISubrangeKind;
 350   }
 351 };
 352
 353 /// \brief Enumeration value.
 354 ///
 355 /// TODO: Add a pointer to the context (DW_TAG_enumeration_type) once that no
 356 /// longer creates a type cycle.
 357 class DIEnumerator : public DINode {
 358   friend class LLVMContextImpl;
 359   friend class MDNode;
 360
 361   int64_t Value;
 362
 363   DIEnumerator(LLVMContext &C, StorageType Storage, int64_t Value,
 364                ArrayRef<Metadata *> Ops)
 365       : DINode(C, DIEnumeratorKind, Storage, dwarf::DW_TAG_enumerator, Ops),
 366         Value(Value) {}
 367   ~DIEnumerator() = default;
 368
 369   static DIEnumerator *getImpl(LLVMContext &Context, int64_t Value,
 370                                StringRef Name, StorageType Storage,
 371                                bool ShouldCreate = true) {
 372     return getImpl(Context, Value, getCanonicalMDString(Context, Name), Storage,
 373                    ShouldCreate);
 374   }
 375   static DIEnumerator *getImpl(LLVMContext &Context, int64_t Value,
 376                                MDString *Name, StorageType Storage,
 377                                bool ShouldCreate = true);
 378
 379   TempDIEnumerator cloneImpl() const {
 380     return getTemporary(getContext(), getValue(), getName());
 381   }
 382
 383 public:
 384   DEFINE_MDNODE_GET(DIEnumerator, (int64_t Value, StringRef Name),
 385                     (Value, Name))
 386   DEFINE_MDNODE_GET(DIEnumerator, (int64_t Value, MDString *Name),
 387                     (Value, Name))
 388
 389   TempDIEnumerator clone() const { return cloneImpl(); }
 390
 391   int64_t getValue() const { return Value; }
 392   StringRef getName() const { return getStringOperand(0); }
 393
 394   MDString *getRawName() const { return getOperandAs<MDString>(0); }
 395
 396   static bool classof(const Metadata *MD) {
 397     return MD->getMetadataID() == DIEnumeratorKind;
 398   }
 399 };
 400
 401 /// \brief Base class for scope-like contexts.
 402 ///
 403 /// Base class for lexical scopes and types (which are also declaration
 404 /// contexts).
 405 ///
 406 /// TODO: Separate the concepts of declaration contexts and lexical scopes.
 407 class DIScope : public DINode {
 408 protected:
 409   DIScope(LLVMContext &C, unsigned ID, StorageType Storage, unsigned Tag,
 410           ArrayRef<Metadata *> Ops)
 411       : DINode(C, ID, Storage, Tag, Ops) {}
 412   ~DIScope() = default;
 413
 414 public:
 415   DIFile *getFile() const { return cast_or_null<DIFile>(getRawFile()); }
 416
 417   inline StringRef getFilename() const;
 418   inline StringRef getDirectory() const;
 419
 420   StringRef getName() const;
 421   DIScopeRef getScope() const;
 422
 423   /// \brief Return the raw underlying file.
 424   ///
 425   /// An \a DIFile is an \a DIScope, but it doesn't point at a separate file
 426   /// (it\em is the file).  If \c this is an \a DIFile, we need to return \c
 427   /// this.  Otherwise, return the first operand, which is where all other
 428   /// subclasses store their file pointer.
 429   Metadata *getRawFile() const {
 430     return isa<DIFile>(this) ? const_cast<DIScope *>(this)
 431                              : static_cast<Metadata *>(getOperand(0));
 432   }
 433
 434   DIScopeRef getRef() const { return DIScopeRef::get(this); }
 435
 436   static bool classof(const Metadata *MD) {
 437     switch (MD->getMetadataID()) {
 438     default:
 439       return false;
 440     case DIBasicTypeKind:
 441     case DIDerivedTypeKind:
 442     case DICompositeTypeKind:
 443     case DISubroutineTypeKind:
 444     case DIFileKind:
 445     case DICompileUnitKind:
 446     case DISubprogramKind:
 447     case DILexicalBlockKind:
 448     case DILexicalBlockFileKind:
 449     case DINamespaceKind:
 450     case DIModuleKind:
 451       return true;
 452     }
 453   }
 454 };
 455
 456 /// \brief File.
 457 ///
 458 /// TODO: Merge with directory/file node (including users).
 459 /// TODO: Canonicalize paths on creation.
 460 class DIFile : public DIScope {
 461   friend class LLVMContextImpl;
 462   friend class MDNode;
 463
 464   DIFile(LLVMContext &C, StorageType Storage, ArrayRef<Metadata *> Ops)
 465       : DIScope(C, DIFileKind, Storage, dwarf::DW_TAG_file_type, Ops) {}
 466   ~DIFile() = default;
 467
 468   static DIFile *getImpl(LLVMContext &Context, StringRef Filename,
 469                          StringRef Directory, StorageType Storage,
 470                          bool ShouldCreate = true) {
 471     return getImpl(Context, getCanonicalMDString(Context, Filename),
 472                    getCanonicalMDString(Context, Directory), Storage,
 473                    ShouldCreate);
 474   }
 475   static DIFile *getImpl(LLVMContext &Context, MDString *Filename,
 476                          MDString *Directory, StorageType Storage,
 477                          bool ShouldCreate = true);
 478
 479   TempDIFile cloneImpl() const {
 480     return getTemporary(getContext(), getFilename(), getDirectory());
 481   }
 482
 483 public:
 484   DEFINE_MDNODE_GET(DIFile, (StringRef Filename, StringRef Directory),
 485                     (Filename, Directory))
 486   DEFINE_MDNODE_GET(DIFile, (MDString * Filename, MDString *Directory),
 487                     (Filename, Directory))
 488
 489   TempDIFile clone() const { return cloneImpl(); }
 490
 491   StringRef getFilename() const { return getStringOperand(0); }
 492   StringRef getDirectory() const { return getStringOperand(1); }
 493
 494   MDString *getRawFilename() const { return getOperandAs<MDString>(0); }
 495   MDString *getRawDirectory() const { return getOperandAs<MDString>(1); }
 496
 497   static bool classof(const Metadata *MD) {
 498     return MD->getMetadataID() == DIFileKind;
 499   }
 500 };
 501
 502 StringRef DIScope::getFilename() const {
 503   if (auto *F = getFile())
 504     return F->getFilename();
 505   return "";
 506 }
 507
 508 StringRef DIScope::getDirectory() const {
 509   if (auto *F = getFile())
 510     return F->getDirectory();
 511   return "";
 512 }
 513
 514 /// \brief Base class for types.
 515 ///
 516 /// TODO: Remove the hardcoded name and context, since many types don't use
 517 /// them.
 518 /// TODO: Split up flags.
 519 class DIType : public DIScope {
 520   unsigned Line;
 521   unsigned Flags;
 522   uint64_t SizeInBits;
 523   uint64_t AlignInBits;
 524   uint64_t OffsetInBits;
 525
 526 protected:
 527   DIType(LLVMContext &C, unsigned ID, StorageType Storage, unsigned Tag,
 528          unsigned Line, uint64_t SizeInBits, uint64_t AlignInBits,
 529          uint64_t OffsetInBits, unsigned Flags, ArrayRef<Metadata *> Ops)
 530       : DIScope(C, ID, Storage, Tag, Ops), Line(Line), Flags(Flags),
 531         SizeInBits(SizeInBits), AlignInBits(AlignInBits),
 532         OffsetInBits(OffsetInBits) {}
 533   ~DIType() = default;
 534
 535 public:
 536   TempDIType clone() const {
 537     return TempDIType(cast<DIType>(MDNode::clone().release()));
 538   }
 539
 540   unsigned getLine() const { return Line; }
 541   uint64_t getSizeInBits() const { return SizeInBits; }
 542   uint64_t getAlignInBits() const { return AlignInBits; }
 543   uint64_t getOffsetInBits() const { return OffsetInBits; }
 544   unsigned getFlags() const { return Flags; }
 545
 546   DIScopeRef getScope() const { return DIScopeRef(getRawScope()); }
 547   StringRef getName() const { return getStringOperand(2); }
 548
 549
 550   Metadata *getRawScope() const { return getOperand(1); }
 551   MDString *getRawName() const { return getOperandAs<MDString>(2); }
 552
 553   void setFlags(unsigned NewFlags) {
 554     assert(!isUniqued() && "Cannot set flags on uniqued nodes");
 555     Flags = NewFlags;
 556   }
 557
 558   bool isPrivate() const {
 559     return (getFlags() & FlagAccessibility) == FlagPrivate;
 560   }
 561   bool isProtected() const {
 562     return (getFlags() & FlagAccessibility) == FlagProtected;
 563   }
 564   bool isPublic() const {
 565     return (getFlags() & FlagAccessibility) == FlagPublic;
 566   }
 567   bool isForwardDecl() const { return getFlags() & FlagFwdDecl; }
 568   bool isAppleBlockExtension() const { return getFlags() & FlagAppleBlock; }
 569   bool isBlockByrefStruct() const { return getFlags() & FlagBlockByrefStruct; }
 570   bool isVirtual() const { return getFlags() & FlagVirtual; }
 571   bool isArtificial() const { return getFlags() & FlagArtificial; }
 572   bool isObjectPointer() const { return getFlags() & FlagObjectPointer; }
 573   bool isObjcClassComplete() const {
 574     return getFlags() & FlagObjcClassComplete;
 575   }
 576   bool isVector() const { return getFlags() & FlagVector; }
 577   bool isStaticMember() const { return getFlags() & FlagStaticMember; }
 578   bool isLValueReference() const { return getFlags() & FlagLValueReference; }
 579   bool isRValueReference() const { return getFlags() & FlagRValueReference; }
 580   bool isExternalTypeRef() const { return getFlags() & FlagExternalTypeRef; }
 581
 582   DITypeRef getRef() const { return DITypeRef::get(this); }
 583
 584   static bool classof(const Metadata *MD) {
 585     switch (MD->getMetadataID()) {
 586     default:
 587       return false;
 588     case DIBasicTypeKind:
 589     case DIDerivedTypeKind:
 590     case DICompositeTypeKind:
 591     case DISubroutineTypeKind:
 592       return true;
 593     }
 594   }
 595 };
 596
 597 /// \brief Basic type, like 'int' or 'float'.
 598 ///
 599 /// TODO: Split out DW_TAG_unspecified_type.
 600 /// TODO: Drop unused accessors.
 601 class DIBasicType : public DIType {
 602   friend class LLVMContextImpl;
 603   friend class MDNode;
 604
 605   unsigned Encoding;
 606
 607   DIBasicType(LLVMContext &C, StorageType Storage, unsigned Tag,
 608               uint64_t SizeInBits, uint64_t AlignInBits, unsigned Encoding,
 609               ArrayRef<Metadata *> Ops)
 610       : DIType(C, DIBasicTypeKind, Storage, Tag, 0, SizeInBits, AlignInBits, 0,
 611                0, Ops),
 612         Encoding(Encoding) {}
 613   ~DIBasicType() = default;
 614
 615   static DIBasicType *getImpl(LLVMContext &Context, unsigned Tag,
 616                               StringRef Name, uint64_t SizeInBits,
 617                               uint64_t AlignInBits, unsigned Encoding,
 618                               StorageType Storage, bool ShouldCreate = true) {
 619     return getImpl(Context, Tag, getCanonicalMDString(Context, Name),
 620                    SizeInBits, AlignInBits, Encoding, Storage, ShouldCreate);
 621   }
 622   static DIBasicType *getImpl(LLVMContext &Context, unsigned Tag,
 623                               MDString *Name, uint64_t SizeInBits,
 624                               uint64_t AlignInBits, unsigned Encoding,
 625                               StorageType Storage, bool ShouldCreate = true);
 626
 627   TempDIBasicType cloneImpl() const {
 628     return getTemporary(getContext(), getTag(), getName(), getSizeInBits(),
 629                         getAlignInBits(), getEncoding());
 630   }
 631
 632 public:
 633   DEFINE_MDNODE_GET(DIBasicType, (unsigned Tag, StringRef Name),
 634                     (Tag, Name, 0, 0, 0))
 635   DEFINE_MDNODE_GET(DIBasicType,
 636                     (unsigned Tag, StringRef Name, uint64_t SizeInBits,
 637                      uint64_t AlignInBits, unsigned Encoding),
 638                     (Tag, Name, SizeInBits, AlignInBits, Encoding))
 639   DEFINE_MDNODE_GET(DIBasicType,
 640                     (unsigned Tag, MDString *Name, uint64_t SizeInBits,
 641                      uint64_t AlignInBits, unsigned Encoding),
 642                     (Tag, Name, SizeInBits, AlignInBits, Encoding))
 643
 644   TempDIBasicType clone() const { return cloneImpl(); }
 645
 646   unsigned getEncoding() const { return Encoding; }
 647
 648   static bool classof(const Metadata *MD) {
 649     return MD->getMetadataID() == DIBasicTypeKind;
 650   }
 651 };
 652
 653 /// \brief Derived types.
 654 ///
 655 /// This includes qualified types, pointers, references, friends, typedefs, and
 656 /// class members.
 657 ///
 658 /// TODO: Split out members (inheritance, fields, methods, etc.).
 659 class DIDerivedType : public DIType {
 660   friend class LLVMContextImpl;
 661   friend class MDNode;
 662
 663   DIDerivedType(LLVMContext &C, StorageType Storage, unsigned Tag,
 664                 unsigned Line, uint64_t SizeInBits, uint64_t AlignInBits,
 665                 uint64_t OffsetInBits, unsigned Flags, ArrayRef<Metadata *> Ops)
 666       : DIType(C, DIDerivedTypeKind, Storage, Tag, Line, SizeInBits,
 667                AlignInBits, OffsetInBits, Flags, Ops) {}
 668   ~DIDerivedType() = default;
 669
 670   static DIDerivedType *getImpl(LLVMContext &Context, unsigned Tag,
 671                                 StringRef Name, DIFile *File, unsigned Line,
 672                                 DIScopeRef Scope, DITypeRef BaseType,
 673                                 uint64_t SizeInBits, uint64_t AlignInBits,
 674                                 uint64_t OffsetInBits, unsigned Flags,
 675                                 Metadata *ExtraData, StorageType Storage,
 676                                 bool ShouldCreate = true) {
 677     return getImpl(Context, Tag, getCanonicalMDString(Context, Name), File,
 678                    Line, Scope, BaseType, SizeInBits, AlignInBits, OffsetInBits,
 679                    Flags, ExtraData, Storage, ShouldCreate);
 680   }
 681   static DIDerivedType *getImpl(LLVMContext &Context, unsigned Tag,
 682                                 MDString *Name, Metadata *File, unsigned Line,
 683                                 Metadata *Scope, Metadata *BaseType,
 684                                 uint64_t SizeInBits, uint64_t AlignInBits,
 685                                 uint64_t OffsetInBits, unsigned Flags,
 686                                 Metadata *ExtraData, StorageType Storage,
 687                                 bool ShouldCreate = true);
 688
 689   TempDIDerivedType cloneImpl() const {
 690     return getTemporary(getContext(), getTag(), getName(), getFile(), getLine(),
 691                         getScope(), getBaseType(), getSizeInBits(),
 692                         getAlignInBits(), getOffsetInBits(), getFlags(),
 693                         getExtraData());
 694   }
 695
 696 public:
 697   DEFINE_MDNODE_GET(DIDerivedType,
 698                     (unsigned Tag, MDString *Name, Metadata *File,
 699                      unsigned Line, Metadata *Scope, Metadata *BaseType,
 700                      uint64_t SizeInBits, uint64_t AlignInBits,
 701                      uint64_t OffsetInBits, unsigned Flags,
 702                      Metadata *ExtraData = nullptr),
 703                     (Tag, Name, File, Line, Scope, BaseType, SizeInBits,
 704                      AlignInBits, OffsetInBits, Flags, ExtraData))
 705   DEFINE_MDNODE_GET(DIDerivedType,
 706                     (unsigned Tag, StringRef Name, DIFile *File, unsigned Line,
 707                      DIScopeRef Scope, DITypeRef BaseType, uint64_t SizeInBits,
 708                      uint64_t AlignInBits, uint64_t OffsetInBits,
 709                      unsigned Flags, Metadata *ExtraData = nullptr),
 710                     (Tag, Name, File, Line, Scope, BaseType, SizeInBits,
 711                      AlignInBits, OffsetInBits, Flags, ExtraData))
 712
 713   TempDIDerivedType clone() const { return cloneImpl(); }
 714
 715   //// Get the base type this is derived from.
 716   DITypeRef getBaseType() const { return DITypeRef(getRawBaseType()); }
 717   Metadata *getRawBaseType() const { return getOperand(3); }
 718
 719   /// \brief Get extra data associated with this derived type.
 720   ///
 721   /// Class type for pointer-to-members, objective-c property node for ivars,
 722   /// or global constant wrapper for static members.
 723   ///
 724   /// TODO: Separate out types that need this extra operand: pointer-to-member
 725   /// types and member fields (static members and ivars).
 726   Metadata *getExtraData() const { return getRawExtraData(); }
 727   Metadata *getRawExtraData() const { return getOperand(4); }
 728
 729   /// \brief Get casted version of extra data.
 730   /// @{
 731   DITypeRef getClassType() const {
 732     assert(getTag() == dwarf::DW_TAG_ptr_to_member_type);
 733     return DITypeRef(getExtraData());
 734   }
 735   DIObjCProperty *getObjCProperty() const {
 736     return dyn_cast_or_null<DIObjCProperty>(getExtraData());
 737   }
 738   Constant *getConstant() const {
 739     assert(getTag() == dwarf::DW_TAG_member && isStaticMember());
 740     if (auto *C = cast_or_null<ConstantAsMetadata>(getExtraData()))
 741       return C->getValue();
 742     return nullptr;
 743   }
 744   /// @}
 745
 746   static bool classof(const Metadata *MD) {
 747     return MD->getMetadataID() == DIDerivedTypeKind;
 748   }
 749 };
 750
 751 /// \brief Composite types.
 752 ///
 753 /// TODO: Detach from DerivedTypeBase (split out MDEnumType?).
 754 /// TODO: Create a custom, unrelated node for DW_TAG_array_type.
 755 class DICompositeType : public DIType {
 756   friend class LLVMContextImpl;
 757   friend class MDNode;
 758
 759   unsigned RuntimeLang;
 760
 761   DICompositeType(LLVMContext &C, StorageType Storage, unsigned Tag,
 762                   unsigned Line, unsigned RuntimeLang, uint64_t SizeInBits,
 763                   uint64_t AlignInBits, uint64_t OffsetInBits, unsigned Flags,
 764                   ArrayRef<Metadata *> Ops)
 765       : DIType(C, DICompositeTypeKind, Storage, Tag, Line, SizeInBits,
 766                AlignInBits, OffsetInBits, Flags, Ops),
 767         RuntimeLang(RuntimeLang) {}
 768   ~DICompositeType() = default;
 769
 770   static DICompositeType *
 771   getImpl(LLVMContext &Context, unsigned Tag, StringRef Name, Metadata *File,
 772           unsigned Line, DIScopeRef Scope, DITypeRef BaseType,
 773           uint64_t SizeInBits, uint64_t AlignInBits, uint64_t OffsetInBits,
 774           uint64_t Flags, DINodeArray Elements, unsigned RuntimeLang,
 775           DITypeRef VTableHolder, DITemplateParameterArray TemplateParams,
 776           StringRef Identifier, StorageType Storage, bool ShouldCreate = true) {
 777     return getImpl(
 778         Context, Tag, getCanonicalMDString(Context, Name), File, Line, Scope,
 779         BaseType, SizeInBits, AlignInBits, OffsetInBits, Flags, Elements.get(),
 780         RuntimeLang, VTableHolder, TemplateParams.get(),
 781         getCanonicalMDString(Context, Identifier), Storage, ShouldCreate);
 782   }
 783   static DICompositeType *
 784   getImpl(LLVMContext &Context, unsigned Tag, MDString *Name, Metadata *File,
 785           unsigned Line, Metadata *Scope, Metadata *BaseType,
 786           uint64_t SizeInBits, uint64_t AlignInBits, uint64_t OffsetInBits,
 787           unsigned Flags, Metadata *Elements, unsigned RuntimeLang,
 788           Metadata *VTableHolder, Metadata *TemplateParams,
 789           MDString *Identifier, StorageType Storage, bool ShouldCreate = true);
 790
 791   TempDICompositeType cloneImpl() const {
 792     return getTemporary(getContext(), getTag(), getName(), getFile(), getLine(),
 793                         getScope(), getBaseType(), getSizeInBits(),
 794                         getAlignInBits(), getOffsetInBits(), getFlags(),
 795                         getElements(), getRuntimeLang(), getVTableHolder(),
 796                         getTemplateParams(), getIdentifier());
 797   }
 798
 799 public:
 800   DEFINE_MDNODE_GET(DICompositeType,
 801                     (unsigned Tag, StringRef Name, DIFile *File, unsigned Line,
 802                      DIScopeRef Scope, DITypeRef BaseType, uint64_t SizeInBits,
 803                      uint64_t AlignInBits, uint64_t OffsetInBits,
 804                      unsigned Flags, DINodeArray Elements, unsigned RuntimeLang,
 805                      DITypeRef VTableHolder,
 806                      DITemplateParameterArray TemplateParams = nullptr,
 807                      StringRef Identifier = ""),
 808                     (Tag, Name, File, Line, Scope, BaseType, SizeInBits,
 809                      AlignInBits, OffsetInBits, Flags, Elements, RuntimeLang,
 810                      VTableHolder, TemplateParams, Identifier))
 811   DEFINE_MDNODE_GET(DICompositeType,
 812                     (unsigned Tag, MDString *Name, Metadata *File,
 813                      unsigned Line, Metadata *Scope, Metadata *BaseType,
 814                      uint64_t SizeInBits, uint64_t AlignInBits,
 815                      uint64_t OffsetInBits, unsigned Flags, Metadata *Elements,
 816                      unsigned RuntimeLang, Metadata *VTableHolder,
 817                      Metadata *TemplateParams = nullptr,
 818                      MDString *Identifier = nullptr),
 819                     (Tag, Name, File, Line, Scope, BaseType, SizeInBits,
 820                      AlignInBits, OffsetInBits, Flags, Elements, RuntimeLang,
 821                      VTableHolder, TemplateParams, Identifier))
 822
 823   TempDICompositeType clone() const { return cloneImpl(); }
 824
 825   DITypeRef getBaseType() const { return DITypeRef(getRawBaseType()); }
 826   DINodeArray getElements() const {
 827     return cast_or_null<MDTuple>(getRawElements());
 828   }
 829   DITypeRef getVTableHolder() const { return DITypeRef(getRawVTableHolder()); }
 830   DITemplateParameterArray getTemplateParams() const {
 831     return cast_or_null<MDTuple>(getRawTemplateParams());
 832   }
 833   StringRef getIdentifier() const { return getStringOperand(7); }
 834   unsigned getRuntimeLang() const { return RuntimeLang; }
 835
 836   Metadata *getRawBaseType() const { return getOperand(3); }
 837   Metadata *getRawElements() const { return getOperand(4); }
 838   Metadata *getRawVTableHolder() const { return getOperand(5); }
 839   Metadata *getRawTemplateParams() const { return getOperand(6); }
 840   MDString *getRawIdentifier() const { return getOperandAs<MDString>(7); }
 841
 842   /// \brief Replace operands.
 843   ///
 844   /// If this \a isUniqued() and not \a isResolved(), on a uniquing collision
 845   /// this will be RAUW'ed and deleted.  Use a \a TrackingMDRef to keep track
 846   /// of its movement if necessary.
 847   /// @{
 848   void replaceElements(DINodeArray Elements) {
 849 #ifndef NDEBUG
 850     for (DINode *Op : getElements())
 851       assert(std::find(Elements->op_begin(), Elements->op_end(), Op) &&
 852              "Lost a member during member list replacement");
 853 #endif
 854     replaceOperandWith(4, Elements.get());
 855   }
 856   void replaceVTableHolder(DITypeRef VTableHolder) {
 857     replaceOperandWith(5, VTableHolder);
 858   }
 859   void replaceTemplateParams(DITemplateParameterArray TemplateParams) {
 860     replaceOperandWith(6, TemplateParams.get());
 861   }
 862   /// @}
 863
 864   static bool classof(const Metadata *MD) {
 865     return MD->getMetadataID() == DICompositeTypeKind;
 866   }
 867 };
 868
 869 template <class T> TypedDINodeRef<T> TypedDINodeRef<T>::get(const T *N) {
 870   if (N)
 871     if (auto *Composite = dyn_cast<DICompositeType>(N))
 872       if (auto *S = Composite->getRawIdentifier())
 873         return TypedDINodeRef<T>(S);
 874   return TypedDINodeRef<T>(N);
 875 }
 876
 877 /// \brief Type array for a subprogram.
 878 ///
 879 /// TODO: Fold the array of types in directly as operands.
 880 class DISubroutineType : public DIType {
 881   friend class LLVMContextImpl;
 882   friend class MDNode;
 883
 884   DISubroutineType(LLVMContext &C, StorageType Storage, unsigned Flags,
 885                    ArrayRef<Metadata *> Ops)
 886       : DIType(C, DISubroutineTypeKind, Storage, dwarf::DW_TAG_subroutine_type,
 887                0, 0, 0, 0, Flags, Ops) {}
 888   ~DISubroutineType() = default;
 889
 890   static DISubroutineType *getImpl(LLVMContext &Context, unsigned Flags,
 891                                    DITypeRefArray TypeArray,
 892                                    StorageType Storage,
 893                                    bool ShouldCreate = true) {
 894     return getImpl(Context, Flags, TypeArray.get(), Storage, ShouldCreate);
 895   }
 896   static DISubroutineType *getImpl(LLVMContext &Context, unsigned Flags,
 897                                    Metadata *TypeArray, StorageType Storage,
 898                                    bool ShouldCreate = true);
 899
 900   TempDISubroutineType cloneImpl() const {
 901     return getTemporary(getContext(), getFlags(), getTypeArray());
 902   }
 903
 904 public:
 905   DEFINE_MDNODE_GET(DISubroutineType,
 906                     (unsigned Flags, DITypeRefArray TypeArray),
 907                     (Flags, TypeArray))
 908   DEFINE_MDNODE_GET(DISubroutineType, (unsigned Flags, Metadata *TypeArray),
 909                     (Flags, TypeArray))
 910
 911   TempDISubroutineType clone() const { return cloneImpl(); }
 912
 913   DITypeRefArray getTypeArray() const {
 914     return cast_or_null<MDTuple>(getRawTypeArray());
 915   }
 916   Metadata *getRawTypeArray() const { return getOperand(3); }
 917
 918   static bool classof(const Metadata *MD) {
 919     return MD->getMetadataID() == DISubroutineTypeKind;
 920   }
 921 };
 922
 923 /// \brief Compile unit.
 924 class DICompileUnit : public DIScope {
 925   friend class LLVMContextImpl;
 926   friend class MDNode;
 927
 928   unsigned SourceLanguage;
 929   bool IsOptimized;
 930   unsigned RuntimeVersion;
 931   unsigned EmissionKind;
 932   uint64_t DWOId;
 933
 934   DICompileUnit(LLVMContext &C, StorageType Storage, unsigned SourceLanguage,
 935                 bool IsOptimized, unsigned RuntimeVersion,
 936                 unsigned EmissionKind, uint64_t DWOId, ArrayRef<Metadata *> Ops)
 937       : DIScope(C, DICompileUnitKind, Storage, dwarf::DW_TAG_compile_unit, Ops),
 938         SourceLanguage(SourceLanguage), IsOptimized(IsOptimized),
 939         RuntimeVersion(RuntimeVersion), EmissionKind(EmissionKind),
 940         DWOId(DWOId) {
 941     assert(Storage != Uniqued);
 942   }
 943   ~DICompileUnit() = default;
 944
 945   static DICompileUnit *
 946   getImpl(LLVMContext &Context, unsigned SourceLanguage, DIFile *File,
 947           StringRef Producer, bool IsOptimized, StringRef Flags,
 948           unsigned RuntimeVersion, StringRef SplitDebugFilename,
 949           unsigned EmissionKind, DICompositeTypeArray EnumTypes,
 950           DITypeArray RetainedTypes, DISubprogramArray Subprograms,
 951           DIGlobalVariableArray GlobalVariables,
 952           DIImportedEntityArray ImportedEntities, uint64_t DWOId,
 953           StorageType Storage, bool ShouldCreate = true) {
 954     return getImpl(Context, SourceLanguage, File,
 955                    getCanonicalMDString(Context, Producer), IsOptimized,
 956                    getCanonicalMDString(Context, Flags), RuntimeVersion,
 957                    getCanonicalMDString(Context, SplitDebugFilename),
 958                    EmissionKind, EnumTypes.get(), RetainedTypes.get(),
 959                    Subprograms.get(), GlobalVariables.get(),
 960                    ImportedEntities.get(), DWOId, Storage, ShouldCreate);
 961   }
 962   static DICompileUnit *
 963   getImpl(LLVMContext &Context, unsigned SourceLanguage, Metadata *File,
 964           MDString *Producer, bool IsOptimized, MDString *Flags,
 965           unsigned RuntimeVersion, MDString *SplitDebugFilename,
 966           unsigned EmissionKind, Metadata *EnumTypes, Metadata *RetainedTypes,
 967           Metadata *Subprograms, Metadata *GlobalVariables,
 968           Metadata *ImportedEntities, uint64_t DWOId, StorageType Storage,
 969           bool ShouldCreate = true);
 970
 971   TempDICompileUnit cloneImpl() const {
 972     return getTemporary(
 973         getContext(), getSourceLanguage(), getFile(), getProducer(),
 974         isOptimized(), getFlags(), getRuntimeVersion(), getSplitDebugFilename(),
 975         getEmissionKind(), getEnumTypes(), getRetainedTypes(), getSubprograms(),
 976         getGlobalVariables(), getImportedEntities(), DWOId);
 977   }
 978
 979   static void get() = delete;
 980   static void getIfExists() = delete;
 981
 982 public:
 983   DEFINE_MDNODE_GET_DISTINCT_TEMPORARY(
 984       DICompileUnit,
 985       (unsigned SourceLanguage, DIFile *File, StringRef Producer,
 986        bool IsOptimized, StringRef Flags, unsigned RuntimeVersion,
 987        StringRef SplitDebugFilename, unsigned EmissionKind,
 988        DICompositeTypeArray EnumTypes, DITypeArray RetainedTypes,
 989        DISubprogramArray Subprograms, DIGlobalVariableArray GlobalVariables,
 990        DIImportedEntityArray ImportedEntities, uint64_t DWOId),
 991       (SourceLanguage, File, Producer, IsOptimized, Flags, RuntimeVersion,
 992        SplitDebugFilename, EmissionKind, EnumTypes, RetainedTypes, Subprograms,
 993        GlobalVariables, ImportedEntities, DWOId))
 994   DEFINE_MDNODE_GET_DISTINCT_TEMPORARY(
 995       DICompileUnit,
 996       (unsigned SourceLanguage, Metadata *File, MDString *Producer,
 997        bool IsOptimized, MDString *Flags, unsigned RuntimeVersion,
 998        MDString *SplitDebugFilename, unsigned EmissionKind, Metadata *EnumTypes,
 999        Metadata *RetainedTypes, Metadata *Subprograms,
1000        Metadata *GlobalVariables, Metadata *ImportedEntities, uint64_t DWOId),
1001       (SourceLanguage, File, Producer, IsOptimized, Flags, RuntimeVersion,
1002        SplitDebugFilename, EmissionKind, EnumTypes, RetainedTypes, Subprograms,
1003        GlobalVariables, ImportedEntities, DWOId))
1004
1005   TempDICompileUnit clone() const { return cloneImpl(); }
1006
1007   unsigned getSourceLanguage() const { return SourceLanguage; }
1008   bool isOptimized() const { return IsOptimized; }
1009   unsigned getRuntimeVersion() const { return RuntimeVersion; }
1010   unsigned getEmissionKind() const { return EmissionKind; }
1011   StringRef getProducer() const { return getStringOperand(1); }
1012   StringRef getFlags() const { return getStringOperand(2); }
1013   StringRef getSplitDebugFilename() const { return getStringOperand(3); }
1014   DICompositeTypeArray getEnumTypes() const {
1015     return cast_or_null<MDTuple>(getRawEnumTypes());
1016   }
1017   DITypeArray getRetainedTypes() const {
1018     return cast_or_null<MDTuple>(getRawRetainedTypes());
1019   }
1020   DISubprogramArray getSubprograms() const {
1021     return cast_or_null<MDTuple>(getRawSubprograms());
1022   }
1023   DIGlobalVariableArray getGlobalVariables() const {
1024     return cast_or_null<MDTuple>(getRawGlobalVariables());
1025   }
1026   DIImportedEntityArray getImportedEntities() const {
1027     return cast_or_null<MDTuple>(getRawImportedEntities());
1028   }
1029   unsigned getDWOId() const { return DWOId; }
1030
1031   MDString *getRawProducer() const { return getOperandAs<MDString>(1); }
1032   MDString *getRawFlags() const { return getOperandAs<MDString>(2); }
1033   MDString *getRawSplitDebugFilename() const {
1034     return getOperandAs<MDString>(3);
1035   }
1036   Metadata *getRawEnumTypes() const { return getOperand(4); }
1037   Metadata *getRawRetainedTypes() const { return getOperand(5); }
1038   Metadata *getRawSubprograms() const { return getOperand(6); }
1039   Metadata *getRawGlobalVariables() const { return getOperand(7); }
1040   Metadata *getRawImportedEntities() const { return getOperand(8); }
1041
1042   /// \brief Replace arrays.
1043   ///
1044   /// If this \a isUniqued() and not \a isResolved(), it will be RAUW'ed and
1045   /// deleted on a uniquing collision.  In practice, uniquing collisions on \a
1046   /// DICompileUnit should be fairly rare.
1047   /// @{
1048   void replaceEnumTypes(DICompositeTypeArray N) {
1049     replaceOperandWith(4, N.get());
1050   }
1051   void replaceRetainedTypes(DITypeArray N) {
1052     replaceOperandWith(5, N.get());
1053   }
1054   void replaceSubprograms(DISubprogramArray N) {
1055     replaceOperandWith(6, N.get());
1056   }
1057   void replaceGlobalVariables(DIGlobalVariableArray N) {
1058     replaceOperandWith(7, N.get());
1059   }
1060   void replaceImportedEntities(DIImportedEntityArray N) {
1061     replaceOperandWith(8, N.get());
1062   }
1063   /// @}
1064
1065   static bool classof(const Metadata *MD) {
1066     return MD->getMetadataID() == DICompileUnitKind;
1067   }
1068 };
1069
1070 /// \brief A scope for locals.
1071 ///
1072 /// A legal scope for lexical blocks, local variables, and debug info
1073 /// locations.  Subclasses are \a DISubprogram, \a DILexicalBlock, and \a
1074 /// DILexicalBlockFile.
1075 class DILocalScope : public DIScope {
1076 protected:
1077   DILocalScope(LLVMContext &C, unsigned ID, StorageType Storage, unsigned Tag,
1078                ArrayRef<Metadata *> Ops)
1079       : DIScope(C, ID, Storage, Tag, Ops) {}
1080   ~DILocalScope() = default;
1081
1082 public:
1083   /// \brief Get the subprogram for this scope.
1084   ///
1085   /// Return this if it's an \a DISubprogram; otherwise, look up the scope
1086   /// chain.
1087   DISubprogram *getSubprogram() const;
1088
1089   static bool classof(const Metadata *MD) {
1090     return MD->getMetadataID() == DISubprogramKind ||
1091            MD->getMetadataID() == DILexicalBlockKind ||
1092            MD->getMetadataID() == DILexicalBlockFileKind;
1093   }
1094 };
1095
1096 /// \brief Debug location.
1097 ///
1098 /// A debug location in source code, used for debug info and otherwise.
1099 class DILocation : public MDNode {
1100   friend class LLVMContextImpl;
1101   friend class MDNode;
1102
1103   DILocation(LLVMContext &C, StorageType Storage, unsigned Line,
1104              unsigned Column, ArrayRef<Metadata *> MDs);
1105   ~DILocation() { dropAllReferences(); }
1106
1107   static DILocation *getImpl(LLVMContext &Context, unsigned Line,
1108                              unsigned Column, Metadata *Scope,
1109                              Metadata *InlinedAt, StorageType Storage,
1110                              bool ShouldCreate = true);
1111   static DILocation *getImpl(LLVMContext &Context, unsigned Line,
1112                              unsigned Column, DILocalScope *Scope,
1113                              DILocation *InlinedAt, StorageType Storage,
1114                              bool ShouldCreate = true) {
1115     return getImpl(Context, Line, Column, static_cast<Metadata *>(Scope),
1116                    static_cast<Metadata *>(InlinedAt), Storage, ShouldCreate);
1117   }
1118
1119   TempDILocation cloneImpl() const {
1120     return getTemporary(getContext(), getLine(), getColumn(), getScope(),
1121                         getInlinedAt());
1122   }
1123
1124   // Disallow replacing operands.
1125   void replaceOperandWith(unsigned I, Metadata *New) = delete;
1126
1127 public:
1128   DEFINE_MDNODE_GET(DILocation,
1129                     (unsigned Line, unsigned Column, Metadata *Scope,
1130                      Metadata *InlinedAt = nullptr),
1131                     (Line, Column, Scope, InlinedAt))
1132   DEFINE_MDNODE_GET(DILocation,
1133                     (unsigned Line, unsigned Column, DILocalScope *Scope,
1134                      DILocation *InlinedAt = nullptr),
1135                     (Line, Column, Scope, InlinedAt))
1136
1137   /// \brief Return a (temporary) clone of this.
1138   TempDILocation clone() const { return cloneImpl(); }
1139
1140   unsigned getLine() const { return SubclassData32; }
1141   unsigned getColumn() const { return SubclassData16; }
1142   DILocalScope *getScope() const { return cast<DILocalScope>(getRawScope()); }
1143   DILocation *getInlinedAt() const {
1144     return cast_or_null<DILocation>(getRawInlinedAt());
1145   }
1146
1147   DIFile *getFile() const { return getScope()->getFile(); }
1148   StringRef getFilename() const { return getScope()->getFilename(); }
1149   StringRef getDirectory() const { return getScope()->getDirectory(); }
1150
1151   /// \brief Get the scope where this is inlined.
1152   ///
1153   /// Walk through \a getInlinedAt() and return \a getScope() from the deepest
1154   /// location.
1155   DILocalScope *getInlinedAtScope() const {
1156     if (auto *IA = getInlinedAt())
1157       return IA->getInlinedAtScope();
1158     return getScope();
1159   }
1160
1161   /// \brief Check whether this can be discriminated from another location.
1162   ///
1163   /// Check \c this can be discriminated from \c RHS in a linetable entry.
1164   /// Scope and inlined-at chains are not recorded in the linetable, so they
1165   /// cannot be used to distinguish basic blocks.
1166   ///
1167   /// The current implementation is weaker than it should be, since it just
1168   /// checks filename and line.
1169   ///
1170   /// FIXME: Add a check for getDiscriminator().
1171   /// FIXME: Add a check for getColumn().
1172   /// FIXME: Change the getFilename() check to getFile() (or add one for
1173   /// getDirectory()).
1174   bool canDiscriminate(const DILocation &RHS) const {
1175     return getFilename() != RHS.getFilename() || getLine() != RHS.getLine();
1176   }
1177
1178   /// \brief Get the DWARF discriminator.
1179   ///
1180   /// DWARF discriminators distinguish identical file locations between
1181   /// instructions that are on different basic blocks.
1182   inline unsigned getDiscriminator() const;
1183
1184   /// \brief Compute new discriminator in the given context.
1185   ///
1186   /// This modifies the \a LLVMContext that \c this is in to increment the next
1187   /// discriminator for \c this's line/filename combination.
1188   ///
1189   /// FIXME: Delete this.  See comments in implementation and at the only call
1190   /// site in \a AddDiscriminators::runOnFunction().
1191   unsigned computeNewDiscriminator() const;
1192
1193   Metadata *getRawScope() const { return getOperand(0); }
1194   Metadata *getRawInlinedAt() const {
1195     if (getNumOperands() == 2)
1196       return getOperand(1);
1197     return nullptr;
1198   }
1199
1200   static bool classof(const Metadata *MD) {
1201     return MD->getMetadataID() == DILocationKind;
1202   }
1203 };
1204
1205 /// \brief Subprogram description.
1206 ///
1207 /// TODO: Remove DisplayName.  It's always equal to Name.
1208 /// TODO: Split up flags.
1209 class DISubprogram : public DILocalScope {
1210   friend class LLVMContextImpl;
1211   friend class MDNode;
1212
1213   unsigned Line;
1214   unsigned ScopeLine;
1215   unsigned Virtuality;
1216   unsigned VirtualIndex;
1217   unsigned Flags;
1218   bool IsLocalToUnit;
1219   bool IsDefinition;
1220   bool IsOptimized;
1221
1222   DISubprogram(LLVMContext &C, StorageType Storage, unsigned Line,
1223                unsigned ScopeLine, unsigned Virtuality, unsigned VirtualIndex,
1224                unsigned Flags, bool IsLocalToUnit, bool IsDefinition,
1225                bool IsOptimized, ArrayRef<Metadata *> Ops)
1226       : DILocalScope(C, DISubprogramKind, Storage, dwarf::DW_TAG_subprogram,
1227                      Ops),
1228         Line(Line), ScopeLine(ScopeLine), Virtuality(Virtuality),
1229         VirtualIndex(VirtualIndex), Flags(Flags), IsLocalToUnit(IsLocalToUnit),
1230         IsDefinition(IsDefinition), IsOptimized(IsOptimized) {}
1231   ~DISubprogram() = default;
1232
1233   static DISubprogram *
1234   getImpl(LLVMContext &Context, DIScopeRef Scope, StringRef Name,
1235           StringRef LinkageName, DIFile *File, unsigned Line,
1236           DISubroutineType *Type, bool IsLocalToUnit, bool IsDefinition,
1237           unsigned ScopeLine, DITypeRef ContainingType, unsigned Virtuality,
1238           unsigned VirtualIndex, unsigned Flags, bool IsOptimized,
1239           Constant *Function, DITemplateParameterArray TemplateParams,
1240           DISubprogram *Declaration, DILocalVariableArray Variables,
1241           StorageType Storage, bool ShouldCreate = true) {
1242     return getImpl(Context, Scope, getCanonicalMDString(Context, Name),
1243                    getCanonicalMDString(Context, LinkageName), File, Line, Type,
1244                    IsLocalToUnit, IsDefinition, ScopeLine, ContainingType,
1245                    Virtuality, VirtualIndex, Flags, IsOptimized,
1246                    Function ? ConstantAsMetadata::get(Function) : nullptr,
1247                    TemplateParams.get(), Declaration, Variables.get(), Storage,
1248                    ShouldCreate);
1249   }
1250   static DISubprogram *
1251   getImpl(LLVMContext &Context, Metadata *Scope, MDString *Name,
1252           MDString *LinkageName, Metadata *File, unsigned Line, Metadata *Type,
1253           bool IsLocalToUnit, bool IsDefinition, unsigned ScopeLine,
1254           Metadata *ContainingType, unsigned Virtuality, unsigned VirtualIndex,
1255           unsigned Flags, bool IsOptimized, Metadata *Function,
1256           Metadata *TemplateParams, Metadata *Declaration, Metadata *Variables,
1257           StorageType Storage, bool ShouldCreate = true);
1258
1259   TempDISubprogram cloneImpl() const {
1260     return getTemporary(getContext(), getScope(), getName(), getLinkageName(),
1261                         getFile(), getLine(), getType(), isLocalToUnit(),
1262                         isDefinition(), getScopeLine(), getContainingType(),
1263                         getVirtuality(), getVirtualIndex(), getFlags(),
1264                         isOptimized(), getFunctionConstant(),
1265                         getTemplateParams(), getDeclaration(), getVariables());
1266   }
1267
1268 public:
1269   DEFINE_MDNODE_GET(DISubprogram,
1270                     (DIScopeRef Scope, StringRef Name, StringRef LinkageName,
1271                      DIFile *File, unsigned Line, DISubroutineType *Type,
1272                      bool IsLocalToUnit, bool IsDefinition, unsigned ScopeLine,
1273                      DITypeRef ContainingType, unsigned Virtuality,
1274                      unsigned VirtualIndex, unsigned Flags, bool IsOptimized,
1275                      Constant *Function = nullptr,
1276                      DITemplateParameterArray TemplateParams = nullptr,
1277                      DISubprogram *Declaration = nullptr,
1278                      DILocalVariableArray Variables = nullptr),
1279                     (Scope, Name, LinkageName, File, Line, Type, IsLocalToUnit,
1280                      IsDefinition, ScopeLine, ContainingType, Virtuality,
1281                      VirtualIndex, Flags, IsOptimized, Function, TemplateParams,
1282                      Declaration, Variables))
1283   DEFINE_MDNODE_GET(
1284       DISubprogram,
1285       (Metadata * Scope, MDString *Name, MDString *LinkageName, Metadata *File,
1286        unsigned Line, Metadata *Type, bool IsLocalToUnit, bool IsDefinition,
1287        unsigned ScopeLine, Metadata *ContainingType, unsigned Virtuality,
1288        unsigned VirtualIndex, unsigned Flags, bool IsOptimized,
1289        Metadata *Function = nullptr, Metadata *TemplateParams = nullptr,
1290        Metadata *Declaration = nullptr, Metadata *Variables = nullptr),
1291       (Scope, Name, LinkageName, File, Line, Type, IsLocalToUnit, IsDefinition,
1292        ScopeLine, ContainingType, Virtuality, VirtualIndex, Flags, IsOptimized,
1293        Function, TemplateParams, Declaration, Variables))
1294
1295   TempDISubprogram clone() const { return cloneImpl(); }
1296
1297 public:
1298   unsigned getLine() const { return Line; }
1299   unsigned getVirtuality() const { return Virtuality; }
1300   unsigned getVirtualIndex() const { return VirtualIndex; }
1301   unsigned getScopeLine() const { return ScopeLine; }
1302   unsigned getFlags() const { return Flags; }
1303   bool isLocalToUnit() const { return IsLocalToUnit; }
1304   bool isDefinition() const { return IsDefinition; }
1305   bool isOptimized() const { return IsOptimized; }
1306
1307   unsigned isArtificial() const { return getFlags() & FlagArtificial; }
1308   bool isPrivate() const {
1309     return (getFlags() & FlagAccessibility) == FlagPrivate;
1310   }
1311   bool isProtected() const {
1312     return (getFlags() & FlagAccessibility) == FlagProtected;
1313   }
1314   bool isPublic() const {
1315     return (getFlags() & FlagAccessibility) == FlagPublic;
1316   }
1317   bool isExplicit() const { return getFlags() & FlagExplicit; }
1318   bool isPrototyped() const { return getFlags() & FlagPrototyped; }
1319
1320   /// \brief Check if this is reference-qualified.
1321   ///
1322   /// Return true if this subprogram is a C++11 reference-qualified non-static
1323   /// member function (void foo() &).
1324   unsigned isLValueReference() const {
1325     return getFlags() & FlagLValueReference;
1326   }
1327
1328   /// \brief Check if this is rvalue-reference-qualified.
1329   ///
1330   /// Return true if this subprogram is a C++11 rvalue-reference-qualified
1331   /// non-static member function (void foo() &&).
1332   unsigned isRValueReference() const {
1333     return getFlags() & FlagRValueReference;
1334   }
1335
1336   DIScopeRef getScope() const { return DIScopeRef(getRawScope()); }
1337
1338   StringRef getName() const { return getStringOperand(2); }
1339   StringRef getDisplayName() const { return getStringOperand(3); }
1340   StringRef getLinkageName() const { return getStringOperand(4); }
1341
1342   MDString *getRawName() const { return getOperandAs<MDString>(2); }
1343   MDString *getRawLinkageName() const { return getOperandAs<MDString>(4); }
1344
1345   DISubroutineType *getType() const {
1346     return cast_or_null<DISubroutineType>(getRawType());
1347   }
1348   DITypeRef getContainingType() const {
1349     return DITypeRef(getRawContainingType());
1350   }
1351
1352   Constant *getFunctionConstant() const {
1353     if (auto *C = cast_or_null<ConstantAsMetadata>(getRawFunction()))
1354       return C->getValue();
1355     return nullptr;
1356   }
1357   DITemplateParameterArray getTemplateParams() const {
1358     return cast_or_null<MDTuple>(getRawTemplateParams());
1359   }
1360   DISubprogram *getDeclaration() const {
1361     return cast_or_null<DISubprogram>(getRawDeclaration());
1362   }
1363   DILocalVariableArray getVariables() const {
1364     return cast_or_null<MDTuple>(getRawVariables());
1365   }
1366
1367   Metadata *getRawScope() const { return getOperand(1); }
1368   Metadata *getRawType() const { return getOperand(5); }
1369   Metadata *getRawContainingType() const { return getOperand(6); }
1370   Metadata *getRawFunction() const { return getOperand(7); }
1371   Metadata *getRawTemplateParams() const { return getOperand(8); }
1372   Metadata *getRawDeclaration() const { return getOperand(9); }
1373   Metadata *getRawVariables() const { return getOperand(10); }
1374
1375   /// \brief Get a pointer to the function this subprogram describes.
1376   ///
1377   /// This dyn_casts \a getFunctionConstant() to \a Function.
1378   ///
1379   /// FIXME: Should this be looking through bitcasts?
1380   Function *getFunction() const;
1381
1382   /// \brief Replace the function.
1383   ///
1384   /// If \a isUniqued() and not \a isResolved(), this could node will be
1385   /// RAUW'ed and deleted out from under the caller.  Use a \a TrackingMDRef if
1386   /// that's a problem.
1387   /// @{
1388   void replaceFunction(Function *F);
1389   void replaceFunction(ConstantAsMetadata *MD) { replaceOperandWith(7, MD); }
1390   void replaceFunction(std::nullptr_t) { replaceOperandWith(7, nullptr); }
1391   /// @}
1392
1393   /// \brief Check if this subprogram describes the given function.
1394   ///
1395   /// FIXME: Should this be looking through bitcasts?
1396   bool describes(const Function *F) const;
1397
1398   static bool classof(const Metadata *MD) {
1399     return MD->getMetadataID() == DISubprogramKind;
1400   }
1401 };
1402
1403 class DILexicalBlockBase : public DILocalScope {
1404 protected:
1405   DILexicalBlockBase(LLVMContext &C, unsigned ID, StorageType Storage,
1406                      ArrayRef<Metadata *> Ops)
1407       : DILocalScope(C, ID, Storage, dwarf::DW_TAG_lexical_block, Ops) {}
1408   ~DILexicalBlockBase() = default;
1409
1410 public:
1411   DILocalScope *getScope() const { return cast<DILocalScope>(getRawScope()); }
1412
1413   Metadata *getRawScope() const { return getOperand(1); }
1414
1415   /// \brief Forwarding accessors to LexicalBlock.
1416   ///
1417   /// TODO: Remove these and update code to use \a DILexicalBlock directly.
1418   /// @{
1419   inline unsigned getLine() const;
1420   inline unsigned getColumn() const;
1421   /// @}
1422   static bool classof(const Metadata *MD) {
1423     return MD->getMetadataID() == DILexicalBlockKind ||
1424            MD->getMetadataID() == DILexicalBlockFileKind;
1425   }
1426 };
1427
1428 class DILexicalBlock : public DILexicalBlockBase {
1429   friend class LLVMContextImpl;
1430   friend class MDNode;
1431
1432   unsigned Line;
1433   uint16_t Column;
1434
1435   DILexicalBlock(LLVMContext &C, StorageType Storage, unsigned Line,
1436                  unsigned Column, ArrayRef<Metadata *> Ops)
1437       : DILexicalBlockBase(C, DILexicalBlockKind, Storage, Ops), Line(Line),
1438         Column(Column) {
1439     assert(Column < (1u << 16) && "Expected 16-bit column");
1440   }
1441   ~DILexicalBlock() = default;
1442
1443   static DILexicalBlock *getImpl(LLVMContext &Context, DILocalScope *Scope,
1444                                  DIFile *File, unsigned Line, unsigned Column,
1445                                  StorageType Storage,
1446                                  bool ShouldCreate = true) {
1447     return getImpl(Context, static_cast<Metadata *>(Scope),
1448                    static_cast<Metadata *>(File), Line, Column, Storage,
1449                    ShouldCreate);
1450   }
1451
1452   static DILexicalBlock *getImpl(LLVMContext &Context, Metadata *Scope,
1453                                  Metadata *File, unsigned Line, unsigned Column,
1454                                  StorageType Storage, bool ShouldCreate = true);
1455
1456   TempDILexicalBlock cloneImpl() const {
1457     return getTemporary(getContext(), getScope(), getFile(), getLine(),
1458                         getColumn());
1459   }
1460
1461 public:
1462   DEFINE_MDNODE_GET(DILexicalBlock, (DILocalScope * Scope, DIFile *File,
1463                                      unsigned Line, unsigned Column),
1464                     (Scope, File, Line, Column))
1465   DEFINE_MDNODE_GET(DILexicalBlock, (Metadata * Scope, Metadata *File,
1466                                      unsigned Line, unsigned Column),
1467                     (Scope, File, Line, Column))
1468
1469   TempDILexicalBlock clone() const { return cloneImpl(); }
1470
1471   unsigned getLine() const { return Line; }
1472   unsigned getColumn() const { return Column; }
1473
1474   static bool classof(const Metadata *MD) {
1475     return MD->getMetadataID() == DILexicalBlockKind;
1476   }
1477 };
1478
1479 unsigned DILexicalBlockBase::getLine() const {
1480   if (auto *N = dyn_cast<DILexicalBlock>(this))
1481     return N->getLine();
1482   return 0;
1483 }
1484
1485 unsigned DILexicalBlockBase::getColumn() const {
1486   if (auto *N = dyn_cast<DILexicalBlock>(this))
1487     return N->getColumn();
1488   return 0;
1489 }
1490
1491 class DILexicalBlockFile : public DILexicalBlockBase {
1492   friend class LLVMContextImpl;
1493   friend class MDNode;
1494
1495   unsigned Discriminator;
1496
1497   DILexicalBlockFile(LLVMContext &C, StorageType Storage,
1498                      unsigned Discriminator, ArrayRef<Metadata *> Ops)
1499       : DILexicalBlockBase(C, DILexicalBlockFileKind, Storage, Ops),
1500         Discriminator(Discriminator) {}
1501   ~DILexicalBlockFile() = default;
1502
1503   static DILexicalBlockFile *getImpl(LLVMContext &Context, DILocalScope *Scope,
1504                                      DIFile *File, unsigned Discriminator,
1505                                      StorageType Storage,
1506                                      bool ShouldCreate = true) {
1507     return getImpl(Context, static_cast<Metadata *>(Scope),
1508                    static_cast<Metadata *>(File), Discriminator, Storage,
1509                    ShouldCreate);
1510   }
1511
1512   static DILexicalBlockFile *getImpl(LLVMContext &Context, Metadata *Scope,
1513                                      Metadata *File, unsigned Discriminator,
1514                                      StorageType Storage,
1515                                      bool ShouldCreate = true);
1516
1517   TempDILexicalBlockFile cloneImpl() const {
1518     return getTemporary(getContext(), getScope(), getFile(),
1519                         getDiscriminator());
1520   }
1521
1522 public:
1523   DEFINE_MDNODE_GET(DILexicalBlockFile, (DILocalScope * Scope, DIFile *File,
1524                                          unsigned Discriminator),
1525                     (Scope, File, Discriminator))
1526   DEFINE_MDNODE_GET(DILexicalBlockFile,
1527                     (Metadata * Scope, Metadata *File, unsigned Discriminator),
1528                     (Scope, File, Discriminator))
1529
1530   TempDILexicalBlockFile clone() const { return cloneImpl(); }
1531
1532   // TODO: Remove these once they're gone from DILexicalBlockBase.
1533   unsigned getLine() const = delete;
1534   unsigned getColumn() const = delete;
1535
1536   unsigned getDiscriminator() const { return Discriminator; }
1537
1538   static bool classof(const Metadata *MD) {
1539     return MD->getMetadataID() == DILexicalBlockFileKind;
1540   }
1541 };
1542
1543 unsigned DILocation::getDiscriminator() const {
1544   if (auto *F = dyn_cast<DILexicalBlockFile>(getScope()))
1545     return F->getDiscriminator();
1546   return 0;
1547 }
1548
1549 class DINamespace : public DIScope {
1550   friend class LLVMContextImpl;
1551   friend class MDNode;
1552
1553   unsigned Line;
1554
1555   DINamespace(LLVMContext &Context, StorageType Storage, unsigned Line,
1556               ArrayRef<Metadata *> Ops)
1557       : DIScope(Context, DINamespaceKind, Storage, dwarf::DW_TAG_namespace,
1558                 Ops),
1559         Line(Line) {}
1560   ~DINamespace() = default;
1561
1562   static DINamespace *getImpl(LLVMContext &Context, DIScope *Scope,
1563                               DIFile *File, StringRef Name, unsigned Line,
1564                               StorageType Storage, bool ShouldCreate = true) {
1565     return getImpl(Context, Scope, File, getCanonicalMDString(Context, Name),
1566                    Line, Storage, ShouldCreate);
1567   }
1568   static DINamespace *getImpl(LLVMContext &Context, Metadata *Scope,
1569                               Metadata *File, MDString *Name, unsigned Line,
1570                               StorageType Storage, bool ShouldCreate = true);
1571
1572   TempDINamespace cloneImpl() const {
1573     return getTemporary(getContext(), getScope(), getFile(), getName(),
1574                         getLine());
1575   }
1576
1577 public:
1578   DEFINE_MDNODE_GET(DINamespace, (DIScope * Scope, DIFile *File, StringRef Name,
1579                                   unsigned Line),
1580                     (Scope, File, Name, Line))
1581   DEFINE_MDNODE_GET(DINamespace, (Metadata * Scope, Metadata *File,
1582                                   MDString *Name, unsigned Line),
1583                     (Scope, File, Name, Line))
1584
1585   TempDINamespace clone() const { return cloneImpl(); }
1586
1587   unsigned getLine() const { return Line; }
1588   DIScope *getScope() const { return cast_or_null<DIScope>(getRawScope()); }
1589   StringRef getName() const { return getStringOperand(2); }
1590
1591   Metadata *getRawScope() const { return getOperand(1); }
1592   MDString *getRawName() const { return getOperandAs<MDString>(2); }
1593
1594   static bool classof(const Metadata *MD) {
1595     return MD->getMetadataID() == DINamespaceKind;
1596   }
1597 };
1598
1599 /// \brief A (clang) module that has been imported by the compile unit.
1600 ///
1601 class DIModule : public DIScope {
1602   friend class LLVMContextImpl;
1603   friend class MDNode;
1604
1605   DIModule(LLVMContext &Context, StorageType Storage, ArrayRef<Metadata *> Ops)
1606       : DIScope(Context, DIModuleKind, Storage, dwarf::DW_TAG_module, Ops) {}
1607   ~DIModule() {}
1608
1609   static DIModule *getImpl(LLVMContext &Context, DIScope *Scope,
1610                            StringRef Name, StringRef ConfigurationMacros,
1611                            StringRef IncludePath, StringRef ISysRoot,
1612                            StorageType Storage, bool ShouldCreate = true) {
1613     return getImpl(Context, Scope, getCanonicalMDString(Context, Name),
1614                    getCanonicalMDString(Context, ConfigurationMacros),
1615                    getCanonicalMDString(Context, IncludePath),
1616                    getCanonicalMDString(Context, ISysRoot),
1617                    Storage, ShouldCreate);
1618   }
1619   static DIModule *getImpl(LLVMContext &Context, Metadata *Scope,
1620                            MDString *Name, MDString *ConfigurationMacros,
1621                            MDString *IncludePath, MDString *ISysRoot,
1622                            StorageType Storage, bool ShouldCreate = true);
1623
1624   TempDIModule cloneImpl() const {
1625     return getTemporary(getContext(), getScope(), getName(),
1626                         getConfigurationMacros(), getIncludePath(),
1627                         getISysRoot());
1628   }
1629
1630 public:
1631   DEFINE_MDNODE_GET(DIModule, (DIScope *Scope, StringRef Name,
1632                                StringRef ConfigurationMacros, StringRef IncludePath,
1633                                StringRef ISysRoot),
1634                     (Scope, Name, ConfigurationMacros, IncludePath, ISysRoot))
1635   DEFINE_MDNODE_GET(DIModule,
1636                     (Metadata *Scope, MDString *Name, MDString *ConfigurationMacros,
1637                      MDString *IncludePath, MDString *ISysRoot),
1638                     (Scope, Name, ConfigurationMacros, IncludePath, ISysRoot))
1639
1640   TempDIModule clone() const { return cloneImpl(); }
1641
1642   DIScope *getScope() const { return cast_or_null<DIScope>(getRawScope()); }
1643   StringRef getName() const { return getStringOperand(1); }
1644   StringRef getConfigurationMacros() const { return getStringOperand(2); }
1645   StringRef getIncludePath() const { return getStringOperand(3); }
1646   StringRef getISysRoot() const { return getStringOperand(4); }
1647
1648   Metadata *getRawScope() const { return getOperand(0); }
1649   MDString *getRawName() const { return getOperandAs<MDString>(1); }
1650   MDString *getRawConfigurationMacros() const { return getOperandAs<MDString>(2); }
1651   MDString *getRawIncludePath() const { return getOperandAs<MDString>(3); }
1652   MDString *getRawISysRoot() const { return getOperandAs<MDString>(4); }
1653
1654   static bool classof(const Metadata *MD) {
1655     return MD->getMetadataID() == DIModuleKind;
1656   }
1657 };
1658
1659 /// \brief Base class for template parameters.
1660 class DITemplateParameter : public DINode {
1661 protected:
1662   DITemplateParameter(LLVMContext &Context, unsigned ID, StorageType Storage,
1663                       unsigned Tag, ArrayRef<Metadata *> Ops)
1664       : DINode(Context, ID, Storage, Tag, Ops) {}
1665   ~DITemplateParameter() = default;
1666
1667 public:
1668   StringRef getName() const { return getStringOperand(0); }
1669   DITypeRef getType() const { return DITypeRef(getRawType()); }
1670
1671   MDString *getRawName() const { return getOperandAs<MDString>(0); }
1672   Metadata *getRawType() const { return getOperand(1); }
1673
1674   static bool classof(const Metadata *MD) {
1675     return MD->getMetadataID() == DITemplateTypeParameterKind ||
1676            MD->getMetadataID() == DITemplateValueParameterKind;
1677   }
1678 };
1679
1680 class DITemplateTypeParameter : public DITemplateParameter {
1681   friend class LLVMContextImpl;
1682   friend class MDNode;
1683
1684   DITemplateTypeParameter(LLVMContext &Context, StorageType Storage,
1685                           ArrayRef<Metadata *> Ops)
1686       : DITemplateParameter(Context, DITemplateTypeParameterKind, Storage,
1687                             dwarf::DW_TAG_template_type_parameter, Ops) {}
1688   ~DITemplateTypeParameter() = default;
1689
1690   static DITemplateTypeParameter *getImpl(LLVMContext &Context, StringRef Name,
1691                                           DITypeRef Type, StorageType Storage,
1692                                           bool ShouldCreate = true) {
1693     return getImpl(Context, getCanonicalMDString(Context, Name), Type, Storage,
1694                    ShouldCreate);
1695   }
1696   static DITemplateTypeParameter *getImpl(LLVMContext &Context, MDString *Name,
1697                                           Metadata *Type, StorageType Storage,
1698                                           bool ShouldCreate = true);
1699
1700   TempDITemplateTypeParameter cloneImpl() const {
1701     return getTemporary(getContext(), getName(), getType());
1702   }
1703
1704 public:
1705   DEFINE_MDNODE_GET(DITemplateTypeParameter, (StringRef Name, DITypeRef Type),
1706                     (Name, Type))
1707   DEFINE_MDNODE_GET(DITemplateTypeParameter, (MDString * Name, Metadata *Type),
1708                     (Name, Type))
1709
1710   TempDITemplateTypeParameter clone() const { return cloneImpl(); }
1711
1712   static bool classof(const Metadata *MD) {
1713     return MD->getMetadataID() == DITemplateTypeParameterKind;
1714   }
1715 };
1716
1717 class DITemplateValueParameter : public DITemplateParameter {
1718   friend class LLVMContextImpl;
1719   friend class MDNode;
1720
1721   DITemplateValueParameter(LLVMContext &Context, StorageType Storage,
1722                            unsigned Tag, ArrayRef<Metadata *> Ops)
1723       : DITemplateParameter(Context, DITemplateValueParameterKind, Storage, Tag,
1724                             Ops) {}
1725   ~DITemplateValueParameter() = default;
1726
1727   static DITemplateValueParameter *getImpl(LLVMContext &Context, unsigned Tag,
1728                                            StringRef Name, DITypeRef Type,
1729                                            Metadata *Value, StorageType Storage,
1730                                            bool ShouldCreate = true) {
1731     return getImpl(Context, Tag, getCanonicalMDString(Context, Name), Type,
1732                    Value, Storage, ShouldCreate);
1733   }
1734   static DITemplateValueParameter *getImpl(LLVMContext &Context, unsigned Tag,
1735                                            MDString *Name, Metadata *Type,
1736                                            Metadata *Value, StorageType Storage,
1737                                            bool ShouldCreate = true);
1738
1739   TempDITemplateValueParameter cloneImpl() const {
1740     return getTemporary(getContext(), getTag(), getName(), getType(),
1741                         getValue());
1742   }
1743
1744 public:
1745   DEFINE_MDNODE_GET(DITemplateValueParameter, (unsigned Tag, StringRef Name,
1746                                                DITypeRef Type, Metadata *Value),
1747                     (Tag, Name, Type, Value))
1748   DEFINE_MDNODE_GET(DITemplateValueParameter, (unsigned Tag, MDString *Name,
1749                                                Metadata *Type, Metadata *Value),
1750                     (Tag, Name, Type, Value))
1751
1752   TempDITemplateValueParameter clone() const { return cloneImpl(); }
1753
1754   Metadata *getValue() const { return getOperand(2); }
1755
1756   static bool classof(const Metadata *MD) {
1757     return MD->getMetadataID() == DITemplateValueParameterKind;
1758   }
1759 };
1760
1761 /// \brief Base class for variables.
1762 class DIVariable : public DINode {
1763   unsigned Line;
1764
1765 protected:
1766   DIVariable(LLVMContext &C, unsigned ID, StorageType Storage, unsigned Line,
1767              ArrayRef<Metadata *> Ops)
1768       : DINode(C, ID, Storage, dwarf::DW_TAG_variable, Ops), Line(Line) {}
1769   ~DIVariable() = default;
1770
1771 public:
1772   unsigned getLine() const { return Line; }
1773   DIScope *getScope() const { return cast_or_null<DIScope>(getRawScope()); }
1774   StringRef getName() const { return getStringOperand(1); }
1775   DIFile *getFile() const { return cast_or_null<DIFile>(getRawFile()); }
1776   DITypeRef getType() const { return DITypeRef(getRawType()); }
1777
1778   StringRef getFilename() const {
1779     if (auto *F = getFile())
1780       return F->getFilename();
1781     return "";
1782   }
1783   StringRef getDirectory() const {
1784     if (auto *F = getFile())
1785       return F->getDirectory();
1786     return "";
1787   }
1788
1789   Metadata *getRawScope() const { return getOperand(0); }
1790   MDString *getRawName() const { return getOperandAs<MDString>(1); }
1791   Metadata *getRawFile() const { return getOperand(2); }
1792   Metadata *getRawType() const { return getOperand(3); }
1793
1794   static bool classof(const Metadata *MD) {
1795     return MD->getMetadataID() == DILocalVariableKind ||
1796            MD->getMetadataID() == DIGlobalVariableKind;
1797   }
1798 };
1799
1800 /// \brief Global variables.
1801 ///
1802 /// TODO: Remove DisplayName.  It's always equal to Name.
1803 class DIGlobalVariable : public DIVariable {
1804   friend class LLVMContextImpl;
1805   friend class MDNode;
1806
1807   bool IsLocalToUnit;
1808   bool IsDefinition;
1809
1810   DIGlobalVariable(LLVMContext &C, StorageType Storage, unsigned Line,
1811                    bool IsLocalToUnit, bool IsDefinition,
1812                    ArrayRef<Metadata *> Ops)
1813       : DIVariable(C, DIGlobalVariableKind, Storage, Line, Ops),
1814         IsLocalToUnit(IsLocalToUnit), IsDefinition(IsDefinition) {}
1815   ~DIGlobalVariable() = default;
1816
1817   static DIGlobalVariable *
1818   getImpl(LLVMContext &Context, DIScope *Scope, StringRef Name,
1819           StringRef LinkageName, DIFile *File, unsigned Line, DITypeRef Type,
1820           bool IsLocalToUnit, bool IsDefinition, Constant *Variable,
1821           DIDerivedType *StaticDataMemberDeclaration, StorageType Storage,
1822           bool ShouldCreate = true) {
1823     return getImpl(Context, Scope, getCanonicalMDString(Context, Name),
1824                    getCanonicalMDString(Context, LinkageName), File, Line, Type,
1825                    IsLocalToUnit, IsDefinition,
1826                    Variable ? ConstantAsMetadata::get(Variable) : nullptr,
1827                    StaticDataMemberDeclaration, Storage, ShouldCreate);
1828   }
1829   static DIGlobalVariable *
1830   getImpl(LLVMContext &Context, Metadata *Scope, MDString *Name,
1831           MDString *LinkageName, Metadata *File, unsigned Line, Metadata *Type,
1832           bool IsLocalToUnit, bool IsDefinition, Metadata *Variable,
1833           Metadata *StaticDataMemberDeclaration, StorageType Storage,
1834           bool ShouldCreate = true);
1835
1836   TempDIGlobalVariable cloneImpl() const {
1837     return getTemporary(getContext(), getScope(), getName(), getLinkageName(),
1838                         getFile(), getLine(), getType(), isLocalToUnit(),
1839                         isDefinition(), getVariable(),
1840                         getStaticDataMemberDeclaration());
1841   }
1842
1843 public:
1844   DEFINE_MDNODE_GET(DIGlobalVariable,
1845                     (DIScope * Scope, StringRef Name, StringRef LinkageName,
1846                      DIFile *File, unsigned Line, DITypeRef Type,
1847                      bool IsLocalToUnit, bool IsDefinition, Constant *Variable,
1848                      DIDerivedType *StaticDataMemberDeclaration),
1849                     (Scope, Name, LinkageName, File, Line, Type, IsLocalToUnit,
1850                      IsDefinition, Variable, StaticDataMemberDeclaration))
1851   DEFINE_MDNODE_GET(DIGlobalVariable,
1852                     (Metadata * Scope, MDString *Name, MDString *LinkageName,
1853                      Metadata *File, unsigned Line, Metadata *Type,
1854                      bool IsLocalToUnit, bool IsDefinition, Metadata *Variable,
1855                      Metadata *StaticDataMemberDeclaration),
1856                     (Scope, Name, LinkageName, File, Line, Type, IsLocalToUnit,
1857                      IsDefinition, Variable, StaticDataMemberDeclaration))
1858
1859   TempDIGlobalVariable clone() const { return cloneImpl(); }
1860
1861   bool isLocalToUnit() const { return IsLocalToUnit; }
1862   bool isDefinition() const { return IsDefinition; }
1863   StringRef getDisplayName() const { return getStringOperand(4); }
1864   StringRef getLinkageName() const { return getStringOperand(5); }
1865   Constant *getVariable() const {
1866     if (auto *C = cast_or_null<ConstantAsMetadata>(getRawVariable()))
1867       return dyn_cast<Constant>(C->getValue());
1868     return nullptr;
1869   }
1870   DIDerivedType *getStaticDataMemberDeclaration() const {
1871     return cast_or_null<DIDerivedType>(getRawStaticDataMemberDeclaration());
1872   }
1873
1874   MDString *getRawLinkageName() const { return getOperandAs<MDString>(5); }
1875   Metadata *getRawVariable() const { return getOperand(6); }
1876   Metadata *getRawStaticDataMemberDeclaration() const { return getOperand(7); }
1877
1878   static bool classof(const Metadata *MD) {
1879     return MD->getMetadataID() == DIGlobalVariableKind;
1880   }
1881 };
1882
1883 /// \brief Local variable.
1884 ///
1885 /// TODO: Split up flags.
1886 class DILocalVariable : public DIVariable {
1887   friend class LLVMContextImpl;
1888   friend class MDNode;
1889
1890   unsigned Arg;
1891   unsigned Flags;
1892
1893   DILocalVariable(LLVMContext &C, StorageType Storage, unsigned Line,
1894                   unsigned Arg, unsigned Flags, ArrayRef<Metadata *> Ops)
1895       : DIVariable(C, DILocalVariableKind, Storage, Line, Ops), Arg(Arg),
1896         Flags(Flags) {}
1897   ~DILocalVariable() = default;
1898
1899   static DILocalVariable *getImpl(LLVMContext &Context, DIScope *Scope,
1900                                   StringRef Name, DIFile *File, unsigned Line,
1901                                   DITypeRef Type, unsigned Arg, unsigned Flags,
1902                                   StorageType Storage,
1903                                   bool ShouldCreate = true) {
1904     return getImpl(Context, Scope, getCanonicalMDString(Context, Name), File,
1905                    Line, Type, Arg, Flags, Storage, ShouldCreate);
1906   }
1907   static DILocalVariable *getImpl(LLVMContext &Context, Metadata *Scope,
1908                                   MDString *Name, Metadata *File, unsigned Line,
1909                                   Metadata *Type, unsigned Arg, unsigned Flags,
1910                                   StorageType Storage,
1911                                   bool ShouldCreate = true);
1912
1913   TempDILocalVariable cloneImpl() const {
1914     return getTemporary(getContext(), getScope(), getName(), getFile(),
1915                         getLine(), getType(), getArg(), getFlags());
1916   }
1917
1918 public:
1919   DEFINE_MDNODE_GET(DILocalVariable,
1920                     (DILocalScope * Scope, StringRef Name, DIFile *File,
1921                      unsigned Line, DITypeRef Type, unsigned Arg,
1922                      unsigned Flags),
1923                     (Scope, Name, File, Line, Type, Arg, Flags))
1924   DEFINE_MDNODE_GET(DILocalVariable,
1925                     (Metadata * Scope, MDString *Name, Metadata *File,
1926                      unsigned Line, Metadata *Type, unsigned Arg,
1927                      unsigned Flags),
1928                     (Scope, Name, File, Line, Type, Arg, Flags))
1929
1930   TempDILocalVariable clone() const { return cloneImpl(); }
1931
1932   /// \brief Get the local scope for this variable.
1933   ///
1934   /// Variables must be defined in a local scope.
1935   DILocalScope *getScope() const {
1936     return cast<DILocalScope>(DIVariable::getScope());
1937   }
1938
1939   bool isParameter() const { return Arg; }
1940   unsigned getArg() const { return Arg; }
1941   unsigned getFlags() const { return Flags; }
1942
1943   bool isArtificial() const { return getFlags() & FlagArtificial; }
1944   bool isObjectPointer() const { return getFlags() & FlagObjectPointer; }
1945
1946   /// \brief Check that a location is valid for this variable.
1947   ///
1948   /// Check that \c DL exists, is in the same subprogram, and has the same
1949   /// inlined-at location as \c this.  (Otherwise, it's not a valid attachment
1950   /// to a \a DbgInfoIntrinsic.)
1951   bool isValidLocationForIntrinsic(const DILocation *DL) const {
1952     return DL && getScope()->getSubprogram() == DL->getScope()->getSubprogram();
1953   }
1954
1955   static bool classof(const Metadata *MD) {
1956     return MD->getMetadataID() == DILocalVariableKind;
1957   }
1958 };
1959
1960 /// \brief DWARF expression.
1961 ///
1962 /// This is (almost) a DWARF expression that modifies the location of a
1963 /// variable or (or the location of a single piece of a variable).
1964 ///
1965 /// FIXME: Instead of DW_OP_plus taking an argument, this should use DW_OP_const
1966 /// and have DW_OP_plus consume the topmost elements on the stack.
1967 ///
1968 /// TODO: Co-allocate the expression elements.
1969 /// TODO: Separate from MDNode, or otherwise drop Distinct and Temporary
1970 /// storage types.
1971 class DIExpression : public MDNode {
1972   friend class LLVMContextImpl;
1973   friend class MDNode;
1974
1975   std::vector<uint64_t> Elements;
1976
1977   DIExpression(LLVMContext &C, StorageType Storage, ArrayRef<uint64_t> Elements)
1978       : MDNode(C, DIExpressionKind, Storage, None),
1979         Elements(Elements.begin(), Elements.end()) {}
1980   ~DIExpression() = default;
1981
1982   static DIExpression *getImpl(LLVMContext &Context,
1983                                ArrayRef<uint64_t> Elements, StorageType Storage,
1984                                bool ShouldCreate = true);
1985
1986   TempDIExpression cloneImpl() const {
1987     return getTemporary(getContext(), getElements());
1988   }
1989
1990 public:
1991   DEFINE_MDNODE_GET(DIExpression, (ArrayRef<uint64_t> Elements), (Elements))
1992
1993   TempDIExpression clone() const { return cloneImpl(); }
1994
1995   ArrayRef<uint64_t> getElements() const { return Elements; }
1996
1997   unsigned getNumElements() const { return Elements.size(); }
1998   uint64_t getElement(unsigned I) const {
1999     assert(I < Elements.size() && "Index out of range");
2000     return Elements[I];
2001   }
2002
2003   /// \brief Return whether this is a piece of an aggregate variable.
2004   bool isBitPiece() const;
2005
2006   /// \brief Return the offset of this piece in bits.
2007   uint64_t getBitPieceOffset() const;
2008
2009   /// \brief Return the size of this piece in bits.
2010   uint64_t getBitPieceSize() const;
2011
2012   typedef ArrayRef<uint64_t>::iterator element_iterator;
2013   element_iterator elements_begin() const { return getElements().begin(); }
2014   element_iterator elements_end() const { return getElements().end(); }
2015
2016   /// \brief A lightweight wrapper around an expression operand.
2017   ///
2018   /// TODO: Store arguments directly and change \a DIExpression to store a
2019   /// range of these.
2020   class ExprOperand {
2021     const uint64_t *Op;
2022
2023   public:
2024     explicit ExprOperand(const uint64_t *Op) : Op(Op) {}
2025
2026     const uint64_t *get() const { return Op; }
2027
2028     /// \brief Get the operand code.
2029     uint64_t getOp() const { return *Op; }
2030
2031     /// \brief Get an argument to the operand.
2032     ///
2033     /// Never returns the operand itself.
2034     uint64_t getArg(unsigned I) const { return Op[I + 1]; }
2035
2036     unsigned getNumArgs() const { return getSize() - 1; }
2037
2038     /// \brief Return the size of the operand.
2039     ///
2040     /// Return the number of elements in the operand (1 + args).
2041     unsigned getSize() const;
2042   };
2043
2044   /// \brief An iterator for expression operands.
2045   class expr_op_iterator
2046       : public std::iterator<std::input_iterator_tag, ExprOperand> {
2047     ExprOperand Op;
2048
2049   public:
2050     explicit expr_op_iterator(element_iterator I) : Op(I) {}
2051
2052     element_iterator getBase() const { return Op.get(); }
2053     const ExprOperand &operator*() const { return Op; }
2054     const ExprOperand *operator->() const { return &Op; }
2055
2056     expr_op_iterator &operator++() {
2057       increment();
2058       return *this;
2059     }
2060     expr_op_iterator operator++(int) {
2061       expr_op_iterator T(*this);
2062       increment();
2063       return T;
2064     }
2065
2066     /// \brief Get the next iterator.
2067     ///
2068     /// \a std::next() doesn't work because this is technically an
2069     /// input_iterator, but it's a perfectly valid operation.  This is an
2070     /// accessor to provide the same functionality.
2071     expr_op_iterator getNext() const { return ++expr_op_iterator(*this); }
2072
2073     bool operator==(const expr_op_iterator &X) const {
2074       return getBase() == X.getBase();
2075     }
2076     bool operator!=(const expr_op_iterator &X) const {
2077       return getBase() != X.getBase();
2078     }
2079
2080   private:
2081     void increment() { Op = ExprOperand(getBase() + Op.getSize()); }
2082   };
2083
2084   /// \brief Visit the elements via ExprOperand wrappers.
2085   ///
2086   /// These range iterators visit elements through \a ExprOperand wrappers.
2087   /// This is not guaranteed to be a valid range unless \a isValid() gives \c
2088   /// true.
2089   ///
2090   /// \pre \a isValid() gives \c true.
2091   /// @{
2092   expr_op_iterator expr_op_begin() const {
2093     return expr_op_iterator(elements_begin());
2094   }
2095   expr_op_iterator expr_op_end() const {
2096     return expr_op_iterator(elements_end());
2097   }
2098   /// @}
2099
2100   bool isValid() const;
2101
2102   static bool classof(const Metadata *MD) {
2103     return MD->getMetadataID() == DIExpressionKind;
2104   }
2105 };
2106
2107 class DIObjCProperty : public DINode {
2108   friend class LLVMContextImpl;
2109   friend class MDNode;
2110
2111   unsigned Line;
2112   unsigned Attributes;
2113
2114   DIObjCProperty(LLVMContext &C, StorageType Storage, unsigned Line,
2115                  unsigned Attributes, ArrayRef<Metadata *> Ops)
2116       : DINode(C, DIObjCPropertyKind, Storage, dwarf::DW_TAG_APPLE_property,
2117                Ops),
2118         Line(Line), Attributes(Attributes) {}
2119   ~DIObjCProperty() = default;
2120
2121   static DIObjCProperty *
2122   getImpl(LLVMContext &Context, StringRef Name, DIFile *File, unsigned Line,
2123           StringRef GetterName, StringRef SetterName, unsigned Attributes,
2124           DITypeRef Type, StorageType Storage, bool ShouldCreate = true) {
2125     return getImpl(Context, getCanonicalMDString(Context, Name), File, Line,
2126                    getCanonicalMDString(Context, GetterName),
2127                    getCanonicalMDString(Context, SetterName), Attributes, Type,
2128                    Storage, ShouldCreate);
2129   }
2130   static DIObjCProperty *getImpl(LLVMContext &Context, MDString *Name,
2131                                  Metadata *File, unsigned Line,
2132                                  MDString *GetterName, MDString *SetterName,
2133                                  unsigned Attributes, Metadata *Type,
2134                                  StorageType Storage, bool ShouldCreate = true);
2135
2136   TempDIObjCProperty cloneImpl() const {
2137     return getTemporary(getContext(), getName(), getFile(), getLine(),
2138                         getGetterName(), getSetterName(), getAttributes(),
2139                         getType());
2140   }
2141
2142 public:
2143   DEFINE_MDNODE_GET(DIObjCProperty,
2144                     (StringRef Name, DIFile *File, unsigned Line,
2145                      StringRef GetterName, StringRef SetterName,
2146                      unsigned Attributes, DITypeRef Type),
2147                     (Name, File, Line, GetterName, SetterName, Attributes,
2148                      Type))
2149   DEFINE_MDNODE_GET(DIObjCProperty,
2150                     (MDString * Name, Metadata *File, unsigned Line,
2151                      MDString *GetterName, MDString *SetterName,
2152                      unsigned Attributes, Metadata *Type),
2153                     (Name, File, Line, GetterName, SetterName, Attributes,
2154                      Type))
2155
2156   TempDIObjCProperty clone() const { return cloneImpl(); }
2157
2158   unsigned getLine() const { return Line; }
2159   unsigned getAttributes() const { return Attributes; }
2160   StringRef getName() const { return getStringOperand(0); }
2161   DIFile *getFile() const { return cast_or_null<DIFile>(getRawFile()); }
2162   StringRef getGetterName() const { return getStringOperand(2); }
2163   StringRef getSetterName() const { return getStringOperand(3); }
2164   DITypeRef getType() const { return DITypeRef(getRawType()); }
2165
2166   StringRef getFilename() const {
2167     if (auto *F = getFile())
2168       return F->getFilename();
2169     return "";
2170   }
2171   StringRef getDirectory() const {
2172     if (auto *F = getFile())
2173       return F->getDirectory();
2174     return "";
2175   }
2176
2177   MDString *getRawName() const { return getOperandAs<MDString>(0); }
2178   Metadata *getRawFile() const { return getOperand(1); }
2179   MDString *getRawGetterName() const { return getOperandAs<MDString>(2); }
2180   MDString *getRawSetterName() const { return getOperandAs<MDString>(3); }
2181   Metadata *getRawType() const { return getOperand(4); }
2182
2183   static bool classof(const Metadata *MD) {
2184     return MD->getMetadataID() == DIObjCPropertyKind;
2185   }
2186 };
2187
2188 /// \brief An imported module (C++ using directive or similar).
2189 class DIImportedEntity : public DINode {
2190   friend class LLVMContextImpl;
2191   friend class MDNode;
2192
2193   unsigned Line;
2194
2195   DIImportedEntity(LLVMContext &C, StorageType Storage, unsigned Tag,
2196                    unsigned Line, ArrayRef<Metadata *> Ops)
2197       : DINode(C, DIImportedEntityKind, Storage, Tag, Ops), Line(Line) {}
2198   ~DIImportedEntity() = default;
2199
2200   static DIImportedEntity *getImpl(LLVMContext &Context, unsigned Tag,
2201                                    DIScope *Scope, DINodeRef Entity,
2202                                    unsigned Line, StringRef Name,
2203                                    StorageType Storage,
2204                                    bool ShouldCreate = true) {
2205     return getImpl(Context, Tag, Scope, Entity, Line,
2206                    getCanonicalMDString(Context, Name), Storage, ShouldCreate);
2207   }
2208   static DIImportedEntity *getImpl(LLVMContext &Context, unsigned Tag,
2209                                    Metadata *Scope, Metadata *Entity,
2210                                    unsigned Line, MDString *Name,
2211                                    StorageType Storage,
2212                                    bool ShouldCreate = true);
2213
2214   TempDIImportedEntity cloneImpl() const {
2215     return getTemporary(getContext(), getTag(), getScope(), getEntity(),
2216                         getLine(), getName());
2217   }
2218
2219 public:
2220   DEFINE_MDNODE_GET(DIImportedEntity,
2221                     (unsigned Tag, DIScope *Scope, DINodeRef Entity,
2222                      unsigned Line, StringRef Name = ""),
2223                     (Tag, Scope, Entity, Line, Name))
2224   DEFINE_MDNODE_GET(DIImportedEntity,
2225                     (unsigned Tag, Metadata *Scope, Metadata *Entity,
2226                      unsigned Line, MDString *Name),
2227                     (Tag, Scope, Entity, Line, Name))
2228
2229   TempDIImportedEntity clone() const { return cloneImpl(); }
2230
2231   unsigned getLine() const { return Line; }
2232   DIScope *getScope() const { return cast_or_null<DIScope>(getRawScope()); }
2233   DINodeRef getEntity() const { return DINodeRef(getRawEntity()); }
2234   StringRef getName() const { return getStringOperand(2); }
2235
2236   Metadata *getRawScope() const { return getOperand(0); }
2237   Metadata *getRawEntity() const { return getOperand(1); }
2238   MDString *getRawName() const { return getOperandAs<MDString>(2); }
2239
2240   static bool classof(const Metadata *MD) {
2241     return MD->getMetadataID() == DIImportedEntityKind;
2242   }
2243 };
2244
2245 } // end namespace llvm
2246
2247 #undef DEFINE_MDNODE_GET_UNPACK_IMPL
2248 #undef DEFINE_MDNODE_GET_UNPACK
2249 #undef DEFINE_MDNODE_GET
2250
2251 #endif