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/ffi/container/array.h>
#include <tvm/ffi/function.h>
#include <tvm/ffi/reflection/registry.h>
#include <tvm/ir/module.h>
#include <tvm/meta_schedule/mutator.h>
#include <tvm/meta_schedule/postproc.h>
#include <tvm/meta_schedule/schedule_rule.h>
#include <tvm/runtime/object.h>
#include <tvm/target/target.h>
#include <tvm/tir/schedule/schedule.h>
 
namespace tvm {
namespace meta_schedule {
 
// Forward declaration
class TuneContext;
class SpaceGenerator;
 
class SpaceGeneratorNode : public runtime::Object {
 public:
  ffi::Optional<ffi::Array<ScheduleRule>> sch_rules;
  ffi::Optional<ffi::Array<Postproc>> postprocs;
  ffi::Optional<ffi::Map<Mutator, FloatImm>> mutator_probs;
 
  static void RegisterReflection() {
    namespace refl = tvm::ffi::reflection;
    refl::ObjectDef<SpaceGeneratorNode>()
        .def_ro("sch_rules", &SpaceGeneratorNode::sch_rules)
        .def_ro("postprocs", &SpaceGeneratorNode::postprocs)
        .def_ro("mutator_probs", &SpaceGeneratorNode::mutator_probs);
  }
 
  virtual ~SpaceGeneratorNode() = default;
 
  virtual void InitializeWithTuneContext(const TuneContext& context);
 
  virtual ffi::Array<tir::Schedule> GenerateDesignSpace(const IRModule& mod) = 0;
 
  virtual SpaceGenerator Clone() const = 0;
 
  static constexpr const bool _type_mutable = true;
  TVM_FFI_DECLARE_OBJECT_INFO("meta_schedule.SpaceGenerator", SpaceGeneratorNode, Object);
};
 
class SpaceGenerator : public runtime::ObjectRef {
 public:
  explicit SpaceGenerator(ObjectPtr<SpaceGeneratorNode> data) : ObjectRef(data) {
    TVM_FFI_ICHECK(data != nullptr);
  }
  using FInitializeWithTuneContext = ffi::TypedFunction<void(const TuneContext&)>;
  using FGenerateDesignSpace = ffi::TypedFunction<ffi::Array<tir::Schedule>(const IRModule&)>;
  using FClone = ffi::TypedFunction<SpaceGenerator()>;
 
 protected:
  SpaceGenerator() = default;
 
 public:
  TVM_DLL static SpaceGenerator PySpaceGenerator(
      ffi::Optional<ffi::Array<ScheduleRule>> sch_rules,
      ffi::Optional<ffi::Array<Postproc>> postprocs,
      ffi::Optional<ffi::Map<Mutator, FloatImm>> mutator_probs,
      FInitializeWithTuneContext f_initialize_with_tune_context,
      FGenerateDesignSpace f_generate_design_space, FClone f_clone);
  TVM_DLL static SpaceGenerator ScheduleFn(
      ffi::Function schedule_fn, ffi::Optional<ffi::Array<ScheduleRule>> sch_rules,
      ffi::Optional<ffi::Array<Postproc>> postprocs,
      ffi::Optional<ffi::Map<Mutator, FloatImm>> mutator_probs);
  TVM_DLL static SpaceGenerator SpaceGeneratorUnion(
      ffi::Array<SpaceGenerator, void> space_generators,
      ffi::Optional<ffi::Array<ScheduleRule>> sch_rules,
      ffi::Optional<ffi::Array<Postproc>> postprocs,
      ffi::Optional<ffi::Map<Mutator, FloatImm>> mutator_probs);
  TVM_DLL static SpaceGenerator PostOrderApply(
      ffi::Function f_block_filter, ffi::Optional<ffi::Array<ScheduleRule>> sch_rules,
      ffi::Optional<ffi::Array<Postproc>> postprocs,
      ffi::Optional<ffi::Map<Mutator, FloatImm>> mutator_probs);
  TVM_FFI_DEFINE_OBJECT_REF_METHODS_NOTNULLABLE(SpaceGenerator, ObjectRef, SpaceGeneratorNode);
};
 
class PySpaceGeneratorNode : public SpaceGeneratorNode {
 public:
  using FInitializeWithTuneContext = SpaceGenerator::FInitializeWithTuneContext;
  using FGenerateDesignSpace = SpaceGenerator::FGenerateDesignSpace;
  using FClone = SpaceGenerator::FClone;
  FInitializeWithTuneContext f_initialize_with_tune_context;
  FGenerateDesignSpace f_generate_design_space;
  FClone f_clone;
 
  static void RegisterReflection() {
    // `f_initialize_with_tune_context` is not registered
    // `f_generate_design_space` is not registered
    // `f_clone` is not registered
  }
 
  void InitializeWithTuneContext(const TuneContext& context) final;
  ffi::Array<tir::Schedule> GenerateDesignSpace(const IRModule& mod) final;
  SpaceGenerator Clone() const final;
  TVM_FFI_DECLARE_OBJECT_INFO_FINAL("meta_schedule.PySpaceGenerator", PySpaceGeneratorNode,
                                    SpaceGeneratorNode);
};
 
}  // namespace meta_schedule
}  // namespace tvm
 
#endif  // TVM_META_SCHEDULE_SPACE_GENERATOR_H_