xref: /aosp_15_r20/external/XNNPACK/src/subgraph/depth-to-space.c (revision 4bdc94577ba0e567308109d787f7fec7b531ce36)
1 // Copyright 2020 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 <stddef.h>
8 #include <stdint.h>
9 
10 #include <xnnpack.h>
11 #include <xnnpack/log.h>
12 #include <xnnpack/operator.h>
13 #include <xnnpack/params.h>
14 #include <xnnpack/subgraph.h>
15 #include <xnnpack/subgraph-validation.h>
16 
17 
create_depth_to_space_operator(const struct xnn_node * node,const struct xnn_value * values,size_t num_values,struct xnn_operator_data * opdata,const struct xnn_caches * caches)18 static enum xnn_status create_depth_to_space_operator(
19   const struct xnn_node* node,
20   const struct xnn_value* values,
21   size_t num_values,
22   struct xnn_operator_data* opdata,
23   const struct xnn_caches* caches)
24 {
25   assert(node->num_inputs == 1);
26   const uint32_t input_id = node->inputs[0];
27   assert(input_id != XNN_INVALID_VALUE_ID);
28   assert(input_id < num_values);
29 
30   assert(node->num_outputs == 1);
31   const uint32_t output_id = node->outputs[0];
32   assert(output_id != XNN_INVALID_VALUE_ID);
33   assert(output_id < num_values);
34 
35   const size_t input_channel_dim = values[input_id].shape.dim[3];
36   const size_t output_channel_dim = values[output_id].shape.dim[3];
37 
38   enum xnn_status status;
39   if (values[input_id].layout == xnn_layout_type_nchw) {
40     assert(values[output_id].layout == xnn_layout_type_nhwc);
41     assert(node->compute_type == xnn_compute_type_fp32);
42     status = xnn_create_depth_to_space_nchw2nhwc_x32(
43         output_channel_dim /* output channels */,
44         input_channel_dim /* input stride */,
45         output_channel_dim /* output stride */,
46         node->params.depth_to_space.block_size,
47         node->flags,
48         &opdata->operator_objects[0]);
49   } else {
50     assert(values[input_id].layout == xnn_layout_type_nhwc);
51     assert(values[output_id].layout == xnn_layout_type_nhwc);
52     switch (node->compute_type) {
53 #ifndef XNN_NO_F16_OPERATORS
54       case xnn_compute_type_fp16:
55         status = xnn_create_depth_to_space_nhwc_x16(
56             output_channel_dim /* output channels */,
57             input_channel_dim /* input stride */,
58             output_channel_dim /* output stride */,
59             node->params.depth_to_space.block_size,
60             node->flags,
61             &opdata->operator_objects[0]);
62         break;
63 #endif  // XNN_NO_F16_OPERATORS
64       case xnn_compute_type_fp32:
65         status = xnn_create_depth_to_space_nhwc_x32(
66             output_channel_dim /* output channels */,
67             input_channel_dim /* input stride */,
68             output_channel_dim /* output stride */,
69             node->params.depth_to_space.block_size,
70             node->flags,
71             &opdata->operator_objects[0]);
72         break;
73 #if !defined(XNN_NO_S8_OPERATORS) && !defined(XNN_NO_U8_OPERATORS)
74       case xnn_compute_type_qs8:
75       case xnn_compute_type_qu8:
76         status = xnn_create_depth_to_space_nhwc_x8(
77             output_channel_dim /* output channels */,
78             input_channel_dim /* input stride */,
79             output_channel_dim /* output stride */,
80             node->params.depth_to_space.block_size,
81             node->flags,
82             &opdata->operator_objects[0]);
83         break;
84 #endif  // !defined(XNN_NO_S8_OPERATORS) && !defined(XNN_NO_U8_OPERATORS)
85       default:
86         XNN_UNREACHABLE;
87     }
88   }
89   if (status == xnn_status_success) {
90     opdata->batch_size = values[input_id].shape.dim[0];
91     opdata->input_height = values[input_id].shape.dim[1];
92     opdata->input_width = values[input_id].shape.dim[2];
93     opdata->output_height = values[output_id].shape.dim[1];
94     opdata->output_width = values[output_id].shape.dim[2];
95     opdata->inputs[0] = input_id;
96     opdata->outputs[0] = output_id;
97   }
98   return status;
99 }
100 
setup_depth_to_space_operator(const struct xnn_operator_data * opdata,const struct xnn_blob * blobs,size_t num_blobs,pthreadpool_t threadpool)101 static enum xnn_status setup_depth_to_space_operator(
102   const struct xnn_operator_data* opdata,
103   const struct xnn_blob* blobs,
104   size_t num_blobs,
105   pthreadpool_t threadpool)
106 {
107   const uint32_t input_id = opdata->inputs[0];
108   assert(input_id != XNN_INVALID_VALUE_ID);
109   assert(input_id < num_blobs);
110 
111   const uint32_t output_id = opdata->outputs[0];
112   assert(output_id != XNN_INVALID_VALUE_ID);
113   assert(output_id < num_blobs);
114 
115   const struct xnn_blob* input_blob = blobs + input_id;
116   const void* input_data = input_blob->data;
117   assert(input_data != NULL);
118 
119   const struct xnn_blob* output_blob = blobs + output_id;
120   void* output_data = output_blob->data;
121   assert(output_data != NULL);
122 
123   switch (opdata->operator_objects[0]->type) {
124     case xnn_operator_type_depth_to_space_nchw2nhwc_x32:
125       return xnn_setup_depth_to_space_nchw2nhwc_x32(
126           opdata->operator_objects[0],
127           opdata->batch_size,
128           opdata->input_height,
129           opdata->input_width,
130           input_data,
131           output_data,
132           threadpool);
133 #ifndef XNN_NO_F16_OPERATORS
134     case xnn_operator_type_depth_to_space_nhwc_x16:
135       return xnn_setup_depth_to_space_nhwc_x16(
136           opdata->operator_objects[0],
137           opdata->batch_size,
138           opdata->input_height,
139           opdata->input_width,
140           input_data,
141           output_data,
142           threadpool);
143 #endif  // XNN_NO_F16_OPERATORS
144     case xnn_operator_type_depth_to_space_nhwc_x32:
145       return xnn_setup_depth_to_space_nhwc_x32(
146           opdata->operator_objects[0],
147           opdata->batch_size,
148           opdata->input_height,
149           opdata->input_width,
150           input_data,
151           output_data,
152           threadpool);
153 #if !defined(XNN_NO_S8_OPERATORS) && !defined(XNN_NO_U8_OPERATORS)
154     case xnn_operator_type_depth_to_space_nhwc_x8:
155       return xnn_setup_depth_to_space_nhwc_x8(
156           opdata->operator_objects[0],
157           opdata->batch_size,
158           opdata->input_height,
159           opdata->input_width,
160           input_data,
161           output_data,
162           threadpool);
163 #endif  // !defined(XNN_NO_S8_OPERATORS) && !defined(XNN_NO_U8_OPERATORS)
164     default:
165       XNN_UNREACHABLE;
166   }
167 }
168 
xnn_define_depth_to_space(xnn_subgraph_t subgraph,uint32_t input_id,uint32_t output_id,uint32_t block_size,uint32_t flags)169 enum xnn_status xnn_define_depth_to_space(
170   xnn_subgraph_t subgraph,
171   uint32_t input_id,
172   uint32_t output_id,
173   uint32_t block_size,
174   uint32_t flags)
175 {
176   enum xnn_status status;
177   if ((status = xnn_subgraph_check_xnnpack_initialized(xnn_node_type_depth_to_space)) != xnn_status_success) {
178     return status;
179   }
180 
181   if ((status = xnn_subgraph_check_input_node_id(xnn_node_type_depth_to_space, input_id, subgraph->num_values)) !=
182       xnn_status_success) {
183     return status;
184   }
185 
186   const struct xnn_value* input_value = &subgraph->values[input_id];
187   status = xnn_subgraph_check_input_type_dense(xnn_node_type_depth_to_space, input_id, input_value);
188   if (status != xnn_status_success) {
189     return status;
190   }
191 
192   switch (input_value->datatype) {
193     case xnn_datatype_fp32:
194 #ifndef XNN_NO_QS8_OPERATORS
195     case xnn_datatype_qint8:
196 #endif  // !defined(XNN_NO_QS8_OPERATORS)
197 #ifndef XNN_NO_QU8_OPERATORS
198     case xnn_datatype_quint8:
199 #endif  // !defined(XNN_NO_QU8_OPERATORS)
200       break;
201     default:
202       xnn_log_error(
203         "failed to define %s operator with input ID #%" PRIu32 ": unsupported Value datatype %s (%d)",
204         xnn_node_type_to_string(xnn_node_type_depth_to_space), input_id,
205         xnn_datatype_to_string(input_value->datatype), input_value->datatype);
206       return xnn_status_invalid_parameter;
207   }
208 
209   status = xnn_subgraph_check_output_node_id(xnn_node_type_depth_to_space, output_id, subgraph->num_values);
210   if (status != xnn_status_success) {
211     return status;
212   }
213 
214   const struct xnn_value* output_value = &subgraph->values[output_id];
215   status = xnn_subgraph_check_output_type_dense(xnn_node_type_depth_to_space, output_id, output_value);
216   if (status != xnn_status_success) {
217     return status;
218   }
219 
220   enum xnn_compute_type compute_type = xnn_compute_type_invalid;
221   switch (output_value->datatype) {
222     case xnn_datatype_fp32:
223       compute_type = xnn_compute_type_fp32;
224       break;
225 #ifndef XNN_NO_QS8_OPERATORS
226     case xnn_datatype_qint8:
227       compute_type = xnn_compute_type_qs8;
228       break;
229 #endif  // !defined(XNN_NO_QS8_OPERATORS)
230 #ifndef XNN_NO_QU8_OPERATORS
231     case xnn_datatype_quint8:
232       compute_type = xnn_compute_type_qu8;
233       break;
234 #endif  // !defined(XNN_NO_QU8_OPERATORS)
235     default:
236       xnn_log_error(
237         "failed to define %s operator with output ID #%" PRIu32 ": unsupported Value datatype %s (%d)",
238         xnn_node_type_to_string(xnn_node_type_depth_to_space), output_id,
239         xnn_datatype_to_string(output_value->datatype), output_value->datatype);
240       return xnn_status_invalid_parameter;
241   }
242   assert(compute_type != xnn_compute_type_invalid);
243 
244   status = xnn_subgraph_check_datatype_matches(
245     xnn_node_type_depth_to_space, input_id, input_value, output_id, output_value);
246   if (status != xnn_status_success) {
247     return status;
248   }
249 
250 #if !defined(XNN_NO_QU8_OPERATORS) || !defined(XNN_NO_QS8_OPERATORS)
251   if (compute_type == xnn_datatype_qint8 || compute_type == xnn_datatype_quint8) {
252     if (input_value->quantization.zero_point != output_value->quantization.zero_point) {
253       xnn_log_error(
254         "failed to define %s operator with input ID #%" PRIu32 " and output ID #%" PRIu32
255         ": mismatching zero point quantization parameter across input (%"PRId32") and output (%"PRId32")",
256         xnn_node_type_to_string(xnn_node_type_depth_to_space), input_id, output_id,
257         input_value->quantization.zero_point, output_value->quantization.zero_point);
258       return xnn_status_invalid_parameter;
259     }
260     if (input_value->quantization.scale != output_value->quantization.scale) {
261       xnn_log_error(
262         "failed to define %s operator with input ID #%" PRIu32 " and output ID #%" PRIu32
263         ": mismatching zero point quantization parameter across input (%.7g) and output (%.7g)",
264         xnn_node_type_to_string(xnn_node_type_depth_to_space), input_id, output_id,
265         input_value->quantization.scale, output_value->quantization.scale);
266       return xnn_status_invalid_parameter;
267     }
268   }
269 #endif  // !defined(XNN_NO_QU8_OPERATORS) || !defined(XNN_NO_QS8_OPERATORS)
270 
271   if (block_size < 2) {
272     xnn_log_error(
273       "failed to define %s operator with block size #%" PRIu32 ": invalid block_size",
274       xnn_node_type_to_string(xnn_node_type_depth_to_space), block_size);
275     return xnn_status_invalid_parameter;
276   }
277 
278   struct xnn_node* node = xnn_subgraph_new_node(subgraph);
279   if (node == NULL) {
280     return xnn_status_out_of_memory;
281   }
282 
283   node->type = xnn_node_type_depth_to_space;
284   node->compute_type = compute_type;
285   node->num_inputs = 1;
286   node->inputs[0] = input_id;
287   node->num_outputs = 1;
288   node->outputs[0] = output_id;
289   node->params.depth_to_space.block_size = block_size;
290   node->flags = flags;
291 
292   node->create = create_depth_to_space_operator;
293   node->setup = setup_depth_to_space_operator;
294 
295   return xnn_status_success;
296 }
297