Local variable. More...

#include "llvm/IR/DebugInfoMetadata.h"

Inheritance diagram for llvm::DILocalVariable:

Public Member Functions
	DEFINE_MDNODE_GET (DILocalVariable,(DILocalScope Scope, StringRef Name, DIFile File, unsigned Line, DIType *Type, unsigned Arg, DIFlags Flags, uint32_t AlignInBits, DINodeArray Annotations),(Scope, Name, File, Line, Type, Arg, Flags, AlignInBits, Annotations)) DEFINE_MDNODE_GET(DILocalVariable
Metadata MDString Metadata unsigned Metadata unsigned DIFlags uint32_t Metadata Annotations TempDILocalVariable	clone () const
DILocalScope *	getScope () const
	Get the local scope for this variable.
bool	isParameter () const
unsigned	getArg () const
DIFlags	getFlags () const
DINodeArray	getAnnotations () const
Metadata *	getRawAnnotations () const
bool	isArtificial () const
bool	isObjectPointer () const
bool	isValidLocationForIntrinsic (const DILocation *DL) const
	Check that a location is valid for this variable.
Public Member Functions inherited from llvm::DIVariable
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
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::DIVariable
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
Metadata *	Scope
Metadata MDString *	Name
Metadata MDString Metadata *	File
Metadata MDString Metadata unsigned	Line
Metadata MDString Metadata unsigned Metadata *	Type
Metadata MDString Metadata unsigned Metadata unsigned	Arg
Metadata MDString Metadata unsigned Metadata unsigned DIFlags	Flags
Metadata MDString Metadata unsigned Metadata unsigned DIFlags uint32_t	AlignInBits
Metadata MDString Metadata unsigned Metadata unsigned DIFlags uint32_t Metadata *	Annotations
Metadata MDString Metadata unsigned Metadata unsigned DIFlags uint32_t Metadata	Scope
Metadata MDString Metadata unsigned Metadata unsigned DIFlags uint32_t Metadata	Name
Metadata MDString Metadata unsigned Metadata unsigned DIFlags uint32_t Metadata	File
Metadata MDString Metadata unsigned Metadata unsigned DIFlags uint32_t Metadata	Line
Metadata MDString Metadata unsigned Metadata unsigned DIFlags uint32_t Metadata	Type
Metadata MDString Metadata unsigned Metadata unsigned DIFlags uint32_t Metadata	Arg
Metadata MDString Metadata unsigned Metadata unsigned DIFlags uint32_t Metadata	Flags
Metadata MDString Metadata unsigned Metadata unsigned DIFlags uint32_t Metadata	AlignInBits

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::DIVariable
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.
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

Local variable.

TODO: Split up flags.

Definition at line 4006 of file DebugInfoMetadata.h.

Member Function Documentation

◆ classof()

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

inlinestatic

Definition at line 4088 of file DebugInfoMetadata.h.

References llvm::Metadata::getMetadataID().

◆ clone()

Metadata MDString Metadata unsigned Metadata unsigned DIFlags uint32_t Metadata Annotations TempDILocalVariable llvm::DILocalVariable::clone ( ) const

inline

Definition at line 4058 of file DebugInfoMetadata.h.

References clone().

Referenced by clone().

◆ DEFINE_MDNODE_GET()

llvm::DILocalVariable::DEFINE_MDNODE_GET	(	DILocalVariable	,
		(DILocalScope Scope, StringRef Name, DIFile File, unsigned Line, DIType *Type, unsigned Arg, DIFlags Flags, uint32_t AlignInBits, DINodeArray Annotations)	,
		(Scope, Name, File, Line, Type, Arg, Flags, AlignInBits, Annotations)	)

References AlignInBits, Annotations, File, Line, Name, Scope, and Type.

◆ getAnnotations()

DINodeArray llvm::DILocalVariable::getAnnotations ( ) const

inline

Definition at line 4071 of file DebugInfoMetadata.h.

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

Referenced by FixupDebugInfoForOutlinedFunction().

◆ getArg()

unsigned llvm::DILocalVariable::getArg ( ) const

inline

Definition at line 4068 of file DebugInfoMetadata.h.

Referenced by llvm::DwarfFile::addScopeVariable(), and FixupDebugInfoForOutlinedFunction().

◆ getFlags()

DIFlags llvm::DILocalVariable::getFlags ( ) const

inline

Definition at line 4069 of file DebugInfoMetadata.h.

Referenced by FixupDebugInfoForOutlinedFunction(), isArtificial(), and isObjectPointer().

◆ getRawAnnotations()

Metadata * llvm::DILocalVariable::getRawAnnotations ( ) const

inline

Definition at line 4074 of file DebugInfoMetadata.h.

References llvm::MDNode::getOperand().

Referenced by getAnnotations().

◆ getScope()

DILocalScope * llvm::DILocalVariable::getScope ( ) const

inline

Get the local scope for this variable.

Variables must be defined in a local scope.

Definition at line 4063 of file DebugInfoMetadata.h.

References llvm::cast(), and llvm::DIVariable::getScope().

Referenced by llvm::DebugHandlerBase::beginFunction(), TransferTracker::emitMOLoc(), FixupDebugInfoForOutlinedFunction(), llvm::DIBuilder::insertDeclare(), isValidLocationForIntrinsic(), llvm::DroppedVariableStats::populateVarIDSetAndInlinedMap(), and llvm::DebugInfoFinder::processVariable().

◆ isArtificial()

bool llvm::DILocalVariable::isArtificial ( ) const

inline

Definition at line 4076 of file DebugInfoMetadata.h.

References getFlags().

◆ isObjectPointer()

bool llvm::DILocalVariable::isObjectPointer ( ) const

inline

Definition at line 4077 of file DebugInfoMetadata.h.

References getFlags().

◆ isParameter()

bool llvm::DILocalVariable::isParameter ( ) const

inline

Definition at line 4067 of file DebugInfoMetadata.h.

Referenced by llvm::DebugHandlerBase::beginFunction(), llvm::SelectionDAGBuilder::handleDebugDeclare(), llvm::SelectionDAGBuilder::handleDebugValue(), and TransferTracker::isEntryValueVariable().

◆ isValidLocationForIntrinsic()

bool llvm::DILocalVariable::isValidLocationForIntrinsic ( const DILocation * DL ) const

inline

Check that a location is valid for this variable.

Check that DL exists, is in the same subprogram, and has the same inlined-at location as this. (Otherwise, it's not a valid attachment to a DbgInfoIntrinsic.)

Definition at line 4084 of file DebugInfoMetadata.h.

References DL, getScope(), and llvm::DILocalScope::getSubprogram().

Referenced by llvm::calculateDbgEntityHistory(), llvm::FastISel::lowerDbgDeclare(), and llvm::SelectionDAGBuilder::resolveDanglingDebugInfo().