xref: /aosp_15_r20/external/ComputeLibrary/arm_compute/dynamic_fusion/sketch/gpu/operators/GpuOutput.h (revision c217d954acce2dbc11938adb493fc0abd69584f3)
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 
25 #ifndef ARM_COMPUTE_DYNAMIC_FUSION_SKETCH_GPU_OPERATORS_GPUOUTPUT
26 #define ARM_COMPUTE_DYNAMIC_FUSION_SKETCH_GPU_OPERATORS_GPUOUTPUT
27 
28 #include "arm_compute/core/ITensorInfo.h"
29 
30 namespace arm_compute
31 {
32 namespace experimental
33 {
34 namespace dynamic_fusion
35 {
36 /** Forward declaration */
37 class GpuWorkloadContext;
38 class GpuWorkloadSketch;
39 
40 /** Operator interface. */
41 class GpuOutput final
42 {
43 public:
44     /** Create an operator and fuse it into the workload sketch.
45      *    @note If @ref validate_op() fails, the creation also fails and may throw an error.
46      *    @note If @ref validate_op() fails, @p sketch remains unchanged and valid.
47      *
48      * Valid data type configurations:
49      *   - Any
50      *
51      * Valid data layouts:
52      *   - Any
53      *
54      * @param[in, out] sketch Workload sketch into which the operator will be fused.
55      * @param[in, out] src    Source tensor info.
56      * @param[in, out] dst    Destination tensor info.
57      *                        If an uninitialized ITensorInfo is passed in, it will be auto-initialized.
58      */
59     static void create_op(GpuWorkloadSketch &sketch,
60                           ITensorInfo       *src,
61                           ITensorInfo       *dst);
62 
63     /** Check if the operator configuration is supported, irrespective of fusion.
64      *
65      * @param[in] context Workload context within which the operator is running.
66      * @param[in] src     Source tensor info.
67      * @param[in] dst     Destination tensor info.
68      *
69      * @return Status
70      */
71     static Status is_supported_op(const GpuWorkloadContext &context,
72                                   const ITensorInfo        *src,
73                                   const ITensorInfo        *dst);
74 
75     /** Validate the operator and check if the its configuration is supported and if it can be fused into the workload sketch.
76      *
77      * Parameters are similar to @ref GpuOutput::create_op().
78      *
79      * @return Status
80      */
81     static Status validate_op(const GpuWorkloadSketch &sketch,
82                               const ITensorInfo       *src,
83                               const ITensorInfo       *dst);
84 };
85 
86 } // namespace dynamic_fusion
87 } // namespace experimental
88 } // namespace arm_compute
89 
90 #endif /* ARM_COMPUTE_DYNAMIC_FUSION_SKETCH_GPU_OPERATORS_GPUOUTPUT */
91