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>
14 #include <rte_alarm.h>
17 #include <mlx5_glue.h>
22 /* Private rte flow items. */
23 enum mlx5_rte_flow_item_type {
24 MLX5_RTE_FLOW_ITEM_TYPE_END = INT_MIN,
25 MLX5_RTE_FLOW_ITEM_TYPE_TAG,
26 MLX5_RTE_FLOW_ITEM_TYPE_TX_QUEUE,
27 MLX5_RTE_FLOW_ITEM_TYPE_VLAN,
28 MLX5_RTE_FLOW_ITEM_TYPE_TUNNEL,
31 /* Private (internal) rte flow actions. */
32 enum mlx5_rte_flow_action_type {
33 MLX5_RTE_FLOW_ACTION_TYPE_END = INT_MIN,
34 MLX5_RTE_FLOW_ACTION_TYPE_TAG,
35 MLX5_RTE_FLOW_ACTION_TYPE_MARK,
36 MLX5_RTE_FLOW_ACTION_TYPE_COPY_MREG,
37 MLX5_RTE_FLOW_ACTION_TYPE_DEFAULT_MISS,
38 MLX5_RTE_FLOW_ACTION_TYPE_SHARED_RSS,
39 MLX5_RTE_FLOW_ACTION_TYPE_TUNNEL_SET,
42 /* Matches on selected register. */
43 struct mlx5_rte_flow_item_tag {
48 /* Modify selected register. */
49 struct mlx5_rte_flow_action_set_tag {
54 struct mlx5_flow_action_copy_mreg {
59 /* Matches on source queue. */
60 struct mlx5_rte_flow_item_tx_queue {
64 /* Feature name to allocate metadata register. */
65 enum mlx5_feature_name {
78 /* Default queue number. */
79 #define MLX5_RSSQ_DEFAULT_NUM 16
81 #define MLX5_FLOW_LAYER_OUTER_L2 (1u << 0)
82 #define MLX5_FLOW_LAYER_OUTER_L3_IPV4 (1u << 1)
83 #define MLX5_FLOW_LAYER_OUTER_L3_IPV6 (1u << 2)
84 #define MLX5_FLOW_LAYER_OUTER_L4_UDP (1u << 3)
85 #define MLX5_FLOW_LAYER_OUTER_L4_TCP (1u << 4)
86 #define MLX5_FLOW_LAYER_OUTER_VLAN (1u << 5)
88 /* Pattern inner Layer bits. */
89 #define MLX5_FLOW_LAYER_INNER_L2 (1u << 6)
90 #define MLX5_FLOW_LAYER_INNER_L3_IPV4 (1u << 7)
91 #define MLX5_FLOW_LAYER_INNER_L3_IPV6 (1u << 8)
92 #define MLX5_FLOW_LAYER_INNER_L4_UDP (1u << 9)
93 #define MLX5_FLOW_LAYER_INNER_L4_TCP (1u << 10)
94 #define MLX5_FLOW_LAYER_INNER_VLAN (1u << 11)
96 /* Pattern tunnel Layer bits. */
97 #define MLX5_FLOW_LAYER_VXLAN (1u << 12)
98 #define MLX5_FLOW_LAYER_VXLAN_GPE (1u << 13)
99 #define MLX5_FLOW_LAYER_GRE (1u << 14)
100 #define MLX5_FLOW_LAYER_MPLS (1u << 15)
101 /* List of tunnel Layer bits continued below. */
103 /* General pattern items bits. */
104 #define MLX5_FLOW_ITEM_METADATA (1u << 16)
105 #define MLX5_FLOW_ITEM_PORT_ID (1u << 17)
106 #define MLX5_FLOW_ITEM_TAG (1u << 18)
107 #define MLX5_FLOW_ITEM_MARK (1u << 19)
109 /* Pattern MISC bits. */
110 #define MLX5_FLOW_LAYER_ICMP (1u << 20)
111 #define MLX5_FLOW_LAYER_ICMP6 (1u << 21)
112 #define MLX5_FLOW_LAYER_GRE_KEY (1u << 22)
114 /* Pattern tunnel Layer bits (continued). */
115 #define MLX5_FLOW_LAYER_IPIP (1u << 23)
116 #define MLX5_FLOW_LAYER_IPV6_ENCAP (1u << 24)
117 #define MLX5_FLOW_LAYER_NVGRE (1u << 25)
118 #define MLX5_FLOW_LAYER_GENEVE (1u << 26)
121 #define MLX5_FLOW_ITEM_TX_QUEUE (1u << 27)
123 /* Pattern tunnel Layer bits (continued). */
124 #define MLX5_FLOW_LAYER_GTP (1u << 28)
126 /* Pattern eCPRI Layer bit. */
127 #define MLX5_FLOW_LAYER_ECPRI (UINT64_C(1) << 29)
129 /* IPv6 Fragment Extension Header bit. */
130 #define MLX5_FLOW_LAYER_OUTER_L3_IPV6_FRAG_EXT (1u << 30)
131 #define MLX5_FLOW_LAYER_INNER_L3_IPV6_FRAG_EXT (1u << 31)
134 #define MLX5_FLOW_LAYER_OUTER_L3 \
135 (MLX5_FLOW_LAYER_OUTER_L3_IPV4 | MLX5_FLOW_LAYER_OUTER_L3_IPV6)
136 #define MLX5_FLOW_LAYER_OUTER_L4 \
137 (MLX5_FLOW_LAYER_OUTER_L4_UDP | MLX5_FLOW_LAYER_OUTER_L4_TCP)
138 #define MLX5_FLOW_LAYER_OUTER \
139 (MLX5_FLOW_LAYER_OUTER_L2 | MLX5_FLOW_LAYER_OUTER_L3 | \
140 MLX5_FLOW_LAYER_OUTER_L4)
143 #define MLX5_FLOW_LAYER_TUNNEL \
144 (MLX5_FLOW_LAYER_VXLAN | MLX5_FLOW_LAYER_VXLAN_GPE | \
145 MLX5_FLOW_LAYER_GRE | MLX5_FLOW_LAYER_NVGRE | MLX5_FLOW_LAYER_MPLS | \
146 MLX5_FLOW_LAYER_IPIP | MLX5_FLOW_LAYER_IPV6_ENCAP | \
147 MLX5_FLOW_LAYER_GENEVE | MLX5_FLOW_LAYER_GTP)
150 #define MLX5_FLOW_LAYER_INNER_L3 \
151 (MLX5_FLOW_LAYER_INNER_L3_IPV4 | MLX5_FLOW_LAYER_INNER_L3_IPV6)
152 #define MLX5_FLOW_LAYER_INNER_L4 \
153 (MLX5_FLOW_LAYER_INNER_L4_UDP | MLX5_FLOW_LAYER_INNER_L4_TCP)
154 #define MLX5_FLOW_LAYER_INNER \
155 (MLX5_FLOW_LAYER_INNER_L2 | MLX5_FLOW_LAYER_INNER_L3 | \
156 MLX5_FLOW_LAYER_INNER_L4)
159 #define MLX5_FLOW_LAYER_L2 \
160 (MLX5_FLOW_LAYER_OUTER_L2 | MLX5_FLOW_LAYER_INNER_L2)
161 #define MLX5_FLOW_LAYER_L3_IPV4 \
162 (MLX5_FLOW_LAYER_OUTER_L3_IPV4 | MLX5_FLOW_LAYER_INNER_L3_IPV4)
163 #define MLX5_FLOW_LAYER_L3_IPV6 \
164 (MLX5_FLOW_LAYER_OUTER_L3_IPV6 | MLX5_FLOW_LAYER_INNER_L3_IPV6)
165 #define MLX5_FLOW_LAYER_L3 \
166 (MLX5_FLOW_LAYER_L3_IPV4 | MLX5_FLOW_LAYER_L3_IPV6)
167 #define MLX5_FLOW_LAYER_L4 \
168 (MLX5_FLOW_LAYER_OUTER_L4 | MLX5_FLOW_LAYER_INNER_L4)
171 #define MLX5_FLOW_ACTION_DROP (1u << 0)
172 #define MLX5_FLOW_ACTION_QUEUE (1u << 1)
173 #define MLX5_FLOW_ACTION_RSS (1u << 2)
174 #define MLX5_FLOW_ACTION_FLAG (1u << 3)
175 #define MLX5_FLOW_ACTION_MARK (1u << 4)
176 #define MLX5_FLOW_ACTION_COUNT (1u << 5)
177 #define MLX5_FLOW_ACTION_PORT_ID (1u << 6)
178 #define MLX5_FLOW_ACTION_OF_POP_VLAN (1u << 7)
179 #define MLX5_FLOW_ACTION_OF_PUSH_VLAN (1u << 8)
180 #define MLX5_FLOW_ACTION_OF_SET_VLAN_VID (1u << 9)
181 #define MLX5_FLOW_ACTION_OF_SET_VLAN_PCP (1u << 10)
182 #define MLX5_FLOW_ACTION_SET_IPV4_SRC (1u << 11)
183 #define MLX5_FLOW_ACTION_SET_IPV4_DST (1u << 12)
184 #define MLX5_FLOW_ACTION_SET_IPV6_SRC (1u << 13)
185 #define MLX5_FLOW_ACTION_SET_IPV6_DST (1u << 14)
186 #define MLX5_FLOW_ACTION_SET_TP_SRC (1u << 15)
187 #define MLX5_FLOW_ACTION_SET_TP_DST (1u << 16)
188 #define MLX5_FLOW_ACTION_JUMP (1u << 17)
189 #define MLX5_FLOW_ACTION_SET_TTL (1u << 18)
190 #define MLX5_FLOW_ACTION_DEC_TTL (1u << 19)
191 #define MLX5_FLOW_ACTION_SET_MAC_SRC (1u << 20)
192 #define MLX5_FLOW_ACTION_SET_MAC_DST (1u << 21)
193 #define MLX5_FLOW_ACTION_ENCAP (1u << 22)
194 #define MLX5_FLOW_ACTION_DECAP (1u << 23)
195 #define MLX5_FLOW_ACTION_INC_TCP_SEQ (1u << 24)
196 #define MLX5_FLOW_ACTION_DEC_TCP_SEQ (1u << 25)
197 #define MLX5_FLOW_ACTION_INC_TCP_ACK (1u << 26)
198 #define MLX5_FLOW_ACTION_DEC_TCP_ACK (1u << 27)
199 #define MLX5_FLOW_ACTION_SET_TAG (1ull << 28)
200 #define MLX5_FLOW_ACTION_MARK_EXT (1ull << 29)
201 #define MLX5_FLOW_ACTION_SET_META (1ull << 30)
202 #define MLX5_FLOW_ACTION_METER (1ull << 31)
203 #define MLX5_FLOW_ACTION_SET_IPV4_DSCP (1ull << 32)
204 #define MLX5_FLOW_ACTION_SET_IPV6_DSCP (1ull << 33)
205 #define MLX5_FLOW_ACTION_AGE (1ull << 34)
206 #define MLX5_FLOW_ACTION_DEFAULT_MISS (1ull << 35)
207 #define MLX5_FLOW_ACTION_SAMPLE (1ull << 36)
208 #define MLX5_FLOW_ACTION_TUNNEL_SET (1ull << 37)
209 #define MLX5_FLOW_ACTION_TUNNEL_MATCH (1ull << 38)
211 #define MLX5_FLOW_FATE_ACTIONS \
212 (MLX5_FLOW_ACTION_DROP | MLX5_FLOW_ACTION_QUEUE | \
213 MLX5_FLOW_ACTION_RSS | MLX5_FLOW_ACTION_JUMP | \
214 MLX5_FLOW_ACTION_DEFAULT_MISS)
216 #define MLX5_FLOW_FATE_ESWITCH_ACTIONS \
217 (MLX5_FLOW_ACTION_DROP | MLX5_FLOW_ACTION_PORT_ID | \
218 MLX5_FLOW_ACTION_JUMP)
221 #define MLX5_FLOW_MODIFY_HDR_ACTIONS (MLX5_FLOW_ACTION_SET_IPV4_SRC | \
222 MLX5_FLOW_ACTION_SET_IPV4_DST | \
223 MLX5_FLOW_ACTION_SET_IPV6_SRC | \
224 MLX5_FLOW_ACTION_SET_IPV6_DST | \
225 MLX5_FLOW_ACTION_SET_TP_SRC | \
226 MLX5_FLOW_ACTION_SET_TP_DST | \
227 MLX5_FLOW_ACTION_SET_TTL | \
228 MLX5_FLOW_ACTION_DEC_TTL | \
229 MLX5_FLOW_ACTION_SET_MAC_SRC | \
230 MLX5_FLOW_ACTION_SET_MAC_DST | \
231 MLX5_FLOW_ACTION_INC_TCP_SEQ | \
232 MLX5_FLOW_ACTION_DEC_TCP_SEQ | \
233 MLX5_FLOW_ACTION_INC_TCP_ACK | \
234 MLX5_FLOW_ACTION_DEC_TCP_ACK | \
235 MLX5_FLOW_ACTION_OF_SET_VLAN_VID | \
236 MLX5_FLOW_ACTION_SET_TAG | \
237 MLX5_FLOW_ACTION_MARK_EXT | \
238 MLX5_FLOW_ACTION_SET_META | \
239 MLX5_FLOW_ACTION_SET_IPV4_DSCP | \
240 MLX5_FLOW_ACTION_SET_IPV6_DSCP)
242 #define MLX5_FLOW_VLAN_ACTIONS (MLX5_FLOW_ACTION_OF_POP_VLAN | \
243 MLX5_FLOW_ACTION_OF_PUSH_VLAN)
245 #define MLX5_FLOW_XCAP_ACTIONS (MLX5_FLOW_ACTION_ENCAP | MLX5_FLOW_ACTION_DECAP)
248 #define IPPROTO_MPLS 137
251 /* UDP port number for MPLS */
252 #define MLX5_UDP_PORT_MPLS 6635
254 /* UDP port numbers for VxLAN. */
255 #define MLX5_UDP_PORT_VXLAN 4789
256 #define MLX5_UDP_PORT_VXLAN_GPE 4790
258 /* UDP port numbers for GENEVE. */
259 #define MLX5_UDP_PORT_GENEVE 6081
261 /* Priority reserved for default flows. */
262 #define MLX5_FLOW_PRIO_RSVD ((uint32_t)-1)
265 * Number of sub priorities.
266 * For each kind of pattern matching i.e. L2, L3, L4 to have a correct
267 * matching on the NIC (firmware dependent) L4 most have the higher priority
268 * followed by L3 and ending with L2.
270 #define MLX5_PRIORITY_MAP_L2 2
271 #define MLX5_PRIORITY_MAP_L3 1
272 #define MLX5_PRIORITY_MAP_L4 0
273 #define MLX5_PRIORITY_MAP_MAX 3
275 /* Valid layer type for IPV4 RSS. */
276 #define MLX5_IPV4_LAYER_TYPES \
277 (ETH_RSS_IPV4 | ETH_RSS_FRAG_IPV4 | \
278 ETH_RSS_NONFRAG_IPV4_TCP | ETH_RSS_NONFRAG_IPV4_UDP | \
279 ETH_RSS_NONFRAG_IPV4_OTHER)
281 /* IBV hash source bits for IPV4. */
282 #define MLX5_IPV4_IBV_RX_HASH (IBV_RX_HASH_SRC_IPV4 | IBV_RX_HASH_DST_IPV4)
284 /* Valid layer type for IPV6 RSS. */
285 #define MLX5_IPV6_LAYER_TYPES \
286 (ETH_RSS_IPV6 | ETH_RSS_FRAG_IPV6 | ETH_RSS_NONFRAG_IPV6_TCP | \
287 ETH_RSS_NONFRAG_IPV6_UDP | ETH_RSS_IPV6_EX | ETH_RSS_IPV6_TCP_EX | \
288 ETH_RSS_IPV6_UDP_EX | ETH_RSS_NONFRAG_IPV6_OTHER)
290 /* IBV hash source bits for IPV6. */
291 #define MLX5_IPV6_IBV_RX_HASH (IBV_RX_HASH_SRC_IPV6 | IBV_RX_HASH_DST_IPV6)
293 /* IBV hash bits for L3 SRC. */
294 #define MLX5_L3_SRC_IBV_RX_HASH (IBV_RX_HASH_SRC_IPV4 | IBV_RX_HASH_SRC_IPV6)
296 /* IBV hash bits for L3 DST. */
297 #define MLX5_L3_DST_IBV_RX_HASH (IBV_RX_HASH_DST_IPV4 | IBV_RX_HASH_DST_IPV6)
299 /* IBV hash bits for TCP. */
300 #define MLX5_TCP_IBV_RX_HASH (IBV_RX_HASH_SRC_PORT_TCP | \
301 IBV_RX_HASH_DST_PORT_TCP)
303 /* IBV hash bits for UDP. */
304 #define MLX5_UDP_IBV_RX_HASH (IBV_RX_HASH_SRC_PORT_UDP | \
305 IBV_RX_HASH_DST_PORT_UDP)
307 /* IBV hash bits for L4 SRC. */
308 #define MLX5_L4_SRC_IBV_RX_HASH (IBV_RX_HASH_SRC_PORT_TCP | \
309 IBV_RX_HASH_SRC_PORT_UDP)
311 /* IBV hash bits for L4 DST. */
312 #define MLX5_L4_DST_IBV_RX_HASH (IBV_RX_HASH_DST_PORT_TCP | \
313 IBV_RX_HASH_DST_PORT_UDP)
315 /* Geneve header first 16Bit */
316 #define MLX5_GENEVE_VER_MASK 0x3
317 #define MLX5_GENEVE_VER_SHIFT 14
318 #define MLX5_GENEVE_VER_VAL(a) \
319 (((a) >> (MLX5_GENEVE_VER_SHIFT)) & (MLX5_GENEVE_VER_MASK))
320 #define MLX5_GENEVE_OPTLEN_MASK 0x3F
321 #define MLX5_GENEVE_OPTLEN_SHIFT 7
322 #define MLX5_GENEVE_OPTLEN_VAL(a) \
323 (((a) >> (MLX5_GENEVE_OPTLEN_SHIFT)) & (MLX5_GENEVE_OPTLEN_MASK))
324 #define MLX5_GENEVE_OAMF_MASK 0x1
325 #define MLX5_GENEVE_OAMF_SHIFT 7
326 #define MLX5_GENEVE_OAMF_VAL(a) \
327 (((a) >> (MLX5_GENEVE_OAMF_SHIFT)) & (MLX5_GENEVE_OAMF_MASK))
328 #define MLX5_GENEVE_CRITO_MASK 0x1
329 #define MLX5_GENEVE_CRITO_SHIFT 6
330 #define MLX5_GENEVE_CRITO_VAL(a) \
331 (((a) >> (MLX5_GENEVE_CRITO_SHIFT)) & (MLX5_GENEVE_CRITO_MASK))
332 #define MLX5_GENEVE_RSVD_MASK 0x3F
333 #define MLX5_GENEVE_RSVD_VAL(a) ((a) & (MLX5_GENEVE_RSVD_MASK))
335 * The length of the Geneve options fields, expressed in four byte multiples,
336 * not including the eight byte fixed tunnel.
338 #define MLX5_GENEVE_OPT_LEN_0 14
339 #define MLX5_GENEVE_OPT_LEN_1 63
341 #define MLX5_ENCAPSULATION_DECISION_SIZE (sizeof(struct rte_flow_item_eth) + \
342 sizeof(struct rte_flow_item_ipv4))
344 /* IPv4 fragment_offset field contains relevant data in bits 2 to 15. */
345 #define MLX5_IPV4_FRAG_OFFSET_MASK \
346 (RTE_IPV4_HDR_OFFSET_MASK | RTE_IPV4_HDR_MF_FLAG)
348 /* Specific item's fields can accept a range of values (using spec and last). */
349 #define MLX5_ITEM_RANGE_NOT_ACCEPTED false
350 #define MLX5_ITEM_RANGE_ACCEPTED true
352 /* Software header modify action numbers of a flow. */
353 #define MLX5_ACT_NUM_MDF_IPV4 1
354 #define MLX5_ACT_NUM_MDF_IPV6 4
355 #define MLX5_ACT_NUM_MDF_MAC 2
356 #define MLX5_ACT_NUM_MDF_VID 1
357 #define MLX5_ACT_NUM_MDF_PORT 2
358 #define MLX5_ACT_NUM_MDF_TTL 1
359 #define MLX5_ACT_NUM_DEC_TTL MLX5_ACT_NUM_MDF_TTL
360 #define MLX5_ACT_NUM_MDF_TCPSEQ 1
361 #define MLX5_ACT_NUM_MDF_TCPACK 1
362 #define MLX5_ACT_NUM_SET_REG 1
363 #define MLX5_ACT_NUM_SET_TAG 1
364 #define MLX5_ACT_NUM_CPY_MREG MLX5_ACT_NUM_SET_TAG
365 #define MLX5_ACT_NUM_SET_MARK MLX5_ACT_NUM_SET_TAG
366 #define MLX5_ACT_NUM_SET_META MLX5_ACT_NUM_SET_TAG
367 #define MLX5_ACT_NUM_SET_DSCP 1
369 enum mlx5_flow_drv_type {
372 MLX5_FLOW_TYPE_VERBS,
376 /* Fate action type. */
377 enum mlx5_flow_fate_type {
378 MLX5_FLOW_FATE_NONE, /* Egress flow. */
379 MLX5_FLOW_FATE_QUEUE,
381 MLX5_FLOW_FATE_PORT_ID,
383 MLX5_FLOW_FATE_DEFAULT_MISS,
387 /* Matcher PRM representation */
388 struct mlx5_flow_dv_match_params {
390 /**< Size of match value. Do NOT split size and key! */
391 uint32_t buf[MLX5_ST_SZ_DW(fte_match_param)];
392 /**< Matcher value. This value is used as the mask or as a key. */
395 /* Matcher structure. */
396 struct mlx5_flow_dv_matcher {
397 LIST_ENTRY(mlx5_flow_dv_matcher) next;
398 /**< Pointer to the next element. */
399 struct mlx5_flow_tbl_resource *tbl;
400 /**< Pointer to the table(group) the matcher associated with. */
401 uint32_t refcnt; /**< Reference counter. */
402 void *matcher_object; /**< Pointer to DV matcher */
403 uint16_t crc; /**< CRC of key. */
404 uint16_t priority; /**< Priority of matcher. */
405 struct mlx5_flow_dv_match_params mask; /**< Matcher mask. */
408 #define MLX5_ENCAP_MAX_LEN 132
410 /* Encap/decap resource key of the hash organization. */
411 union mlx5_flow_encap_decap_key {
413 uint32_t ft_type:8; /**< Flow table type, Rx or Tx. */
414 uint32_t refmt_type:8; /**< Header reformat type. */
415 uint32_t buf_size:8; /**< Encap buf size. */
416 uint32_t table_level:8; /**< Root table or not. */
417 uint32_t cksum; /**< Encap buf check sum. */
419 uint64_t v64; /**< full 64bits value of key */
422 /* Encap/decap resource structure. */
423 struct mlx5_flow_dv_encap_decap_resource {
424 struct mlx5_hlist_entry entry;
425 /* Pointer to next element. */
426 uint32_t refcnt; /**< Reference counter. */
428 /**< Encap/decap action object. */
429 uint8_t buf[MLX5_ENCAP_MAX_LEN];
431 uint8_t reformat_type;
433 uint64_t flags; /**< Flags for RDMA API. */
434 uint32_t idx; /**< Index for the index memory pool. */
437 /* Tag resource structure. */
438 struct mlx5_flow_dv_tag_resource {
439 struct mlx5_hlist_entry entry;
440 /**< hash list entry for tag resource, tag value as the key. */
442 /**< Tag action object. */
443 uint32_t refcnt; /**< Reference counter. */
444 uint32_t idx; /**< Index for the index memory pool. */
448 * Number of modification commands.
449 * The maximal actions amount in FW is some constant, and it is 16 in the
450 * latest releases. In some old releases, it will be limited to 8.
451 * Since there is no interface to query the capacity, the maximal value should
452 * be used to allow PMD to create the flow. The validation will be done in the
453 * lower driver layer or FW. A failure will be returned if exceeds the maximal
454 * supported actions number on the root table.
455 * On non-root tables, there is no limitation, but 32 is enough right now.
457 #define MLX5_MAX_MODIFY_NUM 32
458 #define MLX5_ROOT_TBL_MODIFY_NUM 16
460 /* Modify resource structure */
461 struct mlx5_flow_dv_modify_hdr_resource {
462 struct mlx5_hlist_entry entry;
463 void *action; /**< Modify header action object. */
464 /* Key area for hash list matching: */
465 uint8_t ft_type; /**< Flow table type, Rx or Tx. */
466 uint32_t actions_num; /**< Number of modification actions. */
467 uint64_t flags; /**< Flags for RDMA API. */
468 struct mlx5_modification_cmd actions[];
469 /**< Modification actions. */
472 /* Modify resource key of the hash organization. */
473 union mlx5_flow_modify_hdr_key {
475 uint32_t ft_type:8; /**< Flow table type, Rx or Tx. */
476 uint32_t actions_num:5; /**< Number of modification actions. */
477 uint32_t group:19; /**< Flow group id. */
478 uint32_t cksum; /**< Actions check sum. */
480 uint64_t v64; /**< full 64bits value of key */
483 /* Jump action resource structure. */
484 struct mlx5_flow_dv_jump_tbl_resource {
485 void *action; /**< Pointer to the rdma core action. */
488 /* Port ID resource structure. */
489 struct mlx5_flow_dv_port_id_action_resource {
490 ILIST_ENTRY(uint32_t)next;
491 /* Pointer to next element. */
492 uint32_t refcnt; /**< Reference counter. */
494 /**< Action object. */
495 uint32_t port_id; /**< Port ID value. */
498 /* Push VLAN action resource structure */
499 struct mlx5_flow_dv_push_vlan_action_resource {
500 ILIST_ENTRY(uint32_t)next;
501 /* Pointer to next element. */
502 uint32_t refcnt; /**< Reference counter. */
503 void *action; /**< Action object. */
504 uint8_t ft_type; /**< Flow table type, Rx, Tx or FDB. */
505 rte_be32_t vlan_tag; /**< VLAN tag value. */
508 /* Metadata register copy table entry. */
509 struct mlx5_flow_mreg_copy_resource {
511 * Hash list entry for copy table.
512 * - Key is 32/64-bit MARK action ID.
513 * - MUST be the first entry.
515 struct mlx5_hlist_entry hlist_ent;
516 LIST_ENTRY(mlx5_flow_mreg_copy_resource) next;
517 /* List entry for device flows. */
519 uint32_t rix_flow; /* Built flow for copy. */
522 /* Table tunnel parameter. */
523 struct mlx5_flow_tbl_tunnel_prm {
524 const struct mlx5_flow_tunnel *tunnel;
529 /* Table data structure of the hash organization. */
530 struct mlx5_flow_tbl_data_entry {
531 struct mlx5_hlist_entry entry;
532 /**< hash list entry, 64-bits key inside. */
533 struct mlx5_flow_tbl_resource tbl;
534 /**< flow table resource. */
535 LIST_HEAD(matchers, mlx5_flow_dv_matcher) matchers;
536 /**< matchers' header associated with the flow table. */
537 struct mlx5_flow_dv_jump_tbl_resource jump;
538 /**< jump resource, at most one for each table created. */
539 uint32_t idx; /**< index for the indexed mempool. */
540 /**< tunnel offload */
541 const struct mlx5_flow_tunnel *tunnel;
544 bool tunnel_offload; /* Tunnel offlod table or not. */
547 /* Sub rdma-core actions list. */
548 struct mlx5_flow_sub_actions_list {
549 uint32_t actions_num; /**< Number of sample actions. */
550 uint64_t action_flags;
551 void *dr_queue_action;
554 void *dr_port_id_action;
555 void *dr_encap_action;
558 /* Sample sub-actions resource list. */
559 struct mlx5_flow_sub_actions_idx {
560 uint32_t rix_hrxq; /**< Hash Rx queue object index. */
561 uint32_t rix_tag; /**< Index to the tag action. */
563 uint32_t rix_port_id_action; /**< Index to port ID action resource. */
564 uint32_t rix_encap_decap; /**< Index to encap/decap resource. */
567 /* Sample action resource structure. */
568 struct mlx5_flow_dv_sample_resource {
569 ILIST_ENTRY(uint32_t)next; /**< Pointer to next element. */
570 uint32_t refcnt; /**< Reference counter. */
571 void *verbs_action; /**< Verbs sample action object. */
572 uint8_t ft_type; /** Flow Table Type */
573 uint32_t ft_id; /** Flow Table Level */
574 uint32_t ratio; /** Sample Ratio */
575 uint64_t set_action; /** Restore reg_c0 value */
576 void *normal_path_tbl; /** Flow Table pointer */
577 void *default_miss; /** default_miss dr_action. */
578 struct mlx5_flow_sub_actions_idx sample_idx;
579 /**< Action index resources. */
580 struct mlx5_flow_sub_actions_list sample_act;
581 /**< Action resources. */
584 #define MLX5_MAX_DEST_NUM 2
586 /* Destination array action resource structure. */
587 struct mlx5_flow_dv_dest_array_resource {
588 ILIST_ENTRY(uint32_t)next; /**< Pointer to next element. */
589 uint32_t refcnt; /**< Reference counter. */
590 uint8_t ft_type; /** Flow Table Type */
591 uint8_t num_of_dest; /**< Number of destination actions. */
592 void *action; /**< Pointer to the rdma core action. */
593 struct mlx5_flow_sub_actions_idx sample_idx[MLX5_MAX_DEST_NUM];
594 /**< Action index resources. */
595 struct mlx5_flow_sub_actions_list sample_act[MLX5_MAX_DEST_NUM];
596 /**< Action resources. */
599 /* Verbs specification header. */
600 struct ibv_spec_header {
601 enum ibv_flow_spec_type type;
605 /* PMD flow priority for tunnel */
606 #define MLX5_TUNNEL_PRIO_GET(rss_desc) \
607 ((rss_desc)->level >= 2 ? MLX5_PRIORITY_MAP_L2 : MLX5_PRIORITY_MAP_L4)
610 /** Device flow handle structure for DV mode only. */
611 struct mlx5_flow_handle_dv {
613 struct mlx5_flow_dv_matcher *matcher; /**< Cache to matcher. */
614 struct mlx5_flow_dv_modify_hdr_resource *modify_hdr;
615 /**< Pointer to modify header resource in cache. */
616 uint32_t rix_encap_decap;
617 /**< Index to encap/decap resource in cache. */
618 uint32_t rix_push_vlan;
619 /**< Index to push VLAN action resource in cache. */
621 /**< Index to the tag action. */
623 /**< Index to sample action resource in cache. */
624 uint32_t rix_dest_array;
625 /**< Index to destination array resource in cache. */
628 /** Device flow handle structure: used both for creating & destroying. */
629 struct mlx5_flow_handle {
630 SILIST_ENTRY(uint32_t)next;
631 struct mlx5_vf_vlan vf_vlan; /**< Structure for VF VLAN workaround. */
632 /**< Index to next device flow handle. */
634 /**< Bit-fields of present layers, see MLX5_FLOW_LAYER_*. */
635 void *drv_flow; /**< pointer to driver flow object. */
636 uint32_t split_flow_id:28; /**< Sub flow unique match flow id. */
637 uint32_t mark:1; /**< Metadate rxq mark flag. */
638 uint32_t fate_action:3; /**< Fate action type. */
640 uint32_t rix_hrxq; /**< Hash Rx queue object index. */
641 uint32_t rix_jump; /**< Index to the jump action resource. */
642 uint32_t rix_port_id_action;
643 /**< Index to port ID action resource. */
645 /**< Generic value indicates the fate action. */
646 uint32_t rix_default_fate;
647 /**< Indicates default miss fate action. */
649 #ifdef HAVE_IBV_FLOW_DV_SUPPORT
650 struct mlx5_flow_handle_dv dvh;
655 * Size for Verbs device flow handle structure only. Do not use the DV only
656 * structure in Verbs. No DV flows attributes will be accessed.
657 * Macro offsetof() could also be used here.
659 #ifdef HAVE_IBV_FLOW_DV_SUPPORT
660 #define MLX5_FLOW_HANDLE_VERBS_SIZE \
661 (sizeof(struct mlx5_flow_handle) - sizeof(struct mlx5_flow_handle_dv))
663 #define MLX5_FLOW_HANDLE_VERBS_SIZE (sizeof(struct mlx5_flow_handle))
667 * Max number of actions per DV flow.
668 * See CREATE_FLOW_MAX_FLOW_ACTIONS_SUPPORTED
669 * in rdma-core file providers/mlx5/verbs.c.
671 #define MLX5_DV_MAX_NUMBER_OF_ACTIONS 8
673 /** Device flow structure only for DV flow creation. */
674 struct mlx5_flow_dv_workspace {
675 uint32_t group; /**< The group index. */
676 uint8_t transfer; /**< 1 if the flow is E-Switch flow. */
677 int actions_n; /**< number of actions. */
678 void *actions[MLX5_DV_MAX_NUMBER_OF_ACTIONS]; /**< Action list. */
679 struct mlx5_flow_dv_encap_decap_resource *encap_decap;
680 /**< Pointer to encap/decap resource in cache. */
681 struct mlx5_flow_dv_push_vlan_action_resource *push_vlan_res;
682 /**< Pointer to push VLAN action resource in cache. */
683 struct mlx5_flow_dv_tag_resource *tag_resource;
684 /**< pointer to the tag action. */
685 struct mlx5_flow_dv_port_id_action_resource *port_id_action;
686 /**< Pointer to port ID action resource. */
687 struct mlx5_flow_dv_jump_tbl_resource *jump;
688 /**< Pointer to the jump action resource. */
689 struct mlx5_flow_dv_match_params value;
690 /**< Holds the value that the packet is compared to. */
691 struct mlx5_flow_dv_sample_resource *sample_res;
692 /**< Pointer to the sample action resource. */
693 struct mlx5_flow_dv_dest_array_resource *dest_array_res;
694 /**< Pointer to the destination array resource. */
698 * Maximal Verbs flow specifications & actions size.
699 * Some elements are mutually exclusive, but enough space should be allocated.
700 * Tunnel cases: 1. Max 2 Ethernet + IP(v6 len > v4 len) + TCP/UDP headers.
701 * 2. One tunnel header (exception: GRE + MPLS),
702 * SPEC length: GRE == tunnel.
703 * Actions: 1. 1 Mark OR Flag.
704 * 2. 1 Drop (if any).
705 * 3. No limitation for counters, but it makes no sense to support too
706 * many counters in a single device flow.
708 #ifdef HAVE_IBV_DEVICE_MPLS_SUPPORT
709 #define MLX5_VERBS_MAX_SPEC_SIZE \
711 (2 * (sizeof(struct ibv_flow_spec_eth) + \
712 sizeof(struct ibv_flow_spec_ipv6) + \
713 sizeof(struct ibv_flow_spec_tcp_udp)) + \
714 sizeof(struct ibv_flow_spec_gre) + \
715 sizeof(struct ibv_flow_spec_mpls)) \
718 #define MLX5_VERBS_MAX_SPEC_SIZE \
720 (2 * (sizeof(struct ibv_flow_spec_eth) + \
721 sizeof(struct ibv_flow_spec_ipv6) + \
722 sizeof(struct ibv_flow_spec_tcp_udp)) + \
723 sizeof(struct ibv_flow_spec_tunnel)) \
727 #if defined(HAVE_IBV_DEVICE_COUNTERS_SET_V42) || \
728 defined(HAVE_IBV_DEVICE_COUNTERS_SET_V45)
729 #define MLX5_VERBS_MAX_ACT_SIZE \
731 sizeof(struct ibv_flow_spec_action_tag) + \
732 sizeof(struct ibv_flow_spec_action_drop) + \
733 sizeof(struct ibv_flow_spec_counter_action) * 4 \
736 #define MLX5_VERBS_MAX_ACT_SIZE \
738 sizeof(struct ibv_flow_spec_action_tag) + \
739 sizeof(struct ibv_flow_spec_action_drop) \
743 #define MLX5_VERBS_MAX_SPEC_ACT_SIZE \
744 (MLX5_VERBS_MAX_SPEC_SIZE + MLX5_VERBS_MAX_ACT_SIZE)
746 /** Device flow structure only for Verbs flow creation. */
747 struct mlx5_flow_verbs_workspace {
748 unsigned int size; /**< Size of the attribute. */
749 struct ibv_flow_attr attr; /**< Verbs flow attribute buffer. */
750 uint8_t specs[MLX5_VERBS_MAX_SPEC_ACT_SIZE];
751 /**< Specifications & actions buffer of verbs flow. */
754 /** Maximal number of device sub-flows supported. */
755 #define MLX5_NUM_MAX_DEV_FLOWS 32
757 /** Device flow structure. */
759 struct rte_flow *flow; /**< Pointer to the main flow. */
760 uint32_t flow_idx; /**< The memory pool index to the main flow. */
761 uint64_t hash_fields; /**< Hash Rx queue hash fields. */
763 /**< Bit-fields of detected actions, see MLX5_FLOW_ACTION_*. */
764 bool external; /**< true if the flow is created external to PMD. */
765 uint8_t ingress; /**< 1 if the flow is ingress. */
767 #ifdef HAVE_IBV_FLOW_DV_SUPPORT
768 struct mlx5_flow_dv_workspace dv;
770 struct mlx5_flow_verbs_workspace verbs;
772 struct mlx5_flow_handle *handle;
773 uint32_t handle_idx; /* Index of the mlx5 flow handle memory. */
774 const struct mlx5_flow_tunnel *tunnel;
777 /* Flow meter state. */
778 #define MLX5_FLOW_METER_DISABLE 0
779 #define MLX5_FLOW_METER_ENABLE 1
781 #define MLX5_MAN_WIDTH 8
782 /* Modify this value if enum rte_mtr_color changes. */
783 #define RTE_MTR_DROPPED RTE_COLORS
785 /* Meter policer statistics */
786 struct mlx5_flow_policer_stats {
787 uint32_t cnt[RTE_COLORS + 1];
788 /**< Color counter, extra for drop. */
790 /**< Statistics mask for the colors. */
793 /* Meter table structure. */
794 struct mlx5_meter_domain_info {
795 struct mlx5_flow_tbl_resource *tbl;
797 struct mlx5_flow_tbl_resource *sfx_tbl;
798 /**< Meter suffix table. */
800 /**< Meter color not match default criteria. */
802 /**< Meter color match criteria. */
804 /**< Meter match action. */
805 void *policer_rules[RTE_MTR_DROPPED + 1];
806 /**< Meter policer for the match. */
809 /* Meter table set for TX RX FDB. */
810 struct mlx5_meter_domains_infos {
812 /**< Table user count. */
813 struct mlx5_meter_domain_info egress;
814 /**< TX meter table. */
815 struct mlx5_meter_domain_info ingress;
816 /**< RX meter table. */
817 struct mlx5_meter_domain_info transfer;
818 /**< FDB meter table. */
820 /**< Drop action as not matched. */
821 void *count_actns[RTE_MTR_DROPPED + 1];
822 /**< Counters for match and unmatched statistics. */
823 uint32_t fmp[MLX5_ST_SZ_DW(flow_meter_parameters)];
824 /**< Flow meter parameter. */
826 /**< Flow meter parameter size. */
828 /**< Flow meter action. */
831 /* Meter parameter structure. */
832 struct mlx5_flow_meter {
833 TAILQ_ENTRY(mlx5_flow_meter) next;
834 /**< Pointer to the next flow meter structure. */
835 uint32_t idx; /* Index to meter object. */
838 struct mlx5_flow_meter_profile *profile;
839 /**< Meter profile parameters. */
841 rte_spinlock_t sl; /**< Meter action spinlock. */
843 /** Policer actions (per meter output color). */
844 enum rte_mtr_policer_action action[RTE_COLORS];
846 /** Set of stats counters to be enabled.
847 * @see enum rte_mtr_stats_type
851 /**< Rule applies to ingress traffic. */
854 /**< Rule applies to egress traffic. */
857 * Instead of simply matching the properties of traffic as it would
858 * appear on a given DPDK port ID, enabling this attribute transfers
859 * a flow rule to the lowest possible level of any device endpoints
860 * found in the pattern.
862 * When supported, this effectively enables an application to
863 * re-route traffic not necessarily intended for it (e.g. coming
864 * from or addressed to different physical ports, VFs or
865 * applications) at the device level.
867 * It complements the behavior of some pattern items such as
868 * RTE_FLOW_ITEM_TYPE_PHY_PORT and is meaningless without them.
870 * When transferring flow rules, ingress and egress attributes keep
871 * their original meaning, as if processing traffic emitted or
872 * received by the application.
875 struct mlx5_meter_domains_infos *mfts;
876 /**< Flow table created for this meter. */
877 struct mlx5_flow_policer_stats policer_stats;
878 /**< Meter policer statistics. */
881 uint32_t active_state:1;
884 /**< Meter shared or not. */
887 /* RFC2697 parameter structure. */
888 struct mlx5_flow_meter_srtcm_rfc2697_prm {
889 /* green_saturation_value = cbs_mantissa * 2^cbs_exponent */
890 uint32_t cbs_exponent:5;
891 uint32_t cbs_mantissa:8;
892 /* cir = 8G * cir_mantissa * 1/(2^cir_exponent) Bytes/Sec */
893 uint32_t cir_exponent:5;
894 uint32_t cir_mantissa:8;
895 /* yellow _saturation_value = ebs_mantissa * 2^ebs_exponent */
896 uint32_t ebs_exponent:5;
897 uint32_t ebs_mantissa:8;
900 /* Flow meter profile structure. */
901 struct mlx5_flow_meter_profile {
902 TAILQ_ENTRY(mlx5_flow_meter_profile) next;
903 /**< Pointer to the next flow meter structure. */
904 uint32_t meter_profile_id; /**< Profile id. */
905 struct rte_mtr_meter_profile profile; /**< Profile detail. */
907 struct mlx5_flow_meter_srtcm_rfc2697_prm srtcm_prm;
908 /**< srtcm_rfc2697 struct. */
910 uint32_t ref_cnt; /**< Use count. */
913 /* Fdir flow structure */
914 struct mlx5_fdir_flow {
915 LIST_ENTRY(mlx5_fdir_flow) next; /* Pointer to the next element. */
916 struct mlx5_fdir *fdir; /* Pointer to fdir. */
917 uint32_t rix_flow; /* Index to flow. */
920 #define MLX5_MAX_TUNNELS 256
921 #define MLX5_TNL_MISS_RULE_PRIORITY 3
922 #define MLX5_TNL_MISS_FDB_JUMP_GRP 0x1234faac
925 * When tunnel offload is active, all JUMP group ids are converted
926 * using the same method. That conversion is applied both to tunnel and
927 * regular rule types.
928 * Group ids used in tunnel rules are relative to it's tunnel (!).
929 * Application can create number of steer rules, using the same
930 * tunnel, with different group id in each rule.
931 * Each tunnel stores its groups internally in PMD tunnel object.
932 * Groups used in regular rules do not belong to any tunnel and are stored
936 struct mlx5_flow_tunnel {
937 LIST_ENTRY(mlx5_flow_tunnel) chain;
938 struct rte_flow_tunnel app_tunnel; /** app tunnel copy */
939 uint32_t tunnel_id; /** unique tunnel ID */
941 struct rte_flow_action action;
942 struct rte_flow_item item;
943 struct mlx5_hlist *groups; /** tunnel groups */
946 /** PMD tunnel related context */
947 struct mlx5_flow_tunnel_hub {
948 LIST_HEAD(, mlx5_flow_tunnel) tunnels;
949 struct mlx5_hlist *groups; /** non tunnel groups */
952 /* convert jump group to flow table ID in tunnel rules */
953 struct tunnel_tbl_entry {
954 struct mlx5_hlist_entry hash;
958 static inline uint32_t
959 tunnel_id_to_flow_tbl(uint32_t id)
961 return id | (1u << 16);
964 static inline uint32_t
965 tunnel_flow_tbl_to_id(uint32_t flow_tbl)
967 return flow_tbl & ~(1u << 16);
970 union tunnel_tbl_key {
978 static inline struct mlx5_flow_tunnel_hub *
979 mlx5_tunnel_hub(struct rte_eth_dev *dev)
981 struct mlx5_priv *priv = dev->data->dev_private;
982 return priv->sh->tunnel_hub;
986 is_tunnel_offload_active(struct rte_eth_dev *dev)
988 struct mlx5_priv *priv = dev->data->dev_private;
989 return !!priv->config.dv_miss_info;
993 is_flow_tunnel_match_rule(__rte_unused struct rte_eth_dev *dev,
994 __rte_unused const struct rte_flow_attr *attr,
995 __rte_unused const struct rte_flow_item items[],
996 __rte_unused const struct rte_flow_action actions[])
998 return (items[0].type == (typeof(items[0].type))
999 MLX5_RTE_FLOW_ITEM_TYPE_TUNNEL);
1003 is_flow_tunnel_steer_rule(__rte_unused struct rte_eth_dev *dev,
1004 __rte_unused const struct rte_flow_attr *attr,
1005 __rte_unused const struct rte_flow_item items[],
1006 __rte_unused const struct rte_flow_action actions[])
1008 return (actions[0].type == (typeof(actions[0].type))
1009 MLX5_RTE_FLOW_ACTION_TYPE_TUNNEL_SET);
1012 static inline const struct mlx5_flow_tunnel *
1013 flow_actions_to_tunnel(const struct rte_flow_action actions[])
1015 return actions[0].conf;
1018 static inline const struct mlx5_flow_tunnel *
1019 flow_items_to_tunnel(const struct rte_flow_item items[])
1021 return items[0].spec;
1024 /* Flow structure. */
1026 ILIST_ENTRY(uint32_t)next; /**< Index to the next flow structure. */
1027 struct mlx5_shared_action_rss *shared_rss; /** < Shred RSS action. */
1028 uint32_t dev_handles;
1029 /**< Device flow handles that are part of the flow. */
1030 uint32_t drv_type:2; /**< Driver type. */
1031 uint32_t fdir:1; /**< Identifier of associated FDIR if any. */
1033 uint32_t meter:16; /**< Holds flow meter id. */
1034 uint32_t rix_mreg_copy;
1035 /**< Index to metadata register copy table resource. */
1036 uint32_t counter; /**< Holds flow counter. */
1037 uint32_t tunnel_id; /**< Tunnel id */
1041 * Define list of valid combinations of RX Hash fields
1042 * (see enum ibv_rx_hash_fields).
1044 #define MLX5_RSS_HASH_IPV4 (IBV_RX_HASH_SRC_IPV4 | IBV_RX_HASH_DST_IPV4)
1045 #define MLX5_RSS_HASH_IPV4_TCP \
1046 (MLX5_RSS_HASH_IPV4 | \
1047 IBV_RX_HASH_SRC_PORT_TCP | IBV_RX_HASH_SRC_PORT_TCP)
1048 #define MLX5_RSS_HASH_IPV4_UDP \
1049 (MLX5_RSS_HASH_IPV4 | \
1050 IBV_RX_HASH_SRC_PORT_UDP | IBV_RX_HASH_SRC_PORT_UDP)
1051 #define MLX5_RSS_HASH_IPV6 (IBV_RX_HASH_SRC_IPV6 | IBV_RX_HASH_DST_IPV6)
1052 #define MLX5_RSS_HASH_IPV6_TCP \
1053 (MLX5_RSS_HASH_IPV6 | \
1054 IBV_RX_HASH_SRC_PORT_TCP | IBV_RX_HASH_SRC_PORT_TCP)
1055 #define MLX5_RSS_HASH_IPV6_UDP \
1056 (MLX5_RSS_HASH_IPV6 | \
1057 IBV_RX_HASH_SRC_PORT_UDP | IBV_RX_HASH_SRC_PORT_UDP)
1058 #define MLX5_RSS_HASH_NONE 0ULL
1060 /* array of valid combinations of RX Hash fields for RSS */
1061 static const uint64_t mlx5_rss_hash_fields[] = {
1063 MLX5_RSS_HASH_IPV4_TCP,
1064 MLX5_RSS_HASH_IPV4_UDP,
1066 MLX5_RSS_HASH_IPV6_TCP,
1067 MLX5_RSS_HASH_IPV6_UDP,
1071 #define MLX5_RSS_HASH_FIELDS_LEN RTE_DIM(mlx5_rss_hash_fields)
1073 /* Shared RSS action structure */
1074 struct mlx5_shared_action_rss {
1075 struct rte_flow_action_rss origin; /**< Original rte RSS action. */
1076 uint8_t key[MLX5_RSS_HASH_KEY_LEN]; /**< RSS hash key. */
1077 uint16_t *queue; /**< Queue indices to use. */
1078 uint32_t hrxq[MLX5_RSS_HASH_FIELDS_LEN];
1079 /**< Hash RX queue indexes mapped to mlx5_rss_hash_fields */
1080 uint32_t hrxq_tunnel[MLX5_RSS_HASH_FIELDS_LEN];
1081 /**< Hash RX queue indexes for tunneled RSS */
1084 struct rte_flow_shared_action {
1085 LIST_ENTRY(rte_flow_shared_action) next;
1086 /**< Pointer to the next element. */
1087 uint32_t refcnt; /**< Atomically accessed refcnt. */
1089 /**< Shared action type (see MLX5_FLOW_ACTION_SHARED_*). */
1091 struct mlx5_shared_action_rss rss;
1092 /**< Shared RSS action. */
1096 /* Thread specific flow workspace intermediate data. */
1097 struct mlx5_flow_workspace {
1098 struct mlx5_flow flows[MLX5_NUM_MAX_DEV_FLOWS];
1099 struct mlx5_flow_rss_desc rss_desc[2];
1100 uint32_t rssq_num[2]; /* Allocated queue num in rss_desc. */
1101 int flow_idx; /* Intermediate device flow index. */
1102 int flow_nested_idx; /* Intermediate device flow index, nested. */
1105 typedef int (*mlx5_flow_validate_t)(struct rte_eth_dev *dev,
1106 const struct rte_flow_attr *attr,
1107 const struct rte_flow_item items[],
1108 const struct rte_flow_action actions[],
1111 struct rte_flow_error *error);
1112 typedef struct mlx5_flow *(*mlx5_flow_prepare_t)
1113 (struct rte_eth_dev *dev, const struct rte_flow_attr *attr,
1114 const struct rte_flow_item items[],
1115 const struct rte_flow_action actions[], struct rte_flow_error *error);
1116 typedef int (*mlx5_flow_translate_t)(struct rte_eth_dev *dev,
1117 struct mlx5_flow *dev_flow,
1118 const struct rte_flow_attr *attr,
1119 const struct rte_flow_item items[],
1120 const struct rte_flow_action actions[],
1121 struct rte_flow_error *error);
1122 typedef int (*mlx5_flow_apply_t)(struct rte_eth_dev *dev, struct rte_flow *flow,
1123 struct rte_flow_error *error);
1124 typedef void (*mlx5_flow_remove_t)(struct rte_eth_dev *dev,
1125 struct rte_flow *flow);
1126 typedef void (*mlx5_flow_destroy_t)(struct rte_eth_dev *dev,
1127 struct rte_flow *flow);
1128 typedef int (*mlx5_flow_query_t)(struct rte_eth_dev *dev,
1129 struct rte_flow *flow,
1130 const struct rte_flow_action *actions,
1132 struct rte_flow_error *error);
1133 typedef struct mlx5_meter_domains_infos *(*mlx5_flow_create_mtr_tbls_t)
1134 (struct rte_eth_dev *dev,
1135 const struct mlx5_flow_meter *fm);
1136 typedef int (*mlx5_flow_destroy_mtr_tbls_t)(struct rte_eth_dev *dev,
1137 struct mlx5_meter_domains_infos *tbls);
1138 typedef int (*mlx5_flow_create_policer_rules_t)
1139 (struct rte_eth_dev *dev,
1140 struct mlx5_flow_meter *fm,
1141 const struct rte_flow_attr *attr);
1142 typedef int (*mlx5_flow_destroy_policer_rules_t)
1143 (struct rte_eth_dev *dev,
1144 const struct mlx5_flow_meter *fm,
1145 const struct rte_flow_attr *attr);
1146 typedef uint32_t (*mlx5_flow_counter_alloc_t)
1147 (struct rte_eth_dev *dev);
1148 typedef void (*mlx5_flow_counter_free_t)(struct rte_eth_dev *dev,
1150 typedef int (*mlx5_flow_counter_query_t)(struct rte_eth_dev *dev,
1152 bool clear, uint64_t *pkts,
1154 typedef int (*mlx5_flow_get_aged_flows_t)
1155 (struct rte_eth_dev *dev,
1157 uint32_t nb_contexts,
1158 struct rte_flow_error *error);
1159 typedef int (*mlx5_flow_action_validate_t)
1160 (struct rte_eth_dev *dev,
1161 const struct rte_flow_shared_action_conf *conf,
1162 const struct rte_flow_action *action,
1163 struct rte_flow_error *error);
1164 typedef struct rte_flow_shared_action *(*mlx5_flow_action_create_t)
1165 (struct rte_eth_dev *dev,
1166 const struct rte_flow_shared_action_conf *conf,
1167 const struct rte_flow_action *action,
1168 struct rte_flow_error *error);
1169 typedef int (*mlx5_flow_action_destroy_t)
1170 (struct rte_eth_dev *dev,
1171 struct rte_flow_shared_action *action,
1172 struct rte_flow_error *error);
1173 typedef int (*mlx5_flow_action_update_t)
1174 (struct rte_eth_dev *dev,
1175 struct rte_flow_shared_action *action,
1176 const void *action_conf,
1177 struct rte_flow_error *error);
1178 typedef int (*mlx5_flow_sync_domain_t)
1179 (struct rte_eth_dev *dev,
1182 struct mlx5_flow_driver_ops {
1183 mlx5_flow_validate_t validate;
1184 mlx5_flow_prepare_t prepare;
1185 mlx5_flow_translate_t translate;
1186 mlx5_flow_apply_t apply;
1187 mlx5_flow_remove_t remove;
1188 mlx5_flow_destroy_t destroy;
1189 mlx5_flow_query_t query;
1190 mlx5_flow_create_mtr_tbls_t create_mtr_tbls;
1191 mlx5_flow_destroy_mtr_tbls_t destroy_mtr_tbls;
1192 mlx5_flow_create_policer_rules_t create_policer_rules;
1193 mlx5_flow_destroy_policer_rules_t destroy_policer_rules;
1194 mlx5_flow_counter_alloc_t counter_alloc;
1195 mlx5_flow_counter_free_t counter_free;
1196 mlx5_flow_counter_query_t counter_query;
1197 mlx5_flow_get_aged_flows_t get_aged_flows;
1198 mlx5_flow_action_validate_t action_validate;
1199 mlx5_flow_action_create_t action_create;
1200 mlx5_flow_action_destroy_t action_destroy;
1201 mlx5_flow_action_update_t action_update;
1202 mlx5_flow_sync_domain_t sync_domain;
1207 struct mlx5_flow_workspace *mlx5_flow_get_thread_workspace(void);
1209 struct flow_grp_info {
1210 uint64_t external:1;
1211 uint64_t transfer:1;
1212 uint64_t fdb_def_rule:1;
1213 /* force standard group translation */
1214 uint64_t std_tbl_fix:1;
1218 tunnel_use_standard_attr_group_translate
1219 (struct rte_eth_dev *dev,
1220 const struct mlx5_flow_tunnel *tunnel,
1221 const struct rte_flow_attr *attr,
1222 const struct rte_flow_item items[],
1223 const struct rte_flow_action actions[])
1227 if (!is_tunnel_offload_active(dev))
1228 /* no tunnel offload API */
1232 * OvS will use jump to group 0 in tunnel steer rule.
1233 * If tunnel steer rule starts from group 0 (attr.group == 0)
1234 * that 0 group must be translated with standard method.
1235 * attr.group == 0 in tunnel match rule translated with tunnel
1238 verdict = !attr->group &&
1239 is_flow_tunnel_steer_rule(dev, attr, items, actions);
1242 * non-tunnel group translation uses standard method for
1243 * root group only: attr.group == 0
1245 verdict = !attr->group;
1251 int mlx5_flow_group_to_table(struct rte_eth_dev *dev,
1252 const struct mlx5_flow_tunnel *tunnel,
1253 uint32_t group, uint32_t *table,
1254 struct flow_grp_info flags,
1255 struct rte_flow_error *error);
1256 uint64_t mlx5_flow_hashfields_adjust(struct mlx5_flow_rss_desc *rss_desc,
1257 int tunnel, uint64_t layer_types,
1258 uint64_t hash_fields);
1259 int mlx5_flow_discover_priorities(struct rte_eth_dev *dev);
1260 uint32_t mlx5_flow_adjust_priority(struct rte_eth_dev *dev, int32_t priority,
1261 uint32_t subpriority);
1262 int mlx5_flow_get_reg_id(struct rte_eth_dev *dev,
1263 enum mlx5_feature_name feature,
1265 struct rte_flow_error *error);
1266 const struct rte_flow_action *mlx5_flow_find_action
1267 (const struct rte_flow_action *actions,
1268 enum rte_flow_action_type action);
1269 int mlx5_validate_action_rss(struct rte_eth_dev *dev,
1270 const struct rte_flow_action *action,
1271 struct rte_flow_error *error);
1272 int mlx5_flow_validate_action_count(struct rte_eth_dev *dev,
1273 const struct rte_flow_attr *attr,
1274 struct rte_flow_error *error);
1275 int mlx5_flow_validate_action_drop(uint64_t action_flags,
1276 const struct rte_flow_attr *attr,
1277 struct rte_flow_error *error);
1278 int mlx5_flow_validate_action_flag(uint64_t action_flags,
1279 const struct rte_flow_attr *attr,
1280 struct rte_flow_error *error);
1281 int mlx5_flow_validate_action_mark(const struct rte_flow_action *action,
1282 uint64_t action_flags,
1283 const struct rte_flow_attr *attr,
1284 struct rte_flow_error *error);
1285 int mlx5_flow_validate_action_queue(const struct rte_flow_action *action,
1286 uint64_t action_flags,
1287 struct rte_eth_dev *dev,
1288 const struct rte_flow_attr *attr,
1289 struct rte_flow_error *error);
1290 int mlx5_flow_validate_action_rss(const struct rte_flow_action *action,
1291 uint64_t action_flags,
1292 struct rte_eth_dev *dev,
1293 const struct rte_flow_attr *attr,
1294 uint64_t item_flags,
1295 struct rte_flow_error *error);
1296 int mlx5_flow_validate_action_default_miss(uint64_t action_flags,
1297 const struct rte_flow_attr *attr,
1298 struct rte_flow_error *error);
1299 int mlx5_flow_validate_attributes(struct rte_eth_dev *dev,
1300 const struct rte_flow_attr *attributes,
1301 struct rte_flow_error *error);
1302 int mlx5_flow_item_acceptable(const struct rte_flow_item *item,
1303 const uint8_t *mask,
1304 const uint8_t *nic_mask,
1306 bool range_accepted,
1307 struct rte_flow_error *error);
1308 int mlx5_flow_validate_item_eth(const struct rte_flow_item *item,
1309 uint64_t item_flags, bool ext_vlan_sup,
1310 struct rte_flow_error *error);
1311 int mlx5_flow_validate_item_gre(const struct rte_flow_item *item,
1312 uint64_t item_flags,
1313 uint8_t target_protocol,
1314 struct rte_flow_error *error);
1315 int mlx5_flow_validate_item_gre_key(const struct rte_flow_item *item,
1316 uint64_t item_flags,
1317 const struct rte_flow_item *gre_item,
1318 struct rte_flow_error *error);
1319 int mlx5_flow_validate_item_ipv4(const struct rte_flow_item *item,
1320 uint64_t item_flags,
1322 uint16_t ether_type,
1323 const struct rte_flow_item_ipv4 *acc_mask,
1324 bool range_accepted,
1325 struct rte_flow_error *error);
1326 int mlx5_flow_validate_item_ipv6(const struct rte_flow_item *item,
1327 uint64_t item_flags,
1329 uint16_t ether_type,
1330 const struct rte_flow_item_ipv6 *acc_mask,
1331 struct rte_flow_error *error);
1332 int mlx5_flow_validate_item_mpls(struct rte_eth_dev *dev,
1333 const struct rte_flow_item *item,
1334 uint64_t item_flags,
1335 uint64_t prev_layer,
1336 struct rte_flow_error *error);
1337 int mlx5_flow_validate_item_tcp(const struct rte_flow_item *item,
1338 uint64_t item_flags,
1339 uint8_t target_protocol,
1340 const struct rte_flow_item_tcp *flow_mask,
1341 struct rte_flow_error *error);
1342 int mlx5_flow_validate_item_udp(const struct rte_flow_item *item,
1343 uint64_t item_flags,
1344 uint8_t target_protocol,
1345 struct rte_flow_error *error);
1346 int mlx5_flow_validate_item_vlan(const struct rte_flow_item *item,
1347 uint64_t item_flags,
1348 struct rte_eth_dev *dev,
1349 struct rte_flow_error *error);
1350 int mlx5_flow_validate_item_vxlan(const struct rte_flow_item *item,
1351 uint64_t item_flags,
1352 struct rte_flow_error *error);
1353 int mlx5_flow_validate_item_vxlan_gpe(const struct rte_flow_item *item,
1354 uint64_t item_flags,
1355 struct rte_eth_dev *dev,
1356 struct rte_flow_error *error);
1357 int mlx5_flow_validate_item_icmp(const struct rte_flow_item *item,
1358 uint64_t item_flags,
1359 uint8_t target_protocol,
1360 struct rte_flow_error *error);
1361 int mlx5_flow_validate_item_icmp6(const struct rte_flow_item *item,
1362 uint64_t item_flags,
1363 uint8_t target_protocol,
1364 struct rte_flow_error *error);
1365 int mlx5_flow_validate_item_nvgre(const struct rte_flow_item *item,
1366 uint64_t item_flags,
1367 uint8_t target_protocol,
1368 struct rte_flow_error *error);
1369 int mlx5_flow_validate_item_geneve(const struct rte_flow_item *item,
1370 uint64_t item_flags,
1371 struct rte_eth_dev *dev,
1372 struct rte_flow_error *error);
1373 int mlx5_flow_validate_item_ecpri(const struct rte_flow_item *item,
1374 uint64_t item_flags,
1376 uint16_t ether_type,
1377 const struct rte_flow_item_ecpri *acc_mask,
1378 struct rte_flow_error *error);
1379 struct mlx5_meter_domains_infos *mlx5_flow_create_mtr_tbls
1380 (struct rte_eth_dev *dev,
1381 const struct mlx5_flow_meter *fm);
1382 int mlx5_flow_destroy_mtr_tbls(struct rte_eth_dev *dev,
1383 struct mlx5_meter_domains_infos *tbl);
1384 int mlx5_flow_create_policer_rules(struct rte_eth_dev *dev,
1385 struct mlx5_flow_meter *fm,
1386 const struct rte_flow_attr *attr);
1387 int mlx5_flow_destroy_policer_rules(struct rte_eth_dev *dev,
1388 struct mlx5_flow_meter *fm,
1389 const struct rte_flow_attr *attr);
1390 int mlx5_flow_meter_flush(struct rte_eth_dev *dev,
1391 struct rte_mtr_error *error);
1392 int mlx5_flow_dv_discover_counter_offset_support(struct rte_eth_dev *dev);
1393 struct rte_flow_shared_action *mlx5_flow_get_shared_rss(struct rte_flow *flow);
1394 int mlx5_shared_action_flush(struct rte_eth_dev *dev);
1395 void mlx5_release_tunnel_hub(struct mlx5_dev_ctx_shared *sh, uint16_t port_id);
1396 int mlx5_alloc_tunnel_hub(struct mlx5_dev_ctx_shared *sh);
1398 /* Hash list callbacks for flow tables: */
1399 struct mlx5_hlist_entry *flow_dv_tbl_create_cb(struct mlx5_hlist *list,
1400 uint64_t key, void *entry_ctx);
1401 void flow_dv_tbl_remove_cb(struct mlx5_hlist *list,
1402 struct mlx5_hlist_entry *entry);
1403 struct mlx5_flow_tbl_resource *flow_dv_tbl_resource_get(struct rte_eth_dev *dev,
1404 uint32_t table_id, uint8_t egress, uint8_t transfer,
1405 bool external, const struct mlx5_flow_tunnel *tunnel,
1406 uint32_t group_id, uint8_t dummy, struct rte_flow_error *error);
1408 struct mlx5_hlist_entry *flow_dv_tag_create_cb(struct mlx5_hlist *list,
1409 uint64_t key, void *cb_ctx);
1410 void flow_dv_tag_remove_cb(struct mlx5_hlist *list,
1411 struct mlx5_hlist_entry *entry);
1413 int flow_dv_modify_match_cb(struct mlx5_hlist *list,
1414 struct mlx5_hlist_entry *entry,
1415 uint64_t key, void *cb_ctx);
1416 struct mlx5_hlist_entry *flow_dv_modify_create_cb(struct mlx5_hlist *list,
1417 uint64_t key, void *ctx);
1418 void flow_dv_modify_remove_cb(struct mlx5_hlist *list,
1419 struct mlx5_hlist_entry *entry);
1421 struct mlx5_hlist_entry *flow_dv_mreg_create_cb(struct mlx5_hlist *list,
1422 uint64_t key, void *ctx);
1423 void flow_dv_mreg_remove_cb(struct mlx5_hlist *list,
1424 struct mlx5_hlist_entry *entry);
1426 int flow_dv_encap_decap_match_cb(struct mlx5_hlist *list,
1427 struct mlx5_hlist_entry *entry,
1428 uint64_t key, void *cb_ctx);
1429 struct mlx5_hlist_entry *flow_dv_encap_decap_create_cb(struct mlx5_hlist *list,
1430 uint64_t key, void *cb_ctx);
1431 void flow_dv_encap_decap_remove_cb(struct mlx5_hlist *list,
1432 struct mlx5_hlist_entry *entry);
1433 #endif /* RTE_PMD_MLX5_FLOW_H_ */