LLVM  10.0.0svn
llvm::ConstantRange Class Reference

This class represents a range of values. More...

#include "llvm/IR/ConstantRange.h"

## Public Types

enum  PreferredRangeType { Smallest, Unsigned, Signed }
If represented precisely, the result of some range operations may consist of multiple disjoint ranges. More...

enum  OverflowResult { OverflowResult::AlwaysOverflowsLow, OverflowResult::AlwaysOverflowsHigh, OverflowResult::MayOverflow, OverflowResult::NeverOverflows }
Represents whether an operation on the given constant range is known to always or never overflow. More...

## Public Member Functions

ConstantRange (uint32_t BitWidth, bool isFullSet)
Initialize a full or empty set for the specified bit width. More...

ConstantRange (APInt Value)
Initialize a range to hold the single specified value. More...

ConstantRange (APInt Lower, APInt Upper)
Initialize a range of values explicitly. More...

bool getEquivalentICmp (CmpInst::Predicate &Pred, APInt &RHS) const
Set up Pred and RHS such that ConstantRange::makeExactICmpRegion(Pred, RHS) == *this. More...

const APIntgetLower () const
Return the lower value for this range. More...

const APIntgetUpper () const
Return the upper value for this range. More...

uint32_t getBitWidth () const
Get the bit width of this ConstantRange. More...

bool isFullSet () const
Return true if this set contains all of the elements possible for this data-type. More...

bool isEmptySet () const
Return true if this set contains no members. More...

bool isWrappedSet () const
Return true if this set wraps around the unsigned domain. More...

bool isUpperWrapped () const
Return true if the exclusive upper bound wraps around the unsigned domain. More...

bool isSignWrappedSet () const
Return true if this set wraps around the signed domain. More...

bool isUpperSignWrapped () const
Return true if the (exclusive) upper bound wraps around the signed domain. More...

bool contains (const APInt &Val) const
Return true if the specified value is in the set. More...

bool contains (const ConstantRange &CR) const
Return true if the other range is a subset of this one. More...

const APIntgetSingleElement () const
If this set contains a single element, return it, otherwise return null. More...

const APIntgetSingleMissingElement () const
If this set contains all but a single element, return it, otherwise return null. More...

bool isSingleElement () const
Return true if this set contains exactly one member. More...

bool isSizeStrictlySmallerThan (const ConstantRange &CR) const
Compare set size of this range with the range CR. More...

bool isSizeLargerThan (uint64_t MaxSize) const
Compare set size of this range with Value. More...

bool isAllNegative () const
Return true if all values in this range are negative. More...

bool isAllNonNegative () const
Return true if all values in this range are non-negative. More...

APInt getUnsignedMax () const
Return the largest unsigned value contained in the ConstantRange. More...

APInt getUnsignedMin () const
Return the smallest unsigned value contained in the ConstantRange. More...

APInt getSignedMax () const
Return the largest signed value contained in the ConstantRange. More...

APInt getSignedMin () const
Return the smallest signed value contained in the ConstantRange. More...

bool operator== (const ConstantRange &CR) const
Return true if this range is equal to another range. More...

bool operator!= (const ConstantRange &CR) const

ConstantRange subtract (const APInt &CI) const
Subtract the specified constant from the endpoints of this constant range. More...

ConstantRange difference (const ConstantRange &CR) const
Subtract the specified range from this range (aka relative complement of the sets). More...

ConstantRange intersectWith (const ConstantRange &CR, PreferredRangeType Type=Smallest) const
Return the range that results from the intersection of this range with another range. More...

ConstantRange unionWith (const ConstantRange &CR, PreferredRangeType Type=Smallest) const
Return the range that results from the union of this range with another range. More...

ConstantRange castOp (Instruction::CastOps CastOp, uint32_t BitWidth) const
Return a new range representing the possible values resulting from an application of the specified cast operator to this range. More...

ConstantRange zeroExtend (uint32_t BitWidth) const
Return a new range in the specified integer type, which must be strictly larger than the current type. More...

ConstantRange signExtend (uint32_t BitWidth) const
Return a new range in the specified integer type, which must be strictly larger than the current type. More...

ConstantRange truncate (uint32_t BitWidth) const
Return a new range in the specified integer type, which must be strictly smaller than the current type. More...

ConstantRange zextOrTrunc (uint32_t BitWidth) const
Make this range have the bit width given by BitWidth. More...

ConstantRange sextOrTrunc (uint32_t BitWidth) const
Make this range have the bit width given by BitWidth. More...

ConstantRange binaryOp (Instruction::BinaryOps BinOp, const ConstantRange &Other) const
Return a new range representing the possible values resulting from an application of the specified binary operator to an left hand side of this range and a right hand side of Other. More...

ConstantRange add (const ConstantRange &Other) const
Return a new range representing the possible values resulting from an addition of a value in this range and a value in Other. More...

ConstantRange addWithNoWrap (const ConstantRange &Other, unsigned NoWrapKind, PreferredRangeType RangeType=Smallest) const
Return a new range representing the possible values resulting from an addition with wrap type NoWrapKind of a value in this range and a value in Other. More...

ConstantRange sub (const ConstantRange &Other) const
Return a new range representing the possible values resulting from a subtraction of a value in this range and a value in Other. More...

ConstantRange multiply (const ConstantRange &Other) const
Return a new range representing the possible values resulting from a multiplication of a value in this range and a value in Other, treating both this and Other as unsigned ranges. More...

ConstantRange smax (const ConstantRange &Other) const
Return a new range representing the possible values resulting from a signed maximum of a value in this range and a value in Other. More...

ConstantRange umax (const ConstantRange &Other) const
Return a new range representing the possible values resulting from an unsigned maximum of a value in this range and a value in Other. More...

ConstantRange smin (const ConstantRange &Other) const
Return a new range representing the possible values resulting from a signed minimum of a value in this range and a value in Other. More...

ConstantRange umin (const ConstantRange &Other) const
Return a new range representing the possible values resulting from an unsigned minimum of a value in this range and a value in Other. More...

ConstantRange udiv (const ConstantRange &Other) const
Return a new range representing the possible values resulting from an unsigned division of a value in this range and a value in Other. More...

ConstantRange sdiv (const ConstantRange &Other) const
Return a new range representing the possible values resulting from a signed division of a value in this range and a value in Other. More...

ConstantRange urem (const ConstantRange &Other) const
Return a new range representing the possible values resulting from an unsigned remainder operation of a value in this range and a value in Other. More...

ConstantRange srem (const ConstantRange &Other) const
Return a new range representing the possible values resulting from a signed remainder operation of a value in this range and a value in Other. More...

ConstantRange binaryAnd (const ConstantRange &Other) const
Return a new range representing the possible values resulting from a binary-and of a value in this range by a value in Other. More...

ConstantRange binaryOr (const ConstantRange &Other) const
Return a new range representing the possible values resulting from a binary-or of a value in this range by a value in Other. More...

ConstantRange shl (const ConstantRange &Other) const
Return a new range representing the possible values resulting from a left shift of a value in this range by a value in Other. More...

ConstantRange lshr (const ConstantRange &Other) const
Return a new range representing the possible values resulting from a logical right shift of a value in this range and a value in Other. More...

ConstantRange ashr (const ConstantRange &Other) const
Return a new range representing the possible values resulting from a arithmetic right shift of a value in this range and a value in Other. More...

ConstantRange uadd_sat (const ConstantRange &Other) const
Perform an unsigned saturating addition of two constant ranges. More...

ConstantRange sadd_sat (const ConstantRange &Other) const
Perform a signed saturating addition of two constant ranges. More...

ConstantRange usub_sat (const ConstantRange &Other) const
Perform an unsigned saturating subtraction of two constant ranges. More...

ConstantRange ssub_sat (const ConstantRange &Other) const
Perform a signed saturating subtraction of two constant ranges. More...

ConstantRange inverse () const
Return a new range that is the logical not of the current set. More...

ConstantRange abs () const
Calculate absolute value range. More...

OverflowResult unsignedAddMayOverflow (const ConstantRange &Other) const
Return whether unsigned add of the two ranges always/never overflows. More...

OverflowResult signedAddMayOverflow (const ConstantRange &Other) const
Return whether signed add of the two ranges always/never overflows. More...

OverflowResult unsignedSubMayOverflow (const ConstantRange &Other) const
Return whether unsigned sub of the two ranges always/never overflows. More...

OverflowResult signedSubMayOverflow (const ConstantRange &Other) const
Return whether signed sub of the two ranges always/never overflows. More...

OverflowResult unsignedMulMayOverflow (const ConstantRange &Other) const
Return whether unsigned mul of the two ranges always/never overflows. More...

void print (raw_ostream &OS) const
Print out the bounds to a stream. More...

void dump () const
Allow printing from a debugger easily. More...

## Static Public Member Functions

static ConstantRange getEmpty (uint32_t BitWidth)
Create empty constant range with the given bit width. More...

static ConstantRange getFull (uint32_t BitWidth)
Create full constant range with the given bit width. More...

static ConstantRange getNonEmpty (APInt Lower, APInt Upper)
Create non-empty constant range with the given bounds. More...

static ConstantRange fromKnownBits (const KnownBits &Known, bool IsSigned)
Initialize a range based on a known bits constraint. More...

static ConstantRange makeAllowedICmpRegion (CmpInst::Predicate Pred, const ConstantRange &Other)
Produce the smallest range such that all values that may satisfy the given predicate with any value contained within Other is contained in the returned range. More...

static ConstantRange makeSatisfyingICmpRegion (CmpInst::Predicate Pred, const ConstantRange &Other)
Produce the largest range such that all values in the returned range satisfy the given predicate with all values contained within Other. More...

static ConstantRange makeExactICmpRegion (CmpInst::Predicate Pred, const APInt &Other)
Produce the exact range such that all values in the returned range satisfy the given predicate with any value contained within Other. More...

static ConstantRange makeGuaranteedNoWrapRegion (Instruction::BinaryOps BinOp, const ConstantRange &Other, unsigned NoWrapKind)
Produce the largest range containing all X such that "X BinOp Y" is guaranteed not to wrap (overflow) for all Y in Other. More...

static ConstantRange makeExactNoWrapRegion (Instruction::BinaryOps BinOp, const APInt &Other, unsigned NoWrapKind)
Produce the range that contains X if and only if "X BinOp Other" does not wrap. More...

## Detailed Description

This class represents a range of values.

Definition at line 47 of file ConstantRange.h.

## ◆ OverflowResult

 strong

Represents whether an operation on the given constant range is known to always or never overflow.

Enumerator
AlwaysOverflowsLow

Always overflows in the direction of signed/unsigned min value.

AlwaysOverflowsHigh

Always overflows in the direction of signed/unsigned max value.

MayOverflow

May or may not overflow.

NeverOverflows

Never overflows.

Definition at line 430 of file ConstantRange.h.

## ◆ PreferredRangeType

If represented precisely, the result of some range operations may consist of multiple disjoint ranges.

As only a single range may be returned, any range covering these disjoint ranges constitutes a valid result, but some may be more useful than others depending on context. The preferred range type specifies whether a range that is non-wrapping in the unsigned or signed domain, or has the smallest size, is preferred. If a signedness is preferred but all ranges are non-wrapping or all wrapping, then the smallest set size is preferred. If there are multiple smallest sets, any one of them may be returned.

Enumerator
Smallest
Unsigned
Signed

Definition at line 272 of file ConstantRange.h.

## ◆ ConstantRange() [1/3]

 ConstantRange::ConstantRange ( uint32_t BitWidth, bool isFullSet )
explicit

Initialize a full or empty set for the specified bit width.

Definition at line 42 of file ConstantRange.cpp.

References llvm::Upper.

## ◆ ConstantRange() [2/3]

 ConstantRange::ConstantRange ( APInt Value )

Initialize a range to hold the single specified value.

Definition at line 46 of file ConstantRange.cpp.

## ◆ ConstantRange() [3/3]

 ConstantRange::ConstantRange ( APInt Lower, APInt Upper )

Initialize a range of values explicitly.

This will assert out if Lower==Upper and Lower != Min or Max value for its type. It will also assert out if the two APInt's are not the same bit width.

Definition at line 49 of file ConstantRange.cpp.

References assert(), llvm::APInt::getBitWidth(), and llvm::LegalizeActions::Lower.

## ◆ abs()

 ConstantRange ConstantRange::abs ( ) const

Calculate absolute value range.

If the original range contains signed min, then the resulting range will also contain signed min.

Definition at line 1300 of file ConstantRange.cpp.

Referenced by srem().

 ConstantRange ConstantRange::add ( const ConstantRange & Other ) const

Return a new range representing the possible values resulting from an addition of a value in this range and a value in Other.

Definition at line 799 of file ConstantRange.cpp.

 ConstantRange ConstantRange::addWithNoWrap ( const ConstantRange & Other, unsigned NoWrapKind, PreferredRangeType RangeType = Smallest ) const

Return a new range representing the possible values resulting from an addition with wrap type NoWrapKind of a value in this range and a value in Other.

If the result range is disjoint, the preferred range is determined by the PreferredRangeType.

Definition at line 818 of file ConstantRange.cpp.

## ◆ ashr()

 ConstantRange ConstantRange::ashr ( const ConstantRange & Other ) const

Return a new range representing the possible values resulting from a arithmetic right shift of a value in this range and a value in Other.

Definition at line 1206 of file ConstantRange.cpp.

Referenced by binaryOp().

## ◆ binaryAnd()

 ConstantRange ConstantRange::binaryAnd ( const ConstantRange & Other ) const

Return a new range representing the possible values resulting from a binary-and of a value in this range by a value in Other.

Definition at line 1149 of file ConstantRange.cpp.

Referenced by binaryOp().

## ◆ binaryOp()

 ConstantRange ConstantRange::binaryOp ( Instruction::BinaryOps BinOp, const ConstantRange & Other ) const

Return a new range representing the possible values resulting from an application of the specified binary operator to an left hand side of this range and a right hand side of Other.

Definition at line 755 of file ConstantRange.cpp.

## ◆ binaryOr()

 ConstantRange ConstantRange::binaryOr ( const ConstantRange & Other ) const

Return a new range representing the possible values resulting from a binary-or of a value in this range by a value in Other.

Definition at line 1160 of file ConstantRange.cpp.

Referenced by binaryOp().

## ◆ castOp()

 ConstantRange ConstantRange::castOp ( Instruction::CastOps CastOp, uint32_t BitWidth ) const

Return a new range representing the possible values resulting from an application of the specified cast operator to this range.

BitWidth is the target bitwidth of the cast. For casts which don't change bitwidth, it must be the same as the source bitwidth. For casts which do change bitwidth, the bitwidth must be consistent with the requested cast and source bitwidth.

Definition at line 605 of file ConstantRange.cpp.

## ◆ contains() [1/2]

 bool ConstantRange::contains ( const APInt & Val ) const

Return true if the specified value is in the set.

Definition at line 367 of file ConstantRange.cpp.

## ◆ contains() [2/2]

 bool ConstantRange::contains ( const ConstantRange & CR ) const

Return true if the other range is a subset of this one.

Definition at line 376 of file ConstantRange.cpp.

## ◆ difference()

 ConstantRange ConstantRange::difference ( const ConstantRange & CR ) const

Subtract the specified range from this range (aka relative complement of the sets).

Definition at line 402 of file ConstantRange.cpp.

References intersectWith(), and inverse().

Referenced by foldSignBitTest(), getEdgeValueLocal(), and isImpliedCondMatchingImmOperands().

## ◆ dump()

 LLVM_DUMP_METHOD void ConstantRange::dump ( ) const

Allow printing from a debugger easily.

Definition at line 1453 of file ConstantRange.cpp.

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

## ◆ fromKnownBits()

 ConstantRange ConstantRange::fromKnownBits ( const KnownBits & Known, bool IsSigned )
static

Initialize a range based on a known bits constraint.

The IsSigned flag indicates whether the constant range should not wrap in the signed or unsigned domain.

Definition at line 57 of file ConstantRange.cpp.

## ◆ getBitWidth()

 uint32_t llvm::ConstantRange::getBitWidth ( ) const
inline

Get the bit width of this ConstantRange.

Definition at line 165 of file ConstantRange.h.

References contains(), and llvm::APInt::getBitWidth().

## ◆ getEmpty()

 static ConstantRange llvm::ConstantRange::getEmpty ( uint32_t BitWidth )
inlinestatic

Create empty constant range with the given bit width.

Definition at line 73 of file ConstantRange.h.

## ◆ getEquivalentICmp()

 bool ConstantRange::getEquivalentICmp ( CmpInst::Predicate & Pred, APInt & RHS ) const

Set up Pred and RHS such that ConstantRange::makeExactICmpRegion(Pred, RHS) == *this.

Return true if successful.

Definition at line 149 of file ConstantRange.cpp.

Referenced by llvm::ScalarEvolution::SimplifyICmpOperands().

## ◆ getFull()

 static ConstantRange llvm::ConstantRange::getFull ( uint32_t BitWidth )
inlinestatic

Create full constant range with the given bit width.

Definition at line 78 of file ConstantRange.h.

## ◆ getLower()

 const APInt& llvm::ConstantRange::getLower ( ) const
inline

Return the lower value for this range.

Definition at line 159 of file ConstantRange.h.

References llvm::Lower.

## ◆ getNonEmpty()

 static ConstantRange llvm::ConstantRange::getNonEmpty ( APInt Lower, APInt Upper )
inlinestatic

Create non-empty constant range with the given bounds.

If Lower and Upper are the same, a full range is returned.

Definition at line 84 of file ConstantRange.h.

References llvm::APInt::getBitWidth(), and Other.

## ◆ getSignedMax()

 APInt ConstantRange::getSignedMax ( ) const

Return the largest signed value contained in the ConstantRange.

Definition at line 355 of file ConstantRange.cpp.

## ◆ getSignedMin()

 APInt ConstantRange::getSignedMin ( ) const

Return the smallest signed value contained in the ConstantRange.

Definition at line 361 of file ConstantRange.cpp.

## ◆ getSingleElement()

 const APInt* llvm::ConstantRange::getSingleElement ( ) const
inline

If this set contains a single element, return it, otherwise return null.

Definition at line 207 of file ConstantRange.h.

References llvm::Lower.

## ◆ getSingleMissingElement()

 const APInt* llvm::ConstantRange::getSingleMissingElement ( ) const
inline

If this set contains all but a single element, return it, otherwise return null.

Definition at line 215 of file ConstantRange.h.

References llvm::Upper.

Referenced by getEquivalentICmp().

## ◆ getUnsignedMax()

 APInt ConstantRange::getUnsignedMax ( ) const

Return the largest unsigned value contained in the ConstantRange.

Definition at line 343 of file ConstantRange.cpp.

References getBitWidth(), llvm::APInt::getMaxValue(), getUpper(), isFullSet(), and isUpperWrapped().

## ◆ getUnsignedMin()

 APInt ConstantRange::getUnsignedMin ( ) const

Return the smallest unsigned value contained in the ConstantRange.

Definition at line 349 of file ConstantRange.cpp.

References getBitWidth(), getLower(), llvm::APInt::getMinValue(), isFullSet(), and isWrappedSet().

## ◆ getUpper()

 const APInt& llvm::ConstantRange::getUpper ( ) const
inline

Return the upper value for this range.

Definition at line 162 of file ConstantRange.h.

References llvm::Upper.

## ◆ intersectWith()

 ConstantRange ConstantRange::intersectWith ( const ConstantRange & CR, PreferredRangeType Type = Smallest ) const

Return the range that results from the intersection of this range with another range.

If the intersection is disjoint, such that two results are possible, the preferred range is determined by the PreferredRangeType.

Definition at line 426 of file ConstantRange.cpp.

## ◆ inverse()

 ConstantRange ConstantRange::inverse ( ) const

Return a new range that is the logical not of the current set.

Definition at line 1292 of file ConstantRange.cpp.

References ConstantRange(), isEmptySet(), isFullSet(), and llvm::LegalizeActions::Lower.

## ◆ isAllNegative()

 bool ConstantRange::isAllNegative ( ) const

Return true if all values in this range are negative.

Definition at line 328 of file ConstantRange.cpp.

## ◆ isAllNonNegative()

 bool ConstantRange::isAllNonNegative ( ) const

Return true if all values in this range are non-negative.

Definition at line 338 of file ConstantRange.cpp.

References isSignWrappedSet(), and llvm::LegalizeActions::Lower.

## ◆ isEmptySet()

 bool ConstantRange::isEmptySet ( ) const

Return true if this set contains no members.

Definition at line 287 of file ConstantRange.cpp.

References llvm::LegalizeActions::Lower.

## ◆ isFullSet()

 bool ConstantRange::isFullSet ( ) const

Return true if this set contains all of the elements possible for this data-type.

Definition at line 283 of file ConstantRange.cpp.

References llvm::LegalizeActions::Lower.

## ◆ isSignWrappedSet()

 bool ConstantRange::isSignWrappedSet ( ) const

Return true if this set wraps around the signed domain.

Special cases:

• Empty set: Not wrapped.
• Full set: Not wrapped.
• [X, SignedMin) == [X, SignedMax]: Not wrapped.

Definition at line 299 of file ConstantRange.cpp.

References llvm::APInt::isMinSignedValue(), and llvm::LegalizeActions::Lower.

Referenced by abs(), getPreferredRange(), getSignedMin(), isAllNonNegative(), mapBinOpcode(), and signExtend().

## ◆ isSingleElement()

 bool llvm::ConstantRange::isSingleElement ( ) const
inline

Return true if this set contains exactly one member.

Definition at line 222 of file ConstantRange.h.

Referenced by getPredicateResult(), hasSingleValue(), and makeAllowedICmpRegion().

## ◆ isSizeLargerThan()

 bool ConstantRange::isSizeLargerThan ( uint64_t MaxSize ) const

Compare set size of this range with Value.

Definition at line 318 of file ConstantRange.cpp.

## ◆ isSizeStrictlySmallerThan()

 bool ConstantRange::isSizeStrictlySmallerThan ( const ConstantRange & CR ) const

Compare set size of this range with the range CR.

Definition at line 308 of file ConstantRange.cpp.

References assert(), getBitWidth(), isFullSet(), and llvm::LegalizeActions::Lower.

Referenced by add(), getPreferredRange(), multiply(), and sub().

## ◆ isUpperSignWrapped()

 bool ConstantRange::isUpperSignWrapped ( ) const

Return true if the (exclusive) upper bound wraps around the signed domain.

Special cases:

• Empty set: Not wrapped.
• Full set: Not wrapped.
• [X, SignedMin): Wrapped.

Definition at line 303 of file ConstantRange.cpp.

References llvm::LegalizeActions::Lower.

Referenced by getSignedMax(), and isAllNegative().

## ◆ isUpperWrapped()

 bool ConstantRange::isUpperWrapped ( ) const

Return true if the exclusive upper bound wraps around the unsigned domain.

Special cases:

• Empty set: Not wrapped.
• Full set: Not wrapped.
• [X, 0): Wrapped.

Definition at line 295 of file ConstantRange.cpp.

References llvm::LegalizeActions::Lower.

## ◆ isWrappedSet()

 bool ConstantRange::isWrappedSet ( ) const

Return true if this set wraps around the unsigned domain.

Special cases:

• Empty set: Not wrapped.
• Full set: Not wrapped.
• [X, 0) == [X, Max]: Not wrapped.

Definition at line 291 of file ConstantRange.cpp.

References llvm::APInt::isNullValue(), and llvm::LegalizeActions::Lower.

Referenced by getPreferredRange(), and getUnsignedMin().

## ◆ lshr()

 ConstantRange ConstantRange::lshr ( const ConstantRange & Other ) const

Return a new range representing the possible values resulting from a logical right shift of a value in this range and a value in Other.

Definition at line 1196 of file ConstantRange.cpp.

Referenced by binaryOp().

## ◆ makeAllowedICmpRegion()

 ConstantRange ConstantRange::makeAllowedICmpRegion ( CmpInst::Predicate Pred, const ConstantRange & Other )
static

Produce the smallest range such that all values that may satisfy the given predicate with any value contained within Other is contained in the returned range.

Formally, this returns a superset of 'union over all y in Other . { x : icmp op x y is true }'. If the exact answer is not representable as a ConstantRange, the return value will be a proper superset of the above.

Example: Pred = ult and Other = i8 [2, 5) returns Result = [0, 4)

Definition at line 77 of file ConstantRange.cpp.

## ◆ makeExactICmpRegion()

 ConstantRange ConstantRange::makeExactICmpRegion ( CmpInst::Predicate Pred, const APInt & Other )
static

Produce the exact range such that all values in the returned range satisfy the given predicate with any value contained within Other.

Formally, this returns the exact answer when the superset of 'union over all y in Other is exactly same as the subset of intersection over all y in Other. { x : icmp op x y is true}'.

Example: Pred = ult and Other = i8 3 returns [0, 3)

Definition at line 137 of file ConstantRange.cpp.

References assert(), makeAllowedICmpRegion(), and makeSatisfyingICmpRegion().

## ◆ makeExactNoWrapRegion()

 ConstantRange ConstantRange::makeExactNoWrapRegion ( Instruction::BinaryOps BinOp, const APInt & Other, unsigned NoWrapKind )
static

Produce the range that contains X if and only if "X BinOp Other" does not wrap.

Definition at line 275 of file ConstantRange.cpp.

References ConstantRange(), and makeGuaranteedNoWrapRegion().

Referenced by getValueFromOverflowCondition().

## ◆ makeGuaranteedNoWrapRegion()

 ConstantRange ConstantRange::makeGuaranteedNoWrapRegion ( Instruction::BinaryOps BinOp, const ConstantRange & Other, unsigned NoWrapKind )
static

Produce the largest range containing all X such that "X BinOp Y" is guaranteed not to wrap (overflow) for all Y in Other.

However, there may be some Y in Other for which additional X not contained in the result also do not overflow.

NoWrapKind must be one of OBO::NoUnsignedWrap or OBO::NoSignedWrap.

Examples: typedef OverflowingBinaryOperator OBO; #define MGNR makeGuaranteedNoWrapRegion MGNR(Add, [i8 1, 2), OBO::NoSignedWrap) == [-128, 127) MGNR(Add, [i8 1, 2), OBO::NoUnsignedWrap) == [0, -1) MGNR(Add, [i8 0, 1), OBO::NoUnsignedWrap) == Full Set MGNR(Add, [i8 -1, 6), OBO::NoSignedWrap) == [INT_MIN+1, INT_MAX-4) MGNR(Sub, [i8 1, 2), OBO::NoSignedWrap) == [-127, 128) MGNR(Sub, [i8 1, 2), OBO::NoUnsignedWrap) == [1, 0)

Definition at line 225 of file ConstantRange.cpp.

## ◆ makeSatisfyingICmpRegion()

 ConstantRange ConstantRange::makeSatisfyingICmpRegion ( CmpInst::Predicate Pred, const ConstantRange & Other )
static

Produce the largest range such that all values in the returned range satisfy the given predicate with all values contained within Other.

Formally, this returns a subset of 'intersection over all y in Other . { x : icmp op x y is true }'. If the exact answer is not representable as a ConstantRange, the return value will be a proper subset of the above.

Example: Pred = ult and Other = i8 [2, 5) returns [0, 2)

Definition at line 127 of file ConstantRange.cpp.

References llvm::CmpInst::getInversePredicate(), inverse(), and makeAllowedICmpRegion().

## ◆ multiply()

 ConstantRange ConstantRange::multiply ( const ConstantRange & Other ) const

Return a new range representing the possible values resulting from a multiplication of a value in this range and a value in Other, treating both this and Other as unsigned ranges.

Definition at line 890 of file ConstantRange.cpp.

## ◆ operator!=()

 bool llvm::ConstantRange::operator!= ( const ConstantRange & CR ) const
inline

Definition at line 252 of file ConstantRange.h.

References llvm::operator==().

## ◆ operator==()

 bool llvm::ConstantRange::operator== ( const ConstantRange & CR ) const
inline

Return true if this range is equal to another range.

Definition at line 249 of file ConstantRange.h.

## ◆ print()

 void ConstantRange::print ( raw_ostream & OS ) const

Print out the bounds to a stream.

Definition at line 1443 of file ConstantRange.cpp.

References isEmptySet(), isFullSet(), and llvm::LegalizeActions::Lower.

Referenced by dump(), llvm::operator<<(), and llvm::ScalarEvolution::print().

 ConstantRange ConstantRange::sadd_sat ( const ConstantRange & Other ) const

Perform a signed saturating addition of two constant ranges.

Definition at line 1265 of file ConstantRange.cpp.

References getNonEmpty(), getSignedMax(), getSignedMin(), isEmptySet(), and llvm::APInt::sadd_sat().

## ◆ sdiv()

 ConstantRange ConstantRange::sdiv ( const ConstantRange & Other ) const

Return a new range representing the possible values resulting from a signed division of a value in this range and a value in Other.

Division by zero and division of SignedMin by -1 are considered undefined behavior, in line with IR, and do not contribute towards the result.

Definition at line 1008 of file ConstantRange.cpp.

Referenced by binaryOp().

## ◆ sextOrTrunc()

 ConstantRange ConstantRange::sextOrTrunc ( uint32_t BitWidth ) const

Make this range have the bit width given by BitWidth.

The value is sign extended, truncated, or left alone to make it that width.

Definition at line 746 of file ConstantRange.cpp.

References getBitWidth(), signExtend(), and truncate().

Referenced by llvm::ScalarEvolution::getSignExtendExpr().

## ◆ shl()

 ConstantRange ConstantRange::shl ( const ConstantRange & Other ) const

Return a new range representing the possible values resulting from a left shift of a value in this range by a value in Other.

TODO: This isn't fully implemented yet.

Definition at line 1171 of file ConstantRange.cpp.

Referenced by binaryOp().

 ConstantRange::OverflowResult ConstantRange::signedAddMayOverflow ( const ConstantRange & Other ) const

Return whether signed add of the two ranges always/never overflows.

Definition at line 1347 of file ConstantRange.cpp.

## ◆ signedSubMayOverflow()

 ConstantRange::OverflowResult ConstantRange::signedSubMayOverflow ( const ConstantRange & Other ) const

Return whether signed sub of the two ranges always/never overflows.

Definition at line 1393 of file ConstantRange.cpp.

Referenced by llvm::computeOverflowForSignedSub().

## ◆ signExtend()

 ConstantRange ConstantRange::signExtend ( uint32_t BitWidth ) const

Return a new range in the specified integer type, which must be strictly larger than the current type.

The returned range will correspond to the possible range of values if the source range had been sign extended to BitWidth.

Definition at line 665 of file ConstantRange.cpp.

## ◆ smax()

 ConstantRange ConstantRange::smax ( const ConstantRange & Other ) const

Return a new range representing the possible values resulting from a signed maximum of a value in this range and a value in Other.

Definition at line 944 of file ConstantRange.cpp.

References getNonEmpty(), getSignedMax(), getSignedMin(), isEmptySet(), and llvm::APIntOps::smax().

## ◆ smin()

 ConstantRange ConstantRange::smin ( const ConstantRange & Other ) const

Return a new range representing the possible values resulting from a signed minimum of a value in this range and a value in Other.

Definition at line 966 of file ConstantRange.cpp.

References getNonEmpty(), getSignedMax(), getSignedMin(), isEmptySet(), and llvm::APIntOps::smin().

## ◆ srem()

 ConstantRange ConstantRange::srem ( const ConstantRange & Other ) const

Return a new range representing the possible values resulting from a signed remainder operation of a value in this range and a value in Other.

Definition at line 1106 of file ConstantRange.cpp.

Referenced by binaryOp().

## ◆ ssub_sat()

 ConstantRange ConstantRange::ssub_sat ( const ConstantRange & Other ) const

Perform a signed saturating subtraction of two constant ranges.

Definition at line 1283 of file ConstantRange.cpp.

References getNonEmpty(), getSignedMax(), getSignedMin(), isEmptySet(), and llvm::APInt::ssub_sat().

## ◆ sub()

 ConstantRange ConstantRange::sub ( const ConstantRange & Other ) const

Return a new range representing the possible values resulting from a subtraction of a value in this range and a value in Other.

Definition at line 870 of file ConstantRange.cpp.

Referenced by binaryOp().

## ◆ subtract()

 ConstantRange ConstantRange::subtract ( const APInt & CI ) const

Subtract the specified constant from the endpoints of this constant range.

Definition at line 394 of file ConstantRange.cpp.

## ◆ truncate()

 ConstantRange ConstantRange::truncate ( uint32_t BitWidth ) const

Return a new range in the specified integer type, which must be strictly smaller than the current type.

The returned range will correspond to the possible range of values if the source range had been truncated to the specified type.

Definition at line 683 of file ConstantRange.cpp.

 ConstantRange ConstantRange::uadd_sat ( const ConstantRange & Other ) const

Perform an unsigned saturating addition of two constant ranges.

Definition at line 1256 of file ConstantRange.cpp.

## ◆ udiv()

 ConstantRange ConstantRange::udiv ( const ConstantRange & Other ) const

Return a new range representing the possible values resulting from an unsigned division of a value in this range and a value in Other.

Definition at line 988 of file ConstantRange.cpp.

## ◆ umax()

 ConstantRange ConstantRange::umax ( const ConstantRange & Other ) const

Return a new range representing the possible values resulting from an unsigned maximum of a value in this range and a value in Other.

Definition at line 955 of file ConstantRange.cpp.

## ◆ umin()

 ConstantRange ConstantRange::umin ( const ConstantRange & Other ) const

Return a new range representing the possible values resulting from an unsigned minimum of a value in this range and a value in Other.

Definition at line 977 of file ConstantRange.cpp.

## ◆ unionWith()

 ConstantRange ConstantRange::unionWith ( const ConstantRange & CR, PreferredRangeType Type = Smallest ) const

Return the range that results from the union of this range with another range.

The resultant range is guaranteed to include the elements of both sets, but may contain more. For example, [3, 9) union [12,15) is [3, 15), which includes 9, 10, and 11, which were not included in either set before.

Definition at line 532 of file ConstantRange.cpp.

 ConstantRange::OverflowResult ConstantRange::unsignedAddMayOverflow ( const ConstantRange & Other ) const

Return whether unsigned add of the two ranges always/never overflows.

Definition at line 1331 of file ConstantRange.cpp.

## ◆ unsignedMulMayOverflow()

 ConstantRange::OverflowResult ConstantRange::unsignedMulMayOverflow ( const ConstantRange & Other ) const

Return whether unsigned mul of the two ranges always/never overflows.

Definition at line 1423 of file ConstantRange.cpp.

Referenced by llvm::computeOverflowForUnsignedMul().

## ◆ unsignedSubMayOverflow()

 ConstantRange::OverflowResult ConstantRange::unsignedSubMayOverflow ( const ConstantRange & Other ) const

Return whether unsigned sub of the two ranges always/never overflows.

Definition at line 1377 of file ConstantRange.cpp.

Referenced by llvm::computeOverflowForUnsignedSub().

## ◆ urem()

 ConstantRange ConstantRange::urem ( const ConstantRange & Other ) const

Return a new range representing the possible values resulting from an unsigned remainder operation of a value in this range and a value in Other.

Definition at line 1093 of file ConstantRange.cpp.

Referenced by binaryOp().

## ◆ usub_sat()

 ConstantRange ConstantRange::usub_sat ( const ConstantRange & Other ) const

Perform an unsigned saturating subtraction of two constant ranges.

Definition at line 1274 of file ConstantRange.cpp.

## ◆ zeroExtend()

 ConstantRange ConstantRange::zeroExtend ( uint32_t BitWidth ) const

Return a new range in the specified integer type, which must be strictly larger than the current type.

The returned range will correspond to the possible range of values if the source range had been zero extended to BitWidth.

Definition at line 648 of file ConstantRange.cpp.

## ◆ zextOrTrunc()

 ConstantRange ConstantRange::zextOrTrunc ( uint32_t BitWidth ) const

Make this range have the bit width given by BitWidth.

The value is zero extended, truncated, or left alone to make it that width.

Definition at line 737 of file ConstantRange.cpp.

References getBitWidth(), truncate(), and zeroExtend().

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