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>
32 /* Private rte flow items. */
33 enum mlx5_rte_flow_item_type {
34 MLX5_RTE_FLOW_ITEM_TYPE_END = INT_MIN,
35 MLX5_RTE_FLOW_ITEM_TYPE_TAG,
36 MLX5_RTE_FLOW_ITEM_TYPE_TX_QUEUE,
37 MLX5_RTE_FLOW_ITEM_TYPE_VLAN,
40 /* Private (internal) rte flow actions. */
41 enum mlx5_rte_flow_action_type {
42 MLX5_RTE_FLOW_ACTION_TYPE_END = INT_MIN,
43 MLX5_RTE_FLOW_ACTION_TYPE_TAG,
44 MLX5_RTE_FLOW_ACTION_TYPE_MARK,
45 MLX5_RTE_FLOW_ACTION_TYPE_COPY_MREG,
48 /* Matches on selected register. */
49 struct mlx5_rte_flow_item_tag {
54 /* Modify selected register. */
55 struct mlx5_rte_flow_action_set_tag {
60 struct mlx5_flow_action_copy_mreg {
65 /* Matches on source queue. */
66 struct mlx5_rte_flow_item_tx_queue {
70 /* Feature name to allocate metadata register. */
71 enum mlx5_feature_name {
84 /* Pattern outer Layer bits. */
85 #define MLX5_FLOW_LAYER_OUTER_L2 (1u << 0)
86 #define MLX5_FLOW_LAYER_OUTER_L3_IPV4 (1u << 1)
87 #define MLX5_FLOW_LAYER_OUTER_L3_IPV6 (1u << 2)
88 #define MLX5_FLOW_LAYER_OUTER_L4_UDP (1u << 3)
89 #define MLX5_FLOW_LAYER_OUTER_L4_TCP (1u << 4)
90 #define MLX5_FLOW_LAYER_OUTER_VLAN (1u << 5)
92 /* Pattern inner Layer bits. */
93 #define MLX5_FLOW_LAYER_INNER_L2 (1u << 6)
94 #define MLX5_FLOW_LAYER_INNER_L3_IPV4 (1u << 7)
95 #define MLX5_FLOW_LAYER_INNER_L3_IPV6 (1u << 8)
96 #define MLX5_FLOW_LAYER_INNER_L4_UDP (1u << 9)
97 #define MLX5_FLOW_LAYER_INNER_L4_TCP (1u << 10)
98 #define MLX5_FLOW_LAYER_INNER_VLAN (1u << 11)
100 /* Pattern tunnel Layer bits. */
101 #define MLX5_FLOW_LAYER_VXLAN (1u << 12)
102 #define MLX5_FLOW_LAYER_VXLAN_GPE (1u << 13)
103 #define MLX5_FLOW_LAYER_GRE (1u << 14)
104 #define MLX5_FLOW_LAYER_MPLS (1u << 15)
105 /* List of tunnel Layer bits continued below. */
107 /* General pattern items bits. */
108 #define MLX5_FLOW_ITEM_METADATA (1u << 16)
109 #define MLX5_FLOW_ITEM_PORT_ID (1u << 17)
110 #define MLX5_FLOW_ITEM_TAG (1u << 18)
111 #define MLX5_FLOW_ITEM_MARK (1u << 19)
113 /* Pattern MISC bits. */
114 #define MLX5_FLOW_LAYER_ICMP (1u << 20)
115 #define MLX5_FLOW_LAYER_ICMP6 (1u << 21)
116 #define MLX5_FLOW_LAYER_GRE_KEY (1u << 22)
118 /* Pattern tunnel Layer bits (continued). */
119 #define MLX5_FLOW_LAYER_IPIP (1u << 23)
120 #define MLX5_FLOW_LAYER_IPV6_ENCAP (1u << 24)
121 #define MLX5_FLOW_LAYER_NVGRE (1u << 25)
122 #define MLX5_FLOW_LAYER_GENEVE (1u << 26)
125 #define MLX5_FLOW_ITEM_TX_QUEUE (1u << 27)
127 /* Pattern tunnel Layer bits (continued). */
128 #define MLX5_FLOW_LAYER_GTP (1u << 28)
131 #define MLX5_FLOW_LAYER_OUTER_L3 \
132 (MLX5_FLOW_LAYER_OUTER_L3_IPV4 | MLX5_FLOW_LAYER_OUTER_L3_IPV6)
133 #define MLX5_FLOW_LAYER_OUTER_L4 \
134 (MLX5_FLOW_LAYER_OUTER_L4_UDP | MLX5_FLOW_LAYER_OUTER_L4_TCP)
135 #define MLX5_FLOW_LAYER_OUTER \
136 (MLX5_FLOW_LAYER_OUTER_L2 | MLX5_FLOW_LAYER_OUTER_L3 | \
137 MLX5_FLOW_LAYER_OUTER_L4)
140 #define MLX5_FLOW_LAYER_TUNNEL \
141 (MLX5_FLOW_LAYER_VXLAN | MLX5_FLOW_LAYER_VXLAN_GPE | \
142 MLX5_FLOW_LAYER_GRE | MLX5_FLOW_LAYER_NVGRE | MLX5_FLOW_LAYER_MPLS | \
143 MLX5_FLOW_LAYER_IPIP | MLX5_FLOW_LAYER_IPV6_ENCAP | \
144 MLX5_FLOW_LAYER_GENEVE | MLX5_FLOW_LAYER_GTP)
147 #define MLX5_FLOW_LAYER_INNER_L3 \
148 (MLX5_FLOW_LAYER_INNER_L3_IPV4 | MLX5_FLOW_LAYER_INNER_L3_IPV6)
149 #define MLX5_FLOW_LAYER_INNER_L4 \
150 (MLX5_FLOW_LAYER_INNER_L4_UDP | MLX5_FLOW_LAYER_INNER_L4_TCP)
151 #define MLX5_FLOW_LAYER_INNER \
152 (MLX5_FLOW_LAYER_INNER_L2 | MLX5_FLOW_LAYER_INNER_L3 | \
153 MLX5_FLOW_LAYER_INNER_L4)
156 #define MLX5_FLOW_LAYER_L2 \
157 (MLX5_FLOW_LAYER_OUTER_L2 | MLX5_FLOW_LAYER_INNER_L2)
158 #define MLX5_FLOW_LAYER_L3_IPV4 \
159 (MLX5_FLOW_LAYER_OUTER_L3_IPV4 | MLX5_FLOW_LAYER_INNER_L3_IPV4)
160 #define MLX5_FLOW_LAYER_L3_IPV6 \
161 (MLX5_FLOW_LAYER_OUTER_L3_IPV6 | MLX5_FLOW_LAYER_INNER_L3_IPV6)
162 #define MLX5_FLOW_LAYER_L3 \
163 (MLX5_FLOW_LAYER_L3_IPV4 | MLX5_FLOW_LAYER_L3_IPV6)
164 #define MLX5_FLOW_LAYER_L4 \
165 (MLX5_FLOW_LAYER_OUTER_L4 | MLX5_FLOW_LAYER_INNER_L4)
168 #define MLX5_FLOW_ACTION_DROP (1u << 0)
169 #define MLX5_FLOW_ACTION_QUEUE (1u << 1)
170 #define MLX5_FLOW_ACTION_RSS (1u << 2)
171 #define MLX5_FLOW_ACTION_FLAG (1u << 3)
172 #define MLX5_FLOW_ACTION_MARK (1u << 4)
173 #define MLX5_FLOW_ACTION_COUNT (1u << 5)
174 #define MLX5_FLOW_ACTION_PORT_ID (1u << 6)
175 #define MLX5_FLOW_ACTION_OF_POP_VLAN (1u << 7)
176 #define MLX5_FLOW_ACTION_OF_PUSH_VLAN (1u << 8)
177 #define MLX5_FLOW_ACTION_OF_SET_VLAN_VID (1u << 9)
178 #define MLX5_FLOW_ACTION_OF_SET_VLAN_PCP (1u << 10)
179 #define MLX5_FLOW_ACTION_SET_IPV4_SRC (1u << 11)
180 #define MLX5_FLOW_ACTION_SET_IPV4_DST (1u << 12)
181 #define MLX5_FLOW_ACTION_SET_IPV6_SRC (1u << 13)
182 #define MLX5_FLOW_ACTION_SET_IPV6_DST (1u << 14)
183 #define MLX5_FLOW_ACTION_SET_TP_SRC (1u << 15)
184 #define MLX5_FLOW_ACTION_SET_TP_DST (1u << 16)
185 #define MLX5_FLOW_ACTION_JUMP (1u << 17)
186 #define MLX5_FLOW_ACTION_SET_TTL (1u << 18)
187 #define MLX5_FLOW_ACTION_DEC_TTL (1u << 19)
188 #define MLX5_FLOW_ACTION_SET_MAC_SRC (1u << 20)
189 #define MLX5_FLOW_ACTION_SET_MAC_DST (1u << 21)
190 #define MLX5_FLOW_ACTION_ENCAP (1u << 22)
191 #define MLX5_FLOW_ACTION_DECAP (1u << 23)
192 #define MLX5_FLOW_ACTION_INC_TCP_SEQ (1u << 24)
193 #define MLX5_FLOW_ACTION_DEC_TCP_SEQ (1u << 25)
194 #define MLX5_FLOW_ACTION_INC_TCP_ACK (1u << 26)
195 #define MLX5_FLOW_ACTION_DEC_TCP_ACK (1u << 27)
196 #define MLX5_FLOW_ACTION_SET_TAG (1ull << 28)
197 #define MLX5_FLOW_ACTION_MARK_EXT (1ull << 29)
198 #define MLX5_FLOW_ACTION_SET_META (1ull << 30)
199 #define MLX5_FLOW_ACTION_METER (1ull << 31)
200 #define MLX5_FLOW_ACTION_SET_IPV4_DSCP (1ull << 32)
201 #define MLX5_FLOW_ACTION_SET_IPV6_DSCP (1ull << 33)
203 #define MLX5_FLOW_FATE_ACTIONS \
204 (MLX5_FLOW_ACTION_DROP | MLX5_FLOW_ACTION_QUEUE | \
205 MLX5_FLOW_ACTION_RSS | MLX5_FLOW_ACTION_JUMP)
207 #define MLX5_FLOW_FATE_ESWITCH_ACTIONS \
208 (MLX5_FLOW_ACTION_DROP | MLX5_FLOW_ACTION_PORT_ID | \
209 MLX5_FLOW_ACTION_JUMP)
212 #define MLX5_FLOW_MODIFY_HDR_ACTIONS (MLX5_FLOW_ACTION_SET_IPV4_SRC | \
213 MLX5_FLOW_ACTION_SET_IPV4_DST | \
214 MLX5_FLOW_ACTION_SET_IPV6_SRC | \
215 MLX5_FLOW_ACTION_SET_IPV6_DST | \
216 MLX5_FLOW_ACTION_SET_TP_SRC | \
217 MLX5_FLOW_ACTION_SET_TP_DST | \
218 MLX5_FLOW_ACTION_SET_TTL | \
219 MLX5_FLOW_ACTION_DEC_TTL | \
220 MLX5_FLOW_ACTION_SET_MAC_SRC | \
221 MLX5_FLOW_ACTION_SET_MAC_DST | \
222 MLX5_FLOW_ACTION_INC_TCP_SEQ | \
223 MLX5_FLOW_ACTION_DEC_TCP_SEQ | \
224 MLX5_FLOW_ACTION_INC_TCP_ACK | \
225 MLX5_FLOW_ACTION_DEC_TCP_ACK | \
226 MLX5_FLOW_ACTION_OF_SET_VLAN_VID | \
227 MLX5_FLOW_ACTION_SET_TAG | \
228 MLX5_FLOW_ACTION_MARK_EXT | \
229 MLX5_FLOW_ACTION_SET_META | \
230 MLX5_FLOW_ACTION_SET_IPV4_DSCP | \
231 MLX5_FLOW_ACTION_SET_IPV6_DSCP)
233 #define MLX5_FLOW_VLAN_ACTIONS (MLX5_FLOW_ACTION_OF_POP_VLAN | \
234 MLX5_FLOW_ACTION_OF_PUSH_VLAN)
236 #define MLX5_FLOW_XCAP_ACTIONS (MLX5_FLOW_ACTION_ENCAP | MLX5_FLOW_ACTION_DECAP)
239 #define IPPROTO_MPLS 137
242 /* UDP port number for MPLS */
243 #define MLX5_UDP_PORT_MPLS 6635
245 /* UDP port numbers for VxLAN. */
246 #define MLX5_UDP_PORT_VXLAN 4789
247 #define MLX5_UDP_PORT_VXLAN_GPE 4790
249 /* UDP port numbers for GENEVE. */
250 #define MLX5_UDP_PORT_GENEVE 6081
252 /* Priority reserved for default flows. */
253 #define MLX5_FLOW_PRIO_RSVD ((uint32_t)-1)
256 * Number of sub priorities.
257 * For each kind of pattern matching i.e. L2, L3, L4 to have a correct
258 * matching on the NIC (firmware dependent) L4 most have the higher priority
259 * followed by L3 and ending with L2.
261 #define MLX5_PRIORITY_MAP_L2 2
262 #define MLX5_PRIORITY_MAP_L3 1
263 #define MLX5_PRIORITY_MAP_L4 0
264 #define MLX5_PRIORITY_MAP_MAX 3
266 /* Valid layer type for IPV4 RSS. */
267 #define MLX5_IPV4_LAYER_TYPES \
268 (ETH_RSS_IPV4 | ETH_RSS_FRAG_IPV4 | \
269 ETH_RSS_NONFRAG_IPV4_TCP | ETH_RSS_NONFRAG_IPV4_UDP | \
270 ETH_RSS_NONFRAG_IPV4_OTHER)
272 /* IBV hash source bits for IPV4. */
273 #define MLX5_IPV4_IBV_RX_HASH (IBV_RX_HASH_SRC_IPV4 | IBV_RX_HASH_DST_IPV4)
275 /* Valid layer type for IPV6 RSS. */
276 #define MLX5_IPV6_LAYER_TYPES \
277 (ETH_RSS_IPV6 | ETH_RSS_FRAG_IPV6 | ETH_RSS_NONFRAG_IPV6_TCP | \
278 ETH_RSS_NONFRAG_IPV6_UDP | ETH_RSS_IPV6_EX | ETH_RSS_IPV6_TCP_EX | \
279 ETH_RSS_IPV6_UDP_EX | ETH_RSS_NONFRAG_IPV6_OTHER)
281 /* IBV hash source bits for IPV6. */
282 #define MLX5_IPV6_IBV_RX_HASH (IBV_RX_HASH_SRC_IPV6 | IBV_RX_HASH_DST_IPV6)
284 /* IBV hash bits for L3 SRC. */
285 #define MLX5_L3_SRC_IBV_RX_HASH (IBV_RX_HASH_SRC_IPV4 | IBV_RX_HASH_SRC_IPV6)
287 /* IBV hash bits for L3 DST. */
288 #define MLX5_L3_DST_IBV_RX_HASH (IBV_RX_HASH_DST_IPV4 | IBV_RX_HASH_DST_IPV6)
290 /* IBV hash bits for TCP. */
291 #define MLX5_TCP_IBV_RX_HASH (IBV_RX_HASH_SRC_PORT_TCP | \
292 IBV_RX_HASH_DST_PORT_TCP)
294 /* IBV hash bits for UDP. */
295 #define MLX5_UDP_IBV_RX_HASH (IBV_RX_HASH_SRC_PORT_UDP | \
296 IBV_RX_HASH_DST_PORT_UDP)
298 /* IBV hash bits for L4 SRC. */
299 #define MLX5_L4_SRC_IBV_RX_HASH (IBV_RX_HASH_SRC_PORT_TCP | \
300 IBV_RX_HASH_SRC_PORT_UDP)
302 /* IBV hash bits for L4 DST. */
303 #define MLX5_L4_DST_IBV_RX_HASH (IBV_RX_HASH_DST_PORT_TCP | \
304 IBV_RX_HASH_DST_PORT_UDP)
306 /* Geneve header first 16Bit */
307 #define MLX5_GENEVE_VER_MASK 0x3
308 #define MLX5_GENEVE_VER_SHIFT 14
309 #define MLX5_GENEVE_VER_VAL(a) \
310 (((a) >> (MLX5_GENEVE_VER_SHIFT)) & (MLX5_GENEVE_VER_MASK))
311 #define MLX5_GENEVE_OPTLEN_MASK 0x3F
312 #define MLX5_GENEVE_OPTLEN_SHIFT 7
313 #define MLX5_GENEVE_OPTLEN_VAL(a) \
314 (((a) >> (MLX5_GENEVE_OPTLEN_SHIFT)) & (MLX5_GENEVE_OPTLEN_MASK))
315 #define MLX5_GENEVE_OAMF_MASK 0x1
316 #define MLX5_GENEVE_OAMF_SHIFT 7
317 #define MLX5_GENEVE_OAMF_VAL(a) \
318 (((a) >> (MLX5_GENEVE_OAMF_SHIFT)) & (MLX5_GENEVE_OAMF_MASK))
319 #define MLX5_GENEVE_CRITO_MASK 0x1
320 #define MLX5_GENEVE_CRITO_SHIFT 6
321 #define MLX5_GENEVE_CRITO_VAL(a) \
322 (((a) >> (MLX5_GENEVE_CRITO_SHIFT)) & (MLX5_GENEVE_CRITO_MASK))
323 #define MLX5_GENEVE_RSVD_MASK 0x3F
324 #define MLX5_GENEVE_RSVD_VAL(a) ((a) & (MLX5_GENEVE_RSVD_MASK))
326 * The length of the Geneve options fields, expressed in four byte multiples,
327 * not including the eight byte fixed tunnel.
329 #define MLX5_GENEVE_OPT_LEN_0 14
330 #define MLX5_GENEVE_OPT_LEN_1 63
332 #define MLX5_ENCAPSULATION_DECISION_SIZE (sizeof(struct rte_flow_item_eth) + \
333 sizeof(struct rte_flow_item_ipv4))
335 /* Software header modify action numbers of a flow. */
336 #define MLX5_ACT_NUM_MDF_IPV4 1
337 #define MLX5_ACT_NUM_MDF_IPV6 4
338 #define MLX5_ACT_NUM_MDF_MAC 2
339 #define MLX5_ACT_NUM_MDF_VID 1
340 #define MLX5_ACT_NUM_MDF_PORT 2
341 #define MLX5_ACT_NUM_MDF_TTL 1
342 #define MLX5_ACT_NUM_DEC_TTL MLX5_ACT_NUM_MDF_TTL
343 #define MLX5_ACT_NUM_MDF_TCPSEQ 1
344 #define MLX5_ACT_NUM_MDF_TCPACK 1
345 #define MLX5_ACT_NUM_SET_REG 1
346 #define MLX5_ACT_NUM_SET_TAG 1
347 #define MLX5_ACT_NUM_CPY_MREG MLX5_ACT_NUM_SET_TAG
348 #define MLX5_ACT_NUM_SET_MARK MLX5_ACT_NUM_SET_TAG
349 #define MLX5_ACT_NUM_SET_META MLX5_ACT_NUM_SET_TAG
350 #define MLX5_ACT_NUM_SET_DSCP 1
352 enum mlx5_flow_drv_type {
355 MLX5_FLOW_TYPE_VERBS,
359 /* Fate action type. */
360 enum mlx5_flow_fate_type {
361 MLX5_FLOW_FATE_NONE, /* Egress flow. */
362 MLX5_FLOW_FATE_QUEUE,
364 MLX5_FLOW_FATE_PORT_ID,
369 /* Matcher PRM representation */
370 struct mlx5_flow_dv_match_params {
372 /**< Size of match value. Do NOT split size and key! */
373 uint32_t buf[MLX5_ST_SZ_DW(fte_match_param)];
374 /**< Matcher value. This value is used as the mask or as a key. */
377 /* Matcher structure. */
378 struct mlx5_flow_dv_matcher {
379 LIST_ENTRY(mlx5_flow_dv_matcher) next;
380 /**< Pointer to the next element. */
381 struct mlx5_flow_tbl_resource *tbl;
382 /**< Pointer to the table(group) the matcher associated with. */
383 rte_atomic32_t refcnt; /**< Reference counter. */
384 void *matcher_object; /**< Pointer to DV matcher */
385 uint16_t crc; /**< CRC of key. */
386 uint16_t priority; /**< Priority of matcher. */
387 struct mlx5_flow_dv_match_params mask; /**< Matcher mask. */
390 #define MLX5_ENCAP_MAX_LEN 132
392 /* Encap/decap resource structure. */
393 struct mlx5_flow_dv_encap_decap_resource {
394 ILIST_ENTRY(uint32_t)next;
395 /* Pointer to next element. */
396 rte_atomic32_t refcnt; /**< Reference counter. */
398 /**< Verbs encap/decap action object. */
399 uint8_t buf[MLX5_ENCAP_MAX_LEN];
401 uint8_t reformat_type;
403 uint64_t flags; /**< Flags for RDMA API. */
406 /* Tag resource structure. */
407 struct mlx5_flow_dv_tag_resource {
408 struct mlx5_hlist_entry entry;
409 /**< hash list entry for tag resource, tag value as the key. */
411 /**< Verbs tag action object. */
412 rte_atomic32_t refcnt; /**< Reference counter. */
413 uint32_t idx; /**< Index for the index memory pool. */
417 * Number of modification commands.
418 * The maximal actions amount in FW is some constant, and it is 16 in the
419 * latest releases. In some old releases, it will be limited to 8.
420 * Since there is no interface to query the capacity, the maximal value should
421 * be used to allow PMD to create the flow. The validation will be done in the
422 * lower driver layer or FW. A failure will be returned if exceeds the maximal
423 * supported actions number on the root table.
424 * On non-root tables, there is no limitation, but 32 is enough right now.
426 #define MLX5_MAX_MODIFY_NUM 32
427 #define MLX5_ROOT_TBL_MODIFY_NUM 16
429 /* Modify resource structure */
430 struct mlx5_flow_dv_modify_hdr_resource {
431 LIST_ENTRY(mlx5_flow_dv_modify_hdr_resource) next;
432 /* Pointer to next element. */
433 rte_atomic32_t refcnt; /**< Reference counter. */
434 struct ibv_flow_action *verbs_action;
435 /**< Verbs modify header action object. */
436 uint8_t ft_type; /**< Flow table type, Rx or Tx. */
437 uint32_t actions_num; /**< Number of modification actions. */
438 uint64_t flags; /**< Flags for RDMA API. */
439 struct mlx5_modification_cmd actions[];
440 /**< Modification actions. */
443 /* Jump action resource structure. */
444 struct mlx5_flow_dv_jump_tbl_resource {
445 rte_atomic32_t refcnt; /**< Reference counter. */
446 uint8_t ft_type; /**< Flow table type, Rx or Tx. */
447 void *action; /**< Pointer to the rdma core action. */
450 /* Port ID resource structure. */
451 struct mlx5_flow_dv_port_id_action_resource {
452 ILIST_ENTRY(uint32_t)next;
453 /* Pointer to next element. */
454 rte_atomic32_t refcnt; /**< Reference counter. */
456 /**< Verbs tag action object. */
457 uint32_t port_id; /**< Port ID value. */
460 /* Push VLAN action resource structure */
461 struct mlx5_flow_dv_push_vlan_action_resource {
462 ILIST_ENTRY(uint32_t)next;
463 /* Pointer to next element. */
464 rte_atomic32_t refcnt; /**< Reference counter. */
465 void *action; /**< Direct verbs action object. */
466 uint8_t ft_type; /**< Flow table type, Rx, Tx or FDB. */
467 rte_be32_t vlan_tag; /**< VLAN tag value. */
470 /* Metadata register copy table entry. */
471 struct mlx5_flow_mreg_copy_resource {
473 * Hash list entry for copy table.
474 * - Key is 32/64-bit MARK action ID.
475 * - MUST be the first entry.
477 struct mlx5_hlist_entry hlist_ent;
478 LIST_ENTRY(mlx5_flow_mreg_copy_resource) next;
479 /* List entry for device flows. */
480 uint32_t refcnt; /* Reference counter. */
481 uint32_t appcnt; /* Apply/Remove counter. */
483 uint32_t rix_flow; /* Built flow for copy. */
486 /* Table data structure of the hash organization. */
487 struct mlx5_flow_tbl_data_entry {
488 struct mlx5_hlist_entry entry;
489 /**< hash list entry, 64-bits key inside. */
490 struct mlx5_flow_tbl_resource tbl;
491 /**< flow table resource. */
492 LIST_HEAD(matchers, mlx5_flow_dv_matcher) matchers;
493 /**< matchers' header associated with the flow table. */
494 struct mlx5_flow_dv_jump_tbl_resource jump;
495 /**< jump resource, at most one for each table created. */
496 uint32_t idx; /**< index for the indexed mempool. */
499 /* Verbs specification header. */
500 struct ibv_spec_header {
501 enum ibv_flow_spec_type type;
505 /* RSS description. */
506 struct mlx5_flow_rss_desc {
508 uint32_t queue_num; /**< Number of entries in @p queue. */
509 uint64_t types; /**< Specific RSS hash types (see ETH_RSS_*). */
510 uint8_t key[MLX5_RSS_HASH_KEY_LEN]; /**< RSS hash key. */
511 uint16_t queue[]; /**< Destination queues to redirect traffic to. */
515 /** Device flow handle structure for DV mode only. */
516 struct mlx5_flow_handle_dv {
518 struct mlx5_flow_dv_matcher *matcher; /**< Cache to matcher. */
519 struct mlx5_flow_dv_modify_hdr_resource *modify_hdr;
520 /**< Pointer to modify header resource in cache. */
521 uint32_t rix_encap_decap;
522 /**< Index to encap/decap resource in cache. */
523 uint32_t rix_push_vlan;
524 /**< Index to push VLAN action resource in cache. */
526 /**< Index to the tag action. */
529 /** Device flow handle structure: used both for creating & destroying. */
530 struct mlx5_flow_handle {
531 SILIST_ENTRY(uint32_t)next;
532 struct mlx5_vf_vlan vf_vlan; /**< Structure for VF VLAN workaround. */
533 /**< Index to next device flow handle. */
535 /**< Bit-fields of present layers, see MLX5_FLOW_LAYER_*. */
536 void *ib_flow; /**< Verbs flow pointer. */
537 uint32_t split_flow_id:28; /**< Sub flow unique match flow id. */
538 uint32_t mark:1; /**< Metadate rxq mark flag. */
539 uint32_t fate_action:3; /**< Fate action type. */
541 uint32_t rix_hrxq; /**< Hash Rx queue object index. */
542 uint32_t rix_jump; /**< Index to the jump action resource. */
543 uint32_t rix_port_id_action;
544 /**< Index to port ID action resource. */
546 /**< Generic value indicates the fate action. */
548 #ifdef HAVE_IBV_FLOW_DV_SUPPORT
549 struct mlx5_flow_handle_dv dvh;
554 * Size for Verbs device flow handle structure only. Do not use the DV only
555 * structure in Verbs. No DV flows attributes will be accessed.
556 * Macro offsetof() could also be used here.
558 #ifdef HAVE_IBV_FLOW_DV_SUPPORT
559 #define MLX5_FLOW_HANDLE_VERBS_SIZE \
560 (sizeof(struct mlx5_flow_handle) - sizeof(struct mlx5_flow_handle_dv))
562 #define MLX5_FLOW_HANDLE_VERBS_SIZE (sizeof(struct mlx5_flow_handle))
566 * Max number of actions per DV flow.
567 * See CREATE_FLOW_MAX_FLOW_ACTIONS_SUPPORTED
568 * in rdma-core file providers/mlx5/verbs.c.
570 #define MLX5_DV_MAX_NUMBER_OF_ACTIONS 8
572 /** Device flow structure only for DV flow creation. */
573 struct mlx5_flow_dv_workspace {
574 uint32_t group; /**< The group index. */
575 uint8_t transfer; /**< 1 if the flow is E-Switch flow. */
576 int actions_n; /**< number of actions. */
577 void *actions[MLX5_DV_MAX_NUMBER_OF_ACTIONS]; /**< Action list. */
578 struct mlx5_flow_dv_encap_decap_resource *encap_decap;
579 /**< Pointer to encap/decap resource in cache. */
580 struct mlx5_flow_dv_push_vlan_action_resource *push_vlan_res;
581 /**< Pointer to push VLAN action resource in cache. */
582 struct mlx5_flow_dv_tag_resource *tag_resource;
583 /**< pointer to the tag action. */
584 struct mlx5_flow_dv_port_id_action_resource *port_id_action;
585 /**< Pointer to port ID action resource. */
586 struct mlx5_flow_dv_jump_tbl_resource *jump;
587 /**< Pointer to the jump action resource. */
588 struct mlx5_flow_dv_match_params value;
589 /**< Holds the value that the packet is compared to. */
593 * Maximal Verbs flow specifications & actions size.
594 * Some elements are mutually exclusive, but enough space should be allocated.
595 * Tunnel cases: 1. Max 2 Ethernet + IP(v6 len > v4 len) + TCP/UDP headers.
596 * 2. One tunnel header (exception: GRE + MPLS),
597 * SPEC length: GRE == tunnel.
598 * Actions: 1. 1 Mark OR Flag.
599 * 2. 1 Drop (if any).
600 * 3. No limitation for counters, but it makes no sense to support too
601 * many counters in a single device flow.
603 #ifdef HAVE_IBV_DEVICE_MPLS_SUPPORT
604 #define MLX5_VERBS_MAX_SPEC_SIZE \
606 (2 * (sizeof(struct ibv_flow_spec_eth) + \
607 sizeof(struct ibv_flow_spec_ipv6) + \
608 sizeof(struct ibv_flow_spec_tcp_udp)) + \
609 sizeof(struct ibv_flow_spec_gre) + \
610 sizeof(struct ibv_flow_spec_mpls)) \
613 #define MLX5_VERBS_MAX_SPEC_SIZE \
615 (2 * (sizeof(struct ibv_flow_spec_eth) + \
616 sizeof(struct ibv_flow_spec_ipv6) + \
617 sizeof(struct ibv_flow_spec_tcp_udp)) + \
618 sizeof(struct ibv_flow_spec_tunnel)) \
622 #if defined(HAVE_IBV_DEVICE_COUNTERS_SET_V42) || \
623 defined(HAVE_IBV_DEVICE_COUNTERS_SET_V45)
624 #define MLX5_VERBS_MAX_ACT_SIZE \
626 sizeof(struct ibv_flow_spec_action_tag) + \
627 sizeof(struct ibv_flow_spec_action_drop) + \
628 sizeof(struct ibv_flow_spec_counter_action) * 4 \
631 #define MLX5_VERBS_MAX_ACT_SIZE \
633 sizeof(struct ibv_flow_spec_action_tag) + \
634 sizeof(struct ibv_flow_spec_action_drop) \
638 #define MLX5_VERBS_MAX_SPEC_ACT_SIZE \
639 (MLX5_VERBS_MAX_SPEC_SIZE + MLX5_VERBS_MAX_ACT_SIZE)
641 /** Device flow structure only for Verbs flow creation. */
642 struct mlx5_flow_verbs_workspace {
643 unsigned int size; /**< Size of the attribute. */
644 struct ibv_flow_attr attr; /**< Verbs flow attribute buffer. */
645 uint8_t specs[MLX5_VERBS_MAX_SPEC_ACT_SIZE];
646 /**< Specifications & actions buffer of verbs flow. */
649 /** Maximal number of device sub-flows supported. */
650 #define MLX5_NUM_MAX_DEV_FLOWS 32
652 /** Device flow structure. */
654 struct rte_flow *flow; /**< Pointer to the main flow. */
655 uint64_t hash_fields; /**< Verbs hash Rx queue hash fields. */
657 /**< Bit-fields of detected actions, see MLX5_FLOW_ACTION_*. */
658 bool external; /**< true if the flow is created external to PMD. */
659 uint8_t ingress; /**< 1 if the flow is ingress. */
661 #ifdef HAVE_IBV_FLOW_DV_SUPPORT
662 struct mlx5_flow_dv_workspace dv;
664 struct mlx5_flow_verbs_workspace verbs;
666 struct mlx5_flow_handle *handle;
667 uint32_t handle_idx; /* Index of the mlx5 flow handle memory. */
670 /* Flow meter state. */
671 #define MLX5_FLOW_METER_DISABLE 0
672 #define MLX5_FLOW_METER_ENABLE 1
674 #define MLX5_MAN_WIDTH 8
675 /* Modify this value if enum rte_mtr_color changes. */
676 #define RTE_MTR_DROPPED RTE_COLORS
678 /* Meter policer statistics */
679 struct mlx5_flow_policer_stats {
680 uint32_t cnt[RTE_COLORS + 1];
681 /**< Color counter, extra for drop. */
683 /**< Statistics mask for the colors. */
686 /* Meter table structure. */
687 struct mlx5_meter_domain_info {
688 struct mlx5_flow_tbl_resource *tbl;
690 struct mlx5_flow_tbl_resource *sfx_tbl;
691 /**< Meter suffix table. */
693 /**< Meter color not match default criteria. */
695 /**< Meter color match criteria. */
697 /**< Meter match action. */
698 void *policer_rules[RTE_MTR_DROPPED + 1];
699 /**< Meter policer for the match. */
702 /* Meter table set for TX RX FDB. */
703 struct mlx5_meter_domains_infos {
705 /**< Table user count. */
706 struct mlx5_meter_domain_info egress;
707 /**< TX meter table. */
708 struct mlx5_meter_domain_info ingress;
709 /**< RX meter table. */
710 struct mlx5_meter_domain_info transfer;
711 /**< FDB meter table. */
713 /**< Drop action as not matched. */
714 void *count_actns[RTE_MTR_DROPPED + 1];
715 /**< Counters for match and unmatched statistics. */
716 uint32_t fmp[MLX5_ST_SZ_DW(flow_meter_parameters)];
717 /**< Flow meter parameter. */
719 /**< Flow meter parameter size. */
721 /**< Flow meter action. */
724 /* Meter parameter structure. */
725 struct mlx5_flow_meter {
726 TAILQ_ENTRY(mlx5_flow_meter) next;
727 /**< Pointer to the next flow meter structure. */
728 uint32_t idx; /* Index to meter object. */
731 struct mlx5_flow_meter_profile *profile;
732 /**< Meter profile parameters. */
734 /** Policer actions (per meter output color). */
735 enum rte_mtr_policer_action action[RTE_COLORS];
737 /** Set of stats counters to be enabled.
738 * @see enum rte_mtr_stats_type
742 /**< Rule applies to ingress traffic. */
745 /**< Rule applies to egress traffic. */
748 * Instead of simply matching the properties of traffic as it would
749 * appear on a given DPDK port ID, enabling this attribute transfers
750 * a flow rule to the lowest possible level of any device endpoints
751 * found in the pattern.
753 * When supported, this effectively enables an application to
754 * re-route traffic not necessarily intended for it (e.g. coming
755 * from or addressed to different physical ports, VFs or
756 * applications) at the device level.
758 * It complements the behavior of some pattern items such as
759 * RTE_FLOW_ITEM_TYPE_PHY_PORT and is meaningless without them.
761 * When transferring flow rules, ingress and egress attributes keep
762 * their original meaning, as if processing traffic emitted or
763 * received by the application.
766 struct mlx5_meter_domains_infos *mfts;
767 /**< Flow table created for this meter. */
768 struct mlx5_flow_policer_stats policer_stats;
769 /**< Meter policer statistics. */
772 uint32_t active_state:1;
775 /**< Meter shared or not. */
778 /* RFC2697 parameter structure. */
779 struct mlx5_flow_meter_srtcm_rfc2697_prm {
780 /* green_saturation_value = cbs_mantissa * 2^cbs_exponent */
781 uint32_t cbs_exponent:5;
782 uint32_t cbs_mantissa:8;
783 /* cir = 8G * cir_mantissa * 1/(2^cir_exponent) Bytes/Sec */
784 uint32_t cir_exponent:5;
785 uint32_t cir_mantissa:8;
786 /* yellow _saturation_value = ebs_mantissa * 2^ebs_exponent */
787 uint32_t ebs_exponent:5;
788 uint32_t ebs_mantissa:8;
791 /* Flow meter profile structure. */
792 struct mlx5_flow_meter_profile {
793 TAILQ_ENTRY(mlx5_flow_meter_profile) next;
794 /**< Pointer to the next flow meter structure. */
795 uint32_t meter_profile_id; /**< Profile id. */
796 struct rte_mtr_meter_profile profile; /**< Profile detail. */
798 struct mlx5_flow_meter_srtcm_rfc2697_prm srtcm_prm;
799 /**< srtcm_rfc2697 struct. */
801 uint32_t ref_cnt; /**< Use count. */
804 /* Fdir flow structure */
805 struct mlx5_fdir_flow {
806 LIST_ENTRY(mlx5_fdir_flow) next; /* Pointer to the next element. */
807 struct mlx5_fdir *fdir; /* Pointer to fdir. */
808 uint32_t rix_flow; /* Index to flow. */
811 #define HAIRPIN_FLOW_ID_BITS 28
813 /* Flow structure. */
815 ILIST_ENTRY(uint32_t)next; /**< Index to the next flow structure. */
816 uint32_t dev_handles;
817 /**< Device flow handles that are part of the flow. */
818 uint32_t drv_type:2; /**< Driver type. */
819 uint32_t fdir:1; /**< Identifier of associated FDIR if any. */
820 uint32_t hairpin_flow_id:HAIRPIN_FLOW_ID_BITS;
821 /**< The flow id used for hairpin. */
822 uint32_t copy_applied:1; /**< The MARK copy Flow os applied. */
823 uint32_t rix_mreg_copy;
824 /**< Index to metadata register copy table resource. */
825 uint32_t counter; /**< Holds flow counter. */
826 uint16_t meter; /**< Holds flow meter id. */
829 typedef int (*mlx5_flow_validate_t)(struct rte_eth_dev *dev,
830 const struct rte_flow_attr *attr,
831 const struct rte_flow_item items[],
832 const struct rte_flow_action actions[],
835 struct rte_flow_error *error);
836 typedef struct mlx5_flow *(*mlx5_flow_prepare_t)
837 (struct rte_eth_dev *dev, const struct rte_flow_attr *attr,
838 const struct rte_flow_item items[],
839 const struct rte_flow_action actions[], struct rte_flow_error *error);
840 typedef int (*mlx5_flow_translate_t)(struct rte_eth_dev *dev,
841 struct mlx5_flow *dev_flow,
842 const struct rte_flow_attr *attr,
843 const struct rte_flow_item items[],
844 const struct rte_flow_action actions[],
845 struct rte_flow_error *error);
846 typedef int (*mlx5_flow_apply_t)(struct rte_eth_dev *dev, struct rte_flow *flow,
847 struct rte_flow_error *error);
848 typedef void (*mlx5_flow_remove_t)(struct rte_eth_dev *dev,
849 struct rte_flow *flow);
850 typedef void (*mlx5_flow_destroy_t)(struct rte_eth_dev *dev,
851 struct rte_flow *flow);
852 typedef int (*mlx5_flow_query_t)(struct rte_eth_dev *dev,
853 struct rte_flow *flow,
854 const struct rte_flow_action *actions,
856 struct rte_flow_error *error);
857 typedef struct mlx5_meter_domains_infos *(*mlx5_flow_create_mtr_tbls_t)
858 (struct rte_eth_dev *dev,
859 const struct mlx5_flow_meter *fm);
860 typedef int (*mlx5_flow_destroy_mtr_tbls_t)(struct rte_eth_dev *dev,
861 struct mlx5_meter_domains_infos *tbls);
862 typedef int (*mlx5_flow_create_policer_rules_t)
863 (struct rte_eth_dev *dev,
864 struct mlx5_flow_meter *fm,
865 const struct rte_flow_attr *attr);
866 typedef int (*mlx5_flow_destroy_policer_rules_t)
867 (struct rte_eth_dev *dev,
868 const struct mlx5_flow_meter *fm,
869 const struct rte_flow_attr *attr);
870 typedef uint32_t (*mlx5_flow_counter_alloc_t)
871 (struct rte_eth_dev *dev);
872 typedef void (*mlx5_flow_counter_free_t)(struct rte_eth_dev *dev,
874 typedef int (*mlx5_flow_counter_query_t)(struct rte_eth_dev *dev,
876 bool clear, uint64_t *pkts,
878 struct mlx5_flow_driver_ops {
879 mlx5_flow_validate_t validate;
880 mlx5_flow_prepare_t prepare;
881 mlx5_flow_translate_t translate;
882 mlx5_flow_apply_t apply;
883 mlx5_flow_remove_t remove;
884 mlx5_flow_destroy_t destroy;
885 mlx5_flow_query_t query;
886 mlx5_flow_create_mtr_tbls_t create_mtr_tbls;
887 mlx5_flow_destroy_mtr_tbls_t destroy_mtr_tbls;
888 mlx5_flow_create_policer_rules_t create_policer_rules;
889 mlx5_flow_destroy_policer_rules_t destroy_policer_rules;
890 mlx5_flow_counter_alloc_t counter_alloc;
891 mlx5_flow_counter_free_t counter_free;
892 mlx5_flow_counter_query_t counter_query;
896 #define MLX5_CNT_CONTAINER(sh, batch, thread) (&(sh)->cmng.ccont \
897 [(((sh)->cmng.mhi[batch] >> (thread)) & 0x1) * 2 + (batch)])
898 #define MLX5_CNT_CONTAINER_UNUSED(sh, batch, thread) (&(sh)->cmng.ccont \
899 [(~((sh)->cmng.mhi[batch] >> (thread)) & 0x1) * 2 + (batch)])
903 struct mlx5_flow_id_pool *mlx5_flow_id_pool_alloc(uint32_t max_id);
904 void mlx5_flow_id_pool_release(struct mlx5_flow_id_pool *pool);
905 uint32_t mlx5_flow_id_get(struct mlx5_flow_id_pool *pool, uint32_t *id);
906 uint32_t mlx5_flow_id_release(struct mlx5_flow_id_pool *pool,
908 int mlx5_flow_group_to_table(const struct rte_flow_attr *attributes,
909 bool external, uint32_t group, bool fdb_def_rule,
910 uint32_t *table, struct rte_flow_error *error);
911 uint64_t mlx5_flow_hashfields_adjust(struct mlx5_flow_rss_desc *rss_desc,
912 int tunnel, uint64_t layer_types,
913 uint64_t hash_fields);
914 uint32_t mlx5_flow_adjust_priority(struct rte_eth_dev *dev, int32_t priority,
915 uint32_t subpriority);
916 int mlx5_flow_get_reg_id(struct rte_eth_dev *dev,
917 enum mlx5_feature_name feature,
919 struct rte_flow_error *error);
920 const struct rte_flow_action *mlx5_flow_find_action
921 (const struct rte_flow_action *actions,
922 enum rte_flow_action_type action);
923 int mlx5_flow_validate_action_count(struct rte_eth_dev *dev,
924 const struct rte_flow_attr *attr,
925 struct rte_flow_error *error);
926 int mlx5_flow_validate_action_drop(uint64_t action_flags,
927 const struct rte_flow_attr *attr,
928 struct rte_flow_error *error);
929 int mlx5_flow_validate_action_flag(uint64_t action_flags,
930 const struct rte_flow_attr *attr,
931 struct rte_flow_error *error);
932 int mlx5_flow_validate_action_mark(const struct rte_flow_action *action,
933 uint64_t action_flags,
934 const struct rte_flow_attr *attr,
935 struct rte_flow_error *error);
936 int mlx5_flow_validate_action_queue(const struct rte_flow_action *action,
937 uint64_t action_flags,
938 struct rte_eth_dev *dev,
939 const struct rte_flow_attr *attr,
940 struct rte_flow_error *error);
941 int mlx5_flow_validate_action_rss(const struct rte_flow_action *action,
942 uint64_t action_flags,
943 struct rte_eth_dev *dev,
944 const struct rte_flow_attr *attr,
946 struct rte_flow_error *error);
947 int mlx5_flow_validate_attributes(struct rte_eth_dev *dev,
948 const struct rte_flow_attr *attributes,
949 struct rte_flow_error *error);
950 int mlx5_flow_item_acceptable(const struct rte_flow_item *item,
952 const uint8_t *nic_mask,
954 struct rte_flow_error *error);
955 int mlx5_flow_validate_item_eth(const struct rte_flow_item *item,
957 struct rte_flow_error *error);
958 int mlx5_flow_validate_item_gre(const struct rte_flow_item *item,
960 uint8_t target_protocol,
961 struct rte_flow_error *error);
962 int mlx5_flow_validate_item_gre_key(const struct rte_flow_item *item,
964 const struct rte_flow_item *gre_item,
965 struct rte_flow_error *error);
966 int mlx5_flow_validate_item_ipv4(const struct rte_flow_item *item,
970 const struct rte_flow_item_ipv4 *acc_mask,
971 struct rte_flow_error *error);
972 int mlx5_flow_validate_item_ipv6(const struct rte_flow_item *item,
976 const struct rte_flow_item_ipv6 *acc_mask,
977 struct rte_flow_error *error);
978 int mlx5_flow_validate_item_mpls(struct rte_eth_dev *dev,
979 const struct rte_flow_item *item,
982 struct rte_flow_error *error);
983 int mlx5_flow_validate_item_tcp(const struct rte_flow_item *item,
985 uint8_t target_protocol,
986 const struct rte_flow_item_tcp *flow_mask,
987 struct rte_flow_error *error);
988 int mlx5_flow_validate_item_udp(const struct rte_flow_item *item,
990 uint8_t target_protocol,
991 struct rte_flow_error *error);
992 int mlx5_flow_validate_item_vlan(const struct rte_flow_item *item,
994 struct rte_eth_dev *dev,
995 struct rte_flow_error *error);
996 int mlx5_flow_validate_item_vxlan(const struct rte_flow_item *item,
998 struct rte_flow_error *error);
999 int mlx5_flow_validate_item_vxlan_gpe(const struct rte_flow_item *item,
1000 uint64_t item_flags,
1001 struct rte_eth_dev *dev,
1002 struct rte_flow_error *error);
1003 int mlx5_flow_validate_item_icmp(const struct rte_flow_item *item,
1004 uint64_t item_flags,
1005 uint8_t target_protocol,
1006 struct rte_flow_error *error);
1007 int mlx5_flow_validate_item_icmp6(const struct rte_flow_item *item,
1008 uint64_t item_flags,
1009 uint8_t target_protocol,
1010 struct rte_flow_error *error);
1011 int mlx5_flow_validate_item_nvgre(const struct rte_flow_item *item,
1012 uint64_t item_flags,
1013 uint8_t target_protocol,
1014 struct rte_flow_error *error);
1015 int mlx5_flow_validate_item_geneve(const struct rte_flow_item *item,
1016 uint64_t item_flags,
1017 struct rte_eth_dev *dev,
1018 struct rte_flow_error *error);
1019 struct mlx5_meter_domains_infos *mlx5_flow_create_mtr_tbls
1020 (struct rte_eth_dev *dev,
1021 const struct mlx5_flow_meter *fm);
1022 int mlx5_flow_destroy_mtr_tbls(struct rte_eth_dev *dev,
1023 struct mlx5_meter_domains_infos *tbl);
1024 int mlx5_flow_create_policer_rules(struct rte_eth_dev *dev,
1025 struct mlx5_flow_meter *fm,
1026 const struct rte_flow_attr *attr);
1027 int mlx5_flow_destroy_policer_rules(struct rte_eth_dev *dev,
1028 struct mlx5_flow_meter *fm,
1029 const struct rte_flow_attr *attr);
1030 int mlx5_flow_meter_flush(struct rte_eth_dev *dev,
1031 struct rte_mtr_error *error);
1032 #endif /* RTE_PMD_MLX5_FLOW_H_ */