LLVM: llvm::DICompositeType Class Reference (original ) (raw )Composite types. More...
#include "[llvm/IR/DebugInfoMetadata.h](DebugInfoMetadata%5F8h%5Fsource.html)"
Public Member Functions
DEFINE_MDNODE_GET (DICompositeType ,(unsigned Tag , StringRef Name , DIFile *File , unsigned Line , DIScope *Scope , DIType *BaseType , uint64_t SizeInBits , uint32_t AlignInBits , uint64_t OffsetInBits , DIFlags Flags , DINodeArray Elements , unsigned RuntimeLang , std::optional< uint32_t > EnumKind , DIType *VTableHolder , DITemplateParameterArray TemplateParams =nullptr, StringRef Identifier ="", DIDerivedType *Discriminator =nullptr, Metadata *DataLocation =nullptr, Metadata *Associated =nullptr, Metadata *Allocated =nullptr, Metadata *Rank =nullptr, DINodeArray Annotations =nullptr, DIType *Specification =nullptr, uint32_t NumExtraInhabitants =0, Metadata *BitStride =nullptr),(Tag , Name , File , Line , Scope , BaseType , SizeInBits , AlignInBits , OffsetInBits , Specification , NumExtraInhabitants , Flags , Elements , RuntimeLang , EnumKind , VTableHolder , TemplateParams , Identifier , Discriminator , DataLocation , Associated , Allocated , Rank , Annotations , BitStride )) DEFINE_MDNODE_GET(DICompositeType
DIType *
getBaseType () const
DINodeArray
getElements () const
DIType *
getVTableHolder () const
DITemplateParameterArray
getTemplateParams () const
StringRef
getIdentifier () const
unsigned
getRuntimeLang () const
std::optional< uint32_t >
getEnumKind () const
Metadata *
getRawBaseType () const
Metadata *
getRawElements () const
Metadata *
getRawVTableHolder () const
Metadata *
getRawTemplateParams () const
MDString *
getRawIdentifier () const
Metadata *
getRawDiscriminator () const
DIDerivedType *
getDiscriminator () const
Metadata *
getRawDataLocation () const
DIVariable *
getDataLocation () const
DIExpression *
getDataLocationExp () const
Metadata *
getRawAssociated () const
DIVariable *
getAssociated () const
DIExpression *
getAssociatedExp () const
Metadata *
getRawAllocated () const
DIVariable *
getAllocated () const
DIExpression *
getAllocatedExp () const
Metadata *
getRawRank () const
ConstantInt *
getRankConst () const
DIExpression *
getRankExp () const
Metadata *
getRawAnnotations () const
DINodeArray
getAnnotations () const
Metadata *
getRawSpecification () const
DIType *
getSpecification () const
Metadata *
getRawBitStride () const
ConstantInt *
getBitStrideConst () const
void
replaceElements (DINodeArray Elements )
Replace operands.
void
replaceVTableHolder (DIType *VTableHolder )
void
replaceTemplateParams (DITemplateParameterArray TemplateParams )
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 LLVM_ABI DICompositeType *
getODRTypeIfExists (LLVMContext &Context , MDString &Identifier )
static LLVM_ABI DICompositeType *
buildODRType (LLVMContext &Context , MDString &Identifier , unsigned Tag , MDString *Name , Metadata *File , unsigned Line , Metadata *Scope , Metadata *BaseType , Metadata *SizeInBits , uint32_t AlignInBits , Metadata *OffsetInBits , Metadata *Specification , uint32_t NumExtraInhabitants , DIFlags Flags , Metadata *Elements , unsigned RuntimeLang , std::optional< uint32_t > EnumKind , Metadata *VTableHolder , Metadata *TemplateParams , Metadata *Discriminator , Metadata *DataLocation , Metadata *Associated , Metadata *Allocated , Metadata *Rank , Metadata *Annotations , Metadata *BitStride )
Build a DICompositeType with the given ODR identifier.
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 )
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.
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
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
Composite types.
TODO: Detach from DerivedTypeBase (split out MDEnumType?). TODO: Create a custom, unrelated node for DW_TAG_array_type.
Definition at line 1627 of file DebugInfoMetadata.h .
◆ buildODRType()
DICompositeType * DICompositeType::buildODRType ( LLVMContext & Context , MDString & Identifier , unsigned Tag , MDString * Name , Metadata * File , unsigned Line , Metadata * Scope , Metadata * BaseType , Metadata * SizeInBits , uint32_t AlignInBits , Metadata * OffsetInBits , Metadata * Specification , uint32_t NumExtraInhabitants , DIFlags Flags , Metadata * Elements , unsigned RuntimeLang , std::optional< uint32_t > EnumKind , Metadata * VTableHolder , Metadata * TemplateParams , Metadata * Discriminator , Metadata * DataLocation , Metadata * Associated , Metadata * Allocated , Metadata * Rank , Metadata * Annotations , Metadata * BitStride )
static
Build a DICompositeType with the given ODR identifier.
Looks up the mapped DICompositeType for the given ODR Identifier. If it doesn't exist, creates a new one. If it does exist and isForwardDecl() , and the new arguments would be a definition, mutates the the type in place. In either case, returns the type.
If not LLVMContext::isODRUniquingDebugTypes() , this function returns nullptr.
Definition at line 1066 of file DebugInfoMetadata.cpp .
References AbstractManglingParser< Derived, Alloc >::Ops , AlignInBits , Allocated , Annotations , assert() , Associated , BaseType , BitStride , DataLocation , Discriminator , Elements , File , Flags , llvm::MDNode::getDistinct() , I , Identifier , Line , Name , NumExtraInhabitants , OffsetInBits , Rank , Scope , SizeInBits , Specification , Tag , TemplateParams , and VTableHolder .
◆ classof()◆ DEFINE_MDNODE_GET()
llvm::DICompositeType::DEFINE_MDNODE_GET
(
DICompositeType
,
(unsigned Tag , StringRef Name , DIFile *File , unsigned Line , DIScope *Scope , DIType *BaseType , uint64_t SizeInBits , uint32_t AlignInBits , uint64_t OffsetInBits , DIFlags Flags , DINodeArray Elements , unsigned RuntimeLang , std::optional< uint32_t > EnumKind , DIType *VTableHolder , DITemplateParameterArray TemplateParams =nullptr, StringRef Identifier ="", DIDerivedType *Discriminator =nullptr, Metadata *DataLocation =nullptr, Metadata *Associated =nullptr, Metadata *Allocated =nullptr, Metadata *Rank =nullptr, DINodeArray Annotations =nullptr, DIType *Specification =nullptr, uint32_t NumExtraInhabitants =0, Metadata *BitStride =nullptr)
,
(Tag , Name , File , Line , Scope , BaseType , SizeInBits , AlignInBits , OffsetInBits , Specification , NumExtraInhabitants , Flags , Elements , RuntimeLang , EnumKind , VTableHolder , TemplateParams , Identifier , Discriminator , DataLocation , Associated , Allocated , Rank , Annotations , BitStride )
)
References AlignInBits , Allocated , Annotations , Associated , BaseType , BitStride , DataLocation , Discriminator , llvm::DIType::DIType() , Elements , File , Flags , Identifier , Line , Name , NumExtraInhabitants , OffsetInBits , Rank , Scope , SizeInBits , Specification , Tag , TemplateParams , and VTableHolder .
◆ getAllocated()
DIVariable * llvm::DICompositeType::getAllocated ( ) const
inline
◆ getAllocatedExp()
DIExpression * llvm::DICompositeType::getAllocatedExp ( ) const
inline
◆ getAnnotations()
DINodeArray llvm::DICompositeType::getAnnotations ( ) const
inline
◆ getAssociated()
DIVariable * llvm::DICompositeType::getAssociated ( ) const
inline
◆ getAssociatedExp()
DIExpression * llvm::DICompositeType::getAssociatedExp ( ) const
inline
◆ getBaseType()
DIType * llvm::DICompositeType::getBaseType ( ) const
inline
◆ getBitStrideConst()
ConstantInt * llvm::DICompositeType::getBitStrideConst ( ) const
inline
◆ getDataLocation()
DIVariable * llvm::DICompositeType::getDataLocation ( ) const
inline
◆ getDataLocationExp()
DIExpression * llvm::DICompositeType::getDataLocationExp ( ) const
inline
◆ getDiscriminator()
DIDerivedType * llvm::DICompositeType::getDiscriminator ( ) const
inline
◆ getElements()
DINodeArray llvm::DICompositeType::getElements ( ) const
inline
◆ getEnumKind()
std::optional< uint32_t > llvm::DICompositeType::getEnumKind ( ) const
inline
◆ getIdentifier()
StringRef llvm::DICompositeType::getIdentifier ( ) const
inline
◆ getODRTypeIfExists()◆ getRankConst()
ConstantInt * llvm::DICompositeType::getRankConst ( ) const
inline
◆ getRankExp()
DIExpression * llvm::DICompositeType::getRankExp ( ) const
inline
◆ getRawAllocated()
Metadata * llvm::DICompositeType::getRawAllocated ( ) const
inline
◆ getRawAnnotations()
Metadata * llvm::DICompositeType::getRawAnnotations ( ) const
inline
◆ getRawAssociated()
Metadata * llvm::DICompositeType::getRawAssociated ( ) const
inline
◆ getRawBaseType()
Metadata * llvm::DICompositeType::getRawBaseType ( ) const
inline
◆ getRawBitStride()
Metadata * llvm::DICompositeType::getRawBitStride ( ) const
inline
◆ getRawDataLocation()
Metadata * llvm::DICompositeType::getRawDataLocation ( ) const
inline
◆ getRawDiscriminator()
Metadata * llvm::DICompositeType::getRawDiscriminator ( ) const
inline
◆ getRawElements()
Metadata * llvm::DICompositeType::getRawElements ( ) const
inline
◆ getRawIdentifier()
MDString * llvm::DICompositeType::getRawIdentifier ( ) const
inline
◆ getRawRank()
Metadata * llvm::DICompositeType::getRawRank ( ) const
inline
◆ getRawSpecification()
Metadata * llvm::DICompositeType::getRawSpecification ( ) const
inline
◆ getRawTemplateParams()
Metadata * llvm::DICompositeType::getRawTemplateParams ( ) const
inline
◆ getRawVTableHolder()
Metadata * llvm::DICompositeType::getRawVTableHolder ( ) const
inline
◆ getRuntimeLang()
unsigned llvm::DICompositeType::getRuntimeLang ( ) const
inline
◆ getSpecification()
DIType * llvm::DICompositeType::getSpecification ( ) const
inline
◆ getTemplateParams()
DITemplateParameterArray llvm::DICompositeType::getTemplateParams ( ) const
inline
◆ getVTableHolder()
DIType * llvm::DICompositeType::getVTableHolder ( ) const
inline
◆ replaceElements()
void llvm::DICompositeType::replaceElements ( DINodeArray Elements )
inline
◆ replaceTemplateParams()
void llvm::DICompositeType::replaceTemplateParams ( DITemplateParameterArray TemplateParams )
inline
◆ replaceVTableHolder()
void llvm::DICompositeType::replaceVTableHolder ( DIType * VTableHolder )
inline
◆ LLVMContextImpl◆ MDNodeDefinition at line 1629 of file DebugInfoMetadata.h .
References AbstractManglingParser< Derived, Alloc >::Ops , AlignInBits , llvm::CallingConv::C , llvm::DIType::DIType() , Flags , Line , MDNode , llvm::DIType::N_OPERANDS , NumExtraInhabitants , llvm::Metadata::Storage , and Tag .
Referenced by MDNode .
◆ AlignInBits◆ Allocated◆ Annotations◆ Associated◆ BaseType◆ BitStride◆ DataLocation◆ Discriminator◆ Elements◆ EnumKind◆ File◆ Flags◆ Identifier◆ Line◆ Name◆ OffsetInBits◆ Rank◆ RuntimeLang◆ Scope◆ SizeInBits◆ Specification◆ Tag◆ TemplateParams◆ VTableHolder
The documentation for this class was generated from the following files: