state.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_SCHEDULE_STATE_H_
#define TVM_TIR_SCHEDULE_STATE_H_

#include <tvm/ir/module.h>
#include <tvm/tir/function.h>
#include <tvm/tir/schedule/block_scope.h>

#include <unordered_map>
#include <utility>

namespace tvm {
namespace tir {

struct BlockInfo {
  BlockScope scope{nullptr};
  // The properties below are information about the current block realization under its parent scope
  bool affine_binding{false};
  bool region_cover{false};

  BlockInfo() = default;

  explicit BlockInfo(BlockScope scope, bool affine_binding = false, bool region_cover = false)
      : scope(std::move(scope)),         //
        affine_binding(affine_binding),  //
        region_cover(region_cover) {}
};

enum ScheduleDebugMask : uint32_t {
  kVerifySRefTree = 1,
  kVerifyCachedFlags = 2,
};

class ScheduleStateNode : public Object {
 public:
  IRModule mod;
  std::unordered_map<StmtSRef, BlockInfo, ObjectPtrHash, ObjectPtrEqual> block_info;
  std::unordered_map<const StmtNode*, StmtSRef> stmt2ref;
  int debug_mask;
  bool enable_check;

  void VisitAttrs(AttrVisitor* v) {
    v->Visit("mod", &mod);
    // `block_info` is not visited
    // `stmt2ref` is not visited
    v->Visit("debug_mask", &debug_mask);
    v->Visit("enable_check", &enable_check);
  }
  TVM_DLL void Replace(const tir::StmtSRef& src_sref, const Stmt& tgt_stmt,
                       const Map<Block, Block>& block_sref_reuse);
  TVM_DLL void DebugVerify() const;

  static constexpr const char* _type_key = "tir.ScheduleState";
  TVM_DECLARE_FINAL_OBJECT_INFO(ScheduleStateNode, Object);

  /******** Property of blocks ********/
  TVM_DLL BlockInfo GetBlockInfo(const StmtSRef& block_sref) const;
  TVM_DLL void UpdateScopeBlockInfo(const Stmt& stmt);
  BlockScope GetBlockScope(const StmtSRef& scope_root) const {
    return GetBlockInfo(scope_root).scope;
  }
  bool IsAffineBlockBinding(const StmtSRef& block_sref) const {
    return GetBlockInfo(block_sref).affine_binding;
  }
  bool IsRegionCoveredConsumer(const StmtSRef& consumer_block_sref) const {
    return GetBlockInfo(consumer_block_sref).region_cover;
  }
  bool IsStagePipeline(const StmtSRef& scope_root) const {
    return GetBlockScope(scope_root)->stage_pipeline;
  }
};

class ScheduleState : public ObjectRef {
 public:
  TVM_DLL explicit ScheduleState(IRModule mod, int debug_mask = 0, bool enable_check = true);

  ScheduleStateNode* get() const { return static_cast<ScheduleStateNode*>(data_.get()); }

  TVM_DEFINE_MUTABLE_OBJECT_REF_METHODS(ScheduleState, ObjectRef, ScheduleStateNode);
};

}  // namespace tir
}  // namespace tvm

#endif  // TVM_TIR_SCHEDULE_STATE_H_