diff mbox series

[3/3] doc: improve Mellanox bifurcated model description

Message ID 20190130112020.871-4-thomas@monjalon.net (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers
Series more doc about isolated mode and bifurcated model |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK

Commit Message

Thomas Monjalon Jan. 30, 2019, 11:20 a.m. UTC 
  In the howto guide about flow bifurcation, the Mellanox case
(which does not require specific details) was missing in the landscape.

In the Linux drivers guide, it was not clear that the flow bifurcation
is performed in the NIC hardware.

References to flow isolated mode are also inserted in those contexts.

Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
---
 doc/guides/howto/flow_bifurcation.rst  | 26 ++++++++++++++++++++++++++
 doc/guides/linux_gsg/linux_drivers.rst |  7 ++++++-
 2 files changed, 32 insertions(+), 1 deletion(-)
diff mbox series

Patch

diff --git a/doc/guides/howto/flow_bifurcation.rst b/doc/guides/howto/flow_bifurcation.rst
index eabf4d730..a36126472 100644
--- a/doc/guides/howto/flow_bifurcation.rst
+++ b/doc/guides/howto/flow_bifurcation.rst
@@ -44,6 +44,32 @@  module.
    Flow Bifurcation Overview
 
 
+Using Flow Bifurcation on Mellanox ConnectX
+-------------------------------------------
+
+The Mellanox devices are :ref:`natively bifurcated <bifurcated_driver>`,
+so there is no need to split into SR-IOV PF/VF
+in order to get the flow bifurcation mechanism.
+The full device is already shared with the kernel driver.
+
+The DPDK application can setup some flow steering rules,
+and let the rest go to the kernel stack.
+In order to define the filters strictly with flow rules,
+the :ref:`flow_isolated_mode` can be configured.
+
+There is no specific instructions to follow.
+The recommended reading is the :doc:`../prog_guide/rte_flow` guide.
+Below is an example of testpmd commands
+for receiving VXLAN 42 in 4 queues of the DPDK port 0,
+while all other packets go to the kernel:
+
+.. code-block:: console
+
+   testpmd> flow isolate 0 true
+   testpmd> flow create 0 ingress pattern eth / ipv4 / udp / vxlan vni is 42 / end \
+            actions rss queues 0 1 2 3 end / end
+
+
 Using Flow Bifurcation on IXGBE in Linux
 ----------------------------------------
 
diff --git a/doc/guides/linux_gsg/linux_drivers.rst b/doc/guides/linux_gsg/linux_drivers.rst
index 8da6a31be..695edbb13 100644
--- a/doc/guides/linux_gsg/linux_drivers.rst
+++ b/doc/guides/linux_gsg/linux_drivers.rst
@@ -85,6 +85,8 @@  This can be done by using the DPDK setup script (called dpdk-setup.sh and locate
 
     VFIO can be used without IOMMU. While this is just as unsafe as using UIO, it does make it possible for the user to keep the degree of device access and programming that VFIO has, in situations where IOMMU is not available.
 
+.. _bifurcated_driver:
+
 Bifurcated Driver
 -----------------
 
@@ -99,7 +101,10 @@  Such model has the following benefits:
  - It enables the user to use legacy linux tools such as ``ethtool`` or
    ``ifconfig`` while running DPDK application on the same network ports.
  - It enables the DPDK application to filter only part of the traffic,
-   While the rest will be directed and handled by the kernel driver.
+   while the rest will be directed and handled by the kernel driver.
+   The flow bifurcation is performed by the NIC hardware.
+   As an example, using :ref:`flow_isolated_mode` allows to choose
+   strictly what is received in DPDK.
 
 More about the bifurcated driver can be found in
 `Mellanox Bifurcated DPDK PMD