sblock_scope.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_S_TIR_SBLOCK_SCOPE_H_
#define TVM_S_TIR_SBLOCK_SCOPE_H_
 
#include <tvm/ir/module.h>
#include <tvm/s_tir/stmt.h>
#include <tvm/s_tir/stmt_functor.h>
#include <tvm/tirx/function.h>
#include <tvm/tirx/stmt.h>
 
#include <unordered_map>
#include <utility>
#include <vector>
 
namespace tvm {
namespace tirx {
 
class StmtSRefObj : public ffi::Object {
 public:
  const StmtNode* stmt;
  StmtSRefObj* parent;
  int64_t seq_index;
 
  static void RegisterReflection() {
    namespace refl = tvm::ffi::reflection;
    refl::ObjectDef<StmtSRefObj>().def_ro("seq_index", &StmtSRefObj::seq_index);
  }
 
  static constexpr const bool _type_mutable = true;
  TVM_FFI_DECLARE_OBJECT_INFO_FINAL("s_tir.StmtSRef", StmtSRefObj, ffi::Object);
 
  void Reset() {
    this->stmt = nullptr;
    this->parent = nullptr;
    this->seq_index = -1;
  }
 
  template <typename StmtType>
  const StmtType* StmtAs() const {
    if (stmt != nullptr && stmt->IsInstance<StmtType>()) {
      return static_cast<const StmtType*>(stmt);
    } else {
      return nullptr;
    }
  }
};
 
class StmtSRef : public ffi::ObjectRef {
 public:
  TVM_DLL explicit StmtSRef(const StmtNode* stmt, StmtSRefObj* parent, int64_t seq_index);
 
  TVM_FFI_DEFINE_OBJECT_REF_METHODS_NOTNULLABLE(StmtSRef, ffi::ObjectRef, StmtSRefObj);
 
 public:
  TVM_DLL static StmtSRef InlineMark();
  TVM_DLL static StmtSRef RootMark();
};
 
class SRefTreeCreator : public s_tir::StmtExprVisitor {
 public:
  using s_tir::StmtExprVisitor::Visit_;
 
  ffi::Optional<VisitInterrupt> Visit(ffi::AnyView value) override {
    if (value.as<ExprNode>()) return std::nullopt;
    return s_tir::StmtExprVisitor::Visit(value);
  }
 
  static std::unordered_map<const StmtNode*, StmtSRef> Create(IRModule mod,
                                                              bool include_loops = true) {
    auto creator = ffi::make_object<SRefTreeCreator>(include_loops);
    for (const auto& kv : mod->functions) {
      const BaseFunc& base_func = kv.second;
      if (auto opt = base_func.as<Function>()) {
        auto func = opt.value();
        creator->Visit(func->body);
      }
    }
    return std::move(creator->stmt2ref_);
  }
 
  explicit SRefTreeCreator(bool include_loops) : include_loops_(include_loops) {}
 
 private:
  void PushSRef(const StmtNode* stmt);
 
  void PopAndRecordSRef();
 
  ffi::Optional<VisitInterrupt> Visit_(const ForNode* loop) final;
 
  ffi::Optional<VisitInterrupt> Visit_(const s_tir::SBlockRealizeNode* realize) final;
 
  ffi::Optional<VisitInterrupt> Visit_(const SeqStmtNode* seq_stmt) final;
 
  bool include_loops_;
  std::unordered_map<const StmtNode*, StmtSRef> stmt2ref_;
  std::vector<StmtSRef> srefs_;
};
 
enum class DepKind : int32_t {
  kRAW = 0,
  kWAW = 1,
  kWAR = 2,
  kOpaque = 3,
};
 
class DependencyObj : public ffi::Object {
 public:
  explicit DependencyObj(ffi::UnsafeInit tag) : src(tag), dst(tag) {}
 
  explicit DependencyObj(StmtSRef src, StmtSRef dst, DepKind kind)
      : src(std::move(src)), dst(std::move(dst)), kind(kind) {}
  StmtSRef src;
  StmtSRef dst;
  DepKind kind;
 
  static void RegisterReflection() {
    namespace refl = tvm::ffi::reflection;
    refl::ObjectDef<DependencyObj>()
        .def_ro("src", &DependencyObj::src)
        .def_ro("dst", &DependencyObj::dst)
        .def_ro("kind", &DependencyObj::kind);
  }
  TVM_FFI_DECLARE_OBJECT_INFO_FINAL("s_tir.Dependency", DependencyObj, ffi::Object);
};
 
class Dependency : public ffi::ObjectRef {
 public:
  TVM_DLL explicit Dependency(StmtSRef src, StmtSRef dst, DepKind kind);
  TVM_FFI_DEFINE_OBJECT_REF_METHODS_NOTNULLABLE(Dependency, ffi::ObjectRef, DependencyObj);
};
 
class SBlockScopeObj : public ffi::Object {
 public:
  std::unordered_map<StmtSRef, ffi::Array<Dependency>, ffi::ObjectPtrHash, ffi::ObjectPtrEqual>
      src2deps;
  std::unordered_map<StmtSRef, ffi::Array<Dependency>, ffi::ObjectPtrHash, ffi::ObjectPtrEqual>
      dst2deps;
  std::unordered_map<TensorVar, ffi::Array<StmtSRef>, ffi::ObjectPtrHash, ffi::ObjectPtrEqual>
      tensor_writers;
 
  static void RegisterReflection() {
    namespace refl = tvm::ffi::reflection;
    refl::ObjectDef<SBlockScopeObj>();
  }
  TVM_FFI_DECLARE_OBJECT_INFO_FINAL("s_tir.SBlockScope", SBlockScopeObj, ffi::Object);
 
 public:
  /******** Dependency ********/
  TVM_DLL ffi::Array<Dependency> GetDepsBySrc(const StmtSRef& src) const;
  TVM_DLL ffi::Array<Dependency> GetDepsByDst(const StmtSRef& dst) const;
};
 
class SBlockScope : public ffi::ObjectRef {
 public:
  explicit SBlockScope(ffi::ObjectPtr<SBlockScopeObj> data) : ffi::ObjectRef(data) {
    TVM_FFI_ICHECK(data != nullptr);
  }
  TVM_DLL SBlockScope();
  TVM_DLL explicit SBlockScope(const ffi::Array<StmtSRef>& child_block_srefs);
 
  TVM_FFI_DEFINE_OBJECT_REF_METHODS_NOTNULLABLE(SBlockScope, ffi::ObjectRef, SBlockScopeObj);
};
 
}  // namespace tirx
}  // namespace tvm
 
#endif  // TVM_S_TIR_SBLOCK_SCOPE_H_