improve comments.
[oota-llvm.git] / include / llvm / CodeGen / ValueTypes.h
index fe3ee6e7b66a8523ca42288e997efdf4e81c9488..57ca285fac49fa160053d3b4422d7fb45874a393 100644 (file)
 
 namespace llvm {
   class Type;
+  class LLVMContext;
 
   struct MVT { // MVT = Machine Value Type
   public:
-
     enum SimpleValueType {
       // If you change this numbering, you must change the values in
-      // ValueTypes.td well!
+      // ValueTypes.td as well!
       Other          =   0,   // This is a non-standard value
       i1             =   1,   // This is a 1 bit integer value
       i8             =   2,   // This is an 8 bit integer value
@@ -50,25 +50,45 @@ namespace llvm {
 
       isVoid         =  13,   // This has no value
 
-      v8i8           =  14,   //  8 x i8
-      v4i16          =  15,   //  4 x i16
-      v2i32          =  16,   //  2 x i32
-      v1i64          =  17,   //  1 x i64
-      v16i8          =  18,   // 16 x i8
-      v8i16          =  19,   //  8 x i16
-      v3i32          =  20,   //  3 x i32
-      v4i32          =  21,   //  4 x i32
-      v2i64          =  22,   //  2 x i64
-
-      v2f32          =  23,   //  2 x f32
-      v3f32          =  24,   //  3 x f32
-      v4f32          =  25,   //  4 x f32
-      v2f64          =  26,   //  2 x f64
-
-      FIRST_VECTOR_VALUETYPE = v8i8,
-      LAST_VECTOR_VALUETYPE  = v2f64,
-
-      LAST_VALUETYPE =  27,   // This always remains at the end of the list.
+      v2i8           =  14,   //  2 x i8
+      v4i8           =  15,   //  4 x i8
+      v8i8           =  16,   //  8 x i8
+      v16i8          =  17,   // 16 x i8
+      v32i8          =  18,   // 32 x i8
+      v2i16          =  19,   //  2 x i16
+      v4i16          =  20,   //  4 x i16
+      v8i16          =  21,   //  8 x i16
+      v16i16         =  22,   // 16 x i16
+      v2i32          =  23,   //  2 x i32
+      v4i32          =  24,   //  4 x i32
+      v8i32          =  25,   //  8 x i32
+      v1i64          =  26,   //  1 x i64
+      v2i64          =  27,   //  2 x i64
+      v4i64          =  28,   //  4 x i64
+
+      v2f32          =  29,   //  2 x f32
+      v4f32          =  30,   //  4 x f32
+      v8f32          =  31,   //  8 x f32
+      v2f64          =  32,   //  2 x f64
+      v4f64          =  33,   //  4 x f64
+
+      FIRST_VECTOR_VALUETYPE = v2i8,
+      LAST_VECTOR_VALUETYPE  = v4f64,
+
+      LAST_VALUETYPE =  34,   // This always remains at the end of the list.
+
+      // This is the current maximum for LAST_VALUETYPE.
+      // MVT::MAX_ALLOWED_VALUETYPE is used for asserts and to size bit vectors
+      // This value must be a multiple of 32.
+      MAX_ALLOWED_VALUETYPE = 64,
+
+      // Metadata - This is MDNode or MDString.
+      Metadata       = 251,
+
+      // iPTRAny - An int value the size of the pointer of the current
+      // target to any address space. This must only be used internal to
+      // tblgen. Other than for overloading, we treat iPTRAny the same as iPTR.
+      iPTRAny        =  252,
 
       // fAny - Any floating-point or vector floating-point value. This is used
       // for intrinsics that have overloadings based on floating-point types.
@@ -82,10 +102,14 @@ namespace llvm {
 
       // iPTR - An int value the size of the pointer of the current
       // target.  This should only be used internal to tblgen!
-      iPTR           =  255
+      iPTR           =  255,
+
+      // LastSimpleValueType - The greatest valid SimpleValueType value.
+      LastSimpleValueType = 255
     };
 
-    /// MVT - This type holds low-level value types. Valid values include any of
+  private:
+    /// This union holds low-level value types. Valid values include any of
     /// the values in the SimpleValueType enum, or any value returned from one
     /// of the MVT methods.  Any value type equal to one of the SimpleValueType
     /// enum values is a "simple" value type.  All others are "extended".
@@ -94,51 +118,43 @@ namespace llvm {
     /// All legal value types must be simple, but often there are some simple
     /// value types that are not legal.
     ///
-    /// @internal
-    /// Extended types are either vector types or arbitrary precision integers.
-    /// Arbitrary precision integers have iAny in the first SimpleTypeBits bits,
-    /// and the bit-width in the next PrecisionBits bits, offset by minus one.
-    /// Vector types are encoded by having the first SimpleTypeBits+PrecisionBits
-    /// bits encode the vector element type (which must be a scalar type, possibly
-    /// an arbitrary precision integer) and the remaining VectorBits upper bits
-    /// encode the vector length, offset by one.
-    ///
-    /// 31--------------16-----------8-------------0
-    ///  | Vector length | Precision | Simple type |
-    ///  |               |      Vector element     |
-    ///
-
-  private:
-
-    static const int SimpleTypeBits = 8;
-    static const int PrecisionBits  = 8;
-    static const int VectorBits     = 32 - SimpleTypeBits - PrecisionBits;
-
-    static const uint32_t SimpleTypeMask =
-      (~uint32_t(0) << (32 - SimpleTypeBits)) >> (32 - SimpleTypeBits);
-
-    static const uint32_t PrecisionMask =
-      ((~uint32_t(0) << VectorBits) >> (32 - PrecisionBits)) << SimpleTypeBits;
-
-    static const uint32_t VectorMask =
-      (~uint32_t(0) >> (32 - VectorBits)) << (32 - VectorBits);
-
-    static const uint32_t ElementMask =
-      (~uint32_t(0) << VectorBits) >> VectorBits;
-
-    uint32_t V;
+    union {
+      uintptr_t V;
+      const Type *LLVMTy;
+    };
 
   public:
-
     MVT() {}
-    MVT(SimpleValueType S) { V = S; }
+    MVT(SimpleValueType S) : V(S) {}
 
-    inline bool operator== (const MVT VT) const { return V == VT.V; }
-    inline bool operator!= (const MVT VT) const { return V != VT.V; }
+    bool operator==(const MVT VT) const {
+      return getRawBits() == VT.getRawBits();
+    }
+    bool operator!=(const MVT VT) const {
+      return getRawBits() != VT.getRawBits();
+    }
+
+    /// getFloatingPointVT - Returns the MVT that represents a floating point
+    /// type with the given number of bits.  There are two floating point types
+    /// with 128 bits - this returns f128 rather than ppcf128.
+    static MVT getFloatingPointVT(unsigned BitWidth) {
+      switch (BitWidth) {
+      default:
+        assert(false && "Bad bit width!");
+      case 32:
+        return f32;
+      case 64:
+        return f64;
+      case 80:
+        return f80;
+      case 128:
+        return f128;
+      }
+    }
 
     /// getIntegerVT - Returns the MVT that represents an integer with the given
     /// number of bits.
-    static inline MVT getIntegerVT(unsigned BitWidth) {
+    static MVT getIntegerVT(unsigned BitWidth) {
       switch (BitWidth) {
       default:
         break;
@@ -155,188 +171,215 @@ namespace llvm {
       case 128:
         return i128;
       }
-      MVT VT;
-      VT.V = iAny | (((BitWidth - 1) << SimpleTypeBits) & PrecisionMask);
-      assert(VT.getSizeInBits() == BitWidth && "Bad bit width!");
-      return VT;
+      return getExtendedIntegerVT(BitWidth);
     }
 
     /// getVectorVT - Returns the MVT that represents a vector NumElements in
     /// length, where each element is of type VT.
-    static inline MVT getVectorVT(MVT VT, unsigned NumElements) {
+    static MVT getVectorVT(MVT VT, unsigned NumElements) {
       switch (VT.V) {
       default:
         break;
       case i8:
+        if (NumElements == 2)  return v2i8;
+        if (NumElements == 4)  return v4i8;
         if (NumElements == 8)  return v8i8;
         if (NumElements == 16) return v16i8;
+        if (NumElements == 32) return v32i8;
         break;
       case i16:
+        if (NumElements == 2)  return v2i16;
         if (NumElements == 4)  return v4i16;
         if (NumElements == 8)  return v8i16;
+        if (NumElements == 16) return v16i16;
         break;
       case i32:
         if (NumElements == 2)  return v2i32;
-        if (NumElements == 3)  return v3i32;
         if (NumElements == 4)  return v4i32;
+        if (NumElements == 8)  return v8i32;
         break;
       case i64:
         if (NumElements == 1)  return v1i64;
         if (NumElements == 2)  return v2i64;
+        if (NumElements == 4)  return v4i64;
         break;
       case f32:
         if (NumElements == 2)  return v2f32;
-        if (NumElements == 3)  return v3f32;
         if (NumElements == 4)  return v4f32;
+        if (NumElements == 8)  return v8f32;
         break;
       case f64:
         if (NumElements == 2)  return v2f64;
+        if (NumElements == 4)  return v4f64;
         break;
       }
-      MVT Result;
-      Result.V = VT.V | ((NumElements + 1) << (32 - VectorBits));
-      assert(Result.getVectorElementType() == VT &&
-             "Bad vector element type!");
-      assert(Result.getVectorNumElements() == NumElements &&
-             "Bad vector length!");
-      return Result;
+      return getExtendedVectorVT(VT, NumElements);
     }
 
     /// getIntVectorWithNumElements - Return any integer vector type that has
     /// the specified number of elements.
-    static inline MVT getIntVectorWithNumElements(unsigned NumElts) {
+    static MVT getIntVectorWithNumElements(unsigned NumElts) {
       switch (NumElts) {
       default: return getVectorVT(i8, NumElts);
       case  1: return v1i64;
       case  2: return v2i32;
-      case  3: return v3i32;
       case  4: return v4i16;
       case  8: return v8i8;
       case 16: return v16i8;
       }
     }
 
-
     /// isSimple - Test if the given MVT is simple (as opposed to being
     /// extended).
-    inline bool isSimple() const {
-      return V <= SimpleTypeMask;
+    bool isSimple() const {
+      return V <= LastSimpleValueType;
     }
 
     /// isExtended - Test if the given MVT is extended (as opposed to
     /// being simple).
-    inline bool isExtended() const {
+    bool isExtended() const {
       return !isSimple();
     }
 
     /// isFloatingPoint - Return true if this is a FP, or a vector FP type.
-    inline bool isFloatingPoint() const {
-      uint32_t SVT = V & SimpleTypeMask;
-      return (SVT >= f32 && SVT <= ppcf128) || (SVT >= v2f32 && SVT <= v2f64);
+    bool isFloatingPoint() const {
+      return isSimple() ?
+             ((V >= f32 && V <= ppcf128) ||
+              (V >= v2f32 && V <= v4f64)) : isExtendedFloatingPoint();
     }
 
     /// isInteger - Return true if this is an integer, or a vector integer type.
-    inline bool isInteger() const {
-      uint32_t SVT = V & SimpleTypeMask;
-      return (SVT >= FIRST_INTEGER_VALUETYPE && SVT <= LAST_INTEGER_VALUETYPE) ||
-        (SVT >= v8i8 && SVT <= v2i64) || (SVT == iAny && (V & PrecisionMask));
+    bool isInteger() const {
+      return isSimple() ?
+             ((V >= FIRST_INTEGER_VALUETYPE && V <= LAST_INTEGER_VALUETYPE) ||
+              (V >= v2i8 && V <= v4i64)) : isExtendedInteger();
     }
 
     /// isVector - Return true if this is a vector value type.
-    inline bool isVector() const {
-      return (V >= FIRST_VECTOR_VALUETYPE && V <= LAST_VECTOR_VALUETYPE) ||
-             (V & VectorMask);
+    bool isVector() const {
+      return isSimple() ?
+             (V >= FIRST_VECTOR_VALUETYPE && V <= LAST_VECTOR_VALUETYPE) :
+             isExtendedVector();
     }
 
     /// is64BitVector - Return true if this is a 64-bit vector type.
-    inline bool is64BitVector() const {
-      return (V==v8i8 || V==v4i16 || V==v2i32 || V==v1i64 || V==v2f32 ||
-              (isExtended() && isVector() && getSizeInBits()==64));
+    bool is64BitVector() const {
+      return isSimple() ?
+             (V==v8i8 || V==v4i16 || V==v2i32 || V==v1i64 || V==v2f32) :
+             isExtended64BitVector();
     }
 
     /// is128BitVector - Return true if this is a 128-bit vector type.
-    inline bool is128BitVector() const {
-      return (V==v16i8 || V==v8i16 || V==v4i32 || V==v2i64 ||
-              V==v4f32 || V==v2f64 ||
-              (isExtended() && isVector() && getSizeInBits()==128));
+    bool is128BitVector() const {
+      return isSimple() ?
+             (V==v16i8 || V==v8i16 || V==v4i32 ||
+              V==v2i64 || V==v4f32 || V==v2f64) :
+             isExtended128BitVector();
+    }
+
+    /// is256BitVector - Return true if this is a 256-bit vector type.
+    inline bool is256BitVector() const {
+      return isSimple() ?
+             (V==v8f32 || V==v4f64 || V==v32i8 || V==v16i16 || V==v8i32 ||
+              V==v4i64) : isExtended256BitVector();
     }
 
     /// isByteSized - Return true if the bit size is a multiple of 8.
-    inline bool isByteSized() const {
+    bool isByteSized() const {
       return (getSizeInBits() & 7) == 0;
     }
 
+    /// isRound - Return true if the size is a power-of-two number of bytes.
+    bool isRound() const {
+      unsigned BitSize = getSizeInBits();
+      return BitSize >= 8 && !(BitSize & (BitSize - 1));
+    }
+
+    /// bitsEq - Return true if this has the same number of bits as VT.
+    bool bitsEq(MVT VT) const {
+      return getSizeInBits() == VT.getSizeInBits();
+    }
+
     /// bitsGT - Return true if this has more bits than VT.
-    inline bool bitsGT(MVT VT) const {
+    bool bitsGT(MVT VT) const {
       return getSizeInBits() > VT.getSizeInBits();
     }
 
     /// bitsGE - Return true if this has no less bits than VT.
-    inline bool bitsGE(MVT VT) const {
+    bool bitsGE(MVT VT) const {
       return getSizeInBits() >= VT.getSizeInBits();
     }
 
     /// bitsLT - Return true if this has less bits than VT.
-    inline bool bitsLT(MVT VT) const {
+    bool bitsLT(MVT VT) const {
       return getSizeInBits() < VT.getSizeInBits();
     }
 
     /// bitsLE - Return true if this has no more bits than VT.
-    inline bool bitsLE(MVT VT) const {
+    bool bitsLE(MVT VT) const {
       return getSizeInBits() <= VT.getSizeInBits();
     }
 
 
     /// getSimpleVT - Return the SimpleValueType held in the specified
     /// simple MVT.
-    inline SimpleValueType getSimpleVT() const {
+    SimpleValueType getSimpleVT() const {
       assert(isSimple() && "Expected a SimpleValueType!");
-      return (SimpleValueType)V;
+      return SimpleValueType(V);
     }
 
     /// getVectorElementType - Given a vector type, return the type of
     /// each element.
-    inline MVT getVectorElementType() const {
+    MVT getVectorElementType() const {
       assert(isVector() && "Invalid vector type!");
       switch (V) {
-      default: {
-        assert(isExtended() && "Unknown simple vector type!");
-        MVT VT;
-        VT.V = V & ElementMask;
-        return VT;
-      }
+      default:
+        return getExtendedVectorElementType();
+      case v2i8 :
+      case v4i8 :
       case v8i8 :
-      case v16i8: return i8;
+      case v16i8:
+      case v32i8: return i8;
+      case v2i16:
       case v4i16:
-      case v8i16: return i16;
+      case v8i16:
+      case v16i16: return i16;
       case v2i32:
-      case v3i32:
-      case v4i32: return i32;
+      case v4i32:
+      case v8i32: return i32;
       case v1i64:
-      case v2i64: return i64;
+      case v2i64:
+      case v4i64: return i64;
       case v2f32:
-      case v3f32:
-      case v4f32: return f32;
-      case v2f64: return f64;
+      case v4f32:
+      case v8f32: return f32;
+      case v2f64:
+      case v4f64: return f64;
       }
     }
 
     /// getVectorNumElements - Given a vector type, return the number of
     /// elements it contains.
-    inline unsigned getVectorNumElements() const {
+    unsigned getVectorNumElements() const {
       assert(isVector() && "Invalid vector type!");
       switch (V) {
       default:
-        assert(isExtended() && "Unknown simple vector type!");
-        return ((V & VectorMask) >> (32 - VectorBits)) - 1;
-      case v16i8: return 16;
+        return getExtendedVectorNumElements();
+      case v32i8: return 32;
+      case v16i8:
+      case v16i16: return 16;
       case v8i8 :
-      case v8i16: return 8;
+      case v8i16:
+      case v8i32:
+      case v8f32: return 8;
+      case v4i8:
       case v4i16:
       case v4i32:
-      case v4f32: return 4;
-      case v3i32:
-      case v3f32: return 3;
+      case v4i64:
+      case v4f32:
+      case v4f64: return 4;
+      case v2i8:
+      case v2i16:
       case v2i32:
       case v2i64:
       case v2f32:
@@ -346,21 +389,24 @@ namespace llvm {
     }
 
     /// getSizeInBits - Return the size of the specified value type in bits.
-    inline unsigned getSizeInBits() const {
+    unsigned getSizeInBits() const {
       switch (V) {
+      case iPTR:
+        assert(0 && "Value type size is target-dependent. Ask TLI.");
+      case iPTRAny:
+      case iAny:
+      case fAny:
+        assert(0 && "Value type is overloaded.");
       default:
-        assert(isExtended() && "MVT has no known size!");
-        if (isVector())
-          return getVectorElementType().getSizeInBits()*getVectorNumElements();
-        if (isInteger())
-          return ((V & PrecisionMask) >> SimpleTypeBits) + 1;
-        assert(false && "Unknown value type!");
-        return 0;
+        return getExtendedSizeInBits();
       case i1  :  return 1;
       case i8  :  return 8;
-      case i16 :  return 16;
+      case i16 :
+      case v2i8:  return 16;
       case f32 :
-      case i32 :  return 32;
+      case i32 :
+      case v4i8:
+      case v2i16: return 32;
       case f64 :
       case i64 :
       case v8i8:
@@ -369,8 +415,6 @@ namespace llvm {
       case v1i64:
       case v2f32: return 64;
       case f80 :  return 80;
-      case v3i32:
-      case v3f32: return 96;
       case f128:
       case ppcf128:
       case i128:
@@ -380,19 +424,25 @@ namespace llvm {
       case v2i64:
       case v4f32:
       case v2f64: return 128;
+      case v32i8:
+      case v16i16:
+      case v8i32:
+      case v4i64:
+      case v8f32:
+      case v4f64: return 256;
       }
     }
 
     /// getStoreSizeInBits - Return the number of bits overwritten by a store
     /// of the specified value type.
-    inline unsigned getStoreSizeInBits() const {
+    unsigned getStoreSizeInBits() const {
       return (getSizeInBits() + 7)/8*8;
     }
 
     /// getRoundIntegerType - Rounds the bit-width of the given integer MVT up
     /// to the nearest power of two (and at least to eight), and returns the
     /// integer MVT with that number of bits.
-    inline MVT getRoundIntegerType() const {
+    MVT getRoundIntegerType() const {
       assert(isInteger() && !isVector() && "Invalid integer type!");
       unsigned BitWidth = getSizeInBits();
       if (BitWidth <= 8)
@@ -401,19 +451,23 @@ namespace llvm {
         return getIntegerVT(1 << Log2_32_Ceil(BitWidth));
     }
 
-    /// getIntegerVTBitMask - Return an integer with 1's every place there are
-    /// bits in the specified integer value type. FIXME: Should return an apint.
-    inline uint64_t getIntegerVTBitMask() const {
-      assert(isInteger() && !isVector() && "Only applies to int scalars!");
-      return ~uint64_t(0UL) >> (64-getSizeInBits());
+    /// isPow2VectorType - Retuns true if the given vector is a power of 2.
+    bool isPow2VectorType() const {
+      unsigned NElts = getVectorNumElements();
+      return !(NElts & (NElts - 1));
     }
 
-    /// getIntegerVTSignBit - Return an integer with a 1 in the position of the
-    /// sign bit for the specified integer value type. FIXME: Should return an
-    /// apint.
-    inline uint64_t getIntegerVTSignBit() const {
-      assert(isInteger() && !isVector() && "Only applies to int scalars!");
-      return uint64_t(1UL) << (getSizeInBits()-1);
+    /// getPow2VectorType - Widens the length of the given vector MVT up to
+    /// the nearest power of 2 and returns that type.
+    MVT getPow2VectorType() const {
+      if (!isPow2VectorType()) {
+        unsigned NElts = getVectorNumElements();
+        unsigned Pow2NElts = 1 <<  Log2_32_Ceil(NElts);
+        return MVT::getVectorVT(getVectorElementType(), Pow2NElts);
+      }
+      else {
+        return *this;
+      }
     }
 
     /// getMVTString - This function returns value type as a string,
@@ -423,7 +477,7 @@ namespace llvm {
     /// getTypeForMVT - This method returns an LLVM type corresponding to the
     /// specified MVT.  For integer types, this returns an unsigned type.  Note
     /// that this will abort for types that cannot be represented.
-    const Type *getTypeForMVT() const;
+    const Type *getTypeForMVT(LLVMContext &Context) const;
 
     /// getMVT - Return the value type corresponding to the specified type.
     /// This returns all pointers as iPTR.  If HandleUnknown is true, unknown
@@ -431,7 +485,7 @@ namespace llvm {
     static MVT getMVT(const Type *Ty, bool HandleUnknown = false);
 
     /// getRawBits - Represent the type as a bunch of bits.
-    uint32_t getRawBits() const { return V; }
+    uintptr_t getRawBits() const { return V; }
 
     /// compareRawBits - A meaningless but well-behaved order, useful for
     /// constructing containers.
@@ -440,6 +494,22 @@ namespace llvm {
         return L.getRawBits() < R.getRawBits();
       }
     };
+
+  private:
+    // Methods for handling the Extended-type case in functions above.
+    // These are all out-of-line to prevent users of this header file
+    // from having a dependency on Type.h.
+    static MVT getExtendedIntegerVT(unsigned BitWidth);
+    static MVT getExtendedVectorVT(MVT VT, unsigned NumElements);
+    bool isExtendedFloatingPoint() const;
+    bool isExtendedInteger() const;
+    bool isExtendedVector() const;
+    bool isExtended64BitVector() const;
+    bool isExtended128BitVector() const;
+    bool isExtended256BitVector() const;
+    MVT getExtendedVectorElementType() const;
+    unsigned getExtendedVectorNumElements() const;
+    unsigned getExtendedSizeInBits() const;
   };
 
 } // End llvm namespace