instruction.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_INSTRUCTION_H_
#define TVM_TIR_SCHEDULE_INSTRUCTION_H_
 
#include <tvm/ffi/reflection/registry.h>
 
#include <utility>
 
namespace tvm {
 
// Forward declaration
template <typename, typename>
class AttrRegistry;
 
namespace tir {
 
// Forward declaration
class Schedule;
 
using FInstructionApply =
    ffi::TypedFunction<ffi::Array<Any>(Schedule sch, const ffi::Array<Any>& inputs,
                                       const ffi::Array<Any>& attrs, const Any& decision)>;
 
using FInstructionAsPython =
    ffi::TypedFunction<ffi::String(const ffi::Array<Any>& inputs, const ffi::Array<Any>& attrs,
                                   const Any& decision, const ffi::Array<ffi::String>& outputs)>;
 
using FInstructionAttrsAsJSON = ffi::TypedFunction<ObjectRef(ffi::Array<Any> attrs)>;
 
using FInstructionAttrsFromJSON = ffi::TypedFunction<ffi::Array<Any>(ObjectRef json_attrs)>;
 
class InstructionKindNode : public runtime::Object {
 public:
  ffi::String name;
  bool is_pure{false};
  FInstructionApply f_apply_to_schedule{nullptr};
  FInstructionAsPython f_as_python{nullptr};
  FInstructionAttrsAsJSON f_attrs_as_json{nullptr};
  FInstructionAttrsFromJSON f_attrs_from_json{nullptr};
 
  static void RegisterReflection() {
    namespace refl = tvm::ffi::reflection;
    refl::ObjectDef<InstructionKindNode>()
        .def_ro("name", &InstructionKindNode::name)
        .def_ro("_is_pure", &InstructionKindNode::is_pure);
  }
 
  bool IsPostproc() const;
  TVM_FFI_DECLARE_OBJECT_INFO_FINAL("tir.InstructionKind", InstructionKindNode, runtime::Object);
};
 
class InstructionKind : public runtime::ObjectRef {
 public:
  static InstructionKind Get(const ffi::String& name);
  TVM_FFI_DEFINE_OBJECT_REF_METHODS_NULLABLE(InstructionKind, runtime::ObjectRef,
                                             InstructionKindNode);
};
 
class InstructionNode : public runtime::Object {
 public:
  InstructionKind kind;
  ffi::Array<Any> inputs;
  ffi::Array<Any> attrs;
  ffi::Array<Any> outputs;
 
  static void RegisterReflection() {
    namespace refl = tvm::ffi::reflection;
    refl::ObjectDef<InstructionNode>()
        .def_ro("kind", &InstructionNode::kind)
        .def_ro("inputs", &InstructionNode::inputs)
        .def_ro("attrs", &InstructionNode::attrs)
        .def_ro("outputs", &InstructionNode::outputs);
  }
  TVM_FFI_DECLARE_OBJECT_INFO_FINAL("tir.Instruction", InstructionNode, runtime::Object);
};
 
class Instruction : public runtime::ObjectRef {
 public:
  explicit Instruction(InstructionKind kind, ffi::Array<Any> inputs, ffi::Array<Any> attrs,
                       ffi::Array<Any> outputs);
 
  TVM_FFI_DEFINE_OBJECT_REF_METHODS_NULLABLE(Instruction, runtime::ObjectRef, InstructionNode);
};
 
#define TVM_INST_KIND_REGISTER_VAR_DEF \
  static DMLC_ATTRIBUTE_UNUSED ::tvm::tir::InstructionKindRegEntry& __make_##InstructionKind
 
#define TVM_REGISTER_INST_KIND(InstructionKindName)             \
  TVM_STR_CONCAT(TVM_INST_KIND_REGISTER_VAR_DEF, __COUNTER__) = \
      ::tvm::tir::InstructionKindRegEntry::RegisterOrGet(InstructionKindName).set_name()
 
class InstructionKindRegEntry {
 public:
  static InstructionKindRegEntry& RegisterOrGet(const ffi::String& name);
 
  InstructionKindRegEntry& set_name() {
    get_mutable()->name = this->name;
    return *this;
  }
 
  InstructionKindRegEntry& set_is_pure(bool is_pure) {
    get_mutable()->is_pure = is_pure;
    return *this;
  }
 
  InstructionKindRegEntry& set_apply_to_schedule(FInstructionApply f_apply_to_schedule) {
    get_mutable()->f_apply_to_schedule = std::move(f_apply_to_schedule);
    return *this;
  }
 
  InstructionKindRegEntry& set_as_python(FInstructionAsPython f_as_python) {
    get_mutable()->f_as_python = std::move(f_as_python);
    return *this;
  }
 
  InstructionKindRegEntry& set_attrs_as_json(FInstructionAttrsAsJSON f_attrs_as_json) {
    get_mutable()->f_attrs_as_json = std::move(f_attrs_as_json);
    return *this;
  }
 
  InstructionKindRegEntry& set_attrs_from_json(FInstructionAttrsFromJSON f_attrs_from_json) {
    get_mutable()->f_attrs_from_json = std::move(f_attrs_from_json);
    return *this;
  }
 
 private:
  explicit InstructionKindRegEntry(uint32_t reg_index);
  InstructionKindNode* get_mutable() const {
    return const_cast<InstructionKindNode*>(inst_kind_.get());
  }
 
  ffi::String name;
  InstructionKind inst_kind_;
  template <typename, typename>
  friend class ::tvm::AttrRegistry;
  friend class InstructionKind;
};
 
}  // namespace tir
}  // namespace tvm
 
#endif  //  TVM_TIR_SCHEDULE_INSTRUCTION_H_