24 #ifndef TVM_RUNTIME_DATA_TYPE_H_
25 #define TVM_RUNTIME_DATA_TYPE_H_
27 #include <tvm/ffi/container/shape.h>
28 #include <tvm/ffi/dtype.h>
30 #include <tvm/runtime/logging.h>
34 #include <type_traits>
82 explicit DataType(DLDataType dtype) : data_(dtype) {}
91 data_.code =
static_cast<uint8_t
>(
code);
92 data_.bits =
static_cast<uint8_t
>(
bits);
94 ICHECK(
lanes > 1) <<
"Invalid value for vscale factor" <<
lanes;
96 data_.lanes = is_scalable ?
static_cast<uint16_t
>(-
lanes) :
static_cast<uint16_t
>(
lanes);
113 int code()
const {
return static_cast<int>(data_.code); }
115 int bits()
const {
return static_cast<int>(data_.bits); }
120 int lanes_as_int =
static_cast<int16_t
>(data_.lanes);
121 if (lanes_as_int < 0) {
122 LOG(FATAL) <<
"Can't fetch the lanes of a scalable vector at a compile time.";
128 int lanes_as_int =
static_cast<int16_t
>(data_.lanes);
129 if (lanes_as_int >= -1) {
130 LOG(FATAL) <<
"A fixed length vector doesn't have a vscale factor.";
132 return -lanes_as_int;
148 return bits() == 8 &&
156 return bits() == 6 &&
197 int encoded_lanes =
static_cast<int16_t
>(data_.lanes);
198 return (encoded_lanes < -1) || (1 < encoded_lanes);
253 return data_.code == other.data_.code && data_.bits == other.data_.bits &&
254 data_.lanes == other.data_.lanes;
266 operator DLDataType()
const {
return data_; }
403 if (std::is_signed<tvm_index_t>::value) {
420 int data_bits = dtype.
bits() * dtype.
lanes();
427 ICHECK_EQ(data_bits % 8, 0U) <<
"Need to load/store by multiple of bytes";
428 return data_bits / 8;
438 inline bool TypeMatch(DLDataType t,
int code,
int bits,
int lanes = 1) {
439 return t.code == code && t.bits == bits && t.lanes == lanes;
447 return lhs.code == rhs.code && lhs.bits == rhs.bits && lhs.lanes == rhs.lanes;
450 using ffi::DLDataTypeToString;
451 using ffi::StringToDLDataType;
454 return os << dtype.operator DLDataType();
464 struct TypeTraits<runtime::
DataType> :
public TypeTraitsBase {
465 static constexpr int32_t field_static_type_index = TypeIndex::kTVMFFIDataType;
469 result->v_uint64 = 0;
470 result->zero_padding = 0;
471 result->type_index = TypeIndex::kTVMFFIDataType;
472 result->v_dtype = src;
477 result->v_uint64 = 0;
478 result->zero_padding = 0;
479 result->type_index = TypeIndex::kTVMFFIDataType;
480 result->v_dtype = src;
484 auto opt_dtype = TypeTraits<DLDataType>::TryCastFromAnyView(src);
492 return TypeTraits<DLDataType>::CheckAnyStrict(src);
496 return runtime::DataType(TypeTraits<DLDataType>::CopyFromAnyViewAfterCheck(src));
499 TVM_FFI_INLINE
static std::string
TypeStr() {
return ffi::StaticTypeKey::kTVMFFIDataType; }
508 inline int cantor_pairing_function(
int a,
int b)
const {
return (a + b) * (a + b + 1) / 2 + b; }
510 int a = dtype.
code();
511 int b = dtype.
bits();
512 int c = dtype.
lanes();
513 int d = cantor_pairing_function(a, b);
514 return cantor_pairing_function(c, d);
Runtime primitive data type.
Definition: data_type.h:47
static DataType ShapeIndex()
Get the corresponding type of TVMShapeIndex.
Definition: data_type.h:402
bool is_handle() const
Definition: data_type.h:194
static DataType Float8E4M3FNUZ(int lanes=1)
Construct float8 e4m3fnuz datatype.
Definition: data_type.h:334
bool is_uint() const
Definition: data_type.h:192
int get_lanes_or_vscale_factor() const
Definition: data_type.h:135
bool is_float8_e5m2() const
Definition: data_type.h:174
static DataType Float4E2M1FN(int lanes=1)
Construct float4 e2m1fn datatype.
Definition: data_type.h:376
static DataType Float(int bits, int lanes=1)
Construct an float type.
Definition: data_type.h:291
bool is_float4_e2m1fn() const
Definition: data_type.h:184
bool is_float6() const
Definition: data_type.h:155
static DataType Float8E8M0FNU(int lanes=1)
Construct float8 e8m0fnu datatype.
Definition: data_type.h:355
DataType element_of() const
Get the scalar version of the type.
Definition: data_type.h:236
bool is_scalable_vector() const
Definition: data_type.h:203
bool is_float8_e4m3() const
Definition: data_type.h:164
DataType & operator=(const DataType &rhs)
Assignment operator.
Definition: data_type.h:240
static DataType Float8E4M3FN(int lanes=1)
Construct float8 e4m3fn datatype.
Definition: data_type.h:327
int bytes() const
Definition: data_type.h:117
TypeCode
Type code for the DataType.
Definition: data_type.h:57
@ kFloat8_e4m3b11fnuz
Definition: data_type.h:65
@ kHandle
Definition: data_type.h:61
@ kUInt
Definition: data_type.h:59
@ kFloat8_e4m3
Definition: data_type.h:64
@ kFloat6_e3m2fn
Definition: data_type.h:72
@ kFloat6_e2m3fn
Definition: data_type.h:71
@ kBFloat
Definition: data_type.h:62
@ kFloat
Definition: data_type.h:60
@ kFloat8_e4m3fn
Definition: data_type.h:66
@ kFloat8_e4m3fnuz
Definition: data_type.h:67
@ kCustomBegin
Definition: data_type.h:74
@ kFloat8_e8m0fnu
Definition: data_type.h:70
@ kFloat4_e2m1fn
Definition: data_type.h:73
@ kInt
Definition: data_type.h:58
@ kFloat8_e3m4
Definition: data_type.h:63
@ kFloat8_e5m2fnuz
Definition: data_type.h:69
@ kFloat8_e5m2
Definition: data_type.h:68
bool is_float6_e3m2fn() const
Definition: data_type.h:182
static DataType Float8E5M2FNUZ(int lanes=1)
Construct float8 e5m2fnuz datatype.
Definition: data_type.h:348
bool is_float8_e3m4() const
Definition: data_type.h:162
bool is_bool() const
Definition: data_type.h:141
static DataType Float8E4M3B11FNUZ(int lanes=1)
Construct float8 e4m3b11fnuz datatype.
Definition: data_type.h:318
bool is_int() const
Definition: data_type.h:190
DataType with_bits(int bits) const
Create a new data type by change bits to a specified value.
Definition: data_type.h:231
bool operator!=(const DataType &other) const
NotEqual comparator.
Definition: data_type.h:261
DataType()
default constructor
Definition: data_type.h:77
bool is_scalable_or_fixed_length_vector() const
Definition: data_type.h:196
int code() const
Definition: data_type.h:113
int lanes() const
Definition: data_type.h:119
static DataType Float8E5M2(int lanes=1)
Construct float8 e5m2 datatype.
Definition: data_type.h:341
DataType(int code, int bits, int lanes, bool is_scalable=false)
Constructor.
Definition: data_type.h:90
bool is_float8_e8m0fnu() const
Definition: data_type.h:178
static DataType Float6E2M3FN(int lanes=1)
Construct float6 e2m3fn datatype.
Definition: data_type.h:362
bool operator==(const DataType &other) const
Equal comparator.
Definition: data_type.h:252
bool is_float16() const
Definition: data_type.h:186
static DataType Bool(int lanes=1, bool is_scalable=false)
Construct a bool type.
Definition: data_type.h:383
DataType with_lanes(int lanes) const
Create a new data type by change lanes to a specified value.
Definition: data_type.h:217
static DataType Float6E3M2FN(int lanes=1)
Construct float6 e3m2fn datatype.
Definition: data_type.h:369
int vscale_factor() const
Definition: data_type.h:127
DataType(DLDataType dtype)
Constructor.
Definition: data_type.h:82
bool is_float8_e4m3b11fnuz() const
Definition: data_type.h:166
DataType with_scalable_vscale_factor(int vscale_factor) const
Create a new scalable vector data type by changing the vscale multiplier to a specified value....
Definition: data_type.h:223
bool is_float8_e4m3fnuz() const
Definition: data_type.h:172
bool is_fixed_length_vector() const
Definition: data_type.h:201
bool is_bfloat() const
Definition: data_type.h:145
static DataType BFloat(int bits, int lanes=1)
Construct an bfloat type.
Definition: data_type.h:298
static DataType Int(int bits, int lanes=1)
Construct an int type.
Definition: data_type.h:274
static DataType Void()
Construct a Void type.
Definition: data_type.h:397
bool is_vector() const
Definition: data_type.h:205
bool is_float6_e2m3fn() const
Definition: data_type.h:180
bool is_scalar() const
Definition: data_type.h:139
int bits() const
Definition: data_type.h:115
bool is_float8() const
Definition: data_type.h:147
bool is_bfloat16() const
Definition: data_type.h:188
bool is_float8_e4m3fn() const
Definition: data_type.h:170
bool is_vector_bool() const
Definition: data_type.h:207
bool is_float4() const
Definition: data_type.h:160
static DataType Handle(int bits=64, int lanes=1)
Construct a handle type.
Definition: data_type.h:392
static DataType UInt(int bits, int lanes=1, bool is_scalable=false)
Construct an uint type.
Definition: data_type.h:282
static DataType Float8E4M3(int lanes=1)
Construct float8 e4m3 datatype.
Definition: data_type.h:311
static DataType Float8E3M4(int lanes=1)
Construct float8 e3m4 datatype.
Definition: data_type.h:304
bool is_void() const
Definition: data_type.h:209
bool is_float8_e5m2fnuz() const
Definition: data_type.h:176
bool is_float() const
Definition: data_type.h:143
std::ostream & operator<<(std::ostream &os, const DataType &dtype)
Definition: data_type.h:453
ffi::Shape::index_type tvm_index_t
Definition: data_type.h:39
int GetVectorBytes(DataType dtype)
Get the number of bytes needed in a vector.
Definition: data_type.h:419
bool TypeMatch(DLDataType t, int code, int bits, int lanes=1)
Check whether type matches the given spec.
Definition: data_type.h:438
bool TypeEqual(DLDataType lhs, DLDataType rhs)
Check whether two types are equal .
Definition: data_type.h:446
Performance counters for profiling via the PAPI library.
Definition: analyzer.h:37
runtime::DataType DataType
Definition: data_type.h:458
static TVM_FFI_INLINE void MoveToAny(runtime::DataType src, TVMFFIAny *result)
Definition: data_type.h:475
static TVM_FFI_INLINE void CopyToAnyView(const runtime::DataType &src, TVMFFIAny *result)
Definition: data_type.h:467
static TVM_FFI_INLINE bool CheckAnyStrict(const TVMFFIAny *src)
Definition: data_type.h:491
static TVM_FFI_INLINE runtime::DataType CopyFromAnyViewAfterCheck(const TVMFFIAny *src)
Definition: data_type.h:495
static TVM_FFI_INLINE std::string TypeStr()
Definition: data_type.h:499
static TVM_FFI_INLINE std::optional< runtime::DataType > TryCastFromAnyView(const TVMFFIAny *src)
Definition: data_type.h:483