1 /*
2  * Copyright (c) 2022-2023 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 SRC_DYNAMIC_FUSION_SKETCH_GPU_TEMPLATE_WRITER_CL_CLTEMPLATEELEMENTWISEBINARY
25 #define SRC_DYNAMIC_FUSION_SKETCH_GPU_TEMPLATE_WRITER_CL_CLTEMPLATEELEMENTWISEBINARY
26 
27 #include "arm_compute/core/experimental/Types.h"
28 #include "src/dynamic_fusion/sketch/gpu/components/cl/ClComponentElementwiseBinary.h"
29 #include "src/dynamic_fusion/sketch/gpu/template_writer/GpuKernelVariableTable.h"
30 #include "src/dynamic_fusion/sketch/gpu/template_writer/IGpuTemplateComponentWriter.h"
31 
32 namespace arm_compute
33 {
34 namespace experimental
35 {
36 namespace dynamic_fusion
37 {
38 class ClTemplateElementwiseBinary final : public IGpuTemplateComponentWriter
39 {
40 public:
41     using Attributes = ClComponentElementwiseBinary::Attributes;
42 
43     /** Constructor
44      *
45      * Similar to @ref ClComponentElementwiseBinary::validate()
46      *
47      * @param[in] id         Component id
48      * @param[in] tensors    Tensor arguments to the components
49      * @param[in] attributes Component attributes
50      */
51     ClTemplateElementwiseBinary(ComponentId                      id,
52                                 const ArgumentPack<ITensorInfo> &tensors,
53                                 const Attributes                &attributes);
54     /** Prevent instances of this class from being copy constructed */
55     ClTemplateElementwiseBinary(const ClTemplateElementwiseBinary &elementwise) = delete;
56     /** Prevent instances of this class from being copied */
57     ClTemplateElementwiseBinary &operator=(const ClTemplateElementwiseBinary &elementwise) = delete;
58     /** Allow instances of this class to be move constructed */
59     ClTemplateElementwiseBinary(ClTemplateElementwiseBinary &&elementwise) = default;
60     /** Allow instances of this class to be moved */
61     ClTemplateElementwiseBinary &operator=(ClTemplateElementwiseBinary &&elementwise) = default;
62 
63     /** Generate kernel component name */
64     std::string get_name() const override;
65 
66     /** Generate kernel component code template
67      *
68      * @param[in] comp_group Component group of which the component is a part of
69      *
70      * @return std::string Component code
71      */
72     std::string get_component_code(const ComponentGroup &comp_group) const override;
73 
74     /** Declare all variables used by the component in the @p vtable
75      *
76      * @param[out] vtable     Variable table
77      * @param[in]  comp_group Component group of which the component is a part of
78      */
79     void declare_variables(GpuKernelVariableTable &vtable, const ComponentGroup &comp_group) const override;
80 
81     /** Generate the tag look-up table used to instantiate the component code.
82      *
83      * @param[in] vtable     Variable table
84      * @param[in] comp_group Component group of which the component is a part of
85      *
86      * @return TagLUT  Tag lookup table
87      */
88     TagLUT get_tag_lut(const GpuKernelVariableTable &vtable, const ComponentGroup &comp_group) const override;
89 
90     /** Generate the build options used in the component
91      *
92      * @param[in] comp_group Component group of which the component is a part of
93      *
94      * @return CLBuildOptions Build options
95      */
96     CLBuildOptions get_build_options(const ComponentGroup &comp_group) const override;
97 
98     /** Generate the component config id string used for tuning */
99     std::string get_config_id() const override;
100 
101     /** Generate the header list used in the component */
102     std::set<std::string> get_headers_list() const override;
103 
104     /** Generate the execution window for the component */
105     Window get_window() const override;
106 
107 private:
108     const ITensorInfo *_lhs;
109     const ITensorInfo *_rhs;
110     const ITensorInfo *_dst;
111     Attributes         _attributes;
112 };
113 } // namespace dynamic_fusion
114 } // namespace experimental
115 } // namespace arm_compute
116 #endif /* SRC_DYNAMIC_FUSION_SKETCH_GPU_TEMPLATE_WRITER_CL_CLTEMPLATEELEMENTWISEBINARY */
117