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/node/reflection.h>

#include <utility>

namespace tvm {

// Forward declaration
template <typename, typename>
class AttrRegistry;

namespace tir {

// Forward declaration
class Schedule;

using FInstructionApply = runtime::TypedPackedFunc<Array<ObjectRef>(
    Schedule sch, const Array<ObjectRef>& inputs, const Array<ObjectRef>& attrs,
    const Optional<ObjectRef>& decision)>;

using FInstructionAsPython = runtime::TypedPackedFunc<String(
    const Array<ObjectRef>& inputs, const Array<ObjectRef>& attrs,
    const Optional<ObjectRef>& decision, const Array<String>& outputs)>;

using FInstructionAttrsAsJSON = runtime::TypedPackedFunc<ObjectRef(Array<ObjectRef> attrs)>;

using FInstructionAttrsFromJSON = runtime::TypedPackedFunc<Array<ObjectRef>(ObjectRef json_attrs)>;

class InstructionKindNode : public runtime::Object {
 public:
  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};

  void VisitAttrs(tvm::AttrVisitor* v) {
    v->Visit("name", &name);
    v->Visit("_is_pure", &is_pure);
    // not visited: f_apply_to_schedule
    // not visited: f_as_python
    // not visited: f_attrs_as_json
    // not visited: f_attrs_from_json
  }

  static constexpr const char* _type_key = "tir.InstructionKind";
  TVM_DECLARE_FINAL_OBJECT_INFO(InstructionKindNode, runtime::Object);
};

class InstructionKind : public runtime::ObjectRef {
 public:
  static InstructionKind Get(const String& name);
  TVM_DEFINE_OBJECT_REF_METHODS(InstructionKind, runtime::ObjectRef, InstructionKindNode);
};

class InstructionNode : public runtime::Object {
 public:
  InstructionKind kind;
  Array<ObjectRef> inputs;
  Array<ObjectRef> attrs;
  Array<ObjectRef> outputs;

  void VisitAttrs(tvm::AttrVisitor* v) {
    v->Visit("kind", &kind);
    v->Visit("inputs", &inputs);
    v->Visit("attrs", &attrs);
    v->Visit("outputs", &outputs);
  }

  static constexpr const char* _type_key = "tir.Instruction";
  TVM_DECLARE_FINAL_OBJECT_INFO(InstructionNode, runtime::Object);
};

class Instruction : public runtime::ObjectRef {
 public:
  explicit Instruction(InstructionKind kind, Array<ObjectRef> inputs, Array<ObjectRef> attrs,
                       Array<ObjectRef> outputs);

  TVM_DEFINE_OBJECT_REF_METHODS(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 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());
  }

  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_