1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright 2016 6WIND S.A.
3 * Copyright 2016 Mellanox Technologies, Ltd
11 #include <rte_common.h>
12 #include <rte_errno.h>
13 #include <rte_branch_prediction.h>
14 #include <rte_string_fns.h>
16 #include <rte_mbuf_dyn.h>
17 #include "rte_ethdev.h"
18 #include "rte_flow_driver.h"
21 /* Mbuf dynamic field name for metadata. */
22 int rte_flow_dynf_metadata_offs = -1;
24 /* Mbuf dynamic field flag bit number for metadata. */
25 uint64_t rte_flow_dynf_metadata_mask;
28 * Flow elements description tables.
30 struct rte_flow_desc_data {
35 /** Generate flow_item[] entry. */
36 #define MK_FLOW_ITEM(t, s) \
37 [RTE_FLOW_ITEM_TYPE_ ## t] = { \
42 /** Information about known flow pattern items. */
43 static const struct rte_flow_desc_data rte_flow_desc_item[] = {
45 MK_FLOW_ITEM(VOID, 0),
46 MK_FLOW_ITEM(INVERT, 0),
47 MK_FLOW_ITEM(ANY, sizeof(struct rte_flow_item_any)),
49 MK_FLOW_ITEM(VF, sizeof(struct rte_flow_item_vf)),
50 MK_FLOW_ITEM(PHY_PORT, sizeof(struct rte_flow_item_phy_port)),
51 MK_FLOW_ITEM(PORT_ID, sizeof(struct rte_flow_item_port_id)),
52 MK_FLOW_ITEM(RAW, sizeof(struct rte_flow_item_raw)),
53 MK_FLOW_ITEM(ETH, sizeof(struct rte_flow_item_eth)),
54 MK_FLOW_ITEM(VLAN, sizeof(struct rte_flow_item_vlan)),
55 MK_FLOW_ITEM(IPV4, sizeof(struct rte_flow_item_ipv4)),
56 MK_FLOW_ITEM(IPV6, sizeof(struct rte_flow_item_ipv6)),
57 MK_FLOW_ITEM(ICMP, sizeof(struct rte_flow_item_icmp)),
58 MK_FLOW_ITEM(UDP, sizeof(struct rte_flow_item_udp)),
59 MK_FLOW_ITEM(TCP, sizeof(struct rte_flow_item_tcp)),
60 MK_FLOW_ITEM(SCTP, sizeof(struct rte_flow_item_sctp)),
61 MK_FLOW_ITEM(VXLAN, sizeof(struct rte_flow_item_vxlan)),
62 MK_FLOW_ITEM(E_TAG, sizeof(struct rte_flow_item_e_tag)),
63 MK_FLOW_ITEM(NVGRE, sizeof(struct rte_flow_item_nvgre)),
64 MK_FLOW_ITEM(MPLS, sizeof(struct rte_flow_item_mpls)),
65 MK_FLOW_ITEM(GRE, sizeof(struct rte_flow_item_gre)),
66 MK_FLOW_ITEM(FUZZY, sizeof(struct rte_flow_item_fuzzy)),
67 MK_FLOW_ITEM(GTP, sizeof(struct rte_flow_item_gtp)),
68 MK_FLOW_ITEM(GTPC, sizeof(struct rte_flow_item_gtp)),
69 MK_FLOW_ITEM(GTPU, sizeof(struct rte_flow_item_gtp)),
70 MK_FLOW_ITEM(ESP, sizeof(struct rte_flow_item_esp)),
71 MK_FLOW_ITEM(GENEVE, sizeof(struct rte_flow_item_geneve)),
72 MK_FLOW_ITEM(VXLAN_GPE, sizeof(struct rte_flow_item_vxlan_gpe)),
73 MK_FLOW_ITEM(ARP_ETH_IPV4, sizeof(struct rte_flow_item_arp_eth_ipv4)),
74 MK_FLOW_ITEM(IPV6_EXT, sizeof(struct rte_flow_item_ipv6_ext)),
75 MK_FLOW_ITEM(ICMP6, sizeof(struct rte_flow_item_icmp6)),
76 MK_FLOW_ITEM(ICMP6_ND_NS, sizeof(struct rte_flow_item_icmp6_nd_ns)),
77 MK_FLOW_ITEM(ICMP6_ND_NA, sizeof(struct rte_flow_item_icmp6_nd_na)),
78 MK_FLOW_ITEM(ICMP6_ND_OPT, sizeof(struct rte_flow_item_icmp6_nd_opt)),
79 MK_FLOW_ITEM(ICMP6_ND_OPT_SLA_ETH,
80 sizeof(struct rte_flow_item_icmp6_nd_opt_sla_eth)),
81 MK_FLOW_ITEM(ICMP6_ND_OPT_TLA_ETH,
82 sizeof(struct rte_flow_item_icmp6_nd_opt_tla_eth)),
83 MK_FLOW_ITEM(MARK, sizeof(struct rte_flow_item_mark)),
84 MK_FLOW_ITEM(META, sizeof(struct rte_flow_item_meta)),
85 MK_FLOW_ITEM(TAG, sizeof(struct rte_flow_item_tag)),
86 MK_FLOW_ITEM(GRE_KEY, sizeof(rte_be32_t)),
87 MK_FLOW_ITEM(GTP_PSC, sizeof(struct rte_flow_item_gtp_psc)),
88 MK_FLOW_ITEM(PPPOES, sizeof(struct rte_flow_item_pppoe)),
89 MK_FLOW_ITEM(PPPOED, sizeof(struct rte_flow_item_pppoe)),
90 MK_FLOW_ITEM(PPPOE_PROTO_ID,
91 sizeof(struct rte_flow_item_pppoe_proto_id)),
92 MK_FLOW_ITEM(NSH, sizeof(struct rte_flow_item_nsh)),
93 MK_FLOW_ITEM(IGMP, sizeof(struct rte_flow_item_igmp)),
94 MK_FLOW_ITEM(AH, sizeof(struct rte_flow_item_ah)),
95 MK_FLOW_ITEM(HIGIG2, sizeof(struct rte_flow_item_higig2_hdr)),
98 /** Generate flow_action[] entry. */
99 #define MK_FLOW_ACTION(t, s) \
100 [RTE_FLOW_ACTION_TYPE_ ## t] = { \
105 /** Information about known flow actions. */
106 static const struct rte_flow_desc_data rte_flow_desc_action[] = {
107 MK_FLOW_ACTION(END, 0),
108 MK_FLOW_ACTION(VOID, 0),
109 MK_FLOW_ACTION(PASSTHRU, 0),
110 MK_FLOW_ACTION(JUMP, sizeof(struct rte_flow_action_jump)),
111 MK_FLOW_ACTION(MARK, sizeof(struct rte_flow_action_mark)),
112 MK_FLOW_ACTION(FLAG, 0),
113 MK_FLOW_ACTION(QUEUE, sizeof(struct rte_flow_action_queue)),
114 MK_FLOW_ACTION(DROP, 0),
115 MK_FLOW_ACTION(COUNT, sizeof(struct rte_flow_action_count)),
116 MK_FLOW_ACTION(RSS, sizeof(struct rte_flow_action_rss)),
117 MK_FLOW_ACTION(PF, 0),
118 MK_FLOW_ACTION(VF, sizeof(struct rte_flow_action_vf)),
119 MK_FLOW_ACTION(PHY_PORT, sizeof(struct rte_flow_action_phy_port)),
120 MK_FLOW_ACTION(PORT_ID, sizeof(struct rte_flow_action_port_id)),
121 MK_FLOW_ACTION(METER, sizeof(struct rte_flow_action_meter)),
122 MK_FLOW_ACTION(SECURITY, sizeof(struct rte_flow_action_security)),
123 MK_FLOW_ACTION(OF_SET_MPLS_TTL,
124 sizeof(struct rte_flow_action_of_set_mpls_ttl)),
125 MK_FLOW_ACTION(OF_DEC_MPLS_TTL, 0),
126 MK_FLOW_ACTION(OF_SET_NW_TTL,
127 sizeof(struct rte_flow_action_of_set_nw_ttl)),
128 MK_FLOW_ACTION(OF_DEC_NW_TTL, 0),
129 MK_FLOW_ACTION(OF_COPY_TTL_OUT, 0),
130 MK_FLOW_ACTION(OF_COPY_TTL_IN, 0),
131 MK_FLOW_ACTION(OF_POP_VLAN, 0),
132 MK_FLOW_ACTION(OF_PUSH_VLAN,
133 sizeof(struct rte_flow_action_of_push_vlan)),
134 MK_FLOW_ACTION(OF_SET_VLAN_VID,
135 sizeof(struct rte_flow_action_of_set_vlan_vid)),
136 MK_FLOW_ACTION(OF_SET_VLAN_PCP,
137 sizeof(struct rte_flow_action_of_set_vlan_pcp)),
138 MK_FLOW_ACTION(OF_POP_MPLS,
139 sizeof(struct rte_flow_action_of_pop_mpls)),
140 MK_FLOW_ACTION(OF_PUSH_MPLS,
141 sizeof(struct rte_flow_action_of_push_mpls)),
142 MK_FLOW_ACTION(VXLAN_ENCAP, sizeof(struct rte_flow_action_vxlan_encap)),
143 MK_FLOW_ACTION(VXLAN_DECAP, 0),
144 MK_FLOW_ACTION(NVGRE_ENCAP, sizeof(struct rte_flow_action_vxlan_encap)),
145 MK_FLOW_ACTION(NVGRE_DECAP, 0),
146 MK_FLOW_ACTION(RAW_ENCAP, sizeof(struct rte_flow_action_raw_encap)),
147 MK_FLOW_ACTION(RAW_DECAP, sizeof(struct rte_flow_action_raw_decap)),
148 MK_FLOW_ACTION(SET_IPV4_SRC,
149 sizeof(struct rte_flow_action_set_ipv4)),
150 MK_FLOW_ACTION(SET_IPV4_DST,
151 sizeof(struct rte_flow_action_set_ipv4)),
152 MK_FLOW_ACTION(SET_IPV6_SRC,
153 sizeof(struct rte_flow_action_set_ipv6)),
154 MK_FLOW_ACTION(SET_IPV6_DST,
155 sizeof(struct rte_flow_action_set_ipv6)),
156 MK_FLOW_ACTION(SET_TP_SRC,
157 sizeof(struct rte_flow_action_set_tp)),
158 MK_FLOW_ACTION(SET_TP_DST,
159 sizeof(struct rte_flow_action_set_tp)),
160 MK_FLOW_ACTION(MAC_SWAP, 0),
161 MK_FLOW_ACTION(DEC_TTL, 0),
162 MK_FLOW_ACTION(SET_TTL, sizeof(struct rte_flow_action_set_ttl)),
163 MK_FLOW_ACTION(SET_MAC_SRC, sizeof(struct rte_flow_action_set_mac)),
164 MK_FLOW_ACTION(SET_MAC_DST, sizeof(struct rte_flow_action_set_mac)),
165 MK_FLOW_ACTION(INC_TCP_SEQ, sizeof(rte_be32_t)),
166 MK_FLOW_ACTION(DEC_TCP_SEQ, sizeof(rte_be32_t)),
167 MK_FLOW_ACTION(INC_TCP_ACK, sizeof(rte_be32_t)),
168 MK_FLOW_ACTION(DEC_TCP_ACK, sizeof(rte_be32_t)),
169 MK_FLOW_ACTION(SET_TAG, sizeof(struct rte_flow_action_set_tag)),
170 MK_FLOW_ACTION(SET_META, sizeof(struct rte_flow_action_set_meta)),
171 MK_FLOW_ACTION(SET_IPV4_DSCP, sizeof(struct rte_flow_action_set_dscp)),
172 MK_FLOW_ACTION(SET_IPV6_DSCP, sizeof(struct rte_flow_action_set_dscp)),
176 rte_flow_dynf_metadata_register(void)
181 static const struct rte_mbuf_dynfield desc_offs = {
182 .name = RTE_MBUF_DYNFIELD_METADATA_NAME,
183 .size = sizeof(uint32_t),
184 .align = __alignof__(uint32_t),
186 static const struct rte_mbuf_dynflag desc_flag = {
187 .name = RTE_MBUF_DYNFLAG_METADATA_NAME,
190 offset = rte_mbuf_dynfield_register(&desc_offs);
193 flag = rte_mbuf_dynflag_register(&desc_flag);
196 rte_flow_dynf_metadata_offs = offset;
197 rte_flow_dynf_metadata_mask = (1ULL << flag);
201 rte_flow_dynf_metadata_offs = -1;
202 rte_flow_dynf_metadata_mask = 0ULL;
207 flow_err(uint16_t port_id, int ret, struct rte_flow_error *error)
211 if (rte_eth_dev_is_removed(port_id))
212 return rte_flow_error_set(error, EIO,
213 RTE_FLOW_ERROR_TYPE_UNSPECIFIED,
214 NULL, rte_strerror(EIO));
218 static enum rte_flow_item_type
219 rte_flow_expand_rss_item_complete(const struct rte_flow_item *item)
221 enum rte_flow_item_type ret = RTE_FLOW_ITEM_TYPE_VOID;
222 uint16_t ether_type = 0;
223 uint16_t ether_type_m;
224 uint8_t ip_next_proto = 0;
225 uint8_t ip_next_proto_m;
227 if (item == NULL || item->spec == NULL)
229 switch (item->type) {
230 case RTE_FLOW_ITEM_TYPE_ETH:
232 ether_type_m = ((const struct rte_flow_item_eth *)
235 ether_type_m = rte_flow_item_eth_mask.type;
236 if (ether_type_m != RTE_BE16(0xFFFF))
238 ether_type = ((const struct rte_flow_item_eth *)
240 if (rte_be_to_cpu_16(ether_type) == RTE_ETHER_TYPE_IPV4)
241 ret = RTE_FLOW_ITEM_TYPE_IPV4;
242 else if (rte_be_to_cpu_16(ether_type) == RTE_ETHER_TYPE_IPV6)
243 ret = RTE_FLOW_ITEM_TYPE_IPV6;
244 else if (rte_be_to_cpu_16(ether_type) == RTE_ETHER_TYPE_VLAN)
245 ret = RTE_FLOW_ITEM_TYPE_VLAN;
247 case RTE_FLOW_ITEM_TYPE_VLAN:
249 ether_type_m = ((const struct rte_flow_item_vlan *)
250 (item->mask))->inner_type;
252 ether_type_m = rte_flow_item_vlan_mask.inner_type;
253 if (ether_type_m != RTE_BE16(0xFFFF))
255 ether_type = ((const struct rte_flow_item_vlan *)
256 (item->spec))->inner_type;
257 if (rte_be_to_cpu_16(ether_type) == RTE_ETHER_TYPE_IPV4)
258 ret = RTE_FLOW_ITEM_TYPE_IPV4;
259 else if (rte_be_to_cpu_16(ether_type) == RTE_ETHER_TYPE_IPV6)
260 ret = RTE_FLOW_ITEM_TYPE_IPV6;
261 else if (rte_be_to_cpu_16(ether_type) == RTE_ETHER_TYPE_VLAN)
262 ret = RTE_FLOW_ITEM_TYPE_VLAN;
264 case RTE_FLOW_ITEM_TYPE_IPV4:
266 ip_next_proto_m = ((const struct rte_flow_item_ipv4 *)
267 (item->mask))->hdr.next_proto_id;
270 rte_flow_item_ipv4_mask.hdr.next_proto_id;
271 if (ip_next_proto_m != 0xFF)
273 ip_next_proto = ((const struct rte_flow_item_ipv4 *)
274 (item->spec))->hdr.next_proto_id;
275 if (ip_next_proto == IPPROTO_UDP)
276 ret = RTE_FLOW_ITEM_TYPE_UDP;
277 else if (ip_next_proto == IPPROTO_TCP)
278 ret = RTE_FLOW_ITEM_TYPE_TCP;
279 else if (ip_next_proto == IPPROTO_IP)
280 ret = RTE_FLOW_ITEM_TYPE_IPV4;
281 else if (ip_next_proto == IPPROTO_IPV6)
282 ret = RTE_FLOW_ITEM_TYPE_IPV6;
284 case RTE_FLOW_ITEM_TYPE_IPV6:
286 ip_next_proto_m = ((const struct rte_flow_item_ipv6 *)
287 (item->mask))->hdr.proto;
290 rte_flow_item_ipv6_mask.hdr.proto;
291 if (ip_next_proto_m != 0xFF)
293 ip_next_proto = ((const struct rte_flow_item_ipv6 *)
294 (item->spec))->hdr.proto;
295 if (ip_next_proto == IPPROTO_UDP)
296 ret = RTE_FLOW_ITEM_TYPE_UDP;
297 else if (ip_next_proto == IPPROTO_TCP)
298 ret = RTE_FLOW_ITEM_TYPE_TCP;
299 else if (ip_next_proto == IPPROTO_IP)
300 ret = RTE_FLOW_ITEM_TYPE_IPV4;
301 else if (ip_next_proto == IPPROTO_IPV6)
302 ret = RTE_FLOW_ITEM_TYPE_IPV6;
305 ret = RTE_FLOW_ITEM_TYPE_VOID;
311 /* Get generic flow operations structure from a port. */
312 const struct rte_flow_ops *
313 rte_flow_ops_get(uint16_t port_id, struct rte_flow_error *error)
315 struct rte_eth_dev *dev = &rte_eth_devices[port_id];
316 const struct rte_flow_ops *ops;
319 if (unlikely(!rte_eth_dev_is_valid_port(port_id)))
321 else if (unlikely(!dev->dev_ops->filter_ctrl ||
322 dev->dev_ops->filter_ctrl(dev,
323 RTE_ETH_FILTER_GENERIC,
330 rte_flow_error_set(error, code, RTE_FLOW_ERROR_TYPE_UNSPECIFIED,
331 NULL, rte_strerror(code));
335 /* Check whether a flow rule can be created on a given port. */
337 rte_flow_validate(uint16_t port_id,
338 const struct rte_flow_attr *attr,
339 const struct rte_flow_item pattern[],
340 const struct rte_flow_action actions[],
341 struct rte_flow_error *error)
343 const struct rte_flow_ops *ops = rte_flow_ops_get(port_id, error);
344 struct rte_eth_dev *dev = &rte_eth_devices[port_id];
348 if (likely(!!ops->validate))
349 return flow_err(port_id, ops->validate(dev, attr, pattern,
350 actions, error), error);
351 return rte_flow_error_set(error, ENOSYS,
352 RTE_FLOW_ERROR_TYPE_UNSPECIFIED,
353 NULL, rte_strerror(ENOSYS));
356 /* Create a flow rule on a given port. */
358 rte_flow_create(uint16_t port_id,
359 const struct rte_flow_attr *attr,
360 const struct rte_flow_item pattern[],
361 const struct rte_flow_action actions[],
362 struct rte_flow_error *error)
364 struct rte_eth_dev *dev = &rte_eth_devices[port_id];
365 struct rte_flow *flow;
366 const struct rte_flow_ops *ops = rte_flow_ops_get(port_id, error);
370 if (likely(!!ops->create)) {
371 flow = ops->create(dev, attr, pattern, actions, error);
373 flow_err(port_id, -rte_errno, error);
376 rte_flow_error_set(error, ENOSYS, RTE_FLOW_ERROR_TYPE_UNSPECIFIED,
377 NULL, rte_strerror(ENOSYS));
381 /* Destroy a flow rule on a given port. */
383 rte_flow_destroy(uint16_t port_id,
384 struct rte_flow *flow,
385 struct rte_flow_error *error)
387 struct rte_eth_dev *dev = &rte_eth_devices[port_id];
388 const struct rte_flow_ops *ops = rte_flow_ops_get(port_id, error);
392 if (likely(!!ops->destroy))
393 return flow_err(port_id, ops->destroy(dev, flow, error),
395 return rte_flow_error_set(error, ENOSYS,
396 RTE_FLOW_ERROR_TYPE_UNSPECIFIED,
397 NULL, rte_strerror(ENOSYS));
400 /* Destroy all flow rules associated with a port. */
402 rte_flow_flush(uint16_t port_id,
403 struct rte_flow_error *error)
405 struct rte_eth_dev *dev = &rte_eth_devices[port_id];
406 const struct rte_flow_ops *ops = rte_flow_ops_get(port_id, error);
410 if (likely(!!ops->flush))
411 return flow_err(port_id, ops->flush(dev, error), error);
412 return rte_flow_error_set(error, ENOSYS,
413 RTE_FLOW_ERROR_TYPE_UNSPECIFIED,
414 NULL, rte_strerror(ENOSYS));
417 /* Query an existing flow rule. */
419 rte_flow_query(uint16_t port_id,
420 struct rte_flow *flow,
421 const struct rte_flow_action *action,
423 struct rte_flow_error *error)
425 struct rte_eth_dev *dev = &rte_eth_devices[port_id];
426 const struct rte_flow_ops *ops = rte_flow_ops_get(port_id, error);
430 if (likely(!!ops->query))
431 return flow_err(port_id, ops->query(dev, flow, action, data,
433 return rte_flow_error_set(error, ENOSYS,
434 RTE_FLOW_ERROR_TYPE_UNSPECIFIED,
435 NULL, rte_strerror(ENOSYS));
438 /* Restrict ingress traffic to the defined flow rules. */
440 rte_flow_isolate(uint16_t port_id,
442 struct rte_flow_error *error)
444 struct rte_eth_dev *dev = &rte_eth_devices[port_id];
445 const struct rte_flow_ops *ops = rte_flow_ops_get(port_id, error);
449 if (likely(!!ops->isolate))
450 return flow_err(port_id, ops->isolate(dev, set, error), error);
451 return rte_flow_error_set(error, ENOSYS,
452 RTE_FLOW_ERROR_TYPE_UNSPECIFIED,
453 NULL, rte_strerror(ENOSYS));
456 /* Initialize flow error structure. */
458 rte_flow_error_set(struct rte_flow_error *error,
460 enum rte_flow_error_type type,
465 *error = (struct rte_flow_error){
475 /** Pattern item specification types. */
476 enum rte_flow_conv_item_spec_type {
477 RTE_FLOW_CONV_ITEM_SPEC,
478 RTE_FLOW_CONV_ITEM_LAST,
479 RTE_FLOW_CONV_ITEM_MASK,
483 * Copy pattern item specification.
486 * Output buffer. Can be NULL if @p size is zero.
488 * Size of @p buf in bytes.
490 * Pattern item to copy specification from.
492 * Specification selector for either @p spec, @p last or @p mask.
495 * Number of bytes needed to store pattern item specification regardless
496 * of @p size. @p buf contents are truncated to @p size if not large
500 rte_flow_conv_item_spec(void *buf, const size_t size,
501 const struct rte_flow_item *item,
502 enum rte_flow_conv_item_spec_type type)
506 type == RTE_FLOW_CONV_ITEM_SPEC ? item->spec :
507 type == RTE_FLOW_CONV_ITEM_LAST ? item->last :
508 type == RTE_FLOW_CONV_ITEM_MASK ? item->mask :
511 switch (item->type) {
513 const struct rte_flow_item_raw *raw;
516 const struct rte_flow_item_raw *raw;
519 const struct rte_flow_item_raw *raw;
522 const struct rte_flow_item_raw *raw;
525 struct rte_flow_item_raw *raw;
529 case RTE_FLOW_ITEM_TYPE_RAW:
530 spec.raw = item->spec;
531 last.raw = item->last ? item->last : item->spec;
532 mask.raw = item->mask ? item->mask : &rte_flow_item_raw_mask;
536 (&(struct rte_flow_item_raw){
537 .relative = src.raw->relative,
538 .search = src.raw->search,
539 .reserved = src.raw->reserved,
540 .offset = src.raw->offset,
541 .limit = src.raw->limit,
542 .length = src.raw->length,
544 size > sizeof(*dst.raw) ? sizeof(*dst.raw) : size);
545 off = sizeof(*dst.raw);
546 if (type == RTE_FLOW_CONV_ITEM_SPEC ||
547 (type == RTE_FLOW_CONV_ITEM_MASK &&
548 ((spec.raw->length & mask.raw->length) >=
549 (last.raw->length & mask.raw->length))))
550 tmp = spec.raw->length & mask.raw->length;
552 tmp = last.raw->length & mask.raw->length;
554 off = RTE_ALIGN_CEIL(off, sizeof(*dst.raw->pattern));
555 if (size >= off + tmp)
556 dst.raw->pattern = rte_memcpy
557 ((void *)((uintptr_t)dst.raw + off),
558 src.raw->pattern, tmp);
563 off = rte_flow_desc_item[item->type].size;
564 rte_memcpy(buf, data, (size > off ? off : size));
571 * Copy action configuration.
574 * Output buffer. Can be NULL if @p size is zero.
576 * Size of @p buf in bytes.
578 * Action to copy configuration from.
581 * Number of bytes needed to store pattern item specification regardless
582 * of @p size. @p buf contents are truncated to @p size if not large
586 rte_flow_conv_action_conf(void *buf, const size_t size,
587 const struct rte_flow_action *action)
591 switch (action->type) {
593 const struct rte_flow_action_rss *rss;
594 const struct rte_flow_action_vxlan_encap *vxlan_encap;
595 const struct rte_flow_action_nvgre_encap *nvgre_encap;
598 struct rte_flow_action_rss *rss;
599 struct rte_flow_action_vxlan_encap *vxlan_encap;
600 struct rte_flow_action_nvgre_encap *nvgre_encap;
605 case RTE_FLOW_ACTION_TYPE_RSS:
606 src.rss = action->conf;
609 (&(struct rte_flow_action_rss){
610 .func = src.rss->func,
611 .level = src.rss->level,
612 .types = src.rss->types,
613 .key_len = src.rss->key_len,
614 .queue_num = src.rss->queue_num,
616 size > sizeof(*dst.rss) ? sizeof(*dst.rss) : size);
617 off = sizeof(*dst.rss);
618 if (src.rss->key_len) {
619 off = RTE_ALIGN_CEIL(off, sizeof(*dst.rss->key));
620 tmp = sizeof(*src.rss->key) * src.rss->key_len;
621 if (size >= off + tmp)
622 dst.rss->key = rte_memcpy
623 ((void *)((uintptr_t)dst.rss + off),
627 if (src.rss->queue_num) {
628 off = RTE_ALIGN_CEIL(off, sizeof(*dst.rss->queue));
629 tmp = sizeof(*src.rss->queue) * src.rss->queue_num;
630 if (size >= off + tmp)
631 dst.rss->queue = rte_memcpy
632 ((void *)((uintptr_t)dst.rss + off),
633 src.rss->queue, tmp);
637 case RTE_FLOW_ACTION_TYPE_VXLAN_ENCAP:
638 case RTE_FLOW_ACTION_TYPE_NVGRE_ENCAP:
639 src.vxlan_encap = action->conf;
640 dst.vxlan_encap = buf;
641 RTE_BUILD_BUG_ON(sizeof(*src.vxlan_encap) !=
642 sizeof(*src.nvgre_encap) ||
643 offsetof(struct rte_flow_action_vxlan_encap,
645 offsetof(struct rte_flow_action_nvgre_encap,
647 off = sizeof(*dst.vxlan_encap);
648 if (src.vxlan_encap->definition) {
650 (off, sizeof(*dst.vxlan_encap->definition));
652 (RTE_FLOW_CONV_OP_PATTERN,
653 (void *)((uintptr_t)dst.vxlan_encap + off),
654 size > off ? size - off : 0,
655 src.vxlan_encap->definition, NULL);
658 if (size >= off + ret)
659 dst.vxlan_encap->definition =
660 (void *)((uintptr_t)dst.vxlan_encap +
666 off = rte_flow_desc_action[action->type].size;
667 rte_memcpy(buf, action->conf, (size > off ? off : size));
674 * Copy a list of pattern items.
677 * Destination buffer. Can be NULL if @p size is zero.
679 * Size of @p dst in bytes.
681 * Source pattern items.
683 * Maximum number of pattern items to process from @p src or 0 to process
684 * the entire list. In both cases, processing stops after
685 * RTE_FLOW_ITEM_TYPE_END is encountered.
687 * Perform verbose error reporting if not NULL.
690 * A positive value representing the number of bytes needed to store
691 * pattern items regardless of @p size on success (@p buf contents are
692 * truncated to @p size if not large enough), a negative errno value
693 * otherwise and rte_errno is set.
696 rte_flow_conv_pattern(struct rte_flow_item *dst,
698 const struct rte_flow_item *src,
700 struct rte_flow_error *error)
702 uintptr_t data = (uintptr_t)dst;
707 for (i = 0, off = 0; !num || i != num; ++i, ++src, ++dst) {
708 if ((size_t)src->type >= RTE_DIM(rte_flow_desc_item) ||
709 !rte_flow_desc_item[src->type].name)
710 return rte_flow_error_set
711 (error, ENOTSUP, RTE_FLOW_ERROR_TYPE_ITEM, src,
712 "cannot convert unknown item type");
713 if (size >= off + sizeof(*dst))
714 *dst = (struct rte_flow_item){
726 off = RTE_ALIGN_CEIL(off, sizeof(double));
727 ret = rte_flow_conv_item_spec
728 ((void *)(data + off),
729 size > off ? size - off : 0, src,
730 RTE_FLOW_CONV_ITEM_SPEC);
731 if (size && size >= off + ret)
732 dst->spec = (void *)(data + off);
737 off = RTE_ALIGN_CEIL(off, sizeof(double));
738 ret = rte_flow_conv_item_spec
739 ((void *)(data + off),
740 size > off ? size - off : 0, src,
741 RTE_FLOW_CONV_ITEM_LAST);
742 if (size && size >= off + ret)
743 dst->last = (void *)(data + off);
747 off = RTE_ALIGN_CEIL(off, sizeof(double));
748 ret = rte_flow_conv_item_spec
749 ((void *)(data + off),
750 size > off ? size - off : 0, src,
751 RTE_FLOW_CONV_ITEM_MASK);
752 if (size && size >= off + ret)
753 dst->mask = (void *)(data + off);
763 * Copy a list of actions.
766 * Destination buffer. Can be NULL if @p size is zero.
768 * Size of @p dst in bytes.
772 * Maximum number of actions to process from @p src or 0 to process the
773 * entire list. In both cases, processing stops after
774 * RTE_FLOW_ACTION_TYPE_END is encountered.
776 * Perform verbose error reporting if not NULL.
779 * A positive value representing the number of bytes needed to store
780 * actions regardless of @p size on success (@p buf contents are truncated
781 * to @p size if not large enough), a negative errno value otherwise and
785 rte_flow_conv_actions(struct rte_flow_action *dst,
787 const struct rte_flow_action *src,
789 struct rte_flow_error *error)
791 uintptr_t data = (uintptr_t)dst;
796 for (i = 0, off = 0; !num || i != num; ++i, ++src, ++dst) {
797 if ((size_t)src->type >= RTE_DIM(rte_flow_desc_action) ||
798 !rte_flow_desc_action[src->type].name)
799 return rte_flow_error_set
800 (error, ENOTSUP, RTE_FLOW_ERROR_TYPE_ACTION,
801 src, "cannot convert unknown action type");
802 if (size >= off + sizeof(*dst))
803 *dst = (struct rte_flow_action){
815 off = RTE_ALIGN_CEIL(off, sizeof(double));
816 ret = rte_flow_conv_action_conf
817 ((void *)(data + off),
818 size > off ? size - off : 0, src);
819 if (size && size >= off + ret)
820 dst->conf = (void *)(data + off);
830 * Copy flow rule components.
832 * This comprises the flow rule descriptor itself, attributes, pattern and
833 * actions list. NULL components in @p src are skipped.
836 * Destination buffer. Can be NULL if @p size is zero.
838 * Size of @p dst in bytes.
840 * Source flow rule descriptor.
842 * Perform verbose error reporting if not NULL.
845 * A positive value representing the number of bytes needed to store all
846 * components including the descriptor regardless of @p size on success
847 * (@p buf contents are truncated to @p size if not large enough), a
848 * negative errno value otherwise and rte_errno is set.
851 rte_flow_conv_rule(struct rte_flow_conv_rule *dst,
853 const struct rte_flow_conv_rule *src,
854 struct rte_flow_error *error)
860 (&(struct rte_flow_conv_rule){
865 size > sizeof(*dst) ? sizeof(*dst) : size);
868 off = RTE_ALIGN_CEIL(off, sizeof(double));
869 if (size && size >= off + sizeof(*dst->attr))
870 dst->attr = rte_memcpy
871 ((void *)((uintptr_t)dst + off),
872 src->attr_ro, sizeof(*dst->attr));
873 off += sizeof(*dst->attr);
875 if (src->pattern_ro) {
876 off = RTE_ALIGN_CEIL(off, sizeof(double));
877 ret = rte_flow_conv_pattern((void *)((uintptr_t)dst + off),
878 size > off ? size - off : 0,
879 src->pattern_ro, 0, error);
882 if (size && size >= off + (size_t)ret)
883 dst->pattern = (void *)((uintptr_t)dst + off);
886 if (src->actions_ro) {
887 off = RTE_ALIGN_CEIL(off, sizeof(double));
888 ret = rte_flow_conv_actions((void *)((uintptr_t)dst + off),
889 size > off ? size - off : 0,
890 src->actions_ro, 0, error);
893 if (size >= off + (size_t)ret)
894 dst->actions = (void *)((uintptr_t)dst + off);
901 * Retrieve the name of a pattern item/action type.
904 * Nonzero when @p src represents an action type instead of a pattern item
907 * Nonzero to write string address instead of contents into @p dst.
909 * Destination buffer. Can be NULL if @p size is zero.
911 * Size of @p dst in bytes.
913 * Depending on @p is_action, source pattern item or action type cast as a
916 * Perform verbose error reporting if not NULL.
919 * A positive value representing the number of bytes needed to store the
920 * name or its address regardless of @p size on success (@p buf contents
921 * are truncated to @p size if not large enough), a negative errno value
922 * otherwise and rte_errno is set.
925 rte_flow_conv_name(int is_action,
930 struct rte_flow_error *error)
933 const struct rte_flow_desc_data *data;
936 static const struct desc_info info_rep[2] = {
937 { rte_flow_desc_item, RTE_DIM(rte_flow_desc_item), },
938 { rte_flow_desc_action, RTE_DIM(rte_flow_desc_action), },
940 const struct desc_info *const info = &info_rep[!!is_action];
941 unsigned int type = (uintptr_t)src;
943 if (type >= info->num)
944 return rte_flow_error_set
945 (error, EINVAL, RTE_FLOW_ERROR_TYPE_UNSPECIFIED, NULL,
946 "unknown object type to retrieve the name of");
948 return strlcpy(dst, info->data[type].name, size);
949 if (size >= sizeof(const char **))
950 *((const char **)dst) = info->data[type].name;
951 return sizeof(const char **);
954 /** Helper function to convert flow API objects. */
956 rte_flow_conv(enum rte_flow_conv_op op,
960 struct rte_flow_error *error)
963 const struct rte_flow_attr *attr;
965 case RTE_FLOW_CONV_OP_NONE:
967 case RTE_FLOW_CONV_OP_ATTR:
969 if (size > sizeof(*attr))
970 size = sizeof(*attr);
971 rte_memcpy(dst, attr, size);
972 return sizeof(*attr);
973 case RTE_FLOW_CONV_OP_ITEM:
974 return rte_flow_conv_pattern(dst, size, src, 1, error);
975 case RTE_FLOW_CONV_OP_ACTION:
976 return rte_flow_conv_actions(dst, size, src, 1, error);
977 case RTE_FLOW_CONV_OP_PATTERN:
978 return rte_flow_conv_pattern(dst, size, src, 0, error);
979 case RTE_FLOW_CONV_OP_ACTIONS:
980 return rte_flow_conv_actions(dst, size, src, 0, error);
981 case RTE_FLOW_CONV_OP_RULE:
982 return rte_flow_conv_rule(dst, size, src, error);
983 case RTE_FLOW_CONV_OP_ITEM_NAME:
984 return rte_flow_conv_name(0, 0, dst, size, src, error);
985 case RTE_FLOW_CONV_OP_ACTION_NAME:
986 return rte_flow_conv_name(1, 0, dst, size, src, error);
987 case RTE_FLOW_CONV_OP_ITEM_NAME_PTR:
988 return rte_flow_conv_name(0, 1, dst, size, src, error);
989 case RTE_FLOW_CONV_OP_ACTION_NAME_PTR:
990 return rte_flow_conv_name(1, 1, dst, size, src, error);
992 return rte_flow_error_set
993 (error, ENOTSUP, RTE_FLOW_ERROR_TYPE_UNSPECIFIED, NULL,
994 "unknown object conversion operation");
997 /** Store a full rte_flow description. */
999 rte_flow_copy(struct rte_flow_desc *desc, size_t len,
1000 const struct rte_flow_attr *attr,
1001 const struct rte_flow_item *items,
1002 const struct rte_flow_action *actions)
1005 * Overlap struct rte_flow_conv with struct rte_flow_desc in order
1006 * to convert the former to the latter without wasting space.
1008 struct rte_flow_conv_rule *dst =
1010 (void *)((uintptr_t)desc +
1011 (offsetof(struct rte_flow_desc, actions) -
1012 offsetof(struct rte_flow_conv_rule, actions))) :
1015 len > sizeof(*desc) - sizeof(*dst) ?
1016 len - (sizeof(*desc) - sizeof(*dst)) :
1018 struct rte_flow_conv_rule src = {
1020 .pattern_ro = items,
1021 .actions_ro = actions,
1025 RTE_BUILD_BUG_ON(sizeof(struct rte_flow_desc) <
1026 sizeof(struct rte_flow_conv_rule));
1028 (&dst->pattern != &desc->items ||
1029 &dst->actions != &desc->actions ||
1030 (uintptr_t)(dst + 1) != (uintptr_t)(desc + 1))) {
1034 ret = rte_flow_conv(RTE_FLOW_CONV_OP_RULE, dst, dst_size, &src, NULL);
1037 ret += sizeof(*desc) - sizeof(*dst);
1039 (&(struct rte_flow_desc){
1042 .items = dst_size ? dst->pattern : NULL,
1043 .actions = dst_size ? dst->actions : NULL,
1045 len > sizeof(*desc) ? sizeof(*desc) : len);
1050 * Expand RSS flows into several possible flows according to the RSS hash
1051 * fields requested and the driver capabilities.
1054 rte_flow_expand_rss(struct rte_flow_expand_rss *buf, size_t size,
1055 const struct rte_flow_item *pattern, uint64_t types,
1056 const struct rte_flow_expand_node graph[],
1057 int graph_root_index)
1059 const int elt_n = 8;
1060 const struct rte_flow_item *item;
1061 const struct rte_flow_expand_node *node = &graph[graph_root_index];
1062 const int *next_node;
1063 const int *stack[elt_n];
1065 struct rte_flow_item flow_items[elt_n];
1068 size_t user_pattern_size = 0;
1070 const struct rte_flow_expand_node *next = NULL;
1071 struct rte_flow_item missed_item;
1074 const struct rte_flow_item *last_item = NULL;
1076 memset(&missed_item, 0, sizeof(missed_item));
1077 lsize = offsetof(struct rte_flow_expand_rss, entry) +
1078 elt_n * sizeof(buf->entry[0]);
1079 if (lsize <= size) {
1080 buf->entry[0].priority = 0;
1081 buf->entry[0].pattern = (void *)&buf->entry[elt_n];
1083 addr = buf->entry[0].pattern;
1085 for (item = pattern; item->type != RTE_FLOW_ITEM_TYPE_END; item++) {
1086 if (item->type != RTE_FLOW_ITEM_TYPE_VOID)
1088 for (i = 0; node->next && node->next[i]; ++i) {
1089 next = &graph[node->next[i]];
1090 if (next->type == item->type)
1095 user_pattern_size += sizeof(*item);
1097 user_pattern_size += sizeof(*item); /* Handle END item. */
1098 lsize += user_pattern_size;
1099 /* Copy the user pattern in the first entry of the buffer. */
1100 if (lsize <= size) {
1101 rte_memcpy(addr, pattern, user_pattern_size);
1102 addr = (void *)(((uintptr_t)addr) + user_pattern_size);
1105 /* Start expanding. */
1106 memset(flow_items, 0, sizeof(flow_items));
1107 user_pattern_size -= sizeof(*item);
1109 * Check if the last valid item has spec set
1110 * and need complete pattern.
1112 missed_item.type = rte_flow_expand_rss_item_complete(last_item);
1113 if (missed_item.type != RTE_FLOW_ITEM_TYPE_VOID) {
1116 for (i = 0; node->next && node->next[i]; ++i) {
1117 next = &graph[node->next[i]];
1118 if (next->type == missed_item.type) {
1119 flow_items[0].type = missed_item.type;
1120 flow_items[1].type = RTE_FLOW_ITEM_TYPE_END;
1126 if (next && missed) {
1127 elt = 2; /* missed item + item end. */
1129 lsize += elt * sizeof(*item) + user_pattern_size;
1130 if ((node->rss_types & types) && lsize <= size) {
1131 buf->entry[buf->entries].priority = 1;
1132 buf->entry[buf->entries].pattern = addr;
1134 rte_memcpy(addr, buf->entry[0].pattern,
1136 addr = (void *)(((uintptr_t)addr) + user_pattern_size);
1137 rte_memcpy(addr, flow_items, elt * sizeof(*item));
1138 addr = (void *)(((uintptr_t)addr) +
1139 elt * sizeof(*item));
1142 memset(flow_items, 0, sizeof(flow_items));
1143 next_node = node->next;
1144 stack[stack_pos] = next_node;
1145 node = next_node ? &graph[*next_node] : NULL;
1147 flow_items[stack_pos].type = node->type;
1148 if (node->rss_types & types) {
1150 * compute the number of items to copy from the
1151 * expansion and copy it.
1152 * When the stack_pos is 0, there are 1 element in it,
1153 * plus the addition END item.
1155 elt = stack_pos + 2;
1156 flow_items[stack_pos + 1].type = RTE_FLOW_ITEM_TYPE_END;
1157 lsize += elt * sizeof(*item) + user_pattern_size;
1158 if (lsize <= size) {
1159 size_t n = elt * sizeof(*item);
1161 buf->entry[buf->entries].priority =
1162 stack_pos + 1 + missed;
1163 buf->entry[buf->entries].pattern = addr;
1165 rte_memcpy(addr, buf->entry[0].pattern,
1167 addr = (void *)(((uintptr_t)addr) +
1169 rte_memcpy(addr, &missed_item,
1170 missed * sizeof(*item));
1171 addr = (void *)(((uintptr_t)addr) +
1172 missed * sizeof(*item));
1173 rte_memcpy(addr, flow_items, n);
1174 addr = (void *)(((uintptr_t)addr) + n);
1179 next_node = node->next;
1180 if (stack_pos++ == elt_n) {
1184 stack[stack_pos] = next_node;
1185 } else if (*(next_node + 1)) {
1186 /* Follow up with the next possibility. */
1189 /* Move to the next path. */
1191 next_node = stack[--stack_pos];
1193 stack[stack_pos] = next_node;
1195 node = *next_node ? &graph[*next_node] : NULL;
1197 /* no expanded flows but we have missed item, create one rule for it */
1198 if (buf->entries == 1 && missed != 0) {
1200 lsize += elt * sizeof(*item) + user_pattern_size;
1201 if (lsize <= size) {
1202 buf->entry[buf->entries].priority = 1;
1203 buf->entry[buf->entries].pattern = addr;
1205 flow_items[0].type = missed_item.type;
1206 flow_items[1].type = RTE_FLOW_ITEM_TYPE_END;
1207 rte_memcpy(addr, buf->entry[0].pattern,
1209 addr = (void *)(((uintptr_t)addr) + user_pattern_size);
1210 rte_memcpy(addr, flow_items, elt * sizeof(*item));
1211 addr = (void *)(((uintptr_t)addr) +
1212 elt * sizeof(*item));