LLVM  14.0.0git
Public Types | Public Member Functions | Protected Member Functions | List of all members
llvm::DDGNode Class Referenceabstract

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

#include "llvm/Analysis/DDG.h"

Inheritance diagram for llvm::DDGNode:
Inheritance graph
[legend]
Collaboration diagram for llvm::DDGNode:
Collaboration graph
[legend]

Public Types

enum  NodeKind {
  NodeKind::Unknown, NodeKind::SingleInstruction, NodeKind::MultiInstruction, NodeKind::PiBlock,
  NodeKind::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)
 
 DDGNode (DDGNode &&N)
 
virtual ~DDGNode ()=0
 
DDGNodeoperator= (const DDGNode &N)
 
DDGNodeoperator= (DDGNode &&N)
 
NodeKind getKind () const
 Getter for the kind of this node. More...
 
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. More...
 
- Public Member Functions inherited from llvm::DGNode< NodeType, EdgeType >
 DGNode (EdgeType &E)
 Create a node with a single outgoing edge E. More...
 
 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. More...
 
bool addEdge (EdgeType &E)
 Add the given edge E to this node, if it doesn't exist already. More...
 
void removeEdge (EdgeType &E)
 Remove the given edge E from this node, if it exists. More...
 
bool hasEdgeTo (const NodeType &N) const
 Test whether there is an edge that goes from this node to N. More...
 
const EdgeListTygetEdges () const
 Retrieve the outgoing edges for the node. More...
 
EdgeListTygetEdges ()
 
void clear ()
 Clear the outgoing edges. More...
 

Protected Member Functions

void setKind (NodeKind K)
 Setter for the kind of this node. More...
 
- 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. More...
 

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 42 of file DDG.h.

Member Typedef Documentation

◆ InstructionListType

Definition at line 44 of file DDG.h.

Member Enumeration Documentation

◆ NodeKind

Enumerator
Unknown 
SingleInstruction 
MultiInstruction 
PiBlock 
Root 

Definition at line 46 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 55 of file DDG.h.

◆ DDGNode() [3/4]

llvm::DDGNode::DDGNode ( const DDGNode N)
inline

Definition at line 56 of file DDG.h.

◆ DDGNode() [4/4]

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

Definition at line 57 of file DDG.h.

◆ ~DDGNode()

DDGNode::~DDGNode ( )
pure virtual

Definition at line 37 of file DDG.cpp.

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 39 of file DDG.cpp.

References llvm::append_range(), assert(), I, and llvm_unreachable.

◆ getKind()

NodeKind llvm::DDGNode::getKind ( ) const
inline

Getter for the kind of this node.

Definition at line 73 of file DDG.h.

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

◆ operator=() [1/2]

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

◆ operator=() [2/2]

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

Definition at line 66 of file DDG.h.

References move, 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 83 of file DDG.h.


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