1 //===- unittests/Support/MathExtrasTest.cpp - math utils 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 "gtest/gtest.h" 11 #include "llvm/Support/MathExtras.h" 12 13 using namespace llvm; 14 15 namespace { 16 17 TEST(MathExtras, countTrailingZeros) { 18 uint8_t Z8 = 0; 19 uint16_t Z16 = 0; 20 uint32_t Z32 = 0; 21 uint64_t Z64 = 0; 22 EXPECT_EQ(8u, countTrailingZeros(Z8)); 23 EXPECT_EQ(16u, countTrailingZeros(Z16)); 24 EXPECT_EQ(32u, countTrailingZeros(Z32)); 25 EXPECT_EQ(64u, countTrailingZeros(Z64)); 26 27 uint8_t NZ8 = 42; 28 uint16_t NZ16 = 42; 29 uint32_t NZ32 = 42; 30 uint64_t NZ64 = 42; 31 EXPECT_EQ(1u, countTrailingZeros(NZ8)); 32 EXPECT_EQ(1u, countTrailingZeros(NZ16)); 33 EXPECT_EQ(1u, countTrailingZeros(NZ32)); 34 EXPECT_EQ(1u, countTrailingZeros(NZ64)); 35 } 36 37 TEST(MathExtras, countLeadingZeros) { 38 uint8_t Z8 = 0; 39 uint16_t Z16 = 0; 40 uint32_t Z32 = 0; 41 uint64_t Z64 = 0; 42 EXPECT_EQ(8u, countLeadingZeros(Z8)); 43 EXPECT_EQ(16u, countLeadingZeros(Z16)); 44 EXPECT_EQ(32u, countLeadingZeros(Z32)); 45 EXPECT_EQ(64u, countLeadingZeros(Z64)); 46 47 uint8_t NZ8 = 42; 48 uint16_t NZ16 = 42; 49 uint32_t NZ32 = 42; 50 uint64_t NZ64 = 42; 51 EXPECT_EQ(2u, countLeadingZeros(NZ8)); 52 EXPECT_EQ(10u, countLeadingZeros(NZ16)); 53 EXPECT_EQ(26u, countLeadingZeros(NZ32)); 54 EXPECT_EQ(58u, countLeadingZeros(NZ64)); 55 56 EXPECT_EQ(8u, countLeadingZeros(0x00F000FFu)); 57 EXPECT_EQ(8u, countLeadingZeros(0x00F12345u)); 58 for (unsigned i = 0; i <= 30; ++i) { 59 EXPECT_EQ(31 - i, countLeadingZeros(1u << i)); 60 } 61 62 EXPECT_EQ(8u, countLeadingZeros(0x00F1234500F12345ULL)); 63 EXPECT_EQ(1u, countLeadingZeros(1ULL << 62)); 64 for (unsigned i = 0; i <= 62; ++i) { 65 EXPECT_EQ(63 - i, countLeadingZeros(1ULL << i)); 66 } 67 } 68 69 TEST(MathExtras, findFirstSet) { 70 uint8_t Z8 = 0; 71 uint16_t Z16 = 0; 72 uint32_t Z32 = 0; 73 uint64_t Z64 = 0; 74 EXPECT_EQ(0xFFULL, findFirstSet(Z8)); 75 EXPECT_EQ(0xFFFFULL, findFirstSet(Z16)); 76 EXPECT_EQ(0xFFFFFFFFULL, findFirstSet(Z32)); 77 EXPECT_EQ(0xFFFFFFFFFFFFFFFFULL, findFirstSet(Z64)); 78 79 uint8_t NZ8 = 42; 80 uint16_t NZ16 = 42; 81 uint32_t NZ32 = 42; 82 uint64_t NZ64 = 42; 83 EXPECT_EQ(1u, findFirstSet(NZ8)); 84 EXPECT_EQ(1u, findFirstSet(NZ16)); 85 EXPECT_EQ(1u, findFirstSet(NZ32)); 86 EXPECT_EQ(1u, findFirstSet(NZ64)); 87 } 88 89 TEST(MathExtras, findLastSet) { 90 uint8_t Z8 = 0; 91 uint16_t Z16 = 0; 92 uint32_t Z32 = 0; 93 uint64_t Z64 = 0; 94 EXPECT_EQ(0xFFULL, findLastSet(Z8)); 95 EXPECT_EQ(0xFFFFULL, findLastSet(Z16)); 96 EXPECT_EQ(0xFFFFFFFFULL, findLastSet(Z32)); 97 EXPECT_EQ(0xFFFFFFFFFFFFFFFFULL, findLastSet(Z64)); 98 99 uint8_t NZ8 = 42; 100 uint16_t NZ16 = 42; 101 uint32_t NZ32 = 42; 102 uint64_t NZ64 = 42; 103 EXPECT_EQ(5u, findLastSet(NZ8)); 104 EXPECT_EQ(5u, findLastSet(NZ16)); 105 EXPECT_EQ(5u, findLastSet(NZ32)); 106 EXPECT_EQ(5u, findLastSet(NZ64)); 107 } 108 109 TEST(MathExtras, isIntN) { 110 EXPECT_TRUE(isIntN(16, 32767)); 111 EXPECT_FALSE(isIntN(16, 32768)); 112 } 113 114 TEST(MathExtras, isUIntN) { 115 EXPECT_TRUE(isUIntN(16, 65535)); 116 EXPECT_FALSE(isUIntN(16, 65536)); 117 EXPECT_TRUE(isUIntN(1, 0)); 118 EXPECT_TRUE(isUIntN(6, 63)); 119 } 120 121 TEST(MathExtras, maxIntN) { 122 EXPECT_EQ(32767, maxIntN(16)); 123 EXPECT_EQ(2147483647, maxIntN(32)); 124 EXPECT_EQ(std::numeric_limits<int32_t>::max(), maxIntN(32)); 125 EXPECT_EQ(std::numeric_limits<int64_t>::max(), maxIntN(64)); 126 } 127 128 TEST(MathExtras, minIntN) { 129 EXPECT_EQ(-32768LL, minIntN(16)); 130 EXPECT_EQ(-64LL, minIntN(7)); 131 EXPECT_EQ(std::numeric_limits<int32_t>::min(), minIntN(32)); 132 EXPECT_EQ(std::numeric_limits<int64_t>::min(), minIntN(64)); 133 } 134 135 TEST(MathExtras, maxUIntN) { 136 EXPECT_EQ(0xffffULL, maxUIntN(16)); 137 EXPECT_EQ(0xffffffffULL, maxUIntN(32)); 138 EXPECT_EQ(0xffffffffffffffffULL, maxUIntN(64)); 139 EXPECT_EQ(1ULL, maxUIntN(1)); 140 EXPECT_EQ(0x0fULL, maxUIntN(4)); 141 } 142 143 TEST(MathExtras, reverseBits) { 144 uint8_t NZ8 = 42; 145 uint16_t NZ16 = 42; 146 uint32_t NZ32 = 42; 147 uint64_t NZ64 = 42; 148 EXPECT_EQ(0x54ULL, reverseBits(NZ8)); 149 EXPECT_EQ(0x5400ULL, reverseBits(NZ16)); 150 EXPECT_EQ(0x54000000ULL, reverseBits(NZ32)); 151 EXPECT_EQ(0x5400000000000000ULL, reverseBits(NZ64)); 152 } 153 154 TEST(MathExtras, isPowerOf2_32) { 155 EXPECT_TRUE(isPowerOf2_32(1 << 6)); 156 EXPECT_TRUE(isPowerOf2_32(1 << 12)); 157 EXPECT_FALSE(isPowerOf2_32((1 << 19) + 3)); 158 EXPECT_FALSE(isPowerOf2_32(0xABCDEF0)); 159 } 160 161 TEST(MathExtras, isPowerOf2_64) { 162 EXPECT_TRUE(isPowerOf2_64(1LL << 46)); 163 EXPECT_TRUE(isPowerOf2_64(1LL << 12)); 164 EXPECT_FALSE(isPowerOf2_64((1LL << 53) + 3)); 165 EXPECT_FALSE(isPowerOf2_64(0xABCDEF0ABCDEF0LL)); 166 } 167 168 TEST(MathExtras, ByteSwap_32) { 169 EXPECT_EQ(0x44332211u, ByteSwap_32(0x11223344)); 170 EXPECT_EQ(0xDDCCBBAAu, ByteSwap_32(0xAABBCCDD)); 171 } 172 173 TEST(MathExtras, ByteSwap_64) { 174 EXPECT_EQ(0x8877665544332211ULL, ByteSwap_64(0x1122334455667788LL)); 175 EXPECT_EQ(0x1100FFEEDDCCBBAAULL, ByteSwap_64(0xAABBCCDDEEFF0011LL)); 176 } 177 178 TEST(MathExtras, countLeadingOnes) { 179 for (int i = 30; i >= 0; --i) { 180 // Start with all ones and unset some bit. 181 EXPECT_EQ(31u - i, countLeadingOnes(0xFFFFFFFF ^ (1 << i))); 182 } 183 for (int i = 62; i >= 0; --i) { 184 // Start with all ones and unset some bit. 185 EXPECT_EQ(63u - i, countLeadingOnes(0xFFFFFFFFFFFFFFFFULL ^ (1LL << i))); 186 } 187 for (int i = 30; i >= 0; --i) { 188 // Start with all ones and unset some bit. 189 EXPECT_EQ(31u - i, countLeadingOnes(0xFFFFFFFF ^ (1 << i))); 190 } 191 } 192 193 TEST(MathExtras, FloatBits) { 194 static const float kValue = 5632.34f; 195 EXPECT_FLOAT_EQ(kValue, BitsToFloat(FloatToBits(kValue))); 196 } 197 198 TEST(MathExtras, DoubleBits) { 199 static const double kValue = 87987234.983498; 200 EXPECT_DOUBLE_EQ(kValue, BitsToDouble(DoubleToBits(kValue))); 201 } 202 203 TEST(MathExtras, MinAlign) { 204 EXPECT_EQ(1u, MinAlign(2, 3)); 205 EXPECT_EQ(2u, MinAlign(2, 4)); 206 EXPECT_EQ(1u, MinAlign(17, 64)); 207 EXPECT_EQ(256u, MinAlign(256, 512)); 208 } 209 210 TEST(MathExtras, NextPowerOf2) { 211 EXPECT_EQ(4u, NextPowerOf2(3)); 212 EXPECT_EQ(16u, NextPowerOf2(15)); 213 EXPECT_EQ(256u, NextPowerOf2(128)); 214 } 215 216 TEST(MathExtras, alignTo) { 217 EXPECT_EQ(8u, alignTo(5, 8)); 218 EXPECT_EQ(24u, alignTo(17, 8)); 219 EXPECT_EQ(0u, alignTo(~0LL, 8)); 220 221 EXPECT_EQ(7u, alignTo(5, 8, 7)); 222 EXPECT_EQ(17u, alignTo(17, 8, 1)); 223 EXPECT_EQ(3u, alignTo(~0LL, 8, 3)); 224 EXPECT_EQ(552u, alignTo(321, 255, 42)); 225 } 226 227 template<typename T> 228 void SaturatingAddTestHelper() 229 { 230 const T Max = std::numeric_limits<T>::max(); 231 bool ResultOverflowed; 232 233 EXPECT_EQ(T(3), SaturatingAdd(T(1), T(2))); 234 EXPECT_EQ(T(3), SaturatingAdd(T(1), T(2), &ResultOverflowed)); 235 EXPECT_FALSE(ResultOverflowed); 236 237 EXPECT_EQ(Max, SaturatingAdd(Max, T(1))); 238 EXPECT_EQ(Max, SaturatingAdd(Max, T(1), &ResultOverflowed)); 239 EXPECT_TRUE(ResultOverflowed); 240 241 EXPECT_EQ(Max, SaturatingAdd(T(1), T(Max - 1))); 242 EXPECT_EQ(Max, SaturatingAdd(T(1), T(Max - 1), &ResultOverflowed)); 243 EXPECT_FALSE(ResultOverflowed); 244 245 EXPECT_EQ(Max, SaturatingAdd(T(1), Max)); 246 EXPECT_EQ(Max, SaturatingAdd(T(1), Max, &ResultOverflowed)); 247 EXPECT_TRUE(ResultOverflowed); 248 249 EXPECT_EQ(Max, SaturatingAdd(Max, Max)); 250 EXPECT_EQ(Max, SaturatingAdd(Max, Max, &ResultOverflowed)); 251 EXPECT_TRUE(ResultOverflowed); 252 } 253 254 TEST(MathExtras, SaturatingAdd) { 255 SaturatingAddTestHelper<uint8_t>(); 256 SaturatingAddTestHelper<uint16_t>(); 257 SaturatingAddTestHelper<uint32_t>(); 258 SaturatingAddTestHelper<uint64_t>(); 259 } 260 261 template<typename T> 262 void SaturatingMultiplyTestHelper() 263 { 264 const T Max = std::numeric_limits<T>::max(); 265 bool ResultOverflowed; 266 267 // Test basic multiplication. 268 EXPECT_EQ(T(6), SaturatingMultiply(T(2), T(3))); 269 EXPECT_EQ(T(6), SaturatingMultiply(T(2), T(3), &ResultOverflowed)); 270 EXPECT_FALSE(ResultOverflowed); 271 272 EXPECT_EQ(T(6), SaturatingMultiply(T(3), T(2))); 273 EXPECT_EQ(T(6), SaturatingMultiply(T(3), T(2), &ResultOverflowed)); 274 EXPECT_FALSE(ResultOverflowed); 275 276 // Test multiplication by zero. 277 EXPECT_EQ(T(0), SaturatingMultiply(T(0), T(0))); 278 EXPECT_EQ(T(0), SaturatingMultiply(T(0), T(0), &ResultOverflowed)); 279 EXPECT_FALSE(ResultOverflowed); 280 281 EXPECT_EQ(T(0), SaturatingMultiply(T(1), T(0))); 282 EXPECT_EQ(T(0), SaturatingMultiply(T(1), T(0), &ResultOverflowed)); 283 EXPECT_FALSE(ResultOverflowed); 284 285 EXPECT_EQ(T(0), SaturatingMultiply(T(0), T(1))); 286 EXPECT_EQ(T(0), SaturatingMultiply(T(0), T(1), &ResultOverflowed)); 287 EXPECT_FALSE(ResultOverflowed); 288 289 EXPECT_EQ(T(0), SaturatingMultiply(Max, T(0))); 290 EXPECT_EQ(T(0), SaturatingMultiply(Max, T(0), &ResultOverflowed)); 291 EXPECT_FALSE(ResultOverflowed); 292 293 EXPECT_EQ(T(0), SaturatingMultiply(T(0), Max)); 294 EXPECT_EQ(T(0), SaturatingMultiply(T(0), Max, &ResultOverflowed)); 295 EXPECT_FALSE(ResultOverflowed); 296 297 // Test multiplication by maximum value. 298 EXPECT_EQ(Max, SaturatingMultiply(Max, T(2))); 299 EXPECT_EQ(Max, SaturatingMultiply(Max, T(2), &ResultOverflowed)); 300 EXPECT_TRUE(ResultOverflowed); 301 302 EXPECT_EQ(Max, SaturatingMultiply(T(2), Max)); 303 EXPECT_EQ(Max, SaturatingMultiply(T(2), Max, &ResultOverflowed)); 304 EXPECT_TRUE(ResultOverflowed); 305 306 EXPECT_EQ(Max, SaturatingMultiply(Max, Max)); 307 EXPECT_EQ(Max, SaturatingMultiply(Max, Max, &ResultOverflowed)); 308 EXPECT_TRUE(ResultOverflowed); 309 310 // Test interesting boundary conditions for algorithm - 311 // ((1 << A) - 1) * ((1 << B) + K) for K in [-1, 0, 1] 312 // and A + B == std::numeric_limits<T>::digits. 313 // We expect overflow iff A > B and K = 1. 314 const int Digits = std::numeric_limits<T>::digits; 315 for (int A = 1, B = Digits - 1; B >= 1; ++A, --B) { 316 for (int K = -1; K <= 1; ++K) { 317 T X = (T(1) << A) - T(1); 318 T Y = (T(1) << B) + K; 319 bool OverflowExpected = A > B && K == 1; 320 321 if(OverflowExpected) { 322 EXPECT_EQ(Max, SaturatingMultiply(X, Y)); 323 EXPECT_EQ(Max, SaturatingMultiply(X, Y, &ResultOverflowed)); 324 EXPECT_TRUE(ResultOverflowed); 325 } else { 326 EXPECT_EQ(X * Y, SaturatingMultiply(X, Y)); 327 EXPECT_EQ(X * Y, SaturatingMultiply(X, Y, &ResultOverflowed)); 328 EXPECT_FALSE(ResultOverflowed); 329 } 330 } 331 } 332 } 333 334 TEST(MathExtras, SaturatingMultiply) { 335 SaturatingMultiplyTestHelper<uint8_t>(); 336 SaturatingMultiplyTestHelper<uint16_t>(); 337 SaturatingMultiplyTestHelper<uint32_t>(); 338 SaturatingMultiplyTestHelper<uint64_t>(); 339 } 340 341 template<typename T> 342 void SaturatingMultiplyAddTestHelper() 343 { 344 const T Max = std::numeric_limits<T>::max(); 345 bool ResultOverflowed; 346 347 // Test basic multiply-add. 348 EXPECT_EQ(T(16), SaturatingMultiplyAdd(T(2), T(3), T(10))); 349 EXPECT_EQ(T(16), SaturatingMultiplyAdd(T(2), T(3), T(10), &ResultOverflowed)); 350 EXPECT_FALSE(ResultOverflowed); 351 352 // Test multiply overflows, add doesn't overflow 353 EXPECT_EQ(Max, SaturatingMultiplyAdd(Max, Max, T(0), &ResultOverflowed)); 354 EXPECT_TRUE(ResultOverflowed); 355 356 // Test multiply doesn't overflow, add overflows 357 EXPECT_EQ(Max, SaturatingMultiplyAdd(T(1), T(1), Max, &ResultOverflowed)); 358 EXPECT_TRUE(ResultOverflowed); 359 360 // Test multiply-add with Max as operand 361 EXPECT_EQ(Max, SaturatingMultiplyAdd(T(1), T(1), Max, &ResultOverflowed)); 362 EXPECT_TRUE(ResultOverflowed); 363 364 EXPECT_EQ(Max, SaturatingMultiplyAdd(T(1), Max, T(1), &ResultOverflowed)); 365 EXPECT_TRUE(ResultOverflowed); 366 367 EXPECT_EQ(Max, SaturatingMultiplyAdd(Max, Max, T(1), &ResultOverflowed)); 368 EXPECT_TRUE(ResultOverflowed); 369 370 EXPECT_EQ(Max, SaturatingMultiplyAdd(Max, Max, Max, &ResultOverflowed)); 371 EXPECT_TRUE(ResultOverflowed); 372 373 // Test multiply-add with 0 as operand 374 EXPECT_EQ(T(1), SaturatingMultiplyAdd(T(1), T(1), T(0), &ResultOverflowed)); 375 EXPECT_FALSE(ResultOverflowed); 376 377 EXPECT_EQ(T(1), SaturatingMultiplyAdd(T(1), T(0), T(1), &ResultOverflowed)); 378 EXPECT_FALSE(ResultOverflowed); 379 380 EXPECT_EQ(T(1), SaturatingMultiplyAdd(T(0), T(0), T(1), &ResultOverflowed)); 381 EXPECT_FALSE(ResultOverflowed); 382 383 EXPECT_EQ(T(0), SaturatingMultiplyAdd(T(0), T(0), T(0), &ResultOverflowed)); 384 EXPECT_FALSE(ResultOverflowed); 385 386 } 387 388 TEST(MathExtras, SaturatingMultiplyAdd) { 389 SaturatingMultiplyAddTestHelper<uint8_t>(); 390 SaturatingMultiplyAddTestHelper<uint16_t>(); 391 SaturatingMultiplyAddTestHelper<uint32_t>(); 392 SaturatingMultiplyAddTestHelper<uint64_t>(); 393 } 394 395 TEST(MathExtras, IsShiftedUInt) { 396 EXPECT_TRUE((isShiftedUInt<1, 0>(0))); 397 EXPECT_TRUE((isShiftedUInt<1, 0>(1))); 398 EXPECT_FALSE((isShiftedUInt<1, 0>(2))); 399 EXPECT_FALSE((isShiftedUInt<1, 0>(3))); 400 EXPECT_FALSE((isShiftedUInt<1, 0>(0x8000000000000000))); 401 EXPECT_TRUE((isShiftedUInt<1, 63>(0x8000000000000000))); 402 EXPECT_TRUE((isShiftedUInt<2, 62>(0xC000000000000000))); 403 EXPECT_FALSE((isShiftedUInt<2, 62>(0xE000000000000000))); 404 405 // 0x201 is ten bits long and has a 1 in the MSB and LSB. 406 EXPECT_TRUE((isShiftedUInt<10, 5>(uint64_t(0x201) << 5))); 407 EXPECT_FALSE((isShiftedUInt<10, 5>(uint64_t(0x201) << 4))); 408 EXPECT_FALSE((isShiftedUInt<10, 5>(uint64_t(0x201) << 6))); 409 } 410 411 TEST(MathExtras, IsShiftedInt) { 412 EXPECT_TRUE((isShiftedInt<1, 0>(0))); 413 EXPECT_TRUE((isShiftedInt<1, 0>(-1))); 414 EXPECT_FALSE((isShiftedInt<1, 0>(2))); 415 EXPECT_FALSE((isShiftedInt<1, 0>(3))); 416 EXPECT_FALSE((isShiftedInt<1, 0>(0x8000000000000000))); 417 EXPECT_TRUE((isShiftedInt<1, 63>(0x8000000000000000))); 418 EXPECT_TRUE((isShiftedInt<2, 62>(0xC000000000000000))); 419 EXPECT_FALSE((isShiftedInt<2, 62>(0xE000000000000000))); 420 421 // 0x201 is ten bits long and has a 1 in the MSB and LSB. 422 EXPECT_TRUE((isShiftedInt<11, 5>(int64_t(0x201) << 5))); 423 EXPECT_FALSE((isShiftedInt<11, 5>(int64_t(0x201) << 3))); 424 EXPECT_FALSE((isShiftedInt<11, 5>(int64_t(0x201) << 6))); 425 EXPECT_TRUE((isShiftedInt<11, 5>(-(int64_t(0x201) << 5)))); 426 EXPECT_FALSE((isShiftedInt<11, 5>(-(int64_t(0x201) << 3)))); 427 EXPECT_FALSE((isShiftedInt<11, 5>(-(int64_t(0x201) << 6)))); 428 429 EXPECT_TRUE((isShiftedInt<6, 10>(-(int64_t(1) << 15)))); 430 EXPECT_FALSE((isShiftedInt<6, 10>(int64_t(1) << 15))); 431 } 432 433 } // namespace 434