llvm::DbgRecord Class Reference

Base class for non-instruction debug metadata records that have positions within IR. More...

#include "llvm/IR/DebugProgramInstruction.h"

Inheritance diagram for llvm::DbgRecord:

Public Types
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
	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)

Public Attributes
DbgMarker *	Marker = nullptr
	Marker that this DbgRecord is linked into.

Protected Member Functions
	~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 Attributes
DebugLoc	DbgLoc
Kind	RecordKind
	Subclass discriminator.

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

Detailed Description

Base class for non-instruction debug metadata records that have positions within IR.

Features various methods copied across from the Instruction class to aid ease-of-use. DbgRecords should always be linked into a DbgMarker's StoredDbgRecords list. The marker connects a DbgRecord back to its position in the BasicBlock.

We need a discriminator for dyn/isa casts. In order to avoid paying for a vtable for "virtual" functions too, subclasses must add a new discriminator value (RecordKind) and cases to a few functions in the base class: deleteRecord clone isIdenticalToWhenDefined both print methods createDebugIntrinsic

Definition at line 139 of file DebugProgramInstruction.h.

Member Typedef Documentation

const_self_iterator

using llvm::DbgRecord::const_self_iterator = simple_ilist<DbgRecord>::const_iterator

Definition at line 220 of file DebugProgramInstruction.h.

self_iterator

using llvm::DbgRecord::self_iterator = simple_ilist<DbgRecord>::iterator

Definition at line 219 of file DebugProgramInstruction.h.

Member Enumeration Documentation

Kind

enum llvm::DbgRecord::Kind : uint8_t

Subclass discriminator.

Enumerator
ValueKind
LabelKind

Definition at line 144 of file DebugProgramInstruction.h.

Constructor & Destructor Documentation

DbgRecord()

llvm::DbgRecord::DbgRecord ( Kind RecordKind, DebugLoc DL )

inline

Definition at line 151 of file DebugProgramInstruction.h.

References DbgLoc, DL, and RecordKind.

Referenced by llvm::DbgLabelRecord::classof(), llvm::DbgVariableRecord::classof(), clone(), llvm::DbgLabelRecord::DbgLabelRecord(), llvm::DbgVariableRecord::DbgVariableRecord(), llvm::DbgVariableRecord::DbgVariableRecord(), llvm::DbgVariableRecord::DbgVariableRecord(), llvm::DbgVariableRecord::DbgVariableRecord(), getNextNode(), getPrevNode(), insertAfter(), insertBefore(), isEquivalentTo(), isIdenticalToWhenDefined(), moveAfter(), and moveBefore().

~DbgRecord()

llvm::DbgRecord::~DbgRecord ( )

protecteddefault

Similarly to Value, we avoid paying the cost of a vtable by protecting the dtor and having deleteRecord dispatch cleanup.

Use deleteRecord to delete a generic record.

Member Function Documentation

clone()

DbgRecord * DbgRecord::clone

(

)

const

Definition at line 387 of file DebugProgramInstruction.cpp.

References llvm::cast(), DbgRecord(), LabelKind, llvm_unreachable, RecordKind, and ValueKind.

createDebugIntrinsic()

DbgInfoIntrinsic * DbgRecord::createDebugIntrinsic	(	Module *	M,
		Instruction *	InsertBefore ) const

Convert this DbgRecord back into an appropriate llvm.dbg.

• intrinsic. InsertBefore Optional position to insert this intrinsic.

  Returns

  A new llvm.dbg.* intrinsic representing this DbgRecord.

Definition at line 138 of file DebugProgramInstruction.cpp.

References llvm::cast(), LabelKind, llvm_unreachable, RecordKind, and ValueKind.

deleteRecord()

void DbgRecord::deleteRecord

(

)

Methods that dispatch to subclass implementations.

These need to be manually updated when a new subclass is added.

Definition at line 82 of file DebugProgramInstruction.cpp.

References llvm::cast(), LabelKind, llvm_unreachable, RecordKind, and ValueKind.

Referenced by llvm::DbgMarker::dropDbgRecords(), llvm::DbgMarker::dropOneDbgRecord(), and eraseFromParent().

dump()

LLVM_DUMP_METHOD void DbgRecord::dump

(

)

const

Definition at line 5423 of file AsmWriter.cpp.

References llvm::dbgs(), and print().

eraseFromParent()

void DbgRecord::eraseFromParent

(

)

Definition at line 682 of file DebugProgramInstruction.cpp.

References deleteRecord(), and removeFromParent().

Referenced by promoteSingleBlockAlloca(), and rewriteSingleStoreAlloca().

getBlock() [1/2]

BasicBlock * DbgRecord::getBlock

(

)

Definition at line 516 of file DebugProgramInstruction.cpp.

References Marker.

Referenced by getContext(), getContext(), getFunction(), and getFunction().

getBlock() [2/2]

const BasicBlock * DbgRecord::getBlock

(

)

const

Definition at line 518 of file DebugProgramInstruction.cpp.

References Marker.

getContext() [1/2]

LLVMContext & DbgRecord::getContext

(

)

Definition at line 532 of file DebugProgramInstruction.cpp.

References getBlock(), and llvm::BasicBlock::getContext().

Referenced by llvm::DbgVariableRecord::addVariableLocationOps(), llvm::DbgLabelRecord::createDebugIntrinsic(), llvm::getDebugValueLoc(), llvm::DbgVariableRecord::replaceVariableLocationOp(), llvm::DbgVariableRecord::replaceVariableLocationOp(), and restorePreTransformState().

getContext() [2/2]

const LLVMContext & DbgRecord::getContext

(

)

const

Definition at line 534 of file DebugProgramInstruction.cpp.

References getBlock(), and llvm::BasicBlock::getContext().

getDebugLoc()

DebugLoc llvm::DbgRecord::getDebugLoc ( ) const

inline

Definition at line 214 of file DebugProgramInstruction.h.

References DbgLoc.

Referenced by buildOverlapMapAndRecordDeclares(), llvm::DbgLabelRecord::clone(), llvm::DbgLabelRecord::createDebugIntrinsic(), llvm::DbgVariableRecord::createDebugIntrinsic(), llvm::DbgVariableRecord::DbgVariableRecord(), llvm::DbgVariableRecord::DbgVariableRecord(), findVarsWithStackSlot(), fixupDebugInfoPostExtraction(), getAggregateVariable(), llvm::getDebugValueLoc(), llvm::FastISel::handleDbgInfo(), insertNewDbgInst(), isEquivalentTo(), llvm::DebugInfoFinder::processDbgRecord(), remarkAlloca(), llvm::coro::salvageDebugInfo(), llvm::ValueEnumerator::ValueEnumerator(), and llvm::SelectionDAGBuilder::visitDbgInfo().

getFunction() [1/2]

Function * DbgRecord::getFunction

(

)

Definition at line 520 of file DebugProgramInstruction.cpp.

References getBlock(), and llvm::BasicBlock::getParent().

Referenced by getModule(), getModule(), and llvm::coro::salvageDebugInfo().

getFunction() [2/2]

const Function * DbgRecord::getFunction

(

)

const

Definition at line 522 of file DebugProgramInstruction.cpp.

References getBlock(), and llvm::BasicBlock::getParent().

getInstruction()

const Instruction * DbgRecord::getInstruction

(

)

const

Definition at line 506 of file DebugProgramInstruction.cpp.

References Marker.

getMarker() [1/2]

DbgMarker * llvm::DbgRecord::getMarker ( )

inline

Definition at line 177 of file DebugProgramInstruction.h.

References Marker.

Referenced by llvm::DbgMarker::dropOneDbgRecord(), getModuleFromDPI(), getNextNode(), insertAfter(), insertAfter(), insertBefore(), insertBefore(), llvm::DbgMarker::insertDbgRecord(), llvm::DbgMarker::insertDbgRecordAfter(), moveAfter(), moveAfter(), moveBefore(), moveBefore(), removeFromParent(), and rewriteDebugUsers().

getMarker() [2/2]

const DbgMarker * llvm::DbgRecord::getMarker ( ) const

inline

Definition at line 178 of file DebugProgramInstruction.h.

References Marker.

getModule() [1/2]

Module * DbgRecord::getModule

(

)

Definition at line 526 of file DebugProgramInstruction.cpp.

References getFunction(), and llvm::GlobalValue::getParent().

Referenced by valueCoversEntireFragment().

getModule() [2/2]

const Module * DbgRecord::getModule

(

)

const

Definition at line 528 of file DebugProgramInstruction.cpp.

References getFunction(), and llvm::GlobalValue::getParent().

getNextNode()

DbgRecord * llvm::DbgRecord::getNextNode ( )

inline

Definition at line 199 of file DebugProgramInstruction.h.

References DbgRecord(), and llvm::ilist_node_impl< ilist_detail::compute_node_options< DbgRecord, Options... >::type >::getIterator().

getParent() [1/2]

BasicBlock * DbgRecord::getParent

(

)

Definition at line 514 of file DebugProgramInstruction.cpp.

References Marker.

getParent() [2/2]

const BasicBlock * DbgRecord::getParent

(

)

const

Definition at line 510 of file DebugProgramInstruction.cpp.

References Marker.

Referenced by llvm::JumpThreadingPass::updateSSA().

getPrevNode()

DbgRecord * llvm::DbgRecord::getPrevNode ( )

inline

Definition at line 200 of file DebugProgramInstruction.h.

References DbgRecord(), and llvm::ilist_node_impl< ilist_detail::compute_node_options< DbgRecord, Options... >::type >::getIterator().

getRecordKind()

Kind llvm::DbgRecord::getRecordKind ( ) const

inline

Definition at line 173 of file DebugProgramInstruction.h.

References RecordKind.

insertAfter() [1/2]

void DbgRecord::insertAfter

(

DbgRecord *

InsertAfter

)

Definition at line 546 of file DebugProgramInstruction.cpp.

References assert(), DbgRecord(), getMarker(), and llvm::DbgMarker::insertDbgRecordAfter().

Referenced by moveAfter(), and moveAfter().

insertAfter() [2/2]

void DbgRecord::insertAfter

(

self_iterator

InsertAfter

)

Definition at line 563 of file DebugProgramInstruction.cpp.

References assert(), and getMarker().

insertBefore() [1/2]

void DbgRecord::insertBefore

(

DbgRecord *

InsertBefore

)

Definition at line 538 of file DebugProgramInstruction.cpp.

References assert(), DbgRecord(), getMarker(), and llvm::DbgMarker::insertDbgRecord().

Referenced by moveBefore(), and moveBefore().

insertBefore() [2/2]

void DbgRecord::insertBefore

(

self_iterator

InsertBefore

)

Definition at line 555 of file DebugProgramInstruction.cpp.

References assert(), and getMarker().

isEquivalentTo()

bool DbgRecord::isEquivalentTo

(

const DbgRecord &

R

)

const

Same as isIdenticalToWhenDefined but checks DebugLoc too.

Definition at line 133 of file DebugProgramInstruction.cpp.

References DbgRecord(), getDebugLoc(), and isIdenticalToWhenDefined().

isIdenticalToWhenDefined()

bool DbgRecord::isIdenticalToWhenDefined

(

const DbgRecord &

R

)

const

Definition at line 119 of file DebugProgramInstruction.cpp.

References llvm::cast(), DbgRecord(), LabelKind, llvm_unreachable, RecordKind, and ValueKind.

Referenced by isEquivalentTo().

moveAfter() [1/2]

void DbgRecord::moveAfter

(

DbgRecord *

MoveAfter

)

Definition at line 578 of file DebugProgramInstruction.cpp.

References assert(), DbgRecord(), getMarker(), insertAfter(), and removeFromParent().

moveAfter() [2/2]

void DbgRecord::moveAfter

(

self_iterator

MoveAfter

)

Definition at line 591 of file DebugProgramInstruction.cpp.

References assert(), getMarker(), insertAfter(), and removeFromParent().

moveBefore() [1/2]

void DbgRecord::moveBefore

(

DbgRecord *

MoveBefore

)

Definition at line 572 of file DebugProgramInstruction.cpp.

References assert(), DbgRecord(), getMarker(), insertBefore(), and removeFromParent().

Referenced by migrateDebugInfo().

moveBefore() [2/2]

void DbgRecord::moveBefore

(

self_iterator

MoveBefore

)

Definition at line 585 of file DebugProgramInstruction.cpp.

References assert(), getMarker(), insertBefore(), and removeFromParent().

print() [1/2]

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

Definition at line 94 of file DebugProgramInstruction.cpp.

References llvm::cast(), RecordKind, and ValueKind.

print() [2/2]

void DbgRecord::print	(	raw_ostream &	O,
		ModuleSlotTracker &	MST,
		bool	IsForDebug ) const

Definition at line 106 of file DebugProgramInstruction.cpp.

References llvm::cast(), LabelKind, llvm_unreachable, RecordKind, and ValueKind.

removeFromParent()

void DbgRecord::removeFromParent

(

)

Definition at line 677 of file DebugProgramInstruction.cpp.

References llvm::ilist_node_impl< ilist_detail::compute_node_options< DbgRecord, Options... >::type >::getIterator(), getMarker(), Marker, and llvm::DbgMarker::StoredDbgRecords.

Referenced by DbgInserterHelper(), eraseFromParent(), hoistLockstepIdenticalDbgVariableRecords(), moveAfter(), moveAfter(), moveBefore(), moveBefore(), rewriteDebugUsers(), and llvm::coro::salvageDebugInfo().

setDebugLoc()

void llvm::DbgRecord::setDebugLoc ( DebugLoc Loc )

inline

Definition at line 215 of file DebugProgramInstruction.h.

References DbgLoc.

Referenced by migrateDebugInfo(), and llvm::coro::salvageDebugInfo().

setMarker()

void llvm::DbgRecord::setMarker ( DbgMarker * M )

inline

Definition at line 175 of file DebugProgramInstruction.h.

References Marker.

Referenced by llvm::DbgMarker::absorbDebugValues().

Member Data Documentation

DbgLoc

DebugLoc llvm::DbgRecord::DbgLoc

protected

Definition at line 147 of file DebugProgramInstruction.h.

Referenced by DbgRecord(), getDebugLoc(), llvm::DbgVariableRecord::isEquivalentTo(), and setDebugLoc().

Marker

DbgMarker* llvm::DbgRecord::Marker = nullptr

Marker that this DbgRecord is linked into.

Definition at line 142 of file DebugProgramInstruction.h.

Referenced by getBlock(), getBlock(), getInstruction(), getMarker(), getMarker(), getParent(), getParent(), llvm::DbgLabelRecord::print(), llvm::DbgVariableRecord::print(), removeFromParent(), and setMarker().

RecordKind

Kind llvm::DbgRecord::RecordKind

protected

Subclass discriminator.

Definition at line 148 of file DebugProgramInstruction.h.

Referenced by clone(), createDebugIntrinsic(), DbgRecord(), deleteRecord(), getRecordKind(), isIdenticalToWhenDefined(), print(), and print().

---

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

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