1 /* 2 * Copyright (c) 2016-2021 Arm Limited. 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/core/experimental/Types.h" 28 #include "arm_compute/runtime/IScheduler.h" 29 30 #include <memory> 31 32 namespace arm_compute 33 { 34 /** C++11 implementation of a pool of threads to automatically split a kernel's execution among several threads. 35 * 36 * It has 2 scheduling modes: Linear or Fanout (please refer to the implementation for details) 37 * The mode is selected automatically based on the runtime environment. However it can be forced via an environment 38 * variable ARM_COMPUTE_CPP_SCHEDULER_MODE. e.g.: 39 * ARM_COMPUTE_CPP_SCHEDULER_MODE=linear # Force select the linear scheduling mode 40 * ARM_COMPUTE_CPP_SCHEDULER_MODE=fanout # Force select the fanout scheduling mode 41 */ 42 class CPPScheduler final : public IScheduler 43 { 44 public: 45 /** Constructor: create a pool of threads. */ 46 CPPScheduler(); 47 /** Default destructor */ 48 ~CPPScheduler(); 49 50 /** Access the scheduler singleton 51 * 52 * @note this method has been deprecated and will be remover in future releases 53 * @return The scheduler 54 */ 55 static CPPScheduler &get(); 56 57 // Inherited functions overridden 58 void set_num_threads(unsigned int num_threads) override; 59 void set_num_threads_with_affinity(unsigned int num_threads, BindFunc func) override; 60 unsigned int num_threads() const override; 61 void schedule(ICPPKernel *kernel, const Hints &hints) override; 62 void schedule_op(ICPPKernel *kernel, const Hints &hints, const Window &window, ITensorPack &tensors) override; 63 64 protected: 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 71 private: 72 struct Impl; 73 std::unique_ptr<Impl> _impl; 74 }; 75 } // namespace arm_compute 76 #endif /* ARM_COMPUTE_CPPSCHEDULER_H */ 77