This class represents an analyzed expression in the program. More...
#include "llvm/Analysis/ScalarEvolution.h"
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, unsigned SCEVTy) | |
| SCEV (const SCEV &)=delete | |
| SCEV & | operator= (const SCEV &)=delete |
| unsigned | getSCEVType () const |
| Type * | getType () const |
| Return the LLVM type of this SCEV expression. More... | |
| bool | isZero () const |
| Return true if the expression is a constant zero. More... | |
| bool | isOne () const |
| Return true if the expression is a constant one. More... | |
| bool | isAllOnesValue () const |
| Return true if the expression is a constant all-ones value. More... | |
| bool | isNonConstantNegative () const |
| Return true if the specified scev is negated, but not a constant. More... | |
| void | print (raw_ostream &OS) const |
| Print out the internal representation of this scalar to the specified stream. More... | |
| void | dump () const |
| This method is used for debugging. More... | |
 Public Member Functions inherited from llvm::FoldingSetBase::Node | |
| Node ()=default | |
| void * | getNextInBucket () const |
| void | SetNextInBucket (void *N) |
Protected Attributes | |
| unsigned short | SubclassData = 0 |
| This field is initialized to zero and may be used in subclasses to store miscellaneous information. More... | |
Friends | |
| 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 77 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.
| Enumerator | |
|---|---|
| FlagAnyWrap | |
| FlagNW | |
| FlagNUW | |
| FlagNSW | |
| NoWrapMask | |
Definition at line 111 of file ScalarEvolution.h.
Constructor & Destructor Documentation
◆ SCEV() [1/2]
|
inlineexplicit |
Definition at line 119 of file ScalarEvolution.h.
References operator=().
◆ SCEV() [2/2]
Member Function Documentation
◆ dump()
| LLVM_DUMP_METHOD void SCEV::dump | ( | ) | const |
This method is used for debugging.
Definition at line 224 of file ScalarEvolution.cpp.
References llvm::dbgs(), and print().
Referenced by getSCEVType().
◆ getSCEVType()
|
inline |
Definition at line 124 of file ScalarEvolution.h.
References dump(), getType(), isAllOnesValue(), isNonConstantNegative(), isOne(), isZero(), and print().
Referenced by BuildConstantFromSCEV(), llvm::SCEVConstant::classof(), llvm::SCEVCastExpr::classof(), llvm::SCEVTruncateExpr::classof(), llvm::SCEVZeroExtendExpr::classof(), llvm::SCEVSignExtendExpr::classof(), llvm::SCEVCouldNotCompute::classof(), llvm::SCEVNAryExpr::classof(), llvm::SCEVCommutativeExpr::classof(), llvm::SCEVAddExpr::classof(), llvm::SCEVMulExpr::classof(), llvm::SCEVUDivExpr::classof(), llvm::SCEVAddRecExpr::classof(), llvm::SCEVSMaxExpr::classof(), llvm::SCEVUMaxExpr::classof(), llvm::SCEVUnknown::classof(), CompareSCEVComplexity(), llvm::SCEVExpander::expandCodeFor(), llvm::ScalarEvolution::getBlockDisposition(), getExprBase(), llvm::ScalarEvolution::getLoopDisposition(), llvm::SCEVExpander::getRelatedExistingExpansion(), getType(), GroupByComplexity(), IsAvailableOnEntry(), isHighCostExpansion(), print(), llvm::SCEVVisitor< SCEVLoopAddRecRewriter, const SCEV *>::visit(), and llvm::SCEVTraversal< SV >::visitAll().
◆ getType()
| Type * SCEV::getType | ( | ) | const |
Return the LLVM type of this SCEV expression.
Definition at line 340 of file ScalarEvolution.cpp.
References getSCEVType(), llvm_unreachable, llvm::scAddExpr, llvm::scAddRecExpr, llvm::scConstant, llvm::scCouldNotCompute, llvm::scMulExpr, llvm::scSignExtend, llvm::scSMaxExpr, llvm::scTruncate, llvm::scUDivExpr, llvm::scUMaxExpr, llvm::scUnknown, and llvm::scZeroExtend.
Referenced by llvm::LoopAccessInfo::addRuntimeChecks(), llvm::SCEVAAResult::alias(), asmClobbersCTR(), BinomialCoefficient(), BuildConstantFromSCEV(), llvm::cannotBeMaxInLoop(), llvm::cannotBeMinInLoop(), countToEliminateCompares(), llvm::InnerLoopVectorizer::createVectorizedLoopSkeleton(), llvm::SCEVExpander::expandCodeFor(), llvm::SCEVExpander::expandEqualPredicate(), llvm::AlignmentFromAssumptionsPass::extractAlignmentInfo(), FactorOutConstant(), FindLoopCounter(), llvm::InnerLoopVectorizer::fixupIVUsers(), genLoopLimit(), llvm::ScalarEvolution::getAnyExtendExpr(), getConstantPart(), llvm::ScalarEvolution::getEqualPredicate(), getExactSDiv(), llvm::ScalarEvolution::getGEPExpr(), llvm::ScalarEvolution::getMinusSCEV(), llvm::ScalarEvolution::getNegativeSCEV(), getNewAlignment(), llvm::ScalarEvolution::getNoopOrAnyExtend(), llvm::ScalarEvolution::getNoopOrSignExtend(), llvm::ScalarEvolution::getNoopOrZeroExtend(), llvm::ScalarEvolution::getNotSCEV(), getNumBytes(), llvm::InnerLoopVectorizer::getOrCreateTripCount(), llvm::ScalarEvolution::getPointerBase(), getRangeForAffineARHelper(), GetRangeFromMetadata(), llvm::SCEVExpander::getRelatedExistingExpansion(), getSCEVType(), getSignedOverflowLimitForStep(), llvm::ScalarEvolution::getSignExtendExpr(), llvm::ScalarEvolution::getTruncateExpr(), llvm::ScalarEvolution::getTruncateOrNoop(), llvm::ScalarEvolution::getTruncateOrSignExtend(), llvm::ScalarEvolution::getTruncateOrZeroExtend(), llvm::ScalarEvolution::getUDivExpr(), llvm::ScalarEvolution::getUMaxFromMismatchedTypes(), llvm::ScalarEvolution::getUMinFromMismatchedTypes(), getUnsignedOverflowLimitForStep(), llvm::ScalarEvolution::getURemExpr(), llvm::ScalarEvolution::getZeroExtendExpr(), llvm::hasIterationCountInvariantInParent(), llvm::RuntimePointerChecking::insert(), isAddFoldable(), isAlwaysFoldable(), isIgnorableInst(), isIntegerLoopHeaderPHI(), llvm::isKnownNegativeInLoop(), llvm::isKnownNonNegativeInLoop(), IsKnownPredicateViaMinOrMax(), isLoadOrStore(), llvm::ScalarEvolution::isLoopBackedgeGuardedByCond(), llvm::ScalarEvolution::isLoopEntryGuardedByCond(), isLoopIncrement(), isLoopInvariant(), llvm::ScalarEvolution::isLoopInvariantPredicate(), isRemainderZero(), isSafeDependenceDistance(), isSimpleCastedPHI(), llvm::FullDependence::isSplitable(), MatchBinaryOp(), matchesOr(), mayLoopAccessLocation(), mayUsePostIncMode(), minAPInt(), PickMostRelevantLoop(), llvm::LoopPredicationPass::run(), llvm::SCEVCastExpr::SCEVCastExpr(), llvm::SCEVEqualPredicate::SCEVEqualPredicate(), llvm::ScalarEvolution::SimplifyICmpOperands(), sizeOfSCEV(), SolveLinEquationWithOverflow(), truncateIVUse(), and llvm::UnrollRuntimeLoopRemainder().
◆ isAllOnesValue()
| bool SCEV::isAllOnesValue | ( | ) | const |
Return true if the expression is a constant all-ones value.
Definition at line 377 of file ScalarEvolution.cpp.
References llvm::PPCISD::SC.
Referenced by llvm::ScalarEvolution::getMulExpr(), getSCEVType(), MatchNotExpr(), and llvm::LoopPredicationPass::run().
◆ isNonConstantNegative()
| bool SCEV::isNonConstantNegative | ( | ) | const |
Return true if the specified scev is negated, but not a constant.
Definition at line 383 of file ScalarEvolution.cpp.
References llvm::dyn_cast(), llvm::SCEVConstant::getAPInt(), llvm::SCEVNAryExpr::getOperand(), llvm::APInt::isNegative(), and llvm::PPCISD::SC.
Referenced by getSCEVType(), IsIncrementNUW(), and PickMostRelevantLoop().
◆ isOne()
| bool SCEV::isOne | ( | ) | const |
Return true if the expression is a constant one.
Definition at line 371 of file ScalarEvolution.cpp.
References llvm::PPCISD::SC.
Referenced by FactorOutConstant(), FindLoopCounter(), genLoopLimit(), getSCEVType(), llvm::LoopPredicationPass::run(), and sizeOfSCEV().
◆ isZero()
| bool SCEV::isZero | ( | ) | const |
Return true if the expression is a constant zero.
Definition at line 365 of file ScalarEvolution.cpp.
References llvm::PPCISD::SC.
Referenced by BrPHIToSelect(), canExpandBackedgeTakenCount(), canFoldIVIncExpr(), DeleteTriviallyDeadInstructions(), DoInitialMatch(), llvm::AlignmentFromAssumptionsPass::extractAlignmentInfo(), FactorOutConstant(), llvm::ScalarEvolution::findArrayDimensions(), findArrayDimensionsRec(), FindLoopCounter(), genLoopLimit(), llvm::ScalarEvolution::getAddRecExpr(), getConstantPart(), llvm::SCEVAddRecExpr::getPostIncExpr(), getSCEVType(), isAlwaysFoldable(), isProfitableChain(), mayUsePostIncMode(), sizeOfSCEV(), and SolveQuadraticAddRecRange().
◆ operator=()
◆ print()
| void SCEV::print | ( | raw_ostream & | OS | ) | const |
Print out the internal representation of this scalar to the specified stream.
This should really only be used for debugging purposes.
Definition at line 230 of file ScalarEvolution.cpp.
References E, FlagNSW, FlagNUW, llvm::LoopBase< BlockT, LoopT >::getHeader(), llvm::SCEVUDivExpr::getLHS(), llvm::SCEVAddRecExpr::getLoop(), llvm::SCEVNAryExpr::getNoWrapFlags(), llvm::SCEVNAryExpr::getNumOperands(), llvm::SCEVCastExpr::getOperand(), llvm::SCEVNAryExpr::getOperand(), llvm::SCEVUDivExpr::getRHS(), getSCEVType(), llvm::SCEVCastExpr::getType(), llvm::SCEVUnknown::getValue(), llvm::SCEVNAryExpr::hasNoSelfWrap(), llvm::SCEVNAryExpr::hasNoSignedWrap(), llvm::SCEVNAryExpr::hasNoUnsignedWrap(), I, llvm::SCEVUnknown::isAlignOf(), llvm::SCEVUnknown::isOffsetOf(), llvm::SCEVUnknown::isSizeOf(), llvm_unreachable, llvm::SCEVNAryExpr::op_begin(), llvm::SCEVNAryExpr::op_end(), llvm::Value::printAsOperand(), llvm::scAddExpr, llvm::scAddRecExpr, llvm::scConstant, llvm::scCouldNotCompute, llvm::scMulExpr, llvm::scSignExtend, llvm::scSMaxExpr, llvm::scTruncate, llvm::scUDivExpr, llvm::scUMaxExpr, llvm::scUnknown, and llvm::scZeroExtend.
Referenced by dump(), llvm::SCEVPredicate::getComplexity(), llvm::SCEVWrapPredicate::getFlags(), llvm::SCEVUnionPredicate::getPredicates(), getSCEVType(), llvm::ScalarEvolutionWrapperPass::getSE(), llvm::PredicatedScalarEvolution::getSE(), llvm::ScalarEvolution::getSignedRangeMax(), llvm::operator<<(), and llvm::ScalarEvolution::print().
Friends And Related Function Documentation
◆ FoldingSetTrait< SCEV >
|
friend |
Definition at line 78 of file ScalarEvolution.h.
Member Data Documentation
◆ SubclassData
|
protected |
This field is initialized to zero and may be used in subclasses to store miscellaneous information.
Definition at line 90 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:
- include/llvm/Analysis/ScalarEvolution.h
- lib/Analysis/ScalarEvolution.cpp
