LLVM  6.0.0svn
Public Types | Public Member Functions | Friends | List of all members
llvm::CallGraphNode Class Reference

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

#include "llvm/Analysis/CallGraph.h"

Public Types

using CallRecord = std::pair< WeakTrackingVH, CallGraphNode * >
 A pair of the calling instruction (a call or invoke) and the call graph node being called. More...
 
using CalledFunctionsVector = std::vector< CallRecord >
 
using iterator = std::vector< CallRecord >::iterator
 
using const_iterator = std::vector< CallRecord >::const_iterator
 

Public Member Functions

 CallGraphNode (Function *F)
 Creates a node for the specified function. More...
 
 CallGraphNode (const CallGraphNode &)=delete
 
CallGraphNodeoperator= (const CallGraphNode &)=delete
 
 ~CallGraphNode ()
 
FunctiongetFunction () const
 Returns the function that this call graph node represents. More...
 
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. More...
 
CallGraphNodeoperator[] (unsigned i) const
 Returns the i'th called function. More...
 
void dump () const
 Print out this call graph node. More...
 
void print (raw_ostream &OS) const
 
void removeAllCalledFunctions ()
 Removes all edges from this CallGraphNode to any functions it calls. More...
 
void stealCalledFunctionsFrom (CallGraphNode *N)
 Moves all the callee information from N to this node. More...
 
void addCalledFunction (CallSite CS, CallGraphNode *M)
 Adds a function to the list of functions called by this one. More...
 
void removeCallEdge (iterator I)
 
void removeCallEdgeFor (CallSite CS)
 Removes the edge in the node for the specified call site. More...
 
void removeAnyCallEdgeTo (CallGraphNode *Callee)
 Removes all call edges from this node to the specified callee function. More...
 
void removeOneAbstractEdgeTo (CallGraphNode *Callee)
 Removes one edge associated with a null callsite from this node to the specified callee function. More...
 
void replaceCallEdge (CallSite CS, CallSite NewCS, CallGraphNode *NewNode)
 Replaces the edge in the node for the specified call site with a new one. More...
 

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

Definition at line 172 of file CallGraph.h.

◆ CallRecord

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

Definition at line 169 of file CallGraph.h.

◆ const_iterator

Definition at line 185 of file CallGraph.h.

◆ iterator

Definition at line 184 of file CallGraph.h.

Constructor & Destructor Documentation

◆ CallGraphNode() [1/2]

llvm::CallGraphNode::CallGraphNode ( Function F)
inline

Creates a node for the specified function.

Definition at line 175 of file CallGraph.h.

◆ CallGraphNode() [2/2]

llvm::CallGraphNode::CallGraphNode ( const CallGraphNode )
delete

◆ ~CallGraphNode()

llvm::CallGraphNode::~CallGraphNode ( )
inline

Definition at line 180 of file CallGraph.h.

References assert().

Member Function Documentation

◆ addCalledFunction()

void llvm::CallGraphNode::addCalledFunction ( CallSite  CS,
CallGraphNode M 
)
inline

◆ begin() [1/2]

iterator llvm::CallGraphNode::begin ( )
inline

◆ begin() [2/2]

const_iterator llvm::CallGraphNode::begin ( ) const
inline

Definition at line 192 of file CallGraph.h.

◆ dump()

LLVM_DUMP_METHOD void CallGraphNode::dump ( ) const

Print out this call graph node.

Definition at line 182 of file CallGraph.cpp.

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

◆ empty()

bool llvm::CallGraphNode::empty ( ) const
inline

Definition at line 194 of file CallGraph.h.

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

◆ end() [1/2]

iterator llvm::CallGraphNode::end ( )
inline

◆ end() [2/2]

const_iterator llvm::CallGraphNode::end ( ) const
inline

Definition at line 193 of file CallGraph.h.

◆ getFunction()

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

◆ 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 199 of file CallGraph.h.

◆ 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 202 of file CallGraph.h.

References assert(), llvm::CallGraph::dump(), and llvm::CallGraph::print().

◆ print()

void CallGraphNode::print ( raw_ostream OS) const

Definition at line 163 of file CallGraph.cpp.

References llvm::Value::getName(), and I.

◆ removeAllCalledFunctions()

void llvm::CallGraphNode::removeAllCalledFunctions ( )
inline

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

Definition at line 218 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 203 of file CallGraph.cpp.

References second.

Referenced by llvm::LegacyInlinerBase::removeDeadFunctions().

◆ removeCallEdge()

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

Definition at line 241 of file CallGraph.h.

References Callee.

◆ removeCallEdgeFor()

void CallGraphNode::removeCallEdgeFor ( CallSite  CS)

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 188 of file CallGraph.cpp.

References assert(), llvm::CallSiteBase< FunTy, BBTy, ValTy, UserTy, UseTy, InstrTy, CallTy, InvokeTy, IterTy >::getInstruction(), and I.

Referenced by DeleteBasicBlock(), and UpdateCallGraphAfterInlining().

◆ 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 215 of file CallGraph.cpp.

References assert(), and I.

Referenced by llvm::InternalizePass::internalizeModule().

◆ replaceCallEdge()

void CallGraphNode::replaceCallEdge ( CallSite  CS,
CallSite  NewCS,
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 231 of file CallGraph.cpp.

References assert(), llvm::CallSiteBase< FunTy, BBTy, ValTy, UserTy, UseTy, InstrTy, CallTy, InvokeTy, IterTy >::getInstruction(), and I.

Referenced by llvm::createArgumentPromotionPass().

◆ size()

unsigned llvm::CallGraphNode::size ( ) const
inline

Definition at line 195 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 226 of file CallGraph.h.

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

Referenced by llvm::createArgumentPromotionPass().

Friends And Related Function Documentation

◆ CallGraph

friend class CallGraph
friend

Definition at line 270 of file CallGraph.h.


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