LLVM API Documentation

llvm::CallGraph Class Reference

#include <CallGraph.h>

Collaboration diagram for llvm::CallGraph:

Collaboration graph
[legend]

List of all members.

Public Types

typedef FunctionMapTy::iterator iterator
typedef
FunctionMapTy::const_iterator 
const_iterator

Public Member Functions

ModulegetModule () const
iterator begin ()
iterator end ()
const_iterator begin () const
const_iterator end () const
const CallGraphNodeoperator[] (const Function *F) const
CallGraphNodeoperator[] (const Function *F)
virtual CallGraphNodegetExternalCallingNode () const
virtual CallGraphNodegetRoot ()
virtual const CallGraphNodegetRoot () const
FunctionremoveFunctionFromModule (CallGraphNode *CGN)
FunctionremoveFunctionFromModule (Function *F)
void changeFunction (Function *OldF, Function *NewF)
CallGraphNodegetOrInsertFunction (const Function *F)
virtual ~CallGraph ()
void initialize (Module &M)
virtual void print (std::ostream &o, const Module *M) const
void print (std::ostream *o, const Module *M) const
void dump () const

Static Public Attributes

static char ID = 0

Protected Types

typedef std::map< const
Function *, CallGraphNode * > 
FunctionMapTy

Protected Member Functions

 CallGraph ()
virtual void destroy ()

Protected Attributes

ModuleMod
FunctionMapTy FunctionMap


Detailed Description

Definition at line 70 of file CallGraph.h.


Member Typedef Documentation

typedef std::map<const Function *, CallGraphNode *> llvm::CallGraph::FunctionMapTy [protected]

Definition at line 74 of file CallGraph.h.

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

Definition at line 82 of file CallGraph.h.

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

Definition at line 83 of file CallGraph.h.


Constructor & Destructor Documentation

llvm::CallGraph::CallGraph (  )  [inline, protected]

Definition at line 148 of file CallGraph.h.

virtual llvm::CallGraph::~CallGraph (  )  [inline, virtual]

Definition at line 151 of file CallGraph.h.

References destroy().


Member Function Documentation

Module& llvm::CallGraph::getModule (  )  const [inline]

getModule - Return the module the call graph corresponds to.

Definition at line 87 of file CallGraph.h.

References Mod.

iterator llvm::CallGraph::begin (  )  [inline]

iterator llvm::CallGraph::end (  )  [inline]

const_iterator llvm::CallGraph::begin (  )  const [inline]

Definition at line 91 of file CallGraph.h.

References FunctionMap.

const_iterator llvm::CallGraph::end (  )  const [inline]

Definition at line 92 of file CallGraph.h.

References FunctionMap.

const CallGraphNode* llvm::CallGraph::operator[] ( const Function F  )  const [inline]

Definition at line 96 of file CallGraph.h.

References FunctionMap, and I.

CallGraphNode* llvm::CallGraph::operator[] ( const Function F  )  [inline]

Definition at line 101 of file CallGraph.h.

References FunctionMap, and I.

virtual CallGraphNode* llvm::CallGraph::getExternalCallingNode (  )  const [inline, virtual]

Returns the CallGraphNode which is used to represent undetermined calls into the callgraph. Override this if you want behavioral inheritance.

Definition at line 109 of file CallGraph.h.

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

virtual CallGraphNode* llvm::CallGraph::getRoot (  )  [inline, virtual]

Return the root/main method in the module, or some other root node, such as the externalcallingnode. Overload these if you behavioral inheritance.

Definition at line 114 of file CallGraph.h.

virtual const CallGraphNode* llvm::CallGraph::getRoot (  )  const [inline, virtual]

Definition at line 115 of file CallGraph.h.

Function * CallGraph::removeFunctionFromModule ( CallGraphNode CGN  ) 

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

References llvm::CallGraphNode::CalledFunctions, FunctionMap, llvm::CallGraphNode::getFunction(), llvm::Module::getFunctionList(), and Mod.

Referenced by InlineCallIfPossible(), llvm::Inliner::removeDeadFunctions(), and removeFunctionFromModule().

Function* llvm::CallGraph::removeFunctionFromModule ( Function F  )  [inline]

Definition at line 129 of file CallGraph.h.

References removeFunctionFromModule().

void CallGraph::changeFunction ( Function OldF,
Function NewF 
)

changeFunction - This method changes the function associated with this CallGraphNode, for use by transformations that need to change the prototype of a Function (thus they must create a new Function and move the old code over).

Definition at line 222 of file CallGraph.cpp.

References llvm::CallGraphNode::F, FunctionMap, and I.

CallGraphNode * CallGraph::getOrInsertFunction ( const Function F  ) 

getOrInsertFunction - This method is identical to calling operator[], but it will insert a new CallGraphNode for the specified function if one does not already exist.

Definition at line 235 of file CallGraph.cpp.

References FunctionMap, llvm::GlobalValue::getParent(), and Mod.

Referenced by llvm::InlineFunction().

void CallGraph::initialize ( Module M  ) 

initialize - Call this method before calling other methods, re/initializes the state of the CallGraph.

Definition at line 175 of file CallGraph.cpp.

References Mod.

void CallGraph::print ( std::ostream &  o,
const Module M 
) const [virtual]

Definition at line 188 of file CallGraph.cpp.

References begin(), E, end(), and I.

Referenced by dump(), and print().

void llvm::CallGraph::print ( std::ostream *  o,
const Module M 
) const [inline]

Definition at line 159 of file CallGraph.h.

References print().

void CallGraph::dump (  )  const

Definition at line 193 of file CallGraph.cpp.

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

void CallGraph::destroy (  )  [protected, virtual]

Definition at line 179 of file CallGraph.cpp.

References E, FunctionMap, and I.

Referenced by ~CallGraph().


Member Data Documentation

Definition at line 72 of file CallGraph.h.

Referenced by getModule(), getOrInsertFunction(), initialize(), and removeFunctionFromModule().

char CallGraph::ID = 0 [static]

Definition at line 78 of file CallGraph.h.


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



This web site is hosted by the Computer Science Department at the University of Illinois at Urbana-Champaign.