mir/ovs
2
0
Fork 0
mirror of https://github.com/openvswitch/ovs synced 2025-08-31 22:35:15 +00:00
Code Issues Releases Wiki Activity

docs: DPDK isn't a datapath, so don't use the term.

Browse Source 
The DPDK library allows OVS fast access to packet I/O in userspace.  It
is not a datapath.  This commit avoids using that term.

Suggested-by: Ilya Maximets <i.maximets@ovn.org>
Acked-by: Ilya Maximets <i.maximets@ovn.org>
Signed-off-by: Ben Pfaff <blp@ovn.org>
This commit is contained in:
Ben Pfaff
2019-10-23 10:19:39 -07:00
parent 653eedff20
commit 49df3c0fe7
14 changed files with 44 additions and 43 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
Documentation/howto/dpdk.rst
View File

@@ -25,14 +25,15 @@
Using Open vSwitch with DPDK
============================
This document describes how to use Open vSwitch with DPDK datapath.
This document describes how to use Open vSwitch with DPDK.
.. important::
Using the DPDK datapath requires building OVS with DPDK support. The
mapping of OVS version to DPDK can vary between releases. For version
mapping information refer to :doc:`releases FAQ </faq/releases>`. For
build instructions refer to :doc:`/intro/install/dpdk`.
Using DPDK with OVS requires configuring OVS at build time to use
the DPDK library. The version of DPDK that OVS supports varies
from one OVS release to another, as described in the :doc:`releases
FAQ </faq/releases>`. For build instructions refer to
:doc:`/intro/install/dpdk`.
Ports and Bridges
-----------------

4
Documentation/howto/userspace-tunneling.rst
View File

@@ -74,8 +74,8 @@ Two Physical Hosts
The environment assumes the use of two hosts, named `host1` and `host2`. We
only detail the configuration of `host1` but a similar configuration can be
used for `host2`. Both hosts should be configured with Open vSwitch (with or
without the DPDK datapath), QEMU/KVM and suitable VM images. Open vSwitch
should be running before proceeding.
without DPDK), QEMU/KVM and suitable VM images. Open vSwitch should be running
before proceeding.
Configuration Steps
-------------------

4
Documentation/intro/install/distributions.rst
View File

@@ -46,8 +46,8 @@ that includes the core userspace components of the switch.
automatically build and install Open vSwitch kernel module for your running
kernel.
3. For DPDK datapath, Open vSwitch with DPDK support is bundled in the package
``openvswitch-switch-dpdk``.
3. For fast userspace switching, Open vSwitch with DPDK support is
bundled in the package ``openvswitch-switch-dpdk``.
Fedora
------

6
Documentation/intro/install/dpdk.rst
View File

@@ -107,8 +107,8 @@ Install DPDK
Install OVS
~~~~~~~~~~~
OVS can be installed using different methods. For OVS to use DPDK datapath, it
has to be configured with DPDK support (``--with-dpdk``).
OVS can be installed using different methods. For OVS to use DPDK, it
has to be configured to build against the DPDK library (``--with-dpdk``).
.. note::
This section focuses on generic recipe that suits most cases. For
@@ -288,7 +288,7 @@ with either the ovs-vswitchd logs, or by running either of the commands::
"DPDK 17.11.0"
At this point you can use ovs-vsctl to set up bridges and other Open vSwitch
features. Seeing as we've configured the DPDK datapath, we will use DPDK-type
features. Seeing as we've configured DPDK support, we will use DPDK-type
ports. For example, to create a userspace bridge named ``br0`` and add two
``dpdk`` ports to it, run::

7
Documentation/topics/dpdk/bridge.rst
View File

@@ -25,13 +25,14 @@
DPDK Bridges
============
The DPDK datapath requires specially configured bridge(s) in order to utilize
DPDK-backed :doc:`physical <phy>` and :doc:`virtual <vhost-user>` ports.
Bridge must be specially configured to utilize DPDK-backed
:doc:`physical <phy>` and :doc:`virtual <vhost-user>` ports.
Quick Example
-------------
This example demonstrates how to add a bridge using the DPDK datapath::
This example demonstrates how to add a bridge that will take advantage
of DPDK::
$ ovs-vsctl add-br br0 -- set bridge br0 datapath_type=netdev

6
Documentation/topics/dpdk/index.rst
View File

@@ -21,9 +21,9 @@
Avoid deeper levels because they do not render well.
=================
The DPDK Datapath
=================
============
DPDK Support
============
.. NOTE(stephenfin): Part of this doc is included in 'howto/dpdk'. Update that
.. if you modify this document

10
Documentation/topics/dpdk/phy.rst
View File

@@ -125,11 +125,11 @@ Multiqueue
----------
Poll Mode Driver (PMD) threads are the threads that do the heavy lifting for
the DPDK datapath. Correct configuration of PMD threads and the Rx queues they
utilize is a requirement in order to deliver the high-performance possible with
DPDK acceleration. It is possible to configure multiple Rx queues for ``dpdk``
ports, thus ensuring this is not a bottleneck for performance. For information
on configuring PMD threads, refer to :doc:`pmd`.
userspace switching. Correct configuration of PMD threads and the Rx
queues they utilize is a requirement in order to deliver the high-performance
possible with DPDK acceleration. It is possible to configure multiple Rx queues
for ``dpdk`` ports, thus ensuring this is not a bottleneck for performance. For
information on configuring PMD threads, refer to :doc:`pmd`.
.. _dpdk-phy-flow-control:

6
Documentation/topics/dpdk/pmd.rst
View File

@@ -26,9 +26,9 @@ PMD Threads
===========
Poll Mode Driver (PMD) threads are the threads that do the heavy lifting for
the DPDK datapath and perform tasks such as continuous polling of input ports
for packets, classifying packets once received, and executing actions on the
packets once they are classified.
userspace switching. They perform tasks such as continuous polling of
input ports for packets, classifying packets once received, and executing
actions on the packets once they are classified.
PMD threads utilize Receive (Rx) and Transmit (Tx) queues, commonly known as
*rxq*\s and *txq*\s. While Tx queue configuration happens automatically, Rx

6
Documentation/topics/dpdk/ring.rst
View File

@@ -32,9 +32,9 @@ DPDK Ring Ports
:doc:`vhost-user ports <vhost-user>` are a better choice and should be used
instead.
The DPDK datapath provides DPDK-backed ring ports that are implemented using
DPDK's ``librte_ring`` library. For more information on this library, refer to
the `DPDK documentation`_.
OVS userspace switching supports ring ports implemented using DPDK's
``librte_ring`` library. For more information on this library, refer
to the `DPDK documentation`_.
.. important::

6
Documentation/topics/dpdk/vhost-user.rst
View File

@@ -25,9 +25,9 @@
DPDK vHost User Ports
=====================
The DPDK datapath provides DPDK-backed vHost user ports as a primary way to
interact with guests. For more information on vHost User, refer to the `QEMU
documentation`_ on same.
OVS userspace switching supports supports vHost user ports as a
primary way to interact with guests. For more information on vHost
User, refer to the `QEMU documentation`_ on same.
.. important::

4
Documentation/topics/testing.rst
View File

@@ -324,8 +324,8 @@ The results of the testsuite are in ``tests/system-userspace-testsuite.dir``.
All the features documented under `Unit Tests`_ are available for the userspace
datapath testsuite.
DPDK datapath
'''''''''''''
Userspace datapath with DPDK
''''''''''''''''''''''''''''
To test :doc:`/intro/install/dpdk` (i.e., the build was configured with
``--with-dpdk``, the DPDK is installed), run the testsuite and generate

2
acinclude.m4
View File

@@ -289,7 +289,7 @@ AC_DEFUN([OVS_CHECK_DPDK], [
[Specify the DPDK build directory])],
[have_dpdk=true])
AC_MSG_CHECKING([whether dpdk datapath is enabled])
AC_MSG_CHECKING([whether dpdk is enabled])
if test "$have_dpdk" != true || test "$with_dpdk" = no; then
AC_MSG_RESULT([no])
DPDKLIB_FOUND=false

10
tests/system-dpdk.at
View File

@@ -5,7 +5,7 @@ AT_BANNER([OVS-DPDK unit tests])
dnl --------------------------------------------------------------------------
dnl Check if EAL init is successful
AT_SETUP([OVS-DPDK datapath - EAL init])
AT_SETUP([OVS-DPDK - EAL init])
AT_KEYWORDS([dpdk])
OVS_DPDK_PRE_CHECK()
OVS_DPDK_START()
@@ -23,7 +23,7 @@ dnl --------------------------------------------------------------------------
dnl --------------------------------------------------------------------------
dnl Add standard DPDK PHY port
AT_SETUP([OVS-DPDK datapath - add standard DPDK port])
AT_SETUP([OVS-DPDK - add standard DPDK port])
AT_KEYWORDS([dpdk])
OVS_DPDK_PRE_PHY_SKIP()
@@ -50,7 +50,7 @@ dnl --------------------------------------------------------------------------
dnl --------------------------------------------------------------------------
dnl Add vhost-user-client port
AT_SETUP([OVS-DPDK datapath - add vhost-user-client port])
AT_SETUP([OVS-DPDK - add vhost-user-client port])
AT_KEYWORDS([dpdk])
OVS_DPDK_PRE_CHECK()
OVS_DPDK_START()
@@ -82,7 +82,7 @@ dnl --------------------------------------------------------------------------
dnl --------------------------------------------------------------------------
dnl Ping vhost-user port
AT_SETUP([OVS-DPDK datapath - ping vhost-user ports])
AT_SETUP([OVS-DPDK - ping vhost-user ports])
AT_KEYWORDS([dpdk])
OVS_DPDK_PRE_CHECK()
AT_SKIP_IF([! which testpmd >/dev/null 2>/dev/null])
@@ -159,7 +159,7 @@ dnl --------------------------------------------------------------------------
dnl --------------------------------------------------------------------------
dnl Ping vhost-user-client port
AT_SETUP([OVS-DPDK datapath - ping vhost-user-client ports])
AT_SETUP([OVS-DPDK - ping vhost-user-client ports])
AT_KEYWORDS([dpdk])
OVS_DPDK_PRE_CHECK()
AT_SKIP_IF([! which testpmd >/dev/null 2>/dev/null])

5
vswitchd/ovs-vswitchd.8.in
View File

@@ -79,9 +79,8 @@ only allow privileged users, such as the superuser, to use it.
unavailable or unsuccessful.
.
.SS "DPDK Options"
For details on initializing the \fBovs\-vswitchd\fR DPDK datapath,
refer to the documentation or \fBovs\-vswitchd.conf.db\fR(5) for
details.
For details on initializing \fBovs\-vswitchd\fR to use DPDK ports,
refer to the documentation or \fBovs\-vswitchd.conf.db\fR(5).
.SS "Daemon Options"
.ds DD \
\fBovs\-vswitchd\fR detaches only after it has connected to the \