1 //===- llvm/IR/DebugInfoMetadata.h - Debug info metadata --------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // Declarations for metadata specific to debug info.
12 //===----------------------------------------------------------------------===//
14 #ifndef LLVM_IR_DEBUGINFOMETADATA_H
15 #define LLVM_IR_DEBUGINFOMETADATA_H
17 #include "llvm/IR/Metadata.h"
18 #include "llvm/Support/Dwarf.h"
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); \
28 static Temp##CLASS getTemporary(LLVMContext &Context, \
29 DEFINE_MDNODE_GET_UNPACK(FORMAL)) { \
31 getImpl(Context, DEFINE_MDNODE_GET_UNPACK(ARGS), Temporary)); \
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); \
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); \
42 DEFINE_MDNODE_GET_DISTINCT_TEMPORARY(CLASS, FORMAL, ARGS)
46 /// \brief Pointer union between a subclass of DINode and MDString.
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;
55 TypedDINodeRef() = default;
56 TypedDINodeRef(std::nullptr_t) {}
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");
65 const TypedDINodeRef<U> &X,
66 typename std::enable_if<std::is_convertible<U *, T *>::value>::type * =
70 operator Metadata *() const { return const_cast<Metadata *>(MD); }
72 bool operator==(const TypedDINodeRef<T> &X) const { return MD == X.MD; }
73 bool operator!=(const TypedDINodeRef<T> &X) const { return MD != X.MD; }
75 /// \brief Create a reference.
77 /// Get a reference to \c N, using an \a MDString reference if available.
78 static TypedDINodeRef get(const T *N);
80 template <class MapTy> T *resolve(const MapTy &Map) const {
84 if (auto *Typed = dyn_cast<T>(MD))
85 return const_cast<T *>(Typed);
87 auto *S = cast<MDString>(MD);
89 assert(I != Map.end() && "Missing identifier in type map");
90 return cast<T>(I->second);
94 typedef TypedDINodeRef<DINode> DINodeRef;
95 typedef TypedDINodeRef<DIScope> DIScopeRef;
96 typedef TypedDINodeRef<DIType> DITypeRef;
98 class DITypeRefArray {
99 const MDTuple *N = nullptr;
102 DITypeRefArray() = default;
103 DITypeRefArray(const MDTuple *N) : N(N) {}
105 explicit operator bool() const { return get(); }
106 explicit operator MDTuple *() const { return get(); }
108 MDTuple *get() const { return const_cast<MDTuple *>(N); }
109 MDTuple *operator->() const { return get(); }
110 MDTuple &operator*() const { return *get(); }
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)); }
116 class iterator : std::iterator<std::input_iterator_tag, DITypeRef,
117 std::ptrdiff_t, void, DITypeRef> {
118 MDNode::op_iterator I = nullptr;
121 iterator() = default;
122 explicit iterator(MDNode::op_iterator I) : I(I) {}
123 DITypeRef operator*() const { return DITypeRef(*I); }
124 iterator &operator++() {
128 iterator operator++(int) {
129 iterator Temp(*this);
133 bool operator==(const iterator &X) const { return I == X.I; }
134 bool operator!=(const iterator &X) const { return I != X.I; }
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(); }
142 /// \brief Tagged DWARF-like metadata node.
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;
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;
160 template <class Ty> Ty *getOperandAs(unsigned I) const {
161 return cast_or_null<Ty>(getOperand(I));
164 StringRef getStringOperand(unsigned I) const {
165 if (auto *S = getOperandAs<MDString>(I))
166 return S->getString();
170 static MDString *getCanonicalMDString(LLVMContext &Context, StringRef S) {
173 return MDString::get(Context, S);
177 unsigned getTag() const { return SubclassData16; }
179 /// \brief Debug info flags.
181 /// The three accessibility flags are mutually exclusive and rolled together
182 /// in the first two bits.
184 #define HANDLE_DI_FLAG(ID, NAME) Flag##NAME = ID,
185 #include "llvm/IR/DebugInfoFlags.def"
186 FlagAccessibility = FlagPrivate | FlagProtected | FlagPublic
189 static unsigned getFlag(StringRef Flag);
190 static const char *getFlagString(unsigned Flag);
192 /// \brief Split up a flags bitfield.
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);
199 DINodeRef getRef() const { return DINodeRef::get(this); }
201 static bool classof(const Metadata *MD) {
202 switch (MD->getMetadataID()) {
205 case GenericDINodeKind:
207 case DIEnumeratorKind:
208 case DIBasicTypeKind:
209 case DIDerivedTypeKind:
210 case DICompositeTypeKind:
211 case DISubroutineTypeKind:
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:
230 template <class T> struct simplify_type<const TypedDINodeRef<T>> {
231 typedef Metadata *SimpleType;
232 static SimpleType getSimplifiedValue(const TypedDINodeRef<T> &MD) {
238 struct simplify_type<TypedDINodeRef<T>>
239 : simplify_type<const TypedDINodeRef<T>> {};
241 /// \brief Generic tagged DWARF-like metadata node.
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;
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) {
257 ~GenericDINode() { dropAllReferences(); }
259 void setHash(unsigned Hash) { SubclassData32 = Hash; }
260 void recalculateHash();
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);
269 static GenericDINode *getImpl(LLVMContext &Context, unsigned Tag,
270 MDString *Header, ArrayRef<Metadata *> DwarfOps,
271 StorageType Storage, bool ShouldCreate = true);
273 TempGenericDINode cloneImpl() const {
275 getContext(), getTag(), getHeader(),
276 SmallVector<Metadata *, 4>(dwarf_op_begin(), dwarf_op_end()));
280 unsigned getHash() const { return SubclassData32; }
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))
289 /// \brief Return a (temporary) clone of this.
290 TempGenericDINode clone() const { return cloneImpl(); }
292 unsigned getTag() const { return SubclassData16; }
293 StringRef getHeader() const { return getStringOperand(0); }
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());
301 unsigned getNumDwarfOperands() const { return getNumOperands() - 1; }
302 const MDOperand &getDwarfOperand(unsigned I) const {
303 return getOperand(I + 1);
305 void replaceDwarfOperandWith(unsigned I, Metadata *New) {
306 replaceOperandWith(I + 1, New);
309 static bool classof(const Metadata *MD) {
310 return MD->getMetadataID() == GenericDINodeKind;
314 /// \brief Array subrange.
316 /// TODO: Merge into node for DW_TAG_array_type, which should have a custom
318 class DISubrange : public DINode {
319 friend class LLVMContextImpl;
325 DISubrange(LLVMContext &C, StorageType Storage, int64_t Count,
327 : DINode(C, DISubrangeKind, Storage, dwarf::DW_TAG_subrange_type, None),
328 Count(Count), LowerBound(LowerBound) {}
329 ~DISubrange() = default;
331 static DISubrange *getImpl(LLVMContext &Context, int64_t Count,
332 int64_t LowerBound, StorageType Storage,
333 bool ShouldCreate = true);
335 TempDISubrange cloneImpl() const {
336 return getTemporary(getContext(), getCount(), getLowerBound());
340 DEFINE_MDNODE_GET(DISubrange, (int64_t Count, int64_t LowerBound = 0),
343 TempDISubrange clone() const { return cloneImpl(); }
345 int64_t getLowerBound() const { return LowerBound; }
346 int64_t getCount() const { return Count; }
348 static bool classof(const Metadata *MD) {
349 return MD->getMetadataID() == DISubrangeKind;
353 /// \brief Enumeration value.
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;
363 DIEnumerator(LLVMContext &C, StorageType Storage, int64_t Value,
364 ArrayRef<Metadata *> Ops)
365 : DINode(C, DIEnumeratorKind, Storage, dwarf::DW_TAG_enumerator, Ops),
367 ~DIEnumerator() = default;
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,
375 static DIEnumerator *getImpl(LLVMContext &Context, int64_t Value,
376 MDString *Name, StorageType Storage,
377 bool ShouldCreate = true);
379 TempDIEnumerator cloneImpl() const {
380 return getTemporary(getContext(), getValue(), getName());
384 DEFINE_MDNODE_GET(DIEnumerator, (int64_t Value, StringRef Name),
386 DEFINE_MDNODE_GET(DIEnumerator, (int64_t Value, MDString *Name),
389 TempDIEnumerator clone() const { return cloneImpl(); }
391 int64_t getValue() const { return Value; }
392 StringRef getName() const { return getStringOperand(0); }
394 MDString *getRawName() const { return getOperandAs<MDString>(0); }
396 static bool classof(const Metadata *MD) {
397 return MD->getMetadataID() == DIEnumeratorKind;
401 /// \brief Base class for scope-like contexts.
403 /// Base class for lexical scopes and types (which are also declaration
406 /// TODO: Separate the concepts of declaration contexts and lexical scopes.
407 class DIScope : public DINode {
409 DIScope(LLVMContext &C, unsigned ID, StorageType Storage, unsigned Tag,
410 ArrayRef<Metadata *> Ops)
411 : DINode(C, ID, Storage, Tag, Ops) {}
412 ~DIScope() = default;
415 DIFile *getFile() const { return cast_or_null<DIFile>(getRawFile()); }
417 inline StringRef getFilename() const;
418 inline StringRef getDirectory() const;
420 StringRef getName() const;
421 DIScopeRef getScope() const;
423 /// \brief Return the raw underlying file.
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));
434 DIScopeRef getRef() const { return DIScopeRef::get(this); }
436 static bool classof(const Metadata *MD) {
437 switch (MD->getMetadataID()) {
440 case DIBasicTypeKind:
441 case DIDerivedTypeKind:
442 case DICompositeTypeKind:
443 case DISubroutineTypeKind:
445 case DICompileUnitKind:
446 case DISubprogramKind:
447 case DILexicalBlockKind:
448 case DILexicalBlockFileKind:
449 case DINamespaceKind:
458 /// TODO: Merge with directory/file node (including users).
459 /// TODO: Canonicalize paths on creation.
460 class DIFile : public DIScope {
461 friend class LLVMContextImpl;
464 DIFile(LLVMContext &C, StorageType Storage, ArrayRef<Metadata *> Ops)
465 : DIScope(C, DIFileKind, Storage, dwarf::DW_TAG_file_type, Ops) {}
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,
475 static DIFile *getImpl(LLVMContext &Context, MDString *Filename,
476 MDString *Directory, StorageType Storage,
477 bool ShouldCreate = true);
479 TempDIFile cloneImpl() const {
480 return getTemporary(getContext(), getFilename(), getDirectory());
484 DEFINE_MDNODE_GET(DIFile, (StringRef Filename, StringRef Directory),
485 (Filename, Directory))
486 DEFINE_MDNODE_GET(DIFile, (MDString * Filename, MDString *Directory),
487 (Filename, Directory))
489 TempDIFile clone() const { return cloneImpl(); }
491 StringRef getFilename() const { return getStringOperand(0); }
492 StringRef getDirectory() const { return getStringOperand(1); }
494 MDString *getRawFilename() const { return getOperandAs<MDString>(0); }
495 MDString *getRawDirectory() const { return getOperandAs<MDString>(1); }
497 static bool classof(const Metadata *MD) {
498 return MD->getMetadataID() == DIFileKind;
502 StringRef DIScope::getFilename() const {
503 if (auto *F = getFile())
504 return F->getFilename();
508 StringRef DIScope::getDirectory() const {
509 if (auto *F = getFile())
510 return F->getDirectory();
514 /// \brief Base class for types.
516 /// TODO: Remove the hardcoded name and context, since many types don't use
518 /// TODO: Split up flags.
519 class DIType : public DIScope {
523 uint64_t AlignInBits;
524 uint64_t OffsetInBits;
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) {}
536 TempDIType clone() const {
537 return TempDIType(cast<DIType>(MDNode::clone().release()));
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; }
546 DIScopeRef getScope() const { return DIScopeRef(getRawScope()); }
547 StringRef getName() const { return getStringOperand(2); }
550 Metadata *getRawScope() const { return getOperand(1); }
551 MDString *getRawName() const { return getOperandAs<MDString>(2); }
553 void setFlags(unsigned NewFlags) {
554 assert(!isUniqued() && "Cannot set flags on uniqued nodes");
558 bool isPrivate() const {
559 return (getFlags() & FlagAccessibility) == FlagPrivate;
561 bool isProtected() const {
562 return (getFlags() & FlagAccessibility) == FlagProtected;
564 bool isPublic() const {
565 return (getFlags() & FlagAccessibility) == FlagPublic;
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;
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; }
582 DITypeRef getRef() const { return DITypeRef::get(this); }
584 static bool classof(const Metadata *MD) {
585 switch (MD->getMetadataID()) {
588 case DIBasicTypeKind:
589 case DIDerivedTypeKind:
590 case DICompositeTypeKind:
591 case DISubroutineTypeKind:
597 /// \brief Basic type, like 'int' or 'float'.
599 /// TODO: Split out DW_TAG_unspecified_type.
600 /// TODO: Drop unused accessors.
601 class DIBasicType : public DIType {
602 friend class LLVMContextImpl;
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,
612 Encoding(Encoding) {}
613 ~DIBasicType() = default;
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);
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);
627 TempDIBasicType cloneImpl() const {
628 return getTemporary(getContext(), getTag(), getName(), getSizeInBits(),
629 getAlignInBits(), getEncoding());
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))
644 TempDIBasicType clone() const { return cloneImpl(); }
646 unsigned getEncoding() const { return Encoding; }
648 static bool classof(const Metadata *MD) {
649 return MD->getMetadataID() == DIBasicTypeKind;
653 /// \brief Derived types.
655 /// This includes qualified types, pointers, references, friends, typedefs, and
658 /// TODO: Split out members (inheritance, fields, methods, etc.).
659 class DIDerivedType : public DIType {
660 friend class LLVMContextImpl;
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;
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);
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);
689 TempDIDerivedType cloneImpl() const {
690 return getTemporary(getContext(), getTag(), getName(), getFile(), getLine(),
691 getScope(), getBaseType(), getSizeInBits(),
692 getAlignInBits(), getOffsetInBits(), getFlags(),
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))
713 TempDIDerivedType clone() const { return cloneImpl(); }
715 //// Get the base type this is derived from.
716 DITypeRef getBaseType() const { return DITypeRef(getRawBaseType()); }
717 Metadata *getRawBaseType() const { return getOperand(3); }
719 /// \brief Get extra data associated with this derived type.
721 /// Class type for pointer-to-members, objective-c property node for ivars,
722 /// or global constant wrapper for static members.
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); }
729 /// \brief Get casted version of extra data.
731 DITypeRef getClassType() const {
732 assert(getTag() == dwarf::DW_TAG_ptr_to_member_type);
733 return DITypeRef(getExtraData());
735 DIObjCProperty *getObjCProperty() const {
736 return dyn_cast_or_null<DIObjCProperty>(getExtraData());
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();
746 static bool classof(const Metadata *MD) {
747 return MD->getMetadataID() == DIDerivedTypeKind;
751 /// \brief Composite types.
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;
759 unsigned RuntimeLang;
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;
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) {
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);
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);
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());
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))
823 TempDICompositeType clone() const { return cloneImpl(); }
825 DITypeRef getBaseType() const { return DITypeRef(getRawBaseType()); }
826 DINodeArray getElements() const {
827 return cast_or_null<MDTuple>(getRawElements());
829 DITypeRef getVTableHolder() const { return DITypeRef(getRawVTableHolder()); }
830 DITemplateParameterArray getTemplateParams() const {
831 return cast_or_null<MDTuple>(getRawTemplateParams());
833 StringRef getIdentifier() const { return getStringOperand(7); }
834 unsigned getRuntimeLang() const { return RuntimeLang; }
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); }
842 /// \brief Replace operands.
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.
848 void replaceElements(DINodeArray Elements) {
850 for (DINode *Op : getElements())
851 assert(std::find(Elements->op_begin(), Elements->op_end(), Op) &&
852 "Lost a member during member list replacement");
854 replaceOperandWith(4, Elements.get());
856 void replaceVTableHolder(DITypeRef VTableHolder) {
857 replaceOperandWith(5, VTableHolder);
859 void replaceTemplateParams(DITemplateParameterArray TemplateParams) {
860 replaceOperandWith(6, TemplateParams.get());
864 static bool classof(const Metadata *MD) {
865 return MD->getMetadataID() == DICompositeTypeKind;
869 template <class T> TypedDINodeRef<T> TypedDINodeRef<T>::get(const T *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);
877 /// \brief Type array for a subprogram.
879 /// TODO: Fold the array of types in directly as operands.
880 class DISubroutineType : public DIType {
881 friend class LLVMContextImpl;
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;
890 static DISubroutineType *getImpl(LLVMContext &Context, unsigned Flags,
891 DITypeRefArray TypeArray,
893 bool ShouldCreate = true) {
894 return getImpl(Context, Flags, TypeArray.get(), Storage, ShouldCreate);
896 static DISubroutineType *getImpl(LLVMContext &Context, unsigned Flags,
897 Metadata *TypeArray, StorageType Storage,
898 bool ShouldCreate = true);
900 TempDISubroutineType cloneImpl() const {
901 return getTemporary(getContext(), getFlags(), getTypeArray());
905 DEFINE_MDNODE_GET(DISubroutineType,
906 (unsigned Flags, DITypeRefArray TypeArray),
908 DEFINE_MDNODE_GET(DISubroutineType, (unsigned Flags, Metadata *TypeArray),
911 TempDISubroutineType clone() const { return cloneImpl(); }
913 DITypeRefArray getTypeArray() const {
914 return cast_or_null<MDTuple>(getRawTypeArray());
916 Metadata *getRawTypeArray() const { return getOperand(3); }
918 static bool classof(const Metadata *MD) {
919 return MD->getMetadataID() == DISubroutineTypeKind;
923 /// \brief Compile unit.
924 class DICompileUnit : public DIScope {
925 friend class LLVMContextImpl;
928 unsigned SourceLanguage;
930 unsigned RuntimeVersion;
931 unsigned EmissionKind;
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),
941 assert(Storage != Uniqued);
943 ~DICompileUnit() = default;
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);
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);
971 TempDICompileUnit cloneImpl() const {
973 getContext(), getSourceLanguage(), getFile(), getProducer(),
974 isOptimized(), getFlags(), getRuntimeVersion(), getSplitDebugFilename(),
975 getEmissionKind(), getEnumTypes(), getRetainedTypes(), getSubprograms(),
976 getGlobalVariables(), getImportedEntities(), DWOId);
979 static void get() = delete;
980 static void getIfExists() = delete;
983 DEFINE_MDNODE_GET_DISTINCT_TEMPORARY(
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(
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))
1005 TempDICompileUnit clone() const { return cloneImpl(); }
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());
1017 DITypeArray getRetainedTypes() const {
1018 return cast_or_null<MDTuple>(getRawRetainedTypes());
1020 DISubprogramArray getSubprograms() const {
1021 return cast_or_null<MDTuple>(getRawSubprograms());
1023 DIGlobalVariableArray getGlobalVariables() const {
1024 return cast_or_null<MDTuple>(getRawGlobalVariables());
1026 DIImportedEntityArray getImportedEntities() const {
1027 return cast_or_null<MDTuple>(getRawImportedEntities());
1029 uint64_t getDWOId() const { return DWOId; }
1030 void setDWOId(uint64_t DwoId) { DWOId = DwoId; }
1032 MDString *getRawProducer() const { return getOperandAs<MDString>(1); }
1033 MDString *getRawFlags() const { return getOperandAs<MDString>(2); }
1034 MDString *getRawSplitDebugFilename() const {
1035 return getOperandAs<MDString>(3);
1037 Metadata *getRawEnumTypes() const { return getOperand(4); }
1038 Metadata *getRawRetainedTypes() const { return getOperand(5); }
1039 Metadata *getRawSubprograms() const { return getOperand(6); }
1040 Metadata *getRawGlobalVariables() const { return getOperand(7); }
1041 Metadata *getRawImportedEntities() const { return getOperand(8); }
1043 /// \brief Replace arrays.
1045 /// If this \a isUniqued() and not \a isResolved(), it will be RAUW'ed and
1046 /// deleted on a uniquing collision. In practice, uniquing collisions on \a
1047 /// DICompileUnit should be fairly rare.
1049 void replaceEnumTypes(DICompositeTypeArray N) {
1050 replaceOperandWith(4, N.get());
1052 void replaceRetainedTypes(DITypeArray N) {
1053 replaceOperandWith(5, N.get());
1055 void replaceSubprograms(DISubprogramArray N) {
1056 replaceOperandWith(6, N.get());
1058 void replaceGlobalVariables(DIGlobalVariableArray N) {
1059 replaceOperandWith(7, N.get());
1061 void replaceImportedEntities(DIImportedEntityArray N) {
1062 replaceOperandWith(8, N.get());
1066 static bool classof(const Metadata *MD) {
1067 return MD->getMetadataID() == DICompileUnitKind;
1071 /// \brief A scope for locals.
1073 /// A legal scope for lexical blocks, local variables, and debug info
1074 /// locations. Subclasses are \a DISubprogram, \a DILexicalBlock, and \a
1075 /// DILexicalBlockFile.
1076 class DILocalScope : public DIScope {
1078 DILocalScope(LLVMContext &C, unsigned ID, StorageType Storage, unsigned Tag,
1079 ArrayRef<Metadata *> Ops)
1080 : DIScope(C, ID, Storage, Tag, Ops) {}
1081 ~DILocalScope() = default;
1084 /// \brief Get the subprogram for this scope.
1086 /// Return this if it's an \a DISubprogram; otherwise, look up the scope
1088 DISubprogram *getSubprogram() const;
1090 static bool classof(const Metadata *MD) {
1091 return MD->getMetadataID() == DISubprogramKind ||
1092 MD->getMetadataID() == DILexicalBlockKind ||
1093 MD->getMetadataID() == DILexicalBlockFileKind;
1097 /// \brief Debug location.
1099 /// A debug location in source code, used for debug info and otherwise.
1100 class DILocation : public MDNode {
1101 friend class LLVMContextImpl;
1102 friend class MDNode;
1104 DILocation(LLVMContext &C, StorageType Storage, unsigned Line,
1105 unsigned Column, ArrayRef<Metadata *> MDs);
1106 ~DILocation() { dropAllReferences(); }
1108 static DILocation *getImpl(LLVMContext &Context, unsigned Line,
1109 unsigned Column, Metadata *Scope,
1110 Metadata *InlinedAt, StorageType Storage,
1111 bool ShouldCreate = true);
1112 static DILocation *getImpl(LLVMContext &Context, unsigned Line,
1113 unsigned Column, DILocalScope *Scope,
1114 DILocation *InlinedAt, StorageType Storage,
1115 bool ShouldCreate = true) {
1116 return getImpl(Context, Line, Column, static_cast<Metadata *>(Scope),
1117 static_cast<Metadata *>(InlinedAt), Storage, ShouldCreate);
1120 TempDILocation cloneImpl() const {
1121 return getTemporary(getContext(), getLine(), getColumn(), getScope(),
1125 // Disallow replacing operands.
1126 void replaceOperandWith(unsigned I, Metadata *New) = delete;
1129 DEFINE_MDNODE_GET(DILocation,
1130 (unsigned Line, unsigned Column, Metadata *Scope,
1131 Metadata *InlinedAt = nullptr),
1132 (Line, Column, Scope, InlinedAt))
1133 DEFINE_MDNODE_GET(DILocation,
1134 (unsigned Line, unsigned Column, DILocalScope *Scope,
1135 DILocation *InlinedAt = nullptr),
1136 (Line, Column, Scope, InlinedAt))
1138 /// \brief Return a (temporary) clone of this.
1139 TempDILocation clone() const { return cloneImpl(); }
1141 unsigned getLine() const { return SubclassData32; }
1142 unsigned getColumn() const { return SubclassData16; }
1143 DILocalScope *getScope() const { return cast<DILocalScope>(getRawScope()); }
1144 DILocation *getInlinedAt() const {
1145 return cast_or_null<DILocation>(getRawInlinedAt());
1148 DIFile *getFile() const { return getScope()->getFile(); }
1149 StringRef getFilename() const { return getScope()->getFilename(); }
1150 StringRef getDirectory() const { return getScope()->getDirectory(); }
1152 /// \brief Get the scope where this is inlined.
1154 /// Walk through \a getInlinedAt() and return \a getScope() from the deepest
1156 DILocalScope *getInlinedAtScope() const {
1157 if (auto *IA = getInlinedAt())
1158 return IA->getInlinedAtScope();
1162 /// \brief Check whether this can be discriminated from another location.
1164 /// Check \c this can be discriminated from \c RHS in a linetable entry.
1165 /// Scope and inlined-at chains are not recorded in the linetable, so they
1166 /// cannot be used to distinguish basic blocks.
1168 /// The current implementation is weaker than it should be, since it just
1169 /// checks filename and line.
1171 /// FIXME: Add a check for getDiscriminator().
1172 /// FIXME: Add a check for getColumn().
1173 /// FIXME: Change the getFilename() check to getFile() (or add one for
1174 /// getDirectory()).
1175 bool canDiscriminate(const DILocation &RHS) const {
1176 return getFilename() != RHS.getFilename() || getLine() != RHS.getLine();
1179 /// \brief Get the DWARF discriminator.
1181 /// DWARF discriminators distinguish identical file locations between
1182 /// instructions that are on different basic blocks.
1183 inline unsigned getDiscriminator() const;
1185 /// \brief Compute new discriminator in the given context.
1187 /// This modifies the \a LLVMContext that \c this is in to increment the next
1188 /// discriminator for \c this's line/filename combination.
1190 /// FIXME: Delete this. See comments in implementation and at the only call
1191 /// site in \a AddDiscriminators::runOnFunction().
1192 unsigned computeNewDiscriminator() const;
1194 Metadata *getRawScope() const { return getOperand(0); }
1195 Metadata *getRawInlinedAt() const {
1196 if (getNumOperands() == 2)
1197 return getOperand(1);
1201 static bool classof(const Metadata *MD) {
1202 return MD->getMetadataID() == DILocationKind;
1206 /// \brief Subprogram description.
1208 /// TODO: Remove DisplayName. It's always equal to Name.
1209 /// TODO: Split up flags.
1210 class DISubprogram : public DILocalScope {
1211 friend class LLVMContextImpl;
1212 friend class MDNode;
1216 unsigned Virtuality;
1217 unsigned VirtualIndex;
1223 DISubprogram(LLVMContext &C, StorageType Storage, unsigned Line,
1224 unsigned ScopeLine, unsigned Virtuality, unsigned VirtualIndex,
1225 unsigned Flags, bool IsLocalToUnit, bool IsDefinition,
1226 bool IsOptimized, ArrayRef<Metadata *> Ops)
1227 : DILocalScope(C, DISubprogramKind, Storage, dwarf::DW_TAG_subprogram,
1229 Line(Line), ScopeLine(ScopeLine), Virtuality(Virtuality),
1230 VirtualIndex(VirtualIndex), Flags(Flags), IsLocalToUnit(IsLocalToUnit),
1231 IsDefinition(IsDefinition), IsOptimized(IsOptimized) {}
1232 ~DISubprogram() = default;
1234 static DISubprogram *
1235 getImpl(LLVMContext &Context, DIScopeRef Scope, StringRef Name,
1236 StringRef LinkageName, DIFile *File, unsigned Line,
1237 DISubroutineType *Type, bool IsLocalToUnit, bool IsDefinition,
1238 unsigned ScopeLine, DITypeRef ContainingType, unsigned Virtuality,
1239 unsigned VirtualIndex, unsigned Flags, bool IsOptimized,
1240 Constant *Function, DITemplateParameterArray TemplateParams,
1241 DISubprogram *Declaration, DILocalVariableArray Variables,
1242 StorageType Storage, bool ShouldCreate = true) {
1243 return getImpl(Context, Scope, getCanonicalMDString(Context, Name),
1244 getCanonicalMDString(Context, LinkageName), File, Line, Type,
1245 IsLocalToUnit, IsDefinition, ScopeLine, ContainingType,
1246 Virtuality, VirtualIndex, Flags, IsOptimized,
1247 Function ? ConstantAsMetadata::get(Function) : nullptr,
1248 TemplateParams.get(), Declaration, Variables.get(), Storage,
1251 static DISubprogram *
1252 getImpl(LLVMContext &Context, Metadata *Scope, MDString *Name,
1253 MDString *LinkageName, Metadata *File, unsigned Line, Metadata *Type,
1254 bool IsLocalToUnit, bool IsDefinition, unsigned ScopeLine,
1255 Metadata *ContainingType, unsigned Virtuality, unsigned VirtualIndex,
1256 unsigned Flags, bool IsOptimized, Metadata *Function,
1257 Metadata *TemplateParams, Metadata *Declaration, Metadata *Variables,
1258 StorageType Storage, bool ShouldCreate = true);
1260 TempDISubprogram cloneImpl() const {
1261 return getTemporary(getContext(), getScope(), getName(), getLinkageName(),
1262 getFile(), getLine(), getType(), isLocalToUnit(),
1263 isDefinition(), getScopeLine(), getContainingType(),
1264 getVirtuality(), getVirtualIndex(), getFlags(),
1265 isOptimized(), getFunctionConstant(),
1266 getTemplateParams(), getDeclaration(), getVariables());
1270 DEFINE_MDNODE_GET(DISubprogram,
1271 (DIScopeRef Scope, StringRef Name, StringRef LinkageName,
1272 DIFile *File, unsigned Line, DISubroutineType *Type,
1273 bool IsLocalToUnit, bool IsDefinition, unsigned ScopeLine,
1274 DITypeRef ContainingType, unsigned Virtuality,
1275 unsigned VirtualIndex, unsigned Flags, bool IsOptimized,
1276 Constant *Function = nullptr,
1277 DITemplateParameterArray TemplateParams = nullptr,
1278 DISubprogram *Declaration = nullptr,
1279 DILocalVariableArray Variables = nullptr),
1280 (Scope, Name, LinkageName, File, Line, Type, IsLocalToUnit,
1281 IsDefinition, ScopeLine, ContainingType, Virtuality,
1282 VirtualIndex, Flags, IsOptimized, Function, TemplateParams,
1283 Declaration, Variables))
1286 (Metadata * Scope, MDString *Name, MDString *LinkageName, Metadata *File,
1287 unsigned Line, Metadata *Type, bool IsLocalToUnit, bool IsDefinition,
1288 unsigned ScopeLine, Metadata *ContainingType, unsigned Virtuality,
1289 unsigned VirtualIndex, unsigned Flags, bool IsOptimized,
1290 Metadata *Function = nullptr, Metadata *TemplateParams = nullptr,
1291 Metadata *Declaration = nullptr, Metadata *Variables = nullptr),
1292 (Scope, Name, LinkageName, File, Line, Type, IsLocalToUnit, IsDefinition,
1293 ScopeLine, ContainingType, Virtuality, VirtualIndex, Flags, IsOptimized,
1294 Function, TemplateParams, Declaration, Variables))
1296 TempDISubprogram clone() const { return cloneImpl(); }
1299 unsigned getLine() const { return Line; }
1300 unsigned getVirtuality() const { return Virtuality; }
1301 unsigned getVirtualIndex() const { return VirtualIndex; }
1302 unsigned getScopeLine() const { return ScopeLine; }
1303 unsigned getFlags() const { return Flags; }
1304 bool isLocalToUnit() const { return IsLocalToUnit; }
1305 bool isDefinition() const { return IsDefinition; }
1306 bool isOptimized() const { return IsOptimized; }
1308 unsigned isArtificial() const { return getFlags() & FlagArtificial; }
1309 bool isPrivate() const {
1310 return (getFlags() & FlagAccessibility) == FlagPrivate;
1312 bool isProtected() const {
1313 return (getFlags() & FlagAccessibility) == FlagProtected;
1315 bool isPublic() const {
1316 return (getFlags() & FlagAccessibility) == FlagPublic;
1318 bool isExplicit() const { return getFlags() & FlagExplicit; }
1319 bool isPrototyped() const { return getFlags() & FlagPrototyped; }
1321 /// \brief Check if this is reference-qualified.
1323 /// Return true if this subprogram is a C++11 reference-qualified non-static
1324 /// member function (void foo() &).
1325 unsigned isLValueReference() const {
1326 return getFlags() & FlagLValueReference;
1329 /// \brief Check if this is rvalue-reference-qualified.
1331 /// Return true if this subprogram is a C++11 rvalue-reference-qualified
1332 /// non-static member function (void foo() &&).
1333 unsigned isRValueReference() const {
1334 return getFlags() & FlagRValueReference;
1337 DIScopeRef getScope() const { return DIScopeRef(getRawScope()); }
1339 StringRef getName() const { return getStringOperand(2); }
1340 StringRef getDisplayName() const { return getStringOperand(3); }
1341 StringRef getLinkageName() const { return getStringOperand(4); }
1343 MDString *getRawName() const { return getOperandAs<MDString>(2); }
1344 MDString *getRawLinkageName() const { return getOperandAs<MDString>(4); }
1346 DISubroutineType *getType() const {
1347 return cast_or_null<DISubroutineType>(getRawType());
1349 DITypeRef getContainingType() const {
1350 return DITypeRef(getRawContainingType());
1353 Constant *getFunctionConstant() const {
1354 if (auto *C = cast_or_null<ConstantAsMetadata>(getRawFunction()))
1355 return C->getValue();
1358 DITemplateParameterArray getTemplateParams() const {
1359 return cast_or_null<MDTuple>(getRawTemplateParams());
1361 DISubprogram *getDeclaration() const {
1362 return cast_or_null<DISubprogram>(getRawDeclaration());
1364 DILocalVariableArray getVariables() const {
1365 return cast_or_null<MDTuple>(getRawVariables());
1368 Metadata *getRawScope() const { return getOperand(1); }
1369 Metadata *getRawType() const { return getOperand(5); }
1370 Metadata *getRawContainingType() const { return getOperand(6); }
1371 Metadata *getRawFunction() const { return getOperand(7); }
1372 Metadata *getRawTemplateParams() const { return getOperand(8); }
1373 Metadata *getRawDeclaration() const { return getOperand(9); }
1374 Metadata *getRawVariables() const { return getOperand(10); }
1376 /// \brief Get a pointer to the function this subprogram describes.
1378 /// This dyn_casts \a getFunctionConstant() to \a Function.
1380 /// FIXME: Should this be looking through bitcasts?
1381 Function *getFunction() const;
1383 /// \brief Replace the function.
1385 /// If \a isUniqued() and not \a isResolved(), this could node will be
1386 /// RAUW'ed and deleted out from under the caller. Use a \a TrackingMDRef if
1387 /// that's a problem.
1389 void replaceFunction(Function *F);
1390 void replaceFunction(ConstantAsMetadata *MD) { replaceOperandWith(7, MD); }
1391 void replaceFunction(std::nullptr_t) { replaceOperandWith(7, nullptr); }
1394 /// \brief Check if this subprogram describes the given function.
1396 /// FIXME: Should this be looking through bitcasts?
1397 bool describes(const Function *F) const;
1399 static bool classof(const Metadata *MD) {
1400 return MD->getMetadataID() == DISubprogramKind;
1404 class DILexicalBlockBase : public DILocalScope {
1406 DILexicalBlockBase(LLVMContext &C, unsigned ID, StorageType Storage,
1407 ArrayRef<Metadata *> Ops)
1408 : DILocalScope(C, ID, Storage, dwarf::DW_TAG_lexical_block, Ops) {}
1409 ~DILexicalBlockBase() = default;
1412 DILocalScope *getScope() const { return cast<DILocalScope>(getRawScope()); }
1414 Metadata *getRawScope() const { return getOperand(1); }
1416 static bool classof(const Metadata *MD) {
1417 return MD->getMetadataID() == DILexicalBlockKind ||
1418 MD->getMetadataID() == DILexicalBlockFileKind;
1422 class DILexicalBlock : public DILexicalBlockBase {
1423 friend class LLVMContextImpl;
1424 friend class MDNode;
1429 DILexicalBlock(LLVMContext &C, StorageType Storage, unsigned Line,
1430 unsigned Column, ArrayRef<Metadata *> Ops)
1431 : DILexicalBlockBase(C, DILexicalBlockKind, Storage, Ops), Line(Line),
1433 assert(Column < (1u << 16) && "Expected 16-bit column");
1435 ~DILexicalBlock() = default;
1437 static DILexicalBlock *getImpl(LLVMContext &Context, DILocalScope *Scope,
1438 DIFile *File, unsigned Line, unsigned Column,
1439 StorageType Storage,
1440 bool ShouldCreate = true) {
1441 return getImpl(Context, static_cast<Metadata *>(Scope),
1442 static_cast<Metadata *>(File), Line, Column, Storage,
1446 static DILexicalBlock *getImpl(LLVMContext &Context, Metadata *Scope,
1447 Metadata *File, unsigned Line, unsigned Column,
1448 StorageType Storage, bool ShouldCreate = true);
1450 TempDILexicalBlock cloneImpl() const {
1451 return getTemporary(getContext(), getScope(), getFile(), getLine(),
1456 DEFINE_MDNODE_GET(DILexicalBlock, (DILocalScope * Scope, DIFile *File,
1457 unsigned Line, unsigned Column),
1458 (Scope, File, Line, Column))
1459 DEFINE_MDNODE_GET(DILexicalBlock, (Metadata * Scope, Metadata *File,
1460 unsigned Line, unsigned Column),
1461 (Scope, File, Line, Column))
1463 TempDILexicalBlock clone() const { return cloneImpl(); }
1465 unsigned getLine() const { return Line; }
1466 unsigned getColumn() const { return Column; }
1468 static bool classof(const Metadata *MD) {
1469 return MD->getMetadataID() == DILexicalBlockKind;
1473 class DILexicalBlockFile : public DILexicalBlockBase {
1474 friend class LLVMContextImpl;
1475 friend class MDNode;
1477 unsigned Discriminator;
1479 DILexicalBlockFile(LLVMContext &C, StorageType Storage,
1480 unsigned Discriminator, ArrayRef<Metadata *> Ops)
1481 : DILexicalBlockBase(C, DILexicalBlockFileKind, Storage, Ops),
1482 Discriminator(Discriminator) {}
1483 ~DILexicalBlockFile() = default;
1485 static DILexicalBlockFile *getImpl(LLVMContext &Context, DILocalScope *Scope,
1486 DIFile *File, unsigned Discriminator,
1487 StorageType Storage,
1488 bool ShouldCreate = true) {
1489 return getImpl(Context, static_cast<Metadata *>(Scope),
1490 static_cast<Metadata *>(File), Discriminator, Storage,
1494 static DILexicalBlockFile *getImpl(LLVMContext &Context, Metadata *Scope,
1495 Metadata *File, unsigned Discriminator,
1496 StorageType Storage,
1497 bool ShouldCreate = true);
1499 TempDILexicalBlockFile cloneImpl() const {
1500 return getTemporary(getContext(), getScope(), getFile(),
1501 getDiscriminator());
1505 DEFINE_MDNODE_GET(DILexicalBlockFile, (DILocalScope * Scope, DIFile *File,
1506 unsigned Discriminator),
1507 (Scope, File, Discriminator))
1508 DEFINE_MDNODE_GET(DILexicalBlockFile,
1509 (Metadata * Scope, Metadata *File, unsigned Discriminator),
1510 (Scope, File, Discriminator))
1512 TempDILexicalBlockFile clone() const { return cloneImpl(); }
1514 // TODO: Remove these once they're gone from DILexicalBlockBase.
1515 unsigned getLine() const = delete;
1516 unsigned getColumn() const = delete;
1518 unsigned getDiscriminator() const { return Discriminator; }
1520 static bool classof(const Metadata *MD) {
1521 return MD->getMetadataID() == DILexicalBlockFileKind;
1525 unsigned DILocation::getDiscriminator() const {
1526 if (auto *F = dyn_cast<DILexicalBlockFile>(getScope()))
1527 return F->getDiscriminator();
1531 class DINamespace : public DIScope {
1532 friend class LLVMContextImpl;
1533 friend class MDNode;
1537 DINamespace(LLVMContext &Context, StorageType Storage, unsigned Line,
1538 ArrayRef<Metadata *> Ops)
1539 : DIScope(Context, DINamespaceKind, Storage, dwarf::DW_TAG_namespace,
1542 ~DINamespace() = default;
1544 static DINamespace *getImpl(LLVMContext &Context, DIScope *Scope,
1545 DIFile *File, StringRef Name, unsigned Line,
1546 StorageType Storage, bool ShouldCreate = true) {
1547 return getImpl(Context, Scope, File, getCanonicalMDString(Context, Name),
1548 Line, Storage, ShouldCreate);
1550 static DINamespace *getImpl(LLVMContext &Context, Metadata *Scope,
1551 Metadata *File, MDString *Name, unsigned Line,
1552 StorageType Storage, bool ShouldCreate = true);
1554 TempDINamespace cloneImpl() const {
1555 return getTemporary(getContext(), getScope(), getFile(), getName(),
1560 DEFINE_MDNODE_GET(DINamespace, (DIScope * Scope, DIFile *File, StringRef Name,
1562 (Scope, File, Name, Line))
1563 DEFINE_MDNODE_GET(DINamespace, (Metadata * Scope, Metadata *File,
1564 MDString *Name, unsigned Line),
1565 (Scope, File, Name, Line))
1567 TempDINamespace clone() const { return cloneImpl(); }
1569 unsigned getLine() const { return Line; }
1570 DIScope *getScope() const { return cast_or_null<DIScope>(getRawScope()); }
1571 StringRef getName() const { return getStringOperand(2); }
1573 Metadata *getRawScope() const { return getOperand(1); }
1574 MDString *getRawName() const { return getOperandAs<MDString>(2); }
1576 static bool classof(const Metadata *MD) {
1577 return MD->getMetadataID() == DINamespaceKind;
1581 /// \brief A (clang) module that has been imported by the compile unit.
1583 class DIModule : public DIScope {
1584 friend class LLVMContextImpl;
1585 friend class MDNode;
1587 DIModule(LLVMContext &Context, StorageType Storage, ArrayRef<Metadata *> Ops)
1588 : DIScope(Context, DIModuleKind, Storage, dwarf::DW_TAG_module, Ops) {}
1591 static DIModule *getImpl(LLVMContext &Context, DIScope *Scope,
1592 StringRef Name, StringRef ConfigurationMacros,
1593 StringRef IncludePath, StringRef ISysRoot,
1594 StorageType Storage, bool ShouldCreate = true) {
1595 return getImpl(Context, Scope, getCanonicalMDString(Context, Name),
1596 getCanonicalMDString(Context, ConfigurationMacros),
1597 getCanonicalMDString(Context, IncludePath),
1598 getCanonicalMDString(Context, ISysRoot),
1599 Storage, ShouldCreate);
1601 static DIModule *getImpl(LLVMContext &Context, Metadata *Scope,
1602 MDString *Name, MDString *ConfigurationMacros,
1603 MDString *IncludePath, MDString *ISysRoot,
1604 StorageType Storage, bool ShouldCreate = true);
1606 TempDIModule cloneImpl() const {
1607 return getTemporary(getContext(), getScope(), getName(),
1608 getConfigurationMacros(), getIncludePath(),
1613 DEFINE_MDNODE_GET(DIModule, (DIScope *Scope, StringRef Name,
1614 StringRef ConfigurationMacros, StringRef IncludePath,
1615 StringRef ISysRoot),
1616 (Scope, Name, ConfigurationMacros, IncludePath, ISysRoot))
1617 DEFINE_MDNODE_GET(DIModule,
1618 (Metadata *Scope, MDString *Name, MDString *ConfigurationMacros,
1619 MDString *IncludePath, MDString *ISysRoot),
1620 (Scope, Name, ConfigurationMacros, IncludePath, ISysRoot))
1622 TempDIModule clone() const { return cloneImpl(); }
1624 DIScope *getScope() const { return cast_or_null<DIScope>(getRawScope()); }
1625 StringRef getName() const { return getStringOperand(1); }
1626 StringRef getConfigurationMacros() const { return getStringOperand(2); }
1627 StringRef getIncludePath() const { return getStringOperand(3); }
1628 StringRef getISysRoot() const { return getStringOperand(4); }
1630 Metadata *getRawScope() const { return getOperand(0); }
1631 MDString *getRawName() const { return getOperandAs<MDString>(1); }
1632 MDString *getRawConfigurationMacros() const { return getOperandAs<MDString>(2); }
1633 MDString *getRawIncludePath() const { return getOperandAs<MDString>(3); }
1634 MDString *getRawISysRoot() const { return getOperandAs<MDString>(4); }
1636 static bool classof(const Metadata *MD) {
1637 return MD->getMetadataID() == DIModuleKind;
1641 /// \brief Base class for template parameters.
1642 class DITemplateParameter : public DINode {
1644 DITemplateParameter(LLVMContext &Context, unsigned ID, StorageType Storage,
1645 unsigned Tag, ArrayRef<Metadata *> Ops)
1646 : DINode(Context, ID, Storage, Tag, Ops) {}
1647 ~DITemplateParameter() = default;
1650 StringRef getName() const { return getStringOperand(0); }
1651 DITypeRef getType() const { return DITypeRef(getRawType()); }
1653 MDString *getRawName() const { return getOperandAs<MDString>(0); }
1654 Metadata *getRawType() const { return getOperand(1); }
1656 static bool classof(const Metadata *MD) {
1657 return MD->getMetadataID() == DITemplateTypeParameterKind ||
1658 MD->getMetadataID() == DITemplateValueParameterKind;
1662 class DITemplateTypeParameter : public DITemplateParameter {
1663 friend class LLVMContextImpl;
1664 friend class MDNode;
1666 DITemplateTypeParameter(LLVMContext &Context, StorageType Storage,
1667 ArrayRef<Metadata *> Ops)
1668 : DITemplateParameter(Context, DITemplateTypeParameterKind, Storage,
1669 dwarf::DW_TAG_template_type_parameter, Ops) {}
1670 ~DITemplateTypeParameter() = default;
1672 static DITemplateTypeParameter *getImpl(LLVMContext &Context, StringRef Name,
1673 DITypeRef Type, StorageType Storage,
1674 bool ShouldCreate = true) {
1675 return getImpl(Context, getCanonicalMDString(Context, Name), Type, Storage,
1678 static DITemplateTypeParameter *getImpl(LLVMContext &Context, MDString *Name,
1679 Metadata *Type, StorageType Storage,
1680 bool ShouldCreate = true);
1682 TempDITemplateTypeParameter cloneImpl() const {
1683 return getTemporary(getContext(), getName(), getType());
1687 DEFINE_MDNODE_GET(DITemplateTypeParameter, (StringRef Name, DITypeRef Type),
1689 DEFINE_MDNODE_GET(DITemplateTypeParameter, (MDString * Name, Metadata *Type),
1692 TempDITemplateTypeParameter clone() const { return cloneImpl(); }
1694 static bool classof(const Metadata *MD) {
1695 return MD->getMetadataID() == DITemplateTypeParameterKind;
1699 class DITemplateValueParameter : public DITemplateParameter {
1700 friend class LLVMContextImpl;
1701 friend class MDNode;
1703 DITemplateValueParameter(LLVMContext &Context, StorageType Storage,
1704 unsigned Tag, ArrayRef<Metadata *> Ops)
1705 : DITemplateParameter(Context, DITemplateValueParameterKind, Storage, Tag,
1707 ~DITemplateValueParameter() = default;
1709 static DITemplateValueParameter *getImpl(LLVMContext &Context, unsigned Tag,
1710 StringRef Name, DITypeRef Type,
1711 Metadata *Value, StorageType Storage,
1712 bool ShouldCreate = true) {
1713 return getImpl(Context, Tag, getCanonicalMDString(Context, Name), Type,
1714 Value, Storage, ShouldCreate);
1716 static DITemplateValueParameter *getImpl(LLVMContext &Context, unsigned Tag,
1717 MDString *Name, Metadata *Type,
1718 Metadata *Value, StorageType Storage,
1719 bool ShouldCreate = true);
1721 TempDITemplateValueParameter cloneImpl() const {
1722 return getTemporary(getContext(), getTag(), getName(), getType(),
1727 DEFINE_MDNODE_GET(DITemplateValueParameter, (unsigned Tag, StringRef Name,
1728 DITypeRef Type, Metadata *Value),
1729 (Tag, Name, Type, Value))
1730 DEFINE_MDNODE_GET(DITemplateValueParameter, (unsigned Tag, MDString *Name,
1731 Metadata *Type, Metadata *Value),
1732 (Tag, Name, Type, Value))
1734 TempDITemplateValueParameter clone() const { return cloneImpl(); }
1736 Metadata *getValue() const { return getOperand(2); }
1738 static bool classof(const Metadata *MD) {
1739 return MD->getMetadataID() == DITemplateValueParameterKind;
1743 /// \brief Base class for variables.
1744 class DIVariable : public DINode {
1748 DIVariable(LLVMContext &C, unsigned ID, StorageType Storage, unsigned Line,
1749 ArrayRef<Metadata *> Ops)
1750 : DINode(C, ID, Storage, dwarf::DW_TAG_variable, Ops), Line(Line) {}
1751 ~DIVariable() = default;
1754 unsigned getLine() const { return Line; }
1755 DIScope *getScope() const { return cast_or_null<DIScope>(getRawScope()); }
1756 StringRef getName() const { return getStringOperand(1); }
1757 DIFile *getFile() const { return cast_or_null<DIFile>(getRawFile()); }
1758 DITypeRef getType() const { return DITypeRef(getRawType()); }
1760 StringRef getFilename() const {
1761 if (auto *F = getFile())
1762 return F->getFilename();
1765 StringRef getDirectory() const {
1766 if (auto *F = getFile())
1767 return F->getDirectory();
1771 Metadata *getRawScope() const { return getOperand(0); }
1772 MDString *getRawName() const { return getOperandAs<MDString>(1); }
1773 Metadata *getRawFile() const { return getOperand(2); }
1774 Metadata *getRawType() const { return getOperand(3); }
1776 static bool classof(const Metadata *MD) {
1777 return MD->getMetadataID() == DILocalVariableKind ||
1778 MD->getMetadataID() == DIGlobalVariableKind;
1782 /// \brief Global variables.
1784 /// TODO: Remove DisplayName. It's always equal to Name.
1785 class DIGlobalVariable : public DIVariable {
1786 friend class LLVMContextImpl;
1787 friend class MDNode;
1792 DIGlobalVariable(LLVMContext &C, StorageType Storage, unsigned Line,
1793 bool IsLocalToUnit, bool IsDefinition,
1794 ArrayRef<Metadata *> Ops)
1795 : DIVariable(C, DIGlobalVariableKind, Storage, Line, Ops),
1796 IsLocalToUnit(IsLocalToUnit), IsDefinition(IsDefinition) {}
1797 ~DIGlobalVariable() = default;
1799 static DIGlobalVariable *
1800 getImpl(LLVMContext &Context, DIScope *Scope, StringRef Name,
1801 StringRef LinkageName, DIFile *File, unsigned Line, DITypeRef Type,
1802 bool IsLocalToUnit, bool IsDefinition, Constant *Variable,
1803 DIDerivedType *StaticDataMemberDeclaration, StorageType Storage,
1804 bool ShouldCreate = true) {
1805 return getImpl(Context, Scope, getCanonicalMDString(Context, Name),
1806 getCanonicalMDString(Context, LinkageName), File, Line, Type,
1807 IsLocalToUnit, IsDefinition,
1808 Variable ? ConstantAsMetadata::get(Variable) : nullptr,
1809 StaticDataMemberDeclaration, Storage, ShouldCreate);
1811 static DIGlobalVariable *
1812 getImpl(LLVMContext &Context, Metadata *Scope, MDString *Name,
1813 MDString *LinkageName, Metadata *File, unsigned Line, Metadata *Type,
1814 bool IsLocalToUnit, bool IsDefinition, Metadata *Variable,
1815 Metadata *StaticDataMemberDeclaration, StorageType Storage,
1816 bool ShouldCreate = true);
1818 TempDIGlobalVariable cloneImpl() const {
1819 return getTemporary(getContext(), getScope(), getName(), getLinkageName(),
1820 getFile(), getLine(), getType(), isLocalToUnit(),
1821 isDefinition(), getVariable(),
1822 getStaticDataMemberDeclaration());
1826 DEFINE_MDNODE_GET(DIGlobalVariable,
1827 (DIScope * Scope, StringRef Name, StringRef LinkageName,
1828 DIFile *File, unsigned Line, DITypeRef Type,
1829 bool IsLocalToUnit, bool IsDefinition, Constant *Variable,
1830 DIDerivedType *StaticDataMemberDeclaration),
1831 (Scope, Name, LinkageName, File, Line, Type, IsLocalToUnit,
1832 IsDefinition, Variable, StaticDataMemberDeclaration))
1833 DEFINE_MDNODE_GET(DIGlobalVariable,
1834 (Metadata * Scope, MDString *Name, MDString *LinkageName,
1835 Metadata *File, unsigned Line, Metadata *Type,
1836 bool IsLocalToUnit, bool IsDefinition, Metadata *Variable,
1837 Metadata *StaticDataMemberDeclaration),
1838 (Scope, Name, LinkageName, File, Line, Type, IsLocalToUnit,
1839 IsDefinition, Variable, StaticDataMemberDeclaration))
1841 TempDIGlobalVariable clone() const { return cloneImpl(); }
1843 bool isLocalToUnit() const { return IsLocalToUnit; }
1844 bool isDefinition() const { return IsDefinition; }
1845 StringRef getDisplayName() const { return getStringOperand(4); }
1846 StringRef getLinkageName() const { return getStringOperand(5); }
1847 Constant *getVariable() const {
1848 if (auto *C = cast_or_null<ConstantAsMetadata>(getRawVariable()))
1849 return dyn_cast<Constant>(C->getValue());
1852 DIDerivedType *getStaticDataMemberDeclaration() const {
1853 return cast_or_null<DIDerivedType>(getRawStaticDataMemberDeclaration());
1856 MDString *getRawLinkageName() const { return getOperandAs<MDString>(5); }
1857 Metadata *getRawVariable() const { return getOperand(6); }
1858 Metadata *getRawStaticDataMemberDeclaration() const { return getOperand(7); }
1860 static bool classof(const Metadata *MD) {
1861 return MD->getMetadataID() == DIGlobalVariableKind;
1865 /// \brief Local variable.
1867 /// TODO: Split up flags.
1868 class DILocalVariable : public DIVariable {
1869 friend class LLVMContextImpl;
1870 friend class MDNode;
1875 DILocalVariable(LLVMContext &C, StorageType Storage, unsigned Line,
1876 unsigned Arg, unsigned Flags, ArrayRef<Metadata *> Ops)
1877 : DIVariable(C, DILocalVariableKind, Storage, Line, Ops), Arg(Arg),
1879 ~DILocalVariable() = default;
1881 static DILocalVariable *getImpl(LLVMContext &Context, DIScope *Scope,
1882 StringRef Name, DIFile *File, unsigned Line,
1883 DITypeRef Type, unsigned Arg, unsigned Flags,
1884 StorageType Storage,
1885 bool ShouldCreate = true) {
1886 return getImpl(Context, Scope, getCanonicalMDString(Context, Name), File,
1887 Line, Type, Arg, Flags, Storage, ShouldCreate);
1889 static DILocalVariable *getImpl(LLVMContext &Context, Metadata *Scope,
1890 MDString *Name, Metadata *File, unsigned Line,
1891 Metadata *Type, unsigned Arg, unsigned Flags,
1892 StorageType Storage,
1893 bool ShouldCreate = true);
1895 TempDILocalVariable cloneImpl() const {
1896 return getTemporary(getContext(), getScope(), getName(), getFile(),
1897 getLine(), getType(), getArg(), getFlags());
1901 DEFINE_MDNODE_GET(DILocalVariable,
1902 (DILocalScope * Scope, StringRef Name, DIFile *File,
1903 unsigned Line, DITypeRef Type, unsigned Arg,
1905 (Scope, Name, File, Line, Type, Arg, Flags))
1906 DEFINE_MDNODE_GET(DILocalVariable,
1907 (Metadata * Scope, MDString *Name, Metadata *File,
1908 unsigned Line, Metadata *Type, unsigned Arg,
1910 (Scope, Name, File, Line, Type, Arg, Flags))
1912 TempDILocalVariable clone() const { return cloneImpl(); }
1914 /// \brief Get the local scope for this variable.
1916 /// Variables must be defined in a local scope.
1917 DILocalScope *getScope() const {
1918 return cast<DILocalScope>(DIVariable::getScope());
1921 bool isParameter() const { return Arg; }
1922 unsigned getArg() const { return Arg; }
1923 unsigned getFlags() const { return Flags; }
1925 bool isArtificial() const { return getFlags() & FlagArtificial; }
1926 bool isObjectPointer() const { return getFlags() & FlagObjectPointer; }
1928 /// \brief Check that a location is valid for this variable.
1930 /// Check that \c DL exists, is in the same subprogram, and has the same
1931 /// inlined-at location as \c this. (Otherwise, it's not a valid attachment
1932 /// to a \a DbgInfoIntrinsic.)
1933 bool isValidLocationForIntrinsic(const DILocation *DL) const {
1934 return DL && getScope()->getSubprogram() == DL->getScope()->getSubprogram();
1937 static bool classof(const Metadata *MD) {
1938 return MD->getMetadataID() == DILocalVariableKind;
1942 /// \brief DWARF expression.
1944 /// This is (almost) a DWARF expression that modifies the location of a
1945 /// variable or (or the location of a single piece of a variable).
1947 /// FIXME: Instead of DW_OP_plus taking an argument, this should use DW_OP_const
1948 /// and have DW_OP_plus consume the topmost elements on the stack.
1950 /// TODO: Co-allocate the expression elements.
1951 /// TODO: Separate from MDNode, or otherwise drop Distinct and Temporary
1953 class DIExpression : public MDNode {
1954 friend class LLVMContextImpl;
1955 friend class MDNode;
1957 std::vector<uint64_t> Elements;
1959 DIExpression(LLVMContext &C, StorageType Storage, ArrayRef<uint64_t> Elements)
1960 : MDNode(C, DIExpressionKind, Storage, None),
1961 Elements(Elements.begin(), Elements.end()) {}
1962 ~DIExpression() = default;
1964 static DIExpression *getImpl(LLVMContext &Context,
1965 ArrayRef<uint64_t> Elements, StorageType Storage,
1966 bool ShouldCreate = true);
1968 TempDIExpression cloneImpl() const {
1969 return getTemporary(getContext(), getElements());
1973 DEFINE_MDNODE_GET(DIExpression, (ArrayRef<uint64_t> Elements), (Elements))
1975 TempDIExpression clone() const { return cloneImpl(); }
1977 ArrayRef<uint64_t> getElements() const { return Elements; }
1979 unsigned getNumElements() const { return Elements.size(); }
1980 uint64_t getElement(unsigned I) const {
1981 assert(I < Elements.size() && "Index out of range");
1985 /// \brief Return whether this is a piece of an aggregate variable.
1986 bool isBitPiece() const;
1988 /// \brief Return the offset of this piece in bits.
1989 uint64_t getBitPieceOffset() const;
1991 /// \brief Return the size of this piece in bits.
1992 uint64_t getBitPieceSize() const;
1994 typedef ArrayRef<uint64_t>::iterator element_iterator;
1995 element_iterator elements_begin() const { return getElements().begin(); }
1996 element_iterator elements_end() const { return getElements().end(); }
1998 /// \brief A lightweight wrapper around an expression operand.
2000 /// TODO: Store arguments directly and change \a DIExpression to store a
2006 explicit ExprOperand(const uint64_t *Op) : Op(Op) {}
2008 const uint64_t *get() const { return Op; }
2010 /// \brief Get the operand code.
2011 uint64_t getOp() const { return *Op; }
2013 /// \brief Get an argument to the operand.
2015 /// Never returns the operand itself.
2016 uint64_t getArg(unsigned I) const { return Op[I + 1]; }
2018 unsigned getNumArgs() const { return getSize() - 1; }
2020 /// \brief Return the size of the operand.
2022 /// Return the number of elements in the operand (1 + args).
2023 unsigned getSize() const;
2026 /// \brief An iterator for expression operands.
2027 class expr_op_iterator
2028 : public std::iterator<std::input_iterator_tag, ExprOperand> {
2032 explicit expr_op_iterator(element_iterator I) : Op(I) {}
2034 element_iterator getBase() const { return Op.get(); }
2035 const ExprOperand &operator*() const { return Op; }
2036 const ExprOperand *operator->() const { return &Op; }
2038 expr_op_iterator &operator++() {
2042 expr_op_iterator operator++(int) {
2043 expr_op_iterator T(*this);
2048 /// \brief Get the next iterator.
2050 /// \a std::next() doesn't work because this is technically an
2051 /// input_iterator, but it's a perfectly valid operation. This is an
2052 /// accessor to provide the same functionality.
2053 expr_op_iterator getNext() const { return ++expr_op_iterator(*this); }
2055 bool operator==(const expr_op_iterator &X) const {
2056 return getBase() == X.getBase();
2058 bool operator!=(const expr_op_iterator &X) const {
2059 return getBase() != X.getBase();
2063 void increment() { Op = ExprOperand(getBase() + Op.getSize()); }
2066 /// \brief Visit the elements via ExprOperand wrappers.
2068 /// These range iterators visit elements through \a ExprOperand wrappers.
2069 /// This is not guaranteed to be a valid range unless \a isValid() gives \c
2072 /// \pre \a isValid() gives \c true.
2074 expr_op_iterator expr_op_begin() const {
2075 return expr_op_iterator(elements_begin());
2077 expr_op_iterator expr_op_end() const {
2078 return expr_op_iterator(elements_end());
2082 bool isValid() const;
2084 static bool classof(const Metadata *MD) {
2085 return MD->getMetadataID() == DIExpressionKind;
2089 class DIObjCProperty : public DINode {
2090 friend class LLVMContextImpl;
2091 friend class MDNode;
2094 unsigned Attributes;
2096 DIObjCProperty(LLVMContext &C, StorageType Storage, unsigned Line,
2097 unsigned Attributes, ArrayRef<Metadata *> Ops)
2098 : DINode(C, DIObjCPropertyKind, Storage, dwarf::DW_TAG_APPLE_property,
2100 Line(Line), Attributes(Attributes) {}
2101 ~DIObjCProperty() = default;
2103 static DIObjCProperty *
2104 getImpl(LLVMContext &Context, StringRef Name, DIFile *File, unsigned Line,
2105 StringRef GetterName, StringRef SetterName, unsigned Attributes,
2106 DITypeRef Type, StorageType Storage, bool ShouldCreate = true) {
2107 return getImpl(Context, getCanonicalMDString(Context, Name), File, Line,
2108 getCanonicalMDString(Context, GetterName),
2109 getCanonicalMDString(Context, SetterName), Attributes, Type,
2110 Storage, ShouldCreate);
2112 static DIObjCProperty *getImpl(LLVMContext &Context, MDString *Name,
2113 Metadata *File, unsigned Line,
2114 MDString *GetterName, MDString *SetterName,
2115 unsigned Attributes, Metadata *Type,
2116 StorageType Storage, bool ShouldCreate = true);
2118 TempDIObjCProperty cloneImpl() const {
2119 return getTemporary(getContext(), getName(), getFile(), getLine(),
2120 getGetterName(), getSetterName(), getAttributes(),
2125 DEFINE_MDNODE_GET(DIObjCProperty,
2126 (StringRef Name, DIFile *File, unsigned Line,
2127 StringRef GetterName, StringRef SetterName,
2128 unsigned Attributes, DITypeRef Type),
2129 (Name, File, Line, GetterName, SetterName, Attributes,
2131 DEFINE_MDNODE_GET(DIObjCProperty,
2132 (MDString * Name, Metadata *File, unsigned Line,
2133 MDString *GetterName, MDString *SetterName,
2134 unsigned Attributes, Metadata *Type),
2135 (Name, File, Line, GetterName, SetterName, Attributes,
2138 TempDIObjCProperty clone() const { return cloneImpl(); }
2140 unsigned getLine() const { return Line; }
2141 unsigned getAttributes() const { return Attributes; }
2142 StringRef getName() const { return getStringOperand(0); }
2143 DIFile *getFile() const { return cast_or_null<DIFile>(getRawFile()); }
2144 StringRef getGetterName() const { return getStringOperand(2); }
2145 StringRef getSetterName() const { return getStringOperand(3); }
2146 DITypeRef getType() const { return DITypeRef(getRawType()); }
2148 StringRef getFilename() const {
2149 if (auto *F = getFile())
2150 return F->getFilename();
2153 StringRef getDirectory() const {
2154 if (auto *F = getFile())
2155 return F->getDirectory();
2159 MDString *getRawName() const { return getOperandAs<MDString>(0); }
2160 Metadata *getRawFile() const { return getOperand(1); }
2161 MDString *getRawGetterName() const { return getOperandAs<MDString>(2); }
2162 MDString *getRawSetterName() const { return getOperandAs<MDString>(3); }
2163 Metadata *getRawType() const { return getOperand(4); }
2165 static bool classof(const Metadata *MD) {
2166 return MD->getMetadataID() == DIObjCPropertyKind;
2170 /// \brief An imported module (C++ using directive or similar).
2171 class DIImportedEntity : public DINode {
2172 friend class LLVMContextImpl;
2173 friend class MDNode;
2177 DIImportedEntity(LLVMContext &C, StorageType Storage, unsigned Tag,
2178 unsigned Line, ArrayRef<Metadata *> Ops)
2179 : DINode(C, DIImportedEntityKind, Storage, Tag, Ops), Line(Line) {}
2180 ~DIImportedEntity() = default;
2182 static DIImportedEntity *getImpl(LLVMContext &Context, unsigned Tag,
2183 DIScope *Scope, DINodeRef Entity,
2184 unsigned Line, StringRef Name,
2185 StorageType Storage,
2186 bool ShouldCreate = true) {
2187 return getImpl(Context, Tag, Scope, Entity, Line,
2188 getCanonicalMDString(Context, Name), Storage, ShouldCreate);
2190 static DIImportedEntity *getImpl(LLVMContext &Context, unsigned Tag,
2191 Metadata *Scope, Metadata *Entity,
2192 unsigned Line, MDString *Name,
2193 StorageType Storage,
2194 bool ShouldCreate = true);
2196 TempDIImportedEntity cloneImpl() const {
2197 return getTemporary(getContext(), getTag(), getScope(), getEntity(),
2198 getLine(), getName());
2202 DEFINE_MDNODE_GET(DIImportedEntity,
2203 (unsigned Tag, DIScope *Scope, DINodeRef Entity,
2204 unsigned Line, StringRef Name = ""),
2205 (Tag, Scope, Entity, Line, Name))
2206 DEFINE_MDNODE_GET(DIImportedEntity,
2207 (unsigned Tag, Metadata *Scope, Metadata *Entity,
2208 unsigned Line, MDString *Name),
2209 (Tag, Scope, Entity, Line, Name))
2211 TempDIImportedEntity clone() const { return cloneImpl(); }
2213 unsigned getLine() const { return Line; }
2214 DIScope *getScope() const { return cast_or_null<DIScope>(getRawScope()); }
2215 DINodeRef getEntity() const { return DINodeRef(getRawEntity()); }
2216 StringRef getName() const { return getStringOperand(2); }
2218 Metadata *getRawScope() const { return getOperand(0); }
2219 Metadata *getRawEntity() const { return getOperand(1); }
2220 MDString *getRawName() const { return getOperandAs<MDString>(2); }
2222 static bool classof(const Metadata *MD) {
2223 return MD->getMetadataID() == DIImportedEntityKind;
2227 } // end namespace llvm
2229 #undef DEFINE_MDNODE_GET_UNPACK_IMPL
2230 #undef DEFINE_MDNODE_GET_UNPACK
2231 #undef DEFINE_MDNODE_GET