LLVM 20.0.0git
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Friends | List of all members
llvm::DIBasicType Class Reference

Basic type, like 'int' or 'float'. More...

#include "llvm/IR/DebugInfoMetadata.h"

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

Public Types

enum class  Signedness { Signed , Unsigned }
 
- 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 Member Functions

 DEFINE_MDNODE_GET (DIBasicType,(unsigned Tag, StringRef Name),(Tag, Name, 0, 0, 0, FlagZero)) DEFINE_MDNODE_GET(DIBasicType
 
unsigned StringRef uint64_t FlagZero DEFINE_MDNODE_GET (DIBasicType,(unsigned Tag, MDString *Name, uint64_t SizeInBits),(Tag, Name, SizeInBits, 0, 0, FlagZero)) DEFINE_MDNODE_GET(DIBasicType
 
unsigned StringRef uint64_t FlagZero unsigned StringRef uint64_t uint32_t unsigned DIFlags Flags DEFINE_MDNODE_GET (DIBasicType,(unsigned Tag, MDString *Name, uint64_t SizeInBits, uint32_t AlignInBits, unsigned Encoding, DIFlags Flags),(Tag, Name, SizeInBits, AlignInBits, Encoding, Flags)) TempDIBasicType clone() const
 
unsigned getEncoding () const
 
std::optional< SignednessgetSignedness () const
 Return the signedness of this type, or std::nullopt if this type is neither signed nor unsigned.
 
- Public Member Functions inherited from llvm::DIType
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::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 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.
 

Public Attributes

unsigned Tag
 
unsigned StringRef Name
 
unsigned StringRef uint64_t SizeInBits
 
unsigned StringRef uint64_t Tag
 
unsigned StringRef uint64_t Name
 
unsigned StringRef uint64_t FlagZero unsigned Tag
 
unsigned StringRef uint64_t FlagZero unsigned StringRef Name
 
unsigned StringRef uint64_t FlagZero unsigned StringRef uint64_t SizeInBits
 
unsigned StringRef uint64_t FlagZero unsigned StringRef uint64_t uint32_t AlignInBits
 
unsigned StringRef uint64_t FlagZero unsigned StringRef uint64_t uint32_t unsigned Encoding
 
unsigned StringRef uint64_t FlagZero unsigned StringRef uint64_t uint32_t unsigned DIFlags Flags
 
unsigned StringRef uint64_t FlagZero unsigned StringRef uint64_t uint32_t unsigned DIFlags Tag
 
unsigned StringRef uint64_t FlagZero unsigned StringRef uint64_t uint32_t unsigned DIFlags Name
 
unsigned StringRef uint64_t FlagZero unsigned StringRef uint64_t uint32_t unsigned DIFlags SizeInBits
 
unsigned StringRef uint64_t FlagZero unsigned StringRef uint64_t uint32_t unsigned DIFlags AlignInBits
 
unsigned StringRef uint64_t FlagZero unsigned StringRef uint64_t uint32_t unsigned DIFlags Encoding
 

Friends

class LLVMContextImpl
 
class MDNode
 

Additional Inherited Members

- Protected Types inherited from llvm::MDNode
using mutable_op_range = iterator_range< MDOperand * >
 
 Active type of storage. More...
- Protected Member Functions inherited from 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)
 
 ~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.
 
- 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

Basic type, like 'int' or 'float'.

TODO: Split out DW_TAG_unspecified_type. TODO: Drop unused accessors.

Definition at line 815 of file DebugInfoMetadata.h.

Member Enumeration Documentation

◆ Signedness

enum class llvm::DIBasicType::Signedness
strong
Enumerator
Signed 
Unsigned 

Definition at line 871 of file DebugInfoMetadata.h.

Member Function Documentation

◆ classof()

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

Definition at line 877 of file DebugInfoMetadata.h.

References llvm::Metadata::getMetadataID().

◆ DEFINE_MDNODE_GET() [1/3]

unsigned StringRef uint64_t FlagZero llvm::DIBasicType::DEFINE_MDNODE_GET ( DIBasicType  ,
(unsigned Tag, MDString *Name, uint64_t SizeInBits ,
(Tag, Name, SizeInBits, 0, 0, FlagZero)   
)

◆ DEFINE_MDNODE_GET() [2/3]

unsigned StringRef uint64_t FlagZero unsigned StringRef uint64_t uint32_t unsigned DIFlags Flags llvm::DIBasicType::DEFINE_MDNODE_GET ( DIBasicType  ,
(unsigned Tag, MDString *Name, uint64_t SizeInBits, uint32_t AlignInBits, unsigned Encoding, DIFlags Flags ,
(Tag, Name, SizeInBits, AlignInBits, Encoding, Flags  
) const
inline

Definition at line 862 of file DebugInfoMetadata.h.

◆ DEFINE_MDNODE_GET() [3/3]

llvm::DIBasicType::DEFINE_MDNODE_GET ( DIBasicType  ,
(unsigned Tag, StringRef Name ,
(Tag, Name, 0, 0, 0, FlagZero)   
)

◆ getEncoding()

unsigned llvm::DIBasicType::getEncoding ( ) const
inline

Definition at line 869 of file DebugInfoMetadata.h.

Referenced by getSignedness().

◆ getSignedness()

std::optional< DIBasicType::Signedness > DIBasicType::getSignedness ( ) const

Return the signedness of this type, or std::nullopt if this type is neither signed nor unsigned.

Definition at line 676 of file DebugInfoMetadata.cpp.

References getEncoding(), Signed, and Unsigned.

Friends And Related Function Documentation

◆ LLVMContextImpl

friend class LLVMContextImpl
friend

Definition at line 816 of file DebugInfoMetadata.h.

◆ MDNode

friend class MDNode
friend

Definition at line 817 of file DebugInfoMetadata.h.

Member Data Documentation

◆ AlignInBits [1/2]

unsigned StringRef uint64_t FlagZero unsigned StringRef uint64_t uint32_t llvm::DIBasicType::AlignInBits

Definition at line 860 of file DebugInfoMetadata.h.

◆ AlignInBits [2/2]

unsigned StringRef uint64_t FlagZero unsigned StringRef uint64_t uint32_t unsigned DIFlags llvm::DIBasicType::AlignInBits

Definition at line 861 of file DebugInfoMetadata.h.

◆ Encoding [1/2]

unsigned StringRef uint64_t FlagZero unsigned StringRef uint64_t uint32_t unsigned llvm::DIBasicType::Encoding

Definition at line 860 of file DebugInfoMetadata.h.

◆ Encoding [2/2]

Definition at line 861 of file DebugInfoMetadata.h.

◆ Flags

Definition at line 860 of file DebugInfoMetadata.h.

◆ Name [1/4]

unsigned StringRef llvm::DIBasicType::Name

Definition at line 853 of file DebugInfoMetadata.h.

◆ Name [2/4]

unsigned StringRef uint64_t llvm::DIBasicType::Name

Definition at line 854 of file DebugInfoMetadata.h.

◆ Name [3/4]

unsigned StringRef uint64_t FlagZero unsigned StringRef llvm::DIBasicType::Name

Definition at line 859 of file DebugInfoMetadata.h.

◆ Name [4/4]

Definition at line 861 of file DebugInfoMetadata.h.

◆ SizeInBits [1/3]

unsigned StringRef uint64_t llvm::DIBasicType::SizeInBits

Definition at line 853 of file DebugInfoMetadata.h.

◆ SizeInBits [2/3]

unsigned StringRef uint64_t FlagZero unsigned StringRef uint64_t llvm::DIBasicType::SizeInBits

Definition at line 859 of file DebugInfoMetadata.h.

◆ SizeInBits [3/3]

unsigned StringRef uint64_t FlagZero unsigned StringRef uint64_t uint32_t unsigned DIFlags llvm::DIBasicType::SizeInBits

Definition at line 861 of file DebugInfoMetadata.h.

◆ Tag [1/4]

unsigned llvm::DIBasicType::Tag

Definition at line 853 of file DebugInfoMetadata.h.

◆ Tag [2/4]

unsigned StringRef uint64_t llvm::DIBasicType::Tag

Definition at line 854 of file DebugInfoMetadata.h.

◆ Tag [3/4]

unsigned StringRef uint64_t FlagZero unsigned llvm::DIBasicType::Tag

Definition at line 859 of file DebugInfoMetadata.h.

◆ Tag [4/4]

Definition at line 861 of file DebugInfoMetadata.h.


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