2 * Copyright (c) 2019 Samsung Electronics Co., Ltd. All Rights Reserved
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
17 #include <compiler/HEScheduler.h>
18 #include <exec/ExecTime.h>
21 #include <ir/InternalType.h>
22 #include <ir/TypeInfo.h>
23 #include <ir/DataType.h>
25 #include <ir/operation/BinaryArithmetic.h>
26 #include <ir/operation/FullyConnected.h>
28 #include <gtest/gtest.h>
32 using namespace onert;
34 using namespace backend;
35 using namespace operation;
39 // Mock backends classes
42 struct MockConfigCPU : public IConfig
44 std::string id() override { return "cpu"; }
45 bool initialize() override { return true; };
46 bool supportPermutation() override { return false; }
47 Layout supportLayout(const Operation &, Layout) override { return Layout::UNKNOWN; }
48 bool supportDynamicTensor() override { return false; }
49 bool supportFP16() override { return false; }
52 class MockBackendContext : public BackendContext
55 using BackendContext::BackendContext;
56 ITensorRegistry *genTensors() override { return nullptr; }
57 FunctionMap genKernels() override { return {}; }
60 struct MockBackendCPU : public Backend
62 std::shared_ptr<IConfig> config() const override { return std::make_shared<MockConfigCPU>(); }
63 std::unique_ptr<BackendContext> newContext(ContextData &&data) const override
65 return std::make_unique<MockBackendContext>(this, std::move(data), nullptr);
69 struct MockConfigGPU : public IConfig
71 std::string id() override { return "gpu"; }
72 bool initialize() override { return true; };
73 bool supportPermutation() override { return false; }
74 ir::Layout supportLayout(const ir::Operation &, ir::Layout) override
76 return ir::Layout::UNKNOWN;
78 bool supportDynamicTensor() override { return false; }
79 bool supportFP16() override { return false; }
82 struct MockBackendGPU : public Backend
84 std::shared_ptr<IConfig> config() const override { return std::make_shared<MockConfigGPU>(); }
85 std::unique_ptr<BackendContext> newContext(ContextData &&data) const override
87 return std::make_unique<MockBackendContext>(this, std::move(data), nullptr);
91 struct MockConfigNPU : public IConfig
93 std::string id() override { return "npu"; }
94 bool initialize() override { return true; };
95 bool supportPermutation() override { return false; }
96 ir::Layout supportLayout(const ir::Operation &, ir::Layout) override
98 return ir::Layout::UNKNOWN;
100 bool supportDynamicTensor() override { return false; }
101 bool supportFP16() override { return false; }
104 struct MockBackendNPU : public Backend
106 std::shared_ptr<IConfig> config() const override { return std::make_shared<MockConfigNPU>(); }
107 std::unique_ptr<BackendContext> newContext(ContextData &&data) const override
109 return std::make_unique<MockBackendContext>(this, std::move(data), nullptr);
117 const int OPERAND_ELEMS = 268203;
118 const int OPERAND_SIZE = OPERAND_ELEMS * 4;
119 const int OPERATION_SIZE = OPERAND_SIZE * 3;
121 const std::string LINEAR("Linear");
122 const std::string DATAFLOW("Dataflow");
123 const std::string PARALLEL("Parallel");
129 // Set executor through environment variable
130 void setExecutor(const std::string &executor) { setenv("EXECUTOR", executor.c_str(), true); }
132 // Set profiling mode through environment variable
133 void setProfilingMode(const bool value) { setenv("PROFILING_MODE", value ? "1" : "0", true); }
135 // Calculate operation size by addition sizes of all input and output operands
136 uint32_t calcOpSize(const std::shared_ptr<Graph> &graph, const OperationIndex &op_idx)
139 const auto &op = graph->operations().at(op_idx);
140 for (const auto &ind : op.getInputs() + op.getOutputs())
141 size += graph->operands().at(ind).info().total_size();
145 // Set execution operation time. This method is needed since ExecutionTime has only
146 // 'updateOperationExecTime' method.
147 void setOperationExecTime(ExecTime &et, const Backend *backend, const std::string &operation,
148 bool quant, uint32_t op_size, int64_t time)
150 // You shouldn't set negative time with this method since nnfw JSON deserializer can't read it
152 int64_t prev_time = et.getOperationExecTime(backend, operation, quant, op_size);
153 int64_t time_to_set = prev_time == ExecTime::NOT_FOUND ? time : 2 * time - prev_time;
154 et.updateOperationExecTime(backend, operation, quant, op_size, time_to_set);
155 assert(et.getOperationExecTime(backend, operation, quant, op_size) == time);
158 // Set same execution time for all given backends/operations
159 void setOperationsExecutionTime(const std::vector<const Backend *> &backends,
160 const std::vector<std::string> &op_names,
161 const std::vector<uint32_t> &op_sizes, int64_t exec_time)
163 assert(op_names.size() == op_sizes.size());
164 ExecTime et(backends);
165 for (int i = 0; i < op_names.size(); ++i)
167 for (auto &backend : backends)
168 setOperationExecTime(et, backend, op_names[i], false, op_sizes[i], exec_time);
170 et.storeOperationsExecTime();
173 // Set permute time from one backend to another. This method is needed since ExecutionTime has only
174 // 'updatePermuteTime' method.
175 void setPermutationTime(ExecTime &et, const Backend *from_backend, const Backend *to_backend,
176 bool quant, uint32_t op_size, int64_t time)
178 // You shouldn't set negative time with this method since nnfw JSON deserializer can't read it
180 int64_t prev_time = et.getPermuteTime(from_backend, to_backend, quant, op_size);
181 int64_t time_to_set = prev_time == ExecTime::NOT_FOUND ? time : 2 * time - prev_time;
182 et.updatePermuteTime(from_backend, to_backend, quant, op_size, time_to_set);
183 assert(et.getPermuteTime(from_backend, to_backend, quant, op_size) == time);
186 // Set same permutation time between all given backends
187 void setPermutationsExecutionTime(const std::vector<const Backend *> &backends,
188 const int operand_size, const int64_t exec_time)
190 ExecTime et(backends);
191 for (const auto &backend : backends)
193 for (auto &other_backend : backends)
195 if (backend == other_backend)
197 setPermutationTime(et, backend, other_backend, false, operand_size, exec_time);
200 et.storeOperationsExecTime();
204 // Functions for creating graphs
207 using OIS = OperandIndexSequence;
209 template <typename NodeT, typename... Types>
210 OperationIndex create(std::shared_ptr<Graph> graph, Types &&... args)
212 auto op = std::make_unique<NodeT>(std::forward<Types>(args)...);
213 auto op_idx = graph->addOperation(std::move(op));
214 // For now in scheduler test all operations in tested graphs has same size (for simplicity)
215 assert(calcOpSize(graph, op_idx) == OPERATION_SIZE);
219 // Create straight graph: Add->Sub->Mul
220 std::shared_ptr<Graph> createStraightGraph()
222 auto graph = std::make_shared<Graph>();
223 const TypeInfo float_op(DataType::FLOAT32);
226 auto add_lhs_idx = graph->addOperand(ir::Shape{OPERAND_ELEMS}, float_op);
227 auto add_rhs_idx = graph->addOperand(ir::Shape{OPERAND_ELEMS}, float_op);
228 auto add_out_idx = graph->addOperand(ir::Shape{OPERAND_ELEMS}, float_op);
229 BinaryArithmetic::Param add_op_params{BinaryArithmetic::ArithmeticType::ADD, Activation::NONE};
230 create<BinaryArithmetic>(graph, OIS{add_lhs_idx, add_rhs_idx}, OIS{add_out_idx}, add_op_params);
233 auto sub_const_idx = graph->addOperand(ir::Shape{OPERAND_ELEMS}, float_op);
234 auto sub_out_idx = graph->addOperand(ir::Shape{OPERAND_ELEMS}, float_op);
235 BinaryArithmetic::Param sub_op_params{BinaryArithmetic::ArithmeticType::SUB, Activation::NONE};
236 create<BinaryArithmetic>(graph, OIS{add_out_idx, sub_const_idx}, OIS{sub_out_idx}, sub_op_params);
239 auto mul_const_idx = graph->addOperand(ir::Shape{OPERAND_ELEMS}, float_op);
240 auto mul_out_idx = graph->addOperand(ir::Shape{OPERAND_ELEMS}, float_op);
241 BinaryArithmetic::Param mul_op_params{BinaryArithmetic::ArithmeticType::MUL, Activation::NONE};
242 create<BinaryArithmetic>(graph, OIS{sub_out_idx, mul_const_idx}, OIS{mul_out_idx}, mul_op_params);
248 /* Create branched graph:
257 std::shared_ptr<Graph> createBranchedGraph()
259 auto graph = std::make_shared<Graph>();
260 const TypeInfo float_op(DataType::FLOAT32);
263 auto add_lhs_idx = graph->addOperand(ir::Shape{OPERAND_ELEMS}, float_op);
264 auto add_rhs_idx = graph->addOperand(ir::Shape{OPERAND_ELEMS}, float_op);
265 auto add_out_idx = graph->addOperand(ir::Shape{OPERAND_ELEMS}, float_op);
266 BinaryArithmetic::Param add_op_params{BinaryArithmetic::ArithmeticType::ADD, Activation::NONE};
267 create<BinaryArithmetic>(graph, OIS{add_lhs_idx, add_rhs_idx}, OIS{add_out_idx}, add_op_params);
270 auto mul1_const_idx = graph->addOperand(ir::Shape{OPERAND_ELEMS}, float_op);
271 auto mul1_out_idx = graph->addOperand(ir::Shape{OPERAND_ELEMS}, float_op);
272 BinaryArithmetic::Param mul1_op_params{BinaryArithmetic::ArithmeticType::MUL, Activation::NONE};
273 create<BinaryArithmetic>(graph, OIS{add_out_idx, mul1_const_idx}, OIS{mul1_out_idx},
277 auto mul2_const_idx = graph->addOperand(ir::Shape{OPERAND_ELEMS}, float_op);
278 auto mul2_out_idx = graph->addOperand(ir::Shape{OPERAND_ELEMS}, float_op);
279 BinaryArithmetic::Param mul2_op_params{BinaryArithmetic::ArithmeticType::MUL, Activation::NONE};
280 create<BinaryArithmetic>(graph, OIS{mul1_out_idx, mul2_const_idx}, OIS{mul2_out_idx},
284 auto fc1_const_idx = graph->addOperand(ir::Shape{OPERAND_ELEMS}, float_op);
285 auto fc1_out_idx = graph->addOperand(ir::Shape{OPERAND_ELEMS}, float_op);
286 FullyConnected::Param fc1_op_params{Activation::NONE};
287 create<FullyConnected>(graph, OIS{add_out_idx, fc1_const_idx}, OIS{fc1_out_idx}, fc1_op_params);
290 auto fc2_const_idx = graph->addOperand(ir::Shape{OPERAND_ELEMS}, float_op);
291 auto fc2_out_idx = graph->addOperand(ir::Shape{OPERAND_ELEMS}, float_op);
292 FullyConnected::Param fc2_op_params{Activation::NONE};
293 create<FullyConnected>(graph, OIS{fc1_out_idx, fc2_const_idx}, OIS{fc2_out_idx}, fc2_op_params);
296 auto sub_out_idx = graph->addOperand(ir::Shape{OPERAND_ELEMS}, float_op);
297 BinaryArithmetic::Param sub_op_params{BinaryArithmetic::ArithmeticType::SUB, Activation::NONE};
298 create<BinaryArithmetic>(graph, OIS{mul2_out_idx, fc2_out_idx}, OIS{sub_out_idx}, sub_op_params);
305 // Tests setup/teardown
308 // SetUp/TearDown methods runs before/after each test and performs actions common for each test
309 class HESchedulerTest : public ::testing::Test
312 void SetUp() override
314 // Initialize mock backends
315 _cpu_backend = new MockBackendCPU();
316 _gpu_backend = new MockBackendGPU();
317 _npu_backend = new MockBackendNPU();
318 _mock_backends = {_cpu_backend, _gpu_backend, _npu_backend};
320 // Remove previous profile data if it exists
321 if (!remove("exec_time.json"))
323 // DO NOTHING (no profile data)
326 // Remember original value of 'EXECUTOR' environment variable
327 char *executor = std::getenv("EXECUTOR");
328 _original_executor = executor == nullptr ? "" : executor;
330 // Remember original value of 'PROFILING_MODE' environment variable
331 char *profiling_mode = std::getenv("PROFILING_MODE");
332 _original_profiling_mode = profiling_mode == nullptr ? "" : profiling_mode;
335 void TearDown() override
340 EXPECT_EQ(remove("exec_time.json"), 0);
341 setenv("EXECUTOR", _original_executor.c_str(), true);
342 setenv("PROFILING_MODE", _original_profiling_mode.c_str(), true);
345 const MockBackendCPU *_cpu_backend{nullptr};
346 const MockBackendGPU *_gpu_backend{nullptr};
347 const MockBackendNPU *_npu_backend{nullptr};
348 std::vector<const Backend *> _mock_backends;
350 std::string _original_executor;
351 std::string _original_profiling_mode;
354 class HESchedulerTestWithExecutorParam : public HESchedulerTest,
355 public testing::WithParamInterface<std::string>
363 // Test scheduler behavior for straight graph with known execution time of all nodes and permutes.
364 TEST_P(HESchedulerTestWithExecutorParam, straight_graph_known_exec_time)
366 setExecutor(GetParam());
370 auto graph(createStraightGraph());
371 subgs.push(ir::SubgraphIndex{0}, graph);
372 OperationIndex add_op_idx(0), sub_op_idx(1), mul_op_idx(2);
374 // Set default execution and transfer time
375 setPermutationsExecutionTime(_mock_backends, OPERAND_SIZE, 1);
376 setOperationsExecutionTime(_mock_backends, {"Add", "Sub", "Mul"},
377 {OPERATION_SIZE, OPERATION_SIZE, OPERATION_SIZE}, 1e4);
380 // Expected behaviour: scheduler assigns different backend to each node
382 // For each backend reduce execution time of one node
383 ExecTime et(_mock_backends);
384 setOperationExecTime(et, _cpu_backend, "Add", false, OPERATION_SIZE, 1);
385 setOperationExecTime(et, _gpu_backend, "Sub", false, OPERATION_SIZE, 1);
386 setOperationExecTime(et, _npu_backend, "Mul", false, OPERATION_SIZE, 1);
387 et.storeOperationsExecTime();
391 compiler::HEScheduler(_mock_backends, compiler::fetchCompilerOptionsFromGlobalConfig(subgs));
392 const auto br = scheduler.schedule(*graph);
393 ASSERT_EQ(br->getBackend(add_op_idx)->config()->id(), "cpu");
394 ASSERT_EQ(br->getBackend(sub_op_idx)->config()->id(), "gpu");
395 ASSERT_EQ(br->getBackend(mul_op_idx)->config()->id(), "npu");
399 // Expected behaviour: scheduler assigns single backend to all nodes because of big transfer time
401 // Increase transfer time
402 setPermutationsExecutionTime(_mock_backends, OPERAND_SIZE, 1e5);
406 compiler::HEScheduler(_mock_backends, compiler::fetchCompilerOptionsFromGlobalConfig(subgs));
407 const auto br = scheduler.schedule(*graph);
408 ASSERT_EQ(br->getBackend(add_op_idx)->config()->id(), "cpu");
409 ASSERT_EQ(br->getBackend(sub_op_idx)->config()->id(), "cpu");
410 ASSERT_EQ(br->getBackend(mul_op_idx)->config()->id(), "cpu");
414 // Test scheduler behavior for branched graph with known execution time of all nodes and permutes
415 TEST_P(HESchedulerTestWithExecutorParam, branched_graph_known_exec_time)
417 const int64_t NPU_ET = 5000;
418 setExecutor(GetParam());
422 auto graph(createBranchedGraph());
423 subgs.push(ir::SubgraphIndex{0}, graph);
424 OperationIndex add_op_idx(0), mul1_op_idx(1), mul2_op_idx(2), fc1_op_idx(3), fc2_op_idx(4),
427 // Set default execution and transfer time
428 setPermutationsExecutionTime(_mock_backends, OPERAND_SIZE, 1000);
429 setOperationsExecutionTime(_mock_backends, {"Add", "Sub", "Mul", "FullyConnected"},
430 {OPERATION_SIZE, OPERATION_SIZE, OPERATION_SIZE, OPERATION_SIZE}, 1e4);
433 // Expected behaviour: for dataflow and linear executors scheduler assigns fastest backend to all
434 // nodes, in case of parallel executor scheduler assigns different backends to branches.
436 // Reduce execution time
437 ExecTime et(_mock_backends);
438 setOperationExecTime(et, _npu_backend, "Add", false, OPERATION_SIZE, NPU_ET);
439 setOperationExecTime(et, _npu_backend, "Mul", false, OPERATION_SIZE, NPU_ET);
440 setOperationExecTime(et, _npu_backend, "Sub", false, OPERATION_SIZE, NPU_ET);
441 setOperationExecTime(et, _npu_backend, "FullyConnected", false, OPERATION_SIZE, NPU_ET);
442 setOperationExecTime(et, _gpu_backend, "Mul", false, OPERATION_SIZE, NPU_ET + 1000);
443 setOperationExecTime(et, _gpu_backend, "FullyConnected", false, OPERATION_SIZE, NPU_ET + 1000);
444 et.storeOperationsExecTime();
448 compiler::HEScheduler(_mock_backends, compiler::fetchCompilerOptionsFromGlobalConfig(subgs));
449 const auto br = scheduler.schedule(*graph);
451 std::string branch1_expected_backend("npu"), branch2_expected_backend("npu");
452 if (GetParam() == PARALLEL)
454 branch1_expected_backend =
455 br->getBackend(mul1_op_idx)->config()->id() == "npu" ? "npu" : "gpu";
456 branch2_expected_backend = branch1_expected_backend == "npu" ? "gpu" : "npu";
459 ASSERT_EQ(br->getBackend(add_op_idx)->config()->id(), "npu");
460 ASSERT_EQ(br->getBackend(mul1_op_idx)->config()->id(), branch1_expected_backend);
461 ASSERT_EQ(br->getBackend(mul2_op_idx)->config()->id(), branch1_expected_backend);
462 ASSERT_EQ(br->getBackend(fc1_op_idx)->config()->id(), branch2_expected_backend);
463 ASSERT_EQ(br->getBackend(fc2_op_idx)->config()->id(), branch2_expected_backend);
464 ASSERT_EQ(br->getBackend(sub_op_idx)->config()->id(), "npu");
468 // Expected behaviour: scheduler assigns single backend to all nodes
470 // Increase execution time for GPU backend
471 ExecTime et(_mock_backends);
472 /* for parallel executor: set a time, that is larger than sum_of_other_branches_nodes_cnt *
473 * npu_exec_time so that npu is prefered: the ith branch will wait for npu until it finishes the
474 * [0;i-1] branches nodes in DFS order. In each branch it goes deep intul doesn't encounter
475 * branching or scheduler assigns another backend to a node*/
476 setOperationExecTime(et, _gpu_backend, "Mul", false, OPERATION_SIZE, NPU_ET * 3 + 1);
477 setOperationExecTime(et, _gpu_backend, "FullyConnected", false, OPERATION_SIZE, NPU_ET * 3 + 1);
478 et.storeOperationsExecTime();
482 compiler::HEScheduler(_mock_backends, compiler::fetchCompilerOptionsFromGlobalConfig(subgs));
483 const auto br = scheduler.schedule(*graph);
484 ASSERT_EQ(br->getBackend(add_op_idx)->config()->id(), "npu");
485 ASSERT_EQ(br->getBackend(mul1_op_idx)->config()->id(), "npu");
486 ASSERT_EQ(br->getBackend(mul2_op_idx)->config()->id(), "npu");
487 ASSERT_EQ(br->getBackend(fc1_op_idx)->config()->id(), "npu");
488 ASSERT_EQ(br->getBackend(fc2_op_idx)->config()->id(), "npu");
489 ASSERT_EQ(br->getBackend(sub_op_idx)->config()->id(), "npu");
493 // SchedulerTestWithExecutorParam tests are parameterized with executor name and runs three times -
494 // one time for each executor
495 INSTANTIATE_TEST_CASE_P(AllExecutors, HESchedulerTestWithExecutorParam,
496 testing::Values(LINEAR, DATAFLOW, PARALLEL));
498 // Test scheduler behavior for branched graph and enabled profiling mode
499 TEST_F(HESchedulerTest, branched_graph_profiling_mode)
503 // Turn on profiling mode
504 setProfilingMode(true);
505 setExecutor(DATAFLOW);
509 auto graph(createBranchedGraph());
510 subgs.push(ir::SubgraphIndex{0}, graph);
511 OperationIndex add_op_idx(0), mul1_op_idx(1), mul2_op_idx(2), fc1_op_idx(3), fc2_op_idx(4),
515 // Expected behaviour: scheduler assigns backends to nodes with unknown execution time
517 // Set execution time for all backends/nodes except for cpu/Sub, npu/Mul, gpu/FC
518 ExecTime et(_mock_backends);
519 setOperationExecTime(et, _cpu_backend, "Add", false, OPERATION_SIZE, ET);
520 setOperationExecTime(et, _cpu_backend, "Mul", false, OPERATION_SIZE, ET + 1);
521 setOperationExecTime(et, _cpu_backend, "FullyConnected", false, OPERATION_SIZE, ET);
522 setOperationExecTime(et, _npu_backend, "Add", false, OPERATION_SIZE, ET);
523 setOperationExecTime(et, _npu_backend, "FullyConnected", false, OPERATION_SIZE, ET);
524 setOperationExecTime(et, _npu_backend, "Sub", false, OPERATION_SIZE, ET);
525 setOperationExecTime(et, _gpu_backend, "Add", false, OPERATION_SIZE, ET);
526 setOperationExecTime(et, _gpu_backend, "Mul", false, OPERATION_SIZE, ET + 1);
527 setOperationExecTime(et, _gpu_backend, "Sub", false, OPERATION_SIZE, ET);
528 et.storeOperationsExecTime();
532 compiler::HEScheduler(_mock_backends, compiler::fetchCompilerOptionsFromGlobalConfig(subgs));
533 const auto br = scheduler.schedule(*graph);
534 ASSERT_EQ(br->getBackend(mul1_op_idx)->config()->id(), "npu");
535 ASSERT_EQ(br->getBackend(mul2_op_idx)->config()->id(), "npu");
536 ASSERT_EQ(br->getBackend(fc1_op_idx)->config()->id(), "gpu");
537 ASSERT_EQ(br->getBackend(fc2_op_idx)->config()->id(), "gpu");
538 ASSERT_EQ(br->getBackend(sub_op_idx)->config()->id(), "cpu");
542 // Expected behaviour: scheduler shuffling backends, so different backends are assigned to
545 // Set execution time for rest backends/nodes (cpu/Sub, npu/Mul, gpu/FC)
546 ExecTime et(_mock_backends);
547 setOperationExecTime(et, _cpu_backend, "Sub", false, OPERATION_SIZE, ET);
548 setOperationExecTime(et, _npu_backend, "Mul", false, OPERATION_SIZE, ET + 1);
549 setOperationExecTime(et, _gpu_backend, "FullyConnected", false, OPERATION_SIZE, ET);
550 et.storeOperationsExecTime();
554 compiler::HEScheduler(_mock_backends, compiler::fetchCompilerOptionsFromGlobalConfig(subgs));
555 const auto br = scheduler.schedule(*graph);
556 ASSERT_NE(br->getBackend(add_op_idx)->config()->id(),
557 br->getBackend(mul1_op_idx)->config()->id());
558 ASSERT_NE(br->getBackend(add_op_idx)->config()->id(),
559 br->getBackend(fc1_op_idx)->config()->id());
560 ASSERT_NE(br->getBackend(mul1_op_idx)->config()->id(),
561 br->getBackend(mul2_op_idx)->config()->id());
562 ASSERT_NE(br->getBackend(fc1_op_idx)->config()->id(),
563 br->getBackend(fc2_op_idx)->config()->id());
564 ASSERT_NE(br->getBackend(mul2_op_idx)->config()->id(),
565 br->getBackend(sub_op_idx)->config()->id());
566 ASSERT_NE(br->getBackend(fc2_op_idx)->config()->id(),
567 br->getBackend(sub_op_idx)->config()->id());
571 // TODO: Add tests with unknown execution and permutation time
573 } // unnamed namespace