Record of a variable value-assignment, aka a non instruction representation of the dbg.value intrinsic. More...

#include "llvm/IR/DebugProgramInstruction.h"

Inheritance diagram for llvm::DbgVariableRecord:

Classes
class	location_op_iterator
	Iterator for ValueAsMetadata that internally uses direct pointer iteration over either a ValueAsMetadata* or a ValueAsMetadata**, dereferencing to the ValueAsMetadata . More...

Public Types
enum class	LocationType : uint8_t { Declare , Value , Assign , DeclareValue , End , Any }
Public Types inherited from llvm::DbgRecord
enum	Kind : uint8_t { ValueKind , LabelKind }
	Subclass discriminator. More...
using	self_iterator = simple_ilist<DbgRecord>::iterator
using	const_self_iterator = simple_ilist<DbgRecord>::const_iterator

Public Member Functions
LLVM_ABI	DbgVariableRecord (const DbgVariableIntrinsic *DVI)
	Create a new DbgVariableRecord representing the intrinsic `DVI`, for example the assignment represented by a dbg.value.
LLVM_ABI	DbgVariableRecord (const DbgVariableRecord &DVR)
LLVM_ABI	DbgVariableRecord (Metadata Location, DILocalVariable DV, DIExpression Expr, const DILocation DI, LocationType Type=LocationType::Value)
	Directly construct a new DbgVariableRecord representing a dbg.value intrinsic assigning `Location` to the DV / Expr / DI variable.
LLVM_ABI	DbgVariableRecord (Metadata Value, DILocalVariable Variable, DIExpression Expression, DIAssignID AssignID, Metadata Address, DIExpression AddressExpression, const DILocation *DI)
bool	isDbgDeclare () const
bool	isDbgValue () const
bool	isDbgDeclareValue () const
LLVM_ABI iterator_range< location_op_iterator >	location_ops () const
	Get the locations corresponding to the variable referenced by the debug info intrinsic.
LLVM_ABI Value *	getVariableLocationOp (unsigned OpIdx) const
LLVM_ABI void	replaceVariableLocationOp (Value OldValue, Value NewValue, bool AllowEmpty=false)
LLVM_ABI void	replaceVariableLocationOp (unsigned OpIdx, Value *NewValue)
LLVM_ABI void	addVariableLocationOps (ArrayRef< Value * > NewValues, DIExpression *NewExpr)
	Adding a new location operand will always result in this intrinsic using an ArgList, and must always be accompanied by a new expression that uses the new operand.
LLVM_ABI unsigned	getNumVariableLocationOps () const
bool	hasArgList () const
bool	hasValidLocation () const
	Returns true if this DbgVariableRecord has no empty MDNodes in its location list.
bool	isAddressOfVariable () const
	Does this describe the address of a local variable.
bool	isValueOfVariable () const
	Determine if this describes the value of a local variable.
LocationType	getType () const
LLVM_ABI void	setKillLocation ()
LLVM_ABI bool	isKillLocation () const
void	setVariable (DILocalVariable *NewVar)
DILocalVariable *	getVariable () const
MDNode *	getRawVariable () const
void	setExpression (DIExpression *NewExpr)
DIExpression *	getExpression () const
MDNode *	getRawExpression () const
Metadata *	getRawLocation () const
	Returns the metadata operand for the first location description.
Value *	getValue (unsigned OpIdx=0) const
void	setRawLocation (Metadata *NewLocation)
	Use of this should generally be avoided; instead, replaceVariableLocationOp and addVariableLocationOps should be used where possible to avoid creating invalid state.
LLVM_ABI std::optional< DbgVariableFragmentInfo >	getFragment () const
DbgVariableFragmentInfo	getFragmentOrEntireVariable () const
	Get the FragmentInfo for the variable if it exists, otherwise return a FragmentInfo that covers the entire variable if the variable size is known, otherwise return a zero-sized fragment.
LLVM_ABI std::optional< uint64_t >	getFragmentSizeInBits () const
	Get the size (in bits) of the variable, or fragment of the variable that is described.
bool	isEquivalentTo (const DbgVariableRecord &Other) const
bool	isIdenticalToWhenDefined (const DbgVariableRecord &Other) const
LLVM_ABI DbgVariableRecord *	clone () const
LLVM_ABI DbgVariableIntrinsic *	createDebugIntrinsic (Module M, Instruction InsertBefore) const
	Convert this DbgVariableRecord back into a dbg.value intrinsic.
LLVM_ABI void	handleChangedLocation (Metadata *NewLocation)
	Handle changes to the location of the Value(s) that we refer to happening "under our feet".
LLVM_ABI void	print (raw_ostream &O, bool IsForDebug=false) const
LLVM_ABI void	print (raw_ostream &ROS, ModuleSlotTracker &MST, bool IsForDebug) const
DbgAssign Methods
bool	isDbgAssign () const
LLVM_ABI Value *	getAddress () const
Metadata *	getRawAddress () const
Metadata *	getRawAssignID () const
LLVM_ABI DIAssignID *	getAssignID () const
DIExpression *	getAddressExpression () const
MDNode *	getRawAddressExpression () const
void	setAddressExpression (DIExpression *NewExpr)
LLVM_ABI void	setAssignId (DIAssignID *New)
void	setAddress (Value *V)
LLVM_ABI void	setKillAddress ()
	Kill the address component.
LLVM_ABI bool	isKillAddress () const
	Check whether this kills the address component.
Public Member Functions inherited from llvm::DbgRecord
	DbgRecord (Kind RecordKind, DebugLoc DL)
LLVM_ABI bool	isEquivalentTo (const DbgRecord &R) const
	Same as isIdenticalToWhenDefined but checks DebugLoc too.
Kind	getRecordKind () const
void	setMarker (DbgMarker *M)
DbgMarker *	getMarker ()
const DbgMarker *	getMarker () const
LLVM_ABI BasicBlock *	getBlock ()
LLVM_ABI const BasicBlock *	getBlock () const
LLVM_ABI Function *	getFunction ()
LLVM_ABI const Function *	getFunction () const
LLVM_ABI Module *	getModule ()
LLVM_ABI const Module *	getModule () const
LLVM_ABI LLVMContext &	getContext ()
LLVM_ABI const LLVMContext &	getContext () const
LLVM_ABI const Instruction *	getInstruction () const
LLVM_ABI const BasicBlock *	getParent () const
LLVM_ABI BasicBlock *	getParent ()
LLVM_ABI void	removeFromParent ()
LLVM_ABI void	eraseFromParent ()
DbgRecord *	getNextNode ()
DbgRecord *	getPrevNode ()
LLVM_ABI void	insertBefore (DbgRecord *InsertBefore)
LLVM_ABI void	insertAfter (DbgRecord *InsertAfter)
LLVM_ABI void	moveBefore (DbgRecord *MoveBefore)
LLVM_ABI void	moveAfter (DbgRecord *MoveAfter)
LLVM_ABI void	insertBefore (self_iterator InsertBefore)
LLVM_ABI void	insertAfter (self_iterator InsertAfter)
LLVM_ABI void	moveBefore (self_iterator MoveBefore)
LLVM_ABI void	moveAfter (self_iterator MoveAfter)
DebugLoc	getDebugLoc () const
void	setDebugLoc (DebugLoc Loc)
LLVM_ABI void	dump () const
LLVM_ABI void	deleteRecord ()
	Methods that dispatch to subclass implementations.
LLVM_ABI DbgRecord *	clone () const
LLVM_ABI void	print (raw_ostream &O, bool IsForDebug=false) const
LLVM_ABI void	print (raw_ostream &O, ModuleSlotTracker &MST, bool IsForDebug) const
LLVM_ABI bool	isIdenticalToWhenDefined (const DbgRecord &R) const
LLVM_ABI DbgInfoIntrinsic *	createDebugIntrinsic (Module M, Instruction InsertBefore) const
	Convert this DbgRecord back into an appropriate llvm.dbg.
Public Member Functions inherited from llvm::ilist_node_impl< ilist_detail::compute_node_options< DbgRecord, Options... >::type >
self_iterator	getIterator ()
reverse_self_iterator	getReverseIterator ()
std::enable_if_t< T::is_sentinel_tracking_explicit, bool >	isSentinel () const
	Check whether this is the sentinel node.
Public Member Functions inherited from llvm::ilist_detail::node_parent_access< ilist_node_impl< ilist_detail::compute_node_options< DbgRecord, Options... >::type >, ilist_detail::compute_node_options< DbgRecord, Options... >::type::parent_ty >
const ilist_detail::compute_node_options< DbgRecord, Options... >::type::parent_ty *	getParent () const
void	setParent (ilist_detail::compute_node_options< DbgRecord, Options... >::type::parent_ty *Parent)

Static Public Member Functions
static LLVM_ABI DbgVariableRecord *	createUnresolvedDbgVariableRecord (LocationType Type, Metadata Val, MDNode Variable, MDNode Expression, MDNode AssignID, Metadata Address, MDNode AddressExpression, MDNode *DI)
	Used to create DbgVariableRecords during parsing, where some metadata references may still be unresolved.
static LLVM_ABI DbgVariableRecord *	createDVRAssign (Value Val, DILocalVariable Variable, DIExpression Expression, DIAssignID AssignID, Value Address, DIExpression AddressExpression, const DILocation *DI)
static LLVM_ABI DbgVariableRecord *	createLinkedDVRAssign (Instruction LinkedInstr, Value Val, DILocalVariable Variable, DIExpression Expression, Value Address, DIExpression AddressExpression, const DILocation *DI)
static LLVM_ABI DbgVariableRecord *	createDbgVariableRecord (Value Location, DILocalVariable DV, DIExpression Expr, const DILocation DI)
static LLVM_ABI DbgVariableRecord *	createDbgVariableRecord (Value Location, DILocalVariable DV, DIExpression Expr, const DILocation DI, DbgVariableRecord &InsertBefore)
static LLVM_ABI DbgVariableRecord *	createDVRDeclare (Value Address, DILocalVariable DV, DIExpression Expr, const DILocation DI)
static LLVM_ABI DbgVariableRecord *	createDVRDeclare (Value Address, DILocalVariable DV, DIExpression Expr, const DILocation DI, DbgVariableRecord &InsertBefore)
static LLVM_ABI DbgVariableRecord *	createDVRDeclareValue (Value Address, DILocalVariable DV, DIExpression Expr, const DILocation DI)
static LLVM_ABI DbgVariableRecord *	createDVRDeclareValue (Value Address, DILocalVariable DV, DIExpression Expr, const DILocation DI, DbgVariableRecord &InsertBefore)
static bool	classof (const DbgRecord *E)
	Support type inquiry through isa, cast, and dyn_cast.

Public Attributes
LocationType	Type
	Classification of the debug-info record that this DbgVariableRecord represents.
DbgRecordParamRef< DILocalVariable >	Variable
DbgRecordParamRef< DIExpression >	Expression
DbgRecordParamRef< DIExpression >	AddressExpression
Public Attributes inherited from llvm::DbgRecord
DbgMarker *	Marker = nullptr
	Marker that this DbgRecord is linked into.

Friends
class	DebugValueUser

Additional Inherited Members
Protected Types inherited from llvm::ilist_node_impl< ilist_detail::compute_node_options< DbgRecord, Options... >::type >
using	self_iterator
using	const_self_iterator
using	reverse_self_iterator
using	const_reverse_self_iterator
Protected Member Functions inherited from llvm::DbgRecord
	~DbgRecord ()=default
	Similarly to Value, we avoid paying the cost of a vtable by protecting the dtor and having deleteRecord dispatch cleanup.
Protected Member Functions inherited from llvm::ilist_node_impl< ilist_detail::compute_node_options< DbgRecord, Options... >::type >
	ilist_node_impl ()=default
Protected Member Functions inherited from llvm::DebugValueUser
ArrayRef< Metadata * >	getDebugValues () const
LLVM_ABI DbgVariableRecord *	getUser ()
LLVM_ABI const DbgVariableRecord *	getUser () const
LLVM_ABI void	handleChangedValue (void Old, Metadata NewDebugValue)
	To be called by ReplaceableMetadataImpl::replaceAllUsesWith, where Old is a pointer to one of the pointers in DebugValues (so should be type Metadata*), and NewDebugValue is the new Metadata that is replacing *Old.
	DebugValueUser ()=default
	DebugValueUser (std::array< Metadata *, 3 > DebugValues)
	DebugValueUser (DebugValueUser &&X)
	DebugValueUser (const DebugValueUser &X)
DebugValueUser &	operator= (DebugValueUser &&X)
DebugValueUser &	operator= (const DebugValueUser &X)
	~DebugValueUser ()
void	resetDebugValues ()
void	resetDebugValue (size_t Idx, Metadata *DebugValue)
bool	operator== (const DebugValueUser &X) const
bool	operator!= (const DebugValueUser &X) const
Protected Attributes inherited from llvm::DbgRecord
DebugLoc	DbgLoc
Kind	RecordKind
	Subclass discriminator.
Protected Attributes inherited from llvm::DebugValueUser
std::array< Metadata *, 3 >	DebugValues

Detailed Description

Record of a variable value-assignment, aka a non instruction representation of the dbg.value intrinsic.

This class inherits from DebugValueUser to allow LLVM's metadata facilities to update our references to metadata beneath our feet.

Definition at line 277 of file DebugProgramInstruction.h.

Member Enumeration Documentation

◆ LocationType

enum class llvm::DbgVariableRecord::LocationType : uint8_t

strong

Enumerator
Declare
Value
Assign
DeclareValue
End	Marks the end of the concrete types.
Any	To indicate all LocationTypes in searches.

Definition at line 281 of file DebugProgramInstruction.h.

Constructor & Destructor Documentation

◆ DbgVariableRecord() [1/4]

DbgVariableRecord::DbgVariableRecord ( const DbgVariableIntrinsic * DVI )

Create a new DbgVariableRecord representing the intrinsic DVI, for example the assignment represented by a dbg.value.

Definition at line 34 of file DebugProgramInstruction.cpp.

References llvm::DbgRecord::DbgRecord(), DebugValueUser, llvm::DbgRecord::getDebugLoc(), llvm::DbgVariableIntrinsic::getRawLocation(), and llvm::DbgRecord::ValueKind.

Referenced by clone(), createDbgVariableRecord(), createDbgVariableRecord(), createDVRAssign(), createDVRDeclare(), createDVRDeclare(), createDVRDeclareValue(), createDVRDeclareValue(), createLinkedDVRAssign(), createUnresolvedDbgVariableRecord(), DbgVariableRecord(), isEquivalentTo(), and isIdenticalToWhenDefined().

◆ DbgVariableRecord() [2/4]

DbgVariableRecord::DbgVariableRecord ( const DbgVariableRecord & DVR )

Definition at line 61 of file DebugProgramInstruction.cpp.

References AddressExpression, llvm::DbgRecord::DbgRecord(), DbgVariableRecord(), llvm::DebugValueUser::DebugValues, DebugValueUser, Expression, llvm::DbgRecord::getDebugLoc(), getExpression(), getType(), getVariable(), Type, llvm::DbgRecord::ValueKind, and Variable.

◆ DbgVariableRecord() [3/4]

DbgVariableRecord::DbgVariableRecord	(	Metadata *	Location,
		DILocalVariable *	DV,
		DIExpression *	Expr,
		const DILocation *	DI,
		LocationType	Type = LocationType::Value )

Directly construct a new DbgVariableRecord representing a dbg.value intrinsic assigning Location to the DV / Expr / DI variable.

Definition at line 67 of file DebugProgramInstruction.cpp.

References llvm::DbgRecord::DbgRecord(), DebugValueUser, Type, and llvm::DbgRecord::ValueKind.

◆ DbgVariableRecord() [4/4]

DbgVariableRecord::DbgVariableRecord	(	Metadata *	Value,
		DILocalVariable *	Variable,
		DIExpression *	Expression,
		DIAssignID *	AssignID,
		Metadata *	Address,
		DIExpression *	AddressExpression,
		const DILocation *	DI )

Definition at line 73 of file DebugProgramInstruction.cpp.

References llvm::Address, AddressExpression, llvm::DbgRecord::DbgRecord(), DebugValueUser, Expression, Value, llvm::DbgRecord::ValueKind, and Variable.

Member Function Documentation

◆ addVariableLocationOps()

void DbgVariableRecord::addVariableLocationOps	(	ArrayRef< Value * >	NewValues,
		DIExpression *	NewExpr )

Adding a new location operand will always result in this intrinsic using an ArgList, and must always be accompanied by a new expression that uses the new operand.

Definition at line 359 of file DebugProgramInstruction.cpp.

References assert(), llvm::DIArgList::get(), getAsMetadata(), llvm::DbgRecord::getContext(), getNumVariableLocationOps(), getVariableLocationOp(), llvm::is_contained(), location_ops(), llvm::SmallVectorTemplateBase< T, bool >::push_back(), setExpression(), setRawLocation(), and llvm::ArrayRef< T >::size().

◆ classof()

bool llvm::DbgVariableRecord::classof ( const DbgRecord * E )

inlinestatic

Support type inquiry through isa, cast, and dyn_cast.

Definition at line 568 of file DebugProgramInstruction.h.

References llvm::DbgRecord::DbgRecord(), E(), and llvm::DbgRecord::ValueKind.

◆ clone()

DbgVariableRecord * DbgVariableRecord::clone ( ) const

Definition at line 413 of file DebugProgramInstruction.cpp.

References DbgVariableRecord().

Referenced by llvm::insertDebugValuesForPHIs().

◆ createDbgVariableRecord() [1/2]

DbgVariableRecord * DbgVariableRecord::createDbgVariableRecord	(	Value *	Location,
		DILocalVariable *	DV,
		DIExpression *	Expr,
		const DILocation *	DI )

static

Definition at line 182 of file DebugProgramInstruction.cpp.

References DbgVariableRecord(), llvm::ValueAsMetadata::get(), and Value.

Referenced by createDbgVariableRecord(), llvm::DIBuilder::insertDbgValueIntrinsic(), and insertNewDbgInst().

◆ createDbgVariableRecord() [2/2]

DbgVariableRecord * DbgVariableRecord::createDbgVariableRecord	(	Value *	Location,
		DILocalVariable *	DV,
		DIExpression *	Expr,
		const DILocation *	DI,
		DbgVariableRecord &	InsertBefore )

static

Definition at line 189 of file DebugProgramInstruction.cpp.

References createDbgVariableRecord(), DbgVariableRecord(), and Value.

◆ createDebugIntrinsic()

DbgVariableIntrinsic * DbgVariableRecord::createDebugIntrinsic	(	Module *	M,
		Instruction *	InsertBefore ) const

Convert this DbgVariableRecord back into a dbg.value intrinsic.

InsertBefore Optional position to insert this intrinsic.

Returns: A new dbg.value intrinsic representing this DbgVariableRecord.

Definition at line 422 of file DebugProgramInstruction.cpp.

References Any, assert(), Assign, llvm::cast(), llvm::CallInst::Create(), Declare, DeclareValue, End, llvm::MetadataAsValue::get(), getAddressExpression(), getAssignID(), llvm::MDNode::getContext(), llvm::DbgRecord::getDebugLoc(), getExpression(), llvm::Function::getFunctionType(), llvm::ilist_node_impl< OptionsT >::getIterator(), llvm::Intrinsic::getOrInsertDeclaration(), getRawAddress(), getRawLocation(), getType(), getVariable(), llvm::Instruction::insertBefore(), isDbgAssign(), llvm_unreachable, llvm::Instruction::setDebugLoc(), llvm::CallInst::setTailCall(), and Value.

◆ createDVRAssign()

DbgVariableRecord * DbgVariableRecord::createDVRAssign	(	Value *	Val,
		DILocalVariable *	Variable,
		DIExpression *	Expression,
		DIAssignID *	AssignID,
		Value *	Address,
		DIExpression *	AddressExpression,
		const DILocation *	DI )

static

Definition at line 230 of file DebugProgramInstruction.cpp.

References llvm::Address, AddressExpression, DbgVariableRecord(), Expression, llvm::ValueAsMetadata::get(), Value, and Variable.

Referenced by createLinkedDVRAssign(), and llvm::DIBuilder::insertDbgAssign().

◆ createDVRDeclare() [1/2]

DbgVariableRecord * DbgVariableRecord::createDVRDeclare	(	Value *	Address,
		DILocalVariable *	DV,
		DIExpression *	Expr,
		const DILocation *	DI )

static

Definition at line 197 of file DebugProgramInstruction.cpp.

References llvm::Address, DbgVariableRecord(), Declare, llvm::ValueAsMetadata::get(), and Value.

Referenced by createDVRDeclare(), llvm::DIBuilder::insertDeclare(), and insertNewDbgInst().

◆ createDVRDeclare() [2/2]

DbgVariableRecord * DbgVariableRecord::createDVRDeclare	(	Value *	Address,
		DILocalVariable *	DV,
		DIExpression *	Expr,
		const DILocation *	DI,
		DbgVariableRecord &	InsertBefore )

static

Definition at line 206 of file DebugProgramInstruction.cpp.

References llvm::Address, createDVRDeclare(), DbgVariableRecord(), and Value.

◆ createDVRDeclareValue() [1/2]

DbgVariableRecord * DbgVariableRecord::createDVRDeclareValue	(	Value *	Address,
		DILocalVariable *	DV,
		DIExpression *	Expr,
		const DILocation *	DI )

static

Definition at line 215 of file DebugProgramInstruction.cpp.

References llvm::Address, DbgVariableRecord(), DeclareValue, llvm::ValueAsMetadata::get(), and Value.

Referenced by createDVRDeclareValue(), and llvm::DIBuilder::insertDeclareValue().

◆ createDVRDeclareValue() [2/2]

DbgVariableRecord * DbgVariableRecord::createDVRDeclareValue	(	Value *	Address,
		DILocalVariable *	DV,
		DIExpression *	Expr,
		const DILocation *	DI,
		DbgVariableRecord &	InsertBefore )

static

Definition at line 222 of file DebugProgramInstruction.cpp.

References llvm::Address, createDVRDeclareValue(), DbgVariableRecord(), and Value.

◆ createLinkedDVRAssign()

DbgVariableRecord * DbgVariableRecord::createLinkedDVRAssign	(	Instruction *	LinkedInstr,
		Value *	Val,
		DILocalVariable *	Variable,
		DIExpression *	Expression,
		Value *	Address,
		DIExpression *	AddressExpression,
		const DILocation *	DI )

static

Definition at line 239 of file DebugProgramInstruction.cpp.

References llvm::Address, AddressExpression, assert(), llvm::cast(), createDVRAssign(), DbgVariableRecord(), Expression, llvm::Instruction::getMetadata(), llvm::ilist_detail::node_parent_access< NodeTy, ParentTy >::getParent(), Value, and Variable.

Referenced by emitDbgAssign(), and insertNewDbgInst().

◆ createUnresolvedDbgVariableRecord()

DbgVariableRecord * DbgVariableRecord::createUnresolvedDbgVariableRecord	(	DbgVariableRecord::LocationType	Type,
		Metadata *	Val,
		MDNode *	Variable,
		MDNode *	Expression,
		MDNode *	AssignID,
		Metadata *	Address,
		MDNode *	AddressExpression,
		MDNode *	DI )

static

Used to create DbgVariableRecords during parsing, where some metadata references may still be unresolved.

Although for some fields a generic Metadata* argument is accepted for forward type-references, the verifier and accessors will reject incorrect types later on. The function is used for all types of DbgVariableRecords for simplicity while parsing, but asserts if any necessary fields are empty or unused fields are not empty, i.e. if the #dbg_assign fields are used for a non-dbg-assign type.

Definition at line 173 of file DebugProgramInstruction.cpp.

References llvm::Address, AddressExpression, DbgVariableRecord(), Expression, Type, and Variable.

Referenced by upgradeDbgIntrinsicToDbgRecord().

◆ getAddress()

Value * DbgVariableRecord::getAddress ( ) const

Definition at line 497 of file DebugProgramInstruction.cpp.

References assert(), llvm::cast(), llvm::dyn_cast_or_null(), getRawAddress(), and Value.

Referenced by llvm::at::calculateFragmentIntersect(), fixupDebugInfoPostExtraction(), isKillAddress(), replaceVariableLocationOp(), and setKillAddress().

◆ getAddressExpression()

DIExpression * llvm::DbgVariableRecord::getAddressExpression ( ) const

inline

Definition at line 533 of file DebugProgramInstruction.h.

References AddressExpression.

Referenced by llvm::at::calculateFragmentIntersect(), createDebugIntrinsic(), getAddressExpression(), and llvm::ValueEnumerator::ValueEnumerator().

◆ getAssignID()

DIAssignID * DbgVariableRecord::getAssignID ( ) const

Definition at line 508 of file DebugProgramInstruction.cpp.

References llvm::cast(), and llvm::DebugValueUser::DebugValues.

Referenced by createDebugIntrinsic(), llvm::at::getAssignmentInsts(), getIDFromMarker(), and llvm::ValueEnumerator::ValueEnumerator().

◆ getExpression()

DIExpression * llvm::DbgVariableRecord::getExpression ( ) const

inline

◆ getFragment()

std::optional< DbgVariableFragmentInfo > DbgVariableRecord::getFragment ( ) const

Definition at line 393 of file DebugProgramInstruction.cpp.

References getExpression(), and llvm::DIExpression::getFragmentInfo().

Referenced by getFragmentOrEntireVariable().

◆ getFragmentOrEntireVariable()

DbgVariableFragmentInfo llvm::DbgVariableRecord::getFragmentOrEntireVariable ( ) const

inline

Get the FragmentInfo for the variable if it exists, otherwise return a FragmentInfo that covers the entire variable if the variable size is known, otherwise return a zero-sized fragment.

Definition at line 500 of file DebugProgramInstruction.h.

References getFragment(), and getFragmentSizeInBits().

Referenced by llvm::at::calculateFragmentIntersect().

◆ getFragmentSizeInBits()

std::optional< uint64_t > DbgVariableRecord::getFragmentSizeInBits ( ) const

Get the size (in bits) of the variable, or fragment of the variable that is described.

Definition at line 397 of file DebugProgramInstruction.cpp.

References getExpression(), llvm::DIVariable::getSizeInBits(), and getVariable().

Referenced by getFragmentOrEntireVariable().

◆ getNumVariableLocationOps()

unsigned DbgVariableRecord::getNumVariableLocationOps ( ) const

Definition at line 276 of file DebugProgramInstruction.cpp.

References llvm::cast(), getRawLocation(), and hasArgList().

Referenced by addVariableLocationOps(), isKillLocation(), replaceVariableLocationOp(), and valueCoversEntireFragment().

◆ getRawAddress()

Metadata * llvm::DbgVariableRecord::getRawAddress ( ) const

inline

Definition at line 528 of file DebugProgramInstruction.h.

References llvm::DebugValueUser::DebugValues, and isDbgAssign().

Referenced by createDebugIntrinsic(), getAddress(), and llvm::ValueEnumerator::ValueEnumerator().

◆ getRawAddressExpression()

MDNode * llvm::DbgVariableRecord::getRawAddressExpression ( ) const

inline

Definition at line 534 of file DebugProgramInstruction.h.

References AddressExpression.

◆ getRawAssignID()

Metadata * llvm::DbgVariableRecord::getRawAssignID ( ) const

inline

Definition at line 531 of file DebugProgramInstruction.h.

References llvm::DebugValueUser::DebugValues.

◆ getRawExpression()

MDNode * llvm::DbgVariableRecord::getRawExpression ( ) const

inline

Definition at line 473 of file DebugProgramInstruction.h.

References Expression.

◆ getRawLocation()

Metadata * llvm::DbgVariableRecord::getRawLocation ( ) const

inline

Returns the metadata operand for the first location description.

i.e., dbg intrinsic dbg.value,declare operand and dbg.assign 1st location operand (the "value componenet"). Note the operand (singular) may be a DIArgList which is a list of values.

Definition at line 479 of file DebugProgramInstruction.h.

References llvm::DebugValueUser::DebugValues.

Referenced by buildOverlapMapAndRecordDeclares(), createDebugIntrinsic(), llvm::DbgValueDef::DbgValueDef(), getNumVariableLocationOps(), getVariableLocationOp(), hasArgList(), isKillLocation(), location_ops(), llvm::coro::salvageDebugInfo(), and llvm::ValueEnumerator::ValueEnumerator().

◆ getRawVariable()

MDNode * llvm::DbgVariableRecord::getRawVariable ( ) const

inline

Definition at line 469 of file DebugProgramInstruction.h.

References Variable.

◆ getType()

LocationType llvm::DbgVariableRecord::getType ( ) const

inline

Definition at line 462 of file DebugProgramInstruction.h.

References Type.

Referenced by createDebugIntrinsic(), DbgVariableRecord(), getAddressExpression(), llvm::FastISel::handleDbgInfo(), isKillAddress(), llvm::coro::salvageDebugInfo(), setKillAddress(), and llvm::SelectionDAGBuilder::visitDbgInfo().

◆ getValue()

Value * llvm::DbgVariableRecord::getValue ( unsigned OpIdx = 0 ) const

inline

Definition at line 481 of file DebugProgramInstruction.h.

References getVariableLocationOp(), OpIdx, and Value.

Referenced by insertNewDbgInst().

◆ getVariable()

DILocalVariable * llvm::DbgVariableRecord::getVariable ( ) const

inline

Definition at line 468 of file DebugProgramInstruction.h.

References Variable.

Referenced by llvm::ConvertDebugDeclareToDebugValue(), llvm::ConvertDebugDeclareToDebugValue(), llvm::ConvertDebugDeclareToDebugValue(), createDebugIntrinsic(), DbgVariableRecord(), findVarsWithStackSlot(), fixupDebugInfoPostExtraction(), getAggregateVariable(), getFragmentSizeInBits(), llvm::FastISel::handleDbgInfo(), llvm::InsertDebugValueAtStoreLoc(), insertNewDbgInst(), remarkAlloca(), valueCoversEntireFragment(), llvm::ValueEnumerator::ValueEnumerator(), and llvm::SelectionDAGBuilder::visitDbgInfo().

◆ getVariableLocationOp()

Value * DbgVariableRecord::getVariableLocationOp ( unsigned OpIdx ) const

Definition at line 282 of file DebugProgramInstruction.cpp.

References assert(), llvm::cast(), llvm::dyn_cast(), getRawLocation(), llvm::isa(), OpIdx, and Value.

Referenced by addVariableLocationOps(), getValue(), llvm::FastISel::handleDbgInfo(), hasValidLocation(), replaceVariableLocationOp(), replaceVariableLocationOp(), llvm::coro::salvageDebugInfo(), valueCoversEntireFragment(), and llvm::SelectionDAGBuilder::visitDbgInfo().

◆ handleChangedLocation()

LLVM_ABI void llvm::DbgVariableRecord::handleChangedLocation ( Metadata * NewLocation )

Handle changes to the location of the Value(s) that we refer to happening "under our feet".

References LLVM_ABI.

◆ hasArgList()

bool llvm::DbgVariableRecord::hasArgList ( ) const

inline

Definition at line 445 of file DebugProgramInstruction.h.

References getRawLocation(), and llvm::isa().

Referenced by getNumVariableLocationOps(), llvm::FastISel::handleDbgInfo(), isKillLocation(), replaceVariableLocationOp(), replaceVariableLocationOp(), and llvm::SelectionDAGBuilder::visitDbgInfo().

◆ hasValidLocation()

bool llvm::DbgVariableRecord::hasValidLocation ( ) const

inline

Returns true if this DbgVariableRecord has no empty MDNodes in its location list.

Definition at line 448 of file DebugProgramInstruction.h.

References getVariableLocationOp().

◆ isAddressOfVariable()

bool llvm::DbgVariableRecord::isAddressOfVariable ( ) const

inline

Does this describe the address of a local variable.

True for dbg.addr and dbg.declare, but not dbg.value or dbg.declare_value, which describes its value.

Definition at line 453 of file DebugProgramInstruction.h.

References Declare, and Type.

Referenced by llvm::ConvertDebugDeclareToDebugValue(), llvm::DbgValueDef::DbgValueDef(), promoteSingleBlockAlloca(), rewriteSingleStoreAlloca(), and valueCoversEntireFragment().

◆ isDbgAssign()

bool llvm::DbgVariableRecord::isDbgAssign ( ) const

inline

Definition at line 525 of file DebugProgramInstruction.h.

References Assign, and getType().

Referenced by llvm::ConvertDebugDeclareToDebugValue(), createDebugIntrinsic(), llvm::DbgValueDef::DbgValueDef(), llvm::memtag::DynCastToDbgAssign(), fixupDebugInfoPostExtraction(), llvm::at::getAssignmentInsts(), getIDFromMarker(), getRawAddress(), insertNewDbgInst(), LLVMDbgRecordGetKind(), replaceVariableLocationOp(), and llvm::ValueEnumerator::ValueEnumerator().

◆ isDbgDeclare()

bool llvm::DbgVariableRecord::isDbgDeclare ( ) const

inline

Definition at line 423 of file DebugProgramInstruction.h.

References Declare, and Type.

Referenced by insertNewDbgInst(), LLVMDbgRecordGetKind(), and llvm::coro::salvageDebugInfo().

◆ isDbgDeclareValue()

bool llvm::DbgVariableRecord::isDbgDeclareValue ( ) const

inline

Definition at line 425 of file DebugProgramInstruction.h.

References DeclareValue, and Type.

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

◆ isDbgValue()

bool llvm::DbgVariableRecord::isDbgValue ( ) const

inline

Definition at line 424 of file DebugProgramInstruction.h.

References Type, and Value.

Referenced by insertNewDbgInst(), and LLVMDbgRecordGetKind().

◆ isEquivalentTo()

bool llvm::DbgVariableRecord::isEquivalentTo ( const DbgVariableRecord & Other ) const

inline

Definition at line 511 of file DebugProgramInstruction.h.

References llvm::DbgRecord::DbgLoc, DbgVariableRecord(), isIdenticalToWhenDefined(), and llvm::Other.

◆ isIdenticalToWhenDefined()

bool llvm::DbgVariableRecord::isIdenticalToWhenDefined ( const DbgVariableRecord & Other ) const

inline

Definition at line 516 of file DebugProgramInstruction.h.

References AddressExpression, DbgVariableRecord(), llvm::DebugValueUser::DebugValues, Expression, llvm::Other, Type, and Variable.

Referenced by isEquivalentTo().

◆ isKillAddress()

bool DbgVariableRecord::isKillAddress ( ) const

Check whether this kills the address component.

This doesn't take into account the position of the intrinsic, therefore a returned value of false does not guarantee the address is a valid location for the variable at the intrinsic's position in IR.

Definition at line 521 of file DebugProgramInstruction.cpp.

References getAddress(), llvm::isa(), and Value.

Referenced by llvm::at::calculateFragmentIntersect(), and isKillAddress().

◆ isKillLocation()

bool DbgVariableRecord::isKillLocation ( ) const

Definition at line 387 of file DebugProgramInstruction.cpp.

References llvm::any_of(), getExpression(), getNumVariableLocationOps(), getRawLocation(), hasArgList(), llvm::isa(), llvm::DIExpression::isComplex(), location_ops(), and Value.

Referenced by llvm::DbgValueDef::DbgValueDef(), isKillAddress(), and SalvageDVI().

◆ isValueOfVariable()

bool llvm::DbgVariableRecord::isValueOfVariable ( ) const

inline

Determine if this describes the value of a local variable.

It is false for dbg.declare, but true for dbg.value and dbg.declare_value, which describes its value.

Definition at line 458 of file DebugProgramInstruction.h.

References DeclareValue, Type, and Value.

Referenced by rewriteSingleStoreAlloca().

◆ location_ops()

iterator_range< DbgVariableRecord::location_op_iterator > DbgVariableRecord::location_ops ( ) const

Get the locations corresponding to the variable referenced by the debug info intrinsic.

Depending on the intrinsic, this could be the variable's value or its address.

Definition at line 253 of file DebugProgramInstruction.cpp.

References assert(), llvm::cast(), llvm::dyn_cast(), and getRawLocation().

Referenced by addVariableLocationOps(), fixupDebugInfoPostExtraction(), llvm::insertDebugValuesForPHIs(), isKillLocation(), replaceVariableLocationOp(), setKillLocation(), and llvm::SelectionDAGBuilder::visitDbgInfo().

◆ print() [1/2]

void DbgVariableRecord::print	(	raw_ostream &	O,
		bool	IsForDebug = false ) const

Definition at line 5146 of file AsmWriter.cpp.

References getModuleFromDPI(), and print().

◆ print() [2/2]

void DbgVariableRecord::print	(	raw_ostream &	ROS,
		ModuleSlotTracker &	MST,
		bool	IsForDebug ) const

Definition at line 5171 of file AsmWriter.cpp.

References F, llvm::ModuleSlotTracker::getMachine(), getModuleFromDPI(), llvm::ModuleSlotTracker::incorporateFunction(), and llvm::DbgRecord::Marker.

◆ replaceVariableLocationOp() [1/2]

void DbgVariableRecord::replaceVariableLocationOp	(	unsigned	OpIdx,
		Value *	NewValue )

Definition at line 339 of file DebugProgramInstruction.cpp.

References assert(), llvm::cast(), llvm::DIArgList::get(), llvm::ValueAsMetadata::get(), getAsMetadata(), llvm::DbgRecord::getContext(), getNumVariableLocationOps(), getVariableLocationOp(), hasArgList(), llvm::isa(), OpIdx, llvm::SmallVectorTemplateBase< T, bool >::push_back(), setRawLocation(), and Value.

◆ replaceVariableLocationOp() [2/2]

void DbgVariableRecord::replaceVariableLocationOp	(	Value *	OldValue,
		Value *	NewValue,
		bool	AllowEmpty = false )

◆ setAddress()

void llvm::DbgVariableRecord::setAddress ( Value * V )

inline

Definition at line 541 of file DebugProgramInstruction.h.

References llvm::ValueAsMetadata::get(), llvm::DebugValueUser::resetDebugValue(), and Value.

Referenced by migrateDebugInfo(), and replaceVariableLocationOp().

◆ setAddressExpression()

void llvm::DbgVariableRecord::setAddressExpression ( DIExpression * NewExpr )

inline

Definition at line 537 of file DebugProgramInstruction.h.

References AddressExpression.

◆ setAssignId()

void DbgVariableRecord::setAssignId ( DIAssignID * New )

Definition at line 512 of file DebugProgramInstruction.cpp.

References llvm::DebugValueUser::resetDebugValue().

Referenced by migrateDebugInfo().

◆ setExpression()

void llvm::DbgVariableRecord::setExpression ( DIExpression * NewExpr )

inline

Definition at line 471 of file DebugProgramInstruction.h.

References Expression.

Referenced by addVariableLocationOps(), restorePreTransformState(), rewriteDebugUsers(), llvm::coro::salvageDebugInfo(), UpdateDbgValue(), and updateOneDbgValueForAlloca().

◆ setKillAddress()

void DbgVariableRecord::setKillAddress ( )

Kill the address component.

Definition at line 516 of file DebugProgramInstruction.cpp.

References llvm::PoisonValue::get(), llvm::ValueAsMetadata::get(), getAddress(), getType(), and llvm::DebugValueUser::resetDebugValue().

Referenced by insertNewDbgInst().

◆ setKillLocation()

void DbgVariableRecord::setKillLocation ( )

Definition at line 375 of file DebugProgramInstruction.cpp.

References llvm::PoisonValue::get(), llvm::SmallPtrSetImpl< PtrType >::insert(), location_ops(), Poison, replaceVariableLocationOp(), and Value.

Referenced by migrateDebugInfo().

◆ setRawLocation()

void llvm::DbgVariableRecord::setRawLocation ( Metadata * NewLocation )

inline

Use of this should generally be avoided; instead, replaceVariableLocationOp and addVariableLocationOps should be used where possible to avoid creating invalid state.

Definition at line 488 of file DebugProgramInstruction.h.

References assert(), llvm::isa(), and llvm::DebugValueUser::resetDebugValue().

Referenced by addVariableLocationOps(), replaceVariableLocationOp(), replaceVariableLocationOp(), and restorePreTransformState().

◆ setVariable()

void llvm::DbgVariableRecord::setVariable ( DILocalVariable * NewVar )

inline

Definition at line 467 of file DebugProgramInstruction.h.

References Variable.

Referenced by fixupDebugInfoPostExtraction().

◆ DebugValueUser

friend class DebugValueUser

friend

Definition at line 278 of file DebugProgramInstruction.h.

References DebugValueUser.

Referenced by DbgVariableRecord(), DbgVariableRecord(), DbgVariableRecord(), DbgVariableRecord(), and DebugValueUser.

Member Data Documentation

◆ AddressExpression

DbgRecordParamRef<DIExpression> llvm::DbgVariableRecord::AddressExpression

Definition at line 302 of file DebugProgramInstruction.h.

Referenced by createDVRAssign(), createLinkedDVRAssign(), createUnresolvedDbgVariableRecord(), DbgVariableRecord(), DbgVariableRecord(), getAddressExpression(), getRawAddressExpression(), isIdenticalToWhenDefined(), and setAddressExpression().

◆ Expression

DbgRecordParamRef<DIExpression> llvm::DbgVariableRecord::Expression

Definition at line 301 of file DebugProgramInstruction.h.

Referenced by createDVRAssign(), createLinkedDVRAssign(), createUnresolvedDbgVariableRecord(), DbgVariableRecord(), DbgVariableRecord(), getExpression(), getRawExpression(), isIdenticalToWhenDefined(), and setExpression().

◆ Type

LocationType llvm::DbgVariableRecord::Type

Classification of the debug-info record that this DbgVariableRecord represents.

Essentially, "does this correspond to a dbg.value, dbg.declare, or dbg.assign?". FIXME: We could use spare padding bits from DbgRecord for this.

Definition at line 294 of file DebugProgramInstruction.h.

Referenced by createUnresolvedDbgVariableRecord(), DbgVariableRecord(), DbgVariableRecord(), getType(), isAddressOfVariable(), isDbgDeclare(), isDbgDeclareValue(), isDbgValue(), isIdenticalToWhenDefined(), isValueOfVariable(), and llvm::coro::salvageDebugInfo().

◆ Variable

DbgRecordParamRef<DILocalVariable> llvm::DbgVariableRecord::Variable

Definition at line 300 of file DebugProgramInstruction.h.

Referenced by createDVRAssign(), createLinkedDVRAssign(), createUnresolvedDbgVariableRecord(), DbgVariableRecord(), DbgVariableRecord(), getRawVariable(), getVariable(), isIdenticalToWhenDefined(), remarkAlloca(), and setVariable().

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

include/llvm/IR/DebugProgramInstruction.h
lib/IR/AsmWriter.cpp
lib/IR/DebugProgramInstruction.cpp

Classes

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Friends

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ LocationType

Constructor & Destructor Documentation

◆ DbgVariableRecord() [1/4]

◆ DbgVariableRecord() [2/4]

◆ DbgVariableRecord() [3/4]

◆ DbgVariableRecord() [4/4]

Member Function Documentation

◆ addVariableLocationOps()

◆ classof()

◆ clone()

◆ createDbgVariableRecord() [1/2]

◆ createDbgVariableRecord() [2/2]

◆ createDebugIntrinsic()

◆ createDVRAssign()

◆ createDVRDeclare() [1/2]

◆ createDVRDeclare() [2/2]

◆ createDVRDeclareValue() [1/2]

◆ createDVRDeclareValue() [2/2]

◆ createLinkedDVRAssign()

◆ createUnresolvedDbgVariableRecord()

◆ getAddress()

◆ getAddressExpression()

◆ getAssignID()

◆ getExpression()

◆ getFragment()

◆ getFragmentOrEntireVariable()

◆ getFragmentSizeInBits()

◆ getNumVariableLocationOps()

◆ getRawAddress()

◆ getRawAddressExpression()

◆ getRawAssignID()

◆ getRawExpression()

◆ getRawLocation()

◆ getRawVariable()

◆ getType()

◆ getValue()

◆ getVariable()

◆ getVariableLocationOp()

◆ handleChangedLocation()

◆ hasArgList()

◆ hasValidLocation()

◆ isAddressOfVariable()

◆ isDbgAssign()

◆ isDbgDeclare()

◆ isDbgDeclareValue()

◆ isDbgValue()

◆ isEquivalentTo()

◆ isIdenticalToWhenDefined()

◆ isKillAddress()

◆ isKillLocation()

◆ isValueOfVariable()

◆ location_ops()

◆ print() [1/2]

◆ print() [2/2]

◆ replaceVariableLocationOp() [1/2]

◆ replaceVariableLocationOp() [2/2]

◆ setAddress()

◆ setAddressExpression()

◆ setAssignId()

◆ setExpression()

◆ setKillAddress()

◆ setKillLocation()

◆ setRawLocation()

◆ setVariable()

Friends And Related Symbol Documentation

◆ DebugValueUser

Member Data Documentation

◆ AddressExpression

◆ Expression

◆ Type

◆ Variable