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