arm_compute v18.05
[platform/upstream/armcl.git] / arm_compute / graph / backends / CL / CLDeviceBackend.h
1 /*
2  * Copyright (c) 2018 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/CLTuner.h"
31
32 namespace arm_compute
33 {
34 namespace graph
35 {
36 namespace backends
37 {
38 /** OpenCL device backend */
39 class CLDeviceBackend final : public IDeviceBackend
40 {
41 public:
42     /** Default Constructor */
43     CLDeviceBackend();
44     /** Destructor */
45     ~CLDeviceBackend();
46     /** Switchs on or off the kernel tuning
47      *
48      * @note When true the tuner set is used, if no tuner is set a new default one is created
49      *
50      * @param[in] enable_tuning Enables tuning if false else true
51      */
52     void set_kernel_tuning(bool enable_tuning);
53
54     // Inherited overridden methods
55     void initialize_backend() override;
56     void setup_backend_context(GraphContext &ctx) override;
57     bool                           is_backend_supported() override;
58     IAllocator                    *backend_allocator() override;
59     std::unique_ptr<ITensorHandle> create_tensor(const Tensor &tensor) override;
60     std::unique_ptr<ITensorHandle> create_subtensor(ITensorHandle *parent, TensorShape shape, Coordinates coords, bool extend_parent) override;
61     std::unique_ptr<arm_compute::IFunction> configure_node(INode &node, GraphContext &ctx) override;
62     Status validate_node(INode &node) override;
63     std::shared_ptr<arm_compute::IMemoryManager> create_memory_manager(MemoryManagerAffinity affinity) override;
64
65 private:
66     CLTuner           _tuner;     /**< CL kernel tuner */
67     CLBufferAllocator _allocator; /**< CL buffer affinity allocator */
68 };
69 } // namespace backends
70 } // namespace graph
71 } // namespace arm_compute
72 #endif //__ARM_COMPUTE_GRAPH_CLDEVICEBACKEND_H__