Make the trunc/sext/zext methods return APInt& so that these operations
[oota-llvm.git] / 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 >> (APINT_BITS_PER_WORD - newWordBits)) <<  wordBits;
942     if (wordsBefore == 1)
943       VAL |= mask;
944     else
945       pVal[wordsBefore-1] |= mask;
946     clearUnusedBits();
947     return *this;
948   }
949
950   uint64_t mask = wordBits == 0 ? 0 : ~0ULL << wordBits;
951   uint64_t *newVal = getMemory(wordsAfter);
952   if (wordsBefore == 1)
953     newVal[0] = VAL | mask;
954   else {
955     for (uint32_t i = 0; i < wordsBefore; ++i)
956       newVal[i] = pVal[i];
957     newVal[wordsBefore-1] |= mask;
958   }
959   for (uint32_t i = wordsBefore; i < wordsAfter; i++)
960     newVal[i] = -1ULL;
961   if (wordsBefore != 1)
962     delete [] pVal;
963   pVal = newVal;
964   return clearUnusedBits();
965 }
966
967 //  Zero extend to a new width.
968 APInt &APInt::zext(uint32_t width) {
969   assert(width > BitWidth && "Invalid APInt ZeroExtend request");
970   assert(width <= IntegerType::MAX_INT_BITS && "Too many bits");
971   uint32_t wordsBefore = getNumWords();
972   BitWidth = width;
973   uint32_t wordsAfter = getNumWords();
974   if (wordsBefore != wordsAfter) {
975     uint64_t *newVal = getClearedMemory(wordsAfter);
976     if (wordsBefore == 1)
977       newVal[0] = VAL;
978     else 
979       for (uint32_t i = 0; i < wordsBefore; ++i)
980         newVal[i] = pVal[i];
981     if (wordsBefore != 1)
982       delete [] pVal;
983     pVal = newVal;
984   }
985   return *this;
986 }
987
988 /// Arithmetic right-shift this APInt by shiftAmt.
989 /// @brief Arithmetic right-shift function.
990 APInt APInt::ashr(uint32_t shiftAmt) const {
991   assert(shiftAmt <= BitWidth && "Invalid shift amount");
992   if (isSingleWord()) {
993     if (shiftAmt == BitWidth)
994       return APInt(BitWidth, 0); // undefined
995     else {
996       uint32_t SignBit = APINT_BITS_PER_WORD - BitWidth;
997       return APInt(BitWidth, 
998         (((int64_t(VAL) << SignBit) >> SignBit) >> shiftAmt));
999     }
1000   }
1001
1002   // If all the bits were shifted out, the result is 0 or -1. This avoids issues
1003   // with shifting by the size of the integer type, which produces undefined
1004   // results. 
1005   if (shiftAmt == BitWidth)
1006     if (isNegative())
1007       return APInt(BitWidth, -1ULL);
1008     else
1009       return APInt(BitWidth, 0);
1010
1011   // Create some space for the result.
1012   uint64_t * val = new uint64_t[getNumWords()];
1013
1014   // If we are shifting less than a word, compute the shift with a simple carry
1015   if (shiftAmt < APINT_BITS_PER_WORD) {
1016     uint64_t carry = 0;
1017     for (int i = getNumWords()-1; i >= 0; --i) {
1018       val[i] = pVal[i] >> shiftAmt | carry;
1019       carry = pVal[i] << (APINT_BITS_PER_WORD - shiftAmt);
1020     }
1021     return APInt(val, BitWidth).clearUnusedBits();
1022   }
1023
1024   // Compute some values needed by the remaining shift algorithms
1025   uint32_t wordShift = shiftAmt % APINT_BITS_PER_WORD;
1026   uint32_t offset = shiftAmt / APINT_BITS_PER_WORD;
1027
1028   // If we are shifting whole words, just move whole words
1029   if (wordShift == 0) {
1030     for (uint32_t i = 0; i < getNumWords() - offset; ++i) 
1031       val[i] = pVal[i+offset];
1032     for (uint32_t i = getNumWords()-offset; i < getNumWords(); i++)
1033       val[i] = (isNegative() ? -1ULL : 0);
1034     return APInt(val,BitWidth).clearUnusedBits();
1035   }
1036
1037   // Shift the low order words 
1038   uint32_t breakWord = getNumWords() - offset -1;
1039   for (uint32_t i = 0; i < breakWord; ++i)
1040     val[i] = pVal[i+offset] >> wordShift |
1041              pVal[i+offset+1] << (APINT_BITS_PER_WORD - wordShift);
1042   // Shift the break word.
1043   uint32_t SignBit = APINT_BITS_PER_WORD - (BitWidth % APINT_BITS_PER_WORD);
1044   val[breakWord] = uint64_t(
1045     (((int64_t(pVal[breakWord+offset]) << SignBit) >> SignBit) >> wordShift));
1046
1047   // Remaining words are 0 or -1
1048   for (uint32_t i = breakWord+1; i < getNumWords(); ++i)
1049     val[i] = (isNegative() ? -1ULL : 0);
1050   return APInt(val, BitWidth).clearUnusedBits();
1051 }
1052
1053 /// Logical right-shift this APInt by shiftAmt.
1054 /// @brief Logical right-shift function.
1055 APInt APInt::lshr(uint32_t shiftAmt) const {
1056   if (isSingleWord())
1057     if (shiftAmt == BitWidth)
1058       return APInt(BitWidth, 0);
1059     else 
1060       return APInt(BitWidth, this->VAL >> shiftAmt);
1061
1062   // If all the bits were shifted out, the result is 0. This avoids issues
1063   // with shifting by the size of the integer type, which produces undefined
1064   // results. We define these "undefined results" to always be 0.
1065   if (shiftAmt == BitWidth)
1066     return APInt(BitWidth, 0);
1067
1068   // Create some space for the result.
1069   uint64_t * val = new uint64_t[getNumWords()];
1070
1071   // If we are shifting less than a word, compute the shift with a simple carry
1072   if (shiftAmt < APINT_BITS_PER_WORD) {
1073     uint64_t carry = 0;
1074     for (int i = getNumWords()-1; i >= 0; --i) {
1075       val[i] = pVal[i] >> shiftAmt | carry;
1076       carry = pVal[i] << (APINT_BITS_PER_WORD - shiftAmt);
1077     }
1078     return APInt(val, BitWidth).clearUnusedBits();
1079   }
1080
1081   // Compute some values needed by the remaining shift algorithms
1082   uint32_t wordShift = shiftAmt % APINT_BITS_PER_WORD;
1083   uint32_t offset = shiftAmt / APINT_BITS_PER_WORD;
1084
1085   // If we are shifting whole words, just move whole words
1086   if (wordShift == 0) {
1087     for (uint32_t i = 0; i < getNumWords() - offset; ++i) 
1088       val[i] = pVal[i+offset];
1089     for (uint32_t i = getNumWords()-offset; i < getNumWords(); i++)
1090       val[i] = 0;
1091     return APInt(val,BitWidth).clearUnusedBits();
1092   }
1093
1094   // Shift the low order words 
1095   uint32_t breakWord = getNumWords() - offset -1;
1096   for (uint32_t i = 0; i < breakWord; ++i)
1097     val[i] = pVal[i+offset] >> wordShift |
1098              pVal[i+offset+1] << (APINT_BITS_PER_WORD - wordShift);
1099   // Shift the break word.
1100   val[breakWord] = pVal[breakWord+offset] >> wordShift;
1101
1102   // Remaining words are 0
1103   for (uint32_t i = breakWord+1; i < getNumWords(); ++i)
1104     val[i] = 0;
1105   return APInt(val, BitWidth).clearUnusedBits();
1106 }
1107
1108 /// Left-shift this APInt by shiftAmt.
1109 /// @brief Left-shift function.
1110 APInt APInt::shl(uint32_t shiftAmt) const {
1111   assert(shiftAmt <= BitWidth && "Invalid shift amount");
1112   if (isSingleWord()) {
1113     if (shiftAmt == BitWidth)
1114       return APInt(BitWidth, 0); // avoid undefined shift results
1115     return APInt(BitWidth, VAL << shiftAmt);
1116   }
1117
1118   // If all the bits were shifted out, the result is 0. This avoids issues
1119   // with shifting by the size of the integer type, which produces undefined
1120   // results. We define these "undefined results" to always be 0.
1121   if (shiftAmt == BitWidth)
1122     return APInt(BitWidth, 0);
1123
1124   // Create some space for the result.
1125   uint64_t * val = new uint64_t[getNumWords()];
1126
1127   // If we are shifting less than a word, do it the easy way
1128   if (shiftAmt < APINT_BITS_PER_WORD) {
1129     uint64_t carry = 0;
1130     for (uint32_t i = 0; i < getNumWords(); i++) {
1131       val[i] = pVal[i] << shiftAmt | carry;
1132       carry = pVal[i] >> (APINT_BITS_PER_WORD - shiftAmt);
1133     }
1134     return APInt(val, BitWidth).clearUnusedBits();
1135   }
1136
1137   // Compute some values needed by the remaining shift algorithms
1138   uint32_t wordShift = shiftAmt % APINT_BITS_PER_WORD;
1139   uint32_t offset = shiftAmt / APINT_BITS_PER_WORD;
1140
1141   // If we are shifting whole words, just move whole words
1142   if (wordShift == 0) {
1143     for (uint32_t i = 0; i < offset; i++) 
1144       val[i] = 0;
1145     for (uint32_t i = offset; i < getNumWords(); i++)
1146       val[i] = pVal[i-offset];
1147     return APInt(val,BitWidth).clearUnusedBits();
1148   }
1149
1150   // Copy whole words from this to Result.
1151   uint32_t i = getNumWords() - 1;
1152   for (; i > offset; --i)
1153     val[i] = pVal[i-offset] << wordShift |
1154              pVal[i-offset-1] >> (APINT_BITS_PER_WORD - wordShift);
1155   val[offset] = pVal[0] << wordShift;
1156   for (i = 0; i < offset; ++i)
1157     val[i] = 0;
1158   return APInt(val, BitWidth).clearUnusedBits();
1159 }
1160
1161 /// Implementation of Knuth's Algorithm D (Division of nonnegative integers)
1162 /// from "Art of Computer Programming, Volume 2", section 4.3.1, p. 272. The
1163 /// variables here have the same names as in the algorithm. Comments explain
1164 /// the algorithm and any deviation from it.
1165 static void KnuthDiv(uint32_t *u, uint32_t *v, uint32_t *q, uint32_t* r, 
1166                      uint32_t m, uint32_t n) {
1167   assert(u && "Must provide dividend");
1168   assert(v && "Must provide divisor");
1169   assert(q && "Must provide quotient");
1170   assert(u != v && u != q && v != q && "Must us different memory");
1171   assert(n>1 && "n must be > 1");
1172
1173   // Knuth uses the value b as the base of the number system. In our case b
1174   // is 2^31 so we just set it to -1u.
1175   uint64_t b = uint64_t(1) << 32;
1176
1177   DEBUG(cerr << "KnuthDiv: m=" << m << " n=" << n << '\n');
1178   DEBUG(cerr << "KnuthDiv: original:");
1179   DEBUG(for (int i = m+n; i >=0; i--) cerr << " " << std::setbase(16) << u[i]);
1180   DEBUG(cerr << " by");
1181   DEBUG(for (int i = n; i >0; i--) cerr << " " << std::setbase(16) << v[i-1]);
1182   DEBUG(cerr << '\n');
1183   // D1. [Normalize.] Set d = b / (v[n-1] + 1) and multiply all the digits of 
1184   // u and v by d. Note that we have taken Knuth's advice here to use a power 
1185   // of 2 value for d such that d * v[n-1] >= b/2 (b is the base). A power of 
1186   // 2 allows us to shift instead of multiply and it is easy to determine the 
1187   // shift amount from the leading zeros.  We are basically normalizing the u
1188   // and v so that its high bits are shifted to the top of v's range without
1189   // overflow. Note that this can require an extra word in u so that u must
1190   // be of length m+n+1.
1191   uint32_t shift = CountLeadingZeros_32(v[n-1]);
1192   uint32_t v_carry = 0;
1193   uint32_t u_carry = 0;
1194   if (shift) {
1195     for (uint32_t i = 0; i < m+n; ++i) {
1196       uint32_t u_tmp = u[i] >> (32 - shift);
1197       u[i] = (u[i] << shift) | u_carry;
1198       u_carry = u_tmp;
1199     }
1200     for (uint32_t i = 0; i < n; ++i) {
1201       uint32_t v_tmp = v[i] >> (32 - shift);
1202       v[i] = (v[i] << shift) | v_carry;
1203       v_carry = v_tmp;
1204     }
1205   }
1206   u[m+n] = u_carry;
1207   DEBUG(cerr << "KnuthDiv:   normal:");
1208   DEBUG(for (int i = m+n; i >=0; i--) cerr << " " << std::setbase(16) << u[i]);
1209   DEBUG(cerr << " by");
1210   DEBUG(for (int i = n; i >0; i--) cerr << " " << std::setbase(16) << v[i-1]);
1211   DEBUG(cerr << '\n');
1212
1213   // D2. [Initialize j.]  Set j to m. This is the loop counter over the places.
1214   int j = m;
1215   do {
1216     DEBUG(cerr << "KnuthDiv: quotient digit #" << j << '\n');
1217     // D3. [Calculate q'.]. 
1218     //     Set qp = (u[j+n]*b + u[j+n-1]) / v[n-1]. (qp=qprime=q')
1219     //     Set rp = (u[j+n]*b + u[j+n-1]) % v[n-1]. (rp=rprime=r')
1220     // Now test if qp == b or qp*v[n-2] > b*rp + u[j+n-2]; if so, decrease
1221     // qp by 1, inrease rp by v[n-1], and repeat this test if rp < b. The test
1222     // on v[n-2] determines at high speed most of the cases in which the trial
1223     // value qp is one too large, and it eliminates all cases where qp is two 
1224     // too large. 
1225     uint64_t dividend = ((uint64_t(u[j+n]) << 32) + u[j+n-1]);
1226     DEBUG(cerr << "KnuthDiv: dividend == " << dividend << '\n');
1227     uint64_t qp = dividend / v[n-1];
1228     uint64_t rp = dividend % v[n-1];
1229     if (qp == b || qp*v[n-2] > b*rp + u[j+n-2]) {
1230       qp--;
1231       rp += v[n-1];
1232       if (rp < b && (qp == b || qp*v[n-2] > b*rp + u[j+n-2]))
1233         qp--;
1234     }
1235     DEBUG(cerr << "KnuthDiv: qp == " << qp << ", rp == " << rp << '\n');
1236
1237     // D4. [Multiply and subtract.] Replace (u[j+n]u[j+n-1]...u[j]) with
1238     // (u[j+n]u[j+n-1]..u[j]) - qp * (v[n-1]...v[1]v[0]). This computation
1239     // consists of a simple multiplication by a one-place number, combined with
1240     // a subtraction. 
1241     bool isNeg = false;
1242     for (uint32_t i = 0; i < n; ++i) {
1243       uint64_t u_tmp = uint64_t(u[j+i]) | (uint64_t(u[j+i+1]) << 32);
1244       uint64_t subtrahend = uint64_t(qp) * uint64_t(v[i]);
1245       bool borrow = subtrahend > u_tmp;
1246       DEBUG(cerr << "KnuthDiv: u_tmp == " << u_tmp 
1247                  << ", subtrahend == " << subtrahend
1248                  << ", borrow = " << borrow << '\n');
1249
1250       uint64_t result = u_tmp - subtrahend;
1251       uint32_t k = j + i;
1252       u[k++] = result & (b-1); // subtract low word
1253       u[k++] = result >> 32;   // subtract high word
1254       while (borrow && k <= m+n) { // deal with borrow to the left
1255         borrow = u[k] == 0;
1256         u[k]--;
1257         k++;
1258       }
1259       isNeg |= borrow;
1260       DEBUG(cerr << "KnuthDiv: u[j+i] == " << u[j+i] << ",  u[j+i+1] == " << 
1261                     u[j+i+1] << '\n'); 
1262     }
1263     DEBUG(cerr << "KnuthDiv: after subtraction:");
1264     DEBUG(for (int i = m+n; i >=0; i--) cerr << " " << u[i]);
1265     DEBUG(cerr << '\n');
1266     // The digits (u[j+n]...u[j]) should be kept positive; if the result of 
1267     // this step is actually negative, (u[j+n]...u[j]) should be left as the 
1268     // true value plus b**(n+1), namely as the b's complement of
1269     // the true value, and a "borrow" to the left should be remembered.
1270     //
1271     if (isNeg) {
1272       bool carry = true;  // true because b's complement is "complement + 1"
1273       for (uint32_t i = 0; i <= m+n; ++i) {
1274         u[i] = ~u[i] + carry; // b's complement
1275         carry = carry && u[i] == 0;
1276       }
1277     }
1278     DEBUG(cerr << "KnuthDiv: after complement:");
1279     DEBUG(for (int i = m+n; i >=0; i--) cerr << " " << u[i]);
1280     DEBUG(cerr << '\n');
1281
1282     // D5. [Test remainder.] Set q[j] = qp. If the result of step D4 was 
1283     // negative, go to step D6; otherwise go on to step D7.
1284     q[j] = qp;
1285     if (isNeg) {
1286       // D6. [Add back]. The probability that this step is necessary is very 
1287       // small, on the order of only 2/b. Make sure that test data accounts for
1288       // this possibility. Decrease q[j] by 1 
1289       q[j]--;
1290       // and add (0v[n-1]...v[1]v[0]) to (u[j+n]u[j+n-1]...u[j+1]u[j]). 
1291       // A carry will occur to the left of u[j+n], and it should be ignored 
1292       // since it cancels with the borrow that occurred in D4.
1293       bool carry = false;
1294       for (uint32_t i = 0; i < n; i++) {
1295         uint32_t limit = std::min(u[j+i],v[i]);
1296         u[j+i] += v[i] + carry;
1297         carry = u[j+i] < limit || (carry && u[j+i] == limit);
1298       }
1299       u[j+n] += carry;
1300     }
1301     DEBUG(cerr << "KnuthDiv: after correction:");
1302     DEBUG(for (int i = m+n; i >=0; i--) cerr <<" " << u[i]);
1303     DEBUG(cerr << "\nKnuthDiv: digit result = " << q[j] << '\n');
1304
1305   // D7. [Loop on j.]  Decrease j by one. Now if j >= 0, go back to D3.
1306   } while (--j >= 0);
1307
1308   DEBUG(cerr << "KnuthDiv: quotient:");
1309   DEBUG(for (int i = m; i >=0; i--) cerr <<" " << q[i]);
1310   DEBUG(cerr << '\n');
1311
1312   // D8. [Unnormalize]. Now q[...] is the desired quotient, and the desired
1313   // remainder may be obtained by dividing u[...] by d. If r is non-null we
1314   // compute the remainder (urem uses this).
1315   if (r) {
1316     // The value d is expressed by the "shift" value above since we avoided
1317     // multiplication by d by using a shift left. So, all we have to do is
1318     // shift right here. In order to mak
1319     if (shift) {
1320       uint32_t carry = 0;
1321       DEBUG(cerr << "KnuthDiv: remainder:");
1322       for (int i = n-1; i >= 0; i--) {
1323         r[i] = (u[i] >> shift) | carry;
1324         carry = u[i] << (32 - shift);
1325         DEBUG(cerr << " " << r[i]);
1326       }
1327     } else {
1328       for (int i = n-1; i >= 0; i--) {
1329         r[i] = u[i];
1330         DEBUG(cerr << " " << r[i]);
1331       }
1332     }
1333     DEBUG(cerr << '\n');
1334   }
1335   DEBUG(cerr << std::setbase(10) << '\n');
1336 }
1337
1338 void APInt::divide(const APInt LHS, uint32_t lhsWords, 
1339                    const APInt &RHS, uint32_t rhsWords,
1340                    APInt *Quotient, APInt *Remainder)
1341 {
1342   assert(lhsWords >= rhsWords && "Fractional result");
1343
1344   // First, compose the values into an array of 32-bit words instead of 
1345   // 64-bit words. This is a necessity of both the "short division" algorithm
1346   // and the the Knuth "classical algorithm" which requires there to be native 
1347   // operations for +, -, and * on an m bit value with an m*2 bit result. We 
1348   // can't use 64-bit operands here because we don't have native results of 
1349   // 128-bits. Furthremore, casting the 64-bit values to 32-bit values won't 
1350   // work on large-endian machines.
1351   uint64_t mask = ~0ull >> (sizeof(uint32_t)*8);
1352   uint32_t n = rhsWords * 2;
1353   uint32_t m = (lhsWords * 2) - n;
1354
1355   // Allocate space for the temporary values we need either on the stack, if
1356   // it will fit, or on the heap if it won't.
1357   uint32_t SPACE[128];
1358   uint32_t *U = 0;
1359   uint32_t *V = 0;
1360   uint32_t *Q = 0;
1361   uint32_t *R = 0;
1362   if ((Remainder?4:3)*n+2*m+1 <= 128) {
1363     U = &SPACE[0];
1364     V = &SPACE[m+n+1];
1365     Q = &SPACE[(m+n+1) + n];
1366     if (Remainder)
1367       R = &SPACE[(m+n+1) + n + (m+n)];
1368   } else {
1369     U = new uint32_t[m + n + 1];
1370     V = new uint32_t[n];
1371     Q = new uint32_t[m+n];
1372     if (Remainder)
1373       R = new uint32_t[n];
1374   }
1375
1376   // Initialize the dividend
1377   memset(U, 0, (m+n+1)*sizeof(uint32_t));
1378   for (unsigned i = 0; i < lhsWords; ++i) {
1379     uint64_t tmp = (LHS.getNumWords() == 1 ? LHS.VAL : LHS.pVal[i]);
1380     U[i * 2] = tmp & mask;
1381     U[i * 2 + 1] = tmp >> (sizeof(uint32_t)*8);
1382   }
1383   U[m+n] = 0; // this extra word is for "spill" in the Knuth algorithm.
1384
1385   // Initialize the divisor
1386   memset(V, 0, (n)*sizeof(uint32_t));
1387   for (unsigned i = 0; i < rhsWords; ++i) {
1388     uint64_t tmp = (RHS.getNumWords() == 1 ? RHS.VAL : RHS.pVal[i]);
1389     V[i * 2] = tmp & mask;
1390     V[i * 2 + 1] = tmp >> (sizeof(uint32_t)*8);
1391   }
1392
1393   // initialize the quotient and remainder
1394   memset(Q, 0, (m+n) * sizeof(uint32_t));
1395   if (Remainder)
1396     memset(R, 0, n * sizeof(uint32_t));
1397
1398   // Now, adjust m and n for the Knuth division. n is the number of words in 
1399   // the divisor. m is the number of words by which the dividend exceeds the
1400   // divisor (i.e. m+n is the length of the dividend). These sizes must not 
1401   // contain any zero words or the Knuth algorithm fails.
1402   for (unsigned i = n; i > 0 && V[i-1] == 0; i--) {
1403     n--;
1404     m++;
1405   }
1406   for (unsigned i = m+n; i > 0 && U[i-1] == 0; i--)
1407     m--;
1408
1409   // If we're left with only a single word for the divisor, Knuth doesn't work
1410   // so we implement the short division algorithm here. This is much simpler
1411   // and faster because we are certain that we can divide a 64-bit quantity
1412   // by a 32-bit quantity at hardware speed and short division is simply a
1413   // series of such operations. This is just like doing short division but we
1414   // are using base 2^32 instead of base 10.
1415   assert(n != 0 && "Divide by zero?");
1416   if (n == 1) {
1417     uint32_t divisor = V[0];
1418     uint32_t remainder = 0;
1419     for (int i = m+n-1; i >= 0; i--) {
1420       uint64_t partial_dividend = uint64_t(remainder) << 32 | U[i];
1421       if (partial_dividend == 0) {
1422         Q[i] = 0;
1423         remainder = 0;
1424       } else if (partial_dividend < divisor) {
1425         Q[i] = 0;
1426         remainder = partial_dividend;
1427       } else if (partial_dividend == divisor) {
1428         Q[i] = 1;
1429         remainder = 0;
1430       } else {
1431         Q[i] = partial_dividend / divisor;
1432         remainder = partial_dividend - (Q[i] * divisor);
1433       }
1434     }
1435     if (R)
1436       R[0] = remainder;
1437   } else {
1438     // Now we're ready to invoke the Knuth classical divide algorithm. In this
1439     // case n > 1.
1440     KnuthDiv(U, V, Q, R, m, n);
1441   }
1442
1443   // If the caller wants the quotient
1444   if (Quotient) {
1445     // Set up the Quotient value's memory.
1446     if (Quotient->BitWidth != LHS.BitWidth) {
1447       if (Quotient->isSingleWord())
1448         Quotient->VAL = 0;
1449       else
1450         delete [] Quotient->pVal;
1451       Quotient->BitWidth = LHS.BitWidth;
1452       if (!Quotient->isSingleWord())
1453         Quotient->pVal = getClearedMemory(Quotient->getNumWords());
1454     } else
1455       Quotient->clear();
1456
1457     // The quotient is in Q. Reconstitute the quotient into Quotient's low 
1458     // order words.
1459     if (lhsWords == 1) {
1460       uint64_t tmp = 
1461         uint64_t(Q[0]) | (uint64_t(Q[1]) << (APINT_BITS_PER_WORD / 2));
1462       if (Quotient->isSingleWord())
1463         Quotient->VAL = tmp;
1464       else
1465         Quotient->pVal[0] = tmp;
1466     } else {
1467       assert(!Quotient->isSingleWord() && "Quotient APInt not large enough");
1468       for (unsigned i = 0; i < lhsWords; ++i)
1469         Quotient->pVal[i] = 
1470           uint64_t(Q[i*2]) | (uint64_t(Q[i*2+1]) << (APINT_BITS_PER_WORD / 2));
1471     }
1472   }
1473
1474   // If the caller wants the remainder
1475   if (Remainder) {
1476     // Set up the Remainder value's memory.
1477     if (Remainder->BitWidth != RHS.BitWidth) {
1478       if (Remainder->isSingleWord())
1479         Remainder->VAL = 0;
1480       else
1481         delete [] Remainder->pVal;
1482       Remainder->BitWidth = RHS.BitWidth;
1483       if (!Remainder->isSingleWord())
1484         Remainder->pVal = getClearedMemory(Remainder->getNumWords());
1485     } else
1486       Remainder->clear();
1487
1488     // The remainder is in R. Reconstitute the remainder into Remainder's low
1489     // order words.
1490     if (rhsWords == 1) {
1491       uint64_t tmp = 
1492         uint64_t(R[0]) | (uint64_t(R[1]) << (APINT_BITS_PER_WORD / 2));
1493       if (Remainder->isSingleWord())
1494         Remainder->VAL = tmp;
1495       else
1496         Remainder->pVal[0] = tmp;
1497     } else {
1498       assert(!Remainder->isSingleWord() && "Remainder APInt not large enough");
1499       for (unsigned i = 0; i < rhsWords; ++i)
1500         Remainder->pVal[i] = 
1501           uint64_t(R[i*2]) | (uint64_t(R[i*2+1]) << (APINT_BITS_PER_WORD / 2));
1502     }
1503   }
1504
1505   // Clean up the memory we allocated.
1506   if (U != &SPACE[0]) {
1507     delete [] U;
1508     delete [] V;
1509     delete [] Q;
1510     delete [] R;
1511   }
1512 }
1513
1514 APInt APInt::udiv(const APInt& RHS) const {
1515   assert(BitWidth == RHS.BitWidth && "Bit widths must be the same");
1516
1517   // First, deal with the easy case
1518   if (isSingleWord()) {
1519     assert(RHS.VAL != 0 && "Divide by zero?");
1520     return APInt(BitWidth, VAL / RHS.VAL);
1521   }
1522
1523   // Get some facts about the LHS and RHS number of bits and words
1524   uint32_t rhsBits = RHS.getActiveBits();
1525   uint32_t rhsWords = !rhsBits ? 0 : (APInt::whichWord(rhsBits - 1) + 1);
1526   assert(rhsWords && "Divided by zero???");
1527   uint32_t lhsBits = this->getActiveBits();
1528   uint32_t lhsWords = !lhsBits ? 0 : (APInt::whichWord(lhsBits - 1) + 1);
1529
1530   // Deal with some degenerate cases
1531   if (!lhsWords) 
1532     // 0 / X ===> 0
1533     return APInt(BitWidth, 0); 
1534   else if (lhsWords < rhsWords || this->ult(RHS)) {
1535     // X / Y ===> 0, iff X < Y
1536     return APInt(BitWidth, 0);
1537   } else if (*this == RHS) {
1538     // X / X ===> 1
1539     return APInt(BitWidth, 1);
1540   } else if (lhsWords == 1 && rhsWords == 1) {
1541     // All high words are zero, just use native divide
1542     return APInt(BitWidth, this->pVal[0] / RHS.pVal[0]);
1543   }
1544
1545   // We have to compute it the hard way. Invoke the Knuth divide algorithm.
1546   APInt Quotient(1,0); // to hold result.
1547   divide(*this, lhsWords, RHS, rhsWords, &Quotient, 0);
1548   return Quotient;
1549 }
1550
1551 APInt APInt::urem(const APInt& RHS) const {
1552   assert(BitWidth == RHS.BitWidth && "Bit widths must be the same");
1553   if (isSingleWord()) {
1554     assert(RHS.VAL != 0 && "Remainder by zero?");
1555     return APInt(BitWidth, VAL % RHS.VAL);
1556   }
1557
1558   // Get some facts about the LHS
1559   uint32_t lhsBits = getActiveBits();
1560   uint32_t lhsWords = !lhsBits ? 0 : (whichWord(lhsBits - 1) + 1);
1561
1562   // Get some facts about the RHS
1563   uint32_t rhsBits = RHS.getActiveBits();
1564   uint32_t rhsWords = !rhsBits ? 0 : (APInt::whichWord(rhsBits - 1) + 1);
1565   assert(rhsWords && "Performing remainder operation by zero ???");
1566
1567   // Check the degenerate cases
1568   if (lhsWords == 0) {
1569     // 0 % Y ===> 0
1570     return APInt(BitWidth, 0);
1571   } else if (lhsWords < rhsWords || this->ult(RHS)) {
1572     // X % Y ===> X, iff X < Y
1573     return *this;
1574   } else if (*this == RHS) {
1575     // X % X == 0;
1576     return APInt(BitWidth, 0);
1577   } else if (lhsWords == 1) {
1578     // All high words are zero, just use native remainder
1579     return APInt(BitWidth, pVal[0] % RHS.pVal[0]);
1580   }
1581
1582   // We have to compute it the hard way. Invoke the Knute divide algorithm.
1583   APInt Remainder(1,0);
1584   divide(*this, lhsWords, RHS, rhsWords, 0, &Remainder);
1585   return Remainder;
1586 }
1587
1588 void APInt::fromString(uint32_t numbits, const char *str, uint32_t slen, 
1589                        uint8_t radix) {
1590   // Check our assumptions here
1591   assert((radix == 10 || radix == 8 || radix == 16 || radix == 2) &&
1592          "Radix should be 2, 8, 10, or 16!");
1593   assert(str && "String is null?");
1594   bool isNeg = str[0] == '-';
1595   if (isNeg)
1596     str++, slen--;
1597   assert(slen <= numbits || radix != 2 && "Insufficient bit width");
1598   assert(slen*3 <= numbits || radix != 8 && "Insufficient bit width");
1599   assert(slen*4 <= numbits || radix != 16 && "Insufficient bit width");
1600   assert((slen*64)/20 <= numbits || radix != 10 && "Insufficient bit width");
1601
1602   // Allocate memory
1603   if (!isSingleWord())
1604     pVal = getClearedMemory(getNumWords());
1605
1606   // Figure out if we can shift instead of multiply
1607   uint32_t shift = (radix == 16 ? 4 : radix == 8 ? 3 : radix == 2 ? 1 : 0);
1608
1609   // Set up an APInt for the digit to add outside the loop so we don't
1610   // constantly construct/destruct it.
1611   APInt apdigit(getBitWidth(), 0);
1612   APInt apradix(getBitWidth(), radix);
1613
1614   // Enter digit traversal loop
1615   for (unsigned i = 0; i < slen; i++) {
1616     // Get a digit
1617     uint32_t digit = 0;
1618     char cdigit = str[i];
1619     if (isdigit(cdigit))
1620       digit = cdigit - '0';
1621     else if (isxdigit(cdigit))
1622       if (cdigit >= 'a')
1623         digit = cdigit - 'a' + 10;
1624       else if (cdigit >= 'A')
1625         digit = cdigit - 'A' + 10;
1626       else
1627         assert(0 && "huh?");
1628     else
1629       assert(0 && "Invalid character in digit string");
1630
1631     // Shift or multiple the value by the radix
1632     if (shift)
1633       this->shl(shift);
1634     else
1635       *this *= apradix;
1636
1637     // Add in the digit we just interpreted
1638     if (apdigit.isSingleWord())
1639       apdigit.VAL = digit;
1640     else
1641       apdigit.pVal[0] = digit;
1642     *this += apdigit;
1643   }
1644   // If its negative, put it in two's complement form
1645   if (isNeg) {
1646     (*this)--;
1647     this->flip();
1648   }
1649 }
1650
1651 std::string APInt::toString(uint8_t radix, bool wantSigned) const {
1652   assert((radix == 10 || radix == 8 || radix == 16 || radix == 2) &&
1653          "Radix should be 2, 8, 10, or 16!");
1654   static const char *digits[] = { 
1655     "0","1","2","3","4","5","6","7","8","9","A","B","C","D","E","F" 
1656   };
1657   std::string result;
1658   uint32_t bits_used = getActiveBits();
1659   if (isSingleWord()) {
1660     char buf[65];
1661     const char *format = (radix == 10 ? (wantSigned ? "%lld" : "%llu") :
1662        (radix == 16 ? "%llX" : (radix == 8 ? "%llo" : 0)));
1663     if (format) {
1664       if (wantSigned) {
1665         int64_t sextVal = (int64_t(VAL) << (APINT_BITS_PER_WORD-BitWidth)) >> 
1666                            (APINT_BITS_PER_WORD-BitWidth);
1667         sprintf(buf, format, sextVal);
1668       } else 
1669         sprintf(buf, format, VAL);
1670     } else {
1671       memset(buf, 0, 65);
1672       uint64_t v = VAL;
1673       while (bits_used) {
1674         uint32_t bit = v & 1;
1675         bits_used--;
1676         buf[bits_used] = digits[bit][0];
1677         v >>=1;
1678       }
1679     }
1680     result = buf;
1681     return result;
1682   }
1683
1684   if (radix != 10) {
1685     uint64_t mask = radix - 1;
1686     uint32_t shift = (radix == 16 ? 4 : radix  == 8 ? 3 : 1);
1687     uint32_t nibbles = APINT_BITS_PER_WORD / shift;
1688     for (uint32_t i = 0; i < getNumWords(); ++i) {
1689       uint64_t value = pVal[i];
1690       for (uint32_t j = 0; j < nibbles; ++j) {
1691         result.insert(0, digits[ value & mask ]);
1692         value >>= shift;
1693       }
1694     }
1695     return result;
1696   }
1697
1698   APInt tmp(*this);
1699   APInt divisor(4, radix);
1700   APInt zero(tmp.getBitWidth(), 0);
1701   size_t insert_at = 0;
1702   if (wantSigned && tmp[BitWidth-1]) {
1703     // They want to print the signed version and it is a negative value
1704     // Flip the bits and add one to turn it into the equivalent positive
1705     // value and put a '-' in the result.
1706     tmp.flip();
1707     tmp++;
1708     result = "-";
1709     insert_at = 1;
1710   }
1711   if (tmp == APInt(tmp.getBitWidth(), 0))
1712     result = "0";
1713   else while (tmp.ne(zero)) {
1714     APInt APdigit(1,0);
1715     APInt tmp2(tmp.getBitWidth(), 0);
1716     divide(tmp, tmp.getNumWords(), divisor, divisor.getNumWords(), &tmp2, 
1717            &APdigit);
1718     uint32_t digit = APdigit.getZExtValue();
1719     assert(digit < radix && "divide failed");
1720     result.insert(insert_at,digits[digit]);
1721     tmp = tmp2;
1722   }
1723
1724   return result;
1725 }
1726
1727 #ifndef NDEBUG
1728 void APInt::dump() const
1729 {
1730   cerr << "APInt(" << BitWidth << ")=" << std::setbase(16);
1731   if (isSingleWord())
1732     cerr << VAL;
1733   else for (unsigned i = getNumWords(); i > 0; i--) {
1734     cerr << pVal[i-1] << " ";
1735   }
1736   cerr << " U(" << this->toString(10) << ") S(" << this->toStringSigned(10)
1737        << ")\n" << std::setbase(10);
1738 }
1739 #endif