tvm
runner.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 #ifndef TVM_META_SCHEDULE_RUNNER_H_
20 #define TVM_META_SCHEDULE_RUNNER_H_
21 
22 #include <tvm/ffi/container/array.h>
23 #include <tvm/ffi/function.h>
24 #include <tvm/ffi/optional.h>
25 #include <tvm/ffi/reflection/registry.h>
26 #include <tvm/ffi/string.h>
27 #include <tvm/ir/expr.h>
29 #include <tvm/runtime/object.h>
30 
31 namespace tvm {
32 namespace meta_schedule {
33 
35 class RunnerInputNode : public runtime::Object {
36  public:
38  ffi::String artifact_path;
40  ffi::String device_type;
42  ffi::Array<ArgInfo> args_info;
43 
44  static void RegisterReflection() {
45  namespace refl = tvm::ffi::reflection;
46  refl::ObjectDef<RunnerInputNode>()
47  .def_ro("artifact_path", &RunnerInputNode::artifact_path)
48  .def_ro("device_type", &RunnerInputNode::device_type)
49  .def_ro("args_info", &RunnerInputNode::args_info);
50  }
51  TVM_FFI_DECLARE_OBJECT_INFO_FINAL("meta_schedule.RunnerInput", RunnerInputNode, runtime::Object);
52 };
53 
58 class RunnerInput : public runtime::ObjectRef {
59  public:
66  TVM_DLL explicit RunnerInput(ffi::String artifact_path, ffi::String device_type,
67  ffi::Array<ArgInfo> args_info);
69 };
70 
72 class RunnerResultNode : public runtime::Object {
73  public:
75  ffi::Optional<ffi::Array<FloatImm>> run_secs;
77  ffi::Optional<ffi::String> error_msg;
78 
79  static void RegisterReflection() {
80  namespace refl = tvm::ffi::reflection;
81  refl::ObjectDef<RunnerResultNode>()
82  .def_ro("run_secs", &RunnerResultNode::run_secs)
83  .def_ro("error_msg", &RunnerResultNode::error_msg);
84  }
85  TVM_FFI_DECLARE_OBJECT_INFO_FINAL("meta_schedule.RunnerResult", RunnerResultNode,
86  runtime::Object);
87 };
88 
93 class RunnerResult : public runtime::ObjectRef {
94  public:
100  TVM_DLL explicit RunnerResult(ffi::Optional<ffi::Array<FloatImm>> run_secs,
101  ffi::Optional<ffi::String> error_msg);
103 };
104 
110 class RunnerFutureNode : public runtime::Object {
111  public:
116  using FDone = ffi::TypedFunction<bool()>;
121  using FResult = ffi::TypedFunction<RunnerResult()>;
122 
127 
128  static void RegisterReflection() {
129  // `f_done` is not registered
130  // `f_result` is not registered
131  }
132 
137  bool Done() const {
138  ICHECK(f_done != nullptr) << "PyRunnerFuture's Done method not implemented!";
139  return f_done();
140  }
146  ICHECK(f_result != nullptr) << "PyRunnerFuture's Result method not implemented!";
147  return f_result();
148  }
150  runtime::Object);
151 };
152 
157 class RunnerFuture : public runtime::ObjectRef {
158  public:
161 
167  TVM_DLL explicit RunnerFuture(FDone f_done, FResult f_result);
169 };
170 
172 class RunnerNode : public runtime::Object {
173  public:
180  using FRun = ffi::TypedFunction<ffi::Array<RunnerFuture>(ffi::Array<RunnerInput>)>;
181 
183  virtual ~RunnerNode() = default;
184 
190  virtual ffi::Array<RunnerFuture> Run(ffi::Array<RunnerInput> runner_inputs) = 0;
191 
192  static constexpr const bool _type_mutable = true;
193  TVM_FFI_DECLARE_OBJECT_INFO("meta_schedule.Runner", RunnerNode, runtime::Object);
194 };
195 
200 class Runner : public runtime::ObjectRef {
201  public:
207  explicit Runner(ObjectPtr<RunnerNode> data) : ObjectRef(data) { TVM_FFI_ICHECK(data != nullptr); }
213  TVM_DLL static Runner PyRunner(FRun f_run);
215 };
216 
218 class PyRunnerNode : public RunnerNode {
219  public:
222 
223  static void RegisterReflection() {
224  // `f_run` is not registered
225  }
226 
227  ffi::Array<RunnerFuture> Run(ffi::Array<RunnerInput> runner_inputs) final {
228  ICHECK(f_run != nullptr) << "PyRunner's Run method not implemented!";
229  return f_run(runner_inputs);
230  }
232 };
233 
234 } // namespace meta_schedule
235 } // namespace tvm
236 
237 #endif // TVM_META_SCHEDULE_RUNNER_H_
An abstract runner with customized build method on the python-side.
Definition: runner.h:218
ffi::Array< RunnerFuture > Run(ffi::Array< RunnerInput > runner_inputs) final
Run the built artifact and get runner futures.
Definition: runner.h:227
TVM_FFI_DECLARE_OBJECT_INFO_FINAL("meta_schedule.PyRunner", PyRunnerNode, RunnerNode)
FRun f_run
The packed function to run the built artifacts and get runner futures.
Definition: runner.h:221
static void RegisterReflection()
Definition: runner.h:223
A class to asynchronously fetch runner's output.
Definition: runner.h:110
TVM_FFI_DECLARE_OBJECT_INFO_FINAL("meta_schedule.RunnerFuture", RunnerFutureNode, runtime::Object)
RunnerResult Result() const
Fetch the runner's output if it is ready.
Definition: runner.h:145
static void RegisterReflection()
Definition: runner.h:128
ffi::TypedFunction< RunnerResult()> FResult
The function type to fetch runner output if it is ready.
Definition: runner.h:121
FDone f_done
The packed function to check whether the runner has finished.
Definition: runner.h:124
FResult f_result
The packed function to fetch runner output if it is ready.
Definition: runner.h:126
bool Done() const
Check whether the runner has finished.
Definition: runner.h:137
ffi::TypedFunction< bool()> FDone
The function type to check whether the runner has finished.
Definition: runner.h:116
Managed reference to RunnerFutureNode.
Definition: runner.h:157
TVM_FFI_DEFINE_OBJECT_REF_METHODS_NOTNULLABLE(RunnerFuture, runtime::ObjectRef, RunnerFutureNode)
RunnerFuture(FDone f_done, FResult f_result)
Constructor of RunnerFuture.
RunnerFutureNode::FDone FDone
Definition: runner.h:159
RunnerFutureNode::FResult FResult
Definition: runner.h:160
Runner's input containing path of artifact, type of device and argument info.
Definition: runner.h:35
TVM_FFI_DECLARE_OBJECT_INFO_FINAL("meta_schedule.RunnerInput", RunnerInputNode, runtime::Object)
static void RegisterReflection()
Definition: runner.h:44
ffi::Array< ArgInfo > args_info
The argument information.
Definition: runner.h:42
ffi::String artifact_path
The path to the built artifact.
Definition: runner.h:38
ffi::String device_type
The type of device.
Definition: runner.h:40
Managed reference to RunnerInputNode.
Definition: runner.h:58
RunnerInput(ffi::String artifact_path, ffi::String device_type, ffi::Array< ArgInfo > args_info)
Constructor of RunnerInput.
TVM_FFI_DEFINE_OBJECT_REF_METHODS_NOTNULLABLE(RunnerInput, runtime::ObjectRef, RunnerInputNode)
The abstract runner interface.
Definition: runner.h:172
ffi::TypedFunction< ffi::Array< RunnerFuture >(ffi::Array< RunnerInput >)> FRun
The function type to run the built artifacts and get runner futures.
Definition: runner.h:180
static constexpr const bool _type_mutable
Definition: runner.h:192
TVM_FFI_DECLARE_OBJECT_INFO("meta_schedule.Runner", RunnerNode, runtime::Object)
virtual ffi::Array< RunnerFuture > Run(ffi::Array< RunnerInput > runner_inputs)=0
Run the built artifact and get runner futures.
virtual ~RunnerNode()=default
Default destructor.
Runner's output containing measurement result of MeasureCandidate or error msg if any.
Definition: runner.h:72
ffi::Optional< ffi::String > error_msg
The error message, if any.
Definition: runner.h:77
TVM_FFI_DECLARE_OBJECT_INFO_FINAL("meta_schedule.RunnerResult", RunnerResultNode, runtime::Object)
static void RegisterReflection()
Definition: runner.h:79
ffi::Optional< ffi::Array< FloatImm > > run_secs
The run time in seconds.
Definition: runner.h:75
Managed reference to RunnerResultNode.
Definition: runner.h:93
RunnerResult(ffi::Optional< ffi::Array< FloatImm >> run_secs, ffi::Optional< ffi::String > error_msg)
Constructor.
TVM_FFI_DEFINE_OBJECT_REF_METHODS_NOTNULLABLE(RunnerResult, runtime::ObjectRef, RunnerResultNode)
Managed reference to RunnerNode.
Definition: runner.h:200
Runner(ObjectPtr< RunnerNode > data)
Constructor from ObjectPtr<RunnerNode>.
Definition: runner.h:207
TVM_FFI_DEFINE_OBJECT_REF_METHODS_NOTNULLABLE(Runner, runtime::ObjectRef, RunnerNode)
static Runner PyRunner(FRun f_run)
Create a runner with customized build method on the python-side.
RunnerNode::FRun FRun
Definition: runner.h:202
Base expr nodes in TVM.
Definition: repr_printer.h:91
constexpr const char * device_type
The device type.
Definition: stmt.h:1063
Performance counters for profiling via the PAPI library.
Definition: analyzer.h:37
A managed object in the TVM runtime.