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)),
141 MK_FLOW_ACTION(SET_MAC_SRC, sizeof(struct rte_flow_action_set_mac)),
142 MK_FLOW_ACTION(SET_MAC_DST, sizeof(struct rte_flow_action_set_mac)),
146 flow_err(uint16_t port_id, int ret, struct rte_flow_error *error)
150 if (rte_eth_dev_is_removed(port_id))
151 return rte_flow_error_set(error, EIO,
152 RTE_FLOW_ERROR_TYPE_UNSPECIFIED,
153 NULL, rte_strerror(EIO));
157 /* Get generic flow operations structure from a port. */
158 const struct rte_flow_ops *
159 rte_flow_ops_get(uint16_t port_id, struct rte_flow_error *error)
161 struct rte_eth_dev *dev = &rte_eth_devices[port_id];
162 const struct rte_flow_ops *ops;
165 if (unlikely(!rte_eth_dev_is_valid_port(port_id)))
167 else if (unlikely(!dev->dev_ops->filter_ctrl ||
168 dev->dev_ops->filter_ctrl(dev,
169 RTE_ETH_FILTER_GENERIC,
176 rte_flow_error_set(error, code, RTE_FLOW_ERROR_TYPE_UNSPECIFIED,
177 NULL, rte_strerror(code));
181 /* Check whether a flow rule can be created on a given port. */
183 rte_flow_validate(uint16_t port_id,
184 const struct rte_flow_attr *attr,
185 const struct rte_flow_item pattern[],
186 const struct rte_flow_action actions[],
187 struct rte_flow_error *error)
189 const struct rte_flow_ops *ops = rte_flow_ops_get(port_id, error);
190 struct rte_eth_dev *dev = &rte_eth_devices[port_id];
194 if (likely(!!ops->validate))
195 return flow_err(port_id, ops->validate(dev, attr, pattern,
196 actions, error), error);
197 return rte_flow_error_set(error, ENOSYS,
198 RTE_FLOW_ERROR_TYPE_UNSPECIFIED,
199 NULL, rte_strerror(ENOSYS));
202 /* Create a flow rule on a given port. */
204 rte_flow_create(uint16_t port_id,
205 const struct rte_flow_attr *attr,
206 const struct rte_flow_item pattern[],
207 const struct rte_flow_action actions[],
208 struct rte_flow_error *error)
210 struct rte_eth_dev *dev = &rte_eth_devices[port_id];
211 struct rte_flow *flow;
212 const struct rte_flow_ops *ops = rte_flow_ops_get(port_id, error);
216 if (likely(!!ops->create)) {
217 flow = ops->create(dev, attr, pattern, actions, error);
219 flow_err(port_id, -rte_errno, error);
222 rte_flow_error_set(error, ENOSYS, RTE_FLOW_ERROR_TYPE_UNSPECIFIED,
223 NULL, rte_strerror(ENOSYS));
227 /* Destroy a flow rule on a given port. */
229 rte_flow_destroy(uint16_t port_id,
230 struct rte_flow *flow,
231 struct rte_flow_error *error)
233 struct rte_eth_dev *dev = &rte_eth_devices[port_id];
234 const struct rte_flow_ops *ops = rte_flow_ops_get(port_id, error);
238 if (likely(!!ops->destroy))
239 return flow_err(port_id, ops->destroy(dev, flow, error),
241 return rte_flow_error_set(error, ENOSYS,
242 RTE_FLOW_ERROR_TYPE_UNSPECIFIED,
243 NULL, rte_strerror(ENOSYS));
246 /* Destroy all flow rules associated with a port. */
248 rte_flow_flush(uint16_t port_id,
249 struct rte_flow_error *error)
251 struct rte_eth_dev *dev = &rte_eth_devices[port_id];
252 const struct rte_flow_ops *ops = rte_flow_ops_get(port_id, error);
256 if (likely(!!ops->flush))
257 return flow_err(port_id, ops->flush(dev, error), error);
258 return rte_flow_error_set(error, ENOSYS,
259 RTE_FLOW_ERROR_TYPE_UNSPECIFIED,
260 NULL, rte_strerror(ENOSYS));
263 /* Query an existing flow rule. */
265 rte_flow_query(uint16_t port_id,
266 struct rte_flow *flow,
267 const struct rte_flow_action *action,
269 struct rte_flow_error *error)
271 struct rte_eth_dev *dev = &rte_eth_devices[port_id];
272 const struct rte_flow_ops *ops = rte_flow_ops_get(port_id, error);
276 if (likely(!!ops->query))
277 return flow_err(port_id, ops->query(dev, flow, action, data,
279 return rte_flow_error_set(error, ENOSYS,
280 RTE_FLOW_ERROR_TYPE_UNSPECIFIED,
281 NULL, rte_strerror(ENOSYS));
284 /* Restrict ingress traffic to the defined flow rules. */
286 rte_flow_isolate(uint16_t port_id,
288 struct rte_flow_error *error)
290 struct rte_eth_dev *dev = &rte_eth_devices[port_id];
291 const struct rte_flow_ops *ops = rte_flow_ops_get(port_id, error);
295 if (likely(!!ops->isolate))
296 return flow_err(port_id, ops->isolate(dev, set, error), error);
297 return rte_flow_error_set(error, ENOSYS,
298 RTE_FLOW_ERROR_TYPE_UNSPECIFIED,
299 NULL, rte_strerror(ENOSYS));
302 /* Initialize flow error structure. */
304 rte_flow_error_set(struct rte_flow_error *error,
306 enum rte_flow_error_type type,
311 *error = (struct rte_flow_error){
321 /** Pattern item specification types. */
322 enum rte_flow_conv_item_spec_type {
323 RTE_FLOW_CONV_ITEM_SPEC,
324 RTE_FLOW_CONV_ITEM_LAST,
325 RTE_FLOW_CONV_ITEM_MASK,
329 * Copy pattern item specification.
332 * Output buffer. Can be NULL if @p size is zero.
334 * Size of @p buf in bytes.
336 * Pattern item to copy specification from.
338 * Specification selector for either @p spec, @p last or @p mask.
341 * Number of bytes needed to store pattern item specification regardless
342 * of @p size. @p buf contents are truncated to @p size if not large
346 rte_flow_conv_item_spec(void *buf, const size_t size,
347 const struct rte_flow_item *item,
348 enum rte_flow_conv_item_spec_type type)
352 type == RTE_FLOW_CONV_ITEM_SPEC ? item->spec :
353 type == RTE_FLOW_CONV_ITEM_LAST ? item->last :
354 type == RTE_FLOW_CONV_ITEM_MASK ? item->mask :
357 switch (item->type) {
359 const struct rte_flow_item_raw *raw;
362 const struct rte_flow_item_raw *raw;
365 const struct rte_flow_item_raw *raw;
368 const struct rte_flow_item_raw *raw;
371 struct rte_flow_item_raw *raw;
375 case RTE_FLOW_ITEM_TYPE_RAW:
376 spec.raw = item->spec;
377 last.raw = item->last ? item->last : item->spec;
378 mask.raw = item->mask ? item->mask : &rte_flow_item_raw_mask;
382 (&(struct rte_flow_item_raw){
383 .relative = src.raw->relative,
384 .search = src.raw->search,
385 .reserved = src.raw->reserved,
386 .offset = src.raw->offset,
387 .limit = src.raw->limit,
388 .length = src.raw->length,
390 size > sizeof(*dst.raw) ? sizeof(*dst.raw) : size);
391 off = sizeof(*dst.raw);
392 if (type == RTE_FLOW_CONV_ITEM_SPEC ||
393 (type == RTE_FLOW_CONV_ITEM_MASK &&
394 ((spec.raw->length & mask.raw->length) >=
395 (last.raw->length & mask.raw->length))))
396 tmp = spec.raw->length & mask.raw->length;
398 tmp = last.raw->length & mask.raw->length;
400 off = RTE_ALIGN_CEIL(off, sizeof(*dst.raw->pattern));
401 if (size >= off + tmp)
402 dst.raw->pattern = rte_memcpy
403 ((void *)((uintptr_t)dst.raw + off),
404 src.raw->pattern, tmp);
409 off = rte_flow_desc_item[item->type].size;
410 rte_memcpy(buf, data, (size > off ? off : size));
417 * Copy action configuration.
420 * Output buffer. Can be NULL if @p size is zero.
422 * Size of @p buf in bytes.
424 * Action to copy configuration from.
427 * Number of bytes needed to store pattern item specification regardless
428 * of @p size. @p buf contents are truncated to @p size if not large
432 rte_flow_conv_action_conf(void *buf, const size_t size,
433 const struct rte_flow_action *action)
437 switch (action->type) {
439 const struct rte_flow_action_rss *rss;
440 const struct rte_flow_action_vxlan_encap *vxlan_encap;
441 const struct rte_flow_action_nvgre_encap *nvgre_encap;
444 struct rte_flow_action_rss *rss;
445 struct rte_flow_action_vxlan_encap *vxlan_encap;
446 struct rte_flow_action_nvgre_encap *nvgre_encap;
451 case RTE_FLOW_ACTION_TYPE_RSS:
452 src.rss = action->conf;
455 (&(struct rte_flow_action_rss){
456 .func = src.rss->func,
457 .level = src.rss->level,
458 .types = src.rss->types,
459 .key_len = src.rss->key_len,
460 .queue_num = src.rss->queue_num,
462 size > sizeof(*dst.rss) ? sizeof(*dst.rss) : size);
463 off = sizeof(*dst.rss);
464 if (src.rss->key_len) {
465 off = RTE_ALIGN_CEIL(off, sizeof(*dst.rss->key));
466 tmp = sizeof(*src.rss->key) * src.rss->key_len;
467 if (size >= off + tmp)
468 dst.rss->key = rte_memcpy
469 ((void *)((uintptr_t)dst.rss + off),
473 if (src.rss->queue_num) {
474 off = RTE_ALIGN_CEIL(off, sizeof(*dst.rss->queue));
475 tmp = sizeof(*src.rss->queue) * src.rss->queue_num;
476 if (size >= off + tmp)
477 dst.rss->queue = rte_memcpy
478 ((void *)((uintptr_t)dst.rss + off),
479 src.rss->queue, tmp);
483 case RTE_FLOW_ACTION_TYPE_VXLAN_ENCAP:
484 case RTE_FLOW_ACTION_TYPE_NVGRE_ENCAP:
485 src.vxlan_encap = action->conf;
486 dst.vxlan_encap = buf;
487 RTE_BUILD_BUG_ON(sizeof(*src.vxlan_encap) !=
488 sizeof(*src.nvgre_encap) ||
489 offsetof(struct rte_flow_action_vxlan_encap,
491 offsetof(struct rte_flow_action_nvgre_encap,
493 off = sizeof(*dst.vxlan_encap);
494 if (src.vxlan_encap->definition) {
496 (off, sizeof(*dst.vxlan_encap->definition));
498 (RTE_FLOW_CONV_OP_PATTERN,
499 (void *)((uintptr_t)dst.vxlan_encap + off),
500 size > off ? size - off : 0,
501 src.vxlan_encap->definition, NULL);
504 if (size >= off + ret)
505 dst.vxlan_encap->definition =
506 (void *)((uintptr_t)dst.vxlan_encap +
512 off = rte_flow_desc_action[action->type].size;
513 rte_memcpy(buf, action->conf, (size > off ? off : size));
520 * Copy a list of pattern items.
523 * Destination buffer. Can be NULL if @p size is zero.
525 * Size of @p dst in bytes.
527 * Source pattern items.
529 * Maximum number of pattern items to process from @p src or 0 to process
530 * the entire list. In both cases, processing stops after
531 * RTE_FLOW_ITEM_TYPE_END is encountered.
533 * Perform verbose error reporting if not NULL.
536 * A positive value representing the number of bytes needed to store
537 * pattern items regardless of @p size on success (@p buf contents are
538 * truncated to @p size if not large enough), a negative errno value
539 * otherwise and rte_errno is set.
542 rte_flow_conv_pattern(struct rte_flow_item *dst,
544 const struct rte_flow_item *src,
546 struct rte_flow_error *error)
548 uintptr_t data = (uintptr_t)dst;
553 for (i = 0, off = 0; !num || i != num; ++i, ++src, ++dst) {
554 if ((size_t)src->type >= RTE_DIM(rte_flow_desc_item) ||
555 !rte_flow_desc_item[src->type].name)
556 return rte_flow_error_set
557 (error, ENOTSUP, RTE_FLOW_ERROR_TYPE_ITEM, src,
558 "cannot convert unknown item type");
559 if (size >= off + sizeof(*dst))
560 *dst = (struct rte_flow_item){
572 off = RTE_ALIGN_CEIL(off, sizeof(double));
573 ret = rte_flow_conv_item_spec
574 ((void *)(data + off),
575 size > off ? size - off : 0, src,
576 RTE_FLOW_CONV_ITEM_SPEC);
577 if (size && size >= off + ret)
578 dst->spec = (void *)(data + off);
583 off = RTE_ALIGN_CEIL(off, sizeof(double));
584 ret = rte_flow_conv_item_spec
585 ((void *)(data + off),
586 size > off ? size - off : 0, src,
587 RTE_FLOW_CONV_ITEM_LAST);
588 if (size && size >= off + ret)
589 dst->last = (void *)(data + off);
593 off = RTE_ALIGN_CEIL(off, sizeof(double));
594 ret = rte_flow_conv_item_spec
595 ((void *)(data + off),
596 size > off ? size - off : 0, src,
597 RTE_FLOW_CONV_ITEM_MASK);
598 if (size && size >= off + ret)
599 dst->mask = (void *)(data + off);
609 * Copy a list of actions.
612 * Destination buffer. Can be NULL if @p size is zero.
614 * Size of @p dst in bytes.
618 * Maximum number of actions to process from @p src or 0 to process the
619 * entire list. In both cases, processing stops after
620 * RTE_FLOW_ACTION_TYPE_END is encountered.
622 * Perform verbose error reporting if not NULL.
625 * A positive value representing the number of bytes needed to store
626 * actions regardless of @p size on success (@p buf contents are truncated
627 * to @p size if not large enough), a negative errno value otherwise and
631 rte_flow_conv_actions(struct rte_flow_action *dst,
633 const struct rte_flow_action *src,
635 struct rte_flow_error *error)
637 uintptr_t data = (uintptr_t)dst;
642 for (i = 0, off = 0; !num || i != num; ++i, ++src, ++dst) {
643 if ((size_t)src->type >= RTE_DIM(rte_flow_desc_action) ||
644 !rte_flow_desc_action[src->type].name)
645 return rte_flow_error_set
646 (error, ENOTSUP, RTE_FLOW_ERROR_TYPE_ACTION,
647 src, "cannot convert unknown action type");
648 if (size >= off + sizeof(*dst))
649 *dst = (struct rte_flow_action){
661 off = RTE_ALIGN_CEIL(off, sizeof(double));
662 ret = rte_flow_conv_action_conf
663 ((void *)(data + off),
664 size > off ? size - off : 0, src);
665 if (size && size >= off + ret)
666 dst->conf = (void *)(data + off);
676 * Copy flow rule components.
678 * This comprises the flow rule descriptor itself, attributes, pattern and
679 * actions list. NULL components in @p src are skipped.
682 * Destination buffer. Can be NULL if @p size is zero.
684 * Size of @p dst in bytes.
686 * Source flow rule descriptor.
688 * Perform verbose error reporting if not NULL.
691 * A positive value representing the number of bytes needed to store all
692 * components including the descriptor regardless of @p size on success
693 * (@p buf contents are truncated to @p size if not large enough), a
694 * negative errno value otherwise and rte_errno is set.
697 rte_flow_conv_rule(struct rte_flow_conv_rule *dst,
699 const struct rte_flow_conv_rule *src,
700 struct rte_flow_error *error)
706 (&(struct rte_flow_conv_rule){
711 size > sizeof(*dst) ? sizeof(*dst) : size);
714 off = RTE_ALIGN_CEIL(off, sizeof(double));
715 if (size && size >= off + sizeof(*dst->attr))
716 dst->attr = rte_memcpy
717 ((void *)((uintptr_t)dst + off),
718 src->attr_ro, sizeof(*dst->attr));
719 off += sizeof(*dst->attr);
721 if (src->pattern_ro) {
722 off = RTE_ALIGN_CEIL(off, sizeof(double));
723 ret = rte_flow_conv_pattern((void *)((uintptr_t)dst + off),
724 size > off ? size - off : 0,
725 src->pattern_ro, 0, error);
728 if (size && size >= off + (size_t)ret)
729 dst->pattern = (void *)((uintptr_t)dst + off);
732 if (src->actions_ro) {
733 off = RTE_ALIGN_CEIL(off, sizeof(double));
734 ret = rte_flow_conv_actions((void *)((uintptr_t)dst + off),
735 size > off ? size - off : 0,
736 src->actions_ro, 0, error);
739 if (size >= off + (size_t)ret)
740 dst->actions = (void *)((uintptr_t)dst + off);
747 * Retrieve the name of a pattern item/action type.
750 * Nonzero when @p src represents an action type instead of a pattern item
753 * Nonzero to write string address instead of contents into @p dst.
755 * Destination buffer. Can be NULL if @p size is zero.
757 * Size of @p dst in bytes.
759 * Depending on @p is_action, source pattern item or action type cast as a
762 * Perform verbose error reporting if not NULL.
765 * A positive value representing the number of bytes needed to store the
766 * name or its address regardless of @p size on success (@p buf contents
767 * are truncated to @p size if not large enough), a negative errno value
768 * otherwise and rte_errno is set.
771 rte_flow_conv_name(int is_action,
776 struct rte_flow_error *error)
779 const struct rte_flow_desc_data *data;
782 static const struct desc_info info_rep[2] = {
783 { rte_flow_desc_item, RTE_DIM(rte_flow_desc_item), },
784 { rte_flow_desc_action, RTE_DIM(rte_flow_desc_action), },
786 const struct desc_info *const info = &info_rep[!!is_action];
787 unsigned int type = (uintptr_t)src;
789 if (type >= info->num)
790 return rte_flow_error_set
791 (error, EINVAL, RTE_FLOW_ERROR_TYPE_UNSPECIFIED, NULL,
792 "unknown object type to retrieve the name of");
794 return strlcpy(dst, info->data[type].name, size);
795 if (size >= sizeof(const char **))
796 *((const char **)dst) = info->data[type].name;
797 return sizeof(const char **);
800 /** Helper function to convert flow API objects. */
802 rte_flow_conv(enum rte_flow_conv_op op,
806 struct rte_flow_error *error)
809 const struct rte_flow_attr *attr;
811 case RTE_FLOW_CONV_OP_NONE:
813 case RTE_FLOW_CONV_OP_ATTR:
815 if (size > sizeof(*attr))
816 size = sizeof(*attr);
817 rte_memcpy(dst, attr, size);
818 return sizeof(*attr);
819 case RTE_FLOW_CONV_OP_ITEM:
820 return rte_flow_conv_pattern(dst, size, src, 1, error);
821 case RTE_FLOW_CONV_OP_ACTION:
822 return rte_flow_conv_actions(dst, size, src, 1, error);
823 case RTE_FLOW_CONV_OP_PATTERN:
824 return rte_flow_conv_pattern(dst, size, src, 0, error);
825 case RTE_FLOW_CONV_OP_ACTIONS:
826 return rte_flow_conv_actions(dst, size, src, 0, error);
827 case RTE_FLOW_CONV_OP_RULE:
828 return rte_flow_conv_rule(dst, size, src, error);
829 case RTE_FLOW_CONV_OP_ITEM_NAME:
830 return rte_flow_conv_name(0, 0, dst, size, src, error);
831 case RTE_FLOW_CONV_OP_ACTION_NAME:
832 return rte_flow_conv_name(1, 0, dst, size, src, error);
833 case RTE_FLOW_CONV_OP_ITEM_NAME_PTR:
834 return rte_flow_conv_name(0, 1, dst, size, src, error);
835 case RTE_FLOW_CONV_OP_ACTION_NAME_PTR:
836 return rte_flow_conv_name(1, 1, dst, size, src, error);
838 return rte_flow_error_set
839 (error, ENOTSUP, RTE_FLOW_ERROR_TYPE_UNSPECIFIED, NULL,
840 "unknown object conversion operation");
843 /** Store a full rte_flow description. */
845 rte_flow_copy(struct rte_flow_desc *desc, size_t len,
846 const struct rte_flow_attr *attr,
847 const struct rte_flow_item *items,
848 const struct rte_flow_action *actions)
851 * Overlap struct rte_flow_conv with struct rte_flow_desc in order
852 * to convert the former to the latter without wasting space.
854 struct rte_flow_conv_rule *dst =
856 (void *)((uintptr_t)desc +
857 (offsetof(struct rte_flow_desc, actions) -
858 offsetof(struct rte_flow_conv_rule, actions))) :
861 len > sizeof(*desc) - sizeof(*dst) ?
862 len - (sizeof(*desc) - sizeof(*dst)) :
864 struct rte_flow_conv_rule src = {
867 .actions_ro = actions,
871 RTE_BUILD_BUG_ON(sizeof(struct rte_flow_desc) <
872 sizeof(struct rte_flow_conv_rule));
874 (&dst->pattern != &desc->items ||
875 &dst->actions != &desc->actions ||
876 (uintptr_t)(dst + 1) != (uintptr_t)(desc + 1))) {
880 ret = rte_flow_conv(RTE_FLOW_CONV_OP_RULE, dst, dst_size, &src, NULL);
883 ret += sizeof(*desc) - sizeof(*dst);
885 (&(struct rte_flow_desc){
888 .items = dst_size ? dst->pattern : NULL,
889 .actions = dst_size ? dst->actions : NULL,
891 len > sizeof(*desc) ? sizeof(*desc) : len);
896 * Expand RSS flows into several possible flows according to the RSS hash
897 * fields requested and the driver capabilities.
899 int __rte_experimental
900 rte_flow_expand_rss(struct rte_flow_expand_rss *buf, size_t size,
901 const struct rte_flow_item *pattern, uint64_t types,
902 const struct rte_flow_expand_node graph[],
903 int graph_root_index)
906 const struct rte_flow_item *item;
907 const struct rte_flow_expand_node *node = &graph[graph_root_index];
908 const int *next_node;
909 const int *stack[elt_n];
911 struct rte_flow_item flow_items[elt_n];
914 size_t user_pattern_size = 0;
917 lsize = offsetof(struct rte_flow_expand_rss, entry) +
918 elt_n * sizeof(buf->entry[0]);
920 buf->entry[0].priority = 0;
921 buf->entry[0].pattern = (void *)&buf->entry[elt_n];
923 addr = buf->entry[0].pattern;
925 for (item = pattern; item->type != RTE_FLOW_ITEM_TYPE_END; item++) {
926 const struct rte_flow_expand_node *next = NULL;
928 for (i = 0; node->next && node->next[i]; ++i) {
929 next = &graph[node->next[i]];
930 if (next->type == item->type)
935 user_pattern_size += sizeof(*item);
937 user_pattern_size += sizeof(*item); /* Handle END item. */
938 lsize += user_pattern_size;
939 /* Copy the user pattern in the first entry of the buffer. */
941 rte_memcpy(addr, pattern, user_pattern_size);
942 addr = (void *)(((uintptr_t)addr) + user_pattern_size);
945 /* Start expanding. */
946 memset(flow_items, 0, sizeof(flow_items));
947 user_pattern_size -= sizeof(*item);
948 next_node = node->next;
949 stack[stack_pos] = next_node;
950 node = next_node ? &graph[*next_node] : NULL;
952 flow_items[stack_pos].type = node->type;
953 if (node->rss_types & types) {
955 * compute the number of items to copy from the
956 * expansion and copy it.
957 * When the stack_pos is 0, there are 1 element in it,
958 * plus the addition END item.
960 int elt = stack_pos + 2;
962 flow_items[stack_pos + 1].type = RTE_FLOW_ITEM_TYPE_END;
963 lsize += elt * sizeof(*item) + user_pattern_size;
965 size_t n = elt * sizeof(*item);
967 buf->entry[buf->entries].priority =
969 buf->entry[buf->entries].pattern = addr;
971 rte_memcpy(addr, buf->entry[0].pattern,
973 addr = (void *)(((uintptr_t)addr) +
975 rte_memcpy(addr, flow_items, n);
976 addr = (void *)(((uintptr_t)addr) + n);
981 next_node = node->next;
982 if (stack_pos++ == elt_n) {
986 stack[stack_pos] = next_node;
987 } else if (*(next_node + 1)) {
988 /* Follow up with the next possibility. */
991 /* Move to the next path. */
993 next_node = stack[--stack_pos];
995 stack[stack_pos] = next_node;
997 node = *next_node ? &graph[*next_node] : NULL;