1 /* SPDX-License-Identifier: BSD-3-Clause
2 * Copyright 2016 6WIND S.A.
3 * Copyright 2016 Mellanox Technologies, Ltd
11 * RTE generic flow API
13 * This interface provides the ability to program packet matching and
14 * associated actions in hardware through flow rules.
21 #include <rte_common.h>
22 #include <rte_ether.h>
28 #include <rte_byteorder.h>
36 * Flow rule attributes.
38 * Priorities are set on a per rule based within groups.
40 * Lower values denote higher priority, the highest priority for a flow rule
41 * is 0, so that a flow that matches for than one rule, the rule with the
42 * lowest priority value will always be matched.
44 * Although optional, applications are encouraged to group similar rules as
45 * much as possible to fully take advantage of hardware capabilities
46 * (e.g. optimized matching) and work around limitations (e.g. a single
47 * pattern type possibly allowed in a given group). Applications should be
48 * aware that groups are not linked by default, and that they must be
49 * explicitly linked by the application using the JUMP action.
51 * Priority levels are arbitrary and up to the application, they
52 * do not need to be contiguous nor start from 0, however the maximum number
53 * varies between devices and may be affected by existing flow rules.
55 * If a packet is matched by several rules of a given group for a given
56 * priority level, the outcome is undefined. It can take any path, may be
57 * duplicated or even cause unrecoverable errors.
59 * Note that support for more than a single group and priority level is not
62 * Flow rules can apply to inbound and/or outbound traffic (ingress/egress).
64 * Several pattern items and actions are valid and can be used in both
65 * directions. Those valid for only one direction are described as such.
67 * At least one direction must be specified.
69 * Specifying both directions at once for a given rule is not recommended
70 * but may be valid in a few cases (e.g. shared counter).
72 struct rte_flow_attr {
73 uint32_t group; /**< Priority group. */
74 uint32_t priority; /**< Rule priority level within group. */
75 uint32_t ingress:1; /**< Rule applies to ingress traffic. */
76 uint32_t egress:1; /**< Rule applies to egress traffic. */
78 * Instead of simply matching the properties of traffic as it would
79 * appear on a given DPDK port ID, enabling this attribute transfers
80 * a flow rule to the lowest possible level of any device endpoints
81 * found in the pattern.
83 * When supported, this effectively enables an application to
84 * re-route traffic not necessarily intended for it (e.g. coming
85 * from or addressed to different physical ports, VFs or
86 * applications) at the device level.
88 * It complements the behavior of some pattern items such as
89 * RTE_FLOW_ITEM_TYPE_PHY_PORT and is meaningless without them.
91 * When transferring flow rules, ingress and egress attributes keep
92 * their original meaning, as if processing traffic emitted or
93 * received by the application.
96 uint32_t reserved:29; /**< Reserved, must be zero. */
100 * Matching pattern item types.
102 * Pattern items fall in two categories:
104 * - Matching protocol headers and packet data, usually associated with a
105 * specification structure. These must be stacked in the same order as the
106 * protocol layers to match inside packets, starting from the lowest.
108 * - Matching meta-data or affecting pattern processing, often without a
109 * specification structure. Since they do not match packet contents, their
110 * position in the list is usually not relevant.
112 * See the description of individual types for more information. Those
113 * marked with [META] fall into the second category.
115 enum rte_flow_item_type {
119 * End marker for item lists. Prevents further processing of items,
120 * thereby ending the pattern.
122 * No associated specification structure.
124 RTE_FLOW_ITEM_TYPE_END,
129 * Used as a placeholder for convenience. It is ignored and simply
132 * No associated specification structure.
134 RTE_FLOW_ITEM_TYPE_VOID,
139 * Inverted matching, i.e. process packets that do not match the
142 * No associated specification structure.
144 RTE_FLOW_ITEM_TYPE_INVERT,
147 * Matches any protocol in place of the current layer, a single ANY
148 * may also stand for several protocol layers.
150 * See struct rte_flow_item_any.
152 RTE_FLOW_ITEM_TYPE_ANY,
157 * Matches traffic originating from (ingress) or going to (egress)
158 * the physical function of the current device.
160 * No associated specification structure.
162 RTE_FLOW_ITEM_TYPE_PF,
167 * Matches traffic originating from (ingress) or going to (egress) a
168 * given virtual function of the current device.
170 * See struct rte_flow_item_vf.
172 RTE_FLOW_ITEM_TYPE_VF,
177 * Matches traffic originating from (ingress) or going to (egress) a
178 * physical port of the underlying device.
180 * See struct rte_flow_item_phy_port.
182 RTE_FLOW_ITEM_TYPE_PHY_PORT,
187 * Matches traffic originating from (ingress) or going to (egress) a
188 * given DPDK port ID.
190 * See struct rte_flow_item_port_id.
192 RTE_FLOW_ITEM_TYPE_PORT_ID,
195 * Matches a byte string of a given length at a given offset.
197 * See struct rte_flow_item_raw.
199 RTE_FLOW_ITEM_TYPE_RAW,
202 * Matches an Ethernet header.
204 * See struct rte_flow_item_eth.
206 RTE_FLOW_ITEM_TYPE_ETH,
209 * Matches an 802.1Q/ad VLAN tag.
211 * See struct rte_flow_item_vlan.
213 RTE_FLOW_ITEM_TYPE_VLAN,
216 * Matches an IPv4 header.
218 * See struct rte_flow_item_ipv4.
220 RTE_FLOW_ITEM_TYPE_IPV4,
223 * Matches an IPv6 header.
225 * See struct rte_flow_item_ipv6.
227 RTE_FLOW_ITEM_TYPE_IPV6,
230 * Matches an ICMP header.
232 * See struct rte_flow_item_icmp.
234 RTE_FLOW_ITEM_TYPE_ICMP,
237 * Matches a UDP header.
239 * See struct rte_flow_item_udp.
241 RTE_FLOW_ITEM_TYPE_UDP,
244 * Matches a TCP header.
246 * See struct rte_flow_item_tcp.
248 RTE_FLOW_ITEM_TYPE_TCP,
251 * Matches a SCTP header.
253 * See struct rte_flow_item_sctp.
255 RTE_FLOW_ITEM_TYPE_SCTP,
258 * Matches a VXLAN header.
260 * See struct rte_flow_item_vxlan.
262 RTE_FLOW_ITEM_TYPE_VXLAN,
265 * Matches a E_TAG header.
267 * See struct rte_flow_item_e_tag.
269 RTE_FLOW_ITEM_TYPE_E_TAG,
272 * Matches a NVGRE header.
274 * See struct rte_flow_item_nvgre.
276 RTE_FLOW_ITEM_TYPE_NVGRE,
279 * Matches a MPLS header.
281 * See struct rte_flow_item_mpls.
283 RTE_FLOW_ITEM_TYPE_MPLS,
286 * Matches a GRE header.
288 * See struct rte_flow_item_gre.
290 RTE_FLOW_ITEM_TYPE_GRE,
295 * Fuzzy pattern match, expect faster than default.
297 * This is for device that support fuzzy matching option.
298 * Usually a fuzzy matching is fast but the cost is accuracy.
300 * See struct rte_flow_item_fuzzy.
302 RTE_FLOW_ITEM_TYPE_FUZZY,
305 * Matches a GTP header.
307 * Configure flow for GTP packets.
309 * See struct rte_flow_item_gtp.
311 RTE_FLOW_ITEM_TYPE_GTP,
314 * Matches a GTP header.
316 * Configure flow for GTP-C packets.
318 * See struct rte_flow_item_gtp.
320 RTE_FLOW_ITEM_TYPE_GTPC,
323 * Matches a GTP header.
325 * Configure flow for GTP-U packets.
327 * See struct rte_flow_item_gtp.
329 RTE_FLOW_ITEM_TYPE_GTPU,
332 * Matches a ESP header.
334 * See struct rte_flow_item_esp.
336 RTE_FLOW_ITEM_TYPE_ESP,
339 * Matches a GENEVE header.
341 * See struct rte_flow_item_geneve.
343 RTE_FLOW_ITEM_TYPE_GENEVE,
346 * Matches a VXLAN-GPE header.
348 * See struct rte_flow_item_vxlan_gpe.
350 RTE_FLOW_ITEM_TYPE_VXLAN_GPE,
353 * Matches an ARP header for Ethernet/IPv4.
355 * See struct rte_flow_item_arp_eth_ipv4.
357 RTE_FLOW_ITEM_TYPE_ARP_ETH_IPV4,
360 * Matches the presence of any IPv6 extension header.
362 * See struct rte_flow_item_ipv6_ext.
364 RTE_FLOW_ITEM_TYPE_IPV6_EXT,
367 * Matches any ICMPv6 header.
369 * See struct rte_flow_item_icmp6.
371 RTE_FLOW_ITEM_TYPE_ICMP6,
374 * Matches an ICMPv6 neighbor discovery solicitation.
376 * See struct rte_flow_item_icmp6_nd_ns.
378 RTE_FLOW_ITEM_TYPE_ICMP6_ND_NS,
381 * Matches an ICMPv6 neighbor discovery advertisement.
383 * See struct rte_flow_item_icmp6_nd_na.
385 RTE_FLOW_ITEM_TYPE_ICMP6_ND_NA,
388 * Matches the presence of any ICMPv6 neighbor discovery option.
390 * See struct rte_flow_item_icmp6_nd_opt.
392 RTE_FLOW_ITEM_TYPE_ICMP6_ND_OPT,
395 * Matches an ICMPv6 neighbor discovery source Ethernet link-layer
398 * See struct rte_flow_item_icmp6_nd_opt_sla_eth.
400 RTE_FLOW_ITEM_TYPE_ICMP6_ND_OPT_SLA_ETH,
403 * Matches an ICMPv6 neighbor discovery target Ethernet link-layer
406 * See struct rte_flow_item_icmp6_nd_opt_tla_eth.
408 RTE_FLOW_ITEM_TYPE_ICMP6_ND_OPT_TLA_ETH,
411 * Matches specified mark field.
413 * See struct rte_flow_item_mark.
415 RTE_FLOW_ITEM_TYPE_MARK,
420 * Matches a metadata value specified in mbuf metadata field.
421 * See struct rte_flow_item_meta.
423 RTE_FLOW_ITEM_TYPE_META,
426 * Matches a GRE optional key field.
428 * The value should a big-endian 32bit integer.
430 * When this item present the K bit is implicitly matched as "1"
431 * in the default mask.
434 * @code rte_be32_t * @endcode
436 RTE_FLOW_ITEM_TYPE_GRE_KEY,
439 * Matches a GTP extension header: PDU session container.
441 * Configure flow for GTP packets with extension header type 0x85.
443 * See struct rte_flow_item_gtp_psc.
445 RTE_FLOW_ITEM_TYPE_GTP_PSC,
448 * Matches a PPPoE header.
450 * Configure flow for PPPoE session packets.
452 * See struct rte_flow_item_pppoe.
454 RTE_FLOW_ITEM_TYPE_PPPOES,
457 * Matches a PPPoE header.
459 * Configure flow for PPPoE discovery packets.
461 * See struct rte_flow_item_pppoe.
463 RTE_FLOW_ITEM_TYPE_PPPOED,
466 * Matches a PPPoE optional proto_id field.
468 * It only applies to PPPoE session packets.
470 * See struct rte_flow_item_pppoe_proto_id.
472 RTE_FLOW_ITEM_TYPE_PPPOE_PROTO_ID,
475 * Matches Network service header (NSH).
476 * See struct rte_flow_item_nsh.
479 RTE_FLOW_ITEM_TYPE_NSH,
482 * Matches Internet Group Management Protocol (IGMP).
483 * See struct rte_flow_item_igmp.
486 RTE_FLOW_ITEM_TYPE_IGMP,
490 * RTE_FLOW_ITEM_TYPE_ANY
492 * Matches any protocol in place of the current layer, a single ANY may also
493 * stand for several protocol layers.
495 * This is usually specified as the first pattern item when looking for a
496 * protocol anywhere in a packet.
498 * A zeroed mask stands for any number of layers.
500 struct rte_flow_item_any {
501 uint32_t num; /**< Number of layers covered. */
504 /** Default mask for RTE_FLOW_ITEM_TYPE_ANY. */
506 static const struct rte_flow_item_any rte_flow_item_any_mask = {
512 * RTE_FLOW_ITEM_TYPE_VF
514 * Matches traffic originating from (ingress) or going to (egress) a given
515 * virtual function of the current device.
517 * If supported, should work even if the virtual function is not managed by
518 * the application and thus not associated with a DPDK port ID.
520 * Note this pattern item does not match VF representors traffic which, as
521 * separate entities, should be addressed through their own DPDK port IDs.
523 * - Can be specified multiple times to match traffic addressed to several
525 * - Can be combined with a PF item to match both PF and VF traffic.
527 * A zeroed mask can be used to match any VF ID.
529 struct rte_flow_item_vf {
530 uint32_t id; /**< VF ID. */
533 /** Default mask for RTE_FLOW_ITEM_TYPE_VF. */
535 static const struct rte_flow_item_vf rte_flow_item_vf_mask = {
541 * RTE_FLOW_ITEM_TYPE_PHY_PORT
543 * Matches traffic originating from (ingress) or going to (egress) a
544 * physical port of the underlying device.
546 * The first PHY_PORT item overrides the physical port normally associated
547 * with the specified DPDK input port (port_id). This item can be provided
548 * several times to match additional physical ports.
550 * Note that physical ports are not necessarily tied to DPDK input ports
551 * (port_id) when those are not under DPDK control. Possible values are
552 * specific to each device, they are not necessarily indexed from zero and
553 * may not be contiguous.
555 * As a device property, the list of allowed values as well as the value
556 * associated with a port_id should be retrieved by other means.
558 * A zeroed mask can be used to match any port index.
560 struct rte_flow_item_phy_port {
561 uint32_t index; /**< Physical port index. */
564 /** Default mask for RTE_FLOW_ITEM_TYPE_PHY_PORT. */
566 static const struct rte_flow_item_phy_port rte_flow_item_phy_port_mask = {
572 * RTE_FLOW_ITEM_TYPE_PORT_ID
574 * Matches traffic originating from (ingress) or going to (egress) a given
577 * Normally only supported if the port ID in question is known by the
578 * underlying PMD and related to the device the flow rule is created
581 * This must not be confused with @p PHY_PORT which refers to the physical
582 * port of a device, whereas @p PORT_ID refers to a struct rte_eth_dev
583 * object on the application side (also known as "port representor"
584 * depending on the kind of underlying device).
586 struct rte_flow_item_port_id {
587 uint32_t id; /**< DPDK port ID. */
590 /** Default mask for RTE_FLOW_ITEM_TYPE_PORT_ID. */
592 static const struct rte_flow_item_port_id rte_flow_item_port_id_mask = {
598 * RTE_FLOW_ITEM_TYPE_RAW
600 * Matches a byte string of a given length at a given offset.
602 * Offset is either absolute (using the start of the packet) or relative to
603 * the end of the previous matched item in the stack, in which case negative
604 * values are allowed.
606 * If search is enabled, offset is used as the starting point. The search
607 * area can be delimited by setting limit to a nonzero value, which is the
608 * maximum number of bytes after offset where the pattern may start.
610 * Matching a zero-length pattern is allowed, doing so resets the relative
611 * offset for subsequent items.
613 * This type does not support ranges (struct rte_flow_item.last).
615 struct rte_flow_item_raw {
616 uint32_t relative:1; /**< Look for pattern after the previous item. */
617 uint32_t search:1; /**< Search pattern from offset (see also limit). */
618 uint32_t reserved:30; /**< Reserved, must be set to zero. */
619 int32_t offset; /**< Absolute or relative offset for pattern. */
620 uint16_t limit; /**< Search area limit for start of pattern. */
621 uint16_t length; /**< Pattern length. */
622 const uint8_t *pattern; /**< Byte string to look for. */
625 /** Default mask for RTE_FLOW_ITEM_TYPE_RAW. */
627 static const struct rte_flow_item_raw rte_flow_item_raw_mask = {
630 .reserved = 0x3fffffff,
631 .offset = 0xffffffff,
639 * RTE_FLOW_ITEM_TYPE_ETH
641 * Matches an Ethernet header.
643 * The @p type field either stands for "EtherType" or "TPID" when followed
644 * by so-called layer 2.5 pattern items such as RTE_FLOW_ITEM_TYPE_VLAN. In
645 * the latter case, @p type refers to that of the outer header, with the
646 * inner EtherType/TPID provided by the subsequent pattern item. This is the
647 * same order as on the wire.
649 struct rte_flow_item_eth {
650 struct rte_ether_addr dst; /**< Destination MAC. */
651 struct rte_ether_addr src; /**< Source MAC. */
652 rte_be16_t type; /**< EtherType or TPID. */
655 /** Default mask for RTE_FLOW_ITEM_TYPE_ETH. */
657 static const struct rte_flow_item_eth rte_flow_item_eth_mask = {
658 .dst.addr_bytes = "\xff\xff\xff\xff\xff\xff",
659 .src.addr_bytes = "\xff\xff\xff\xff\xff\xff",
660 .type = RTE_BE16(0x0000),
665 * RTE_FLOW_ITEM_TYPE_VLAN
667 * Matches an 802.1Q/ad VLAN tag.
669 * The corresponding standard outer EtherType (TPID) values are
670 * RTE_ETHER_TYPE_VLAN or RTE_ETHER_TYPE_QINQ. It can be overridden by
671 * the preceding pattern item.
673 struct rte_flow_item_vlan {
674 rte_be16_t tci; /**< Tag control information. */
675 rte_be16_t inner_type; /**< Inner EtherType or TPID. */
678 /** Default mask for RTE_FLOW_ITEM_TYPE_VLAN. */
680 static const struct rte_flow_item_vlan rte_flow_item_vlan_mask = {
681 .tci = RTE_BE16(0x0fff),
682 .inner_type = RTE_BE16(0x0000),
687 * RTE_FLOW_ITEM_TYPE_IPV4
689 * Matches an IPv4 header.
691 * Note: IPv4 options are handled by dedicated pattern items.
693 struct rte_flow_item_ipv4 {
694 struct rte_ipv4_hdr hdr; /**< IPv4 header definition. */
697 /** Default mask for RTE_FLOW_ITEM_TYPE_IPV4. */
699 static const struct rte_flow_item_ipv4 rte_flow_item_ipv4_mask = {
701 .src_addr = RTE_BE32(0xffffffff),
702 .dst_addr = RTE_BE32(0xffffffff),
708 * RTE_FLOW_ITEM_TYPE_IPV6.
710 * Matches an IPv6 header.
712 * Note: IPv6 options are handled by dedicated pattern items, see
713 * RTE_FLOW_ITEM_TYPE_IPV6_EXT.
715 struct rte_flow_item_ipv6 {
716 struct rte_ipv6_hdr hdr; /**< IPv6 header definition. */
719 /** Default mask for RTE_FLOW_ITEM_TYPE_IPV6. */
721 static const struct rte_flow_item_ipv6 rte_flow_item_ipv6_mask = {
724 "\xff\xff\xff\xff\xff\xff\xff\xff"
725 "\xff\xff\xff\xff\xff\xff\xff\xff",
727 "\xff\xff\xff\xff\xff\xff\xff\xff"
728 "\xff\xff\xff\xff\xff\xff\xff\xff",
734 * RTE_FLOW_ITEM_TYPE_ICMP.
736 * Matches an ICMP header.
738 struct rte_flow_item_icmp {
739 struct rte_icmp_hdr hdr; /**< ICMP header definition. */
742 /** Default mask for RTE_FLOW_ITEM_TYPE_ICMP. */
744 static const struct rte_flow_item_icmp rte_flow_item_icmp_mask = {
753 * RTE_FLOW_ITEM_TYPE_UDP.
755 * Matches a UDP header.
757 struct rte_flow_item_udp {
758 struct rte_udp_hdr hdr; /**< UDP header definition. */
761 /** Default mask for RTE_FLOW_ITEM_TYPE_UDP. */
763 static const struct rte_flow_item_udp rte_flow_item_udp_mask = {
765 .src_port = RTE_BE16(0xffff),
766 .dst_port = RTE_BE16(0xffff),
772 * RTE_FLOW_ITEM_TYPE_TCP.
774 * Matches a TCP header.
776 struct rte_flow_item_tcp {
777 struct rte_tcp_hdr hdr; /**< TCP header definition. */
780 /** Default mask for RTE_FLOW_ITEM_TYPE_TCP. */
782 static const struct rte_flow_item_tcp rte_flow_item_tcp_mask = {
784 .src_port = RTE_BE16(0xffff),
785 .dst_port = RTE_BE16(0xffff),
791 * RTE_FLOW_ITEM_TYPE_SCTP.
793 * Matches a SCTP header.
795 struct rte_flow_item_sctp {
796 struct rte_sctp_hdr hdr; /**< SCTP header definition. */
799 /** Default mask for RTE_FLOW_ITEM_TYPE_SCTP. */
801 static const struct rte_flow_item_sctp rte_flow_item_sctp_mask = {
803 .src_port = RTE_BE16(0xffff),
804 .dst_port = RTE_BE16(0xffff),
810 * RTE_FLOW_ITEM_TYPE_VXLAN.
812 * Matches a VXLAN header (RFC 7348).
814 struct rte_flow_item_vxlan {
815 uint8_t flags; /**< Normally 0x08 (I flag). */
816 uint8_t rsvd0[3]; /**< Reserved, normally 0x000000. */
817 uint8_t vni[3]; /**< VXLAN identifier. */
818 uint8_t rsvd1; /**< Reserved, normally 0x00. */
821 /** Default mask for RTE_FLOW_ITEM_TYPE_VXLAN. */
823 static const struct rte_flow_item_vxlan rte_flow_item_vxlan_mask = {
824 .vni = "\xff\xff\xff",
829 * RTE_FLOW_ITEM_TYPE_E_TAG.
831 * Matches a E-tag header.
833 * The corresponding standard outer EtherType (TPID) value is
834 * RTE_ETHER_TYPE_ETAG. It can be overridden by the preceding pattern item.
836 struct rte_flow_item_e_tag {
838 * E-Tag control information (E-TCI).
839 * E-PCP (3b), E-DEI (1b), ingress E-CID base (12b).
841 rte_be16_t epcp_edei_in_ecid_b;
842 /** Reserved (2b), GRP (2b), E-CID base (12b). */
843 rte_be16_t rsvd_grp_ecid_b;
844 uint8_t in_ecid_e; /**< Ingress E-CID ext. */
845 uint8_t ecid_e; /**< E-CID ext. */
846 rte_be16_t inner_type; /**< Inner EtherType or TPID. */
849 /** Default mask for RTE_FLOW_ITEM_TYPE_E_TAG. */
851 static const struct rte_flow_item_e_tag rte_flow_item_e_tag_mask = {
852 .rsvd_grp_ecid_b = RTE_BE16(0x3fff),
857 * RTE_FLOW_ITEM_TYPE_NVGRE.
859 * Matches a NVGRE header.
861 struct rte_flow_item_nvgre {
863 * Checksum (1b), undefined (1b), key bit (1b), sequence number (1b),
864 * reserved 0 (9b), version (3b).
866 * c_k_s_rsvd0_ver must have value 0x2000 according to RFC 7637.
868 rte_be16_t c_k_s_rsvd0_ver;
869 rte_be16_t protocol; /**< Protocol type (0x6558). */
870 uint8_t tni[3]; /**< Virtual subnet ID. */
871 uint8_t flow_id; /**< Flow ID. */
874 /** Default mask for RTE_FLOW_ITEM_TYPE_NVGRE. */
876 static const struct rte_flow_item_nvgre rte_flow_item_nvgre_mask = {
877 .tni = "\xff\xff\xff",
882 * RTE_FLOW_ITEM_TYPE_MPLS.
884 * Matches a MPLS header.
886 struct rte_flow_item_mpls {
888 * Label (20b), TC (3b), Bottom of Stack (1b).
890 uint8_t label_tc_s[3];
891 uint8_t ttl; /** Time-to-Live. */
894 /** Default mask for RTE_FLOW_ITEM_TYPE_MPLS. */
896 static const struct rte_flow_item_mpls rte_flow_item_mpls_mask = {
897 .label_tc_s = "\xff\xff\xf0",
902 * RTE_FLOW_ITEM_TYPE_GRE.
904 * Matches a GRE header.
906 struct rte_flow_item_gre {
908 * Checksum (1b), reserved 0 (12b), version (3b).
911 rte_be16_t c_rsvd0_ver;
912 rte_be16_t protocol; /**< Protocol type. */
915 /** Default mask for RTE_FLOW_ITEM_TYPE_GRE. */
917 static const struct rte_flow_item_gre rte_flow_item_gre_mask = {
918 .protocol = RTE_BE16(0xffff),
923 * RTE_FLOW_ITEM_TYPE_FUZZY
925 * Fuzzy pattern match, expect faster than default.
927 * This is for device that support fuzzy match option.
928 * Usually a fuzzy match is fast but the cost is accuracy.
929 * i.e. Signature Match only match pattern's hash value, but it is
930 * possible two different patterns have the same hash value.
932 * Matching accuracy level can be configure by threshold.
933 * Driver can divide the range of threshold and map to different
934 * accuracy levels that device support.
936 * Threshold 0 means perfect match (no fuzziness), while threshold
937 * 0xffffffff means fuzziest match.
939 struct rte_flow_item_fuzzy {
940 uint32_t thresh; /**< Accuracy threshold. */
943 /** Default mask for RTE_FLOW_ITEM_TYPE_FUZZY. */
945 static const struct rte_flow_item_fuzzy rte_flow_item_fuzzy_mask = {
946 .thresh = 0xffffffff,
951 * RTE_FLOW_ITEM_TYPE_GTP.
953 * Matches a GTPv1 header.
955 struct rte_flow_item_gtp {
957 * Version (3b), protocol type (1b), reserved (1b),
958 * Extension header flag (1b),
959 * Sequence number flag (1b),
960 * N-PDU number flag (1b).
962 uint8_t v_pt_rsv_flags;
963 uint8_t msg_type; /**< Message type. */
964 rte_be16_t msg_len; /**< Message length. */
965 rte_be32_t teid; /**< Tunnel endpoint identifier. */
968 /** Default mask for RTE_FLOW_ITEM_TYPE_GTP. */
970 static const struct rte_flow_item_gtp rte_flow_item_gtp_mask = {
971 .teid = RTE_BE32(0xffffffff),
976 * RTE_FLOW_ITEM_TYPE_ESP
978 * Matches an ESP header.
980 struct rte_flow_item_esp {
981 struct rte_esp_hdr hdr; /**< ESP header definition. */
984 /** Default mask for RTE_FLOW_ITEM_TYPE_ESP. */
986 static const struct rte_flow_item_esp rte_flow_item_esp_mask = {
988 .spi = RTE_BE32(0xffffffff),
994 * RTE_FLOW_ITEM_TYPE_GENEVE.
996 * Matches a GENEVE header.
998 struct rte_flow_item_geneve {
1000 * Version (2b), length of the options fields (6b), OAM packet (1b),
1001 * critical options present (1b), reserved 0 (6b).
1003 rte_be16_t ver_opt_len_o_c_rsvd0;
1004 rte_be16_t protocol; /**< Protocol type. */
1005 uint8_t vni[3]; /**< Virtual Network Identifier. */
1006 uint8_t rsvd1; /**< Reserved, normally 0x00. */
1009 /** Default mask for RTE_FLOW_ITEM_TYPE_GENEVE. */
1011 static const struct rte_flow_item_geneve rte_flow_item_geneve_mask = {
1012 .vni = "\xff\xff\xff",
1017 * RTE_FLOW_ITEM_TYPE_VXLAN_GPE (draft-ietf-nvo3-vxlan-gpe-05).
1019 * Matches a VXLAN-GPE header.
1021 struct rte_flow_item_vxlan_gpe {
1022 uint8_t flags; /**< Normally 0x0c (I and P flags). */
1023 uint8_t rsvd0[2]; /**< Reserved, normally 0x0000. */
1024 uint8_t protocol; /**< Protocol type. */
1025 uint8_t vni[3]; /**< VXLAN identifier. */
1026 uint8_t rsvd1; /**< Reserved, normally 0x00. */
1029 /** Default mask for RTE_FLOW_ITEM_TYPE_VXLAN_GPE. */
1031 static const struct rte_flow_item_vxlan_gpe rte_flow_item_vxlan_gpe_mask = {
1032 .vni = "\xff\xff\xff",
1037 * RTE_FLOW_ITEM_TYPE_ARP_ETH_IPV4
1039 * Matches an ARP header for Ethernet/IPv4.
1041 struct rte_flow_item_arp_eth_ipv4 {
1042 rte_be16_t hrd; /**< Hardware type, normally 1. */
1043 rte_be16_t pro; /**< Protocol type, normally 0x0800. */
1044 uint8_t hln; /**< Hardware address length, normally 6. */
1045 uint8_t pln; /**< Protocol address length, normally 4. */
1046 rte_be16_t op; /**< Opcode (1 for request, 2 for reply). */
1047 struct rte_ether_addr sha; /**< Sender hardware address. */
1048 rte_be32_t spa; /**< Sender IPv4 address. */
1049 struct rte_ether_addr tha; /**< Target hardware address. */
1050 rte_be32_t tpa; /**< Target IPv4 address. */
1053 /** Default mask for RTE_FLOW_ITEM_TYPE_ARP_ETH_IPV4. */
1055 static const struct rte_flow_item_arp_eth_ipv4
1056 rte_flow_item_arp_eth_ipv4_mask = {
1057 .sha.addr_bytes = "\xff\xff\xff\xff\xff\xff",
1058 .spa = RTE_BE32(0xffffffff),
1059 .tha.addr_bytes = "\xff\xff\xff\xff\xff\xff",
1060 .tpa = RTE_BE32(0xffffffff),
1065 * RTE_FLOW_ITEM_TYPE_IPV6_EXT
1067 * Matches the presence of any IPv6 extension header.
1069 * Normally preceded by any of:
1071 * - RTE_FLOW_ITEM_TYPE_IPV6
1072 * - RTE_FLOW_ITEM_TYPE_IPV6_EXT
1074 struct rte_flow_item_ipv6_ext {
1075 uint8_t next_hdr; /**< Next header. */
1078 /** Default mask for RTE_FLOW_ITEM_TYPE_IPV6_EXT. */
1081 struct rte_flow_item_ipv6_ext rte_flow_item_ipv6_ext_mask = {
1087 * RTE_FLOW_ITEM_TYPE_ICMP6
1089 * Matches any ICMPv6 header.
1091 struct rte_flow_item_icmp6 {
1092 uint8_t type; /**< ICMPv6 type. */
1093 uint8_t code; /**< ICMPv6 code. */
1094 uint16_t checksum; /**< ICMPv6 checksum. */
1097 /** Default mask for RTE_FLOW_ITEM_TYPE_ICMP6. */
1099 static const struct rte_flow_item_icmp6 rte_flow_item_icmp6_mask = {
1106 * RTE_FLOW_ITEM_TYPE_ICMP6_ND_NS
1108 * Matches an ICMPv6 neighbor discovery solicitation.
1110 struct rte_flow_item_icmp6_nd_ns {
1111 uint8_t type; /**< ICMPv6 type, normally 135. */
1112 uint8_t code; /**< ICMPv6 code, normally 0. */
1113 rte_be16_t checksum; /**< ICMPv6 checksum. */
1114 rte_be32_t reserved; /**< Reserved, normally 0. */
1115 uint8_t target_addr[16]; /**< Target address. */
1118 /** Default mask for RTE_FLOW_ITEM_TYPE_ICMP6_ND_NS. */
1121 struct rte_flow_item_icmp6_nd_ns rte_flow_item_icmp6_nd_ns_mask = {
1123 "\xff\xff\xff\xff\xff\xff\xff\xff"
1124 "\xff\xff\xff\xff\xff\xff\xff\xff",
1129 * RTE_FLOW_ITEM_TYPE_ICMP6_ND_NA
1131 * Matches an ICMPv6 neighbor discovery advertisement.
1133 struct rte_flow_item_icmp6_nd_na {
1134 uint8_t type; /**< ICMPv6 type, normally 136. */
1135 uint8_t code; /**< ICMPv6 code, normally 0. */
1136 rte_be16_t checksum; /**< ICMPv6 checksum. */
1138 * Route flag (1b), solicited flag (1b), override flag (1b),
1141 rte_be32_t rso_reserved;
1142 uint8_t target_addr[16]; /**< Target address. */
1145 /** Default mask for RTE_FLOW_ITEM_TYPE_ICMP6_ND_NA. */
1148 struct rte_flow_item_icmp6_nd_na rte_flow_item_icmp6_nd_na_mask = {
1150 "\xff\xff\xff\xff\xff\xff\xff\xff"
1151 "\xff\xff\xff\xff\xff\xff\xff\xff",
1156 * RTE_FLOW_ITEM_TYPE_ICMP6_ND_OPT
1158 * Matches the presence of any ICMPv6 neighbor discovery option.
1160 * Normally preceded by any of:
1162 * - RTE_FLOW_ITEM_TYPE_ICMP6_ND_NA
1163 * - RTE_FLOW_ITEM_TYPE_ICMP6_ND_NS
1164 * - RTE_FLOW_ITEM_TYPE_ICMP6_ND_OPT
1166 struct rte_flow_item_icmp6_nd_opt {
1167 uint8_t type; /**< ND option type. */
1168 uint8_t length; /**< ND option length. */
1171 /** Default mask for RTE_FLOW_ITEM_TYPE_ICMP6_ND_OPT. */
1173 static const struct rte_flow_item_icmp6_nd_opt
1174 rte_flow_item_icmp6_nd_opt_mask = {
1180 * RTE_FLOW_ITEM_TYPE_ICMP6_ND_OPT_SLA_ETH
1182 * Matches an ICMPv6 neighbor discovery source Ethernet link-layer address
1185 * Normally preceded by any of:
1187 * - RTE_FLOW_ITEM_TYPE_ICMP6_ND_NA
1188 * - RTE_FLOW_ITEM_TYPE_ICMP6_ND_OPT
1190 struct rte_flow_item_icmp6_nd_opt_sla_eth {
1191 uint8_t type; /**< ND option type, normally 1. */
1192 uint8_t length; /**< ND option length, normally 1. */
1193 struct rte_ether_addr sla; /**< Source Ethernet LLA. */
1196 /** Default mask for RTE_FLOW_ITEM_TYPE_ICMP6_ND_OPT_SLA_ETH. */
1198 static const struct rte_flow_item_icmp6_nd_opt_sla_eth
1199 rte_flow_item_icmp6_nd_opt_sla_eth_mask = {
1200 .sla.addr_bytes = "\xff\xff\xff\xff\xff\xff",
1205 * RTE_FLOW_ITEM_TYPE_ICMP6_ND_OPT_TLA_ETH
1207 * Matches an ICMPv6 neighbor discovery target Ethernet link-layer address
1210 * Normally preceded by any of:
1212 * - RTE_FLOW_ITEM_TYPE_ICMP6_ND_NS
1213 * - RTE_FLOW_ITEM_TYPE_ICMP6_ND_OPT
1215 struct rte_flow_item_icmp6_nd_opt_tla_eth {
1216 uint8_t type; /**< ND option type, normally 2. */
1217 uint8_t length; /**< ND option length, normally 1. */
1218 struct rte_ether_addr tla; /**< Target Ethernet LLA. */
1221 /** Default mask for RTE_FLOW_ITEM_TYPE_ICMP6_ND_OPT_TLA_ETH. */
1223 static const struct rte_flow_item_icmp6_nd_opt_tla_eth
1224 rte_flow_item_icmp6_nd_opt_tla_eth_mask = {
1225 .tla.addr_bytes = "\xff\xff\xff\xff\xff\xff",
1230 * RTE_FLOW_ITEM_TYPE_META.
1232 * Matches a specified metadata value.
1234 struct rte_flow_item_meta {
1238 /** Default mask for RTE_FLOW_ITEM_TYPE_META. */
1240 static const struct rte_flow_item_meta rte_flow_item_meta_mask = {
1241 .data = RTE_BE32(UINT32_MAX),
1246 * RTE_FLOW_ITEM_TYPE_GTP_PSC.
1248 * Matches a GTP PDU extension header with type 0x85.
1250 struct rte_flow_item_gtp_psc {
1251 uint8_t pdu_type; /**< PDU type. */
1252 uint8_t qfi; /**< QoS flow identifier. */
1255 /** Default mask for RTE_FLOW_ITEM_TYPE_GTP_PSC. */
1257 static const struct rte_flow_item_gtp_psc
1258 rte_flow_item_gtp_psc_mask = {
1264 * RTE_FLOW_ITEM_TYPE_PPPOE.
1266 * Matches a PPPoE header.
1268 struct rte_flow_item_pppoe {
1270 * Version (4b), type (4b).
1272 uint8_t version_type;
1273 uint8_t code; /**< Message type. */
1274 rte_be16_t session_id; /**< Session identifier. */
1275 rte_be16_t length; /**< Payload length. */
1279 * RTE_FLOW_ITEM_TYPE_PPPOE_PROTO_ID.
1281 * Matches a PPPoE optional proto_id field.
1283 * It only applies to PPPoE session packets.
1285 * Normally preceded by any of:
1287 * - RTE_FLOW_ITEM_TYPE_PPPOE
1288 * - RTE_FLOW_ITEM_TYPE_PPPOE_PROTO_ID
1290 struct rte_flow_item_pppoe_proto_id {
1291 rte_be16_t proto_id; /**< PPP protocol identifier. */
1294 /** Default mask for RTE_FLOW_ITEM_TYPE_PPPOE_PROTO_ID. */
1296 static const struct rte_flow_item_pppoe_proto_id
1297 rte_flow_item_pppoe_proto_id_mask = {
1298 .proto_id = RTE_BE16(0xffff),
1304 * @b EXPERIMENTAL: this structure may change without prior notice
1306 * RTE_FLOW_ITEM_TYPE_MARK
1308 * Matches an arbitrary integer value which was set using the ``MARK`` action
1309 * in a previously matched rule.
1311 * This item can only be specified once as a match criteria as the ``MARK``
1312 * action can only be specified once in a flow action.
1314 * This value is arbitrary and application-defined. Maximum allowed value
1315 * depends on the underlying implementation.
1317 * Depending on the underlying implementation the MARK item may be supported on
1318 * the physical device, with virtual groups in the PMD or not at all.
1320 struct rte_flow_item_mark {
1321 uint32_t id; /**< Integer value to match against. */
1326 * @b EXPERIMENTAL: this structure may change without prior notice
1328 * RTE_FLOW_ITEM_TYPE_NSH
1330 * Match network service header (NSH), RFC 8300
1333 struct rte_flow_item_nsh {
1336 uint32_t reserved:1;
1339 uint32_t reserved1:4;
1341 uint32_t next_proto:8;
1346 /** Default mask for RTE_FLOW_ITEM_TYPE_NSH. */
1348 static const struct rte_flow_item_nsh rte_flow_item_nsh_mask = {
1358 * @b EXPERIMENTAL: this structure may change without prior notice
1360 * RTE_FLOW_ITEM_TYPE_IGMP
1362 * Match Internet Group Management Protocol (IGMP), RFC 2236
1365 struct rte_flow_item_igmp {
1367 uint32_t max_resp_time:8;
1368 uint32_t checksum:16;
1369 uint32_t group_addr;
1372 /** Default mask for RTE_FLOW_ITEM_TYPE_IGMP. */
1374 static const struct rte_flow_item_igmp rte_flow_item_igmp_mask = {
1375 .group_addr = 0xffffffff,
1380 * Matching pattern item definition.
1382 * A pattern is formed by stacking items starting from the lowest protocol
1383 * layer to match. This stacking restriction does not apply to meta items
1384 * which can be placed anywhere in the stack without affecting the meaning
1385 * of the resulting pattern.
1387 * Patterns are terminated by END items.
1389 * The spec field should be a valid pointer to a structure of the related
1390 * item type. It may remain unspecified (NULL) in many cases to request
1391 * broad (nonspecific) matching. In such cases, last and mask must also be
1394 * Optionally, last can point to a structure of the same type to define an
1395 * inclusive range. This is mostly supported by integer and address fields,
1396 * may cause errors otherwise. Fields that do not support ranges must be set
1397 * to 0 or to the same value as the corresponding fields in spec.
1399 * Only the fields defined to nonzero values in the default masks (see
1400 * rte_flow_item_{name}_mask constants) are considered relevant by
1401 * default. This can be overridden by providing a mask structure of the
1402 * same type with applicable bits set to one. It can also be used to
1403 * partially filter out specific fields (e.g. as an alternate mean to match
1404 * ranges of IP addresses).
1406 * Mask is a simple bit-mask applied before interpreting the contents of
1407 * spec and last, which may yield unexpected results if not used
1408 * carefully. For example, if for an IPv4 address field, spec provides
1409 * 10.1.2.3, last provides 10.3.4.5 and mask provides 255.255.0.0, the
1410 * effective range becomes 10.1.0.0 to 10.3.255.255.
1412 struct rte_flow_item {
1413 enum rte_flow_item_type type; /**< Item type. */
1414 const void *spec; /**< Pointer to item specification structure. */
1415 const void *last; /**< Defines an inclusive range (spec to last). */
1416 const void *mask; /**< Bit-mask applied to spec and last. */
1422 * Each possible action is represented by a type.
1423 * An action can have an associated configuration object.
1424 * Several actions combined in a list can be assigned
1425 * to a flow rule and are performed in order.
1427 * They fall in three categories:
1429 * - Actions that modify the fate of matching traffic, for instance by
1430 * dropping or assigning it a specific destination.
1432 * - Actions that modify matching traffic contents or its properties. This
1433 * includes adding/removing encapsulation, encryption, compression and
1436 * - Actions related to the flow rule itself, such as updating counters or
1437 * making it non-terminating.
1439 * Flow rules being terminating by default, not specifying any action of the
1440 * fate kind results in undefined behavior. This applies to both ingress and
1443 * PASSTHRU, when supported, makes a flow rule non-terminating.
1445 enum rte_flow_action_type {
1447 * End marker for action lists. Prevents further processing of
1448 * actions, thereby ending the list.
1450 * No associated configuration structure.
1452 RTE_FLOW_ACTION_TYPE_END,
1455 * Used as a placeholder for convenience. It is ignored and simply
1456 * discarded by PMDs.
1458 * No associated configuration structure.
1460 RTE_FLOW_ACTION_TYPE_VOID,
1463 * Leaves traffic up for additional processing by subsequent flow
1464 * rules; makes a flow rule non-terminating.
1466 * No associated configuration structure.
1468 RTE_FLOW_ACTION_TYPE_PASSTHRU,
1471 * RTE_FLOW_ACTION_TYPE_JUMP
1473 * Redirects packets to a group on the current device.
1475 * See struct rte_flow_action_jump.
1477 RTE_FLOW_ACTION_TYPE_JUMP,
1480 * Attaches an integer value to packets and sets PKT_RX_FDIR and
1481 * PKT_RX_FDIR_ID mbuf flags.
1483 * See struct rte_flow_action_mark.
1485 RTE_FLOW_ACTION_TYPE_MARK,
1488 * Flags packets. Similar to MARK without a specific value; only
1489 * sets the PKT_RX_FDIR mbuf flag.
1491 * No associated configuration structure.
1493 RTE_FLOW_ACTION_TYPE_FLAG,
1496 * Assigns packets to a given queue index.
1498 * See struct rte_flow_action_queue.
1500 RTE_FLOW_ACTION_TYPE_QUEUE,
1505 * PASSTHRU overrides this action if both are specified.
1507 * No associated configuration structure.
1509 RTE_FLOW_ACTION_TYPE_DROP,
1512 * Enables counters for this flow rule.
1514 * These counters can be retrieved and reset through rte_flow_query(),
1515 * see struct rte_flow_query_count.
1517 * See struct rte_flow_action_count.
1519 RTE_FLOW_ACTION_TYPE_COUNT,
1522 * Similar to QUEUE, except RSS is additionally performed on packets
1523 * to spread them among several queues according to the provided
1526 * See struct rte_flow_action_rss.
1528 RTE_FLOW_ACTION_TYPE_RSS,
1531 * Directs matching traffic to the physical function (PF) of the
1534 * No associated configuration structure.
1536 RTE_FLOW_ACTION_TYPE_PF,
1539 * Directs matching traffic to a given virtual function of the
1542 * See struct rte_flow_action_vf.
1544 RTE_FLOW_ACTION_TYPE_VF,
1547 * Directs packets to a given physical port index of the underlying
1550 * See struct rte_flow_action_phy_port.
1552 RTE_FLOW_ACTION_TYPE_PHY_PORT,
1555 * Directs matching traffic to a given DPDK port ID.
1557 * See struct rte_flow_action_port_id.
1559 RTE_FLOW_ACTION_TYPE_PORT_ID,
1562 * Traffic metering and policing (MTR).
1564 * See struct rte_flow_action_meter.
1565 * See file rte_mtr.h for MTR object configuration.
1567 RTE_FLOW_ACTION_TYPE_METER,
1570 * Redirects packets to security engine of current device for security
1571 * processing as specified by security session.
1573 * See struct rte_flow_action_security.
1575 RTE_FLOW_ACTION_TYPE_SECURITY,
1578 * Implements OFPAT_SET_MPLS_TTL ("MPLS TTL") as defined by the
1579 * OpenFlow Switch Specification.
1581 * See struct rte_flow_action_of_set_mpls_ttl.
1583 RTE_FLOW_ACTION_TYPE_OF_SET_MPLS_TTL,
1586 * Implements OFPAT_DEC_MPLS_TTL ("decrement MPLS TTL") as defined
1587 * by the OpenFlow Switch Specification.
1589 * No associated configuration structure.
1591 RTE_FLOW_ACTION_TYPE_OF_DEC_MPLS_TTL,
1594 * Implements OFPAT_SET_NW_TTL ("IP TTL") as defined by the OpenFlow
1595 * Switch Specification.
1597 * See struct rte_flow_action_of_set_nw_ttl.
1599 RTE_FLOW_ACTION_TYPE_OF_SET_NW_TTL,
1602 * Implements OFPAT_DEC_NW_TTL ("decrement IP TTL") as defined by
1603 * the OpenFlow Switch Specification.
1605 * No associated configuration structure.
1607 RTE_FLOW_ACTION_TYPE_OF_DEC_NW_TTL,
1610 * Implements OFPAT_COPY_TTL_OUT ("copy TTL "outwards" -- from
1611 * next-to-outermost to outermost") as defined by the OpenFlow
1612 * Switch Specification.
1614 * No associated configuration structure.
1616 RTE_FLOW_ACTION_TYPE_OF_COPY_TTL_OUT,
1619 * Implements OFPAT_COPY_TTL_IN ("copy TTL "inwards" -- from
1620 * outermost to next-to-outermost") as defined by the OpenFlow
1621 * Switch Specification.
1623 * No associated configuration structure.
1625 RTE_FLOW_ACTION_TYPE_OF_COPY_TTL_IN,
1628 * Implements OFPAT_POP_VLAN ("pop the outer VLAN tag") as defined
1629 * by the OpenFlow Switch Specification.
1631 * No associated configuration structure.
1633 RTE_FLOW_ACTION_TYPE_OF_POP_VLAN,
1636 * Implements OFPAT_PUSH_VLAN ("push a new VLAN tag") as defined by
1637 * the OpenFlow Switch Specification.
1639 * See struct rte_flow_action_of_push_vlan.
1641 RTE_FLOW_ACTION_TYPE_OF_PUSH_VLAN,
1644 * Implements OFPAT_SET_VLAN_VID ("set the 802.1q VLAN id") as
1645 * defined by the OpenFlow Switch Specification.
1647 * See struct rte_flow_action_of_set_vlan_vid.
1649 RTE_FLOW_ACTION_TYPE_OF_SET_VLAN_VID,
1652 * Implements OFPAT_SET_LAN_PCP ("set the 802.1q priority") as
1653 * defined by the OpenFlow Switch Specification.
1655 * See struct rte_flow_action_of_set_vlan_pcp.
1657 RTE_FLOW_ACTION_TYPE_OF_SET_VLAN_PCP,
1660 * Implements OFPAT_POP_MPLS ("pop the outer MPLS tag") as defined
1661 * by the OpenFlow Switch Specification.
1663 * See struct rte_flow_action_of_pop_mpls.
1665 RTE_FLOW_ACTION_TYPE_OF_POP_MPLS,
1668 * Implements OFPAT_PUSH_MPLS ("push a new MPLS tag") as defined by
1669 * the OpenFlow Switch Specification.
1671 * See struct rte_flow_action_of_push_mpls.
1673 RTE_FLOW_ACTION_TYPE_OF_PUSH_MPLS,
1676 * Encapsulate flow in VXLAN tunnel as defined in
1677 * rte_flow_action_vxlan_encap action structure.
1679 * See struct rte_flow_action_vxlan_encap.
1681 RTE_FLOW_ACTION_TYPE_VXLAN_ENCAP,
1684 * Decapsulate outer most VXLAN tunnel from matched flow.
1686 * If flow pattern does not define a valid VXLAN tunnel (as specified by
1687 * RFC7348) then the PMD should return a RTE_FLOW_ERROR_TYPE_ACTION
1690 RTE_FLOW_ACTION_TYPE_VXLAN_DECAP,
1693 * Encapsulate flow in NVGRE tunnel defined in the
1694 * rte_flow_action_nvgre_encap action structure.
1696 * See struct rte_flow_action_nvgre_encap.
1698 RTE_FLOW_ACTION_TYPE_NVGRE_ENCAP,
1701 * Decapsulate outer most NVGRE tunnel from matched flow.
1703 * If flow pattern does not define a valid NVGRE tunnel (as specified by
1704 * RFC7637) then the PMD should return a RTE_FLOW_ERROR_TYPE_ACTION
1707 RTE_FLOW_ACTION_TYPE_NVGRE_DECAP,
1710 * Add outer header whose template is provided in its data buffer
1712 * See struct rte_flow_action_raw_encap.
1714 RTE_FLOW_ACTION_TYPE_RAW_ENCAP,
1717 * Remove outer header whose template is provided in its data buffer.
1719 * See struct rte_flow_action_raw_decap
1721 RTE_FLOW_ACTION_TYPE_RAW_DECAP,
1724 * Modify IPv4 source address in the outermost IPv4 header.
1726 * If flow pattern does not define a valid RTE_FLOW_ITEM_TYPE_IPV4,
1727 * then the PMD should return a RTE_FLOW_ERROR_TYPE_ACTION error.
1729 * See struct rte_flow_action_set_ipv4.
1731 RTE_FLOW_ACTION_TYPE_SET_IPV4_SRC,
1734 * Modify IPv4 destination address in the outermost IPv4 header.
1736 * If flow pattern does not define a valid RTE_FLOW_ITEM_TYPE_IPV4,
1737 * then the PMD should return a RTE_FLOW_ERROR_TYPE_ACTION error.
1739 * See struct rte_flow_action_set_ipv4.
1741 RTE_FLOW_ACTION_TYPE_SET_IPV4_DST,
1744 * Modify IPv6 source address in the outermost IPv6 header.
1746 * If flow pattern does not define a valid RTE_FLOW_ITEM_TYPE_IPV6,
1747 * then the PMD should return a RTE_FLOW_ERROR_TYPE_ACTION error.
1749 * See struct rte_flow_action_set_ipv6.
1751 RTE_FLOW_ACTION_TYPE_SET_IPV6_SRC,
1754 * Modify IPv6 destination address in the outermost IPv6 header.
1756 * If flow pattern does not define a valid RTE_FLOW_ITEM_TYPE_IPV6,
1757 * then the PMD should return a RTE_FLOW_ERROR_TYPE_ACTION error.
1759 * See struct rte_flow_action_set_ipv6.
1761 RTE_FLOW_ACTION_TYPE_SET_IPV6_DST,
1764 * Modify source port number in the outermost TCP/UDP header.
1766 * If flow pattern does not define a valid RTE_FLOW_ITEM_TYPE_TCP
1767 * or RTE_FLOW_ITEM_TYPE_UDP, then the PMD should return a
1768 * RTE_FLOW_ERROR_TYPE_ACTION error.
1770 * See struct rte_flow_action_set_tp.
1772 RTE_FLOW_ACTION_TYPE_SET_TP_SRC,
1775 * Modify destination port number in the outermost TCP/UDP header.
1777 * If flow pattern does not define a valid RTE_FLOW_ITEM_TYPE_TCP
1778 * or RTE_FLOW_ITEM_TYPE_UDP, then the PMD should return a
1779 * RTE_FLOW_ERROR_TYPE_ACTION error.
1781 * See struct rte_flow_action_set_tp.
1783 RTE_FLOW_ACTION_TYPE_SET_TP_DST,
1786 * Swap the source and destination MAC addresses in the outermost
1789 * If flow pattern does not define a valid RTE_FLOW_ITEM_TYPE_ETH,
1790 * then the PMD should return a RTE_FLOW_ERROR_TYPE_ACTION error.
1792 * No associated configuration structure.
1794 RTE_FLOW_ACTION_TYPE_MAC_SWAP,
1797 * Decrease TTL value directly
1799 * No associated configuration structure.
1801 RTE_FLOW_ACTION_TYPE_DEC_TTL,
1806 * See struct rte_flow_action_set_ttl
1808 RTE_FLOW_ACTION_TYPE_SET_TTL,
1811 * Set source MAC address from matched flow.
1813 * If flow pattern does not define a valid RTE_FLOW_ITEM_TYPE_ETH,
1814 * the PMD should return a RTE_FLOW_ERROR_TYPE_ACTION error.
1816 * See struct rte_flow_action_set_mac.
1818 RTE_FLOW_ACTION_TYPE_SET_MAC_SRC,
1821 * Set destination MAC address from matched flow.
1823 * If flow pattern does not define a valid RTE_FLOW_ITEM_TYPE_ETH,
1824 * the PMD should return a RTE_FLOW_ERROR_TYPE_ACTION error.
1826 * See struct rte_flow_action_set_mac.
1828 RTE_FLOW_ACTION_TYPE_SET_MAC_DST,
1831 * Increase sequence number in the outermost TCP header.
1833 * Action configuration specifies the value to increase
1834 * TCP sequence number as a big-endian 32 bit integer.
1837 * @code rte_be32_t * @endcode
1839 * Using this action on non-matching traffic will result in
1840 * undefined behavior.
1842 RTE_FLOW_ACTION_TYPE_INC_TCP_SEQ,
1845 * Decrease sequence number in the outermost TCP header.
1847 * Action configuration specifies the value to decrease
1848 * TCP sequence number as a big-endian 32 bit integer.
1851 * @code rte_be32_t * @endcode
1853 * Using this action on non-matching traffic will result in
1854 * undefined behavior.
1856 RTE_FLOW_ACTION_TYPE_DEC_TCP_SEQ,
1859 * Increase acknowledgment number in the outermost TCP header.
1861 * Action configuration specifies the value to increase
1862 * TCP acknowledgment number as a big-endian 32 bit integer.
1865 * @code rte_be32_t * @endcode
1867 * Using this action on non-matching traffic will result in
1868 * undefined behavior.
1870 RTE_FLOW_ACTION_TYPE_INC_TCP_ACK,
1873 * Decrease acknowledgment number in the outermost TCP header.
1875 * Action configuration specifies the value to decrease
1876 * TCP acknowledgment number as a big-endian 32 bit integer.
1879 * @code rte_be32_t * @endcode
1881 * Using this action on non-matching traffic will result in
1882 * undefined behavior.
1884 RTE_FLOW_ACTION_TYPE_DEC_TCP_ACK,
1888 * RTE_FLOW_ACTION_TYPE_MARK
1890 * Attaches an integer value to packets and sets PKT_RX_FDIR and
1891 * PKT_RX_FDIR_ID mbuf flags.
1893 * This value is arbitrary and application-defined. Maximum allowed value
1894 * depends on the underlying implementation. It is returned in the
1895 * hash.fdir.hi mbuf field.
1897 struct rte_flow_action_mark {
1898 uint32_t id; /**< Integer value to return with packets. */
1903 * @b EXPERIMENTAL: this structure may change without prior notice
1905 * RTE_FLOW_ACTION_TYPE_JUMP
1907 * Redirects packets to a group on the current device.
1909 * In a hierarchy of groups, which can be used to represent physical or logical
1910 * flow tables on the device, this action allows the action to be a redirect to
1911 * a group on that device.
1913 struct rte_flow_action_jump {
1918 * RTE_FLOW_ACTION_TYPE_QUEUE
1920 * Assign packets to a given queue index.
1922 struct rte_flow_action_queue {
1923 uint16_t index; /**< Queue index to use. */
1929 * @b EXPERIMENTAL: this structure may change without prior notice
1931 * RTE_FLOW_ACTION_TYPE_COUNT
1933 * Adds a counter action to a matched flow.
1935 * If more than one count action is specified in a single flow rule, then each
1936 * action must specify a unique id.
1938 * Counters can be retrieved and reset through ``rte_flow_query()``, see
1939 * ``struct rte_flow_query_count``.
1941 * The shared flag indicates whether the counter is unique to the flow rule the
1942 * action is specified with, or whether it is a shared counter.
1944 * For a count action with the shared flag set, then then a global device
1945 * namespace is assumed for the counter id, so that any matched flow rules using
1946 * a count action with the same counter id on the same port will contribute to
1949 * For ports within the same switch domain then the counter id namespace extends
1950 * to all ports within that switch domain.
1952 struct rte_flow_action_count {
1953 uint32_t shared:1; /**< Share counter ID with other flow rules. */
1954 uint32_t reserved:31; /**< Reserved, must be zero. */
1955 uint32_t id; /**< Counter ID. */
1959 * RTE_FLOW_ACTION_TYPE_COUNT (query)
1961 * Query structure to retrieve and reset flow rule counters.
1963 struct rte_flow_query_count {
1964 uint32_t reset:1; /**< Reset counters after query [in]. */
1965 uint32_t hits_set:1; /**< hits field is set [out]. */
1966 uint32_t bytes_set:1; /**< bytes field is set [out]. */
1967 uint32_t reserved:29; /**< Reserved, must be zero [in, out]. */
1968 uint64_t hits; /**< Number of hits for this rule [out]. */
1969 uint64_t bytes; /**< Number of bytes through this rule [out]. */
1973 * Hash function types.
1975 enum rte_eth_hash_function {
1976 RTE_ETH_HASH_FUNCTION_DEFAULT = 0,
1977 RTE_ETH_HASH_FUNCTION_TOEPLITZ, /**< Toeplitz */
1978 RTE_ETH_HASH_FUNCTION_SIMPLE_XOR, /**< Simple XOR */
1980 * Symmetric Toeplitz: src, dst will be replaced by
1981 * xor(src, dst). For the case with src/dst only,
1982 * src or dst address will xor with zero pair.
1984 RTE_ETH_HASH_FUNCTION_SYMMETRIC_TOEPLITZ,
1985 RTE_ETH_HASH_FUNCTION_MAX,
1989 * RTE_FLOW_ACTION_TYPE_RSS
1991 * Similar to QUEUE, except RSS is additionally performed on packets to
1992 * spread them among several queues according to the provided parameters.
1994 * Unlike global RSS settings used by other DPDK APIs, unsetting the
1995 * @p types field does not disable RSS in a flow rule. Doing so instead
1996 * requests safe unspecified "best-effort" settings from the underlying PMD,
1997 * which depending on the flow rule, may result in anything ranging from
1998 * empty (single queue) to all-inclusive RSS.
2000 * Note: RSS hash result is stored in the hash.rss mbuf field which overlaps
2001 * hash.fdir.lo. Since the MARK action sets the hash.fdir.hi field only,
2002 * both can be requested simultaneously.
2004 struct rte_flow_action_rss {
2005 enum rte_eth_hash_function func; /**< RSS hash function to apply. */
2007 * Packet encapsulation level RSS hash @p types apply to.
2009 * - @p 0 requests the default behavior. Depending on the packet
2010 * type, it can mean outermost, innermost, anything in between or
2013 * It basically stands for the innermost encapsulation level RSS
2014 * can be performed on according to PMD and device capabilities.
2016 * - @p 1 requests RSS to be performed on the outermost packet
2017 * encapsulation level.
2019 * - @p 2 and subsequent values request RSS to be performed on the
2020 * specified inner packet encapsulation level, from outermost to
2021 * innermost (lower to higher values).
2023 * Values other than @p 0 are not necessarily supported.
2025 * Requesting a specific RSS level on unrecognized traffic results
2026 * in undefined behavior. For predictable results, it is recommended
2027 * to make the flow rule pattern match packet headers up to the
2028 * requested encapsulation level so that only matching traffic goes
2032 uint64_t types; /**< Specific RSS hash types (see ETH_RSS_*). */
2033 uint32_t key_len; /**< Hash key length in bytes. */
2034 uint32_t queue_num; /**< Number of entries in @p queue. */
2035 const uint8_t *key; /**< Hash key. */
2036 const uint16_t *queue; /**< Queue indices to use. */
2040 * RTE_FLOW_ACTION_TYPE_VF
2042 * Directs matching traffic to a given virtual function of the current
2045 * Packets matched by a VF pattern item can be redirected to their original
2046 * VF ID instead of the specified one. This parameter may not be available
2047 * and is not guaranteed to work properly if the VF part is matched by a
2048 * prior flow rule or if packets are not addressed to a VF in the first
2051 struct rte_flow_action_vf {
2052 uint32_t original:1; /**< Use original VF ID if possible. */
2053 uint32_t reserved:31; /**< Reserved, must be zero. */
2054 uint32_t id; /**< VF ID. */
2058 * RTE_FLOW_ACTION_TYPE_PHY_PORT
2060 * Directs packets to a given physical port index of the underlying
2063 * @see RTE_FLOW_ITEM_TYPE_PHY_PORT
2065 struct rte_flow_action_phy_port {
2066 uint32_t original:1; /**< Use original port index if possible. */
2067 uint32_t reserved:31; /**< Reserved, must be zero. */
2068 uint32_t index; /**< Physical port index. */
2072 * RTE_FLOW_ACTION_TYPE_PORT_ID
2074 * Directs matching traffic to a given DPDK port ID.
2076 * @see RTE_FLOW_ITEM_TYPE_PORT_ID
2078 struct rte_flow_action_port_id {
2079 uint32_t original:1; /**< Use original DPDK port ID if possible. */
2080 uint32_t reserved:31; /**< Reserved, must be zero. */
2081 uint32_t id; /**< DPDK port ID. */
2085 * RTE_FLOW_ACTION_TYPE_METER
2087 * Traffic metering and policing (MTR).
2089 * Packets matched by items of this type can be either dropped or passed to the
2090 * next item with their color set by the MTR object.
2092 struct rte_flow_action_meter {
2093 uint32_t mtr_id; /**< MTR object ID created with rte_mtr_create(). */
2097 * RTE_FLOW_ACTION_TYPE_SECURITY
2099 * Perform the security action on flows matched by the pattern items
2100 * according to the configuration of the security session.
2102 * This action modifies the payload of matched flows. For INLINE_CRYPTO, the
2103 * security protocol headers and IV are fully provided by the application as
2104 * specified in the flow pattern. The payload of matching packets is
2105 * encrypted on egress, and decrypted and authenticated on ingress.
2106 * For INLINE_PROTOCOL, the security protocol is fully offloaded to HW,
2107 * providing full encapsulation and decapsulation of packets in security
2108 * protocols. The flow pattern specifies both the outer security header fields
2109 * and the inner packet fields. The security session specified in the action
2110 * must match the pattern parameters.
2112 * The security session specified in the action must be created on the same
2113 * port as the flow action that is being specified.
2115 * The ingress/egress flow attribute should match that specified in the
2116 * security session if the security session supports the definition of the
2119 * Multiple flows can be configured to use the same security session.
2121 struct rte_flow_action_security {
2122 void *security_session; /**< Pointer to security session structure. */
2126 * RTE_FLOW_ACTION_TYPE_OF_SET_MPLS_TTL
2128 * Implements OFPAT_SET_MPLS_TTL ("MPLS TTL") as defined by the OpenFlow
2129 * Switch Specification.
2131 struct rte_flow_action_of_set_mpls_ttl {
2132 uint8_t mpls_ttl; /**< MPLS TTL. */
2136 * RTE_FLOW_ACTION_TYPE_OF_SET_NW_TTL
2138 * Implements OFPAT_SET_NW_TTL ("IP TTL") as defined by the OpenFlow Switch
2141 struct rte_flow_action_of_set_nw_ttl {
2142 uint8_t nw_ttl; /**< IP TTL. */
2146 * RTE_FLOW_ACTION_TYPE_OF_PUSH_VLAN
2148 * Implements OFPAT_PUSH_VLAN ("push a new VLAN tag") as defined by the
2149 * OpenFlow Switch Specification.
2151 struct rte_flow_action_of_push_vlan {
2152 rte_be16_t ethertype; /**< EtherType. */
2156 * RTE_FLOW_ACTION_TYPE_OF_SET_VLAN_VID
2158 * Implements OFPAT_SET_VLAN_VID ("set the 802.1q VLAN id") as defined by
2159 * the OpenFlow Switch Specification.
2161 struct rte_flow_action_of_set_vlan_vid {
2162 rte_be16_t vlan_vid; /**< VLAN id. */
2166 * RTE_FLOW_ACTION_TYPE_OF_SET_VLAN_PCP
2168 * Implements OFPAT_SET_LAN_PCP ("set the 802.1q priority") as defined by
2169 * the OpenFlow Switch Specification.
2171 struct rte_flow_action_of_set_vlan_pcp {
2172 uint8_t vlan_pcp; /**< VLAN priority. */
2176 * RTE_FLOW_ACTION_TYPE_OF_POP_MPLS
2178 * Implements OFPAT_POP_MPLS ("pop the outer MPLS tag") as defined by the
2179 * OpenFlow Switch Specification.
2181 struct rte_flow_action_of_pop_mpls {
2182 rte_be16_t ethertype; /**< EtherType. */
2186 * RTE_FLOW_ACTION_TYPE_OF_PUSH_MPLS
2188 * Implements OFPAT_PUSH_MPLS ("push a new MPLS tag") as defined by the
2189 * OpenFlow Switch Specification.
2191 struct rte_flow_action_of_push_mpls {
2192 rte_be16_t ethertype; /**< EtherType. */
2197 * @b EXPERIMENTAL: this structure may change without prior notice
2199 * RTE_FLOW_ACTION_TYPE_VXLAN_ENCAP
2201 * VXLAN tunnel end-point encapsulation data definition
2203 * The tunnel definition is provided through the flow item pattern, the
2204 * provided pattern must conform to RFC7348 for the tunnel specified. The flow
2205 * definition must be provided in order from the RTE_FLOW_ITEM_TYPE_ETH
2206 * definition up the end item which is specified by RTE_FLOW_ITEM_TYPE_END.
2208 * The mask field allows user to specify which fields in the flow item
2209 * definitions can be ignored and which have valid data and can be used
2212 * Note: the last field is not used in the definition of a tunnel and can be
2215 * Valid flow definition for RTE_FLOW_ACTION_TYPE_VXLAN_ENCAP include:
2217 * - ETH / IPV4 / UDP / VXLAN / END
2218 * - ETH / IPV6 / UDP / VXLAN / END
2219 * - ETH / VLAN / IPV4 / UDP / VXLAN / END
2222 struct rte_flow_action_vxlan_encap {
2224 * Encapsulating vxlan tunnel definition
2225 * (terminated by the END pattern item).
2227 struct rte_flow_item *definition;
2232 * @b EXPERIMENTAL: this structure may change without prior notice
2234 * RTE_FLOW_ACTION_TYPE_NVGRE_ENCAP
2236 * NVGRE tunnel end-point encapsulation data definition
2238 * The tunnel definition is provided through the flow item pattern the
2239 * provided pattern must conform with RFC7637. The flow definition must be
2240 * provided in order from the RTE_FLOW_ITEM_TYPE_ETH definition up the end item
2241 * which is specified by RTE_FLOW_ITEM_TYPE_END.
2243 * The mask field allows user to specify which fields in the flow item
2244 * definitions can be ignored and which have valid data and can be used
2247 * Note: the last field is not used in the definition of a tunnel and can be
2250 * Valid flow definition for RTE_FLOW_ACTION_TYPE_NVGRE_ENCAP include:
2252 * - ETH / IPV4 / NVGRE / END
2253 * - ETH / VLAN / IPV6 / NVGRE / END
2256 struct rte_flow_action_nvgre_encap {
2258 * Encapsulating vxlan tunnel definition
2259 * (terminated by the END pattern item).
2261 struct rte_flow_item *definition;
2266 * @b EXPERIMENTAL: this structure may change without prior notice
2268 * RTE_FLOW_ACTION_TYPE_RAW_ENCAP
2270 * Raw tunnel end-point encapsulation data definition.
2272 * The data holds the headers definitions to be applied on the packet.
2273 * The data must start with ETH header up to the tunnel item header itself.
2274 * When used right after RAW_DECAP (for decapsulating L3 tunnel type for
2275 * example MPLSoGRE) the data will just hold layer 2 header.
2277 * The preserve parameter holds which bits in the packet the PMD is not allowed
2278 * to change, this parameter can also be NULL and then the PMD is allowed
2279 * to update any field.
2281 * size holds the number of bytes in @p data and @p preserve.
2283 struct rte_flow_action_raw_encap {
2284 uint8_t *data; /**< Encapsulation data. */
2285 uint8_t *preserve; /**< Bit-mask of @p data to preserve on output. */
2286 size_t size; /**< Size of @p data and @p preserve. */
2291 * @b EXPERIMENTAL: this structure may change without prior notice
2293 * RTE_FLOW_ACTION_TYPE_RAW_DECAP
2295 * Raw tunnel end-point decapsulation data definition.
2297 * The data holds the headers definitions to be removed from the packet.
2298 * The data must start with ETH header up to the tunnel item header itself.
2299 * When used right before RAW_DECAP (for encapsulating L3 tunnel type for
2300 * example MPLSoGRE) the data will just hold layer 2 header.
2302 * size holds the number of bytes in @p data.
2304 struct rte_flow_action_raw_decap {
2305 uint8_t *data; /**< Encapsulation data. */
2306 size_t size; /**< Size of @p data and @p preserve. */
2311 * @b EXPERIMENTAL: this structure may change without prior notice
2313 * RTE_FLOW_ACTION_TYPE_SET_IPV4_SRC
2314 * RTE_FLOW_ACTION_TYPE_SET_IPV4_DST
2316 * Allows modification of IPv4 source (RTE_FLOW_ACTION_TYPE_SET_IPV4_SRC)
2317 * and destination address (RTE_FLOW_ACTION_TYPE_SET_IPV4_DST) in the
2318 * specified outermost IPv4 header.
2320 struct rte_flow_action_set_ipv4 {
2321 rte_be32_t ipv4_addr;
2326 * @b EXPERIMENTAL: this structure may change without prior notice
2328 * RTE_FLOW_ACTION_TYPE_SET_IPV6_SRC
2329 * RTE_FLOW_ACTION_TYPE_SET_IPV6_DST
2331 * Allows modification of IPv6 source (RTE_FLOW_ACTION_TYPE_SET_IPV6_SRC)
2332 * and destination address (RTE_FLOW_ACTION_TYPE_SET_IPV6_DST) in the
2333 * specified outermost IPv6 header.
2335 struct rte_flow_action_set_ipv6 {
2336 uint8_t ipv6_addr[16];
2341 * @b EXPERIMENTAL: this structure may change without prior notice
2343 * RTE_FLOW_ACTION_TYPE_SET_TP_SRC
2344 * RTE_FLOW_ACTION_TYPE_SET_TP_DST
2346 * Allows modification of source (RTE_FLOW_ACTION_TYPE_SET_TP_SRC)
2347 * and destination (RTE_FLOW_ACTION_TYPE_SET_TP_DST) port numbers
2348 * in the specified outermost TCP/UDP header.
2350 struct rte_flow_action_set_tp {
2355 * RTE_FLOW_ACTION_TYPE_SET_TTL
2357 * Set the TTL value directly for IPv4 or IPv6
2359 struct rte_flow_action_set_ttl {
2364 * RTE_FLOW_ACTION_TYPE_SET_MAC
2366 * Set MAC address from the matched flow
2368 struct rte_flow_action_set_mac {
2369 uint8_t mac_addr[RTE_ETHER_ADDR_LEN];
2373 * Definition of a single action.
2375 * A list of actions is terminated by a END action.
2377 * For simple actions without a configuration object, conf remains NULL.
2379 struct rte_flow_action {
2380 enum rte_flow_action_type type; /**< Action type. */
2381 const void *conf; /**< Pointer to action configuration object. */
2385 * Opaque type returned after successfully creating a flow.
2387 * This handle can be used to manage and query the related flow (e.g. to
2388 * destroy it or retrieve counters).
2393 * Verbose error types.
2395 * Most of them provide the type of the object referenced by struct
2396 * rte_flow_error.cause.
2398 enum rte_flow_error_type {
2399 RTE_FLOW_ERROR_TYPE_NONE, /**< No error. */
2400 RTE_FLOW_ERROR_TYPE_UNSPECIFIED, /**< Cause unspecified. */
2401 RTE_FLOW_ERROR_TYPE_HANDLE, /**< Flow rule (handle). */
2402 RTE_FLOW_ERROR_TYPE_ATTR_GROUP, /**< Group field. */
2403 RTE_FLOW_ERROR_TYPE_ATTR_PRIORITY, /**< Priority field. */
2404 RTE_FLOW_ERROR_TYPE_ATTR_INGRESS, /**< Ingress field. */
2405 RTE_FLOW_ERROR_TYPE_ATTR_EGRESS, /**< Egress field. */
2406 RTE_FLOW_ERROR_TYPE_ATTR_TRANSFER, /**< Transfer field. */
2407 RTE_FLOW_ERROR_TYPE_ATTR, /**< Attributes structure. */
2408 RTE_FLOW_ERROR_TYPE_ITEM_NUM, /**< Pattern length. */
2409 RTE_FLOW_ERROR_TYPE_ITEM_SPEC, /**< Item specification. */
2410 RTE_FLOW_ERROR_TYPE_ITEM_LAST, /**< Item specification range. */
2411 RTE_FLOW_ERROR_TYPE_ITEM_MASK, /**< Item specification mask. */
2412 RTE_FLOW_ERROR_TYPE_ITEM, /**< Specific pattern item. */
2413 RTE_FLOW_ERROR_TYPE_ACTION_NUM, /**< Number of actions. */
2414 RTE_FLOW_ERROR_TYPE_ACTION_CONF, /**< Action configuration. */
2415 RTE_FLOW_ERROR_TYPE_ACTION, /**< Specific action. */
2419 * Verbose error structure definition.
2421 * This object is normally allocated by applications and set by PMDs, the
2422 * message points to a constant string which does not need to be freed by
2423 * the application, however its pointer can be considered valid only as long
2424 * as its associated DPDK port remains configured. Closing the underlying
2425 * device or unloading the PMD invalidates it.
2427 * Both cause and message may be NULL regardless of the error type.
2429 struct rte_flow_error {
2430 enum rte_flow_error_type type; /**< Cause field and error types. */
2431 const void *cause; /**< Object responsible for the error. */
2432 const char *message; /**< Human-readable error message. */
2436 * Complete flow rule description.
2438 * This object type is used when converting a flow rule description.
2440 * @see RTE_FLOW_CONV_OP_RULE
2441 * @see rte_flow_conv()
2444 struct rte_flow_conv_rule {
2446 const struct rte_flow_attr *attr_ro; /**< RO attributes. */
2447 struct rte_flow_attr *attr; /**< Attributes. */
2450 const struct rte_flow_item *pattern_ro; /**< RO pattern. */
2451 struct rte_flow_item *pattern; /**< Pattern items. */
2454 const struct rte_flow_action *actions_ro; /**< RO actions. */
2455 struct rte_flow_action *actions; /**< List of actions. */
2460 * Conversion operations for flow API objects.
2462 * @see rte_flow_conv()
2464 enum rte_flow_conv_op {
2466 * No operation to perform.
2468 * rte_flow_conv() simply returns 0.
2470 RTE_FLOW_CONV_OP_NONE,
2473 * Convert attributes structure.
2475 * This is a basic copy of an attributes structure.
2478 * @code const struct rte_flow_attr * @endcode
2480 * @code struct rte_flow_attr * @endcode
2482 RTE_FLOW_CONV_OP_ATTR,
2485 * Convert a single item.
2487 * Duplicates @p spec, @p last and @p mask but not outside objects.
2490 * @code const struct rte_flow_item * @endcode
2492 * @code struct rte_flow_item * @endcode
2494 RTE_FLOW_CONV_OP_ITEM,
2497 * Convert a single action.
2499 * Duplicates @p conf but not outside objects.
2502 * @code const struct rte_flow_action * @endcode
2504 * @code struct rte_flow_action * @endcode
2506 RTE_FLOW_CONV_OP_ACTION,
2509 * Convert an entire pattern.
2511 * Duplicates all pattern items at once with the same constraints as
2512 * RTE_FLOW_CONV_OP_ITEM.
2515 * @code const struct rte_flow_item * @endcode
2517 * @code struct rte_flow_item * @endcode
2519 RTE_FLOW_CONV_OP_PATTERN,
2522 * Convert a list of actions.
2524 * Duplicates the entire list of actions at once with the same
2525 * constraints as RTE_FLOW_CONV_OP_ACTION.
2528 * @code const struct rte_flow_action * @endcode
2530 * @code struct rte_flow_action * @endcode
2532 RTE_FLOW_CONV_OP_ACTIONS,
2535 * Convert a complete flow rule description.
2537 * Comprises attributes, pattern and actions together at once with
2538 * the usual constraints.
2541 * @code const struct rte_flow_conv_rule * @endcode
2543 * @code struct rte_flow_conv_rule * @endcode
2545 RTE_FLOW_CONV_OP_RULE,
2548 * Convert item type to its name string.
2550 * Writes a NUL-terminated string to @p dst. Like snprintf(), the
2551 * returned value excludes the terminator which is always written
2555 * @code (const void *)enum rte_flow_item_type @endcode
2557 * @code char * @endcode
2559 RTE_FLOW_CONV_OP_ITEM_NAME,
2562 * Convert action type to its name string.
2564 * Writes a NUL-terminated string to @p dst. Like snprintf(), the
2565 * returned value excludes the terminator which is always written
2569 * @code (const void *)enum rte_flow_action_type @endcode
2571 * @code char * @endcode
2573 RTE_FLOW_CONV_OP_ACTION_NAME,
2576 * Convert item type to pointer to item name.
2578 * Retrieves item name pointer from its type. The string itself is
2579 * not copied; instead, a unique pointer to an internal static
2580 * constant storage is written to @p dst.
2583 * @code (const void *)enum rte_flow_item_type @endcode
2585 * @code const char ** @endcode
2587 RTE_FLOW_CONV_OP_ITEM_NAME_PTR,
2590 * Convert action type to pointer to action name.
2592 * Retrieves action name pointer from its type. The string itself is
2593 * not copied; instead, a unique pointer to an internal static
2594 * constant storage is written to @p dst.
2597 * @code (const void *)enum rte_flow_action_type @endcode
2599 * @code const char ** @endcode
2601 RTE_FLOW_CONV_OP_ACTION_NAME_PTR,
2605 * Check whether a flow rule can be created on a given port.
2607 * The flow rule is validated for correctness and whether it could be accepted
2608 * by the device given sufficient resources. The rule is checked against the
2609 * current device mode and queue configuration. The flow rule may also
2610 * optionally be validated against existing flow rules and device resources.
2611 * This function has no effect on the target device.
2613 * The returned value is guaranteed to remain valid only as long as no
2614 * successful calls to rte_flow_create() or rte_flow_destroy() are made in
2615 * the meantime and no device parameter affecting flow rules in any way are
2616 * modified, due to possible collisions or resource limitations (although in
2617 * such cases EINVAL should not be returned).
2620 * Port identifier of Ethernet device.
2622 * Flow rule attributes.
2623 * @param[in] pattern
2624 * Pattern specification (list terminated by the END pattern item).
2625 * @param[in] actions
2626 * Associated actions (list terminated by the END action).
2628 * Perform verbose error reporting if not NULL. PMDs initialize this
2629 * structure in case of error only.
2632 * 0 if flow rule is valid and can be created. A negative errno value
2633 * otherwise (rte_errno is also set), the following errors are defined:
2635 * -ENOSYS: underlying device does not support this functionality.
2637 * -EIO: underlying device is removed.
2639 * -EINVAL: unknown or invalid rule specification.
2641 * -ENOTSUP: valid but unsupported rule specification (e.g. partial
2642 * bit-masks are unsupported).
2644 * -EEXIST: collision with an existing rule. Only returned if device
2645 * supports flow rule collision checking and there was a flow rule
2646 * collision. Not receiving this return code is no guarantee that creating
2647 * the rule will not fail due to a collision.
2649 * -ENOMEM: not enough memory to execute the function, or if the device
2650 * supports resource validation, resource limitation on the device.
2652 * -EBUSY: action cannot be performed due to busy device resources, may
2653 * succeed if the affected queues or even the entire port are in a stopped
2654 * state (see rte_eth_dev_rx_queue_stop() and rte_eth_dev_stop()).
2657 rte_flow_validate(uint16_t port_id,
2658 const struct rte_flow_attr *attr,
2659 const struct rte_flow_item pattern[],
2660 const struct rte_flow_action actions[],
2661 struct rte_flow_error *error);
2664 * Create a flow rule on a given port.
2667 * Port identifier of Ethernet device.
2669 * Flow rule attributes.
2670 * @param[in] pattern
2671 * Pattern specification (list terminated by the END pattern item).
2672 * @param[in] actions
2673 * Associated actions (list terminated by the END action).
2675 * Perform verbose error reporting if not NULL. PMDs initialize this
2676 * structure in case of error only.
2679 * A valid handle in case of success, NULL otherwise and rte_errno is set
2680 * to the positive version of one of the error codes defined for
2681 * rte_flow_validate().
2684 rte_flow_create(uint16_t port_id,
2685 const struct rte_flow_attr *attr,
2686 const struct rte_flow_item pattern[],
2687 const struct rte_flow_action actions[],
2688 struct rte_flow_error *error);
2691 * Destroy a flow rule on a given port.
2693 * Failure to destroy a flow rule handle may occur when other flow rules
2694 * depend on it, and destroying it would result in an inconsistent state.
2696 * This function is only guaranteed to succeed if handles are destroyed in
2697 * reverse order of their creation.
2700 * Port identifier of Ethernet device.
2702 * Flow rule handle to destroy.
2704 * Perform verbose error reporting if not NULL. PMDs initialize this
2705 * structure in case of error only.
2708 * 0 on success, a negative errno value otherwise and rte_errno is set.
2711 rte_flow_destroy(uint16_t port_id,
2712 struct rte_flow *flow,
2713 struct rte_flow_error *error);
2716 * Destroy all flow rules associated with a port.
2718 * In the unlikely event of failure, handles are still considered destroyed
2719 * and no longer valid but the port must be assumed to be in an inconsistent
2723 * Port identifier of Ethernet device.
2725 * Perform verbose error reporting if not NULL. PMDs initialize this
2726 * structure in case of error only.
2729 * 0 on success, a negative errno value otherwise and rte_errno is set.
2732 rte_flow_flush(uint16_t port_id,
2733 struct rte_flow_error *error);
2736 * Query an existing flow rule.
2738 * This function allows retrieving flow-specific data such as counters.
2739 * Data is gathered by special actions which must be present in the flow
2742 * \see RTE_FLOW_ACTION_TYPE_COUNT
2745 * Port identifier of Ethernet device.
2747 * Flow rule handle to query.
2749 * Action definition as defined in original flow rule.
2750 * @param[in, out] data
2751 * Pointer to storage for the associated query data type.
2753 * Perform verbose error reporting if not NULL. PMDs initialize this
2754 * structure in case of error only.
2757 * 0 on success, a negative errno value otherwise and rte_errno is set.
2760 rte_flow_query(uint16_t port_id,
2761 struct rte_flow *flow,
2762 const struct rte_flow_action *action,
2764 struct rte_flow_error *error);
2767 * Restrict ingress traffic to the defined flow rules.
2769 * Isolated mode guarantees that all ingress traffic comes from defined flow
2770 * rules only (current and future).
2772 * Besides making ingress more deterministic, it allows PMDs to safely reuse
2773 * resources otherwise assigned to handle the remaining traffic, such as
2774 * global RSS configuration settings, VLAN filters, MAC address entries,
2775 * legacy filter API rules and so on in order to expand the set of possible
2778 * Calling this function as soon as possible after device initialization,
2779 * ideally before the first call to rte_eth_dev_configure(), is recommended
2780 * to avoid possible failures due to conflicting settings.
2782 * Once effective, leaving isolated mode may not be possible depending on
2783 * PMD implementation.
2785 * Additionally, the following functionality has no effect on the underlying
2786 * port and may return errors such as ENOTSUP ("not supported"):
2788 * - Toggling promiscuous mode.
2789 * - Toggling allmulticast mode.
2790 * - Configuring MAC addresses.
2791 * - Configuring multicast addresses.
2792 * - Configuring VLAN filters.
2793 * - Configuring Rx filters through the legacy API (e.g. FDIR).
2794 * - Configuring global RSS settings.
2797 * Port identifier of Ethernet device.
2799 * Nonzero to enter isolated mode, attempt to leave it otherwise.
2801 * Perform verbose error reporting if not NULL. PMDs initialize this
2802 * structure in case of error only.
2805 * 0 on success, a negative errno value otherwise and rte_errno is set.
2808 rte_flow_isolate(uint16_t port_id, int set, struct rte_flow_error *error);
2811 * Initialize flow error structure.
2814 * Pointer to flow error structure (may be NULL).
2816 * Related error code (rte_errno).
2818 * Cause field and error types.
2820 * Object responsible for the error.
2822 * Human-readable error message.
2825 * Negative error code (errno value) and rte_errno is set.
2828 rte_flow_error_set(struct rte_flow_error *error,
2830 enum rte_flow_error_type type,
2832 const char *message);
2836 * @see rte_flow_copy()
2838 struct rte_flow_desc {
2839 size_t size; /**< Allocated space including data[]. */
2840 struct rte_flow_attr attr; /**< Attributes. */
2841 struct rte_flow_item *items; /**< Items. */
2842 struct rte_flow_action *actions; /**< Actions. */
2843 uint8_t data[]; /**< Storage for items/actions. */
2848 * Copy an rte_flow rule description.
2850 * This interface is kept for compatibility with older applications but is
2851 * implemented as a wrapper to rte_flow_conv(). It is deprecated due to its
2852 * lack of flexibility and reliance on a type unusable with C++ programs
2853 * (struct rte_flow_desc).
2856 * Flow rule description.
2858 * Total size of allocated data for the flow description.
2860 * Flow rule attributes.
2862 * Pattern specification (list terminated by the END pattern item).
2863 * @param[in] actions
2864 * Associated actions (list terminated by the END action).
2867 * If len is greater or equal to the size of the flow, the total size of the
2868 * flow description and its data.
2869 * If len is lower than the size of the flow, the number of bytes that would
2870 * have been written to desc had it been sufficient. Nothing is written.
2874 rte_flow_copy(struct rte_flow_desc *fd, size_t len,
2875 const struct rte_flow_attr *attr,
2876 const struct rte_flow_item *items,
2877 const struct rte_flow_action *actions);
2880 * Flow object conversion helper.
2882 * This function performs conversion of various flow API objects to a
2883 * pre-allocated destination buffer. See enum rte_flow_conv_op for possible
2884 * operations and details about each of them.
2886 * Since destination buffer must be large enough, it works in a manner
2887 * reminiscent of snprintf():
2889 * - If @p size is 0, @p dst may be a NULL pointer, otherwise @p dst must be
2891 * - If positive, the returned value represents the number of bytes needed
2892 * to store the conversion of @p src to @p dst according to @p op
2893 * regardless of the @p size parameter.
2894 * - Since no more than @p size bytes can be written to @p dst, output is
2895 * truncated and may be inconsistent when the returned value is larger
2897 * - In case of conversion error, a negative error code is returned and
2898 * @p dst contents are unspecified.
2901 * Operation to perform, related to the object type of @p dst.
2903 * Destination buffer address. Must be suitably aligned by the caller.
2905 * Destination buffer size in bytes.
2907 * Source object to copy. Depending on @p op, its type may differ from
2910 * Perform verbose error reporting if not NULL. Initialized in case of
2914 * The number of bytes required to convert @p src to @p dst on success, a
2915 * negative errno value otherwise and rte_errno is set.
2917 * @see rte_flow_conv_op
2921 rte_flow_conv(enum rte_flow_conv_op op,
2925 struct rte_flow_error *error);
2931 #endif /* RTE_FLOW_H_ */