Gian Marco Iodice | 781cba7 | 2020-06-19 16:56:57 +0100 | [diff] [blame] | 1 | /* |
Gian Marco Iodice | 3cce35d | 2022-12-30 16:07:45 +0000 | [diff] [blame] | 2 | * Copyright (c) 2020-2021, 2023 Arm Limited. |
Gian Marco Iodice | 781cba7 | 2020-06-19 16:56:57 +0100 | [diff] [blame] | 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_CL_CLUTILS_H |
| 26 | #define ARM_COMPUTE_CL_CLUTILS_H |
| 27 | |
| 28 | #include "arm_compute/core/CL/OpenCL.h" |
SiCongLi | 1af5416 | 2021-10-06 15:25:57 +0100 | [diff] [blame] | 29 | #include "arm_compute/core/experimental/IPostOp.h" |
Gian Marco Iodice | 781cba7 | 2020-06-19 16:56:57 +0100 | [diff] [blame] | 30 | |
Matthew Bentham | 314d3e2 | 2023-06-23 10:53:52 +0000 | [diff] [blame^] | 31 | #include <map> |
| 32 | |
Gian Marco Iodice | 781cba7 | 2020-06-19 16:56:57 +0100 | [diff] [blame] | 33 | namespace arm_compute |
| 34 | { |
| 35 | class TensorShape; |
SiCongLi | 1af5416 | 2021-10-06 15:25:57 +0100 | [diff] [blame] | 36 | class CLBuildOptions; |
| 37 | class ITensorInfo; |
Jakub Sujak | 8c49f16 | 2023-06-16 09:52:50 +0100 | [diff] [blame] | 38 | class ICLTensor; |
Matthew Bentham | 314d3e2 | 2023-06-23 10:53:52 +0000 | [diff] [blame^] | 39 | enum class DataType; |
Gian Marco Iodice | 781cba7 | 2020-06-19 16:56:57 +0100 | [diff] [blame] | 40 | |
Gian Marco Iodice | 3cce35d | 2022-12-30 16:07:45 +0000 | [diff] [blame] | 41 | /** OpenCL Image2D types */ |
| 42 | enum class CLImage2DType |
| 43 | { |
| 44 | ReadOnly, |
| 45 | WriteOnly |
| 46 | }; |
| 47 | |
Jakub Sujak | 8c49f16 | 2023-06-16 09:52:50 +0100 | [diff] [blame] | 48 | /** Create a cl::Image2D object from a tensor |
| 49 | * |
| 50 | * @param[in] tensor Tensor from which to construct Image 2D object |
| 51 | * @param[in] image_type Image 2D type (@ref CLImage2DType) |
| 52 | * |
| 53 | * @return cl::Image2D object |
| 54 | */ |
| 55 | cl::Image2D create_image2d_from_tensor(const ICLTensor *tensor, CLImage2DType image_type); |
| 56 | |
Gian Marco Iodice | 781cba7 | 2020-06-19 16:56:57 +0100 | [diff] [blame] | 57 | /** Create a cl::Image2D object from an OpenCL buffer |
| 58 | * |
| 59 | * @note The following conditions are required to create a OpenCL image object from OpenCL buffer, |
| 60 | * -# The platform should support the OpenCL cl_khr_image2d_from_buffer extension |
| 61 | * -# The stride Y for the input1 should satisfy the OpenCL pitch alignment requirement |
| 62 | * -# input width should be less or equal to (CL_DEVICE_IMAGE2D_MAX_WIDTH * 4) |
| 63 | * -# input height should be less or equal to CL_DEVICE_IMAGE2D_MAX_HEIGHT |
| 64 | * |
| 65 | * It is user responsibility to ensure the above conditions are satisfied since no checks are performed within this function |
| 66 | * |
| 67 | * @param[in] ctx cl::Context object |
| 68 | * @param[in] buffer cl::Buffer object from which the OpenCL image2d object is created |
| 69 | * @param[in] shape2d 2D tensor shape |
Gian Marco Iodice | 6f93134 | 2020-09-15 14:17:41 +0100 | [diff] [blame] | 70 | * @param[in] data_type DataType to use. Only supported: F32,F16 |
Gian Marco Iodice | 781cba7 | 2020-06-19 16:56:57 +0100 | [diff] [blame] | 71 | * @param[in] image_row_pitch Image row pitch (a.k.a. stride Y) to be used in the image2d object |
Gian Marco Iodice | 3cce35d | 2022-12-30 16:07:45 +0000 | [diff] [blame] | 72 | * @param[in] image_type Image 2D type (@ref CLImage2DType) |
Gian Marco Iodice | 781cba7 | 2020-06-19 16:56:57 +0100 | [diff] [blame] | 73 | * |
| 74 | * @return cl::Image2D object |
| 75 | */ |
Gian Marco Iodice | 3cce35d | 2022-12-30 16:07:45 +0000 | [diff] [blame] | 76 | cl::Image2D create_image2d_from_buffer(const cl::Context &ctx, const cl::Buffer &buffer, const TensorShape &shape2d, DataType data_type, size_t image_row_pitch, CLImage2DType image_type); |
Gian Marco Iodice | 781cba7 | 2020-06-19 16:56:57 +0100 | [diff] [blame] | 77 | |
SiCongLi | 1af5416 | 2021-10-06 15:25:57 +0100 | [diff] [blame] | 78 | namespace experimental |
| 79 | { |
| 80 | /** @name (EXPERIMENTAL_POST_OPS) |
| 81 | * @{ |
| 82 | */ |
| 83 | |
| 84 | /** Manage validation, building and configurations of PostOp CL kernels */ |
| 85 | class PostOpCLKernelUtils final |
| 86 | { |
| 87 | public: |
| 88 | /** CL kernel name postfix for post ops */ |
| 89 | using NamePostfix = std::string; |
| 90 | /** CL kernels that supports post ops assign each post op to a 'slot', in accordance with the postfix |
| 91 | * For example, for a kernel with postfix '_act_prelu_eltwiseadd', there are 3 slots |
| 92 | * slot 1: (unary) activation, slot 2: pRelu, slot 3: elementwise addition |
| 93 | * |
| 94 | * Some kernels may allow some slots to be optional, to support multiple combinations of post op sequences. |
| 95 | * In such cases, we need to explicitly set up a mapping between each post op and the slots for that kernel. |
| 96 | * For example, suppose we have 2 kernels with postfixes: _eltwiseadd_prelu, _act_eltwiseadd_act_prelu, where the activations in the |
| 97 | * second kernel are optional. Say we want to support an eltwise addition, followed by a prelu (sequence { eltwiseadd, prelu }). |
| 98 | * Now we can choose which one of the 2 kernels to use, since they both support this post op sequence. |
| 99 | * We can either: |
| 100 | * 1. assign the elementwise to slot 1 and prelu to slot 2 of kernel 1 |
| 101 | * { { Eltwise_Add, PRelu } -> {"_eltwise_act", {1, 2} } } or |
| 102 | * 2. assign the elementwise to slot 2 and prelu to slot 4 of kernel 1 |
| 103 | * { { Eltwise_Add, PRelu } -> {"_act_eltwiseadd_act_prelu", {2, 4} } } |
| 104 | */ |
| 105 | using Slots = std::vector<unsigned int>; |
| 106 | using Config = std::map<PostOpTypeSequence, std::tuple<NamePostfix, Slots>>; |
| 107 | |
| 108 | public: |
| 109 | explicit PostOpCLKernelUtils(const Config &config); |
| 110 | |
| 111 | /** Check if post op argument tensor shapes are compliant |
| 112 | * All post ops must not alter the shape of the original dst tensor (even after broadcasting) |
| 113 | * |
| 114 | * @param[in] dst Dst tensor to apply the post ops to |
| 115 | * @param[in] post_ops Post ops |
| 116 | * |
| 117 | * @return true if shapes are compliant and false otherwise |
| 118 | */ |
| 119 | static bool are_post_op_shapes_compliant(const ITensorInfo *dst, const experimental::PostOpList<ITensorInfo *> &post_ops); |
| 120 | /** Check if the post op sequence is supported in the current configuration |
| 121 | * |
| 122 | * @param[in] post_ops Post ops |
| 123 | * |
| 124 | * @return true if the post op sequence is supported and false otherwise |
| 125 | */ |
| 126 | bool is_post_op_sequence_supported(const PostOpList<ITensorInfo *> &post_ops) const; |
| 127 | /** Helper function to set PostOp related build options |
| 128 | * @note Convention |
| 129 | * 1. Each post op "slot" is prefixed with "P<slot number>", followed by the usual parameters for that post op. |
| 130 | * E.g. If the first slot is an activation, we need to pass 3 definitions in this way: |
| 131 | * -P1_ACTIVATION_TYPE=... -P1_ACTIVATION_A_VAL=... -P1_ACTIVATION_B_VAL=... |
| 132 | * |
| 133 | * 2. For multi-ary post ops, to pass the position of the previous op's dest tensor, |
| 134 | * we append "_X_POS_<pos>" to the post op type. |
| 135 | * E.g. for a single post op add(dst, x), where dst is the result of the main op. |
| 136 | * In this case, the position of the previous op's dest is 0, so we pass |
| 137 | * -P1_ELTWISE_OP=ADD_X_POS_0 |
| 138 | * |
| 139 | * @param[out] built_opts OpenCL kernel build options |
| 140 | * @param[in] post_ops Post ops |
| 141 | * |
| 142 | */ |
| 143 | void set_post_ops_cl_build_options(CLBuildOptions &built_opts, const PostOpList<ITensorInfo *> &post_ops) const; |
| 144 | /** Helper function to set PostOp kernel name |
| 145 | * |
| 146 | * @param[out] kernel_name OpenCL kernel name |
| 147 | * @param[in] post_ops Post ops |
| 148 | * |
| 149 | */ |
| 150 | void set_post_ops_cl_kernel_name(std::string &kernel_name, const PostOpList<ITensorInfo *> &post_ops) const; |
| 151 | |
| 152 | private: |
| 153 | Config _supported_config{}; |
| 154 | }; |
| 155 | /** @} */ // end of group (EXPERIMENTAL_POST_OPS) |
| 156 | |
| 157 | } // namespace experimental |
| 158 | |
Gian Marco Iodice | 781cba7 | 2020-06-19 16:56:57 +0100 | [diff] [blame] | 159 | } // arm_compute |
| 160 | |
| 161 | #endif /* ARM_COMPUTE_CL_CLUTILS_H */ |