blob: c29cb53fb9c5d738cc3c0c19324005fe3cb4ad8f [file] [log] [blame]
Chris Lattner645e00d2002-09-01 23:53:36 +00001//===-- ConstantRange.cpp - ConstantRange implementation ------------------===//
Misha Brukmanfd939082005-04-21 23:48:37 +00002//
John Criswellb576c942003-10-20 19:43:21 +00003// The LLVM Compiler Infrastructure
4//
Chris Lattner4ee451d2007-12-29 20:36:04 +00005// This file is distributed under the University of Illinois Open Source
6// License. See LICENSE.TXT for details.
Misha Brukmanfd939082005-04-21 23:48:37 +00007//
John Criswellb576c942003-10-20 19:43:21 +00008//===----------------------------------------------------------------------===//
Chris Lattner645e00d2002-09-01 23:53:36 +00009//
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):
16//
17// [F, F) = {} = Empty set
18// [T, F) = {T}
19// [F, T) = {F}
20// [T, T) = {F, T} = Full set
21//
22//===----------------------------------------------------------------------===//
23
Frits van Bommela09d5142011-07-27 15:20:06 +000024#include "llvm/InstrTypes.h"
Chris Lattner645e00d2002-09-01 23:53:36 +000025#include "llvm/Support/ConstantRange.h"
David Greene7fd5fb42010-01-05 01:28:32 +000026#include "llvm/Support/Debug.h"
Chris Lattner944fac72008-08-23 22:23:09 +000027#include "llvm/Support/raw_ostream.h"
Chris Lattner2cdd21c2003-12-14 21:35:53 +000028using namespace llvm;
Brian Gaeked0fde302003-11-11 22:41:34 +000029
Chris Lattner645e00d2002-09-01 23:53:36 +000030/// Initialize a full (the default) or empty set for the specified type.
31///
Dan Gohman38b06442009-07-09 23:16:10 +000032ConstantRange::ConstantRange(uint32_t BitWidth, bool Full) {
Chris Lattner645e00d2002-09-01 23:53:36 +000033 if (Full)
Reid Spencer663e7112007-02-28 17:36:23 +000034 Lower = Upper = APInt::getMaxValue(BitWidth);
Chris Lattner645e00d2002-09-01 23:53:36 +000035 else
Reid Spencer663e7112007-02-28 17:36:23 +000036 Lower = Upper = APInt::getMinValue(BitWidth);
Chris Lattner645e00d2002-09-01 23:53:36 +000037}
38
Chris Lattnerfc33d302004-03-30 00:20:08 +000039/// Initialize a range to hold the single specified value.
40///
Nick Lewycky7f9ef4b2010-08-11 22:04:36 +000041ConstantRange::ConstantRange(const APInt &V) : Lower(V), Upper(V + 1) {}
Chris Lattner645e00d2002-09-01 23:53:36 +000042
Dan Gohman38b06442009-07-09 23:16:10 +000043ConstantRange::ConstantRange(const APInt &L, const APInt &U) :
44 Lower(L), Upper(U) {
45 assert(L.getBitWidth() == U.getBitWidth() &&
46 "ConstantRange with unequal bit widths");
Zhou Shengc125c002007-04-26 16:42:07 +000047 assert((L != U || (L.isMaxValue() || L.isMinValue())) &&
Reid Spencer663e7112007-02-28 17:36:23 +000048 "Lower == Upper, but they aren't min or max value!");
49}
50
Nick Lewyckybf8c7f02009-07-11 06:15:39 +000051ConstantRange ConstantRange::makeICmpRegion(unsigned Pred,
52 const ConstantRange &CR) {
Nick Lewyckyf2d7b7c2010-09-28 18:18:36 +000053 if (CR.isEmptySet())
54 return CR;
55
Nick Lewyckybf8c7f02009-07-11 06:15:39 +000056 uint32_t W = CR.getBitWidth();
57 switch (Pred) {
Richard Trieu23946fc2011-09-21 03:09:09 +000058 default: assert(0 && "Invalid ICmp predicate to makeICmpRegion()");
Frits van Bommela09d5142011-07-27 15:20:06 +000059 case CmpInst::ICMP_EQ:
Nick Lewyckyf067a232009-07-11 17:04:01 +000060 return CR;
Frits van Bommela09d5142011-07-27 15:20:06 +000061 case CmpInst::ICMP_NE:
Nick Lewyckybf8c7f02009-07-11 06:15:39 +000062 if (CR.isSingleElement())
63 return ConstantRange(CR.getUpper(), CR.getLower());
64 return ConstantRange(W);
Frits van Bommela09d5142011-07-27 15:20:06 +000065 case CmpInst::ICMP_ULT: {
Nick Lewyckyf2d7b7c2010-09-28 18:18:36 +000066 APInt UMax(CR.getUnsignedMax());
67 if (UMax.isMinValue())
68 return ConstantRange(W, /* empty */ false);
69 return ConstantRange(APInt::getMinValue(W), UMax);
70 }
Frits van Bommela09d5142011-07-27 15:20:06 +000071 case CmpInst::ICMP_SLT: {
Nick Lewyckyf2d7b7c2010-09-28 18:18:36 +000072 APInt SMax(CR.getSignedMax());
73 if (SMax.isMinSignedValue())
74 return ConstantRange(W, /* empty */ false);
75 return ConstantRange(APInt::getSignedMinValue(W), SMax);
76 }
Frits van Bommela09d5142011-07-27 15:20:06 +000077 case CmpInst::ICMP_ULE: {
Nick Lewyckybf8c7f02009-07-11 06:15:39 +000078 APInt UMax(CR.getUnsignedMax());
79 if (UMax.isMaxValue())
80 return ConstantRange(W);
81 return ConstantRange(APInt::getMinValue(W), UMax + 1);
82 }
Frits van Bommela09d5142011-07-27 15:20:06 +000083 case CmpInst::ICMP_SLE: {
Nick Lewyckybf8c7f02009-07-11 06:15:39 +000084 APInt SMax(CR.getSignedMax());
Nick Lewyckyf2d7b7c2010-09-28 18:18:36 +000085 if (SMax.isMaxSignedValue())
Nick Lewyckybf8c7f02009-07-11 06:15:39 +000086 return ConstantRange(W);
87 return ConstantRange(APInt::getSignedMinValue(W), SMax + 1);
88 }
Frits van Bommela09d5142011-07-27 15:20:06 +000089 case CmpInst::ICMP_UGT: {
Nick Lewyckyf2d7b7c2010-09-28 18:18:36 +000090 APInt UMin(CR.getUnsignedMin());
91 if (UMin.isMaxValue())
92 return ConstantRange(W, /* empty */ false);
93 return ConstantRange(UMin + 1, APInt::getNullValue(W));
94 }
Frits van Bommela09d5142011-07-27 15:20:06 +000095 case CmpInst::ICMP_SGT: {
Nick Lewyckyf2d7b7c2010-09-28 18:18:36 +000096 APInt SMin(CR.getSignedMin());
97 if (SMin.isMaxSignedValue())
98 return ConstantRange(W, /* empty */ false);
99 return ConstantRange(SMin + 1, APInt::getSignedMinValue(W));
100 }
Frits van Bommela09d5142011-07-27 15:20:06 +0000101 case CmpInst::ICMP_UGE: {
Nick Lewyckybf8c7f02009-07-11 06:15:39 +0000102 APInt UMin(CR.getUnsignedMin());
103 if (UMin.isMinValue())
104 return ConstantRange(W);
105 return ConstantRange(UMin, APInt::getNullValue(W));
106 }
Frits van Bommela09d5142011-07-27 15:20:06 +0000107 case CmpInst::ICMP_SGE: {
Nick Lewyckybf8c7f02009-07-11 06:15:39 +0000108 APInt SMin(CR.getSignedMin());
109 if (SMin.isMinSignedValue())
110 return ConstantRange(W);
111 return ConstantRange(SMin, APInt::getSignedMinValue(W));
112 }
113 }
114}
115
Chris Lattner645e00d2002-09-01 23:53:36 +0000116/// isFullSet - Return true if this set contains all of the elements possible
117/// for this data-type
118bool ConstantRange::isFullSet() const {
Zhou Shengc125c002007-04-26 16:42:07 +0000119 return Lower == Upper && Lower.isMaxValue();
Chris Lattner645e00d2002-09-01 23:53:36 +0000120}
Misha Brukmanfd939082005-04-21 23:48:37 +0000121
Chris Lattner645e00d2002-09-01 23:53:36 +0000122/// isEmptySet - Return true if this set contains no members.
123///
124bool ConstantRange::isEmptySet() const {
Zhou Shengc125c002007-04-26 16:42:07 +0000125 return Lower == Upper && Lower.isMinValue();
Chris Lattner645e00d2002-09-01 23:53:36 +0000126}
127
128/// isWrappedSet - Return true if this set wraps around the top of the range,
129/// for example: [100, 8)
130///
Reid Spencera6e8a952007-03-01 07:54:15 +0000131bool ConstantRange::isWrappedSet() const {
Reid Spencer663e7112007-02-28 17:36:23 +0000132 return Lower.ugt(Upper);
Chris Lattner645e00d2002-09-01 23:53:36 +0000133}
134
Nick Lewycky32cda112010-09-06 23:52:49 +0000135/// isSignWrappedSet - Return true if this set wraps around the INT_MIN of
136/// its bitwidth, for example: i8 [120, 140).
137///
138bool ConstantRange::isSignWrappedSet() const {
139 return contains(APInt::getSignedMaxValue(getBitWidth())) &&
140 contains(APInt::getSignedMinValue(getBitWidth()));
141}
142
Chris Lattner645e00d2002-09-01 23:53:36 +0000143/// getSetSize - Return the number of elements in this set.
144///
Reid Spencer663e7112007-02-28 17:36:23 +0000145APInt ConstantRange::getSetSize() const {
146 if (isEmptySet())
Reid Spencerbb626a62007-02-28 22:02:48 +0000147 return APInt(getBitWidth(), 0);
148 if (getBitWidth() == 1) {
Chris Lattner645e00d2002-09-01 23:53:36 +0000149 if (Lower != Upper) // One of T or F in the set...
Reid Spencerbb626a62007-02-28 22:02:48 +0000150 return APInt(2, 1);
151 return APInt(2, 2); // Must be full set...
Chris Lattner645e00d2002-09-01 23:53:36 +0000152 }
Misha Brukmanfd939082005-04-21 23:48:37 +0000153
Chris Lattner645e00d2002-09-01 23:53:36 +0000154 // Simply subtract the bounds...
Reid Spencer663e7112007-02-28 17:36:23 +0000155 return Upper - Lower;
Chris Lattner645e00d2002-09-01 23:53:36 +0000156}
157
Nick Lewycky3400e6a2007-03-10 15:54:12 +0000158/// getUnsignedMax - Return the largest unsigned value contained in the
159/// ConstantRange.
160///
161APInt ConstantRange::getUnsignedMax() const {
162 if (isFullSet() || isWrappedSet())
163 return APInt::getMaxValue(getBitWidth());
164 else
165 return getUpper() - 1;
166}
167
168/// getUnsignedMin - Return the smallest unsigned value contained in the
169/// ConstantRange.
170///
171APInt ConstantRange::getUnsignedMin() const {
172 if (isFullSet() || (isWrappedSet() && getUpper() != 0))
173 return APInt::getMinValue(getBitWidth());
174 else
175 return getLower();
176}
177
178/// getSignedMax - Return the largest signed value contained in the
179/// ConstantRange.
180///
181APInt ConstantRange::getSignedMax() const {
Zhou Shengdaacf222007-04-13 05:57:32 +0000182 APInt SignedMax(APInt::getSignedMaxValue(getBitWidth()));
Nick Lewycky3400e6a2007-03-10 15:54:12 +0000183 if (!isWrappedSet()) {
Nick Lewyckyae5eb7a2007-06-09 04:20:33 +0000184 if (getLower().sle(getUpper() - 1))
Nick Lewycky3400e6a2007-03-10 15:54:12 +0000185 return getUpper() - 1;
186 else
187 return SignedMax;
188 } else {
Nick Lewycky780905e2009-07-13 04:50:21 +0000189 if (getLower().isNegative() == getUpper().isNegative())
190 return SignedMax;
191 else
Nick Lewycky3400e6a2007-03-10 15:54:12 +0000192 return getUpper() - 1;
Nick Lewycky3400e6a2007-03-10 15:54:12 +0000193 }
194}
195
196/// getSignedMin - Return the smallest signed value contained in the
197/// ConstantRange.
198///
199APInt ConstantRange::getSignedMin() const {
Zhou Shengdaacf222007-04-13 05:57:32 +0000200 APInt SignedMin(APInt::getSignedMinValue(getBitWidth()));
Nick Lewycky3400e6a2007-03-10 15:54:12 +0000201 if (!isWrappedSet()) {
Nick Lewyckyae5eb7a2007-06-09 04:20:33 +0000202 if (getLower().sle(getUpper() - 1))
Nick Lewycky3400e6a2007-03-10 15:54:12 +0000203 return getLower();
204 else
205 return SignedMin;
206 } else {
207 if ((getUpper() - 1).slt(getLower())) {
208 if (getUpper() != SignedMin)
209 return SignedMin;
210 else
211 return getLower();
212 } else {
213 return getLower();
214 }
215 }
216}
217
Chris Lattnerfc33d302004-03-30 00:20:08 +0000218/// contains - Return true if the specified value is in the set.
219///
Reid Spencera6e8a952007-03-01 07:54:15 +0000220bool ConstantRange::contains(const APInt &V) const {
221 if (Lower == Upper)
222 return isFullSet();
Chris Lattner645e00d2002-09-01 23:53:36 +0000223
Reid Spencera6e8a952007-03-01 07:54:15 +0000224 if (!isWrappedSet())
225 return Lower.ule(V) && V.ult(Upper);
Reid Spencer663e7112007-02-28 17:36:23 +0000226 else
227 return Lower.ule(V) || V.ult(Upper);
Chris Lattnerfc33d302004-03-30 00:20:08 +0000228}
229
Nick Lewyckybf8c7f02009-07-11 06:15:39 +0000230/// contains - Return true if the argument is a subset of this range.
Nick Lewycky7f9ef4b2010-08-11 22:04:36 +0000231/// Two equal sets contain each other. The empty set contained by all other
232/// sets.
Nick Lewyckybf8c7f02009-07-11 06:15:39 +0000233///
234bool ConstantRange::contains(const ConstantRange &Other) const {
Nick Lewycky7f9ef4b2010-08-11 22:04:36 +0000235 if (isFullSet() || Other.isEmptySet()) return true;
236 if (isEmptySet() || Other.isFullSet()) return false;
Nick Lewyckybf8c7f02009-07-11 06:15:39 +0000237
238 if (!isWrappedSet()) {
239 if (Other.isWrappedSet())
240 return false;
241
242 return Lower.ule(Other.getLower()) && Other.getUpper().ule(Upper);
243 }
244
245 if (!Other.isWrappedSet())
246 return Other.getUpper().ule(Upper) ||
247 Lower.ule(Other.getLower());
248
249 return Other.getUpper().ule(Upper) && Lower.ule(Other.getLower());
250}
251
Chris Lattnerfc33d302004-03-30 00:20:08 +0000252/// subtract - Subtract the specified constant from the endpoints of this
253/// constant range.
Reid Spencer581b0d42007-02-28 19:57:34 +0000254ConstantRange ConstantRange::subtract(const APInt &Val) const {
Reid Spencerbb626a62007-02-28 22:02:48 +0000255 assert(Val.getBitWidth() == getBitWidth() && "Wrong bit width");
Chris Lattnerfc33d302004-03-30 00:20:08 +0000256 // If the set is empty or full, don't modify the endpoints.
Reid Spencer663e7112007-02-28 17:36:23 +0000257 if (Lower == Upper)
258 return *this;
Reid Spencer663e7112007-02-28 17:36:23 +0000259 return ConstantRange(Lower - Val, Upper - Val);
Chris Lattnerfc33d302004-03-30 00:20:08 +0000260}
Chris Lattner645e00d2002-09-01 23:53:36 +0000261
Nick Lewycky3e051642007-02-11 00:58:49 +0000262/// intersectWith - Return the range that results from the intersection of this
Nick Lewycky3a4a8842009-07-18 06:34:42 +0000263/// range with another range. The resultant range is guaranteed to include all
264/// elements contained in both input ranges, and to have the smallest possible
265/// set size that does so. Because there may be two intersections with the
266/// same set size, A.intersectWith(B) might not be equal to B.intersectWith(A).
Reid Spencera6e8a952007-03-01 07:54:15 +0000267ConstantRange ConstantRange::intersectWith(const ConstantRange &CR) const {
Reid Spencerbb626a62007-02-28 22:02:48 +0000268 assert(getBitWidth() == CR.getBitWidth() &&
269 "ConstantRange types don't agree!");
Nick Lewycky377b1192007-07-14 02:51:34 +0000270
271 // Handle common cases.
272 if ( isEmptySet() || CR.isFullSet()) return *this;
273 if (CR.isEmptySet() || isFullSet()) return CR;
274
275 if (!isWrappedSet() && CR.isWrappedSet())
Nick Lewycky3a4a8842009-07-18 06:34:42 +0000276 return CR.intersectWith(*this);
Nick Lewycky377b1192007-07-14 02:51:34 +0000277
278 if (!isWrappedSet() && !CR.isWrappedSet()) {
279 if (Lower.ult(CR.Lower)) {
280 if (Upper.ule(CR.Lower))
281 return ConstantRange(getBitWidth(), false);
282
283 if (Upper.ult(CR.Upper))
284 return ConstantRange(CR.Lower, Upper);
285
286 return CR;
287 } else {
288 if (Upper.ult(CR.Upper))
289 return *this;
290
291 if (Lower.ult(CR.Upper))
292 return ConstantRange(Lower, CR.Upper);
293
294 return ConstantRange(getBitWidth(), false);
295 }
296 }
297
298 if (isWrappedSet() && !CR.isWrappedSet()) {
299 if (CR.Lower.ult(Upper)) {
300 if (CR.Upper.ult(Upper))
301 return CR;
302
303 if (CR.Upper.ult(Lower))
304 return ConstantRange(CR.Lower, Upper);
305
306 if (getSetSize().ult(CR.getSetSize()))
307 return *this;
308 else
309 return CR;
310 } else if (CR.Lower.ult(Lower)) {
311 if (CR.Upper.ule(Lower))
312 return ConstantRange(getBitWidth(), false);
313
314 return ConstantRange(Lower, CR.Upper);
315 }
316 return CR;
317 }
318
319 if (CR.Upper.ult(Upper)) {
320 if (CR.Lower.ult(Upper)) {
321 if (getSetSize().ult(CR.getSetSize()))
322 return *this;
323 else
324 return CR;
325 }
326
327 if (CR.Lower.ult(Lower))
328 return ConstantRange(Lower, CR.Upper);
329
330 return CR;
331 } else if (CR.Upper.ult(Lower)) {
332 if (CR.Lower.ult(Lower))
333 return *this;
334
335 return ConstantRange(CR.Lower, Upper);
336 }
337 if (getSetSize().ult(CR.getSetSize()))
338 return *this;
339 else
340 return CR;
341}
342
343
Nick Lewycky3e051642007-02-11 00:58:49 +0000344/// unionWith - Return the range that results from the union of this range with
Chris Lattner645e00d2002-09-01 23:53:36 +0000345/// another range. The resultant range is guaranteed to include the elements of
Nick Lewycky9babd0e2007-04-01 03:47:44 +0000346/// both sets, but may contain more. For example, [3, 9) union [12,15) is
347/// [3, 15), which includes 9, 10, and 11, which were not included in either
348/// set before.
Chris Lattner645e00d2002-09-01 23:53:36 +0000349///
Reid Spencera6e8a952007-03-01 07:54:15 +0000350ConstantRange ConstantRange::unionWith(const ConstantRange &CR) const {
Reid Spencerbb626a62007-02-28 22:02:48 +0000351 assert(getBitWidth() == CR.getBitWidth() &&
352 "ConstantRange types don't agree!");
Chris Lattner645e00d2002-09-01 23:53:36 +0000353
Nick Lewyckyc6a28fc2007-03-02 03:33:05 +0000354 if ( isFullSet() || CR.isEmptySet()) return *this;
355 if (CR.isFullSet() || isEmptySet()) return CR;
Chris Lattner645e00d2002-09-01 23:53:36 +0000356
Nick Lewycky9babd0e2007-04-01 03:47:44 +0000357 if (!isWrappedSet() && CR.isWrappedSet()) return CR.unionWith(*this);
358
Nick Lewycky9babd0e2007-04-01 03:47:44 +0000359 if (!isWrappedSet() && !CR.isWrappedSet()) {
Nick Lewycky7e7dc452009-07-19 03:44:35 +0000360 if (CR.Upper.ult(Lower) || Upper.ult(CR.Lower)) {
361 // If the two ranges are disjoint, find the smaller gap and bridge it.
362 APInt d1 = CR.Lower - Upper, d2 = Lower - CR.Upper;
363 if (d1.ult(d2))
364 return ConstantRange(Lower, CR.Upper);
365 else
366 return ConstantRange(CR.Lower, Upper);
367 }
368
369 APInt L = Lower, U = Upper;
Nick Lewycky9babd0e2007-04-01 03:47:44 +0000370 if (CR.Lower.ult(L))
371 L = CR.Lower;
Nick Lewycky7e7dc452009-07-19 03:44:35 +0000372 if ((CR.Upper - 1).ugt(U - 1))
Nick Lewycky9babd0e2007-04-01 03:47:44 +0000373 U = CR.Upper;
Nick Lewycky7e7dc452009-07-19 03:44:35 +0000374
375 if (L == 0 && U == 0)
376 return ConstantRange(getBitWidth());
377
378 return ConstantRange(L, U);
Nick Lewycky9babd0e2007-04-01 03:47:44 +0000379 }
380
Nick Lewycky7e7dc452009-07-19 03:44:35 +0000381 if (!CR.isWrappedSet()) {
382 // ------U L----- and ------U L----- : this
383 // L--U L--U : CR
384 if (CR.Upper.ule(Upper) || CR.Lower.uge(Lower))
Nick Lewycky9babd0e2007-04-01 03:47:44 +0000385 return *this;
Nick Lewycky9babd0e2007-04-01 03:47:44 +0000386
Nick Lewycky7e7dc452009-07-19 03:44:35 +0000387 // ------U L----- : this
388 // L---------U : CR
389 if (CR.Lower.ule(Upper) && Lower.ule(CR.Upper))
Nick Lewycky9babd0e2007-04-01 03:47:44 +0000390 return ConstantRange(getBitWidth());
Nick Lewycky9babd0e2007-04-01 03:47:44 +0000391
Nick Lewycky7e7dc452009-07-19 03:44:35 +0000392 // ----U L---- : this
393 // L---U : CR
394 // <d1> <d2>
395 if (Upper.ule(CR.Lower) && CR.Upper.ule(Lower)) {
Nick Lewycky9babd0e2007-04-01 03:47:44 +0000396 APInt d1 = CR.Lower - Upper, d2 = Lower - CR.Upper;
Nick Lewycky7e7dc452009-07-19 03:44:35 +0000397 if (d1.ult(d2))
398 return ConstantRange(Lower, CR.Upper);
399 else
400 return ConstantRange(CR.Lower, Upper);
Nick Lewycky9babd0e2007-04-01 03:47:44 +0000401 }
402
Nick Lewycky7e7dc452009-07-19 03:44:35 +0000403 // ----U L----- : this
404 // L----U : CR
405 if (Upper.ult(CR.Lower) && Lower.ult(CR.Upper))
406 return ConstantRange(CR.Lower, Upper);
Nick Lewycky9babd0e2007-04-01 03:47:44 +0000407
Nick Lewycky7e7dc452009-07-19 03:44:35 +0000408 // ------U L---- : this
409 // L-----U : CR
410 if (CR.Lower.ult(Upper) && CR.Upper.ult(Lower))
411 return ConstantRange(Lower, CR.Upper);
Nick Lewycky9babd0e2007-04-01 03:47:44 +0000412 }
413
Nick Lewycky7e7dc452009-07-19 03:44:35 +0000414 assert(isWrappedSet() && CR.isWrappedSet() &&
415 "ConstantRange::unionWith missed wrapped union unwrapped case");
Nick Lewycky9babd0e2007-04-01 03:47:44 +0000416
Nick Lewycky7e7dc452009-07-19 03:44:35 +0000417 // ------U L---- and ------U L---- : this
418 // -U L----------- and ------------U L : CR
419 if (CR.Lower.ule(Upper) || Lower.ule(CR.Upper))
420 return ConstantRange(getBitWidth());
Nick Lewycky9babd0e2007-04-01 03:47:44 +0000421
Nick Lewycky7e7dc452009-07-19 03:44:35 +0000422 APInt L = Lower, U = Upper;
423 if (CR.Upper.ugt(U))
424 U = CR.Upper;
425 if (CR.Lower.ult(L))
426 L = CR.Lower;
Nick Lewyckyc6a28fc2007-03-02 03:33:05 +0000427
428 return ConstantRange(L, U);
Chris Lattner645e00d2002-09-01 23:53:36 +0000429}
Chris Lattner96f9d722002-09-02 00:18:22 +0000430
Chris Lattnerfc33d302004-03-30 00:20:08 +0000431/// zeroExtend - Return a new range in the specified integer type, which must
432/// be strictly larger than the current type. The returned range will
Reid Spencere4d87aa2006-12-23 06:05:41 +0000433/// correspond to the possible range of values as if the source range had been
Chris Lattnerfc33d302004-03-30 00:20:08 +0000434/// zero extended.
Reid Spencerbb626a62007-02-28 22:02:48 +0000435ConstantRange ConstantRange::zeroExtend(uint32_t DstTySize) const {
Nick Lewycky32cda112010-09-06 23:52:49 +0000436 if (isEmptySet()) return ConstantRange(DstTySize, /*isFullSet=*/false);
437
Reid Spencerbb626a62007-02-28 22:02:48 +0000438 unsigned SrcTySize = getBitWidth();
Reid Spencer663e7112007-02-28 17:36:23 +0000439 assert(SrcTySize < DstTySize && "Not a value extension");
Nick Lewycky32cda112010-09-06 23:52:49 +0000440 if (isFullSet() || isWrappedSet())
441 // Change into [0, 1 << src bit width)
Reid Spencerdc5c1592007-02-28 18:57:32 +0000442 return ConstantRange(APInt(DstTySize,0), APInt(DstTySize,1).shl(SrcTySize));
Chris Lattnerfc33d302004-03-30 00:20:08 +0000443
Jay Foad40f8f622010-12-07 08:25:19 +0000444 return ConstantRange(Lower.zext(DstTySize), Upper.zext(DstTySize));
Chris Lattnerfc33d302004-03-30 00:20:08 +0000445}
446
Nick Lewyckye32157c2007-04-07 15:41:33 +0000447/// signExtend - Return a new range in the specified integer type, which must
448/// be strictly larger than the current type. The returned range will
449/// correspond to the possible range of values as if the source range had been
450/// sign extended.
451ConstantRange ConstantRange::signExtend(uint32_t DstTySize) const {
Nick Lewycky32cda112010-09-06 23:52:49 +0000452 if (isEmptySet()) return ConstantRange(DstTySize, /*isFullSet=*/false);
453
Nick Lewyckye32157c2007-04-07 15:41:33 +0000454 unsigned SrcTySize = getBitWidth();
455 assert(SrcTySize < DstTySize && "Not a value extension");
Nick Lewycky32cda112010-09-06 23:52:49 +0000456 if (isFullSet() || isSignWrappedSet()) {
Nick Lewyckye32157c2007-04-07 15:41:33 +0000457 return ConstantRange(APInt::getHighBitsSet(DstTySize,DstTySize-SrcTySize+1),
Nick Lewyckyff84de72009-07-13 04:17:23 +0000458 APInt::getLowBitsSet(DstTySize, SrcTySize-1) + 1);
Nick Lewyckye32157c2007-04-07 15:41:33 +0000459 }
460
Jay Foad40f8f622010-12-07 08:25:19 +0000461 return ConstantRange(Lower.sext(DstTySize), Upper.sext(DstTySize));
Nick Lewyckye32157c2007-04-07 15:41:33 +0000462}
463
Chris Lattnerfc33d302004-03-30 00:20:08 +0000464/// truncate - Return a new range in the specified integer type, which must be
465/// strictly smaller than the current type. The returned range will
Reid Spencere4d87aa2006-12-23 06:05:41 +0000466/// correspond to the possible range of values as if the source range had been
Chris Lattnerfc33d302004-03-30 00:20:08 +0000467/// truncated to the specified type.
Reid Spencerbb626a62007-02-28 22:02:48 +0000468ConstantRange ConstantRange::truncate(uint32_t DstTySize) const {
469 unsigned SrcTySize = getBitWidth();
Reid Spencer663e7112007-02-28 17:36:23 +0000470 assert(SrcTySize > DstTySize && "Not a value truncation");
Zhou Shengdaacf222007-04-13 05:57:32 +0000471 APInt Size(APInt::getLowBitsSet(SrcTySize, DstTySize));
Reid Spencer663e7112007-02-28 17:36:23 +0000472 if (isFullSet() || getSetSize().ugt(Size))
Nick Lewycky7f9ef4b2010-08-11 22:04:36 +0000473 return ConstantRange(DstTySize, /*isFullSet=*/true);
Chris Lattnerfc33d302004-03-30 00:20:08 +0000474
Jay Foad40f8f622010-12-07 08:25:19 +0000475 return ConstantRange(Lower.trunc(DstTySize), Upper.trunc(DstTySize));
Chris Lattnerfc33d302004-03-30 00:20:08 +0000476}
477
Nuno Lopes95a3be02009-11-09 15:36:28 +0000478/// zextOrTrunc - make this range have the bit width given by \p DstTySize. The
479/// value is zero extended, truncated, or left alone to make it that width.
480ConstantRange ConstantRange::zextOrTrunc(uint32_t DstTySize) const {
481 unsigned SrcTySize = getBitWidth();
482 if (SrcTySize > DstTySize)
483 return truncate(DstTySize);
484 else if (SrcTySize < DstTySize)
485 return zeroExtend(DstTySize);
486 else
487 return *this;
488}
489
490/// sextOrTrunc - make this range have the bit width given by \p DstTySize. The
491/// value is sign extended, truncated, or left alone to make it that width.
492ConstantRange ConstantRange::sextOrTrunc(uint32_t DstTySize) const {
493 unsigned SrcTySize = getBitWidth();
494 if (SrcTySize > DstTySize)
495 return truncate(DstTySize);
496 else if (SrcTySize < DstTySize)
497 return signExtend(DstTySize);
498 else
499 return *this;
500}
501
Dan Gohmana3755d82009-07-09 22:07:27 +0000502ConstantRange
503ConstantRange::add(const ConstantRange &Other) const {
504 if (isEmptySet() || Other.isEmptySet())
505 return ConstantRange(getBitWidth(), /*isFullSet=*/false);
Nick Lewyckycf9e07d2009-07-13 02:49:08 +0000506 if (isFullSet() || Other.isFullSet())
507 return ConstantRange(getBitWidth(), /*isFullSet=*/true);
Dan Gohmana3755d82009-07-09 22:07:27 +0000508
509 APInt Spread_X = getSetSize(), Spread_Y = Other.getSetSize();
510 APInt NewLower = getLower() + Other.getLower();
511 APInt NewUpper = getUpper() + Other.getUpper() - 1;
512 if (NewLower == NewUpper)
513 return ConstantRange(getBitWidth(), /*isFullSet=*/true);
514
515 ConstantRange X = ConstantRange(NewLower, NewUpper);
516 if (X.getSetSize().ult(Spread_X) || X.getSetSize().ult(Spread_Y))
517 // We've wrapped, therefore, full set.
518 return ConstantRange(getBitWidth(), /*isFullSet=*/true);
519
520 return X;
Chris Lattner96f9d722002-09-02 00:18:22 +0000521}
522
Dan Gohmana3755d82009-07-09 22:07:27 +0000523ConstantRange
Nick Lewycky7f9ef4b2010-08-11 22:04:36 +0000524ConstantRange::sub(const ConstantRange &Other) const {
525 if (isEmptySet() || Other.isEmptySet())
526 return ConstantRange(getBitWidth(), /*isFullSet=*/false);
527 if (isFullSet() || Other.isFullSet())
528 return ConstantRange(getBitWidth(), /*isFullSet=*/true);
529
530 APInt Spread_X = getSetSize(), Spread_Y = Other.getSetSize();
Nick Lewyckye6240e82011-06-22 21:13:46 +0000531 APInt NewLower = getLower() - Other.getUpper() + 1;
532 APInt NewUpper = getUpper() - Other.getLower();
Nick Lewycky7f9ef4b2010-08-11 22:04:36 +0000533 if (NewLower == NewUpper)
534 return ConstantRange(getBitWidth(), /*isFullSet=*/true);
535
536 ConstantRange X = ConstantRange(NewLower, NewUpper);
537 if (X.getSetSize().ult(Spread_X) || X.getSetSize().ult(Spread_Y))
538 // We've wrapped, therefore, full set.
539 return ConstantRange(getBitWidth(), /*isFullSet=*/true);
540
541 return X;
542}
543
544ConstantRange
Dan Gohmana3755d82009-07-09 22:07:27 +0000545ConstantRange::multiply(const ConstantRange &Other) const {
Dan Gohman8dcc58e2010-01-26 15:56:18 +0000546 // TODO: If either operand is a single element and the multiply is known to
547 // be non-wrapping, round the result min and max value to the appropriate
548 // multiple of that element. If wrapping is possible, at least adjust the
549 // range according to the greatest power-of-two factor of the single element.
Dan Gohman153f1eb2010-01-26 04:13:15 +0000550
Nick Lewycky2ff893f2009-07-12 02:19:05 +0000551 if (isEmptySet() || Other.isEmptySet())
552 return ConstantRange(getBitWidth(), /*isFullSet=*/false);
553 if (isFullSet() || Other.isFullSet())
554 return ConstantRange(getBitWidth(), /*isFullSet=*/true);
555
Nick Lewyckyf1db1202009-07-13 03:27:41 +0000556 APInt this_min = getUnsignedMin().zext(getBitWidth() * 2);
557 APInt this_max = getUnsignedMax().zext(getBitWidth() * 2);
558 APInt Other_min = Other.getUnsignedMin().zext(getBitWidth() * 2);
559 APInt Other_max = Other.getUnsignedMax().zext(getBitWidth() * 2);
Nick Lewycky2ff893f2009-07-12 02:19:05 +0000560
Nick Lewyckyf1db1202009-07-13 03:27:41 +0000561 ConstantRange Result_zext = ConstantRange(this_min * Other_min,
562 this_max * Other_max + 1);
Nick Lewycky2ff893f2009-07-12 02:19:05 +0000563 return Result_zext.truncate(getBitWidth());
Dan Gohmana3755d82009-07-09 22:07:27 +0000564}
565
566ConstantRange
567ConstantRange::smax(const ConstantRange &Other) const {
Dan Gohman38b06442009-07-09 23:16:10 +0000568 // X smax Y is: range(smax(X_smin, Y_smin),
569 // smax(X_smax, Y_smax))
570 if (isEmptySet() || Other.isEmptySet())
571 return ConstantRange(getBitWidth(), /*isFullSet=*/false);
Dan Gohman38b06442009-07-09 23:16:10 +0000572 APInt NewL = APIntOps::smax(getSignedMin(), Other.getSignedMin());
573 APInt NewU = APIntOps::smax(getSignedMax(), Other.getSignedMax()) + 1;
574 if (NewU == NewL)
575 return ConstantRange(getBitWidth(), /*isFullSet=*/true);
576 return ConstantRange(NewL, NewU);
Dan Gohmana3755d82009-07-09 22:07:27 +0000577}
578
579ConstantRange
580ConstantRange::umax(const ConstantRange &Other) const {
581 // X umax Y is: range(umax(X_umin, Y_umin),
582 // umax(X_umax, Y_umax))
583 if (isEmptySet() || Other.isEmptySet())
584 return ConstantRange(getBitWidth(), /*isFullSet=*/false);
Dan Gohmana3755d82009-07-09 22:07:27 +0000585 APInt NewL = APIntOps::umax(getUnsignedMin(), Other.getUnsignedMin());
586 APInt NewU = APIntOps::umax(getUnsignedMax(), Other.getUnsignedMax()) + 1;
587 if (NewU == NewL)
588 return ConstantRange(getBitWidth(), /*isFullSet=*/true);
589 return ConstantRange(NewL, NewU);
590}
591
592ConstantRange
Nick Lewycky956daf02009-07-12 05:18:18 +0000593ConstantRange::udiv(const ConstantRange &RHS) const {
594 if (isEmptySet() || RHS.isEmptySet() || RHS.getUnsignedMax() == 0)
595 return ConstantRange(getBitWidth(), /*isFullSet=*/false);
596 if (RHS.isFullSet())
597 return ConstantRange(getBitWidth(), /*isFullSet=*/true);
598
599 APInt Lower = getUnsignedMin().udiv(RHS.getUnsignedMax());
600
601 APInt RHS_umin = RHS.getUnsignedMin();
602 if (RHS_umin == 0) {
603 // We want the lowest value in RHS excluding zero. Usually that would be 1
604 // except for a range in the form of [X, 1) in which case it would be X.
605 if (RHS.getUpper() == 1)
606 RHS_umin = RHS.getLower();
607 else
608 RHS_umin = APInt(getBitWidth(), 1);
609 }
610
611 APInt Upper = getUnsignedMax().udiv(RHS_umin) + 1;
612
613 // If the LHS is Full and the RHS is a wrapped interval containing 1 then
614 // this could occur.
615 if (Lower == Upper)
616 return ConstantRange(getBitWidth(), /*isFullSet=*/true);
617
618 return ConstantRange(Lower, Upper);
Dan Gohmana3755d82009-07-09 22:07:27 +0000619}
620
Nuno Lopes34e992d2009-11-12 14:53:53 +0000621ConstantRange
Nick Lewycky198381e2010-09-07 05:39:02 +0000622ConstantRange::binaryAnd(const ConstantRange &Other) const {
623 if (isEmptySet() || Other.isEmptySet())
624 return ConstantRange(getBitWidth(), /*isFullSet=*/false);
625
626 // TODO: replace this with something less conservative
627
628 APInt umin = APIntOps::umin(Other.getUnsignedMax(), getUnsignedMax());
629 if (umin.isAllOnesValue())
630 return ConstantRange(getBitWidth(), /*isFullSet=*/true);
631 return ConstantRange(APInt::getNullValue(getBitWidth()), umin + 1);
632}
633
634ConstantRange
635ConstantRange::binaryOr(const ConstantRange &Other) const {
636 if (isEmptySet() || Other.isEmptySet())
637 return ConstantRange(getBitWidth(), /*isFullSet=*/false);
638
639 // TODO: replace this with something less conservative
640
641 APInt umax = APIntOps::umax(getUnsignedMin(), Other.getUnsignedMin());
642 if (umax.isMinValue())
643 return ConstantRange(getBitWidth(), /*isFullSet=*/true);
644 return ConstantRange(umax, APInt::getNullValue(getBitWidth()));
645}
646
647ConstantRange
Nick Lewycky7f9ef4b2010-08-11 22:04:36 +0000648ConstantRange::shl(const ConstantRange &Other) const {
649 if (isEmptySet() || Other.isEmptySet())
650 return ConstantRange(getBitWidth(), /*isFullSet=*/false);
Nuno Lopes34e992d2009-11-12 14:53:53 +0000651
Nick Lewycky7f9ef4b2010-08-11 22:04:36 +0000652 APInt min = getUnsignedMin().shl(Other.getUnsignedMin());
653 APInt max = getUnsignedMax().shl(Other.getUnsignedMax());
Nuno Lopes34e992d2009-11-12 14:53:53 +0000654
655 // there's no overflow!
Nuno Lopes44591452009-11-12 15:10:33 +0000656 APInt Zeros(getBitWidth(), getUnsignedMax().countLeadingZeros());
Nick Lewycky7f9ef4b2010-08-11 22:04:36 +0000657 if (Zeros.ugt(Other.getUnsignedMax()))
658 return ConstantRange(min, max + 1);
Nuno Lopes34e992d2009-11-12 14:53:53 +0000659
660 // FIXME: implement the other tricky cases
Nick Lewycky7f9ef4b2010-08-11 22:04:36 +0000661 return ConstantRange(getBitWidth(), /*isFullSet=*/true);
Nuno Lopes34e992d2009-11-12 14:53:53 +0000662}
663
664ConstantRange
Nick Lewycky7f9ef4b2010-08-11 22:04:36 +0000665ConstantRange::lshr(const ConstantRange &Other) const {
666 if (isEmptySet() || Other.isEmptySet())
667 return ConstantRange(getBitWidth(), /*isFullSet=*/false);
Nuno Lopes34e992d2009-11-12 14:53:53 +0000668
Nick Lewycky7f9ef4b2010-08-11 22:04:36 +0000669 APInt max = getUnsignedMax().lshr(Other.getUnsignedMin());
670 APInt min = getUnsignedMin().lshr(Other.getUnsignedMax());
671 if (min == max + 1)
672 return ConstantRange(getBitWidth(), /*isFullSet=*/true);
673
674 return ConstantRange(min, max + 1);
Nuno Lopes34e992d2009-11-12 14:53:53 +0000675}
676
Owen Anderson9773e452010-08-07 05:47:46 +0000677ConstantRange ConstantRange::inverse() const {
678 if (isFullSet()) {
Nick Lewycky7f9ef4b2010-08-11 22:04:36 +0000679 return ConstantRange(getBitWidth(), /*isFullSet=*/false);
Owen Anderson9773e452010-08-07 05:47:46 +0000680 } else if (isEmptySet()) {
Nick Lewycky7f9ef4b2010-08-11 22:04:36 +0000681 return ConstantRange(getBitWidth(), /*isFullSet=*/true);
Owen Anderson9773e452010-08-07 05:47:46 +0000682 }
683 return ConstantRange(Upper, Lower);
684}
685
Dan Gohman38b06442009-07-09 23:16:10 +0000686/// print - Print out the bounds to a stream...
Chris Lattner96f9d722002-09-02 00:18:22 +0000687///
Dan Gohman38b06442009-07-09 23:16:10 +0000688void ConstantRange::print(raw_ostream &OS) const {
Dan Gohmandf6d5e02010-01-26 04:12:55 +0000689 if (isFullSet())
690 OS << "full-set";
691 else if (isEmptySet())
692 OS << "empty-set";
693 else
694 OS << "[" << Lower << "," << Upper << ")";
Dan Gohmana3755d82009-07-09 22:07:27 +0000695}
696
Dan Gohman38b06442009-07-09 23:16:10 +0000697/// dump - Allow printing from a debugger easily...
Dan Gohmana3755d82009-07-09 22:07:27 +0000698///
Dan Gohman38b06442009-07-09 23:16:10 +0000699void ConstantRange::dump() const {
David Greene7fd5fb42010-01-05 01:28:32 +0000700 print(dbgs());
Dan Gohmana3755d82009-07-09 22:07:27 +0000701}