9832542328411c233126e840f7e0154cf6f4fb8e
[dpdk.git] / drivers / net / mlx5 / mlx5_flow.h
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright 2018 Mellanox Technologies, Ltd
3  */
4
5 #ifndef RTE_PMD_MLX5_FLOW_H_
6 #define RTE_PMD_MLX5_FLOW_H_
7
8 #include <netinet/in.h>
9 #include <sys/queue.h>
10 #include <stdalign.h>
11 #include <stdint.h>
12 #include <string.h>
13
14 /* Verbs header. */
15 /* ISO C doesn't support unnamed structs/unions, disabling -pedantic. */
16 #ifdef PEDANTIC
17 #pragma GCC diagnostic ignored "-Wpedantic"
18 #endif
19 #include <infiniband/verbs.h>
20 #ifdef PEDANTIC
21 #pragma GCC diagnostic error "-Wpedantic"
22 #endif
23
24 #include <rte_atomic.h>
25 #include <rte_alarm.h>
26 #include <rte_mtr.h>
27
28 #include "mlx5.h"
29 #include "mlx5_prm.h"
30
31 /* Private rte flow items. */
32 enum mlx5_rte_flow_item_type {
33         MLX5_RTE_FLOW_ITEM_TYPE_END = INT_MIN,
34         MLX5_RTE_FLOW_ITEM_TYPE_TAG,
35         MLX5_RTE_FLOW_ITEM_TYPE_TX_QUEUE,
36 };
37
38 /* Private (internal) rte flow actions. */
39 enum mlx5_rte_flow_action_type {
40         MLX5_RTE_FLOW_ACTION_TYPE_END = INT_MIN,
41         MLX5_RTE_FLOW_ACTION_TYPE_TAG,
42         MLX5_RTE_FLOW_ACTION_TYPE_MARK,
43         MLX5_RTE_FLOW_ACTION_TYPE_COPY_MREG,
44 };
45
46 /* Matches on selected register. */
47 struct mlx5_rte_flow_item_tag {
48         enum modify_reg id;
49         uint32_t data;
50 };
51
52 /* Modify selected register. */
53 struct mlx5_rte_flow_action_set_tag {
54         enum modify_reg id;
55         uint32_t data;
56 };
57
58 struct mlx5_flow_action_copy_mreg {
59         enum modify_reg dst;
60         enum modify_reg src;
61 };
62
63 /* Matches on source queue. */
64 struct mlx5_rte_flow_item_tx_queue {
65         uint32_t queue;
66 };
67
68 /* Feature name to allocate metadata register. */
69 enum mlx5_feature_name {
70         MLX5_HAIRPIN_RX,
71         MLX5_HAIRPIN_TX,
72         MLX5_METADATA_RX,
73         MLX5_METADATA_TX,
74         MLX5_METADATA_FDB,
75         MLX5_FLOW_MARK,
76         MLX5_APP_TAG,
77         MLX5_COPY_MARK,
78         MLX5_MTR_COLOR,
79         MLX5_MTR_SFX,
80 };
81
82 /* Pattern outer Layer bits. */
83 #define MLX5_FLOW_LAYER_OUTER_L2 (1u << 0)
84 #define MLX5_FLOW_LAYER_OUTER_L3_IPV4 (1u << 1)
85 #define MLX5_FLOW_LAYER_OUTER_L3_IPV6 (1u << 2)
86 #define MLX5_FLOW_LAYER_OUTER_L4_UDP (1u << 3)
87 #define MLX5_FLOW_LAYER_OUTER_L4_TCP (1u << 4)
88 #define MLX5_FLOW_LAYER_OUTER_VLAN (1u << 5)
89
90 /* Pattern inner Layer bits. */
91 #define MLX5_FLOW_LAYER_INNER_L2 (1u << 6)
92 #define MLX5_FLOW_LAYER_INNER_L3_IPV4 (1u << 7)
93 #define MLX5_FLOW_LAYER_INNER_L3_IPV6 (1u << 8)
94 #define MLX5_FLOW_LAYER_INNER_L4_UDP (1u << 9)
95 #define MLX5_FLOW_LAYER_INNER_L4_TCP (1u << 10)
96 #define MLX5_FLOW_LAYER_INNER_VLAN (1u << 11)
97
98 /* Pattern tunnel Layer bits. */
99 #define MLX5_FLOW_LAYER_VXLAN (1u << 12)
100 #define MLX5_FLOW_LAYER_VXLAN_GPE (1u << 13)
101 #define MLX5_FLOW_LAYER_GRE (1u << 14)
102 #define MLX5_FLOW_LAYER_MPLS (1u << 15)
103 /* List of tunnel Layer bits continued below. */
104
105 /* General pattern items bits. */
106 #define MLX5_FLOW_ITEM_METADATA (1u << 16)
107 #define MLX5_FLOW_ITEM_PORT_ID (1u << 17)
108 #define MLX5_FLOW_ITEM_TAG (1u << 18)
109 #define MLX5_FLOW_ITEM_MARK (1u << 19)
110
111 /* Pattern MISC bits. */
112 #define MLX5_FLOW_LAYER_ICMP (1u << 20)
113 #define MLX5_FLOW_LAYER_ICMP6 (1u << 21)
114 #define MLX5_FLOW_LAYER_GRE_KEY (1u << 22)
115
116 /* Pattern tunnel Layer bits (continued). */
117 #define MLX5_FLOW_LAYER_IPIP (1u << 23)
118 #define MLX5_FLOW_LAYER_IPV6_ENCAP (1u << 24)
119 #define MLX5_FLOW_LAYER_NVGRE (1u << 25)
120 #define MLX5_FLOW_LAYER_GENEVE (1u << 26)
121
122 /* Queue items. */
123 #define MLX5_FLOW_ITEM_TX_QUEUE (1u << 27)
124
125 /* Pattern tunnel Layer bits (continued). */
126 #define MLX5_FLOW_LAYER_GTP (1u << 28)
127
128 /* Outer Masks. */
129 #define MLX5_FLOW_LAYER_OUTER_L3 \
130         (MLX5_FLOW_LAYER_OUTER_L3_IPV4 | MLX5_FLOW_LAYER_OUTER_L3_IPV6)
131 #define MLX5_FLOW_LAYER_OUTER_L4 \
132         (MLX5_FLOW_LAYER_OUTER_L4_UDP | MLX5_FLOW_LAYER_OUTER_L4_TCP)
133 #define MLX5_FLOW_LAYER_OUTER \
134         (MLX5_FLOW_LAYER_OUTER_L2 | MLX5_FLOW_LAYER_OUTER_L3 | \
135          MLX5_FLOW_LAYER_OUTER_L4)
136
137 /* Tunnel Masks. */
138 #define MLX5_FLOW_LAYER_TUNNEL \
139         (MLX5_FLOW_LAYER_VXLAN | MLX5_FLOW_LAYER_VXLAN_GPE | \
140          MLX5_FLOW_LAYER_GRE | MLX5_FLOW_LAYER_NVGRE | MLX5_FLOW_LAYER_MPLS | \
141          MLX5_FLOW_LAYER_IPIP | MLX5_FLOW_LAYER_IPV6_ENCAP | \
142          MLX5_FLOW_LAYER_GENEVE | MLX5_FLOW_LAYER_GTP)
143
144 /* Inner Masks. */
145 #define MLX5_FLOW_LAYER_INNER_L3 \
146         (MLX5_FLOW_LAYER_INNER_L3_IPV4 | MLX5_FLOW_LAYER_INNER_L3_IPV6)
147 #define MLX5_FLOW_LAYER_INNER_L4 \
148         (MLX5_FLOW_LAYER_INNER_L4_UDP | MLX5_FLOW_LAYER_INNER_L4_TCP)
149 #define MLX5_FLOW_LAYER_INNER \
150         (MLX5_FLOW_LAYER_INNER_L2 | MLX5_FLOW_LAYER_INNER_L3 | \
151          MLX5_FLOW_LAYER_INNER_L4)
152
153 /* Layer Masks. */
154 #define MLX5_FLOW_LAYER_L2 \
155         (MLX5_FLOW_LAYER_OUTER_L2 | MLX5_FLOW_LAYER_INNER_L2)
156 #define MLX5_FLOW_LAYER_L3_IPV4 \
157         (MLX5_FLOW_LAYER_OUTER_L3_IPV4 | MLX5_FLOW_LAYER_INNER_L3_IPV4)
158 #define MLX5_FLOW_LAYER_L3_IPV6 \
159         (MLX5_FLOW_LAYER_OUTER_L3_IPV6 | MLX5_FLOW_LAYER_INNER_L3_IPV6)
160 #define MLX5_FLOW_LAYER_L3 \
161         (MLX5_FLOW_LAYER_L3_IPV4 | MLX5_FLOW_LAYER_L3_IPV6)
162 #define MLX5_FLOW_LAYER_L4 \
163         (MLX5_FLOW_LAYER_OUTER_L4 | MLX5_FLOW_LAYER_INNER_L4)
164
165 /* Actions */
166 #define MLX5_FLOW_ACTION_DROP (1u << 0)
167 #define MLX5_FLOW_ACTION_QUEUE (1u << 1)
168 #define MLX5_FLOW_ACTION_RSS (1u << 2)
169 #define MLX5_FLOW_ACTION_FLAG (1u << 3)
170 #define MLX5_FLOW_ACTION_MARK (1u << 4)
171 #define MLX5_FLOW_ACTION_COUNT (1u << 5)
172 #define MLX5_FLOW_ACTION_PORT_ID (1u << 6)
173 #define MLX5_FLOW_ACTION_OF_POP_VLAN (1u << 7)
174 #define MLX5_FLOW_ACTION_OF_PUSH_VLAN (1u << 8)
175 #define MLX5_FLOW_ACTION_OF_SET_VLAN_VID (1u << 9)
176 #define MLX5_FLOW_ACTION_OF_SET_VLAN_PCP (1u << 10)
177 #define MLX5_FLOW_ACTION_SET_IPV4_SRC (1u << 11)
178 #define MLX5_FLOW_ACTION_SET_IPV4_DST (1u << 12)
179 #define MLX5_FLOW_ACTION_SET_IPV6_SRC (1u << 13)
180 #define MLX5_FLOW_ACTION_SET_IPV6_DST (1u << 14)
181 #define MLX5_FLOW_ACTION_SET_TP_SRC (1u << 15)
182 #define MLX5_FLOW_ACTION_SET_TP_DST (1u << 16)
183 #define MLX5_FLOW_ACTION_JUMP (1u << 17)
184 #define MLX5_FLOW_ACTION_SET_TTL (1u << 18)
185 #define MLX5_FLOW_ACTION_DEC_TTL (1u << 19)
186 #define MLX5_FLOW_ACTION_SET_MAC_SRC (1u << 20)
187 #define MLX5_FLOW_ACTION_SET_MAC_DST (1u << 21)
188 #define MLX5_FLOW_ACTION_VXLAN_ENCAP (1u << 22)
189 #define MLX5_FLOW_ACTION_VXLAN_DECAP (1u << 23)
190 #define MLX5_FLOW_ACTION_NVGRE_ENCAP (1u << 24)
191 #define MLX5_FLOW_ACTION_NVGRE_DECAP (1u << 25)
192 #define MLX5_FLOW_ACTION_RAW_ENCAP (1u << 26)
193 #define MLX5_FLOW_ACTION_RAW_DECAP (1u << 27)
194 #define MLX5_FLOW_ACTION_INC_TCP_SEQ (1u << 28)
195 #define MLX5_FLOW_ACTION_DEC_TCP_SEQ (1u << 29)
196 #define MLX5_FLOW_ACTION_INC_TCP_ACK (1u << 30)
197 #define MLX5_FLOW_ACTION_DEC_TCP_ACK (1u << 31)
198 #define MLX5_FLOW_ACTION_SET_TAG (1ull << 32)
199 #define MLX5_FLOW_ACTION_MARK_EXT (1ull << 33)
200 #define MLX5_FLOW_ACTION_SET_META (1ull << 34)
201 #define MLX5_FLOW_ACTION_METER (1ull << 35)
202 #define MLX5_FLOW_ACTION_SET_IPV4_DSCP (1ull << 36)
203 #define MLX5_FLOW_ACTION_SET_IPV6_DSCP (1ull << 37)
204
205 #define MLX5_FLOW_FATE_ACTIONS \
206         (MLX5_FLOW_ACTION_DROP | MLX5_FLOW_ACTION_QUEUE | \
207          MLX5_FLOW_ACTION_RSS | MLX5_FLOW_ACTION_JUMP)
208
209 #define MLX5_FLOW_FATE_ESWITCH_ACTIONS \
210         (MLX5_FLOW_ACTION_DROP | MLX5_FLOW_ACTION_PORT_ID | \
211          MLX5_FLOW_ACTION_JUMP)
212
213 #define MLX5_FLOW_ENCAP_ACTIONS (MLX5_FLOW_ACTION_VXLAN_ENCAP | \
214                                  MLX5_FLOW_ACTION_NVGRE_ENCAP | \
215                                  MLX5_FLOW_ACTION_RAW_ENCAP | \
216                                  MLX5_FLOW_ACTION_OF_PUSH_VLAN)
217
218 #define MLX5_FLOW_DECAP_ACTIONS (MLX5_FLOW_ACTION_VXLAN_DECAP | \
219                                  MLX5_FLOW_ACTION_NVGRE_DECAP | \
220                                  MLX5_FLOW_ACTION_RAW_DECAP | \
221                                  MLX5_FLOW_ACTION_OF_POP_VLAN)
222
223 #define MLX5_FLOW_MODIFY_HDR_ACTIONS (MLX5_FLOW_ACTION_SET_IPV4_SRC | \
224                                       MLX5_FLOW_ACTION_SET_IPV4_DST | \
225                                       MLX5_FLOW_ACTION_SET_IPV6_SRC | \
226                                       MLX5_FLOW_ACTION_SET_IPV6_DST | \
227                                       MLX5_FLOW_ACTION_SET_TP_SRC | \
228                                       MLX5_FLOW_ACTION_SET_TP_DST | \
229                                       MLX5_FLOW_ACTION_SET_TTL | \
230                                       MLX5_FLOW_ACTION_DEC_TTL | \
231                                       MLX5_FLOW_ACTION_SET_MAC_SRC | \
232                                       MLX5_FLOW_ACTION_SET_MAC_DST | \
233                                       MLX5_FLOW_ACTION_INC_TCP_SEQ | \
234                                       MLX5_FLOW_ACTION_DEC_TCP_SEQ | \
235                                       MLX5_FLOW_ACTION_INC_TCP_ACK | \
236                                       MLX5_FLOW_ACTION_DEC_TCP_ACK | \
237                                       MLX5_FLOW_ACTION_OF_SET_VLAN_VID | \
238                                       MLX5_FLOW_ACTION_SET_TAG | \
239                                       MLX5_FLOW_ACTION_MARK_EXT | \
240                                       MLX5_FLOW_ACTION_SET_META | \
241                                       MLX5_FLOW_ACTION_SET_IPV4_DSCP | \
242                                       MLX5_FLOW_ACTION_SET_IPV6_DSCP)
243
244 #define MLX5_FLOW_VLAN_ACTIONS (MLX5_FLOW_ACTION_OF_POP_VLAN | \
245                                 MLX5_FLOW_ACTION_OF_PUSH_VLAN)
246 #ifndef IPPROTO_MPLS
247 #define IPPROTO_MPLS 137
248 #endif
249
250 /* UDP port number for MPLS */
251 #define MLX5_UDP_PORT_MPLS 6635
252
253 /* UDP port numbers for VxLAN. */
254 #define MLX5_UDP_PORT_VXLAN 4789
255 #define MLX5_UDP_PORT_VXLAN_GPE 4790
256
257 /* UDP port numbers for GENEVE. */
258 #define MLX5_UDP_PORT_GENEVE 6081
259
260 /* Priority reserved for default flows. */
261 #define MLX5_FLOW_PRIO_RSVD ((uint32_t)-1)
262
263 /*
264  * Number of sub priorities.
265  * For each kind of pattern matching i.e. L2, L3, L4 to have a correct
266  * matching on the NIC (firmware dependent) L4 most have the higher priority
267  * followed by L3 and ending with L2.
268  */
269 #define MLX5_PRIORITY_MAP_L2 2
270 #define MLX5_PRIORITY_MAP_L3 1
271 #define MLX5_PRIORITY_MAP_L4 0
272 #define MLX5_PRIORITY_MAP_MAX 3
273
274 /* Valid layer type for IPV4 RSS. */
275 #define MLX5_IPV4_LAYER_TYPES \
276         (ETH_RSS_IPV4 | ETH_RSS_FRAG_IPV4 | \
277          ETH_RSS_NONFRAG_IPV4_TCP | ETH_RSS_NONFRAG_IPV4_UDP | \
278          ETH_RSS_NONFRAG_IPV4_OTHER)
279
280 /* IBV hash source bits  for IPV4. */
281 #define MLX5_IPV4_IBV_RX_HASH (IBV_RX_HASH_SRC_IPV4 | IBV_RX_HASH_DST_IPV4)
282
283 /* Valid layer type for IPV6 RSS. */
284 #define MLX5_IPV6_LAYER_TYPES \
285         (ETH_RSS_IPV6 | ETH_RSS_FRAG_IPV6 | ETH_RSS_NONFRAG_IPV6_TCP | \
286          ETH_RSS_NONFRAG_IPV6_UDP | ETH_RSS_IPV6_EX  | ETH_RSS_IPV6_TCP_EX | \
287          ETH_RSS_IPV6_UDP_EX | ETH_RSS_NONFRAG_IPV6_OTHER)
288
289 /* IBV hash source bits  for IPV6. */
290 #define MLX5_IPV6_IBV_RX_HASH (IBV_RX_HASH_SRC_IPV6 | IBV_RX_HASH_DST_IPV6)
291
292 /* IBV hash bits for L3 SRC. */
293 #define MLX5_L3_SRC_IBV_RX_HASH (IBV_RX_HASH_SRC_IPV4 | IBV_RX_HASH_SRC_IPV6)
294
295 /* IBV hash bits for L3 DST. */
296 #define MLX5_L3_DST_IBV_RX_HASH (IBV_RX_HASH_DST_IPV4 | IBV_RX_HASH_DST_IPV6)
297
298 /* IBV hash bits for TCP. */
299 #define MLX5_TCP_IBV_RX_HASH (IBV_RX_HASH_SRC_PORT_TCP | \
300                               IBV_RX_HASH_DST_PORT_TCP)
301
302 /* IBV hash bits for UDP. */
303 #define MLX5_UDP_IBV_RX_HASH (IBV_RX_HASH_SRC_PORT_UDP | \
304                               IBV_RX_HASH_DST_PORT_UDP)
305
306 /* IBV hash bits for L4 SRC. */
307 #define MLX5_L4_SRC_IBV_RX_HASH (IBV_RX_HASH_SRC_PORT_TCP | \
308                                  IBV_RX_HASH_SRC_PORT_UDP)
309
310 /* IBV hash bits for L4 DST. */
311 #define MLX5_L4_DST_IBV_RX_HASH (IBV_RX_HASH_DST_PORT_TCP | \
312                                  IBV_RX_HASH_DST_PORT_UDP)
313
314 /* Geneve header first 16Bit */
315 #define MLX5_GENEVE_VER_MASK 0x3
316 #define MLX5_GENEVE_VER_SHIFT 14
317 #define MLX5_GENEVE_VER_VAL(a) \
318                 (((a) >> (MLX5_GENEVE_VER_SHIFT)) & (MLX5_GENEVE_VER_MASK))
319 #define MLX5_GENEVE_OPTLEN_MASK 0x3F
320 #define MLX5_GENEVE_OPTLEN_SHIFT 7
321 #define MLX5_GENEVE_OPTLEN_VAL(a) \
322             (((a) >> (MLX5_GENEVE_OPTLEN_SHIFT)) & (MLX5_GENEVE_OPTLEN_MASK))
323 #define MLX5_GENEVE_OAMF_MASK 0x1
324 #define MLX5_GENEVE_OAMF_SHIFT 7
325 #define MLX5_GENEVE_OAMF_VAL(a) \
326                 (((a) >> (MLX5_GENEVE_OAMF_SHIFT)) & (MLX5_GENEVE_OAMF_MASK))
327 #define MLX5_GENEVE_CRITO_MASK 0x1
328 #define MLX5_GENEVE_CRITO_SHIFT 6
329 #define MLX5_GENEVE_CRITO_VAL(a) \
330                 (((a) >> (MLX5_GENEVE_CRITO_SHIFT)) & (MLX5_GENEVE_CRITO_MASK))
331 #define MLX5_GENEVE_RSVD_MASK 0x3F
332 #define MLX5_GENEVE_RSVD_VAL(a) ((a) & (MLX5_GENEVE_RSVD_MASK))
333 /*
334  * The length of the Geneve options fields, expressed in four byte multiples,
335  * not including the eight byte fixed tunnel.
336  */
337 #define MLX5_GENEVE_OPT_LEN_0 14
338 #define MLX5_GENEVE_OPT_LEN_1 63
339
340 enum mlx5_flow_drv_type {
341         MLX5_FLOW_TYPE_MIN,
342         MLX5_FLOW_TYPE_DV,
343         MLX5_FLOW_TYPE_VERBS,
344         MLX5_FLOW_TYPE_MAX,
345 };
346
347 /* Matcher PRM representation */
348 struct mlx5_flow_dv_match_params {
349         size_t size;
350         /**< Size of match value. Do NOT split size and key! */
351         uint32_t buf[MLX5_ST_SZ_DW(fte_match_param)];
352         /**< Matcher value. This value is used as the mask or as a key. */
353 };
354
355 /* Matcher structure. */
356 struct mlx5_flow_dv_matcher {
357         LIST_ENTRY(mlx5_flow_dv_matcher) next;
358         /**< Pointer to the next element. */
359         struct mlx5_flow_tbl_resource *tbl;
360         /**< Pointer to the table(group) the matcher associated with. */
361         rte_atomic32_t refcnt; /**< Reference counter. */
362         void *matcher_object; /**< Pointer to DV matcher */
363         uint16_t crc; /**< CRC of key. */
364         uint16_t priority; /**< Priority of matcher. */
365         struct mlx5_flow_dv_match_params mask; /**< Matcher mask. */
366 };
367
368 #define MLX5_ENCAP_MAX_LEN 132
369
370 /* Encap/decap resource structure. */
371 struct mlx5_flow_dv_encap_decap_resource {
372         LIST_ENTRY(mlx5_flow_dv_encap_decap_resource) next;
373         /* Pointer to next element. */
374         rte_atomic32_t refcnt; /**< Reference counter. */
375         void *verbs_action;
376         /**< Verbs encap/decap action object. */
377         uint8_t buf[MLX5_ENCAP_MAX_LEN];
378         size_t size;
379         uint8_t reformat_type;
380         uint8_t ft_type;
381         uint64_t flags; /**< Flags for RDMA API. */
382 };
383
384 /* Tag resource structure. */
385 struct mlx5_flow_dv_tag_resource {
386         struct mlx5_hlist_entry entry;
387         /**< hash list entry for tag resource, tag value as the key. */
388         void *action;
389         /**< Verbs tag action object. */
390         rte_atomic32_t refcnt; /**< Reference counter. */
391 };
392
393 /*
394  * Number of modification commands.
395  * If extensive metadata registers are supported, the maximal actions amount is
396  * 16 and 8 otherwise on root table. The validation could also be done in the
397  * lower driver layer.
398  * On non-root table, there is no limitation, but 32 is enough right now.
399  */
400 #define MLX5_MAX_MODIFY_NUM                     32
401 #define MLX5_ROOT_TBL_MODIFY_NUM                16
402 #define MLX5_ROOT_TBL_MODIFY_NUM_NO_MREG        8
403
404 /* Modify resource structure */
405 struct mlx5_flow_dv_modify_hdr_resource {
406         LIST_ENTRY(mlx5_flow_dv_modify_hdr_resource) next;
407         /* Pointer to next element. */
408         rte_atomic32_t refcnt; /**< Reference counter. */
409         struct ibv_flow_action *verbs_action;
410         /**< Verbs modify header action object. */
411         uint8_t ft_type; /**< Flow table type, Rx or Tx. */
412         uint32_t actions_num; /**< Number of modification actions. */
413         uint64_t flags; /**< Flags for RDMA API. */
414         struct mlx5_modification_cmd actions[];
415         /**< Modification actions. */
416 };
417
418 /* Jump action resource structure. */
419 struct mlx5_flow_dv_jump_tbl_resource {
420         rte_atomic32_t refcnt; /**< Reference counter. */
421         uint8_t ft_type; /**< Flow table type, Rx or Tx. */
422         void *action; /**< Pointer to the rdma core action. */
423 };
424
425 /* Port ID resource structure. */
426 struct mlx5_flow_dv_port_id_action_resource {
427         LIST_ENTRY(mlx5_flow_dv_port_id_action_resource) next;
428         /* Pointer to next element. */
429         rte_atomic32_t refcnt; /**< Reference counter. */
430         void *action;
431         /**< Verbs tag action object. */
432         uint32_t port_id; /**< Port ID value. */
433 };
434
435 /* Push VLAN action resource structure */
436 struct mlx5_flow_dv_push_vlan_action_resource {
437         LIST_ENTRY(mlx5_flow_dv_push_vlan_action_resource) next;
438         /* Pointer to next element. */
439         rte_atomic32_t refcnt; /**< Reference counter. */
440         void *action; /**< Direct verbs action object. */
441         uint8_t ft_type; /**< Flow table type, Rx, Tx or FDB. */
442         rte_be32_t vlan_tag; /**< VLAN tag value. */
443 };
444
445 /* Metadata register copy table entry. */
446 struct mlx5_flow_mreg_copy_resource {
447         /*
448          * Hash list entry for copy table.
449          *  - Key is 32/64-bit MARK action ID.
450          *  - MUST be the first entry.
451          */
452         struct mlx5_hlist_entry hlist_ent;
453         LIST_ENTRY(mlx5_flow_mreg_copy_resource) next;
454         /* List entry for device flows. */
455         uint32_t refcnt; /* Reference counter. */
456         uint32_t appcnt; /* Apply/Remove counter. */
457         struct rte_flow *flow; /* Built flow for copy. */
458 };
459
460 /* Table data structure of the hash organization. */
461 struct mlx5_flow_tbl_data_entry {
462         struct mlx5_hlist_entry entry;
463         /**< hash list entry, 64-bits key inside. */
464         struct mlx5_flow_tbl_resource tbl;
465         /**< flow table resource. */
466         LIST_HEAD(matchers, mlx5_flow_dv_matcher) matchers;
467         /**< matchers' header associated with the flow table. */
468         struct mlx5_flow_dv_jump_tbl_resource jump;
469         /**< jump resource, at most one for each table created. */
470 };
471
472 /*
473  * Max number of actions per DV flow.
474  * See CREATE_FLOW_MAX_FLOW_ACTIONS_SUPPORTED
475  * In rdma-core file providers/mlx5/verbs.c
476  */
477 #define MLX5_DV_MAX_NUMBER_OF_ACTIONS 8
478
479 /* DV flows structure. */
480 struct mlx5_flow_dv {
481         struct mlx5_hrxq *hrxq; /**< Hash Rx queues. */
482         /* Flow DV api: */
483         struct mlx5_flow_dv_matcher *matcher; /**< Cache to matcher. */
484         struct mlx5_flow_dv_match_params value;
485         /**< Holds the value that the packet is compared to. */
486         struct mlx5_flow_dv_encap_decap_resource *encap_decap;
487         /**< Pointer to encap/decap resource in cache. */
488         struct mlx5_flow_dv_modify_hdr_resource *modify_hdr;
489         /**< Pointer to modify header resource in cache. */
490         struct ibv_flow *flow; /**< Installed flow. */
491         struct mlx5_flow_dv_jump_tbl_resource *jump;
492         /**< Pointer to the jump action resource. */
493         struct mlx5_flow_dv_port_id_action_resource *port_id_action;
494         /**< Pointer to port ID action resource. */
495         struct mlx5_vf_vlan vf_vlan;
496         /**< Structure for VF VLAN workaround. */
497         struct mlx5_flow_dv_push_vlan_action_resource *push_vlan_res;
498         /**< Pointer to push VLAN action resource in cache. */
499         struct mlx5_flow_dv_tag_resource *tag_resource;
500         /**< pointer to the tag action. */
501 #ifdef HAVE_IBV_FLOW_DV_SUPPORT
502         void *actions[MLX5_DV_MAX_NUMBER_OF_ACTIONS];
503         /**< Action list. */
504 #endif
505         int actions_n; /**< number of actions. */
506 };
507
508 /* Verbs specification header. */
509 struct ibv_spec_header {
510         enum ibv_flow_spec_type type;
511         uint16_t size;
512 };
513
514 /** Handles information leading to a drop fate. */
515 struct mlx5_flow_verbs {
516         LIST_ENTRY(mlx5_flow_verbs) next;
517         unsigned int size; /**< Size of the attribute. */
518         struct {
519                 struct ibv_flow_attr *attr;
520                 /**< Pointer to the Specification buffer. */
521                 uint8_t *specs; /**< Pointer to the specifications. */
522         };
523         struct ibv_flow *flow; /**< Verbs flow pointer. */
524         struct mlx5_hrxq *hrxq; /**< Hash Rx queue object. */
525         struct mlx5_vf_vlan vf_vlan;
526         /**< Structure for VF VLAN workaround. */
527 };
528
529 struct mlx5_flow_rss {
530         uint32_t level;
531         uint32_t queue_num; /**< Number of entries in @p queue. */
532         uint64_t types; /**< Specific RSS hash types (see ETH_RSS_*). */
533         uint16_t (*queue)[]; /**< Destination queues to redirect traffic to. */
534         uint8_t key[MLX5_RSS_HASH_KEY_LEN]; /**< RSS hash key. */
535 };
536
537 /** Device flow structure. */
538 struct mlx5_flow {
539         LIST_ENTRY(mlx5_flow) next;
540         struct rte_flow *flow; /**< Pointer to the main flow. */
541         uint64_t layers;
542         /**< Bit-fields of present layers, see MLX5_FLOW_LAYER_*. */
543         uint64_t actions;
544         /**< Bit-fields of detected actions, see MLX5_FLOW_ACTION_*. */
545         uint64_t hash_fields; /**< Verbs hash Rx queue hash fields. */
546         uint8_t ingress; /**< 1 if the flow is ingress. */
547         uint32_t group; /**< The group index. */
548         uint8_t transfer; /**< 1 if the flow is E-Switch flow. */
549         union {
550 #ifdef HAVE_IBV_FLOW_DV_SUPPORT
551                 struct mlx5_flow_dv dv;
552 #endif
553                 struct mlx5_flow_verbs verbs;
554         };
555         union {
556                 uint32_t qrss_id; /**< Uniqie Q/RSS suffix subflow tag. */
557                 uint32_t mtr_flow_id; /**< Unique meter match flow id. */
558         };
559         bool external; /**< true if the flow is created external to PMD. */
560 };
561
562 /* Flow meter state. */
563 #define MLX5_FLOW_METER_DISABLE 0
564 #define MLX5_FLOW_METER_ENABLE 1
565
566 #define MLX5_MAN_WIDTH 8
567 /* Modify this value if enum rte_mtr_color changes. */
568 #define RTE_MTR_DROPPED RTE_COLORS
569
570 /* Meter policer statistics */
571 struct mlx5_flow_policer_stats {
572         struct mlx5_flow_counter *cnt[RTE_COLORS + 1];
573         /**< Color counter, extra for drop. */
574         uint64_t stats_mask;
575         /**< Statistics mask for the colors. */
576 };
577
578 /* Meter table structure. */
579 struct mlx5_meter_domain_info {
580         struct mlx5_flow_tbl_resource *tbl;
581         /**< Meter table. */
582         void *any_matcher;
583         /**< Meter color not match default criteria. */
584         void *color_matcher;
585         /**< Meter color match criteria. */
586         void *jump_actn;
587         /**< Meter match action. */
588         void *policer_rules[RTE_MTR_DROPPED + 1];
589         /**< Meter policer for the match. */
590 };
591
592 /* Meter table set for TX RX FDB. */
593 struct mlx5_meter_domains_infos {
594         uint32_t ref_cnt;
595         /**< Table user count. */
596         struct mlx5_meter_domain_info egress;
597         /**< TX meter table. */
598         struct mlx5_meter_domain_info ingress;
599         /**< RX meter table. */
600         struct mlx5_meter_domain_info transfer;
601         /**< FDB meter table. */
602         void *drop_actn;
603         /**< Drop action as not matched. */
604         void *count_actns[RTE_MTR_DROPPED + 1];
605         /**< Counters for match and unmatched statistics. */
606         uint32_t fmp[MLX5_ST_SZ_DW(flow_meter_parameters)];
607         /**< Flow meter parameter. */
608         size_t fmp_size;
609         /**< Flow meter parameter size. */
610         void *meter_action;
611         /**< Flow meter action. */
612 };
613
614 /* Meter parameter structure. */
615 struct mlx5_flow_meter {
616         TAILQ_ENTRY(mlx5_flow_meter) next;
617         /**< Pointer to the next flow meter structure. */
618         uint32_t meter_id;
619         /**< Meter id. */
620         struct rte_mtr_params params;
621         /**< Meter rule parameters. */
622         struct mlx5_flow_meter_profile *profile;
623         /**< Meter profile parameters. */
624         struct rte_flow_attr attr;
625         /**< Flow attributes. */
626         struct mlx5_meter_domains_infos *mfts;
627         /**< Flow table created for this meter. */
628         struct mlx5_flow_policer_stats policer_stats;
629         /**< Meter policer statistics. */
630         uint32_t ref_cnt;
631         /**< Use count. */
632         uint32_t active_state:1;
633         /**< Meter state. */
634         uint32_t shared:1;
635         /**< Meter shared or not. */
636 };
637
638 /* RFC2697 parameter structure. */
639 struct mlx5_flow_meter_srtcm_rfc2697_prm {
640         /* green_saturation_value = cbs_mantissa * 2^cbs_exponent */
641         uint32_t cbs_exponent:5;
642         uint32_t cbs_mantissa:8;
643         /* cir = 8G * cir_mantissa * 1/(2^cir_exponent) Bytes/Sec */
644         uint32_t cir_exponent:5;
645         uint32_t cir_mantissa:8;
646         /* yellow _saturation_value = ebs_mantissa * 2^ebs_exponent */
647         uint32_t ebs_exponent:5;
648         uint32_t ebs_mantissa:8;
649 };
650
651 /* Flow meter profile structure. */
652 struct mlx5_flow_meter_profile {
653         TAILQ_ENTRY(mlx5_flow_meter_profile) next;
654         /**< Pointer to the next flow meter structure. */
655         uint32_t meter_profile_id; /**< Profile id. */
656         struct rte_mtr_meter_profile profile; /**< Profile detail. */
657         union {
658                 struct mlx5_flow_meter_srtcm_rfc2697_prm srtcm_prm;
659                 /**< srtcm_rfc2697 struct. */
660         };
661         uint32_t ref_cnt; /**< Use count. */
662 };
663
664 /* Flow structure. */
665 struct rte_flow {
666         TAILQ_ENTRY(rte_flow) next; /**< Pointer to the next flow structure. */
667         enum mlx5_flow_drv_type drv_type; /**< Driver type. */
668         struct mlx5_flow_rss rss; /**< RSS context. */
669         struct mlx5_flow_counter *counter; /**< Holds flow counter. */
670         struct mlx5_flow_mreg_copy_resource *mreg_copy;
671         /**< pointer to metadata register copy table resource. */
672         struct mlx5_flow_meter *meter; /**< Holds flow meter. */
673         LIST_HEAD(dev_flows, mlx5_flow) dev_flows;
674         /**< Device flows that are part of the flow. */
675         struct mlx5_fdir *fdir; /**< Pointer to associated FDIR if any. */
676         uint32_t hairpin_flow_id; /**< The flow id used for hairpin. */
677         uint32_t copy_applied:1; /**< The MARK copy Flow os applied. */
678 };
679
680 typedef int (*mlx5_flow_validate_t)(struct rte_eth_dev *dev,
681                                     const struct rte_flow_attr *attr,
682                                     const struct rte_flow_item items[],
683                                     const struct rte_flow_action actions[],
684                                     bool external,
685                                     struct rte_flow_error *error);
686 typedef struct mlx5_flow *(*mlx5_flow_prepare_t)
687         (const struct rte_flow_attr *attr, const struct rte_flow_item items[],
688          const struct rte_flow_action actions[], struct rte_flow_error *error);
689 typedef int (*mlx5_flow_translate_t)(struct rte_eth_dev *dev,
690                                      struct mlx5_flow *dev_flow,
691                                      const struct rte_flow_attr *attr,
692                                      const struct rte_flow_item items[],
693                                      const struct rte_flow_action actions[],
694                                      struct rte_flow_error *error);
695 typedef int (*mlx5_flow_apply_t)(struct rte_eth_dev *dev, struct rte_flow *flow,
696                                  struct rte_flow_error *error);
697 typedef void (*mlx5_flow_remove_t)(struct rte_eth_dev *dev,
698                                    struct rte_flow *flow);
699 typedef void (*mlx5_flow_destroy_t)(struct rte_eth_dev *dev,
700                                     struct rte_flow *flow);
701 typedef int (*mlx5_flow_query_t)(struct rte_eth_dev *dev,
702                                  struct rte_flow *flow,
703                                  const struct rte_flow_action *actions,
704                                  void *data,
705                                  struct rte_flow_error *error);
706 typedef struct mlx5_meter_domains_infos *(*mlx5_flow_create_mtr_tbls_t)
707                                             (struct rte_eth_dev *dev,
708                                              const struct mlx5_flow_meter *fm);
709 typedef int (*mlx5_flow_destroy_mtr_tbls_t)(struct rte_eth_dev *dev,
710                                         struct mlx5_meter_domains_infos *tbls);
711 typedef int (*mlx5_flow_create_policer_rules_t)
712                                         (struct rte_eth_dev *dev,
713                                          struct mlx5_flow_meter *fm,
714                                          const struct rte_flow_attr *attr);
715 typedef int (*mlx5_flow_destroy_policer_rules_t)
716                                         (struct rte_eth_dev *dev,
717                                          const struct mlx5_flow_meter *fm,
718                                          const struct rte_flow_attr *attr);
719 typedef struct mlx5_flow_counter * (*mlx5_flow_counter_alloc_t)
720                                    (struct rte_eth_dev *dev);
721 typedef void (*mlx5_flow_counter_free_t)(struct rte_eth_dev *dev,
722                                          struct mlx5_flow_counter *cnt);
723 typedef int (*mlx5_flow_counter_query_t)(struct rte_eth_dev *dev,
724                                          struct mlx5_flow_counter *cnt,
725                                          bool clear, uint64_t *pkts,
726                                          uint64_t *bytes);
727 struct mlx5_flow_driver_ops {
728         mlx5_flow_validate_t validate;
729         mlx5_flow_prepare_t prepare;
730         mlx5_flow_translate_t translate;
731         mlx5_flow_apply_t apply;
732         mlx5_flow_remove_t remove;
733         mlx5_flow_destroy_t destroy;
734         mlx5_flow_query_t query;
735         mlx5_flow_create_mtr_tbls_t create_mtr_tbls;
736         mlx5_flow_destroy_mtr_tbls_t destroy_mtr_tbls;
737         mlx5_flow_create_policer_rules_t create_policer_rules;
738         mlx5_flow_destroy_policer_rules_t destroy_policer_rules;
739         mlx5_flow_counter_alloc_t counter_alloc;
740         mlx5_flow_counter_free_t counter_free;
741         mlx5_flow_counter_query_t counter_query;
742 };
743
744
745 #define MLX5_CNT_CONTAINER(sh, batch, thread) (&(sh)->cmng.ccont \
746         [(((sh)->cmng.mhi[batch] >> (thread)) & 0x1) * 2 + (batch)])
747 #define MLX5_CNT_CONTAINER_UNUSED(sh, batch, thread) (&(sh)->cmng.ccont \
748         [(~((sh)->cmng.mhi[batch] >> (thread)) & 0x1) * 2 + (batch)])
749
750 /* mlx5_flow.c */
751
752 struct mlx5_flow_id_pool *mlx5_flow_id_pool_alloc(void);
753 void mlx5_flow_id_pool_release(struct mlx5_flow_id_pool *pool);
754 uint32_t mlx5_flow_id_get(struct mlx5_flow_id_pool *pool, uint32_t *id);
755 uint32_t mlx5_flow_id_release(struct mlx5_flow_id_pool *pool,
756                               uint32_t id);
757 int mlx5_flow_group_to_table(const struct rte_flow_attr *attributes,
758                              bool external, uint32_t group, uint32_t *table,
759                              struct rte_flow_error *error);
760 uint64_t mlx5_flow_hashfields_adjust(struct mlx5_flow *dev_flow, int tunnel,
761                                      uint64_t layer_types,
762                                      uint64_t hash_fields);
763 uint32_t mlx5_flow_adjust_priority(struct rte_eth_dev *dev, int32_t priority,
764                                    uint32_t subpriority);
765 enum modify_reg mlx5_flow_get_reg_id(struct rte_eth_dev *dev,
766                                      enum mlx5_feature_name feature,
767                                      uint32_t id,
768                                      struct rte_flow_error *error);
769 const struct rte_flow_action *mlx5_flow_find_action
770                                         (const struct rte_flow_action *actions,
771                                          enum rte_flow_action_type action);
772 int mlx5_flow_validate_action_count(struct rte_eth_dev *dev,
773                                     const struct rte_flow_attr *attr,
774                                     struct rte_flow_error *error);
775 int mlx5_flow_validate_action_drop(uint64_t action_flags,
776                                    const struct rte_flow_attr *attr,
777                                    struct rte_flow_error *error);
778 int mlx5_flow_validate_action_flag(uint64_t action_flags,
779                                    const struct rte_flow_attr *attr,
780                                    struct rte_flow_error *error);
781 int mlx5_flow_validate_action_mark(const struct rte_flow_action *action,
782                                    uint64_t action_flags,
783                                    const struct rte_flow_attr *attr,
784                                    struct rte_flow_error *error);
785 int mlx5_flow_validate_action_queue(const struct rte_flow_action *action,
786                                     uint64_t action_flags,
787                                     struct rte_eth_dev *dev,
788                                     const struct rte_flow_attr *attr,
789                                     struct rte_flow_error *error);
790 int mlx5_flow_validate_action_rss(const struct rte_flow_action *action,
791                                   uint64_t action_flags,
792                                   struct rte_eth_dev *dev,
793                                   const struct rte_flow_attr *attr,
794                                   uint64_t item_flags,
795                                   struct rte_flow_error *error);
796 int mlx5_flow_validate_attributes(struct rte_eth_dev *dev,
797                                   const struct rte_flow_attr *attributes,
798                                   struct rte_flow_error *error);
799 int mlx5_flow_item_acceptable(const struct rte_flow_item *item,
800                               const uint8_t *mask,
801                               const uint8_t *nic_mask,
802                               unsigned int size,
803                               struct rte_flow_error *error);
804 int mlx5_flow_validate_item_eth(const struct rte_flow_item *item,
805                                 uint64_t item_flags,
806                                 struct rte_flow_error *error);
807 int mlx5_flow_validate_item_gre(const struct rte_flow_item *item,
808                                 uint64_t item_flags,
809                                 uint8_t target_protocol,
810                                 struct rte_flow_error *error);
811 int mlx5_flow_validate_item_gre_key(const struct rte_flow_item *item,
812                                     uint64_t item_flags,
813                                     const struct rte_flow_item *gre_item,
814                                     struct rte_flow_error *error);
815 int mlx5_flow_validate_item_ipv4(const struct rte_flow_item *item,
816                                  uint64_t item_flags,
817                                  uint64_t last_item,
818                                  uint16_t ether_type,
819                                  const struct rte_flow_item_ipv4 *acc_mask,
820                                  struct rte_flow_error *error);
821 int mlx5_flow_validate_item_ipv6(const struct rte_flow_item *item,
822                                  uint64_t item_flags,
823                                  uint64_t last_item,
824                                  uint16_t ether_type,
825                                  const struct rte_flow_item_ipv6 *acc_mask,
826                                  struct rte_flow_error *error);
827 int mlx5_flow_validate_item_mpls(struct rte_eth_dev *dev,
828                                  const struct rte_flow_item *item,
829                                  uint64_t item_flags,
830                                  uint64_t prev_layer,
831                                  struct rte_flow_error *error);
832 int mlx5_flow_validate_item_tcp(const struct rte_flow_item *item,
833                                 uint64_t item_flags,
834                                 uint8_t target_protocol,
835                                 const struct rte_flow_item_tcp *flow_mask,
836                                 struct rte_flow_error *error);
837 int mlx5_flow_validate_item_udp(const struct rte_flow_item *item,
838                                 uint64_t item_flags,
839                                 uint8_t target_protocol,
840                                 struct rte_flow_error *error);
841 int mlx5_flow_validate_item_vlan(const struct rte_flow_item *item,
842                                  uint64_t item_flags,
843                                  struct rte_eth_dev *dev,
844                                  struct rte_flow_error *error);
845 int mlx5_flow_validate_item_vxlan(const struct rte_flow_item *item,
846                                   uint64_t item_flags,
847                                   struct rte_flow_error *error);
848 int mlx5_flow_validate_item_vxlan_gpe(const struct rte_flow_item *item,
849                                       uint64_t item_flags,
850                                       struct rte_eth_dev *dev,
851                                       struct rte_flow_error *error);
852 int mlx5_flow_validate_item_icmp(const struct rte_flow_item *item,
853                                  uint64_t item_flags,
854                                  uint8_t target_protocol,
855                                  struct rte_flow_error *error);
856 int mlx5_flow_validate_item_icmp6(const struct rte_flow_item *item,
857                                    uint64_t item_flags,
858                                    uint8_t target_protocol,
859                                    struct rte_flow_error *error);
860 int mlx5_flow_validate_item_nvgre(const struct rte_flow_item *item,
861                                   uint64_t item_flags,
862                                   uint8_t target_protocol,
863                                   struct rte_flow_error *error);
864 int mlx5_flow_validate_item_geneve(const struct rte_flow_item *item,
865                                    uint64_t item_flags,
866                                    struct rte_eth_dev *dev,
867                                    struct rte_flow_error *error);
868 struct mlx5_meter_domains_infos *mlx5_flow_create_mtr_tbls
869                                         (struct rte_eth_dev *dev,
870                                          const struct mlx5_flow_meter *fm);
871 int mlx5_flow_destroy_mtr_tbls(struct rte_eth_dev *dev,
872                                struct mlx5_meter_domains_infos *tbl);
873 int mlx5_flow_create_policer_rules(struct rte_eth_dev *dev,
874                                    struct mlx5_flow_meter *fm,
875                                    const struct rte_flow_attr *attr);
876 int mlx5_flow_destroy_policer_rules(struct rte_eth_dev *dev,
877                                     struct mlx5_flow_meter *fm,
878                                     const struct rte_flow_attr *attr);
879 int mlx5_flow_meter_flush(struct rte_eth_dev *dev,
880                           struct rte_mtr_error *error);
881 #endif /* RTE_PMD_MLX5_FLOW_H_ */