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_tunnel_decap_set() */ 118 int (*tunnel_decap_set) 119 (struct rte_eth_dev *dev, 120 struct rte_flow_tunnel *tunnel, 121 struct rte_flow_action **pmd_actions, 122 uint32_t *num_of_actions, 123 struct rte_flow_error *err); 124 /** See rte_flow_tunnel_match() */ 125 int (*tunnel_match) 126 (struct rte_eth_dev *dev, 127 struct rte_flow_tunnel *tunnel, 128 struct rte_flow_item **pmd_items, 129 uint32_t *num_of_items, 130 struct rte_flow_error *err); 131 /** See rte_flow_get_rte_flow_restore_info() */ 132 int (*get_restore_info) 133 (struct rte_eth_dev *dev, 134 struct rte_mbuf *m, 135 struct rte_flow_restore_info *info, 136 struct rte_flow_error *err); 137 /** See rte_flow_action_tunnel_decap_release() */ 138 int (*tunnel_action_decap_release) 139 (struct rte_eth_dev *dev, 140 struct rte_flow_action *pmd_actions, 141 uint32_t num_of_actions, 142 struct rte_flow_error *err); 143 /** See rte_flow_item_release() */ 144 int (*tunnel_item_release) 145 (struct rte_eth_dev *dev, 146 struct rte_flow_item *pmd_items, 147 uint32_t num_of_items, 148 struct rte_flow_error *err); 149 /** See rte_flow_pick_transfer_proxy() */ 150 int (*pick_transfer_proxy) 151 (struct rte_eth_dev *dev, 152 uint16_t *proxy_port_id, 153 struct rte_flow_error *error); 154 struct rte_flow_item_flex_handle *(*flex_item_create) 155 (struct rte_eth_dev *dev, 156 const struct rte_flow_item_flex_conf *conf, 157 struct rte_flow_error *error); 158 int (*flex_item_release) 159 (struct rte_eth_dev *dev, 160 const struct rte_flow_item_flex_handle *handle, 161 struct rte_flow_error *error); 162 /** See rte_flow_info_get() */ 163 int (*info_get) 164 (struct rte_eth_dev *dev, 165 struct rte_flow_port_info *port_info, 166 struct rte_flow_queue_info *queue_info, 167 struct rte_flow_error *err); 168 /** See rte_flow_configure() */ 169 int (*configure) 170 (struct rte_eth_dev *dev, 171 const struct rte_flow_port_attr *port_attr, 172 uint16_t nb_queue, 173 const struct rte_flow_queue_attr *queue_attr[], 174 struct rte_flow_error *err); 175 /** See rte_flow_pattern_template_create() */ 176 struct rte_flow_pattern_template *(*pattern_template_create) 177 (struct rte_eth_dev *dev, 178 const struct rte_flow_pattern_template_attr *template_attr, 179 const struct rte_flow_item pattern[], 180 struct rte_flow_error *err); 181 /** See rte_flow_pattern_template_destroy() */ 182 int (*pattern_template_destroy) 183 (struct rte_eth_dev *dev, 184 struct rte_flow_pattern_template *pattern_template, 185 struct rte_flow_error *err); 186 /** See rte_flow_actions_template_create() */ 187 struct rte_flow_actions_template *(*actions_template_create) 188 (struct rte_eth_dev *dev, 189 const struct rte_flow_actions_template_attr *template_attr, 190 const struct rte_flow_action actions[], 191 const struct rte_flow_action masks[], 192 struct rte_flow_error *err); 193 /** See rte_flow_actions_template_destroy() */ 194 int (*actions_template_destroy) 195 (struct rte_eth_dev *dev, 196 struct rte_flow_actions_template *actions_template, 197 struct rte_flow_error *err); 198 /** See rte_flow_template_table_create() */ 199 struct rte_flow_template_table *(*template_table_create) 200 (struct rte_eth_dev *dev, 201 const struct rte_flow_template_table_attr *table_attr, 202 struct rte_flow_pattern_template *pattern_templates[], 203 uint8_t nb_pattern_templates, 204 struct rte_flow_actions_template *actions_templates[], 205 uint8_t nb_actions_templates, 206 struct rte_flow_error *err); 207 /** See rte_flow_template_table_destroy() */ 208 int (*template_table_destroy) 209 (struct rte_eth_dev *dev, 210 struct rte_flow_template_table *template_table, 211 struct rte_flow_error *err); 212 /** See rte_flow_async_create() */ 213 struct rte_flow *(*async_create) 214 (struct rte_eth_dev *dev, 215 uint32_t queue_id, 216 const struct rte_flow_op_attr *op_attr, 217 struct rte_flow_template_table *template_table, 218 const struct rte_flow_item pattern[], 219 uint8_t pattern_template_index, 220 const struct rte_flow_action actions[], 221 uint8_t actions_template_index, 222 void *user_data, 223 struct rte_flow_error *err); 224 /** See rte_flow_async_destroy() */ 225 int (*async_destroy) 226 (struct rte_eth_dev *dev, 227 uint32_t queue_id, 228 const struct rte_flow_op_attr *op_attr, 229 struct rte_flow *flow, 230 void *user_data, 231 struct rte_flow_error *err); 232 /** See rte_flow_push() */ 233 int (*push) 234 (struct rte_eth_dev *dev, 235 uint32_t queue_id, 236 struct rte_flow_error *err); 237 /** See rte_flow_pull() */ 238 int (*pull) 239 (struct rte_eth_dev *dev, 240 uint32_t queue_id, 241 struct rte_flow_op_result res[], 242 uint16_t n_res, 243 struct rte_flow_error *error); 244 /** See rte_flow_async_action_handle_create() */ 245 struct rte_flow_action_handle *(*async_action_handle_create) 246 (struct rte_eth_dev *dev, 247 uint32_t queue_id, 248 const struct rte_flow_op_attr *op_attr, 249 const struct rte_flow_indir_action_conf *indir_action_conf, 250 const struct rte_flow_action *action, 251 void *user_data, 252 struct rte_flow_error *err); 253 /** See rte_flow_async_action_handle_destroy() */ 254 int (*async_action_handle_destroy) 255 (struct rte_eth_dev *dev, 256 uint32_t queue_id, 257 const struct rte_flow_op_attr *op_attr, 258 struct rte_flow_action_handle *action_handle, 259 void *user_data, 260 struct rte_flow_error *error); 261 /** See rte_flow_async_action_handle_update() */ 262 int (*async_action_handle_update) 263 (struct rte_eth_dev *dev, 264 uint32_t queue_id, 265 const struct rte_flow_op_attr *op_attr, 266 struct rte_flow_action_handle *action_handle, 267 const void *update, 268 void *user_data, 269 struct rte_flow_error *error); 270 /** See rte_flow_async_action_handle_query() */ 271 int (*async_action_handle_query) 272 (struct rte_eth_dev *dev, 273 uint32_t queue_id, 274 const struct rte_flow_op_attr *op_attr, 275 const struct rte_flow_action_handle *action_handle, 276 void *data, 277 void *user_data, 278 struct rte_flow_error *error); 279 }; 280 281 /** 282 * Get generic flow operations structure from a port. 283 * 284 * @param port_id 285 * Port identifier to query. 286 * @param[out] error 287 * Pointer to flow error structure. 288 * 289 * @return 290 * The flow operations structure associated with port_id, NULL in case of 291 * error, in which case rte_errno is set and the error structure contains 292 * additional details. 293 */ 294 const struct rte_flow_ops * 295 rte_flow_ops_get(uint16_t port_id, struct rte_flow_error *error); 296 297 #ifdef __cplusplus 298 } 299 #endif 300 301 #endif /* RTE_FLOW_DRIVER_H_ */ 302