LLVM 20.0.0git
Public Member Functions | Static Public Attributes | List of all members
llvm::ModuleSummaryIndexWrapperPass Class Reference

Legacy wrapper pass to provide the ModuleSummaryIndex object. More...

#include "llvm/Analysis/ModuleSummaryAnalysis.h"

Inheritance diagram for llvm::ModuleSummaryIndexWrapperPass:
Inheritance graph
[legend]

Public Member Functions

 ModuleSummaryIndexWrapperPass ()
 
ModuleSummaryIndexgetIndex ()
 Get the index built by pass.
 
const ModuleSummaryIndexgetIndex () const
 
bool runOnModule (Module &M) override
 runOnModule - Virtual method overriden by subclasses to process the module being operated on.
 
bool doFinalization (Module &M) override
 doFinalization - Virtual method overriden by subclasses to do any necessary clean up after all passes have run.
 
void getAnalysisUsage (AnalysisUsage &AU) const override
 getAnalysisUsage - This function should be overriden by passes that need analysis information to do their job.
 
- Public Member Functions inherited from llvm::ModulePass
 ModulePass (char &pid)
 
 ~ModulePass () override
 
PasscreatePrinterPass (raw_ostream &OS, const std::string &Banner) const override
 createPrinterPass - Get a module printer pass.
 
virtual bool runOnModule (Module &M)=0
 runOnModule - Virtual method overriden by subclasses to process the module being operated on.
 
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
 
Passoperator= (const Pass &)=delete
 
virtual ~Pass ()
 
PassKind getPassKind () const
 
virtual StringRef getPassName () const
 getPassName - Return a nice clean name for a pass.
 
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.
 
virtual void print (raw_ostream &OS, const Module *M) const
 print - Print out the internal state of the pass.
 
void dump () const
 
virtual PasscreatePrinterPass (raw_ostream &OS, const std::string &Banner) const =0
 createPrinterPass - Get a Pass appropriate to print the IR this pass operates on (Module, Function or MachineFunction).
 
virtual void assignPassManager (PMStack &, PassManagerType)
 Each pass is responsible for assigning a pass manager to itself.
 
virtual void preparePassManager (PMStack &)
 Check if available pass managers are suitable for this pass or not.
 
virtual PassManagerType getPotentialPassManagerType () const
 Return what kind of Pass Manager can manage this pass.
 
void setResolver (AnalysisResolver *AR)
 
AnalysisResolvergetResolver () const
 
virtual void getAnalysisUsage (AnalysisUsage &) const
 getAnalysisUsage - This function should be overriden by passes that need analysis information to do their job.
 
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.
 
virtual void * getAdjustedAnalysisPointer (AnalysisID ID)
 getAdjustedAnalysisPointer - This method is used when a pass implements an analysis interface through multiple inheritance.
 
virtual ImmutablePassgetAsImmutablePass ()
 
virtual PMDataManagergetAsPMDataManager ()
 
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<typename AnalysisType >
AnalysisType * getAnalysisIfAvailable () const
 getAnalysisIfAvailable<AnalysisType>() - 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<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.
 
template<typename AnalysisType >
AnalysisType & getAnalysis (Function &F, bool *Changed=nullptr)
 getAnalysis<AnalysisType>() - This function is used by subclasses to get to the analysis information that they claim to use by overriding the getAnalysisUsage function.
 
template<typename AnalysisType >
AnalysisType & getAnalysisID (AnalysisID PI) const
 
template<typename AnalysisType >
AnalysisType & getAnalysisID (AnalysisID PI, Function &F, bool *Changed=nullptr)
 

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)
 
- Protected Member Functions inherited from llvm::ModulePass
bool skipModule (Module &M) const
 Optional passes call this function to check whether the pass should be skipped.
 

Detailed Description

Legacy wrapper pass to provide the ModuleSummaryIndex object.

Definition at line 57 of file ModuleSummaryAnalysis.h.

Constructor & Destructor Documentation

◆ ModuleSummaryIndexWrapperPass()

ModuleSummaryIndexWrapperPass::ModuleSummaryIndexWrapperPass ( )

Member Function Documentation

◆ doFinalization()

bool ModuleSummaryIndexWrapperPass::doFinalization ( Module )
overridevirtual

doFinalization - Virtual method overriden by subclasses to do any necessary clean up after all passes have run.

Reimplemented from llvm::Pass.

Definition at line 1155 of file ModuleSummaryAnalysis.cpp.

◆ getAnalysisUsage()

void ModuleSummaryIndexWrapperPass::getAnalysisUsage ( AnalysisUsage ) const
overridevirtual

getAnalysisUsage - This function should be overriden by passes that need analysis information to do their job.

If a pass specifies that it uses a particular analysis result to this function, it can then use the getAnalysis<AnalysisType>() function, below.

Reimplemented from llvm::Pass.

Definition at line 1160 of file ModuleSummaryAnalysis.cpp.

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

◆ getIndex() [1/2]

ModuleSummaryIndex & llvm::ModuleSummaryIndexWrapperPass::getIndex ( )
inline

Get the index built by pass.

Definition at line 66 of file ModuleSummaryAnalysis.h.

◆ getIndex() [2/2]

const ModuleSummaryIndex & llvm::ModuleSummaryIndexWrapperPass::getIndex ( ) const
inline

Definition at line 67 of file ModuleSummaryAnalysis.h.

◆ runOnModule()

bool ModuleSummaryIndexWrapperPass::runOnModule ( Module M)
overridevirtual

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

Implements llvm::ModulePass.

Definition at line 1135 of file ModuleSummaryAnalysis.cpp.

References llvm::buildModuleSummaryIndex(), F, and llvm::needsParamAccessSummary().

Member Data Documentation

◆ ID

char ModuleSummaryIndexWrapperPass::ID = 0
static

Definition at line 61 of file ModuleSummaryAnalysis.h.


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