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>
30 #include <rte_higig.h>
32 #include <rte_mbuf_dyn.h>
39 * Flow rule attributes.
41 * Priorities are set on a per rule based within groups.
43 * Lower values denote higher priority, the highest priority for a flow rule
44 * is 0, so that a flow that matches for than one rule, the rule with the
45 * lowest priority value will always be matched.
47 * Although optional, applications are encouraged to group similar rules as
48 * much as possible to fully take advantage of hardware capabilities
49 * (e.g. optimized matching) and work around limitations (e.g. a single
50 * pattern type possibly allowed in a given group). Applications should be
51 * aware that groups are not linked by default, and that they must be
52 * explicitly linked by the application using the JUMP action.
54 * Priority levels are arbitrary and up to the application, they
55 * do not need to be contiguous nor start from 0, however the maximum number
56 * varies between devices and may be affected by existing flow rules.
58 * If a packet is matched by several rules of a given group for a given
59 * priority level, the outcome is undefined. It can take any path, may be
60 * duplicated or even cause unrecoverable errors.
62 * Note that support for more than a single group and priority level is not
65 * Flow rules can apply to inbound and/or outbound traffic (ingress/egress).
67 * Several pattern items and actions are valid and can be used in both
68 * directions. Those valid for only one direction are described as such.
70 * At least one direction must be specified.
72 * Specifying both directions at once for a given rule is not recommended
73 * but may be valid in a few cases (e.g. shared counter).
75 struct rte_flow_attr {
76 uint32_t group; /**< Priority group. */
77 uint32_t priority; /**< Rule priority level within group. */
78 uint32_t ingress:1; /**< Rule applies to ingress traffic. */
79 uint32_t egress:1; /**< Rule applies to egress traffic. */
81 * Instead of simply matching the properties of traffic as it would
82 * appear on a given DPDK port ID, enabling this attribute transfers
83 * a flow rule to the lowest possible level of any device endpoints
84 * found in the pattern.
86 * When supported, this effectively enables an application to
87 * re-route traffic not necessarily intended for it (e.g. coming
88 * from or addressed to different physical ports, VFs or
89 * applications) at the device level.
91 * It complements the behavior of some pattern items such as
92 * RTE_FLOW_ITEM_TYPE_PHY_PORT and is meaningless without them.
94 * When transferring flow rules, ingress and egress attributes keep
95 * their original meaning, as if processing traffic emitted or
96 * received by the application.
99 uint32_t reserved:29; /**< Reserved, must be zero. */
103 * Matching pattern item types.
105 * Pattern items fall in two categories:
107 * - Matching protocol headers and packet data, usually associated with a
108 * specification structure. These must be stacked in the same order as the
109 * protocol layers to match inside packets, starting from the lowest.
111 * - Matching meta-data or affecting pattern processing, often without a
112 * specification structure. Since they do not match packet contents, their
113 * position in the list is usually not relevant.
115 * See the description of individual types for more information. Those
116 * marked with [META] fall into the second category.
118 enum rte_flow_item_type {
122 * End marker for item lists. Prevents further processing of items,
123 * thereby ending the pattern.
125 * No associated specification structure.
127 RTE_FLOW_ITEM_TYPE_END,
132 * Used as a placeholder for convenience. It is ignored and simply
135 * No associated specification structure.
137 RTE_FLOW_ITEM_TYPE_VOID,
142 * Inverted matching, i.e. process packets that do not match the
145 * No associated specification structure.
147 RTE_FLOW_ITEM_TYPE_INVERT,
150 * Matches any protocol in place of the current layer, a single ANY
151 * may also stand for several protocol layers.
153 * See struct rte_flow_item_any.
155 RTE_FLOW_ITEM_TYPE_ANY,
160 * Matches traffic originating from (ingress) or going to (egress)
161 * the physical function of the current device.
163 * No associated specification structure.
165 RTE_FLOW_ITEM_TYPE_PF,
170 * Matches traffic originating from (ingress) or going to (egress) a
171 * given virtual function of the current device.
173 * See struct rte_flow_item_vf.
175 RTE_FLOW_ITEM_TYPE_VF,
180 * Matches traffic originating from (ingress) or going to (egress) a
181 * physical port of the underlying device.
183 * See struct rte_flow_item_phy_port.
185 RTE_FLOW_ITEM_TYPE_PHY_PORT,
190 * Matches traffic originating from (ingress) or going to (egress) a
191 * given DPDK port ID.
193 * See struct rte_flow_item_port_id.
195 RTE_FLOW_ITEM_TYPE_PORT_ID,
198 * Matches a byte string of a given length at a given offset.
200 * See struct rte_flow_item_raw.
202 RTE_FLOW_ITEM_TYPE_RAW,
205 * Matches an Ethernet header.
207 * See struct rte_flow_item_eth.
209 RTE_FLOW_ITEM_TYPE_ETH,
212 * Matches an 802.1Q/ad VLAN tag.
214 * See struct rte_flow_item_vlan.
216 RTE_FLOW_ITEM_TYPE_VLAN,
219 * Matches an IPv4 header.
221 * See struct rte_flow_item_ipv4.
223 RTE_FLOW_ITEM_TYPE_IPV4,
226 * Matches an IPv6 header.
228 * See struct rte_flow_item_ipv6.
230 RTE_FLOW_ITEM_TYPE_IPV6,
233 * Matches an ICMP header.
235 * See struct rte_flow_item_icmp.
237 RTE_FLOW_ITEM_TYPE_ICMP,
240 * Matches a UDP header.
242 * See struct rte_flow_item_udp.
244 RTE_FLOW_ITEM_TYPE_UDP,
247 * Matches a TCP header.
249 * See struct rte_flow_item_tcp.
251 RTE_FLOW_ITEM_TYPE_TCP,
254 * Matches a SCTP header.
256 * See struct rte_flow_item_sctp.
258 RTE_FLOW_ITEM_TYPE_SCTP,
261 * Matches a VXLAN header.
263 * See struct rte_flow_item_vxlan.
265 RTE_FLOW_ITEM_TYPE_VXLAN,
268 * Matches a E_TAG header.
270 * See struct rte_flow_item_e_tag.
272 RTE_FLOW_ITEM_TYPE_E_TAG,
275 * Matches a NVGRE header.
277 * See struct rte_flow_item_nvgre.
279 RTE_FLOW_ITEM_TYPE_NVGRE,
282 * Matches a MPLS header.
284 * See struct rte_flow_item_mpls.
286 RTE_FLOW_ITEM_TYPE_MPLS,
289 * Matches a GRE header.
291 * See struct rte_flow_item_gre.
293 RTE_FLOW_ITEM_TYPE_GRE,
298 * Fuzzy pattern match, expect faster than default.
300 * This is for device that support fuzzy matching option.
301 * Usually a fuzzy matching is fast but the cost is accuracy.
303 * See struct rte_flow_item_fuzzy.
305 RTE_FLOW_ITEM_TYPE_FUZZY,
308 * Matches a GTP header.
310 * Configure flow for GTP packets.
312 * See struct rte_flow_item_gtp.
314 RTE_FLOW_ITEM_TYPE_GTP,
317 * Matches a GTP header.
319 * Configure flow for GTP-C packets.
321 * See struct rte_flow_item_gtp.
323 RTE_FLOW_ITEM_TYPE_GTPC,
326 * Matches a GTP header.
328 * Configure flow for GTP-U packets.
330 * See struct rte_flow_item_gtp.
332 RTE_FLOW_ITEM_TYPE_GTPU,
335 * Matches a ESP header.
337 * See struct rte_flow_item_esp.
339 RTE_FLOW_ITEM_TYPE_ESP,
342 * Matches a GENEVE header.
344 * See struct rte_flow_item_geneve.
346 RTE_FLOW_ITEM_TYPE_GENEVE,
349 * Matches a VXLAN-GPE header.
351 * See struct rte_flow_item_vxlan_gpe.
353 RTE_FLOW_ITEM_TYPE_VXLAN_GPE,
356 * Matches an ARP header for Ethernet/IPv4.
358 * See struct rte_flow_item_arp_eth_ipv4.
360 RTE_FLOW_ITEM_TYPE_ARP_ETH_IPV4,
363 * Matches the presence of any IPv6 extension header.
365 * See struct rte_flow_item_ipv6_ext.
367 RTE_FLOW_ITEM_TYPE_IPV6_EXT,
370 * Matches any ICMPv6 header.
372 * See struct rte_flow_item_icmp6.
374 RTE_FLOW_ITEM_TYPE_ICMP6,
377 * Matches an ICMPv6 neighbor discovery solicitation.
379 * See struct rte_flow_item_icmp6_nd_ns.
381 RTE_FLOW_ITEM_TYPE_ICMP6_ND_NS,
384 * Matches an ICMPv6 neighbor discovery advertisement.
386 * See struct rte_flow_item_icmp6_nd_na.
388 RTE_FLOW_ITEM_TYPE_ICMP6_ND_NA,
391 * Matches the presence of any ICMPv6 neighbor discovery option.
393 * See struct rte_flow_item_icmp6_nd_opt.
395 RTE_FLOW_ITEM_TYPE_ICMP6_ND_OPT,
398 * Matches an ICMPv6 neighbor discovery source Ethernet link-layer
401 * See struct rte_flow_item_icmp6_nd_opt_sla_eth.
403 RTE_FLOW_ITEM_TYPE_ICMP6_ND_OPT_SLA_ETH,
406 * Matches an ICMPv6 neighbor discovery target Ethernet link-layer
409 * See struct rte_flow_item_icmp6_nd_opt_tla_eth.
411 RTE_FLOW_ITEM_TYPE_ICMP6_ND_OPT_TLA_ETH,
414 * Matches specified mark field.
416 * See struct rte_flow_item_mark.
418 RTE_FLOW_ITEM_TYPE_MARK,
423 * Matches a metadata value.
425 * See struct rte_flow_item_meta.
427 RTE_FLOW_ITEM_TYPE_META,
430 * Matches a GRE optional key field.
432 * The value should a big-endian 32bit integer.
434 * When this item present the K bit is implicitly matched as "1"
435 * in the default mask.
438 * @code rte_be32_t * @endcode
440 RTE_FLOW_ITEM_TYPE_GRE_KEY,
443 * Matches a GTP extension header: PDU session container.
445 * Configure flow for GTP packets with extension header type 0x85.
447 * See struct rte_flow_item_gtp_psc.
449 RTE_FLOW_ITEM_TYPE_GTP_PSC,
452 * Matches a PPPoE header.
454 * Configure flow for PPPoE session packets.
456 * See struct rte_flow_item_pppoe.
458 RTE_FLOW_ITEM_TYPE_PPPOES,
461 * Matches a PPPoE header.
463 * Configure flow for PPPoE discovery packets.
465 * See struct rte_flow_item_pppoe.
467 RTE_FLOW_ITEM_TYPE_PPPOED,
470 * Matches a PPPoE optional proto_id field.
472 * It only applies to PPPoE session packets.
474 * See struct rte_flow_item_pppoe_proto_id.
476 RTE_FLOW_ITEM_TYPE_PPPOE_PROTO_ID,
479 * Matches Network service header (NSH).
480 * See struct rte_flow_item_nsh.
483 RTE_FLOW_ITEM_TYPE_NSH,
486 * Matches Internet Group Management Protocol (IGMP).
487 * See struct rte_flow_item_igmp.
490 RTE_FLOW_ITEM_TYPE_IGMP,
493 * Matches IP Authentication Header (AH).
494 * See struct rte_flow_item_ah.
497 RTE_FLOW_ITEM_TYPE_AH,
500 * Matches a HIGIG header.
501 * see struct rte_flow_item_higig2_hdr.
503 RTE_FLOW_ITEM_TYPE_HIGIG2,
508 * Matches a tag value.
510 * See struct rte_flow_item_tag.
512 RTE_FLOW_ITEM_TYPE_TAG,
515 * Matches a L2TPv3 over IP header.
517 * Configure flow for L2TPv3 over IP packets.
519 * See struct rte_flow_item_l2tpv3oip.
521 RTE_FLOW_ITEM_TYPE_L2TPV3OIP,
524 * Matches PFCP Header.
525 * See struct rte_flow_item_pfcp.
528 RTE_FLOW_ITEM_TYPE_PFCP,
534 * RTE_FLOW_ITEM_TYPE_HIGIG2
535 * Matches higig2 header
538 struct rte_flow_item_higig2_hdr {
539 struct rte_higig2_hdr hdr;
542 /** Default mask for RTE_FLOW_ITEM_TYPE_HIGIG2. */
544 static const struct rte_flow_item_higig2_hdr rte_flow_item_higig2_hdr_mask = {
547 .classification = 0xffff,
555 * RTE_FLOW_ITEM_TYPE_ANY
557 * Matches any protocol in place of the current layer, a single ANY may also
558 * stand for several protocol layers.
560 * This is usually specified as the first pattern item when looking for a
561 * protocol anywhere in a packet.
563 * A zeroed mask stands for any number of layers.
565 struct rte_flow_item_any {
566 uint32_t num; /**< Number of layers covered. */
569 /** Default mask for RTE_FLOW_ITEM_TYPE_ANY. */
571 static const struct rte_flow_item_any rte_flow_item_any_mask = {
577 * RTE_FLOW_ITEM_TYPE_VF
579 * Matches traffic originating from (ingress) or going to (egress) a given
580 * virtual function of the current device.
582 * If supported, should work even if the virtual function is not managed by
583 * the application and thus not associated with a DPDK port ID.
585 * Note this pattern item does not match VF representors traffic which, as
586 * separate entities, should be addressed through their own DPDK port IDs.
588 * - Can be specified multiple times to match traffic addressed to several
590 * - Can be combined with a PF item to match both PF and VF traffic.
592 * A zeroed mask can be used to match any VF ID.
594 struct rte_flow_item_vf {
595 uint32_t id; /**< VF ID. */
598 /** Default mask for RTE_FLOW_ITEM_TYPE_VF. */
600 static const struct rte_flow_item_vf rte_flow_item_vf_mask = {
606 * RTE_FLOW_ITEM_TYPE_PHY_PORT
608 * Matches traffic originating from (ingress) or going to (egress) a
609 * physical port of the underlying device.
611 * The first PHY_PORT item overrides the physical port normally associated
612 * with the specified DPDK input port (port_id). This item can be provided
613 * several times to match additional physical ports.
615 * Note that physical ports are not necessarily tied to DPDK input ports
616 * (port_id) when those are not under DPDK control. Possible values are
617 * specific to each device, they are not necessarily indexed from zero and
618 * may not be contiguous.
620 * As a device property, the list of allowed values as well as the value
621 * associated with a port_id should be retrieved by other means.
623 * A zeroed mask can be used to match any port index.
625 struct rte_flow_item_phy_port {
626 uint32_t index; /**< Physical port index. */
629 /** Default mask for RTE_FLOW_ITEM_TYPE_PHY_PORT. */
631 static const struct rte_flow_item_phy_port rte_flow_item_phy_port_mask = {
637 * RTE_FLOW_ITEM_TYPE_PORT_ID
639 * Matches traffic originating from (ingress) or going to (egress) a given
642 * Normally only supported if the port ID in question is known by the
643 * underlying PMD and related to the device the flow rule is created
646 * This must not be confused with @p PHY_PORT which refers to the physical
647 * port of a device, whereas @p PORT_ID refers to a struct rte_eth_dev
648 * object on the application side (also known as "port representor"
649 * depending on the kind of underlying device).
651 struct rte_flow_item_port_id {
652 uint32_t id; /**< DPDK port ID. */
655 /** Default mask for RTE_FLOW_ITEM_TYPE_PORT_ID. */
657 static const struct rte_flow_item_port_id rte_flow_item_port_id_mask = {
663 * RTE_FLOW_ITEM_TYPE_RAW
665 * Matches a byte string of a given length at a given offset.
667 * Offset is either absolute (using the start of the packet) or relative to
668 * the end of the previous matched item in the stack, in which case negative
669 * values are allowed.
671 * If search is enabled, offset is used as the starting point. The search
672 * area can be delimited by setting limit to a nonzero value, which is the
673 * maximum number of bytes after offset where the pattern may start.
675 * Matching a zero-length pattern is allowed, doing so resets the relative
676 * offset for subsequent items.
678 * This type does not support ranges (struct rte_flow_item.last).
680 struct rte_flow_item_raw {
681 uint32_t relative:1; /**< Look for pattern after the previous item. */
682 uint32_t search:1; /**< Search pattern from offset (see also limit). */
683 uint32_t reserved:30; /**< Reserved, must be set to zero. */
684 int32_t offset; /**< Absolute or relative offset for pattern. */
685 uint16_t limit; /**< Search area limit for start of pattern. */
686 uint16_t length; /**< Pattern length. */
687 const uint8_t *pattern; /**< Byte string to look for. */
690 /** Default mask for RTE_FLOW_ITEM_TYPE_RAW. */
692 static const struct rte_flow_item_raw rte_flow_item_raw_mask = {
695 .reserved = 0x3fffffff,
696 .offset = 0xffffffff,
704 * RTE_FLOW_ITEM_TYPE_ETH
706 * Matches an Ethernet header.
708 * The @p type field either stands for "EtherType" or "TPID" when followed
709 * by so-called layer 2.5 pattern items such as RTE_FLOW_ITEM_TYPE_VLAN. In
710 * the latter case, @p type refers to that of the outer header, with the
711 * inner EtherType/TPID provided by the subsequent pattern item. This is the
712 * same order as on the wire.
714 struct rte_flow_item_eth {
715 struct rte_ether_addr dst; /**< Destination MAC. */
716 struct rte_ether_addr src; /**< Source MAC. */
717 rte_be16_t type; /**< EtherType or TPID. */
720 /** Default mask for RTE_FLOW_ITEM_TYPE_ETH. */
722 static const struct rte_flow_item_eth rte_flow_item_eth_mask = {
723 .dst.addr_bytes = "\xff\xff\xff\xff\xff\xff",
724 .src.addr_bytes = "\xff\xff\xff\xff\xff\xff",
725 .type = RTE_BE16(0x0000),
730 * RTE_FLOW_ITEM_TYPE_VLAN
732 * Matches an 802.1Q/ad VLAN tag.
734 * The corresponding standard outer EtherType (TPID) values are
735 * RTE_ETHER_TYPE_VLAN or RTE_ETHER_TYPE_QINQ. It can be overridden by
736 * the preceding pattern item.
738 struct rte_flow_item_vlan {
739 rte_be16_t tci; /**< Tag control information. */
740 rte_be16_t inner_type; /**< Inner EtherType or TPID. */
743 /** Default mask for RTE_FLOW_ITEM_TYPE_VLAN. */
745 static const struct rte_flow_item_vlan rte_flow_item_vlan_mask = {
746 .tci = RTE_BE16(0x0fff),
747 .inner_type = RTE_BE16(0x0000),
752 * RTE_FLOW_ITEM_TYPE_IPV4
754 * Matches an IPv4 header.
756 * Note: IPv4 options are handled by dedicated pattern items.
758 struct rte_flow_item_ipv4 {
759 struct rte_ipv4_hdr hdr; /**< IPv4 header definition. */
762 /** Default mask for RTE_FLOW_ITEM_TYPE_IPV4. */
764 static const struct rte_flow_item_ipv4 rte_flow_item_ipv4_mask = {
766 .src_addr = RTE_BE32(0xffffffff),
767 .dst_addr = RTE_BE32(0xffffffff),
773 * RTE_FLOW_ITEM_TYPE_IPV6.
775 * Matches an IPv6 header.
777 * Note: IPv6 options are handled by dedicated pattern items, see
778 * RTE_FLOW_ITEM_TYPE_IPV6_EXT.
780 struct rte_flow_item_ipv6 {
781 struct rte_ipv6_hdr hdr; /**< IPv6 header definition. */
784 /** Default mask for RTE_FLOW_ITEM_TYPE_IPV6. */
786 static const struct rte_flow_item_ipv6 rte_flow_item_ipv6_mask = {
789 "\xff\xff\xff\xff\xff\xff\xff\xff"
790 "\xff\xff\xff\xff\xff\xff\xff\xff",
792 "\xff\xff\xff\xff\xff\xff\xff\xff"
793 "\xff\xff\xff\xff\xff\xff\xff\xff",
799 * RTE_FLOW_ITEM_TYPE_ICMP.
801 * Matches an ICMP header.
803 struct rte_flow_item_icmp {
804 struct rte_icmp_hdr hdr; /**< ICMP header definition. */
807 /** Default mask for RTE_FLOW_ITEM_TYPE_ICMP. */
809 static const struct rte_flow_item_icmp rte_flow_item_icmp_mask = {
818 * RTE_FLOW_ITEM_TYPE_UDP.
820 * Matches a UDP header.
822 struct rte_flow_item_udp {
823 struct rte_udp_hdr hdr; /**< UDP header definition. */
826 /** Default mask for RTE_FLOW_ITEM_TYPE_UDP. */
828 static const struct rte_flow_item_udp rte_flow_item_udp_mask = {
830 .src_port = RTE_BE16(0xffff),
831 .dst_port = RTE_BE16(0xffff),
837 * RTE_FLOW_ITEM_TYPE_TCP.
839 * Matches a TCP header.
841 struct rte_flow_item_tcp {
842 struct rte_tcp_hdr hdr; /**< TCP header definition. */
845 /** Default mask for RTE_FLOW_ITEM_TYPE_TCP. */
847 static const struct rte_flow_item_tcp rte_flow_item_tcp_mask = {
849 .src_port = RTE_BE16(0xffff),
850 .dst_port = RTE_BE16(0xffff),
856 * RTE_FLOW_ITEM_TYPE_SCTP.
858 * Matches a SCTP header.
860 struct rte_flow_item_sctp {
861 struct rte_sctp_hdr hdr; /**< SCTP header definition. */
864 /** Default mask for RTE_FLOW_ITEM_TYPE_SCTP. */
866 static const struct rte_flow_item_sctp rte_flow_item_sctp_mask = {
868 .src_port = RTE_BE16(0xffff),
869 .dst_port = RTE_BE16(0xffff),
875 * RTE_FLOW_ITEM_TYPE_VXLAN.
877 * Matches a VXLAN header (RFC 7348).
879 struct rte_flow_item_vxlan {
880 uint8_t flags; /**< Normally 0x08 (I flag). */
881 uint8_t rsvd0[3]; /**< Reserved, normally 0x000000. */
882 uint8_t vni[3]; /**< VXLAN identifier. */
883 uint8_t rsvd1; /**< Reserved, normally 0x00. */
886 /** Default mask for RTE_FLOW_ITEM_TYPE_VXLAN. */
888 static const struct rte_flow_item_vxlan rte_flow_item_vxlan_mask = {
889 .vni = "\xff\xff\xff",
894 * RTE_FLOW_ITEM_TYPE_E_TAG.
896 * Matches a E-tag header.
898 * The corresponding standard outer EtherType (TPID) value is
899 * RTE_ETHER_TYPE_ETAG. It can be overridden by the preceding pattern item.
901 struct rte_flow_item_e_tag {
903 * E-Tag control information (E-TCI).
904 * E-PCP (3b), E-DEI (1b), ingress E-CID base (12b).
906 rte_be16_t epcp_edei_in_ecid_b;
907 /** Reserved (2b), GRP (2b), E-CID base (12b). */
908 rte_be16_t rsvd_grp_ecid_b;
909 uint8_t in_ecid_e; /**< Ingress E-CID ext. */
910 uint8_t ecid_e; /**< E-CID ext. */
911 rte_be16_t inner_type; /**< Inner EtherType or TPID. */
914 /** Default mask for RTE_FLOW_ITEM_TYPE_E_TAG. */
916 static const struct rte_flow_item_e_tag rte_flow_item_e_tag_mask = {
917 .rsvd_grp_ecid_b = RTE_BE16(0x3fff),
922 * RTE_FLOW_ITEM_TYPE_NVGRE.
924 * Matches a NVGRE header.
926 struct rte_flow_item_nvgre {
928 * Checksum (1b), undefined (1b), key bit (1b), sequence number (1b),
929 * reserved 0 (9b), version (3b).
931 * c_k_s_rsvd0_ver must have value 0x2000 according to RFC 7637.
933 rte_be16_t c_k_s_rsvd0_ver;
934 rte_be16_t protocol; /**< Protocol type (0x6558). */
935 uint8_t tni[3]; /**< Virtual subnet ID. */
936 uint8_t flow_id; /**< Flow ID. */
939 /** Default mask for RTE_FLOW_ITEM_TYPE_NVGRE. */
941 static const struct rte_flow_item_nvgre rte_flow_item_nvgre_mask = {
942 .tni = "\xff\xff\xff",
947 * RTE_FLOW_ITEM_TYPE_MPLS.
949 * Matches a MPLS header.
951 struct rte_flow_item_mpls {
953 * Label (20b), TC (3b), Bottom of Stack (1b).
955 uint8_t label_tc_s[3];
956 uint8_t ttl; /** Time-to-Live. */
959 /** Default mask for RTE_FLOW_ITEM_TYPE_MPLS. */
961 static const struct rte_flow_item_mpls rte_flow_item_mpls_mask = {
962 .label_tc_s = "\xff\xff\xf0",
967 * RTE_FLOW_ITEM_TYPE_GRE.
969 * Matches a GRE header.
971 struct rte_flow_item_gre {
973 * Checksum (1b), reserved 0 (12b), version (3b).
976 rte_be16_t c_rsvd0_ver;
977 rte_be16_t protocol; /**< Protocol type. */
980 /** Default mask for RTE_FLOW_ITEM_TYPE_GRE. */
982 static const struct rte_flow_item_gre rte_flow_item_gre_mask = {
983 .protocol = RTE_BE16(0xffff),
988 * RTE_FLOW_ITEM_TYPE_FUZZY
990 * Fuzzy pattern match, expect faster than default.
992 * This is for device that support fuzzy match option.
993 * Usually a fuzzy match is fast but the cost is accuracy.
994 * i.e. Signature Match only match pattern's hash value, but it is
995 * possible two different patterns have the same hash value.
997 * Matching accuracy level can be configure by threshold.
998 * Driver can divide the range of threshold and map to different
999 * accuracy levels that device support.
1001 * Threshold 0 means perfect match (no fuzziness), while threshold
1002 * 0xffffffff means fuzziest match.
1004 struct rte_flow_item_fuzzy {
1005 uint32_t thresh; /**< Accuracy threshold. */
1008 /** Default mask for RTE_FLOW_ITEM_TYPE_FUZZY. */
1010 static const struct rte_flow_item_fuzzy rte_flow_item_fuzzy_mask = {
1011 .thresh = 0xffffffff,
1016 * RTE_FLOW_ITEM_TYPE_GTP.
1018 * Matches a GTPv1 header.
1020 struct rte_flow_item_gtp {
1022 * Version (3b), protocol type (1b), reserved (1b),
1023 * Extension header flag (1b),
1024 * Sequence number flag (1b),
1025 * N-PDU number flag (1b).
1027 uint8_t v_pt_rsv_flags;
1028 uint8_t msg_type; /**< Message type. */
1029 rte_be16_t msg_len; /**< Message length. */
1030 rte_be32_t teid; /**< Tunnel endpoint identifier. */
1033 /** Default mask for RTE_FLOW_ITEM_TYPE_GTP. */
1035 static const struct rte_flow_item_gtp rte_flow_item_gtp_mask = {
1036 .teid = RTE_BE32(0xffffffff),
1041 * RTE_FLOW_ITEM_TYPE_ESP
1043 * Matches an ESP header.
1045 struct rte_flow_item_esp {
1046 struct rte_esp_hdr hdr; /**< ESP header definition. */
1049 /** Default mask for RTE_FLOW_ITEM_TYPE_ESP. */
1051 static const struct rte_flow_item_esp rte_flow_item_esp_mask = {
1053 .spi = RTE_BE32(0xffffffff),
1059 * RTE_FLOW_ITEM_TYPE_GENEVE.
1061 * Matches a GENEVE header.
1063 struct rte_flow_item_geneve {
1065 * Version (2b), length of the options fields (6b), OAM packet (1b),
1066 * critical options present (1b), reserved 0 (6b).
1068 rte_be16_t ver_opt_len_o_c_rsvd0;
1069 rte_be16_t protocol; /**< Protocol type. */
1070 uint8_t vni[3]; /**< Virtual Network Identifier. */
1071 uint8_t rsvd1; /**< Reserved, normally 0x00. */
1074 /** Default mask for RTE_FLOW_ITEM_TYPE_GENEVE. */
1076 static const struct rte_flow_item_geneve rte_flow_item_geneve_mask = {
1077 .vni = "\xff\xff\xff",
1082 * RTE_FLOW_ITEM_TYPE_VXLAN_GPE (draft-ietf-nvo3-vxlan-gpe-05).
1084 * Matches a VXLAN-GPE header.
1086 struct rte_flow_item_vxlan_gpe {
1087 uint8_t flags; /**< Normally 0x0c (I and P flags). */
1088 uint8_t rsvd0[2]; /**< Reserved, normally 0x0000. */
1089 uint8_t protocol; /**< Protocol type. */
1090 uint8_t vni[3]; /**< VXLAN identifier. */
1091 uint8_t rsvd1; /**< Reserved, normally 0x00. */
1094 /** Default mask for RTE_FLOW_ITEM_TYPE_VXLAN_GPE. */
1096 static const struct rte_flow_item_vxlan_gpe rte_flow_item_vxlan_gpe_mask = {
1097 .vni = "\xff\xff\xff",
1102 * RTE_FLOW_ITEM_TYPE_ARP_ETH_IPV4
1104 * Matches an ARP header for Ethernet/IPv4.
1106 struct rte_flow_item_arp_eth_ipv4 {
1107 rte_be16_t hrd; /**< Hardware type, normally 1. */
1108 rte_be16_t pro; /**< Protocol type, normally 0x0800. */
1109 uint8_t hln; /**< Hardware address length, normally 6. */
1110 uint8_t pln; /**< Protocol address length, normally 4. */
1111 rte_be16_t op; /**< Opcode (1 for request, 2 for reply). */
1112 struct rte_ether_addr sha; /**< Sender hardware address. */
1113 rte_be32_t spa; /**< Sender IPv4 address. */
1114 struct rte_ether_addr tha; /**< Target hardware address. */
1115 rte_be32_t tpa; /**< Target IPv4 address. */
1118 /** Default mask for RTE_FLOW_ITEM_TYPE_ARP_ETH_IPV4. */
1120 static const struct rte_flow_item_arp_eth_ipv4
1121 rte_flow_item_arp_eth_ipv4_mask = {
1122 .sha.addr_bytes = "\xff\xff\xff\xff\xff\xff",
1123 .spa = RTE_BE32(0xffffffff),
1124 .tha.addr_bytes = "\xff\xff\xff\xff\xff\xff",
1125 .tpa = RTE_BE32(0xffffffff),
1130 * RTE_FLOW_ITEM_TYPE_IPV6_EXT
1132 * Matches the presence of any IPv6 extension header.
1134 * Normally preceded by any of:
1136 * - RTE_FLOW_ITEM_TYPE_IPV6
1137 * - RTE_FLOW_ITEM_TYPE_IPV6_EXT
1139 struct rte_flow_item_ipv6_ext {
1140 uint8_t next_hdr; /**< Next header. */
1143 /** Default mask for RTE_FLOW_ITEM_TYPE_IPV6_EXT. */
1146 struct rte_flow_item_ipv6_ext rte_flow_item_ipv6_ext_mask = {
1152 * RTE_FLOW_ITEM_TYPE_ICMP6
1154 * Matches any ICMPv6 header.
1156 struct rte_flow_item_icmp6 {
1157 uint8_t type; /**< ICMPv6 type. */
1158 uint8_t code; /**< ICMPv6 code. */
1159 uint16_t checksum; /**< ICMPv6 checksum. */
1162 /** Default mask for RTE_FLOW_ITEM_TYPE_ICMP6. */
1164 static const struct rte_flow_item_icmp6 rte_flow_item_icmp6_mask = {
1171 * RTE_FLOW_ITEM_TYPE_ICMP6_ND_NS
1173 * Matches an ICMPv6 neighbor discovery solicitation.
1175 struct rte_flow_item_icmp6_nd_ns {
1176 uint8_t type; /**< ICMPv6 type, normally 135. */
1177 uint8_t code; /**< ICMPv6 code, normally 0. */
1178 rte_be16_t checksum; /**< ICMPv6 checksum. */
1179 rte_be32_t reserved; /**< Reserved, normally 0. */
1180 uint8_t target_addr[16]; /**< Target address. */
1183 /** Default mask for RTE_FLOW_ITEM_TYPE_ICMP6_ND_NS. */
1186 struct rte_flow_item_icmp6_nd_ns rte_flow_item_icmp6_nd_ns_mask = {
1188 "\xff\xff\xff\xff\xff\xff\xff\xff"
1189 "\xff\xff\xff\xff\xff\xff\xff\xff",
1194 * RTE_FLOW_ITEM_TYPE_ICMP6_ND_NA
1196 * Matches an ICMPv6 neighbor discovery advertisement.
1198 struct rte_flow_item_icmp6_nd_na {
1199 uint8_t type; /**< ICMPv6 type, normally 136. */
1200 uint8_t code; /**< ICMPv6 code, normally 0. */
1201 rte_be16_t checksum; /**< ICMPv6 checksum. */
1203 * Route flag (1b), solicited flag (1b), override flag (1b),
1206 rte_be32_t rso_reserved;
1207 uint8_t target_addr[16]; /**< Target address. */
1210 /** Default mask for RTE_FLOW_ITEM_TYPE_ICMP6_ND_NA. */
1213 struct rte_flow_item_icmp6_nd_na rte_flow_item_icmp6_nd_na_mask = {
1215 "\xff\xff\xff\xff\xff\xff\xff\xff"
1216 "\xff\xff\xff\xff\xff\xff\xff\xff",
1221 * RTE_FLOW_ITEM_TYPE_ICMP6_ND_OPT
1223 * Matches the presence of any ICMPv6 neighbor discovery option.
1225 * Normally preceded by any of:
1227 * - RTE_FLOW_ITEM_TYPE_ICMP6_ND_NA
1228 * - RTE_FLOW_ITEM_TYPE_ICMP6_ND_NS
1229 * - RTE_FLOW_ITEM_TYPE_ICMP6_ND_OPT
1231 struct rte_flow_item_icmp6_nd_opt {
1232 uint8_t type; /**< ND option type. */
1233 uint8_t length; /**< ND option length. */
1236 /** Default mask for RTE_FLOW_ITEM_TYPE_ICMP6_ND_OPT. */
1238 static const struct rte_flow_item_icmp6_nd_opt
1239 rte_flow_item_icmp6_nd_opt_mask = {
1245 * RTE_FLOW_ITEM_TYPE_ICMP6_ND_OPT_SLA_ETH
1247 * Matches an ICMPv6 neighbor discovery source Ethernet link-layer address
1250 * Normally preceded by any of:
1252 * - RTE_FLOW_ITEM_TYPE_ICMP6_ND_NA
1253 * - RTE_FLOW_ITEM_TYPE_ICMP6_ND_OPT
1255 struct rte_flow_item_icmp6_nd_opt_sla_eth {
1256 uint8_t type; /**< ND option type, normally 1. */
1257 uint8_t length; /**< ND option length, normally 1. */
1258 struct rte_ether_addr sla; /**< Source Ethernet LLA. */
1261 /** Default mask for RTE_FLOW_ITEM_TYPE_ICMP6_ND_OPT_SLA_ETH. */
1263 static const struct rte_flow_item_icmp6_nd_opt_sla_eth
1264 rte_flow_item_icmp6_nd_opt_sla_eth_mask = {
1265 .sla.addr_bytes = "\xff\xff\xff\xff\xff\xff",
1270 * RTE_FLOW_ITEM_TYPE_ICMP6_ND_OPT_TLA_ETH
1272 * Matches an ICMPv6 neighbor discovery target Ethernet link-layer address
1275 * Normally preceded by any of:
1277 * - RTE_FLOW_ITEM_TYPE_ICMP6_ND_NS
1278 * - RTE_FLOW_ITEM_TYPE_ICMP6_ND_OPT
1280 struct rte_flow_item_icmp6_nd_opt_tla_eth {
1281 uint8_t type; /**< ND option type, normally 2. */
1282 uint8_t length; /**< ND option length, normally 1. */
1283 struct rte_ether_addr tla; /**< Target Ethernet LLA. */
1286 /** Default mask for RTE_FLOW_ITEM_TYPE_ICMP6_ND_OPT_TLA_ETH. */
1288 static const struct rte_flow_item_icmp6_nd_opt_tla_eth
1289 rte_flow_item_icmp6_nd_opt_tla_eth_mask = {
1290 .tla.addr_bytes = "\xff\xff\xff\xff\xff\xff",
1295 * RTE_FLOW_ITEM_TYPE_META
1297 * Matches a specified metadata value. On egress, metadata can be set
1298 * either by mbuf dynamic metadata field with PKT_TX_DYNF_METADATA flag or
1299 * RTE_FLOW_ACTION_TYPE_SET_META. On ingress, RTE_FLOW_ACTION_TYPE_SET_META
1300 * sets metadata for a packet and the metadata will be reported via mbuf
1301 * metadata dynamic field with PKT_RX_DYNF_METADATA flag. The dynamic mbuf
1302 * field must be registered in advance by rte_flow_dynf_metadata_register().
1304 struct rte_flow_item_meta {
1308 /** Default mask for RTE_FLOW_ITEM_TYPE_META. */
1310 static const struct rte_flow_item_meta rte_flow_item_meta_mask = {
1316 * RTE_FLOW_ITEM_TYPE_GTP_PSC.
1318 * Matches a GTP PDU extension header with type 0x85.
1320 struct rte_flow_item_gtp_psc {
1321 uint8_t pdu_type; /**< PDU type. */
1322 uint8_t qfi; /**< QoS flow identifier. */
1325 /** Default mask for RTE_FLOW_ITEM_TYPE_GTP_PSC. */
1327 static const struct rte_flow_item_gtp_psc
1328 rte_flow_item_gtp_psc_mask = {
1334 * RTE_FLOW_ITEM_TYPE_PPPOE.
1336 * Matches a PPPoE header.
1338 struct rte_flow_item_pppoe {
1340 * Version (4b), type (4b).
1342 uint8_t version_type;
1343 uint8_t code; /**< Message type. */
1344 rte_be16_t session_id; /**< Session identifier. */
1345 rte_be16_t length; /**< Payload length. */
1349 * RTE_FLOW_ITEM_TYPE_PPPOE_PROTO_ID.
1351 * Matches a PPPoE optional proto_id field.
1353 * It only applies to PPPoE session packets.
1355 * Normally preceded by any of:
1357 * - RTE_FLOW_ITEM_TYPE_PPPOE
1358 * - RTE_FLOW_ITEM_TYPE_PPPOE_PROTO_ID
1360 struct rte_flow_item_pppoe_proto_id {
1361 rte_be16_t proto_id; /**< PPP protocol identifier. */
1364 /** Default mask for RTE_FLOW_ITEM_TYPE_PPPOE_PROTO_ID. */
1366 static const struct rte_flow_item_pppoe_proto_id
1367 rte_flow_item_pppoe_proto_id_mask = {
1368 .proto_id = RTE_BE16(0xffff),
1374 * @b EXPERIMENTAL: this structure may change without prior notice
1376 * RTE_FLOW_ITEM_TYPE_TAG
1378 * Matches a specified tag value at the specified index.
1380 struct rte_flow_item_tag {
1385 /** Default mask for RTE_FLOW_ITEM_TYPE_TAG. */
1387 static const struct rte_flow_item_tag rte_flow_item_tag_mask = {
1394 * RTE_FLOW_ITEM_TYPE_L2TPV3OIP.
1396 * Matches a L2TPv3 over IP header.
1398 struct rte_flow_item_l2tpv3oip {
1399 rte_be32_t session_id; /**< Session ID. */
1402 /** Default mask for RTE_FLOW_ITEM_TYPE_L2TPV3OIP. */
1404 static const struct rte_flow_item_l2tpv3oip rte_flow_item_l2tpv3oip_mask = {
1405 .session_id = RTE_BE32(UINT32_MAX),
1412 * @b EXPERIMENTAL: this structure may change without prior notice
1414 * RTE_FLOW_ITEM_TYPE_MARK
1416 * Matches an arbitrary integer value which was set using the ``MARK`` action
1417 * in a previously matched rule.
1419 * This item can only be specified once as a match criteria as the ``MARK``
1420 * action can only be specified once in a flow action.
1422 * This value is arbitrary and application-defined. Maximum allowed value
1423 * depends on the underlying implementation.
1425 * Depending on the underlying implementation the MARK item may be supported on
1426 * the physical device, with virtual groups in the PMD or not at all.
1428 struct rte_flow_item_mark {
1429 uint32_t id; /**< Integer value to match against. */
1432 /** Default mask for RTE_FLOW_ITEM_TYPE_MARK. */
1434 static const struct rte_flow_item_mark rte_flow_item_mark_mask = {
1441 * @b EXPERIMENTAL: this structure may change without prior notice
1443 * RTE_FLOW_ITEM_TYPE_NSH
1445 * Match network service header (NSH), RFC 8300
1448 struct rte_flow_item_nsh {
1451 uint32_t reserved:1;
1454 uint32_t reserved1:4;
1456 uint32_t next_proto:8;
1461 /** Default mask for RTE_FLOW_ITEM_TYPE_NSH. */
1463 static const struct rte_flow_item_nsh rte_flow_item_nsh_mask = {
1473 * @b EXPERIMENTAL: this structure may change without prior notice
1475 * RTE_FLOW_ITEM_TYPE_IGMP
1477 * Match Internet Group Management Protocol (IGMP), RFC 2236
1480 struct rte_flow_item_igmp {
1482 uint32_t max_resp_time:8;
1483 uint32_t checksum:16;
1484 uint32_t group_addr;
1487 /** Default mask for RTE_FLOW_ITEM_TYPE_IGMP. */
1489 static const struct rte_flow_item_igmp rte_flow_item_igmp_mask = {
1490 .group_addr = 0xffffffff,
1496 * @b EXPERIMENTAL: this structure may change without prior notice
1498 * RTE_FLOW_ITEM_TYPE_AH
1500 * Match IP Authentication Header (AH), RFC 4302
1503 struct rte_flow_item_ah {
1504 uint32_t next_hdr:8;
1505 uint32_t payload_len:8;
1506 uint32_t reserved:16;
1511 /** Default mask for RTE_FLOW_ITEM_TYPE_AH. */
1513 static const struct rte_flow_item_ah rte_flow_item_ah_mask = {
1520 * @b EXPERIMENTAL: this structure may change without prior notice
1522 * RTE_FLOW_ITEM_TYPE_PFCP
1526 struct rte_flow_item_pfcp {
1533 /** Default mask for RTE_FLOW_ITEM_TYPE_PFCP. */
1535 static const struct rte_flow_item_pfcp rte_flow_item_pfcp_mask = {
1537 .seid = RTE_BE64(0xffffffffffffffff),
1542 * Matching pattern item definition.
1544 * A pattern is formed by stacking items starting from the lowest protocol
1545 * layer to match. This stacking restriction does not apply to meta items
1546 * which can be placed anywhere in the stack without affecting the meaning
1547 * of the resulting pattern.
1549 * Patterns are terminated by END items.
1551 * The spec field should be a valid pointer to a structure of the related
1552 * item type. It may remain unspecified (NULL) in many cases to request
1553 * broad (nonspecific) matching. In such cases, last and mask must also be
1556 * Optionally, last can point to a structure of the same type to define an
1557 * inclusive range. This is mostly supported by integer and address fields,
1558 * may cause errors otherwise. Fields that do not support ranges must be set
1559 * to 0 or to the same value as the corresponding fields in spec.
1561 * Only the fields defined to nonzero values in the default masks (see
1562 * rte_flow_item_{name}_mask constants) are considered relevant by
1563 * default. This can be overridden by providing a mask structure of the
1564 * same type with applicable bits set to one. It can also be used to
1565 * partially filter out specific fields (e.g. as an alternate mean to match
1566 * ranges of IP addresses).
1568 * Mask is a simple bit-mask applied before interpreting the contents of
1569 * spec and last, which may yield unexpected results if not used
1570 * carefully. For example, if for an IPv4 address field, spec provides
1571 * 10.1.2.3, last provides 10.3.4.5 and mask provides 255.255.0.0, the
1572 * effective range becomes 10.1.0.0 to 10.3.255.255.
1574 struct rte_flow_item {
1575 enum rte_flow_item_type type; /**< Item type. */
1576 const void *spec; /**< Pointer to item specification structure. */
1577 const void *last; /**< Defines an inclusive range (spec to last). */
1578 const void *mask; /**< Bit-mask applied to spec and last. */
1584 * Each possible action is represented by a type.
1585 * An action can have an associated configuration object.
1586 * Several actions combined in a list can be assigned
1587 * to a flow rule and are performed in order.
1589 * They fall in three categories:
1591 * - Actions that modify the fate of matching traffic, for instance by
1592 * dropping or assigning it a specific destination.
1594 * - Actions that modify matching traffic contents or its properties. This
1595 * includes adding/removing encapsulation, encryption, compression and
1598 * - Actions related to the flow rule itself, such as updating counters or
1599 * making it non-terminating.
1601 * Flow rules being terminating by default, not specifying any action of the
1602 * fate kind results in undefined behavior. This applies to both ingress and
1605 * PASSTHRU, when supported, makes a flow rule non-terminating.
1607 enum rte_flow_action_type {
1609 * End marker for action lists. Prevents further processing of
1610 * actions, thereby ending the list.
1612 * No associated configuration structure.
1614 RTE_FLOW_ACTION_TYPE_END,
1617 * Used as a placeholder for convenience. It is ignored and simply
1618 * discarded by PMDs.
1620 * No associated configuration structure.
1622 RTE_FLOW_ACTION_TYPE_VOID,
1625 * Leaves traffic up for additional processing by subsequent flow
1626 * rules; makes a flow rule non-terminating.
1628 * No associated configuration structure.
1630 RTE_FLOW_ACTION_TYPE_PASSTHRU,
1633 * RTE_FLOW_ACTION_TYPE_JUMP
1635 * Redirects packets to a group on the current device.
1637 * See struct rte_flow_action_jump.
1639 RTE_FLOW_ACTION_TYPE_JUMP,
1642 * Attaches an integer value to packets and sets PKT_RX_FDIR and
1643 * PKT_RX_FDIR_ID mbuf flags.
1645 * See struct rte_flow_action_mark.
1647 RTE_FLOW_ACTION_TYPE_MARK,
1650 * Flags packets. Similar to MARK without a specific value; only
1651 * sets the PKT_RX_FDIR mbuf flag.
1653 * No associated configuration structure.
1655 RTE_FLOW_ACTION_TYPE_FLAG,
1658 * Assigns packets to a given queue index.
1660 * See struct rte_flow_action_queue.
1662 RTE_FLOW_ACTION_TYPE_QUEUE,
1667 * PASSTHRU overrides this action if both are specified.
1669 * No associated configuration structure.
1671 RTE_FLOW_ACTION_TYPE_DROP,
1674 * Enables counters for this flow rule.
1676 * These counters can be retrieved and reset through rte_flow_query(),
1677 * see struct rte_flow_query_count.
1679 * See struct rte_flow_action_count.
1681 RTE_FLOW_ACTION_TYPE_COUNT,
1684 * Similar to QUEUE, except RSS is additionally performed on packets
1685 * to spread them among several queues according to the provided
1688 * See struct rte_flow_action_rss.
1690 RTE_FLOW_ACTION_TYPE_RSS,
1693 * Directs matching traffic to the physical function (PF) of the
1696 * No associated configuration structure.
1698 RTE_FLOW_ACTION_TYPE_PF,
1701 * Directs matching traffic to a given virtual function of the
1704 * See struct rte_flow_action_vf.
1706 RTE_FLOW_ACTION_TYPE_VF,
1709 * Directs packets to a given physical port index of the underlying
1712 * See struct rte_flow_action_phy_port.
1714 RTE_FLOW_ACTION_TYPE_PHY_PORT,
1717 * Directs matching traffic to a given DPDK port ID.
1719 * See struct rte_flow_action_port_id.
1721 RTE_FLOW_ACTION_TYPE_PORT_ID,
1724 * Traffic metering and policing (MTR).
1726 * See struct rte_flow_action_meter.
1727 * See file rte_mtr.h for MTR object configuration.
1729 RTE_FLOW_ACTION_TYPE_METER,
1732 * Redirects packets to security engine of current device for security
1733 * processing as specified by security session.
1735 * See struct rte_flow_action_security.
1737 RTE_FLOW_ACTION_TYPE_SECURITY,
1740 * Implements OFPAT_SET_MPLS_TTL ("MPLS TTL") as defined by the
1741 * OpenFlow Switch Specification.
1743 * See struct rte_flow_action_of_set_mpls_ttl.
1745 RTE_FLOW_ACTION_TYPE_OF_SET_MPLS_TTL,
1748 * Implements OFPAT_DEC_MPLS_TTL ("decrement MPLS TTL") as defined
1749 * by the OpenFlow Switch Specification.
1751 * No associated configuration structure.
1753 RTE_FLOW_ACTION_TYPE_OF_DEC_MPLS_TTL,
1756 * Implements OFPAT_SET_NW_TTL ("IP TTL") as defined by the OpenFlow
1757 * Switch Specification.
1759 * See struct rte_flow_action_of_set_nw_ttl.
1761 RTE_FLOW_ACTION_TYPE_OF_SET_NW_TTL,
1764 * Implements OFPAT_DEC_NW_TTL ("decrement IP TTL") as defined by
1765 * the OpenFlow Switch Specification.
1767 * No associated configuration structure.
1769 RTE_FLOW_ACTION_TYPE_OF_DEC_NW_TTL,
1772 * Implements OFPAT_COPY_TTL_OUT ("copy TTL "outwards" -- from
1773 * next-to-outermost to outermost") as defined by the OpenFlow
1774 * Switch Specification.
1776 * No associated configuration structure.
1778 RTE_FLOW_ACTION_TYPE_OF_COPY_TTL_OUT,
1781 * Implements OFPAT_COPY_TTL_IN ("copy TTL "inwards" -- from
1782 * outermost to next-to-outermost") as defined by the OpenFlow
1783 * Switch Specification.
1785 * No associated configuration structure.
1787 RTE_FLOW_ACTION_TYPE_OF_COPY_TTL_IN,
1790 * Implements OFPAT_POP_VLAN ("pop the outer VLAN tag") as defined
1791 * by the OpenFlow Switch Specification.
1793 * No associated configuration structure.
1795 RTE_FLOW_ACTION_TYPE_OF_POP_VLAN,
1798 * Implements OFPAT_PUSH_VLAN ("push a new VLAN tag") as defined by
1799 * the OpenFlow Switch Specification.
1801 * See struct rte_flow_action_of_push_vlan.
1803 RTE_FLOW_ACTION_TYPE_OF_PUSH_VLAN,
1806 * Implements OFPAT_SET_VLAN_VID ("set the 802.1q VLAN id") as
1807 * defined by the OpenFlow Switch Specification.
1809 * See struct rte_flow_action_of_set_vlan_vid.
1811 RTE_FLOW_ACTION_TYPE_OF_SET_VLAN_VID,
1814 * Implements OFPAT_SET_LAN_PCP ("set the 802.1q priority") as
1815 * defined by the OpenFlow Switch Specification.
1817 * See struct rte_flow_action_of_set_vlan_pcp.
1819 RTE_FLOW_ACTION_TYPE_OF_SET_VLAN_PCP,
1822 * Implements OFPAT_POP_MPLS ("pop the outer MPLS tag") as defined
1823 * by the OpenFlow Switch Specification.
1825 * See struct rte_flow_action_of_pop_mpls.
1827 RTE_FLOW_ACTION_TYPE_OF_POP_MPLS,
1830 * Implements OFPAT_PUSH_MPLS ("push a new MPLS tag") as defined by
1831 * the OpenFlow Switch Specification.
1833 * See struct rte_flow_action_of_push_mpls.
1835 RTE_FLOW_ACTION_TYPE_OF_PUSH_MPLS,
1838 * Encapsulate flow in VXLAN tunnel as defined in
1839 * rte_flow_action_vxlan_encap action structure.
1841 * See struct rte_flow_action_vxlan_encap.
1843 RTE_FLOW_ACTION_TYPE_VXLAN_ENCAP,
1846 * Decapsulate outer most VXLAN tunnel from matched flow.
1848 * If flow pattern does not define a valid VXLAN tunnel (as specified by
1849 * RFC7348) then the PMD should return a RTE_FLOW_ERROR_TYPE_ACTION
1852 RTE_FLOW_ACTION_TYPE_VXLAN_DECAP,
1855 * Encapsulate flow in NVGRE tunnel defined in the
1856 * rte_flow_action_nvgre_encap action structure.
1858 * See struct rte_flow_action_nvgre_encap.
1860 RTE_FLOW_ACTION_TYPE_NVGRE_ENCAP,
1863 * Decapsulate outer most NVGRE tunnel from matched flow.
1865 * If flow pattern does not define a valid NVGRE tunnel (as specified by
1866 * RFC7637) then the PMD should return a RTE_FLOW_ERROR_TYPE_ACTION
1869 RTE_FLOW_ACTION_TYPE_NVGRE_DECAP,
1872 * Add outer header whose template is provided in its data buffer
1874 * See struct rte_flow_action_raw_encap.
1876 RTE_FLOW_ACTION_TYPE_RAW_ENCAP,
1879 * Remove outer header whose template is provided in its data buffer.
1881 * See struct rte_flow_action_raw_decap
1883 RTE_FLOW_ACTION_TYPE_RAW_DECAP,
1886 * Modify IPv4 source address in the outermost IPv4 header.
1888 * If flow pattern does not define a valid RTE_FLOW_ITEM_TYPE_IPV4,
1889 * then the PMD should return a RTE_FLOW_ERROR_TYPE_ACTION error.
1891 * See struct rte_flow_action_set_ipv4.
1893 RTE_FLOW_ACTION_TYPE_SET_IPV4_SRC,
1896 * Modify IPv4 destination address in the outermost IPv4 header.
1898 * If flow pattern does not define a valid RTE_FLOW_ITEM_TYPE_IPV4,
1899 * then the PMD should return a RTE_FLOW_ERROR_TYPE_ACTION error.
1901 * See struct rte_flow_action_set_ipv4.
1903 RTE_FLOW_ACTION_TYPE_SET_IPV4_DST,
1906 * Modify IPv6 source address in the outermost IPv6 header.
1908 * If flow pattern does not define a valid RTE_FLOW_ITEM_TYPE_IPV6,
1909 * then the PMD should return a RTE_FLOW_ERROR_TYPE_ACTION error.
1911 * See struct rte_flow_action_set_ipv6.
1913 RTE_FLOW_ACTION_TYPE_SET_IPV6_SRC,
1916 * Modify IPv6 destination address in the outermost IPv6 header.
1918 * If flow pattern does not define a valid RTE_FLOW_ITEM_TYPE_IPV6,
1919 * then the PMD should return a RTE_FLOW_ERROR_TYPE_ACTION error.
1921 * See struct rte_flow_action_set_ipv6.
1923 RTE_FLOW_ACTION_TYPE_SET_IPV6_DST,
1926 * Modify source port number in the outermost TCP/UDP header.
1928 * If flow pattern does not define a valid RTE_FLOW_ITEM_TYPE_TCP
1929 * or RTE_FLOW_ITEM_TYPE_UDP, then the PMD should return a
1930 * RTE_FLOW_ERROR_TYPE_ACTION error.
1932 * See struct rte_flow_action_set_tp.
1934 RTE_FLOW_ACTION_TYPE_SET_TP_SRC,
1937 * Modify destination port number in the outermost TCP/UDP header.
1939 * If flow pattern does not define a valid RTE_FLOW_ITEM_TYPE_TCP
1940 * or RTE_FLOW_ITEM_TYPE_UDP, then the PMD should return a
1941 * RTE_FLOW_ERROR_TYPE_ACTION error.
1943 * See struct rte_flow_action_set_tp.
1945 RTE_FLOW_ACTION_TYPE_SET_TP_DST,
1948 * Swap the source and destination MAC addresses in the outermost
1951 * If flow pattern does not define a valid RTE_FLOW_ITEM_TYPE_ETH,
1952 * then the PMD should return a RTE_FLOW_ERROR_TYPE_ACTION error.
1954 * No associated configuration structure.
1956 RTE_FLOW_ACTION_TYPE_MAC_SWAP,
1959 * Decrease TTL value directly
1961 * No associated configuration structure.
1963 RTE_FLOW_ACTION_TYPE_DEC_TTL,
1968 * See struct rte_flow_action_set_ttl
1970 RTE_FLOW_ACTION_TYPE_SET_TTL,
1973 * Set source MAC address from matched flow.
1975 * If flow pattern does not define a valid RTE_FLOW_ITEM_TYPE_ETH,
1976 * the PMD should return a RTE_FLOW_ERROR_TYPE_ACTION error.
1978 * See struct rte_flow_action_set_mac.
1980 RTE_FLOW_ACTION_TYPE_SET_MAC_SRC,
1983 * Set destination MAC address from matched flow.
1985 * If flow pattern does not define a valid RTE_FLOW_ITEM_TYPE_ETH,
1986 * the PMD should return a RTE_FLOW_ERROR_TYPE_ACTION error.
1988 * See struct rte_flow_action_set_mac.
1990 RTE_FLOW_ACTION_TYPE_SET_MAC_DST,
1993 * Increase sequence number in the outermost TCP header.
1995 * Action configuration specifies the value to increase
1996 * TCP sequence number as a big-endian 32 bit integer.
1999 * @code rte_be32_t * @endcode
2001 * Using this action on non-matching traffic will result in
2002 * undefined behavior.
2004 RTE_FLOW_ACTION_TYPE_INC_TCP_SEQ,
2007 * Decrease sequence number in the outermost TCP header.
2009 * Action configuration specifies the value to decrease
2010 * TCP sequence number as a big-endian 32 bit integer.
2013 * @code rte_be32_t * @endcode
2015 * Using this action on non-matching traffic will result in
2016 * undefined behavior.
2018 RTE_FLOW_ACTION_TYPE_DEC_TCP_SEQ,
2021 * Increase acknowledgment number in the outermost TCP header.
2023 * Action configuration specifies the value to increase
2024 * TCP acknowledgment number as a big-endian 32 bit integer.
2027 * @code rte_be32_t * @endcode
2029 * Using this action on non-matching traffic will result in
2030 * undefined behavior.
2032 RTE_FLOW_ACTION_TYPE_INC_TCP_ACK,
2035 * Decrease acknowledgment number in the outermost TCP header.
2037 * Action configuration specifies the value to decrease
2038 * TCP acknowledgment number as a big-endian 32 bit integer.
2041 * @code rte_be32_t * @endcode
2043 * Using this action on non-matching traffic will result in
2044 * undefined behavior.
2046 RTE_FLOW_ACTION_TYPE_DEC_TCP_ACK,
2051 * Tag is for internal flow usage only and
2052 * is not delivered to the application.
2054 * See struct rte_flow_action_set_tag.
2056 RTE_FLOW_ACTION_TYPE_SET_TAG,
2059 * Set metadata on ingress or egress path.
2061 * See struct rte_flow_action_set_meta.
2063 RTE_FLOW_ACTION_TYPE_SET_META,
2066 * Modify IPv4 DSCP in the outermost IP header.
2068 * If flow pattern does not define a valid RTE_FLOW_ITEM_TYPE_IPV4,
2069 * then the PMD should return a RTE_FLOW_ERROR_TYPE_ACTION error.
2071 * See struct rte_flow_action_set_dscp.
2073 RTE_FLOW_ACTION_TYPE_SET_IPV4_DSCP,
2076 * Modify IPv6 DSCP in the outermost IP header.
2078 * If flow pattern does not define a valid RTE_FLOW_ITEM_TYPE_IPV6,
2079 * then the PMD should return a RTE_FLOW_ERROR_TYPE_ACTION error.
2081 * See struct rte_flow_action_set_dscp.
2083 RTE_FLOW_ACTION_TYPE_SET_IPV6_DSCP,
2087 * RTE_FLOW_ACTION_TYPE_MARK
2089 * Attaches an integer value to packets and sets PKT_RX_FDIR and
2090 * PKT_RX_FDIR_ID mbuf flags.
2092 * This value is arbitrary and application-defined. Maximum allowed value
2093 * depends on the underlying implementation. It is returned in the
2094 * hash.fdir.hi mbuf field.
2096 struct rte_flow_action_mark {
2097 uint32_t id; /**< Integer value to return with packets. */
2102 * @b EXPERIMENTAL: this structure may change without prior notice
2104 * RTE_FLOW_ACTION_TYPE_JUMP
2106 * Redirects packets to a group on the current device.
2108 * In a hierarchy of groups, which can be used to represent physical or logical
2109 * flow tables on the device, this action allows the action to be a redirect to
2110 * a group on that device.
2112 struct rte_flow_action_jump {
2117 * RTE_FLOW_ACTION_TYPE_QUEUE
2119 * Assign packets to a given queue index.
2121 struct rte_flow_action_queue {
2122 uint16_t index; /**< Queue index to use. */
2128 * @b EXPERIMENTAL: this structure may change without prior notice
2130 * RTE_FLOW_ACTION_TYPE_COUNT
2132 * Adds a counter action to a matched flow.
2134 * If more than one count action is specified in a single flow rule, then each
2135 * action must specify a unique id.
2137 * Counters can be retrieved and reset through ``rte_flow_query()``, see
2138 * ``struct rte_flow_query_count``.
2140 * The shared flag indicates whether the counter is unique to the flow rule the
2141 * action is specified with, or whether it is a shared counter.
2143 * For a count action with the shared flag set, then then a global device
2144 * namespace is assumed for the counter id, so that any matched flow rules using
2145 * a count action with the same counter id on the same port will contribute to
2148 * For ports within the same switch domain then the counter id namespace extends
2149 * to all ports within that switch domain.
2151 struct rte_flow_action_count {
2152 uint32_t shared:1; /**< Share counter ID with other flow rules. */
2153 uint32_t reserved:31; /**< Reserved, must be zero. */
2154 uint32_t id; /**< Counter ID. */
2158 * RTE_FLOW_ACTION_TYPE_COUNT (query)
2160 * Query structure to retrieve and reset flow rule counters.
2162 struct rte_flow_query_count {
2163 uint32_t reset:1; /**< Reset counters after query [in]. */
2164 uint32_t hits_set:1; /**< hits field is set [out]. */
2165 uint32_t bytes_set:1; /**< bytes field is set [out]. */
2166 uint32_t reserved:29; /**< Reserved, must be zero [in, out]. */
2167 uint64_t hits; /**< Number of hits for this rule [out]. */
2168 uint64_t bytes; /**< Number of bytes through this rule [out]. */
2172 * Hash function types.
2174 enum rte_eth_hash_function {
2175 RTE_ETH_HASH_FUNCTION_DEFAULT = 0,
2176 RTE_ETH_HASH_FUNCTION_TOEPLITZ, /**< Toeplitz */
2177 RTE_ETH_HASH_FUNCTION_SIMPLE_XOR, /**< Simple XOR */
2179 * Symmetric Toeplitz: src, dst will be replaced by
2180 * xor(src, dst). For the case with src/dst only,
2181 * src or dst address will xor with zero pair.
2183 RTE_ETH_HASH_FUNCTION_SYMMETRIC_TOEPLITZ,
2184 RTE_ETH_HASH_FUNCTION_MAX,
2188 * RTE_FLOW_ACTION_TYPE_RSS
2190 * Similar to QUEUE, except RSS is additionally performed on packets to
2191 * spread them among several queues according to the provided parameters.
2193 * Unlike global RSS settings used by other DPDK APIs, unsetting the
2194 * @p types field does not disable RSS in a flow rule. Doing so instead
2195 * requests safe unspecified "best-effort" settings from the underlying PMD,
2196 * which depending on the flow rule, may result in anything ranging from
2197 * empty (single queue) to all-inclusive RSS.
2199 * Note: RSS hash result is stored in the hash.rss mbuf field which overlaps
2200 * hash.fdir.lo. Since the MARK action sets the hash.fdir.hi field only,
2201 * both can be requested simultaneously.
2203 struct rte_flow_action_rss {
2204 enum rte_eth_hash_function func; /**< RSS hash function to apply. */
2206 * Packet encapsulation level RSS hash @p types apply to.
2208 * - @p 0 requests the default behavior. Depending on the packet
2209 * type, it can mean outermost, innermost, anything in between or
2212 * It basically stands for the innermost encapsulation level RSS
2213 * can be performed on according to PMD and device capabilities.
2215 * - @p 1 requests RSS to be performed on the outermost packet
2216 * encapsulation level.
2218 * - @p 2 and subsequent values request RSS to be performed on the
2219 * specified inner packet encapsulation level, from outermost to
2220 * innermost (lower to higher values).
2222 * Values other than @p 0 are not necessarily supported.
2224 * Requesting a specific RSS level on unrecognized traffic results
2225 * in undefined behavior. For predictable results, it is recommended
2226 * to make the flow rule pattern match packet headers up to the
2227 * requested encapsulation level so that only matching traffic goes
2231 uint64_t types; /**< Specific RSS hash types (see ETH_RSS_*). */
2232 uint32_t key_len; /**< Hash key length in bytes. */
2233 uint32_t queue_num; /**< Number of entries in @p queue. */
2234 const uint8_t *key; /**< Hash key. */
2235 const uint16_t *queue; /**< Queue indices to use. */
2239 * RTE_FLOW_ACTION_TYPE_VF
2241 * Directs matching traffic to a given virtual function of the current
2244 * Packets matched by a VF pattern item can be redirected to their original
2245 * VF ID instead of the specified one. This parameter may not be available
2246 * and is not guaranteed to work properly if the VF part is matched by a
2247 * prior flow rule or if packets are not addressed to a VF in the first
2250 struct rte_flow_action_vf {
2251 uint32_t original:1; /**< Use original VF ID if possible. */
2252 uint32_t reserved:31; /**< Reserved, must be zero. */
2253 uint32_t id; /**< VF ID. */
2257 * RTE_FLOW_ACTION_TYPE_PHY_PORT
2259 * Directs packets to a given physical port index of the underlying
2262 * @see RTE_FLOW_ITEM_TYPE_PHY_PORT
2264 struct rte_flow_action_phy_port {
2265 uint32_t original:1; /**< Use original port index if possible. */
2266 uint32_t reserved:31; /**< Reserved, must be zero. */
2267 uint32_t index; /**< Physical port index. */
2271 * RTE_FLOW_ACTION_TYPE_PORT_ID
2273 * Directs matching traffic to a given DPDK port ID.
2275 * @see RTE_FLOW_ITEM_TYPE_PORT_ID
2277 struct rte_flow_action_port_id {
2278 uint32_t original:1; /**< Use original DPDK port ID if possible. */
2279 uint32_t reserved:31; /**< Reserved, must be zero. */
2280 uint32_t id; /**< DPDK port ID. */
2284 * RTE_FLOW_ACTION_TYPE_METER
2286 * Traffic metering and policing (MTR).
2288 * Packets matched by items of this type can be either dropped or passed to the
2289 * next item with their color set by the MTR object.
2291 struct rte_flow_action_meter {
2292 uint32_t mtr_id; /**< MTR object ID created with rte_mtr_create(). */
2296 * RTE_FLOW_ACTION_TYPE_SECURITY
2298 * Perform the security action on flows matched by the pattern items
2299 * according to the configuration of the security session.
2301 * This action modifies the payload of matched flows. For INLINE_CRYPTO, the
2302 * security protocol headers and IV are fully provided by the application as
2303 * specified in the flow pattern. The payload of matching packets is
2304 * encrypted on egress, and decrypted and authenticated on ingress.
2305 * For INLINE_PROTOCOL, the security protocol is fully offloaded to HW,
2306 * providing full encapsulation and decapsulation of packets in security
2307 * protocols. The flow pattern specifies both the outer security header fields
2308 * and the inner packet fields. The security session specified in the action
2309 * must match the pattern parameters.
2311 * The security session specified in the action must be created on the same
2312 * port as the flow action that is being specified.
2314 * The ingress/egress flow attribute should match that specified in the
2315 * security session if the security session supports the definition of the
2318 * Multiple flows can be configured to use the same security session.
2320 * The NULL value is allowed for security session. If security session is NULL,
2321 * then SPI field in ESP flow item and IP addresses in flow items 'IPv4' and
2322 * 'IPv6' will be allowed to be a range. The rule thus created can enable
2323 * security processing on multiple flows.
2325 struct rte_flow_action_security {
2326 void *security_session; /**< Pointer to security session structure. */
2330 * RTE_FLOW_ACTION_TYPE_OF_SET_MPLS_TTL
2332 * Implements OFPAT_SET_MPLS_TTL ("MPLS TTL") as defined by the OpenFlow
2333 * Switch Specification.
2335 struct rte_flow_action_of_set_mpls_ttl {
2336 uint8_t mpls_ttl; /**< MPLS TTL. */
2340 * RTE_FLOW_ACTION_TYPE_OF_SET_NW_TTL
2342 * Implements OFPAT_SET_NW_TTL ("IP TTL") as defined by the OpenFlow Switch
2345 struct rte_flow_action_of_set_nw_ttl {
2346 uint8_t nw_ttl; /**< IP TTL. */
2350 * RTE_FLOW_ACTION_TYPE_OF_PUSH_VLAN
2352 * Implements OFPAT_PUSH_VLAN ("push a new VLAN tag") as defined by the
2353 * OpenFlow Switch Specification.
2355 struct rte_flow_action_of_push_vlan {
2356 rte_be16_t ethertype; /**< EtherType. */
2360 * RTE_FLOW_ACTION_TYPE_OF_SET_VLAN_VID
2362 * Implements OFPAT_SET_VLAN_VID ("set the 802.1q VLAN id") as defined by
2363 * the OpenFlow Switch Specification.
2365 struct rte_flow_action_of_set_vlan_vid {
2366 rte_be16_t vlan_vid; /**< VLAN id. */
2370 * RTE_FLOW_ACTION_TYPE_OF_SET_VLAN_PCP
2372 * Implements OFPAT_SET_LAN_PCP ("set the 802.1q priority") as defined by
2373 * the OpenFlow Switch Specification.
2375 struct rte_flow_action_of_set_vlan_pcp {
2376 uint8_t vlan_pcp; /**< VLAN priority. */
2380 * RTE_FLOW_ACTION_TYPE_OF_POP_MPLS
2382 * Implements OFPAT_POP_MPLS ("pop the outer MPLS tag") as defined by the
2383 * OpenFlow Switch Specification.
2385 struct rte_flow_action_of_pop_mpls {
2386 rte_be16_t ethertype; /**< EtherType. */
2390 * RTE_FLOW_ACTION_TYPE_OF_PUSH_MPLS
2392 * Implements OFPAT_PUSH_MPLS ("push a new MPLS tag") as defined by the
2393 * OpenFlow Switch Specification.
2395 struct rte_flow_action_of_push_mpls {
2396 rte_be16_t ethertype; /**< EtherType. */
2401 * @b EXPERIMENTAL: this structure may change without prior notice
2403 * RTE_FLOW_ACTION_TYPE_VXLAN_ENCAP
2405 * VXLAN tunnel end-point encapsulation data definition
2407 * The tunnel definition is provided through the flow item pattern, the
2408 * provided pattern must conform to RFC7348 for the tunnel specified. The flow
2409 * definition must be provided in order from the RTE_FLOW_ITEM_TYPE_ETH
2410 * definition up the end item which is specified by RTE_FLOW_ITEM_TYPE_END.
2412 * The mask field allows user to specify which fields in the flow item
2413 * definitions can be ignored and which have valid data and can be used
2416 * Note: the last field is not used in the definition of a tunnel and can be
2419 * Valid flow definition for RTE_FLOW_ACTION_TYPE_VXLAN_ENCAP include:
2421 * - ETH / IPV4 / UDP / VXLAN / END
2422 * - ETH / IPV6 / UDP / VXLAN / END
2423 * - ETH / VLAN / IPV4 / UDP / VXLAN / END
2426 struct rte_flow_action_vxlan_encap {
2428 * Encapsulating vxlan tunnel definition
2429 * (terminated by the END pattern item).
2431 struct rte_flow_item *definition;
2436 * @b EXPERIMENTAL: this structure may change without prior notice
2438 * RTE_FLOW_ACTION_TYPE_NVGRE_ENCAP
2440 * NVGRE tunnel end-point encapsulation data definition
2442 * The tunnel definition is provided through the flow item pattern the
2443 * provided pattern must conform with RFC7637. The flow definition must be
2444 * provided in order from the RTE_FLOW_ITEM_TYPE_ETH definition up the end item
2445 * which is specified by RTE_FLOW_ITEM_TYPE_END.
2447 * The mask field allows user to specify which fields in the flow item
2448 * definitions can be ignored and which have valid data and can be used
2451 * Note: the last field is not used in the definition of a tunnel and can be
2454 * Valid flow definition for RTE_FLOW_ACTION_TYPE_NVGRE_ENCAP include:
2456 * - ETH / IPV4 / NVGRE / END
2457 * - ETH / VLAN / IPV6 / NVGRE / END
2460 struct rte_flow_action_nvgre_encap {
2462 * Encapsulating vxlan tunnel definition
2463 * (terminated by the END pattern item).
2465 struct rte_flow_item *definition;
2470 * @b EXPERIMENTAL: this structure may change without prior notice
2472 * RTE_FLOW_ACTION_TYPE_RAW_ENCAP
2474 * Raw tunnel end-point encapsulation data definition.
2476 * The data holds the headers definitions to be applied on the packet.
2477 * The data must start with ETH header up to the tunnel item header itself.
2478 * When used right after RAW_DECAP (for decapsulating L3 tunnel type for
2479 * example MPLSoGRE) the data will just hold layer 2 header.
2481 * The preserve parameter holds which bits in the packet the PMD is not allowed
2482 * to change, this parameter can also be NULL and then the PMD is allowed
2483 * to update any field.
2485 * size holds the number of bytes in @p data and @p preserve.
2487 struct rte_flow_action_raw_encap {
2488 uint8_t *data; /**< Encapsulation data. */
2489 uint8_t *preserve; /**< Bit-mask of @p data to preserve on output. */
2490 size_t size; /**< Size of @p data and @p preserve. */
2495 * @b EXPERIMENTAL: this structure may change without prior notice
2497 * RTE_FLOW_ACTION_TYPE_RAW_DECAP
2499 * Raw tunnel end-point decapsulation data definition.
2501 * The data holds the headers definitions to be removed from the packet.
2502 * The data must start with ETH header up to the tunnel item header itself.
2503 * When used right before RAW_DECAP (for encapsulating L3 tunnel type for
2504 * example MPLSoGRE) the data will just hold layer 2 header.
2506 * size holds the number of bytes in @p data.
2508 struct rte_flow_action_raw_decap {
2509 uint8_t *data; /**< Encapsulation data. */
2510 size_t size; /**< Size of @p data and @p preserve. */
2515 * @b EXPERIMENTAL: this structure may change without prior notice
2517 * RTE_FLOW_ACTION_TYPE_SET_IPV4_SRC
2518 * RTE_FLOW_ACTION_TYPE_SET_IPV4_DST
2520 * Allows modification of IPv4 source (RTE_FLOW_ACTION_TYPE_SET_IPV4_SRC)
2521 * and destination address (RTE_FLOW_ACTION_TYPE_SET_IPV4_DST) in the
2522 * specified outermost IPv4 header.
2524 struct rte_flow_action_set_ipv4 {
2525 rte_be32_t ipv4_addr;
2530 * @b EXPERIMENTAL: this structure may change without prior notice
2532 * RTE_FLOW_ACTION_TYPE_SET_IPV6_SRC
2533 * RTE_FLOW_ACTION_TYPE_SET_IPV6_DST
2535 * Allows modification of IPv6 source (RTE_FLOW_ACTION_TYPE_SET_IPV6_SRC)
2536 * and destination address (RTE_FLOW_ACTION_TYPE_SET_IPV6_DST) in the
2537 * specified outermost IPv6 header.
2539 struct rte_flow_action_set_ipv6 {
2540 uint8_t ipv6_addr[16];
2545 * @b EXPERIMENTAL: this structure may change without prior notice
2547 * RTE_FLOW_ACTION_TYPE_SET_TP_SRC
2548 * RTE_FLOW_ACTION_TYPE_SET_TP_DST
2550 * Allows modification of source (RTE_FLOW_ACTION_TYPE_SET_TP_SRC)
2551 * and destination (RTE_FLOW_ACTION_TYPE_SET_TP_DST) port numbers
2552 * in the specified outermost TCP/UDP header.
2554 struct rte_flow_action_set_tp {
2559 * RTE_FLOW_ACTION_TYPE_SET_TTL
2561 * Set the TTL value directly for IPv4 or IPv6
2563 struct rte_flow_action_set_ttl {
2568 * RTE_FLOW_ACTION_TYPE_SET_MAC
2570 * Set MAC address from the matched flow
2572 struct rte_flow_action_set_mac {
2573 uint8_t mac_addr[RTE_ETHER_ADDR_LEN];
2578 * @b EXPERIMENTAL: this structure may change without prior notice
2580 * RTE_FLOW_ACTION_TYPE_SET_TAG
2582 * Set a tag which is a transient data used during flow matching. This is not
2583 * delivered to application. Multiple tags are supported by specifying index.
2585 struct rte_flow_action_set_tag {
2593 * @b EXPERIMENTAL: this structure may change without prior notice
2595 * RTE_FLOW_ACTION_TYPE_SET_META
2597 * Set metadata. Metadata set by mbuf metadata dynamic field with
2598 * PKT_TX_DYNF_DATA flag on egress will be overridden by this action. On
2599 * ingress, the metadata will be carried by mbuf metadata dynamic field
2600 * with PKT_RX_DYNF_METADATA flag if set. The dynamic mbuf field must be
2601 * registered in advance by rte_flow_dynf_metadata_register().
2603 * Altering partial bits is supported with mask. For bits which have never
2604 * been set, unpredictable value will be seen depending on driver
2605 * implementation. For loopback/hairpin packet, metadata set on Rx/Tx may
2606 * or may not be propagated to the other path depending on HW capability.
2608 * RTE_FLOW_ITEM_TYPE_META matches metadata.
2610 struct rte_flow_action_set_meta {
2616 * RTE_FLOW_ACTION_TYPE_SET_IPV4_DSCP
2617 * RTE_FLOW_ACTION_TYPE_SET_IPV6_DSCP
2619 * Set the DSCP value for IPv4/IPv6 header.
2620 * DSCP in low 6 bits, rest ignored.
2622 struct rte_flow_action_set_dscp {
2626 /* Mbuf dynamic field offset for metadata. */
2627 extern int rte_flow_dynf_metadata_offs;
2629 /* Mbuf dynamic field flag mask for metadata. */
2630 extern uint64_t rte_flow_dynf_metadata_mask;
2632 /* Mbuf dynamic field pointer for metadata. */
2633 #define RTE_FLOW_DYNF_METADATA(m) \
2634 RTE_MBUF_DYNFIELD((m), rte_flow_dynf_metadata_offs, uint32_t *)
2636 /* Mbuf dynamic flags for metadata. */
2637 #define PKT_RX_DYNF_METADATA (rte_flow_dynf_metadata_mask)
2638 #define PKT_TX_DYNF_METADATA (rte_flow_dynf_metadata_mask)
2641 static inline uint32_t
2642 rte_flow_dynf_metadata_get(struct rte_mbuf *m)
2644 return *RTE_FLOW_DYNF_METADATA(m);
2649 rte_flow_dynf_metadata_set(struct rte_mbuf *m, uint32_t v)
2651 *RTE_FLOW_DYNF_METADATA(m) = v;
2655 * Definition of a single action.
2657 * A list of actions is terminated by a END action.
2659 * For simple actions without a configuration object, conf remains NULL.
2661 struct rte_flow_action {
2662 enum rte_flow_action_type type; /**< Action type. */
2663 const void *conf; /**< Pointer to action configuration object. */
2667 * Opaque type returned after successfully creating a flow.
2669 * This handle can be used to manage and query the related flow (e.g. to
2670 * destroy it or retrieve counters).
2675 * Verbose error types.
2677 * Most of them provide the type of the object referenced by struct
2678 * rte_flow_error.cause.
2680 enum rte_flow_error_type {
2681 RTE_FLOW_ERROR_TYPE_NONE, /**< No error. */
2682 RTE_FLOW_ERROR_TYPE_UNSPECIFIED, /**< Cause unspecified. */
2683 RTE_FLOW_ERROR_TYPE_HANDLE, /**< Flow rule (handle). */
2684 RTE_FLOW_ERROR_TYPE_ATTR_GROUP, /**< Group field. */
2685 RTE_FLOW_ERROR_TYPE_ATTR_PRIORITY, /**< Priority field. */
2686 RTE_FLOW_ERROR_TYPE_ATTR_INGRESS, /**< Ingress field. */
2687 RTE_FLOW_ERROR_TYPE_ATTR_EGRESS, /**< Egress field. */
2688 RTE_FLOW_ERROR_TYPE_ATTR_TRANSFER, /**< Transfer field. */
2689 RTE_FLOW_ERROR_TYPE_ATTR, /**< Attributes structure. */
2690 RTE_FLOW_ERROR_TYPE_ITEM_NUM, /**< Pattern length. */
2691 RTE_FLOW_ERROR_TYPE_ITEM_SPEC, /**< Item specification. */
2692 RTE_FLOW_ERROR_TYPE_ITEM_LAST, /**< Item specification range. */
2693 RTE_FLOW_ERROR_TYPE_ITEM_MASK, /**< Item specification mask. */
2694 RTE_FLOW_ERROR_TYPE_ITEM, /**< Specific pattern item. */
2695 RTE_FLOW_ERROR_TYPE_ACTION_NUM, /**< Number of actions. */
2696 RTE_FLOW_ERROR_TYPE_ACTION_CONF, /**< Action configuration. */
2697 RTE_FLOW_ERROR_TYPE_ACTION, /**< Specific action. */
2701 * Verbose error structure definition.
2703 * This object is normally allocated by applications and set by PMDs, the
2704 * message points to a constant string which does not need to be freed by
2705 * the application, however its pointer can be considered valid only as long
2706 * as its associated DPDK port remains configured. Closing the underlying
2707 * device or unloading the PMD invalidates it.
2709 * Both cause and message may be NULL regardless of the error type.
2711 struct rte_flow_error {
2712 enum rte_flow_error_type type; /**< Cause field and error types. */
2713 const void *cause; /**< Object responsible for the error. */
2714 const char *message; /**< Human-readable error message. */
2718 * Complete flow rule description.
2720 * This object type is used when converting a flow rule description.
2722 * @see RTE_FLOW_CONV_OP_RULE
2723 * @see rte_flow_conv()
2726 struct rte_flow_conv_rule {
2728 const struct rte_flow_attr *attr_ro; /**< RO attributes. */
2729 struct rte_flow_attr *attr; /**< Attributes. */
2732 const struct rte_flow_item *pattern_ro; /**< RO pattern. */
2733 struct rte_flow_item *pattern; /**< Pattern items. */
2736 const struct rte_flow_action *actions_ro; /**< RO actions. */
2737 struct rte_flow_action *actions; /**< List of actions. */
2742 * Conversion operations for flow API objects.
2744 * @see rte_flow_conv()
2746 enum rte_flow_conv_op {
2748 * No operation to perform.
2750 * rte_flow_conv() simply returns 0.
2752 RTE_FLOW_CONV_OP_NONE,
2755 * Convert attributes structure.
2757 * This is a basic copy of an attributes structure.
2760 * @code const struct rte_flow_attr * @endcode
2762 * @code struct rte_flow_attr * @endcode
2764 RTE_FLOW_CONV_OP_ATTR,
2767 * Convert a single item.
2769 * Duplicates @p spec, @p last and @p mask but not outside objects.
2772 * @code const struct rte_flow_item * @endcode
2774 * @code struct rte_flow_item * @endcode
2776 RTE_FLOW_CONV_OP_ITEM,
2779 * Convert a single action.
2781 * Duplicates @p conf but not outside objects.
2784 * @code const struct rte_flow_action * @endcode
2786 * @code struct rte_flow_action * @endcode
2788 RTE_FLOW_CONV_OP_ACTION,
2791 * Convert an entire pattern.
2793 * Duplicates all pattern items at once with the same constraints as
2794 * RTE_FLOW_CONV_OP_ITEM.
2797 * @code const struct rte_flow_item * @endcode
2799 * @code struct rte_flow_item * @endcode
2801 RTE_FLOW_CONV_OP_PATTERN,
2804 * Convert a list of actions.
2806 * Duplicates the entire list of actions at once with the same
2807 * constraints as RTE_FLOW_CONV_OP_ACTION.
2810 * @code const struct rte_flow_action * @endcode
2812 * @code struct rte_flow_action * @endcode
2814 RTE_FLOW_CONV_OP_ACTIONS,
2817 * Convert a complete flow rule description.
2819 * Comprises attributes, pattern and actions together at once with
2820 * the usual constraints.
2823 * @code const struct rte_flow_conv_rule * @endcode
2825 * @code struct rte_flow_conv_rule * @endcode
2827 RTE_FLOW_CONV_OP_RULE,
2830 * Convert item type to its name string.
2832 * Writes a NUL-terminated string to @p dst. Like snprintf(), the
2833 * returned value excludes the terminator which is always written
2837 * @code (const void *)enum rte_flow_item_type @endcode
2839 * @code char * @endcode
2841 RTE_FLOW_CONV_OP_ITEM_NAME,
2844 * Convert action type to its name string.
2846 * Writes a NUL-terminated string to @p dst. Like snprintf(), the
2847 * returned value excludes the terminator which is always written
2851 * @code (const void *)enum rte_flow_action_type @endcode
2853 * @code char * @endcode
2855 RTE_FLOW_CONV_OP_ACTION_NAME,
2858 * Convert item type to pointer to item name.
2860 * Retrieves item name pointer from its type. The string itself is
2861 * not copied; instead, a unique pointer to an internal static
2862 * constant storage is written to @p dst.
2865 * @code (const void *)enum rte_flow_item_type @endcode
2867 * @code const char ** @endcode
2869 RTE_FLOW_CONV_OP_ITEM_NAME_PTR,
2872 * Convert action type to pointer to action name.
2874 * Retrieves action name pointer from its type. The string itself is
2875 * not copied; instead, a unique pointer to an internal static
2876 * constant storage is written to @p dst.
2879 * @code (const void *)enum rte_flow_action_type @endcode
2881 * @code const char ** @endcode
2883 RTE_FLOW_CONV_OP_ACTION_NAME_PTR,
2888 * @b EXPERIMENTAL: this API may change without prior notice.
2890 * Dump hardware internal representation information of
2893 * @param[in] port_id
2894 * The port identifier of the Ethernet device.
2896 * A pointer to a file for output.
2898 * Perform verbose error reporting if not NULL. PMDs initialize this
2899 * structure in case of error only.
2901 * 0 on success, a nagative value otherwise.
2905 rte_flow_dev_dump(uint16_t port_id, FILE *file, struct rte_flow_error *error);
2908 * Check if mbuf dynamic field for metadata is registered.
2911 * True if registered, false otherwise.
2915 rte_flow_dynf_metadata_avail(void)
2917 return !!rte_flow_dynf_metadata_mask;
2921 * Register mbuf dynamic field and flag for metadata.
2923 * This function must be called prior to use SET_META action in order to
2924 * register the dynamic mbuf field. Otherwise, the data cannot be delivered to
2928 * 0 on success, a negative errno value otherwise and rte_errno is set.
2932 rte_flow_dynf_metadata_register(void);
2935 * Check whether a flow rule can be created on a given port.
2937 * The flow rule is validated for correctness and whether it could be accepted
2938 * by the device given sufficient resources. The rule is checked against the
2939 * current device mode and queue configuration. The flow rule may also
2940 * optionally be validated against existing flow rules and device resources.
2941 * This function has no effect on the target device.
2943 * The returned value is guaranteed to remain valid only as long as no
2944 * successful calls to rte_flow_create() or rte_flow_destroy() are made in
2945 * the meantime and no device parameter affecting flow rules in any way are
2946 * modified, due to possible collisions or resource limitations (although in
2947 * such cases EINVAL should not be returned).
2950 * Port identifier of Ethernet device.
2952 * Flow rule attributes.
2953 * @param[in] pattern
2954 * Pattern specification (list terminated by the END pattern item).
2955 * @param[in] actions
2956 * Associated actions (list terminated by the END action).
2958 * Perform verbose error reporting if not NULL. PMDs initialize this
2959 * structure in case of error only.
2962 * 0 if flow rule is valid and can be created. A negative errno value
2963 * otherwise (rte_errno is also set), the following errors are defined:
2965 * -ENOSYS: underlying device does not support this functionality.
2967 * -EIO: underlying device is removed.
2969 * -EINVAL: unknown or invalid rule specification.
2971 * -ENOTSUP: valid but unsupported rule specification (e.g. partial
2972 * bit-masks are unsupported).
2974 * -EEXIST: collision with an existing rule. Only returned if device
2975 * supports flow rule collision checking and there was a flow rule
2976 * collision. Not receiving this return code is no guarantee that creating
2977 * the rule will not fail due to a collision.
2979 * -ENOMEM: not enough memory to execute the function, or if the device
2980 * supports resource validation, resource limitation on the device.
2982 * -EBUSY: action cannot be performed due to busy device resources, may
2983 * succeed if the affected queues or even the entire port are in a stopped
2984 * state (see rte_eth_dev_rx_queue_stop() and rte_eth_dev_stop()).
2987 rte_flow_validate(uint16_t port_id,
2988 const struct rte_flow_attr *attr,
2989 const struct rte_flow_item pattern[],
2990 const struct rte_flow_action actions[],
2991 struct rte_flow_error *error);
2994 * Create a flow rule on a given port.
2997 * Port identifier of Ethernet device.
2999 * Flow rule attributes.
3000 * @param[in] pattern
3001 * Pattern specification (list terminated by the END pattern item).
3002 * @param[in] actions
3003 * Associated actions (list terminated by the END action).
3005 * Perform verbose error reporting if not NULL. PMDs initialize this
3006 * structure in case of error only.
3009 * A valid handle in case of success, NULL otherwise and rte_errno is set
3010 * to the positive version of one of the error codes defined for
3011 * rte_flow_validate().
3014 rte_flow_create(uint16_t port_id,
3015 const struct rte_flow_attr *attr,
3016 const struct rte_flow_item pattern[],
3017 const struct rte_flow_action actions[],
3018 struct rte_flow_error *error);
3021 * Destroy a flow rule on a given port.
3023 * Failure to destroy a flow rule handle may occur when other flow rules
3024 * depend on it, and destroying it would result in an inconsistent state.
3026 * This function is only guaranteed to succeed if handles are destroyed in
3027 * reverse order of their creation.
3030 * Port identifier of Ethernet device.
3032 * Flow rule handle to destroy.
3034 * Perform verbose error reporting if not NULL. PMDs initialize this
3035 * structure in case of error only.
3038 * 0 on success, a negative errno value otherwise and rte_errno is set.
3041 rte_flow_destroy(uint16_t port_id,
3042 struct rte_flow *flow,
3043 struct rte_flow_error *error);
3046 * Destroy all flow rules associated with a port.
3048 * In the unlikely event of failure, handles are still considered destroyed
3049 * and no longer valid but the port must be assumed to be in an inconsistent
3053 * Port identifier of Ethernet device.
3055 * Perform verbose error reporting if not NULL. PMDs initialize this
3056 * structure in case of error only.
3059 * 0 on success, a negative errno value otherwise and rte_errno is set.
3062 rte_flow_flush(uint16_t port_id,
3063 struct rte_flow_error *error);
3066 * Query an existing flow rule.
3068 * This function allows retrieving flow-specific data such as counters.
3069 * Data is gathered by special actions which must be present in the flow
3072 * \see RTE_FLOW_ACTION_TYPE_COUNT
3075 * Port identifier of Ethernet device.
3077 * Flow rule handle to query.
3079 * Action definition as defined in original flow rule.
3080 * @param[in, out] data
3081 * Pointer to storage for the associated query data type.
3083 * Perform verbose error reporting if not NULL. PMDs initialize this
3084 * structure in case of error only.
3087 * 0 on success, a negative errno value otherwise and rte_errno is set.
3090 rte_flow_query(uint16_t port_id,
3091 struct rte_flow *flow,
3092 const struct rte_flow_action *action,
3094 struct rte_flow_error *error);
3097 * Restrict ingress traffic to the defined flow rules.
3099 * Isolated mode guarantees that all ingress traffic comes from defined flow
3100 * rules only (current and future).
3102 * Besides making ingress more deterministic, it allows PMDs to safely reuse
3103 * resources otherwise assigned to handle the remaining traffic, such as
3104 * global RSS configuration settings, VLAN filters, MAC address entries,
3105 * legacy filter API rules and so on in order to expand the set of possible
3108 * Calling this function as soon as possible after device initialization,
3109 * ideally before the first call to rte_eth_dev_configure(), is recommended
3110 * to avoid possible failures due to conflicting settings.
3112 * Once effective, leaving isolated mode may not be possible depending on
3113 * PMD implementation.
3115 * Additionally, the following functionality has no effect on the underlying
3116 * port and may return errors such as ENOTSUP ("not supported"):
3118 * - Toggling promiscuous mode.
3119 * - Toggling allmulticast mode.
3120 * - Configuring MAC addresses.
3121 * - Configuring multicast addresses.
3122 * - Configuring VLAN filters.
3123 * - Configuring Rx filters through the legacy API (e.g. FDIR).
3124 * - Configuring global RSS settings.
3127 * Port identifier of Ethernet device.
3129 * Nonzero to enter isolated mode, attempt to leave it otherwise.
3131 * Perform verbose error reporting if not NULL. PMDs initialize this
3132 * structure in case of error only.
3135 * 0 on success, a negative errno value otherwise and rte_errno is set.
3138 rte_flow_isolate(uint16_t port_id, int set, struct rte_flow_error *error);
3141 * Initialize flow error structure.
3144 * Pointer to flow error structure (may be NULL).
3146 * Related error code (rte_errno).
3148 * Cause field and error types.
3150 * Object responsible for the error.
3152 * Human-readable error message.
3155 * Negative error code (errno value) and rte_errno is set.
3158 rte_flow_error_set(struct rte_flow_error *error,
3160 enum rte_flow_error_type type,
3162 const char *message);
3166 * @see rte_flow_copy()
3168 struct rte_flow_desc {
3169 size_t size; /**< Allocated space including data[]. */
3170 struct rte_flow_attr attr; /**< Attributes. */
3171 struct rte_flow_item *items; /**< Items. */
3172 struct rte_flow_action *actions; /**< Actions. */
3173 uint8_t data[]; /**< Storage for items/actions. */
3178 * Copy an rte_flow rule description.
3180 * This interface is kept for compatibility with older applications but is
3181 * implemented as a wrapper to rte_flow_conv(). It is deprecated due to its
3182 * lack of flexibility and reliance on a type unusable with C++ programs
3183 * (struct rte_flow_desc).
3186 * Flow rule description.
3188 * Total size of allocated data for the flow description.
3190 * Flow rule attributes.
3192 * Pattern specification (list terminated by the END pattern item).
3193 * @param[in] actions
3194 * Associated actions (list terminated by the END action).
3197 * If len is greater or equal to the size of the flow, the total size of the
3198 * flow description and its data.
3199 * If len is lower than the size of the flow, the number of bytes that would
3200 * have been written to desc had it been sufficient. Nothing is written.
3204 rte_flow_copy(struct rte_flow_desc *fd, size_t len,
3205 const struct rte_flow_attr *attr,
3206 const struct rte_flow_item *items,
3207 const struct rte_flow_action *actions);
3210 * Flow object conversion helper.
3212 * This function performs conversion of various flow API objects to a
3213 * pre-allocated destination buffer. See enum rte_flow_conv_op for possible
3214 * operations and details about each of them.
3216 * Since destination buffer must be large enough, it works in a manner
3217 * reminiscent of snprintf():
3219 * - If @p size is 0, @p dst may be a NULL pointer, otherwise @p dst must be
3221 * - If positive, the returned value represents the number of bytes needed
3222 * to store the conversion of @p src to @p dst according to @p op
3223 * regardless of the @p size parameter.
3224 * - Since no more than @p size bytes can be written to @p dst, output is
3225 * truncated and may be inconsistent when the returned value is larger
3227 * - In case of conversion error, a negative error code is returned and
3228 * @p dst contents are unspecified.
3231 * Operation to perform, related to the object type of @p dst.
3233 * Destination buffer address. Must be suitably aligned by the caller.
3235 * Destination buffer size in bytes.
3237 * Source object to copy. Depending on @p op, its type may differ from
3240 * Perform verbose error reporting if not NULL. Initialized in case of
3244 * The number of bytes required to convert @p src to @p dst on success, a
3245 * negative errno value otherwise and rte_errno is set.
3247 * @see rte_flow_conv_op
3251 rte_flow_conv(enum rte_flow_conv_op op,
3255 struct rte_flow_error *error);
3261 #endif /* RTE_FLOW_H_ */