LLVM: llvm::CallGraphWrapperPass Class Reference (original) (raw)

The [ModulePass](classllvm%5F1%5F1ModulePass.html "ModulePass class - This class is used to implement unstructured interprocedural optimizations and ana...") which wraps up a [CallGraph](classllvm%5F1%5F1CallGraph.html "The basic data container for the call graph of a Module of IR.") and the logic to build it. More...

#include "[llvm/Analysis/CallGraph.h](CallGraph%5F8h%5Fsource.html)"

Public Member Functions
CallGraphWrapperPass ()
~CallGraphWrapperPass () override
const CallGraph & getCallGraph () const
The internal CallGraph around which the rest of this interface is wrapped.
CallGraph & getCallGraph ()
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.
void getAnalysisUsage (AnalysisUsage &AU) const override
getAnalysisUsage - This function should be overriden by passes that need analysis information to do their job.
bool runOnModule (Module &M) override
runOnModule - Virtual method overriden by subclasses to process the module being operated on.
void releaseMemory () override
releaseMemory() - This member can be implemented by a pass if it wants to be able to release its memory when it is no longer needed.
void print (raw_ostream &o, const Module *) const override
print - Print out the internal state of the pass.
void dump () const
Public Member Functions inherited from llvm::ModulePass
ModulePass (char &pid)
~ModulePass () override
Pass * createPrinterPass (raw_ostream &OS, const std::string &Banner) const override
createPrinterPass - Get a module printer pass.
void assignPassManager (PMStack &PMS, PassManagerType T) override
Find appropriate Module Pass Manager in the PM Stack and add self into that manager.
PassManagerType getPotentialPassManagerType () const override
Return what kind of Pass Manager can manage this pass.
Public Member Functions inherited from llvm::Pass
Pass (PassKind K, char &pid)
Pass (const Pass &)=delete
Pass & operator= (const Pass &)=delete
virtual ~Pass ()
PassKind getPassKind () const
virtual StringRef getPassName () const
getPassName - Return a nice clean name for a pass.
StringRef getPassArgument () const
Return a nice clean name for a pass corresponding to that used to enable the pass in opt.
AnalysisID getPassID () const
getPassID - Return the PassID number that corresponds to this pass.
virtual bool doInitialization (Module &)
doInitialization - Virtual method overridden by subclasses to do any necessary initialization before any pass is run.
virtual bool doFinalization (Module &)
doFinalization - Virtual method overriden by subclasses to do any necessary clean up after all passes have run.
void dump () const
virtual void preparePassManager (PMStack &)
Check if available pass managers are suitable for this pass or not.
void setResolver (AnalysisResolver *AR)
AnalysisResolver * getResolver () const
virtual ImmutablePass * getAsImmutablePass ()
virtual PMDataManager * getAsPMDataManager ()
virtual void verifyAnalysis () const
verifyAnalysis() - This member can be implemented by a analysis pass to check state of analysis information.
virtual void dumpPassStructure (unsigned Offset=0)
template
AnalysisType * getAnalysisIfAvailable () const
getAnalysisIfAvailable() - Subclasses use this function to get analysis information that might be around, for example to update it.
bool mustPreserveAnalysisID (char &AID) const
mustPreserveAnalysisID - This method serves the same function as getAnalysisIfAvailable, but works if you just have an AnalysisID.
template
AnalysisType & getAnalysis () const
getAnalysis() - This function is used by subclasses to get to the analysis information that they claim to use by overriding the getAnalysisUsage function.
template
AnalysisType & getAnalysis (Function &F, bool *Changed=nullptr)
getAnalysis() - This function is used by subclasses to get to the analysis information that they claim to use by overriding the getAnalysisUsage function.
template
AnalysisType & getAnalysisID (AnalysisID PI) const
template
AnalysisType & getAnalysisID (AnalysisID PI, Function &F, bool *Changed=nullptr)
Static Public Attributes
static char ID
Additional Inherited Members
Static Public Member Functions inherited from llvm::Pass
static const PassInfo * lookupPassInfo (const void *TI)
static const PassInfo * lookupPassInfo (StringRef Arg)
static Pass * createPass (AnalysisID ID)
Protected Member Functions inherited from llvm::ModulePass
bool skipModule (const Module &M) const
Optional passes call this function to check whether the pass should be skipped.

The [ModulePass](classllvm%5F1%5F1ModulePass.html "ModulePass class - This class is used to implement unstructured interprocedural optimizations and ana...") which wraps up a [CallGraph](classllvm%5F1%5F1CallGraph.html "The basic data container for the call graph of a Module of IR.") and the logic to build it.

This class exposes both the interface to the call graph container and the module pass which runs over a module of IR and produces the call graph. The call graph interface is entirelly a wrapper around a [CallGraph](classllvm%5F1%5F1CallGraph.html "The basic data container for the call graph of a Module of IR.") object which is stored internally for each module.

Definition at line 333 of file CallGraph.h.

◆ const_iterator

◆ iterator

CallGraphWrapperPass::CallGraphWrapperPass ( )

◆ ~CallGraphWrapperPass()

CallGraphWrapperPass::~CallGraphWrapperPass ( ) overridedefault

◆ begin() [1/2]

iterator llvm::CallGraphWrapperPass::begin ( ) inline

◆ begin() [2/2]

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

◆ dump()

◆ end() [1/2]

iterator llvm::CallGraphWrapperPass::end ( ) inline

◆ end() [2/2]

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

◆ getAnalysisUsage()

void CallGraphWrapperPass::getAnalysisUsage ( AnalysisUsage & ) const overridevirtual

◆ getCallGraph() [1/2]

CallGraph & llvm::CallGraphWrapperPass::getCallGraph ( ) inline

◆ getCallGraph() [2/2]

const CallGraph & llvm::CallGraphWrapperPass::getCallGraph ( ) const inline

The internal [CallGraph](classllvm%5F1%5F1CallGraph.html "The basic data container for the call graph of a Module of IR.") around which the rest of this interface is wrapped.

Definition at line 344 of file CallGraph.h.

◆ getCallsExternalNode()

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

◆ getExternalCallingNode()

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

Returns the [CallGraphNode](classllvm%5F1%5F1CallGraphNode.html "A node in the call graph for a module.") which is used to represent undetermined calls into the callgraph.

Definition at line 368 of file CallGraph.h.

◆ getModule()

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

Returns the module the call graph corresponds to.

Definition at line 351 of file CallGraph.h.

◆ getOrInsertFunction()

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

Definition at line 393 of file CallGraph.h.

References F.

◆ operator[]() [1/2]

Returns the call graph node for the provided function.

Definition at line 364 of file CallGraph.h.

References F.

◆ operator[]() [2/2]

Returns the call graph node for the provided function.

Definition at line 359 of file CallGraph.h.

References F.

◆ print()

print - Print out the internal state of the pass.

This is called by Analyze to print out the contents of an analysis. Otherwise it is not necessary to implement this method. Beware that the module pointer MAY be null. This automatically forwards to a virtual function that does not provide the Module* in case the analysis doesn't need it it can just be ignored.

Reimplemented from llvm::Pass.

Definition at line 322 of file CallGraph.cpp.

Referenced by dump().

◆ releaseMemory()

void llvm::CallGraphWrapperPass::releaseMemory ( ) overridevirtual

releaseMemory() - This member can be implemented by a pass if it wants to be able to release its memory when it is no longer needed.

The default behavior of passes is to hold onto memory for the entire duration of their lifetime (which is the entire compile time). For pipelined passes, this is not a big deal because that memory gets recycled every time the pass is invoked on another program unit. For IP passes, it is more important to free memory when it is unused.

Optionally implement this function to release pass memory when it is no longer used.

Reimplemented from llvm::Pass.

References dump().

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

◆ runOnModule()

bool CallGraphWrapperPass::runOnModule ( Module & M) overridevirtual

runOnModule - Virtual method overriden by subclasses to process the module being operated on.

Implements llvm::ModulePass.

Definition at line 309 of file CallGraph.cpp.

◆ ID

char llvm::CallGraphWrapperPass::ID static

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