1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright(c) 2019 Intel Corporation
5 #ifndef _IAVF_GENERIC_FLOW_H_
6 #define _IAVF_GENERIC_FLOW_H_
8 #include <rte_flow_driver.h>
12 #define IAVF_PROT_MAC_INNER (1ULL << 1)
13 #define IAVF_PROT_MAC_OUTER (1ULL << 2)
14 #define IAVF_PROT_VLAN_INNER (1ULL << 3)
15 #define IAVF_PROT_VLAN_OUTER (1ULL << 4)
16 #define IAVF_PROT_IPV4_INNER (1ULL << 5)
17 #define IAVF_PROT_IPV4_OUTER (1ULL << 6)
18 #define IAVF_PROT_IPV6_INNER (1ULL << 7)
19 #define IAVF_PROT_IPV6_OUTER (1ULL << 8)
20 #define IAVF_PROT_TCP_INNER (1ULL << 9)
21 #define IAVF_PROT_TCP_OUTER (1ULL << 10)
22 #define IAVF_PROT_UDP_INNER (1ULL << 11)
23 #define IAVF_PROT_UDP_OUTER (1ULL << 12)
24 #define IAVF_PROT_SCTP_INNER (1ULL << 13)
25 #define IAVF_PROT_SCTP_OUTER (1ULL << 14)
26 #define IAVF_PROT_ICMP4_INNER (1ULL << 15)
27 #define IAVF_PROT_ICMP4_OUTER (1ULL << 16)
28 #define IAVF_PROT_ICMP6_INNER (1ULL << 17)
29 #define IAVF_PROT_ICMP6_OUTER (1ULL << 18)
30 #define IAVF_PROT_VXLAN (1ULL << 19)
31 #define IAVF_PROT_NVGRE (1ULL << 20)
32 #define IAVF_PROT_GTPU (1ULL << 21)
33 #define IAVF_PROT_ESP (1ULL << 22)
34 #define IAVF_PROT_AH (1ULL << 23)
35 #define IAVF_PROT_L2TPV3OIP (1ULL << 24)
36 #define IAVF_PROT_PFCP (1ULL << 25)
37 #define IAVF_PROT_ECPRI (1ULL << 26)
42 #define IAVF_SMAC (1ULL << 63)
43 #define IAVF_DMAC (1ULL << 62)
44 #define IAVF_ETHERTYPE (1ULL << 61)
45 #define IAVF_IP_SRC (1ULL << 60)
46 #define IAVF_IP_DST (1ULL << 59)
47 #define IAVF_IP_PROTO (1ULL << 58)
48 #define IAVF_IP_TTL (1ULL << 57)
49 #define IAVF_IP_TOS (1ULL << 56)
50 #define IAVF_SPORT (1ULL << 55)
51 #define IAVF_DPORT (1ULL << 54)
52 #define IAVF_ICMP_TYPE (1ULL << 53)
53 #define IAVF_ICMP_CODE (1ULL << 52)
54 #define IAVF_VXLAN_VNI (1ULL << 51)
55 #define IAVF_NVGRE_TNI (1ULL << 50)
56 #define IAVF_GTPU_TEID (1ULL << 49)
57 #define IAVF_GTPU_QFI (1ULL << 48)
58 #define IAVF_ESP_SPI (1ULL << 47)
59 #define IAVF_AH_SPI (1ULL << 46)
60 #define IAVF_L2TPV3OIP_SESSION_ID (1ULL << 45)
61 #define IAVF_PFCP_S_FIELD (1ULL << 44)
62 #define IAVF_PFCP_SEID (1ULL << 43)
63 #define IAVF_ECPRI_PC_RTC_ID (1ULL << 42)
67 #define IAVF_INSET_NONE 0ULL
71 #define IAVF_INSET_SMAC (IAVF_PROT_MAC_OUTER | IAVF_SMAC)
72 #define IAVF_INSET_DMAC (IAVF_PROT_MAC_OUTER | IAVF_DMAC)
73 #define IAVF_INSET_VLAN_INNER (IAVF_PROT_VLAN_INNER)
74 #define IAVF_INSET_VLAN_OUTER (IAVF_PROT_VLAN_OUTER)
75 #define IAVF_INSET_ETHERTYPE (IAVF_ETHERTYPE)
77 #define IAVF_INSET_IPV4_SRC \
78 (IAVF_PROT_IPV4_OUTER | IAVF_IP_SRC)
79 #define IAVF_INSET_IPV4_DST \
80 (IAVF_PROT_IPV4_OUTER | IAVF_IP_DST)
81 #define IAVF_INSET_IPV4_TOS \
82 (IAVF_PROT_IPV4_OUTER | IAVF_IP_TOS)
83 #define IAVF_INSET_IPV4_PROTO \
84 (IAVF_PROT_IPV4_OUTER | IAVF_IP_PROTO)
85 #define IAVF_INSET_IPV4_TTL \
86 (IAVF_PROT_IPV4_OUTER | IAVF_IP_TTL)
87 #define IAVF_INSET_IPV6_SRC \
88 (IAVF_PROT_IPV6_OUTER | IAVF_IP_SRC)
89 #define IAVF_INSET_IPV6_DST \
90 (IAVF_PROT_IPV6_OUTER | IAVF_IP_DST)
91 #define IAVF_INSET_IPV6_NEXT_HDR \
92 (IAVF_PROT_IPV6_OUTER | IAVF_IP_PROTO)
93 #define IAVF_INSET_IPV6_HOP_LIMIT \
94 (IAVF_PROT_IPV6_OUTER | IAVF_IP_TTL)
95 #define IAVF_INSET_IPV6_TC \
96 (IAVF_PROT_IPV6_OUTER | IAVF_IP_TOS)
98 #define IAVF_INSET_TUN_IPV4_SRC \
99 (IAVF_PROT_IPV4_INNER | IAVF_IP_SRC)
100 #define IAVF_INSET_TUN_IPV4_DST \
101 (IAVF_PROT_IPV4_INNER | IAVF_IP_DST)
102 #define IAVF_INSET_TUN_IPV4_TOS \
103 (IAVF_PROT_IPV4_INNER | IAVF_IP_TOS)
104 #define IAVF_INSET_TUN_IPV4_PROTO \
105 (IAVF_PROT_IPV4_INNER | IAVF_IP_PROTO)
106 #define IAVF_INSET_TUN_IPV4_TTL \
107 (IAVF_PROT_IPV4_INNER | IAVF_IP_TTL)
108 #define IAVF_INSET_TUN_IPV6_SRC \
109 (IAVF_PROT_IPV6_INNER | IAVF_IP_SRC)
110 #define IAVF_INSET_TUN_IPV6_DST \
111 (IAVF_PROT_IPV6_INNER | IAVF_IP_DST)
112 #define IAVF_INSET_TUN_IPV6_NEXT_HDR \
113 (IAVF_PROT_IPV6_INNER | IAVF_IP_PROTO)
114 #define IAVF_INSET_TUN_IPV6_HOP_LIMIT \
115 (IAVF_PROT_IPV6_INNER | IAVF_IP_TTL)
116 #define IAVF_INSET_TUN_IPV6_TC \
117 (IAVF_PROT_IPV6_INNER | IAVF_IP_TOS)
119 #define IAVF_INSET_TCP_SRC_PORT \
120 (IAVF_PROT_TCP_OUTER | IAVF_SPORT)
121 #define IAVF_INSET_TCP_DST_PORT \
122 (IAVF_PROT_TCP_OUTER | IAVF_DPORT)
123 #define IAVF_INSET_UDP_SRC_PORT \
124 (IAVF_PROT_UDP_OUTER | IAVF_SPORT)
125 #define IAVF_INSET_UDP_DST_PORT \
126 (IAVF_PROT_UDP_OUTER | IAVF_DPORT)
128 #define IAVF_INSET_TUN_TCP_SRC_PORT \
129 (IAVF_PROT_TCP_INNER | IAVF_SPORT)
130 #define IAVF_INSET_TUN_TCP_DST_PORT \
131 (IAVF_PROT_TCP_INNER | IAVF_DPORT)
132 #define IAVF_INSET_TUN_UDP_SRC_PORT \
133 (IAVF_PROT_UDP_INNER | IAVF_SPORT)
134 #define IAVF_INSET_TUN_UDP_DST_PORT \
135 (IAVF_PROT_UDP_INNER | IAVF_DPORT)
137 #define IAVF_INSET_SCTP_SRC_PORT \
138 (IAVF_PROT_SCTP_OUTER | IAVF_SPORT)
139 #define IAVF_INSET_SCTP_DST_PORT \
140 (IAVF_PROT_SCTP_OUTER | IAVF_DPORT)
141 #define IAVF_INSET_ICMP4_SRC_PORT \
142 (IAVF_PROT_ICMP4_OUTER | IAVF_SPORT)
143 #define IAVF_INSET_ICMP4_DST_PORT \
144 (IAVF_PROT_ICMP4_OUTER | IAVF_DPORT)
145 #define IAVF_INSET_ICMP6_SRC_PORT \
146 (IAVF_PROT_ICMP6_OUTER | IAVF_SPORT)
147 #define IAVF_INSET_ICMP6_DST_PORT \
148 (IAVF_PROT_ICMP6_OUTER | IAVF_DPORT)
149 #define IAVF_INSET_ICMP4_TYPE \
150 (IAVF_PROT_ICMP4_OUTER | IAVF_ICMP_TYPE)
151 #define IAVF_INSET_ICMP4_CODE \
152 (IAVF_PROT_ICMP4_OUTER | IAVF_ICMP_CODE)
153 #define IAVF_INSET_ICMP6_TYPE \
154 (IAVF_PROT_ICMP6_OUTER | IAVF_ICMP_TYPE)
155 #define IAVF_INSET_ICMP6_CODE \
156 (IAVF_PROT_ICMP6_OUTER | IAVF_ICMP_CODE)
157 #define IAVF_INSET_GTPU_TEID \
158 (IAVF_PROT_GTPU | IAVF_GTPU_TEID)
159 #define IAVF_INSET_GTPU_QFI \
160 (IAVF_PROT_GTPU | IAVF_GTPU_QFI)
161 #define IAVF_INSET_ESP_SPI \
162 (IAVF_PROT_ESP | IAVF_ESP_SPI)
163 #define IAVF_INSET_AH_SPI \
164 (IAVF_PROT_AH | IAVF_AH_SPI)
165 #define IAVF_INSET_L2TPV3OIP_SESSION_ID \
166 (IAVF_PROT_L2TPV3OIP | IAVF_L2TPV3OIP_SESSION_ID)
167 #define IAVF_INSET_PFCP_S_FIELD \
168 (IAVF_PROT_PFCP | IAVF_PFCP_S_FIELD)
169 #define IAVF_INSET_PFCP_SEID \
170 (IAVF_PROT_PFCP | IAVF_PFCP_S_FIELD | IAVF_PFCP_SEID)
171 #define IAVF_INSET_ECPRI \
172 (IAVF_PROT_ECPRI | IAVF_ECPRI_PC_RTC_ID)
175 extern enum rte_flow_item_type iavf_pattern_empty[];
178 extern enum rte_flow_item_type iavf_pattern_ethertype[];
179 extern enum rte_flow_item_type iavf_pattern_ethertype_vlan[];
180 extern enum rte_flow_item_type iavf_pattern_ethertype_qinq[];
183 extern enum rte_flow_item_type iavf_pattern_eth_arp[];
185 /* non-tunnel IPv4 */
186 extern enum rte_flow_item_type iavf_pattern_eth_ipv4[];
187 extern enum rte_flow_item_type iavf_pattern_eth_vlan_ipv4[];
188 extern enum rte_flow_item_type iavf_pattern_eth_qinq_ipv4[];
189 extern enum rte_flow_item_type iavf_pattern_eth_ipv4_udp[];
190 extern enum rte_flow_item_type iavf_pattern_eth_vlan_ipv4_udp[];
191 extern enum rte_flow_item_type iavf_pattern_eth_qinq_ipv4_udp[];
192 extern enum rte_flow_item_type iavf_pattern_eth_ipv4_tcp[];
193 extern enum rte_flow_item_type iavf_pattern_eth_vlan_ipv4_tcp[];
194 extern enum rte_flow_item_type iavf_pattern_eth_qinq_ipv4_tcp[];
195 extern enum rte_flow_item_type iavf_pattern_eth_ipv4_sctp[];
196 extern enum rte_flow_item_type iavf_pattern_eth_vlan_ipv4_sctp[];
197 extern enum rte_flow_item_type iavf_pattern_eth_qinq_ipv4_sctp[];
198 extern enum rte_flow_item_type iavf_pattern_eth_ipv4_icmp[];
199 extern enum rte_flow_item_type iavf_pattern_eth_vlan_ipv4_icmp[];
200 extern enum rte_flow_item_type iavf_pattern_eth_qinq_ipv4_icmp[];
202 /* non-tunnel IPv6 */
203 extern enum rte_flow_item_type iavf_pattern_eth_ipv6[];
204 extern enum rte_flow_item_type iavf_pattern_eth_vlan_ipv6[];
205 extern enum rte_flow_item_type iavf_pattern_eth_qinq_ipv6[];
206 extern enum rte_flow_item_type iavf_pattern_eth_ipv6_udp[];
207 extern enum rte_flow_item_type iavf_pattern_eth_vlan_ipv6_udp[];
208 extern enum rte_flow_item_type iavf_pattern_eth_qinq_ipv6_udp[];
209 extern enum rte_flow_item_type iavf_pattern_eth_ipv6_tcp[];
210 extern enum rte_flow_item_type iavf_pattern_eth_vlan_ipv6_tcp[];
211 extern enum rte_flow_item_type iavf_pattern_eth_qinq_ipv6_tcp[];
212 extern enum rte_flow_item_type iavf_pattern_eth_ipv6_sctp[];
213 extern enum rte_flow_item_type iavf_pattern_eth_vlan_ipv6_sctp[];
214 extern enum rte_flow_item_type iavf_pattern_eth_qinq_ipv6_sctp[];
215 extern enum rte_flow_item_type iavf_pattern_eth_ipv6_icmp6[];
216 extern enum rte_flow_item_type iavf_pattern_eth_vlan_ipv6_icmp6[];
217 extern enum rte_flow_item_type iavf_pattern_eth_qinq_ipv6_icmp6[];
220 extern enum rte_flow_item_type iavf_pattern_eth_ipv4_gtpc[];
223 extern enum rte_flow_item_type iavf_pattern_eth_ipv4_gtpu[];
224 extern enum rte_flow_item_type iavf_pattern_eth_ipv4_gtpu_eh[];
227 extern enum rte_flow_item_type iavf_pattern_eth_ipv6_gtpc[];
230 extern enum rte_flow_item_type iavf_pattern_eth_ipv6_gtpu[];
231 extern enum rte_flow_item_type iavf_pattern_eth_ipv6_gtpu_eh[];
234 extern enum rte_flow_item_type iavf_pattern_eth_ipv4_gtpu_ipv4[];
235 extern enum rte_flow_item_type iavf_pattern_eth_ipv4_gtpu_ipv4_udp[];
236 extern enum rte_flow_item_type iavf_pattern_eth_ipv4_gtpu_ipv4_tcp[];
237 extern enum rte_flow_item_type iavf_pattern_eth_ipv4_gtpu_ipv4_icmp[];
240 extern enum rte_flow_item_type iavf_pattern_eth_ipv4_gtpu_ipv6[];
241 extern enum rte_flow_item_type iavf_pattern_eth_ipv4_gtpu_ipv6_udp[];
242 extern enum rte_flow_item_type iavf_pattern_eth_ipv4_gtpu_ipv6_tcp[];
243 extern enum rte_flow_item_type iavf_pattern_eth_ipv4_gtpu_ipv6_icmp[];
246 extern enum rte_flow_item_type iavf_pattern_eth_ipv6_gtpu_ipv4[];
247 extern enum rte_flow_item_type iavf_pattern_eth_ipv6_gtpu_ipv4_udp[];
248 extern enum rte_flow_item_type iavf_pattern_eth_ipv6_gtpu_ipv4_tcp[];
249 extern enum rte_flow_item_type iavf_pattern_eth_ipv6_gtpu_ipv4_icmp[];
252 extern enum rte_flow_item_type iavf_pattern_eth_ipv6_gtpu_ipv6[];
253 extern enum rte_flow_item_type iavf_pattern_eth_ipv6_gtpu_ipv6_udp[];
254 extern enum rte_flow_item_type iavf_pattern_eth_ipv6_gtpu_ipv6_tcp[];
255 extern enum rte_flow_item_type iavf_pattern_eth_ipv6_gtpu_ipv6_icmp[];
257 /* IPv4 GTPU EH IPv4 */
258 extern enum rte_flow_item_type iavf_pattern_eth_ipv4_gtpu_eh_ipv4[];
259 extern enum rte_flow_item_type iavf_pattern_eth_ipv4_gtpu_eh_ipv4_udp[];
260 extern enum rte_flow_item_type iavf_pattern_eth_ipv4_gtpu_eh_ipv4_tcp[];
261 extern enum rte_flow_item_type iavf_pattern_eth_ipv4_gtpu_eh_ipv4_icmp[];
263 /* IPv4 GTPU EH IPv6 */
264 extern enum rte_flow_item_type iavf_pattern_eth_ipv4_gtpu_eh_ipv6[];
265 extern enum rte_flow_item_type iavf_pattern_eth_ipv4_gtpu_eh_ipv6_udp[];
266 extern enum rte_flow_item_type iavf_pattern_eth_ipv4_gtpu_eh_ipv6_tcp[];
267 extern enum rte_flow_item_type iavf_pattern_eth_ipv4_gtpu_eh_ipv6_icmp[];
269 /* IPv6 GTPU EH IPv4 */
270 extern enum rte_flow_item_type iavf_pattern_eth_ipv6_gtpu_eh_ipv4[];
271 extern enum rte_flow_item_type iavf_pattern_eth_ipv6_gtpu_eh_ipv4_udp[];
272 extern enum rte_flow_item_type iavf_pattern_eth_ipv6_gtpu_eh_ipv4_tcp[];
273 extern enum rte_flow_item_type iavf_pattern_eth_ipv6_gtpu_eh_ipv4_icmp[];
275 /* IPv6 GTPU EH IPv6 */
276 extern enum rte_flow_item_type iavf_pattern_eth_ipv6_gtpu_eh_ipv6[];
277 extern enum rte_flow_item_type iavf_pattern_eth_ipv6_gtpu_eh_ipv6_udp[];
278 extern enum rte_flow_item_type iavf_pattern_eth_ipv6_gtpu_eh_ipv6_tcp[];
279 extern enum rte_flow_item_type iavf_pattern_eth_ipv6_gtpu_eh_ipv6_icmp[];
282 extern enum rte_flow_item_type iavf_pattern_eth_ipv4_esp[];
283 extern enum rte_flow_item_type iavf_pattern_eth_ipv4_udp_esp[];
284 extern enum rte_flow_item_type iavf_pattern_eth_ipv6_esp[];
285 extern enum rte_flow_item_type iavf_pattern_eth_ipv6_udp_esp[];
288 extern enum rte_flow_item_type iavf_pattern_eth_ipv4_ah[];
289 extern enum rte_flow_item_type iavf_pattern_eth_ipv6_ah[];
292 extern enum rte_flow_item_type iavf_pattern_eth_ipv4_l2tpv3[];
293 extern enum rte_flow_item_type iavf_pattern_eth_ipv6_l2tpv3[];
296 extern enum rte_flow_item_type iavf_pattern_eth_ipv4_pfcp[];
297 extern enum rte_flow_item_type iavf_pattern_eth_ipv6_pfcp[];
300 extern enum rte_flow_item_type iavf_pattern_eth_ecpri[];
301 extern enum rte_flow_item_type iavf_pattern_eth_ipv4_ecpri[];
303 extern const struct rte_flow_ops iavf_flow_ops;
305 /* pattern structure */
306 struct iavf_pattern_match_item {
307 enum rte_flow_item_type *pattern_list;
308 /* pattern_list must end with RTE_FLOW_ITEM_TYPE_END */
309 uint64_t input_set_mask;
313 typedef int (*engine_init_t)(struct iavf_adapter *ad);
314 typedef void (*engine_uninit_t)(struct iavf_adapter *ad);
315 typedef int (*engine_validation_t)(struct iavf_adapter *ad,
316 struct rte_flow *flow,
318 struct rte_flow_error *error);
319 typedef int (*engine_create_t)(struct iavf_adapter *ad,
320 struct rte_flow *flow,
322 struct rte_flow_error *error);
323 typedef int (*engine_destroy_t)(struct iavf_adapter *ad,
324 struct rte_flow *flow,
325 struct rte_flow_error *error);
326 typedef int (*engine_query_t)(struct iavf_adapter *ad,
327 struct rte_flow *flow,
328 struct rte_flow_query_count *count,
329 struct rte_flow_error *error);
330 typedef void (*engine_free_t) (struct rte_flow *flow);
331 typedef int (*parse_pattern_action_t)(struct iavf_adapter *ad,
332 struct iavf_pattern_match_item *array,
334 const struct rte_flow_item pattern[],
335 const struct rte_flow_action actions[],
337 struct rte_flow_error *error);
340 enum iavf_flow_engine_type {
341 IAVF_FLOW_ENGINE_NONE = 0,
342 IAVF_FLOW_ENGINE_FDIR,
343 IAVF_FLOW_ENGINE_HASH,
344 IAVF_FLOW_ENGINE_MAX,
348 * classification stages.
349 * for non-pipeline mode, we have two classification stages: Distributor/RSS
350 * for pipeline-mode we have three classification stages:
351 * Permission/Distributor/RSS
353 enum iavf_flow_classification_stage {
354 IAVF_FLOW_STAGE_NONE = 0,
356 IAVF_FLOW_STAGE_DISTRIBUTOR,
360 /* Struct to store engine created. */
361 struct iavf_flow_engine {
362 TAILQ_ENTRY(iavf_flow_engine) node;
364 engine_uninit_t uninit;
365 engine_validation_t validation;
366 engine_create_t create;
367 engine_destroy_t destroy;
368 engine_query_t query_count;
370 enum iavf_flow_engine_type type;
373 TAILQ_HEAD(iavf_engine_list, iavf_flow_engine);
375 /* Struct to store flow created. */
377 TAILQ_ENTRY(rte_flow) node;
378 struct iavf_flow_engine *engine;
382 struct iavf_flow_parser {
383 struct iavf_flow_engine *engine;
384 struct iavf_pattern_match_item *array;
386 parse_pattern_action_t parse_pattern_action;
387 enum iavf_flow_classification_stage stage;
390 /* Struct to store parser created. */
391 struct iavf_flow_parser_node {
392 TAILQ_ENTRY(iavf_flow_parser_node) node;
393 struct iavf_flow_parser *parser;
396 void iavf_register_flow_engine(struct iavf_flow_engine *engine);
397 int iavf_flow_init(struct iavf_adapter *ad);
398 void iavf_flow_uninit(struct iavf_adapter *ad);
399 int iavf_flow_flush(struct rte_eth_dev *dev,
400 struct rte_flow_error *error);
401 int iavf_register_parser(struct iavf_flow_parser *parser,
402 struct iavf_adapter *ad);
403 void iavf_unregister_parser(struct iavf_flow_parser *parser,
404 struct iavf_adapter *ad);
405 struct iavf_pattern_match_item *
406 iavf_search_pattern_match_item(const struct rte_flow_item pattern[],
407 struct iavf_pattern_match_item *array,
409 struct rte_flow_error *error);