Marat Dukhan | 1d75a54 | 2020-02-03 12:23:01 -0800 | [diff] [blame] | 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 | #pragma once |
| 7 | |
| 8 | #include <stddef.h> |
| 9 | #include <stdint.h> |
| 10 | |
| 11 | #include <xnnpack.h> |
| 12 | |
| 13 | #define XNN_MAX_INPUTS 3 |
Marat Dukhan | 5cb16e7 | 2020-05-05 16:41:57 -0700 | [diff] [blame] | 14 | #define XNN_MAX_OUTPUTS 2 |
Marat Dukhan | 1d75a54 | 2020-02-03 12:23:01 -0800 | [diff] [blame] | 15 | |
| 16 | #define XNN_MAX_RUNTIME_INPUTS 2 |
Marat Dukhan | 5cb16e7 | 2020-05-05 16:41:57 -0700 | [diff] [blame] | 17 | #define XNN_MAX_RUNTIME_OUTPUTS 2 |
Marat Dukhan | 1d75a54 | 2020-02-03 12:23:01 -0800 | [diff] [blame] | 18 | |
Marat Dukhan | 1f19872 | 2020-05-24 14:07:03 -0700 | [diff] [blame] | 19 | #define XNN_INVALID_NODE_ID UINT32_MAX |
| 20 | |
XNNPACK Team | ab8c4c8 | 2020-10-09 08:05:51 -0700 | [diff] [blame] | 21 | #ifdef __cplusplus |
| 22 | extern "C" { |
| 23 | #endif |
| 24 | |
Marat Dukhan | 1d75a54 | 2020-02-03 12:23:01 -0800 | [diff] [blame] | 25 | struct xnn_shape { |
| 26 | size_t num_dims; |
| 27 | size_t dim[XNN_MAX_TENSOR_DIMS]; |
| 28 | }; |
| 29 | |
| 30 | enum xnn_value_type { |
| 31 | xnn_value_type_invalid = 0, |
| 32 | xnn_value_type_dense_tensor = 1, |
| 33 | }; |
| 34 | |
Marat Dukhan | 9de90e0 | 2020-06-18 16:04:12 -0700 | [diff] [blame] | 35 | enum xnn_layout_type { |
| 36 | xnn_layout_type_nhwc = 0, |
| 37 | xnn_layout_type_nchw = 1, |
| 38 | }; |
| 39 | |
Marat Dukhan | 1d75a54 | 2020-02-03 12:23:01 -0800 | [diff] [blame] | 40 | /// Abstraction for a collections of elements produced and consumed by nodes. |
| 41 | struct xnn_value { |
| 42 | /// Unique ID for the value. |
| 43 | uint32_t id; |
| 44 | /// Type of the collection of elements. |
| 45 | /// |
| 46 | /// Currently only dense tensors are supported. |
| 47 | /// Other types (e.g. sparse tensors) might be supported in the future. |
| 48 | enum xnn_value_type type; |
| 49 | /// Type of elements in the collection. |
| 50 | enum xnn_datatype datatype; |
| 51 | /// Tensor shape. |
| 52 | struct xnn_shape shape; |
| 53 | /// Binary features of the tensor. Supported values are any combination of: |
| 54 | /// - XNN_VALUE_FLAG_EXTERNAL_INPUT |
| 55 | /// - XNN_VALUE_FLAG_EXTERNAL_OUTPUT |
| 56 | uint32_t flags; |
| 57 | /// Static initialization data. Must be null for non-static values. |
| 58 | const void* data; |
Marat Dukhan | 1f19872 | 2020-05-24 14:07:03 -0700 | [diff] [blame] | 59 | /// Index of the Subgraph node that produced the value, or XNN_INVALID_NODE_ID is the Value is an external input. |
| 60 | uint32_t producer; |
| 61 | /// Index of the first Node that consume the value, or XNN_INVALID_NODE_ID if the Value has no consumers within the |
| 62 | /// graph (e.g. Value is an external output). |
| 63 | uint32_t first_consumer; |
| 64 | /// Number of Nodes that consume the value. |
| 65 | /// If multiple inputs in a Node refer to this Value as input, the Node is counted as consumer multiple times. |
| 66 | /// If the Value is an external output, it counts as having an extra consumer. |
| 67 | uint32_t num_consumers; |
Marat Dukhan | 9de90e0 | 2020-06-18 16:04:12 -0700 | [diff] [blame] | 68 | uint32_t num_nchw_compatible_consumers; |
| 69 | enum xnn_layout_type layout; |
Marat Dukhan | 1d75a54 | 2020-02-03 12:23:01 -0800 | [diff] [blame] | 70 | }; |
| 71 | |
| 72 | struct xnn_blob { |
| 73 | /// Size in bytes. |
| 74 | size_t size; |
| 75 | /// Data pointer. |
| 76 | void* data; |
| 77 | bool external; |
| 78 | }; |
| 79 | |
| 80 | enum xnn_node_type { |
| 81 | xnn_node_type_invalid = 0, |
Marat Dukhan | 5fab409 | 2020-06-10 01:28:28 -0700 | [diff] [blame] | 82 | xnn_node_type_abs, |
Marat Dukhan | 54dcb46 | 2020-02-10 11:06:12 -0800 | [diff] [blame] | 83 | xnn_node_type_add2, |
Marat Dukhan | 5cb16e7 | 2020-05-05 16:41:57 -0700 | [diff] [blame] | 84 | xnn_node_type_argmax_pooling_2d, |
Marat Dukhan | 21d3bd6 | 2020-02-29 00:39:39 -0800 | [diff] [blame] | 85 | xnn_node_type_average_pooling_2d, |
Marat Dukhan | 5fab409 | 2020-06-10 01:28:28 -0700 | [diff] [blame] | 86 | xnn_node_type_bankers_rounding, |
| 87 | xnn_node_type_ceiling, |
Marat Dukhan | 52bd86f | 2020-02-11 18:21:51 -0800 | [diff] [blame] | 88 | xnn_node_type_clamp, |
Marat Dukhan | 1d75a54 | 2020-02-03 12:23:01 -0800 | [diff] [blame] | 89 | xnn_node_type_convolution_2d, |
Marat Dukhan | f587084 | 2020-04-27 18:19:54 -0700 | [diff] [blame] | 90 | xnn_node_type_deconvolution_2d, |
Marat Dukhan | 1d75a54 | 2020-02-03 12:23:01 -0800 | [diff] [blame] | 91 | xnn_node_type_depthwise_convolution_2d, |
Marat Dukhan | 9d3a459 | 2020-06-05 16:52:42 -0700 | [diff] [blame] | 92 | xnn_node_type_divide, |
Marat Dukhan | 38c07ec | 2020-04-23 16:44:32 -0700 | [diff] [blame] | 93 | xnn_node_type_fully_connected, |
Marat Dukhan | 5fab409 | 2020-06-10 01:28:28 -0700 | [diff] [blame] | 94 | xnn_node_type_floor, |
Marat Dukhan | a059b7d | 2020-06-11 11:41:27 -0700 | [diff] [blame] | 95 | xnn_node_type_global_average_pooling_2d, |
Marat Dukhan | 52bd86f | 2020-02-11 18:21:51 -0800 | [diff] [blame] | 96 | xnn_node_type_hardswish, |
Marat Dukhan | 5bbebac | 2020-06-10 19:42:15 -0700 | [diff] [blame] | 97 | xnn_node_type_leaky_relu, |
Marat Dukhan | 21d3bd6 | 2020-02-29 00:39:39 -0800 | [diff] [blame] | 98 | xnn_node_type_max_pooling_2d, |
Marat Dukhan | 9d3a459 | 2020-06-05 16:52:42 -0700 | [diff] [blame] | 99 | xnn_node_type_maximum2, |
| 100 | xnn_node_type_minimum2, |
| 101 | xnn_node_type_multiply2, |
Marat Dukhan | 5fab409 | 2020-06-10 01:28:28 -0700 | [diff] [blame] | 102 | xnn_node_type_negate, |
Marat Dukhan | 2fd2ba1 | 2020-02-10 13:14:45 -0800 | [diff] [blame] | 103 | xnn_node_type_prelu, |
Marat Dukhan | 52bd86f | 2020-02-11 18:21:51 -0800 | [diff] [blame] | 104 | xnn_node_type_sigmoid, |
| 105 | xnn_node_type_softmax, |
Marat Dukhan | aff24e2 | 2020-07-23 01:43:58 -0700 | [diff] [blame] | 106 | xnn_node_type_static_constant_pad, |
Marat Dukhan | d27202d | 2020-07-09 23:43:40 -0700 | [diff] [blame] | 107 | xnn_node_type_static_reshape, |
Marat Dukhan | aff24e2 | 2020-07-23 01:43:58 -0700 | [diff] [blame] | 108 | xnn_node_type_static_resize_bilinear_2d, |
Marat Dukhan | 5fab409 | 2020-06-10 01:28:28 -0700 | [diff] [blame] | 109 | xnn_node_type_square, |
Marat Dukhan | 51a01c6 | 2020-07-09 03:26:57 -0700 | [diff] [blame] | 110 | xnn_node_type_square_root, |
Marat Dukhan | 9d3a459 | 2020-06-05 16:52:42 -0700 | [diff] [blame] | 111 | xnn_node_type_squared_difference, |
| 112 | xnn_node_type_subtract, |
Marat Dukhan | 5cb16e7 | 2020-05-05 16:41:57 -0700 | [diff] [blame] | 113 | xnn_node_type_unpooling_2d, |
Marat Dukhan | 1d75a54 | 2020-02-03 12:23:01 -0800 | [diff] [blame] | 114 | }; |
| 115 | |
| 116 | struct xnn_node { |
| 117 | enum xnn_node_type type; |
| 118 | uint32_t id; |
| 119 | /// Static parameters of the operator node. |
| 120 | union { |
| 121 | struct { |
| 122 | uint32_t input_padding_top; |
| 123 | uint32_t input_padding_right; |
| 124 | uint32_t input_padding_bottom; |
| 125 | uint32_t input_padding_left; |
| 126 | uint32_t kernel_height; |
| 127 | uint32_t kernel_width; |
| 128 | uint32_t subsampling_height; |
| 129 | uint32_t subsampling_width; |
| 130 | uint32_t dilation_height; |
| 131 | uint32_t dilation_width; |
| 132 | uint32_t groups; |
| 133 | size_t group_input_channels; |
| 134 | size_t group_output_channels; |
Marat Dukhan | 1d75a54 | 2020-02-03 12:23:01 -0800 | [diff] [blame] | 135 | } convolution_2d; |
| 136 | struct { |
Marat Dukhan | f587084 | 2020-04-27 18:19:54 -0700 | [diff] [blame] | 137 | uint32_t padding_top; |
| 138 | uint32_t padding_right; |
| 139 | uint32_t padding_bottom; |
| 140 | uint32_t padding_left; |
| 141 | uint32_t adjustment_height; |
| 142 | uint32_t adjustment_width; |
| 143 | uint32_t kernel_height; |
| 144 | uint32_t kernel_width; |
| 145 | uint32_t upsampling_height; |
| 146 | uint32_t upsampling_width; |
| 147 | uint32_t dilation_height; |
| 148 | uint32_t dilation_width; |
| 149 | uint32_t groups; |
| 150 | size_t group_input_channels; |
| 151 | size_t group_output_channels; |
| 152 | } deconvolution_2d; |
| 153 | struct { |
Marat Dukhan | 1d75a54 | 2020-02-03 12:23:01 -0800 | [diff] [blame] | 154 | uint32_t input_padding_top; |
| 155 | uint32_t input_padding_right; |
| 156 | uint32_t input_padding_bottom; |
| 157 | uint32_t input_padding_left; |
| 158 | uint32_t kernel_height; |
| 159 | uint32_t kernel_width; |
| 160 | uint32_t subsampling_height; |
| 161 | uint32_t subsampling_width; |
| 162 | uint32_t dilation_height; |
| 163 | uint32_t dilation_width; |
| 164 | uint32_t depth_multiplier; |
| 165 | size_t input_channels; |
Marat Dukhan | 1d75a54 | 2020-02-03 12:23:01 -0800 | [diff] [blame] | 166 | } depthwise_convolution_2d; |
Marat Dukhan | 21d3bd6 | 2020-02-29 00:39:39 -0800 | [diff] [blame] | 167 | struct { |
Marat Dukhan | b389f35 | 2020-05-14 02:58:46 -0700 | [diff] [blame] | 168 | uint32_t padding_top; |
| 169 | uint32_t padding_right; |
| 170 | uint32_t padding_bottom; |
| 171 | uint32_t padding_left; |
Marat Dukhan | 21d3bd6 | 2020-02-29 00:39:39 -0800 | [diff] [blame] | 172 | uint32_t pooling_height; |
| 173 | uint32_t pooling_width; |
| 174 | uint32_t stride_height; |
| 175 | uint32_t stride_width; |
| 176 | uint32_t dilation_height; |
| 177 | uint32_t dilation_width; |
| 178 | } pooling_2d; |
Marat Dukhan | ab2946c | 2020-05-21 20:04:13 -0700 | [diff] [blame] | 179 | struct { |
Marat Dukhan | 5bbebac | 2020-06-10 19:42:15 -0700 | [diff] [blame] | 180 | float negative_slope; |
| 181 | } leaky_relu; |
| 182 | struct { |
Marat Dukhan | ab2946c | 2020-05-21 20:04:13 -0700 | [diff] [blame] | 183 | size_t pre_paddings[XNN_MAX_TENSOR_DIMS]; |
| 184 | size_t post_paddings[XNN_MAX_TENSOR_DIMS]; |
| 185 | uint32_t padding_value; |
| 186 | } static_pad; |
Marat Dukhan | d27202d | 2020-07-09 23:43:40 -0700 | [diff] [blame] | 187 | struct { |
| 188 | struct xnn_shape new_shape; |
| 189 | } static_reshape; |
Marat Dukhan | aff24e2 | 2020-07-23 01:43:58 -0700 | [diff] [blame] | 190 | struct { |
| 191 | size_t new_height; |
| 192 | size_t new_width; |
| 193 | } static_resize; |
Marat Dukhan | 1d75a54 | 2020-02-03 12:23:01 -0800 | [diff] [blame] | 194 | } params; |
Marat Dukhan | 54dcb46 | 2020-02-10 11:06:12 -0800 | [diff] [blame] | 195 | struct { |
| 196 | float output_min; |
| 197 | float output_max; |
| 198 | } activation; |
Marat Dukhan | 1d75a54 | 2020-02-03 12:23:01 -0800 | [diff] [blame] | 199 | /// Value IDs for node inputs. |
Marat Dukhan | 05b9830 | 2020-04-22 17:41:14 -0700 | [diff] [blame] | 200 | uint32_t inputs[XNN_MAX_INPUTS]; |
Marat Dukhan | 1d75a54 | 2020-02-03 12:23:01 -0800 | [diff] [blame] | 201 | uint32_t num_inputs; |
| 202 | /// Value IDs for node outputs. |
Chao Mei | 0dc8f47 | 2020-05-07 01:09:46 -0700 | [diff] [blame] | 203 | uint32_t outputs[XNN_MAX_OUTPUTS]; |
Marat Dukhan | 1d75a54 | 2020-02-03 12:23:01 -0800 | [diff] [blame] | 204 | uint32_t num_outputs; |
| 205 | uint32_t flags; |
Marat Dukhan | 9de90e0 | 2020-06-18 16:04:12 -0700 | [diff] [blame] | 206 | uint32_t layout_flags; |
| 207 | uint32_t cluster_leader; |
Marat Dukhan | 1d75a54 | 2020-02-03 12:23:01 -0800 | [diff] [blame] | 208 | }; |
| 209 | |
| 210 | struct xnn_operator_data { |
Marat Dukhan | 54cf510 | 2020-05-21 20:29:25 -0700 | [diff] [blame] | 211 | xnn_operator_t operator_object; |
Marat Dukhan | 1d75a54 | 2020-02-03 12:23:01 -0800 | [diff] [blame] | 212 | size_t batch_size; |
| 213 | size_t input_height; |
| 214 | size_t input_width; |
Marat Dukhan | aff24e2 | 2020-07-23 01:43:58 -0700 | [diff] [blame] | 215 | size_t output_height; |
| 216 | size_t output_width; |
Marat Dukhan | 54dcb46 | 2020-02-10 11:06:12 -0800 | [diff] [blame] | 217 | struct xnn_shape shape1; |
| 218 | struct xnn_shape shape2; |
Marat Dukhan | ab2946c | 2020-05-21 20:04:13 -0700 | [diff] [blame] | 219 | size_t pre_paddings[XNN_MAX_TENSOR_DIMS]; |
| 220 | size_t post_paddings[XNN_MAX_TENSOR_DIMS]; |
Marat Dukhan | f587084 | 2020-04-27 18:19:54 -0700 | [diff] [blame] | 221 | uint32_t adjustment_height; |
| 222 | uint32_t adjustment_width; |
Marat Dukhan | 1d75a54 | 2020-02-03 12:23:01 -0800 | [diff] [blame] | 223 | uint32_t inputs[XNN_MAX_RUNTIME_INPUTS]; |
| 224 | uint32_t outputs[XNN_MAX_RUNTIME_OUTPUTS]; |
| 225 | }; |
| 226 | |
| 227 | struct xnn_subgraph { |
| 228 | /// Number of Value IDs reserved for communication with external graph representation. |
| 229 | /// Values created during subgraph transformation avoid using IDs in [0, reserved_value_ids-1] range. |
| 230 | uint32_t external_value_ids; |
| 231 | |
| 232 | uint32_t num_reserved_values; |
| 233 | uint32_t num_values; |
| 234 | struct xnn_value* values; |
| 235 | |
| 236 | uint32_t num_reserved_nodes; |
| 237 | uint32_t num_nodes; |
| 238 | struct xnn_node* nodes; |
| 239 | }; |
| 240 | |
| 241 | /// Runtime is a combination of an execution plan for subgraph Nodes and a memory manager for subgraph Values. |
| 242 | struct xnn_runtime { |
| 243 | uint32_t num_external_values; |
| 244 | |
| 245 | /// List of operators in the execution plan, in execution order. |
Marat Dukhan | 54cf510 | 2020-05-21 20:29:25 -0700 | [diff] [blame] | 246 | struct xnn_operator_data* opdata; |
Marat Dukhan | 1d75a54 | 2020-02-03 12:23:01 -0800 | [diff] [blame] | 247 | /// Number of operators in the execution plan. |
| 248 | size_t num_ops; |
| 249 | |
| 250 | struct xnn_blob* blobs; |
| 251 | size_t num_blobs; |
| 252 | |
| 253 | void* workspace; |
Marat Dukhan | 022c659 | 2020-02-05 18:07:41 -0800 | [diff] [blame] | 254 | |
| 255 | pthreadpool_t threadpool; |
Marat Dukhan | 1d75a54 | 2020-02-03 12:23:01 -0800 | [diff] [blame] | 256 | }; |
| 257 | |
| 258 | struct xnn_value* xnn_subgraph_new_internal_value(xnn_subgraph_t subgraph); |
| 259 | |
| 260 | struct xnn_node* xnn_subgraph_new_node(xnn_subgraph_t subgraph); |
| 261 | |
| 262 | size_t xnn_tensor_get_size( |
| 263 | xnn_subgraph_t subgraph, |
| 264 | uint32_t value_id); |
Marat Dukhan | 1f19872 | 2020-05-24 14:07:03 -0700 | [diff] [blame] | 265 | |
| 266 | enum xnn_status xnn_subgraph_optimize(xnn_subgraph_t subgraph, uint32_t flags); |
| 267 | |
XNNPACK Team | ab8c4c8 | 2020-10-09 08:05:51 -0700 | [diff] [blame] | 268 | void xnn_subgraph_rewrite_for_nchw(xnn_subgraph_t subgraph); |
| 269 | |
Marat Dukhan | 1f19872 | 2020-05-24 14:07:03 -0700 | [diff] [blame] | 270 | void xnn_node_clear(struct xnn_node* node); |
| 271 | void xnn_value_clear(struct xnn_value* value); |
XNNPACK Team | ab8c4c8 | 2020-10-09 08:05:51 -0700 | [diff] [blame] | 272 | |
| 273 | |
| 274 | #ifdef __cplusplus |
| 275 | } // extern "C" |
| 276 | #endif |