net/mlx5: make flow tag list 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 /* Hash list callback context */
388 struct mlx5_flow_cb_ctx {
389         struct rte_eth_dev *dev;
390         struct rte_flow_error *error;
391         void *data;
392 };
393
394 /* Matcher PRM representation */
395 struct mlx5_flow_dv_match_params {
396         size_t size;
397         /**< Size of match value. Do NOT split size and key! */
398         uint32_t buf[MLX5_ST_SZ_DW(fte_match_param)];
399         /**< Matcher value. This value is used as the mask or as a key. */
400 };
401
402 /* Matcher structure. */
403 struct mlx5_flow_dv_matcher {
404         LIST_ENTRY(mlx5_flow_dv_matcher) next;
405         /**< Pointer to the next element. */
406         struct mlx5_flow_tbl_resource *tbl;
407         /**< Pointer to the table(group) the matcher associated with. */
408         uint32_t refcnt; /**< Reference counter. */
409         void *matcher_object; /**< Pointer to DV matcher */
410         uint16_t crc; /**< CRC of key. */
411         uint16_t priority; /**< Priority of matcher. */
412         struct mlx5_flow_dv_match_params mask; /**< Matcher mask. */
413 };
414
415 #define MLX5_ENCAP_MAX_LEN 132
416
417 /* Encap/decap resource key of the hash organization. */
418 union mlx5_flow_encap_decap_key {
419         struct {
420                 uint32_t ft_type:8;     /**< Flow table type, Rx or Tx. */
421                 uint32_t refmt_type:8;  /**< Header reformat type. */
422                 uint32_t buf_size:8;    /**< Encap buf size. */
423                 uint32_t table_level:8; /**< Root table or not. */
424                 uint32_t cksum;         /**< Encap buf check sum. */
425         };
426         uint64_t v64;                   /**< full 64bits value of key */
427 };
428
429 /* Encap/decap resource structure. */
430 struct mlx5_flow_dv_encap_decap_resource {
431         struct mlx5_hlist_entry entry;
432         /* Pointer to next element. */
433         uint32_t refcnt; /**< Reference counter. */
434         void *action;
435         /**< Encap/decap action object. */
436         uint8_t buf[MLX5_ENCAP_MAX_LEN];
437         size_t size;
438         uint8_t reformat_type;
439         uint8_t ft_type;
440         uint64_t flags; /**< Flags for RDMA API. */
441         uint32_t idx; /**< Index for the index memory pool. */
442 };
443
444 /* Tag resource structure. */
445 struct mlx5_flow_dv_tag_resource {
446         struct mlx5_hlist_entry entry;
447         /**< hash list entry for tag resource, tag value as the key. */
448         void *action;
449         /**< Tag action object. */
450         uint32_t refcnt; /**< Reference counter. */
451         uint32_t idx; /**< Index for the index memory pool. */
452 };
453
454 /*
455  * Number of modification commands.
456  * The maximal actions amount in FW is some constant, and it is 16 in the
457  * latest releases. In some old releases, it will be limited to 8.
458  * Since there is no interface to query the capacity, the maximal value should
459  * be used to allow PMD to create the flow. The validation will be done in the
460  * lower driver layer or FW. A failure will be returned if exceeds the maximal
461  * supported actions number on the root table.
462  * On non-root tables, there is no limitation, but 32 is enough right now.
463  */
464 #define MLX5_MAX_MODIFY_NUM                     32
465 #define MLX5_ROOT_TBL_MODIFY_NUM                16
466
467 /* Modify resource structure */
468 struct mlx5_flow_dv_modify_hdr_resource {
469         struct mlx5_hlist_entry entry;
470         /* Pointer to next element. */
471         uint32_t refcnt; /**< Reference counter. */
472         void *action;
473         /**< Modify header action object. */
474         uint8_t ft_type; /**< Flow table type, Rx or Tx. */
475         uint32_t actions_num; /**< Number of modification actions. */
476         uint64_t flags; /**< Flags for RDMA API. */
477         struct mlx5_modification_cmd actions[];
478         /**< Modification actions. */
479 };
480
481 /* Modify resource key of the hash organization. */
482 union mlx5_flow_modify_hdr_key {
483         struct {
484                 uint32_t ft_type:8;     /**< Flow table type, Rx or Tx. */
485                 uint32_t actions_num:5; /**< Number of modification actions. */
486                 uint32_t group:19;      /**< Flow group id. */
487                 uint32_t cksum;         /**< Actions check sum. */
488         };
489         uint64_t v64;                   /**< full 64bits value of key */
490 };
491
492 /* Jump action resource structure. */
493 struct mlx5_flow_dv_jump_tbl_resource {
494         void *action; /**< Pointer to the rdma core action. */
495 };
496
497 /* Port ID resource structure. */
498 struct mlx5_flow_dv_port_id_action_resource {
499         ILIST_ENTRY(uint32_t)next;
500         /* Pointer to next element. */
501         uint32_t refcnt; /**< Reference counter. */
502         void *action;
503         /**< Action object. */
504         uint32_t port_id; /**< Port ID value. */
505 };
506
507 /* Push VLAN action resource structure */
508 struct mlx5_flow_dv_push_vlan_action_resource {
509         ILIST_ENTRY(uint32_t)next;
510         /* Pointer to next element. */
511         uint32_t refcnt; /**< Reference counter. */
512         void *action; /**< Action object. */
513         uint8_t ft_type; /**< Flow table type, Rx, Tx or FDB. */
514         rte_be32_t vlan_tag; /**< VLAN tag value. */
515 };
516
517 /* Metadata register copy table entry. */
518 struct mlx5_flow_mreg_copy_resource {
519         /*
520          * Hash list entry for copy table.
521          *  - Key is 32/64-bit MARK action ID.
522          *  - MUST be the first entry.
523          */
524         struct mlx5_hlist_entry hlist_ent;
525         LIST_ENTRY(mlx5_flow_mreg_copy_resource) next;
526         /* List entry for device flows. */
527         uint32_t refcnt; /* Reference counter. */
528         uint32_t appcnt; /* Apply/Remove counter. */
529         uint32_t idx;
530         uint32_t rix_flow; /* Built flow for copy. */
531 };
532
533 /* Table tunnel parameter. */
534 struct mlx5_flow_tbl_tunnel_prm {
535         const struct mlx5_flow_tunnel *tunnel;
536         uint32_t group_id;
537         bool external;
538 };
539
540 /* Table data structure of the hash organization. */
541 struct mlx5_flow_tbl_data_entry {
542         struct mlx5_hlist_entry entry;
543         /**< hash list entry, 64-bits key inside. */
544         struct mlx5_flow_tbl_resource tbl;
545         /**< flow table resource. */
546         LIST_HEAD(matchers, mlx5_flow_dv_matcher) matchers;
547         /**< matchers' header associated with the flow table. */
548         struct mlx5_flow_dv_jump_tbl_resource jump;
549         /**< jump resource, at most one for each table created. */
550         uint32_t idx; /**< index for the indexed mempool. */
551         /**< tunnel offload */
552         const struct mlx5_flow_tunnel *tunnel;
553         uint32_t group_id;
554         bool external;
555         bool tunnel_offload; /* Tunnel offlod table or not. */
556 };
557
558 /* Sub rdma-core actions list. */
559 struct mlx5_flow_sub_actions_list {
560         uint32_t actions_num; /**< Number of sample actions. */
561         uint64_t action_flags;
562         void *dr_queue_action;
563         void *dr_tag_action;
564         void *dr_cnt_action;
565         void *dr_port_id_action;
566         void *dr_encap_action;
567 };
568
569 /* Sample sub-actions resource list. */
570 struct mlx5_flow_sub_actions_idx {
571         uint32_t rix_hrxq; /**< Hash Rx queue object index. */
572         uint32_t rix_tag; /**< Index to the tag action. */
573         uint32_t cnt;
574         uint32_t rix_port_id_action; /**< Index to port ID action resource. */
575         uint32_t rix_encap_decap; /**< Index to encap/decap resource. */
576 };
577
578 /* Sample action resource structure. */
579 struct mlx5_flow_dv_sample_resource {
580         ILIST_ENTRY(uint32_t)next; /**< Pointer to next element. */
581         uint32_t refcnt; /**< Reference counter. */
582         void *verbs_action; /**< Verbs sample action object. */
583         uint8_t ft_type; /** Flow Table Type */
584         uint32_t ft_id; /** Flow Table Level */
585         uint32_t ratio;   /** Sample Ratio */
586         uint64_t set_action; /** Restore reg_c0 value */
587         void *normal_path_tbl; /** Flow Table pointer */
588         void *default_miss; /** default_miss dr_action. */
589         struct mlx5_flow_sub_actions_idx sample_idx;
590         /**< Action index resources. */
591         struct mlx5_flow_sub_actions_list sample_act;
592         /**< Action resources. */
593 };
594
595 #define MLX5_MAX_DEST_NUM       2
596
597 /* Destination array action resource structure. */
598 struct mlx5_flow_dv_dest_array_resource {
599         ILIST_ENTRY(uint32_t)next; /**< Pointer to next element. */
600         uint32_t refcnt; /**< Reference counter. */
601         uint8_t ft_type; /** Flow Table Type */
602         uint8_t num_of_dest; /**< Number of destination actions. */
603         void *action; /**< Pointer to the rdma core action. */
604         struct mlx5_flow_sub_actions_idx sample_idx[MLX5_MAX_DEST_NUM];
605         /**< Action index resources. */
606         struct mlx5_flow_sub_actions_list sample_act[MLX5_MAX_DEST_NUM];
607         /**< Action resources. */
608 };
609
610 /* Verbs specification header. */
611 struct ibv_spec_header {
612         enum ibv_flow_spec_type type;
613         uint16_t size;
614 };
615
616 /* RSS description. */
617 struct mlx5_flow_rss_desc {
618         uint32_t level;
619         uint32_t queue_num; /**< Number of entries in @p queue. */
620         uint64_t types; /**< Specific RSS hash types (see ETH_RSS_*). */
621         uint8_t key[MLX5_RSS_HASH_KEY_LEN]; /**< RSS hash key. */
622         uint16_t *queue; /**< Destination queues. */
623 };
624
625 /* PMD flow priority for tunnel */
626 #define MLX5_TUNNEL_PRIO_GET(rss_desc) \
627         ((rss_desc)->level >= 2 ? MLX5_PRIORITY_MAP_L2 : MLX5_PRIORITY_MAP_L4)
628
629
630 /** Device flow handle structure for DV mode only. */
631 struct mlx5_flow_handle_dv {
632         /* Flow DV api: */
633         struct mlx5_flow_dv_matcher *matcher; /**< Cache to matcher. */
634         struct mlx5_flow_dv_modify_hdr_resource *modify_hdr;
635         /**< Pointer to modify header resource in cache. */
636         uint32_t rix_encap_decap;
637         /**< Index to encap/decap resource in cache. */
638         uint32_t rix_push_vlan;
639         /**< Index to push VLAN action resource in cache. */
640         uint32_t rix_tag;
641         /**< Index to the tag action. */
642         uint32_t rix_sample;
643         /**< Index to sample action resource in cache. */
644         uint32_t rix_dest_array;
645         /**< Index to destination array resource in cache. */
646 } __rte_packed;
647
648 /** Device flow handle structure: used both for creating & destroying. */
649 struct mlx5_flow_handle {
650         SILIST_ENTRY(uint32_t)next;
651         struct mlx5_vf_vlan vf_vlan; /**< Structure for VF VLAN workaround. */
652         /**< Index to next device flow handle. */
653         uint64_t layers;
654         /**< Bit-fields of present layers, see MLX5_FLOW_LAYER_*. */
655         void *drv_flow; /**< pointer to driver flow object. */
656         uint32_t split_flow_id:28; /**< Sub flow unique match flow id. */
657         uint32_t mark:1; /**< Metadate rxq mark flag. */
658         uint32_t fate_action:3; /**< Fate action type. */
659         union {
660                 uint32_t rix_hrxq; /**< Hash Rx queue object index. */
661                 uint32_t rix_jump; /**< Index to the jump action resource. */
662                 uint32_t rix_port_id_action;
663                 /**< Index to port ID action resource. */
664                 uint32_t rix_fate;
665                 /**< Generic value indicates the fate action. */
666                 uint32_t rix_default_fate;
667                 /**< Indicates default miss fate action. */
668         };
669 #ifdef HAVE_IBV_FLOW_DV_SUPPORT
670         struct mlx5_flow_handle_dv dvh;
671 #endif
672 } __rte_packed;
673
674 /*
675  * Size for Verbs device flow handle structure only. Do not use the DV only
676  * structure in Verbs. No DV flows attributes will be accessed.
677  * Macro offsetof() could also be used here.
678  */
679 #ifdef HAVE_IBV_FLOW_DV_SUPPORT
680 #define MLX5_FLOW_HANDLE_VERBS_SIZE \
681         (sizeof(struct mlx5_flow_handle) - sizeof(struct mlx5_flow_handle_dv))
682 #else
683 #define MLX5_FLOW_HANDLE_VERBS_SIZE (sizeof(struct mlx5_flow_handle))
684 #endif
685
686 /*
687  * Max number of actions per DV flow.
688  * See CREATE_FLOW_MAX_FLOW_ACTIONS_SUPPORTED
689  * in rdma-core file providers/mlx5/verbs.c.
690  */
691 #define MLX5_DV_MAX_NUMBER_OF_ACTIONS 8
692
693 /** Device flow structure only for DV flow creation. */
694 struct mlx5_flow_dv_workspace {
695         uint32_t group; /**< The group index. */
696         uint8_t transfer; /**< 1 if the flow is E-Switch flow. */
697         int actions_n; /**< number of actions. */
698         void *actions[MLX5_DV_MAX_NUMBER_OF_ACTIONS]; /**< Action list. */
699         struct mlx5_flow_dv_encap_decap_resource *encap_decap;
700         /**< Pointer to encap/decap resource in cache. */
701         struct mlx5_flow_dv_push_vlan_action_resource *push_vlan_res;
702         /**< Pointer to push VLAN action resource in cache. */
703         struct mlx5_flow_dv_tag_resource *tag_resource;
704         /**< pointer to the tag action. */
705         struct mlx5_flow_dv_port_id_action_resource *port_id_action;
706         /**< Pointer to port ID action resource. */
707         struct mlx5_flow_dv_jump_tbl_resource *jump;
708         /**< Pointer to the jump action resource. */
709         struct mlx5_flow_dv_match_params value;
710         /**< Holds the value that the packet is compared to. */
711         struct mlx5_flow_dv_sample_resource *sample_res;
712         /**< Pointer to the sample action resource. */
713         struct mlx5_flow_dv_dest_array_resource *dest_array_res;
714         /**< Pointer to the destination array resource. */
715 };
716
717 /*
718  * Maximal Verbs flow specifications & actions size.
719  * Some elements are mutually exclusive, but enough space should be allocated.
720  * Tunnel cases: 1. Max 2 Ethernet + IP(v6 len > v4 len) + TCP/UDP headers.
721  *               2. One tunnel header (exception: GRE + MPLS),
722  *                  SPEC length: GRE == tunnel.
723  * Actions: 1. 1 Mark OR Flag.
724  *          2. 1 Drop (if any).
725  *          3. No limitation for counters, but it makes no sense to support too
726  *             many counters in a single device flow.
727  */
728 #ifdef HAVE_IBV_DEVICE_MPLS_SUPPORT
729 #define MLX5_VERBS_MAX_SPEC_SIZE \
730                 ( \
731                         (2 * (sizeof(struct ibv_flow_spec_eth) + \
732                               sizeof(struct ibv_flow_spec_ipv6) + \
733                               sizeof(struct ibv_flow_spec_tcp_udp)) + \
734                         sizeof(struct ibv_flow_spec_gre) + \
735                         sizeof(struct ibv_flow_spec_mpls)) \
736                 )
737 #else
738 #define MLX5_VERBS_MAX_SPEC_SIZE \
739                 ( \
740                         (2 * (sizeof(struct ibv_flow_spec_eth) + \
741                               sizeof(struct ibv_flow_spec_ipv6) + \
742                               sizeof(struct ibv_flow_spec_tcp_udp)) + \
743                         sizeof(struct ibv_flow_spec_tunnel)) \
744                 )
745 #endif
746
747 #if defined(HAVE_IBV_DEVICE_COUNTERS_SET_V42) || \
748         defined(HAVE_IBV_DEVICE_COUNTERS_SET_V45)
749 #define MLX5_VERBS_MAX_ACT_SIZE \
750                 ( \
751                         sizeof(struct ibv_flow_spec_action_tag) + \
752                         sizeof(struct ibv_flow_spec_action_drop) + \
753                         sizeof(struct ibv_flow_spec_counter_action) * 4 \
754                 )
755 #else
756 #define MLX5_VERBS_MAX_ACT_SIZE \
757                 ( \
758                         sizeof(struct ibv_flow_spec_action_tag) + \
759                         sizeof(struct ibv_flow_spec_action_drop) \
760                 )
761 #endif
762
763 #define MLX5_VERBS_MAX_SPEC_ACT_SIZE \
764                 (MLX5_VERBS_MAX_SPEC_SIZE + MLX5_VERBS_MAX_ACT_SIZE)
765
766 /** Device flow structure only for Verbs flow creation. */
767 struct mlx5_flow_verbs_workspace {
768         unsigned int size; /**< Size of the attribute. */
769         struct ibv_flow_attr attr; /**< Verbs flow attribute buffer. */
770         uint8_t specs[MLX5_VERBS_MAX_SPEC_ACT_SIZE];
771         /**< Specifications & actions buffer of verbs flow. */
772 };
773
774 /** Maximal number of device sub-flows supported. */
775 #define MLX5_NUM_MAX_DEV_FLOWS 32
776
777 /** Device flow structure. */
778 struct mlx5_flow {
779         struct rte_flow *flow; /**< Pointer to the main flow. */
780         uint32_t flow_idx; /**< The memory pool index to the main flow. */
781         uint64_t hash_fields; /**< Hash Rx queue hash fields. */
782         uint64_t act_flags;
783         /**< Bit-fields of detected actions, see MLX5_FLOW_ACTION_*. */
784         bool external; /**< true if the flow is created external to PMD. */
785         uint8_t ingress; /**< 1 if the flow is ingress. */
786         union {
787 #ifdef HAVE_IBV_FLOW_DV_SUPPORT
788                 struct mlx5_flow_dv_workspace dv;
789 #endif
790                 struct mlx5_flow_verbs_workspace verbs;
791         };
792         struct mlx5_flow_handle *handle;
793         uint32_t handle_idx; /* Index of the mlx5 flow handle memory. */
794         const struct mlx5_flow_tunnel *tunnel;
795 };
796
797 /* Flow meter state. */
798 #define MLX5_FLOW_METER_DISABLE 0
799 #define MLX5_FLOW_METER_ENABLE 1
800
801 #define MLX5_MAN_WIDTH 8
802 /* Modify this value if enum rte_mtr_color changes. */
803 #define RTE_MTR_DROPPED RTE_COLORS
804
805 /* Meter policer statistics */
806 struct mlx5_flow_policer_stats {
807         uint32_t cnt[RTE_COLORS + 1];
808         /**< Color counter, extra for drop. */
809         uint64_t stats_mask;
810         /**< Statistics mask for the colors. */
811 };
812
813 /* Meter table structure. */
814 struct mlx5_meter_domain_info {
815         struct mlx5_flow_tbl_resource *tbl;
816         /**< Meter table. */
817         struct mlx5_flow_tbl_resource *sfx_tbl;
818         /**< Meter suffix table. */
819         void *any_matcher;
820         /**< Meter color not match default criteria. */
821         void *color_matcher;
822         /**< Meter color match criteria. */
823         void *jump_actn;
824         /**< Meter match action. */
825         void *policer_rules[RTE_MTR_DROPPED + 1];
826         /**< Meter policer for the match. */
827 };
828
829 /* Meter table set for TX RX FDB. */
830 struct mlx5_meter_domains_infos {
831         uint32_t ref_cnt;
832         /**< Table user count. */
833         struct mlx5_meter_domain_info egress;
834         /**< TX meter table. */
835         struct mlx5_meter_domain_info ingress;
836         /**< RX meter table. */
837         struct mlx5_meter_domain_info transfer;
838         /**< FDB meter table. */
839         void *drop_actn;
840         /**< Drop action as not matched. */
841         void *count_actns[RTE_MTR_DROPPED + 1];
842         /**< Counters for match and unmatched statistics. */
843         uint32_t fmp[MLX5_ST_SZ_DW(flow_meter_parameters)];
844         /**< Flow meter parameter. */
845         size_t fmp_size;
846         /**< Flow meter parameter size. */
847         void *meter_action;
848         /**< Flow meter action. */
849 };
850
851 /* Meter parameter structure. */
852 struct mlx5_flow_meter {
853         TAILQ_ENTRY(mlx5_flow_meter) next;
854         /**< Pointer to the next flow meter structure. */
855         uint32_t idx; /* Index to meter object. */
856         uint32_t meter_id;
857         /**< Meter id. */
858         struct mlx5_flow_meter_profile *profile;
859         /**< Meter profile parameters. */
860
861         rte_spinlock_t sl; /**< Meter action spinlock. */
862
863         /** Policer actions (per meter output color). */
864         enum rte_mtr_policer_action action[RTE_COLORS];
865
866         /** Set of stats counters to be enabled.
867          * @see enum rte_mtr_stats_type
868          */
869         uint64_t stats_mask;
870
871         /**< Rule applies to ingress traffic. */
872         uint32_t ingress:1;
873
874         /**< Rule applies to egress traffic. */
875         uint32_t egress:1;
876         /**
877          * Instead of simply matching the properties of traffic as it would
878          * appear on a given DPDK port ID, enabling this attribute transfers
879          * a flow rule to the lowest possible level of any device endpoints
880          * found in the pattern.
881          *
882          * When supported, this effectively enables an application to
883          * re-route traffic not necessarily intended for it (e.g. coming
884          * from or addressed to different physical ports, VFs or
885          * applications) at the device level.
886          *
887          * It complements the behavior of some pattern items such as
888          * RTE_FLOW_ITEM_TYPE_PHY_PORT and is meaningless without them.
889          *
890          * When transferring flow rules, ingress and egress attributes keep
891          * their original meaning, as if processing traffic emitted or
892          * received by the application.
893          */
894         uint32_t transfer:1;
895         struct mlx5_meter_domains_infos *mfts;
896         /**< Flow table created for this meter. */
897         struct mlx5_flow_policer_stats policer_stats;
898         /**< Meter policer statistics. */
899         uint32_t ref_cnt;
900         /**< Use count. */
901         uint32_t active_state:1;
902         /**< Meter state. */
903         uint32_t shared:1;
904         /**< Meter shared or not. */
905 };
906
907 /* RFC2697 parameter structure. */
908 struct mlx5_flow_meter_srtcm_rfc2697_prm {
909         /* green_saturation_value = cbs_mantissa * 2^cbs_exponent */
910         uint32_t cbs_exponent:5;
911         uint32_t cbs_mantissa:8;
912         /* cir = 8G * cir_mantissa * 1/(2^cir_exponent) Bytes/Sec */
913         uint32_t cir_exponent:5;
914         uint32_t cir_mantissa:8;
915         /* yellow _saturation_value = ebs_mantissa * 2^ebs_exponent */
916         uint32_t ebs_exponent:5;
917         uint32_t ebs_mantissa:8;
918 };
919
920 /* Flow meter profile structure. */
921 struct mlx5_flow_meter_profile {
922         TAILQ_ENTRY(mlx5_flow_meter_profile) next;
923         /**< Pointer to the next flow meter structure. */
924         uint32_t meter_profile_id; /**< Profile id. */
925         struct rte_mtr_meter_profile profile; /**< Profile detail. */
926         union {
927                 struct mlx5_flow_meter_srtcm_rfc2697_prm srtcm_prm;
928                 /**< srtcm_rfc2697 struct. */
929         };
930         uint32_t ref_cnt; /**< Use count. */
931 };
932
933 /* Fdir flow structure */
934 struct mlx5_fdir_flow {
935         LIST_ENTRY(mlx5_fdir_flow) next; /* Pointer to the next element. */
936         struct mlx5_fdir *fdir; /* Pointer to fdir. */
937         uint32_t rix_flow; /* Index to flow. */
938 };
939
940 #define MLX5_MAX_TUNNELS 256
941 #define MLX5_TNL_MISS_RULE_PRIORITY 3
942 #define MLX5_TNL_MISS_FDB_JUMP_GRP  0x1234faac
943
944 /*
945  * When tunnel offload is active, all JUMP group ids are converted
946  * using the same method. That conversion is applied both to tunnel and
947  * regular rule types.
948  * Group ids used in tunnel rules are relative to it's tunnel (!).
949  * Application can create number of steer rules, using the same
950  * tunnel, with different group id in each rule.
951  * Each tunnel stores its groups internally in PMD tunnel object.
952  * Groups used in regular rules do not belong to any tunnel and are stored
953  * in tunnel hub.
954  */
955
956 struct mlx5_flow_tunnel {
957         LIST_ENTRY(mlx5_flow_tunnel) chain;
958         struct rte_flow_tunnel app_tunnel;      /** app tunnel copy */
959         uint32_t tunnel_id;                     /** unique tunnel ID */
960         uint32_t refctn;
961         struct rte_flow_action action;
962         struct rte_flow_item item;
963         struct mlx5_hlist *groups;              /** tunnel groups */
964 };
965
966 /** PMD tunnel related context */
967 struct mlx5_flow_tunnel_hub {
968         LIST_HEAD(, mlx5_flow_tunnel) tunnels;
969         struct mlx5_hlist *groups;              /** non tunnel groups */
970 };
971
972 /* convert jump group to flow table ID in tunnel rules */
973 struct tunnel_tbl_entry {
974         struct mlx5_hlist_entry hash;
975         uint32_t flow_table;
976 };
977
978 static inline uint32_t
979 tunnel_id_to_flow_tbl(uint32_t id)
980 {
981         return id | (1u << 16);
982 }
983
984 static inline uint32_t
985 tunnel_flow_tbl_to_id(uint32_t flow_tbl)
986 {
987         return flow_tbl & ~(1u << 16);
988 }
989
990 union tunnel_tbl_key {
991         uint64_t val;
992         struct {
993                 uint32_t tunnel_id;
994                 uint32_t group;
995         };
996 };
997
998 static inline struct mlx5_flow_tunnel_hub *
999 mlx5_tunnel_hub(struct rte_eth_dev *dev)
1000 {
1001         struct mlx5_priv *priv = dev->data->dev_private;
1002         return priv->sh->tunnel_hub;
1003 }
1004
1005 static inline bool
1006 is_tunnel_offload_active(struct rte_eth_dev *dev)
1007 {
1008         struct mlx5_priv *priv = dev->data->dev_private;
1009         return !!priv->config.dv_miss_info;
1010 }
1011
1012 static inline bool
1013 is_flow_tunnel_match_rule(__rte_unused struct rte_eth_dev *dev,
1014                           __rte_unused const struct rte_flow_attr *attr,
1015                           __rte_unused const struct rte_flow_item items[],
1016                           __rte_unused const struct rte_flow_action actions[])
1017 {
1018         return (items[0].type == (typeof(items[0].type))
1019                                  MLX5_RTE_FLOW_ITEM_TYPE_TUNNEL);
1020 }
1021
1022 static inline bool
1023 is_flow_tunnel_steer_rule(__rte_unused struct rte_eth_dev *dev,
1024                           __rte_unused const struct rte_flow_attr *attr,
1025                           __rte_unused const struct rte_flow_item items[],
1026                           __rte_unused const struct rte_flow_action actions[])
1027 {
1028         return (actions[0].type == (typeof(actions[0].type))
1029                                    MLX5_RTE_FLOW_ACTION_TYPE_TUNNEL_SET);
1030 }
1031
1032 static inline const struct mlx5_flow_tunnel *
1033 flow_actions_to_tunnel(const struct rte_flow_action actions[])
1034 {
1035         return actions[0].conf;
1036 }
1037
1038 static inline const struct mlx5_flow_tunnel *
1039 flow_items_to_tunnel(const struct rte_flow_item items[])
1040 {
1041         return items[0].spec;
1042 }
1043
1044 /* Flow structure. */
1045 struct rte_flow {
1046         ILIST_ENTRY(uint32_t)next; /**< Index to the next flow structure. */
1047         struct mlx5_shared_action_rss *shared_rss; /** < Shred RSS action. */
1048         uint32_t dev_handles;
1049         /**< Device flow handles that are part of the flow. */
1050         uint32_t drv_type:2; /**< Driver type. */
1051         uint32_t fdir:1; /**< Identifier of associated FDIR if any. */
1052         uint32_t tunnel:1;
1053         uint32_t copy_applied:1; /**< The MARK copy Flow os applied. */
1054         uint32_t meter:16; /**< Holds flow meter id. */
1055         uint32_t rix_mreg_copy;
1056         /**< Index to metadata register copy table resource. */
1057         uint32_t counter; /**< Holds flow counter. */
1058         uint32_t tunnel_id;  /**< Tunnel id */
1059 } __rte_packed;
1060
1061 /*
1062  * Define list of valid combinations of RX Hash fields
1063  * (see enum ibv_rx_hash_fields).
1064  */
1065 #define MLX5_RSS_HASH_IPV4 (IBV_RX_HASH_SRC_IPV4 | IBV_RX_HASH_DST_IPV4)
1066 #define MLX5_RSS_HASH_IPV4_TCP \
1067         (MLX5_RSS_HASH_IPV4 | \
1068          IBV_RX_HASH_SRC_PORT_TCP | IBV_RX_HASH_SRC_PORT_TCP)
1069 #define MLX5_RSS_HASH_IPV4_UDP \
1070         (MLX5_RSS_HASH_IPV4 | \
1071          IBV_RX_HASH_SRC_PORT_UDP | IBV_RX_HASH_SRC_PORT_UDP)
1072 #define MLX5_RSS_HASH_IPV6 (IBV_RX_HASH_SRC_IPV6 | IBV_RX_HASH_DST_IPV6)
1073 #define MLX5_RSS_HASH_IPV6_TCP \
1074         (MLX5_RSS_HASH_IPV6 | \
1075          IBV_RX_HASH_SRC_PORT_TCP | IBV_RX_HASH_SRC_PORT_TCP)
1076 #define MLX5_RSS_HASH_IPV6_UDP \
1077         (MLX5_RSS_HASH_IPV6 | \
1078          IBV_RX_HASH_SRC_PORT_UDP | IBV_RX_HASH_SRC_PORT_UDP)
1079 #define MLX5_RSS_HASH_NONE 0ULL
1080
1081 /* array of valid combinations of RX Hash fields for RSS */
1082 static const uint64_t mlx5_rss_hash_fields[] = {
1083         MLX5_RSS_HASH_IPV4,
1084         MLX5_RSS_HASH_IPV4_TCP,
1085         MLX5_RSS_HASH_IPV4_UDP,
1086         MLX5_RSS_HASH_IPV6,
1087         MLX5_RSS_HASH_IPV6_TCP,
1088         MLX5_RSS_HASH_IPV6_UDP,
1089         MLX5_RSS_HASH_NONE,
1090 };
1091
1092 #define MLX5_RSS_HASH_FIELDS_LEN RTE_DIM(mlx5_rss_hash_fields)
1093
1094 /* Shared RSS action structure */
1095 struct mlx5_shared_action_rss {
1096         struct rte_flow_action_rss origin; /**< Original rte RSS action. */
1097         uint8_t key[MLX5_RSS_HASH_KEY_LEN]; /**< RSS hash key. */
1098         uint16_t *queue; /**< Queue indices to use. */
1099         uint32_t hrxq[MLX5_RSS_HASH_FIELDS_LEN];
1100         /**< Hash RX queue indexes mapped to mlx5_rss_hash_fields */
1101         uint32_t hrxq_tunnel[MLX5_RSS_HASH_FIELDS_LEN];
1102         /**< Hash RX queue indexes for tunneled RSS */
1103 };
1104
1105 struct rte_flow_shared_action {
1106         LIST_ENTRY(rte_flow_shared_action) next;
1107                 /**< Pointer to the next element. */
1108         uint32_t refcnt; /**< Atomically accessed refcnt. */
1109         uint64_t type;
1110                 /**< Shared action type (see MLX5_FLOW_ACTION_SHARED_*). */
1111         union {
1112                 struct mlx5_shared_action_rss rss;
1113                         /**< Shared RSS action. */
1114         };
1115 };
1116
1117 /* Thread specific flow workspace intermediate data. */
1118 struct mlx5_flow_workspace {
1119         struct mlx5_flow flows[MLX5_NUM_MAX_DEV_FLOWS];
1120         struct mlx5_flow_rss_desc rss_desc[2];
1121         uint32_t rssq_num[2]; /* Allocated queue num in rss_desc. */
1122         int flow_idx; /* Intermediate device flow index. */
1123         int flow_nested_idx; /* Intermediate device flow index, nested. */
1124 };
1125
1126 typedef int (*mlx5_flow_validate_t)(struct rte_eth_dev *dev,
1127                                     const struct rte_flow_attr *attr,
1128                                     const struct rte_flow_item items[],
1129                                     const struct rte_flow_action actions[],
1130                                     bool external,
1131                                     int hairpin,
1132                                     struct rte_flow_error *error);
1133 typedef struct mlx5_flow *(*mlx5_flow_prepare_t)
1134         (struct rte_eth_dev *dev, const struct rte_flow_attr *attr,
1135          const struct rte_flow_item items[],
1136          const struct rte_flow_action actions[], struct rte_flow_error *error);
1137 typedef int (*mlx5_flow_translate_t)(struct rte_eth_dev *dev,
1138                                      struct mlx5_flow *dev_flow,
1139                                      const struct rte_flow_attr *attr,
1140                                      const struct rte_flow_item items[],
1141                                      const struct rte_flow_action actions[],
1142                                      struct rte_flow_error *error);
1143 typedef int (*mlx5_flow_apply_t)(struct rte_eth_dev *dev, struct rte_flow *flow,
1144                                  struct rte_flow_error *error);
1145 typedef void (*mlx5_flow_remove_t)(struct rte_eth_dev *dev,
1146                                    struct rte_flow *flow);
1147 typedef void (*mlx5_flow_destroy_t)(struct rte_eth_dev *dev,
1148                                     struct rte_flow *flow);
1149 typedef int (*mlx5_flow_query_t)(struct rte_eth_dev *dev,
1150                                  struct rte_flow *flow,
1151                                  const struct rte_flow_action *actions,
1152                                  void *data,
1153                                  struct rte_flow_error *error);
1154 typedef struct mlx5_meter_domains_infos *(*mlx5_flow_create_mtr_tbls_t)
1155                                             (struct rte_eth_dev *dev,
1156                                              const struct mlx5_flow_meter *fm);
1157 typedef int (*mlx5_flow_destroy_mtr_tbls_t)(struct rte_eth_dev *dev,
1158                                         struct mlx5_meter_domains_infos *tbls);
1159 typedef int (*mlx5_flow_create_policer_rules_t)
1160                                         (struct rte_eth_dev *dev,
1161                                          struct mlx5_flow_meter *fm,
1162                                          const struct rte_flow_attr *attr);
1163 typedef int (*mlx5_flow_destroy_policer_rules_t)
1164                                         (struct rte_eth_dev *dev,
1165                                          const struct mlx5_flow_meter *fm,
1166                                          const struct rte_flow_attr *attr);
1167 typedef uint32_t (*mlx5_flow_counter_alloc_t)
1168                                    (struct rte_eth_dev *dev);
1169 typedef void (*mlx5_flow_counter_free_t)(struct rte_eth_dev *dev,
1170                                          uint32_t cnt);
1171 typedef int (*mlx5_flow_counter_query_t)(struct rte_eth_dev *dev,
1172                                          uint32_t cnt,
1173                                          bool clear, uint64_t *pkts,
1174                                          uint64_t *bytes);
1175 typedef int (*mlx5_flow_get_aged_flows_t)
1176                                         (struct rte_eth_dev *dev,
1177                                          void **context,
1178                                          uint32_t nb_contexts,
1179                                          struct rte_flow_error *error);
1180 typedef int (*mlx5_flow_action_validate_t)
1181                                 (struct rte_eth_dev *dev,
1182                                  const struct rte_flow_shared_action_conf *conf,
1183                                  const struct rte_flow_action *action,
1184                                  struct rte_flow_error *error);
1185 typedef struct rte_flow_shared_action *(*mlx5_flow_action_create_t)
1186                                 (struct rte_eth_dev *dev,
1187                                  const struct rte_flow_shared_action_conf *conf,
1188                                  const struct rte_flow_action *action,
1189                                  struct rte_flow_error *error);
1190 typedef int (*mlx5_flow_action_destroy_t)
1191                                 (struct rte_eth_dev *dev,
1192                                  struct rte_flow_shared_action *action,
1193                                  struct rte_flow_error *error);
1194 typedef int (*mlx5_flow_action_update_t)
1195                         (struct rte_eth_dev *dev,
1196                          struct rte_flow_shared_action *action,
1197                          const void *action_conf,
1198                          struct rte_flow_error *error);
1199 typedef int (*mlx5_flow_sync_domain_t)
1200                         (struct rte_eth_dev *dev,
1201                          uint32_t domains,
1202                          uint32_t flags);
1203 struct mlx5_flow_driver_ops {
1204         mlx5_flow_validate_t validate;
1205         mlx5_flow_prepare_t prepare;
1206         mlx5_flow_translate_t translate;
1207         mlx5_flow_apply_t apply;
1208         mlx5_flow_remove_t remove;
1209         mlx5_flow_destroy_t destroy;
1210         mlx5_flow_query_t query;
1211         mlx5_flow_create_mtr_tbls_t create_mtr_tbls;
1212         mlx5_flow_destroy_mtr_tbls_t destroy_mtr_tbls;
1213         mlx5_flow_create_policer_rules_t create_policer_rules;
1214         mlx5_flow_destroy_policer_rules_t destroy_policer_rules;
1215         mlx5_flow_counter_alloc_t counter_alloc;
1216         mlx5_flow_counter_free_t counter_free;
1217         mlx5_flow_counter_query_t counter_query;
1218         mlx5_flow_get_aged_flows_t get_aged_flows;
1219         mlx5_flow_action_validate_t action_validate;
1220         mlx5_flow_action_create_t action_create;
1221         mlx5_flow_action_destroy_t action_destroy;
1222         mlx5_flow_action_update_t action_update;
1223         mlx5_flow_sync_domain_t sync_domain;
1224 };
1225
1226 /* mlx5_flow.c */
1227
1228 struct mlx5_flow_workspace *mlx5_flow_get_thread_workspace(void);
1229 __extension__
1230 struct flow_grp_info {
1231         uint64_t external:1;
1232         uint64_t transfer:1;
1233         uint64_t fdb_def_rule:1;
1234         /* force standard group translation */
1235         uint64_t std_tbl_fix:1;
1236 };
1237
1238 static inline bool
1239 tunnel_use_standard_attr_group_translate
1240                     (struct rte_eth_dev *dev,
1241                      const struct mlx5_flow_tunnel *tunnel,
1242                      const struct rte_flow_attr *attr,
1243                      const struct rte_flow_item items[],
1244                      const struct rte_flow_action actions[])
1245 {
1246         bool verdict;
1247
1248         if (!is_tunnel_offload_active(dev))
1249                 /* no tunnel offload API */
1250                 verdict = true;
1251         else if (tunnel) {
1252                 /*
1253                  * OvS will use jump to group 0 in tunnel steer rule.
1254                  * If tunnel steer rule starts from group 0 (attr.group == 0)
1255                  * that 0 group must be translated with standard method.
1256                  * attr.group == 0 in tunnel match rule translated with tunnel
1257                  * method
1258                  */
1259                 verdict = !attr->group &&
1260                           is_flow_tunnel_steer_rule(dev, attr, items, actions);
1261         } else {
1262                 /*
1263                  * non-tunnel group translation uses standard method for
1264                  * root group only: attr.group == 0
1265                  */
1266                 verdict = !attr->group;
1267         }
1268
1269         return verdict;
1270 }
1271
1272 int mlx5_flow_group_to_table(struct rte_eth_dev *dev,
1273                              const struct mlx5_flow_tunnel *tunnel,
1274                              uint32_t group, uint32_t *table,
1275                              struct flow_grp_info flags,
1276                                  struct rte_flow_error *error);
1277 uint64_t mlx5_flow_hashfields_adjust(struct mlx5_flow_rss_desc *rss_desc,
1278                                      int tunnel, uint64_t layer_types,
1279                                      uint64_t hash_fields);
1280 int mlx5_flow_discover_priorities(struct rte_eth_dev *dev);
1281 uint32_t mlx5_flow_adjust_priority(struct rte_eth_dev *dev, int32_t priority,
1282                                    uint32_t subpriority);
1283 int mlx5_flow_get_reg_id(struct rte_eth_dev *dev,
1284                                      enum mlx5_feature_name feature,
1285                                      uint32_t id,
1286                                      struct rte_flow_error *error);
1287 const struct rte_flow_action *mlx5_flow_find_action
1288                                         (const struct rte_flow_action *actions,
1289                                          enum rte_flow_action_type action);
1290 int mlx5_validate_action_rss(struct rte_eth_dev *dev,
1291                              const struct rte_flow_action *action,
1292                              struct rte_flow_error *error);
1293 int mlx5_flow_validate_action_count(struct rte_eth_dev *dev,
1294                                     const struct rte_flow_attr *attr,
1295                                     struct rte_flow_error *error);
1296 int mlx5_flow_validate_action_drop(uint64_t action_flags,
1297                                    const struct rte_flow_attr *attr,
1298                                    struct rte_flow_error *error);
1299 int mlx5_flow_validate_action_flag(uint64_t action_flags,
1300                                    const struct rte_flow_attr *attr,
1301                                    struct rte_flow_error *error);
1302 int mlx5_flow_validate_action_mark(const struct rte_flow_action *action,
1303                                    uint64_t action_flags,
1304                                    const struct rte_flow_attr *attr,
1305                                    struct rte_flow_error *error);
1306 int mlx5_flow_validate_action_queue(const struct rte_flow_action *action,
1307                                     uint64_t action_flags,
1308                                     struct rte_eth_dev *dev,
1309                                     const struct rte_flow_attr *attr,
1310                                     struct rte_flow_error *error);
1311 int mlx5_flow_validate_action_rss(const struct rte_flow_action *action,
1312                                   uint64_t action_flags,
1313                                   struct rte_eth_dev *dev,
1314                                   const struct rte_flow_attr *attr,
1315                                   uint64_t item_flags,
1316                                   struct rte_flow_error *error);
1317 int mlx5_flow_validate_action_default_miss(uint64_t action_flags,
1318                                 const struct rte_flow_attr *attr,
1319                                 struct rte_flow_error *error);
1320 int mlx5_flow_validate_attributes(struct rte_eth_dev *dev,
1321                                   const struct rte_flow_attr *attributes,
1322                                   struct rte_flow_error *error);
1323 int mlx5_flow_item_acceptable(const struct rte_flow_item *item,
1324                               const uint8_t *mask,
1325                               const uint8_t *nic_mask,
1326                               unsigned int size,
1327                               bool range_accepted,
1328                               struct rte_flow_error *error);
1329 int mlx5_flow_validate_item_eth(const struct rte_flow_item *item,
1330                                 uint64_t item_flags, bool ext_vlan_sup,
1331                                 struct rte_flow_error *error);
1332 int mlx5_flow_validate_item_gre(const struct rte_flow_item *item,
1333                                 uint64_t item_flags,
1334                                 uint8_t target_protocol,
1335                                 struct rte_flow_error *error);
1336 int mlx5_flow_validate_item_gre_key(const struct rte_flow_item *item,
1337                                     uint64_t item_flags,
1338                                     const struct rte_flow_item *gre_item,
1339                                     struct rte_flow_error *error);
1340 int mlx5_flow_validate_item_ipv4(const struct rte_flow_item *item,
1341                                  uint64_t item_flags,
1342                                  uint64_t last_item,
1343                                  uint16_t ether_type,
1344                                  const struct rte_flow_item_ipv4 *acc_mask,
1345                                  bool range_accepted,
1346                                  struct rte_flow_error *error);
1347 int mlx5_flow_validate_item_ipv6(const struct rte_flow_item *item,
1348                                  uint64_t item_flags,
1349                                  uint64_t last_item,
1350                                  uint16_t ether_type,
1351                                  const struct rte_flow_item_ipv6 *acc_mask,
1352                                  struct rte_flow_error *error);
1353 int mlx5_flow_validate_item_mpls(struct rte_eth_dev *dev,
1354                                  const struct rte_flow_item *item,
1355                                  uint64_t item_flags,
1356                                  uint64_t prev_layer,
1357                                  struct rte_flow_error *error);
1358 int mlx5_flow_validate_item_tcp(const struct rte_flow_item *item,
1359                                 uint64_t item_flags,
1360                                 uint8_t target_protocol,
1361                                 const struct rte_flow_item_tcp *flow_mask,
1362                                 struct rte_flow_error *error);
1363 int mlx5_flow_validate_item_udp(const struct rte_flow_item *item,
1364                                 uint64_t item_flags,
1365                                 uint8_t target_protocol,
1366                                 struct rte_flow_error *error);
1367 int mlx5_flow_validate_item_vlan(const struct rte_flow_item *item,
1368                                  uint64_t item_flags,
1369                                  struct rte_eth_dev *dev,
1370                                  struct rte_flow_error *error);
1371 int mlx5_flow_validate_item_vxlan(const struct rte_flow_item *item,
1372                                   uint64_t item_flags,
1373                                   struct rte_flow_error *error);
1374 int mlx5_flow_validate_item_vxlan_gpe(const struct rte_flow_item *item,
1375                                       uint64_t item_flags,
1376                                       struct rte_eth_dev *dev,
1377                                       struct rte_flow_error *error);
1378 int mlx5_flow_validate_item_icmp(const struct rte_flow_item *item,
1379                                  uint64_t item_flags,
1380                                  uint8_t target_protocol,
1381                                  struct rte_flow_error *error);
1382 int mlx5_flow_validate_item_icmp6(const struct rte_flow_item *item,
1383                                    uint64_t item_flags,
1384                                    uint8_t target_protocol,
1385                                    struct rte_flow_error *error);
1386 int mlx5_flow_validate_item_nvgre(const struct rte_flow_item *item,
1387                                   uint64_t item_flags,
1388                                   uint8_t target_protocol,
1389                                   struct rte_flow_error *error);
1390 int mlx5_flow_validate_item_geneve(const struct rte_flow_item *item,
1391                                    uint64_t item_flags,
1392                                    struct rte_eth_dev *dev,
1393                                    struct rte_flow_error *error);
1394 int mlx5_flow_validate_item_ecpri(const struct rte_flow_item *item,
1395                                   uint64_t item_flags,
1396                                   uint64_t last_item,
1397                                   uint16_t ether_type,
1398                                   const struct rte_flow_item_ecpri *acc_mask,
1399                                   struct rte_flow_error *error);
1400 struct mlx5_meter_domains_infos *mlx5_flow_create_mtr_tbls
1401                                         (struct rte_eth_dev *dev,
1402                                          const struct mlx5_flow_meter *fm);
1403 int mlx5_flow_destroy_mtr_tbls(struct rte_eth_dev *dev,
1404                                struct mlx5_meter_domains_infos *tbl);
1405 int mlx5_flow_create_policer_rules(struct rte_eth_dev *dev,
1406                                    struct mlx5_flow_meter *fm,
1407                                    const struct rte_flow_attr *attr);
1408 int mlx5_flow_destroy_policer_rules(struct rte_eth_dev *dev,
1409                                     struct mlx5_flow_meter *fm,
1410                                     const struct rte_flow_attr *attr);
1411 int mlx5_flow_meter_flush(struct rte_eth_dev *dev,
1412                           struct rte_mtr_error *error);
1413 int mlx5_flow_dv_discover_counter_offset_support(struct rte_eth_dev *dev);
1414 struct rte_flow_shared_action *mlx5_flow_get_shared_rss(struct rte_flow *flow);
1415 int mlx5_shared_action_flush(struct rte_eth_dev *dev);
1416 void mlx5_release_tunnel_hub(struct mlx5_dev_ctx_shared *sh, uint16_t port_id);
1417 int mlx5_alloc_tunnel_hub(struct mlx5_dev_ctx_shared *sh);
1418
1419 /* Hash list callbacks for flow tables: */
1420 struct mlx5_hlist_entry *flow_dv_tbl_create_cb(struct mlx5_hlist *list,
1421                                                uint64_t key, void *entry_ctx);
1422 void flow_dv_tbl_remove_cb(struct mlx5_hlist *list,
1423                            struct mlx5_hlist_entry *entry);
1424 struct mlx5_flow_tbl_resource *flow_dv_tbl_resource_get(struct rte_eth_dev *dev,
1425                 uint32_t table_id, uint8_t egress, uint8_t transfer,
1426                 bool external, const struct mlx5_flow_tunnel *tunnel,
1427                 uint32_t group_id, uint8_t dummy, struct rte_flow_error *error);
1428
1429 struct mlx5_hlist_entry *flow_dv_tag_create_cb(struct mlx5_hlist *list,
1430                                                uint64_t key, void *cb_ctx);
1431 void flow_dv_tag_remove_cb(struct mlx5_hlist *list,
1432                            struct mlx5_hlist_entry *entry);
1433
1434 #endif /* RTE_PMD_MLX5_FLOW_H_ */