llvm::DDGNode Class Reference

Data Dependence Graph Node The graph can represent the following types of nodes: More...

#include "llvm/Analysis/DDG.h"

Inheritance diagram for llvm::DDGNode:

Public Types
enum class	NodeKind {   Unknown , SingleInstruction , MultiInstruction , PiBlock ,   Root }
using	InstructionListType = SmallVectorImpl< Instruction * >
Public Types inherited from llvm::DGNode< NodeType, EdgeType >
using	EdgeListTy = SetVector< EdgeType * >
using	iterator = typename EdgeListTy::iterator
using	const_iterator = typename EdgeListTy::const_iterator

Public Member Functions
	DDGNode ()=delete
	DDGNode (const NodeKind K)
	DDGNode (const DDGNode &N)=default
	DDGNode (DDGNode &&N)
virtual	~DDGNode ()=0
DDGNode &	operator= (const DDGNode &N)
DDGNode &	operator= (DDGNode &&N)
NodeKind	getKind () const
	Getter for the kind of this node.
bool	collectInstructions (llvm::function_ref< bool(Instruction *)> const &Pred, InstructionListType &IList) const
	Collect a list of instructions, in IList, for which predicate Pred evaluates to true when iterating over instructions of this node.
Public Member Functions inherited from llvm::DGNode< NodeType, EdgeType >
	DGNode (EdgeType &E)
	Create a node with a single outgoing edge E.
	DGNode ()=default
	DGNode (const DGNode< NodeType, EdgeType > &N)
	DGNode (DGNode< NodeType, EdgeType > &&N)
DGNode< NodeType, EdgeType > &	operator= (const DGNode< NodeType, EdgeType > &N)
DGNode< NodeType, EdgeType > &	operator= (const DGNode< NodeType, EdgeType > &&N)
const_iterator	begin () const
const_iterator	end () const
iterator	begin ()
iterator	end ()
const EdgeType &	front () const
EdgeType &	front ()
const EdgeType &	back () const
EdgeType &	back ()
bool	findEdgesTo (const NodeType &N, SmallVectorImpl< EdgeType * > &EL) const
	Collect in EL, all the edges from this node to N.
bool	addEdge (EdgeType &E)
	Add the given edge E to this node, if it doesn't exist already.
void	removeEdge (EdgeType &E)
	Remove the given edge E from this node, if it exists.
bool	hasEdgeTo (const NodeType &N) const
	Test whether there is an edge that goes from this node to N.
const EdgeListTy &	getEdges () const
	Retrieve the outgoing edges for the node.
EdgeListTy &	getEdges ()
void	clear ()
	Clear the outgoing edges.

Protected Member Functions
void	setKind (NodeKind K)
	Setter for the kind of this node.
Protected Member Functions inherited from llvm::DGNode< NodeType, EdgeType >
bool	isEqualTo (const NodeType &N) const
NodeType &	getDerived ()
const NodeType &	getDerived () const
const_iterator	findEdgeTo (const NodeType &N) const
	Find an edge to N.

Additional Inherited Members
Protected Attributes inherited from llvm::DGNode< NodeType, EdgeType >
EdgeListTy	Edges

Detailed Description

Data Dependence Graph Node The graph can represent the following types of nodes:

1. Single instruction node containing just one instruction.
2. Multiple instruction node where two or more instructions from the same basic block are merged into one node.
3. Pi-block node which is a group of other DDG nodes that are part of a strongly-connected component of the graph. A pi-block node contains more than one single or multiple instruction nodes. The root node cannot be part of a pi-block.
4. Root node is a special node that connects to all components such that there is always a path from it to any node in the graph.

Definition at line 44 of file DDG.h.

Member Typedef Documentation

InstructionListType

using llvm::DDGNode::InstructionListType = SmallVectorImpl<Instruction *>

Definition at line 46 of file DDG.h.

Member Enumeration Documentation

NodeKind

enum class llvm::DDGNode::NodeKind

strong

Enumerator
Unknown
SingleInstruction
MultiInstruction
PiBlock
Root

Definition at line 48 of file DDG.h.

Constructor & Destructor Documentation

DDGNode() [1/4]

llvm::DDGNode::DDGNode ( )

delete

DDGNode() [2/4]

llvm::DDGNode::DDGNode ( const NodeKind  K )

inline

Definition at line 57 of file DDG.h.

DDGNode() [3/4]

llvm::DDGNode::DDGNode ( const DDGNode &  N )

default

DDGNode() [4/4]

llvm::DDGNode::DDGNode ( DDGNode &&  N )

inline

Definition at line 59 of file DDG.h.

~DDGNode()

DDGNode::~DDGNode ( )

pure virtualdefault

Member Function Documentation

collectInstructions()

bool DDGNode::collectInstructions	(	llvm::function_ref< bool(Instruction *)> const &	Pred,
		InstructionListType &	IList
	)		const

Collect a list of instructions, in IList, for which predicate Pred evaluates to true when iterating over instructions of this node.

Return true if at least one instruction was collected, and false otherwise.

Definition at line 38 of file DDG.cpp.

References llvm::append_range(), assert(), llvm::SmallVectorBase< Size_T >::empty(), I, llvm_unreachable, and llvm::SmallVectorTemplateBase< T, bool >::push_back().

getKind()

NodeKind llvm::DDGNode::getKind ( ) const

inline

Getter for the kind of this node.

Definition at line 75 of file DDG.h.

Referenced by llvm::PiBlockDDGNode::PiBlockDDGNode(), and llvm::SimpleDDGNode::SimpleDDGNode().

operator=() [1/2]

DDGNode & llvm::DDGNode::operator= ( const DDGNode &  N )

inline

Definition at line 62 of file DDG.h.

References N, and llvm::DGNode< NodeType, EdgeType >::operator=().

Referenced by llvm::PiBlockDDGNode::operator=(), and llvm::SimpleDDGNode::operator=().

operator=() [2/2]

DDGNode & llvm::DDGNode::operator= ( DDGNode &&  N )

inline

Definition at line 68 of file DDG.h.

References N, and llvm::DGNode< NodeType, EdgeType >::operator=().

setKind()

void llvm::DDGNode::setKind ( NodeKind  K )

inlineprotected

Setter for the kind of this node.

Definition at line 85 of file DDG.h.

---

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

• include/llvm/Analysis/DDG.h
• lib/Analysis/DDG.cpp