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_TCP_SRC_PORT \
99 (IAVF_PROT_TCP_OUTER | IAVF_SPORT)
100 #define IAVF_INSET_TCP_DST_PORT \
101 (IAVF_PROT_TCP_OUTER | IAVF_DPORT)
102 #define IAVF_INSET_UDP_SRC_PORT \
103 (IAVF_PROT_UDP_OUTER | IAVF_SPORT)
104 #define IAVF_INSET_UDP_DST_PORT \
105 (IAVF_PROT_UDP_OUTER | IAVF_DPORT)
106 #define IAVF_INSET_SCTP_SRC_PORT \
107 (IAVF_PROT_SCTP_OUTER | IAVF_SPORT)
108 #define IAVF_INSET_SCTP_DST_PORT \
109 (IAVF_PROT_SCTP_OUTER | IAVF_DPORT)
110 #define IAVF_INSET_ICMP4_SRC_PORT \
111 (IAVF_PROT_ICMP4_OUTER | IAVF_SPORT)
112 #define IAVF_INSET_ICMP4_DST_PORT \
113 (IAVF_PROT_ICMP4_OUTER | IAVF_DPORT)
114 #define IAVF_INSET_ICMP6_SRC_PORT \
115 (IAVF_PROT_ICMP6_OUTER | IAVF_SPORT)
116 #define IAVF_INSET_ICMP6_DST_PORT \
117 (IAVF_PROT_ICMP6_OUTER | IAVF_DPORT)
118 #define IAVF_INSET_ICMP4_TYPE \
119 (IAVF_PROT_ICMP4_OUTER | IAVF_ICMP_TYPE)
120 #define IAVF_INSET_ICMP4_CODE \
121 (IAVF_PROT_ICMP4_OUTER | IAVF_ICMP_CODE)
122 #define IAVF_INSET_ICMP6_TYPE \
123 (IAVF_PROT_ICMP6_OUTER | IAVF_ICMP_TYPE)
124 #define IAVF_INSET_ICMP6_CODE \
125 (IAVF_PROT_ICMP6_OUTER | IAVF_ICMP_CODE)
126 #define IAVF_INSET_GTPU_TEID \
127 (IAVF_PROT_GTPU | IAVF_GTPU_TEID)
128 #define IAVF_INSET_GTPU_QFI \
129 (IAVF_PROT_GTPU | IAVF_GTPU_QFI)
130 #define IAVF_INSET_ESP_SPI \
131 (IAVF_PROT_ESP | IAVF_ESP_SPI)
132 #define IAVF_INSET_AH_SPI \
133 (IAVF_PROT_AH | IAVF_AH_SPI)
134 #define IAVF_INSET_L2TPV3OIP_SESSION_ID \
135 (IAVF_PROT_L2TPV3OIP | IAVF_L2TPV3OIP_SESSION_ID)
136 #define IAVF_INSET_PFCP_S_FIELD \
137 (IAVF_PROT_PFCP | IAVF_PFCP_S_FIELD)
138 #define IAVF_INSET_PFCP_SEID \
139 (IAVF_PROT_PFCP | IAVF_PFCP_S_FIELD | IAVF_PFCP_SEID)
140 #define IAVF_INSET_ECPRI \
141 (IAVF_PROT_ECPRI | IAVF_ECPRI_PC_RTC_ID)
144 extern enum rte_flow_item_type iavf_pattern_empty[];
147 extern enum rte_flow_item_type iavf_pattern_ethertype[];
148 extern enum rte_flow_item_type iavf_pattern_ethertype_vlan[];
149 extern enum rte_flow_item_type iavf_pattern_ethertype_qinq[];
152 extern enum rte_flow_item_type iavf_pattern_eth_arp[];
154 /* non-tunnel IPv4 */
155 extern enum rte_flow_item_type iavf_pattern_eth_ipv4[];
156 extern enum rte_flow_item_type iavf_pattern_eth_vlan_ipv4[];
157 extern enum rte_flow_item_type iavf_pattern_eth_qinq_ipv4[];
158 extern enum rte_flow_item_type iavf_pattern_eth_ipv4_udp[];
159 extern enum rte_flow_item_type iavf_pattern_eth_vlan_ipv4_udp[];
160 extern enum rte_flow_item_type iavf_pattern_eth_qinq_ipv4_udp[];
161 extern enum rte_flow_item_type iavf_pattern_eth_ipv4_tcp[];
162 extern enum rte_flow_item_type iavf_pattern_eth_vlan_ipv4_tcp[];
163 extern enum rte_flow_item_type iavf_pattern_eth_qinq_ipv4_tcp[];
164 extern enum rte_flow_item_type iavf_pattern_eth_ipv4_sctp[];
165 extern enum rte_flow_item_type iavf_pattern_eth_vlan_ipv4_sctp[];
166 extern enum rte_flow_item_type iavf_pattern_eth_qinq_ipv4_sctp[];
167 extern enum rte_flow_item_type iavf_pattern_eth_ipv4_icmp[];
168 extern enum rte_flow_item_type iavf_pattern_eth_vlan_ipv4_icmp[];
169 extern enum rte_flow_item_type iavf_pattern_eth_qinq_ipv4_icmp[];
171 /* non-tunnel IPv6 */
172 extern enum rte_flow_item_type iavf_pattern_eth_ipv6[];
173 extern enum rte_flow_item_type iavf_pattern_eth_vlan_ipv6[];
174 extern enum rte_flow_item_type iavf_pattern_eth_qinq_ipv6[];
175 extern enum rte_flow_item_type iavf_pattern_eth_ipv6_udp[];
176 extern enum rte_flow_item_type iavf_pattern_eth_vlan_ipv6_udp[];
177 extern enum rte_flow_item_type iavf_pattern_eth_qinq_ipv6_udp[];
178 extern enum rte_flow_item_type iavf_pattern_eth_ipv6_tcp[];
179 extern enum rte_flow_item_type iavf_pattern_eth_vlan_ipv6_tcp[];
180 extern enum rte_flow_item_type iavf_pattern_eth_qinq_ipv6_tcp[];
181 extern enum rte_flow_item_type iavf_pattern_eth_ipv6_sctp[];
182 extern enum rte_flow_item_type iavf_pattern_eth_vlan_ipv6_sctp[];
183 extern enum rte_flow_item_type iavf_pattern_eth_qinq_ipv6_sctp[];
184 extern enum rte_flow_item_type iavf_pattern_eth_ipv6_icmp6[];
185 extern enum rte_flow_item_type iavf_pattern_eth_vlan_ipv6_icmp6[];
186 extern enum rte_flow_item_type iavf_pattern_eth_qinq_ipv6_icmp6[];
189 extern enum rte_flow_item_type iavf_pattern_eth_ipv4_gtpc[];
192 extern enum rte_flow_item_type iavf_pattern_eth_ipv4_gtpu[];
193 extern enum rte_flow_item_type iavf_pattern_eth_ipv4_gtpu_eh[];
196 extern enum rte_flow_item_type iavf_pattern_eth_ipv6_gtpc[];
199 extern enum rte_flow_item_type iavf_pattern_eth_ipv6_gtpu[];
200 extern enum rte_flow_item_type iavf_pattern_eth_ipv6_gtpu_eh[];
203 extern enum rte_flow_item_type iavf_pattern_eth_ipv4_gtpu_ipv4[];
204 extern enum rte_flow_item_type iavf_pattern_eth_ipv4_gtpu_ipv4_udp[];
205 extern enum rte_flow_item_type iavf_pattern_eth_ipv4_gtpu_ipv4_tcp[];
206 extern enum rte_flow_item_type iavf_pattern_eth_ipv4_gtpu_ipv4_icmp[];
209 extern enum rte_flow_item_type iavf_pattern_eth_ipv4_gtpu_ipv6[];
210 extern enum rte_flow_item_type iavf_pattern_eth_ipv4_gtpu_ipv6_udp[];
211 extern enum rte_flow_item_type iavf_pattern_eth_ipv4_gtpu_ipv6_tcp[];
212 extern enum rte_flow_item_type iavf_pattern_eth_ipv4_gtpu_ipv6_icmp[];
215 extern enum rte_flow_item_type iavf_pattern_eth_ipv6_gtpu_ipv4[];
216 extern enum rte_flow_item_type iavf_pattern_eth_ipv6_gtpu_ipv4_udp[];
217 extern enum rte_flow_item_type iavf_pattern_eth_ipv6_gtpu_ipv4_tcp[];
218 extern enum rte_flow_item_type iavf_pattern_eth_ipv6_gtpu_ipv4_icmp[];
221 extern enum rte_flow_item_type iavf_pattern_eth_ipv6_gtpu_ipv6[];
222 extern enum rte_flow_item_type iavf_pattern_eth_ipv6_gtpu_ipv6_udp[];
223 extern enum rte_flow_item_type iavf_pattern_eth_ipv6_gtpu_ipv6_tcp[];
224 extern enum rte_flow_item_type iavf_pattern_eth_ipv6_gtpu_ipv6_icmp[];
226 /* IPv4 GTPU EH IPv4 */
227 extern enum rte_flow_item_type iavf_pattern_eth_ipv4_gtpu_eh_ipv4[];
228 extern enum rte_flow_item_type iavf_pattern_eth_ipv4_gtpu_eh_ipv4_udp[];
229 extern enum rte_flow_item_type iavf_pattern_eth_ipv4_gtpu_eh_ipv4_tcp[];
230 extern enum rte_flow_item_type iavf_pattern_eth_ipv4_gtpu_eh_ipv4_icmp[];
232 /* IPv4 GTPU EH IPv6 */
233 extern enum rte_flow_item_type iavf_pattern_eth_ipv4_gtpu_eh_ipv6[];
234 extern enum rte_flow_item_type iavf_pattern_eth_ipv4_gtpu_eh_ipv6_udp[];
235 extern enum rte_flow_item_type iavf_pattern_eth_ipv4_gtpu_eh_ipv6_tcp[];
236 extern enum rte_flow_item_type iavf_pattern_eth_ipv4_gtpu_eh_ipv6_icmp[];
238 /* IPv6 GTPU EH IPv4 */
239 extern enum rte_flow_item_type iavf_pattern_eth_ipv6_gtpu_eh_ipv4[];
240 extern enum rte_flow_item_type iavf_pattern_eth_ipv6_gtpu_eh_ipv4_udp[];
241 extern enum rte_flow_item_type iavf_pattern_eth_ipv6_gtpu_eh_ipv4_tcp[];
242 extern enum rte_flow_item_type iavf_pattern_eth_ipv6_gtpu_eh_ipv4_icmp[];
244 /* IPv6 GTPU EH IPv6 */
245 extern enum rte_flow_item_type iavf_pattern_eth_ipv6_gtpu_eh_ipv6[];
246 extern enum rte_flow_item_type iavf_pattern_eth_ipv6_gtpu_eh_ipv6_udp[];
247 extern enum rte_flow_item_type iavf_pattern_eth_ipv6_gtpu_eh_ipv6_tcp[];
248 extern enum rte_flow_item_type iavf_pattern_eth_ipv6_gtpu_eh_ipv6_icmp[];
251 extern enum rte_flow_item_type iavf_pattern_eth_ipv4_esp[];
252 extern enum rte_flow_item_type iavf_pattern_eth_ipv4_udp_esp[];
253 extern enum rte_flow_item_type iavf_pattern_eth_ipv6_esp[];
254 extern enum rte_flow_item_type iavf_pattern_eth_ipv6_udp_esp[];
257 extern enum rte_flow_item_type iavf_pattern_eth_ipv4_ah[];
258 extern enum rte_flow_item_type iavf_pattern_eth_ipv6_ah[];
261 extern enum rte_flow_item_type iavf_pattern_eth_ipv4_l2tpv3[];
262 extern enum rte_flow_item_type iavf_pattern_eth_ipv6_l2tpv3[];
265 extern enum rte_flow_item_type iavf_pattern_eth_ipv4_pfcp[];
266 extern enum rte_flow_item_type iavf_pattern_eth_ipv6_pfcp[];
269 extern enum rte_flow_item_type iavf_pattern_eth_ecpri[];
270 extern enum rte_flow_item_type iavf_pattern_eth_ipv4_ecpri[];
272 extern const struct rte_flow_ops iavf_flow_ops;
274 /* pattern structure */
275 struct iavf_pattern_match_item {
276 enum rte_flow_item_type *pattern_list;
277 /* pattern_list must end with RTE_FLOW_ITEM_TYPE_END */
278 uint64_t input_set_mask;
282 typedef int (*engine_init_t)(struct iavf_adapter *ad);
283 typedef void (*engine_uninit_t)(struct iavf_adapter *ad);
284 typedef int (*engine_validation_t)(struct iavf_adapter *ad,
285 struct rte_flow *flow,
287 struct rte_flow_error *error);
288 typedef int (*engine_create_t)(struct iavf_adapter *ad,
289 struct rte_flow *flow,
291 struct rte_flow_error *error);
292 typedef int (*engine_destroy_t)(struct iavf_adapter *ad,
293 struct rte_flow *flow,
294 struct rte_flow_error *error);
295 typedef int (*engine_query_t)(struct iavf_adapter *ad,
296 struct rte_flow *flow,
297 struct rte_flow_query_count *count,
298 struct rte_flow_error *error);
299 typedef void (*engine_free_t) (struct rte_flow *flow);
300 typedef int (*parse_pattern_action_t)(struct iavf_adapter *ad,
301 struct iavf_pattern_match_item *array,
303 const struct rte_flow_item pattern[],
304 const struct rte_flow_action actions[],
306 struct rte_flow_error *error);
309 enum iavf_flow_engine_type {
310 IAVF_FLOW_ENGINE_NONE = 0,
311 IAVF_FLOW_ENGINE_FDIR,
312 IAVF_FLOW_ENGINE_HASH,
313 IAVF_FLOW_ENGINE_MAX,
317 * classification stages.
318 * for non-pipeline mode, we have two classification stages: Distributor/RSS
319 * for pipeline-mode we have three classification stages:
320 * Permission/Distributor/RSS
322 enum iavf_flow_classification_stage {
323 IAVF_FLOW_STAGE_NONE = 0,
325 IAVF_FLOW_STAGE_DISTRIBUTOR,
329 /* Struct to store engine created. */
330 struct iavf_flow_engine {
331 TAILQ_ENTRY(iavf_flow_engine) node;
333 engine_uninit_t uninit;
334 engine_validation_t validation;
335 engine_create_t create;
336 engine_destroy_t destroy;
337 engine_query_t query_count;
339 enum iavf_flow_engine_type type;
342 TAILQ_HEAD(iavf_engine_list, iavf_flow_engine);
344 /* Struct to store flow created. */
346 TAILQ_ENTRY(rte_flow) node;
347 struct iavf_flow_engine *engine;
351 struct iavf_flow_parser {
352 struct iavf_flow_engine *engine;
353 struct iavf_pattern_match_item *array;
355 parse_pattern_action_t parse_pattern_action;
356 enum iavf_flow_classification_stage stage;
359 /* Struct to store parser created. */
360 struct iavf_flow_parser_node {
361 TAILQ_ENTRY(iavf_flow_parser_node) node;
362 struct iavf_flow_parser *parser;
365 void iavf_register_flow_engine(struct iavf_flow_engine *engine);
366 int iavf_flow_init(struct iavf_adapter *ad);
367 void iavf_flow_uninit(struct iavf_adapter *ad);
368 int iavf_flow_flush(struct rte_eth_dev *dev,
369 struct rte_flow_error *error);
370 int iavf_register_parser(struct iavf_flow_parser *parser,
371 struct iavf_adapter *ad);
372 void iavf_unregister_parser(struct iavf_flow_parser *parser,
373 struct iavf_adapter *ad);
374 struct iavf_pattern_match_item *
375 iavf_search_pattern_match_item(const struct rte_flow_item pattern[],
376 struct iavf_pattern_match_item *array,
378 struct rte_flow_error *error);