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.
31 A flow rule is the combination of attributes with a matching pattern and a
32 list of actions. Flow rules form the basis of this API.
34 Flow rules can have several distinct actions (such as counting,
35 encapsulating, decapsulating before redirecting packets to a particular
36 queue, etc.), instead of relying on several rules to achieve this and having
37 applications deal with hardware implementation details regarding their
40 Support for different priority levels on a rule basis is provided, for
41 example in order to force a more specific rule to come before a more generic
42 one for packets matched by both. However hardware support for more than a
43 single priority level cannot be guaranteed. When supported, the number of
44 available priority levels is usually low, which is why they can also be
45 implemented in software by PMDs (e.g. missing priority levels may be
46 emulated by reordering rules).
48 In order to remain as hardware-agnostic as possible, by default all rules
49 are considered to have the same priority, which means that the order between
50 overlapping rules (when a packet is matched by several filters) is
53 PMDs may refuse to create overlapping rules at a given priority level when
54 they can be detected (e.g. if a pattern matches an existing filter).
56 Thus predictable results for a given priority level can only be achieved
57 with non-overlapping rules, using perfect matching on all protocol layers.
59 Flow rules can also be grouped, the flow rule priority is specific to the
60 group they belong to. All flow rules in a given group are thus processed within
61 the context of that group. Groups are not linked by default, so the logical
62 hierarchy of groups must be explicitly defined by flow rules themselves in each
63 group using the JUMP action to define the next group to redirect too. Only flow
64 rules defined in the default group 0 are guarantee to be matched against, this
65 makes group 0 the origin of any group hierarchy defined by an application.
67 Support for multiple actions per rule may be implemented internally on top
68 of non-default hardware priorities, as a result both features may not be
69 simultaneously available to applications.
71 Considering that allowed pattern/actions combinations cannot be known in
72 advance and would result in an impractically large number of capabilities to
73 expose, a method is provided to validate a given rule from the current
74 device configuration state.
76 This enables applications to check if the rule types they need is supported
77 at initialization time, before starting their data path. This method can be
78 used anytime, its only requirement being that the resources needed by a rule
79 should exist (e.g. a target RX queue should be configured first).
81 Each defined rule is associated with an opaque handle managed by the PMD,
82 applications are responsible for keeping it. These can be used for queries
83 and rules management, such as retrieving counters or other data and
86 To avoid resource leaks on the PMD side, handles must be explicitly
87 destroyed by the application before releasing associated resources such as
90 The following sections cover:
92 - **Attributes** (represented by ``struct rte_flow_attr``): properties of a
93 flow rule such as its direction (ingress or egress) and priority.
95 - **Pattern item** (represented by ``struct rte_flow_item``): part of a
96 matching pattern that either matches specific packet data or traffic
97 properties. It can also describe properties of the pattern itself, such as
100 - **Matching pattern**: traffic properties to look for, a combination of any
103 - **Actions** (represented by ``struct rte_flow_action``): operations to
104 perform whenever a packet is matched by a pattern.
112 Flow rules can be grouped by assigning them a common group number. Groups
113 allow a logical hierarchy of flow rule groups (tables) to be defined. These
114 groups can be supported virtually in the PMD or in the physical device.
115 Group 0 is the default group and this is the only group which flows are
116 guarantee to matched against, all subsequent groups can only be reached by
117 way of the JUMP action from a matched flow rule.
119 Although optional, applications are encouraged to group similar rules as
120 much as possible to fully take advantage of hardware capabilities
121 (e.g. optimized matching) and work around limitations (e.g. a single pattern
122 type possibly allowed in a given group), while being aware that the groups
123 hierarchies must be programmed explicitly.
125 Note that support for more than a single group is not guaranteed.
130 A priority level can be assigned to a flow rule, lower values
131 denote higher priority, with 0 as the maximum.
133 Priority levels are arbitrary and up to the application, they do
134 not need to be contiguous nor start from 0, however the maximum number
135 varies between devices and may be affected by existing flow rules.
137 A flow which matches multiple rules in the same group will always matched by
138 the rule with the highest priority in that group.
140 If a packet is matched by several rules of a given group for a given
141 priority level, the outcome is undefined. It can take any path, may be
142 duplicated or even cause unrecoverable errors.
144 Note that support for more than a single priority level is not guaranteed.
146 Attribute: Traffic direction
147 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
149 Flow rule patterns apply to inbound and/or outbound traffic.
151 In the context of this API, **ingress** and **egress** respectively stand
152 for **inbound** and **outbound** based on the standpoint of the application
153 creating a flow rule.
155 There are no exceptions to this definition.
157 Several pattern items and actions are valid and can be used in both
158 directions. At least one direction must be specified.
160 Specifying both directions at once for a given rule is not recommended but
161 may be valid in a few cases (e.g. shared counters).
166 Instead of simply matching the properties of traffic as it would appear on a
167 given DPDK port ID, enabling this attribute transfers a flow rule to the
168 lowest possible level of any device endpoints found in the pattern.
170 When supported, this effectively enables an application to reroute traffic
171 not necessarily intended for it (e.g. coming from or addressed to different
172 physical ports, VFs or applications) at the device level.
174 It complements the behavior of some pattern items such as `Item: PHY_PORT`_
175 and is meaningless without them.
177 When transferring flow rules, **ingress** and **egress** attributes
178 (`Attribute: Traffic direction`_) keep their original meaning, as if
179 processing traffic emitted or received by the application.
184 Pattern items fall in two categories:
186 - Matching protocol headers and packet data, usually associated with a
187 specification structure. These must be stacked in the same order as the
188 protocol layers to match inside packets, starting from the lowest.
190 - Matching meta-data or affecting pattern processing, often without a
191 specification structure. Since they do not match packet contents, their
192 position in the list is usually not relevant.
194 Item specification structures are used to match specific values among
195 protocol fields (or item properties). Documentation describes for each item
196 whether they are associated with one and their type name if so.
198 Up to three structures of the same type can be set for a given item:
200 - ``spec``: values to match (e.g. a given IPv4 address).
202 - ``last``: upper bound for an inclusive range with corresponding fields in
205 - ``mask``: bit-mask applied to both ``spec`` and ``last`` whose purpose is
206 to distinguish the values to take into account and/or partially mask them
207 out (e.g. in order to match an IPv4 address prefix).
209 Usage restrictions and expected behavior:
211 - Setting either ``mask`` or ``last`` without ``spec`` is an error.
213 - Field values in ``last`` which are either 0 or equal to the corresponding
214 values in ``spec`` are ignored; they do not generate a range. Nonzero
215 values lower than those in ``spec`` are not supported.
217 - Setting ``spec`` and optionally ``last`` without ``mask`` causes the PMD
218 to use the default mask defined for that item (defined as
219 ``rte_flow_item_{name}_mask`` constants).
221 - Not setting any of them (assuming item type allows it) is equivalent to
222 providing an empty (zeroed) ``mask`` for broad (nonspecific) matching.
224 - ``mask`` is a simple bit-mask applied before interpreting the contents of
225 ``spec`` and ``last``, which may yield unexpected results if not used
226 carefully. For example, if for an IPv4 address field, ``spec`` provides
227 *10.1.2.3*, ``last`` provides *10.3.4.5* and ``mask`` provides
228 *255.255.0.0*, the effective range becomes *10.1.0.0* to *10.3.255.255*.
230 Example of an item specification matching an Ethernet header:
232 .. _table_rte_flow_pattern_item_example:
234 .. table:: Ethernet item
236 +----------+----------+-----------------------+
237 | Field | Subfield | Value |
238 +==========+==========+=======================+
239 | ``spec`` | ``src`` | ``00:00:01:02:03:04`` |
240 | +----------+-----------------------+
241 | | ``dst`` | ``00:00:2a:66:00:01`` |
242 | +----------+-----------------------+
243 | | ``type`` | ``0x22aa`` |
244 +----------+----------+-----------------------+
245 | ``last`` | unspecified |
246 +----------+----------+-----------------------+
247 | ``mask`` | ``src`` | ``00:00:ff:ff:ff:00`` |
248 | +----------+-----------------------+
249 | | ``dst`` | ``00:00:00:00:00:ff`` |
250 | +----------+-----------------------+
251 | | ``type`` | ``0x0000`` |
252 +----------+----------+-----------------------+
254 Non-masked bits stand for any value (shown as ``?`` below), Ethernet headers
255 with the following properties are thus matched:
257 - ``src``: ``??:??:01:02:03:??``
258 - ``dst``: ``??:??:??:??:??:01``
259 - ``type``: ``0x????``
264 A pattern is formed by stacking items starting from the lowest protocol
265 layer to match. This stacking restriction does not apply to meta items which
266 can be placed anywhere in the stack without affecting the meaning of the
269 Patterns are terminated by END items.
273 .. _table_rte_flow_tcpv4_as_l4:
275 .. table:: TCPv4 as L4
291 .. _table_rte_flow_tcpv6_in_vxlan:
293 .. table:: TCPv6 in VXLAN
295 +-------+------------+
297 +=======+============+
299 +-------+------------+
301 +-------+------------+
303 +-------+------------+
305 +-------+------------+
307 +-------+------------+
309 +-------+------------+
311 +-------+------------+
313 +-------+------------+
317 .. _table_rte_flow_tcpv4_as_l4_meta:
319 .. table:: TCPv4 as L4 with meta items
341 The above example shows how meta items do not affect packet data matching
342 items, as long as those remain stacked properly. The resulting matching
343 pattern is identical to "TCPv4 as L4".
345 .. _table_rte_flow_udpv6_anywhere:
347 .. table:: UDPv6 anywhere
359 If supported by the PMD, omitting one or several protocol layers at the
360 bottom of the stack as in the above example (missing an Ethernet
361 specification) enables looking up anywhere in packets.
363 It is unspecified whether the payload of supported encapsulations
364 (e.g. VXLAN payload) is matched by such a pattern, which may apply to inner,
365 outer or both packets.
367 .. _table_rte_flow_invalid_l3:
369 .. table:: Invalid, missing L3
381 The above pattern is invalid due to a missing L3 specification between L2
382 (Ethernet) and L4 (UDP). Doing so is only allowed at the bottom and at the
388 They match meta-data or affect pattern processing instead of matching packet
389 data directly, most of them do not need a specification structure. This
390 particularity allows them to be specified anywhere in the stack without
391 causing any side effect.
396 End marker for item lists. Prevents further processing of items, thereby
399 - Its numeric value is 0 for convenience.
400 - PMD support is mandatory.
401 - ``spec``, ``last`` and ``mask`` are ignored.
403 .. _table_rte_flow_item_end:
407 +----------+---------+
409 +==========+=========+
410 | ``spec`` | ignored |
411 +----------+---------+
412 | ``last`` | ignored |
413 +----------+---------+
414 | ``mask`` | ignored |
415 +----------+---------+
420 Used as a placeholder for convenience. It is ignored and simply discarded by
423 - PMD support is mandatory.
424 - ``spec``, ``last`` and ``mask`` are ignored.
426 .. _table_rte_flow_item_void:
430 +----------+---------+
432 +==========+=========+
433 | ``spec`` | ignored |
434 +----------+---------+
435 | ``last`` | ignored |
436 +----------+---------+
437 | ``mask`` | ignored |
438 +----------+---------+
440 One usage example for this type is generating rules that share a common
441 prefix quickly without reallocating memory, only by updating item types:
443 .. _table_rte_flow_item_void_example:
445 .. table:: TCP, UDP or ICMP as L4
447 +-------+--------------------+
449 +=======+====================+
451 +-------+--------------------+
453 +-------+------+------+------+
454 | 2 | UDP | VOID | VOID |
455 +-------+------+------+------+
456 | 3 | VOID | TCP | VOID |
457 +-------+------+------+------+
458 | 4 | VOID | VOID | ICMP |
459 +-------+------+------+------+
461 +-------+--------------------+
466 Inverted matching, i.e. process packets that do not match the pattern.
468 - ``spec``, ``last`` and ``mask`` are ignored.
470 .. _table_rte_flow_item_invert:
474 +----------+---------+
476 +==========+=========+
477 | ``spec`` | ignored |
478 +----------+---------+
479 | ``last`` | ignored |
480 +----------+---------+
481 | ``mask`` | ignored |
482 +----------+---------+
484 Usage example, matching non-TCPv4 packets only:
486 .. _table_rte_flow_item_invert_example:
488 .. table:: Anything but TCPv4
507 Matches traffic originating from (ingress) or going to (egress) the physical
508 function of the current device.
510 If supported, should work even if the physical function is not managed by
511 the application and thus not associated with a DPDK port ID.
513 - Can be combined with any number of `Item: VF`_ to match both PF and VF
515 - ``spec``, ``last`` and ``mask`` must not be set.
517 .. _table_rte_flow_item_pf:
534 Matches traffic originating from (ingress) or going to (egress) a given
535 virtual function of the current device.
537 If supported, should work even if the virtual function is not managed by the
538 application and thus not associated with a DPDK port ID.
540 Note this pattern item does not match VF representors traffic which, as
541 separate entities, should be addressed through their own DPDK port IDs.
543 - Can be specified multiple times to match traffic addressed to several VF
545 - Can be combined with a PF item to match both PF and VF traffic.
546 - Default ``mask`` matches any VF ID.
548 .. _table_rte_flow_item_vf:
552 +----------+----------+---------------------------+
553 | Field | Subfield | Value |
554 +==========+==========+===========================+
555 | ``spec`` | ``id`` | destination VF ID |
556 +----------+----------+---------------------------+
557 | ``last`` | ``id`` | upper range value |
558 +----------+----------+---------------------------+
559 | ``mask`` | ``id`` | zeroed to match any VF ID |
560 +----------+----------+---------------------------+
565 Matches traffic originating from (ingress) or going to (egress) a physical
566 port of the underlying device.
568 The first PHY_PORT item overrides the physical port normally associated with
569 the specified DPDK input port (port_id). This item can be provided several
570 times to match additional physical ports.
572 Note that physical ports are not necessarily tied to DPDK input ports
573 (port_id) when those are not under DPDK control. Possible values are
574 specific to each device, they are not necessarily indexed from zero and may
577 As a device property, the list of allowed values as well as the value
578 associated with a port_id should be retrieved by other means.
580 - Default ``mask`` matches any port index.
582 .. _table_rte_flow_item_phy_port:
586 +----------+-----------+--------------------------------+
587 | Field | Subfield | Value |
588 +==========+===========+================================+
589 | ``spec`` | ``index`` | physical port index |
590 +----------+-----------+--------------------------------+
591 | ``last`` | ``index`` | upper range value |
592 +----------+-----------+--------------------------------+
593 | ``mask`` | ``index`` | zeroed to match any port index |
594 +----------+-----------+--------------------------------+
599 Matches traffic originating from (ingress) or going to (egress) a given DPDK
602 Normally only supported if the port ID in question is known by the
603 underlying PMD and related to the device the flow rule is created against.
605 This must not be confused with `Item: PHY_PORT`_ which refers to the
606 physical port of a device, whereas `Item: PORT_ID`_ refers to a ``struct
607 rte_eth_dev`` object on the application side (also known as "port
608 representor" depending on the kind of underlying device).
610 - Default ``mask`` matches the specified DPDK port ID.
612 .. _table_rte_flow_item_port_id:
616 +----------+----------+-----------------------------+
617 | Field | Subfield | Value |
618 +==========+==========+=============================+
619 | ``spec`` | ``id`` | DPDK port ID |
620 +----------+----------+-----------------------------+
621 | ``last`` | ``id`` | upper range value |
622 +----------+----------+-----------------------------+
623 | ``mask`` | ``id`` | zeroed to match any port ID |
624 +----------+----------+-----------------------------+
629 Matches an arbitrary integer value which was set using the ``MARK`` action in
630 a previously matched rule.
632 This item can only specified once as a match criteria as the ``MARK`` action can
633 only be specified once in a flow action.
635 Note the value of MARK field is arbitrary and application defined.
637 Depending on the underlying implementation the MARK item may be supported on
638 the physical device, with virtual groups in the PMD or not at all.
640 - Default ``mask`` matches any integer value.
642 .. _table_rte_flow_item_mark:
646 +----------+----------+---------------------------+
647 | Field | Subfield | Value |
648 +==========+==========+===========================+
649 | ``spec`` | ``id`` | integer value |
650 +----------+--------------------------------------+
651 | ``last`` | ``id`` | upper range value |
652 +----------+----------+---------------------------+
653 | ``mask`` | ``id`` | zeroed to match any value |
654 +----------+----------+---------------------------+
659 Matches tag item set by other flows. Multiple tags are supported by specifying
662 - Default ``mask`` matches the specified tag value and index.
664 .. _table_rte_flow_item_tag:
668 +----------+----------+----------------------------------------+
669 | Field | Subfield | Value |
670 +==========+===========+=======================================+
671 | ``spec`` | ``data`` | 32 bit flow tag value |
672 | +-----------+---------------------------------------+
673 | | ``index`` | index of flow tag |
674 +----------+-----------+---------------------------------------+
675 | ``last`` | ``data`` | upper range value |
676 | +-----------+---------------------------------------+
677 | | ``index`` | field is ignored |
678 +----------+-----------+---------------------------------------+
679 | ``mask`` | ``data`` | bit-mask applies to "spec" and "last" |
680 | +-----------+---------------------------------------+
681 | | ``index`` | field is ignored |
682 +----------+-----------+---------------------------------------+
687 Matches 32 bit metadata item set.
689 On egress, metadata can be set either by mbuf metadata field with
690 PKT_TX_DYNF_METADATA flag or ``SET_META`` action. On ingress, ``SET_META``
691 action sets metadata for a packet and the metadata will be reported via
692 ``metadata`` dynamic field of ``rte_mbuf`` with PKT_RX_DYNF_METADATA flag.
694 - Default ``mask`` matches the specified Rx metadata value.
696 .. _table_rte_flow_item_meta:
700 +----------+----------+---------------------------------------+
701 | Field | Subfield | Value |
702 +==========+==========+=======================================+
703 | ``spec`` | ``data`` | 32 bit metadata value |
704 +----------+----------+---------------------------------------+
705 | ``last`` | ``data`` | upper range value |
706 +----------+----------+---------------------------------------+
707 | ``mask`` | ``data`` | bit-mask applies to "spec" and "last" |
708 +----------+----------+---------------------------------------+
710 Data matching item types
711 ~~~~~~~~~~~~~~~~~~~~~~~~
713 Most of these are basically protocol header definitions with associated
714 bit-masks. They must be specified (stacked) from lowest to highest protocol
715 layer to form a matching pattern.
720 Matches any protocol in place of the current layer, a single ANY may also
721 stand for several protocol layers.
723 This is usually specified as the first pattern item when looking for a
724 protocol anywhere in a packet.
726 - Default ``mask`` stands for any number of layers.
728 .. _table_rte_flow_item_any:
732 +----------+----------+--------------------------------------+
733 | Field | Subfield | Value |
734 +==========+==========+======================================+
735 | ``spec`` | ``num`` | number of layers covered |
736 +----------+----------+--------------------------------------+
737 | ``last`` | ``num`` | upper range value |
738 +----------+----------+--------------------------------------+
739 | ``mask`` | ``num`` | zeroed to cover any number of layers |
740 +----------+----------+--------------------------------------+
742 Example for VXLAN TCP payload matching regardless of outer L3 (IPv4 or IPv6)
743 and L4 (UDP) both matched by the first ANY specification, and inner L3 (IPv4
744 or IPv6) matched by the second ANY specification:
746 .. _table_rte_flow_item_any_example:
748 .. table:: TCP in VXLAN with wildcards
750 +-------+------+----------+----------+-------+
751 | Index | Item | Field | Subfield | Value |
752 +=======+======+==========+==========+=======+
754 +-------+------+----------+----------+-------+
755 | 1 | ANY | ``spec`` | ``num`` | 2 |
756 +-------+------+----------+----------+-------+
758 +-------+------------------------------------+
760 +-------+------+----------+----------+-------+
761 | 4 | ANY | ``spec`` | ``num`` | 1 |
762 +-------+------+----------+----------+-------+
764 +-------+------------------------------------+
766 +-------+------------------------------------+
771 Matches a byte string of a given length at a given offset.
773 Offset is either absolute (using the start of the packet) or relative to the
774 end of the previous matched item in the stack, in which case negative values
777 If search is enabled, offset is used as the starting point. The search area
778 can be delimited by setting limit to a nonzero value, which is the maximum
779 number of bytes after offset where the pattern may start.
781 Matching a zero-length pattern is allowed, doing so resets the relative
782 offset for subsequent items.
784 - This type does not support ranges (``last`` field).
785 - Default ``mask`` matches all fields exactly.
787 .. _table_rte_flow_item_raw:
791 +----------+--------------+-------------------------------------------------+
792 | Field | Subfield | Value |
793 +==========+==============+=================================================+
794 | ``spec`` | ``relative`` | look for pattern after the previous item |
795 | +--------------+-------------------------------------------------+
796 | | ``search`` | search pattern from offset (see also ``limit``) |
797 | +--------------+-------------------------------------------------+
798 | | ``reserved`` | reserved, must be set to zero |
799 | +--------------+-------------------------------------------------+
800 | | ``offset`` | absolute or relative offset for ``pattern`` |
801 | +--------------+-------------------------------------------------+
802 | | ``limit`` | search area limit for start of ``pattern`` |
803 | +--------------+-------------------------------------------------+
804 | | ``length`` | ``pattern`` length |
805 | +--------------+-------------------------------------------------+
806 | | ``pattern`` | byte string to look for |
807 +----------+--------------+-------------------------------------------------+
808 | ``last`` | if specified, either all 0 or with the same values as ``spec`` |
809 +----------+----------------------------------------------------------------+
810 | ``mask`` | bit-mask applied to ``spec`` values with usual behavior |
811 +----------+----------------------------------------------------------------+
813 Example pattern looking for several strings at various offsets of a UDP
814 payload, using combined RAW items:
816 .. _table_rte_flow_item_raw_example:
818 .. table:: UDP payload matching
820 +-------+------+----------+--------------+-------+
821 | Index | Item | Field | Subfield | Value |
822 +=======+======+==========+==============+=======+
824 +-------+----------------------------------------+
826 +-------+----------------------------------------+
828 +-------+------+----------+--------------+-------+
829 | 3 | RAW | ``spec`` | ``relative`` | 1 |
830 | | | +--------------+-------+
831 | | | | ``search`` | 1 |
832 | | | +--------------+-------+
833 | | | | ``offset`` | 10 |
834 | | | +--------------+-------+
835 | | | | ``limit`` | 0 |
836 | | | +--------------+-------+
837 | | | | ``length`` | 3 |
838 | | | +--------------+-------+
839 | | | | ``pattern`` | "foo" |
840 +-------+------+----------+--------------+-------+
841 | 4 | RAW | ``spec`` | ``relative`` | 1 |
842 | | | +--------------+-------+
843 | | | | ``search`` | 0 |
844 | | | +--------------+-------+
845 | | | | ``offset`` | 20 |
846 | | | +--------------+-------+
847 | | | | ``limit`` | 0 |
848 | | | +--------------+-------+
849 | | | | ``length`` | 3 |
850 | | | +--------------+-------+
851 | | | | ``pattern`` | "bar" |
852 +-------+------+----------+--------------+-------+
853 | 5 | RAW | ``spec`` | ``relative`` | 1 |
854 | | | +--------------+-------+
855 | | | | ``search`` | 0 |
856 | | | +--------------+-------+
857 | | | | ``offset`` | -29 |
858 | | | +--------------+-------+
859 | | | | ``limit`` | 0 |
860 | | | +--------------+-------+
861 | | | | ``length`` | 3 |
862 | | | +--------------+-------+
863 | | | | ``pattern`` | "baz" |
864 +-------+------+----------+--------------+-------+
866 +-------+----------------------------------------+
870 - Locate "foo" at least 10 bytes deep inside UDP payload.
871 - Locate "bar" after "foo" plus 20 bytes.
872 - Locate "baz" after "bar" minus 29 bytes.
874 Such a packet may be represented as follows (not to scale)::
877 | |<--------->| |<--------->|
879 |-----|------|-----|-----|-----|-----|-----------|-----|------|
880 | ETH | IPv4 | UDP | ... | baz | foo | ......... | bar | .... |
881 |-----|------|-----|-----|-----|-----|-----------|-----|------|
883 |<--------------------------->|
886 Note that matching subsequent pattern items would resume after "baz", not
887 "bar" since matching is always performed after the previous item of the
893 Matches an Ethernet header.
895 The ``type`` field either stands for "EtherType" or "TPID" when followed by
896 so-called layer 2.5 pattern items such as ``RTE_FLOW_ITEM_TYPE_VLAN``. In
897 the latter case, ``type`` refers to that of the outer header, with the inner
898 EtherType/TPID provided by the subsequent pattern item. This is the same
899 order as on the wire.
900 If the ``type`` field contains a TPID value, then only tagged packets with the
901 specified TPID will match the pattern.
902 The field ``has_vlan`` can be used to match any type of tagged packets,
903 instead of using the ``type`` field.
904 If the ``type`` and ``has_vlan`` fields are not specified, then both tagged
905 and untagged packets will match the pattern.
907 - ``dst``: destination MAC.
908 - ``src``: source MAC.
909 - ``type``: EtherType or TPID.
910 - ``has_vlan``: packet header contains at least one VLAN.
911 - Default ``mask`` matches destination and source addresses only.
916 Matches an 802.1Q/ad VLAN tag.
918 The corresponding standard outer EtherType (TPID) values are
919 ``RTE_ETHER_TYPE_VLAN`` or ``RTE_ETHER_TYPE_QINQ``. It can be overridden by the
920 preceding pattern item.
921 If a ``VLAN`` item is present in the pattern, then only tagged packets will
923 The field ``has_more_vlan`` can be used to match any type of tagged packets,
924 instead of using the ``inner_type field``.
925 If the ``inner_type`` and ``has_more_vlan`` fields are not specified,
926 then any tagged packets will match the pattern.
928 - ``tci``: tag control information.
929 - ``inner_type``: inner EtherType or TPID.
930 - ``has_more_vlan``: packet header contains at least one more VLAN, after this VLAN.
931 - Default ``mask`` matches the VID part of TCI only (lower 12 bits).
936 Matches an IPv4 header.
938 Note: IPv4 options are handled by dedicated pattern items.
940 - ``hdr``: IPv4 header definition (``rte_ip.h``).
941 - Default ``mask`` matches source and destination addresses only.
946 Matches an IPv6 header.
948 Dedicated flags indicate if header contains specific extension headers.
949 To match on packets containing a specific extension header, an application
950 should match on the dedicated flag set to 1.
951 To match on packets not containing a specific extension header, an application
952 should match on the dedicated flag clear to 0.
953 In case application doesn't care about the existence of a specific extension
954 header, it should not specify the dedicated flag for matching.
956 - ``hdr``: IPv6 header definition (``rte_ip.h``).
957 - ``has_hop_ext``: header contains Hop-by-Hop Options extension header.
958 - ``has_route_ext``: header contains Routing extension header.
959 - ``has_frag_ext``: header contains Fragment extension header.
960 - ``has_auth_ext``: header contains Authentication extension header.
961 - ``has_esp_ext``: header contains Encapsulation Security Payload extension header.
962 - ``has_dest_ext``: header contains Destination Options extension header.
963 - ``has_mobil_ext``: header contains Mobility extension header.
964 - ``has_hip_ext``: header contains Host Identity Protocol extension header.
965 - ``has_shim6_ext``: header contains Shim6 Protocol extension header.
966 - Default ``mask`` matches ``hdr`` source and destination addresses only.
971 Matches an ICMP header.
973 - ``hdr``: ICMP header definition (``rte_icmp.h``).
974 - Default ``mask`` matches ICMP type and code only.
979 Matches a UDP header.
981 - ``hdr``: UDP header definition (``rte_udp.h``).
982 - Default ``mask`` matches source and destination ports only.
987 Matches a TCP header.
989 - ``hdr``: TCP header definition (``rte_tcp.h``).
990 - Default ``mask`` matches source and destination ports only.
995 Matches a SCTP header.
997 - ``hdr``: SCTP header definition (``rte_sctp.h``).
998 - Default ``mask`` matches source and destination ports only.
1003 Matches a VXLAN header (RFC 7348).
1005 - ``flags``: normally 0x08 (I flag).
1006 - ``rsvd0``: reserved, normally 0x000000.
1007 - ``vni``: VXLAN network identifier.
1008 - ``rsvd1``: reserved, normally 0x00.
1009 - Default ``mask`` matches VNI only.
1014 Matches an IEEE 802.1BR E-Tag header.
1016 The corresponding standard outer EtherType (TPID) value is
1017 ``RTE_ETHER_TYPE_ETAG``. It can be overridden by the preceding pattern item.
1019 - ``epcp_edei_in_ecid_b``: E-Tag control information (E-TCI), E-PCP (3b),
1020 E-DEI (1b), ingress E-CID base (12b).
1021 - ``rsvd_grp_ecid_b``: reserved (2b), GRP (2b), E-CID base (12b).
1022 - ``in_ecid_e``: ingress E-CID ext.
1023 - ``ecid_e``: E-CID ext.
1024 - ``inner_type``: inner EtherType or TPID.
1025 - Default ``mask`` simultaneously matches GRP and E-CID base.
1030 Matches a NVGRE header (RFC 7637).
1032 - ``c_k_s_rsvd0_ver``: checksum (1b), undefined (1b), key bit (1b),
1033 sequence number (1b), reserved 0 (9b), version (3b). This field must have
1034 value 0x2000 according to RFC 7637.
1035 - ``protocol``: protocol type (0x6558).
1036 - ``tni``: virtual subnet ID.
1037 - ``flow_id``: flow ID.
1038 - Default ``mask`` matches TNI only.
1043 Matches a MPLS header.
1045 - ``label_tc_s_ttl``: label, TC, Bottom of Stack and TTL.
1046 - Default ``mask`` matches label only.
1051 Matches a GRE header.
1053 - ``c_rsvd0_ver``: checksum, reserved 0 and version.
1054 - ``protocol``: protocol type.
1055 - Default ``mask`` matches protocol only.
1060 Matches a GRE key field.
1061 This should be preceded by item ``GRE``.
1063 - Value to be matched is a big-endian 32 bit integer.
1064 - When this item present it implicitly match K bit in default mask as "1"
1069 Fuzzy pattern match, expect faster than default.
1071 This is for device that support fuzzy match option. Usually a fuzzy match is
1072 fast but the cost is accuracy. i.e. Signature Match only match pattern's hash
1073 value, but it is possible two different patterns have the same hash value.
1075 Matching accuracy level can be configured by threshold. Driver can divide the
1076 range of threshold and map to different accuracy levels that device support.
1078 Threshold 0 means perfect match (no fuzziness), while threshold 0xffffffff
1079 means fuzziest match.
1081 .. _table_rte_flow_item_fuzzy:
1085 +----------+---------------+--------------------------------------------------+
1086 | Field | Subfield | Value |
1087 +==========+===============+==================================================+
1088 | ``spec`` | ``threshold`` | 0 as perfect match, 0xffffffff as fuzziest match |
1089 +----------+---------------+--------------------------------------------------+
1090 | ``last`` | ``threshold`` | upper range value |
1091 +----------+---------------+--------------------------------------------------+
1092 | ``mask`` | ``threshold`` | bit-mask apply to "spec" and "last" |
1093 +----------+---------------+--------------------------------------------------+
1095 Usage example, fuzzy match a TCPv4 packets:
1097 .. _table_rte_flow_item_fuzzy_example:
1099 .. table:: Fuzzy matching
1101 +-------+----------+
1103 +=======+==========+
1105 +-------+----------+
1107 +-------+----------+
1109 +-------+----------+
1111 +-------+----------+
1113 +-------+----------+
1115 Item: ``GTP``, ``GTPC``, ``GTPU``
1116 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1118 Matches a GTPv1 header.
1120 Note: GTP, GTPC and GTPU use the same structure. GTPC and GTPU item
1121 are defined for a user-friendly API when creating GTP-C and GTP-U
1124 - ``v_pt_rsv_flags``: version (3b), protocol type (1b), reserved (1b),
1125 extension header flag (1b), sequence number flag (1b), N-PDU number
1127 - ``msg_type``: message type.
1128 - ``msg_len``: message length.
1129 - ``teid``: tunnel endpoint identifier.
1130 - Default ``mask`` matches teid only.
1135 Matches an ESP header.
1137 - ``hdr``: ESP header definition (``rte_esp.h``).
1138 - Default ``mask`` matches SPI only.
1143 Matches a GENEVE header.
1145 - ``ver_opt_len_o_c_rsvd0``: version (2b), length of the options fields (6b),
1146 OAM packet (1b), critical options present (1b), reserved 0 (6b).
1147 - ``protocol``: protocol type.
1148 - ``vni``: virtual network identifier.
1149 - ``rsvd1``: reserved, normally 0x00.
1150 - Default ``mask`` matches VNI only.
1155 Matches a VXLAN-GPE header (draft-ietf-nvo3-vxlan-gpe-05).
1157 - ``flags``: normally 0x0C (I and P flags).
1158 - ``rsvd0``: reserved, normally 0x0000.
1159 - ``protocol``: protocol type.
1160 - ``vni``: VXLAN network identifier.
1161 - ``rsvd1``: reserved, normally 0x00.
1162 - Default ``mask`` matches VNI only.
1164 Item: ``ARP_ETH_IPV4``
1165 ^^^^^^^^^^^^^^^^^^^^^^
1167 Matches an ARP header for Ethernet/IPv4.
1169 - ``hdr``: hardware type, normally 1.
1170 - ``pro``: protocol type, normally 0x0800.
1171 - ``hln``: hardware address length, normally 6.
1172 - ``pln``: protocol address length, normally 4.
1173 - ``op``: opcode (1 for request, 2 for reply).
1174 - ``sha``: sender hardware address.
1175 - ``spa``: sender IPv4 address.
1176 - ``tha``: target hardware address.
1177 - ``tpa``: target IPv4 address.
1178 - Default ``mask`` matches SHA, SPA, THA and TPA.
1183 Matches the presence of any IPv6 extension header.
1185 - ``next_hdr``: next header.
1186 - Default ``mask`` matches ``next_hdr``.
1188 Normally preceded by any of:
1193 Item: ``IPV6_FRAG_EXT``
1194 ^^^^^^^^^^^^^^^^^^^^^^^
1196 Matches the presence of IPv6 fragment extension header.
1198 - ``hdr``: IPv6 fragment extension header definition (``rte_ip.h``).
1200 Normally preceded by any of:
1208 Matches any ICMPv6 header.
1210 - ``type``: ICMPv6 type.
1211 - ``code``: ICMPv6 code.
1212 - ``checksum``: ICMPv6 checksum.
1213 - Default ``mask`` matches ``type`` and ``code``.
1215 Item: ``ICMP6_ND_NS``
1216 ^^^^^^^^^^^^^^^^^^^^^
1218 Matches an ICMPv6 neighbor discovery solicitation.
1220 - ``type``: ICMPv6 type, normally 135.
1221 - ``code``: ICMPv6 code, normally 0.
1222 - ``checksum``: ICMPv6 checksum.
1223 - ``reserved``: reserved, normally 0.
1224 - ``target_addr``: target address.
1225 - Default ``mask`` matches target address only.
1227 Item: ``ICMP6_ND_NA``
1228 ^^^^^^^^^^^^^^^^^^^^^
1230 Matches an ICMPv6 neighbor discovery advertisement.
1232 - ``type``: ICMPv6 type, normally 136.
1233 - ``code``: ICMPv6 code, normally 0.
1234 - ``checksum``: ICMPv6 checksum.
1235 - ``rso_reserved``: route flag (1b), solicited flag (1b), override flag
1236 (1b), reserved (29b).
1237 - ``target_addr``: target address.
1238 - Default ``mask`` matches target address only.
1240 Item: ``ICMP6_ND_OPT``
1241 ^^^^^^^^^^^^^^^^^^^^^^
1243 Matches the presence of any ICMPv6 neighbor discovery option.
1245 - ``type``: ND option type.
1246 - ``length``: ND option length.
1247 - Default ``mask`` matches type only.
1249 Normally preceded by any of:
1251 - `Item: ICMP6_ND_NA`_
1252 - `Item: ICMP6_ND_NS`_
1253 - `Item: ICMP6_ND_OPT`_
1255 Item: ``ICMP6_ND_OPT_SLA_ETH``
1256 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1258 Matches an ICMPv6 neighbor discovery source Ethernet link-layer address
1261 - ``type``: ND option type, normally 1.
1262 - ``length``: ND option length, normally 1.
1263 - ``sla``: source Ethernet LLA.
1264 - Default ``mask`` matches source link-layer address only.
1266 Normally preceded by any of:
1268 - `Item: ICMP6_ND_NA`_
1269 - `Item: ICMP6_ND_OPT`_
1271 Item: ``ICMP6_ND_OPT_TLA_ETH``
1272 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1274 Matches an ICMPv6 neighbor discovery target Ethernet link-layer address
1277 - ``type``: ND option type, normally 2.
1278 - ``length``: ND option length, normally 1.
1279 - ``tla``: target Ethernet LLA.
1280 - Default ``mask`` matches target link-layer address only.
1282 Normally preceded by any of:
1284 - `Item: ICMP6_ND_NS`_
1285 - `Item: ICMP6_ND_OPT`_
1290 Matches an application specific 32 bit metadata item.
1292 - Default ``mask`` matches the specified metadata value.
1297 Matches a GTP PDU extension header with type 0x85.
1299 - ``pdu_type``: PDU type.
1300 - ``qfi``: QoS flow identifier.
1301 - Default ``mask`` matches QFI only.
1303 Item: ``PPPOES``, ``PPPOED``
1304 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1306 Matches a PPPoE header.
1308 - ``version_type``: version (4b), type (4b).
1309 - ``code``: message type.
1310 - ``session_id``: session identifier.
1311 - ``length``: payload length.
1313 Item: ``PPPOE_PROTO_ID``
1314 ^^^^^^^^^^^^^^^^^^^^^^^^
1316 Matches a PPPoE session protocol identifier.
1318 - ``proto_id``: PPP protocol identifier.
1319 - Default ``mask`` matches proto_id only.
1324 Matches a network service header (RFC 8300).
1326 - ``version``: normally 0x0 (2 bits).
1327 - ``oam_pkt``: indicate oam packet (1 bit).
1328 - ``reserved``: reserved bit (1 bit).
1329 - ``ttl``: maximum SFF hopes (6 bits).
1330 - ``length``: total length in 4 bytes words (6 bits).
1331 - ``reserved1``: reserved1 bits (4 bits).
1332 - ``mdtype``: ndicates format of NSH header (4 bits).
1333 - ``next_proto``: indicates protocol type of encap data (8 bits).
1334 - ``spi``: service path identifier (3 bytes).
1335 - ``sindex``: service index (1 byte).
1336 - Default ``mask`` matches mdtype, next_proto, spi, sindex.
1342 Matches a Internet Group Management Protocol (RFC 2236).
1344 - ``type``: IGMP message type (Query/Report).
1345 - ``max_resp_time``: max time allowed before sending report.
1346 - ``checksum``: checksum, 1s complement of whole IGMP message.
1347 - ``group_addr``: group address, for Query value will be 0.
1348 - Default ``mask`` matches group_addr.
1354 Matches a IP Authentication Header (RFC 4302).
1356 - ``next_hdr``: next payload after AH.
1357 - ``payload_len``: total length of AH in 4B words.
1358 - ``reserved``: reserved bits.
1359 - ``spi``: security parameters index.
1360 - ``seq_num``: counter value increased by 1 on each packet sent.
1361 - Default ``mask`` matches spi.
1366 Matches a HIGIG2 header field. It is layer 2.5 protocol and used in
1369 - Default ``mask`` matches classification and vlan.
1374 Matches a L2TPv3 over IP header.
1376 - ``session_id``: L2TPv3 over IP session identifier.
1377 - Default ``mask`` matches session_id only.
1382 Matches a PFCP Header.
1384 - ``s_field``: S field.
1385 - ``msg_type``: message type.
1386 - ``msg_len``: message length.
1387 - ``seid``: session endpoint identifier.
1388 - Default ``mask`` matches s_field and seid.
1393 Matches a eCPRI header.
1395 - ``hdr``: eCPRI header definition (``rte_ecpri.h``).
1396 - Default ``mask`` matches nothing, for all eCPRI messages.
1398 Item: ``PACKET_INTEGRITY_CHECKS``
1399 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1401 Matches packet integrity.
1402 For some devices application needs to enable integration checks in HW
1403 before using this item.
1405 - ``level``: the encapsulation level that should be checked:
1406 - ``level == 0`` means the default PMD mode (can be inner most / outermost).
1407 - ``level == 1`` means outermost header.
1408 - ``level > 1`` means inner header. See also RSS level.
1409 - ``packet_ok``: All HW packet integrity checks have passed based on the
1410 topmost network layer. For example, for ICMP packet the topmost network
1411 layer is L3 and for TCP or UDP packet the topmost network layer is L4.
1412 - ``l2_ok``: all layer 2 HW integrity checks passed.
1413 - ``l3_ok``: all layer 3 HW integrity checks passed.
1414 - ``l4_ok``: all layer 4 HW integrity checks passed.
1415 - ``l2_crc_ok``: layer 2 CRC check passed.
1416 - ``ipv4_csum_ok``: IPv4 checksum check passed.
1417 - ``l4_csum_ok``: layer 4 checksum check passed.
1418 - ``l3_len_ok``: the layer 3 length is smaller than the frame length.
1423 Matches a conntrack state after conntrack action.
1425 - ``flags``: conntrack packet state flags.
1426 - Default ``mask`` matches all state bits.
1431 Each possible action is represented by a type.
1432 An action can have an associated configuration object.
1433 Several actions combined in a list can be assigned
1434 to a flow rule and are performed in order.
1436 They fall in three categories:
1438 - Actions that modify the fate of matching traffic, for instance by dropping
1439 or assigning it a specific destination.
1441 - Actions that modify matching traffic contents or its properties. This
1442 includes adding/removing encapsulation, encryption, compression and marks.
1444 - Actions related to the flow rule itself, such as updating counters or
1445 making it non-terminating.
1447 Flow rules being terminating by default, not specifying any action of the
1448 fate kind results in undefined behavior. This applies to both ingress and
1451 PASSTHRU, when supported, makes a flow rule non-terminating.
1453 Like matching patterns, action lists are terminated by END items.
1455 Example of action that redirects packets to queue index 10:
1457 .. _table_rte_flow_action_example:
1459 .. table:: Queue action
1461 +-----------+-------+
1463 +===========+=======+
1465 +-----------+-------+
1467 Actions are performed in list order:
1469 .. _table_rte_flow_count_then_drop:
1471 .. table:: Count then drop
1485 .. _table_rte_flow_mark_count_redirect:
1487 .. table:: Mark, count then redirect
1489 +-------+--------+------------+-------+
1490 | Index | Action | Field | Value |
1491 +=======+========+============+=======+
1492 | 0 | MARK | ``mark`` | 0x2a |
1493 +-------+--------+------------+-------+
1494 | 1 | COUNT | ``shared`` | 0 |
1495 | | +------------+-------+
1497 +-------+--------+------------+-------+
1498 | 2 | QUEUE | ``queue`` | 10 |
1499 +-------+--------+------------+-------+
1501 +-------+-----------------------------+
1505 .. _table_rte_flow_redirect_queue_5:
1507 .. table:: Redirect to queue 5
1509 +-------+--------+-----------+-------+
1510 | Index | Action | Field | Value |
1511 +=======+========+===========+=======+
1513 +-------+--------+-----------+-------+
1514 | 1 | QUEUE | ``queue`` | 5 |
1515 +-------+--------+-----------+-------+
1517 +-------+----------------------------+
1519 In the above example, while DROP and QUEUE must be performed in order, both
1520 have to happen before reaching END. Only QUEUE has a visible effect.
1522 Note that such a list may be thought as ambiguous and rejected on that
1525 .. _table_rte_flow_redirect_queue_5_3:
1527 .. table:: Redirect to queues 5 and 3
1529 +-------+--------+-----------+-------+
1530 | Index | Action | Field | Value |
1531 +=======+========+===========+=======+
1532 | 0 | QUEUE | ``queue`` | 5 |
1533 +-------+--------+-----------+-------+
1535 +-------+--------+-----------+-------+
1536 | 2 | QUEUE | ``queue`` | 3 |
1537 +-------+--------+-----------+-------+
1539 +-------+----------------------------+
1541 As previously described, all actions must be taken into account. This
1542 effectively duplicates traffic to both queues. The above example also shows
1543 that VOID is ignored.
1548 Common action types are described in this section.
1553 End marker for action lists. Prevents further processing of actions, thereby
1556 - Its numeric value is 0 for convenience.
1557 - PMD support is mandatory.
1558 - No configurable properties.
1560 .. _table_rte_flow_action_end:
1573 Used as a placeholder for convenience. It is ignored and simply discarded by
1576 - PMD support is mandatory.
1577 - No configurable properties.
1579 .. _table_rte_flow_action_void:
1589 Action: ``PASSTHRU``
1590 ^^^^^^^^^^^^^^^^^^^^
1592 Leaves traffic up for additional processing by subsequent flow rules; makes
1593 a flow rule non-terminating.
1595 - No configurable properties.
1597 .. _table_rte_flow_action_passthru:
1607 Example to copy a packet to a queue and continue processing by subsequent
1610 .. _table_rte_flow_action_passthru_example:
1612 .. table:: Copy to queue 8
1614 +-------+--------+-----------+-------+
1615 | Index | Action | Field | Value |
1616 +=======+========+===========+=======+
1618 +-------+--------+-----------+-------+
1619 | 1 | QUEUE | ``queue`` | 8 |
1620 +-------+--------+-----------+-------+
1622 +-------+----------------------------+
1627 Redirects packets to a group on the current device.
1629 In a hierarchy of groups, which can be used to represent physical or logical
1630 flow group/tables on the device, this action redirects the matched flow to
1631 the specified group on that device.
1633 If a matched flow is redirected to a table which doesn't contain a matching
1634 rule for that flow then the behavior is undefined and the resulting behavior
1635 is up to the specific device. Best practice when using groups would be define
1636 a default flow rule for each group which a defines the default actions in that
1637 group so a consistent behavior is defined.
1639 Defining an action for matched flow in a group to jump to a group which is
1640 higher in the group hierarchy may not be supported by physical devices,
1641 depending on how groups are mapped to the physical devices. In the
1642 definitions of jump actions, applications should be aware that it may be
1643 possible to define flow rules which trigger an undefined behavior causing
1644 flows to loop between groups.
1646 .. _table_rte_flow_action_jump:
1650 +-----------+------------------------------+
1652 +===========+==============================+
1653 | ``group`` | Group to redirect packets to |
1654 +-----------+------------------------------+
1659 Attaches an integer value to packets and sets ``PKT_RX_FDIR`` and
1660 ``PKT_RX_FDIR_ID`` mbuf flags.
1662 This value is arbitrary and application-defined. Maximum allowed value
1663 depends on the underlying implementation. It is returned in the
1664 ``hash.fdir.hi`` mbuf field.
1666 .. _table_rte_flow_action_mark:
1670 +--------+--------------------------------------+
1672 +========+======================================+
1673 | ``id`` | integer value to return with packets |
1674 +--------+--------------------------------------+
1679 Flags packets. Similar to `Action: MARK`_ without a specific value; only
1680 sets the ``PKT_RX_FDIR`` mbuf flag.
1682 - No configurable properties.
1684 .. _table_rte_flow_action_flag:
1697 Assigns packets to a given queue index.
1699 .. _table_rte_flow_action_queue:
1703 +-----------+--------------------+
1705 +===========+====================+
1706 | ``index`` | queue index to use |
1707 +-----------+--------------------+
1714 - No configurable properties.
1716 .. _table_rte_flow_action_drop:
1729 Adds a counter action to a matched flow.
1731 If more than one count action is specified in a single flow rule, then each
1732 action must specify a unique id.
1734 Counters can be retrieved and reset through ``rte_flow_query()``, see
1735 ``struct rte_flow_query_count``.
1737 The shared flag indicates whether the counter is unique to the flow rule the
1738 action is specified with, or whether it is a shared counter.
1740 For a count action with the shared flag set, then a global device
1741 namespace is assumed for the counter id, so that any matched flow rules using
1742 a count action with the same counter id on the same port will contribute to
1745 For ports within the same switch domain then the counter id namespace extends
1746 to all ports within that switch domain.
1748 The shared flag is DEPRECATED and ``INDIRECT`` ``COUNT`` action should be used
1749 to make shared counters.
1751 .. _table_rte_flow_action_count:
1755 +------------+---------------------------------+
1757 +============+=================================+
1758 | ``shared`` | DEPRECATED, shared counter flag |
1759 +------------+---------------------------------+
1760 | ``id`` | counter id |
1761 +------------+---------------------------------+
1763 Query structure to retrieve and reset flow rule counters:
1765 .. _table_rte_flow_query_count:
1767 .. table:: COUNT query
1769 +---------------+-----+-----------------------------------+
1770 | Field | I/O | Value |
1771 +===============+=====+===================================+
1772 | ``reset`` | in | reset counter after query |
1773 +---------------+-----+-----------------------------------+
1774 | ``hits_set`` | out | ``hits`` field is set |
1775 +---------------+-----+-----------------------------------+
1776 | ``bytes_set`` | out | ``bytes`` field is set |
1777 +---------------+-----+-----------------------------------+
1778 | ``hits`` | out | number of hits for this rule |
1779 +---------------+-----+-----------------------------------+
1780 | ``bytes`` | out | number of bytes through this rule |
1781 +---------------+-----+-----------------------------------+
1786 Similar to QUEUE, except RSS is additionally performed on packets to spread
1787 them among several queues according to the provided parameters.
1789 Unlike global RSS settings used by other DPDK APIs, unsetting the ``types``
1790 field does not disable RSS in a flow rule. Doing so instead requests safe
1791 unspecified "best-effort" settings from the underlying PMD, which depending
1792 on the flow rule, may result in anything ranging from empty (single queue)
1793 to all-inclusive RSS.
1795 If non-applicable for matching packets RSS types are requested,
1796 these RSS types are simply ignored. For example, it happens if:
1798 - Hashing of both TCP and UDP ports is requested
1799 (only one can be present in a packet).
1801 - Requested RSS types contradict to flow rule pattern
1802 (e.g. pattern has UDP item, but RSS types contain TCP).
1804 If requested RSS hash types are not supported by the Ethernet device at all
1805 (not reported in ``dev_info.flow_type_rss_offloads``),
1806 the flow creation will fail.
1808 Note: RSS hash result is stored in the ``hash.rss`` mbuf field which
1809 overlaps ``hash.fdir.lo``. Since `Action: MARK`_ sets the ``hash.fdir.hi``
1810 field only, both can be requested simultaneously.
1812 Also, regarding packet encapsulation ``level``:
1814 - ``0`` requests the default behavior. Depending on the packet type, it can
1815 mean outermost, innermost, anything in between or even no RSS.
1817 It basically stands for the innermost encapsulation level RSS can be
1818 performed on according to PMD and device capabilities.
1820 - ``1`` requests RSS to be performed on the outermost packet encapsulation
1823 - ``2`` and subsequent values request RSS to be performed on the specified
1824 inner packet encapsulation level, from outermost to innermost (lower to
1827 Values other than ``0`` are not necessarily supported.
1829 Requesting a specific RSS level on unrecognized traffic results in undefined
1830 behavior. For predictable results, it is recommended to make the flow rule
1831 pattern match packet headers up to the requested encapsulation level so that
1832 only matching traffic goes through.
1834 .. _table_rte_flow_action_rss:
1838 +---------------+---------------------------------------------+
1840 +===============+=============================================+
1841 | ``func`` | RSS hash function to apply |
1842 +---------------+---------------------------------------------+
1843 | ``level`` | encapsulation level for ``types`` |
1844 +---------------+---------------------------------------------+
1845 | ``types`` | specific RSS hash types (see ``ETH_RSS_*``) |
1846 +---------------+---------------------------------------------+
1847 | ``key_len`` | hash key length in bytes |
1848 +---------------+---------------------------------------------+
1849 | ``queue_num`` | number of entries in ``queue`` |
1850 +---------------+---------------------------------------------+
1851 | ``key`` | hash key |
1852 +---------------+---------------------------------------------+
1853 | ``queue`` | queue indices to use |
1854 +---------------+---------------------------------------------+
1859 Directs matching traffic to the physical function (PF) of the current
1864 - No configurable properties.
1866 .. _table_rte_flow_action_pf:
1879 Directs matching traffic to a given virtual function of the current device.
1881 Packets matched by a VF pattern item can be redirected to their original VF
1882 ID instead of the specified one. This parameter may not be available and is
1883 not guaranteed to work properly if the VF part is matched by a prior flow
1884 rule or if packets are not addressed to a VF in the first place.
1888 .. _table_rte_flow_action_vf:
1892 +--------------+--------------------------------+
1894 +==============+================================+
1895 | ``original`` | use original VF ID if possible |
1896 +--------------+--------------------------------+
1898 +--------------+--------------------------------+
1900 Action: ``PHY_PORT``
1901 ^^^^^^^^^^^^^^^^^^^^
1903 Directs matching traffic to a given physical port index of the underlying
1906 See `Item: PHY_PORT`_.
1908 .. _table_rte_flow_action_phy_port:
1912 +--------------+-------------------------------------+
1914 +==============+=====================================+
1915 | ``original`` | use original port index if possible |
1916 +--------------+-------------------------------------+
1917 | ``index`` | physical port index |
1918 +--------------+-------------------------------------+
1922 Directs matching traffic to a given DPDK port ID.
1924 See `Item: PORT_ID`_.
1926 .. _table_rte_flow_action_port_id:
1930 +--------------+---------------------------------------+
1932 +==============+=======================================+
1933 | ``original`` | use original DPDK port ID if possible |
1934 +--------------+---------------------------------------+
1935 | ``id`` | DPDK port ID |
1936 +--------------+---------------------------------------+
1941 Applies a stage of metering and policing.
1943 The metering and policing (MTR) object has to be first created using the
1944 rte_mtr_create() API function. The ID of the MTR object is specified as
1945 action parameter. More than one flow can use the same MTR object through
1946 the meter action. The MTR object can be further updated or queried using
1949 .. _table_rte_flow_action_meter:
1953 +--------------+---------------+
1955 +==============+===============+
1956 | ``mtr_id`` | MTR object ID |
1957 +--------------+---------------+
1959 Action: ``SECURITY``
1960 ^^^^^^^^^^^^^^^^^^^^
1962 Perform the security action on flows matched by the pattern items
1963 according to the configuration of the security session.
1965 This action modifies the payload of matched flows. For INLINE_CRYPTO, the
1966 security protocol headers and IV are fully provided by the application as
1967 specified in the flow pattern. The payload of matching packets is
1968 encrypted on egress, and decrypted and authenticated on ingress.
1969 For INLINE_PROTOCOL, the security protocol is fully offloaded to HW,
1970 providing full encapsulation and decapsulation of packets in security
1971 protocols. The flow pattern specifies both the outer security header fields
1972 and the inner packet fields. The security session specified in the action
1973 must match the pattern parameters.
1975 The security session specified in the action must be created on the same
1976 port as the flow action that is being specified.
1978 The ingress/egress flow attribute should match that specified in the
1979 security session if the security session supports the definition of the
1982 Multiple flows can be configured to use the same security session.
1984 .. _table_rte_flow_action_security:
1988 +----------------------+--------------------------------------+
1990 +======================+======================================+
1991 | ``security_session`` | security session to apply |
1992 +----------------------+--------------------------------------+
1994 The following is an example of configuring IPsec inline using the
1995 INLINE_CRYPTO security session:
1997 The encryption algorithm, keys and salt are part of the opaque
1998 ``rte_security_session``. The SA is identified according to the IP and ESP
1999 fields in the pattern items.
2001 .. _table_rte_flow_item_esp_inline_example:
2003 .. table:: IPsec inline crypto flow pattern items.
2005 +-------+----------+
2007 +=======+==========+
2009 +-------+----------+
2011 +-------+----------+
2013 +-------+----------+
2015 +-------+----------+
2017 .. _table_rte_flow_action_esp_inline_example:
2019 .. table:: IPsec inline flow actions.
2021 +-------+----------+
2023 +=======+==========+
2025 +-------+----------+
2027 +-------+----------+
2029 Action: ``OF_SET_MPLS_TTL``
2030 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
2032 Implements ``OFPAT_SET_MPLS_TTL`` ("MPLS TTL") as defined by the `OpenFlow
2033 Switch Specification`_.
2035 .. _table_rte_flow_action_of_set_mpls_ttl:
2037 .. table:: OF_SET_MPLS_TTL
2039 +--------------+----------+
2041 +==============+==========+
2042 | ``mpls_ttl`` | MPLS TTL |
2043 +--------------+----------+
2045 Action: ``OF_DEC_MPLS_TTL``
2046 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
2048 Implements ``OFPAT_DEC_MPLS_TTL`` ("decrement MPLS TTL") as defined by the
2049 `OpenFlow Switch Specification`_.
2051 .. _table_rte_flow_action_of_dec_mpls_ttl:
2053 .. table:: OF_DEC_MPLS_TTL
2061 Action: ``OF_SET_NW_TTL``
2062 ^^^^^^^^^^^^^^^^^^^^^^^^^
2064 Implements ``OFPAT_SET_NW_TTL`` ("IP TTL") as defined by the `OpenFlow
2065 Switch Specification`_.
2067 .. _table_rte_flow_action_of_set_nw_ttl:
2069 .. table:: OF_SET_NW_TTL
2071 +------------+--------+
2073 +============+========+
2074 | ``nw_ttl`` | IP TTL |
2075 +------------+--------+
2077 Action: ``OF_DEC_NW_TTL``
2078 ^^^^^^^^^^^^^^^^^^^^^^^^^
2080 Implements ``OFPAT_DEC_NW_TTL`` ("decrement IP TTL") as defined by the
2081 `OpenFlow Switch Specification`_.
2083 .. _table_rte_flow_action_of_dec_nw_ttl:
2085 .. table:: OF_DEC_NW_TTL
2093 Action: ``OF_COPY_TTL_OUT``
2094 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
2096 Implements ``OFPAT_COPY_TTL_OUT`` ("copy TTL "outwards" -- from
2097 next-to-outermost to outermost") as defined by the `OpenFlow Switch
2100 .. _table_rte_flow_action_of_copy_ttl_out:
2102 .. table:: OF_COPY_TTL_OUT
2110 Action: ``OF_COPY_TTL_IN``
2111 ^^^^^^^^^^^^^^^^^^^^^^^^^^
2113 Implements ``OFPAT_COPY_TTL_IN`` ("copy TTL "inwards" -- from outermost to
2114 next-to-outermost") as defined by the `OpenFlow Switch Specification`_.
2116 .. _table_rte_flow_action_of_copy_ttl_in:
2118 .. table:: OF_COPY_TTL_IN
2126 Action: ``OF_POP_VLAN``
2127 ^^^^^^^^^^^^^^^^^^^^^^^
2129 Implements ``OFPAT_POP_VLAN`` ("pop the outer VLAN tag") as defined
2130 by the `OpenFlow Switch Specification`_.
2132 .. _table_rte_flow_action_of_pop_vlan:
2134 .. table:: OF_POP_VLAN
2142 Action: ``OF_PUSH_VLAN``
2143 ^^^^^^^^^^^^^^^^^^^^^^^^
2145 Implements ``OFPAT_PUSH_VLAN`` ("push a new VLAN tag") as defined by the
2146 `OpenFlow Switch Specification`_.
2148 .. _table_rte_flow_action_of_push_vlan:
2150 .. table:: OF_PUSH_VLAN
2152 +---------------+-----------+
2154 +===============+===========+
2155 | ``ethertype`` | EtherType |
2156 +---------------+-----------+
2158 Action: ``OF_SET_VLAN_VID``
2159 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
2161 Implements ``OFPAT_SET_VLAN_VID`` ("set the 802.1q VLAN id") as defined by
2162 the `OpenFlow Switch Specification`_.
2164 .. _table_rte_flow_action_of_set_vlan_vid:
2166 .. table:: OF_SET_VLAN_VID
2168 +--------------+---------+
2170 +==============+=========+
2171 | ``vlan_vid`` | VLAN id |
2172 +--------------+---------+
2174 Action: ``OF_SET_VLAN_PCP``
2175 ^^^^^^^^^^^^^^^^^^^^^^^^^^^
2177 Implements ``OFPAT_SET_LAN_PCP`` ("set the 802.1q priority") as defined by
2178 the `OpenFlow Switch Specification`_.
2180 .. _table_rte_flow_action_of_set_vlan_pcp:
2182 .. table:: OF_SET_VLAN_PCP
2184 +--------------+---------------+
2186 +==============+===============+
2187 | ``vlan_pcp`` | VLAN priority |
2188 +--------------+---------------+
2190 Action: ``OF_POP_MPLS``
2191 ^^^^^^^^^^^^^^^^^^^^^^^
2193 Implements ``OFPAT_POP_MPLS`` ("pop the outer MPLS tag") as defined by the
2194 `OpenFlow Switch Specification`_.
2196 .. _table_rte_flow_action_of_pop_mpls:
2198 .. table:: OF_POP_MPLS
2200 +---------------+-----------+
2202 +===============+===========+
2203 | ``ethertype`` | EtherType |
2204 +---------------+-----------+
2206 Action: ``OF_PUSH_MPLS``
2207 ^^^^^^^^^^^^^^^^^^^^^^^^
2209 Implements ``OFPAT_PUSH_MPLS`` ("push a new MPLS tag") as defined by the
2210 `OpenFlow Switch Specification`_.
2212 .. _table_rte_flow_action_of_push_mpls:
2214 .. table:: OF_PUSH_MPLS
2216 +---------------+-----------+
2218 +===============+===========+
2219 | ``ethertype`` | EtherType |
2220 +---------------+-----------+
2222 Action: ``VXLAN_ENCAP``
2223 ^^^^^^^^^^^^^^^^^^^^^^^
2225 Performs a VXLAN encapsulation action by encapsulating the matched flow in the
2226 VXLAN tunnel as defined in the``rte_flow_action_vxlan_encap`` flow items
2229 This action modifies the payload of matched flows. The flow definition specified
2230 in the ``rte_flow_action_tunnel_encap`` action structure must define a valid
2231 VLXAN network overlay which conforms with RFC 7348 (Virtual eXtensible Local
2232 Area Network (VXLAN): A Framework for Overlaying Virtualized Layer 2 Networks
2233 over Layer 3 Networks). The pattern must be terminated with the
2234 RTE_FLOW_ITEM_TYPE_END item type.
2236 .. _table_rte_flow_action_vxlan_encap:
2238 .. table:: VXLAN_ENCAP
2240 +----------------+-------------------------------------+
2242 +================+=====================================+
2243 | ``definition`` | Tunnel end-point overlay definition |
2244 +----------------+-------------------------------------+
2246 .. _table_rte_flow_action_vxlan_encap_example:
2248 .. table:: IPv4 VxLAN flow pattern example.
2250 +-------+----------+
2252 +=======+==========+
2254 +-------+----------+
2256 +-------+----------+
2258 +-------+----------+
2260 +-------+----------+
2262 +-------+----------+
2264 Action: ``VXLAN_DECAP``
2265 ^^^^^^^^^^^^^^^^^^^^^^^
2267 Performs a decapsulation action by stripping all headers of the VXLAN tunnel
2268 network overlay from the matched flow.
2270 The flow items pattern defined for the flow rule with which a ``VXLAN_DECAP``
2271 action is specified, must define a valid VXLAN tunnel as per RFC7348. If the
2272 flow pattern does not specify a valid VXLAN tunnel then a
2273 RTE_FLOW_ERROR_TYPE_ACTION error should be returned.
2275 This action modifies the payload of matched flows.
2277 Action: ``NVGRE_ENCAP``
2278 ^^^^^^^^^^^^^^^^^^^^^^^
2280 Performs a NVGRE encapsulation action by encapsulating the matched flow in the
2281 NVGRE tunnel as defined in the``rte_flow_action_tunnel_encap`` flow item
2284 This action modifies the payload of matched flows. The flow definition specified
2285 in the ``rte_flow_action_tunnel_encap`` action structure must defined a valid
2286 NVGRE network overlay which conforms with RFC 7637 (NVGRE: Network
2287 Virtualization Using Generic Routing Encapsulation). The pattern must be
2288 terminated with the RTE_FLOW_ITEM_TYPE_END item type.
2290 .. _table_rte_flow_action_nvgre_encap:
2292 .. table:: NVGRE_ENCAP
2294 +----------------+-------------------------------------+
2296 +================+=====================================+
2297 | ``definition`` | NVGRE end-point overlay definition |
2298 +----------------+-------------------------------------+
2300 .. _table_rte_flow_action_nvgre_encap_example:
2302 .. table:: IPv4 NVGRE flow pattern example.
2304 +-------+----------+
2306 +=======+==========+
2308 +-------+----------+
2310 +-------+----------+
2312 +-------+----------+
2314 +-------+----------+
2316 Action: ``NVGRE_DECAP``
2317 ^^^^^^^^^^^^^^^^^^^^^^^
2319 Performs a decapsulation action by stripping all headers of the NVGRE tunnel
2320 network overlay from the matched flow.
2322 The flow items pattern defined for the flow rule with which a ``NVGRE_DECAP``
2323 action is specified, must define a valid NVGRE tunnel as per RFC7637. If the
2324 flow pattern does not specify a valid NVGRE tunnel then a
2325 RTE_FLOW_ERROR_TYPE_ACTION error should be returned.
2327 This action modifies the payload of matched flows.
2329 Action: ``RAW_ENCAP``
2330 ^^^^^^^^^^^^^^^^^^^^^
2332 Adds outer header whose template is provided in its data buffer,
2333 as defined in the ``rte_flow_action_raw_encap`` definition.
2335 This action modifies the payload of matched flows. The data supplied must
2336 be a valid header, either holding layer 2 data in case of adding layer 2 after
2337 decap layer 3 tunnel (for example MPLSoGRE) or complete tunnel definition
2338 starting from layer 2 and moving to the tunnel item itself. When applied to
2339 the original packet the resulting packet must be a valid packet.
2341 .. _table_rte_flow_action_raw_encap:
2343 .. table:: RAW_ENCAP
2345 +----------------+----------------------------------------+
2347 +================+========================================+
2348 | ``data`` | Encapsulation data |
2349 +----------------+----------------------------------------+
2350 | ``preserve`` | Bit-mask of data to preserve on output |
2351 +----------------+----------------------------------------+
2352 | ``size`` | Size of data and preserve |
2353 +----------------+----------------------------------------+
2355 Action: ``RAW_DECAP``
2356 ^^^^^^^^^^^^^^^^^^^^^^^
2358 Remove outer header whose template is provided in its data buffer,
2359 as defined in the ``rte_flow_action_raw_decap``
2361 This action modifies the payload of matched flows. The data supplied must
2362 be a valid header, either holding layer 2 data in case of removing layer 2
2363 before encapsulation of layer 3 tunnel (for example MPLSoGRE) or complete
2364 tunnel definition starting from layer 2 and moving to the tunnel item itself.
2365 When applied to the original packet the resulting packet must be a
2368 .. _table_rte_flow_action_raw_decap:
2370 .. table:: RAW_DECAP
2372 +----------------+----------------------------------------+
2374 +================+========================================+
2375 | ``data`` | Decapsulation data |
2376 +----------------+----------------------------------------+
2377 | ``size`` | Size of data |
2378 +----------------+----------------------------------------+
2380 Action: ``SET_IPV4_SRC``
2381 ^^^^^^^^^^^^^^^^^^^^^^^^
2383 Set a new IPv4 source address in the outermost IPv4 header.
2385 It must be used with a valid RTE_FLOW_ITEM_TYPE_IPV4 flow pattern item.
2386 Otherwise, RTE_FLOW_ERROR_TYPE_ACTION error will be returned.
2388 .. _table_rte_flow_action_set_ipv4_src:
2390 .. table:: SET_IPV4_SRC
2392 +-----------------------------------------+
2394 +===============+=========================+
2395 | ``ipv4_addr`` | new IPv4 source address |
2396 +---------------+-------------------------+
2398 Action: ``SET_IPV4_DST``
2399 ^^^^^^^^^^^^^^^^^^^^^^^^
2401 Set a new IPv4 destination address in the outermost IPv4 header.
2403 It must be used with a valid RTE_FLOW_ITEM_TYPE_IPV4 flow pattern item.
2404 Otherwise, RTE_FLOW_ERROR_TYPE_ACTION error will be returned.
2406 .. _table_rte_flow_action_set_ipv4_dst:
2408 .. table:: SET_IPV4_DST
2410 +---------------+------------------------------+
2412 +===============+==============================+
2413 | ``ipv4_addr`` | new IPv4 destination address |
2414 +---------------+------------------------------+
2416 Action: ``SET_IPV6_SRC``
2417 ^^^^^^^^^^^^^^^^^^^^^^^^
2419 Set a new IPv6 source address in the outermost IPv6 header.
2421 It must be used with a valid RTE_FLOW_ITEM_TYPE_IPV6 flow pattern item.
2422 Otherwise, RTE_FLOW_ERROR_TYPE_ACTION error will be returned.
2424 .. _table_rte_flow_action_set_ipv6_src:
2426 .. table:: SET_IPV6_SRC
2428 +---------------+-------------------------+
2430 +===============+=========================+
2431 | ``ipv6_addr`` | new IPv6 source address |
2432 +---------------+-------------------------+
2434 Action: ``SET_IPV6_DST``
2435 ^^^^^^^^^^^^^^^^^^^^^^^^
2437 Set a new IPv6 destination address in the outermost IPv6 header.
2439 It must be used with a valid RTE_FLOW_ITEM_TYPE_IPV6 flow pattern item.
2440 Otherwise, RTE_FLOW_ERROR_TYPE_ACTION error will be returned.
2442 .. _table_rte_flow_action_set_ipv6_dst:
2444 .. table:: SET_IPV6_DST
2446 +---------------+------------------------------+
2448 +===============+==============================+
2449 | ``ipv6_addr`` | new IPv6 destination address |
2450 +---------------+------------------------------+
2452 Action: ``SET_TP_SRC``
2453 ^^^^^^^^^^^^^^^^^^^^^^^^^
2455 Set a new source port number in the outermost TCP/UDP header.
2457 It must be used with a valid RTE_FLOW_ITEM_TYPE_TCP or RTE_FLOW_ITEM_TYPE_UDP
2458 flow pattern item. Otherwise, RTE_FLOW_ERROR_TYPE_ACTION error will be returned.
2460 .. _table_rte_flow_action_set_tp_src:
2462 .. table:: SET_TP_SRC
2464 +----------+-------------------------+
2466 +==========+=========================+
2467 | ``port`` | new TCP/UDP source port |
2468 +---------------+--------------------+
2470 Action: ``SET_TP_DST``
2471 ^^^^^^^^^^^^^^^^^^^^^^^^^
2473 Set a new destination port number in the outermost TCP/UDP header.
2475 It must be used with a valid RTE_FLOW_ITEM_TYPE_TCP or RTE_FLOW_ITEM_TYPE_UDP
2476 flow pattern item. Otherwise, RTE_FLOW_ERROR_TYPE_ACTION error will be returned.
2478 .. _table_rte_flow_action_set_tp_dst:
2480 .. table:: SET_TP_DST
2482 +----------+------------------------------+
2484 +==========+==============================+
2485 | ``port`` | new TCP/UDP destination port |
2486 +---------------+-------------------------+
2488 Action: ``MAC_SWAP``
2489 ^^^^^^^^^^^^^^^^^^^^^^^^^
2491 Swap the source and destination MAC addresses in the outermost Ethernet
2494 It must be used with a valid RTE_FLOW_ITEM_TYPE_ETH flow pattern item.
2495 Otherwise, RTE_FLOW_ERROR_TYPE_ACTION error will be returned.
2497 .. _table_rte_flow_action_mac_swap:
2512 If there is no valid RTE_FLOW_ITEM_TYPE_IPV4 or RTE_FLOW_ITEM_TYPE_IPV6
2513 in pattern, Some PMDs will reject rule because behavior will be undefined.
2515 .. _table_rte_flow_action_dec_ttl:
2528 Assigns a new TTL value.
2530 If there is no valid RTE_FLOW_ITEM_TYPE_IPV4 or RTE_FLOW_ITEM_TYPE_IPV6
2531 in pattern, Some PMDs will reject rule because behavior will be undefined.
2533 .. _table_rte_flow_action_set_ttl:
2537 +---------------+--------------------+
2539 +===============+====================+
2540 | ``ttl_value`` | new TTL value |
2541 +---------------+--------------------+
2543 Action: ``SET_MAC_SRC``
2544 ^^^^^^^^^^^^^^^^^^^^^^^
2546 Set source MAC address.
2548 It must be used with a valid RTE_FLOW_ITEM_TYPE_ETH flow pattern item.
2549 Otherwise, RTE_FLOW_ERROR_TYPE_ACTION error will be returned.
2551 .. _table_rte_flow_action_set_mac_src:
2553 .. table:: SET_MAC_SRC
2555 +--------------+---------------+
2557 +==============+===============+
2558 | ``mac_addr`` | MAC address |
2559 +--------------+---------------+
2561 Action: ``SET_MAC_DST``
2562 ^^^^^^^^^^^^^^^^^^^^^^^
2564 Set destination MAC address.
2566 It must be used with a valid RTE_FLOW_ITEM_TYPE_ETH flow pattern item.
2567 Otherwise, RTE_FLOW_ERROR_TYPE_ACTION error will be returned.
2569 .. _table_rte_flow_action_set_mac_dst:
2571 .. table:: SET_MAC_DST
2573 +--------------+---------------+
2575 +==============+===============+
2576 | ``mac_addr`` | MAC address |
2577 +--------------+---------------+
2579 Action: ``INC_TCP_SEQ``
2580 ^^^^^^^^^^^^^^^^^^^^^^^
2582 Increase sequence number in the outermost TCP header.
2583 Value to increase TCP sequence number by is a big-endian 32 bit integer.
2585 Using this action on non-matching traffic will result in undefined behavior.
2587 Action: ``DEC_TCP_SEQ``
2588 ^^^^^^^^^^^^^^^^^^^^^^^
2590 Decrease sequence number in the outermost TCP header.
2591 Value to decrease TCP sequence number by is a big-endian 32 bit integer.
2593 Using this action on non-matching traffic will result in undefined behavior.
2595 Action: ``INC_TCP_ACK``
2596 ^^^^^^^^^^^^^^^^^^^^^^^
2598 Increase acknowledgment number in the outermost TCP header.
2599 Value to increase TCP acknowledgment number by is a big-endian 32 bit integer.
2601 Using this action on non-matching traffic will result in undefined behavior.
2603 Action: ``DEC_TCP_ACK``
2604 ^^^^^^^^^^^^^^^^^^^^^^^
2606 Decrease acknowledgment number in the outermost TCP header.
2607 Value to decrease TCP acknowledgment number by is a big-endian 32 bit integer.
2609 Using this action on non-matching traffic will result in undefined behavior.
2616 Tag is a transient data used during flow matching. This is not delivered to
2617 application. Multiple tags are supported by specifying index.
2619 .. _table_rte_flow_action_set_tag:
2623 +-----------+----------------------------+
2625 +===========+============================+
2626 | ``data`` | 32 bit tag value |
2627 +-----------+----------------------------+
2628 | ``mask`` | bit-mask applies to "data" |
2629 +-----------+----------------------------+
2630 | ``index`` | index of tag to set |
2631 +-----------+----------------------------+
2633 Action: ``SET_META``
2634 ^^^^^^^^^^^^^^^^^^^^^^^
2636 Set metadata. Item ``META`` matches metadata.
2638 Metadata set by mbuf metadata field with PKT_TX_DYNF_METADATA flag on egress
2639 will be overridden by this action. On ingress, the metadata will be carried by
2640 ``metadata`` dynamic field of ``rte_mbuf`` which can be accessed by
2641 ``RTE_FLOW_DYNF_METADATA()``. PKT_RX_DYNF_METADATA flag will be set along
2644 The mbuf dynamic field must be registered by calling
2645 ``rte_flow_dynf_metadata_register()`` prior to use ``SET_META`` action.
2647 Altering partial bits is supported with ``mask``. For bits which have never been
2648 set, unpredictable value will be seen depending on driver implementation. For
2649 loopback/hairpin packet, metadata set on Rx/Tx may or may not be propagated to
2650 the other path depending on HW capability.
2652 In hairpin case with Tx explicit flow mode, metadata could (not mandatory) be
2653 used to connect the Rx and Tx flows if it can be propagated from Rx to Tx path.
2655 .. _table_rte_flow_action_set_meta:
2659 +----------+----------------------------+
2661 +==========+============================+
2662 | ``data`` | 32 bit metadata value |
2663 +----------+----------------------------+
2664 | ``mask`` | bit-mask applies to "data" |
2665 +----------+----------------------------+
2667 Action: ``SET_IPV4_DSCP``
2668 ^^^^^^^^^^^^^^^^^^^^^^^^^
2672 Modify DSCP in IPv4 header.
2674 It must be used with RTE_FLOW_ITEM_TYPE_IPV4 in pattern.
2675 Otherwise, RTE_FLOW_ERROR_TYPE_ACTION error will be returned.
2677 .. _table_rte_flow_action_set_ipv4_dscp:
2679 .. table:: SET_IPV4_DSCP
2681 +-----------+---------------------------------+
2683 +===========+=================================+
2684 | ``dscp`` | DSCP in low 6 bits, rest ignore |
2685 +-----------+---------------------------------+
2687 Action: ``SET_IPV6_DSCP``
2688 ^^^^^^^^^^^^^^^^^^^^^^^^^
2692 Modify DSCP in IPv6 header.
2694 It must be used with RTE_FLOW_ITEM_TYPE_IPV6 in pattern.
2695 Otherwise, RTE_FLOW_ERROR_TYPE_ACTION error will be returned.
2697 .. _table_rte_flow_action_set_ipv6_dscp:
2699 .. table:: SET_IPV6_DSCP
2701 +-----------+---------------------------------+
2703 +===========+=================================+
2704 | ``dscp`` | DSCP in low 6 bits, rest ignore |
2705 +-----------+---------------------------------+
2710 Set ageing timeout configuration to a flow.
2712 Event RTE_ETH_EVENT_FLOW_AGED will be reported if
2713 timeout passed without any matching on the flow.
2715 .. _table_rte_flow_action_age:
2719 +--------------+---------------------------------+
2721 +==============+=================================+
2722 | ``timeout`` | 24 bits timeout value |
2723 +--------------+---------------------------------+
2724 | ``reserved`` | 8 bits reserved, must be zero |
2725 +--------------+---------------------------------+
2726 | ``context`` | user input flow context |
2727 +--------------+---------------------------------+
2729 Query structure to retrieve ageing status information of a
2730 shared AGE action, or a flow rule using the AGE action:
2732 .. _table_rte_flow_query_age:
2734 .. table:: AGE query
2736 +------------------------------+-----+----------------------------------------+
2737 | Field | I/O | Value |
2738 +==============================+=====+========================================+
2739 | ``aged`` | out | Aging timeout expired |
2740 +------------------------------+-----+----------------------------------------+
2741 | ``sec_since_last_hit_valid`` | out | ``sec_since_last_hit`` value is valid |
2742 +------------------------------+-----+----------------------------------------+
2743 | ``sec_since_last_hit`` | out | Seconds since last traffic hit |
2744 +------------------------------+-----+----------------------------------------+
2749 Adds a sample action to a matched flow.
2751 The matching packets will be duplicated with the specified ``ratio`` and
2752 applied with own set of actions with a fate action, the packets sampled
2753 equals is '1/ratio'. All the packets continue to the target destination.
2755 When the ``ratio`` is set to 1 then the packets will be 100% mirrored.
2756 ``actions`` represent the different set of actions for the sampled or mirrored
2757 packets, and must have a fate action.
2759 .. _table_rte_flow_action_sample:
2763 +--------------+---------------------------------+
2765 +==============+=================================+
2766 | ``ratio`` | 32 bits sample ratio value |
2767 +--------------+---------------------------------+
2768 | ``actions`` | sub-action list for sampling |
2769 +--------------+---------------------------------+
2771 Action: ``INDIRECT``
2772 ^^^^^^^^^^^^^^^^^^^^
2774 Flow utilize indirect action by handle as returned from
2775 ``rte_flow_action_handle_create()``.
2777 The behaviour of the indirect action defined by ``action`` argument of type
2778 ``struct rte_flow_action`` passed to ``rte_flow_action_handle_create()``.
2780 The indirect action can be used by a single flow or shared among multiple flows.
2781 The indirect action can be in-place updated by ``rte_flow_action_handle_update()``
2782 without destroying flow and creating flow again. The fields that could be
2783 updated depend on the type of the ``action`` and different for every type.
2785 The indirect action specified data (e.g. counter) can be queried by
2786 ``rte_flow_action_handle_query()``.
2788 .. _table_rte_flow_action_handle:
2798 Action: ``MODIFY_FIELD``
2799 ^^^^^^^^^^^^^^^^^^^^^^^^
2801 Modify ``dst`` field according to ``op`` selected (set, addition,
2802 subtraction) with ``width`` bits of data from ``src`` field.
2804 Any arbitrary header field (as well as mark, metadata or tag values)
2805 can be used as both source and destination fields as set by ``field``.
2806 The immediate value ``RTE_FLOW_FIELD_VALUE`` (or a pointer to it
2807 ``RTE_FLOW_FIELD_POINTER``) is allowed as a source only.
2808 ``RTE_FLOW_FIELD_START`` is used to point to the beginning of a packet.
2809 See ``enum rte_flow_field_id`` for the list of supported fields.
2811 ``op`` selects the operation to perform on a destination field.
2812 - ``set`` copies the data from ``src`` field to ``dst`` field.
2813 - ``add`` adds together ``dst`` and ``src`` and stores the result into ``dst``.
2814 - ``sub`` subtracts ``src`` from ``dst`` and stores the result into ``dst``
2816 ``width`` defines a number of bits to use from ``src`` field.
2818 ``level`` is used to access any packet field on any encapsulation level
2819 as well as any tag element in the tag array.
2820 - ``0`` means the default behaviour. Depending on the packet type, it can
2821 mean outermost, innermost or anything in between.
2822 - ``1`` requests access to the outermost packet encapsulation level.
2823 - ``2`` and subsequent values requests access to the specified packet
2824 encapsulation level, from outermost to innermost (lower to higher values).
2825 For the tag array (in case of multiple tags are supported and present)
2826 ``level`` translates directly into the array index.
2828 ``offset`` specifies the number of bits to skip from a field's start.
2829 That allows performing a partial copy of the needed part or to divide a big
2830 packet field into multiple smaller fields. Alternatively, ``offset`` allows
2831 going past the specified packet field boundary to copy a field to an
2832 arbitrary place in a packet, essentially providing a way to copy any part of
2833 a packet to any other part of it.
2835 ``value`` sets an immediate value to be used as a source or points to a
2836 location of the value in memory. It is used instead of ``level`` and ``offset``
2837 for ``RTE_FLOW_FIELD_VALUE`` and ``RTE_FLOW_FIELD_POINTER`` respectively.
2839 .. _table_rte_flow_action_modify_field:
2841 .. table:: MODIFY_FIELD
2843 +---------------+-------------------------+
2845 +===============+=========================+
2846 | ``op`` | operation to perform |
2847 +---------------+-------------------------+
2848 | ``dst`` | destination field |
2849 +---------------+-------------------------+
2850 | ``src`` | source field |
2851 +---------------+-------------------------+
2852 | ``width`` | number of bits to use |
2853 +---------------+-------------------------+
2855 .. _table_rte_flow_action_modify_data:
2857 .. table:: destination/source field definition
2859 +---------------+----------------------------------------------------------+
2861 +===============+==========================================================+
2862 | ``field`` | ID: packet field, mark, meta, tag, immediate, pointer |
2863 +---------------+----------------------------------------------------------+
2864 | ``level`` | encapsulation level of a packet field or tag array index |
2865 +---------------+----------------------------------------------------------+
2866 | ``offset`` | number of bits to skip at the beginning |
2867 +---------------+----------------------------------------------------------+
2868 | ``value`` | immediate value or a pointer to this value |
2869 +---------------+----------------------------------------------------------+
2871 Action: ``CONNTRACK``
2872 ^^^^^^^^^^^^^^^^^^^^^
2874 Create a conntrack (connection tracking) context with the provided information.
2876 In stateful session like TCP, the conntrack action provides the ability to
2877 examine every packet of this connection and associate the state to every
2878 packet. It will help to realize the stateful offload of connections with little
2879 software participation. For example, the packets with invalid state may be
2880 handled by the software. The control packets could be handled in the hardware.
2881 The software just need to query the state of a connection when needed, and then
2882 decide how to handle the flow rules and conntrack context.
2884 A conntrack context should be created via ``rte_flow_action_handle_create()``
2885 before using. Then the handle with ``INDIRECT`` type is used for a flow rule
2886 creation. If a flow rule with an opposite direction needs to be created, the
2887 ``rte_flow_action_handle_update()`` should be used to modify the direction.
2889 Not all the fields of the ``struct rte_flow_action_conntrack`` will be used
2890 for a conntrack context creating, depending on the HW, and they should be
2891 in host byte order. PMD should convert them into network byte order when
2894 The ``struct rte_flow_modify_conntrack`` should be used for an updating.
2896 The current conntrack context information could be queried via the
2897 ``rte_flow_action_handle_query()`` interface.
2899 .. _table_rte_flow_action_conntrack:
2901 .. table:: CONNTRACK
2903 +--------------------------+-------------------------------------------------------------+
2905 +==========================+=============================================================+
2906 | ``peer_port`` | peer port number |
2907 +--------------------------+-------------------------------------------------------------+
2908 | ``is_original_dir`` | direction of this connection for creating flow rule |
2909 +--------------------------+-------------------------------------------------------------+
2910 | ``enable`` | enable the conntrack context |
2911 +--------------------------+-------------------------------------------------------------+
2912 | ``live_connection`` | one ack was seen for this connection |
2913 +--------------------------+-------------------------------------------------------------+
2914 | ``selective_ack`` | SACK enabled |
2915 +--------------------------+-------------------------------------------------------------+
2916 | ``challenge_ack_passed`` | a challenge ack has passed |
2917 +--------------------------+-------------------------------------------------------------+
2918 | ``last_direction`` | direction of the last passed packet |
2919 +--------------------------+-------------------------------------------------------------+
2920 | ``liberal_mode`` | only report state change |
2921 +--------------------------+-------------------------------------------------------------+
2922 | ``state`` | current state |
2923 +--------------------------+-------------------------------------------------------------+
2924 | ``max_ack_window`` | maximal window scaling factor |
2925 +--------------------------+-------------------------------------------------------------+
2926 | ``retransmission_limit`` | maximal retransmission times |
2927 +--------------------------+-------------------------------------------------------------+
2928 | ``original_dir`` | TCP parameters of the original direction |
2929 +--------------------------+-------------------------------------------------------------+
2930 | ``reply_dir`` | TCP parameters of the reply direction |
2931 +--------------------------+-------------------------------------------------------------+
2932 | ``last_window`` | window size of the last passed packet |
2933 +--------------------------+-------------------------------------------------------------+
2934 | ``last_seq`` | sequence number of the last passed packet |
2935 +--------------------------+-------------------------------------------------------------+
2936 | ``last_ack`` | acknowledgment number the last passed packet |
2937 +--------------------------+-------------------------------------------------------------+
2938 | ``last_end`` | sum of ack number and length of the last passed packet |
2939 +--------------------------+-------------------------------------------------------------+
2941 .. _table_rte_flow_tcp_dir_param:
2943 .. table:: configuration parameters for each direction
2945 +---------------------+---------------------------------------------------------+
2947 +=====================+=========================================================+
2948 | ``scale`` | TCP window scaling factor |
2949 +---------------------+---------------------------------------------------------+
2950 | ``close_initiated`` | FIN sent from this direction |
2951 +---------------------+---------------------------------------------------------+
2952 | ``last_ack_seen`` | an ACK packet received |
2953 +---------------------+---------------------------------------------------------+
2954 | ``data_unacked`` | unacknowledged data for packets from this direction |
2955 +---------------------+---------------------------------------------------------+
2956 | ``sent_end`` | max{seq + len} seen in sent packets |
2957 +---------------------+---------------------------------------------------------+
2958 | ``reply_end`` | max{sack + max{win, 1}} seen in reply packets |
2959 +---------------------+---------------------------------------------------------+
2960 | ``max_win`` | max{max{win, 1}} + {sack - ack} seen in sent packets |
2961 +---------------------+---------------------------------------------------------+
2962 | ``max_ack`` | max{ack} + seen in sent packets |
2963 +---------------------+---------------------------------------------------------+
2965 .. _table_rte_flow_modify_conntrack:
2967 .. table:: update a conntrack context
2969 +----------------+-------------------------------------------------+
2971 +================+=================================================+
2972 | ``new_ct`` | new conntrack information |
2973 +----------------+-------------------------------------------------+
2974 | ``direction`` | direction will be updated |
2975 +----------------+-------------------------------------------------+
2976 | ``state`` | other fields except direction will be updated |
2977 +----------------+-------------------------------------------------+
2978 | ``reserved`` | reserved bits |
2979 +----------------+-------------------------------------------------+
2981 Action: ``METER_COLOR``
2982 ^^^^^^^^^^^^^^^^^^^^^^^
2984 Color the packet to reflect the meter color result.
2986 The meter action must be configured before meter color action.
2987 Meter color action is set to a color to reflect the meter color result.
2988 Set the meter color in the mbuf to the selected color.
2989 The meter color action output color is the output color of the packet,
2990 which is set in the packet meta-data (i.e. struct ``rte_mbuf::sched::color``)
2992 .. _table_rte_flow_action_meter_color:
2994 .. table:: METER_COLOR
2996 +-----------------+--------------+
2998 +=================+==============+
2999 | ``meter_color`` | Packet color |
3000 +-----------------+--------------+
3005 All specified pattern items (``enum rte_flow_item_type``) and actions
3006 (``enum rte_flow_action_type``) use positive identifiers.
3008 The negative space is reserved for dynamic types generated by PMDs during
3009 run-time. PMDs may encounter them as a result but must not accept negative
3010 identifiers they are not aware of.
3012 A method to generate them remains to be defined.
3014 Application may use PMD dynamic items or actions in flow rules. In that case
3015 size of configuration object in dynamic element must be a pointer size.
3020 A rather simple API with few functions is provided to fully manage flow
3023 Each created flow rule is associated with an opaque, PMD-specific handle
3024 pointer. The application is responsible for keeping it until the rule is
3027 Flows rules are represented by ``struct rte_flow`` objects.
3032 Given that expressing a definite set of device capabilities is not
3033 practical, a dedicated function is provided to check if a flow rule is
3034 supported and can be created.
3039 rte_flow_validate(uint16_t port_id,
3040 const struct rte_flow_attr *attr,
3041 const struct rte_flow_item pattern[],
3042 const struct rte_flow_action actions[],
3043 struct rte_flow_error *error);
3045 The flow rule is validated for correctness and whether it could be accepted
3046 by the device given sufficient resources. The rule is checked against the
3047 current device mode and queue configuration. The flow rule may also
3048 optionally be validated against existing flow rules and device resources.
3049 This function has no effect on the target device.
3051 The returned value is guaranteed to remain valid only as long as no
3052 successful calls to ``rte_flow_create()`` or ``rte_flow_destroy()`` are made
3053 in the meantime and no device parameter affecting flow rules in any way are
3054 modified, due to possible collisions or resource limitations (although in
3055 such cases ``EINVAL`` should not be returned).
3059 - ``port_id``: port identifier of Ethernet device.
3060 - ``attr``: flow rule attributes.
3061 - ``pattern``: pattern specification (list terminated by the END pattern
3063 - ``actions``: associated actions (list terminated by the END action).
3064 - ``error``: perform verbose error reporting if not NULL. PMDs initialize
3065 this structure in case of error only.
3069 - 0 if flow rule is valid and can be created. A negative errno value
3070 otherwise (``rte_errno`` is also set), the following errors are defined.
3071 - ``-ENOSYS``: underlying device does not support this functionality.
3072 - ``-EINVAL``: unknown or invalid rule specification.
3073 - ``-ENOTSUP``: valid but unsupported rule specification (e.g. partial
3074 bit-masks are unsupported).
3075 - ``EEXIST``: collision with an existing rule. Only returned if device
3076 supports flow rule collision checking and there was a flow rule
3077 collision. Not receiving this return code is no guarantee that creating
3078 the rule will not fail due to a collision.
3079 - ``ENOMEM``: not enough memory to execute the function, or if the device
3080 supports resource validation, resource limitation on the device.
3081 - ``-EBUSY``: action cannot be performed due to busy device resources, may
3082 succeed if the affected queues or even the entire port are in a stopped
3083 state (see ``rte_eth_dev_rx_queue_stop()`` and ``rte_eth_dev_stop()``).
3088 Creating a flow rule is similar to validating one, except the rule is
3089 actually created and a handle returned.
3094 rte_flow_create(uint16_t port_id,
3095 const struct rte_flow_attr *attr,
3096 const struct rte_flow_item pattern[],
3097 const struct rte_flow_action *actions[],
3098 struct rte_flow_error *error);
3102 - ``port_id``: port identifier of Ethernet device.
3103 - ``attr``: flow rule attributes.
3104 - ``pattern``: pattern specification (list terminated by the END pattern
3106 - ``actions``: associated actions (list terminated by the END action).
3107 - ``error``: perform verbose error reporting if not NULL. PMDs initialize
3108 this structure in case of error only.
3112 A valid handle in case of success, NULL otherwise and ``rte_errno`` is set
3113 to the positive version of one of the error codes defined for
3114 ``rte_flow_validate()``.
3119 Flow rules destruction is not automatic, and a queue or a port should not be
3120 released if any are still attached to them. Applications must take care of
3121 performing this step before releasing resources.
3126 rte_flow_destroy(uint16_t port_id,
3127 struct rte_flow *flow,
3128 struct rte_flow_error *error);
3131 Failure to destroy a flow rule handle may occur when other flow rules depend
3132 on it, and destroying it would result in an inconsistent state.
3134 This function is only guaranteed to succeed if handles are destroyed in
3135 reverse order of their creation.
3139 - ``port_id``: port identifier of Ethernet device.
3140 - ``flow``: flow rule handle to destroy.
3141 - ``error``: perform verbose error reporting if not NULL. PMDs initialize
3142 this structure in case of error only.
3146 - 0 on success, a negative errno value otherwise and ``rte_errno`` is set.
3151 Convenience function to destroy all flow rule handles associated with a
3152 port. They are released as with successive calls to ``rte_flow_destroy()``.
3157 rte_flow_flush(uint16_t port_id,
3158 struct rte_flow_error *error);
3160 In the unlikely event of failure, handles are still considered destroyed and
3161 no longer valid but the port must be assumed to be in an inconsistent state.
3165 - ``port_id``: port identifier of Ethernet device.
3166 - ``error``: perform verbose error reporting if not NULL. PMDs initialize
3167 this structure in case of error only.
3171 - 0 on success, a negative errno value otherwise and ``rte_errno`` is set.
3176 Query an existing flow rule.
3178 This function allows retrieving flow-specific data such as counters. Data
3179 is gathered by special actions which must be present in the flow rule
3185 rte_flow_query(uint16_t port_id,
3186 struct rte_flow *flow,
3187 const struct rte_flow_action *action,
3189 struct rte_flow_error *error);
3193 - ``port_id``: port identifier of Ethernet device.
3194 - ``flow``: flow rule handle to query.
3195 - ``action``: action to query, this must match prototype from flow rule.
3196 - ``data``: pointer to storage for the associated query data type.
3197 - ``error``: perform verbose error reporting if not NULL. PMDs initialize
3198 this structure in case of error only.
3202 - 0 on success, a negative errno value otherwise and ``rte_errno`` is set.
3204 .. _flow_isolated_mode:
3209 The general expectation for ingress traffic is that flow rules process it
3210 first; the remaining unmatched or pass-through traffic usually ends up in a
3211 queue (with or without RSS, locally or in some sub-device instance)
3212 depending on the global configuration settings of a port.
3214 While fine from a compatibility standpoint, this approach makes drivers more
3215 complex as they have to check for possible side effects outside of this API
3216 when creating or destroying flow rules. It results in a more limited set of
3217 available rule types due to the way device resources are assigned (e.g. no
3218 support for the RSS action even on capable hardware).
3220 Given that nonspecific traffic can be handled by flow rules as well,
3221 isolated mode is a means for applications to tell a driver that ingress on
3222 the underlying port must be injected from the defined flow rules only; that
3223 no default traffic is expected outside those rules.
3225 This has the following benefits:
3227 - Applications get finer-grained control over the kind of traffic they want
3228 to receive (no traffic by default).
3230 - More importantly they control at what point nonspecific traffic is handled
3231 relative to other flow rules, by adjusting priority levels.
3233 - Drivers can assign more hardware resources to flow rules and expand the
3234 set of supported rule types.
3236 Because toggling isolated mode may cause profound changes to the ingress
3237 processing path of a driver, it may not be possible to leave it once
3238 entered. Likewise, existing flow rules or global configuration settings may
3239 prevent a driver from entering isolated mode.
3241 Applications relying on this mode are therefore encouraged to toggle it as
3242 soon as possible after device initialization, ideally before the first call
3243 to ``rte_eth_dev_configure()`` to avoid possible failures due to conflicting
3246 Once effective, the following functionality has no effect on the underlying
3247 port and may return errors such as ``ENOTSUP`` ("not supported"):
3249 - Toggling promiscuous mode.
3250 - Toggling allmulticast mode.
3251 - Configuring MAC addresses.
3252 - Configuring multicast addresses.
3253 - Configuring VLAN filters.
3254 - Configuring global RSS settings.
3259 rte_flow_isolate(uint16_t port_id, int set, struct rte_flow_error *error);
3263 - ``port_id``: port identifier of Ethernet device.
3264 - ``set``: nonzero to enter isolated mode, attempt to leave it otherwise.
3265 - ``error``: perform verbose error reporting if not NULL. PMDs initialize
3266 this structure in case of error only.
3270 - 0 on success, a negative errno value otherwise and ``rte_errno`` is set.
3272 Verbose error reporting
3273 -----------------------
3275 The defined *errno* values may not be accurate enough for users or
3276 application developers who want to investigate issues related to flow rules
3277 management. A dedicated error object is defined for this purpose:
3281 enum rte_flow_error_type {
3282 RTE_FLOW_ERROR_TYPE_NONE, /**< No error. */
3283 RTE_FLOW_ERROR_TYPE_UNSPECIFIED, /**< Cause unspecified. */
3284 RTE_FLOW_ERROR_TYPE_HANDLE, /**< Flow rule (handle). */
3285 RTE_FLOW_ERROR_TYPE_ATTR_GROUP, /**< Group field. */
3286 RTE_FLOW_ERROR_TYPE_ATTR_PRIORITY, /**< Priority field. */
3287 RTE_FLOW_ERROR_TYPE_ATTR_INGRESS, /**< Ingress field. */
3288 RTE_FLOW_ERROR_TYPE_ATTR_EGRESS, /**< Egress field. */
3289 RTE_FLOW_ERROR_TYPE_ATTR, /**< Attributes structure. */
3290 RTE_FLOW_ERROR_TYPE_ITEM_NUM, /**< Pattern length. */
3291 RTE_FLOW_ERROR_TYPE_ITEM, /**< Specific pattern item. */
3292 RTE_FLOW_ERROR_TYPE_ACTION_NUM, /**< Number of actions. */
3293 RTE_FLOW_ERROR_TYPE_ACTION, /**< Specific action. */
3296 struct rte_flow_error {
3297 enum rte_flow_error_type type; /**< Cause field and error types. */
3298 const void *cause; /**< Object responsible for the error. */
3299 const char *message; /**< Human-readable error message. */
3302 Error type ``RTE_FLOW_ERROR_TYPE_NONE`` stands for no error, in which case
3303 remaining fields can be ignored. Other error types describe the type of the
3304 object pointed by ``cause``.
3306 If non-NULL, ``cause`` points to the object responsible for the error. For a
3307 flow rule, this may be a pattern item or an individual action.
3309 If non-NULL, ``message`` provides a human-readable error message.
3311 This object is normally allocated by applications and set by PMDs in case of
3312 error, the message points to a constant string which does not need to be
3313 freed by the application, however its pointer can be considered valid only
3314 as long as its associated DPDK port remains configured. Closing the
3315 underlying device or unloading the PMD invalidates it.
3326 rte_flow_error_set(struct rte_flow_error *error,
3328 enum rte_flow_error_type type,
3330 const char *message);
3332 This function initializes ``error`` (if non-NULL) with the provided
3333 parameters and sets ``rte_errno`` to ``code``. A negative error ``code`` is
3342 rte_flow_conv(enum rte_flow_conv_op op,
3346 struct rte_flow_error *error);
3348 Convert ``src`` to ``dst`` according to operation ``op``. Possible
3351 - Attributes, pattern item or action duplication.
3352 - Duplication of an entire pattern or list of actions.
3353 - Duplication of a complete flow rule description.
3354 - Pattern item or action name retrieval.
3356 Tunneled traffic offload
3357 ~~~~~~~~~~~~~~~~~~~~~~~~
3359 rte_flow API provides the building blocks for vendor-agnostic flow
3360 classification offloads. The rte_flow "patterns" and "actions"
3361 primitives are fine-grained, thus enabling DPDK applications the
3362 flexibility to offload network stacks and complex pipelines.
3363 Applications wishing to offload tunneled traffic are required to use
3364 the rte_flow primitives, such as group, meta, mark, tag, and others to
3365 model their high-level objects. The hardware model design for
3366 high-level software objects is not trivial. Furthermore, an optimal
3367 design is often vendor-specific.
3369 When hardware offloads tunneled traffic in multi-group logic,
3370 partially offloaded packets may arrive to the application after they
3371 were modified in hardware. In this case, the application may need to
3372 restore the original packet headers. Consider the following sequence:
3373 The application decaps a packet in one group and jumps to a second
3374 group where it tries to match on a 5-tuple, that will miss and send
3375 the packet to the application. In this case, the application does not
3376 receive the original packet but a modified one. Also, in this case,
3377 the application cannot match on the outer header fields, such as VXLAN
3380 There are several possible ways to use rte_flow "patterns" and
3381 "actions" to resolve the issues above. For example:
3383 1 Mapping headers to a hardware registers using the
3384 rte_flow_action_mark/rte_flow_action_tag/rte_flow_set_meta objects.
3386 2 Apply the decap only at the last offload stage after all the
3387 "patterns" were matched and the packet will be fully offloaded.
3389 Every approach has its pros and cons and is highly dependent on the
3390 hardware vendor. For example, some hardware may have a limited number
3391 of registers while other hardware could not support inner actions and
3392 must decap before accessing inner headers.
3394 The tunnel offload model resolves these issues. The model goals are:
3396 1 Provide a unified application API to offload tunneled traffic that
3397 is capable to match on outer headers after decap.
3399 2 Allow the application to restore the outer header of partially
3402 The tunnel offload model does not introduce new elements to the
3403 existing RTE flow model and is implemented as a set of helper
3406 For the application to work with the tunnel offload API it
3407 has to adjust flow rules in multi-table tunnel offload in the
3410 1 Remove explicit call to decap action and replace it with PMD actions
3411 obtained from rte_flow_tunnel_decap_and_set() helper.
3413 2 Add PMD items obtained from rte_flow_tunnel_match() helper to all
3414 other rules in the tunnel offload sequence.
3416 The model requirements:
3418 Software application must initialize
3419 rte_tunnel object with tunnel parameters before calling
3420 rte_flow_tunnel_decap_set() & rte_flow_tunnel_match().
3422 PMD actions array obtained in rte_flow_tunnel_decap_set() must be
3423 released by application with rte_flow_action_release() call.
3425 PMD items array obtained with rte_flow_tunnel_match() must be released
3426 by application with rte_flow_item_release() call. Application can
3427 release PMD items and actions after rule was created. However, if the
3428 application needs to create additional rule for the same tunnel it
3429 will need to obtain PMD items again.
3431 Application cannot destroy rte_tunnel object before it releases all
3432 PMD actions & PMD items referencing that tunnel.
3437 - DPDK does not keep track of flow rules definitions or flow rule objects
3438 automatically. Applications may keep track of the former and must keep
3439 track of the latter. PMDs may also do it for internal needs, however this
3440 must not be relied on by applications.
3442 - Flow rules are not maintained between successive port initializations. An
3443 application exiting without releasing them and restarting must re-create
3446 - API operations are synchronous and blocking (``EAGAIN`` cannot be
3449 - Stopping the data path (TX/RX) should not be necessary when managing flow
3450 rules. If this cannot be achieved naturally or with workarounds (such as
3451 temporarily replacing the burst function pointers), an appropriate error
3452 code must be returned (``EBUSY``).
3454 - Applications, not PMDs, are responsible for maintaining flow rules
3455 configuration when closing, stopping or restarting a port or performing other
3456 actions which may affect them.
3457 Applications must assume that after port close, stop or restart all flows
3458 related to that port are not valid, hardware rules are destroyed and relevant
3459 PMD resources are released.
3461 For devices exposing multiple ports sharing global settings affected by flow
3464 - All ports under DPDK control must behave consistently, PMDs are
3465 responsible for making sure that existing flow rules on a port are not
3466 affected by other ports.
3468 - Ports not under DPDK control (unaffected or handled by other applications)
3469 are user's responsibility. They may affect existing flow rules and cause
3470 undefined behavior. PMDs aware of this may prevent flow rules creation
3471 altogether in such cases.
3476 The PMD interface is defined in ``rte_flow_driver.h``. It is not subject to
3477 API/ABI versioning constraints as it is not exposed to applications and may
3478 evolve independently.
3480 The PMD interface is based on callbacks pointed by the ``struct rte_flow_ops``.
3482 - PMD callbacks implement exactly the interface described in `Rules
3483 management`_, except for the port ID argument which has already been
3484 converted to a pointer to the underlying ``struct rte_eth_dev``.
3486 - Public API functions do not process flow rules definitions at all before
3487 calling PMD functions (no basic error checking, no validation
3488 whatsoever). They only make sure these callbacks are non-NULL or return
3489 the ``ENOSYS`` (function not supported) error.
3491 This interface additionally defines the following helper function:
3493 - ``rte_flow_ops_get()``: get generic flow operations structure from a
3496 If PMD interfaces don't support re-entrancy/multi-thread safety,
3497 the rte_flow API functions will protect threads by mutex per port.
3498 The application can check whether ``RTE_ETH_DEV_FLOW_OPS_THREAD_SAFE``
3499 is set in ``dev_flags``, meaning the PMD is thread-safe regarding rte_flow,
3500 so the API level protection is disabled.
3501 Please note that this API-level mutex protects only rte_flow functions,
3502 other control path functions are not in scope.
3504 Device compatibility
3505 --------------------
3507 No known implementation supports all the described features.
3509 Unsupported features or combinations are not expected to be fully emulated
3510 in software by PMDs for performance reasons. Partially supported features
3511 may be completed in software as long as hardware performs most of the work
3512 (such as queue redirection and packet recognition).
3514 However PMDs are expected to do their best to satisfy application requests
3515 by working around hardware limitations as long as doing so does not affect
3516 the behavior of existing flow rules.
3518 The following sections provide a few examples of such cases and describe how
3519 PMDs should handle them, they are based on limitations built into the
3525 Each flow rule comes with its own, per-layer bit-masks, while hardware may
3526 support only a single, device-wide bit-mask for a given layer type, so that
3527 two IPv4 rules cannot use different bit-masks.
3529 The expected behavior in this case is that PMDs automatically configure
3530 global bit-masks according to the needs of the first flow rule created.
3532 Subsequent rules are allowed only if their bit-masks match those, the
3533 ``EEXIST`` error code should be returned otherwise.
3535 Unsupported layer types
3536 ~~~~~~~~~~~~~~~~~~~~~~~
3538 Many protocols can be simulated by crafting patterns with the `Item: RAW`_
3541 PMDs can rely on this capability to simulate support for protocols with
3542 headers not directly recognized by hardware.
3544 ``ANY`` pattern item
3545 ~~~~~~~~~~~~~~~~~~~~
3547 This pattern item stands for anything, which can be difficult to translate
3548 to something hardware would understand, particularly if followed by more
3551 Consider the following pattern:
3553 .. _table_rte_flow_unsupported_any:
3555 .. table:: Pattern with ANY as L3
3557 +-------+-----------------------+
3559 +=======+=======================+
3561 +-------+-----+---------+-------+
3562 | 1 | ANY | ``num`` | ``1`` |
3563 +-------+-----+---------+-------+
3565 +-------+-----------------------+
3567 +-------+-----------------------+
3569 Knowing that TCP does not make sense with something other than IPv4 and IPv6
3570 as L3, such a pattern may be translated to two flow rules instead:
3572 .. _table_rte_flow_unsupported_any_ipv4:
3574 .. table:: ANY replaced with IPV4
3576 +-------+--------------------+
3578 +=======+====================+
3580 +-------+--------------------+
3581 | 1 | IPV4 (zeroed mask) |
3582 +-------+--------------------+
3584 +-------+--------------------+
3586 +-------+--------------------+
3590 .. _table_rte_flow_unsupported_any_ipv6:
3592 .. table:: ANY replaced with IPV6
3594 +-------+--------------------+
3596 +=======+====================+
3598 +-------+--------------------+
3599 | 1 | IPV6 (zeroed mask) |
3600 +-------+--------------------+
3602 +-------+--------------------+
3604 +-------+--------------------+
3606 Note that as soon as a ANY rule covers several layers, this approach may
3607 yield a large number of hidden flow rules. It is thus suggested to only
3608 support the most common scenarios (anything as L2 and/or L3).
3613 - When combined with `Action: QUEUE`_, packet counting (`Action: COUNT`_)
3614 and tagging (`Action: MARK`_ or `Action: FLAG`_) may be implemented in
3615 software as long as the target queue is used by a single rule.
3617 - When a single target queue is provided, `Action: RSS`_ can also be
3618 implemented through `Action: QUEUE`_.
3623 While it would naturally make sense, flow rules cannot be assumed to be
3624 processed by hardware in the same order as their creation for several
3627 - They may be managed internally as a tree or a hash table instead of a
3629 - Removing a flow rule before adding another one can either put the new rule
3630 at the end of the list or reuse a freed entry.
3631 - Duplication may occur when packets are matched by several rules.
3633 For overlapping rules (particularly in order to use `Action: PASSTHRU`_)
3634 predictable behavior is only guaranteed by using different priority levels.
3636 Priority levels are not necessarily implemented in hardware, or may be
3637 severely limited (e.g. a single priority bit).
3639 For these reasons, priority levels may be implemented purely in software by
3642 - For devices expecting flow rules to be added in the correct order, PMDs
3643 may destroy and re-create existing rules after adding a new one with
3646 - A configurable number of dummy or empty rules can be created at
3647 initialization time to save high priority slots for later.
3649 - In order to save priority levels, PMDs may evaluate whether rules are
3650 likely to collide and adjust their priority accordingly.
3653 .. _OpenFlow Switch Specification: https://www.opennetworking.org/software-defined-standards/specifications/