• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (c) 2018-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_GRAPH_CLDEVICEBACKEND_H
25 #define ARM_COMPUTE_GRAPH_CLDEVICEBACKEND_H
26 
27 #include "arm_compute/graph/IDeviceBackend.h"
28 
29 #include "arm_compute/runtime/CL/CLBufferAllocator.h"
30 #include "arm_compute/runtime/CL/CLGEMMHeuristicsHandle.h"
31 #include "arm_compute/runtime/CL/CLTuner.h"
32 #include "arm_compute/runtime/CL/CLTypes.h"
33 
34 namespace arm_compute
35 {
36 namespace graph
37 {
38 namespace backends
39 {
40 /** OpenCL device backend */
41 class CLDeviceBackend final : public IDeviceBackend
42 {
43 public:
44     /** Default Constructor */
45     CLDeviceBackend();
46     /** Destructor */
47     ~CLDeviceBackend();
48     /** Switchs on or off the kernel tuning
49      *
50      * @note When true the tuner set is used, if no tuner is set a new default one is created
51      *
52      * @param[in] enable_tuning Enables tuning if false else true
53      */
54     void set_kernel_tuning(bool enable_tuning);
55     /** Set kernel tuning mode
56      *
57      * @param[in] tuning_mode Indicates how exhaustive the search for the optimal LWS should be while tuning
58      */
59     void set_kernel_tuning_mode(CLTunerMode tuning_mode);
60 
61     // Inherited overridden methods
62     void initialize_backend() override;
63     void setup_backend_context(GraphContext &ctx) override;
64     void release_backend_context(GraphContext &ctx) override;
65     bool                           is_backend_supported() override;
66     IAllocator                    *backend_allocator() override;
67     std::unique_ptr<ITensorHandle> create_tensor(const Tensor &tensor) override;
68     std::unique_ptr<ITensorHandle> create_subtensor(ITensorHandle *parent, TensorShape shape, Coordinates coords, bool extend_parent) override;
69     std::unique_ptr<arm_compute::IFunction> configure_node(INode &node, GraphContext &ctx) override;
70     Status validate_node(INode &node) override;
71     std::shared_ptr<arm_compute::IMemoryManager> create_memory_manager(MemoryManagerAffinity affinity) override;
72     std::shared_ptr<arm_compute::IWeightsManager> create_weights_manager() override;
73     void                                          sync() override;
74 
75 private:
76     int                                _context_count;   /**< Counts how many contexts are currently using the backend */
77     CLTuner                            _tuner;           /**< CL kernel tuner */
78     CLGEMMHeuristicsHandle             _gemm_heuristics; /**< GEMM heuristics */
79     std::unique_ptr<CLBufferAllocator> _allocator;       /**< CL buffer affinity allocator */
80     std::string                        _tuner_file;      /**< Filename to load/store the tuner's values from */
81     CLBackendType                      _backend_type;    /**< OpenCL backend type to use */
82 };
83 } // namespace backends
84 } // namespace graph
85 } // namespace arm_compute
86 #endif //ARM_COMPUTE_GRAPH_CLDEVICEBACKEND_H
87