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/ffi/cast.h>
#include <tvm/ffi/container/array.h>
#include <tvm/ffi/reflection/registry.h>
#include <tvm/ir/source_map.h>
#include <tvm/runtime/data_type.h>
 
#include <string>
 
namespace tvm {
 
class TypeNode : public ffi::Object {
 public:
  mutable Span span;
 
  static void RegisterReflection() {
    namespace refl = tvm::ffi::reflection;
    // span do not participate in structural equal and hash.
    refl::ObjectDef<TypeNode>().def_ro("span", &TypeNode::span, refl::DefaultValue(Span()),
                                       refl::AttachFieldFlag::SEqHashIgnore());
  }
 
  static constexpr TVMFFISEqHashKind _type_s_eq_hash_kind = kTVMFFISEqHashKindTreeNode;
 
  static constexpr const uint32_t _type_child_slots = 14;
  TVM_FFI_DECLARE_OBJECT_INFO("ir.Type", TypeNode, ffi::Object);
};
 
class Type : public ffi::ObjectRef {
 public:
  TVM_FFI_DEFINE_OBJECT_REF_METHODS_NULLABLE(Type, ffi::ObjectRef, TypeNode);
};
 
class PrimTypeNode : public TypeNode {
 public:
  runtime::DataType dtype;
 
  static void RegisterReflection() {
    namespace refl = tvm::ffi::reflection;
    refl::ObjectDef<PrimTypeNode>().def_ro("dtype", &PrimTypeNode::dtype);
  }
  TVM_FFI_DECLARE_OBJECT_INFO_FINAL("ir.PrimType", 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_FFI_DEFINE_OBJECT_REF_METHODS_NULLABLE(PrimType, Type, PrimTypeNode);
};
 
class PointerTypeNode : public TypeNode {
 public:
  Type element_type;
  ffi::String storage_scope;
 
  static void RegisterReflection() {
    namespace refl = tvm::ffi::reflection;
    refl::ObjectDef<PointerTypeNode>()
        .def_ro("element_type", &PointerTypeNode::element_type)
        .def_ro("storage_scope", &PointerTypeNode::storage_scope);
  }
  TVM_FFI_DECLARE_OBJECT_INFO_FINAL("ir.PointerType", PointerTypeNode, TypeNode);
};
 
/*
 * \brief Managed reference to PointerTypeNode.
 * \sa PointerTypeNode
 */
class PointerType : public Type {
 public:
  TVM_DLL explicit PointerType(Type element_type, ffi::String storage_scope = "");
 
  TVM_FFI_DEFINE_OBJECT_REF_METHODS_NULLABLE(PointerType, Type, PointerTypeNode);
};
 
class TupleTypeNode : public TypeNode {
 public:
  ffi::Array<Type> fields;
 
  TupleTypeNode() {}
 
  static void RegisterReflection() {
    namespace refl = tvm::ffi::reflection;
    refl::ObjectDef<TupleTypeNode>().def_ro("fields", &TupleTypeNode::fields);
  }
  TVM_FFI_DECLARE_OBJECT_INFO_FINAL("ir.TupleType", TupleTypeNode, TypeNode);
};
 
class TupleType : public Type {
 public:
  TVM_DLL explicit TupleType(ffi::Array<Type> fields, Span span = Span());
 
  TVM_DLL TupleType static Empty();
 
  TVM_FFI_DEFINE_OBJECT_REF_METHODS_NULLABLE(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 FuncTypeNode : public TypeNode {
 public:
  ffi::Array<Type> arg_types;
  Type ret_type;
 
  static void RegisterReflection() {
    namespace refl = tvm::ffi::reflection;
    refl::ObjectDef<FuncTypeNode>()
        .def_ro("arg_types", &FuncTypeNode::arg_types)
        .def_ro("ret_type", &FuncTypeNode::ret_type);
  }
  TVM_FFI_DECLARE_OBJECT_INFO_FINAL("ir.FuncType", FuncTypeNode, TypeNode);
};
 
class FuncType : public Type {
 public:
  TVM_DLL FuncType(ffi::Array<Type> arg_types, Type ret_type, Span span = Span());
 
  TVM_FFI_DEFINE_OBJECT_REF_METHODS_NULLABLE(FuncType, Type, FuncTypeNode);
};
 
class TensorMapTypeNode : public TypeNode {
 public:
  static void RegisterReflection() {
    namespace refl = tvm::ffi::reflection;
    refl::ObjectDef<TensorMapTypeNode>();
  }
  TVM_FFI_DECLARE_OBJECT_INFO_FINAL("ir.TensorMapType", TensorMapTypeNode, TypeNode);
};
 
class TensorMapType : public Type {
 public:
  TVM_DLL TensorMapType(Span span = Span());
 
  explicit TensorMapType(::tvm::ffi::ObjectPtr<TensorMapTypeNode> n) : Type(n) {}
  TensorMapType(const TensorMapType&) = default;
  TensorMapType(TensorMapType&&) = default;
  TensorMapType& operator=(const TensorMapType&) = default;
  TensorMapType& operator=(TensorMapType&&) = default;
  const TensorMapTypeNode* operator->() const {
    return static_cast<const TensorMapTypeNode*>(data_.get());
  }
  const TensorMapTypeNode* get() const { return operator->(); }
  using ContainerType = TensorMapTypeNode;
};
 
}  // namespace tvm
#endif  // TVM_IR_TYPE_H_