blob: 7f68fd32ae18e992b3c4d68d64132d3d5dcdbe3f [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
Owen Anderson634bab12010-08-07 00:42:06 +000024#include "llvm/Constants.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"
Nick Lewyckybf8c7f02009-07-11 06:15:39 +000028#include "llvm/Instructions.h"
Chris Lattner2cdd21c2003-12-14 21:35:53 +000029using namespace llvm;
Brian Gaeked0fde302003-11-11 22:41:34 +000030
Chris Lattner645e00d2002-09-01 23:53:36 +000031/// Initialize a full (the default) or empty set for the specified type.
32///
Dan Gohman38b06442009-07-09 23:16:10 +000033ConstantRange::ConstantRange(uint32_t BitWidth, bool Full) {
Chris Lattner645e00d2002-09-01 23:53:36 +000034 if (Full)
Reid Spencer663e7112007-02-28 17:36:23 +000035 Lower = Upper = APInt::getMaxValue(BitWidth);
Chris Lattner645e00d2002-09-01 23:53:36 +000036 else
Reid Spencer663e7112007-02-28 17:36:23 +000037 Lower = Upper = APInt::getMinValue(BitWidth);
Chris Lattner645e00d2002-09-01 23:53:36 +000038}
39
Chris Lattnerfc33d302004-03-30 00:20:08 +000040/// Initialize a range to hold the single specified value.
41///
Nick Lewycky7f9ef4b2010-08-11 22:04:36 +000042ConstantRange::ConstantRange(const APInt &V) : Lower(V), Upper(V + 1) {}
Chris Lattner645e00d2002-09-01 23:53:36 +000043
Dan Gohman38b06442009-07-09 23:16:10 +000044ConstantRange::ConstantRange(const APInt &L, const APInt &U) :
45 Lower(L), Upper(U) {
46 assert(L.getBitWidth() == U.getBitWidth() &&
47 "ConstantRange with unequal bit widths");
Zhou Shengc125c002007-04-26 16:42:07 +000048 assert((L != U || (L.isMaxValue() || L.isMinValue())) &&
Reid Spencer663e7112007-02-28 17:36:23 +000049 "Lower == Upper, but they aren't min or max value!");
50}
51
Nick Lewyckybf8c7f02009-07-11 06:15:39 +000052ConstantRange ConstantRange::makeICmpRegion(unsigned Pred,
53 const ConstantRange &CR) {
Nick Lewyckyf2d7b7c2010-09-28 18:18:36 +000054 if (CR.isEmptySet())
55 return CR;
56
Nick Lewyckybf8c7f02009-07-11 06:15:39 +000057 uint32_t W = CR.getBitWidth();
58 switch (Pred) {
59 default: assert(!"Invalid ICmp predicate to makeICmpRegion()");
60 case ICmpInst::ICMP_EQ:
Nick Lewyckyf067a232009-07-11 17:04:01 +000061 return CR;
Nick Lewyckybf8c7f02009-07-11 06:15:39 +000062 case ICmpInst::ICMP_NE:
63 if (CR.isSingleElement())
64 return ConstantRange(CR.getUpper(), CR.getLower());
65 return ConstantRange(W);
Nick Lewyckyf2d7b7c2010-09-28 18:18:36 +000066 case ICmpInst::ICMP_ULT: {
67 APInt UMax(CR.getUnsignedMax());
68 if (UMax.isMinValue())
69 return ConstantRange(W, /* empty */ false);
70 return ConstantRange(APInt::getMinValue(W), UMax);
71 }
72 case ICmpInst::ICMP_SLT: {
73 APInt SMax(CR.getSignedMax());
74 if (SMax.isMinSignedValue())
75 return ConstantRange(W, /* empty */ false);
76 return ConstantRange(APInt::getSignedMinValue(W), SMax);
77 }
Nick Lewyckybf8c7f02009-07-11 06:15:39 +000078 case ICmpInst::ICMP_ULE: {
79 APInt UMax(CR.getUnsignedMax());
80 if (UMax.isMaxValue())
81 return ConstantRange(W);
82 return ConstantRange(APInt::getMinValue(W), UMax + 1);
83 }
84 case ICmpInst::ICMP_SLE: {
85 APInt SMax(CR.getSignedMax());
Nick Lewyckyf2d7b7c2010-09-28 18:18:36 +000086 if (SMax.isMaxSignedValue())
Nick Lewyckybf8c7f02009-07-11 06:15:39 +000087 return ConstantRange(W);
88 return ConstantRange(APInt::getSignedMinValue(W), SMax + 1);
89 }
Nick Lewyckyf2d7b7c2010-09-28 18:18:36 +000090 case ICmpInst::ICMP_UGT: {
91 APInt UMin(CR.getUnsignedMin());
92 if (UMin.isMaxValue())
93 return ConstantRange(W, /* empty */ false);
94 return ConstantRange(UMin + 1, APInt::getNullValue(W));
95 }
96 case ICmpInst::ICMP_SGT: {
97 APInt SMin(CR.getSignedMin());
98 if (SMin.isMaxSignedValue())
99 return ConstantRange(W, /* empty */ false);
100 return ConstantRange(SMin + 1, APInt::getSignedMinValue(W));
101 }
Nick Lewyckybf8c7f02009-07-11 06:15:39 +0000102 case ICmpInst::ICMP_UGE: {
103 APInt UMin(CR.getUnsignedMin());
104 if (UMin.isMinValue())
105 return ConstantRange(W);
106 return ConstantRange(UMin, APInt::getNullValue(W));
107 }
108 case ICmpInst::ICMP_SGE: {
109 APInt SMin(CR.getSignedMin());
110 if (SMin.isMinSignedValue())
111 return ConstantRange(W);
112 return ConstantRange(SMin, APInt::getSignedMinValue(W));
113 }
114 }
115}
116
Chris Lattner645e00d2002-09-01 23:53:36 +0000117/// isFullSet - Return true if this set contains all of the elements possible
118/// for this data-type
119bool ConstantRange::isFullSet() const {
Zhou Shengc125c002007-04-26 16:42:07 +0000120 return Lower == Upper && Lower.isMaxValue();
Chris Lattner645e00d2002-09-01 23:53:36 +0000121}
Misha Brukmanfd939082005-04-21 23:48:37 +0000122
Chris Lattner645e00d2002-09-01 23:53:36 +0000123/// isEmptySet - Return true if this set contains no members.
124///
125bool ConstantRange::isEmptySet() const {
Zhou Shengc125c002007-04-26 16:42:07 +0000126 return Lower == Upper && Lower.isMinValue();
Chris Lattner645e00d2002-09-01 23:53:36 +0000127}
128
129/// isWrappedSet - Return true if this set wraps around the top of the range,
130/// for example: [100, 8)
131///
Reid Spencera6e8a952007-03-01 07:54:15 +0000132bool ConstantRange::isWrappedSet() const {
Reid Spencer663e7112007-02-28 17:36:23 +0000133 return Lower.ugt(Upper);
Chris Lattner645e00d2002-09-01 23:53:36 +0000134}
135
Nick Lewycky32cda112010-09-06 23:52:49 +0000136/// isSignWrappedSet - Return true if this set wraps around the INT_MIN of
137/// its bitwidth, for example: i8 [120, 140).
138///
139bool ConstantRange::isSignWrappedSet() const {
140 return contains(APInt::getSignedMaxValue(getBitWidth())) &&
141 contains(APInt::getSignedMinValue(getBitWidth()));
142}
143
Chris Lattner645e00d2002-09-01 23:53:36 +0000144/// getSetSize - Return the number of elements in this set.
145///
Reid Spencer663e7112007-02-28 17:36:23 +0000146APInt ConstantRange::getSetSize() const {
147 if (isEmptySet())
Reid Spencerbb626a62007-02-28 22:02:48 +0000148 return APInt(getBitWidth(), 0);
149 if (getBitWidth() == 1) {
Chris Lattner645e00d2002-09-01 23:53:36 +0000150 if (Lower != Upper) // One of T or F in the set...
Reid Spencerbb626a62007-02-28 22:02:48 +0000151 return APInt(2, 1);
152 return APInt(2, 2); // Must be full set...
Chris Lattner645e00d2002-09-01 23:53:36 +0000153 }
Misha Brukmanfd939082005-04-21 23:48:37 +0000154
Chris Lattner645e00d2002-09-01 23:53:36 +0000155 // Simply subtract the bounds...
Reid Spencer663e7112007-02-28 17:36:23 +0000156 return Upper - Lower;
Chris Lattner645e00d2002-09-01 23:53:36 +0000157}
158
Nick Lewycky3400e6a2007-03-10 15:54:12 +0000159/// getUnsignedMax - Return the largest unsigned value contained in the
160/// ConstantRange.
161///
162APInt ConstantRange::getUnsignedMax() const {
163 if (isFullSet() || isWrappedSet())
164 return APInt::getMaxValue(getBitWidth());
165 else
166 return getUpper() - 1;
167}
168
169/// getUnsignedMin - Return the smallest unsigned value contained in the
170/// ConstantRange.
171///
172APInt ConstantRange::getUnsignedMin() const {
173 if (isFullSet() || (isWrappedSet() && getUpper() != 0))
174 return APInt::getMinValue(getBitWidth());
175 else
176 return getLower();
177}
178
179/// getSignedMax - Return the largest signed value contained in the
180/// ConstantRange.
181///
182APInt ConstantRange::getSignedMax() const {
Zhou Shengdaacf222007-04-13 05:57:32 +0000183 APInt SignedMax(APInt::getSignedMaxValue(getBitWidth()));
Nick Lewycky3400e6a2007-03-10 15:54:12 +0000184 if (!isWrappedSet()) {
Nick Lewyckyae5eb7a2007-06-09 04:20:33 +0000185 if (getLower().sle(getUpper() - 1))
Nick Lewycky3400e6a2007-03-10 15:54:12 +0000186 return getUpper() - 1;
187 else
188 return SignedMax;
189 } else {
Nick Lewycky780905e2009-07-13 04:50:21 +0000190 if (getLower().isNegative() == getUpper().isNegative())
191 return SignedMax;
192 else
Nick Lewycky3400e6a2007-03-10 15:54:12 +0000193 return getUpper() - 1;
Nick Lewycky3400e6a2007-03-10 15:54:12 +0000194 }
195}
196
197/// getSignedMin - Return the smallest signed value contained in the
198/// ConstantRange.
199///
200APInt ConstantRange::getSignedMin() const {
Zhou Shengdaacf222007-04-13 05:57:32 +0000201 APInt SignedMin(APInt::getSignedMinValue(getBitWidth()));
Nick Lewycky3400e6a2007-03-10 15:54:12 +0000202 if (!isWrappedSet()) {
Nick Lewyckyae5eb7a2007-06-09 04:20:33 +0000203 if (getLower().sle(getUpper() - 1))
Nick Lewycky3400e6a2007-03-10 15:54:12 +0000204 return getLower();
205 else
206 return SignedMin;
207 } else {
208 if ((getUpper() - 1).slt(getLower())) {
209 if (getUpper() != SignedMin)
210 return SignedMin;
211 else
212 return getLower();
213 } else {
214 return getLower();
215 }
216 }
217}
218
Chris Lattnerfc33d302004-03-30 00:20:08 +0000219/// contains - Return true if the specified value is in the set.
220///
Reid Spencera6e8a952007-03-01 07:54:15 +0000221bool ConstantRange::contains(const APInt &V) const {
222 if (Lower == Upper)
223 return isFullSet();
Chris Lattner645e00d2002-09-01 23:53:36 +0000224
Reid Spencera6e8a952007-03-01 07:54:15 +0000225 if (!isWrappedSet())
226 return Lower.ule(V) && V.ult(Upper);
Reid Spencer663e7112007-02-28 17:36:23 +0000227 else
228 return Lower.ule(V) || V.ult(Upper);
Chris Lattnerfc33d302004-03-30 00:20:08 +0000229}
230
Nick Lewyckybf8c7f02009-07-11 06:15:39 +0000231/// contains - Return true if the argument is a subset of this range.
Nick Lewycky7f9ef4b2010-08-11 22:04:36 +0000232/// Two equal sets contain each other. The empty set contained by all other
233/// sets.
Nick Lewyckybf8c7f02009-07-11 06:15:39 +0000234///
235bool ConstantRange::contains(const ConstantRange &Other) const {
Nick Lewycky7f9ef4b2010-08-11 22:04:36 +0000236 if (isFullSet() || Other.isEmptySet()) return true;
237 if (isEmptySet() || Other.isFullSet()) return false;
Nick Lewyckybf8c7f02009-07-11 06:15:39 +0000238
239 if (!isWrappedSet()) {
240 if (Other.isWrappedSet())
241 return false;
242
243 return Lower.ule(Other.getLower()) && Other.getUpper().ule(Upper);
244 }
245
246 if (!Other.isWrappedSet())
247 return Other.getUpper().ule(Upper) ||
248 Lower.ule(Other.getLower());
249
250 return Other.getUpper().ule(Upper) && Lower.ule(Other.getLower());
251}
252
Chris Lattnerfc33d302004-03-30 00:20:08 +0000253/// subtract - Subtract the specified constant from the endpoints of this
254/// constant range.
Reid Spencer581b0d42007-02-28 19:57:34 +0000255ConstantRange ConstantRange::subtract(const APInt &Val) const {
Reid Spencerbb626a62007-02-28 22:02:48 +0000256 assert(Val.getBitWidth() == getBitWidth() && "Wrong bit width");
Chris Lattnerfc33d302004-03-30 00:20:08 +0000257 // If the set is empty or full, don't modify the endpoints.
Reid Spencer663e7112007-02-28 17:36:23 +0000258 if (Lower == Upper)
259 return *this;
Reid Spencer663e7112007-02-28 17:36:23 +0000260 return ConstantRange(Lower - Val, Upper - Val);
Chris Lattnerfc33d302004-03-30 00:20:08 +0000261}
Chris Lattner645e00d2002-09-01 23:53:36 +0000262
Nick Lewycky3e051642007-02-11 00:58:49 +0000263/// intersectWith - Return the range that results from the intersection of this
Nick Lewycky3a4a8842009-07-18 06:34:42 +0000264/// range with another range. The resultant range is guaranteed to include all
265/// elements contained in both input ranges, and to have the smallest possible
266/// set size that does so. Because there may be two intersections with the
267/// same set size, A.intersectWith(B) might not be equal to B.intersectWith(A).
Reid Spencera6e8a952007-03-01 07:54:15 +0000268ConstantRange ConstantRange::intersectWith(const ConstantRange &CR) const {
Reid Spencerbb626a62007-02-28 22:02:48 +0000269 assert(getBitWidth() == CR.getBitWidth() &&
270 "ConstantRange types don't agree!");
Nick Lewycky377b1192007-07-14 02:51:34 +0000271
272 // Handle common cases.
273 if ( isEmptySet() || CR.isFullSet()) return *this;
274 if (CR.isEmptySet() || isFullSet()) return CR;
275
276 if (!isWrappedSet() && CR.isWrappedSet())
Nick Lewycky3a4a8842009-07-18 06:34:42 +0000277 return CR.intersectWith(*this);
Nick Lewycky377b1192007-07-14 02:51:34 +0000278
279 if (!isWrappedSet() && !CR.isWrappedSet()) {
280 if (Lower.ult(CR.Lower)) {
281 if (Upper.ule(CR.Lower))
282 return ConstantRange(getBitWidth(), false);
283
284 if (Upper.ult(CR.Upper))
285 return ConstantRange(CR.Lower, Upper);
286
287 return CR;
288 } else {
289 if (Upper.ult(CR.Upper))
290 return *this;
291
292 if (Lower.ult(CR.Upper))
293 return ConstantRange(Lower, CR.Upper);
294
295 return ConstantRange(getBitWidth(), false);
296 }
297 }
298
299 if (isWrappedSet() && !CR.isWrappedSet()) {
300 if (CR.Lower.ult(Upper)) {
301 if (CR.Upper.ult(Upper))
302 return CR;
303
304 if (CR.Upper.ult(Lower))
305 return ConstantRange(CR.Lower, Upper);
306
307 if (getSetSize().ult(CR.getSetSize()))
308 return *this;
309 else
310 return CR;
311 } else if (CR.Lower.ult(Lower)) {
312 if (CR.Upper.ule(Lower))
313 return ConstantRange(getBitWidth(), false);
314
315 return ConstantRange(Lower, CR.Upper);
316 }
317 return CR;
318 }
319
320 if (CR.Upper.ult(Upper)) {
321 if (CR.Lower.ult(Upper)) {
322 if (getSetSize().ult(CR.getSetSize()))
323 return *this;
324 else
325 return CR;
326 }
327
328 if (CR.Lower.ult(Lower))
329 return ConstantRange(Lower, CR.Upper);
330
331 return CR;
332 } else if (CR.Upper.ult(Lower)) {
333 if (CR.Lower.ult(Lower))
334 return *this;
335
336 return ConstantRange(CR.Lower, Upper);
337 }
338 if (getSetSize().ult(CR.getSetSize()))
339 return *this;
340 else
341 return CR;
342}
343
344
Nick Lewycky3e051642007-02-11 00:58:49 +0000345/// unionWith - Return the range that results from the union of this range with
Chris Lattner645e00d2002-09-01 23:53:36 +0000346/// another range. The resultant range is guaranteed to include the elements of
Nick Lewycky9babd0e2007-04-01 03:47:44 +0000347/// both sets, but may contain more. For example, [3, 9) union [12,15) is
348/// [3, 15), which includes 9, 10, and 11, which were not included in either
349/// set before.
Chris Lattner645e00d2002-09-01 23:53:36 +0000350///
Reid Spencera6e8a952007-03-01 07:54:15 +0000351ConstantRange ConstantRange::unionWith(const ConstantRange &CR) const {
Reid Spencerbb626a62007-02-28 22:02:48 +0000352 assert(getBitWidth() == CR.getBitWidth() &&
353 "ConstantRange types don't agree!");
Chris Lattner645e00d2002-09-01 23:53:36 +0000354
Nick Lewyckyc6a28fc2007-03-02 03:33:05 +0000355 if ( isFullSet() || CR.isEmptySet()) return *this;
356 if (CR.isFullSet() || isEmptySet()) return CR;
Chris Lattner645e00d2002-09-01 23:53:36 +0000357
Nick Lewycky9babd0e2007-04-01 03:47:44 +0000358 if (!isWrappedSet() && CR.isWrappedSet()) return CR.unionWith(*this);
359
Nick Lewycky9babd0e2007-04-01 03:47:44 +0000360 if (!isWrappedSet() && !CR.isWrappedSet()) {
Nick Lewycky7e7dc452009-07-19 03:44:35 +0000361 if (CR.Upper.ult(Lower) || Upper.ult(CR.Lower)) {
362 // If the two ranges are disjoint, find the smaller gap and bridge it.
363 APInt d1 = CR.Lower - Upper, d2 = Lower - CR.Upper;
364 if (d1.ult(d2))
365 return ConstantRange(Lower, CR.Upper);
366 else
367 return ConstantRange(CR.Lower, Upper);
368 }
369
370 APInt L = Lower, U = Upper;
Nick Lewycky9babd0e2007-04-01 03:47:44 +0000371 if (CR.Lower.ult(L))
372 L = CR.Lower;
Nick Lewycky7e7dc452009-07-19 03:44:35 +0000373 if ((CR.Upper - 1).ugt(U - 1))
Nick Lewycky9babd0e2007-04-01 03:47:44 +0000374 U = CR.Upper;
Nick Lewycky7e7dc452009-07-19 03:44:35 +0000375
376 if (L == 0 && U == 0)
377 return ConstantRange(getBitWidth());
378
379 return ConstantRange(L, U);
Nick Lewycky9babd0e2007-04-01 03:47:44 +0000380 }
381
Nick Lewycky7e7dc452009-07-19 03:44:35 +0000382 if (!CR.isWrappedSet()) {
383 // ------U L----- and ------U L----- : this
384 // L--U L--U : CR
385 if (CR.Upper.ule(Upper) || CR.Lower.uge(Lower))
Nick Lewycky9babd0e2007-04-01 03:47:44 +0000386 return *this;
Nick Lewycky9babd0e2007-04-01 03:47:44 +0000387
Nick Lewycky7e7dc452009-07-19 03:44:35 +0000388 // ------U L----- : this
389 // L---------U : CR
390 if (CR.Lower.ule(Upper) && Lower.ule(CR.Upper))
Nick Lewycky9babd0e2007-04-01 03:47:44 +0000391 return ConstantRange(getBitWidth());
Nick Lewycky9babd0e2007-04-01 03:47:44 +0000392
Nick Lewycky7e7dc452009-07-19 03:44:35 +0000393 // ----U L---- : this
394 // L---U : CR
395 // <d1> <d2>
396 if (Upper.ule(CR.Lower) && CR.Upper.ule(Lower)) {
Nick Lewycky9babd0e2007-04-01 03:47:44 +0000397 APInt d1 = CR.Lower - Upper, d2 = Lower - CR.Upper;
Nick Lewycky7e7dc452009-07-19 03:44:35 +0000398 if (d1.ult(d2))
399 return ConstantRange(Lower, CR.Upper);
400 else
401 return ConstantRange(CR.Lower, Upper);
Nick Lewycky9babd0e2007-04-01 03:47:44 +0000402 }
403
Nick Lewycky7e7dc452009-07-19 03:44:35 +0000404 // ----U L----- : this
405 // L----U : CR
406 if (Upper.ult(CR.Lower) && Lower.ult(CR.Upper))
407 return ConstantRange(CR.Lower, Upper);
Nick Lewycky9babd0e2007-04-01 03:47:44 +0000408
Nick Lewycky7e7dc452009-07-19 03:44:35 +0000409 // ------U L---- : this
410 // L-----U : CR
411 if (CR.Lower.ult(Upper) && CR.Upper.ult(Lower))
412 return ConstantRange(Lower, CR.Upper);
Nick Lewycky9babd0e2007-04-01 03:47:44 +0000413 }
414
Nick Lewycky7e7dc452009-07-19 03:44:35 +0000415 assert(isWrappedSet() && CR.isWrappedSet() &&
416 "ConstantRange::unionWith missed wrapped union unwrapped case");
Nick Lewycky9babd0e2007-04-01 03:47:44 +0000417
Nick Lewycky7e7dc452009-07-19 03:44:35 +0000418 // ------U L---- and ------U L---- : this
419 // -U L----------- and ------------U L : CR
420 if (CR.Lower.ule(Upper) || Lower.ule(CR.Upper))
421 return ConstantRange(getBitWidth());
Nick Lewycky9babd0e2007-04-01 03:47:44 +0000422
Nick Lewycky7e7dc452009-07-19 03:44:35 +0000423 APInt L = Lower, U = Upper;
424 if (CR.Upper.ugt(U))
425 U = CR.Upper;
426 if (CR.Lower.ult(L))
427 L = CR.Lower;
Nick Lewyckyc6a28fc2007-03-02 03:33:05 +0000428
429 return ConstantRange(L, U);
Chris Lattner645e00d2002-09-01 23:53:36 +0000430}
Chris Lattner96f9d722002-09-02 00:18:22 +0000431
Chris Lattnerfc33d302004-03-30 00:20:08 +0000432/// zeroExtend - Return a new range in the specified integer type, which must
433/// be strictly larger than the current type. The returned range will
Reid Spencere4d87aa2006-12-23 06:05:41 +0000434/// correspond to the possible range of values as if the source range had been
Chris Lattnerfc33d302004-03-30 00:20:08 +0000435/// zero extended.
Reid Spencerbb626a62007-02-28 22:02:48 +0000436ConstantRange ConstantRange::zeroExtend(uint32_t DstTySize) const {
Nick Lewycky32cda112010-09-06 23:52:49 +0000437 if (isEmptySet()) return ConstantRange(DstTySize, /*isFullSet=*/false);
438
Reid Spencerbb626a62007-02-28 22:02:48 +0000439 unsigned SrcTySize = getBitWidth();
Reid Spencer663e7112007-02-28 17:36:23 +0000440 assert(SrcTySize < DstTySize && "Not a value extension");
Nick Lewycky32cda112010-09-06 23:52:49 +0000441 if (isFullSet() || isWrappedSet())
442 // Change into [0, 1 << src bit width)
Reid Spencerdc5c1592007-02-28 18:57:32 +0000443 return ConstantRange(APInt(DstTySize,0), APInt(DstTySize,1).shl(SrcTySize));
Chris Lattnerfc33d302004-03-30 00:20:08 +0000444
Reid Spencer663e7112007-02-28 17:36:23 +0000445 APInt L = Lower; L.zext(DstTySize);
446 APInt U = Upper; U.zext(DstTySize);
447 return ConstantRange(L, U);
Chris Lattnerfc33d302004-03-30 00:20:08 +0000448}
449
Nick Lewyckye32157c2007-04-07 15:41:33 +0000450/// signExtend - Return a new range in the specified integer type, which must
451/// be strictly larger than the current type. The returned range will
452/// correspond to the possible range of values as if the source range had been
453/// sign extended.
454ConstantRange ConstantRange::signExtend(uint32_t DstTySize) const {
Nick Lewycky32cda112010-09-06 23:52:49 +0000455 if (isEmptySet()) return ConstantRange(DstTySize, /*isFullSet=*/false);
456
Nick Lewyckye32157c2007-04-07 15:41:33 +0000457 unsigned SrcTySize = getBitWidth();
458 assert(SrcTySize < DstTySize && "Not a value extension");
Nick Lewycky32cda112010-09-06 23:52:49 +0000459 if (isFullSet() || isSignWrappedSet()) {
Nick Lewyckye32157c2007-04-07 15:41:33 +0000460 return ConstantRange(APInt::getHighBitsSet(DstTySize,DstTySize-SrcTySize+1),
Nick Lewyckyff84de72009-07-13 04:17:23 +0000461 APInt::getLowBitsSet(DstTySize, SrcTySize-1) + 1);
Nick Lewyckye32157c2007-04-07 15:41:33 +0000462 }
463
464 APInt L = Lower; L.sext(DstTySize);
465 APInt U = Upper; U.sext(DstTySize);
466 return ConstantRange(L, U);
467}
468
Chris Lattnerfc33d302004-03-30 00:20:08 +0000469/// truncate - Return a new range in the specified integer type, which must be
470/// strictly smaller than the current type. The returned range will
Reid Spencere4d87aa2006-12-23 06:05:41 +0000471/// correspond to the possible range of values as if the source range had been
Chris Lattnerfc33d302004-03-30 00:20:08 +0000472/// truncated to the specified type.
Reid Spencerbb626a62007-02-28 22:02:48 +0000473ConstantRange ConstantRange::truncate(uint32_t DstTySize) const {
474 unsigned SrcTySize = getBitWidth();
Reid Spencer663e7112007-02-28 17:36:23 +0000475 assert(SrcTySize > DstTySize && "Not a value truncation");
Zhou Shengdaacf222007-04-13 05:57:32 +0000476 APInt Size(APInt::getLowBitsSet(SrcTySize, DstTySize));
Reid Spencer663e7112007-02-28 17:36:23 +0000477 if (isFullSet() || getSetSize().ugt(Size))
Nick Lewycky7f9ef4b2010-08-11 22:04:36 +0000478 return ConstantRange(DstTySize, /*isFullSet=*/true);
Chris Lattnerfc33d302004-03-30 00:20:08 +0000479
Reid Spencer663e7112007-02-28 17:36:23 +0000480 APInt L = Lower; L.trunc(DstTySize);
481 APInt U = Upper; U.trunc(DstTySize);
482 return ConstantRange(L, U);
Chris Lattnerfc33d302004-03-30 00:20:08 +0000483}
484
Nuno Lopes95a3be02009-11-09 15:36:28 +0000485/// zextOrTrunc - make this range have the bit width given by \p DstTySize. The
486/// value is zero extended, truncated, or left alone to make it that width.
487ConstantRange ConstantRange::zextOrTrunc(uint32_t DstTySize) const {
488 unsigned SrcTySize = getBitWidth();
489 if (SrcTySize > DstTySize)
490 return truncate(DstTySize);
491 else if (SrcTySize < DstTySize)
492 return zeroExtend(DstTySize);
493 else
494 return *this;
495}
496
497/// sextOrTrunc - make this range have the bit width given by \p DstTySize. The
498/// value is sign extended, truncated, or left alone to make it that width.
499ConstantRange ConstantRange::sextOrTrunc(uint32_t DstTySize) const {
500 unsigned SrcTySize = getBitWidth();
501 if (SrcTySize > DstTySize)
502 return truncate(DstTySize);
503 else if (SrcTySize < DstTySize)
504 return signExtend(DstTySize);
505 else
506 return *this;
507}
508
Dan Gohmana3755d82009-07-09 22:07:27 +0000509ConstantRange
510ConstantRange::add(const ConstantRange &Other) const {
511 if (isEmptySet() || Other.isEmptySet())
512 return ConstantRange(getBitWidth(), /*isFullSet=*/false);
Nick Lewyckycf9e07d2009-07-13 02:49:08 +0000513 if (isFullSet() || Other.isFullSet())
514 return ConstantRange(getBitWidth(), /*isFullSet=*/true);
Dan Gohmana3755d82009-07-09 22:07:27 +0000515
516 APInt Spread_X = getSetSize(), Spread_Y = Other.getSetSize();
517 APInt NewLower = getLower() + Other.getLower();
518 APInt NewUpper = getUpper() + Other.getUpper() - 1;
519 if (NewLower == NewUpper)
520 return ConstantRange(getBitWidth(), /*isFullSet=*/true);
521
522 ConstantRange X = ConstantRange(NewLower, NewUpper);
523 if (X.getSetSize().ult(Spread_X) || X.getSetSize().ult(Spread_Y))
524 // We've wrapped, therefore, full set.
525 return ConstantRange(getBitWidth(), /*isFullSet=*/true);
526
527 return X;
Chris Lattner96f9d722002-09-02 00:18:22 +0000528}
529
Dan Gohmana3755d82009-07-09 22:07:27 +0000530ConstantRange
Nick Lewycky7f9ef4b2010-08-11 22:04:36 +0000531ConstantRange::sub(const ConstantRange &Other) const {
532 if (isEmptySet() || Other.isEmptySet())
533 return ConstantRange(getBitWidth(), /*isFullSet=*/false);
534 if (isFullSet() || Other.isFullSet())
535 return ConstantRange(getBitWidth(), /*isFullSet=*/true);
536
537 APInt Spread_X = getSetSize(), Spread_Y = Other.getSetSize();
538 APInt NewLower = getLower() - Other.getLower();
539 APInt NewUpper = getUpper() - Other.getUpper() + 1;
540 if (NewLower == NewUpper)
541 return ConstantRange(getBitWidth(), /*isFullSet=*/true);
542
543 ConstantRange X = ConstantRange(NewLower, NewUpper);
544 if (X.getSetSize().ult(Spread_X) || X.getSetSize().ult(Spread_Y))
545 // We've wrapped, therefore, full set.
546 return ConstantRange(getBitWidth(), /*isFullSet=*/true);
547
548 return X;
549}
550
551ConstantRange
Dan Gohmana3755d82009-07-09 22:07:27 +0000552ConstantRange::multiply(const ConstantRange &Other) const {
Dan Gohman8dcc58e2010-01-26 15:56:18 +0000553 // TODO: If either operand is a single element and the multiply is known to
554 // be non-wrapping, round the result min and max value to the appropriate
555 // multiple of that element. If wrapping is possible, at least adjust the
556 // range according to the greatest power-of-two factor of the single element.
Dan Gohman153f1eb2010-01-26 04:13:15 +0000557
Nick Lewycky2ff893f2009-07-12 02:19:05 +0000558 if (isEmptySet() || Other.isEmptySet())
559 return ConstantRange(getBitWidth(), /*isFullSet=*/false);
560 if (isFullSet() || Other.isFullSet())
561 return ConstantRange(getBitWidth(), /*isFullSet=*/true);
562
Nick Lewyckyf1db1202009-07-13 03:27:41 +0000563 APInt this_min = getUnsignedMin().zext(getBitWidth() * 2);
564 APInt this_max = getUnsignedMax().zext(getBitWidth() * 2);
565 APInt Other_min = Other.getUnsignedMin().zext(getBitWidth() * 2);
566 APInt Other_max = Other.getUnsignedMax().zext(getBitWidth() * 2);
Nick Lewycky2ff893f2009-07-12 02:19:05 +0000567
Nick Lewyckyf1db1202009-07-13 03:27:41 +0000568 ConstantRange Result_zext = ConstantRange(this_min * Other_min,
569 this_max * Other_max + 1);
Nick Lewycky2ff893f2009-07-12 02:19:05 +0000570 return Result_zext.truncate(getBitWidth());
Dan Gohmana3755d82009-07-09 22:07:27 +0000571}
572
573ConstantRange
574ConstantRange::smax(const ConstantRange &Other) const {
Dan Gohman38b06442009-07-09 23:16:10 +0000575 // X smax Y is: range(smax(X_smin, Y_smin),
576 // smax(X_smax, Y_smax))
577 if (isEmptySet() || Other.isEmptySet())
578 return ConstantRange(getBitWidth(), /*isFullSet=*/false);
Dan Gohman38b06442009-07-09 23:16:10 +0000579 APInt NewL = APIntOps::smax(getSignedMin(), Other.getSignedMin());
580 APInt NewU = APIntOps::smax(getSignedMax(), Other.getSignedMax()) + 1;
581 if (NewU == NewL)
582 return ConstantRange(getBitWidth(), /*isFullSet=*/true);
583 return ConstantRange(NewL, NewU);
Dan Gohmana3755d82009-07-09 22:07:27 +0000584}
585
586ConstantRange
587ConstantRange::umax(const ConstantRange &Other) const {
588 // X umax Y is: range(umax(X_umin, Y_umin),
589 // umax(X_umax, Y_umax))
590 if (isEmptySet() || Other.isEmptySet())
591 return ConstantRange(getBitWidth(), /*isFullSet=*/false);
Dan Gohmana3755d82009-07-09 22:07:27 +0000592 APInt NewL = APIntOps::umax(getUnsignedMin(), Other.getUnsignedMin());
593 APInt NewU = APIntOps::umax(getUnsignedMax(), Other.getUnsignedMax()) + 1;
594 if (NewU == NewL)
595 return ConstantRange(getBitWidth(), /*isFullSet=*/true);
596 return ConstantRange(NewL, NewU);
597}
598
599ConstantRange
Nick Lewycky956daf02009-07-12 05:18:18 +0000600ConstantRange::udiv(const ConstantRange &RHS) const {
601 if (isEmptySet() || RHS.isEmptySet() || RHS.getUnsignedMax() == 0)
602 return ConstantRange(getBitWidth(), /*isFullSet=*/false);
603 if (RHS.isFullSet())
604 return ConstantRange(getBitWidth(), /*isFullSet=*/true);
605
606 APInt Lower = getUnsignedMin().udiv(RHS.getUnsignedMax());
607
608 APInt RHS_umin = RHS.getUnsignedMin();
609 if (RHS_umin == 0) {
610 // We want the lowest value in RHS excluding zero. Usually that would be 1
611 // except for a range in the form of [X, 1) in which case it would be X.
612 if (RHS.getUpper() == 1)
613 RHS_umin = RHS.getLower();
614 else
615 RHS_umin = APInt(getBitWidth(), 1);
616 }
617
618 APInt Upper = getUnsignedMax().udiv(RHS_umin) + 1;
619
620 // If the LHS is Full and the RHS is a wrapped interval containing 1 then
621 // this could occur.
622 if (Lower == Upper)
623 return ConstantRange(getBitWidth(), /*isFullSet=*/true);
624
625 return ConstantRange(Lower, Upper);
Dan Gohmana3755d82009-07-09 22:07:27 +0000626}
627
Nuno Lopes34e992d2009-11-12 14:53:53 +0000628ConstantRange
Nick Lewycky198381e2010-09-07 05:39:02 +0000629ConstantRange::binaryAnd(const ConstantRange &Other) const {
630 if (isEmptySet() || Other.isEmptySet())
631 return ConstantRange(getBitWidth(), /*isFullSet=*/false);
632
633 // TODO: replace this with something less conservative
634
635 APInt umin = APIntOps::umin(Other.getUnsignedMax(), getUnsignedMax());
636 if (umin.isAllOnesValue())
637 return ConstantRange(getBitWidth(), /*isFullSet=*/true);
638 return ConstantRange(APInt::getNullValue(getBitWidth()), umin + 1);
639}
640
641ConstantRange
642ConstantRange::binaryOr(const ConstantRange &Other) const {
643 if (isEmptySet() || Other.isEmptySet())
644 return ConstantRange(getBitWidth(), /*isFullSet=*/false);
645
646 // TODO: replace this with something less conservative
647
648 APInt umax = APIntOps::umax(getUnsignedMin(), Other.getUnsignedMin());
649 if (umax.isMinValue())
650 return ConstantRange(getBitWidth(), /*isFullSet=*/true);
651 return ConstantRange(umax, APInt::getNullValue(getBitWidth()));
652}
653
654ConstantRange
Nick Lewycky7f9ef4b2010-08-11 22:04:36 +0000655ConstantRange::shl(const ConstantRange &Other) const {
656 if (isEmptySet() || Other.isEmptySet())
657 return ConstantRange(getBitWidth(), /*isFullSet=*/false);
Nuno Lopes34e992d2009-11-12 14:53:53 +0000658
Nick Lewycky7f9ef4b2010-08-11 22:04:36 +0000659 APInt min = getUnsignedMin().shl(Other.getUnsignedMin());
660 APInt max = getUnsignedMax().shl(Other.getUnsignedMax());
Nuno Lopes34e992d2009-11-12 14:53:53 +0000661
662 // there's no overflow!
Nuno Lopes44591452009-11-12 15:10:33 +0000663 APInt Zeros(getBitWidth(), getUnsignedMax().countLeadingZeros());
Nick Lewycky7f9ef4b2010-08-11 22:04:36 +0000664 if (Zeros.ugt(Other.getUnsignedMax()))
665 return ConstantRange(min, max + 1);
Nuno Lopes34e992d2009-11-12 14:53:53 +0000666
667 // FIXME: implement the other tricky cases
Nick Lewycky7f9ef4b2010-08-11 22:04:36 +0000668 return ConstantRange(getBitWidth(), /*isFullSet=*/true);
Nuno Lopes34e992d2009-11-12 14:53:53 +0000669}
670
671ConstantRange
Nick Lewycky7f9ef4b2010-08-11 22:04:36 +0000672ConstantRange::lshr(const ConstantRange &Other) const {
673 if (isEmptySet() || Other.isEmptySet())
674 return ConstantRange(getBitWidth(), /*isFullSet=*/false);
Nuno Lopes34e992d2009-11-12 14:53:53 +0000675
Nick Lewycky7f9ef4b2010-08-11 22:04:36 +0000676 APInt max = getUnsignedMax().lshr(Other.getUnsignedMin());
677 APInt min = getUnsignedMin().lshr(Other.getUnsignedMax());
678 if (min == max + 1)
679 return ConstantRange(getBitWidth(), /*isFullSet=*/true);
680
681 return ConstantRange(min, max + 1);
Nuno Lopes34e992d2009-11-12 14:53:53 +0000682}
683
Owen Anderson9773e452010-08-07 05:47:46 +0000684ConstantRange ConstantRange::inverse() const {
685 if (isFullSet()) {
Nick Lewycky7f9ef4b2010-08-11 22:04:36 +0000686 return ConstantRange(getBitWidth(), /*isFullSet=*/false);
Owen Anderson9773e452010-08-07 05:47:46 +0000687 } else if (isEmptySet()) {
Nick Lewycky7f9ef4b2010-08-11 22:04:36 +0000688 return ConstantRange(getBitWidth(), /*isFullSet=*/true);
Owen Anderson9773e452010-08-07 05:47:46 +0000689 }
690 return ConstantRange(Upper, Lower);
691}
692
Dan Gohman38b06442009-07-09 23:16:10 +0000693/// print - Print out the bounds to a stream...
Chris Lattner96f9d722002-09-02 00:18:22 +0000694///
Dan Gohman38b06442009-07-09 23:16:10 +0000695void ConstantRange::print(raw_ostream &OS) const {
Dan Gohmandf6d5e02010-01-26 04:12:55 +0000696 if (isFullSet())
697 OS << "full-set";
698 else if (isEmptySet())
699 OS << "empty-set";
700 else
701 OS << "[" << Lower << "," << Upper << ")";
Dan Gohmana3755d82009-07-09 22:07:27 +0000702}
703
Dan Gohman38b06442009-07-09 23:16:10 +0000704/// dump - Allow printing from a debugger easily...
Dan Gohmana3755d82009-07-09 22:07:27 +0000705///
Dan Gohman38b06442009-07-09 23:16:10 +0000706void ConstantRange::dump() const {
David Greene7fd5fb42010-01-05 01:28:32 +0000707 print(dbgs());
Dan Gohmana3755d82009-07-09 22:07:27 +0000708}