xref: /llvm-project/llvm/unittests/ADT/APIntTest.cpp (revision 0dda16464438c95fbd935512b1cf025f08df3ee6)
1 //===- llvm/unittest/ADT/APInt.cpp - APInt unit tests ---------------------===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 
10 #include "llvm/ADT/APInt.h"
11 #include "llvm/ADT/SmallString.h"
12 #include "gtest/gtest.h"
13 #include <array>
14 #include <ostream>
15 
16 using namespace llvm;
17 
18 namespace {
19 
20 // Test that APInt shift left works when bitwidth > 64 and shiftamt == 0
21 TEST(APIntTest, ShiftLeftByZero) {
22   APInt One = APInt::getNullValue(65) + 1;
23   APInt Shl = One.shl(0);
24   EXPECT_TRUE(Shl[0]);
25   EXPECT_FALSE(Shl[1]);
26 }
27 
28 TEST(APIntTest, i128_NegativeCount) {
29   APInt Minus3(128, static_cast<uint64_t>(-3), true);
30   EXPECT_EQ(126u, Minus3.countLeadingOnes());
31   EXPECT_EQ(-3, Minus3.getSExtValue());
32 
33   APInt Minus1(128, static_cast<uint64_t>(-1), true);
34   EXPECT_EQ(0u, Minus1.countLeadingZeros());
35   EXPECT_EQ(128u, Minus1.countLeadingOnes());
36   EXPECT_EQ(128u, Minus1.getActiveBits());
37   EXPECT_EQ(0u, Minus1.countTrailingZeros());
38   EXPECT_EQ(128u, Minus1.countTrailingOnes());
39   EXPECT_EQ(128u, Minus1.countPopulation());
40   EXPECT_EQ(-1, Minus1.getSExtValue());
41 }
42 
43 // XFAIL this test on FreeBSD where the system gcc-4.2.1 seems to miscompile it.
44 #if defined(__llvm__) || !defined(__FreeBSD__)
45 
46 TEST(APIntTest, i33_Count) {
47   APInt i33minus2(33, static_cast<uint64_t>(-2), true);
48   EXPECT_EQ(0u, i33minus2.countLeadingZeros());
49   EXPECT_EQ(32u, i33minus2.countLeadingOnes());
50   EXPECT_EQ(33u, i33minus2.getActiveBits());
51   EXPECT_EQ(1u, i33minus2.countTrailingZeros());
52   EXPECT_EQ(32u, i33minus2.countPopulation());
53   EXPECT_EQ(-2, i33minus2.getSExtValue());
54   EXPECT_EQ(((uint64_t)-2)&((1ull<<33) -1), i33minus2.getZExtValue());
55 }
56 
57 #endif
58 
59 TEST(APIntTest, i65_Count) {
60   APInt i65(65, 0, true);
61   EXPECT_EQ(65u, i65.countLeadingZeros());
62   EXPECT_EQ(0u, i65.countLeadingOnes());
63   EXPECT_EQ(0u, i65.getActiveBits());
64   EXPECT_EQ(1u, i65.getActiveWords());
65   EXPECT_EQ(65u, i65.countTrailingZeros());
66   EXPECT_EQ(0u, i65.countPopulation());
67 
68   APInt i65minus(65, 0, true);
69   i65minus.setBit(64);
70   EXPECT_EQ(0u, i65minus.countLeadingZeros());
71   EXPECT_EQ(1u, i65minus.countLeadingOnes());
72   EXPECT_EQ(65u, i65minus.getActiveBits());
73   EXPECT_EQ(64u, i65minus.countTrailingZeros());
74   EXPECT_EQ(1u, i65minus.countPopulation());
75 }
76 
77 TEST(APIntTest, i128_PositiveCount) {
78   APInt u128max = APInt::getAllOnesValue(128);
79   EXPECT_EQ(128u, u128max.countLeadingOnes());
80   EXPECT_EQ(0u, u128max.countLeadingZeros());
81   EXPECT_EQ(128u, u128max.getActiveBits());
82   EXPECT_EQ(0u, u128max.countTrailingZeros());
83   EXPECT_EQ(128u, u128max.countTrailingOnes());
84   EXPECT_EQ(128u, u128max.countPopulation());
85 
86   APInt u64max(128, static_cast<uint64_t>(-1), false);
87   EXPECT_EQ(64u, u64max.countLeadingZeros());
88   EXPECT_EQ(0u, u64max.countLeadingOnes());
89   EXPECT_EQ(64u, u64max.getActiveBits());
90   EXPECT_EQ(0u, u64max.countTrailingZeros());
91   EXPECT_EQ(64u, u64max.countTrailingOnes());
92   EXPECT_EQ(64u, u64max.countPopulation());
93   EXPECT_EQ((uint64_t)~0ull, u64max.getZExtValue());
94 
95   APInt zero(128, 0, true);
96   EXPECT_EQ(128u, zero.countLeadingZeros());
97   EXPECT_EQ(0u, zero.countLeadingOnes());
98   EXPECT_EQ(0u, zero.getActiveBits());
99   EXPECT_EQ(128u, zero.countTrailingZeros());
100   EXPECT_EQ(0u, zero.countTrailingOnes());
101   EXPECT_EQ(0u, zero.countPopulation());
102   EXPECT_EQ(0u, zero.getSExtValue());
103   EXPECT_EQ(0u, zero.getZExtValue());
104 
105   APInt one(128, 1, true);
106   EXPECT_EQ(127u, one.countLeadingZeros());
107   EXPECT_EQ(0u, one.countLeadingOnes());
108   EXPECT_EQ(1u, one.getActiveBits());
109   EXPECT_EQ(0u, one.countTrailingZeros());
110   EXPECT_EQ(1u, one.countTrailingOnes());
111   EXPECT_EQ(1u, one.countPopulation());
112   EXPECT_EQ(1, one.getSExtValue());
113   EXPECT_EQ(1u, one.getZExtValue());
114 }
115 
116 TEST(APIntTest, i1) {
117   const APInt neg_two(1, static_cast<uint64_t>(-2), true);
118   const APInt neg_one(1, static_cast<uint64_t>(-1), true);
119   const APInt zero(1, 0);
120   const APInt one(1, 1);
121   const APInt two(1, 2);
122 
123   EXPECT_EQ(0, neg_two.getSExtValue());
124   EXPECT_EQ(-1, neg_one.getSExtValue());
125   EXPECT_EQ(1u, neg_one.getZExtValue());
126   EXPECT_EQ(0u, zero.getZExtValue());
127   EXPECT_EQ(-1, one.getSExtValue());
128   EXPECT_EQ(1u, one.getZExtValue());
129   EXPECT_EQ(0u, two.getZExtValue());
130   EXPECT_EQ(0, two.getSExtValue());
131 
132   // Basic equalities for 1-bit values.
133   EXPECT_EQ(zero, two);
134   EXPECT_EQ(zero, neg_two);
135   EXPECT_EQ(one, neg_one);
136   EXPECT_EQ(two, neg_two);
137 
138   // Min/max signed values.
139   EXPECT_TRUE(zero.isMaxSignedValue());
140   EXPECT_FALSE(one.isMaxSignedValue());
141   EXPECT_FALSE(zero.isMinSignedValue());
142   EXPECT_TRUE(one.isMinSignedValue());
143 
144   // Additions.
145   EXPECT_EQ(two, one + one);
146   EXPECT_EQ(zero, neg_one + one);
147   EXPECT_EQ(neg_two, neg_one + neg_one);
148 
149   // Subtractions.
150   EXPECT_EQ(neg_two, neg_one - one);
151   EXPECT_EQ(two, one - neg_one);
152   EXPECT_EQ(zero, one - one);
153 
154   // Shifts.
155   EXPECT_EQ(zero, one << one);
156   EXPECT_EQ(one, one << zero);
157   EXPECT_EQ(zero, one.shl(1));
158   EXPECT_EQ(one, one.shl(0));
159   EXPECT_EQ(zero, one.lshr(1));
160   EXPECT_EQ(zero, one.ashr(1));
161 
162   // Rotates.
163   EXPECT_EQ(one, one.rotl(0));
164   EXPECT_EQ(one, one.rotl(1));
165   EXPECT_EQ(one, one.rotr(0));
166   EXPECT_EQ(one, one.rotr(1));
167 
168   // Multiplies.
169   EXPECT_EQ(neg_one, neg_one * one);
170   EXPECT_EQ(neg_one, one * neg_one);
171   EXPECT_EQ(one, neg_one * neg_one);
172   EXPECT_EQ(one, one * one);
173 
174   // Divides.
175   EXPECT_EQ(neg_one, one.sdiv(neg_one));
176   EXPECT_EQ(neg_one, neg_one.sdiv(one));
177   EXPECT_EQ(one, neg_one.sdiv(neg_one));
178   EXPECT_EQ(one, one.sdiv(one));
179 
180   EXPECT_EQ(neg_one, one.udiv(neg_one));
181   EXPECT_EQ(neg_one, neg_one.udiv(one));
182   EXPECT_EQ(one, neg_one.udiv(neg_one));
183   EXPECT_EQ(one, one.udiv(one));
184 
185   // Remainders.
186   EXPECT_EQ(zero, neg_one.srem(one));
187   EXPECT_EQ(zero, neg_one.urem(one));
188   EXPECT_EQ(zero, one.srem(neg_one));
189 
190   // sdivrem
191   {
192   APInt q(8, 0);
193   APInt r(8, 0);
194   APInt one(8, 1);
195   APInt two(8, 2);
196   APInt nine(8, 9);
197   APInt four(8, 4);
198 
199   EXPECT_EQ(nine.srem(two), one);
200   EXPECT_EQ(nine.srem(-two), one);
201   EXPECT_EQ((-nine).srem(two), -one);
202   EXPECT_EQ((-nine).srem(-two), -one);
203 
204   APInt::sdivrem(nine, two, q, r);
205   EXPECT_EQ(four, q);
206   EXPECT_EQ(one, r);
207   APInt::sdivrem(-nine, two, q, r);
208   EXPECT_EQ(-four, q);
209   EXPECT_EQ(-one, r);
210   APInt::sdivrem(nine, -two, q, r);
211   EXPECT_EQ(-four, q);
212   EXPECT_EQ(one, r);
213   APInt::sdivrem(-nine, -two, q, r);
214   EXPECT_EQ(four, q);
215   EXPECT_EQ(-one, r);
216   }
217 }
218 
219 TEST(APIntTest, compare) {
220   std::array<APInt, 5> testVals{{
221     APInt{16, 2},
222     APInt{16, 1},
223     APInt{16, 0},
224     APInt{16, (uint64_t)-1, true},
225     APInt{16, (uint64_t)-2, true},
226   }};
227 
228   for (auto &arg1 : testVals)
229     for (auto &arg2 : testVals) {
230       auto uv1 = arg1.getZExtValue();
231       auto uv2 = arg2.getZExtValue();
232       auto sv1 = arg1.getSExtValue();
233       auto sv2 = arg2.getSExtValue();
234 
235       EXPECT_EQ(uv1 <  uv2, arg1.ult(arg2));
236       EXPECT_EQ(uv1 <= uv2, arg1.ule(arg2));
237       EXPECT_EQ(uv1 >  uv2, arg1.ugt(arg2));
238       EXPECT_EQ(uv1 >= uv2, arg1.uge(arg2));
239 
240       EXPECT_EQ(sv1 <  sv2, arg1.slt(arg2));
241       EXPECT_EQ(sv1 <= sv2, arg1.sle(arg2));
242       EXPECT_EQ(sv1 >  sv2, arg1.sgt(arg2));
243       EXPECT_EQ(sv1 >= sv2, arg1.sge(arg2));
244 
245       EXPECT_EQ(uv1 <  uv2, arg1.ult(uv2));
246       EXPECT_EQ(uv1 <= uv2, arg1.ule(uv2));
247       EXPECT_EQ(uv1 >  uv2, arg1.ugt(uv2));
248       EXPECT_EQ(uv1 >= uv2, arg1.uge(uv2));
249 
250       EXPECT_EQ(sv1 <  sv2, arg1.slt(sv2));
251       EXPECT_EQ(sv1 <= sv2, arg1.sle(sv2));
252       EXPECT_EQ(sv1 >  sv2, arg1.sgt(sv2));
253       EXPECT_EQ(sv1 >= sv2, arg1.sge(sv2));
254     }
255 }
256 
257 
258 // Tests different div/rem varaints using scheme (a * b + c) / a
259 void testDiv(APInt a, APInt b, APInt c) {
260   ASSERT_TRUE(a.uge(b)); // Must: a >= b
261   ASSERT_TRUE(a.ugt(c)); // Must: a > c
262 
263   auto p = a * b + c;
264 
265   auto q = p.udiv(a);
266   auto r = p.urem(a);
267   EXPECT_EQ(b, q);
268   EXPECT_EQ(c, r);
269   APInt::udivrem(p, a, q, r);
270   EXPECT_EQ(b, q);
271   EXPECT_EQ(c, r);
272   q = p.sdiv(a);
273   r = p.srem(a);
274   EXPECT_EQ(b, q);
275   EXPECT_EQ(c, r);
276   APInt::sdivrem(p, a, q, r);
277   EXPECT_EQ(b, q);
278   EXPECT_EQ(c, r);
279 
280   if (b.ugt(c)) { // Test also symmetric case
281     q = p.udiv(b);
282     r = p.urem(b);
283     EXPECT_EQ(a, q);
284     EXPECT_EQ(c, r);
285     APInt::udivrem(p, b, q, r);
286     EXPECT_EQ(a, q);
287     EXPECT_EQ(c, r);
288     q = p.sdiv(b);
289     r = p.srem(b);
290     EXPECT_EQ(a, q);
291     EXPECT_EQ(c, r);
292     APInt::sdivrem(p, b, q, r);
293     EXPECT_EQ(a, q);
294     EXPECT_EQ(c, r);
295   }
296 }
297 
298 TEST(APIntTest, divrem_big1) {
299   // Tests KnuthDiv rare step D6
300   testDiv({256, "1ffffffffffffffff", 16},
301           {256, "1ffffffffffffffff", 16},
302           {256, 0});
303 }
304 
305 TEST(APIntTest, divrem_big2) {
306   // Tests KnuthDiv rare step D6
307   testDiv({1024,                       "112233ceff"
308                  "cecece000000ffffffffffffffffffff"
309                  "ffffffffffffffffffffffffffffffff"
310                  "ffffffffffffffffffffffffffffffff"
311                  "ffffffffffffffffffffffffffffff33", 16},
312           {1024,           "111111ffffffffffffffff"
313                  "ffffffffffffffffffffffffffffffff"
314                  "fffffffffffffffffffffffffffffccf"
315                  "ffffffffffffffffffffffffffffff00", 16},
316           {1024, 7919});
317 }
318 
319 TEST(APIntTest, divrem_big3) {
320   // Tests KnuthDiv case without shift
321   testDiv({256, "80000001ffffffffffffffff", 16},
322           {256, "ffffffffffffff0000000", 16},
323           {256, 4219});
324 }
325 
326 TEST(APIntTest, divrem_big4) {
327   // Tests heap allocation in divide() enfoced by huge numbers
328   testDiv(APInt{4096, 5}.shl(2001),
329           APInt{4096, 1}.shl(2000),
330           APInt{4096, 4219*13});
331 }
332 
333 TEST(APIntTest, divrem_big5) {
334   // Tests one word divisor case of divide()
335   testDiv(APInt{1024, 19}.shl(811),
336           APInt{1024, 4356013}, // one word
337           APInt{1024, 1});
338 }
339 
340 TEST(APIntTest, divrem_big6) {
341   // Tests some rare "borrow" cases in D4 step
342   testDiv(APInt{512, "ffffffffffffffff00000000000000000000000001", 16},
343           APInt{512, "10000000000000001000000000000001", 16},
344           APInt{512, "10000000000000000000000000000000", 16});
345 }
346 
347 TEST(APIntTest, divrem_big7) {
348   // Yet another test for KnuthDiv rare step D6.
349   testDiv({224, "800000008000000200000005", 16},
350           {224, "fffffffd", 16},
351           {224, "80000000800000010000000f", 16});
352 }
353 
354 TEST(APIntTest, fromString) {
355   EXPECT_EQ(APInt(32, 0), APInt(32,   "0", 2));
356   EXPECT_EQ(APInt(32, 1), APInt(32,   "1", 2));
357   EXPECT_EQ(APInt(32, 2), APInt(32,  "10", 2));
358   EXPECT_EQ(APInt(32, 3), APInt(32,  "11", 2));
359   EXPECT_EQ(APInt(32, 4), APInt(32, "100", 2));
360 
361   EXPECT_EQ(APInt(32, 0), APInt(32,   "+0", 2));
362   EXPECT_EQ(APInt(32, 1), APInt(32,   "+1", 2));
363   EXPECT_EQ(APInt(32, 2), APInt(32,  "+10", 2));
364   EXPECT_EQ(APInt(32, 3), APInt(32,  "+11", 2));
365   EXPECT_EQ(APInt(32, 4), APInt(32, "+100", 2));
366 
367   EXPECT_EQ(APInt(32, uint64_t(-0LL)), APInt(32,   "-0", 2));
368   EXPECT_EQ(APInt(32, uint64_t(-1LL)), APInt(32,   "-1", 2));
369   EXPECT_EQ(APInt(32, uint64_t(-2LL)), APInt(32,  "-10", 2));
370   EXPECT_EQ(APInt(32, uint64_t(-3LL)), APInt(32,  "-11", 2));
371   EXPECT_EQ(APInt(32, uint64_t(-4LL)), APInt(32, "-100", 2));
372 
373 
374   EXPECT_EQ(APInt(32,  0), APInt(32,  "0",  8));
375   EXPECT_EQ(APInt(32,  1), APInt(32,  "1",  8));
376   EXPECT_EQ(APInt(32,  7), APInt(32,  "7",  8));
377   EXPECT_EQ(APInt(32,  8), APInt(32,  "10", 8));
378   EXPECT_EQ(APInt(32, 15), APInt(32,  "17", 8));
379   EXPECT_EQ(APInt(32, 16), APInt(32,  "20", 8));
380 
381   EXPECT_EQ(APInt(32,  +0), APInt(32,  "+0",  8));
382   EXPECT_EQ(APInt(32,  +1), APInt(32,  "+1",  8));
383   EXPECT_EQ(APInt(32,  +7), APInt(32,  "+7",  8));
384   EXPECT_EQ(APInt(32,  +8), APInt(32,  "+10", 8));
385   EXPECT_EQ(APInt(32, +15), APInt(32,  "+17", 8));
386   EXPECT_EQ(APInt(32, +16), APInt(32,  "+20", 8));
387 
388   EXPECT_EQ(APInt(32,  uint64_t(-0LL)), APInt(32,  "-0",  8));
389   EXPECT_EQ(APInt(32,  uint64_t(-1LL)), APInt(32,  "-1",  8));
390   EXPECT_EQ(APInt(32,  uint64_t(-7LL)), APInt(32,  "-7",  8));
391   EXPECT_EQ(APInt(32,  uint64_t(-8LL)), APInt(32,  "-10", 8));
392   EXPECT_EQ(APInt(32, uint64_t(-15LL)), APInt(32,  "-17", 8));
393   EXPECT_EQ(APInt(32, uint64_t(-16LL)), APInt(32,  "-20", 8));
394 
395 
396   EXPECT_EQ(APInt(32,  0), APInt(32,  "0", 10));
397   EXPECT_EQ(APInt(32,  1), APInt(32,  "1", 10));
398   EXPECT_EQ(APInt(32,  9), APInt(32,  "9", 10));
399   EXPECT_EQ(APInt(32, 10), APInt(32, "10", 10));
400   EXPECT_EQ(APInt(32, 19), APInt(32, "19", 10));
401   EXPECT_EQ(APInt(32, 20), APInt(32, "20", 10));
402 
403   EXPECT_EQ(APInt(32,  uint64_t(-0LL)), APInt(32,  "-0", 10));
404   EXPECT_EQ(APInt(32,  uint64_t(-1LL)), APInt(32,  "-1", 10));
405   EXPECT_EQ(APInt(32,  uint64_t(-9LL)), APInt(32,  "-9", 10));
406   EXPECT_EQ(APInt(32, uint64_t(-10LL)), APInt(32, "-10", 10));
407   EXPECT_EQ(APInt(32, uint64_t(-19LL)), APInt(32, "-19", 10));
408   EXPECT_EQ(APInt(32, uint64_t(-20LL)), APInt(32, "-20", 10));
409 
410 
411   EXPECT_EQ(APInt(32,  0), APInt(32,  "0", 16));
412   EXPECT_EQ(APInt(32,  1), APInt(32,  "1", 16));
413   EXPECT_EQ(APInt(32, 15), APInt(32,  "F", 16));
414   EXPECT_EQ(APInt(32, 16), APInt(32, "10", 16));
415   EXPECT_EQ(APInt(32, 31), APInt(32, "1F", 16));
416   EXPECT_EQ(APInt(32, 32), APInt(32, "20", 16));
417 
418   EXPECT_EQ(APInt(32,  uint64_t(-0LL)), APInt(32,  "-0", 16));
419   EXPECT_EQ(APInt(32,  uint64_t(-1LL)), APInt(32,  "-1", 16));
420   EXPECT_EQ(APInt(32, uint64_t(-15LL)), APInt(32,  "-F", 16));
421   EXPECT_EQ(APInt(32, uint64_t(-16LL)), APInt(32, "-10", 16));
422   EXPECT_EQ(APInt(32, uint64_t(-31LL)), APInt(32, "-1F", 16));
423   EXPECT_EQ(APInt(32, uint64_t(-32LL)), APInt(32, "-20", 16));
424 
425   EXPECT_EQ(APInt(32,  0), APInt(32,  "0", 36));
426   EXPECT_EQ(APInt(32,  1), APInt(32,  "1", 36));
427   EXPECT_EQ(APInt(32, 35), APInt(32,  "Z", 36));
428   EXPECT_EQ(APInt(32, 36), APInt(32, "10", 36));
429   EXPECT_EQ(APInt(32, 71), APInt(32, "1Z", 36));
430   EXPECT_EQ(APInt(32, 72), APInt(32, "20", 36));
431 
432   EXPECT_EQ(APInt(32,  uint64_t(-0LL)), APInt(32,  "-0", 36));
433   EXPECT_EQ(APInt(32,  uint64_t(-1LL)), APInt(32,  "-1", 36));
434   EXPECT_EQ(APInt(32, uint64_t(-35LL)), APInt(32,  "-Z", 36));
435   EXPECT_EQ(APInt(32, uint64_t(-36LL)), APInt(32, "-10", 36));
436   EXPECT_EQ(APInt(32, uint64_t(-71LL)), APInt(32, "-1Z", 36));
437   EXPECT_EQ(APInt(32, uint64_t(-72LL)), APInt(32, "-20", 36));
438 }
439 
440 TEST(APIntTest, FromArray) {
441   EXPECT_EQ(APInt(32, uint64_t(1)), APInt(32, ArrayRef<uint64_t>(1)));
442 }
443 
444 TEST(APIntTest, StringBitsNeeded2) {
445   EXPECT_EQ(1U, APInt::getBitsNeeded(  "0", 2));
446   EXPECT_EQ(1U, APInt::getBitsNeeded(  "1", 2));
447   EXPECT_EQ(2U, APInt::getBitsNeeded( "10", 2));
448   EXPECT_EQ(2U, APInt::getBitsNeeded( "11", 2));
449   EXPECT_EQ(3U, APInt::getBitsNeeded("100", 2));
450 
451   EXPECT_EQ(1U, APInt::getBitsNeeded(  "+0", 2));
452   EXPECT_EQ(1U, APInt::getBitsNeeded(  "+1", 2));
453   EXPECT_EQ(2U, APInt::getBitsNeeded( "+10", 2));
454   EXPECT_EQ(2U, APInt::getBitsNeeded( "+11", 2));
455   EXPECT_EQ(3U, APInt::getBitsNeeded("+100", 2));
456 
457   EXPECT_EQ(2U, APInt::getBitsNeeded(  "-0", 2));
458   EXPECT_EQ(2U, APInt::getBitsNeeded(  "-1", 2));
459   EXPECT_EQ(3U, APInt::getBitsNeeded( "-10", 2));
460   EXPECT_EQ(3U, APInt::getBitsNeeded( "-11", 2));
461   EXPECT_EQ(4U, APInt::getBitsNeeded("-100", 2));
462 }
463 
464 TEST(APIntTest, StringBitsNeeded8) {
465   EXPECT_EQ(3U, APInt::getBitsNeeded( "0", 8));
466   EXPECT_EQ(3U, APInt::getBitsNeeded( "7", 8));
467   EXPECT_EQ(6U, APInt::getBitsNeeded("10", 8));
468   EXPECT_EQ(6U, APInt::getBitsNeeded("17", 8));
469   EXPECT_EQ(6U, APInt::getBitsNeeded("20", 8));
470 
471   EXPECT_EQ(3U, APInt::getBitsNeeded( "+0", 8));
472   EXPECT_EQ(3U, APInt::getBitsNeeded( "+7", 8));
473   EXPECT_EQ(6U, APInt::getBitsNeeded("+10", 8));
474   EXPECT_EQ(6U, APInt::getBitsNeeded("+17", 8));
475   EXPECT_EQ(6U, APInt::getBitsNeeded("+20", 8));
476 
477   EXPECT_EQ(4U, APInt::getBitsNeeded( "-0", 8));
478   EXPECT_EQ(4U, APInt::getBitsNeeded( "-7", 8));
479   EXPECT_EQ(7U, APInt::getBitsNeeded("-10", 8));
480   EXPECT_EQ(7U, APInt::getBitsNeeded("-17", 8));
481   EXPECT_EQ(7U, APInt::getBitsNeeded("-20", 8));
482 }
483 
484 TEST(APIntTest, StringBitsNeeded10) {
485   EXPECT_EQ(1U, APInt::getBitsNeeded( "0", 10));
486   EXPECT_EQ(2U, APInt::getBitsNeeded( "3", 10));
487   EXPECT_EQ(4U, APInt::getBitsNeeded( "9", 10));
488   EXPECT_EQ(4U, APInt::getBitsNeeded("10", 10));
489   EXPECT_EQ(5U, APInt::getBitsNeeded("19", 10));
490   EXPECT_EQ(5U, APInt::getBitsNeeded("20", 10));
491 
492   EXPECT_EQ(1U, APInt::getBitsNeeded( "+0", 10));
493   EXPECT_EQ(4U, APInt::getBitsNeeded( "+9", 10));
494   EXPECT_EQ(4U, APInt::getBitsNeeded("+10", 10));
495   EXPECT_EQ(5U, APInt::getBitsNeeded("+19", 10));
496   EXPECT_EQ(5U, APInt::getBitsNeeded("+20", 10));
497 
498   EXPECT_EQ(2U, APInt::getBitsNeeded( "-0", 10));
499   EXPECT_EQ(5U, APInt::getBitsNeeded( "-9", 10));
500   EXPECT_EQ(5U, APInt::getBitsNeeded("-10", 10));
501   EXPECT_EQ(6U, APInt::getBitsNeeded("-19", 10));
502   EXPECT_EQ(6U, APInt::getBitsNeeded("-20", 10));
503 }
504 
505 TEST(APIntTest, StringBitsNeeded16) {
506   EXPECT_EQ(4U, APInt::getBitsNeeded( "0", 16));
507   EXPECT_EQ(4U, APInt::getBitsNeeded( "F", 16));
508   EXPECT_EQ(8U, APInt::getBitsNeeded("10", 16));
509   EXPECT_EQ(8U, APInt::getBitsNeeded("1F", 16));
510   EXPECT_EQ(8U, APInt::getBitsNeeded("20", 16));
511 
512   EXPECT_EQ(4U, APInt::getBitsNeeded( "+0", 16));
513   EXPECT_EQ(4U, APInt::getBitsNeeded( "+F", 16));
514   EXPECT_EQ(8U, APInt::getBitsNeeded("+10", 16));
515   EXPECT_EQ(8U, APInt::getBitsNeeded("+1F", 16));
516   EXPECT_EQ(8U, APInt::getBitsNeeded("+20", 16));
517 
518   EXPECT_EQ(5U, APInt::getBitsNeeded( "-0", 16));
519   EXPECT_EQ(5U, APInt::getBitsNeeded( "-F", 16));
520   EXPECT_EQ(9U, APInt::getBitsNeeded("-10", 16));
521   EXPECT_EQ(9U, APInt::getBitsNeeded("-1F", 16));
522   EXPECT_EQ(9U, APInt::getBitsNeeded("-20", 16));
523 }
524 
525 TEST(APIntTest, toString) {
526   SmallString<16> S;
527   bool isSigned;
528 
529   APInt(8, 0).toString(S, 2, true, true);
530   EXPECT_EQ(S.str().str(), "0b0");
531   S.clear();
532   APInt(8, 0).toString(S, 8, true, true);
533   EXPECT_EQ(S.str().str(), "00");
534   S.clear();
535   APInt(8, 0).toString(S, 10, true, true);
536   EXPECT_EQ(S.str().str(), "0");
537   S.clear();
538   APInt(8, 0).toString(S, 16, true, true);
539   EXPECT_EQ(S.str().str(), "0x0");
540   S.clear();
541   APInt(8, 0).toString(S, 36, true, false);
542   EXPECT_EQ(S.str().str(), "0");
543   S.clear();
544 
545   isSigned = false;
546   APInt(8, 255, isSigned).toString(S, 2, isSigned, true);
547   EXPECT_EQ(S.str().str(), "0b11111111");
548   S.clear();
549   APInt(8, 255, isSigned).toString(S, 8, isSigned, true);
550   EXPECT_EQ(S.str().str(), "0377");
551   S.clear();
552   APInt(8, 255, isSigned).toString(S, 10, isSigned, true);
553   EXPECT_EQ(S.str().str(), "255");
554   S.clear();
555   APInt(8, 255, isSigned).toString(S, 16, isSigned, true);
556   EXPECT_EQ(S.str().str(), "0xFF");
557   S.clear();
558   APInt(8, 255, isSigned).toString(S, 36, isSigned, false);
559   EXPECT_EQ(S.str().str(), "73");
560   S.clear();
561 
562   isSigned = true;
563   APInt(8, 255, isSigned).toString(S, 2, isSigned, true);
564   EXPECT_EQ(S.str().str(), "-0b1");
565   S.clear();
566   APInt(8, 255, isSigned).toString(S, 8, isSigned, true);
567   EXPECT_EQ(S.str().str(), "-01");
568   S.clear();
569   APInt(8, 255, isSigned).toString(S, 10, isSigned, true);
570   EXPECT_EQ(S.str().str(), "-1");
571   S.clear();
572   APInt(8, 255, isSigned).toString(S, 16, isSigned, true);
573   EXPECT_EQ(S.str().str(), "-0x1");
574   S.clear();
575   APInt(8, 255, isSigned).toString(S, 36, isSigned, false);
576   EXPECT_EQ(S.str().str(), "-1");
577   S.clear();
578 }
579 
580 TEST(APIntTest, Log2) {
581   EXPECT_EQ(APInt(15, 7).logBase2(), 2U);
582   EXPECT_EQ(APInt(15, 7).ceilLogBase2(), 3U);
583   EXPECT_EQ(APInt(15, 7).exactLogBase2(), -1);
584   EXPECT_EQ(APInt(15, 8).logBase2(), 3U);
585   EXPECT_EQ(APInt(15, 8).ceilLogBase2(), 3U);
586   EXPECT_EQ(APInt(15, 8).exactLogBase2(), 3);
587   EXPECT_EQ(APInt(15, 9).logBase2(), 3U);
588   EXPECT_EQ(APInt(15, 9).ceilLogBase2(), 4U);
589   EXPECT_EQ(APInt(15, 9).exactLogBase2(), -1);
590 }
591 
592 TEST(APIntTest, magic) {
593   EXPECT_EQ(APInt(32, 3).magic().m, APInt(32, "55555556", 16));
594   EXPECT_EQ(APInt(32, 3).magic().s, 0U);
595   EXPECT_EQ(APInt(32, 5).magic().m, APInt(32, "66666667", 16));
596   EXPECT_EQ(APInt(32, 5).magic().s, 1U);
597   EXPECT_EQ(APInt(32, 7).magic().m, APInt(32, "92492493", 16));
598   EXPECT_EQ(APInt(32, 7).magic().s, 2U);
599 }
600 
601 TEST(APIntTest, magicu) {
602   EXPECT_EQ(APInt(32, 3).magicu().m, APInt(32, "AAAAAAAB", 16));
603   EXPECT_EQ(APInt(32, 3).magicu().s, 1U);
604   EXPECT_EQ(APInt(32, 5).magicu().m, APInt(32, "CCCCCCCD", 16));
605   EXPECT_EQ(APInt(32, 5).magicu().s, 2U);
606   EXPECT_EQ(APInt(32, 7).magicu().m, APInt(32, "24924925", 16));
607   EXPECT_EQ(APInt(32, 7).magicu().s, 3U);
608   EXPECT_EQ(APInt(64, 25).magicu(1).m, APInt(64, "A3D70A3D70A3D70B", 16));
609   EXPECT_EQ(APInt(64, 25).magicu(1).s, 4U);
610 }
611 
612 #ifdef GTEST_HAS_DEATH_TEST
613 #ifndef NDEBUG
614 TEST(APIntTest, StringDeath) {
615   EXPECT_DEATH(APInt(0, "", 0), "Bitwidth too small");
616   EXPECT_DEATH(APInt(32, "", 0), "Invalid string length");
617   EXPECT_DEATH(APInt(32, "0", 0), "Radix should be 2, 8, 10, 16, or 36!");
618   EXPECT_DEATH(APInt(32, "", 10), "Invalid string length");
619   EXPECT_DEATH(APInt(32, "-", 10), "String is only a sign, needs a value.");
620   EXPECT_DEATH(APInt(1, "1234", 10), "Insufficient bit width");
621   EXPECT_DEATH(APInt(32, "\0", 10), "Invalid string length");
622   EXPECT_DEATH(APInt(32, StringRef("1\02", 3), 10), "Invalid character in digit string");
623   EXPECT_DEATH(APInt(32, "1L", 10), "Invalid character in digit string");
624 }
625 #endif
626 #endif
627 
628 TEST(APIntTest, mul_clear) {
629   APInt ValA(65, -1ULL);
630   APInt ValB(65, 4);
631   APInt ValC(65, 0);
632   ValC = ValA * ValB;
633   ValA *= ValB;
634   EXPECT_EQ(ValA.toString(10, false), ValC.toString(10, false));
635 }
636 
637 TEST(APIntTest, Rotate) {
638   EXPECT_EQ(APInt(8, 1),  APInt(8, 1).rotl(0));
639   EXPECT_EQ(APInt(8, 2),  APInt(8, 1).rotl(1));
640   EXPECT_EQ(APInt(8, 4),  APInt(8, 1).rotl(2));
641   EXPECT_EQ(APInt(8, 16), APInt(8, 1).rotl(4));
642   EXPECT_EQ(APInt(8, 1),  APInt(8, 1).rotl(8));
643 
644   EXPECT_EQ(APInt(8, 16), APInt(8, 16).rotl(0));
645   EXPECT_EQ(APInt(8, 32), APInt(8, 16).rotl(1));
646   EXPECT_EQ(APInt(8, 64), APInt(8, 16).rotl(2));
647   EXPECT_EQ(APInt(8, 1),  APInt(8, 16).rotl(4));
648   EXPECT_EQ(APInt(8, 16), APInt(8, 16).rotl(8));
649 
650   EXPECT_EQ(APInt(8, 16), APInt(8, 16).rotr(0));
651   EXPECT_EQ(APInt(8, 8),  APInt(8, 16).rotr(1));
652   EXPECT_EQ(APInt(8, 4),  APInt(8, 16).rotr(2));
653   EXPECT_EQ(APInt(8, 1),  APInt(8, 16).rotr(4));
654   EXPECT_EQ(APInt(8, 16), APInt(8, 16).rotr(8));
655 
656   EXPECT_EQ(APInt(8, 1),   APInt(8, 1).rotr(0));
657   EXPECT_EQ(APInt(8, 128), APInt(8, 1).rotr(1));
658   EXPECT_EQ(APInt(8, 64),  APInt(8, 1).rotr(2));
659   EXPECT_EQ(APInt(8, 16),  APInt(8, 1).rotr(4));
660   EXPECT_EQ(APInt(8, 1),   APInt(8, 1).rotr(8));
661 
662   APInt Big(256, "00004000800000000000000000003fff8000000000000000", 16);
663   APInt Rot(256, "3fff80000000000000000000000000000000000040008000", 16);
664   EXPECT_EQ(Rot, Big.rotr(144));
665 }
666 
667 TEST(APIntTest, Splat) {
668   APInt ValA(8, 0x01);
669   EXPECT_EQ(ValA, APInt::getSplat(8, ValA));
670   EXPECT_EQ(APInt(64, 0x0101010101010101ULL), APInt::getSplat(64, ValA));
671 
672   APInt ValB(3, 5);
673   EXPECT_EQ(APInt(4, 0xD), APInt::getSplat(4, ValB));
674   EXPECT_EQ(APInt(15, 0xDB6D), APInt::getSplat(15, ValB));
675 }
676 
677 TEST(APIntTest, tcDecrement) {
678   // Test single word decrement.
679 
680   // No out borrow.
681   {
682     integerPart singleWord = ~integerPart(0) << (integerPartWidth - 1);
683     integerPart carry = APInt::tcDecrement(&singleWord, 1);
684     EXPECT_EQ(carry, integerPart(0));
685     EXPECT_EQ(singleWord, ~integerPart(0) >> 1);
686   }
687 
688   // With out borrow.
689   {
690     integerPart singleWord = 0;
691     integerPart carry = APInt::tcDecrement(&singleWord, 1);
692     EXPECT_EQ(carry, integerPart(1));
693     EXPECT_EQ(singleWord, ~integerPart(0));
694   }
695 
696   // Test multiword decrement.
697 
698   // No across word borrow, no out borrow.
699   {
700     integerPart test[4] = {0x1, 0x1, 0x1, 0x1};
701     integerPart expected[4] = {0x0, 0x1, 0x1, 0x1};
702     APInt::tcDecrement(test, 4);
703     EXPECT_EQ(APInt::tcCompare(test, expected, 4), 0);
704   }
705 
706   // 1 across word borrow, no out borrow.
707   {
708     integerPart test[4] = {0x0, 0xF, 0x1, 0x1};
709     integerPart expected[4] = {~integerPart(0), 0xE, 0x1, 0x1};
710     integerPart carry = APInt::tcDecrement(test, 4);
711     EXPECT_EQ(carry, integerPart(0));
712     EXPECT_EQ(APInt::tcCompare(test, expected, 4), 0);
713   }
714 
715   // 2 across word borrow, no out borrow.
716   {
717     integerPart test[4] = {0x0, 0x0, 0xC, 0x1};
718     integerPart expected[4] = {~integerPart(0), ~integerPart(0), 0xB, 0x1};
719     integerPart carry = APInt::tcDecrement(test, 4);
720     EXPECT_EQ(carry, integerPart(0));
721     EXPECT_EQ(APInt::tcCompare(test, expected, 4), 0);
722   }
723 
724   // 3 across word borrow, no out borrow.
725   {
726     integerPart test[4] = {0x0, 0x0, 0x0, 0x1};
727     integerPart expected[4] = {~integerPart(0), ~integerPart(0), ~integerPart(0), 0x0};
728     integerPart carry = APInt::tcDecrement(test, 4);
729     EXPECT_EQ(carry, integerPart(0));
730     EXPECT_EQ(APInt::tcCompare(test, expected, 4), 0);
731   }
732 
733   // 3 across word borrow, with out borrow.
734   {
735     integerPart test[4] = {0x0, 0x0, 0x0, 0x0};
736     integerPart expected[4] = {~integerPart(0), ~integerPart(0), ~integerPart(0), ~integerPart(0)};
737     integerPart carry = APInt::tcDecrement(test, 4);
738     EXPECT_EQ(carry, integerPart(1));
739     EXPECT_EQ(APInt::tcCompare(test, expected, 4), 0);
740   }
741 }
742 
743 TEST(APIntTest, arrayAccess) {
744   // Single word check.
745   uint64_t E1 = 0x2CA7F46BF6569915ULL;
746   APInt A1(64, E1);
747   for (unsigned i = 0, e = 64; i < e; ++i) {
748     EXPECT_EQ(bool(E1 & (1ULL << i)),
749               A1[i]);
750   }
751 
752   // Multiword check.
753   integerPart E2[4] = {
754     0xEB6EB136591CBA21ULL,
755     0x7B9358BD6A33F10AULL,
756     0x7E7FFA5EADD8846ULL,
757     0x305F341CA00B613DULL
758   };
759   APInt A2(integerPartWidth*4, E2);
760   for (unsigned i = 0; i < 4; ++i) {
761     for (unsigned j = 0; j < integerPartWidth; ++j) {
762       EXPECT_EQ(bool(E2[i] & (1ULL << j)),
763                 A2[i*integerPartWidth + j]);
764     }
765   }
766 }
767 
768 TEST(APIntTest, LargeAPIntConstruction) {
769   // Check that we can properly construct very large APInt. It is very
770   // unlikely that people will ever do this, but it is a legal input,
771   // so we should not crash on it.
772   APInt A9(UINT32_MAX, 0);
773   EXPECT_FALSE(A9.getBoolValue());
774 }
775 
776 TEST(APIntTest, nearestLogBase2) {
777   // Single word check.
778 
779   // Test round up.
780   uint64_t I1 = 0x1800001;
781   APInt A1(64, I1);
782   EXPECT_EQ(A1.nearestLogBase2(), A1.ceilLogBase2());
783 
784   // Test round down.
785   uint64_t I2 = 0x1000011;
786   APInt A2(64, I2);
787   EXPECT_EQ(A2.nearestLogBase2(), A2.logBase2());
788 
789   // Test ties round up.
790   uint64_t I3 = 0x1800000;
791   APInt A3(64, I3);
792   EXPECT_EQ(A3.nearestLogBase2(), A3.ceilLogBase2());
793 
794   // Multiple word check.
795 
796   // Test round up.
797   integerPart I4[4] = {0x0, 0xF, 0x18, 0x0};
798   APInt A4(integerPartWidth*4, I4);
799   EXPECT_EQ(A4.nearestLogBase2(), A4.ceilLogBase2());
800 
801   // Test round down.
802   integerPart I5[4] = {0x0, 0xF, 0x10, 0x0};
803   APInt A5(integerPartWidth*4, I5);
804   EXPECT_EQ(A5.nearestLogBase2(), A5.logBase2());
805 
806   // Test ties round up.
807   uint64_t I6[4] = {0x0, 0x0, 0x0, 0x18};
808   APInt A6(integerPartWidth*4, I6);
809   EXPECT_EQ(A6.nearestLogBase2(), A6.ceilLogBase2());
810 
811   // Test BitWidth == 1 special cases.
812   APInt A7(1, 1);
813   EXPECT_EQ(A7.nearestLogBase2(), 0ULL);
814   APInt A8(1, 0);
815   EXPECT_EQ(A8.nearestLogBase2(), UINT32_MAX);
816 
817   // Test the zero case when we have a bit width large enough such
818   // that the bit width is larger than UINT32_MAX-1.
819   APInt A9(UINT32_MAX, 0);
820   EXPECT_EQ(A9.nearestLogBase2(), UINT32_MAX);
821 }
822 
823 TEST(APIntTest, IsSplat) {
824   APInt A(32, 0x01010101);
825   EXPECT_FALSE(A.isSplat(1));
826   EXPECT_FALSE(A.isSplat(2));
827   EXPECT_FALSE(A.isSplat(4));
828   EXPECT_TRUE(A.isSplat(8));
829   EXPECT_TRUE(A.isSplat(16));
830   EXPECT_TRUE(A.isSplat(32));
831 
832   APInt B(24, 0xAAAAAA);
833   EXPECT_FALSE(B.isSplat(1));
834   EXPECT_TRUE(B.isSplat(2));
835   EXPECT_TRUE(B.isSplat(4));
836   EXPECT_TRUE(B.isSplat(8));
837   EXPECT_TRUE(B.isSplat(24));
838 
839   APInt C(24, 0xABAAAB);
840   EXPECT_FALSE(C.isSplat(1));
841   EXPECT_FALSE(C.isSplat(2));
842   EXPECT_FALSE(C.isSplat(4));
843   EXPECT_FALSE(C.isSplat(8));
844   EXPECT_TRUE(C.isSplat(24));
845 
846   APInt D(32, 0xABBAABBA);
847   EXPECT_FALSE(D.isSplat(1));
848   EXPECT_FALSE(D.isSplat(2));
849   EXPECT_FALSE(D.isSplat(4));
850   EXPECT_FALSE(D.isSplat(8));
851   EXPECT_TRUE(D.isSplat(16));
852   EXPECT_TRUE(D.isSplat(32));
853 
854   APInt E(32, 0);
855   EXPECT_TRUE(E.isSplat(1));
856   EXPECT_TRUE(E.isSplat(2));
857   EXPECT_TRUE(E.isSplat(4));
858   EXPECT_TRUE(E.isSplat(8));
859   EXPECT_TRUE(E.isSplat(16));
860   EXPECT_TRUE(E.isSplat(32));
861 }
862 
863 #if defined(__clang__)
864 // Disable the pragma warning from versions of Clang without -Wself-move
865 #pragma clang diagnostic push
866 #pragma clang diagnostic ignored "-Wunknown-pragmas"
867 // Disable the warning that triggers on exactly what is being tested.
868 #pragma clang diagnostic push
869 #pragma clang diagnostic ignored "-Wself-move"
870 #endif
871 TEST(APIntTest, SelfMoveAssignment) {
872   APInt X(32, 0xdeadbeef);
873   X = std::move(X);
874   EXPECT_EQ(32u, X.getBitWidth());
875   EXPECT_EQ(0xdeadbeefULL, X.getLimitedValue());
876 
877   uint64_t Bits[] = {0xdeadbeefdeadbeefULL, 0xdeadbeefdeadbeefULL};
878   APInt Y(128, Bits);
879   Y = std::move(Y);
880   EXPECT_EQ(128u, Y.getBitWidth());
881   EXPECT_EQ(~0ULL, Y.getLimitedValue());
882   const uint64_t *Raw = Y.getRawData();
883   EXPECT_EQ(2u, Y.getNumWords());
884   EXPECT_EQ(0xdeadbeefdeadbeefULL, Raw[0]);
885   EXPECT_EQ(0xdeadbeefdeadbeefULL, Raw[1]);
886 }
887 #if defined(__clang__)
888 #pragma clang diagnostic pop
889 #pragma clang diagnostic pop
890 #endif
891 }
892