Debug lexical block. More...

#include "llvm/IR/DebugInfoMetadata.h"

Inheritance diagram for llvm::DILexicalBlock:

[legend]

Public Member Functions
	DEFINE_MDNODE_GET (DILexicalBlock,(DILocalScope Scope, DIFile File, unsigned Line, unsigned Column),(Scope, File, Line, Column)) DEFINE_MDNODE_GET(DILexicalBlock

Metadata Metadata unsigned unsigned Column TempDILexicalBlock	clone () const

unsigned	getLine () const

unsigned	getColumn () const

Public Member Functions inherited from llvm::DILexicalBlockBase
DILocalScope *	getScope () const

Metadata *	getRawScope () const

void	replaceScope (DIScope *Scope)

Public Member Functions inherited from llvm::DILocalScope
DISubprogram *	getSubprogram () const
	Get the subprogram for this scope.

DILocalScope *	getNonLexicalBlockFileScope () const
	Get the first non DILexicalBlockFile scope of this scope.

Public Member Functions inherited from llvm::DIScope
DIFile *	getFile () const

StringRef	getFilename () const

StringRef	getDirectory () const

std::optional< StringRef >	getSource () const

StringRef	getName () const

DIScope *	getScope () const

Metadata *	getRawFile () 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.

LLVMContext &	getContext () 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< MDOperand >	operands () const

const MDOperand &	getOperand (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

Public Member Functions inherited from llvm::Metadata
unsigned	getMetadataID () const

void	dump () const
	User-friendly dump.

void	dump (const Module *M) const

void	print (raw_ostream &OS, const Module *M=nullptr, bool IsForDebug=false) const
	Print.

void	print (raw_ostream &OS, ModuleSlotTracker &MST, const Module *M=nullptr, bool IsForDebug=false) const

void	printAsOperand (raw_ostream &OS, const Module *M=nullptr) const
	Print as operand.

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::DILexicalBlockBase
static bool	classof (const Metadata *MD)

Static Public Member Functions inherited from llvm::DILocalScope
static DILocalScope *	cloneScopeForSubprogram (DILocalScope &RootScope, DISubprogram &NewSP, LLVMContext &Ctx, DenseMap< const MDNode , MDNode > &Cache)
	Traverses the scope chain rooted at RootScope until it hits a Subprogram, recreating the chain with "NewSP" instead.

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 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 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 MDNode *	concatenate (MDNode A, MDNode B)
	Methods for metadata merging.

static MDNode *	intersect (MDNode A, MDNode B)

static MDNode *	getMostGenericTBAA (MDNode A, MDNode B)

static MDNode *	getMostGenericFPMath (MDNode A, MDNode B)

static MDNode *	getMostGenericRange (MDNode A, MDNode B)

static MDNode *	getMostGenericAliasScope (MDNode A, MDNode B)

static MDNode *	getMostGenericAlignmentOrDereferenceable (MDNode A, MDNode B)

static MDNode *	getMergedProfMetadata (MDNode A, MDNode B, const Instruction AInstr, const Instruction BInstr)
	Merge !prof metadata from two instructions.

Public Attributes
Metadata *	Scope

Metadata Metadata *	File

Metadata Metadata unsigned	Line

Metadata Metadata unsigned unsigned	Column

Metadata Metadata unsigned unsigned	Scope

Metadata Metadata unsigned unsigned	File

Metadata Metadata unsigned unsigned	Line

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

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::DILexicalBlockBase
	DILexicalBlockBase (LLVMContext &C, unsigned ID, StorageType Storage, ArrayRef< Metadata * > Ops)

	~DILexicalBlockBase ()=default

Protected Member Functions inherited from llvm::DILocalScope
	DILocalScope (LLVMContext &C, unsigned ID, StorageType Storage, unsigned Tag, ArrayRef< Metadata * > Ops)

	~DILocalScope ()=default

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 ()

MDOperand *	mutable_begin ()

MDOperand *	mutable_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.

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

Debug lexical block.

Uses the SubclassData32 Metadata slot.

Definition at line 2246 of file DebugInfoMetadata.h.

Member Function Documentation

◆ classof()

static bool llvm::DILexicalBlock::classof ( const Metadata * MD )

inlinestatic

Definition at line 2294 of file DebugInfoMetadata.h.

References llvm::Metadata::getMetadataID().

◆ clone()

Metadata Metadata unsigned unsigned Column TempDILexicalBlock llvm::DILexicalBlock::clone ( ) const

inline

Definition at line 2289 of file DebugInfoMetadata.h.

◆ DEFINE_MDNODE_GET()

llvm::DILexicalBlock::DEFINE_MDNODE_GET	(	DILexicalBlock	,
		(DILocalScope Scope, DIFile File, unsigned Line, unsigned Column)	,
		(Scope, File, Line, Column)
	)

◆ getColumn()

unsigned llvm::DILexicalBlock::getColumn ( ) const

inline

Definition at line 2292 of file DebugInfoMetadata.h.

◆ getLine()

unsigned llvm::DILexicalBlock::getLine ( ) const

inline

Definition at line 2291 of file DebugInfoMetadata.h.

References llvm::Metadata::SubclassData32.

Friends And Related Function Documentation

◆ LLVMContextImpl

friend class LLVMContextImpl

friend

Definition at line 2247 of file DebugInfoMetadata.h.

◆ MDNode

friend class MDNode

friend

Definition at line 2248 of file DebugInfoMetadata.h.

Member Data Documentation

◆ Column

Metadata Metadata unsigned unsigned llvm::DILexicalBlock::Column

Definition at line 2286 of file DebugInfoMetadata.h.

◆ File [1/2]

Metadata Metadata* llvm::DILexicalBlock::File

Definition at line 2285 of file DebugInfoMetadata.h.

◆ File [2/2]

Metadata Metadata unsigned unsigned llvm::DILexicalBlock::File

Definition at line 2287 of file DebugInfoMetadata.h.

◆ Line [1/2]

Metadata Metadata unsigned llvm::DILexicalBlock::Line

Definition at line 2285 of file DebugInfoMetadata.h.

◆ Line [2/2]

Metadata Metadata unsigned unsigned llvm::DILexicalBlock::Line

Definition at line 2287 of file DebugInfoMetadata.h.

◆ Scope [1/2]

Metadata* llvm::DILexicalBlock::Scope

Definition at line 2285 of file DebugInfoMetadata.h.

◆ Scope [2/2]

Metadata Metadata unsigned unsigned llvm::DILexicalBlock::Scope

Definition at line 2287 of file DebugInfoMetadata.h.

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

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

Public Member Functions

Static Public Member Functions

Public Attributes

Friends

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ classof()

◆ clone()

◆ DEFINE_MDNODE_GET()

◆ getColumn()

◆ getLine()

Friends And Related Function Documentation

◆ LLVMContextImpl

◆ MDNode

Member Data Documentation

◆ Column

◆ File [1/2]

◆ File [2/2]

◆ Line [1/2]

◆ Line [2/2]

◆ Scope [1/2]

◆ Scope [2/2]