tile_primitive.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_TILE_PRIMITIVE_H_
#define TVM_TIRX_TILE_PRIMITIVE_H_
 
#include <tvm/ffi/object.h>
#include <tvm/ir/op.h>
#include <tvm/target/target.h>
#include <tvm/tirx/exec_scope.h>
#include <tvm/tirx/stmt.h>
#include <tvm/tirx/var.h>
 
namespace tvm {
namespace tirx {
 
class LambdaExprNode : public ffi::Object {
 public:
  Array<Var> vars;
  PrimExpr pred;
 
  PrimExpr Apply(const Array<PrimExpr>& indices) const;
 
  static void RegisterReflection() {
    namespace refl = tvm::ffi::reflection;
    refl::ObjectDef<LambdaExprNode>()
        .def_ro("vars", &LambdaExprNode::vars, refl::AttachFieldFlag::SEqHashDefRecursive())
        .def_ro("pred", &LambdaExprNode::pred);
  }
 
  static constexpr TVMFFISEqHashKind _type_s_eq_hash_kind = kTVMFFISEqHashKindTreeNode;
  TVM_FFI_DECLARE_OBJECT_INFO_FINAL("tirx.LambdaExpr", LambdaExprNode, ffi::Object);
};
 
class LambdaExpr : public ffi::ObjectRef {
 public:
  explicit LambdaExpr(Array<Var> vars, PrimExpr pred);
 
  TVM_FFI_DEFINE_OBJECT_REF_METHODS_NULLABLE(LambdaExpr, ffi::ObjectRef, LambdaExprNode);
};
 
using FArgSanitizer = ffi::TypedFunction<void(tvm::Op, ffi::Array<ffi::ObjectRef>)>;
 
namespace callback {
constexpr const char* kPrivateAlloc = "private_alloc";
constexpr const char* kDeviceInitStmt = "device_init_stmt";
constexpr const char* kHostInitStmt = "host_init_stmt";
constexpr const char* kPostBufferDefStmt = "post_buffer_def_stmt";
}  // namespace callback
 
class DispatchContextNode : public ffi::Object {
 public:
  Target target;
  ExecScope exec_scope;
  ffi::Map<ffi::String, IterVar> launch_params;
  ffi::Map<Var, Range> var_range_map;
  bool alloc_only;
  ffi::Map<ffi::String, ffi::ObjectRef> callbacks;
  ffi::Map<ffi::String, ffi::ObjectRef> shared_state;
  ffi::Map<ffi::String, ffi::Array<PrimExpr>> inter;
  ffi::Map<ffi::String, ffi::Array<PrimExpr>> intra;
  ffi::String scope_kind;
 
  static void RegisterReflection() {
    namespace refl = tvm::ffi::reflection;
    refl::ObjectDef<DispatchContextNode>()
        .def_ro("target", &DispatchContextNode::target)
        .def_ro("exec_scope", &DispatchContextNode::exec_scope)
        .def_ro("launch_params", &DispatchContextNode::launch_params)
        .def_ro("var_range_map", &DispatchContextNode::var_range_map)
        .def_ro("alloc_only", &DispatchContextNode::alloc_only)
        .def_ro("callbacks", &DispatchContextNode::callbacks)
        .def_ro("shared_state", &DispatchContextNode::shared_state)
        .def_ro("inter", &DispatchContextNode::inter)
        .def_ro("intra", &DispatchContextNode::intra)
        .def_ro("scope_kind", &DispatchContextNode::scope_kind);
  }
 
  void AddAllocBuffer(BufferVar buffer);
 
  void AddInitStmt(Stmt stmt, bool host = false);
 
  void AddPostBufferDefStmt(BufferVar buffer, Stmt stmt);
 
  void SharedStateSet(ffi::String key, ffi::ObjectRef value);
 
  ffi::Optional<ffi::ObjectRef> SharedStateGet(ffi::String key);
 
  TVM_FFI_DECLARE_OBJECT_INFO_FINAL("tirx.DispatchContext", DispatchContextNode, ffi::Object);
};
 
class DispatchContext : public ffi::ObjectRef {
 public:
  TVM_DLL DispatchContext(Target target, ExecScope exec_scope,
                          ffi::Map<ffi::String, IterVar> launch_params = {},
                          ffi::Map<Var, Range> var_range_map = {}, bool alloc_only = false,
                          ffi::Map<ffi::String, ffi::ObjectRef> callbacks = {},
                          ffi::Map<ffi::String, ffi::ObjectRef> shared_state = {},
                          ffi::Map<ffi::String, ffi::Array<PrimExpr>> inter = {},
                          ffi::Map<ffi::String, ffi::Array<PrimExpr>> intra = {},
                          ffi::String scope_kind = "");
 
  TVM_FFI_DEFINE_OBJECT_REF_METHODS_NULLABLE(DispatchContext, ffi::ObjectRef, DispatchContextNode);
};
 
class TilePrimitiveCallNode : public StmtNode {
 public:
  explicit TilePrimitiveCallNode(ffi::UnsafeInit tag) : op(tag) {}
 
  TilePrimitiveCallNode(tvm::Op op, ffi::Array<ffi::Any> args,
                        ffi::Map<ffi::String, BufferVar> workspace,
                        ffi::Map<ffi::String, ffi::Any> config, ffi::Optional<ffi::String> dispatch,
                        ExecScope scope)
      : op(std::move(op)),
        args(std::move(args)),
        workspace(std::move(workspace)),
        config(std::move(config)),
        dispatch(std::move(dispatch)),
        scope(std::move(scope)) {}
 
  // tvm::Op which corresponds to the TIRX operator.
  tvm::Op op;
 
  // Arguments to the operator.
  ffi::Array<ffi::Any> args;
 
  // Workspace (pre-allocated buffers) for the operator.
  ffi::Map<ffi::String, BufferVar> workspace;
 
  // Config for the operator/scheduler.
  ffi::Map<ffi::String, ffi::Any> config;
 
  // Optional dispatch variant name registered via @register_dispatch.
  ffi::Optional<ffi::String> dispatch{std::nullopt};
 
  // Cooperation scope of this call. Default thread (an unscoped call).
  ExecScope scope = ExecScope(ScopeKind::kThread);
 
  static void RegisterReflection() {
    namespace refl = tvm::ffi::reflection;
    refl::ObjectDef<TilePrimitiveCallNode>()
        .def_ro("op", &TilePrimitiveCallNode::op)
        .def_ro("args", &TilePrimitiveCallNode::args)
        .def_ro("workspace", &TilePrimitiveCallNode::workspace)
        .def_ro("config", &TilePrimitiveCallNode::config)
        .def_ro("dispatch", &TilePrimitiveCallNode::dispatch)
        .def_ro("scope", &TilePrimitiveCallNode::scope);
  }
 
  TVM_FFI_DECLARE_OBJECT_INFO_FINAL("tirx.TilePrimitiveCall", TilePrimitiveCallNode, StmtNode);
};
 
class TilePrimitiveCall : public Stmt {
 public:
  TVM_DLL TilePrimitiveCall(tvm::Op op, ffi::Array<ffi::Any> args,
                            ffi::Map<ffi::String, BufferVar> workspace = {},
                            ffi::Map<ffi::String, ffi::Any> config = {},
                            ffi::Optional<ffi::String> dispatch = std::nullopt,
                            ExecScope scope = ExecScope(ScopeKind::kThread));
 
  static bool IsValidOpCallArgType(const ffi::Any& arg);
 
  TVM_FFI_DEFINE_OBJECT_REF_METHODS_NULLABLE(TilePrimitiveCall, Stmt, TilePrimitiveCallNode);
  TVM_DEFINE_OBJECT_REF_COW_METHOD(TilePrimitiveCallNode);
};
 
TVM_DLL const Op& cast();
 
TVM_DLL const Op& copy();
 
TVM_DLL const Op& copy_async();
 
TVM_DLL const Op& fill();
 
TVM_DLL const Op& gemm();
 
TVM_DLL const Op& gemm_async();
 
TVM_DLL const Op& zero();
 
TVM_DLL const Op& sqrt();
 
TVM_DLL const Op& exp();
 
TVM_DLL const Op& exp2();
 
TVM_DLL const Op& add();
 
TVM_DLL const Op& sub();
 
TVM_DLL const Op& mul();
 
TVM_DLL const Op& fdiv();
 
TVM_DLL const Op& minimum();
 
TVM_DLL const Op& maximum();
 
TVM_DLL const Op& reciprocal();
 
TVM_DLL const Op& sum();
 
TVM_DLL const Op& max();
 
TVM_DLL const Op& min();
 
TVM_DLL const Op& memset();
 
TVM_DLL const Op& reduce_negate();
 
TVM_DLL const Op& binary_reduce();
 
TVM_DLL const Op& unary_reduce();
 
TVM_DLL const Op& binary_chain();
 
TVM_DLL const Op& select();
 
TVM_DLL const Op& fma();
 
TVM_DLL const Op& silu();
 
TVM_DLL const Op& compose_op();
 
TVM_DLL const Op& permute_layout();
 
}  // namespace tirx
}  // namespace tvm
 
#endif  // TVM_TIRX_TILE_PRIMITIVE_H_