24#include "llvm/Config/llvm-config.h"
54 "ConstantRange with unequal bit widths");
56 "Lower == Upper, but they aren't min or max value!");
89 if (std::optional<unsigned> DifferentBit =
114 if (
UMax.isMinValue())
120 if (
SMax.isMinSignedValue())
130 if (
UMin.isMaxValue())
136 if (
SMin.isMaxSignedValue())
191 "Only for relational integer predicates!");
197 return FlippedSignednessPred;
216 RHS = *OnlyMissingElt;
249 unsigned BitWidth = V.getBitWidth();
251 return ConstantRange::getFull(V.getBitWidth());
263 unsigned BitWidth = V.getBitWidth();
265 return ConstantRange::getFull(
BitWidth);
274 if (V.isNegative()) {
287 unsigned NoWrapKind) {
292 assert((NoWrapKind == OBO::NoSignedWrap ||
293 NoWrapKind == OBO::NoUnsignedWrap) &&
294 "NoWrapKind invalid!");
296 bool Unsigned = NoWrapKind == OBO::NoUnsignedWrap;
303 case Instruction::Add: {
310 SMin.isNegative() ? SignedMinVal -
SMin : SignedMinVal,
311 SMax.isStrictlyPositive() ? SignedMinVal -
SMax : SignedMinVal);
314 case Instruction::Sub: {
321 SMax.isStrictlyPositive() ? SignedMinVal +
SMax : SignedMinVal,
322 SMin.isNegative() ? SignedMinVal +
SMin : SignedMinVal);
325 case Instruction::Mul:
336 case Instruction::Shl: {
361 unsigned NoWrapKind) {
369 unsigned BitWidth = Mask.getBitWidth();
393 return Lower.
ugt(Upper) && !Upper.
isZero();
397 return Lower.
ugt(Upper);
405 return Lower.
sgt(Upper);
413 if (
Other.isFullSet())
415 return (Upper - Lower).ult(
Other.Upper -
Other.Lower);
425 return (Upper - Lower).ugt(MaxSize);
472 return Lower.
ule(V) && V.ult(Upper);
473 return Lower.
ule(V) || V.ult(Upper);
481 if (
Other.isUpperWrapped())
484 return Lower.
ule(
Other.getLower()) &&
Other.getUpper().ule(Upper);
487 if (!
Other.isUpperWrapped())
488 return Other.getUpper().ule(Upper) ||
491 return Other.getUpper().ule(Upper) && Lower.
ule(
Other.getLower());
544 "ConstantRange types don't agree!");
554 if (Lower.
ult(CR.Lower)) {
557 if (Upper.
ule(CR.Lower))
562 if (Upper.
ult(CR.Upper))
571 if (Upper.
ult(CR.Upper))
576 if (Lower.
ult(CR.Upper))
585 if (CR.Lower.
ult(Upper)) {
588 if (CR.Upper.
ult(Upper))
593 if (CR.Upper.
ule(Lower))
600 if (CR.Lower.
ult(Lower)) {
603 if (CR.Upper.
ule(Lower))
616 if (CR.Upper.
ult(Upper)) {
619 if (CR.Lower.
ult(Upper))
624 if (CR.Lower.
ult(Lower))
631 if (CR.Upper.
ule(Lower)) {
634 if (CR.Lower.
ult(Lower))
650 "ConstantRange types don't agree!");
664 if (CR.Upper.
ult(Lower) || Upper.
ult(CR.Lower))
668 APInt L = CR.Lower.
ult(Lower) ? CR.Lower : Lower;
669 APInt U = (CR.Upper - 1).ugt(Upper - 1) ? CR.Upper : Upper;
671 if (L.isZero() && U.isZero())
680 if (CR.Upper.
ule(Upper) || CR.Lower.
uge(Lower))
685 if (CR.Lower.
ule(Upper) && Lower.
ule(CR.Upper))
693 if (Upper.
ult(CR.Lower) && CR.Upper.
ult(Lower))
699 if (Upper.
ult(CR.Lower) && Lower.
ule(CR.Upper))
705 "ConstantRange::unionWith missed a case with one range wrapped");
711 if (CR.Lower.
ule(Upper) || Lower.
ule(CR.Upper))
714 APInt L = CR.Lower.
ult(Lower) ? CR.Lower : Lower;
715 APInt U = CR.Upper.
ugt(Upper) ? CR.Upper : Upper;
720std::optional<ConstantRange>
729std::optional<ConstantRange>
743 case Instruction::Trunc:
745 case Instruction::SExt:
747 case Instruction::ZExt:
749 case Instruction::BitCast:
751 case Instruction::FPToUI:
752 case Instruction::FPToSI:
756 return getFull(ResultBitWidth);
757 case Instruction::UIToFP: {
762 if (ResultBitWidth > BW) {
763 Min = Min.
zext(ResultBitWidth);
764 Max = Max.zext(ResultBitWidth);
766 return getNonEmpty(std::move(Min), std::move(Max) + 1);
768 case Instruction::SIToFP: {
773 if (ResultBitWidth > BW) {
779 case Instruction::FPTrunc:
780 case Instruction::FPExt:
781 case Instruction::IntToPtr:
782 case Instruction::PtrToInt:
783 case Instruction::AddrSpaceCast:
785 return getFull(ResultBitWidth);
793 assert(SrcTySize < DstTySize &&
"Not a value extension");
796 APInt LowerExt(DstTySize, 0);
798 LowerExt = Lower.
zext(DstTySize);
810 assert(SrcTySize < DstTySize &&
"Not a value extension");
827 return getEmpty(DstTySize);
829 return getFull(DstTySize);
831 APInt LowerDiv(Lower), UpperDiv(Upper);
841 return getFull(DstTySize);
848 if (LowerDiv == UpperDiv)
853 if (LowerDiv.getActiveBits() > DstTySize) {
861 if (UpperDivWidth <= DstTySize)
866 if (UpperDivWidth == DstTySize + 1) {
869 if (UpperDiv.
ult(LowerDiv))
874 return getFull(DstTySize);
879 if (SrcTySize > DstTySize)
881 if (SrcTySize < DstTySize)
888 if (SrcTySize > DstTySize)
890 if (SrcTySize < DstTySize)
900 case Instruction::Add:
902 case Instruction::Sub:
904 case Instruction::Mul:
906 case Instruction::UDiv:
908 case Instruction::SDiv:
910 case Instruction::URem:
912 case Instruction::SRem:
914 case Instruction::Shl:
916 case Instruction::LShr:
918 case Instruction::AShr:
920 case Instruction::And:
922 case Instruction::Or:
924 case Instruction::Xor:
928 case Instruction::FAdd:
930 case Instruction::FSub:
932 case Instruction::FMul:
942 unsigned NoWrapKind)
const {
946 case Instruction::Add:
948 case Instruction::Sub:
950 case Instruction::Mul:
960 switch (IntrinsicID) {
961 case Intrinsic::uadd_sat:
962 case Intrinsic::usub_sat:
963 case Intrinsic::sadd_sat:
964 case Intrinsic::ssub_sat:
965 case Intrinsic::umin:
966 case Intrinsic::umax:
967 case Intrinsic::smin:
968 case Intrinsic::smax:
970 case Intrinsic::ctlz:
971 case Intrinsic::cttz:
972 case Intrinsic::ctpop:
981 switch (IntrinsicID) {
982 case Intrinsic::uadd_sat:
983 return Ops[0].uadd_sat(Ops[1]);
984 case Intrinsic::usub_sat:
985 return Ops[0].usub_sat(Ops[1]);
986 case Intrinsic::sadd_sat:
987 return Ops[0].sadd_sat(Ops[1]);
988 case Intrinsic::ssub_sat:
989 return Ops[0].ssub_sat(Ops[1]);
990 case Intrinsic::umin:
991 return Ops[0].umin(Ops[1]);
992 case Intrinsic::umax:
993 return Ops[0].umax(Ops[1]);
994 case Intrinsic::smin:
995 return Ops[0].smin(Ops[1]);
996 case Intrinsic::smax:
997 return Ops[0].smax(Ops[1]);
998 case Intrinsic::abs: {
999 const APInt *IntMinIsPoison = Ops[1].getSingleElement();
1000 assert(IntMinIsPoison &&
"Must be known (immarg)");
1004 case Intrinsic::ctlz: {
1005 const APInt *ZeroIsPoison = Ops[1].getSingleElement();
1006 assert(ZeroIsPoison &&
"Must be known (immarg)");
1010 case Intrinsic::cttz: {
1011 const APInt *ZeroIsPoison = Ops[1].getSingleElement();
1012 assert(ZeroIsPoison &&
"Must be known (immarg)");
1016 case Intrinsic::ctpop:
1017 return Ops[0].ctpop();
1033 if (NewLower == NewUpper)
1037 if (
X.isSizeStrictlySmallerThan(*
this) ||
1038 X.isSizeStrictlySmallerThan(
Other))
1045 unsigned NoWrapKind,
1062 if (NoWrapKind & OBO::NoSignedWrap)
1065 if (NoWrapKind & OBO::NoUnsignedWrap)
1080 if (NewLower == NewUpper)
1084 if (
X.isSizeStrictlySmallerThan(*
this) ||
1085 X.isSizeStrictlySmallerThan(
Other))
1092 unsigned NoWrapKind,
1109 if (NoWrapKind & OBO::NoSignedWrap)
1112 if (NoWrapKind & OBO::NoUnsignedWrap) {
1158 this_max * Other_max + 1);
1180 auto L = {this_min * Other_min, this_min * Other_max,
1181 this_max * Other_min, this_max * Other_max};
1182 auto Compare = [](
const APInt &
A,
const APInt &
B) {
return A.slt(
B); };
1183 ConstantRange Result_sext(std::min(L, Compare), std::max(L, Compare) + 1);
1191 unsigned NoWrapKind,
1218 bool O1, O2, O3, O4;
1219 auto Muls = {Min.
smul_ov(OtherMin, O1), Min.
smul_ov(OtherMax, O2),
1220 Max.smul_ov(OtherMin, O3), Max.smul_ov(OtherMax, O4)};
1221 if (O1 || O2 || O3 || O4)
1224 auto Compare = [](
const APInt &
A,
const APInt &
B) {
return A.slt(
B); };
1225 return getNonEmpty(std::min(Muls, Compare), std::max(Muls, Compare) + 1);
1291 APInt RHS_umin =
RHS.getUnsignedMin();
1295 if (
RHS.getUpper() == 1)
1296 RHS_umin =
RHS.getLower();
1325 (PosL.Upper - 1).
sdiv(PosR.Lower) + 1);
1340 if (
RHS.Lower.isAllOnes())
1342 AdjNegRUpper =
RHS.Upper;
1345 AdjNegRUpper = NegR.Upper - 1;
1353 if (NegL.Upper != SignedMin + 1) {
1355 if (Upper == SignedMin + 1)
1357 AdjNegLLower = Lower;
1360 AdjNegLLower = NegL.Lower + 1;
1364 AdjNegLLower.
sdiv(NegR.Upper - 1) + 1));
1375 NegRes =
ConstantRange((PosL.Upper - 1).sdiv(NegR.Upper - 1),
1376 PosL.Lower.
sdiv(NegR.Lower) + 1);
1382 (NegL.Upper - 1).
sdiv(PosR.Upper - 1) + 1));
1397 if (
const APInt *RHSInt =
RHS.getSingleElement()) {
1399 if (RHSInt->isZero())
1403 return {LHSInt->urem(*RHSInt)};
1419 if (
const APInt *RHSInt =
RHS.getSingleElement()) {
1421 if (RHSInt->isZero())
1425 return {LHSInt->srem(*RHSInt)};
1443 if (MaxLHS.ult(MinAbsRHS))
1452 if (MaxLHS.isNegative()) {
1453 if (MinLHS.
ugt(-MinAbsRHS))
1504 if (
Other.isSingleElement() &&
Other.getSingleElement()->isAllOnes())
1507 return Other.binaryNot();
1520 if ((~LHSKnown.
Zero).isSubsetOf(RHSKnown.
One))
1522 else if ((~RHSKnown.
Zero).isSubsetOf(LHSKnown.
One))
1539 unsigned EqualLeadingBits = (Min ^ Max).
countl_zero();
1540 if (
RHS->ule(EqualLeadingBits))
1551 Max <<=
Other.getUnsignedMin();
1557 if (OtherMax.
ugt(Max.countl_zero()))
1562 Min <<=
Other.getUnsignedMin();
1635 return getNonEmpty(std::move(NewL), std::move(NewU));
1644 return getNonEmpty(std::move(NewL), std::move(NewU));
1653 return getNonEmpty(std::move(NewL), std::move(NewU));
1662 return getNonEmpty(std::move(NewL), std::move(NewU));
1671 return getNonEmpty(std::move(NewL), std::move(NewU));
1690 Max.smul_sat(OtherMin), Max.smul_sat(OtherMax)};
1691 auto Compare = [](
const APInt &
A,
const APInt &
B) {
return A.slt(
B); };
1692 return getNonEmpty(std::min(L, Compare), std::max(L, Compare) + 1);
1701 return getNonEmpty(std::move(NewL), std::move(NewU));
1709 APInt ShAmtMin =
Other.getUnsignedMin(), ShAmtMax =
Other.getUnsignedMax();
1711 APInt NewU = Max.sshl_sat(Max.isNegative() ? ShAmtMin : ShAmtMax) + 1;
1712 return getNonEmpty(std::move(NewL), std::move(NewU));
1745 if (IntMinIsPoison &&
SMin.isMinSignedValue()) {
1747 if (
SMax.isMinSignedValue())
1753 if (
SMin.isNonNegative())
1757 if (
SMax.isNegative())
1770 if (ZeroIsPoison &&
contains(Zero)) {
1806 "Unexpected wrapped set.");
1816 unsigned LCPLength = (
Lower ^ (
Upper - 1)).countl_zero();
1822 std::max(
BitWidth - LCPLength - 1,
Lower.countr_zero()) + 1));
1831 if (ZeroIsPoison &&
contains(Zero)) {
1847 }
else if (Upper == 1) {
1874 "Unexpected wrapped set.");
1883 unsigned LCPPopCount =
Lower.getHiBits(LCPLength).popcount();
1887 LCPPopCount + (
Lower.countr_zero() <
BitWidth - LCPLength ? 1 : 0);
1892 unsigned MaxBits = LCPPopCount + (
BitWidth - LCPLength) -
1893 (Max.countr_one() <
BitWidth - LCPLength ? 1 : 0);
1923 APInt OtherMin =
Other.getUnsignedMin(), OtherMax =
Other.getUnsignedMax();
1926 if (Min.
ugt(~OtherMin))
1928 if (Max.ugt(~OtherMax))
1939 APInt OtherMin =
Other.getSignedMin(), OtherMax =
Other.getSignedMax();
1947 Min.
sgt(SignedMax - OtherMin))
1949 if (Max.isNegative() && OtherMax.isNegative() &&
1950 Max.slt(SignedMin - OtherMax))
1953 if (Max.isNonNegative() && OtherMax.isNonNegative() &&
1954 Max.sgt(SignedMax - OtherMax))
1957 Min.
slt(SignedMin - OtherMin))
1969 APInt OtherMin =
Other.getUnsignedMin(), OtherMax =
Other.getUnsignedMax();
1972 if (Max.ult(OtherMin))
1974 if (Min.
ult(OtherMax))
1985 APInt OtherMin =
Other.getSignedMin(), OtherMax =
Other.getSignedMax();
1993 Min.
sgt(SignedMax + OtherMax))
1996 Max.slt(SignedMin + OtherMin))
1999 if (Max.isNonNegative() && OtherMin.
isNegative() &&
2000 Max.sgt(SignedMax + OtherMin))
2002 if (Min.
isNegative() && OtherMax.isNonNegative() &&
2003 Min.
slt(SignedMin + OtherMax))
2015 APInt OtherMin =
Other.getUnsignedMin(), OtherMax =
Other.getUnsignedMax();
2018 (void) Min.
umul_ov(OtherMin, Overflow);
2022 (void) Max.umul_ov(OtherMax, Overflow);
2035 OS <<
"[" << Lower <<
"," << Upper <<
")";
2038#if !defined(NDEBUG) || defined(LLVM_ENABLE_DUMP)
2045 const unsigned NumRanges = Ranges.getNumOperands() / 2;
2046 assert(NumRanges >= 1 &&
"Must have at least one range!");
2047 assert(Ranges.getNumOperands() % 2 == 0 &&
"Must be a sequence of pairs");
2049 auto *FirstLow = mdconst::extract<ConstantInt>(Ranges.getOperand(0));
2050 auto *FirstHigh = mdconst::extract<ConstantInt>(Ranges.getOperand(1));
2052 ConstantRange CR(FirstLow->getValue(), FirstHigh->getValue());
2054 for (
unsigned i = 1; i < NumRanges; ++i) {
2055 auto *
Low = mdconst::extract<ConstantInt>(Ranges.getOperand(2 * i + 0));
2056 auto *
High = mdconst::extract<ConstantInt>(Ranges.getOperand(2 * i + 1));
This file implements a class to represent arbitrary precision integral constant values and operations...
static GCRegistry::Add< OcamlGC > B("ocaml", "ocaml 3.10-compatible GC")
static GCRegistry::Add< ErlangGC > A("erlang", "erlang-compatible garbage collector")
#define LLVM_DUMP_METHOD
Mark debug helper function definitions like dump() that should not be stripped from debug builds.
static ConstantRange getUnsignedPopCountRange(const APInt &Lower, const APInt &Upper)
static ConstantRange makeExactMulNUWRegion(const APInt &V)
Exact mul nuw region for single element RHS.
static ConstantRange makeExactMulNSWRegion(const APInt &V)
Exact mul nsw region for single element RHS.
static ConstantRange getPreferredRange(const ConstantRange &CR1, const ConstantRange &CR2, ConstantRange::PreferredRangeType Type)
static ConstantRange getUnsignedCountTrailingZerosRange(const APInt &Lower, const APInt &Upper)
This file contains the declarations for the subclasses of Constant, which represent the different fla...
static GCMetadataPrinterRegistry::Add< ErlangGCPrinter > X("erlang", "erlang-compatible garbage collector")
static bool isZero(Value *V, const DataLayout &DL, DominatorTree *DT, AssumptionCache *AC)
assert(ImpDefSCC.getReg()==AMDGPU::SCC &&ImpDefSCC.isDef())
Class for arbitrary precision integers.
APInt umul_ov(const APInt &RHS, bool &Overflow) const
APInt usub_sat(const APInt &RHS) const
APInt udiv(const APInt &RHS) const
Unsigned division operation.
static APInt getAllOnes(unsigned numBits)
Return an APInt of a specified width with all bits set.
void clearBit(unsigned BitPosition)
Set a given bit to 0.
APInt zext(unsigned width) const
Zero extend to a new width.
bool isMinSignedValue() const
Determine if this is the smallest signed value.
unsigned getActiveBits() const
Compute the number of active bits in the value.
APInt trunc(unsigned width) const
Truncate to new width.
static APInt getMaxValue(unsigned numBits)
Gets maximum unsigned value of APInt for specific bit width.
APInt smul_sat(const APInt &RHS) const
APInt sadd_sat(const APInt &RHS) const
bool sgt(const APInt &RHS) const
Signed greater than comparison.
bool isAllOnes() const
Determine if all bits are set. This is true for zero-width values.
bool ugt(const APInt &RHS) const
Unsigned greater than comparison.
bool isZero() const
Determine if this value is zero, i.e. all bits are clear.
unsigned getBitWidth() const
Return the number of bits in the APInt.
bool ult(const APInt &RHS) const
Unsigned less than comparison.
static APInt getSignedMaxValue(unsigned numBits)
Gets maximum signed value of APInt for a specific bit width.
bool isMinValue() const
Determine if this is the smallest unsigned value.
static APInt getMinValue(unsigned numBits)
Gets minimum unsigned value of APInt for a specific bit width.
bool isNegative() const
Determine sign of this APInt.
APInt sdiv(const APInt &RHS) const
Signed division function for APInt.
static APInt getSignedMinValue(unsigned numBits)
Gets minimum signed value of APInt for a specific bit width.
APInt sshl_sat(const APInt &RHS) const
APInt ushl_sat(const APInt &RHS) const
bool isStrictlyPositive() const
Determine if this APInt Value is positive.
unsigned countl_one() const
Count the number of leading one bits.
void clearLowBits(unsigned loBits)
Set bottom loBits bits to 0.
APInt uadd_sat(const APInt &RHS) const
APInt ashr(unsigned ShiftAmt) const
Arithmetic right-shift function.
void setAllBits()
Set every bit to 1.
bool getBoolValue() const
Convert APInt to a boolean value.
APInt smul_ov(const APInt &RHS, bool &Overflow) const
bool isNonNegative() const
Determine if this APInt Value is non-negative (>= 0)
bool ule(const APInt &RHS) const
Unsigned less or equal comparison.
APInt sext(unsigned width) const
Sign extend to a new width.
APInt umul_sat(const APInt &RHS) const
static APInt getLowBitsSet(unsigned numBits, unsigned loBitsSet)
Constructs an APInt value that has the bottom loBitsSet bits set.
bool slt(const APInt &RHS) const
Signed less than comparison.
static APInt getHighBitsSet(unsigned numBits, unsigned hiBitsSet)
Constructs an APInt value that has the top hiBitsSet bits set.
static APInt getZero(unsigned numBits)
Get the '0' value for the specified bit-width.
static APInt getBitsSetFrom(unsigned numBits, unsigned loBit)
Constructs an APInt value that has a contiguous range of bits set.
static APInt getOneBitSet(unsigned numBits, unsigned BitNo)
Return an APInt with exactly one bit set in the result.
APInt lshr(unsigned shiftAmt) const
Logical right-shift function.
unsigned countr_one() const
Count the number of trailing one bits.
bool uge(const APInt &RHS) const
Unsigned greater or equal comparison.
void clearSignBit()
Set the sign bit to 0.
APInt ssub_sat(const APInt &RHS) const
bool isMaxValue() const
Determine if this is the largest unsigned value.
ArrayRef - Represent a constant reference to an array (0 or more elements consecutively in memory),...
Predicate
This enumeration lists the possible predicates for CmpInst subclasses.
@ ICMP_SLT
signed less than
@ ICMP_SLE
signed less or equal
@ ICMP_UGE
unsigned greater or equal
@ ICMP_UGT
unsigned greater than
@ ICMP_SGT
signed greater than
@ ICMP_ULT
unsigned less than
@ ICMP_SGE
signed greater or equal
@ ICMP_ULE
unsigned less or equal
Predicate getInversePredicate() const
For example, EQ -> NE, UGT -> ULE, SLT -> SGE, OEQ -> UNE, UGT -> OLE, OLT -> UGE,...
Predicate getFlippedSignednessPredicate()
For example, SLT->ULT, ULT->SLT, SLE->ULE, ULE->SLE, EQ->Failed assert.
bool isIntPredicate() const
bool isRelational() const
Return true if the predicate is relational (not EQ or NE).
This class represents a range of values.
ConstantRange multiply(const ConstantRange &Other) const
Return a new range representing the possible values resulting from a multiplication of a value in thi...
ConstantRange add(const ConstantRange &Other) const
Return a new range representing the possible values resulting from an addition of a value in this ran...
bool isUpperSignWrapped() const
Return true if the (exclusive) upper bound wraps around the signed domain.
unsigned getActiveBits() const
Compute the maximal number of active bits needed to represent every value in this range.
ConstantRange zextOrTrunc(uint32_t BitWidth) const
Make this range have the bit width given by BitWidth.
PreferredRangeType
If represented precisely, the result of some range operations may consist of multiple disjoint ranges...
std::optional< ConstantRange > exactUnionWith(const ConstantRange &CR) const
Union the two ranges and return the result if it can be represented exactly, otherwise return std::nu...
bool getEquivalentICmp(CmpInst::Predicate &Pred, APInt &RHS) const
Set up Pred and RHS such that ConstantRange::makeExactICmpRegion(Pred, RHS) == *this.
ConstantRange umul_sat(const ConstantRange &Other) const
Perform an unsigned saturating multiplication of two constant ranges.
static CmpInst::Predicate getEquivalentPredWithFlippedSignedness(CmpInst::Predicate Pred, const ConstantRange &CR1, const ConstantRange &CR2)
If the comparison between constant ranges this and Other is insensitive to the signedness of the comp...
ConstantRange subtract(const APInt &CI) const
Subtract the specified constant from the endpoints of this constant range.
const APInt * getSingleElement() const
If this set contains a single element, return it, otherwise return null.
ConstantRange binaryXor(const ConstantRange &Other) const
Return a new range representing the possible values resulting from a binary-xor of a value in this ra...
const APInt * getSingleMissingElement() const
If this set contains all but a single element, return it, otherwise return null.
static ConstantRange fromKnownBits(const KnownBits &Known, bool IsSigned)
Initialize a range based on a known bits constraint.
const APInt & getLower() const
Return the lower value for this range.
OverflowResult unsignedSubMayOverflow(const ConstantRange &Other) const
Return whether unsigned sub of the two ranges always/never overflows.
bool isAllNegative() const
Return true if all values in this range are negative.
ConstantRange truncate(uint32_t BitWidth) const
Return a new range in the specified integer type, which must be strictly smaller than the current typ...
OverflowResult unsignedAddMayOverflow(const ConstantRange &Other) const
Return whether unsigned add of the two ranges always/never overflows.
ConstantRange urem(const ConstantRange &Other) const
Return a new range representing the possible values resulting from an unsigned remainder operation of...
ConstantRange sshl_sat(const ConstantRange &Other) const
Perform a signed saturating left shift of this constant range by a value in Other.
ConstantRange smul_fast(const ConstantRange &Other) const
Return range of possible values for a signed multiplication of this and Other.
ConstantRange lshr(const ConstantRange &Other) const
Return a new range representing the possible values resulting from a logical right shift of a value i...
KnownBits toKnownBits() const
Return known bits for values in this range.
ConstantRange castOp(Instruction::CastOps CastOp, uint32_t BitWidth) const
Return a new range representing the possible values resulting from an application of the specified ca...
ConstantRange umin(const ConstantRange &Other) const
Return a new range representing the possible values resulting from an unsigned minimum of a value in ...
APInt getUnsignedMin() const
Return the smallest unsigned value contained in the ConstantRange.
ConstantRange difference(const ConstantRange &CR) const
Subtract the specified range from this range (aka relative complement of the sets).
bool isFullSet() const
Return true if this set contains all of the elements possible for this data-type.
ConstantRange srem(const ConstantRange &Other) const
Return a new range representing the possible values resulting from a signed remainder operation of a ...
bool icmp(CmpInst::Predicate Pred, const ConstantRange &Other) const
Does the predicate Pred hold between ranges this and Other? NOTE: false does not mean that inverse pr...
ConstantRange sadd_sat(const ConstantRange &Other) const
Perform a signed saturating addition of two constant ranges.
ConstantRange ushl_sat(const ConstantRange &Other) const
Perform an unsigned saturating left shift of this constant range by a value in Other.
static ConstantRange intrinsic(Intrinsic::ID IntrinsicID, ArrayRef< ConstantRange > Ops)
Compute range of intrinsic result for the given operand ranges.
void dump() const
Allow printing from a debugger easily.
bool isEmptySet() const
Return true if this set contains no members.
ConstantRange smul_sat(const ConstantRange &Other) const
Perform a signed saturating multiplication of two constant ranges.
ConstantRange shl(const ConstantRange &Other) const
Return a new range representing the possible values resulting from a left shift of a value in this ra...
ConstantRange zeroExtend(uint32_t BitWidth) const
Return a new range in the specified integer type, which must be strictly larger than the current type...
bool isSignWrappedSet() const
Return true if this set wraps around the signed domain.
bool isSizeLargerThan(uint64_t MaxSize) const
Compare set size of this range with Value.
APInt getSignedMin() const
Return the smallest signed value contained in the ConstantRange.
ConstantRange abs(bool IntMinIsPoison=false) const
Calculate absolute value range.
static bool isIntrinsicSupported(Intrinsic::ID IntrinsicID)
Returns true if ConstantRange calculations are supported for intrinsic with IntrinsicID.
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...
bool isWrappedSet() const
Return true if this set wraps around the unsigned domain.
ConstantRange usub_sat(const ConstantRange &Other) const
Perform an unsigned saturating subtraction of two constant ranges.
ConstantRange uadd_sat(const ConstantRange &Other) const
Perform an unsigned saturating addition of two constant ranges.
ConstantRange overflowingBinaryOp(Instruction::BinaryOps BinOp, const ConstantRange &Other, unsigned NoWrapKind) const
Return a new range representing the possible values resulting from an application of the specified ov...
void print(raw_ostream &OS) const
Print out the bounds to a stream.
ConstantRange(uint32_t BitWidth, bool isFullSet)
Initialize a full or empty set for the specified bit width.
OverflowResult unsignedMulMayOverflow(const ConstantRange &Other) const
Return whether unsigned mul of the two ranges always/never overflows.
ConstantRange subWithNoWrap(const ConstantRange &Other, unsigned NoWrapKind, PreferredRangeType RangeType=Smallest) const
Return a new range representing the possible values resulting from an subtraction with wrap type NoWr...
bool isSingleElement() const
Return true if this set contains exactly one member.
ConstantRange ssub_sat(const ConstantRange &Other) const
Perform a signed saturating subtraction of two constant ranges.
bool isAllNonNegative() const
Return true if all values in this range are non-negative.
ConstantRange umax(const ConstantRange &Other) const
Return a new range representing the possible values resulting from an unsigned maximum of a value in ...
ConstantRange signExtend(uint32_t BitWidth) const
Return a new range in the specified integer type, which must be strictly larger than the current type...
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 c...
ConstantRange sdiv(const ConstantRange &Other) const
Return a new range representing the possible values resulting from a signed division of a value in th...
const APInt & getUpper() const
Return the upper value for this range.
bool isUpperWrapped() const
Return true if the exclusive upper bound wraps around the unsigned domain.
ConstantRange unionWith(const ConstantRange &CR, PreferredRangeType Type=Smallest) const
Return the range that results from the union of this range with another range.
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 a...
ConstantRange inverse() const
Return a new range that is the logical not of the current set.
std::optional< ConstantRange > exactIntersectWith(const ConstantRange &CR) const
Intersect the two ranges and return the result if it can be represented exactly, otherwise return std...
ConstantRange ashr(const ConstantRange &Other) const
Return a new range representing the possible values resulting from a arithmetic right shift of a valu...
ConstantRange binaryAnd(const ConstantRange &Other) const
Return a new range representing the possible values resulting from a binary-and of a value in this ra...
bool contains(const APInt &Val) const
Return true if the specified value is in the set.
static bool areInsensitiveToSignednessOfInvertedICmpPredicate(const ConstantRange &CR1, const ConstantRange &CR2)
Return true iff CR1 ult CR2 is equivalent to CR1 sge CR2.
OverflowResult signedAddMayOverflow(const ConstantRange &Other) const
Return whether signed add of the two ranges always/never overflows.
APInt getUnsignedMax() const
Return the largest unsigned value contained in the 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 NoWrapK...
ConstantRange intersectWith(const ConstantRange &CR, PreferredRangeType Type=Smallest) const
Return the range that results from the intersection of this range with another range.
APInt getSignedMax() const
Return the largest signed value contained in the ConstantRange.
OverflowResult
Represents whether an operation on the given constant range is known to always or never overflow.
@ NeverOverflows
Never overflows.
@ AlwaysOverflowsHigh
Always overflows in the direction of signed/unsigned max value.
@ AlwaysOverflowsLow
Always overflows in the direction of signed/unsigned min value.
@ MayOverflow
May or may not overflow.
static ConstantRange makeMaskNotEqualRange(const APInt &Mask, const APInt &C)
Initialize a range containing all values X that satisfy (X & Mask) != C.
static bool areInsensitiveToSignednessOfICmpPredicate(const ConstantRange &CR1, const ConstantRange &CR2)
Return true iff CR1 ult CR2 is equivalent to CR1 slt CR2.
ConstantRange cttz(bool ZeroIsPoison=false) const
Calculate cttz range.
static ConstantRange getNonEmpty(APInt Lower, APInt Upper)
Create non-empty constant range with the given bounds.
ConstantRange ctpop() const
Calculate ctpop range.
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)...
ConstantRange smin(const ConstantRange &Other) const
Return a new range representing the possible values resulting from a signed minimum of a value in thi...
ConstantRange udiv(const ConstantRange &Other) const
Return a new range representing the possible values resulting from an unsigned division of a value in...
unsigned getMinSignedBits() const
Compute the maximal number of bits needed to represent every value in this signed range.
uint32_t getBitWidth() const
Get the bit width of this ConstantRange.
ConstantRange binaryNot() const
Return a new range representing the possible values resulting from a binary-xor of a value in this ra...
ConstantRange smax(const ConstantRange &Other) const
Return a new range representing the possible values resulting from a signed maximum of a value in thi...
ConstantRange binaryOp(Instruction::BinaryOps BinOp, const ConstantRange &Other) const
Return a new range representing the possible values resulting from an application of the specified bi...
ConstantRange binaryOr(const ConstantRange &Other) const
Return a new range representing the possible values resulting from a binary-or of a value in this ran...
OverflowResult signedSubMayOverflow(const ConstantRange &Other) const
Return whether signed sub of the two ranges always/never overflows.
ConstantRange ctlz(bool ZeroIsPoison=false) const
Calculate ctlz range.
ConstantRange sub(const ConstantRange &Other) const
Return a new range representing the possible values resulting from a subtraction of a value in this r...
ConstantRange sextOrTrunc(uint32_t BitWidth) const
Make this range have the bit width given by BitWidth.
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.
bool isSizeStrictlySmallerThan(const ConstantRange &CR) const
Compare set size of this range with the range CR.
ConstantRange multiplyWithNoWrap(const ConstantRange &Other, unsigned NoWrapKind, PreferredRangeType RangeType=Smallest) const
Return a new range representing the possible values resulting from a multiplication with wrap type No...
Utility class for integer operators which may exhibit overflow - Add, Sub, Mul, and Shl.
The instances of the Type class are immutable: once they are created, they are never changed.
This class implements an extremely fast bulk output stream that can only output to a stream.
#define llvm_unreachable(msg)
Marks that the current location is not supposed to be reachable.
std::optional< unsigned > GetMostSignificantDifferentBit(const APInt &A, const APInt &B)
Compare two values, and if they are different, return the position of the most significant bit that i...
APInt RoundingUDiv(const APInt &A, const APInt &B, APInt::Rounding RM)
Return A unsign-divided by B, rounded by the given rounding mode.
APInt RoundingSDiv(const APInt &A, const APInt &B, APInt::Rounding RM)
Return A sign-divided by B, rounded by the given rounding mode.
const APInt & smin(const APInt &A, const APInt &B)
Determine the smaller of two APInts considered to be signed.
const APInt & smax(const APInt &A, const APInt &B)
Determine the larger of two APInts considered to be signed.
const APInt & umin(const APInt &A, const APInt &B)
Determine the smaller of two APInts considered to be unsigned.
const APInt & umax(const APInt &A, const APInt &B)
Determine the larger of two APInts considered to be unsigned.
@ C
The default llvm calling convention, compatible with C.
This is an optimization pass for GlobalISel generic memory operations.
GCNRegPressure max(const GCNRegPressure &P1, const GCNRegPressure &P2)
@ Low
Lower the current thread's priority such that it does not affect foreground tasks significantly.
ConstantRange getConstantRangeFromMetadata(const MDNode &RangeMD)
Parse out a conservative ConstantRange from !range metadata.
int countl_zero(T Val)
Count number of 0's from the most significant bit to the least stopping at the first 1.
raw_ostream & dbgs()
dbgs() - This returns a reference to a raw_ostream for debugging messages.
@ UMin
Unsigned integer min implemented in terms of select(cmp()).
@ SMax
Signed integer max implemented in terms of select(cmp()).
@ SMin
Signed integer min implemented in terms of select(cmp()).
@ UMax
Unsigned integer max implemented in terms of select(cmp()).
constexpr unsigned BitWidth
OutputIt move(R &&Range, OutputIt Out)
Provide wrappers to std::move which take ranges instead of having to pass begin/end explicitly.
Implement std::hash so that hash_code can be used in STL containers.
static KnownBits makeConstant(const APInt &C)
Create known bits from a known constant.
bool isNonNegative() const
Returns true if this value is known to be non-negative.
bool isUnknown() const
Returns true if we don't know any bits.
bool hasConflict() const
Returns true if there is conflicting information.
unsigned getBitWidth() const
Get the bit width of this value.
APInt getMaxValue() const
Return the maximal unsigned value possible given these KnownBits.
APInt getMinValue() const
Return the minimal unsigned value possible given these KnownBits.
bool isNegative() const
Returns true if this value is known to be negative.