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_TUNNEL_SET,
39 MLX5_RTE_FLOW_ACTION_TYPE_AGE,
42 #define MLX5_SHARED_ACTION_TYPE_OFFSET 30
45 MLX5_SHARED_ACTION_TYPE_RSS,
46 MLX5_SHARED_ACTION_TYPE_AGE,
49 /* Matches on selected register. */
50 struct mlx5_rte_flow_item_tag {
55 /* Modify selected register. */
56 struct mlx5_rte_flow_action_set_tag {
61 struct mlx5_flow_action_copy_mreg {
66 /* Matches on source queue. */
67 struct mlx5_rte_flow_item_tx_queue {
71 /* Feature name to allocate metadata register. */
72 enum mlx5_feature_name {
85 /* Default queue number. */
86 #define MLX5_RSSQ_DEFAULT_NUM 16
88 #define MLX5_FLOW_LAYER_OUTER_L2 (1u << 0)
89 #define MLX5_FLOW_LAYER_OUTER_L3_IPV4 (1u << 1)
90 #define MLX5_FLOW_LAYER_OUTER_L3_IPV6 (1u << 2)
91 #define MLX5_FLOW_LAYER_OUTER_L4_UDP (1u << 3)
92 #define MLX5_FLOW_LAYER_OUTER_L4_TCP (1u << 4)
93 #define MLX5_FLOW_LAYER_OUTER_VLAN (1u << 5)
95 /* Pattern inner Layer bits. */
96 #define MLX5_FLOW_LAYER_INNER_L2 (1u << 6)
97 #define MLX5_FLOW_LAYER_INNER_L3_IPV4 (1u << 7)
98 #define MLX5_FLOW_LAYER_INNER_L3_IPV6 (1u << 8)
99 #define MLX5_FLOW_LAYER_INNER_L4_UDP (1u << 9)
100 #define MLX5_FLOW_LAYER_INNER_L4_TCP (1u << 10)
101 #define MLX5_FLOW_LAYER_INNER_VLAN (1u << 11)
103 /* Pattern tunnel Layer bits. */
104 #define MLX5_FLOW_LAYER_VXLAN (1u << 12)
105 #define MLX5_FLOW_LAYER_VXLAN_GPE (1u << 13)
106 #define MLX5_FLOW_LAYER_GRE (1u << 14)
107 #define MLX5_FLOW_LAYER_MPLS (1u << 15)
108 /* List of tunnel Layer bits continued below. */
110 /* General pattern items bits. */
111 #define MLX5_FLOW_ITEM_METADATA (1u << 16)
112 #define MLX5_FLOW_ITEM_PORT_ID (1u << 17)
113 #define MLX5_FLOW_ITEM_TAG (1u << 18)
114 #define MLX5_FLOW_ITEM_MARK (1u << 19)
116 /* Pattern MISC bits. */
117 #define MLX5_FLOW_LAYER_ICMP (1u << 20)
118 #define MLX5_FLOW_LAYER_ICMP6 (1u << 21)
119 #define MLX5_FLOW_LAYER_GRE_KEY (1u << 22)
121 /* Pattern tunnel Layer bits (continued). */
122 #define MLX5_FLOW_LAYER_IPIP (1u << 23)
123 #define MLX5_FLOW_LAYER_IPV6_ENCAP (1u << 24)
124 #define MLX5_FLOW_LAYER_NVGRE (1u << 25)
125 #define MLX5_FLOW_LAYER_GENEVE (1u << 26)
128 #define MLX5_FLOW_ITEM_TX_QUEUE (1u << 27)
130 /* Pattern tunnel Layer bits (continued). */
131 #define MLX5_FLOW_LAYER_GTP (1u << 28)
133 /* Pattern eCPRI Layer bit. */
134 #define MLX5_FLOW_LAYER_ECPRI (UINT64_C(1) << 29)
136 /* IPv6 Fragment Extension Header bit. */
137 #define MLX5_FLOW_LAYER_OUTER_L3_IPV6_FRAG_EXT (1u << 30)
138 #define MLX5_FLOW_LAYER_INNER_L3_IPV6_FRAG_EXT (1u << 31)
141 #define MLX5_FLOW_LAYER_OUTER_L3 \
142 (MLX5_FLOW_LAYER_OUTER_L3_IPV4 | MLX5_FLOW_LAYER_OUTER_L3_IPV6)
143 #define MLX5_FLOW_LAYER_OUTER_L4 \
144 (MLX5_FLOW_LAYER_OUTER_L4_UDP | MLX5_FLOW_LAYER_OUTER_L4_TCP)
145 #define MLX5_FLOW_LAYER_OUTER \
146 (MLX5_FLOW_LAYER_OUTER_L2 | MLX5_FLOW_LAYER_OUTER_L3 | \
147 MLX5_FLOW_LAYER_OUTER_L4)
150 #define MLX5_FLOW_LAYER_TUNNEL \
151 (MLX5_FLOW_LAYER_VXLAN | MLX5_FLOW_LAYER_VXLAN_GPE | \
152 MLX5_FLOW_LAYER_GRE | MLX5_FLOW_LAYER_NVGRE | MLX5_FLOW_LAYER_MPLS | \
153 MLX5_FLOW_LAYER_IPIP | MLX5_FLOW_LAYER_IPV6_ENCAP | \
154 MLX5_FLOW_LAYER_GENEVE | MLX5_FLOW_LAYER_GTP)
157 #define MLX5_FLOW_LAYER_INNER_L3 \
158 (MLX5_FLOW_LAYER_INNER_L3_IPV4 | MLX5_FLOW_LAYER_INNER_L3_IPV6)
159 #define MLX5_FLOW_LAYER_INNER_L4 \
160 (MLX5_FLOW_LAYER_INNER_L4_UDP | MLX5_FLOW_LAYER_INNER_L4_TCP)
161 #define MLX5_FLOW_LAYER_INNER \
162 (MLX5_FLOW_LAYER_INNER_L2 | MLX5_FLOW_LAYER_INNER_L3 | \
163 MLX5_FLOW_LAYER_INNER_L4)
166 #define MLX5_FLOW_LAYER_L2 \
167 (MLX5_FLOW_LAYER_OUTER_L2 | MLX5_FLOW_LAYER_INNER_L2)
168 #define MLX5_FLOW_LAYER_L3_IPV4 \
169 (MLX5_FLOW_LAYER_OUTER_L3_IPV4 | MLX5_FLOW_LAYER_INNER_L3_IPV4)
170 #define MLX5_FLOW_LAYER_L3_IPV6 \
171 (MLX5_FLOW_LAYER_OUTER_L3_IPV6 | MLX5_FLOW_LAYER_INNER_L3_IPV6)
172 #define MLX5_FLOW_LAYER_L3 \
173 (MLX5_FLOW_LAYER_L3_IPV4 | MLX5_FLOW_LAYER_L3_IPV6)
174 #define MLX5_FLOW_LAYER_L4 \
175 (MLX5_FLOW_LAYER_OUTER_L4 | MLX5_FLOW_LAYER_INNER_L4)
178 #define MLX5_FLOW_ACTION_DROP (1u << 0)
179 #define MLX5_FLOW_ACTION_QUEUE (1u << 1)
180 #define MLX5_FLOW_ACTION_RSS (1u << 2)
181 #define MLX5_FLOW_ACTION_FLAG (1u << 3)
182 #define MLX5_FLOW_ACTION_MARK (1u << 4)
183 #define MLX5_FLOW_ACTION_COUNT (1u << 5)
184 #define MLX5_FLOW_ACTION_PORT_ID (1u << 6)
185 #define MLX5_FLOW_ACTION_OF_POP_VLAN (1u << 7)
186 #define MLX5_FLOW_ACTION_OF_PUSH_VLAN (1u << 8)
187 #define MLX5_FLOW_ACTION_OF_SET_VLAN_VID (1u << 9)
188 #define MLX5_FLOW_ACTION_OF_SET_VLAN_PCP (1u << 10)
189 #define MLX5_FLOW_ACTION_SET_IPV4_SRC (1u << 11)
190 #define MLX5_FLOW_ACTION_SET_IPV4_DST (1u << 12)
191 #define MLX5_FLOW_ACTION_SET_IPV6_SRC (1u << 13)
192 #define MLX5_FLOW_ACTION_SET_IPV6_DST (1u << 14)
193 #define MLX5_FLOW_ACTION_SET_TP_SRC (1u << 15)
194 #define MLX5_FLOW_ACTION_SET_TP_DST (1u << 16)
195 #define MLX5_FLOW_ACTION_JUMP (1u << 17)
196 #define MLX5_FLOW_ACTION_SET_TTL (1u << 18)
197 #define MLX5_FLOW_ACTION_DEC_TTL (1u << 19)
198 #define MLX5_FLOW_ACTION_SET_MAC_SRC (1u << 20)
199 #define MLX5_FLOW_ACTION_SET_MAC_DST (1u << 21)
200 #define MLX5_FLOW_ACTION_ENCAP (1u << 22)
201 #define MLX5_FLOW_ACTION_DECAP (1u << 23)
202 #define MLX5_FLOW_ACTION_INC_TCP_SEQ (1u << 24)
203 #define MLX5_FLOW_ACTION_DEC_TCP_SEQ (1u << 25)
204 #define MLX5_FLOW_ACTION_INC_TCP_ACK (1u << 26)
205 #define MLX5_FLOW_ACTION_DEC_TCP_ACK (1u << 27)
206 #define MLX5_FLOW_ACTION_SET_TAG (1ull << 28)
207 #define MLX5_FLOW_ACTION_MARK_EXT (1ull << 29)
208 #define MLX5_FLOW_ACTION_SET_META (1ull << 30)
209 #define MLX5_FLOW_ACTION_METER (1ull << 31)
210 #define MLX5_FLOW_ACTION_SET_IPV4_DSCP (1ull << 32)
211 #define MLX5_FLOW_ACTION_SET_IPV6_DSCP (1ull << 33)
212 #define MLX5_FLOW_ACTION_AGE (1ull << 34)
213 #define MLX5_FLOW_ACTION_DEFAULT_MISS (1ull << 35)
214 #define MLX5_FLOW_ACTION_SAMPLE (1ull << 36)
215 #define MLX5_FLOW_ACTION_TUNNEL_SET (1ull << 37)
216 #define MLX5_FLOW_ACTION_TUNNEL_MATCH (1ull << 38)
218 #define MLX5_FLOW_FATE_ACTIONS \
219 (MLX5_FLOW_ACTION_DROP | MLX5_FLOW_ACTION_QUEUE | \
220 MLX5_FLOW_ACTION_RSS | MLX5_FLOW_ACTION_JUMP | \
221 MLX5_FLOW_ACTION_DEFAULT_MISS)
223 #define MLX5_FLOW_FATE_ESWITCH_ACTIONS \
224 (MLX5_FLOW_ACTION_DROP | MLX5_FLOW_ACTION_PORT_ID | \
225 MLX5_FLOW_ACTION_JUMP)
228 #define MLX5_FLOW_MODIFY_HDR_ACTIONS (MLX5_FLOW_ACTION_SET_IPV4_SRC | \
229 MLX5_FLOW_ACTION_SET_IPV4_DST | \
230 MLX5_FLOW_ACTION_SET_IPV6_SRC | \
231 MLX5_FLOW_ACTION_SET_IPV6_DST | \
232 MLX5_FLOW_ACTION_SET_TP_SRC | \
233 MLX5_FLOW_ACTION_SET_TP_DST | \
234 MLX5_FLOW_ACTION_SET_TTL | \
235 MLX5_FLOW_ACTION_DEC_TTL | \
236 MLX5_FLOW_ACTION_SET_MAC_SRC | \
237 MLX5_FLOW_ACTION_SET_MAC_DST | \
238 MLX5_FLOW_ACTION_INC_TCP_SEQ | \
239 MLX5_FLOW_ACTION_DEC_TCP_SEQ | \
240 MLX5_FLOW_ACTION_INC_TCP_ACK | \
241 MLX5_FLOW_ACTION_DEC_TCP_ACK | \
242 MLX5_FLOW_ACTION_OF_SET_VLAN_VID | \
243 MLX5_FLOW_ACTION_SET_TAG | \
244 MLX5_FLOW_ACTION_MARK_EXT | \
245 MLX5_FLOW_ACTION_SET_META | \
246 MLX5_FLOW_ACTION_SET_IPV4_DSCP | \
247 MLX5_FLOW_ACTION_SET_IPV6_DSCP)
249 #define MLX5_FLOW_VLAN_ACTIONS (MLX5_FLOW_ACTION_OF_POP_VLAN | \
250 MLX5_FLOW_ACTION_OF_PUSH_VLAN)
252 #define MLX5_FLOW_XCAP_ACTIONS (MLX5_FLOW_ACTION_ENCAP | MLX5_FLOW_ACTION_DECAP)
255 #define IPPROTO_MPLS 137
258 /* UDP port number for MPLS */
259 #define MLX5_UDP_PORT_MPLS 6635
261 /* UDP port numbers for VxLAN. */
262 #define MLX5_UDP_PORT_VXLAN 4789
263 #define MLX5_UDP_PORT_VXLAN_GPE 4790
265 /* UDP port numbers for GENEVE. */
266 #define MLX5_UDP_PORT_GENEVE 6081
268 /* Priority reserved for default flows. */
269 #define MLX5_FLOW_PRIO_RSVD ((uint32_t)-1)
272 * Number of sub priorities.
273 * For each kind of pattern matching i.e. L2, L3, L4 to have a correct
274 * matching on the NIC (firmware dependent) L4 most have the higher priority
275 * followed by L3 and ending with L2.
277 #define MLX5_PRIORITY_MAP_L2 2
278 #define MLX5_PRIORITY_MAP_L3 1
279 #define MLX5_PRIORITY_MAP_L4 0
280 #define MLX5_PRIORITY_MAP_MAX 3
282 /* Valid layer type for IPV4 RSS. */
283 #define MLX5_IPV4_LAYER_TYPES \
284 (ETH_RSS_IPV4 | ETH_RSS_FRAG_IPV4 | \
285 ETH_RSS_NONFRAG_IPV4_TCP | ETH_RSS_NONFRAG_IPV4_UDP | \
286 ETH_RSS_NONFRAG_IPV4_OTHER)
288 /* IBV hash source bits for IPV4. */
289 #define MLX5_IPV4_IBV_RX_HASH (IBV_RX_HASH_SRC_IPV4 | IBV_RX_HASH_DST_IPV4)
291 /* Valid layer type for IPV6 RSS. */
292 #define MLX5_IPV6_LAYER_TYPES \
293 (ETH_RSS_IPV6 | ETH_RSS_FRAG_IPV6 | ETH_RSS_NONFRAG_IPV6_TCP | \
294 ETH_RSS_NONFRAG_IPV6_UDP | ETH_RSS_IPV6_EX | ETH_RSS_IPV6_TCP_EX | \
295 ETH_RSS_IPV6_UDP_EX | ETH_RSS_NONFRAG_IPV6_OTHER)
297 /* IBV hash source bits for IPV6. */
298 #define MLX5_IPV6_IBV_RX_HASH (IBV_RX_HASH_SRC_IPV6 | IBV_RX_HASH_DST_IPV6)
300 /* IBV hash bits for L3 SRC. */
301 #define MLX5_L3_SRC_IBV_RX_HASH (IBV_RX_HASH_SRC_IPV4 | IBV_RX_HASH_SRC_IPV6)
303 /* IBV hash bits for L3 DST. */
304 #define MLX5_L3_DST_IBV_RX_HASH (IBV_RX_HASH_DST_IPV4 | IBV_RX_HASH_DST_IPV6)
306 /* IBV hash bits for TCP. */
307 #define MLX5_TCP_IBV_RX_HASH (IBV_RX_HASH_SRC_PORT_TCP | \
308 IBV_RX_HASH_DST_PORT_TCP)
310 /* IBV hash bits for UDP. */
311 #define MLX5_UDP_IBV_RX_HASH (IBV_RX_HASH_SRC_PORT_UDP | \
312 IBV_RX_HASH_DST_PORT_UDP)
314 /* IBV hash bits for L4 SRC. */
315 #define MLX5_L4_SRC_IBV_RX_HASH (IBV_RX_HASH_SRC_PORT_TCP | \
316 IBV_RX_HASH_SRC_PORT_UDP)
318 /* IBV hash bits for L4 DST. */
319 #define MLX5_L4_DST_IBV_RX_HASH (IBV_RX_HASH_DST_PORT_TCP | \
320 IBV_RX_HASH_DST_PORT_UDP)
322 /* Geneve header first 16Bit */
323 #define MLX5_GENEVE_VER_MASK 0x3
324 #define MLX5_GENEVE_VER_SHIFT 14
325 #define MLX5_GENEVE_VER_VAL(a) \
326 (((a) >> (MLX5_GENEVE_VER_SHIFT)) & (MLX5_GENEVE_VER_MASK))
327 #define MLX5_GENEVE_OPTLEN_MASK 0x3F
328 #define MLX5_GENEVE_OPTLEN_SHIFT 7
329 #define MLX5_GENEVE_OPTLEN_VAL(a) \
330 (((a) >> (MLX5_GENEVE_OPTLEN_SHIFT)) & (MLX5_GENEVE_OPTLEN_MASK))
331 #define MLX5_GENEVE_OAMF_MASK 0x1
332 #define MLX5_GENEVE_OAMF_SHIFT 7
333 #define MLX5_GENEVE_OAMF_VAL(a) \
334 (((a) >> (MLX5_GENEVE_OAMF_SHIFT)) & (MLX5_GENEVE_OAMF_MASK))
335 #define MLX5_GENEVE_CRITO_MASK 0x1
336 #define MLX5_GENEVE_CRITO_SHIFT 6
337 #define MLX5_GENEVE_CRITO_VAL(a) \
338 (((a) >> (MLX5_GENEVE_CRITO_SHIFT)) & (MLX5_GENEVE_CRITO_MASK))
339 #define MLX5_GENEVE_RSVD_MASK 0x3F
340 #define MLX5_GENEVE_RSVD_VAL(a) ((a) & (MLX5_GENEVE_RSVD_MASK))
342 * The length of the Geneve options fields, expressed in four byte multiples,
343 * not including the eight byte fixed tunnel.
345 #define MLX5_GENEVE_OPT_LEN_0 14
346 #define MLX5_GENEVE_OPT_LEN_1 63
348 #define MLX5_ENCAPSULATION_DECISION_SIZE (sizeof(struct rte_ether_hdr) + \
349 sizeof(struct rte_ipv4_hdr))
351 /* IPv4 fragment_offset field contains relevant data in bits 2 to 15. */
352 #define MLX5_IPV4_FRAG_OFFSET_MASK \
353 (RTE_IPV4_HDR_OFFSET_MASK | RTE_IPV4_HDR_MF_FLAG)
355 /* Specific item's fields can accept a range of values (using spec and last). */
356 #define MLX5_ITEM_RANGE_NOT_ACCEPTED false
357 #define MLX5_ITEM_RANGE_ACCEPTED true
359 /* Software header modify action numbers of a flow. */
360 #define MLX5_ACT_NUM_MDF_IPV4 1
361 #define MLX5_ACT_NUM_MDF_IPV6 4
362 #define MLX5_ACT_NUM_MDF_MAC 2
363 #define MLX5_ACT_NUM_MDF_VID 1
364 #define MLX5_ACT_NUM_MDF_PORT 2
365 #define MLX5_ACT_NUM_MDF_TTL 1
366 #define MLX5_ACT_NUM_DEC_TTL MLX5_ACT_NUM_MDF_TTL
367 #define MLX5_ACT_NUM_MDF_TCPSEQ 1
368 #define MLX5_ACT_NUM_MDF_TCPACK 1
369 #define MLX5_ACT_NUM_SET_REG 1
370 #define MLX5_ACT_NUM_SET_TAG 1
371 #define MLX5_ACT_NUM_CPY_MREG MLX5_ACT_NUM_SET_TAG
372 #define MLX5_ACT_NUM_SET_MARK MLX5_ACT_NUM_SET_TAG
373 #define MLX5_ACT_NUM_SET_META MLX5_ACT_NUM_SET_TAG
374 #define MLX5_ACT_NUM_SET_DSCP 1
376 enum mlx5_flow_drv_type {
379 MLX5_FLOW_TYPE_VERBS,
383 /* Fate action type. */
384 enum mlx5_flow_fate_type {
385 MLX5_FLOW_FATE_NONE, /* Egress flow. */
386 MLX5_FLOW_FATE_QUEUE,
388 MLX5_FLOW_FATE_PORT_ID,
390 MLX5_FLOW_FATE_DEFAULT_MISS,
391 MLX5_FLOW_FATE_SHARED_RSS,
395 /* Matcher PRM representation */
396 struct mlx5_flow_dv_match_params {
398 /**< Size of match value. Do NOT split size and key! */
399 uint32_t buf[MLX5_ST_SZ_DW(fte_match_param)];
400 /**< Matcher value. This value is used as the mask or as a key. */
403 /* Matcher structure. */
404 struct mlx5_flow_dv_matcher {
405 struct mlx5_cache_entry entry; /**< Pointer to the next element. */
406 struct mlx5_flow_tbl_resource *tbl;
407 /**< Pointer to the table(group) the matcher associated with. */
408 void *matcher_object; /**< Pointer to DV matcher */
409 uint16_t crc; /**< CRC of key. */
410 uint16_t priority; /**< Priority of matcher. */
411 struct mlx5_flow_dv_match_params mask; /**< Matcher mask. */
414 #define MLX5_ENCAP_MAX_LEN 132
416 /* Encap/decap resource structure. */
417 struct mlx5_flow_dv_encap_decap_resource {
418 struct mlx5_hlist_entry entry;
419 /* Pointer to next element. */
420 uint32_t refcnt; /**< Reference counter. */
422 /**< Encap/decap action object. */
423 uint8_t buf[MLX5_ENCAP_MAX_LEN];
425 uint8_t reformat_type;
427 uint64_t flags; /**< Flags for RDMA API. */
428 uint32_t idx; /**< Index for the index memory pool. */
431 /* Tag resource structure. */
432 struct mlx5_flow_dv_tag_resource {
433 struct mlx5_hlist_entry entry;
434 /**< hash list entry for tag resource, tag value as the key. */
436 /**< Tag action object. */
437 uint32_t refcnt; /**< Reference counter. */
438 uint32_t idx; /**< Index for the index memory pool. */
442 * Number of modification commands.
443 * The maximal actions amount in FW is some constant, and it is 16 in the
444 * latest releases. In some old releases, it will be limited to 8.
445 * Since there is no interface to query the capacity, the maximal value should
446 * be used to allow PMD to create the flow. The validation will be done in the
447 * lower driver layer or FW. A failure will be returned if exceeds the maximal
448 * supported actions number on the root table.
449 * On non-root tables, there is no limitation, but 32 is enough right now.
451 #define MLX5_MAX_MODIFY_NUM 32
452 #define MLX5_ROOT_TBL_MODIFY_NUM 16
454 /* Modify resource structure */
455 struct mlx5_flow_dv_modify_hdr_resource {
456 struct mlx5_hlist_entry entry;
457 void *action; /**< Modify header action object. */
458 /* Key area for hash list matching: */
459 uint8_t ft_type; /**< Flow table type, Rx or Tx. */
460 uint32_t actions_num; /**< Number of modification actions. */
461 uint64_t flags; /**< Flags for RDMA API. */
462 struct mlx5_modification_cmd actions[];
463 /**< Modification actions. */
466 /* Modify resource key of the hash organization. */
467 union mlx5_flow_modify_hdr_key {
469 uint32_t ft_type:8; /**< Flow table type, Rx or Tx. */
470 uint32_t actions_num:5; /**< Number of modification actions. */
471 uint32_t group:19; /**< Flow group id. */
472 uint32_t cksum; /**< Actions check sum. */
474 uint64_t v64; /**< full 64bits value of key */
477 /* Jump action resource structure. */
478 struct mlx5_flow_dv_jump_tbl_resource {
479 void *action; /**< Pointer to the rdma core action. */
482 /* Port ID resource structure. */
483 struct mlx5_flow_dv_port_id_action_resource {
484 struct mlx5_cache_entry entry;
485 void *action; /**< Action object. */
486 uint32_t port_id; /**< Port ID value. */
487 uint32_t idx; /**< Indexed pool memory index. */
490 /* Push VLAN action resource structure */
491 struct mlx5_flow_dv_push_vlan_action_resource {
492 struct mlx5_cache_entry entry; /* Cache entry. */
493 void *action; /**< Action object. */
494 uint8_t ft_type; /**< Flow table type, Rx, Tx or FDB. */
495 rte_be32_t vlan_tag; /**< VLAN tag value. */
496 uint32_t idx; /**< Indexed pool memory index. */
499 /* Metadata register copy table entry. */
500 struct mlx5_flow_mreg_copy_resource {
502 * Hash list entry for copy table.
503 * - Key is 32/64-bit MARK action ID.
504 * - MUST be the first entry.
506 struct mlx5_hlist_entry hlist_ent;
507 LIST_ENTRY(mlx5_flow_mreg_copy_resource) next;
508 /* List entry for device flows. */
510 uint32_t rix_flow; /* Built flow for copy. */
513 /* Table tunnel parameter. */
514 struct mlx5_flow_tbl_tunnel_prm {
515 const struct mlx5_flow_tunnel *tunnel;
520 /* Table data structure of the hash organization. */
521 struct mlx5_flow_tbl_data_entry {
522 struct mlx5_hlist_entry entry;
523 /**< hash list entry, 64-bits key inside. */
524 struct mlx5_flow_tbl_resource tbl;
525 /**< flow table resource. */
526 struct mlx5_cache_list matchers;
527 /**< matchers' header associated with the flow table. */
528 struct mlx5_flow_dv_jump_tbl_resource jump;
529 /**< jump resource, at most one for each table created. */
530 uint32_t idx; /**< index for the indexed mempool. */
531 /**< tunnel offload */
532 const struct mlx5_flow_tunnel *tunnel;
535 bool tunnel_offload; /* Tunnel offlod table or not. */
536 bool is_egress; /**< Egress table. */
539 /* Sub rdma-core actions list. */
540 struct mlx5_flow_sub_actions_list {
541 uint32_t actions_num; /**< Number of sample actions. */
542 uint64_t action_flags;
543 void *dr_queue_action;
546 void *dr_port_id_action;
547 void *dr_encap_action;
550 /* Sample sub-actions resource list. */
551 struct mlx5_flow_sub_actions_idx {
552 uint32_t rix_hrxq; /**< Hash Rx queue object index. */
553 uint32_t rix_tag; /**< Index to the tag action. */
555 uint32_t rix_port_id_action; /**< Index to port ID action resource. */
556 uint32_t rix_encap_decap; /**< Index to encap/decap resource. */
559 /* Sample action resource structure. */
560 struct mlx5_flow_dv_sample_resource {
561 struct mlx5_cache_entry entry; /**< Cache entry. */
563 void *verbs_action; /**< Verbs sample action object. */
564 void **sub_actions; /**< Sample sub-action array. */
566 uint32_t idx; /** Sample object index. */
567 uint8_t ft_type; /** Flow Table Type */
568 uint32_t ft_id; /** Flow Table Level */
569 uint32_t ratio; /** Sample Ratio */
570 uint64_t set_action; /** Restore reg_c0 value */
571 void *normal_path_tbl; /** Flow Table pointer */
572 void *default_miss; /** default_miss dr_action. */
573 struct mlx5_flow_sub_actions_idx sample_idx;
574 /**< Action index resources. */
575 struct mlx5_flow_sub_actions_list sample_act;
576 /**< Action resources. */
579 #define MLX5_MAX_DEST_NUM 2
581 /* Destination array action resource structure. */
582 struct mlx5_flow_dv_dest_array_resource {
583 struct mlx5_cache_entry entry; /**< Cache entry. */
584 uint32_t idx; /** Destination array action object index. */
585 uint8_t ft_type; /** Flow Table Type */
586 uint8_t num_of_dest; /**< Number of destination actions. */
587 void *action; /**< Pointer to the rdma core action. */
588 struct mlx5_flow_sub_actions_idx sample_idx[MLX5_MAX_DEST_NUM];
589 /**< Action index resources. */
590 struct mlx5_flow_sub_actions_list sample_act[MLX5_MAX_DEST_NUM];
591 /**< Action resources. */
594 /* Verbs specification header. */
595 struct ibv_spec_header {
596 enum ibv_flow_spec_type type;
600 /* PMD flow priority for tunnel */
601 #define MLX5_TUNNEL_PRIO_GET(rss_desc) \
602 ((rss_desc)->level >= 2 ? MLX5_PRIORITY_MAP_L2 : MLX5_PRIORITY_MAP_L4)
605 /** Device flow handle structure for DV mode only. */
606 struct mlx5_flow_handle_dv {
608 struct mlx5_flow_dv_matcher *matcher; /**< Cache to matcher. */
609 struct mlx5_flow_dv_modify_hdr_resource *modify_hdr;
610 /**< Pointer to modify header resource in cache. */
611 uint32_t rix_encap_decap;
612 /**< Index to encap/decap resource in cache. */
613 uint32_t rix_push_vlan;
614 /**< Index to push VLAN action resource in cache. */
616 /**< Index to the tag action. */
618 /**< Index to sample action resource in cache. */
619 uint32_t rix_dest_array;
620 /**< Index to destination array resource in cache. */
623 /** Device flow handle structure: used both for creating & destroying. */
624 struct mlx5_flow_handle {
625 SILIST_ENTRY(uint32_t)next;
626 struct mlx5_vf_vlan vf_vlan; /**< Structure for VF VLAN workaround. */
627 /**< Index to next device flow handle. */
629 /**< Bit-fields of present layers, see MLX5_FLOW_LAYER_*. */
630 void *drv_flow; /**< pointer to driver flow object. */
631 uint32_t split_flow_id:28; /**< Sub flow unique match flow id. */
632 uint32_t mark:1; /**< Metadate rxq mark flag. */
633 uint32_t fate_action:3; /**< Fate action type. */
635 uint32_t rix_hrxq; /**< Hash Rx queue object index. */
636 uint32_t rix_jump; /**< Index to the jump action resource. */
637 uint32_t rix_port_id_action;
638 /**< Index to port ID action resource. */
640 /**< Generic value indicates the fate action. */
641 uint32_t rix_default_fate;
642 /**< Indicates default miss fate action. */
644 /**< Indicates shared RSS fate action. */
646 #ifdef HAVE_IBV_FLOW_DV_SUPPORT
647 struct mlx5_flow_handle_dv dvh;
652 * Size for Verbs device flow handle structure only. Do not use the DV only
653 * structure in Verbs. No DV flows attributes will be accessed.
654 * Macro offsetof() could also be used here.
656 #ifdef HAVE_IBV_FLOW_DV_SUPPORT
657 #define MLX5_FLOW_HANDLE_VERBS_SIZE \
658 (sizeof(struct mlx5_flow_handle) - sizeof(struct mlx5_flow_handle_dv))
660 #define MLX5_FLOW_HANDLE_VERBS_SIZE (sizeof(struct mlx5_flow_handle))
664 * Max number of actions per DV flow.
665 * See CREATE_FLOW_MAX_FLOW_ACTIONS_SUPPORTED
666 * in rdma-core file providers/mlx5/verbs.c.
668 #define MLX5_DV_MAX_NUMBER_OF_ACTIONS 8
670 /** Device flow structure only for DV flow creation. */
671 struct mlx5_flow_dv_workspace {
672 uint32_t group; /**< The group index. */
673 uint8_t transfer; /**< 1 if the flow is E-Switch flow. */
674 int actions_n; /**< number of actions. */
675 void *actions[MLX5_DV_MAX_NUMBER_OF_ACTIONS]; /**< Action list. */
676 struct mlx5_flow_dv_encap_decap_resource *encap_decap;
677 /**< Pointer to encap/decap resource in cache. */
678 struct mlx5_flow_dv_push_vlan_action_resource *push_vlan_res;
679 /**< Pointer to push VLAN action resource in cache. */
680 struct mlx5_flow_dv_tag_resource *tag_resource;
681 /**< pointer to the tag action. */
682 struct mlx5_flow_dv_port_id_action_resource *port_id_action;
683 /**< Pointer to port ID action resource. */
684 struct mlx5_flow_dv_jump_tbl_resource *jump;
685 /**< Pointer to the jump action resource. */
686 struct mlx5_flow_dv_match_params value;
687 /**< Holds the value that the packet is compared to. */
688 struct mlx5_flow_dv_sample_resource *sample_res;
689 /**< Pointer to the sample action resource. */
690 struct mlx5_flow_dv_dest_array_resource *dest_array_res;
691 /**< Pointer to the destination array resource. */
695 * Maximal Verbs flow specifications & actions size.
696 * Some elements are mutually exclusive, but enough space should be allocated.
697 * Tunnel cases: 1. Max 2 Ethernet + IP(v6 len > v4 len) + TCP/UDP headers.
698 * 2. One tunnel header (exception: GRE + MPLS),
699 * SPEC length: GRE == tunnel.
700 * Actions: 1. 1 Mark OR Flag.
701 * 2. 1 Drop (if any).
702 * 3. No limitation for counters, but it makes no sense to support too
703 * many counters in a single device flow.
705 #ifdef HAVE_IBV_DEVICE_MPLS_SUPPORT
706 #define MLX5_VERBS_MAX_SPEC_SIZE \
708 (2 * (sizeof(struct ibv_flow_spec_eth) + \
709 sizeof(struct ibv_flow_spec_ipv6) + \
710 sizeof(struct ibv_flow_spec_tcp_udp)) + \
711 sizeof(struct ibv_flow_spec_gre) + \
712 sizeof(struct ibv_flow_spec_mpls)) \
715 #define MLX5_VERBS_MAX_SPEC_SIZE \
717 (2 * (sizeof(struct ibv_flow_spec_eth) + \
718 sizeof(struct ibv_flow_spec_ipv6) + \
719 sizeof(struct ibv_flow_spec_tcp_udp)) + \
720 sizeof(struct ibv_flow_spec_tunnel)) \
724 #if defined(HAVE_IBV_DEVICE_COUNTERS_SET_V42) || \
725 defined(HAVE_IBV_DEVICE_COUNTERS_SET_V45)
726 #define MLX5_VERBS_MAX_ACT_SIZE \
728 sizeof(struct ibv_flow_spec_action_tag) + \
729 sizeof(struct ibv_flow_spec_action_drop) + \
730 sizeof(struct ibv_flow_spec_counter_action) * 4 \
733 #define MLX5_VERBS_MAX_ACT_SIZE \
735 sizeof(struct ibv_flow_spec_action_tag) + \
736 sizeof(struct ibv_flow_spec_action_drop) \
740 #define MLX5_VERBS_MAX_SPEC_ACT_SIZE \
741 (MLX5_VERBS_MAX_SPEC_SIZE + MLX5_VERBS_MAX_ACT_SIZE)
743 /** Device flow structure only for Verbs flow creation. */
744 struct mlx5_flow_verbs_workspace {
745 unsigned int size; /**< Size of the attribute. */
746 struct ibv_flow_attr attr; /**< Verbs flow attribute buffer. */
747 uint8_t specs[MLX5_VERBS_MAX_SPEC_ACT_SIZE];
748 /**< Specifications & actions buffer of verbs flow. */
751 /** Maximal number of device sub-flows supported. */
752 #define MLX5_NUM_MAX_DEV_FLOWS 32
754 /** Device flow structure. */
757 struct rte_flow *flow; /**< Pointer to the main flow. */
758 uint32_t flow_idx; /**< The memory pool index to the main flow. */
759 uint64_t hash_fields; /**< Hash Rx queue hash fields. */
761 /**< Bit-fields of detected actions, see MLX5_FLOW_ACTION_*. */
762 bool external; /**< true if the flow is created external to PMD. */
763 uint8_t ingress:1; /**< 1 if the flow is ingress. */
764 uint8_t skip_scale:1;
765 /**< 1 if skip the scale the table with factor. */
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 #define MLX5_MAX_TUNNELS 256
914 #define MLX5_TNL_MISS_RULE_PRIORITY 3
915 #define MLX5_TNL_MISS_FDB_JUMP_GRP 0x1234faac
918 * When tunnel offload is active, all JUMP group ids are converted
919 * using the same method. That conversion is applied both to tunnel and
920 * regular rule types.
921 * Group ids used in tunnel rules are relative to it's tunnel (!).
922 * Application can create number of steer rules, using the same
923 * tunnel, with different group id in each rule.
924 * Each tunnel stores its groups internally in PMD tunnel object.
925 * Groups used in regular rules do not belong to any tunnel and are stored
929 struct mlx5_flow_tunnel {
930 LIST_ENTRY(mlx5_flow_tunnel) chain;
931 struct rte_flow_tunnel app_tunnel; /** app tunnel copy */
932 uint32_t tunnel_id; /** unique tunnel ID */
934 struct rte_flow_action action;
935 struct rte_flow_item item;
936 struct mlx5_hlist *groups; /** tunnel groups */
939 /** PMD tunnel related context */
940 struct mlx5_flow_tunnel_hub {
942 * Access to the list MUST be MT protected
944 LIST_HEAD(, mlx5_flow_tunnel) tunnels;
945 /* protect access to the tunnels list */
947 struct mlx5_hlist *groups; /** non tunnel groups */
950 /* convert jump group to flow table ID in tunnel rules */
951 struct tunnel_tbl_entry {
952 struct mlx5_hlist_entry hash;
956 static inline uint32_t
957 tunnel_id_to_flow_tbl(uint32_t id)
959 return id | (1u << 16);
962 static inline uint32_t
963 tunnel_flow_tbl_to_id(uint32_t flow_tbl)
965 return flow_tbl & ~(1u << 16);
968 union tunnel_tbl_key {
976 static inline struct mlx5_flow_tunnel_hub *
977 mlx5_tunnel_hub(struct rte_eth_dev *dev)
979 struct mlx5_priv *priv = dev->data->dev_private;
980 return priv->sh->tunnel_hub;
984 is_tunnel_offload_active(struct rte_eth_dev *dev)
986 #ifdef HAVE_IBV_FLOW_DV_SUPPORT
987 struct mlx5_priv *priv = dev->data->dev_private;
988 return !!priv->config.dv_miss_info;
996 is_flow_tunnel_match_rule(__rte_unused struct rte_eth_dev *dev,
997 __rte_unused const struct rte_flow_attr *attr,
998 __rte_unused const struct rte_flow_item items[],
999 __rte_unused const struct rte_flow_action actions[])
1001 return (items[0].type == (typeof(items[0].type))
1002 MLX5_RTE_FLOW_ITEM_TYPE_TUNNEL);
1006 is_flow_tunnel_steer_rule(__rte_unused struct rte_eth_dev *dev,
1007 __rte_unused const struct rte_flow_attr *attr,
1008 __rte_unused const struct rte_flow_item items[],
1009 __rte_unused const struct rte_flow_action actions[])
1011 return (actions[0].type == (typeof(actions[0].type))
1012 MLX5_RTE_FLOW_ACTION_TYPE_TUNNEL_SET);
1015 static inline const struct mlx5_flow_tunnel *
1016 flow_actions_to_tunnel(const struct rte_flow_action actions[])
1018 return actions[0].conf;
1021 static inline const struct mlx5_flow_tunnel *
1022 flow_items_to_tunnel(const struct rte_flow_item items[])
1024 return items[0].spec;
1027 /* Flow structure. */
1029 ILIST_ENTRY(uint32_t)next; /**< Index to the next flow structure. */
1030 uint32_t dev_handles;
1031 /**< Device flow handles that are part of the flow. */
1032 uint32_t drv_type:2; /**< Driver type. */
1034 uint32_t meter:16; /**< Holds flow meter id. */
1035 uint32_t rix_mreg_copy;
1036 /**< Index to metadata register copy table resource. */
1037 uint32_t counter; /**< Holds flow counter. */
1038 uint32_t tunnel_id; /**< Tunnel id */
1039 uint32_t age; /**< Holds ASO age bit index. */
1043 * Define list of valid combinations of RX Hash fields
1044 * (see enum ibv_rx_hash_fields).
1046 #define MLX5_RSS_HASH_IPV4 (IBV_RX_HASH_SRC_IPV4 | IBV_RX_HASH_DST_IPV4)
1047 #define MLX5_RSS_HASH_IPV4_TCP \
1048 (MLX5_RSS_HASH_IPV4 | \
1049 IBV_RX_HASH_SRC_PORT_TCP | IBV_RX_HASH_SRC_PORT_TCP)
1050 #define MLX5_RSS_HASH_IPV4_UDP \
1051 (MLX5_RSS_HASH_IPV4 | \
1052 IBV_RX_HASH_SRC_PORT_UDP | IBV_RX_HASH_SRC_PORT_UDP)
1053 #define MLX5_RSS_HASH_IPV6 (IBV_RX_HASH_SRC_IPV6 | IBV_RX_HASH_DST_IPV6)
1054 #define MLX5_RSS_HASH_IPV6_TCP \
1055 (MLX5_RSS_HASH_IPV6 | \
1056 IBV_RX_HASH_SRC_PORT_TCP | IBV_RX_HASH_SRC_PORT_TCP)
1057 #define MLX5_RSS_HASH_IPV6_UDP \
1058 (MLX5_RSS_HASH_IPV6 | \
1059 IBV_RX_HASH_SRC_PORT_UDP | IBV_RX_HASH_SRC_PORT_UDP)
1060 #define MLX5_RSS_HASH_NONE 0ULL
1062 /* array of valid combinations of RX Hash fields for RSS */
1063 static const uint64_t mlx5_rss_hash_fields[] = {
1065 MLX5_RSS_HASH_IPV4_TCP,
1066 MLX5_RSS_HASH_IPV4_UDP,
1068 MLX5_RSS_HASH_IPV6_TCP,
1069 MLX5_RSS_HASH_IPV6_UDP,
1073 /* Shared RSS action structure */
1074 struct mlx5_shared_action_rss {
1075 ILIST_ENTRY(uint32_t)next; /**< Index to the next RSS structure. */
1076 uint32_t refcnt; /**< Atomically accessed refcnt. */
1077 struct rte_flow_action_rss origin; /**< Original rte RSS action. */
1078 uint8_t key[MLX5_RSS_HASH_KEY_LEN]; /**< RSS hash key. */
1079 uint16_t *queue; /**< Queue indices to use. */
1080 uint32_t hrxq[MLX5_RSS_HASH_FIELDS_LEN];
1081 /**< Hash RX queue indexes mapped to mlx5_rss_hash_fields */
1082 uint32_t hrxq_tunnel[MLX5_RSS_HASH_FIELDS_LEN];
1083 /**< Hash RX queue indexes for tunneled RSS */
1086 struct rte_flow_shared_action {
1090 /* Thread specific flow workspace intermediate data. */
1091 struct mlx5_flow_workspace {
1092 /* If creating another flow in same thread, push new as stack. */
1093 struct mlx5_flow_workspace *prev;
1094 struct mlx5_flow_workspace *next;
1095 uint32_t inuse; /* can't create new flow with current. */
1096 struct mlx5_flow flows[MLX5_NUM_MAX_DEV_FLOWS];
1097 struct mlx5_flow_rss_desc rss_desc;
1098 uint32_t rssq_num; /* Allocated queue num in rss_desc. */
1099 uint32_t flow_idx; /* Intermediate device flow index. */
1102 struct mlx5_flow_split_info {
1104 /**< True if flow is created by request external to PMD. */
1105 uint8_t skip_scale; /**< Skip the scale the table with factor. */
1106 uint32_t flow_idx; /**< This memory pool index to the flow. */
1107 uint32_t prefix_mark; /**< Prefix subflow mark flag. */
1108 uint64_t prefix_layers; /**< Prefix subflow layers. */
1111 typedef int (*mlx5_flow_validate_t)(struct rte_eth_dev *dev,
1112 const struct rte_flow_attr *attr,
1113 const struct rte_flow_item items[],
1114 const struct rte_flow_action actions[],
1117 struct rte_flow_error *error);
1118 typedef struct mlx5_flow *(*mlx5_flow_prepare_t)
1119 (struct rte_eth_dev *dev, const struct rte_flow_attr *attr,
1120 const struct rte_flow_item items[],
1121 const struct rte_flow_action actions[], struct rte_flow_error *error);
1122 typedef int (*mlx5_flow_translate_t)(struct rte_eth_dev *dev,
1123 struct mlx5_flow *dev_flow,
1124 const struct rte_flow_attr *attr,
1125 const struct rte_flow_item items[],
1126 const struct rte_flow_action actions[],
1127 struct rte_flow_error *error);
1128 typedef int (*mlx5_flow_apply_t)(struct rte_eth_dev *dev, struct rte_flow *flow,
1129 struct rte_flow_error *error);
1130 typedef void (*mlx5_flow_remove_t)(struct rte_eth_dev *dev,
1131 struct rte_flow *flow);
1132 typedef void (*mlx5_flow_destroy_t)(struct rte_eth_dev *dev,
1133 struct rte_flow *flow);
1134 typedef int (*mlx5_flow_query_t)(struct rte_eth_dev *dev,
1135 struct rte_flow *flow,
1136 const struct rte_flow_action *actions,
1138 struct rte_flow_error *error);
1139 typedef struct mlx5_meter_domains_infos *(*mlx5_flow_create_mtr_tbls_t)
1140 (struct rte_eth_dev *dev,
1141 const struct mlx5_flow_meter *fm);
1142 typedef int (*mlx5_flow_destroy_mtr_tbls_t)(struct rte_eth_dev *dev,
1143 struct mlx5_meter_domains_infos *tbls);
1144 typedef int (*mlx5_flow_create_policer_rules_t)
1145 (struct rte_eth_dev *dev,
1146 struct mlx5_flow_meter *fm,
1147 const struct rte_flow_attr *attr);
1148 typedef int (*mlx5_flow_destroy_policer_rules_t)
1149 (struct rte_eth_dev *dev,
1150 const struct mlx5_flow_meter *fm,
1151 const struct rte_flow_attr *attr);
1152 typedef uint32_t (*mlx5_flow_counter_alloc_t)
1153 (struct rte_eth_dev *dev);
1154 typedef void (*mlx5_flow_counter_free_t)(struct rte_eth_dev *dev,
1156 typedef int (*mlx5_flow_counter_query_t)(struct rte_eth_dev *dev,
1158 bool clear, uint64_t *pkts,
1160 typedef int (*mlx5_flow_get_aged_flows_t)
1161 (struct rte_eth_dev *dev,
1163 uint32_t nb_contexts,
1164 struct rte_flow_error *error);
1165 typedef int (*mlx5_flow_action_validate_t)
1166 (struct rte_eth_dev *dev,
1167 const struct rte_flow_shared_action_conf *conf,
1168 const struct rte_flow_action *action,
1169 struct rte_flow_error *error);
1170 typedef struct rte_flow_shared_action *(*mlx5_flow_action_create_t)
1171 (struct rte_eth_dev *dev,
1172 const struct rte_flow_shared_action_conf *conf,
1173 const struct rte_flow_action *action,
1174 struct rte_flow_error *error);
1175 typedef int (*mlx5_flow_action_destroy_t)
1176 (struct rte_eth_dev *dev,
1177 struct rte_flow_shared_action *action,
1178 struct rte_flow_error *error);
1179 typedef int (*mlx5_flow_action_update_t)
1180 (struct rte_eth_dev *dev,
1181 struct rte_flow_shared_action *action,
1182 const void *action_conf,
1183 struct rte_flow_error *error);
1184 typedef int (*mlx5_flow_action_query_t)
1185 (struct rte_eth_dev *dev,
1186 const struct rte_flow_shared_action *action,
1188 struct rte_flow_error *error);
1189 typedef int (*mlx5_flow_sync_domain_t)
1190 (struct rte_eth_dev *dev,
1194 struct mlx5_flow_driver_ops {
1195 mlx5_flow_validate_t validate;
1196 mlx5_flow_prepare_t prepare;
1197 mlx5_flow_translate_t translate;
1198 mlx5_flow_apply_t apply;
1199 mlx5_flow_remove_t remove;
1200 mlx5_flow_destroy_t destroy;
1201 mlx5_flow_query_t query;
1202 mlx5_flow_create_mtr_tbls_t create_mtr_tbls;
1203 mlx5_flow_destroy_mtr_tbls_t destroy_mtr_tbls;
1204 mlx5_flow_create_policer_rules_t create_policer_rules;
1205 mlx5_flow_destroy_policer_rules_t destroy_policer_rules;
1206 mlx5_flow_counter_alloc_t counter_alloc;
1207 mlx5_flow_counter_free_t counter_free;
1208 mlx5_flow_counter_query_t counter_query;
1209 mlx5_flow_get_aged_flows_t get_aged_flows;
1210 mlx5_flow_action_validate_t action_validate;
1211 mlx5_flow_action_create_t action_create;
1212 mlx5_flow_action_destroy_t action_destroy;
1213 mlx5_flow_action_update_t action_update;
1214 mlx5_flow_action_query_t action_query;
1215 mlx5_flow_sync_domain_t sync_domain;
1220 struct mlx5_flow_workspace *mlx5_flow_get_thread_workspace(void);
1222 struct flow_grp_info {
1223 uint64_t external:1;
1224 uint64_t transfer:1;
1225 uint64_t fdb_def_rule:1;
1226 /* force standard group translation */
1227 uint64_t std_tbl_fix:1;
1228 uint64_t skip_scale:1;
1232 tunnel_use_standard_attr_group_translate
1233 (struct rte_eth_dev *dev,
1234 const struct mlx5_flow_tunnel *tunnel,
1235 const struct rte_flow_attr *attr,
1236 const struct rte_flow_item items[],
1237 const struct rte_flow_action actions[])
1241 if (!is_tunnel_offload_active(dev))
1242 /* no tunnel offload API */
1246 * OvS will use jump to group 0 in tunnel steer rule.
1247 * If tunnel steer rule starts from group 0 (attr.group == 0)
1248 * that 0 group must be translated with standard method.
1249 * attr.group == 0 in tunnel match rule translated with tunnel
1252 verdict = !attr->group &&
1253 is_flow_tunnel_steer_rule(dev, attr, items, actions);
1256 * non-tunnel group translation uses standard method for
1257 * root group only: attr.group == 0
1259 verdict = !attr->group;
1265 int mlx5_flow_group_to_table(struct rte_eth_dev *dev,
1266 const struct mlx5_flow_tunnel *tunnel,
1267 uint32_t group, uint32_t *table,
1268 const struct flow_grp_info *flags,
1269 struct rte_flow_error *error);
1270 uint64_t mlx5_flow_hashfields_adjust(struct mlx5_flow_rss_desc *rss_desc,
1271 int tunnel, uint64_t layer_types,
1272 uint64_t hash_fields);
1273 int mlx5_flow_discover_priorities(struct rte_eth_dev *dev);
1274 uint32_t mlx5_flow_adjust_priority(struct rte_eth_dev *dev, int32_t priority,
1275 uint32_t subpriority);
1276 int mlx5_flow_get_reg_id(struct rte_eth_dev *dev,
1277 enum mlx5_feature_name feature,
1279 struct rte_flow_error *error);
1280 const struct rte_flow_action *mlx5_flow_find_action
1281 (const struct rte_flow_action *actions,
1282 enum rte_flow_action_type action);
1283 int mlx5_validate_action_rss(struct rte_eth_dev *dev,
1284 const struct rte_flow_action *action,
1285 struct rte_flow_error *error);
1286 int mlx5_flow_validate_action_count(struct rte_eth_dev *dev,
1287 const struct rte_flow_attr *attr,
1288 struct rte_flow_error *error);
1289 int mlx5_flow_validate_action_drop(uint64_t action_flags,
1290 const struct rte_flow_attr *attr,
1291 struct rte_flow_error *error);
1292 int mlx5_flow_validate_action_flag(uint64_t action_flags,
1293 const struct rte_flow_attr *attr,
1294 struct rte_flow_error *error);
1295 int mlx5_flow_validate_action_mark(const struct rte_flow_action *action,
1296 uint64_t action_flags,
1297 const struct rte_flow_attr *attr,
1298 struct rte_flow_error *error);
1299 int mlx5_flow_validate_action_queue(const struct rte_flow_action *action,
1300 uint64_t action_flags,
1301 struct rte_eth_dev *dev,
1302 const struct rte_flow_attr *attr,
1303 struct rte_flow_error *error);
1304 int mlx5_flow_validate_action_rss(const struct rte_flow_action *action,
1305 uint64_t action_flags,
1306 struct rte_eth_dev *dev,
1307 const struct rte_flow_attr *attr,
1308 uint64_t item_flags,
1309 struct rte_flow_error *error);
1310 int mlx5_flow_validate_action_default_miss(uint64_t action_flags,
1311 const struct rte_flow_attr *attr,
1312 struct rte_flow_error *error);
1313 int mlx5_flow_validate_attributes(struct rte_eth_dev *dev,
1314 const struct rte_flow_attr *attributes,
1315 struct rte_flow_error *error);
1316 int mlx5_flow_item_acceptable(const struct rte_flow_item *item,
1317 const uint8_t *mask,
1318 const uint8_t *nic_mask,
1320 bool range_accepted,
1321 struct rte_flow_error *error);
1322 int mlx5_flow_validate_item_eth(const struct rte_flow_item *item,
1323 uint64_t item_flags, bool ext_vlan_sup,
1324 struct rte_flow_error *error);
1325 int mlx5_flow_validate_item_gre(const struct rte_flow_item *item,
1326 uint64_t item_flags,
1327 uint8_t target_protocol,
1328 struct rte_flow_error *error);
1329 int mlx5_flow_validate_item_gre_key(const struct rte_flow_item *item,
1330 uint64_t item_flags,
1331 const struct rte_flow_item *gre_item,
1332 struct rte_flow_error *error);
1333 int mlx5_flow_validate_item_ipv4(const struct rte_flow_item *item,
1334 uint64_t item_flags,
1336 uint16_t ether_type,
1337 const struct rte_flow_item_ipv4 *acc_mask,
1338 bool range_accepted,
1339 struct rte_flow_error *error);
1340 int mlx5_flow_validate_item_ipv6(const struct rte_flow_item *item,
1341 uint64_t item_flags,
1343 uint16_t ether_type,
1344 const struct rte_flow_item_ipv6 *acc_mask,
1345 struct rte_flow_error *error);
1346 int mlx5_flow_validate_item_mpls(struct rte_eth_dev *dev,
1347 const struct rte_flow_item *item,
1348 uint64_t item_flags,
1349 uint64_t prev_layer,
1350 struct rte_flow_error *error);
1351 int mlx5_flow_validate_item_tcp(const struct rte_flow_item *item,
1352 uint64_t item_flags,
1353 uint8_t target_protocol,
1354 const struct rte_flow_item_tcp *flow_mask,
1355 struct rte_flow_error *error);
1356 int mlx5_flow_validate_item_udp(const struct rte_flow_item *item,
1357 uint64_t item_flags,
1358 uint8_t target_protocol,
1359 struct rte_flow_error *error);
1360 int mlx5_flow_validate_item_vlan(const struct rte_flow_item *item,
1361 uint64_t item_flags,
1362 struct rte_eth_dev *dev,
1363 struct rte_flow_error *error);
1364 int mlx5_flow_validate_item_vxlan(const struct rte_flow_item *item,
1365 uint64_t item_flags,
1366 struct rte_flow_error *error);
1367 int mlx5_flow_validate_item_vxlan_gpe(const struct rte_flow_item *item,
1368 uint64_t item_flags,
1369 struct rte_eth_dev *dev,
1370 struct rte_flow_error *error);
1371 int mlx5_flow_validate_item_icmp(const struct rte_flow_item *item,
1372 uint64_t item_flags,
1373 uint8_t target_protocol,
1374 struct rte_flow_error *error);
1375 int mlx5_flow_validate_item_icmp6(const struct rte_flow_item *item,
1376 uint64_t item_flags,
1377 uint8_t target_protocol,
1378 struct rte_flow_error *error);
1379 int mlx5_flow_validate_item_nvgre(const struct rte_flow_item *item,
1380 uint64_t item_flags,
1381 uint8_t target_protocol,
1382 struct rte_flow_error *error);
1383 int mlx5_flow_validate_item_geneve(const struct rte_flow_item *item,
1384 uint64_t item_flags,
1385 struct rte_eth_dev *dev,
1386 struct rte_flow_error *error);
1387 int mlx5_flow_validate_item_ecpri(const struct rte_flow_item *item,
1388 uint64_t item_flags,
1390 uint16_t ether_type,
1391 const struct rte_flow_item_ecpri *acc_mask,
1392 struct rte_flow_error *error);
1393 struct mlx5_meter_domains_infos *mlx5_flow_create_mtr_tbls
1394 (struct rte_eth_dev *dev,
1395 const struct mlx5_flow_meter *fm);
1396 int mlx5_flow_destroy_mtr_tbls(struct rte_eth_dev *dev,
1397 struct mlx5_meter_domains_infos *tbl);
1398 int mlx5_flow_create_policer_rules(struct rte_eth_dev *dev,
1399 struct mlx5_flow_meter *fm,
1400 const struct rte_flow_attr *attr);
1401 int mlx5_flow_destroy_policer_rules(struct rte_eth_dev *dev,
1402 struct mlx5_flow_meter *fm,
1403 const struct rte_flow_attr *attr);
1404 int mlx5_flow_meter_flush(struct rte_eth_dev *dev,
1405 struct rte_mtr_error *error);
1406 int mlx5_flow_dv_discover_counter_offset_support(struct rte_eth_dev *dev);
1407 int mlx5_shared_action_flush(struct rte_eth_dev *dev);
1408 void mlx5_release_tunnel_hub(struct mlx5_dev_ctx_shared *sh, uint16_t port_id);
1409 int mlx5_alloc_tunnel_hub(struct mlx5_dev_ctx_shared *sh);
1411 /* Hash list callbacks for flow tables: */
1412 struct mlx5_hlist_entry *flow_dv_tbl_create_cb(struct mlx5_hlist *list,
1413 uint64_t key, void *entry_ctx);
1414 void flow_dv_tbl_remove_cb(struct mlx5_hlist *list,
1415 struct mlx5_hlist_entry *entry);
1416 struct mlx5_flow_tbl_resource *flow_dv_tbl_resource_get(struct rte_eth_dev *dev,
1417 uint32_t table_id, uint8_t egress, uint8_t transfer,
1418 bool external, const struct mlx5_flow_tunnel *tunnel,
1419 uint32_t group_id, uint8_t dummy, struct rte_flow_error *error);
1421 struct mlx5_hlist_entry *flow_dv_tag_create_cb(struct mlx5_hlist *list,
1422 uint64_t key, void *cb_ctx);
1423 void flow_dv_tag_remove_cb(struct mlx5_hlist *list,
1424 struct mlx5_hlist_entry *entry);
1426 int flow_dv_modify_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_modify_create_cb(struct mlx5_hlist *list,
1430 uint64_t key, void *ctx);
1431 void flow_dv_modify_remove_cb(struct mlx5_hlist *list,
1432 struct mlx5_hlist_entry *entry);
1434 struct mlx5_hlist_entry *flow_dv_mreg_create_cb(struct mlx5_hlist *list,
1435 uint64_t key, void *ctx);
1436 void flow_dv_mreg_remove_cb(struct mlx5_hlist *list,
1437 struct mlx5_hlist_entry *entry);
1439 int flow_dv_encap_decap_match_cb(struct mlx5_hlist *list,
1440 struct mlx5_hlist_entry *entry,
1441 uint64_t key, void *cb_ctx);
1442 struct mlx5_hlist_entry *flow_dv_encap_decap_create_cb(struct mlx5_hlist *list,
1443 uint64_t key, void *cb_ctx);
1444 void flow_dv_encap_decap_remove_cb(struct mlx5_hlist *list,
1445 struct mlx5_hlist_entry *entry);
1447 int flow_dv_matcher_match_cb(struct mlx5_cache_list *list,
1448 struct mlx5_cache_entry *entry, void *ctx);
1449 struct mlx5_cache_entry *flow_dv_matcher_create_cb(struct mlx5_cache_list *list,
1450 struct mlx5_cache_entry *entry, void *ctx);
1451 void flow_dv_matcher_remove_cb(struct mlx5_cache_list *list,
1452 struct mlx5_cache_entry *entry);
1454 int flow_dv_port_id_match_cb(struct mlx5_cache_list *list,
1455 struct mlx5_cache_entry *entry, void *cb_ctx);
1456 struct mlx5_cache_entry *flow_dv_port_id_create_cb(struct mlx5_cache_list *list,
1457 struct mlx5_cache_entry *entry, void *cb_ctx);
1458 void flow_dv_port_id_remove_cb(struct mlx5_cache_list *list,
1459 struct mlx5_cache_entry *entry);
1461 int flow_dv_push_vlan_match_cb(struct mlx5_cache_list *list,
1462 struct mlx5_cache_entry *entry, void *cb_ctx);
1463 struct mlx5_cache_entry *flow_dv_push_vlan_create_cb
1464 (struct mlx5_cache_list *list,
1465 struct mlx5_cache_entry *entry, void *cb_ctx);
1466 void flow_dv_push_vlan_remove_cb(struct mlx5_cache_list *list,
1467 struct mlx5_cache_entry *entry);
1469 int flow_dv_sample_match_cb(struct mlx5_cache_list *list,
1470 struct mlx5_cache_entry *entry, void *cb_ctx);
1471 struct mlx5_cache_entry *flow_dv_sample_create_cb
1472 (struct mlx5_cache_list *list,
1473 struct mlx5_cache_entry *entry, void *cb_ctx);
1474 void flow_dv_sample_remove_cb(struct mlx5_cache_list *list,
1475 struct mlx5_cache_entry *entry);
1477 int flow_dv_dest_array_match_cb(struct mlx5_cache_list *list,
1478 struct mlx5_cache_entry *entry, void *cb_ctx);
1479 struct mlx5_cache_entry *flow_dv_dest_array_create_cb
1480 (struct mlx5_cache_list *list,
1481 struct mlx5_cache_entry *entry, void *cb_ctx);
1482 void flow_dv_dest_array_remove_cb(struct mlx5_cache_list *list,
1483 struct mlx5_cache_entry *entry);
1484 struct mlx5_aso_age_action *flow_aso_age_get_by_idx(struct rte_eth_dev *dev,
1486 #endif /* RTE_PMD_MLX5_FLOW_H_ */