Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 1 | /* |
Anthony Barbier | 52ecb06 | 2018-05-25 13:32:10 +0100 | [diff] [blame] | 2 | * Copyright (c) 2016-2018 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 | */ |
| 24 | #ifndef __ARM_COMPUTE_CPPSCHEDULER_H__ |
| 25 | #define __ARM_COMPUTE_CPPSCHEDULER_H__ |
| 26 | |
| 27 | #include "arm_compute/runtime/IScheduler.h" |
| 28 | |
Moritz Pflanzer | ff06f20 | 2017-09-08 13:48:23 +0100 | [diff] [blame] | 29 | #include <list> |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 30 | |
| 31 | namespace arm_compute |
| 32 | { |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 33 | /** C++11 implementation of a pool of threads to automatically split a kernel's execution among several threads. */ |
| 34 | class CPPScheduler : public IScheduler |
| 35 | { |
| 36 | public: |
| 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 maximum number of threads supported by C++11 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 CPPScheduler has in his pool. |
| 43 | * |
| 44 | * @return Number of threads available in CPPScheduler. |
| 45 | */ |
| 46 | unsigned int num_threads() const override; |
Moritz Pflanzer | d929b9c | 2017-06-28 10:15:48 +0100 | [diff] [blame] | 47 | |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 48 | /** Access the scheduler singleton |
| 49 | * |
| 50 | * @return The scheduler |
| 51 | */ |
| 52 | static CPPScheduler &get(); |
| 53 | /** Multithread the execution of the passed kernel if possible. |
| 54 | * |
| 55 | * The kernel will run on a single thread if any of these conditions is true: |
| 56 | * - ICPPKernel::is_parallelisable() returns false |
| 57 | * - The scheduler has been initialized with only one thread. |
| 58 | * |
Anthony Barbier | 376c85f | 2018-05-25 14:17:21 +0100 | [diff] [blame] | 59 | * @param[in] kernel Kernel to execute. |
| 60 | * @param[in] hints Hints for the scheduler. |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 61 | */ |
Anthony Barbier | 376c85f | 2018-05-25 14:17:21 +0100 | [diff] [blame] | 62 | void schedule(ICPPKernel *kernel, const Hints &hints) override; |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 63 | |
Anthony Barbier | 148b075 | 2018-09-11 14:19:39 +0100 | [diff] [blame] | 64 | protected: |
Anthony Barbier | 52ecb06 | 2018-05-25 13:32:10 +0100 | [diff] [blame] | 65 | /** Will run the workloads in parallel using num_threads |
| 66 | * |
| 67 | * @param[in] workloads Workloads to run |
| 68 | */ |
| 69 | void run_workloads(std::vector<Workload> &workloads) override; |
| 70 | |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 71 | private: |
Anthony Barbier | 52ecb06 | 2018-05-25 13:32:10 +0100 | [diff] [blame] | 72 | class Thread; |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 73 | /** Constructor: create a pool of threads. */ |
| 74 | CPPScheduler(); |
| 75 | |
Moritz Pflanzer | ff06f20 | 2017-09-08 13:48:23 +0100 | [diff] [blame] | 76 | unsigned int _num_threads; |
| 77 | std::list<Thread> _threads; |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 78 | }; |
| 79 | } |
| 80 | #endif /* __ARM_COMPUTE_CPPSCHEDULER_H__ */ |