1 .. SPDX-License-Identifier: BSD-3-Clause
2 Copyright 2016 6WIND S.A.
3 Copyright 2016 Mellanox Technologies, Ltd
5 Generic flow API (rte_flow)
6 ===========================
11 This API provides a generic means to configure hardware to match specific
12 ingress or egress traffic, alter its fate and query related counters
13 according to any number of user-defined rules.
15 It is named *rte_flow* after the prefix used for all its symbols, and is
16 defined in ``rte_flow.h``.
18 - Matching can be performed on packet data (protocol headers, payload) and
19 properties (e.g. associated physical port, virtual device function ID).
21 - Possible operations include dropping traffic, diverting it to specific
22 queues, to virtual/physical device functions or ports, performing tunnel
23 offloads, adding marks and so on.
25 It is slightly higher-level than the legacy filtering framework which it
26 encompasses and supersedes (including all functions and filter types) in
27 order to expose a single interface with an unambiguous behavior that is
28 common to all poll-mode drivers (PMDs).
36 A flow rule is the combination of attributes with a matching pattern and a
37 list of actions. Flow rules form the basis of this API.
39 Flow rules can have several distinct actions (such as counting,
40 encapsulating, decapsulating before redirecting packets to a particular
41 queue, etc.), instead of relying on several rules to achieve this and having
42 applications deal with hardware implementation details regarding their
45 Support for different priority levels on a rule basis is provided, for
46 example in order to force a more specific rule to come before a more generic
47 one for packets matched by both. However hardware support for more than a
48 single priority level cannot be guaranteed. When supported, the number of
49 available priority levels is usually low, which is why they can also be
50 implemented in software by PMDs (e.g. missing priority levels may be
51 emulated by reordering rules).
53 In order to remain as hardware-agnostic as possible, by default all rules
54 are considered to have the same priority, which means that the order between
55 overlapping rules (when a packet is matched by several filters) is
58 PMDs may refuse to create overlapping rules at a given priority level when
59 they can be detected (e.g. if a pattern matches an existing filter).
61 Thus predictable results for a given priority level can only be achieved
62 with non-overlapping rules, using perfect matching on all protocol layers.
64 Flow rules can also be grouped, the flow rule priority is specific to the
65 group they belong to. All flow rules in a given group are thus processed within
66 the context of that group. Groups are not linked by default, so the logical
67 hierarchy of groups must be explicitly defined by flow rules themselves in each
68 group using the JUMP action to define the next group to redirect too. Only flow
69 rules defined in the default group 0 are guarantee to be matched against, this
70 makes group 0 the origin of any group hierarchy defined by an application.
72 Support for multiple actions per rule may be implemented internally on top
73 of non-default hardware priorities, as a result both features may not be
74 simultaneously available to applications.
76 Considering that allowed pattern/actions combinations cannot be known in
77 advance and would result in an impractically large number of capabilities to
78 expose, a method is provided to validate a given rule from the current
79 device configuration state.
81 This enables applications to check if the rule types they need is supported
82 at initialization time, before starting their data path. This method can be
83 used anytime, its only requirement being that the resources needed by a rule
84 should exist (e.g. a target RX queue should be configured first).
86 Each defined rule is associated with an opaque handle managed by the PMD,
87 applications are responsible for keeping it. These can be used for queries
88 and rules management, such as retrieving counters or other data and
91 To avoid resource leaks on the PMD side, handles must be explicitly
92 destroyed by the application before releasing associated resources such as
95 The following sections cover:
97 - **Attributes** (represented by ``struct rte_flow_attr``): properties of a
98 flow rule such as its direction (ingress or egress) and priority.
100 - **Pattern item** (represented by ``struct rte_flow_item``): part of a
101 matching pattern that either matches specific packet data or traffic
102 properties. It can also describe properties of the pattern itself, such as
105 - **Matching pattern**: traffic properties to look for, a combination of any
108 - **Actions** (represented by ``struct rte_flow_action``): operations to
109 perform whenever a packet is matched by a pattern.
117 Flow rules can be grouped by assigning them a common group number. Groups
118 allow a logical hierarchy of flow rule groups (tables) to be defined. These
119 groups can be supported virtually in the PMD or in the physical device.
120 Group 0 is the default group and this is the only group which flows are
121 guarantee to matched against, all subsequent groups can only be reached by
122 way of the JUMP action from a matched flow rule.
124 Although optional, applications are encouraged to group similar rules as
125 much as possible to fully take advantage of hardware capabilities
126 (e.g. optimized matching) and work around limitations (e.g. a single pattern
127 type possibly allowed in a given group), while being aware that the groups
128 hierarchies must be programmed explicitly.
130 Note that support for more than a single group is not guaranteed.
135 A priority level can be assigned to a flow rule, lower values
136 denote higher priority, with 0 as the maximum.
138 Priority levels are arbitrary and up to the application, they do
139 not need to be contiguous nor start from 0, however the maximum number
140 varies between devices and may be affected by existing flow rules.
142 A flow which matches multiple rules in the same group will always matched by
143 the rule with the highest priority in that group.
145 If a packet is matched by several rules of a given group for a given
146 priority level, the outcome is undefined. It can take any path, may be
147 duplicated or even cause unrecoverable errors.
149 Note that support for more than a single priority level is not guaranteed.
151 Attribute: Traffic direction
152 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
154 Flow rule patterns apply to inbound and/or outbound traffic.
156 In the context of this API, **ingress** and **egress** respectively stand
157 for **inbound** and **outbound** based on the standpoint of the application
158 creating a flow rule.
160 There are no exceptions to this definition.
162 Several pattern items and actions are valid and can be used in both
163 directions. At least one direction must be specified.
165 Specifying both directions at once for a given rule is not recommended but
166 may be valid in a few cases (e.g. shared counters).
171 Instead of simply matching the properties of traffic as it would appear on a
172 given DPDK port ID, enabling this attribute transfers a flow rule to the
173 lowest possible level of any device endpoints found in the pattern.
175 When supported, this effectively enables an application to reroute traffic
176 not necessarily intended for it (e.g. coming from or addressed to different
177 physical ports, VFs or applications) at the device level.
179 It complements the behavior of some pattern items such as `Item: PHY_PORT`_
180 and is meaningless without them.
182 When transferring flow rules, **ingress** and **egress** attributes
183 (`Attribute: Traffic direction`_) keep their original meaning, as if
184 processing traffic emitted or received by the application.
189 Pattern items fall in two categories:
191 - Matching protocol headers and packet data, usually associated with a
192 specification structure. These must be stacked in the same order as the
193 protocol layers to match inside packets, starting from the lowest.
195 - Matching meta-data or affecting pattern processing, often without a
196 specification structure. Since they do not match packet contents, their
197 position in the list is usually not relevant.
199 Item specification structures are used to match specific values among
200 protocol fields (or item properties). Documentation describes for each item
201 whether they are associated with one and their type name if so.
203 Up to three structures of the same type can be set for a given item:
205 - ``spec``: values to match (e.g. a given IPv4 address).
207 - ``last``: upper bound for an inclusive range with corresponding fields in
210 - ``mask``: bit-mask applied to both ``spec`` and ``last`` whose purpose is
211 to distinguish the values to take into account and/or partially mask them
212 out (e.g. in order to match an IPv4 address prefix).
214 Usage restrictions and expected behavior:
216 - Setting either ``mask`` or ``last`` without ``spec`` is an error.
218 - Field values in ``last`` which are either 0 or equal to the corresponding
219 values in ``spec`` are ignored; they do not generate a range. Nonzero
220 values lower than those in ``spec`` are not supported.
222 - Setting ``spec`` and optionally ``last`` without ``mask`` causes the PMD
223 to use the default mask defined for that item (defined as
224 ``rte_flow_item_{name}_mask`` constants).
226 - Not setting any of them (assuming item type allows it) is equivalent to
227 providing an empty (zeroed) ``mask`` for broad (nonspecific) matching.
229 - ``mask`` is a simple bit-mask applied before interpreting the contents of
230 ``spec`` and ``last``, which may yield unexpected results if not used
231 carefully. For example, if for an IPv4 address field, ``spec`` provides
232 *10.1.2.3*, ``last`` provides *10.3.4.5* and ``mask`` provides
233 *255.255.0.0*, the effective range becomes *10.1.0.0* to *10.3.255.255*.
235 Example of an item specification matching an Ethernet header:
237 .. _table_rte_flow_pattern_item_example:
239 .. table:: Ethernet item
241 +----------+----------+-----------------------+
242 | Field | Subfield | Value |
243 +==========+==========+=======================+
244 | ``spec`` | ``src`` | ``00:00:01:02:03:04`` |
245 | +----------+-----------------------+
246 | | ``dst`` | ``00:00:2a:66:00:01`` |
247 | +----------+-----------------------+
248 | | ``type`` | ``0x22aa`` |
249 +----------+----------+-----------------------+
250 | ``last`` | unspecified |
251 +----------+----------+-----------------------+
252 | ``mask`` | ``src`` | ``00:00:ff:ff:ff:00`` |
253 | +----------+-----------------------+
254 | | ``dst`` | ``00:00:00:00:00:ff`` |
255 | +----------+-----------------------+
256 | | ``type`` | ``0x0000`` |
257 +----------+----------+-----------------------+
259 Non-masked bits stand for any value (shown as ``?`` below), Ethernet headers
260 with the following properties are thus matched:
262 - ``src``: ``??:??:01:02:03:??``
263 - ``dst``: ``??:??:??:??:??:01``
264 - ``type``: ``0x????``
269 A pattern is formed by stacking items starting from the lowest protocol
270 layer to match. This stacking restriction does not apply to meta items which
271 can be placed anywhere in the stack without affecting the meaning of the
274 Patterns are terminated by END items.
278 .. _table_rte_flow_tcpv4_as_l4:
280 .. table:: TCPv4 as L4
296 .. _table_rte_flow_tcpv6_in_vxlan:
298 .. table:: TCPv6 in VXLAN
300 +-------+------------+
302 +=======+============+
304 +-------+------------+
306 +-------+------------+
308 +-------+------------+
310 +-------+------------+
312 +-------+------------+
314 +-------+------------+
316 +-------+------------+
318 +-------+------------+
322 .. _table_rte_flow_tcpv4_as_l4_meta:
324 .. table:: TCPv4 as L4 with meta items
346 The above example shows how meta items do not affect packet data matching
347 items, as long as those remain stacked properly. The resulting matching
348 pattern is identical to "TCPv4 as L4".
350 .. _table_rte_flow_udpv6_anywhere:
352 .. table:: UDPv6 anywhere
364 If supported by the PMD, omitting one or several protocol layers at the
365 bottom of the stack as in the above example (missing an Ethernet
366 specification) enables looking up anywhere in packets.
368 It is unspecified whether the payload of supported encapsulations
369 (e.g. VXLAN payload) is matched by such a pattern, which may apply to inner,
370 outer or both packets.
372 .. _table_rte_flow_invalid_l3:
374 .. table:: Invalid, missing L3
386 The above pattern is invalid due to a missing L3 specification between L2
387 (Ethernet) and L4 (UDP). Doing so is only allowed at the bottom and at the
393 They match meta-data or affect pattern processing instead of matching packet
394 data directly, most of them do not need a specification structure. This
395 particularity allows them to be specified anywhere in the stack without
396 causing any side effect.
401 End marker for item lists. Prevents further processing of items, thereby
404 - Its numeric value is 0 for convenience.
405 - PMD support is mandatory.
406 - ``spec``, ``last`` and ``mask`` are ignored.
408 .. _table_rte_flow_item_end:
412 +----------+---------+
414 +==========+=========+
415 | ``spec`` | ignored |
416 +----------+---------+
417 | ``last`` | ignored |
418 +----------+---------+
419 | ``mask`` | ignored |
420 +----------+---------+
425 Used as a placeholder for convenience. It is ignored and simply discarded by
428 - PMD support is mandatory.
429 - ``spec``, ``last`` and ``mask`` are ignored.
431 .. _table_rte_flow_item_void:
435 +----------+---------+
437 +==========+=========+
438 | ``spec`` | ignored |
439 +----------+---------+
440 | ``last`` | ignored |
441 +----------+---------+
442 | ``mask`` | ignored |
443 +----------+---------+
445 One usage example for this type is generating rules that share a common
446 prefix quickly without reallocating memory, only by updating item types:
448 .. _table_rte_flow_item_void_example:
450 .. table:: TCP, UDP or ICMP as L4
452 +-------+--------------------+
454 +=======+====================+
456 +-------+--------------------+
458 +-------+------+------+------+
459 | 2 | UDP | VOID | VOID |
460 +-------+------+------+------+
461 | 3 | VOID | TCP | VOID |
462 +-------+------+------+------+
463 | 4 | VOID | VOID | ICMP |
464 +-------+------+------+------+
466 +-------+--------------------+
471 Inverted matching, i.e. process packets that do not match the pattern.
473 - ``spec``, ``last`` and ``mask`` are ignored.
475 .. _table_rte_flow_item_invert:
479 +----------+---------+
481 +==========+=========+
482 | ``spec`` | ignored |
483 +----------+---------+
484 | ``last`` | ignored |
485 +----------+---------+
486 | ``mask`` | ignored |
487 +----------+---------+
489 Usage example, matching non-TCPv4 packets only:
491 .. _table_rte_flow_item_invert_example:
493 .. table:: Anything but TCPv4
512 Matches traffic originating from (ingress) or going to (egress) the physical
513 function of the current device.
515 If supported, should work even if the physical function is not managed by
516 the application and thus not associated with a DPDK port ID.
518 - Can be combined with any number of `Item: VF`_ to match both PF and VF
520 - ``spec``, ``last`` and ``mask`` must not be set.
522 .. _table_rte_flow_item_pf:
539 Matches traffic originating from (ingress) or going to (egress) a given
540 virtual function of the current device.
542 If supported, should work even if the virtual function is not managed by the
543 application and thus not associated with a DPDK port ID.
545 Note this pattern item does not match VF representors traffic which, as
546 separate entities, should be addressed through their own DPDK port IDs.
548 - Can be specified multiple times to match traffic addressed to several VF
550 - Can be combined with a PF item to match both PF and VF traffic.
551 - Default ``mask`` matches any VF ID.
553 .. _table_rte_flow_item_vf:
557 +----------+----------+---------------------------+
558 | Field | Subfield | Value |
559 +==========+==========+===========================+
560 | ``spec`` | ``id`` | destination VF ID |
561 +----------+----------+---------------------------+
562 | ``last`` | ``id`` | upper range value |
563 +----------+----------+---------------------------+
564 | ``mask`` | ``id`` | zeroed to match any VF ID |
565 +----------+----------+---------------------------+
570 Matches traffic originating from (ingress) or going to (egress) a physical
571 port of the underlying device.
573 The first PHY_PORT item overrides the physical port normally associated with
574 the specified DPDK input port (port_id). This item can be provided several
575 times to match additional physical ports.
577 Note that physical ports are not necessarily tied to DPDK input ports
578 (port_id) when those are not under DPDK control. Possible values are
579 specific to each device, they are not necessarily indexed from zero and may
582 As a device property, the list of allowed values as well as the value
583 associated with a port_id should be retrieved by other means.
585 - Default ``mask`` matches any port index.
587 .. _table_rte_flow_item_phy_port:
591 +----------+-----------+--------------------------------+
592 | Field | Subfield | Value |
593 +==========+===========+================================+
594 | ``spec`` | ``index`` | physical port index |
595 +----------+-----------+--------------------------------+
596 | ``last`` | ``index`` | upper range value |
597 +----------+-----------+--------------------------------+
598 | ``mask`` | ``index`` | zeroed to match any port index |
599 +----------+-----------+--------------------------------+
604 Matches traffic originating from (ingress) or going to (egress) a given DPDK
607 Normally only supported if the port ID in question is known by the
608 underlying PMD and related to the device the flow rule is created against.
610 This must not be confused with `Item: PHY_PORT`_ which refers to the
611 physical port of a device, whereas `Item: PORT_ID`_ refers to a ``struct
612 rte_eth_dev`` object on the application side (also known as "port
613 representor" depending on the kind of underlying device).
615 - Default ``mask`` matches the specified DPDK port ID.
617 .. _table_rte_flow_item_port_id:
621 +----------+----------+-----------------------------+
622 | Field | Subfield | Value |
623 +==========+==========+=============================+
624 | ``spec`` | ``id`` | DPDK port ID |
625 +----------+----------+-----------------------------+
626 | ``last`` | ``id`` | upper range value |
627 +----------+----------+-----------------------------+
628 | ``mask`` | ``id`` | zeroed to match any port ID |
629 +----------+----------+-----------------------------+
634 Matches an arbitrary integer value which was set using the ``MARK`` action in
635 a previously matched rule.
637 This item can only specified once as a match criteria as the ``MARK`` action can
638 only be specified once in a flow action.
640 Note the value of MARK field is arbitrary and application defined.
642 Depending on the underlying implementation the MARK item may be supported on
643 the physical device, with virtual groups in the PMD or not at all.
645 - Default ``mask`` matches any integer value.
647 .. _table_rte_flow_item_mark:
651 +----------+----------+---------------------------+
652 | Field | Subfield | Value |
653 +==========+==========+===========================+
654 | ``spec`` | ``id`` | integer value |
655 +----------+--------------------------------------+
656 | ``last`` | ``id`` | upper range value |
657 +----------+----------+---------------------------+
658 | ``mask`` | ``id`` | zeroed to match any value |
659 +----------+----------+---------------------------+
664 Matches tag item set by other flows. Multiple tags are supported by specifying
667 - Default ``mask`` matches the specified tag value and index.
669 .. _table_rte_flow_item_tag:
673 +----------+----------+----------------------------------------+
674 | Field | Subfield | Value |
675 +==========+===========+=======================================+
676 | ``spec`` | ``data`` | 32 bit flow tag value |
677 | +-----------+---------------------------------------+
678 | | ``index`` | index of flow tag |
679 +----------+-----------+---------------------------------------+
680 | ``last`` | ``data`` | upper range value |
681 | +-----------+---------------------------------------+
682 | | ``index`` | field is ignored |
683 +----------+-----------+---------------------------------------+
684 | ``mask`` | ``data`` | bit-mask applies to "spec" and "last" |
685 | +-----------+---------------------------------------+
686 | | ``index`` | field is ignored |
687 +----------+-----------+---------------------------------------+
692 Matches 32 bit metadata item set.
694 On egress, metadata can be set either by mbuf metadata field with
695 PKT_TX_DYNF_METADATA flag or ``SET_META`` action. On ingress, ``SET_META``
696 action sets metadata for a packet and the metadata will be reported via
697 ``metadata`` dynamic field of ``rte_mbuf`` with PKT_RX_DYNF_METADATA flag.
699 - Default ``mask`` matches the specified Rx metadata value.
701 .. _table_rte_flow_item_meta:
705 +----------+----------+---------------------------------------+
706 | Field | Subfield | Value |
707 +==========+==========+=======================================+
708 | ``spec`` | ``data`` | 32 bit metadata value |
709 +----------+----------+---------------------------------------+
710 | ``last`` | ``data`` | upper range value |
711 +----------+----------+---------------------------------------+
712 | ``mask`` | ``data`` | bit-mask applies to "spec" and "last" |
713 +----------+----------+---------------------------------------+
715 Data matching item types
716 ~~~~~~~~~~~~~~~~~~~~~~~~
718 Most of these are basically protocol header definitions with associated
719 bit-masks. They must be specified (stacked) from lowest to highest protocol
720 layer to form a matching pattern.
722 The following list is not exhaustive, new protocols will be added in the
728 Matches any protocol in place of the current layer, a single ANY may also
729 stand for several protocol layers.
731 This is usually specified as the first pattern item when looking for a
732 protocol anywhere in a packet.
734 - Default ``mask`` stands for any number of layers.
736 .. _table_rte_flow_item_any:
740 +----------+----------+--------------------------------------+
741 | Field | Subfield | Value |
742 +==========+==========+======================================+
743 | ``spec`` | ``num`` | number of layers covered |
744 +----------+----------+--------------------------------------+
745 | ``last`` | ``num`` | upper range value |
746 +----------+----------+--------------------------------------+
747 | ``mask`` | ``num`` | zeroed to cover any number of layers |
748 +----------+----------+--------------------------------------+
750 Example for VXLAN TCP payload matching regardless of outer L3 (IPv4 or IPv6)
751 and L4 (UDP) both matched by the first ANY specification, and inner L3 (IPv4
752 or IPv6) matched by the second ANY specification:
754 .. _table_rte_flow_item_any_example:
756 .. table:: TCP in VXLAN with wildcards
758 +-------+------+----------+----------+-------+
759 | Index | Item | Field | Subfield | Value |
760 +=======+======+==========+==========+=======+
762 +-------+------+----------+----------+-------+
763 | 1 | ANY | ``spec`` | ``num`` | 2 |
764 +-------+------+----------+----------+-------+
766 +-------+------------------------------------+
768 +-------+------+----------+----------+-------+
769 | 4 | ANY | ``spec`` | ``num`` | 1 |
770 +-------+------+----------+----------+-------+
772 +-------+------------------------------------+
774 +-------+------------------------------------+
779 Matches a byte string of a given length at a given offset.
781 Offset is either absolute (using the start of the packet) or relative to the
782 end of the previous matched item in the stack, in which case negative values
785 If search is enabled, offset is used as the starting point. The search area
786 can be delimited by setting limit to a nonzero value, which is the maximum
787 number of bytes after offset where the pattern may start.
789 Matching a zero-length pattern is allowed, doing so resets the relative
790 offset for subsequent items.
792 - This type does not support ranges (``last`` field).
793 - Default ``mask`` matches all fields exactly.
795 .. _table_rte_flow_item_raw:
799 +----------+--------------+-------------------------------------------------+
800 | Field | Subfield | Value |
801 +==========+==============+=================================================+
802 | ``spec`` | ``relative`` | look for pattern after the previous item |
803 | +--------------+-------------------------------------------------+
804 | | ``search`` | search pattern from offset (see also ``limit``) |
805 | +--------------+-------------------------------------------------+
806 | | ``reserved`` | reserved, must be set to zero |
807 | +--------------+-------------------------------------------------+
808 | | ``offset`` | absolute or relative offset for ``pattern`` |
809 | +--------------+-------------------------------------------------+
810 | | ``limit`` | search area limit for start of ``pattern`` |
811 | +--------------+-------------------------------------------------+
812 | | ``length`` | ``pattern`` length |
813 | +--------------+-------------------------------------------------+
814 | | ``pattern`` | byte string to look for |
815 +----------+--------------+-------------------------------------------------+
816 | ``last`` | if specified, either all 0 or with the same values as ``spec`` |
817 +----------+----------------------------------------------------------------+
818 | ``mask`` | bit-mask applied to ``spec`` values with usual behavior |
819 +----------+----------------------------------------------------------------+
821 Example pattern looking for several strings at various offsets of a UDP
822 payload, using combined RAW items:
824 .. _table_rte_flow_item_raw_example:
826 .. table:: UDP payload matching
828 +-------+------+----------+--------------+-------+
829 | Index | Item | Field | Subfield | Value |
830 +=======+======+==========+==============+=======+
832 +-------+----------------------------------------+
834 +-------+----------------------------------------+
836 +-------+------+----------+--------------+-------+
837 | 3 | RAW | ``spec`` | ``relative`` | 1 |
838 | | | +--------------+-------+
839 | | | | ``search`` | 1 |
840 | | | +--------------+-------+
841 | | | | ``offset`` | 10 |
842 | | | +--------------+-------+
843 | | | | ``limit`` | 0 |
844 | | | +--------------+-------+
845 | | | | ``length`` | 3 |
846 | | | +--------------+-------+
847 | | | | ``pattern`` | "foo" |
848 +-------+------+----------+--------------+-------+
849 | 4 | RAW | ``spec`` | ``relative`` | 1 |
850 | | | +--------------+-------+
851 | | | | ``search`` | 0 |
852 | | | +--------------+-------+
853 | | | | ``offset`` | 20 |
854 | | | +--------------+-------+
855 | | | | ``limit`` | 0 |
856 | | | +--------------+-------+
857 | | | | ``length`` | 3 |
858 | | | +--------------+-------+
859 | | | | ``pattern`` | "bar" |
860 +-------+------+----------+--------------+-------+
861 | 5 | RAW | ``spec`` | ``relative`` | 1 |
862 | | | +--------------+-------+
863 | | | | ``search`` | 0 |
864 | | | +--------------+-------+
865 | | | | ``offset`` | -29 |
866 | | | +--------------+-------+
867 | | | | ``limit`` | 0 |
868 | | | +--------------+-------+
869 | | | | ``length`` | 3 |
870 | | | +--------------+-------+
871 | | | | ``pattern`` | "baz" |
872 +-------+------+----------+--------------+-------+
874 +-------+----------------------------------------+
878 - Locate "foo" at least 10 bytes deep inside UDP payload.
879 - Locate "bar" after "foo" plus 20 bytes.
880 - Locate "baz" after "bar" minus 29 bytes.
882 Such a packet may be represented as follows (not to scale)::
885 | |<--------->| |<--------->|
887 |-----|------|-----|-----|-----|-----|-----------|-----|------|
888 | ETH | IPv4 | UDP | ... | baz | foo | ......... | bar | .... |
889 |-----|------|-----|-----|-----|-----|-----------|-----|------|
891 |<--------------------------->|
894 Note that matching subsequent pattern items would resume after "baz", not
895 "bar" since matching is always performed after the previous item of the
901 Matches an Ethernet header.
903 The ``type`` field either stands for "EtherType" or "TPID" when followed by
904 so-called layer 2.5 pattern items such as ``RTE_FLOW_ITEM_TYPE_VLAN``. In
905 the latter case, ``type`` refers to that of the outer header, with the inner
906 EtherType/TPID provided by the subsequent pattern item. This is the same
907 order as on the wire.
909 - ``dst``: destination MAC.
910 - ``src``: source MAC.
911 - ``type``: EtherType or TPID.
912 - Default ``mask`` matches destination and source addresses only.
917 Matches an 802.1Q/ad VLAN tag.
919 The corresponding standard outer EtherType (TPID) values are
920 ``RTE_ETHER_TYPE_VLAN`` or ``RTE_ETHER_TYPE_QINQ``. It can be overridden by the
921 preceding pattern item.
923 - ``tci``: tag control information.
924 - ``inner_type``: inner EtherType or TPID.
925 - Default ``mask`` matches the VID part of TCI only (lower 12 bits).
930 Matches an IPv4 header.
932 Note: IPv4 options are handled by dedicated pattern items.
934 - ``hdr``: IPv4 header definition (``rte_ip.h``).
935 - Default ``mask`` matches source and destination addresses only.
940 Matches an IPv6 header.
942 Note: IPv6 options are handled by dedicated pattern items, see `Item:
945 - ``hdr``: IPv6 header definition (``rte_ip.h``).
946 - Default ``mask`` matches source and destination addresses only.
951 Matches an ICMP header.
953 - ``hdr``: ICMP header definition (``rte_icmp.h``).
954 - Default ``mask`` matches ICMP type and code only.
959 Matches a UDP header.
961 - ``hdr``: UDP header definition (``rte_udp.h``).
962 - Default ``mask`` matches source and destination ports only.
967 Matches a TCP header.
969 - ``hdr``: TCP header definition (``rte_tcp.h``).
970 - Default ``mask`` matches source and destination ports only.
975 Matches a SCTP header.
977 - ``hdr``: SCTP header definition (``rte_sctp.h``).
978 - Default ``mask`` matches source and destination ports only.
983 Matches a VXLAN header (RFC 7348).
985 - ``flags``: normally 0x08 (I flag).
986 - ``rsvd0``: reserved, normally 0x000000.
987 - ``vni``: VXLAN network identifier.
988 - ``rsvd1``: reserved, normally 0x00.
989 - Default ``mask`` matches VNI only.
994 Matches an IEEE 802.1BR E-Tag header.
996 The corresponding standard outer EtherType (TPID) value is
997 ``RTE_ETHER_TYPE_ETAG``. It can be overridden by the preceding pattern item.
999 - ``epcp_edei_in_ecid_b``: E-Tag control information (E-TCI), E-PCP (3b),
1000 E-DEI (1b), ingress E-CID base (12b).
1001 - ``rsvd_grp_ecid_b``: reserved (2b), GRP (2b), E-CID base (12b).
1002 - ``in_ecid_e``: ingress E-CID ext.
1003 - ``ecid_e``: E-CID ext.
1004 - ``inner_type``: inner EtherType or TPID.
1005 - Default ``mask`` simultaneously matches GRP and E-CID base.
1010 Matches a NVGRE header (RFC 7637).
1012 - ``c_k_s_rsvd0_ver``: checksum (1b), undefined (1b), key bit (1b),
1013 sequence number (1b), reserved 0 (9b), version (3b). This field must have
1014 value 0x2000 according to RFC 7637.
1015 - ``protocol``: protocol type (0x6558).
1016 - ``tni``: virtual subnet ID.
1017 - ``flow_id``: flow ID.
1018 - Default ``mask`` matches TNI only.
1023 Matches a MPLS header.
1025 - ``label_tc_s_ttl``: label, TC, Bottom of Stack and TTL.
1026 - Default ``mask`` matches label only.
1031 Matches a GRE header.
1033 - ``c_rsvd0_ver``: checksum, reserved 0 and version.
1034 - ``protocol``: protocol type.
1035 - Default ``mask`` matches protocol only.
1040 Matches a GRE key field.
1041 This should be preceded by item ``GRE``.
1043 - Value to be matched is a big-endian 32 bit integer.
1044 - When this item present it implicitly match K bit in default mask as "1"
1049 Fuzzy pattern match, expect faster than default.
1051 This is for device that support fuzzy match option. Usually a fuzzy match is
1052 fast but the cost is accuracy. i.e. Signature Match only match pattern's hash
1053 value, but it is possible two different patterns have the same hash value.
1055 Matching accuracy level can be configured by threshold. Driver can divide the
1056 range of threshold and map to different accuracy levels that device support.
1058 Threshold 0 means perfect match (no fuzziness), while threshold 0xffffffff
1059 means fuzziest match.
1061 .. _table_rte_flow_item_fuzzy:
1065 +----------+---------------+--------------------------------------------------+
1066 | Field | Subfield | Value |
1067 +==========+===============+==================================================+
1068 | ``spec`` | ``threshold`` | 0 as perfect match, 0xffffffff as fuzziest match |
1069 +----------+---------------+--------------------------------------------------+
1070 | ``last`` | ``threshold`` | upper range value |
1071 +----------+---------------+--------------------------------------------------+
1072 | ``mask`` | ``threshold`` | bit-mask apply to "spec" and "last" |
1073 +----------+---------------+--------------------------------------------------+
1075 Usage example, fuzzy match a TCPv4 packets:
1077 .. _table_rte_flow_item_fuzzy_example:
1079 .. table:: Fuzzy matching
1081 +-------+----------+
1083 +=======+==========+
1085 +-------+----------+
1087 +-------+----------+
1089 +-------+----------+
1091 +-------+----------+
1093 +-------+----------+
1095 Item: ``GTP``, ``GTPC``, ``GTPU``
1096 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1098 Matches a GTPv1 header.
1100 Note: GTP, GTPC and GTPU use the same structure. GTPC and GTPU item
1101 are defined for a user-friendly API when creating GTP-C and GTP-U
1104 - ``v_pt_rsv_flags``: version (3b), protocol type (1b), reserved (1b),
1105 extension header flag (1b), sequence number flag (1b), N-PDU number
1107 - ``msg_type``: message type.
1108 - ``msg_len``: message length.
1109 - ``teid``: tunnel endpoint identifier.
1110 - Default ``mask`` matches teid only.
1115 Matches an ESP header.
1117 - ``hdr``: ESP header definition (``rte_esp.h``).
1118 - Default ``mask`` matches SPI only.
1123 Matches a GENEVE header.
1125 - ``ver_opt_len_o_c_rsvd0``: version (2b), length of the options fields (6b),
1126 OAM packet (1b), critical options present (1b), reserved 0 (6b).
1127 - ``protocol``: protocol type.
1128 - ``vni``: virtual network identifier.
1129 - ``rsvd1``: reserved, normally 0x00.
1130 - Default ``mask`` matches VNI only.
1135 Matches a VXLAN-GPE header (draft-ietf-nvo3-vxlan-gpe-05).
1137 - ``flags``: normally 0x0C (I and P flags).
1138 - ``rsvd0``: reserved, normally 0x0000.
1139 - ``protocol``: protocol type.
1140 - ``vni``: VXLAN network identifier.
1141 - ``rsvd1``: reserved, normally 0x00.
1142 - Default ``mask`` matches VNI only.
1144 Item: ``ARP_ETH_IPV4``
1145 ^^^^^^^^^^^^^^^^^^^^^^
1147 Matches an ARP header for Ethernet/IPv4.
1149 - ``hdr``: hardware type, normally 1.
1150 - ``pro``: protocol type, normally 0x0800.
1151 - ``hln``: hardware address length, normally 6.
1152 - ``pln``: protocol address length, normally 4.
1153 - ``op``: opcode (1 for request, 2 for reply).
1154 - ``sha``: sender hardware address.
1155 - ``spa``: sender IPv4 address.
1156 - ``tha``: target hardware address.
1157 - ``tpa``: target IPv4 address.
1158 - Default ``mask`` matches SHA, SPA, THA and TPA.
1163 Matches the presence of any IPv6 extension header.
1165 - ``next_hdr``: next header.
1166 - Default ``mask`` matches ``next_hdr``.
1168 Normally preceded by any of:
1176 Matches any ICMPv6 header.
1178 - ``type``: ICMPv6 type.
1179 - ``code``: ICMPv6 code.
1180 - ``checksum``: ICMPv6 checksum.
1181 - Default ``mask`` matches ``type`` and ``code``.
1183 Item: ``ICMP6_ND_NS``
1184 ^^^^^^^^^^^^^^^^^^^^^
1186 Matches an ICMPv6 neighbor discovery solicitation.
1188 - ``type``: ICMPv6 type, normally 135.
1189 - ``code``: ICMPv6 code, normally 0.
1190 - ``checksum``: ICMPv6 checksum.
1191 - ``reserved``: reserved, normally 0.
1192 - ``target_addr``: target address.
1193 - Default ``mask`` matches target address only.
1195 Item: ``ICMP6_ND_NA``
1196 ^^^^^^^^^^^^^^^^^^^^^
1198 Matches an ICMPv6 neighbor discovery advertisement.
1200 - ``type``: ICMPv6 type, normally 136.
1201 - ``code``: ICMPv6 code, normally 0.
1202 - ``checksum``: ICMPv6 checksum.
1203 - ``rso_reserved``: route flag (1b), solicited flag (1b), override flag
1204 (1b), reserved (29b).
1205 - ``target_addr``: target address.
1206 - Default ``mask`` matches target address only.
1208 Item: ``ICMP6_ND_OPT``
1209 ^^^^^^^^^^^^^^^^^^^^^^
1211 Matches the presence of any ICMPv6 neighbor discovery option.
1213 - ``type``: ND option type.
1214 - ``length``: ND option length.
1215 - Default ``mask`` matches type only.
1217 Normally preceded by any of:
1219 - `Item: ICMP6_ND_NA`_
1220 - `Item: ICMP6_ND_NS`_
1221 - `Item: ICMP6_ND_OPT`_
1223 Item: ``ICMP6_ND_OPT_SLA_ETH``
1224 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1226 Matches an ICMPv6 neighbor discovery source Ethernet link-layer address
1229 - ``type``: ND option type, normally 1.
1230 - ``length``: ND option length, normally 1.
1231 - ``sla``: source Ethernet LLA.
1232 - Default ``mask`` matches source link-layer address only.
1234 Normally preceded by any of:
1236 - `Item: ICMP6_ND_NA`_
1237 - `Item: ICMP6_ND_OPT`_
1239 Item: ``ICMP6_ND_OPT_TLA_ETH``
1240 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1242 Matches an ICMPv6 neighbor discovery target Ethernet link-layer address
1245 - ``type``: ND option type, normally 2.
1246 - ``length``: ND option length, normally 1.
1247 - ``tla``: target Ethernet LLA.
1248 - Default ``mask`` matches target link-layer address only.
1250 Normally preceded by any of:
1252 - `Item: ICMP6_ND_NS`_
1253 - `Item: ICMP6_ND_OPT`_
1258 Matches an application specific 32 bit metadata item.
1260 - Default ``mask`` matches the specified metadata value.
1265 Matches a GTP PDU extension header with type 0x85.
1267 - ``pdu_type``: PDU type.
1268 - ``qfi``: QoS flow identifier.
1269 - Default ``mask`` matches QFI only.
1271 Item: ``PPPOES``, ``PPPOED``
1272 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1274 Matches a PPPoE header.
1276 - ``version_type``: version (4b), type (4b).
1277 - ``code``: message type.
1278 - ``session_id``: session identifier.
1279 - ``length``: payload length.
1281 Item: ``PPPOE_PROTO_ID``
1282 ^^^^^^^^^^^^^^^^^^^^^^^^
1284 Matches a PPPoE session protocol identifier.
1286 - ``proto_id``: PPP protocol identifier.
1287 - Default ``mask`` matches proto_id only.
1292 Matches a network service header (RFC 8300).
1294 - ``version``: normally 0x0 (2 bits).
1295 - ``oam_pkt``: indicate oam packet (1 bit).
1296 - ``reserved``: reserved bit (1 bit).
1297 - ``ttl``: maximum SFF hopes (6 bits).
1298 - ``length``: total length in 4 bytes words (6 bits).
1299 - ``reserved1``: reserved1 bits (4 bits).
1300 - ``mdtype``: ndicates format of NSH header (4 bits).
1301 - ``next_proto``: indicates protocol type of encap data (8 bits).
1302 - ``spi``: service path identifier (3 bytes).
1303 - ``sindex``: service index (1 byte).
1304 - Default ``mask`` matches mdtype, next_proto, spi, sindex.
1310 Matches a Internet Group Management Protocol (RFC 2236).
1312 - ``type``: IGMP message type (Query/Report).
1313 - ``max_resp_time``: max time allowed before sending report.
1314 - ``checksum``: checksum, 1s complement of whole IGMP message.
1315 - ``group_addr``: group address, for Query value will be 0.
1316 - Default ``mask`` matches group_addr.
1322 Matches a IP Authentication Header (RFC 4302).
1324 - ``next_hdr``: next payload after AH.
1325 - ``payload_len``: total length of AH in 4B words.
1326 - ``reserved``: reserved bits.
1327 - ``spi``: security parameters index.
1328 - ``seq_num``: counter value increased by 1 on each packet sent.
1329 - Default ``mask`` matches spi.
1334 Matches a HIGIG2 header field. It is layer 2.5 protocol and used in
1337 - Default ``mask`` matches classification and vlan.
1342 Matches a L2TPv3 over IP header.
1344 - ``session_id``: L2TPv3 over IP session identifier.
1345 - Default ``mask`` matches session_id only.
1350 Matches a PFCP Header.
1352 - ``s_field``: S field.
1353 - ``msg_type``: message type.
1354 - ``msg_len``: message length.
1355 - ``seid``: session endpoint identifier.
1356 - Default ``mask`` matches s_field and seid.
1361 Each possible action is represented by a type.
1362 An action can have an associated configuration object.
1363 Several actions combined in a list can be assigned
1364 to a flow rule and are performed in order.
1366 They fall in three categories:
1368 - Actions that modify the fate of matching traffic, for instance by dropping
1369 or assigning it a specific destination.
1371 - Actions that modify matching traffic contents or its properties. This
1372 includes adding/removing encapsulation, encryption, compression and marks.
1374 - Actions related to the flow rule itself, such as updating counters or
1375 making it non-terminating.
1377 Flow rules being terminating by default, not specifying any action of the
1378 fate kind results in undefined behavior. This applies to both ingress and
1381 PASSTHRU, when supported, makes a flow rule non-terminating.
1383 Like matching patterns, action lists are terminated by END items.
1385 Example of action that redirects packets to queue index 10:
1387 .. _table_rte_flow_action_example:
1389 .. table:: Queue action
1391 +-----------+-------+
1393 +===========+=======+
1395 +-----------+-------+
1397 Actions are performed in list order:
1399 .. _table_rte_flow_count_then_drop:
1401 .. table:: Count then drop
1415 .. _table_rte_flow_mark_count_redirect:
1417 .. table:: Mark, count then redirect
1419 +-------+--------+------------+-------+
1420 | Index | Action | Field | Value |
1421 +=======+========+============+=======+
1422 | 0 | MARK | ``mark`` | 0x2a |
1423 +-------+--------+------------+-------+
1424 | 1 | COUNT | ``shared`` | 0 |
1425 | | +------------+-------+
1427 +-------+--------+------------+-------+
1428 | 2 | QUEUE | ``queue`` | 10 |
1429 +-------+--------+------------+-------+
1431 +-------+-----------------------------+
1435 .. _table_rte_flow_redirect_queue_5:
1437 .. table:: Redirect to queue 5
1439 +-------+--------+-----------+-------+
1440 | Index | Action | Field | Value |
1441 +=======+========+===========+=======+
1443 +-------+--------+-----------+-------+
1444 | 1 | QUEUE | ``queue`` | 5 |
1445 +-------+--------+-----------+-------+
1447 +-------+----------------------------+
1449 In the above example, while DROP and QUEUE must be performed in order, both
1450 have to happen before reaching END. Only QUEUE has a visible effect.
1452 Note that such a list may be thought as ambiguous and rejected on that
1455 .. _table_rte_flow_redirect_queue_5_3:
1457 .. table:: Redirect to queues 5 and 3
1459 +-------+--------+-----------+-------+
1460 | Index | Action | Field | Value |
1461 +=======+========+===========+=======+
1462 | 0 | QUEUE | ``queue`` | 5 |
1463 +-------+--------+-----------+-------+
1465 +-------+--------+-----------+-------+
1466 | 2 | QUEUE | ``queue`` | 3 |
1467 +-------+--------+-----------+-------+
1469 +-------+----------------------------+
1471 As previously described, all actions must be taken into account. This
1472 effectively duplicates traffic to both queues. The above example also shows
1473 that VOID is ignored.
1478 Common action types are described in this section. Like pattern item types,
1479 this list is not exhaustive as new actions will be added in the future.
1484 End marker for action lists. Prevents further processing of actions, thereby
1487 - Its numeric value is 0 for convenience.
1488 - PMD support is mandatory.
1489 - No configurable properties.
1491 .. _table_rte_flow_action_end:
1504 Used as a placeholder for convenience. It is ignored and simply discarded by
1507 - PMD support is mandatory.
1508 - No configurable properties.
1510 .. _table_rte_flow_action_void:
1520 Action: ``PASSTHRU``
1521 ^^^^^^^^^^^^^^^^^^^^
1523 Leaves traffic up for additional processing by subsequent flow rules; makes
1524 a flow rule non-terminating.
1526 - No configurable properties.
1528 .. _table_rte_flow_action_passthru:
1538 Example to copy a packet to a queue and continue processing by subsequent
1541 .. _table_rte_flow_action_passthru_example:
1543 .. table:: Copy to queue 8
1545 +-------+--------+-----------+-------+
1546 | Index | Action | Field | Value |
1547 +=======+========+===========+=======+
1549 +-------+--------+-----------+-------+
1550 | 1 | QUEUE | ``queue`` | 8 |
1551 +-------+--------+-----------+-------+
1553 +-------+----------------------------+
1558 Redirects packets to a group on the current device.
1560 In a hierarchy of groups, which can be used to represent physical or logical
1561 flow group/tables on the device, this action redirects the matched flow to
1562 the specified group on that device.
1564 If a matched flow is redirected to a table which doesn't contain a matching
1565 rule for that flow then the behavior is undefined and the resulting behavior
1566 is up to the specific device. Best practice when using groups would be define
1567 a default flow rule for each group which a defines the default actions in that
1568 group so a consistent behavior is defined.
1570 Defining an action for matched flow in a group to jump to a group which is
1571 higher in the group hierarchy may not be supported by physical devices,
1572 depending on how groups are mapped to the physical devices. In the
1573 definitions of jump actions, applications should be aware that it may be
1574 possible to define flow rules which trigger an undefined behavior causing
1575 flows to loop between groups.
1577 .. _table_rte_flow_action_jump:
1581 +-----------+------------------------------+
1583 +===========+==============================+
1584 | ``group`` | Group to redirect packets to |
1585 +-----------+------------------------------+
1590 Attaches an integer value to packets and sets ``PKT_RX_FDIR`` and
1591 ``PKT_RX_FDIR_ID`` mbuf flags.
1593 This value is arbitrary and application-defined. Maximum allowed value
1594 depends on the underlying implementation. It is returned in the
1595 ``hash.fdir.hi`` mbuf field.
1597 .. _table_rte_flow_action_mark:
1601 +--------+--------------------------------------+
1603 +========+======================================+
1604 | ``id`` | integer value to return with packets |
1605 +--------+--------------------------------------+
1610 Flags packets. Similar to `Action: MARK`_ without a specific value; only
1611 sets the ``PKT_RX_FDIR`` mbuf flag.
1613 - No configurable properties.
1615 .. _table_rte_flow_action_flag:
1628 Assigns packets to a given queue index.
1630 .. _table_rte_flow_action_queue:
1634 +-----------+--------------------+
1636 +===========+====================+
1637 | ``index`` | queue index to use |
1638 +-----------+--------------------+
1645 - No configurable properties.
1647 .. _table_rte_flow_action_drop:
1660 Adds a counter action to a matched flow.
1662 If more than one count action is specified in a single flow rule, then each
1663 action must specify a unique id.
1665 Counters can be retrieved and reset through ``rte_flow_query()``, see
1666 ``struct rte_flow_query_count``.
1668 The shared flag indicates whether the counter is unique to the flow rule the
1669 action is specified with, or whether it is a shared counter.
1671 For a count action with the shared flag set, then a global device
1672 namespace is assumed for the counter id, so that any matched flow rules using
1673 a count action with the same counter id on the same port will contribute to
1676 For ports within the same switch domain then the counter id namespace extends
1677 to all ports within that switch domain.
1679 .. _table_rte_flow_action_count:
1683 +------------+---------------------+
1685 +============+=====================+
1686 | ``shared`` | shared counter flag |
1687 +------------+---------------------+
1688 | ``id`` | counter id |
1689 +------------+---------------------+
1691 Query structure to retrieve and reset flow rule counters:
1693 .. _table_rte_flow_query_count:
1695 .. table:: COUNT query
1697 +---------------+-----+-----------------------------------+
1698 | Field | I/O | Value |
1699 +===============+=====+===================================+
1700 | ``reset`` | in | reset counter after query |
1701 +---------------+-----+-----------------------------------+
1702 | ``hits_set`` | out | ``hits`` field is set |
1703 +---------------+-----+-----------------------------------+
1704 | ``bytes_set`` | out | ``bytes`` field is set |
1705 +---------------+-----+-----------------------------------+
1706 | ``hits`` | out | number of hits for this rule |
1707 +---------------+-----+-----------------------------------+
1708 | ``bytes`` | out | number of bytes through this rule |
1709 +---------------+-----+-----------------------------------+
1714 Similar to QUEUE, except RSS is additionally performed on packets to spread
1715 them among several queues according to the provided parameters.
1717 Unlike global RSS settings used by other DPDK APIs, unsetting the ``types``
1718 field does not disable RSS in a flow rule. Doing so instead requests safe
1719 unspecified "best-effort" settings from the underlying PMD, which depending
1720 on the flow rule, may result in anything ranging from empty (single queue)
1721 to all-inclusive RSS.
1723 Note: RSS hash result is stored in the ``hash.rss`` mbuf field which
1724 overlaps ``hash.fdir.lo``. Since `Action: MARK`_ sets the ``hash.fdir.hi``
1725 field only, both can be requested simultaneously.
1727 Also, regarding packet encapsulation ``level``:
1729 - ``0`` requests the default behavior. Depending on the packet type, it can
1730 mean outermost, innermost, anything in between or even no RSS.
1732 It basically stands for the innermost encapsulation level RSS can be
1733 performed on according to PMD and device capabilities.
1735 - ``1`` requests RSS to be performed on the outermost packet encapsulation
1738 - ``2`` and subsequent values request RSS to be performed on the specified
1739 inner packet encapsulation level, from outermost to innermost (lower to
1742 Values other than ``0`` are not necessarily supported.
1744 Requesting a specific RSS level on unrecognized traffic results in undefined
1745 behavior. For predictable results, it is recommended to make the flow rule
1746 pattern match packet headers up to the requested encapsulation level so that
1747 only matching traffic goes through.
1749 .. _table_rte_flow_action_rss:
1753 +---------------+---------------------------------------------+
1755 +===============+=============================================+
1756 | ``func`` | RSS hash function to apply |
1757 +---------------+---------------------------------------------+
1758 | ``level`` | encapsulation level for ``types`` |
1759 +---------------+---------------------------------------------+
1760 | ``types`` | specific RSS hash types (see ``ETH_RSS_*``) |
1761 +---------------+---------------------------------------------+
1762 | ``key_len`` | hash key length in bytes |
1763 +---------------+---------------------------------------------+
1764 | ``queue_num`` | number of entries in ``queue`` |
1765 +---------------+---------------------------------------------+
1766 | ``key`` | hash key |
1767 +---------------+---------------------------------------------+
1768 | ``queue`` | queue indices to use |
1769 +---------------+---------------------------------------------+
1774 Directs matching traffic to the physical function (PF) of the current
1779 - No configurable properties.
1781 .. _table_rte_flow_action_pf:
1794 Directs matching traffic to a given virtual function of the current device.
1796 Packets matched by a VF pattern item can be redirected to their original VF
1797 ID instead of the specified one. This parameter may not be available and is
1798 not guaranteed to work properly if the VF part is matched by a prior flow
1799 rule or if packets are not addressed to a VF in the first place.
1803 .. _table_rte_flow_action_vf:
1807 +--------------+--------------------------------+
1809 +==============+================================+
1810 | ``original`` | use original VF ID if possible |
1811 +--------------+--------------------------------+
1813 +--------------+--------------------------------+
1815 Action: ``PHY_PORT``
1816 ^^^^^^^^^^^^^^^^^^^^
1818 Directs matching traffic to a given physical port index of the underlying
1821 See `Item: PHY_PORT`_.
1823 .. _table_rte_flow_action_phy_port:
1827 +--------------+-------------------------------------+
1829 +==============+=====================================+
1830 | ``original`` | use original port index if possible |
1831 +--------------+-------------------------------------+
1832 | ``index`` | physical port index |
1833 +--------------+-------------------------------------+
1837 Directs matching traffic to a given DPDK port ID.
1839 See `Item: PORT_ID`_.
1841 .. _table_rte_flow_action_port_id:
1845 +--------------+---------------------------------------+
1847 +==============+=======================================+
1848 | ``original`` | use original DPDK port ID if possible |
1849 +--------------+---------------------------------------+
1850 | ``id`` | DPDK port ID |
1851 +--------------+---------------------------------------+
1856 Applies a stage of metering and policing.
1858 The metering and policing (MTR) object has to be first created using the
1859 rte_mtr_create() API function. The ID of the MTR object is specified as
1860 action parameter. More than one flow can use the same MTR object through
1861 the meter action. The MTR object can be further updated or queried using
1864 .. _table_rte_flow_action_meter:
1868 +--------------+---------------+
1870 +==============+===============+
1871 | ``mtr_id`` | MTR object ID |
1872 +--------------+---------------+
1874 Action: ``SECURITY``
1875 ^^^^^^^^^^^^^^^^^^^^
1877 Perform the security action on flows matched by the pattern items
1878 according to the configuration of the security session.
1880 This action modifies the payload of matched flows. For INLINE_CRYPTO, the
1881 security protocol headers and IV are fully provided by the application as
1882 specified in the flow pattern. The payload of matching packets is
1883 encrypted on egress, and decrypted and authenticated on ingress.
1884 For INLINE_PROTOCOL, the security protocol is fully offloaded to HW,
1885 providing full encapsulation and decapsulation of packets in security
1886 protocols. The flow pattern specifies both the outer security header fields
1887 and the inner packet fields. The security session specified in the action
1888 must match the pattern parameters.
1890 The security session specified in the action must be created on the same
1891 port as the flow action that is being specified.
1893 The ingress/egress flow attribute should match that specified in the
1894 security session if the security session supports the definition of the
1897 Multiple flows can be configured to use the same security session.
1899 .. _table_rte_flow_action_security:
1903 +----------------------+--------------------------------------+
1905 +======================+======================================+
1906 | ``security_session`` | security session to apply |
1907 +----------------------+--------------------------------------+
1909 The following is an example of configuring IPsec inline using the
1910 INLINE_CRYPTO security session:
1912 The encryption algorithm, keys and salt are part of the opaque
1913 ``rte_security_session``. The SA is identified according to the IP and ESP
1914 fields in the pattern items.
1916 .. _table_rte_flow_item_esp_inline_example:
1918 .. table:: IPsec inline crypto flow pattern items.
1920 +-------+----------+
1922 +=======+==========+
1924 +-------+----------+
1926 +-------+----------+
1928 +-------+----------+
1930 +-------+----------+
1932 .. _table_rte_flow_action_esp_inline_example:
1934 .. table:: IPsec inline flow actions.
1936 +-------+----------+
1938 +=======+==========+
1940 +-------+----------+
1942 +-------+----------+
1944 Action: ``OF_SET_MPLS_TTL``
1945 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
1947 Implements ``OFPAT_SET_MPLS_TTL`` ("MPLS TTL") as defined by the `OpenFlow
1948 Switch Specification`_.
1950 .. _table_rte_flow_action_of_set_mpls_ttl:
1952 .. table:: OF_SET_MPLS_TTL
1954 +--------------+----------+
1956 +==============+==========+
1957 | ``mpls_ttl`` | MPLS TTL |
1958 +--------------+----------+
1960 Action: ``OF_DEC_MPLS_TTL``
1961 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
1963 Implements ``OFPAT_DEC_MPLS_TTL`` ("decrement MPLS TTL") as defined by the
1964 `OpenFlow Switch Specification`_.
1966 .. _table_rte_flow_action_of_dec_mpls_ttl:
1968 .. table:: OF_DEC_MPLS_TTL
1976 Action: ``OF_SET_NW_TTL``
1977 ^^^^^^^^^^^^^^^^^^^^^^^^^
1979 Implements ``OFPAT_SET_NW_TTL`` ("IP TTL") as defined by the `OpenFlow
1980 Switch Specification`_.
1982 .. _table_rte_flow_action_of_set_nw_ttl:
1984 .. table:: OF_SET_NW_TTL
1986 +------------+--------+
1988 +============+========+
1989 | ``nw_ttl`` | IP TTL |
1990 +------------+--------+
1992 Action: ``OF_DEC_NW_TTL``
1993 ^^^^^^^^^^^^^^^^^^^^^^^^^
1995 Implements ``OFPAT_DEC_NW_TTL`` ("decrement IP TTL") as defined by the
1996 `OpenFlow Switch Specification`_.
1998 .. _table_rte_flow_action_of_dec_nw_ttl:
2000 .. table:: OF_DEC_NW_TTL
2008 Action: ``OF_COPY_TTL_OUT``
2009 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
2011 Implements ``OFPAT_COPY_TTL_OUT`` ("copy TTL "outwards" -- from
2012 next-to-outermost to outermost") as defined by the `OpenFlow Switch
2015 .. _table_rte_flow_action_of_copy_ttl_out:
2017 .. table:: OF_COPY_TTL_OUT
2025 Action: ``OF_COPY_TTL_IN``
2026 ^^^^^^^^^^^^^^^^^^^^^^^^^^
2028 Implements ``OFPAT_COPY_TTL_IN`` ("copy TTL "inwards" -- from outermost to
2029 next-to-outermost") as defined by the `OpenFlow Switch Specification`_.
2031 .. _table_rte_flow_action_of_copy_ttl_in:
2033 .. table:: OF_COPY_TTL_IN
2041 Action: ``OF_POP_VLAN``
2042 ^^^^^^^^^^^^^^^^^^^^^^^
2044 Implements ``OFPAT_POP_VLAN`` ("pop the outer VLAN tag") as defined
2045 by the `OpenFlow Switch Specification`_.
2047 .. _table_rte_flow_action_of_pop_vlan:
2049 .. table:: OF_POP_VLAN
2057 Action: ``OF_PUSH_VLAN``
2058 ^^^^^^^^^^^^^^^^^^^^^^^^
2060 Implements ``OFPAT_PUSH_VLAN`` ("push a new VLAN tag") as defined by the
2061 `OpenFlow Switch Specification`_.
2063 .. _table_rte_flow_action_of_push_vlan:
2065 .. table:: OF_PUSH_VLAN
2067 +---------------+-----------+
2069 +===============+===========+
2070 | ``ethertype`` | EtherType |
2071 +---------------+-----------+
2073 Action: ``OF_SET_VLAN_VID``
2074 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
2076 Implements ``OFPAT_SET_VLAN_VID`` ("set the 802.1q VLAN id") as defined by
2077 the `OpenFlow Switch Specification`_.
2079 .. _table_rte_flow_action_of_set_vlan_vid:
2081 .. table:: OF_SET_VLAN_VID
2083 +--------------+---------+
2085 +==============+=========+
2086 | ``vlan_vid`` | VLAN id |
2087 +--------------+---------+
2089 Action: ``OF_SET_VLAN_PCP``
2090 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
2092 Implements ``OFPAT_SET_LAN_PCP`` ("set the 802.1q priority") as defined by
2093 the `OpenFlow Switch Specification`_.
2095 .. _table_rte_flow_action_of_set_vlan_pcp:
2097 .. table:: OF_SET_VLAN_PCP
2099 +--------------+---------------+
2101 +==============+===============+
2102 | ``vlan_pcp`` | VLAN priority |
2103 +--------------+---------------+
2105 Action: ``OF_POP_MPLS``
2106 ^^^^^^^^^^^^^^^^^^^^^^^
2108 Implements ``OFPAT_POP_MPLS`` ("pop the outer MPLS tag") as defined by the
2109 `OpenFlow Switch Specification`_.
2111 .. _table_rte_flow_action_of_pop_mpls:
2113 .. table:: OF_POP_MPLS
2115 +---------------+-----------+
2117 +===============+===========+
2118 | ``ethertype`` | EtherType |
2119 +---------------+-----------+
2121 Action: ``OF_PUSH_MPLS``
2122 ^^^^^^^^^^^^^^^^^^^^^^^^
2124 Implements ``OFPAT_PUSH_MPLS`` ("push a new MPLS tag") as defined by the
2125 `OpenFlow Switch Specification`_.
2127 .. _table_rte_flow_action_of_push_mpls:
2129 .. table:: OF_PUSH_MPLS
2131 +---------------+-----------+
2133 +===============+===========+
2134 | ``ethertype`` | EtherType |
2135 +---------------+-----------+
2137 Action: ``VXLAN_ENCAP``
2138 ^^^^^^^^^^^^^^^^^^^^^^^
2140 Performs a VXLAN encapsulation action by encapsulating the matched flow in the
2141 VXLAN tunnel as defined in the``rte_flow_action_vxlan_encap`` flow items
2144 This action modifies the payload of matched flows. The flow definition specified
2145 in the ``rte_flow_action_tunnel_encap`` action structure must define a valid
2146 VLXAN network overlay which conforms with RFC 7348 (Virtual eXtensible Local
2147 Area Network (VXLAN): A Framework for Overlaying Virtualized Layer 2 Networks
2148 over Layer 3 Networks). The pattern must be terminated with the
2149 RTE_FLOW_ITEM_TYPE_END item type.
2151 .. _table_rte_flow_action_vxlan_encap:
2153 .. table:: VXLAN_ENCAP
2155 +----------------+-------------------------------------+
2157 +================+=====================================+
2158 | ``definition`` | Tunnel end-point overlay definition |
2159 +----------------+-------------------------------------+
2161 .. _table_rte_flow_action_vxlan_encap_example:
2163 .. table:: IPv4 VxLAN flow pattern example.
2165 +-------+----------+
2167 +=======+==========+
2169 +-------+----------+
2171 +-------+----------+
2173 +-------+----------+
2175 +-------+----------+
2177 +-------+----------+
2179 Action: ``VXLAN_DECAP``
2180 ^^^^^^^^^^^^^^^^^^^^^^^
2182 Performs a decapsulation action by stripping all headers of the VXLAN tunnel
2183 network overlay from the matched flow.
2185 The flow items pattern defined for the flow rule with which a ``VXLAN_DECAP``
2186 action is specified, must define a valid VXLAN tunnel as per RFC7348. If the
2187 flow pattern does not specify a valid VXLAN tunnel then a
2188 RTE_FLOW_ERROR_TYPE_ACTION error should be returned.
2190 This action modifies the payload of matched flows.
2192 Action: ``NVGRE_ENCAP``
2193 ^^^^^^^^^^^^^^^^^^^^^^^
2195 Performs a NVGRE encapsulation action by encapsulating the matched flow in the
2196 NVGRE tunnel as defined in the``rte_flow_action_tunnel_encap`` flow item
2199 This action modifies the payload of matched flows. The flow definition specified
2200 in the ``rte_flow_action_tunnel_encap`` action structure must defined a valid
2201 NVGRE network overlay which conforms with RFC 7637 (NVGRE: Network
2202 Virtualization Using Generic Routing Encapsulation). The pattern must be
2203 terminated with the RTE_FLOW_ITEM_TYPE_END item type.
2205 .. _table_rte_flow_action_nvgre_encap:
2207 .. table:: NVGRE_ENCAP
2209 +----------------+-------------------------------------+
2211 +================+=====================================+
2212 | ``definition`` | NVGRE end-point overlay definition |
2213 +----------------+-------------------------------------+
2215 .. _table_rte_flow_action_nvgre_encap_example:
2217 .. table:: IPv4 NVGRE flow pattern example.
2219 +-------+----------+
2221 +=======+==========+
2223 +-------+----------+
2225 +-------+----------+
2227 +-------+----------+
2229 +-------+----------+
2231 Action: ``NVGRE_DECAP``
2232 ^^^^^^^^^^^^^^^^^^^^^^^
2234 Performs a decapsulation action by stripping all headers of the NVGRE tunnel
2235 network overlay from the matched flow.
2237 The flow items pattern defined for the flow rule with which a ``NVGRE_DECAP``
2238 action is specified, must define a valid NVGRE tunnel as per RFC7637. If the
2239 flow pattern does not specify a valid NVGRE tunnel then a
2240 RTE_FLOW_ERROR_TYPE_ACTION error should be returned.
2242 This action modifies the payload of matched flows.
2244 Action: ``RAW_ENCAP``
2245 ^^^^^^^^^^^^^^^^^^^^^
2247 Adds outer header whose template is provided in its data buffer,
2248 as defined in the ``rte_flow_action_raw_encap`` definition.
2250 This action modifies the payload of matched flows. The data supplied must
2251 be a valid header, either holding layer 2 data in case of adding layer 2 after
2252 decap layer 3 tunnel (for example MPLSoGRE) or complete tunnel definition
2253 starting from layer 2 and moving to the tunnel item itself. When applied to
2254 the original packet the resulting packet must be a valid packet.
2256 .. _table_rte_flow_action_raw_encap:
2258 .. table:: RAW_ENCAP
2260 +----------------+----------------------------------------+
2262 +================+========================================+
2263 | ``data`` | Encapsulation data |
2264 +----------------+----------------------------------------+
2265 | ``preserve`` | Bit-mask of data to preserve on output |
2266 +----------------+----------------------------------------+
2267 | ``size`` | Size of data and preserve |
2268 +----------------+----------------------------------------+
2270 Action: ``RAW_DECAP``
2271 ^^^^^^^^^^^^^^^^^^^^^^^
2273 Remove outer header whose template is provided in its data buffer,
2274 as defined in the ``rte_flow_action_raw_decap``
2276 This action modifies the payload of matched flows. The data supplied must
2277 be a valid header, either holding layer 2 data in case of removing layer 2
2278 before encapsulation of layer 3 tunnel (for example MPLSoGRE) or complete
2279 tunnel definition starting from layer 2 and moving to the tunnel item itself.
2280 When applied to the original packet the resulting packet must be a
2283 .. _table_rte_flow_action_raw_decap:
2285 .. table:: RAW_DECAP
2287 +----------------+----------------------------------------+
2289 +================+========================================+
2290 | ``data`` | Decapsulation data |
2291 +----------------+----------------------------------------+
2292 | ``size`` | Size of data |
2293 +----------------+----------------------------------------+
2295 Action: ``SET_IPV4_SRC``
2296 ^^^^^^^^^^^^^^^^^^^^^^^^
2298 Set a new IPv4 source address in the outermost IPv4 header.
2300 It must be used with a valid RTE_FLOW_ITEM_TYPE_IPV4 flow pattern item.
2301 Otherwise, RTE_FLOW_ERROR_TYPE_ACTION error will be returned.
2303 .. _table_rte_flow_action_set_ipv4_src:
2305 .. table:: SET_IPV4_SRC
2307 +-----------------------------------------+
2309 +===============+=========================+
2310 | ``ipv4_addr`` | new IPv4 source address |
2311 +---------------+-------------------------+
2313 Action: ``SET_IPV4_DST``
2314 ^^^^^^^^^^^^^^^^^^^^^^^^
2316 Set a new IPv4 destination address in the outermost IPv4 header.
2318 It must be used with a valid RTE_FLOW_ITEM_TYPE_IPV4 flow pattern item.
2319 Otherwise, RTE_FLOW_ERROR_TYPE_ACTION error will be returned.
2321 .. _table_rte_flow_action_set_ipv4_dst:
2323 .. table:: SET_IPV4_DST
2325 +---------------+------------------------------+
2327 +===============+==============================+
2328 | ``ipv4_addr`` | new IPv4 destination address |
2329 +---------------+------------------------------+
2331 Action: ``SET_IPV6_SRC``
2332 ^^^^^^^^^^^^^^^^^^^^^^^^
2334 Set a new IPv6 source address in the outermost IPv6 header.
2336 It must be used with a valid RTE_FLOW_ITEM_TYPE_IPV6 flow pattern item.
2337 Otherwise, RTE_FLOW_ERROR_TYPE_ACTION error will be returned.
2339 .. _table_rte_flow_action_set_ipv6_src:
2341 .. table:: SET_IPV6_SRC
2343 +---------------+-------------------------+
2345 +===============+=========================+
2346 | ``ipv6_addr`` | new IPv6 source address |
2347 +---------------+-------------------------+
2349 Action: ``SET_IPV6_DST``
2350 ^^^^^^^^^^^^^^^^^^^^^^^^
2352 Set a new IPv6 destination address in the outermost IPv6 header.
2354 It must be used with a valid RTE_FLOW_ITEM_TYPE_IPV6 flow pattern item.
2355 Otherwise, RTE_FLOW_ERROR_TYPE_ACTION error will be returned.
2357 .. _table_rte_flow_action_set_ipv6_dst:
2359 .. table:: SET_IPV6_DST
2361 +---------------+------------------------------+
2363 +===============+==============================+
2364 | ``ipv6_addr`` | new IPv6 destination address |
2365 +---------------+------------------------------+
2367 Action: ``SET_TP_SRC``
2368 ^^^^^^^^^^^^^^^^^^^^^^^^^
2370 Set a new source port number in the outermost TCP/UDP header.
2372 It must be used with a valid RTE_FLOW_ITEM_TYPE_TCP or RTE_FLOW_ITEM_TYPE_UDP
2373 flow pattern item. Otherwise, RTE_FLOW_ERROR_TYPE_ACTION error will be returned.
2375 .. _table_rte_flow_action_set_tp_src:
2377 .. table:: SET_TP_SRC
2379 +----------+-------------------------+
2381 +==========+=========================+
2382 | ``port`` | new TCP/UDP source port |
2383 +---------------+--------------------+
2385 Action: ``SET_TP_DST``
2386 ^^^^^^^^^^^^^^^^^^^^^^^^^
2388 Set a new destination port number in the outermost TCP/UDP header.
2390 It must be used with a valid RTE_FLOW_ITEM_TYPE_TCP or RTE_FLOW_ITEM_TYPE_UDP
2391 flow pattern item. Otherwise, RTE_FLOW_ERROR_TYPE_ACTION error will be returned.
2393 .. _table_rte_flow_action_set_tp_dst:
2395 .. table:: SET_TP_DST
2397 +----------+------------------------------+
2399 +==========+==============================+
2400 | ``port`` | new TCP/UDP destination port |
2401 +---------------+-------------------------+
2403 Action: ``MAC_SWAP``
2404 ^^^^^^^^^^^^^^^^^^^^^^^^^
2406 Swap the source and destination MAC addresses in the outermost Ethernet
2409 It must be used with a valid RTE_FLOW_ITEM_TYPE_ETH flow pattern item.
2410 Otherwise, RTE_FLOW_ERROR_TYPE_ACTION error will be returned.
2412 .. _table_rte_flow_action_mac_swap:
2427 If there is no valid RTE_FLOW_ITEM_TYPE_IPV4 or RTE_FLOW_ITEM_TYPE_IPV6
2428 in pattern, Some PMDs will reject rule because behavior will be undefined.
2430 .. _table_rte_flow_action_dec_ttl:
2443 Assigns a new TTL value.
2445 If there is no valid RTE_FLOW_ITEM_TYPE_IPV4 or RTE_FLOW_ITEM_TYPE_IPV6
2446 in pattern, Some PMDs will reject rule because behavior will be undefined.
2448 .. _table_rte_flow_action_set_ttl:
2452 +---------------+--------------------+
2454 +===============+====================+
2455 | ``ttl_value`` | new TTL value |
2456 +---------------+--------------------+
2458 Action: ``SET_MAC_SRC``
2459 ^^^^^^^^^^^^^^^^^^^^^^^
2461 Set source MAC address.
2463 It must be used with a valid RTE_FLOW_ITEM_TYPE_ETH flow pattern item.
2464 Otherwise, RTE_FLOW_ERROR_TYPE_ACTION error will be returned.
2466 .. _table_rte_flow_action_set_mac_src:
2468 .. table:: SET_MAC_SRC
2470 +--------------+---------------+
2472 +==============+===============+
2473 | ``mac_addr`` | MAC address |
2474 +--------------+---------------+
2476 Action: ``SET_MAC_DST``
2477 ^^^^^^^^^^^^^^^^^^^^^^^
2479 Set destination MAC address.
2481 It must be used with a valid RTE_FLOW_ITEM_TYPE_ETH flow pattern item.
2482 Otherwise, RTE_FLOW_ERROR_TYPE_ACTION error will be returned.
2484 .. _table_rte_flow_action_set_mac_dst:
2486 .. table:: SET_MAC_DST
2488 +--------------+---------------+
2490 +==============+===============+
2491 | ``mac_addr`` | MAC address |
2492 +--------------+---------------+
2494 Action: ``INC_TCP_SEQ``
2495 ^^^^^^^^^^^^^^^^^^^^^^^
2497 Increase sequence number in the outermost TCP header.
2498 Value to increase TCP sequence number by is a big-endian 32 bit integer.
2500 Using this action on non-matching traffic will result in undefined behavior.
2502 Action: ``DEC_TCP_SEQ``
2503 ^^^^^^^^^^^^^^^^^^^^^^^
2505 Decrease sequence number in the outermost TCP header.
2506 Value to decrease TCP sequence number by is a big-endian 32 bit integer.
2508 Using this action on non-matching traffic will result in undefined behavior.
2510 Action: ``INC_TCP_ACK``
2511 ^^^^^^^^^^^^^^^^^^^^^^^
2513 Increase acknowledgment number in the outermost TCP header.
2514 Value to increase TCP acknowledgment number by is a big-endian 32 bit integer.
2516 Using this action on non-matching traffic will result in undefined behavior.
2518 Action: ``DEC_TCP_ACK``
2519 ^^^^^^^^^^^^^^^^^^^^^^^
2521 Decrease acknowledgment number in the outermost TCP header.
2522 Value to decrease TCP acknowledgment number by is a big-endian 32 bit integer.
2524 Using this action on non-matching traffic will result in undefined behavior.
2531 Tag is a transient data used during flow matching. This is not delivered to
2532 application. Multiple tags are supported by specifying index.
2534 .. _table_rte_flow_action_set_tag:
2538 +-----------+----------------------------+
2540 +===========+============================+
2541 | ``data`` | 32 bit tag value |
2542 +-----------+----------------------------+
2543 | ``mask`` | bit-mask applies to "data" |
2544 +-----------+----------------------------+
2545 | ``index`` | index of tag to set |
2546 +-----------+----------------------------+
2548 Action: ``SET_META``
2549 ^^^^^^^^^^^^^^^^^^^^^^^
2551 Set metadata. Item ``META`` matches metadata.
2553 Metadata set by mbuf metadata field with PKT_TX_DYNF_METADATA flag on egress
2554 will be overridden by this action. On ingress, the metadata will be carried by
2555 ``metadata`` dynamic field of ``rte_mbuf`` which can be accessed by
2556 ``RTE_FLOW_DYNF_METADATA()``. PKT_RX_DYNF_METADATA flag will be set along
2559 The mbuf dynamic field must be registered by calling
2560 ``rte_flow_dynf_metadata_register()`` prior to use ``SET_META`` action.
2562 Altering partial bits is supported with ``mask``. For bits which have never been
2563 set, unpredictable value will be seen depending on driver implementation. For
2564 loopback/hairpin packet, metadata set on Rx/Tx may or may not be propagated to
2565 the other path depending on HW capability.
2567 .. _table_rte_flow_action_set_meta:
2571 +----------+----------------------------+
2573 +==========+============================+
2574 | ``data`` | 32 bit metadata value |
2575 +----------+----------------------------+
2576 | ``mask`` | bit-mask applies to "data" |
2577 +----------+----------------------------+
2579 Action: ``SET_IPV4_DSCP``
2580 ^^^^^^^^^^^^^^^^^^^^^^^^^
2584 Modify DSCP in IPv4 header.
2586 It must be used with RTE_FLOW_ITEM_TYPE_IPV4 in pattern.
2587 Otherwise, RTE_FLOW_ERROR_TYPE_ACTION error will be returned.
2589 .. _table_rte_flow_action_set_ipv4_dscp:
2591 .. table:: SET_IPV4_DSCP
2593 +-----------+---------------------------------+
2595 +===========+=================================+
2596 | ``dscp`` | DSCP in low 6 bits, rest ignore |
2597 +-----------+---------------------------------+
2599 Action: ``SET_IPV6_DSCP``
2600 ^^^^^^^^^^^^^^^^^^^^^^^^^
2604 Modify DSCP in IPv6 header.
2606 It must be used with RTE_FLOW_ITEM_TYPE_IPV6 in pattern.
2607 Otherwise, RTE_FLOW_ERROR_TYPE_ACTION error will be returned.
2609 .. _table_rte_flow_action_set_ipv6_dscp:
2611 .. table:: SET_IPV6_DSCP
2613 +-----------+---------------------------------+
2615 +===========+=================================+
2616 | ``dscp`` | DSCP in low 6 bits, rest ignore |
2617 +-----------+---------------------------------+
2622 All specified pattern items (``enum rte_flow_item_type``) and actions
2623 (``enum rte_flow_action_type``) use positive identifiers.
2625 The negative space is reserved for dynamic types generated by PMDs during
2626 run-time. PMDs may encounter them as a result but must not accept negative
2627 identifiers they are not aware of.
2629 A method to generate them remains to be defined.
2634 Pattern item types will be added as new protocols are implemented.
2636 Variable headers support through dedicated pattern items, for example in
2637 order to match specific IPv4 options and IPv6 extension headers would be
2638 stacked after IPv4/IPv6 items.
2640 Other action types are planned but are not defined yet. These include the
2641 ability to alter packet data in several ways, such as performing
2642 encapsulation/decapsulation of tunnel headers.
2647 A rather simple API with few functions is provided to fully manage flow
2650 Each created flow rule is associated with an opaque, PMD-specific handle
2651 pointer. The application is responsible for keeping it until the rule is
2654 Flows rules are represented by ``struct rte_flow`` objects.
2659 Given that expressing a definite set of device capabilities is not
2660 practical, a dedicated function is provided to check if a flow rule is
2661 supported and can be created.
2666 rte_flow_validate(uint16_t port_id,
2667 const struct rte_flow_attr *attr,
2668 const struct rte_flow_item pattern[],
2669 const struct rte_flow_action actions[],
2670 struct rte_flow_error *error);
2672 The flow rule is validated for correctness and whether it could be accepted
2673 by the device given sufficient resources. The rule is checked against the
2674 current device mode and queue configuration. The flow rule may also
2675 optionally be validated against existing flow rules and device resources.
2676 This function has no effect on the target device.
2678 The returned value is guaranteed to remain valid only as long as no
2679 successful calls to ``rte_flow_create()`` or ``rte_flow_destroy()`` are made
2680 in the meantime and no device parameter affecting flow rules in any way are
2681 modified, due to possible collisions or resource limitations (although in
2682 such cases ``EINVAL`` should not be returned).
2686 - ``port_id``: port identifier of Ethernet device.
2687 - ``attr``: flow rule attributes.
2688 - ``pattern``: pattern specification (list terminated by the END pattern
2690 - ``actions``: associated actions (list terminated by the END action).
2691 - ``error``: perform verbose error reporting if not NULL. PMDs initialize
2692 this structure in case of error only.
2696 - 0 if flow rule is valid and can be created. A negative errno value
2697 otherwise (``rte_errno`` is also set), the following errors are defined.
2698 - ``-ENOSYS``: underlying device does not support this functionality.
2699 - ``-EINVAL``: unknown or invalid rule specification.
2700 - ``-ENOTSUP``: valid but unsupported rule specification (e.g. partial
2701 bit-masks are unsupported).
2702 - ``EEXIST``: collision with an existing rule. Only returned if device
2703 supports flow rule collision checking and there was a flow rule
2704 collision. Not receiving this return code is no guarantee that creating
2705 the rule will not fail due to a collision.
2706 - ``ENOMEM``: not enough memory to execute the function, or if the device
2707 supports resource validation, resource limitation on the device.
2708 - ``-EBUSY``: action cannot be performed due to busy device resources, may
2709 succeed if the affected queues or even the entire port are in a stopped
2710 state (see ``rte_eth_dev_rx_queue_stop()`` and ``rte_eth_dev_stop()``).
2715 Creating a flow rule is similar to validating one, except the rule is
2716 actually created and a handle returned.
2721 rte_flow_create(uint16_t port_id,
2722 const struct rte_flow_attr *attr,
2723 const struct rte_flow_item pattern[],
2724 const struct rte_flow_action *actions[],
2725 struct rte_flow_error *error);
2729 - ``port_id``: port identifier of Ethernet device.
2730 - ``attr``: flow rule attributes.
2731 - ``pattern``: pattern specification (list terminated by the END pattern
2733 - ``actions``: associated actions (list terminated by the END action).
2734 - ``error``: perform verbose error reporting if not NULL. PMDs initialize
2735 this structure in case of error only.
2739 A valid handle in case of success, NULL otherwise and ``rte_errno`` is set
2740 to the positive version of one of the error codes defined for
2741 ``rte_flow_validate()``.
2746 Flow rules destruction is not automatic, and a queue or a port should not be
2747 released if any are still attached to them. Applications must take care of
2748 performing this step before releasing resources.
2753 rte_flow_destroy(uint16_t port_id,
2754 struct rte_flow *flow,
2755 struct rte_flow_error *error);
2758 Failure to destroy a flow rule handle may occur when other flow rules depend
2759 on it, and destroying it would result in an inconsistent state.
2761 This function is only guaranteed to succeed if handles are destroyed in
2762 reverse order of their creation.
2766 - ``port_id``: port identifier of Ethernet device.
2767 - ``flow``: flow rule handle to destroy.
2768 - ``error``: perform verbose error reporting if not NULL. PMDs initialize
2769 this structure in case of error only.
2773 - 0 on success, a negative errno value otherwise and ``rte_errno`` is set.
2778 Convenience function to destroy all flow rule handles associated with a
2779 port. They are released as with successive calls to ``rte_flow_destroy()``.
2784 rte_flow_flush(uint16_t port_id,
2785 struct rte_flow_error *error);
2787 In the unlikely event of failure, handles are still considered destroyed and
2788 no longer valid but the port must be assumed to be in an inconsistent state.
2792 - ``port_id``: port identifier of Ethernet device.
2793 - ``error``: perform verbose error reporting if not NULL. PMDs initialize
2794 this structure in case of error only.
2798 - 0 on success, a negative errno value otherwise and ``rte_errno`` is set.
2803 Query an existing flow rule.
2805 This function allows retrieving flow-specific data such as counters. Data
2806 is gathered by special actions which must be present in the flow rule
2812 rte_flow_query(uint16_t port_id,
2813 struct rte_flow *flow,
2814 const struct rte_flow_action *action,
2816 struct rte_flow_error *error);
2820 - ``port_id``: port identifier of Ethernet device.
2821 - ``flow``: flow rule handle to query.
2822 - ``action``: action to query, this must match prototype from flow rule.
2823 - ``data``: pointer to storage for the associated query data type.
2824 - ``error``: perform verbose error reporting if not NULL. PMDs initialize
2825 this structure in case of error only.
2829 - 0 on success, a negative errno value otherwise and ``rte_errno`` is set.
2831 .. _flow_isolated_mode:
2836 The general expectation for ingress traffic is that flow rules process it
2837 first; the remaining unmatched or pass-through traffic usually ends up in a
2838 queue (with or without RSS, locally or in some sub-device instance)
2839 depending on the global configuration settings of a port.
2841 While fine from a compatibility standpoint, this approach makes drivers more
2842 complex as they have to check for possible side effects outside of this API
2843 when creating or destroying flow rules. It results in a more limited set of
2844 available rule types due to the way device resources are assigned (e.g. no
2845 support for the RSS action even on capable hardware).
2847 Given that nonspecific traffic can be handled by flow rules as well,
2848 isolated mode is a means for applications to tell a driver that ingress on
2849 the underlying port must be injected from the defined flow rules only; that
2850 no default traffic is expected outside those rules.
2852 This has the following benefits:
2854 - Applications get finer-grained control over the kind of traffic they want
2855 to receive (no traffic by default).
2857 - More importantly they control at what point nonspecific traffic is handled
2858 relative to other flow rules, by adjusting priority levels.
2860 - Drivers can assign more hardware resources to flow rules and expand the
2861 set of supported rule types.
2863 Because toggling isolated mode may cause profound changes to the ingress
2864 processing path of a driver, it may not be possible to leave it once
2865 entered. Likewise, existing flow rules or global configuration settings may
2866 prevent a driver from entering isolated mode.
2868 Applications relying on this mode are therefore encouraged to toggle it as
2869 soon as possible after device initialization, ideally before the first call
2870 to ``rte_eth_dev_configure()`` to avoid possible failures due to conflicting
2873 Once effective, the following functionality has no effect on the underlying
2874 port and may return errors such as ``ENOTSUP`` ("not supported"):
2876 - Toggling promiscuous mode.
2877 - Toggling allmulticast mode.
2878 - Configuring MAC addresses.
2879 - Configuring multicast addresses.
2880 - Configuring VLAN filters.
2881 - Configuring Rx filters through the legacy API (e.g. FDIR).
2882 - Configuring global RSS settings.
2887 rte_flow_isolate(uint16_t port_id, int set, struct rte_flow_error *error);
2891 - ``port_id``: port identifier of Ethernet device.
2892 - ``set``: nonzero to enter isolated mode, attempt to leave it otherwise.
2893 - ``error``: perform verbose error reporting if not NULL. PMDs initialize
2894 this structure in case of error only.
2898 - 0 on success, a negative errno value otherwise and ``rte_errno`` is set.
2900 Verbose error reporting
2901 -----------------------
2903 The defined *errno* values may not be accurate enough for users or
2904 application developers who want to investigate issues related to flow rules
2905 management. A dedicated error object is defined for this purpose:
2909 enum rte_flow_error_type {
2910 RTE_FLOW_ERROR_TYPE_NONE, /**< No error. */
2911 RTE_FLOW_ERROR_TYPE_UNSPECIFIED, /**< Cause unspecified. */
2912 RTE_FLOW_ERROR_TYPE_HANDLE, /**< Flow rule (handle). */
2913 RTE_FLOW_ERROR_TYPE_ATTR_GROUP, /**< Group field. */
2914 RTE_FLOW_ERROR_TYPE_ATTR_PRIORITY, /**< Priority field. */
2915 RTE_FLOW_ERROR_TYPE_ATTR_INGRESS, /**< Ingress field. */
2916 RTE_FLOW_ERROR_TYPE_ATTR_EGRESS, /**< Egress field. */
2917 RTE_FLOW_ERROR_TYPE_ATTR, /**< Attributes structure. */
2918 RTE_FLOW_ERROR_TYPE_ITEM_NUM, /**< Pattern length. */
2919 RTE_FLOW_ERROR_TYPE_ITEM, /**< Specific pattern item. */
2920 RTE_FLOW_ERROR_TYPE_ACTION_NUM, /**< Number of actions. */
2921 RTE_FLOW_ERROR_TYPE_ACTION, /**< Specific action. */
2924 struct rte_flow_error {
2925 enum rte_flow_error_type type; /**< Cause field and error types. */
2926 const void *cause; /**< Object responsible for the error. */
2927 const char *message; /**< Human-readable error message. */
2930 Error type ``RTE_FLOW_ERROR_TYPE_NONE`` stands for no error, in which case
2931 remaining fields can be ignored. Other error types describe the type of the
2932 object pointed by ``cause``.
2934 If non-NULL, ``cause`` points to the object responsible for the error. For a
2935 flow rule, this may be a pattern item or an individual action.
2937 If non-NULL, ``message`` provides a human-readable error message.
2939 This object is normally allocated by applications and set by PMDs in case of
2940 error, the message points to a constant string which does not need to be
2941 freed by the application, however its pointer can be considered valid only
2942 as long as its associated DPDK port remains configured. Closing the
2943 underlying device or unloading the PMD invalidates it.
2954 rte_flow_error_set(struct rte_flow_error *error,
2956 enum rte_flow_error_type type,
2958 const char *message);
2960 This function initializes ``error`` (if non-NULL) with the provided
2961 parameters and sets ``rte_errno`` to ``code``. A negative error ``code`` is
2970 rte_flow_conv(enum rte_flow_conv_op op,
2974 struct rte_flow_error *error);
2976 Convert ``src`` to ``dst`` according to operation ``op``. Possible
2979 - Attributes, pattern item or action duplication.
2980 - Duplication of an entire pattern or list of actions.
2981 - Duplication of a complete flow rule description.
2982 - Pattern item or action name retrieval.
2987 - DPDK does not keep track of flow rules definitions or flow rule objects
2988 automatically. Applications may keep track of the former and must keep
2989 track of the latter. PMDs may also do it for internal needs, however this
2990 must not be relied on by applications.
2992 - Flow rules are not maintained between successive port initializations. An
2993 application exiting without releasing them and restarting must re-create
2996 - API operations are synchronous and blocking (``EAGAIN`` cannot be
2999 - There is no provision for re-entrancy/multi-thread safety, although nothing
3000 should prevent different devices from being configured at the same
3001 time. PMDs may protect their control path functions accordingly.
3003 - Stopping the data path (TX/RX) should not be necessary when managing flow
3004 rules. If this cannot be achieved naturally or with workarounds (such as
3005 temporarily replacing the burst function pointers), an appropriate error
3006 code must be returned (``EBUSY``).
3008 - PMDs, not applications, are responsible for maintaining flow rules
3009 configuration when stopping and restarting a port or performing other
3010 actions which may affect them. They can only be destroyed explicitly by
3013 For devices exposing multiple ports sharing global settings affected by flow
3016 - All ports under DPDK control must behave consistently, PMDs are
3017 responsible for making sure that existing flow rules on a port are not
3018 affected by other ports.
3020 - Ports not under DPDK control (unaffected or handled by other applications)
3021 are user's responsibility. They may affect existing flow rules and cause
3022 undefined behavior. PMDs aware of this may prevent flow rules creation
3023 altogether in such cases.
3028 The PMD interface is defined in ``rte_flow_driver.h``. It is not subject to
3029 API/ABI versioning constraints as it is not exposed to applications and may
3030 evolve independently.
3032 It is currently implemented on top of the legacy filtering framework through
3033 filter type *RTE_ETH_FILTER_GENERIC* that accepts the single operation
3034 *RTE_ETH_FILTER_GET* to return PMD-specific *rte_flow* callbacks wrapped
3035 inside ``struct rte_flow_ops``.
3037 This overhead is temporarily necessary in order to keep compatibility with
3038 the legacy filtering framework, which should eventually disappear.
3040 - PMD callbacks implement exactly the interface described in `Rules
3041 management`_, except for the port ID argument which has already been
3042 converted to a pointer to the underlying ``struct rte_eth_dev``.
3044 - Public API functions do not process flow rules definitions at all before
3045 calling PMD functions (no basic error checking, no validation
3046 whatsoever). They only make sure these callbacks are non-NULL or return
3047 the ``ENOSYS`` (function not supported) error.
3049 This interface additionally defines the following helper function:
3051 - ``rte_flow_ops_get()``: get generic flow operations structure from a
3054 More will be added over time.
3056 Device compatibility
3057 --------------------
3059 No known implementation supports all the described features.
3061 Unsupported features or combinations are not expected to be fully emulated
3062 in software by PMDs for performance reasons. Partially supported features
3063 may be completed in software as long as hardware performs most of the work
3064 (such as queue redirection and packet recognition).
3066 However PMDs are expected to do their best to satisfy application requests
3067 by working around hardware limitations as long as doing so does not affect
3068 the behavior of existing flow rules.
3070 The following sections provide a few examples of such cases and describe how
3071 PMDs should handle them, they are based on limitations built into the
3077 Each flow rule comes with its own, per-layer bit-masks, while hardware may
3078 support only a single, device-wide bit-mask for a given layer type, so that
3079 two IPv4 rules cannot use different bit-masks.
3081 The expected behavior in this case is that PMDs automatically configure
3082 global bit-masks according to the needs of the first flow rule created.
3084 Subsequent rules are allowed only if their bit-masks match those, the
3085 ``EEXIST`` error code should be returned otherwise.
3087 Unsupported layer types
3088 ~~~~~~~~~~~~~~~~~~~~~~~
3090 Many protocols can be simulated by crafting patterns with the `Item: RAW`_
3093 PMDs can rely on this capability to simulate support for protocols with
3094 headers not directly recognized by hardware.
3096 ``ANY`` pattern item
3097 ~~~~~~~~~~~~~~~~~~~~
3099 This pattern item stands for anything, which can be difficult to translate
3100 to something hardware would understand, particularly if followed by more
3103 Consider the following pattern:
3105 .. _table_rte_flow_unsupported_any:
3107 .. table:: Pattern with ANY as L3
3109 +-------+-----------------------+
3111 +=======+=======================+
3113 +-------+-----+---------+-------+
3114 | 1 | ANY | ``num`` | ``1`` |
3115 +-------+-----+---------+-------+
3117 +-------+-----------------------+
3119 +-------+-----------------------+
3121 Knowing that TCP does not make sense with something other than IPv4 and IPv6
3122 as L3, such a pattern may be translated to two flow rules instead:
3124 .. _table_rte_flow_unsupported_any_ipv4:
3126 .. table:: ANY replaced with IPV4
3128 +-------+--------------------+
3130 +=======+====================+
3132 +-------+--------------------+
3133 | 1 | IPV4 (zeroed mask) |
3134 +-------+--------------------+
3136 +-------+--------------------+
3138 +-------+--------------------+
3142 .. _table_rte_flow_unsupported_any_ipv6:
3144 .. table:: ANY replaced with IPV6
3146 +-------+--------------------+
3148 +=======+====================+
3150 +-------+--------------------+
3151 | 1 | IPV6 (zeroed mask) |
3152 +-------+--------------------+
3154 +-------+--------------------+
3156 +-------+--------------------+
3158 Note that as soon as a ANY rule covers several layers, this approach may
3159 yield a large number of hidden flow rules. It is thus suggested to only
3160 support the most common scenarios (anything as L2 and/or L3).
3165 - When combined with `Action: QUEUE`_, packet counting (`Action: COUNT`_)
3166 and tagging (`Action: MARK`_ or `Action: FLAG`_) may be implemented in
3167 software as long as the target queue is used by a single rule.
3169 - When a single target queue is provided, `Action: RSS`_ can also be
3170 implemented through `Action: QUEUE`_.
3175 While it would naturally make sense, flow rules cannot be assumed to be
3176 processed by hardware in the same order as their creation for several
3179 - They may be managed internally as a tree or a hash table instead of a
3181 - Removing a flow rule before adding another one can either put the new rule
3182 at the end of the list or reuse a freed entry.
3183 - Duplication may occur when packets are matched by several rules.
3185 For overlapping rules (particularly in order to use `Action: PASSTHRU`_)
3186 predictable behavior is only guaranteed by using different priority levels.
3188 Priority levels are not necessarily implemented in hardware, or may be
3189 severely limited (e.g. a single priority bit).
3191 For these reasons, priority levels may be implemented purely in software by
3194 - For devices expecting flow rules to be added in the correct order, PMDs
3195 may destroy and re-create existing rules after adding a new one with
3198 - A configurable number of dummy or empty rules can be created at
3199 initialization time to save high priority slots for later.
3201 - In order to save priority levels, PMDs may evaluate whether rules are
3202 likely to collide and adjust their priority accordingly.
3207 - A device profile selection function which could be used to force a
3208 permanent profile instead of relying on its automatic configuration based
3209 on existing flow rules.
3211 - A method to optimize *rte_flow* rules with specific pattern items and
3212 action types generated on the fly by PMDs. DPDK should assign negative
3213 numbers to these in order to not collide with the existing types. See
3216 - Adding specific egress pattern items and actions as described in
3217 `Attribute: Traffic direction`_.
3219 - Optional software fallback when PMDs are unable to handle requested flow
3220 rules so applications do not have to implement their own.
3222 .. _OpenFlow Switch Specification: https://www.opennetworking.org/software-defined-standards/specifications/
git.droids-corp.org / dpdk.git / blob