1 //===-- ConstantRange.cpp - ConstantRange implementation ------------------===//
3 // The LLVM Compiler Infrastructure
5 // This file was developed by the LLVM research group and is distributed under
6 // the University of Illinois Open Source License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // Represent a range of possible values that may occur when the program is run
11 // for an integral value. This keeps track of a lower and upper bound for the
12 // constant, which MAY wrap around the end of the numeric range. To do this, it
13 // keeps track of a [lower, upper) bound, which specifies an interval just like
14 // STL iterators. When used with boolean values, the following are important
15 // ranges (other integral ranges use min/max values for special range values):
17 // [F, F) = {} = Empty set
20 // [T, T) = {F, T} = Full set
22 //===----------------------------------------------------------------------===//
24 #include "llvm/Support/ConstantRange.h"
25 #include "llvm/Support/Streams.h"
29 /// Initialize a full (the default) or empty set for the specified type.
31 ConstantRange::ConstantRange(uint32_t BitWidth, bool Full) :
32 Lower(BitWidth, 0), Upper(BitWidth, 0) {
34 Lower = Upper = APInt::getMaxValue(BitWidth);
36 Lower = Upper = APInt::getMinValue(BitWidth);
39 /// Initialize a range to hold the single specified value.
41 ConstantRange::ConstantRange(const APInt & V) : Lower(V), Upper(V + 1) { }
43 ConstantRange::ConstantRange(const APInt &L, const APInt &U) :
45 assert(L.getBitWidth() == U.getBitWidth() &&
46 "ConstantRange with unequal bit widths");
47 assert((L != U || (L.isMaxValue() || L.isMinValue())) &&
48 "Lower == Upper, but they aren't min or max value!");
51 /// isFullSet - Return true if this set contains all of the elements possible
52 /// for this data-type
53 bool ConstantRange::isFullSet() const {
54 return Lower == Upper && Lower.isMaxValue();
57 /// isEmptySet - Return true if this set contains no members.
59 bool ConstantRange::isEmptySet() const {
60 return Lower == Upper && Lower.isMinValue();
63 /// isWrappedSet - Return true if this set wraps around the top of the range,
64 /// for example: [100, 8)
66 bool ConstantRange::isWrappedSet() const {
67 return Lower.ugt(Upper);
70 /// getSetSize - Return the number of elements in this set.
72 APInt ConstantRange::getSetSize() const {
74 return APInt(getBitWidth(), 0);
75 if (getBitWidth() == 1) {
76 if (Lower != Upper) // One of T or F in the set...
78 return APInt(2, 2); // Must be full set...
81 // Simply subtract the bounds...
85 /// getUnsignedMax - Return the largest unsigned value contained in the
88 APInt ConstantRange::getUnsignedMax() const {
89 if (isFullSet() || isWrappedSet())
90 return APInt::getMaxValue(getBitWidth());
92 return getUpper() - 1;
95 /// getUnsignedMin - Return the smallest unsigned value contained in the
98 APInt ConstantRange::getUnsignedMin() const {
99 if (isFullSet() || (isWrappedSet() && getUpper() != 0))
100 return APInt::getMinValue(getBitWidth());
105 /// getSignedMax - Return the largest signed value contained in the
108 APInt ConstantRange::getSignedMax() const {
109 APInt SignedMax(APInt::getSignedMaxValue(getBitWidth()));
110 if (!isWrappedSet()) {
111 if (getLower().sle(getUpper() - 1))
112 return getUpper() - 1;
116 if ((getUpper() - 1).slt(getLower())) {
117 if (getLower() != SignedMax)
120 return getUpper() - 1;
122 return getUpper() - 1;
127 /// getSignedMin - Return the smallest signed value contained in the
130 APInt ConstantRange::getSignedMin() const {
131 APInt SignedMin(APInt::getSignedMinValue(getBitWidth()));
132 if (!isWrappedSet()) {
133 if (getLower().sle(getUpper() - 1))
138 if ((getUpper() - 1).slt(getLower())) {
139 if (getUpper() != SignedMin)
149 /// contains - Return true if the specified value is in the set.
151 bool ConstantRange::contains(const APInt &V) const {
156 return Lower.ule(V) && V.ult(Upper);
158 return Lower.ule(V) || V.ult(Upper);
161 /// subtract - Subtract the specified constant from the endpoints of this
163 ConstantRange ConstantRange::subtract(const APInt &Val) const {
164 assert(Val.getBitWidth() == getBitWidth() && "Wrong bit width");
165 // If the set is empty or full, don't modify the endpoints.
168 return ConstantRange(Lower - Val, Upper - Val);
172 // intersect1Wrapped - This helper function is used to intersect two ranges when
173 // it is known that LHS is wrapped and RHS isn't.
176 ConstantRange::intersect1Wrapped(const ConstantRange &LHS,
177 const ConstantRange &RHS) {
178 assert(LHS.isWrappedSet() && !RHS.isWrappedSet());
180 // Check to see if we overlap on the Left side of RHS...
182 if (RHS.Lower.ult(LHS.Upper)) {
183 // We do overlap on the left side of RHS, see if we overlap on the right of
185 if (RHS.Upper.ugt(LHS.Lower)) {
186 // Ok, the result overlaps on both the left and right sides. See if the
187 // resultant interval will be smaller if we wrap or not...
189 if (LHS.getSetSize().ult(RHS.getSetSize()))
195 // No overlap on the right, just on the left.
196 return ConstantRange(RHS.Lower, LHS.Upper);
199 // We don't overlap on the left side of RHS, see if we overlap on the right
201 if (RHS.Upper.ugt(LHS.Lower)) {
203 return ConstantRange(LHS.Lower, RHS.Upper);
206 return ConstantRange(LHS.getBitWidth(), false);
211 /// intersectWith - Return the range that results from the intersection of this
212 /// range with another range.
214 ConstantRange ConstantRange::intersectWith(const ConstantRange &CR) const {
215 assert(getBitWidth() == CR.getBitWidth() &&
216 "ConstantRange types don't agree!");
217 // Handle common special cases
218 if (isEmptySet() || CR.isFullSet())
220 if (isFullSet() || CR.isEmptySet())
223 if (!isWrappedSet()) {
224 if (!CR.isWrappedSet()) {
225 using namespace APIntOps;
226 APInt L = umax(Lower, CR.Lower);
227 APInt U = umin(Upper, CR.Upper);
229 if (L.ult(U)) // If range isn't empty...
230 return ConstantRange(L, U);
232 return ConstantRange(getBitWidth(), false);// Otherwise, empty set
234 return intersect1Wrapped(CR, *this);
235 } else { // We know "this" is wrapped...
236 if (!CR.isWrappedSet())
237 return intersect1Wrapped(*this, CR);
239 // Both ranges are wrapped...
240 using namespace APIntOps;
241 APInt L = umax(Lower, CR.Lower);
242 APInt U = umin(Upper, CR.Upper);
243 return ConstantRange(L, U);
249 /// maximalIntersectWith - Return the range that results from the intersection
250 /// of this range with another range. The resultant range is guaranteed to
251 /// include all elements contained in both input ranges, and is also guaranteed
252 /// to be the smallest possible set that does so.
253 ConstantRange ConstantRange::maximalIntersectWith(const ConstantRange &CR) const {
254 assert(getBitWidth() == CR.getBitWidth() &&
255 "ConstantRange types don't agree!");
257 // Handle common cases.
258 if ( isEmptySet() || CR.isFullSet()) return *this;
259 if (CR.isEmptySet() || isFullSet()) return CR;
261 if (!isWrappedSet() && CR.isWrappedSet())
262 return CR.maximalIntersectWith(*this);
264 if (!isWrappedSet() && !CR.isWrappedSet()) {
265 if (Lower.ult(CR.Lower)) {
266 if (Upper.ule(CR.Lower))
267 return ConstantRange(getBitWidth(), false);
269 if (Upper.ult(CR.Upper))
270 return ConstantRange(CR.Lower, Upper);
274 if (Upper.ult(CR.Upper))
277 if (Lower.ult(CR.Upper))
278 return ConstantRange(Lower, CR.Upper);
280 return ConstantRange(getBitWidth(), false);
284 if (isWrappedSet() && !CR.isWrappedSet()) {
285 if (CR.Lower.ult(Upper)) {
286 if (CR.Upper.ult(Upper))
289 if (CR.Upper.ult(Lower))
290 return ConstantRange(CR.Lower, Upper);
292 if (getSetSize().ult(CR.getSetSize()))
296 } else if (CR.Lower.ult(Lower)) {
297 if (CR.Upper.ule(Lower))
298 return ConstantRange(getBitWidth(), false);
300 return ConstantRange(Lower, CR.Upper);
305 if (CR.Upper.ult(Upper)) {
306 if (CR.Lower.ult(Upper)) {
307 if (getSetSize().ult(CR.getSetSize()))
313 if (CR.Lower.ult(Lower))
314 return ConstantRange(Lower, CR.Upper);
317 } else if (CR.Upper.ult(Lower)) {
318 if (CR.Lower.ult(Lower))
321 return ConstantRange(CR.Lower, Upper);
323 if (getSetSize().ult(CR.getSetSize()))
330 /// unionWith - Return the range that results from the union of this range with
331 /// another range. The resultant range is guaranteed to include the elements of
332 /// both sets, but may contain more. For example, [3, 9) union [12,15) is
333 /// [3, 15), which includes 9, 10, and 11, which were not included in either
336 ConstantRange ConstantRange::unionWith(const ConstantRange &CR) const {
337 assert(getBitWidth() == CR.getBitWidth() &&
338 "ConstantRange types don't agree!");
340 if ( isFullSet() || CR.isEmptySet()) return *this;
341 if (CR.isFullSet() || isEmptySet()) return CR;
343 if (!isWrappedSet() && CR.isWrappedSet()) return CR.unionWith(*this);
345 APInt L = Lower, U = Upper;
347 if (!isWrappedSet() && !CR.isWrappedSet()) {
355 if (isWrappedSet() && !CR.isWrappedSet()) {
356 if ((CR.Lower.ult(Upper) && CR.Upper.ult(Upper)) ||
357 (CR.Lower.ugt(Lower) && CR.Upper.ugt(Lower))) {
361 if (CR.Lower.ule(Upper) && Lower.ule(CR.Upper)) {
362 return ConstantRange(getBitWidth());
365 if (CR.Lower.ule(Upper) && CR.Upper.ule(Lower)) {
366 APInt d1 = CR.Upper - Upper, d2 = Lower - CR.Upper;
374 if (Upper.ult(CR.Lower) && CR.Upper.ult(Lower)) {
375 APInt d1 = CR.Lower - Upper, d2 = Lower - CR.Upper;
383 if (Upper.ult(CR.Lower) && Lower.ult(CR.Upper)) {
384 APInt d1 = CR.Lower - Upper, d2 = Lower - CR.Lower;
394 if (isWrappedSet() && CR.isWrappedSet()) {
395 if (Lower.ult(CR.Upper) || CR.Lower.ult(Upper))
396 return ConstantRange(getBitWidth());
398 if (CR.Upper.ugt(U)) {
402 if (CR.Lower.ult(L)) {
406 if (L == U) return ConstantRange(getBitWidth());
409 return ConstantRange(L, U);
412 /// zeroExtend - Return a new range in the specified integer type, which must
413 /// be strictly larger than the current type. The returned range will
414 /// correspond to the possible range of values as if the source range had been
416 ConstantRange ConstantRange::zeroExtend(uint32_t DstTySize) const {
417 unsigned SrcTySize = getBitWidth();
418 assert(SrcTySize < DstTySize && "Not a value extension");
420 // Change a source full set into [0, 1 << 8*numbytes)
421 return ConstantRange(APInt(DstTySize,0), APInt(DstTySize,1).shl(SrcTySize));
423 APInt L = Lower; L.zext(DstTySize);
424 APInt U = Upper; U.zext(DstTySize);
425 return ConstantRange(L, U);
428 /// signExtend - Return a new range in the specified integer type, which must
429 /// be strictly larger than the current type. The returned range will
430 /// correspond to the possible range of values as if the source range had been
432 ConstantRange ConstantRange::signExtend(uint32_t DstTySize) const {
433 unsigned SrcTySize = getBitWidth();
434 assert(SrcTySize < DstTySize && "Not a value extension");
436 return ConstantRange(APInt::getHighBitsSet(DstTySize,DstTySize-SrcTySize+1),
437 APInt::getLowBitsSet(DstTySize, SrcTySize-1));
440 APInt L = Lower; L.sext(DstTySize);
441 APInt U = Upper; U.sext(DstTySize);
442 return ConstantRange(L, U);
445 /// truncate - Return a new range in the specified integer type, which must be
446 /// strictly smaller than the current type. The returned range will
447 /// correspond to the possible range of values as if the source range had been
448 /// truncated to the specified type.
449 ConstantRange ConstantRange::truncate(uint32_t DstTySize) const {
450 unsigned SrcTySize = getBitWidth();
451 assert(SrcTySize > DstTySize && "Not a value truncation");
452 APInt Size(APInt::getLowBitsSet(SrcTySize, DstTySize));
453 if (isFullSet() || getSetSize().ugt(Size))
454 return ConstantRange(DstTySize);
456 APInt L = Lower; L.trunc(DstTySize);
457 APInt U = Upper; U.trunc(DstTySize);
458 return ConstantRange(L, U);
461 /// print - Print out the bounds to a stream...
463 void ConstantRange::print(std::ostream &OS) const {
464 OS << "[" << Lower.toStringSigned(10) << ","
465 << Upper.toStringSigned(10) << " )";
468 /// dump - Allow printing from a debugger easily...
470 void ConstantRange::dump() const {