Derived types. More...

#include "llvm/IR/DebugInfoMetadata.h"

Inheritance diagram for llvm::DIDerivedType:

Classes
struct	PtrAuthData
	Pointer authentication (__ptrauth) metadata. More...

Public Member Functions
	DEFINE_MDNODE_GET (DIDerivedType,(unsigned Tag, MDString Name, Metadata File, unsigned Line, Metadata Scope, Metadata BaseType, Metadata SizeInBits, uint32_t AlignInBits, Metadata OffsetInBits, std::optional< unsigned > DWARFAddressSpace, std::optional< PtrAuthData > PtrAuthData, DIFlags Flags, Metadata ExtraData=nullptr, Metadata Annotations=nullptr),(Tag, Name, File, Line, Scope, BaseType, SizeInBits, AlignInBits, OffsetInBits, DWARFAddressSpace, PtrAuthData, Flags, ExtraData, Annotations)) DEFINE_MDNODE_GET(DIDerivedType
Metadata *	getExtraData () const
	Get extra data associated with this derived type.
Metadata *	getRawExtraData () const
DITemplateParameterArray	getTemplateParams () const
	Get the template parameters from a template alias.
DINodeArray	getAnnotations () const
	Get annotations associated with this derived type.
Metadata *	getRawAnnotations () const

LLVM_ABI DIType *	getClassType () const
	Get casted version of extra data.
DIObjCProperty *	getObjCProperty () const
LLVM_ABI uint32_t	getVBPtrOffset () const
LLVM_ABI Constant *	getStorageOffsetInBits () const
LLVM_ABI Constant *	getConstant () const
LLVM_ABI Constant *	getDiscriminantValue () const
Public Member Functions inherited from llvm::DIType
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::DIType
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)

Public Attributes
unsigned	Tag
unsigned StringRef	Name
unsigned StringRef DIFile *	File
unsigned StringRef DIFile unsigned	Line
unsigned StringRef DIFile unsigned DIScope *	Scope
unsigned StringRef DIFile unsigned DIScope DIType *	BaseType
unsigned StringRef DIFile unsigned DIScope DIType Metadata *	SizeInBits
unsigned StringRef DIFile unsigned DIScope DIType Metadata uint32_t	AlignInBits
unsigned StringRef DIFile unsigned DIScope DIType Metadata uint32_t Metadata *	OffsetInBits
unsigned StringRef DIFile unsigned DIScope DIType Metadata uint32_t Metadata std::optional< unsigned >	DWARFAddressSpace
unsigned StringRef DIFile unsigned DIScope DIType Metadata uint32_t Metadata std::optional< unsigned > std::optional< PtrAuthData >	PtrAuthData
unsigned StringRef DIFile unsigned DIScope DIType Metadata uint32_t Metadata std::optional< unsigned > std::optional< PtrAuthData > DIFlags	Flags
unsigned StringRef DIFile unsigned DIScope DIType Metadata uint32_t Metadata std::optional< unsigned > std::optional< PtrAuthData > DIFlags Metadata *	ExtraData = nullptr
unsigned StringRef DIFile unsigned DIScope DIType Metadata uint32_t Metadata std::optional< unsigned > std::optional< PtrAuthData > DIFlags Metadata DINodeArray	Annotations

Friends
class	LLVMContextImpl
class	MDNode

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...
Protected Member Functions inherited from llvm::DIType
	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 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
Static Protected Attributes inherited from llvm::DIType
static constexpr unsigned	N_OPERANDS = 5

Detailed Description

Derived types.

This includes qualified types, pointers, references, friends, typedefs, and class members.

TODO: Split out members (inheritance, fields, methods, etc.).

Definition at line 1219 of file DebugInfoMetadata.h.

Member Function Documentation

◆ classof()

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

inlinestatic

Definition at line 1437 of file DebugInfoMetadata.h.

References llvm::Metadata::getMetadataID().

◆ DEFINE_MDNODE_GET()

llvm::DIDerivedType::DEFINE_MDNODE_GET	(	DIDerivedType	,
		(unsigned Tag, MDString Name, Metadata File, unsigned Line, Metadata Scope, Metadata BaseType, Metadata SizeInBits, uint32_t AlignInBits, Metadata OffsetInBits, std::optional< unsigned > DWARFAddressSpace, std::optional< PtrAuthData > PtrAuthData, DIFlags Flags, Metadata ExtraData=nullptr, Metadata Annotations=nullptr)	,
		(Tag, Name, File, Line, Scope, BaseType, SizeInBits, AlignInBits, OffsetInBits, DWARFAddressSpace, PtrAuthData, Flags, ExtraData, Annotations)	)

References AlignInBits, Annotations, BaseType, ExtraData, File, Flags, Line, Name, OffsetInBits, Scope, SizeInBits, and Tag.

◆ getAnnotations()

DINodeArray llvm::DIDerivedType::getAnnotations ( ) const

inline

Get annotations associated with this derived type.

Definition at line 1413 of file DebugInfoMetadata.h.

References llvm::cast_or_null(), and getRawAnnotations().

◆ getClassType()

DIType * DIDerivedType::getClassType ( ) const

Get casted version of extra data.

Definition at line 954 of file DebugInfoMetadata.cpp.

References assert(), llvm::cast_or_null(), llvm::DIType::DIType(), getExtraData(), and llvm::DINode::getTag().

◆ getConstant()

Constant * DIDerivedType::getConstant ( ) const

Definition at line 972 of file DebugInfoMetadata.cpp.

References assert(), llvm::CallingConv::C, llvm::cast_or_null(), getExtraData(), llvm::DINode::getTag(), and llvm::DIType::isStaticMember().

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

◆ getDiscriminantValue()

Constant * DIDerivedType::getDiscriminantValue ( ) const

Definition at line 980 of file DebugInfoMetadata.cpp.

References assert(), llvm::CallingConv::C, llvm::cast_or_null(), getExtraData(), llvm::DINode::getTag(), and llvm::DIType::isStaticMember().

◆ getExtraData()

Metadata * llvm::DIDerivedType::getExtraData ( ) const

inline

Get extra data associated with this derived type.

Class type for pointer-to-members, objective-c property node for ivars, global constant wrapper for static members, virtual base pointer offset for inheritance, a tuple of template parameters for template aliases, discriminant for a variant, or storage offset for a bit field.

TODO: Separate out types that need this extra operand: pointer-to-member types and member fields (static members and ivars).

Definition at line 1404 of file DebugInfoMetadata.h.

References getRawExtraData().

Referenced by getClassType(), getConstant(), getDiscriminantValue(), getObjCProperty(), getStorageOffsetInBits(), getTemplateParams(), and getVBPtrOffset().