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

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

#include "llvm/Analysis/CallGraph.h"

Public Types

using iterator = FunctionMapTy::iterator
 
using const_iterator = FunctionMapTy::const_iterator
 

Public Member Functions

 CallGraph (Module &M)
 
 CallGraph (CallGraph &&Arg)
 
 ~CallGraph ()
 
void print (raw_ostream &OS) const
 
void dump () const
 
ModulegetModule () const
 Returns the module the call graph corresponds to. More...
 
iterator begin ()
 
iterator end ()
 
const_iterator begin () const
 
const_iterator end () const
 
const CallGraphNodeoperator[] (const Function *F) const
 Returns the call graph node for the provided function. More...
 
CallGraphNodeoperator[] (const Function *F)
 Returns the call graph node for the provided function. More...
 
CallGraphNodegetExternalCallingNode () const
 Returns the CallGraphNode which is used to represent undetermined calls into the callgraph. More...
 
CallGraphNodegetCallsExternalNode () const
 
FunctionremoveFunctionFromModule (CallGraphNode *CGN)
 Unlink the function from this module, returning it. More...
 
CallGraphNodegetOrInsertFunction (const Function *F)
 Similar to operator[], but this will insert a new CallGraphNode for F if one does not already exist. More...
 

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

◆ const_iterator

using llvm::CallGraph::const_iterator = FunctionMapTy::const_iterator

Definition at line 111 of file CallGraph.h.

◆ iterator

using llvm::CallGraph::iterator = FunctionMapTy::iterator

Definition at line 110 of file CallGraph.h.

Constructor & Destructor Documentation

◆ CallGraph() [1/2]

CallGraph::CallGraph ( Module M)
explicit

Definition at line 31 of file CallGraph.cpp.

References F().

Referenced by llvm::CallGraphAnalysis::run().

◆ CallGraph() [2/2]

CallGraph::CallGraph ( CallGraph &&  Arg)

Definition at line 39 of file CallGraph.cpp.

References Arg.

◆ ~CallGraph()

CallGraph::~CallGraph ( )

Member Function Documentation

◆ begin() [1/2]

iterator llvm::CallGraph::begin ( )
inline

◆ begin() [2/2]

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

Definition at line 118 of file CallGraph.h.

◆ dump()

LLVM_DUMP_METHOD void CallGraph::dump ( ) const

◆ end() [1/2]

iterator llvm::CallGraph::end ( )
inline

◆ end() [2/2]

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

Definition at line 119 of file CallGraph.h.

◆ getCallsExternalNode()

CallGraphNode* llvm::CallGraph::getCallsExternalNode ( ) const
inline

Definition at line 139 of file CallGraph.h.

References getOrInsertFunction(), and removeFunctionFromModule().

Referenced by buildCGN(), and prepareForSplit().

◆ getExternalCallingNode()

CallGraphNode* llvm::CallGraph::getExternalCallingNode ( ) const
inline

◆ getModule()

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

Returns the module the call graph corresponds to.

Definition at line 114 of file CallGraph.h.

Referenced by copyFeaturesToFunction(), createDevirtTriggerFunc(), llvm::LegacyInlinerBase::doInitialization(), and llvm::CallGraphSCCPass::skipSCC().

◆ getOrInsertFunction()

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

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

Referenced by buildCGN(), llvm::createArgumentPromotionPass(), createDevirtTriggerFunc(), getCallsExternalNode(), llvm::coro::updateCallGraph(), and ~CallGraph().

◆ operator[]() [1/2]

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

Returns the call graph node for the provided function.

Definition at line 122 of file CallGraph.h.

References assert(), and I.

◆ operator[]() [2/2]

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

Returns the call graph node for the provided function.

Definition at line 129 of file CallGraph.h.

References assert(), and I.

◆ print()

void CallGraph::print ( raw_ostream OS) const

◆ removeFunctionFromModule()

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

References assert(), llvm::CallGraphNode::empty(), F(), llvm::CallGraphNode::getFunction(), llvm::Module::getFunctionList(), I, and llvm::iplist_impl< IntrusiveListT, TraitsT >::remove().

Referenced by llvm::createArgumentPromotionPass(), getCallsExternalNode(), and inlineCallsImpl().


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