tvm
type.h
Go to the documentation of this file.
1 /*
2  * Licensed to the Apache Software Foundation (ASF) under one
3  * or more contributor license agreements. See the NOTICE file
4  * distributed with this work for additional information
5  * regarding copyright ownership. The ASF licenses this file
6  * to you under the Apache License, Version 2.0 (the
7  * "License"); you may not use this file except in compliance
8  * with the License. You may obtain a copy of the License at
9  *
10  * http://www.apache.org/licenses/LICENSE-2.0
11  *
12  * Unless required by applicable law or agreed to in writing,
13  * software distributed under the License is distributed on an
14  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15  * KIND, either express or implied. See the License for the
16  * specific language governing permissions and limitations
17  * under the License.
18  */
19 
49 #ifndef TVM_IR_TYPE_H_
50 #define TVM_IR_TYPE_H_
51 
52 #include <tvm/ffi/container/array.h>
53 #include <tvm/ffi/reflection/registry.h>
54 #include <tvm/ir/source_map.h>
55 #include <tvm/node/node.h>
56 #include <tvm/runtime/data_type.h>
57 #include <tvm/runtime/object.h>
58 
59 #include <string>
60 
61 namespace tvm {
62 
75 class TypeNode : public Object {
76  public:
81  mutable Span span;
82 
83  static void RegisterReflection() {
84  namespace refl = tvm::ffi::reflection;
85  // span do not participate in structural equal and hash.
86  refl::ObjectDef<TypeNode>().def_ro("span", &TypeNode::span, refl::DefaultValue(Span()),
87  refl::AttachFieldFlag::SEqHashIgnore());
88  }
89 
90  static constexpr TVMFFISEqHashKind _type_s_eq_hash_kind = kTVMFFISEqHashKindTreeNode;
91 
92  static constexpr const uint32_t _type_child_slots = 14;
94 };
95 
100 class Type : public ObjectRef {
101  public:
103 };
104 
113 class PrimTypeNode : public TypeNode {
114  public:
119 
120  static void RegisterReflection() {
121  namespace refl = tvm::ffi::reflection;
122  refl::ObjectDef<PrimTypeNode>().def_ro("dtype", &PrimTypeNode::dtype);
123  }
125 };
126 
127 /*
128  * \brief Managed reference to PrimTypeNode.
129  * \sa PrimTypeNode
130  */
131 class PrimType : public Type {
132  public:
138  TVM_DLL explicit PrimType(runtime::DataType dtype, Span span = Span());
139 
141 };
142 
153 class PointerTypeNode : public TypeNode {
154  public:
162  ffi::String storage_scope;
163 
164  static void RegisterReflection() {
165  namespace refl = tvm::ffi::reflection;
166  refl::ObjectDef<PointerTypeNode>()
167  .def_ro("element_type", &PointerTypeNode::element_type)
168  .def_ro("storage_scope", &PointerTypeNode::storage_scope);
169  }
171 };
172 
173 /*
174  * \brief Managed reference to PointerTypeNode.
175  * \sa PointerTypeNode
176  */
177 class PointerType : public Type {
178  public:
184  TVM_DLL explicit PointerType(Type element_type, ffi::String storage_scope = "");
185 
187 };
188 
193 class TupleTypeNode : public TypeNode {
194  public:
196  ffi::Array<Type> fields;
197 
199 
200  static void RegisterReflection() {
201  namespace refl = tvm::ffi::reflection;
202  refl::ObjectDef<TupleTypeNode>()
203  .def_ro("fields", &TupleTypeNode::fields)
204  .def_ro("span", &TupleTypeNode::span);
205  }
207 };
208 
213 class TupleType : public Type {
214  public:
220  TVM_DLL explicit TupleType(ffi::Array<Type> fields, Span span = Span());
221 
226  TVM_DLL TupleType static Empty();
227 
229 };
230 
234 inline Type VoidType() { return TupleType::Empty(); }
235 
240 inline bool IsVoidType(const Type& type) {
241  auto* n = type.as<TupleTypeNode>();
242  return n && n->fields.size() == 0;
243 }
244 
253 class FuncTypeNode : public TypeNode {
254  public:
256  ffi::Array<Type> arg_types;
259 
260  static void RegisterReflection() {
261  namespace refl = tvm::ffi::reflection;
262  refl::ObjectDef<FuncTypeNode>()
263  .def_ro("arg_types", &FuncTypeNode::arg_types)
264  .def_ro("ret_type", &FuncTypeNode::ret_type)
265  .def_ro("span", &FuncTypeNode::span);
266  }
268 };
269 
274 class FuncType : public Type {
275  public:
283  TVM_DLL FuncType(ffi::Array<Type> arg_types, Type ret_type, Span span = Span());
284 
286 };
287 
292 class TensorMapTypeNode : public TypeNode {
293  public:
294  static void RegisterReflection() {
295  namespace refl = tvm::ffi::reflection;
296  refl::ObjectDef<TensorMapTypeNode>().def_ro("span", &TensorMapTypeNode::span);
297  }
299 };
300 
305 class TensorMapType : public Type {
306  public:
307  TVM_DLL TensorMapType(Span span = Span());
308 
311 };
312 
313 } // namespace tvm
314 #endif // TVM_IR_TYPE_H_
Function type.
Definition: type.h:253
TVM_FFI_DECLARE_OBJECT_INFO_FINAL("ir.FuncType", FuncTypeNode, TypeNode)
Type ret_type
The type of return value.
Definition: type.h:258
ffi::Array< Type > arg_types
type type of arguments
Definition: type.h:256
static void RegisterReflection()
Definition: type.h:260
Managed reference to FuncTypeNode.
Definition: type.h:274
FuncType(ffi::Array< Type > arg_types, Type ret_type, Span span=Span())
Constructor.
TVM_FFI_DEFINE_OBJECT_REF_METHODS_NULLABLE(FuncType, Type, FuncTypeNode)
Low-level raw pointer type.
Definition: type.h:153
Type element_type
The type of the element which the pointer points to.
Definition: type.h:158
ffi::String storage_scope
The storage scope of the pointer.
Definition: type.h:162
TVM_FFI_DECLARE_OBJECT_INFO_FINAL("ir.PointerType", PointerTypeNode, TypeNode)
static void RegisterReflection()
Definition: type.h:164
Definition: type.h:177
PointerType(Type element_type, ffi::String storage_scope="")
Constructor.
TVM_FFI_DEFINE_OBJECT_REF_METHODS_NULLABLE(PointerType, Type, PointerTypeNode)
Primitive data types used in the low-level IR.
Definition: type.h:113
runtime::DataType dtype
The corresponding dtype field.
Definition: type.h:118
TVM_FFI_DECLARE_OBJECT_INFO_FINAL("ir.PrimType", PrimTypeNode, TypeNode)
static void RegisterReflection()
Definition: type.h:120
Definition: type.h:131
PrimType(runtime::DataType dtype, Span span=Span())
Constructor.
TVM_FFI_DEFINE_OBJECT_REF_METHODS_NULLABLE(PrimType, Type, PrimTypeNode)
Definition: source_map.h:111
The type of tensor map.
Definition: type.h:292
static void RegisterReflection()
Definition: type.h:294
TVM_FFI_DECLARE_OBJECT_INFO_FINAL("ir.TensorMapType", TensorMapTypeNode, TypeNode)
Managed reference to TensorMapTypeNode.
Definition: type.h:305
TensorMapType(Span span=Span())
TVM_FFI_DEFINE_OBJECT_REF_METHODS_NULLABLE_WITHOUT_DEFAULT_CONSTRUCTOR(TensorMapType, Type, TensorMapTypeNode)
The type of tuple values.
Definition: type.h:193
TupleTypeNode()
Definition: type.h:198
TVM_FFI_DECLARE_OBJECT_INFO_FINAL("ir.TupleType", TupleTypeNode, TypeNode)
static void RegisterReflection()
Definition: type.h:200
ffi::Array< Type > fields
The type of each field in the tuple.
Definition: type.h:196
Managed reference to TupleTypeNode.
Definition: type.h:213
TVM_FFI_DEFINE_OBJECT_REF_METHODS_NULLABLE(TupleType, Type, TupleTypeNode)
TupleType(ffi::Array< Type > fields, Span span=Span())
Constructor.
static TupleType Empty()
Create an empty tuple type that constains nothing.
Type is the base type of all types.
Definition: type.h:75
TVM_FFI_DECLARE_OBJECT_INFO("ir.Type", TypeNode, Object)
static constexpr const uint32_t _type_child_slots
Definition: type.h:92
static constexpr TVMFFISEqHashKind _type_s_eq_hash_kind
Definition: type.h:90
static void RegisterReflection()
Definition: type.h:83
Span span
Span that points to the original source code. Reserved debug information.
Definition: type.h:81
Managed reference to TypeNode.
Definition: type.h:100
TVM_FFI_DEFINE_OBJECT_REF_METHODS_NULLABLE(Type, ObjectRef, TypeNode)
Runtime primitive data type.
Definition: data_type.h:47
Definition: repr_printer.h:91
Performance counters for profiling via the PAPI library.
Definition: analyzer.h:37
bool IsVoidType(const Type &type)
Check whether the tyep represents void.
Definition: type.h:240
Type VoidType()
Definition: type.h:234
Definitions and helper macros for IR/AST nodes.
A managed object in the TVM runtime.
A map from source names to source code.