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(CLASS, FORMAL, ARGS)                                 \
  24   static CLASS *get(LLVMContext &Context, DEFINE_MDNODE_GET_UNPACK(FORMAL)) {  \
  25     return getImpl(Context, DEFINE_MDNODE_GET_UNPACK(ARGS), Uniqued);          \
  26   }                                                                            \
  27   static CLASS *getIfExists(LLVMContext &Context,                              \
  28                             DEFINE_MDNODE_GET_UNPACK(FORMAL)) {                \
  29     return getImpl(Context, DEFINE_MDNODE_GET_UNPACK(ARGS), Uniqued,           \
  30                    /* ShouldCreate */ false);                                  \
  31   }                                                                            \
  32   static CLASS *getDistinct(LLVMContext &Context,                              \
  33                             DEFINE_MDNODE_GET_UNPACK(FORMAL)) {                \
  34     return getImpl(Context, DEFINE_MDNODE_GET_UNPACK(ARGS), Distinct);         \
  35   }                                                                            \
  36   static Temp##CLASS getTemporary(LLVMContext &Context,                        \
  37                                   DEFINE_MDNODE_GET_UNPACK(FORMAL)) {          \
  38     return Temp##CLASS(                                                        \
  39         getImpl(Context, DEFINE_MDNODE_GET_UNPACK(ARGS), Temporary));          \
  40   }
  41
  42 namespace llvm {
  43
  44 /// \brief Debug location.
  45 ///
  46 /// A debug location in source code, used for debug info and otherwise.
  47 class MDLocation : public MDNode {
  48   friend class LLVMContextImpl;
  49   friend class MDNode;
  50
  51   MDLocation(LLVMContext &C, StorageType Storage, unsigned Line,
  52              unsigned Column, ArrayRef<Metadata *> MDs);
  53   ~MDLocation() { dropAllReferences(); }
  54
  55   static MDLocation *getImpl(LLVMContext &Context, unsigned Line,
  56                              unsigned Column, Metadata *Scope,
  57                              Metadata *InlinedAt, StorageType Storage,
  58                              bool ShouldCreate = true);
  59
  60   TempMDLocation cloneImpl() const {
  61     return getTemporary(getContext(), getLine(), getColumn(), getScope(),
  62                         getInlinedAt());
  63   }
  64
  65   // Disallow replacing operands.
  66   void replaceOperandWith(unsigned I, Metadata *New) = delete;
  67
  68 public:
  69   DEFINE_MDNODE_GET(MDLocation,
  70                     (unsigned Line, unsigned Column, Metadata *Scope,
  71                      Metadata *InlinedAt = nullptr),
  72                     (Line, Column, Scope, InlinedAt))
  73
  74   /// \brief Return a (temporary) clone of this.
  75   TempMDLocation clone() const { return cloneImpl(); }
  76
  77   unsigned getLine() const { return SubclassData32; }
  78   unsigned getColumn() const { return SubclassData16; }
  79   Metadata *getScope() const { return getOperand(0); }
  80   Metadata *getInlinedAt() const {
  81     if (getNumOperands() == 2)
  82       return getOperand(1);
  83     return nullptr;
  84   }
  85
  86   static bool classof(const Metadata *MD) {
  87     return MD->getMetadataID() == MDLocationKind;
  88   }
  89 };
  90
  91 /// \brief Tagged DWARF-like metadata node.
  92 ///
  93 /// A metadata node with a DWARF tag (i.e., a constant named \c DW_TAG_*,
  94 /// defined in llvm/Support/Dwarf.h).  Called \a DebugNode because it's
  95 /// potentially used for non-DWARF output.
  96 class DebugNode : public MDNode {
  97   friend class LLVMContextImpl;
  98   friend class MDNode;
  99
 100 protected:
 101   DebugNode(LLVMContext &C, unsigned ID, StorageType Storage, unsigned Tag,
 102             ArrayRef<Metadata *> Ops1, ArrayRef<Metadata *> Ops2 = None)
 103       : MDNode(C, ID, Storage, Ops1, Ops2) {
 104     assert(Tag < 1u << 16);
 105     SubclassData16 = Tag;
 106   }
 107   ~DebugNode() {}
 108
 109   template <class Ty> Ty *getOperandAs(unsigned I) const {
 110     return cast_or_null<Ty>(getOperand(I));
 111   }
 112
 113   StringRef getStringOperand(unsigned I) const {
 114     if (auto *S = getOperandAs<MDString>(I))
 115       return S->getString();
 116     return StringRef();
 117   }
 118
 119   static MDString *getCanonicalMDString(LLVMContext &Context, StringRef S) {
 120     if (S.empty())
 121       return nullptr;
 122     return MDString::get(Context, S);
 123   }
 124
 125 public:
 126   unsigned getTag() const { return SubclassData16; }
 127
 128   static bool classof(const Metadata *MD) {
 129     switch (MD->getMetadataID()) {
 130     default:
 131       return false;
 132     case GenericDebugNodeKind:
 133     case MDSubrangeKind:
 134     case MDEnumeratorKind:
 135     case MDBasicTypeKind:
 136     case MDDerivedTypeKind:
 137     case MDCompositeTypeKind:
 138     case MDSubroutineTypeKind:
 139     case MDFileKind:
 140     case MDCompileUnitKind:
 141     case MDSubprogramKind:
 142     case MDLexicalBlockKind:
 143     case MDLexicalBlockFileKind:
 144     case MDNamespaceKind:
 145     case MDTemplateTypeParameterKind:
 146     case MDTemplateValueParameterKind:
 147     case MDGlobalVariableKind:
 148     case MDLocalVariableKind:
 149     case MDExpressionKind:
 150     case MDObjCPropertyKind:
 151     case MDImportedEntityKind:
 152       return true;
 153     }
 154   }
 155 };
 156
 157 /// \brief Generic tagged DWARF-like metadata node.
 158 ///
 159 /// An un-specialized DWARF-like metadata node.  The first operand is a
 160 /// (possibly empty) null-separated \a MDString header that contains arbitrary
 161 /// fields.  The remaining operands are \a dwarf_operands(), and are pointers
 162 /// to other metadata.
 163 class GenericDebugNode : public DebugNode {
 164   friend class LLVMContextImpl;
 165   friend class MDNode;
 166
 167   GenericDebugNode(LLVMContext &C, StorageType Storage, unsigned Hash,
 168                    unsigned Tag, ArrayRef<Metadata *> Ops1,
 169                    ArrayRef<Metadata *> Ops2)
 170       : DebugNode(C, GenericDebugNodeKind, Storage, Tag, Ops1, Ops2) {
 171     setHash(Hash);
 172   }
 173   ~GenericDebugNode() { dropAllReferences(); }
 174
 175   void setHash(unsigned Hash) { SubclassData32 = Hash; }
 176   void recalculateHash();
 177
 178   static GenericDebugNode *getImpl(LLVMContext &Context, unsigned Tag,
 179                                    StringRef Header,
 180                                    ArrayRef<Metadata *> DwarfOps,
 181                                    StorageType Storage,
 182                                    bool ShouldCreate = true) {
 183     return getImpl(Context, Tag, getCanonicalMDString(Context, Header),
 184                    DwarfOps, Storage, ShouldCreate);
 185   }
 186
 187   static GenericDebugNode *getImpl(LLVMContext &Context, unsigned Tag,
 188                                    MDString *Header,
 189                                    ArrayRef<Metadata *> DwarfOps,
 190                                    StorageType Storage,
 191                                    bool ShouldCreate = true);
 192
 193   TempGenericDebugNode cloneImpl() const {
 194     return getTemporary(
 195         getContext(), getTag(), getHeader(),
 196         SmallVector<Metadata *, 4>(dwarf_op_begin(), dwarf_op_end()));
 197   }
 198
 199 public:
 200   unsigned getHash() const { return SubclassData32; }
 201
 202   DEFINE_MDNODE_GET(GenericDebugNode, (unsigned Tag, StringRef Header,
 203                                        ArrayRef<Metadata *> DwarfOps),
 204                     (Tag, Header, DwarfOps))
 205   DEFINE_MDNODE_GET(GenericDebugNode, (unsigned Tag, MDString *Header,
 206                                        ArrayRef<Metadata *> DwarfOps),
 207                     (Tag, Header, DwarfOps))
 208
 209   /// \brief Return a (temporary) clone of this.
 210   TempGenericDebugNode clone() const { return cloneImpl(); }
 211
 212   unsigned getTag() const { return SubclassData16; }
 213   StringRef getHeader() const { return getStringOperand(0); }
 214
 215   op_iterator dwarf_op_begin() const { return op_begin() + 1; }
 216   op_iterator dwarf_op_end() const { return op_end(); }
 217   op_range dwarf_operands() const {
 218     return op_range(dwarf_op_begin(), dwarf_op_end());
 219   }
 220
 221   unsigned getNumDwarfOperands() const { return getNumOperands() - 1; }
 222   const MDOperand &getDwarfOperand(unsigned I) const {
 223     return getOperand(I + 1);
 224   }
 225   void replaceDwarfOperandWith(unsigned I, Metadata *New) {
 226     replaceOperandWith(I + 1, New);
 227   }
 228
 229   static bool classof(const Metadata *MD) {
 230     return MD->getMetadataID() == GenericDebugNodeKind;
 231   }
 232 };
 233
 234 /// \brief Array subrange.
 235 ///
 236 /// TODO: Merge into node for DW_TAG_array_type, which should have a custom
 237 /// type.
 238 class MDSubrange : public DebugNode {
 239   friend class LLVMContextImpl;
 240   friend class MDNode;
 241
 242   int64_t Count;
 243   int64_t Lo;
 244
 245   MDSubrange(LLVMContext &C, StorageType Storage, int64_t Count, int64_t Lo)
 246       : DebugNode(C, MDSubrangeKind, Storage, dwarf::DW_TAG_subrange_type,
 247                   None),
 248         Count(Count), Lo(Lo) {}
 249   ~MDSubrange() {}
 250
 251   static MDSubrange *getImpl(LLVMContext &Context, int64_t Count, int64_t Lo,
 252                              StorageType Storage, bool ShouldCreate = true);
 253
 254   TempMDSubrange cloneImpl() const {
 255     return getTemporary(getContext(), getCount(), getLo());
 256   }
 257
 258 public:
 259   DEFINE_MDNODE_GET(MDSubrange, (int64_t Count, int64_t Lo = 0), (Count, Lo))
 260
 261   TempMDSubrange clone() const { return cloneImpl(); }
 262
 263   int64_t getLo() const { return Lo; }
 264   int64_t getCount() const { return Count; }
 265
 266   static bool classof(const Metadata *MD) {
 267     return MD->getMetadataID() == MDSubrangeKind;
 268   }
 269 };
 270
 271 /// \brief Enumeration value.
 272 ///
 273 /// TODO: Add a pointer to the context (DW_TAG_enumeration_type) once that no
 274 /// longer creates a type cycle.
 275 class MDEnumerator : public DebugNode {
 276   friend class LLVMContextImpl;
 277   friend class MDNode;
 278
 279   int64_t Value;
 280
 281   MDEnumerator(LLVMContext &C, StorageType Storage, int64_t Value,
 282                ArrayRef<Metadata *> Ops)
 283       : DebugNode(C, MDEnumeratorKind, Storage, dwarf::DW_TAG_enumerator, Ops),
 284         Value(Value) {}
 285   ~MDEnumerator() {}
 286
 287   static MDEnumerator *getImpl(LLVMContext &Context, int64_t Value,
 288                                StringRef Name, StorageType Storage,
 289                                bool ShouldCreate = true) {
 290     return getImpl(Context, Value, getCanonicalMDString(Context, Name), Storage,
 291                    ShouldCreate);
 292   }
 293   static MDEnumerator *getImpl(LLVMContext &Context, int64_t Value,
 294                                MDString *Name, StorageType Storage,
 295                                bool ShouldCreate = true);
 296
 297   TempMDEnumerator cloneImpl() const {
 298     return getTemporary(getContext(), getValue(), getName());
 299   }
 300
 301 public:
 302   DEFINE_MDNODE_GET(MDEnumerator, (int64_t Value, StringRef Name),
 303                     (Value, Name))
 304   DEFINE_MDNODE_GET(MDEnumerator, (int64_t Value, MDString *Name),
 305                     (Value, Name))
 306
 307   TempMDEnumerator clone() const { return cloneImpl(); }
 308
 309   int64_t getValue() const { return Value; }
 310   StringRef getName() const { return getStringOperand(0); }
 311
 312   MDString *getRawName() const { return getOperandAs<MDString>(0); }
 313
 314   static bool classof(const Metadata *MD) {
 315     return MD->getMetadataID() == MDEnumeratorKind;
 316   }
 317 };
 318
 319 /// \brief Base class for scope-like contexts.
 320 ///
 321 /// Base class for lexical scopes and types (which are also declaration
 322 /// contexts).
 323 ///
 324 /// TODO: Separate the concepts of declaration contexts and lexical scopes.
 325 class MDScope : public DebugNode {
 326 protected:
 327   MDScope(LLVMContext &C, unsigned ID, StorageType Storage, unsigned Tag,
 328           ArrayRef<Metadata *> Ops)
 329       : DebugNode(C, ID, Storage, Tag, Ops) {}
 330   ~MDScope() {}
 331
 332 public:
 333   Metadata *getFile() const { return getOperand(0); }
 334
 335   static bool classof(const Metadata *MD) {
 336     switch (MD->getMetadataID()) {
 337     default:
 338       return false;
 339     case MDBasicTypeKind:
 340     case MDDerivedTypeKind:
 341     case MDCompositeTypeKind:
 342     case MDSubroutineTypeKind:
 343     case MDFileKind:
 344     case MDCompileUnitKind:
 345     case MDSubprogramKind:
 346     case MDLexicalBlockKind:
 347     case MDLexicalBlockFileKind:
 348     case MDNamespaceKind:
 349       return true;
 350     }
 351   }
 352 };
 353
 354 /// \brief Base class for types.
 355 ///
 356 /// TODO: Remove the hardcoded name and context, since many types don't use
 357 /// them.
 358 /// TODO: Split up flags.
 359 class MDType : public MDScope {
 360   unsigned Line;
 361   unsigned SizeInBits;
 362   unsigned AlignInBits;
 363   unsigned OffsetInBits;
 364   unsigned Flags;
 365
 366 protected:
 367   MDType(LLVMContext &C, unsigned ID, StorageType Storage, unsigned Tag,
 368          unsigned Line, unsigned SizeInBits, unsigned AlignInBits,
 369          unsigned OffsetInBits, unsigned Flags, ArrayRef<Metadata *> Ops)
 370       : MDScope(C, ID, Storage, Tag, Ops), Line(Line), SizeInBits(SizeInBits),
 371         AlignInBits(AlignInBits), OffsetInBits(OffsetInBits), Flags(Flags) {}
 372   ~MDType() {}
 373
 374 public:
 375   unsigned getLine() const { return Line; }
 376   unsigned getSizeInBits() const { return SizeInBits; }
 377   unsigned getAlignInBits() const { return AlignInBits; }
 378   unsigned getOffsetInBits() const { return OffsetInBits; }
 379   unsigned getFlags() const { return Flags; }
 380
 381   Metadata *getScope() const { return getOperand(1); }
 382   StringRef getName() const { return getStringOperand(2); }
 383
 384   MDString *getRawName() const { return getOperandAs<MDString>(2); }
 385
 386   static bool classof(const Metadata *MD) {
 387     switch (MD->getMetadataID()) {
 388     default:
 389       return false;
 390     case MDBasicTypeKind:
 391     case MDDerivedTypeKind:
 392     case MDCompositeTypeKind:
 393     case MDSubroutineTypeKind:
 394       return true;
 395     }
 396   }
 397 };
 398
 399 /// \brief Basic type.
 400 ///
 401 /// TODO: Split out DW_TAG_unspecified_type.
 402 /// TODO: Drop unused accessors.
 403 class MDBasicType : public MDType {
 404   friend class LLVMContextImpl;
 405   friend class MDNode;
 406
 407   unsigned Encoding;
 408
 409   MDBasicType(LLVMContext &C, StorageType Storage, unsigned Tag,
 410               unsigned SizeInBits, unsigned AlignInBits, unsigned Encoding,
 411               ArrayRef<Metadata *> Ops)
 412       : MDType(C, MDBasicTypeKind, Storage, Tag, 0, SizeInBits, AlignInBits, 0,
 413                0, Ops),
 414         Encoding(Encoding) {}
 415   ~MDBasicType() {}
 416
 417   static MDBasicType *getImpl(LLVMContext &Context, unsigned Tag,
 418                               StringRef Name, unsigned SizeInBits,
 419                               unsigned AlignInBits, unsigned Encoding,
 420                               StorageType Storage, bool ShouldCreate = true) {
 421     return getImpl(Context, Tag, getCanonicalMDString(Context, Name),
 422                    SizeInBits, AlignInBits, Encoding, Storage, ShouldCreate);
 423   }
 424   static MDBasicType *getImpl(LLVMContext &Context, unsigned Tag,
 425                               MDString *Name, unsigned SizeInBits,
 426                               unsigned AlignInBits, unsigned Encoding,
 427                               StorageType Storage, bool ShouldCreate = true);
 428
 429   TempMDBasicType cloneImpl() const {
 430     return getTemporary(getContext(), getTag(), getName(), getSizeInBits(),
 431                         getAlignInBits(), getEncoding());
 432   }
 433
 434 public:
 435   DEFINE_MDNODE_GET(MDBasicType,
 436                     (unsigned Tag, StringRef Name, unsigned SizeInBits,
 437                      unsigned AlignInBits, unsigned Encoding),
 438                     (Tag, Name, SizeInBits, AlignInBits, Encoding))
 439   DEFINE_MDNODE_GET(MDBasicType,
 440                     (unsigned Tag, MDString *Name, unsigned SizeInBits,
 441                      unsigned AlignInBits, unsigned Encoding),
 442                     (Tag, Name, SizeInBits, AlignInBits, Encoding))
 443
 444   TempMDBasicType clone() const { return cloneImpl(); }
 445
 446   unsigned getEncoding() const { return Encoding; }
 447
 448   static bool classof(const Metadata *MD) {
 449     return MD->getMetadataID() == MDBasicTypeKind;
 450   }
 451 };
 452
 453 /// \brief Base class for MDDerivedType and MDCompositeType.
 454 ///
 455 /// TODO: Delete; they're not really related.
 456 class MDDerivedTypeBase : public MDType {
 457 protected:
 458   MDDerivedTypeBase(LLVMContext &C, unsigned ID, StorageType Storage,
 459                     unsigned Tag, unsigned Line, unsigned SizeInBits,
 460                     unsigned AlignInBits, unsigned OffsetInBits, unsigned Flags,
 461                     ArrayRef<Metadata *> Ops)
 462       : MDType(C, ID, Storage, Tag, Line, SizeInBits, AlignInBits, OffsetInBits,
 463                Flags, Ops) {}
 464   ~MDDerivedTypeBase() {}
 465
 466 public:
 467   Metadata *getBaseType() const { return getOperand(3); }
 468
 469   static bool classof(const Metadata *MD) {
 470     return MD->getMetadataID() == MDDerivedTypeKind ||
 471            MD->getMetadataID() == MDCompositeTypeKind ||
 472            MD->getMetadataID() == MDSubroutineTypeKind;
 473   }
 474 };
 475
 476 /// \brief Derived types.
 477 ///
 478 /// This includes qualified types, pointers, references, friends, typedefs, and
 479 /// class members.
 480 ///
 481 /// TODO: Split out members (inheritance, fields, methods, etc.).
 482 class MDDerivedType : public MDDerivedTypeBase {
 483   friend class LLVMContextImpl;
 484   friend class MDNode;
 485
 486   MDDerivedType(LLVMContext &C, StorageType Storage, unsigned Tag,
 487                 unsigned Line, unsigned SizeInBits, unsigned AlignInBits,
 488                 unsigned OffsetInBits, unsigned Flags, ArrayRef<Metadata *> Ops)
 489       : MDDerivedTypeBase(C, MDDerivedTypeKind, Storage, Tag, Line, SizeInBits,
 490                           AlignInBits, OffsetInBits, Flags, Ops) {}
 491   ~MDDerivedType() {}
 492
 493   static MDDerivedType *getImpl(LLVMContext &Context, unsigned Tag,
 494                                 StringRef Name, Metadata *File, unsigned Line,
 495                                 Metadata *Scope, Metadata *BaseType,
 496                                 unsigned SizeInBits, unsigned AlignInBits,
 497                                 unsigned OffsetInBits, unsigned Flags,
 498                                 Metadata *ExtraData, StorageType Storage,
 499                                 bool ShouldCreate = true) {
 500     return getImpl(Context, Tag, getCanonicalMDString(Context, Name), File,
 501                    Line, Scope, BaseType, SizeInBits, AlignInBits, OffsetInBits,
 502                    Flags, ExtraData, Storage, ShouldCreate);
 503   }
 504   static MDDerivedType *getImpl(LLVMContext &Context, unsigned Tag,
 505                                 MDString *Name, Metadata *File, unsigned Line,
 506                                 Metadata *Scope, Metadata *BaseType,
 507                                 unsigned SizeInBits, unsigned AlignInBits,
 508                                 unsigned OffsetInBits, unsigned Flags,
 509                                 Metadata *ExtraData, StorageType Storage,
 510                                 bool ShouldCreate = true);
 511
 512   TempMDDerivedType cloneImpl() const {
 513     return getTemporary(getContext(), getTag(), getName(), getFile(), getLine(),
 514                         getScope(), getBaseType(), getSizeInBits(),
 515                         getAlignInBits(), getOffsetInBits(), getFlags(),
 516                         getExtraData());
 517   }
 518
 519 public:
 520   DEFINE_MDNODE_GET(MDDerivedType,
 521                     (unsigned Tag, MDString *Name, Metadata *File,
 522                      unsigned Line, Metadata *Scope, Metadata *BaseType,
 523                      unsigned SizeInBits, unsigned AlignInBits,
 524                      unsigned OffsetInBits, unsigned Flags,
 525                      Metadata *ExtraData = nullptr),
 526                     (Tag, Name, File, Line, Scope, BaseType, SizeInBits,
 527                      AlignInBits, OffsetInBits, Flags, ExtraData))
 528   DEFINE_MDNODE_GET(MDDerivedType,
 529                     (unsigned Tag, StringRef Name, Metadata *File,
 530                      unsigned Line, Metadata *Scope, Metadata *BaseType,
 531                      unsigned SizeInBits, unsigned AlignInBits,
 532                      unsigned OffsetInBits, unsigned Flags,
 533                      Metadata *ExtraData = nullptr),
 534                     (Tag, Name, File, Line, Scope, BaseType, SizeInBits,
 535                      AlignInBits, OffsetInBits, Flags, ExtraData))
 536
 537   TempMDDerivedType clone() const { return cloneImpl(); }
 538
 539   /// \brief Get extra data associated with this derived type.
 540   ///
 541   /// Class type for pointer-to-members, objective-c property node for ivars,
 542   /// or global constant wrapper for static members.
 543   ///
 544   /// TODO: Separate out types that need this extra operand: pointer-to-member
 545   /// types and member fields (static members and ivars).
 546   Metadata *getExtraData() const { return getOperand(4); }
 547
 548   static bool classof(const Metadata *MD) {
 549     return MD->getMetadataID() == MDDerivedTypeKind;
 550   }
 551 };
 552
 553 /// \brief Base class for MDCompositeType and MDSubroutineType.
 554 ///
 555 /// TODO: Delete; they're not really related.
 556 class MDCompositeTypeBase : public MDDerivedTypeBase {
 557   unsigned RuntimeLang;
 558
 559 protected:
 560   MDCompositeTypeBase(LLVMContext &C, unsigned ID, StorageType Storage,
 561                       unsigned Tag, unsigned Line, unsigned RuntimeLang,
 562                       unsigned SizeInBits, unsigned AlignInBits,
 563                       unsigned OffsetInBits, unsigned Flags,
 564                       ArrayRef<Metadata *> Ops)
 565       : MDDerivedTypeBase(C, ID, Storage, Tag, Line, SizeInBits, AlignInBits,
 566                           OffsetInBits, Flags, Ops),
 567         RuntimeLang(RuntimeLang) {}
 568   ~MDCompositeTypeBase() {}
 569
 570 public:
 571   Metadata *getElements() const { return getOperand(4); }
 572   Metadata *getVTableHolder() const { return getOperand(5); }
 573   Metadata *getTemplateParams() const { return getOperand(6); }
 574   StringRef getIdentifier() const { return getStringOperand(7); }
 575   unsigned getRuntimeLang() const { return RuntimeLang; }
 576
 577   MDString *getRawIdentifier() const { return getOperandAs<MDString>(7); }
 578
 579   static bool classof(const Metadata *MD) {
 580     return MD->getMetadataID() == MDCompositeTypeKind ||
 581            MD->getMetadataID() == MDSubroutineTypeKind;
 582   }
 583 };
 584
 585 /// \brief Composite types.
 586 ///
 587 /// TODO: Detach from DerivedTypeBase (split out MDEnumType?).
 588 /// TODO: Create a custom, unrelated node for DW_TAG_array_type.
 589 class MDCompositeType : public MDCompositeTypeBase {
 590   friend class LLVMContextImpl;
 591   friend class MDNode;
 592
 593   MDCompositeType(LLVMContext &C, StorageType Storage, unsigned Tag,
 594                   unsigned Line, unsigned RuntimeLang, unsigned SizeInBits,
 595                   unsigned AlignInBits, unsigned OffsetInBits, unsigned Flags,
 596                   ArrayRef<Metadata *> Ops)
 597       : MDCompositeTypeBase(C, MDCompositeTypeKind, Storage, Tag, Line,
 598                             RuntimeLang, SizeInBits, AlignInBits, OffsetInBits,
 599                             Flags, Ops) {}
 600   ~MDCompositeType() {}
 601
 602   static MDCompositeType *
 603   getImpl(LLVMContext &Context, unsigned Tag, StringRef Name, Metadata *File,
 604           unsigned Line, Metadata *Scope, Metadata *BaseType,
 605           unsigned SizeInBits, unsigned AlignInBits, unsigned OffsetInBits,
 606           unsigned Flags, Metadata *Elements, unsigned RuntimeLang,
 607           Metadata *VTableHolder, Metadata *TemplateParams,
 608           StringRef Identifier, StorageType Storage, bool ShouldCreate = true) {
 609     return getImpl(Context, Tag, getCanonicalMDString(Context, Name), File,
 610                    Line, Scope, BaseType, SizeInBits, AlignInBits, OffsetInBits,
 611                    Flags, Elements, RuntimeLang, VTableHolder, TemplateParams,
 612                    getCanonicalMDString(Context, Identifier), Storage,
 613                    ShouldCreate);
 614   }
 615   static MDCompositeType *
 616   getImpl(LLVMContext &Context, unsigned Tag, MDString *Name, Metadata *File,
 617           unsigned Line, Metadata *Scope, Metadata *BaseType,
 618           unsigned SizeInBits, unsigned AlignInBits, unsigned OffsetInBits,
 619           unsigned Flags, Metadata *Elements, unsigned RuntimeLang,
 620           Metadata *VTableHolder, Metadata *TemplateParams,
 621           MDString *Identifier, StorageType Storage, bool ShouldCreate = true);
 622
 623   TempMDCompositeType cloneImpl() const {
 624     return getTemporary(getContext(), getTag(), getName(), getFile(), getLine(),
 625                         getScope(), getBaseType(), getSizeInBits(),
 626                         getAlignInBits(), getOffsetInBits(), getFlags(),
 627                         getElements(), getRuntimeLang(), getVTableHolder(),
 628                         getTemplateParams(), getIdentifier());
 629   }
 630
 631 public:
 632   DEFINE_MDNODE_GET(MDCompositeType,
 633                     (unsigned Tag, StringRef Name, Metadata *File,
 634                      unsigned Line, Metadata *Scope, Metadata *BaseType,
 635                      unsigned SizeInBits, unsigned AlignInBits,
 636                      unsigned OffsetInBits, unsigned Flags, Metadata *Elements,
 637                      unsigned RuntimeLang, Metadata *VTableHolder,
 638                      Metadata *TemplateParams = nullptr,
 639                      StringRef Identifier = ""),
 640                     (Tag, Name, File, Line, Scope, BaseType, SizeInBits,
 641                      AlignInBits, OffsetInBits, Flags, Elements, RuntimeLang,
 642                      VTableHolder, TemplateParams, Identifier))
 643   DEFINE_MDNODE_GET(MDCompositeType,
 644                     (unsigned Tag, MDString *Name, Metadata *File,
 645                      unsigned Line, Metadata *Scope, Metadata *BaseType,
 646                      unsigned SizeInBits, unsigned AlignInBits,
 647                      unsigned OffsetInBits, unsigned Flags, Metadata *Elements,
 648                      unsigned RuntimeLang, Metadata *VTableHolder,
 649                      Metadata *TemplateParams = nullptr,
 650                      MDString *Identifier = nullptr),
 651                     (Tag, Name, File, Line, Scope, BaseType, SizeInBits,
 652                      AlignInBits, OffsetInBits, Flags, Elements, RuntimeLang,
 653                      VTableHolder, TemplateParams, Identifier))
 654
 655   TempMDCompositeType clone() const { return cloneImpl(); }
 656
 657   static bool classof(const Metadata *MD) {
 658     return MD->getMetadataID() == MDCompositeTypeKind;
 659   }
 660 };
 661
 662 /// \brief Type array for a subprogram.
 663 ///
 664 /// TODO: Detach from CompositeType, and fold the array of types in directly
 665 /// as operands.
 666 class MDSubroutineType : public MDCompositeTypeBase {
 667   friend class LLVMContextImpl;
 668   friend class MDNode;
 669
 670   MDSubroutineType(LLVMContext &C, StorageType Storage, unsigned Flags,
 671                    ArrayRef<Metadata *> Ops)
 672       : MDCompositeTypeBase(C, MDSubroutineTypeKind, Storage,
 673                             dwarf::DW_TAG_subroutine_type, 0, 0, 0, 0, 0, Flags,
 674                             Ops) {}
 675   ~MDSubroutineType() {}
 676
 677   static MDSubroutineType *getImpl(LLVMContext &Context, unsigned Flags,
 678                                    Metadata *TypeArray, StorageType Storage,
 679                                    bool ShouldCreate = true);
 680
 681   TempMDSubroutineType cloneImpl() const {
 682     return getTemporary(getContext(), getFlags(), getTypeArray());
 683   }
 684
 685 public:
 686   DEFINE_MDNODE_GET(MDSubroutineType, (unsigned Flags, Metadata *TypeArray),
 687                     (Flags, TypeArray))
 688
 689   TempMDSubroutineType clone() const { return cloneImpl(); }
 690
 691   Metadata *getTypeArray() const { return getElements(); }
 692
 693   static bool classof(const Metadata *MD) {
 694     return MD->getMetadataID() == MDSubroutineTypeKind;
 695   }
 696 };
 697
 698 /// \brief File.
 699 ///
 700 /// TODO: Merge with directory/file node (including users).
 701 /// TODO: Canonicalize paths on creation.
 702 class MDFile : public MDScope {
 703   friend class LLVMContextImpl;
 704   friend class MDNode;
 705
 706   MDFile(LLVMContext &C, StorageType Storage, ArrayRef<Metadata *> Ops)
 707       : MDScope(C, MDFileKind, Storage, dwarf::DW_TAG_file_type, Ops) {}
 708   ~MDFile() {}
 709
 710   static MDFile *getImpl(LLVMContext &Context, StringRef Filename,
 711                          StringRef Directory, StorageType Storage,
 712                          bool ShouldCreate = true) {
 713     return getImpl(Context, getCanonicalMDString(Context, Filename),
 714                    getCanonicalMDString(Context, Directory), Storage,
 715                    ShouldCreate);
 716   }
 717   static MDFile *getImpl(LLVMContext &Context, MDString *Filename,
 718                          MDString *Directory, StorageType Storage,
 719                          bool ShouldCreate = true);
 720
 721   TempMDFile cloneImpl() const {
 722     return getTemporary(getContext(), getFilename(), getDirectory());
 723   }
 724
 725 public:
 726   DEFINE_MDNODE_GET(MDFile, (StringRef Filename, StringRef Directory),
 727                     (Filename, Directory))
 728   DEFINE_MDNODE_GET(MDFile, (MDString * Filename, MDString *Directory),
 729                     (Filename, Directory))
 730
 731   TempMDFile clone() const { return cloneImpl(); }
 732
 733   MDTuple *getFileNode() const { return cast<MDTuple>(getOperand(0)); }
 734
 735   StringRef getFilename() const {
 736     if (auto *S = getRawFilename())
 737       return S->getString();
 738     return StringRef();
 739   }
 740   StringRef getDirectory() const {
 741     if (auto *S = getRawDirectory())
 742       return S->getString();
 743     return StringRef();
 744   }
 745
 746   MDString *getRawFilename() const {
 747     return cast_or_null<MDString>(getFileNode()->getOperand(0));
 748   }
 749   MDString *getRawDirectory() const {
 750     return cast_or_null<MDString>(getFileNode()->getOperand(1));
 751   }
 752
 753   static bool classof(const Metadata *MD) {
 754     return MD->getMetadataID() == MDFileKind;
 755   }
 756 };
 757
 758 /// \brief Compile unit.
 759 class MDCompileUnit : public MDScope {
 760   friend class LLVMContextImpl;
 761   friend class MDNode;
 762
 763   unsigned SourceLanguage;
 764   bool IsOptimized;
 765   unsigned RuntimeVersion;
 766   unsigned EmissionKind;
 767
 768   MDCompileUnit(LLVMContext &C, StorageType Storage, unsigned SourceLanguage,
 769                 bool IsOptimized, unsigned RuntimeVersion,
 770                 unsigned EmissionKind, ArrayRef<Metadata *> Ops)
 771       : MDScope(C, MDCompileUnitKind, Storage, dwarf::DW_TAG_compile_unit, Ops),
 772         SourceLanguage(SourceLanguage), IsOptimized(IsOptimized),
 773         RuntimeVersion(RuntimeVersion), EmissionKind(EmissionKind) {}
 774   ~MDCompileUnit() {}
 775
 776   static MDCompileUnit *
 777   getImpl(LLVMContext &Context, unsigned SourceLanguage, Metadata *File,
 778           StringRef Producer, bool IsOptimized, StringRef Flags,
 779           unsigned RuntimeVersion, StringRef SplitDebugFilename,
 780           unsigned EmissionKind, Metadata *EnumTypes, Metadata *RetainedTypes,
 781           Metadata *Subprograms, Metadata *GlobalVariables,
 782           Metadata *ImportedEntities, StorageType Storage,
 783           bool ShouldCreate = true) {
 784     return getImpl(Context, SourceLanguage, File,
 785                    getCanonicalMDString(Context, Producer), IsOptimized,
 786                    getCanonicalMDString(Context, Flags), RuntimeVersion,
 787                    getCanonicalMDString(Context, SplitDebugFilename),
 788                    EmissionKind, EnumTypes, RetainedTypes, Subprograms,
 789                    GlobalVariables, ImportedEntities, Storage, ShouldCreate);
 790   }
 791   static MDCompileUnit *
 792   getImpl(LLVMContext &Context, unsigned SourceLanguage, Metadata *File,
 793           MDString *Producer, bool IsOptimized, MDString *Flags,
 794           unsigned RuntimeVersion, MDString *SplitDebugFilename,
 795           unsigned EmissionKind, Metadata *EnumTypes, Metadata *RetainedTypes,
 796           Metadata *Subprograms, Metadata *GlobalVariables,
 797           Metadata *ImportedEntities, StorageType Storage,
 798           bool ShouldCreate = true);
 799
 800   TempMDCompileUnit cloneImpl() const {
 801     return getTemporary(
 802         getContext(), getSourceLanguage(), getFile(), getProducer(),
 803         isOptimized(), getFlags(), getRuntimeVersion(), getSplitDebugFilename(),
 804         getEmissionKind(), getEnumTypes(), getRetainedTypes(), getSubprograms(),
 805         getGlobalVariables(), getImportedEntities());
 806   }
 807
 808 public:
 809   DEFINE_MDNODE_GET(MDCompileUnit,
 810                     (unsigned SourceLanguage, Metadata *File,
 811                      StringRef Producer, bool IsOptimized, StringRef Flags,
 812                      unsigned RuntimeVersion, StringRef SplitDebugFilename,
 813                      unsigned EmissionKind, Metadata *EnumTypes,
 814                      Metadata *RetainedTypes, Metadata *Subprograms,
 815                      Metadata *GlobalVariables, Metadata *ImportedEntities),
 816                     (SourceLanguage, File, Producer, IsOptimized, Flags,
 817                      RuntimeVersion, SplitDebugFilename, EmissionKind,
 818                      EnumTypes, RetainedTypes, Subprograms, GlobalVariables,
 819                      ImportedEntities))
 820   DEFINE_MDNODE_GET(MDCompileUnit,
 821                     (unsigned SourceLanguage, Metadata *File,
 822                      MDString *Producer, bool IsOptimized, MDString *Flags,
 823                      unsigned RuntimeVersion, MDString *SplitDebugFilename,
 824                      unsigned EmissionKind, Metadata *EnumTypes,
 825                      Metadata *RetainedTypes, Metadata *Subprograms,
 826                      Metadata *GlobalVariables, Metadata *ImportedEntities),
 827                     (SourceLanguage, File, Producer, IsOptimized, Flags,
 828                      RuntimeVersion, SplitDebugFilename, EmissionKind,
 829                      EnumTypes, RetainedTypes, Subprograms, GlobalVariables,
 830                      ImportedEntities))
 831
 832   TempMDCompileUnit clone() const { return cloneImpl(); }
 833
 834   unsigned getSourceLanguage() const { return SourceLanguage; }
 835   bool isOptimized() const { return IsOptimized; }
 836   unsigned getRuntimeVersion() const { return RuntimeVersion; }
 837   unsigned getEmissionKind() const { return EmissionKind; }
 838   StringRef getProducer() const { return getStringOperand(1); }
 839   StringRef getFlags() const { return getStringOperand(2); }
 840   StringRef getSplitDebugFilename() const { return getStringOperand(3); }
 841   Metadata *getEnumTypes() const { return getOperand(4); }
 842   Metadata *getRetainedTypes() const { return getOperand(5); }
 843   Metadata *getSubprograms() const { return getOperand(6); }
 844   Metadata *getGlobalVariables() const { return getOperand(7); }
 845   Metadata *getImportedEntities() const { return getOperand(8); }
 846
 847   MDString *getRawProducer() const { return getOperandAs<MDString>(1); }
 848   MDString *getRawFlags() const { return getOperandAs<MDString>(2); }
 849   MDString *getRawSplitDebugFilename() const {
 850     return getOperandAs<MDString>(3);
 851   }
 852
 853   static bool classof(const Metadata *MD) {
 854     return MD->getMetadataID() == MDCompileUnitKind;
 855   }
 856 };
 857
 858 /// \brief Subprogram description.
 859 ///
 860 /// TODO: Remove DisplayName.  It's always equal to Name.
 861 /// TODO: Split up flags.
 862 class MDSubprogram : public MDScope {
 863   friend class LLVMContextImpl;
 864   friend class MDNode;
 865
 866   unsigned Line;
 867   unsigned ScopeLine;
 868   unsigned Virtuality;
 869   unsigned VirtualIndex;
 870   unsigned Flags;
 871   bool IsLocalToUnit;
 872   bool IsDefinition;
 873   bool IsOptimized;
 874
 875   MDSubprogram(LLVMContext &C, StorageType Storage, unsigned Line,
 876                unsigned ScopeLine, unsigned Virtuality, unsigned VirtualIndex,
 877                unsigned Flags, bool IsLocalToUnit, bool IsDefinition,
 878                bool IsOptimized, ArrayRef<Metadata *> Ops)
 879       : MDScope(C, MDSubprogramKind, Storage, dwarf::DW_TAG_subprogram, Ops),
 880         Line(Line), ScopeLine(ScopeLine), Virtuality(Virtuality),
 881         VirtualIndex(VirtualIndex), Flags(Flags), IsLocalToUnit(IsLocalToUnit),
 882         IsDefinition(IsDefinition), IsOptimized(IsOptimized) {}
 883   ~MDSubprogram() {}
 884
 885   static MDSubprogram *
 886   getImpl(LLVMContext &Context, Metadata *Scope, StringRef Name,
 887           StringRef LinkageName, Metadata *File, unsigned Line, Metadata *Type,
 888           bool IsLocalToUnit, bool IsDefinition, unsigned ScopeLine,
 889           Metadata *ContainingType, unsigned Virtuality, unsigned VirtualIndex,
 890           unsigned Flags, bool IsOptimized, Metadata *Function,
 891           Metadata *TemplateParams, Metadata *Declaration, Metadata *Variables,
 892           StorageType Storage, bool ShouldCreate = true) {
 893     return getImpl(Context, Scope, getCanonicalMDString(Context, Name),
 894                    getCanonicalMDString(Context, LinkageName), File, Line, Type,
 895                    IsLocalToUnit, IsDefinition, ScopeLine, ContainingType,
 896                    Virtuality, VirtualIndex, Flags, IsOptimized, Function,
 897                    TemplateParams, Declaration, Variables, Storage,
 898                    ShouldCreate);
 899   }
 900   static MDSubprogram *
 901   getImpl(LLVMContext &Context, Metadata *Scope, MDString *Name,
 902           MDString *LinkageName, Metadata *File, unsigned Line, Metadata *Type,
 903           bool IsLocalToUnit, bool IsDefinition, unsigned ScopeLine,
 904           Metadata *ContainingType, unsigned Virtuality, unsigned VirtualIndex,
 905           unsigned Flags, bool IsOptimized, Metadata *Function,
 906           Metadata *TemplateParams, Metadata *Declaration, Metadata *Variables,
 907           StorageType Storage, bool ShouldCreate = true);
 908
 909   TempMDSubprogram cloneImpl() const {
 910     return getTemporary(getContext(), getScope(), getName(), getLinkageName(),
 911                         getFile(), getLine(), getType(), isLocalToUnit(),
 912                         isDefinition(), getScopeLine(), getContainingType(),
 913                         getVirtuality(), getVirtualIndex(), getFlags(),
 914                         isOptimized(), getFunction(), getTemplateParams(),
 915                         getDeclaration(), getVariables());
 916   }
 917
 918 public:
 919   DEFINE_MDNODE_GET(
 920       MDSubprogram,
 921       (Metadata * Scope, StringRef Name, StringRef LinkageName, Metadata *File,
 922        unsigned Line, Metadata *Type, bool IsLocalToUnit, bool IsDefinition,
 923        unsigned ScopeLine, Metadata *ContainingType, unsigned Virtuality,
 924        unsigned VirtualIndex, unsigned Flags, bool IsOptimized,
 925        Metadata *Function = nullptr, Metadata *TemplateParams = nullptr,
 926        Metadata *Declaration = nullptr, Metadata *Variables = nullptr),
 927       (Scope, Name, LinkageName, File, Line, Type, IsLocalToUnit, IsDefinition,
 928        ScopeLine, ContainingType, Virtuality, VirtualIndex, Flags, IsOptimized,
 929        Function, TemplateParams, Declaration, Variables))
 930   DEFINE_MDNODE_GET(
 931       MDSubprogram,
 932       (Metadata * Scope, MDString *Name, MDString *LinkageName, Metadata *File,
 933        unsigned Line, Metadata *Type, bool IsLocalToUnit, bool IsDefinition,
 934        unsigned ScopeLine, Metadata *ContainingType, unsigned Virtuality,
 935        unsigned VirtualIndex, unsigned Flags, bool IsOptimized,
 936        Metadata *Function = nullptr, Metadata *TemplateParams = nullptr,
 937        Metadata *Declaration = nullptr, Metadata *Variables = nullptr),
 938       (Scope, Name, LinkageName, File, Line, Type, IsLocalToUnit, IsDefinition,
 939        ScopeLine, ContainingType, Virtuality, VirtualIndex, Flags, IsOptimized,
 940        Function, TemplateParams, Declaration, Variables))
 941
 942   TempMDSubprogram clone() const { return cloneImpl(); }
 943
 944 public:
 945   unsigned getLine() const { return Line; }
 946   unsigned getVirtuality() const { return Virtuality; }
 947   unsigned getVirtualIndex() const { return VirtualIndex; }
 948   unsigned getScopeLine() const { return ScopeLine; }
 949   unsigned getFlags() const { return Flags; }
 950   bool isLocalToUnit() const { return IsLocalToUnit; }
 951   bool isDefinition() const { return IsDefinition; }
 952   bool isOptimized() const { return IsOptimized; }
 953
 954   Metadata *getScope() const { return getOperand(1); }
 955
 956   StringRef getName() const { return getStringOperand(2); }
 957   StringRef getDisplayName() const { return getStringOperand(3); }
 958   StringRef getLinkageName() const { return getStringOperand(4); }
 959
 960   MDString *getRawName() const { return getOperandAs<MDString>(2); }
 961   MDString *getRawLinkageName() const { return getOperandAs<MDString>(4); }
 962
 963   Metadata *getType() const { return getOperand(5); }
 964   Metadata *getContainingType() const { return getOperand(6); }
 965
 966   Metadata *getFunction() const { return getOperand(7); }
 967   Metadata *getTemplateParams() const { return getOperand(8); }
 968   Metadata *getDeclaration() const { return getOperand(9); }
 969   Metadata *getVariables() const { return getOperand(10); }
 970
 971   /// \brief Replace the function.
 972   ///
 973   /// If \a isUniqued() and not \a isResolved(), this could node will be
 974   /// RAUW'ed and deleted out from under the caller.  Use a \a TrackingMDRef if
 975   /// that's a problem.
 976   /// @{
 977   void replaceFunction(Function *F);
 978   void replaceFunction(ConstantAsMetadata *MD) { replaceOperandWith(7, MD); }
 979   void replaceFunction(std::nullptr_t) { replaceOperandWith(7, nullptr); }
 980   /// @}
 981
 982   static bool classof(const Metadata *MD) {
 983     return MD->getMetadataID() == MDSubprogramKind;
 984   }
 985 };
 986
 987 class MDLexicalBlockBase : public MDScope {
 988 protected:
 989   MDLexicalBlockBase(LLVMContext &C, unsigned ID, StorageType Storage,
 990                      ArrayRef<Metadata *> Ops)
 991       : MDScope(C, ID, Storage, dwarf::DW_TAG_lexical_block, Ops) {}
 992   ~MDLexicalBlockBase() {}
 993
 994 public:
 995   Metadata *getScope() const { return getOperand(1); }
 996
 997   static bool classof(const Metadata *MD) {
 998     return MD->getMetadataID() == MDLexicalBlockKind ||
 999            MD->getMetadataID() == MDLexicalBlockFileKind;
1000   }
1001 };
1002
1003 class MDLexicalBlock : public MDLexicalBlockBase {
1004   friend class LLVMContextImpl;
1005   friend class MDNode;
1006
1007   unsigned Line;
1008   unsigned Column;
1009
1010   MDLexicalBlock(LLVMContext &C, StorageType Storage, unsigned Line,
1011                  unsigned Column, ArrayRef<Metadata *> Ops)
1012       : MDLexicalBlockBase(C, MDLexicalBlockKind, Storage, Ops), Line(Line),
1013         Column(Column) {}
1014   ~MDLexicalBlock() {}
1015
1016   static MDLexicalBlock *getImpl(LLVMContext &Context, Metadata *Scope,
1017                                  Metadata *File, unsigned Line, unsigned Column,
1018                                  StorageType Storage, bool ShouldCreate = true);
1019
1020   TempMDLexicalBlock cloneImpl() const {
1021     return getTemporary(getContext(), getScope(), getFile(), getLine(),
1022                         getColumn());
1023   }
1024
1025 public:
1026   DEFINE_MDNODE_GET(MDLexicalBlock, (Metadata * Scope, Metadata *File,
1027                                      unsigned Line, unsigned Column),
1028                     (Scope, File, Line, Column))
1029
1030   TempMDLexicalBlock clone() const { return cloneImpl(); }
1031
1032   unsigned getLine() const { return Line; }
1033   unsigned getColumn() const { return Column; }
1034
1035   static bool classof(const Metadata *MD) {
1036     return MD->getMetadataID() == MDLexicalBlockKind;
1037   }
1038 };
1039
1040 class MDLexicalBlockFile : public MDLexicalBlockBase {
1041   friend class LLVMContextImpl;
1042   friend class MDNode;
1043
1044   unsigned Discriminator;
1045
1046   MDLexicalBlockFile(LLVMContext &C, StorageType Storage,
1047                      unsigned Discriminator, ArrayRef<Metadata *> Ops)
1048       : MDLexicalBlockBase(C, MDLexicalBlockFileKind, Storage, Ops),
1049         Discriminator(Discriminator) {}
1050   ~MDLexicalBlockFile() {}
1051
1052   static MDLexicalBlockFile *getImpl(LLVMContext &Context, Metadata *Scope,
1053                                      Metadata *File, unsigned Discriminator,
1054                                      StorageType Storage,
1055                                      bool ShouldCreate = true);
1056
1057   TempMDLexicalBlockFile cloneImpl() const {
1058     return getTemporary(getContext(), getScope(), getFile(),
1059                         getDiscriminator());
1060   }
1061
1062 public:
1063   DEFINE_MDNODE_GET(MDLexicalBlockFile,
1064                     (Metadata * Scope, Metadata *File, unsigned Discriminator),
1065                     (Scope, File, Discriminator))
1066
1067   TempMDLexicalBlockFile clone() const { return cloneImpl(); }
1068
1069   unsigned getDiscriminator() const { return Discriminator; }
1070
1071   static bool classof(const Metadata *MD) {
1072     return MD->getMetadataID() == MDLexicalBlockFileKind;
1073   }
1074 };
1075
1076 class MDNamespace : public MDScope {
1077   friend class LLVMContextImpl;
1078   friend class MDNode;
1079
1080   unsigned Line;
1081
1082   MDNamespace(LLVMContext &Context, StorageType Storage, unsigned Line,
1083               ArrayRef<Metadata *> Ops)
1084       : MDScope(Context, MDNamespaceKind, Storage, dwarf::DW_TAG_namespace,
1085                 Ops),
1086         Line(Line) {}
1087   ~MDNamespace() {}
1088
1089   static MDNamespace *getImpl(LLVMContext &Context, Metadata *Scope,
1090                               Metadata *File, StringRef Name, unsigned Line,
1091                               StorageType Storage, bool ShouldCreate = true) {
1092     return getImpl(Context, Scope, File, getCanonicalMDString(Context, Name),
1093                    Line, Storage, ShouldCreate);
1094   }
1095   static MDNamespace *getImpl(LLVMContext &Context, Metadata *Scope,
1096                               Metadata *File, MDString *Name, unsigned Line,
1097                               StorageType Storage, bool ShouldCreate = true);
1098
1099   TempMDNamespace cloneImpl() const {
1100     return getTemporary(getContext(), getScope(), getFile(), getName(),
1101                         getLine());
1102   }
1103
1104 public:
1105   DEFINE_MDNODE_GET(MDNamespace, (Metadata * Scope, Metadata *File,
1106                                   StringRef Name, unsigned Line),
1107                     (Scope, File, Name, Line))
1108   DEFINE_MDNODE_GET(MDNamespace, (Metadata * Scope, Metadata *File,
1109                                   MDString *Name, unsigned Line),
1110                     (Scope, File, Name, Line))
1111
1112   TempMDNamespace clone() const { return cloneImpl(); }
1113
1114   unsigned getLine() const { return Line; }
1115   Metadata *getScope() const { return getOperand(1); }
1116   StringRef getName() const { return getStringOperand(2); }
1117
1118   MDString *getRawName() const { return getOperandAs<MDString>(2); }
1119
1120   static bool classof(const Metadata *MD) {
1121     return MD->getMetadataID() == MDNamespaceKind;
1122   }
1123 };
1124
1125 /// \brief Base class for template parameters.
1126 ///
1127 /// TODO: Remove the scope.  It's always the compile unit, and never
1128 /// referenced.
1129 /// TODO: Remove File, Line and Column.  They're always 0 and never
1130 /// referenced.
1131 class MDTemplateParameter : public DebugNode {
1132 protected:
1133   MDTemplateParameter(LLVMContext &Context, unsigned ID, StorageType Storage,
1134                       unsigned Tag, ArrayRef<Metadata *> Ops)
1135       : DebugNode(Context, ID, Storage, Tag, Ops) {}
1136   ~MDTemplateParameter() {}
1137
1138 public:
1139   Metadata *getScope() const { return getOperand(0); }
1140   StringRef getName() const { return getStringOperand(1); }
1141   Metadata *getType() const { return getOperand(2); }
1142
1143   MDString *getRawName() const { return getOperandAs<MDString>(1); }
1144
1145   static bool classof(const Metadata *MD) {
1146     return MD->getMetadataID() == MDTemplateTypeParameterKind ||
1147            MD->getMetadataID() == MDTemplateValueParameterKind;
1148   }
1149 };
1150
1151 class MDTemplateTypeParameter : public MDTemplateParameter {
1152   friend class LLVMContextImpl;
1153   friend class MDNode;
1154
1155   MDTemplateTypeParameter(LLVMContext &Context, StorageType Storage,
1156                           ArrayRef<Metadata *> Ops)
1157       : MDTemplateParameter(Context, MDTemplateTypeParameterKind, Storage,
1158                             dwarf::DW_TAG_template_type_parameter, Ops) {}
1159   ~MDTemplateTypeParameter() {}
1160
1161   static MDTemplateTypeParameter *getImpl(LLVMContext &Context, Metadata *Scope,
1162                                           StringRef Name, Metadata *Type,
1163                                           StorageType Storage,
1164                                           bool ShouldCreate = true) {
1165     return getImpl(Context, Scope, getCanonicalMDString(Context, Name), Type,
1166                    Storage, ShouldCreate);
1167   }
1168   static MDTemplateTypeParameter *getImpl(LLVMContext &Context, Metadata *Scope,
1169                                           MDString *Name, Metadata *Type,
1170                                           StorageType Storage,
1171                                           bool ShouldCreate = true);
1172
1173   TempMDTemplateTypeParameter cloneImpl() const {
1174     return getTemporary(getContext(), getScope(), getName(), getType());
1175   }
1176
1177 public:
1178   DEFINE_MDNODE_GET(MDTemplateTypeParameter,
1179                     (Metadata * Scope, StringRef Name, Metadata *Type),
1180                     (Scope, Name, Type))
1181   DEFINE_MDNODE_GET(MDTemplateTypeParameter,
1182                     (Metadata * Scope, MDString *Name, Metadata *Type),
1183                     (Scope, Name, Type))
1184
1185   TempMDTemplateTypeParameter clone() const { return cloneImpl(); }
1186
1187   static bool classof(const Metadata *MD) {
1188     return MD->getMetadataID() == MDTemplateTypeParameterKind;
1189   }
1190 };
1191
1192 class MDTemplateValueParameter : public MDTemplateParameter {
1193   friend class LLVMContextImpl;
1194   friend class MDNode;
1195
1196   MDTemplateValueParameter(LLVMContext &Context, StorageType Storage,
1197                            unsigned Tag, ArrayRef<Metadata *> Ops)
1198       : MDTemplateParameter(Context, MDTemplateValueParameterKind, Storage, Tag,
1199                             Ops) {}
1200   ~MDTemplateValueParameter() {}
1201
1202   static MDTemplateValueParameter *getImpl(LLVMContext &Context, unsigned Tag,
1203                                            Metadata *Scope, StringRef Name,
1204                                            Metadata *Type, Metadata *Value,
1205                                            StorageType Storage,
1206                                            bool ShouldCreate = true) {
1207     return getImpl(Context, Tag, Scope, getCanonicalMDString(Context, Name),
1208                    Type, Value, Storage, ShouldCreate);
1209   }
1210   static MDTemplateValueParameter *getImpl(LLVMContext &Context, unsigned Tag,
1211                                            Metadata *Scope, MDString *Name,
1212                                            Metadata *Type, Metadata *Value,
1213                                            StorageType Storage,
1214                                            bool ShouldCreate = true);
1215
1216   TempMDTemplateValueParameter cloneImpl() const {
1217     return getTemporary(getContext(), getTag(), getScope(), getName(),
1218                         getType(), getValue());
1219   }
1220
1221 public:
1222   DEFINE_MDNODE_GET(MDTemplateValueParameter,
1223                     (unsigned Tag, Metadata *Scope, StringRef Name,
1224                      Metadata *Type, Metadata *Value),
1225                     (Tag, Scope, Name, Type, Value))
1226   DEFINE_MDNODE_GET(MDTemplateValueParameter,
1227                     (unsigned Tag, Metadata *Scope, MDString *Name,
1228                      Metadata *Type, Metadata *Value),
1229                     (Tag, Scope, Name, Type, Value))
1230
1231   TempMDTemplateValueParameter clone() const { return cloneImpl(); }
1232
1233   Metadata *getValue() const { return getOperand(3); }
1234
1235   static bool classof(const Metadata *MD) {
1236     return MD->getMetadataID() == MDTemplateValueParameterKind;
1237   }
1238 };
1239
1240 /// \brief Base class for variables.
1241 ///
1242 /// TODO: Hardcode to DW_TAG_variable.
1243 class MDVariable : public DebugNode {
1244   unsigned Line;
1245
1246 protected:
1247   MDVariable(LLVMContext &C, unsigned ID, StorageType Storage, unsigned Tag,
1248              unsigned Line, ArrayRef<Metadata *> Ops)
1249       : DebugNode(C, ID, Storage, Tag, Ops), Line(Line) {}
1250   ~MDVariable() {}
1251
1252 public:
1253   unsigned getLine() const { return Line; }
1254   Metadata *getScope() const { return getOperand(0); }
1255   StringRef getName() const { return getStringOperand(1); }
1256   Metadata *getFile() const { return getOperand(2); }
1257   Metadata *getType() const { return getOperand(3); }
1258
1259   MDString *getRawName() const { return getOperandAs<MDString>(1); }
1260
1261   static bool classof(const Metadata *MD) {
1262     return MD->getMetadataID() == MDLocalVariableKind ||
1263            MD->getMetadataID() == MDGlobalVariableKind;
1264   }
1265 };
1266
1267 /// \brief Global variables.
1268 ///
1269 /// TODO: Remove DisplayName.  It's always equal to Name.
1270 class MDGlobalVariable : public MDVariable {
1271   friend class LLVMContextImpl;
1272   friend class MDNode;
1273
1274   bool IsLocalToUnit;
1275   bool IsDefinition;
1276
1277   MDGlobalVariable(LLVMContext &C, StorageType Storage, unsigned Line,
1278                    bool IsLocalToUnit, bool IsDefinition,
1279                    ArrayRef<Metadata *> Ops)
1280       : MDVariable(C, MDGlobalVariableKind, Storage, dwarf::DW_TAG_variable,
1281                    Line, Ops),
1282         IsLocalToUnit(IsLocalToUnit), IsDefinition(IsDefinition) {}
1283   ~MDGlobalVariable() {}
1284
1285   static MDGlobalVariable *
1286   getImpl(LLVMContext &Context, Metadata *Scope, StringRef Name,
1287           StringRef LinkageName, Metadata *File, unsigned Line, Metadata *Type,
1288           bool IsLocalToUnit, bool IsDefinition, Metadata *Variable,
1289           Metadata *StaticDataMemberDeclaration, StorageType Storage,
1290           bool ShouldCreate = true) {
1291     return getImpl(Context, Scope, getCanonicalMDString(Context, Name),
1292                    getCanonicalMDString(Context, LinkageName), File, Line, Type,
1293                    IsLocalToUnit, IsDefinition, Variable,
1294                    StaticDataMemberDeclaration, Storage, ShouldCreate);
1295   }
1296   static MDGlobalVariable *
1297   getImpl(LLVMContext &Context, Metadata *Scope, MDString *Name,
1298           MDString *LinkageName, Metadata *File, unsigned Line, Metadata *Type,
1299           bool IsLocalToUnit, bool IsDefinition, Metadata *Variable,
1300           Metadata *StaticDataMemberDeclaration, StorageType Storage,
1301           bool ShouldCreate = true);
1302
1303   TempMDGlobalVariable cloneImpl() const {
1304     return getTemporary(getContext(), getScope(), getName(), getLinkageName(),
1305                         getFile(), getLine(), getType(), isLocalToUnit(),
1306                         isDefinition(), getVariable(),
1307                         getStaticDataMemberDeclaration());
1308   }
1309
1310 public:
1311   DEFINE_MDNODE_GET(MDGlobalVariable,
1312                     (Metadata * Scope, StringRef Name, StringRef LinkageName,
1313                      Metadata *File, unsigned Line, Metadata *Type,
1314                      bool IsLocalToUnit, bool IsDefinition, Metadata *Variable,
1315                      Metadata *StaticDataMemberDeclaration),
1316                     (Scope, Name, LinkageName, File, Line, Type, IsLocalToUnit,
1317                      IsDefinition, Variable, StaticDataMemberDeclaration))
1318   DEFINE_MDNODE_GET(MDGlobalVariable,
1319                     (Metadata * Scope, MDString *Name, MDString *LinkageName,
1320                      Metadata *File, unsigned Line, Metadata *Type,
1321                      bool IsLocalToUnit, bool IsDefinition, Metadata *Variable,
1322                      Metadata *StaticDataMemberDeclaration),
1323                     (Scope, Name, LinkageName, File, Line, Type, IsLocalToUnit,
1324                      IsDefinition, Variable, StaticDataMemberDeclaration))
1325
1326   TempMDGlobalVariable clone() const { return cloneImpl(); }
1327
1328   bool isLocalToUnit() const { return IsLocalToUnit; }
1329   bool isDefinition() const { return IsDefinition; }
1330   StringRef getDisplayName() const { return getStringOperand(4); }
1331   StringRef getLinkageName() const { return getStringOperand(5); }
1332   Metadata *getVariable() const { return getOperand(6); }
1333   Metadata *getStaticDataMemberDeclaration() const { return getOperand(7); }
1334
1335   MDString *getRawLinkageName() const { return getOperandAs<MDString>(5); }
1336
1337   static bool classof(const Metadata *MD) {
1338     return MD->getMetadataID() == MDGlobalVariableKind;
1339   }
1340 };
1341
1342 /// \brief Local variable.
1343 ///
1344 /// TODO: Split between arguments and otherwise.
1345 /// TODO: Use \c DW_TAG_variable instead of fake tags.
1346 /// TODO: Split up flags.
1347 class MDLocalVariable : public MDVariable {
1348   friend class LLVMContextImpl;
1349   friend class MDNode;
1350
1351   unsigned Arg;
1352   unsigned Flags;
1353
1354   MDLocalVariable(LLVMContext &C, StorageType Storage, unsigned Tag,
1355                   unsigned Line, unsigned Arg, unsigned Flags,
1356                   ArrayRef<Metadata *> Ops)
1357       : MDVariable(C, MDLocalVariableKind, Storage, Tag, Line, Ops), Arg(Arg),
1358         Flags(Flags) {}
1359   ~MDLocalVariable() {}
1360
1361   static MDLocalVariable *getImpl(LLVMContext &Context, unsigned Tag,
1362                                   Metadata *Scope, StringRef Name,
1363                                   Metadata *File, unsigned Line, Metadata *Type,
1364                                   unsigned Arg, unsigned Flags,
1365                                   Metadata *InlinedAt, StorageType Storage,
1366                                   bool ShouldCreate = true) {
1367     return getImpl(Context, Tag, Scope, getCanonicalMDString(Context, Name),
1368                    File, Line, Type, Arg, Flags, InlinedAt, Storage,
1369                    ShouldCreate);
1370   }
1371   static MDLocalVariable *getImpl(LLVMContext &Context, unsigned Tag,
1372                                   Metadata *Scope, MDString *Name,
1373                                   Metadata *File, unsigned Line, Metadata *Type,
1374                                   unsigned Arg, unsigned Flags,
1375                                   Metadata *InlinedAt, StorageType Storage,
1376                                   bool ShouldCreate = true);
1377
1378   TempMDLocalVariable cloneImpl() const {
1379     return getTemporary(getContext(), getTag(), getScope(), getName(),
1380                         getFile(), getLine(), getType(), getArg(), getFlags(),
1381                         getInlinedAt());
1382   }
1383
1384 public:
1385   DEFINE_MDNODE_GET(MDLocalVariable,
1386                     (unsigned Tag, Metadata *Scope, StringRef Name,
1387                      Metadata *File, unsigned Line, Metadata *Type,
1388                      unsigned Arg, unsigned Flags,
1389                      Metadata *InlinedAt = nullptr),
1390                     (Tag, Scope, Name, File, Line, Type, Arg, Flags, InlinedAt))
1391   DEFINE_MDNODE_GET(MDLocalVariable,
1392                     (unsigned Tag, Metadata *Scope, MDString *Name,
1393                      Metadata *File, unsigned Line, Metadata *Type,
1394                      unsigned Arg, unsigned Flags,
1395                      Metadata *InlinedAt = nullptr),
1396                     (Tag, Scope, Name, File, Line, Type, Arg, Flags, InlinedAt))
1397
1398   TempMDLocalVariable clone() const { return cloneImpl(); }
1399
1400   unsigned getArg() const { return Arg; }
1401   unsigned getFlags() const { return Flags; }
1402   Metadata *getInlinedAt() const { return getOperand(4); }
1403
1404   static bool classof(const Metadata *MD) {
1405     return MD->getMetadataID() == MDLocalVariableKind;
1406   }
1407 };
1408
1409 /// \brief DWARF expression.
1410 ///
1411 /// TODO: Co-allocate the expression elements.
1412 /// TODO: Drop fake DW_TAG_expression and separate from DebugNode.
1413 /// TODO: Separate from MDNode, or otherwise drop Distinct and Temporary
1414 /// storage types.
1415 class MDExpression : public DebugNode {
1416   friend class LLVMContextImpl;
1417   friend class MDNode;
1418
1419   std::vector<uint64_t> Elements;
1420
1421   MDExpression(LLVMContext &C, StorageType Storage, ArrayRef<uint64_t> Elements)
1422       : DebugNode(C, MDExpressionKind, Storage, dwarf::DW_TAG_expression, None),
1423         Elements(Elements.begin(), Elements.end()) {}
1424   ~MDExpression() {}
1425
1426   static MDExpression *getImpl(LLVMContext &Context,
1427                                ArrayRef<uint64_t> Elements, StorageType Storage,
1428                                bool ShouldCreate = true);
1429
1430   TempMDExpression cloneImpl() const {
1431     return getTemporary(getContext(), getElements());
1432   }
1433
1434 public:
1435   DEFINE_MDNODE_GET(MDExpression, (ArrayRef<uint64_t> Elements), (Elements))
1436
1437   TempMDExpression clone() const { return cloneImpl(); }
1438
1439   ArrayRef<uint64_t> getElements() const { return Elements; }
1440
1441   unsigned getNumElements() const { return Elements.size(); }
1442   uint64_t getElement(unsigned I) const {
1443     assert(I < Elements.size() && "Index out of range");
1444     return Elements[I];
1445   }
1446
1447   typedef ArrayRef<uint64_t>::iterator element_iterator;
1448   element_iterator elements_begin() const { return getElements().begin(); }
1449   element_iterator elements_end() const { return getElements().end(); }
1450
1451   /// \brief A lightweight wrapper around an expression operand.
1452   ///
1453   /// TODO: Store arguments directly and change \a MDExpression to store a
1454   /// range of these.
1455   class ExprOperand {
1456     const uint64_t *Op;
1457
1458   public:
1459     explicit ExprOperand(const uint64_t *Op) : Op(Op) {}
1460
1461     const uint64_t *get() const { return Op; }
1462
1463     /// \brief Get the operand code.
1464     uint64_t getOp() const { return *Op; }
1465
1466     /// \brief Get an argument to the operand.
1467     ///
1468     /// Never returns the operand itself.
1469     uint64_t getArg(unsigned I) const { return Op[I + 1]; }
1470
1471     unsigned getNumArgs() const { return getSize() - 1; }
1472
1473     /// \brief Return the size of the operand.
1474     ///
1475     /// Return the number of elements in the operand (1 + args).
1476     unsigned getSize() const;
1477   };
1478
1479   /// \brief An iterator for expression operands.
1480   class expr_op_iterator
1481       : public std::iterator<std::input_iterator_tag, ExprOperand> {
1482     ExprOperand Op;
1483
1484   public:
1485     explicit expr_op_iterator(element_iterator I) : Op(I) {}
1486
1487     element_iterator getBase() const { return Op.get(); }
1488     const ExprOperand &operator*() const { return Op; }
1489     const ExprOperand *operator->() const { return &Op; }
1490
1491     expr_op_iterator &operator++() {
1492       increment();
1493       return *this;
1494     }
1495     expr_op_iterator operator++(int) {
1496       expr_op_iterator T(*this);
1497       increment();
1498       return T;
1499     }
1500
1501     bool operator==(const expr_op_iterator &X) const {
1502       return getBase() == X.getBase();
1503     }
1504     bool operator!=(const expr_op_iterator &X) const {
1505       return getBase() != X.getBase();
1506     }
1507
1508   private:
1509     void increment() { Op = ExprOperand(getBase() + Op.getSize()); }
1510   };
1511
1512   /// \brief Visit the elements via ExprOperand wrappers.
1513   ///
1514   /// These range iterators visit elements through \a ExprOperand wrappers.
1515   /// This is not guaranteed to be a valid range unless \a isValid() gives \c
1516   /// true.
1517   ///
1518   /// \pre \a isValid() gives \c true.
1519   /// @{
1520   expr_op_iterator expr_op_begin() const {
1521     return expr_op_iterator(elements_begin());
1522   }
1523   expr_op_iterator expr_op_end() const {
1524     return expr_op_iterator(elements_end());
1525   }
1526   /// @}
1527
1528   bool isValid() const;
1529
1530   static bool classof(const Metadata *MD) {
1531     return MD->getMetadataID() == MDExpressionKind;
1532   }
1533 };
1534
1535 class MDObjCProperty : public DebugNode {
1536   friend class LLVMContextImpl;
1537   friend class MDNode;
1538
1539   unsigned Line;
1540   unsigned Attributes;
1541
1542   MDObjCProperty(LLVMContext &C, StorageType Storage, unsigned Line,
1543                  unsigned Attributes, ArrayRef<Metadata *> Ops)
1544       : DebugNode(C, MDObjCPropertyKind, Storage, dwarf::DW_TAG_APPLE_property,
1545                   Ops),
1546         Line(Line), Attributes(Attributes) {}
1547   ~MDObjCProperty() {}
1548
1549   static MDObjCProperty *
1550   getImpl(LLVMContext &Context, StringRef Name, Metadata *File, unsigned Line,
1551           StringRef GetterName, StringRef SetterName, unsigned Attributes,
1552           Metadata *Type, StorageType Storage, bool ShouldCreate = true) {
1553     return getImpl(Context, getCanonicalMDString(Context, Name), File, Line,
1554                    getCanonicalMDString(Context, GetterName),
1555                    getCanonicalMDString(Context, SetterName), Attributes, Type,
1556                    Storage, ShouldCreate);
1557   }
1558   static MDObjCProperty *getImpl(LLVMContext &Context, MDString *Name,
1559                                  Metadata *File, unsigned Line,
1560                                  MDString *GetterName, MDString *SetterName,
1561                                  unsigned Attributes, Metadata *Type,
1562                                  StorageType Storage, bool ShouldCreate = true);
1563
1564   TempMDObjCProperty cloneImpl() const {
1565     return getTemporary(getContext(), getName(), getFile(), getLine(),
1566                         getGetterName(), getSetterName(), getAttributes(),
1567                         getType());
1568   }
1569
1570 public:
1571   DEFINE_MDNODE_GET(MDObjCProperty,
1572                     (StringRef Name, Metadata *File, unsigned Line,
1573                      StringRef GetterName, StringRef SetterName,
1574                      unsigned Attributes, Metadata *Type),
1575                     (Name, File, Line, GetterName, SetterName, Attributes,
1576                      Type))
1577   DEFINE_MDNODE_GET(MDObjCProperty,
1578                     (MDString * Name, Metadata *File, unsigned Line,
1579                      MDString *GetterName, MDString *SetterName,
1580                      unsigned Attributes, Metadata *Type),
1581                     (Name, File, Line, GetterName, SetterName, Attributes,
1582                      Type))
1583
1584   TempMDObjCProperty clone() const { return cloneImpl(); }
1585
1586   unsigned getLine() const { return Line; }
1587   unsigned getAttributes() const { return Attributes; }
1588   StringRef getName() const { return getStringOperand(0); }
1589   Metadata *getFile() const { return getOperand(1); }
1590   StringRef getGetterName() const { return getStringOperand(2); }
1591   StringRef getSetterName() const { return getStringOperand(3); }
1592   Metadata *getType() const { return getOperand(4); }
1593
1594   MDString *getRawName() const { return getOperandAs<MDString>(0); }
1595   MDString *getRawGetterName() const { return getOperandAs<MDString>(2); }
1596   MDString *getRawSetterName() const { return getOperandAs<MDString>(3); }
1597
1598   static bool classof(const Metadata *MD) {
1599     return MD->getMetadataID() == MDObjCPropertyKind;
1600   }
1601 };
1602
1603 class MDImportedEntity : public DebugNode {
1604   friend class LLVMContextImpl;
1605   friend class MDNode;
1606
1607   unsigned Line;
1608
1609   MDImportedEntity(LLVMContext &C, StorageType Storage, unsigned Tag,
1610                    unsigned Line, ArrayRef<Metadata *> Ops)
1611       : DebugNode(C, MDImportedEntityKind, Storage, Tag, Ops), Line(Line) {}
1612   ~MDImportedEntity() {}
1613
1614   static MDImportedEntity *getImpl(LLVMContext &Context, unsigned Tag,
1615                                    Metadata *Scope, Metadata *Entity,
1616                                    unsigned Line, StringRef Name,
1617                                    StorageType Storage,
1618                                    bool ShouldCreate = true) {
1619     return getImpl(Context, Tag, Scope, Entity, Line,
1620                    getCanonicalMDString(Context, Name), Storage, ShouldCreate);
1621   }
1622   static MDImportedEntity *getImpl(LLVMContext &Context, unsigned Tag,
1623                                    Metadata *Scope, Metadata *Entity,
1624                                    unsigned Line, MDString *Name,
1625                                    StorageType Storage,
1626                                    bool ShouldCreate = true);
1627
1628   TempMDImportedEntity cloneImpl() const {
1629     return getTemporary(getContext(), getTag(), getScope(), getEntity(),
1630                         getLine(), getName());
1631   }
1632
1633 public:
1634   DEFINE_MDNODE_GET(MDImportedEntity,
1635                     (unsigned Tag, Metadata *Scope, Metadata *Entity,
1636                      unsigned Line, StringRef Name = ""),
1637                     (Tag, Scope, Entity, Line, Name))
1638   DEFINE_MDNODE_GET(MDImportedEntity,
1639                     (unsigned Tag, Metadata *Scope, Metadata *Entity,
1640                      unsigned Line, MDString *Name),
1641                     (Tag, Scope, Entity, Line, Name))
1642
1643   TempMDImportedEntity clone() const { return cloneImpl(); }
1644
1645   unsigned getLine() const { return Line; }
1646   Metadata *getScope() const { return getOperand(0); }
1647   Metadata *getEntity() const { return getOperand(1); }
1648   StringRef getName() const { return getStringOperand(2); }
1649
1650   MDString *getRawName() const { return getOperandAs<MDString>(2); }
1651
1652   static bool classof(const Metadata *MD) {
1653     return MD->getMetadataID() == MDImportedEntityKind;
1654   }
1655 };
1656
1657 } // end namespace llvm
1658
1659 #undef DEFINE_MDNODE_GET_UNPACK_IMPL
1660 #undef DEFINE_MDNODE_GET_UNPACK
1661 #undef DEFINE_MDNODE_GET
1662
1663 #endif