Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (c) 2016, 2017 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 | #include "arm_compute/core/CL/kernels/CLPixelWiseMultiplicationKernel.h" |
| 25 | |
| 26 | #include "arm_compute/core/CL/CLHelpers.h" |
| 27 | #include "arm_compute/core/CL/CLKernelLibrary.h" |
| 28 | #include "arm_compute/core/CL/ICLTensor.h" |
| 29 | #include "arm_compute/core/CL/OpenCL.h" |
| 30 | #include "arm_compute/core/Error.h" |
| 31 | #include "arm_compute/core/Helpers.h" |
| 32 | #include "arm_compute/core/TensorInfo.h" |
| 33 | #include "arm_compute/core/Validate.h" |
| 34 | #include "arm_compute/core/Window.h" |
| 35 | |
| 36 | #include <cmath> |
| 37 | #include <cstdlib> |
| 38 | #include <set> |
| 39 | #include <string> |
| 40 | |
| 41 | using namespace arm_compute; |
| 42 | |
Giorgio Arena | 7062382 | 2017-11-27 15:50:10 +0000 | [diff] [blame] | 43 | namespace |
| 44 | { |
| 45 | Error validate_arguments(const ITensorInfo *input1, const ITensorInfo *input2, const ITensorInfo *output, float scale, |
| 46 | ConvertPolicy overflow_policy, RoundingPolicy rounding_policy) |
| 47 | { |
| 48 | ARM_COMPUTE_UNUSED(overflow_policy); |
| 49 | ARM_COMPUTE_UNUSED(rounding_policy); |
| 50 | |
| 51 | ARM_COMPUTE_RETURN_ERROR_ON_DATA_TYPE_CHANNEL_NOT_IN(input1, 1, DataType::U8, DataType::QS8, DataType::QS16, DataType::S16, DataType::F16, DataType::F32); |
| 52 | ARM_COMPUTE_RETURN_ERROR_ON_DATA_TYPE_CHANNEL_NOT_IN(input2, 1, DataType::U8, DataType::QS8, DataType::QS16, DataType::S16, DataType::F16, DataType::F32); |
| 53 | ARM_COMPUTE_RETURN_ERROR_ON_MISMATCHING_SHAPES(input1, input2); |
| 54 | ARM_COMPUTE_RETURN_ERROR_ON_MISMATCHING_FIXED_POINT(input1, input2); |
| 55 | ARM_COMPUTE_RETURN_ERROR_ON_MSG(scale < 0, "Scale cannot be negative."); |
| 56 | |
| 57 | if(is_data_type_fixed_point(input1->data_type())) |
| 58 | { |
| 59 | // All data types must be all QS8 or all QS16 |
| 60 | ARM_COMPUTE_RETURN_ERROR_ON_MISMATCHING_DATA_TYPES(input1, input2); |
| 61 | ARM_COMPUTE_RETURN_ERROR_ON_MSG(scale != 1, "Unsupported scaling factor for QS8/QS16. Scale must be 1."); |
| 62 | } |
| 63 | |
| 64 | // Validate in case of configured output |
| 65 | if((output != nullptr) && (output->total_size() != 0)) |
| 66 | { |
| 67 | ARM_COMPUTE_RETURN_ERROR_ON_DATA_TYPE_CHANNEL_NOT_IN(output, 1, DataType::U8, DataType::QS8, DataType::QS16, DataType::S16, DataType::F16, DataType::F32); |
| 68 | ARM_COMPUTE_RETURN_ERROR_ON_MSG(output->data_type() == DataType::U8 && (input1->data_type() != DataType::U8 || input2->data_type() != DataType::U8), |
| 69 | "Output can only be U8 if both inputs are U8"); |
| 70 | ARM_COMPUTE_RETURN_ERROR_ON_MISMATCHING_SHAPES(input1, output); |
| 71 | ARM_COMPUTE_RETURN_ERROR_ON_MISMATCHING_FIXED_POINT(input1, output); |
| 72 | if(is_data_type_fixed_point(input1->data_type())) |
| 73 | { |
| 74 | ARM_COMPUTE_RETURN_ERROR_ON_MISMATCHING_DATA_TYPES(input1, output); |
| 75 | } |
| 76 | } |
| 77 | |
| 78 | return Error{}; |
| 79 | } |
| 80 | |
| 81 | std::pair<Error, Window> validate_and_configure_window(ITensorInfo *input1, ITensorInfo *input2, ITensorInfo *output) |
| 82 | { |
| 83 | constexpr unsigned int num_elems_processed_per_iteration = 16; |
| 84 | |
| 85 | Window win = calculate_max_window(*input1, Steps(num_elems_processed_per_iteration)); |
| 86 | |
| 87 | AccessWindowHorizontal input1_access(input1, 0, num_elems_processed_per_iteration); |
| 88 | AccessWindowHorizontal input2_access(input2, 0, num_elems_processed_per_iteration); |
| 89 | AccessWindowHorizontal output_access(output, 0, num_elems_processed_per_iteration); |
| 90 | |
| 91 | bool window_changed = update_window_and_padding(win, input1_access, input2_access, output_access); |
| 92 | |
| 93 | ValidRegion valid_region = intersect_valid_regions(input1->valid_region(), |
| 94 | input2->valid_region()); |
| 95 | output_access.set_valid_region(win, valid_region); |
| 96 | |
| 97 | Error err = (window_changed) ? ARM_COMPUTE_CREATE_ERROR(ErrorCode::RUNTIME_ERROR, "Insufficient Padding!") : Error{}; |
| 98 | return std::make_pair(err, win); |
| 99 | } |
| 100 | } // namespace |
| 101 | |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 102 | CLPixelWiseMultiplicationKernel::CLPixelWiseMultiplicationKernel() |
| 103 | : _input1(nullptr), _input2(nullptr), _output(nullptr) |
| 104 | { |
| 105 | } |
| 106 | |
| 107 | void CLPixelWiseMultiplicationKernel::configure(const ICLTensor *input1, const ICLTensor *input2, ICLTensor *output, float scale, |
| 108 | ConvertPolicy overflow_policy, RoundingPolicy rounding_policy) |
| 109 | { |
Georgios Pinitas | f0dea70 | 2017-07-03 18:17:28 +0100 | [diff] [blame] | 110 | ARM_COMPUTE_ERROR_ON_NULLPTR(input1, input2, output); |
| 111 | |
| 112 | // Auto initialize output if not initialized |
| 113 | { |
| 114 | set_shape_if_empty(*output->info(), input1->info()->tensor_shape()); |
| 115 | |
| 116 | if(input1->info()->data_type() == DataType::S16 || input2->info()->data_type() == DataType::S16) |
| 117 | { |
| 118 | set_format_if_unknown(*output->info(), Format::S16); |
| 119 | } |
| 120 | else if(input1->info()->data_type() == DataType::F32 || input2->info()->data_type() == DataType::F32) |
| 121 | { |
| 122 | set_format_if_unknown(*output->info(), Format::F32); |
| 123 | } |
| 124 | } |
| 125 | |
Georgios Pinitas | f9d3a0a | 2017-11-03 19:01:44 +0000 | [diff] [blame] | 126 | ARM_COMPUTE_ERROR_THROW_ON(CLPixelWiseMultiplicationKernel::validate(input1->info(), input2->info(), output->info(), |
| 127 | scale, overflow_policy, rounding_policy)); |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 128 | |
| 129 | _input1 = input1; |
| 130 | _input2 = input2; |
| 131 | _output = output; |
| 132 | |
| 133 | int scale_int = -1; |
| 134 | // Extract sign, exponent and mantissa |
| 135 | int exponent = 0; |
| 136 | float normalized_mantissa = std::frexp(scale, &exponent); |
| 137 | // Use int scaling if factor is equal to 1/2^n for 0 <= n <= 15 |
| 138 | // frexp returns 0.5 as mantissa which means that the exponent will be in the range of -1 <= e <= 14 |
| 139 | // Moreover, it will be negative as we deal with 1/2^n |
| 140 | if((normalized_mantissa == 0.5f) && (-14 <= exponent) && (exponent <= 1)) |
| 141 | { |
| 142 | // Store the positive exponent. We know that we compute 1/2^n |
| 143 | // Additionally we need to subtract 1 to compensate that frexp used a mantissa of 0.5 |
| 144 | scale_int = std::abs(exponent - 1); |
| 145 | } |
| 146 | |
| 147 | std::string data_type; |
| 148 | std::string compute_type; |
| 149 | // Check if it has float inputs and output |
| 150 | if(is_data_type_float(input1->info()->data_type()) || is_data_type_float(input2->info()->data_type())) |
| 151 | { |
| 152 | scale_int = -1; |
Michele Di Giorgio | ab0a77e | 2017-06-21 15:36:24 +0100 | [diff] [blame] | 153 | compute_type = (input1->info()->data_type() == DataType::F32 || input2->info()->data_type() == DataType::F32) ? "float" : "half"; |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 154 | data_type = "DATA_TYPE_FLOAT"; |
| 155 | } |
| 156 | else |
| 157 | { |
Michele Di Giorgio | ab0a77e | 2017-06-21 15:36:24 +0100 | [diff] [blame] | 158 | if(input1->info()->data_type() == DataType::S16 || input2->info()->data_type() == DataType::S16) |
| 159 | { |
| 160 | compute_type = "int"; |
| 161 | } |
| 162 | else if(input1->info()->data_type() == DataType::QS8) |
| 163 | { |
| 164 | compute_type = "qs8"; |
| 165 | } |
| 166 | else if(input1->info()->data_type() == DataType::QS16) |
| 167 | { |
| 168 | compute_type = "qs16"; |
| 169 | } |
| 170 | else |
| 171 | { |
| 172 | compute_type = "ushort"; |
| 173 | } |
| 174 | data_type = "DATA_TYPE_INT"; |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 175 | } |
| 176 | |
| 177 | // Construct kernel name |
| 178 | std::string kernel_name = "pixelwise_mul"; |
| 179 | kernel_name += (scale_int >= 0) ? "_int" : "_float"; |
| 180 | |
| 181 | // Set kernel build options |
| 182 | std::set<std::string> build_opts; |
| 183 | build_opts.emplace((overflow_policy == ConvertPolicy::WRAP || is_data_type_float(output->info()->data_type())) ? "-DWRAP" : "-DSATURATE"); |
| 184 | build_opts.emplace((rounding_policy == RoundingPolicy::TO_ZERO) ? "-DROUND=_rtz" : "-DROUND=_rte"); |
Michele Di Giorgio | ab0a77e | 2017-06-21 15:36:24 +0100 | [diff] [blame] | 185 | if(is_data_type_fixed_point(input1->info()->data_type())) |
| 186 | { |
| 187 | build_opts.emplace("-DFIXED_POINT_POSITION=" + support::cpp11::to_string(input1->info()->fixed_point_position())); |
| 188 | } |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 189 | build_opts.emplace("-DDATA_TYPE_IN1=" + get_cl_type_from_data_type(input1->info()->data_type())); |
| 190 | build_opts.emplace("-DDATA_TYPE_IN2=" + get_cl_type_from_data_type(input2->info()->data_type())); |
| 191 | build_opts.emplace("-DDATA_TYPE_OUT=" + get_cl_type_from_data_type(output->info()->data_type())); |
| 192 | build_opts.emplace("-DDATA_TYPE_RES=" + compute_type); |
| 193 | build_opts.emplace("-D" + data_type); |
| 194 | |
| 195 | // Create kernel |
| 196 | _kernel = static_cast<cl::Kernel>(CLKernelLibrary::get().create_kernel(kernel_name, build_opts)); |
| 197 | |
| 198 | // Set scale argument |
Anthony Barbier | 9a7182e | 2017-07-11 18:36:40 +0100 | [diff] [blame] | 199 | unsigned int idx = 3 * num_arguments_per_3D_tensor(); //Skip the inputs and output parameters |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 200 | |
| 201 | if(scale_int >= 0) |
| 202 | { |
| 203 | _kernel.setArg(idx++, scale_int); |
| 204 | } |
| 205 | else |
| 206 | { |
| 207 | _kernel.setArg(idx++, scale); |
| 208 | } |
| 209 | |
| 210 | // Configure kernel window |
Giorgio Arena | 7062382 | 2017-11-27 15:50:10 +0000 | [diff] [blame] | 211 | auto win_config = validate_and_configure_window(input1->info(), input2->info(), output->info()); |
| 212 | ARM_COMPUTE_ERROR_THROW_ON(win_config.first); |
| 213 | ICLKernel::configure(win_config.second); |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 214 | } |
| 215 | |
Georgios Pinitas | f9d3a0a | 2017-11-03 19:01:44 +0000 | [diff] [blame] | 216 | Error CLPixelWiseMultiplicationKernel::validate(const ITensorInfo *input1, const ITensorInfo *input2, const ITensorInfo *output, float scale, |
| 217 | ConvertPolicy overflow_policy, RoundingPolicy rounding_policy) |
| 218 | { |
Giorgio Arena | 7062382 | 2017-11-27 15:50:10 +0000 | [diff] [blame] | 219 | ARM_COMPUTE_RETURN_ON_ERROR(validate_arguments(input1, input2, output, scale, overflow_policy, rounding_policy)); |
| 220 | ARM_COMPUTE_RETURN_ON_ERROR(validate_and_configure_window(input1->clone().get(), input2->clone().get(), output->clone().get()).first); |
Georgios Pinitas | f9d3a0a | 2017-11-03 19:01:44 +0000 | [diff] [blame] | 221 | |
| 222 | return Error{}; |
| 223 | } |
| 224 | |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 225 | void CLPixelWiseMultiplicationKernel::run(const Window &window, cl::CommandQueue &queue) |
| 226 | { |
| 227 | ARM_COMPUTE_ERROR_ON_UNCONFIGURED_KERNEL(this); |
| 228 | ARM_COMPUTE_ERROR_ON_INVALID_SUBWINDOW(ICLKernel::window(), window); |
| 229 | |
Anthony Barbier | 9a7182e | 2017-07-11 18:36:40 +0100 | [diff] [blame] | 230 | Window slice = window.first_slice_window_3D(); |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 231 | |
| 232 | do |
| 233 | { |
| 234 | unsigned int idx = 0; |
Anthony Barbier | 9a7182e | 2017-07-11 18:36:40 +0100 | [diff] [blame] | 235 | add_3D_tensor_argument(idx, _input1, slice); |
| 236 | add_3D_tensor_argument(idx, _input2, slice); |
| 237 | add_3D_tensor_argument(idx, _output, slice); |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 238 | enqueue(queue, *this, slice); |
| 239 | } |
Anthony Barbier | 9a7182e | 2017-07-11 18:36:40 +0100 | [diff] [blame] | 240 | while(window.slide_window_slice_3D(slice)); |
Anthony Barbier | 6ff3b19 | 2017-09-04 18:44:23 +0100 | [diff] [blame] | 241 | } |