Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 1 | /* |
Georgios Pinitas | 77d4252 | 2019-11-05 13:35:47 +0000 | [diff] [blame] | 2 | * Copyright (c) 2017-2019 ARM Limited. |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 3 | * |
| 4 | * SPDX-License-Identifier: MIT |
| 5 | * |
| 6 | * Permission is hereby granted, free of charge, to any person obtaining a copy |
| 7 | * of this software and associated documentation files (the "Software"), to |
| 8 | * deal in the Software without restriction, including without limitation the |
| 9 | * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or |
| 10 | * sell copies of the Software, and to permit persons to whom the Software is |
| 11 | * furnished to do so, subject to the following conditions: |
| 12 | * |
| 13 | * The above copyright notice and this permission notice shall be included in all |
| 14 | * copies or substantial portions of the Software. |
| 15 | * |
| 16 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
| 17 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
| 18 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
| 19 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
| 20 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
| 21 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE |
| 22 | * SOFTWARE. |
| 23 | */ |
Michalis Spyrou | f464337 | 2019-11-29 16:17:13 +0000 | [diff] [blame] | 24 | #ifndef ARM_COMPUTE_ISCHEDULER_H |
| 25 | #define ARM_COMPUTE_ISCHEDULER_H |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 26 | |
Moritz Pflanzer | c186b57 | 2017-09-07 09:48:04 +0100 | [diff] [blame] | 27 | #include "arm_compute/core/CPP/CPPTypes.h" |
| 28 | |
Anthony Barbier | 52ecb06 | 2018-05-25 13:32:10 +0100 | [diff] [blame] | 29 | #include <functional> |
| 30 | |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 31 | namespace arm_compute |
| 32 | { |
| 33 | class ICPPKernel; |
| 34 | |
| 35 | /** Scheduler interface to run kernels */ |
| 36 | class IScheduler |
| 37 | { |
| 38 | public: |
Anthony Barbier | 376c85f | 2018-05-25 14:17:21 +0100 | [diff] [blame] | 39 | /** Strategies available to split a workload */ |
| 40 | enum class StrategyHint |
| 41 | { |
| 42 | STATIC, /**< Split the workload evenly among the threads */ |
| 43 | DYNAMIC, /**< Split the workload dynamically using a bucket system */ |
| 44 | }; |
| 45 | /** Scheduler hints |
| 46 | * |
| 47 | * Collection of preferences set by the function regarding how to split a given workload |
| 48 | */ |
| 49 | class Hints |
| 50 | { |
| 51 | public: |
| 52 | /** Constructor |
| 53 | * |
| 54 | * @param[in] split_dimension Dimension along which to split the kernel's execution window. |
| 55 | * @param[in] strategy (Optional) Split strategy. |
Georgios Pinitas | 77d4252 | 2019-11-05 13:35:47 +0000 | [diff] [blame] | 56 | * @param[in] threshold (Optional) Dynamic scheduling capping threshold. |
Anthony Barbier | 376c85f | 2018-05-25 14:17:21 +0100 | [diff] [blame] | 57 | */ |
Georgios Pinitas | 77d4252 | 2019-11-05 13:35:47 +0000 | [diff] [blame] | 58 | Hints(unsigned int split_dimension, StrategyHint strategy = StrategyHint::STATIC, int threshold = 0) |
| 59 | : _split_dimension(split_dimension), _strategy(strategy), _threshold(threshold) |
Anthony Barbier | 376c85f | 2018-05-25 14:17:21 +0100 | [diff] [blame] | 60 | { |
| 61 | } |
| 62 | /** Set the split_dimension hint |
| 63 | * |
| 64 | * @param[in] split_dimension Dimension along which to split the kernel's execution window. |
| 65 | * |
| 66 | * @return the Hints object |
| 67 | */ |
| 68 | Hints &set_split_dimension(unsigned int split_dimension) |
| 69 | { |
| 70 | _split_dimension = split_dimension; |
| 71 | return *this; |
| 72 | } |
| 73 | /** Return the prefered split dimension |
| 74 | * |
| 75 | * @return The split dimension |
| 76 | */ |
| 77 | unsigned int split_dimension() const |
| 78 | { |
| 79 | return _split_dimension; |
| 80 | } |
| 81 | |
| 82 | /** Set the strategy hint |
| 83 | * |
| 84 | * @param[in] strategy Prefered strategy to use to split the workload |
| 85 | * |
| 86 | * @return the Hints object |
| 87 | */ |
| 88 | Hints &set_strategy(StrategyHint strategy) |
| 89 | { |
| 90 | _strategy = strategy; |
| 91 | return *this; |
| 92 | } |
| 93 | /** Return the prefered strategy to use to split workload. |
| 94 | * |
| 95 | * @return The strategy |
| 96 | */ |
| 97 | StrategyHint strategy() const |
| 98 | { |
| 99 | return _strategy; |
| 100 | } |
Georgios Pinitas | 77d4252 | 2019-11-05 13:35:47 +0000 | [diff] [blame] | 101 | /** Return the granule capping threshold to be used by dynamic scheduling. |
| 102 | * |
| 103 | * @return The capping threshold |
| 104 | */ |
| 105 | int threshold() const |
| 106 | { |
| 107 | return _threshold; |
| 108 | } |
Anthony Barbier | 376c85f | 2018-05-25 14:17:21 +0100 | [diff] [blame] | 109 | |
| 110 | private: |
| 111 | unsigned int _split_dimension; |
| 112 | StrategyHint _strategy; |
Georgios Pinitas | 77d4252 | 2019-11-05 13:35:47 +0000 | [diff] [blame] | 113 | int _threshold; |
Anthony Barbier | 376c85f | 2018-05-25 14:17:21 +0100 | [diff] [blame] | 114 | }; |
Anthony Barbier | 52ecb06 | 2018-05-25 13:32:10 +0100 | [diff] [blame] | 115 | /** Signature for the workloads to execute */ |
| 116 | using Workload = std::function<void(const ThreadInfo &)>; |
Moritz Pflanzer | c186b57 | 2017-09-07 09:48:04 +0100 | [diff] [blame] | 117 | /** Default constructor. */ |
Moritz Pflanzer | beabe3b | 2017-08-31 14:56:32 +0100 | [diff] [blame] | 118 | IScheduler(); |
Moritz Pflanzer | c186b57 | 2017-09-07 09:48:04 +0100 | [diff] [blame] | 119 | |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 120 | /** Destructor. */ |
| 121 | virtual ~IScheduler() = default; |
Moritz Pflanzer | beabe3b | 2017-08-31 14:56:32 +0100 | [diff] [blame] | 122 | |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 123 | /** Sets the number of threads the scheduler will use to run the kernels. |
| 124 | * |
| 125 | * @param[in] num_threads If set to 0, then one thread per CPU core available on the system will be used, otherwise the number of threads specified. |
| 126 | */ |
| 127 | virtual void set_num_threads(unsigned int num_threads) = 0; |
Moritz Pflanzer | beabe3b | 2017-08-31 14:56:32 +0100 | [diff] [blame] | 128 | |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 129 | /** Returns the number of threads that the SingleThreadScheduler has in his pool. |
| 130 | * |
| 131 | * @return Number of threads available in SingleThreadScheduler. |
| 132 | */ |
| 133 | virtual unsigned int num_threads() const = 0; |
Moritz Pflanzer | beabe3b | 2017-08-31 14:56:32 +0100 | [diff] [blame] | 134 | |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 135 | /** Runs the kernel in the same thread as the caller synchronously. |
| 136 | * |
Anthony Barbier | 376c85f | 2018-05-25 14:17:21 +0100 | [diff] [blame] | 137 | * @param[in] kernel Kernel to execute. |
| 138 | * @param[in] hints Hints for the scheduler. |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 139 | */ |
Anthony Barbier | 376c85f | 2018-05-25 14:17:21 +0100 | [diff] [blame] | 140 | virtual void schedule(ICPPKernel *kernel, const Hints &hints) = 0; |
Moritz Pflanzer | c186b57 | 2017-09-07 09:48:04 +0100 | [diff] [blame] | 141 | |
Anthony Barbier | 52ecb06 | 2018-05-25 13:32:10 +0100 | [diff] [blame] | 142 | /** Execute all the passed workloads |
| 143 | * |
| 144 | * @note there is no guarantee regarding the order in which the workloads will be executed or whether or not they will be executed in parallel. |
| 145 | * |
| 146 | * @param[in] workloads Array of workloads to run |
Anthony Barbier | 148b075 | 2018-09-11 14:19:39 +0100 | [diff] [blame] | 147 | * @param[in] tag String that can be used by profiling tools to identify the workloads run by the scheduler (Can be null). |
Anthony Barbier | 52ecb06 | 2018-05-25 13:32:10 +0100 | [diff] [blame] | 148 | */ |
Anthony Barbier | 148b075 | 2018-09-11 14:19:39 +0100 | [diff] [blame] | 149 | virtual void run_tagged_workloads(std::vector<Workload> &workloads, const char *tag); |
Anthony Barbier | 52ecb06 | 2018-05-25 13:32:10 +0100 | [diff] [blame] | 150 | |
Moritz Pflanzer | beabe3b | 2017-08-31 14:56:32 +0100 | [diff] [blame] | 151 | /** Get CPU info. |
Moritz Pflanzer | c186b57 | 2017-09-07 09:48:04 +0100 | [diff] [blame] | 152 | * |
Moritz Pflanzer | beabe3b | 2017-08-31 14:56:32 +0100 | [diff] [blame] | 153 | * @return CPU info. |
Moritz Pflanzer | c186b57 | 2017-09-07 09:48:04 +0100 | [diff] [blame] | 154 | */ |
Pablo Tello | 7fad9b1 | 2018-03-14 17:55:27 +0000 | [diff] [blame] | 155 | CPUInfo &cpu_info(); |
Georgios Pinitas | 53d1227 | 2018-02-01 20:23:25 +0000 | [diff] [blame] | 156 | /** Get a hint for the best possible number of execution threads |
| 157 | * |
| 158 | * @warning In case we can't work out the best number of threads, |
| 159 | * std::thread::hardware_concurrency() is returned else 1 in case of bare metal builds |
| 160 | * |
| 161 | * @return Best possible number of execution threads to use |
| 162 | */ |
| 163 | unsigned int num_threads_hint() const; |
Moritz Pflanzer | c186b57 | 2017-09-07 09:48:04 +0100 | [diff] [blame] | 164 | |
| 165 | protected: |
Anthony Barbier | 148b075 | 2018-09-11 14:19:39 +0100 | [diff] [blame] | 166 | /** Execute all the passed workloads |
| 167 | * |
| 168 | * @note there is no guarantee regarding the order in which the workloads will be executed or whether or not they will be executed in parallel. |
| 169 | * |
| 170 | * @param[in] workloads Array of workloads to run |
| 171 | */ |
| 172 | virtual void run_workloads(std::vector<Workload> &workloads) = 0; |
Pablo Tello | 7fad9b1 | 2018-03-14 17:55:27 +0000 | [diff] [blame] | 173 | CPUInfo _cpu_info; |
Georgios Pinitas | 53d1227 | 2018-02-01 20:23:25 +0000 | [diff] [blame] | 174 | |
| 175 | private: |
| 176 | unsigned int _num_threads_hint = {}; |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 177 | }; |
Georgios Pinitas | 77d4252 | 2019-11-05 13:35:47 +0000 | [diff] [blame] | 178 | } // namespace arm_compute |
Michalis Spyrou | f464337 | 2019-11-29 16:17:13 +0000 | [diff] [blame] | 179 | #endif /* ARM_COMPUTE_ISCHEDULER_H */ |