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