buffer.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_TIRX_BUFFER_H_
#define TVM_TIRX_BUFFER_H_
 
#include <tvm/ffi/container/array.h>
#include <tvm/ffi/reflection/registry.h>
#include <tvm/ffi/string.h>
#include <tvm/ir/expr.h>
#include <tvm/tirx/layout.h>
#include <tvm/tirx/var.h>
 
#include <string>
 
namespace tvm {
namespace tirx {
 
#ifndef TVM_INDEX_DEFAULT_I64
#define TVM_INDEX_DEFAULT_I64 1
#endif
inline PrimType DefaultIndexPrimType() {
#if TVM_INDEX_DEFAULT_I64
  static const PrimType default_index_ty = PrimType::Int(64);
#else
  static const PrimType default_index_ty = PrimType::Int(32);
#endif
  return default_index_ty;
}
 
inline DLDataType DefaultIndexType() {
#if TVM_INDEX_DEFAULT_I64
  return DLDataType{kDLInt, 64, 1};
#else
  return DLDataType{kDLInt, 32, 1};
#endif
}
 
// forward declare Stmt
class Stmt;
 
class BufferTypeNode : public TypeNode {
 public:
  PrimType dtype = PrimType::Void();
  ffi::String storage_scope;
  ffi::Array<PrimExpr> shape;
  ffi::Array<PrimExpr> strides;
  PrimExpr elem_offset;
  int data_alignment;
  int offset_factor;
  ffi::Optional<Layout> layout;
 
  ffi::Array<PrimExpr> allocated_addr;
 
  BufferTypeNode() {}
 
  static void RegisterReflection() {
    namespace refl = tvm::ffi::reflection;
    refl::ObjectDef<BufferTypeNode>()
        .def_ro("dtype", &BufferTypeNode::dtype)
        .def_ro("storage_scope", &BufferTypeNode::storage_scope)
        // TODO(tqchen): use SEqHashDefNonRecursive after the next pypi tvm-ffi release
        .def_ro("shape", &BufferTypeNode::shape, refl::AttachFieldFlag::SEqHashDefRecursive())
        // TODO(tqchen): use SEqHashDefNonRecursive after the next pypi tvm-ffi release
        .def_ro("strides", &BufferTypeNode::strides, refl::AttachFieldFlag::SEqHashDefRecursive())
        // TODO(tqchen): use SEqHashDefNonRecursive after the next pypi tvm-ffi release
        .def_ro("elem_offset", &BufferTypeNode::elem_offset,
                refl::AttachFieldFlag::SEqHashDefRecursive())
        .def_ro("data_alignment", &BufferTypeNode::data_alignment)
        .def_ro("offset_factor", &BufferTypeNode::offset_factor)
        .def_ro("layout", &BufferTypeNode::layout)
        .def_ro("allocated_addr", &BufferTypeNode::allocated_addr);
  }
 
  DLDataType DefaultIndexType() const {
    return shape.size() != 0 ? shape[0].ty()->dtype : tvm::tirx::DefaultIndexType();
  }
 
  PrimType ElementType() const { return dtype; }
 
  PointerType DataPointerType() const { return PointerType(dtype, storage_scope); }
 
  ffi::Array<PrimExpr> ElemOffset(ffi::Array<PrimExpr> index, bool inner = false) const;
 
  TVM_FFI_DECLARE_OBJECT_INFO_FINAL("tirx.BufferType", BufferTypeNode, TypeNode);
};
 
class BufferType : public Type {
 public:
  TVM_DLL BufferType(ffi::String storage_scope, PrimType dtype, ffi::Array<PrimExpr> shape,
                     ffi::Array<PrimExpr> strides, PrimExpr elem_offset, int data_alignment,
                     int offset_factor, ffi::Optional<Layout> layout = std::nullopt,
                     ffi::Array<PrimExpr> allocated_addr = {}, Span span = Span());
 
  TVM_FFI_DEFINE_OBJECT_REF_METHODS_NOTNULLABLE(BufferType, Type, BufferTypeNode);
 
  explicit BufferType(ffi::ObjectPtr<BufferTypeNode> n) : Type(ffi::UnsafeInit{}) {
    TVM_FFI_ICHECK(n != nullptr);
    data_ = std::move(n);
  }
};
 
class BufferVar : public Var {
 public:
  TVM_DLL explicit BufferVar(ffi::String name, BufferType type, Span span = Span());
 
  explicit BufferVar(Var var) : Var(std::move(var)) {
    TVM_FFI_ICHECK(get() != nullptr && get()->ty.as<BufferTypeNode>())
        << "Expected a non-null Var with BufferType";
  }
 
  Var var() const { return ffi::GetRef<Var>(get()); }
 
  BufferType type() const { return get()->ty.as_or_throw<BufferType>(); }
 
  const ffi::String& name() const { return get()->name; }
 
  const Span& span() const { return get()->span; }
 
  TVM_DLL Expr data() const;
 
  TVM_DLL BufferVar MakeStrideView() const;
  TVM_DLL BufferVar MakeSlice(ffi::Array<PrimExpr> begins, ffi::Array<PrimExpr> extents) const;
  TVM_DLL Expr access_ptr(int access_mask, PointerType ptr_type = PointerType::VoidPointerTy(),
                          int content_lanes = 1, PrimExpr offset = IntImm::Int32(0),
                          ffi::Optional<PrimExpr> input_extent = std::nullopt) const;
  TVM_DLL PrimExpr vload(ffi::Array<PrimExpr> begin, PrimType dtype) const;
  TVM_DLL Stmt vstore(ffi::Array<PrimExpr> begin, PrimExpr value) const;
 
  BufferVar GetFlattenedBuffer() const;
 
  ffi::Array<PrimExpr> OffsetOf(ffi::Array<PrimExpr> index) const;
 
  PrimExpr OffsetOf_p(const ffi::Array<PrimExpr>& indices) const;
 
  TVM_DLL ffi::String scope() const;
 
  TVM_DLL BufferVar with_allocated_addr(ffi::Array<PrimExpr> allocated_addr) const;
 
  TVM_DLL bool IsScalar(bool alloc_or_decl = true) const;
 
  TVM_DLL BufferVar with_dtype(PrimType dtype) const;
 
  PrimType ElementType() const { return (*this)->ElementType(); }
 
  PointerType DataPointerType() const { return (*this)->DataPointerType(); }
 
  BufferVar() = default;
  explicit BufferVar(ffi::ObjectPtr<VarNode> n) : Var(std::move(n)) {}
  explicit BufferVar(ffi::UnsafeInit tag) : Var(tag) {}
  TVM_FFI_DEFINE_DEFAULT_COPY_MOVE_AND_ASSIGN(BufferVar);
 
  const BufferTypeNode* operator->() const {
    const auto* var_node = static_cast<const VarNode*>(data_.get());
    TVM_FFI_ICHECK(var_node != nullptr);
    const auto* type_node = var_node->ty.as<BufferTypeNode>();
    TVM_FFI_ICHECK(type_node != nullptr)
        << "Expected a Var with BufferType, but " << var_node->name << " has type " << var_node->ty;
    return type_node;
  }
 
  const VarNode* get() const { return static_cast<const VarNode*>(data_.get()); }
 
  [[maybe_unused]] static constexpr bool _type_is_nullable = false;
  static constexpr bool _type_container_is_exact = false;
  using ContainerType = VarNode;
};
 
// Preserve ObjectRef-style identity comparison for exact BufferVar operands.
// Comparisons widened to Var or Expr continue to build symbolic expressions.
inline bool operator==(const BufferVar& lhs, const BufferVar& rhs) { return lhs.same_as(rhs); }
 
inline bool operator!=(const BufferVar& lhs, const BufferVar& rhs) { return !lhs.same_as(rhs); }
 
inline BufferVar GetBufferVar(const VarNode* var) { return BufferVar(ffi::GetRef<Var>(var)); }
 
inline ffi::ObjectPtr<BufferTypeNode> CopyBufferType(const BufferVar& var) {
  return ffi::make_object<BufferTypeNode>(*var.operator->());
}
 
inline BufferVar RebuildBufferVar(const BufferVar& var, ffi::ObjectPtr<BufferTypeNode> type,
                                  ffi::Optional<ffi::String> name = std::nullopt) {
  return BufferVar(name.value_or(var.name()), BufferType(std::move(type)), var.span());
}
 
TVM_DLL BufferVar decl_buffer(ffi::Array<PrimExpr> shape, PrimType dtype = PrimType::Float(32),
                              ffi::String name = "buffer", ffi::String storage_scope = "",
                              Span span = Span());
 
TVM_DLL tirx::BufferVar BufferWithOffsetAlignment(ffi::Array<PrimExpr> shape, PrimType dtype,
                                                  std::string name, int data_alignment,
                                                  int offset_factor, std::string memory_scope = "");
 
TVM_DLL TensorLoad BufferLoad(BufferVar buffer, ffi::Array<PrimExpr> indices, Span span = Span());
}  // namespace tirx
}  // namespace tvm
 
namespace tvm::ffi {
 
template <>
inline constexpr bool use_default_type_traits_v<tirx::BufferVar> = false;
 
template <>
struct TypeTraits<tirx::BufferVar> : public ObjectRefTypeTraitsBase<tirx::BufferVar> {
  using Base = ObjectRefTypeTraitsBase<tirx::BufferVar>;
  using Base::CopyFromAnyViewAfterCheck;
  using Base::CopyToAnyView;
  using Base::GetMismatchTypeInfo;
  using Base::MoveFromAnyAfterCheck;
  using Base::MoveToAny;
  using Base::TypeSchema;
  using Base::TypeStr;
 
  TVM_FFI_INLINE static bool CheckAnyStrict(const TVMFFIAny* src) {
    if (src->type_index == TypeIndex::kTVMFFINone) {
      return false;
    }
    if (src->type_index != tirx::VarNode::RuntimeTypeIndex()) {
      return false;
    }
    const auto* var = static_cast<const tirx::VarNode*>(
        details::ObjectUnsafe::ObjectPtrFromUnowned<Object>(src->v_obj).get());
    return details::AnyUnsafe::CheckAnyStrict<tirx::BufferType>(var->ExprNode::ty);
  }
 
  TVM_FFI_INLINE static std::optional<tirx::BufferVar> TryCastFromAnyView(const TVMFFIAny* src) {
    if (CheckAnyStrict(src)) {
      return details::ObjectUnsafe::ObjectRefFromObjectPtr<tirx::BufferVar>(
          details::ObjectUnsafe::ObjectPtrFromUnowned<tirx::VarNode>(src->v_obj));
    }
    return std::nullopt;
  }
};
 
}  // namespace tvm::ffi
 
#endif  // TVM_TIR_BUFFER_H_