DWARF expression. More...

#include "llvm/IR/DebugInfoMetadata.h"

Inheritance diagram for llvm::DIExpression:

Collaboration diagram for llvm::DIExpression:

[legend]

Classes
class	expr_op_iterator
	An iterator for expression operands. More...

class	ExprOperand
	A lightweight wrapper around an expression operand. More...

struct	FragmentInfo
	Holds the characteristics of one fragment of a larger variable. More...

Public Types
enum	SignedOrUnsignedConstant { SignedConstant, UnsignedConstant }

enum	PrependOps : uint8_t { ApplyOffset = 0, DerefBefore = 1 << 0, DerefAfter = 1 << 1, StackValue = 1 << 2, EntryValue = 1 << 3 }
	Used for DIExpression::prepend. More...

using	element_iterator = ArrayRef< uint64_t >::iterator

using	ExtOps = std::array< uint64_t, 6 >

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

Public Member Functions
	DEFINE_MDNODE_GET (DIExpression,(ArrayRef< uint64_t > Elements),(Elements)) TempDIExpression clone() const

ArrayRef< uint64_t >	getElements () const

unsigned	getNumElements () const

uint64_t	getElement (unsigned I) const

llvm::Optional< SignedOrUnsignedConstant >	isConstant () const
	Determine whether this represents a constant value, if so. More...

uint64_t	getNumLocationOperands () const
	Return the number of unique location operands referred to (via DW_OP_LLVM_arg) in this expression; this is not necessarily the number of instances of DW_OP_LLVM_arg within the expression. More...

element_iterator	elements_begin () const

element_iterator	elements_end () const

bool	isValid () const

bool	startsWithDeref () const
	Return whether the first element a DW_OP_deref. More...

Optional< FragmentInfo >	getFragmentInfo () const
	Retrieve the details of this fragment expression. More...

bool	isFragment () const
	Return whether this is a piece of an aggregate variable. More...

bool	isImplicit () const
	Return whether this is an implicit location description. More...

bool	isComplex () const
	Return whether the location is computed on the expression stack, meaning it cannot be a simple register location. More...

bool	extractIfOffset (int64_t &Offset) const
	If this is a constant offset, extract it. More...

bool	hasAllLocationOps (unsigned N) const
	Returns true iff this DIExpression contains at least one instance of `DW_OP_LLVM_arg, n` for all n in [0, N). More...

int	fragmentCmp (const DIExpression *Other) const
	Determine the relative position of the fragments described by this DIExpression and `Other`. More...

bool	fragmentsOverlap (const DIExpression *Other) const
	Check if fragments overlap between this DIExpression and `Other`. More...

bool	isEntryValue () const
	Check if the expression consists of exactly one entry value operand. More...

std::pair< DIExpression , const ConstantInt >	constantFold (const ConstantInt *CI)
	Try to shorten an expression with an initial constant operand. More...


expr_op_iterator	expr_op_begin () const
	Visit the elements via ExprOperand wrappers. More...

expr_op_iterator	expr_op_end () const

iterator_range< expr_op_iterator >	expr_ops () 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. More...

LLVMContext &	getContext () const

void	replaceOperandWith (unsigned I, Metadata *New)
	Replace a specific operand. More...

bool	isResolved () const
	Check if node is fully resolved. More...

bool	isUniqued () const

bool	isDistinct () const

bool	isTemporary () const

void	replaceAllUsesWith (Metadata *MD)
	RAUW a temporary. More...

void	resolveCycles ()
	Resolve cycles. More...

void	resolve ()
	Resolve a unique, unresolved node. More...

op_iterator	op_begin () const

op_iterator	op_end () const

op_range	operands () const

const MDOperand &	getOperand (unsigned I) const

unsigned	getNumOperands () const
	Return number of MDNode operands. More...

bool	isTBAAVtableAccess () const
	Check whether MDNode is a vtable access. More...

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

void	dump () const
	User-friendly dump. More...

void	dump (const Module *M) const

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

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

void	printAsOperand (raw_ostream &OS, ModuleSlotTracker &MST, const Module *M=nullptr) const

Static Public Member Functions
static bool	classof (const Metadata *MD)

static Optional< FragmentInfo >	getFragmentInfo (expr_op_iterator Start, expr_op_iterator End)
	Retrieve the details of this fragment expression. More...

static void	appendOffset (SmallVectorImpl< uint64_t > &Ops, int64_t Offset)
	Append `Ops` with operations to apply the `Offset`. More...

static const DIExpression *	extractAddressClass (const DIExpression *Expr, unsigned &AddrClass)
	Checks if the last 4 elements of the expression are DW_OP_constu <DWARF Address Space> DW_OP_swap DW_OP_xderef and extracts the <DWARF Address Space>. More...

static DIExpression *	prepend (const DIExpression *Expr, uint8_t Flags, int64_t Offset=0)
	Prepend `DIExpr` with a deref and offset operation and optionally turn it into a stack value or/and an entry value. More...

static DIExpression *	prependOpcodes (const DIExpression *Expr, SmallVectorImpl< uint64_t > &Ops, bool StackValue=false, bool EntryValue=false)
	Prepend `DIExpr` with the given opcodes and optionally turn it into a stack value. More...

static DIExpression *	append (const DIExpression *Expr, ArrayRef< uint64_t > Ops)
	Append the opcodes `Ops` to `DIExpr`. More...

static DIExpression *	appendToStack (const DIExpression *Expr, ArrayRef< uint64_t > Ops)
	Convert `DIExpr` into a stack value if it isn't one already by appending DW_OP_deref if needed, and appending `Ops` to the resulting expression. More...

static DIExpression *	appendOpsToArg (const DIExpression *Expr, ArrayRef< uint64_t > Ops, unsigned ArgNo, bool StackValue=false)
	Create a copy of `Expr` by appending the given list of `Ops` to each instance of the operand `DW_OP_LLVM_arg, \p ArgNo`. More...

static DIExpression *	replaceArg (const DIExpression *Expr, uint64_t OldArg, uint64_t NewArg)
	Create a copy of `Expr` with each instance of `DW_OP_LLVM_arg, \p OldArg` replaced with `DW_OP_LLVM_arg, \p NewArg`, and each instance of `DW_OP_LLVM_arg, Arg` with `DW_OP_LLVM_arg, Arg - 1` for all Arg > `OldArg`. More...

static Optional< DIExpression * >	createFragmentExpression (const DIExpression *Expr, unsigned OffsetInBits, unsigned SizeInBits)
	Create a DIExpression to describe one part of an aggregate variable that is fragmented across multiple Values. More...

static int	fragmentCmp (const FragmentInfo &A, const FragmentInfo &B)
	Determine the relative position of the fragments passed in. More...

static ExtOps	getExtOps (unsigned FromSize, unsigned ToSize, bool Signed)
	Returns the ops for a zero- or sign-extension in a DIExpression. More...

static DIExpression *	appendExt (const DIExpression *Expr, unsigned FromSize, unsigned ToSize, bool Signed)
	Append a zero- or sign-extension to `Expr`. More...

static bool	fragmentsOverlap (const FragmentInfo &A, const FragmentInfo &B)
	Check if fragments overlap between a pair of FragmentInfos. More...

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

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

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

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

static bool	classof (const Metadata *MD)
	Methods for support type inquiry through isa, cast, and dyn_cast: More...

static MDNode *	concatenate (MDNode A, MDNode B)
	Methods for metadata merging. More...

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)

Friends
class	LLVMContextImpl

class	MDNode

Additional Inherited Members
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::MDNode
	MDNode (LLVMContext &Context, unsigned ID, StorageType Storage, ArrayRef< Metadata * > Ops1, ArrayRef< Metadata * > Ops2=None)

	~MDNode ()=default

void *	operator new (size_t Size, unsigned NumOps)

void	operator delete (void *Mem)

void	operator delete (void *, unsigned)
	Required by std, but never called. More...

void	operator delete (void *, unsigned, bool)
	Required by std, but never called. More...

void	dropAllReferences ()

MDOperand *	mutable_begin ()

MDOperand *	mutable_end ()

mutable_op_range	mutable_operands ()

void	setOperand (unsigned I, Metadata *New)
	Set an operand. More...

void	storeDistinctInContext ()

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

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

unsigned char	SubclassData1: 1

unsigned short	SubclassData16 = 0

unsigned	SubclassData32 = 0

Detailed Description

DWARF expression.

This is (almost) a DWARF expression that modifies the location of a variable, or the location of a single piece of a variable, or (when using DW_OP_stack_value) is the constant variable value.

TODO: Co-allocate the expression elements. TODO: Separate from MDNode, or otherwise drop Distinct and Temporary storage types.

Definition at line 2586 of file DebugInfoMetadata.h.

Member Typedef Documentation

◆ element_iterator

using llvm::DIExpression::element_iterator = ArrayRef<uint64_t>::iterator

Definition at line 2634 of file DebugInfoMetadata.h.

◆ ExtOps

using llvm::DIExpression::ExtOps = std::array<uint64_t, 6>

Definition at line 2872 of file DebugInfoMetadata.h.

Member Enumeration Documentation

◆ PrependOps

enum llvm::DIExpression::PrependOps : uint8_t

Used for DIExpression::prepend.

Enumerator
ApplyOffset
DerefBefore
DerefAfter
StackValue
EntryValue

Definition at line 2792 of file DebugInfoMetadata.h.

◆ SignedOrUnsignedConstant

enum llvm::DIExpression::SignedOrUnsignedConstant

Enumerator
SignedConstant
UnsignedConstant

Definition at line 2619 of file DebugInfoMetadata.h.

Member Function Documentation

◆ append()

DIExpression * DIExpression::append	(	const DIExpression *	Expr,
		ArrayRef< uint64_t >	Ops
	)

static

Append the opcodes Ops to DIExpr.

Unlike appendToStack, the returned expression is a stack value only if DIExpr is a stack value. If DIExpr describes a fragment, the returned expression will describe the same fragment.

Definition at line 1392 of file DebugInfoMetadata.cpp.

References llvm::SmallVectorImpl< T >::append(), assert(), llvm::ArrayRef< T >::begin(), llvm::dwarf::DW_OP_LLVM_fragment, llvm::ArrayRef< T >::empty(), llvm::ArrayRef< T >::end(), expr_ops(), llvm::MDNode::get(), llvm::MDNode::getContext(), llvm::None, and result.

Referenced by appendToStack(), combineDIExpressions(), and llvm::LowerDbgDeclare().

◆ appendExt()

DIExpression * DIExpression::appendExt	(	const DIExpression *	Expr,
		unsigned	FromSize,
		unsigned	ToSize,
		bool	Signed
	)

static

Append a zero- or sign-extension to Expr.

Converts the expression to a stack value if it isn't one already.

Definition at line 1574 of file DebugInfoMetadata.cpp.

References appendToStack(), getExtOps(), and Signed.

Referenced by llvm::X86InstrInfo::describeLoadedValue(), and llvm::replaceAllDbgUsesWith().

◆ appendOffset()

void DIExpression::appendOffset	(	SmallVectorImpl< uint64_t > &	Ops,
		int64_t	Offset
	)

static

Append Ops with operations to apply the Offset.

Definition at line 1228 of file DebugInfoMetadata.cpp.

References Offset.

Referenced by llvm::X86InstrInfo::describeLoadedValue(), llvm::TargetInstrInfo::describeLoadedValue(), llvm::SystemZRegisterInfo::eliminateFrameIndex(), llvm::AArch64RegisterInfo::getOffsetOpcodes(), llvm::TargetRegisterInfo::getOffsetOpcodes(), getSalvageOpsForBinOp(), getSalvageOpsForGEP(), prepend(), and llvm::SelectionDAG::salvageDebugInfo().

◆ appendOpsToArg()

DIExpression * DIExpression::appendOpsToArg	(	const DIExpression *	Expr,
		ArrayRef< uint64_t >	Ops,
		unsigned	ArgNo,
		bool	StackValue = `false`
	)

static

Create a copy of Expr by appending the given list of Ops to each instance of the operand DW_OP_LLVM_arg, \p ArgNo.

This is used to modify a specific location used by Expr, such as when salvaging that location.

Definition at line 1312 of file DebugInfoMetadata.cpp.

References llvm::any_of(), assert(), llvm::ArrayRef< T >::begin(), llvm::dwarf::DW_OP_LLVM_arg, llvm::ArrayRef< T >::end(), expr_ops(), llvm::MDNode::get(), llvm::MDNode::getContext(), llvm::SmallVectorImpl< T >::insert(), prependOpcodes(), and StackValue.

Referenced by computeExprForSpill(), llvm::SystemZRegisterInfo::eliminateFrameIndex(), llvm::SelectionDAG::salvageDebugInfo(), llvm::salvageDebugInfoForDbgValues(), and llvm::SelectionDAGBuilder::salvageUnresolvedDbgValue().

◆ appendToStack()

DIExpression * DIExpression::appendToStack	(	const DIExpression *	Expr,
		ArrayRef< uint64_t >	Ops
	)

static

Convert DIExpr into a stack value if it isn't one already by appending DW_OP_deref if needed, and appending Ops to the resulting expression.

If DIExpr describes a fragment, the returned expression will describe the same fragment.

Definition at line 1416 of file DebugInfoMetadata.cpp.

References llvm::SmallVectorImpl< T >::append(), append(), assert(), llvm::ArrayRef< T >::back(), llvm::ArrayRef< T >::begin(), llvm::ArrayRef< T >::drop_back(), llvm::dwarf::DW_OP_LLVM_fragment, llvm::ArrayRef< T >::empty(), llvm::ArrayRef< T >::end(), getElements(), getFragmentInfo(), getNumElements(), llvm::Optional< T >::hasValue(), and llvm::none_of().

Referenced by appendExt().

◆ classof()

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

inlinestatic

Definition at line 2740 of file DebugInfoMetadata.h.

References llvm::Metadata::getMetadataID().

◆ constantFold()

std::pair< DIExpression *, const ConstantInt * > DIExpression::constantFold ( const ConstantInt * CI )

Try to shorten an expression with an initial constant operand.

Returns a new expression and constant on success, or the original expression and constant on failure.

Definition at line 1491 of file DebugInfoMetadata.cpp.

References assert(), llvm::dwarf::DW_OP_LLVM_convert, expr_ops(), First, llvm::ConstantInt::get(), llvm::MDNode::get(), llvm::MDNode::getContext(), llvm::ConstantInt::getValue(), llvm::APInt::sextOrTrunc(), and llvm::APInt::zextOrTrunc().

Referenced by llvm::InstrEmitter::EmitDbgValueFromSingleOp(), and llvm::FastISel::selectIntrinsicCall().

◆ createFragmentExpression()

Optional< DIExpression * > DIExpression::createFragmentExpression	(	const DIExpression *	Expr,
		unsigned	OffsetInBits,
		unsigned	SizeInBits
	)

static

Create a DIExpression to describe one part of an aggregate variable that is fragmented across multiple Values.

The DW_OP_LLVM_fragment operation will be appended to the elements of Expr. If Expr already contains a DW_OP_LLVM_fragment OffsetInBits is interpreted as an offset into the existing fragment.

Parameters

OffsetInBits	Offset of the piece in bits.
SizeInBits	Size of the piece in bits.

Returns: Creating a fragment expression may fail if Expr contains arithmetic operations that would be truncated.

Definition at line 1449 of file DebugInfoMetadata.cpp.

References assert(), llvm::dwarf::DW_OP_LLVM_fragment, expr_ops(), llvm::MDNode::get(), llvm::MDNode::getContext(), and llvm::None.

Referenced by llvm::SelectionDAGBuilder::handleDebugValue(), llvm::SelectionDAG::transferDbgValues(), and transferSRADebugInfo().

◆ DEFINE_MDNODE_GET()

llvm::DIExpression::DEFINE_MDNODE_GET	(	DIExpression	,
		(ArrayRef< uint64_t > Elements)	,
		(Elements)
	)		const

inline

Definition at line 2606 of file DebugInfoMetadata.h.

◆ elements_begin()

element_iterator llvm::DIExpression::elements_begin ( ) const

inline

Definition at line 2636 of file DebugInfoMetadata.h.

References llvm::ArrayRef< T >::begin(), and getElements().

Referenced by expr_op_begin().

◆ elements_end()

element_iterator llvm::DIExpression::elements_end ( ) const

inline

Definition at line 2637 of file DebugInfoMetadata.h.

References llvm::ArrayRef< T >::end(), and getElements().

Referenced by expr_op_end().

◆ expr_op_begin()

expr_op_iterator llvm::DIExpression::expr_op_begin ( ) const

inline

Visit the elements via ExprOperand wrappers.

These range iterators visit elements through ExprOperand wrappers. This is not guaranteed to be a valid range unless isValid() gives true.

Precondition: isValid() gives true.

Definition at line 2727 of file DebugInfoMetadata.h.

References elements_begin().

Referenced by llvm::DIExpressionCursor::DIExpressionCursor(), expr_ops(), llvm::DbgVariableLocation::extractFromMachineInstruction(), getFragmentInfo(), and isValid().

◆ expr_op_end()

expr_op_iterator llvm::DIExpression::expr_op_end ( ) const

inline

Definition at line 2730 of file DebugInfoMetadata.h.

References elements_end().

Referenced by llvm::DIExpressionCursor::DIExpressionCursor(), expr_ops(), llvm::DbgVariableLocation::extractFromMachineInstruction(), getFragmentInfo(), and isValid().

◆ expr_ops()

iterator_range<expr_op_iterator> llvm::DIExpression::expr_ops ( ) const

inline

Definition at line 2733 of file DebugInfoMetadata.h.

References expr_op_begin(), and expr_op_end().

Referenced by append(), appendOpsToArg(), constantFold(), createFragmentExpression(), emitDebugValueComment(), getNumLocationOperands(), hasAllLocationOps(), isComplex(), isImplicit(), prependOpcodes(), and replaceArg().

◆ extractAddressClass()

const DIExpression * DIExpression::extractAddressClass	(	const DIExpression *	Expr,
		unsigned &	AddrClass
	)

static

Checks if the last 4 elements of the expression are DW_OP_constu <DWARF Address Space> DW_OP_swap DW_OP_xderef and extracts the <DWARF Address Space>.

Definition at line 1276 of file DebugInfoMetadata.cpp.

References llvm::MDNode::get(), llvm::MDNode::getContext(), and llvm::makeArrayRef().

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

◆ extractIfOffset()

bool DIExpression::extractIfOffset ( int64_t & Offset ) const

If this is a constant offset, extract it.

If there is no expression, return true with an offset of zero.

Definition at line 1240 of file DebugInfoMetadata.cpp.

References getNumElements(), and Offset.

◆ fragmentCmp() [1/2]

int llvm::DIExpression::fragmentCmp ( const DIExpression * Other ) const

inline

Determine the relative position of the fragments described by this DIExpression and Other.

Calls static fragmentCmp implementation.

Definition at line 2889 of file DebugInfoMetadata.h.

References fragmentCmp(), getFragmentInfo(), and Other.

◆ fragmentCmp() [2/2]

static int llvm::DIExpression::fragmentCmp	(	const FragmentInfo &	A,
		const FragmentInfo &	B
	)

inlinestatic

Determine the relative position of the fragments passed in.

Returns -1 if this is entirely before Other, 0 if this and Other overlap, 1 if this is entirely after Other.

Definition at line 2859 of file DebugInfoMetadata.h.

References B, r1, and r2.

Referenced by fragmentCmp(), and fragmentsOverlap().

◆ fragmentsOverlap() [1/2]

bool llvm::DIExpression::fragmentsOverlap ( const DIExpression * Other ) const

inline

Check if fragments overlap between this DIExpression and Other.

Definition at line 2896 of file DebugInfoMetadata.h.

References fragmentCmp(), isFragment(), and Other.

◆ fragmentsOverlap() [2/2]

static bool llvm::DIExpression::fragmentsOverlap	(	const FragmentInfo &	A,
		const FragmentInfo &	B
	)

inlinestatic

Check if fragments overlap between a pair of FragmentInfos.

Definition at line 2883 of file DebugInfoMetadata.h.

References B, and fragmentCmp().

Referenced by llvm::SelectionDAGBuilder::dropDanglingDebugInfo(), and stashEntryDbgValues().

◆ getElement()

uint64_t llvm::DIExpression::getElement ( unsigned I ) const

inline

Definition at line 2614 of file DebugInfoMetadata.h.

References assert(), I, and llvm::ArrayRef< T >::size().

Referenced by llvm::DwarfCompileUnit::addLocationAttribute(), isConstant(), isEntryValue(), and startsWithDeref().

◆ getElements()

ArrayRef<uint64_t> llvm::DIExpression::getElements ( ) const

inline

Definition at line 2610 of file DebugInfoMetadata.h.

Referenced by appendToStack(), combineDIExpressions(), llvm::DbgValueLoc::DbgValueLoc(), elements_begin(), elements_end(), and llvm::MDNodeKeyImpl< DIExpression >::isKeyOf().

◆ getExtOps()

DIExpression::ExtOps DIExpression::getExtOps	(	unsigned	FromSize,
		unsigned	ToSize,
		bool	Signed
	)

static

Returns the ops for a zero- or sign-extension in a DIExpression.

Definition at line 1566 of file DebugInfoMetadata.cpp.

References llvm::dwarf::DW_OP_LLVM_convert, and Signed.

Referenced by appendExt(), and llvm::salvageDebugInfoImpl().

◆ getFragmentInfo() [1/2]

Optional<FragmentInfo> llvm::DIExpression::getFragmentInfo ( ) const

inline

Retrieve the details of this fragment expression.

Definition at line 2760 of file DebugInfoMetadata.h.

References expr_op_begin(), and expr_op_end().

Referenced by fragmentCmp(), llvm::DIExpressionCursor::getFragmentInfo(), and isFragment().

◆ getFragmentInfo() [2/2]

Optional< DIExpression::FragmentInfo > DIExpression::getFragmentInfo	(	expr_op_iterator	Start,
		expr_op_iterator	End
	)

static

Retrieve the details of this fragment expression.

Definition at line 1219 of file DebugInfoMetadata.cpp.

Referenced by llvm::DwarfExpression::addFragmentOffset(), appendToStack(), and llvm::SelectionDAGBuilder::handleDebugValue().

◆ getNumElements()

unsigned llvm::DIExpression::getNumElements ( ) const

inline

Definition at line 2612 of file DebugInfoMetadata.h.

References llvm::ArrayRef< T >::size().

Referenced by appendToStack(), emitDebugValueComment(), extractIfOffset(), isComplex(), isConstant(), isEntryValue(), isImplicit(), isValid(), and startsWithDeref().

◆ getNumLocationOperands()

uint64_t DIExpression::getNumLocationOperands ( ) const

Return the number of unique location operands referred to (via DW_OP_LLVM_arg) in this expression; this is not necessarily the number of instances of DW_OP_LLVM_arg within the expression.

For example, for the expression: (DW_OP_LLVM_arg 0, DW_OP_LLVM_arg 1, DW_OP_plus, DW_OP_LLVM_arg 0, DW_OP_mul) This function would return 2, as there are two unique location operands (0 and 1).

Definition at line 1529 of file DebugInfoMetadata.cpp.

References assert(), llvm::dwarf::DW_OP_LLVM_arg, expr_ops(), hasAllLocationOps(), and llvm::max().

Referenced by llvm::coro::salvageDebugInfo(), llvm::salvageDebugInfoForDbgValues(), and llvm::SelectionDAGBuilder::salvageUnresolvedDbgValue().

◆ hasAllLocationOps()

bool DIExpression::hasAllLocationOps ( unsigned N ) const

Returns true iff this DIExpression contains at least one instance of DW_OP_LLVM_arg, n for all n in [0, N).

Definition at line 1265 of file DebugInfoMetadata.cpp.

References llvm::dwarf::DW_OP_LLVM_arg, expr_ops(), llvm::detail::DenseSetImpl< ValueT, SmallDenseMap< ValueT, detail::DenseSetEmpty, 4, DenseMapInfo< ValueT >, detail::DenseSetPair< ValueT > >, DenseMapInfo< ValueT > >::insert(), llvm::is_contained(), and N.

Referenced by getNumLocationOperands().

◆ isComplex()

bool DIExpression::isComplex ( ) const

Return whether the location is computed on the expression stack, meaning it cannot be a simple register location.

Definition at line 1197 of file DebugInfoMetadata.cpp.

References llvm::dwarf::DW_OP_LLVM_fragment, llvm::dwarf::DW_OP_LLVM_tag_offset, expr_ops(), getNumElements(), and isValid().

Referenced by llvm::coro::salvageDebugInfo().

◆ isConstant()

llvm::Optional< DIExpression::SignedOrUnsignedConstant > DIExpression::isConstant ( ) const

Determine whether this represents a constant value, if so.

Definition at line 1540 of file DebugInfoMetadata.cpp.

References llvm::dwarf::DW_OP_LLVM_fragment, getElement(), getNumElements(), and llvm::None.

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

◆ isEntryValue()

bool llvm::DIExpression::isEntryValue ( ) const

inline

Check if the expression consists of exactly one entry value operand.

(This is the only configuration of entry values that is supported.)

Definition at line 2904 of file DebugInfoMetadata.h.

References llvm::dwarf::DW_OP_LLVM_entry_value, getElement(), and getNumElements().

Referenced by llvm::DwarfCompileUnit::addComplexAddress(), finishCallSiteParams(), llvm::MachineInstr::isDebugEntryValue(), llvm::DbgValueLoc::isEntryVal(), and llvm::DwarfExpression::setLocation().

◆ isFragment()

bool llvm::DIExpression::isFragment ( ) const

inline

Return whether this is a piece of an aggregate variable.

Definition at line 2765 of file DebugInfoMetadata.h.

References getFragmentInfo().

Referenced by llvm::DwarfExpression::addFragmentOffset(), fragmentsOverlap(), and llvm::DbgValueLoc::isFragment().

◆ isImplicit()

bool DIExpression::isImplicit ( ) const

Return whether this is an implicit location description.

Definition at line 1177 of file DebugInfoMetadata.cpp.

References llvm::dwarf::DW_OP_LLVM_tag_offset, expr_ops(), getNumElements(), and isValid().

Referenced by combineDIExpressions().

◆ isValid()

bool DIExpression::isValid ( ) const

Definition at line 1096 of file DebugInfoMetadata.cpp.

References llvm::dwarf::DW_OP_LLVM_arg, llvm::dwarf::DW_OP_LLVM_convert, llvm::dwarf::DW_OP_LLVM_entry_value, llvm::dwarf::DW_OP_LLVM_fragment, llvm::dwarf::DW_OP_LLVM_implicit_pointer, llvm::dwarf::DW_OP_LLVM_tag_offset, E, expr_op_begin(), expr_op_end(), llvm::DIExpression::ExprOperand::get(), getNumElements(), and I.

Referenced by llvm::DbgValueLoc::DbgValueLoc(), finishCallSiteParams(), isComplex(), and isImplicit().

◆ prepend()

DIExpression * DIExpression::prepend	(	const DIExpression *	Expr,
		uint8_t	Flags,
		int64_t	Offset = `0`
	)

static

Prepend DIExpr with a deref and offset operation and optionally turn it into a stack value or/and an entry value.

Definition at line 1296 of file DebugInfoMetadata.cpp.

References appendOffset(), DerefAfter, DerefBefore, EntryValue, Offset, prependOpcodes(), and StackValue.

Referenced by computeExprForSpill(), llvm::MipsInstrInfo::describeLoadedValue(), llvm::TargetInstrInfo::describeLoadedValue(), processDbgDeclares(), llvm::replaceDbgDeclare(), replaceOneDbgValueForAlloca(), and llvm::FastISel::selectIntrinsicCall().

◆ prependOpcodes()

DIExpression * DIExpression::prependOpcodes	(	const DIExpression *	Expr,
		SmallVectorImpl< uint64_t > &	Ops,
		bool	StackValue = `false`,
		bool	EntryValue = `false`
	)

static

Prepend DIExpr with the given opcodes and optionally turn it into a stack value.

Definition at line 1358 of file DebugInfoMetadata.cpp.

References assert(), llvm::dwarf::DW_OP_LLVM_entry_value, llvm::dwarf::DW_OP_LLVM_fragment, EntryValue, expr_ops(), llvm::MDNode::get(), llvm::MDNode::getContext(), and StackValue.

Referenced by appendOpsToArg(), llvm::TargetInstrInfo::describeLoadedValue(), prepend(), llvm::TargetRegisterInfo::prependOffsetExpression(), and TryToShrinkGlobalToBoolean().

◆ replaceArg()

DIExpression * DIExpression::replaceArg	(	const DIExpression *	Expr,
		uint64_t	OldArg,
		uint64_t	NewArg
	)

static

Create a copy of Expr with each instance of DW_OP_LLVM_arg, \p OldArg replaced with DW_OP_LLVM_arg, \p NewArg, and each instance of DW_OP_LLVM_arg, Arg with DW_OP_LLVM_arg, Arg - 1 for all Arg > OldArg.

This is used when replacing one of the operands of a debug value list with another operand in the same list and deleting the old operand.

Definition at line 1336 of file DebugInfoMetadata.cpp.

References Arg, assert(), llvm::dwarf::DW_OP_LLVM_arg, expr_ops(), llvm::MDNode::get(), and llvm::MDNode::getContext().

◆ startsWithDeref()

bool llvm::DIExpression::startsWithDeref ( ) const

inline

Return whether the first element a DW_OP_deref.

Definition at line 2745 of file DebugInfoMetadata.h.

References getElement(), and getNumElements().

Referenced by promoteSingleBlockAlloca(), and rewriteSingleStoreAlloca().

Friends And Related Function Documentation

◆ LLVMContextImpl

friend class LLVMContextImpl

friend

Definition at line 2587 of file DebugInfoMetadata.h.

◆ MDNode

friend class MDNode

friend

Definition at line 2588 of file DebugInfoMetadata.h.

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

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

Classes

Public Types

Public Member Functions

Static Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ element_iterator

◆ ExtOps

Member Enumeration Documentation

◆ PrependOps

◆ SignedOrUnsignedConstant

Member Function Documentation

◆ append()

◆ appendExt()

◆ appendOffset()

◆ appendOpsToArg()

◆ appendToStack()

◆ classof()

◆ constantFold()

◆ createFragmentExpression()

◆ DEFINE_MDNODE_GET()

◆ elements_begin()

◆ elements_end()

◆ expr_op_begin()

◆ expr_op_end()

◆ expr_ops()

◆ extractAddressClass()

◆ extractIfOffset()

◆ fragmentCmp() [1/2]

◆ fragmentCmp() [2/2]

◆ fragmentsOverlap() [1/2]

◆ fragmentsOverlap() [2/2]

◆ getElement()

◆ getElements()

◆ getExtOps()

◆ getFragmentInfo() [1/2]

◆ getFragmentInfo() [2/2]

◆ getNumElements()

◆ getNumLocationOperands()

◆ hasAllLocationOps()

◆ isComplex()

◆ isConstant()

◆ isEntryValue()

◆ isFragment()

◆ isImplicit()

◆ isValid()

◆ prepend()

◆ prependOpcodes()

◆ replaceArg()

◆ startsWithDeref()

Friends And Related Function Documentation

◆ LLVMContextImpl

◆ MDNode