Compute Library
 21.02
CPPScheduler.h
Go to the documentation of this file.
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 
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 class CPPScheduler final : public IScheduler
36 {
37 public:
38  /** Constructor: create a pool of threads. */
39  CPPScheduler();
40  /** Default destructor */
41  ~CPPScheduler();
42 
43  /** Access the scheduler singleton
44  *
45  * @note this method has been deprecated and will be remover in future releases
46  * @return The scheduler
47  */
48  static CPPScheduler &get();
49 
50  // Inherited functions overridden
51  void set_num_threads(unsigned int num_threads) override;
52  void set_num_threads_with_affinity(unsigned int num_threads, BindFunc func) override;
53  unsigned int num_threads() const override;
54  void schedule(ICPPKernel *kernel, const Hints &hints) override;
55  void schedule_op(ICPPKernel *kernel, const Hints &hints, const Window &window, ITensorPack &tensors) override;
56 
57 protected:
58  /** Will run the workloads in parallel using num_threads
59  *
60  * @param[in] workloads Workloads to run
61  */
62  void run_workloads(std::vector<Workload> &workloads) override;
63 
64 private:
65  struct Impl;
66  std::unique_ptr<Impl> _impl;
67 };
68 } // namespace arm_compute
69 #endif /* ARM_COMPUTE_CPPSCHEDULER_H */
unsigned int num_threads() const override
Returns the number of threads that the SingleThreadScheduler has in his pool.
Common interface for all kernels implemented in C++.
Definition: ICPPKernel.h:38
Scheduler interface to run kernels.
Definition: IScheduler.h:41
Copyright (c) 2017-2021 Arm Limited.
void set_num_threads_with_affinity(unsigned int num_threads, BindFunc func) override
Sets the number of threads the scheduler will use to run the kernels but also using a binding functio...
std::function< int(int, int)> BindFunc
Function to be used and map a given thread id to a logical core id.
Definition: IScheduler.h:56
C++11 implementation of a pool of threads to automatically split a kernel&#39;s execution among several t...
Definition: CPPScheduler.h:35
~CPPScheduler()
Default destructor.
void set_num_threads(unsigned int num_threads) override
Sets the number of threads the scheduler will use to run the kernels.
FloorUKernelPtr func
void schedule_op(ICPPKernel *kernel, const Hints &hints, const Window &window, ITensorPack &tensors) override
Runs the kernel in the same thread as the caller synchronously.
Tensor packing service.
Definition: ITensorPack.h:37
Describe a multidimensional execution window.
Definition: Window.h:39
void schedule(ICPPKernel *kernel, const Hints &hints) override
Runs the kernel in the same thread as the caller synchronously.
CPPScheduler()
Constructor: create a pool of threads.