mutator.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_MUTATOR_H_
#define TVM_S_TIR_META_SCHEDULE_MUTATOR_H_
 
#include <tvm/ffi/function.h>
#include <tvm/ffi/optional.h>
#include <tvm/ffi/reflection/registry.h>
#include <tvm/ir/prim/expr.h>
#include <tvm/runtime/base.h>
#include <tvm/s_tir/random_engine.h>
#include <tvm/s_tir/schedule/schedule.h>
#include <tvm/s_tir/schedule/trace.h>
 
namespace tvm {
namespace s_tir {
namespace meta_schedule {
 
class TuneContext;
class Mutator;
 
class MutatorObj : public ffi::Object {
 public:
  virtual ~MutatorObj() = default;
 
  static void RegisterReflection() {
    namespace refl = tvm::ffi::reflection;
    refl::ObjectDef<MutatorObj>();
  }
 
  virtual void InitializeWithTuneContext(const TuneContext& context) = 0;
 
  virtual ffi::Optional<s_tir::Trace> Apply(const s_tir::Trace& trace,
                                            LinearCongruentialEngine::TRandState* rand_state) = 0;
 
  virtual Mutator Clone() const = 0;
 
  static constexpr const bool _type_mutable = true;
  TVM_FFI_DECLARE_OBJECT_INFO("s_tir.meta_schedule.Mutator", MutatorObj, ffi::Object);
};
 
class Mutator : public ffi::ObjectRef {
 public:
  explicit Mutator(ffi::UnsafeInit tag, ffi::ObjectPtr<MutatorObj> data) : ffi::ObjectRef(tag) {
    data_ = std::move(data);
  }
 
  using FInitializeWithTuneContext = ffi::TypedFunction<void(const TuneContext&)>;
  using FApply = ffi::TypedFunction<ffi::Optional<s_tir::Trace>(
      const s_tir::Trace&, LinearCongruentialEngine::TRandState rand_state)>;
  using FClone = ffi::TypedFunction<Mutator()>;
  TVM_DLL static Mutator MutateTileSize();
  TVM_DLL static Mutator MutateParallel(int64_t max_jobs_per_core);
  TVM_DLL static Mutator MutateUnroll();
  TVM_DLL static Mutator MutateComputeLocation();
  TVM_DLL static Mutator MutateThreadBinding();
  TVM_DLL static Mutator PyMutator(FInitializeWithTuneContext f_initialize_with_tune_context,
                                   FApply f_apply, FClone f_clone);
  TVM_DLL static ffi::Map<Mutator, FloatImm, void> DefaultLLVM();
  TVM_DLL static ffi::Map<Mutator, FloatImm, void> DefaultCUDA();
  TVM_DLL static ffi::Map<Mutator, FloatImm, void> DefaultCUDATensorCore();
  TVM_DLL static ffi::Map<Mutator, FloatImm, void> DefaultHexagon();
 
  TVM_FFI_DEFINE_OBJECT_REF_METHODS_NOTNULLABLE(Mutator, ffi::ObjectRef, MutatorObj);
};
 
class PyMutatorObj : public MutatorObj {
 public:
  using FInitializeWithTuneContext = Mutator::FInitializeWithTuneContext;
  using FApply = Mutator::FApply;
  using FClone = Mutator::FClone;
  FInitializeWithTuneContext f_initialize_with_tune_context;
  FApply f_apply;
  FClone f_clone;
 
  static void RegisterReflection() {
    namespace refl = tvm::ffi::reflection;
    refl::ObjectDef<PyMutatorObj>();
    // `f_initialize_with_tune_context` is not registered
    // `f_apply` is not registered
    // `f_clone` is not registered
  }
 
  void InitializeWithTuneContext(const TuneContext& context) final;
  ffi::Optional<s_tir::Trace> Apply(const s_tir::Trace& trace,
                                    LinearCongruentialEngine::TRandState* rand_state) final;
  Mutator Clone() const final;
  TVM_FFI_DECLARE_OBJECT_INFO_FINAL("s_tir.meta_schedule.PyMutator", PyMutatorObj, MutatorObj);
};
 
}  // namespace meta_schedule
}  // namespace s_tir
}  // namespace tvm
 
#endif  // TVM_S_TIR_META_SCHEDULE_MUTATOR_H_