LLVM: llvm::LazyCallGraph::Node Class Reference (original) (raw)

A node in the call graph. More...

#include "[llvm/Analysis/LazyCallGraph.h](LazyCallGraph%5F8h%5Fsource.html)"

Public Member Functions
LazyCallGraph & getGraph () const
Function & getFunction () const
StringRef getName () const
bool operator== (const Node &N) const
Equality is defined as address equality.
bool operator!= (const Node &N) const
bool isPopulated () const
Tests whether the node has been populated with edges.
bool isDead () const
Tests whether this is actually a dead node and no longer valid.
EdgeSequence & operator* () const
EdgeSequence * operator-> () const
EdgeSequence & populate ()
Populate the edges of this node if necessary.

A node in the call graph.

This represents a single node. Its primary roles are to cache the list of callees, de-duplicate and provide fast testing of whether a function is a callee, and facilitate iteration of child nodes in the graph.

The node works much like an optional in order to lazily populate the edges of each node. Until populated, there are no edges. Once populated, you can access the edges by dereferencing the node or using the -> operator as if the node was an std::optional<EdgeSequence>.

Definition at line 313 of file LazyCallGraph.h.

◆ getFunction()

Function & llvm::LazyCallGraph::Node::getFunction ( ) const inline

◆ getGraph()

LazyCallGraph & llvm::LazyCallGraph::Node::getGraph ( ) const inline

◆ getName()

StringRef llvm::LazyCallGraph::Node::getName ( ) const inline

◆ isDead()

bool llvm::LazyCallGraph::Node::isDead ( ) const inline

Tests whether this is actually a dead node and no longer valid.

Users rarely interact with nodes in this state and other methods are invalid. This is used to model a node in an edge list where the function has been completely removed.

Definition at line 336 of file LazyCallGraph.h.

References assert().

◆ isPopulated()

bool llvm::LazyCallGraph::Node::isPopulated ( ) const inline

Tests whether the node has been populated with edges.

Definition at line 329 of file LazyCallGraph.h.

◆ operator!=()

bool llvm::LazyCallGraph::Node::operator!= ( const Node & N) const inline

◆ operator*()

EdgeSequence & llvm::LazyCallGraph::Node::operator* ( ) const inline

◆ operator->()

EdgeSequence * llvm::LazyCallGraph::Node::operator-> ( ) const inline

◆ operator==()

bool llvm::LazyCallGraph::Node::operator== ( const Node & N) const inline

◆ populate()

EdgeSequence & llvm::LazyCallGraph::Node::populate ( ) inline

Populate the edges of this node if necessary.

The first time this is called it will populate the edges for this node in the graph. It does this by scanning the underlying function, so once this is done, any changes to that function must be explicitly reflected in updates to the graph.

Returns

the populated [EdgeSequence](classllvm%5F1%5F1LazyCallGraph%5F1%5F1EdgeSequence.html "The edge sequence object.") to simplify walking it.

This will not update or re-scan anything if called repeatedly. Instead, the edge sequence is cached and returned immediately on subsequent calls.

Definition at line 362 of file LazyCallGraph.h.

◆ LazyCallGraph::RefSCC

◆ operator<<

Print the name of this node's function.

Definition at line 398 of file LazyCallGraph.h.

References N.

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