tvm
mutator.h
Go to the documentation of this file.
1 /*
2  * Licensed to the Apache Software Foundation (ASF) under one
3  * or more contributor license agreements. See the NOTICE file
4  * distributed with this work for additional information
5  * regarding copyright ownership. The ASF licenses this file
6  * to you under the Apache License, Version 2.0 (the
7  * "License"); you may not use this file except in compliance
8  * with the License. You may obtain a copy of the License at
9  *
10  * http://www.apache.org/licenses/LICENSE-2.0
11  *
12  * Unless required by applicable law or agreed to in writing,
13  * software distributed under the License is distributed on an
14  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15  * KIND, either express or implied. See the License for the
16  * specific language governing permissions and limitations
17  * under the License.
18  */
19 
20 #ifndef TVM_META_SCHEDULE_MUTATOR_H_
21 #define TVM_META_SCHEDULE_MUTATOR_H_
22 
23 #include <tvm/ffi/function.h>
24 #include <tvm/ffi/optional.h>
25 #include <tvm/ffi/reflection/registry.h>
26 #include <tvm/runtime/object.h>
29 #include <tvm/tir/schedule/trace.h>
30 
31 namespace tvm {
32 namespace meta_schedule {
33 
34 class TuneContext;
35 class Mutator;
36 
38 class MutatorNode : public runtime::Object {
39  public:
41  virtual ~MutatorNode() = default;
42 
43  static void RegisterReflection() {
44  // No fields to register
45  }
46 
52  virtual void InitializeWithTuneContext(const TuneContext& context) = 0;
53 
60  virtual Optional<tir::Trace> Apply(const tir::Trace& trace,
62 
67  virtual Mutator Clone() const = 0;
68 
69  static constexpr const char* _type_key = "meta_schedule.Mutator";
71 };
72 
77 class Mutator : public runtime::ObjectRef {
78  public:
83  using FInitializeWithTuneContext = ffi::TypedFunction<void(const TuneContext&)>;
89  using FApply = ffi::TypedFunction<Optional<tir::Trace>(
95  using FClone = ffi::TypedFunction<Mutator()>;
100  using FAsString = ffi::TypedFunction<String()>;
102  TVM_DLL static Mutator MutateTileSize();
108  TVM_DLL static Mutator MutateParallel(int64_t max_jobs_per_core);
113  TVM_DLL static Mutator MutateUnroll();
118  TVM_DLL static Mutator MutateComputeLocation();
123  TVM_DLL static Mutator MutateThreadBinding();
132  TVM_DLL static Mutator PyMutator(FInitializeWithTuneContext f_initialize_with_tune_context,
133  FApply f_apply, FClone f_clone, FAsString f_as_string);
135  TVM_DLL static Map<Mutator, FloatImm, void> DefaultLLVM();
137  TVM_DLL static Map<Mutator, FloatImm, void> DefaultCUDA();
139  TVM_DLL static Map<Mutator, FloatImm, void> DefaultCUDATensorCore();
141  TVM_DLL static Map<Mutator, FloatImm, void> DefaultHexagon();
142 
144 };
145 
147 class PyMutatorNode : public MutatorNode {
148  public:
161 
162  static void RegisterReflection() {
163  // `f_initialize_with_tune_context` is not registered
164  // `f_apply` is not registered
165  // `f_clone` is not registered
166  // `f_as_string` is not registered
167  }
168 
169  void InitializeWithTuneContext(const TuneContext& context) final;
170  Optional<tir::Trace> Apply(const tir::Trace& trace,
172  Mutator Clone() const final;
173 
174  static constexpr const char* _type_key = "meta_schedule.PyMutator";
176 };
177 
178 } // namespace meta_schedule
179 } // namespace tvm
180 
181 #endif // TVM_META_SCHEDULE_MUTATOR_H_
Mutator is designed to mutate the trace to explore the design space.
Definition: mutator.h:38
static constexpr const char * _type_key
Definition: mutator.h:69
virtual ~MutatorNode()=default
Virtual destructor.
TVM_DECLARE_BASE_OBJECT_INFO(MutatorNode, Object)
virtual void InitializeWithTuneContext(const TuneContext &context)=0
Initialize the design space generator with tuning context.
virtual Optional< tir::Trace > Apply(const tir::Trace &trace, support::LinearCongruentialEngine::TRandState *rand_state)=0
Apply the mutator function to the given trace.
virtual Mutator Clone() const =0
Clone the mutator.
static void RegisterReflection()
Definition: mutator.h:43
Managed reference to MutatorNode.
Definition: mutator.h:77
static Mutator MutateThreadBinding()
Create a Mutator that mutates auto thread binding.
ffi::TypedFunction< Mutator()> FClone
Clone the mutator.
Definition: mutator.h:95
static Map< Mutator, FloatImm, void > DefaultLLVM()
Create default mutators for LLVM.
static Mutator MutateComputeLocation()
Create a Mutator that mutates the outcome of SampleComputeLocation.
static Map< Mutator, FloatImm, void > DefaultHexagon()
Create default mutators for Hexagon.
static Mutator MutateUnroll()
Create a Mutator that mutates auto unroll step.
static Map< Mutator, FloatImm, void > DefaultCUDA()
Create default mutators for CUDA.
TVM_DEFINE_MUTABLE_OBJECT_REF_METHODS(Mutator, ObjectRef, MutatorNode)
static Mutator MutateTileSize()
Create a Mutator that mutates the decision of instruction Sample-Perfect-Tile.
static Mutator MutateParallel(int64_t max_jobs_per_core)
Create a Mutator that mutates the parallel extent.
static Mutator PyMutator(FInitializeWithTuneContext f_initialize_with_tune_context, FApply f_apply, FClone f_clone, FAsString f_as_string)
Create a mutator with customized methods on the python-side.
ffi::TypedFunction< void(const TuneContext &)> FInitializeWithTuneContext
The function type of InitializeWithTuneContext method.
Definition: mutator.h:83
ffi::TypedFunction< String()> FAsString
Get the mutator as string with name.
Definition: mutator.h:100
static Map< Mutator, FloatImm, void > DefaultCUDATensorCore()
Create default mutators for CUDA with TensorCore.
ffi::TypedFunction< Optional< tir::Trace >(const tir::Trace &, support::LinearCongruentialEngine::TRandState rand_state)> FApply
Apply the mutator function to the given trace.
Definition: mutator.h:90
The mutator with customized methods on the python-side.
Definition: mutator.h:147
Mutator::FApply FApply
Definition: mutator.h:150
FInitializeWithTuneContext f_initialize_with_tune_context
The packed function to the InitializeWithTuneContext function.
Definition: mutator.h:154
Mutator::FClone FClone
Definition: mutator.h:151
static void RegisterReflection()
Definition: mutator.h:162
FAsString f_as_string
The packed function to the AsString function.
Definition: mutator.h:160
Mutator::FAsString FAsString
Definition: mutator.h:152
FApply f_apply
The packed function to the Apply function.
Definition: mutator.h:156
void InitializeWithTuneContext(const TuneContext &context) final
Initialize the design space generator with tuning context.
Mutator Clone() const final
Clone the mutator.
static constexpr const char * _type_key
Definition: mutator.h:174
TVM_DECLARE_FINAL_OBJECT_INFO(PyMutatorNode, MutatorNode)
FClone f_clone
The packed function to the Clone function.
Definition: mutator.h:158
Mutator::FInitializeWithTuneContext FInitializeWithTuneContext
Definition: mutator.h:149
Optional< tir::Trace > Apply(const tir::Trace &trace, support::LinearCongruentialEngine::TRandState *rand_state) final
Apply the mutator function to the given trace.
Managed reference to TuneContextNode.
Definition: tune_context.h:98
int64_t TRandState
Definition: random_engine.h:46
Managed reference to TraceNode.
Definition: trace.h:143
Performance counters for profiling via the PAPI library.
Definition: analyzer.h:37
A managed object in the TVM runtime.
Random number generator. It provides a generic interface consistent with std::uniform_random_bit_gene...