lib/Support/APInt.cpp

   1 //===-- APInt.cpp - Implement APInt class ---------------------------------===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by Sheng Zhou and is distributed under the
   6 // University of Illinois Open Source License. See LICENSE.TXT for details.
   7 //
   8 //===----------------------------------------------------------------------===//
   9 //
  10 // This file implements a class to represent arbitrary precision integer
  11 // constant values and provide a variety of arithmetic operations on them.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #define DEBUG_TYPE "apint"
  16 #include "llvm/ADT/APInt.h"
  17 #include "llvm/DerivedTypes.h"
  18 #include "llvm/Support/Debug.h"
  19 #include "llvm/Support/MathExtras.h"
  20 #include <cstring>
  21 #include <cstdlib>
  22 #ifndef NDEBUG
  23 #include <iomanip>
  24 #endif
  25
  26 using namespace llvm;
  27
  28 /// A utility function for allocating memory, checking for allocation failures,
  29 /// and ensuring the contents are zeroed.
  30 inline static uint64_t* getClearedMemory(uint32_t numWords) {
  31   uint64_t * result = new uint64_t[numWords];
  32   assert(result && "APInt memory allocation fails!");
  33   memset(result, 0, numWords * sizeof(uint64_t));
  34   return result;
  35 }
  36
  37 /// A utility function for allocating memory and checking for allocation
  38 /// failure.  The content is not zeroed.
  39 inline static uint64_t* getMemory(uint32_t numWords) {
  40   uint64_t * result = new uint64_t[numWords];
  41   assert(result && "APInt memory allocation fails!");
  42   return result;
  43 }
  44
  45 APInt::APInt(uint32_t numBits, uint64_t val) : BitWidth(numBits), VAL(0) {
  46   assert(BitWidth >= IntegerType::MIN_INT_BITS && "bitwidth too small");
  47   assert(BitWidth <= IntegerType::MAX_INT_BITS && "bitwidth too large");
  48   if (isSingleWord())
  49     VAL = val;
  50   else {
  51     pVal = getClearedMemory(getNumWords());
  52     pVal[0] = val;
  53   }
  54   clearUnusedBits();
  55 }
  56
  57 APInt::APInt(uint32_t numBits, uint32_t numWords, uint64_t bigVal[])
  58   : BitWidth(numBits), VAL(0)  {
  59   assert(BitWidth >= IntegerType::MIN_INT_BITS && "bitwidth too small");
  60   assert(BitWidth <= IntegerType::MAX_INT_BITS && "bitwidth too large");
  61   assert(bigVal && "Null pointer detected!");
  62   if (isSingleWord())
  63     VAL = bigVal[0];
  64   else {
  65     // Get memory, cleared to 0
  66     pVal = getClearedMemory(getNumWords());
  67     // Calculate the number of words to copy
  68     uint32_t words = std::min<uint32_t>(numWords, getNumWords());
  69     // Copy the words from bigVal to pVal
  70     memcpy(pVal, bigVal, words * APINT_WORD_SIZE);
  71   }
  72   // Make sure unused high bits are cleared
  73   clearUnusedBits();
  74 }
  75
  76 APInt::APInt(uint32_t numbits, const char StrStart[], uint32_t slen,
  77              uint8_t radix)
  78   : BitWidth(numbits), VAL(0) {
  79   fromString(numbits, StrStart, slen, radix);
  80 }
  81
  82 APInt::APInt(uint32_t numbits, const std::string& Val, uint8_t radix)
  83   : BitWidth(numbits), VAL(0) {
  84   assert(!Val.empty() && "String empty?");
  85   fromString(numbits, Val.c_str(), Val.size(), radix);
  86 }
  87
  88 APInt::APInt(const APInt& that)
  89   : BitWidth(that.BitWidth), VAL(0) {
  90   if (isSingleWord())
  91     VAL = that.VAL;
  92   else {
  93     pVal = getMemory(getNumWords());
  94     memcpy(pVal, that.pVal, getNumWords() * APINT_WORD_SIZE);
  95   }
  96 }
  97
  98 APInt::~APInt() {
  99   if (!isSingleWord() && pVal)
 100     delete [] pVal;
 101 }
 102
 103 APInt& APInt::operator=(const APInt& RHS) {
 104   // Don't do anything for X = X
 105   if (this == &RHS)
 106     return *this;
 107
 108   // If the bitwidths are the same, we can avoid mucking with memory
 109   if (BitWidth == RHS.getBitWidth()) {
 110     if (isSingleWord())
 111       VAL = RHS.VAL;
 112     else
 113       memcpy(pVal, RHS.pVal, getNumWords() * APINT_WORD_SIZE);
 114     return *this;
 115   }
 116
 117   if (isSingleWord())
 118     if (RHS.isSingleWord())
 119       VAL = RHS.VAL;
 120     else {
 121       VAL = 0;
 122       pVal = getMemory(RHS.getNumWords());
 123       memcpy(pVal, RHS.pVal, RHS.getNumWords() * APINT_WORD_SIZE);
 124     }
 125   else if (getNumWords() == RHS.getNumWords())
 126     memcpy(pVal, RHS.pVal, RHS.getNumWords() * APINT_WORD_SIZE);
 127   else if (RHS.isSingleWord()) {
 128     delete [] pVal;
 129     VAL = RHS.VAL;
 130   } else {
 131     delete [] pVal;
 132     pVal = getMemory(RHS.getNumWords());
 133     memcpy(pVal, RHS.pVal, RHS.getNumWords() * APINT_WORD_SIZE);
 134   }
 135   BitWidth = RHS.BitWidth;
 136   return clearUnusedBits();
 137 }
 138
 139 APInt& APInt::operator=(uint64_t RHS) {
 140   if (isSingleWord())
 141     VAL = RHS;
 142   else {
 143     pVal[0] = RHS;
 144     memset(pVal+1, 0, (getNumWords() - 1) * APINT_WORD_SIZE);
 145   }
 146   return clearUnusedBits();
 147 }
 148
 149 /// add_1 - This function adds a single "digit" integer, y, to the multiple
 150 /// "digit" integer array,  x[]. x[] is modified to reflect the addition and
 151 /// 1 is returned if there is a carry out, otherwise 0 is returned.
 152 /// @returns the carry of the addition.
 153 static bool add_1(uint64_t dest[], uint64_t x[], uint32_t len, uint64_t y) {
 154   for (uint32_t i = 0; i < len; ++i) {
 155     dest[i] = y + x[i];
 156     if (dest[i] < y)
 157       y = 1; // Carry one to next digit.
 158     else {
 159       y = 0; // No need to carry so exit early
 160       break;
 161     }
 162   }
 163   return y;
 164 }
 165
 166 /// @brief Prefix increment operator. Increments the APInt by one.
 167 APInt& APInt::operator++() {
 168   if (isSingleWord())
 169     ++VAL;
 170   else
 171     add_1(pVal, pVal, getNumWords(), 1);
 172   return clearUnusedBits();
 173 }
 174
 175 /// sub_1 - This function subtracts a single "digit" (64-bit word), y, from
 176 /// the multi-digit integer array, x[], propagating the borrowed 1 value until
 177 /// no further borrowing is neeeded or it runs out of "digits" in x.  The result
 178 /// is 1 if "borrowing" exhausted the digits in x, or 0 if x was not exhausted.
 179 /// In other words, if y > x then this function returns 1, otherwise 0.
 180 /// @returns the borrow out of the subtraction
 181 static bool sub_1(uint64_t x[], uint32_t len, uint64_t y) {
 182   for (uint32_t i = 0; i < len; ++i) {
 183     uint64_t X = x[i];
 184     x[i] -= y;
 185     if (y > X)
 186       y = 1;  // We have to "borrow 1" from next "digit"
 187     else {
 188       y = 0;  // No need to borrow
 189       break;  // Remaining digits are unchanged so exit early
 190     }
 191   }
 192   return bool(y);
 193 }
 194
 195 /// @brief Prefix decrement operator. Decrements the APInt by one.
 196 APInt& APInt::operator--() {
 197   if (isSingleWord())
 198     --VAL;
 199   else
 200     sub_1(pVal, getNumWords(), 1);
 201   return clearUnusedBits();
 202 }
 203
 204 /// add - This function adds the integer array x to the integer array Y and
 205 /// places the result in dest.
 206 /// @returns the carry out from the addition
 207 /// @brief General addition of 64-bit integer arrays
 208 static bool add(uint64_t *dest, const uint64_t *x, const uint64_t *y,
 209                 uint32_t len) {
 210   bool carry = false;
 211   for (uint32_t i = 0; i< len; ++i) {
 212     uint64_t limit = std::min(x[i],y[i]); // must come first in case dest == x
 213     dest[i] = x[i] + y[i] + carry;
 214     carry = dest[i] < limit || (carry && dest[i] == limit);
 215   }
 216   return carry;
 217 }
 218
 219 /// Adds the RHS APint to this APInt.
 220 /// @returns this, after addition of RHS.
 221 /// @brief Addition assignment operator.
 222 APInt& APInt::operator+=(const APInt& RHS) {
 223   assert(BitWidth == RHS.BitWidth && "Bit widths must be the same");
 224   if (isSingleWord())
 225     VAL += RHS.VAL;
 226   else {
 227     add(pVal, pVal, RHS.pVal, getNumWords());
 228   }
 229   return clearUnusedBits();
 230 }
 231
 232 /// Subtracts the integer array y from the integer array x
 233 /// @returns returns the borrow out.
 234 /// @brief Generalized subtraction of 64-bit integer arrays.
 235 static bool sub(uint64_t *dest, const uint64_t *x, const uint64_t *y,
 236                 uint32_t len) {
 237   bool borrow = false;
 238   for (uint32_t i = 0; i < len; ++i) {
 239     uint64_t x_tmp = borrow ? x[i] - 1 : x[i];
 240     borrow = y[i] > x_tmp || (borrow && x[i] == 0);
 241     dest[i] = x_tmp - y[i];
 242   }
 243   return borrow;
 244 }
 245
 246 /// Subtracts the RHS APInt from this APInt
 247 /// @returns this, after subtraction
 248 /// @brief Subtraction assignment operator.
 249 APInt& APInt::operator-=(const APInt& RHS) {
 250   assert(BitWidth == RHS.BitWidth && "Bit widths must be the same");
 251   if (isSingleWord())
 252     VAL -= RHS.VAL;
 253   else
 254     sub(pVal, pVal, RHS.pVal, getNumWords());
 255   return clearUnusedBits();
 256 }
 257
 258 /// Multiplies an integer array, x by a a uint64_t integer and places the result
 259 /// into dest.
 260 /// @returns the carry out of the multiplication.
 261 /// @brief Multiply a multi-digit APInt by a single digit (64-bit) integer.
 262 static uint64_t mul_1(uint64_t dest[], uint64_t x[], uint32_t len, uint64_t y) {
 263   // Split y into high 32-bit part (hy)  and low 32-bit part (ly)
 264   uint64_t ly = y & 0xffffffffULL, hy = y >> 32;
 265   uint64_t carry = 0;
 266
 267   // For each digit of x.
 268   for (uint32_t i = 0; i < len; ++i) {
 269     // Split x into high and low words
 270     uint64_t lx = x[i] & 0xffffffffULL;
 271     uint64_t hx = x[i] >> 32;
 272     // hasCarry - A flag to indicate if there is a carry to the next digit.
 273     // hasCarry == 0, no carry
 274     // hasCarry == 1, has carry
 275     // hasCarry == 2, no carry and the calculation result == 0.
 276     uint8_t hasCarry = 0;
 277     dest[i] = carry + lx * ly;
 278     // Determine if the add above introduces carry.
 279     hasCarry = (dest[i] < carry) ? 1 : 0;
 280     carry = hx * ly + (dest[i] >> 32) + (hasCarry ? (1ULL << 32) : 0);
 281     // The upper limit of carry can be (2^32 - 1)(2^32 - 1) +
 282     // (2^32 - 1) + 2^32 = 2^64.
 283     hasCarry = (!carry && hasCarry) ? 1 : (!carry ? 2 : 0);
 284
 285     carry += (lx * hy) & 0xffffffffULL;
 286     dest[i] = (carry << 32) | (dest[i] & 0xffffffffULL);
 287     carry = (((!carry && hasCarry != 2) || hasCarry == 1) ? (1ULL << 32) : 0) +
 288             (carry >> 32) + ((lx * hy) >> 32) + hx * hy;
 289   }
 290   return carry;
 291 }
 292
 293 /// Multiplies integer array x by integer array y and stores the result into
 294 /// the integer array dest. Note that dest's size must be >= xlen + ylen.
 295 /// @brief Generalized multiplicate of integer arrays.
 296 static void mul(uint64_t dest[], uint64_t x[], uint32_t xlen, uint64_t y[],
 297                 uint32_t ylen) {
 298   dest[xlen] = mul_1(dest, x, xlen, y[0]);
 299   for (uint32_t i = 1; i < ylen; ++i) {
 300     uint64_t ly = y[i] & 0xffffffffULL, hy = y[i] >> 32;
 301     uint64_t carry = 0, lx = 0, hx = 0;
 302     for (uint32_t j = 0; j < xlen; ++j) {
 303       lx = x[j] & 0xffffffffULL;
 304       hx = x[j] >> 32;
 305       // hasCarry - A flag to indicate if has carry.
 306       // hasCarry == 0, no carry
 307       // hasCarry == 1, has carry
 308       // hasCarry == 2, no carry and the calculation result == 0.
 309       uint8_t hasCarry = 0;
 310       uint64_t resul = carry + lx * ly;
 311       hasCarry = (resul < carry) ? 1 : 0;
 312       carry = (hasCarry ? (1ULL << 32) : 0) + hx * ly + (resul >> 32);
 313       hasCarry = (!carry && hasCarry) ? 1 : (!carry ? 2 : 0);
 314
 315       carry += (lx * hy) & 0xffffffffULL;
 316       resul = (carry << 32) | (resul & 0xffffffffULL);
 317       dest[i+j] += resul;
 318       carry = (((!carry && hasCarry != 2) || hasCarry == 1) ? (1ULL << 32) : 0)+
 319               (carry >> 32) + (dest[i+j] < resul ? 1 : 0) +
 320               ((lx * hy) >> 32) + hx * hy;
 321     }
 322     dest[i+xlen] = carry;
 323   }
 324 }
 325
 326 APInt& APInt::operator*=(const APInt& RHS) {
 327   assert(BitWidth == RHS.BitWidth && "Bit widths must be the same");
 328   if (isSingleWord()) {
 329     VAL *= RHS.VAL;
 330     clearUnusedBits();
 331     return *this;
 332   }
 333
 334   // Get some bit facts about LHS and check for zero
 335   uint32_t lhsBits = getActiveBits();
 336   uint32_t lhsWords = !lhsBits ? 0 : whichWord(lhsBits - 1) + 1;
 337   if (!lhsWords)
 338     // 0 * X ===> 0
 339     return *this;
 340
 341   // Get some bit facts about RHS and check for zero
 342   uint32_t rhsBits = RHS.getActiveBits();
 343   uint32_t rhsWords = !rhsBits ? 0 : whichWord(rhsBits - 1) + 1;
 344   if (!rhsWords) {
 345     // X * 0 ===> 0
 346     clear();
 347     return *this;
 348   }
 349
 350   // Allocate space for the result
 351   uint32_t destWords = rhsWords + lhsWords;
 352   uint64_t *dest = getMemory(destWords);
 353
 354   // Perform the long multiply
 355   mul(dest, pVal, lhsWords, RHS.pVal, rhsWords);
 356
 357   // Copy result back into *this
 358   clear();
 359   uint32_t wordsToCopy = destWords >= getNumWords() ? getNumWords() : destWords;
 360   memcpy(pVal, dest, wordsToCopy * APINT_WORD_SIZE);
 361
 362   // delete dest array and return
 363   delete[] dest;
 364   return *this;
 365 }
 366
 367 APInt& APInt::operator&=(const APInt& RHS) {
 368   assert(BitWidth == RHS.BitWidth && "Bit widths must be the same");
 369   if (isSingleWord()) {
 370     VAL &= RHS.VAL;
 371     return *this;
 372   }
 373   uint32_t numWords = getNumWords();
 374   for (uint32_t i = 0; i < numWords; ++i)
 375     pVal[i] &= RHS.pVal[i];
 376   return *this;
 377 }
 378
 379 APInt& APInt::operator|=(const APInt& RHS) {
 380   assert(BitWidth == RHS.BitWidth && "Bit widths must be the same");
 381   if (isSingleWord()) {
 382     VAL |= RHS.VAL;
 383     return *this;
 384   }
 385   uint32_t numWords = getNumWords();
 386   for (uint32_t i = 0; i < numWords; ++i)
 387     pVal[i] |= RHS.pVal[i];
 388   return *this;
 389 }
 390
 391 APInt& APInt::operator^=(const APInt& RHS) {
 392   assert(BitWidth == RHS.BitWidth && "Bit widths must be the same");
 393   if (isSingleWord()) {
 394     VAL ^= RHS.VAL;
 395     this->clearUnusedBits();
 396     return *this;
 397   }
 398   uint32_t numWords = getNumWords();
 399   for (uint32_t i = 0; i < numWords; ++i)
 400     pVal[i] ^= RHS.pVal[i];
 401   return clearUnusedBits();
 402 }
 403
 404 APInt APInt::operator&(const APInt& RHS) const {
 405   assert(BitWidth == RHS.BitWidth && "Bit widths must be the same");
 406   if (isSingleWord())
 407     return APInt(getBitWidth(), VAL & RHS.VAL);
 408
 409   uint32_t numWords = getNumWords();
 410   uint64_t* val = getMemory(numWords);
 411   for (uint32_t i = 0; i < numWords; ++i)
 412     val[i] = pVal[i] & RHS.pVal[i];
 413   return APInt(val, getBitWidth());
 414 }
 415
 416 APInt APInt::operator|(const APInt& RHS) const {
 417   assert(BitWidth == RHS.BitWidth && "Bit widths must be the same");
 418   if (isSingleWord())
 419     return APInt(getBitWidth(), VAL | RHS.VAL);
 420
 421   uint32_t numWords = getNumWords();
 422   uint64_t *val = getMemory(numWords);
 423   for (uint32_t i = 0; i < numWords; ++i)
 424     val[i] = pVal[i] | RHS.pVal[i];
 425   return APInt(val, getBitWidth());
 426 }
 427
 428 APInt APInt::operator^(const APInt& RHS) const {
 429   assert(BitWidth == RHS.BitWidth && "Bit widths must be the same");
 430   if (isSingleWord())
 431     return APInt(BitWidth, VAL ^ RHS.VAL);
 432
 433   uint32_t numWords = getNumWords();
 434   uint64_t *val = getMemory(numWords);
 435   for (uint32_t i = 0; i < numWords; ++i)
 436     val[i] = pVal[i] ^ RHS.pVal[i];
 437
 438   // 0^0==1 so clear the high bits in case they got set.
 439   return APInt(val, getBitWidth()).clearUnusedBits();
 440 }
 441
 442 bool APInt::operator !() const {
 443   if (isSingleWord())
 444     return !VAL;
 445
 446   for (uint32_t i = 0; i < getNumWords(); ++i)
 447     if (pVal[i])
 448       return false;
 449   return true;
 450 }
 451
 452 APInt APInt::operator*(const APInt& RHS) const {
 453   assert(BitWidth == RHS.BitWidth && "Bit widths must be the same");
 454   if (isSingleWord())
 455     return APInt(BitWidth, VAL * RHS.VAL);
 456   APInt Result(*this);
 457   Result *= RHS;
 458   return Result.clearUnusedBits();
 459 }
 460
 461 APInt APInt::operator+(const APInt& RHS) const {
 462   assert(BitWidth == RHS.BitWidth && "Bit widths must be the same");
 463   if (isSingleWord())
 464     return APInt(BitWidth, VAL + RHS.VAL);
 465   APInt Result(BitWidth, 0);
 466   add(Result.pVal, this->pVal, RHS.pVal, getNumWords());
 467   return Result.clearUnusedBits();
 468 }
 469
 470 APInt APInt::operator-(const APInt& RHS) const {
 471   assert(BitWidth == RHS.BitWidth && "Bit widths must be the same");
 472   if (isSingleWord())
 473     return APInt(BitWidth, VAL - RHS.VAL);
 474   APInt Result(BitWidth, 0);
 475   sub(Result.pVal, this->pVal, RHS.pVal, getNumWords());
 476   return Result.clearUnusedBits();
 477 }
 478
 479 bool APInt::operator[](uint32_t bitPosition) const {
 480   return (maskBit(bitPosition) &
 481           (isSingleWord() ?  VAL : pVal[whichWord(bitPosition)])) != 0;
 482 }
 483
 484 bool APInt::operator==(const APInt& RHS) const {
 485   assert(BitWidth == RHS.BitWidth && "Comparison requires equal bit widths");
 486   if (isSingleWord())
 487     return VAL == RHS.VAL;
 488
 489   // Get some facts about the number of bits used in the two operands.
 490   uint32_t n1 = getActiveBits();
 491   uint32_t n2 = RHS.getActiveBits();
 492
 493   // If the number of bits isn't the same, they aren't equal
 494   if (n1 != n2)
 495     return false;
 496
 497   // If the number of bits fits in a word, we only need to compare the low word.
 498   if (n1 <= APINT_BITS_PER_WORD)
 499     return pVal[0] == RHS.pVal[0];
 500
 501   // Otherwise, compare everything
 502   for (int i = whichWord(n1 - 1); i >= 0; --i)
 503     if (pVal[i] != RHS.pVal[i])
 504       return false;
 505   return true;
 506 }
 507
 508 bool APInt::operator==(uint64_t Val) const {
 509   if (isSingleWord())
 510     return VAL == Val;
 511
 512   uint32_t n = getActiveBits();
 513   if (n <= APINT_BITS_PER_WORD)
 514     return pVal[0] == Val;
 515   else
 516     return false;
 517 }
 518
 519 bool APInt::ult(const APInt& RHS) const {
 520   assert(BitWidth == RHS.BitWidth && "Bit widths must be same for comparison");
 521   if (isSingleWord())
 522     return VAL < RHS.VAL;
 523
 524   // Get active bit length of both operands
 525   uint32_t n1 = getActiveBits();
 526   uint32_t n2 = RHS.getActiveBits();
 527
 528   // If magnitude of LHS is less than RHS, return true.
 529   if (n1 < n2)
 530     return true;
 531
 532   // If magnitude of RHS is greather than LHS, return false.
 533   if (n2 < n1)
 534     return false;
 535
 536   // If they bot fit in a word, just compare the low order word
 537   if (n1 <= APINT_BITS_PER_WORD && n2 <= APINT_BITS_PER_WORD)
 538     return pVal[0] < RHS.pVal[0];
 539
 540   // Otherwise, compare all words
 541   uint32_t topWord = whichWord(std::max(n1,n2)-1);
 542   for (int i = topWord; i >= 0; --i) {
 543     if (pVal[i] > RHS.pVal[i])
 544       return false;
 545     if (pVal[i] < RHS.pVal[i])
 546       return true;
 547   }
 548   return false;
 549 }
 550
 551 bool APInt::slt(const APInt& RHS) const {
 552   assert(BitWidth == RHS.BitWidth && "Bit widths must be same for comparison");
 553   if (isSingleWord()) {
 554     int64_t lhsSext = (int64_t(VAL) << (64-BitWidth)) >> (64-BitWidth);
 555     int64_t rhsSext = (int64_t(RHS.VAL) << (64-BitWidth)) >> (64-BitWidth);
 556     return lhsSext < rhsSext;
 557   }
 558
 559   APInt lhs(*this);
 560   APInt rhs(RHS);
 561   bool lhsNeg = isNegative();
 562   bool rhsNeg = rhs.isNegative();
 563   if (lhsNeg) {
 564     // Sign bit is set so perform two's complement to make it positive
 565     lhs.flip();
 566     lhs++;
 567   }
 568   if (rhsNeg) {
 569     // Sign bit is set so perform two's complement to make it positive
 570     rhs.flip();
 571     rhs++;
 572   }
 573
 574   // Now we have unsigned values to compare so do the comparison if necessary
 575   // based on the negativeness of the values.
 576   if (lhsNeg)
 577     if (rhsNeg)
 578       return lhs.ugt(rhs);
 579     else
 580       return true;
 581   else if (rhsNeg)
 582     return false;
 583   else
 584     return lhs.ult(rhs);
 585 }
 586
 587 APInt& APInt::set(uint32_t bitPosition) {
 588   if (isSingleWord())
 589     VAL |= maskBit(bitPosition);
 590   else
 591     pVal[whichWord(bitPosition)] |= maskBit(bitPosition);
 592   return *this;
 593 }
 594
 595 APInt& APInt::set() {
 596   if (isSingleWord()) {
 597     VAL = -1ULL;
 598     return clearUnusedBits();
 599   }
 600
 601   // Set all the bits in all the words.
 602   for (uint32_t i = 0; i < getNumWords() - 1; ++i)
 603     pVal[i] = -1ULL;
 604   // Clear the unused ones
 605   return clearUnusedBits();
 606 }
 607
 608 /// Set the given bit to 0 whose position is given as "bitPosition".
 609 /// @brief Set a given bit to 0.
 610 APInt& APInt::clear(uint32_t bitPosition) {
 611   if (isSingleWord())
 612     VAL &= ~maskBit(bitPosition);
 613   else
 614     pVal[whichWord(bitPosition)] &= ~maskBit(bitPosition);
 615   return *this;
 616 }
 617
 618 /// @brief Set every bit to 0.
 619 APInt& APInt::clear() {
 620   if (isSingleWord())
 621     VAL = 0;
 622   else
 623     memset(pVal, 0, getNumWords() * APINT_WORD_SIZE);
 624   return *this;
 625 }
 626
 627 /// @brief Bitwise NOT operator. Performs a bitwise logical NOT operation on
 628 /// this APInt.
 629 APInt APInt::operator~() const {
 630   APInt Result(*this);
 631   Result.flip();
 632   return Result;
 633 }
 634
 635 /// @brief Toggle every bit to its opposite value.
 636 APInt& APInt::flip() {
 637   if (isSingleWord()) {
 638     VAL ^= -1ULL;
 639     return clearUnusedBits();
 640   }
 641   for (uint32_t i = 0; i < getNumWords(); ++i)
 642     pVal[i] ^= -1ULL;
 643   return clearUnusedBits();
 644 }
 645
 646 /// Toggle a given bit to its opposite value whose position is given
 647 /// as "bitPosition".
 648 /// @brief Toggles a given bit to its opposite value.
 649 APInt& APInt::flip(uint32_t bitPosition) {
 650   assert(bitPosition < BitWidth && "Out of the bit-width range!");
 651   if ((*this)[bitPosition]) clear(bitPosition);
 652   else set(bitPosition);
 653   return *this;
 654 }
 655
 656 uint64_t APInt::getHashValue() const {
 657   // Put the bit width into the low order bits.
 658   uint64_t hash = BitWidth;
 659
 660   // Add the sum of the words to the hash.
 661   if (isSingleWord())
 662     hash += VAL << 6; // clear separation of up to 64 bits
 663   else
 664     for (uint32_t i = 0; i < getNumWords(); ++i)
 665       hash += pVal[i] << 6; // clear sepration of up to 64 bits
 666   return hash;
 667 }
 668
 669 /// HiBits - This function returns the high "numBits" bits of this APInt.
 670 APInt APInt::getHiBits(uint32_t numBits) const {
 671   return APIntOps::lshr(*this, BitWidth - numBits);
 672 }
 673
 674 /// LoBits - This function returns the low "numBits" bits of this APInt.
 675 APInt APInt::getLoBits(uint32_t numBits) const {
 676   return APIntOps::lshr(APIntOps::shl(*this, BitWidth - numBits),
 677                         BitWidth - numBits);
 678 }
 679
 680 bool APInt::isPowerOf2() const {
 681   return (!!*this) && !(*this & (*this - APInt(BitWidth,1)));
 682 }
 683
 684 uint32_t APInt::countLeadingZeros() const {
 685   uint32_t Count = 0;
 686   if (isSingleWord())
 687     Count = CountLeadingZeros_64(VAL);
 688   else {
 689     for (uint32_t i = getNumWords(); i > 0u; --i) {
 690       if (pVal[i-1] == 0)
 691         Count += APINT_BITS_PER_WORD;
 692       else {
 693         Count += CountLeadingZeros_64(pVal[i-1]);
 694         break;
 695       }
 696     }
 697   }
 698   uint32_t remainder = BitWidth % APINT_BITS_PER_WORD;
 699   if (remainder)
 700     Count -= APINT_BITS_PER_WORD - remainder;
 701   return Count;
 702 }
 703
 704 static uint32_t countLeadingOnes_64(uint64_t V, uint32_t skip) {
 705   uint32_t Count = 0;
 706   if (skip)
 707     V <<= skip;
 708   while (V && (V & (1ULL << 63))) {
 709     Count++;
 710     V <<= 1;
 711   }
 712   return Count;
 713 }
 714
 715 uint32_t APInt::countLeadingOnes() const {
 716   if (isSingleWord())
 717     return countLeadingOnes_64(VAL, APINT_BITS_PER_WORD - BitWidth);
 718
 719   uint32_t highWordBits = BitWidth % APINT_BITS_PER_WORD;
 720   uint32_t shift = (highWordBits == 0 ? 0 : APINT_BITS_PER_WORD - highWordBits);
 721   int i = getNumWords() - 1;
 722   uint32_t Count = countLeadingOnes_64(pVal[i], shift);
 723   if (Count == highWordBits) {
 724     for (i--; i >= 0; --i) {
 725       if (pVal[i] == -1ULL)
 726         Count += APINT_BITS_PER_WORD;
 727       else {
 728         Count += countLeadingOnes_64(pVal[i], 0);
 729         break;
 730       }
 731     }
 732   }
 733   return Count;
 734 }
 735
 736 uint32_t APInt::countTrailingZeros() const {
 737   if (isSingleWord())
 738     return CountTrailingZeros_64(VAL);
 739   uint32_t Count = 0;
 740   uint32_t i = 0;
 741   for (; i < getNumWords() && pVal[i] == 0; ++i)
 742     Count += APINT_BITS_PER_WORD;
 743   if (i < getNumWords())
 744     Count += CountTrailingZeros_64(pVal[i]);
 745   return Count;
 746 }
 747
 748 uint32_t APInt::countPopulation() const {
 749   if (isSingleWord())
 750     return CountPopulation_64(VAL);
 751   uint32_t Count = 0;
 752   for (uint32_t i = 0; i < getNumWords(); ++i)
 753     Count += CountPopulation_64(pVal[i]);
 754   return Count;
 755 }
 756
 757 APInt APInt::byteSwap() const {
 758   assert(BitWidth >= 16 && BitWidth % 16 == 0 && "Cannot byteswap!");
 759   if (BitWidth == 16)
 760     return APInt(BitWidth, ByteSwap_16(VAL));
 761   else if (BitWidth == 32)
 762     return APInt(BitWidth, ByteSwap_32(VAL));
 763   else if (BitWidth == 48) {
 764     uint64_t Tmp1 = ((VAL >> 32) << 16) | (VAL & 0xFFFF);
 765     Tmp1 = ByteSwap_32(Tmp1);
 766     uint64_t Tmp2 = (VAL >> 16) & 0xFFFF;
 767     Tmp2 = ByteSwap_16(Tmp2);
 768     return
 769       APInt(BitWidth,
 770             (Tmp1 & 0xff) | ((Tmp1<<16) & 0xffff00000000ULL) | (Tmp2 << 16));
 771   } else if (BitWidth == 64)
 772     return APInt(BitWidth, ByteSwap_64(VAL));
 773   else {
 774     APInt Result(BitWidth, 0);
 775     char *pByte = (char*)Result.pVal;
 776     for (uint32_t i = 0; i < BitWidth / APINT_WORD_SIZE / 2; ++i) {
 777       char Tmp = pByte[i];
 778       pByte[i] = pByte[BitWidth / APINT_WORD_SIZE - 1 - i];
 779       pByte[BitWidth / APINT_WORD_SIZE - i - 1] = Tmp;
 780     }
 781     return Result;
 782   }
 783 }
 784
 785 APInt llvm::APIntOps::GreatestCommonDivisor(const APInt& API1,
 786                                             const APInt& API2) {
 787   APInt A = API1, B = API2;
 788   while (!!B) {
 789     APInt T = B;
 790     B = APIntOps::urem(A, B);
 791     A = T;
 792   }
 793   return A;
 794 }
 795
 796 APInt llvm::APIntOps::RoundDoubleToAPInt(double Double, uint32_t width) {
 797   union {
 798     double D;
 799     uint64_t I;
 800   } T;
 801   T.D = Double;
 802
 803   // Get the sign bit from the highest order bit
 804   bool isNeg = T.I >> 63;
 805
 806   // Get the 11-bit exponent and adjust for the 1023 bit bias
 807   int64_t exp = ((T.I >> 52) & 0x7ff) - 1023;
 808
 809   // If the exponent is negative, the value is < 0 so just return 0.
 810   if (exp < 0)
 811     return APInt(width, 0u);
 812
 813   // Extract the mantissa by clearing the top 12 bits (sign + exponent).
 814   uint64_t mantissa = (T.I & (~0ULL >> 12)) | 1ULL << 52;
 815
 816   // If the exponent doesn't shift all bits out of the mantissa
 817   if (exp < 52)
 818     return isNeg ? -APInt(width, mantissa >> (52 - exp)) :
 819                     APInt(width, mantissa >> (52 - exp));
 820
 821   // If the client didn't provide enough bits for us to shift the mantissa into
 822   // then the result is undefined, just return 0
 823   if (width <= exp - 52)
 824     return APInt(width, 0);
 825
 826   // Otherwise, we have to shift the mantissa bits up to the right location
 827   APInt Tmp(width, mantissa);
 828   Tmp = Tmp.shl(exp - 52);
 829   return isNeg ? -Tmp : Tmp;
 830 }
 831
 832 /// RoundToDouble - This function convert this APInt to a double.
 833 /// The layout for double is as following (IEEE Standard 754):
 834 ///  --------------------------------------
 835 /// |  Sign    Exponent    Fraction    Bias |
 836 /// |-------------------------------------- |
 837 /// |  1[63]   11[62-52]   52[51-00]   1023 |
 838 ///  --------------------------------------
 839 double APInt::roundToDouble(bool isSigned) const {
 840
 841   // Handle the simple case where the value is contained in one uint64_t.
 842   if (isSingleWord() || getActiveBits() <= APINT_BITS_PER_WORD) {
 843     if (isSigned) {
 844       int64_t sext = (int64_t(VAL) << (64-BitWidth)) >> (64-BitWidth);
 845       return double(sext);
 846     } else
 847       return double(VAL);
 848   }
 849
 850   // Determine if the value is negative.
 851   bool isNeg = isSigned ? (*this)[BitWidth-1] : false;
 852
 853   // Construct the absolute value if we're negative.
 854   APInt Tmp(isNeg ? -(*this) : (*this));
 855
 856   // Figure out how many bits we're using.
 857   uint32_t n = Tmp.getActiveBits();
 858
 859   // The exponent (without bias normalization) is just the number of bits
 860   // we are using. Note that the sign bit is gone since we constructed the
 861   // absolute value.
 862   uint64_t exp = n;
 863
 864   // Return infinity for exponent overflow
 865   if (exp > 1023) {
 866     if (!isSigned || !isNeg)
 867       return double(1.0E300 * 1.0E300); // positive infinity
 868     else
 869       return double(-1.0E300 * 1.0E300); // negative infinity
 870   }
 871   exp += 1023; // Increment for 1023 bias
 872
 873   // Number of bits in mantissa is 52. To obtain the mantissa value, we must
 874   // extract the high 52 bits from the correct words in pVal.
 875   uint64_t mantissa;
 876   unsigned hiWord = whichWord(n-1);
 877   if (hiWord == 0) {
 878     mantissa = Tmp.pVal[0];
 879     if (n > 52)
 880       mantissa >>= n - 52; // shift down, we want the top 52 bits.
 881   } else {
 882     assert(hiWord > 0 && "huh?");
 883     uint64_t hibits = Tmp.pVal[hiWord] << (52 - n % APINT_BITS_PER_WORD);
 884     uint64_t lobits = Tmp.pVal[hiWord-1] >> (11 + n % APINT_BITS_PER_WORD);
 885     mantissa = hibits | lobits;
 886   }
 887
 888   // The leading bit of mantissa is implicit, so get rid of it.
 889   uint64_t sign = isNeg ? (1ULL << (APINT_BITS_PER_WORD - 1)) : 0;
 890   union {
 891     double D;
 892     uint64_t I;
 893   } T;
 894   T.I = sign | (exp << 52) | mantissa;
 895   return T.D;
 896 }
 897
 898 // Truncate to new width.
 899 APInt &APInt::trunc(uint32_t width) {
 900   assert(width < BitWidth && "Invalid APInt Truncate request");
 901   assert(width >= IntegerType::MIN_INT_BITS && "Can't truncate to 0 bits");
 902   uint32_t wordsBefore = getNumWords();
 903   BitWidth = width;
 904   uint32_t wordsAfter = getNumWords();
 905   if (wordsBefore != wordsAfter) {
 906     if (wordsAfter == 1) {
 907       uint64_t *tmp = pVal;
 908       VAL = pVal[0];
 909       delete [] tmp;
 910     } else {
 911       uint64_t *newVal = getClearedMemory(wordsAfter);
 912       for (uint32_t i = 0; i < wordsAfter; ++i)
 913         newVal[i] = pVal[i];
 914       delete [] pVal;
 915       pVal = newVal;
 916     }
 917   }
 918   return clearUnusedBits();
 919 }
 920
 921 // Sign extend to a new width.
 922 APInt &APInt::sext(uint32_t width) {
 923   assert(width > BitWidth && "Invalid APInt SignExtend request");
 924   assert(width <= IntegerType::MAX_INT_BITS && "Too many bits");
 925   // If the sign bit isn't set, this is the same as zext.
 926   if (!isNegative()) {
 927     zext(width);
 928     return *this;
 929   }
 930
 931   // The sign bit is set. First, get some facts
 932   uint32_t wordsBefore = getNumWords();
 933   uint32_t wordBits = BitWidth % APINT_BITS_PER_WORD;
 934   BitWidth = width;
 935   uint32_t wordsAfter = getNumWords();
 936
 937   // Mask the high order word appropriately
 938   if (wordsBefore == wordsAfter) {
 939     uint32_t newWordBits = width % APINT_BITS_PER_WORD;
 940     // The extension is contained to the wordsBefore-1th word.
 941     uint64_t mask = ~0ULL;
 942     if (newWordBits)
 943       mask >>= APINT_BITS_PER_WORD - newWordBits;
 944     mask <<= wordBits;
 945     if (wordsBefore == 1)
 946       VAL |= mask;
 947     else
 948       pVal[wordsBefore-1] |= mask;
 949     return clearUnusedBits();
 950   }
 951
 952   uint64_t mask = wordBits == 0 ? 0 : ~0ULL << wordBits;
 953   uint64_t *newVal = getMemory(wordsAfter);
 954   if (wordsBefore == 1)
 955     newVal[0] = VAL | mask;
 956   else {
 957     for (uint32_t i = 0; i < wordsBefore; ++i)
 958       newVal[i] = pVal[i];
 959     newVal[wordsBefore-1] |= mask;
 960   }
 961   for (uint32_t i = wordsBefore; i < wordsAfter; i++)
 962     newVal[i] = -1ULL;
 963   if (wordsBefore != 1)
 964     delete [] pVal;
 965   pVal = newVal;
 966   return clearUnusedBits();
 967 }
 968
 969 //  Zero extend to a new width.
 970 APInt &APInt::zext(uint32_t width) {
 971   assert(width > BitWidth && "Invalid APInt ZeroExtend request");
 972   assert(width <= IntegerType::MAX_INT_BITS && "Too many bits");
 973   uint32_t wordsBefore = getNumWords();
 974   BitWidth = width;
 975   uint32_t wordsAfter = getNumWords();
 976   if (wordsBefore != wordsAfter) {
 977     uint64_t *newVal = getClearedMemory(wordsAfter);
 978     if (wordsBefore == 1)
 979       newVal[0] = VAL;
 980     else
 981       for (uint32_t i = 0; i < wordsBefore; ++i)
 982         newVal[i] = pVal[i];
 983     if (wordsBefore != 1)
 984       delete [] pVal;
 985     pVal = newVal;
 986   }
 987   return *this;
 988 }
 989
 990 APInt &APInt::zextOrTrunc(uint32_t width) {
 991   if (BitWidth < width)
 992     return zext(width);
 993   if (BitWidth > width)
 994     return trunc(width);
 995   return *this;
 996 }
 997
 998 APInt &APInt::sextOrTrunc(uint32_t width) {
 999   if (BitWidth < width)
1000     return sext(width);
1001   if (BitWidth > width)
1002     return trunc(width);
1003   return *this;
1004 }
1005
1006 /// Arithmetic right-shift this APInt by shiftAmt.
1007 /// @brief Arithmetic right-shift function.
1008 APInt APInt::ashr(uint32_t shiftAmt) const {
1009   assert(shiftAmt <= BitWidth && "Invalid shift amount");
1010   if (isSingleWord()) {
1011     if (shiftAmt == BitWidth)
1012       return APInt(BitWidth, 0); // undefined
1013     else {
1014       uint32_t SignBit = APINT_BITS_PER_WORD - BitWidth;
1015       return APInt(BitWidth,
1016         (((int64_t(VAL) << SignBit) >> SignBit) >> shiftAmt));
1017     }
1018   }
1019
1020   // If all the bits were shifted out, the result is 0 or -1. This avoids issues
1021   // with shifting by the size of the integer type, which produces undefined
1022   // results.
1023   if (shiftAmt == BitWidth)
1024     if (isNegative())
1025       return APInt(BitWidth, -1ULL);
1026     else
1027       return APInt(BitWidth, 0);
1028
1029   // Create some space for the result.
1030   uint64_t * val = new uint64_t[getNumWords()];
1031
1032   // If we are shifting less than a word, compute the shift with a simple carry
1033   if (shiftAmt < APINT_BITS_PER_WORD) {
1034     uint64_t carry = 0;
1035     for (int i = getNumWords()-1; i >= 0; --i) {
1036       val[i] = (pVal[i] >> shiftAmt) | carry;
1037       carry = pVal[i] << (APINT_BITS_PER_WORD - shiftAmt);
1038     }
1039     return APInt(val, BitWidth).clearUnusedBits();
1040   }
1041
1042   // Compute some values needed by the remaining shift algorithms
1043   uint32_t wordShift = shiftAmt % APINT_BITS_PER_WORD;
1044   uint32_t offset = shiftAmt / APINT_BITS_PER_WORD;
1045
1046   // If we are shifting whole words, just move whole words
1047   if (wordShift == 0) {
1048     for (uint32_t i = 0; i < getNumWords() - offset; ++i)
1049       val[i] = pVal[i+offset];
1050     for (uint32_t i = getNumWords()-offset; i < getNumWords(); i++)
1051       val[i] = (isNegative() ? -1ULL : 0);
1052     return APInt(val,BitWidth).clearUnusedBits();
1053   }
1054
1055   // Shift the low order words
1056   uint32_t breakWord = getNumWords() - offset -1;
1057   for (uint32_t i = 0; i < breakWord; ++i)
1058     val[i] = (pVal[i+offset] >> wordShift) |
1059              (pVal[i+offset+1] << (APINT_BITS_PER_WORD - wordShift));
1060   // Shift the break word.
1061   uint32_t SignBit = APINT_BITS_PER_WORD - (BitWidth % APINT_BITS_PER_WORD);
1062   val[breakWord] = uint64_t(
1063     (((int64_t(pVal[breakWord+offset]) << SignBit) >> SignBit) >> wordShift));
1064
1065   // Remaining words are 0 or -1
1066   for (uint32_t i = breakWord+1; i < getNumWords(); ++i)
1067     val[i] = (isNegative() ? -1ULL : 0);
1068   return APInt(val, BitWidth).clearUnusedBits();
1069 }
1070
1071 /// Logical right-shift this APInt by shiftAmt.
1072 /// @brief Logical right-shift function.
1073 APInt APInt::lshr(uint32_t shiftAmt) const {
1074   if (isSingleWord())
1075     if (shiftAmt == BitWidth)
1076       return APInt(BitWidth, 0);
1077     else
1078       return APInt(BitWidth, this->VAL >> shiftAmt);
1079
1080   // If all the bits were shifted out, the result is 0. This avoids issues
1081   // with shifting by the size of the integer type, which produces undefined
1082   // results. We define these "undefined results" to always be 0.
1083   if (shiftAmt == BitWidth)
1084     return APInt(BitWidth, 0);
1085
1086   // Create some space for the result.
1087   uint64_t * val = new uint64_t[getNumWords()];
1088
1089   // If we are shifting less than a word, compute the shift with a simple carry
1090   if (shiftAmt < APINT_BITS_PER_WORD) {
1091     uint64_t carry = 0;
1092     for (int i = getNumWords()-1; i >= 0; --i) {
1093       val[i] = (pVal[i] >> shiftAmt) | carry;
1094       carry = pVal[i] << (APINT_BITS_PER_WORD - shiftAmt);
1095     }
1096     return APInt(val, BitWidth).clearUnusedBits();
1097   }
1098
1099   // Compute some values needed by the remaining shift algorithms
1100   uint32_t wordShift = shiftAmt % APINT_BITS_PER_WORD;
1101   uint32_t offset = shiftAmt / APINT_BITS_PER_WORD;
1102
1103   // If we are shifting whole words, just move whole words
1104   if (wordShift == 0) {
1105     for (uint32_t i = 0; i < getNumWords() - offset; ++i)
1106       val[i] = pVal[i+offset];
1107     for (uint32_t i = getNumWords()-offset; i < getNumWords(); i++)
1108       val[i] = 0;
1109     return APInt(val,BitWidth).clearUnusedBits();
1110   }
1111
1112   // Shift the low order words
1113   uint32_t breakWord = getNumWords() - offset -1;
1114   for (uint32_t i = 0; i < breakWord; ++i)
1115     val[i] = (pVal[i+offset] >> wordShift) |
1116              (pVal[i+offset+1] << (APINT_BITS_PER_WORD - wordShift));
1117   // Shift the break word.
1118   val[breakWord] = pVal[breakWord+offset] >> wordShift;
1119
1120   // Remaining words are 0
1121   for (uint32_t i = breakWord+1; i < getNumWords(); ++i)
1122     val[i] = 0;
1123   return APInt(val, BitWidth).clearUnusedBits();
1124 }
1125
1126 /// Left-shift this APInt by shiftAmt.
1127 /// @brief Left-shift function.
1128 APInt APInt::shl(uint32_t shiftAmt) const {
1129   assert(shiftAmt <= BitWidth && "Invalid shift amount");
1130   if (isSingleWord()) {
1131     if (shiftAmt == BitWidth)
1132       return APInt(BitWidth, 0); // avoid undefined shift results
1133     return APInt(BitWidth, VAL << shiftAmt);
1134   }
1135
1136   // If all the bits were shifted out, the result is 0. This avoids issues
1137   // with shifting by the size of the integer type, which produces undefined
1138   // results. We define these "undefined results" to always be 0.
1139   if (shiftAmt == BitWidth)
1140     return APInt(BitWidth, 0);
1141
1142   // Create some space for the result.
1143   uint64_t * val = new uint64_t[getNumWords()];
1144
1145   // If we are shifting less than a word, do it the easy way
1146   if (shiftAmt < APINT_BITS_PER_WORD) {
1147     uint64_t carry = 0;
1148     for (uint32_t i = 0; i < getNumWords(); i++) {
1149       val[i] = pVal[i] << shiftAmt | carry;
1150       carry = pVal[i] >> (APINT_BITS_PER_WORD - shiftAmt);
1151     }
1152     return APInt(val, BitWidth).clearUnusedBits();
1153   }
1154
1155   // Compute some values needed by the remaining shift algorithms
1156   uint32_t wordShift = shiftAmt % APINT_BITS_PER_WORD;
1157   uint32_t offset = shiftAmt / APINT_BITS_PER_WORD;
1158
1159   // If we are shifting whole words, just move whole words
1160   if (wordShift == 0) {
1161     for (uint32_t i = 0; i < offset; i++)
1162       val[i] = 0;
1163     for (uint32_t i = offset; i < getNumWords(); i++)
1164       val[i] = pVal[i-offset];
1165     return APInt(val,BitWidth).clearUnusedBits();
1166   }
1167
1168   // Copy whole words from this to Result.
1169   uint32_t i = getNumWords() - 1;
1170   for (; i > offset; --i)
1171     val[i] = pVal[i-offset] << wordShift |
1172              pVal[i-offset-1] >> (APINT_BITS_PER_WORD - wordShift);
1173   val[offset] = pVal[0] << wordShift;
1174   for (i = 0; i < offset; ++i)
1175     val[i] = 0;
1176   return APInt(val, BitWidth).clearUnusedBits();
1177 }
1178
1179
1180 // Square Root - this method computes and returns the square root of "this".
1181 // Three mechanisms are used for computation. For small values (<= 5 bits),
1182 // a table lookup is done. This gets some performance for common cases. For
1183 // values using less than 52 bits, the value is converted to double and then
1184 // the libc sqrt function is called. The result is rounded and then converted
1185 // back to a uint64_t which is then used to construct the result. Finally,
1186 // the Babylonian method for computing square roots is used.
1187 APInt APInt::sqrt() const {
1188
1189   // Determine the magnitude of the value.
1190   uint32_t magnitude = getActiveBits();
1191
1192   // Use a fast table for some small values. This also gets rid of some
1193   // rounding errors in libc sqrt for small values.
1194   if (magnitude <= 5) {
1195     static const uint8_t results[32] = {
1196       /*     0 */ 0,
1197       /*  1- 2 */ 1, 1,
1198       /*  3- 6 */ 2, 2, 2, 2,
1199       /*  7-12 */ 3, 3, 3, 3, 3, 3,
1200       /* 13-20 */ 4, 4, 4, 4, 4, 4, 4, 4,
1201       /* 21-30 */ 5, 5, 5, 5, 5, 5, 5, 5, 5, 5,
1202       /*    31 */ 6
1203     };
1204     return APInt(BitWidth, results[ (isSingleWord() ? VAL : pVal[0]) ]);
1205   }
1206
1207   // If the magnitude of the value fits in less than 52 bits (the precision of
1208   // an IEEE double precision floating point value), then we can use the
1209   // libc sqrt function which will probably use a hardware sqrt computation.
1210   // This should be faster than the algorithm below.
1211   if (magnitude < 52)
1212     return APInt(BitWidth,
1213                  uint64_t(::round(::sqrt(double(isSingleWord()?VAL:pVal[0])))));
1214
1215   // Okay, all the short cuts are exhausted. We must compute it. The following
1216   // is a classical Babylonian method for computing the square root. This code
1217   // was adapted to APINt from a wikipedia article on such computations.
1218   // See http://www.wikipedia.org/ and go to the page named
1219   // Calculate_an_integer_square_root.
1220   uint32_t nbits = BitWidth, i = 4;
1221   APInt testy(BitWidth, 16);
1222   APInt x_old(BitWidth, 1);
1223   APInt x_new(BitWidth, 0);
1224   APInt two(BitWidth, 2);
1225
1226   // Select a good starting value using binary logarithms.
1227   for (;; i += 2, testy = testy.shl(2))
1228     if (i >= nbits || this->ule(testy)) {
1229       x_old = x_old.shl(i / 2);
1230       break;
1231     }
1232
1233   // Use the Babylonian method to arrive at the integer square root:
1234   for (;;) {
1235     x_new = (this->udiv(x_old) + x_old).udiv(two);
1236     if (x_old.ule(x_new))
1237       break;
1238     x_old = x_new;
1239   }
1240
1241   // Make sure we return the closest approximation
1242   // NOTE: The rounding calculation below is correct. It will produce an
1243   // off-by-one discrepancy with results from pari/gp. That discrepancy has been
1244   // determined to be a rounding issue with pari/gp as it begins to use a
1245   // floating point representation after 192 bits. There are no discrepancies
1246   // between this algorithm and pari/gp for bit widths < 192 bits.
1247   APInt square(x_old * x_old);
1248   APInt nextSquare((x_old + 1) * (x_old +1));
1249   if (this->ult(square))
1250     return x_old;
1251   else if (this->ule(nextSquare)) {
1252     APInt midpoint((nextSquare - square).udiv(two));
1253     APInt offset(*this - square);
1254     if (offset.ult(midpoint))
1255       return x_old;
1256     else
1257       return x_old + 1;
1258   } else
1259     assert(0 && "Error in APInt::sqrt computation");
1260   return x_old + 1;
1261 }
1262
1263 /// Implementation of Knuth's Algorithm D (Division of nonnegative integers)
1264 /// from "Art of Computer Programming, Volume 2", section 4.3.1, p. 272. The
1265 /// variables here have the same names as in the algorithm. Comments explain
1266 /// the algorithm and any deviation from it.
1267 static void KnuthDiv(uint32_t *u, uint32_t *v, uint32_t *q, uint32_t* r,
1268                      uint32_t m, uint32_t n) {
1269   assert(u && "Must provide dividend");
1270   assert(v && "Must provide divisor");
1271   assert(q && "Must provide quotient");
1272   assert(u != v && u != q && v != q && "Must us different memory");
1273   assert(n>1 && "n must be > 1");
1274
1275   // Knuth uses the value b as the base of the number system. In our case b
1276   // is 2^31 so we just set it to -1u.
1277   uint64_t b = uint64_t(1) << 32;
1278
1279   DEBUG(cerr << "KnuthDiv: m=" << m << " n=" << n << '\n');
1280   DEBUG(cerr << "KnuthDiv: original:");
1281   DEBUG(for (int i = m+n; i >=0; i--) cerr << " " << std::setbase(16) << u[i]);
1282   DEBUG(cerr << " by");
1283   DEBUG(for (int i = n; i >0; i--) cerr << " " << std::setbase(16) << v[i-1]);
1284   DEBUG(cerr << '\n');
1285   // D1. [Normalize.] Set d = b / (v[n-1] + 1) and multiply all the digits of
1286   // u and v by d. Note that we have taken Knuth's advice here to use a power
1287   // of 2 value for d such that d * v[n-1] >= b/2 (b is the base). A power of
1288   // 2 allows us to shift instead of multiply and it is easy to determine the
1289   // shift amount from the leading zeros.  We are basically normalizing the u
1290   // and v so that its high bits are shifted to the top of v's range without
1291   // overflow. Note that this can require an extra word in u so that u must
1292   // be of length m+n+1.
1293   uint32_t shift = CountLeadingZeros_32(v[n-1]);
1294   uint32_t v_carry = 0;
1295   uint32_t u_carry = 0;
1296   if (shift) {
1297     for (uint32_t i = 0; i < m+n; ++i) {
1298       uint32_t u_tmp = u[i] >> (32 - shift);
1299       u[i] = (u[i] << shift) | u_carry;
1300       u_carry = u_tmp;
1301     }
1302     for (uint32_t i = 0; i < n; ++i) {
1303       uint32_t v_tmp = v[i] >> (32 - shift);
1304       v[i] = (v[i] << shift) | v_carry;
1305       v_carry = v_tmp;
1306     }
1307   }
1308   u[m+n] = u_carry;
1309   DEBUG(cerr << "KnuthDiv:   normal:");
1310   DEBUG(for (int i = m+n; i >=0; i--) cerr << " " << std::setbase(16) << u[i]);
1311   DEBUG(cerr << " by");
1312   DEBUG(for (int i = n; i >0; i--) cerr << " " << std::setbase(16) << v[i-1]);
1313   DEBUG(cerr << '\n');
1314
1315   // D2. [Initialize j.]  Set j to m. This is the loop counter over the places.
1316   int j = m;
1317   do {
1318     DEBUG(cerr << "KnuthDiv: quotient digit #" << j << '\n');
1319     // D3. [Calculate q'.].
1320     //     Set qp = (u[j+n]*b + u[j+n-1]) / v[n-1]. (qp=qprime=q')
1321     //     Set rp = (u[j+n]*b + u[j+n-1]) % v[n-1]. (rp=rprime=r')
1322     // Now test if qp == b or qp*v[n-2] > b*rp + u[j+n-2]; if so, decrease
1323     // qp by 1, inrease rp by v[n-1], and repeat this test if rp < b. The test
1324     // on v[n-2] determines at high speed most of the cases in which the trial
1325     // value qp is one too large, and it eliminates all cases where qp is two
1326     // too large.
1327     uint64_t dividend = ((uint64_t(u[j+n]) << 32) + u[j+n-1]);
1328     DEBUG(cerr << "KnuthDiv: dividend == " << dividend << '\n');
1329     uint64_t qp = dividend / v[n-1];
1330     uint64_t rp = dividend % v[n-1];
1331     if (qp == b || qp*v[n-2] > b*rp + u[j+n-2]) {
1332       qp--;
1333       rp += v[n-1];
1334       if (rp < b && (qp == b || qp*v[n-2] > b*rp + u[j+n-2]))
1335         qp--;
1336     }
1337     DEBUG(cerr << "KnuthDiv: qp == " << qp << ", rp == " << rp << '\n');
1338
1339     // D4. [Multiply and subtract.] Replace (u[j+n]u[j+n-1]...u[j]) with
1340     // (u[j+n]u[j+n-1]..u[j]) - qp * (v[n-1]...v[1]v[0]). This computation
1341     // consists of a simple multiplication by a one-place number, combined with
1342     // a subtraction.
1343     bool isNeg = false;
1344     for (uint32_t i = 0; i < n; ++i) {
1345       uint64_t u_tmp = uint64_t(u[j+i]) | (uint64_t(u[j+i+1]) << 32);
1346       uint64_t subtrahend = uint64_t(qp) * uint64_t(v[i]);
1347       bool borrow = subtrahend > u_tmp;
1348       DEBUG(cerr << "KnuthDiv: u_tmp == " << u_tmp
1349                  << ", subtrahend == " << subtrahend
1350                  << ", borrow = " << borrow << '\n');
1351
1352       uint64_t result = u_tmp - subtrahend;
1353       uint32_t k = j + i;
1354       u[k++] = result & (b-1); // subtract low word
1355       u[k++] = result >> 32;   // subtract high word
1356       while (borrow && k <= m+n) { // deal with borrow to the left
1357         borrow = u[k] == 0;
1358         u[k]--;
1359         k++;
1360       }
1361       isNeg |= borrow;
1362       DEBUG(cerr << "KnuthDiv: u[j+i] == " << u[j+i] << ",  u[j+i+1] == " <<
1363                     u[j+i+1] << '\n');
1364     }
1365     DEBUG(cerr << "KnuthDiv: after subtraction:");
1366     DEBUG(for (int i = m+n; i >=0; i--) cerr << " " << u[i]);
1367     DEBUG(cerr << '\n');
1368     // The digits (u[j+n]...u[j]) should be kept positive; if the result of
1369     // this step is actually negative, (u[j+n]...u[j]) should be left as the
1370     // true value plus b**(n+1), namely as the b's complement of
1371     // the true value, and a "borrow" to the left should be remembered.
1372     //
1373     if (isNeg) {
1374       bool carry = true;  // true because b's complement is "complement + 1"
1375       for (uint32_t i = 0; i <= m+n; ++i) {
1376         u[i] = ~u[i] + carry; // b's complement
1377         carry = carry && u[i] == 0;
1378       }
1379     }
1380     DEBUG(cerr << "KnuthDiv: after complement:");
1381     DEBUG(for (int i = m+n; i >=0; i--) cerr << " " << u[i]);
1382     DEBUG(cerr << '\n');
1383
1384     // D5. [Test remainder.] Set q[j] = qp. If the result of step D4 was
1385     // negative, go to step D6; otherwise go on to step D7.
1386     q[j] = qp;
1387     if (isNeg) {
1388       // D6. [Add back]. The probability that this step is necessary is very
1389       // small, on the order of only 2/b. Make sure that test data accounts for
1390       // this possibility. Decrease q[j] by 1
1391       q[j]--;
1392       // and add (0v[n-1]...v[1]v[0]) to (u[j+n]u[j+n-1]...u[j+1]u[j]).
1393       // A carry will occur to the left of u[j+n], and it should be ignored
1394       // since it cancels with the borrow that occurred in D4.
1395       bool carry = false;
1396       for (uint32_t i = 0; i < n; i++) {
1397         uint32_t limit = std::min(u[j+i],v[i]);
1398         u[j+i] += v[i] + carry;
1399         carry = u[j+i] < limit || (carry && u[j+i] == limit);
1400       }
1401       u[j+n] += carry;
1402     }
1403     DEBUG(cerr << "KnuthDiv: after correction:");
1404     DEBUG(for (int i = m+n; i >=0; i--) cerr <<" " << u[i]);
1405     DEBUG(cerr << "\nKnuthDiv: digit result = " << q[j] << '\n');
1406
1407   // D7. [Loop on j.]  Decrease j by one. Now if j >= 0, go back to D3.
1408   } while (--j >= 0);
1409
1410   DEBUG(cerr << "KnuthDiv: quotient:");
1411   DEBUG(for (int i = m; i >=0; i--) cerr <<" " << q[i]);
1412   DEBUG(cerr << '\n');
1413
1414   // D8. [Unnormalize]. Now q[...] is the desired quotient, and the desired
1415   // remainder may be obtained by dividing u[...] by d. If r is non-null we
1416   // compute the remainder (urem uses this).
1417   if (r) {
1418     // The value d is expressed by the "shift" value above since we avoided
1419     // multiplication by d by using a shift left. So, all we have to do is
1420     // shift right here. In order to mak
1421     if (shift) {
1422       uint32_t carry = 0;
1423       DEBUG(cerr << "KnuthDiv: remainder:");
1424       for (int i = n-1; i >= 0; i--) {
1425         r[i] = (u[i] >> shift) | carry;
1426         carry = u[i] << (32 - shift);
1427         DEBUG(cerr << " " << r[i]);
1428       }
1429     } else {
1430       for (int i = n-1; i >= 0; i--) {
1431         r[i] = u[i];
1432         DEBUG(cerr << " " << r[i]);
1433       }
1434     }
1435     DEBUG(cerr << '\n');
1436   }
1437   DEBUG(cerr << std::setbase(10) << '\n');
1438 }
1439
1440 void APInt::divide(const APInt LHS, uint32_t lhsWords,
1441                    const APInt &RHS, uint32_t rhsWords,
1442                    APInt *Quotient, APInt *Remainder)
1443 {
1444   assert(lhsWords >= rhsWords && "Fractional result");
1445
1446   // First, compose the values into an array of 32-bit words instead of
1447   // 64-bit words. This is a necessity of both the "short division" algorithm
1448   // and the the Knuth "classical algorithm" which requires there to be native
1449   // operations for +, -, and * on an m bit value with an m*2 bit result. We
1450   // can't use 64-bit operands here because we don't have native results of
1451   // 128-bits. Furthremore, casting the 64-bit values to 32-bit values won't
1452   // work on large-endian machines.
1453   uint64_t mask = ~0ull >> (sizeof(uint32_t)*8);
1454   uint32_t n = rhsWords * 2;
1455   uint32_t m = (lhsWords * 2) - n;
1456
1457   // Allocate space for the temporary values we need either on the stack, if
1458   // it will fit, or on the heap if it won't.
1459   uint32_t SPACE[128];
1460   uint32_t *U = 0;
1461   uint32_t *V = 0;
1462   uint32_t *Q = 0;
1463   uint32_t *R = 0;
1464   if ((Remainder?4:3)*n+2*m+1 <= 128) {
1465     U = &SPACE[0];
1466     V = &SPACE[m+n+1];
1467     Q = &SPACE[(m+n+1) + n];
1468     if (Remainder)
1469       R = &SPACE[(m+n+1) + n + (m+n)];
1470   } else {
1471     U = new uint32_t[m + n + 1];
1472     V = new uint32_t[n];
1473     Q = new uint32_t[m+n];
1474     if (Remainder)
1475       R = new uint32_t[n];
1476   }
1477
1478   // Initialize the dividend
1479   memset(U, 0, (m+n+1)*sizeof(uint32_t));
1480   for (unsigned i = 0; i < lhsWords; ++i) {
1481     uint64_t tmp = (LHS.getNumWords() == 1 ? LHS.VAL : LHS.pVal[i]);
1482     U[i * 2] = tmp & mask;
1483     U[i * 2 + 1] = tmp >> (sizeof(uint32_t)*8);
1484   }
1485   U[m+n] = 0; // this extra word is for "spill" in the Knuth algorithm.
1486
1487   // Initialize the divisor
1488   memset(V, 0, (n)*sizeof(uint32_t));
1489   for (unsigned i = 0; i < rhsWords; ++i) {
1490     uint64_t tmp = (RHS.getNumWords() == 1 ? RHS.VAL : RHS.pVal[i]);
1491     V[i * 2] = tmp & mask;
1492     V[i * 2 + 1] = tmp >> (sizeof(uint32_t)*8);
1493   }
1494
1495   // initialize the quotient and remainder
1496   memset(Q, 0, (m+n) * sizeof(uint32_t));
1497   if (Remainder)
1498     memset(R, 0, n * sizeof(uint32_t));
1499
1500   // Now, adjust m and n for the Knuth division. n is the number of words in
1501   // the divisor. m is the number of words by which the dividend exceeds the
1502   // divisor (i.e. m+n is the length of the dividend). These sizes must not
1503   // contain any zero words or the Knuth algorithm fails.
1504   for (unsigned i = n; i > 0 && V[i-1] == 0; i--) {
1505     n--;
1506     m++;
1507   }
1508   for (unsigned i = m+n; i > 0 && U[i-1] == 0; i--)
1509     m--;
1510
1511   // If we're left with only a single word for the divisor, Knuth doesn't work
1512   // so we implement the short division algorithm here. This is much simpler
1513   // and faster because we are certain that we can divide a 64-bit quantity
1514   // by a 32-bit quantity at hardware speed and short division is simply a
1515   // series of such operations. This is just like doing short division but we
1516   // are using base 2^32 instead of base 10.
1517   assert(n != 0 && "Divide by zero?");
1518   if (n == 1) {
1519     uint32_t divisor = V[0];
1520     uint32_t remainder = 0;
1521     for (int i = m+n-1; i >= 0; i--) {
1522       uint64_t partial_dividend = uint64_t(remainder) << 32 | U[i];
1523       if (partial_dividend == 0) {
1524         Q[i] = 0;
1525         remainder = 0;
1526       } else if (partial_dividend < divisor) {
1527         Q[i] = 0;
1528         remainder = partial_dividend;
1529       } else if (partial_dividend == divisor) {
1530         Q[i] = 1;
1531         remainder = 0;
1532       } else {
1533         Q[i] = partial_dividend / divisor;
1534         remainder = partial_dividend - (Q[i] * divisor);
1535       }
1536     }
1537     if (R)
1538       R[0] = remainder;
1539   } else {
1540     // Now we're ready to invoke the Knuth classical divide algorithm. In this
1541     // case n > 1.
1542     KnuthDiv(U, V, Q, R, m, n);
1543   }
1544
1545   // If the caller wants the quotient
1546   if (Quotient) {
1547     // Set up the Quotient value's memory.
1548     if (Quotient->BitWidth != LHS.BitWidth) {
1549       if (Quotient->isSingleWord())
1550         Quotient->VAL = 0;
1551       else
1552         delete [] Quotient->pVal;
1553       Quotient->BitWidth = LHS.BitWidth;
1554       if (!Quotient->isSingleWord())
1555         Quotient->pVal = getClearedMemory(Quotient->getNumWords());
1556     } else
1557       Quotient->clear();
1558
1559     // The quotient is in Q. Reconstitute the quotient into Quotient's low
1560     // order words.
1561     if (lhsWords == 1) {
1562       uint64_t tmp =
1563         uint64_t(Q[0]) | (uint64_t(Q[1]) << (APINT_BITS_PER_WORD / 2));
1564       if (Quotient->isSingleWord())
1565         Quotient->VAL = tmp;
1566       else
1567         Quotient->pVal[0] = tmp;
1568     } else {
1569       assert(!Quotient->isSingleWord() && "Quotient APInt not large enough");
1570       for (unsigned i = 0; i < lhsWords; ++i)
1571         Quotient->pVal[i] =
1572           uint64_t(Q[i*2]) | (uint64_t(Q[i*2+1]) << (APINT_BITS_PER_WORD / 2));
1573     }
1574   }
1575
1576   // If the caller wants the remainder
1577   if (Remainder) {
1578     // Set up the Remainder value's memory.
1579     if (Remainder->BitWidth != RHS.BitWidth) {
1580       if (Remainder->isSingleWord())
1581         Remainder->VAL = 0;
1582       else
1583         delete [] Remainder->pVal;
1584       Remainder->BitWidth = RHS.BitWidth;
1585       if (!Remainder->isSingleWord())
1586         Remainder->pVal = getClearedMemory(Remainder->getNumWords());
1587     } else
1588       Remainder->clear();
1589
1590     // The remainder is in R. Reconstitute the remainder into Remainder's low
1591     // order words.
1592     if (rhsWords == 1) {
1593       uint64_t tmp =
1594         uint64_t(R[0]) | (uint64_t(R[1]) << (APINT_BITS_PER_WORD / 2));
1595       if (Remainder->isSingleWord())
1596         Remainder->VAL = tmp;
1597       else
1598         Remainder->pVal[0] = tmp;
1599     } else {
1600       assert(!Remainder->isSingleWord() && "Remainder APInt not large enough");
1601       for (unsigned i = 0; i < rhsWords; ++i)
1602         Remainder->pVal[i] =
1603           uint64_t(R[i*2]) | (uint64_t(R[i*2+1]) << (APINT_BITS_PER_WORD / 2));
1604     }
1605   }
1606
1607   // Clean up the memory we allocated.
1608   if (U != &SPACE[0]) {
1609     delete [] U;
1610     delete [] V;
1611     delete [] Q;
1612     delete [] R;
1613   }
1614 }
1615
1616 APInt APInt::udiv(const APInt& RHS) const {
1617   assert(BitWidth == RHS.BitWidth && "Bit widths must be the same");
1618
1619   // First, deal with the easy case
1620   if (isSingleWord()) {
1621     assert(RHS.VAL != 0 && "Divide by zero?");
1622     return APInt(BitWidth, VAL / RHS.VAL);
1623   }
1624
1625   // Get some facts about the LHS and RHS number of bits and words
1626   uint32_t rhsBits = RHS.getActiveBits();
1627   uint32_t rhsWords = !rhsBits ? 0 : (APInt::whichWord(rhsBits - 1) + 1);
1628   assert(rhsWords && "Divided by zero???");
1629   uint32_t lhsBits = this->getActiveBits();
1630   uint32_t lhsWords = !lhsBits ? 0 : (APInt::whichWord(lhsBits - 1) + 1);
1631
1632   // Deal with some degenerate cases
1633   if (!lhsWords)
1634     // 0 / X ===> 0
1635     return APInt(BitWidth, 0);
1636   else if (lhsWords < rhsWords || this->ult(RHS)) {
1637     // X / Y ===> 0, iff X < Y
1638     return APInt(BitWidth, 0);
1639   } else if (*this == RHS) {
1640     // X / X ===> 1
1641     return APInt(BitWidth, 1);
1642   } else if (lhsWords == 1 && rhsWords == 1) {
1643     // All high words are zero, just use native divide
1644     return APInt(BitWidth, this->pVal[0] / RHS.pVal[0]);
1645   }
1646
1647   // We have to compute it the hard way. Invoke the Knuth divide algorithm.
1648   APInt Quotient(1,0); // to hold result.
1649   divide(*this, lhsWords, RHS, rhsWords, &Quotient, 0);
1650   return Quotient;
1651 }
1652
1653 APInt APInt::urem(const APInt& RHS) const {
1654   assert(BitWidth == RHS.BitWidth && "Bit widths must be the same");
1655   if (isSingleWord()) {
1656     assert(RHS.VAL != 0 && "Remainder by zero?");
1657     return APInt(BitWidth, VAL % RHS.VAL);
1658   }
1659
1660   // Get some facts about the LHS
1661   uint32_t lhsBits = getActiveBits();
1662   uint32_t lhsWords = !lhsBits ? 0 : (whichWord(lhsBits - 1) + 1);
1663
1664   // Get some facts about the RHS
1665   uint32_t rhsBits = RHS.getActiveBits();
1666   uint32_t rhsWords = !rhsBits ? 0 : (APInt::whichWord(rhsBits - 1) + 1);
1667   assert(rhsWords && "Performing remainder operation by zero ???");
1668
1669   // Check the degenerate cases
1670   if (lhsWords == 0) {
1671     // 0 % Y ===> 0
1672     return APInt(BitWidth, 0);
1673   } else if (lhsWords < rhsWords || this->ult(RHS)) {
1674     // X % Y ===> X, iff X < Y
1675     return *this;
1676   } else if (*this == RHS) {
1677     // X % X == 0;
1678     return APInt(BitWidth, 0);
1679   } else if (lhsWords == 1) {
1680     // All high words are zero, just use native remainder
1681     return APInt(BitWidth, pVal[0] % RHS.pVal[0]);
1682   }
1683
1684   // We have to compute it the hard way. Invoke the Knute divide algorithm.
1685   APInt Remainder(1,0);
1686   divide(*this, lhsWords, RHS, rhsWords, 0, &Remainder);
1687   return Remainder;
1688 }
1689
1690 void APInt::fromString(uint32_t numbits, const char *str, uint32_t slen,
1691                        uint8_t radix) {
1692   // Check our assumptions here
1693   assert((radix == 10 || radix == 8 || radix == 16 || radix == 2) &&
1694          "Radix should be 2, 8, 10, or 16!");
1695   assert(str && "String is null?");
1696   bool isNeg = str[0] == '-';
1697   if (isNeg)
1698     str++, slen--;
1699   assert(slen <= numbits || radix != 2 && "Insufficient bit width");
1700   assert(slen*3 <= numbits || radix != 8 && "Insufficient bit width");
1701   assert(slen*4 <= numbits || radix != 16 && "Insufficient bit width");
1702   assert((slen*64)/20 <= numbits || radix != 10 && "Insufficient bit width");
1703
1704   // Allocate memory
1705   if (!isSingleWord())
1706     pVal = getClearedMemory(getNumWords());
1707
1708   // Figure out if we can shift instead of multiply
1709   uint32_t shift = (radix == 16 ? 4 : radix == 8 ? 3 : radix == 2 ? 1 : 0);
1710
1711   // Set up an APInt for the digit to add outside the loop so we don't
1712   // constantly construct/destruct it.
1713   APInt apdigit(getBitWidth(), 0);
1714   APInt apradix(getBitWidth(), radix);
1715
1716   // Enter digit traversal loop
1717   for (unsigned i = 0; i < slen; i++) {
1718     // Get a digit
1719     uint32_t digit = 0;
1720     char cdigit = str[i];
1721     if (isdigit(cdigit))
1722       digit = cdigit - '0';
1723     else if (isxdigit(cdigit))
1724       if (cdigit >= 'a')
1725         digit = cdigit - 'a' + 10;
1726       else if (cdigit >= 'A')
1727         digit = cdigit - 'A' + 10;
1728       else
1729         assert(0 && "huh?");
1730     else
1731       assert(0 && "Invalid character in digit string");
1732
1733     // Shift or multiple the value by the radix
1734     if (shift)
1735       this->shl(shift);
1736     else
1737       *this *= apradix;
1738
1739     // Add in the digit we just interpreted
1740     if (apdigit.isSingleWord())
1741       apdigit.VAL = digit;
1742     else
1743       apdigit.pVal[0] = digit;
1744     *this += apdigit;
1745   }
1746   // If its negative, put it in two's complement form
1747   if (isNeg) {
1748     (*this)--;
1749     this->flip();
1750   }
1751 }
1752
1753 std::string APInt::toString(uint8_t radix, bool wantSigned) const {
1754   assert((radix == 10 || radix == 8 || radix == 16 || radix == 2) &&
1755          "Radix should be 2, 8, 10, or 16!");
1756   static const char *digits[] = {
1757     "0","1","2","3","4","5","6","7","8","9","A","B","C","D","E","F"
1758   };
1759   std::string result;
1760   uint32_t bits_used = getActiveBits();
1761   if (isSingleWord()) {
1762     char buf[65];
1763     const char *format = (radix == 10 ? (wantSigned ? "%lld" : "%llu") :
1764        (radix == 16 ? "%llX" : (radix == 8 ? "%llo" : 0)));
1765     if (format) {
1766       if (wantSigned) {
1767         int64_t sextVal = (int64_t(VAL) << (APINT_BITS_PER_WORD-BitWidth)) >>
1768                            (APINT_BITS_PER_WORD-BitWidth);
1769         sprintf(buf, format, sextVal);
1770       } else
1771         sprintf(buf, format, VAL);
1772     } else {
1773       memset(buf, 0, 65);
1774       uint64_t v = VAL;
1775       while (bits_used) {
1776         uint32_t bit = v & 1;
1777         bits_used--;
1778         buf[bits_used] = digits[bit][0];
1779         v >>=1;
1780       }
1781     }
1782     result = buf;
1783     return result;
1784   }
1785
1786   if (radix != 10) {
1787     uint64_t mask = radix - 1;
1788     uint32_t shift = (radix == 16 ? 4 : radix  == 8 ? 3 : 1);
1789     uint32_t nibbles = APINT_BITS_PER_WORD / shift;
1790     for (uint32_t i = 0; i < getNumWords(); ++i) {
1791       uint64_t value = pVal[i];
1792       for (uint32_t j = 0; j < nibbles; ++j) {
1793         result.insert(0, digits[ value & mask ]);
1794         value >>= shift;
1795       }
1796     }
1797     return result;
1798   }
1799
1800   APInt tmp(*this);
1801   APInt divisor(4, radix);
1802   APInt zero(tmp.getBitWidth(), 0);
1803   size_t insert_at = 0;
1804   if (wantSigned && tmp[BitWidth-1]) {
1805     // They want to print the signed version and it is a negative value
1806     // Flip the bits and add one to turn it into the equivalent positive
1807     // value and put a '-' in the result.
1808     tmp.flip();
1809     tmp++;
1810     result = "-";
1811     insert_at = 1;
1812   }
1813   if (tmp == APInt(tmp.getBitWidth(), 0))
1814     result = "0";
1815   else while (tmp.ne(zero)) {
1816     APInt APdigit(1,0);
1817     APInt tmp2(tmp.getBitWidth(), 0);
1818     divide(tmp, tmp.getNumWords(), divisor, divisor.getNumWords(), &tmp2,
1819            &APdigit);
1820     uint32_t digit = APdigit.getZExtValue();
1821     assert(digit < radix && "divide failed");
1822     result.insert(insert_at,digits[digit]);
1823     tmp = tmp2;
1824   }
1825
1826   return result;
1827 }
1828
1829 #ifndef NDEBUG
1830 void APInt::dump() const
1831 {
1832   cerr << "APInt(" << BitWidth << ")=" << std::setbase(16);
1833   if (isSingleWord())
1834     cerr << VAL;
1835   else for (unsigned i = getNumWords(); i > 0; i--) {
1836     cerr << pVal[i-1] << " ";
1837   }
1838   cerr << " U(" << this->toString(10) << ") S(" << this->toStringSigned(10)
1839        << ")\n" << std::setbase(10);
1840 }
1841 #endif