//===-- llvm/Support/ConstantRange.h - Represent a range --------*- C++ -*-===//
-//
+//
// 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
// constant, which MAY wrap around the end of the numeric range. To do this, it
// keeps track of a [lower, upper) bound, which specifies an interval just like
// STL iterators. When used with boolean values, the following are important
-// ranges (other integral ranges use min/max values for special range values):
+// ranges: :
//
// [F, F) = {} = Empty set
// [T, F) = {T}
// [F, T) = {F}
// [T, T) = {F, T} = Full set
//
+// The other integral ranges use min/max values for special range values. For
+// example, for 8-bit types, it uses:
+// [0, 0) = {} = Empty set
+// [255, 255) = {0..255} = Full Set
+//
+// Note that ConstantRange always keeps unsigned values.
//===----------------------------------------------------------------------===//
#ifndef LLVM_SUPPORT_CONSTANT_RANGE_H
#define LLVM_SUPPORT_CONSTANT_RANGE_H
-#include "Support/DataTypes.h"
+#include "llvm/Support/DataTypes.h"
+#include "llvm/Support/Streams.h"
#include <iosfwd>
namespace llvm {
class Constant;
class ConstantIntegral;
+class ConstantInt;
class Type;
class ConstantRange {
/// Initialize a full (the default) or empty set for the specified type.
///
ConstantRange(const Type *Ty, bool isFullSet = true);
-
+
+ /// Initialize a range to hold the single specified value.
+ ///
+ ConstantRange(Constant *Value);
+
/// Initialize a range of values explicitly... this will assert out if
/// Lower==Upper and Lower != Min or Max for its type, if the two constants
/// have different types, or if the constant are not integral values.
///
ConstantRange(Constant *Lower, Constant *Upper);
-
- /// Initialize a set of values that all satisfy the condition with C.
- ///
- ConstantRange(unsigned SetCCOpcode, ConstantIntegral *C);
+
+ /// Initialize a set of values that all satisfy the predicate with C. The
+ /// predicate should be either an ICmpInst::Predicate or FCmpInst::Predicate
+ /// value.
+ /// @brief Get a range for a relation with a constant integral.
+ ConstantRange(unsigned short predicate, ConstantIntegral *C);
/// getLower - Return the lower value for this range...
///
/// getType - Return the LLVM data type of this range.
///
const Type *getType() const;
-
+
/// isFullSet - Return true if this set contains all of the elements possible
/// for this data-type
///
bool isFullSet() const;
-
+
/// isEmptySet - Return true if this set contains no members.
///
bool isEmptySet() const;
/// isWrappedSet - Return true if this set wraps around the top of the range,
/// for example: [100, 8)
///
- bool isWrappedSet() const;
-
+ bool isWrappedSet(bool isSigned) const;
+
+ /// contains - Return true if the specified value is in the set.
+ /// The isSigned parameter indicates whether the comparisons should be
+ /// performed as if the values are signed or not.
+ ///
+ bool contains(ConstantInt *Val, bool isSigned) const;
+
/// getSingleElement - If this set contains a single element, return it,
/// otherwise return null.
///
ConstantIntegral *getSingleElement() const;
-
+
/// isSingleElement - Return true if this set contains exactly one member.
///
bool isSingleElement() const { return getSingleElement() != 0; }
return !operator==(CR);
}
+ /// subtract - Subtract the specified constant from the endpoints of this
+ /// constant range.
+ ConstantRange subtract(ConstantInt *CI) const;
+
/// intersect - Return the range that results from the intersection of this
/// range with another range. The resultant range is pruned as much as
/// possible, but there may be cases where elements are included that are in
/// one of the sets but not the other. For example: [100, 8) intersect [3,
/// 120) yields [3, 120)
///
- ConstantRange intersectWith(const ConstantRange &CR) const;
+ ConstantRange intersectWith(const ConstantRange &CR, bool isSigned) const;
/// union - Return the range that results from the union of this range with
/// another range. The resultant range is guaranteed to include the elements
/// [3, 15), which includes 9, 10, and 11, which were not included in either
/// set before.
///
- ConstantRange unionWith(const ConstantRange &CR) const;
+ ConstantRange unionWith(const ConstantRange &CR, bool isSigned) const;
+
+ /// 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 if the source range had been
+ /// zero extended.
+ ConstantRange zeroExtend(const Type *Ty) const;
+
+ /// 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 if the source range had been
+ /// truncated to the specified type.
+ ConstantRange truncate(const Type *Ty) const;
/// print - Print out the bounds to a stream...
///
void print(std::ostream &OS) const;
+ void print(std::ostream *OS) const { if (OS) print(*OS); }
/// dump - Allow printing from a debugger easily...
///
projects / oota-llvm.git / blobdiff