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

#include "llvm/IR/DebugProgramInstruction.h"

Inheritance diagram for llvm::DbgRecord:

[legend]

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)

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

BasicBlock *	getBlock ()

const BasicBlock *	getBlock () const

Function *	getFunction ()

const Function *	getFunction () const

Module *	getModule ()

const Module *	getModule () const

LLVMContext &	getContext ()

const LLVMContext &	getContext () const

const Instruction *	getInstruction () const

const BasicBlock *	getParent () const

BasicBlock *	getParent ()

void	removeFromParent ()

void	eraseFromParent ()

DbgRecord *	getNextNode ()

DbgRecord *	getPrevNode ()

void	insertBefore (DbgRecord *InsertBefore)

void	insertAfter (DbgRecord *InsertAfter)

void	moveBefore (DbgRecord *MoveBefore)

void	moveAfter (DbgRecord *MoveAfter)

DebugLoc	getDebugLoc () const

void	setDebugLoc (DebugLoc Loc)

void	dump () const


void	deleteRecord ()
	Methods that dispatch to subclass implementations.

DbgRecord *	clone () const

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

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

bool	isIdenticalToWhenDefined (const DbgRecord &R) const

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< OptionsT >
self_iterator	getIterator ()

const_self_iterator	getIterator () const

reverse_self_iterator	getReverseIterator ()

const_reverse_self_iterator	getReverseIterator () const

bool	isSentinel () const
	Check whether this is the sentinel node.

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< OptionsT >
	ilist_node_impl ()=default

Protected Attributes
DebugLoc	DbgLoc

Kind	RecordKind
	Subclass discriminator.

Additional Inherited Members
Protected Types inherited from llvm::ilist_node_impl< OptionsT >
using	self_iterator = typename ilist_select_iterator_type< OptionsT::has_iterator_bits, OptionsT, false, false >::type

using	const_self_iterator = typename ilist_select_iterator_type< OptionsT::has_iterator_bits, OptionsT, false, true >::type

using	reverse_self_iterator = typename ilist_select_iterator_type< OptionsT::has_iterator_bits, OptionsT, true, false >::type

using	const_reverse_self_iterator = typename ilist_select_iterator_type< OptionsT::has_iterator_bits, OptionsT, true, true >::type

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 it's 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 134 of file DebugProgramInstruction.h.