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