d/numam-dpdk
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

doc: remove flow API migration section

Browse Source 
This section has become less relevant since the flow API (rte_flow) is now
a mature DPDK API with applications developed directly on top of it instead
of an afterthought.

This patch removes it for the following reasons:

- It has never been updated to track the latest changes in the legacy
  filter types and never will.

- Many provided examples are theoretical and misleading since PMDs do not
  implement them. Others are obvious.

- Upcoming work on the flow API will alter the behavior of several pattern
  items, actions and in some cases, flow rules, which will in turn cause
  existing examples to be wrong.

Signed-off-by: Adrien Mazarguil <adrien.mazarguil@6wind.com>
Acked-by: Andrew Rybchenko <arybchenko@solarflare.com>
This commit is contained in:
Adrien Mazarguil 2018-04-25 17:27:43 +02:00 committed by Ferruh Yigit
parent 9f995def55
commit 551d148944
1 changed files with 0 additions and 298 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

298
doc/guides/prog_guide/rte_flow.rst
View File

@ -55,9 +55,6 @@ encompasses and supersedes (including all functions and filter types) in
order to expose a single interface with an unambiguous behavior that is
common to all poll-mode drivers (PMDs).
Several methods to migrate existing applications are described in `API
migration`_.
Flow rule
---------
@ -2068,298 +2065,3 @@ Future evolutions
- Optional software fallback when PMDs are unable to handle requested flow
rules so applications do not have to implement their own.
API migration
-------------
Exhaustive list of deprecated filter types (normally prefixed with
*RTE_ETH_FILTER_*) found in ``rte_eth_ctrl.h`` and methods to convert them
to *rte_flow* rules.
``MACVLAN`` to ``ETH`` → ``VF``, ``PF``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*MACVLAN* can be translated to a basic `Item: ETH`_ flow rule with a
terminating `Action: VF`_ or `Action: PF`_.
.. _table_rte_flow_migration_macvlan:
.. table:: MACVLAN conversion
+--------------------------+---------+
| Pattern | Actions |
+===+=====+==========+=====+=========+
| 0 | ETH | ``spec`` | any | VF, |
| | +----------+-----+ PF |
| | | ``last`` | N/A | |
| | +----------+-----+ |
| | | ``mask`` | any | |
+---+-----+----------+-----+---------+
| 1 | END | END |
+---+----------------------+---------+
``ETHERTYPE`` to ``ETH`` → ``QUEUE``, ``DROP``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*ETHERTYPE* is basically an `Item: ETH`_ flow rule with a terminating
`Action: QUEUE`_ or `Action: DROP`_.
.. _table_rte_flow_migration_ethertype:
.. table:: ETHERTYPE conversion
+--------------------------+---------+
| Pattern | Actions |
+===+=====+==========+=====+=========+
| 0 | ETH | ``spec`` | any | QUEUE, |
| | +----------+-----+ DROP |
| | | ``last`` | N/A | |
| | +----------+-----+ |
| | | ``mask`` | any | |
+---+-----+----------+-----+---------+
| 1 | END | END |
+---+----------------------+---------+
``FLEXIBLE`` to ``RAW`` → ``QUEUE``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*FLEXIBLE* can be translated to one `Item: RAW`_ pattern with a terminating
`Action: QUEUE`_ and a defined priority level.
.. _table_rte_flow_migration_flexible:
.. table:: FLEXIBLE conversion
+--------------------------+---------+
| Pattern | Actions |
+===+=====+==========+=====+=========+
| 0 | RAW | ``spec`` | any | QUEUE |
| | +----------+-----+ |
| | | ``last`` | N/A | |
| | +----------+-----+ |
| | | ``mask`` | any | |
+---+-----+----------+-----+---------+
| 1 | END | END |
+---+----------------------+---------+
``SYN`` to ``TCP`` → ``QUEUE``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*SYN* is a `Item: TCP`_ rule with only the ``syn`` bit enabled and masked,
and a terminating `Action: QUEUE`_.
Priority level can be set to simulate the high priority bit.
.. _table_rte_flow_migration_syn:
.. table:: SYN conversion
+-----------------------------------+---------+
| Pattern | Actions |
+===+======+==========+=============+=========+
| 0 | ETH | ``spec`` | unset | QUEUE |
| | +----------+-------------+ |
| | | ``last`` | unset | |
| | +----------+-------------+ |
| | | ``mask`` | unset | |
+---+------+----------+-------------+---------+
| 1 | IPV4 | ``spec`` | unset | END |
| | +----------+-------------+ |
| | | ``mask`` | unset | |
| | +----------+-------------+ |
| | | ``mask`` | unset | |
+---+------+----------+---------+---+ |
| 2 | TCP | ``spec`` | ``syn`` | 1 | |
| | +----------+---------+---+ |
| | | ``mask`` | ``syn`` | 1 | |
+---+------+----------+---------+---+ |
| 3 | END | |
+---+-------------------------------+---------+
``NTUPLE`` to ``IPV4``, ``TCP``, ``UDP`` → ``QUEUE``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*NTUPLE* is similar to specifying an empty L2, `Item: IPV4`_ as L3 with
`Item: TCP`_ or `Item: UDP`_ as L4 and a terminating `Action: QUEUE`_.
A priority level can be specified as well.
.. _table_rte_flow_migration_ntuple:
.. table:: NTUPLE conversion
+-----------------------------+---------+
| Pattern | Actions |
+===+======+==========+=======+=========+
| 0 | ETH | ``spec`` | unset | QUEUE |
| | +----------+-------+ |
| | | ``last`` | unset | |
| | +----------+-------+ |
| | | ``mask`` | unset | |
+---+------+----------+-------+---------+
| 1 | IPV4 | ``spec`` | any | END |
| | +----------+-------+ |
| | | ``last`` | unset | |
| | +----------+-------+ |
| | | ``mask`` | any | |
+---+------+----------+-------+ |
| 2 | TCP, | ``spec`` | any | |
| | UDP +----------+-------+ |
| | | ``last`` | unset | |
| | +----------+-------+ |
| | | ``mask`` | any | |
+---+------+----------+-------+ |
| 3 | END | |
+---+-------------------------+---------+
``TUNNEL`` to ``ETH``, ``IPV4``, ``IPV6``, ``VXLAN`` (or other) → ``QUEUE``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*TUNNEL* matches common IPv4 and IPv6 L3/L4-based tunnel types.
In the following table, `Item: ANY`_ is used to cover the optional L4.
.. _table_rte_flow_migration_tunnel:
.. table:: TUNNEL conversion
+-------------------------------------------------------+---------+
| Pattern | Actions |
+===+==========================+==========+=============+=========+
| 0 | ETH | ``spec`` | any | QUEUE |
| | +----------+-------------+ |
| | | ``last`` | unset | |
| | +----------+-------------+ |
| | | ``mask`` | any | |
+---+--------------------------+----------+-------------+---------+
| 1 | IPV4, IPV6 | ``spec`` | any | END |
| | +----------+-------------+ |
| | | ``last`` | unset | |
| | +----------+-------------+ |
| | | ``mask`` | any | |
+---+--------------------------+----------+-------------+ |
| 2 | ANY | ``spec`` | any | |
| | +----------+-------------+ |
| | | ``last`` | unset | |
| | +----------+---------+---+ |
| | | ``mask`` | ``num`` | 0 | |
+---+--------------------------+----------+---------+---+ |
| 3 | VXLAN, GENEVE, TEREDO, | ``spec`` | any | |
| | NVGRE, GRE, ... +----------+-------------+ |
| | | ``last`` | unset | |
| | +----------+-------------+ |
| | | ``mask`` | any | |
+---+--------------------------+----------+-------------+ |
| 4 | END | |
+---+---------------------------------------------------+---------+
``FDIR`` to most item types → ``QUEUE``, ``DROP``, ``PASSTHRU``
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
*FDIR* is more complex than any other type, there are several methods to
emulate its functionality. It is summarized for the most part in the table
below.
A few features are intentionally not supported:
- The ability to configure the matching input set and masks for the entire
device, PMDs should take care of it automatically according to the
requested flow rules.
For example if a device supports only one bit-mask per protocol type,
source/address IPv4 bit-masks can be made immutable by the first created
rule. Subsequent IPv4 or TCPv4 rules can only be created if they are
compatible.
Note that only protocol bit-masks affected by existing flow rules are
immutable, others can be changed later. They become mutable again after
the related flow rules are destroyed.
- Returning four or eight bytes of matched data when using flex bytes
filtering. Although a specific action could implement it, it conflicts
with the much more useful 32 bits tagging on devices that support it.
- Side effects on RSS processing of the entire device. Flow rules that
conflict with the current device configuration should not be
allowed. Similarly, device configuration should not be allowed when it
affects existing flow rules.
- Device modes of operation. "none" is unsupported since filtering cannot be
disabled as long as a flow rule is present.
- "MAC VLAN" or "tunnel" perfect matching modes should be automatically set
according to the created flow rules.
- Signature mode of operation is not defined but could be handled through
"FUZZY" item.
.. _table_rte_flow_migration_fdir:
.. table:: FDIR conversion
+----------------------------------------+-----------------------+
| Pattern | Actions |
+===+===================+==========+=====+=======================+
| 0 | ETH, RAW | ``spec`` | any | QUEUE, DROP, PASSTHRU |
| | +----------+-----+ |
| | | ``last`` | N/A | |
| | +----------+-----+ |
| | | ``mask`` | any | |
+---+-------------------+----------+-----+-----------------------+
| 1 | IPV4, IPv6 | ``spec`` | any | MARK |
| | +----------+-----+ |
| | | ``last`` | N/A | |
| | +----------+-----+ |
| | | ``mask`` | any | |
+---+-------------------+----------+-----+-----------------------+
| 2 | TCP, UDP, SCTP | ``spec`` | any | END |
| | +----------+-----+ |
| | | ``last`` | N/A | |
| | +----------+-----+ |
| | | ``mask`` | any | |
+---+-------------------+----------+-----+ |
| 3 | VF, PF, FUZZY | ``spec`` | any | |
| | (optional) +----------+-----+ |
| | | ``last`` | N/A | |
| | +----------+-----+ |
| | | ``mask`` | any | |
+---+-------------------+----------+-----+ |
| 4 | END | |
+---+------------------------------------+-----------------------+
``HASH``
~~~~~~~~
There is no counterpart to this filter type because it translates to a
global device setting instead of a pattern item. Device settings are
automatically set according to the created flow rules.
``L2_TUNNEL`` to ``VOID`` → ``VXLAN`` (or others)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
All packets are matched. This type alters incoming packets to encapsulate
them in a chosen tunnel type, optionally redirect them to a VF as well.
The destination pool for tag based forwarding can be emulated with other
flow rules using `Action: DUP`_.
.. _table_rte_flow_migration_l2tunnel:
.. table:: L2_TUNNEL conversion
+---------------------------+--------------------+
| Pattern | Actions |
+===+======+==========+=====+====================+
| 0 | VOID | ``spec`` | N/A | VXLAN, GENEVE, ... |
| | | | | |
| | | | | |
| | +----------+-----+ |
| | | ``last`` | N/A | |
| | +----------+-----+ |
| | | ``mask`` | N/A | |
| | | | | |
+---+------+----------+-----+--------------------+
| 1 | END | VF (optional) |
+---+ +--------------------+
| 2 | | END |
+---+-----------------------+--------------------+