A node in the call graph for a module. More...

#include "llvm/Analysis/CallGraph.h"

Public Types
using	CallRecord = std::pair< std::optional< WeakTrackingVH >, CallGraphNode * >
	A pair of the calling instruction (a call or invoke) and the call graph node being called.

using	CalledFunctionsVector = std::vector< CallRecord >

using	iterator = std::vector< CallRecord >::iterator

using	const_iterator = std::vector< CallRecord >::const_iterator

Public Member Functions
	CallGraphNode (CallGraph CG, Function F)
	Creates a node for the specified function.

	CallGraphNode (const CallGraphNode &)=delete

CallGraphNode &	operator= (const CallGraphNode &)=delete

	~CallGraphNode ()

Function *	getFunction () const
	Returns the function that this call graph node represents.

iterator	begin ()

iterator	end ()

const_iterator	begin () const

const_iterator	end () const

bool	empty () const

unsigned	size () const

unsigned	getNumReferences () const
	Returns the number of other CallGraphNodes in this CallGraph that reference this node in their callee list.

CallGraphNode *	operator[] (unsigned i) const
	Returns the i'th called function.

void	dump () const
	Print out this call graph node.

void	print (raw_ostream &OS) const

void	removeAllCalledFunctions ()
	Removes all edges from this CallGraphNode to any functions it calls.

void	stealCalledFunctionsFrom (CallGraphNode *N)
	Moves all the callee information from N to this node.

void	addCalledFunction (CallBase Call, CallGraphNode M)
	Adds a function to the list of functions called by this one.

void	removeCallEdge (iterator I)

void	removeCallEdgeFor (CallBase &Call)
	Removes the edge in the node for the specified call site.

void	removeAnyCallEdgeTo (CallGraphNode *Callee)
	Removes all call edges from this node to the specified callee function.

void	removeOneAbstractEdgeTo (CallGraphNode *Callee)
	Removes one edge associated with a null callsite from this node to the specified callee function.

void	replaceCallEdge (CallBase &Call, CallBase &NewCall, CallGraphNode *NewNode)
	Replaces the edge in the node for the specified call site with a new one.

Friends
class	CallGraph

Detailed Description

A node in the call graph for a module.

Typically represents a function in the call graph. There are also special "null" nodes used to represent theoretical entries in the call graph.

Definition at line 165 of file CallGraph.h.

Member Typedef Documentation

◆ CalledFunctionsVector

using llvm::CallGraphNode::CalledFunctionsVector = std::vector<CallRecord>

Definition at line 180 of file CallGraph.h.

◆ CallRecord

using llvm::CallGraphNode::CallRecord = std::pair<std::optional<WeakTrackingVH>, CallGraphNode *>

A pair of the calling instruction (a call or invoke) and the call graph node being called.

Call graph node may have two types of call records which represent an edge in the call graph - reference or a call edge. Reference edges are not associated with any call instruction and are created with the first field set to None, while real call edges have instruction address in this field. Therefore, all real call edges are expected to have a value in the first field and it is not supposed to be nullptr. Reference edges, for example, are used for connecting broker function caller to the callback function for callback call sites.

Definition at line 177 of file CallGraph.h.

◆ const_iterator

using llvm::CallGraphNode::const_iterator = std::vector<CallRecord>::const_iterator

Definition at line 193 of file CallGraph.h.

◆ iterator

using llvm::CallGraphNode::iterator = std::vector<CallRecord>::iterator

Definition at line 192 of file CallGraph.h.

Constructor & Destructor Documentation

◆ CallGraphNode() [1/2]

llvm::CallGraphNode::CallGraphNode	(	CallGraph *	CG,
		Function *	F
	)

inline

Creates a node for the specified function.

Definition at line 183 of file CallGraph.h.

References F.

◆ CallGraphNode() [2/2]

llvm::CallGraphNode::CallGraphNode ( const CallGraphNode & )

delete

◆ ~CallGraphNode()

llvm::CallGraphNode::~CallGraphNode ( )

inline

Definition at line 188 of file CallGraph.h.

References assert().

Member Function Documentation

◆ addCalledFunction()

void llvm::CallGraphNode::addCalledFunction	(	CallBase *	Call,
		CallGraphNode *	M
	)

inline

Adds a function to the list of functions called by this one.

Definition at line 241 of file CallGraph.h.

Referenced by llvm::CallGraph::addToCallGraph(), and replaceCallEdge().

◆ begin() [1/2]

iterator llvm::CallGraphNode::begin ( )

inline

Definition at line 198 of file CallGraph.h.

◆ begin() [2/2]

const_iterator llvm::CallGraphNode::begin ( ) const

inline

Definition at line 200 of file CallGraph.h.

◆ dump()

LLVM_DUMP_METHOD void CallGraphNode::dump ( ) const

Print out this call graph node.

Definition at line 203 of file CallGraph.cpp.

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

◆ empty()

bool llvm::CallGraphNode::empty ( ) const

inline

Definition at line 202 of file CallGraph.h.

Referenced by llvm::CallGraph::removeFunctionFromModule().

◆ end() [1/2]

iterator llvm::CallGraphNode::end ( )

inline

Definition at line 199 of file CallGraph.h.

◆ end() [2/2]

const_iterator llvm::CallGraphNode::end ( ) const

inline

Definition at line 201 of file CallGraph.h.

◆ getFunction()

Function * llvm::CallGraphNode::getFunction ( ) const

inline

Returns the function that this call graph node represents.

Definition at line 196 of file CallGraph.h.

Referenced by getDescription(), print(), and llvm::CallGraph::removeFunctionFromModule().

◆ getNumReferences()

unsigned llvm::CallGraphNode::getNumReferences ( ) const

inline

Returns the number of other CallGraphNodes in this CallGraph that reference this node in their callee list.

Definition at line 207 of file CallGraph.h.

Referenced by print().

◆ operator=()

CallGraphNode & llvm::CallGraphNode::operator= ( const CallGraphNode & )

delete

◆ operator[]()

CallGraphNode * llvm::CallGraphNode::operator[] ( unsigned i ) const

inline

Returns the i'th called function.

Definition at line 210 of file CallGraph.h.

References assert().

◆ print()

void CallGraphNode::print ( raw_ostream & OS ) const

Definition at line 184 of file CallGraph.cpp.

References getFunction(), llvm::Value::getName(), getNumReferences(), I, and OS.

Referenced by dump().

◆ removeAllCalledFunctions()

void llvm::CallGraphNode::removeAllCalledFunctions ( )

inline

Removes all edges from this CallGraphNode to any functions it calls.

Definition at line 226 of file CallGraph.h.

◆ removeAnyCallEdgeTo()

void CallGraphNode::removeAnyCallEdgeTo ( CallGraphNode * Callee )

Removes all call edges from this node to the specified callee function.

This takes more time to execute than removeCallEdgeTo, so it should not be used unless necessary.

Definition at line 229 of file CallGraph.cpp.

◆ removeCallEdge()

void llvm::CallGraphNode::removeCallEdge ( iterator I )

inline

Definition at line 248 of file CallGraph.h.

References I.

◆ removeCallEdgeFor()

void CallGraphNode::removeCallEdgeFor ( CallBase & Call )

Removes the edge in the node for the specified call site.

removeCallEdgeFor - This method removes the edge in the node for the specified call site.

Note that this method takes linear time, so it should be used sparingly.

Definition at line 209 of file CallGraph.cpp.

References assert(), llvm::forEachCallbackFunction(), llvm::CallGraph::getOrInsertFunction(), I, and removeOneAbstractEdgeTo().

◆ removeOneAbstractEdgeTo()

void CallGraphNode::removeOneAbstractEdgeTo ( CallGraphNode * Callee )

Removes one edge associated with a null callsite from this node to the specified callee function.

removeOneAbstractEdgeTo - Remove one edge associated with a null callsite from this node to the specified callee function.

Definition at line 241 of file CallGraph.cpp.

References assert(), and I.

Referenced by removeCallEdgeFor(), and replaceCallEdge().

◆ replaceCallEdge()

void CallGraphNode::replaceCallEdge	(	CallBase &	Call,
		CallBase &	NewCall,
		CallGraphNode *	NewNode
	)

Replaces the edge in the node for the specified call site with a new one.

replaceCallEdge - This method replaces the edge in the node for the specified call site with a new one.

Note that this method takes linear time, so it should be used sparingly.

Definition at line 257 of file CallGraph.cpp.

References addCalledFunction(), assert(), llvm::forEachCallbackFunction(), llvm::CallGraph::getOrInsertFunction(), I, N, llvm::SmallVectorTemplateBase< T, bool >::push_back(), removeOneAbstractEdgeTo(), and llvm::SmallVectorBase< Size_T >::size().

◆ size()

unsigned llvm::CallGraphNode::size ( ) const

inline

Definition at line 203 of file CallGraph.h.

◆ stealCalledFunctionsFrom()

void llvm::CallGraphNode::stealCalledFunctionsFrom ( CallGraphNode * N )

inline

Moves all the callee information from N to this node.

Definition at line 234 of file CallGraph.h.

References assert(), N, and std::swap().

Friends And Related Function Documentation

◆ CallGraph

friend class CallGraph

friend

Definition at line 278 of file CallGraph.h.

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

include/llvm/Analysis/CallGraph.h
lib/Analysis/CallGraph.cpp

Public Types

Public Member Functions

Friends

Detailed Description

Member Typedef Documentation

◆ CalledFunctionsVector

◆ CallRecord

◆ const_iterator

◆ iterator

Constructor & Destructor Documentation

◆ CallGraphNode() [1/2]

◆ CallGraphNode() [2/2]

◆ ~CallGraphNode()

Member Function Documentation

◆ addCalledFunction()

◆ begin() [1/2]

◆ begin() [2/2]

◆ dump()

◆ empty()

◆ end() [1/2]

◆ end() [2/2]

◆ getFunction()

◆ getNumReferences()

◆ operator=()

◆ operator[]()

◆ print()

◆ removeAllCalledFunctions()

◆ removeAnyCallEdgeTo()

◆ removeCallEdge()

◆ removeCallEdgeFor()

◆ removeOneAbstractEdgeTo()

◆ replaceCallEdge()

◆ size()

◆ stealCalledFunctionsFrom()

Friends And Related Function Documentation

◆ CallGraph