1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright 2018 Mellanox Technologies, Ltd
5 #ifndef RTE_PMD_MLX5_FLOW_H_
6 #define RTE_PMD_MLX5_FLOW_H_
8 #include <netinet/in.h>
15 /* ISO C doesn't support unnamed structs/unions, disabling -pedantic. */
17 #pragma GCC diagnostic ignored "-Wpedantic"
19 #include <infiniband/verbs.h>
21 #pragma GCC diagnostic error "-Wpedantic"
24 #include <rte_atomic.h>
25 #include <rte_alarm.h>
31 /* Private rte flow items. */
32 enum mlx5_rte_flow_item_type {
33 MLX5_RTE_FLOW_ITEM_TYPE_END = INT_MIN,
34 MLX5_RTE_FLOW_ITEM_TYPE_TAG,
35 MLX5_RTE_FLOW_ITEM_TYPE_TX_QUEUE,
38 /* Private (internal) rte flow actions. */
39 enum mlx5_rte_flow_action_type {
40 MLX5_RTE_FLOW_ACTION_TYPE_END = INT_MIN,
41 MLX5_RTE_FLOW_ACTION_TYPE_TAG,
42 MLX5_RTE_FLOW_ACTION_TYPE_MARK,
43 MLX5_RTE_FLOW_ACTION_TYPE_COPY_MREG,
46 /* Matches on selected register. */
47 struct mlx5_rte_flow_item_tag {
52 /* Modify selected register. */
53 struct mlx5_rte_flow_action_set_tag {
58 struct mlx5_flow_action_copy_mreg {
63 /* Matches on source queue. */
64 struct mlx5_rte_flow_item_tx_queue {
68 /* Feature name to allocate metadata register. */
69 enum mlx5_feature_name {
82 /* Pattern outer Layer bits. */
83 #define MLX5_FLOW_LAYER_OUTER_L2 (1u << 0)
84 #define MLX5_FLOW_LAYER_OUTER_L3_IPV4 (1u << 1)
85 #define MLX5_FLOW_LAYER_OUTER_L3_IPV6 (1u << 2)
86 #define MLX5_FLOW_LAYER_OUTER_L4_UDP (1u << 3)
87 #define MLX5_FLOW_LAYER_OUTER_L4_TCP (1u << 4)
88 #define MLX5_FLOW_LAYER_OUTER_VLAN (1u << 5)
90 /* Pattern inner Layer bits. */
91 #define MLX5_FLOW_LAYER_INNER_L2 (1u << 6)
92 #define MLX5_FLOW_LAYER_INNER_L3_IPV4 (1u << 7)
93 #define MLX5_FLOW_LAYER_INNER_L3_IPV6 (1u << 8)
94 #define MLX5_FLOW_LAYER_INNER_L4_UDP (1u << 9)
95 #define MLX5_FLOW_LAYER_INNER_L4_TCP (1u << 10)
96 #define MLX5_FLOW_LAYER_INNER_VLAN (1u << 11)
98 /* Pattern tunnel Layer bits. */
99 #define MLX5_FLOW_LAYER_VXLAN (1u << 12)
100 #define MLX5_FLOW_LAYER_VXLAN_GPE (1u << 13)
101 #define MLX5_FLOW_LAYER_GRE (1u << 14)
102 #define MLX5_FLOW_LAYER_MPLS (1u << 15)
103 /* List of tunnel Layer bits continued below. */
105 /* General pattern items bits. */
106 #define MLX5_FLOW_ITEM_METADATA (1u << 16)
107 #define MLX5_FLOW_ITEM_PORT_ID (1u << 17)
108 #define MLX5_FLOW_ITEM_TAG (1u << 18)
109 #define MLX5_FLOW_ITEM_MARK (1u << 19)
111 /* Pattern MISC bits. */
112 #define MLX5_FLOW_LAYER_ICMP (1u << 19)
113 #define MLX5_FLOW_LAYER_ICMP6 (1u << 20)
114 #define MLX5_FLOW_LAYER_GRE_KEY (1u << 21)
116 /* Pattern tunnel Layer bits (continued). */
117 #define MLX5_FLOW_LAYER_IPIP (1u << 21)
118 #define MLX5_FLOW_LAYER_IPV6_ENCAP (1u << 22)
119 #define MLX5_FLOW_LAYER_NVGRE (1u << 23)
120 #define MLX5_FLOW_LAYER_GENEVE (1u << 24)
123 #define MLX5_FLOW_ITEM_TX_QUEUE (1u << 25)
126 #define MLX5_FLOW_LAYER_OUTER_L3 \
127 (MLX5_FLOW_LAYER_OUTER_L3_IPV4 | MLX5_FLOW_LAYER_OUTER_L3_IPV6)
128 #define MLX5_FLOW_LAYER_OUTER_L4 \
129 (MLX5_FLOW_LAYER_OUTER_L4_UDP | MLX5_FLOW_LAYER_OUTER_L4_TCP)
130 #define MLX5_FLOW_LAYER_OUTER \
131 (MLX5_FLOW_LAYER_OUTER_L2 | MLX5_FLOW_LAYER_OUTER_L3 | \
132 MLX5_FLOW_LAYER_OUTER_L4)
134 /* LRO support mask, i.e. flow contains IPv4/IPv6 and TCP. */
135 #define MLX5_FLOW_LAYER_IPV4_LRO \
136 (MLX5_FLOW_LAYER_OUTER_L3_IPV4 | MLX5_FLOW_LAYER_OUTER_L4_TCP)
137 #define MLX5_FLOW_LAYER_IPV6_LRO \
138 (MLX5_FLOW_LAYER_OUTER_L3_IPV6 | MLX5_FLOW_LAYER_OUTER_L4_TCP)
141 #define MLX5_FLOW_LAYER_TUNNEL \
142 (MLX5_FLOW_LAYER_VXLAN | MLX5_FLOW_LAYER_VXLAN_GPE | \
143 MLX5_FLOW_LAYER_GRE | MLX5_FLOW_LAYER_NVGRE | MLX5_FLOW_LAYER_MPLS | \
144 MLX5_FLOW_LAYER_IPIP | MLX5_FLOW_LAYER_IPV6_ENCAP | \
145 MLX5_FLOW_LAYER_GENEVE)
148 #define MLX5_FLOW_LAYER_INNER_L3 \
149 (MLX5_FLOW_LAYER_INNER_L3_IPV4 | MLX5_FLOW_LAYER_INNER_L3_IPV6)
150 #define MLX5_FLOW_LAYER_INNER_L4 \
151 (MLX5_FLOW_LAYER_INNER_L4_UDP | MLX5_FLOW_LAYER_INNER_L4_TCP)
152 #define MLX5_FLOW_LAYER_INNER \
153 (MLX5_FLOW_LAYER_INNER_L2 | MLX5_FLOW_LAYER_INNER_L3 | \
154 MLX5_FLOW_LAYER_INNER_L4)
157 #define MLX5_FLOW_LAYER_L2 \
158 (MLX5_FLOW_LAYER_OUTER_L2 | MLX5_FLOW_LAYER_INNER_L2)
159 #define MLX5_FLOW_LAYER_L3_IPV4 \
160 (MLX5_FLOW_LAYER_OUTER_L3_IPV4 | MLX5_FLOW_LAYER_INNER_L3_IPV4)
161 #define MLX5_FLOW_LAYER_L3_IPV6 \
162 (MLX5_FLOW_LAYER_OUTER_L3_IPV6 | MLX5_FLOW_LAYER_INNER_L3_IPV6)
163 #define MLX5_FLOW_LAYER_L3 \
164 (MLX5_FLOW_LAYER_L3_IPV4 | MLX5_FLOW_LAYER_L3_IPV6)
165 #define MLX5_FLOW_LAYER_L4 \
166 (MLX5_FLOW_LAYER_OUTER_L4 | MLX5_FLOW_LAYER_INNER_L4)
169 #define MLX5_FLOW_ACTION_DROP (1u << 0)
170 #define MLX5_FLOW_ACTION_QUEUE (1u << 1)
171 #define MLX5_FLOW_ACTION_RSS (1u << 2)
172 #define MLX5_FLOW_ACTION_FLAG (1u << 3)
173 #define MLX5_FLOW_ACTION_MARK (1u << 4)
174 #define MLX5_FLOW_ACTION_COUNT (1u << 5)
175 #define MLX5_FLOW_ACTION_PORT_ID (1u << 6)
176 #define MLX5_FLOW_ACTION_OF_POP_VLAN (1u << 7)
177 #define MLX5_FLOW_ACTION_OF_PUSH_VLAN (1u << 8)
178 #define MLX5_FLOW_ACTION_OF_SET_VLAN_VID (1u << 9)
179 #define MLX5_FLOW_ACTION_OF_SET_VLAN_PCP (1u << 10)
180 #define MLX5_FLOW_ACTION_SET_IPV4_SRC (1u << 11)
181 #define MLX5_FLOW_ACTION_SET_IPV4_DST (1u << 12)
182 #define MLX5_FLOW_ACTION_SET_IPV6_SRC (1u << 13)
183 #define MLX5_FLOW_ACTION_SET_IPV6_DST (1u << 14)
184 #define MLX5_FLOW_ACTION_SET_TP_SRC (1u << 15)
185 #define MLX5_FLOW_ACTION_SET_TP_DST (1u << 16)
186 #define MLX5_FLOW_ACTION_JUMP (1u << 17)
187 #define MLX5_FLOW_ACTION_SET_TTL (1u << 18)
188 #define MLX5_FLOW_ACTION_DEC_TTL (1u << 19)
189 #define MLX5_FLOW_ACTION_SET_MAC_SRC (1u << 20)
190 #define MLX5_FLOW_ACTION_SET_MAC_DST (1u << 21)
191 #define MLX5_FLOW_ACTION_VXLAN_ENCAP (1u << 22)
192 #define MLX5_FLOW_ACTION_VXLAN_DECAP (1u << 23)
193 #define MLX5_FLOW_ACTION_NVGRE_ENCAP (1u << 24)
194 #define MLX5_FLOW_ACTION_NVGRE_DECAP (1u << 25)
195 #define MLX5_FLOW_ACTION_RAW_ENCAP (1u << 26)
196 #define MLX5_FLOW_ACTION_RAW_DECAP (1u << 27)
197 #define MLX5_FLOW_ACTION_INC_TCP_SEQ (1u << 28)
198 #define MLX5_FLOW_ACTION_DEC_TCP_SEQ (1u << 29)
199 #define MLX5_FLOW_ACTION_INC_TCP_ACK (1u << 30)
200 #define MLX5_FLOW_ACTION_DEC_TCP_ACK (1u << 31)
201 #define MLX5_FLOW_ACTION_SET_TAG (1ull << 32)
202 #define MLX5_FLOW_ACTION_MARK_EXT (1ull << 33)
203 #define MLX5_FLOW_ACTION_SET_META (1ull << 34)
205 #define MLX5_FLOW_FATE_ACTIONS \
206 (MLX5_FLOW_ACTION_DROP | MLX5_FLOW_ACTION_QUEUE | \
207 MLX5_FLOW_ACTION_RSS | MLX5_FLOW_ACTION_JUMP)
209 #define MLX5_FLOW_FATE_ESWITCH_ACTIONS \
210 (MLX5_FLOW_ACTION_DROP | MLX5_FLOW_ACTION_PORT_ID | \
211 MLX5_FLOW_ACTION_JUMP)
213 #define MLX5_FLOW_ENCAP_ACTIONS (MLX5_FLOW_ACTION_VXLAN_ENCAP | \
214 MLX5_FLOW_ACTION_NVGRE_ENCAP | \
215 MLX5_FLOW_ACTION_RAW_ENCAP | \
216 MLX5_FLOW_ACTION_OF_PUSH_VLAN)
218 #define MLX5_FLOW_DECAP_ACTIONS (MLX5_FLOW_ACTION_VXLAN_DECAP | \
219 MLX5_FLOW_ACTION_NVGRE_DECAP | \
220 MLX5_FLOW_ACTION_RAW_DECAP | \
221 MLX5_FLOW_ACTION_OF_POP_VLAN)
223 #define MLX5_FLOW_MODIFY_HDR_ACTIONS (MLX5_FLOW_ACTION_SET_IPV4_SRC | \
224 MLX5_FLOW_ACTION_SET_IPV4_DST | \
225 MLX5_FLOW_ACTION_SET_IPV6_SRC | \
226 MLX5_FLOW_ACTION_SET_IPV6_DST | \
227 MLX5_FLOW_ACTION_SET_TP_SRC | \
228 MLX5_FLOW_ACTION_SET_TP_DST | \
229 MLX5_FLOW_ACTION_SET_TTL | \
230 MLX5_FLOW_ACTION_DEC_TTL | \
231 MLX5_FLOW_ACTION_SET_MAC_SRC | \
232 MLX5_FLOW_ACTION_SET_MAC_DST | \
233 MLX5_FLOW_ACTION_INC_TCP_SEQ | \
234 MLX5_FLOW_ACTION_DEC_TCP_SEQ | \
235 MLX5_FLOW_ACTION_INC_TCP_ACK | \
236 MLX5_FLOW_ACTION_DEC_TCP_ACK | \
237 MLX5_FLOW_ACTION_OF_SET_VLAN_VID | \
238 MLX5_FLOW_ACTION_SET_TAG | \
239 MLX5_FLOW_ACTION_MARK_EXT | \
240 MLX5_FLOW_ACTION_SET_META)
242 #define MLX5_FLOW_VLAN_ACTIONS (MLX5_FLOW_ACTION_OF_POP_VLAN | \
243 MLX5_FLOW_ACTION_OF_PUSH_VLAN)
245 #define IPPROTO_MPLS 137
248 /* UDP port number for MPLS */
249 #define MLX5_UDP_PORT_MPLS 6635
251 /* UDP port numbers for VxLAN. */
252 #define MLX5_UDP_PORT_VXLAN 4789
253 #define MLX5_UDP_PORT_VXLAN_GPE 4790
255 /* UDP port numbers for GENEVE. */
256 #define MLX5_UDP_PORT_GENEVE 6081
258 /* Priority reserved for default flows. */
259 #define MLX5_FLOW_PRIO_RSVD ((uint32_t)-1)
262 * Number of sub priorities.
263 * For each kind of pattern matching i.e. L2, L3, L4 to have a correct
264 * matching on the NIC (firmware dependent) L4 most have the higher priority
265 * followed by L3 and ending with L2.
267 #define MLX5_PRIORITY_MAP_L2 2
268 #define MLX5_PRIORITY_MAP_L3 1
269 #define MLX5_PRIORITY_MAP_L4 0
270 #define MLX5_PRIORITY_MAP_MAX 3
272 /* Valid layer type for IPV4 RSS. */
273 #define MLX5_IPV4_LAYER_TYPES \
274 (ETH_RSS_IPV4 | ETH_RSS_FRAG_IPV4 | \
275 ETH_RSS_NONFRAG_IPV4_TCP | ETH_RSS_NONFRAG_IPV4_UDP | \
276 ETH_RSS_NONFRAG_IPV4_OTHER)
278 /* IBV hash source bits for IPV4. */
279 #define MLX5_IPV4_IBV_RX_HASH (IBV_RX_HASH_SRC_IPV4 | IBV_RX_HASH_DST_IPV4)
281 /* Valid layer type for IPV6 RSS. */
282 #define MLX5_IPV6_LAYER_TYPES \
283 (ETH_RSS_IPV6 | ETH_RSS_FRAG_IPV6 | ETH_RSS_NONFRAG_IPV6_TCP | \
284 ETH_RSS_NONFRAG_IPV6_UDP | ETH_RSS_IPV6_EX | ETH_RSS_IPV6_TCP_EX | \
285 ETH_RSS_IPV6_UDP_EX | ETH_RSS_NONFRAG_IPV6_OTHER)
287 /* IBV hash source bits for IPV6. */
288 #define MLX5_IPV6_IBV_RX_HASH (IBV_RX_HASH_SRC_IPV6 | IBV_RX_HASH_DST_IPV6)
291 /* Geneve header first 16Bit */
292 #define MLX5_GENEVE_VER_MASK 0x3
293 #define MLX5_GENEVE_VER_SHIFT 14
294 #define MLX5_GENEVE_VER_VAL(a) \
295 (((a) >> (MLX5_GENEVE_VER_SHIFT)) & (MLX5_GENEVE_VER_MASK))
296 #define MLX5_GENEVE_OPTLEN_MASK 0x3F
297 #define MLX5_GENEVE_OPTLEN_SHIFT 7
298 #define MLX5_GENEVE_OPTLEN_VAL(a) \
299 (((a) >> (MLX5_GENEVE_OPTLEN_SHIFT)) & (MLX5_GENEVE_OPTLEN_MASK))
300 #define MLX5_GENEVE_OAMF_MASK 0x1
301 #define MLX5_GENEVE_OAMF_SHIFT 7
302 #define MLX5_GENEVE_OAMF_VAL(a) \
303 (((a) >> (MLX5_GENEVE_OAMF_SHIFT)) & (MLX5_GENEVE_OAMF_MASK))
304 #define MLX5_GENEVE_CRITO_MASK 0x1
305 #define MLX5_GENEVE_CRITO_SHIFT 6
306 #define MLX5_GENEVE_CRITO_VAL(a) \
307 (((a) >> (MLX5_GENEVE_CRITO_SHIFT)) & (MLX5_GENEVE_CRITO_MASK))
308 #define MLX5_GENEVE_RSVD_MASK 0x3F
309 #define MLX5_GENEVE_RSVD_VAL(a) ((a) & (MLX5_GENEVE_RSVD_MASK))
311 * The length of the Geneve options fields, expressed in four byte multiples,
312 * not including the eight byte fixed tunnel.
314 #define MLX5_GENEVE_OPT_LEN_0 14
315 #define MLX5_GENEVE_OPT_LEN_1 63
317 enum mlx5_flow_drv_type {
320 MLX5_FLOW_TYPE_VERBS,
324 /* Matcher PRM representation */
325 struct mlx5_flow_dv_match_params {
327 /**< Size of match value. Do NOT split size and key! */
328 uint32_t buf[MLX5_ST_SZ_DW(fte_match_param)];
329 /**< Matcher value. This value is used as the mask or as a key. */
332 /* Matcher structure. */
333 struct mlx5_flow_dv_matcher {
334 LIST_ENTRY(mlx5_flow_dv_matcher) next;
335 /* Pointer to the next element. */
336 rte_atomic32_t refcnt; /**< Reference counter. */
337 void *matcher_object; /**< Pointer to DV matcher */
338 uint16_t crc; /**< CRC of key. */
339 uint16_t priority; /**< Priority of matcher. */
340 uint8_t egress; /**< Egress matcher. */
341 uint8_t transfer; /**< 1 if the flow is E-Switch flow. */
342 uint32_t group; /**< The matcher group. */
343 struct mlx5_flow_dv_match_params mask; /**< Matcher mask. */
346 #define MLX5_ENCAP_MAX_LEN 132
348 /* Encap/decap resource structure. */
349 struct mlx5_flow_dv_encap_decap_resource {
350 LIST_ENTRY(mlx5_flow_dv_encap_decap_resource) next;
351 /* Pointer to next element. */
352 rte_atomic32_t refcnt; /**< Reference counter. */
354 /**< Verbs encap/decap action object. */
355 uint8_t buf[MLX5_ENCAP_MAX_LEN];
357 uint8_t reformat_type;
359 uint64_t flags; /**< Flags for RDMA API. */
362 /* Tag resource structure. */
363 struct mlx5_flow_dv_tag_resource {
364 LIST_ENTRY(mlx5_flow_dv_tag_resource) next;
365 /* Pointer to next element. */
366 rte_atomic32_t refcnt; /**< Reference counter. */
368 /**< Verbs tag action object. */
369 uint32_t tag; /**< the tag value. */
373 * Number of modification commands.
374 * If extensive metadata registers are supported
375 * the maximal actions amount is 16 and 8 otherwise.
377 #define MLX5_MODIFY_NUM 16
378 #define MLX5_MODIFY_NUM_NO_MREG 8
380 /* Modify resource structure */
381 struct mlx5_flow_dv_modify_hdr_resource {
382 LIST_ENTRY(mlx5_flow_dv_modify_hdr_resource) next;
383 /* Pointer to next element. */
384 rte_atomic32_t refcnt; /**< Reference counter. */
385 struct ibv_flow_action *verbs_action;
386 /**< Verbs modify header action object. */
387 uint8_t ft_type; /**< Flow table type, Rx or Tx. */
388 uint32_t actions_num; /**< Number of modification actions. */
389 struct mlx5_modification_cmd actions[MLX5_MODIFY_NUM];
390 /**< Modification actions. */
391 uint64_t flags; /**< Flags for RDMA API. */
394 /* Jump action resource structure. */
395 struct mlx5_flow_dv_jump_tbl_resource {
396 LIST_ENTRY(mlx5_flow_dv_jump_tbl_resource) next;
397 /* Pointer to next element. */
398 rte_atomic32_t refcnt; /**< Reference counter. */
399 void *action; /**< Pointer to the rdma core action. */
400 uint8_t ft_type; /**< Flow table type, Rx or Tx. */
401 struct mlx5_flow_tbl_resource *tbl; /**< The target table. */
404 /* Port ID resource structure. */
405 struct mlx5_flow_dv_port_id_action_resource {
406 LIST_ENTRY(mlx5_flow_dv_port_id_action_resource) next;
407 /* Pointer to next element. */
408 rte_atomic32_t refcnt; /**< Reference counter. */
410 /**< Verbs tag action object. */
411 uint32_t port_id; /**< Port ID value. */
414 /* Push VLAN action resource structure */
415 struct mlx5_flow_dv_push_vlan_action_resource {
416 LIST_ENTRY(mlx5_flow_dv_push_vlan_action_resource) next;
417 /* Pointer to next element. */
418 rte_atomic32_t refcnt; /**< Reference counter. */
419 void *action; /**< Direct verbs action object. */
420 uint8_t ft_type; /**< Flow table type, Rx, Tx or FDB. */
421 rte_be32_t vlan_tag; /**< VLAN tag value. */
424 /* Metadata register copy table entry. */
425 struct mlx5_flow_mreg_copy_resource {
427 * Hash list entry for copy table.
428 * - Key is 32/64-bit MARK action ID.
429 * - MUST be the first entry.
431 struct mlx5_hlist_entry hlist_ent;
432 LIST_ENTRY(mlx5_flow_mreg_copy_resource) next;
433 /* List entry for device flows. */
434 uint32_t refcnt; /* Reference counter. */
435 uint32_t appcnt; /* Apply/Remove counter. */
436 struct rte_flow *flow; /* Built flow for copy. */
440 * Max number of actions per DV flow.
441 * See CREATE_FLOW_MAX_FLOW_ACTIONS_SUPPORTED
442 * In rdma-core file providers/mlx5/verbs.c
444 #define MLX5_DV_MAX_NUMBER_OF_ACTIONS 8
446 /* DV flows structure. */
447 struct mlx5_flow_dv {
448 struct mlx5_hrxq *hrxq; /**< Hash Rx queues. */
450 struct mlx5_flow_dv_matcher *matcher; /**< Cache to matcher. */
451 struct mlx5_flow_dv_match_params value;
452 /**< Holds the value that the packet is compared to. */
453 struct mlx5_flow_dv_encap_decap_resource *encap_decap;
454 /**< Pointer to encap/decap resource in cache. */
455 struct mlx5_flow_dv_modify_hdr_resource *modify_hdr;
456 /**< Pointer to modify header resource in cache. */
457 struct ibv_flow *flow; /**< Installed flow. */
458 struct mlx5_flow_dv_jump_tbl_resource *jump;
459 /**< Pointer to the jump action resource. */
460 struct mlx5_flow_dv_port_id_action_resource *port_id_action;
461 /**< Pointer to port ID action resource. */
462 struct mlx5_vf_vlan vf_vlan;
463 /**< Structure for VF VLAN workaround. */
464 struct mlx5_flow_dv_push_vlan_action_resource *push_vlan_res;
465 /**< Pointer to push VLAN action resource in cache. */
466 struct mlx5_flow_dv_tag_resource *tag_resource;
467 /**< pointer to the tag action. */
468 #ifdef HAVE_IBV_FLOW_DV_SUPPORT
469 void *actions[MLX5_DV_MAX_NUMBER_OF_ACTIONS];
472 int actions_n; /**< number of actions. */
475 /* Verbs specification header. */
476 struct ibv_spec_header {
477 enum ibv_flow_spec_type type;
481 /** Handles information leading to a drop fate. */
482 struct mlx5_flow_verbs {
483 LIST_ENTRY(mlx5_flow_verbs) next;
484 unsigned int size; /**< Size of the attribute. */
486 struct ibv_flow_attr *attr;
487 /**< Pointer to the Specification buffer. */
488 uint8_t *specs; /**< Pointer to the specifications. */
490 struct ibv_flow *flow; /**< Verbs flow pointer. */
491 struct mlx5_hrxq *hrxq; /**< Hash Rx queue object. */
492 struct mlx5_vf_vlan vf_vlan;
493 /**< Structure for VF VLAN workaround. */
496 struct mlx5_flow_rss {
498 uint32_t queue_num; /**< Number of entries in @p queue. */
499 uint64_t types; /**< Specific RSS hash types (see ETH_RSS_*). */
500 uint16_t (*queue)[]; /**< Destination queues to redirect traffic to. */
501 uint8_t key[MLX5_RSS_HASH_KEY_LEN]; /**< RSS hash key. */
504 /** Device flow structure. */
506 LIST_ENTRY(mlx5_flow) next;
507 struct rte_flow *flow; /**< Pointer to the main flow. */
509 /**< Bit-fields of present layers, see MLX5_FLOW_LAYER_*. */
511 /**< Bit-fields of detected actions, see MLX5_FLOW_ACTION_*. */
512 uint64_t hash_fields; /**< Verbs hash Rx queue hash fields. */
513 uint8_t ingress; /**< 1 if the flow is ingress. */
514 uint32_t group; /**< The group index. */
515 uint8_t transfer; /**< 1 if the flow is E-Switch flow. */
517 #ifdef HAVE_IBV_FLOW_DV_SUPPORT
518 struct mlx5_flow_dv dv;
520 struct mlx5_flow_verbs verbs;
522 uint32_t qrss_id; /**< Uniqie Q/RSS suffix subflow tag. */
523 bool external; /**< true if the flow is created external to PMD. */
526 /* Flow meter state. */
527 #define MLX5_FLOW_METER_DISABLE 0
528 #define MLX5_FLOW_METER_ENABLE 1
530 #define MLX5_MAN_WIDTH 8
531 /* Modify this value if enum rte_mtr_color changes. */
532 #define RTE_MTR_DROPPED RTE_COLORS
534 /* Meter policer statistics */
535 struct mlx5_flow_policer_stats {
536 struct mlx5_flow_counter *cnt[RTE_COLORS + 1];
537 /**< Color counter, extra for drop. */
539 /**< Statistics mask for the colors. */
542 /* Meter table structure. */
543 struct mlx5_meter_domain_info {
544 struct mlx5_flow_tbl_resource *tbl;
547 /**< Meter color not match default criteria. */
549 /**< Meter color match criteria. */
551 /**< Meter match action. */
552 void *policer_rules[RTE_MTR_DROPPED + 1];
553 /**< Meter policer for the match. */
556 /* Meter table set for TX RX FDB. */
557 struct mlx5_meter_domains_infos {
559 /**< Table user count. */
560 struct mlx5_meter_domain_info egress;
561 /**< TX meter table. */
562 struct mlx5_meter_domain_info ingress;
563 /**< RX meter table. */
564 struct mlx5_meter_domain_info transfer;
565 /**< FDB meter table. */
567 /**< Drop action as not matched. */
568 void *count_actns[RTE_MTR_DROPPED + 1];
569 /**< Counters for match and unmatched statistics. */
570 uint32_t fmp[MLX5_ST_SZ_DW(flow_meter_parameters)];
571 /**< Flow meter parameter. */
573 /**< Flow meter parameter size. */
575 /**< Flow meter action. */
578 /* Meter parameter structure. */
579 struct mlx5_flow_meter {
580 TAILQ_ENTRY(mlx5_flow_meter) next;
581 /**< Pointer to the next flow meter structure. */
584 struct rte_mtr_params params;
585 /**< Meter rule parameters. */
586 struct mlx5_flow_meter_profile *profile;
587 /**< Meter profile parameters. */
588 struct mlx5_meter_domains_infos *mfts;
589 /**< Flow table created for this meter. */
590 struct mlx5_flow_policer_stats policer_stats;
591 /**< Meter policer statistics. */
594 uint32_t active_state:1;
597 /**< Meter shared or not. */
600 /* RFC2697 parameter structure. */
601 struct mlx5_flow_meter_srtcm_rfc2697_prm {
602 /* green_saturation_value = cbs_mantissa * 2^cbs_exponent */
603 uint32_t cbs_exponent:5;
604 uint32_t cbs_mantissa:8;
605 /* cir = 8G * cir_mantissa * 1/(2^cir_exponent) Bytes/Sec */
606 uint32_t cir_exponent:5;
607 uint32_t cir_mantissa:8;
608 /* yellow _saturation_value = ebs_mantissa * 2^ebs_exponent */
609 uint32_t ebs_exponent:5;
610 uint32_t ebs_mantissa:8;
613 /* Flow meter profile structure. */
614 struct mlx5_flow_meter_profile {
615 TAILQ_ENTRY(mlx5_flow_meter_profile) next;
616 /**< Pointer to the next flow meter structure. */
617 uint32_t meter_profile_id; /**< Profile id. */
618 struct rte_mtr_meter_profile profile; /**< Profile detail. */
620 struct mlx5_flow_meter_srtcm_rfc2697_prm srtcm_prm;
621 /**< srtcm_rfc2697 struct. */
623 uint32_t ref_cnt; /**< Use count. */
626 /* Flow structure. */
628 TAILQ_ENTRY(rte_flow) next; /**< Pointer to the next flow structure. */
629 enum mlx5_flow_drv_type drv_type; /**< Driver type. */
630 struct mlx5_flow_rss rss; /**< RSS context. */
631 struct mlx5_flow_counter *counter; /**< Holds flow counter. */
632 struct mlx5_flow_mreg_copy_resource *mreg_copy;
633 /**< pointer to metadata register copy table resource. */
634 LIST_HEAD(dev_flows, mlx5_flow) dev_flows;
635 /**< Device flows that are part of the flow. */
636 struct mlx5_fdir *fdir; /**< Pointer to associated FDIR if any. */
637 uint32_t hairpin_flow_id; /**< The flow id used for hairpin. */
638 uint32_t copy_applied:1; /**< The MARK copy Flow os applied. */
641 typedef int (*mlx5_flow_validate_t)(struct rte_eth_dev *dev,
642 const struct rte_flow_attr *attr,
643 const struct rte_flow_item items[],
644 const struct rte_flow_action actions[],
646 struct rte_flow_error *error);
647 typedef struct mlx5_flow *(*mlx5_flow_prepare_t)
648 (const struct rte_flow_attr *attr, const struct rte_flow_item items[],
649 const struct rte_flow_action actions[], struct rte_flow_error *error);
650 typedef int (*mlx5_flow_translate_t)(struct rte_eth_dev *dev,
651 struct mlx5_flow *dev_flow,
652 const struct rte_flow_attr *attr,
653 const struct rte_flow_item items[],
654 const struct rte_flow_action actions[],
655 struct rte_flow_error *error);
656 typedef int (*mlx5_flow_apply_t)(struct rte_eth_dev *dev, struct rte_flow *flow,
657 struct rte_flow_error *error);
658 typedef void (*mlx5_flow_remove_t)(struct rte_eth_dev *dev,
659 struct rte_flow *flow);
660 typedef void (*mlx5_flow_destroy_t)(struct rte_eth_dev *dev,
661 struct rte_flow *flow);
662 typedef int (*mlx5_flow_query_t)(struct rte_eth_dev *dev,
663 struct rte_flow *flow,
664 const struct rte_flow_action *actions,
666 struct rte_flow_error *error);
667 typedef struct mlx5_meter_domains_infos *(*mlx5_flow_create_mtr_tbls_t)
668 (struct rte_eth_dev *dev,
669 const struct mlx5_flow_meter *fm);
670 typedef int (*mlx5_flow_destroy_mtr_tbls_t)(struct rte_eth_dev *dev,
671 struct mlx5_meter_domains_infos *tbls);
672 typedef int (*mlx5_flow_create_policer_rules_t)
673 (struct rte_eth_dev *dev,
674 struct mlx5_flow_meter *fm,
675 const struct rte_flow_attr *attr);
676 typedef int (*mlx5_flow_destroy_policer_rules_t)
677 (struct rte_eth_dev *dev,
678 const struct mlx5_flow_meter *fm,
679 const struct rte_flow_attr *attr);
680 typedef struct mlx5_flow_counter * (*mlx5_flow_counter_alloc_t)
681 (struct rte_eth_dev *dev);
682 typedef void (*mlx5_flow_counter_free_t)(struct rte_eth_dev *dev,
683 struct mlx5_flow_counter *cnt);
684 typedef int (*mlx5_flow_counter_query_t)(struct rte_eth_dev *dev,
685 struct mlx5_flow_counter *cnt,
686 bool clear, uint64_t *pkts,
688 struct mlx5_flow_driver_ops {
689 mlx5_flow_validate_t validate;
690 mlx5_flow_prepare_t prepare;
691 mlx5_flow_translate_t translate;
692 mlx5_flow_apply_t apply;
693 mlx5_flow_remove_t remove;
694 mlx5_flow_destroy_t destroy;
695 mlx5_flow_query_t query;
696 mlx5_flow_create_mtr_tbls_t create_mtr_tbls;
697 mlx5_flow_destroy_mtr_tbls_t destroy_mtr_tbls;
698 mlx5_flow_create_policer_rules_t create_policer_rules;
699 mlx5_flow_destroy_policer_rules_t destroy_policer_rules;
700 mlx5_flow_counter_alloc_t counter_alloc;
701 mlx5_flow_counter_free_t counter_free;
702 mlx5_flow_counter_query_t counter_query;
706 #define MLX5_CNT_CONTAINER(sh, batch, thread) (&(sh)->cmng.ccont \
707 [(((sh)->cmng.mhi[batch] >> (thread)) & 0x1) * 2 + (batch)])
708 #define MLX5_CNT_CONTAINER_UNUSED(sh, batch, thread) (&(sh)->cmng.ccont \
709 [(~((sh)->cmng.mhi[batch] >> (thread)) & 0x1) * 2 + (batch)])
713 struct mlx5_flow_id_pool *mlx5_flow_id_pool_alloc(void);
714 void mlx5_flow_id_pool_release(struct mlx5_flow_id_pool *pool);
715 uint32_t mlx5_flow_id_get(struct mlx5_flow_id_pool *pool, uint32_t *id);
716 uint32_t mlx5_flow_id_release(struct mlx5_flow_id_pool *pool,
718 int mlx5_flow_group_to_table(const struct rte_flow_attr *attributes,
719 bool external, uint32_t group, uint32_t *table,
720 struct rte_flow_error *error);
721 uint64_t mlx5_flow_hashfields_adjust(struct mlx5_flow *dev_flow, int tunnel,
722 uint64_t layer_types,
723 uint64_t hash_fields);
724 uint32_t mlx5_flow_adjust_priority(struct rte_eth_dev *dev, int32_t priority,
725 uint32_t subpriority);
726 enum modify_reg mlx5_flow_get_reg_id(struct rte_eth_dev *dev,
727 enum mlx5_feature_name feature,
729 struct rte_flow_error *error);
730 const struct rte_flow_action *mlx5_flow_find_action
731 (const struct rte_flow_action *actions,
732 enum rte_flow_action_type action);
733 int mlx5_flow_validate_action_count(struct rte_eth_dev *dev,
734 const struct rte_flow_attr *attr,
735 struct rte_flow_error *error);
736 int mlx5_flow_validate_action_drop(uint64_t action_flags,
737 const struct rte_flow_attr *attr,
738 struct rte_flow_error *error);
739 int mlx5_flow_validate_action_flag(uint64_t action_flags,
740 const struct rte_flow_attr *attr,
741 struct rte_flow_error *error);
742 int mlx5_flow_validate_action_mark(const struct rte_flow_action *action,
743 uint64_t action_flags,
744 const struct rte_flow_attr *attr,
745 struct rte_flow_error *error);
746 int mlx5_flow_validate_action_queue(const struct rte_flow_action *action,
747 uint64_t action_flags,
748 struct rte_eth_dev *dev,
749 const struct rte_flow_attr *attr,
750 struct rte_flow_error *error);
751 int mlx5_flow_validate_action_rss(const struct rte_flow_action *action,
752 uint64_t action_flags,
753 struct rte_eth_dev *dev,
754 const struct rte_flow_attr *attr,
756 struct rte_flow_error *error);
757 int mlx5_flow_validate_attributes(struct rte_eth_dev *dev,
758 const struct rte_flow_attr *attributes,
759 struct rte_flow_error *error);
760 int mlx5_flow_item_acceptable(const struct rte_flow_item *item,
762 const uint8_t *nic_mask,
764 struct rte_flow_error *error);
765 int mlx5_flow_validate_item_eth(const struct rte_flow_item *item,
767 struct rte_flow_error *error);
768 int mlx5_flow_validate_item_gre(const struct rte_flow_item *item,
770 uint8_t target_protocol,
771 struct rte_flow_error *error);
772 int mlx5_flow_validate_item_gre_key(const struct rte_flow_item *item,
774 const struct rte_flow_item *gre_item,
775 struct rte_flow_error *error);
776 int mlx5_flow_validate_item_ipv4(const struct rte_flow_item *item,
780 const struct rte_flow_item_ipv4 *acc_mask,
781 struct rte_flow_error *error);
782 int mlx5_flow_validate_item_ipv6(const struct rte_flow_item *item,
786 const struct rte_flow_item_ipv6 *acc_mask,
787 struct rte_flow_error *error);
788 int mlx5_flow_validate_item_mpls(struct rte_eth_dev *dev,
789 const struct rte_flow_item *item,
792 struct rte_flow_error *error);
793 int mlx5_flow_validate_item_tcp(const struct rte_flow_item *item,
795 uint8_t target_protocol,
796 const struct rte_flow_item_tcp *flow_mask,
797 struct rte_flow_error *error);
798 int mlx5_flow_validate_item_udp(const struct rte_flow_item *item,
800 uint8_t target_protocol,
801 struct rte_flow_error *error);
802 int mlx5_flow_validate_item_vlan(const struct rte_flow_item *item,
804 struct rte_eth_dev *dev,
805 struct rte_flow_error *error);
806 int mlx5_flow_validate_item_vxlan(const struct rte_flow_item *item,
808 struct rte_flow_error *error);
809 int mlx5_flow_validate_item_vxlan_gpe(const struct rte_flow_item *item,
811 struct rte_eth_dev *dev,
812 struct rte_flow_error *error);
813 int mlx5_flow_validate_item_icmp(const struct rte_flow_item *item,
815 uint8_t target_protocol,
816 struct rte_flow_error *error);
817 int mlx5_flow_validate_item_icmp6(const struct rte_flow_item *item,
819 uint8_t target_protocol,
820 struct rte_flow_error *error);
821 int mlx5_flow_validate_item_nvgre(const struct rte_flow_item *item,
823 uint8_t target_protocol,
824 struct rte_flow_error *error);
825 int mlx5_flow_validate_item_geneve(const struct rte_flow_item *item,
827 struct rte_eth_dev *dev,
828 struct rte_flow_error *error);
829 struct mlx5_meter_domains_infos *mlx5_flow_create_mtr_tbls
830 (struct rte_eth_dev *dev,
831 const struct mlx5_flow_meter *fm);
832 int mlx5_flow_destroy_mtr_tbls(struct rte_eth_dev *dev,
833 struct mlx5_meter_domains_infos *tbl);
834 int mlx5_flow_create_policer_rules(struct rte_eth_dev *dev,
835 struct mlx5_flow_meter *fm,
836 const struct rte_flow_attr *attr);
837 int mlx5_flow_destroy_policer_rules(struct rte_eth_dev *dev,
838 struct mlx5_flow_meter *fm,
839 const struct rte_flow_attr *attr);
840 #endif /* RTE_PMD_MLX5_FLOW_H_ */