block_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_TIR_BLOCK_SCOPE_H_
#define TVM_TIR_BLOCK_SCOPE_H_
 
#include <tvm/ir/module.h>
#include <tvm/tir/function.h>
#include <tvm/tir/stmt.h>
#include <tvm/tir/stmt_functor.h>
 
#include <unordered_map>
#include <utility>
#include <vector>
 
namespace tvm {
namespace tir {
 
class StmtSRefNode : public Object {
 public:
  const StmtNode* stmt;
  StmtSRefNode* parent;
  int64_t seq_index;
 
  static void RegisterReflection() {
    namespace refl = tvm::ffi::reflection;
    refl::ObjectDef<StmtSRefNode>().def_ro("seq_index", &StmtSRefNode::seq_index);
  }
 
  static constexpr const bool _type_mutable = true;
  TVM_FFI_DECLARE_OBJECT_INFO_FINAL("tir.StmtSRef", StmtSRefNode, 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 ObjectRef {
 public:
  TVM_DLL explicit StmtSRef(const StmtNode* stmt, StmtSRefNode* parent, int64_t seq_index);
 
  TVM_FFI_DEFINE_OBJECT_REF_METHODS_NULLABLE(StmtSRef, ObjectRef, StmtSRefNode);
 
 public:
  TVM_DLL static StmtSRef InlineMark();
  TVM_DLL static StmtSRef RootMark();
};
 
class SRefTreeCreator : private StmtVisitor {
 public:
  static std::unordered_map<const StmtNode*, StmtSRef> Create(IRModule mod,
                                                              bool include_loops = true) {
    SRefTreeCreator creator(include_loops);
    for (const auto& kv : mod->functions) {
      const BaseFunc& base_func = kv.second;
      if (auto opt = base_func.as<PrimFunc>()) {
        auto func = opt.value();
        creator.VisitStmt(func->body);
      }
    }
    return std::move(creator.stmt2ref_);
  }
 
 private:
  explicit SRefTreeCreator(bool include_loops) : include_loops_(include_loops) {}
 
  void PushSRef(const StmtNode* stmt);
 
  void PopAndRecordSRef();
 
  void VisitStmt_(const ForNode* loop) final;
 
  void VisitStmt_(const BlockRealizeNode* realize) final;
 
  void VisitStmt_(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 DependencyNode : public Object {
 public:
  StmtSRef src;
  StmtSRef dst;
  DepKind kind;
 
  static void RegisterReflection() {
    namespace refl = tvm::ffi::reflection;
    refl::ObjectDef<DependencyNode>()
        .def_ro("src", &DependencyNode::src)
        .def_ro("dst", &DependencyNode::dst)
        .def_ro("kind", &DependencyNode::kind);
  }
  TVM_FFI_DECLARE_OBJECT_INFO_FINAL("tir.Dependency", DependencyNode, Object);
};
 
class Dependency : public ObjectRef {
 public:
  TVM_DLL explicit Dependency(StmtSRef src, StmtSRef dst, DepKind kind);
  TVM_FFI_DEFINE_OBJECT_REF_METHODS_NOTNULLABLE(Dependency, ObjectRef, DependencyNode);
};
 
class BlockScopeNode : public Object {
 public:
  std::unordered_map<StmtSRef, ffi::Array<Dependency>, ObjectPtrHash, ObjectPtrEqual> src2deps;
  std::unordered_map<StmtSRef, ffi::Array<Dependency>, ObjectPtrHash, ObjectPtrEqual> dst2deps;
  std::unordered_map<Buffer, ffi::Array<StmtSRef>, ObjectPtrHash, ObjectPtrEqual> buffer_writers;
 
  static void RegisterReflection() {
    // No fields to register as they are not visited
  }
  TVM_FFI_DECLARE_OBJECT_INFO_FINAL("tir.BlockScope", BlockScopeNode, Object);
 
 public:
  /******** Dependency ********/
  TVM_DLL ffi::Array<Dependency> GetDepsBySrc(const StmtSRef& src) const;
  TVM_DLL ffi::Array<Dependency> GetDepsByDst(const StmtSRef& dst) const;
};
 
class BlockScope : public ObjectRef {
 public:
  explicit BlockScope(ObjectPtr<BlockScopeNode> data) : ObjectRef(data) {
    TVM_FFI_ICHECK(data != nullptr);
  }
  TVM_DLL BlockScope();
  TVM_DLL explicit BlockScope(const ffi::Array<StmtSRef>& child_block_srefs);
 
  TVM_FFI_DEFINE_OBJECT_REF_METHODS_NOTNULLABLE(BlockScope, ObjectRef, BlockScopeNode);
};
 
}  // namespace tir
}  // namespace tvm
 
#endif  // TVM_TIR_BLOCK_SCOPE_H_