Base class for types. More...

#include "llvm/IR/DebugInfoMetadata.h"

Inheritance diagram for llvm::DIType:

Public Member Functions
TempDIType	clone () const
unsigned	getLine () const
LLVM_ABI uint32_t	getAlignInBits () const
uint32_t	getAlignInBytes () const
uint32_t	getNumExtraInhabitants () const
DIFlags	getFlags () const
DIScope *	getScope () const
StringRef	getName () const
Metadata *	getRawScope () const
MDString *	getRawName () const
Metadata *	getRawSizeInBits () const
uint64_t	getSizeInBits () const
Metadata *	getRawOffsetInBits () const
uint64_t	getOffsetInBits () const
TempDIType	cloneWithFlags (DIFlags NewFlags) const
	Returns a new temporary DIType with updated Flags.
bool	isPrivate () const
bool	isProtected () const
bool	isPublic () const
bool	isForwardDecl () const
bool	isAppleBlockExtension () const
bool	isVirtual () const
bool	isArtificial () const
bool	isObjectPointer () const
bool	isObjcClassComplete () const
bool	isVector () const
bool	isBitField () const
bool	isStaticMember () const
bool	isLValueReference () const
bool	isRValueReference () const
bool	isTypePassByValue () const
bool	isTypePassByReference () const
bool	isBigEndian () const
bool	isLittleEndian () const
bool	getExportSymbols () const
Public Member Functions inherited from llvm::DIScope
DIFile *	getFile () const
StringRef	getFilename () const
StringRef	getDirectory () const
std::optional< StringRef >	getSource () const
LLVM_ABI StringRef	getName () const
LLVM_ABI DIScope *	getScope () const
Metadata *	getRawFile () const
	Return the raw underlying file.
Public Member Functions inherited from llvm::DINode
LLVM_ABI dwarf::Tag	getTag () const
Public Member Functions inherited from llvm::MDNode
	MDNode (const MDNode &)=delete
void	operator= (const MDNode &)=delete
void *	operator new (size_t)=delete
LLVM_ABI TempMDNode	clone () const
	Create a (temporary) clone of this.
LLVMContext &	getContext () const
LLVM_ABI void	replaceOperandWith (unsigned I, Metadata *New)
	Replace a specific operand.
bool	isResolved () const
	Check if node is fully resolved.
bool	isUniqued () const
bool	isDistinct () const
bool	isTemporary () const
bool	isReplaceable () const
bool	isAlwaysReplaceable () const
bool	hasGeneralizedMDString ()
	Check if this is a valid generalized type metadata node.
unsigned	getNumTemporaryUses () const
void	replaceAllUsesWith (Metadata *MD)
	RAUW a temporary.
LLVM_ABI void	resolveCycles ()
	Resolve cycles.
LLVM_ABI void	resolve ()
	Resolve a unique, unresolved node.
op_iterator	op_begin () const
op_iterator	op_end () const
ArrayRef< MDOperand >	operands () const
const MDOperand &	getOperand (unsigned I) const
unsigned	getNumOperands () const
	Return number of MDNode operands.
LLVM_ABI bool	isTBAAVtableAccess () const
	Check whether MDNode is a vtable access.
LLVM_ABI void	printTree (raw_ostream &OS, const Module *M=nullptr) const
	Print in tree shape.
LLVM_ABI void	printTree (raw_ostream &OS, ModuleSlotTracker &MST, const Module *M=nullptr) const
LLVM_ABI void	dumpTree () const
	User-friendly dump in tree shape.
LLVM_ABI void	dumpTree (const Module *M) const
Public Member Functions inherited from llvm::Metadata
unsigned	getMetadataID () const
LLVM_ABI void	dump () const
	User-friendly dump.
LLVM_ABI void	dump (const Module *M) const
LLVM_ABI void	print (raw_ostream &OS, const Module *M=nullptr, bool IsForDebug=false) const
	Print.
LLVM_ABI void	print (raw_ostream &OS, ModuleSlotTracker &MST, const Module *M=nullptr, bool IsForDebug=false) const
LLVM_ABI void	printAsOperand (raw_ostream &OS, const Module *M=nullptr) const
	Print as operand.
LLVM_ABI void	printAsOperand (raw_ostream &OS, ModuleSlotTracker &MST, const Module *M=nullptr) const

Static Public Member Functions
static bool	classof (const Metadata *MD)
Static Public Member Functions inherited from llvm::DIScope
static bool	classof (const Metadata *MD)
Static Public Member Functions inherited from llvm::DINode
static LLVM_ABI DIFlags	getFlag (StringRef Flag)
static LLVM_ABI StringRef	getFlagString (DIFlags Flag)
static LLVM_ABI DIFlags	splitFlags (DIFlags Flags, SmallVectorImpl< DIFlags > &SplitFlags)
	Split up a flags bitfield.
static bool	classof (const Metadata *MD)
Static Public Member Functions inherited from llvm::MDNode
static MDTuple *	get (LLVMContext &Context, ArrayRef< Metadata * > MDs)
static MDTuple *	getIfExists (LLVMContext &Context, ArrayRef< Metadata * > MDs)
static MDTuple *	getDistinct (LLVMContext &Context, ArrayRef< Metadata * > MDs)
static TempMDTuple	getTemporary (LLVMContext &Context, ArrayRef< Metadata * > MDs)
static LLVM_ABI void	deleteTemporary (MDNode *N)
	Deallocate a node created by getTemporary.
template<class T>
static std::enable_if_t< std::is_base_of< MDNode, T >::value, T * >	replaceWithPermanent (std::unique_ptr< T, TempMDNodeDeleter > N)
	Replace a temporary node with a permanent one.
template<class T>
static std::enable_if_t< std::is_base_of< MDNode, T >::value, T * >	replaceWithUniqued (std::unique_ptr< T, TempMDNodeDeleter > N)
	Replace a temporary node with a uniqued one.
template<class T>
static std::enable_if_t< std::is_base_of< MDNode, T >::value, T * >	replaceWithDistinct (std::unique_ptr< T, TempMDNodeDeleter > N)
	Replace a temporary node with a distinct one.
static bool	classof (const Metadata *MD)
	Methods for support type inquiry through isa, cast, and dyn_cast:
static LLVM_ABI MDNode *	concatenate (MDNode A, MDNode B)
	Methods for metadata merging.
static LLVM_ABI MDNode *	intersect (MDNode A, MDNode B)
static LLVM_ABI MDNode *	getMostGenericTBAA (MDNode A, MDNode B)
static LLVM_ABI MDNode *	getMostGenericFPMath (MDNode A, MDNode B)
static LLVM_ABI MDNode *	getMostGenericRange (MDNode A, MDNode B)
static LLVM_ABI MDNode *	getMostGenericNoaliasAddrspace (MDNode A, MDNode B)
static LLVM_ABI MDNode *	getMostGenericAliasScope (MDNode A, MDNode B)
static LLVM_ABI MDNode *	getMostGenericAlignmentOrDereferenceable (MDNode A, MDNode B)
static LLVM_ABI MDNode *	getMergedProfMetadata (MDNode A, MDNode B, const Instruction AInstr, const Instruction BInstr)
	Merge !prof metadata from two instructions.
static LLVM_ABI MDNode *	getMergedMemProfMetadata (MDNode A, MDNode B)
static LLVM_ABI MDNode *	getMergedCallsiteMetadata (MDNode A, MDNode B)
static LLVM_ABI MDNode *	getMergedCalleeTypeMetadata (const MDNode A, const MDNode B)
static LLVM_ABI CaptureComponents	toCaptureComponents (const MDNode *MD)
	Convert !captures metadata to CaptureComponents. MD may be nullptr.
static LLVM_ABI MDNode *	fromCaptureComponents (LLVMContext &Ctx, CaptureComponents CC)
	Convert CaptureComponents to !captures metadata.

Protected Member Functions
	DIType (LLVMContext &C, unsigned ID, StorageType Storage, unsigned Tag, unsigned Line, uint32_t AlignInBits, uint32_t NumExtraInhabitants, DIFlags Flags, ArrayRef< Metadata * > Ops)
	~DIType ()=default
void	init (unsigned Line, uint32_t AlignInBits, uint32_t NumExtraInhabitants, DIFlags Flags)
void	mutate (unsigned Tag, unsigned Line, uint32_t AlignInBits, uint32_t NumExtraInhabitants, DIFlags Flags)
	Change fields in place.
Protected Member Functions inherited from llvm::DIScope
	DIScope (LLVMContext &C, unsigned ID, StorageType Storage, unsigned Tag, ArrayRef< Metadata * > Ops)
	~DIScope ()=default
Protected Member Functions inherited from llvm::DINode
	DINode (LLVMContext &C, unsigned ID, StorageType Storage, unsigned Tag, ArrayRef< Metadata * > Ops1, ArrayRef< Metadata * > Ops2={})
	~DINode ()=default
template<class Ty>
Ty *	getOperandAs (unsigned I) const
StringRef	getStringOperand (unsigned I) const
void	setTag (unsigned Tag)
	Allow subclasses to mutate the tag.
Protected Member Functions inherited from llvm::MDNode
LLVM_ABI	MDNode (LLVMContext &Context, unsigned ID, StorageType Storage, ArrayRef< Metadata * > Ops1, ArrayRef< Metadata * > Ops2={})
	~MDNode ()=default
LLVM_ABI void *	operator new (size_t Size, size_t NumOps, StorageType Storage)
LLVM_ABI void	operator delete (void *Mem)
void	operator delete (void *, unsigned)
	Required by std, but never called.
void	operator delete (void *, unsigned, bool)
	Required by std, but never called.
LLVM_ABI void	dropAllReferences ()
MDOperand *	mutable_begin ()
MDOperand *	mutable_end ()
mutable_op_range	mutable_operands ()
LLVM_ABI void	setOperand (unsigned I, Metadata *New)
	Set an operand.
unsigned	getNumUnresolved () const
void	setNumUnresolved (unsigned N)
LLVM_ABI void	storeDistinctInContext ()
void	resize (size_t NumOps)
	Resize the node to hold NumOps operands.
Protected Member Functions inherited from llvm::Metadata
	Metadata (unsigned ID, StorageType Storage)
	~Metadata ()=default
void	handleChangedOperand (void , Metadata )
	Default handling of a changed operand, which asserts.

Static Protected Attributes
static constexpr unsigned	N_OPERANDS = 5

Additional Inherited Members
Public Types inherited from llvm::DINode
enum	DIFlags : uint32_t { FlagAccessibility = FlagPrivate \| FlagProtected \| FlagPublic , FlagPtrToMemberRep }
	Debug info flags. More...
Public Types inherited from llvm::MDNode
using	op_iterator = const MDOperand *
using	op_range = iterator_range<op_iterator>
Public Types inherited from llvm::Metadata
enum	MetadataKind
Static Public Attributes inherited from llvm::Metadata
static constexpr const unsigned	PoisonGeneratingIDs []
	Metadata IDs that may generate poison.
Protected Types inherited from llvm::MDNode
using	mutable_op_range = iterator_range<MDOperand *>
Protected Types inherited from llvm::Metadata
enum	StorageType { Uniqued , Distinct , Temporary }
	Active type of storage. More...
Static Protected Member Functions inherited from llvm::DINode
static MDString *	getCanonicalMDString (LLVMContext &Context, StringRef S)
Static Protected Member Functions inherited from llvm::MDNode
template<class T, class StoreT>
static T *	storeImpl (T *N, StorageType Storage, StoreT &Store)
template<class T>
static T *	storeImpl (T *N, StorageType Storage)
Protected Attributes inherited from llvm::Metadata
unsigned char	Storage: 7
	Storage flag for non-uniqued, otherwise unowned, metadata.
unsigned char	SubclassData1: 1
unsigned short	SubclassData16 = 0
unsigned	SubclassData32 = 0

Detailed Description

Base class for types.

TODO: Remove the hardcoded name and context, since many types don't use them. TODO: Split up flags.

Uses the SubclassData32 Metadata slot.

Definition at line 765 of file DebugInfoMetadata.h.

Constructor & Destructor Documentation

◆ DIType()

llvm::DIType::DIType	(	LLVMContext &	C,
		unsigned	ID,
		StorageType	Storage,
		unsigned	Tag,
		unsigned	Line,
		uint32_t	AlignInBits,
		uint32_t	NumExtraInhabitants,
		DIFlags	Flags,
		ArrayRef< Metadata * >	Ops )

inlineprotected

◆ ~DIType()

llvm::DIType::~DIType ( )

protecteddefault

Member Function Documentation

◆ classof()

bool llvm::DIType::classof ( const Metadata * MD )

inlinestatic

Definition at line 869 of file DebugInfoMetadata.h.

References llvm::Metadata::getMetadataID().

◆ clone()

TempDIType llvm::DIType::clone ( ) const

inline

Definition at line 798 of file DebugInfoMetadata.h.

References llvm::cast(), llvm::MDNode::clone(), and llvm::release.

Referenced by cloneWithFlags(), llvm::DIBasicType::DEFINE_MDNODE_GET(), and llvm::DIFixedPointType::DEFINE_MDNODE_GET().

◆ cloneWithFlags()

TempDIType llvm::DIType::cloneWithFlags ( DIFlags NewFlags ) const

inline

Returns a new temporary DIType with updated Flags.

Definition at line 833 of file DebugInfoMetadata.h.

References clone().

Referenced by createTypeWithFlags().

◆ getAlignInBits()

uint32_t DIType::getAlignInBits ( ) const

Definition at line 45 of file DebugInfoMetadata.cpp.

References llvm::DINode::getTag(), and llvm::Metadata::SubclassData32.

Referenced by llvm::DIBasicType::cloneImpl(), getAlignInBytes(), and solveDIType().

◆ getAlignInBytes()

uint32_t llvm::DIType::getAlignInBytes ( ) const

inline

Definition at line 804 of file DebugInfoMetadata.h.

References getAlignInBits().

Referenced by llvm::DwarfUnit::constructTypeDIE(), and llvm::DwarfUnit::getOrCreateStaticMemberDIE().

◆ getExportSymbols()

bool llvm::DIType::getExportSymbols ( ) const

inline

Definition at line 867 of file DebugInfoMetadata.h.

References getFlags().

Referenced by llvm::DwarfUnit::constructTypeDIE().

◆ getFlags()

DIFlags llvm::DIType::getFlags ( ) const

inline

◆ getLine()

unsigned llvm::DIType::getLine ( ) const

inline

Definition at line 802 of file DebugInfoMetadata.h.

◆ getName()

StringRef llvm::DIType::getName ( ) const

inline

Definition at line 809 of file DebugInfoMetadata.h.

References llvm::DINode::getStringOperand().

Referenced by buildFrameDebugInfo(), llvm::DwarfUnit::constructTypeDIE(), llvm::BTFDebug::endModule(), llvm::DwarfUnit::getOrCreateStaticMemberDIE(), and solveDIType().

◆ getNumExtraInhabitants()

uint32_t llvm::DIType::getNumExtraInhabitants ( ) const

inline

Definition at line 805 of file DebugInfoMetadata.h.

Referenced by llvm::DIBasicType::cloneImpl(), and llvm::DwarfUnit::constructTypeDIE().

◆ getOffsetInBits()

uint64_t llvm::DIType::getOffsetInBits ( ) const

inline

Definition at line 824 of file DebugInfoMetadata.h.

References llvm::dyn_cast_or_null(), and getRawOffsetInBits().

◆ getRawName()

MDString * llvm::DIType::getRawName ( ) const

inline

Definition at line 812 of file DebugInfoMetadata.h.

References llvm::DINode::getOperandAs().

Referenced by llvm::DIBasicType::cloneImpl().

◆ getRawOffsetInBits()

Metadata * llvm::DIType::getRawOffsetInBits ( ) const

inline

Definition at line 823 of file DebugInfoMetadata.h.

References llvm::MDNode::getOperand().

Referenced by getOffsetInBits().

◆ getRawScope()

Metadata * llvm::DIType::getRawScope ( ) const

inline

Definition at line 811 of file DebugInfoMetadata.h.

References llvm::MDNode::getOperand().

Referenced by getScope().

◆ getRawSizeInBits()

Metadata * llvm::DIType::getRawSizeInBits ( ) const

inline

Definition at line 814 of file DebugInfoMetadata.h.

References llvm::MDNode::getOperand().

Referenced by llvm::DIBasicType::cloneImpl(), llvm::DwarfUnit::constructTypeDIE(), and getSizeInBits().

◆ getScope()

DIScope * llvm::DIType::getScope ( ) const

inline

Definition at line 808 of file DebugInfoMetadata.h.

References llvm::cast_or_null(), llvm::DIScope::DIScope(), and getRawScope().

Referenced by llvm::DwarfDebug::addDwarfTypeUnitType(), and llvm::DwarfUnit::getOrCreateStaticMemberDIE().

◆ getSizeInBits()

uint64_t llvm::DIType::getSizeInBits ( ) const

inline

Definition at line 815 of file DebugInfoMetadata.h.

References llvm::dyn_cast_or_null(), and getRawSizeInBits().

Referenced by llvm::DwarfUnit::constructTypeDIE(), hasVectorBeenPadded(), solveDIType(), and transferSRADebugInfo().

◆ init()

void llvm::DIType::init	(	unsigned	Line,
		uint32_t	AlignInBits,
		uint32_t	NumExtraInhabitants,
		DIFlags	Flags )

inlineprotected

Definition at line 781 of file DebugInfoMetadata.h.

References llvm::Metadata::SubclassData32.

Referenced by DIType(), and mutate().

◆ isAppleBlockExtension()

bool llvm::DIType::isAppleBlockExtension ( ) const

inline

Definition at line 849 of file DebugInfoMetadata.h.

References getFlags().

Referenced by llvm::DwarfUnit::constructTypeDIE().

◆ isArtificial()

bool llvm::DIType::isArtificial ( ) const

inline

Definition at line 851 of file DebugInfoMetadata.h.

References getFlags().

Referenced by llvm::DwarfUnit::getOrCreateStaticMemberDIE().

◆ isBigEndian()

bool llvm::DIType::isBigEndian ( ) const

inline

Definition at line 865 of file DebugInfoMetadata.h.

References getFlags().

◆ isBitField()

bool llvm::DIType::isBitField ( ) const

inline

Definition at line 857 of file DebugInfoMetadata.h.

References getFlags().

Referenced by llvm::DIDerivedType::getStorageOffsetInBits().

◆ isForwardDecl()

bool llvm::DIType::isForwardDecl ( ) const

inline

Definition at line 848 of file DebugInfoMetadata.h.

References getFlags().

Referenced by llvm::DwarfUnit::constructTypeDIE().

◆ isLittleEndian()

bool llvm::DIType::isLittleEndian ( ) const

inline

Definition at line 866 of file DebugInfoMetadata.h.

References getFlags().

◆ isLValueReference()

bool llvm::DIType::isLValueReference ( ) const

inline

Definition at line 859 of file DebugInfoMetadata.h.

References getFlags().

◆ isObjcClassComplete()

bool llvm::DIType::isObjcClassComplete ( ) const

inline

Definition at line 853 of file DebugInfoMetadata.h.

References getFlags().

Referenced by llvm::DwarfUnit::constructTypeDIE().

◆ isObjectPointer()

bool llvm::DIType::isObjectPointer ( ) const

inline

Definition at line 852 of file DebugInfoMetadata.h.

References getFlags().

◆ isPrivate()

bool llvm::DIType::isPrivate ( ) const

inline

Definition at line 839 of file DebugInfoMetadata.h.

References llvm::DINode::FlagAccessibility, and getFlags().

◆ isProtected()

bool llvm::DIType::isProtected ( ) const

inline

Definition at line 842 of file DebugInfoMetadata.h.

References llvm::DINode::FlagAccessibility, and getFlags().

◆ isPublic()

bool llvm::DIType::isPublic ( ) const

inline

Definition at line 845 of file DebugInfoMetadata.h.

References llvm::DINode::FlagAccessibility, and getFlags().

◆ isRValueReference()

bool llvm::DIType::isRValueReference ( ) const

inline

Definition at line 860 of file DebugInfoMetadata.h.

References getFlags().

◆ isStaticMember()

bool llvm::DIType::isStaticMember ( ) const

inline

Definition at line 858 of file DebugInfoMetadata.h.

References getFlags().

Referenced by llvm::DIDerivedType::getConstant(), and llvm::DIDerivedType::getDiscriminantValue().

◆ isTypePassByReference()

bool llvm::DIType::isTypePassByReference ( ) const

inline

Definition at line 862 of file DebugInfoMetadata.h.

References getFlags().

Referenced by llvm::DwarfUnit::constructTypeDIE().

◆ isTypePassByValue()

bool llvm::DIType::isTypePassByValue ( ) const

inline

Definition at line 861 of file DebugInfoMetadata.h.

References getFlags().

Referenced by llvm::DwarfUnit::constructTypeDIE().

◆ isVector()

bool llvm::DIType::isVector ( ) const

inline

Definition at line 856 of file DebugInfoMetadata.h.

References getFlags().

Referenced by hasVectorBeenPadded().

◆ isVirtual()

bool llvm::DIType::isVirtual ( ) const

inline

Definition at line 850 of file DebugInfoMetadata.h.

References getFlags().

◆ mutate()

void llvm::DIType::mutate	(	unsigned	Tag,
		unsigned	Line,
		uint32_t	AlignInBits,
		uint32_t	NumExtraInhabitants,
		DIFlags	Flags )

inlineprotected

Change fields in place.

Definition at line 790 of file DebugInfoMetadata.h.

References assert(), init(), llvm::MDNode::isDistinct(), llvm::DINode::setTag(), and llvm::Tag.

Member Data Documentation

◆ N_OPERANDS

unsigned llvm::DIType::N_OPERANDS = 5

staticconstexprprotected

Definition at line 771 of file DebugInfoMetadata.h.

Referenced by llvm::DICompositeType::MDNode, llvm::DIDerivedType::MDNode, llvm::DIStringType::MDNode, llvm::DISubrangeType::MDNode, and llvm::DISubroutineType::MDNode.

The documentation for this class was generated from the following files:

include/llvm/IR/DebugInfoMetadata.h
lib/IR/DebugInfoMetadata.cpp

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ DIType()

◆ ~DIType()

Member Function Documentation

◆ classof()

◆ clone()

◆ cloneWithFlags()

◆ getAlignInBits()

◆ getAlignInBytes()

◆ getExportSymbols()

◆ getFlags()

◆ getLine()

◆ getName()

◆ getNumExtraInhabitants()

◆ getOffsetInBits()

◆ getRawName()

◆ getRawOffsetInBits()

◆ getRawScope()

◆ getRawSizeInBits()

◆ getScope()

◆ getSizeInBits()

◆ init()

◆ isAppleBlockExtension()

◆ isArtificial()

◆ isBigEndian()

◆ isBitField()

◆ isForwardDecl()

◆ isLittleEndian()

◆ isLValueReference()

◆ isObjcClassComplete()

◆ isObjectPointer()

◆ isPrivate()

◆ isProtected()

◆ isPublic()

◆ isRValueReference()

◆ isStaticMember()

◆ isTypePassByReference()

◆ isTypePassByValue()

◆ isVector()

◆ isVirtual()

◆ mutate()

Member Data Documentation

◆ N_OPERANDS