space_generator.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_SPACE_GENERATOR_H_
#define TVM_META_SCHEDULE_SPACE_GENERATOR_H_

#include <tvm/ir/module.h>
#include <tvm/tir/schedule/schedule.h>

namespace tvm {
namespace meta_schedule {

// Forward declaration
class TuneContext;

class SpaceGeneratorNode : public Object {
 public:
  virtual ~SpaceGeneratorNode() = default;

  virtual void InitializeWithTuneContext(const TuneContext& tune_context) = 0;

  virtual Array<tir::Schedule> GenerateDesignSpace(const IRModule& mod) = 0;

  static constexpr const char* _type_key = "meta_schedule.SpaceGenerator";
  TVM_DECLARE_BASE_OBJECT_INFO(SpaceGeneratorNode, Object);
};

class PySpaceGeneratorNode : public SpaceGeneratorNode {
 public:
  using FInitializeWithTuneContext = runtime::TypedPackedFunc<void(const TuneContext&)>;
  using FGenerateDesignSpace = runtime::TypedPackedFunc<Array<tir::Schedule>(const IRModule&)>;

  FInitializeWithTuneContext f_initialize_with_tune_context;
  FGenerateDesignSpace f_generate_design_space;

  void VisitAttrs(tvm::AttrVisitor* v) {
    // `f_initialize_with_tune_context` is not visited
    // `f_generate_design_space` is not visited
  }

  void InitializeWithTuneContext(const TuneContext& tune_context) final {
    ICHECK(f_initialize_with_tune_context != nullptr)
        << "PySpaceGenerator's InitializeWithTuneContext !";
    f_initialize_with_tune_context(tune_context);
  }

  Array<tir::Schedule> GenerateDesignSpace(const IRModule& mod) final {
    ICHECK(f_generate_design_space != nullptr)
        << "PySpaceGenerator's GenerateDesignSpace method not implemented!";
    return f_generate_design_space(mod);
  }

  static constexpr const char* _type_key = "meta_schedule.PySpaceGenerator";
  TVM_DECLARE_FINAL_OBJECT_INFO(PySpaceGeneratorNode, SpaceGeneratorNode);
};

class SpaceGenerator : public ObjectRef {
 protected:
  SpaceGenerator() = default;

 public:
  TVM_DLL static SpaceGenerator PySpaceGenerator(
      PySpaceGeneratorNode::FInitializeWithTuneContext initialize_with_tune_context_func,
      PySpaceGeneratorNode::FGenerateDesignSpace generate_design_space_func);

  TVM_DLL static SpaceGenerator SpaceGeneratorUnion(Array<SpaceGenerator, void> space_generators);
  TVM_DEFINE_MUTABLE_NOTNULLABLE_OBJECT_REF_METHODS(SpaceGenerator, ObjectRef, SpaceGeneratorNode);
};

}  // namespace meta_schedule
}  // namespace tvm

#endif  // TVM_META_SCHEDULE_SPACE_GENERATOR_H_