include/llvm/ADT/APInt.h

   1 //===-- llvm/Support/APInt.h - For Arbitrary Precision Integer -*- C++ -*--===//
   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 integral
  11 // constant values and operations on them.
  12 //
  13 //===----------------------------------------------------------------------===//
  14
  15 #ifndef LLVM_APINT_H
  16 #define LLVM_APINT_H
  17
  18 #include "llvm/Support/DataTypes.h"
  19 #include <cassert>
  20 #include <string>
  21
  22 namespace llvm {
  23
  24 //===----------------------------------------------------------------------===//
  25 //                              APInt Class
  26 //===----------------------------------------------------------------------===//
  27
  28 /// APInt - This class represents arbitrary precision constant integral values.
  29 /// It is a functional replacement for common case unsigned integer type like
  30 /// "unsigned", "unsigned long" or "uint64_t", but also allows non-byte-width
  31 /// integer sizes and large integer value types such as 3-bits, 15-bits, or more
  32 /// than 64-bits of precision. APInt provides a variety of arithmetic operators
  33 /// and methods to manipulate integer values of any bit-width. It supports both
  34 /// the typical integer arithmetic and comparison operations as well as bitwise
  35 /// manipulation.
  36 ///
  37 /// The class has several invariants worth noting:
  38 ///   * All bit, byte, and word positions are zero-based.
  39 ///   * Once the bit width is set, it doesn't change except by the Truncate,
  40 ///     SignExtend, or ZeroExtend operations.
  41 ///   * All binary operators must be on APInt instances of the same bit width.
  42 ///     Attempting to use these operators on instances with different bit
  43 ///     widths will yield an assertion.
  44 ///   * The value is stored canonically as an unsigned value. For operations
  45 ///     where it makes a difference, there are both signed and unsigned variants
  46 ///     of the operation. For example, sdiv and udiv. However, because the bit
  47 ///     widths must be the same, operations such as Mul and Add produce the same
  48 ///     results regardless of whether the values are interpreted as signed or
  49 ///     not.
  50 ///   * In general, the class tries to follow the style of computation that LLVM
  51 ///     uses in its IR. This simplifies its use for LLVM.
  52 ///
  53 /// @brief Class for arbitrary precision integers.
  54 class APInt {
  55
  56   uint32_t BitWidth;      ///< The number of bits in this APInt.
  57
  58   /// This union is used to store the integer value. When the
  59   /// integer bit-width <= 64, it uses VAL, otherwise it uses pVal.
  60   union {
  61     uint64_t VAL;    ///< Used to store the <= 64 bits integer value.
  62     uint64_t *pVal;  ///< Used to store the >64 bits integer value.
  63   };
  64
  65   /// This enum is used to hold the constants we needed for APInt.
  66   enum {
  67     APINT_BITS_PER_WORD = sizeof(uint64_t) * 8, ///< Bits in a word
  68     APINT_WORD_SIZE = sizeof(uint64_t)          ///< Byte size of a word
  69   };
  70
  71   /// This constructor is used only internally for speed of construction of
  72   /// temporaries. It is unsafe for general use so it is not public.
  73   /// @brief Fast internal constructor
  74   APInt(uint64_t* val, uint32_t bits) : BitWidth(bits), pVal(val) { }
  75
  76   /// @returns true if the number of bits <= 64, false otherwise.
  77   /// @brief Determine if this APInt just has one word to store value.
  78   inline bool isSingleWord() const {
  79     return BitWidth <= APINT_BITS_PER_WORD;
  80   }
  81
  82   /// @returns the word position for the specified bit position.
  83   /// @brief Determine which word a bit is in.
  84   static inline uint32_t whichWord(uint32_t bitPosition) {
  85     return bitPosition / APINT_BITS_PER_WORD;
  86   }
  87
  88   /// @returns the bit position in a word for the specified bit position
  89   /// in the APInt.
  90   /// @brief Determine which bit in a word a bit is in.
  91   static inline uint32_t whichBit(uint32_t bitPosition) {
  92     return bitPosition % APINT_BITS_PER_WORD;
  93   }
  94
  95   /// This method generates and returns a uint64_t (word) mask for a single
  96   /// bit at a specific bit position. This is used to mask the bit in the
  97   /// corresponding word.
  98   /// @returns a uint64_t with only bit at "whichBit(bitPosition)" set
  99   /// @brief Get a single bit mask.
 100   static inline uint64_t maskBit(uint32_t bitPosition) {
 101     return 1ULL << whichBit(bitPosition);
 102   }
 103
 104   /// This method is used internally to clear the to "N" bits in the high order
 105   /// word that are not used by the APInt. This is needed after the most
 106   /// significant word is assigned a value to ensure that those bits are
 107   /// zero'd out.
 108   /// @brief Clear unused high order bits
 109   inline APInt& clearUnusedBits() {
 110     // Compute how many bits are used in the final word
 111     uint32_t wordBits = BitWidth % APINT_BITS_PER_WORD;
 112     if (wordBits == 0)
 113       // If all bits are used, we want to leave the value alone. This also
 114       // avoids the undefined behavior of >> when the shfit is the same size as
 115       // the word size (64).
 116       return *this;
 117
 118     // Mask out the hight bits.
 119     uint64_t mask = ~uint64_t(0ULL) >> (APINT_BITS_PER_WORD - wordBits);
 120     if (isSingleWord())
 121       VAL &= mask;
 122     else
 123       pVal[getNumWords() - 1] &= mask;
 124     return *this;
 125   }
 126
 127   /// @returns the corresponding word for the specified bit position.
 128   /// @brief Get the word corresponding to a bit position
 129   inline uint64_t getWord(uint32_t bitPosition) const {
 130     return isSingleWord() ? VAL : pVal[whichWord(bitPosition)];
 131   }
 132
 133   /// This is used by the constructors that take string arguments.
 134   /// @brief Convert a char array into an APInt
 135   void fromString(uint32_t numBits, const char *strStart, uint32_t slen,
 136                   uint8_t radix);
 137
 138   /// This is used by the toString method to divide by the radix. It simply
 139   /// provides a more convenient form of divide for internal use since KnuthDiv
 140   /// has specific constraints on its inputs. If those constraints are not met
 141   /// then it provides a simpler form of divide.
 142   /// @brief An internal division function for dividing APInts.
 143   static void divide(const APInt LHS, uint32_t lhsWords,
 144                      const APInt &RHS, uint32_t rhsWords,
 145                      APInt *Quotient, APInt *Remainder);
 146
 147 #ifndef NDEBUG
 148   /// @brief debug method
 149   void dump() const;
 150 #endif
 151
 152 public:
 153   /// @name Constructors
 154   /// @{
 155   /// If isSigned is true then val is treated as if it were a signed value
 156   /// (i.e. as an int64_t) and the appropriate sign extension to the bit width
 157   /// will be done. Otherwise, no sign extension occurs (high order bits beyond
 158   /// the range of val are zero filled).
 159   /// @param numBits the bit width of the constructed APInt
 160   /// @param val the initial value of the APInt
 161   /// @param isSigned how to treat signedness of val
 162   /// @brief Create a new APInt of numBits width, initialized as val.
 163   APInt(uint32_t numBits, uint64_t val, bool isSigned = false);
 164
 165   /// Note that numWords can be smaller or larger than the corresponding bit
 166   /// width but any extraneous bits will be dropped.
 167   /// @param numBits the bit width of the constructed APInt
 168   /// @param numWords the number of words in bigVal
 169   /// @param bigVal a sequence of words to form the initial value of the APInt
 170   /// @brief Construct an APInt of numBits width, initialized as bigVal[].
 171   APInt(uint32_t numBits, uint32_t numWords, uint64_t bigVal[]);
 172
 173   /// This constructor interprets Val as a string in the given radix. The
 174   /// interpretation stops when the first charater that is not suitable for the
 175   /// radix is encountered. Acceptable radix values are 2, 8, 10 and 16. It is
 176   /// an error for the value implied by the string to require more bits than
 177   /// numBits.
 178   /// @param numBits the bit width of the constructed APInt
 179   /// @param val the string to be interpreted
 180   /// @param radix the radix of Val to use for the intepretation
 181   /// @brief Construct an APInt from a string representation.
 182   APInt(uint32_t numBits, const std::string& val, uint8_t radix);
 183
 184   /// This constructor interprets the slen characters starting at StrStart as
 185   /// a string in the given radix. The interpretation stops when the first
 186   /// character that is not suitable for the radix is encountered. Acceptable
 187   /// radix values are 2, 8, 10 and 16. It is an error for the value implied by
 188   /// the string to require more bits than numBits.
 189   /// @param numBits the bit width of the constructed APInt
 190   /// @param strStart the start of the string to be interpreted
 191   /// @param slen the maximum number of characters to interpret
 192   /// @brief Construct an APInt from a string representation.
 193   APInt(uint32_t numBits, const char strStart[], uint32_t slen, uint8_t radix);
 194
 195   /// Simply makes *this a copy of that.
 196   /// @brief Copy Constructor.
 197   APInt(const APInt& that);
 198
 199   /// @brief Destructor.
 200   ~APInt();
 201
 202   /// @}
 203   /// @name Value Tests
 204   /// @{
 205   /// This tests the high bit of this APInt to determine if it is set.
 206   /// @returns true if this APInt is negative, false otherwise
 207   /// @brief Determine sign of this APInt.
 208   bool isNegative() const {
 209     return (*this)[BitWidth - 1];
 210   }
 211
 212   /// This tests the high bit of the APInt to determine if it is unset.
 213   /// @brief Determine if this APInt Value is positive (not negative).
 214   bool isPositive() const {
 215     return !isNegative();
 216   }
 217
 218   /// This tests if the value of this APInt is strictly positive (> 0).
 219   /// @returns true if this APInt is Positive and not zero.
 220   /// @brief Determine if this APInt Value is strictly positive.
 221   inline bool isStrictlyPositive() const {
 222     return isPositive() && (*this) != 0;
 223   }
 224
 225   /// This checks to see if the value has all bits of the APInt are set or not.
 226   /// @brief Determine if all bits are set
 227   inline bool isAllOnesValue() const {
 228     return countPopulation() == BitWidth;
 229   }
 230
 231   /// This checks to see if the value of this APInt is the maximum unsigned
 232   /// value for the APInt's bit width.
 233   /// @brief Determine if this is the largest unsigned value.
 234   bool isMaxValue() const {
 235     return countPopulation() == BitWidth;
 236   }
 237
 238   /// This checks to see if the value of this APInt is the maximum signed
 239   /// value for the APInt's bit width.
 240   /// @brief Determine if this is the largest signed value.
 241   bool isMaxSignedValue() const {
 242     return BitWidth == 1 ? VAL == 0 :
 243                           !isNegative() && countPopulation() == BitWidth - 1;
 244   }
 245
 246   /// This checks to see if the value of this APInt is the minimum unsigned
 247   /// value for the APInt's bit width.
 248   /// @brief Determine if this is the smallest unsigned value.
 249   bool isMinValue() const {
 250     return countPopulation() == 0;
 251   }
 252
 253   /// This checks to see if the value of this APInt is the minimum signed
 254   /// value for the APInt's bit width.
 255   /// @brief Determine if this is the smallest signed value.
 256   bool isMinSignedValue() const {
 257     return BitWidth == 1 ? VAL == 1 :
 258                            isNegative() && countPopulation() == 1;
 259   }
 260
 261   /// @brief Check if this APInt has an N-bits integer value.
 262   inline bool isIntN(uint32_t N) const {
 263     assert(N && "N == 0 ???");
 264     if (isSingleWord()) {
 265       return VAL == (VAL & (~0ULL >> (64 - N)));
 266     } else {
 267       APInt Tmp(N, getNumWords(), pVal);
 268       return Tmp == (*this);
 269     }
 270   }
 271
 272   /// @returns true if the argument APInt value is a power of two > 0.
 273   bool isPowerOf2() const;
 274
 275   /// This converts the APInt to a boolean valy as a test against zero.
 276   /// @brief Boolean conversion function.
 277   inline bool getBoolValue() const {
 278     return countLeadingZeros() != BitWidth;
 279   }
 280
 281   /// @}
 282   /// @name Value Generators
 283   /// @{
 284   /// @brief Gets maximum unsigned value of APInt for specific bit width.
 285   static APInt getMaxValue(uint32_t numBits) {
 286     return APInt(numBits, 0).set();
 287   }
 288
 289   /// @brief Gets maximum signed value of APInt for a specific bit width.
 290   static APInt getSignedMaxValue(uint32_t numBits) {
 291     return APInt(numBits, 0).set().clear(numBits - 1);
 292   }
 293
 294   /// @brief Gets minimum unsigned value of APInt for a specific bit width.
 295   static APInt getMinValue(uint32_t numBits) {
 296     return APInt(numBits, 0);
 297   }
 298
 299   /// @brief Gets minimum signed value of APInt for a specific bit width.
 300   static APInt getSignedMinValue(uint32_t numBits) {
 301     return APInt(numBits, 0).set(numBits - 1);
 302   }
 303
 304   /// getSignBit - This is just a wrapper function of getSignedMinValue(), and
 305   /// it helps code readability when we want to get a SignBit.
 306   /// @brief Get the SignBit for a specific bit width.
 307   inline static APInt getSignBit(uint32_t BitWidth) {
 308     return getSignedMinValue(BitWidth);
 309   }
 310
 311   /// @returns the all-ones value for an APInt of the specified bit-width.
 312   /// @brief Get the all-ones value.
 313   static APInt getAllOnesValue(uint32_t numBits) {
 314     return APInt(numBits, 0).set();
 315   }
 316
 317   /// @returns the '0' value for an APInt of the specified bit-width.
 318   /// @brief Get the '0' value.
 319   static APInt getNullValue(uint32_t numBits) {
 320     return APInt(numBits, 0);
 321   }
 322
 323   /// Get an APInt with the same BitWidth as this APInt, just zero mask
 324   /// the low bits and right shift to the least significant bit.
 325   /// @returns the high "numBits" bits of this APInt.
 326   APInt getHiBits(uint32_t numBits) const;
 327
 328   /// Get an APInt with the same BitWidth as this APInt, just zero mask
 329   /// the high bits.
 330   /// @returns the low "numBits" bits of this APInt.
 331   APInt getLoBits(uint32_t numBits) const;
 332
 333   /// Constructs an APInt value that has a contiguous range of bits set. The
 334   /// bits from loBit to hiBit will be set. All other bits will be zero. For
 335   /// example, with parameters(32, 15, 0) you would get 0x0000FFFF. If hiBit is
 336   /// less than loBit then the set bits "wrap". For example, with
 337   /// parameters (32, 3, 28), you would get 0xF000000F.
 338   /// @param numBits the intended bit width of the result
 339   /// @param loBit the index of the lowest bit set.
 340   /// @param hiBit the index of the highest bit set.
 341   /// @returns An APInt value with the requested bits set.
 342   /// @brief Get a value with a block of bits set.
 343   static APInt getBitsSet(uint32_t numBits, uint32_t loBit, uint32_t hiBit) {
 344     assert(hiBit < numBits && "hiBit out of range");
 345     assert(loBit < numBits && "loBit out of range");
 346     if (hiBit < loBit)
 347       return getLowBitsSet(numBits, hiBit+1) |
 348              getHighBitsSet(numBits, numBits-loBit+1);
 349     return getLowBitsSet(numBits, hiBit-loBit+1).shl(loBit);
 350   }
 351
 352   /// Constructs an APInt value that has the top hiBitsSet bits set.
 353   /// @param numBits the bitwidth of the result
 354   /// @param hiBitsSet the number of high-order bits set in the result.
 355   /// @brief Get a value with high bits set
 356   static APInt getHighBitsSet(uint32_t numBits, uint32_t hiBitsSet) {
 357     assert(hiBitsSet <= numBits && "Too many bits to set!");
 358     assert(hiBitsSet > 0 && "You must set SOME bits");
 359     uint32_t shiftAmt = numBits - hiBitsSet;
 360     // For small values, return quickly
 361     if (numBits <= APINT_BITS_PER_WORD)
 362       return APInt(numBits, ~0ULL << shiftAmt);
 363     return (~APInt(numBits, 0)).shl(shiftAmt);
 364   }
 365
 366   /// Constructs an APInt value that has the bottom loBitsSet bits set.
 367   /// @param numBits the bitwidth of the result
 368   /// @param loBitsSet the number of low-order bits set in the result.
 369   /// @brief Get a value with low bits set
 370   static APInt getLowBitsSet(uint32_t numBits, uint32_t loBitsSet) {
 371     assert(loBitsSet <= numBits && "Too many bits to set!");
 372     assert(loBitsSet > 0 && "You must set SOME bits");
 373     uint32_t shiftAmt = numBits - loBitsSet;
 374     // For small values, return quickly
 375     if (numBits <= APINT_BITS_PER_WORD)
 376       return APInt(numBits, ~0ULL >> shiftAmt);
 377     return (~APInt(numBits, 0)).lshr(shiftAmt);
 378   }
 379
 380   /// The hash value is computed as the sum of the words and the bit width.
 381   /// @returns A hash value computed from the sum of the APInt words.
 382   /// @brief Get a hash value based on this APInt
 383   uint64_t getHashValue() const;
 384
 385   /// This function returns a pointer to the internal storage of the APInt.
 386   /// This is useful for writing out the APInt in binary form without any
 387   /// conversions.
 388   inline const uint64_t* getRawData() const {
 389     if (isSingleWord())
 390       return &VAL;
 391     return &pVal[0];
 392   }
 393
 394   /// @brief Set a sepcific word in the value to a new value.
 395   inline void setWordToValue(uint32_t idx, uint64_t Val) {
 396     assert(idx < getNumWords() && "Invalid word array index");
 397     if (isSingleWord())
 398       VAL = Val;
 399     else
 400       pVal[idx] = Val;
 401   }
 402
 403   /// @}
 404   /// @name Unary Operators
 405   /// @{
 406   /// @returns a new APInt value representing *this incremented by one
 407   /// @brief Postfix increment operator.
 408   inline const APInt operator++(int) {
 409     APInt API(*this);
 410     ++(*this);
 411     return API;
 412   }
 413
 414   /// @returns *this incremented by one
 415   /// @brief Prefix increment operator.
 416   APInt& operator++();
 417
 418   /// @returns a new APInt representing *this decremented by one.
 419   /// @brief Postfix decrement operator.
 420   inline const APInt operator--(int) {
 421     APInt API(*this);
 422     --(*this);
 423     return API;
 424   }
 425
 426   /// @returns *this decremented by one.
 427   /// @brief Prefix decrement operator.
 428   APInt& operator--();
 429
 430   /// Performs a bitwise complement operation on this APInt.
 431   /// @returns an APInt that is the bitwise complement of *this
 432   /// @brief Unary bitwise complement operator.
 433   APInt operator~() const;
 434
 435   /// Negates *this using two's complement logic.
 436   /// @returns An APInt value representing the negation of *this.
 437   /// @brief Unary negation operator
 438   inline APInt operator-() const {
 439     return APInt(BitWidth, 0) - (*this);
 440   }
 441
 442   /// Performs logical negation operation on this APInt.
 443   /// @returns true if *this is zero, false otherwise.
 444   /// @brief Logical negation operator.
 445   bool operator !() const;
 446
 447   /// @}
 448   /// @name Assignment Operators
 449   /// @{
 450   /// @returns *this after assignment of RHS.
 451   /// @brief Copy assignment operator.
 452   APInt& operator=(const APInt& RHS);
 453
 454   /// The RHS value is assigned to *this. If the significant bits in RHS exceed
 455   /// the bit width, the excess bits are truncated. If the bit width is larger
 456   /// than 64, the value is zero filled in the unspecified high order bits.
 457   /// @returns *this after assignment of RHS value.
 458   /// @brief Assignment operator.
 459   APInt& operator=(uint64_t RHS);
 460
 461   /// Performs a bitwise AND operation on this APInt and RHS. The result is
 462   /// assigned to *this.
 463   /// @returns *this after ANDing with RHS.
 464   /// @brief Bitwise AND assignment operator.
 465   APInt& operator&=(const APInt& RHS);
 466
 467   /// Performs a bitwise OR operation on this APInt and RHS. The result is
 468   /// assigned *this;
 469   /// @returns *this after ORing with RHS.
 470   /// @brief Bitwise OR assignment operator.
 471   APInt& operator|=(const APInt& RHS);
 472
 473   /// Performs a bitwise XOR operation on this APInt and RHS. The result is
 474   /// assigned to *this.
 475   /// @returns *this after XORing with RHS.
 476   /// @brief Bitwise XOR assignment operator.
 477   APInt& operator^=(const APInt& RHS);
 478
 479   /// Multiplies this APInt by RHS and assigns the result to *this.
 480   /// @returns *this
 481   /// @brief Multiplication assignment operator.
 482   APInt& operator*=(const APInt& RHS);
 483
 484   /// Adds RHS to *this and assigns the result to *this.
 485   /// @returns *this
 486   /// @brief Addition assignment operator.
 487   APInt& operator+=(const APInt& RHS);
 488
 489   /// Subtracts RHS from *this and assigns the result to *this.
 490   /// @returns *this
 491   /// @brief Subtraction assignment operator.
 492   APInt& operator-=(const APInt& RHS);
 493
 494   /// Shifts *this left by shiftAmt and assigns the result to *this.
 495   /// @returns *this after shifting left by shiftAmt
 496   /// @brief Left-shift assignment function.
 497   inline APInt& operator<<=(uint32_t shiftAmt) {
 498     *this = shl(shiftAmt);
 499     return *this;
 500   }
 501
 502   /// @}
 503   /// @name Binary Operators
 504   /// @{
 505   /// Performs a bitwise AND operation on *this and RHS.
 506   /// @returns An APInt value representing the bitwise AND of *this and RHS.
 507   /// @brief Bitwise AND operator.
 508   APInt operator&(const APInt& RHS) const;
 509   APInt And(const APInt& RHS) const {
 510     return this->operator&(RHS);
 511   }
 512
 513   /// Performs a bitwise OR operation on *this and RHS.
 514   /// @returns An APInt value representing the bitwise OR of *this and RHS.
 515   /// @brief Bitwise OR operator.
 516   APInt operator|(const APInt& RHS) const;
 517   APInt Or(const APInt& RHS) const {
 518     return this->operator|(RHS);
 519   }
 520
 521   /// Performs a bitwise XOR operation on *this and RHS.
 522   /// @returns An APInt value representing the bitwise XOR of *this and RHS.
 523   /// @brief Bitwise XOR operator.
 524   APInt operator^(const APInt& RHS) const;
 525   APInt Xor(const APInt& RHS) const {
 526     return this->operator^(RHS);
 527   }
 528
 529   /// Multiplies this APInt by RHS and returns the result.
 530   /// @brief Multiplication operator.
 531   APInt operator*(const APInt& RHS) const;
 532
 533   /// Adds RHS to this APInt and returns the result.
 534   /// @brief Addition operator.
 535   APInt operator+(const APInt& RHS) const;
 536   APInt operator+(uint64_t RHS) const {
 537     return (*this) + APInt(BitWidth, RHS);
 538   }
 539
 540   /// Subtracts RHS from this APInt and returns the result.
 541   /// @brief Subtraction operator.
 542   APInt operator-(const APInt& RHS) const;
 543   APInt operator-(uint64_t RHS) const {
 544     return (*this) - APInt(BitWidth, RHS);
 545   }
 546
 547   /// Arithmetic right-shift this APInt by shiftAmt.
 548   /// @brief Arithmetic right-shift function.
 549   APInt ashr(uint32_t shiftAmt) const;
 550
 551   /// Logical right-shift this APInt by shiftAmt.
 552   /// @brief Logical right-shift function.
 553   APInt lshr(uint32_t shiftAmt) const;
 554
 555   /// Left-shift this APInt by shiftAmt.
 556   /// @brief Left-shift function.
 557   APInt shl(uint32_t shiftAmt) const;
 558
 559   /// Perform an unsigned divide operation on this APInt by RHS. Both this and
 560   /// RHS are treated as unsigned quantities for purposes of this division.
 561   /// @returns a new APInt value containing the division result
 562   /// @brief Unsigned division operation.
 563   APInt udiv(const APInt& RHS) const;
 564
 565   /// Signed divide this APInt by APInt RHS.
 566   /// @brief Signed division function for APInt.
 567   inline APInt sdiv(const APInt& RHS) const {
 568     if (isNegative())
 569       if (RHS.isNegative())
 570         return (-(*this)).udiv(-RHS);
 571       else
 572         return -((-(*this)).udiv(RHS));
 573     else if (RHS.isNegative())
 574       return -(this->udiv(-RHS));
 575     return this->udiv(RHS);
 576   }
 577
 578   /// Perform an unsigned remainder operation on this APInt with RHS being the
 579   /// divisor. Both this and RHS are treated as unsigned quantities for purposes
 580   /// of this operation. Note that this is a true remainder operation and not
 581   /// a modulo operation because the sign follows the sign of the dividend
 582   /// which is *this.
 583   /// @returns a new APInt value containing the remainder result
 584   /// @brief Unsigned remainder operation.
 585   APInt urem(const APInt& RHS) const;
 586
 587   /// Signed remainder operation on APInt.
 588   /// @brief Function for signed remainder operation.
 589   inline APInt srem(const APInt& RHS) const {
 590     if (isNegative())
 591       if (RHS.isNegative())
 592         return -((-(*this)).urem(-RHS));
 593       else
 594         return -((-(*this)).urem(RHS));
 595     else if (RHS.isNegative())
 596       return this->urem(-RHS);
 597     return this->urem(RHS);
 598   }
 599
 600   /// @returns the bit value at bitPosition
 601   /// @brief Array-indexing support.
 602   bool operator[](uint32_t bitPosition) const;
 603
 604   /// @}
 605   /// @name Comparison Operators
 606   /// @{
 607   /// Compares this APInt with RHS for the validity of the equality
 608   /// relationship.
 609   /// @brief Equality operator.
 610   bool operator==(const APInt& RHS) const;
 611
 612   /// Compares this APInt with a uint64_t for the validity of the equality
 613   /// relationship.
 614   /// @returns true if *this == Val
 615   /// @brief Equality operator.
 616   bool operator==(uint64_t Val) const;
 617
 618   /// Compares this APInt with RHS for the validity of the equality
 619   /// relationship.
 620   /// @returns true if *this == Val
 621   /// @brief Equality comparison.
 622   bool eq(const APInt &RHS) const {
 623     return (*this) == RHS;
 624   }
 625
 626   /// Compares this APInt with RHS for the validity of the inequality
 627   /// relationship.
 628   /// @returns true if *this != Val
 629   /// @brief Inequality operator.
 630   inline bool operator!=(const APInt& RHS) const {
 631     return !((*this) == RHS);
 632   }
 633
 634   /// Compares this APInt with a uint64_t for the validity of the inequality
 635   /// relationship.
 636   /// @returns true if *this != Val
 637   /// @brief Inequality operator.
 638   inline bool operator!=(uint64_t Val) const {
 639     return !((*this) == Val);
 640   }
 641
 642   /// Compares this APInt with RHS for the validity of the inequality
 643   /// relationship.
 644   /// @returns true if *this != Val
 645   /// @brief Inequality comparison
 646   bool ne(const APInt &RHS) const {
 647     return !((*this) == RHS);
 648   }
 649
 650   /// Regards both *this and RHS as unsigned quantities and compares them for
 651   /// the validity of the less-than relationship.
 652   /// @returns true if *this < RHS when both are considered unsigned.
 653   /// @brief Unsigned less than comparison
 654   bool ult(const APInt& RHS) const;
 655
 656   /// Regards both *this and RHS as signed quantities and compares them for
 657   /// validity of the less-than relationship.
 658   /// @returns true if *this < RHS when both are considered signed.
 659   /// @brief Signed less than comparison
 660   bool slt(const APInt& RHS) const;
 661
 662   /// Regards both *this and RHS as unsigned quantities and compares them for
 663   /// validity of the less-or-equal relationship.
 664   /// @returns true if *this <= RHS when both are considered unsigned.
 665   /// @brief Unsigned less or equal comparison
 666   bool ule(const APInt& RHS) const {
 667     return ult(RHS) || eq(RHS);
 668   }
 669
 670   /// Regards both *this and RHS as signed quantities and compares them for
 671   /// validity of the less-or-equal relationship.
 672   /// @returns true if *this <= RHS when both are considered signed.
 673   /// @brief Signed less or equal comparison
 674   bool sle(const APInt& RHS) const {
 675     return slt(RHS) || eq(RHS);
 676   }
 677
 678   /// Regards both *this and RHS as unsigned quantities and compares them for
 679   /// the validity of the greater-than relationship.
 680   /// @returns true if *this > RHS when both are considered unsigned.
 681   /// @brief Unsigned greather than comparison
 682   bool ugt(const APInt& RHS) const {
 683     return !ult(RHS) && !eq(RHS);
 684   }
 685
 686   /// Regards both *this and RHS as signed quantities and compares them for
 687   /// the validity of the greater-than relationship.
 688   /// @returns true if *this > RHS when both are considered signed.
 689   /// @brief Signed greather than comparison
 690   bool sgt(const APInt& RHS) const {
 691     return !slt(RHS) && !eq(RHS);
 692   }
 693
 694   /// Regards both *this and RHS as unsigned quantities and compares them for
 695   /// validity of the greater-or-equal relationship.
 696   /// @returns true if *this >= RHS when both are considered unsigned.
 697   /// @brief Unsigned greater or equal comparison
 698   bool uge(const APInt& RHS) const {
 699     return !ult(RHS);
 700   }
 701
 702   /// Regards both *this and RHS as signed quantities and compares them for
 703   /// validity of the greater-or-equal relationship.
 704   /// @returns true if *this >= RHS when both are considered signed.
 705   /// @brief Signed greather or equal comparison
 706   bool sge(const APInt& RHS) const {
 707     return !slt(RHS);
 708   }
 709
 710   /// @}
 711   /// @name Resizing Operators
 712   /// @{
 713   /// Truncate the APInt to a specified width. It is an error to specify a width
 714   /// that is greater than or equal to the current width.
 715   /// @brief Truncate to new width.
 716   APInt &trunc(uint32_t width);
 717
 718   /// This operation sign extends the APInt to a new width. If the high order
 719   /// bit is set, the fill on the left will be done with 1 bits, otherwise zero.
 720   /// It is an error to specify a width that is less than or equal to the
 721   /// current width.
 722   /// @brief Sign extend to a new width.
 723   APInt &sext(uint32_t width);
 724
 725   /// This operation zero extends the APInt to a new width. Thie high order bits
 726   /// are filled with 0 bits.  It is an error to specify a width that is less
 727   /// than or equal to the current width.
 728   /// @brief Zero extend to a new width.
 729   APInt &zext(uint32_t width);
 730
 731   /// Make this APInt have the bit width given by \p width. The value is sign
 732   /// extended, truncated, or left alone to make it that width.
 733   /// @brief Sign extend or truncate to width
 734   APInt &sextOrTrunc(uint32_t width);
 735
 736   /// Make this APInt have the bit width given by \p width. The value is zero
 737   /// extended, truncated, or left alone to make it that width.
 738   /// @brief Zero extend or truncate to width
 739   APInt &zextOrTrunc(uint32_t width);
 740
 741   /// This is a help function for convenience. If the given \p width equals to
 742   /// this APInt's BitWidth, just return this APInt, otherwise, just zero
 743   /// extend it.
 744   inline APInt &zextOrCopy(uint32_t width) {
 745     if (width == BitWidth)
 746       return *this;
 747     return zext(width);
 748   }
 749
 750   /// @}
 751   /// @name Bit Manipulation Operators
 752   /// @{
 753   /// @brief Set every bit to 1.
 754   APInt& set();
 755
 756   /// Set the given bit to 1 whose position is given as "bitPosition".
 757   /// @brief Set a given bit to 1.
 758   APInt& set(uint32_t bitPosition);
 759
 760   /// @brief Set every bit to 0.
 761   APInt& clear();
 762
 763   /// Set the given bit to 0 whose position is given as "bitPosition".
 764   /// @brief Set a given bit to 0.
 765   APInt& clear(uint32_t bitPosition);
 766
 767   /// @brief Toggle every bit to its opposite value.
 768   APInt& flip();
 769
 770   /// Toggle a given bit to its opposite value whose position is given
 771   /// as "bitPosition".
 772   /// @brief Toggles a given bit to its opposite value.
 773   APInt& flip(uint32_t bitPosition);
 774
 775   /// @}
 776   /// @name Value Characterization Functions
 777   /// @{
 778
 779   /// @returns the total number of bits.
 780   inline uint32_t getBitWidth() const {
 781     return BitWidth;
 782   }
 783
 784   /// Here one word's bitwidth equals to that of uint64_t.
 785   /// @returns the number of words to hold the integer value of this APInt.
 786   /// @brief Get the number of words.
 787   inline uint32_t getNumWords() const {
 788     return (BitWidth + APINT_BITS_PER_WORD - 1) / APINT_BITS_PER_WORD;
 789   }
 790
 791   /// This function returns the number of active bits which is defined as the
 792   /// bit width minus the number of leading zeros. This is used in several
 793   /// computations to see how "wide" the value is.
 794   /// @brief Compute the number of active bits in the value
 795   inline uint32_t getActiveBits() const {
 796     return BitWidth - countLeadingZeros();
 797   }
 798
 799   /// This function returns the number of active words in the value of this
 800   /// APInt. This is used in conjunction with getActiveData to extract the raw
 801   /// value of the APInt.
 802   inline uint32_t getActiveWords() const {
 803     return whichWord(getActiveBits()-1) + 1;
 804   }
 805
 806   /// Computes the minimum bit width for this APInt while considering it to be
 807   /// a signed (and probably negative) value. If the value is not negative,
 808   /// this function returns the same value as getActiveBits(). Otherwise, it
 809   /// returns the smallest bit width that will retain the negative value. For
 810   /// example, -1 can be written as 0b1 or 0xFFFFFFFFFF. 0b1 is shorter and so
 811   /// for -1, this function will always return 1.
 812   /// @brief Get the minimum bit size for this signed APInt
 813   inline uint32_t getMinSignedBits() const {
 814     if (isNegative())
 815       return BitWidth - countLeadingOnes() + 1;
 816     return getActiveBits();
 817   }
 818
 819   /// This method attempts to return the value of this APInt as a zero extended
 820   /// uint64_t. The bitwidth must be <= 64 or the value must fit within a
 821   /// uint64_t. Otherwise an assertion will result.
 822   /// @brief Get zero extended value
 823   inline uint64_t getZExtValue() const {
 824     if (isSingleWord())
 825       return VAL;
 826     assert(getActiveBits() <= 64 && "Too many bits for uint64_t");
 827     return pVal[0];
 828   }
 829
 830   /// This method attempts to return the value of this APInt as a sign extended
 831   /// int64_t. The bit width must be <= 64 or the value must fit within an
 832   /// int64_t. Otherwise an assertion will result.
 833   /// @brief Get sign extended value
 834   inline int64_t getSExtValue() const {
 835     if (isSingleWord())
 836       return int64_t(VAL << (APINT_BITS_PER_WORD - BitWidth)) >>
 837                      (APINT_BITS_PER_WORD - BitWidth);
 838     assert(getActiveBits() <= 64 && "Too many bits for int64_t");
 839     return int64_t(pVal[0]);
 840   }
 841   /// countLeadingZeros - This function is an APInt version of the
 842   /// countLeadingZeros_{32,64} functions in MathExtras.h. It counts the number
 843   /// of zeros from the most significant bit to the first one bit.
 844   /// @returns getNumWords() * APINT_BITS_PER_WORD if the value is zero.
 845   /// @returns the number of zeros from the most significant bit to the first
 846   /// one bits.
 847   /// @brief Count the number of leading one bits.
 848   uint32_t countLeadingZeros() const;
 849
 850   /// countLeadingOnes - This function counts the number of contiguous 1 bits
 851   /// in the high order bits. The count stops when the first 0 bit is reached.
 852   /// @returns 0 if the high order bit is not set
 853   /// @returns the number of 1 bits from the most significant to the least
 854   /// @brief Count the number of leading one bits.
 855   uint32_t countLeadingOnes() const;
 856
 857   /// countTrailingZeros - This function is an APInt version of the
 858   /// countTrailingZoers_{32,64} functions in MathExtras.h. It counts
 859   /// the number of zeros from the least significant bit to the first one bit.
 860   /// @returns getNumWords() * APINT_BITS_PER_WORD if the value is zero.
 861   /// @returns the number of zeros from the least significant bit to the first
 862   /// one bit.
 863   /// @brief Count the number of trailing zero bits.
 864   uint32_t countTrailingZeros() const;
 865
 866   /// countPopulation - This function is an APInt version of the
 867   /// countPopulation_{32,64} functions in MathExtras.h. It counts the number
 868   /// of 1 bits in the APInt value.
 869   /// @returns 0 if the value is zero.
 870   /// @returns the number of set bits.
 871   /// @brief Count the number of bits set.
 872   uint32_t countPopulation() const;
 873
 874   /// @}
 875   /// @name Conversion Functions
 876   /// @{
 877
 878   /// This is used internally to convert an APInt to a string.
 879   /// @brief Converts an APInt to a std::string
 880   std::string toString(uint8_t radix, bool wantSigned) const;
 881
 882   /// Considers the APInt to be unsigned and converts it into a string in the
 883   /// radix given. The radix can be 2, 8, 10 or 16.
 884   /// @returns a character interpretation of the APInt
 885   /// @brief Convert unsigned APInt to string representation.
 886   inline std::string toString(uint8_t radix = 10) const {
 887     return toString(radix, false);
 888   }
 889
 890   /// Considers the APInt to be unsigned and converts it into a string in the
 891   /// radix given. The radix can be 2, 8, 10 or 16.
 892   /// @returns a character interpretation of the APInt
 893   /// @brief Convert unsigned APInt to string representation.
 894   inline std::string toStringSigned(uint8_t radix = 10) const {
 895     return toString(radix, true);
 896   }
 897
 898   /// @returns a byte-swapped representation of this APInt Value.
 899   APInt byteSwap() const;
 900
 901   /// @brief Converts this APInt to a double value.
 902   double roundToDouble(bool isSigned) const;
 903
 904   /// @brief Converts this unsigned APInt to a double value.
 905   double roundToDouble() const {
 906     return roundToDouble(false);
 907   }
 908
 909   /// @brief Converts this signed APInt to a double value.
 910   double signedRoundToDouble() const {
 911     return roundToDouble(true);
 912   }
 913
 914   /// The conversion does not do a translation from integer to double, it just
 915   /// re-interprets the bits as a double. Note that it is valid to do this on
 916   /// any bit width. Exactly 64 bits will be translated.
 917   /// @brief Converts APInt bits to a double
 918   double bitsToDouble() const {
 919     union {
 920       uint64_t I;
 921       double D;
 922     } T;
 923     T.I = (isSingleWord() ? VAL : pVal[0]);
 924     return T.D;
 925   }
 926
 927   /// The conversion does not do a translation from integer to float, it just
 928   /// re-interprets the bits as a float. Note that it is valid to do this on
 929   /// any bit width. Exactly 32 bits will be translated.
 930   /// @brief Converts APInt bits to a double
 931   float bitsToFloat() const {
 932     union {
 933       uint32_t I;
 934       float F;
 935     } T;
 936     T.I = uint32_t((isSingleWord() ? VAL : pVal[0]));
 937     return T.F;
 938   }
 939
 940   /// The conversion does not do a translation from double to integer, it just
 941   /// re-interprets the bits of the double. Note that it is valid to do this on
 942   /// any bit width but bits from V may get truncated.
 943   /// @brief Converts a double to APInt bits.
 944   APInt& doubleToBits(double V) {
 945     union {
 946       uint64_t I;
 947       double D;
 948     } T;
 949     T.D = V;
 950     if (isSingleWord())
 951       VAL = T.I;
 952     else
 953       pVal[0] = T.I;
 954     return clearUnusedBits();
 955   }
 956
 957   /// The conversion does not do a translation from float to integer, it just
 958   /// re-interprets the bits of the float. Note that it is valid to do this on
 959   /// any bit width but bits from V may get truncated.
 960   /// @brief Converts a float to APInt bits.
 961   APInt& floatToBits(float V) {
 962     union {
 963       uint32_t I;
 964       float F;
 965     } T;
 966     T.F = V;
 967     if (isSingleWord())
 968       VAL = T.I;
 969     else
 970       pVal[0] = T.I;
 971     return clearUnusedBits();
 972   }
 973
 974   /// @}
 975   /// @name Mathematics Operations
 976   /// @{
 977
 978   /// @returns the floor log base 2 of this APInt.
 979   inline uint32_t logBase2() const {
 980     return BitWidth - 1 - countLeadingZeros();
 981   }
 982
 983   /// @brief Compute the square root
 984   APInt sqrt() const;
 985
 986   /// If *this is < 0 then return -(*this), otherwise *this;
 987   /// @brief Get the absolute value;
 988   APInt abs() const {
 989     if (isNegative())
 990       return -(*this);
 991     return *this;
 992   }
 993   /// @}
 994 };
 995
 996 inline bool operator==(uint64_t V1, const APInt& V2) {
 997   return V2 == V1;
 998 }
 999
1000 inline bool operator!=(uint64_t V1, const APInt& V2) {
1001   return V2 != V1;
1002 }
1003
1004 namespace APIntOps {
1005
1006 /// @brief Determine the smaller of two APInts considered to be signed.
1007 inline APInt smin(const APInt &A, const APInt &B) {
1008   return A.slt(B) ? A : B;
1009 }
1010
1011 /// @brief Determine the larger of two APInts considered to be signed.
1012 inline APInt smax(const APInt &A, const APInt &B) {
1013   return A.sgt(B) ? A : B;
1014 }
1015
1016 /// @brief Determine the smaller of two APInts considered to be signed.
1017 inline APInt umin(const APInt &A, const APInt &B) {
1018   return A.ult(B) ? A : B;
1019 }
1020
1021 /// @brief Determine the larger of two APInts considered to be unsigned.
1022 inline APInt umax(const APInt &A, const APInt &B) {
1023   return A.ugt(B) ? A : B;
1024 }
1025
1026 /// @brief Check if the specified APInt has a N-bits integer value.
1027 inline bool isIntN(uint32_t N, const APInt& APIVal) {
1028   return APIVal.isIntN(N);
1029 }
1030
1031 /// @returns true if the argument APInt value is a sequence of ones
1032 /// starting at the least significant bit with the remainder zero.
1033 inline const bool isMask(uint32_t numBits, const APInt& APIVal) {
1034   return APIVal.getBoolValue() && ((APIVal + APInt(numBits,1)) & APIVal) == 0;
1035 }
1036
1037 /// @returns true if the argument APInt value contains a sequence of ones
1038 /// with the remainder zero.
1039 inline const bool isShiftedMask(uint32_t numBits, const APInt& APIVal) {
1040   return isMask(numBits, (APIVal - APInt(numBits,1)) | APIVal);
1041 }
1042
1043 /// @returns a byte-swapped representation of the specified APInt Value.
1044 inline APInt byteSwap(const APInt& APIVal) {
1045   return APIVal.byteSwap();
1046 }
1047
1048 /// @returns the floor log base 2 of the specified APInt value.
1049 inline uint32_t logBase2(const APInt& APIVal) {
1050   return APIVal.logBase2();
1051 }
1052
1053 /// GreatestCommonDivisor - This function returns the greatest common
1054 /// divisor of the two APInt values using Enclid's algorithm.
1055 /// @returns the greatest common divisor of Val1 and Val2
1056 /// @brief Compute GCD of two APInt values.
1057 APInt GreatestCommonDivisor(const APInt& Val1, const APInt& Val2);
1058
1059 /// Treats the APInt as an unsigned value for conversion purposes.
1060 /// @brief Converts the given APInt to a double value.
1061 inline double RoundAPIntToDouble(const APInt& APIVal) {
1062   return APIVal.roundToDouble();
1063 }
1064
1065 /// Treats the APInt as a signed value for conversion purposes.
1066 /// @brief Converts the given APInt to a double value.
1067 inline double RoundSignedAPIntToDouble(const APInt& APIVal) {
1068   return APIVal.signedRoundToDouble();
1069 }
1070
1071 /// @brief Converts the given APInt to a float vlalue.
1072 inline float RoundAPIntToFloat(const APInt& APIVal) {
1073   return float(RoundAPIntToDouble(APIVal));
1074 }
1075
1076 /// Treast the APInt as a signed value for conversion purposes.
1077 /// @brief Converts the given APInt to a float value.
1078 inline float RoundSignedAPIntToFloat(const APInt& APIVal) {
1079   return float(APIVal.signedRoundToDouble());
1080 }
1081
1082 /// RoundDoubleToAPInt - This function convert a double value to an APInt value.
1083 /// @brief Converts the given double value into a APInt.
1084 APInt RoundDoubleToAPInt(double Double, uint32_t width);
1085
1086 /// RoundFloatToAPInt - Converts a float value into an APInt value.
1087 /// @brief Converts a float value into a APInt.
1088 inline APInt RoundFloatToAPInt(float Float, uint32_t width) {
1089   return RoundDoubleToAPInt(double(Float), width);
1090 }
1091
1092 /// Arithmetic right-shift the APInt by shiftAmt.
1093 /// @brief Arithmetic right-shift function.
1094 inline APInt ashr(const APInt& LHS, uint32_t shiftAmt) {
1095   return LHS.ashr(shiftAmt);
1096 }
1097
1098 /// Logical right-shift the APInt by shiftAmt.
1099 /// @brief Logical right-shift function.
1100 inline APInt lshr(const APInt& LHS, uint32_t shiftAmt) {
1101   return LHS.lshr(shiftAmt);
1102 }
1103
1104 /// Left-shift the APInt by shiftAmt.
1105 /// @brief Left-shift function.
1106 inline APInt shl(const APInt& LHS, uint32_t shiftAmt) {
1107   return LHS.shl(shiftAmt);
1108 }
1109
1110 /// Signed divide APInt LHS by APInt RHS.
1111 /// @brief Signed division function for APInt.
1112 inline APInt sdiv(const APInt& LHS, const APInt& RHS) {
1113   return LHS.sdiv(RHS);
1114 }
1115
1116 /// Unsigned divide APInt LHS by APInt RHS.
1117 /// @brief Unsigned division function for APInt.
1118 inline APInt udiv(const APInt& LHS, const APInt& RHS) {
1119   return LHS.udiv(RHS);
1120 }
1121
1122 /// Signed remainder operation on APInt.
1123 /// @brief Function for signed remainder operation.
1124 inline APInt srem(const APInt& LHS, const APInt& RHS) {
1125   return LHS.srem(RHS);
1126 }
1127
1128 /// Unsigned remainder operation on APInt.
1129 /// @brief Function for unsigned remainder operation.
1130 inline APInt urem(const APInt& LHS, const APInt& RHS) {
1131   return LHS.urem(RHS);
1132 }
1133
1134 /// Performs multiplication on APInt values.
1135 /// @brief Function for multiplication operation.
1136 inline APInt mul(const APInt& LHS, const APInt& RHS) {
1137   return LHS * RHS;
1138 }
1139
1140 /// Performs addition on APInt values.
1141 /// @brief Function for addition operation.
1142 inline APInt add(const APInt& LHS, const APInt& RHS) {
1143   return LHS + RHS;
1144 }
1145
1146 /// Performs subtraction on APInt values.
1147 /// @brief Function for subtraction operation.
1148 inline APInt sub(const APInt& LHS, const APInt& RHS) {
1149   return LHS - RHS;
1150 }
1151
1152 /// Performs bitwise AND operation on APInt LHS and
1153 /// APInt RHS.
1154 /// @brief Bitwise AND function for APInt.
1155 inline APInt And(const APInt& LHS, const APInt& RHS) {
1156   return LHS & RHS;
1157 }
1158
1159 /// Performs bitwise OR operation on APInt LHS and APInt RHS.
1160 /// @brief Bitwise OR function for APInt.
1161 inline APInt Or(const APInt& LHS, const APInt& RHS) {
1162   return LHS | RHS;
1163 }
1164
1165 /// Performs bitwise XOR operation on APInt.
1166 /// @brief Bitwise XOR function for APInt.
1167 inline APInt Xor(const APInt& LHS, const APInt& RHS) {
1168   return LHS ^ RHS;
1169 }
1170
1171 /// Performs a bitwise complement operation on APInt.
1172 /// @brief Bitwise complement function.
1173 inline APInt Not(const APInt& APIVal) {
1174   return ~APIVal;
1175 }
1176
1177 } // End of APIntOps namespace
1178
1179 } // End of llvm namespace
1180
1181 #endif