LLVM 19.0.0git
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
llvm::DIType Class Reference

Base class for types. More...

#include "llvm/IR/DebugInfoMetadata.h"

Inheritance diagram for llvm::DIType:
Inheritance graph
[legend]

Public Member Functions

TempDIType clone () const
 
unsigned getLine () const
 
uint64_t getSizeInBits () const
 
uint32_t getAlignInBits () const
 
uint32_t getAlignInBytes () const
 
uint64_t getOffsetInBits () const
 
DIFlags getFlags () const
 
DIScopegetScope () const
 
StringRef getName () const
 
MetadatagetRawScope () const
 
MDStringgetRawName () 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
DIFilegetFile () const
 
StringRef getFilename () const
 
StringRef getDirectory () const
 
std::optional< StringRefgetSource () const
 
StringRef getName () const
 
DIScopegetScope () const
 
MetadatagetRawFile () const
 Return the raw underlying file.
 
- Public Member Functions inherited from llvm::DINode
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
 
TempMDNode clone () const
 Create a (temporary) clone of this.
 
LLVMContextgetContext () const
 
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
 
unsigned getNumTemporaryUses () const
 
void replaceAllUsesWith (Metadata *MD)
 RAUW a temporary.
 
void resolveCycles ()
 Resolve cycles.
 
void resolve ()
 Resolve a unique, unresolved node.
 
op_iterator op_begin () const
 
op_iterator op_end () const
 
ArrayRef< MDOperandoperands () const
 
const MDOperandgetOperand (unsigned I) const
 
unsigned getNumOperands () const
 Return number of MDNode operands.
 
bool isTBAAVtableAccess () const
 Check whether MDNode is a vtable access.
 
void printTree (raw_ostream &OS, const Module *M=nullptr) const
 Print in tree shape.
 
void printTree (raw_ostream &OS, ModuleSlotTracker &MST, const Module *M=nullptr) const
 
void dumpTree () const
 User-friendly dump in tree shape.
 
void dumpTree (const Module *M) 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 DIFlags getFlag (StringRef Flag)
 
static StringRef getFlagString (DIFlags Flag)
 
static 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 MDTupleget (LLVMContext &Context, ArrayRef< Metadata * > MDs)
 
static MDTuplegetIfExists (LLVMContext &Context, ArrayRef< Metadata * > MDs)
 
static MDTuplegetDistinct (LLVMContext &Context, ArrayRef< Metadata * > MDs)
 
static TempMDTuple getTemporary (LLVMContext &Context, ArrayRef< Metadata * > MDs)
 
static 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 MDNodeconcatenate (MDNode *A, MDNode *B)
 Methods for metadata merging.
 
static MDNodeintersect (MDNode *A, MDNode *B)
 
static MDNodegetMostGenericTBAA (MDNode *A, MDNode *B)
 
static MDNodegetMostGenericFPMath (MDNode *A, MDNode *B)
 
static MDNodegetMostGenericRange (MDNode *A, MDNode *B)
 
static MDNodegetMostGenericAliasScope (MDNode *A, MDNode *B)
 
static MDNodegetMostGenericAlignmentOrDereferenceable (MDNode *A, MDNode *B)
 
static MDNodegetMergedProfMetadata (MDNode *A, MDNode *B, const Instruction *AInstr, const Instruction *BInstr)
 Merge !prof metadata from two instructions.
 

Protected Member Functions

 DIType (LLVMContext &C, unsigned ID, StorageType Storage, unsigned Tag, unsigned Line, uint64_t SizeInBits, uint32_t AlignInBits, uint64_t OffsetInBits, DIFlags Flags, ArrayRef< Metadata * > Ops)
 
 ~DIType ()=default
 
void init (unsigned Line, uint64_t SizeInBits, uint32_t AlignInBits, uint64_t OffsetInBits, DIFlags Flags)
 
void mutate (unsigned Tag, unsigned Line, uint64_t SizeInBits, uint32_t AlignInBits, uint64_t OffsetInBits, 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=std::nullopt)
 
 ~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
 MDNode (LLVMContext &Context, unsigned ID, StorageType Storage, ArrayRef< Metadata * > Ops1, ArrayRef< Metadata * > Ops2=std::nullopt)
 
 ~MDNode ()=default
 
void * operator new (size_t Size, size_t NumOps, StorageType Storage)
 
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.
 
void dropAllReferences ()
 
MDOperandmutable_begin ()
 
MDOperandmutable_end ()
 
mutable_op_range mutable_operands ()
 
void setOperand (unsigned I, Metadata *New)
 Set an operand.
 
unsigned getNumUnresolved () const
 
void setNumUnresolved (unsigned N)
 
void storeDistinctInContext ()
 
void resize (size_t NumOps)
 Resize the node to hold NumOps operands.
 

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 >
 
- Protected Types inherited from llvm::MDNode
using mutable_op_range = iterator_range< MDOperand * >
 
 Active type of storage. More...
- Static Protected Member Functions inherited from llvm::DINode
static MDStringgetCanonicalMDString (LLVMContext &Context, StringRef S)
 
- Static Protected Member Functions inherited from llvm::MDNode
template<class T , class StoreT >
static TstoreImpl (T *N, StorageType Storage, StoreT &Store)
 
template<class T >
static TstoreImpl (T *N, StorageType Storage)
 

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 710 of file DebugInfoMetadata.h.

Constructor & Destructor Documentation

◆ DIType()

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

Definition at line 717 of file DebugInfoMetadata.h.

References init().

◆ ~DIType()

llvm::DIType::~DIType ( )
protecteddefault

Member Function Documentation

◆ classof()

static bool llvm::DIType::classof ( const Metadata MD)
inlinestatic

Definition at line 797 of file DebugInfoMetadata.h.

References llvm::Metadata::getMetadataID().

◆ clone()

TempDIType llvm::DIType::clone ( ) const
inline

Definition at line 743 of file DebugInfoMetadata.h.

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

Referenced by cloneWithFlags().

◆ cloneWithFlags()

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

Returns a new temporary DIType with updated Flags.

Definition at line 761 of file DebugInfoMetadata.h.

References clone().

Referenced by createTypeWithFlags().

◆ getAlignInBits()

uint32_t DIType::getAlignInBits ( ) const

Definition at line 37 of file DebugInfoMetadata.cpp.

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

Referenced by getAlignInBytes(), and solveDIType().

◆ getAlignInBytes()

uint32_t llvm::DIType::getAlignInBytes ( ) const
inline

◆ getExportSymbols()

bool llvm::DIType::getExportSymbols ( ) const
inline

Definition at line 795 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 747 of file DebugInfoMetadata.h.

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

◆ getName()

StringRef llvm::DIType::getName ( ) const
inline

◆ getOffsetInBits()

uint64_t llvm::DIType::getOffsetInBits ( ) const
inline

Definition at line 751 of file DebugInfoMetadata.h.

◆ getRawName()

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

Definition at line 758 of file DebugInfoMetadata.h.

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

◆ getRawScope()

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

Definition at line 757 of file DebugInfoMetadata.h.

References llvm::MDNode::getOperand().

Referenced by getScope().

◆ getScope()

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

◆ getSizeInBits()

uint64_t llvm::DIType::getSizeInBits ( ) const
inline

◆ init()

void llvm::DIType::init ( unsigned  Line,
uint64_t  SizeInBits,
uint32_t  AlignInBits,
uint64_t  OffsetInBits,
DIFlags  Flags 
)
inlineprotected

Definition at line 725 of file DebugInfoMetadata.h.

References llvm::Metadata::SubclassData32.

Referenced by DIType(), and mutate().

◆ isAppleBlockExtension()

bool llvm::DIType::isAppleBlockExtension ( ) const
inline

Definition at line 777 of file DebugInfoMetadata.h.

References getFlags().

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

◆ isArtificial()

bool llvm::DIType::isArtificial ( ) const
inline

◆ isBigEndian()

bool llvm::DIType::isBigEndian ( ) const
inline

Definition at line 793 of file DebugInfoMetadata.h.

References getFlags().

◆ isBitField()

bool llvm::DIType::isBitField ( ) const
inline

Definition at line 785 of file DebugInfoMetadata.h.

References getFlags().

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

◆ isForwardDecl()

bool llvm::DIType::isForwardDecl ( ) const
inline

◆ isLittleEndian()

bool llvm::DIType::isLittleEndian ( ) const
inline

Definition at line 794 of file DebugInfoMetadata.h.

References getFlags().

◆ isLValueReference()

bool llvm::DIType::isLValueReference ( ) const
inline

Definition at line 787 of file DebugInfoMetadata.h.

References getFlags().

◆ isObjcClassComplete()

bool llvm::DIType::isObjcClassComplete ( ) const
inline

Definition at line 781 of file DebugInfoMetadata.h.

References getFlags().

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

◆ isObjectPointer()

bool llvm::DIType::isObjectPointer ( ) const
inline

Definition at line 780 of file DebugInfoMetadata.h.

References getFlags().

Referenced by llvm::DIBuilder::createObjectPointerType().

◆ isPrivate()

bool llvm::DIType::isPrivate ( ) const
inline

Definition at line 767 of file DebugInfoMetadata.h.

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

◆ isProtected()

bool llvm::DIType::isProtected ( ) const
inline

Definition at line 770 of file DebugInfoMetadata.h.

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

◆ isPublic()

bool llvm::DIType::isPublic ( ) const
inline

Definition at line 773 of file DebugInfoMetadata.h.

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

◆ isRValueReference()

bool llvm::DIType::isRValueReference ( ) const
inline

Definition at line 788 of file DebugInfoMetadata.h.

References getFlags().

◆ isStaticMember()

bool llvm::DIType::isStaticMember ( ) const
inline

◆ isTypePassByReference()

bool llvm::DIType::isTypePassByReference ( ) const
inline

Definition at line 790 of file DebugInfoMetadata.h.

References getFlags().

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

◆ isTypePassByValue()

bool llvm::DIType::isTypePassByValue ( ) const
inline

Definition at line 789 of file DebugInfoMetadata.h.

References getFlags().

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

◆ isVector()

bool llvm::DIType::isVector ( ) const
inline

Definition at line 784 of file DebugInfoMetadata.h.

References getFlags().

Referenced by hasVectorBeenPadded().

◆ isVirtual()

bool llvm::DIType::isVirtual ( ) const
inline

Definition at line 778 of file DebugInfoMetadata.h.

References getFlags().

◆ mutate()

void llvm::DIType::mutate ( unsigned  Tag,
unsigned  Line,
uint64_t  SizeInBits,
uint32_t  AlignInBits,
uint64_t  OffsetInBits,
DIFlags  Flags 
)
inlineprotected

Change fields in place.

Definition at line 735 of file DebugInfoMetadata.h.

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


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