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 {
86 /* Default queue number. */
87 #define MLX5_RSSQ_DEFAULT_NUM 16
89 #define MLX5_FLOW_LAYER_OUTER_L2 (1u << 0)
90 #define MLX5_FLOW_LAYER_OUTER_L3_IPV4 (1u << 1)
91 #define MLX5_FLOW_LAYER_OUTER_L3_IPV6 (1u << 2)
92 #define MLX5_FLOW_LAYER_OUTER_L4_UDP (1u << 3)
93 #define MLX5_FLOW_LAYER_OUTER_L4_TCP (1u << 4)
94 #define MLX5_FLOW_LAYER_OUTER_VLAN (1u << 5)
96 /* Pattern inner Layer bits. */
97 #define MLX5_FLOW_LAYER_INNER_L2 (1u << 6)
98 #define MLX5_FLOW_LAYER_INNER_L3_IPV4 (1u << 7)
99 #define MLX5_FLOW_LAYER_INNER_L3_IPV6 (1u << 8)
100 #define MLX5_FLOW_LAYER_INNER_L4_UDP (1u << 9)
101 #define MLX5_FLOW_LAYER_INNER_L4_TCP (1u << 10)
102 #define MLX5_FLOW_LAYER_INNER_VLAN (1u << 11)
104 /* Pattern tunnel Layer bits. */
105 #define MLX5_FLOW_LAYER_VXLAN (1u << 12)
106 #define MLX5_FLOW_LAYER_VXLAN_GPE (1u << 13)
107 #define MLX5_FLOW_LAYER_GRE (1u << 14)
108 #define MLX5_FLOW_LAYER_MPLS (1u << 15)
109 /* List of tunnel Layer bits continued below. */
111 /* General pattern items bits. */
112 #define MLX5_FLOW_ITEM_METADATA (1u << 16)
113 #define MLX5_FLOW_ITEM_PORT_ID (1u << 17)
114 #define MLX5_FLOW_ITEM_TAG (1u << 18)
115 #define MLX5_FLOW_ITEM_MARK (1u << 19)
117 /* Pattern MISC bits. */
118 #define MLX5_FLOW_LAYER_ICMP (1u << 20)
119 #define MLX5_FLOW_LAYER_ICMP6 (1u << 21)
120 #define MLX5_FLOW_LAYER_GRE_KEY (1u << 22)
122 /* Pattern tunnel Layer bits (continued). */
123 #define MLX5_FLOW_LAYER_IPIP (1u << 23)
124 #define MLX5_FLOW_LAYER_IPV6_ENCAP (1u << 24)
125 #define MLX5_FLOW_LAYER_NVGRE (1u << 25)
126 #define MLX5_FLOW_LAYER_GENEVE (1u << 26)
129 #define MLX5_FLOW_ITEM_TX_QUEUE (1u << 27)
131 /* Pattern tunnel Layer bits (continued). */
132 #define MLX5_FLOW_LAYER_GTP (1u << 28)
134 /* Pattern eCPRI Layer bit. */
135 #define MLX5_FLOW_LAYER_ECPRI (UINT64_C(1) << 29)
137 /* IPv6 Fragment Extension Header bit. */
138 #define MLX5_FLOW_LAYER_OUTER_L3_IPV6_FRAG_EXT (1u << 30)
139 #define MLX5_FLOW_LAYER_INNER_L3_IPV6_FRAG_EXT (1u << 31)
141 /* Pattern tunnel Layer bits (continued). */
142 #define MLX5_FLOW_LAYER_GENEVE_OPT (UINT64_C(1) << 32)
143 #define MLX5_FLOW_LAYER_GTP_PSC (UINT64_C(1) << 33)
146 #define MLX5_FLOW_LAYER_OUTER_L3 \
147 (MLX5_FLOW_LAYER_OUTER_L3_IPV4 | MLX5_FLOW_LAYER_OUTER_L3_IPV6)
148 #define MLX5_FLOW_LAYER_OUTER_L4 \
149 (MLX5_FLOW_LAYER_OUTER_L4_UDP | MLX5_FLOW_LAYER_OUTER_L4_TCP)
150 #define MLX5_FLOW_LAYER_OUTER \
151 (MLX5_FLOW_LAYER_OUTER_L2 | MLX5_FLOW_LAYER_OUTER_L3 | \
152 MLX5_FLOW_LAYER_OUTER_L4)
155 #define MLX5_FLOW_LAYER_TUNNEL \
156 (MLX5_FLOW_LAYER_VXLAN | MLX5_FLOW_LAYER_VXLAN_GPE | \
157 MLX5_FLOW_LAYER_GRE | MLX5_FLOW_LAYER_NVGRE | MLX5_FLOW_LAYER_MPLS | \
158 MLX5_FLOW_LAYER_IPIP | MLX5_FLOW_LAYER_IPV6_ENCAP | \
159 MLX5_FLOW_LAYER_GENEVE | MLX5_FLOW_LAYER_GTP)
162 #define MLX5_FLOW_LAYER_INNER_L3 \
163 (MLX5_FLOW_LAYER_INNER_L3_IPV4 | MLX5_FLOW_LAYER_INNER_L3_IPV6)
164 #define MLX5_FLOW_LAYER_INNER_L4 \
165 (MLX5_FLOW_LAYER_INNER_L4_UDP | MLX5_FLOW_LAYER_INNER_L4_TCP)
166 #define MLX5_FLOW_LAYER_INNER \
167 (MLX5_FLOW_LAYER_INNER_L2 | MLX5_FLOW_LAYER_INNER_L3 | \
168 MLX5_FLOW_LAYER_INNER_L4)
171 #define MLX5_FLOW_LAYER_L2 \
172 (MLX5_FLOW_LAYER_OUTER_L2 | MLX5_FLOW_LAYER_INNER_L2)
173 #define MLX5_FLOW_LAYER_L3_IPV4 \
174 (MLX5_FLOW_LAYER_OUTER_L3_IPV4 | MLX5_FLOW_LAYER_INNER_L3_IPV4)
175 #define MLX5_FLOW_LAYER_L3_IPV6 \
176 (MLX5_FLOW_LAYER_OUTER_L3_IPV6 | MLX5_FLOW_LAYER_INNER_L3_IPV6)
177 #define MLX5_FLOW_LAYER_L3 \
178 (MLX5_FLOW_LAYER_L3_IPV4 | MLX5_FLOW_LAYER_L3_IPV6)
179 #define MLX5_FLOW_LAYER_L4 \
180 (MLX5_FLOW_LAYER_OUTER_L4 | MLX5_FLOW_LAYER_INNER_L4)
183 #define MLX5_FLOW_ACTION_DROP (1u << 0)
184 #define MLX5_FLOW_ACTION_QUEUE (1u << 1)
185 #define MLX5_FLOW_ACTION_RSS (1u << 2)
186 #define MLX5_FLOW_ACTION_FLAG (1u << 3)
187 #define MLX5_FLOW_ACTION_MARK (1u << 4)
188 #define MLX5_FLOW_ACTION_COUNT (1u << 5)
189 #define MLX5_FLOW_ACTION_PORT_ID (1u << 6)
190 #define MLX5_FLOW_ACTION_OF_POP_VLAN (1u << 7)
191 #define MLX5_FLOW_ACTION_OF_PUSH_VLAN (1u << 8)
192 #define MLX5_FLOW_ACTION_OF_SET_VLAN_VID (1u << 9)
193 #define MLX5_FLOW_ACTION_OF_SET_VLAN_PCP (1u << 10)
194 #define MLX5_FLOW_ACTION_SET_IPV4_SRC (1u << 11)
195 #define MLX5_FLOW_ACTION_SET_IPV4_DST (1u << 12)
196 #define MLX5_FLOW_ACTION_SET_IPV6_SRC (1u << 13)
197 #define MLX5_FLOW_ACTION_SET_IPV6_DST (1u << 14)
198 #define MLX5_FLOW_ACTION_SET_TP_SRC (1u << 15)
199 #define MLX5_FLOW_ACTION_SET_TP_DST (1u << 16)
200 #define MLX5_FLOW_ACTION_JUMP (1u << 17)
201 #define MLX5_FLOW_ACTION_SET_TTL (1u << 18)
202 #define MLX5_FLOW_ACTION_DEC_TTL (1u << 19)
203 #define MLX5_FLOW_ACTION_SET_MAC_SRC (1u << 20)
204 #define MLX5_FLOW_ACTION_SET_MAC_DST (1u << 21)
205 #define MLX5_FLOW_ACTION_ENCAP (1u << 22)
206 #define MLX5_FLOW_ACTION_DECAP (1u << 23)
207 #define MLX5_FLOW_ACTION_INC_TCP_SEQ (1u << 24)
208 #define MLX5_FLOW_ACTION_DEC_TCP_SEQ (1u << 25)
209 #define MLX5_FLOW_ACTION_INC_TCP_ACK (1u << 26)
210 #define MLX5_FLOW_ACTION_DEC_TCP_ACK (1u << 27)
211 #define MLX5_FLOW_ACTION_SET_TAG (1ull << 28)
212 #define MLX5_FLOW_ACTION_MARK_EXT (1ull << 29)
213 #define MLX5_FLOW_ACTION_SET_META (1ull << 30)
214 #define MLX5_FLOW_ACTION_METER (1ull << 31)
215 #define MLX5_FLOW_ACTION_SET_IPV4_DSCP (1ull << 32)
216 #define MLX5_FLOW_ACTION_SET_IPV6_DSCP (1ull << 33)
217 #define MLX5_FLOW_ACTION_AGE (1ull << 34)
218 #define MLX5_FLOW_ACTION_DEFAULT_MISS (1ull << 35)
219 #define MLX5_FLOW_ACTION_SAMPLE (1ull << 36)
220 #define MLX5_FLOW_ACTION_TUNNEL_SET (1ull << 37)
221 #define MLX5_FLOW_ACTION_TUNNEL_MATCH (1ull << 38)
223 #define MLX5_FLOW_FATE_ACTIONS \
224 (MLX5_FLOW_ACTION_DROP | MLX5_FLOW_ACTION_QUEUE | \
225 MLX5_FLOW_ACTION_RSS | MLX5_FLOW_ACTION_JUMP | \
226 MLX5_FLOW_ACTION_DEFAULT_MISS)
228 #define MLX5_FLOW_FATE_ESWITCH_ACTIONS \
229 (MLX5_FLOW_ACTION_DROP | MLX5_FLOW_ACTION_PORT_ID | \
230 MLX5_FLOW_ACTION_JUMP)
233 #define MLX5_FLOW_MODIFY_HDR_ACTIONS (MLX5_FLOW_ACTION_SET_IPV4_SRC | \
234 MLX5_FLOW_ACTION_SET_IPV4_DST | \
235 MLX5_FLOW_ACTION_SET_IPV6_SRC | \
236 MLX5_FLOW_ACTION_SET_IPV6_DST | \
237 MLX5_FLOW_ACTION_SET_TP_SRC | \
238 MLX5_FLOW_ACTION_SET_TP_DST | \
239 MLX5_FLOW_ACTION_SET_TTL | \
240 MLX5_FLOW_ACTION_DEC_TTL | \
241 MLX5_FLOW_ACTION_SET_MAC_SRC | \
242 MLX5_FLOW_ACTION_SET_MAC_DST | \
243 MLX5_FLOW_ACTION_INC_TCP_SEQ | \
244 MLX5_FLOW_ACTION_DEC_TCP_SEQ | \
245 MLX5_FLOW_ACTION_INC_TCP_ACK | \
246 MLX5_FLOW_ACTION_DEC_TCP_ACK | \
247 MLX5_FLOW_ACTION_OF_SET_VLAN_VID | \
248 MLX5_FLOW_ACTION_SET_TAG | \
249 MLX5_FLOW_ACTION_MARK_EXT | \
250 MLX5_FLOW_ACTION_SET_META | \
251 MLX5_FLOW_ACTION_SET_IPV4_DSCP | \
252 MLX5_FLOW_ACTION_SET_IPV6_DSCP)
254 #define MLX5_FLOW_VLAN_ACTIONS (MLX5_FLOW_ACTION_OF_POP_VLAN | \
255 MLX5_FLOW_ACTION_OF_PUSH_VLAN)
257 #define MLX5_FLOW_XCAP_ACTIONS (MLX5_FLOW_ACTION_ENCAP | MLX5_FLOW_ACTION_DECAP)
260 #define IPPROTO_MPLS 137
263 /* UDP port number for MPLS */
264 #define MLX5_UDP_PORT_MPLS 6635
266 /* UDP port numbers for VxLAN. */
267 #define MLX5_UDP_PORT_VXLAN 4789
268 #define MLX5_UDP_PORT_VXLAN_GPE 4790
270 /* UDP port numbers for GENEVE. */
271 #define MLX5_UDP_PORT_GENEVE 6081
273 /* Priority reserved for default flows. */
274 #define MLX5_FLOW_PRIO_RSVD ((uint32_t)-1)
277 * Number of sub priorities.
278 * For each kind of pattern matching i.e. L2, L3, L4 to have a correct
279 * matching on the NIC (firmware dependent) L4 most have the higher priority
280 * followed by L3 and ending with L2.
282 #define MLX5_PRIORITY_MAP_L2 2
283 #define MLX5_PRIORITY_MAP_L3 1
284 #define MLX5_PRIORITY_MAP_L4 0
285 #define MLX5_PRIORITY_MAP_MAX 3
287 /* Valid layer type for IPV4 RSS. */
288 #define MLX5_IPV4_LAYER_TYPES \
289 (ETH_RSS_IPV4 | ETH_RSS_FRAG_IPV4 | \
290 ETH_RSS_NONFRAG_IPV4_TCP | ETH_RSS_NONFRAG_IPV4_UDP | \
291 ETH_RSS_NONFRAG_IPV4_OTHER)
293 /* IBV hash source bits for IPV4. */
294 #define MLX5_IPV4_IBV_RX_HASH (IBV_RX_HASH_SRC_IPV4 | IBV_RX_HASH_DST_IPV4)
296 /* Valid layer type for IPV6 RSS. */
297 #define MLX5_IPV6_LAYER_TYPES \
298 (ETH_RSS_IPV6 | ETH_RSS_FRAG_IPV6 | ETH_RSS_NONFRAG_IPV6_TCP | \
299 ETH_RSS_NONFRAG_IPV6_UDP | ETH_RSS_IPV6_EX | ETH_RSS_IPV6_TCP_EX | \
300 ETH_RSS_IPV6_UDP_EX | ETH_RSS_NONFRAG_IPV6_OTHER)
302 /* IBV hash source bits for IPV6. */
303 #define MLX5_IPV6_IBV_RX_HASH (IBV_RX_HASH_SRC_IPV6 | IBV_RX_HASH_DST_IPV6)
305 /* IBV hash bits for L3 SRC. */
306 #define MLX5_L3_SRC_IBV_RX_HASH (IBV_RX_HASH_SRC_IPV4 | IBV_RX_HASH_SRC_IPV6)
308 /* IBV hash bits for L3 DST. */
309 #define MLX5_L3_DST_IBV_RX_HASH (IBV_RX_HASH_DST_IPV4 | IBV_RX_HASH_DST_IPV6)
311 /* IBV hash bits for TCP. */
312 #define MLX5_TCP_IBV_RX_HASH (IBV_RX_HASH_SRC_PORT_TCP | \
313 IBV_RX_HASH_DST_PORT_TCP)
315 /* IBV hash bits for UDP. */
316 #define MLX5_UDP_IBV_RX_HASH (IBV_RX_HASH_SRC_PORT_UDP | \
317 IBV_RX_HASH_DST_PORT_UDP)
319 /* IBV hash bits for L4 SRC. */
320 #define MLX5_L4_SRC_IBV_RX_HASH (IBV_RX_HASH_SRC_PORT_TCP | \
321 IBV_RX_HASH_SRC_PORT_UDP)
323 /* IBV hash bits for L4 DST. */
324 #define MLX5_L4_DST_IBV_RX_HASH (IBV_RX_HASH_DST_PORT_TCP | \
325 IBV_RX_HASH_DST_PORT_UDP)
327 /* Geneve header first 16Bit */
328 #define MLX5_GENEVE_VER_MASK 0x3
329 #define MLX5_GENEVE_VER_SHIFT 14
330 #define MLX5_GENEVE_VER_VAL(a) \
331 (((a) >> (MLX5_GENEVE_VER_SHIFT)) & (MLX5_GENEVE_VER_MASK))
332 #define MLX5_GENEVE_OPTLEN_MASK 0x3F
333 #define MLX5_GENEVE_OPTLEN_SHIFT 8
334 #define MLX5_GENEVE_OPTLEN_VAL(a) \
335 (((a) >> (MLX5_GENEVE_OPTLEN_SHIFT)) & (MLX5_GENEVE_OPTLEN_MASK))
336 #define MLX5_GENEVE_OAMF_MASK 0x1
337 #define MLX5_GENEVE_OAMF_SHIFT 7
338 #define MLX5_GENEVE_OAMF_VAL(a) \
339 (((a) >> (MLX5_GENEVE_OAMF_SHIFT)) & (MLX5_GENEVE_OAMF_MASK))
340 #define MLX5_GENEVE_CRITO_MASK 0x1
341 #define MLX5_GENEVE_CRITO_SHIFT 6
342 #define MLX5_GENEVE_CRITO_VAL(a) \
343 (((a) >> (MLX5_GENEVE_CRITO_SHIFT)) & (MLX5_GENEVE_CRITO_MASK))
344 #define MLX5_GENEVE_RSVD_MASK 0x3F
345 #define MLX5_GENEVE_RSVD_VAL(a) ((a) & (MLX5_GENEVE_RSVD_MASK))
347 * The length of the Geneve options fields, expressed in four byte multiples,
348 * not including the eight byte fixed tunnel.
350 #define MLX5_GENEVE_OPT_LEN_0 14
351 #define MLX5_GENEVE_OPT_LEN_1 63
353 #define MLX5_ENCAPSULATION_DECISION_SIZE (sizeof(struct rte_ether_hdr) + \
354 sizeof(struct rte_ipv4_hdr))
355 /* GTP extension header flag. */
356 #define MLX5_GTP_EXT_HEADER_FLAG 4
358 /* GTP extension header max PDU type value. */
359 #define MLX5_GTP_EXT_MAX_PDU_TYPE 15
361 /* GTP extension header PDU type shift. */
362 #define MLX5_GTP_PDU_TYPE_SHIFT(a) ((a) << 4)
364 /* IPv4 fragment_offset field contains relevant data in bits 2 to 15. */
365 #define MLX5_IPV4_FRAG_OFFSET_MASK \
366 (RTE_IPV4_HDR_OFFSET_MASK | RTE_IPV4_HDR_MF_FLAG)
368 /* Specific item's fields can accept a range of values (using spec and last). */
369 #define MLX5_ITEM_RANGE_NOT_ACCEPTED false
370 #define MLX5_ITEM_RANGE_ACCEPTED true
372 /* Software header modify action numbers of a flow. */
373 #define MLX5_ACT_NUM_MDF_IPV4 1
374 #define MLX5_ACT_NUM_MDF_IPV6 4
375 #define MLX5_ACT_NUM_MDF_MAC 2
376 #define MLX5_ACT_NUM_MDF_VID 1
377 #define MLX5_ACT_NUM_MDF_PORT 2
378 #define MLX5_ACT_NUM_MDF_TTL 1
379 #define MLX5_ACT_NUM_DEC_TTL MLX5_ACT_NUM_MDF_TTL
380 #define MLX5_ACT_NUM_MDF_TCPSEQ 1
381 #define MLX5_ACT_NUM_MDF_TCPACK 1
382 #define MLX5_ACT_NUM_SET_REG 1
383 #define MLX5_ACT_NUM_SET_TAG 1
384 #define MLX5_ACT_NUM_CPY_MREG MLX5_ACT_NUM_SET_TAG
385 #define MLX5_ACT_NUM_SET_MARK MLX5_ACT_NUM_SET_TAG
386 #define MLX5_ACT_NUM_SET_META MLX5_ACT_NUM_SET_TAG
387 #define MLX5_ACT_NUM_SET_DSCP 1
389 enum mlx5_flow_drv_type {
392 MLX5_FLOW_TYPE_VERBS,
396 /* Fate action type. */
397 enum mlx5_flow_fate_type {
398 MLX5_FLOW_FATE_NONE, /* Egress flow. */
399 MLX5_FLOW_FATE_QUEUE,
401 MLX5_FLOW_FATE_PORT_ID,
403 MLX5_FLOW_FATE_DEFAULT_MISS,
404 MLX5_FLOW_FATE_SHARED_RSS,
408 /* Matcher PRM representation */
409 struct mlx5_flow_dv_match_params {
411 /**< Size of match value. Do NOT split size and key! */
412 uint32_t buf[MLX5_ST_SZ_DW(fte_match_param)];
413 /**< Matcher value. This value is used as the mask or as a key. */
416 /* Matcher structure. */
417 struct mlx5_flow_dv_matcher {
418 struct mlx5_cache_entry entry; /**< Pointer to the next element. */
419 struct mlx5_flow_tbl_resource *tbl;
420 /**< Pointer to the table(group) the matcher associated with. */
421 void *matcher_object; /**< Pointer to DV matcher */
422 uint16_t crc; /**< CRC of key. */
423 uint16_t priority; /**< Priority of matcher. */
424 struct mlx5_flow_dv_match_params mask; /**< Matcher mask. */
427 #define MLX5_ENCAP_MAX_LEN 132
429 /* Encap/decap resource structure. */
430 struct mlx5_flow_dv_encap_decap_resource {
431 struct mlx5_hlist_entry entry;
432 /* Pointer to next element. */
433 uint32_t refcnt; /**< Reference counter. */
435 /**< Encap/decap action object. */
436 uint8_t buf[MLX5_ENCAP_MAX_LEN];
438 uint8_t reformat_type;
440 uint64_t flags; /**< Flags for RDMA API. */
441 uint32_t idx; /**< Index for the index memory pool. */
444 /* Tag resource structure. */
445 struct mlx5_flow_dv_tag_resource {
446 struct mlx5_hlist_entry entry;
447 /**< hash list entry for tag resource, tag value as the key. */
449 /**< Tag action object. */
450 uint32_t refcnt; /**< Reference counter. */
451 uint32_t idx; /**< Index for the index memory pool. */
452 uint32_t tag_id; /**< Tag ID. */
456 * Number of modification commands.
457 * The maximal actions amount in FW is some constant, and it is 16 in the
458 * latest releases. In some old releases, it will be limited to 8.
459 * Since there is no interface to query the capacity, the maximal value should
460 * be used to allow PMD to create the flow. The validation will be done in the
461 * lower driver layer or FW. A failure will be returned if exceeds the maximal
462 * supported actions number on the root table.
463 * On non-root tables, there is no limitation, but 32 is enough right now.
465 #define MLX5_MAX_MODIFY_NUM 32
466 #define MLX5_ROOT_TBL_MODIFY_NUM 16
468 /* Modify resource structure */
469 struct mlx5_flow_dv_modify_hdr_resource {
470 struct mlx5_hlist_entry entry;
471 void *action; /**< Modify header action object. */
472 /* Key area for hash list matching: */
473 uint8_t ft_type; /**< Flow table type, Rx or Tx. */
474 uint32_t actions_num; /**< Number of modification actions. */
475 uint64_t flags; /**< Flags for RDMA API. */
476 struct mlx5_modification_cmd actions[];
477 /**< Modification actions. */
480 /* Modify resource key of the hash organization. */
481 union mlx5_flow_modify_hdr_key {
483 uint32_t ft_type:8; /**< Flow table type, Rx or Tx. */
484 uint32_t actions_num:5; /**< Number of modification actions. */
485 uint32_t group:19; /**< Flow group id. */
486 uint32_t cksum; /**< Actions check sum. */
488 uint64_t v64; /**< full 64bits value of key */
491 /* Jump action resource structure. */
492 struct mlx5_flow_dv_jump_tbl_resource {
493 void *action; /**< Pointer to the rdma core action. */
496 /* Port ID resource structure. */
497 struct mlx5_flow_dv_port_id_action_resource {
498 struct mlx5_cache_entry entry;
499 void *action; /**< Action object. */
500 uint32_t port_id; /**< Port ID value. */
501 uint32_t idx; /**< Indexed pool memory index. */
504 /* Push VLAN action resource structure */
505 struct mlx5_flow_dv_push_vlan_action_resource {
506 struct mlx5_cache_entry entry; /* Cache entry. */
507 void *action; /**< Action object. */
508 uint8_t ft_type; /**< Flow table type, Rx, Tx or FDB. */
509 rte_be32_t vlan_tag; /**< VLAN tag value. */
510 uint32_t idx; /**< Indexed pool memory index. */
513 /* Metadata register copy table entry. */
514 struct mlx5_flow_mreg_copy_resource {
516 * Hash list entry for copy table.
517 * - Key is 32/64-bit MARK action ID.
518 * - MUST be the first entry.
520 struct mlx5_hlist_entry hlist_ent;
521 LIST_ENTRY(mlx5_flow_mreg_copy_resource) next;
522 /* List entry for device flows. */
524 uint32_t rix_flow; /* Built flow for copy. */
528 /* Table tunnel parameter. */
529 struct mlx5_flow_tbl_tunnel_prm {
530 const struct mlx5_flow_tunnel *tunnel;
535 /* Table data structure of the hash organization. */
536 struct mlx5_flow_tbl_data_entry {
537 struct mlx5_hlist_entry entry;
538 /**< hash list entry, 64-bits key inside. */
539 struct mlx5_flow_tbl_resource tbl;
540 /**< flow table resource. */
541 struct mlx5_cache_list matchers;
542 /**< matchers' header associated with the flow table. */
543 struct mlx5_flow_dv_jump_tbl_resource jump;
544 /**< jump resource, at most one for each table created. */
545 uint32_t idx; /**< index for the indexed mempool. */
546 /**< tunnel offload */
547 const struct mlx5_flow_tunnel *tunnel;
550 uint32_t tunnel_offload:1; /* Tunnel offlod table or not. */
551 uint32_t is_egress:1; /**< Egress table. */
552 uint32_t is_transfer:1; /**< Transfer table. */
553 uint32_t dummy:1; /**< DR table. */
554 uint32_t reserve:27; /**< Reserved to future using. */
555 uint32_t table_id; /**< Table ID. */
558 /* Sub rdma-core actions list. */
559 struct mlx5_flow_sub_actions_list {
560 uint32_t actions_num; /**< Number of sample actions. */
561 uint64_t action_flags;
562 void *dr_queue_action;
565 void *dr_port_id_action;
566 void *dr_encap_action;
569 /* Sample sub-actions resource list. */
570 struct mlx5_flow_sub_actions_idx {
571 uint32_t rix_hrxq; /**< Hash Rx queue object index. */
572 uint32_t rix_tag; /**< Index to the tag action. */
574 uint32_t rix_port_id_action; /**< Index to port ID action resource. */
575 uint32_t rix_encap_decap; /**< Index to encap/decap resource. */
578 /* Sample action resource structure. */
579 struct mlx5_flow_dv_sample_resource {
580 struct mlx5_cache_entry entry; /**< Cache entry. */
582 void *verbs_action; /**< Verbs sample action object. */
583 void **sub_actions; /**< Sample sub-action array. */
585 struct rte_eth_dev *dev; /**< Device registers the action. */
586 uint32_t idx; /** Sample object index. */
587 uint8_t ft_type; /** Flow Table Type */
588 uint32_t ft_id; /** Flow Table Level */
589 uint32_t ratio; /** Sample Ratio */
590 uint64_t set_action; /** Restore reg_c0 value */
591 void *normal_path_tbl; /** Flow Table pointer */
592 void *default_miss; /** default_miss dr_action. */
593 struct mlx5_flow_sub_actions_idx sample_idx;
594 /**< Action index resources. */
595 struct mlx5_flow_sub_actions_list sample_act;
596 /**< Action resources. */
599 #define MLX5_MAX_DEST_NUM 2
601 /* Destination array action resource structure. */
602 struct mlx5_flow_dv_dest_array_resource {
603 struct mlx5_cache_entry entry; /**< Cache entry. */
604 uint32_t idx; /** Destination array action object index. */
605 uint8_t ft_type; /** Flow Table Type */
606 uint8_t num_of_dest; /**< Number of destination actions. */
607 struct rte_eth_dev *dev; /**< Device registers the action. */
608 void *action; /**< Pointer to the rdma core action. */
609 struct mlx5_flow_sub_actions_idx sample_idx[MLX5_MAX_DEST_NUM];
610 /**< Action index resources. */
611 struct mlx5_flow_sub_actions_list sample_act[MLX5_MAX_DEST_NUM];
612 /**< Action resources. */
615 /* PMD flow priority for tunnel */
616 #define MLX5_TUNNEL_PRIO_GET(rss_desc) \
617 ((rss_desc)->level >= 2 ? MLX5_PRIORITY_MAP_L2 : MLX5_PRIORITY_MAP_L4)
620 /** Device flow handle structure for DV mode only. */
621 struct mlx5_flow_handle_dv {
623 struct mlx5_flow_dv_matcher *matcher; /**< Cache to matcher. */
624 struct mlx5_flow_dv_modify_hdr_resource *modify_hdr;
625 /**< Pointer to modify header resource in cache. */
626 uint32_t rix_encap_decap;
627 /**< Index to encap/decap resource in cache. */
628 uint32_t rix_push_vlan;
629 /**< Index to push VLAN action resource in cache. */
631 /**< Index to the tag action. */
633 /**< Index to sample action resource in cache. */
634 uint32_t rix_dest_array;
635 /**< Index to destination array resource in cache. */
638 /** Device flow handle structure: used both for creating & destroying. */
639 struct mlx5_flow_handle {
640 SILIST_ENTRY(uint32_t)next;
641 struct mlx5_vf_vlan vf_vlan; /**< Structure for VF VLAN workaround. */
642 /**< Index to next device flow handle. */
644 /**< Bit-fields of present layers, see MLX5_FLOW_LAYER_*. */
645 void *drv_flow; /**< pointer to driver flow object. */
646 uint32_t split_flow_id:28; /**< Sub flow unique match flow id. */
647 uint32_t mark:1; /**< Metadate rxq mark flag. */
648 uint32_t fate_action:3; /**< Fate action type. */
650 uint32_t rix_hrxq; /**< Hash Rx queue object index. */
651 uint32_t rix_jump; /**< Index to the jump action resource. */
652 uint32_t rix_port_id_action;
653 /**< Index to port ID action resource. */
655 /**< Generic value indicates the fate action. */
656 uint32_t rix_default_fate;
657 /**< Indicates default miss fate action. */
659 /**< Indicates shared RSS fate action. */
661 #if defined(HAVE_IBV_FLOW_DV_SUPPORT) || !defined(HAVE_INFINIBAND_VERBS_H)
662 struct mlx5_flow_handle_dv dvh;
667 * Size for Verbs device flow handle structure only. Do not use the DV only
668 * structure in Verbs. No DV flows attributes will be accessed.
669 * Macro offsetof() could also be used here.
671 #if defined(HAVE_IBV_FLOW_DV_SUPPORT) || !defined(HAVE_INFINIBAND_VERBS_H)
672 #define MLX5_FLOW_HANDLE_VERBS_SIZE \
673 (sizeof(struct mlx5_flow_handle) - sizeof(struct mlx5_flow_handle_dv))
675 #define MLX5_FLOW_HANDLE_VERBS_SIZE (sizeof(struct mlx5_flow_handle))
679 * Max number of actions per DV flow.
680 * See CREATE_FLOW_MAX_FLOW_ACTIONS_SUPPORTED
681 * in rdma-core file providers/mlx5/verbs.c.
683 #define MLX5_DV_MAX_NUMBER_OF_ACTIONS 8
685 /** Device flow structure only for DV flow creation. */
686 struct mlx5_flow_dv_workspace {
687 uint32_t group; /**< The group index. */
688 uint8_t transfer; /**< 1 if the flow is E-Switch flow. */
689 int actions_n; /**< number of actions. */
690 void *actions[MLX5_DV_MAX_NUMBER_OF_ACTIONS]; /**< Action list. */
691 struct mlx5_flow_dv_encap_decap_resource *encap_decap;
692 /**< Pointer to encap/decap resource in cache. */
693 struct mlx5_flow_dv_push_vlan_action_resource *push_vlan_res;
694 /**< Pointer to push VLAN action resource in cache. */
695 struct mlx5_flow_dv_tag_resource *tag_resource;
696 /**< pointer to the tag action. */
697 struct mlx5_flow_dv_port_id_action_resource *port_id_action;
698 /**< Pointer to port ID action resource. */
699 struct mlx5_flow_dv_jump_tbl_resource *jump;
700 /**< Pointer to the jump action resource. */
701 struct mlx5_flow_dv_match_params value;
702 /**< Holds the value that the packet is compared to. */
703 struct mlx5_flow_dv_sample_resource *sample_res;
704 /**< Pointer to the sample action resource. */
705 struct mlx5_flow_dv_dest_array_resource *dest_array_res;
706 /**< Pointer to the destination array resource. */
709 #ifdef HAVE_INFINIBAND_VERBS_H
711 * Maximal Verbs flow specifications & actions size.
712 * Some elements are mutually exclusive, but enough space should be allocated.
713 * Tunnel cases: 1. Max 2 Ethernet + IP(v6 len > v4 len) + TCP/UDP headers.
714 * 2. One tunnel header (exception: GRE + MPLS),
715 * SPEC length: GRE == tunnel.
716 * Actions: 1. 1 Mark OR Flag.
717 * 2. 1 Drop (if any).
718 * 3. No limitation for counters, but it makes no sense to support too
719 * many counters in a single device flow.
721 #ifdef HAVE_IBV_DEVICE_MPLS_SUPPORT
722 #define MLX5_VERBS_MAX_SPEC_SIZE \
724 (2 * (sizeof(struct ibv_flow_spec_eth) + \
725 sizeof(struct ibv_flow_spec_ipv6) + \
726 sizeof(struct ibv_flow_spec_tcp_udp)) + \
727 sizeof(struct ibv_flow_spec_gre) + \
728 sizeof(struct ibv_flow_spec_mpls)) \
731 #define MLX5_VERBS_MAX_SPEC_SIZE \
733 (2 * (sizeof(struct ibv_flow_spec_eth) + \
734 sizeof(struct ibv_flow_spec_ipv6) + \
735 sizeof(struct ibv_flow_spec_tcp_udp)) + \
736 sizeof(struct ibv_flow_spec_tunnel)) \
740 #if defined(HAVE_IBV_DEVICE_COUNTERS_SET_V42) || \
741 defined(HAVE_IBV_DEVICE_COUNTERS_SET_V45)
742 #define MLX5_VERBS_MAX_ACT_SIZE \
744 sizeof(struct ibv_flow_spec_action_tag) + \
745 sizeof(struct ibv_flow_spec_action_drop) + \
746 sizeof(struct ibv_flow_spec_counter_action) * 4 \
749 #define MLX5_VERBS_MAX_ACT_SIZE \
751 sizeof(struct ibv_flow_spec_action_tag) + \
752 sizeof(struct ibv_flow_spec_action_drop) \
756 #define MLX5_VERBS_MAX_SPEC_ACT_SIZE \
757 (MLX5_VERBS_MAX_SPEC_SIZE + MLX5_VERBS_MAX_ACT_SIZE)
759 /** Device flow structure only for Verbs flow creation. */
760 struct mlx5_flow_verbs_workspace {
761 unsigned int size; /**< Size of the attribute. */
762 struct ibv_flow_attr attr; /**< Verbs flow attribute buffer. */
763 uint8_t specs[MLX5_VERBS_MAX_SPEC_ACT_SIZE];
764 /**< Specifications & actions buffer of verbs flow. */
766 #endif /* HAVE_INFINIBAND_VERBS_H */
768 /** Maximal number of device sub-flows supported. */
769 #define MLX5_NUM_MAX_DEV_FLOWS 32
771 /** Device flow structure. */
774 struct rte_flow *flow; /**< Pointer to the main flow. */
775 uint32_t flow_idx; /**< The memory pool index to the main flow. */
776 uint64_t hash_fields; /**< Hash Rx queue hash fields. */
778 /**< Bit-fields of detected actions, see MLX5_FLOW_ACTION_*. */
779 bool external; /**< true if the flow is created external to PMD. */
780 uint8_t ingress:1; /**< 1 if the flow is ingress. */
781 uint8_t skip_scale:1;
782 /**< 1 if skip the scale the table with factor. */
784 #if defined(HAVE_IBV_FLOW_DV_SUPPORT) || !defined(HAVE_INFINIBAND_VERBS_H)
785 struct mlx5_flow_dv_workspace dv;
787 #ifdef HAVE_INFINIBAND_VERBS_H
788 struct mlx5_flow_verbs_workspace verbs;
791 struct mlx5_flow_handle *handle;
792 uint32_t handle_idx; /* Index of the mlx5 flow handle memory. */
793 const struct mlx5_flow_tunnel *tunnel;
796 /* Flow meter state. */
797 #define MLX5_FLOW_METER_DISABLE 0
798 #define MLX5_FLOW_METER_ENABLE 1
800 #define MLX5_MAN_WIDTH 8
801 /* Modify this value if enum rte_mtr_color changes. */
802 #define RTE_MTR_DROPPED RTE_COLORS
804 /* Meter policer statistics */
805 struct mlx5_flow_policer_stats {
806 uint32_t cnt[RTE_COLORS + 1];
807 /**< Color counter, extra for drop. */
809 /**< Statistics mask for the colors. */
812 /* Meter table structure. */
813 struct mlx5_meter_domain_info {
814 struct mlx5_flow_tbl_resource *tbl;
816 struct mlx5_flow_tbl_resource *sfx_tbl;
817 /**< Meter suffix table. */
819 /**< Meter color not match default criteria. */
821 /**< Meter color match criteria. */
823 /**< Meter match action. */
824 void *policer_rules[RTE_MTR_DROPPED + 1];
825 /**< Meter policer for the match. */
828 /* Meter table set for TX RX FDB. */
829 struct mlx5_meter_domains_infos {
831 /**< Table user count. */
832 struct mlx5_meter_domain_info egress;
833 /**< TX meter table. */
834 struct mlx5_meter_domain_info ingress;
835 /**< RX meter table. */
836 struct mlx5_meter_domain_info transfer;
837 /**< FDB meter table. */
839 /**< Drop action as not matched. */
840 void *count_actns[RTE_MTR_DROPPED + 1];
841 /**< Counters for match and unmatched statistics. */
842 uint32_t fmp[MLX5_ST_SZ_DW(flow_meter_parameters)];
843 /**< Flow meter parameter. */
845 /**< Flow meter parameter size. */
847 /**< Flow meter action. */
850 /* Meter parameter structure. */
851 struct mlx5_flow_meter {
852 TAILQ_ENTRY(mlx5_flow_meter) next;
853 /**< Pointer to the next flow meter structure. */
854 uint32_t idx; /* Index to meter object. */
857 struct mlx5_flow_meter_profile *profile;
858 /**< Meter profile parameters. */
860 rte_spinlock_t sl; /**< Meter action spinlock. */
862 /** Policer actions (per meter output color). */
863 enum rte_mtr_policer_action action[RTE_COLORS];
865 /** Set of stats counters to be enabled.
866 * @see enum rte_mtr_stats_type
870 /**< Rule applies to ingress traffic. */
873 /**< Rule applies to egress traffic. */
876 * Instead of simply matching the properties of traffic as it would
877 * appear on a given DPDK port ID, enabling this attribute transfers
878 * a flow rule to the lowest possible level of any device endpoints
879 * found in the pattern.
881 * When supported, this effectively enables an application to
882 * re-route traffic not necessarily intended for it (e.g. coming
883 * from or addressed to different physical ports, VFs or
884 * applications) at the device level.
886 * It complements the behavior of some pattern items such as
887 * RTE_FLOW_ITEM_TYPE_PHY_PORT and is meaningless without them.
889 * When transferring flow rules, ingress and egress attributes keep
890 * their original meaning, as if processing traffic emitted or
891 * received by the application.
894 struct mlx5_meter_domains_infos *mfts;
895 /**< Flow table created for this meter. */
896 struct mlx5_flow_policer_stats policer_stats;
897 /**< Meter policer statistics. */
900 uint32_t active_state:1;
903 /**< Meter shared or not. */
906 /* RFC2697 parameter structure. */
907 struct mlx5_flow_meter_srtcm_rfc2697_prm {
908 /* green_saturation_value = cbs_mantissa * 2^cbs_exponent */
909 uint32_t cbs_exponent:5;
910 uint32_t cbs_mantissa:8;
911 /* cir = 8G * cir_mantissa * 1/(2^cir_exponent) Bytes/Sec */
912 uint32_t cir_exponent:5;
913 uint32_t cir_mantissa:8;
914 /* yellow _saturation_value = ebs_mantissa * 2^ebs_exponent */
915 uint32_t ebs_exponent:5;
916 uint32_t ebs_mantissa:8;
919 /* Flow meter profile structure. */
920 struct mlx5_flow_meter_profile {
921 TAILQ_ENTRY(mlx5_flow_meter_profile) next;
922 /**< Pointer to the next flow meter structure. */
923 uint32_t meter_profile_id; /**< Profile id. */
924 struct rte_mtr_meter_profile profile; /**< Profile detail. */
926 struct mlx5_flow_meter_srtcm_rfc2697_prm srtcm_prm;
927 /**< srtcm_rfc2697 struct. */
929 uint32_t ref_cnt; /**< Use count. */
932 #define MLX5_MAX_TUNNELS 256
933 #define MLX5_TNL_MISS_RULE_PRIORITY 3
934 #define MLX5_TNL_MISS_FDB_JUMP_GRP 0x1234faac
937 * When tunnel offload is active, all JUMP group ids are converted
938 * using the same method. That conversion is applied both to tunnel and
939 * regular rule types.
940 * Group ids used in tunnel rules are relative to it's tunnel (!).
941 * Application can create number of steer rules, using the same
942 * tunnel, with different group id in each rule.
943 * Each tunnel stores its groups internally in PMD tunnel object.
944 * Groups used in regular rules do not belong to any tunnel and are stored
948 struct mlx5_flow_tunnel {
949 LIST_ENTRY(mlx5_flow_tunnel) chain;
950 struct rte_flow_tunnel app_tunnel; /** app tunnel copy */
951 uint32_t tunnel_id; /** unique tunnel ID */
953 struct rte_flow_action action;
954 struct rte_flow_item item;
955 struct mlx5_hlist *groups; /** tunnel groups */
958 /** PMD tunnel related context */
959 struct mlx5_flow_tunnel_hub {
961 * Access to the list MUST be MT protected
963 LIST_HEAD(, mlx5_flow_tunnel) tunnels;
964 /* protect access to the tunnels list */
966 struct mlx5_hlist *groups; /** non tunnel groups */
969 /* convert jump group to flow table ID in tunnel rules */
970 struct tunnel_tbl_entry {
971 struct mlx5_hlist_entry hash;
977 static inline uint32_t
978 tunnel_id_to_flow_tbl(uint32_t id)
980 return id | (1u << 16);
983 static inline uint32_t
984 tunnel_flow_tbl_to_id(uint32_t flow_tbl)
986 return flow_tbl & ~(1u << 16);
989 union tunnel_tbl_key {
997 static inline struct mlx5_flow_tunnel_hub *
998 mlx5_tunnel_hub(struct rte_eth_dev *dev)
1000 struct mlx5_priv *priv = dev->data->dev_private;
1001 return priv->sh->tunnel_hub;
1005 is_tunnel_offload_active(struct rte_eth_dev *dev)
1007 #ifdef HAVE_IBV_FLOW_DV_SUPPORT
1008 struct mlx5_priv *priv = dev->data->dev_private;
1009 return !!priv->config.dv_miss_info;
1017 is_flow_tunnel_match_rule(__rte_unused struct rte_eth_dev *dev,
1018 __rte_unused const struct rte_flow_attr *attr,
1019 __rte_unused const struct rte_flow_item items[],
1020 __rte_unused const struct rte_flow_action actions[])
1022 return (items[0].type == (typeof(items[0].type))
1023 MLX5_RTE_FLOW_ITEM_TYPE_TUNNEL);
1027 is_flow_tunnel_steer_rule(__rte_unused struct rte_eth_dev *dev,
1028 __rte_unused const struct rte_flow_attr *attr,
1029 __rte_unused const struct rte_flow_item items[],
1030 __rte_unused const struct rte_flow_action actions[])
1032 return (actions[0].type == (typeof(actions[0].type))
1033 MLX5_RTE_FLOW_ACTION_TYPE_TUNNEL_SET);
1036 static inline const struct mlx5_flow_tunnel *
1037 flow_actions_to_tunnel(const struct rte_flow_action actions[])
1039 return actions[0].conf;
1042 static inline const struct mlx5_flow_tunnel *
1043 flow_items_to_tunnel(const struct rte_flow_item items[])
1045 return items[0].spec;
1048 /* Flow structure. */
1050 ILIST_ENTRY(uint32_t)next; /**< Index to the next flow structure. */
1051 uint32_t dev_handles;
1052 /**< Device flow handles that are part of the flow. */
1053 uint32_t drv_type:2; /**< Driver type. */
1055 uint32_t meter:16; /**< Holds flow meter id. */
1056 uint32_t rix_mreg_copy;
1057 /**< Index to metadata register copy table resource. */
1058 uint32_t counter; /**< Holds flow counter. */
1059 uint32_t tunnel_id; /**< Tunnel id */
1060 uint32_t age; /**< Holds ASO age bit index. */
1061 uint32_t geneve_tlv_option; /**< Holds Geneve TLV option id. > */
1065 * Define list of valid combinations of RX Hash fields
1066 * (see enum ibv_rx_hash_fields).
1068 #define MLX5_RSS_HASH_IPV4 (IBV_RX_HASH_SRC_IPV4 | IBV_RX_HASH_DST_IPV4)
1069 #define MLX5_RSS_HASH_IPV4_TCP \
1070 (MLX5_RSS_HASH_IPV4 | \
1071 IBV_RX_HASH_SRC_PORT_TCP | IBV_RX_HASH_SRC_PORT_TCP)
1072 #define MLX5_RSS_HASH_IPV4_UDP \
1073 (MLX5_RSS_HASH_IPV4 | \
1074 IBV_RX_HASH_SRC_PORT_UDP | IBV_RX_HASH_SRC_PORT_UDP)
1075 #define MLX5_RSS_HASH_IPV6 (IBV_RX_HASH_SRC_IPV6 | IBV_RX_HASH_DST_IPV6)
1076 #define MLX5_RSS_HASH_IPV6_TCP \
1077 (MLX5_RSS_HASH_IPV6 | \
1078 IBV_RX_HASH_SRC_PORT_TCP | IBV_RX_HASH_SRC_PORT_TCP)
1079 #define MLX5_RSS_HASH_IPV6_UDP \
1080 (MLX5_RSS_HASH_IPV6 | \
1081 IBV_RX_HASH_SRC_PORT_UDP | IBV_RX_HASH_SRC_PORT_UDP)
1082 #define MLX5_RSS_HASH_NONE 0ULL
1084 /* array of valid combinations of RX Hash fields for RSS */
1085 static const uint64_t mlx5_rss_hash_fields[] = {
1087 MLX5_RSS_HASH_IPV4_TCP,
1088 MLX5_RSS_HASH_IPV4_UDP,
1090 MLX5_RSS_HASH_IPV6_TCP,
1091 MLX5_RSS_HASH_IPV6_UDP,
1095 /* Shared RSS action structure */
1096 struct mlx5_shared_action_rss {
1097 ILIST_ENTRY(uint32_t)next; /**< Index to the next RSS structure. */
1098 uint32_t refcnt; /**< Atomically accessed refcnt. */
1099 struct rte_flow_action_rss origin; /**< Original rte RSS action. */
1100 uint8_t key[MLX5_RSS_HASH_KEY_LEN]; /**< RSS hash key. */
1101 struct mlx5_ind_table_obj *ind_tbl;
1102 /**< Hash RX queues (hrxq, hrxq_tunnel fields) indirection table. */
1103 uint32_t hrxq[MLX5_RSS_HASH_FIELDS_LEN];
1104 /**< Hash RX queue indexes mapped to mlx5_rss_hash_fields */
1105 uint32_t hrxq_tunnel[MLX5_RSS_HASH_FIELDS_LEN];
1106 /**< Hash RX queue indexes for tunneled RSS */
1107 rte_spinlock_t action_rss_sl; /**< Shared RSS action spinlock. */
1110 struct rte_flow_shared_action {
1114 /* Thread specific flow workspace intermediate data. */
1115 struct mlx5_flow_workspace {
1116 /* If creating another flow in same thread, push new as stack. */
1117 struct mlx5_flow_workspace *prev;
1118 struct mlx5_flow_workspace *next;
1119 uint32_t inuse; /* can't create new flow with current. */
1120 struct mlx5_flow flows[MLX5_NUM_MAX_DEV_FLOWS];
1121 struct mlx5_flow_rss_desc rss_desc;
1122 uint32_t rssq_num; /* Allocated queue num in rss_desc. */
1123 uint32_t flow_idx; /* Intermediate device flow index. */
1126 struct mlx5_flow_split_info {
1128 /**< True if flow is created by request external to PMD. */
1129 uint8_t skip_scale; /**< Skip the scale the table with factor. */
1130 uint32_t flow_idx; /**< This memory pool index to the flow. */
1131 uint32_t prefix_mark; /**< Prefix subflow mark flag. */
1132 uint64_t prefix_layers; /**< Prefix subflow layers. */
1135 typedef int (*mlx5_flow_validate_t)(struct rte_eth_dev *dev,
1136 const struct rte_flow_attr *attr,
1137 const struct rte_flow_item items[],
1138 const struct rte_flow_action actions[],
1141 struct rte_flow_error *error);
1142 typedef struct mlx5_flow *(*mlx5_flow_prepare_t)
1143 (struct rte_eth_dev *dev, const struct rte_flow_attr *attr,
1144 const struct rte_flow_item items[],
1145 const struct rte_flow_action actions[], struct rte_flow_error *error);
1146 typedef int (*mlx5_flow_translate_t)(struct rte_eth_dev *dev,
1147 struct mlx5_flow *dev_flow,
1148 const struct rte_flow_attr *attr,
1149 const struct rte_flow_item items[],
1150 const struct rte_flow_action actions[],
1151 struct rte_flow_error *error);
1152 typedef int (*mlx5_flow_apply_t)(struct rte_eth_dev *dev, struct rte_flow *flow,
1153 struct rte_flow_error *error);
1154 typedef void (*mlx5_flow_remove_t)(struct rte_eth_dev *dev,
1155 struct rte_flow *flow);
1156 typedef void (*mlx5_flow_destroy_t)(struct rte_eth_dev *dev,
1157 struct rte_flow *flow);
1158 typedef int (*mlx5_flow_query_t)(struct rte_eth_dev *dev,
1159 struct rte_flow *flow,
1160 const struct rte_flow_action *actions,
1162 struct rte_flow_error *error);
1163 typedef struct mlx5_meter_domains_infos *(*mlx5_flow_create_mtr_tbls_t)
1164 (struct rte_eth_dev *dev,
1165 const struct mlx5_flow_meter *fm);
1166 typedef int (*mlx5_flow_destroy_mtr_tbls_t)(struct rte_eth_dev *dev,
1167 struct mlx5_meter_domains_infos *tbls);
1168 typedef int (*mlx5_flow_create_policer_rules_t)
1169 (struct rte_eth_dev *dev,
1170 struct mlx5_flow_meter *fm,
1171 const struct rte_flow_attr *attr);
1172 typedef int (*mlx5_flow_destroy_policer_rules_t)
1173 (struct rte_eth_dev *dev,
1174 const struct mlx5_flow_meter *fm,
1175 const struct rte_flow_attr *attr);
1176 typedef uint32_t (*mlx5_flow_counter_alloc_t)
1177 (struct rte_eth_dev *dev);
1178 typedef void (*mlx5_flow_counter_free_t)(struct rte_eth_dev *dev,
1180 typedef int (*mlx5_flow_counter_query_t)(struct rte_eth_dev *dev,
1182 bool clear, uint64_t *pkts,
1184 typedef int (*mlx5_flow_get_aged_flows_t)
1185 (struct rte_eth_dev *dev,
1187 uint32_t nb_contexts,
1188 struct rte_flow_error *error);
1189 typedef int (*mlx5_flow_action_validate_t)
1190 (struct rte_eth_dev *dev,
1191 const struct rte_flow_shared_action_conf *conf,
1192 const struct rte_flow_action *action,
1193 struct rte_flow_error *error);
1194 typedef struct rte_flow_shared_action *(*mlx5_flow_action_create_t)
1195 (struct rte_eth_dev *dev,
1196 const struct rte_flow_shared_action_conf *conf,
1197 const struct rte_flow_action *action,
1198 struct rte_flow_error *error);
1199 typedef int (*mlx5_flow_action_destroy_t)
1200 (struct rte_eth_dev *dev,
1201 struct rte_flow_shared_action *action,
1202 struct rte_flow_error *error);
1203 typedef int (*mlx5_flow_action_update_t)
1204 (struct rte_eth_dev *dev,
1205 struct rte_flow_shared_action *action,
1206 const void *action_conf,
1207 struct rte_flow_error *error);
1208 typedef int (*mlx5_flow_action_query_t)
1209 (struct rte_eth_dev *dev,
1210 const struct rte_flow_shared_action *action,
1212 struct rte_flow_error *error);
1213 typedef int (*mlx5_flow_sync_domain_t)
1214 (struct rte_eth_dev *dev,
1218 struct mlx5_flow_driver_ops {
1219 mlx5_flow_validate_t validate;
1220 mlx5_flow_prepare_t prepare;
1221 mlx5_flow_translate_t translate;
1222 mlx5_flow_apply_t apply;
1223 mlx5_flow_remove_t remove;
1224 mlx5_flow_destroy_t destroy;
1225 mlx5_flow_query_t query;
1226 mlx5_flow_create_mtr_tbls_t create_mtr_tbls;
1227 mlx5_flow_destroy_mtr_tbls_t destroy_mtr_tbls;
1228 mlx5_flow_create_policer_rules_t create_policer_rules;
1229 mlx5_flow_destroy_policer_rules_t destroy_policer_rules;
1230 mlx5_flow_counter_alloc_t counter_alloc;
1231 mlx5_flow_counter_free_t counter_free;
1232 mlx5_flow_counter_query_t counter_query;
1233 mlx5_flow_get_aged_flows_t get_aged_flows;
1234 mlx5_flow_action_validate_t action_validate;
1235 mlx5_flow_action_create_t action_create;
1236 mlx5_flow_action_destroy_t action_destroy;
1237 mlx5_flow_action_update_t action_update;
1238 mlx5_flow_action_query_t action_query;
1239 mlx5_flow_sync_domain_t sync_domain;
1244 struct mlx5_flow_workspace *mlx5_flow_get_thread_workspace(void);
1246 struct flow_grp_info {
1247 uint64_t external:1;
1248 uint64_t transfer:1;
1249 uint64_t fdb_def_rule:1;
1250 /* force standard group translation */
1251 uint64_t std_tbl_fix:1;
1252 uint64_t skip_scale:1;
1256 tunnel_use_standard_attr_group_translate
1257 (struct rte_eth_dev *dev,
1258 const struct mlx5_flow_tunnel *tunnel,
1259 const struct rte_flow_attr *attr,
1260 const struct rte_flow_item items[],
1261 const struct rte_flow_action actions[])
1265 if (!is_tunnel_offload_active(dev))
1266 /* no tunnel offload API */
1270 * OvS will use jump to group 0 in tunnel steer rule.
1271 * If tunnel steer rule starts from group 0 (attr.group == 0)
1272 * that 0 group must be translated with standard method.
1273 * attr.group == 0 in tunnel match rule translated with tunnel
1276 verdict = !attr->group &&
1277 is_flow_tunnel_steer_rule(dev, attr, items, actions);
1280 * non-tunnel group translation uses standard method for
1281 * root group only: attr.group == 0
1283 verdict = !attr->group;
1289 int mlx5_flow_group_to_table(struct rte_eth_dev *dev,
1290 const struct mlx5_flow_tunnel *tunnel,
1291 uint32_t group, uint32_t *table,
1292 const struct flow_grp_info *flags,
1293 struct rte_flow_error *error);
1294 uint64_t mlx5_flow_hashfields_adjust(struct mlx5_flow_rss_desc *rss_desc,
1295 int tunnel, uint64_t layer_types,
1296 uint64_t hash_fields);
1297 int mlx5_flow_discover_priorities(struct rte_eth_dev *dev);
1298 uint32_t mlx5_flow_adjust_priority(struct rte_eth_dev *dev, int32_t priority,
1299 uint32_t subpriority);
1300 int mlx5_flow_get_reg_id(struct rte_eth_dev *dev,
1301 enum mlx5_feature_name feature,
1303 struct rte_flow_error *error);
1304 const struct rte_flow_action *mlx5_flow_find_action
1305 (const struct rte_flow_action *actions,
1306 enum rte_flow_action_type action);
1307 int mlx5_validate_action_rss(struct rte_eth_dev *dev,
1308 const struct rte_flow_action *action,
1309 struct rte_flow_error *error);
1310 int mlx5_flow_validate_action_count(struct rte_eth_dev *dev,
1311 const struct rte_flow_attr *attr,
1312 struct rte_flow_error *error);
1313 int mlx5_flow_validate_action_drop(uint64_t action_flags,
1314 const struct rte_flow_attr *attr,
1315 struct rte_flow_error *error);
1316 int mlx5_flow_validate_action_flag(uint64_t action_flags,
1317 const struct rte_flow_attr *attr,
1318 struct rte_flow_error *error);
1319 int mlx5_flow_validate_action_mark(const struct rte_flow_action *action,
1320 uint64_t action_flags,
1321 const struct rte_flow_attr *attr,
1322 struct rte_flow_error *error);
1323 int mlx5_flow_validate_action_queue(const struct rte_flow_action *action,
1324 uint64_t action_flags,
1325 struct rte_eth_dev *dev,
1326 const struct rte_flow_attr *attr,
1327 struct rte_flow_error *error);
1328 int mlx5_flow_validate_action_rss(const struct rte_flow_action *action,
1329 uint64_t action_flags,
1330 struct rte_eth_dev *dev,
1331 const struct rte_flow_attr *attr,
1332 uint64_t item_flags,
1333 struct rte_flow_error *error);
1334 int mlx5_flow_validate_action_default_miss(uint64_t action_flags,
1335 const struct rte_flow_attr *attr,
1336 struct rte_flow_error *error);
1337 int mlx5_flow_validate_attributes(struct rte_eth_dev *dev,
1338 const struct rte_flow_attr *attributes,
1339 struct rte_flow_error *error);
1340 int mlx5_flow_item_acceptable(const struct rte_flow_item *item,
1341 const uint8_t *mask,
1342 const uint8_t *nic_mask,
1344 bool range_accepted,
1345 struct rte_flow_error *error);
1346 int mlx5_flow_validate_item_eth(const struct rte_flow_item *item,
1347 uint64_t item_flags, bool ext_vlan_sup,
1348 struct rte_flow_error *error);
1349 int mlx5_flow_validate_item_gre(const struct rte_flow_item *item,
1350 uint64_t item_flags,
1351 uint8_t target_protocol,
1352 struct rte_flow_error *error);
1353 int mlx5_flow_validate_item_gre_key(const struct rte_flow_item *item,
1354 uint64_t item_flags,
1355 const struct rte_flow_item *gre_item,
1356 struct rte_flow_error *error);
1357 int mlx5_flow_validate_item_ipv4(const struct rte_flow_item *item,
1358 uint64_t item_flags,
1360 uint16_t ether_type,
1361 const struct rte_flow_item_ipv4 *acc_mask,
1362 bool range_accepted,
1363 struct rte_flow_error *error);
1364 int mlx5_flow_validate_item_ipv6(const struct rte_flow_item *item,
1365 uint64_t item_flags,
1367 uint16_t ether_type,
1368 const struct rte_flow_item_ipv6 *acc_mask,
1369 struct rte_flow_error *error);
1370 int mlx5_flow_validate_item_mpls(struct rte_eth_dev *dev,
1371 const struct rte_flow_item *item,
1372 uint64_t item_flags,
1373 uint64_t prev_layer,
1374 struct rte_flow_error *error);
1375 int mlx5_flow_validate_item_tcp(const struct rte_flow_item *item,
1376 uint64_t item_flags,
1377 uint8_t target_protocol,
1378 const struct rte_flow_item_tcp *flow_mask,
1379 struct rte_flow_error *error);
1380 int mlx5_flow_validate_item_udp(const struct rte_flow_item *item,
1381 uint64_t item_flags,
1382 uint8_t target_protocol,
1383 struct rte_flow_error *error);
1384 int mlx5_flow_validate_item_vlan(const struct rte_flow_item *item,
1385 uint64_t item_flags,
1386 struct rte_eth_dev *dev,
1387 struct rte_flow_error *error);
1388 int mlx5_flow_validate_item_vxlan(const struct rte_flow_item *item,
1389 uint64_t item_flags,
1390 struct rte_flow_error *error);
1391 int mlx5_flow_validate_item_vxlan_gpe(const struct rte_flow_item *item,
1392 uint64_t item_flags,
1393 struct rte_eth_dev *dev,
1394 struct rte_flow_error *error);
1395 int mlx5_flow_validate_item_icmp(const struct rte_flow_item *item,
1396 uint64_t item_flags,
1397 uint8_t target_protocol,
1398 struct rte_flow_error *error);
1399 int mlx5_flow_validate_item_icmp6(const struct rte_flow_item *item,
1400 uint64_t item_flags,
1401 uint8_t target_protocol,
1402 struct rte_flow_error *error);
1403 int mlx5_flow_validate_item_nvgre(const struct rte_flow_item *item,
1404 uint64_t item_flags,
1405 uint8_t target_protocol,
1406 struct rte_flow_error *error);
1407 int mlx5_flow_validate_item_geneve(const struct rte_flow_item *item,
1408 uint64_t item_flags,
1409 struct rte_eth_dev *dev,
1410 struct rte_flow_error *error);
1411 int mlx5_flow_validate_item_geneve_opt(const struct rte_flow_item *item,
1413 const struct rte_flow_item *geneve_item,
1414 struct rte_eth_dev *dev,
1415 struct rte_flow_error *error);
1416 int mlx5_flow_validate_item_ecpri(const struct rte_flow_item *item,
1417 uint64_t item_flags,
1419 uint16_t ether_type,
1420 const struct rte_flow_item_ecpri *acc_mask,
1421 struct rte_flow_error *error);
1422 struct mlx5_meter_domains_infos *mlx5_flow_create_mtr_tbls
1423 (struct rte_eth_dev *dev,
1424 const struct mlx5_flow_meter *fm);
1425 int mlx5_flow_destroy_mtr_tbls(struct rte_eth_dev *dev,
1426 struct mlx5_meter_domains_infos *tbl);
1427 int mlx5_flow_create_policer_rules(struct rte_eth_dev *dev,
1428 struct mlx5_flow_meter *fm,
1429 const struct rte_flow_attr *attr);
1430 int mlx5_flow_destroy_policer_rules(struct rte_eth_dev *dev,
1431 struct mlx5_flow_meter *fm,
1432 const struct rte_flow_attr *attr);
1433 int mlx5_flow_meter_flush(struct rte_eth_dev *dev,
1434 struct rte_mtr_error *error);
1435 int mlx5_flow_dv_discover_counter_offset_support(struct rte_eth_dev *dev);
1436 int mlx5_shared_action_flush(struct rte_eth_dev *dev);
1437 void mlx5_release_tunnel_hub(struct mlx5_dev_ctx_shared *sh, uint16_t port_id);
1438 int mlx5_alloc_tunnel_hub(struct mlx5_dev_ctx_shared *sh);
1440 /* Hash list callbacks for flow tables: */
1441 struct mlx5_hlist_entry *flow_dv_tbl_create_cb(struct mlx5_hlist *list,
1442 uint64_t key, void *entry_ctx);
1443 int flow_dv_tbl_match_cb(struct mlx5_hlist *list,
1444 struct mlx5_hlist_entry *entry, uint64_t key,
1446 void flow_dv_tbl_remove_cb(struct mlx5_hlist *list,
1447 struct mlx5_hlist_entry *entry);
1448 struct mlx5_flow_tbl_resource *flow_dv_tbl_resource_get(struct rte_eth_dev *dev,
1449 uint32_t table_id, uint8_t egress, uint8_t transfer,
1450 bool external, const struct mlx5_flow_tunnel *tunnel,
1451 uint32_t group_id, uint8_t dummy, struct rte_flow_error *error);
1453 struct mlx5_hlist_entry *flow_dv_tag_create_cb(struct mlx5_hlist *list,
1454 uint64_t key, void *cb_ctx);
1455 int flow_dv_tag_match_cb(struct mlx5_hlist *list,
1456 struct mlx5_hlist_entry *entry, uint64_t key,
1458 void flow_dv_tag_remove_cb(struct mlx5_hlist *list,
1459 struct mlx5_hlist_entry *entry);
1461 int flow_dv_modify_match_cb(struct mlx5_hlist *list,
1462 struct mlx5_hlist_entry *entry,
1463 uint64_t key, void *cb_ctx);
1464 struct mlx5_hlist_entry *flow_dv_modify_create_cb(struct mlx5_hlist *list,
1465 uint64_t key, void *ctx);
1466 void flow_dv_modify_remove_cb(struct mlx5_hlist *list,
1467 struct mlx5_hlist_entry *entry);
1469 struct mlx5_hlist_entry *flow_dv_mreg_create_cb(struct mlx5_hlist *list,
1470 uint64_t key, void *ctx);
1471 int flow_dv_mreg_match_cb(struct mlx5_hlist *list,
1472 struct mlx5_hlist_entry *entry, uint64_t key,
1474 void flow_dv_mreg_remove_cb(struct mlx5_hlist *list,
1475 struct mlx5_hlist_entry *entry);
1477 int flow_dv_encap_decap_match_cb(struct mlx5_hlist *list,
1478 struct mlx5_hlist_entry *entry,
1479 uint64_t key, void *cb_ctx);
1480 struct mlx5_hlist_entry *flow_dv_encap_decap_create_cb(struct mlx5_hlist *list,
1481 uint64_t key, void *cb_ctx);
1482 void flow_dv_encap_decap_remove_cb(struct mlx5_hlist *list,
1483 struct mlx5_hlist_entry *entry);
1485 int flow_dv_matcher_match_cb(struct mlx5_cache_list *list,
1486 struct mlx5_cache_entry *entry, void *ctx);
1487 struct mlx5_cache_entry *flow_dv_matcher_create_cb(struct mlx5_cache_list *list,
1488 struct mlx5_cache_entry *entry, void *ctx);
1489 void flow_dv_matcher_remove_cb(struct mlx5_cache_list *list,
1490 struct mlx5_cache_entry *entry);
1492 int flow_dv_port_id_match_cb(struct mlx5_cache_list *list,
1493 struct mlx5_cache_entry *entry, void *cb_ctx);
1494 struct mlx5_cache_entry *flow_dv_port_id_create_cb(struct mlx5_cache_list *list,
1495 struct mlx5_cache_entry *entry, void *cb_ctx);
1496 void flow_dv_port_id_remove_cb(struct mlx5_cache_list *list,
1497 struct mlx5_cache_entry *entry);
1499 int flow_dv_push_vlan_match_cb(struct mlx5_cache_list *list,
1500 struct mlx5_cache_entry *entry, void *cb_ctx);
1501 struct mlx5_cache_entry *flow_dv_push_vlan_create_cb
1502 (struct mlx5_cache_list *list,
1503 struct mlx5_cache_entry *entry, void *cb_ctx);
1504 void flow_dv_push_vlan_remove_cb(struct mlx5_cache_list *list,
1505 struct mlx5_cache_entry *entry);
1507 int flow_dv_sample_match_cb(struct mlx5_cache_list *list,
1508 struct mlx5_cache_entry *entry, void *cb_ctx);
1509 struct mlx5_cache_entry *flow_dv_sample_create_cb
1510 (struct mlx5_cache_list *list,
1511 struct mlx5_cache_entry *entry, void *cb_ctx);
1512 void flow_dv_sample_remove_cb(struct mlx5_cache_list *list,
1513 struct mlx5_cache_entry *entry);
1515 int flow_dv_dest_array_match_cb(struct mlx5_cache_list *list,
1516 struct mlx5_cache_entry *entry, void *cb_ctx);
1517 struct mlx5_cache_entry *flow_dv_dest_array_create_cb
1518 (struct mlx5_cache_list *list,
1519 struct mlx5_cache_entry *entry, void *cb_ctx);
1520 void flow_dv_dest_array_remove_cb(struct mlx5_cache_list *list,
1521 struct mlx5_cache_entry *entry);
1522 struct mlx5_aso_age_action *flow_aso_age_get_by_idx(struct rte_eth_dev *dev,
1524 int flow_dev_geneve_tlv_option_resource_register(struct rte_eth_dev *dev,
1525 const struct rte_flow_item *item,
1526 struct rte_flow_error *error);
1528 void flow_release_workspace(void *data);
1529 int mlx5_flow_os_init_workspace_once(void);
1530 void *mlx5_flow_os_get_specific_workspace(void);
1531 int mlx5_flow_os_set_specific_workspace(struct mlx5_flow_workspace *data);
1532 void mlx5_flow_os_release_workspace(void);
1535 #endif /* RTE_PMD_MLX5_FLOW_H_ */