Implement review feedback for the ConstantBool->ConstantInt merge. Chris
[oota-llvm.git] / lib / Analysis / ConstantRange.cpp
index e180f12a1a045f2b7fa14fa731c90bc8d266e081..7a344201dd3e4125b612200494f55daae73eb2e2 100644 (file)
@@ -1,10 +1,10 @@
 //===-- ConstantRange.cpp - ConstantRange implementation ------------------===//
-// 
+//
 //                     The LLVM Compiler Infrastructure
 //
 // This file was developed by the LLVM research group and is distributed under
 // the University of Illinois Open Source License. See LICENSE.TXT for details.
-// 
+//
 //===----------------------------------------------------------------------===//
 //
 // Represent a range of possible values that may occur when the program is run
 //===----------------------------------------------------------------------===//
 
 #include "llvm/Support/ConstantRange.h"
-#include "llvm/Type.h"
+#include "llvm/Constants.h"
 #include "llvm/Instruction.h"
-#include "llvm/ConstantHandling.h"
+#include "llvm/Instructions.h"
+#include "llvm/Type.h"
+#include "llvm/Support/Streams.h"
+#include <ostream>
+using namespace llvm;
+
+static ConstantInt *getMaxValue(const Type *Ty, bool isSigned = false) {
+  if (Ty == Type::Int1Ty)
+    return ConstantInt::getTrue();
+  if (Ty->isInteger()) {
+    if (isSigned) {
+      // Calculate 011111111111111...
+      unsigned TypeBits = Ty->getPrimitiveSizeInBits();
+      int64_t Val = INT64_MAX;             // All ones
+      Val >>= 64-TypeBits;                 // Shift out unwanted 1 bits...
+      return ConstantInt::get(Ty, Val);
+    }
+    return ConstantInt::getAllOnesValue(Ty);
+  }
+  return 0;
+}
+
+// Static constructor to create the minimum constant for an integral type...
+static ConstantInt *getMinValue(const Type *Ty, bool isSigned = false) {
+  if (Ty == Type::Int1Ty)
+    return ConstantInt::getFalse();
+  if (Ty->isInteger()) {
+    if (isSigned) {
+      // Calculate 1111111111000000000000
+      unsigned TypeBits = Ty->getPrimitiveSizeInBits();
+      int64_t Val = -1;                    // All ones
+      Val <<= TypeBits-1;                  // Shift over to the right spot
+      return ConstantInt::get(Ty, Val);
+    }
+    return ConstantInt::get(Ty, 0);
+  }
+  return 0;
+}
+static ConstantInt *Next(ConstantInt *CI) {
+  if (CI->getType() == Type::Int1Ty)
+    return ConstantInt::get(Type::Int1Ty, !CI->getZExtValue());
 
-namespace llvm {
+  Constant *Result = ConstantExpr::getAdd(CI,
+                                          ConstantInt::get(CI->getType(), 1));
+  return cast<ConstantInt>(Result);
+}
+
+static bool LT(ConstantInt *A, ConstantInt *B, bool isSigned) {
+  Constant *C = ConstantExpr::getICmp(
+    (isSigned ? ICmpInst::ICMP_SLT : ICmpInst::ICMP_ULT), A, B);
+  assert(isa<ConstantInt>(C) && "Constant folding of integrals not impl??");
+  return cast<ConstantInt>(C)->getZExtValue();
+}
+
+static bool LTE(ConstantInt *A, ConstantInt *B, bool isSigned) {
+  Constant *C = ConstantExpr::getICmp(
+    (isSigned ? ICmpInst::ICMP_SLE : ICmpInst::ICMP_ULE), A, B);
+  assert(isa<ConstantInt>(C) && "Constant folding of integrals not impl??");
+  return cast<ConstantInt>(C)->getZExtValue();
+}
+
+static bool GT(ConstantInt *A, ConstantInt *B, bool isSigned) { 
+  return LT(B, A, isSigned); }
+
+static ConstantInt *Min(ConstantInt *A, ConstantInt *B, 
+                             bool isSigned) {
+  return LT(A, B, isSigned) ? A : B;
+}
+static ConstantInt *Max(ConstantInt *A, ConstantInt *B,
+                             bool isSigned) {
+  return GT(A, B, isSigned) ? A : B;
+}
 
 /// Initialize a full (the default) or empty set for the specified type.
 ///
@@ -34,58 +103,69 @@ ConstantRange::ConstantRange(const Type *Ty, bool Full) {
   assert(Ty->isIntegral() &&
          "Cannot make constant range of non-integral type!");
   if (Full)
-    Lower = Upper = ConstantIntegral::getMaxValue(Ty);
+    Lower = Upper = getMaxValue(Ty);
   else
-    Lower = Upper = ConstantIntegral::getMinValue(Ty);
+    Lower = Upper = getMinValue(Ty);
 }
 
+/// Initialize a range to hold the single specified value.
+///
+ConstantRange::ConstantRange(Constant *V) 
+  : Lower(cast<ConstantInt>(V)), Upper(Next(cast<ConstantInt>(V))) { }
+
 /// Initialize a range of values explicitly... this will assert out if
 /// Lower==Upper and Lower != Min or Max for its type (or if the two constants
 /// have different types)
 ///
-ConstantRange::ConstantRange(ConstantIntegral *L,
-                             ConstantIntegral *U) : Lower(L), Upper(U) {
+ConstantRange::ConstantRange(Constant *L, Constant *U) 
+  : Lower(cast<ConstantInt>(L)), Upper(cast<ConstantInt>(U)) {
   assert(Lower->getType() == Upper->getType() &&
          "Incompatible types for ConstantRange!");
-  
-  // Make sure that if L & U are equal that they are either Min or Max...
-  assert((L != U || (L == ConstantIntegral::getMaxValue(L->getType()) ||
-                     L == ConstantIntegral::getMinValue(L->getType()))) &&
-         "Lower == Upper, but they aren't min or max for type!");
-}
 
-static ConstantIntegral *Next(ConstantIntegral *CI) {
-  if (CI->getType() == Type::BoolTy)
-    return CI == ConstantBool::True ? ConstantBool::False : ConstantBool::True;
-      
-  // Otherwise use operator+ in the ConstantHandling Library.
-  Constant *Result = *ConstantInt::get(CI->getType(), 1) + *CI;
-  assert(Result && "ConstantHandling not implemented for integral plus!?");
-  return cast<ConstantIntegral>(Result);
+  // Make sure that if L & U are equal that they are either Min or Max...
+  assert((L != U || (L == getMaxValue(L->getType()) ||
+                     L == getMinValue(L->getType())))
+          && "Lower == Upper, but they aren't min or max for type!");
 }
 
 /// Initialize a set of values that all satisfy the condition with C.
 ///
-ConstantRange::ConstantRange(unsigned SetCCOpcode, ConstantIntegral *C) {
-  switch (SetCCOpcode) {
-  default: assert(0 && "Invalid SetCC opcode to ConstantRange ctor!");
-  case Instruction::SetEQ: Lower = C; Upper = Next(C); return;
-  case Instruction::SetNE: Upper = C; Lower = Next(C); return;
-  case Instruction::SetLT:
-    Lower = ConstantIntegral::getMinValue(C->getType());
+ConstantRange::ConstantRange(unsigned short ICmpOpcode, ConstantInt *C) {
+  switch (ICmpOpcode) {
+  default: assert(0 && "Invalid ICmp opcode to ConstantRange ctor!");
+  case ICmpInst::ICMP_EQ: Lower = C; Upper = Next(C); return;
+  case ICmpInst::ICMP_NE: Upper = C; Lower = Next(C); return;
+  case ICmpInst::ICMP_ULT:
+    Lower = getMinValue(C->getType());
     Upper = C;
     return;
-  case Instruction::SetGT:
+  case ICmpInst::ICMP_SLT:
+    Lower = getMinValue(C->getType(), true);
+    Upper = C;
+    return;
+  case ICmpInst::ICMP_UGT:
+    Lower = Next(C);
+    Upper = getMinValue(C->getType());        // Min = Next(Max)
+    return;
+  case ICmpInst::ICMP_SGT:
     Lower = Next(C);
-    Upper = ConstantIntegral::getMinValue(C->getType());  // Min = Next(Max)
+    Upper = getMinValue(C->getType(), true);  // Min = Next(Max)
     return;
-  case Instruction::SetLE:
-    Lower = ConstantIntegral::getMinValue(C->getType());
+  case ICmpInst::ICMP_ULE:
+    Lower = getMinValue(C->getType());
     Upper = Next(C);
     return;
-  case Instruction::SetGE:
+  case ICmpInst::ICMP_SLE:
+    Lower = getMinValue(C->getType(), true);
+    Upper = Next(C);
+    return;
+  case ICmpInst::ICMP_UGE:
+    Lower = C;
+    Upper = getMinValue(C->getType());        // Min = Next(Max)
+    return;
+  case ICmpInst::ICMP_SGE:
     Lower = C;
-    Upper = ConstantIntegral::getMinValue(C->getType());  // Min = Next(Max)
+    Upper = getMinValue(C->getType(), true);  // Min = Next(Max)
     return;
   }
 }
@@ -97,26 +177,25 @@ const Type *ConstantRange::getType() const { return Lower->getType(); }
 /// isFullSet - Return true if this set contains all of the elements possible
 /// for this data-type
 bool ConstantRange::isFullSet() const {
-  return Lower == Upper && Lower == ConstantIntegral::getMaxValue(getType());
+  return Lower == Upper && Lower == getMaxValue(getType());
 }
-  
+
 /// isEmptySet - Return true if this set contains no members.
 ///
 bool ConstantRange::isEmptySet() const {
-  return Lower == Upper && Lower == ConstantIntegral::getMinValue(getType());
+  return Lower == Upper && Lower == getMinValue(getType());
 }
 
 /// isWrappedSet - Return true if this set wraps around the top of the range,
 /// for example: [100, 8)
 ///
-bool ConstantRange::isWrappedSet() const {
-  return (*(Constant*)Lower > *(Constant*)Upper)->getValue();
+bool ConstantRange::isWrappedSet(bool isSigned) const {
+  return GT(Lower, Upper, isSigned);
 }
 
-  
 /// getSingleElement - If this set contains a single element, return it,
 /// otherwise return null.
-ConstantIntegral *ConstantRange::getSingleElement() const {
+ConstantInt *ConstantRange::getSingleElement() const {
   if (Upper == Next(Lower))  // Is it a single element range?
     return Lower;
   return 0;
@@ -126,34 +205,56 @@ ConstantIntegral *ConstantRange::getSingleElement() const {
 ///
 uint64_t ConstantRange::getSetSize() const {
   if (isEmptySet()) return 0;
-  if (getType() == Type::BoolTy) {
+  if (getType() == Type::Int1Ty) {
     if (Lower != Upper)  // One of T or F in the set...
       return 1;
     return 2;            // Must be full set...
   }
-  
+
   // Simply subtract the bounds...
-  Constant *Result = *(Constant*)Upper - *(Constant*)Lower;
-  assert(Result && "Subtraction of constant integers not implemented?");
-  return cast<ConstantInt>(Result)->getRawValue();
+  Constant *Result = ConstantExpr::getSub(Upper, Lower);
+  return cast<ConstantInt>(Result)->getZExtValue();
 }
 
+/// contains - Return true if the specified value is in the set.
+///
+bool ConstantRange::contains(ConstantInt *Val, bool isSigned) const {
+  if (Lower == Upper) {
+    if (isFullSet()) return true;
+    return false;
+  }
+
+  if (!isWrappedSet(isSigned))
+    return LTE(Lower, Val, isSigned) && LT(Val, Upper, isSigned);
+  return LTE(Lower, Val, isSigned) || LT(Val, Upper, isSigned);
+}
 
+/// subtract - Subtract the specified constant from the endpoints of this
+/// constant range.
+ConstantRange ConstantRange::subtract(ConstantInt *CI) const {
+  assert(CI->getType() == getType() && getType()->isInteger() &&
+         "Cannot subtract from different type range or non-integer!");
+  // If the set is empty or full, don't modify the endpoints.
+  if (Lower == Upper) return *this;
+  return ConstantRange(ConstantExpr::getSub(Lower, CI),
+                       ConstantExpr::getSub(Upper, CI));
+}
 
 
 // intersect1Wrapped - This helper function is used to intersect two ranges when
 // it is known that LHS is wrapped and RHS isn't.
 //
 static ConstantRange intersect1Wrapped(const ConstantRange &LHS,
-                                       const ConstantRange &RHS) {
-  assert(LHS.isWrappedSet() && !RHS.isWrappedSet());
+                                       const ConstantRange &RHS,
+                                       bool isSigned) {
+  assert(LHS.isWrappedSet(isSigned) && !RHS.isWrappedSet(isSigned));
 
   // Check to see if we overlap on the Left side of RHS...
   //
-  if ((*(Constant*)RHS.getLower() < *(Constant*)LHS.getUpper())->getValue()) {
+  if (LT(RHS.getLower(), LHS.getUpper(), isSigned)) {
     // We do overlap on the left side of RHS, see if we overlap on the right of
     // RHS...
-    if ((*(Constant*)RHS.getUpper() > *(Constant*)LHS.getLower())->getValue()) {
+    if (GT(RHS.getUpper(), LHS.getLower(), isSigned)) {
       // Ok, the result overlaps on both the left and right sides.  See if the
       // resultant interval will be smaller if we wrap or not...
       //
@@ -166,11 +267,10 @@ static ConstantRange intersect1Wrapped(const ConstantRange &LHS,
       // No overlap on the right, just on the left.
       return ConstantRange(RHS.getLower(), LHS.getUpper());
     }
-
   } else {
     // We don't overlap on the left side of RHS, see if we overlap on the right
     // of RHS...
-    if ((*(Constant*)RHS.getUpper() > *(Constant*)LHS.getLower())->getValue()) {
+    if (GT(RHS.getUpper(), LHS.getLower(), isSigned)) {
       // Simple overlap...
       return ConstantRange(LHS.getLower(), RHS.getUpper());
     } else {
@@ -180,45 +280,34 @@ static ConstantRange intersect1Wrapped(const ConstantRange &LHS,
   }
 }
 
-static ConstantIntegral *Min(ConstantIntegral *A, ConstantIntegral *B) {
-  if ((*(Constant*)A < *(Constant*)B)->getValue())
-    return A;
-  return B;
-}
-static ConstantIntegral *Max(ConstantIntegral *A, ConstantIntegral *B) {
-  if ((*(Constant*)A > *(Constant*)B)->getValue())
-    return A;
-  return B;
-}
-
-  
 /// intersect - Return the range that results from the intersection of this
 /// range with another range.
 ///
-ConstantRange ConstantRange::intersectWith(const ConstantRange &CR) const {
+ConstantRange ConstantRange::intersectWith(const ConstantRange &CR,
+                                           bool isSigned) const {
   assert(getType() == CR.getType() && "ConstantRange types don't agree!");
   // Handle common special cases
   if (isEmptySet() || CR.isFullSet())  return *this;
   if (isFullSet()  || CR.isEmptySet()) return CR;
 
-  if (!isWrappedSet()) {
-    if (!CR.isWrappedSet()) {
-      ConstantIntegral *L = Max(Lower, CR.Lower);
-      ConstantIntegral *U = Min(Upper, CR.Upper);
+  if (!isWrappedSet(isSigned)) {
+    if (!CR.isWrappedSet(isSigned)) {
+      ConstantInt *L = Max(Lower, CR.Lower, isSigned);
+      ConstantInt *U = Min(Upper, CR.Upper, isSigned);
 
-      if ((*L < *U)->getValue())  // If range isn't empty...
+      if (LT(L, U, isSigned))  // If range isn't empty...
         return ConstantRange(L, U);
       else
         return ConstantRange(getType(), false);  // Otherwise, return empty set
     } else
-      return intersect1Wrapped(CR, *this);
+      return intersect1Wrapped(CR, *this, isSigned);
   } else {   // We know "this" is wrapped...
-    if (!CR.isWrappedSet())
-      return intersect1Wrapped(*this, CR);
+    if (!CR.isWrappedSet(isSigned))
+      return intersect1Wrapped(*this, CR, isSigned);
     else {
       // Both ranges are wrapped...
-      ConstantIntegral *L = Max(Lower, CR.Lower);
-      ConstantIntegral *U = Min(Upper, CR.Upper);
+      ConstantInt *L = Max(Lower, CR.Lower, isSigned);
+      ConstantInt *U = Min(Upper, CR.Upper, isSigned);
       return ConstantRange(L, U);
     }
   }
@@ -231,7 +320,8 @@ ConstantRange ConstantRange::intersectWith(const ConstantRange &CR) const {
 /// 15), which includes 9, 10, and 11, which were not included in either set
 /// before.
 ///
-ConstantRange ConstantRange::unionWith(const ConstantRange &CR) const {
+ConstantRange ConstantRange::unionWith(const ConstantRange &CR,
+                                       bool isSigned) const {
   assert(getType() == CR.getType() && "ConstantRange types don't agree!");
 
   assert(0 && "Range union not implemented yet!");
@@ -239,16 +329,50 @@ ConstantRange ConstantRange::unionWith(const ConstantRange &CR) const {
   return *this;
 }
 
+/// zeroExtend - 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 as if the source range had been
+/// zero extended.
+ConstantRange ConstantRange::zeroExtend(const Type *Ty) const {
+  unsigned SrcTySize = getLower()->getType()->getPrimitiveSizeInBits();
+  assert(SrcTySize < Ty->getPrimitiveSizeInBits() && "Not a value extension");
+  if (isFullSet()) {
+    // Change a source full set into [0, 1 << 8*numbytes)
+    return ConstantRange(Constant::getNullValue(Ty),
+                         ConstantInt::get(Ty, 1ULL << SrcTySize));
+  }
+
+  Constant *Lower = getLower();
+  Constant *Upper = getUpper();
+
+  return ConstantRange(ConstantExpr::getZExt(Lower, Ty),
+                       ConstantExpr::getZExt(Upper, Ty));
+}
+
+/// truncate - 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 as if the source range had been
+/// truncated to the specified type.
+ConstantRange ConstantRange::truncate(const Type *Ty) const {
+  unsigned SrcTySize = getLower()->getType()->getPrimitiveSizeInBits();
+  assert(SrcTySize > Ty->getPrimitiveSizeInBits() && "Not a value truncation");
+  uint64_t Size = 1ULL << Ty->getPrimitiveSizeInBits();
+  if (isFullSet() || getSetSize() >= Size)
+    return ConstantRange(getType());
+
+  return ConstantRange(
+      ConstantExpr::getTrunc(getLower(), Ty),
+      ConstantExpr::getTrunc(getUpper(), Ty));
+}
+
 /// print - Print out the bounds to a stream...
 ///
 void ConstantRange::print(std::ostream &OS) const {
-  OS << "[" << Lower << "," << Upper << " )";
+  OS << "[" << *Lower << "," << *Upper << " )";
 }
 
 /// dump - Allow printing from a debugger easily...
 ///
 void ConstantRange::dump() const {
-  print(std::cerr);
+  print(cerr);
 }
-
-} // End llvm namespace