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)),
76 MK_FLOW_ITEM(META, sizeof(struct rte_flow_item_meta)),
77 MK_FLOW_ITEM(GRE_KEY, sizeof(rte_be32_t)),
78 MK_FLOW_ITEM(GTP_PSC, sizeof(struct rte_flow_item_gtp_psc)),
79 MK_FLOW_ITEM(PPPOES, sizeof(struct rte_flow_item_pppoe)),
80 MK_FLOW_ITEM(PPPOED, sizeof(struct rte_flow_item_pppoe)),
81 MK_FLOW_ITEM(PPPOE_PROTO_ID,
82 sizeof(struct rte_flow_item_pppoe_proto_id)),
83 MK_FLOW_ITEM(NSH, sizeof(struct rte_flow_item_nsh)),
84 MK_FLOW_ITEM(IGMP, sizeof(struct rte_flow_item_igmp)),
85 MK_FLOW_ITEM(AH, sizeof(struct rte_flow_item_ah)),
88 /** Generate flow_action[] entry. */
89 #define MK_FLOW_ACTION(t, s) \
90 [RTE_FLOW_ACTION_TYPE_ ## t] = { \
95 /** Information about known flow actions. */
96 static const struct rte_flow_desc_data rte_flow_desc_action[] = {
97 MK_FLOW_ACTION(END, 0),
98 MK_FLOW_ACTION(VOID, 0),
99 MK_FLOW_ACTION(PASSTHRU, 0),
100 MK_FLOW_ACTION(JUMP, sizeof(struct rte_flow_action_jump)),
101 MK_FLOW_ACTION(MARK, sizeof(struct rte_flow_action_mark)),
102 MK_FLOW_ACTION(FLAG, 0),
103 MK_FLOW_ACTION(QUEUE, sizeof(struct rte_flow_action_queue)),
104 MK_FLOW_ACTION(DROP, 0),
105 MK_FLOW_ACTION(COUNT, sizeof(struct rte_flow_action_count)),
106 MK_FLOW_ACTION(RSS, sizeof(struct rte_flow_action_rss)),
107 MK_FLOW_ACTION(PF, 0),
108 MK_FLOW_ACTION(VF, sizeof(struct rte_flow_action_vf)),
109 MK_FLOW_ACTION(PHY_PORT, sizeof(struct rte_flow_action_phy_port)),
110 MK_FLOW_ACTION(PORT_ID, sizeof(struct rte_flow_action_port_id)),
111 MK_FLOW_ACTION(METER, sizeof(struct rte_flow_action_meter)),
112 MK_FLOW_ACTION(SECURITY, sizeof(struct rte_flow_action_security)),
113 MK_FLOW_ACTION(OF_SET_MPLS_TTL,
114 sizeof(struct rte_flow_action_of_set_mpls_ttl)),
115 MK_FLOW_ACTION(OF_DEC_MPLS_TTL, 0),
116 MK_FLOW_ACTION(OF_SET_NW_TTL,
117 sizeof(struct rte_flow_action_of_set_nw_ttl)),
118 MK_FLOW_ACTION(OF_DEC_NW_TTL, 0),
119 MK_FLOW_ACTION(OF_COPY_TTL_OUT, 0),
120 MK_FLOW_ACTION(OF_COPY_TTL_IN, 0),
121 MK_FLOW_ACTION(OF_POP_VLAN, 0),
122 MK_FLOW_ACTION(OF_PUSH_VLAN,
123 sizeof(struct rte_flow_action_of_push_vlan)),
124 MK_FLOW_ACTION(OF_SET_VLAN_VID,
125 sizeof(struct rte_flow_action_of_set_vlan_vid)),
126 MK_FLOW_ACTION(OF_SET_VLAN_PCP,
127 sizeof(struct rte_flow_action_of_set_vlan_pcp)),
128 MK_FLOW_ACTION(OF_POP_MPLS,
129 sizeof(struct rte_flow_action_of_pop_mpls)),
130 MK_FLOW_ACTION(OF_PUSH_MPLS,
131 sizeof(struct rte_flow_action_of_push_mpls)),
132 MK_FLOW_ACTION(VXLAN_ENCAP, sizeof(struct rte_flow_action_vxlan_encap)),
133 MK_FLOW_ACTION(VXLAN_DECAP, 0),
134 MK_FLOW_ACTION(NVGRE_ENCAP, sizeof(struct rte_flow_action_vxlan_encap)),
135 MK_FLOW_ACTION(NVGRE_DECAP, 0),
136 MK_FLOW_ACTION(RAW_ENCAP, sizeof(struct rte_flow_action_raw_encap)),
137 MK_FLOW_ACTION(RAW_DECAP, sizeof(struct rte_flow_action_raw_decap)),
138 MK_FLOW_ACTION(SET_IPV4_SRC,
139 sizeof(struct rte_flow_action_set_ipv4)),
140 MK_FLOW_ACTION(SET_IPV4_DST,
141 sizeof(struct rte_flow_action_set_ipv4)),
142 MK_FLOW_ACTION(SET_IPV6_SRC,
143 sizeof(struct rte_flow_action_set_ipv6)),
144 MK_FLOW_ACTION(SET_IPV6_DST,
145 sizeof(struct rte_flow_action_set_ipv6)),
146 MK_FLOW_ACTION(SET_TP_SRC,
147 sizeof(struct rte_flow_action_set_tp)),
148 MK_FLOW_ACTION(SET_TP_DST,
149 sizeof(struct rte_flow_action_set_tp)),
150 MK_FLOW_ACTION(MAC_SWAP, 0),
151 MK_FLOW_ACTION(DEC_TTL, 0),
152 MK_FLOW_ACTION(SET_TTL, sizeof(struct rte_flow_action_set_ttl)),
153 MK_FLOW_ACTION(SET_MAC_SRC, sizeof(struct rte_flow_action_set_mac)),
154 MK_FLOW_ACTION(SET_MAC_DST, sizeof(struct rte_flow_action_set_mac)),
155 MK_FLOW_ACTION(INC_TCP_SEQ, sizeof(rte_be32_t)),
156 MK_FLOW_ACTION(DEC_TCP_SEQ, sizeof(rte_be32_t)),
157 MK_FLOW_ACTION(INC_TCP_ACK, sizeof(rte_be32_t)),
158 MK_FLOW_ACTION(DEC_TCP_ACK, sizeof(rte_be32_t)),
162 flow_err(uint16_t port_id, int ret, struct rte_flow_error *error)
166 if (rte_eth_dev_is_removed(port_id))
167 return rte_flow_error_set(error, EIO,
168 RTE_FLOW_ERROR_TYPE_UNSPECIFIED,
169 NULL, rte_strerror(EIO));
173 /* Get generic flow operations structure from a port. */
174 const struct rte_flow_ops *
175 rte_flow_ops_get(uint16_t port_id, struct rte_flow_error *error)
177 struct rte_eth_dev *dev = &rte_eth_devices[port_id];
178 const struct rte_flow_ops *ops;
181 if (unlikely(!rte_eth_dev_is_valid_port(port_id)))
183 else if (unlikely(!dev->dev_ops->filter_ctrl ||
184 dev->dev_ops->filter_ctrl(dev,
185 RTE_ETH_FILTER_GENERIC,
192 rte_flow_error_set(error, code, RTE_FLOW_ERROR_TYPE_UNSPECIFIED,
193 NULL, rte_strerror(code));
197 /* Check whether a flow rule can be created on a given port. */
199 rte_flow_validate(uint16_t port_id,
200 const struct rte_flow_attr *attr,
201 const struct rte_flow_item pattern[],
202 const struct rte_flow_action actions[],
203 struct rte_flow_error *error)
205 const struct rte_flow_ops *ops = rte_flow_ops_get(port_id, error);
206 struct rte_eth_dev *dev = &rte_eth_devices[port_id];
210 if (likely(!!ops->validate))
211 return flow_err(port_id, ops->validate(dev, attr, pattern,
212 actions, error), error);
213 return rte_flow_error_set(error, ENOSYS,
214 RTE_FLOW_ERROR_TYPE_UNSPECIFIED,
215 NULL, rte_strerror(ENOSYS));
218 /* Create a flow rule on a given port. */
220 rte_flow_create(uint16_t port_id,
221 const struct rte_flow_attr *attr,
222 const struct rte_flow_item pattern[],
223 const struct rte_flow_action actions[],
224 struct rte_flow_error *error)
226 struct rte_eth_dev *dev = &rte_eth_devices[port_id];
227 struct rte_flow *flow;
228 const struct rte_flow_ops *ops = rte_flow_ops_get(port_id, error);
232 if (likely(!!ops->create)) {
233 flow = ops->create(dev, attr, pattern, actions, error);
235 flow_err(port_id, -rte_errno, error);
238 rte_flow_error_set(error, ENOSYS, RTE_FLOW_ERROR_TYPE_UNSPECIFIED,
239 NULL, rte_strerror(ENOSYS));
243 /* Destroy a flow rule on a given port. */
245 rte_flow_destroy(uint16_t port_id,
246 struct rte_flow *flow,
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->destroy))
255 return flow_err(port_id, ops->destroy(dev, flow, error),
257 return rte_flow_error_set(error, ENOSYS,
258 RTE_FLOW_ERROR_TYPE_UNSPECIFIED,
259 NULL, rte_strerror(ENOSYS));
262 /* Destroy all flow rules associated with a port. */
264 rte_flow_flush(uint16_t port_id,
265 struct rte_flow_error *error)
267 struct rte_eth_dev *dev = &rte_eth_devices[port_id];
268 const struct rte_flow_ops *ops = rte_flow_ops_get(port_id, error);
272 if (likely(!!ops->flush))
273 return flow_err(port_id, ops->flush(dev, error), error);
274 return rte_flow_error_set(error, ENOSYS,
275 RTE_FLOW_ERROR_TYPE_UNSPECIFIED,
276 NULL, rte_strerror(ENOSYS));
279 /* Query an existing flow rule. */
281 rte_flow_query(uint16_t port_id,
282 struct rte_flow *flow,
283 const struct rte_flow_action *action,
285 struct rte_flow_error *error)
287 struct rte_eth_dev *dev = &rte_eth_devices[port_id];
288 const struct rte_flow_ops *ops = rte_flow_ops_get(port_id, error);
292 if (likely(!!ops->query))
293 return flow_err(port_id, ops->query(dev, flow, action, data,
295 return rte_flow_error_set(error, ENOSYS,
296 RTE_FLOW_ERROR_TYPE_UNSPECIFIED,
297 NULL, rte_strerror(ENOSYS));
300 /* Restrict ingress traffic to the defined flow rules. */
302 rte_flow_isolate(uint16_t port_id,
304 struct rte_flow_error *error)
306 struct rte_eth_dev *dev = &rte_eth_devices[port_id];
307 const struct rte_flow_ops *ops = rte_flow_ops_get(port_id, error);
311 if (likely(!!ops->isolate))
312 return flow_err(port_id, ops->isolate(dev, set, error), error);
313 return rte_flow_error_set(error, ENOSYS,
314 RTE_FLOW_ERROR_TYPE_UNSPECIFIED,
315 NULL, rte_strerror(ENOSYS));
318 /* Initialize flow error structure. */
320 rte_flow_error_set(struct rte_flow_error *error,
322 enum rte_flow_error_type type,
327 *error = (struct rte_flow_error){
337 /** Pattern item specification types. */
338 enum rte_flow_conv_item_spec_type {
339 RTE_FLOW_CONV_ITEM_SPEC,
340 RTE_FLOW_CONV_ITEM_LAST,
341 RTE_FLOW_CONV_ITEM_MASK,
345 * Copy pattern item specification.
348 * Output buffer. Can be NULL if @p size is zero.
350 * Size of @p buf in bytes.
352 * Pattern item to copy specification from.
354 * Specification selector for either @p spec, @p last or @p mask.
357 * Number of bytes needed to store pattern item specification regardless
358 * of @p size. @p buf contents are truncated to @p size if not large
362 rte_flow_conv_item_spec(void *buf, const size_t size,
363 const struct rte_flow_item *item,
364 enum rte_flow_conv_item_spec_type type)
368 type == RTE_FLOW_CONV_ITEM_SPEC ? item->spec :
369 type == RTE_FLOW_CONV_ITEM_LAST ? item->last :
370 type == RTE_FLOW_CONV_ITEM_MASK ? item->mask :
373 switch (item->type) {
375 const struct rte_flow_item_raw *raw;
378 const struct rte_flow_item_raw *raw;
381 const struct rte_flow_item_raw *raw;
384 const struct rte_flow_item_raw *raw;
387 struct rte_flow_item_raw *raw;
391 case RTE_FLOW_ITEM_TYPE_RAW:
392 spec.raw = item->spec;
393 last.raw = item->last ? item->last : item->spec;
394 mask.raw = item->mask ? item->mask : &rte_flow_item_raw_mask;
398 (&(struct rte_flow_item_raw){
399 .relative = src.raw->relative,
400 .search = src.raw->search,
401 .reserved = src.raw->reserved,
402 .offset = src.raw->offset,
403 .limit = src.raw->limit,
404 .length = src.raw->length,
406 size > sizeof(*dst.raw) ? sizeof(*dst.raw) : size);
407 off = sizeof(*dst.raw);
408 if (type == RTE_FLOW_CONV_ITEM_SPEC ||
409 (type == RTE_FLOW_CONV_ITEM_MASK &&
410 ((spec.raw->length & mask.raw->length) >=
411 (last.raw->length & mask.raw->length))))
412 tmp = spec.raw->length & mask.raw->length;
414 tmp = last.raw->length & mask.raw->length;
416 off = RTE_ALIGN_CEIL(off, sizeof(*dst.raw->pattern));
417 if (size >= off + tmp)
418 dst.raw->pattern = rte_memcpy
419 ((void *)((uintptr_t)dst.raw + off),
420 src.raw->pattern, tmp);
425 off = rte_flow_desc_item[item->type].size;
426 rte_memcpy(buf, data, (size > off ? off : size));
433 * Copy action configuration.
436 * Output buffer. Can be NULL if @p size is zero.
438 * Size of @p buf in bytes.
440 * Action to copy configuration from.
443 * Number of bytes needed to store pattern item specification regardless
444 * of @p size. @p buf contents are truncated to @p size if not large
448 rte_flow_conv_action_conf(void *buf, const size_t size,
449 const struct rte_flow_action *action)
453 switch (action->type) {
455 const struct rte_flow_action_rss *rss;
456 const struct rte_flow_action_vxlan_encap *vxlan_encap;
457 const struct rte_flow_action_nvgre_encap *nvgre_encap;
460 struct rte_flow_action_rss *rss;
461 struct rte_flow_action_vxlan_encap *vxlan_encap;
462 struct rte_flow_action_nvgre_encap *nvgre_encap;
467 case RTE_FLOW_ACTION_TYPE_RSS:
468 src.rss = action->conf;
471 (&(struct rte_flow_action_rss){
472 .func = src.rss->func,
473 .level = src.rss->level,
474 .types = src.rss->types,
475 .key_len = src.rss->key_len,
476 .queue_num = src.rss->queue_num,
478 size > sizeof(*dst.rss) ? sizeof(*dst.rss) : size);
479 off = sizeof(*dst.rss);
480 if (src.rss->key_len) {
481 off = RTE_ALIGN_CEIL(off, sizeof(*dst.rss->key));
482 tmp = sizeof(*src.rss->key) * src.rss->key_len;
483 if (size >= off + tmp)
484 dst.rss->key = rte_memcpy
485 ((void *)((uintptr_t)dst.rss + off),
489 if (src.rss->queue_num) {
490 off = RTE_ALIGN_CEIL(off, sizeof(*dst.rss->queue));
491 tmp = sizeof(*src.rss->queue) * src.rss->queue_num;
492 if (size >= off + tmp)
493 dst.rss->queue = rte_memcpy
494 ((void *)((uintptr_t)dst.rss + off),
495 src.rss->queue, tmp);
499 case RTE_FLOW_ACTION_TYPE_VXLAN_ENCAP:
500 case RTE_FLOW_ACTION_TYPE_NVGRE_ENCAP:
501 src.vxlan_encap = action->conf;
502 dst.vxlan_encap = buf;
503 RTE_BUILD_BUG_ON(sizeof(*src.vxlan_encap) !=
504 sizeof(*src.nvgre_encap) ||
505 offsetof(struct rte_flow_action_vxlan_encap,
507 offsetof(struct rte_flow_action_nvgre_encap,
509 off = sizeof(*dst.vxlan_encap);
510 if (src.vxlan_encap->definition) {
512 (off, sizeof(*dst.vxlan_encap->definition));
514 (RTE_FLOW_CONV_OP_PATTERN,
515 (void *)((uintptr_t)dst.vxlan_encap + off),
516 size > off ? size - off : 0,
517 src.vxlan_encap->definition, NULL);
520 if (size >= off + ret)
521 dst.vxlan_encap->definition =
522 (void *)((uintptr_t)dst.vxlan_encap +
528 off = rte_flow_desc_action[action->type].size;
529 rte_memcpy(buf, action->conf, (size > off ? off : size));
536 * Copy a list of pattern items.
539 * Destination buffer. Can be NULL if @p size is zero.
541 * Size of @p dst in bytes.
543 * Source pattern items.
545 * Maximum number of pattern items to process from @p src or 0 to process
546 * the entire list. In both cases, processing stops after
547 * RTE_FLOW_ITEM_TYPE_END is encountered.
549 * Perform verbose error reporting if not NULL.
552 * A positive value representing the number of bytes needed to store
553 * pattern items regardless of @p size on success (@p buf contents are
554 * truncated to @p size if not large enough), a negative errno value
555 * otherwise and rte_errno is set.
558 rte_flow_conv_pattern(struct rte_flow_item *dst,
560 const struct rte_flow_item *src,
562 struct rte_flow_error *error)
564 uintptr_t data = (uintptr_t)dst;
569 for (i = 0, off = 0; !num || i != num; ++i, ++src, ++dst) {
570 if ((size_t)src->type >= RTE_DIM(rte_flow_desc_item) ||
571 !rte_flow_desc_item[src->type].name)
572 return rte_flow_error_set
573 (error, ENOTSUP, RTE_FLOW_ERROR_TYPE_ITEM, src,
574 "cannot convert unknown item type");
575 if (size >= off + sizeof(*dst))
576 *dst = (struct rte_flow_item){
588 off = RTE_ALIGN_CEIL(off, sizeof(double));
589 ret = rte_flow_conv_item_spec
590 ((void *)(data + off),
591 size > off ? size - off : 0, src,
592 RTE_FLOW_CONV_ITEM_SPEC);
593 if (size && size >= off + ret)
594 dst->spec = (void *)(data + off);
599 off = RTE_ALIGN_CEIL(off, sizeof(double));
600 ret = rte_flow_conv_item_spec
601 ((void *)(data + off),
602 size > off ? size - off : 0, src,
603 RTE_FLOW_CONV_ITEM_LAST);
604 if (size && size >= off + ret)
605 dst->last = (void *)(data + off);
609 off = RTE_ALIGN_CEIL(off, sizeof(double));
610 ret = rte_flow_conv_item_spec
611 ((void *)(data + off),
612 size > off ? size - off : 0, src,
613 RTE_FLOW_CONV_ITEM_MASK);
614 if (size && size >= off + ret)
615 dst->mask = (void *)(data + off);
625 * Copy a list of actions.
628 * Destination buffer. Can be NULL if @p size is zero.
630 * Size of @p dst in bytes.
634 * Maximum number of actions to process from @p src or 0 to process the
635 * entire list. In both cases, processing stops after
636 * RTE_FLOW_ACTION_TYPE_END is encountered.
638 * Perform verbose error reporting if not NULL.
641 * A positive value representing the number of bytes needed to store
642 * actions regardless of @p size on success (@p buf contents are truncated
643 * to @p size if not large enough), a negative errno value otherwise and
647 rte_flow_conv_actions(struct rte_flow_action *dst,
649 const struct rte_flow_action *src,
651 struct rte_flow_error *error)
653 uintptr_t data = (uintptr_t)dst;
658 for (i = 0, off = 0; !num || i != num; ++i, ++src, ++dst) {
659 if ((size_t)src->type >= RTE_DIM(rte_flow_desc_action) ||
660 !rte_flow_desc_action[src->type].name)
661 return rte_flow_error_set
662 (error, ENOTSUP, RTE_FLOW_ERROR_TYPE_ACTION,
663 src, "cannot convert unknown action type");
664 if (size >= off + sizeof(*dst))
665 *dst = (struct rte_flow_action){
677 off = RTE_ALIGN_CEIL(off, sizeof(double));
678 ret = rte_flow_conv_action_conf
679 ((void *)(data + off),
680 size > off ? size - off : 0, src);
681 if (size && size >= off + ret)
682 dst->conf = (void *)(data + off);
692 * Copy flow rule components.
694 * This comprises the flow rule descriptor itself, attributes, pattern and
695 * actions list. NULL components in @p src are skipped.
698 * Destination buffer. Can be NULL if @p size is zero.
700 * Size of @p dst in bytes.
702 * Source flow rule descriptor.
704 * Perform verbose error reporting if not NULL.
707 * A positive value representing the number of bytes needed to store all
708 * components including the descriptor regardless of @p size on success
709 * (@p buf contents are truncated to @p size if not large enough), a
710 * negative errno value otherwise and rte_errno is set.
713 rte_flow_conv_rule(struct rte_flow_conv_rule *dst,
715 const struct rte_flow_conv_rule *src,
716 struct rte_flow_error *error)
722 (&(struct rte_flow_conv_rule){
727 size > sizeof(*dst) ? sizeof(*dst) : size);
730 off = RTE_ALIGN_CEIL(off, sizeof(double));
731 if (size && size >= off + sizeof(*dst->attr))
732 dst->attr = rte_memcpy
733 ((void *)((uintptr_t)dst + off),
734 src->attr_ro, sizeof(*dst->attr));
735 off += sizeof(*dst->attr);
737 if (src->pattern_ro) {
738 off = RTE_ALIGN_CEIL(off, sizeof(double));
739 ret = rte_flow_conv_pattern((void *)((uintptr_t)dst + off),
740 size > off ? size - off : 0,
741 src->pattern_ro, 0, error);
744 if (size && size >= off + (size_t)ret)
745 dst->pattern = (void *)((uintptr_t)dst + off);
748 if (src->actions_ro) {
749 off = RTE_ALIGN_CEIL(off, sizeof(double));
750 ret = rte_flow_conv_actions((void *)((uintptr_t)dst + off),
751 size > off ? size - off : 0,
752 src->actions_ro, 0, error);
755 if (size >= off + (size_t)ret)
756 dst->actions = (void *)((uintptr_t)dst + off);
763 * Retrieve the name of a pattern item/action type.
766 * Nonzero when @p src represents an action type instead of a pattern item
769 * Nonzero to write string address instead of contents into @p dst.
771 * Destination buffer. Can be NULL if @p size is zero.
773 * Size of @p dst in bytes.
775 * Depending on @p is_action, source pattern item or action type cast as a
778 * Perform verbose error reporting if not NULL.
781 * A positive value representing the number of bytes needed to store the
782 * name or its address regardless of @p size on success (@p buf contents
783 * are truncated to @p size if not large enough), a negative errno value
784 * otherwise and rte_errno is set.
787 rte_flow_conv_name(int is_action,
792 struct rte_flow_error *error)
795 const struct rte_flow_desc_data *data;
798 static const struct desc_info info_rep[2] = {
799 { rte_flow_desc_item, RTE_DIM(rte_flow_desc_item), },
800 { rte_flow_desc_action, RTE_DIM(rte_flow_desc_action), },
802 const struct desc_info *const info = &info_rep[!!is_action];
803 unsigned int type = (uintptr_t)src;
805 if (type >= info->num)
806 return rte_flow_error_set
807 (error, EINVAL, RTE_FLOW_ERROR_TYPE_UNSPECIFIED, NULL,
808 "unknown object type to retrieve the name of");
810 return strlcpy(dst, info->data[type].name, size);
811 if (size >= sizeof(const char **))
812 *((const char **)dst) = info->data[type].name;
813 return sizeof(const char **);
816 /** Helper function to convert flow API objects. */
818 rte_flow_conv(enum rte_flow_conv_op op,
822 struct rte_flow_error *error)
825 const struct rte_flow_attr *attr;
827 case RTE_FLOW_CONV_OP_NONE:
829 case RTE_FLOW_CONV_OP_ATTR:
831 if (size > sizeof(*attr))
832 size = sizeof(*attr);
833 rte_memcpy(dst, attr, size);
834 return sizeof(*attr);
835 case RTE_FLOW_CONV_OP_ITEM:
836 return rte_flow_conv_pattern(dst, size, src, 1, error);
837 case RTE_FLOW_CONV_OP_ACTION:
838 return rte_flow_conv_actions(dst, size, src, 1, error);
839 case RTE_FLOW_CONV_OP_PATTERN:
840 return rte_flow_conv_pattern(dst, size, src, 0, error);
841 case RTE_FLOW_CONV_OP_ACTIONS:
842 return rte_flow_conv_actions(dst, size, src, 0, error);
843 case RTE_FLOW_CONV_OP_RULE:
844 return rte_flow_conv_rule(dst, size, src, error);
845 case RTE_FLOW_CONV_OP_ITEM_NAME:
846 return rte_flow_conv_name(0, 0, dst, size, src, error);
847 case RTE_FLOW_CONV_OP_ACTION_NAME:
848 return rte_flow_conv_name(1, 0, dst, size, src, error);
849 case RTE_FLOW_CONV_OP_ITEM_NAME_PTR:
850 return rte_flow_conv_name(0, 1, dst, size, src, error);
851 case RTE_FLOW_CONV_OP_ACTION_NAME_PTR:
852 return rte_flow_conv_name(1, 1, dst, size, src, error);
854 return rte_flow_error_set
855 (error, ENOTSUP, RTE_FLOW_ERROR_TYPE_UNSPECIFIED, NULL,
856 "unknown object conversion operation");
859 /** Store a full rte_flow description. */
861 rte_flow_copy(struct rte_flow_desc *desc, size_t len,
862 const struct rte_flow_attr *attr,
863 const struct rte_flow_item *items,
864 const struct rte_flow_action *actions)
867 * Overlap struct rte_flow_conv with struct rte_flow_desc in order
868 * to convert the former to the latter without wasting space.
870 struct rte_flow_conv_rule *dst =
872 (void *)((uintptr_t)desc +
873 (offsetof(struct rte_flow_desc, actions) -
874 offsetof(struct rte_flow_conv_rule, actions))) :
877 len > sizeof(*desc) - sizeof(*dst) ?
878 len - (sizeof(*desc) - sizeof(*dst)) :
880 struct rte_flow_conv_rule src = {
883 .actions_ro = actions,
887 RTE_BUILD_BUG_ON(sizeof(struct rte_flow_desc) <
888 sizeof(struct rte_flow_conv_rule));
890 (&dst->pattern != &desc->items ||
891 &dst->actions != &desc->actions ||
892 (uintptr_t)(dst + 1) != (uintptr_t)(desc + 1))) {
896 ret = rte_flow_conv(RTE_FLOW_CONV_OP_RULE, dst, dst_size, &src, NULL);
899 ret += sizeof(*desc) - sizeof(*dst);
901 (&(struct rte_flow_desc){
904 .items = dst_size ? dst->pattern : NULL,
905 .actions = dst_size ? dst->actions : NULL,
907 len > sizeof(*desc) ? sizeof(*desc) : len);
912 * Expand RSS flows into several possible flows according to the RSS hash
913 * fields requested and the driver capabilities.
916 rte_flow_expand_rss(struct rte_flow_expand_rss *buf, size_t size,
917 const struct rte_flow_item *pattern, uint64_t types,
918 const struct rte_flow_expand_node graph[],
919 int graph_root_index)
922 const struct rte_flow_item *item;
923 const struct rte_flow_expand_node *node = &graph[graph_root_index];
924 const int *next_node;
925 const int *stack[elt_n];
927 struct rte_flow_item flow_items[elt_n];
930 size_t user_pattern_size = 0;
933 lsize = offsetof(struct rte_flow_expand_rss, entry) +
934 elt_n * sizeof(buf->entry[0]);
936 buf->entry[0].priority = 0;
937 buf->entry[0].pattern = (void *)&buf->entry[elt_n];
939 addr = buf->entry[0].pattern;
941 for (item = pattern; item->type != RTE_FLOW_ITEM_TYPE_END; item++) {
942 const struct rte_flow_expand_node *next = NULL;
944 for (i = 0; node->next && node->next[i]; ++i) {
945 next = &graph[node->next[i]];
946 if (next->type == item->type)
951 user_pattern_size += sizeof(*item);
953 user_pattern_size += sizeof(*item); /* Handle END item. */
954 lsize += user_pattern_size;
955 /* Copy the user pattern in the first entry of the buffer. */
957 rte_memcpy(addr, pattern, user_pattern_size);
958 addr = (void *)(((uintptr_t)addr) + user_pattern_size);
961 /* Start expanding. */
962 memset(flow_items, 0, sizeof(flow_items));
963 user_pattern_size -= sizeof(*item);
964 next_node = node->next;
965 stack[stack_pos] = next_node;
966 node = next_node ? &graph[*next_node] : NULL;
968 flow_items[stack_pos].type = node->type;
969 if (node->rss_types & types) {
971 * compute the number of items to copy from the
972 * expansion and copy it.
973 * When the stack_pos is 0, there are 1 element in it,
974 * plus the addition END item.
976 int elt = stack_pos + 2;
978 flow_items[stack_pos + 1].type = RTE_FLOW_ITEM_TYPE_END;
979 lsize += elt * sizeof(*item) + user_pattern_size;
981 size_t n = elt * sizeof(*item);
983 buf->entry[buf->entries].priority =
985 buf->entry[buf->entries].pattern = addr;
987 rte_memcpy(addr, buf->entry[0].pattern,
989 addr = (void *)(((uintptr_t)addr) +
991 rte_memcpy(addr, flow_items, n);
992 addr = (void *)(((uintptr_t)addr) + n);
997 next_node = node->next;
998 if (stack_pos++ == elt_n) {
1002 stack[stack_pos] = next_node;
1003 } else if (*(next_node + 1)) {
1004 /* Follow up with the next possibility. */
1007 /* Move to the next path. */
1009 next_node = stack[--stack_pos];
1011 stack[stack_pos] = next_node;
1013 node = *next_node ? &graph[*next_node] : NULL;