Compute Library
 21.05
BackendRegistry.h
Go to the documentation of this file.
1 /*
2  * Copyright (c) 2018-2020 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_GRAPH_BACKEND_REGISTRY_H
25 #define ARM_COMPUTE_GRAPH_BACKEND_REGISTRY_H
26 
29 
30 #include <map>
31 #include <memory>
32 
33 namespace arm_compute
34 {
35 namespace graph
36 {
37 namespace backends
38 {
39 /** Registry holding all the supported backends */
40 class BackendRegistry final
41 {
42 public:
43  /** Gets backend registry instance
44  *
45  * @return Backend registry instance
46  */
47  static BackendRegistry &get();
48  /** Finds a backend in the registry
49  *
50  * @param[in] target Backend target
51  *
52  * @return Pointer to the backend interface if found, else nullptr
53  */
55 
56  /** Get a backend from the registry
57  *
58  * The backend must be present and supported.
59  *
60  * @param[in] target Backend target
61  *
62  * @return Reference to the backend interface
63  */
65  /** Checks if a backend for a given target exists
66  *
67  * @param[in] target Execution target
68  *
69  * @return True if exists else false
70  */
71  bool contains(Target target) const;
72  /** Backends accessor
73  *
74  * @return Map containing the registered backends
75  */
76  const std::map<Target, std::unique_ptr<IDeviceBackend>> &backends() const;
77  /** Registers a backend to the registry
78  *
79  * @param[in] target Execution target to register for
80  */
81  template <typename T>
82  void add_backend(Target target);
83 
84 private:
85  /** Default Constructor */
87 
88 private:
89  std::map<Target, std::unique_ptr<IDeviceBackend>> _registered_backends;
90 };
91 
92 template <typename T>
94 {
95  _registered_backends[target] = std::make_unique<T>();
96 }
97 } // namespace backends
98 } // namespace graph
99 } // namespace arm_compute
100 #endif /* ARM_COMPUTE_GRAPH_BACKEND_REGISTRY_H */
IDeviceBackend & get_backend(Target target)
Get a backend from the registry.
Copyright (c) 2017-2021 Arm Limited.
void add_backend(Target target)
Registers a backend to the registry.
bool contains(Target target) const
Checks if a backend for a given target exists.
static BackendRegistry & get()
Gets backend registry instance.
IDeviceBackend * find_backend(Target target)
Finds a backend in the registry.
const std::map< Target, std::unique_ptr< IDeviceBackend > > & backends() const
Backends accessor.
Registry holding all the supported backends.