xref: /aosp_15_r20/external/XNNPACK/src/operators/unpooling-nhwc.c (revision 4bdc94577ba0e567308109d787f7fec7b531ce36)
1 // Copyright 2019 Google LLC
2 //
3 // This source code is licensed under the BSD-style license found in the
4 // LICENSE file in the root directory of this source tree.
5 
6 #include <assert.h>
7 #include <math.h>
8 #include <stdbool.h>
9 #include <stddef.h>
10 #include <stdint.h>
11 #include <stdlib.h>
12 #include <string.h>
13 
14 #include <xnnpack.h>
15 #include <xnnpack/allocator.h>
16 #include <xnnpack/operator.h>
17 #include <xnnpack/log.h>
18 #include <xnnpack/common.h>
19 #include <xnnpack/math.h>
20 #include <xnnpack/params.h>
21 #include <xnnpack/indirection.h>
22 
23 
xnn_create_unpooling2d_nhwc_x32(uint32_t input_padding_top,uint32_t input_padding_right,uint32_t input_padding_bottom,uint32_t input_padding_left,uint32_t pooling_height,uint32_t pooling_width,size_t channels,size_t input_pixel_stride,size_t output_pixel_stride,uint32_t flags,xnn_operator_t * unpooling_op_out)24 enum xnn_status xnn_create_unpooling2d_nhwc_x32(
25     uint32_t input_padding_top,
26     uint32_t input_padding_right,
27     uint32_t input_padding_bottom,
28     uint32_t input_padding_left,
29     uint32_t pooling_height,
30     uint32_t pooling_width,
31     size_t channels,
32     size_t input_pixel_stride,
33     size_t output_pixel_stride,
34     uint32_t flags,
35     xnn_operator_t* unpooling_op_out)
36 {
37   xnn_operator_t unpooling_op = NULL;
38   enum xnn_status status = xnn_status_uninitialized;
39 
40   if ((xnn_params.init_flags & XNN_INIT_FLAG_XNNPACK) == 0) {
41     xnn_log_error("failed to create %s operator: XNNPACK is not initialized",
42       xnn_operator_type_to_string(xnn_operator_type_unpooling_nhwc_x32));
43     goto error;
44   }
45 
46   status = xnn_status_invalid_parameter;
47 
48   const uint32_t pooling_size = pooling_height * pooling_width;
49   if (pooling_size == 0) {
50     xnn_log_error(
51       "failed to create %s operator with %" PRIu32 "x%" PRIu32 " pooling size: "
52       "pooling size dimensions must be non-zero",
53       xnn_operator_type_to_string(xnn_operator_type_unpooling_nhwc_x32), pooling_width, pooling_height);
54     goto error;
55   }
56 
57   if (pooling_size == 1) {
58     xnn_log_error(
59       "failed to create %s operator with 1 pooling element: 1x1 unpooling is meaningless",
60       xnn_operator_type_to_string(xnn_operator_type_unpooling_nhwc_x32));
61     goto error;
62   }
63 
64   if (channels == 0) {
65     xnn_log_error(
66       "failed to create %s operator with %zu channels: number of channels must be non-zero",
67       xnn_operator_type_to_string(xnn_operator_type_unpooling_nhwc_x32), channels);
68     goto error;
69   }
70 
71   if (input_pixel_stride < channels) {
72     xnn_log_error(
73       "failed to create %s operator with input pixel stride of %zu: "
74       "stride must be at least as large as the number of channels (%zu)",
75       xnn_operator_type_to_string(xnn_operator_type_unpooling_nhwc_x32), input_pixel_stride, channels);
76     goto error;
77   }
78 
79   if (output_pixel_stride < channels) {
80     xnn_log_error(
81       "failed to create %s operator with output pixel stride of %zu: "
82       "stride must be at least as large as the number of channels (%zu)",
83       xnn_operator_type_to_string(xnn_operator_type_unpooling_nhwc_x32), output_pixel_stride, channels);
84     goto error;
85   }
86 
87   status = xnn_status_out_of_memory;
88 
89   unpooling_op = xnn_allocate_zero_simd_memory(sizeof(struct xnn_operator));
90   if (unpooling_op == NULL) {
91     xnn_log_error(
92       "failed to allocate %zu bytes for %s operator descriptor",
93       sizeof(struct xnn_operator), xnn_operator_type_to_string(xnn_operator_type_unpooling_nhwc_x32));
94     goto error;
95   }
96 
97   unpooling_op->padding_top = input_padding_top;
98   unpooling_op->padding_right = input_padding_right;
99   unpooling_op->padding_bottom = input_padding_bottom;
100   unpooling_op->padding_left = input_padding_left;
101 
102   unpooling_op->kernel_height = pooling_height;
103   unpooling_op->kernel_width = pooling_width;
104   unpooling_op->channels = channels;
105   unpooling_op->input_pixel_stride = input_pixel_stride;
106   unpooling_op->output_pixel_stride = output_pixel_stride;
107 
108   unpooling_op->type = xnn_operator_type_unpooling_nhwc_x32;
109   unpooling_op->flags = flags;
110 
111   unpooling_op->state = xnn_run_state_invalid;
112 
113   *unpooling_op_out = unpooling_op;
114   return xnn_status_success;
115 
116 error:
117   xnn_delete_operator(unpooling_op);
118   return status;
119 }
120 
xnn_setup_unpooling2d_nhwc_x32(xnn_operator_t unpooling_op,size_t batch_size,size_t input_height,size_t input_width,const void * input,const uint32_t * index,void * output,pthreadpool_t threadpool)121 enum xnn_status xnn_setup_unpooling2d_nhwc_x32(
122     xnn_operator_t unpooling_op,
123     size_t batch_size,
124     size_t input_height,
125     size_t input_width,
126     const void* input,
127     const uint32_t* index,
128     void* output,
129     pthreadpool_t threadpool)
130 {
131   if (unpooling_op->type != xnn_operator_type_unpooling_nhwc_x32) {
132     xnn_log_error("failed to setup operator: operator type mismatch (expected %s, got %s)",
133       xnn_operator_type_to_string(xnn_operator_type_unpooling_nhwc_x32),
134       xnn_operator_type_to_string(unpooling_op->type));
135     return xnn_status_invalid_parameter;
136   }
137   unpooling_op->state = xnn_run_state_invalid;
138 
139   if ((xnn_params.init_flags & XNN_INIT_FLAG_XNNPACK) == 0) {
140     xnn_log_error("failed to setup %s operator: XNNPACK is not initialized",
141       xnn_operator_type_to_string(xnn_operator_type_unpooling_nhwc_x32));
142     return xnn_status_uninitialized;
143   }
144 
145   if (input_width == 0 || input_height == 0) {
146     xnn_log_error(
147       "failed to setup %s operator with %zux%zu input: input dimensions must be non-zero",
148       xnn_operator_type_to_string(xnn_operator_type_unpooling_nhwc_x32), input_width, input_height);
149     return xnn_status_invalid_parameter;
150   }
151 
152   if (batch_size == 0) {
153     unpooling_op->state = xnn_run_state_skip;
154     return xnn_status_success;
155   }
156 
157   unpooling_op->batch_size = batch_size;
158   unpooling_op->input_height = input_height;
159   unpooling_op->input_width = input_width;
160   unpooling_op->input = input;
161 
162   unpooling_op->output_height = xnn_compute_unpooling_output_dimension(
163     input_height, unpooling_op->padding_top + unpooling_op->padding_bottom,
164     unpooling_op->kernel_height);
165   unpooling_op->output_width = xnn_compute_unpooling_output_dimension(
166     input_width, unpooling_op->padding_left + unpooling_op->padding_right,
167     unpooling_op->kernel_width);
168   unpooling_op->output = output;
169 
170   size_t valid_batch_size = 0;
171   if (output == unpooling_op->last_output &&
172       input_height == unpooling_op->last_input_height &&
173       input_width == unpooling_op->last_input_width)
174   {
175     valid_batch_size = unpooling_op->valid_batch_size;
176     if (batch_size <= valid_batch_size) {
177       unpooling_op->compute.range[0] = batch_size * input_height;
178       unpooling_op->state = xnn_run_state_ready;
179       return xnn_status_success;
180     }
181   }
182 
183   const size_t pooling_height = unpooling_op->kernel_height;
184   const size_t pooling_width = unpooling_op->kernel_width;
185   const size_t pooling_size = pooling_height * pooling_width;
186 
187   const size_t indirection_buffer_size = sizeof(void*) * (batch_size * input_height * input_width * pooling_size);
188   const void** indirection_buffer = (const void**) xnn_reallocate_memory(unpooling_op->indirection_buffer, indirection_buffer_size);
189   if (indirection_buffer == NULL) {
190     xnn_log_error(
191       "failed to allocate %zu bytes for %s operator indirection buffer",
192       indirection_buffer_size, xnn_operator_type_to_string(xnn_operator_type_unpooling_nhwc_x32));
193     return xnn_status_out_of_memory;
194   }
195   unpooling_op->indirection_buffer = indirection_buffer;
196 
197   xnn_indirection_init_unpool2d(unpooling_op, valid_batch_size, 2 /* log2(sizeof(type32)) */);
198 
199   const size_t channels = unpooling_op->channels;
200   const size_t input_pixel_stride_in_bytes = unpooling_op->input_pixel_stride * sizeof(float);
201   unpooling_op->context.unpooling = (struct unpooling_context) {
202     .input = input,
203     .input_height_stride = input_width * input_pixel_stride_in_bytes,
204     .input_width_stride = input_pixel_stride_in_bytes,
205     .index = index,
206     .index_height_stride = input_width * channels * sizeof(uint32_t),
207     .index_width_stride = channels * sizeof(uint32_t),
208     .indirect_output = indirection_buffer,
209     .indirect_output_height_stride = input_width * pooling_size * sizeof(void*),
210     .indirect_output_width_stride = pooling_size * sizeof(void*),
211     .pooling_size = pooling_size,
212     .channels = channels,
213     .fill_value = 0,
214     .ukernel = xnn_params.x32.unpool,
215   };
216   unpooling_op->compute.type = xnn_parallelization_type_2d;
217   unpooling_op->compute.task_2d = (pthreadpool_task_2d_t) xnn_compute_unpooling;
218   unpooling_op->compute.range[0] = batch_size * input_height;
219   unpooling_op->compute.range[1] = input_width;
220   unpooling_op->state = xnn_run_state_ready;
221 
222   unpooling_op->last_output = output;
223   unpooling_op->last_input_height = input_height;
224   unpooling_op->last_input_width = input_width;
225   unpooling_op->valid_batch_size = max(valid_batch_size, batch_size);
226 
227   return xnn_status_success;
228 }
229