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_META_SCHEDULE_TUNE_CONTEXT_H_
#define TVM_META_SCHEDULE_TUNE_CONTEXT_H_

#include <tvm/ir/expr.h>
#include <tvm/ir/module.h>
#include <tvm/meta_schedule/builder.h>
#include <tvm/meta_schedule/mutator.h>
#include <tvm/meta_schedule/postproc.h>
#include <tvm/meta_schedule/runner.h>
#include <tvm/meta_schedule/schedule_rule.h>
#include <tvm/meta_schedule/search_strategy.h>
#include <tvm/meta_schedule/space_generator.h>
#include <tvm/node/reflection.h>
#include <tvm/runtime/container/array.h>
#include <tvm/runtime/container/map.h>
#include <tvm/runtime/container/optional.h>
#include <tvm/runtime/container/string.h>
#include <tvm/runtime/object.h>
#include <tvm/runtime/packed_func.h>
#include <tvm/support/random_engine.h>
#include <tvm/target/target.h>

namespace tvm {
namespace meta_schedule {

class TaskSchedulerNode;
class MeasureCallback;

class TuneContextNode : public runtime::Object {
 public:
  Optional<IRModule> mod;
  Optional<Target> target;
  Optional<SpaceGenerator> space_generator;
  Optional<SearchStrategy> search_strategy;
  Array<ScheduleRule> sch_rules;
  Array<Postproc> postprocs;
  Map<Mutator, FloatImm> mutator_probs;
  Optional<String> task_name;
  PackedFunc logging_func;
  support::LinearCongruentialEngine::TRandState rand_state;
  int num_threads;

  bool is_terminated;  // TODO(@junrushao1994): move to TaskScheduler
  Optional<Array<MeasureCandidate>> measure_candidates;
  Optional<Array<BuilderResult>> builder_results;
  Optional<Array<RunnerFuture>> runner_futures;

  void VisitAttrs(tvm::AttrVisitor* v) {
    v->Visit("mod", &mod);
    v->Visit("target", &target);
    v->Visit("space_generator", &space_generator);
    v->Visit("search_strategy", &search_strategy);
    v->Visit("sch_rules", &sch_rules);
    v->Visit("postprocs", &postprocs);
    v->Visit("mutator_probs", &mutator_probs);
    v->Visit("task_name", &task_name);
    // `logging_func` is not visited
    v->Visit("rand_state", &rand_state);
    v->Visit("num_threads", &num_threads);
    v->Visit("is_terminated", &is_terminated);
    v->Visit("measure_candidates", &measure_candidates);
    v->Visit("builder_results", &builder_results);
    v->Visit("runner_futures", &runner_futures);
  }

  void Initialize();
  void _SetMeasureCandidates(const Array<MeasureCandidate>& candidates);
  void _SendToBuilder(const Builder& builder);
  void _SendToRunner(const Runner& runner);
  Array<RunnerResult> _Join();
  void _ClearMeasureState();
  static constexpr const char* _type_key = "meta_schedule.TuneContext";
  TVM_DECLARE_FINAL_OBJECT_INFO(TuneContextNode, Object);
};

class TuneContext : public runtime::ObjectRef {
 public:
  TVM_DLL explicit TuneContext(Optional<IRModule> mod,                                    //
                               Optional<Target> target,                                   //
                               Optional<SpaceGenerator> space_generator,                  //
                               Optional<SearchStrategy> search_strategy,                  //
                               Optional<Array<ScheduleRule>> sch_rules,                   //
                               Optional<Array<Postproc>> postprocs,                       //
                               Optional<Map<Mutator, FloatImm>> mutator_probs,            //
                               Optional<String> task_name,                                //
                               PackedFunc logging_func,                                   //
                               support::LinearCongruentialEngine::TRandState rand_state,  //
                               int num_threads);
  TVM_DEFINE_MUTABLE_NOTNULLABLE_OBJECT_REF_METHODS(TuneContext, ObjectRef, TuneContextNode);
};

}  // namespace meta_schedule
}  // namespace tvm

#endif  // TVM_META_SCHEDULE_TUNE_CONTEXT_H_