1 /* SPDX-License-Identifier: BSD-3-Clause 2 * Copyright 2016 6WIND S.A. 3 * Copyright 2016 Mellanox Technologies, Ltd 4 */ 5 6 #ifndef RTE_FLOW_DRIVER_H_ 7 #define RTE_FLOW_DRIVER_H_ 8 9 /** 10 * @file 11 * RTE generic flow API (driver side) 12 * 13 * This file provides implementation helpers for internal use by PMDs, they 14 * are not intended to be exposed to applications and are not subject to ABI 15 * versioning. 16 */ 17 18 #include <stdint.h> 19 20 #include "rte_ethdev.h" 21 #include "ethdev_driver.h" 22 #include "rte_flow.h" 23 24 #ifdef __cplusplus 25 extern "C" { 26 #endif 27 28 /** 29 * Generic flow operations structure implemented and returned by PMDs. 30 * 31 * These callback functions are not supposed to be used by applications 32 * directly, which must rely on the API defined in rte_flow.h. 33 * 34 * Public-facing wrapper functions perform a few consistency checks so that 35 * unimplemented (i.e. NULL) callbacks simply return -ENOTSUP. These 36 * callbacks otherwise only differ by their first argument (with port ID 37 * already resolved to a pointer to struct rte_eth_dev). 38 */ 39 struct rte_flow_ops { 40 /** See rte_flow_validate(). */ 41 int (*validate) 42 (struct rte_eth_dev *, 43 const struct rte_flow_attr *, 44 const struct rte_flow_item [], 45 const struct rte_flow_action [], 46 struct rte_flow_error *); 47 /** See rte_flow_create(). */ 48 struct rte_flow *(*create) 49 (struct rte_eth_dev *, 50 const struct rte_flow_attr *, 51 const struct rte_flow_item [], 52 const struct rte_flow_action [], 53 struct rte_flow_error *); 54 /** See rte_flow_destroy(). */ 55 int (*destroy) 56 (struct rte_eth_dev *, 57 struct rte_flow *, 58 struct rte_flow_error *); 59 /** See rte_flow_flush(). */ 60 int (*flush) 61 (struct rte_eth_dev *, 62 struct rte_flow_error *); 63 /** See rte_flow_query(). */ 64 int (*query) 65 (struct rte_eth_dev *, 66 struct rte_flow *, 67 const struct rte_flow_action *, 68 void *, 69 struct rte_flow_error *); 70 /** See rte_flow_isolate(). */ 71 int (*isolate) 72 (struct rte_eth_dev *, 73 int, 74 struct rte_flow_error *); 75 /** See rte_flow_dev_dump(). */ 76 int (*dev_dump) 77 (struct rte_eth_dev *dev, 78 struct rte_flow *flow, 79 FILE *file, 80 struct rte_flow_error *error); 81 /** See rte_flow_get_aged_flows() */ 82 int (*get_aged_flows) 83 (struct rte_eth_dev *dev, 84 void **context, 85 uint32_t nb_contexts, 86 struct rte_flow_error *err); 87 /** See rte_flow_get_q_aged_flows() */ 88 int (*get_q_aged_flows) 89 (struct rte_eth_dev *dev, 90 uint32_t queue_id, 91 void **contexts, 92 uint32_t nb_contexts, 93 struct rte_flow_error *error); 94 /** See rte_flow_action_handle_create() */ 95 struct rte_flow_action_handle *(*action_handle_create) 96 (struct rte_eth_dev *dev, 97 const struct rte_flow_indir_action_conf *conf, 98 const struct rte_flow_action *action, 99 struct rte_flow_error *error); 100 /** See rte_flow_action_handle_destroy() */ 101 int (*action_handle_destroy) 102 (struct rte_eth_dev *dev, 103 struct rte_flow_action_handle *handle, 104 struct rte_flow_error *error); 105 /** See rte_flow_action_handle_update() */ 106 int (*action_handle_update) 107 (struct rte_eth_dev *dev, 108 struct rte_flow_action_handle *handle, 109 const void *update, 110 struct rte_flow_error *error); 111 /** See rte_flow_action_handle_query() */ 112 int (*action_handle_query) 113 (struct rte_eth_dev *dev, 114 const struct rte_flow_action_handle *handle, 115 void *data, 116 struct rte_flow_error *error); 117 /** See rte_flow_action_handle_query_update() */ 118 int (*action_handle_query_update) 119 (struct rte_eth_dev *dev, 120 struct rte_flow_action_handle *handle, 121 const void *update, void *query, 122 enum rte_flow_query_update_mode qu_mode, 123 struct rte_flow_error *error); 124 /** @see rte_flow_action_list_handle_create() */ 125 struct rte_flow_action_list_handle *(*action_list_handle_create) 126 (struct rte_eth_dev *dev, 127 const struct rte_flow_indir_action_conf *conf, 128 const struct rte_flow_action actions[], 129 struct rte_flow_error *error); 130 /** @see rte_flow_action_list_handle_destroy() */ 131 int (*action_list_handle_destroy) 132 (struct rte_eth_dev *dev, 133 struct rte_flow_action_list_handle *handle, 134 struct rte_flow_error *error); 135 /** See rte_flow_tunnel_decap_set() */ 136 int (*tunnel_decap_set) 137 (struct rte_eth_dev *dev, 138 struct rte_flow_tunnel *tunnel, 139 struct rte_flow_action **pmd_actions, 140 uint32_t *num_of_actions, 141 struct rte_flow_error *err); 142 /** See rte_flow_tunnel_match() */ 143 int (*tunnel_match) 144 (struct rte_eth_dev *dev, 145 struct rte_flow_tunnel *tunnel, 146 struct rte_flow_item **pmd_items, 147 uint32_t *num_of_items, 148 struct rte_flow_error *err); 149 /** See rte_flow_get_rte_flow_restore_info() */ 150 int (*get_restore_info) 151 (struct rte_eth_dev *dev, 152 struct rte_mbuf *m, 153 struct rte_flow_restore_info *info, 154 struct rte_flow_error *err); 155 /** See rte_flow_action_tunnel_decap_release() */ 156 int (*tunnel_action_decap_release) 157 (struct rte_eth_dev *dev, 158 struct rte_flow_action *pmd_actions, 159 uint32_t num_of_actions, 160 struct rte_flow_error *err); 161 /** See rte_flow_item_release() */ 162 int (*tunnel_item_release) 163 (struct rte_eth_dev *dev, 164 struct rte_flow_item *pmd_items, 165 uint32_t num_of_items, 166 struct rte_flow_error *err); 167 /** See rte_flow_pick_transfer_proxy() */ 168 int (*pick_transfer_proxy) 169 (struct rte_eth_dev *dev, 170 uint16_t *proxy_port_id, 171 struct rte_flow_error *error); 172 struct rte_flow_item_flex_handle *(*flex_item_create) 173 (struct rte_eth_dev *dev, 174 const struct rte_flow_item_flex_conf *conf, 175 struct rte_flow_error *error); 176 int (*flex_item_release) 177 (struct rte_eth_dev *dev, 178 const struct rte_flow_item_flex_handle *handle, 179 struct rte_flow_error *error); 180 /** See rte_flow_info_get() */ 181 int (*info_get) 182 (struct rte_eth_dev *dev, 183 struct rte_flow_port_info *port_info, 184 struct rte_flow_queue_info *queue_info, 185 struct rte_flow_error *err); 186 /** See rte_flow_configure() */ 187 int (*configure) 188 (struct rte_eth_dev *dev, 189 const struct rte_flow_port_attr *port_attr, 190 uint16_t nb_queue, 191 const struct rte_flow_queue_attr *queue_attr[], 192 struct rte_flow_error *err); 193 /** See rte_flow_pattern_template_create() */ 194 struct rte_flow_pattern_template *(*pattern_template_create) 195 (struct rte_eth_dev *dev, 196 const struct rte_flow_pattern_template_attr *template_attr, 197 const struct rte_flow_item pattern[], 198 struct rte_flow_error *err); 199 /** See rte_flow_pattern_template_destroy() */ 200 int (*pattern_template_destroy) 201 (struct rte_eth_dev *dev, 202 struct rte_flow_pattern_template *pattern_template, 203 struct rte_flow_error *err); 204 /** See rte_flow_actions_template_create() */ 205 struct rte_flow_actions_template *(*actions_template_create) 206 (struct rte_eth_dev *dev, 207 const struct rte_flow_actions_template_attr *template_attr, 208 const struct rte_flow_action actions[], 209 const struct rte_flow_action masks[], 210 struct rte_flow_error *err); 211 /** See rte_flow_actions_template_destroy() */ 212 int (*actions_template_destroy) 213 (struct rte_eth_dev *dev, 214 struct rte_flow_actions_template *actions_template, 215 struct rte_flow_error *err); 216 /** See rte_flow_template_table_create() */ 217 struct rte_flow_template_table *(*template_table_create) 218 (struct rte_eth_dev *dev, 219 const struct rte_flow_template_table_attr *table_attr, 220 struct rte_flow_pattern_template *pattern_templates[], 221 uint8_t nb_pattern_templates, 222 struct rte_flow_actions_template *actions_templates[], 223 uint8_t nb_actions_templates, 224 struct rte_flow_error *err); 225 /** See rte_flow_template_table_destroy() */ 226 int (*template_table_destroy) 227 (struct rte_eth_dev *dev, 228 struct rte_flow_template_table *template_table, 229 struct rte_flow_error *err); 230 /** See rte_flow_group_set_miss_actions() */ 231 int (*group_set_miss_actions) 232 (struct rte_eth_dev *dev, 233 uint32_t group_id, 234 const struct rte_flow_group_attr *attr, 235 const struct rte_flow_action actions[], 236 struct rte_flow_error *err); 237 /** See rte_flow_actions_update(). */ 238 int (*actions_update) 239 (struct rte_eth_dev *dev, 240 struct rte_flow *flow, 241 const struct rte_flow_action actions[], 242 struct rte_flow_error *error); 243 /** @see rte_flow_action_list_handle_query_update() */ 244 int (*action_list_handle_query_update) 245 (struct rte_eth_dev *dev, 246 const struct rte_flow_action_list_handle *handle, 247 const void **update, void **query, 248 enum rte_flow_query_update_mode mode, 249 struct rte_flow_error *error); 250 /** @see rte_flow_calc_table_hash() */ 251 int (*flow_calc_table_hash) 252 (struct rte_eth_dev *dev, const struct rte_flow_template_table *table, 253 const struct rte_flow_item pattern[], uint8_t pattern_template_index, 254 uint32_t *hash, struct rte_flow_error *error); 255 /** @see rte_flow_calc_encap_hash() */ 256 int (*flow_calc_encap_hash) 257 (struct rte_eth_dev *dev, const struct rte_flow_item pattern[], 258 enum rte_flow_encap_hash_field dest_field, uint8_t *hash, 259 struct rte_flow_error *error); 260 /** @see rte_flow_template_table_resize() */ 261 int (*flow_template_table_resize)(struct rte_eth_dev *dev, 262 struct rte_flow_template_table *table, 263 uint32_t nb_rules, 264 struct rte_flow_error *error); 265 /** @see rte_flow_async_update_resized() */ 266 int (*flow_update_resized)(struct rte_eth_dev *dev, uint32_t queue, 267 const struct rte_flow_op_attr *attr, 268 struct rte_flow *rule, void *user_data, 269 struct rte_flow_error *error); 270 /** @see rte_flow_template_table_resize_complete() */ 271 int (*flow_template_table_resize_complete) 272 (struct rte_eth_dev *dev, 273 struct rte_flow_template_table *table, 274 struct rte_flow_error *error); 275 }; 276 277 /** 278 * Get generic flow operations structure from a port. 279 * 280 * @param port_id 281 * Port identifier to query. 282 * @param[out] error 283 * Pointer to flow error structure. 284 * 285 * @return 286 * The flow operations structure associated with port_id, NULL in case of 287 * error, in which case rte_errno is set and the error structure contains 288 * additional details. 289 */ 290 const struct rte_flow_ops * 291 rte_flow_ops_get(uint16_t port_id, struct rte_flow_error *error); 292 293 /** 294 * Register mbuf dynamic flag for rte_flow_get_restore_info. 295 */ 296 int 297 rte_flow_restore_info_dynflag_register(void); 298 299 /** @internal Enqueue rule creation operation. */ 300 typedef struct rte_flow *(*rte_flow_async_create_t)(struct rte_eth_dev *dev, 301 uint32_t queue, 302 const struct rte_flow_op_attr *attr, 303 struct rte_flow_template_table *table, 304 const struct rte_flow_item *items, 305 uint8_t pattern_template_index, 306 const struct rte_flow_action *actions, 307 uint8_t action_template_index, 308 void *user_data, 309 struct rte_flow_error *error); 310 311 /** @internal Enqueue rule creation by index operation. */ 312 typedef struct rte_flow *(*rte_flow_async_create_by_index_t)(struct rte_eth_dev *dev, 313 uint32_t queue, 314 const struct rte_flow_op_attr *attr, 315 struct rte_flow_template_table *table, 316 uint32_t rule_index, 317 const struct rte_flow_action *actions, 318 uint8_t action_template_index, 319 void *user_data, 320 struct rte_flow_error *error); 321 322 /** @internal Enqueue rule update operation. */ 323 typedef int (*rte_flow_async_actions_update_t)(struct rte_eth_dev *dev, 324 uint32_t queue_id, 325 const struct rte_flow_op_attr *op_attr, 326 struct rte_flow *flow, 327 const struct rte_flow_action *actions, 328 uint8_t actions_template_index, 329 void *user_data, 330 struct rte_flow_error *error); 331 332 /** @internal Enqueue rule destruction operation. */ 333 typedef int (*rte_flow_async_destroy_t)(struct rte_eth_dev *dev, 334 uint32_t queue_id, 335 const struct rte_flow_op_attr *op_attr, 336 struct rte_flow *flow, 337 void *user_data, 338 struct rte_flow_error *error); 339 340 /** @internal Push all internally stored rules to the HW. */ 341 typedef int (*rte_flow_push_t)(struct rte_eth_dev *dev, 342 uint32_t queue_id, 343 struct rte_flow_error *error); 344 345 /** @internal Pull the flow rule operations results from the HW. */ 346 typedef int (*rte_flow_pull_t)(struct rte_eth_dev *dev, 347 uint32_t queue_id, 348 struct rte_flow_op_result *res, 349 uint16_t n_res, 350 struct rte_flow_error *error); 351 352 /** @internal Enqueue indirect action creation operation. */ 353 typedef struct rte_flow_action_handle *(*rte_flow_async_action_handle_create_t)( 354 struct rte_eth_dev *dev, 355 uint32_t queue_id, 356 const struct rte_flow_op_attr *op_attr, 357 const struct rte_flow_indir_action_conf *indir_action_conf, 358 const struct rte_flow_action *action, 359 void *user_data, 360 struct rte_flow_error *error); 361 362 /** @internal Enqueue indirect action destruction operation. */ 363 typedef int (*rte_flow_async_action_handle_destroy_t)(struct rte_eth_dev *dev, 364 uint32_t queue_id, 365 const struct rte_flow_op_attr *op_attr, 366 struct rte_flow_action_handle *action_handle, 367 void *user_data, 368 struct rte_flow_error *error); 369 370 /** @internal Enqueue indirect action update operation. */ 371 typedef int (*rte_flow_async_action_handle_update_t)(struct rte_eth_dev *dev, 372 uint32_t queue_id, 373 const struct rte_flow_op_attr *op_attr, 374 struct rte_flow_action_handle *action_handle, 375 const void *update, 376 void *user_data, 377 struct rte_flow_error *error); 378 379 /** @internal Enqueue indirect action query operation. */ 380 typedef int (*rte_flow_async_action_handle_query_t) 381 (struct rte_eth_dev *dev, 382 uint32_t queue_id, 383 const struct rte_flow_op_attr *op_attr, 384 const struct rte_flow_action_handle *action_handle, 385 void *data, 386 void *user_data, 387 struct rte_flow_error *error); 388 389 /** @internal Enqueue indirect action query and/or update operation. */ 390 typedef int (*rte_flow_async_action_handle_query_update_t)(struct rte_eth_dev *dev, 391 uint32_t queue_id, 392 const struct rte_flow_op_attr *attr, 393 struct rte_flow_action_handle *handle, 394 const void *update, void *query, 395 enum rte_flow_query_update_mode mode, 396 void *user_data, 397 struct rte_flow_error *error); 398 399 /** @internal Enqueue indirect action list creation operation. */ 400 typedef struct rte_flow_action_list_handle *(*rte_flow_async_action_list_handle_create_t)( 401 struct rte_eth_dev *dev, 402 uint32_t queue_id, 403 const struct rte_flow_op_attr *attr, 404 const struct rte_flow_indir_action_conf *conf, 405 const struct rte_flow_action *actions, 406 void *user_data, 407 struct rte_flow_error *error); 408 409 /** @internal Enqueue indirect action list destruction operation. */ 410 typedef int (*rte_flow_async_action_list_handle_destroy_t)( 411 struct rte_eth_dev *dev, 412 uint32_t queue_id, 413 const struct rte_flow_op_attr *op_attr, 414 struct rte_flow_action_list_handle *handle, 415 void *user_data, 416 struct rte_flow_error *error); 417 418 /** @internal Enqueue indirect action list query and/or update operation. */ 419 typedef int (*rte_flow_async_action_list_handle_query_update_t)( 420 struct rte_eth_dev *dev, 421 uint32_t queue_id, 422 const struct rte_flow_op_attr *attr, 423 const struct rte_flow_action_list_handle *handle, 424 const void **update, 425 void **query, 426 enum rte_flow_query_update_mode mode, 427 void *user_data, 428 struct rte_flow_error *error); 429 430 /** 431 * @internal 432 * 433 * Fast path async flow functions are held in a flat array, one entry per ethdev. 434 */ 435 struct rte_flow_fp_ops { 436 rte_flow_async_create_t async_create; 437 rte_flow_async_create_by_index_t async_create_by_index; 438 rte_flow_async_actions_update_t async_actions_update; 439 rte_flow_async_destroy_t async_destroy; 440 rte_flow_push_t push; 441 rte_flow_pull_t pull; 442 rte_flow_async_action_handle_create_t async_action_handle_create; 443 rte_flow_async_action_handle_destroy_t async_action_handle_destroy; 444 rte_flow_async_action_handle_update_t async_action_handle_update; 445 rte_flow_async_action_handle_query_t async_action_handle_query; 446 rte_flow_async_action_handle_query_update_t async_action_handle_query_update; 447 rte_flow_async_action_list_handle_create_t async_action_list_handle_create; 448 rte_flow_async_action_list_handle_destroy_t async_action_list_handle_destroy; 449 rte_flow_async_action_list_handle_query_update_t async_action_list_handle_query_update; 450 } __rte_cache_aligned; 451 452 /** 453 * @internal 454 * Default implementation of fast path flow API functions. 455 */ 456 extern struct rte_flow_fp_ops rte_flow_fp_default_ops; 457 458 #ifdef __cplusplus 459 } 460 #endif 461 462 #endif /* RTE_FLOW_DRIVER_H_ */ 463