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>
15 #include "rte_ethdev.h"
16 #include "rte_flow_driver.h"
20 * Flow elements description tables.
22 struct rte_flow_desc_data {
27 /** Generate flow_item[] entry. */
28 #define MK_FLOW_ITEM(t, s) \
29 [RTE_FLOW_ITEM_TYPE_ ## t] = { \
34 /** Information about known flow pattern items. */
35 static const struct rte_flow_desc_data rte_flow_desc_item[] = {
37 MK_FLOW_ITEM(VOID, 0),
38 MK_FLOW_ITEM(INVERT, 0),
39 MK_FLOW_ITEM(ANY, sizeof(struct rte_flow_item_any)),
41 MK_FLOW_ITEM(VF, sizeof(struct rte_flow_item_vf)),
42 MK_FLOW_ITEM(PHY_PORT, sizeof(struct rte_flow_item_phy_port)),
43 MK_FLOW_ITEM(PORT_ID, sizeof(struct rte_flow_item_port_id)),
44 MK_FLOW_ITEM(RAW, sizeof(struct rte_flow_item_raw)),
45 MK_FLOW_ITEM(ETH, sizeof(struct rte_flow_item_eth)),
46 MK_FLOW_ITEM(VLAN, sizeof(struct rte_flow_item_vlan)),
47 MK_FLOW_ITEM(IPV4, sizeof(struct rte_flow_item_ipv4)),
48 MK_FLOW_ITEM(IPV6, sizeof(struct rte_flow_item_ipv6)),
49 MK_FLOW_ITEM(ICMP, sizeof(struct rte_flow_item_icmp)),
50 MK_FLOW_ITEM(UDP, sizeof(struct rte_flow_item_udp)),
51 MK_FLOW_ITEM(TCP, sizeof(struct rte_flow_item_tcp)),
52 MK_FLOW_ITEM(SCTP, sizeof(struct rte_flow_item_sctp)),
53 MK_FLOW_ITEM(VXLAN, sizeof(struct rte_flow_item_vxlan)),
54 MK_FLOW_ITEM(E_TAG, sizeof(struct rte_flow_item_e_tag)),
55 MK_FLOW_ITEM(NVGRE, sizeof(struct rte_flow_item_nvgre)),
56 MK_FLOW_ITEM(MPLS, sizeof(struct rte_flow_item_mpls)),
57 MK_FLOW_ITEM(GRE, sizeof(struct rte_flow_item_gre)),
58 MK_FLOW_ITEM(FUZZY, sizeof(struct rte_flow_item_fuzzy)),
59 MK_FLOW_ITEM(GTP, sizeof(struct rte_flow_item_gtp)),
60 MK_FLOW_ITEM(GTPC, sizeof(struct rte_flow_item_gtp)),
61 MK_FLOW_ITEM(GTPU, sizeof(struct rte_flow_item_gtp)),
62 MK_FLOW_ITEM(ESP, sizeof(struct rte_flow_item_esp)),
63 MK_FLOW_ITEM(GENEVE, sizeof(struct rte_flow_item_geneve)),
64 MK_FLOW_ITEM(VXLAN_GPE, sizeof(struct rte_flow_item_vxlan_gpe)),
65 MK_FLOW_ITEM(ARP_ETH_IPV4, sizeof(struct rte_flow_item_arp_eth_ipv4)),
66 MK_FLOW_ITEM(IPV6_EXT, sizeof(struct rte_flow_item_ipv6_ext)),
67 MK_FLOW_ITEM(ICMP6, sizeof(struct rte_flow_item_icmp6)),
68 MK_FLOW_ITEM(ICMP6_ND_NS, sizeof(struct rte_flow_item_icmp6_nd_ns)),
69 MK_FLOW_ITEM(ICMP6_ND_NA, sizeof(struct rte_flow_item_icmp6_nd_na)),
70 MK_FLOW_ITEM(ICMP6_ND_OPT, sizeof(struct rte_flow_item_icmp6_nd_opt)),
71 MK_FLOW_ITEM(ICMP6_ND_OPT_SLA_ETH,
72 sizeof(struct rte_flow_item_icmp6_nd_opt_sla_eth)),
73 MK_FLOW_ITEM(ICMP6_ND_OPT_TLA_ETH,
74 sizeof(struct rte_flow_item_icmp6_nd_opt_tla_eth)),
75 MK_FLOW_ITEM(MARK, sizeof(struct rte_flow_item_mark)),
78 /** Generate flow_action[] entry. */
79 #define MK_FLOW_ACTION(t, s) \
80 [RTE_FLOW_ACTION_TYPE_ ## t] = { \
85 /** Information about known flow actions. */
86 static const struct rte_flow_desc_data rte_flow_desc_action[] = {
87 MK_FLOW_ACTION(END, 0),
88 MK_FLOW_ACTION(VOID, 0),
89 MK_FLOW_ACTION(PASSTHRU, 0),
90 MK_FLOW_ACTION(JUMP, sizeof(struct rte_flow_action_jump)),
91 MK_FLOW_ACTION(MARK, sizeof(struct rte_flow_action_mark)),
92 MK_FLOW_ACTION(FLAG, 0),
93 MK_FLOW_ACTION(QUEUE, sizeof(struct rte_flow_action_queue)),
94 MK_FLOW_ACTION(DROP, 0),
95 MK_FLOW_ACTION(COUNT, sizeof(struct rte_flow_action_count)),
96 MK_FLOW_ACTION(RSS, sizeof(struct rte_flow_action_rss)),
97 MK_FLOW_ACTION(PF, 0),
98 MK_FLOW_ACTION(VF, sizeof(struct rte_flow_action_vf)),
99 MK_FLOW_ACTION(PHY_PORT, sizeof(struct rte_flow_action_phy_port)),
100 MK_FLOW_ACTION(PORT_ID, sizeof(struct rte_flow_action_port_id)),
101 MK_FLOW_ACTION(METER, sizeof(struct rte_flow_action_meter)),
102 MK_FLOW_ACTION(SECURITY, sizeof(struct rte_flow_action_security)),
103 MK_FLOW_ACTION(OF_SET_MPLS_TTL,
104 sizeof(struct rte_flow_action_of_set_mpls_ttl)),
105 MK_FLOW_ACTION(OF_DEC_MPLS_TTL, 0),
106 MK_FLOW_ACTION(OF_SET_NW_TTL,
107 sizeof(struct rte_flow_action_of_set_nw_ttl)),
108 MK_FLOW_ACTION(OF_DEC_NW_TTL, 0),
109 MK_FLOW_ACTION(OF_COPY_TTL_OUT, 0),
110 MK_FLOW_ACTION(OF_COPY_TTL_IN, 0),
111 MK_FLOW_ACTION(OF_POP_VLAN, 0),
112 MK_FLOW_ACTION(OF_PUSH_VLAN,
113 sizeof(struct rte_flow_action_of_push_vlan)),
114 MK_FLOW_ACTION(OF_SET_VLAN_VID,
115 sizeof(struct rte_flow_action_of_set_vlan_vid)),
116 MK_FLOW_ACTION(OF_SET_VLAN_PCP,
117 sizeof(struct rte_flow_action_of_set_vlan_pcp)),
118 MK_FLOW_ACTION(OF_POP_MPLS,
119 sizeof(struct rte_flow_action_of_pop_mpls)),
120 MK_FLOW_ACTION(OF_PUSH_MPLS,
121 sizeof(struct rte_flow_action_of_push_mpls)),
122 MK_FLOW_ACTION(VXLAN_ENCAP, sizeof(struct rte_flow_action_vxlan_encap)),
123 MK_FLOW_ACTION(VXLAN_DECAP, 0),
124 MK_FLOW_ACTION(NVGRE_ENCAP, sizeof(struct rte_flow_action_vxlan_encap)),
125 MK_FLOW_ACTION(NVGRE_DECAP, 0),
126 MK_FLOW_ACTION(SET_IPV4_SRC,
127 sizeof(struct rte_flow_action_set_ipv4)),
128 MK_FLOW_ACTION(SET_IPV4_DST,
129 sizeof(struct rte_flow_action_set_ipv4)),
130 MK_FLOW_ACTION(SET_IPV6_SRC,
131 sizeof(struct rte_flow_action_set_ipv6)),
132 MK_FLOW_ACTION(SET_IPV6_DST,
133 sizeof(struct rte_flow_action_set_ipv6)),
134 MK_FLOW_ACTION(SET_TP_SRC,
135 sizeof(struct rte_flow_action_set_tp)),
136 MK_FLOW_ACTION(SET_TP_DST,
137 sizeof(struct rte_flow_action_set_tp)),
138 MK_FLOW_ACTION(MAC_SWAP, 0),
139 MK_FLOW_ACTION(DEC_TTL, 0),
140 MK_FLOW_ACTION(SET_TTL, sizeof(struct rte_flow_action_set_ttl)),
144 flow_err(uint16_t port_id, int ret, struct rte_flow_error *error)
148 if (rte_eth_dev_is_removed(port_id))
149 return rte_flow_error_set(error, EIO,
150 RTE_FLOW_ERROR_TYPE_UNSPECIFIED,
151 NULL, rte_strerror(EIO));
155 /* Get generic flow operations structure from a port. */
156 const struct rte_flow_ops *
157 rte_flow_ops_get(uint16_t port_id, struct rte_flow_error *error)
159 struct rte_eth_dev *dev = &rte_eth_devices[port_id];
160 const struct rte_flow_ops *ops;
163 if (unlikely(!rte_eth_dev_is_valid_port(port_id)))
165 else if (unlikely(!dev->dev_ops->filter_ctrl ||
166 dev->dev_ops->filter_ctrl(dev,
167 RTE_ETH_FILTER_GENERIC,
174 rte_flow_error_set(error, code, RTE_FLOW_ERROR_TYPE_UNSPECIFIED,
175 NULL, rte_strerror(code));
179 /* Check whether a flow rule can be created on a given port. */
181 rte_flow_validate(uint16_t port_id,
182 const struct rte_flow_attr *attr,
183 const struct rte_flow_item pattern[],
184 const struct rte_flow_action actions[],
185 struct rte_flow_error *error)
187 const struct rte_flow_ops *ops = rte_flow_ops_get(port_id, error);
188 struct rte_eth_dev *dev = &rte_eth_devices[port_id];
192 if (likely(!!ops->validate))
193 return flow_err(port_id, ops->validate(dev, attr, pattern,
194 actions, error), error);
195 return rte_flow_error_set(error, ENOSYS,
196 RTE_FLOW_ERROR_TYPE_UNSPECIFIED,
197 NULL, rte_strerror(ENOSYS));
200 /* Create a flow rule on a given port. */
202 rte_flow_create(uint16_t port_id,
203 const struct rte_flow_attr *attr,
204 const struct rte_flow_item pattern[],
205 const struct rte_flow_action actions[],
206 struct rte_flow_error *error)
208 struct rte_eth_dev *dev = &rte_eth_devices[port_id];
209 struct rte_flow *flow;
210 const struct rte_flow_ops *ops = rte_flow_ops_get(port_id, error);
214 if (likely(!!ops->create)) {
215 flow = ops->create(dev, attr, pattern, actions, error);
217 flow_err(port_id, -rte_errno, error);
220 rte_flow_error_set(error, ENOSYS, RTE_FLOW_ERROR_TYPE_UNSPECIFIED,
221 NULL, rte_strerror(ENOSYS));
225 /* Destroy a flow rule on a given port. */
227 rte_flow_destroy(uint16_t port_id,
228 struct rte_flow *flow,
229 struct rte_flow_error *error)
231 struct rte_eth_dev *dev = &rte_eth_devices[port_id];
232 const struct rte_flow_ops *ops = rte_flow_ops_get(port_id, error);
236 if (likely(!!ops->destroy))
237 return flow_err(port_id, ops->destroy(dev, flow, error),
239 return rte_flow_error_set(error, ENOSYS,
240 RTE_FLOW_ERROR_TYPE_UNSPECIFIED,
241 NULL, rte_strerror(ENOSYS));
244 /* Destroy all flow rules associated with a port. */
246 rte_flow_flush(uint16_t port_id,
247 struct rte_flow_error *error)
249 struct rte_eth_dev *dev = &rte_eth_devices[port_id];
250 const struct rte_flow_ops *ops = rte_flow_ops_get(port_id, error);
254 if (likely(!!ops->flush))
255 return flow_err(port_id, ops->flush(dev, error), error);
256 return rte_flow_error_set(error, ENOSYS,
257 RTE_FLOW_ERROR_TYPE_UNSPECIFIED,
258 NULL, rte_strerror(ENOSYS));
261 /* Query an existing flow rule. */
263 rte_flow_query(uint16_t port_id,
264 struct rte_flow *flow,
265 const struct rte_flow_action *action,
267 struct rte_flow_error *error)
269 struct rte_eth_dev *dev = &rte_eth_devices[port_id];
270 const struct rte_flow_ops *ops = rte_flow_ops_get(port_id, error);
274 if (likely(!!ops->query))
275 return flow_err(port_id, ops->query(dev, flow, action, data,
277 return rte_flow_error_set(error, ENOSYS,
278 RTE_FLOW_ERROR_TYPE_UNSPECIFIED,
279 NULL, rte_strerror(ENOSYS));
282 /* Restrict ingress traffic to the defined flow rules. */
284 rte_flow_isolate(uint16_t port_id,
286 struct rte_flow_error *error)
288 struct rte_eth_dev *dev = &rte_eth_devices[port_id];
289 const struct rte_flow_ops *ops = rte_flow_ops_get(port_id, error);
293 if (likely(!!ops->isolate))
294 return flow_err(port_id, ops->isolate(dev, set, error), error);
295 return rte_flow_error_set(error, ENOSYS,
296 RTE_FLOW_ERROR_TYPE_UNSPECIFIED,
297 NULL, rte_strerror(ENOSYS));
300 /* Initialize flow error structure. */
302 rte_flow_error_set(struct rte_flow_error *error,
304 enum rte_flow_error_type type,
309 *error = (struct rte_flow_error){
319 /** Pattern item specification types. */
320 enum rte_flow_conv_item_spec_type {
321 RTE_FLOW_CONV_ITEM_SPEC,
322 RTE_FLOW_CONV_ITEM_LAST,
323 RTE_FLOW_CONV_ITEM_MASK,
327 * Copy pattern item specification.
330 * Output buffer. Can be NULL if @p size is zero.
332 * Size of @p buf in bytes.
334 * Pattern item to copy specification from.
336 * Specification selector for either @p spec, @p last or @p mask.
339 * Number of bytes needed to store pattern item specification regardless
340 * of @p size. @p buf contents are truncated to @p size if not large
344 rte_flow_conv_item_spec(void *buf, const size_t size,
345 const struct rte_flow_item *item,
346 enum rte_flow_conv_item_spec_type type)
350 type == RTE_FLOW_CONV_ITEM_SPEC ? item->spec :
351 type == RTE_FLOW_CONV_ITEM_LAST ? item->last :
352 type == RTE_FLOW_CONV_ITEM_MASK ? item->mask :
355 switch (item->type) {
357 const struct rte_flow_item_raw *raw;
360 const struct rte_flow_item_raw *raw;
363 const struct rte_flow_item_raw *raw;
366 const struct rte_flow_item_raw *raw;
369 struct rte_flow_item_raw *raw;
373 case RTE_FLOW_ITEM_TYPE_RAW:
374 spec.raw = item->spec;
375 last.raw = item->last ? item->last : item->spec;
376 mask.raw = item->mask ? item->mask : &rte_flow_item_raw_mask;
380 (&(struct rte_flow_item_raw){
381 .relative = src.raw->relative,
382 .search = src.raw->search,
383 .reserved = src.raw->reserved,
384 .offset = src.raw->offset,
385 .limit = src.raw->limit,
386 .length = src.raw->length,
388 size > sizeof(*dst.raw) ? sizeof(*dst.raw) : size);
389 off = sizeof(*dst.raw);
390 if (type == RTE_FLOW_CONV_ITEM_SPEC ||
391 (type == RTE_FLOW_CONV_ITEM_MASK &&
392 ((spec.raw->length & mask.raw->length) >=
393 (last.raw->length & mask.raw->length))))
394 tmp = spec.raw->length & mask.raw->length;
396 tmp = last.raw->length & mask.raw->length;
398 off = RTE_ALIGN_CEIL(off, sizeof(*dst.raw->pattern));
399 if (size >= off + tmp)
400 dst.raw->pattern = rte_memcpy
401 ((void *)((uintptr_t)dst.raw + off),
402 src.raw->pattern, tmp);
407 off = rte_flow_desc_item[item->type].size;
408 rte_memcpy(buf, data, (size > off ? off : size));
415 * Copy action configuration.
418 * Output buffer. Can be NULL if @p size is zero.
420 * Size of @p buf in bytes.
422 * Action to copy configuration from.
425 * Number of bytes needed to store pattern item specification regardless
426 * of @p size. @p buf contents are truncated to @p size if not large
430 rte_flow_conv_action_conf(void *buf, const size_t size,
431 const struct rte_flow_action *action)
435 switch (action->type) {
437 const struct rte_flow_action_rss *rss;
438 const struct rte_flow_action_vxlan_encap *vxlan_encap;
439 const struct rte_flow_action_nvgre_encap *nvgre_encap;
442 struct rte_flow_action_rss *rss;
443 struct rte_flow_action_vxlan_encap *vxlan_encap;
444 struct rte_flow_action_nvgre_encap *nvgre_encap;
449 case RTE_FLOW_ACTION_TYPE_RSS:
450 src.rss = action->conf;
453 (&(struct rte_flow_action_rss){
454 .func = src.rss->func,
455 .level = src.rss->level,
456 .types = src.rss->types,
457 .key_len = src.rss->key_len,
458 .queue_num = src.rss->queue_num,
460 size > sizeof(*dst.rss) ? sizeof(*dst.rss) : size);
461 off = sizeof(*dst.rss);
462 if (src.rss->key_len) {
463 off = RTE_ALIGN_CEIL(off, sizeof(*dst.rss->key));
464 tmp = sizeof(*src.rss->key) * src.rss->key_len;
465 if (size >= off + tmp)
466 dst.rss->key = rte_memcpy
467 ((void *)((uintptr_t)dst.rss + off),
471 if (src.rss->queue_num) {
472 off = RTE_ALIGN_CEIL(off, sizeof(*dst.rss->queue));
473 tmp = sizeof(*src.rss->queue) * src.rss->queue_num;
474 if (size >= off + tmp)
475 dst.rss->queue = rte_memcpy
476 ((void *)((uintptr_t)dst.rss + off),
477 src.rss->queue, tmp);
481 case RTE_FLOW_ACTION_TYPE_VXLAN_ENCAP:
482 case RTE_FLOW_ACTION_TYPE_NVGRE_ENCAP:
483 src.vxlan_encap = action->conf;
484 dst.vxlan_encap = buf;
485 RTE_BUILD_BUG_ON(sizeof(*src.vxlan_encap) !=
486 sizeof(*src.nvgre_encap) ||
487 offsetof(struct rte_flow_action_vxlan_encap,
489 offsetof(struct rte_flow_action_nvgre_encap,
491 off = sizeof(*dst.vxlan_encap);
492 if (src.vxlan_encap->definition) {
494 (off, sizeof(*dst.vxlan_encap->definition));
496 (RTE_FLOW_CONV_OP_PATTERN,
497 (void *)((uintptr_t)dst.vxlan_encap + off),
498 size > off ? size - off : 0,
499 src.vxlan_encap->definition, NULL);
502 if (size >= off + ret)
503 dst.vxlan_encap->definition =
504 (void *)((uintptr_t)dst.vxlan_encap +
510 off = rte_flow_desc_action[action->type].size;
511 rte_memcpy(buf, action->conf, (size > off ? off : size));
518 * Copy a list of pattern items.
521 * Destination buffer. Can be NULL if @p size is zero.
523 * Size of @p dst in bytes.
525 * Source pattern items.
527 * Maximum number of pattern items to process from @p src or 0 to process
528 * the entire list. In both cases, processing stops after
529 * RTE_FLOW_ITEM_TYPE_END is encountered.
531 * Perform verbose error reporting if not NULL.
534 * A positive value representing the number of bytes needed to store
535 * pattern items regardless of @p size on success (@p buf contents are
536 * truncated to @p size if not large enough), a negative errno value
537 * otherwise and rte_errno is set.
540 rte_flow_conv_pattern(struct rte_flow_item *dst,
542 const struct rte_flow_item *src,
544 struct rte_flow_error *error)
546 uintptr_t data = (uintptr_t)dst;
551 for (i = 0, off = 0; !num || i != num; ++i, ++src, ++dst) {
552 if ((size_t)src->type >= RTE_DIM(rte_flow_desc_item) ||
553 !rte_flow_desc_item[src->type].name)
554 return rte_flow_error_set
555 (error, ENOTSUP, RTE_FLOW_ERROR_TYPE_ITEM, src,
556 "cannot convert unknown item type");
557 if (size >= off + sizeof(*dst))
558 *dst = (struct rte_flow_item){
570 off = RTE_ALIGN_CEIL(off, sizeof(double));
571 ret = rte_flow_conv_item_spec
572 ((void *)(data + off),
573 size > off ? size - off : 0, src,
574 RTE_FLOW_CONV_ITEM_SPEC);
575 if (size && size >= off + ret)
576 dst->spec = (void *)(data + off);
581 off = RTE_ALIGN_CEIL(off, sizeof(double));
582 ret = rte_flow_conv_item_spec
583 ((void *)(data + off),
584 size > off ? size - off : 0, src,
585 RTE_FLOW_CONV_ITEM_LAST);
586 if (size && size >= off + ret)
587 dst->last = (void *)(data + off);
591 off = RTE_ALIGN_CEIL(off, sizeof(double));
592 ret = rte_flow_conv_item_spec
593 ((void *)(data + off),
594 size > off ? size - off : 0, src,
595 RTE_FLOW_CONV_ITEM_MASK);
596 if (size && size >= off + ret)
597 dst->mask = (void *)(data + off);
607 * Copy a list of actions.
610 * Destination buffer. Can be NULL if @p size is zero.
612 * Size of @p dst in bytes.
616 * Maximum number of actions to process from @p src or 0 to process the
617 * entire list. In both cases, processing stops after
618 * RTE_FLOW_ACTION_TYPE_END is encountered.
620 * Perform verbose error reporting if not NULL.
623 * A positive value representing the number of bytes needed to store
624 * actions regardless of @p size on success (@p buf contents are truncated
625 * to @p size if not large enough), a negative errno value otherwise and
629 rte_flow_conv_actions(struct rte_flow_action *dst,
631 const struct rte_flow_action *src,
633 struct rte_flow_error *error)
635 uintptr_t data = (uintptr_t)dst;
640 for (i = 0, off = 0; !num || i != num; ++i, ++src, ++dst) {
641 if ((size_t)src->type >= RTE_DIM(rte_flow_desc_action) ||
642 !rte_flow_desc_action[src->type].name)
643 return rte_flow_error_set
644 (error, ENOTSUP, RTE_FLOW_ERROR_TYPE_ACTION,
645 src, "cannot convert unknown action type");
646 if (size >= off + sizeof(*dst))
647 *dst = (struct rte_flow_action){
659 off = RTE_ALIGN_CEIL(off, sizeof(double));
660 ret = rte_flow_conv_action_conf
661 ((void *)(data + off),
662 size > off ? size - off : 0, src);
663 if (size && size >= off + ret)
664 dst->conf = (void *)(data + off);
674 * Copy flow rule components.
676 * This comprises the flow rule descriptor itself, attributes, pattern and
677 * actions list. NULL components in @p src are skipped.
680 * Destination buffer. Can be NULL if @p size is zero.
682 * Size of @p dst in bytes.
684 * Source flow rule descriptor.
686 * Perform verbose error reporting if not NULL.
689 * A positive value representing the number of bytes needed to store all
690 * components including the descriptor regardless of @p size on success
691 * (@p buf contents are truncated to @p size if not large enough), a
692 * negative errno value otherwise and rte_errno is set.
695 rte_flow_conv_rule(struct rte_flow_conv_rule *dst,
697 const struct rte_flow_conv_rule *src,
698 struct rte_flow_error *error)
704 (&(struct rte_flow_conv_rule){
709 size > sizeof(*dst) ? sizeof(*dst) : size);
712 off = RTE_ALIGN_CEIL(off, sizeof(double));
713 if (size && size >= off + sizeof(*dst->attr))
714 dst->attr = rte_memcpy
715 ((void *)((uintptr_t)dst + off),
716 src->attr_ro, sizeof(*dst->attr));
717 off += sizeof(*dst->attr);
719 if (src->pattern_ro) {
720 off = RTE_ALIGN_CEIL(off, sizeof(double));
721 ret = rte_flow_conv_pattern((void *)((uintptr_t)dst + off),
722 size > off ? size - off : 0,
723 src->pattern_ro, 0, error);
726 if (size && size >= off + (size_t)ret)
727 dst->pattern = (void *)((uintptr_t)dst + off);
730 if (src->actions_ro) {
731 off = RTE_ALIGN_CEIL(off, sizeof(double));
732 ret = rte_flow_conv_actions((void *)((uintptr_t)dst + off),
733 size > off ? size - off : 0,
734 src->actions_ro, 0, error);
737 if (size >= off + (size_t)ret)
738 dst->actions = (void *)((uintptr_t)dst + off);
745 * Retrieve the name of a pattern item/action type.
748 * Nonzero when @p src represents an action type instead of a pattern item
751 * Nonzero to write string address instead of contents into @p dst.
753 * Destination buffer. Can be NULL if @p size is zero.
755 * Size of @p dst in bytes.
757 * Depending on @p is_action, source pattern item or action type cast as a
760 * Perform verbose error reporting if not NULL.
763 * A positive value representing the number of bytes needed to store the
764 * name or its address regardless of @p size on success (@p buf contents
765 * are truncated to @p size if not large enough), a negative errno value
766 * otherwise and rte_errno is set.
769 rte_flow_conv_name(int is_action,
774 struct rte_flow_error *error)
777 const struct rte_flow_desc_data *data;
780 static const struct desc_info info_rep[2] = {
781 { rte_flow_desc_item, RTE_DIM(rte_flow_desc_item), },
782 { rte_flow_desc_action, RTE_DIM(rte_flow_desc_action), },
784 const struct desc_info *const info = &info_rep[!!is_action];
785 unsigned int type = (uintptr_t)src;
787 if (type >= info->num)
788 return rte_flow_error_set
789 (error, EINVAL, RTE_FLOW_ERROR_TYPE_UNSPECIFIED, NULL,
790 "unknown object type to retrieve the name of");
792 return strlcpy(dst, info->data[type].name, size);
793 if (size >= sizeof(const char **))
794 *((const char **)dst) = info->data[type].name;
795 return sizeof(const char **);
798 /** Helper function to convert flow API objects. */
800 rte_flow_conv(enum rte_flow_conv_op op,
804 struct rte_flow_error *error)
807 const struct rte_flow_attr *attr;
809 case RTE_FLOW_CONV_OP_NONE:
811 case RTE_FLOW_CONV_OP_ATTR:
813 if (size > sizeof(*attr))
814 size = sizeof(*attr);
815 rte_memcpy(dst, attr, size);
816 return sizeof(*attr);
817 case RTE_FLOW_CONV_OP_ITEM:
818 return rte_flow_conv_pattern(dst, size, src, 1, error);
819 case RTE_FLOW_CONV_OP_ACTION:
820 return rte_flow_conv_actions(dst, size, src, 1, error);
821 case RTE_FLOW_CONV_OP_PATTERN:
822 return rte_flow_conv_pattern(dst, size, src, 0, error);
823 case RTE_FLOW_CONV_OP_ACTIONS:
824 return rte_flow_conv_actions(dst, size, src, 0, error);
825 case RTE_FLOW_CONV_OP_RULE:
826 return rte_flow_conv_rule(dst, size, src, error);
827 case RTE_FLOW_CONV_OP_ITEM_NAME:
828 return rte_flow_conv_name(0, 0, dst, size, src, error);
829 case RTE_FLOW_CONV_OP_ACTION_NAME:
830 return rte_flow_conv_name(1, 0, dst, size, src, error);
831 case RTE_FLOW_CONV_OP_ITEM_NAME_PTR:
832 return rte_flow_conv_name(0, 1, dst, size, src, error);
833 case RTE_FLOW_CONV_OP_ACTION_NAME_PTR:
834 return rte_flow_conv_name(1, 1, dst, size, src, error);
836 return rte_flow_error_set
837 (error, ENOTSUP, RTE_FLOW_ERROR_TYPE_UNSPECIFIED, NULL,
838 "unknown object conversion operation");
841 /** Store a full rte_flow description. */
843 rte_flow_copy(struct rte_flow_desc *desc, size_t len,
844 const struct rte_flow_attr *attr,
845 const struct rte_flow_item *items,
846 const struct rte_flow_action *actions)
849 * Overlap struct rte_flow_conv with struct rte_flow_desc in order
850 * to convert the former to the latter without wasting space.
852 struct rte_flow_conv_rule *dst =
854 (void *)((uintptr_t)desc +
855 (offsetof(struct rte_flow_desc, actions) -
856 offsetof(struct rte_flow_conv_rule, actions))) :
859 len > sizeof(*desc) - sizeof(*dst) ?
860 len - (sizeof(*desc) - sizeof(*dst)) :
862 struct rte_flow_conv_rule src = {
865 .actions_ro = actions,
869 RTE_BUILD_BUG_ON(sizeof(struct rte_flow_desc) <
870 sizeof(struct rte_flow_conv_rule));
872 (&dst->pattern != &desc->items ||
873 &dst->actions != &desc->actions ||
874 (uintptr_t)(dst + 1) != (uintptr_t)(desc + 1))) {
878 ret = rte_flow_conv(RTE_FLOW_CONV_OP_RULE, dst, dst_size, &src, NULL);
881 ret += sizeof(*desc) - sizeof(*dst);
883 (&(struct rte_flow_desc){
886 .items = dst_size ? dst->pattern : NULL,
887 .actions = dst_size ? dst->actions : NULL,
889 len > sizeof(*desc) ? sizeof(*desc) : len);
894 * Expand RSS flows into several possible flows according to the RSS hash
895 * fields requested and the driver capabilities.
897 int __rte_experimental
898 rte_flow_expand_rss(struct rte_flow_expand_rss *buf, size_t size,
899 const struct rte_flow_item *pattern, uint64_t types,
900 const struct rte_flow_expand_node graph[],
901 int graph_root_index)
904 const struct rte_flow_item *item;
905 const struct rte_flow_expand_node *node = &graph[graph_root_index];
906 const int *next_node;
907 const int *stack[elt_n];
909 struct rte_flow_item flow_items[elt_n];
912 size_t user_pattern_size = 0;
915 lsize = offsetof(struct rte_flow_expand_rss, entry) +
916 elt_n * sizeof(buf->entry[0]);
918 buf->entry[0].priority = 0;
919 buf->entry[0].pattern = (void *)&buf->entry[elt_n];
921 addr = buf->entry[0].pattern;
923 for (item = pattern; item->type != RTE_FLOW_ITEM_TYPE_END; item++) {
924 const struct rte_flow_expand_node *next = NULL;
926 for (i = 0; node->next && node->next[i]; ++i) {
927 next = &graph[node->next[i]];
928 if (next->type == item->type)
933 user_pattern_size += sizeof(*item);
935 user_pattern_size += sizeof(*item); /* Handle END item. */
936 lsize += user_pattern_size;
937 /* Copy the user pattern in the first entry of the buffer. */
939 rte_memcpy(addr, pattern, user_pattern_size);
940 addr = (void *)(((uintptr_t)addr) + user_pattern_size);
943 /* Start expanding. */
944 memset(flow_items, 0, sizeof(flow_items));
945 user_pattern_size -= sizeof(*item);
946 next_node = node->next;
947 stack[stack_pos] = next_node;
948 node = next_node ? &graph[*next_node] : NULL;
950 flow_items[stack_pos].type = node->type;
951 if (node->rss_types & types) {
953 * compute the number of items to copy from the
954 * expansion and copy it.
955 * When the stack_pos is 0, there are 1 element in it,
956 * plus the addition END item.
958 int elt = stack_pos + 2;
960 flow_items[stack_pos + 1].type = RTE_FLOW_ITEM_TYPE_END;
961 lsize += elt * sizeof(*item) + user_pattern_size;
963 size_t n = elt * sizeof(*item);
965 buf->entry[buf->entries].priority =
967 buf->entry[buf->entries].pattern = addr;
969 rte_memcpy(addr, buf->entry[0].pattern,
971 addr = (void *)(((uintptr_t)addr) +
973 rte_memcpy(addr, flow_items, n);
974 addr = (void *)(((uintptr_t)addr) + n);
979 next_node = node->next;
980 if (stack_pos++ == elt_n) {
984 stack[stack_pos] = next_node;
985 } else if (*(next_node + 1)) {
986 /* Follow up with the next possibility. */
989 /* Move to the next path. */
991 next_node = stack[--stack_pos];
993 stack[stack_pos] = next_node;
995 node = *next_node ? &graph[*next_node] : NULL;