1 //===- CodeGen/ValueTypes.h - Low-Level Target independ. types --*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file defines the set of low-level target independent types which various
11 // values in the code generator are. This allows the target specific behavior
12 // of instructions to be described to target independent passes.
14 //===----------------------------------------------------------------------===//
16 #ifndef LLVM_CODEGEN_VALUETYPES_H
17 #define LLVM_CODEGEN_VALUETYPES_H
21 #include "llvm/Support/DataTypes.h"
22 #include "llvm/Support/MathExtras.h"
27 struct MVT { // MVT = Machine Value Type
29 enum SimpleValueType {
30 // If you change this numbering, you must change the values in
31 // ValueTypes.td as well!
32 Other = 0, // This is a non-standard value
33 i1 = 1, // This is a 1 bit integer value
34 i8 = 2, // This is an 8 bit integer value
35 i16 = 3, // This is a 16 bit integer value
36 i32 = 4, // This is a 32 bit integer value
37 i64 = 5, // This is a 64 bit integer value
38 i128 = 6, // This is a 128 bit integer value
40 FIRST_INTEGER_VALUETYPE = i1,
41 LAST_INTEGER_VALUETYPE = i128,
43 f32 = 7, // This is a 32 bit floating point value
44 f64 = 8, // This is a 64 bit floating point value
45 f80 = 9, // This is a 80 bit floating point value
46 f128 = 10, // This is a 128 bit floating point value
47 ppcf128 = 11, // This is a PPC 128-bit floating point value
48 Flag = 12, // This is a condition code or machine flag.
50 isVoid = 13, // This has no value
54 v2i16 = 16, // 2 x i16
56 v4i16 = 18, // 4 x i16
57 v2i32 = 19, // 2 x i32
58 v1i64 = 20, // 1 x i64
59 v16i8 = 21, // 16 x i8
60 v8i16 = 22, // 8 x i16
61 v3i32 = 23, // 3 x i32
62 v4i32 = 24, // 4 x i32
63 v2i64 = 25, // 2 x i64
65 v2f32 = 26, // 2 x f32
66 v3f32 = 27, // 3 x f32
67 v4f32 = 28, // 4 x f32
68 v2f64 = 29, // 2 x f64
70 FIRST_VECTOR_VALUETYPE = v2i8,
71 LAST_VECTOR_VALUETYPE = v2f64,
73 LAST_VALUETYPE = 30, // This always remains at the end of the list.
75 // iPTRAny - An int value the size of the pointer of the current
76 // target to any address space. This must only be used internal to
77 // tblgen. Other than for overloading, we treat iPTRAny the same as iPTR.
80 // fAny - Any floating-point or vector floating-point value. This is used
81 // for intrinsics that have overloadings based on floating-point types.
82 // This is only for tblgen's consumption!
85 // iAny - An integer or vector integer value of any bit width. This is
86 // used for intrinsics that have overloadings based on integer bit widths.
87 // This is only for tblgen's consumption!
90 // iPTR - An int value the size of the pointer of the current
91 // target. This should only be used internal to tblgen!
94 // LastSimpleValueType - The greatest valid SimpleValueType value.
95 LastSimpleValueType = 255
99 /// This union holds low-level value types. Valid values include any of
100 /// the values in the SimpleValueType enum, or any value returned from one
101 /// of the MVT methods. Any value type equal to one of the SimpleValueType
102 /// enum values is a "simple" value type. All others are "extended".
104 /// Note that simple doesn't necessary mean legal for the target machine.
105 /// All legal value types must be simple, but often there are some simple
106 /// value types that are not legal.
110 SimpleValueType SimpleTy;
116 MVT(SimpleValueType S) : V(S) {}
118 bool operator==(const MVT VT) const {
119 return getRawBits() == VT.getRawBits();
121 bool operator!=(const MVT VT) const {
122 return getRawBits() != VT.getRawBits();
125 /// getFloatingPointVT - Returns the MVT that represents a floating point
126 /// type with the given number of bits. There are two floating point types
127 /// with 128 bits - this returns f128 rather than ppcf128.
128 static MVT getFloatingPointVT(unsigned BitWidth) {
131 assert(false && "Bad bit width!");
143 /// getIntegerVT - Returns the MVT that represents an integer with the given
145 static MVT getIntegerVT(unsigned BitWidth) {
162 return getExtendedIntegerVT(BitWidth);
165 /// getVectorVT - Returns the MVT that represents a vector NumElements in
166 /// length, where each element is of type VT.
167 static MVT getVectorVT(MVT VT, unsigned NumElements) {
172 if (NumElements == 2) return v2i8;
173 if (NumElements == 4) return v4i8;
174 if (NumElements == 8) return v8i8;
175 if (NumElements == 16) return v16i8;
178 if (NumElements == 2) return v2i16;
179 if (NumElements == 4) return v4i16;
180 if (NumElements == 8) return v8i16;
183 if (NumElements == 2) return v2i32;
184 if (NumElements == 3) return v3i32;
185 if (NumElements == 4) return v4i32;
188 if (NumElements == 1) return v1i64;
189 if (NumElements == 2) return v2i64;
192 if (NumElements == 2) return v2f32;
193 if (NumElements == 3) return v3f32;
194 if (NumElements == 4) return v4f32;
197 if (NumElements == 2) return v2f64;
200 return getExtendedVectorVT(VT, NumElements);
203 /// getIntVectorWithNumElements - Return any integer vector type that has
204 /// the specified number of elements.
205 static MVT getIntVectorWithNumElements(unsigned NumElts) {
207 default: return getVectorVT(i8, NumElts);
208 case 1: return v1i64;
209 case 2: return v2i32;
210 case 3: return v3i32;
211 case 4: return v4i16;
213 case 16: return v16i8;
217 /// isSimple - Test if the given MVT is simple (as opposed to being
219 bool isSimple() const {
220 return V <= LastSimpleValueType;
223 /// isExtended - Test if the given MVT is extended (as opposed to
225 bool isExtended() const {
229 /// isFloatingPoint - Return true if this is a FP, or a vector FP type.
230 bool isFloatingPoint() const {
232 ((SimpleTy >= f32 && SimpleTy <= ppcf128) ||
233 (SimpleTy >= v2f32 && SimpleTy <= v2f64)) :
234 isExtendedFloatingPoint();
237 /// isInteger - Return true if this is an integer, or a vector integer type.
238 bool isInteger() const {
240 ((SimpleTy >= FIRST_INTEGER_VALUETYPE &&
241 SimpleTy <= LAST_INTEGER_VALUETYPE) ||
242 (SimpleTy >= v2i8 && SimpleTy <= v2i64)) :
246 /// isVector - Return true if this is a vector value type.
247 bool isVector() const {
249 (SimpleTy >= FIRST_VECTOR_VALUETYPE &&
250 SimpleTy <= LAST_VECTOR_VALUETYPE) :
254 /// is64BitVector - Return true if this is a 64-bit vector type.
255 bool is64BitVector() const {
257 (SimpleTy==v8i8 || SimpleTy==v4i16 || SimpleTy==v2i32 ||
258 SimpleTy==v1i64 || SimpleTy==v2f32) :
259 isExtended64BitVector();
262 /// is128BitVector - Return true if this is a 128-bit vector type.
263 bool is128BitVector() const {
265 (SimpleTy==v16i8 || SimpleTy==v8i16 || SimpleTy==v4i32 ||
266 SimpleTy==v2i64 || SimpleTy==v4f32 || SimpleTy==v2f64) :
267 isExtended128BitVector();
270 /// isByteSized - Return true if the bit size is a multiple of 8.
271 bool isByteSized() const {
272 return (getSizeInBits() & 7) == 0;
275 /// isRound - Return true if the size is a power-of-two number of bytes.
276 bool isRound() const {
277 unsigned BitSize = getSizeInBits();
278 return BitSize >= 8 && !(BitSize & (BitSize - 1));
281 /// bitsEq - Return true if this has the same number of bits as VT.
282 bool bitsEq(MVT VT) const {
283 return getSizeInBits() == VT.getSizeInBits();
286 /// bitsGT - Return true if this has more bits than VT.
287 bool bitsGT(MVT VT) const {
288 return getSizeInBits() > VT.getSizeInBits();
291 /// bitsGE - Return true if this has no less bits than VT.
292 bool bitsGE(MVT VT) const {
293 return getSizeInBits() >= VT.getSizeInBits();
296 /// bitsLT - Return true if this has less bits than VT.
297 bool bitsLT(MVT VT) const {
298 return getSizeInBits() < VT.getSizeInBits();
301 /// bitsLE - Return true if this has no more bits than VT.
302 bool bitsLE(MVT VT) const {
303 return getSizeInBits() <= VT.getSizeInBits();
307 /// getSimpleVT - Return the SimpleValueType held in the specified
309 SimpleValueType getSimpleVT() const {
310 assert(isSimple() && "Expected a SimpleValueType!");
314 /// getVectorElementType - Given a vector type, return the type of
316 MVT getVectorElementType() const {
317 assert(isVector() && "Invalid vector type!");
320 return getExtendedVectorElementType();
324 case v16i8: return i8;
327 case v8i16: return i16;
330 case v4i32: return i32;
332 case v2i64: return i64;
335 case v4f32: return f32;
336 case v2f64: return f64;
340 /// getVectorNumElements - Given a vector type, return the number of
341 /// elements it contains.
342 unsigned getVectorNumElements() const {
343 assert(isVector() && "Invalid vector type!");
346 return getExtendedVectorNumElements();
347 case v16i8: return 16;
349 case v8i16: return 8;
353 case v4f32: return 4;
355 case v3f32: return 3;
361 case v2f64: return 2;
362 case v1i64: return 1;
366 /// getSizeInBits - Return the size of the specified value type in bits.
367 unsigned getSizeInBits() const {
370 assert(0 && "Value type size is target-dependent. Ask TLI.");
374 assert(0 && "Value type is overloaded.");
376 return getExtendedSizeInBits();
380 case v2i8: return 16;
384 case v2i16: return 32;
391 case v2f32: return 64;
392 case f80 : return 80;
394 case v3f32: return 96;
403 case v2f64: return 128;
407 /// getStoreSizeInBits - Return the number of bits overwritten by a store
408 /// of the specified value type.
409 unsigned getStoreSizeInBits() const {
410 return (getSizeInBits() + 7)/8*8;
413 /// getRoundIntegerType - Rounds the bit-width of the given integer MVT up
414 /// to the nearest power of two (and at least to eight), and returns the
415 /// integer MVT with that number of bits.
416 MVT getRoundIntegerType() const {
417 assert(isInteger() && !isVector() && "Invalid integer type!");
418 unsigned BitWidth = getSizeInBits();
422 return getIntegerVT(1 << Log2_32_Ceil(BitWidth));
425 /// isPow2VectorType - Retuns true if the given vector is a power of 2.
426 bool isPow2VectorType() const {
427 unsigned NElts = getVectorNumElements();
428 return !(NElts & (NElts - 1));
431 /// getPow2VectorType - Widens the length of the given vector MVT up to
432 /// the nearest power of 2 and returns that type.
433 MVT getPow2VectorType() const {
434 if (!isPow2VectorType()) {
435 unsigned NElts = getVectorNumElements();
436 unsigned Pow2NElts = 1 << Log2_32_Ceil(NElts);
437 return MVT::getVectorVT(getVectorElementType(), Pow2NElts);
444 /// getIntegerVTBitMask - Return an integer with 1's every place there are
445 /// bits in the specified integer value type. FIXME: Should return an apint.
446 uint64_t getIntegerVTBitMask() const {
447 assert(isInteger() && !isVector() && "Only applies to int scalars!");
448 return ~uint64_t(0UL) >> (64-getSizeInBits());
451 /// getIntegerVTSignBit - Return an integer with a 1 in the position of the
452 /// sign bit for the specified integer value type. FIXME: Should return an
454 uint64_t getIntegerVTSignBit() const {
455 assert(isInteger() && !isVector() && "Only applies to int scalars!");
456 return uint64_t(1UL) << (getSizeInBits()-1);
459 /// getMVTString - This function returns value type as a string,
461 std::string getMVTString() const;
463 /// getTypeForMVT - This method returns an LLVM type corresponding to the
464 /// specified MVT. For integer types, this returns an unsigned type. Note
465 /// that this will abort for types that cannot be represented.
466 const Type *getTypeForMVT() const;
468 /// getMVT - Return the value type corresponding to the specified type.
469 /// This returns all pointers as iPTR. If HandleUnknown is true, unknown
470 /// types are returned as Other, otherwise they are invalid.
471 static MVT getMVT(const Type *Ty, bool HandleUnknown = false);
473 /// getRawBits - Represent the type as a bunch of bits.
474 uintptr_t getRawBits() const { return V; }
476 /// compareRawBits - A meaningless but well-behaved order, useful for
477 /// constructing containers.
478 struct compareRawBits {
479 bool operator()(MVT L, MVT R) const {
480 return L.getRawBits() < R.getRawBits();
485 // Methods for handling the Extended-type case in functions above.
486 // These are all out-of-line to prevent users of this header file
487 // from having a dependency on Type.h.
488 static MVT getExtendedIntegerVT(unsigned BitWidth);
489 static MVT getExtendedVectorVT(MVT VT, unsigned NumElements);
490 bool isExtendedFloatingPoint() const;
491 bool isExtendedInteger() const;
492 bool isExtendedVector() const;
493 bool isExtended64BitVector() const;
494 bool isExtended128BitVector() const;
495 MVT getExtendedVectorElementType() const;
496 unsigned getExtendedVectorNumElements() const;
497 unsigned getExtendedSizeInBits() const;
500 } // End llvm namespace