LLVM 19.0.0git
Public Member Functions | List of all members
llvm::ImmutablePass Class Reference

ImmutablePass class - This class is used to provide information that does not need to be run. More...

#include "llvm/Pass.h"

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

Public Member Functions

 ImmutablePass (char &pid)
 
 ~ImmutablePass () override
 
virtual void initializePass ()
 initializePass - This method may be overriden by immutable passes to allow them to perform various initialization actions they require.
 
ImmutablePassgetAsImmutablePass () override
 
bool runOnModule (Module &) override
 ImmutablePasses are never run.
 
- 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)
 

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

ImmutablePass class - This class is used to provide information that does not need to be run.

This is useful for things like target information and "basic" versions of AnalysisGroups.

Definition at line 282 of file Pass.h.

Constructor & Destructor Documentation

◆ ImmutablePass()

llvm::ImmutablePass::ImmutablePass ( char pid)
inlineexplicit

Definition at line 284 of file Pass.h.

◆ ~ImmutablePass()

ImmutablePass::~ImmutablePass ( )
overridedefault

Member Function Documentation

◆ getAsImmutablePass()

ImmutablePass * llvm::ImmutablePass::getAsImmutablePass ( )
inlineoverridevirtual

Reimplemented from llvm::Pass.

Definition at line 296 of file Pass.h.

◆ initializePass()

void ImmutablePass::initializePass ( )
virtual

initializePass - This method may be overriden by immutable passes to allow them to perform various initialization actions they require.

This is primarily because an ImmutablePass can "require" another ImmutablePass, and if it does, the overloaded version of initializePass may get access to these passes with getAnalysis<>.

Definition at line 157 of file Pass.cpp.

◆ runOnModule()

bool llvm::ImmutablePass::runOnModule ( Module )
inlineoverridevirtual

ImmutablePasses are never run.

Implements llvm::ModulePass.

Definition at line 299 of file Pass.h.


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