blob: 91d086b6890d08e21892ab3a5d5f721cacf55fe2 [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) {
Craig Topper85814382012-02-07 05:05:23 +000058 default: llvm_unreachable("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());
Nick Lewycky48a09ae2012-01-03 20:33:00 +0000164 return getUpper() - 1;
Nick Lewycky3400e6a2007-03-10 15:54:12 +0000165}
166
167/// getUnsignedMin - Return the smallest unsigned value contained in the
168/// ConstantRange.
169///
170APInt ConstantRange::getUnsignedMin() const {
171 if (isFullSet() || (isWrappedSet() && getUpper() != 0))
172 return APInt::getMinValue(getBitWidth());
Nick Lewycky48a09ae2012-01-03 20:33:00 +0000173 return getLower();
Nick Lewycky3400e6a2007-03-10 15:54:12 +0000174}
175
176/// getSignedMax - Return the largest signed value contained in the
177/// ConstantRange.
178///
179APInt ConstantRange::getSignedMax() const {
Zhou Shengdaacf222007-04-13 05:57:32 +0000180 APInt SignedMax(APInt::getSignedMaxValue(getBitWidth()));
Nick Lewycky3400e6a2007-03-10 15:54:12 +0000181 if (!isWrappedSet()) {
Nick Lewyckyae5eb7a2007-06-09 04:20:33 +0000182 if (getLower().sle(getUpper() - 1))
Nick Lewycky3400e6a2007-03-10 15:54:12 +0000183 return getUpper() - 1;
Nick Lewycky48a09ae2012-01-03 20:33:00 +0000184 return SignedMax;
Nick Lewycky3400e6a2007-03-10 15:54:12 +0000185 }
Nick Lewycky48a09ae2012-01-03 20:33:00 +0000186 if (getLower().isNegative() == getUpper().isNegative())
187 return SignedMax;
188 return getUpper() - 1;
Nick Lewycky3400e6a2007-03-10 15:54:12 +0000189}
190
191/// getSignedMin - Return the smallest signed value contained in the
192/// ConstantRange.
193///
194APInt ConstantRange::getSignedMin() const {
Zhou Shengdaacf222007-04-13 05:57:32 +0000195 APInt SignedMin(APInt::getSignedMinValue(getBitWidth()));
Nick Lewycky3400e6a2007-03-10 15:54:12 +0000196 if (!isWrappedSet()) {
Nick Lewyckyae5eb7a2007-06-09 04:20:33 +0000197 if (getLower().sle(getUpper() - 1))
Nick Lewycky3400e6a2007-03-10 15:54:12 +0000198 return getLower();
Nick Lewycky48a09ae2012-01-03 20:33:00 +0000199 return SignedMin;
Nick Lewycky3400e6a2007-03-10 15:54:12 +0000200 }
Nick Lewycky48a09ae2012-01-03 20:33:00 +0000201 if ((getUpper() - 1).slt(getLower())) {
202 if (getUpper() != SignedMin)
203 return SignedMin;
204 }
205 return getLower();
Nick Lewycky3400e6a2007-03-10 15:54:12 +0000206}
207
Chris Lattnerfc33d302004-03-30 00:20:08 +0000208/// contains - Return true if the specified value is in the set.
209///
Reid Spencera6e8a952007-03-01 07:54:15 +0000210bool ConstantRange::contains(const APInt &V) const {
211 if (Lower == Upper)
212 return isFullSet();
Chris Lattner645e00d2002-09-01 23:53:36 +0000213
Reid Spencera6e8a952007-03-01 07:54:15 +0000214 if (!isWrappedSet())
215 return Lower.ule(V) && V.ult(Upper);
Nick Lewycky48a09ae2012-01-03 20:33:00 +0000216 return Lower.ule(V) || V.ult(Upper);
Chris Lattnerfc33d302004-03-30 00:20:08 +0000217}
218
Nick Lewyckybf8c7f02009-07-11 06:15:39 +0000219/// contains - Return true if the argument is a subset of this range.
Nick Lewycky7f9ef4b2010-08-11 22:04:36 +0000220/// Two equal sets contain each other. The empty set contained by all other
221/// sets.
Nick Lewyckybf8c7f02009-07-11 06:15:39 +0000222///
223bool ConstantRange::contains(const ConstantRange &Other) const {
Nick Lewycky7f9ef4b2010-08-11 22:04:36 +0000224 if (isFullSet() || Other.isEmptySet()) return true;
225 if (isEmptySet() || Other.isFullSet()) return false;
Nick Lewyckybf8c7f02009-07-11 06:15:39 +0000226
227 if (!isWrappedSet()) {
228 if (Other.isWrappedSet())
229 return false;
230
231 return Lower.ule(Other.getLower()) && Other.getUpper().ule(Upper);
232 }
233
234 if (!Other.isWrappedSet())
235 return Other.getUpper().ule(Upper) ||
236 Lower.ule(Other.getLower());
237
238 return Other.getUpper().ule(Upper) && Lower.ule(Other.getLower());
239}
240
Chris Lattnerfc33d302004-03-30 00:20:08 +0000241/// subtract - Subtract the specified constant from the endpoints of this
242/// constant range.
Reid Spencer581b0d42007-02-28 19:57:34 +0000243ConstantRange ConstantRange::subtract(const APInt &Val) const {
Reid Spencerbb626a62007-02-28 22:02:48 +0000244 assert(Val.getBitWidth() == getBitWidth() && "Wrong bit width");
Chris Lattnerfc33d302004-03-30 00:20:08 +0000245 // If the set is empty or full, don't modify the endpoints.
Reid Spencer663e7112007-02-28 17:36:23 +0000246 if (Lower == Upper)
247 return *this;
Reid Spencer663e7112007-02-28 17:36:23 +0000248 return ConstantRange(Lower - Val, Upper - Val);
Chris Lattnerfc33d302004-03-30 00:20:08 +0000249}
Chris Lattner645e00d2002-09-01 23:53:36 +0000250
Nuno Lopes62d7afa2012-06-28 16:10:13 +0000251/// \brief Subtract the specified range from this range (aka relative complement
252/// of the sets).
253ConstantRange ConstantRange::difference(const ConstantRange &CR) const {
254 return intersectWith(CR.inverse());
255}
256
Nick Lewycky3e051642007-02-11 00:58:49 +0000257/// intersectWith - Return the range that results from the intersection of this
Nick Lewycky3a4a8842009-07-18 06:34:42 +0000258/// range with another range. The resultant range is guaranteed to include all
259/// elements contained in both input ranges, and to have the smallest possible
260/// set size that does so. Because there may be two intersections with the
261/// same set size, A.intersectWith(B) might not be equal to B.intersectWith(A).
Reid Spencera6e8a952007-03-01 07:54:15 +0000262ConstantRange ConstantRange::intersectWith(const ConstantRange &CR) const {
Reid Spencerbb626a62007-02-28 22:02:48 +0000263 assert(getBitWidth() == CR.getBitWidth() &&
264 "ConstantRange types don't agree!");
Nick Lewycky377b1192007-07-14 02:51:34 +0000265
266 // Handle common cases.
267 if ( isEmptySet() || CR.isFullSet()) return *this;
268 if (CR.isEmptySet() || isFullSet()) return CR;
269
270 if (!isWrappedSet() && CR.isWrappedSet())
Nick Lewycky3a4a8842009-07-18 06:34:42 +0000271 return CR.intersectWith(*this);
Nick Lewycky377b1192007-07-14 02:51:34 +0000272
273 if (!isWrappedSet() && !CR.isWrappedSet()) {
274 if (Lower.ult(CR.Lower)) {
275 if (Upper.ule(CR.Lower))
276 return ConstantRange(getBitWidth(), false);
277
278 if (Upper.ult(CR.Upper))
279 return ConstantRange(CR.Lower, Upper);
280
281 return CR;
Nick Lewycky377b1192007-07-14 02:51:34 +0000282 }
Nick Lewycky48a09ae2012-01-03 20:33:00 +0000283 if (Upper.ult(CR.Upper))
284 return *this;
285
286 if (Lower.ult(CR.Upper))
287 return ConstantRange(Lower, CR.Upper);
288
289 return ConstantRange(getBitWidth(), false);
Nick Lewycky377b1192007-07-14 02:51:34 +0000290 }
291
292 if (isWrappedSet() && !CR.isWrappedSet()) {
293 if (CR.Lower.ult(Upper)) {
294 if (CR.Upper.ult(Upper))
295 return CR;
296
Nuno Lopesfbb7a732012-05-18 00:14:36 +0000297 if (CR.Upper.ule(Lower))
Nick Lewycky377b1192007-07-14 02:51:34 +0000298 return ConstantRange(CR.Lower, Upper);
299
300 if (getSetSize().ult(CR.getSetSize()))
301 return *this;
Nick Lewycky48a09ae2012-01-03 20:33:00 +0000302 return CR;
303 }
304 if (CR.Lower.ult(Lower)) {
Nick Lewycky377b1192007-07-14 02:51:34 +0000305 if (CR.Upper.ule(Lower))
306 return ConstantRange(getBitWidth(), false);
307
308 return ConstantRange(Lower, CR.Upper);
309 }
310 return CR;
311 }
312
313 if (CR.Upper.ult(Upper)) {
314 if (CR.Lower.ult(Upper)) {
315 if (getSetSize().ult(CR.getSetSize()))
316 return *this;
Nick Lewycky48a09ae2012-01-03 20:33:00 +0000317 return CR;
Nick Lewycky377b1192007-07-14 02:51:34 +0000318 }
319
320 if (CR.Lower.ult(Lower))
321 return ConstantRange(Lower, CR.Upper);
322
323 return CR;
Nick Lewycky48a09ae2012-01-03 20:33:00 +0000324 }
Nuno Lopes532516a2012-06-28 00:59:33 +0000325 if (CR.Upper.ule(Lower)) {
Nick Lewycky377b1192007-07-14 02:51:34 +0000326 if (CR.Lower.ult(Lower))
327 return *this;
328
329 return ConstantRange(CR.Lower, Upper);
330 }
331 if (getSetSize().ult(CR.getSetSize()))
332 return *this;
Nick Lewycky48a09ae2012-01-03 20:33:00 +0000333 return CR;
Nick Lewycky377b1192007-07-14 02:51:34 +0000334}
335
336
Nick Lewycky3e051642007-02-11 00:58:49 +0000337/// unionWith - Return the range that results from the union of this range with
Chris Lattner645e00d2002-09-01 23:53:36 +0000338/// another range. The resultant range is guaranteed to include the elements of
Nick Lewycky9babd0e2007-04-01 03:47:44 +0000339/// both sets, but may contain more. For example, [3, 9) union [12,15) is
340/// [3, 15), which includes 9, 10, and 11, which were not included in either
341/// set before.
Chris Lattner645e00d2002-09-01 23:53:36 +0000342///
Reid Spencera6e8a952007-03-01 07:54:15 +0000343ConstantRange ConstantRange::unionWith(const ConstantRange &CR) const {
Reid Spencerbb626a62007-02-28 22:02:48 +0000344 assert(getBitWidth() == CR.getBitWidth() &&
345 "ConstantRange types don't agree!");
Chris Lattner645e00d2002-09-01 23:53:36 +0000346
Nick Lewyckyc6a28fc2007-03-02 03:33:05 +0000347 if ( isFullSet() || CR.isEmptySet()) return *this;
348 if (CR.isFullSet() || isEmptySet()) return CR;
Chris Lattner645e00d2002-09-01 23:53:36 +0000349
Nick Lewycky9babd0e2007-04-01 03:47:44 +0000350 if (!isWrappedSet() && CR.isWrappedSet()) return CR.unionWith(*this);
351
Nick Lewycky9babd0e2007-04-01 03:47:44 +0000352 if (!isWrappedSet() && !CR.isWrappedSet()) {
Nick Lewycky7e7dc452009-07-19 03:44:35 +0000353 if (CR.Upper.ult(Lower) || Upper.ult(CR.Lower)) {
354 // If the two ranges are disjoint, find the smaller gap and bridge it.
355 APInt d1 = CR.Lower - Upper, d2 = Lower - CR.Upper;
356 if (d1.ult(d2))
357 return ConstantRange(Lower, CR.Upper);
Nick Lewycky48a09ae2012-01-03 20:33:00 +0000358 return ConstantRange(CR.Lower, Upper);
Nick Lewycky7e7dc452009-07-19 03:44:35 +0000359 }
360
361 APInt L = Lower, U = Upper;
Nick Lewycky9babd0e2007-04-01 03:47:44 +0000362 if (CR.Lower.ult(L))
363 L = CR.Lower;
Nick Lewycky7e7dc452009-07-19 03:44:35 +0000364 if ((CR.Upper - 1).ugt(U - 1))
Nick Lewycky9babd0e2007-04-01 03:47:44 +0000365 U = CR.Upper;
Nick Lewycky7e7dc452009-07-19 03:44:35 +0000366
367 if (L == 0 && U == 0)
368 return ConstantRange(getBitWidth());
369
370 return ConstantRange(L, U);
Nick Lewycky9babd0e2007-04-01 03:47:44 +0000371 }
372
Nick Lewycky7e7dc452009-07-19 03:44:35 +0000373 if (!CR.isWrappedSet()) {
374 // ------U L----- and ------U L----- : this
375 // L--U L--U : CR
376 if (CR.Upper.ule(Upper) || CR.Lower.uge(Lower))
Nick Lewycky9babd0e2007-04-01 03:47:44 +0000377 return *this;
Nick Lewycky9babd0e2007-04-01 03:47:44 +0000378
Nick Lewycky7e7dc452009-07-19 03:44:35 +0000379 // ------U L----- : this
380 // L---------U : CR
381 if (CR.Lower.ule(Upper) && Lower.ule(CR.Upper))
Nick Lewycky9babd0e2007-04-01 03:47:44 +0000382 return ConstantRange(getBitWidth());
Nick Lewycky9babd0e2007-04-01 03:47:44 +0000383
Nick Lewycky7e7dc452009-07-19 03:44:35 +0000384 // ----U L---- : this
385 // L---U : CR
386 // <d1> <d2>
387 if (Upper.ule(CR.Lower) && CR.Upper.ule(Lower)) {
Nick Lewycky9babd0e2007-04-01 03:47:44 +0000388 APInt d1 = CR.Lower - Upper, d2 = Lower - CR.Upper;
Nick Lewycky7e7dc452009-07-19 03:44:35 +0000389 if (d1.ult(d2))
390 return ConstantRange(Lower, CR.Upper);
Nick Lewycky48a09ae2012-01-03 20:33:00 +0000391 return ConstantRange(CR.Lower, Upper);
Nick Lewycky9babd0e2007-04-01 03:47:44 +0000392 }
393
Nick Lewycky7e7dc452009-07-19 03:44:35 +0000394 // ----U L----- : this
395 // L----U : CR
396 if (Upper.ult(CR.Lower) && Lower.ult(CR.Upper))
397 return ConstantRange(CR.Lower, Upper);
Nick Lewycky9babd0e2007-04-01 03:47:44 +0000398
Nick Lewycky7e7dc452009-07-19 03:44:35 +0000399 // ------U L---- : this
400 // L-----U : CR
Nick Lewycky48a09ae2012-01-03 20:33:00 +0000401 assert(CR.Lower.ult(Upper) && CR.Upper.ult(Lower) &&
402 "ConstantRange::unionWith missed a case with one range wrapped");
403 return ConstantRange(Lower, CR.Upper);
Nick Lewycky9babd0e2007-04-01 03:47:44 +0000404 }
405
Nick Lewycky7e7dc452009-07-19 03:44:35 +0000406 // ------U L---- and ------U L---- : this
407 // -U L----------- and ------------U L : CR
408 if (CR.Lower.ule(Upper) || Lower.ule(CR.Upper))
409 return ConstantRange(getBitWidth());
Nick Lewycky9babd0e2007-04-01 03:47:44 +0000410
Nick Lewycky7e7dc452009-07-19 03:44:35 +0000411 APInt L = Lower, U = Upper;
412 if (CR.Upper.ugt(U))
413 U = CR.Upper;
414 if (CR.Lower.ult(L))
415 L = CR.Lower;
Nick Lewyckyc6a28fc2007-03-02 03:33:05 +0000416
417 return ConstantRange(L, U);
Chris Lattner645e00d2002-09-01 23:53:36 +0000418}
Chris Lattner96f9d722002-09-02 00:18:22 +0000419
Chris Lattnerfc33d302004-03-30 00:20:08 +0000420/// zeroExtend - Return a new range in the specified integer type, which must
421/// be strictly larger than the current type. The returned range will
Reid Spencere4d87aa2006-12-23 06:05:41 +0000422/// correspond to the possible range of values as if the source range had been
Chris Lattnerfc33d302004-03-30 00:20:08 +0000423/// zero extended.
Reid Spencerbb626a62007-02-28 22:02:48 +0000424ConstantRange ConstantRange::zeroExtend(uint32_t DstTySize) const {
Nick Lewycky32cda112010-09-06 23:52:49 +0000425 if (isEmptySet()) return ConstantRange(DstTySize, /*isFullSet=*/false);
426
Reid Spencerbb626a62007-02-28 22:02:48 +0000427 unsigned SrcTySize = getBitWidth();
Reid Spencer663e7112007-02-28 17:36:23 +0000428 assert(SrcTySize < DstTySize && "Not a value extension");
Nick Lewycky32cda112010-09-06 23:52:49 +0000429 if (isFullSet() || isWrappedSet())
430 // Change into [0, 1 << src bit width)
Reid Spencerdc5c1592007-02-28 18:57:32 +0000431 return ConstantRange(APInt(DstTySize,0), APInt(DstTySize,1).shl(SrcTySize));
Chris Lattnerfc33d302004-03-30 00:20:08 +0000432
Jay Foad40f8f622010-12-07 08:25:19 +0000433 return ConstantRange(Lower.zext(DstTySize), Upper.zext(DstTySize));
Chris Lattnerfc33d302004-03-30 00:20:08 +0000434}
435
Nick Lewyckye32157c2007-04-07 15:41:33 +0000436/// signExtend - Return a new range in the specified integer type, which must
437/// be strictly larger than the current type. The returned range will
438/// correspond to the possible range of values as if the source range had been
439/// sign extended.
440ConstantRange ConstantRange::signExtend(uint32_t DstTySize) const {
Nick Lewycky32cda112010-09-06 23:52:49 +0000441 if (isEmptySet()) return ConstantRange(DstTySize, /*isFullSet=*/false);
442
Nick Lewyckye32157c2007-04-07 15:41:33 +0000443 unsigned SrcTySize = getBitWidth();
444 assert(SrcTySize < DstTySize && "Not a value extension");
Nick Lewycky32cda112010-09-06 23:52:49 +0000445 if (isFullSet() || isSignWrappedSet()) {
Nick Lewyckye32157c2007-04-07 15:41:33 +0000446 return ConstantRange(APInt::getHighBitsSet(DstTySize,DstTySize-SrcTySize+1),
Nick Lewyckyff84de72009-07-13 04:17:23 +0000447 APInt::getLowBitsSet(DstTySize, SrcTySize-1) + 1);
Nick Lewyckye32157c2007-04-07 15:41:33 +0000448 }
449
Jay Foad40f8f622010-12-07 08:25:19 +0000450 return ConstantRange(Lower.sext(DstTySize), Upper.sext(DstTySize));
Nick Lewyckye32157c2007-04-07 15:41:33 +0000451}
452
Chris Lattnerfc33d302004-03-30 00:20:08 +0000453/// truncate - Return a new range in the specified integer type, which must be
454/// strictly smaller than the current type. The returned range will
Reid Spencere4d87aa2006-12-23 06:05:41 +0000455/// correspond to the possible range of values as if the source range had been
Chris Lattnerfc33d302004-03-30 00:20:08 +0000456/// truncated to the specified type.
Reid Spencerbb626a62007-02-28 22:02:48 +0000457ConstantRange ConstantRange::truncate(uint32_t DstTySize) const {
Benjamin Kramerb3ff49e2011-11-24 17:24:33 +0000458 assert(getBitWidth() > DstTySize && "Not a value truncation");
459 if (isFullSet() || getSetSize().getActiveBits() > DstTySize)
Nick Lewycky7f9ef4b2010-08-11 22:04:36 +0000460 return ConstantRange(DstTySize, /*isFullSet=*/true);
Chris Lattnerfc33d302004-03-30 00:20:08 +0000461
Jay Foad40f8f622010-12-07 08:25:19 +0000462 return ConstantRange(Lower.trunc(DstTySize), Upper.trunc(DstTySize));
Chris Lattnerfc33d302004-03-30 00:20:08 +0000463}
464
Nuno Lopes95a3be02009-11-09 15:36:28 +0000465/// zextOrTrunc - make this range have the bit width given by \p DstTySize. The
466/// value is zero extended, truncated, or left alone to make it that width.
467ConstantRange ConstantRange::zextOrTrunc(uint32_t DstTySize) const {
468 unsigned SrcTySize = getBitWidth();
469 if (SrcTySize > DstTySize)
470 return truncate(DstTySize);
Nick Lewycky48a09ae2012-01-03 20:33:00 +0000471 if (SrcTySize < DstTySize)
Nuno Lopes95a3be02009-11-09 15:36:28 +0000472 return zeroExtend(DstTySize);
Nick Lewycky48a09ae2012-01-03 20:33:00 +0000473 return *this;
Nuno Lopes95a3be02009-11-09 15:36:28 +0000474}
475
476/// sextOrTrunc - make this range have the bit width given by \p DstTySize. The
477/// value is sign extended, truncated, or left alone to make it that width.
478ConstantRange ConstantRange::sextOrTrunc(uint32_t DstTySize) const {
479 unsigned SrcTySize = getBitWidth();
480 if (SrcTySize > DstTySize)
481 return truncate(DstTySize);
Nick Lewycky48a09ae2012-01-03 20:33:00 +0000482 if (SrcTySize < DstTySize)
Nuno Lopes95a3be02009-11-09 15:36:28 +0000483 return signExtend(DstTySize);
Nick Lewycky48a09ae2012-01-03 20:33:00 +0000484 return *this;
Nuno Lopes95a3be02009-11-09 15:36:28 +0000485}
486
Dan Gohmana3755d82009-07-09 22:07:27 +0000487ConstantRange
488ConstantRange::add(const ConstantRange &Other) const {
489 if (isEmptySet() || Other.isEmptySet())
490 return ConstantRange(getBitWidth(), /*isFullSet=*/false);
Nick Lewyckycf9e07d2009-07-13 02:49:08 +0000491 if (isFullSet() || Other.isFullSet())
492 return ConstantRange(getBitWidth(), /*isFullSet=*/true);
Dan Gohmana3755d82009-07-09 22:07:27 +0000493
494 APInt Spread_X = getSetSize(), Spread_Y = Other.getSetSize();
495 APInt NewLower = getLower() + Other.getLower();
496 APInt NewUpper = getUpper() + Other.getUpper() - 1;
497 if (NewLower == NewUpper)
498 return ConstantRange(getBitWidth(), /*isFullSet=*/true);
499
500 ConstantRange X = ConstantRange(NewLower, NewUpper);
501 if (X.getSetSize().ult(Spread_X) || X.getSetSize().ult(Spread_Y))
502 // We've wrapped, therefore, full set.
503 return ConstantRange(getBitWidth(), /*isFullSet=*/true);
504
505 return X;
Chris Lattner96f9d722002-09-02 00:18:22 +0000506}
507
Dan Gohmana3755d82009-07-09 22:07:27 +0000508ConstantRange
Nick Lewycky7f9ef4b2010-08-11 22:04:36 +0000509ConstantRange::sub(const ConstantRange &Other) const {
510 if (isEmptySet() || Other.isEmptySet())
511 return ConstantRange(getBitWidth(), /*isFullSet=*/false);
512 if (isFullSet() || Other.isFullSet())
513 return ConstantRange(getBitWidth(), /*isFullSet=*/true);
514
515 APInt Spread_X = getSetSize(), Spread_Y = Other.getSetSize();
Nick Lewyckye6240e82011-06-22 21:13:46 +0000516 APInt NewLower = getLower() - Other.getUpper() + 1;
517 APInt NewUpper = getUpper() - Other.getLower();
Nick Lewycky7f9ef4b2010-08-11 22:04:36 +0000518 if (NewLower == NewUpper)
519 return ConstantRange(getBitWidth(), /*isFullSet=*/true);
520
521 ConstantRange X = ConstantRange(NewLower, NewUpper);
522 if (X.getSetSize().ult(Spread_X) || X.getSetSize().ult(Spread_Y))
523 // We've wrapped, therefore, full set.
524 return ConstantRange(getBitWidth(), /*isFullSet=*/true);
525
526 return X;
527}
528
529ConstantRange
Dan Gohmana3755d82009-07-09 22:07:27 +0000530ConstantRange::multiply(const ConstantRange &Other) const {
Dan Gohman8dcc58e2010-01-26 15:56:18 +0000531 // TODO: If either operand is a single element and the multiply is known to
532 // be non-wrapping, round the result min and max value to the appropriate
533 // multiple of that element. If wrapping is possible, at least adjust the
534 // range according to the greatest power-of-two factor of the single element.
Dan Gohman153f1eb2010-01-26 04:13:15 +0000535
Nick Lewycky2ff893f2009-07-12 02:19:05 +0000536 if (isEmptySet() || Other.isEmptySet())
537 return ConstantRange(getBitWidth(), /*isFullSet=*/false);
538 if (isFullSet() || Other.isFullSet())
539 return ConstantRange(getBitWidth(), /*isFullSet=*/true);
540
Nick Lewyckyf1db1202009-07-13 03:27:41 +0000541 APInt this_min = getUnsignedMin().zext(getBitWidth() * 2);
542 APInt this_max = getUnsignedMax().zext(getBitWidth() * 2);
543 APInt Other_min = Other.getUnsignedMin().zext(getBitWidth() * 2);
544 APInt Other_max = Other.getUnsignedMax().zext(getBitWidth() * 2);
Nick Lewycky2ff893f2009-07-12 02:19:05 +0000545
Nick Lewyckyf1db1202009-07-13 03:27:41 +0000546 ConstantRange Result_zext = ConstantRange(this_min * Other_min,
547 this_max * Other_max + 1);
Nick Lewycky2ff893f2009-07-12 02:19:05 +0000548 return Result_zext.truncate(getBitWidth());
Dan Gohmana3755d82009-07-09 22:07:27 +0000549}
550
551ConstantRange
552ConstantRange::smax(const ConstantRange &Other) const {
Dan Gohman38b06442009-07-09 23:16:10 +0000553 // X smax Y is: range(smax(X_smin, Y_smin),
554 // smax(X_smax, Y_smax))
555 if (isEmptySet() || Other.isEmptySet())
556 return ConstantRange(getBitWidth(), /*isFullSet=*/false);
Dan Gohman38b06442009-07-09 23:16:10 +0000557 APInt NewL = APIntOps::smax(getSignedMin(), Other.getSignedMin());
558 APInt NewU = APIntOps::smax(getSignedMax(), Other.getSignedMax()) + 1;
559 if (NewU == NewL)
560 return ConstantRange(getBitWidth(), /*isFullSet=*/true);
561 return ConstantRange(NewL, NewU);
Dan Gohmana3755d82009-07-09 22:07:27 +0000562}
563
564ConstantRange
565ConstantRange::umax(const ConstantRange &Other) const {
566 // X umax Y is: range(umax(X_umin, Y_umin),
567 // umax(X_umax, Y_umax))
568 if (isEmptySet() || Other.isEmptySet())
569 return ConstantRange(getBitWidth(), /*isFullSet=*/false);
Dan Gohmana3755d82009-07-09 22:07:27 +0000570 APInt NewL = APIntOps::umax(getUnsignedMin(), Other.getUnsignedMin());
571 APInt NewU = APIntOps::umax(getUnsignedMax(), Other.getUnsignedMax()) + 1;
572 if (NewU == NewL)
573 return ConstantRange(getBitWidth(), /*isFullSet=*/true);
574 return ConstantRange(NewL, NewU);
575}
576
577ConstantRange
Nick Lewycky956daf02009-07-12 05:18:18 +0000578ConstantRange::udiv(const ConstantRange &RHS) const {
579 if (isEmptySet() || RHS.isEmptySet() || RHS.getUnsignedMax() == 0)
580 return ConstantRange(getBitWidth(), /*isFullSet=*/false);
581 if (RHS.isFullSet())
582 return ConstantRange(getBitWidth(), /*isFullSet=*/true);
583
584 APInt Lower = getUnsignedMin().udiv(RHS.getUnsignedMax());
585
586 APInt RHS_umin = RHS.getUnsignedMin();
587 if (RHS_umin == 0) {
588 // We want the lowest value in RHS excluding zero. Usually that would be 1
589 // except for a range in the form of [X, 1) in which case it would be X.
590 if (RHS.getUpper() == 1)
591 RHS_umin = RHS.getLower();
592 else
593 RHS_umin = APInt(getBitWidth(), 1);
594 }
595
596 APInt Upper = getUnsignedMax().udiv(RHS_umin) + 1;
597
598 // If the LHS is Full and the RHS is a wrapped interval containing 1 then
599 // this could occur.
600 if (Lower == Upper)
601 return ConstantRange(getBitWidth(), /*isFullSet=*/true);
602
603 return ConstantRange(Lower, Upper);
Dan Gohmana3755d82009-07-09 22:07:27 +0000604}
605
Nuno Lopes34e992d2009-11-12 14:53:53 +0000606ConstantRange
Nick Lewycky198381e2010-09-07 05:39:02 +0000607ConstantRange::binaryAnd(const ConstantRange &Other) const {
608 if (isEmptySet() || Other.isEmptySet())
609 return ConstantRange(getBitWidth(), /*isFullSet=*/false);
610
611 // TODO: replace this with something less conservative
612
613 APInt umin = APIntOps::umin(Other.getUnsignedMax(), getUnsignedMax());
614 if (umin.isAllOnesValue())
615 return ConstantRange(getBitWidth(), /*isFullSet=*/true);
616 return ConstantRange(APInt::getNullValue(getBitWidth()), umin + 1);
617}
618
619ConstantRange
620ConstantRange::binaryOr(const ConstantRange &Other) const {
621 if (isEmptySet() || Other.isEmptySet())
622 return ConstantRange(getBitWidth(), /*isFullSet=*/false);
623
624 // TODO: replace this with something less conservative
625
626 APInt umax = APIntOps::umax(getUnsignedMin(), Other.getUnsignedMin());
627 if (umax.isMinValue())
628 return ConstantRange(getBitWidth(), /*isFullSet=*/true);
629 return ConstantRange(umax, APInt::getNullValue(getBitWidth()));
630}
631
632ConstantRange
Nick Lewycky7f9ef4b2010-08-11 22:04:36 +0000633ConstantRange::shl(const ConstantRange &Other) const {
634 if (isEmptySet() || Other.isEmptySet())
635 return ConstantRange(getBitWidth(), /*isFullSet=*/false);
Nuno Lopes34e992d2009-11-12 14:53:53 +0000636
Nick Lewycky7f9ef4b2010-08-11 22:04:36 +0000637 APInt min = getUnsignedMin().shl(Other.getUnsignedMin());
638 APInt max = getUnsignedMax().shl(Other.getUnsignedMax());
Nuno Lopes34e992d2009-11-12 14:53:53 +0000639
640 // there's no overflow!
Nuno Lopes44591452009-11-12 15:10:33 +0000641 APInt Zeros(getBitWidth(), getUnsignedMax().countLeadingZeros());
Nick Lewycky7f9ef4b2010-08-11 22:04:36 +0000642 if (Zeros.ugt(Other.getUnsignedMax()))
643 return ConstantRange(min, max + 1);
Nuno Lopes34e992d2009-11-12 14:53:53 +0000644
645 // FIXME: implement the other tricky cases
Nick Lewycky7f9ef4b2010-08-11 22:04:36 +0000646 return ConstantRange(getBitWidth(), /*isFullSet=*/true);
Nuno Lopes34e992d2009-11-12 14:53:53 +0000647}
648
649ConstantRange
Nick Lewycky7f9ef4b2010-08-11 22:04:36 +0000650ConstantRange::lshr(const ConstantRange &Other) const {
651 if (isEmptySet() || Other.isEmptySet())
652 return ConstantRange(getBitWidth(), /*isFullSet=*/false);
Nuno Lopes34e992d2009-11-12 14:53:53 +0000653
Nick Lewycky7f9ef4b2010-08-11 22:04:36 +0000654 APInt max = getUnsignedMax().lshr(Other.getUnsignedMin());
655 APInt min = getUnsignedMin().lshr(Other.getUnsignedMax());
656 if (min == max + 1)
657 return ConstantRange(getBitWidth(), /*isFullSet=*/true);
658
659 return ConstantRange(min, max + 1);
Nuno Lopes34e992d2009-11-12 14:53:53 +0000660}
661
Owen Anderson9773e452010-08-07 05:47:46 +0000662ConstantRange ConstantRange::inverse() const {
Nick Lewycky48a09ae2012-01-03 20:33:00 +0000663 if (isFullSet())
Nick Lewycky7f9ef4b2010-08-11 22:04:36 +0000664 return ConstantRange(getBitWidth(), /*isFullSet=*/false);
Nick Lewycky48a09ae2012-01-03 20:33:00 +0000665 if (isEmptySet())
Nick Lewycky7f9ef4b2010-08-11 22:04:36 +0000666 return ConstantRange(getBitWidth(), /*isFullSet=*/true);
Owen Anderson9773e452010-08-07 05:47:46 +0000667 return ConstantRange(Upper, Lower);
668}
669
Dan Gohman38b06442009-07-09 23:16:10 +0000670/// print - Print out the bounds to a stream...
Chris Lattner96f9d722002-09-02 00:18:22 +0000671///
Dan Gohman38b06442009-07-09 23:16:10 +0000672void ConstantRange::print(raw_ostream &OS) const {
Dan Gohmandf6d5e02010-01-26 04:12:55 +0000673 if (isFullSet())
674 OS << "full-set";
675 else if (isEmptySet())
676 OS << "empty-set";
677 else
678 OS << "[" << Lower << "," << Upper << ")";
Dan Gohmana3755d82009-07-09 22:07:27 +0000679}
680
Dan Gohman38b06442009-07-09 23:16:10 +0000681/// dump - Allow printing from a debugger easily...
Dan Gohmana3755d82009-07-09 22:07:27 +0000682///
Dan Gohman38b06442009-07-09 23:16:10 +0000683void ConstantRange::dump() const {
David Greene7fd5fb42010-01-05 01:28:32 +0000684 print(dbgs());
Dan Gohmana3755d82009-07-09 22:07:27 +0000685}