1 //===- ConstantRangeTest.cpp - ConstantRange tests ------------------------===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 
9 #include "llvm/ADT/BitVector.h"
10 #include "llvm/IR/ConstantRange.h"
11 #include "llvm/IR/Instructions.h"
12 #include "llvm/IR/Operator.h"
13 #include "llvm/Support/KnownBits.h"
14 #include "gtest/gtest.h"
15 
16 using namespace llvm;
17 
18 namespace {
19 
20 class ConstantRangeTest : public ::testing::Test {
21 protected:
22   static ConstantRange Full;
23   static ConstantRange Empty;
24   static ConstantRange One;
25   static ConstantRange Some;
26   static ConstantRange Wrap;
27 };
28 
29 template<typename Fn>
EnumerateConstantRanges(unsigned Bits,Fn TestFn)30 static void EnumerateConstantRanges(unsigned Bits, Fn TestFn) {
31   unsigned Max = 1 << Bits;
32   for (unsigned Lo = 0; Lo < Max; Lo++) {
33     for (unsigned Hi = 0; Hi < Max; Hi++) {
34       // Enforce ConstantRange invariant.
35       if (Lo == Hi && Lo != 0 && Lo != Max - 1)
36         continue;
37 
38       ConstantRange CR(APInt(Bits, Lo), APInt(Bits, Hi));
39       TestFn(CR);
40     }
41   }
42 }
43 
44 template<typename Fn>
EnumerateTwoConstantRanges(unsigned Bits,Fn TestFn)45 static void EnumerateTwoConstantRanges(unsigned Bits, Fn TestFn) {
46   EnumerateConstantRanges(Bits, [&](const ConstantRange &CR1) {
47     EnumerateConstantRanges(Bits, [&](const ConstantRange &CR2) {
48       TestFn(CR1, CR2);
49     });
50   });
51 }
52 
53 template<typename Fn>
ForeachNumInConstantRange(const ConstantRange & CR,Fn TestFn)54 static void ForeachNumInConstantRange(const ConstantRange &CR, Fn TestFn) {
55   if (!CR.isEmptySet()) {
56     APInt N = CR.getLower();
57     do TestFn(N);
58     while (++N != CR.getUpper());
59   }
60 }
61 
62 template<typename Fn1, typename Fn2>
TestUnsignedBinOpExhaustive(Fn1 RangeFn,Fn2 IntFn,bool SkipZeroRHS=false,bool CorrectnessOnly=false)63 static void TestUnsignedBinOpExhaustive(
64     Fn1 RangeFn, Fn2 IntFn,
65     bool SkipZeroRHS = false, bool CorrectnessOnly = false) {
66   unsigned Bits = 4;
67   EnumerateTwoConstantRanges(Bits, [&](const ConstantRange &CR1,
68                                        const ConstantRange &CR2) {
69     APInt Min = APInt::getMaxValue(Bits);
70     APInt Max = APInt::getMinValue(Bits);
71     ForeachNumInConstantRange(CR1, [&](const APInt &N1) {
72       ForeachNumInConstantRange(CR2, [&](const APInt &N2) {
73         if (SkipZeroRHS && N2 == 0)
74           return;
75 
76         APInt N = IntFn(N1, N2);
77         if (N.ult(Min))
78           Min = N;
79         if (N.ugt(Max))
80           Max = N;
81       });
82     });
83 
84     ConstantRange CR = RangeFn(CR1, CR2);
85     if (Min.ugt(Max)) {
86       EXPECT_TRUE(CR.isEmptySet());
87       return;
88     }
89 
90     ConstantRange Exact = ConstantRange::getNonEmpty(Min, Max + 1);
91     if (CorrectnessOnly) {
92       EXPECT_TRUE(CR.contains(Exact));
93     } else {
94       EXPECT_EQ(Exact, CR);
95     }
96   });
97 }
98 
99 template<typename Fn1, typename Fn2>
TestSignedBinOpExhaustive(Fn1 RangeFn,Fn2 IntFn,bool SkipZeroRHS=false,bool CorrectnessOnly=false)100 static void TestSignedBinOpExhaustive(
101     Fn1 RangeFn, Fn2 IntFn,
102     bool SkipZeroRHS = false, bool CorrectnessOnly = false) {
103   unsigned Bits = 4;
104   EnumerateTwoConstantRanges(Bits, [&](const ConstantRange &CR1,
105                                        const ConstantRange &CR2) {
106     APInt Min = APInt::getSignedMaxValue(Bits);
107     APInt Max = APInt::getSignedMinValue(Bits);
108     ForeachNumInConstantRange(CR1, [&](const APInt &N1) {
109       ForeachNumInConstantRange(CR2, [&](const APInt &N2) {
110         if (SkipZeroRHS && N2 == 0)
111           return;
112 
113         APInt N = IntFn(N1, N2);
114         if (N.slt(Min))
115           Min = N;
116         if (N.sgt(Max))
117           Max = N;
118       });
119     });
120 
121     ConstantRange CR = RangeFn(CR1, CR2);
122     if (Min.sgt(Max)) {
123       EXPECT_TRUE(CR.isEmptySet());
124       return;
125     }
126 
127     ConstantRange Exact = ConstantRange::getNonEmpty(Min, Max + 1);
128     if (CorrectnessOnly) {
129       EXPECT_TRUE(CR.contains(Exact));
130     } else {
131       EXPECT_EQ(Exact, CR);
132     }
133   });
134 }
135 
136 ConstantRange ConstantRangeTest::Full(16, true);
137 ConstantRange ConstantRangeTest::Empty(16, false);
138 ConstantRange ConstantRangeTest::One(APInt(16, 0xa));
139 ConstantRange ConstantRangeTest::Some(APInt(16, 0xa), APInt(16, 0xaaa));
140 ConstantRange ConstantRangeTest::Wrap(APInt(16, 0xaaa), APInt(16, 0xa));
141 
TEST_F(ConstantRangeTest,Basics)142 TEST_F(ConstantRangeTest, Basics) {
143   EXPECT_TRUE(Full.isFullSet());
144   EXPECT_FALSE(Full.isEmptySet());
145   EXPECT_TRUE(Full.inverse().isEmptySet());
146   EXPECT_FALSE(Full.isWrappedSet());
147   EXPECT_TRUE(Full.contains(APInt(16, 0x0)));
148   EXPECT_TRUE(Full.contains(APInt(16, 0x9)));
149   EXPECT_TRUE(Full.contains(APInt(16, 0xa)));
150   EXPECT_TRUE(Full.contains(APInt(16, 0xaa9)));
151   EXPECT_TRUE(Full.contains(APInt(16, 0xaaa)));
152 
153   EXPECT_FALSE(Empty.isFullSet());
154   EXPECT_TRUE(Empty.isEmptySet());
155   EXPECT_TRUE(Empty.inverse().isFullSet());
156   EXPECT_FALSE(Empty.isWrappedSet());
157   EXPECT_FALSE(Empty.contains(APInt(16, 0x0)));
158   EXPECT_FALSE(Empty.contains(APInt(16, 0x9)));
159   EXPECT_FALSE(Empty.contains(APInt(16, 0xa)));
160   EXPECT_FALSE(Empty.contains(APInt(16, 0xaa9)));
161   EXPECT_FALSE(Empty.contains(APInt(16, 0xaaa)));
162 
163   EXPECT_FALSE(One.isFullSet());
164   EXPECT_FALSE(One.isEmptySet());
165   EXPECT_FALSE(One.isWrappedSet());
166   EXPECT_FALSE(One.contains(APInt(16, 0x0)));
167   EXPECT_FALSE(One.contains(APInt(16, 0x9)));
168   EXPECT_TRUE(One.contains(APInt(16, 0xa)));
169   EXPECT_FALSE(One.contains(APInt(16, 0xaa9)));
170   EXPECT_FALSE(One.contains(APInt(16, 0xaaa)));
171   EXPECT_FALSE(One.inverse().contains(APInt(16, 0xa)));
172 
173   EXPECT_FALSE(Some.isFullSet());
174   EXPECT_FALSE(Some.isEmptySet());
175   EXPECT_FALSE(Some.isWrappedSet());
176   EXPECT_FALSE(Some.contains(APInt(16, 0x0)));
177   EXPECT_FALSE(Some.contains(APInt(16, 0x9)));
178   EXPECT_TRUE(Some.contains(APInt(16, 0xa)));
179   EXPECT_TRUE(Some.contains(APInt(16, 0xaa9)));
180   EXPECT_FALSE(Some.contains(APInt(16, 0xaaa)));
181 
182   EXPECT_FALSE(Wrap.isFullSet());
183   EXPECT_FALSE(Wrap.isEmptySet());
184   EXPECT_TRUE(Wrap.isWrappedSet());
185   EXPECT_TRUE(Wrap.contains(APInt(16, 0x0)));
186   EXPECT_TRUE(Wrap.contains(APInt(16, 0x9)));
187   EXPECT_FALSE(Wrap.contains(APInt(16, 0xa)));
188   EXPECT_FALSE(Wrap.contains(APInt(16, 0xaa9)));
189   EXPECT_TRUE(Wrap.contains(APInt(16, 0xaaa)));
190 }
191 
TEST_F(ConstantRangeTest,Equality)192 TEST_F(ConstantRangeTest, Equality) {
193   EXPECT_EQ(Full, Full);
194   EXPECT_EQ(Empty, Empty);
195   EXPECT_EQ(One, One);
196   EXPECT_EQ(Some, Some);
197   EXPECT_EQ(Wrap, Wrap);
198   EXPECT_NE(Full, Empty);
199   EXPECT_NE(Full, One);
200   EXPECT_NE(Full, Some);
201   EXPECT_NE(Full, Wrap);
202   EXPECT_NE(Empty, One);
203   EXPECT_NE(Empty, Some);
204   EXPECT_NE(Empty, Wrap);
205   EXPECT_NE(One, Some);
206   EXPECT_NE(One, Wrap);
207   EXPECT_NE(Some, Wrap);
208 }
209 
TEST_F(ConstantRangeTest,SingleElement)210 TEST_F(ConstantRangeTest, SingleElement) {
211   EXPECT_EQ(Full.getSingleElement(), static_cast<APInt *>(nullptr));
212   EXPECT_EQ(Empty.getSingleElement(), static_cast<APInt *>(nullptr));
213   EXPECT_EQ(Full.getSingleMissingElement(), static_cast<APInt *>(nullptr));
214   EXPECT_EQ(Empty.getSingleMissingElement(), static_cast<APInt *>(nullptr));
215 
216   EXPECT_EQ(*One.getSingleElement(), APInt(16, 0xa));
217   EXPECT_EQ(Some.getSingleElement(), static_cast<APInt *>(nullptr));
218   EXPECT_EQ(Wrap.getSingleElement(), static_cast<APInt *>(nullptr));
219 
220   EXPECT_EQ(One.getSingleMissingElement(), static_cast<APInt *>(nullptr));
221   EXPECT_EQ(Some.getSingleMissingElement(), static_cast<APInt *>(nullptr));
222 
223   ConstantRange OneInverse = One.inverse();
224   EXPECT_EQ(*OneInverse.getSingleMissingElement(), *One.getSingleElement());
225 
226   EXPECT_FALSE(Full.isSingleElement());
227   EXPECT_FALSE(Empty.isSingleElement());
228   EXPECT_TRUE(One.isSingleElement());
229   EXPECT_FALSE(Some.isSingleElement());
230   EXPECT_FALSE(Wrap.isSingleElement());
231 }
232 
TEST_F(ConstantRangeTest,GetMinsAndMaxes)233 TEST_F(ConstantRangeTest, GetMinsAndMaxes) {
234   EXPECT_EQ(Full.getUnsignedMax(), APInt(16, UINT16_MAX));
235   EXPECT_EQ(One.getUnsignedMax(), APInt(16, 0xa));
236   EXPECT_EQ(Some.getUnsignedMax(), APInt(16, 0xaa9));
237   EXPECT_EQ(Wrap.getUnsignedMax(), APInt(16, UINT16_MAX));
238 
239   EXPECT_EQ(Full.getUnsignedMin(), APInt(16, 0));
240   EXPECT_EQ(One.getUnsignedMin(), APInt(16, 0xa));
241   EXPECT_EQ(Some.getUnsignedMin(), APInt(16, 0xa));
242   EXPECT_EQ(Wrap.getUnsignedMin(), APInt(16, 0));
243 
244   EXPECT_EQ(Full.getSignedMax(), APInt(16, INT16_MAX));
245   EXPECT_EQ(One.getSignedMax(), APInt(16, 0xa));
246   EXPECT_EQ(Some.getSignedMax(), APInt(16, 0xaa9));
247   EXPECT_EQ(Wrap.getSignedMax(), APInt(16, INT16_MAX));
248 
249   EXPECT_EQ(Full.getSignedMin(), APInt(16, (uint64_t)INT16_MIN));
250   EXPECT_EQ(One.getSignedMin(), APInt(16, 0xa));
251   EXPECT_EQ(Some.getSignedMin(), APInt(16, 0xa));
252   EXPECT_EQ(Wrap.getSignedMin(), APInt(16, (uint64_t)INT16_MIN));
253 
254   // Found by Klee
255   EXPECT_EQ(ConstantRange(APInt(4, 7), APInt(4, 0)).getSignedMax(),
256             APInt(4, 7));
257 }
258 
TEST_F(ConstantRangeTest,SignWrapped)259 TEST_F(ConstantRangeTest, SignWrapped) {
260   EXPECT_FALSE(Full.isSignWrappedSet());
261   EXPECT_FALSE(Empty.isSignWrappedSet());
262   EXPECT_FALSE(One.isSignWrappedSet());
263   EXPECT_FALSE(Some.isSignWrappedSet());
264   EXPECT_TRUE(Wrap.isSignWrappedSet());
265 
266   EXPECT_FALSE(ConstantRange(APInt(8, 127), APInt(8, 128)).isSignWrappedSet());
267   EXPECT_TRUE(ConstantRange(APInt(8, 127), APInt(8, 129)).isSignWrappedSet());
268   EXPECT_FALSE(ConstantRange(APInt(8, 128), APInt(8, 129)).isSignWrappedSet());
269   EXPECT_TRUE(ConstantRange(APInt(8, 10), APInt(8, 9)).isSignWrappedSet());
270   EXPECT_TRUE(ConstantRange(APInt(8, 10), APInt(8, 250)).isSignWrappedSet());
271   EXPECT_FALSE(ConstantRange(APInt(8, 250), APInt(8, 10)).isSignWrappedSet());
272   EXPECT_FALSE(ConstantRange(APInt(8, 250), APInt(8, 251)).isSignWrappedSet());
273 }
274 
TEST_F(ConstantRangeTest,UpperWrapped)275 TEST_F(ConstantRangeTest, UpperWrapped) {
276   // The behavior here is the same as for isWrappedSet() / isSignWrappedSet().
277   EXPECT_FALSE(Full.isUpperWrapped());
278   EXPECT_FALSE(Empty.isUpperWrapped());
279   EXPECT_FALSE(One.isUpperWrapped());
280   EXPECT_FALSE(Some.isUpperWrapped());
281   EXPECT_TRUE(Wrap.isUpperWrapped());
282   EXPECT_FALSE(Full.isUpperSignWrapped());
283   EXPECT_FALSE(Empty.isUpperSignWrapped());
284   EXPECT_FALSE(One.isUpperSignWrapped());
285   EXPECT_FALSE(Some.isUpperSignWrapped());
286   EXPECT_TRUE(Wrap.isUpperSignWrapped());
287 
288   // The behavior differs if Upper is the Min/SignedMin value.
289   ConstantRange CR1(APInt(8, 42), APInt::getMinValue(8));
290   EXPECT_FALSE(CR1.isWrappedSet());
291   EXPECT_TRUE(CR1.isUpperWrapped());
292 
293   ConstantRange CR2(APInt(8, 42), APInt::getSignedMinValue(8));
294   EXPECT_FALSE(CR2.isSignWrappedSet());
295   EXPECT_TRUE(CR2.isUpperSignWrapped());
296 }
297 
TEST_F(ConstantRangeTest,Trunc)298 TEST_F(ConstantRangeTest, Trunc) {
299   ConstantRange TFull = Full.truncate(10);
300   ConstantRange TEmpty = Empty.truncate(10);
301   ConstantRange TOne = One.truncate(10);
302   ConstantRange TSome = Some.truncate(10);
303   ConstantRange TWrap = Wrap.truncate(10);
304   EXPECT_TRUE(TFull.isFullSet());
305   EXPECT_TRUE(TEmpty.isEmptySet());
306   EXPECT_EQ(TOne, ConstantRange(One.getLower().trunc(10),
307                                 One.getUpper().trunc(10)));
308   EXPECT_TRUE(TSome.isFullSet());
309   EXPECT_TRUE(TWrap.isFullSet());
310 
311   // trunc([2, 5), 3->2) = [2, 1)
312   ConstantRange TwoFive(APInt(3, 2), APInt(3, 5));
313   EXPECT_EQ(TwoFive.truncate(2), ConstantRange(APInt(2, 2), APInt(2, 1)));
314 
315   // trunc([2, 6), 3->2) = full
316   ConstantRange TwoSix(APInt(3, 2), APInt(3, 6));
317   EXPECT_TRUE(TwoSix.truncate(2).isFullSet());
318 
319   // trunc([5, 7), 3->2) = [1, 3)
320   ConstantRange FiveSeven(APInt(3, 5), APInt(3, 7));
321   EXPECT_EQ(FiveSeven.truncate(2), ConstantRange(APInt(2, 1), APInt(2, 3)));
322 
323   // trunc([7, 1), 3->2) = [3, 1)
324   ConstantRange SevenOne(APInt(3, 7), APInt(3, 1));
325   EXPECT_EQ(SevenOne.truncate(2), ConstantRange(APInt(2, 3), APInt(2, 1)));
326 }
327 
TEST_F(ConstantRangeTest,ZExt)328 TEST_F(ConstantRangeTest, ZExt) {
329   ConstantRange ZFull = Full.zeroExtend(20);
330   ConstantRange ZEmpty = Empty.zeroExtend(20);
331   ConstantRange ZOne = One.zeroExtend(20);
332   ConstantRange ZSome = Some.zeroExtend(20);
333   ConstantRange ZWrap = Wrap.zeroExtend(20);
334   EXPECT_EQ(ZFull, ConstantRange(APInt(20, 0), APInt(20, 0x10000)));
335   EXPECT_TRUE(ZEmpty.isEmptySet());
336   EXPECT_EQ(ZOne, ConstantRange(One.getLower().zext(20),
337                                 One.getUpper().zext(20)));
338   EXPECT_EQ(ZSome, ConstantRange(Some.getLower().zext(20),
339                                  Some.getUpper().zext(20)));
340   EXPECT_EQ(ZWrap, ConstantRange(APInt(20, 0), APInt(20, 0x10000)));
341 
342   // zext([5, 0), 3->7) = [5, 8)
343   ConstantRange FiveZero(APInt(3, 5), APInt(3, 0));
344   EXPECT_EQ(FiveZero.zeroExtend(7), ConstantRange(APInt(7, 5), APInt(7, 8)));
345 }
346 
TEST_F(ConstantRangeTest,SExt)347 TEST_F(ConstantRangeTest, SExt) {
348   ConstantRange SFull = Full.signExtend(20);
349   ConstantRange SEmpty = Empty.signExtend(20);
350   ConstantRange SOne = One.signExtend(20);
351   ConstantRange SSome = Some.signExtend(20);
352   ConstantRange SWrap = Wrap.signExtend(20);
353   EXPECT_EQ(SFull, ConstantRange(APInt(20, (uint64_t)INT16_MIN, true),
354                                  APInt(20, INT16_MAX + 1, true)));
355   EXPECT_TRUE(SEmpty.isEmptySet());
356   EXPECT_EQ(SOne, ConstantRange(One.getLower().sext(20),
357                                 One.getUpper().sext(20)));
358   EXPECT_EQ(SSome, ConstantRange(Some.getLower().sext(20),
359                                  Some.getUpper().sext(20)));
360   EXPECT_EQ(SWrap, ConstantRange(APInt(20, (uint64_t)INT16_MIN, true),
361                                  APInt(20, INT16_MAX + 1, true)));
362 
363   EXPECT_EQ(ConstantRange(APInt(8, 120), APInt(8, 140)).signExtend(16),
364             ConstantRange(APInt(16, -128), APInt(16, 128)));
365 
366   EXPECT_EQ(ConstantRange(APInt(16, 0x0200), APInt(16, 0x8000)).signExtend(19),
367             ConstantRange(APInt(19, 0x0200), APInt(19, 0x8000)));
368 }
369 
TEST_F(ConstantRangeTest,IntersectWith)370 TEST_F(ConstantRangeTest, IntersectWith) {
371   EXPECT_EQ(Empty.intersectWith(Full), Empty);
372   EXPECT_EQ(Empty.intersectWith(Empty), Empty);
373   EXPECT_EQ(Empty.intersectWith(One), Empty);
374   EXPECT_EQ(Empty.intersectWith(Some), Empty);
375   EXPECT_EQ(Empty.intersectWith(Wrap), Empty);
376   EXPECT_EQ(Full.intersectWith(Full), Full);
377   EXPECT_EQ(Some.intersectWith(Some), Some);
378   EXPECT_EQ(Some.intersectWith(One), One);
379   EXPECT_EQ(Full.intersectWith(One), One);
380   EXPECT_EQ(Full.intersectWith(Some), Some);
381   EXPECT_EQ(Some.intersectWith(Wrap), Empty);
382   EXPECT_EQ(One.intersectWith(Wrap), Empty);
383   EXPECT_EQ(One.intersectWith(Wrap), Wrap.intersectWith(One));
384 
385   // Klee generated testcase from PR4545.
386   // The intersection of i16 [4, 2) and [6, 5) is disjoint, looking like
387   // 01..4.6789ABCDEF where the dots represent values not in the intersection.
388   ConstantRange LHS(APInt(16, 4), APInt(16, 2));
389   ConstantRange RHS(APInt(16, 6), APInt(16, 5));
390   EXPECT_TRUE(LHS.intersectWith(RHS) == LHS);
391 
392   // previous bug: intersection of [min, 3) and [2, max) should be 2
393   LHS = ConstantRange(APInt(32, -2147483646), APInt(32, 3));
394   RHS = ConstantRange(APInt(32, 2), APInt(32, 2147483646));
395   EXPECT_EQ(LHS.intersectWith(RHS), ConstantRange(APInt(32, 2)));
396 
397   // [2, 0) /\ [4, 3) = [2, 0)
398   LHS = ConstantRange(APInt(32, 2), APInt(32, 0));
399   RHS = ConstantRange(APInt(32, 4), APInt(32, 3));
400   EXPECT_EQ(LHS.intersectWith(RHS), ConstantRange(APInt(32, 2), APInt(32, 0)));
401 
402   // [2, 0) /\ [4, 2) = [4, 0)
403   LHS = ConstantRange(APInt(32, 2), APInt(32, 0));
404   RHS = ConstantRange(APInt(32, 4), APInt(32, 2));
405   EXPECT_EQ(LHS.intersectWith(RHS), ConstantRange(APInt(32, 4), APInt(32, 0)));
406 
407   // [4, 2) /\ [5, 1) = [5, 1)
408   LHS = ConstantRange(APInt(32, 4), APInt(32, 2));
409   RHS = ConstantRange(APInt(32, 5), APInt(32, 1));
410   EXPECT_EQ(LHS.intersectWith(RHS), ConstantRange(APInt(32, 5), APInt(32, 1)));
411 
412   // [2, 0) /\ [7, 4) = [7, 4)
413   LHS = ConstantRange(APInt(32, 2), APInt(32, 0));
414   RHS = ConstantRange(APInt(32, 7), APInt(32, 4));
415   EXPECT_EQ(LHS.intersectWith(RHS), ConstantRange(APInt(32, 7), APInt(32, 4)));
416 
417   // [4, 2) /\ [1, 0) = [1, 0)
418   LHS = ConstantRange(APInt(32, 4), APInt(32, 2));
419   RHS = ConstantRange(APInt(32, 1), APInt(32, 0));
420   EXPECT_EQ(LHS.intersectWith(RHS), ConstantRange(APInt(32, 4), APInt(32, 2)));
421 
422   // [15, 0) /\ [7, 6) = [15, 0)
423   LHS = ConstantRange(APInt(32, 15), APInt(32, 0));
424   RHS = ConstantRange(APInt(32, 7), APInt(32, 6));
425   EXPECT_EQ(LHS.intersectWith(RHS), ConstantRange(APInt(32, 15), APInt(32, 0)));
426 }
427 
428 template<typename Fn1, typename Fn2>
testBinarySetOperationExhaustive(Fn1 OpFn,Fn2 InResultFn)429 void testBinarySetOperationExhaustive(Fn1 OpFn, Fn2 InResultFn) {
430   unsigned Bits = 4;
431   EnumerateTwoConstantRanges(Bits,
432       [=](const ConstantRange &CR1, const ConstantRange &CR2) {
433         // Collect up to three contiguous unsigned ranges. The HaveInterrupt
434         // variables are used determine when we have to switch to the next
435         // range because the previous one ended.
436         APInt Lower1(Bits, 0), Upper1(Bits, 0);
437         APInt Lower2(Bits, 0), Upper2(Bits, 0);
438         APInt Lower3(Bits, 0), Upper3(Bits, 0);
439         bool HaveRange1 = false, HaveInterrupt1 = false;
440         bool HaveRange2 = false, HaveInterrupt2 = false;
441         bool HaveRange3 = false, HaveInterrupt3 = false;
442 
443         APInt Num(Bits, 0);
444         for (unsigned I = 0, Limit = 1 << Bits; I < Limit; ++I, ++Num) {
445           if (!InResultFn(CR1, CR2, Num)) {
446             if (HaveRange3)
447               HaveInterrupt3 = true;
448             else if (HaveRange2)
449               HaveInterrupt2 = true;
450             else if (HaveRange1)
451               HaveInterrupt1 = true;
452             continue;
453           }
454 
455           if (HaveRange3) {
456             Upper3 = Num;
457           } else if (HaveInterrupt2) {
458             HaveRange3 = true;
459             Lower3 = Upper3 = Num;
460           } else if (HaveRange2) {
461             Upper2 = Num;
462           } else if (HaveInterrupt1) {
463             HaveRange2 = true;
464             Lower2 = Upper2 = Num;
465           } else if (HaveRange1) {
466             Upper1 = Num;
467           } else {
468             HaveRange1 = true;
469             Lower1 = Upper1 = Num;
470           }
471         }
472 
473         (void)HaveInterrupt3;
474         assert(!HaveInterrupt3 && "Should have at most three ranges");
475 
476         ConstantRange SmallestCR = OpFn(CR1, CR2, ConstantRange::Smallest);
477         ConstantRange UnsignedCR = OpFn(CR1, CR2, ConstantRange::Unsigned);
478         ConstantRange SignedCR = OpFn(CR1, CR2, ConstantRange::Signed);
479 
480         if (!HaveRange1) {
481           EXPECT_TRUE(SmallestCR.isEmptySet());
482           EXPECT_TRUE(UnsignedCR.isEmptySet());
483           EXPECT_TRUE(SignedCR.isEmptySet());
484           return;
485         }
486 
487         if (!HaveRange2) {
488           if (Lower1 == Upper1 + 1) {
489             EXPECT_TRUE(SmallestCR.isFullSet());
490             EXPECT_TRUE(UnsignedCR.isFullSet());
491             EXPECT_TRUE(SignedCR.isFullSet());
492           } else {
493             ConstantRange Expected(Lower1, Upper1 + 1);
494             EXPECT_EQ(Expected, SmallestCR);
495             EXPECT_EQ(Expected, UnsignedCR);
496             EXPECT_EQ(Expected, SignedCR);
497           }
498           return;
499         }
500 
501         ConstantRange Variant1(Bits, /*full*/ true);
502         ConstantRange Variant2(Bits, /*full*/ true);
503         if (!HaveRange3) {
504           // Compute the two possible ways to cover two disjoint ranges.
505           if (Lower1 != Upper2 + 1)
506             Variant1 = ConstantRange(Lower1, Upper2 + 1);
507           if (Lower2 != Upper1 + 1)
508             Variant2 = ConstantRange(Lower2, Upper1 + 1);
509         } else {
510           // If we have three ranges, the first and last one have to be adjacent
511           // to the unsigned domain. It's better to think of this as having two
512           // holes, and we can construct one range using each hole.
513           assert(Lower1.isNullValue() && Upper3.isMaxValue());
514           Variant1 = ConstantRange(Lower2, Upper1 + 1);
515           Variant2 = ConstantRange(Lower3, Upper2 + 1);
516         }
517 
518         // Smallest: Smaller set, then any set.
519         if (Variant1.isSizeStrictlySmallerThan(Variant2))
520           EXPECT_EQ(Variant1, SmallestCR);
521         else if (Variant2.isSizeStrictlySmallerThan(Variant1))
522           EXPECT_EQ(Variant2, SmallestCR);
523         else
524           EXPECT_TRUE(Variant1 == SmallestCR || Variant2 == SmallestCR);
525 
526         // Unsigned: Non-wrapped set, then smaller set, then any set.
527         bool Variant1Full = Variant1.isFullSet() || Variant1.isWrappedSet();
528         bool Variant2Full = Variant2.isFullSet() || Variant2.isWrappedSet();
529         if (!Variant1Full && Variant2Full)
530           EXPECT_EQ(Variant1, UnsignedCR);
531         else if (Variant1Full && !Variant2Full)
532           EXPECT_EQ(Variant2, UnsignedCR);
533         else if (Variant1.isSizeStrictlySmallerThan(Variant2))
534           EXPECT_EQ(Variant1, UnsignedCR);
535         else if (Variant2.isSizeStrictlySmallerThan(Variant1))
536           EXPECT_EQ(Variant2, UnsignedCR);
537         else
538           EXPECT_TRUE(Variant1 == UnsignedCR || Variant2 == UnsignedCR);
539 
540         // Signed: Signed non-wrapped set, then smaller set, then any set.
541         Variant1Full = Variant1.isFullSet() || Variant1.isSignWrappedSet();
542         Variant2Full = Variant2.isFullSet() || Variant2.isSignWrappedSet();
543         if (!Variant1Full && Variant2Full)
544           EXPECT_EQ(Variant1, SignedCR);
545         else if (Variant1Full && !Variant2Full)
546           EXPECT_EQ(Variant2, SignedCR);
547         else if (Variant1.isSizeStrictlySmallerThan(Variant2))
548           EXPECT_EQ(Variant1, SignedCR);
549         else if (Variant2.isSizeStrictlySmallerThan(Variant1))
550           EXPECT_EQ(Variant2, SignedCR);
551         else
552           EXPECT_TRUE(Variant1 == SignedCR || Variant2 == SignedCR);
553       });
554 }
555 
TEST_F(ConstantRangeTest,IntersectWithExhaustive)556 TEST_F(ConstantRangeTest, IntersectWithExhaustive) {
557   testBinarySetOperationExhaustive(
558       [](const ConstantRange &CR1, const ConstantRange &CR2,
559          ConstantRange::PreferredRangeType Type) {
560         return CR1.intersectWith(CR2, Type);
561       },
562       [](const ConstantRange &CR1, const ConstantRange &CR2, const APInt &N) {
563         return CR1.contains(N) && CR2.contains(N);
564       });
565 }
566 
TEST_F(ConstantRangeTest,UnionWithExhaustive)567 TEST_F(ConstantRangeTest, UnionWithExhaustive) {
568   testBinarySetOperationExhaustive(
569       [](const ConstantRange &CR1, const ConstantRange &CR2,
570          ConstantRange::PreferredRangeType Type) {
571         return CR1.unionWith(CR2, Type);
572       },
573       [](const ConstantRange &CR1, const ConstantRange &CR2, const APInt &N) {
574         return CR1.contains(N) || CR2.contains(N);
575       });
576 }
577 
TEST_F(ConstantRangeTest,UnionWith)578 TEST_F(ConstantRangeTest, UnionWith) {
579   EXPECT_EQ(Wrap.unionWith(One),
580             ConstantRange(APInt(16, 0xaaa), APInt(16, 0xb)));
581   EXPECT_EQ(One.unionWith(Wrap), Wrap.unionWith(One));
582   EXPECT_EQ(Empty.unionWith(Empty), Empty);
583   EXPECT_EQ(Full.unionWith(Full), Full);
584   EXPECT_EQ(Some.unionWith(Wrap), Full);
585 
586   // PR4545
587   EXPECT_EQ(ConstantRange(APInt(16, 14), APInt(16, 1)).unionWith(
588                                     ConstantRange(APInt(16, 0), APInt(16, 8))),
589             ConstantRange(APInt(16, 14), APInt(16, 8)));
590   EXPECT_EQ(ConstantRange(APInt(16, 6), APInt(16, 4)).unionWith(
591                                     ConstantRange(APInt(16, 4), APInt(16, 0))),
592             ConstantRange::getFull(16));
593   EXPECT_EQ(ConstantRange(APInt(16, 1), APInt(16, 0)).unionWith(
594                                     ConstantRange(APInt(16, 2), APInt(16, 1))),
595             ConstantRange::getFull(16));
596 }
597 
TEST_F(ConstantRangeTest,SetDifference)598 TEST_F(ConstantRangeTest, SetDifference) {
599   EXPECT_EQ(Full.difference(Empty), Full);
600   EXPECT_EQ(Full.difference(Full), Empty);
601   EXPECT_EQ(Empty.difference(Empty), Empty);
602   EXPECT_EQ(Empty.difference(Full), Empty);
603 
604   ConstantRange A(APInt(16, 3), APInt(16, 7));
605   ConstantRange B(APInt(16, 5), APInt(16, 9));
606   ConstantRange C(APInt(16, 3), APInt(16, 5));
607   ConstantRange D(APInt(16, 7), APInt(16, 9));
608   ConstantRange E(APInt(16, 5), APInt(16, 4));
609   ConstantRange F(APInt(16, 7), APInt(16, 3));
610   EXPECT_EQ(A.difference(B), C);
611   EXPECT_EQ(B.difference(A), D);
612   EXPECT_EQ(E.difference(A), F);
613 }
614 
TEST_F(ConstantRangeTest,SubtractAPInt)615 TEST_F(ConstantRangeTest, SubtractAPInt) {
616   EXPECT_EQ(Full.subtract(APInt(16, 4)), Full);
617   EXPECT_EQ(Empty.subtract(APInt(16, 4)), Empty);
618   EXPECT_EQ(Some.subtract(APInt(16, 4)),
619             ConstantRange(APInt(16, 0x6), APInt(16, 0xaa6)));
620   EXPECT_EQ(Wrap.subtract(APInt(16, 4)),
621             ConstantRange(APInt(16, 0xaa6), APInt(16, 0x6)));
622   EXPECT_EQ(One.subtract(APInt(16, 4)),
623             ConstantRange(APInt(16, 0x6)));
624 }
625 
TEST_F(ConstantRangeTest,Add)626 TEST_F(ConstantRangeTest, Add) {
627   EXPECT_EQ(Full.add(APInt(16, 4)), Full);
628   EXPECT_EQ(Full.add(Full), Full);
629   EXPECT_EQ(Full.add(Empty), Empty);
630   EXPECT_EQ(Full.add(One), Full);
631   EXPECT_EQ(Full.add(Some), Full);
632   EXPECT_EQ(Full.add(Wrap), Full);
633   EXPECT_EQ(Empty.add(Empty), Empty);
634   EXPECT_EQ(Empty.add(One), Empty);
635   EXPECT_EQ(Empty.add(Some), Empty);
636   EXPECT_EQ(Empty.add(Wrap), Empty);
637   EXPECT_EQ(Empty.add(APInt(16, 4)), Empty);
638   EXPECT_EQ(Some.add(APInt(16, 4)),
639             ConstantRange(APInt(16, 0xe), APInt(16, 0xaae)));
640   EXPECT_EQ(Wrap.add(APInt(16, 4)),
641             ConstantRange(APInt(16, 0xaae), APInt(16, 0xe)));
642   EXPECT_EQ(One.add(APInt(16, 4)),
643             ConstantRange(APInt(16, 0xe)));
644 }
645 
646 template <typename Fn1, typename Fn2>
TestAddWithNoSignedWrapExhaustive(Fn1 RangeFn,Fn2 IntFn)647 static void TestAddWithNoSignedWrapExhaustive(Fn1 RangeFn, Fn2 IntFn) {
648   unsigned Bits = 4;
649   EnumerateTwoConstantRanges(Bits, [&](const ConstantRange &CR1,
650                                        const ConstantRange &CR2) {
651     ConstantRange CR = RangeFn(CR1, CR2);
652     APInt Min = APInt::getSignedMaxValue(Bits);
653     APInt Max = APInt::getSignedMinValue(Bits);
654     bool AllOverflow = true;
655     ForeachNumInConstantRange(CR1, [&](const APInt &N1) {
656       ForeachNumInConstantRange(CR2, [&](const APInt &N2) {
657         bool IsOverflow = false;
658         APInt N = IntFn(IsOverflow, N1, N2);
659         if (!IsOverflow) {
660           AllOverflow = false;
661           if (N.slt(Min))
662             Min = N;
663           if (N.sgt(Max))
664             Max = N;
665           EXPECT_TRUE(CR.contains(N));
666         }
667       });
668     });
669 
670     EXPECT_EQ(CR.isEmptySet(), AllOverflow);
671 
672     if (!CR1.isSignWrappedSet() && !CR2.isSignWrappedSet()) {
673       if (Min.sgt(Max)) {
674         EXPECT_TRUE(CR.isEmptySet());
675         return;
676       }
677 
678       ConstantRange Exact = ConstantRange::getNonEmpty(Min, Max + 1);
679       EXPECT_EQ(Exact, CR);
680     }
681   });
682 }
683 
684 template <typename Fn1, typename Fn2>
TestAddWithNoUnsignedWrapExhaustive(Fn1 RangeFn,Fn2 IntFn)685 static void TestAddWithNoUnsignedWrapExhaustive(Fn1 RangeFn, Fn2 IntFn) {
686   unsigned Bits = 4;
687   EnumerateTwoConstantRanges(Bits, [&](const ConstantRange &CR1,
688                                        const ConstantRange &CR2) {
689     ConstantRange CR = RangeFn(CR1, CR2);
690     APInt Min = APInt::getMaxValue(Bits);
691     APInt Max = APInt::getMinValue(Bits);
692     bool AllOverflow = true;
693     ForeachNumInConstantRange(CR1, [&](const APInt &N1) {
694       ForeachNumInConstantRange(CR2, [&](const APInt &N2) {
695         bool IsOverflow = false;
696         APInt N = IntFn(IsOverflow, N1, N2);
697         if (!IsOverflow) {
698           AllOverflow = false;
699           if (N.ult(Min))
700             Min = N;
701           if (N.ugt(Max))
702             Max = N;
703           EXPECT_TRUE(CR.contains(N));
704         }
705       });
706     });
707 
708     EXPECT_EQ(CR.isEmptySet(), AllOverflow);
709 
710     if (!CR1.isWrappedSet() && !CR2.isWrappedSet()) {
711       if (Min.ugt(Max)) {
712         EXPECT_TRUE(CR.isEmptySet());
713         return;
714       }
715 
716       ConstantRange Exact = ConstantRange::getNonEmpty(Min, Max + 1);
717       EXPECT_EQ(Exact, CR);
718     }
719   });
720 }
721 
722 template <typename Fn1, typename Fn2, typename Fn3>
TestAddWithNoSignedUnsignedWrapExhaustive(Fn1 RangeFn,Fn2 IntFnSigned,Fn3 IntFnUnsigned)723 static void TestAddWithNoSignedUnsignedWrapExhaustive(Fn1 RangeFn,
724                                                       Fn2 IntFnSigned,
725                                                       Fn3 IntFnUnsigned) {
726   unsigned Bits = 4;
727   EnumerateTwoConstantRanges(
728       Bits, [&](const ConstantRange &CR1, const ConstantRange &CR2) {
729         ConstantRange CR = RangeFn(CR1, CR2);
730         APInt UMin = APInt::getMaxValue(Bits);
731         APInt UMax = APInt::getMinValue(Bits);
732         APInt SMin = APInt::getSignedMaxValue(Bits);
733         APInt SMax = APInt::getSignedMinValue(Bits);
734         bool AllOverflow = true;
735         ForeachNumInConstantRange(CR1, [&](const APInt &N1) {
736           ForeachNumInConstantRange(CR2, [&](const APInt &N2) {
737             bool IsOverflow = false, IsSignedOverflow = false;
738             APInt N = IntFnSigned(IsSignedOverflow, N1, N2);
739             (void) IntFnUnsigned(IsOverflow, N1, N2);
740             if (!IsSignedOverflow && !IsOverflow) {
741               AllOverflow = false;
742               if (N.slt(SMin))
743                 SMin = N;
744               if (N.sgt(SMax))
745                 SMax = N;
746               if (N.ult(UMin))
747                 UMin = N;
748               if (N.ugt(UMax))
749                 UMax = N;
750               EXPECT_TRUE(CR.contains(N));
751             }
752           });
753         });
754 
755         EXPECT_EQ(CR.isEmptySet(), AllOverflow);
756 
757         if (!CR1.isWrappedSet() && !CR2.isWrappedSet() &&
758             !CR1.isSignWrappedSet() && !CR2.isSignWrappedSet()) {
759           if (UMin.ugt(UMax) || SMin.sgt(SMax)) {
760             EXPECT_TRUE(CR.isEmptySet());
761             return;
762           }
763 
764           ConstantRange Exact =
765               ConstantRange::getNonEmpty(SMin, SMax + 1)
766                   .intersectWith(ConstantRange::getNonEmpty(UMin, UMax + 1));
767           EXPECT_EQ(Exact, CR);
768         }
769       });
770 }
771 
TEST_F(ConstantRangeTest,AddWithNoWrap)772 TEST_F(ConstantRangeTest, AddWithNoWrap) {
773   typedef OverflowingBinaryOperator OBO;
774   EXPECT_EQ(Empty.addWithNoWrap(Some, OBO::NoSignedWrap), Empty);
775   EXPECT_EQ(Some.addWithNoWrap(Empty, OBO::NoSignedWrap), Empty);
776   EXPECT_EQ(Full.addWithNoWrap(Full, OBO::NoSignedWrap), Full);
777   EXPECT_NE(Full.addWithNoWrap(Some, OBO::NoSignedWrap), Full);
778   EXPECT_NE(Some.addWithNoWrap(Full, OBO::NoSignedWrap), Full);
779   EXPECT_EQ(Full.addWithNoWrap(ConstantRange(APInt(16, 1), APInt(16, 2)),
780                                OBO::NoSignedWrap),
781             ConstantRange(APInt(16, INT16_MIN + 1), APInt(16, INT16_MIN)));
782   EXPECT_EQ(ConstantRange(APInt(16, 1), APInt(16, 2))
783                 .addWithNoWrap(Full, OBO::NoSignedWrap),
784             ConstantRange(APInt(16, INT16_MIN + 1), APInt(16, INT16_MIN)));
785   EXPECT_EQ(Full.addWithNoWrap(ConstantRange(APInt(16, -1), APInt(16, 0)),
786                                OBO::NoSignedWrap),
787             ConstantRange(APInt(16, INT16_MIN), APInt(16, INT16_MAX)));
788   EXPECT_EQ(ConstantRange(APInt(8, 100), APInt(8, 120))
789                 .addWithNoWrap(ConstantRange(APInt(8, 120), APInt(8, 123)),
790                                OBO::NoSignedWrap),
791             ConstantRange(8, false));
792   EXPECT_EQ(ConstantRange(APInt(8, -120), APInt(8, -100))
793                 .addWithNoWrap(ConstantRange(APInt(8, -110), APInt(8, -100)),
794                                OBO::NoSignedWrap),
795             ConstantRange(8, false));
796   EXPECT_EQ(ConstantRange(APInt(8, 0), APInt(8, 101))
797                 .addWithNoWrap(ConstantRange(APInt(8, -128), APInt(8, 28)),
798                                OBO::NoSignedWrap),
799             ConstantRange(8, true));
800   EXPECT_EQ(ConstantRange(APInt(8, 0), APInt(8, 101))
801                 .addWithNoWrap(ConstantRange(APInt(8, -120), APInt(8, 29)),
802                                OBO::NoSignedWrap),
803             ConstantRange(APInt(8, -120), APInt(8, -128)));
804   EXPECT_EQ(ConstantRange(APInt(8, -50), APInt(8, 50))
805                 .addWithNoWrap(ConstantRange(APInt(8, 10), APInt(8, 20)),
806                                OBO::NoSignedWrap),
807             ConstantRange(APInt(8, -40), APInt(8, 69)));
808   EXPECT_EQ(ConstantRange(APInt(8, 10), APInt(8, 20))
809                 .addWithNoWrap(ConstantRange(APInt(8, -50), APInt(8, 50)),
810                                OBO::NoSignedWrap),
811             ConstantRange(APInt(8, -40), APInt(8, 69)));
812   EXPECT_EQ(ConstantRange(APInt(8, 120), APInt(8, -10))
813                 .addWithNoWrap(ConstantRange(APInt(8, 5), APInt(8, 20)),
814                                OBO::NoSignedWrap),
815             ConstantRange(APInt(8, 125), APInt(8, 9)));
816   EXPECT_EQ(ConstantRange(APInt(8, 5), APInt(8, 20))
817                 .addWithNoWrap(ConstantRange(APInt(8, 120), APInt(8, -10)),
818                                OBO::NoSignedWrap),
819             ConstantRange(APInt(8, 125), APInt(8, 9)));
820 
821   TestAddWithNoSignedWrapExhaustive(
822       [](const ConstantRange &CR1, const ConstantRange &CR2) {
823         return CR1.addWithNoWrap(CR2, OBO::NoSignedWrap);
824       },
825       [](bool &IsOverflow, const APInt &N1, const APInt &N2) {
826         return N1.sadd_ov(N2, IsOverflow);
827       });
828 
829   EXPECT_EQ(Empty.addWithNoWrap(Some, OBO::NoUnsignedWrap), Empty);
830   EXPECT_EQ(Some.addWithNoWrap(Empty, OBO::NoUnsignedWrap), Empty);
831   EXPECT_EQ(Full.addWithNoWrap(Full, OBO::NoUnsignedWrap), Full);
832   EXPECT_NE(Full.addWithNoWrap(Some, OBO::NoUnsignedWrap), Full);
833   EXPECT_NE(Some.addWithNoWrap(Full, OBO::NoUnsignedWrap), Full);
834   EXPECT_EQ(Full.addWithNoWrap(ConstantRange(APInt(16, 1), APInt(16, 2)),
835                                OBO::NoUnsignedWrap),
836             ConstantRange(APInt(16, 1), APInt(16, 0)));
837   EXPECT_EQ(ConstantRange(APInt(16, 1), APInt(16, 2))
838                 .addWithNoWrap(Full, OBO::NoUnsignedWrap),
839             ConstantRange(APInt(16, 1), APInt(16, 0)));
840   EXPECT_EQ(ConstantRange(APInt(8, 200), APInt(8, 220))
841                 .addWithNoWrap(ConstantRange(APInt(8, 100), APInt(8, 123)),
842                                OBO::NoUnsignedWrap),
843             ConstantRange(8, false));
844   EXPECT_EQ(ConstantRange(APInt(8, 0), APInt(8, 101))
845                 .addWithNoWrap(ConstantRange(APInt(8, 0), APInt(8, 156)),
846                                OBO::NoUnsignedWrap),
847             ConstantRange(8, true));
848   EXPECT_EQ(ConstantRange(APInt(8, 0), APInt(8, 101))
849                 .addWithNoWrap(ConstantRange(APInt(8, 10), APInt(8, 29)),
850                                OBO::NoUnsignedWrap),
851             ConstantRange(APInt(8, 10), APInt(8, 129)));
852   EXPECT_EQ(ConstantRange(APInt(8, 20), APInt(8, 10))
853                 .addWithNoWrap(ConstantRange(APInt(8, 50), APInt(8, 200)),
854                                OBO::NoUnsignedWrap),
855             ConstantRange(APInt(8, 50), APInt(8, 0)));
856   EXPECT_EQ(ConstantRange(APInt(8, 10), APInt(8, 20))
857                 .addWithNoWrap(ConstantRange(APInt(8, 50), APInt(8, 200)),
858                                OBO::NoUnsignedWrap),
859             ConstantRange(APInt(8, 60), APInt(8, -37)));
860   EXPECT_EQ(ConstantRange(APInt(8, 20), APInt(8, -30))
861                 .addWithNoWrap(ConstantRange(APInt(8, 5), APInt(8, 20)),
862                                OBO::NoUnsignedWrap),
863             ConstantRange(APInt(8, 25), APInt(8, -11)));
864   EXPECT_EQ(ConstantRange(APInt(8, 5), APInt(8, 20))
865                 .addWithNoWrap(ConstantRange(APInt(8, 20), APInt(8, -30)),
866                                OBO::NoUnsignedWrap),
867             ConstantRange(APInt(8, 25), APInt(8, -11)));
868 
869   TestAddWithNoUnsignedWrapExhaustive(
870       [](const ConstantRange &CR1, const ConstantRange &CR2) {
871         return CR1.addWithNoWrap(CR2, OBO::NoUnsignedWrap);
872       },
873       [](bool &IsOverflow, const APInt &N1, const APInt &N2) {
874         return N1.uadd_ov(N2, IsOverflow);
875       });
876 
877   EXPECT_EQ(ConstantRange(APInt(8, 50), APInt(8, 100))
878                 .addWithNoWrap(ConstantRange(APInt(8, 20), APInt(8, 70)),
879                                OBO::NoSignedWrap),
880             ConstantRange(APInt(8, 70), APInt(8, -128)));
881   EXPECT_EQ(ConstantRange(APInt(8, 50), APInt(8, 100))
882                 .addWithNoWrap(ConstantRange(APInt(8, 20), APInt(8, 70)),
883                                OBO::NoUnsignedWrap),
884             ConstantRange(APInt(8, 70), APInt(8, 169)));
885   EXPECT_EQ(ConstantRange(APInt(8, 50), APInt(8, 100))
886                 .addWithNoWrap(ConstantRange(APInt(8, 20), APInt(8, 70)),
887                                OBO::NoUnsignedWrap | OBO::NoSignedWrap),
888             ConstantRange(APInt(8, 70), APInt(8, -128)));
889 
890   EXPECT_EQ(ConstantRange(APInt(8, -100), APInt(8, -50))
891                 .addWithNoWrap(ConstantRange(APInt(8, 20), APInt(8, 30)),
892                                OBO::NoSignedWrap),
893             ConstantRange(APInt(8, -80), APInt(8, -21)));
894   EXPECT_EQ(ConstantRange(APInt(8, -100), APInt(8, -50))
895                 .addWithNoWrap(ConstantRange(APInt(8, 20), APInt(8, 30)),
896                                OBO::NoUnsignedWrap),
897             ConstantRange(APInt(8, 176), APInt(8, 235)));
898   EXPECT_EQ(ConstantRange(APInt(8, -100), APInt(8, -50))
899                 .addWithNoWrap(ConstantRange(APInt(8, 20), APInt(8, 30)),
900                                OBO::NoUnsignedWrap | OBO::NoSignedWrap),
901             ConstantRange(APInt(8, 176), APInt(8, 235)));
902 
903   TestAddWithNoSignedUnsignedWrapExhaustive(
904       [](const ConstantRange &CR1, const ConstantRange &CR2) {
905         return CR1.addWithNoWrap(CR2, OBO::NoUnsignedWrap | OBO::NoSignedWrap);
906       },
907       [](bool &IsOverflow, const APInt &N1, const APInt &N2) {
908         return N1.sadd_ov(N2, IsOverflow);
909       },
910       [](bool &IsOverflow, const APInt &N1, const APInt &N2) {
911         return N1.uadd_ov(N2, IsOverflow);
912       });
913 }
914 
TEST_F(ConstantRangeTest,Sub)915 TEST_F(ConstantRangeTest, Sub) {
916   EXPECT_EQ(Full.sub(APInt(16, 4)), Full);
917   EXPECT_EQ(Full.sub(Full), Full);
918   EXPECT_EQ(Full.sub(Empty), Empty);
919   EXPECT_EQ(Full.sub(One), Full);
920   EXPECT_EQ(Full.sub(Some), Full);
921   EXPECT_EQ(Full.sub(Wrap), Full);
922   EXPECT_EQ(Empty.sub(Empty), Empty);
923   EXPECT_EQ(Empty.sub(One), Empty);
924   EXPECT_EQ(Empty.sub(Some), Empty);
925   EXPECT_EQ(Empty.sub(Wrap), Empty);
926   EXPECT_EQ(Empty.sub(APInt(16, 4)), Empty);
927   EXPECT_EQ(Some.sub(APInt(16, 4)),
928             ConstantRange(APInt(16, 0x6), APInt(16, 0xaa6)));
929   EXPECT_EQ(Some.sub(Some),
930             ConstantRange(APInt(16, 0xf561), APInt(16, 0xaa0)));
931   EXPECT_EQ(Wrap.sub(APInt(16, 4)),
932             ConstantRange(APInt(16, 0xaa6), APInt(16, 0x6)));
933   EXPECT_EQ(One.sub(APInt(16, 4)),
934             ConstantRange(APInt(16, 0x6)));
935 }
936 
TEST_F(ConstantRangeTest,SubWithNoWrap)937 TEST_F(ConstantRangeTest, SubWithNoWrap) {
938   typedef OverflowingBinaryOperator OBO;
939   TestAddWithNoSignedWrapExhaustive(
940       [](const ConstantRange &CR1, const ConstantRange &CR2) {
941         return CR1.subWithNoWrap(CR2, OBO::NoSignedWrap);
942       },
943       [](bool &IsOverflow, const APInt &N1, const APInt &N2) {
944         return N1.ssub_ov(N2, IsOverflow);
945       });
946   TestAddWithNoUnsignedWrapExhaustive(
947       [](const ConstantRange &CR1, const ConstantRange &CR2) {
948         return CR1.subWithNoWrap(CR2, OBO::NoUnsignedWrap);
949       },
950       [](bool &IsOverflow, const APInt &N1, const APInt &N2) {
951         return N1.usub_ov(N2, IsOverflow);
952       });
953   TestAddWithNoSignedUnsignedWrapExhaustive(
954       [](const ConstantRange &CR1, const ConstantRange &CR2) {
955         return CR1.subWithNoWrap(CR2, OBO::NoUnsignedWrap | OBO::NoSignedWrap);
956       },
957       [](bool &IsOverflow, const APInt &N1, const APInt &N2) {
958         return N1.ssub_ov(N2, IsOverflow);
959       },
960       [](bool &IsOverflow, const APInt &N1, const APInt &N2) {
961         return N1.usub_ov(N2, IsOverflow);
962       });
963 }
964 
TEST_F(ConstantRangeTest,Multiply)965 TEST_F(ConstantRangeTest, Multiply) {
966   EXPECT_EQ(Full.multiply(Full), Full);
967   EXPECT_EQ(Full.multiply(Empty), Empty);
968   EXPECT_EQ(Full.multiply(One), Full);
969   EXPECT_EQ(Full.multiply(Some), Full);
970   EXPECT_EQ(Full.multiply(Wrap), Full);
971   EXPECT_EQ(Empty.multiply(Empty), Empty);
972   EXPECT_EQ(Empty.multiply(One), Empty);
973   EXPECT_EQ(Empty.multiply(Some), Empty);
974   EXPECT_EQ(Empty.multiply(Wrap), Empty);
975   EXPECT_EQ(One.multiply(One), ConstantRange(APInt(16, 0xa*0xa),
976                                              APInt(16, 0xa*0xa + 1)));
977   EXPECT_EQ(One.multiply(Some), ConstantRange(APInt(16, 0xa*0xa),
978                                               APInt(16, 0xa*0xaa9 + 1)));
979   EXPECT_EQ(One.multiply(Wrap), Full);
980   EXPECT_EQ(Some.multiply(Some), Full);
981   EXPECT_EQ(Some.multiply(Wrap), Full);
982   EXPECT_EQ(Wrap.multiply(Wrap), Full);
983 
984   ConstantRange Zero(APInt(16, 0));
985   EXPECT_EQ(Zero.multiply(Full), Zero);
986   EXPECT_EQ(Zero.multiply(Some), Zero);
987   EXPECT_EQ(Zero.multiply(Wrap), Zero);
988   EXPECT_EQ(Full.multiply(Zero), Zero);
989   EXPECT_EQ(Some.multiply(Zero), Zero);
990   EXPECT_EQ(Wrap.multiply(Zero), Zero);
991 
992   // http://llvm.org/PR4545
993   EXPECT_EQ(ConstantRange(APInt(4, 1), APInt(4, 6)).multiply(
994                 ConstantRange(APInt(4, 6), APInt(4, 2))),
995             ConstantRange(4, /*isFullSet=*/true));
996 
997   EXPECT_EQ(ConstantRange(APInt(8, 254), APInt(8, 0)).multiply(
998               ConstantRange(APInt(8, 252), APInt(8, 4))),
999             ConstantRange(APInt(8, 250), APInt(8, 9)));
1000   EXPECT_EQ(ConstantRange(APInt(8, 254), APInt(8, 255)).multiply(
1001               ConstantRange(APInt(8, 2), APInt(8, 4))),
1002             ConstantRange(APInt(8, 250), APInt(8, 253)));
1003 
1004   // TODO: This should be return [-2, 0]
1005   EXPECT_EQ(ConstantRange(APInt(8, -2)).multiply(
1006               ConstantRange(APInt(8, 0), APInt(8, 2))),
1007             ConstantRange(APInt(8, -2), APInt(8, 1)));
1008 }
1009 
TEST_F(ConstantRangeTest,UMax)1010 TEST_F(ConstantRangeTest, UMax) {
1011   EXPECT_EQ(Full.umax(Full), Full);
1012   EXPECT_EQ(Full.umax(Empty), Empty);
1013   EXPECT_EQ(Full.umax(Some), ConstantRange(APInt(16, 0xa), APInt(16, 0)));
1014   EXPECT_EQ(Full.umax(Wrap), Full);
1015   EXPECT_EQ(Full.umax(Some), ConstantRange(APInt(16, 0xa), APInt(16, 0)));
1016   EXPECT_EQ(Empty.umax(Empty), Empty);
1017   EXPECT_EQ(Empty.umax(Some), Empty);
1018   EXPECT_EQ(Empty.umax(Wrap), Empty);
1019   EXPECT_EQ(Empty.umax(One), Empty);
1020   EXPECT_EQ(Some.umax(Some), Some);
1021   EXPECT_EQ(Some.umax(Wrap), ConstantRange(APInt(16, 0xa), APInt(16, 0)));
1022   EXPECT_EQ(Some.umax(One), Some);
1023   // TODO: ConstantRange is currently over-conservative here.
1024   EXPECT_EQ(Wrap.umax(Wrap), Full);
1025   EXPECT_EQ(Wrap.umax(One), ConstantRange(APInt(16, 0xa), APInt(16, 0)));
1026   EXPECT_EQ(One.umax(One), One);
1027 }
1028 
TEST_F(ConstantRangeTest,SMax)1029 TEST_F(ConstantRangeTest, SMax) {
1030   EXPECT_EQ(Full.smax(Full), Full);
1031   EXPECT_EQ(Full.smax(Empty), Empty);
1032   EXPECT_EQ(Full.smax(Some), ConstantRange(APInt(16, 0xa),
1033                                            APInt::getSignedMinValue(16)));
1034   EXPECT_EQ(Full.smax(Wrap), Full);
1035   EXPECT_EQ(Full.smax(One), ConstantRange(APInt(16, 0xa),
1036                                           APInt::getSignedMinValue(16)));
1037   EXPECT_EQ(Empty.smax(Empty), Empty);
1038   EXPECT_EQ(Empty.smax(Some), Empty);
1039   EXPECT_EQ(Empty.smax(Wrap), Empty);
1040   EXPECT_EQ(Empty.smax(One), Empty);
1041   EXPECT_EQ(Some.smax(Some), Some);
1042   EXPECT_EQ(Some.smax(Wrap), ConstantRange(APInt(16, 0xa),
1043                                            APInt(16, (uint64_t)INT16_MIN)));
1044   EXPECT_EQ(Some.smax(One), Some);
1045   EXPECT_EQ(Wrap.smax(One), ConstantRange(APInt(16, 0xa),
1046                                           APInt(16, (uint64_t)INT16_MIN)));
1047   EXPECT_EQ(One.smax(One), One);
1048 }
1049 
TEST_F(ConstantRangeTest,UMin)1050 TEST_F(ConstantRangeTest, UMin) {
1051   EXPECT_EQ(Full.umin(Full), Full);
1052   EXPECT_EQ(Full.umin(Empty), Empty);
1053   EXPECT_EQ(Full.umin(Some), ConstantRange(APInt(16, 0), APInt(16, 0xaaa)));
1054   EXPECT_EQ(Full.umin(Wrap), Full);
1055   EXPECT_EQ(Empty.umin(Empty), Empty);
1056   EXPECT_EQ(Empty.umin(Some), Empty);
1057   EXPECT_EQ(Empty.umin(Wrap), Empty);
1058   EXPECT_EQ(Empty.umin(One), Empty);
1059   EXPECT_EQ(Some.umin(Some), Some);
1060   EXPECT_EQ(Some.umin(Wrap), ConstantRange(APInt(16, 0), APInt(16, 0xaaa)));
1061   EXPECT_EQ(Some.umin(One), One);
1062   // TODO: ConstantRange is currently over-conservative here.
1063   EXPECT_EQ(Wrap.umin(Wrap), Full);
1064   EXPECT_EQ(Wrap.umin(One), ConstantRange(APInt(16, 0), APInt(16, 0xb)));
1065   EXPECT_EQ(One.umin(One), One);
1066 }
1067 
TEST_F(ConstantRangeTest,SMin)1068 TEST_F(ConstantRangeTest, SMin) {
1069   EXPECT_EQ(Full.smin(Full), Full);
1070   EXPECT_EQ(Full.smin(Empty), Empty);
1071   EXPECT_EQ(Full.smin(Some), ConstantRange(APInt(16, (uint64_t)INT16_MIN),
1072                                            APInt(16, 0xaaa)));
1073   EXPECT_EQ(Full.smin(Wrap), Full);
1074   EXPECT_EQ(Empty.smin(Empty), Empty);
1075   EXPECT_EQ(Empty.smin(Some), Empty);
1076   EXPECT_EQ(Empty.smin(Wrap), Empty);
1077   EXPECT_EQ(Empty.smin(One), Empty);
1078   EXPECT_EQ(Some.smin(Some), Some);
1079   EXPECT_EQ(Some.smin(Wrap), ConstantRange(APInt(16, (uint64_t)INT16_MIN),
1080                                            APInt(16, 0xaaa)));
1081   EXPECT_EQ(Some.smin(One), One);
1082   // TODO: ConstantRange is currently over-conservative here.
1083   EXPECT_EQ(Wrap.smin(Wrap), Full);
1084   EXPECT_EQ(Wrap.smin(One), ConstantRange(APInt(16, (uint64_t)INT16_MIN),
1085                                           APInt(16, 0xb)));
1086   EXPECT_EQ(One.smin(One), One);
1087 }
1088 
TEST_F(ConstantRangeTest,UDiv)1089 TEST_F(ConstantRangeTest, UDiv) {
1090   EXPECT_EQ(Full.udiv(Full), Full);
1091   EXPECT_EQ(Full.udiv(Empty), Empty);
1092   EXPECT_EQ(Full.udiv(One), ConstantRange(APInt(16, 0),
1093                                           APInt(16, 0xffff / 0xa + 1)));
1094   EXPECT_EQ(Full.udiv(Some), ConstantRange(APInt(16, 0),
1095                                            APInt(16, 0xffff / 0xa + 1)));
1096   EXPECT_EQ(Full.udiv(Wrap), Full);
1097   EXPECT_EQ(Empty.udiv(Empty), Empty);
1098   EXPECT_EQ(Empty.udiv(One), Empty);
1099   EXPECT_EQ(Empty.udiv(Some), Empty);
1100   EXPECT_EQ(Empty.udiv(Wrap), Empty);
1101   EXPECT_EQ(One.udiv(One), ConstantRange(APInt(16, 1)));
1102   EXPECT_EQ(One.udiv(Some), ConstantRange(APInt(16, 0), APInt(16, 2)));
1103   EXPECT_EQ(One.udiv(Wrap), ConstantRange(APInt(16, 0), APInt(16, 0xb)));
1104   EXPECT_EQ(Some.udiv(Some), ConstantRange(APInt(16, 0), APInt(16, 0x111)));
1105   EXPECT_EQ(Some.udiv(Wrap), ConstantRange(APInt(16, 0), APInt(16, 0xaaa)));
1106   EXPECT_EQ(Wrap.udiv(Wrap), Full);
1107 
1108 
1109   ConstantRange Zero(APInt(16, 0));
1110   EXPECT_EQ(Zero.udiv(One), Zero);
1111   EXPECT_EQ(Zero.udiv(Full), Zero);
1112 
1113   EXPECT_EQ(ConstantRange(APInt(16, 0), APInt(16, 99)).udiv(Full),
1114             ConstantRange(APInt(16, 0), APInt(16, 99)));
1115   EXPECT_EQ(ConstantRange(APInt(16, 10), APInt(16, 99)).udiv(Full),
1116             ConstantRange(APInt(16, 0), APInt(16, 99)));
1117 }
1118 
TEST_F(ConstantRangeTest,SDiv)1119 TEST_F(ConstantRangeTest, SDiv) {
1120   unsigned Bits = 4;
1121   EnumerateTwoConstantRanges(Bits, [&](const ConstantRange &CR1,
1122                                        const ConstantRange &CR2) {
1123     // Collect possible results in a bit vector. We store the signed value plus
1124     // a bias to make it unsigned.
1125     int Bias = 1 << (Bits - 1);
1126     BitVector Results(1 << Bits);
1127     ForeachNumInConstantRange(CR1, [&](const APInt &N1) {
1128       ForeachNumInConstantRange(CR2, [&](const APInt &N2) {
1129         // Division by zero is UB.
1130         if (N2 == 0)
1131           return;
1132 
1133         // SignedMin / -1 is UB.
1134         if (N1.isMinSignedValue() && N2.isAllOnesValue())
1135           return;
1136 
1137         APInt N = N1.sdiv(N2);
1138         Results.set(N.getSExtValue() + Bias);
1139       });
1140     });
1141 
1142     ConstantRange CR = CR1.sdiv(CR2);
1143     if (Results.none()) {
1144       EXPECT_TRUE(CR.isEmptySet());
1145       return;
1146     }
1147 
1148     // If there is a non-full signed envelope, that should be the result.
1149     APInt SMin(Bits, Results.find_first() - Bias);
1150     APInt SMax(Bits, Results.find_last() - Bias);
1151     ConstantRange Envelope = ConstantRange::getNonEmpty(SMin, SMax + 1);
1152     if (!Envelope.isFullSet()) {
1153       EXPECT_EQ(Envelope, CR);
1154       return;
1155     }
1156 
1157     // If the signed envelope is a full set, try to find a smaller sign wrapped
1158     // set that is separated in negative and positive components (or one which
1159     // can also additionally contain zero).
1160     int LastNeg = Results.find_last_in(0, Bias) - Bias;
1161     int LastPos = Results.find_next(Bias) - Bias;
1162     if (Results[Bias]) {
1163       if (LastNeg == -1)
1164         ++LastNeg;
1165       else if (LastPos == 1)
1166         --LastPos;
1167     }
1168 
1169     APInt WMax(Bits, LastNeg);
1170     APInt WMin(Bits, LastPos);
1171     ConstantRange Wrapped = ConstantRange::getNonEmpty(WMin, WMax + 1);
1172     EXPECT_EQ(Wrapped, CR);
1173   });
1174 }
1175 
TEST_F(ConstantRangeTest,URem)1176 TEST_F(ConstantRangeTest, URem) {
1177   EXPECT_EQ(Full.urem(Empty), Empty);
1178   EXPECT_EQ(Empty.urem(Full), Empty);
1179   // urem by zero is poison.
1180   EXPECT_EQ(Full.urem(ConstantRange(APInt(16, 0))), Empty);
1181   // urem by full range doesn't contain MaxValue.
1182   EXPECT_EQ(Full.urem(Full), ConstantRange(APInt(16, 0), APInt(16, 0xffff)));
1183   // urem is upper bounded by maximum RHS minus one.
1184   EXPECT_EQ(Full.urem(ConstantRange(APInt(16, 0), APInt(16, 123))),
1185             ConstantRange(APInt(16, 0), APInt(16, 122)));
1186   // urem is upper bounded by maximum LHS.
1187   EXPECT_EQ(ConstantRange(APInt(16, 0), APInt(16, 123)).urem(Full),
1188             ConstantRange(APInt(16, 0), APInt(16, 123)));
1189   // If the LHS is always lower than the RHS, the result is the LHS.
1190   EXPECT_EQ(ConstantRange(APInt(16, 10), APInt(16, 20))
1191                 .urem(ConstantRange(APInt(16, 20), APInt(16, 30))),
1192             ConstantRange(APInt(16, 10), APInt(16, 20)));
1193   // It has to be strictly lower, otherwise the top value may wrap to zero.
1194   EXPECT_EQ(ConstantRange(APInt(16, 10), APInt(16, 20))
1195                 .urem(ConstantRange(APInt(16, 19), APInt(16, 30))),
1196             ConstantRange(APInt(16, 0), APInt(16, 20)));
1197   // [12, 14] % 10 is [2, 4], but we conservatively compute [0, 9].
1198   EXPECT_EQ(ConstantRange(APInt(16, 12), APInt(16, 15))
1199                 .urem(ConstantRange(APInt(16, 10))),
1200             ConstantRange(APInt(16, 0), APInt(16, 10)));
1201 
1202   TestUnsignedBinOpExhaustive(
1203       [](const ConstantRange &CR1, const ConstantRange &CR2) {
1204         return CR1.urem(CR2);
1205       },
1206       [](const APInt &N1, const APInt &N2) {
1207         return N1.urem(N2);
1208       },
1209       /* SkipZeroRHS */ true, /* CorrectnessOnly */ true);
1210 }
1211 
TEST_F(ConstantRangeTest,SRem)1212 TEST_F(ConstantRangeTest, SRem) {
1213   EXPECT_EQ(Full.srem(Empty), Empty);
1214   EXPECT_EQ(Empty.srem(Full), Empty);
1215   // srem by zero is UB.
1216   EXPECT_EQ(Full.srem(ConstantRange(APInt(16, 0))), Empty);
1217   // srem by full range doesn't contain SignedMinValue.
1218   EXPECT_EQ(Full.srem(Full), ConstantRange(APInt::getSignedMinValue(16) + 1,
1219                                            APInt::getSignedMinValue(16)));
1220 
1221   ConstantRange PosMod(APInt(16, 10), APInt(16, 21));  // [10, 20]
1222   ConstantRange NegMod(APInt(16, -20), APInt(16, -9)); // [-20, -10]
1223   ConstantRange IntMinMod(APInt::getSignedMinValue(16));
1224 
1225   ConstantRange Expected(16, true);
1226 
1227   // srem is bounded by abs(RHS) minus one.
1228   ConstantRange PosLargeLHS(APInt(16, 0), APInt(16, 41));
1229   Expected = ConstantRange(APInt(16, 0), APInt(16, 20));
1230   EXPECT_EQ(PosLargeLHS.srem(PosMod), Expected);
1231   EXPECT_EQ(PosLargeLHS.srem(NegMod), Expected);
1232   ConstantRange NegLargeLHS(APInt(16, -40), APInt(16, 1));
1233   Expected = ConstantRange(APInt(16, -19), APInt(16, 1));
1234   EXPECT_EQ(NegLargeLHS.srem(PosMod), Expected);
1235   EXPECT_EQ(NegLargeLHS.srem(NegMod), Expected);
1236   ConstantRange PosNegLargeLHS(APInt(16, -32), APInt(16, 38));
1237   Expected = ConstantRange(APInt(16, -19), APInt(16, 20));
1238   EXPECT_EQ(PosNegLargeLHS.srem(PosMod), Expected);
1239   EXPECT_EQ(PosNegLargeLHS.srem(NegMod), Expected);
1240 
1241   // srem is bounded by LHS.
1242   ConstantRange PosLHS(APInt(16, 0), APInt(16, 16));
1243   EXPECT_EQ(PosLHS.srem(PosMod), PosLHS);
1244   EXPECT_EQ(PosLHS.srem(NegMod), PosLHS);
1245   EXPECT_EQ(PosLHS.srem(IntMinMod), PosLHS);
1246   ConstantRange NegLHS(APInt(16, -15), APInt(16, 1));
1247   EXPECT_EQ(NegLHS.srem(PosMod), NegLHS);
1248   EXPECT_EQ(NegLHS.srem(NegMod), NegLHS);
1249   EXPECT_EQ(NegLHS.srem(IntMinMod), NegLHS);
1250   ConstantRange PosNegLHS(APInt(16, -12), APInt(16, 18));
1251   EXPECT_EQ(PosNegLHS.srem(PosMod), PosNegLHS);
1252   EXPECT_EQ(PosNegLHS.srem(NegMod), PosNegLHS);
1253   EXPECT_EQ(PosNegLHS.srem(IntMinMod), PosNegLHS);
1254 
1255   // srem is LHS if it is smaller than RHS.
1256   ConstantRange PosSmallLHS(APInt(16, 3), APInt(16, 8));
1257   EXPECT_EQ(PosSmallLHS.srem(PosMod), PosSmallLHS);
1258   EXPECT_EQ(PosSmallLHS.srem(NegMod), PosSmallLHS);
1259   EXPECT_EQ(PosSmallLHS.srem(IntMinMod), PosSmallLHS);
1260   ConstantRange NegSmallLHS(APInt(16, -7), APInt(16, -2));
1261   EXPECT_EQ(NegSmallLHS.srem(PosMod), NegSmallLHS);
1262   EXPECT_EQ(NegSmallLHS.srem(NegMod), NegSmallLHS);
1263   EXPECT_EQ(NegSmallLHS.srem(IntMinMod), NegSmallLHS);
1264   ConstantRange PosNegSmallLHS(APInt(16, -3), APInt(16, 8));
1265   EXPECT_EQ(PosNegSmallLHS.srem(PosMod), PosNegSmallLHS);
1266   EXPECT_EQ(PosNegSmallLHS.srem(NegMod), PosNegSmallLHS);
1267   EXPECT_EQ(PosNegSmallLHS.srem(IntMinMod), PosNegSmallLHS);
1268 
1269   // Example of a suboptimal result:
1270   // [12, 14] srem 10 is [2, 4], but we conservatively compute [0, 9].
1271   EXPECT_EQ(ConstantRange(APInt(16, 12), APInt(16, 15))
1272                 .srem(ConstantRange(APInt(16, 10))),
1273             ConstantRange(APInt(16, 0), APInt(16, 10)));
1274 
1275   TestSignedBinOpExhaustive(
1276       [](const ConstantRange &CR1, const ConstantRange &CR2) {
1277         return CR1.srem(CR2);
1278       },
1279       [](const APInt &N1, const APInt &N2) {
1280         return N1.srem(N2);
1281       },
1282       /* SkipZeroRHS */ true, /* CorrectnessOnly */ true);
1283 }
1284 
TEST_F(ConstantRangeTest,Shl)1285 TEST_F(ConstantRangeTest, Shl) {
1286   ConstantRange Some2(APInt(16, 0xfff), APInt(16, 0x8000));
1287   ConstantRange WrapNullMax(APInt(16, 0x1), APInt(16, 0x0));
1288   EXPECT_EQ(Full.shl(Full), Full);
1289   EXPECT_EQ(Full.shl(Empty), Empty);
1290   EXPECT_EQ(Full.shl(One), Full);    // TODO: [0, (-1 << 0xa) + 1)
1291   EXPECT_EQ(Full.shl(Some), Full);   // TODO: [0, (-1 << 0xa) + 1)
1292   EXPECT_EQ(Full.shl(Wrap), Full);
1293   EXPECT_EQ(Empty.shl(Empty), Empty);
1294   EXPECT_EQ(Empty.shl(One), Empty);
1295   EXPECT_EQ(Empty.shl(Some), Empty);
1296   EXPECT_EQ(Empty.shl(Wrap), Empty);
1297   EXPECT_EQ(One.shl(One), ConstantRange(APInt(16, 0xa << 0xa),
1298                                         APInt(16, (0xa << 0xa) + 1)));
1299   EXPECT_EQ(One.shl(Some), Full);    // TODO: [0xa << 0xa, 0)
1300   EXPECT_EQ(One.shl(Wrap), Full);    // TODO: [0xa, 0xa << 14 + 1)
1301   EXPECT_EQ(Some.shl(Some), Full);   // TODO: [0xa << 0xa, 0xfc01)
1302   EXPECT_EQ(Some.shl(Wrap), Full);   // TODO: [0xa, 0x7ff << 0x5 + 1)
1303   EXPECT_EQ(Wrap.shl(Wrap), Full);
1304   EXPECT_EQ(
1305       Some2.shl(ConstantRange(APInt(16, 0x1))),
1306       ConstantRange(APInt(16, 0xfff << 0x1), APInt(16, 0x7fff << 0x1) + 1));
1307   EXPECT_EQ(One.shl(WrapNullMax), Full);
1308 }
1309 
TEST_F(ConstantRangeTest,Lshr)1310 TEST_F(ConstantRangeTest, Lshr) {
1311   EXPECT_EQ(Full.lshr(Full), Full);
1312   EXPECT_EQ(Full.lshr(Empty), Empty);
1313   EXPECT_EQ(Full.lshr(One), ConstantRange(APInt(16, 0),
1314                                           APInt(16, (0xffff >> 0xa) + 1)));
1315   EXPECT_EQ(Full.lshr(Some), ConstantRange(APInt(16, 0),
1316                                            APInt(16, (0xffff >> 0xa) + 1)));
1317   EXPECT_EQ(Full.lshr(Wrap), Full);
1318   EXPECT_EQ(Empty.lshr(Empty), Empty);
1319   EXPECT_EQ(Empty.lshr(One), Empty);
1320   EXPECT_EQ(Empty.lshr(Some), Empty);
1321   EXPECT_EQ(Empty.lshr(Wrap), Empty);
1322   EXPECT_EQ(One.lshr(One), ConstantRange(APInt(16, 0)));
1323   EXPECT_EQ(One.lshr(Some), ConstantRange(APInt(16, 0)));
1324   EXPECT_EQ(One.lshr(Wrap), ConstantRange(APInt(16, 0), APInt(16, 0xb)));
1325   EXPECT_EQ(Some.lshr(Some), ConstantRange(APInt(16, 0),
1326                                            APInt(16, (0xaaa >> 0xa) + 1)));
1327   EXPECT_EQ(Some.lshr(Wrap), ConstantRange(APInt(16, 0), APInt(16, 0xaaa)));
1328   EXPECT_EQ(Wrap.lshr(Wrap), Full);
1329 }
1330 
TEST_F(ConstantRangeTest,Ashr)1331 TEST_F(ConstantRangeTest, Ashr) {
1332   EXPECT_EQ(Full.ashr(Full), Full);
1333   EXPECT_EQ(Full.ashr(Empty), Empty);
1334   EXPECT_EQ(Full.ashr(One), ConstantRange(APInt(16, 0xffe0),
1335                                           APInt(16, (0x7fff >> 0xa) + 1 )));
1336   ConstantRange Small(APInt(16, 0xa), APInt(16, 0xb));
1337   EXPECT_EQ(Full.ashr(Small), ConstantRange(APInt(16, 0xffe0),
1338                                            APInt(16, (0x7fff >> 0xa) + 1 )));
1339   EXPECT_EQ(Full.ashr(Some), ConstantRange(APInt(16, 0xffe0),
1340                                            APInt(16, (0x7fff >> 0xa) + 1 )));
1341   EXPECT_EQ(Full.ashr(Wrap), Full);
1342   EXPECT_EQ(Empty.ashr(Empty), Empty);
1343   EXPECT_EQ(Empty.ashr(One), Empty);
1344   EXPECT_EQ(Empty.ashr(Some), Empty);
1345   EXPECT_EQ(Empty.ashr(Wrap), Empty);
1346   EXPECT_EQ(One.ashr(One), ConstantRange(APInt(16, 0)));
1347   EXPECT_EQ(One.ashr(Some), ConstantRange(APInt(16, 0)));
1348   EXPECT_EQ(One.ashr(Wrap), ConstantRange(APInt(16, 0), APInt(16, 0xb)));
1349   EXPECT_EQ(Some.ashr(Some), ConstantRange(APInt(16, 0),
1350                                            APInt(16, (0xaaa >> 0xa) + 1)));
1351   EXPECT_EQ(Some.ashr(Wrap), ConstantRange(APInt(16, 0), APInt(16, 0xaaa)));
1352   EXPECT_EQ(Wrap.ashr(Wrap), Full);
1353   ConstantRange Neg(APInt(16, 0xf3f0, true), APInt(16, 0xf7f8, true));
1354   EXPECT_EQ(Neg.ashr(Small), ConstantRange(APInt(16, 0xfffc, true),
1355                                            APInt(16, 0xfffe, true)));
1356 }
1357 
TEST(ConstantRange,MakeAllowedICmpRegion)1358 TEST(ConstantRange, MakeAllowedICmpRegion) {
1359   // PR8250
1360   ConstantRange SMax = ConstantRange(APInt::getSignedMaxValue(32));
1361   EXPECT_TRUE(ConstantRange::makeAllowedICmpRegion(ICmpInst::ICMP_SGT, SMax)
1362                   .isEmptySet());
1363 }
1364 
TEST(ConstantRange,MakeSatisfyingICmpRegion)1365 TEST(ConstantRange, MakeSatisfyingICmpRegion) {
1366   ConstantRange LowHalf(APInt(8, 0), APInt(8, 128));
1367   ConstantRange HighHalf(APInt(8, 128), APInt(8, 0));
1368   ConstantRange EmptySet(8, /* isFullSet = */ false);
1369 
1370   EXPECT_EQ(ConstantRange::makeSatisfyingICmpRegion(ICmpInst::ICMP_NE, LowHalf),
1371             HighHalf);
1372 
1373   EXPECT_EQ(
1374       ConstantRange::makeSatisfyingICmpRegion(ICmpInst::ICMP_NE, HighHalf),
1375       LowHalf);
1376 
1377   EXPECT_TRUE(ConstantRange::makeSatisfyingICmpRegion(ICmpInst::ICMP_EQ,
1378                                                       HighHalf).isEmptySet());
1379 
1380   ConstantRange UnsignedSample(APInt(8, 5), APInt(8, 200));
1381 
1382   EXPECT_EQ(ConstantRange::makeSatisfyingICmpRegion(ICmpInst::ICMP_ULT,
1383                                                     UnsignedSample),
1384             ConstantRange(APInt(8, 0), APInt(8, 5)));
1385 
1386   EXPECT_EQ(ConstantRange::makeSatisfyingICmpRegion(ICmpInst::ICMP_ULE,
1387                                                     UnsignedSample),
1388             ConstantRange(APInt(8, 0), APInt(8, 6)));
1389 
1390   EXPECT_EQ(ConstantRange::makeSatisfyingICmpRegion(ICmpInst::ICMP_UGT,
1391                                                     UnsignedSample),
1392             ConstantRange(APInt(8, 200), APInt(8, 0)));
1393 
1394   EXPECT_EQ(ConstantRange::makeSatisfyingICmpRegion(ICmpInst::ICMP_UGE,
1395                                                     UnsignedSample),
1396             ConstantRange(APInt(8, 199), APInt(8, 0)));
1397 
1398   ConstantRange SignedSample(APInt(8, -5), APInt(8, 5));
1399 
1400   EXPECT_EQ(
1401       ConstantRange::makeSatisfyingICmpRegion(ICmpInst::ICMP_SLT, SignedSample),
1402       ConstantRange(APInt(8, -128), APInt(8, -5)));
1403 
1404   EXPECT_EQ(
1405       ConstantRange::makeSatisfyingICmpRegion(ICmpInst::ICMP_SLE, SignedSample),
1406       ConstantRange(APInt(8, -128), APInt(8, -4)));
1407 
1408   EXPECT_EQ(
1409       ConstantRange::makeSatisfyingICmpRegion(ICmpInst::ICMP_SGT, SignedSample),
1410       ConstantRange(APInt(8, 5), APInt(8, -128)));
1411 
1412   EXPECT_EQ(
1413       ConstantRange::makeSatisfyingICmpRegion(ICmpInst::ICMP_SGE, SignedSample),
1414       ConstantRange(APInt(8, 4), APInt(8, -128)));
1415 }
1416 
TEST(ConstantRange,MakeGuaranteedNoWrapRegion)1417 TEST(ConstantRange, MakeGuaranteedNoWrapRegion) {
1418   const int IntMin4Bits = 8;
1419   const int IntMax4Bits = 7;
1420   typedef OverflowingBinaryOperator OBO;
1421 
1422   for (int Const : {0, -1, -2, 1, 2, IntMin4Bits, IntMax4Bits}) {
1423     APInt C(4, Const, true /* = isSigned */);
1424 
1425     auto NUWRegion = ConstantRange::makeGuaranteedNoWrapRegion(
1426         Instruction::Add, C, OBO::NoUnsignedWrap);
1427 
1428     EXPECT_FALSE(NUWRegion.isEmptySet());
1429 
1430     auto NSWRegion = ConstantRange::makeGuaranteedNoWrapRegion(
1431         Instruction::Add, C, OBO::NoSignedWrap);
1432 
1433     EXPECT_FALSE(NSWRegion.isEmptySet());
1434 
1435     for (APInt I = NUWRegion.getLower(), E = NUWRegion.getUpper(); I != E;
1436          ++I) {
1437       bool Overflow = false;
1438       (void)I.uadd_ov(C, Overflow);
1439       EXPECT_FALSE(Overflow);
1440     }
1441 
1442     for (APInt I = NSWRegion.getLower(), E = NSWRegion.getUpper(); I != E;
1443          ++I) {
1444       bool Overflow = false;
1445       (void)I.sadd_ov(C, Overflow);
1446       EXPECT_FALSE(Overflow);
1447     }
1448   }
1449 
1450   for (int Const : {0, -1, -2, 1, 2, IntMin4Bits, IntMax4Bits}) {
1451     APInt C(4, Const, true /* = isSigned */);
1452 
1453     auto NUWRegion = ConstantRange::makeGuaranteedNoWrapRegion(
1454         Instruction::Sub, C, OBO::NoUnsignedWrap);
1455 
1456     EXPECT_FALSE(NUWRegion.isEmptySet());
1457 
1458     auto NSWRegion = ConstantRange::makeGuaranteedNoWrapRegion(
1459         Instruction::Sub, C, OBO::NoSignedWrap);
1460 
1461     EXPECT_FALSE(NSWRegion.isEmptySet());
1462 
1463     for (APInt I = NUWRegion.getLower(), E = NUWRegion.getUpper(); I != E;
1464          ++I) {
1465       bool Overflow = false;
1466       (void)I.usub_ov(C, Overflow);
1467       EXPECT_FALSE(Overflow);
1468     }
1469 
1470     for (APInt I = NSWRegion.getLower(), E = NSWRegion.getUpper(); I != E;
1471          ++I) {
1472       bool Overflow = false;
1473       (void)I.ssub_ov(C, Overflow);
1474       EXPECT_FALSE(Overflow);
1475     }
1476   }
1477 
1478   auto NSWForAllValues = ConstantRange::makeGuaranteedNoWrapRegion(
1479       Instruction::Add, ConstantRange(32, /* isFullSet = */ true),
1480       OBO::NoSignedWrap);
1481   EXPECT_TRUE(NSWForAllValues.isSingleElement() &&
1482               NSWForAllValues.getSingleElement()->isMinValue());
1483 
1484   NSWForAllValues = ConstantRange::makeGuaranteedNoWrapRegion(
1485       Instruction::Sub, ConstantRange(32, /* isFullSet = */ true),
1486       OBO::NoSignedWrap);
1487   EXPECT_TRUE(NSWForAllValues.isSingleElement() &&
1488               NSWForAllValues.getSingleElement()->isMaxValue());
1489 
1490   auto NUWForAllValues = ConstantRange::makeGuaranteedNoWrapRegion(
1491       Instruction::Add, ConstantRange(32, /* isFullSet = */ true),
1492       OBO::NoUnsignedWrap);
1493   EXPECT_TRUE(NUWForAllValues.isSingleElement() &&
1494               NUWForAllValues.getSingleElement()->isMinValue());
1495 
1496   NUWForAllValues = ConstantRange::makeGuaranteedNoWrapRegion(
1497       Instruction::Sub, ConstantRange(32, /* isFullSet = */ true),
1498       OBO::NoUnsignedWrap);
1499   EXPECT_TRUE(NUWForAllValues.isSingleElement() &&
1500               NUWForAllValues.getSingleElement()->isMaxValue());
1501 
1502   EXPECT_TRUE(ConstantRange::makeGuaranteedNoWrapRegion(
1503       Instruction::Add, APInt(32, 0), OBO::NoUnsignedWrap).isFullSet());
1504   EXPECT_TRUE(ConstantRange::makeGuaranteedNoWrapRegion(
1505       Instruction::Add, APInt(32, 0), OBO::NoSignedWrap).isFullSet());
1506   EXPECT_TRUE(ConstantRange::makeGuaranteedNoWrapRegion(
1507       Instruction::Sub, APInt(32, 0), OBO::NoUnsignedWrap).isFullSet());
1508   EXPECT_TRUE(ConstantRange::makeGuaranteedNoWrapRegion(
1509       Instruction::Sub, APInt(32, 0), OBO::NoSignedWrap).isFullSet());
1510 
1511   ConstantRange OneToFive(APInt(32, 1), APInt(32, 6));
1512   EXPECT_EQ(ConstantRange::makeGuaranteedNoWrapRegion(
1513                 Instruction::Add, OneToFive, OBO::NoSignedWrap),
1514             ConstantRange(APInt::getSignedMinValue(32),
1515                           APInt::getSignedMaxValue(32) - 4));
1516   EXPECT_EQ(ConstantRange::makeGuaranteedNoWrapRegion(
1517                 Instruction::Add, OneToFive, OBO::NoUnsignedWrap),
1518             ConstantRange(APInt::getMinValue(32), APInt::getMinValue(32) - 5));
1519   EXPECT_EQ(ConstantRange::makeGuaranteedNoWrapRegion(
1520                 Instruction::Sub, OneToFive, OBO::NoSignedWrap),
1521             ConstantRange(APInt::getSignedMinValue(32) + 5,
1522                           APInt::getSignedMinValue(32)));
1523   EXPECT_EQ(ConstantRange::makeGuaranteedNoWrapRegion(
1524                 Instruction::Sub, OneToFive, OBO::NoUnsignedWrap),
1525             ConstantRange(APInt::getMinValue(32) + 5, APInt::getMinValue(32)));
1526 
1527   ConstantRange MinusFiveToMinusTwo(APInt(32, -5), APInt(32, -1));
1528   EXPECT_EQ(ConstantRange::makeGuaranteedNoWrapRegion(
1529                 Instruction::Add, MinusFiveToMinusTwo, OBO::NoSignedWrap),
1530             ConstantRange(APInt::getSignedMinValue(32) + 5,
1531                           APInt::getSignedMinValue(32)));
1532   EXPECT_EQ(ConstantRange::makeGuaranteedNoWrapRegion(
1533                 Instruction::Add, MinusFiveToMinusTwo, OBO::NoUnsignedWrap),
1534             ConstantRange(APInt(32, 0), APInt(32, 2)));
1535   EXPECT_EQ(ConstantRange::makeGuaranteedNoWrapRegion(
1536                 Instruction::Sub, MinusFiveToMinusTwo, OBO::NoSignedWrap),
1537             ConstantRange(APInt::getSignedMinValue(32),
1538                           APInt::getSignedMaxValue(32) - 4));
1539   EXPECT_EQ(ConstantRange::makeGuaranteedNoWrapRegion(
1540                 Instruction::Sub, MinusFiveToMinusTwo, OBO::NoUnsignedWrap),
1541             ConstantRange(APInt::getMaxValue(32) - 1,
1542                           APInt::getMinValue(32)));
1543 
1544   ConstantRange MinusOneToOne(APInt(32, -1), APInt(32, 2));
1545   EXPECT_EQ(ConstantRange::makeGuaranteedNoWrapRegion(
1546                 Instruction::Add, MinusOneToOne, OBO::NoSignedWrap),
1547             ConstantRange(APInt::getSignedMinValue(32) + 1,
1548                           APInt::getSignedMinValue(32) - 1));
1549   EXPECT_EQ(ConstantRange::makeGuaranteedNoWrapRegion(
1550                 Instruction::Add, MinusOneToOne, OBO::NoUnsignedWrap),
1551             ConstantRange(APInt(32, 0), APInt(32, 1)));
1552   EXPECT_EQ(ConstantRange::makeGuaranteedNoWrapRegion(
1553                 Instruction::Sub, MinusOneToOne, OBO::NoSignedWrap),
1554             ConstantRange(APInt::getSignedMinValue(32) + 1,
1555                           APInt::getSignedMinValue(32) - 1));
1556   EXPECT_EQ(ConstantRange::makeGuaranteedNoWrapRegion(
1557                 Instruction::Sub, MinusOneToOne, OBO::NoUnsignedWrap),
1558             ConstantRange(APInt::getMaxValue(32),
1559                           APInt::getMinValue(32)));
1560 
1561   ConstantRange One(APInt(32, 1), APInt(32, 2));
1562   EXPECT_EQ(ConstantRange::makeGuaranteedNoWrapRegion(
1563                 Instruction::Add, One, OBO::NoSignedWrap),
1564             ConstantRange(APInt::getSignedMinValue(32),
1565                           APInt::getSignedMaxValue(32)));
1566   EXPECT_EQ(ConstantRange::makeGuaranteedNoWrapRegion(
1567                 Instruction::Add, One, OBO::NoUnsignedWrap),
1568             ConstantRange(APInt::getMinValue(32), APInt::getMaxValue(32)));
1569   EXPECT_EQ(ConstantRange::makeGuaranteedNoWrapRegion(
1570                 Instruction::Sub, One, OBO::NoSignedWrap),
1571             ConstantRange(APInt::getSignedMinValue(32) + 1,
1572                           APInt::getSignedMinValue(32)));
1573   EXPECT_EQ(ConstantRange::makeGuaranteedNoWrapRegion(
1574                 Instruction::Sub, One, OBO::NoUnsignedWrap),
1575             ConstantRange(APInt::getMinValue(32) + 1, APInt::getMinValue(32)));
1576 
1577   ConstantRange OneLessThanBitWidth(APInt(32, 0), APInt(32, 31) + 1);
1578   ConstantRange UpToBitWidth(APInt(32, 0), APInt(32, 32) + 1);
1579   EXPECT_EQ(ConstantRange::makeGuaranteedNoWrapRegion(
1580                 Instruction::Shl, UpToBitWidth, OBO::NoUnsignedWrap),
1581             ConstantRange::makeGuaranteedNoWrapRegion(
1582                 Instruction::Shl, OneLessThanBitWidth, OBO::NoUnsignedWrap));
1583   EXPECT_EQ(ConstantRange::makeGuaranteedNoWrapRegion(
1584                 Instruction::Shl, UpToBitWidth, OBO::NoSignedWrap),
1585             ConstantRange::makeGuaranteedNoWrapRegion(
1586                 Instruction::Shl, OneLessThanBitWidth, OBO::NoSignedWrap));
1587   EXPECT_EQ(ConstantRange::makeGuaranteedNoWrapRegion(
1588                 Instruction::Shl, UpToBitWidth, OBO::NoUnsignedWrap),
1589             ConstantRange(APInt(32, 0), APInt(32, 1) + 1));
1590   EXPECT_EQ(ConstantRange::makeGuaranteedNoWrapRegion(
1591                 Instruction::Shl, UpToBitWidth, OBO::NoSignedWrap),
1592             ConstantRange(APInt(32, -1), APInt(32, 0) + 1));
1593 
1594   EXPECT_EQ(
1595       ConstantRange::makeGuaranteedNoWrapRegion(
1596           Instruction::Shl, ConstantRange::getFull(32), OBO::NoUnsignedWrap),
1597       ConstantRange::makeGuaranteedNoWrapRegion(
1598           Instruction::Shl, OneLessThanBitWidth, OBO::NoUnsignedWrap));
1599   EXPECT_EQ(
1600       ConstantRange::makeGuaranteedNoWrapRegion(
1601           Instruction::Shl, ConstantRange::getFull(32), OBO::NoSignedWrap),
1602       ConstantRange::makeGuaranteedNoWrapRegion(
1603           Instruction::Shl, OneLessThanBitWidth, OBO::NoSignedWrap));
1604 
1605   ConstantRange IllegalShAmt(APInt(32, 32), APInt(32, 0) + 1);
1606   EXPECT_EQ(ConstantRange::makeGuaranteedNoWrapRegion(
1607                 Instruction::Shl, IllegalShAmt, OBO::NoUnsignedWrap),
1608             ConstantRange::getFull(32));
1609   EXPECT_EQ(ConstantRange::makeGuaranteedNoWrapRegion(
1610                 Instruction::Shl, IllegalShAmt, OBO::NoSignedWrap),
1611             ConstantRange::getFull(32));
1612 
1613   EXPECT_EQ(
1614       ConstantRange::makeGuaranteedNoWrapRegion(
1615           Instruction::Shl, ConstantRange(APInt(32, -32), APInt(32, 16) + 1),
1616           OBO::NoUnsignedWrap),
1617       ConstantRange::makeGuaranteedNoWrapRegion(
1618           Instruction::Shl, ConstantRange(APInt(32, 0), APInt(32, 16) + 1),
1619           OBO::NoUnsignedWrap));
1620   EXPECT_EQ(
1621       ConstantRange::makeGuaranteedNoWrapRegion(
1622           Instruction::Shl, ConstantRange(APInt(32, -32), APInt(32, 16) + 1),
1623           OBO::NoSignedWrap),
1624       ConstantRange::makeGuaranteedNoWrapRegion(
1625           Instruction::Shl, ConstantRange(APInt(32, 0), APInt(32, 16) + 1),
1626           OBO::NoSignedWrap));
1627 
1628   EXPECT_EQ(ConstantRange::makeGuaranteedNoWrapRegion(
1629                 Instruction::Shl,
1630                 ConstantRange(APInt(32, -32), APInt(32, 16) + 1),
1631                 OBO::NoUnsignedWrap),
1632             ConstantRange(APInt(32, 0), APInt(32, 65535) + 1));
1633   EXPECT_EQ(ConstantRange::makeGuaranteedNoWrapRegion(
1634                 Instruction::Shl,
1635                 ConstantRange(APInt(32, -32), APInt(32, 16) + 1),
1636                 OBO::NoSignedWrap),
1637             ConstantRange(APInt(32, -32768), APInt(32, 32767) + 1));
1638 }
1639 
1640 template<typename Fn>
TestNoWrapRegionExhaustive(Instruction::BinaryOps BinOp,unsigned NoWrapKind,Fn OverflowFn)1641 void TestNoWrapRegionExhaustive(Instruction::BinaryOps BinOp,
1642                                 unsigned NoWrapKind, Fn OverflowFn) {
1643   unsigned Bits = 5;
1644   EnumerateConstantRanges(Bits, [&](const ConstantRange &CR) {
1645     if (CR.isEmptySet())
1646       return;
1647     if (Instruction::isShift(BinOp) && CR.getUnsignedMax().uge(Bits))
1648       return;
1649 
1650     ConstantRange NoWrap =
1651         ConstantRange::makeGuaranteedNoWrapRegion(BinOp, CR, NoWrapKind);
1652     ConstantRange Full = ConstantRange::getFull(Bits);
1653     ForeachNumInConstantRange(Full, [&](const APInt &N1) {
1654       bool NoOverflow = true;
1655       bool Overflow = true;
1656       ForeachNumInConstantRange(CR, [&](const APInt &N2) {
1657         if (OverflowFn(N1, N2))
1658           NoOverflow = false;
1659         else
1660           Overflow = false;
1661       });
1662       EXPECT_EQ(NoOverflow, NoWrap.contains(N1));
1663 
1664       // The no-wrap range is exact for single-element ranges.
1665       if (CR.isSingleElement()) {
1666         EXPECT_EQ(Overflow, !NoWrap.contains(N1));
1667       }
1668     });
1669   });
1670 }
1671 
1672 // Show that makeGuaranteedNoWrapRegion() is maximal, and for single-element
1673 // ranges also exact.
TEST(ConstantRange,NoWrapRegionExhaustive)1674 TEST(ConstantRange, NoWrapRegionExhaustive) {
1675   TestNoWrapRegionExhaustive(
1676       Instruction::Add, OverflowingBinaryOperator::NoUnsignedWrap,
1677       [](const APInt &N1, const APInt &N2) {
1678         bool Overflow;
1679         (void) N1.uadd_ov(N2, Overflow);
1680         return Overflow;
1681       });
1682   TestNoWrapRegionExhaustive(
1683       Instruction::Add, OverflowingBinaryOperator::NoSignedWrap,
1684       [](const APInt &N1, const APInt &N2) {
1685         bool Overflow;
1686         (void) N1.sadd_ov(N2, Overflow);
1687         return Overflow;
1688       });
1689   TestNoWrapRegionExhaustive(
1690       Instruction::Sub, OverflowingBinaryOperator::NoUnsignedWrap,
1691       [](const APInt &N1, const APInt &N2) {
1692         bool Overflow;
1693         (void) N1.usub_ov(N2, Overflow);
1694         return Overflow;
1695       });
1696   TestNoWrapRegionExhaustive(
1697       Instruction::Sub, OverflowingBinaryOperator::NoSignedWrap,
1698       [](const APInt &N1, const APInt &N2) {
1699         bool Overflow;
1700         (void) N1.ssub_ov(N2, Overflow);
1701         return Overflow;
1702       });
1703   TestNoWrapRegionExhaustive(
1704       Instruction::Mul, OverflowingBinaryOperator::NoUnsignedWrap,
1705       [](const APInt &N1, const APInt &N2) {
1706         bool Overflow;
1707         (void) N1.umul_ov(N2, Overflow);
1708         return Overflow;
1709       });
1710   TestNoWrapRegionExhaustive(
1711       Instruction::Mul, OverflowingBinaryOperator::NoSignedWrap,
1712       [](const APInt &N1, const APInt &N2) {
1713         bool Overflow;
1714         (void) N1.smul_ov(N2, Overflow);
1715         return Overflow;
1716       });
1717   TestNoWrapRegionExhaustive(Instruction::Shl,
1718                              OverflowingBinaryOperator::NoUnsignedWrap,
1719                              [](const APInt &N1, const APInt &N2) {
1720                                bool Overflow;
1721                                (void)N1.ushl_ov(N2, Overflow);
1722                                return Overflow;
1723                              });
1724   TestNoWrapRegionExhaustive(Instruction::Shl,
1725                              OverflowingBinaryOperator::NoSignedWrap,
1726                              [](const APInt &N1, const APInt &N2) {
1727                                bool Overflow;
1728                                (void)N1.sshl_ov(N2, Overflow);
1729                                return Overflow;
1730                              });
1731 }
1732 
TEST(ConstantRange,GetEquivalentICmp)1733 TEST(ConstantRange, GetEquivalentICmp) {
1734   APInt RHS;
1735   CmpInst::Predicate Pred;
1736 
1737   EXPECT_TRUE(ConstantRange(APInt::getMinValue(32), APInt(32, 100))
1738                   .getEquivalentICmp(Pred, RHS));
1739   EXPECT_EQ(Pred, CmpInst::ICMP_ULT);
1740   EXPECT_EQ(RHS, APInt(32, 100));
1741 
1742   EXPECT_TRUE(ConstantRange(APInt::getSignedMinValue(32), APInt(32, 100))
1743                   .getEquivalentICmp(Pred, RHS));
1744   EXPECT_EQ(Pred, CmpInst::ICMP_SLT);
1745   EXPECT_EQ(RHS, APInt(32, 100));
1746 
1747   EXPECT_TRUE(ConstantRange(APInt(32, 100), APInt::getMinValue(32))
1748                   .getEquivalentICmp(Pred, RHS));
1749   EXPECT_EQ(Pred, CmpInst::ICMP_UGE);
1750   EXPECT_EQ(RHS, APInt(32, 100));
1751 
1752   EXPECT_TRUE(ConstantRange(APInt(32, 100), APInt::getSignedMinValue(32))
1753                   .getEquivalentICmp(Pred, RHS));
1754   EXPECT_EQ(Pred, CmpInst::ICMP_SGE);
1755   EXPECT_EQ(RHS, APInt(32, 100));
1756 
1757   EXPECT_TRUE(
1758       ConstantRange(32, /*isFullSet=*/true).getEquivalentICmp(Pred, RHS));
1759   EXPECT_EQ(Pred, CmpInst::ICMP_UGE);
1760   EXPECT_EQ(RHS, APInt(32, 0));
1761 
1762   EXPECT_TRUE(
1763       ConstantRange(32, /*isFullSet=*/false).getEquivalentICmp(Pred, RHS));
1764   EXPECT_EQ(Pred, CmpInst::ICMP_ULT);
1765   EXPECT_EQ(RHS, APInt(32, 0));
1766 
1767   EXPECT_FALSE(ConstantRange(APInt(32, 100), APInt(32, 200))
1768                    .getEquivalentICmp(Pred, RHS));
1769 
1770   EXPECT_FALSE(ConstantRange(APInt::getSignedMinValue(32) - APInt(32, 100),
1771                              APInt::getSignedMinValue(32) + APInt(32, 100))
1772                    .getEquivalentICmp(Pred, RHS));
1773 
1774   EXPECT_FALSE(ConstantRange(APInt::getMinValue(32) - APInt(32, 100),
1775                              APInt::getMinValue(32) + APInt(32, 100))
1776                    .getEquivalentICmp(Pred, RHS));
1777 
1778   EXPECT_TRUE(ConstantRange(APInt(32, 100)).getEquivalentICmp(Pred, RHS));
1779   EXPECT_EQ(Pred, CmpInst::ICMP_EQ);
1780   EXPECT_EQ(RHS, APInt(32, 100));
1781 
1782   EXPECT_TRUE(
1783       ConstantRange(APInt(32, 100)).inverse().getEquivalentICmp(Pred, RHS));
1784   EXPECT_EQ(Pred, CmpInst::ICMP_NE);
1785   EXPECT_EQ(RHS, APInt(32, 100));
1786 
1787   EXPECT_TRUE(
1788       ConstantRange(APInt(512, 100)).inverse().getEquivalentICmp(Pred, RHS));
1789   EXPECT_EQ(Pred, CmpInst::ICMP_NE);
1790   EXPECT_EQ(RHS, APInt(512, 100));
1791 
1792   // NB!  It would be correct for the following four calls to getEquivalentICmp
1793   // to return ordered predicates like CmpInst::ICMP_ULT or CmpInst::ICMP_UGT.
1794   // However, that's not the case today.
1795 
1796   EXPECT_TRUE(ConstantRange(APInt(32, 0)).getEquivalentICmp(Pred, RHS));
1797   EXPECT_EQ(Pred, CmpInst::ICMP_EQ);
1798   EXPECT_EQ(RHS, APInt(32, 0));
1799 
1800   EXPECT_TRUE(
1801       ConstantRange(APInt(32, 0)).inverse().getEquivalentICmp(Pred, RHS));
1802   EXPECT_EQ(Pred, CmpInst::ICMP_NE);
1803   EXPECT_EQ(RHS, APInt(32, 0));
1804 
1805   EXPECT_TRUE(ConstantRange(APInt(32, -1)).getEquivalentICmp(Pred, RHS));
1806   EXPECT_EQ(Pred, CmpInst::ICMP_EQ);
1807   EXPECT_EQ(RHS, APInt(32, -1));
1808 
1809   EXPECT_TRUE(
1810       ConstantRange(APInt(32, -1)).inverse().getEquivalentICmp(Pred, RHS));
1811   EXPECT_EQ(Pred, CmpInst::ICMP_NE);
1812   EXPECT_EQ(RHS, APInt(32, -1));
1813 }
1814 
1815 #define EXPECT_MAY_OVERFLOW(op) \
1816   EXPECT_EQ(ConstantRange::OverflowResult::MayOverflow, (op))
1817 #define EXPECT_ALWAYS_OVERFLOWS_LOW(op) \
1818   EXPECT_EQ(ConstantRange::OverflowResult::AlwaysOverflowsLow, (op))
1819 #define EXPECT_ALWAYS_OVERFLOWS_HIGH(op) \
1820   EXPECT_EQ(ConstantRange::OverflowResult::AlwaysOverflowsHigh, (op))
1821 #define EXPECT_NEVER_OVERFLOWS(op) \
1822   EXPECT_EQ(ConstantRange::OverflowResult::NeverOverflows, (op))
1823 
TEST_F(ConstantRangeTest,UnsignedAddOverflow)1824 TEST_F(ConstantRangeTest, UnsignedAddOverflow) {
1825   // Ill-defined - may overflow is a conservative result.
1826   EXPECT_MAY_OVERFLOW(Some.unsignedAddMayOverflow(Empty));
1827   EXPECT_MAY_OVERFLOW(Empty.unsignedAddMayOverflow(Some));
1828 
1829   // Never overflow despite one full/wrap set.
1830   ConstantRange Zero(APInt::getNullValue(16));
1831   EXPECT_NEVER_OVERFLOWS(Full.unsignedAddMayOverflow(Zero));
1832   EXPECT_NEVER_OVERFLOWS(Wrap.unsignedAddMayOverflow(Zero));
1833   EXPECT_NEVER_OVERFLOWS(Zero.unsignedAddMayOverflow(Full));
1834   EXPECT_NEVER_OVERFLOWS(Zero.unsignedAddMayOverflow(Wrap));
1835 
1836   // But usually full/wrap always may overflow.
1837   EXPECT_MAY_OVERFLOW(Full.unsignedAddMayOverflow(One));
1838   EXPECT_MAY_OVERFLOW(Wrap.unsignedAddMayOverflow(One));
1839   EXPECT_MAY_OVERFLOW(One.unsignedAddMayOverflow(Full));
1840   EXPECT_MAY_OVERFLOW(One.unsignedAddMayOverflow(Wrap));
1841 
1842   ConstantRange A(APInt(16, 0xfd00), APInt(16, 0xfe00));
1843   ConstantRange B1(APInt(16, 0x0100), APInt(16, 0x0201));
1844   ConstantRange B2(APInt(16, 0x0100), APInt(16, 0x0202));
1845   EXPECT_NEVER_OVERFLOWS(A.unsignedAddMayOverflow(B1));
1846   EXPECT_MAY_OVERFLOW(A.unsignedAddMayOverflow(B2));
1847   EXPECT_NEVER_OVERFLOWS(B1.unsignedAddMayOverflow(A));
1848   EXPECT_MAY_OVERFLOW(B2.unsignedAddMayOverflow(A));
1849 
1850   ConstantRange C1(APInt(16, 0x0299), APInt(16, 0x0400));
1851   ConstantRange C2(APInt(16, 0x0300), APInt(16, 0x0400));
1852   EXPECT_MAY_OVERFLOW(A.unsignedAddMayOverflow(C1));
1853   EXPECT_ALWAYS_OVERFLOWS_HIGH(A.unsignedAddMayOverflow(C2));
1854   EXPECT_MAY_OVERFLOW(C1.unsignedAddMayOverflow(A));
1855   EXPECT_ALWAYS_OVERFLOWS_HIGH(C2.unsignedAddMayOverflow(A));
1856 }
1857 
TEST_F(ConstantRangeTest,UnsignedSubOverflow)1858 TEST_F(ConstantRangeTest, UnsignedSubOverflow) {
1859   // Ill-defined - may overflow is a conservative result.
1860   EXPECT_MAY_OVERFLOW(Some.unsignedSubMayOverflow(Empty));
1861   EXPECT_MAY_OVERFLOW(Empty.unsignedSubMayOverflow(Some));
1862 
1863   // Never overflow despite one full/wrap set.
1864   ConstantRange Zero(APInt::getNullValue(16));
1865   ConstantRange Max(APInt::getAllOnesValue(16));
1866   EXPECT_NEVER_OVERFLOWS(Full.unsignedSubMayOverflow(Zero));
1867   EXPECT_NEVER_OVERFLOWS(Wrap.unsignedSubMayOverflow(Zero));
1868   EXPECT_NEVER_OVERFLOWS(Max.unsignedSubMayOverflow(Full));
1869   EXPECT_NEVER_OVERFLOWS(Max.unsignedSubMayOverflow(Wrap));
1870 
1871   // But usually full/wrap always may overflow.
1872   EXPECT_MAY_OVERFLOW(Full.unsignedSubMayOverflow(One));
1873   EXPECT_MAY_OVERFLOW(Wrap.unsignedSubMayOverflow(One));
1874   EXPECT_MAY_OVERFLOW(One.unsignedSubMayOverflow(Full));
1875   EXPECT_MAY_OVERFLOW(One.unsignedSubMayOverflow(Wrap));
1876 
1877   ConstantRange A(APInt(16, 0x0000), APInt(16, 0x0100));
1878   ConstantRange B(APInt(16, 0x0100), APInt(16, 0x0200));
1879   EXPECT_NEVER_OVERFLOWS(B.unsignedSubMayOverflow(A));
1880   EXPECT_ALWAYS_OVERFLOWS_LOW(A.unsignedSubMayOverflow(B));
1881 
1882   ConstantRange A1(APInt(16, 0x0000), APInt(16, 0x0101));
1883   ConstantRange B1(APInt(16, 0x0100), APInt(16, 0x0201));
1884   EXPECT_NEVER_OVERFLOWS(B1.unsignedSubMayOverflow(A1));
1885   EXPECT_MAY_OVERFLOW(A1.unsignedSubMayOverflow(B1));
1886 
1887   ConstantRange A2(APInt(16, 0x0000), APInt(16, 0x0102));
1888   ConstantRange B2(APInt(16, 0x0100), APInt(16, 0x0202));
1889   EXPECT_MAY_OVERFLOW(B2.unsignedSubMayOverflow(A2));
1890   EXPECT_MAY_OVERFLOW(A2.unsignedSubMayOverflow(B2));
1891 }
1892 
TEST_F(ConstantRangeTest,SignedAddOverflow)1893 TEST_F(ConstantRangeTest, SignedAddOverflow) {
1894   // Ill-defined - may overflow is a conservative result.
1895   EXPECT_MAY_OVERFLOW(Some.signedAddMayOverflow(Empty));
1896   EXPECT_MAY_OVERFLOW(Empty.signedAddMayOverflow(Some));
1897 
1898   // Never overflow despite one full/wrap set.
1899   ConstantRange Zero(APInt::getNullValue(16));
1900   EXPECT_NEVER_OVERFLOWS(Full.signedAddMayOverflow(Zero));
1901   EXPECT_NEVER_OVERFLOWS(Wrap.signedAddMayOverflow(Zero));
1902   EXPECT_NEVER_OVERFLOWS(Zero.signedAddMayOverflow(Full));
1903   EXPECT_NEVER_OVERFLOWS(Zero.signedAddMayOverflow(Wrap));
1904 
1905   // But usually full/wrap always may overflow.
1906   EXPECT_MAY_OVERFLOW(Full.signedAddMayOverflow(One));
1907   EXPECT_MAY_OVERFLOW(Wrap.signedAddMayOverflow(One));
1908   EXPECT_MAY_OVERFLOW(One.signedAddMayOverflow(Full));
1909   EXPECT_MAY_OVERFLOW(One.signedAddMayOverflow(Wrap));
1910 
1911   ConstantRange A(APInt(16, 0x7d00), APInt(16, 0x7e00));
1912   ConstantRange B1(APInt(16, 0x0100), APInt(16, 0x0201));
1913   ConstantRange B2(APInt(16, 0x0100), APInt(16, 0x0202));
1914   EXPECT_NEVER_OVERFLOWS(A.signedAddMayOverflow(B1));
1915   EXPECT_MAY_OVERFLOW(A.signedAddMayOverflow(B2));
1916   ConstantRange B3(APInt(16, 0x8000), APInt(16, 0x0201));
1917   ConstantRange B4(APInt(16, 0x8000), APInt(16, 0x0202));
1918   EXPECT_NEVER_OVERFLOWS(A.signedAddMayOverflow(B3));
1919   EXPECT_MAY_OVERFLOW(A.signedAddMayOverflow(B4));
1920   ConstantRange B5(APInt(16, 0x0299), APInt(16, 0x0400));
1921   ConstantRange B6(APInt(16, 0x0300), APInt(16, 0x0400));
1922   EXPECT_MAY_OVERFLOW(A.signedAddMayOverflow(B5));
1923   EXPECT_ALWAYS_OVERFLOWS_HIGH(A.signedAddMayOverflow(B6));
1924 
1925   ConstantRange C(APInt(16, 0x8200), APInt(16, 0x8300));
1926   ConstantRange D1(APInt(16, 0xfe00), APInt(16, 0xff00));
1927   ConstantRange D2(APInt(16, 0xfd99), APInt(16, 0xff00));
1928   EXPECT_NEVER_OVERFLOWS(C.signedAddMayOverflow(D1));
1929   EXPECT_MAY_OVERFLOW(C.signedAddMayOverflow(D2));
1930   ConstantRange D3(APInt(16, 0xfe00), APInt(16, 0x8000));
1931   ConstantRange D4(APInt(16, 0xfd99), APInt(16, 0x8000));
1932   EXPECT_NEVER_OVERFLOWS(C.signedAddMayOverflow(D3));
1933   EXPECT_MAY_OVERFLOW(C.signedAddMayOverflow(D4));
1934   ConstantRange D5(APInt(16, 0xfc00), APInt(16, 0xfd02));
1935   ConstantRange D6(APInt(16, 0xfc00), APInt(16, 0xfd01));
1936   EXPECT_MAY_OVERFLOW(C.signedAddMayOverflow(D5));
1937   EXPECT_ALWAYS_OVERFLOWS_LOW(C.signedAddMayOverflow(D6));
1938 
1939   ConstantRange E(APInt(16, 0xff00), APInt(16, 0x0100));
1940   EXPECT_NEVER_OVERFLOWS(E.signedAddMayOverflow(E));
1941   ConstantRange F(APInt(16, 0xf000), APInt(16, 0x7000));
1942   EXPECT_MAY_OVERFLOW(F.signedAddMayOverflow(F));
1943 }
1944 
TEST_F(ConstantRangeTest,SignedSubOverflow)1945 TEST_F(ConstantRangeTest, SignedSubOverflow) {
1946   // Ill-defined - may overflow is a conservative result.
1947   EXPECT_MAY_OVERFLOW(Some.signedSubMayOverflow(Empty));
1948   EXPECT_MAY_OVERFLOW(Empty.signedSubMayOverflow(Some));
1949 
1950   // Never overflow despite one full/wrap set.
1951   ConstantRange Zero(APInt::getNullValue(16));
1952   EXPECT_NEVER_OVERFLOWS(Full.signedSubMayOverflow(Zero));
1953   EXPECT_NEVER_OVERFLOWS(Wrap.signedSubMayOverflow(Zero));
1954 
1955   // But usually full/wrap always may overflow.
1956   EXPECT_MAY_OVERFLOW(Full.signedSubMayOverflow(One));
1957   EXPECT_MAY_OVERFLOW(Wrap.signedSubMayOverflow(One));
1958   EXPECT_MAY_OVERFLOW(One.signedSubMayOverflow(Full));
1959   EXPECT_MAY_OVERFLOW(One.signedSubMayOverflow(Wrap));
1960 
1961   ConstantRange A(APInt(16, 0x7d00), APInt(16, 0x7e00));
1962   ConstantRange B1(APInt(16, 0xfe00), APInt(16, 0xff00));
1963   ConstantRange B2(APInt(16, 0xfd99), APInt(16, 0xff00));
1964   EXPECT_NEVER_OVERFLOWS(A.signedSubMayOverflow(B1));
1965   EXPECT_MAY_OVERFLOW(A.signedSubMayOverflow(B2));
1966   ConstantRange B3(APInt(16, 0xfc00), APInt(16, 0xfd02));
1967   ConstantRange B4(APInt(16, 0xfc00), APInt(16, 0xfd01));
1968   EXPECT_MAY_OVERFLOW(A.signedSubMayOverflow(B3));
1969   EXPECT_ALWAYS_OVERFLOWS_HIGH(A.signedSubMayOverflow(B4));
1970 
1971   ConstantRange C(APInt(16, 0x8200), APInt(16, 0x8300));
1972   ConstantRange D1(APInt(16, 0x0100), APInt(16, 0x0201));
1973   ConstantRange D2(APInt(16, 0x0100), APInt(16, 0x0202));
1974   EXPECT_NEVER_OVERFLOWS(C.signedSubMayOverflow(D1));
1975   EXPECT_MAY_OVERFLOW(C.signedSubMayOverflow(D2));
1976   ConstantRange D3(APInt(16, 0x0299), APInt(16, 0x0400));
1977   ConstantRange D4(APInt(16, 0x0300), APInt(16, 0x0400));
1978   EXPECT_MAY_OVERFLOW(C.signedSubMayOverflow(D3));
1979   EXPECT_ALWAYS_OVERFLOWS_LOW(C.signedSubMayOverflow(D4));
1980 
1981   ConstantRange E(APInt(16, 0xff00), APInt(16, 0x0100));
1982   EXPECT_NEVER_OVERFLOWS(E.signedSubMayOverflow(E));
1983   ConstantRange F(APInt(16, 0xf000), APInt(16, 0x7001));
1984   EXPECT_MAY_OVERFLOW(F.signedSubMayOverflow(F));
1985 }
1986 
1987 template<typename Fn1, typename Fn2>
TestOverflowExhaustive(Fn1 OverflowFn,Fn2 MayOverflowFn)1988 static void TestOverflowExhaustive(Fn1 OverflowFn, Fn2 MayOverflowFn) {
1989   // Constant range overflow checks are tested exhaustively on 4-bit numbers.
1990   unsigned Bits = 4;
1991   EnumerateTwoConstantRanges(Bits, [=](const ConstantRange &CR1,
1992                                        const ConstantRange &CR2) {
1993     // Loop over all N1 in CR1 and N2 in CR2 and check whether any of the
1994     // operations have overflow / have no overflow.
1995     bool RangeHasOverflowLow = false;
1996     bool RangeHasOverflowHigh = false;
1997     bool RangeHasNoOverflow = false;
1998     ForeachNumInConstantRange(CR1, [&](const APInt &N1) {
1999       ForeachNumInConstantRange(CR2, [&](const APInt &N2) {
2000         bool IsOverflowHigh;
2001         if (!OverflowFn(IsOverflowHigh, N1, N2)) {
2002           RangeHasNoOverflow = true;
2003           return;
2004         }
2005 
2006         if (IsOverflowHigh)
2007           RangeHasOverflowHigh = true;
2008         else
2009           RangeHasOverflowLow = true;
2010       });
2011     });
2012 
2013     ConstantRange::OverflowResult OR = MayOverflowFn(CR1, CR2);
2014     switch (OR) {
2015     case ConstantRange::OverflowResult::AlwaysOverflowsLow:
2016       EXPECT_TRUE(RangeHasOverflowLow);
2017       EXPECT_FALSE(RangeHasOverflowHigh);
2018       EXPECT_FALSE(RangeHasNoOverflow);
2019       break;
2020     case ConstantRange::OverflowResult::AlwaysOverflowsHigh:
2021       EXPECT_TRUE(RangeHasOverflowHigh);
2022       EXPECT_FALSE(RangeHasOverflowLow);
2023       EXPECT_FALSE(RangeHasNoOverflow);
2024       break;
2025     case ConstantRange::OverflowResult::NeverOverflows:
2026       EXPECT_FALSE(RangeHasOverflowLow);
2027       EXPECT_FALSE(RangeHasOverflowHigh);
2028       EXPECT_TRUE(RangeHasNoOverflow);
2029       break;
2030     case ConstantRange::OverflowResult::MayOverflow:
2031       // We return MayOverflow for empty sets as a conservative result,
2032       // but of course neither the RangeHasOverflow nor the
2033       // RangeHasNoOverflow flags will be set.
2034       if (CR1.isEmptySet() || CR2.isEmptySet())
2035         break;
2036 
2037       EXPECT_TRUE(RangeHasOverflowLow || RangeHasOverflowHigh);
2038       EXPECT_TRUE(RangeHasNoOverflow);
2039       break;
2040     }
2041   });
2042 }
2043 
TEST_F(ConstantRangeTest,UnsignedAddOverflowExhaustive)2044 TEST_F(ConstantRangeTest, UnsignedAddOverflowExhaustive) {
2045   TestOverflowExhaustive(
2046       [](bool &IsOverflowHigh, const APInt &N1, const APInt &N2) {
2047         bool Overflow;
2048         (void) N1.uadd_ov(N2, Overflow);
2049         IsOverflowHigh = true;
2050         return Overflow;
2051       },
2052       [](const ConstantRange &CR1, const ConstantRange &CR2) {
2053         return CR1.unsignedAddMayOverflow(CR2);
2054       });
2055 }
2056 
TEST_F(ConstantRangeTest,UnsignedSubOverflowExhaustive)2057 TEST_F(ConstantRangeTest, UnsignedSubOverflowExhaustive) {
2058   TestOverflowExhaustive(
2059       [](bool &IsOverflowHigh, const APInt &N1, const APInt &N2) {
2060         bool Overflow;
2061         (void) N1.usub_ov(N2, Overflow);
2062         IsOverflowHigh = false;
2063         return Overflow;
2064       },
2065       [](const ConstantRange &CR1, const ConstantRange &CR2) {
2066         return CR1.unsignedSubMayOverflow(CR2);
2067       });
2068 }
2069 
TEST_F(ConstantRangeTest,UnsignedMulOverflowExhaustive)2070 TEST_F(ConstantRangeTest, UnsignedMulOverflowExhaustive) {
2071   TestOverflowExhaustive(
2072       [](bool &IsOverflowHigh, const APInt &N1, const APInt &N2) {
2073         bool Overflow;
2074         (void) N1.umul_ov(N2, Overflow);
2075         IsOverflowHigh = true;
2076         return Overflow;
2077       },
2078       [](const ConstantRange &CR1, const ConstantRange &CR2) {
2079         return CR1.unsignedMulMayOverflow(CR2);
2080       });
2081 }
2082 
TEST_F(ConstantRangeTest,SignedAddOverflowExhaustive)2083 TEST_F(ConstantRangeTest, SignedAddOverflowExhaustive) {
2084   TestOverflowExhaustive(
2085       [](bool &IsOverflowHigh, const APInt &N1, const APInt &N2) {
2086         bool Overflow;
2087         (void) N1.sadd_ov(N2, Overflow);
2088         IsOverflowHigh = N1.isNonNegative();
2089         return Overflow;
2090       },
2091       [](const ConstantRange &CR1, const ConstantRange &CR2) {
2092         return CR1.signedAddMayOverflow(CR2);
2093       });
2094 }
2095 
TEST_F(ConstantRangeTest,SignedSubOverflowExhaustive)2096 TEST_F(ConstantRangeTest, SignedSubOverflowExhaustive) {
2097   TestOverflowExhaustive(
2098       [](bool &IsOverflowHigh, const APInt &N1, const APInt &N2) {
2099         bool Overflow;
2100         (void) N1.ssub_ov(N2, Overflow);
2101         IsOverflowHigh = N1.isNonNegative();
2102         return Overflow;
2103       },
2104       [](const ConstantRange &CR1, const ConstantRange &CR2) {
2105         return CR1.signedSubMayOverflow(CR2);
2106       });
2107 }
2108 
TEST_F(ConstantRangeTest,FromKnownBits)2109 TEST_F(ConstantRangeTest, FromKnownBits) {
2110   KnownBits Unknown(16);
2111   EXPECT_EQ(Full, ConstantRange::fromKnownBits(Unknown, /*signed*/false));
2112   EXPECT_EQ(Full, ConstantRange::fromKnownBits(Unknown, /*signed*/true));
2113 
2114   // .10..01. -> unsigned 01000010 (66)  to 11011011 (219)
2115   //          -> signed   11000010 (194) to 01011011 (91)
2116   KnownBits Known(8);
2117   Known.Zero = 36;
2118   Known.One = 66;
2119   ConstantRange Unsigned(APInt(8, 66), APInt(8, 219 + 1));
2120   ConstantRange Signed(APInt(8, 194), APInt(8, 91 + 1));
2121   EXPECT_EQ(Unsigned, ConstantRange::fromKnownBits(Known, /*signed*/false));
2122   EXPECT_EQ(Signed, ConstantRange::fromKnownBits(Known, /*signed*/true));
2123 
2124   // 1.10.10. -> 10100100 (164) to 11101101 (237)
2125   Known.Zero = 18;
2126   Known.One = 164;
2127   ConstantRange CR1(APInt(8, 164), APInt(8, 237 + 1));
2128   EXPECT_EQ(CR1, ConstantRange::fromKnownBits(Known, /*signed*/false));
2129   EXPECT_EQ(CR1, ConstantRange::fromKnownBits(Known, /*signed*/true));
2130 
2131   // 01.0.1.0 -> 01000100 (68) to 01101110 (110)
2132   Known.Zero = 145;
2133   Known.One = 68;
2134   ConstantRange CR2(APInt(8, 68), APInt(8, 110 + 1));
2135   EXPECT_EQ(CR2, ConstantRange::fromKnownBits(Known, /*signed*/false));
2136   EXPECT_EQ(CR2, ConstantRange::fromKnownBits(Known, /*signed*/true));
2137 }
2138 
TEST_F(ConstantRangeTest,FromKnownBitsExhaustive)2139 TEST_F(ConstantRangeTest, FromKnownBitsExhaustive) {
2140   unsigned Bits = 4;
2141   unsigned Max = 1 << Bits;
2142   KnownBits Known(Bits);
2143   for (unsigned Zero = 0; Zero < Max; ++Zero) {
2144     for (unsigned One = 0; One < Max; ++One) {
2145       Known.Zero = Zero;
2146       Known.One = One;
2147       if (Known.hasConflict() || Known.isUnknown())
2148         continue;
2149 
2150       APInt MinUnsigned = APInt::getMaxValue(Bits);
2151       APInt MaxUnsigned = APInt::getMinValue(Bits);
2152       APInt MinSigned = APInt::getSignedMaxValue(Bits);
2153       APInt MaxSigned = APInt::getSignedMinValue(Bits);
2154       for (unsigned N = 0; N < Max; ++N) {
2155         APInt Num(Bits, N);
2156         if ((Num & Known.Zero) != 0 || (~Num & Known.One) != 0)
2157           continue;
2158 
2159         if (Num.ult(MinUnsigned)) MinUnsigned = Num;
2160         if (Num.ugt(MaxUnsigned)) MaxUnsigned = Num;
2161         if (Num.slt(MinSigned)) MinSigned = Num;
2162         if (Num.sgt(MaxSigned)) MaxSigned = Num;
2163       }
2164 
2165       ConstantRange UnsignedCR(MinUnsigned, MaxUnsigned + 1);
2166       ConstantRange SignedCR(MinSigned, MaxSigned + 1);
2167       EXPECT_EQ(UnsignedCR, ConstantRange::fromKnownBits(Known, false));
2168       EXPECT_EQ(SignedCR, ConstantRange::fromKnownBits(Known, true));
2169     }
2170   }
2171 }
2172 
TEST_F(ConstantRangeTest,Negative)2173 TEST_F(ConstantRangeTest, Negative) {
2174   // All elements in an empty set (of which there are none) are both negative
2175   // and non-negative. Empty & full sets checked explicitly for clarity, but
2176   // they are also covered by the exhaustive test below.
2177   EXPECT_TRUE(Empty.isAllNegative());
2178   EXPECT_TRUE(Empty.isAllNonNegative());
2179   EXPECT_FALSE(Full.isAllNegative());
2180   EXPECT_FALSE(Full.isAllNonNegative());
2181 
2182   unsigned Bits = 4;
2183   EnumerateConstantRanges(Bits, [](const ConstantRange &CR) {
2184     bool AllNegative = true;
2185     bool AllNonNegative = true;
2186     ForeachNumInConstantRange(CR, [&](const APInt &N) {
2187       if (!N.isNegative())
2188         AllNegative = false;
2189       if (!N.isNonNegative())
2190         AllNonNegative = false;
2191     });
2192     assert((CR.isEmptySet() || !AllNegative || !AllNonNegative) &&
2193            "Only empty set can be both all negative and all non-negative");
2194 
2195     EXPECT_EQ(AllNegative, CR.isAllNegative());
2196     EXPECT_EQ(AllNonNegative, CR.isAllNonNegative());
2197   });
2198 }
2199 
TEST_F(ConstantRangeTest,UAddSat)2200 TEST_F(ConstantRangeTest, UAddSat) {
2201   TestUnsignedBinOpExhaustive(
2202       [](const ConstantRange &CR1, const ConstantRange &CR2) {
2203         return CR1.uadd_sat(CR2);
2204       },
2205       [](const APInt &N1, const APInt &N2) {
2206         return N1.uadd_sat(N2);
2207       });
2208 }
2209 
TEST_F(ConstantRangeTest,USubSat)2210 TEST_F(ConstantRangeTest, USubSat) {
2211   TestUnsignedBinOpExhaustive(
2212       [](const ConstantRange &CR1, const ConstantRange &CR2) {
2213         return CR1.usub_sat(CR2);
2214       },
2215       [](const APInt &N1, const APInt &N2) {
2216         return N1.usub_sat(N2);
2217       });
2218 }
2219 
TEST_F(ConstantRangeTest,UMulSat)2220 TEST_F(ConstantRangeTest, UMulSat) {
2221   TestUnsignedBinOpExhaustive(
2222       [](const ConstantRange &CR1, const ConstantRange &CR2) {
2223         return CR1.umul_sat(CR2);
2224       },
2225       [](const APInt &N1, const APInt &N2) { return N1.umul_sat(N2); });
2226 }
2227 
TEST_F(ConstantRangeTest,UShlSat)2228 TEST_F(ConstantRangeTest, UShlSat) {
2229   TestUnsignedBinOpExhaustive(
2230       [](const ConstantRange &CR1, const ConstantRange &CR2) {
2231         return CR1.ushl_sat(CR2);
2232       },
2233       [](const APInt &N1, const APInt &N2) { return N1.ushl_sat(N2); });
2234 }
2235 
TEST_F(ConstantRangeTest,SAddSat)2236 TEST_F(ConstantRangeTest, SAddSat) {
2237   TestSignedBinOpExhaustive(
2238       [](const ConstantRange &CR1, const ConstantRange &CR2) {
2239         return CR1.sadd_sat(CR2);
2240       },
2241       [](const APInt &N1, const APInt &N2) {
2242         return N1.sadd_sat(N2);
2243       });
2244 }
2245 
TEST_F(ConstantRangeTest,SSubSat)2246 TEST_F(ConstantRangeTest, SSubSat) {
2247   TestSignedBinOpExhaustive(
2248       [](const ConstantRange &CR1, const ConstantRange &CR2) {
2249         return CR1.ssub_sat(CR2);
2250       },
2251       [](const APInt &N1, const APInt &N2) {
2252         return N1.ssub_sat(N2);
2253       });
2254 }
2255 
TEST_F(ConstantRangeTest,SMulSat)2256 TEST_F(ConstantRangeTest, SMulSat) {
2257   TestSignedBinOpExhaustive(
2258       [](const ConstantRange &CR1, const ConstantRange &CR2) {
2259         return CR1.smul_sat(CR2);
2260       },
2261       [](const APInt &N1, const APInt &N2) { return N1.smul_sat(N2); });
2262 }
2263 
TEST_F(ConstantRangeTest,SShlSat)2264 TEST_F(ConstantRangeTest, SShlSat) {
2265   TestSignedBinOpExhaustive(
2266       [](const ConstantRange &CR1, const ConstantRange &CR2) {
2267         return CR1.sshl_sat(CR2);
2268       },
2269       [](const APInt &N1, const APInt &N2) { return N1.sshl_sat(N2); });
2270 }
2271 
TEST_F(ConstantRangeTest,Abs)2272 TEST_F(ConstantRangeTest, Abs) {
2273   unsigned Bits = 4;
2274   EnumerateConstantRanges(Bits, [&](const ConstantRange &CR) {
2275     // We're working with unsigned integers here, because it makes the signed
2276     // min case non-wrapping.
2277     APInt Min = APInt::getMaxValue(Bits);
2278     APInt Max = APInt::getMinValue(Bits);
2279     ForeachNumInConstantRange(CR, [&](const APInt &N) {
2280       APInt AbsN = N.abs();
2281       if (AbsN.ult(Min))
2282         Min = AbsN;
2283       if (AbsN.ugt(Max))
2284         Max = AbsN;
2285     });
2286 
2287     ConstantRange AbsCR = CR.abs();
2288     if (Min.ugt(Max)) {
2289       EXPECT_TRUE(AbsCR.isEmptySet());
2290       return;
2291     }
2292 
2293     ConstantRange Exact = ConstantRange::getNonEmpty(Min, Max + 1);
2294     EXPECT_EQ(Exact, AbsCR);
2295   });
2296 }
2297 
TEST_F(ConstantRangeTest,castOps)2298 TEST_F(ConstantRangeTest, castOps) {
2299   ConstantRange A(APInt(16, 66), APInt(16, 128));
2300   ConstantRange FpToI8 = A.castOp(Instruction::FPToSI, 8);
2301   EXPECT_EQ(8u, FpToI8.getBitWidth());
2302   EXPECT_TRUE(FpToI8.isFullSet());
2303 
2304   ConstantRange FpToI16 = A.castOp(Instruction::FPToSI, 16);
2305   EXPECT_EQ(16u, FpToI16.getBitWidth());
2306   EXPECT_EQ(A, FpToI16);
2307 
2308   ConstantRange FPExtToDouble = A.castOp(Instruction::FPExt, 64);
2309   EXPECT_EQ(64u, FPExtToDouble.getBitWidth());
2310   EXPECT_TRUE(FPExtToDouble.isFullSet());
2311 
2312   ConstantRange PtrToInt = A.castOp(Instruction::PtrToInt, 64);
2313   EXPECT_EQ(64u, PtrToInt.getBitWidth());
2314   EXPECT_TRUE(PtrToInt.isFullSet());
2315 
2316   ConstantRange IntToPtr = A.castOp(Instruction::IntToPtr, 64);
2317   EXPECT_EQ(64u, IntToPtr.getBitWidth());
2318   EXPECT_TRUE(IntToPtr.isFullSet());
2319 }
2320 }  // anonymous namespace
2321