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_vxlan.h>
29 #include <rte_byteorder.h>
31 #include <rte_higig.h>
32 #include <rte_ecpri.h>
34 #include <rte_mbuf_dyn.h>
41 * Flow rule attributes.
43 * Priorities are set on a per rule based within groups.
45 * Lower values denote higher priority, the highest priority for a flow rule
46 * is 0, so that a flow that matches for than one rule, the rule with the
47 * lowest priority value will always be matched.
49 * Although optional, applications are encouraged to group similar rules as
50 * much as possible to fully take advantage of hardware capabilities
51 * (e.g. optimized matching) and work around limitations (e.g. a single
52 * pattern type possibly allowed in a given group). Applications should be
53 * aware that groups are not linked by default, and that they must be
54 * explicitly linked by the application using the JUMP action.
56 * Priority levels are arbitrary and up to the application, they
57 * do not need to be contiguous nor start from 0, however the maximum number
58 * varies between devices and may be affected by existing flow rules.
60 * If a packet is matched by several rules of a given group for a given
61 * priority level, the outcome is undefined. It can take any path, may be
62 * duplicated or even cause unrecoverable errors.
64 * Note that support for more than a single group and priority level is not
67 * Flow rules can apply to inbound and/or outbound traffic (ingress/egress).
69 * Several pattern items and actions are valid and can be used in both
70 * directions. Those valid for only one direction are described as such.
72 * At least one direction must be specified.
74 * Specifying both directions at once for a given rule is not recommended
75 * but may be valid in a few cases (e.g. shared counter).
77 struct rte_flow_attr {
78 uint32_t group; /**< Priority group. */
79 uint32_t priority; /**< Rule priority level within group. */
80 uint32_t ingress:1; /**< Rule applies to ingress traffic. */
81 uint32_t egress:1; /**< Rule applies to egress traffic. */
83 * Instead of simply matching the properties of traffic as it would
84 * appear on a given DPDK port ID, enabling this attribute transfers
85 * a flow rule to the lowest possible level of any device endpoints
86 * found in the pattern.
88 * When supported, this effectively enables an application to
89 * re-route traffic not necessarily intended for it (e.g. coming
90 * from or addressed to different physical ports, VFs or
91 * applications) at the device level.
93 * It complements the behavior of some pattern items such as
94 * RTE_FLOW_ITEM_TYPE_PHY_PORT and is meaningless without them.
96 * When transferring flow rules, ingress and egress attributes keep
97 * their original meaning, as if processing traffic emitted or
98 * received by the application.
101 uint32_t reserved:29; /**< Reserved, must be zero. */
105 * Matching pattern item types.
107 * Pattern items fall in two categories:
109 * - Matching protocol headers and packet data, usually associated with a
110 * specification structure. These must be stacked in the same order as the
111 * protocol layers to match inside packets, starting from the lowest.
113 * - Matching meta-data or affecting pattern processing, often without a
114 * specification structure. Since they do not match packet contents, their
115 * position in the list is usually not relevant.
117 * See the description of individual types for more information. Those
118 * marked with [META] fall into the second category.
120 enum rte_flow_item_type {
124 * End marker for item lists. Prevents further processing of items,
125 * thereby ending the pattern.
127 * No associated specification structure.
129 RTE_FLOW_ITEM_TYPE_END,
134 * Used as a placeholder for convenience. It is ignored and simply
137 * No associated specification structure.
139 RTE_FLOW_ITEM_TYPE_VOID,
144 * Inverted matching, i.e. process packets that do not match the
147 * No associated specification structure.
149 RTE_FLOW_ITEM_TYPE_INVERT,
152 * Matches any protocol in place of the current layer, a single ANY
153 * may also stand for several protocol layers.
155 * See struct rte_flow_item_any.
157 RTE_FLOW_ITEM_TYPE_ANY,
162 * Matches traffic originating from (ingress) or going to (egress)
163 * the physical function of the current device.
165 * No associated specification structure.
167 RTE_FLOW_ITEM_TYPE_PF,
172 * Matches traffic originating from (ingress) or going to (egress) a
173 * given virtual function of the current device.
175 * See struct rte_flow_item_vf.
177 RTE_FLOW_ITEM_TYPE_VF,
182 * Matches traffic originating from (ingress) or going to (egress) a
183 * physical port of the underlying device.
185 * See struct rte_flow_item_phy_port.
187 RTE_FLOW_ITEM_TYPE_PHY_PORT,
192 * Matches traffic originating from (ingress) or going to (egress) a
193 * given DPDK port ID.
195 * See struct rte_flow_item_port_id.
197 RTE_FLOW_ITEM_TYPE_PORT_ID,
200 * Matches a byte string of a given length at a given offset.
202 * See struct rte_flow_item_raw.
204 RTE_FLOW_ITEM_TYPE_RAW,
207 * Matches an Ethernet header.
209 * See struct rte_flow_item_eth.
211 RTE_FLOW_ITEM_TYPE_ETH,
214 * Matches an 802.1Q/ad VLAN tag.
216 * See struct rte_flow_item_vlan.
218 RTE_FLOW_ITEM_TYPE_VLAN,
221 * Matches an IPv4 header.
223 * See struct rte_flow_item_ipv4.
225 RTE_FLOW_ITEM_TYPE_IPV4,
228 * Matches an IPv6 header.
230 * See struct rte_flow_item_ipv6.
232 RTE_FLOW_ITEM_TYPE_IPV6,
235 * Matches an ICMP header.
237 * See struct rte_flow_item_icmp.
239 RTE_FLOW_ITEM_TYPE_ICMP,
242 * Matches a UDP header.
244 * See struct rte_flow_item_udp.
246 RTE_FLOW_ITEM_TYPE_UDP,
249 * Matches a TCP header.
251 * See struct rte_flow_item_tcp.
253 RTE_FLOW_ITEM_TYPE_TCP,
256 * Matches a SCTP header.
258 * See struct rte_flow_item_sctp.
260 RTE_FLOW_ITEM_TYPE_SCTP,
263 * Matches a VXLAN header.
265 * See struct rte_flow_item_vxlan.
267 RTE_FLOW_ITEM_TYPE_VXLAN,
270 * Matches a E_TAG header.
272 * See struct rte_flow_item_e_tag.
274 RTE_FLOW_ITEM_TYPE_E_TAG,
277 * Matches a NVGRE header.
279 * See struct rte_flow_item_nvgre.
281 RTE_FLOW_ITEM_TYPE_NVGRE,
284 * Matches a MPLS header.
286 * See struct rte_flow_item_mpls.
288 RTE_FLOW_ITEM_TYPE_MPLS,
291 * Matches a GRE header.
293 * See struct rte_flow_item_gre.
295 RTE_FLOW_ITEM_TYPE_GRE,
300 * Fuzzy pattern match, expect faster than default.
302 * This is for device that support fuzzy matching option.
303 * Usually a fuzzy matching is fast but the cost is accuracy.
305 * See struct rte_flow_item_fuzzy.
307 RTE_FLOW_ITEM_TYPE_FUZZY,
310 * Matches a GTP header.
312 * Configure flow for GTP packets.
314 * See struct rte_flow_item_gtp.
316 RTE_FLOW_ITEM_TYPE_GTP,
319 * Matches a GTP header.
321 * Configure flow for GTP-C packets.
323 * See struct rte_flow_item_gtp.
325 RTE_FLOW_ITEM_TYPE_GTPC,
328 * Matches a GTP header.
330 * Configure flow for GTP-U packets.
332 * See struct rte_flow_item_gtp.
334 RTE_FLOW_ITEM_TYPE_GTPU,
337 * Matches a ESP header.
339 * See struct rte_flow_item_esp.
341 RTE_FLOW_ITEM_TYPE_ESP,
344 * Matches a GENEVE header.
346 * See struct rte_flow_item_geneve.
348 RTE_FLOW_ITEM_TYPE_GENEVE,
351 * Matches a VXLAN-GPE header.
353 * See struct rte_flow_item_vxlan_gpe.
355 RTE_FLOW_ITEM_TYPE_VXLAN_GPE,
358 * Matches an ARP header for Ethernet/IPv4.
360 * See struct rte_flow_item_arp_eth_ipv4.
362 RTE_FLOW_ITEM_TYPE_ARP_ETH_IPV4,
365 * Matches the presence of any IPv6 extension header.
367 * See struct rte_flow_item_ipv6_ext.
369 RTE_FLOW_ITEM_TYPE_IPV6_EXT,
372 * Matches any ICMPv6 header.
374 * See struct rte_flow_item_icmp6.
376 RTE_FLOW_ITEM_TYPE_ICMP6,
379 * Matches an ICMPv6 neighbor discovery solicitation.
381 * See struct rte_flow_item_icmp6_nd_ns.
383 RTE_FLOW_ITEM_TYPE_ICMP6_ND_NS,
386 * Matches an ICMPv6 neighbor discovery advertisement.
388 * See struct rte_flow_item_icmp6_nd_na.
390 RTE_FLOW_ITEM_TYPE_ICMP6_ND_NA,
393 * Matches the presence of any ICMPv6 neighbor discovery option.
395 * See struct rte_flow_item_icmp6_nd_opt.
397 RTE_FLOW_ITEM_TYPE_ICMP6_ND_OPT,
400 * Matches an ICMPv6 neighbor discovery source Ethernet link-layer
403 * See struct rte_flow_item_icmp6_nd_opt_sla_eth.
405 RTE_FLOW_ITEM_TYPE_ICMP6_ND_OPT_SLA_ETH,
408 * Matches an ICMPv6 neighbor discovery target Ethernet link-layer
411 * See struct rte_flow_item_icmp6_nd_opt_tla_eth.
413 RTE_FLOW_ITEM_TYPE_ICMP6_ND_OPT_TLA_ETH,
416 * Matches specified mark field.
418 * See struct rte_flow_item_mark.
420 RTE_FLOW_ITEM_TYPE_MARK,
425 * Matches a metadata value.
427 * See struct rte_flow_item_meta.
429 RTE_FLOW_ITEM_TYPE_META,
432 * Matches a GRE optional key field.
434 * The value should a big-endian 32bit integer.
436 * When this item present the K bit is implicitly matched as "1"
437 * in the default mask.
440 * @code rte_be32_t * @endcode
442 RTE_FLOW_ITEM_TYPE_GRE_KEY,
445 * Matches a GTP extension header: PDU session container.
447 * Configure flow for GTP packets with extension header type 0x85.
449 * See struct rte_flow_item_gtp_psc.
451 RTE_FLOW_ITEM_TYPE_GTP_PSC,
454 * Matches a PPPoE header.
456 * Configure flow for PPPoE session packets.
458 * See struct rte_flow_item_pppoe.
460 RTE_FLOW_ITEM_TYPE_PPPOES,
463 * Matches a PPPoE header.
465 * Configure flow for PPPoE discovery packets.
467 * See struct rte_flow_item_pppoe.
469 RTE_FLOW_ITEM_TYPE_PPPOED,
472 * Matches a PPPoE optional proto_id field.
474 * It only applies to PPPoE session packets.
476 * See struct rte_flow_item_pppoe_proto_id.
478 RTE_FLOW_ITEM_TYPE_PPPOE_PROTO_ID,
481 * Matches Network service header (NSH).
482 * See struct rte_flow_item_nsh.
485 RTE_FLOW_ITEM_TYPE_NSH,
488 * Matches Internet Group Management Protocol (IGMP).
489 * See struct rte_flow_item_igmp.
492 RTE_FLOW_ITEM_TYPE_IGMP,
495 * Matches IP Authentication Header (AH).
496 * See struct rte_flow_item_ah.
499 RTE_FLOW_ITEM_TYPE_AH,
502 * Matches a HIGIG header.
503 * see struct rte_flow_item_higig2_hdr.
505 RTE_FLOW_ITEM_TYPE_HIGIG2,
510 * Matches a tag value.
512 * See struct rte_flow_item_tag.
514 RTE_FLOW_ITEM_TYPE_TAG,
517 * Matches a L2TPv3 over IP header.
519 * Configure flow for L2TPv3 over IP packets.
521 * See struct rte_flow_item_l2tpv3oip.
523 RTE_FLOW_ITEM_TYPE_L2TPV3OIP,
526 * Matches PFCP Header.
527 * See struct rte_flow_item_pfcp.
530 RTE_FLOW_ITEM_TYPE_PFCP,
533 * Matches eCPRI Header.
535 * Configure flow for eCPRI over ETH or UDP packets.
537 * See struct rte_flow_item_ecpri.
539 RTE_FLOW_ITEM_TYPE_ECPRI,
542 * Matches the presence of IPv6 fragment extension header.
544 * See struct rte_flow_item_ipv6_frag_ext.
546 RTE_FLOW_ITEM_TYPE_IPV6_FRAG_EXT,
549 * Matches Geneve Variable Length Option
551 * See struct rte_flow_item_geneve_opt
553 RTE_FLOW_ITEM_TYPE_GENEVE_OPT,
558 * Matches on packet integrity.
559 * For some devices application needs to enable integration checks in HW
560 * before using this item.
562 * @see struct rte_flow_item_integrity.
564 RTE_FLOW_ITEM_TYPE_INTEGRITY,
569 * RTE_FLOW_ITEM_TYPE_HIGIG2
570 * Matches higig2 header
573 struct rte_flow_item_higig2_hdr {
574 struct rte_higig2_hdr hdr;
577 /** Default mask for RTE_FLOW_ITEM_TYPE_HIGIG2. */
579 static const struct rte_flow_item_higig2_hdr rte_flow_item_higig2_hdr_mask = {
582 .classification = 0xffff,
590 * RTE_FLOW_ITEM_TYPE_ANY
592 * Matches any protocol in place of the current layer, a single ANY may also
593 * stand for several protocol layers.
595 * This is usually specified as the first pattern item when looking for a
596 * protocol anywhere in a packet.
598 * A zeroed mask stands for any number of layers.
600 struct rte_flow_item_any {
601 uint32_t num; /**< Number of layers covered. */
604 /** Default mask for RTE_FLOW_ITEM_TYPE_ANY. */
606 static const struct rte_flow_item_any rte_flow_item_any_mask = {
612 * RTE_FLOW_ITEM_TYPE_VF
614 * Matches traffic originating from (ingress) or going to (egress) a given
615 * virtual function of the current device.
617 * If supported, should work even if the virtual function is not managed by
618 * the application and thus not associated with a DPDK port ID.
620 * Note this pattern item does not match VF representors traffic which, as
621 * separate entities, should be addressed through their own DPDK port IDs.
623 * - Can be specified multiple times to match traffic addressed to several
625 * - Can be combined with a PF item to match both PF and VF traffic.
627 * A zeroed mask can be used to match any VF ID.
629 struct rte_flow_item_vf {
630 uint32_t id; /**< VF ID. */
633 /** Default mask for RTE_FLOW_ITEM_TYPE_VF. */
635 static const struct rte_flow_item_vf rte_flow_item_vf_mask = {
641 * RTE_FLOW_ITEM_TYPE_PHY_PORT
643 * Matches traffic originating from (ingress) or going to (egress) a
644 * physical port of the underlying device.
646 * The first PHY_PORT item overrides the physical port normally associated
647 * with the specified DPDK input port (port_id). This item can be provided
648 * several times to match additional physical ports.
650 * Note that physical ports are not necessarily tied to DPDK input ports
651 * (port_id) when those are not under DPDK control. Possible values are
652 * specific to each device, they are not necessarily indexed from zero and
653 * may not be contiguous.
655 * As a device property, the list of allowed values as well as the value
656 * associated with a port_id should be retrieved by other means.
658 * A zeroed mask can be used to match any port index.
660 struct rte_flow_item_phy_port {
661 uint32_t index; /**< Physical port index. */
664 /** Default mask for RTE_FLOW_ITEM_TYPE_PHY_PORT. */
666 static const struct rte_flow_item_phy_port rte_flow_item_phy_port_mask = {
672 * RTE_FLOW_ITEM_TYPE_PORT_ID
674 * Matches traffic originating from (ingress) or going to (egress) a given
677 * Normally only supported if the port ID in question is known by the
678 * underlying PMD and related to the device the flow rule is created
681 * This must not be confused with @p PHY_PORT which refers to the physical
682 * port of a device, whereas @p PORT_ID refers to a struct rte_eth_dev
683 * object on the application side (also known as "port representor"
684 * depending on the kind of underlying device).
686 struct rte_flow_item_port_id {
687 uint32_t id; /**< DPDK port ID. */
690 /** Default mask for RTE_FLOW_ITEM_TYPE_PORT_ID. */
692 static const struct rte_flow_item_port_id rte_flow_item_port_id_mask = {
698 * RTE_FLOW_ITEM_TYPE_RAW
700 * Matches a byte string of a given length at a given offset.
702 * Offset is either absolute (using the start of the packet) or relative to
703 * the end of the previous matched item in the stack, in which case negative
704 * values are allowed.
706 * If search is enabled, offset is used as the starting point. The search
707 * area can be delimited by setting limit to a nonzero value, which is the
708 * maximum number of bytes after offset where the pattern may start.
710 * Matching a zero-length pattern is allowed, doing so resets the relative
711 * offset for subsequent items.
713 * This type does not support ranges (struct rte_flow_item.last).
715 struct rte_flow_item_raw {
716 uint32_t relative:1; /**< Look for pattern after the previous item. */
717 uint32_t search:1; /**< Search pattern from offset (see also limit). */
718 uint32_t reserved:30; /**< Reserved, must be set to zero. */
719 int32_t offset; /**< Absolute or relative offset for pattern. */
720 uint16_t limit; /**< Search area limit for start of pattern. */
721 uint16_t length; /**< Pattern length. */
722 const uint8_t *pattern; /**< Byte string to look for. */
725 /** Default mask for RTE_FLOW_ITEM_TYPE_RAW. */
727 static const struct rte_flow_item_raw rte_flow_item_raw_mask = {
730 .reserved = 0x3fffffff,
731 .offset = 0xffffffff,
739 * RTE_FLOW_ITEM_TYPE_ETH
741 * Matches an Ethernet header.
743 * Inside @p hdr field, the sub-field @p ether_type stands either for EtherType
744 * or TPID, depending on whether the item is followed by a VLAN item or not. If
745 * two VLAN items follow, the sub-field refers to the outer one, which, in turn,
746 * contains the inner TPID in the similar header field. The innermost VLAN item
747 * contains a layer-3 EtherType. All of that follows the order seen on the wire.
749 * If the field in question contains a TPID value, only tagged packets with the
750 * specified TPID will match the pattern. Alternatively, it's possible to match
751 * any type of tagged packets by means of the field @p has_vlan rather than use
752 * the EtherType/TPID field. Also, it's possible to leave the two fields unused.
753 * If this is the case, both tagged and untagged packets will match the pattern.
756 struct rte_flow_item_eth {
760 * These fields are retained for compatibility.
761 * Please switch to the new header field below.
763 struct rte_ether_addr dst; /**< Destination MAC. */
764 struct rte_ether_addr src; /**< Source MAC. */
765 rte_be16_t type; /**< EtherType or TPID. */
767 struct rte_ether_hdr hdr;
769 uint32_t has_vlan:1; /**< Packet header contains at least one VLAN. */
770 uint32_t reserved:31; /**< Reserved, must be zero. */
773 /** Default mask for RTE_FLOW_ITEM_TYPE_ETH. */
775 static const struct rte_flow_item_eth rte_flow_item_eth_mask = {
776 .hdr.d_addr.addr_bytes = "\xff\xff\xff\xff\xff\xff",
777 .hdr.s_addr.addr_bytes = "\xff\xff\xff\xff\xff\xff",
778 .hdr.ether_type = RTE_BE16(0x0000),
783 * RTE_FLOW_ITEM_TYPE_VLAN
785 * Matches an 802.1Q/ad VLAN tag.
787 * The corresponding standard outer EtherType (TPID) values are
788 * RTE_ETHER_TYPE_VLAN or RTE_ETHER_TYPE_QINQ. It can be overridden by
789 * the preceding pattern item.
790 * If a @p VLAN item is present in the pattern, then only tagged packets will
792 * The field @p has_more_vlan can be used to match any type of tagged packets,
793 * instead of using the @p eth_proto field of @p hdr.
794 * If the @p eth_proto of @p hdr and @p has_more_vlan fields are not specified,
795 * then any tagged packets will match the pattern.
798 struct rte_flow_item_vlan {
802 * These fields are retained for compatibility.
803 * Please switch to the new header field below.
805 rte_be16_t tci; /**< Tag control information. */
806 rte_be16_t inner_type; /**< Inner EtherType or TPID. */
808 struct rte_vlan_hdr hdr;
810 uint32_t has_more_vlan:1;
811 /**< Packet header contains at least one more VLAN, after this VLAN. */
812 uint32_t reserved:31; /**< Reserved, must be zero. */
815 /** Default mask for RTE_FLOW_ITEM_TYPE_VLAN. */
817 static const struct rte_flow_item_vlan rte_flow_item_vlan_mask = {
818 .hdr.vlan_tci = RTE_BE16(0x0fff),
819 .hdr.eth_proto = RTE_BE16(0x0000),
824 * RTE_FLOW_ITEM_TYPE_IPV4
826 * Matches an IPv4 header.
828 * Note: IPv4 options are handled by dedicated pattern items.
830 struct rte_flow_item_ipv4 {
831 struct rte_ipv4_hdr hdr; /**< IPv4 header definition. */
834 /** Default mask for RTE_FLOW_ITEM_TYPE_IPV4. */
836 static const struct rte_flow_item_ipv4 rte_flow_item_ipv4_mask = {
838 .src_addr = RTE_BE32(0xffffffff),
839 .dst_addr = RTE_BE32(0xffffffff),
845 * RTE_FLOW_ITEM_TYPE_IPV6.
847 * Matches an IPv6 header.
849 * Dedicated flags indicate if header contains specific extension headers.
851 struct rte_flow_item_ipv6 {
852 struct rte_ipv6_hdr hdr; /**< IPv6 header definition. */
853 uint32_t has_hop_ext:1;
854 /**< Header contains Hop-by-Hop Options extension header. */
855 uint32_t has_route_ext:1;
856 /**< Header contains Routing extension header. */
857 uint32_t has_frag_ext:1;
858 /**< Header contains Fragment extension header. */
859 uint32_t has_auth_ext:1;
860 /**< Header contains Authentication extension header. */
861 uint32_t has_esp_ext:1;
862 /**< Header contains Encapsulation Security Payload extension header. */
863 uint32_t has_dest_ext:1;
864 /**< Header contains Destination Options extension header. */
865 uint32_t has_mobil_ext:1;
866 /**< Header contains Mobility extension header. */
867 uint32_t has_hip_ext:1;
868 /**< Header contains Host Identity Protocol extension header. */
869 uint32_t has_shim6_ext:1;
870 /**< Header contains Shim6 Protocol extension header. */
871 uint32_t reserved:23;
872 /**< Reserved for future extension headers, must be zero. */
875 /** Default mask for RTE_FLOW_ITEM_TYPE_IPV6. */
877 static const struct rte_flow_item_ipv6 rte_flow_item_ipv6_mask = {
880 "\xff\xff\xff\xff\xff\xff\xff\xff"
881 "\xff\xff\xff\xff\xff\xff\xff\xff",
883 "\xff\xff\xff\xff\xff\xff\xff\xff"
884 "\xff\xff\xff\xff\xff\xff\xff\xff",
890 * RTE_FLOW_ITEM_TYPE_ICMP.
892 * Matches an ICMP header.
894 struct rte_flow_item_icmp {
895 struct rte_icmp_hdr hdr; /**< ICMP header definition. */
898 /** Default mask for RTE_FLOW_ITEM_TYPE_ICMP. */
900 static const struct rte_flow_item_icmp rte_flow_item_icmp_mask = {
909 * RTE_FLOW_ITEM_TYPE_UDP.
911 * Matches a UDP header.
913 struct rte_flow_item_udp {
914 struct rte_udp_hdr hdr; /**< UDP header definition. */
917 /** Default mask for RTE_FLOW_ITEM_TYPE_UDP. */
919 static const struct rte_flow_item_udp rte_flow_item_udp_mask = {
921 .src_port = RTE_BE16(0xffff),
922 .dst_port = RTE_BE16(0xffff),
928 * RTE_FLOW_ITEM_TYPE_TCP.
930 * Matches a TCP header.
932 struct rte_flow_item_tcp {
933 struct rte_tcp_hdr hdr; /**< TCP header definition. */
936 /** Default mask for RTE_FLOW_ITEM_TYPE_TCP. */
938 static const struct rte_flow_item_tcp rte_flow_item_tcp_mask = {
940 .src_port = RTE_BE16(0xffff),
941 .dst_port = RTE_BE16(0xffff),
947 * RTE_FLOW_ITEM_TYPE_SCTP.
949 * Matches a SCTP header.
951 struct rte_flow_item_sctp {
952 struct rte_sctp_hdr hdr; /**< SCTP header definition. */
955 /** Default mask for RTE_FLOW_ITEM_TYPE_SCTP. */
957 static const struct rte_flow_item_sctp rte_flow_item_sctp_mask = {
959 .src_port = RTE_BE16(0xffff),
960 .dst_port = RTE_BE16(0xffff),
966 * RTE_FLOW_ITEM_TYPE_VXLAN.
968 * Matches a VXLAN header (RFC 7348).
971 struct rte_flow_item_vxlan {
975 * These fields are retained for compatibility.
976 * Please switch to the new header field below.
978 uint8_t flags; /**< Normally 0x08 (I flag). */
979 uint8_t rsvd0[3]; /**< Reserved, normally 0x000000. */
980 uint8_t vni[3]; /**< VXLAN identifier. */
981 uint8_t rsvd1; /**< Reserved, normally 0x00. */
983 struct rte_vxlan_hdr hdr;
987 /** Default mask for RTE_FLOW_ITEM_TYPE_VXLAN. */
989 static const struct rte_flow_item_vxlan rte_flow_item_vxlan_mask = {
990 .hdr.vx_vni = RTE_BE32(0xffffff00), /* (0xffffff << 8) */
995 * RTE_FLOW_ITEM_TYPE_E_TAG.
997 * Matches a E-tag header.
999 * The corresponding standard outer EtherType (TPID) value is
1000 * RTE_ETHER_TYPE_ETAG. It can be overridden by the preceding pattern item.
1002 struct rte_flow_item_e_tag {
1004 * E-Tag control information (E-TCI).
1005 * E-PCP (3b), E-DEI (1b), ingress E-CID base (12b).
1007 rte_be16_t epcp_edei_in_ecid_b;
1008 /** Reserved (2b), GRP (2b), E-CID base (12b). */
1009 rte_be16_t rsvd_grp_ecid_b;
1010 uint8_t in_ecid_e; /**< Ingress E-CID ext. */
1011 uint8_t ecid_e; /**< E-CID ext. */
1012 rte_be16_t inner_type; /**< Inner EtherType or TPID. */
1015 /** Default mask for RTE_FLOW_ITEM_TYPE_E_TAG. */
1017 static const struct rte_flow_item_e_tag rte_flow_item_e_tag_mask = {
1018 .rsvd_grp_ecid_b = RTE_BE16(0x3fff),
1023 * RTE_FLOW_ITEM_TYPE_NVGRE.
1025 * Matches a NVGRE header.
1027 struct rte_flow_item_nvgre {
1029 * Checksum (1b), undefined (1b), key bit (1b), sequence number (1b),
1030 * reserved 0 (9b), version (3b).
1032 * c_k_s_rsvd0_ver must have value 0x2000 according to RFC 7637.
1034 rte_be16_t c_k_s_rsvd0_ver;
1035 rte_be16_t protocol; /**< Protocol type (0x6558). */
1036 uint8_t tni[3]; /**< Virtual subnet ID. */
1037 uint8_t flow_id; /**< Flow ID. */
1040 /** Default mask for RTE_FLOW_ITEM_TYPE_NVGRE. */
1042 static const struct rte_flow_item_nvgre rte_flow_item_nvgre_mask = {
1043 .tni = "\xff\xff\xff",
1048 * RTE_FLOW_ITEM_TYPE_MPLS.
1050 * Matches a MPLS header.
1052 struct rte_flow_item_mpls {
1054 * Label (20b), TC (3b), Bottom of Stack (1b).
1056 uint8_t label_tc_s[3];
1057 uint8_t ttl; /** Time-to-Live. */
1060 /** Default mask for RTE_FLOW_ITEM_TYPE_MPLS. */
1062 static const struct rte_flow_item_mpls rte_flow_item_mpls_mask = {
1063 .label_tc_s = "\xff\xff\xf0",
1068 * RTE_FLOW_ITEM_TYPE_GRE.
1070 * Matches a GRE header.
1072 struct rte_flow_item_gre {
1074 * Checksum (1b), reserved 0 (12b), version (3b).
1075 * Refer to RFC 2784.
1077 rte_be16_t c_rsvd0_ver;
1078 rte_be16_t protocol; /**< Protocol type. */
1081 /** Default mask for RTE_FLOW_ITEM_TYPE_GRE. */
1083 static const struct rte_flow_item_gre rte_flow_item_gre_mask = {
1084 .protocol = RTE_BE16(0xffff),
1089 * RTE_FLOW_ITEM_TYPE_FUZZY
1091 * Fuzzy pattern match, expect faster than default.
1093 * This is for device that support fuzzy match option.
1094 * Usually a fuzzy match is fast but the cost is accuracy.
1095 * i.e. Signature Match only match pattern's hash value, but it is
1096 * possible two different patterns have the same hash value.
1098 * Matching accuracy level can be configure by threshold.
1099 * Driver can divide the range of threshold and map to different
1100 * accuracy levels that device support.
1102 * Threshold 0 means perfect match (no fuzziness), while threshold
1103 * 0xffffffff means fuzziest match.
1105 struct rte_flow_item_fuzzy {
1106 uint32_t thresh; /**< Accuracy threshold. */
1109 /** Default mask for RTE_FLOW_ITEM_TYPE_FUZZY. */
1111 static const struct rte_flow_item_fuzzy rte_flow_item_fuzzy_mask = {
1112 .thresh = 0xffffffff,
1117 * RTE_FLOW_ITEM_TYPE_GTP.
1119 * Matches a GTPv1 header.
1121 struct rte_flow_item_gtp {
1123 * Version (3b), protocol type (1b), reserved (1b),
1124 * Extension header flag (1b),
1125 * Sequence number flag (1b),
1126 * N-PDU number flag (1b).
1128 uint8_t v_pt_rsv_flags;
1129 uint8_t msg_type; /**< Message type. */
1130 rte_be16_t msg_len; /**< Message length. */
1131 rte_be32_t teid; /**< Tunnel endpoint identifier. */
1134 /** Default mask for RTE_FLOW_ITEM_TYPE_GTP. */
1136 static const struct rte_flow_item_gtp rte_flow_item_gtp_mask = {
1137 .teid = RTE_BE32(0xffffffff),
1142 * RTE_FLOW_ITEM_TYPE_ESP
1144 * Matches an ESP header.
1146 struct rte_flow_item_esp {
1147 struct rte_esp_hdr hdr; /**< ESP header definition. */
1150 /** Default mask for RTE_FLOW_ITEM_TYPE_ESP. */
1152 static const struct rte_flow_item_esp rte_flow_item_esp_mask = {
1154 .spi = RTE_BE32(0xffffffff),
1160 * RTE_FLOW_ITEM_TYPE_GENEVE.
1162 * Matches a GENEVE header.
1164 struct rte_flow_item_geneve {
1166 * Version (2b), length of the options fields (6b), OAM packet (1b),
1167 * critical options present (1b), reserved 0 (6b).
1169 rte_be16_t ver_opt_len_o_c_rsvd0;
1170 rte_be16_t protocol; /**< Protocol type. */
1171 uint8_t vni[3]; /**< Virtual Network Identifier. */
1172 uint8_t rsvd1; /**< Reserved, normally 0x00. */
1175 /** Default mask for RTE_FLOW_ITEM_TYPE_GENEVE. */
1177 static const struct rte_flow_item_geneve rte_flow_item_geneve_mask = {
1178 .vni = "\xff\xff\xff",
1183 * RTE_FLOW_ITEM_TYPE_VXLAN_GPE (draft-ietf-nvo3-vxlan-gpe-05).
1185 * Matches a VXLAN-GPE header.
1187 struct rte_flow_item_vxlan_gpe {
1188 uint8_t flags; /**< Normally 0x0c (I and P flags). */
1189 uint8_t rsvd0[2]; /**< Reserved, normally 0x0000. */
1190 uint8_t protocol; /**< Protocol type. */
1191 uint8_t vni[3]; /**< VXLAN identifier. */
1192 uint8_t rsvd1; /**< Reserved, normally 0x00. */
1195 /** Default mask for RTE_FLOW_ITEM_TYPE_VXLAN_GPE. */
1197 static const struct rte_flow_item_vxlan_gpe rte_flow_item_vxlan_gpe_mask = {
1198 .vni = "\xff\xff\xff",
1203 * RTE_FLOW_ITEM_TYPE_ARP_ETH_IPV4
1205 * Matches an ARP header for Ethernet/IPv4.
1207 struct rte_flow_item_arp_eth_ipv4 {
1208 rte_be16_t hrd; /**< Hardware type, normally 1. */
1209 rte_be16_t pro; /**< Protocol type, normally 0x0800. */
1210 uint8_t hln; /**< Hardware address length, normally 6. */
1211 uint8_t pln; /**< Protocol address length, normally 4. */
1212 rte_be16_t op; /**< Opcode (1 for request, 2 for reply). */
1213 struct rte_ether_addr sha; /**< Sender hardware address. */
1214 rte_be32_t spa; /**< Sender IPv4 address. */
1215 struct rte_ether_addr tha; /**< Target hardware address. */
1216 rte_be32_t tpa; /**< Target IPv4 address. */
1219 /** Default mask for RTE_FLOW_ITEM_TYPE_ARP_ETH_IPV4. */
1221 static const struct rte_flow_item_arp_eth_ipv4
1222 rte_flow_item_arp_eth_ipv4_mask = {
1223 .sha.addr_bytes = "\xff\xff\xff\xff\xff\xff",
1224 .spa = RTE_BE32(0xffffffff),
1225 .tha.addr_bytes = "\xff\xff\xff\xff\xff\xff",
1226 .tpa = RTE_BE32(0xffffffff),
1231 * RTE_FLOW_ITEM_TYPE_IPV6_EXT
1233 * Matches the presence of any IPv6 extension header.
1235 * Normally preceded by any of:
1237 * - RTE_FLOW_ITEM_TYPE_IPV6
1238 * - RTE_FLOW_ITEM_TYPE_IPV6_EXT
1240 struct rte_flow_item_ipv6_ext {
1241 uint8_t next_hdr; /**< Next header. */
1244 /** Default mask for RTE_FLOW_ITEM_TYPE_IPV6_EXT. */
1247 struct rte_flow_item_ipv6_ext rte_flow_item_ipv6_ext_mask = {
1253 * RTE_FLOW_ITEM_TYPE_IPV6_FRAG_EXT
1255 * Matches the presence of IPv6 fragment extension header.
1257 * Preceded by any of:
1259 * - RTE_FLOW_ITEM_TYPE_IPV6
1260 * - RTE_FLOW_ITEM_TYPE_IPV6_EXT
1262 struct rte_flow_item_ipv6_frag_ext {
1263 struct rte_ipv6_fragment_ext hdr;
1267 * RTE_FLOW_ITEM_TYPE_ICMP6
1269 * Matches any ICMPv6 header.
1271 struct rte_flow_item_icmp6 {
1272 uint8_t type; /**< ICMPv6 type. */
1273 uint8_t code; /**< ICMPv6 code. */
1274 uint16_t checksum; /**< ICMPv6 checksum. */
1277 /** Default mask for RTE_FLOW_ITEM_TYPE_ICMP6. */
1279 static const struct rte_flow_item_icmp6 rte_flow_item_icmp6_mask = {
1286 * RTE_FLOW_ITEM_TYPE_ICMP6_ND_NS
1288 * Matches an ICMPv6 neighbor discovery solicitation.
1290 struct rte_flow_item_icmp6_nd_ns {
1291 uint8_t type; /**< ICMPv6 type, normally 135. */
1292 uint8_t code; /**< ICMPv6 code, normally 0. */
1293 rte_be16_t checksum; /**< ICMPv6 checksum. */
1294 rte_be32_t reserved; /**< Reserved, normally 0. */
1295 uint8_t target_addr[16]; /**< Target address. */
1298 /** Default mask for RTE_FLOW_ITEM_TYPE_ICMP6_ND_NS. */
1301 struct rte_flow_item_icmp6_nd_ns rte_flow_item_icmp6_nd_ns_mask = {
1303 "\xff\xff\xff\xff\xff\xff\xff\xff"
1304 "\xff\xff\xff\xff\xff\xff\xff\xff",
1309 * RTE_FLOW_ITEM_TYPE_ICMP6_ND_NA
1311 * Matches an ICMPv6 neighbor discovery advertisement.
1313 struct rte_flow_item_icmp6_nd_na {
1314 uint8_t type; /**< ICMPv6 type, normally 136. */
1315 uint8_t code; /**< ICMPv6 code, normally 0. */
1316 rte_be16_t checksum; /**< ICMPv6 checksum. */
1318 * Route flag (1b), solicited flag (1b), override flag (1b),
1321 rte_be32_t rso_reserved;
1322 uint8_t target_addr[16]; /**< Target address. */
1325 /** Default mask for RTE_FLOW_ITEM_TYPE_ICMP6_ND_NA. */
1328 struct rte_flow_item_icmp6_nd_na rte_flow_item_icmp6_nd_na_mask = {
1330 "\xff\xff\xff\xff\xff\xff\xff\xff"
1331 "\xff\xff\xff\xff\xff\xff\xff\xff",
1336 * RTE_FLOW_ITEM_TYPE_ICMP6_ND_OPT
1338 * Matches the presence of any ICMPv6 neighbor discovery option.
1340 * Normally preceded by any of:
1342 * - RTE_FLOW_ITEM_TYPE_ICMP6_ND_NA
1343 * - RTE_FLOW_ITEM_TYPE_ICMP6_ND_NS
1344 * - RTE_FLOW_ITEM_TYPE_ICMP6_ND_OPT
1346 struct rte_flow_item_icmp6_nd_opt {
1347 uint8_t type; /**< ND option type. */
1348 uint8_t length; /**< ND option length. */
1351 /** Default mask for RTE_FLOW_ITEM_TYPE_ICMP6_ND_OPT. */
1353 static const struct rte_flow_item_icmp6_nd_opt
1354 rte_flow_item_icmp6_nd_opt_mask = {
1360 * RTE_FLOW_ITEM_TYPE_ICMP6_ND_OPT_SLA_ETH
1362 * Matches an ICMPv6 neighbor discovery source Ethernet link-layer address
1365 * Normally preceded by any of:
1367 * - RTE_FLOW_ITEM_TYPE_ICMP6_ND_NA
1368 * - RTE_FLOW_ITEM_TYPE_ICMP6_ND_OPT
1370 struct rte_flow_item_icmp6_nd_opt_sla_eth {
1371 uint8_t type; /**< ND option type, normally 1. */
1372 uint8_t length; /**< ND option length, normally 1. */
1373 struct rte_ether_addr sla; /**< Source Ethernet LLA. */
1376 /** Default mask for RTE_FLOW_ITEM_TYPE_ICMP6_ND_OPT_SLA_ETH. */
1378 static const struct rte_flow_item_icmp6_nd_opt_sla_eth
1379 rte_flow_item_icmp6_nd_opt_sla_eth_mask = {
1380 .sla.addr_bytes = "\xff\xff\xff\xff\xff\xff",
1385 * RTE_FLOW_ITEM_TYPE_ICMP6_ND_OPT_TLA_ETH
1387 * Matches an ICMPv6 neighbor discovery target Ethernet link-layer address
1390 * Normally preceded by any of:
1392 * - RTE_FLOW_ITEM_TYPE_ICMP6_ND_NS
1393 * - RTE_FLOW_ITEM_TYPE_ICMP6_ND_OPT
1395 struct rte_flow_item_icmp6_nd_opt_tla_eth {
1396 uint8_t type; /**< ND option type, normally 2. */
1397 uint8_t length; /**< ND option length, normally 1. */
1398 struct rte_ether_addr tla; /**< Target Ethernet LLA. */
1401 /** Default mask for RTE_FLOW_ITEM_TYPE_ICMP6_ND_OPT_TLA_ETH. */
1403 static const struct rte_flow_item_icmp6_nd_opt_tla_eth
1404 rte_flow_item_icmp6_nd_opt_tla_eth_mask = {
1405 .tla.addr_bytes = "\xff\xff\xff\xff\xff\xff",
1410 * RTE_FLOW_ITEM_TYPE_META
1412 * Matches a specified metadata value. On egress, metadata can be set
1413 * either by mbuf dynamic metadata field with PKT_TX_DYNF_METADATA flag or
1414 * RTE_FLOW_ACTION_TYPE_SET_META. On ingress, RTE_FLOW_ACTION_TYPE_SET_META
1415 * sets metadata for a packet and the metadata will be reported via mbuf
1416 * metadata dynamic field with PKT_RX_DYNF_METADATA flag. The dynamic mbuf
1417 * field must be registered in advance by rte_flow_dynf_metadata_register().
1419 struct rte_flow_item_meta {
1423 /** Default mask for RTE_FLOW_ITEM_TYPE_META. */
1425 static const struct rte_flow_item_meta rte_flow_item_meta_mask = {
1431 * RTE_FLOW_ITEM_TYPE_GTP_PSC.
1433 * Matches a GTP PDU extension header with type 0x85.
1435 struct rte_flow_item_gtp_psc {
1436 uint8_t pdu_type; /**< PDU type. */
1437 uint8_t qfi; /**< PPP, RQI, QoS flow identifier. */
1440 /** Default mask for RTE_FLOW_ITEM_TYPE_GTP_PSC. */
1442 static const struct rte_flow_item_gtp_psc
1443 rte_flow_item_gtp_psc_mask = {
1449 * RTE_FLOW_ITEM_TYPE_PPPOE.
1451 * Matches a PPPoE header.
1453 struct rte_flow_item_pppoe {
1455 * Version (4b), type (4b).
1457 uint8_t version_type;
1458 uint8_t code; /**< Message type. */
1459 rte_be16_t session_id; /**< Session identifier. */
1460 rte_be16_t length; /**< Payload length. */
1464 * RTE_FLOW_ITEM_TYPE_PPPOE_PROTO_ID.
1466 * Matches a PPPoE optional proto_id field.
1468 * It only applies to PPPoE session packets.
1470 * Normally preceded by any of:
1472 * - RTE_FLOW_ITEM_TYPE_PPPOE
1473 * - RTE_FLOW_ITEM_TYPE_PPPOE_PROTO_ID
1475 struct rte_flow_item_pppoe_proto_id {
1476 rte_be16_t proto_id; /**< PPP protocol identifier. */
1479 /** Default mask for RTE_FLOW_ITEM_TYPE_PPPOE_PROTO_ID. */
1481 static const struct rte_flow_item_pppoe_proto_id
1482 rte_flow_item_pppoe_proto_id_mask = {
1483 .proto_id = RTE_BE16(0xffff),
1489 * @b EXPERIMENTAL: this structure may change without prior notice
1491 * RTE_FLOW_ITEM_TYPE_TAG
1493 * Matches a specified tag value at the specified index.
1495 struct rte_flow_item_tag {
1500 /** Default mask for RTE_FLOW_ITEM_TYPE_TAG. */
1502 static const struct rte_flow_item_tag rte_flow_item_tag_mask = {
1509 * RTE_FLOW_ITEM_TYPE_L2TPV3OIP.
1511 * Matches a L2TPv3 over IP header.
1513 struct rte_flow_item_l2tpv3oip {
1514 rte_be32_t session_id; /**< Session ID. */
1517 /** Default mask for RTE_FLOW_ITEM_TYPE_L2TPV3OIP. */
1519 static const struct rte_flow_item_l2tpv3oip rte_flow_item_l2tpv3oip_mask = {
1520 .session_id = RTE_BE32(UINT32_MAX),
1527 * @b EXPERIMENTAL: this structure may change without prior notice
1529 * RTE_FLOW_ITEM_TYPE_MARK
1531 * Matches an arbitrary integer value which was set using the ``MARK`` action
1532 * in a previously matched rule.
1534 * This item can only be specified once as a match criteria as the ``MARK``
1535 * action can only be specified once in a flow action.
1537 * This value is arbitrary and application-defined. Maximum allowed value
1538 * depends on the underlying implementation.
1540 * Depending on the underlying implementation the MARK item may be supported on
1541 * the physical device, with virtual groups in the PMD or not at all.
1543 struct rte_flow_item_mark {
1544 uint32_t id; /**< Integer value to match against. */
1547 /** Default mask for RTE_FLOW_ITEM_TYPE_MARK. */
1549 static const struct rte_flow_item_mark rte_flow_item_mark_mask = {
1556 * @b EXPERIMENTAL: this structure may change without prior notice
1558 * RTE_FLOW_ITEM_TYPE_NSH
1560 * Match network service header (NSH), RFC 8300
1563 struct rte_flow_item_nsh {
1566 uint32_t reserved:1;
1569 uint32_t reserved1:4;
1571 uint32_t next_proto:8;
1576 /** Default mask for RTE_FLOW_ITEM_TYPE_NSH. */
1578 static const struct rte_flow_item_nsh rte_flow_item_nsh_mask = {
1588 * @b EXPERIMENTAL: this structure may change without prior notice
1590 * RTE_FLOW_ITEM_TYPE_IGMP
1592 * Match Internet Group Management Protocol (IGMP), RFC 2236
1595 struct rte_flow_item_igmp {
1597 uint32_t max_resp_time:8;
1598 uint32_t checksum:16;
1599 uint32_t group_addr;
1602 /** Default mask for RTE_FLOW_ITEM_TYPE_IGMP. */
1604 static const struct rte_flow_item_igmp rte_flow_item_igmp_mask = {
1605 .group_addr = 0xffffffff,
1611 * @b EXPERIMENTAL: this structure may change without prior notice
1613 * RTE_FLOW_ITEM_TYPE_AH
1615 * Match IP Authentication Header (AH), RFC 4302
1618 struct rte_flow_item_ah {
1619 uint32_t next_hdr:8;
1620 uint32_t payload_len:8;
1621 uint32_t reserved:16;
1626 /** Default mask for RTE_FLOW_ITEM_TYPE_AH. */
1628 static const struct rte_flow_item_ah rte_flow_item_ah_mask = {
1635 * @b EXPERIMENTAL: this structure may change without prior notice
1637 * RTE_FLOW_ITEM_TYPE_PFCP
1641 struct rte_flow_item_pfcp {
1648 /** Default mask for RTE_FLOW_ITEM_TYPE_PFCP. */
1650 static const struct rte_flow_item_pfcp rte_flow_item_pfcp_mask = {
1652 .seid = RTE_BE64(UINT64_C(0xffffffffffffffff)),
1658 * @b EXPERIMENTAL: this structure may change without prior notice
1660 * RTE_FLOW_ITEM_TYPE_ECPRI
1662 * Match eCPRI Header
1664 struct rte_flow_item_ecpri {
1665 struct rte_ecpri_combined_msg_hdr hdr;
1668 /** Default mask for RTE_FLOW_ITEM_TYPE_ECPRI. */
1670 static const struct rte_flow_item_ecpri rte_flow_item_ecpri_mask = {
1680 * RTE_FLOW_ITEM_TYPE_GENEVE_OPT
1682 * Matches a GENEVE Variable Length Option
1684 struct rte_flow_item_geneve_opt {
1685 rte_be16_t option_class;
1686 uint8_t option_type;
1691 /** Default mask for RTE_FLOW_ITEM_TYPE_GENEVE_OPT. */
1693 static const struct rte_flow_item_geneve_opt
1694 rte_flow_item_geneve_opt_mask = {
1695 .option_type = 0xff,
1699 struct rte_flow_item_integrity {
1700 /**< Tunnel encapsulation level the item should apply to.
1701 * @see rte_flow_action_rss
1708 /**< The packet is valid after passing all HW checks. */
1709 uint64_t packet_ok:1;
1710 /**< L2 layer is valid after passing all HW checks. */
1712 /**< L3 layer is valid after passing all HW checks. */
1714 /**< L4 layer is valid after passing all HW checks. */
1716 /**< L2 layer CRC is valid. */
1717 uint64_t l2_crc_ok:1;
1718 /**< IPv4 layer checksum is valid. */
1719 uint64_t ipv4_csum_ok:1;
1720 /**< L4 layer checksum is valid. */
1721 uint64_t l4_csum_ok:1;
1722 /**< The l3 length is smaller than the frame length. */
1723 uint64_t l3_len_ok:1;
1724 uint64_t reserved:56;
1731 static const struct rte_flow_item_integrity
1732 rte_flow_item_integrity_mask = {
1739 * Matching pattern item definition.
1741 * A pattern is formed by stacking items starting from the lowest protocol
1742 * layer to match. This stacking restriction does not apply to meta items
1743 * which can be placed anywhere in the stack without affecting the meaning
1744 * of the resulting pattern.
1746 * Patterns are terminated by END items.
1748 * The spec field should be a valid pointer to a structure of the related
1749 * item type. It may remain unspecified (NULL) in many cases to request
1750 * broad (nonspecific) matching. In such cases, last and mask must also be
1753 * Optionally, last can point to a structure of the same type to define an
1754 * inclusive range. This is mostly supported by integer and address fields,
1755 * may cause errors otherwise. Fields that do not support ranges must be set
1756 * to 0 or to the same value as the corresponding fields in spec.
1758 * Only the fields defined to nonzero values in the default masks (see
1759 * rte_flow_item_{name}_mask constants) are considered relevant by
1760 * default. This can be overridden by providing a mask structure of the
1761 * same type with applicable bits set to one. It can also be used to
1762 * partially filter out specific fields (e.g. as an alternate mean to match
1763 * ranges of IP addresses).
1765 * Mask is a simple bit-mask applied before interpreting the contents of
1766 * spec and last, which may yield unexpected results if not used
1767 * carefully. For example, if for an IPv4 address field, spec provides
1768 * 10.1.2.3, last provides 10.3.4.5 and mask provides 255.255.0.0, the
1769 * effective range becomes 10.1.0.0 to 10.3.255.255.
1771 struct rte_flow_item {
1772 enum rte_flow_item_type type; /**< Item type. */
1773 const void *spec; /**< Pointer to item specification structure. */
1774 const void *last; /**< Defines an inclusive range (spec to last). */
1775 const void *mask; /**< Bit-mask applied to spec and last. */
1781 * Each possible action is represented by a type.
1782 * An action can have an associated configuration object.
1783 * Several actions combined in a list can be assigned
1784 * to a flow rule and are performed in order.
1786 * They fall in three categories:
1788 * - Actions that modify the fate of matching traffic, for instance by
1789 * dropping or assigning it a specific destination.
1791 * - Actions that modify matching traffic contents or its properties. This
1792 * includes adding/removing encapsulation, encryption, compression and
1795 * - Actions related to the flow rule itself, such as updating counters or
1796 * making it non-terminating.
1798 * Flow rules being terminating by default, not specifying any action of the
1799 * fate kind results in undefined behavior. This applies to both ingress and
1802 * PASSTHRU, when supported, makes a flow rule non-terminating.
1804 enum rte_flow_action_type {
1806 * End marker for action lists. Prevents further processing of
1807 * actions, thereby ending the list.
1809 * No associated configuration structure.
1811 RTE_FLOW_ACTION_TYPE_END,
1814 * Used as a placeholder for convenience. It is ignored and simply
1815 * discarded by PMDs.
1817 * No associated configuration structure.
1819 RTE_FLOW_ACTION_TYPE_VOID,
1822 * Leaves traffic up for additional processing by subsequent flow
1823 * rules; makes a flow rule non-terminating.
1825 * No associated configuration structure.
1827 RTE_FLOW_ACTION_TYPE_PASSTHRU,
1830 * RTE_FLOW_ACTION_TYPE_JUMP
1832 * Redirects packets to a group on the current device.
1834 * See struct rte_flow_action_jump.
1836 RTE_FLOW_ACTION_TYPE_JUMP,
1839 * Attaches an integer value to packets and sets PKT_RX_FDIR and
1840 * PKT_RX_FDIR_ID mbuf flags.
1842 * See struct rte_flow_action_mark.
1844 RTE_FLOW_ACTION_TYPE_MARK,
1847 * Flags packets. Similar to MARK without a specific value; only
1848 * sets the PKT_RX_FDIR mbuf flag.
1850 * No associated configuration structure.
1852 RTE_FLOW_ACTION_TYPE_FLAG,
1855 * Assigns packets to a given queue index.
1857 * See struct rte_flow_action_queue.
1859 RTE_FLOW_ACTION_TYPE_QUEUE,
1864 * PASSTHRU overrides this action if both are specified.
1866 * No associated configuration structure.
1868 RTE_FLOW_ACTION_TYPE_DROP,
1871 * Enables counters for this flow rule.
1873 * These counters can be retrieved and reset through rte_flow_query() or
1874 * rte_flow_action_handle_query() if the action provided via handle,
1875 * see struct rte_flow_query_count.
1877 * See struct rte_flow_action_count.
1879 RTE_FLOW_ACTION_TYPE_COUNT,
1882 * Similar to QUEUE, except RSS is additionally performed on packets
1883 * to spread them among several queues according to the provided
1886 * See struct rte_flow_action_rss.
1888 RTE_FLOW_ACTION_TYPE_RSS,
1891 * Directs matching traffic to the physical function (PF) of the
1894 * No associated configuration structure.
1896 RTE_FLOW_ACTION_TYPE_PF,
1899 * Directs matching traffic to a given virtual function of the
1902 * See struct rte_flow_action_vf.
1904 RTE_FLOW_ACTION_TYPE_VF,
1907 * Directs packets to a given physical port index of the underlying
1910 * See struct rte_flow_action_phy_port.
1912 RTE_FLOW_ACTION_TYPE_PHY_PORT,
1915 * Directs matching traffic to a given DPDK port ID.
1917 * See struct rte_flow_action_port_id.
1919 RTE_FLOW_ACTION_TYPE_PORT_ID,
1922 * Traffic metering and policing (MTR).
1924 * See struct rte_flow_action_meter.
1925 * See file rte_mtr.h for MTR object configuration.
1927 RTE_FLOW_ACTION_TYPE_METER,
1930 * Redirects packets to security engine of current device for security
1931 * processing as specified by security session.
1933 * See struct rte_flow_action_security.
1935 RTE_FLOW_ACTION_TYPE_SECURITY,
1938 * Implements OFPAT_SET_MPLS_TTL ("MPLS TTL") as defined by the
1939 * OpenFlow Switch Specification.
1941 * See struct rte_flow_action_of_set_mpls_ttl.
1943 RTE_FLOW_ACTION_TYPE_OF_SET_MPLS_TTL,
1946 * Implements OFPAT_DEC_MPLS_TTL ("decrement MPLS TTL") as defined
1947 * by the OpenFlow Switch Specification.
1949 * No associated configuration structure.
1951 RTE_FLOW_ACTION_TYPE_OF_DEC_MPLS_TTL,
1954 * Implements OFPAT_SET_NW_TTL ("IP TTL") as defined by the OpenFlow
1955 * Switch Specification.
1957 * See struct rte_flow_action_of_set_nw_ttl.
1959 RTE_FLOW_ACTION_TYPE_OF_SET_NW_TTL,
1962 * Implements OFPAT_DEC_NW_TTL ("decrement IP TTL") as defined by
1963 * the OpenFlow Switch Specification.
1965 * No associated configuration structure.
1967 RTE_FLOW_ACTION_TYPE_OF_DEC_NW_TTL,
1970 * Implements OFPAT_COPY_TTL_OUT ("copy TTL "outwards" -- from
1971 * next-to-outermost to outermost") as defined by the OpenFlow
1972 * Switch Specification.
1974 * No associated configuration structure.
1976 RTE_FLOW_ACTION_TYPE_OF_COPY_TTL_OUT,
1979 * Implements OFPAT_COPY_TTL_IN ("copy TTL "inwards" -- from
1980 * outermost to next-to-outermost") as defined by the OpenFlow
1981 * Switch Specification.
1983 * No associated configuration structure.
1985 RTE_FLOW_ACTION_TYPE_OF_COPY_TTL_IN,
1988 * Implements OFPAT_POP_VLAN ("pop the outer VLAN tag") as defined
1989 * by the OpenFlow Switch Specification.
1991 * No associated configuration structure.
1993 RTE_FLOW_ACTION_TYPE_OF_POP_VLAN,
1996 * Implements OFPAT_PUSH_VLAN ("push a new VLAN tag") as defined by
1997 * the OpenFlow Switch Specification.
1999 * See struct rte_flow_action_of_push_vlan.
2001 RTE_FLOW_ACTION_TYPE_OF_PUSH_VLAN,
2004 * Implements OFPAT_SET_VLAN_VID ("set the 802.1q VLAN id") as
2005 * defined by the OpenFlow Switch Specification.
2007 * See struct rte_flow_action_of_set_vlan_vid.
2009 RTE_FLOW_ACTION_TYPE_OF_SET_VLAN_VID,
2012 * Implements OFPAT_SET_LAN_PCP ("set the 802.1q priority") as
2013 * defined by the OpenFlow Switch Specification.
2015 * See struct rte_flow_action_of_set_vlan_pcp.
2017 RTE_FLOW_ACTION_TYPE_OF_SET_VLAN_PCP,
2020 * Implements OFPAT_POP_MPLS ("pop the outer MPLS tag") as defined
2021 * by the OpenFlow Switch Specification.
2023 * See struct rte_flow_action_of_pop_mpls.
2025 RTE_FLOW_ACTION_TYPE_OF_POP_MPLS,
2028 * Implements OFPAT_PUSH_MPLS ("push a new MPLS tag") as defined by
2029 * the OpenFlow Switch Specification.
2031 * See struct rte_flow_action_of_push_mpls.
2033 RTE_FLOW_ACTION_TYPE_OF_PUSH_MPLS,
2036 * Encapsulate flow in VXLAN tunnel as defined in
2037 * rte_flow_action_vxlan_encap action structure.
2039 * See struct rte_flow_action_vxlan_encap.
2041 RTE_FLOW_ACTION_TYPE_VXLAN_ENCAP,
2044 * Decapsulate outer most VXLAN tunnel from matched flow.
2046 * If flow pattern does not define a valid VXLAN tunnel (as specified by
2047 * RFC7348) then the PMD should return a RTE_FLOW_ERROR_TYPE_ACTION
2050 RTE_FLOW_ACTION_TYPE_VXLAN_DECAP,
2053 * Encapsulate flow in NVGRE tunnel defined in the
2054 * rte_flow_action_nvgre_encap action structure.
2056 * See struct rte_flow_action_nvgre_encap.
2058 RTE_FLOW_ACTION_TYPE_NVGRE_ENCAP,
2061 * Decapsulate outer most NVGRE tunnel from matched flow.
2063 * If flow pattern does not define a valid NVGRE tunnel (as specified by
2064 * RFC7637) then the PMD should return a RTE_FLOW_ERROR_TYPE_ACTION
2067 RTE_FLOW_ACTION_TYPE_NVGRE_DECAP,
2070 * Add outer header whose template is provided in its data buffer
2072 * See struct rte_flow_action_raw_encap.
2074 RTE_FLOW_ACTION_TYPE_RAW_ENCAP,
2077 * Remove outer header whose template is provided in its data buffer.
2079 * See struct rte_flow_action_raw_decap
2081 RTE_FLOW_ACTION_TYPE_RAW_DECAP,
2084 * Modify IPv4 source address in the outermost IPv4 header.
2086 * If flow pattern does not define a valid RTE_FLOW_ITEM_TYPE_IPV4,
2087 * then the PMD should return a RTE_FLOW_ERROR_TYPE_ACTION error.
2089 * See struct rte_flow_action_set_ipv4.
2091 RTE_FLOW_ACTION_TYPE_SET_IPV4_SRC,
2094 * Modify IPv4 destination address in the outermost IPv4 header.
2096 * If flow pattern does not define a valid RTE_FLOW_ITEM_TYPE_IPV4,
2097 * then the PMD should return a RTE_FLOW_ERROR_TYPE_ACTION error.
2099 * See struct rte_flow_action_set_ipv4.
2101 RTE_FLOW_ACTION_TYPE_SET_IPV4_DST,
2104 * Modify IPv6 source address in the outermost IPv6 header.
2106 * If flow pattern does not define a valid RTE_FLOW_ITEM_TYPE_IPV6,
2107 * then the PMD should return a RTE_FLOW_ERROR_TYPE_ACTION error.
2109 * See struct rte_flow_action_set_ipv6.
2111 RTE_FLOW_ACTION_TYPE_SET_IPV6_SRC,
2114 * Modify IPv6 destination address in the outermost IPv6 header.
2116 * If flow pattern does not define a valid RTE_FLOW_ITEM_TYPE_IPV6,
2117 * then the PMD should return a RTE_FLOW_ERROR_TYPE_ACTION error.
2119 * See struct rte_flow_action_set_ipv6.
2121 RTE_FLOW_ACTION_TYPE_SET_IPV6_DST,
2124 * Modify source port number in the outermost TCP/UDP header.
2126 * If flow pattern does not define a valid RTE_FLOW_ITEM_TYPE_TCP
2127 * or RTE_FLOW_ITEM_TYPE_UDP, then the PMD should return a
2128 * RTE_FLOW_ERROR_TYPE_ACTION error.
2130 * See struct rte_flow_action_set_tp.
2132 RTE_FLOW_ACTION_TYPE_SET_TP_SRC,
2135 * Modify destination port number in the outermost TCP/UDP header.
2137 * If flow pattern does not define a valid RTE_FLOW_ITEM_TYPE_TCP
2138 * or RTE_FLOW_ITEM_TYPE_UDP, then the PMD should return a
2139 * RTE_FLOW_ERROR_TYPE_ACTION error.
2141 * See struct rte_flow_action_set_tp.
2143 RTE_FLOW_ACTION_TYPE_SET_TP_DST,
2146 * Swap the source and destination MAC addresses in the outermost
2149 * If flow pattern does not define a valid RTE_FLOW_ITEM_TYPE_ETH,
2150 * then the PMD should return a RTE_FLOW_ERROR_TYPE_ACTION error.
2152 * No associated configuration structure.
2154 RTE_FLOW_ACTION_TYPE_MAC_SWAP,
2157 * Decrease TTL value directly
2159 * No associated configuration structure.
2161 RTE_FLOW_ACTION_TYPE_DEC_TTL,
2166 * See struct rte_flow_action_set_ttl
2168 RTE_FLOW_ACTION_TYPE_SET_TTL,
2171 * Set source MAC address from matched flow.
2173 * If flow pattern does not define a valid RTE_FLOW_ITEM_TYPE_ETH,
2174 * the PMD should return a RTE_FLOW_ERROR_TYPE_ACTION error.
2176 * See struct rte_flow_action_set_mac.
2178 RTE_FLOW_ACTION_TYPE_SET_MAC_SRC,
2181 * Set destination MAC address from matched flow.
2183 * If flow pattern does not define a valid RTE_FLOW_ITEM_TYPE_ETH,
2184 * the PMD should return a RTE_FLOW_ERROR_TYPE_ACTION error.
2186 * See struct rte_flow_action_set_mac.
2188 RTE_FLOW_ACTION_TYPE_SET_MAC_DST,
2191 * Increase sequence number in the outermost TCP header.
2193 * Action configuration specifies the value to increase
2194 * TCP sequence number as a big-endian 32 bit integer.
2197 * @code rte_be32_t * @endcode
2199 * Using this action on non-matching traffic will result in
2200 * undefined behavior.
2202 RTE_FLOW_ACTION_TYPE_INC_TCP_SEQ,
2205 * Decrease sequence number in the outermost TCP header.
2207 * Action configuration specifies the value to decrease
2208 * TCP sequence number as a big-endian 32 bit integer.
2211 * @code rte_be32_t * @endcode
2213 * Using this action on non-matching traffic will result in
2214 * undefined behavior.
2216 RTE_FLOW_ACTION_TYPE_DEC_TCP_SEQ,
2219 * Increase acknowledgment number in the outermost TCP header.
2221 * Action configuration specifies the value to increase
2222 * TCP acknowledgment number as a big-endian 32 bit integer.
2225 * @code rte_be32_t * @endcode
2227 * Using this action on non-matching traffic will result in
2228 * undefined behavior.
2230 RTE_FLOW_ACTION_TYPE_INC_TCP_ACK,
2233 * Decrease acknowledgment number in the outermost TCP header.
2235 * Action configuration specifies the value to decrease
2236 * TCP acknowledgment number as a big-endian 32 bit integer.
2239 * @code rte_be32_t * @endcode
2241 * Using this action on non-matching traffic will result in
2242 * undefined behavior.
2244 RTE_FLOW_ACTION_TYPE_DEC_TCP_ACK,
2249 * Tag is for internal flow usage only and
2250 * is not delivered to the application.
2252 * See struct rte_flow_action_set_tag.
2254 RTE_FLOW_ACTION_TYPE_SET_TAG,
2257 * Set metadata on ingress or egress path.
2259 * See struct rte_flow_action_set_meta.
2261 RTE_FLOW_ACTION_TYPE_SET_META,
2264 * Modify IPv4 DSCP in the outermost IP header.
2266 * If flow pattern does not define a valid RTE_FLOW_ITEM_TYPE_IPV4,
2267 * then the PMD should return a RTE_FLOW_ERROR_TYPE_ACTION error.
2269 * See struct rte_flow_action_set_dscp.
2271 RTE_FLOW_ACTION_TYPE_SET_IPV4_DSCP,
2274 * Modify IPv6 DSCP in the outermost IP header.
2276 * If flow pattern does not define a valid RTE_FLOW_ITEM_TYPE_IPV6,
2277 * then the PMD should return a RTE_FLOW_ERROR_TYPE_ACTION error.
2279 * See struct rte_flow_action_set_dscp.
2281 RTE_FLOW_ACTION_TYPE_SET_IPV6_DSCP,
2284 * Report as aged flow if timeout passed without any matching on the
2287 * See struct rte_flow_action_age.
2288 * See function rte_flow_get_aged_flows
2289 * see enum RTE_ETH_EVENT_FLOW_AGED
2290 * See struct rte_flow_query_age
2292 RTE_FLOW_ACTION_TYPE_AGE,
2295 * The matching packets will be duplicated with specified ratio and
2296 * applied with own set of actions with a fate action.
2298 * See struct rte_flow_action_sample.
2300 RTE_FLOW_ACTION_TYPE_SAMPLE,
2304 * @see RTE_FLOW_ACTION_TYPE_INDIRECT
2306 * Describe action shared across multiple flow rules.
2308 * Allow multiple rules reference the same action by handle (see
2309 * struct rte_flow_shared_action).
2311 RTE_FLOW_ACTION_TYPE_SHARED,
2314 * Modify a packet header field, tag, mark or metadata.
2316 * Allow the modification of an arbitrary header field via
2317 * set, add and sub operations or copying its content into
2318 * tag, meta or mark for future processing.
2320 * See struct rte_flow_action_modify_field.
2322 RTE_FLOW_ACTION_TYPE_MODIFY_FIELD,
2325 * An action handle is referenced in a rule through an indirect action.
2327 * The same action handle may be used in multiple rules for the same
2328 * or different ethdev ports.
2330 RTE_FLOW_ACTION_TYPE_INDIRECT,
2334 * RTE_FLOW_ACTION_TYPE_MARK
2336 * Attaches an integer value to packets and sets PKT_RX_FDIR and
2337 * PKT_RX_FDIR_ID mbuf flags.
2339 * This value is arbitrary and application-defined. Maximum allowed value
2340 * depends on the underlying implementation. It is returned in the
2341 * hash.fdir.hi mbuf field.
2343 struct rte_flow_action_mark {
2344 uint32_t id; /**< Integer value to return with packets. */
2349 * @b EXPERIMENTAL: this structure may change without prior notice
2351 * RTE_FLOW_ACTION_TYPE_JUMP
2353 * Redirects packets to a group on the current device.
2355 * In a hierarchy of groups, which can be used to represent physical or logical
2356 * flow tables on the device, this action allows the action to be a redirect to
2357 * a group on that device.
2359 struct rte_flow_action_jump {
2364 * RTE_FLOW_ACTION_TYPE_QUEUE
2366 * Assign packets to a given queue index.
2368 struct rte_flow_action_queue {
2369 uint16_t index; /**< Queue index to use. */
2374 * @b EXPERIMENTAL: this structure may change without prior notice
2376 * RTE_FLOW_ACTION_TYPE_AGE
2378 * Report flow as aged-out if timeout passed without any matching
2379 * on the flow. RTE_ETH_EVENT_FLOW_AGED event is triggered when a
2380 * port detects new aged-out flows.
2382 * The flow context and the flow handle will be reported by the
2383 * rte_flow_get_aged_flows API.
2385 struct rte_flow_action_age {
2386 uint32_t timeout:24; /**< Time in seconds. */
2387 uint32_t reserved:8; /**< Reserved, must be zero. */
2389 /**< The user flow context, NULL means the rte_flow pointer. */
2393 * RTE_FLOW_ACTION_TYPE_AGE (query)
2395 * Query structure to retrieve the aging status information of a
2396 * shared AGE action, or a flow rule using the AGE action.
2398 struct rte_flow_query_age {
2399 uint32_t reserved:6; /**< Reserved, must be zero. */
2400 uint32_t aged:1; /**< 1 if aging timeout expired, 0 otherwise. */
2401 uint32_t sec_since_last_hit_valid:1;
2402 /**< sec_since_last_hit value is valid. */
2403 uint32_t sec_since_last_hit:24; /**< Seconds since last traffic hit. */
2408 * @b EXPERIMENTAL: this structure may change without prior notice
2410 * RTE_FLOW_ACTION_TYPE_COUNT
2412 * Adds a counter action to a matched flow.
2414 * If more than one count action is specified in a single flow rule, then each
2415 * action must specify a unique id.
2417 * Counters can be retrieved and reset through ``rte_flow_query()``, see
2418 * ``struct rte_flow_query_count``.
2420 * @deprecated Shared attribute is deprecated, use generic
2421 * RTE_FLOW_ACTION_TYPE_INDIRECT action.
2423 * The shared flag indicates whether the counter is unique to the flow rule the
2424 * action is specified with, or whether it is a shared counter.
2426 * For a count action with the shared flag set, then then a global device
2427 * namespace is assumed for the counter id, so that any matched flow rules using
2428 * a count action with the same counter id on the same port will contribute to
2431 * For ports within the same switch domain then the counter id namespace extends
2432 * to all ports within that switch domain.
2434 struct rte_flow_action_count {
2435 /** @deprecated Share counter ID with other flow rules. */
2437 uint32_t reserved:31; /**< Reserved, must be zero. */
2438 uint32_t id; /**< Counter ID. */
2442 * RTE_FLOW_ACTION_TYPE_COUNT (query)
2444 * Query structure to retrieve and reset flow rule counters.
2446 struct rte_flow_query_count {
2447 uint32_t reset:1; /**< Reset counters after query [in]. */
2448 uint32_t hits_set:1; /**< hits field is set [out]. */
2449 uint32_t bytes_set:1; /**< bytes field is set [out]. */
2450 uint32_t reserved:29; /**< Reserved, must be zero [in, out]. */
2451 uint64_t hits; /**< Number of hits for this rule [out]. */
2452 uint64_t bytes; /**< Number of bytes through this rule [out]. */
2456 * Hash function types.
2458 enum rte_eth_hash_function {
2459 RTE_ETH_HASH_FUNCTION_DEFAULT = 0,
2460 RTE_ETH_HASH_FUNCTION_TOEPLITZ, /**< Toeplitz */
2461 RTE_ETH_HASH_FUNCTION_SIMPLE_XOR, /**< Simple XOR */
2463 * Symmetric Toeplitz: src, dst will be replaced by
2464 * xor(src, dst). For the case with src/dst only,
2465 * src or dst address will xor with zero pair.
2467 RTE_ETH_HASH_FUNCTION_SYMMETRIC_TOEPLITZ,
2468 RTE_ETH_HASH_FUNCTION_MAX,
2472 * RTE_FLOW_ACTION_TYPE_RSS
2474 * Similar to QUEUE, except RSS is additionally performed on packets to
2475 * spread them among several queues according to the provided parameters.
2477 * Unlike global RSS settings used by other DPDK APIs, unsetting the
2478 * @p types field does not disable RSS in a flow rule. Doing so instead
2479 * requests safe unspecified "best-effort" settings from the underlying PMD,
2480 * which depending on the flow rule, may result in anything ranging from
2481 * empty (single queue) to all-inclusive RSS.
2483 * Note: RSS hash result is stored in the hash.rss mbuf field which overlaps
2484 * hash.fdir.lo. Since the MARK action sets the hash.fdir.hi field only,
2485 * both can be requested simultaneously.
2487 struct rte_flow_action_rss {
2488 enum rte_eth_hash_function func; /**< RSS hash function to apply. */
2490 * Packet encapsulation level RSS hash @p types apply to.
2492 * - @p 0 requests the default behavior. Depending on the packet
2493 * type, it can mean outermost, innermost, anything in between or
2496 * It basically stands for the innermost encapsulation level RSS
2497 * can be performed on according to PMD and device capabilities.
2499 * - @p 1 requests RSS to be performed on the outermost packet
2500 * encapsulation level.
2502 * - @p 2 and subsequent values request RSS to be performed on the
2503 * specified inner packet encapsulation level, from outermost to
2504 * innermost (lower to higher values).
2506 * Values other than @p 0 are not necessarily supported.
2508 * Requesting a specific RSS level on unrecognized traffic results
2509 * in undefined behavior. For predictable results, it is recommended
2510 * to make the flow rule pattern match packet headers up to the
2511 * requested encapsulation level so that only matching traffic goes
2515 uint64_t types; /**< Specific RSS hash types (see ETH_RSS_*). */
2516 uint32_t key_len; /**< Hash key length in bytes. */
2517 uint32_t queue_num; /**< Number of entries in @p queue. */
2518 const uint8_t *key; /**< Hash key. */
2519 const uint16_t *queue; /**< Queue indices to use. */
2523 * RTE_FLOW_ACTION_TYPE_VF
2525 * Directs matching traffic to a given virtual function of the current
2528 * Packets matched by a VF pattern item can be redirected to their original
2529 * VF ID instead of the specified one. This parameter may not be available
2530 * and is not guaranteed to work properly if the VF part is matched by a
2531 * prior flow rule or if packets are not addressed to a VF in the first
2534 struct rte_flow_action_vf {
2535 uint32_t original:1; /**< Use original VF ID if possible. */
2536 uint32_t reserved:31; /**< Reserved, must be zero. */
2537 uint32_t id; /**< VF ID. */
2541 * RTE_FLOW_ACTION_TYPE_PHY_PORT
2543 * Directs packets to a given physical port index of the underlying
2546 * @see RTE_FLOW_ITEM_TYPE_PHY_PORT
2548 struct rte_flow_action_phy_port {
2549 uint32_t original:1; /**< Use original port index if possible. */
2550 uint32_t reserved:31; /**< Reserved, must be zero. */
2551 uint32_t index; /**< Physical port index. */
2555 * RTE_FLOW_ACTION_TYPE_PORT_ID
2557 * Directs matching traffic to a given DPDK port ID.
2559 * @see RTE_FLOW_ITEM_TYPE_PORT_ID
2561 struct rte_flow_action_port_id {
2562 uint32_t original:1; /**< Use original DPDK port ID if possible. */
2563 uint32_t reserved:31; /**< Reserved, must be zero. */
2564 uint32_t id; /**< DPDK port ID. */
2568 * RTE_FLOW_ACTION_TYPE_METER
2570 * Traffic metering and policing (MTR).
2572 * Packets matched by items of this type can be either dropped or passed to the
2573 * next item with their color set by the MTR object.
2575 struct rte_flow_action_meter {
2576 uint32_t mtr_id; /**< MTR object ID created with rte_mtr_create(). */
2580 * RTE_FLOW_ACTION_TYPE_SECURITY
2582 * Perform the security action on flows matched by the pattern items
2583 * according to the configuration of the security session.
2585 * This action modifies the payload of matched flows. For INLINE_CRYPTO, the
2586 * security protocol headers and IV are fully provided by the application as
2587 * specified in the flow pattern. The payload of matching packets is
2588 * encrypted on egress, and decrypted and authenticated on ingress.
2589 * For INLINE_PROTOCOL, the security protocol is fully offloaded to HW,
2590 * providing full encapsulation and decapsulation of packets in security
2591 * protocols. The flow pattern specifies both the outer security header fields
2592 * and the inner packet fields. The security session specified in the action
2593 * must match the pattern parameters.
2595 * The security session specified in the action must be created on the same
2596 * port as the flow action that is being specified.
2598 * The ingress/egress flow attribute should match that specified in the
2599 * security session if the security session supports the definition of the
2602 * Multiple flows can be configured to use the same security session.
2604 * The NULL value is allowed for security session. If security session is NULL,
2605 * then SPI field in ESP flow item and IP addresses in flow items 'IPv4' and
2606 * 'IPv6' will be allowed to be a range. The rule thus created can enable
2607 * security processing on multiple flows.
2609 struct rte_flow_action_security {
2610 void *security_session; /**< Pointer to security session structure. */
2614 * RTE_FLOW_ACTION_TYPE_OF_SET_MPLS_TTL
2616 * Implements OFPAT_SET_MPLS_TTL ("MPLS TTL") as defined by the OpenFlow
2617 * Switch Specification.
2619 struct rte_flow_action_of_set_mpls_ttl {
2620 uint8_t mpls_ttl; /**< MPLS TTL. */
2624 * RTE_FLOW_ACTION_TYPE_OF_SET_NW_TTL
2626 * Implements OFPAT_SET_NW_TTL ("IP TTL") as defined by the OpenFlow Switch
2629 struct rte_flow_action_of_set_nw_ttl {
2630 uint8_t nw_ttl; /**< IP TTL. */
2634 * RTE_FLOW_ACTION_TYPE_OF_PUSH_VLAN
2636 * Implements OFPAT_PUSH_VLAN ("push a new VLAN tag") as defined by the
2637 * OpenFlow Switch Specification.
2639 struct rte_flow_action_of_push_vlan {
2640 rte_be16_t ethertype; /**< EtherType. */
2644 * RTE_FLOW_ACTION_TYPE_OF_SET_VLAN_VID
2646 * Implements OFPAT_SET_VLAN_VID ("set the 802.1q VLAN id") as defined by
2647 * the OpenFlow Switch Specification.
2649 struct rte_flow_action_of_set_vlan_vid {
2650 rte_be16_t vlan_vid; /**< VLAN id. */
2654 * RTE_FLOW_ACTION_TYPE_OF_SET_VLAN_PCP
2656 * Implements OFPAT_SET_LAN_PCP ("set the 802.1q priority") as defined by
2657 * the OpenFlow Switch Specification.
2659 struct rte_flow_action_of_set_vlan_pcp {
2660 uint8_t vlan_pcp; /**< VLAN priority. */
2664 * RTE_FLOW_ACTION_TYPE_OF_POP_MPLS
2666 * Implements OFPAT_POP_MPLS ("pop the outer MPLS tag") as defined by the
2667 * OpenFlow Switch Specification.
2669 struct rte_flow_action_of_pop_mpls {
2670 rte_be16_t ethertype; /**< EtherType. */
2674 * RTE_FLOW_ACTION_TYPE_OF_PUSH_MPLS
2676 * Implements OFPAT_PUSH_MPLS ("push a new MPLS tag") as defined by the
2677 * OpenFlow Switch Specification.
2679 struct rte_flow_action_of_push_mpls {
2680 rte_be16_t ethertype; /**< EtherType. */
2685 * @b EXPERIMENTAL: this structure may change without prior notice
2687 * RTE_FLOW_ACTION_TYPE_VXLAN_ENCAP
2689 * VXLAN tunnel end-point encapsulation data definition
2691 * The tunnel definition is provided through the flow item pattern, the
2692 * provided pattern must conform to RFC7348 for the tunnel specified. The flow
2693 * definition must be provided in order from the RTE_FLOW_ITEM_TYPE_ETH
2694 * definition up the end item which is specified by RTE_FLOW_ITEM_TYPE_END.
2696 * The mask field allows user to specify which fields in the flow item
2697 * definitions can be ignored and which have valid data and can be used
2700 * Note: the last field is not used in the definition of a tunnel and can be
2703 * Valid flow definition for RTE_FLOW_ACTION_TYPE_VXLAN_ENCAP include:
2705 * - ETH / IPV4 / UDP / VXLAN / END
2706 * - ETH / IPV6 / UDP / VXLAN / END
2707 * - ETH / VLAN / IPV4 / UDP / VXLAN / END
2710 struct rte_flow_action_vxlan_encap {
2712 * Encapsulating vxlan tunnel definition
2713 * (terminated by the END pattern item).
2715 struct rte_flow_item *definition;
2720 * @b EXPERIMENTAL: this structure may change without prior notice
2722 * RTE_FLOW_ACTION_TYPE_NVGRE_ENCAP
2724 * NVGRE tunnel end-point encapsulation data definition
2726 * The tunnel definition is provided through the flow item pattern the
2727 * provided pattern must conform with RFC7637. The flow definition must be
2728 * provided in order from the RTE_FLOW_ITEM_TYPE_ETH definition up the end item
2729 * which is specified by RTE_FLOW_ITEM_TYPE_END.
2731 * The mask field allows user to specify which fields in the flow item
2732 * definitions can be ignored and which have valid data and can be used
2735 * Note: the last field is not used in the definition of a tunnel and can be
2738 * Valid flow definition for RTE_FLOW_ACTION_TYPE_NVGRE_ENCAP include:
2740 * - ETH / IPV4 / NVGRE / END
2741 * - ETH / VLAN / IPV6 / NVGRE / END
2744 struct rte_flow_action_nvgre_encap {
2746 * Encapsulating vxlan tunnel definition
2747 * (terminated by the END pattern item).
2749 struct rte_flow_item *definition;
2754 * @b EXPERIMENTAL: this structure may change without prior notice
2756 * RTE_FLOW_ACTION_TYPE_RAW_ENCAP
2758 * Raw tunnel end-point encapsulation data definition.
2760 * The data holds the headers definitions to be applied on the packet.
2761 * The data must start with ETH header up to the tunnel item header itself.
2762 * When used right after RAW_DECAP (for decapsulating L3 tunnel type for
2763 * example MPLSoGRE) the data will just hold layer 2 header.
2765 * The preserve parameter holds which bits in the packet the PMD is not allowed
2766 * to change, this parameter can also be NULL and then the PMD is allowed
2767 * to update any field.
2769 * size holds the number of bytes in @p data and @p preserve.
2771 struct rte_flow_action_raw_encap {
2772 uint8_t *data; /**< Encapsulation data. */
2773 uint8_t *preserve; /**< Bit-mask of @p data to preserve on output. */
2774 size_t size; /**< Size of @p data and @p preserve. */
2779 * @b EXPERIMENTAL: this structure may change without prior notice
2781 * RTE_FLOW_ACTION_TYPE_RAW_DECAP
2783 * Raw tunnel end-point decapsulation data definition.
2785 * The data holds the headers definitions to be removed from the packet.
2786 * The data must start with ETH header up to the tunnel item header itself.
2787 * When used right before RAW_DECAP (for encapsulating L3 tunnel type for
2788 * example MPLSoGRE) the data will just hold layer 2 header.
2790 * size holds the number of bytes in @p data.
2792 struct rte_flow_action_raw_decap {
2793 uint8_t *data; /**< Encapsulation data. */
2794 size_t size; /**< Size of @p data and @p preserve. */
2799 * @b EXPERIMENTAL: this structure may change without prior notice
2801 * RTE_FLOW_ACTION_TYPE_SET_IPV4_SRC
2802 * RTE_FLOW_ACTION_TYPE_SET_IPV4_DST
2804 * Allows modification of IPv4 source (RTE_FLOW_ACTION_TYPE_SET_IPV4_SRC)
2805 * and destination address (RTE_FLOW_ACTION_TYPE_SET_IPV4_DST) in the
2806 * specified outermost IPv4 header.
2808 struct rte_flow_action_set_ipv4 {
2809 rte_be32_t ipv4_addr;
2814 * @b EXPERIMENTAL: this structure may change without prior notice
2816 * RTE_FLOW_ACTION_TYPE_SET_IPV6_SRC
2817 * RTE_FLOW_ACTION_TYPE_SET_IPV6_DST
2819 * Allows modification of IPv6 source (RTE_FLOW_ACTION_TYPE_SET_IPV6_SRC)
2820 * and destination address (RTE_FLOW_ACTION_TYPE_SET_IPV6_DST) in the
2821 * specified outermost IPv6 header.
2823 struct rte_flow_action_set_ipv6 {
2824 uint8_t ipv6_addr[16];
2829 * @b EXPERIMENTAL: this structure may change without prior notice
2831 * RTE_FLOW_ACTION_TYPE_SET_TP_SRC
2832 * RTE_FLOW_ACTION_TYPE_SET_TP_DST
2834 * Allows modification of source (RTE_FLOW_ACTION_TYPE_SET_TP_SRC)
2835 * and destination (RTE_FLOW_ACTION_TYPE_SET_TP_DST) port numbers
2836 * in the specified outermost TCP/UDP header.
2838 struct rte_flow_action_set_tp {
2843 * RTE_FLOW_ACTION_TYPE_SET_TTL
2845 * Set the TTL value directly for IPv4 or IPv6
2847 struct rte_flow_action_set_ttl {
2852 * RTE_FLOW_ACTION_TYPE_SET_MAC
2854 * Set MAC address from the matched flow
2856 struct rte_flow_action_set_mac {
2857 uint8_t mac_addr[RTE_ETHER_ADDR_LEN];
2862 * @b EXPERIMENTAL: this structure may change without prior notice
2864 * RTE_FLOW_ACTION_TYPE_SET_TAG
2866 * Set a tag which is a transient data used during flow matching. This is not
2867 * delivered to application. Multiple tags are supported by specifying index.
2869 struct rte_flow_action_set_tag {
2877 * @b EXPERIMENTAL: this structure may change without prior notice
2879 * RTE_FLOW_ACTION_TYPE_SET_META
2881 * Set metadata. Metadata set by mbuf metadata dynamic field with
2882 * PKT_TX_DYNF_DATA flag on egress will be overridden by this action. On
2883 * ingress, the metadata will be carried by mbuf metadata dynamic field
2884 * with PKT_RX_DYNF_METADATA flag if set. The dynamic mbuf field must be
2885 * registered in advance by rte_flow_dynf_metadata_register().
2887 * Altering partial bits is supported with mask. For bits which have never
2888 * been set, unpredictable value will be seen depending on driver
2889 * implementation. For loopback/hairpin packet, metadata set on Rx/Tx may
2890 * or may not be propagated to the other path depending on HW capability.
2892 * RTE_FLOW_ITEM_TYPE_META matches metadata.
2894 struct rte_flow_action_set_meta {
2900 * RTE_FLOW_ACTION_TYPE_SET_IPV4_DSCP
2901 * RTE_FLOW_ACTION_TYPE_SET_IPV6_DSCP
2903 * Set the DSCP value for IPv4/IPv6 header.
2904 * DSCP in low 6 bits, rest ignored.
2906 struct rte_flow_action_set_dscp {
2912 * @b EXPERIMENTAL: this structure may change without prior notice
2914 * RTE_FLOW_ACTION_TYPE_INDIRECT
2916 * Opaque type returned after successfully creating an indirect action object.
2917 * The definition of the object handle is different per driver or
2918 * per direct action type.
2920 * This handle can be used to manage and query the related direct action:
2921 * - referenced in single flow rule or across multiple flow rules
2922 * over multiple ports
2923 * - update action object configuration
2924 * - query action object data
2925 * - destroy action object
2927 struct rte_flow_action_handle;
2930 * Field IDs for MODIFY_FIELD action.
2932 enum rte_flow_field_id {
2933 RTE_FLOW_FIELD_START = 0, /**< Start of a packet. */
2934 RTE_FLOW_FIELD_MAC_DST, /**< Destination MAC Address. */
2935 RTE_FLOW_FIELD_MAC_SRC, /**< Source MAC Address. */
2936 RTE_FLOW_FIELD_VLAN_TYPE, /**< 802.1Q Tag Identifier. */
2937 RTE_FLOW_FIELD_VLAN_ID, /**< 802.1Q VLAN Identifier. */
2938 RTE_FLOW_FIELD_MAC_TYPE, /**< EtherType. */
2939 RTE_FLOW_FIELD_IPV4_DSCP, /**< IPv4 DSCP. */
2940 RTE_FLOW_FIELD_IPV4_TTL, /**< IPv4 Time To Live. */
2941 RTE_FLOW_FIELD_IPV4_SRC, /**< IPv4 Source Address. */
2942 RTE_FLOW_FIELD_IPV4_DST, /**< IPv4 Destination Address. */
2943 RTE_FLOW_FIELD_IPV6_DSCP, /**< IPv6 DSCP. */
2944 RTE_FLOW_FIELD_IPV6_HOPLIMIT, /**< IPv6 Hop Limit. */
2945 RTE_FLOW_FIELD_IPV6_SRC, /**< IPv6 Source Address. */
2946 RTE_FLOW_FIELD_IPV6_DST, /**< IPv6 Destination Address. */
2947 RTE_FLOW_FIELD_TCP_PORT_SRC, /**< TCP Source Port Number. */
2948 RTE_FLOW_FIELD_TCP_PORT_DST, /**< TCP Destination Port Number. */
2949 RTE_FLOW_FIELD_TCP_SEQ_NUM, /**< TCP Sequence Number. */
2950 RTE_FLOW_FIELD_TCP_ACK_NUM, /**< TCP Acknowledgment Number. */
2951 RTE_FLOW_FIELD_TCP_FLAGS, /**< TCP Flags. */
2952 RTE_FLOW_FIELD_UDP_PORT_SRC, /**< UDP Source Port Number. */
2953 RTE_FLOW_FIELD_UDP_PORT_DST, /**< UDP Destination Port Number. */
2954 RTE_FLOW_FIELD_VXLAN_VNI, /**< VXLAN Network Identifier. */
2955 RTE_FLOW_FIELD_GENEVE_VNI, /**< GENEVE Network Identifier. */
2956 RTE_FLOW_FIELD_GTP_TEID, /**< GTP Tunnel Endpoint Identifier. */
2957 RTE_FLOW_FIELD_TAG, /**< Tag value. */
2958 RTE_FLOW_FIELD_MARK, /**< Mark value. */
2959 RTE_FLOW_FIELD_META, /**< Metadata value. */
2960 RTE_FLOW_FIELD_POINTER, /**< Memory pointer. */
2961 RTE_FLOW_FIELD_VALUE, /**< Immediate value. */
2965 * Field description for MODIFY_FIELD action.
2967 struct rte_flow_action_modify_data {
2968 enum rte_flow_field_id field; /**< Field or memory type ID. */
2972 /**< Encapsulation level or tag index. */
2974 /**< Number of bits to skip from a field. */
2978 * Immediate value for RTE_FLOW_FIELD_VALUE or
2979 * memory address for RTE_FLOW_FIELD_POINTER.
2986 * Operation types for MODIFY_FIELD action.
2988 enum rte_flow_modify_op {
2989 RTE_FLOW_MODIFY_SET = 0, /**< Set a new value. */
2990 RTE_FLOW_MODIFY_ADD, /**< Add a value to a field. */
2991 RTE_FLOW_MODIFY_SUB, /**< Subtract a value from a field. */
2996 * @b EXPERIMENTAL: this structure may change without prior notice
2998 * RTE_FLOW_ACTION_TYPE_MODIFY_FIELD
3000 * Modify a destination header field according to the specified
3001 * operation. Another packet field can be used as a source as well
3002 * as tag, mark, metadata, immediate value or a pointer to it.
3004 struct rte_flow_action_modify_field {
3005 enum rte_flow_modify_op operation; /**< Operation to perform. */
3006 struct rte_flow_action_modify_data dst; /**< Destination field. */
3007 struct rte_flow_action_modify_data src; /**< Source field. */
3008 uint32_t width; /**< Number of bits to use from a source field. */
3011 /* Mbuf dynamic field offset for metadata. */
3012 extern int32_t rte_flow_dynf_metadata_offs;
3014 /* Mbuf dynamic field flag mask for metadata. */
3015 extern uint64_t rte_flow_dynf_metadata_mask;
3017 /* Mbuf dynamic field pointer for metadata. */
3018 #define RTE_FLOW_DYNF_METADATA(m) \
3019 RTE_MBUF_DYNFIELD((m), rte_flow_dynf_metadata_offs, uint32_t *)
3021 /* Mbuf dynamic flags for metadata. */
3022 #define PKT_RX_DYNF_METADATA (rte_flow_dynf_metadata_mask)
3023 #define PKT_TX_DYNF_METADATA (rte_flow_dynf_metadata_mask)
3026 static inline uint32_t
3027 rte_flow_dynf_metadata_get(struct rte_mbuf *m)
3029 return *RTE_FLOW_DYNF_METADATA(m);
3034 rte_flow_dynf_metadata_set(struct rte_mbuf *m, uint32_t v)
3036 *RTE_FLOW_DYNF_METADATA(m) = v;
3040 * Definition of a single action.
3042 * A list of actions is terminated by a END action.
3044 * For simple actions without a configuration object, conf remains NULL.
3046 struct rte_flow_action {
3047 enum rte_flow_action_type type; /**< Action type. */
3048 const void *conf; /**< Pointer to action configuration object. */
3052 * Opaque type returned after successfully creating a flow.
3054 * This handle can be used to manage and query the related flow (e.g. to
3055 * destroy it or retrieve counters).
3061 * @b EXPERIMENTAL: this structure may change without prior notice
3063 * RTE_FLOW_ACTION_TYPE_SAMPLE
3065 * Adds a sample action to a matched flow.
3067 * The matching packets will be duplicated with specified ratio and applied
3068 * with own set of actions with a fate action, the sampled packet could be
3069 * redirected to queue or port. All the packets continue processing on the
3070 * default flow path.
3072 * When the sample ratio is set to 1 then the packets will be 100% mirrored.
3073 * Additional action list be supported to add for sampled or mirrored packets.
3075 struct rte_flow_action_sample {
3076 uint32_t ratio; /**< packets sampled equals to '1/ratio'. */
3077 const struct rte_flow_action *actions;
3078 /**< sub-action list specific for the sampling hit cases. */
3082 * Verbose error types.
3084 * Most of them provide the type of the object referenced by struct
3085 * rte_flow_error.cause.
3087 enum rte_flow_error_type {
3088 RTE_FLOW_ERROR_TYPE_NONE, /**< No error. */
3089 RTE_FLOW_ERROR_TYPE_UNSPECIFIED, /**< Cause unspecified. */
3090 RTE_FLOW_ERROR_TYPE_HANDLE, /**< Flow rule (handle). */
3091 RTE_FLOW_ERROR_TYPE_ATTR_GROUP, /**< Group field. */
3092 RTE_FLOW_ERROR_TYPE_ATTR_PRIORITY, /**< Priority field. */
3093 RTE_FLOW_ERROR_TYPE_ATTR_INGRESS, /**< Ingress field. */
3094 RTE_FLOW_ERROR_TYPE_ATTR_EGRESS, /**< Egress field. */
3095 RTE_FLOW_ERROR_TYPE_ATTR_TRANSFER, /**< Transfer field. */
3096 RTE_FLOW_ERROR_TYPE_ATTR, /**< Attributes structure. */
3097 RTE_FLOW_ERROR_TYPE_ITEM_NUM, /**< Pattern length. */
3098 RTE_FLOW_ERROR_TYPE_ITEM_SPEC, /**< Item specification. */
3099 RTE_FLOW_ERROR_TYPE_ITEM_LAST, /**< Item specification range. */
3100 RTE_FLOW_ERROR_TYPE_ITEM_MASK, /**< Item specification mask. */
3101 RTE_FLOW_ERROR_TYPE_ITEM, /**< Specific pattern item. */
3102 RTE_FLOW_ERROR_TYPE_ACTION_NUM, /**< Number of actions. */
3103 RTE_FLOW_ERROR_TYPE_ACTION_CONF, /**< Action configuration. */
3104 RTE_FLOW_ERROR_TYPE_ACTION, /**< Specific action. */
3108 * Verbose error structure definition.
3110 * This object is normally allocated by applications and set by PMDs, the
3111 * message points to a constant string which does not need to be freed by
3112 * the application, however its pointer can be considered valid only as long
3113 * as its associated DPDK port remains configured. Closing the underlying
3114 * device or unloading the PMD invalidates it.
3116 * Both cause and message may be NULL regardless of the error type.
3118 struct rte_flow_error {
3119 enum rte_flow_error_type type; /**< Cause field and error types. */
3120 const void *cause; /**< Object responsible for the error. */
3121 const char *message; /**< Human-readable error message. */
3125 * Complete flow rule description.
3127 * This object type is used when converting a flow rule description.
3129 * @see RTE_FLOW_CONV_OP_RULE
3130 * @see rte_flow_conv()
3133 struct rte_flow_conv_rule {
3135 const struct rte_flow_attr *attr_ro; /**< RO attributes. */
3136 struct rte_flow_attr *attr; /**< Attributes. */
3139 const struct rte_flow_item *pattern_ro; /**< RO pattern. */
3140 struct rte_flow_item *pattern; /**< Pattern items. */
3143 const struct rte_flow_action *actions_ro; /**< RO actions. */
3144 struct rte_flow_action *actions; /**< List of actions. */
3149 * Conversion operations for flow API objects.
3151 * @see rte_flow_conv()
3153 enum rte_flow_conv_op {
3155 * No operation to perform.
3157 * rte_flow_conv() simply returns 0.
3159 RTE_FLOW_CONV_OP_NONE,
3162 * Convert attributes structure.
3164 * This is a basic copy of an attributes structure.
3167 * @code const struct rte_flow_attr * @endcode
3169 * @code struct rte_flow_attr * @endcode
3171 RTE_FLOW_CONV_OP_ATTR,
3174 * Convert a single item.
3176 * Duplicates @p spec, @p last and @p mask but not outside objects.
3179 * @code const struct rte_flow_item * @endcode
3181 * @code struct rte_flow_item * @endcode
3183 RTE_FLOW_CONV_OP_ITEM,
3186 * Convert a single action.
3188 * Duplicates @p conf but not outside objects.
3191 * @code const struct rte_flow_action * @endcode
3193 * @code struct rte_flow_action * @endcode
3195 RTE_FLOW_CONV_OP_ACTION,
3198 * Convert an entire pattern.
3200 * Duplicates all pattern items at once with the same constraints as
3201 * RTE_FLOW_CONV_OP_ITEM.
3204 * @code const struct rte_flow_item * @endcode
3206 * @code struct rte_flow_item * @endcode
3208 RTE_FLOW_CONV_OP_PATTERN,
3211 * Convert a list of actions.
3213 * Duplicates the entire list of actions at once with the same
3214 * constraints as RTE_FLOW_CONV_OP_ACTION.
3217 * @code const struct rte_flow_action * @endcode
3219 * @code struct rte_flow_action * @endcode
3221 RTE_FLOW_CONV_OP_ACTIONS,
3224 * Convert a complete flow rule description.
3226 * Comprises attributes, pattern and actions together at once with
3227 * the usual constraints.
3230 * @code const struct rte_flow_conv_rule * @endcode
3232 * @code struct rte_flow_conv_rule * @endcode
3234 RTE_FLOW_CONV_OP_RULE,
3237 * Convert item type to its name string.
3239 * Writes a NUL-terminated string to @p dst. Like snprintf(), the
3240 * returned value excludes the terminator which is always written
3244 * @code (const void *)enum rte_flow_item_type @endcode
3246 * @code char * @endcode
3248 RTE_FLOW_CONV_OP_ITEM_NAME,
3251 * Convert action type to its name string.
3253 * Writes a NUL-terminated string to @p dst. Like snprintf(), the
3254 * returned value excludes the terminator which is always written
3258 * @code (const void *)enum rte_flow_action_type @endcode
3260 * @code char * @endcode
3262 RTE_FLOW_CONV_OP_ACTION_NAME,
3265 * Convert item type to pointer to item name.
3267 * Retrieves item name pointer from its type. The string itself is
3268 * not copied; instead, a unique pointer to an internal static
3269 * constant storage is written to @p dst.
3272 * @code (const void *)enum rte_flow_item_type @endcode
3274 * @code const char ** @endcode
3276 RTE_FLOW_CONV_OP_ITEM_NAME_PTR,
3279 * Convert action type to pointer to action name.
3281 * Retrieves action name pointer from its type. The string itself is
3282 * not copied; instead, a unique pointer to an internal static
3283 * constant storage is written to @p dst.
3286 * @code (const void *)enum rte_flow_action_type @endcode
3288 * @code const char ** @endcode
3290 RTE_FLOW_CONV_OP_ACTION_NAME_PTR,
3295 * @b EXPERIMENTAL: this API may change without prior notice.
3297 * Dump hardware internal representation information of
3300 * @param[in] port_id
3301 * The port identifier of the Ethernet device.
3303 * The pointer of flow rule to dump. Dump all rules if NULL.
3305 * A pointer to a file for output.
3307 * Perform verbose error reporting if not NULL. PMDs initialize this
3308 * structure in case of error only.
3310 * 0 on success, a nagative value otherwise.
3314 rte_flow_dev_dump(uint16_t port_id, struct rte_flow *flow,
3315 FILE *file, struct rte_flow_error *error);
3318 * Check if mbuf dynamic field for metadata is registered.
3321 * True if registered, false otherwise.
3325 rte_flow_dynf_metadata_avail(void)
3327 return !!rte_flow_dynf_metadata_mask;
3331 * Register mbuf dynamic field and flag for metadata.
3333 * This function must be called prior to use SET_META action in order to
3334 * register the dynamic mbuf field. Otherwise, the data cannot be delivered to
3338 * 0 on success, a negative errno value otherwise and rte_errno is set.
3342 rte_flow_dynf_metadata_register(void);
3345 * Check whether a flow rule can be created on a given port.
3347 * The flow rule is validated for correctness and whether it could be accepted
3348 * by the device given sufficient resources. The rule is checked against the
3349 * current device mode and queue configuration. The flow rule may also
3350 * optionally be validated against existing flow rules and device resources.
3351 * This function has no effect on the target device.
3353 * The returned value is guaranteed to remain valid only as long as no
3354 * successful calls to rte_flow_create() or rte_flow_destroy() are made in
3355 * the meantime and no device parameter affecting flow rules in any way are
3356 * modified, due to possible collisions or resource limitations (although in
3357 * such cases EINVAL should not be returned).
3360 * Port identifier of Ethernet device.
3362 * Flow rule attributes.
3363 * @param[in] pattern
3364 * Pattern specification (list terminated by the END pattern item).
3365 * @param[in] actions
3366 * Associated actions (list terminated by the END action).
3368 * Perform verbose error reporting if not NULL. PMDs initialize this
3369 * structure in case of error only.
3372 * 0 if flow rule is valid and can be created. A negative errno value
3373 * otherwise (rte_errno is also set), the following errors are defined:
3375 * -ENOSYS: underlying device does not support this functionality.
3377 * -EIO: underlying device is removed.
3379 * -EINVAL: unknown or invalid rule specification.
3381 * -ENOTSUP: valid but unsupported rule specification (e.g. partial
3382 * bit-masks are unsupported).
3384 * -EEXIST: collision with an existing rule. Only returned if device
3385 * supports flow rule collision checking and there was a flow rule
3386 * collision. Not receiving this return code is no guarantee that creating
3387 * the rule will not fail due to a collision.
3389 * -ENOMEM: not enough memory to execute the function, or if the device
3390 * supports resource validation, resource limitation on the device.
3392 * -EBUSY: action cannot be performed due to busy device resources, may
3393 * succeed if the affected queues or even the entire port are in a stopped
3394 * state (see rte_eth_dev_rx_queue_stop() and rte_eth_dev_stop()).
3397 rte_flow_validate(uint16_t port_id,
3398 const struct rte_flow_attr *attr,
3399 const struct rte_flow_item pattern[],
3400 const struct rte_flow_action actions[],
3401 struct rte_flow_error *error);
3404 * Create a flow rule on a given port.
3407 * Port identifier of Ethernet device.
3409 * Flow rule attributes.
3410 * @param[in] pattern
3411 * Pattern specification (list terminated by the END pattern item).
3412 * @param[in] actions
3413 * Associated actions (list terminated by the END action).
3415 * Perform verbose error reporting if not NULL. PMDs initialize this
3416 * structure in case of error only.
3419 * A valid handle in case of success, NULL otherwise and rte_errno is set
3420 * to the positive version of one of the error codes defined for
3421 * rte_flow_validate().
3424 rte_flow_create(uint16_t port_id,
3425 const struct rte_flow_attr *attr,
3426 const struct rte_flow_item pattern[],
3427 const struct rte_flow_action actions[],
3428 struct rte_flow_error *error);
3431 * Destroy a flow rule on a given port.
3433 * Failure to destroy a flow rule handle may occur when other flow rules
3434 * depend on it, and destroying it would result in an inconsistent state.
3436 * This function is only guaranteed to succeed if handles are destroyed in
3437 * reverse order of their creation.
3440 * Port identifier of Ethernet device.
3442 * Flow rule handle to destroy.
3444 * Perform verbose error reporting if not NULL. PMDs initialize this
3445 * structure in case of error only.
3448 * 0 on success, a negative errno value otherwise and rte_errno is set.
3451 rte_flow_destroy(uint16_t port_id,
3452 struct rte_flow *flow,
3453 struct rte_flow_error *error);
3456 * Destroy all flow rules associated with a port.
3458 * In the unlikely event of failure, handles are still considered destroyed
3459 * and no longer valid but the port must be assumed to be in an inconsistent
3463 * Port identifier of Ethernet device.
3465 * Perform verbose error reporting if not NULL. PMDs initialize this
3466 * structure in case of error only.
3469 * 0 on success, a negative errno value otherwise and rte_errno is set.
3472 rte_flow_flush(uint16_t port_id,
3473 struct rte_flow_error *error);
3476 * Query an existing flow rule.
3478 * This function allows retrieving flow-specific data such as counters.
3479 * Data is gathered by special actions which must be present in the flow
3482 * \see RTE_FLOW_ACTION_TYPE_COUNT
3485 * Port identifier of Ethernet device.
3487 * Flow rule handle to query.
3489 * Action definition as defined in original flow rule.
3490 * @param[in, out] data
3491 * Pointer to storage for the associated query data type.
3493 * Perform verbose error reporting if not NULL. PMDs initialize this
3494 * structure in case of error only.
3497 * 0 on success, a negative errno value otherwise and rte_errno is set.
3500 rte_flow_query(uint16_t port_id,
3501 struct rte_flow *flow,
3502 const struct rte_flow_action *action,
3504 struct rte_flow_error *error);
3507 * Restrict ingress traffic to the defined flow rules.
3509 * Isolated mode guarantees that all ingress traffic comes from defined flow
3510 * rules only (current and future).
3512 * Besides making ingress more deterministic, it allows PMDs to safely reuse
3513 * resources otherwise assigned to handle the remaining traffic, such as
3514 * global RSS configuration settings, VLAN filters, MAC address entries,
3515 * legacy filter API rules and so on in order to expand the set of possible
3518 * Calling this function as soon as possible after device initialization,
3519 * ideally before the first call to rte_eth_dev_configure(), is recommended
3520 * to avoid possible failures due to conflicting settings.
3522 * Once effective, leaving isolated mode may not be possible depending on
3523 * PMD implementation.
3525 * Additionally, the following functionality has no effect on the underlying
3526 * port and may return errors such as ENOTSUP ("not supported"):
3528 * - Toggling promiscuous mode.
3529 * - Toggling allmulticast mode.
3530 * - Configuring MAC addresses.
3531 * - Configuring multicast addresses.
3532 * - Configuring VLAN filters.
3533 * - Configuring Rx filters through the legacy API (e.g. FDIR).
3534 * - Configuring global RSS settings.
3537 * Port identifier of Ethernet device.
3539 * Nonzero to enter isolated mode, attempt to leave it otherwise.
3541 * Perform verbose error reporting if not NULL. PMDs initialize this
3542 * structure in case of error only.
3545 * 0 on success, a negative errno value otherwise and rte_errno is set.
3548 rte_flow_isolate(uint16_t port_id, int set, struct rte_flow_error *error);
3551 * Initialize flow error structure.
3554 * Pointer to flow error structure (may be NULL).
3556 * Related error code (rte_errno).
3558 * Cause field and error types.
3560 * Object responsible for the error.
3562 * Human-readable error message.
3565 * Negative error code (errno value) and rte_errno is set.
3568 rte_flow_error_set(struct rte_flow_error *error,
3570 enum rte_flow_error_type type,
3572 const char *message);
3576 * @see rte_flow_copy()
3578 struct rte_flow_desc {
3579 size_t size; /**< Allocated space including data[]. */
3580 struct rte_flow_attr attr; /**< Attributes. */
3581 struct rte_flow_item *items; /**< Items. */
3582 struct rte_flow_action *actions; /**< Actions. */
3583 uint8_t data[]; /**< Storage for items/actions. */
3588 * Copy an rte_flow rule description.
3590 * This interface is kept for compatibility with older applications but is
3591 * implemented as a wrapper to rte_flow_conv(). It is deprecated due to its
3592 * lack of flexibility and reliance on a type unusable with C++ programs
3593 * (struct rte_flow_desc).
3596 * Flow rule description.
3598 * Total size of allocated data for the flow description.
3600 * Flow rule attributes.
3602 * Pattern specification (list terminated by the END pattern item).
3603 * @param[in] actions
3604 * Associated actions (list terminated by the END action).
3607 * If len is greater or equal to the size of the flow, the total size of the
3608 * flow description and its data.
3609 * If len is lower than the size of the flow, the number of bytes that would
3610 * have been written to desc had it been sufficient. Nothing is written.
3614 rte_flow_copy(struct rte_flow_desc *fd, size_t len,
3615 const struct rte_flow_attr *attr,
3616 const struct rte_flow_item *items,
3617 const struct rte_flow_action *actions);
3620 * Flow object conversion helper.
3622 * This function performs conversion of various flow API objects to a
3623 * pre-allocated destination buffer. See enum rte_flow_conv_op for possible
3624 * operations and details about each of them.
3626 * Since destination buffer must be large enough, it works in a manner
3627 * reminiscent of snprintf():
3629 * - If @p size is 0, @p dst may be a NULL pointer, otherwise @p dst must be
3631 * - If positive, the returned value represents the number of bytes needed
3632 * to store the conversion of @p src to @p dst according to @p op
3633 * regardless of the @p size parameter.
3634 * - Since no more than @p size bytes can be written to @p dst, output is
3635 * truncated and may be inconsistent when the returned value is larger
3637 * - In case of conversion error, a negative error code is returned and
3638 * @p dst contents are unspecified.
3641 * Operation to perform, related to the object type of @p dst.
3643 * Destination buffer address. Must be suitably aligned by the caller.
3645 * Destination buffer size in bytes.
3647 * Source object to copy. Depending on @p op, its type may differ from
3650 * Perform verbose error reporting if not NULL. Initialized in case of
3654 * The number of bytes required to convert @p src to @p dst on success, a
3655 * negative errno value otherwise and rte_errno is set.
3657 * @see rte_flow_conv_op
3661 rte_flow_conv(enum rte_flow_conv_op op,
3665 struct rte_flow_error *error);
3668 * Get aged-out flows of a given port.
3670 * RTE_ETH_EVENT_FLOW_AGED event will be triggered when at least one new aged
3671 * out flow was detected after the last call to rte_flow_get_aged_flows.
3672 * This function can be called to get the aged flows usynchronously from the
3673 * event callback or synchronously regardless the event.
3674 * This is not safe to call rte_flow_get_aged_flows function with other flow
3675 * functions from multiple threads simultaneously.
3678 * Port identifier of Ethernet device.
3679 * @param[in, out] contexts
3680 * The address of an array of pointers to the aged-out flows contexts.
3681 * @param[in] nb_contexts
3682 * The length of context array pointers.
3684 * Perform verbose error reporting if not NULL. Initialized in case of
3688 * if nb_contexts is 0, return the amount of all aged contexts.
3689 * if nb_contexts is not 0 , return the amount of aged flows reported
3690 * in the context array, otherwise negative errno value.
3692 * @see rte_flow_action_age
3693 * @see RTE_ETH_EVENT_FLOW_AGED
3697 rte_flow_get_aged_flows(uint16_t port_id, void **contexts,
3698 uint32_t nb_contexts, struct rte_flow_error *error);
3701 * Specify indirect action object configuration
3703 struct rte_flow_indir_action_conf {
3705 * Flow direction for the indirect action configuration.
3707 * Action should be valid at least for one flow direction,
3708 * otherwise it is invalid for both ingress and egress rules.
3711 /**< Action valid for rules applied to ingress traffic. */
3713 /**< Action valid for rules applied to egress traffic. */
3715 * When set to 1, indicates that the action is valid for
3716 * transfer traffic; otherwise, for non-transfer traffic.
3718 uint32_t transfer:1;
3723 * @b EXPERIMENTAL: this API may change without prior notice.
3725 * Create an indirect action object that can be used in flow rules
3727 * The created object handle has single state and configuration
3728 * across all the flow rules using it.
3730 * @param[in] port_id
3731 * The port identifier of the Ethernet device.
3733 * Action configuration for the indirect action object creation.
3735 * Specific configuration of the indirect action object.
3737 * Perform verbose error reporting if not NULL. PMDs initialize this
3738 * structure in case of error only.
3740 * A valid handle in case of success, NULL otherwise and rte_errno is set
3741 * to one of the error codes defined:
3742 * - (ENODEV) if *port_id* invalid.
3743 * - (ENOSYS) if underlying device does not support this functionality.
3744 * - (EIO) if underlying device is removed.
3745 * - (EINVAL) if *action* invalid.
3746 * - (ENOTSUP) if *action* valid but unsupported.
3749 struct rte_flow_action_handle *
3750 rte_flow_action_handle_create(uint16_t port_id,
3751 const struct rte_flow_indir_action_conf *conf,
3752 const struct rte_flow_action *action,
3753 struct rte_flow_error *error);
3757 * @b EXPERIMENTAL: this API may change without prior notice.
3759 * Destroy indirect action by handle.
3761 * @param[in] port_id
3762 * The port identifier of the Ethernet device.
3764 * Handle for the indirect action object to be destroyed.
3766 * Perform verbose error reporting if not NULL. PMDs initialize this
3767 * structure in case of error only.
3770 * - (-ENODEV) if *port_id* invalid.
3771 * - (-ENOSYS) if underlying device does not support this functionality.
3772 * - (-EIO) if underlying device is removed.
3773 * - (-ENOENT) if action pointed by *action* handle was not found.
3774 * - (-EBUSY) if action pointed by *action* handle still used by some rules
3775 * rte_errno is also set.
3779 rte_flow_action_handle_destroy(uint16_t port_id,
3780 struct rte_flow_action_handle *handle,
3781 struct rte_flow_error *error);
3785 * @b EXPERIMENTAL: this API may change without prior notice.
3787 * Update in-place the action configuration and / or state pointed
3788 * by action *handle* with the configuration provided as *update* argument.
3789 * The update of the action configuration effects all flow rules reusing
3790 * the action via *handle*.
3791 * The update general pointer provides the ability of partial updating.
3793 * @param[in] port_id
3794 * The port identifier of the Ethernet device.
3796 * Handle for the indirect action object to be updated.
3798 * Update profile specification used to modify the action pointed by handle.
3799 * *update* could be with the same type of the immediate action corresponding
3800 * to the *handle* argument when creating, or a wrapper structure includes
3801 * action configuration to be updated and bit fields to indicate the member
3802 * of fields inside the action to update.
3804 * Perform verbose error reporting if not NULL. PMDs initialize this
3805 * structure in case of error only.
3808 * - (-ENODEV) if *port_id* invalid.
3809 * - (-ENOSYS) if underlying device does not support this functionality.
3810 * - (-EIO) if underlying device is removed.
3811 * - (-EINVAL) if *update* invalid.
3812 * - (-ENOTSUP) if *update* valid but unsupported.
3813 * - (-ENOENT) if indirect action object pointed by *handle* was not found.
3814 * rte_errno is also set.
3818 rte_flow_action_handle_update(uint16_t port_id,
3819 struct rte_flow_action_handle *handle,
3821 struct rte_flow_error *error);
3825 * @b EXPERIMENTAL: this API may change without prior notice.
3827 * Query the direct action by corresponding indirect action object handle.
3829 * Retrieve action-specific data such as counters.
3830 * Data is gathered by special action which may be present/referenced in
3831 * more than one flow rule definition.
3833 * @see RTE_FLOW_ACTION_TYPE_COUNT
3836 * Port identifier of Ethernet device.
3838 * Handle for the action object to query.
3839 * @param[in, out] data
3840 * Pointer to storage for the associated query data type.
3842 * Perform verbose error reporting if not NULL. PMDs initialize this
3843 * structure in case of error only.
3846 * 0 on success, a negative errno value otherwise and rte_errno is set.
3850 rte_flow_action_handle_query(uint16_t port_id,
3851 const struct rte_flow_action_handle *handle,
3852 void *data, struct rte_flow_error *error);
3854 /* Tunnel has a type and the key information. */
3855 struct rte_flow_tunnel {
3857 * Tunnel type, for example RTE_FLOW_ITEM_TYPE_VXLAN,
3858 * RTE_FLOW_ITEM_TYPE_NVGRE etc.
3860 enum rte_flow_item_type type;
3861 uint64_t tun_id; /**< Tunnel identification. */
3866 rte_be32_t src_addr; /**< IPv4 source address. */
3867 rte_be32_t dst_addr; /**< IPv4 destination address. */
3870 uint8_t src_addr[16]; /**< IPv6 source address. */
3871 uint8_t dst_addr[16]; /**< IPv6 destination address. */
3874 rte_be16_t tp_src; /**< Tunnel port source. */
3875 rte_be16_t tp_dst; /**< Tunnel port destination. */
3876 uint16_t tun_flags; /**< Tunnel flags. */
3878 bool is_ipv6; /**< True for valid IPv6 fields. Otherwise IPv4. */
3881 * the following members are required to restore packet
3884 uint8_t tos; /**< TOS for IPv4, TC for IPv6. */
3885 uint8_t ttl; /**< TTL for IPv4, HL for IPv6. */
3886 uint32_t label; /**< Flow Label for IPv6. */
3890 * Indicate that the packet has a tunnel.
3892 #define RTE_FLOW_RESTORE_INFO_TUNNEL (1ULL << 0)
3895 * Indicate that the packet has a non decapsulated tunnel header.
3897 #define RTE_FLOW_RESTORE_INFO_ENCAPSULATED (1ULL << 1)
3900 * Indicate that the packet has a group_id.
3902 #define RTE_FLOW_RESTORE_INFO_GROUP_ID (1ULL << 2)
3905 * Restore information structure to communicate the current packet processing
3906 * state when some of the processing pipeline is done in hardware and should
3907 * continue in software.
3909 struct rte_flow_restore_info {
3911 * Bitwise flags (RTE_FLOW_RESTORE_INFO_*) to indicate validation of
3912 * other fields in struct rte_flow_restore_info.
3915 uint32_t group_id; /**< Group ID where packed missed */
3916 struct rte_flow_tunnel tunnel; /**< Tunnel information. */
3920 * Allocate an array of actions to be used in rte_flow_create, to implement
3921 * tunnel-decap-set for the given tunnel.
3923 * actions vxlan_decap / tunnel-decap-set(tunnel properties) /
3924 * jump group 0 / end
3927 * Port identifier of Ethernet device.
3929 * Tunnel properties.
3930 * @param[out] actions
3931 * Array of actions to be allocated by the PMD. This array should be
3932 * concatenated with the actions array provided to rte_flow_create.
3933 * @param[out] num_of_actions
3934 * Number of actions allocated.
3936 * Perform verbose error reporting if not NULL. PMDs initialize this
3937 * structure in case of error only.
3940 * 0 on success, a negative errno value otherwise and rte_errno is set.
3944 rte_flow_tunnel_decap_set(uint16_t port_id,
3945 struct rte_flow_tunnel *tunnel,
3946 struct rte_flow_action **actions,
3947 uint32_t *num_of_actions,
3948 struct rte_flow_error *error);
3951 * Allocate an array of items to be used in rte_flow_create, to implement
3952 * tunnel-match for the given tunnel.
3954 * pattern tunnel-match(tunnel properties) / outer-header-matches /
3955 * inner-header-matches / end
3958 * Port identifier of Ethernet device.
3960 * Tunnel properties.
3962 * Array of items to be allocated by the PMD. This array should be
3963 * concatenated with the items array provided to rte_flow_create.
3964 * @param[out] num_of_items
3965 * Number of items allocated.
3967 * Perform verbose error reporting if not NULL. PMDs initialize this
3968 * structure in case of error only.
3971 * 0 on success, a negative errno value otherwise and rte_errno is set.
3975 rte_flow_tunnel_match(uint16_t port_id,
3976 struct rte_flow_tunnel *tunnel,
3977 struct rte_flow_item **items,
3978 uint32_t *num_of_items,
3979 struct rte_flow_error *error);
3982 * Populate the current packet processing state, if exists, for the given mbuf.
3985 * Port identifier of Ethernet device.
3989 * Restore information. Upon success contains the HW state.
3991 * Perform verbose error reporting if not NULL. PMDs initialize this
3992 * structure in case of error only.
3995 * 0 on success, a negative errno value otherwise and rte_errno is set.
3999 rte_flow_get_restore_info(uint16_t port_id,
4001 struct rte_flow_restore_info *info,
4002 struct rte_flow_error *error);
4005 * Release the action array as allocated by rte_flow_tunnel_decap_set.
4008 * Port identifier of Ethernet device.
4009 * @param[in] actions
4010 * Array of actions to be released.
4011 * @param[in] num_of_actions
4012 * Number of elements in actions array.
4014 * Perform verbose error reporting if not NULL. PMDs initialize this
4015 * structure in case of error only.
4018 * 0 on success, a negative errno value otherwise and rte_errno is set.
4022 rte_flow_tunnel_action_decap_release(uint16_t port_id,
4023 struct rte_flow_action *actions,
4024 uint32_t num_of_actions,
4025 struct rte_flow_error *error);
4028 * Release the item array as allocated by rte_flow_tunnel_match.
4031 * Port identifier of Ethernet device.
4033 * Array of items to be released.
4034 * @param[in] num_of_items
4035 * Number of elements in item array.
4037 * Perform verbose error reporting if not NULL. PMDs initialize this
4038 * structure in case of error only.
4041 * 0 on success, a negative errno value otherwise and rte_errno is set.
4045 rte_flow_tunnel_item_release(uint16_t port_id,
4046 struct rte_flow_item *items,
4047 uint32_t num_of_items,
4048 struct rte_flow_error *error);
4053 #endif /* RTE_FLOW_H_ */