Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 1 | /* |
Sang-Hoon Park | 0094c02 | 2021-01-20 18:16:47 +0000 | [diff] [blame] | 2 | * Copyright (c) 2017-2021 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_OMPSCHEDULER_H |
| 25 | #define ARM_COMPUTE_OMPSCHEDULER_H |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 26 | |
| 27 | #include "arm_compute/runtime/IScheduler.h" |
| 28 | |
| 29 | namespace arm_compute |
| 30 | { |
| 31 | /** Pool of threads to automatically split a kernel's execution among several threads. */ |
Georgios Pinitas | 12833d0 | 2019-07-25 13:31:10 +0100 | [diff] [blame] | 32 | class OMPScheduler final : public IScheduler |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 33 | { |
| 34 | public: |
Georgios Pinitas | 12833d0 | 2019-07-25 13:31:10 +0100 | [diff] [blame] | 35 | /** Constructor. */ |
| 36 | OMPScheduler(); |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 37 | /** Sets the number of threads the scheduler will use to run the kernels. |
| 38 | * |
| 39 | * @param[in] num_threads If set to 0, then the number returned by omp_get_max_threads() will be used, otherwise the number of threads specified. |
| 40 | */ |
| 41 | void set_num_threads(unsigned int num_threads) override; |
| 42 | /** Returns the number of threads that the OMPScheduler has in its pool. |
| 43 | * |
| 44 | * @return Number of threads available in OMPScheduler. |
| 45 | */ |
| 46 | unsigned int num_threads() const override; |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 47 | /** Multithread the execution of the passed kernel if possible. |
| 48 | * |
| 49 | * The kernel will run on a single thread if any of these conditions is true: |
| 50 | * - ICPPKernel::is_parallelisable() returns false |
| 51 | * - The scheduler has been initialized with only one thread. |
| 52 | * |
Anthony Barbier | 376c85f | 2018-05-25 14:17:21 +0100 | [diff] [blame] | 53 | * @param[in] kernel Kernel to execute. |
| 54 | * @param[in] hints Hints for the scheduler. |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 55 | */ |
Anthony Barbier | 376c85f | 2018-05-25 14:17:21 +0100 | [diff] [blame] | 56 | void schedule(ICPPKernel *kernel, const Hints &hints) override; |
Anthony Barbier | 148b075 | 2018-09-11 14:19:39 +0100 | [diff] [blame] | 57 | |
Michalis Spyrou | bcd2352 | 2020-05-21 15:02:36 +0100 | [diff] [blame] | 58 | /** Multithread the execution of the passed kernel if possible. |
| 59 | * |
| 60 | * The kernel will run on a single thread if any of these conditions is true: |
| 61 | * - ICPPKernel::is_parallelisable() returns false |
| 62 | * - The scheduler has been initialized with only one thread. |
| 63 | * |
| 64 | * @param[in] kernel Kernel to execute. |
| 65 | * @param[in] hints Hints for the scheduler. |
Sang-Hoon Park | 0094c02 | 2021-01-20 18:16:47 +0000 | [diff] [blame] | 66 | * @param[in] window Window to use for kernel execution. |
Georgios Pinitas | 0499dff | 2020-07-31 22:21:38 +0100 | [diff] [blame] | 67 | * @param[in] tensors Vector containing the tensors to operate on. |
Michalis Spyrou | bcd2352 | 2020-05-21 15:02:36 +0100 | [diff] [blame] | 68 | */ |
Sang-Hoon Park | 0094c02 | 2021-01-20 18:16:47 +0000 | [diff] [blame] | 69 | void schedule_op(ICPPKernel *kernel, const Hints &hints, const Window &window, ITensorPack &tensors) override; |
Michalis Spyrou | bcd2352 | 2020-05-21 15:02:36 +0100 | [diff] [blame] | 70 | |
Anthony Barbier | 148b075 | 2018-09-11 14:19:39 +0100 | [diff] [blame] | 71 | protected: |
Georgios Pinitas | 584252d | 2018-06-29 18:25:22 +0100 | [diff] [blame] | 72 | /** Execute all the passed workloads |
| 73 | * |
| 74 | * @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. |
| 75 | * |
| 76 | * @param[in] workloads Array of workloads to run |
| 77 | */ |
| 78 | void run_workloads(std::vector<Workload> &workloads) override; |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 79 | |
| 80 | private: |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 81 | unsigned int _num_threads; |
| 82 | }; |
Georgios Pinitas | 12833d0 | 2019-07-25 13:31:10 +0100 | [diff] [blame] | 83 | } // namespace arm_compute |
Michalis Spyrou | f464337 | 2019-11-29 16:17:13 +0000 | [diff] [blame] | 84 | #endif /* ARM_COMPUTE_OMPSCHEDULER_H */ |