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