1 //===----------- ValueTypes.cpp - Implementation of EVT methods -----------===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 
9 #include "llvm/CodeGen/ValueTypes.h"
10 #include "llvm/ADT/StringExtras.h"
11 #include "llvm/IR/DerivedTypes.h"
12 #include "llvm/IR/Type.h"
13 #include "llvm/Support/ErrorHandling.h"
14 #include "llvm/Support/TypeSize.h"
15 using namespace llvm;
16 
17 EVT EVT::changeExtendedTypeToInteger() const {
18   LLVMContext &Context = LLVMTy->getContext();
19   return getIntegerVT(Context, getSizeInBits());
20 }
21 
22 EVT EVT::changeExtendedVectorElementTypeToInteger() const {
23   LLVMContext &Context = LLVMTy->getContext();
24   EVT IntTy = getIntegerVT(Context, getScalarSizeInBits());
25   return getVectorVT(Context, IntTy, getVectorNumElements(),
26                      isScalableVector());
27 }
28 
29 EVT EVT::changeExtendedVectorElementType(EVT EltVT) const {
30   LLVMContext &Context = LLVMTy->getContext();
31   return getVectorVT(Context, EltVT, getVectorElementCount());
32 }
33 
34 EVT EVT::getExtendedIntegerVT(LLVMContext &Context, unsigned BitWidth) {
35   EVT VT;
36   VT.LLVMTy = IntegerType::get(Context, BitWidth);
37   assert(VT.isExtended() && "Type is not extended!");
38   return VT;
39 }
40 
41 EVT EVT::getExtendedVectorVT(LLVMContext &Context, EVT VT, unsigned NumElements,
42                              bool IsScalable) {
43   EVT ResultVT;
44   ResultVT.LLVMTy =
45       VectorType::get(VT.getTypeForEVT(Context), NumElements, IsScalable);
46   assert(ResultVT.isExtended() && "Type is not extended!");
47   return ResultVT;
48 }
49 
50 EVT EVT::getExtendedVectorVT(LLVMContext &Context, EVT VT, ElementCount EC) {
51   EVT ResultVT;
52   ResultVT.LLVMTy =
53       VectorType::get(VT.getTypeForEVT(Context), {EC.Min, EC.Scalable});
54   assert(ResultVT.isExtended() && "Type is not extended!");
55   return ResultVT;
56 }
57 
58 bool EVT::isExtendedFloatingPoint() const {
59   assert(isExtended() && "Type is not extended!");
60   return LLVMTy->isFPOrFPVectorTy();
61 }
62 
63 bool EVT::isExtendedInteger() const {
64   assert(isExtended() && "Type is not extended!");
65   return LLVMTy->isIntOrIntVectorTy();
66 }
67 
68 bool EVT::isExtendedScalarInteger() const {
69   assert(isExtended() && "Type is not extended!");
70   return LLVMTy->isIntegerTy();
71 }
72 
73 bool EVT::isExtendedVector() const {
74   assert(isExtended() && "Type is not extended!");
75   return LLVMTy->isVectorTy();
76 }
77 
78 bool EVT::isExtended16BitVector() const {
79   return isExtendedVector() && getExtendedSizeInBits() == 16;
80 }
81 
82 bool EVT::isExtended32BitVector() const {
83   return isExtendedVector() && getExtendedSizeInBits() == 32;
84 }
85 
86 bool EVT::isExtended64BitVector() const {
87   return isExtendedVector() && getExtendedSizeInBits() == 64;
88 }
89 
90 bool EVT::isExtended128BitVector() const {
91   return isExtendedVector() && getExtendedSizeInBits() == 128;
92 }
93 
94 bool EVT::isExtended256BitVector() const {
95   return isExtendedVector() && getExtendedSizeInBits() == 256;
96 }
97 
98 bool EVT::isExtended512BitVector() const {
99   return isExtendedVector() && getExtendedSizeInBits() == 512;
100 }
101 
102 bool EVT::isExtended1024BitVector() const {
103   return isExtendedVector() && getExtendedSizeInBits() == 1024;
104 }
105 
106 bool EVT::isExtended2048BitVector() const {
107   return isExtendedVector() && getExtendedSizeInBits() == 2048;
108 }
109 
110 bool EVT::isExtendedFixedLengthVector() const {
111   return isExtendedVector() && isa<FixedVectorType>(LLVMTy);
112 }
113 
114 bool EVT::isExtendedScalableVector() const {
115   return isExtendedVector() && isa<ScalableVectorType>(LLVMTy);
116 }
117 
118 EVT EVT::getExtendedVectorElementType() const {
119   assert(isExtended() && "Type is not extended!");
120   return EVT::getEVT(cast<VectorType>(LLVMTy)->getElementType());
121 }
122 
123 unsigned EVT::getExtendedVectorNumElements() const {
124   assert(isExtended() && "Type is not extended!");
125   return cast<VectorType>(LLVMTy)->getNumElements();
126 }
127 
128 ElementCount EVT::getExtendedVectorElementCount() const {
129   assert(isExtended() && "Type is not extended!");
130   return cast<VectorType>(LLVMTy)->getElementCount();
131 }
132 
133 TypeSize EVT::getExtendedSizeInBits() const {
134   assert(isExtended() && "Type is not extended!");
135   if (IntegerType *ITy = dyn_cast<IntegerType>(LLVMTy))
136     return TypeSize::Fixed(ITy->getBitWidth());
137   if (VectorType *VTy = dyn_cast<VectorType>(LLVMTy))
138     return VTy->getPrimitiveSizeInBits();
139   llvm_unreachable("Unrecognized extended type!");
140 }
141 
142 /// getEVTString - This function returns value type as a string, e.g. "i32".
143 std::string EVT::getEVTString() const {
144   switch (V.SimpleTy) {
145   default:
146     if (isVector())
147       return (isScalableVector() ? "nxv" : "v")
148              + utostr(getVectorElementCount().Min)
149              + getVectorElementType().getEVTString();
150     if (isInteger())
151       return "i" + utostr(getSizeInBits());
152     if (isFloatingPoint())
153       return "f" + utostr(getSizeInBits());
154     llvm_unreachable("Invalid EVT!");
155   case MVT::bf16:    return "bf16";
156   case MVT::ppcf128: return "ppcf128";
157   case MVT::isVoid:  return "isVoid";
158   case MVT::Other:   return "ch";
159   case MVT::Glue:    return "glue";
160   case MVT::x86mmx:  return "x86mmx";
161   case MVT::Metadata:return "Metadata";
162   case MVT::Untyped: return "Untyped";
163   case MVT::exnref : return "exnref";
164   }
165 }
166 
167 /// getTypeForEVT - This method returns an LLVM type corresponding to the
168 /// specified EVT.  For integer types, this returns an unsigned type.  Note
169 /// that this will abort for types that cannot be represented.
170 Type *EVT::getTypeForEVT(LLVMContext &Context) const {
171   switch (V.SimpleTy) {
172   default:
173     assert(isExtended() && "Type is not extended!");
174     return LLVMTy;
175   case MVT::isVoid:  return Type::getVoidTy(Context);
176   case MVT::i1:      return Type::getInt1Ty(Context);
177   case MVT::i8:      return Type::getInt8Ty(Context);
178   case MVT::i16:     return Type::getInt16Ty(Context);
179   case MVT::i32:     return Type::getInt32Ty(Context);
180   case MVT::i64:     return Type::getInt64Ty(Context);
181   case MVT::i128:    return IntegerType::get(Context, 128);
182   case MVT::f16:     return Type::getHalfTy(Context);
183   case MVT::bf16:     return Type::getBFloatTy(Context);
184   case MVT::f32:     return Type::getFloatTy(Context);
185   case MVT::f64:     return Type::getDoubleTy(Context);
186   case MVT::f80:     return Type::getX86_FP80Ty(Context);
187   case MVT::f128:    return Type::getFP128Ty(Context);
188   case MVT::ppcf128: return Type::getPPC_FP128Ty(Context);
189   case MVT::x86mmx:  return Type::getX86_MMXTy(Context);
190   case MVT::v1i1:    return VectorType::get(Type::getInt1Ty(Context), 1);
191   case MVT::v2i1:    return VectorType::get(Type::getInt1Ty(Context), 2);
192   case MVT::v4i1:    return VectorType::get(Type::getInt1Ty(Context), 4);
193   case MVT::v8i1:    return VectorType::get(Type::getInt1Ty(Context), 8);
194   case MVT::v16i1:   return VectorType::get(Type::getInt1Ty(Context), 16);
195   case MVT::v32i1:   return VectorType::get(Type::getInt1Ty(Context), 32);
196   case MVT::v64i1:   return VectorType::get(Type::getInt1Ty(Context), 64);
197   case MVT::v128i1:  return VectorType::get(Type::getInt1Ty(Context), 128);
198   case MVT::v256i1:  return VectorType::get(Type::getInt1Ty(Context), 256);
199   case MVT::v512i1:  return VectorType::get(Type::getInt1Ty(Context), 512);
200   case MVT::v1024i1: return VectorType::get(Type::getInt1Ty(Context), 1024);
201   case MVT::v1i8:    return VectorType::get(Type::getInt8Ty(Context), 1);
202   case MVT::v2i8:    return VectorType::get(Type::getInt8Ty(Context), 2);
203   case MVT::v4i8:    return VectorType::get(Type::getInt8Ty(Context), 4);
204   case MVT::v8i8:    return VectorType::get(Type::getInt8Ty(Context), 8);
205   case MVT::v16i8:   return VectorType::get(Type::getInt8Ty(Context), 16);
206   case MVT::v32i8:   return VectorType::get(Type::getInt8Ty(Context), 32);
207   case MVT::v64i8:   return VectorType::get(Type::getInt8Ty(Context), 64);
208   case MVT::v128i8:  return VectorType::get(Type::getInt8Ty(Context), 128);
209   case MVT::v256i8:  return VectorType::get(Type::getInt8Ty(Context), 256);
210   case MVT::v1i16:   return VectorType::get(Type::getInt16Ty(Context), 1);
211   case MVT::v2i16:   return VectorType::get(Type::getInt16Ty(Context), 2);
212   case MVT::v3i16:   return VectorType::get(Type::getInt16Ty(Context), 3);
213   case MVT::v4i16:   return VectorType::get(Type::getInt16Ty(Context), 4);
214   case MVT::v8i16:   return VectorType::get(Type::getInt16Ty(Context), 8);
215   case MVT::v16i16:  return VectorType::get(Type::getInt16Ty(Context), 16);
216   case MVT::v32i16:  return VectorType::get(Type::getInt16Ty(Context), 32);
217   case MVT::v64i16:  return VectorType::get(Type::getInt16Ty(Context), 64);
218   case MVT::v128i16: return VectorType::get(Type::getInt16Ty(Context), 128);
219   case MVT::v1i32:   return VectorType::get(Type::getInt32Ty(Context), 1);
220   case MVT::v2i32:   return VectorType::get(Type::getInt32Ty(Context), 2);
221   case MVT::v3i32:   return VectorType::get(Type::getInt32Ty(Context), 3);
222   case MVT::v4i32:   return VectorType::get(Type::getInt32Ty(Context), 4);
223   case MVT::v5i32:   return VectorType::get(Type::getInt32Ty(Context), 5);
224   case MVT::v8i32:   return VectorType::get(Type::getInt32Ty(Context), 8);
225   case MVT::v16i32:  return VectorType::get(Type::getInt32Ty(Context), 16);
226   case MVT::v32i32:  return VectorType::get(Type::getInt32Ty(Context), 32);
227   case MVT::v64i32:  return VectorType::get(Type::getInt32Ty(Context), 64);
228   case MVT::v128i32: return VectorType::get(Type::getInt32Ty(Context), 128);
229   case MVT::v256i32: return VectorType::get(Type::getInt32Ty(Context), 256);
230   case MVT::v512i32: return VectorType::get(Type::getInt32Ty(Context), 512);
231   case MVT::v1024i32:return VectorType::get(Type::getInt32Ty(Context), 1024);
232   case MVT::v2048i32:return VectorType::get(Type::getInt32Ty(Context), 2048);
233   case MVT::v1i64:   return VectorType::get(Type::getInt64Ty(Context), 1);
234   case MVT::v2i64:   return VectorType::get(Type::getInt64Ty(Context), 2);
235   case MVT::v4i64:   return VectorType::get(Type::getInt64Ty(Context), 4);
236   case MVT::v8i64:   return VectorType::get(Type::getInt64Ty(Context), 8);
237   case MVT::v16i64:  return VectorType::get(Type::getInt64Ty(Context), 16);
238   case MVT::v32i64:  return VectorType::get(Type::getInt64Ty(Context), 32);
239   case MVT::v1i128:  return VectorType::get(Type::getInt128Ty(Context), 1);
240   case MVT::v2f16:   return VectorType::get(Type::getHalfTy(Context), 2);
241   case MVT::v3f16:   return VectorType::get(Type::getHalfTy(Context), 3);
242   case MVT::v4f16:   return VectorType::get(Type::getHalfTy(Context), 4);
243   case MVT::v8f16:   return VectorType::get(Type::getHalfTy(Context), 8);
244   case MVT::v16f16:  return VectorType::get(Type::getHalfTy(Context), 16);
245   case MVT::v32f16:  return VectorType::get(Type::getHalfTy(Context), 32);
246   case MVT::v2bf16:  return VectorType::get(Type::getBFloatTy(Context), 2);
247   case MVT::v3bf16:  return VectorType::get(Type::getBFloatTy(Context), 3);
248   case MVT::v4bf16:  return VectorType::get(Type::getBFloatTy(Context), 4);
249   case MVT::v8bf16:  return VectorType::get(Type::getBFloatTy(Context), 8);
250   case MVT::v16bf16: return VectorType::get(Type::getBFloatTy(Context), 16);
251   case MVT::v32bf16: return VectorType::get(Type::getBFloatTy(Context), 32);
252   case MVT::v1f32:   return VectorType::get(Type::getFloatTy(Context), 1);
253   case MVT::v2f32:   return VectorType::get(Type::getFloatTy(Context), 2);
254   case MVT::v3f32:   return VectorType::get(Type::getFloatTy(Context), 3);
255   case MVT::v4f32:   return VectorType::get(Type::getFloatTy(Context), 4);
256   case MVT::v5f32:   return VectorType::get(Type::getFloatTy(Context), 5);
257   case MVT::v8f32:   return VectorType::get(Type::getFloatTy(Context), 8);
258   case MVT::v16f32:  return VectorType::get(Type::getFloatTy(Context), 16);
259   case MVT::v32f32:  return VectorType::get(Type::getFloatTy(Context), 32);
260   case MVT::v64f32:  return VectorType::get(Type::getFloatTy(Context), 64);
261   case MVT::v128f32: return VectorType::get(Type::getFloatTy(Context), 128);
262   case MVT::v256f32: return VectorType::get(Type::getFloatTy(Context), 256);
263   case MVT::v512f32: return VectorType::get(Type::getFloatTy(Context), 512);
264   case MVT::v1024f32:return VectorType::get(Type::getFloatTy(Context), 1024);
265   case MVT::v2048f32:return VectorType::get(Type::getFloatTy(Context), 2048);
266   case MVT::v1f64:   return VectorType::get(Type::getDoubleTy(Context), 1);
267   case MVT::v2f64:   return VectorType::get(Type::getDoubleTy(Context), 2);
268   case MVT::v4f64:   return VectorType::get(Type::getDoubleTy(Context), 4);
269   case MVT::v8f64:   return VectorType::get(Type::getDoubleTy(Context), 8);
270   case MVT::v16f64:  return VectorType::get(Type::getDoubleTy(Context), 16);
271   case MVT::nxv1i1:
272     return VectorType::get(Type::getInt1Ty(Context), 1, /*Scalable=*/ true);
273   case MVT::nxv2i1:
274     return VectorType::get(Type::getInt1Ty(Context), 2, /*Scalable=*/ true);
275   case MVT::nxv4i1:
276     return VectorType::get(Type::getInt1Ty(Context), 4, /*Scalable=*/ true);
277   case MVT::nxv8i1:
278     return VectorType::get(Type::getInt1Ty(Context), 8, /*Scalable=*/ true);
279   case MVT::nxv16i1:
280     return VectorType::get(Type::getInt1Ty(Context), 16, /*Scalable=*/ true);
281   case MVT::nxv32i1:
282     return VectorType::get(Type::getInt1Ty(Context), 32, /*Scalable=*/ true);
283   case MVT::nxv1i8:
284     return VectorType::get(Type::getInt8Ty(Context), 1, /*Scalable=*/ true);
285   case MVT::nxv2i8:
286     return VectorType::get(Type::getInt8Ty(Context), 2, /*Scalable=*/ true);
287   case MVT::nxv4i8:
288     return VectorType::get(Type::getInt8Ty(Context), 4, /*Scalable=*/ true);
289   case MVT::nxv8i8:
290     return VectorType::get(Type::getInt8Ty(Context), 8, /*Scalable=*/ true);
291   case MVT::nxv16i8:
292     return VectorType::get(Type::getInt8Ty(Context), 16, /*Scalable=*/ true);
293   case MVT::nxv32i8:
294     return VectorType::get(Type::getInt8Ty(Context), 32, /*Scalable=*/ true);
295   case MVT::nxv1i16:
296     return VectorType::get(Type::getInt16Ty(Context), 1, /*Scalable=*/ true);
297   case MVT::nxv2i16:
298     return VectorType::get(Type::getInt16Ty(Context), 2, /*Scalable=*/ true);
299   case MVT::nxv4i16:
300     return VectorType::get(Type::getInt16Ty(Context), 4, /*Scalable=*/ true);
301   case MVT::nxv8i16:
302     return VectorType::get(Type::getInt16Ty(Context), 8, /*Scalable=*/ true);
303   case MVT::nxv16i16:
304     return VectorType::get(Type::getInt16Ty(Context), 16, /*Scalable=*/ true);
305   case MVT::nxv32i16:
306     return VectorType::get(Type::getInt16Ty(Context), 32, /*Scalable=*/ true);
307   case MVT::nxv1i32:
308     return VectorType::get(Type::getInt32Ty(Context), 1, /*Scalable=*/ true);
309   case MVT::nxv2i32:
310     return VectorType::get(Type::getInt32Ty(Context), 2, /*Scalable=*/ true);
311   case MVT::nxv4i32:
312     return VectorType::get(Type::getInt32Ty(Context), 4, /*Scalable=*/ true);
313   case MVT::nxv8i32:
314     return VectorType::get(Type::getInt32Ty(Context), 8, /*Scalable=*/ true);
315   case MVT::nxv16i32:
316     return VectorType::get(Type::getInt32Ty(Context), 16,/*Scalable=*/ true);
317   case MVT::nxv32i32:
318     return VectorType::get(Type::getInt32Ty(Context), 32,/*Scalable=*/ true);
319   case MVT::nxv1i64:
320     return VectorType::get(Type::getInt64Ty(Context), 1, /*Scalable=*/ true);
321   case MVT::nxv2i64:
322     return VectorType::get(Type::getInt64Ty(Context), 2, /*Scalable=*/ true);
323   case MVT::nxv4i64:
324     return VectorType::get(Type::getInt64Ty(Context), 4, /*Scalable=*/ true);
325   case MVT::nxv8i64:
326     return VectorType::get(Type::getInt64Ty(Context), 8, /*Scalable=*/ true);
327   case MVT::nxv16i64:
328     return VectorType::get(Type::getInt64Ty(Context), 16, /*Scalable=*/ true);
329   case MVT::nxv32i64:
330     return VectorType::get(Type::getInt64Ty(Context), 32, /*Scalable=*/ true);
331   case MVT::nxv2f16:
332     return VectorType::get(Type::getHalfTy(Context), 2, /*Scalable=*/ true);
333   case MVT::nxv4f16:
334     return VectorType::get(Type::getHalfTy(Context), 4, /*Scalable=*/ true);
335   case MVT::nxv8f16:
336     return VectorType::get(Type::getHalfTy(Context), 8, /*Scalable=*/ true);
337   case MVT::nxv2bf16:
338     return VectorType::get(Type::getBFloatTy(Context), 2, /*Scalable=*/ true);
339   case MVT::nxv4bf16:
340     return VectorType::get(Type::getBFloatTy(Context), 4, /*Scalable=*/ true);
341   case MVT::nxv8bf16:
342     return VectorType::get(Type::getBFloatTy(Context), 8, /*Scalable=*/ true);
343   case MVT::nxv1f32:
344     return VectorType::get(Type::getFloatTy(Context), 1, /*Scalable=*/ true);
345   case MVT::nxv2f32:
346     return VectorType::get(Type::getFloatTy(Context), 2, /*Scalable=*/ true);
347   case MVT::nxv4f32:
348     return VectorType::get(Type::getFloatTy(Context), 4, /*Scalable=*/ true);
349   case MVT::nxv8f32:
350     return VectorType::get(Type::getFloatTy(Context), 8, /*Scalable=*/ true);
351   case MVT::nxv16f32:
352     return VectorType::get(Type::getFloatTy(Context), 16, /*Scalable=*/ true);
353   case MVT::nxv1f64:
354     return VectorType::get(Type::getDoubleTy(Context), 1, /*Scalable=*/ true);
355   case MVT::nxv2f64:
356     return VectorType::get(Type::getDoubleTy(Context), 2, /*Scalable=*/ true);
357   case MVT::nxv4f64:
358     return VectorType::get(Type::getDoubleTy(Context), 4, /*Scalable=*/ true);
359   case MVT::nxv8f64:
360     return VectorType::get(Type::getDoubleTy(Context), 8, /*Scalable=*/ true);
361   case MVT::Metadata: return Type::getMetadataTy(Context);
362   }
363 }
364 
365 /// Return the value type corresponding to the specified type.  This returns all
366 /// pointers as MVT::iPTR.  If HandleUnknown is true, unknown types are returned
367 /// as Other, otherwise they are invalid.
368 MVT MVT::getVT(Type *Ty, bool HandleUnknown){
369   switch (Ty->getTypeID()) {
370   default:
371     if (HandleUnknown) return MVT(MVT::Other);
372     llvm_unreachable("Unknown type!");
373   case Type::VoidTyID:
374     return MVT::isVoid;
375   case Type::IntegerTyID:
376     return getIntegerVT(cast<IntegerType>(Ty)->getBitWidth());
377   case Type::HalfTyID:      return MVT(MVT::f16);
378   case Type::BFloatTyID:    return MVT(MVT::bf16);
379   case Type::FloatTyID:     return MVT(MVT::f32);
380   case Type::DoubleTyID:    return MVT(MVT::f64);
381   case Type::X86_FP80TyID:  return MVT(MVT::f80);
382   case Type::X86_MMXTyID:   return MVT(MVT::x86mmx);
383   case Type::FP128TyID:     return MVT(MVT::f128);
384   case Type::PPC_FP128TyID: return MVT(MVT::ppcf128);
385   case Type::PointerTyID:   return MVT(MVT::iPTR);
386   case Type::FixedVectorTyID:
387   case Type::ScalableVectorTyID: {
388     VectorType *VTy = cast<VectorType>(Ty);
389     return getVectorVT(
390       getVT(VTy->getElementType(), /*HandleUnknown=*/ false),
391             VTy->getElementCount());
392   }
393   }
394 }
395 
396 /// getEVT - Return the value type corresponding to the specified type.  This
397 /// returns all pointers as MVT::iPTR.  If HandleUnknown is true, unknown types
398 /// are returned as Other, otherwise they are invalid.
399 EVT EVT::getEVT(Type *Ty, bool HandleUnknown){
400   switch (Ty->getTypeID()) {
401   default:
402     return MVT::getVT(Ty, HandleUnknown);
403   case Type::IntegerTyID:
404     return getIntegerVT(Ty->getContext(), cast<IntegerType>(Ty)->getBitWidth());
405   case Type::FixedVectorTyID:
406   case Type::ScalableVectorTyID: {
407     VectorType *VTy = cast<VectorType>(Ty);
408     return getVectorVT(Ty->getContext(),
409                        getEVT(VTy->getElementType(), /*HandleUnknown=*/ false),
410                        VTy->getElementCount());
411   }
412   }
413 }
414