2002-09-01 23:53:39 +00:00
|
|
|
//===-- llvm/Support/ConstantRange.h - Represent a range --------*- C++ -*-===//
|
2005-04-21 20:48:15 +00:00
|
|
|
//
|
2003-10-20 20:19:47 +00:00
|
|
|
// 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.
|
2005-04-21 20:48:15 +00:00
|
|
|
//
|
2003-10-20 20:19:47 +00:00
|
|
|
//===----------------------------------------------------------------------===//
|
2002-09-01 23:53:39 +00:00
|
|
|
//
|
|
|
|
// Represent a range of possible values that may occur when the program is run
|
|
|
|
// for an integral value. This keeps track of a lower and upper bound for the
|
|
|
|
// 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
|
2006-12-23 06:05:41 +00:00
|
|
|
// ranges: :
|
2002-09-01 23:53:39 +00:00
|
|
|
//
|
|
|
|
// [F, F) = {} = Empty set
|
|
|
|
// [T, F) = {T}
|
|
|
|
// [F, T) = {F}
|
|
|
|
// [T, T) = {F, T} = Full set
|
|
|
|
//
|
2006-12-23 06:05:41 +00:00
|
|
|
// 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.
|
2002-09-01 23:53:39 +00:00
|
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
|
|
|
|
#ifndef LLVM_SUPPORT_CONSTANT_RANGE_H
|
|
|
|
#define LLVM_SUPPORT_CONSTANT_RANGE_H
|
|
|
|
|
2004-09-01 22:55:40 +00:00
|
|
|
#include "llvm/Support/DataTypes.h"
|
2006-11-28 22:21:29 +00:00
|
|
|
#include "llvm/Support/Streams.h"
|
2002-09-02 00:18:26 +00:00
|
|
|
#include <iosfwd>
|
2003-11-11 22:41:34 +00:00
|
|
|
|
|
|
|
namespace llvm {
|
2004-03-29 20:42:38 +00:00
|
|
|
class Constant;
|
2004-03-30 00:20:08 +00:00
|
|
|
class ConstantInt;
|
2002-09-01 23:53:39 +00:00
|
|
|
class Type;
|
|
|
|
|
|
|
|
class ConstantRange {
|
2007-01-11 12:24:14 +00:00
|
|
|
ConstantInt *Lower, *Upper;
|
2002-09-01 23:53:39 +00:00
|
|
|
public:
|
|
|
|
/// Initialize a full (the default) or empty set for the specified type.
|
|
|
|
///
|
|
|
|
ConstantRange(const Type *Ty, bool isFullSet = true);
|
2005-04-21 20:48:15 +00:00
|
|
|
|
2004-03-30 00:20:08 +00:00
|
|
|
/// Initialize a range to hold the single specified value.
|
|
|
|
///
|
|
|
|
ConstantRange(Constant *Value);
|
|
|
|
|
2002-09-01 23:53:39 +00:00
|
|
|
/// Initialize a range of values explicitly... this will assert out if
|
2004-03-29 20:42:38 +00:00
|
|
|
/// 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.
|
2002-09-01 23:53:39 +00:00
|
|
|
///
|
2004-03-29 20:42:38 +00:00
|
|
|
ConstantRange(Constant *Lower, Constant *Upper);
|
2005-04-21 20:48:15 +00:00
|
|
|
|
2006-12-23 06:05:41 +00:00
|
|
|
/// 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.
|
2007-01-11 12:24:14 +00:00
|
|
|
ConstantRange(unsigned short predicate, ConstantInt *C);
|
2004-03-29 20:42:38 +00:00
|
|
|
|
2002-09-01 23:53:39 +00:00
|
|
|
/// getLower - Return the lower value for this range...
|
|
|
|
///
|
2007-01-11 12:24:14 +00:00
|
|
|
ConstantInt *getLower() const { return Lower; }
|
2002-09-01 23:53:39 +00:00
|
|
|
|
|
|
|
/// getUpper - Return the upper value for this range...
|
|
|
|
///
|
2007-01-11 12:24:14 +00:00
|
|
|
ConstantInt *getUpper() const { return Upper; }
|
2002-09-01 23:53:39 +00:00
|
|
|
|
|
|
|
/// getType - Return the LLVM data type of this range.
|
|
|
|
///
|
|
|
|
const Type *getType() const;
|
2005-04-21 20:48:15 +00:00
|
|
|
|
2002-09-01 23:53:39 +00:00
|
|
|
/// isFullSet - Return true if this set contains all of the elements possible
|
|
|
|
/// for this data-type
|
|
|
|
///
|
|
|
|
bool isFullSet() const;
|
2005-04-21 20:48:15 +00:00
|
|
|
|
2002-09-01 23:53:39 +00:00
|
|
|
/// 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)
|
|
|
|
///
|
2006-12-23 06:05:41 +00:00
|
|
|
bool isWrappedSet(bool isSigned) const;
|
2004-03-30 00:20:08 +00:00
|
|
|
|
|
|
|
/// contains - Return true if the specified value is in the set.
|
2006-12-23 06:05:41 +00:00
|
|
|
/// The isSigned parameter indicates whether the comparisons should be
|
|
|
|
/// performed as if the values are signed or not.
|
2004-03-30 00:20:08 +00:00
|
|
|
///
|
2006-12-23 06:05:41 +00:00
|
|
|
bool contains(ConstantInt *Val, bool isSigned) const;
|
2005-04-21 20:48:15 +00:00
|
|
|
|
2002-09-01 23:53:39 +00:00
|
|
|
/// getSingleElement - If this set contains a single element, return it,
|
|
|
|
/// otherwise return null.
|
|
|
|
///
|
2007-01-11 12:24:14 +00:00
|
|
|
ConstantInt *getSingleElement() const;
|
2005-04-21 20:48:15 +00:00
|
|
|
|
2002-09-01 23:53:39 +00:00
|
|
|
/// isSingleElement - Return true if this set contains exactly one member.
|
|
|
|
///
|
|
|
|
bool isSingleElement() const { return getSingleElement() != 0; }
|
|
|
|
|
|
|
|
/// getSetSize - Return the number of elements in this set.
|
|
|
|
///
|
|
|
|
uint64_t getSetSize() const;
|
|
|
|
|
2002-09-03 01:05:31 +00:00
|
|
|
/// operator== - Return true if this range is equal to another range.
|
|
|
|
///
|
|
|
|
bool operator==(const ConstantRange &CR) const {
|
|
|
|
return Lower == CR.Lower && Upper == CR.Upper;
|
|
|
|
}
|
|
|
|
bool operator!=(const ConstantRange &CR) const {
|
|
|
|
return !operator==(CR);
|
|
|
|
}
|
|
|
|
|
2004-03-30 00:20:08 +00:00
|
|
|
/// subtract - Subtract the specified constant from the endpoints of this
|
|
|
|
/// constant range.
|
|
|
|
ConstantRange subtract(ConstantInt *CI) const;
|
|
|
|
|
2007-02-11 00:58:49 +00:00
|
|
|
/// intersectWith - Return the range that results from the intersection of
|
|
|
|
/// this range with another range. The resultant range is pruned as much as
|
2002-09-01 23:53:39 +00:00
|
|
|
/// 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)
|
|
|
|
///
|
2006-12-23 06:05:41 +00:00
|
|
|
ConstantRange intersectWith(const ConstantRange &CR, bool isSigned) const;
|
2002-09-01 23:53:39 +00:00
|
|
|
|
2007-02-11 00:58:49 +00:00
|
|
|
/// unionWith - 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.
|
2002-09-01 23:53:39 +00:00
|
|
|
///
|
2006-12-23 06:05:41 +00:00
|
|
|
ConstantRange unionWith(const ConstantRange &CR, bool isSigned) const;
|
2002-09-02 00:18:26 +00:00
|
|
|
|
2004-03-30 00:20:08 +00:00
|
|
|
/// 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;
|
|
|
|
|
2002-09-02 00:18:26 +00:00
|
|
|
/// print - Print out the bounds to a stream...
|
|
|
|
///
|
|
|
|
void print(std::ostream &OS) const;
|
2006-12-17 05:15:13 +00:00
|
|
|
void print(std::ostream *OS) const { if (OS) print(*OS); }
|
2002-09-02 00:18:26 +00:00
|
|
|
|
|
|
|
/// dump - Allow printing from a debugger easily...
|
|
|
|
///
|
|
|
|
void dump() const;
|
2002-09-01 23:53:39 +00:00
|
|
|
};
|
|
|
|
|
2002-09-02 00:18:26 +00:00
|
|
|
inline std::ostream &operator<<(std::ostream &OS, const ConstantRange &CR) {
|
|
|
|
CR.print(OS);
|
|
|
|
return OS;
|
|
|
|
}
|
|
|
|
|
2003-11-11 22:41:34 +00:00
|
|
|
} // End llvm namespace
|
|
|
|
|
2002-09-01 23:53:39 +00:00
|
|
|
#endif
|