1 /*
2 * Copyright (c) 2018-2020 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 "src/core/CL/kernels/CLGatherKernel.h"
25 #include "arm_compute/core/CL/ICLTensor.h"
26 #include "arm_compute/core/utils/misc/ShapeCalculator.h"
27 #include "src/core/helpers/AutoConfiguration.h"
28 #include "src/core/helpers/WindowHelpers.h"
29 #include "support/StringSupport.h"
30
31 #include <string>
32
33 namespace arm_compute
34 {
35 namespace
36 {
validate_arguments(const ITensorInfo * input,const ITensorInfo * indices,const ITensorInfo * output,int axis)37 inline Status validate_arguments(const ITensorInfo *input, const ITensorInfo *indices, const ITensorInfo *output, int axis)
38 {
39 ARM_COMPUTE_RETURN_ERROR_ON_NULLPTR(input, indices, output);
40 const uint32_t actual_axis = wrap_around(axis, static_cast<int>(input->num_dimensions()));
41 ARM_COMPUTE_RETURN_ERROR_ON(indices->num_dimensions() > 1);
42 ARM_COMPUTE_RETURN_ERROR_ON(input->num_dimensions() > 4);
43 ARM_COMPUTE_RETURN_ERROR_ON(actual_axis >= input->num_dimensions());
44 ARM_COMPUTE_RETURN_ERROR_ON(input->data_type() == DataType::UNKNOWN);
45
46 if(output->total_size() != 0)
47 {
48 ARM_COMPUTE_RETURN_ERROR_ON_MISMATCHING_DATA_TYPES(input, output);
49 ARM_COMPUTE_RETURN_ERROR_ON_MISMATCHING_QUANTIZATION_INFO(input, output);
50 TensorShape output_shape = arm_compute::misc::shape_calculator::compute_gather_shape(input->tensor_shape(), indices->tensor_shape(), actual_axis);
51 ARM_COMPUTE_RETURN_ERROR_ON(output_shape.total_size() != output->tensor_shape().total_size());
52 }
53
54 ARM_COMPUTE_RETURN_ERROR_ON_DATA_TYPE_CHANNEL_NOT_IN(indices, 1, DataType::U32, DataType::S32);
55
56 return Status{};
57 }
58
validate_and_configure_window(ITensorInfo * input,ITensorInfo * indices,ITensorInfo * output,int axis)59 std::pair<Status, Window> validate_and_configure_window(ITensorInfo *input, ITensorInfo *indices, ITensorInfo *output, int axis)
60 {
61 ARM_COMPUTE_ERROR_ON_NULLPTR(input, output, indices);
62 const uint32_t actual_axis = wrap_around(axis, static_cast<int>(input->num_dimensions()));
63 // Output auto initialization if not yet initialized
64 TensorShape output_shape = arm_compute::misc::shape_calculator::compute_gather_shape(input->tensor_shape(), indices->tensor_shape(), actual_axis);
65 auto_init_if_empty((*output), output_shape, 1, input->data_type());
66
67 // Create window
68 Window win = calculate_max_window(*output, Steps());
69 output->set_valid_region(ValidRegion(Coordinates(), output->tensor_shape()));
70
71 return std::make_pair(Status{}, win);
72 }
73
74 } // namespace
75
CLGatherKernel()76 CLGatherKernel::CLGatherKernel()
77 : _input(nullptr), _indices(nullptr), _output(nullptr), _axis(0)
78 {
79 }
80
configure(const ICLTensor * input,const ICLTensor * indices,ICLTensor * output,int axis)81 void CLGatherKernel::configure(const ICLTensor *input, const ICLTensor *indices, ICLTensor *output, int axis)
82 {
83 configure(CLKernelLibrary::get().get_compile_context(), input, indices, output, axis);
84 }
85
configure(const CLCompileContext & compile_context,const ICLTensor * input,const ICLTensor * indices,ICLTensor * output,int axis)86 void CLGatherKernel::configure(const CLCompileContext &compile_context, const ICLTensor *input, const ICLTensor *indices, ICLTensor *output, int axis)
87 {
88 ARM_COMPUTE_ERROR_ON_NULLPTR(input, output, indices);
89 ARM_COMPUTE_ERROR_THROW_ON(validate_arguments(input->info(), indices->info(), output->info(), axis));
90
91 // Configure kernel window
92 auto win_config = validate_and_configure_window(input->info(), indices->info(), output->info(), axis);
93 ARM_COMPUTE_ERROR_THROW_ON(win_config.first);
94
95 _input = input;
96 _output = output;
97 _indices = indices;
98 _axis = wrap_around(axis, static_cast<int>(input->info()->num_dimensions()));
99
100 // Set build options
101 CLBuildOptions build_opts;
102 build_opts.add_option("-DDATA_TYPE=" + get_cl_unsigned_type_from_element_size(data_size_from_type(input->info()->data_type())));
103 build_opts.add_option("-DOUTPUT_DIM_Z=" + support::cpp11::to_string(output->info()->dimension(2)));
104 build_opts.add_option("-DINPUT_DIM_Z=" + support::cpp11::to_string(input->info()->dimension(2)));
105 build_opts.add_option("-DAXIS=" + support::cpp11::to_string(_axis));
106
107 // Create kernel
108 _kernel = create_kernel(compile_context, "gather", build_opts.options());
109 ICLKernel::configure_internal(win_config.second);
110 }
111
validate(const ITensorInfo * input,const ITensorInfo * indices,const ITensorInfo * output,int axis)112 Status CLGatherKernel::validate(const ITensorInfo *input, const ITensorInfo *indices, const ITensorInfo *output, int axis)
113 {
114 ARM_COMPUTE_RETURN_ON_ERROR(validate_arguments(input, indices, output, axis));
115 ARM_COMPUTE_RETURN_ON_ERROR(validate_and_configure_window(input->clone().get(), indices->clone().get(), output->clone().get(), axis).first);
116 return Status{};
117 }
118
run(const Window & window,cl::CommandQueue & queue)119 void CLGatherKernel::run(const Window &window, cl::CommandQueue &queue)
120 {
121 ARM_COMPUTE_ERROR_ON_UNCONFIGURED_KERNEL(this);
122 ARM_COMPUTE_ERROR_ON_INVALID_SUBWINDOW(IKernel::window(), window);
123
124 Window window_collapsed = window.collapse_if_possible(ICLKernel::window(), Window::DimZ);
125 unsigned int idx = 0;
126 add_4D_tensor_argument(idx, _input, window_collapsed);
127 add_1D_tensor_argument(idx, _indices, window_collapsed);
128 add_4D_tensor_argument(idx, _output, window_collapsed);
129 enqueue(queue, *this, window_collapsed, lws_hint());
130 }
131 } // namespace arm_compute
132