integration.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_INTEGRATION_H_
#define TVM_META_SCHEDULE_INTEGRATION_H_

#include <tvm/meta_schedule/database.h>
#include <tvm/support/with.h>

#include <unordered_set>

namespace tvm {
namespace meta_schedule {

/**************** ExtractedTask ****************/

class ExtractedTaskNode : public runtime::Object {
 public:
  String task_name;
  IRModule mod;
  Array<IRModule> dispatched;

  void VisitAttrs(AttrVisitor* v) {
    v->Visit("task_name", &task_name);
    v->Visit("mod", &mod);
    v->Visit("dispatched", &dispatched);
  }

  static constexpr const char* _type_key = "meta_schedule.ExtractedTask";
  TVM_DECLARE_FINAL_OBJECT_INFO(ExtractedTaskNode, runtime::Object);
};

class ExtractedTask : public runtime::ObjectRef {
 public:
  explicit ExtractedTask(String task_name, IRModule mod, Array<IRModule> dispatched);
  TVM_DEFINE_NOTNULLABLE_OBJECT_REF_METHODS(ExtractedTask, runtime::ObjectRef, ExtractedTaskNode);
};

/**************** MetaScheduleContext ****************/

class MetaScheduleContextNode : public runtime::Object {
 public:
  virtual ~MetaScheduleContextNode() = default;
  virtual Optional<ObjectRef> Query(runtime::String task_name, IRModule mod,
                                    Optional<Array<IRModule>> dispatched) = 0;

  static constexpr const char* _type_key = "meta_schedule.MetaScheduleContext";
  TVM_DECLARE_BASE_OBJECT_INFO(MetaScheduleContextNode, runtime::Object);
};

class MetaScheduleContext : public runtime::ObjectRef {
  friend class MetaScheduleContextInternal;
  friend class With<MetaScheduleContext>;

 public:
  virtual ~MetaScheduleContext() = default;
  static Optional<MetaScheduleContext> Current();
  static Optional<ObjectRef> QueryInsideWithScope(runtime::String task_name, IRModule mod,
                                                  Optional<Array<IRModule>> dispatched);

  TVM_DEFINE_MUTABLE_NOTNULLABLE_OBJECT_REF_METHODS(MetaScheduleContext, runtime::ObjectRef,
                                                    MetaScheduleContextNode);

 protected:
  MetaScheduleContext() = default;
  void EnterWithScope();
  void ExitWithScope();
};

/**************** TaskExtraction ****************/

class TaskExtractionNode : public MetaScheduleContextNode {
 public:
  Array<ExtractedTask> tasks{nullptr};

  void VisitAttrs(AttrVisitor* v) { v->Visit("tasks", &tasks); }

  // Inherited from base class
  Optional<ObjectRef> Query(runtime::String task_name, IRModule mod,
                            Optional<Array<IRModule>> dispatched) final;

  static constexpr const char* _type_key = "meta_schedule.TaskExtraction";
  TVM_DECLARE_FINAL_OBJECT_INFO(TaskExtractionNode, MetaScheduleContextNode);
};

class TaskExtraction : public MetaScheduleContext {
 public:
  TaskExtraction();
  TVM_DEFINE_MUTABLE_NOTNULLABLE_OBJECT_REF_METHODS(TaskExtraction, MetaScheduleContext,
                                                    TaskExtractionNode);
};

/**************** ApplyHistoryBest ****************/

class ApplyHistoryBestNode : public MetaScheduleContextNode {
 public:
  Database database{nullptr};

  void VisitAttrs(AttrVisitor* v) {
    v->Visit("database", &database);  //
  }

  // Inherited from base class
  Optional<ObjectRef> Query(runtime::String task_name, IRModule mod,
                            Optional<Array<IRModule>> dispatched) final;

  static constexpr const char* _type_key = "meta_schedule.ApplyHistoryBest";
  TVM_DECLARE_FINAL_OBJECT_INFO(ApplyHistoryBestNode, MetaScheduleContextNode);
};

class ApplyHistoryBest : public MetaScheduleContext {
 public:
  explicit ApplyHistoryBest(Database database);
  TVM_DEFINE_MUTABLE_NOTNULLABLE_OBJECT_REF_METHODS(ApplyHistoryBest, MetaScheduleContext,
                                                    ApplyHistoryBestNode);
};

}  // namespace meta_schedule
}  // namespace tvm

#endif  // TVM_META_SCHEDULE_INTEGRATION_H_