LLVM 19.0.0git
Public Types | Public Member Functions | Protected Attributes | Friends | List of all members
llvm::SCEV Class Reference

This class represents an analyzed expression in the program. More...

#include "llvm/Analysis/ScalarEvolution.h"

Inheritance diagram for llvm::SCEV:
Inheritance graph

Public Types

enum  NoWrapFlags {
  FlagAnyWrap = 0 , FlagNW = (1 << 0) , FlagNUW = (1 << 1) , FlagNSW = (1 << 2) ,
  NoWrapMask = (1 << 3) - 1
 NoWrapFlags are bitfield indices into SubclassData. More...

Public Member Functions

 SCEV (const FoldingSetNodeIDRef ID, SCEVTypes SCEVTy, unsigned short ExpressionSize)
 SCEV (const SCEV &)=delete
SCEVoperator= (const SCEV &)=delete
SCEVTypes getSCEVType () const
TypegetType () const
 Return the LLVM type of this SCEV expression.
ArrayRef< const SCEV * > operands () const
 Return operands of this SCEV expression.
bool isZero () const
 Return true if the expression is a constant zero.
bool isOne () const
 Return true if the expression is a constant one.
bool isAllOnesValue () const
 Return true if the expression is a constant all-ones value.
bool isNonConstantNegative () const
 Return true if the specified scev is negated, but not a constant.
unsigned short getExpressionSize () const
void print (raw_ostream &OS) const
 Print out the internal representation of this scalar to the specified stream.
void dump () const
 This method is used for debugging.
- Public Member Functions inherited from llvm::FoldingSetBase::Node
 Node ()=default
void * getNextInBucket () const
void SetNextInBucket (void *N)

Protected Attributes

const unsigned short ExpressionSize
unsigned short SubclassData = 0
 This field is initialized to zero and may be used in subclasses to store miscellaneous information.


struct FoldingSetTrait< SCEV >

Detailed Description

This class represents an analyzed expression in the program.

These are opaque objects that the client is not allowed to do much with directly.

Definition at line 75 of file ScalarEvolution.h.

Member Enumeration Documentation

◆ NoWrapFlags

NoWrapFlags are bitfield indices into SubclassData.

Add and Mul expressions may have no-unsigned-wrap <NUW> or no-signed-wrap <NSW> properties, which are derived from the IR operator. NSW is a misnomer that we use to mean no signed overflow or underflow.

AddRec expressions may have a no-self-wraparound <NW> property if, in the integer domain, abs(step) * max-iteration(loop) <= unsigned-max(bitwidth). This means that the recurrence will never reach its start value if the step is non-zero. Computing the same value on each iteration is not considered wrapping, and recurrences with step = 0 are trivially <NW>. <NW> is independent of the sign of step and the value the add recurrence starts with.

Note that NUW and NSW are also valid properties of a recurrence, and either implies NW. For convenience, NW will be set for a recurrence whenever either NUW or NSW are set.

We require that the flag on a SCEV apply to the entire scope in which that SCEV is defined. A SCEV's scope is set of locations dominated by a defining location, which is in turn described by the following rules:

  • A SCEVUnknown is at the point of definition of the Value.
  • A SCEVConstant is defined at all points.
  • A SCEVAddRec is defined starting with the header of the associated loop.
  • All other SCEVs are defined at the earlest point all operands are defined.

The above rules describe a maximally hoisted form (without regards to potential control dependence). A SCEV is defined anywhere a corresponding instruction could be defined in said maximally hoisted form. Note that SCEVUDivExpr (currently the only expression type which can trap) can be defined per these rules in regions where it would trap at runtime. A SCEV being defined does not require the existence of any instruction within the defined scope.


Definition at line 130 of file ScalarEvolution.h.

Constructor & Destructor Documentation

◆ SCEV() [1/2]

llvm::SCEV::SCEV ( const FoldingSetNodeIDRef  ID,
unsigned short  ExpressionSize 

Definition at line 138 of file ScalarEvolution.h.

◆ SCEV() [2/2]

llvm::SCEV::SCEV ( const SCEV )

Member Function Documentation

◆ dump()

LLVM_DUMP_METHOD void SCEV::dump ( ) const

This method is used for debugging.

Definition at line 261 of file ScalarEvolution.cpp.

References llvm::dbgs(), and print().

◆ getExpressionSize()

unsigned short llvm::SCEV::getExpressionSize ( ) const

Definition at line 173 of file ScalarEvolution.h.

References ExpressionSize.

Referenced by hasHugeExpression().

◆ getSCEVType()

SCEVTypes llvm::SCEV::getSCEVType ( ) const

◆ getType()

Type * SCEV::getType ( ) const

Return the LLVM type of this SCEV expression.

Definition at line 380 of file ScalarEvolution.cpp.

References getSCEVType(), llvm_unreachable, llvm::scAddExpr, llvm::scAddRecExpr, llvm::scConstant, llvm::scCouldNotCompute, llvm::scMulExpr, llvm::scPtrToInt, llvm::scSequentialUMinExpr, llvm::scSignExtend, llvm::scSMaxExpr, llvm::scSMinExpr, llvm::scTruncate, llvm::scUDivExpr, llvm::scUMaxExpr, llvm::scUMinExpr, llvm::scUnknown, llvm::scVScale, and llvm::scZeroExtend.

Referenced by llvm::SCEVAAResult::alias(), BinomialCoefficient(), calculateRtStride(), llvm::cannotBeMaxInLoop(), llvm::cannotBeMinInLoop(), llvm::ScalarEvolution::computeConstantDifference(), llvm::LoopVectorizationCostModel::computeMaxVF(), llvm::IndexedReference::computeRefCost(), computeTripCount(), countToEliminateCompares(), createNodeForSelectViaUMinSeq(), createReplacement(), DoInitialMatch(), llvm::VPWidenPointerInductionRecipe::execute(), llvm::VPExpandSCEVRecipe::execute(), llvm::ScalarEvolution::ExitLimit::ExitLimit(), expandBounds(), llvm::SCEVExpander::expandCodeFor(), findForkedSCEVs(), FindLoopCounter(), llvm::SCEVExpander::generateOverflowCheck(), genLoopLimit(), llvm::ScalarEvolution::getAnyExtendExpr(), llvm::ScalarEvolution::getGEPExpr(), llvm::ScalarEvolution::getLoopInvariantExitCondDuringFirstIterationsImpl(), llvm::ScalarEvolution::getLosslessPtrToIntExpr(), llvm::ScalarEvolution::getMinTrailingZeros(), getNewAlignment(), getSignedOverflowLimitForStep(), llvm::ScalarEvolution::getSignExtendExprImpl(), getStartAndEndForAccess(), llvm::ScalarEvolution::getTripCountFromExitCount(), llvm::SCEVMulExpr::getType(), llvm::SCEVUDivExpr::getType(), llvm::SCEVAddRecExpr::getType(), llvm::SCEVMinMaxExpr::getType(), llvm::SCEVSequentialMinMaxExpr::getType(), llvm::ScalarEvolution::getUMinFromMismatchedTypes(), getUnsignedOverflowLimitForStep(), llvm::ScalarEvolution::getZeroExtendExprImpl(), llvm::hasIterationCountInvariantInParent(), llvm::ARMTTIImpl::isHardwareLoopProfitable(), llvm::isKnownNegativeInLoop(), llvm::isKnownNonNegativeInLoop(), llvm::isKnownNonPositiveInLoop(), llvm::isKnownPositiveInLoop(), llvm::ScalarEvolution::isLoopBackedgeGuardedByCond(), isSafeDecreasingBound(), isSafeDependenceDistance(), isSafeIncreasingBound(), IsSimplerBaseSCEVForTarget(), llvm::VPlanTransforms::optimizeForVFAndUF(), optimizeLoopExitWithUnknownExitCount(), llvm::LoopStructure::parseLoopStructure(), PrintSCEVWithTypeHint(), llvm::replaceSymbolicStrideSCEV(), llvm::splitLoopBound(), llvm::UnrollRuntimeLoopRemainder(), verifyTripCount(), llvm::SCEVDivision::visitAddExpr(), llvm::SCEVDivision::visitAddRecExpr(), and llvm::SCEVDivision::visitMulExpr().

◆ isAllOnesValue()

bool SCEV::isAllOnesValue ( ) const

Return true if the expression is a constant all-ones value.

Definition at line 454 of file ScalarEvolution.cpp.

Referenced by MatchNotExpr().

◆ isNonConstantNegative()

bool SCEV::isNonConstantNegative ( ) const

Return true if the specified scev is negated, but not a constant.

Definition at line 460 of file ScalarEvolution.cpp.

References llvm::Mul.

Referenced by calculateRtStride().

◆ isOne()

bool SCEV::isOne ( ) const

Return true if the expression is a constant one.

Definition at line 448 of file ScalarEvolution.cpp.

Referenced by llvm::SCEVDivision::divide(), llvm::SCEVExpander::generateOverflowCheck(), genLoopLimit(), getStartForNegStride(), and isLoopCounter().

◆ isZero()

bool SCEV::isZero ( ) const

◆ operands()

ArrayRef< const SCEV * > SCEV::operands ( ) const

◆ operator=()

SCEV & llvm::SCEV::operator= ( const SCEV )

◆ print()

void SCEV::print ( raw_ostream OS) const

Friends And Related Function Documentation

◆ FoldingSetTrait< SCEV >

friend struct FoldingSetTrait< SCEV >

Definition at line 416 of file ScalarEvolution.h.

Member Data Documentation

◆ ExpressionSize

const unsigned short llvm::SCEV::ExpressionSize

Definition at line 87 of file ScalarEvolution.h.

Referenced by getExpressionSize().

◆ SubclassData

unsigned short llvm::SCEV::SubclassData = 0

This field is initialized to zero and may be used in subclasses to store miscellaneous information.

Definition at line 91 of file ScalarEvolution.h.

Referenced by llvm::SCEVNAryExpr::getNoWrapFlags(), llvm::SCEVCommutativeExpr::setNoWrapFlags(), and llvm::SCEVAddRecExpr::setNoWrapFlags().

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