Compute Library
 21.02
Scheduler.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2017-2019 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_SCHEDULER_H
25 #define ARM_COMPUTE_SCHEDULER_H
26 
28 
29 #include <map>
30 #include <memory>
31 
32 namespace arm_compute
33 {
34 /** Configurable scheduler which supports multiple multithreading APIs and choosing between different schedulers at runtime. */
35 class Scheduler
36 {
37 public:
38  /** Scheduler type */
39  enum class Type
40  {
41  ST, /**< Single thread. */
42  CPP, /**< C++11 threads. */
43  OMP, /**< OpenMP. */
44  CUSTOM /**< Provided by the user. */
45  };
46  /** Sets the user defined scheduler and makes it the active scheduler.
47  *
48  * @param[in] scheduler A shared pointer to a custom scheduler implemented by the user.
49  */
50  static void set(std::shared_ptr<IScheduler> scheduler);
51  /** Access the scheduler singleton.
52  *
53  * @return A reference to the scheduler object.
54  */
55  static IScheduler &get();
56  /** Set the active scheduler.
57  *
58  * Only one scheduler can be enabled at any time.
59  *
60  * @param[in] t the type of the scheduler to be enabled.
61  */
62  static void set(Type t);
63  /** Returns the type of the active scheduler.
64  *
65  * @return The current scheduler's type.
66  */
67  static Type get_type();
68  /** Returns true if the given scheduler type is supported. False otherwise.
69  *
70  * @param[in] t the type of the scheduler to check.
71  *
72  * @return true if the given scheduler type is supported. False otherwise.
73  */
74  static bool is_available(Type t);
75 
76 private:
77  static Type _scheduler_type;
78  static std::shared_ptr<IScheduler> _custom_scheduler;
79  static std::map<Type, std::unique_ptr<IScheduler>> _schedulers;
80 
81  Scheduler();
82 };
83 } // namespace arm_compute
84 #endif /* ARM_COMPUTE_SCHEDULER_H */
Type
Scheduler type.
Definition: Scheduler.h:39
Scheduler interface to run kernels.
Definition: IScheduler.h:41
Copyright (c) 2017-2021 Arm Limited.
static bool is_available(Type t)
Returns true if the given scheduler type is supported.
Definition: Scheduler.cpp:77
Configurable scheduler which supports multiple multithreading APIs and choosing between different sch...
Definition: Scheduler.h:35
static Type get_type()
Returns the type of the active scheduler.
Definition: Scheduler.cpp:89