tune_context.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_META_SCHEDULE_TUNE_CONTEXT_H_
#define TVM_S_TIR_META_SCHEDULE_TUNE_CONTEXT_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/expr.h>
#include <tvm/ir/module.h>
#include <tvm/ir/prim/expr.h>
#include <tvm/s_tir/meta_schedule/builder.h>
#include <tvm/s_tir/meta_schedule/runner.h>
#include <tvm/s_tir/meta_schedule/search_strategy.h>
#include <tvm/s_tir/meta_schedule/space_generator.h>
#include <tvm/s_tir/random_engine.h>
#include <tvm/target/target.h>
 
namespace tvm {
namespace s_tir {
namespace meta_schedule {
 
class TaskSchedulerObj;
class MeasureCallback;
class TuneContext;
 
class TuneContextObj : public ffi::Object {
 public:
  using TRandState = LinearCongruentialEngine::TRandState;
 
  ffi::Optional<IRModule> mod;
  ffi::Optional<Target> target;
  ffi::Optional<SpaceGenerator> space_generator;
  ffi::Optional<SearchStrategy> search_strategy;
  ffi::Optional<ffi::String> task_name;
  int num_threads;
  TRandState rand_state;
  ffi::Function logger;
 
  static void RegisterReflection() {
    namespace refl = tvm::ffi::reflection;
    refl::ObjectDef<TuneContextObj>()
        .def_ro("mod", &TuneContextObj::mod)
        .def_ro("target", &TuneContextObj::target)
        .def_ro("space_generator", &TuneContextObj::space_generator)
        .def_ro("search_strategy", &TuneContextObj::search_strategy)
        .def_ro("task_name", &TuneContextObj::task_name)
        .def_ro("num_threads", &TuneContextObj::num_threads)
        .def_ro("rand_state", &TuneContextObj::rand_state);
    // `logger` is not registered
  }
 
  void Initialize();
  TuneContext Clone() const;
 
  static constexpr const bool _type_mutable = true;
  TVM_FFI_DECLARE_OBJECT_INFO_FINAL("s_tir.meta_schedule.TuneContext", TuneContextObj, ffi::Object);
};
 
class TuneContext : public ffi::ObjectRef {
 public:
  using TRandState = LinearCongruentialEngine::TRandState;
  explicit TuneContext(ffi::ObjectPtr<TuneContextObj> data) : ffi::ObjectRef(data) {
    TVM_FFI_ICHECK(data != nullptr);
  }
  TVM_DLL explicit TuneContext(ffi::Optional<IRModule> mod, ffi::Optional<Target> target,
                               ffi::Optional<SpaceGenerator> space_generator,
                               ffi::Optional<SearchStrategy> search_strategy,
                               ffi::Optional<ffi::String> task_name, int num_threads,
                               TRandState rand_state, ffi::Function logger);
  TVM_FFI_DEFINE_OBJECT_REF_METHODS_NOTNULLABLE(TuneContext, ffi::ObjectRef, TuneContextObj);
};
 
}  // namespace meta_schedule
}  // namespace s_tir
}  // namespace tvm
 
#endif  // TVM_S_TIR_META_SCHEDULE_TUNE_CONTEXT_H_