llvm::DIVariable Class Reference

Base class for variables. More...

#include "llvm/IR/DebugInfoMetadata.h"

Inheritance diagram for llvm::DIVariable:

Public Member Functions
unsigned	getLine () const
DIScope *	getScope () const
StringRef	getName () const
DIFile *	getFile () const
DIType *	getType () const
uint32_t	getAlignInBits () const
uint32_t	getAlignInBytes () const
LLVM_ABI std::optional< uint64_t >	getSizeInBits () const
	Determines the size of the variable's type.
std::optional< DIBasicType::Signedness >	getSignedness () const
	Return the signedness of this variable's type, or std::nullopt if this type is neither signed nor unsigned.
StringRef	getFilename () const
StringRef	getDirectory () const
std::optional< StringRef >	getSource () const
Metadata *	getRawScope () const
MDString *	getRawName () const
Metadata *	getRawFile () const
Metadata *	getRawType () const
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
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::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 *	getMostGenericNoFPClass (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 MDNode *	getMergedAllocTokenMetadata (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
LLVM_ABI	DIVariable (LLVMContext &C, unsigned ID, StorageType Storage, signed Line, ArrayRef< Metadata * > Ops, uint32_t AlignInBits=0)
	~DIVariable ()=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.

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 variables.

Uses the SubclassData32 Metadata slot.

Definition at line 3406 of file DebugInfoMetadata.h.

Constructor & Destructor Documentation

DIVariable()

DIVariable::DIVariable ( LLVMContext & C, unsigned ID, StorageType Storage, signed Line, ArrayRef< Metadata * > Ops, uint32_t AlignInBits = 0 )

protected

Definition at line 1647 of file DebugInfoMetadata.cpp.

References AbstractManglingParser< Derived, Alloc >::Ops, C(), llvm::DINode::DINode(), llvm::Metadata::Storage, and llvm::Metadata::SubclassData32.

Referenced by llvm::DIGlobalVariable::MDNode, and llvm::DILocalVariable::MDNode.

~DIVariable()

llvm::DIVariable::~DIVariable ( )

protecteddefault

Member Function Documentation

classof()

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

inlinestatic

Definition at line 3457 of file DebugInfoMetadata.h.

References llvm::Metadata::getMetadataID().

getAlignInBits()

uint32_t llvm::DIVariable::getAlignInBits ( ) const

inline

Definition at line 3421 of file DebugInfoMetadata.h.

References llvm::Metadata::SubclassData32.

Referenced by FixupDebugInfoForOutlinedFunction(), and getAlignInBytes().

getAlignInBytes()

uint32_t llvm::DIVariable::getAlignInBytes ( ) const

inline

Definition at line 3422 of file DebugInfoMetadata.h.

References getAlignInBits().

Referenced by llvm::DwarfCompileUnit::getOrCreateGlobalVariableDIE().

getDirectory()

StringRef llvm::DIVariable::getDirectory ( ) const

inline

Definition at line 3440 of file DebugInfoMetadata.h.

References F, and getFile().

getFile()

DIFile * llvm::DIVariable::getFile ( ) const

inline

Definition at line 3419 of file DebugInfoMetadata.h.

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

Referenced by llvm::SPIRVNonSemanticDebugHandler::emitNonSemanticDebugStrings(), FixupDebugInfoForOutlinedFunction(), getDirectory(), getFilename(), and getSource().

getFilename()

StringRef llvm::DIVariable::getFilename ( ) const

inline

Definition at line 3434 of file DebugInfoMetadata.h.

References F, and getFile().

getLine()

unsigned llvm::DIVariable::getLine ( ) const

inline

Definition at line 3416 of file DebugInfoMetadata.h.

Referenced by FixupDebugInfoForOutlinedFunction().

getName()

StringRef llvm::DIVariable::getName ( ) const

inline

Definition at line 3418 of file DebugInfoMetadata.h.

References llvm::DINode::getStringOperand().

Referenced by llvm::DwarfCompileUnit::addLocationAttribute(), llvm::SPIRVNonSemanticDebugHandler::emitNonSemanticDebugStrings(), FixupDebugInfoForOutlinedFunction(), llvm::DbgVariable::getName(), llvm::DwarfCompileUnit::getOrCreateGlobalVariableDIE(), llvm::DbgValueRangeTable::printValues(), and remarkAlloca().

getRawFile()

Metadata * llvm::DIVariable::getRawFile ( ) const

inline

Definition at line 3454 of file DebugInfoMetadata.h.

References llvm::MDNode::getOperand().

Referenced by getFile().

getRawName()

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

inline

Definition at line 3453 of file DebugInfoMetadata.h.

References llvm::DINode::getOperandAs().

getRawScope()

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

inline

Definition at line 3452 of file DebugInfoMetadata.h.

References llvm::MDNode::getOperand().

Referenced by getScope().

getRawType()

Metadata * llvm::DIVariable::getRawType ( ) const

inline

Definition at line 3455 of file DebugInfoMetadata.h.

References llvm::MDNode::getOperand().

Referenced by getSizeInBits(), and getType().

getScope()

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

inline

Definition at line 3417 of file DebugInfoMetadata.h.

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

Referenced by llvm::DwarfDebug::endModule(), llvm::DwarfCompileUnit::getOrCreateGlobalVariableDIE(), and llvm::DILocalVariable::getScope().

getSignedness()

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

inline

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

Definition at line 3428 of file DebugInfoMetadata.h.

References llvm::dyn_cast(), and getType().

Referenced by llvm::DIExpression::getActiveBits(), and llvm::replaceAllDbgUsesWith().

getSizeInBits()

std::optional< uint64_t > DIVariable::getSizeInBits

(

)

const

Determines the size of the variable's type.

Definition at line 1653 of file DebugInfoMetadata.cpp.

References llvm::dyn_cast(), getRawType(), Size, and T.

Referenced by emitDbgAssign(), LiveDebugValues::MLocTracker::emitLoc(), llvm::DIExpression::getActiveBits(), llvm::DbgVariableIntrinsic::getFragmentSizeInBits(), llvm::DbgVariableRecord::getFragmentSizeInBits(), and llvm::SelectionDAGBuilder::handleDebugValue().

getSource()

std::optional< StringRef > llvm::DIVariable::getSource ( ) const

inline

Definition at line 3446 of file DebugInfoMetadata.h.

References F, and getFile().

getType()

DIType * llvm::DIVariable::getType ( ) const

inline

Definition at line 3420 of file DebugInfoMetadata.h.

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

Referenced by FixupDebugInfoForOutlinedFunction(), llvm::DwarfCompileUnit::getOrCreateGlobalVariableDIE(), getSignedness(), llvm::DbgVariable::getType(), isCompositeType(), llvm::DebugInfoFinder::processVariable(), and transferSRADebugInfo().

---

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

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