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(CLASS, FORMAL, ARGS) \
24 static CLASS *get(LLVMContext &Context, DEFINE_MDNODE_GET_UNPACK(FORMAL)) { \
25 return getImpl(Context, DEFINE_MDNODE_GET_UNPACK(ARGS), Uniqued); \
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); \
32 static CLASS *getDistinct(LLVMContext &Context, \
33 DEFINE_MDNODE_GET_UNPACK(FORMAL)) { \
34 return getImpl(Context, DEFINE_MDNODE_GET_UNPACK(ARGS), Distinct); \
36 static Temp##CLASS getTemporary(LLVMContext &Context, \
37 DEFINE_MDNODE_GET_UNPACK(FORMAL)) { \
39 getImpl(Context, DEFINE_MDNODE_GET_UNPACK(ARGS), Temporary)); \
44 /// \brief Debug location.
46 /// A debug location in source code, used for debug info and otherwise.
47 class MDLocation : public MDNode {
48 friend class LLVMContextImpl;
51 MDLocation(LLVMContext &C, StorageType Storage, unsigned Line,
52 unsigned Column, ArrayRef<Metadata *> MDs);
53 ~MDLocation() { dropAllReferences(); }
55 static MDLocation *getImpl(LLVMContext &Context, unsigned Line,
56 unsigned Column, Metadata *Scope,
57 Metadata *InlinedAt, StorageType Storage,
58 bool ShouldCreate = true);
60 TempMDLocation cloneImpl() const {
61 return getTemporary(getContext(), getLine(), getColumn(), getScope(),
65 // Disallow replacing operands.
66 void replaceOperandWith(unsigned I, Metadata *New) LLVM_DELETED_FUNCTION;
69 DEFINE_MDNODE_GET(MDLocation,
70 (unsigned Line, unsigned Column, Metadata *Scope,
71 Metadata *InlinedAt = nullptr),
72 (Line, Column, Scope, InlinedAt))
74 /// \brief Return a (temporary) clone of this.
75 TempMDLocation clone() const { return cloneImpl(); }
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)
86 static bool classof(const Metadata *MD) {
87 return MD->getMetadataID() == MDLocationKind;
91 /// \brief Tagged DWARF-like metadata node.
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;
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;
109 template <class Ty> Ty *getOperandAs(unsigned I) const {
110 return cast_or_null<Ty>(getOperand(I));
113 StringRef getStringOperand(unsigned I) const {
114 if (auto *S = getOperandAs<MDString>(I))
115 return S->getString();
119 static MDString *getCanonicalMDString(LLVMContext &Context, StringRef S) {
122 return MDString::get(Context, S);
126 unsigned getTag() const { return SubclassData16; }
128 static bool classof(const Metadata *MD) {
129 switch (MD->getMetadataID()) {
132 case GenericDebugNodeKind:
134 case MDEnumeratorKind:
135 case MDBasicTypeKind:
136 case MDDerivedTypeKind:
137 case MDCompositeTypeKind:
138 case MDSubroutineTypeKind:
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:
157 /// \brief Generic tagged DWARF-like metadata node.
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;
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) {
173 ~GenericDebugNode() { dropAllReferences(); }
175 void setHash(unsigned Hash) { SubclassData32 = Hash; }
176 void recalculateHash();
178 static GenericDebugNode *getImpl(LLVMContext &Context, unsigned Tag,
180 ArrayRef<Metadata *> DwarfOps,
182 bool ShouldCreate = true) {
183 return getImpl(Context, Tag, getCanonicalMDString(Context, Header),
184 DwarfOps, Storage, ShouldCreate);
187 static GenericDebugNode *getImpl(LLVMContext &Context, unsigned Tag,
189 ArrayRef<Metadata *> DwarfOps,
191 bool ShouldCreate = true);
193 TempGenericDebugNode cloneImpl() const {
195 getContext(), getTag(), getHeader(),
196 SmallVector<Metadata *, 4>(dwarf_op_begin(), dwarf_op_end()));
200 unsigned getHash() const { return SubclassData32; }
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))
209 /// \brief Return a (temporary) clone of this.
210 TempGenericDebugNode clone() const { return cloneImpl(); }
212 unsigned getTag() const { return SubclassData16; }
213 StringRef getHeader() const { return getStringOperand(0); }
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());
221 unsigned getNumDwarfOperands() const { return getNumOperands() - 1; }
222 const MDOperand &getDwarfOperand(unsigned I) const {
223 return getOperand(I + 1);
225 void replaceDwarfOperandWith(unsigned I, Metadata *New) {
226 replaceOperandWith(I + 1, New);
229 static bool classof(const Metadata *MD) {
230 return MD->getMetadataID() == GenericDebugNodeKind;
234 /// \brief Array subrange.
236 /// TODO: Merge into node for DW_TAG_array_type, which should have a custom
238 class MDSubrange : public DebugNode {
239 friend class LLVMContextImpl;
245 MDSubrange(LLVMContext &C, StorageType Storage, int64_t Count, int64_t Lo)
246 : DebugNode(C, MDSubrangeKind, Storage, dwarf::DW_TAG_subrange_type,
248 Count(Count), Lo(Lo) {}
251 static MDSubrange *getImpl(LLVMContext &Context, int64_t Count, int64_t Lo,
252 StorageType Storage, bool ShouldCreate = true);
254 TempMDSubrange cloneImpl() const {
255 return getTemporary(getContext(), getCount(), getLo());
259 DEFINE_MDNODE_GET(MDSubrange, (int64_t Count, int64_t Lo = 0), (Count, Lo))
261 TempMDSubrange clone() const { return cloneImpl(); }
263 int64_t getLo() const { return Lo; }
264 int64_t getCount() const { return Count; }
266 static bool classof(const Metadata *MD) {
267 return MD->getMetadataID() == MDSubrangeKind;
271 /// \brief Enumeration value.
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;
281 MDEnumerator(LLVMContext &C, StorageType Storage, int64_t Value,
282 ArrayRef<Metadata *> Ops)
283 : DebugNode(C, MDEnumeratorKind, Storage, dwarf::DW_TAG_enumerator, Ops),
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,
293 static MDEnumerator *getImpl(LLVMContext &Context, int64_t Value,
294 MDString *Name, StorageType Storage,
295 bool ShouldCreate = true);
297 TempMDEnumerator cloneImpl() const {
298 return getTemporary(getContext(), getValue(), getName());
302 DEFINE_MDNODE_GET(MDEnumerator, (int64_t Value, StringRef Name),
304 DEFINE_MDNODE_GET(MDEnumerator, (int64_t Value, MDString *Name),
307 TempMDEnumerator clone() const { return cloneImpl(); }
309 int64_t getValue() const { return Value; }
310 StringRef getName() const { return getStringOperand(0); }
312 MDString *getRawName() const { return getOperandAs<MDString>(0); }
314 static bool classof(const Metadata *MD) {
315 return MD->getMetadataID() == MDEnumeratorKind;
319 /// \brief Base class for scope-like contexts.
321 /// Base class for lexical scopes and types (which are also declaration
324 /// TODO: Separate the concepts of declaration contexts and lexical scopes.
325 class MDScope : public DebugNode {
327 MDScope(LLVMContext &C, unsigned ID, StorageType Storage, unsigned Tag,
328 ArrayRef<Metadata *> Ops)
329 : DebugNode(C, ID, Storage, Tag, Ops) {}
333 Metadata *getFile() const { return getOperand(0); }
335 static bool classof(const Metadata *MD) {
336 switch (MD->getMetadataID()) {
339 case MDBasicTypeKind:
340 case MDDerivedTypeKind:
341 case MDCompositeTypeKind:
342 case MDSubroutineTypeKind:
344 case MDCompileUnitKind:
345 case MDSubprogramKind:
346 case MDLexicalBlockKind:
347 case MDLexicalBlockFileKind:
348 case MDNamespaceKind:
354 /// \brief Base class for types.
356 /// TODO: Remove the hardcoded name and context, since many types don't use
358 /// TODO: Split up flags.
359 class MDType : public MDScope {
362 unsigned AlignInBits;
363 unsigned OffsetInBits;
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) {}
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; }
381 Metadata *getScope() const { return getOperand(1); }
382 StringRef getName() const { return getStringOperand(2); }
384 MDString *getRawName() const { return getOperandAs<MDString>(2); }
386 static bool classof(const Metadata *MD) {
387 switch (MD->getMetadataID()) {
390 case MDBasicTypeKind:
391 case MDDerivedTypeKind:
392 case MDCompositeTypeKind:
393 case MDSubroutineTypeKind:
399 /// \brief Basic type.
401 /// TODO: Split out DW_TAG_unspecified_type.
402 /// TODO: Drop unused accessors.
403 class MDBasicType : public MDType {
404 friend class LLVMContextImpl;
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,
414 Encoding(Encoding) {}
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);
424 static MDBasicType *getImpl(LLVMContext &Context, unsigned Tag,
425 MDString *Name, unsigned SizeInBits,
426 unsigned AlignInBits, unsigned Encoding,
427 StorageType Storage, bool ShouldCreate = true);
429 TempMDBasicType cloneImpl() const {
430 return getTemporary(getContext(), getTag(), getName(), getSizeInBits(),
431 getAlignInBits(), getEncoding());
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))
444 TempMDBasicType clone() const { return cloneImpl(); }
446 unsigned getEncoding() const { return Encoding; }
448 static bool classof(const Metadata *MD) {
449 return MD->getMetadataID() == MDBasicTypeKind;
453 /// \brief Base class for MDDerivedType and MDCompositeType.
455 /// TODO: Delete; they're not really related.
456 class MDDerivedTypeBase : public MDType {
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,
464 ~MDDerivedTypeBase() {}
467 Metadata *getBaseType() const { return getOperand(3); }
469 static bool classof(const Metadata *MD) {
470 return MD->getMetadataID() == MDDerivedTypeKind ||
471 MD->getMetadataID() == MDCompositeTypeKind ||
472 MD->getMetadataID() == MDSubroutineTypeKind;
476 /// \brief Derived types.
478 /// This includes qualified types, pointers, references, friends, typedefs, and
481 /// TODO: Split out members (inheritance, fields, methods, etc.).
482 class MDDerivedType : public MDDerivedTypeBase {
483 friend class LLVMContextImpl;
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) {}
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);
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);
512 TempMDDerivedType cloneImpl() const {
513 return getTemporary(getContext(), getTag(), getName(), getFile(), getLine(),
514 getScope(), getBaseType(), getSizeInBits(),
515 getAlignInBits(), getOffsetInBits(), getFlags(),
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))
537 TempMDDerivedType clone() const { return cloneImpl(); }
539 /// \brief Get extra data associated with this derived type.
541 /// Class type for pointer-to-members, objective-c property node for ivars,
542 /// or global constant wrapper for static members.
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); }
548 static bool classof(const Metadata *MD) {
549 return MD->getMetadataID() == MDDerivedTypeKind;
553 /// \brief Base class for MDCompositeType and MDSubroutineType.
555 /// TODO: Delete; they're not really related.
556 class MDCompositeTypeBase : public MDDerivedTypeBase {
557 unsigned RuntimeLang;
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() {}
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; }
577 MDString *getRawIdentifier() const { return getOperandAs<MDString>(7); }
579 static bool classof(const Metadata *MD) {
580 return MD->getMetadataID() == MDCompositeTypeKind ||
581 MD->getMetadataID() == MDSubroutineTypeKind;
585 /// \brief Composite types.
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;
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,
600 ~MDCompositeType() {}
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,
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);
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());
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))
655 TempMDCompositeType clone() const { return cloneImpl(); }
657 static bool classof(const Metadata *MD) {
658 return MD->getMetadataID() == MDCompositeTypeKind;
662 /// \brief Type array for a subprogram.
664 /// TODO: Detach from CompositeType, and fold the array of types in directly
666 class MDSubroutineType : public MDCompositeTypeBase {
667 friend class LLVMContextImpl;
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,
675 ~MDSubroutineType() {}
677 static MDSubroutineType *getImpl(LLVMContext &Context, unsigned Flags,
678 Metadata *TypeArray, StorageType Storage,
679 bool ShouldCreate = true);
681 TempMDSubroutineType cloneImpl() const {
682 return getTemporary(getContext(), getFlags(), getTypeArray());
686 DEFINE_MDNODE_GET(MDSubroutineType, (unsigned Flags, Metadata *TypeArray),
689 TempMDSubroutineType clone() const { return cloneImpl(); }
691 Metadata *getTypeArray() const { return getElements(); }
693 static bool classof(const Metadata *MD) {
694 return MD->getMetadataID() == MDSubroutineTypeKind;
700 /// TODO: Merge with directory/file node (including users).
701 /// TODO: Canonicalize paths on creation.
702 class MDFile : public MDScope {
703 friend class LLVMContextImpl;
706 MDFile(LLVMContext &C, StorageType Storage, ArrayRef<Metadata *> Ops)
707 : MDScope(C, MDFileKind, Storage, dwarf::DW_TAG_file_type, Ops) {}
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,
717 static MDFile *getImpl(LLVMContext &Context, MDString *Filename,
718 MDString *Directory, StorageType Storage,
719 bool ShouldCreate = true);
721 TempMDFile cloneImpl() const {
722 return getTemporary(getContext(), getFilename(), getDirectory());
726 DEFINE_MDNODE_GET(MDFile, (StringRef Filename, StringRef Directory),
727 (Filename, Directory))
728 DEFINE_MDNODE_GET(MDFile, (MDString * Filename, MDString *Directory),
729 (Filename, Directory))
731 TempMDFile clone() const { return cloneImpl(); }
733 MDTuple *getFileNode() const { return cast<MDTuple>(getOperand(0)); }
735 StringRef getFilename() const {
736 if (auto *S = getRawFilename())
737 return S->getString();
740 StringRef getDirectory() const {
741 if (auto *S = getRawDirectory())
742 return S->getString();
746 MDString *getRawFilename() const {
747 return cast_or_null<MDString>(getFileNode()->getOperand(0));
749 MDString *getRawDirectory() const {
750 return cast_or_null<MDString>(getFileNode()->getOperand(1));
753 static bool classof(const Metadata *MD) {
754 return MD->getMetadataID() == MDFileKind;
758 /// \brief Compile unit.
759 class MDCompileUnit : public MDScope {
760 friend class LLVMContextImpl;
763 unsigned SourceLanguage;
765 unsigned RuntimeVersion;
766 unsigned EmissionKind;
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) {}
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);
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);
800 TempMDCompileUnit cloneImpl() const {
802 getContext(), getSourceLanguage(), getFile(), getProducer(),
803 isOptimized(), getFlags(), getRuntimeVersion(), getSplitDebugFilename(),
804 getEmissionKind(), getEnumTypes(), getRetainedTypes(), getSubprograms(),
805 getGlobalVariables(), getImportedEntities());
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,
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,
832 TempMDCompileUnit clone() const { return cloneImpl(); }
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); }
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);
853 static bool classof(const Metadata *MD) {
854 return MD->getMetadataID() == MDCompileUnitKind;
858 /// \brief Subprogram description.
860 /// TODO: Remove DisplayName. It's always equal to Name.
861 /// TODO: Split up flags.
862 class MDSubprogram : public MDScope {
863 friend class LLVMContextImpl;
869 unsigned VirtualIndex;
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) {}
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,
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);
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());
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))
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))
942 TempMDSubprogram clone() const { return cloneImpl(); }
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; }
954 Metadata *getScope() const { return getOperand(1); }
956 StringRef getName() const { return getStringOperand(2); }
957 StringRef getDisplayName() const { return getStringOperand(3); }
958 StringRef getLinkageName() const { return getStringOperand(4); }
960 MDString *getRawName() const { return getOperandAs<MDString>(2); }
961 MDString *getRawLinkageName() const { return getOperandAs<MDString>(4); }
963 Metadata *getType() const { return getOperand(5); }
964 Metadata *getContainingType() const { return getOperand(6); }
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); }
971 static bool classof(const Metadata *MD) {
972 return MD->getMetadataID() == MDSubprogramKind;
976 class MDLexicalBlockBase : public MDScope {
978 MDLexicalBlockBase(LLVMContext &C, unsigned ID, StorageType Storage,
979 ArrayRef<Metadata *> Ops)
980 : MDScope(C, ID, Storage, dwarf::DW_TAG_lexical_block, Ops) {}
981 ~MDLexicalBlockBase() {}
984 Metadata *getScope() const { return getOperand(1); }
986 static bool classof(const Metadata *MD) {
987 return MD->getMetadataID() == MDLexicalBlockKind ||
988 MD->getMetadataID() == MDLexicalBlockFileKind;
992 class MDLexicalBlock : public MDLexicalBlockBase {
993 friend class LLVMContextImpl;
999 MDLexicalBlock(LLVMContext &C, StorageType Storage, unsigned Line,
1000 unsigned Column, ArrayRef<Metadata *> Ops)
1001 : MDLexicalBlockBase(C, MDLexicalBlockKind, Storage, Ops), Line(Line),
1003 ~MDLexicalBlock() {}
1005 static MDLexicalBlock *getImpl(LLVMContext &Context, Metadata *Scope,
1006 Metadata *File, unsigned Line, unsigned Column,
1007 StorageType Storage, bool ShouldCreate = true);
1009 TempMDLexicalBlock cloneImpl() const {
1010 return getTemporary(getContext(), getScope(), getFile(), getLine(),
1015 DEFINE_MDNODE_GET(MDLexicalBlock, (Metadata * Scope, Metadata *File,
1016 unsigned Line, unsigned Column),
1017 (Scope, File, Line, Column))
1019 TempMDLexicalBlock clone() const { return cloneImpl(); }
1021 unsigned getLine() const { return Line; }
1022 unsigned getColumn() const { return Column; }
1024 static bool classof(const Metadata *MD) {
1025 return MD->getMetadataID() == MDLexicalBlockKind;
1029 class MDLexicalBlockFile : public MDLexicalBlockBase {
1030 friend class LLVMContextImpl;
1031 friend class MDNode;
1033 unsigned Discriminator;
1035 MDLexicalBlockFile(LLVMContext &C, StorageType Storage,
1036 unsigned Discriminator, ArrayRef<Metadata *> Ops)
1037 : MDLexicalBlockBase(C, MDLexicalBlockFileKind, Storage, Ops),
1038 Discriminator(Discriminator) {}
1039 ~MDLexicalBlockFile() {}
1041 static MDLexicalBlockFile *getImpl(LLVMContext &Context, Metadata *Scope,
1042 Metadata *File, unsigned Discriminator,
1043 StorageType Storage,
1044 bool ShouldCreate = true);
1046 TempMDLexicalBlockFile cloneImpl() const {
1047 return getTemporary(getContext(), getScope(), getFile(),
1048 getDiscriminator());
1052 DEFINE_MDNODE_GET(MDLexicalBlockFile,
1053 (Metadata * Scope, Metadata *File, unsigned Discriminator),
1054 (Scope, File, Discriminator))
1056 TempMDLexicalBlockFile clone() const { return cloneImpl(); }
1058 unsigned getDiscriminator() const { return Discriminator; }
1060 static bool classof(const Metadata *MD) {
1061 return MD->getMetadataID() == MDLexicalBlockFileKind;
1065 class MDNamespace : public MDScope {
1066 friend class LLVMContextImpl;
1067 friend class MDNode;
1071 MDNamespace(LLVMContext &Context, StorageType Storage, unsigned Line,
1072 ArrayRef<Metadata *> Ops)
1073 : MDScope(Context, MDNamespaceKind, Storage, dwarf::DW_TAG_namespace,
1078 static MDNamespace *getImpl(LLVMContext &Context, Metadata *Scope,
1079 Metadata *File, StringRef Name, unsigned Line,
1080 StorageType Storage, bool ShouldCreate = true) {
1081 return getImpl(Context, Scope, File, getCanonicalMDString(Context, Name),
1082 Line, Storage, ShouldCreate);
1084 static MDNamespace *getImpl(LLVMContext &Context, Metadata *Scope,
1085 Metadata *File, MDString *Name, unsigned Line,
1086 StorageType Storage, bool ShouldCreate = true);
1088 TempMDNamespace cloneImpl() const {
1089 return getTemporary(getContext(), getScope(), getFile(), getName(),
1094 DEFINE_MDNODE_GET(MDNamespace, (Metadata * Scope, Metadata *File,
1095 StringRef Name, unsigned Line),
1096 (Scope, File, Name, Line))
1097 DEFINE_MDNODE_GET(MDNamespace, (Metadata * Scope, Metadata *File,
1098 MDString *Name, unsigned Line),
1099 (Scope, File, Name, Line))
1101 TempMDNamespace clone() const { return cloneImpl(); }
1103 unsigned getLine() const { return Line; }
1104 Metadata *getScope() const { return getOperand(1); }
1105 StringRef getName() const { return getStringOperand(2); }
1107 MDString *getRawName() const { return getOperandAs<MDString>(2); }
1109 static bool classof(const Metadata *MD) {
1110 return MD->getMetadataID() == MDNamespaceKind;
1114 /// \brief Base class for template parameters.
1116 /// TODO: Remove the scope. It's always the compile unit, and never
1118 /// TODO: Remove File, Line and Column. They're always 0 and never
1120 class MDTemplateParameter : public DebugNode {
1122 MDTemplateParameter(LLVMContext &Context, unsigned ID, StorageType Storage,
1123 unsigned Tag, ArrayRef<Metadata *> Ops)
1124 : DebugNode(Context, ID, Storage, Tag, Ops) {}
1125 ~MDTemplateParameter() {}
1128 Metadata *getScope() const { return getOperand(0); }
1129 StringRef getName() const { return getStringOperand(1); }
1130 Metadata *getType() const { return getOperand(2); }
1132 static bool classof(const Metadata *MD) {
1133 return MD->getMetadataID() == MDTemplateTypeParameterKind ||
1134 MD->getMetadataID() == MDTemplateValueParameterKind;
1138 class MDTemplateTypeParameter : public MDTemplateParameter {
1139 friend class LLVMContextImpl;
1140 friend class MDNode;
1142 MDTemplateTypeParameter(LLVMContext &Context, StorageType Storage,
1143 ArrayRef<Metadata *> Ops)
1144 : MDTemplateParameter(Context, MDTemplateTypeParameterKind, Storage,
1145 dwarf::DW_TAG_template_type_parameter, Ops) {}
1146 ~MDTemplateTypeParameter() {}
1148 static MDTemplateTypeParameter *getImpl(LLVMContext &Context, Metadata *Scope,
1149 StringRef Name, Metadata *Type,
1150 StorageType Storage,
1151 bool ShouldCreate = true) {
1152 return getImpl(Context, Scope, getCanonicalMDString(Context, Name), Type,
1153 Storage, ShouldCreate);
1155 static MDTemplateTypeParameter *getImpl(LLVMContext &Context, Metadata *Scope,
1156 MDString *Name, Metadata *Type,
1157 StorageType Storage,
1158 bool ShouldCreate = true);
1160 TempMDTemplateTypeParameter cloneImpl() const {
1161 return getTemporary(getContext(), getScope(), getName(), getType());
1165 DEFINE_MDNODE_GET(MDTemplateTypeParameter,
1166 (Metadata * Scope, StringRef Name, Metadata *Type),
1167 (Scope, Name, Type))
1168 DEFINE_MDNODE_GET(MDTemplateTypeParameter,
1169 (Metadata * Scope, MDString *Name, Metadata *Type),
1170 (Scope, Name, Type))
1172 TempMDTemplateTypeParameter clone() const { return cloneImpl(); }
1174 static bool classof(const Metadata *MD) {
1175 return MD->getMetadataID() == MDTemplateTypeParameterKind;
1179 class MDTemplateValueParameter : public MDTemplateParameter {
1180 friend class LLVMContextImpl;
1181 friend class MDNode;
1183 MDTemplateValueParameter(LLVMContext &Context, StorageType Storage,
1184 unsigned Tag, ArrayRef<Metadata *> Ops)
1185 : MDTemplateParameter(Context, MDTemplateValueParameterKind, Storage, Tag,
1187 ~MDTemplateValueParameter() {}
1189 static MDTemplateValueParameter *getImpl(LLVMContext &Context, unsigned Tag,
1190 Metadata *Scope, StringRef Name,
1191 Metadata *Type, Metadata *Value,
1192 StorageType Storage,
1193 bool ShouldCreate = true) {
1194 return getImpl(Context, Tag, Scope, getCanonicalMDString(Context, Name),
1195 Type, Value, Storage, ShouldCreate);
1197 static MDTemplateValueParameter *getImpl(LLVMContext &Context, unsigned Tag,
1198 Metadata *Scope, MDString *Name,
1199 Metadata *Type, Metadata *Value,
1200 StorageType Storage,
1201 bool ShouldCreate = true);
1203 TempMDTemplateValueParameter cloneImpl() const {
1204 return getTemporary(getContext(), getTag(), getScope(), getName(),
1205 getType(), getValue());
1209 DEFINE_MDNODE_GET(MDTemplateValueParameter,
1210 (unsigned Tag, Metadata *Scope, StringRef Name,
1211 Metadata *Type, Metadata *Value),
1212 (Tag, Scope, Name, Type, Value))
1213 DEFINE_MDNODE_GET(MDTemplateValueParameter,
1214 (unsigned Tag, Metadata *Scope, MDString *Name,
1215 Metadata *Type, Metadata *Value),
1216 (Tag, Scope, Name, Type, Value))
1218 Metadata *getValue() const { return getOperand(3); }
1220 static bool classof(const Metadata *MD) {
1221 return MD->getMetadataID() == MDTemplateValueParameterKind;
1225 /// \brief Base class for variables.
1227 /// TODO: Hardcode to DW_TAG_variable.
1228 class MDVariable : public DebugNode {
1232 MDVariable(LLVMContext &C, unsigned ID, StorageType Storage, unsigned Tag,
1233 unsigned Line, ArrayRef<Metadata *> Ops)
1234 : DebugNode(C, ID, Storage, Tag, Ops), Line(Line) {}
1238 unsigned getLine() const { return Line; }
1239 Metadata *getScope() const { return getOperand(0); }
1240 StringRef getName() const { return getStringOperand(1); }
1241 Metadata *getFile() const { return getOperand(2); }
1242 Metadata *getType() const { return getOperand(3); }
1244 static bool classof(const Metadata *MD) {
1245 return MD->getMetadataID() == MDLocalVariableKind ||
1246 MD->getMetadataID() == MDGlobalVariableKind;
1250 /// \brief Global variables.
1252 /// TODO: Remove DisplayName. It's always equal to Name.
1253 class MDGlobalVariable : public MDVariable {
1254 friend class LLVMContextImpl;
1255 friend class MDNode;
1260 MDGlobalVariable(LLVMContext &C, StorageType Storage, unsigned Line,
1261 bool IsLocalToUnit, bool IsDefinition,
1262 ArrayRef<Metadata *> Ops)
1263 : MDVariable(C, MDGlobalVariableKind, Storage, dwarf::DW_TAG_variable,
1265 IsLocalToUnit(IsLocalToUnit), IsDefinition(IsDefinition) {}
1266 ~MDGlobalVariable() {}
1268 static MDGlobalVariable *
1269 getImpl(LLVMContext &Context, Metadata *Scope, StringRef Name,
1270 StringRef LinkageName, Metadata *File, unsigned Line, Metadata *Type,
1271 bool IsLocalToUnit, bool IsDefinition, Metadata *Variable,
1272 Metadata *StaticDataMemberDeclaration, StorageType Storage,
1273 bool ShouldCreate = true) {
1274 return getImpl(Context, Scope, getCanonicalMDString(Context, Name),
1275 getCanonicalMDString(Context, LinkageName), File, Line, Type,
1276 IsLocalToUnit, IsDefinition, Variable,
1277 StaticDataMemberDeclaration, Storage, ShouldCreate);
1279 static MDGlobalVariable *
1280 getImpl(LLVMContext &Context, Metadata *Scope, MDString *Name,
1281 MDString *LinkageName, Metadata *File, unsigned Line, Metadata *Type,
1282 bool IsLocalToUnit, bool IsDefinition, Metadata *Variable,
1283 Metadata *StaticDataMemberDeclaration, StorageType Storage,
1284 bool ShouldCreate = true);
1286 TempMDGlobalVariable cloneImpl() const {
1287 return getTemporary(getContext(), getScope(), getName(), getLinkageName(),
1288 getFile(), getLine(), getType(), isLocalToUnit(),
1289 isDefinition(), getVariable(),
1290 getStaticDataMemberDeclaration());
1294 DEFINE_MDNODE_GET(MDGlobalVariable,
1295 (Metadata * Scope, StringRef Name, StringRef LinkageName,
1296 Metadata *File, unsigned Line, Metadata *Type,
1297 bool IsLocalToUnit, bool IsDefinition, Metadata *Variable,
1298 Metadata *StaticDataMemberDeclaration),
1299 (Scope, Name, LinkageName, File, Line, Type, IsLocalToUnit,
1300 IsDefinition, Variable, StaticDataMemberDeclaration))
1301 DEFINE_MDNODE_GET(MDGlobalVariable,
1302 (Metadata * Scope, MDString *Name, MDString *LinkageName,
1303 Metadata *File, unsigned Line, Metadata *Type,
1304 bool IsLocalToUnit, bool IsDefinition, Metadata *Variable,
1305 Metadata *StaticDataMemberDeclaration),
1306 (Scope, Name, LinkageName, File, Line, Type, IsLocalToUnit,
1307 IsDefinition, Variable, StaticDataMemberDeclaration))
1309 bool isLocalToUnit() const { return IsLocalToUnit; }
1310 bool isDefinition() const { return IsDefinition; }
1311 StringRef getDisplayName() const { return getStringOperand(4); }
1312 StringRef getLinkageName() const { return getStringOperand(5); }
1313 Metadata *getVariable() const { return getOperand(6); }
1314 Metadata *getStaticDataMemberDeclaration() const { return getOperand(7); }
1316 static bool classof(const Metadata *MD) {
1317 return MD->getMetadataID() == MDGlobalVariableKind;
1321 /// \brief Local variable.
1323 /// TODO: Split between arguments and otherwise.
1324 /// TODO: Use \c DW_TAG_variable instead of fake tags.
1325 /// TODO: Split up flags.
1326 class MDLocalVariable : public MDVariable {
1327 friend class LLVMContextImpl;
1328 friend class MDNode;
1333 MDLocalVariable(LLVMContext &C, StorageType Storage, unsigned Tag,
1334 unsigned Line, unsigned Arg, unsigned Flags,
1335 ArrayRef<Metadata *> Ops)
1336 : MDVariable(C, MDLocalVariableKind, Storage, Tag, Line, Ops), Arg(Arg),
1338 ~MDLocalVariable() {}
1340 static MDLocalVariable *getImpl(LLVMContext &Context, unsigned Tag,
1341 Metadata *Scope, StringRef Name,
1342 Metadata *File, unsigned Line, Metadata *Type,
1343 unsigned Arg, unsigned Flags,
1344 Metadata *InlinedAt, StorageType Storage,
1345 bool ShouldCreate = true) {
1346 return getImpl(Context, Tag, Scope, getCanonicalMDString(Context, Name),
1347 File, Line, Type, Arg, Flags, InlinedAt, Storage,
1350 static MDLocalVariable *getImpl(LLVMContext &Context, unsigned Tag,
1351 Metadata *Scope, MDString *Name,
1352 Metadata *File, unsigned Line, Metadata *Type,
1353 unsigned Arg, unsigned Flags,
1354 Metadata *InlinedAt, StorageType Storage,
1355 bool ShouldCreate = true);
1357 TempMDLocalVariable cloneImpl() const {
1358 return getTemporary(getContext(), getTag(), getScope(), getName(),
1359 getFile(), getLine(), getType(), getArg(), getFlags(),
1364 DEFINE_MDNODE_GET(MDLocalVariable,
1365 (unsigned Tag, Metadata *Scope, StringRef Name,
1366 Metadata *File, unsigned Line, Metadata *Type,
1367 unsigned Arg, unsigned Flags,
1368 Metadata *InlinedAt = nullptr),
1369 (Tag, Scope, Name, File, Line, Type, Arg, Flags, InlinedAt))
1370 DEFINE_MDNODE_GET(MDLocalVariable,
1371 (unsigned Tag, Metadata *Scope, MDString *Name,
1372 Metadata *File, unsigned Line, Metadata *Type,
1373 unsigned Arg, unsigned Flags,
1374 Metadata *InlinedAt = nullptr),
1375 (Tag, Scope, Name, File, Line, Type, Arg, Flags, InlinedAt))
1377 unsigned getArg() const { return Arg; }
1378 unsigned getFlags() const { return Flags; }
1379 Metadata *getInlinedAt() const { return getOperand(4); }
1381 static bool classof(const Metadata *MD) {
1382 return MD->getMetadataID() == MDLocalVariableKind;
1386 /// \brief DWARF expression.
1388 /// TODO: Co-allocate the expression elements.
1389 /// TODO: Drop fake DW_TAG_expression and separate from DebugNode.
1390 /// TODO: Separate from MDNode, or otherwise drop Distinct and Temporary
1392 class MDExpression : public DebugNode {
1393 friend class LLVMContextImpl;
1394 friend class MDNode;
1396 std::vector<uint64_t> Elements;
1398 MDExpression(LLVMContext &C, StorageType Storage, ArrayRef<uint64_t> Elements)
1399 : DebugNode(C, MDExpressionKind, Storage, dwarf::DW_TAG_expression, None),
1400 Elements(Elements.begin(), Elements.end()) {}
1403 static MDExpression *getImpl(LLVMContext &Context,
1404 ArrayRef<uint64_t> Elements, StorageType Storage,
1405 bool ShouldCreate = true);
1407 TempMDExpression cloneImpl() const {
1408 return getTemporary(getContext(), getElements());
1412 DEFINE_MDNODE_GET(MDExpression, (ArrayRef<uint64_t> Elements), (Elements))
1414 ArrayRef<uint64_t> getElements() const { return Elements; }
1416 unsigned getNumElements() const { return Elements.size(); }
1417 uint64_t getElement(unsigned I) const {
1418 assert(I < Elements.size() && "Index out of range");
1422 typedef ArrayRef<uint64_t>::iterator element_iterator;
1423 element_iterator elements_begin() const { return getElements().begin(); }
1424 element_iterator elements_end() const { return getElements().end(); }
1426 /// \brief A lightweight wrapper around an expression operand.
1428 /// TODO: Store arguments directly and change \a MDExpression to store a
1434 explicit ExprOperand(const uint64_t *Op) : Op(Op) {}
1436 const uint64_t *get() const { return Op; }
1438 /// \brief Get the operand code.
1439 uint64_t getOp() const { return *Op; }
1441 /// \brief Get an argument to the operand.
1443 /// Never returns the operand itself.
1444 uint64_t getArg(unsigned I) const { return Op[I + 1]; }
1446 unsigned getNumArgs() const { return getSize() - 1; }
1448 /// \brief Return the size of the operand.
1450 /// Return the number of elements in the operand (1 + args).
1451 unsigned getSize() const;
1454 /// \brief An iterator for expression operands.
1455 class expr_op_iterator
1456 : public std::iterator<std::input_iterator_tag, ExprOperand> {
1460 explicit expr_op_iterator(element_iterator I) : Op(I) {}
1462 element_iterator getBase() const { return Op.get(); }
1463 const ExprOperand &operator*() const { return Op; }
1464 const ExprOperand *operator->() const { return &Op; }
1466 expr_op_iterator &operator++() {
1470 expr_op_iterator operator++(int) {
1471 expr_op_iterator T(*this);
1476 bool operator==(const expr_op_iterator &X) const {
1477 return getBase() == X.getBase();
1479 bool operator!=(const expr_op_iterator &X) const {
1480 return getBase() != X.getBase();
1484 void increment() { Op = ExprOperand(getBase() + Op.getSize()); }
1487 /// \brief Visit the elements via ExprOperand wrappers.
1489 /// These range iterators visit elements through \a ExprOperand wrappers.
1490 /// This is not guaranteed to be a valid range unless \a isValid() gives \c
1493 /// \pre \a isValid() gives \c true.
1495 expr_op_iterator expr_op_begin() const {
1496 return expr_op_iterator(elements_begin());
1498 expr_op_iterator expr_op_end() const {
1499 return expr_op_iterator(elements_end());
1503 bool isValid() const;
1505 static bool classof(const Metadata *MD) {
1506 return MD->getMetadataID() == MDExpressionKind;
1510 class MDObjCProperty : public DebugNode {
1511 friend class LLVMContextImpl;
1512 friend class MDNode;
1515 unsigned Attributes;
1517 MDObjCProperty(LLVMContext &C, StorageType Storage, unsigned Line,
1518 unsigned Attributes, ArrayRef<Metadata *> Ops)
1519 : DebugNode(C, MDObjCPropertyKind, Storage, dwarf::DW_TAG_APPLE_property,
1521 Line(Line), Attributes(Attributes) {}
1522 ~MDObjCProperty() {}
1524 static MDObjCProperty *
1525 getImpl(LLVMContext &Context, StringRef Name, Metadata *File, unsigned Line,
1526 StringRef GetterName, StringRef SetterName, unsigned Attributes,
1527 Metadata *Type, StorageType Storage, bool ShouldCreate = true) {
1528 return getImpl(Context, getCanonicalMDString(Context, Name), File, Line,
1529 getCanonicalMDString(Context, GetterName),
1530 getCanonicalMDString(Context, SetterName), Attributes, Type,
1531 Storage, ShouldCreate);
1533 static MDObjCProperty *getImpl(LLVMContext &Context, MDString *Name,
1534 Metadata *File, unsigned Line,
1535 MDString *GetterName, MDString *SetterName,
1536 unsigned Attributes, Metadata *Type,
1537 StorageType Storage, bool ShouldCreate = true);
1539 TempMDObjCProperty cloneImpl() const {
1540 return getTemporary(getContext(), getName(), getFile(), getLine(),
1541 getGetterName(), getSetterName(), getAttributes(),
1546 DEFINE_MDNODE_GET(MDObjCProperty,
1547 (StringRef Name, Metadata *File, unsigned Line,
1548 StringRef GetterName, StringRef SetterName,
1549 unsigned Attributes, Metadata *Type),
1550 (Name, File, Line, GetterName, SetterName, Attributes,
1552 DEFINE_MDNODE_GET(MDObjCProperty,
1553 (MDString * Name, Metadata *File, unsigned Line,
1554 MDString *GetterName, MDString *SetterName,
1555 unsigned Attributes, Metadata *Type),
1556 (Name, File, Line, GetterName, SetterName, Attributes,
1559 unsigned getLine() const { return Line; }
1560 unsigned getAttributes() const { return Attributes; }
1561 StringRef getName() const { return getStringOperand(0); }
1562 Metadata *getFile() const { return getOperand(1); }
1563 StringRef getGetterName() const { return getStringOperand(2); }
1564 StringRef getSetterName() const { return getStringOperand(3); }
1565 Metadata *getType() const { return getOperand(4); }
1567 static bool classof(const Metadata *MD) {
1568 return MD->getMetadataID() == MDObjCPropertyKind;
1572 class MDImportedEntity : public DebugNode {
1573 friend class LLVMContextImpl;
1574 friend class MDNode;
1578 MDImportedEntity(LLVMContext &C, StorageType Storage, unsigned Tag,
1579 unsigned Line, ArrayRef<Metadata *> Ops)
1580 : DebugNode(C, MDImportedEntityKind, Storage, Tag, Ops), Line(Line) {}
1581 ~MDImportedEntity() {}
1583 static MDImportedEntity *getImpl(LLVMContext &Context, unsigned Tag,
1584 Metadata *Scope, Metadata *Entity,
1585 unsigned Line, StringRef Name,
1586 StorageType Storage,
1587 bool ShouldCreate = true) {
1588 return getImpl(Context, Tag, Scope, Entity, Line,
1589 getCanonicalMDString(Context, Name), Storage, ShouldCreate);
1591 static MDImportedEntity *getImpl(LLVMContext &Context, unsigned Tag,
1592 Metadata *Scope, Metadata *Entity,
1593 unsigned Line, MDString *Name,
1594 StorageType Storage,
1595 bool ShouldCreate = true);
1597 TempMDImportedEntity cloneImpl() const {
1598 return getTemporary(getContext(), getTag(), getScope(), getEntity(),
1599 getLine(), getName());
1603 DEFINE_MDNODE_GET(MDImportedEntity,
1604 (unsigned Tag, Metadata *Scope, Metadata *Entity,
1605 unsigned Line, StringRef Name = ""),
1606 (Tag, Scope, Entity, Line, Name))
1607 DEFINE_MDNODE_GET(MDImportedEntity,
1608 (unsigned Tag, Metadata *Scope, Metadata *Entity,
1609 unsigned Line, MDString *Name),
1610 (Tag, Scope, Entity, Line, Name))
1612 TempMDImportedEntity clone() const { return cloneImpl(); }
1614 unsigned getLine() const { return Line; }
1615 Metadata *getScope() const { return getOperand(0); }
1616 Metadata *getEntity() const { return getOperand(1); }
1617 StringRef getName() const { return getStringOperand(2); }
1619 static bool classof(const Metadata *MD) {
1620 return MD->getMetadataID() == MDImportedEntityKind;
1624 } // end namespace llvm
1626 #undef DEFINE_MDNODE_GET_UNPACK_IMPL
1627 #undef DEFINE_MDNODE_GET_UNPACK
1628 #undef DEFINE_MDNODE_GET