expr.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_EXPR_H_
#define TVM_IR_EXPR_H_
 
#include <tvm/ffi/reflection/registry.h>
#include <tvm/ffi/string.h>
#include <tvm/ir/source_map.h>
#include <tvm/ir/type.h>
#include <tvm/node/node.h>
#include <tvm/runtime/object.h>
 
#include <algorithm>
#include <functional>
#include <limits>
#include <string>
#include <type_traits>
 
namespace tvm {
 
using tvm::String;
 
// Forward-declare VirtualDevice to avoid circular imports.
class VirtualDevice;
 
class BaseExprNode : public Object {
 public:
  mutable Span span;
 
  static void RegisterReflection() {
    namespace refl = tvm::ffi::reflection;
    // span do not participate in structural equal and hash.
    refl::ObjectDef<BaseExprNode>().def_ro("span", &BaseExprNode::span, refl::DefaultValue(Span()),
                                           refl::AttachFieldFlag::SEqHashIgnore());
  }
 
  static constexpr const char* _type_key = "ir.BaseExpr";
 
  static constexpr TVMFFISEqHashKind _type_s_eq_hash_kind = kTVMFFISEqHashKindTreeNode;
 
  static constexpr const uint32_t _type_child_slots = 64;
  TVM_DECLARE_BASE_OBJECT_INFO(BaseExprNode, Object);
};
 
class BaseExpr : public ObjectRef {
 public:
  TVM_DEFINE_OBJECT_REF_METHODS(BaseExpr, ObjectRef, BaseExprNode);
};
 
class PrimExprNode : public BaseExprNode {
 public:
  DataType dtype;
 
  static void RegisterReflection() {
    namespace refl = tvm::ffi::reflection;
    refl::ObjectDef<PrimExprNode>().def_ro("dtype", &PrimExprNode::dtype);
  }
 
  TVM_OBJECT_ENABLE_SCRIPT_PRINTER();
 
  static constexpr const char* _type_key = "ir.PrimExpr";
  static constexpr const uint32_t _type_child_slots = 40;
  TVM_DECLARE_BASE_OBJECT_INFO(PrimExprNode, BaseExprNode);
};
 
class PrimExpr : public BaseExpr {
 public:
  TVM_DLL PrimExpr(int32_t value);  // NOLINT(*)
  TVM_DLL PrimExpr(float value);  // NOLINT(*)
 
  DataType dtype() const { return static_cast<const PrimExprNode*>(get())->dtype; }
 
  TVM_DEFINE_OBJECT_REF_METHODS(PrimExpr, BaseExpr, PrimExprNode);
 
  TVM_DLL static PrimExpr ConvertFallbackValue(String value);  // NOLINT(*)
};
 
class PrimExprConvertibleNode : public Object {
 public:
  virtual ~PrimExprConvertibleNode() {}
  virtual PrimExpr ToPrimExpr() const = 0;
 
  static constexpr const char* _type_key = "ir.PrimExprConvertible";
  TVM_DECLARE_BASE_OBJECT_INFO(PrimExprConvertibleNode, Object);
};
 
class PrimExprConvertible : public ObjectRef {
 public:
  TVM_DEFINE_OBJECT_REF_METHODS(PrimExprConvertible, ObjectRef, PrimExprConvertibleNode);
};
 
namespace ffi {
// define automatic conversion from bool, int64_t, double, String to PrimExpr
// These functions are declared early to avoid circular dependency
template <>
inline constexpr bool use_default_type_traits_v<PrimExpr> = false;
 
template <>
struct TypeTraits<PrimExpr>
    : public ObjectRefWithFallbackTraitsBase<PrimExpr, StrictBool, int64_t, double, String,
                                             PrimExprConvertible> {
  TVM_FFI_INLINE static PrimExpr ConvertFallbackValue(StrictBool value);
  TVM_FFI_INLINE static PrimExpr ConvertFallbackValue(int64_t value);
  TVM_FFI_INLINE static PrimExpr ConvertFallbackValue(double value);
  TVM_FFI_INLINE static PrimExpr ConvertFallbackValue(String value) {
    return PrimExpr::ConvertFallbackValue(value);
  }
  TVM_FFI_INLINE static PrimExpr ConvertFallbackValue(PrimExprConvertible value) {
    return value->ToPrimExpr();
  }
};
}  // namespace ffi
 
TVM_DLL PrimExpr operator+(PrimExpr a, PrimExpr b);
 
TVM_DLL PrimExpr operator-(PrimExpr a, PrimExpr b);
 
TVM_DLL PrimExpr operator-(PrimExpr a);
 
TVM_DLL PrimExpr operator*(PrimExpr a, PrimExpr b);
 
TVM_DLL PrimExpr operator/(PrimExpr a, PrimExpr b);
 
TVM_DLL PrimExpr operator<<(PrimExpr a, PrimExpr b);
 
TVM_DLL PrimExpr operator>>(PrimExpr a, PrimExpr b);
 
TVM_DLL PrimExpr operator>(PrimExpr a, PrimExpr b);
 
TVM_DLL PrimExpr operator>=(PrimExpr a, PrimExpr b);
 
TVM_DLL PrimExpr operator<(PrimExpr a, PrimExpr b);
 
TVM_DLL PrimExpr operator<=(PrimExpr a, PrimExpr b);
 
TVM_DLL PrimExpr operator==(PrimExpr a, PrimExpr b);
 
TVM_DLL PrimExpr operator!=(PrimExpr a, PrimExpr b);
 
TVM_DLL PrimExpr operator&&(PrimExpr a, PrimExpr b);
 
TVM_DLL PrimExpr operator||(PrimExpr a, PrimExpr b);
 
TVM_DLL PrimExpr operator!(PrimExpr a);
 
TVM_DLL PrimExpr operator&(PrimExpr a, PrimExpr b);
 
TVM_DLL PrimExpr operator|(PrimExpr a, PrimExpr b);
 
TVM_DLL PrimExpr operator^(PrimExpr a, PrimExpr b);
 
TVM_DLL PrimExpr operator~(PrimExpr a);
 
class RelaxExprNode : public BaseExprNode {
 public:
  mutable Optional<ObjectRef> struct_info_ = Optional<ObjectRef>();
 
  static void RegisterReflection() {
    namespace refl = tvm::ffi::reflection;
    refl::ObjectDef<RelaxExprNode>().def_ro("struct_info_", &RelaxExprNode::struct_info_,
                                            refl::AttachFieldFlag::SEqHashIgnore());
  }
 
  static constexpr const char* _type_key = "ir.RelaxExpr";
  static constexpr const uint32_t _type_child_slots = 22;
  TVM_DECLARE_BASE_OBJECT_INFO(RelaxExprNode, BaseExprNode);
};
 
class RelaxExpr : public BaseExpr {
 public:
  TVM_DEFINE_OBJECT_REF_METHODS(RelaxExpr, BaseExpr, RelaxExprNode);
};
 
class GlobalVar;
class GlobalVarNode : public RelaxExprNode {
 public:
  String name_hint;
 
  static void RegisterReflection() {
    namespace refl = tvm::ffi::reflection;
    refl::ObjectDef<GlobalVarNode>().def_ro("name_hint", &GlobalVarNode::name_hint);
  }
 
  bool SEqual(const GlobalVarNode* other,
              ffi::TypedFunction<bool(AnyView, AnyView, bool, AnyView)> equal) const {
    return equal(name_hint, other->name_hint, false, "name_hint");
  }
 
  uint64_t SHash(uint64_t init_hash,
                 ffi::TypedFunction<uint64_t(AnyView, uint64_t, bool)> hash) const {
    return hash(name_hint, init_hash, false);
  }
 
  static constexpr TVMFFISEqHashKind _type_s_eq_hash_kind = kTVMFFISEqHashKindFreeVar;
  static constexpr const char* _type_key = "ir.GlobalVar";
  TVM_DECLARE_FINAL_OBJECT_INFO(GlobalVarNode, RelaxExprNode);
};
 
class GlobalVar : public RelaxExpr {
 public:
  TVM_DLL explicit GlobalVar(String name_hint, Span span = {});
 
  TVM_DEFINE_OBJECT_REF_METHODS(GlobalVar, RelaxExpr, GlobalVarNode);
  TVM_DEFINE_OBJECT_REF_COW_METHOD(GlobalVarNode);
};
 
class IntImmNode : public PrimExprNode {
 public:
  int64_t value;
 
  static void RegisterReflection() {
    namespace refl = tvm::ffi::reflection;
    refl::ObjectDef<IntImmNode>().def_ro("value", &IntImmNode::value);
  }
 
  static constexpr const char* _type_key = "ir.IntImm";
  TVM_DECLARE_FINAL_OBJECT_INFO(IntImmNode, PrimExprNode);
};
 
class IntImm : public PrimExpr {
 public:
  TVM_DLL IntImm(DataType dtype, int64_t value, Span span = Span());
 
  TVM_DEFINE_OBJECT_REF_METHODS(IntImm, PrimExpr, IntImmNode);
  TVM_DEFINE_OBJECT_REF_COW_METHOD(IntImmNode);
};
 
class FloatImmNode : public PrimExprNode {
 public:
  double value;
 
  static void RegisterReflection() {
    namespace refl = tvm::ffi::reflection;
    refl::ObjectDef<FloatImmNode>().def_ro("value", &FloatImmNode::value);
  }
 
  static constexpr const char* _type_key = "ir.FloatImm";
  TVM_DECLARE_FINAL_OBJECT_INFO(FloatImmNode, PrimExprNode);
};
 
class FloatImm : public PrimExpr {
 public:
  TVM_DLL FloatImm(DataType dtype, double value, Span span = Span());
 
  TVM_DEFINE_OBJECT_REF_METHODS(FloatImm, PrimExpr, FloatImmNode);
  TVM_DEFINE_OBJECT_REF_COW_METHOD(FloatImmNode);
};
 
class Bool : public IntImm {
 public:
  explicit Bool(bool value, Span span = Span()) : IntImm(DataType::Bool(), value, span) {}
  Bool operator!() const { return Bool((*this)->value == 0); }
  operator bool() const { return (*this)->value != 0; }
 
  TVM_DEFINE_NOTNULLABLE_OBJECT_REF_METHODS(Bool, IntImm, IntImmNode);
};
 
// Overload operators to make sure we have the most fine grained types.
inline Bool operator||(const Bool& a, bool b) { return Bool(a.operator bool() || b); }
inline Bool operator||(bool a, const Bool& b) { return Bool(a || b.operator bool()); }
inline Bool operator||(const Bool& a, const Bool& b) {
  return Bool(a.operator bool() || b.operator bool());
}
inline Bool operator&&(const Bool& a, bool b) { return Bool(a.operator bool() && b); }
inline Bool operator&&(bool a, const Bool& b) { return Bool(a && b.operator bool()); }
inline Bool operator&&(const Bool& a, const Bool& b) {
  return Bool(a.operator bool() && b.operator bool());
}
 
inline bool operator==(const Bool& a, bool b) { return a.operator bool() == b; }
inline bool operator==(bool a, const Bool& b) { return a == b.operator bool(); }
inline bool operator==(const Bool& a, const Bool& b) {
  return a.operator bool() == b.operator bool();
}
 
class Integer : public IntImm {
 public:
  Integer() {}
  explicit Integer(ObjectPtr<Object> node) : IntImm(node) {}
  Integer(int value, Span span = Span()) : IntImm(DataType::Int(32), value, span) {}  // NOLINT(*)
  Integer(IntImm other) : IntImm(std::move(other)) {}  // NOLINT(*)
  template <typename Enum, typename = typename std::enable_if<std::is_enum<Enum>::value>::type>
  explicit Integer(Enum value) : Integer(static_cast<int>(value)) {
    static_assert(std::is_same<int, typename std::underlying_type<Enum>::type>::value,
                  "declare enum to be enum int to use visitor");
  }
  Integer& operator=(const IntImm& other) {
    data_ = ffi::details::ObjectUnsafe::ObjectPtrFromObjectRef<Object>(other);
    return *this;
  }
  int64_t IntValue() const {
    ICHECK(data_ != nullptr) << " Trying to reference a null Integer";
    return (*this)->value;
  }
  // comparators
  Bool operator==(int other) const {
    if (data_ == nullptr) return Bool(false);
    return Bool((*this)->value == other);
  }
  Bool operator!=(int other) const { return !(*this == other); }
  template <typename Enum, typename = typename std::enable_if<std::is_enum<Enum>::value>::type>
  Bool operator==(Enum other) const {
    return *this == static_cast<int>(other);
  }
  template <typename Enum, typename = typename std::enable_if<std::is_enum<Enum>::value>::type>
  Bool operator!=(Enum other) const {
    return *this != static_cast<int>(other);
  }
};
 
class RangeNode : public Object {
 public:
  PrimExpr min;
  PrimExpr extent;
  mutable Span span;
  RangeNode() {}
  RangeNode(PrimExpr min, PrimExpr extent, Span span = Span())
      : min(min), extent(extent), span(span) {}
 
  static void RegisterReflection() {
    namespace refl = tvm::ffi::reflection;
    refl::ObjectDef<RangeNode>()
        .def_ro("min", &RangeNode::min)
        .def_ro("extent", &RangeNode::extent)
        .def_ro("span", &RangeNode::span, refl::AttachFieldFlag::SEqHashIgnore());
  }
 
  static constexpr const char* _type_key = "ir.Range";
  static constexpr TVMFFISEqHashKind _type_s_eq_hash_kind = kTVMFFISEqHashKindTreeNode;
 
  TVM_DECLARE_FINAL_OBJECT_INFO(RangeNode, Object);
};
 
class Range : public ObjectRef {
 public:
  TVM_DLL Range(PrimExpr begin, PrimExpr end, Span span = Span());
  static Range FromMinExtent(PrimExpr min, PrimExpr extent, Span span = Span());
  // declare range.
  TVM_DEFINE_OBJECT_REF_METHODS(Range, ObjectRef, RangeNode);
};
 
namespace ffi {
// Type traits to enable automatic conversion into IntImm, Integer, and Bool
// when called through the FFI
template <>
inline constexpr bool use_default_type_traits_v<IntImm> = false;
 
// specialize to enable implicit conversion from const char*
template <>
struct TypeTraits<IntImm> : public ObjectRefWithFallbackTraitsBase<IntImm, int64_t> {
  TVM_FFI_INLINE static IntImm ConvertFallbackValue(int64_t value) {
    auto dtype =
        (value > std::numeric_limits<int>::max() || value < std::numeric_limits<int>::min())
            ? DataType::Int(64)
            : DataType::Int(32);
    return IntImm(dtype, value);
  }
};
 
template <>
inline constexpr bool use_default_type_traits_v<Integer> = false;
 
template <>
struct TypeTraits<Integer> : public ObjectRefWithFallbackTraitsBase<Integer, int64_t> {
  TVM_FFI_INLINE static Integer ConvertFallbackValue(int64_t value) {
    return Integer(TypeTraits<IntImm>::ConvertFallbackValue(value));
  }
};
 
template <>
inline constexpr bool use_default_type_traits_v<FloatImm> = false;
 
template <>
struct TypeTraits<FloatImm> : public ObjectRefWithFallbackTraitsBase<FloatImm, double> {
  TVM_FFI_INLINE static FloatImm ConvertFallbackValue(double value) {
    return FloatImm(runtime::DataType::Float(32), value);
  }
};
 
template <>
inline constexpr bool use_default_type_traits_v<Bool> = false;
 
template <>
struct TypeTraits<Bool> : public ObjectRefWithFallbackTraitsBase<Bool, int64_t> {
  TVM_FFI_INLINE static Bool ConvertFallbackValue(int64_t value) { return Bool(value != 0); }
};
 
// define automatic conversion from bool, int64_t, double to PrimExpr
TVM_FFI_INLINE PrimExpr TypeTraits<PrimExpr>::ConvertFallbackValue(StrictBool value) {
  return IntImm(DataType::Bool(), value, Span());
}
 
TVM_FFI_INLINE PrimExpr TypeTraits<PrimExpr>::ConvertFallbackValue(int64_t value) {
  return TypeTraits<IntImm>::ConvertFallbackValue(value);
}
 
TVM_FFI_INLINE PrimExpr TypeTraits<PrimExpr>::ConvertFallbackValue(double value) {
  return TypeTraits<FloatImm>::ConvertFallbackValue(value);
}
}  // namespace ffi
}  // namespace tvm
 
/* \brief Allow tvm.GLobalVar as key in STL tables
 *
 * For most IR expressions, it would be ambiguous whether the
 * expression should follow reference equality or structural equality.
 * This is not the case for variables, which do not contain nested
 * internal structure, and are frequently used as keys in lookup
 * tables.
 *
 * Providing `std::hash` and `std::equal_to` specializations for
 * `tvm::GlobalVar` allows it to be used as a key in STL tables.  For
 * other IR expressions, the user must specify the type of equality
 * used (e.g. `std::unordered_set<T, StructuralHash, StructuralEqual>`
 * or `std::unordered_set<T, ObjectPtrHash, ObjectPtrEqual>`).
 */
template <>
struct std::hash<tvm::GlobalVar> {
  std::size_t operator()(const tvm::GlobalVar& var) const {
    return tvm::runtime::ObjectPtrHash()(var);
  }
};
 
template <>
struct std::equal_to<tvm::GlobalVar> {
  bool operator()(const tvm::GlobalVar& var_a, const tvm::GlobalVar& var_b) const {
    return tvm::runtime::ObjectPtrEqual()(var_a, var_b);
  }
};
#endif  // TVM_IR_EXPR_H_