LLVM  3.7.0
Public Member Functions | Static Public Attributes | List of all members
llvm::InlineCostAnalysis Class Reference

Cost analyzer used by inliner. More...

#include <InlineCost.h>

Inheritance diagram for llvm::InlineCostAnalysis:
[legend]
Collaboration diagram for llvm::InlineCostAnalysis:
[legend]

Public Member Functions

 InlineCostAnalysis ()
 
 ~InlineCostAnalysis () override
 
void getAnalysisUsage (AnalysisUsage &AU) const override
 getAnalysisUsage - For this class, we declare that we require and preserve the call graph. More...
 
bool runOnSCC (CallGraphSCC &SCC) override
 runOnSCC - This method should be implemented by the subclass to perform whatever action is necessary for the specified SCC. More...
 
InlineCost getInlineCost (CallSite CS, int Threshold)
 Get an InlineCost object representing the cost of inlining this callsite. More...
 
InlineCost getInlineCost (CallSite CS, Function *Callee, int Threshold)
 Get an InlineCost with the callee explicitly specified. More...
 
bool isInlineViable (Function &Callee)
 Minimal filter to detect invalid constructs for inlining. More...
 
- Public Member Functions inherited from llvm::CallGraphSCCPass
 CallGraphSCCPass (char &pid)
 
PasscreatePrinterPass (raw_ostream &O, const std::string &Banner) const override
 createPrinterPass - Get a pass that prints the Module corresponding to a CallGraph. More...
 
virtual bool doInitialization (CallGraph &CG)
 doInitialization - This method is called before the SCC's of the program has been processed, allowing the pass to do initialization as necessary. More...
 
virtual bool doFinalization (CallGraph &CG)
 doFinalization - This method is called after the SCC's of the program has been processed, allowing the pass to do final cleanup as necessary. More...
 
void assignPassManager (PMStack &PMS, PassManagerType PMT) override
 Assign pass manager to manager this pass. More...
 
PassManagerType getPotentialPassManagerType () const override
 Return what kind of Pass Manager can manage this pass. More...
 
- Public Member Functions inherited from llvm::Pass
 Pass (PassKind K, char &pid)
 
virtual ~Pass ()
 
PassKind getPassKind () const
 
virtual const char * getPassName () const
 getPassName - Return a nice clean name for a pass. More...
 
AnalysisID getPassID () const
 getPassID - Return the PassID number that corresponds to this pass. More...
 
virtual bool doInitialization (Module &)
 doInitialization - Virtual method overridden by subclasses to do any necessary initialization before any pass is run. More...
 
virtual bool doFinalization (Module &)
 doFinalization - Virtual method overriden by subclasses to do any necessary clean up after all passes have run. More...
 
virtual void print (raw_ostream &O, const Module *M) const
 print - Print out the internal state of the pass. More...
 
void dump () const
 
virtual void preparePassManager (PMStack &)
 Check if available pass managers are suitable for this pass or not. More...
 
void setResolver (AnalysisResolver *AR)
 
AnalysisResolvergetResolver () const
 
virtual void releaseMemory ()
 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. More...
 
virtual void * getAdjustedAnalysisPointer (AnalysisID ID)
 getAdjustedAnalysisPointer - This method is used when a pass implements an analysis interface through multiple inheritance. More...
 
virtual ImmutablePassgetAsImmutablePass ()
 
virtual PMDataManagergetAsPMDataManager ()
 
virtual void verifyAnalysis () const
 verifyAnalysis() - This member can be implemented by a analysis pass to check state of analysis information. More...
 
virtual void dumpPassStructure (unsigned Offset=0)
 
template<typename AnalysisType >
AnalysisType * getAnalysisIfAvailable () const
 getAnalysisIfAvailable<AnalysisType>() - Subclasses use this function to get analysis information that might be around, for example to update it. More...
 
bool mustPreserveAnalysisID (char &AID) const
 mustPreserveAnalysisID - This method serves the same function as getAnalysisIfAvailable, but works if you just have an AnalysisID. More...
 
template<typename AnalysisType >
AnalysisType & getAnalysis () const
 getAnalysis<AnalysisType>() - This function is used by subclasses to get to the analysis information that they claim to use by overriding the getAnalysisUsage function. More...
 
template<typename AnalysisType >
AnalysisType & getAnalysis (Function &F)
 getAnalysis<AnalysisType>() - This function is used by subclasses to get to the analysis information that they claim to use by overriding the getAnalysisUsage function. More...
 
template<typename AnalysisType >
AnalysisType & getAnalysisID (AnalysisID PI) const
 
template<typename AnalysisType >
AnalysisType & getAnalysisID (AnalysisID PI, Function &F)
 

Static Public Attributes

static char ID = 0
 

Additional Inherited Members

- Static Public Member Functions inherited from llvm::Pass
static const PassInfolookupPassInfo (const void *TI)
 
static const PassInfolookupPassInfo (StringRef Arg)
 
static PasscreatePass (AnalysisID ID)
 

Detailed Description

Cost analyzer used by inliner.

Definition at line 102 of file InlineCost.h.

Constructor & Destructor Documentation

InlineCostAnalysis::InlineCostAnalysis ( )

Definition at line 1316 of file InlineCost.cpp.

InlineCostAnalysis::~InlineCostAnalysis ( )
override

Definition at line 1318 of file InlineCost.cpp.

Member Function Documentation

void InlineCostAnalysis::getAnalysisUsage ( AnalysisUsage AU) const
overridevirtual

getAnalysisUsage - For this class, we declare that we require and preserve the call graph.

For this class, we declare that we require and preserve the call graph.

If the derived class implements this method, it should always explicitly call the implementation here.

Reimplemented from llvm::CallGraphSCCPass.

Definition at line 1320 of file InlineCost.cpp.

References llvm::AnalysisUsage::addRequired(), llvm::CallGraphSCCPass::getAnalysisUsage(), and llvm::AnalysisUsage::setPreservesAll().

InlineCost InlineCostAnalysis::getInlineCost ( CallSite  CS,
int  Threshold 
)

Get an InlineCost object representing the cost of inlining this callsite.

Note that threshold is passed into this function. Only costs below the threshold are computed with any accuracy. The threshold can be used to bound the computation necessary to determine whether the cost is sufficiently low to warrant inlining.

Also note that calling this function dynamically computes the cost of inlining the callsite. It is an expensive, heavyweight call.

Definition at line 1333 of file InlineCost.cpp.

References llvm::CallSiteBase< FunTy, BBTy, ValTy, UserTy, InstrTy, CallTy, InvokeTy, IterTy >::getCalledFunction(), and Threshold.

InlineCost InlineCostAnalysis::getInlineCost ( CallSite  CS,
Function Callee,
int  Threshold 
)
bool InlineCostAnalysis::isInlineViable ( Function Callee)
bool InlineCostAnalysis::runOnSCC ( CallGraphSCC SCC)
overridevirtual

runOnSCC - This method should be implemented by the subclass to perform whatever action is necessary for the specified SCC.

Note that non-recursive (or only self-recursive) functions will have an SCC size of 1, where recursive portions of the call graph will have SCC size > 1.

SCC passes that add or delete functions to the SCC are required to update the SCC list, otherwise stale pointers may be dereferenced.

Implements llvm::CallGraphSCCPass.

Definition at line 1327 of file InlineCost.cpp.

Member Data Documentation

Inline Cost true char InlineCostAnalysis::ID = 0
inlinestatic

Definition at line 107 of file InlineCost.h.


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