net/ice: fix hash flow crash
[dpdk.git] / drivers / net / ice / ice_hash.c
1 /* SPDX-License-Identifier: BSD-3-Clause
2  * Copyright(c) 2019 Intel Corporation
3  */
4
5 #include <sys/queue.h>
6 #include <stdio.h>
7 #include <errno.h>
8 #include <stdint.h>
9 #include <string.h>
10 #include <unistd.h>
11 #include <stdarg.h>
12
13 #include <rte_debug.h>
14 #include <rte_ether.h>
15 #include <rte_ethdev_driver.h>
16 #include <rte_log.h>
17 #include <rte_malloc.h>
18 #include <rte_eth_ctrl.h>
19 #include <rte_tailq.h>
20 #include <rte_flow_driver.h>
21
22 #include "ice_logs.h"
23 #include "base/ice_type.h"
24 #include "base/ice_flow.h"
25 #include "ice_ethdev.h"
26 #include "ice_generic_flow.h"
27
28 struct rss_type_match_hdr {
29         uint32_t hdr_mask;
30         uint64_t eth_rss_hint;
31 };
32
33 struct ice_hash_match_type {
34         uint64_t hash_type;
35         uint64_t hash_flds;
36 };
37
38 struct rss_meta {
39         uint32_t pkt_hdr;
40         uint64_t hash_flds;
41         uint8_t hash_function;
42 };
43
44 struct ice_hash_flow_cfg {
45         bool simple_xor;
46         struct ice_rss_cfg rss_cfg;
47 };
48
49 static int
50 ice_hash_init(struct ice_adapter *ad);
51
52 static int
53 ice_hash_create(struct ice_adapter *ad,
54                 struct rte_flow *flow,
55                 void *meta,
56                 struct rte_flow_error *error);
57
58 static int
59 ice_hash_destroy(struct ice_adapter *ad,
60                 struct rte_flow *flow,
61                 struct rte_flow_error *error);
62
63 static void
64 ice_hash_uninit(struct ice_adapter *ad);
65
66 static void
67 ice_hash_free(struct rte_flow *flow);
68
69 static int
70 ice_hash_parse_pattern_action(struct ice_adapter *ad,
71                         struct ice_pattern_match_item *array,
72                         uint32_t array_len,
73                         const struct rte_flow_item pattern[],
74                         const struct rte_flow_action actions[],
75                         void **meta,
76                         struct rte_flow_error *error);
77
78 /* The first member is protocol header, the second member is ETH_RSS_*. */
79 struct rss_type_match_hdr hint_0 = {
80         ICE_FLOW_SEG_HDR_NONE,  0};
81 struct rss_type_match_hdr hint_1 = {
82         ICE_FLOW_SEG_HDR_IPV4,  ETH_RSS_IPV4};
83 struct rss_type_match_hdr hint_2 = {
84         ICE_FLOW_SEG_HDR_IPV4 | ICE_FLOW_SEG_HDR_UDP, ETH_RSS_NONFRAG_IPV4_UDP};
85 struct rss_type_match_hdr hint_3 = {
86         ICE_FLOW_SEG_HDR_IPV4 | ICE_FLOW_SEG_HDR_TCP, ETH_RSS_NONFRAG_IPV4_TCP};
87 struct rss_type_match_hdr hint_4 = {
88         ICE_FLOW_SEG_HDR_IPV4 | ICE_FLOW_SEG_HDR_SCTP, ETH_RSS_NONFRAG_IPV4_SCTP};
89 struct rss_type_match_hdr hint_5 = {
90         ICE_FLOW_SEG_HDR_IPV6,  ETH_RSS_IPV6};
91 struct rss_type_match_hdr hint_6 = {
92         ICE_FLOW_SEG_HDR_IPV6 | ICE_FLOW_SEG_HDR_UDP, ETH_RSS_NONFRAG_IPV6_UDP};
93 struct rss_type_match_hdr hint_7 = {
94         ICE_FLOW_SEG_HDR_IPV6 | ICE_FLOW_SEG_HDR_TCP, ETH_RSS_NONFRAG_IPV6_TCP};
95 struct rss_type_match_hdr hint_8 = {
96         ICE_FLOW_SEG_HDR_IPV6 | ICE_FLOW_SEG_HDR_SCTP, ETH_RSS_NONFRAG_IPV6_SCTP};
97 struct rss_type_match_hdr hint_9 = {
98         ICE_FLOW_SEG_HDR_GTPU_IP,       ETH_RSS_IPV4};
99 struct rss_type_match_hdr hint_10 = {
100         ICE_FLOW_SEG_HDR_PPPOE, ETH_RSS_IPV4};
101 struct rss_type_match_hdr hint_11 = {
102         ICE_FLOW_SEG_HDR_PPPOE, ETH_RSS_NONFRAG_IPV4_UDP};
103 struct rss_type_match_hdr hint_12 = {
104         ICE_FLOW_SEG_HDR_PPPOE, ETH_RSS_NONFRAG_IPV4_TCP};
105 struct rss_type_match_hdr hint_13 = {
106         ICE_FLOW_SEG_HDR_PPPOE, ETH_RSS_NONFRAG_IPV4_SCTP};
107
108 /* Supported pattern for os default package. */
109 static struct ice_pattern_match_item ice_hash_pattern_list_os[] = {
110         {pattern_eth_ipv4,      ICE_INSET_NONE, &hint_1},
111         {pattern_eth_ipv4_udp,  ICE_INSET_NONE, &hint_2},
112         {pattern_eth_ipv4_tcp,  ICE_INSET_NONE, &hint_3},
113         {pattern_eth_ipv4_sctp, ICE_INSET_NONE, &hint_4},
114         {pattern_eth_ipv6,      ICE_INSET_NONE, &hint_5},
115         {pattern_eth_ipv6_udp,  ICE_INSET_NONE, &hint_6},
116         {pattern_eth_ipv6_tcp,  ICE_INSET_NONE, &hint_7},
117         {pattern_eth_ipv6_sctp, ICE_INSET_NONE, &hint_8},
118         {pattern_empty,         ICE_INSET_NONE, &hint_0},
119 };
120
121 /* Supported pattern for comms package. */
122 static struct ice_pattern_match_item ice_hash_pattern_list_comms[] = {
123         {pattern_eth_ipv4,                  ICE_INSET_NONE,  &hint_1},
124         {pattern_eth_ipv4_udp,              ICE_INSET_NONE,  &hint_2},
125         {pattern_eth_ipv4_tcp,              ICE_INSET_NONE,  &hint_3},
126         {pattern_eth_ipv4_sctp,             ICE_INSET_NONE,  &hint_4},
127         {pattern_eth_ipv6,                  ICE_INSET_NONE,  &hint_5},
128         {pattern_eth_ipv6_udp,              ICE_INSET_NONE,  &hint_6},
129         {pattern_eth_ipv6_tcp,              ICE_INSET_NONE,  &hint_7},
130         {pattern_eth_ipv6_sctp,             ICE_INSET_NONE,  &hint_8},
131         {pattern_empty,                     ICE_INSET_NONE,  &hint_0},
132         {pattern_eth_ipv4_gtpu_eh_ipv4,     ICE_INSET_NONE,  &hint_9},
133         {pattern_eth_ipv4_gtpu_eh_ipv4_udp, ICE_INSET_NONE,  &hint_9},
134         {pattern_eth_ipv4_gtpu_eh_ipv4_tcp, ICE_INSET_NONE,  &hint_9},
135         {pattern_eth_pppoes_ipv4,           ICE_INSET_NONE,  &hint_10},
136         {pattern_eth_pppoes_ipv4_udp,       ICE_INSET_NONE,  &hint_11},
137         {pattern_eth_pppoes_ipv4_tcp,       ICE_INSET_NONE,  &hint_12},
138         {pattern_eth_pppoes_ipv4_sctp,      ICE_INSET_NONE,  &hint_13},
139 };
140
141 /**
142  * The first member is input set combination,
143  * the second member is hash fields.
144  */
145 struct ice_hash_match_type ice_hash_type_list[] = {
146         {ETH_RSS_IPV4 | ETH_RSS_L3_SRC_ONLY,                                    BIT_ULL(ICE_FLOW_FIELD_IDX_IPV4_SA)},
147         {ETH_RSS_IPV4 | ETH_RSS_L3_DST_ONLY,                                    BIT_ULL(ICE_FLOW_FIELD_IDX_IPV4_DA)},
148         {ETH_RSS_IPV4,                                                          ICE_FLOW_HASH_IPV4},
149         {ETH_RSS_NONFRAG_IPV4_UDP | ETH_RSS_L3_SRC_ONLY | ETH_RSS_L4_SRC_ONLY,  BIT_ULL(ICE_FLOW_FIELD_IDX_IPV4_SA) | BIT_ULL(ICE_FLOW_FIELD_IDX_UDP_SRC_PORT)},
150         {ETH_RSS_NONFRAG_IPV4_UDP | ETH_RSS_L3_SRC_ONLY | ETH_RSS_L4_DST_ONLY,  BIT_ULL(ICE_FLOW_FIELD_IDX_IPV4_SA) | BIT_ULL(ICE_FLOW_FIELD_IDX_UDP_DST_PORT)},
151         {ETH_RSS_NONFRAG_IPV4_UDP | ETH_RSS_L3_SRC_ONLY,                        BIT_ULL(ICE_FLOW_FIELD_IDX_IPV4_SA)},
152         {ETH_RSS_NONFRAG_IPV4_UDP | ETH_RSS_L3_DST_ONLY | ETH_RSS_L4_SRC_ONLY,  BIT_ULL(ICE_FLOW_FIELD_IDX_IPV4_DA) | BIT_ULL(ICE_FLOW_FIELD_IDX_UDP_SRC_PORT)},
153         {ETH_RSS_NONFRAG_IPV4_UDP | ETH_RSS_L3_DST_ONLY | ETH_RSS_L4_DST_ONLY,  BIT_ULL(ICE_FLOW_FIELD_IDX_IPV4_DA) | BIT_ULL(ICE_FLOW_FIELD_IDX_UDP_DST_PORT)},
154         {ETH_RSS_NONFRAG_IPV4_UDP | ETH_RSS_L3_DST_ONLY,                        BIT_ULL(ICE_FLOW_FIELD_IDX_IPV4_DA)},
155         {ETH_RSS_NONFRAG_IPV4_UDP | ETH_RSS_L4_SRC_ONLY,                        BIT_ULL(ICE_FLOW_FIELD_IDX_UDP_SRC_PORT)},
156         {ETH_RSS_NONFRAG_IPV4_UDP | ETH_RSS_L4_DST_ONLY,                        BIT_ULL(ICE_FLOW_FIELD_IDX_UDP_DST_PORT)},
157         {ETH_RSS_NONFRAG_IPV4_UDP,                                              ICE_HASH_UDP_IPV4},
158         {ETH_RSS_NONFRAG_IPV4_TCP | ETH_RSS_L3_SRC_ONLY | ETH_RSS_L4_SRC_ONLY,  BIT_ULL(ICE_FLOW_FIELD_IDX_IPV4_SA) | BIT_ULL(ICE_FLOW_FIELD_IDX_TCP_SRC_PORT)},
159         {ETH_RSS_NONFRAG_IPV4_TCP | ETH_RSS_L3_SRC_ONLY | ETH_RSS_L4_DST_ONLY,  BIT_ULL(ICE_FLOW_FIELD_IDX_IPV4_SA) | BIT_ULL(ICE_FLOW_FIELD_IDX_TCP_DST_PORT)},
160         {ETH_RSS_NONFRAG_IPV4_TCP | ETH_RSS_L3_SRC_ONLY,                        BIT_ULL(ICE_FLOW_FIELD_IDX_IPV4_SA)},
161         {ETH_RSS_NONFRAG_IPV4_TCP | ETH_RSS_L3_DST_ONLY | ETH_RSS_L4_SRC_ONLY,  BIT_ULL(ICE_FLOW_FIELD_IDX_IPV4_DA) | BIT_ULL(ICE_FLOW_FIELD_IDX_TCP_SRC_PORT)},
162         {ETH_RSS_NONFRAG_IPV4_TCP | ETH_RSS_L3_DST_ONLY | ETH_RSS_L4_DST_ONLY,  BIT_ULL(ICE_FLOW_FIELD_IDX_IPV4_DA) | BIT_ULL(ICE_FLOW_FIELD_IDX_TCP_DST_PORT)},
163         {ETH_RSS_NONFRAG_IPV4_TCP | ETH_RSS_L3_DST_ONLY,                        BIT_ULL(ICE_FLOW_FIELD_IDX_IPV4_DA)},
164         {ETH_RSS_NONFRAG_IPV4_TCP | ETH_RSS_L4_SRC_ONLY,                        BIT_ULL(ICE_FLOW_FIELD_IDX_TCP_SRC_PORT)},
165         {ETH_RSS_NONFRAG_IPV4_TCP | ETH_RSS_L4_DST_ONLY,                        BIT_ULL(ICE_FLOW_FIELD_IDX_TCP_DST_PORT)},
166         {ETH_RSS_NONFRAG_IPV4_TCP,                                              ICE_HASH_TCP_IPV4},
167         {ETH_RSS_NONFRAG_IPV4_SCTP | ETH_RSS_L3_SRC_ONLY | ETH_RSS_L4_SRC_ONLY, BIT_ULL(ICE_FLOW_FIELD_IDX_IPV4_SA) | BIT_ULL(ICE_FLOW_FIELD_IDX_SCTP_SRC_PORT)},
168         {ETH_RSS_NONFRAG_IPV4_SCTP | ETH_RSS_L3_SRC_ONLY | ETH_RSS_L4_DST_ONLY, BIT_ULL(ICE_FLOW_FIELD_IDX_IPV4_SA) | BIT_ULL(ICE_FLOW_FIELD_IDX_SCTP_DST_PORT)},
169         {ETH_RSS_NONFRAG_IPV4_SCTP | ETH_RSS_L3_SRC_ONLY,                       BIT_ULL(ICE_FLOW_FIELD_IDX_IPV4_SA)},
170         {ETH_RSS_NONFRAG_IPV4_SCTP | ETH_RSS_L3_DST_ONLY | ETH_RSS_L4_SRC_ONLY, BIT_ULL(ICE_FLOW_FIELD_IDX_IPV4_DA) | BIT_ULL(ICE_FLOW_FIELD_IDX_SCTP_SRC_PORT)},
171         {ETH_RSS_NONFRAG_IPV4_SCTP | ETH_RSS_L3_DST_ONLY | ETH_RSS_L4_DST_ONLY, BIT_ULL(ICE_FLOW_FIELD_IDX_IPV4_DA) | BIT_ULL(ICE_FLOW_FIELD_IDX_SCTP_DST_PORT)},
172         {ETH_RSS_NONFRAG_IPV4_SCTP | ETH_RSS_L3_DST_ONLY,                       BIT_ULL(ICE_FLOW_FIELD_IDX_IPV4_DA)},
173         {ETH_RSS_NONFRAG_IPV4_SCTP | ETH_RSS_L4_SRC_ONLY,                       BIT_ULL(ICE_FLOW_FIELD_IDX_SCTP_SRC_PORT)},
174         {ETH_RSS_NONFRAG_IPV4_SCTP | ETH_RSS_L4_DST_ONLY,                       BIT_ULL(ICE_FLOW_FIELD_IDX_SCTP_DST_PORT)},
175         {ETH_RSS_NONFRAG_IPV4_SCTP,                                             ICE_HASH_SCTP_IPV4},
176         {ETH_RSS_IPV6 | ETH_RSS_L3_SRC_ONLY,                                    BIT_ULL(ICE_FLOW_FIELD_IDX_IPV6_SA)},
177         {ETH_RSS_IPV6 | ETH_RSS_L3_DST_ONLY,                                    BIT_ULL(ICE_FLOW_FIELD_IDX_IPV6_DA)},
178         {ETH_RSS_IPV6,                                                          ICE_FLOW_HASH_IPV6},
179         {ETH_RSS_NONFRAG_IPV6_UDP | ETH_RSS_L3_SRC_ONLY | ETH_RSS_L4_SRC_ONLY,  BIT_ULL(ICE_FLOW_FIELD_IDX_IPV6_SA) | BIT_ULL(ICE_FLOW_FIELD_IDX_UDP_SRC_PORT)},
180         {ETH_RSS_NONFRAG_IPV6_UDP | ETH_RSS_L3_SRC_ONLY | ETH_RSS_L4_DST_ONLY,  BIT_ULL(ICE_FLOW_FIELD_IDX_IPV6_SA) | BIT_ULL(ICE_FLOW_FIELD_IDX_UDP_DST_PORT)},
181         {ETH_RSS_NONFRAG_IPV6_UDP | ETH_RSS_L3_SRC_ONLY,                        BIT_ULL(ICE_FLOW_FIELD_IDX_IPV6_SA)},
182         {ETH_RSS_NONFRAG_IPV6_UDP | ETH_RSS_L3_DST_ONLY | ETH_RSS_L4_SRC_ONLY,  BIT_ULL(ICE_FLOW_FIELD_IDX_IPV6_DA) | BIT_ULL(ICE_FLOW_FIELD_IDX_UDP_SRC_PORT)},
183         {ETH_RSS_NONFRAG_IPV6_UDP | ETH_RSS_L3_DST_ONLY | ETH_RSS_L4_DST_ONLY,  BIT_ULL(ICE_FLOW_FIELD_IDX_IPV6_DA) | BIT_ULL(ICE_FLOW_FIELD_IDX_UDP_DST_PORT)},
184         {ETH_RSS_NONFRAG_IPV6_UDP | ETH_RSS_L3_DST_ONLY,                        BIT_ULL(ICE_FLOW_FIELD_IDX_IPV6_DA)},
185         {ETH_RSS_NONFRAG_IPV6_UDP | ETH_RSS_L4_SRC_ONLY,                        BIT_ULL(ICE_FLOW_FIELD_IDX_UDP_SRC_PORT)},
186         {ETH_RSS_NONFRAG_IPV6_UDP | ETH_RSS_L4_DST_ONLY,                        BIT_ULL(ICE_FLOW_FIELD_IDX_UDP_DST_PORT)},
187         {ETH_RSS_NONFRAG_IPV6_UDP,                                              ICE_HASH_UDP_IPV6},
188         {ETH_RSS_NONFRAG_IPV6_TCP | ETH_RSS_L3_SRC_ONLY | ETH_RSS_L4_SRC_ONLY,  BIT_ULL(ICE_FLOW_FIELD_IDX_IPV6_SA) | BIT_ULL(ICE_FLOW_FIELD_IDX_TCP_SRC_PORT)},
189         {ETH_RSS_NONFRAG_IPV6_TCP | ETH_RSS_L3_SRC_ONLY | ETH_RSS_L4_DST_ONLY,  BIT_ULL(ICE_FLOW_FIELD_IDX_IPV6_SA) | BIT_ULL(ICE_FLOW_FIELD_IDX_TCP_DST_PORT)},
190         {ETH_RSS_NONFRAG_IPV6_TCP | ETH_RSS_L3_SRC_ONLY,                        BIT_ULL(ICE_FLOW_FIELD_IDX_IPV6_SA)},
191         {ETH_RSS_NONFRAG_IPV6_TCP | ETH_RSS_L3_DST_ONLY | ETH_RSS_L4_SRC_ONLY,  BIT_ULL(ICE_FLOW_FIELD_IDX_IPV6_DA) | BIT_ULL(ICE_FLOW_FIELD_IDX_TCP_SRC_PORT)},
192         {ETH_RSS_NONFRAG_IPV6_TCP | ETH_RSS_L3_DST_ONLY | ETH_RSS_L4_DST_ONLY,  BIT_ULL(ICE_FLOW_FIELD_IDX_IPV6_DA) | BIT_ULL(ICE_FLOW_FIELD_IDX_TCP_DST_PORT)},
193         {ETH_RSS_NONFRAG_IPV6_TCP | ETH_RSS_L3_DST_ONLY,                        BIT_ULL(ICE_FLOW_FIELD_IDX_IPV6_DA)},
194         {ETH_RSS_NONFRAG_IPV6_TCP | ETH_RSS_L4_SRC_ONLY,                        BIT_ULL(ICE_FLOW_FIELD_IDX_TCP_SRC_PORT)},
195         {ETH_RSS_NONFRAG_IPV6_TCP | ETH_RSS_L4_DST_ONLY,                        BIT_ULL(ICE_FLOW_FIELD_IDX_TCP_DST_PORT)},
196         {ETH_RSS_NONFRAG_IPV6_TCP,                                              ICE_HASH_TCP_IPV6},
197         {ETH_RSS_NONFRAG_IPV6_SCTP | ETH_RSS_L3_SRC_ONLY | ETH_RSS_L4_SRC_ONLY, BIT_ULL(ICE_FLOW_FIELD_IDX_IPV6_SA) | BIT_ULL(ICE_FLOW_FIELD_IDX_SCTP_SRC_PORT)},
198         {ETH_RSS_NONFRAG_IPV6_SCTP | ETH_RSS_L3_SRC_ONLY | ETH_RSS_L4_DST_ONLY, BIT_ULL(ICE_FLOW_FIELD_IDX_IPV6_SA) | BIT_ULL(ICE_FLOW_FIELD_IDX_SCTP_DST_PORT)},
199         {ETH_RSS_NONFRAG_IPV6_SCTP | ETH_RSS_L3_SRC_ONLY,                       BIT_ULL(ICE_FLOW_FIELD_IDX_IPV6_SA)},
200         {ETH_RSS_NONFRAG_IPV6_SCTP | ETH_RSS_L3_DST_ONLY | ETH_RSS_L4_SRC_ONLY, BIT_ULL(ICE_FLOW_FIELD_IDX_IPV6_DA) | BIT_ULL(ICE_FLOW_FIELD_IDX_SCTP_SRC_PORT)},
201         {ETH_RSS_NONFRAG_IPV6_SCTP | ETH_RSS_L3_DST_ONLY | ETH_RSS_L4_DST_ONLY, BIT_ULL(ICE_FLOW_FIELD_IDX_IPV6_DA) | BIT_ULL(ICE_FLOW_FIELD_IDX_SCTP_DST_PORT)},
202         {ETH_RSS_NONFRAG_IPV6_SCTP | ETH_RSS_L3_DST_ONLY,                       BIT_ULL(ICE_FLOW_FIELD_IDX_IPV6_DA)},
203         {ETH_RSS_NONFRAG_IPV6_SCTP | ETH_RSS_L4_SRC_ONLY,                       BIT_ULL(ICE_FLOW_FIELD_IDX_SCTP_SRC_PORT)},
204         {ETH_RSS_NONFRAG_IPV6_SCTP | ETH_RSS_L4_DST_ONLY,                       BIT_ULL(ICE_FLOW_FIELD_IDX_SCTP_DST_PORT)},
205         {ETH_RSS_NONFRAG_IPV6_SCTP,                                             ICE_HASH_SCTP_IPV6},
206 };
207
208 static struct ice_flow_engine ice_hash_engine = {
209         .init = ice_hash_init,
210         .create = ice_hash_create,
211         .destroy = ice_hash_destroy,
212         .uninit = ice_hash_uninit,
213         .free = ice_hash_free,
214         .type = ICE_FLOW_ENGINE_HASH,
215 };
216
217 /* Register parser for os package. */
218 static struct ice_flow_parser ice_hash_parser_os = {
219         .engine = &ice_hash_engine,
220         .array = ice_hash_pattern_list_os,
221         .array_len = RTE_DIM(ice_hash_pattern_list_os),
222         .parse_pattern_action = ice_hash_parse_pattern_action,
223         .stage = ICE_FLOW_STAGE_RSS,
224 };
225
226 /* Register parser for comms package. */
227 static struct ice_flow_parser ice_hash_parser_comms = {
228         .engine = &ice_hash_engine,
229         .array = ice_hash_pattern_list_comms,
230         .array_len = RTE_DIM(ice_hash_pattern_list_comms),
231         .parse_pattern_action = ice_hash_parse_pattern_action,
232         .stage = ICE_FLOW_STAGE_RSS,
233 };
234
235 RTE_INIT(ice_hash_engine_init)
236 {
237         struct ice_flow_engine *engine = &ice_hash_engine;
238         ice_register_flow_engine(engine);
239 }
240
241 static int
242 ice_hash_init(struct ice_adapter *ad)
243 {
244         struct ice_flow_parser *parser = NULL;
245
246         if (ad->active_pkg_type == ICE_PKG_TYPE_OS_DEFAULT)
247                 parser = &ice_hash_parser_os;
248         else if (ad->active_pkg_type == ICE_PKG_TYPE_COMMS)
249                 parser = &ice_hash_parser_comms;
250         else
251                 return -EINVAL;
252
253         return ice_register_parser(parser, ad);
254 }
255
256 static int
257 ice_hash_check_inset(const struct rte_flow_item pattern[],
258                 struct rte_flow_error *error)
259 {
260         const struct rte_flow_item *item = pattern;
261
262         for (item = pattern; item->type != RTE_FLOW_ITEM_TYPE_END; item++) {
263                 if (item->last) {
264                         rte_flow_error_set(error, EINVAL,
265                                         RTE_FLOW_ERROR_TYPE_ITEM, item,
266                                         "Not support range");
267                         return -rte_errno;
268                 }
269
270                 /* Ignore spec and mask. */
271                 if (item->spec || item->mask) {
272                         rte_flow_error_set(error, EINVAL,
273                                         RTE_FLOW_ERROR_TYPE_ITEM, item,
274                                         "Invalid spec/mask.");
275                         return -rte_errno;
276                 }
277         }
278
279         return 0;
280 }
281
282 static int
283 ice_hash_parse_action(struct ice_pattern_match_item *pattern_match_item,
284                 const struct rte_flow_action actions[],
285                 void **meta,
286                 struct rte_flow_error *error)
287 {
288         const struct rte_flow_action *action;
289         enum rte_flow_action_type action_type;
290         const struct rte_flow_action_rss *rss;
291         struct rss_type_match_hdr *m = (struct rss_type_match_hdr *)
292                                 (pattern_match_item->meta);
293         uint32_t type_list_len = RTE_DIM(ice_hash_type_list);
294         struct ice_hash_match_type *type_match_item;
295         uint64_t rss_hf;
296         uint16_t i;
297
298         /* Supported action is RSS. */
299         for (action = actions; action->type !=
300                 RTE_FLOW_ACTION_TYPE_END; action++) {
301                 action_type = action->type;
302                 switch (action_type) {
303                 case RTE_FLOW_ACTION_TYPE_RSS:
304                         rss = action->conf;
305                         rss_hf = rss->types;
306
307                         /**
308                          * Check simultaneous use of SRC_ONLY and DST_ONLY
309                          * of the same level.
310                          */
311                         rss_hf = rte_eth_rss_hf_refine(rss_hf);
312
313                         /* Check if pattern is empty. */
314                         if (pattern_match_item->pattern_list !=
315                                 pattern_empty && rss->func ==
316                                 RTE_ETH_HASH_FUNCTION_SIMPLE_XOR)
317                                 return rte_flow_error_set(error, ENOTSUP,
318                                         RTE_FLOW_ERROR_TYPE_ACTION, action,
319                                         "Not supported flow");
320
321                         /* Check if rss types match pattern. */
322                         if (rss->func != RTE_ETH_HASH_FUNCTION_SIMPLE_XOR) {
323                                 if (((rss_hf & ETH_RSS_IPV4) != m->eth_rss_hint) &&
324                                 ((rss_hf & ETH_RSS_NONFRAG_IPV4_UDP) != m->eth_rss_hint) &&
325                                 ((rss_hf & ETH_RSS_NONFRAG_IPV4_TCP) != m->eth_rss_hint) &&
326                                 ((rss_hf & ETH_RSS_NONFRAG_IPV4_SCTP) != m->eth_rss_hint) &&
327                                 ((rss_hf & ETH_RSS_IPV6) != m->eth_rss_hint) &&
328                                 ((rss_hf & ETH_RSS_NONFRAG_IPV6_UDP) != m->eth_rss_hint) &&
329                                 ((rss_hf & ETH_RSS_NONFRAG_IPV6_TCP) != m->eth_rss_hint) &&
330                                 ((rss_hf & ETH_RSS_NONFRAG_IPV6_SCTP) != m->eth_rss_hint))
331                                         return rte_flow_error_set(error,
332                                         ENOTSUP, RTE_FLOW_ERROR_TYPE_ACTION,
333                                         action, "Not supported RSS types");
334                         }
335
336                         if (rss->level)
337                                 return rte_flow_error_set(error, ENOTSUP,
338                                         RTE_FLOW_ERROR_TYPE_ACTION, action,
339                                         "a nonzero RSS encapsulation level is not supported");
340
341                         if (rss->key_len)
342                                 return rte_flow_error_set(error, ENOTSUP,
343                                         RTE_FLOW_ERROR_TYPE_ACTION, action,
344                                         "a nonzero RSS key_len is not supported");
345
346                         if (rss->queue)
347                                 return rte_flow_error_set(error, ENOTSUP,
348                                         RTE_FLOW_ERROR_TYPE_ACTION, action,
349                                         "a non-NULL RSS queue is not supported");
350
351                         /* Check hash function and save it to rss_meta. */
352                         if (rss->func ==
353                                 RTE_ETH_HASH_FUNCTION_SIMPLE_XOR)
354                                 ((struct rss_meta *)*meta)->hash_function =
355                                 RTE_ETH_HASH_FUNCTION_SIMPLE_XOR;
356
357                         if (rss->func ==
358                                 RTE_ETH_HASH_FUNCTION_SYMMETRIC_TOEPLITZ)
359                                 ((struct rss_meta *)*meta)->hash_function =
360                                 RTE_ETH_HASH_FUNCTION_SYMMETRIC_TOEPLITZ;
361
362                         type_match_item = rte_zmalloc("ice_type_match_item",
363                                         sizeof(struct ice_hash_match_type), 0);
364                         if (!type_match_item) {
365                                 rte_flow_error_set(error, EINVAL,
366                                         RTE_FLOW_ERROR_TYPE_HANDLE, NULL,
367                                         "No memory for type_match_item");
368                                 return -ENOMEM;
369                         }
370
371                         /* Find matched hash fields according to hash type. */
372                         for (i = 0; i < type_list_len; i++) {
373                                 if (rss_hf ==
374                                         ice_hash_type_list[i].hash_type) {
375                                         type_match_item->hash_type =
376                                                 ice_hash_type_list[i].hash_type;
377                                         type_match_item->hash_flds =
378                                                 ice_hash_type_list[i].hash_flds;
379                                 }
380                         }
381
382                         /* Save hash fileds to rss_meta. */
383                         ((struct rss_meta *)*meta)->hash_flds =
384                                         type_match_item->hash_flds;
385
386                         rte_free(type_match_item);
387                         break;
388
389                 case RTE_FLOW_ACTION_TYPE_END:
390                         break;
391
392                 default:
393                         rte_flow_error_set(error, EINVAL,
394                                         RTE_FLOW_ERROR_TYPE_ACTION, action,
395                                         "Invalid action.");
396                         return -rte_errno;
397                 }
398         }
399
400         return 0;
401 }
402
403 static int
404 ice_hash_parse_pattern_action(__rte_unused struct ice_adapter *ad,
405                         struct ice_pattern_match_item *array,
406                         uint32_t array_len,
407                         const struct rte_flow_item pattern[],
408                         const struct rte_flow_action actions[],
409                         void **meta,
410                         struct rte_flow_error *error)
411 {
412         int ret = 0;
413         struct ice_pattern_match_item *pattern_match_item;
414         struct rss_meta *rss_meta_ptr;
415
416         rss_meta_ptr = rte_zmalloc(NULL, sizeof(*rss_meta_ptr), 0);
417         if (!rss_meta_ptr) {
418                 rte_flow_error_set(error, EINVAL,
419                                 RTE_FLOW_ERROR_TYPE_HANDLE, NULL,
420                                 "No memory for rss_meta_ptr");
421                 return -ENOMEM;
422         }
423
424         /* Check rss supported pattern and find matched pattern. */
425         pattern_match_item = ice_search_pattern_match_item(pattern,
426                                         array, array_len, error);
427         if (!pattern_match_item) {
428                 ret = -rte_errno;
429                 goto error;
430         }
431
432         ret = ice_hash_check_inset(pattern, error);
433         if (ret)
434                 goto error;
435
436         /* Save protocol header to rss_meta. */
437         *meta = rss_meta_ptr;
438         ((struct rss_meta *)*meta)->pkt_hdr = ((struct rss_type_match_hdr *)
439                 (pattern_match_item->meta))->hdr_mask;
440
441         /* Check rss action. */
442         ret = ice_hash_parse_action(pattern_match_item, actions, meta, error);
443 error:
444         if (ret)
445                 rte_free(rss_meta_ptr);
446         rte_free(pattern_match_item);
447
448         return ret;
449 }
450
451 static int
452 ice_hash_create(struct ice_adapter *ad,
453                 struct rte_flow *flow,
454                 void *meta,
455                 struct rte_flow_error *error)
456 {
457         struct ice_pf *pf = &ad->pf;
458         struct ice_hw *hw = ICE_PF_TO_HW(pf);
459         struct ice_vsi *vsi = pf->main_vsi;
460         int ret;
461         uint32_t reg;
462         struct ice_hash_flow_cfg *filter_ptr;
463
464         uint32_t headermask = ((struct rss_meta *)meta)->pkt_hdr;
465         uint64_t hash_field = ((struct rss_meta *)meta)->hash_flds;
466         uint8_t hash_function = ((struct rss_meta *)meta)->hash_function;
467
468         filter_ptr = rte_zmalloc("ice_rss_filter",
469                                 sizeof(struct ice_hash_flow_cfg), 0);
470         if (!filter_ptr) {
471                 rte_flow_error_set(error, EINVAL,
472                                 RTE_FLOW_ERROR_TYPE_HANDLE, NULL,
473                                 "No memory for filter_ptr");
474                 return -ENOMEM;
475         }
476
477         if (hash_function == RTE_ETH_HASH_FUNCTION_SIMPLE_XOR) {
478                 /* Enable registers for simple_xor hash function. */
479                 reg = ICE_READ_REG(hw, VSIQF_HASH_CTL(vsi->vsi_id));
480                 reg = (reg & (~VSIQF_HASH_CTL_HASH_SCHEME_M)) |
481                         (2 << VSIQF_HASH_CTL_HASH_SCHEME_S);
482                 ICE_WRITE_REG(hw, VSIQF_HASH_CTL(vsi->vsi_id), reg);
483
484                 filter_ptr->simple_xor = 1;
485
486                 goto out;
487         } else {
488                 filter_ptr->rss_cfg.packet_hdr = headermask;
489                 filter_ptr->rss_cfg.hashed_flds = hash_field;
490                 filter_ptr->rss_cfg.symm =
491                         (hash_function ==
492                                 RTE_ETH_HASH_FUNCTION_SYMMETRIC_TOEPLITZ);
493
494                 ret = ice_add_rss_cfg(hw, vsi->idx,
495                                 filter_ptr->rss_cfg.hashed_flds,
496                                 filter_ptr->rss_cfg.packet_hdr,
497                                 filter_ptr->rss_cfg.symm);
498                 if (ret) {
499                         rte_flow_error_set(error, EINVAL,
500                                         RTE_FLOW_ERROR_TYPE_HANDLE, NULL,
501                                         "rss flow create fail");
502                         goto error;
503                 }
504         }
505
506 out:
507         flow->rule = filter_ptr;
508         rte_free(meta);
509         return 0;
510
511 error:
512         rte_free(filter_ptr);
513         rte_free(meta);
514         return -rte_errno;
515 }
516
517 static int
518 ice_hash_destroy(struct ice_adapter *ad,
519                 struct rte_flow *flow,
520                 struct rte_flow_error *error)
521 {
522         struct ice_pf *pf = ICE_DEV_PRIVATE_TO_PF(ad);
523         struct ice_hw *hw = ICE_PF_TO_HW(pf);
524         struct ice_vsi *vsi = pf->main_vsi;
525         int ret;
526         uint32_t reg;
527         struct ice_hash_flow_cfg *filter_ptr;
528
529         filter_ptr = (struct ice_hash_flow_cfg *)flow->rule;
530
531         if (filter_ptr->simple_xor == 1) {
532                 /* Return to symmetric_toeplitz state. */
533                 reg = ICE_READ_REG(hw, VSIQF_HASH_CTL(vsi->vsi_id));
534                 reg = (reg & (~VSIQF_HASH_CTL_HASH_SCHEME_M)) |
535                         (1 << VSIQF_HASH_CTL_HASH_SCHEME_S);
536                 ICE_WRITE_REG(hw, VSIQF_HASH_CTL(vsi->vsi_id), reg);
537         } else {
538                 ret = ice_rem_rss_cfg(hw, vsi->idx,
539                                 filter_ptr->rss_cfg.hashed_flds,
540                                 filter_ptr->rss_cfg.packet_hdr);
541                 /* Fixme: Ignore the error if a rule does not exist.
542                  * Currently a rule for inputset change or symm turn on/off
543                  * will overwrite an exist rule, while application still
544                  * have 2 rte_flow handles.
545                  **/
546                 if (ret && ret != ICE_ERR_DOES_NOT_EXIST) {
547                         rte_flow_error_set(error, EINVAL,
548                                         RTE_FLOW_ERROR_TYPE_HANDLE, NULL,
549                                         "rss flow destroy fail");
550                         goto error;
551                 }
552         }
553
554         rte_free(filter_ptr);
555         return 0;
556
557 error:
558         rte_free(filter_ptr);
559         return -rte_errno;
560 }
561
562 static void
563 ice_hash_uninit(struct ice_adapter *ad)
564 {
565         if (ad->active_pkg_type == ICE_PKG_TYPE_OS_DEFAULT)
566                 ice_unregister_parser(&ice_hash_parser_os, ad);
567         else if (ad->active_pkg_type == ICE_PKG_TYPE_COMMS)
568                 ice_unregister_parser(&ice_hash_parser_comms, ad);
569 }
570
571 static void
572 ice_hash_free(struct rte_flow *flow)
573 {
574         rte_free(flow->rule);
575 }