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/container/array.h>
#include <tvm/ffi/dtype.h>
#include <tvm/ffi/reflection/registry.h>
#include <tvm/ir/base_expr.h>
#include <tvm/ir/location.h>
 
#include <string>
 
namespace tvm {
 
class AnyTypeNode : public TypeNode {
 public:
  static void RegisterReflection() { ffi::reflection::ObjectDef<AnyTypeNode>(); }
  TVM_FFI_DECLARE_OBJECT_INFO_FINAL("ir.AnyType", AnyTypeNode, TypeNode);
};
 
class AnyType : public Type {
 public:
  TVM_TIRX_DLL AnyType(Location loc = UnknownLoc());
 
  TVM_FFI_DEFINE_OBJECT_REF_METHODS_NOTNULLABLE(AnyType, Type, AnyTypeNode);
};
 
class TensorRegionTypeNode : public TypeNode {
 public:
  static void RegisterReflection() {
    namespace refl = tvm::ffi::reflection;
    refl::ObjectDef<TensorRegionTypeNode>();
  }
 
  TVM_FFI_DECLARE_OBJECT_INFO_FINAL("ir.TensorRegionType", TensorRegionTypeNode, TypeNode);
};
 
class TensorRegionType : public Type {
 public:
  TVM_TIRX_DLL TensorRegionType();
 
  TVM_FFI_DEFINE_OBJECT_REF_METHODS_NOTNULLABLE(TensorRegionType, Type, TensorRegionTypeNode);
};
 
class StringTypeNode : public TypeNode {
 public:
  static void RegisterReflection() { ffi::reflection::ObjectDef<StringTypeNode>(); }
  TVM_FFI_DECLARE_OBJECT_INFO_FINAL("ir.StringType", StringTypeNode, TypeNode);
};
 
class StringType : public Type {
 public:
  TVM_TIRX_DLL StringType();
  TVM_FFI_DEFINE_OBJECT_REF_METHODS_NOTNULLABLE(StringType, Type, StringTypeNode);
};
 
class PtrTypeNode : public TypeNode {
 public:
  Type element_type = PrimType::Void();
  ffi::String storage_scope;
 
  static void RegisterReflection() {
    namespace refl = tvm::ffi::reflection;
    refl::ObjectDef<PtrTypeNode>()
        .def_ro("element_type", &PtrTypeNode::element_type)
        .def_ro("storage_scope", &PtrTypeNode::storage_scope);
  }
  TVM_FFI_DECLARE_OBJECT_INFO_FINAL("ir.PtrType", PtrTypeNode, TypeNode);
};
 
/*
 * \brief Managed reference to PtrTypeNode.
 * \sa PtrTypeNode
 */
class PtrType : public Type {
 public:
  TVM_TIRX_DLL explicit PtrType(Type element_type, ffi::String storage_scope = "");
 
  TVM_TIRX_DLL static PtrType VoidPtrType(ffi::String storage_scope = "");
 
  TVM_FFI_DEFINE_OBJECT_REF_METHODS_NOTNULLABLE(PtrType, Type, PtrTypeNode);
};
 
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_TIRX_DLL explicit TupleType(ffi::Array<Type> fields, Location loc = UnknownLoc());
 
  TVM_TIRX_DLL TupleType static Empty();
 
  TVM_FFI_DEFINE_OBJECT_REF_METHODS_NOTNULLABLE(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 = VoidType();
 
  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_TIRX_DLL FuncType(ffi::Array<Type> arg_types, Type ret_type, Location loc = UnknownLoc());
 
  TVM_FFI_DEFINE_OBJECT_REF_METHODS_NOTNULLABLE(FuncType, Type, FuncTypeNode);
};
 
}  // namespace tvm
#endif  // TVM_IR_TYPE_H_