#include "llvm/IR/DebugInfoMetadata.h"

Inheritance diagram for llvm::DILabel:

Public Member Functions
	DEFINE_MDNODE_GET (DILabel,(DILocalScope Scope, StringRef Name, DIFile File, unsigned Line, unsigned Column, bool IsArtificial, std::optional< unsigned > CoroSuspendIdx),(Scope, Name, File, Line, Column, IsArtificial, CoroSuspendIdx)) DEFINE_MDNODE_GET(DILabel
Metadata MDString Metadata unsigned unsigned bool std::optional< unsigned > CoroSuspendIdx TempDILabel	clone () const
DILocalScope *	getScope () const
	Get the local scope for this label.
unsigned	getLine () const
unsigned	getColumn () const
StringRef	getName () const
DIFile *	getFile () const
bool	isArtificial () const
std::optional< unsigned >	getCoroSuspendIdx () const
Metadata *	getRawScope () const
MDString *	getRawName () const
Metadata *	getRawFile () const
bool	isValidLocationForIntrinsic (const DILocation *DL) const
	Check that a location is valid for this label.
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.

Public Attributes
Metadata *	Scope
Metadata MDString *	Name
Metadata MDString Metadata *	File
Metadata MDString Metadata unsigned	Line
Metadata MDString Metadata unsigned unsigned	Column
Metadata MDString Metadata unsigned unsigned bool	IsArtificial
Metadata MDString Metadata unsigned unsigned bool std::optional< unsigned >	CoroSuspendIdx
Metadata MDString Metadata unsigned unsigned bool std::optional< unsigned >	Scope
Metadata MDString Metadata unsigned unsigned bool std::optional< unsigned >	Name
Metadata MDString Metadata unsigned unsigned bool std::optional< unsigned >	File
Metadata MDString Metadata unsigned unsigned bool std::optional< unsigned >	Line
Metadata MDString Metadata unsigned unsigned bool std::optional< unsigned >	Column
Metadata MDString Metadata unsigned unsigned bool std::optional< unsigned >	IsArtificial

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

Label.

Uses the SubclassData32 Metadata slot.

Definition at line 4269 of file DebugInfoMetadata.h.

Member Function Documentation

◆ classof()

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

inlinestatic

Definition at line 4345 of file DebugInfoMetadata.h.

References llvm::Metadata::getMetadataID().

◆ clone()

Metadata MDString Metadata unsigned unsigned bool std::optional< unsigned > CoroSuspendIdx TempDILabel llvm::DILabel::clone ( ) const

inline

Definition at line 4317 of file DebugInfoMetadata.h.

References clone().

Referenced by clone().

◆ DEFINE_MDNODE_GET()

llvm::DILabel::DEFINE_MDNODE_GET	(	DILabel	,
		(DILocalScope Scope, StringRef Name, DIFile File, unsigned Line, unsigned Column, bool IsArtificial, std::optional< unsigned > CoroSuspendIdx)	,
		(Scope, Name, File, Line, Column, IsArtificial, CoroSuspendIdx)	)

References File, Line, Name, and Scope.

◆ getColumn()

unsigned llvm::DILabel::getColumn ( ) const

inline

Definition at line 4326 of file DebugInfoMetadata.h.

Referenced by fixupDebugInfoPostExtraction().

◆ getCoroSuspendIdx()

std::optional< unsigned > llvm::DILabel::getCoroSuspendIdx ( ) const

inline

Definition at line 4330 of file DebugInfoMetadata.h.

Referenced by llvm::DwarfCompileUnit::applyLabelAttributes(), and fixupDebugInfoPostExtraction().

◆ getFile()

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

inline

Definition at line 4328 of file DebugInfoMetadata.h.

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

Referenced by fixupDebugInfoPostExtraction().

◆ getLine()

unsigned llvm::DILabel::getLine ( ) const

inline

Definition at line 4325 of file DebugInfoMetadata.h.

References llvm::Metadata::SubclassData32.

Referenced by fixupDebugInfoPostExtraction().

◆ getName()

StringRef llvm::DILabel::getName ( ) const

inline

Definition at line 4327 of file DebugInfoMetadata.h.

References llvm::DINode::getStringOperand().

Referenced by fixupDebugInfoPostExtraction(), and llvm::DbgLabel::getName().

◆ getRawFile()

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

inline

Definition at line 4334 of file DebugInfoMetadata.h.

References llvm::MDNode::getOperand().

Referenced by getFile().

◆ getRawName()

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

inline

Definition at line 4333 of file DebugInfoMetadata.h.

References llvm::DINode::getOperandAs().

◆ getRawScope()

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

inline

Definition at line 4332 of file DebugInfoMetadata.h.

References llvm::MDNode::getOperand().

Referenced by getScope().

◆ getScope()

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

inline

Get the local scope for this label.

Labels must be defined in a local scope.

Definition at line 4322 of file DebugInfoMetadata.h.

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

Referenced by fixupDebugInfoPostExtraction(), llvm::DIBuilder::insertLabel(), and isValidLocationForIntrinsic().

◆ isArtificial()

bool llvm::DILabel::isArtificial ( ) const

inline

Definition at line 4329 of file DebugInfoMetadata.h.

Referenced by llvm::DwarfCompileUnit::applyLabelAttributes(), and fixupDebugInfoPostExtraction().

◆ isValidLocationForIntrinsic()

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

inline

Check that a location is valid for this label.

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

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

Referenced by llvm::calculateDbgEntityHistory().