llvm::CallGraph Class Reference

The basic data container for the call graph of a Module of IR. More...

#include <CallGraph.h>

List of all members.

Public Types
typedef FunctionMapTy::iterator	iterator
typedef FunctionMapTy::const_iterator	const_iterator
Public Member Functions
	CallGraph (Module &M)
	~CallGraph ()
void	print (raw_ostream &OS) const
void	dump () const
Module &	getModule () const
	Returns the module the call graph corresponds to.
iterator	begin ()
iterator	end ()
const_iterator	begin () const
const_iterator	end () const
const CallGraphNode *	operator[] (const Function *F) const
	Returns the call graph node for the provided function.
CallGraphNode *	operator[] (const Function *F)
	Returns the call graph node for the provided function.
CallGraphNode *	getExternalCallingNode () const
	Returns the CallGraphNode which is used to represent undetermined calls into the callgraph.
CallGraphNode *	getCallsExternalNode () const
Function *	removeFunctionFromModule (CallGraphNode *CGN)
	Unlink the function from this module, returning it.
CallGraphNode *	getOrInsertFunction (const Function *F)
	Similar to operator[], but this will insert a new CallGraphNode for F if one does not already exist.

---

Detailed Description

The basic data container for the call graph of a Module of IR.

This class exposes both the interface to the call graph for a module of IR.

The core call graph itself can also be updated to reflect changes to the IR.

Definition at line 74 of file CallGraph.h.

---

Member Typedef Documentation

typedef FunctionMapTy::const_iterator llvm::CallGraph::const_iterator

Definition at line 113 of file CallGraph.h.

typedef FunctionMapTy::iterator llvm::CallGraph::iterator

Definition at line 112 of file CallGraph.h.

---

Constructor & Destructor Documentation

CallGraph::CallGraph

(

Module &

M

)

Definition at line 23 of file CallGraph.cpp.

References llvm::Module::begin(), llvm::Module::end(), and I.

CallGraph::~CallGraph

(

)

Definition at line 35 of file CallGraph.cpp.

References I.

---

Member Function Documentation

iterator llvm::CallGraph::begin

(

)

[inline]

Definition at line 118 of file CallGraph.h.

Referenced by llvm::GraphTraits< CallGraph * >::nodes_begin(), llvm::GraphTraits< const CallGraph * >::nodes_begin(), print(), and llvm::Inliner::removeDeadFunctions().

const_iterator llvm::CallGraph::begin

(

)

const [inline]

Definition at line 120 of file CallGraph.h.

void CallGraph::dump

(

)

const

Definition at line 106 of file CallGraph.cpp.

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

iterator llvm::CallGraph::end

(

)

[inline]

Definition at line 119 of file CallGraph.h.

Referenced by llvm::GraphTraits< CallGraph * >::nodes_end(), llvm::GraphTraits< const CallGraph * >::nodes_end(), print(), and llvm::Inliner::removeDeadFunctions().

const_iterator llvm::CallGraph::end

(

)

const [inline]

Definition at line 121 of file CallGraph.h.

CallGraphNode* llvm::CallGraph::getCallsExternalNode

(

)

const [inline]

Definition at line 141 of file CallGraph.h.

CallGraphNode* llvm::CallGraph::getExternalCallingNode

(

)

const [inline]

Returns the CallGraphNode which is used to represent undetermined calls into the callgraph.

Definition at line 139 of file CallGraph.h.

Referenced by llvm::GraphTraits< CallGraph * >::getEntryNode(), llvm::GraphTraits< const CallGraph * >::getEntryNode(), and llvm::Inliner::removeDeadFunctions().

Module& llvm::CallGraph::getModule

(

)

const [inline]

Returns the module the call graph corresponds to.

Definition at line 116 of file CallGraph.h.

CallGraphNode * CallGraph::getOrInsertFunction

(

const Function *

F

)

Similar to operator[], but this will insert a new CallGraphNode for F if one does not already exist.

Definition at line 144 of file CallGraph.cpp.

References F(), and llvm::GlobalValue::getParent().

const CallGraphNode* llvm::CallGraph::operator[]

(

const Function *

F

)

const [inline]

Returns the call graph node for the provided function.

Definition at line 124 of file CallGraph.h.

References I.

CallGraphNode* llvm::CallGraph::operator[]

(

const Function *

F

)

[inline]

Returns the call graph node for the provided function.

Definition at line 131 of file CallGraph.h.

References I.

void CallGraph::print

(

raw_ostream &

OS

)

const

Definition at line 93 of file CallGraph.cpp.

References begin(), end(), llvm::CallGraphNode::getFunction(), llvm::Value::getName(), and I.

Referenced by dump().

Function * CallGraph::removeFunctionFromModule

(

CallGraphNode *

CGN

)

Unlink the function from this module, returning it.

Because this removes the function from the module, the call graph node is destroyed. This is only valid if the function does not call any other functions (ie, there are no edges in it's CGN). The easiest way to do this is to dropAllReferences before calling this.

Definition at line 115 of file CallGraph.cpp.

References llvm::CallGraphNode::empty(), F(), llvm::CallGraphNode::getFunction(), llvm::Module::getFunctionList(), and llvm::iplist< NodeTy, Traits >::remove().

Referenced by llvm::Inliner::removeDeadFunctions(), and llvm::Inliner::runOnSCC().

---

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

• CallGraph.h
• CallGraph.cpp