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_
11 #include <sys/queue.h>
13 #include <rte_alarm.h>
16 #include <mlx5_glue.h>
21 /* Private rte flow items. */
22 enum mlx5_rte_flow_item_type {
23 MLX5_RTE_FLOW_ITEM_TYPE_END = INT_MIN,
24 MLX5_RTE_FLOW_ITEM_TYPE_TAG,
25 MLX5_RTE_FLOW_ITEM_TYPE_TX_QUEUE,
26 MLX5_RTE_FLOW_ITEM_TYPE_VLAN,
27 MLX5_RTE_FLOW_ITEM_TYPE_TUNNEL,
30 /* Private (internal) rte flow actions. */
31 enum mlx5_rte_flow_action_type {
32 MLX5_RTE_FLOW_ACTION_TYPE_END = INT_MIN,
33 MLX5_RTE_FLOW_ACTION_TYPE_TAG,
34 MLX5_RTE_FLOW_ACTION_TYPE_MARK,
35 MLX5_RTE_FLOW_ACTION_TYPE_COPY_MREG,
36 MLX5_RTE_FLOW_ACTION_TYPE_DEFAULT_MISS,
37 MLX5_RTE_FLOW_ACTION_TYPE_TUNNEL_SET,
38 MLX5_RTE_FLOW_ACTION_TYPE_AGE,
41 #define MLX5_INDIRECT_ACTION_TYPE_OFFSET 30
44 MLX5_INDIRECT_ACTION_TYPE_RSS,
45 MLX5_INDIRECT_ACTION_TYPE_AGE,
48 /* Matches on selected register. */
49 struct mlx5_rte_flow_item_tag {
54 /* Modify selected register. */
55 struct mlx5_rte_flow_action_set_tag {
62 struct mlx5_flow_action_copy_mreg {
67 /* Matches on source queue. */
68 struct mlx5_rte_flow_item_tx_queue {
72 /* Feature name to allocate metadata register. */
73 enum mlx5_feature_name {
87 /* Default queue number. */
88 #define MLX5_RSSQ_DEFAULT_NUM 16
90 #define MLX5_FLOW_LAYER_OUTER_L2 (1u << 0)
91 #define MLX5_FLOW_LAYER_OUTER_L3_IPV4 (1u << 1)
92 #define MLX5_FLOW_LAYER_OUTER_L3_IPV6 (1u << 2)
93 #define MLX5_FLOW_LAYER_OUTER_L4_UDP (1u << 3)
94 #define MLX5_FLOW_LAYER_OUTER_L4_TCP (1u << 4)
95 #define MLX5_FLOW_LAYER_OUTER_VLAN (1u << 5)
97 /* Pattern inner Layer bits. */
98 #define MLX5_FLOW_LAYER_INNER_L2 (1u << 6)
99 #define MLX5_FLOW_LAYER_INNER_L3_IPV4 (1u << 7)
100 #define MLX5_FLOW_LAYER_INNER_L3_IPV6 (1u << 8)
101 #define MLX5_FLOW_LAYER_INNER_L4_UDP (1u << 9)
102 #define MLX5_FLOW_LAYER_INNER_L4_TCP (1u << 10)
103 #define MLX5_FLOW_LAYER_INNER_VLAN (1u << 11)
105 /* Pattern tunnel Layer bits. */
106 #define MLX5_FLOW_LAYER_VXLAN (1u << 12)
107 #define MLX5_FLOW_LAYER_VXLAN_GPE (1u << 13)
108 #define MLX5_FLOW_LAYER_GRE (1u << 14)
109 #define MLX5_FLOW_LAYER_MPLS (1u << 15)
110 /* List of tunnel Layer bits continued below. */
112 /* General pattern items bits. */
113 #define MLX5_FLOW_ITEM_METADATA (1u << 16)
114 #define MLX5_FLOW_ITEM_PORT_ID (1u << 17)
115 #define MLX5_FLOW_ITEM_TAG (1u << 18)
116 #define MLX5_FLOW_ITEM_MARK (1u << 19)
118 /* Pattern MISC bits. */
119 #define MLX5_FLOW_LAYER_ICMP (1u << 20)
120 #define MLX5_FLOW_LAYER_ICMP6 (1u << 21)
121 #define MLX5_FLOW_LAYER_GRE_KEY (1u << 22)
123 /* Pattern tunnel Layer bits (continued). */
124 #define MLX5_FLOW_LAYER_IPIP (1u << 23)
125 #define MLX5_FLOW_LAYER_IPV6_ENCAP (1u << 24)
126 #define MLX5_FLOW_LAYER_NVGRE (1u << 25)
127 #define MLX5_FLOW_LAYER_GENEVE (1u << 26)
130 #define MLX5_FLOW_ITEM_TX_QUEUE (1u << 27)
132 /* Pattern tunnel Layer bits (continued). */
133 #define MLX5_FLOW_LAYER_GTP (1u << 28)
135 /* Pattern eCPRI Layer bit. */
136 #define MLX5_FLOW_LAYER_ECPRI (UINT64_C(1) << 29)
138 /* IPv6 Fragment Extension Header bit. */
139 #define MLX5_FLOW_LAYER_OUTER_L3_IPV6_FRAG_EXT (1u << 30)
140 #define MLX5_FLOW_LAYER_INNER_L3_IPV6_FRAG_EXT (1u << 31)
142 /* Pattern tunnel Layer bits (continued). */
143 #define MLX5_FLOW_LAYER_GENEVE_OPT (UINT64_C(1) << 32)
144 #define MLX5_FLOW_LAYER_GTP_PSC (UINT64_C(1) << 33)
147 #define MLX5_FLOW_LAYER_OUTER_L3 \
148 (MLX5_FLOW_LAYER_OUTER_L3_IPV4 | MLX5_FLOW_LAYER_OUTER_L3_IPV6)
149 #define MLX5_FLOW_LAYER_OUTER_L4 \
150 (MLX5_FLOW_LAYER_OUTER_L4_UDP | MLX5_FLOW_LAYER_OUTER_L4_TCP)
151 #define MLX5_FLOW_LAYER_OUTER \
152 (MLX5_FLOW_LAYER_OUTER_L2 | MLX5_FLOW_LAYER_OUTER_L3 | \
153 MLX5_FLOW_LAYER_OUTER_L4)
156 #define MLX5_FLOW_LAYER_TUNNEL \
157 (MLX5_FLOW_LAYER_VXLAN | MLX5_FLOW_LAYER_VXLAN_GPE | \
158 MLX5_FLOW_LAYER_GRE | MLX5_FLOW_LAYER_NVGRE | MLX5_FLOW_LAYER_MPLS | \
159 MLX5_FLOW_LAYER_IPIP | MLX5_FLOW_LAYER_IPV6_ENCAP | \
160 MLX5_FLOW_LAYER_GENEVE | MLX5_FLOW_LAYER_GTP)
163 #define MLX5_FLOW_LAYER_INNER_L3 \
164 (MLX5_FLOW_LAYER_INNER_L3_IPV4 | MLX5_FLOW_LAYER_INNER_L3_IPV6)
165 #define MLX5_FLOW_LAYER_INNER_L4 \
166 (MLX5_FLOW_LAYER_INNER_L4_UDP | MLX5_FLOW_LAYER_INNER_L4_TCP)
167 #define MLX5_FLOW_LAYER_INNER \
168 (MLX5_FLOW_LAYER_INNER_L2 | MLX5_FLOW_LAYER_INNER_L3 | \
169 MLX5_FLOW_LAYER_INNER_L4)
172 #define MLX5_FLOW_LAYER_L2 \
173 (MLX5_FLOW_LAYER_OUTER_L2 | MLX5_FLOW_LAYER_INNER_L2)
174 #define MLX5_FLOW_LAYER_L3_IPV4 \
175 (MLX5_FLOW_LAYER_OUTER_L3_IPV4 | MLX5_FLOW_LAYER_INNER_L3_IPV4)
176 #define MLX5_FLOW_LAYER_L3_IPV6 \
177 (MLX5_FLOW_LAYER_OUTER_L3_IPV6 | MLX5_FLOW_LAYER_INNER_L3_IPV6)
178 #define MLX5_FLOW_LAYER_L3 \
179 (MLX5_FLOW_LAYER_L3_IPV4 | MLX5_FLOW_LAYER_L3_IPV6)
180 #define MLX5_FLOW_LAYER_L4 \
181 (MLX5_FLOW_LAYER_OUTER_L4 | MLX5_FLOW_LAYER_INNER_L4)
184 #define MLX5_FLOW_ACTION_DROP (1u << 0)
185 #define MLX5_FLOW_ACTION_QUEUE (1u << 1)
186 #define MLX5_FLOW_ACTION_RSS (1u << 2)
187 #define MLX5_FLOW_ACTION_FLAG (1u << 3)
188 #define MLX5_FLOW_ACTION_MARK (1u << 4)
189 #define MLX5_FLOW_ACTION_COUNT (1u << 5)
190 #define MLX5_FLOW_ACTION_PORT_ID (1u << 6)
191 #define MLX5_FLOW_ACTION_OF_POP_VLAN (1u << 7)
192 #define MLX5_FLOW_ACTION_OF_PUSH_VLAN (1u << 8)
193 #define MLX5_FLOW_ACTION_OF_SET_VLAN_VID (1u << 9)
194 #define MLX5_FLOW_ACTION_OF_SET_VLAN_PCP (1u << 10)
195 #define MLX5_FLOW_ACTION_SET_IPV4_SRC (1u << 11)
196 #define MLX5_FLOW_ACTION_SET_IPV4_DST (1u << 12)
197 #define MLX5_FLOW_ACTION_SET_IPV6_SRC (1u << 13)
198 #define MLX5_FLOW_ACTION_SET_IPV6_DST (1u << 14)
199 #define MLX5_FLOW_ACTION_SET_TP_SRC (1u << 15)
200 #define MLX5_FLOW_ACTION_SET_TP_DST (1u << 16)
201 #define MLX5_FLOW_ACTION_JUMP (1u << 17)
202 #define MLX5_FLOW_ACTION_SET_TTL (1u << 18)
203 #define MLX5_FLOW_ACTION_DEC_TTL (1u << 19)
204 #define MLX5_FLOW_ACTION_SET_MAC_SRC (1u << 20)
205 #define MLX5_FLOW_ACTION_SET_MAC_DST (1u << 21)
206 #define MLX5_FLOW_ACTION_ENCAP (1u << 22)
207 #define MLX5_FLOW_ACTION_DECAP (1u << 23)
208 #define MLX5_FLOW_ACTION_INC_TCP_SEQ (1u << 24)
209 #define MLX5_FLOW_ACTION_DEC_TCP_SEQ (1u << 25)
210 #define MLX5_FLOW_ACTION_INC_TCP_ACK (1u << 26)
211 #define MLX5_FLOW_ACTION_DEC_TCP_ACK (1u << 27)
212 #define MLX5_FLOW_ACTION_SET_TAG (1ull << 28)
213 #define MLX5_FLOW_ACTION_MARK_EXT (1ull << 29)
214 #define MLX5_FLOW_ACTION_SET_META (1ull << 30)
215 #define MLX5_FLOW_ACTION_METER (1ull << 31)
216 #define MLX5_FLOW_ACTION_SET_IPV4_DSCP (1ull << 32)
217 #define MLX5_FLOW_ACTION_SET_IPV6_DSCP (1ull << 33)
218 #define MLX5_FLOW_ACTION_AGE (1ull << 34)
219 #define MLX5_FLOW_ACTION_DEFAULT_MISS (1ull << 35)
220 #define MLX5_FLOW_ACTION_SAMPLE (1ull << 36)
221 #define MLX5_FLOW_ACTION_TUNNEL_SET (1ull << 37)
222 #define MLX5_FLOW_ACTION_TUNNEL_MATCH (1ull << 38)
223 #define MLX5_FLOW_ACTION_MODIFY_FIELD (1ull << 39)
225 #define MLX5_FLOW_FATE_ACTIONS \
226 (MLX5_FLOW_ACTION_DROP | MLX5_FLOW_ACTION_QUEUE | \
227 MLX5_FLOW_ACTION_RSS | MLX5_FLOW_ACTION_JUMP | \
228 MLX5_FLOW_ACTION_DEFAULT_MISS)
230 #define MLX5_FLOW_FATE_ESWITCH_ACTIONS \
231 (MLX5_FLOW_ACTION_DROP | MLX5_FLOW_ACTION_PORT_ID | \
232 MLX5_FLOW_ACTION_JUMP)
235 #define MLX5_FLOW_MODIFY_HDR_ACTIONS (MLX5_FLOW_ACTION_SET_IPV4_SRC | \
236 MLX5_FLOW_ACTION_SET_IPV4_DST | \
237 MLX5_FLOW_ACTION_SET_IPV6_SRC | \
238 MLX5_FLOW_ACTION_SET_IPV6_DST | \
239 MLX5_FLOW_ACTION_SET_TP_SRC | \
240 MLX5_FLOW_ACTION_SET_TP_DST | \
241 MLX5_FLOW_ACTION_SET_TTL | \
242 MLX5_FLOW_ACTION_DEC_TTL | \
243 MLX5_FLOW_ACTION_SET_MAC_SRC | \
244 MLX5_FLOW_ACTION_SET_MAC_DST | \
245 MLX5_FLOW_ACTION_INC_TCP_SEQ | \
246 MLX5_FLOW_ACTION_DEC_TCP_SEQ | \
247 MLX5_FLOW_ACTION_INC_TCP_ACK | \
248 MLX5_FLOW_ACTION_DEC_TCP_ACK | \
249 MLX5_FLOW_ACTION_OF_SET_VLAN_VID | \
250 MLX5_FLOW_ACTION_SET_TAG | \
251 MLX5_FLOW_ACTION_MARK_EXT | \
252 MLX5_FLOW_ACTION_SET_META | \
253 MLX5_FLOW_ACTION_SET_IPV4_DSCP | \
254 MLX5_FLOW_ACTION_SET_IPV6_DSCP | \
255 MLX5_FLOW_ACTION_MODIFY_FIELD)
257 #define MLX5_FLOW_VLAN_ACTIONS (MLX5_FLOW_ACTION_OF_POP_VLAN | \
258 MLX5_FLOW_ACTION_OF_PUSH_VLAN)
260 #define MLX5_FLOW_XCAP_ACTIONS (MLX5_FLOW_ACTION_ENCAP | MLX5_FLOW_ACTION_DECAP)
263 #define IPPROTO_MPLS 137
266 /* UDP port number for MPLS */
267 #define MLX5_UDP_PORT_MPLS 6635
269 /* UDP port numbers for VxLAN. */
270 #define MLX5_UDP_PORT_VXLAN 4789
271 #define MLX5_UDP_PORT_VXLAN_GPE 4790
273 /* UDP port numbers for GENEVE. */
274 #define MLX5_UDP_PORT_GENEVE 6081
276 /* Lowest priority indicator. */
277 #define MLX5_FLOW_LOWEST_PRIO_INDICATOR ((uint32_t)-1)
280 * Max priority for ingress\egress flow groups
281 * greater than 0 and for any transfer flow group.
282 * From user configation: 0 - 21843.
284 #define MLX5_NON_ROOT_FLOW_MAX_PRIO (21843 + 1)
287 * Number of sub priorities.
288 * For each kind of pattern matching i.e. L2, L3, L4 to have a correct
289 * matching on the NIC (firmware dependent) L4 most have the higher priority
290 * followed by L3 and ending with L2.
292 #define MLX5_PRIORITY_MAP_L2 2
293 #define MLX5_PRIORITY_MAP_L3 1
294 #define MLX5_PRIORITY_MAP_L4 0
295 #define MLX5_PRIORITY_MAP_MAX 3
297 /* Valid layer type for IPV4 RSS. */
298 #define MLX5_IPV4_LAYER_TYPES \
299 (ETH_RSS_IPV4 | ETH_RSS_FRAG_IPV4 | \
300 ETH_RSS_NONFRAG_IPV4_TCP | ETH_RSS_NONFRAG_IPV4_UDP | \
301 ETH_RSS_NONFRAG_IPV4_OTHER)
303 /* IBV hash source bits for IPV4. */
304 #define MLX5_IPV4_IBV_RX_HASH (IBV_RX_HASH_SRC_IPV4 | IBV_RX_HASH_DST_IPV4)
306 /* Valid layer type for IPV6 RSS. */
307 #define MLX5_IPV6_LAYER_TYPES \
308 (ETH_RSS_IPV6 | ETH_RSS_FRAG_IPV6 | ETH_RSS_NONFRAG_IPV6_TCP | \
309 ETH_RSS_NONFRAG_IPV6_UDP | ETH_RSS_IPV6_EX | ETH_RSS_IPV6_TCP_EX | \
310 ETH_RSS_IPV6_UDP_EX | ETH_RSS_NONFRAG_IPV6_OTHER)
312 /* IBV hash source bits for IPV6. */
313 #define MLX5_IPV6_IBV_RX_HASH (IBV_RX_HASH_SRC_IPV6 | IBV_RX_HASH_DST_IPV6)
315 /* IBV hash bits for L3 SRC. */
316 #define MLX5_L3_SRC_IBV_RX_HASH (IBV_RX_HASH_SRC_IPV4 | IBV_RX_HASH_SRC_IPV6)
318 /* IBV hash bits for L3 DST. */
319 #define MLX5_L3_DST_IBV_RX_HASH (IBV_RX_HASH_DST_IPV4 | IBV_RX_HASH_DST_IPV6)
321 /* IBV hash bits for TCP. */
322 #define MLX5_TCP_IBV_RX_HASH (IBV_RX_HASH_SRC_PORT_TCP | \
323 IBV_RX_HASH_DST_PORT_TCP)
325 /* IBV hash bits for UDP. */
326 #define MLX5_UDP_IBV_RX_HASH (IBV_RX_HASH_SRC_PORT_UDP | \
327 IBV_RX_HASH_DST_PORT_UDP)
329 /* IBV hash bits for L4 SRC. */
330 #define MLX5_L4_SRC_IBV_RX_HASH (IBV_RX_HASH_SRC_PORT_TCP | \
331 IBV_RX_HASH_SRC_PORT_UDP)
333 /* IBV hash bits for L4 DST. */
334 #define MLX5_L4_DST_IBV_RX_HASH (IBV_RX_HASH_DST_PORT_TCP | \
335 IBV_RX_HASH_DST_PORT_UDP)
337 /* Geneve header first 16Bit */
338 #define MLX5_GENEVE_VER_MASK 0x3
339 #define MLX5_GENEVE_VER_SHIFT 14
340 #define MLX5_GENEVE_VER_VAL(a) \
341 (((a) >> (MLX5_GENEVE_VER_SHIFT)) & (MLX5_GENEVE_VER_MASK))
342 #define MLX5_GENEVE_OPTLEN_MASK 0x3F
343 #define MLX5_GENEVE_OPTLEN_SHIFT 8
344 #define MLX5_GENEVE_OPTLEN_VAL(a) \
345 (((a) >> (MLX5_GENEVE_OPTLEN_SHIFT)) & (MLX5_GENEVE_OPTLEN_MASK))
346 #define MLX5_GENEVE_OAMF_MASK 0x1
347 #define MLX5_GENEVE_OAMF_SHIFT 7
348 #define MLX5_GENEVE_OAMF_VAL(a) \
349 (((a) >> (MLX5_GENEVE_OAMF_SHIFT)) & (MLX5_GENEVE_OAMF_MASK))
350 #define MLX5_GENEVE_CRITO_MASK 0x1
351 #define MLX5_GENEVE_CRITO_SHIFT 6
352 #define MLX5_GENEVE_CRITO_VAL(a) \
353 (((a) >> (MLX5_GENEVE_CRITO_SHIFT)) & (MLX5_GENEVE_CRITO_MASK))
354 #define MLX5_GENEVE_RSVD_MASK 0x3F
355 #define MLX5_GENEVE_RSVD_VAL(a) ((a) & (MLX5_GENEVE_RSVD_MASK))
357 * The length of the Geneve options fields, expressed in four byte multiples,
358 * not including the eight byte fixed tunnel.
360 #define MLX5_GENEVE_OPT_LEN_0 14
361 #define MLX5_GENEVE_OPT_LEN_1 63
363 #define MLX5_ENCAPSULATION_DECISION_SIZE (sizeof(struct rte_ether_hdr) + \
364 sizeof(struct rte_ipv4_hdr))
365 /* GTP extension header flag. */
366 #define MLX5_GTP_EXT_HEADER_FLAG 4
368 /* GTP extension header max PDU type value. */
369 #define MLX5_GTP_EXT_MAX_PDU_TYPE 15
371 /* GTP extension header PDU type shift. */
372 #define MLX5_GTP_PDU_TYPE_SHIFT(a) ((a) << 4)
374 /* IPv4 fragment_offset field contains relevant data in bits 2 to 15. */
375 #define MLX5_IPV4_FRAG_OFFSET_MASK \
376 (RTE_IPV4_HDR_OFFSET_MASK | RTE_IPV4_HDR_MF_FLAG)
378 /* Specific item's fields can accept a range of values (using spec and last). */
379 #define MLX5_ITEM_RANGE_NOT_ACCEPTED false
380 #define MLX5_ITEM_RANGE_ACCEPTED true
382 /* Software header modify action numbers of a flow. */
383 #define MLX5_ACT_NUM_MDF_IPV4 1
384 #define MLX5_ACT_NUM_MDF_IPV6 4
385 #define MLX5_ACT_NUM_MDF_MAC 2
386 #define MLX5_ACT_NUM_MDF_VID 1
387 #define MLX5_ACT_NUM_MDF_PORT 2
388 #define MLX5_ACT_NUM_MDF_TTL 1
389 #define MLX5_ACT_NUM_DEC_TTL MLX5_ACT_NUM_MDF_TTL
390 #define MLX5_ACT_NUM_MDF_TCPSEQ 1
391 #define MLX5_ACT_NUM_MDF_TCPACK 1
392 #define MLX5_ACT_NUM_SET_REG 1
393 #define MLX5_ACT_NUM_SET_TAG 1
394 #define MLX5_ACT_NUM_CPY_MREG MLX5_ACT_NUM_SET_TAG
395 #define MLX5_ACT_NUM_SET_MARK MLX5_ACT_NUM_SET_TAG
396 #define MLX5_ACT_NUM_SET_META MLX5_ACT_NUM_SET_TAG
397 #define MLX5_ACT_NUM_SET_DSCP 1
399 /* Maximum number of fields to modify in MODIFY_FIELD */
400 #define MLX5_ACT_MAX_MOD_FIELDS 5
402 enum mlx5_flow_drv_type {
405 MLX5_FLOW_TYPE_VERBS,
409 /* Fate action type. */
410 enum mlx5_flow_fate_type {
411 MLX5_FLOW_FATE_NONE, /* Egress flow. */
412 MLX5_FLOW_FATE_QUEUE,
414 MLX5_FLOW_FATE_PORT_ID,
416 MLX5_FLOW_FATE_DEFAULT_MISS,
417 MLX5_FLOW_FATE_SHARED_RSS,
421 /* Matcher PRM representation */
422 struct mlx5_flow_dv_match_params {
424 /**< Size of match value. Do NOT split size and key! */
425 uint32_t buf[MLX5_ST_SZ_DW(fte_match_param)];
426 /**< Matcher value. This value is used as the mask or as a key. */
429 /* Matcher structure. */
430 struct mlx5_flow_dv_matcher {
431 struct mlx5_cache_entry entry; /**< Pointer to the next element. */
432 struct mlx5_flow_tbl_resource *tbl;
433 /**< Pointer to the table(group) the matcher associated with. */
434 void *matcher_object; /**< Pointer to DV matcher */
435 uint16_t crc; /**< CRC of key. */
436 uint16_t priority; /**< Priority of matcher. */
437 struct mlx5_flow_dv_match_params mask; /**< Matcher mask. */
440 #define MLX5_ENCAP_MAX_LEN 132
442 /* Encap/decap resource structure. */
443 struct mlx5_flow_dv_encap_decap_resource {
444 struct mlx5_hlist_entry entry;
445 /* Pointer to next element. */
446 uint32_t refcnt; /**< Reference counter. */
448 /**< Encap/decap action object. */
449 uint8_t buf[MLX5_ENCAP_MAX_LEN];
451 uint8_t reformat_type;
453 uint64_t flags; /**< Flags for RDMA API. */
454 uint32_t idx; /**< Index for the index memory pool. */
457 /* Tag resource structure. */
458 struct mlx5_flow_dv_tag_resource {
459 struct mlx5_hlist_entry entry;
460 /**< hash list entry for tag resource, tag value as the key. */
462 /**< Tag action object. */
463 uint32_t refcnt; /**< Reference counter. */
464 uint32_t idx; /**< Index for the index memory pool. */
465 uint32_t tag_id; /**< Tag ID. */
469 * Number of modification commands.
470 * The maximal actions amount in FW is some constant, and it is 16 in the
471 * latest releases. In some old releases, it will be limited to 8.
472 * Since there is no interface to query the capacity, the maximal value should
473 * be used to allow PMD to create the flow. The validation will be done in the
474 * lower driver layer or FW. A failure will be returned if exceeds the maximal
475 * supported actions number on the root table.
476 * On non-root tables, there is no limitation, but 32 is enough right now.
478 #define MLX5_MAX_MODIFY_NUM 32
479 #define MLX5_ROOT_TBL_MODIFY_NUM 16
481 /* Modify resource structure */
482 struct mlx5_flow_dv_modify_hdr_resource {
483 struct mlx5_hlist_entry entry;
484 void *action; /**< Modify header action object. */
485 /* Key area for hash list matching: */
486 uint8_t ft_type; /**< Flow table type, Rx or Tx. */
487 uint32_t actions_num; /**< Number of modification actions. */
488 uint64_t flags; /**< Flags for RDMA API. */
489 struct mlx5_modification_cmd actions[];
490 /**< Modification actions. */
493 /* Modify resource key of the hash organization. */
494 union mlx5_flow_modify_hdr_key {
496 uint32_t ft_type:8; /**< Flow table type, Rx or Tx. */
497 uint32_t actions_num:5; /**< Number of modification actions. */
498 uint32_t group:19; /**< Flow group id. */
499 uint32_t cksum; /**< Actions check sum. */
501 uint64_t v64; /**< full 64bits value of key */
504 /* Jump action resource structure. */
505 struct mlx5_flow_dv_jump_tbl_resource {
506 void *action; /**< Pointer to the rdma core action. */
509 /* Port ID resource structure. */
510 struct mlx5_flow_dv_port_id_action_resource {
511 struct mlx5_cache_entry entry;
512 void *action; /**< Action object. */
513 uint32_t port_id; /**< Port ID value. */
514 uint32_t idx; /**< Indexed pool memory index. */
517 /* Push VLAN action resource structure */
518 struct mlx5_flow_dv_push_vlan_action_resource {
519 struct mlx5_cache_entry entry; /* Cache entry. */
520 void *action; /**< Action object. */
521 uint8_t ft_type; /**< Flow table type, Rx, Tx or FDB. */
522 rte_be32_t vlan_tag; /**< VLAN tag value. */
523 uint32_t idx; /**< Indexed pool memory index. */
526 /* Metadata register copy table entry. */
527 struct mlx5_flow_mreg_copy_resource {
529 * Hash list entry for copy table.
530 * - Key is 32/64-bit MARK action ID.
531 * - MUST be the first entry.
533 struct mlx5_hlist_entry hlist_ent;
534 LIST_ENTRY(mlx5_flow_mreg_copy_resource) next;
535 /* List entry for device flows. */
537 uint32_t rix_flow; /* Built flow for copy. */
541 /* Table tunnel parameter. */
542 struct mlx5_flow_tbl_tunnel_prm {
543 const struct mlx5_flow_tunnel *tunnel;
548 /* Table data structure of the hash organization. */
549 struct mlx5_flow_tbl_data_entry {
550 struct mlx5_hlist_entry entry;
551 /**< hash list entry, 64-bits key inside. */
552 struct mlx5_flow_tbl_resource tbl;
553 /**< flow table resource. */
554 struct mlx5_cache_list matchers;
555 /**< matchers' header associated with the flow table. */
556 struct mlx5_flow_dv_jump_tbl_resource jump;
557 /**< jump resource, at most one for each table created. */
558 uint32_t idx; /**< index for the indexed mempool. */
559 /**< tunnel offload */
560 const struct mlx5_flow_tunnel *tunnel;
563 uint32_t tunnel_offload:1; /* Tunnel offlod table or not. */
564 uint32_t is_egress:1; /**< Egress table. */
565 uint32_t is_transfer:1; /**< Transfer table. */
566 uint32_t dummy:1; /**< DR table. */
567 uint32_t reserve:27; /**< Reserved to future using. */
568 uint32_t table_id; /**< Table ID. */
571 /* Sub rdma-core actions list. */
572 struct mlx5_flow_sub_actions_list {
573 uint32_t actions_num; /**< Number of sample actions. */
574 uint64_t action_flags;
575 void *dr_queue_action;
578 void *dr_port_id_action;
579 void *dr_encap_action;
580 void *dr_jump_action;
583 /* Sample sub-actions resource list. */
584 struct mlx5_flow_sub_actions_idx {
585 uint32_t rix_hrxq; /**< Hash Rx queue object index. */
586 uint32_t rix_tag; /**< Index to the tag action. */
587 uint32_t rix_port_id_action; /**< Index to port ID action resource. */
588 uint32_t rix_encap_decap; /**< Index to encap/decap resource. */
589 uint32_t rix_jump; /**< Index to the jump action resource. */
592 /* Sample action resource structure. */
593 struct mlx5_flow_dv_sample_resource {
594 struct mlx5_cache_entry entry; /**< Cache entry. */
596 void *verbs_action; /**< Verbs sample action object. */
597 void **sub_actions; /**< Sample sub-action array. */
599 struct rte_eth_dev *dev; /**< Device registers the action. */
600 uint32_t idx; /** Sample object index. */
601 uint8_t ft_type; /** Flow Table Type */
602 uint32_t ft_id; /** Flow Table Level */
603 uint32_t ratio; /** Sample Ratio */
604 uint64_t set_action; /** Restore reg_c0 value */
605 void *normal_path_tbl; /** Flow Table pointer */
606 struct mlx5_flow_sub_actions_idx sample_idx;
607 /**< Action index resources. */
608 struct mlx5_flow_sub_actions_list sample_act;
609 /**< Action resources. */
612 #define MLX5_MAX_DEST_NUM 2
614 /* Destination array action resource structure. */
615 struct mlx5_flow_dv_dest_array_resource {
616 struct mlx5_cache_entry entry; /**< Cache entry. */
617 uint32_t idx; /** Destination array action object index. */
618 uint8_t ft_type; /** Flow Table Type */
619 uint8_t num_of_dest; /**< Number of destination actions. */
620 struct rte_eth_dev *dev; /**< Device registers the action. */
621 void *action; /**< Pointer to the rdma core action. */
622 struct mlx5_flow_sub_actions_idx sample_idx[MLX5_MAX_DEST_NUM];
623 /**< Action index resources. */
624 struct mlx5_flow_sub_actions_list sample_act[MLX5_MAX_DEST_NUM];
625 /**< Action resources. */
628 /* PMD flow priority for tunnel */
629 #define MLX5_TUNNEL_PRIO_GET(rss_desc) \
630 ((rss_desc)->level >= 2 ? MLX5_PRIORITY_MAP_L2 : MLX5_PRIORITY_MAP_L4)
633 /** Device flow handle structure for DV mode only. */
634 struct mlx5_flow_handle_dv {
636 struct mlx5_flow_dv_matcher *matcher; /**< Cache to matcher. */
637 struct mlx5_flow_dv_modify_hdr_resource *modify_hdr;
638 /**< Pointer to modify header resource in cache. */
639 uint32_t rix_encap_decap;
640 /**< Index to encap/decap resource in cache. */
641 uint32_t rix_push_vlan;
642 /**< Index to push VLAN action resource in cache. */
644 /**< Index to the tag action. */
646 /**< Index to sample action resource in cache. */
647 uint32_t rix_dest_array;
648 /**< Index to destination array resource in cache. */
651 /** Device flow handle structure: used both for creating & destroying. */
652 struct mlx5_flow_handle {
653 SILIST_ENTRY(uint32_t)next;
654 struct mlx5_vf_vlan vf_vlan; /**< Structure for VF VLAN workaround. */
655 /**< Index to next device flow handle. */
657 /**< Bit-fields of present layers, see MLX5_FLOW_LAYER_*. */
658 void *drv_flow; /**< pointer to driver flow object. */
659 uint32_t split_flow_id:27; /**< Sub flow unique match flow id. */
660 uint32_t is_meter_flow_id:1; /**< Indate if flow_id is for meter. */
661 uint32_t mark:1; /**< Metadate rxq mark flag. */
662 uint32_t fate_action:3; /**< Fate action type. */
664 uint32_t rix_hrxq; /**< Hash Rx queue object index. */
665 uint32_t rix_jump; /**< Index to the jump action resource. */
666 uint32_t rix_port_id_action;
667 /**< Index to port ID action resource. */
669 /**< Generic value indicates the fate action. */
670 uint32_t rix_default_fate;
671 /**< Indicates default miss fate action. */
673 /**< Indicates shared RSS fate action. */
675 #if defined(HAVE_IBV_FLOW_DV_SUPPORT) || !defined(HAVE_INFINIBAND_VERBS_H)
676 struct mlx5_flow_handle_dv dvh;
681 * Size for Verbs device flow handle structure only. Do not use the DV only
682 * structure in Verbs. No DV flows attributes will be accessed.
683 * Macro offsetof() could also be used here.
685 #if defined(HAVE_IBV_FLOW_DV_SUPPORT) || !defined(HAVE_INFINIBAND_VERBS_H)
686 #define MLX5_FLOW_HANDLE_VERBS_SIZE \
687 (sizeof(struct mlx5_flow_handle) - sizeof(struct mlx5_flow_handle_dv))
689 #define MLX5_FLOW_HANDLE_VERBS_SIZE (sizeof(struct mlx5_flow_handle))
693 * Max number of actions per DV flow.
694 * See CREATE_FLOW_MAX_FLOW_ACTIONS_SUPPORTED
695 * in rdma-core file providers/mlx5/verbs.c.
697 #define MLX5_DV_MAX_NUMBER_OF_ACTIONS 8
699 /** Device flow structure only for DV flow creation. */
700 struct mlx5_flow_dv_workspace {
701 uint32_t group; /**< The group index. */
702 uint8_t transfer; /**< 1 if the flow is E-Switch flow. */
703 int actions_n; /**< number of actions. */
704 void *actions[MLX5_DV_MAX_NUMBER_OF_ACTIONS]; /**< Action list. */
705 struct mlx5_flow_dv_encap_decap_resource *encap_decap;
706 /**< Pointer to encap/decap resource in cache. */
707 struct mlx5_flow_dv_push_vlan_action_resource *push_vlan_res;
708 /**< Pointer to push VLAN action resource in cache. */
709 struct mlx5_flow_dv_tag_resource *tag_resource;
710 /**< pointer to the tag action. */
711 struct mlx5_flow_dv_port_id_action_resource *port_id_action;
712 /**< Pointer to port ID action resource. */
713 struct mlx5_flow_dv_jump_tbl_resource *jump;
714 /**< Pointer to the jump action resource. */
715 struct mlx5_flow_dv_match_params value;
716 /**< Holds the value that the packet is compared to. */
717 struct mlx5_flow_dv_sample_resource *sample_res;
718 /**< Pointer to the sample action resource. */
719 struct mlx5_flow_dv_dest_array_resource *dest_array_res;
720 /**< Pointer to the destination array resource. */
723 #ifdef HAVE_INFINIBAND_VERBS_H
725 * Maximal Verbs flow specifications & actions size.
726 * Some elements are mutually exclusive, but enough space should be allocated.
727 * Tunnel cases: 1. Max 2 Ethernet + IP(v6 len > v4 len) + TCP/UDP headers.
728 * 2. One tunnel header (exception: GRE + MPLS),
729 * SPEC length: GRE == tunnel.
730 * Actions: 1. 1 Mark OR Flag.
731 * 2. 1 Drop (if any).
732 * 3. No limitation for counters, but it makes no sense to support too
733 * many counters in a single device flow.
735 #ifdef HAVE_IBV_DEVICE_MPLS_SUPPORT
736 #define MLX5_VERBS_MAX_SPEC_SIZE \
738 (2 * (sizeof(struct ibv_flow_spec_eth) + \
739 sizeof(struct ibv_flow_spec_ipv6) + \
740 sizeof(struct ibv_flow_spec_tcp_udp)) + \
741 sizeof(struct ibv_flow_spec_gre) + \
742 sizeof(struct ibv_flow_spec_mpls)) \
745 #define MLX5_VERBS_MAX_SPEC_SIZE \
747 (2 * (sizeof(struct ibv_flow_spec_eth) + \
748 sizeof(struct ibv_flow_spec_ipv6) + \
749 sizeof(struct ibv_flow_spec_tcp_udp)) + \
750 sizeof(struct ibv_flow_spec_tunnel)) \
754 #if defined(HAVE_IBV_DEVICE_COUNTERS_SET_V42) || \
755 defined(HAVE_IBV_DEVICE_COUNTERS_SET_V45)
756 #define MLX5_VERBS_MAX_ACT_SIZE \
758 sizeof(struct ibv_flow_spec_action_tag) + \
759 sizeof(struct ibv_flow_spec_action_drop) + \
760 sizeof(struct ibv_flow_spec_counter_action) * 4 \
763 #define MLX5_VERBS_MAX_ACT_SIZE \
765 sizeof(struct ibv_flow_spec_action_tag) + \
766 sizeof(struct ibv_flow_spec_action_drop) \
770 #define MLX5_VERBS_MAX_SPEC_ACT_SIZE \
771 (MLX5_VERBS_MAX_SPEC_SIZE + MLX5_VERBS_MAX_ACT_SIZE)
773 /** Device flow structure only for Verbs flow creation. */
774 struct mlx5_flow_verbs_workspace {
775 unsigned int size; /**< Size of the attribute. */
776 struct ibv_flow_attr attr; /**< Verbs flow attribute buffer. */
777 uint8_t specs[MLX5_VERBS_MAX_SPEC_ACT_SIZE];
778 /**< Specifications & actions buffer of verbs flow. */
780 #endif /* HAVE_INFINIBAND_VERBS_H */
782 #define MLX5_SCALE_FLOW_GROUP_BIT 0
783 #define MLX5_SCALE_JUMP_FLOW_GROUP_BIT 1
785 /** Maximal number of device sub-flows supported. */
786 #define MLX5_NUM_MAX_DEV_FLOWS 32
788 /** Device flow structure. */
791 struct rte_flow *flow; /**< Pointer to the main flow. */
792 uint32_t flow_idx; /**< The memory pool index to the main flow. */
793 uint64_t hash_fields; /**< Hash Rx queue hash fields. */
795 /**< Bit-fields of detected actions, see MLX5_FLOW_ACTION_*. */
796 bool external; /**< true if the flow is created external to PMD. */
797 uint8_t ingress:1; /**< 1 if the flow is ingress. */
798 uint8_t skip_scale:2;
800 * Each Bit be set to 1 if Skip the scale the flow group with factor.
801 * If bit0 be set to 1, then skip the scale the original flow group;
802 * If bit1 be set to 1, then skip the scale the jump flow group if
803 * having jump action.
804 * 00: Enable scale in a flow, default value.
805 * 01: Skip scale the flow group with factor, enable scale the group
807 * 10: Enable scale the group with factor, skip scale the group of
809 * 11: Skip scale the table with factor both for flow group and jump
813 #if defined(HAVE_IBV_FLOW_DV_SUPPORT) || !defined(HAVE_INFINIBAND_VERBS_H)
814 struct mlx5_flow_dv_workspace dv;
816 #ifdef HAVE_INFINIBAND_VERBS_H
817 struct mlx5_flow_verbs_workspace verbs;
820 struct mlx5_flow_handle *handle;
821 uint32_t handle_idx; /* Index of the mlx5 flow handle memory. */
822 const struct mlx5_flow_tunnel *tunnel;
825 /* Flow meter state. */
826 #define MLX5_FLOW_METER_DISABLE 0
827 #define MLX5_FLOW_METER_ENABLE 1
829 #define MLX5_ASO_WQE_CQE_RESPONSE_DELAY 10u
830 #define MLX5_MTR_POLL_WQE_CQE_TIMES 100000u
832 #define MLX5_MAN_WIDTH 8
833 /* Legacy Meter parameter structure. */
834 struct mlx5_legacy_flow_meter {
835 struct mlx5_flow_meter_info fm;
836 /* Must be the first in struct. */
837 TAILQ_ENTRY(mlx5_legacy_flow_meter) next;
838 /**< Pointer to the next flow meter structure. */
839 uint32_t idx; /* Index to meter object. */
842 #define MLX5_MAX_TUNNELS 256
843 #define MLX5_TNL_MISS_RULE_PRIORITY 3
844 #define MLX5_TNL_MISS_FDB_JUMP_GRP 0x1234faac
847 * When tunnel offload is active, all JUMP group ids are converted
848 * using the same method. That conversion is applied both to tunnel and
849 * regular rule types.
850 * Group ids used in tunnel rules are relative to it's tunnel (!).
851 * Application can create number of steer rules, using the same
852 * tunnel, with different group id in each rule.
853 * Each tunnel stores its groups internally in PMD tunnel object.
854 * Groups used in regular rules do not belong to any tunnel and are stored
858 struct mlx5_flow_tunnel {
859 LIST_ENTRY(mlx5_flow_tunnel) chain;
860 struct rte_flow_tunnel app_tunnel; /** app tunnel copy */
861 uint32_t tunnel_id; /** unique tunnel ID */
863 struct rte_flow_action action;
864 struct rte_flow_item item;
865 struct mlx5_hlist *groups; /** tunnel groups */
868 /** PMD tunnel related context */
869 struct mlx5_flow_tunnel_hub {
871 * Access to the list MUST be MT protected
873 LIST_HEAD(, mlx5_flow_tunnel) tunnels;
874 /* protect access to the tunnels list */
876 struct mlx5_hlist *groups; /** non tunnel groups */
879 /* convert jump group to flow table ID in tunnel rules */
880 struct tunnel_tbl_entry {
881 struct mlx5_hlist_entry hash;
887 static inline uint32_t
888 tunnel_id_to_flow_tbl(uint32_t id)
890 return id | (1u << 16);
893 static inline uint32_t
894 tunnel_flow_tbl_to_id(uint32_t flow_tbl)
896 return flow_tbl & ~(1u << 16);
899 union tunnel_tbl_key {
907 static inline struct mlx5_flow_tunnel_hub *
908 mlx5_tunnel_hub(struct rte_eth_dev *dev)
910 struct mlx5_priv *priv = dev->data->dev_private;
911 return priv->sh->tunnel_hub;
915 is_tunnel_offload_active(struct rte_eth_dev *dev)
917 #ifdef HAVE_IBV_FLOW_DV_SUPPORT
918 struct mlx5_priv *priv = dev->data->dev_private;
919 return !!priv->config.dv_miss_info;
927 is_flow_tunnel_match_rule(__rte_unused struct rte_eth_dev *dev,
928 __rte_unused const struct rte_flow_attr *attr,
929 __rte_unused const struct rte_flow_item items[],
930 __rte_unused const struct rte_flow_action actions[])
932 return (items[0].type == (typeof(items[0].type))
933 MLX5_RTE_FLOW_ITEM_TYPE_TUNNEL);
937 is_flow_tunnel_steer_rule(__rte_unused struct rte_eth_dev *dev,
938 __rte_unused const struct rte_flow_attr *attr,
939 __rte_unused const struct rte_flow_item items[],
940 __rte_unused const struct rte_flow_action actions[])
942 return (actions[0].type == (typeof(actions[0].type))
943 MLX5_RTE_FLOW_ACTION_TYPE_TUNNEL_SET);
946 static inline const struct mlx5_flow_tunnel *
947 flow_actions_to_tunnel(const struct rte_flow_action actions[])
949 return actions[0].conf;
952 static inline const struct mlx5_flow_tunnel *
953 flow_items_to_tunnel(const struct rte_flow_item items[])
955 return items[0].spec;
958 /* Flow structure. */
960 ILIST_ENTRY(uint32_t)next; /**< Index to the next flow structure. */
961 uint32_t dev_handles;
962 /**< Device flow handles that are part of the flow. */
963 uint32_t drv_type:2; /**< Driver type. */
965 uint32_t meter:24; /**< Holds flow meter id. */
966 uint32_t rix_mreg_copy;
967 /**< Index to metadata register copy table resource. */
968 uint32_t counter; /**< Holds flow counter. */
969 uint32_t tunnel_id; /**< Tunnel id */
970 uint32_t age; /**< Holds ASO age bit index. */
971 uint32_t geneve_tlv_option; /**< Holds Geneve TLV option id. > */
975 * Define list of valid combinations of RX Hash fields
976 * (see enum ibv_rx_hash_fields).
978 #define MLX5_RSS_HASH_IPV4 (IBV_RX_HASH_SRC_IPV4 | IBV_RX_HASH_DST_IPV4)
979 #define MLX5_RSS_HASH_IPV4_TCP \
980 (MLX5_RSS_HASH_IPV4 | \
981 IBV_RX_HASH_SRC_PORT_TCP | IBV_RX_HASH_DST_PORT_TCP)
982 #define MLX5_RSS_HASH_IPV4_UDP \
983 (MLX5_RSS_HASH_IPV4 | \
984 IBV_RX_HASH_SRC_PORT_UDP | IBV_RX_HASH_DST_PORT_UDP)
985 #define MLX5_RSS_HASH_IPV6 (IBV_RX_HASH_SRC_IPV6 | IBV_RX_HASH_DST_IPV6)
986 #define MLX5_RSS_HASH_IPV6_TCP \
987 (MLX5_RSS_HASH_IPV6 | \
988 IBV_RX_HASH_SRC_PORT_TCP | IBV_RX_HASH_DST_PORT_TCP)
989 #define MLX5_RSS_HASH_IPV6_UDP \
990 (MLX5_RSS_HASH_IPV6 | \
991 IBV_RX_HASH_SRC_PORT_UDP | IBV_RX_HASH_DST_PORT_UDP)
992 #define MLX5_RSS_HASH_IPV4_SRC_ONLY IBV_RX_HASH_SRC_IPV4
993 #define MLX5_RSS_HASH_IPV4_DST_ONLY IBV_RX_HASH_DST_IPV4
994 #define MLX5_RSS_HASH_IPV6_SRC_ONLY IBV_RX_HASH_SRC_IPV6
995 #define MLX5_RSS_HASH_IPV6_DST_ONLY IBV_RX_HASH_DST_IPV6
996 #define MLX5_RSS_HASH_IPV4_UDP_SRC_ONLY \
997 (MLX5_RSS_HASH_IPV4 | IBV_RX_HASH_SRC_PORT_UDP)
998 #define MLX5_RSS_HASH_IPV4_UDP_DST_ONLY \
999 (MLX5_RSS_HASH_IPV4 | IBV_RX_HASH_DST_PORT_UDP)
1000 #define MLX5_RSS_HASH_IPV6_UDP_SRC_ONLY \
1001 (MLX5_RSS_HASH_IPV6 | IBV_RX_HASH_SRC_PORT_UDP)
1002 #define MLX5_RSS_HASH_IPV6_UDP_DST_ONLY \
1003 (MLX5_RSS_HASH_IPV6 | IBV_RX_HASH_DST_PORT_UDP)
1004 #define MLX5_RSS_HASH_IPV4_TCP_SRC_ONLY \
1005 (MLX5_RSS_HASH_IPV4 | IBV_RX_HASH_SRC_PORT_TCP)
1006 #define MLX5_RSS_HASH_IPV4_TCP_DST_ONLY \
1007 (MLX5_RSS_HASH_IPV4 | IBV_RX_HASH_DST_PORT_TCP)
1008 #define MLX5_RSS_HASH_IPV6_TCP_SRC_ONLY \
1009 (MLX5_RSS_HASH_IPV6 | IBV_RX_HASH_SRC_PORT_TCP)
1010 #define MLX5_RSS_HASH_IPV6_TCP_DST_ONLY \
1011 (MLX5_RSS_HASH_IPV6 | IBV_RX_HASH_DST_PORT_TCP)
1012 #define MLX5_RSS_HASH_NONE 0ULL
1014 /* array of valid combinations of RX Hash fields for RSS */
1015 static const uint64_t mlx5_rss_hash_fields[] = {
1017 MLX5_RSS_HASH_IPV4_TCP,
1018 MLX5_RSS_HASH_IPV4_UDP,
1020 MLX5_RSS_HASH_IPV6_TCP,
1021 MLX5_RSS_HASH_IPV6_UDP,
1025 /* Shared RSS action structure */
1026 struct mlx5_shared_action_rss {
1027 ILIST_ENTRY(uint32_t)next; /**< Index to the next RSS structure. */
1028 uint32_t refcnt; /**< Atomically accessed refcnt. */
1029 struct rte_flow_action_rss origin; /**< Original rte RSS action. */
1030 uint8_t key[MLX5_RSS_HASH_KEY_LEN]; /**< RSS hash key. */
1031 struct mlx5_ind_table_obj *ind_tbl;
1032 /**< Hash RX queues (hrxq, hrxq_tunnel fields) indirection table. */
1033 uint32_t hrxq[MLX5_RSS_HASH_FIELDS_LEN];
1034 /**< Hash RX queue indexes mapped to mlx5_rss_hash_fields */
1035 rte_spinlock_t action_rss_sl; /**< Shared RSS action spinlock. */
1038 struct rte_flow_action_handle {
1042 /* Thread specific flow workspace intermediate data. */
1043 struct mlx5_flow_workspace {
1044 /* If creating another flow in same thread, push new as stack. */
1045 struct mlx5_flow_workspace *prev;
1046 struct mlx5_flow_workspace *next;
1047 uint32_t inuse; /* can't create new flow with current. */
1048 struct mlx5_flow flows[MLX5_NUM_MAX_DEV_FLOWS];
1049 struct mlx5_flow_rss_desc rss_desc;
1050 uint32_t rssq_num; /* Allocated queue num in rss_desc. */
1051 uint32_t flow_idx; /* Intermediate device flow index. */
1052 struct mlx5_flow_meter_info *fm; /* Pointer to the meter in flow. */
1055 struct mlx5_flow_split_info {
1057 /**< True if flow is created by request external to PMD. */
1058 uint8_t skip_scale; /**< Skip the scale the table with factor. */
1059 uint32_t flow_idx; /**< This memory pool index to the flow. */
1060 uint32_t prefix_mark; /**< Prefix subflow mark flag. */
1061 uint64_t prefix_layers; /**< Prefix subflow layers. */
1064 typedef int (*mlx5_flow_validate_t)(struct rte_eth_dev *dev,
1065 const struct rte_flow_attr *attr,
1066 const struct rte_flow_item items[],
1067 const struct rte_flow_action actions[],
1070 struct rte_flow_error *error);
1071 typedef struct mlx5_flow *(*mlx5_flow_prepare_t)
1072 (struct rte_eth_dev *dev, const struct rte_flow_attr *attr,
1073 const struct rte_flow_item items[],
1074 const struct rte_flow_action actions[], struct rte_flow_error *error);
1075 typedef int (*mlx5_flow_translate_t)(struct rte_eth_dev *dev,
1076 struct mlx5_flow *dev_flow,
1077 const struct rte_flow_attr *attr,
1078 const struct rte_flow_item items[],
1079 const struct rte_flow_action actions[],
1080 struct rte_flow_error *error);
1081 typedef int (*mlx5_flow_apply_t)(struct rte_eth_dev *dev, struct rte_flow *flow,
1082 struct rte_flow_error *error);
1083 typedef void (*mlx5_flow_remove_t)(struct rte_eth_dev *dev,
1084 struct rte_flow *flow);
1085 typedef void (*mlx5_flow_destroy_t)(struct rte_eth_dev *dev,
1086 struct rte_flow *flow);
1087 typedef int (*mlx5_flow_query_t)(struct rte_eth_dev *dev,
1088 struct rte_flow *flow,
1089 const struct rte_flow_action *actions,
1091 struct rte_flow_error *error);
1092 typedef struct mlx5_meter_domains_infos *(*mlx5_flow_create_mtr_tbls_t)
1093 (struct rte_eth_dev *dev);
1094 typedef int (*mlx5_flow_destroy_mtr_tbls_t)(struct rte_eth_dev *dev,
1095 struct mlx5_meter_domains_infos *tbls);
1096 typedef int (*mlx5_flow_create_policer_rules_t)
1097 (struct rte_eth_dev *dev,
1098 struct mlx5_flow_meter_info *fm,
1099 const struct rte_flow_attr *attr);
1100 typedef int (*mlx5_flow_destroy_policer_rules_t)
1101 (struct rte_eth_dev *dev,
1102 const struct mlx5_flow_meter_info *fm,
1103 const struct rte_flow_attr *attr);
1104 typedef uint32_t (*mlx5_flow_mtr_alloc_t)
1105 (struct rte_eth_dev *dev);
1106 typedef void (*mlx5_flow_mtr_free_t)(struct rte_eth_dev *dev,
1108 typedef uint32_t (*mlx5_flow_counter_alloc_t)
1109 (struct rte_eth_dev *dev);
1110 typedef void (*mlx5_flow_counter_free_t)(struct rte_eth_dev *dev,
1112 typedef int (*mlx5_flow_counter_query_t)(struct rte_eth_dev *dev,
1114 bool clear, uint64_t *pkts,
1116 typedef int (*mlx5_flow_get_aged_flows_t)
1117 (struct rte_eth_dev *dev,
1119 uint32_t nb_contexts,
1120 struct rte_flow_error *error);
1121 typedef int (*mlx5_flow_action_validate_t)
1122 (struct rte_eth_dev *dev,
1123 const struct rte_flow_indir_action_conf *conf,
1124 const struct rte_flow_action *action,
1125 struct rte_flow_error *error);
1126 typedef struct rte_flow_action_handle *(*mlx5_flow_action_create_t)
1127 (struct rte_eth_dev *dev,
1128 const struct rte_flow_indir_action_conf *conf,
1129 const struct rte_flow_action *action,
1130 struct rte_flow_error *error);
1131 typedef int (*mlx5_flow_action_destroy_t)
1132 (struct rte_eth_dev *dev,
1133 struct rte_flow_action_handle *action,
1134 struct rte_flow_error *error);
1135 typedef int (*mlx5_flow_action_update_t)
1136 (struct rte_eth_dev *dev,
1137 struct rte_flow_action_handle *action,
1139 struct rte_flow_error *error);
1140 typedef int (*mlx5_flow_action_query_t)
1141 (struct rte_eth_dev *dev,
1142 const struct rte_flow_action_handle *action,
1144 struct rte_flow_error *error);
1145 typedef int (*mlx5_flow_sync_domain_t)
1146 (struct rte_eth_dev *dev,
1150 struct mlx5_flow_driver_ops {
1151 mlx5_flow_validate_t validate;
1152 mlx5_flow_prepare_t prepare;
1153 mlx5_flow_translate_t translate;
1154 mlx5_flow_apply_t apply;
1155 mlx5_flow_remove_t remove;
1156 mlx5_flow_destroy_t destroy;
1157 mlx5_flow_query_t query;
1158 mlx5_flow_create_mtr_tbls_t create_mtr_tbls;
1159 mlx5_flow_destroy_mtr_tbls_t destroy_mtr_tbls;
1160 mlx5_flow_create_policer_rules_t prepare_policer_rules;
1161 mlx5_flow_destroy_policer_rules_t destroy_policer_rules;
1162 mlx5_flow_mtr_alloc_t create_meter;
1163 mlx5_flow_mtr_free_t free_meter;
1164 mlx5_flow_counter_alloc_t counter_alloc;
1165 mlx5_flow_counter_free_t counter_free;
1166 mlx5_flow_counter_query_t counter_query;
1167 mlx5_flow_get_aged_flows_t get_aged_flows;
1168 mlx5_flow_action_validate_t action_validate;
1169 mlx5_flow_action_create_t action_create;
1170 mlx5_flow_action_destroy_t action_destroy;
1171 mlx5_flow_action_update_t action_update;
1172 mlx5_flow_action_query_t action_query;
1173 mlx5_flow_sync_domain_t sync_domain;
1178 struct mlx5_flow_workspace *mlx5_flow_get_thread_workspace(void);
1180 struct flow_grp_info {
1181 uint64_t external:1;
1182 uint64_t transfer:1;
1183 uint64_t fdb_def_rule:1;
1184 /* force standard group translation */
1185 uint64_t std_tbl_fix:1;
1186 uint64_t skip_scale:2;
1190 tunnel_use_standard_attr_group_translate
1191 (struct rte_eth_dev *dev,
1192 const struct mlx5_flow_tunnel *tunnel,
1193 const struct rte_flow_attr *attr,
1194 const struct rte_flow_item items[],
1195 const struct rte_flow_action actions[])
1199 if (!is_tunnel_offload_active(dev))
1200 /* no tunnel offload API */
1204 * OvS will use jump to group 0 in tunnel steer rule.
1205 * If tunnel steer rule starts from group 0 (attr.group == 0)
1206 * that 0 group must be translated with standard method.
1207 * attr.group == 0 in tunnel match rule translated with tunnel
1210 verdict = !attr->group &&
1211 is_flow_tunnel_steer_rule(dev, attr, items, actions);
1214 * non-tunnel group translation uses standard method for
1215 * root group only: attr.group == 0
1217 verdict = !attr->group;
1224 * Get DV flow aso meter by index.
1227 * Pointer to the Ethernet device structure.
1229 * mlx5 flow aso meter index in the container.
1231 * mlx5 flow aso meter pool in the container,
1234 * Pointer to the aso meter, NULL otherwise.
1236 static inline struct mlx5_aso_mtr *
1237 mlx5_aso_meter_by_idx(struct mlx5_priv *priv, uint32_t idx)
1239 struct mlx5_aso_mtr_pool *pool;
1240 struct mlx5_aso_mtr_pools_mng *mtrmng = priv->sh->mtrmng;
1242 /* Decrease to original index. */
1244 MLX5_ASSERT(idx / MLX5_ASO_MTRS_PER_POOL < mtrmng->n);
1245 pool = mtrmng->pools[idx / MLX5_ASO_MTRS_PER_POOL];
1246 return &pool->mtrs[idx % MLX5_ASO_MTRS_PER_POOL];
1249 int mlx5_flow_group_to_table(struct rte_eth_dev *dev,
1250 const struct mlx5_flow_tunnel *tunnel,
1251 uint32_t group, uint32_t *table,
1252 const struct flow_grp_info *flags,
1253 struct rte_flow_error *error);
1254 uint64_t mlx5_flow_hashfields_adjust(struct mlx5_flow_rss_desc *rss_desc,
1255 int tunnel, uint64_t layer_types,
1256 uint64_t hash_fields);
1257 int mlx5_flow_discover_priorities(struct rte_eth_dev *dev);
1258 uint32_t mlx5_flow_adjust_priority(struct rte_eth_dev *dev, int32_t priority,
1259 uint32_t subpriority);
1260 uint32_t mlx5_get_lowest_priority(struct rte_eth_dev *dev,
1261 const struct rte_flow_attr *attr);
1262 uint16_t mlx5_get_matcher_priority(struct rte_eth_dev *dev,
1263 const struct rte_flow_attr *attr,
1264 uint32_t subpriority);
1265 int mlx5_flow_get_reg_id(struct rte_eth_dev *dev,
1266 enum mlx5_feature_name feature,
1268 struct rte_flow_error *error);
1269 const struct rte_flow_action *mlx5_flow_find_action
1270 (const struct rte_flow_action *actions,
1271 enum rte_flow_action_type action);
1272 int mlx5_validate_action_rss(struct rte_eth_dev *dev,
1273 const struct rte_flow_action *action,
1274 struct rte_flow_error *error);
1275 int mlx5_flow_validate_action_count(struct rte_eth_dev *dev,
1276 const struct rte_flow_attr *attr,
1277 struct rte_flow_error *error);
1278 int mlx5_flow_validate_action_drop(uint64_t action_flags,
1279 const struct rte_flow_attr *attr,
1280 struct rte_flow_error *error);
1281 int mlx5_flow_validate_action_flag(uint64_t action_flags,
1282 const struct rte_flow_attr *attr,
1283 struct rte_flow_error *error);
1284 int mlx5_flow_validate_action_mark(const struct rte_flow_action *action,
1285 uint64_t action_flags,
1286 const struct rte_flow_attr *attr,
1287 struct rte_flow_error *error);
1288 int mlx5_flow_validate_action_queue(const struct rte_flow_action *action,
1289 uint64_t action_flags,
1290 struct rte_eth_dev *dev,
1291 const struct rte_flow_attr *attr,
1292 struct rte_flow_error *error);
1293 int mlx5_flow_validate_action_rss(const struct rte_flow_action *action,
1294 uint64_t action_flags,
1295 struct rte_eth_dev *dev,
1296 const struct rte_flow_attr *attr,
1297 uint64_t item_flags,
1298 struct rte_flow_error *error);
1299 int mlx5_flow_validate_action_default_miss(uint64_t action_flags,
1300 const struct rte_flow_attr *attr,
1301 struct rte_flow_error *error);
1302 int mlx5_flow_validate_attributes(struct rte_eth_dev *dev,
1303 const struct rte_flow_attr *attributes,
1304 struct rte_flow_error *error);
1305 int mlx5_flow_item_acceptable(const struct rte_flow_item *item,
1306 const uint8_t *mask,
1307 const uint8_t *nic_mask,
1309 bool range_accepted,
1310 struct rte_flow_error *error);
1311 int mlx5_flow_validate_item_eth(const struct rte_flow_item *item,
1312 uint64_t item_flags, bool ext_vlan_sup,
1313 struct rte_flow_error *error);
1314 int mlx5_flow_validate_item_gre(const struct rte_flow_item *item,
1315 uint64_t item_flags,
1316 uint8_t target_protocol,
1317 struct rte_flow_error *error);
1318 int mlx5_flow_validate_item_gre_key(const struct rte_flow_item *item,
1319 uint64_t item_flags,
1320 const struct rte_flow_item *gre_item,
1321 struct rte_flow_error *error);
1322 int mlx5_flow_validate_item_ipv4(const struct rte_flow_item *item,
1323 uint64_t item_flags,
1325 uint16_t ether_type,
1326 const struct rte_flow_item_ipv4 *acc_mask,
1327 bool range_accepted,
1328 struct rte_flow_error *error);
1329 int mlx5_flow_validate_item_ipv6(const struct rte_flow_item *item,
1330 uint64_t item_flags,
1332 uint16_t ether_type,
1333 const struct rte_flow_item_ipv6 *acc_mask,
1334 struct rte_flow_error *error);
1335 int mlx5_flow_validate_item_mpls(struct rte_eth_dev *dev,
1336 const struct rte_flow_item *item,
1337 uint64_t item_flags,
1338 uint64_t prev_layer,
1339 struct rte_flow_error *error);
1340 int mlx5_flow_validate_item_tcp(const struct rte_flow_item *item,
1341 uint64_t item_flags,
1342 uint8_t target_protocol,
1343 const struct rte_flow_item_tcp *flow_mask,
1344 struct rte_flow_error *error);
1345 int mlx5_flow_validate_item_udp(const struct rte_flow_item *item,
1346 uint64_t item_flags,
1347 uint8_t target_protocol,
1348 struct rte_flow_error *error);
1349 int mlx5_flow_validate_item_vlan(const struct rte_flow_item *item,
1350 uint64_t item_flags,
1351 struct rte_eth_dev *dev,
1352 struct rte_flow_error *error);
1353 int mlx5_flow_validate_item_vxlan(const struct rte_flow_item *item,
1354 uint64_t item_flags,
1355 struct rte_flow_error *error);
1356 int mlx5_flow_validate_item_vxlan_gpe(const struct rte_flow_item *item,
1357 uint64_t item_flags,
1358 struct rte_eth_dev *dev,
1359 struct rte_flow_error *error);
1360 int mlx5_flow_validate_item_icmp(const struct rte_flow_item *item,
1361 uint64_t item_flags,
1362 uint8_t target_protocol,
1363 struct rte_flow_error *error);
1364 int mlx5_flow_validate_item_icmp6(const struct rte_flow_item *item,
1365 uint64_t item_flags,
1366 uint8_t target_protocol,
1367 struct rte_flow_error *error);
1368 int mlx5_flow_validate_item_nvgre(const struct rte_flow_item *item,
1369 uint64_t item_flags,
1370 uint8_t target_protocol,
1371 struct rte_flow_error *error);
1372 int mlx5_flow_validate_item_geneve(const struct rte_flow_item *item,
1373 uint64_t item_flags,
1374 struct rte_eth_dev *dev,
1375 struct rte_flow_error *error);
1376 int mlx5_flow_validate_item_geneve_opt(const struct rte_flow_item *item,
1378 const struct rte_flow_item *geneve_item,
1379 struct rte_eth_dev *dev,
1380 struct rte_flow_error *error);
1381 int mlx5_flow_validate_item_ecpri(const struct rte_flow_item *item,
1382 uint64_t item_flags,
1384 uint16_t ether_type,
1385 const struct rte_flow_item_ecpri *acc_mask,
1386 struct rte_flow_error *error);
1387 struct mlx5_meter_domains_infos *mlx5_flow_create_mtr_tbls
1388 (struct rte_eth_dev *dev);
1389 int mlx5_flow_destroy_mtr_tbls(struct rte_eth_dev *dev,
1390 struct mlx5_meter_domains_infos *tbl);
1391 int mlx5_flow_prepare_policer_rules(struct rte_eth_dev *dev,
1392 struct mlx5_flow_meter_info *fm,
1393 const struct rte_flow_attr *attr);
1394 int mlx5_flow_destroy_policer_rules(struct rte_eth_dev *dev,
1395 struct mlx5_flow_meter_info *fm,
1396 const struct rte_flow_attr *attr);
1397 int mlx5_flow_meter_flush(struct rte_eth_dev *dev,
1398 struct rte_mtr_error *error);
1399 int mlx5_flow_dv_discover_counter_offset_support(struct rte_eth_dev *dev);
1400 int mlx5_action_handle_flush(struct rte_eth_dev *dev);
1401 void mlx5_release_tunnel_hub(struct mlx5_dev_ctx_shared *sh, uint16_t port_id);
1402 int mlx5_alloc_tunnel_hub(struct mlx5_dev_ctx_shared *sh);
1404 /* Hash list callbacks for flow tables: */
1405 struct mlx5_hlist_entry *flow_dv_tbl_create_cb(struct mlx5_hlist *list,
1406 uint64_t key, void *entry_ctx);
1407 int flow_dv_tbl_match_cb(struct mlx5_hlist *list,
1408 struct mlx5_hlist_entry *entry, uint64_t key,
1410 void flow_dv_tbl_remove_cb(struct mlx5_hlist *list,
1411 struct mlx5_hlist_entry *entry);
1412 struct mlx5_flow_tbl_resource *flow_dv_tbl_resource_get(struct rte_eth_dev *dev,
1413 uint32_t table_id, uint8_t egress, uint8_t transfer,
1414 bool external, const struct mlx5_flow_tunnel *tunnel,
1415 uint32_t group_id, uint8_t dummy, struct rte_flow_error *error);
1417 struct mlx5_hlist_entry *flow_dv_tag_create_cb(struct mlx5_hlist *list,
1418 uint64_t key, void *cb_ctx);
1419 int flow_dv_tag_match_cb(struct mlx5_hlist *list,
1420 struct mlx5_hlist_entry *entry, uint64_t key,
1422 void flow_dv_tag_remove_cb(struct mlx5_hlist *list,
1423 struct mlx5_hlist_entry *entry);
1425 int flow_dv_modify_match_cb(struct mlx5_hlist *list,
1426 struct mlx5_hlist_entry *entry,
1427 uint64_t key, void *cb_ctx);
1428 struct mlx5_hlist_entry *flow_dv_modify_create_cb(struct mlx5_hlist *list,
1429 uint64_t key, void *ctx);
1430 void flow_dv_modify_remove_cb(struct mlx5_hlist *list,
1431 struct mlx5_hlist_entry *entry);
1433 struct mlx5_hlist_entry *flow_dv_mreg_create_cb(struct mlx5_hlist *list,
1434 uint64_t key, void *ctx);
1435 int flow_dv_mreg_match_cb(struct mlx5_hlist *list,
1436 struct mlx5_hlist_entry *entry, uint64_t key,
1438 void flow_dv_mreg_remove_cb(struct mlx5_hlist *list,
1439 struct mlx5_hlist_entry *entry);
1441 int flow_dv_encap_decap_match_cb(struct mlx5_hlist *list,
1442 struct mlx5_hlist_entry *entry,
1443 uint64_t key, void *cb_ctx);
1444 struct mlx5_hlist_entry *flow_dv_encap_decap_create_cb(struct mlx5_hlist *list,
1445 uint64_t key, void *cb_ctx);
1446 void flow_dv_encap_decap_remove_cb(struct mlx5_hlist *list,
1447 struct mlx5_hlist_entry *entry);
1449 int flow_dv_matcher_match_cb(struct mlx5_cache_list *list,
1450 struct mlx5_cache_entry *entry, void *ctx);
1451 struct mlx5_cache_entry *flow_dv_matcher_create_cb(struct mlx5_cache_list *list,
1452 struct mlx5_cache_entry *entry, void *ctx);
1453 void flow_dv_matcher_remove_cb(struct mlx5_cache_list *list,
1454 struct mlx5_cache_entry *entry);
1456 int flow_dv_port_id_match_cb(struct mlx5_cache_list *list,
1457 struct mlx5_cache_entry *entry, void *cb_ctx);
1458 struct mlx5_cache_entry *flow_dv_port_id_create_cb(struct mlx5_cache_list *list,
1459 struct mlx5_cache_entry *entry, void *cb_ctx);
1460 void flow_dv_port_id_remove_cb(struct mlx5_cache_list *list,
1461 struct mlx5_cache_entry *entry);
1463 int flow_dv_push_vlan_match_cb(struct mlx5_cache_list *list,
1464 struct mlx5_cache_entry *entry, void *cb_ctx);
1465 struct mlx5_cache_entry *flow_dv_push_vlan_create_cb
1466 (struct mlx5_cache_list *list,
1467 struct mlx5_cache_entry *entry, void *cb_ctx);
1468 void flow_dv_push_vlan_remove_cb(struct mlx5_cache_list *list,
1469 struct mlx5_cache_entry *entry);
1471 int flow_dv_sample_match_cb(struct mlx5_cache_list *list,
1472 struct mlx5_cache_entry *entry, void *cb_ctx);
1473 struct mlx5_cache_entry *flow_dv_sample_create_cb
1474 (struct mlx5_cache_list *list,
1475 struct mlx5_cache_entry *entry, void *cb_ctx);
1476 void flow_dv_sample_remove_cb(struct mlx5_cache_list *list,
1477 struct mlx5_cache_entry *entry);
1479 int flow_dv_dest_array_match_cb(struct mlx5_cache_list *list,
1480 struct mlx5_cache_entry *entry, void *cb_ctx);
1481 struct mlx5_cache_entry *flow_dv_dest_array_create_cb
1482 (struct mlx5_cache_list *list,
1483 struct mlx5_cache_entry *entry, void *cb_ctx);
1484 void flow_dv_dest_array_remove_cb(struct mlx5_cache_list *list,
1485 struct mlx5_cache_entry *entry);
1486 struct mlx5_aso_age_action *flow_aso_age_get_by_idx(struct rte_eth_dev *dev,
1488 int flow_dev_geneve_tlv_option_resource_register(struct rte_eth_dev *dev,
1489 const struct rte_flow_item *item,
1490 struct rte_flow_error *error);
1491 void flow_release_workspace(void *data);
1492 int mlx5_flow_os_init_workspace_once(void);
1493 void *mlx5_flow_os_get_specific_workspace(void);
1494 int mlx5_flow_os_set_specific_workspace(struct mlx5_flow_workspace *data);
1495 void mlx5_flow_os_release_workspace(void);
1496 uint32_t mlx5_flow_mtr_alloc(struct rte_eth_dev *dev);
1497 void mlx5_flow_mtr_free(struct rte_eth_dev *dev, uint32_t mtr_idx);
1498 #endif /* RTE_PMD_MLX5_FLOW_H_ */