[llvm-profdata] Add SaturatingAdd/SaturatingMultiply Helper Functions
[oota-llvm.git] / lib / IR / ValueTypes.cpp
1 //===----------- ValueTypes.cpp - Implementation of EVT methods -----------===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 //
10 // This file implements methods in the CodeGen/ValueTypes.h header.
11 //
12 //===----------------------------------------------------------------------===//
13
14 #include "llvm/CodeGen/ValueTypes.h"
15 #include "llvm/ADT/StringExtras.h"
16 #include "llvm/IR/DerivedTypes.h"
17 #include "llvm/IR/LLVMContext.h"
18 #include "llvm/IR/Type.h"
19 #include "llvm/Support/ErrorHandling.h"
20 using namespace llvm;
21
22 EVT EVT::changeExtendedTypeToInteger() const {
23   LLVMContext &Context = LLVMTy->getContext();
24   return getIntegerVT(Context, getSizeInBits());
25 }
26
27 EVT EVT::changeExtendedVectorElementTypeToInteger() const {
28   LLVMContext &Context = LLVMTy->getContext();
29   EVT IntTy = getIntegerVT(Context, getVectorElementType().getSizeInBits());
30   return getVectorVT(Context, IntTy, getVectorNumElements());
31 }
32
33 EVT EVT::getExtendedIntegerVT(LLVMContext &Context, unsigned BitWidth) {
34   EVT VT;
35   VT.LLVMTy = IntegerType::get(Context, BitWidth);
36   assert(VT.isExtended() && "Type is not extended!");
37   return VT;
38 }
39
40 EVT EVT::getExtendedVectorVT(LLVMContext &Context, EVT VT,
41                              unsigned NumElements) {
42   EVT ResultVT;
43   ResultVT.LLVMTy = VectorType::get(VT.getTypeForEVT(Context), NumElements);
44   assert(ResultVT.isExtended() && "Type is not extended!");
45   return ResultVT;
46 }
47
48 bool EVT::isExtendedFloatingPoint() const {
49   assert(isExtended() && "Type is not extended!");
50   return LLVMTy->isFPOrFPVectorTy();
51 }
52
53 bool EVT::isExtendedInteger() const {
54   assert(isExtended() && "Type is not extended!");
55   return LLVMTy->isIntOrIntVectorTy();
56 }
57
58 bool EVT::isExtendedVector() const {
59   assert(isExtended() && "Type is not extended!");
60   return LLVMTy->isVectorTy();
61 }
62
63 bool EVT::isExtended16BitVector() const {
64   return isExtendedVector() && getExtendedSizeInBits() == 16;
65 }
66
67 bool EVT::isExtended32BitVector() const {
68   return isExtendedVector() && getExtendedSizeInBits() == 32;
69 }
70
71 bool EVT::isExtended64BitVector() const {
72   return isExtendedVector() && getExtendedSizeInBits() == 64;
73 }
74
75 bool EVT::isExtended128BitVector() const {
76   return isExtendedVector() && getExtendedSizeInBits() == 128;
77 }
78
79 bool EVT::isExtended256BitVector() const {
80   return isExtendedVector() && getExtendedSizeInBits() == 256;
81 }
82
83 bool EVT::isExtended512BitVector() const {
84   return isExtendedVector() && getExtendedSizeInBits() == 512;
85 }
86
87 bool EVT::isExtended1024BitVector() const {
88   return isExtendedVector() && getExtendedSizeInBits() == 1024;
89 }
90
91 EVT EVT::getExtendedVectorElementType() const {
92   assert(isExtended() && "Type is not extended!");
93   return EVT::getEVT(cast<VectorType>(LLVMTy)->getElementType());
94 }
95
96 unsigned EVT::getExtendedVectorNumElements() const {
97   assert(isExtended() && "Type is not extended!");
98   return cast<VectorType>(LLVMTy)->getNumElements();
99 }
100
101 unsigned EVT::getExtendedSizeInBits() const {
102   assert(isExtended() && "Type is not extended!");
103   if (IntegerType *ITy = dyn_cast<IntegerType>(LLVMTy))
104     return ITy->getBitWidth();
105   if (VectorType *VTy = dyn_cast<VectorType>(LLVMTy))
106     return VTy->getBitWidth();
107   llvm_unreachable("Unrecognized extended type!");
108 }
109
110 /// getEVTString - This function returns value type as a string, e.g. "i32".
111 std::string EVT::getEVTString() const {
112   switch (V.SimpleTy) {
113   default:
114     if (isVector())
115       return "v" + utostr(getVectorNumElements()) +
116              getVectorElementType().getEVTString();
117     if (isInteger())
118       return "i" + utostr(getSizeInBits());
119     llvm_unreachable("Invalid EVT!");
120   case MVT::i1:      return "i1";
121   case MVT::i8:      return "i8";
122   case MVT::i16:     return "i16";
123   case MVT::i32:     return "i32";
124   case MVT::i64:     return "i64";
125   case MVT::i128:    return "i128";
126   case MVT::f16:     return "f16";
127   case MVT::f32:     return "f32";
128   case MVT::f64:     return "f64";
129   case MVT::f80:     return "f80";
130   case MVT::f128:    return "f128";
131   case MVT::ppcf128: return "ppcf128";
132   case MVT::isVoid:  return "isVoid";
133   case MVT::Other:   return "ch";
134   case MVT::Glue:    return "glue";
135   case MVT::x86mmx:  return "x86mmx";
136   case MVT::v2i1:    return "v2i1";
137   case MVT::v4i1:    return "v4i1";
138   case MVT::v8i1:    return "v8i1";
139   case MVT::v16i1:   return "v16i1";
140   case MVT::v32i1:   return "v32i1";
141   case MVT::v64i1:   return "v64i1";
142   case MVT::v1i8:    return "v1i8";
143   case MVT::v2i8:    return "v2i8";
144   case MVT::v4i8:    return "v4i8";
145   case MVT::v8i8:    return "v8i8";
146   case MVT::v16i8:   return "v16i8";
147   case MVT::v32i8:   return "v32i8";
148   case MVT::v64i8:   return "v64i8";
149   case MVT::v1i16:   return "v1i16";
150   case MVT::v2i16:   return "v2i16";
151   case MVT::v4i16:   return "v4i16";
152   case MVT::v8i16:   return "v8i16";
153   case MVT::v16i16:  return "v16i16";
154   case MVT::v32i16:  return "v32i16";
155   case MVT::v1i32:   return "v1i32";
156   case MVT::v2i32:   return "v2i32";
157   case MVT::v4i32:   return "v4i32";
158   case MVT::v8i32:   return "v8i32";
159   case MVT::v16i32:  return "v16i32";
160   case MVT::v1i64:   return "v1i64";
161   case MVT::v2i64:   return "v2i64";
162   case MVT::v4i64:   return "v4i64";
163   case MVT::v8i64:   return "v8i64";
164   case MVT::v16i64:  return "v16i64";
165   case MVT::v1i128:  return "v1i128";
166   case MVT::v1f32:   return "v1f32";
167   case MVT::v2f32:   return "v2f32";
168   case MVT::v2f16:   return "v2f16";
169   case MVT::v4f16:   return "v4f16";
170   case MVT::v8f16:   return "v8f16";
171   case MVT::v4f32:   return "v4f32";
172   case MVT::v8f32:   return "v8f32";
173   case MVT::v16f32:  return "v16f32";
174   case MVT::v1f64:   return "v1f64";
175   case MVT::v2f64:   return "v2f64";
176   case MVT::v4f64:   return "v4f64";
177   case MVT::v8f64:   return "v8f64";
178   case MVT::Metadata:return "Metadata";
179   case MVT::Untyped: return "Untyped";
180   }
181 }
182
183 /// getTypeForEVT - This method returns an LLVM type corresponding to the
184 /// specified EVT.  For integer types, this returns an unsigned type.  Note
185 /// that this will abort for types that cannot be represented.
186 Type *EVT::getTypeForEVT(LLVMContext &Context) const {
187   switch (V.SimpleTy) {
188   default:
189     assert(isExtended() && "Type is not extended!");
190     return LLVMTy;
191   case MVT::isVoid:  return Type::getVoidTy(Context);
192   case MVT::i1:      return Type::getInt1Ty(Context);
193   case MVT::i8:      return Type::getInt8Ty(Context);
194   case MVT::i16:     return Type::getInt16Ty(Context);
195   case MVT::i32:     return Type::getInt32Ty(Context);
196   case MVT::i64:     return Type::getInt64Ty(Context);
197   case MVT::i128:    return IntegerType::get(Context, 128);
198   case MVT::f16:     return Type::getHalfTy(Context);
199   case MVT::f32:     return Type::getFloatTy(Context);
200   case MVT::f64:     return Type::getDoubleTy(Context);
201   case MVT::f80:     return Type::getX86_FP80Ty(Context);
202   case MVT::f128:    return Type::getFP128Ty(Context);
203   case MVT::ppcf128: return Type::getPPC_FP128Ty(Context);
204   case MVT::x86mmx:  return Type::getX86_MMXTy(Context);
205   case MVT::v2i1:    return VectorType::get(Type::getInt1Ty(Context), 2);
206   case MVT::v4i1:    return VectorType::get(Type::getInt1Ty(Context), 4);
207   case MVT::v8i1:    return VectorType::get(Type::getInt1Ty(Context), 8);
208   case MVT::v16i1:   return VectorType::get(Type::getInt1Ty(Context), 16);
209   case MVT::v32i1:   return VectorType::get(Type::getInt1Ty(Context), 32);
210   case MVT::v64i1:   return VectorType::get(Type::getInt1Ty(Context), 64);
211   case MVT::v1i8:    return VectorType::get(Type::getInt8Ty(Context), 1);
212   case MVT::v2i8:    return VectorType::get(Type::getInt8Ty(Context), 2);
213   case MVT::v4i8:    return VectorType::get(Type::getInt8Ty(Context), 4);
214   case MVT::v8i8:    return VectorType::get(Type::getInt8Ty(Context), 8);
215   case MVT::v16i8:   return VectorType::get(Type::getInt8Ty(Context), 16);
216   case MVT::v32i8:   return VectorType::get(Type::getInt8Ty(Context), 32);
217   case MVT::v64i8:   return VectorType::get(Type::getInt8Ty(Context), 64);
218   case MVT::v1i16:   return VectorType::get(Type::getInt16Ty(Context), 1);
219   case MVT::v2i16:   return VectorType::get(Type::getInt16Ty(Context), 2);
220   case MVT::v4i16:   return VectorType::get(Type::getInt16Ty(Context), 4);
221   case MVT::v8i16:   return VectorType::get(Type::getInt16Ty(Context), 8);
222   case MVT::v16i16:  return VectorType::get(Type::getInt16Ty(Context), 16);
223   case MVT::v32i16:  return VectorType::get(Type::getInt16Ty(Context), 32);
224   case MVT::v1i32:   return VectorType::get(Type::getInt32Ty(Context), 1);
225   case MVT::v2i32:   return VectorType::get(Type::getInt32Ty(Context), 2);
226   case MVT::v4i32:   return VectorType::get(Type::getInt32Ty(Context), 4);
227   case MVT::v8i32:   return VectorType::get(Type::getInt32Ty(Context), 8);
228   case MVT::v16i32:  return VectorType::get(Type::getInt32Ty(Context), 16);
229   case MVT::v1i64:   return VectorType::get(Type::getInt64Ty(Context), 1);
230   case MVT::v2i64:   return VectorType::get(Type::getInt64Ty(Context), 2);
231   case MVT::v4i64:   return VectorType::get(Type::getInt64Ty(Context), 4);
232   case MVT::v8i64:   return VectorType::get(Type::getInt64Ty(Context), 8);
233   case MVT::v16i64:  return VectorType::get(Type::getInt64Ty(Context), 16);
234   case MVT::v1i128:  return VectorType::get(Type::getInt128Ty(Context), 1);
235   case MVT::v2f16:   return VectorType::get(Type::getHalfTy(Context), 2);
236   case MVT::v4f16:   return VectorType::get(Type::getHalfTy(Context), 4);
237   case MVT::v8f16:   return VectorType::get(Type::getHalfTy(Context), 8);
238   case MVT::v1f32:   return VectorType::get(Type::getFloatTy(Context), 1);
239   case MVT::v2f32:   return VectorType::get(Type::getFloatTy(Context), 2);
240   case MVT::v4f32:   return VectorType::get(Type::getFloatTy(Context), 4);
241   case MVT::v8f32:   return VectorType::get(Type::getFloatTy(Context), 8);
242   case MVT::v16f32:   return VectorType::get(Type::getFloatTy(Context), 16);
243   case MVT::v1f64:   return VectorType::get(Type::getDoubleTy(Context), 1);
244   case MVT::v2f64:   return VectorType::get(Type::getDoubleTy(Context), 2);
245   case MVT::v4f64:   return VectorType::get(Type::getDoubleTy(Context), 4); 
246   case MVT::v8f64:   return VectorType::get(Type::getDoubleTy(Context), 8); 
247   case MVT::Metadata: return Type::getMetadataTy(Context);
248  }
249 }
250
251 /// Return the value type corresponding to the specified type.  This returns all
252 /// pointers as MVT::iPTR.  If HandleUnknown is true, unknown types are returned
253 /// as Other, otherwise they are invalid.
254 MVT MVT::getVT(Type *Ty, bool HandleUnknown){
255   switch (Ty->getTypeID()) {
256   default:
257     if (HandleUnknown) return MVT(MVT::Other);
258     llvm_unreachable("Unknown type!");
259   case Type::VoidTyID:
260     return MVT::isVoid;
261   case Type::IntegerTyID:
262     return getIntegerVT(cast<IntegerType>(Ty)->getBitWidth());
263   case Type::HalfTyID:      return MVT(MVT::f16);
264   case Type::FloatTyID:     return MVT(MVT::f32);
265   case Type::DoubleTyID:    return MVT(MVT::f64);
266   case Type::X86_FP80TyID:  return MVT(MVT::f80);
267   case Type::X86_MMXTyID:   return MVT(MVT::x86mmx);
268   case Type::FP128TyID:     return MVT(MVT::f128);
269   case Type::PPC_FP128TyID: return MVT(MVT::ppcf128);
270   case Type::PointerTyID:   return MVT(MVT::iPTR);
271   case Type::VectorTyID: {
272     VectorType *VTy = cast<VectorType>(Ty);
273     return getVectorVT(
274       getVT(VTy->getElementType(), false), VTy->getNumElements());
275   }
276   }
277 }
278
279 /// getEVT - Return the value type corresponding to the specified type.  This
280 /// returns all pointers as MVT::iPTR.  If HandleUnknown is true, unknown types
281 /// are returned as Other, otherwise they are invalid.
282 EVT EVT::getEVT(Type *Ty, bool HandleUnknown){
283   switch (Ty->getTypeID()) {
284   default:
285     return MVT::getVT(Ty, HandleUnknown);
286   case Type::IntegerTyID:
287     return getIntegerVT(Ty->getContext(), cast<IntegerType>(Ty)->getBitWidth());
288   case Type::VectorTyID: {
289     VectorType *VTy = cast<VectorType>(Ty);
290     return getVectorVT(Ty->getContext(), getEVT(VTy->getElementType(), false),
291                        VTy->getNumElements());
292   }
293   }
294 }