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

An immutable pass that tracks lazily created [AssumptionCache](classllvm%5F1%5F1AssumptionCache.html "A cache of @llvm.assume calls within a function.") objects. More...

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

Public Member Functions
AssumptionCache & getAssumptionCache (Function &F)
Get the cached assumptions for a function.
AssumptionCache * lookupAssumptionCache (Function &F)
Return the cached assumptions for a function if it has already been scanned.
AssumptionCacheTracker ()
~AssumptionCacheTracker () override
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 verifyAnalysis () const override
verifyAnalysis() - This member can be implemented by a analysis pass to check state of analysis information.
bool doFinalization (Module &) override
doFinalization - Virtual method overriden by subclasses to do any necessary clean up after all passes have run.
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.
ImmutablePass * getAsImmutablePass () override
bool runOnModule (Module &) override
ImmutablePasses are never run.
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 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)
AnalysisResolver * getResolver () const
virtual void getAnalysisUsage (AnalysisUsage &) const
getAnalysisUsage - This function should be overriden by passes that need analysis information to do their job.
virtual PMDataManager * getAsPMDataManager ()
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 = 0
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.

An immutable pass that tracks lazily created [AssumptionCache](classllvm%5F1%5F1AssumptionCache.html "A cache of @llvm.assume calls within a function.") objects.

This is essentially a workaround for the legacy pass manager's weaknesses which associates each assumption cache with Function and clears it if the function is deleted. The nature of the AssumptionCache is that it is not invalidated by any changes to the function body and so this is sufficient to be conservatively correct.

Definition at line 211 of file AssumptionCache.h.

AssumptionCacheTracker::AssumptionCacheTracker ( )

~AssumptionCacheTracker()

AssumptionCacheTracker::~AssumptionCacheTracker ( ) overridedefault

doFinalization()

bool llvm::AssumptionCacheTracker::doFinalization ( Module & ) inlineoverridevirtual

getAssumptionCache()

lookupAssumptionCache()

Return the cached assumptions for a function if it has already been scanned.

Otherwise return nullptr.

Definition at line 274 of file AssumptionCache.cpp.

References F, and I.

releaseMemory()

void llvm::AssumptionCacheTracker::releaseMemory ( ) inlineoverridevirtual

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.

Definition at line 248 of file AssumptionCache.h.

References verifyAnalysis().

verifyAnalysis()

void AssumptionCacheTracker::verifyAnalysis ( ) const overridevirtual

verifyAnalysis() - This member can be implemented by a analysis pass to check state of analysis information.

Reimplemented from llvm::Pass.

Definition at line 281 of file AssumptionCache.cpp.

References B(), llvm::cast(), llvm::SmallPtrSetImpl< PtrType >::count(), I, II, llvm::SmallPtrSetImpl< PtrType >::insert(), llvm::PatternMatch::m_Intrinsic(), llvm::PatternMatch::match(), llvm::report_fatal_error(), and VerifyAssumptionCache.

Referenced by doFinalization(), and releaseMemory().

ID

char AssumptionCacheTracker::ID = 0 static

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