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