LLVM 22.0.0git
llvm::ExternalAAWrapperPass Struct Reference

A wrapper pass for external alias analyses. More...

#include "llvm/Analysis/AliasAnalysis.h"

Inheritance diagram for llvm::ExternalAAWrapperPass:
[legend]

Public Types

using CallbackT = std::function<void(Pass &, Function &, AAResults &)>

Public Member Functions

LLVM_ABI ExternalAAWrapperPass ()
LLVM_ABI ExternalAAWrapperPass (CallbackT CB, bool RunEarly=false)
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::ImmutablePass
 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.
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.
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.
virtual void print (raw_ostream &OS, const Module *M) const
 print - Print out the internal state of the pass.
void dump () const
virtual void preparePassManager (PMStack &)
 Check if available pass managers are suitable for this pass or not.
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.
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)

Public Attributes

CallbackT CB
bool RunEarly = false
 Flag indicating whether this external AA should run before Basic AA.

Static Public Attributes

static LLVM_ABI 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 (const Module &M) const
 Optional passes call this function to check whether the pass should be skipped.

Detailed Description

A wrapper pass for external alias analyses.

This just squirrels away the callback used to run any analyses and register their results.

Definition at line 1040 of file AliasAnalysis.h.

Member Typedef Documentation

◆ CallbackT

using llvm::ExternalAAWrapperPass::CallbackT = std::function<void(Pass &, Function &, AAResults &)>

Definition at line 1041 of file AliasAnalysis.h.

Constructor & Destructor Documentation

◆ ExternalAAWrapperPass() [1/2]

ExternalAAWrapperPass::ExternalAAWrapperPass ( )

◆ ExternalAAWrapperPass() [2/2]

ExternalAAWrapperPass::ExternalAAWrapperPass ( CallbackT CB,
bool RunEarly = false )
explicit

Definition at line 708 of file AliasAnalysis.cpp.

References CB, ID, llvm::ImmutablePass::ImmutablePass(), llvm::move(), and RunEarly.

Member Function Documentation

◆ getAnalysisUsage()

void llvm::ExternalAAWrapperPass::getAnalysisUsage ( AnalysisUsage & ) const
inlineoverridevirtual

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 1068 of file AliasAnalysis.h.

References llvm::AnalysisUsage::setPreservesAll().

Member Data Documentation

◆ CB

CallbackT llvm::ExternalAAWrapperPass::CB

Definition at line 1043 of file AliasAnalysis.h.

Referenced by ExternalAAWrapperPass().

◆ ID

char ExternalAAWrapperPass::ID = 0
static

Definition at line 1045 of file AliasAnalysis.h.

Referenced by ExternalAAWrapperPass(), and ExternalAAWrapperPass().

◆ RunEarly

bool llvm::ExternalAAWrapperPass::RunEarly = false

Flag indicating whether this external AA should run before Basic AA.

This flag is for LegacyPassManager only. To run an external AA early with the NewPassManager, override the registerEarlyDefaultAliasAnalyses method on the target machine.

By default, external AA passes are run after Basic AA. If this flag is set to true, the external AA will be run before Basic AA during alias analysis.

For some targets, we prefer to run the external AA early to improve compile time as it has more target-specific information. This is particularly useful when the external AA can provide more precise results than Basic AA so that Basic AA does not need to spend time recomputing them.

Definition at line 1066 of file AliasAnalysis.h.

Referenced by ExternalAAWrapperPass().


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