A cache of @llvm.assume calls within a function. More...

#include "llvm/Analysis/AssumptionCache.h"

Classes
struct	ResultElem

Public Types
enum	: unsigned { ExprResultIdx = std::numeric_limits<unsigned>::max() }
	Value of ResultElem::Index indicating that the argument to the call of the llvm.assume. More...

Public Member Functions
	AssumptionCache (Function &F, TargetTransformInfo *TTI=nullptr)
	Construct an AssumptionCache from a function by scanning all of its instructions.
bool	invalidate (Function &, const PreservedAnalyses &, FunctionAnalysisManager::Invalidator &)
	This cache is designed to be self-updating and so it should never be invalidated.
LLVM_ABI void	registerAssumption (AssumeInst *CI)
	Add an @llvm.assume intrinsic to this function's cache.
LLVM_ABI void	unregisterAssumption (AssumeInst *CI)
	Remove an @llvm.assume intrinsic from this function's cache if it has been added to the cache earlier.
LLVM_ABI void	replaceAssumption (WeakVH &Handle, AssumeInst *New)
	Replace the assumption referenced by `Handle` (must be a valid handle for a registered assumption) with `New`.
LLVM_ABI void	updateAffectedValues (AssumeInst *CI)
	Update the cache of values being affected by this assumption (i.e.
void	clear ()
	Clear the cache of @llvm.assume intrinsics for a function.
MutableArrayRef< WeakVH >	assumptions ()
	Access the list of assumption handles currently tracked for this function.
MutableArrayRef< ResultElem >	assumptionsFor (const Value *V)
	Access the list of assumptions which affect this value.
MutableArrayRef< ResultElem >	allAssumptionsFor (const Value *V)
	Access the list of assumptions which affect this value, ignoring the -max-assumes-per-value limit.

Static Public Member Functions
static LLVM_ABI void	findValuesAffectedByOperandBundle (OperandBundleUse Bundle, function_ref< void(Value *)> InsertAffected)
	Determine which values are affected by this assume operand bundle.

Detailed Description

A cache of @llvm.assume calls within a function.

This cache provides fast lookup of assumptions within a function by caching them and amortizing the cost of scanning for them across all queries. Passes that create new assumptions are required to call registerAssumption() to register any new @llvm.assume calls that they create. Deletions of @llvm.assume calls do not require special handling.

Definition at line 47 of file AssumptionCache.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum : unsigned

Value of ResultElem::Index indicating that the argument to the call of the llvm.assume.

Enumerator
ExprResultIdx

Definition at line 51 of file AssumptionCache.h.

Constructor & Destructor Documentation

◆ AssumptionCache()

llvm::AssumptionCache::AssumptionCache	(	Function &	F,
		TargetTransformInfo *	TTI = nullptr )

inline

Construct an AssumptionCache from a function by scanning all of its instructions.

Definition at line 117 of file AssumptionCache.h.

Referenced by llvm::AssumptionAnalysis::run().

Member Function Documentation

◆ allAssumptionsFor()

MutableArrayRef< ResultElem > llvm::AssumptionCache::allAssumptionsFor ( const Value * V )

inline

Access the list of assumptions which affect this value, ignoring the -max-assumes-per-value limit.

Only for callers which must observe every assumption, such as cache verification. Analyses should use assumptionsFor().

Definition at line 181 of file AssumptionCache.h.

References llvm::MutableArrayRef().

Referenced by assumptionsFor().

◆ assumptions()

MutableArrayRef< WeakVH > llvm::AssumptionCache::assumptions ( )

inline

Access the list of assumption handles currently tracked for this function.

Note that these produce weak handles that may be null. The caller must handle that case. FIXME: We should replace this with pointee_iterator<filter_iterator<...>> when we can write that to filter out the null values. Then caller code will become simpler.

Definition at line 162 of file AssumptionCache.h.

Referenced by llvm::CodeMetrics::collectEphemeralValues(), llvm::CodeMetrics::collectEphemeralValues(), llvm::AssumptionPrinterPass::run(), llvm::DropUnnecessaryAssumesPass::run(), and llvm::AlignmentFromAssumptionsPass::runImpl().