An interface layer with SCEV used to manage how we see SCEV expressions for values in the context of existing predicates. More...

#include "llvm/Analysis/ScalarEvolution.h"

Public Member Functions
	PredicatedScalarEvolution (ScalarEvolution &SE, Loop &L)

const SCEVPredicate &	getPredicate () const

const SCEV *	getSCEV (Value *V)
	Returns the SCEV expression of V, in the context of the current SCEV predicate.

const SCEV *	getBackedgeTakenCount ()
	Get the (predicated) backedge count for the analyzed loop.

const SCEV *	getSymbolicMaxBackedgeTakenCount ()
	Get the (predicated) symbolic max backedge count for the analyzed loop.

unsigned	getSmallConstantMaxTripCount ()
	Returns the upper bound of the loop trip count as a normal unsigned value, or 0 if the trip count is unknown.

void	addPredicate (const SCEVPredicate &Pred)
	Adds a new predicate.

const SCEVAddRecExpr *	getAsAddRec (Value *V)
	Attempts to produce an AddRecExpr for V by adding additional SCEV predicates.

void	setNoOverflow (Value *V, SCEVWrapPredicate::IncrementWrapFlags Flags)
	Proves that V doesn't overflow by adding SCEV predicate.

bool	hasNoOverflow (Value *V, SCEVWrapPredicate::IncrementWrapFlags Flags)
	Returns true if we've proved that V doesn't wrap by means of a SCEV predicate.

ScalarEvolution *	getSE () const
	Returns the ScalarEvolution analysis used.

	PredicatedScalarEvolution (const PredicatedScalarEvolution &)
	We need to explicitly define the copy constructor because of FlagsMap.

void	print (raw_ostream &OS, unsigned Depth) const
	Print the SCEV mappings done by the Predicated Scalar Evolution.

bool	areAddRecsEqualWithPreds (const SCEVAddRecExpr AR1, const SCEVAddRecExpr AR2) const
	Check if `AR1` and `AR2` are equal, while taking into account Equal predicates in Preds.

Detailed Description

An interface layer with SCEV used to manage how we see SCEV expressions for values in the context of existing predicates.

We can add new predicates, but we cannot remove them.

This layer has multiple purposes:

provides a simple interface for SCEV versioning.
guarantees that the order of transformations applied on a SCEV expression for a single Value is consistent across two different getSCEV calls. This means that, for example, once we've obtained an AddRec expression for a certain value through expression rewriting, we will continue to get an AddRec expression for that Value.
lowers the number of expression rewrites.

Definition at line 2391 of file ScalarEvolution.h.

Constructor & Destructor Documentation

◆ PredicatedScalarEvolution() [1/2]

PredicatedScalarEvolution::PredicatedScalarEvolution	(	ScalarEvolution &	SE,
		Loop &	L
	)

Definition at line 15088 of file ScalarEvolution.cpp.

◆ PredicatedScalarEvolution() [2/2]

PredicatedScalarEvolution::PredicatedScalarEvolution ( const PredicatedScalarEvolution & Init )

We need to explicitly define the copy constructor because of FlagsMap.

Definition at line 15226 of file ScalarEvolution.cpp.

References I.

Member Function Documentation

◆ addPredicate()

void PredicatedScalarEvolution::addPredicate ( const SCEVPredicate & Pred )

Adds a new predicate.

Definition at line 15155 of file ScalarEvolution.cpp.

References llvm::SmallVectorTemplateBase< T, bool >::push_back().

Referenced by getAsAddRec(), getBackedgeTakenCount(), getSmallConstantMaxTripCount(), getSymbolicMaxBackedgeTakenCount(), llvm::replaceSymbolicStrideSCEV(), and setNoOverflow().

◆ areAddRecsEqualWithPreds()

bool PredicatedScalarEvolution::areAddRecsEqualWithPreds	(	const SCEVAddRecExpr *	AR1,
		const SCEVAddRecExpr *	AR2
	)		const

Check if AR1 and AR2 are equal, while taking into account Equal predicates in Preds.

Definition at line 5703 of file ScalarEvolution.cpp.

References llvm::ScalarEvolution::getEqualPredicate(), llvm::SCEVAddRecExpr::getStart(), and llvm::SCEVAddRecExpr::getStepRecurrence().

Referenced by getCastsForInductionPHI().

◆ getAsAddRec()

const SCEVAddRecExpr * PredicatedScalarEvolution::getAsAddRec ( Value * V )

Attempts to produce an AddRecExpr for V by adding additional SCEV predicates.

If we can't transform the expression into an AddRecExpr we return nullptr and not add additional SCEV predicates to the current context.

Definition at line 15211 of file ScalarEvolution.cpp.

References addPredicate(), llvm::ScalarEvolution::convertSCEVToAddRecWithPredicates(), llvm::ScalarEvolution::getSCEV(), getSCEV(), and P.

Referenced by llvm::getPtrStride(), hasComputableBounds(), and llvm::InductionDescriptor::isInductionPHI().

◆ getBackedgeTakenCount()

const SCEV * PredicatedScalarEvolution::getBackedgeTakenCount ( )

Get the (predicated) backedge count for the analyzed loop.

Definition at line 15124 of file ScalarEvolution.cpp.

References addPredicate(), llvm::ScalarEvolution::getPredicatedBackedgeTakenCount(), and P.

Referenced by llvm::LoopVectorizationLegality::canVectorize(), llvm::LoopVectorizationCostModel::computeMaxVF(), and processLoopInVPlanNativePath().

◆ getPredicate()

const SCEVPredicate & PredicatedScalarEvolution::getPredicate ( ) const

Definition at line 15165 of file ScalarEvolution.cpp.

Referenced by llvm::LoopVectorizationLegality::canVectorize(), llvm::LoopAccessInfo::print(), llvm::LoopVectorizePass::processLoop(), and llvm::LoopVectorizationCostModel::runtimeChecksRequired().

◆ getSCEV()

const SCEV * PredicatedScalarEvolution::getSCEV ( Value * V )

Returns the SCEV expression of V, in the context of the current SCEV predicate.

The order of transformations applied on the expression of V returned by ScalarEvolution is guaranteed to be preserved, even when adding new predicates.

Definition at line 15105 of file ScalarEvolution.cpp.

References llvm::ScalarEvolution::getSCEV(), and llvm::ScalarEvolution::rewriteUsingPredicate().

Referenced by getAddressAccessSCEV(), getAsAddRec(), getCastsForInductionPHI(), llvm::LoopVectorizationCostModel::getInstructionCost(), hasNoOverflow(), llvm::InductionDescriptor::isInductionPHI(), isNoWrap(), isNoWrapAddRec(), llvm::replaceSymbolicStrideSCEV(), setNoOverflow(), and llvm::LoopVectorizationCostModel::setVectorizedCallDecision().