type.h

Go to the documentation of this file.

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
 
#ifndef TVM_IR_TYPE_H_
#define TVM_IR_TYPE_H_
 
#include <tvm/ir/source_map.h>
#include <tvm/node/node.h>
#include <tvm/runtime/container/array.h>
#include <tvm/runtime/data_type.h>
#include <tvm/runtime/object.h>
 
#include <string>
 
namespace tvm {
 
class TypeNode : public Object {
 public:
  mutable Span span;
 
  static constexpr const char* _type_key = "Type";
  static constexpr const bool _type_has_method_sequal_reduce = true;
  static constexpr const bool _type_has_method_shash_reduce = true;
  static constexpr const uint32_t _type_child_slots = 14;
  TVM_DECLARE_BASE_OBJECT_INFO(TypeNode, Object);
};
 
class Type : public ObjectRef {
 public:
  TVM_DEFINE_OBJECT_REF_METHODS(Type, ObjectRef, TypeNode);
};
 
class PrimTypeNode : public TypeNode {
 public:
  runtime::DataType dtype;
 
  void VisitAttrs(AttrVisitor* v) { v->Visit("dtype", &dtype); }
 
  bool SEqualReduce(const PrimTypeNode* other, SEqualReducer equal) const {
    return equal(dtype, other->dtype);
  }
 
  void SHashReduce(SHashReducer hash_reduce) const { hash_reduce(dtype); }
 
  static constexpr const char* _type_key = "PrimType";
  TVM_DECLARE_FINAL_OBJECT_INFO(PrimTypeNode, TypeNode);
};
 
/*
 * \brief Managed reference to PrimTypeNode.
 * \sa PrimTypeNode
 */
class PrimType : public Type {
 public:
  TVM_DLL explicit PrimType(runtime::DataType dtype, Span span = Span());
 
  TVM_DEFINE_OBJECT_REF_METHODS(PrimType, Type, PrimTypeNode);
};
 
class PointerTypeNode : public TypeNode {
 public:
  Type element_type;
  String storage_scope;
 
  void VisitAttrs(AttrVisitor* v) {
    v->Visit("element_type", &element_type);
    v->Visit("storage_scope", &storage_scope);
  }
 
  bool SEqualReduce(const PointerTypeNode* other, SEqualReducer equal) const {
    // Make "global" equal to ""
    String lhs_scope = storage_scope.empty() ? "global" : storage_scope;
    String rhs_scope = other->storage_scope.empty() ? "global" : other->storage_scope;
    return equal(element_type, other->element_type) && equal(lhs_scope, rhs_scope);
  }
 
  void SHashReduce(SHashReducer hash_reduce) const {
    hash_reduce(element_type);
    // Make "global" equal to ""
    hash_reduce(storage_scope.empty() ? "global" : storage_scope);
  }
 
  static constexpr const char* _type_key = "PointerType";
  TVM_DECLARE_FINAL_OBJECT_INFO(PointerTypeNode, TypeNode);
};
 
/*
 * \brief Managed reference to PointerTypeNode.
 * \sa PointerTypeNode
 */
class PointerType : public Type {
 public:
  TVM_DLL explicit PointerType(Type element_type, String storage_scope = "");
 
  TVM_DEFINE_OBJECT_REF_METHODS(PointerType, Type, PointerTypeNode);
};
 
enum TypeKind : int {
  kType = 0,
  kShapeVar = 1,
  kBaseType = 2,
  kConstraint = 4,
  kAdtHandle = 5,
  kTypeData = 6
};
 
inline String TypeKind2String(TypeKind kind) {
  switch (kind) {
    case TypeKind::kType:
      return "Type";
    case TypeKind::kShapeVar:
      return "ShapeVar";
    case TypeKind::kBaseType:
      return "BaseType";
    case TypeKind::kConstraint:
      return "Constraint";
    case TypeKind::kAdtHandle:
      return "AdtHandle";
    case TypeKind::kTypeData:
      return "TypeData";
  }
  LOG(FATAL) << "ValueError: Unknown TypeKind: " << static_cast<int>(kind);
}
 
class TypeVarNode : public TypeNode {
 public:
  String name_hint;
  TypeKind kind;
 
  void VisitAttrs(AttrVisitor* v) {
    v->Visit("name_hint", &name_hint);
    v->Visit("kind", &kind);
    v->Visit("span", &span);
  }
 
  bool SEqualReduce(const TypeVarNode* other, SEqualReducer equal) const {
    return equal(kind, other->kind) && equal.FreeVarEqualImpl(this, other);
  }
 
  void SHashReduce(SHashReducer hash_reduce) const {
    hash_reduce(kind);
    hash_reduce.FreeVarHashImpl(this);
  }
 
  static constexpr const char* _type_key = "TypeVar";
  TVM_DECLARE_FINAL_OBJECT_INFO(TypeVarNode, TypeNode);
};
 
class TypeVar : public Type {
 public:
  TVM_DLL TypeVar(String name_hint, TypeKind kind, Span span = Span());
 
  TVM_DEFINE_OBJECT_REF_METHODS(TypeVar, Type, TypeVarNode);
};
 
class GlobalTypeVarNode : public TypeNode {
 public:
  String name_hint;
  TypeKind kind;
 
  void VisitAttrs(AttrVisitor* v) {
    v->Visit("name_hint", &name_hint);
    v->Visit("kind", &kind);
  }
 
  bool SEqualReduce(const GlobalTypeVarNode* other, SEqualReducer equal) const {
    // name matters for now in global type var.
    return equal(name_hint, other->name_hint) && equal.FreeVarEqualImpl(this, other);
  }
 
  void SHashReduce(SHashReducer hash_reduce) const {
    hash_reduce(name_hint);
    hash_reduce.FreeVarHashImpl(this);
  }
 
  static constexpr const char* _type_key = "GlobalTypeVar";
  TVM_DECLARE_FINAL_OBJECT_INFO(GlobalTypeVarNode, TypeNode);
};
 
class GlobalTypeVar : public Type {
 public:
  TVM_DLL GlobalTypeVar(String name_hint, TypeKind kind, Span span = Span());
 
  TVM_DEFINE_OBJECT_REF_METHODS(GlobalTypeVar, Type, GlobalTypeVarNode);
};
 
class TupleTypeNode : public TypeNode {
 public:
  Array<Type> fields;
 
  TupleTypeNode() {}
 
  void VisitAttrs(AttrVisitor* v) {
    v->Visit("fields", &fields);
    v->Visit("span", &span);
  }
 
  bool SEqualReduce(const TupleTypeNode* other, SEqualReducer equal) const {
    return equal(fields, other->fields);
  }
 
  void SHashReduce(SHashReducer hash_reduce) const { hash_reduce(fields); }
 
  static constexpr const char* _type_key = "TupleType";
  TVM_DECLARE_FINAL_OBJECT_INFO(TupleTypeNode, TypeNode);
};
 
class TupleType : public Type {
 public:
  TVM_DLL explicit TupleType(Array<Type> fields, Span span = Span());
 
  TVM_DLL TupleType static Empty();
 
  TVM_DEFINE_OBJECT_REF_METHODS(TupleType, Type, TupleTypeNode);
};
 
inline Type VoidType() { return TupleType::Empty(); }
 
inline bool IsVoidType(const Type& type) {
  auto* n = type.as<TupleTypeNode>();
  return n && n->fields.size() == 0;
}
 
class TypeConstraintNode : public TypeNode {
 public:
  static constexpr const char* _type_key = "TypeConstraint";
  static constexpr const uint32_t _type_child_slots = 1;
  TVM_DECLARE_BASE_OBJECT_INFO(TypeConstraintNode, TypeNode);
};
 
class TypeConstraint : public Type {
 public:
  TVM_DEFINE_OBJECT_REF_METHODS(TypeConstraint, Type, TypeConstraintNode);
};
 
class FuncTypeNode : public TypeNode {
 public:
  Array<Type> arg_types;
  Type ret_type;
  // The following fields are used in polymorphic(template) functions
  // For normal functions, the following two fields will be empty.
  Array<TypeVar> type_params;
  Array<TypeConstraint> type_constraints;
 
  void VisitAttrs(AttrVisitor* v) {
    v->Visit("arg_types", &arg_types);
    v->Visit("ret_type", &ret_type);
    v->Visit("type_params", &type_params);
    v->Visit("type_constraints", &type_constraints);
    v->Visit("span", &span);
  }
 
  bool SEqualReduce(const FuncTypeNode* other, SEqualReducer equal) const {
    // type params first as they defines type vars.
    return equal.DefEqual(type_params, other->type_params) && equal(arg_types, other->arg_types) &&
           equal(ret_type, other->ret_type) && equal(type_constraints, other->type_constraints);
  }
 
  void SHashReduce(SHashReducer hash_reduce) const {
    hash_reduce.DefHash(type_params);
    hash_reduce(arg_types);
    hash_reduce(ret_type);
    hash_reduce(type_constraints);
  }
 
  static constexpr const char* _type_key = "FuncType";
  TVM_DECLARE_FINAL_OBJECT_INFO(FuncTypeNode, TypeNode);
};
 
class FuncType : public Type {
 public:
  TVM_DLL FuncType(Array<Type> arg_types, Type ret_type, Array<TypeVar> type_params,
                   Array<TypeConstraint> type_constraints, Span span = Span());
 
  TVM_DEFINE_OBJECT_REF_METHODS(FuncType, Type, FuncTypeNode);
};
 
class IncompleteTypeNode : public TypeNode {
 public:
  TypeKind kind;
 
  void VisitAttrs(tvm::AttrVisitor* v) {
    v->Visit("kind", &kind);
    v->Visit("span", &span);
  }
 
  bool SEqualReduce(const IncompleteTypeNode* other, SEqualReducer equal) const {
    return equal(kind, other->kind) && equal.FreeVarEqualImpl(this, other);
  }
 
  void SHashReduce(SHashReducer hash_reduce) const { hash_reduce(kind); }
 
  static constexpr const char* _type_key = "IncompleteType";
  TVM_DECLARE_FINAL_OBJECT_INFO(IncompleteTypeNode, TypeNode);
};
 
class IncompleteType : public Type {
 public:
  TVM_DLL explicit IncompleteType(TypeKind kind, Span span = Span());
 
  TVM_DEFINE_OBJECT_REF_METHODS(IncompleteType, Type, IncompleteTypeNode);
};
 
class RelayRefTypeNode : public TypeNode {
 public:
  Type value;
 
  RelayRefTypeNode() {}
 
  void VisitAttrs(tvm::AttrVisitor* v) {
    v->Visit("value", &value);
    v->Visit("span", &span);
  }
 
  bool SEqualReduce(const RelayRefTypeNode* other, SEqualReducer equal) const {
    return equal(value, other->value);
  }
 
  void SHashReduce(SHashReducer hash_reduce) const { hash_reduce(value); }
 
  // Keep the relay prefix in the type as this type is specific
  // to the relay itself.
  static constexpr const char* _type_key = "relay.RefType";
  TVM_DECLARE_FINAL_OBJECT_INFO(RelayRefTypeNode, TypeNode);
};
 
class RelayRefType : public Type {
 public:
  TVM_DLL explicit RelayRefType(Type value, Span span = Span());
  TVM_DEFINE_OBJECT_REF_METHODS(RelayRefType, Type, RelayRefTypeNode);
};
}  // namespace tvm
#endif  // TVM_IR_TYPE_H_