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>
33 #include <rte_bitops.h>
35 #include <rte_mbuf_dyn.h>
36 #include <rte_meter.h>
38 #include <rte_l2tpv2.h>
46 * Flow rule attributes.
48 * Priorities are set on a per rule based within groups.
50 * Lower values denote higher priority, the highest priority for a flow rule
51 * is 0, so that a flow that matches for than one rule, the rule with the
52 * lowest priority value will always be matched.
54 * Although optional, applications are encouraged to group similar rules as
55 * much as possible to fully take advantage of hardware capabilities
56 * (e.g. optimized matching) and work around limitations (e.g. a single
57 * pattern type possibly allowed in a given group). Applications should be
58 * aware that groups are not linked by default, and that they must be
59 * explicitly linked by the application using the JUMP action.
61 * Priority levels are arbitrary and up to the application, they
62 * do not need to be contiguous nor start from 0, however the maximum number
63 * varies between devices and may be affected by existing flow rules.
65 * If a packet is matched by several rules of a given group for a given
66 * priority level, the outcome is undefined. It can take any path, may be
67 * duplicated or even cause unrecoverable errors.
69 * Note that support for more than a single group and priority level is not
72 * At vNIC / ethdev level, flow rules can apply to inbound and / or outbound
73 * traffic (ingress / egress), with respect to the vNIC / ethdev in question.
74 * At embedded switch level, flow rules apply to all traffic seen by it
75 * unless fitting meta items are used to set concrete traffic source(s).
77 * Several pattern items and actions are valid and can be used in both
78 * directions. Those valid for only one direction are described as such.
80 * At least one direction must be specified.
82 * Specifying both directions at once for a given rule is not recommended
83 * but may be valid in a few cases.
85 struct rte_flow_attr {
86 uint32_t group; /**< Priority group. */
87 uint32_t priority; /**< Rule priority level within group. */
89 * The rule in question applies to ingress traffic (non-"transfer").
92 * It has been possible to combine this attribute with "transfer".
93 * Doing so has been assumed to restrict the scope of matching
94 * to traffic going from within the embedded switch toward the
95 * ethdev the flow rule being created through. This behaviour
96 * is deprecated. During the transition period, one may still
97 * rely on it, but PMDs and applications are encouraged to
98 * gradually move away from this approach.
102 * The rule in question applies to egress traffic (non-"transfer").
105 * It has been possible to combine this attribute with "transfer".
106 * Doing so has been assumed to restrict the scope of matching
107 * to traffic sent by the application by virtue of the ethdev
108 * the flow rule being created through. This behaviour is now
109 * deprecated. During the transition period, one may still
110 * rely on it, but PMDs and applications are encouraged to
111 * gradually move away from this approach.
115 * Instead of simply matching the properties of traffic as it would
116 * appear on a given DPDK port ID, enabling this attribute transfers
117 * a flow rule to the lowest possible level of any device endpoints
118 * found in the pattern.
120 * When supported, this effectively enables an application to
121 * re-route traffic not necessarily intended for it (e.g. coming
122 * from or addressed to different physical ports, VFs or
123 * applications) at the device level.
125 * The application should match traffic originating from precise
126 * locations. See items PORT_REPRESENTOR and REPRESENTED_PORT.
128 * Managing "transfer" flows requires that the user communicate them
129 * through a suitable port. @see rte_flow_pick_transfer_proxy().
132 uint32_t reserved:29; /**< Reserved, must be zero. */
136 * Matching pattern item types.
138 * Pattern items fall in two categories:
140 * - Matching protocol headers and packet data, usually associated with a
141 * specification structure. These must be stacked in the same order as the
142 * protocol layers to match inside packets, starting from the lowest.
144 * - Matching meta-data or affecting pattern processing, often without a
145 * specification structure. Since they do not match packet contents, their
146 * position in the list is usually not relevant.
148 * See the description of individual types for more information. Those
149 * marked with [META] fall into the second category.
151 enum rte_flow_item_type {
155 * End marker for item lists. Prevents further processing of items,
156 * thereby ending the pattern.
158 * No associated specification structure.
160 RTE_FLOW_ITEM_TYPE_END,
165 * Used as a placeholder for convenience. It is ignored and simply
168 * No associated specification structure.
170 RTE_FLOW_ITEM_TYPE_VOID,
175 * Inverted matching, i.e. process packets that do not match the
178 * No associated specification structure.
180 RTE_FLOW_ITEM_TYPE_INVERT,
183 * Matches any protocol in place of the current layer, a single ANY
184 * may also stand for several protocol layers.
186 * See struct rte_flow_item_any.
188 RTE_FLOW_ITEM_TYPE_ANY,
192 * @see RTE_FLOW_ITEM_TYPE_PORT_REPRESENTOR
193 * @see RTE_FLOW_ITEM_TYPE_REPRESENTED_PORT
197 * Matches traffic originating from (ingress) or going to (egress)
198 * the physical function of the current device.
200 * No associated specification structure.
202 RTE_FLOW_ITEM_TYPE_PF,
206 * @see RTE_FLOW_ITEM_TYPE_PORT_REPRESENTOR
207 * @see RTE_FLOW_ITEM_TYPE_REPRESENTED_PORT
211 * Matches traffic originating from (ingress) or going to (egress) a
212 * given virtual function of the current device.
214 * See struct rte_flow_item_vf.
216 RTE_FLOW_ITEM_TYPE_VF,
220 * @see RTE_FLOW_ITEM_TYPE_PORT_REPRESENTOR
221 * @see RTE_FLOW_ITEM_TYPE_REPRESENTED_PORT
225 * Matches traffic originating from (ingress) or going to (egress) a
226 * physical port of the underlying device.
228 * See struct rte_flow_item_phy_port.
230 RTE_FLOW_ITEM_TYPE_PHY_PORT,
234 * @see RTE_FLOW_ITEM_TYPE_PORT_REPRESENTOR
235 * @see RTE_FLOW_ITEM_TYPE_REPRESENTED_PORT
239 * Matches traffic originating from (ingress) or going to (egress) a
240 * given DPDK port ID.
242 * See struct rte_flow_item_port_id.
244 RTE_FLOW_ITEM_TYPE_PORT_ID,
247 * Matches a byte string of a given length at a given offset.
249 * See struct rte_flow_item_raw.
251 RTE_FLOW_ITEM_TYPE_RAW,
254 * Matches an Ethernet header.
256 * See struct rte_flow_item_eth.
258 RTE_FLOW_ITEM_TYPE_ETH,
261 * Matches an 802.1Q/ad VLAN tag.
263 * See struct rte_flow_item_vlan.
265 RTE_FLOW_ITEM_TYPE_VLAN,
268 * Matches an IPv4 header.
270 * See struct rte_flow_item_ipv4.
272 RTE_FLOW_ITEM_TYPE_IPV4,
275 * Matches an IPv6 header.
277 * See struct rte_flow_item_ipv6.
279 RTE_FLOW_ITEM_TYPE_IPV6,
282 * Matches an ICMP header.
284 * See struct rte_flow_item_icmp.
286 RTE_FLOW_ITEM_TYPE_ICMP,
289 * Matches a UDP header.
291 * See struct rte_flow_item_udp.
293 RTE_FLOW_ITEM_TYPE_UDP,
296 * Matches a TCP header.
298 * See struct rte_flow_item_tcp.
300 RTE_FLOW_ITEM_TYPE_TCP,
303 * Matches a SCTP header.
305 * See struct rte_flow_item_sctp.
307 RTE_FLOW_ITEM_TYPE_SCTP,
310 * Matches a VXLAN header.
312 * See struct rte_flow_item_vxlan.
314 RTE_FLOW_ITEM_TYPE_VXLAN,
317 * Matches a E_TAG header.
319 * See struct rte_flow_item_e_tag.
321 RTE_FLOW_ITEM_TYPE_E_TAG,
324 * Matches a NVGRE header.
326 * See struct rte_flow_item_nvgre.
328 RTE_FLOW_ITEM_TYPE_NVGRE,
331 * Matches a MPLS header.
333 * See struct rte_flow_item_mpls.
335 RTE_FLOW_ITEM_TYPE_MPLS,
338 * Matches a GRE header.
340 * See struct rte_flow_item_gre.
342 RTE_FLOW_ITEM_TYPE_GRE,
347 * Fuzzy pattern match, expect faster than default.
349 * This is for device that support fuzzy matching option.
350 * Usually a fuzzy matching is fast but the cost is accuracy.
352 * See struct rte_flow_item_fuzzy.
354 RTE_FLOW_ITEM_TYPE_FUZZY,
357 * Matches a GTP header.
359 * Configure flow for GTP packets.
361 * See struct rte_flow_item_gtp.
363 RTE_FLOW_ITEM_TYPE_GTP,
366 * Matches a GTP header.
368 * Configure flow for GTP-C packets.
370 * See struct rte_flow_item_gtp.
372 RTE_FLOW_ITEM_TYPE_GTPC,
375 * Matches a GTP header.
377 * Configure flow for GTP-U packets.
379 * See struct rte_flow_item_gtp.
381 RTE_FLOW_ITEM_TYPE_GTPU,
384 * Matches a ESP header.
386 * See struct rte_flow_item_esp.
388 RTE_FLOW_ITEM_TYPE_ESP,
391 * Matches a GENEVE header.
393 * See struct rte_flow_item_geneve.
395 RTE_FLOW_ITEM_TYPE_GENEVE,
398 * Matches a VXLAN-GPE header.
400 * See struct rte_flow_item_vxlan_gpe.
402 RTE_FLOW_ITEM_TYPE_VXLAN_GPE,
405 * Matches an ARP header for Ethernet/IPv4.
407 * See struct rte_flow_item_arp_eth_ipv4.
409 RTE_FLOW_ITEM_TYPE_ARP_ETH_IPV4,
412 * Matches the presence of any IPv6 extension header.
414 * See struct rte_flow_item_ipv6_ext.
416 RTE_FLOW_ITEM_TYPE_IPV6_EXT,
419 * Matches any ICMPv6 header.
421 * See struct rte_flow_item_icmp6.
423 RTE_FLOW_ITEM_TYPE_ICMP6,
426 * Matches an ICMPv6 neighbor discovery solicitation.
428 * See struct rte_flow_item_icmp6_nd_ns.
430 RTE_FLOW_ITEM_TYPE_ICMP6_ND_NS,
433 * Matches an ICMPv6 neighbor discovery advertisement.
435 * See struct rte_flow_item_icmp6_nd_na.
437 RTE_FLOW_ITEM_TYPE_ICMP6_ND_NA,
440 * Matches the presence of any ICMPv6 neighbor discovery option.
442 * See struct rte_flow_item_icmp6_nd_opt.
444 RTE_FLOW_ITEM_TYPE_ICMP6_ND_OPT,
447 * Matches an ICMPv6 neighbor discovery source Ethernet link-layer
450 * See struct rte_flow_item_icmp6_nd_opt_sla_eth.
452 RTE_FLOW_ITEM_TYPE_ICMP6_ND_OPT_SLA_ETH,
455 * Matches an ICMPv6 neighbor discovery target Ethernet link-layer
458 * See struct rte_flow_item_icmp6_nd_opt_tla_eth.
460 RTE_FLOW_ITEM_TYPE_ICMP6_ND_OPT_TLA_ETH,
463 * Matches specified mark field.
465 * See struct rte_flow_item_mark.
467 RTE_FLOW_ITEM_TYPE_MARK,
472 * Matches a metadata value.
474 * See struct rte_flow_item_meta.
476 RTE_FLOW_ITEM_TYPE_META,
479 * Matches a GRE optional key field.
481 * The value should a big-endian 32bit integer.
483 * When this item present the K bit is implicitly matched as "1"
484 * in the default mask.
487 * @code rte_be32_t * @endcode
489 RTE_FLOW_ITEM_TYPE_GRE_KEY,
492 * Matches a GTP extension header: PDU session container.
494 * Configure flow for GTP packets with extension header type 0x85.
496 * See struct rte_flow_item_gtp_psc.
498 RTE_FLOW_ITEM_TYPE_GTP_PSC,
501 * Matches a PPPoE header.
503 * Configure flow for PPPoE session packets.
505 * See struct rte_flow_item_pppoe.
507 RTE_FLOW_ITEM_TYPE_PPPOES,
510 * Matches a PPPoE header.
512 * Configure flow for PPPoE discovery packets.
514 * See struct rte_flow_item_pppoe.
516 RTE_FLOW_ITEM_TYPE_PPPOED,
519 * Matches a PPPoE optional proto_id field.
521 * It only applies to PPPoE session packets.
523 * See struct rte_flow_item_pppoe_proto_id.
525 RTE_FLOW_ITEM_TYPE_PPPOE_PROTO_ID,
528 * Matches Network service header (NSH).
529 * See struct rte_flow_item_nsh.
532 RTE_FLOW_ITEM_TYPE_NSH,
535 * Matches Internet Group Management Protocol (IGMP).
536 * See struct rte_flow_item_igmp.
539 RTE_FLOW_ITEM_TYPE_IGMP,
542 * Matches IP Authentication Header (AH).
543 * See struct rte_flow_item_ah.
546 RTE_FLOW_ITEM_TYPE_AH,
549 * Matches a HIGIG header.
550 * see struct rte_flow_item_higig2_hdr.
552 RTE_FLOW_ITEM_TYPE_HIGIG2,
557 * Matches a tag value.
559 * See struct rte_flow_item_tag.
561 RTE_FLOW_ITEM_TYPE_TAG,
564 * Matches a L2TPv3 over IP header.
566 * Configure flow for L2TPv3 over IP packets.
568 * See struct rte_flow_item_l2tpv3oip.
570 RTE_FLOW_ITEM_TYPE_L2TPV3OIP,
573 * Matches PFCP Header.
574 * See struct rte_flow_item_pfcp.
577 RTE_FLOW_ITEM_TYPE_PFCP,
580 * Matches eCPRI Header.
582 * Configure flow for eCPRI over ETH or UDP packets.
584 * See struct rte_flow_item_ecpri.
586 RTE_FLOW_ITEM_TYPE_ECPRI,
589 * Matches the presence of IPv6 fragment extension header.
591 * See struct rte_flow_item_ipv6_frag_ext.
593 RTE_FLOW_ITEM_TYPE_IPV6_FRAG_EXT,
596 * Matches Geneve Variable Length Option
598 * See struct rte_flow_item_geneve_opt
600 RTE_FLOW_ITEM_TYPE_GENEVE_OPT,
605 * Matches on packet integrity.
606 * For some devices application needs to enable integration checks in HW
607 * before using this item.
609 * @see struct rte_flow_item_integrity.
611 RTE_FLOW_ITEM_TYPE_INTEGRITY,
616 * Matches conntrack state.
618 * @see struct rte_flow_item_conntrack.
620 RTE_FLOW_ITEM_TYPE_CONNTRACK,
625 * Matches traffic entering the embedded switch from the given ethdev.
627 * @see struct rte_flow_item_ethdev
629 RTE_FLOW_ITEM_TYPE_PORT_REPRESENTOR,
634 * Matches traffic entering the embedded switch from
635 * the entity represented by the given ethdev.
637 * @see struct rte_flow_item_ethdev
639 RTE_FLOW_ITEM_TYPE_REPRESENTED_PORT,
642 * Matches a configured set of fields at runtime calculated offsets
643 * over the generic network header with variable length and
646 * @see struct rte_flow_item_flex.
648 RTE_FLOW_ITEM_TYPE_FLEX,
651 * Matches L2TPv2 Header.
653 * See struct rte_flow_item_l2tpv2.
655 RTE_FLOW_ITEM_TYPE_L2TPV2,
658 * Matches PPP Header.
660 * See struct rte_flow_item_ppp.
662 RTE_FLOW_ITEM_TYPE_PPP,
667 * RTE_FLOW_ITEM_TYPE_HIGIG2
668 * Matches higig2 header
671 struct rte_flow_item_higig2_hdr {
672 struct rte_higig2_hdr hdr;
675 /** Default mask for RTE_FLOW_ITEM_TYPE_HIGIG2. */
677 static const struct rte_flow_item_higig2_hdr rte_flow_item_higig2_hdr_mask = {
680 .classification = 0xffff,
688 * RTE_FLOW_ITEM_TYPE_ANY
690 * Matches any protocol in place of the current layer, a single ANY may also
691 * stand for several protocol layers.
693 * This is usually specified as the first pattern item when looking for a
694 * protocol anywhere in a packet.
696 * A zeroed mask stands for any number of layers.
698 struct rte_flow_item_any {
699 uint32_t num; /**< Number of layers covered. */
702 /** Default mask for RTE_FLOW_ITEM_TYPE_ANY. */
704 static const struct rte_flow_item_any rte_flow_item_any_mask = {
711 * @see RTE_FLOW_ITEM_TYPE_PORT_REPRESENTOR
712 * @see RTE_FLOW_ITEM_TYPE_REPRESENTED_PORT
714 * RTE_FLOW_ITEM_TYPE_VF
716 * Matches traffic originating from (ingress) or going to (egress) a given
717 * virtual function of the current device.
719 * If supported, should work even if the virtual function is not managed by
720 * the application and thus not associated with a DPDK port ID.
722 * Note this pattern item does not match VF representors traffic which, as
723 * separate entities, should be addressed through their own DPDK port IDs.
725 * - Can be specified multiple times to match traffic addressed to several
727 * - Can be combined with a PF item to match both PF and VF traffic.
729 * A zeroed mask can be used to match any VF ID.
731 struct rte_flow_item_vf {
732 uint32_t id; /**< VF ID. */
735 /** Default mask for RTE_FLOW_ITEM_TYPE_VF. */
737 static const struct rte_flow_item_vf rte_flow_item_vf_mask = {
744 * @see RTE_FLOW_ITEM_TYPE_PORT_REPRESENTOR
745 * @see RTE_FLOW_ITEM_TYPE_REPRESENTED_PORT
747 * RTE_FLOW_ITEM_TYPE_PHY_PORT
749 * Matches traffic originating from (ingress) or going to (egress) a
750 * physical port of the underlying device.
752 * The first PHY_PORT item overrides the physical port normally associated
753 * with the specified DPDK input port (port_id). This item can be provided
754 * several times to match additional physical ports.
756 * Note that physical ports are not necessarily tied to DPDK input ports
757 * (port_id) when those are not under DPDK control. Possible values are
758 * specific to each device, they are not necessarily indexed from zero and
759 * may not be contiguous.
761 * As a device property, the list of allowed values as well as the value
762 * associated with a port_id should be retrieved by other means.
764 * A zeroed mask can be used to match any port index.
766 struct rte_flow_item_phy_port {
767 uint32_t index; /**< Physical port index. */
770 /** Default mask for RTE_FLOW_ITEM_TYPE_PHY_PORT. */
772 static const struct rte_flow_item_phy_port rte_flow_item_phy_port_mask = {
779 * @see RTE_FLOW_ITEM_TYPE_PORT_REPRESENTOR
780 * @see RTE_FLOW_ITEM_TYPE_REPRESENTED_PORT
782 * RTE_FLOW_ITEM_TYPE_PORT_ID
784 * Matches traffic originating from (ingress) or going to (egress) a given
787 * Normally only supported if the port ID in question is known by the
788 * underlying PMD and related to the device the flow rule is created
791 * This must not be confused with @p PHY_PORT which refers to the physical
792 * port of a device, whereas @p PORT_ID refers to a struct rte_eth_dev
793 * object on the application side (also known as "port representor"
794 * depending on the kind of underlying device).
796 struct rte_flow_item_port_id {
797 uint32_t id; /**< DPDK port ID. */
800 /** Default mask for RTE_FLOW_ITEM_TYPE_PORT_ID. */
802 static const struct rte_flow_item_port_id rte_flow_item_port_id_mask = {
808 * RTE_FLOW_ITEM_TYPE_RAW
810 * Matches a byte string of a given length at a given offset.
812 * Offset is either absolute (using the start of the packet) or relative to
813 * the end of the previous matched item in the stack, in which case negative
814 * values are allowed.
816 * If search is enabled, offset is used as the starting point. The search
817 * area can be delimited by setting limit to a nonzero value, which is the
818 * maximum number of bytes after offset where the pattern may start.
820 * Matching a zero-length pattern is allowed, doing so resets the relative
821 * offset for subsequent items.
823 * This type does not support ranges (struct rte_flow_item.last).
825 struct rte_flow_item_raw {
826 uint32_t relative:1; /**< Look for pattern after the previous item. */
827 uint32_t search:1; /**< Search pattern from offset (see also limit). */
828 uint32_t reserved:30; /**< Reserved, must be set to zero. */
829 int32_t offset; /**< Absolute or relative offset for pattern. */
830 uint16_t limit; /**< Search area limit for start of pattern. */
831 uint16_t length; /**< Pattern length. */
832 const uint8_t *pattern; /**< Byte string to look for. */
835 /** Default mask for RTE_FLOW_ITEM_TYPE_RAW. */
837 static const struct rte_flow_item_raw rte_flow_item_raw_mask = {
840 .reserved = 0x3fffffff,
841 .offset = 0xffffffff,
849 * RTE_FLOW_ITEM_TYPE_ETH
851 * Matches an Ethernet header.
853 * Inside @p hdr field, the sub-field @p ether_type stands either for EtherType
854 * or TPID, depending on whether the item is followed by a VLAN item or not. If
855 * two VLAN items follow, the sub-field refers to the outer one, which, in turn,
856 * contains the inner TPID in the similar header field. The innermost VLAN item
857 * contains a layer-3 EtherType. All of that follows the order seen on the wire.
859 * If the field in question contains a TPID value, only tagged packets with the
860 * specified TPID will match the pattern. Alternatively, it's possible to match
861 * any type of tagged packets by means of the field @p has_vlan rather than use
862 * the EtherType/TPID field. Also, it's possible to leave the two fields unused.
863 * If this is the case, both tagged and untagged packets will match the pattern.
866 struct rte_flow_item_eth {
870 * These fields are retained for compatibility.
871 * Please switch to the new header field below.
873 struct rte_ether_addr dst; /**< Destination MAC. */
874 struct rte_ether_addr src; /**< Source MAC. */
875 rte_be16_t type; /**< EtherType or TPID. */
877 struct rte_ether_hdr hdr;
879 uint32_t has_vlan:1; /**< Packet header contains at least one VLAN. */
880 uint32_t reserved:31; /**< Reserved, must be zero. */
883 /** Default mask for RTE_FLOW_ITEM_TYPE_ETH. */
885 static const struct rte_flow_item_eth rte_flow_item_eth_mask = {
886 .hdr.dst_addr.addr_bytes = "\xff\xff\xff\xff\xff\xff",
887 .hdr.src_addr.addr_bytes = "\xff\xff\xff\xff\xff\xff",
888 .hdr.ether_type = RTE_BE16(0x0000),
893 * RTE_FLOW_ITEM_TYPE_VLAN
895 * Matches an 802.1Q/ad VLAN tag.
897 * The corresponding standard outer EtherType (TPID) values are
898 * RTE_ETHER_TYPE_VLAN or RTE_ETHER_TYPE_QINQ. It can be overridden by
899 * the preceding pattern item.
900 * If a @p VLAN item is present in the pattern, then only tagged packets will
902 * The field @p has_more_vlan can be used to match any type of tagged packets,
903 * instead of using the @p eth_proto field of @p hdr.
904 * If the @p eth_proto of @p hdr and @p has_more_vlan fields are not specified,
905 * then any tagged packets will match the pattern.
908 struct rte_flow_item_vlan {
912 * These fields are retained for compatibility.
913 * Please switch to the new header field below.
915 rte_be16_t tci; /**< Tag control information. */
916 rte_be16_t inner_type; /**< Inner EtherType or TPID. */
918 struct rte_vlan_hdr hdr;
920 /** Packet header contains at least one more VLAN, after this VLAN. */
921 uint32_t has_more_vlan:1;
922 uint32_t reserved:31; /**< Reserved, must be zero. */
925 /** Default mask for RTE_FLOW_ITEM_TYPE_VLAN. */
927 static const struct rte_flow_item_vlan rte_flow_item_vlan_mask = {
928 .hdr.vlan_tci = RTE_BE16(0x0fff),
929 .hdr.eth_proto = RTE_BE16(0x0000),
934 * RTE_FLOW_ITEM_TYPE_IPV4
936 * Matches an IPv4 header.
938 * Note: IPv4 options are handled by dedicated pattern items.
940 struct rte_flow_item_ipv4 {
941 struct rte_ipv4_hdr hdr; /**< IPv4 header definition. */
944 /** Default mask for RTE_FLOW_ITEM_TYPE_IPV4. */
946 static const struct rte_flow_item_ipv4 rte_flow_item_ipv4_mask = {
948 .src_addr = RTE_BE32(0xffffffff),
949 .dst_addr = RTE_BE32(0xffffffff),
955 * RTE_FLOW_ITEM_TYPE_IPV6.
957 * Matches an IPv6 header.
959 * Dedicated flags indicate if header contains specific extension headers.
961 struct rte_flow_item_ipv6 {
962 struct rte_ipv6_hdr hdr; /**< IPv6 header definition. */
963 /** Header contains Hop-by-Hop Options extension header. */
964 uint32_t has_hop_ext:1;
965 /** Header contains Routing extension header. */
966 uint32_t has_route_ext:1;
967 /** Header contains Fragment extension header. */
968 uint32_t has_frag_ext:1;
969 /** Header contains Authentication extension header. */
970 uint32_t has_auth_ext:1;
971 /** Header contains Encapsulation Security Payload extension header. */
972 uint32_t has_esp_ext:1;
973 /** Header contains Destination Options extension header. */
974 uint32_t has_dest_ext:1;
975 /** Header contains Mobility extension header. */
976 uint32_t has_mobil_ext:1;
977 /** Header contains Host Identity Protocol extension header. */
978 uint32_t has_hip_ext:1;
979 /** Header contains Shim6 Protocol extension header. */
980 uint32_t has_shim6_ext:1;
981 /** Reserved for future extension headers, must be zero. */
982 uint32_t reserved:23;
985 /** Default mask for RTE_FLOW_ITEM_TYPE_IPV6. */
987 static const struct rte_flow_item_ipv6 rte_flow_item_ipv6_mask = {
990 "\xff\xff\xff\xff\xff\xff\xff\xff"
991 "\xff\xff\xff\xff\xff\xff\xff\xff",
993 "\xff\xff\xff\xff\xff\xff\xff\xff"
994 "\xff\xff\xff\xff\xff\xff\xff\xff",
1000 * RTE_FLOW_ITEM_TYPE_ICMP.
1002 * Matches an ICMP header.
1004 struct rte_flow_item_icmp {
1005 struct rte_icmp_hdr hdr; /**< ICMP header definition. */
1008 /** Default mask for RTE_FLOW_ITEM_TYPE_ICMP. */
1010 static const struct rte_flow_item_icmp rte_flow_item_icmp_mask = {
1019 * RTE_FLOW_ITEM_TYPE_UDP.
1021 * Matches a UDP header.
1023 struct rte_flow_item_udp {
1024 struct rte_udp_hdr hdr; /**< UDP header definition. */
1027 /** Default mask for RTE_FLOW_ITEM_TYPE_UDP. */
1029 static const struct rte_flow_item_udp rte_flow_item_udp_mask = {
1031 .src_port = RTE_BE16(0xffff),
1032 .dst_port = RTE_BE16(0xffff),
1038 * RTE_FLOW_ITEM_TYPE_TCP.
1040 * Matches a TCP header.
1042 struct rte_flow_item_tcp {
1043 struct rte_tcp_hdr hdr; /**< TCP header definition. */
1046 /** Default mask for RTE_FLOW_ITEM_TYPE_TCP. */
1048 static const struct rte_flow_item_tcp rte_flow_item_tcp_mask = {
1050 .src_port = RTE_BE16(0xffff),
1051 .dst_port = RTE_BE16(0xffff),
1057 * RTE_FLOW_ITEM_TYPE_SCTP.
1059 * Matches a SCTP header.
1061 struct rte_flow_item_sctp {
1062 struct rte_sctp_hdr hdr; /**< SCTP header definition. */
1065 /** Default mask for RTE_FLOW_ITEM_TYPE_SCTP. */
1067 static const struct rte_flow_item_sctp rte_flow_item_sctp_mask = {
1069 .src_port = RTE_BE16(0xffff),
1070 .dst_port = RTE_BE16(0xffff),
1076 * RTE_FLOW_ITEM_TYPE_VXLAN.
1078 * Matches a VXLAN header (RFC 7348).
1081 struct rte_flow_item_vxlan {
1085 * These fields are retained for compatibility.
1086 * Please switch to the new header field below.
1088 uint8_t flags; /**< Normally 0x08 (I flag). */
1089 uint8_t rsvd0[3]; /**< Reserved, normally 0x000000. */
1090 uint8_t vni[3]; /**< VXLAN identifier. */
1091 uint8_t rsvd1; /**< Reserved, normally 0x00. */
1093 struct rte_vxlan_hdr hdr;
1097 /** Default mask for RTE_FLOW_ITEM_TYPE_VXLAN. */
1099 static const struct rte_flow_item_vxlan rte_flow_item_vxlan_mask = {
1100 .hdr.vx_vni = RTE_BE32(0xffffff00), /* (0xffffff << 8) */
1105 * RTE_FLOW_ITEM_TYPE_E_TAG.
1107 * Matches a E-tag header.
1109 * The corresponding standard outer EtherType (TPID) value is
1110 * RTE_ETHER_TYPE_ETAG. It can be overridden by the preceding pattern item.
1112 struct rte_flow_item_e_tag {
1114 * E-Tag control information (E-TCI).
1115 * E-PCP (3b), E-DEI (1b), ingress E-CID base (12b).
1117 rte_be16_t epcp_edei_in_ecid_b;
1118 /** Reserved (2b), GRP (2b), E-CID base (12b). */
1119 rte_be16_t rsvd_grp_ecid_b;
1120 uint8_t in_ecid_e; /**< Ingress E-CID ext. */
1121 uint8_t ecid_e; /**< E-CID ext. */
1122 rte_be16_t inner_type; /**< Inner EtherType or TPID. */
1125 /** Default mask for RTE_FLOW_ITEM_TYPE_E_TAG. */
1127 static const struct rte_flow_item_e_tag rte_flow_item_e_tag_mask = {
1128 .rsvd_grp_ecid_b = RTE_BE16(0x3fff),
1133 * RTE_FLOW_ITEM_TYPE_NVGRE.
1135 * Matches a NVGRE header.
1137 struct rte_flow_item_nvgre {
1139 * Checksum (1b), undefined (1b), key bit (1b), sequence number (1b),
1140 * reserved 0 (9b), version (3b).
1142 * c_k_s_rsvd0_ver must have value 0x2000 according to RFC 7637.
1144 rte_be16_t c_k_s_rsvd0_ver;
1145 rte_be16_t protocol; /**< Protocol type (0x6558). */
1146 uint8_t tni[3]; /**< Virtual subnet ID. */
1147 uint8_t flow_id; /**< Flow ID. */
1150 /** Default mask for RTE_FLOW_ITEM_TYPE_NVGRE. */
1152 static const struct rte_flow_item_nvgre rte_flow_item_nvgre_mask = {
1153 .tni = "\xff\xff\xff",
1158 * RTE_FLOW_ITEM_TYPE_MPLS.
1160 * Matches a MPLS header.
1162 struct rte_flow_item_mpls {
1164 * Label (20b), TC (3b), Bottom of Stack (1b).
1166 uint8_t label_tc_s[3];
1167 uint8_t ttl; /** Time-to-Live. */
1170 /** Default mask for RTE_FLOW_ITEM_TYPE_MPLS. */
1172 static const struct rte_flow_item_mpls rte_flow_item_mpls_mask = {
1173 .label_tc_s = "\xff\xff\xf0",
1178 * RTE_FLOW_ITEM_TYPE_GRE.
1180 * Matches a GRE header.
1182 struct rte_flow_item_gre {
1184 * Checksum (1b), reserved 0 (12b), version (3b).
1185 * Refer to RFC 2784.
1187 rte_be16_t c_rsvd0_ver;
1188 rte_be16_t protocol; /**< Protocol type. */
1191 /** Default mask for RTE_FLOW_ITEM_TYPE_GRE. */
1193 static const struct rte_flow_item_gre rte_flow_item_gre_mask = {
1194 .protocol = RTE_BE16(0xffff),
1199 * RTE_FLOW_ITEM_TYPE_FUZZY
1201 * Fuzzy pattern match, expect faster than default.
1203 * This is for device that support fuzzy match option.
1204 * Usually a fuzzy match is fast but the cost is accuracy.
1205 * i.e. Signature Match only match pattern's hash value, but it is
1206 * possible two different patterns have the same hash value.
1208 * Matching accuracy level can be configure by threshold.
1209 * Driver can divide the range of threshold and map to different
1210 * accuracy levels that device support.
1212 * Threshold 0 means perfect match (no fuzziness), while threshold
1213 * 0xffffffff means fuzziest match.
1215 struct rte_flow_item_fuzzy {
1216 uint32_t thresh; /**< Accuracy threshold. */
1219 /** Default mask for RTE_FLOW_ITEM_TYPE_FUZZY. */
1221 static const struct rte_flow_item_fuzzy rte_flow_item_fuzzy_mask = {
1222 .thresh = 0xffffffff,
1227 * RTE_FLOW_ITEM_TYPE_GTP.
1229 * Matches a GTPv1 header.
1231 struct rte_flow_item_gtp {
1233 * Version (3b), protocol type (1b), reserved (1b),
1234 * Extension header flag (1b),
1235 * Sequence number flag (1b),
1236 * N-PDU number flag (1b).
1238 uint8_t v_pt_rsv_flags;
1239 uint8_t msg_type; /**< Message type. */
1240 rte_be16_t msg_len; /**< Message length. */
1241 rte_be32_t teid; /**< Tunnel endpoint identifier. */
1244 /** Default mask for RTE_FLOW_ITEM_TYPE_GTP. */
1246 static const struct rte_flow_item_gtp rte_flow_item_gtp_mask = {
1247 .teid = RTE_BE32(0xffffffff),
1252 * RTE_FLOW_ITEM_TYPE_ESP
1254 * Matches an ESP header.
1256 struct rte_flow_item_esp {
1257 struct rte_esp_hdr hdr; /**< ESP header definition. */
1260 /** Default mask for RTE_FLOW_ITEM_TYPE_ESP. */
1262 static const struct rte_flow_item_esp rte_flow_item_esp_mask = {
1264 .spi = RTE_BE32(0xffffffff),
1270 * RTE_FLOW_ITEM_TYPE_GENEVE.
1272 * Matches a GENEVE header.
1274 struct rte_flow_item_geneve {
1276 * Version (2b), length of the options fields (6b), OAM packet (1b),
1277 * critical options present (1b), reserved 0 (6b).
1279 rte_be16_t ver_opt_len_o_c_rsvd0;
1280 rte_be16_t protocol; /**< Protocol type. */
1281 uint8_t vni[3]; /**< Virtual Network Identifier. */
1282 uint8_t rsvd1; /**< Reserved, normally 0x00. */
1285 /** Default mask for RTE_FLOW_ITEM_TYPE_GENEVE. */
1287 static const struct rte_flow_item_geneve rte_flow_item_geneve_mask = {
1288 .vni = "\xff\xff\xff",
1293 * RTE_FLOW_ITEM_TYPE_VXLAN_GPE (draft-ietf-nvo3-vxlan-gpe-05).
1295 * Matches a VXLAN-GPE header.
1297 struct rte_flow_item_vxlan_gpe {
1298 uint8_t flags; /**< Normally 0x0c (I and P flags). */
1299 uint8_t rsvd0[2]; /**< Reserved, normally 0x0000. */
1300 uint8_t protocol; /**< Protocol type. */
1301 uint8_t vni[3]; /**< VXLAN identifier. */
1302 uint8_t rsvd1; /**< Reserved, normally 0x00. */
1305 /** Default mask for RTE_FLOW_ITEM_TYPE_VXLAN_GPE. */
1307 static const struct rte_flow_item_vxlan_gpe rte_flow_item_vxlan_gpe_mask = {
1308 .vni = "\xff\xff\xff",
1313 * RTE_FLOW_ITEM_TYPE_ARP_ETH_IPV4
1315 * Matches an ARP header for Ethernet/IPv4.
1317 struct rte_flow_item_arp_eth_ipv4 {
1318 rte_be16_t hrd; /**< Hardware type, normally 1. */
1319 rte_be16_t pro; /**< Protocol type, normally 0x0800. */
1320 uint8_t hln; /**< Hardware address length, normally 6. */
1321 uint8_t pln; /**< Protocol address length, normally 4. */
1322 rte_be16_t op; /**< Opcode (1 for request, 2 for reply). */
1323 struct rte_ether_addr sha; /**< Sender hardware address. */
1324 rte_be32_t spa; /**< Sender IPv4 address. */
1325 struct rte_ether_addr tha; /**< Target hardware address. */
1326 rte_be32_t tpa; /**< Target IPv4 address. */
1329 /** Default mask for RTE_FLOW_ITEM_TYPE_ARP_ETH_IPV4. */
1331 static const struct rte_flow_item_arp_eth_ipv4
1332 rte_flow_item_arp_eth_ipv4_mask = {
1333 .sha.addr_bytes = "\xff\xff\xff\xff\xff\xff",
1334 .spa = RTE_BE32(0xffffffff),
1335 .tha.addr_bytes = "\xff\xff\xff\xff\xff\xff",
1336 .tpa = RTE_BE32(0xffffffff),
1341 * RTE_FLOW_ITEM_TYPE_IPV6_EXT
1343 * Matches the presence of any IPv6 extension header.
1345 * Normally preceded by any of:
1347 * - RTE_FLOW_ITEM_TYPE_IPV6
1348 * - RTE_FLOW_ITEM_TYPE_IPV6_EXT
1350 struct rte_flow_item_ipv6_ext {
1351 uint8_t next_hdr; /**< Next header. */
1354 /** Default mask for RTE_FLOW_ITEM_TYPE_IPV6_EXT. */
1357 struct rte_flow_item_ipv6_ext rte_flow_item_ipv6_ext_mask = {
1363 * RTE_FLOW_ITEM_TYPE_IPV6_FRAG_EXT
1365 * Matches the presence of IPv6 fragment extension header.
1367 * Preceded by any of:
1369 * - RTE_FLOW_ITEM_TYPE_IPV6
1370 * - RTE_FLOW_ITEM_TYPE_IPV6_EXT
1372 struct rte_flow_item_ipv6_frag_ext {
1373 struct rte_ipv6_fragment_ext hdr;
1377 * RTE_FLOW_ITEM_TYPE_ICMP6
1379 * Matches any ICMPv6 header.
1381 struct rte_flow_item_icmp6 {
1382 uint8_t type; /**< ICMPv6 type. */
1383 uint8_t code; /**< ICMPv6 code. */
1384 uint16_t checksum; /**< ICMPv6 checksum. */
1387 /** Default mask for RTE_FLOW_ITEM_TYPE_ICMP6. */
1389 static const struct rte_flow_item_icmp6 rte_flow_item_icmp6_mask = {
1396 * RTE_FLOW_ITEM_TYPE_ICMP6_ND_NS
1398 * Matches an ICMPv6 neighbor discovery solicitation.
1400 struct rte_flow_item_icmp6_nd_ns {
1401 uint8_t type; /**< ICMPv6 type, normally 135. */
1402 uint8_t code; /**< ICMPv6 code, normally 0. */
1403 rte_be16_t checksum; /**< ICMPv6 checksum. */
1404 rte_be32_t reserved; /**< Reserved, normally 0. */
1405 uint8_t target_addr[16]; /**< Target address. */
1408 /** Default mask for RTE_FLOW_ITEM_TYPE_ICMP6_ND_NS. */
1411 struct rte_flow_item_icmp6_nd_ns rte_flow_item_icmp6_nd_ns_mask = {
1413 "\xff\xff\xff\xff\xff\xff\xff\xff"
1414 "\xff\xff\xff\xff\xff\xff\xff\xff",
1419 * RTE_FLOW_ITEM_TYPE_ICMP6_ND_NA
1421 * Matches an ICMPv6 neighbor discovery advertisement.
1423 struct rte_flow_item_icmp6_nd_na {
1424 uint8_t type; /**< ICMPv6 type, normally 136. */
1425 uint8_t code; /**< ICMPv6 code, normally 0. */
1426 rte_be16_t checksum; /**< ICMPv6 checksum. */
1428 * Route flag (1b), solicited flag (1b), override flag (1b),
1431 rte_be32_t rso_reserved;
1432 uint8_t target_addr[16]; /**< Target address. */
1435 /** Default mask for RTE_FLOW_ITEM_TYPE_ICMP6_ND_NA. */
1438 struct rte_flow_item_icmp6_nd_na rte_flow_item_icmp6_nd_na_mask = {
1440 "\xff\xff\xff\xff\xff\xff\xff\xff"
1441 "\xff\xff\xff\xff\xff\xff\xff\xff",
1446 * RTE_FLOW_ITEM_TYPE_ICMP6_ND_OPT
1448 * Matches the presence of any ICMPv6 neighbor discovery option.
1450 * Normally preceded by any of:
1452 * - RTE_FLOW_ITEM_TYPE_ICMP6_ND_NA
1453 * - RTE_FLOW_ITEM_TYPE_ICMP6_ND_NS
1454 * - RTE_FLOW_ITEM_TYPE_ICMP6_ND_OPT
1456 struct rte_flow_item_icmp6_nd_opt {
1457 uint8_t type; /**< ND option type. */
1458 uint8_t length; /**< ND option length. */
1461 /** Default mask for RTE_FLOW_ITEM_TYPE_ICMP6_ND_OPT. */
1463 static const struct rte_flow_item_icmp6_nd_opt
1464 rte_flow_item_icmp6_nd_opt_mask = {
1470 * RTE_FLOW_ITEM_TYPE_ICMP6_ND_OPT_SLA_ETH
1472 * Matches an ICMPv6 neighbor discovery source Ethernet link-layer address
1475 * Normally preceded by any of:
1477 * - RTE_FLOW_ITEM_TYPE_ICMP6_ND_NA
1478 * - RTE_FLOW_ITEM_TYPE_ICMP6_ND_OPT
1480 struct rte_flow_item_icmp6_nd_opt_sla_eth {
1481 uint8_t type; /**< ND option type, normally 1. */
1482 uint8_t length; /**< ND option length, normally 1. */
1483 struct rte_ether_addr sla; /**< Source Ethernet LLA. */
1486 /** Default mask for RTE_FLOW_ITEM_TYPE_ICMP6_ND_OPT_SLA_ETH. */
1488 static const struct rte_flow_item_icmp6_nd_opt_sla_eth
1489 rte_flow_item_icmp6_nd_opt_sla_eth_mask = {
1490 .sla.addr_bytes = "\xff\xff\xff\xff\xff\xff",
1495 * RTE_FLOW_ITEM_TYPE_ICMP6_ND_OPT_TLA_ETH
1497 * Matches an ICMPv6 neighbor discovery target Ethernet link-layer address
1500 * Normally preceded by any of:
1502 * - RTE_FLOW_ITEM_TYPE_ICMP6_ND_NS
1503 * - RTE_FLOW_ITEM_TYPE_ICMP6_ND_OPT
1505 struct rte_flow_item_icmp6_nd_opt_tla_eth {
1506 uint8_t type; /**< ND option type, normally 2. */
1507 uint8_t length; /**< ND option length, normally 1. */
1508 struct rte_ether_addr tla; /**< Target Ethernet LLA. */
1511 /** Default mask for RTE_FLOW_ITEM_TYPE_ICMP6_ND_OPT_TLA_ETH. */
1513 static const struct rte_flow_item_icmp6_nd_opt_tla_eth
1514 rte_flow_item_icmp6_nd_opt_tla_eth_mask = {
1515 .tla.addr_bytes = "\xff\xff\xff\xff\xff\xff",
1520 * RTE_FLOW_ITEM_TYPE_META
1522 * Matches a specified metadata value. On egress, metadata can be set
1523 * either by mbuf dynamic metadata field with PKT_TX_DYNF_METADATA flag or
1524 * RTE_FLOW_ACTION_TYPE_SET_META. On ingress, RTE_FLOW_ACTION_TYPE_SET_META
1525 * sets metadata for a packet and the metadata will be reported via mbuf
1526 * metadata dynamic field with PKT_RX_DYNF_METADATA flag. The dynamic mbuf
1527 * field must be registered in advance by rte_flow_dynf_metadata_register().
1529 struct rte_flow_item_meta {
1533 /** Default mask for RTE_FLOW_ITEM_TYPE_META. */
1535 static const struct rte_flow_item_meta rte_flow_item_meta_mask = {
1541 * RTE_FLOW_ITEM_TYPE_GTP_PSC.
1543 * Matches a GTP PDU extension header with type 0x85.
1545 struct rte_flow_item_gtp_psc {
1546 struct rte_gtp_psc_generic_hdr hdr; /**< gtp psc generic hdr. */
1549 /** Default mask for RTE_FLOW_ITEM_TYPE_GTP_PSC. */
1551 static const struct rte_flow_item_gtp_psc
1552 rte_flow_item_gtp_psc_mask = {
1558 * RTE_FLOW_ITEM_TYPE_PPPOE.
1560 * Matches a PPPoE header.
1562 struct rte_flow_item_pppoe {
1564 * Version (4b), type (4b).
1566 uint8_t version_type;
1567 uint8_t code; /**< Message type. */
1568 rte_be16_t session_id; /**< Session identifier. */
1569 rte_be16_t length; /**< Payload length. */
1573 * RTE_FLOW_ITEM_TYPE_PPPOE_PROTO_ID.
1575 * Matches a PPPoE optional proto_id field.
1577 * It only applies to PPPoE session packets.
1579 * Normally preceded by any of:
1581 * - RTE_FLOW_ITEM_TYPE_PPPOE
1582 * - RTE_FLOW_ITEM_TYPE_PPPOE_PROTO_ID
1584 struct rte_flow_item_pppoe_proto_id {
1585 rte_be16_t proto_id; /**< PPP protocol identifier. */
1588 /** Default mask for RTE_FLOW_ITEM_TYPE_PPPOE_PROTO_ID. */
1590 static const struct rte_flow_item_pppoe_proto_id
1591 rte_flow_item_pppoe_proto_id_mask = {
1592 .proto_id = RTE_BE16(0xffff),
1598 * @b EXPERIMENTAL: this structure may change without prior notice
1600 * RTE_FLOW_ITEM_TYPE_TAG
1602 * Matches a specified tag value at the specified index.
1604 struct rte_flow_item_tag {
1609 /** Default mask for RTE_FLOW_ITEM_TYPE_TAG. */
1611 static const struct rte_flow_item_tag rte_flow_item_tag_mask = {
1618 * RTE_FLOW_ITEM_TYPE_L2TPV3OIP.
1620 * Matches a L2TPv3 over IP header.
1622 struct rte_flow_item_l2tpv3oip {
1623 rte_be32_t session_id; /**< Session ID. */
1626 /** Default mask for RTE_FLOW_ITEM_TYPE_L2TPV3OIP. */
1628 static const struct rte_flow_item_l2tpv3oip rte_flow_item_l2tpv3oip_mask = {
1629 .session_id = RTE_BE32(UINT32_MAX),
1636 * @b EXPERIMENTAL: this structure may change without prior notice
1638 * RTE_FLOW_ITEM_TYPE_MARK
1640 * Matches an arbitrary integer value which was set using the ``MARK`` action
1641 * in a previously matched rule.
1643 * This item can only be specified once as a match criteria as the ``MARK``
1644 * action can only be specified once in a flow action.
1646 * This value is arbitrary and application-defined. Maximum allowed value
1647 * depends on the underlying implementation.
1649 * Depending on the underlying implementation the MARK item may be supported on
1650 * the physical device, with virtual groups in the PMD or not at all.
1652 struct rte_flow_item_mark {
1653 uint32_t id; /**< Integer value to match against. */
1656 /** Default mask for RTE_FLOW_ITEM_TYPE_MARK. */
1658 static const struct rte_flow_item_mark rte_flow_item_mark_mask = {
1665 * @b EXPERIMENTAL: this structure may change without prior notice
1667 * RTE_FLOW_ITEM_TYPE_NSH
1669 * Match network service header (NSH), RFC 8300
1672 struct rte_flow_item_nsh {
1675 uint32_t reserved:1;
1678 uint32_t reserved1:4;
1680 uint32_t next_proto:8;
1685 /** Default mask for RTE_FLOW_ITEM_TYPE_NSH. */
1687 static const struct rte_flow_item_nsh rte_flow_item_nsh_mask = {
1697 * @b EXPERIMENTAL: this structure may change without prior notice
1699 * RTE_FLOW_ITEM_TYPE_IGMP
1701 * Match Internet Group Management Protocol (IGMP), RFC 2236
1704 struct rte_flow_item_igmp {
1706 uint32_t max_resp_time:8;
1707 uint32_t checksum:16;
1708 uint32_t group_addr;
1711 /** Default mask for RTE_FLOW_ITEM_TYPE_IGMP. */
1713 static const struct rte_flow_item_igmp rte_flow_item_igmp_mask = {
1714 .group_addr = 0xffffffff,
1720 * @b EXPERIMENTAL: this structure may change without prior notice
1722 * RTE_FLOW_ITEM_TYPE_AH
1724 * Match IP Authentication Header (AH), RFC 4302
1727 struct rte_flow_item_ah {
1728 uint32_t next_hdr:8;
1729 uint32_t payload_len:8;
1730 uint32_t reserved:16;
1735 /** Default mask for RTE_FLOW_ITEM_TYPE_AH. */
1737 static const struct rte_flow_item_ah rte_flow_item_ah_mask = {
1744 * @b EXPERIMENTAL: this structure may change without prior notice
1746 * RTE_FLOW_ITEM_TYPE_PFCP
1750 struct rte_flow_item_pfcp {
1757 /** Default mask for RTE_FLOW_ITEM_TYPE_PFCP. */
1759 static const struct rte_flow_item_pfcp rte_flow_item_pfcp_mask = {
1761 .seid = RTE_BE64(UINT64_C(0xffffffffffffffff)),
1767 * @b EXPERIMENTAL: this structure may change without prior notice
1769 * RTE_FLOW_ITEM_TYPE_ECPRI
1771 * Match eCPRI Header
1773 struct rte_flow_item_ecpri {
1774 struct rte_ecpri_combined_msg_hdr hdr;
1777 /** Default mask for RTE_FLOW_ITEM_TYPE_ECPRI. */
1779 static const struct rte_flow_item_ecpri rte_flow_item_ecpri_mask = {
1789 * RTE_FLOW_ITEM_TYPE_GENEVE_OPT
1791 * Matches a GENEVE Variable Length Option
1793 struct rte_flow_item_geneve_opt {
1794 rte_be16_t option_class;
1795 uint8_t option_type;
1800 /** Default mask for RTE_FLOW_ITEM_TYPE_GENEVE_OPT. */
1802 static const struct rte_flow_item_geneve_opt
1803 rte_flow_item_geneve_opt_mask = {
1804 .option_type = 0xff,
1810 * @b EXPERIMENTAL: this structure may change without prior notice
1812 * RTE_FLOW_ITEM_TYPE_INTEGRITY
1814 * Match on packet integrity check result.
1816 struct rte_flow_item_integrity {
1817 /** Tunnel encapsulation level the item should apply to.
1818 * @see rte_flow_action_rss
1825 /** The packet is valid after passing all HW checks. */
1826 uint64_t packet_ok:1;
1827 /** L2 layer is valid after passing all HW checks. */
1829 /** L3 layer is valid after passing all HW checks. */
1831 /** L4 layer is valid after passing all HW checks. */
1833 /** L2 layer CRC is valid. */
1834 uint64_t l2_crc_ok:1;
1835 /** IPv4 layer checksum is valid. */
1836 uint64_t ipv4_csum_ok:1;
1837 /** L4 layer checksum is valid. */
1838 uint64_t l4_csum_ok:1;
1839 /** L3 length is smaller than frame length. */
1840 uint64_t l3_len_ok:1;
1841 uint64_t reserved:56;
1848 static const struct rte_flow_item_integrity
1849 rte_flow_item_integrity_mask = {
1856 * The packet is valid after conntrack checking.
1858 #define RTE_FLOW_CONNTRACK_PKT_STATE_VALID RTE_BIT32(0)
1860 * The state of the connection is changed.
1862 #define RTE_FLOW_CONNTRACK_PKT_STATE_CHANGED RTE_BIT32(1)
1864 * Error is detected on this packet for this connection and
1865 * an invalid state is set.
1867 #define RTE_FLOW_CONNTRACK_PKT_STATE_INVALID RTE_BIT32(2)
1869 * The HW connection tracking module is disabled.
1870 * It can be due to application command or an invalid state.
1872 #define RTE_FLOW_CONNTRACK_PKT_STATE_DISABLED RTE_BIT32(3)
1874 * The packet contains some bad field(s) and cannot continue
1875 * with the conntrack module checking.
1877 #define RTE_FLOW_CONNTRACK_PKT_STATE_BAD RTE_BIT32(4)
1881 * @b EXPERIMENTAL: this structure may change without prior notice
1883 * RTE_FLOW_ITEM_TYPE_CONNTRACK
1885 * Matches the state of a packet after it passed the connection tracking
1886 * examination. The state is a bitmap of one RTE_FLOW_CONNTRACK_PKT_STATE*
1887 * or a reasonable combination of these bits.
1889 struct rte_flow_item_conntrack {
1893 /** Default mask for RTE_FLOW_ITEM_TYPE_CONNTRACK. */
1895 static const struct rte_flow_item_conntrack rte_flow_item_conntrack_mask = {
1896 .flags = 0xffffffff,
1902 * @b EXPERIMENTAL: this structure may change without prior notice
1904 * Provides an ethdev port ID for use with the following items:
1905 * RTE_FLOW_ITEM_TYPE_PORT_REPRESENTOR,
1906 * RTE_FLOW_ITEM_TYPE_REPRESENTED_PORT.
1908 struct rte_flow_item_ethdev {
1909 uint16_t port_id; /**< ethdev port ID */
1912 /** Default mask for items based on struct rte_flow_item_ethdev */
1914 static const struct rte_flow_item_ethdev rte_flow_item_ethdev_mask = {
1921 * @b EXPERIMENTAL: this structure may change without prior notice
1923 * RTE_FLOW_ITEM_TYPE_L2TPV2
1925 * Matches L2TPv2 Header
1927 struct rte_flow_item_l2tpv2 {
1928 struct rte_l2tpv2_combined_msg_hdr hdr;
1931 /** Default mask for RTE_FLOW_ITEM_TYPE_L2TPV2. */
1933 static const struct rte_flow_item_l2tpv2 rte_flow_item_l2tpv2_mask = {
1935 * flags and version bit mask
1936 * 7 6 5 4 3 2 1 0 7 6 5 4 3 2 1 0
1937 * T L x x S x O P x x x x V V V V
1941 .flags_version = RTE_BE16(0xcb0f),
1949 * @b EXPERIMENTAL: this structure may change without prior notice
1951 * RTE_FLOW_ITEM_TYPE_PPP
1953 * Matches PPP Header
1955 struct rte_flow_item_ppp {
1956 struct rte_ppp_hdr hdr;
1959 /** Default mask for RTE_FLOW_ITEM_TYPE_PPP. */
1961 static const struct rte_flow_item_ppp rte_flow_item_ppp_mask = {
1965 .proto_id = RTE_BE16(0xffff),
1971 * Matching pattern item definition.
1973 * A pattern is formed by stacking items starting from the lowest protocol
1974 * layer to match. This stacking restriction does not apply to meta items
1975 * which can be placed anywhere in the stack without affecting the meaning
1976 * of the resulting pattern.
1978 * Patterns are terminated by END items.
1980 * The spec field should be a valid pointer to a structure of the related
1981 * item type. It may remain unspecified (NULL) in many cases to request
1982 * broad (nonspecific) matching. In such cases, last and mask must also be
1985 * Optionally, last can point to a structure of the same type to define an
1986 * inclusive range. This is mostly supported by integer and address fields,
1987 * may cause errors otherwise. Fields that do not support ranges must be set
1988 * to 0 or to the same value as the corresponding fields in spec.
1990 * Only the fields defined to nonzero values in the default masks (see
1991 * rte_flow_item_{name}_mask constants) are considered relevant by
1992 * default. This can be overridden by providing a mask structure of the
1993 * same type with applicable bits set to one. It can also be used to
1994 * partially filter out specific fields (e.g. as an alternate mean to match
1995 * ranges of IP addresses).
1997 * Mask is a simple bit-mask applied before interpreting the contents of
1998 * spec and last, which may yield unexpected results if not used
1999 * carefully. For example, if for an IPv4 address field, spec provides
2000 * 10.1.2.3, last provides 10.3.4.5 and mask provides 255.255.0.0, the
2001 * effective range becomes 10.1.0.0 to 10.3.255.255.
2003 struct rte_flow_item {
2004 enum rte_flow_item_type type; /**< Item type. */
2005 const void *spec; /**< Pointer to item specification structure. */
2006 const void *last; /**< Defines an inclusive range (spec to last). */
2007 const void *mask; /**< Bit-mask applied to spec and last. */
2012 * @b EXPERIMENTAL: this structure may change without prior notice
2014 * RTE_FLOW_ITEM_TYPE_FLEX
2016 * Matches a specified set of fields within the network protocol
2017 * header. Each field is presented as set of bits with specified width, and
2018 * bit offset from the header beginning.
2020 * The pattern is concatenation of bit fields configured at item creation
2021 * by rte_flow_flex_item_create(). At configuration the fields are presented
2022 * by sample_data array.
2024 * This type does not support ranges (struct rte_flow_item.last).
2026 struct rte_flow_item_flex {
2027 struct rte_flow_item_flex_handle *handle; /**< Opaque item handle. */
2028 uint32_t length; /**< Pattern length in bytes. */
2029 const uint8_t *pattern; /**< Combined bitfields pattern to match. */
2032 * Field bit offset calculation mode.
2034 enum rte_flow_item_flex_field_mode {
2036 * Dummy field, used for byte boundary alignment in pattern.
2037 * Pattern mask and data are ignored in the match. All configuration
2038 * parameters besides field size are ignored.
2040 FIELD_MODE_DUMMY = 0,
2042 * Fixed offset field. The bit offset from header beginning
2043 * is permanent and defined by field_base parameter.
2047 * The field bit offset is extracted from other header field (indirect
2048 * offset field). The resulting field offset to match is calculated as:
2050 * field_base + (*offset_base & offset_mask) << offset_shift
2054 * The field bit offset is extracted from other header field (indirect
2055 * offset field), the latter is considered as bitmask containing some
2056 * number of one bits, the resulting field offset to match is
2059 * field_base + bitcount(*offset_base & offset_mask) << offset_shift
2065 * Flex item field tunnel mode
2067 enum rte_flow_item_flex_tunnel_mode {
2069 * The protocol header can be present in the packet only once.
2070 * No multiple flex item flow inclusions (for inner/outer) are allowed.
2071 * No any relations with tunnel protocols are imposed. The drivers
2072 * can optimize hardware resource usage to handle match on single flex
2073 * item of specific type.
2075 FLEX_TUNNEL_MODE_SINGLE = 0,
2077 * Flex item presents outer header only.
2079 FLEX_TUNNEL_MODE_OUTER,
2081 * Flex item presents inner header only.
2083 FLEX_TUNNEL_MODE_INNER,
2085 * Flex item presents either inner or outer header. The driver
2086 * handles as many multiple inners as hardware supports.
2088 FLEX_TUNNEL_MODE_MULTI,
2090 * Flex item presents tunnel protocol header.
2092 FLEX_TUNNEL_MODE_TUNNEL,
2098 * @b EXPERIMENTAL: this structure may change without prior notice
2101 struct rte_flow_item_flex_field {
2102 /** Defines how match field offset is calculated over the packet. */
2103 enum rte_flow_item_flex_field_mode field_mode;
2104 uint32_t field_size; /**< Field size in bits. */
2105 int32_t field_base; /**< Field offset in bits. */
2106 uint32_t offset_base; /**< Indirect offset field offset in bits. */
2107 uint32_t offset_mask; /**< Indirect offset field bit mask. */
2108 int32_t offset_shift; /**< Indirect offset multiply factor. */
2109 uint32_t field_id:16; /**< Device hint, for multiple items in flow. */
2110 uint32_t reserved:16; /**< Reserved field. */
2115 * @b EXPERIMENTAL: this structure may change without prior notice
2117 struct rte_flow_item_flex_link {
2119 * Preceding/following header. The item type must be always provided.
2120 * For preceding one item must specify the header value/mask to match
2121 * for the link be taken and start the flex item header parsing.
2123 struct rte_flow_item item;
2125 * Next field value to match to continue with one of the configured
2133 * @b EXPERIMENTAL: this structure may change without prior notice
2135 struct rte_flow_item_flex_conf {
2137 * Specifies the flex item and tunnel relations and tells the PMD
2138 * whether flex item can be used for inner, outer or both headers,
2139 * or whether flex item presents the tunnel protocol itself.
2141 enum rte_flow_item_flex_tunnel_mode tunnel;
2143 * The next header offset, it presents the network header size covered
2144 * by the flex item and can be obtained with all supported offset
2145 * calculating methods (fixed, dedicated field, bitmask, etc).
2147 struct rte_flow_item_flex_field next_header;
2149 * Specifies the next protocol field to match with link next protocol
2150 * values and continue packet parsing with matching link.
2152 struct rte_flow_item_flex_field next_protocol;
2154 * The fields will be sampled and presented for explicit match
2155 * with pattern in the rte_flow_flex_item. There can be multiple
2156 * fields descriptors, the number should be specified by nb_samples.
2158 struct rte_flow_item_flex_field *sample_data;
2159 /** Number of field descriptors in the sample_data array. */
2160 uint32_t nb_samples;
2162 * Input link defines the flex item relation with preceding
2163 * header. It specified the preceding item type and provides pattern
2164 * to match. The flex item will continue parsing and will provide the
2165 * data to flow match in case if there is the match with one of input
2168 struct rte_flow_item_flex_link *input_link;
2169 /** Number of link descriptors in the input link array. */
2172 * Output link defines the next protocol field value to match and
2173 * the following protocol header to continue packet parsing. Also
2174 * defines the tunnel-related behaviour.
2176 struct rte_flow_item_flex_link *output_link;
2177 /** Number of link descriptors in the output link array. */
2178 uint32_t nb_outputs;
2184 * Each possible action is represented by a type.
2185 * An action can have an associated configuration object.
2186 * Several actions combined in a list can be assigned
2187 * to a flow rule and are performed in order.
2189 * They fall in three categories:
2191 * - Actions that modify the fate of matching traffic, for instance by
2192 * dropping or assigning it a specific destination.
2194 * - Actions that modify matching traffic contents or its properties. This
2195 * includes adding/removing encapsulation, encryption, compression and
2198 * - Actions related to the flow rule itself, such as updating counters or
2199 * making it non-terminating.
2201 * Flow rules being terminating by default, not specifying any action of the
2202 * fate kind results in undefined behavior. This applies to both ingress and
2205 * PASSTHRU, when supported, makes a flow rule non-terminating.
2207 enum rte_flow_action_type {
2209 * End marker for action lists. Prevents further processing of
2210 * actions, thereby ending the list.
2212 * No associated configuration structure.
2214 RTE_FLOW_ACTION_TYPE_END,
2217 * Used as a placeholder for convenience. It is ignored and simply
2218 * discarded by PMDs.
2220 * No associated configuration structure.
2222 RTE_FLOW_ACTION_TYPE_VOID,
2225 * Leaves traffic up for additional processing by subsequent flow
2226 * rules; makes a flow rule non-terminating.
2228 * No associated configuration structure.
2230 RTE_FLOW_ACTION_TYPE_PASSTHRU,
2233 * RTE_FLOW_ACTION_TYPE_JUMP
2235 * Redirects packets to a group on the current device.
2237 * See struct rte_flow_action_jump.
2239 RTE_FLOW_ACTION_TYPE_JUMP,
2242 * Attaches an integer value to packets and sets PKT_RX_FDIR and
2243 * PKT_RX_FDIR_ID mbuf flags.
2245 * See struct rte_flow_action_mark.
2247 * One should negotiate mark delivery from the NIC to the PMD.
2248 * @see rte_eth_rx_metadata_negotiate()
2249 * @see RTE_ETH_RX_METADATA_USER_MARK
2251 RTE_FLOW_ACTION_TYPE_MARK,
2254 * Flags packets. Similar to MARK without a specific value; only
2255 * sets the PKT_RX_FDIR mbuf flag.
2257 * No associated configuration structure.
2259 * One should negotiate flag delivery from the NIC to the PMD.
2260 * @see rte_eth_rx_metadata_negotiate()
2261 * @see RTE_ETH_RX_METADATA_USER_FLAG
2263 RTE_FLOW_ACTION_TYPE_FLAG,
2266 * Assigns packets to a given queue index.
2268 * See struct rte_flow_action_queue.
2270 RTE_FLOW_ACTION_TYPE_QUEUE,
2275 * PASSTHRU overrides this action if both are specified.
2277 * No associated configuration structure.
2279 RTE_FLOW_ACTION_TYPE_DROP,
2282 * Enables counters for this flow rule.
2284 * These counters can be retrieved and reset through rte_flow_query() or
2285 * rte_flow_action_handle_query() if the action provided via handle,
2286 * see struct rte_flow_query_count.
2288 * See struct rte_flow_action_count.
2290 RTE_FLOW_ACTION_TYPE_COUNT,
2293 * Similar to QUEUE, except RSS is additionally performed on packets
2294 * to spread them among several queues according to the provided
2297 * See struct rte_flow_action_rss.
2299 RTE_FLOW_ACTION_TYPE_RSS,
2303 * @see RTE_FLOW_ACTION_TYPE_PORT_REPRESENTOR
2304 * @see RTE_FLOW_ACTION_TYPE_REPRESENTED_PORT
2306 * Directs matching traffic to the physical function (PF) of the
2309 * No associated configuration structure.
2311 RTE_FLOW_ACTION_TYPE_PF,
2315 * @see RTE_FLOW_ACTION_TYPE_PORT_REPRESENTOR
2316 * @see RTE_FLOW_ACTION_TYPE_REPRESENTED_PORT
2318 * Directs matching traffic to a given virtual function of the
2321 * See struct rte_flow_action_vf.
2323 RTE_FLOW_ACTION_TYPE_VF,
2327 * @see RTE_FLOW_ACTION_TYPE_PORT_REPRESENTOR
2328 * @see RTE_FLOW_ACTION_TYPE_REPRESENTED_PORT
2330 * Directs packets to a given physical port index of the underlying
2333 * See struct rte_flow_action_phy_port.
2335 RTE_FLOW_ACTION_TYPE_PHY_PORT,
2339 * @see RTE_FLOW_ACTION_TYPE_PORT_REPRESENTOR
2340 * @see RTE_FLOW_ACTION_TYPE_REPRESENTED_PORT
2342 * Directs matching traffic to a given DPDK port ID.
2344 * See struct rte_flow_action_port_id.
2346 RTE_FLOW_ACTION_TYPE_PORT_ID,
2349 * Traffic metering and policing (MTR).
2351 * See struct rte_flow_action_meter.
2352 * See file rte_mtr.h for MTR object configuration.
2354 RTE_FLOW_ACTION_TYPE_METER,
2357 * Redirects packets to security engine of current device for security
2358 * processing as specified by security session.
2360 * See struct rte_flow_action_security.
2362 RTE_FLOW_ACTION_TYPE_SECURITY,
2365 * Implements OFPAT_SET_MPLS_TTL ("MPLS TTL") as defined by the
2366 * OpenFlow Switch Specification.
2368 * See struct rte_flow_action_of_set_mpls_ttl.
2370 RTE_FLOW_ACTION_TYPE_OF_SET_MPLS_TTL,
2373 * Implements OFPAT_DEC_MPLS_TTL ("decrement MPLS TTL") as defined
2374 * by the OpenFlow Switch Specification.
2376 * No associated configuration structure.
2378 RTE_FLOW_ACTION_TYPE_OF_DEC_MPLS_TTL,
2381 * Implements OFPAT_SET_NW_TTL ("IP TTL") as defined by the OpenFlow
2382 * Switch Specification.
2384 * See struct rte_flow_action_of_set_nw_ttl.
2386 RTE_FLOW_ACTION_TYPE_OF_SET_NW_TTL,
2389 * Implements OFPAT_DEC_NW_TTL ("decrement IP TTL") as defined by
2390 * the OpenFlow Switch Specification.
2392 * No associated configuration structure.
2394 RTE_FLOW_ACTION_TYPE_OF_DEC_NW_TTL,
2397 * Implements OFPAT_COPY_TTL_OUT ("copy TTL "outwards" -- from
2398 * next-to-outermost to outermost") as defined by the OpenFlow
2399 * Switch Specification.
2401 * No associated configuration structure.
2403 RTE_FLOW_ACTION_TYPE_OF_COPY_TTL_OUT,
2406 * Implements OFPAT_COPY_TTL_IN ("copy TTL "inwards" -- from
2407 * outermost to next-to-outermost") as defined by the OpenFlow
2408 * Switch Specification.
2410 * No associated configuration structure.
2412 RTE_FLOW_ACTION_TYPE_OF_COPY_TTL_IN,
2415 * Implements OFPAT_POP_VLAN ("pop the outer VLAN tag") as defined
2416 * by the OpenFlow Switch Specification.
2418 * No associated configuration structure.
2420 RTE_FLOW_ACTION_TYPE_OF_POP_VLAN,
2423 * Implements OFPAT_PUSH_VLAN ("push a new VLAN tag") as defined by
2424 * the OpenFlow Switch Specification.
2426 * See struct rte_flow_action_of_push_vlan.
2428 RTE_FLOW_ACTION_TYPE_OF_PUSH_VLAN,
2431 * Implements OFPAT_SET_VLAN_VID ("set the 802.1q VLAN ID") as
2432 * defined by the OpenFlow Switch Specification.
2434 * See struct rte_flow_action_of_set_vlan_vid.
2436 RTE_FLOW_ACTION_TYPE_OF_SET_VLAN_VID,
2439 * Implements OFPAT_SET_LAN_PCP ("set the 802.1q priority") as
2440 * defined by the OpenFlow Switch Specification.
2442 * See struct rte_flow_action_of_set_vlan_pcp.
2444 RTE_FLOW_ACTION_TYPE_OF_SET_VLAN_PCP,
2447 * Implements OFPAT_POP_MPLS ("pop the outer MPLS tag") as defined
2448 * by the OpenFlow Switch Specification.
2450 * See struct rte_flow_action_of_pop_mpls.
2452 RTE_FLOW_ACTION_TYPE_OF_POP_MPLS,
2455 * Implements OFPAT_PUSH_MPLS ("push a new MPLS tag") as defined by
2456 * the OpenFlow Switch Specification.
2458 * See struct rte_flow_action_of_push_mpls.
2460 RTE_FLOW_ACTION_TYPE_OF_PUSH_MPLS,
2463 * Encapsulate flow in VXLAN tunnel as defined in
2464 * rte_flow_action_vxlan_encap action structure.
2466 * See struct rte_flow_action_vxlan_encap.
2468 RTE_FLOW_ACTION_TYPE_VXLAN_ENCAP,
2471 * Decapsulate outer most VXLAN tunnel from matched flow.
2473 * If flow pattern does not define a valid VXLAN tunnel (as specified by
2474 * RFC7348) then the PMD should return a RTE_FLOW_ERROR_TYPE_ACTION
2477 RTE_FLOW_ACTION_TYPE_VXLAN_DECAP,
2480 * Encapsulate flow in NVGRE tunnel defined in the
2481 * rte_flow_action_nvgre_encap action structure.
2483 * See struct rte_flow_action_nvgre_encap.
2485 RTE_FLOW_ACTION_TYPE_NVGRE_ENCAP,
2488 * Decapsulate outer most NVGRE tunnel from matched flow.
2490 * If flow pattern does not define a valid NVGRE tunnel (as specified by
2491 * RFC7637) then the PMD should return a RTE_FLOW_ERROR_TYPE_ACTION
2494 RTE_FLOW_ACTION_TYPE_NVGRE_DECAP,
2497 * Add outer header whose template is provided in its data buffer
2499 * See struct rte_flow_action_raw_encap.
2501 RTE_FLOW_ACTION_TYPE_RAW_ENCAP,
2504 * Remove outer header whose template is provided in its data buffer.
2506 * See struct rte_flow_action_raw_decap
2508 RTE_FLOW_ACTION_TYPE_RAW_DECAP,
2511 * Modify IPv4 source address in the outermost IPv4 header.
2513 * If flow pattern does not define a valid RTE_FLOW_ITEM_TYPE_IPV4,
2514 * then the PMD should return a RTE_FLOW_ERROR_TYPE_ACTION error.
2516 * See struct rte_flow_action_set_ipv4.
2518 RTE_FLOW_ACTION_TYPE_SET_IPV4_SRC,
2521 * Modify IPv4 destination address in the outermost IPv4 header.
2523 * If flow pattern does not define a valid RTE_FLOW_ITEM_TYPE_IPV4,
2524 * then the PMD should return a RTE_FLOW_ERROR_TYPE_ACTION error.
2526 * See struct rte_flow_action_set_ipv4.
2528 RTE_FLOW_ACTION_TYPE_SET_IPV4_DST,
2531 * Modify IPv6 source address in the outermost IPv6 header.
2533 * If flow pattern does not define a valid RTE_FLOW_ITEM_TYPE_IPV6,
2534 * then the PMD should return a RTE_FLOW_ERROR_TYPE_ACTION error.
2536 * See struct rte_flow_action_set_ipv6.
2538 RTE_FLOW_ACTION_TYPE_SET_IPV6_SRC,
2541 * Modify IPv6 destination address in the outermost IPv6 header.
2543 * If flow pattern does not define a valid RTE_FLOW_ITEM_TYPE_IPV6,
2544 * then the PMD should return a RTE_FLOW_ERROR_TYPE_ACTION error.
2546 * See struct rte_flow_action_set_ipv6.
2548 RTE_FLOW_ACTION_TYPE_SET_IPV6_DST,
2551 * Modify source port number in the outermost TCP/UDP header.
2553 * If flow pattern does not define a valid RTE_FLOW_ITEM_TYPE_TCP
2554 * or RTE_FLOW_ITEM_TYPE_UDP, then the PMD should return a
2555 * RTE_FLOW_ERROR_TYPE_ACTION error.
2557 * See struct rte_flow_action_set_tp.
2559 RTE_FLOW_ACTION_TYPE_SET_TP_SRC,
2562 * Modify destination port number in the outermost TCP/UDP header.
2564 * If flow pattern does not define a valid RTE_FLOW_ITEM_TYPE_TCP
2565 * or RTE_FLOW_ITEM_TYPE_UDP, then the PMD should return a
2566 * RTE_FLOW_ERROR_TYPE_ACTION error.
2568 * See struct rte_flow_action_set_tp.
2570 RTE_FLOW_ACTION_TYPE_SET_TP_DST,
2573 * Swap the source and destination MAC addresses in the outermost
2576 * If flow pattern does not define a valid RTE_FLOW_ITEM_TYPE_ETH,
2577 * then the PMD should return a RTE_FLOW_ERROR_TYPE_ACTION error.
2579 * No associated configuration structure.
2581 RTE_FLOW_ACTION_TYPE_MAC_SWAP,
2584 * Decrease TTL value directly
2586 * No associated configuration structure.
2588 RTE_FLOW_ACTION_TYPE_DEC_TTL,
2593 * See struct rte_flow_action_set_ttl
2595 RTE_FLOW_ACTION_TYPE_SET_TTL,
2598 * Set source MAC address from matched flow.
2600 * If flow pattern does not define a valid RTE_FLOW_ITEM_TYPE_ETH,
2601 * the PMD should return a RTE_FLOW_ERROR_TYPE_ACTION error.
2603 * See struct rte_flow_action_set_mac.
2605 RTE_FLOW_ACTION_TYPE_SET_MAC_SRC,
2608 * Set destination MAC address from matched flow.
2610 * If flow pattern does not define a valid RTE_FLOW_ITEM_TYPE_ETH,
2611 * the PMD should return a RTE_FLOW_ERROR_TYPE_ACTION error.
2613 * See struct rte_flow_action_set_mac.
2615 RTE_FLOW_ACTION_TYPE_SET_MAC_DST,
2618 * Increase sequence number in the outermost TCP header.
2620 * Action configuration specifies the value to increase
2621 * TCP sequence number as a big-endian 32 bit integer.
2624 * @code rte_be32_t * @endcode
2626 * Using this action on non-matching traffic will result in
2627 * undefined behavior.
2629 RTE_FLOW_ACTION_TYPE_INC_TCP_SEQ,
2632 * Decrease sequence number in the outermost TCP header.
2634 * Action configuration specifies the value to decrease
2635 * TCP sequence number as a big-endian 32 bit integer.
2638 * @code rte_be32_t * @endcode
2640 * Using this action on non-matching traffic will result in
2641 * undefined behavior.
2643 RTE_FLOW_ACTION_TYPE_DEC_TCP_SEQ,
2646 * Increase acknowledgment number in the outermost TCP header.
2648 * Action configuration specifies the value to increase
2649 * TCP acknowledgment number as a big-endian 32 bit integer.
2652 * @code rte_be32_t * @endcode
2654 * Using this action on non-matching traffic will result in
2655 * undefined behavior.
2657 RTE_FLOW_ACTION_TYPE_INC_TCP_ACK,
2660 * Decrease acknowledgment number in the outermost TCP header.
2662 * Action configuration specifies the value to decrease
2663 * TCP acknowledgment number as a big-endian 32 bit integer.
2666 * @code rte_be32_t * @endcode
2668 * Using this action on non-matching traffic will result in
2669 * undefined behavior.
2671 RTE_FLOW_ACTION_TYPE_DEC_TCP_ACK,
2676 * Tag is for internal flow usage only and
2677 * is not delivered to the application.
2679 * See struct rte_flow_action_set_tag.
2681 RTE_FLOW_ACTION_TYPE_SET_TAG,
2684 * Set metadata on ingress or egress path.
2686 * See struct rte_flow_action_set_meta.
2688 RTE_FLOW_ACTION_TYPE_SET_META,
2691 * Modify IPv4 DSCP in the outermost IP header.
2693 * If flow pattern does not define a valid RTE_FLOW_ITEM_TYPE_IPV4,
2694 * then the PMD should return a RTE_FLOW_ERROR_TYPE_ACTION error.
2696 * See struct rte_flow_action_set_dscp.
2698 RTE_FLOW_ACTION_TYPE_SET_IPV4_DSCP,
2701 * Modify IPv6 DSCP in the outermost IP header.
2703 * If flow pattern does not define a valid RTE_FLOW_ITEM_TYPE_IPV6,
2704 * then the PMD should return a RTE_FLOW_ERROR_TYPE_ACTION error.
2706 * See struct rte_flow_action_set_dscp.
2708 RTE_FLOW_ACTION_TYPE_SET_IPV6_DSCP,
2711 * Report as aged flow if timeout passed without any matching on the
2714 * See struct rte_flow_action_age.
2715 * See function rte_flow_get_aged_flows
2716 * see enum RTE_ETH_EVENT_FLOW_AGED
2717 * See struct rte_flow_query_age
2719 RTE_FLOW_ACTION_TYPE_AGE,
2722 * The matching packets will be duplicated with specified ratio and
2723 * applied with own set of actions with a fate action.
2725 * See struct rte_flow_action_sample.
2727 RTE_FLOW_ACTION_TYPE_SAMPLE,
2731 * @see RTE_FLOW_ACTION_TYPE_INDIRECT
2733 * Describe action shared across multiple flow rules.
2735 * Allow multiple rules reference the same action by handle (see
2736 * struct rte_flow_shared_action).
2738 RTE_FLOW_ACTION_TYPE_SHARED,
2741 * Modify a packet header field, tag, mark or metadata.
2743 * Allow the modification of an arbitrary header field via
2744 * set, add and sub operations or copying its content into
2745 * tag, meta or mark for future processing.
2747 * See struct rte_flow_action_modify_field.
2749 RTE_FLOW_ACTION_TYPE_MODIFY_FIELD,
2752 * An action handle is referenced in a rule through an indirect action.
2754 * The same action handle may be used in multiple rules for the same
2755 * or different ethdev ports.
2757 RTE_FLOW_ACTION_TYPE_INDIRECT,
2762 * Enable tracking a TCP connection state.
2764 * @see struct rte_flow_action_conntrack.
2766 RTE_FLOW_ACTION_TYPE_CONNTRACK,
2769 * Color the packet to reflect the meter color result.
2770 * Set the meter color in the mbuf to the selected color.
2772 * See struct rte_flow_action_meter_color.
2774 RTE_FLOW_ACTION_TYPE_METER_COLOR,
2777 * At embedded switch level, sends matching traffic to the given ethdev.
2779 * @see struct rte_flow_action_ethdev
2781 RTE_FLOW_ACTION_TYPE_PORT_REPRESENTOR,
2784 * At embedded switch level, send matching traffic to
2785 * the entity represented by the given ethdev.
2787 * @see struct rte_flow_action_ethdev
2789 RTE_FLOW_ACTION_TYPE_REPRESENTED_PORT,
2793 * RTE_FLOW_ACTION_TYPE_MARK
2795 * Attaches an integer value to packets and sets PKT_RX_FDIR and
2796 * PKT_RX_FDIR_ID mbuf flags.
2798 * This value is arbitrary and application-defined. Maximum allowed value
2799 * depends on the underlying implementation. It is returned in the
2800 * hash.fdir.hi mbuf field.
2802 struct rte_flow_action_mark {
2803 uint32_t id; /**< Integer value to return with packets. */
2808 * @b EXPERIMENTAL: this structure may change without prior notice
2810 * RTE_FLOW_ACTION_TYPE_JUMP
2812 * Redirects packets to a group on the current device.
2814 * In a hierarchy of groups, which can be used to represent physical or logical
2815 * flow tables on the device, this action allows the action to be a redirect to
2816 * a group on that device.
2818 struct rte_flow_action_jump {
2823 * RTE_FLOW_ACTION_TYPE_QUEUE
2825 * Assign packets to a given queue index.
2827 struct rte_flow_action_queue {
2828 uint16_t index; /**< Queue index to use. */
2833 * @b EXPERIMENTAL: this structure may change without prior notice
2835 * RTE_FLOW_ACTION_TYPE_AGE
2837 * Report flow as aged-out if timeout passed without any matching
2838 * on the flow. RTE_ETH_EVENT_FLOW_AGED event is triggered when a
2839 * port detects new aged-out flows.
2841 * The flow context and the flow handle will be reported by the
2842 * rte_flow_get_aged_flows API.
2844 struct rte_flow_action_age {
2845 uint32_t timeout:24; /**< Time in seconds. */
2846 uint32_t reserved:8; /**< Reserved, must be zero. */
2847 /** The user flow context, NULL means the rte_flow pointer. */
2852 * RTE_FLOW_ACTION_TYPE_AGE (query)
2854 * Query structure to retrieve the aging status information of a
2855 * shared AGE action, or a flow rule using the AGE action.
2857 struct rte_flow_query_age {
2858 uint32_t reserved:6; /**< Reserved, must be zero. */
2859 uint32_t aged:1; /**< 1 if aging timeout expired, 0 otherwise. */
2860 /** sec_since_last_hit value is valid. */
2861 uint32_t sec_since_last_hit_valid:1;
2862 uint32_t sec_since_last_hit:24; /**< Seconds since last traffic hit. */
2867 * @b EXPERIMENTAL: this structure may change without prior notice
2869 * RTE_FLOW_ACTION_TYPE_COUNT
2871 * Adds a counter action to a matched flow.
2873 * If more than one count action is specified in a single flow rule, then each
2874 * action must specify a unique ID.
2876 * Counters can be retrieved and reset through ``rte_flow_query()``, see
2877 * ``struct rte_flow_query_count``.
2879 * For ports within the same switch domain then the counter ID namespace extends
2880 * to all ports within that switch domain.
2882 struct rte_flow_action_count {
2883 uint32_t id; /**< Counter ID. */
2887 * RTE_FLOW_ACTION_TYPE_COUNT (query)
2889 * Query structure to retrieve and reset flow rule counters.
2891 struct rte_flow_query_count {
2892 uint32_t reset:1; /**< Reset counters after query [in]. */
2893 uint32_t hits_set:1; /**< hits field is set [out]. */
2894 uint32_t bytes_set:1; /**< bytes field is set [out]. */
2895 uint32_t reserved:29; /**< Reserved, must be zero [in, out]. */
2896 uint64_t hits; /**< Number of hits for this rule [out]. */
2897 uint64_t bytes; /**< Number of bytes through this rule [out]. */
2901 * Hash function types.
2903 enum rte_eth_hash_function {
2904 RTE_ETH_HASH_FUNCTION_DEFAULT = 0,
2905 RTE_ETH_HASH_FUNCTION_TOEPLITZ, /**< Toeplitz */
2906 RTE_ETH_HASH_FUNCTION_SIMPLE_XOR, /**< Simple XOR */
2908 * Symmetric Toeplitz: src, dst will be replaced by
2909 * xor(src, dst). For the case with src/dst only,
2910 * src or dst address will xor with zero pair.
2912 RTE_ETH_HASH_FUNCTION_SYMMETRIC_TOEPLITZ,
2913 RTE_ETH_HASH_FUNCTION_MAX,
2917 * RTE_FLOW_ACTION_TYPE_RSS
2919 * Similar to QUEUE, except RSS is additionally performed on packets to
2920 * spread them among several queues according to the provided parameters.
2922 * Unlike global RSS settings used by other DPDK APIs, unsetting the
2923 * @p types field does not disable RSS in a flow rule. Doing so instead
2924 * requests safe unspecified "best-effort" settings from the underlying PMD,
2925 * which depending on the flow rule, may result in anything ranging from
2926 * empty (single queue) to all-inclusive RSS.
2928 * Note: RSS hash result is stored in the hash.rss mbuf field which overlaps
2929 * hash.fdir.lo. Since the MARK action sets the hash.fdir.hi field only,
2930 * both can be requested simultaneously.
2932 struct rte_flow_action_rss {
2933 enum rte_eth_hash_function func; /**< RSS hash function to apply. */
2935 * Packet encapsulation level RSS hash @p types apply to.
2937 * - @p 0 requests the default behavior. Depending on the packet
2938 * type, it can mean outermost, innermost, anything in between or
2941 * It basically stands for the innermost encapsulation level RSS
2942 * can be performed on according to PMD and device capabilities.
2944 * - @p 1 requests RSS to be performed on the outermost packet
2945 * encapsulation level.
2947 * - @p 2 and subsequent values request RSS to be performed on the
2948 * specified inner packet encapsulation level, from outermost to
2949 * innermost (lower to higher values).
2951 * Values other than @p 0 are not necessarily supported.
2953 * Requesting a specific RSS level on unrecognized traffic results
2954 * in undefined behavior. For predictable results, it is recommended
2955 * to make the flow rule pattern match packet headers up to the
2956 * requested encapsulation level so that only matching traffic goes
2960 uint64_t types; /**< Specific RSS hash types (see ETH_RSS_*). */
2961 uint32_t key_len; /**< Hash key length in bytes. */
2962 uint32_t queue_num; /**< Number of entries in @p queue. */
2963 const uint8_t *key; /**< Hash key. */
2964 const uint16_t *queue; /**< Queue indices to use. */
2969 * @see RTE_FLOW_ACTION_TYPE_PORT_REPRESENTOR
2970 * @see RTE_FLOW_ACTION_TYPE_REPRESENTED_PORT
2972 * RTE_FLOW_ACTION_TYPE_VF
2974 * Directs matching traffic to a given virtual function of the current
2977 * Packets matched by a VF pattern item can be redirected to their original
2978 * VF ID instead of the specified one. This parameter may not be available
2979 * and is not guaranteed to work properly if the VF part is matched by a
2980 * prior flow rule or if packets are not addressed to a VF in the first
2983 struct rte_flow_action_vf {
2984 uint32_t original:1; /**< Use original VF ID if possible. */
2985 uint32_t reserved:31; /**< Reserved, must be zero. */
2986 uint32_t id; /**< VF ID. */
2991 * @see RTE_FLOW_ACTION_TYPE_PORT_REPRESENTOR
2992 * @see RTE_FLOW_ACTION_TYPE_REPRESENTED_PORT
2994 * RTE_FLOW_ACTION_TYPE_PHY_PORT
2996 * Directs packets to a given physical port index of the underlying
2999 * @see RTE_FLOW_ITEM_TYPE_PHY_PORT
3001 struct rte_flow_action_phy_port {
3002 uint32_t original:1; /**< Use original port index if possible. */
3003 uint32_t reserved:31; /**< Reserved, must be zero. */
3004 uint32_t index; /**< Physical port index. */
3009 * @see RTE_FLOW_ACTION_TYPE_PORT_REPRESENTOR
3010 * @see RTE_FLOW_ACTION_TYPE_REPRESENTED_PORT
3012 * RTE_FLOW_ACTION_TYPE_PORT_ID
3014 * Directs matching traffic to a given DPDK port ID.
3016 * @see RTE_FLOW_ITEM_TYPE_PORT_ID
3018 struct rte_flow_action_port_id {
3019 uint32_t original:1; /**< Use original DPDK port ID if possible. */
3020 uint32_t reserved:31; /**< Reserved, must be zero. */
3021 uint32_t id; /**< DPDK port ID. */
3025 * RTE_FLOW_ACTION_TYPE_METER
3027 * Traffic metering and policing (MTR).
3029 * Packets matched by items of this type can be either dropped or passed to the
3030 * next item with their color set by the MTR object.
3032 struct rte_flow_action_meter {
3033 uint32_t mtr_id; /**< MTR object ID created with rte_mtr_create(). */
3037 * RTE_FLOW_ACTION_TYPE_SECURITY
3039 * Perform the security action on flows matched by the pattern items
3040 * according to the configuration of the security session.
3042 * This action modifies the payload of matched flows. For INLINE_CRYPTO, the
3043 * security protocol headers and IV are fully provided by the application as
3044 * specified in the flow pattern. The payload of matching packets is
3045 * encrypted on egress, and decrypted and authenticated on ingress.
3046 * For INLINE_PROTOCOL, the security protocol is fully offloaded to HW,
3047 * providing full encapsulation and decapsulation of packets in security
3048 * protocols. The flow pattern specifies both the outer security header fields
3049 * and the inner packet fields. The security session specified in the action
3050 * must match the pattern parameters.
3052 * The security session specified in the action must be created on the same
3053 * port as the flow action that is being specified.
3055 * The ingress/egress flow attribute should match that specified in the
3056 * security session if the security session supports the definition of the
3059 * Multiple flows can be configured to use the same security session.
3061 * The NULL value is allowed for security session. If security session is NULL,
3062 * then SPI field in ESP flow item and IP addresses in flow items 'IPv4' and
3063 * 'IPv6' will be allowed to be a range. The rule thus created can enable
3064 * security processing on multiple flows.
3066 struct rte_flow_action_security {
3067 void *security_session; /**< Pointer to security session structure. */
3071 * RTE_FLOW_ACTION_TYPE_OF_SET_MPLS_TTL
3073 * Implements OFPAT_SET_MPLS_TTL ("MPLS TTL") as defined by the OpenFlow
3074 * Switch Specification.
3076 struct rte_flow_action_of_set_mpls_ttl {
3077 uint8_t mpls_ttl; /**< MPLS TTL. */
3081 * RTE_FLOW_ACTION_TYPE_OF_SET_NW_TTL
3083 * Implements OFPAT_SET_NW_TTL ("IP TTL") as defined by the OpenFlow Switch
3086 struct rte_flow_action_of_set_nw_ttl {
3087 uint8_t nw_ttl; /**< IP TTL. */
3091 * RTE_FLOW_ACTION_TYPE_OF_PUSH_VLAN
3093 * Implements OFPAT_PUSH_VLAN ("push a new VLAN tag") as defined by the
3094 * OpenFlow Switch Specification.
3096 struct rte_flow_action_of_push_vlan {
3097 rte_be16_t ethertype; /**< EtherType. */
3101 * RTE_FLOW_ACTION_TYPE_OF_SET_VLAN_VID
3103 * Implements OFPAT_SET_VLAN_VID ("set the 802.1q VLAN ID") as defined by
3104 * the OpenFlow Switch Specification.
3106 struct rte_flow_action_of_set_vlan_vid {
3107 rte_be16_t vlan_vid; /**< VLAN ID. */
3111 * RTE_FLOW_ACTION_TYPE_OF_SET_VLAN_PCP
3113 * Implements OFPAT_SET_LAN_PCP ("set the 802.1q priority") as defined by
3114 * the OpenFlow Switch Specification.
3116 struct rte_flow_action_of_set_vlan_pcp {
3117 uint8_t vlan_pcp; /**< VLAN priority. */
3121 * RTE_FLOW_ACTION_TYPE_OF_POP_MPLS
3123 * Implements OFPAT_POP_MPLS ("pop the outer MPLS tag") as defined by the
3124 * OpenFlow Switch Specification.
3126 struct rte_flow_action_of_pop_mpls {
3127 rte_be16_t ethertype; /**< EtherType. */
3131 * RTE_FLOW_ACTION_TYPE_OF_PUSH_MPLS
3133 * Implements OFPAT_PUSH_MPLS ("push a new MPLS tag") as defined by the
3134 * OpenFlow Switch Specification.
3136 struct rte_flow_action_of_push_mpls {
3137 rte_be16_t ethertype; /**< EtherType. */
3142 * @b EXPERIMENTAL: this structure may change without prior notice
3144 * RTE_FLOW_ACTION_TYPE_VXLAN_ENCAP
3146 * VXLAN tunnel end-point encapsulation data definition
3148 * The tunnel definition is provided through the flow item pattern, the
3149 * provided pattern must conform to RFC7348 for the tunnel specified. The flow
3150 * definition must be provided in order from the RTE_FLOW_ITEM_TYPE_ETH
3151 * definition up the end item which is specified by RTE_FLOW_ITEM_TYPE_END.
3153 * The mask field allows user to specify which fields in the flow item
3154 * definitions can be ignored and which have valid data and can be used
3157 * Note: the last field is not used in the definition of a tunnel and can be
3160 * Valid flow definition for RTE_FLOW_ACTION_TYPE_VXLAN_ENCAP include:
3162 * - ETH / IPV4 / UDP / VXLAN / END
3163 * - ETH / IPV6 / UDP / VXLAN / END
3164 * - ETH / VLAN / IPV4 / UDP / VXLAN / END
3167 struct rte_flow_action_vxlan_encap {
3169 * Encapsulating vxlan tunnel definition
3170 * (terminated by the END pattern item).
3172 struct rte_flow_item *definition;
3177 * @b EXPERIMENTAL: this structure may change without prior notice
3179 * RTE_FLOW_ACTION_TYPE_NVGRE_ENCAP
3181 * NVGRE tunnel end-point encapsulation data definition
3183 * The tunnel definition is provided through the flow item pattern the
3184 * provided pattern must conform with RFC7637. The flow definition must be
3185 * provided in order from the RTE_FLOW_ITEM_TYPE_ETH definition up the end item
3186 * which is specified by RTE_FLOW_ITEM_TYPE_END.
3188 * The mask field allows user to specify which fields in the flow item
3189 * definitions can be ignored and which have valid data and can be used
3192 * Note: the last field is not used in the definition of a tunnel and can be
3195 * Valid flow definition for RTE_FLOW_ACTION_TYPE_NVGRE_ENCAP include:
3197 * - ETH / IPV4 / NVGRE / END
3198 * - ETH / VLAN / IPV6 / NVGRE / END
3201 struct rte_flow_action_nvgre_encap {
3203 * Encapsulating vxlan tunnel definition
3204 * (terminated by the END pattern item).
3206 struct rte_flow_item *definition;
3211 * @b EXPERIMENTAL: this structure may change without prior notice
3213 * RTE_FLOW_ACTION_TYPE_RAW_ENCAP
3215 * Raw tunnel end-point encapsulation data definition.
3217 * The data holds the headers definitions to be applied on the packet.
3218 * The data must start with ETH header up to the tunnel item header itself.
3219 * When used right after RAW_DECAP (for decapsulating L3 tunnel type for
3220 * example MPLSoGRE) the data will just hold layer 2 header.
3222 * The preserve parameter holds which bits in the packet the PMD is not allowed
3223 * to change, this parameter can also be NULL and then the PMD is allowed
3224 * to update any field.
3226 * size holds the number of bytes in @p data and @p preserve.
3228 struct rte_flow_action_raw_encap {
3229 uint8_t *data; /**< Encapsulation data. */
3230 uint8_t *preserve; /**< Bit-mask of @p data to preserve on output. */
3231 size_t size; /**< Size of @p data and @p preserve. */
3236 * @b EXPERIMENTAL: this structure may change without prior notice
3238 * RTE_FLOW_ACTION_TYPE_RAW_DECAP
3240 * Raw tunnel end-point decapsulation data definition.
3242 * The data holds the headers definitions to be removed from the packet.
3243 * The data must start with ETH header up to the tunnel item header itself.
3244 * When used right before RAW_DECAP (for encapsulating L3 tunnel type for
3245 * example MPLSoGRE) the data will just hold layer 2 header.
3247 * size holds the number of bytes in @p data.
3249 struct rte_flow_action_raw_decap {
3250 uint8_t *data; /**< Encapsulation data. */
3251 size_t size; /**< Size of @p data and @p preserve. */
3256 * @b EXPERIMENTAL: this structure may change without prior notice
3258 * RTE_FLOW_ACTION_TYPE_SET_IPV4_SRC
3259 * RTE_FLOW_ACTION_TYPE_SET_IPV4_DST
3261 * Allows modification of IPv4 source (RTE_FLOW_ACTION_TYPE_SET_IPV4_SRC)
3262 * and destination address (RTE_FLOW_ACTION_TYPE_SET_IPV4_DST) in the
3263 * specified outermost IPv4 header.
3265 struct rte_flow_action_set_ipv4 {
3266 rte_be32_t ipv4_addr;
3271 * @b EXPERIMENTAL: this structure may change without prior notice
3273 * RTE_FLOW_ACTION_TYPE_SET_IPV6_SRC
3274 * RTE_FLOW_ACTION_TYPE_SET_IPV6_DST
3276 * Allows modification of IPv6 source (RTE_FLOW_ACTION_TYPE_SET_IPV6_SRC)
3277 * and destination address (RTE_FLOW_ACTION_TYPE_SET_IPV6_DST) in the
3278 * specified outermost IPv6 header.
3280 struct rte_flow_action_set_ipv6 {
3281 uint8_t ipv6_addr[16];
3286 * @b EXPERIMENTAL: this structure may change without prior notice
3288 * RTE_FLOW_ACTION_TYPE_SET_TP_SRC
3289 * RTE_FLOW_ACTION_TYPE_SET_TP_DST
3291 * Allows modification of source (RTE_FLOW_ACTION_TYPE_SET_TP_SRC)
3292 * and destination (RTE_FLOW_ACTION_TYPE_SET_TP_DST) port numbers
3293 * in the specified outermost TCP/UDP header.
3295 struct rte_flow_action_set_tp {
3300 * RTE_FLOW_ACTION_TYPE_SET_TTL
3302 * Set the TTL value directly for IPv4 or IPv6
3304 struct rte_flow_action_set_ttl {
3309 * RTE_FLOW_ACTION_TYPE_SET_MAC
3311 * Set MAC address from the matched flow
3313 struct rte_flow_action_set_mac {
3314 uint8_t mac_addr[RTE_ETHER_ADDR_LEN];
3319 * @b EXPERIMENTAL: this structure may change without prior notice
3321 * RTE_FLOW_ACTION_TYPE_SET_TAG
3323 * Set a tag which is a transient data used during flow matching. This is not
3324 * delivered to application. Multiple tags are supported by specifying index.
3326 struct rte_flow_action_set_tag {
3334 * @b EXPERIMENTAL: this structure may change without prior notice
3336 * RTE_FLOW_ACTION_TYPE_SET_META
3338 * Set metadata. Metadata set by mbuf metadata dynamic field with
3339 * PKT_TX_DYNF_DATA flag on egress will be overridden by this action. On
3340 * ingress, the metadata will be carried by mbuf metadata dynamic field
3341 * with PKT_RX_DYNF_METADATA flag if set. The dynamic mbuf field must be
3342 * registered in advance by rte_flow_dynf_metadata_register().
3344 * Altering partial bits is supported with mask. For bits which have never
3345 * been set, unpredictable value will be seen depending on driver
3346 * implementation. For loopback/hairpin packet, metadata set on Rx/Tx may
3347 * or may not be propagated to the other path depending on HW capability.
3349 * RTE_FLOW_ITEM_TYPE_META matches metadata.
3351 struct rte_flow_action_set_meta {
3357 * RTE_FLOW_ACTION_TYPE_SET_IPV4_DSCP
3358 * RTE_FLOW_ACTION_TYPE_SET_IPV6_DSCP
3360 * Set the DSCP value for IPv4/IPv6 header.
3361 * DSCP in low 6 bits, rest ignored.
3363 struct rte_flow_action_set_dscp {
3369 * @b EXPERIMENTAL: this structure may change without prior notice
3371 * RTE_FLOW_ACTION_TYPE_INDIRECT
3373 * Opaque type returned after successfully creating an indirect action object.
3374 * The definition of the object handle is different per driver or
3375 * per direct action type.
3377 * This handle can be used to manage and query the related direct action:
3378 * - referenced in single flow rule or across multiple flow rules
3379 * over multiple ports
3380 * - update action object configuration
3381 * - query action object data
3382 * - destroy action object
3384 struct rte_flow_action_handle;
3387 * The state of a TCP connection.
3389 enum rte_flow_conntrack_state {
3390 /** SYN-ACK packet was seen. */
3391 RTE_FLOW_CONNTRACK_STATE_SYN_RECV,
3392 /** 3-way handshake was done. */
3393 RTE_FLOW_CONNTRACK_STATE_ESTABLISHED,
3394 /** First FIN packet was received to close the connection. */
3395 RTE_FLOW_CONNTRACK_STATE_FIN_WAIT,
3396 /** First FIN was ACKed. */
3397 RTE_FLOW_CONNTRACK_STATE_CLOSE_WAIT,
3398 /** Second FIN was received, waiting for the last ACK. */
3399 RTE_FLOW_CONNTRACK_STATE_LAST_ACK,
3400 /** Second FIN was ACKed, connection was closed. */
3401 RTE_FLOW_CONNTRACK_STATE_TIME_WAIT,
3405 * The last passed TCP packet flags of a connection.
3407 enum rte_flow_conntrack_tcp_last_index {
3408 RTE_FLOW_CONNTRACK_FLAG_NONE = 0, /**< No Flag. */
3409 RTE_FLOW_CONNTRACK_FLAG_SYN = RTE_BIT32(0), /**< With SYN flag. */
3410 RTE_FLOW_CONNTRACK_FLAG_SYNACK = RTE_BIT32(1), /**< With SYNACK flag. */
3411 RTE_FLOW_CONNTRACK_FLAG_FIN = RTE_BIT32(2), /**< With FIN flag. */
3412 RTE_FLOW_CONNTRACK_FLAG_ACK = RTE_BIT32(3), /**< With ACK flag. */
3413 RTE_FLOW_CONNTRACK_FLAG_RST = RTE_BIT32(4), /**< With RST flag. */
3418 * @b EXPERIMENTAL: this structure may change without prior notice
3420 * Configuration parameters for each direction of a TCP connection.
3421 * All fields should be in host byte order.
3422 * If needed, driver should convert all fields to network byte order
3423 * if HW needs them in that way.
3425 struct rte_flow_tcp_dir_param {
3426 /** TCP window scaling factor, 0xF to disable. */
3428 /** The FIN was sent by this direction. */
3429 uint32_t close_initiated:1;
3430 /** An ACK packet has been received by this side. */
3431 uint32_t last_ack_seen:1;
3433 * If set, it indicates that there is unacknowledged data for the
3434 * packets sent from this direction.
3436 uint32_t data_unacked:1;
3438 * Maximal value of sequence + payload length in sent
3439 * packets (next ACK from the opposite direction).
3443 * Maximal value of (ACK + window size) in received packet + length
3444 * over sent packet (maximal sequence could be sent).
3447 /** Maximal value of actual window size in sent packets. */
3449 /** Maximal value of ACK in sent packets. */
3455 * @b EXPERIMENTAL: this structure may change without prior notice
3457 * RTE_FLOW_ACTION_TYPE_CONNTRACK
3459 * Configuration and initial state for the connection tracking module.
3460 * This structure could be used for both setting and query.
3461 * All fields should be in host byte order.
3463 struct rte_flow_action_conntrack {
3464 /** The peer port number, can be the same port. */
3467 * Direction of this connection when creating a flow rule, the
3468 * value only affects the creation of subsequent flow rules.
3470 uint32_t is_original_dir:1;
3472 * Enable / disable the conntrack HW module. When disabled, the
3473 * result will always be RTE_FLOW_CONNTRACK_FLAG_DISABLED.
3474 * In this state the HW will act as passthrough.
3475 * It only affects this conntrack object in the HW without any effect
3476 * to the other objects.
3479 /** At least one ack was seen after the connection was established. */
3480 uint32_t live_connection:1;
3481 /** Enable selective ACK on this connection. */
3482 uint32_t selective_ack:1;
3483 /** A challenge ack has passed. */
3484 uint32_t challenge_ack_passed:1;
3486 * 1: The last packet is seen from the original direction.
3487 * 0: The last packet is seen from the reply direction.
3489 uint32_t last_direction:1;
3490 /** No TCP check will be done except the state change. */
3491 uint32_t liberal_mode:1;
3492 /** The current state of this connection. */
3493 enum rte_flow_conntrack_state state;
3494 /** Scaling factor for maximal allowed ACK window. */
3495 uint8_t max_ack_window;
3496 /** Maximal allowed number of retransmission times. */
3497 uint8_t retransmission_limit;
3498 /** TCP parameters of the original direction. */
3499 struct rte_flow_tcp_dir_param original_dir;
3500 /** TCP parameters of the reply direction. */
3501 struct rte_flow_tcp_dir_param reply_dir;
3502 /** The window value of the last packet passed this conntrack. */
3503 uint16_t last_window;
3504 enum rte_flow_conntrack_tcp_last_index last_index;
3505 /** The sequence of the last packet passed this conntrack. */
3507 /** The acknowledgment of the last packet passed this conntrack. */
3510 * The total value ACK + payload length of the last packet
3511 * passed this conntrack.
3517 * RTE_FLOW_ACTION_TYPE_CONNTRACK
3519 * Wrapper structure for the context update interface.
3520 * Ports cannot support updating, and the only valid solution is to
3521 * destroy the old context and create a new one instead.
3523 struct rte_flow_modify_conntrack {
3524 /** New connection tracking parameters to be updated. */
3525 struct rte_flow_action_conntrack new_ct;
3526 /** The direction field will be updated. */
3527 uint32_t direction:1;
3528 /** All the other fields except direction will be updated. */
3530 /** Reserved bits for the future usage. */
3531 uint32_t reserved:30;
3536 * @b EXPERIMENTAL: this structure may change without prior notice
3538 * RTE_FLOW_ACTION_TYPE_METER_COLOR
3540 * The meter color should be set in the packet meta-data
3541 * (i.e. struct rte_mbuf::sched::color).
3543 struct rte_flow_action_meter_color {
3544 enum rte_color color; /**< Packet color. */
3549 * @b EXPERIMENTAL: this structure may change without prior notice
3551 * Provides an ethdev port ID for use with the following actions:
3552 * RTE_FLOW_ACTION_TYPE_PORT_REPRESENTOR,
3553 * RTE_FLOW_ACTION_TYPE_REPRESENTED_PORT.
3555 struct rte_flow_action_ethdev {
3556 uint16_t port_id; /**< ethdev port ID */
3560 * Field IDs for MODIFY_FIELD action.
3562 enum rte_flow_field_id {
3563 RTE_FLOW_FIELD_START = 0, /**< Start of a packet. */
3564 RTE_FLOW_FIELD_MAC_DST, /**< Destination MAC Address. */
3565 RTE_FLOW_FIELD_MAC_SRC, /**< Source MAC Address. */
3566 RTE_FLOW_FIELD_VLAN_TYPE, /**< 802.1Q Tag Identifier. */
3567 RTE_FLOW_FIELD_VLAN_ID, /**< 802.1Q VLAN Identifier. */
3568 RTE_FLOW_FIELD_MAC_TYPE, /**< EtherType. */
3569 RTE_FLOW_FIELD_IPV4_DSCP, /**< IPv4 DSCP. */
3570 RTE_FLOW_FIELD_IPV4_TTL, /**< IPv4 Time To Live. */
3571 RTE_FLOW_FIELD_IPV4_SRC, /**< IPv4 Source Address. */
3572 RTE_FLOW_FIELD_IPV4_DST, /**< IPv4 Destination Address. */
3573 RTE_FLOW_FIELD_IPV6_DSCP, /**< IPv6 DSCP. */
3574 RTE_FLOW_FIELD_IPV6_HOPLIMIT, /**< IPv6 Hop Limit. */
3575 RTE_FLOW_FIELD_IPV6_SRC, /**< IPv6 Source Address. */
3576 RTE_FLOW_FIELD_IPV6_DST, /**< IPv6 Destination Address. */
3577 RTE_FLOW_FIELD_TCP_PORT_SRC, /**< TCP Source Port Number. */
3578 RTE_FLOW_FIELD_TCP_PORT_DST, /**< TCP Destination Port Number. */
3579 RTE_FLOW_FIELD_TCP_SEQ_NUM, /**< TCP Sequence Number. */
3580 RTE_FLOW_FIELD_TCP_ACK_NUM, /**< TCP Acknowledgment Number. */
3581 RTE_FLOW_FIELD_TCP_FLAGS, /**< TCP Flags. */
3582 RTE_FLOW_FIELD_UDP_PORT_SRC, /**< UDP Source Port Number. */
3583 RTE_FLOW_FIELD_UDP_PORT_DST, /**< UDP Destination Port Number. */
3584 RTE_FLOW_FIELD_VXLAN_VNI, /**< VXLAN Network Identifier. */
3585 RTE_FLOW_FIELD_GENEVE_VNI, /**< GENEVE Network Identifier. */
3586 RTE_FLOW_FIELD_GTP_TEID, /**< GTP Tunnel Endpoint Identifier. */
3587 RTE_FLOW_FIELD_TAG, /**< Tag value. */
3588 RTE_FLOW_FIELD_MARK, /**< Mark value. */
3589 RTE_FLOW_FIELD_META, /**< Metadata value. */
3590 RTE_FLOW_FIELD_POINTER, /**< Memory pointer. */
3591 RTE_FLOW_FIELD_VALUE, /**< Immediate value. */
3596 * @b EXPERIMENTAL: this structure may change without prior notice
3598 * Field description for MODIFY_FIELD action.
3600 struct rte_flow_action_modify_data {
3601 enum rte_flow_field_id field; /**< Field or memory type ID. */
3605 /** Encapsulation level or tag index. */
3607 /** Number of bits to skip from a field. */
3611 * Immediate value for RTE_FLOW_FIELD_VALUE, presented in the
3612 * same byte order and length as in relevant rte_flow_item_xxx.
3613 * The immediate source bitfield offset is inherited from
3614 * the destination's one.
3618 * Memory address for RTE_FLOW_FIELD_POINTER, memory layout
3619 * should be the same as for relevant field in the
3620 * rte_flow_item_xxx structure.
3627 * Operation types for MODIFY_FIELD action.
3629 enum rte_flow_modify_op {
3630 RTE_FLOW_MODIFY_SET = 0, /**< Set a new value. */
3631 RTE_FLOW_MODIFY_ADD, /**< Add a value to a field. */
3632 RTE_FLOW_MODIFY_SUB, /**< Subtract a value from a field. */
3637 * @b EXPERIMENTAL: this structure may change without prior notice
3639 * RTE_FLOW_ACTION_TYPE_MODIFY_FIELD
3641 * Modify a destination header field according to the specified
3642 * operation. Another field of the packet can be used as a source as well
3643 * as tag, mark, metadata, immediate value or a pointer to it.
3645 struct rte_flow_action_modify_field {
3646 enum rte_flow_modify_op operation; /**< Operation to perform. */
3647 struct rte_flow_action_modify_data dst; /**< Destination field. */
3648 struct rte_flow_action_modify_data src; /**< Source field. */
3649 uint32_t width; /**< Number of bits to use from a source field. */
3652 /* Mbuf dynamic field offset for metadata. */
3653 extern int32_t rte_flow_dynf_metadata_offs;
3655 /* Mbuf dynamic field flag mask for metadata. */
3656 extern uint64_t rte_flow_dynf_metadata_mask;
3658 /* Mbuf dynamic field pointer for metadata. */
3659 #define RTE_FLOW_DYNF_METADATA(m) \
3660 RTE_MBUF_DYNFIELD((m), rte_flow_dynf_metadata_offs, uint32_t *)
3662 /* Mbuf dynamic flags for metadata. */
3663 #define PKT_RX_DYNF_METADATA (rte_flow_dynf_metadata_mask)
3664 #define PKT_TX_DYNF_METADATA (rte_flow_dynf_metadata_mask)
3667 static inline uint32_t
3668 rte_flow_dynf_metadata_get(struct rte_mbuf *m)
3670 return *RTE_FLOW_DYNF_METADATA(m);
3675 rte_flow_dynf_metadata_set(struct rte_mbuf *m, uint32_t v)
3677 *RTE_FLOW_DYNF_METADATA(m) = v;
3681 * Definition of a single action.
3683 * A list of actions is terminated by a END action.
3685 * For simple actions without a configuration object, conf remains NULL.
3687 struct rte_flow_action {
3688 enum rte_flow_action_type type; /**< Action type. */
3689 const void *conf; /**< Pointer to action configuration object. */
3693 * Opaque type returned after successfully creating a flow.
3695 * This handle can be used to manage and query the related flow (e.g. to
3696 * destroy it or retrieve counters).
3702 * @b EXPERIMENTAL: this structure may change without prior notice
3704 * RTE_FLOW_ACTION_TYPE_SAMPLE
3706 * Adds a sample action to a matched flow.
3708 * The matching packets will be duplicated with specified ratio and applied
3709 * with own set of actions with a fate action, the sampled packet could be
3710 * redirected to queue or port. All the packets continue processing on the
3711 * default flow path.
3713 * When the sample ratio is set to 1 then the packets will be 100% mirrored.
3714 * Additional action list be supported to add for sampled or mirrored packets.
3716 struct rte_flow_action_sample {
3717 uint32_t ratio; /**< packets sampled equals to '1/ratio'. */
3718 /** sub-action list specific for the sampling hit cases. */
3719 const struct rte_flow_action *actions;
3723 * Verbose error types.
3725 * Most of them provide the type of the object referenced by struct
3726 * rte_flow_error.cause.
3728 enum rte_flow_error_type {
3729 RTE_FLOW_ERROR_TYPE_NONE, /**< No error. */
3730 RTE_FLOW_ERROR_TYPE_UNSPECIFIED, /**< Cause unspecified. */
3731 RTE_FLOW_ERROR_TYPE_HANDLE, /**< Flow rule (handle). */
3732 RTE_FLOW_ERROR_TYPE_ATTR_GROUP, /**< Group field. */
3733 RTE_FLOW_ERROR_TYPE_ATTR_PRIORITY, /**< Priority field. */
3734 RTE_FLOW_ERROR_TYPE_ATTR_INGRESS, /**< Ingress field. */
3735 RTE_FLOW_ERROR_TYPE_ATTR_EGRESS, /**< Egress field. */
3736 RTE_FLOW_ERROR_TYPE_ATTR_TRANSFER, /**< Transfer field. */
3737 RTE_FLOW_ERROR_TYPE_ATTR, /**< Attributes structure. */
3738 RTE_FLOW_ERROR_TYPE_ITEM_NUM, /**< Pattern length. */
3739 RTE_FLOW_ERROR_TYPE_ITEM_SPEC, /**< Item specification. */
3740 RTE_FLOW_ERROR_TYPE_ITEM_LAST, /**< Item specification range. */
3741 RTE_FLOW_ERROR_TYPE_ITEM_MASK, /**< Item specification mask. */
3742 RTE_FLOW_ERROR_TYPE_ITEM, /**< Specific pattern item. */
3743 RTE_FLOW_ERROR_TYPE_ACTION_NUM, /**< Number of actions. */
3744 RTE_FLOW_ERROR_TYPE_ACTION_CONF, /**< Action configuration. */
3745 RTE_FLOW_ERROR_TYPE_ACTION, /**< Specific action. */
3749 * Verbose error structure definition.
3751 * This object is normally allocated by applications and set by PMDs, the
3752 * message points to a constant string which does not need to be freed by
3753 * the application, however its pointer can be considered valid only as long
3754 * as its associated DPDK port remains configured. Closing the underlying
3755 * device or unloading the PMD invalidates it.
3757 * Both cause and message may be NULL regardless of the error type.
3759 struct rte_flow_error {
3760 enum rte_flow_error_type type; /**< Cause field and error types. */
3761 const void *cause; /**< Object responsible for the error. */
3762 const char *message; /**< Human-readable error message. */
3766 * Complete flow rule description.
3768 * This object type is used when converting a flow rule description.
3770 * @see RTE_FLOW_CONV_OP_RULE
3771 * @see rte_flow_conv()
3774 struct rte_flow_conv_rule {
3776 const struct rte_flow_attr *attr_ro; /**< RO attributes. */
3777 struct rte_flow_attr *attr; /**< Attributes. */
3780 const struct rte_flow_item *pattern_ro; /**< RO pattern. */
3781 struct rte_flow_item *pattern; /**< Pattern items. */
3784 const struct rte_flow_action *actions_ro; /**< RO actions. */
3785 struct rte_flow_action *actions; /**< List of actions. */
3790 * Conversion operations for flow API objects.
3792 * @see rte_flow_conv()
3794 enum rte_flow_conv_op {
3796 * No operation to perform.
3798 * rte_flow_conv() simply returns 0.
3800 RTE_FLOW_CONV_OP_NONE,
3803 * Convert attributes structure.
3805 * This is a basic copy of an attributes structure.
3808 * @code const struct rte_flow_attr * @endcode
3810 * @code struct rte_flow_attr * @endcode
3812 RTE_FLOW_CONV_OP_ATTR,
3815 * Convert a single item.
3817 * Duplicates @p spec, @p last and @p mask but not outside objects.
3820 * @code const struct rte_flow_item * @endcode
3822 * @code struct rte_flow_item * @endcode
3824 RTE_FLOW_CONV_OP_ITEM,
3827 * Convert a single action.
3829 * Duplicates @p conf but not outside objects.
3832 * @code const struct rte_flow_action * @endcode
3834 * @code struct rte_flow_action * @endcode
3836 RTE_FLOW_CONV_OP_ACTION,
3839 * Convert an entire pattern.
3841 * Duplicates all pattern items at once with the same constraints as
3842 * RTE_FLOW_CONV_OP_ITEM.
3845 * @code const struct rte_flow_item * @endcode
3847 * @code struct rte_flow_item * @endcode
3849 RTE_FLOW_CONV_OP_PATTERN,
3852 * Convert a list of actions.
3854 * Duplicates the entire list of actions at once with the same
3855 * constraints as RTE_FLOW_CONV_OP_ACTION.
3858 * @code const struct rte_flow_action * @endcode
3860 * @code struct rte_flow_action * @endcode
3862 RTE_FLOW_CONV_OP_ACTIONS,
3865 * Convert a complete flow rule description.
3867 * Comprises attributes, pattern and actions together at once with
3868 * the usual constraints.
3871 * @code const struct rte_flow_conv_rule * @endcode
3873 * @code struct rte_flow_conv_rule * @endcode
3875 RTE_FLOW_CONV_OP_RULE,
3878 * Convert item type to its name string.
3880 * Writes a NUL-terminated string to @p dst. Like snprintf(), the
3881 * returned value excludes the terminator which is always written
3885 * @code (const void *)enum rte_flow_item_type @endcode
3887 * @code char * @endcode
3889 RTE_FLOW_CONV_OP_ITEM_NAME,
3892 * Convert action type to its name string.
3894 * Writes a NUL-terminated string to @p dst. Like snprintf(), the
3895 * returned value excludes the terminator which is always written
3899 * @code (const void *)enum rte_flow_action_type @endcode
3901 * @code char * @endcode
3903 RTE_FLOW_CONV_OP_ACTION_NAME,
3906 * Convert item type to pointer to item name.
3908 * Retrieves item name pointer from its type. The string itself is
3909 * not copied; instead, a unique pointer to an internal static
3910 * constant storage is written to @p dst.
3913 * @code (const void *)enum rte_flow_item_type @endcode
3915 * @code const char ** @endcode
3917 RTE_FLOW_CONV_OP_ITEM_NAME_PTR,
3920 * Convert action type to pointer to action name.
3922 * Retrieves action name pointer from its type. The string itself is
3923 * not copied; instead, a unique pointer to an internal static
3924 * constant storage is written to @p dst.
3927 * @code (const void *)enum rte_flow_action_type @endcode
3929 * @code const char ** @endcode
3931 RTE_FLOW_CONV_OP_ACTION_NAME_PTR,
3936 * @b EXPERIMENTAL: this API may change without prior notice.
3938 * Dump hardware internal representation information of
3941 * @param[in] port_id
3942 * The port identifier of the Ethernet device.
3944 * The pointer of flow rule to dump. Dump all rules if NULL.
3946 * A pointer to a file for output.
3948 * Perform verbose error reporting if not NULL. PMDs initialize this
3949 * structure in case of error only.
3951 * 0 on success, a nagative value otherwise.
3955 rte_flow_dev_dump(uint16_t port_id, struct rte_flow *flow,
3956 FILE *file, struct rte_flow_error *error);
3959 * Check if mbuf dynamic field for metadata is registered.
3962 * True if registered, false otherwise.
3966 rte_flow_dynf_metadata_avail(void)
3968 return !!rte_flow_dynf_metadata_mask;
3972 * Register mbuf dynamic field and flag for metadata.
3974 * This function must be called prior to use SET_META action in order to
3975 * register the dynamic mbuf field. Otherwise, the data cannot be delivered to
3979 * 0 on success, a negative errno value otherwise and rte_errno is set.
3983 rte_flow_dynf_metadata_register(void);
3986 * Check whether a flow rule can be created on a given port.
3988 * The flow rule is validated for correctness and whether it could be accepted
3989 * by the device given sufficient resources. The rule is checked against the
3990 * current device mode and queue configuration. The flow rule may also
3991 * optionally be validated against existing flow rules and device resources.
3992 * This function has no effect on the target device.
3994 * The returned value is guaranteed to remain valid only as long as no
3995 * successful calls to rte_flow_create() or rte_flow_destroy() are made in
3996 * the meantime and no device parameter affecting flow rules in any way are
3997 * modified, due to possible collisions or resource limitations (although in
3998 * such cases EINVAL should not be returned).
4001 * Port identifier of Ethernet device.
4003 * Flow rule attributes.
4004 * @param[in] pattern
4005 * Pattern specification (list terminated by the END pattern item).
4006 * @param[in] actions
4007 * Associated actions (list terminated by the END action).
4009 * Perform verbose error reporting if not NULL. PMDs initialize this
4010 * structure in case of error only.
4013 * 0 if flow rule is valid and can be created. A negative errno value
4014 * otherwise (rte_errno is also set), the following errors are defined:
4016 * -ENOSYS: underlying device does not support this functionality.
4018 * -EIO: underlying device is removed.
4020 * -EINVAL: unknown or invalid rule specification.
4022 * -ENOTSUP: valid but unsupported rule specification (e.g. partial
4023 * bit-masks are unsupported).
4025 * -EEXIST: collision with an existing rule. Only returned if device
4026 * supports flow rule collision checking and there was a flow rule
4027 * collision. Not receiving this return code is no guarantee that creating
4028 * the rule will not fail due to a collision.
4030 * -ENOMEM: not enough memory to execute the function, or if the device
4031 * supports resource validation, resource limitation on the device.
4033 * -EBUSY: action cannot be performed due to busy device resources, may
4034 * succeed if the affected queues or even the entire port are in a stopped
4035 * state (see rte_eth_dev_rx_queue_stop() and rte_eth_dev_stop()).
4038 rte_flow_validate(uint16_t port_id,
4039 const struct rte_flow_attr *attr,
4040 const struct rte_flow_item pattern[],
4041 const struct rte_flow_action actions[],
4042 struct rte_flow_error *error);
4045 * Create a flow rule on a given port.
4048 * Port identifier of Ethernet device.
4050 * Flow rule attributes.
4051 * @param[in] pattern
4052 * Pattern specification (list terminated by the END pattern item).
4053 * @param[in] actions
4054 * Associated actions (list terminated by the END action).
4056 * Perform verbose error reporting if not NULL. PMDs initialize this
4057 * structure in case of error only.
4060 * A valid handle in case of success, NULL otherwise and rte_errno is set
4061 * to the positive version of one of the error codes defined for
4062 * rte_flow_validate().
4065 rte_flow_create(uint16_t port_id,
4066 const struct rte_flow_attr *attr,
4067 const struct rte_flow_item pattern[],
4068 const struct rte_flow_action actions[],
4069 struct rte_flow_error *error);
4072 * Destroy a flow rule on a given port.
4074 * Failure to destroy a flow rule handle may occur when other flow rules
4075 * depend on it, and destroying it would result in an inconsistent state.
4077 * This function is only guaranteed to succeed if handles are destroyed in
4078 * reverse order of their creation.
4081 * Port identifier of Ethernet device.
4083 * Flow rule handle to destroy.
4085 * Perform verbose error reporting if not NULL. PMDs initialize this
4086 * structure in case of error only.
4089 * 0 on success, a negative errno value otherwise and rte_errno is set.
4092 rte_flow_destroy(uint16_t port_id,
4093 struct rte_flow *flow,
4094 struct rte_flow_error *error);
4097 * Destroy all flow rules associated with a port.
4099 * In the unlikely event of failure, handles are still considered destroyed
4100 * and no longer valid but the port must be assumed to be in an inconsistent
4104 * Port identifier of Ethernet device.
4106 * Perform verbose error reporting if not NULL. PMDs initialize this
4107 * structure in case of error only.
4110 * 0 on success, a negative errno value otherwise and rte_errno is set.
4113 rte_flow_flush(uint16_t port_id,
4114 struct rte_flow_error *error);
4117 * Query an existing flow rule.
4119 * This function allows retrieving flow-specific data such as counters.
4120 * Data is gathered by special actions which must be present in the flow
4123 * \see RTE_FLOW_ACTION_TYPE_COUNT
4126 * Port identifier of Ethernet device.
4128 * Flow rule handle to query.
4130 * Action definition as defined in original flow rule.
4131 * @param[in, out] data
4132 * Pointer to storage for the associated query data type.
4134 * Perform verbose error reporting if not NULL. PMDs initialize this
4135 * structure in case of error only.
4138 * 0 on success, a negative errno value otherwise and rte_errno is set.
4141 rte_flow_query(uint16_t port_id,
4142 struct rte_flow *flow,
4143 const struct rte_flow_action *action,
4145 struct rte_flow_error *error);
4148 * Restrict ingress traffic to the defined flow rules.
4150 * Isolated mode guarantees that all ingress traffic comes from defined flow
4151 * rules only (current and future).
4153 * Besides making ingress more deterministic, it allows PMDs to safely reuse
4154 * resources otherwise assigned to handle the remaining traffic, such as
4155 * global RSS configuration settings, VLAN filters, MAC address entries,
4156 * legacy filter API rules and so on in order to expand the set of possible
4159 * Calling this function as soon as possible after device initialization,
4160 * ideally before the first call to rte_eth_dev_configure(), is recommended
4161 * to avoid possible failures due to conflicting settings.
4163 * Once effective, leaving isolated mode may not be possible depending on
4164 * PMD implementation.
4166 * Additionally, the following functionality has no effect on the underlying
4167 * port and may return errors such as ENOTSUP ("not supported"):
4169 * - Toggling promiscuous mode.
4170 * - Toggling allmulticast mode.
4171 * - Configuring MAC addresses.
4172 * - Configuring multicast addresses.
4173 * - Configuring VLAN filters.
4174 * - Configuring Rx filters through the legacy API (e.g. FDIR).
4175 * - Configuring global RSS settings.
4178 * Port identifier of Ethernet device.
4180 * Nonzero to enter isolated mode, attempt to leave it otherwise.
4182 * Perform verbose error reporting if not NULL. PMDs initialize this
4183 * structure in case of error only.
4186 * 0 on success, a negative errno value otherwise and rte_errno is set.
4189 rte_flow_isolate(uint16_t port_id, int set, struct rte_flow_error *error);
4192 * Initialize flow error structure.
4195 * Pointer to flow error structure (may be NULL).
4197 * Related error code (rte_errno).
4199 * Cause field and error types.
4201 * Object responsible for the error.
4203 * Human-readable error message.
4206 * Negative error code (errno value) and rte_errno is set.
4209 rte_flow_error_set(struct rte_flow_error *error,
4211 enum rte_flow_error_type type,
4213 const char *message);
4217 * @see rte_flow_copy()
4219 struct rte_flow_desc {
4220 size_t size; /**< Allocated space including data[]. */
4221 struct rte_flow_attr attr; /**< Attributes. */
4222 struct rte_flow_item *items; /**< Items. */
4223 struct rte_flow_action *actions; /**< Actions. */
4224 uint8_t data[]; /**< Storage for items/actions. */
4229 * Copy an rte_flow rule description.
4231 * This interface is kept for compatibility with older applications but is
4232 * implemented as a wrapper to rte_flow_conv(). It is deprecated due to its
4233 * lack of flexibility and reliance on a type unusable with C++ programs
4234 * (struct rte_flow_desc).
4237 * Flow rule description.
4239 * Total size of allocated data for the flow description.
4241 * Flow rule attributes.
4243 * Pattern specification (list terminated by the END pattern item).
4244 * @param[in] actions
4245 * Associated actions (list terminated by the END action).
4248 * If len is greater or equal to the size of the flow, the total size of the
4249 * flow description and its data.
4250 * If len is lower than the size of the flow, the number of bytes that would
4251 * have been written to desc had it been sufficient. Nothing is written.
4255 rte_flow_copy(struct rte_flow_desc *fd, size_t len,
4256 const struct rte_flow_attr *attr,
4257 const struct rte_flow_item *items,
4258 const struct rte_flow_action *actions);
4261 * Flow object conversion helper.
4263 * This function performs conversion of various flow API objects to a
4264 * pre-allocated destination buffer. See enum rte_flow_conv_op for possible
4265 * operations and details about each of them.
4267 * Since destination buffer must be large enough, it works in a manner
4268 * reminiscent of snprintf():
4270 * - If @p size is 0, @p dst may be a NULL pointer, otherwise @p dst must be
4272 * - If positive, the returned value represents the number of bytes needed
4273 * to store the conversion of @p src to @p dst according to @p op
4274 * regardless of the @p size parameter.
4275 * - Since no more than @p size bytes can be written to @p dst, output is
4276 * truncated and may be inconsistent when the returned value is larger
4278 * - In case of conversion error, a negative error code is returned and
4279 * @p dst contents are unspecified.
4282 * Operation to perform, related to the object type of @p dst.
4284 * Destination buffer address. Must be suitably aligned by the caller.
4286 * Destination buffer size in bytes.
4288 * Source object to copy. Depending on @p op, its type may differ from
4291 * Perform verbose error reporting if not NULL. Initialized in case of
4295 * The number of bytes required to convert @p src to @p dst on success, a
4296 * negative errno value otherwise and rte_errno is set.
4298 * @see rte_flow_conv_op
4302 rte_flow_conv(enum rte_flow_conv_op op,
4306 struct rte_flow_error *error);
4309 * Get aged-out flows of a given port.
4311 * RTE_ETH_EVENT_FLOW_AGED event will be triggered when at least one new aged
4312 * out flow was detected after the last call to rte_flow_get_aged_flows.
4313 * This function can be called to get the aged flows usynchronously from the
4314 * event callback or synchronously regardless the event.
4315 * This is not safe to call rte_flow_get_aged_flows function with other flow
4316 * functions from multiple threads simultaneously.
4319 * Port identifier of Ethernet device.
4320 * @param[in, out] contexts
4321 * The address of an array of pointers to the aged-out flows contexts.
4322 * @param[in] nb_contexts
4323 * The length of context array pointers.
4325 * Perform verbose error reporting if not NULL. Initialized in case of
4329 * if nb_contexts is 0, return the amount of all aged contexts.
4330 * if nb_contexts is not 0 , return the amount of aged flows reported
4331 * in the context array, otherwise negative errno value.
4333 * @see rte_flow_action_age
4334 * @see RTE_ETH_EVENT_FLOW_AGED
4338 rte_flow_get_aged_flows(uint16_t port_id, void **contexts,
4339 uint32_t nb_contexts, struct rte_flow_error *error);
4342 * Specify indirect action object configuration
4344 struct rte_flow_indir_action_conf {
4346 * Flow direction for the indirect action configuration.
4348 * Action should be valid at least for one flow direction,
4349 * otherwise it is invalid for both ingress and egress rules.
4351 /** Action valid for rules applied to ingress traffic. */
4353 /** Action valid for rules applied to egress traffic. */
4356 * When set to 1, indicates that the action is valid for
4357 * transfer traffic; otherwise, for non-transfer traffic.
4359 uint32_t transfer:1;
4364 * @b EXPERIMENTAL: this API may change without prior notice.
4366 * Create an indirect action object that can be used in flow rules
4368 * The created object handle has single state and configuration
4369 * across all the flow rules using it.
4371 * @param[in] port_id
4372 * The port identifier of the Ethernet device.
4374 * Action configuration for the indirect action object creation.
4376 * Specific configuration of the indirect action object.
4378 * Perform verbose error reporting if not NULL. PMDs initialize this
4379 * structure in case of error only.
4381 * A valid handle in case of success, NULL otherwise and rte_errno is set
4382 * to one of the error codes defined:
4383 * - (ENODEV) if *port_id* invalid.
4384 * - (ENOSYS) if underlying device does not support this functionality.
4385 * - (EIO) if underlying device is removed.
4386 * - (EINVAL) if *action* invalid.
4387 * - (ENOTSUP) if *action* valid but unsupported.
4390 struct rte_flow_action_handle *
4391 rte_flow_action_handle_create(uint16_t port_id,
4392 const struct rte_flow_indir_action_conf *conf,
4393 const struct rte_flow_action *action,
4394 struct rte_flow_error *error);
4398 * @b EXPERIMENTAL: this API may change without prior notice.
4400 * Destroy indirect action by handle.
4402 * @param[in] port_id
4403 * The port identifier of the Ethernet device.
4405 * Handle for the indirect action object to be destroyed.
4407 * Perform verbose error reporting if not NULL. PMDs initialize this
4408 * structure in case of error only.
4411 * - (-ENODEV) if *port_id* invalid.
4412 * - (-ENOSYS) if underlying device does not support this functionality.
4413 * - (-EIO) if underlying device is removed.
4414 * - (-ENOENT) if action pointed by *action* handle was not found.
4415 * - (-EBUSY) if action pointed by *action* handle still used by some rules
4416 * rte_errno is also set.
4420 rte_flow_action_handle_destroy(uint16_t port_id,
4421 struct rte_flow_action_handle *handle,
4422 struct rte_flow_error *error);
4426 * @b EXPERIMENTAL: this API may change without prior notice.
4428 * Update in-place the action configuration and / or state pointed
4429 * by action *handle* with the configuration provided as *update* argument.
4430 * The update of the action configuration effects all flow rules reusing
4431 * the action via *handle*.
4432 * The update general pointer provides the ability of partial updating.
4434 * @param[in] port_id
4435 * The port identifier of the Ethernet device.
4437 * Handle for the indirect action object to be updated.
4439 * Update profile specification used to modify the action pointed by handle.
4440 * *update* could be with the same type of the immediate action corresponding
4441 * to the *handle* argument when creating, or a wrapper structure includes
4442 * action configuration to be updated and bit fields to indicate the member
4443 * of fields inside the action to update.
4445 * Perform verbose error reporting if not NULL. PMDs initialize this
4446 * structure in case of error only.
4449 * - (-ENODEV) if *port_id* invalid.
4450 * - (-ENOSYS) if underlying device does not support this functionality.
4451 * - (-EIO) if underlying device is removed.
4452 * - (-EINVAL) if *update* invalid.
4453 * - (-ENOTSUP) if *update* valid but unsupported.
4454 * - (-ENOENT) if indirect action object pointed by *handle* was not found.
4455 * rte_errno is also set.
4459 rte_flow_action_handle_update(uint16_t port_id,
4460 struct rte_flow_action_handle *handle,
4462 struct rte_flow_error *error);
4466 * @b EXPERIMENTAL: this API may change without prior notice.
4468 * Query the direct action by corresponding indirect action object handle.
4470 * Retrieve action-specific data such as counters.
4471 * Data is gathered by special action which may be present/referenced in
4472 * more than one flow rule definition.
4474 * @see RTE_FLOW_ACTION_TYPE_COUNT
4477 * Port identifier of Ethernet device.
4479 * Handle for the action object to query.
4480 * @param[in, out] data
4481 * Pointer to storage for the associated query data type.
4483 * Perform verbose error reporting if not NULL. PMDs initialize this
4484 * structure in case of error only.
4487 * 0 on success, a negative errno value otherwise and rte_errno is set.
4491 rte_flow_action_handle_query(uint16_t port_id,
4492 const struct rte_flow_action_handle *handle,
4493 void *data, struct rte_flow_error *error);
4495 /* Tunnel has a type and the key information. */
4496 struct rte_flow_tunnel {
4498 * Tunnel type, for example RTE_FLOW_ITEM_TYPE_VXLAN,
4499 * RTE_FLOW_ITEM_TYPE_NVGRE etc.
4501 enum rte_flow_item_type type;
4502 uint64_t tun_id; /**< Tunnel identification. */
4507 rte_be32_t src_addr; /**< IPv4 source address. */
4508 rte_be32_t dst_addr; /**< IPv4 destination address. */
4511 uint8_t src_addr[16]; /**< IPv6 source address. */
4512 uint8_t dst_addr[16]; /**< IPv6 destination address. */
4515 rte_be16_t tp_src; /**< Tunnel port source. */
4516 rte_be16_t tp_dst; /**< Tunnel port destination. */
4517 uint16_t tun_flags; /**< Tunnel flags. */
4519 bool is_ipv6; /**< True for valid IPv6 fields. Otherwise IPv4. */
4522 * the following members are required to restore packet
4525 uint8_t tos; /**< TOS for IPv4, TC for IPv6. */
4526 uint8_t ttl; /**< TTL for IPv4, HL for IPv6. */
4527 uint32_t label; /**< Flow Label for IPv6. */
4531 * Indicate that the packet has a tunnel.
4533 #define RTE_FLOW_RESTORE_INFO_TUNNEL RTE_BIT64(0)
4536 * Indicate that the packet has a non decapsulated tunnel header.
4538 #define RTE_FLOW_RESTORE_INFO_ENCAPSULATED RTE_BIT64(1)
4541 * Indicate that the packet has a group_id.
4543 #define RTE_FLOW_RESTORE_INFO_GROUP_ID RTE_BIT64(2)
4546 * Restore information structure to communicate the current packet processing
4547 * state when some of the processing pipeline is done in hardware and should
4548 * continue in software.
4550 struct rte_flow_restore_info {
4552 * Bitwise flags (RTE_FLOW_RESTORE_INFO_*) to indicate validation of
4553 * other fields in struct rte_flow_restore_info.
4556 uint32_t group_id; /**< Group ID where packed missed */
4557 struct rte_flow_tunnel tunnel; /**< Tunnel information. */
4561 * Allocate an array of actions to be used in rte_flow_create, to implement
4562 * tunnel-decap-set for the given tunnel.
4564 * actions vxlan_decap / tunnel-decap-set(tunnel properties) /
4565 * jump group 0 / end
4568 * Port identifier of Ethernet device.
4570 * Tunnel properties.
4571 * @param[out] actions
4572 * Array of actions to be allocated by the PMD. This array should be
4573 * concatenated with the actions array provided to rte_flow_create.
4574 * @param[out] num_of_actions
4575 * Number of actions allocated.
4577 * Perform verbose error reporting if not NULL. PMDs initialize this
4578 * structure in case of error only.
4581 * 0 on success, a negative errno value otherwise and rte_errno is set.
4585 rte_flow_tunnel_decap_set(uint16_t port_id,
4586 struct rte_flow_tunnel *tunnel,
4587 struct rte_flow_action **actions,
4588 uint32_t *num_of_actions,
4589 struct rte_flow_error *error);
4592 * Allocate an array of items to be used in rte_flow_create, to implement
4593 * tunnel-match for the given tunnel.
4595 * pattern tunnel-match(tunnel properties) / outer-header-matches /
4596 * inner-header-matches / end
4599 * Port identifier of Ethernet device.
4601 * Tunnel properties.
4603 * Array of items to be allocated by the PMD. This array should be
4604 * concatenated with the items array provided to rte_flow_create.
4605 * @param[out] num_of_items
4606 * Number of items allocated.
4608 * Perform verbose error reporting if not NULL. PMDs initialize this
4609 * structure in case of error only.
4612 * 0 on success, a negative errno value otherwise and rte_errno is set.
4616 rte_flow_tunnel_match(uint16_t port_id,
4617 struct rte_flow_tunnel *tunnel,
4618 struct rte_flow_item **items,
4619 uint32_t *num_of_items,
4620 struct rte_flow_error *error);
4623 * Populate the current packet processing state, if exists, for the given mbuf.
4625 * One should negotiate tunnel metadata delivery from the NIC to the HW.
4626 * @see rte_eth_rx_metadata_negotiate()
4627 * @see RTE_ETH_RX_METADATA_TUNNEL_ID
4630 * Port identifier of Ethernet device.
4634 * Restore information. Upon success contains the HW state.
4636 * Perform verbose error reporting if not NULL. PMDs initialize this
4637 * structure in case of error only.
4640 * 0 on success, a negative errno value otherwise and rte_errno is set.
4644 rte_flow_get_restore_info(uint16_t port_id,
4646 struct rte_flow_restore_info *info,
4647 struct rte_flow_error *error);
4650 * Release the action array as allocated by rte_flow_tunnel_decap_set.
4653 * Port identifier of Ethernet device.
4654 * @param[in] actions
4655 * Array of actions to be released.
4656 * @param[in] num_of_actions
4657 * Number of elements in actions array.
4659 * Perform verbose error reporting if not NULL. PMDs initialize this
4660 * structure in case of error only.
4663 * 0 on success, a negative errno value otherwise and rte_errno is set.
4667 rte_flow_tunnel_action_decap_release(uint16_t port_id,
4668 struct rte_flow_action *actions,
4669 uint32_t num_of_actions,
4670 struct rte_flow_error *error);
4673 * Release the item array as allocated by rte_flow_tunnel_match.
4676 * Port identifier of Ethernet device.
4678 * Array of items to be released.
4679 * @param[in] num_of_items
4680 * Number of elements in item array.
4682 * Perform verbose error reporting if not NULL. PMDs initialize this
4683 * structure in case of error only.
4686 * 0 on success, a negative errno value otherwise and rte_errno is set.
4690 rte_flow_tunnel_item_release(uint16_t port_id,
4691 struct rte_flow_item *items,
4692 uint32_t num_of_items,
4693 struct rte_flow_error *error);
4697 * @b EXPERIMENTAL: this API may change without prior notice.
4699 * Get a proxy port to manage "transfer" flows.
4701 * Managing "transfer" flows requires that the user communicate them
4702 * via a port which has the privilege to control the embedded switch.
4703 * For some vendors, all ports in a given switching domain have
4704 * this privilege. For other vendors, it's only one port.
4706 * This API indicates such a privileged port (a "proxy")
4707 * for a given port in the same switching domain.
4710 * If the PMD serving @p port_id doesn't have the corresponding method
4711 * implemented, the API will return @p port_id via @p proxy_port_id.
4714 * Indicates the port to get a "proxy" for
4715 * @param[out] proxy_port_id
4716 * Indicates the "proxy" port
4718 * If not NULL, allows the PMD to provide verbose report in case of error
4721 * 0 on success, a negative error code otherwise
4725 rte_flow_pick_transfer_proxy(uint16_t port_id, uint16_t *proxy_port_id,
4726 struct rte_flow_error *error);
4730 * @b EXPERIMENTAL: this API may change without prior notice.
4732 * Create the flex item with specified configuration over
4733 * the Ethernet device.
4736 * Port identifier of Ethernet device.
4738 * Item configuration.
4740 * Perform verbose error reporting if not NULL. PMDs initialize this
4741 * structure in case of error only.
4744 * Non-NULL opaque pointer on success, NULL otherwise and rte_errno is set.
4747 struct rte_flow_item_flex_handle *
4748 rte_flow_flex_item_create(uint16_t port_id,
4749 const struct rte_flow_item_flex_conf *conf,
4750 struct rte_flow_error *error);
4753 * Release the flex item on the specified Ethernet device.
4756 * Port identifier of Ethernet device.
4758 * Handle of the item existing on the specified device.
4760 * Perform verbose error reporting if not NULL. PMDs initialize this
4761 * structure in case of error only.
4764 * 0 on success, a negative errno value otherwise and rte_errno is set.
4768 rte_flow_flex_item_release(uint16_t port_id,
4769 const struct rte_flow_item_flex_handle *handle,
4770 struct rte_flow_error *error);
4776 #endif /* RTE_FLOW_H_ */