frame.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_SCRIPT_IR_BUILDER_FRAME_H_
#define TVM_S_TIR_SCRIPT_IR_BUILDER_FRAME_H_
 
#include <tvm/s_tir/stmt.h>
#include <tvm/tirx/script/ir_builder/frame.h>
 
namespace tvm {
namespace script {
namespace ir_builder {
namespace s_tir {
 
class FunctionFrameObj : public tirx::FunctionFrameObj {
 public:
  ffi::Array<tvm::tirx::TensorVar> root_alloc_tensors;
  tvm::s_tir::TensorAllocatedAddresses root_allocated_addresses;
 
  static void RegisterReflection() {
    namespace refl = tvm::ffi::reflection;
    refl::ObjectDef<FunctionFrameObj>()
        .def_ro("root_alloc_tensors", &FunctionFrameObj::root_alloc_tensors)
        .def_ro("root_allocated_addresses", &FunctionFrameObj::root_allocated_addresses);
  }
  TVM_FFI_DECLARE_OBJECT_INFO_FINAL("script.ir_builder.s_tir.FunctionFrame", FunctionFrameObj,
                                    tirx::FunctionFrameObj);
  static void BindTensorRegion(tvm::tirx::TensorVar tensor, tvm::TensorRegion region,
                               ffi::Array<PrimExpr> allocated_addr);
  tvm::tirx::Function FinalizeFunction(tvm::tirx::Function func) final;
};
 
class FunctionFrame : public tirx::FunctionFrame {
 public:
  explicit FunctionFrame(ffi::ObjectPtr<FunctionFrameObj> data)
      : tirx::FunctionFrame(std::move(data)) {}
  TVM_FFI_DEFINE_OBJECT_REF_METHODS_NOTNULLABLE(FunctionFrame, tirx::FunctionFrame,
                                                FunctionFrameObj);
};
 
class SBlockFrameObj : public ir::StmtFrameObj {
 public:
  ffi::String name;
  ffi::Array<tvm::s_tir::IterVar> iter_vars;
  ffi::Optional<ffi::Array<tvm::TensorRegion>> reads;
  ffi::Optional<ffi::Array<tvm::TensorRegion>> writes;
  ffi::Optional<tvm::SeqStmt> init;
  ffi::Array<tvm::tirx::TensorVar> alloc_tensors;
  ffi::Array<tvm::s_tir::MatchTensorRegion> match_tensors;
  tvm::s_tir::TensorAllocatedAddresses allocated_addresses;
  ffi::Optional<ffi::Map<ffi::String, Any>> annotations;
  ffi::Array<PrimExpr> iter_values;
  ffi::Optional<PrimExpr> predicate;
  bool no_realize;
 
  static void RegisterReflection() {
    namespace refl = tvm::ffi::reflection;
    refl::ObjectDef<SBlockFrameObj>()
        .def_ro("name", &SBlockFrameObj::name)
        .def_ro("iter_vars", &SBlockFrameObj::iter_vars)
        .def_ro("reads", &SBlockFrameObj::reads)
        .def_ro("writes", &SBlockFrameObj::writes)
        .def_ro("init", &SBlockFrameObj::init)
        .def_ro("alloc_tensors", &SBlockFrameObj::alloc_tensors)
        .def_ro("match_tensors", &SBlockFrameObj::match_tensors)
        .def_ro("allocated_addresses", &SBlockFrameObj::allocated_addresses)
        .def_ro("annotations", &SBlockFrameObj::annotations)
        .def_ro("iter_values", &SBlockFrameObj::iter_values)
        .def_ro("predicate", &SBlockFrameObj::predicate)
        .def_ro("no_realize", &SBlockFrameObj::no_realize);
  }
  TVM_FFI_DECLARE_OBJECT_INFO_FINAL("script.ir_builder.s_tir.SBlockFrame", SBlockFrameObj,
                                    ir::StmtFrameObj);
 
 public:
  void ExitWithScope() final;
};
 
class SBlockFrame : public ir::StmtFrame {
 public:
  explicit SBlockFrame(ffi::ObjectPtr<SBlockFrameObj> data) : ir::StmtFrame(ffi::UnsafeInit{}) {
    TVM_FFI_ICHECK(data != nullptr);
    data_ = std::move(data);
  }
  TVM_FFI_DEFINE_OBJECT_REF_METHODS_NOTNULLABLE(SBlockFrame, ir::StmtFrame, SBlockFrameObj);
};
 
class BlockInitFrameObj : public ir::StmtFrameObj {
 public:
  static void RegisterReflection() {
    namespace refl = tvm::ffi::reflection;
    refl::ObjectDef<BlockInitFrameObj>();
  }
  TVM_FFI_DECLARE_OBJECT_INFO_FINAL("script.ir_builder.s_tir.BlockInitFrame", BlockInitFrameObj,
                                    ir::StmtFrameObj);
 
 public:
  void EnterWithScope() final;
  void ExitWithScope() final;
};
 
class BlockInitFrame : public ir::StmtFrame {
 public:
  explicit BlockInitFrame(ffi::ObjectPtr<BlockInitFrameObj> data)
      : ir::StmtFrame(ffi::UnsafeInit{}) {
    TVM_FFI_ICHECK(data != nullptr);
    data_ = std::move(data);
  }
  TVM_FFI_DEFINE_OBJECT_REF_METHODS_NOTNULLABLE(BlockInitFrame, ir::StmtFrame, BlockInitFrameObj);
};
 
}  // namespace s_tir
}  // namespace ir_builder
}  // namespace script
}  // namespace tvm
 
#endif  // TVM_S_TIR_SCRIPT_IR_BUILDER_FRAME_H_