Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 1 | /* |
Georgios Pinitas | 53d1227 | 2018-02-01 20:23:25 +0000 | [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 | #include "arm_compute/runtime/CPP/CPPScheduler.h" |
| 25 | |
| 26 | #include "arm_compute/core/CPP/ICPPKernel.h" |
| 27 | #include "arm_compute/core/Error.h" |
| 28 | #include "arm_compute/core/Helpers.h" |
| 29 | #include "arm_compute/core/Utils.h" |
| 30 | |
Moritz Pflanzer | ff06f20 | 2017-09-08 13:48:23 +0100 | [diff] [blame] | 31 | #include <condition_variable> |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 32 | #include <iostream> |
Moritz Pflanzer | ff06f20 | 2017-09-08 13:48:23 +0100 | [diff] [blame] | 33 | #include <mutex> |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 34 | #include <system_error> |
| 35 | #include <thread> |
| 36 | |
Moritz Pflanzer | ff06f20 | 2017-09-08 13:48:23 +0100 | [diff] [blame] | 37 | namespace arm_compute |
| 38 | { |
| 39 | class Thread |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 40 | { |
| 41 | public: |
Moritz Pflanzer | ff06f20 | 2017-09-08 13:48:23 +0100 | [diff] [blame] | 42 | /** Start a new thread. */ |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 43 | Thread(); |
Moritz Pflanzer | ff06f20 | 2017-09-08 13:48:23 +0100 | [diff] [blame] | 44 | |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 45 | Thread(const Thread &) = delete; |
| 46 | Thread &operator=(const Thread &) = delete; |
| 47 | Thread(Thread &&) = delete; |
| 48 | Thread &operator=(Thread &&) = delete; |
Moritz Pflanzer | ff06f20 | 2017-09-08 13:48:23 +0100 | [diff] [blame] | 49 | |
| 50 | /** Destructor. Make the thread join. */ |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 51 | ~Thread(); |
Moritz Pflanzer | ff06f20 | 2017-09-08 13:48:23 +0100 | [diff] [blame] | 52 | |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 53 | /** Request the worker thread to start executing the given kernel |
| 54 | * This function will return as soon as the kernel has been sent to the worker thread. |
| 55 | * wait() needs to be called to ensure the execution is complete. |
| 56 | */ |
Moritz Pflanzer | c186b57 | 2017-09-07 09:48:04 +0100 | [diff] [blame] | 57 | void start(ICPPKernel *kernel, const Window &window, const ThreadInfo &info); |
Moritz Pflanzer | ff06f20 | 2017-09-08 13:48:23 +0100 | [diff] [blame] | 58 | |
| 59 | /** Wait for the current kernel execution to complete. */ |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 60 | void wait(); |
Moritz Pflanzer | ff06f20 | 2017-09-08 13:48:23 +0100 | [diff] [blame] | 61 | |
| 62 | /** Function ran by the worker thread. */ |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 63 | void worker_thread(); |
| 64 | |
| 65 | private: |
Moritz Pflanzer | ff06f20 | 2017-09-08 13:48:23 +0100 | [diff] [blame] | 66 | std::thread _thread; |
| 67 | ICPPKernel *_kernel{ nullptr }; |
| 68 | Window _window; |
| 69 | ThreadInfo _info; |
| 70 | std::mutex _m; |
| 71 | std::condition_variable _cv; |
| 72 | bool _wait_for_work{ false }; |
| 73 | bool _job_complete{ true }; |
| 74 | std::exception_ptr _current_exception; |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 75 | }; |
| 76 | |
| 77 | Thread::Thread() |
Moritz Pflanzer | ff06f20 | 2017-09-08 13:48:23 +0100 | [diff] [blame] | 78 | : _thread(), _window(), _info(), _m(), _cv(), _current_exception(nullptr) |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 79 | { |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 80 | _thread = std::thread(&Thread::worker_thread, this); |
| 81 | } |
| 82 | |
| 83 | Thread::~Thread() |
| 84 | { |
Moritz Pflanzer | ff06f20 | 2017-09-08 13:48:23 +0100 | [diff] [blame] | 85 | // Make sure worker thread has ended |
| 86 | if(_thread.joinable()) |
| 87 | { |
| 88 | start(nullptr, Window(), ThreadInfo()); |
| 89 | _thread.join(); |
| 90 | } |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 91 | } |
| 92 | |
Moritz Pflanzer | c186b57 | 2017-09-07 09:48:04 +0100 | [diff] [blame] | 93 | void Thread::start(ICPPKernel *kernel, const Window &window, const ThreadInfo &info) |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 94 | { |
| 95 | _kernel = kernel; |
| 96 | _window = window; |
Moritz Pflanzer | c186b57 | 2017-09-07 09:48:04 +0100 | [diff] [blame] | 97 | _info = info; |
Moritz Pflanzer | ff06f20 | 2017-09-08 13:48:23 +0100 | [diff] [blame] | 98 | |
| 99 | { |
| 100 | std::lock_guard<std::mutex> lock(_m); |
| 101 | _wait_for_work = true; |
| 102 | _job_complete = false; |
| 103 | } |
| 104 | _cv.notify_one(); |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 105 | } |
| 106 | |
| 107 | void Thread::wait() |
| 108 | { |
Moritz Pflanzer | ff06f20 | 2017-09-08 13:48:23 +0100 | [diff] [blame] | 109 | { |
| 110 | std::unique_lock<std::mutex> lock(_m); |
| 111 | _cv.wait(lock, [&] { return _job_complete; }); |
| 112 | } |
| 113 | |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 114 | if(_current_exception) |
| 115 | { |
| 116 | std::rethrow_exception(_current_exception); |
| 117 | } |
| 118 | } |
| 119 | |
| 120 | void Thread::worker_thread() |
| 121 | { |
Moritz Pflanzer | ff06f20 | 2017-09-08 13:48:23 +0100 | [diff] [blame] | 122 | while(true) |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 123 | { |
Moritz Pflanzer | ff06f20 | 2017-09-08 13:48:23 +0100 | [diff] [blame] | 124 | std::unique_lock<std::mutex> lock(_m); |
| 125 | _cv.wait(lock, [&] { return _wait_for_work; }); |
| 126 | _wait_for_work = false; |
| 127 | |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 128 | _current_exception = nullptr; |
Moritz Pflanzer | ff06f20 | 2017-09-08 13:48:23 +0100 | [diff] [blame] | 129 | |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 130 | // Time to exit |
| 131 | if(_kernel == nullptr) |
| 132 | { |
| 133 | return; |
| 134 | } |
| 135 | |
| 136 | try |
| 137 | { |
| 138 | _window.validate(); |
Moritz Pflanzer | c186b57 | 2017-09-07 09:48:04 +0100 | [diff] [blame] | 139 | _kernel->run(_window, _info); |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 140 | } |
| 141 | catch(...) |
| 142 | { |
| 143 | _current_exception = std::current_exception(); |
| 144 | } |
Moritz Pflanzer | ff06f20 | 2017-09-08 13:48:23 +0100 | [diff] [blame] | 145 | |
| 146 | _job_complete = true; |
| 147 | lock.unlock(); |
| 148 | _cv.notify_one(); |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 149 | } |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 150 | } |
| 151 | |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 152 | CPPScheduler &CPPScheduler::get() |
| 153 | { |
| 154 | static CPPScheduler scheduler; |
| 155 | return scheduler; |
| 156 | } |
| 157 | |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 158 | CPPScheduler::CPPScheduler() |
Georgios Pinitas | 53d1227 | 2018-02-01 20:23:25 +0000 | [diff] [blame] | 159 | : _num_threads(num_threads_hint()), |
Moritz Pflanzer | ff06f20 | 2017-09-08 13:48:23 +0100 | [diff] [blame] | 160 | _threads(_num_threads - 1) |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 161 | { |
| 162 | } |
| 163 | |
| 164 | void CPPScheduler::set_num_threads(unsigned int num_threads) |
| 165 | { |
Anthony Barbier | ce87612 | 2018-02-22 12:44:15 +0000 | [diff] [blame] | 166 | _num_threads = num_threads == 0 ? num_threads_hint() : num_threads; |
Moritz Pflanzer | ff06f20 | 2017-09-08 13:48:23 +0100 | [diff] [blame] | 167 | _threads.resize(_num_threads - 1); |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 168 | } |
| 169 | |
Moritz Pflanzer | d929b9c | 2017-06-28 10:15:48 +0100 | [diff] [blame] | 170 | unsigned int CPPScheduler::num_threads() const |
| 171 | { |
| 172 | return _num_threads; |
| 173 | } |
| 174 | |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 175 | void CPPScheduler::schedule(ICPPKernel *kernel, unsigned int split_dimension) |
| 176 | { |
| 177 | ARM_COMPUTE_ERROR_ON_MSG(!kernel, "The child class didn't set the kernel"); |
| 178 | |
| 179 | /** [Scheduler example] */ |
Moritz Pflanzer | c186b57 | 2017-09-07 09:48:04 +0100 | [diff] [blame] | 180 | ThreadInfo info; |
Moritz Pflanzer | beabe3b | 2017-08-31 14:56:32 +0100 | [diff] [blame] | 181 | info.cpu_info = _info; |
Moritz Pflanzer | c186b57 | 2017-09-07 09:48:04 +0100 | [diff] [blame] | 182 | |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 183 | const Window &max_window = kernel->window(); |
| 184 | const unsigned int num_iterations = max_window.num_iterations(split_dimension); |
Moritz Pflanzer | c186b57 | 2017-09-07 09:48:04 +0100 | [diff] [blame] | 185 | info.num_threads = std::min(num_iterations, _num_threads); |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 186 | |
Moritz Pflanzer | 2fd5d95 | 2017-09-24 12:10:46 +0100 | [diff] [blame] | 187 | if(num_iterations == 0) |
| 188 | { |
| 189 | return; |
| 190 | } |
| 191 | |
Moritz Pflanzer | c186b57 | 2017-09-07 09:48:04 +0100 | [diff] [blame] | 192 | if(!kernel->is_parallelisable() || info.num_threads == 1) |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 193 | { |
Moritz Pflanzer | c186b57 | 2017-09-07 09:48:04 +0100 | [diff] [blame] | 194 | kernel->run(max_window, info); |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 195 | } |
| 196 | else |
| 197 | { |
Moritz Pflanzer | ff06f20 | 2017-09-08 13:48:23 +0100 | [diff] [blame] | 198 | int t = 0; |
| 199 | auto thread_it = _threads.begin(); |
| 200 | |
| 201 | for(; t < info.num_threads - 1; ++t, ++thread_it) |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 202 | { |
Moritz Pflanzer | c186b57 | 2017-09-07 09:48:04 +0100 | [diff] [blame] | 203 | Window win = max_window.split_window(split_dimension, t, info.num_threads); |
| 204 | info.thread_id = t; |
Moritz Pflanzer | ff06f20 | 2017-09-08 13:48:23 +0100 | [diff] [blame] | 205 | thread_it->start(kernel, win, info); |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 206 | } |
| 207 | |
Moritz Pflanzer | ff06f20 | 2017-09-08 13:48:23 +0100 | [diff] [blame] | 208 | // Run last part on main thread |
| 209 | Window win = max_window.split_window(split_dimension, t, info.num_threads); |
| 210 | info.thread_id = t; |
| 211 | kernel->run(win, info); |
| 212 | |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 213 | try |
| 214 | { |
Moritz Pflanzer | ff06f20 | 2017-09-08 13:48:23 +0100 | [diff] [blame] | 215 | for(auto &thread : _threads) |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 216 | { |
Moritz Pflanzer | ff06f20 | 2017-09-08 13:48:23 +0100 | [diff] [blame] | 217 | thread.wait(); |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 218 | } |
| 219 | } |
| 220 | catch(const std::system_error &e) |
| 221 | { |
Moritz Pflanzer | ff06f20 | 2017-09-08 13:48:23 +0100 | [diff] [blame] | 222 | std::cerr << "Caught system_error with code " << e.code() << " meaning " << e.what() << '\n'; |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 223 | } |
| 224 | } |
| 225 | /** [Scheduler example] */ |
| 226 | } |
Moritz Pflanzer | ff06f20 | 2017-09-08 13:48:23 +0100 | [diff] [blame] | 227 | } // namespace arm_compute |