builder.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_META_SCHEDULE_BUILDER_H_
#define TVM_META_SCHEDULE_BUILDER_H_
 
#include <tvm/ffi/container/array.h>
#include <tvm/ffi/container/map.h>
#include <tvm/ffi/function.h>
#include <tvm/ffi/optional.h>
#include <tvm/ffi/reflection/registry.h>
#include <tvm/ffi/string.h>
#include <tvm/ir/module.h>
#include <tvm/runtime/object.h>
#include <tvm/runtime/tensor.h>
#include <tvm/target/target.h>
 
namespace tvm {
namespace meta_schedule {
 
class BuilderInputNode : public runtime::Object {
 public:
  IRModule mod;
  Target target;
  ffi::Optional<ffi::Map<ffi::String, runtime::Tensor>> params;
 
  static void RegisterReflection() {
    namespace refl = tvm::ffi::reflection;
    refl::ObjectDef<BuilderInputNode>()
        .def_ro("mod", &BuilderInputNode::mod)
        .def_ro("target", &BuilderInputNode::target)
        .def_ro("params", &BuilderInputNode::params);
  }
  TVM_FFI_DECLARE_OBJECT_INFO_FINAL("meta_schedule.BuilderInput", BuilderInputNode,
                                    runtime::Object);
};
 
class BuilderInput : public runtime::ObjectRef {
 public:
  TVM_DLL explicit BuilderInput(
      IRModule mod, Target target,
      ffi::Optional<ffi::Map<ffi::String, runtime::Tensor>> params = std::nullopt);
  TVM_FFI_DEFINE_OBJECT_REF_METHODS_NOTNULLABLE(BuilderInput, runtime::ObjectRef, BuilderInputNode);
};
 
class BuilderResultNode : public runtime::Object {
 public:
  ffi::Optional<ffi::String> artifact_path;
  ffi::Optional<ffi::String> error_msg;
 
  static void RegisterReflection() {
    namespace refl = tvm::ffi::reflection;
    refl::ObjectDef<BuilderResultNode>()
        .def_ro("artifact_path", &BuilderResultNode::artifact_path)
        .def_ro("error_msg", &BuilderResultNode::error_msg);
  }
  TVM_FFI_DECLARE_OBJECT_INFO_FINAL("meta_schedule.BuilderResult", BuilderResultNode,
                                    runtime::Object);
};
 
class BuilderResult : public runtime::ObjectRef {
 public:
  TVM_DLL explicit BuilderResult(ffi::Optional<ffi::String> artifact_path,
                                 ffi::Optional<ffi::String> error_msg);
  TVM_FFI_DEFINE_OBJECT_REF_METHODS_NOTNULLABLE(BuilderResult, runtime::ObjectRef,
                                                BuilderResultNode);
};
 
class BuilderNode : public runtime::Object {
 public:
  virtual ~BuilderNode() = default;
  virtual ffi::Array<BuilderResult> Build(const ffi::Array<BuilderInput>& build_inputs) = 0;
  using FBuild = ffi::TypedFunction<ffi::Array<BuilderResult>(const ffi::Array<BuilderInput>&)>;
 
  static constexpr const bool _type_mutable = true;
  TVM_FFI_DECLARE_OBJECT_INFO("meta_schedule.Builder", BuilderNode, runtime::Object);
};
 
class Builder : public runtime::ObjectRef {
 public:
  explicit Builder(ObjectPtr<BuilderNode> data) : ObjectRef(data) {
    TVM_FFI_ICHECK(data != nullptr);
  }
  static Builder PyBuilder(BuilderNode::FBuild f_build);
  TVM_FFI_DEFINE_OBJECT_REF_METHODS_NOTNULLABLE(Builder, runtime::ObjectRef, BuilderNode);
};
 
class PyBuilderNode : public BuilderNode {
 public:
  FBuild f_build;
 
  static void RegisterReflection() {
    namespace refl = tvm::ffi::reflection;
    refl::ObjectDef<PyBuilderNode>().def_ro("f_build", &PyBuilderNode::f_build);
  }
 
  ffi::Array<BuilderResult> Build(const ffi::Array<BuilderInput>& build_inputs) final {
    ICHECK(f_build != nullptr) << "PyBuilder's Build method not implemented!";
    return f_build(build_inputs);
  }
  TVM_FFI_DECLARE_OBJECT_INFO_FINAL("meta_schedule.PyBuilder", PyBuilderNode, BuilderNode);
};
 
}  // namespace meta_schedule
}  // namespace tvm
 
#endif  // TVM_META_SCHEDULE_BUILDER_H_