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 hiBit the index of the highest bit set.
 340   /// @param loBit the index of the lowest 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 hiBit, uint32_t loBit = 0);
 344
 345   /// Constructs an APInt value that has the top hiBitsSet bits set.
 346   /// @param numBits the bitwidth of the result
 347   /// @param hiBitsSet the number of high-order bits set in the result.
 348   /// @brief Get a value with high bits set
 349   static APInt getHighBitsSet(uint32_t numBits, uint32_t hiBitsSet);
 350
 351   /// Constructs an APInt value that has the bottom loBitsSet bits set.
 352   /// @param numBits the bitwidth of the result
 353   /// @param loBitsSet the number of low-order bits set in the result.
 354   /// @brief Get a value with low bits set
 355   static APInt getLowBitsSet(uint32_t numBits, uint32_t loBitsSet);
 356
 357   /// The hash value is computed as the sum of the words and the bit width.
 358   /// @returns A hash value computed from the sum of the APInt words.
 359   /// @brief Get a hash value based on this APInt
 360   uint64_t getHashValue() const;
 361
 362   /// This function returns a pointer to the internal storage of the APInt.
 363   /// This is useful for writing out the APInt in binary form without any
 364   /// conversions.
 365   inline const uint64_t* getRawData() const {
 366     if (isSingleWord())
 367       return &VAL;
 368     return &pVal[0];
 369   }
 370
 371   /// @brief Set a sepcific word in the value to a new value.
 372   inline void setWordToValue(uint32_t idx, uint64_t Val) {
 373     assert(idx < getNumWords() && "Invalid word array index");
 374     if (isSingleWord())
 375       VAL = Val;
 376     else
 377       pVal[idx] = Val;
 378   }
 379
 380   /// @}
 381   /// @name Unary Operators
 382   /// @{
 383   /// @returns a new APInt value representing *this incremented by one
 384   /// @brief Postfix increment operator.
 385   inline const APInt operator++(int) {
 386     APInt API(*this);
 387     ++(*this);
 388     return API;
 389   }
 390
 391   /// @returns *this incremented by one
 392   /// @brief Prefix increment operator.
 393   APInt& operator++();
 394
 395   /// @returns a new APInt representing *this decremented by one.
 396   /// @brief Postfix decrement operator.
 397   inline const APInt operator--(int) {
 398     APInt API(*this);
 399     --(*this);
 400     return API;
 401   }
 402
 403   /// @returns *this decremented by one.
 404   /// @brief Prefix decrement operator.
 405   APInt& operator--();
 406
 407   /// Performs a bitwise complement operation on this APInt.
 408   /// @returns an APInt that is the bitwise complement of *this
 409   /// @brief Unary bitwise complement operator.
 410   APInt operator~() const;
 411
 412   /// Negates *this using two's complement logic.
 413   /// @returns An APInt value representing the negation of *this.
 414   /// @brief Unary negation operator
 415   inline APInt operator-() const {
 416     return APInt(BitWidth, 0) - (*this);
 417   }
 418
 419   /// Performs logical negation operation on this APInt.
 420   /// @returns true if *this is zero, false otherwise.
 421   /// @brief Logical negation operator.
 422   bool operator !() const;
 423
 424   /// @}
 425   /// @name Assignment Operators
 426   /// @{
 427   /// @returns *this after assignment of RHS.
 428   /// @brief Copy assignment operator.
 429   APInt& operator=(const APInt& RHS);
 430
 431   /// The RHS value is assigned to *this. If the significant bits in RHS exceed
 432   /// the bit width, the excess bits are truncated. If the bit width is larger
 433   /// than 64, the value is zero filled in the unspecified high order bits.
 434   /// @returns *this after assignment of RHS value.
 435   /// @brief Assignment operator.
 436   APInt& operator=(uint64_t RHS);
 437
 438   /// Performs a bitwise AND operation on this APInt and RHS. The result is
 439   /// assigned to *this.
 440   /// @returns *this after ANDing with RHS.
 441   /// @brief Bitwise AND assignment operator.
 442   APInt& operator&=(const APInt& RHS);
 443
 444   /// Performs a bitwise OR operation on this APInt and RHS. The result is
 445   /// assigned *this;
 446   /// @returns *this after ORing with RHS.
 447   /// @brief Bitwise OR assignment operator.
 448   APInt& operator|=(const APInt& RHS);
 449
 450   /// Performs a bitwise XOR operation on this APInt and RHS. The result is
 451   /// assigned to *this.
 452   /// @returns *this after XORing with RHS.
 453   /// @brief Bitwise XOR assignment operator.
 454   APInt& operator^=(const APInt& RHS);
 455
 456   /// Multiplies this APInt by RHS and assigns the result to *this.
 457   /// @returns *this
 458   /// @brief Multiplication assignment operator.
 459   APInt& operator*=(const APInt& RHS);
 460
 461   /// Adds RHS to *this and assigns the result to *this.
 462   /// @returns *this
 463   /// @brief Addition assignment operator.
 464   APInt& operator+=(const APInt& RHS);
 465
 466   /// Subtracts RHS from *this and assigns the result to *this.
 467   /// @returns *this
 468   /// @brief Subtraction assignment operator.
 469   APInt& operator-=(const APInt& RHS);
 470
 471   /// Shifts *this left by shiftAmt and assigns the result to *this.
 472   /// @returns *this after shifting left by shiftAmt
 473   /// @brief Left-shift assignment function.
 474   inline APInt& operator<<=(uint32_t shiftAmt) {
 475     *this = shl(shiftAmt);
 476     return *this;
 477   }
 478
 479   /// @}
 480   /// @name Binary Operators
 481   /// @{
 482   /// Performs a bitwise AND operation on *this and RHS.
 483   /// @returns An APInt value representing the bitwise AND of *this and RHS.
 484   /// @brief Bitwise AND operator.
 485   APInt operator&(const APInt& RHS) const;
 486   APInt And(const APInt& RHS) const {
 487     return this->operator&(RHS);
 488   }
 489
 490   /// Performs a bitwise OR operation on *this and RHS.
 491   /// @returns An APInt value representing the bitwise OR of *this and RHS.
 492   /// @brief Bitwise OR operator.
 493   APInt operator|(const APInt& RHS) const;
 494   APInt Or(const APInt& RHS) const {
 495     return this->operator|(RHS);
 496   }
 497
 498   /// Performs a bitwise XOR operation on *this and RHS.
 499   /// @returns An APInt value representing the bitwise XOR of *this and RHS.
 500   /// @brief Bitwise XOR operator.
 501   APInt operator^(const APInt& RHS) const;
 502   APInt Xor(const APInt& RHS) const {
 503     return this->operator^(RHS);
 504   }
 505
 506   /// Multiplies this APInt by RHS and returns the result.
 507   /// @brief Multiplication operator.
 508   APInt operator*(const APInt& RHS) const;
 509
 510   /// Adds RHS to this APInt and returns the result.
 511   /// @brief Addition operator.
 512   APInt operator+(const APInt& RHS) const;
 513   APInt operator+(uint64_t RHS) const {
 514     return (*this) + APInt(BitWidth, RHS);
 515   }
 516
 517   /// Subtracts RHS from this APInt and returns the result.
 518   /// @brief Subtraction operator.
 519   APInt operator-(const APInt& RHS) const;
 520   APInt operator-(uint64_t RHS) const {
 521     return (*this) - APInt(BitWidth, RHS);
 522   }
 523
 524   /// Arithmetic right-shift this APInt by shiftAmt.
 525   /// @brief Arithmetic right-shift function.
 526   APInt ashr(uint32_t shiftAmt) const;
 527
 528   /// Logical right-shift this APInt by shiftAmt.
 529   /// @brief Logical right-shift function.
 530   APInt lshr(uint32_t shiftAmt) const;
 531
 532   /// Left-shift this APInt by shiftAmt.
 533   /// @brief Left-shift function.
 534   APInt shl(uint32_t shiftAmt) const;
 535
 536   /// Perform an unsigned divide operation on this APInt by RHS. Both this and
 537   /// RHS are treated as unsigned quantities for purposes of this division.
 538   /// @returns a new APInt value containing the division result
 539   /// @brief Unsigned division operation.
 540   APInt udiv(const APInt& RHS) const;
 541
 542   /// Signed divide this APInt by APInt RHS.
 543   /// @brief Signed division function for APInt.
 544   inline APInt sdiv(const APInt& RHS) const {
 545     if (isNegative())
 546       if (RHS.isNegative())
 547         return (-(*this)).udiv(-RHS);
 548       else
 549         return -((-(*this)).udiv(RHS));
 550     else if (RHS.isNegative())
 551       return -(this->udiv(-RHS));
 552     return this->udiv(RHS);
 553   }
 554
 555   /// Perform an Unsigned remainder operation on this APInt with RHS being the
 556   /// divisor. Both this and RHS are treated as unsigned quantities for purposes
 557   /// of this operation.
 558   /// @returns a new APInt value containing the remainder result
 559   /// @brief Unsigned remainder operation.
 560   APInt urem(const APInt& RHS) const;
 561
 562   /// Signed remainder operation on APInt.
 563   /// @brief Function for signed remainder operation.
 564   inline APInt srem(const APInt& RHS) const {
 565     if (isNegative())
 566       if (RHS.isNegative())
 567         return (-(*this)).urem(-RHS);
 568       else
 569         return -((-(*this)).urem(RHS));
 570     else if (RHS.isNegative())
 571       return -(this->urem(-RHS));
 572     return this->urem(RHS);
 573   }
 574
 575   /// @returns the bit value at bitPosition
 576   /// @brief Array-indexing support.
 577   bool operator[](uint32_t bitPosition) const;
 578
 579   /// @}
 580   /// @name Comparison Operators
 581   /// @{
 582   /// Compares this APInt with RHS for the validity of the equality
 583   /// relationship.
 584   /// @brief Equality operator.
 585   bool operator==(const APInt& RHS) const;
 586
 587   /// Compares this APInt with a uint64_t for the validity of the equality
 588   /// relationship.
 589   /// @returns true if *this == Val
 590   /// @brief Equality operator.
 591   bool operator==(uint64_t Val) const;
 592
 593   /// Compares this APInt with RHS for the validity of the equality
 594   /// relationship.
 595   /// @returns true if *this == Val
 596   /// @brief Equality comparison.
 597   bool eq(const APInt &RHS) const {
 598     return (*this) == RHS;
 599   }
 600
 601   /// Compares this APInt with RHS for the validity of the inequality
 602   /// relationship.
 603   /// @returns true if *this != Val
 604   /// @brief Inequality operator.
 605   inline bool operator!=(const APInt& RHS) const {
 606     return !((*this) == RHS);
 607   }
 608
 609   /// Compares this APInt with a uint64_t for the validity of the inequality
 610   /// relationship.
 611   /// @returns true if *this != Val
 612   /// @brief Inequality operator.
 613   inline bool operator!=(uint64_t Val) const {
 614     return !((*this) == Val);
 615   }
 616
 617   /// Compares this APInt with RHS for the validity of the inequality
 618   /// relationship.
 619   /// @returns true if *this != Val
 620   /// @brief Inequality comparison
 621   bool ne(const APInt &RHS) const {
 622     return !((*this) == RHS);
 623   }
 624
 625   /// Regards both *this and RHS as unsigned quantities and compares them for
 626   /// the validity of the less-than relationship.
 627   /// @returns true if *this < RHS when both are considered unsigned.
 628   /// @brief Unsigned less than comparison
 629   bool ult(const APInt& RHS) const;
 630
 631   /// Regards both *this and RHS as signed quantities and compares them for
 632   /// validity of the less-than relationship.
 633   /// @returns true if *this < RHS when both are considered signed.
 634   /// @brief Signed less than comparison
 635   bool slt(const APInt& RHS) const;
 636
 637   /// Regards both *this and RHS as unsigned quantities and compares them for
 638   /// validity of the less-or-equal relationship.
 639   /// @returns true if *this <= RHS when both are considered unsigned.
 640   /// @brief Unsigned less or equal comparison
 641   bool ule(const APInt& RHS) const {
 642     return ult(RHS) || eq(RHS);
 643   }
 644
 645   /// Regards both *this and RHS as signed quantities and compares them for
 646   /// validity of the less-or-equal relationship.
 647   /// @returns true if *this <= RHS when both are considered signed.
 648   /// @brief Signed less or equal comparison
 649   bool sle(const APInt& RHS) const {
 650     return slt(RHS) || eq(RHS);
 651   }
 652
 653   /// Regards both *this and RHS as unsigned quantities and compares them for
 654   /// the validity of the greater-than relationship.
 655   /// @returns true if *this > RHS when both are considered unsigned.
 656   /// @brief Unsigned greather than comparison
 657   bool ugt(const APInt& RHS) const {
 658     return !ult(RHS) && !eq(RHS);
 659   }
 660
 661   /// Regards both *this and RHS as signed quantities and compares them for
 662   /// the validity of the greater-than relationship.
 663   /// @returns true if *this > RHS when both are considered signed.
 664   /// @brief Signed greather than comparison
 665   bool sgt(const APInt& RHS) const {
 666     return !slt(RHS) && !eq(RHS);
 667   }
 668
 669   /// Regards both *this and RHS as unsigned quantities and compares them for
 670   /// validity of the greater-or-equal relationship.
 671   /// @returns true if *this >= RHS when both are considered unsigned.
 672   /// @brief Unsigned greater or equal comparison
 673   bool uge(const APInt& RHS) const {
 674     return !ult(RHS);
 675   }
 676
 677   /// Regards both *this and RHS as signed quantities and compares them for
 678   /// validity of the greater-or-equal relationship.
 679   /// @returns true if *this >= RHS when both are considered signed.
 680   /// @brief Signed greather or equal comparison
 681   bool sge(const APInt& RHS) const {
 682     return !slt(RHS);
 683   }
 684
 685   /// @}
 686   /// @name Resizing Operators
 687   /// @{
 688   /// Truncate the APInt to a specified width. It is an error to specify a width
 689   /// that is greater than or equal to the current width.
 690   /// @brief Truncate to new width.
 691   APInt &trunc(uint32_t width);
 692
 693   /// This operation sign extends the APInt to a new width. If the high order
 694   /// bit is set, the fill on the left will be done with 1 bits, otherwise zero.
 695   /// It is an error to specify a width that is less than or equal to the
 696   /// current width.
 697   /// @brief Sign extend to a new width.
 698   APInt &sext(uint32_t width);
 699
 700   /// This operation zero extends the APInt to a new width. Thie high order bits
 701   /// are filled with 0 bits.  It is an error to specify a width that is less
 702   /// than or equal to the current width.
 703   /// @brief Zero extend to a new width.
 704   APInt &zext(uint32_t width);
 705
 706   /// Make this APInt have the bit width given by \p width. The value is sign
 707   /// extended, truncated, or left alone to make it that width.
 708   /// @brief Sign extend or truncate to width
 709   APInt &sextOrTrunc(uint32_t width);
 710
 711   /// Make this APInt have the bit width given by \p width. The value is zero
 712   /// extended, truncated, or left alone to make it that width.
 713   /// @brief Zero extend or truncate to width
 714   APInt &zextOrTrunc(uint32_t width);
 715
 716   /// This is a help function for convenience. If the given \p width equals to
 717   /// this APInt's BitWidth, just return this APInt, otherwise, just zero
 718   /// extend it.
 719   inline APInt &zextOrCopy(uint32_t width) {
 720     if (width == BitWidth)
 721       return *this;
 722     return zext(width);
 723   }
 724
 725   /// @}
 726   /// @name Bit Manipulation Operators
 727   /// @{
 728   /// @brief Set every bit to 1.
 729   APInt& set();
 730
 731   /// Set the given bit to 1 whose position is given as "bitPosition".
 732   /// @brief Set a given bit to 1.
 733   APInt& set(uint32_t bitPosition);
 734
 735   /// @brief Set every bit to 0.
 736   APInt& clear();
 737
 738   /// Set the given bit to 0 whose position is given as "bitPosition".
 739   /// @brief Set a given bit to 0.
 740   APInt& clear(uint32_t bitPosition);
 741
 742   /// @brief Toggle every bit to its opposite value.
 743   APInt& flip();
 744
 745   /// Toggle a given bit to its opposite value whose position is given
 746   /// as "bitPosition".
 747   /// @brief Toggles a given bit to its opposite value.
 748   APInt& flip(uint32_t bitPosition);
 749
 750   /// @}
 751   /// @name Value Characterization Functions
 752   /// @{
 753
 754   /// @returns the total number of bits.
 755   inline uint32_t getBitWidth() const {
 756     return BitWidth;
 757   }
 758
 759   /// Here one word's bitwidth equals to that of uint64_t.
 760   /// @returns the number of words to hold the integer value of this APInt.
 761   /// @brief Get the number of words.
 762   inline uint32_t getNumWords() const {
 763     return (BitWidth + APINT_BITS_PER_WORD - 1) / APINT_BITS_PER_WORD;
 764   }
 765
 766   /// This function returns the number of active bits which is defined as the
 767   /// bit width minus the number of leading zeros. This is used in several
 768   /// computations to see how "wide" the value is.
 769   /// @brief Compute the number of active bits in the value
 770   inline uint32_t getActiveBits() const {
 771     return BitWidth - countLeadingZeros();
 772   }
 773
 774   /// This function returns the number of active words in the value of this
 775   /// APInt. This is used in conjunction with getActiveData to extract the raw
 776   /// value of the APInt.
 777   inline uint32_t getActiveWords() const {
 778     return whichWord(getActiveBits()-1) + 1;
 779   }
 780
 781   /// Computes the minimum bit width for this APInt while considering it to be
 782   /// a signed (and probably negative) value. If the value is not negative,
 783   /// this function returns the same value as getActiveBits(). Otherwise, it
 784   /// returns the smallest bit width that will retain the negative value. For
 785   /// example, -1 can be written as 0b1 or 0xFFFFFFFFFF. 0b1 is shorter and so
 786   /// for -1, this function will always return 1.
 787   /// @brief Get the minimum bit size for this signed APInt
 788   inline uint32_t getMinSignedBits() const {
 789     if (isNegative())
 790       return BitWidth - countLeadingOnes() + 1;
 791     return getActiveBits();
 792   }
 793
 794   /// This method attempts to return the value of this APInt as a zero extended
 795   /// uint64_t. The bitwidth must be <= 64 or the value must fit within a
 796   /// uint64_t. Otherwise an assertion will result.
 797   /// @brief Get zero extended value
 798   inline uint64_t getZExtValue() const {
 799     if (isSingleWord())
 800       return VAL;
 801     assert(getActiveBits() <= 64 && "Too many bits for uint64_t");
 802     return pVal[0];
 803   }
 804
 805   /// This method attempts to return the value of this APInt as a sign extended
 806   /// int64_t. The bit width must be <= 64 or the value must fit within an
 807   /// int64_t. Otherwise an assertion will result.
 808   /// @brief Get sign extended value
 809   inline int64_t getSExtValue() const {
 810     if (isSingleWord())
 811       return int64_t(VAL << (APINT_BITS_PER_WORD - BitWidth)) >>
 812                      (APINT_BITS_PER_WORD - BitWidth);
 813     assert(getActiveBits() <= 64 && "Too many bits for int64_t");
 814     return int64_t(pVal[0]);
 815   }
 816   /// countLeadingZeros - This function is an APInt version of the
 817   /// countLeadingZeros_{32,64} functions in MathExtras.h. It counts the number
 818   /// of zeros from the most significant bit to the first one bit.
 819   /// @returns getNumWords() * APINT_BITS_PER_WORD if the value is zero.
 820   /// @returns the number of zeros from the most significant bit to the first
 821   /// one bits.
 822   /// @brief Count the number of leading one bits.
 823   uint32_t countLeadingZeros() const;
 824
 825   /// countLeadingOnes - This function counts the number of contiguous 1 bits
 826   /// in the high order bits. The count stops when the first 0 bit is reached.
 827   /// @returns 0 if the high order bit is not set
 828   /// @returns the number of 1 bits from the most significant to the least
 829   /// @brief Count the number of leading one bits.
 830   uint32_t countLeadingOnes() const;
 831
 832   /// countTrailingZeros - This function is an APInt version of the
 833   /// countTrailingZoers_{32,64} functions in MathExtras.h. It counts
 834   /// the number of zeros from the least significant bit to the first one bit.
 835   /// @returns getNumWords() * APINT_BITS_PER_WORD if the value is zero.
 836   /// @returns the number of zeros from the least significant bit to the first
 837   /// one bit.
 838   /// @brief Count the number of trailing zero bits.
 839   uint32_t countTrailingZeros() const;
 840
 841   /// countPopulation - This function is an APInt version of the
 842   /// countPopulation_{32,64} functions in MathExtras.h. It counts the number
 843   /// of 1 bits in the APInt value.
 844   /// @returns 0 if the value is zero.
 845   /// @returns the number of set bits.
 846   /// @brief Count the number of bits set.
 847   uint32_t countPopulation() const;
 848
 849   /// @}
 850   /// @name Conversion Functions
 851   /// @{
 852
 853   /// This is used internally to convert an APInt to a string.
 854   /// @brief Converts an APInt to a std::string
 855   std::string toString(uint8_t radix, bool wantSigned) const;
 856
 857   /// Considers the APInt to be unsigned and converts it into a string in the
 858   /// radix given. The radix can be 2, 8, 10 or 16.
 859   /// @returns a character interpretation of the APInt
 860   /// @brief Convert unsigned APInt to string representation.
 861   inline std::string toString(uint8_t radix = 10) const {
 862     return toString(radix, false);
 863   }
 864
 865   /// Considers the APInt to be unsigned and converts it into a string in the
 866   /// radix given. The radix can be 2, 8, 10 or 16.
 867   /// @returns a character interpretation of the APInt
 868   /// @brief Convert unsigned APInt to string representation.
 869   inline std::string toStringSigned(uint8_t radix = 10) const {
 870     return toString(radix, true);
 871   }
 872
 873   /// @returns a byte-swapped representation of this APInt Value.
 874   APInt byteSwap() const;
 875
 876   /// @brief Converts this APInt to a double value.
 877   double roundToDouble(bool isSigned) const;
 878
 879   /// @brief Converts this unsigned APInt to a double value.
 880   double roundToDouble() const {
 881     return roundToDouble(false);
 882   }
 883
 884   /// @brief Converts this signed APInt to a double value.
 885   double signedRoundToDouble() const {
 886     return roundToDouble(true);
 887   }
 888
 889   /// The conversion does not do a translation from integer to double, it just
 890   /// re-interprets the bits as a double. Note that it is valid to do this on
 891   /// any bit width. Exactly 64 bits will be translated.
 892   /// @brief Converts APInt bits to a double
 893   double bitsToDouble() const {
 894     union {
 895       uint64_t I;
 896       double D;
 897     } T;
 898     T.I = (isSingleWord() ? VAL : pVal[0]);
 899     return T.D;
 900   }
 901
 902   /// The conversion does not do a translation from integer to float, it just
 903   /// re-interprets the bits as a float. Note that it is valid to do this on
 904   /// any bit width. Exactly 32 bits will be translated.
 905   /// @brief Converts APInt bits to a double
 906   float bitsToFloat() const {
 907     union {
 908       uint32_t I;
 909       float F;
 910     } T;
 911     T.I = uint32_t((isSingleWord() ? VAL : pVal[0]));
 912     return T.F;
 913   }
 914
 915   /// The conversion does not do a translation from double to integer, it just
 916   /// re-interprets the bits of the double. Note that it is valid to do this on
 917   /// any bit width but bits from V may get truncated.
 918   /// @brief Converts a double to APInt bits.
 919   APInt& doubleToBits(double V) {
 920     union {
 921       uint64_t I;
 922       double D;
 923     } T;
 924     T.D = V;
 925     if (isSingleWord())
 926       VAL = T.I;
 927     else
 928       pVal[0] = T.I;
 929     return clearUnusedBits();
 930   }
 931
 932   /// The conversion does not do a translation from float to integer, it just
 933   /// re-interprets the bits of the float. Note that it is valid to do this on
 934   /// any bit width but bits from V may get truncated.
 935   /// @brief Converts a float to APInt bits.
 936   APInt& floatToBits(float V) {
 937     union {
 938       uint32_t I;
 939       float F;
 940     } T;
 941     T.F = V;
 942     if (isSingleWord())
 943       VAL = T.I;
 944     else
 945       pVal[0] = T.I;
 946     return clearUnusedBits();
 947   }
 948
 949   /// @}
 950   /// @name Mathematics Operations
 951   /// @{
 952
 953   /// @returns the floor log base 2 of this APInt.
 954   inline uint32_t logBase2() const {
 955     return BitWidth - 1 - countLeadingZeros();
 956   }
 957
 958   /// @brief Compute the square root
 959   APInt sqrt() const;
 960
 961   /// If *this is < 0 then return -(*this), otherwise *this;
 962   /// @brief Get the absolute value;
 963   APInt abs() const {
 964     if (isNegative())
 965       return -(*this);
 966     return *this;
 967   }
 968   /// @}
 969 };
 970
 971 inline bool operator==(uint64_t V1, const APInt& V2) {
 972   return V2 == V1;
 973 }
 974
 975 inline bool operator!=(uint64_t V1, const APInt& V2) {
 976   return V2 != V1;
 977 }
 978
 979 namespace APIntOps {
 980
 981 /// @brief Determine the smaller of two APInts considered to be signed.
 982 inline APInt smin(const APInt &A, const APInt &B) {
 983   return A.slt(B) ? A : B;
 984 }
 985
 986 /// @brief Determine the larger of two APInts considered to be signed.
 987 inline APInt smax(const APInt &A, const APInt &B) {
 988   return A.sgt(B) ? A : B;
 989 }
 990
 991 /// @brief Determine the smaller of two APInts considered to be signed.
 992 inline APInt umin(const APInt &A, const APInt &B) {
 993   return A.ult(B) ? A : B;
 994 }
 995
 996 /// @brief Determine the larger of two APInts considered to be unsigned.
 997 inline APInt umax(const APInt &A, const APInt &B) {
 998   return A.ugt(B) ? A : B;
 999 }
1000
1001 /// @brief Check if the specified APInt has a N-bits integer value.
1002 inline bool isIntN(uint32_t N, const APInt& APIVal) {
1003   return APIVal.isIntN(N);
1004 }
1005
1006 /// @returns true if the argument APInt value is a sequence of ones
1007 /// starting at the least significant bit with the remainder zero.
1008 inline const bool isMask(uint32_t numBits, const APInt& APIVal) {
1009   return APIVal.getBoolValue() && ((APIVal + APInt(numBits,1)) & APIVal) == 0;
1010 }
1011
1012 /// @returns true if the argument APInt value contains a sequence of ones
1013 /// with the remainder zero.
1014 inline const bool isShiftedMask(uint32_t numBits, const APInt& APIVal) {
1015   return isMask(numBits, (APIVal - APInt(numBits,1)) | APIVal);
1016 }
1017
1018 /// @returns a byte-swapped representation of the specified APInt Value.
1019 inline APInt byteSwap(const APInt& APIVal) {
1020   return APIVal.byteSwap();
1021 }
1022
1023 /// @returns the floor log base 2 of the specified APInt value.
1024 inline uint32_t logBase2(const APInt& APIVal) {
1025   return APIVal.logBase2();
1026 }
1027
1028 /// GreatestCommonDivisor - This function returns the greatest common
1029 /// divisor of the two APInt values using Enclid's algorithm.
1030 /// @returns the greatest common divisor of Val1 and Val2
1031 /// @brief Compute GCD of two APInt values.
1032 APInt GreatestCommonDivisor(const APInt& Val1, const APInt& Val2);
1033
1034 /// Treats the APInt as an unsigned value for conversion purposes.
1035 /// @brief Converts the given APInt to a double value.
1036 inline double RoundAPIntToDouble(const APInt& APIVal) {
1037   return APIVal.roundToDouble();
1038 }
1039
1040 /// Treats the APInt as a signed value for conversion purposes.
1041 /// @brief Converts the given APInt to a double value.
1042 inline double RoundSignedAPIntToDouble(const APInt& APIVal) {
1043   return APIVal.signedRoundToDouble();
1044 }
1045
1046 /// @brief Converts the given APInt to a float vlalue.
1047 inline float RoundAPIntToFloat(const APInt& APIVal) {
1048   return float(RoundAPIntToDouble(APIVal));
1049 }
1050
1051 /// Treast the APInt as a signed value for conversion purposes.
1052 /// @brief Converts the given APInt to a float value.
1053 inline float RoundSignedAPIntToFloat(const APInt& APIVal) {
1054   return float(APIVal.signedRoundToDouble());
1055 }
1056
1057 /// RoundDoubleToAPInt - This function convert a double value to an APInt value.
1058 /// @brief Converts the given double value into a APInt.
1059 APInt RoundDoubleToAPInt(double Double, uint32_t width);
1060
1061 /// RoundFloatToAPInt - Converts a float value into an APInt value.
1062 /// @brief Converts a float value into a APInt.
1063 inline APInt RoundFloatToAPInt(float Float, uint32_t width) {
1064   return RoundDoubleToAPInt(double(Float), width);
1065 }
1066
1067 /// Arithmetic right-shift the APInt by shiftAmt.
1068 /// @brief Arithmetic right-shift function.
1069 inline APInt ashr(const APInt& LHS, uint32_t shiftAmt) {
1070   return LHS.ashr(shiftAmt);
1071 }
1072
1073 /// Logical right-shift the APInt by shiftAmt.
1074 /// @brief Logical right-shift function.
1075 inline APInt lshr(const APInt& LHS, uint32_t shiftAmt) {
1076   return LHS.lshr(shiftAmt);
1077 }
1078
1079 /// Left-shift the APInt by shiftAmt.
1080 /// @brief Left-shift function.
1081 inline APInt shl(const APInt& LHS, uint32_t shiftAmt) {
1082   return LHS.shl(shiftAmt);
1083 }
1084
1085 /// Signed divide APInt LHS by APInt RHS.
1086 /// @brief Signed division function for APInt.
1087 inline APInt sdiv(const APInt& LHS, const APInt& RHS) {
1088   return LHS.sdiv(RHS);
1089 }
1090
1091 /// Unsigned divide APInt LHS by APInt RHS.
1092 /// @brief Unsigned division function for APInt.
1093 inline APInt udiv(const APInt& LHS, const APInt& RHS) {
1094   return LHS.udiv(RHS);
1095 }
1096
1097 /// Signed remainder operation on APInt.
1098 /// @brief Function for signed remainder operation.
1099 inline APInt srem(const APInt& LHS, const APInt& RHS) {
1100   return LHS.srem(RHS);
1101 }
1102
1103 /// Unsigned remainder operation on APInt.
1104 /// @brief Function for unsigned remainder operation.
1105 inline APInt urem(const APInt& LHS, const APInt& RHS) {
1106   return LHS.urem(RHS);
1107 }
1108
1109 /// Performs multiplication on APInt values.
1110 /// @brief Function for multiplication operation.
1111 inline APInt mul(const APInt& LHS, const APInt& RHS) {
1112   return LHS * RHS;
1113 }
1114
1115 /// Performs addition on APInt values.
1116 /// @brief Function for addition operation.
1117 inline APInt add(const APInt& LHS, const APInt& RHS) {
1118   return LHS + RHS;
1119 }
1120
1121 /// Performs subtraction on APInt values.
1122 /// @brief Function for subtraction operation.
1123 inline APInt sub(const APInt& LHS, const APInt& RHS) {
1124   return LHS - RHS;
1125 }
1126
1127 /// Performs bitwise AND operation on APInt LHS and
1128 /// APInt RHS.
1129 /// @brief Bitwise AND function for APInt.
1130 inline APInt And(const APInt& LHS, const APInt& RHS) {
1131   return LHS & RHS;
1132 }
1133
1134 /// Performs bitwise OR operation on APInt LHS and APInt RHS.
1135 /// @brief Bitwise OR function for APInt.
1136 inline APInt Or(const APInt& LHS, const APInt& RHS) {
1137   return LHS | RHS;
1138 }
1139
1140 /// Performs bitwise XOR operation on APInt.
1141 /// @brief Bitwise XOR function for APInt.
1142 inline APInt Xor(const APInt& LHS, const APInt& RHS) {
1143   return LHS ^ RHS;
1144 }
1145
1146 /// Performs a bitwise complement operation on APInt.
1147 /// @brief Bitwise complement function.
1148 inline APInt Not(const APInt& APIVal) {
1149   return ~APIVal;
1150 }
1151
1152 } // End of APIntOps namespace
1153
1154 } // End of llvm namespace
1155
1156 #endif