[ovs-dev] [PATCH ovn 1/3] Documentaion cleanup: faq and dpdk sections
nusiddiq at redhat.com
nusiddiq at redhat.com
Mon May 20 08:36:39 UTC 2019
From: Numan Siddique <nusiddiq at redhat.com>
This patch cleans up the Documentation/faq folder by removing non OVN
related files. There are only 2 files now - contributing.rst and general.rst.
The contents of ovn.rst is moved over to general.rst.
This patch also cleans up dpdk related folders and also modifies
few files which references the deleted files.
Upcoming patches will further cleanup the Documentation folder.
Signed-off-by: Numan Siddique <nusiddiq at redhat.com>
---
Documentation/automake.mk | 24 -
Documentation/faq/configuration.rst | 257 --------
Documentation/faq/contributing.rst | 97 ---
Documentation/faq/design.rst | 142 ----
Documentation/faq/general.rst | 155 +++--
Documentation/faq/index.rst | 10 -
Documentation/faq/issues.rst | 435 ------------
Documentation/faq/openflow.rst | 543 ---------------
Documentation/faq/ovn.rst | 90 ---
Documentation/faq/qos.rst | 169 -----
Documentation/faq/releases.rst | 302 ---------
Documentation/faq/terminology.rst | 37 --
Documentation/faq/vlan.rst | 285 --------
Documentation/faq/vxlan.rst | 53 --
Documentation/howto/dpdk.rst | 394 -----------
Documentation/howto/index.rst | 2 -
Documentation/howto/userspace-tunneling.rst | 248 -------
Documentation/index.rst | 7 +-
Documentation/intro/install/dpdk.rst | 693 --------------------
Documentation/intro/install/general.rst | 2 +-
Documentation/intro/install/index.rst | 1 -
Documentation/topics/dpdk/bridge.rst | 132 ----
Documentation/topics/dpdk/index.rst | 43 --
Documentation/topics/dpdk/jumbo-frames.rst | 73 ---
Documentation/topics/dpdk/memory.rst | 216 ------
Documentation/topics/dpdk/pdump.rst | 67 --
Documentation/topics/dpdk/phy.rst | 389 -----------
Documentation/topics/dpdk/pmd.rst | 248 -------
Documentation/topics/dpdk/qos.rst | 78 ---
Documentation/topics/dpdk/ring.rst | 86 ---
Documentation/topics/dpdk/vdev.rst | 66 --
Documentation/topics/dpdk/vhost-user.rst | 505 --------------
Documentation/topics/index.rst | 1 -
Documentation/topics/testing.rst | 31 -
TODO.rst | 5 +
35 files changed, 80 insertions(+), 5806 deletions(-)
delete mode 100644 Documentation/faq/configuration.rst
delete mode 100644 Documentation/faq/design.rst
delete mode 100644 Documentation/faq/issues.rst
delete mode 100644 Documentation/faq/openflow.rst
delete mode 100644 Documentation/faq/ovn.rst
delete mode 100644 Documentation/faq/qos.rst
delete mode 100644 Documentation/faq/releases.rst
delete mode 100644 Documentation/faq/terminology.rst
delete mode 100644 Documentation/faq/vlan.rst
delete mode 100644 Documentation/faq/vxlan.rst
delete mode 100644 Documentation/howto/dpdk.rst
delete mode 100644 Documentation/howto/userspace-tunneling.rst
delete mode 100644 Documentation/intro/install/dpdk.rst
delete mode 100644 Documentation/topics/dpdk/bridge.rst
delete mode 100644 Documentation/topics/dpdk/index.rst
delete mode 100644 Documentation/topics/dpdk/jumbo-frames.rst
delete mode 100644 Documentation/topics/dpdk/memory.rst
delete mode 100644 Documentation/topics/dpdk/pdump.rst
delete mode 100644 Documentation/topics/dpdk/phy.rst
delete mode 100644 Documentation/topics/dpdk/pmd.rst
delete mode 100644 Documentation/topics/dpdk/qos.rst
delete mode 100644 Documentation/topics/dpdk/ring.rst
delete mode 100644 Documentation/topics/dpdk/vdev.rst
delete mode 100644 Documentation/topics/dpdk/vhost-user.rst
diff --git a/Documentation/automake.mk b/Documentation/automake.mk
index 082438e09..cdf89ecb3 100644
--- a/Documentation/automake.mk
+++ b/Documentation/automake.mk
@@ -13,7 +13,6 @@ DOC_SOURCE = \
Documentation/intro/install/debian.rst \
Documentation/intro/install/documentation.rst \
Documentation/intro/install/distributions.rst \
- Documentation/intro/install/dpdk.rst \
Documentation/intro/install/fedora.rst \
Documentation/intro/install/general.rst \
Documentation/intro/install/netbsd.rst \
@@ -36,17 +35,6 @@ DOC_SOURCE = \
Documentation/topics/idl-compound-indexes.rst \
Documentation/topics/datapath.rst \
Documentation/topics/design.rst \
- Documentation/topics/dpdk/index.rst \
- Documentation/topics/dpdk/bridge.rst \
- Documentation/topics/dpdk/jumbo-frames.rst \
- Documentation/topics/dpdk/memory.rst \
- Documentation/topics/dpdk/pdump.rst \
- Documentation/topics/dpdk/phy.rst \
- Documentation/topics/dpdk/pmd.rst \
- Documentation/topics/dpdk/qos.rst \
- Documentation/topics/dpdk/ring.rst \
- Documentation/topics/dpdk/vdev.rst \
- Documentation/topics/dpdk/vhost-user.rst \
Documentation/topics/testing.rst \
Documentation/topics/high-availability.rst \
Documentation/topics/integration.rst \
@@ -61,7 +49,6 @@ DOC_SOURCE = \
Documentation/topics/windows.rst \
Documentation/howto/index.rst \
Documentation/howto/docker.rst \
- Documentation/howto/dpdk.rst \
Documentation/howto/firewalld.rst \
Documentation/howto/ipsec.rst \
Documentation/howto/kvm.rst \
@@ -76,24 +63,13 @@ DOC_SOURCE = \
Documentation/howto/sflow.rst \
Documentation/howto/tunneling.png \
Documentation/howto/tunneling.rst \
- Documentation/howto/userspace-tunneling.rst \
Documentation/howto/vlan.png \
Documentation/howto/vlan.rst \
Documentation/howto/vtep.rst \
Documentation/ref/index.rst \
Documentation/faq/index.rst \
- Documentation/faq/configuration.rst \
Documentation/faq/contributing.rst \
- Documentation/faq/design.rst \
Documentation/faq/general.rst \
- Documentation/faq/issues.rst \
- Documentation/faq/openflow.rst \
- Documentation/faq/ovn.rst \
- Documentation/faq/qos.rst \
- Documentation/faq/releases.rst \
- Documentation/faq/terminology.rst \
- Documentation/faq/vlan.rst \
- Documentation/faq/vxlan.rst \
Documentation/internals/index.rst \
Documentation/internals/authors.rst \
Documentation/internals/bugs.rst \
diff --git a/Documentation/faq/configuration.rst b/Documentation/faq/configuration.rst
deleted file mode 100644
index cb2c6b4ec..000000000
--- a/Documentation/faq/configuration.rst
+++ /dev/null
@@ -1,257 +0,0 @@
-..
- Licensed under the Apache License, Version 2.0 (the "License"); you may
- not use this file except in compliance with the License. You may obtain
- a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
- WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
- License for the specific language governing permissions and limitations
- under the License.
-
- Convention for heading levels in Open vSwitch documentation:
-
- ======= Heading 0 (reserved for the title in a document)
- ------- Heading 1
- ~~~~~~~ Heading 2
- +++++++ Heading 3
- ''''''' Heading 4
-
- Avoid deeper levels because they do not render well.
-
-===================
-Basic Configuration
-===================
-
-Q: How do I configure a port as an access port?
-
- A. Add ``tag=VLAN`` to your ``ovs-vsctl add-port`` command. For example,
- the following commands configure br0 with eth0 as a trunk port (the
- default) and tap0 as an access port for VLAN 9:
-
- ::
-
- $ ovs-vsctl add-br br0
- $ ovs-vsctl add-port br0 eth0
- $ ovs-vsctl add-port br0 tap0 tag=9
-
- If you want to configure an already added port as an access port, use
- ``ovs-vsctl set``, e.g.:
-
- ::
-
- $ ovs-vsctl set port tap0 tag=9
-
-Q: How do I configure a port as a SPAN port, that is, enable mirroring of all
-traffic to that port?
-
- A. The following commands configure br0 with eth0 and tap0 as trunk ports.
- All traffic coming in or going out on eth0 or tap0 is also mirrored to
- tap1; any traffic arriving on tap1 is dropped:
-
- ::
-
- $ ovs-vsctl add-br br0
- $ ovs-vsctl add-port br0 eth0
- $ ovs-vsctl add-port br0 tap0
- $ ovs-vsctl add-port br0 tap1 \
- -- --id=@p get port tap1 \
- -- --id=@m create mirror name=m0 select-all=true output-port=@p \
- -- set bridge br0 mirrors=@m
-
- To later disable mirroring, run:
-
- ::
-
- $ ovs-vsctl clear bridge br0 mirrors
-
-Q: Does Open vSwitch support configuring a port in promiscuous mode?
-
- A: Yes. How you configure it depends on what you mean by "promiscuous
- mode":
-
- - Conventionally, "promiscuous mode" is a feature of a network interface
- card. Ordinarily, a NIC passes to the CPU only the packets actually
- destined to its host machine. It discards the rest to avoid wasting
- memory and CPU cycles. When promiscuous mode is enabled, however, it
- passes every packet to the CPU. On an old-style shared-media or
- hub-based network, this allows the host to spy on all packets on the
- network. But in the switched networks that are almost everywhere these
- days, promiscuous mode doesn't have much effect, because few packets not
- destined to a host are delivered to the host's NIC.
-
- This form of promiscuous mode is configured in the guest OS of the VMs on
- your bridge, e.g. with "ip link set <device> promisc".
-
- - The VMware vSwitch uses a different definition of "promiscuous mode".
- When you configure promiscuous mode on a VMware vNIC, the vSwitch sends a
- copy of every packet received by the vSwitch to that vNIC. That has a
- much bigger effect than just enabling promiscuous mode in a guest OS.
- Rather than getting a few stray packets for which the switch does not yet
- know the correct destination, the vNIC gets every packet. The effect is
- similar to replacing the vSwitch by a virtual hub.
-
- This "promiscuous mode" is what switches normally call "port mirroring"
- or "SPAN". For information on how to configure SPAN, see "How do I
- configure a port as a SPAN port, that is, enable mirroring of all traffic
- to that port?"
-
-Q: How do I configure a DPDK port as an access port?
-
- A: Firstly, you must have a DPDK-enabled version of Open vSwitch.
-
- If your version is DPDK-enabled it may support the dpdk_version and
- dpdk_initialized keys in the configuration database. Earlier versions
- of Open vSwitch only supported the other-config:dpdk-init key in the
- configuration in the database. All versions will display lines with
- "EAL:..." during startup when other_config:dpdk-init is set to 'true'.
-
- Secondly, when adding a DPDK port, unlike a system port, the type for the
- interface and valid dpdk-devargs must be specified. For example::
-
- $ ovs-vsctl add-br br0
- $ ovs-vsctl add-port br0 myportname -- set Interface myportname \
- type=dpdk options:dpdk-devargs=0000:06:00.0
-
- Refer to :doc:`/intro/install/dpdk` for more information on enabling and
- using DPDK with Open vSwitch.
-
-Q: How do I configure a VLAN as an RSPAN VLAN, that is, enable mirroring of all
-traffic to that VLAN?
-
- A: The following commands configure br0 with eth0 as a trunk port and tap0
- as an access port for VLAN 10. All traffic coming in or going out on tap0,
- as well as traffic coming in or going out on eth0 in VLAN 10, is also
- mirrored to VLAN 15 on eth0. The original tag for VLAN 10, in cases where
- one is present, is dropped as part of mirroring:
-
- ::
-
- $ ovs-vsctl add-br br0
- $ ovs-vsctl add-port br0 eth0
- $ ovs-vsctl add-port br0 tap0 tag=10
- $ ovs-vsctl \
- -- --id=@m create mirror name=m0 select-all=true select-vlan=10 \
- output-vlan=15 \
- -- set bridge br0 mirrors=@m
-
- To later disable mirroring, run:
-
- ::
-
- $ ovs-vsctl clear bridge br0 mirrors
-
- Mirroring to a VLAN can disrupt a network that contains unmanaged switches.
- See ovs-vswitchd.conf.db(5) for details. Mirroring to a GRE tunnel has
- fewer caveats than mirroring to a VLAN and should generally be preferred.
-
-Q: Can I mirror more than one input VLAN to an RSPAN VLAN?
-
- A: Yes, but mirroring to a VLAN strips the original VLAN tag in favor of
- the specified output-vlan. This loss of information may make the mirrored
- traffic too hard to interpret.
-
- To mirror multiple VLANs, use the commands above, but specify a
- comma-separated list of VLANs as the value for select-vlan. To mirror
- every VLAN, use the commands above, but omit select-vlan and its value
- entirely.
-
- When a packet arrives on a VLAN that is used as a mirror output VLAN, the
- mirror is disregarded. Instead, in standalone mode, OVS floods the packet
- across all the ports for which the mirror output VLAN is configured. (If
- an OpenFlow controller is in use, then it can override this behavior
- through the flow table.) If OVS is used as an intermediate switch, rather
- than an edge switch, this ensures that the RSPAN traffic is distributed
- through the network.
-
- Mirroring to a VLAN can disrupt a network that contains unmanaged switches.
- See ovs-vswitchd.conf.db(5) for details. Mirroring to a GRE tunnel has
- fewer caveats than mirroring to a VLAN and should generally be preferred.
-
-Q: How do I configure mirroring of all traffic to a GRE tunnel?
-
- A: The following commands configure br0 with eth0 and tap0 as trunk ports.
- All traffic coming in or going out on eth0 or tap0 is also mirrored to
- gre0, a GRE tunnel to the remote host 192.168.1.10; any traffic arriving on
- gre0 is dropped::
-
- $ ovs-vsctl add-br br0
- $ ovs-vsctl add-port br0 eth0
- $ ovs-vsctl add-port br0 tap0
- $ ovs-vsctl add-port br0 gre0 \
- -- set interface gre0 type=gre options:remote_ip=192.168.1.10 \
- -- --id=@p get port gre0 \
- -- --id=@m create mirror name=m0 select-all=true output-port=@p \
- -- set bridge br0 mirrors=@m
-
- To later disable mirroring and destroy the GRE tunnel::
-
- $ ovs-vsctl clear bridge br0 mirrors
- $ ovs-vsctl del-port br0 gre0
-
-Q: Does Open vSwitch support ERSPAN?
-
- A: Yes. ERSPAN version I and version II over IPv4 GRE and
- IPv6 GRE tunnel are supported. See ovs-fields(7) for matching
- and setting ERSPAN fields.
-
- ::
-
- $ ovs-vsctl add-br br0
- $ #For ERSPAN type 2 (version I)
- $ ovs-vsctl add-port br0 at_erspan0 -- \
- set int at_erspan0 type=erspan options:key=1 \
- options:remote_ip=172.31.1.1 \
- options:erspan_ver=1 options:erspan_idx=1
- $ #For ERSPAN type 3 (version II)
- $ ovs-vsctl add-port br0 at_erspan0 -- \
- set int at_erspan0 type=erspan options:key=1 \
- options:remote_ip=172.31.1.1 \
- options:erspan_ver=2 options:erspan_dir=1 \
- options:erspan_hwid=4
-
-Q: How do I connect two bridges?
-
- A: First, why do you want to do this? Two connected bridges are not much
- different from a single bridge, so you might as well just have a single
- bridge with all your ports on it.
-
- If you still want to connect two bridges, you can use a pair of patch
- ports. The following example creates bridges br0 and br1, adds eth0 and
- tap0 to br0, adds tap1 to br1, and then connects br0 and br1 with a pair of
- patch ports.
-
- ::
-
- $ ovs-vsctl add-br br0
- $ ovs-vsctl add-port br0 eth0
- $ ovs-vsctl add-port br0 tap0
- $ ovs-vsctl add-br br1
- $ ovs-vsctl add-port br1 tap1
- $ ovs-vsctl \
- -- add-port br0 patch0 \
- -- set interface patch0 type=patch options:peer=patch1 \
- -- add-port br1 patch1 \
- -- set interface patch1 type=patch options:peer=patch0
-
- Bridges connected with patch ports are much like a single bridge. For
- instance, if the example above also added eth1 to br1, and both eth0 and
- eth1 happened to be connected to the same next-hop switch, then you could
- loop your network just as you would if you added eth0 and eth1 to the same
- bridge (see the "Configuration Problems" section below for more
- information).
-
- If you are using Open vSwitch 1.9 or an earlier version, then you need to
- be using the kernel module bundled with Open vSwitch rather than the one
- that is integrated into Linux 3.3 and later, because Open vSwitch 1.9 and
- earlier versions need kernel support for patch ports. This also means that
- in Open vSwitch 1.9 and earlier, patch ports will not work with the
- userspace datapath, only with the kernel module.
-
-Q: How do I configure a bridge without an OpenFlow local port? (Local port in
-the sense of OFPP_LOCAL)
-
- A: Open vSwitch does not support such a configuration. Bridges always have
- their local ports.
diff --git a/Documentation/faq/contributing.rst b/Documentation/faq/contributing.rst
index 9f7ea121d..baf1a4e00 100644
--- a/Documentation/faq/contributing.rst
+++ b/Documentation/faq/contributing.rst
@@ -25,103 +25,6 @@
Development
===========
-Q: How do I implement a new OpenFlow message?
-
- A: Add your new message to ``enum ofpraw`` and ``enum ofptype`` in
- ``include/openvswitch/ofp-msgs.h``, following the existing pattern.
- Then recompile and fix all of the new warnings, implementing new functionality
- for the new message as needed. (If you configure with ``--enable-Werror``, as
- described in :doc:`/intro/install/general`, then it is impossible to miss any
- warnings.)
-
- To add an OpenFlow vendor extension message (aka experimenter message) for
- a vendor that doesn't yet have any extension messages, you will also need
- to edit ``build-aux/extract-ofp-msgs`` and at least ``ofphdrs_decode()``
- and ``ofpraw_put__()`` in ``lib/ofp-msgs.c``. OpenFlow doesn't standardize
- vendor extensions very well, so it's hard to make the process simpler than
- that. (If you have a choice of how to design your vendor extension
- messages, it will be easier if you make them resemble the ONF and OVS
- extension messages.)
-
-Q: How do I add support for a new field or header?
-
- A: Add new members for your field to ``struct flow`` in
- ``include/openvswitch/flow.h``, and add new enumerations for your new field
- to ``enum mf_field_id`` in ``include/openvswitch/meta-flow.h``, following
- the existing pattern. If the field uses a new OXM class, add it to
- OXM_CLASSES in ``build-aux/extract-ofp-fields``. Also, add support to
- ``miniflow_extract()`` in ``lib/flow.c`` for extracting your new field from
- a packet into struct miniflow, and to ``nx_put_raw()`` in
- ``lib/nx-match.c`` to output your new field in OXM matches. Then recompile
- and fix all of the new warnings, implementing new functionality for the new
- field or header as needed. (If you configure with ``--enable-Werror``, as
- described in :doc:`/intro/install/general`, then it is impossible to miss
- any warnings.)
-
- If you want kernel datapath support for your new field, you also need to
- modify the kernel module for the operating systems you are interested in.
- This isn't mandatory, since fields understood only by userspace work too
- (with a performance penalty), so it's reasonable to start development
- without it. If you implement kernel module support for Linux, then the
- Linux kernel "netdev" mailing list is the place to submit that support
- first; please read up on the Linux kernel development process separately.
- The Windows datapath kernel module support, on the other hand, is
- maintained within the OVS tree, so patches for that can go directly to
- ovs-dev.
-
-Q: How do I add support for a new OpenFlow action?
-
- A: Add your new action to ``enum ofp_raw_action_type`` in
- ``lib/ofp-actions.c``, following the existing pattern. Then recompile and
- fix all of the new warnings, implementing new functionality for the new
- action as needed. (If you configure with ``--enable-Werror``, as described
- in the :doc:`/intro/install/general`, then it is impossible to miss any
- warnings.)
-
- If you need to add an OpenFlow vendor extension action for a vendor that
- doesn't yet have any extension actions, then you will also need to add the
- vendor to ``vendor_map`` in ``build-aux/extract-ofp-actions``. Also, you
- will need to add support for the vendor to ``ofpact_decode_raw()`` and
- ``ofpact_put_raw()`` in ``lib/ofp-actions.c``. (If you have a choice of
- how to design your vendor extension actions, it will be easier if you make
- them resemble the ONF and OVS extension actions.)
-
-Q: How do I add support for a new OpenFlow error message?
-
- A: Add your new error to ``enum ofperr`` in
- ``include/openvswitch/ofp-errors.h``. Read the large comment at the top of
- the file for details. If you need to add an OpenFlow vendor extension
- error for a vendor that doesn't yet have any, first add the vendor ID to
- the ``<name>_VENDOR_ID`` list in ``include/openflow/openflow-common.h``.
-
-Q: What's a Signed-off-by and how do I provide one?
-
- A: Free and open source software projects usually require a contributor to
- provide some assurance that they're entitled to contribute the code that
- they provide. Some projects, for example, do this with a Contributor
- License Agreement (CLA) or a copyright assignment that is signed on paper
- or electronically.
-
- For this purpose, Open vSwitch has adopted something called the Developer's
- Certificate of Origin (DCO), which is also used by the Linux kernel and
- originated there. Informally stated, agreeing to the DCO is the
- developer's way of attesting that a particular commit that they are
- contributing is one that they are allowed to contribute. You should visit
- https://developercertificate.org/ to read the full statement of the DCO,
- which is less than 200 words long.
-
- To certify compliance with the Developer's Certificate of Origin for a
- particular commit, just add the following line to the end of your commit
- message, properly substituting your name and email address:
-
- Signed-off-by: Firstname Lastname <email at example.org>
-
- Git has special support for adding a Signed-off-by line to a commit
- message: when you run "git commit", just add the -s option, as in "git
- commit -s". If you use the "git citool" GUI for commits, you can add a
- Signed-off-by line to the commit message by pressing Control+S. Other Git
- user interfaces may provide similar support.
-
Q: How do I apply patches from email?
A: You can use ``git am`` on raw email contents, either from a file saved by
diff --git a/Documentation/faq/design.rst b/Documentation/faq/design.rst
deleted file mode 100644
index 4732cb1dd..000000000
--- a/Documentation/faq/design.rst
+++ /dev/null
@@ -1,142 +0,0 @@
-..
- Licensed under the Apache License, Version 2.0 (the "License"); you may
- not use this file except in compliance with the License. You may obtain
- a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
- WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
- License for the specific language governing permissions and limitations
- under the License.
-
- Convention for heading levels in Open vSwitch documentation:
-
- ======= Heading 0 (reserved for the title in a document)
- ------- Heading 1
- ~~~~~~~ Heading 2
- +++++++ Heading 3
- ''''''' Heading 4
-
- Avoid deeper levels because they do not render well.
-
-======================
-Implementation Details
-======================
-
-Q: I hear OVS has a couple of kinds of flows. Can you tell me about them?
-
- A: Open vSwitch uses different kinds of flows for different purposes:
-
- - OpenFlow flows are the most important kind of flow. OpenFlow controllers
- use these flows to define a switch's policy. OpenFlow flows support
- wildcards, priorities, and multiple tables.
-
- When in-band control is in use, Open vSwitch sets up a few "hidden"
- flows, with priority higher than a controller or the user can configure,
- that are not visible via OpenFlow. (See the "Controller" section of the
- FAQ for more information about hidden flows.)
-
- - The Open vSwitch software switch implementation uses a second kind of
- flow internally. These flows, called "datapath" or "kernel" flows, do
- not support priorities and comprise only a single table, which makes them
- suitable for caching. (Like OpenFlow flows, datapath flows do support
- wildcarding, in Open vSwitch 1.11 and later.) OpenFlow flows and
- datapath flows also support different actions and number ports
- differently.
-
- Datapath flows are an implementation detail that is subject to change in
- future versions of Open vSwitch. Even with the current version of Open
- vSwitch, hardware switch implementations do not necessarily use this
- architecture.
-
-Users and controllers directly control only the OpenFlow flow table. Open
-vSwitch manages the datapath flow table itself, so users should not normally be
-concerned with it.
-
-Q: Why are there so many different ways to dump flows?
-
- A: Open vSwitch has two kinds of flows (see the previous question), so it
- has commands with different purposes for dumping each kind of flow:
-
- - ``ovs-ofctl dump-flows <br>`` dumps OpenFlow flows, excluding hidden
- flows. This is the most commonly useful form of flow dump. (Unlike the
- other commands, this should work with any OpenFlow switch, not just Open
- vSwitch.)
-
- - ``ovs-appctl bridge/dump-flows <br>`` dumps OpenFlow flows, including
- hidden flows. This is occasionally useful for troubleshooting suspected
- issues with in-band control.
-
- - ``ovs-dpctl dump-flows [dp]`` dumps the datapath flow table entries for a
- Linux kernel-based datapath. In Open vSwitch 1.10 and later,
- ovs-vswitchd merges multiple switches into a single datapath, so it will
- show all the flows on all your kernel-based switches. This command can
- occasionally be useful for debugging.
-
- - ``ovs-appctl dpif/dump-flows <br>``, new in Open vSwitch 1.10, dumps
- datapath flows for only the specified bridge, regardless of the type.
-
-Q: How does multicast snooping works with VLANs?
-
- A: Open vSwitch maintains snooping tables for each VLAN.
-
-Q: Can OVS populate the kernel flow table in advance instead of in reaction to
-packets?
-
- A: No. There are several reasons:
-
- - Kernel flows are not as sophisticated as OpenFlow flows, which means that
- some OpenFlow policies could require a large number of kernel flows. The
- "conjunctive match" feature is an extreme example: the number of kernel
- flows it requires is the product of the number of flows in each
- dimension.
-
- - With multiple OpenFlow flow tables and simple sets of actions, the number
- of kernel flows required can be as large as the product of the number of
- flows in each dimension. With more sophisticated actions, the number of
- kernel flows could be even larger.
-
- - Open vSwitch is designed so that any version of OVS userspace
- interoperates with any version of the OVS kernel module. This forward
- and backward compatibility requires that userspace observe how the kernel
- module parses received packets. This is only possible in a
- straightforward way when userspace adds kernel flows in reaction to
- received packets.
-
- For more relevant information on the architecture of Open vSwitch, please
- read "The Design and Implementation of Open vSwitch", published in USENIX
- NSDI 2015.
-
-Q: How many packets does OVS buffer?
-
- A: Open vSwitch fast path packet processing uses a "run to completion"
- model in which every packet is completely handled in a single pass.
- Therefore, in the common case where a packet just passes through the fast
- path, Open vSwitch does not buffer packets itself. The operating system
- and the network drivers involved in receiving and later in transmitting the
- packet do often include buffering. Open vSwitch is only a middleman
- between these and does not have direct access or influence over their
- buffers.
-
- Outside the common case, Open vSwitch does sometimes buffer packets. When
- the OVS fast path processes a packet that does not match any of the flows
- in its megaflow cache, it passes that packet to the Open vSwitch slow path.
- This procedure queues a copy of the packet to the Open vSwitch userspace
- which processes it and, if necessary, passes it back to the kernel module.
- Queuing the packet to userspace as part of this process involves buffering.
- (Going the opposite direction does not, because the kernel actually
- processes the request synchronously.) A few other exceptional cases also
- queue packets to userspace for processing; most of these are due to
- OpenFlow actions that the fast path cannot handle and that must therefore
- be handled by the slow path instead.
-
- OpenFlow also has a concept of packet buffering. When an OpenFlow switch
- sends a packet to a controller, it may opt to retain a copy of the packet
- in an OpenFlow "packet buffer". Later, if the controller wants to tell the
- switch to forward a copy of that packet, it can refer to the packet through
- its assigned buffer, instead of sending the whole packet back to the
- switch, thereby saving bandwidth in the OpenFlow control channel. Before
- Open vSwitch 2.7, OVS implemented such buffering; Open vSwitch 2.7 and
- later do not.
diff --git a/Documentation/faq/general.rst b/Documentation/faq/general.rst
index efbc213de..243815ff8 100644
--- a/Documentation/faq/general.rst
+++ b/Documentation/faq/general.rst
@@ -25,106 +25,97 @@
General
=======
-Q: What is Open vSwitch?
-
- A: Open vSwitch is a production quality open source software switch
- designed to be used as a vswitch in virtualized server environments. A
- vswitch forwards traffic between different VMs on the same physical host
- and also forwards traffic between VMs and the physical network. Open
- vSwitch supports standard management interfaces (e.g. sFlow, NetFlow,
- IPFIX, RSPAN, CLI), and is open to programmatic extension and control using
- OpenFlow and the OVSDB management protocol.
-
- Open vSwitch as designed to be compatible with modern switching chipsets.
- This means that it can be ported to existing high-fanout switches allowing
- the same flexible control of the physical infrastructure as the virtual
- infrastructure. It also means that Open vSwitch will be able to take
- advantage of on-NIC switching chipsets as their functionality matures.
-
-Q: What virtualization platforms can use Open vSwitch?
-
- A: Open vSwitch can currently run on any Linux-based virtualization
- platform (kernel 3.10 and newer), including: KVM, VirtualBox, Xen, Xen
- Cloud Platform, XenServer. As of Linux 3.3 it is part of the mainline
- kernel. The bulk of the code is written in platform- independent C and is
- easily ported to other environments. We welcome inquires about integrating
- Open vSwitch with other virtualization platforms.
-
-Q: How can I try Open vSwitch?
-
- A: The Open vSwitch source code can be built on a Linux system. You can
- build and experiment with Open vSwitch on any Linux machine. Packages for
+Q: What is OVN?
+
+ A: OVN, the Open Virtual Network, is a system to support virtual network
+ abstraction. OVN complements the existing capabilities of OVS to add
+ native support for virtual network abstractions, such as virtual L2 and L3
+ overlays and security groups.
+
+ OVN is intended to be used by cloud management software (CMS).
+ For details about the architecture of OVN, see the ovn-architecture manpage.
+ Some high-level features offered by OVN include
+
+ * Distributed virtual routers
+ * Distributed logical switches
+ * Access Control Lists
+ * DHCP
+ * DNS server
+
+Q: How can I try OVN?
+
+ A: The OVN source code can be built on a Linux system. You can
+ build and experiment with OVN on any Linux machine. Packages for
various Linux distributions are available on many platforms, including:
Debian, Ubuntu, Fedora.
- You may also download and run a virtualization platform that already has
- Open vSwitch integrated. For example, download a recent ISO for XenServer
- or Xen Cloud Platform. Be aware that the version integrated with a
- particular platform may not be the most recent Open vSwitch release.
+Q: Why does OVN use STT and Geneve instead of VLANs or VXLAN (or GRE)?
-Q: Does Open vSwitch only work on Linux?
+ A: OVN implements a fairly sophisticated packet processing pipeline in
+ "logical datapaths" that can implement switching or routing functionality.
+ A logical datapath has an ingress pipeline and an egress pipeline, and each
+ of these pipelines can include logic based on packet fields as well as
+ packet metadata such as the logical ingress and egress ports (the latter
+ only in the egress pipeline).
- A: No, Open vSwitch has been ported to a number of different operating
- systems and hardware platforms. Most of the development work occurs on
- Linux, but the code should be portable to any POSIX system. We've seen
- Open vSwitch ported to a number of different platforms, including FreeBSD,
- Windows, and even non-POSIX embedded systems.
+ The processing for a logical datapath can be split across hypervisors. In
+ particular, when a logical ingress pipeline executes an "output" action,
+ OVN passes the packet to the egress pipeline on the hypervisor (or, in the
+ case of output to a logical multicast group, hypervisors) on which the
+ logical egress port is located. If this hypervisor is not the same as the
+ ingress hypervisor, then the packet has to be transmitted across a physical
+ network.
- By definition, the Open vSwitch Linux kernel module only works on Linux and
- will provide the highest performance. However, a userspace datapath is
- available that should be very portable.
+ This situation is where tunneling comes in. To send the packet to another
+ hypervisor, OVN encapsulates it with a tunnel protocol and sends the
+ encapsulated packet across the physical network. When the remote
+ hypervisor receives the tunnel packet, it decapsulates it and passes it
+ through the logical egress pipeline. To do so, it also needs the metadata,
+ that is, the logical ingress and egress ports.
-Q: What's involved with porting Open vSwitch to a new platform or switching ASIC?
+ Thus, to implement OVN logical packet processing, at least the following
+ metadata must pass across the physical network:
- A: :doc:`/topics/porting` describes how one would go about porting Open
- vSwitch to a new operating system or hardware platform.
+ * Logical datapath ID, a 24-bit identifier. In Geneve, OVN uses the VNI to
+ hold the logical datapath ID; in STT, OVN uses 24 bits of STT's 64-bit
+ context ID.
-Q: Why would I use Open vSwitch instead of the Linux bridge?
+ * Logical ingress port, a 15-bit identifier. In Geneve, OVN uses an option
+ to hold the logical ingress port; in STT, 15 bits of the context ID.
- A: Open vSwitch is specially designed to make it easier to manage VM
- network configuration and monitor state spread across many physical hosts
- in dynamic virtualized environments. Refer to :doc:`/intro/why-ovs` for a
- more detailed description of how Open vSwitch relates to the Linux Bridge.
+ * Logical egress port, a 16-bit identifier. In Geneve, OVN uses an option
+ to hold the logical egress port; in STT, 16 bits of the context ID.
-Q: How is Open vSwitch related to distributed virtual switches like the VMware
-vNetwork distributed switch or the Cisco Nexus 1000V?
+ See ``ovn-architecture(7)``, under "Tunnel Encapsulations", for details.
- A: Distributed vswitch applications (e.g., VMware vNetwork distributed
- switch, Cisco Nexus 1000V) provide a centralized way to configure and
- monitor the network state of VMs that are spread across many physical
- hosts. Open vSwitch is not a distributed vswitch itself, rather it runs on
- each physical host and supports remote management in a way that makes it
- easier for developers of virtualization/cloud management platforms to offer
- distributed vswitch capabilities.
+ Together, these metadata require 24 + 15 + 16 = 55 bits. GRE provides 32
+ bits, VXLAN provides 24, and VLAN only provides 12. Most notably, if
+ logical egress pipelines do not match on the logical ingress port, thereby
+ restricting the class of ACLs available to users, then this eliminates 15
+ bits, bringing the requirement down to 40 bits. At this point, one can
+ choose to limit the size of the OVN logical network in various ways, e.g.:
- To aid in distribution, Open vSwitch provides two open protocols that are
- specially designed for remote management in virtualized network
- environments: OpenFlow, which exposes flow-based forwarding state, and the
- OVSDB management protocol, which exposes switch port state. In addition to
- the switch implementation itself, Open vSwitch includes tools (ovs-ofctl,
- ovs-vsctl) that developers can script and extend to provide distributed
- vswitch capabilities that are closely integrated with their virtualization
- management platform.
+ * 16 bits of logical datapaths + 16 bits of logical egress ports. This
+ combination fits within a 32-bit GRE tunnel key.
-Q: Why doesn't Open vSwitch support distribution?
+ * 12 bits of logical datapaths + 12 bits of logical egress ports. This
+ combination fits within a 24-bit VXLAN VNI.
- A: Open vSwitch is intended to be a useful component for building flexible
- network infrastructure. There are many different approaches to distribution
- which balance trade-offs between simplicity, scalability, hardware
- compatibility, convergence times, logical forwarding model, etc. The goal
- of Open vSwitch is to be able to support all as a primitive building block
- rather than choose a particular point in the distributed design space.
+ * It's difficult to identify an acceptable compromise for a VLAN-based
+ deployment.
-Q: How can I contribute to the Open vSwitch Community?
+ These compromises wouldn't suit every site, since some deployments
+ may need to allocate more bits to the datapath or egress port
+ identifiers.
+
+ As a side note, OVN does support VXLAN for use with ASIC-based top of rack
+ switches, using ``ovn-controller-vtep(8)`` and the OVSDB VTEP schema
+ described in ``vtep(5)``, but this limits the features available from OVN
+ to the subset available from the VTEP schema.
+
+Q: How can I contribute to the OVN Community?
A: You can start by joining the mailing lists and helping to answer
questions. You can also suggest improvements to documentation. If you
have a feature or bug you would like to work on, send a mail to one of the
:doc:`mailing lists </internals/mailing-lists>`.
-
-Q: Why can I no longer connect to my OpenFlow controller or OVSDB manager?
-
- A: Starting in OVS 2.4, we switched the default ports to the IANA-specified
- port numbers for OpenFlow (6633->6653) and OVSDB (6632->6640). We
- recommend using these port numbers, but if you cannot, all the programs
- allow overriding the default port. See the appropriate man page.
diff --git a/Documentation/faq/index.rst b/Documentation/faq/index.rst
index ad3cc2b6f..61c211520 100644
--- a/Documentation/faq/index.rst
+++ b/Documentation/faq/index.rst
@@ -30,15 +30,5 @@ Open vSwitch FAQ
.. toctree::
:maxdepth: 2
- configuration
contributing
- design
general
- issues
- openflow
- qos
- releases
- terminology
- vlan
- vxlan
- ovn
diff --git a/Documentation/faq/issues.rst b/Documentation/faq/issues.rst
deleted file mode 100644
index d736d4fec..000000000
--- a/Documentation/faq/issues.rst
+++ /dev/null
@@ -1,435 +0,0 @@
-..
- Licensed under the Apache License, Version 2.0 (the "License"); you may
- not use this file except in compliance with the License. You may obtain
- a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
- WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
- License for the specific language governing permissions and limitations
- under the License.
-
- Convention for heading levels in Open vSwitch documentation:
-
- ======= Heading 0 (reserved for the title in a document)
- ------- Heading 1
- ~~~~~~~ Heading 2
- +++++++ Heading 3
- ''''''' Heading 4
-
- Avoid deeper levels because they do not render well.
-
-===========================
-Common Configuration Issues
-===========================
-
-Q: I created a bridge and added my Ethernet port to it, using commands like
-these::
-
- $ ovs-vsctl add-br br0
- $ ovs-vsctl add-port br0 eth0
-
-and as soon as I ran the "add-port" command I lost all connectivity through
-eth0. Help!
-
- A: A physical Ethernet device that is part of an Open vSwitch bridge should
- not have an IP address. If one does, then that IP address will not be
- fully functional.
-
- You can restore functionality by moving the IP address to an Open vSwitch
- "internal" device, such as the network device named after the bridge
- itself. For example, assuming that eth0's IP address is 192.168.128.5, you
- could run the commands below to fix up the situation::
-
- $ ip addr flush dev eth0
- $ ip addr add 192.168.128.5/24 dev br0
- $ ip link set br0 up
-
- (If your only connection to the machine running OVS is through the IP
- address in question, then you would want to run all of these commands on a
- single command line, or put them into a script.) If there were any
- additional routes assigned to eth0, then you would also want to use
- commands to adjust these routes to go through br0.
-
- If you use DHCP to obtain an IP address, then you should kill the DHCP
- client that was listening on the physical Ethernet interface (e.g. eth0)
- and start one listening on the internal interface (e.g. br0). You might
- still need to manually clear the IP address from the physical interface
- (e.g. with "ip addr flush dev eth0").
-
- There is no compelling reason why Open vSwitch must work this way.
- However, this is the way that the Linux kernel bridge module has always
- worked, so it's a model that those accustomed to Linux bridging are already
- used to. Also, the model that most people expect is not implementable
- without kernel changes on all the versions of Linux that Open vSwitch
- supports.
-
- By the way, this issue is not specific to physical Ethernet devices. It
- applies to all network devices except Open vSwitch "internal" devices.
-
-Q: I created a bridge and added a couple of Ethernet ports to it, using
-commands like these::
-
- $ ovs-vsctl add-br br0
- $ ovs-vsctl add-port br0 eth0
- $ ovs-vsctl add-port br0 eth1
-
-and now my network seems to have melted: connectivity is unreliable (even
-connectivity that doesn't go through Open vSwitch), all the LEDs on my physical
-switches are blinking, wireshark shows duplicated packets, and CPU usage is
-very high.
-
- A: More than likely, you've looped your network. Probably, eth0 and eth1
- are connected to the same physical Ethernet switch. This yields a scenario
- where OVS receives a broadcast packet on eth0 and sends it out on eth1,
- then the physical switch connected to eth1 sends the packet back on eth0,
- and so on forever. More complicated scenarios, involving a loop through
- multiple switches, are possible too.
-
- The solution depends on what you are trying to do:
-
- - If you added eth0 and eth1 to get higher bandwidth or higher reliability
- between OVS and your physical Ethernet switch, use a bond. The following
- commands create br0 and then add eth0 and eth1 as a bond::
-
- $ ovs-vsctl add-br br0
- $ ovs-vsctl add-bond br0 bond0 eth0 eth1
-
- Bonds have tons of configuration options. Please read the documentation
- on the Port table in ovs-vswitchd.conf.db(5) for all the details.
-
- Configuration for DPDK-enabled interfaces is slightly less
- straightforward. Refer to :doc:`/intro/install/dpdk` for more
- information.
-
- - Perhaps you don't actually need eth0 and eth1 to be on the same bridge.
- For example, if you simply want to be able to connect each of them to
- virtual machines, then you can put each of them on a bridge of its own::
-
- $ ovs-vsctl add-br br0
- $ ovs-vsctl add-port br0 eth0
-
- $ ovs-vsctl add-br br1
- $ ovs-vsctl add-port br1 eth1
-
- and then connect VMs to br0 and br1. (A potential disadvantage is that
- traffic cannot directly pass between br0 and br1. Instead, it will go
- out eth0 and come back in eth1, or vice versa.)
-
- - If you have a redundant or complex network topology and you want to
- prevent loops, turn on spanning tree protocol (STP). The following
- commands create br0, enable STP, and add eth0 and eth1 to the bridge.
- The order is important because you don't want have to have a loop in your
- network even transiently::
-
- $ ovs-vsctl add-br br0
- $ ovs-vsctl set bridge br0 stp_enable=true
- $ ovs-vsctl add-port br0 eth0
- $ ovs-vsctl add-port br0 eth1
-
- The Open vSwitch implementation of STP is not well tested. Report any
- bugs you observe, but if you'd rather avoid acting as a beta tester then
- another option might be your best shot.
-
-Q: I can't seem to use Open vSwitch in a wireless network.
-
- A: Wireless base stations generally only allow packets with the source MAC
- address of NIC that completed the initial handshake. Therefore, without
- MAC rewriting, only a single device can communicate over a single wireless
- link.
-
- This isn't specific to Open vSwitch, it's enforced by the access point, so
- the same problems will show up with the Linux bridge or any other way to do
- bridging.
-
-Q: I can't seem to add my PPP interface to an Open vSwitch bridge.
-
- A: PPP most commonly carries IP packets, but Open vSwitch works only with
- Ethernet frames. The correct way to interface PPP to an Ethernet network
- is usually to use routing instead of switching.
-
-Q: Is there any documentation on the database tables and fields?
-
- A: Yes. ovs-vswitchd.conf.db(5) is a comprehensive reference.
-
-Q: When I run ovs-dpctl I no longer see the bridges I created. Instead, I only
-see a datapath called "ovs-system". How can I see datapath information about a
-particular bridge?
-
- A: In version 1.9.0, OVS switched to using a single datapath that is shared
- by all bridges of that type. The ``ovs-appctl dpif/*`` commands provide
- similar functionality that is scoped by the bridge.
-
-Q: I created a GRE port using ovs-vsctl so why can't I send traffic or see the
-port in the datapath?
-
- A: On Linux kernels before 3.11, the OVS GRE module and Linux GRE module
- cannot be loaded at the same time. It is likely that on your system the
- Linux GRE module is already loaded and blocking OVS (to confirm, check
- dmesg for errors regarding GRE registration). To fix this, unload all GRE
- modules that appear in lsmod as well as the OVS kernel module. You can then
- reload the OVS module following the directions in
- :doc:`/intro/install/general` , which will ensure that dependencies are
- satisfied.
-
-Q: Open vSwitch does not seem to obey my packet filter rules.
-
- A: It depends on mechanisms and configurations you want to use.
-
- You cannot usefully use typical packet filters, like iptables, on physical
- Ethernet ports that you add to an Open vSwitch bridge. This is because
- Open vSwitch captures packets from the interface at a layer lower below
- where typical packet-filter implementations install their hooks. (This
- actually applies to any interface of type "system" that you might add to an
- Open vSwitch bridge.)
-
- You can usefully use typical packet filters on Open vSwitch internal ports
- as they are mostly ordinary interfaces from the point of view of packet
- filters.
-
- For example, suppose you create a bridge br0 and add Ethernet port eth0 to
- it. Then you can usefully add iptables rules to affect the internal
- interface br0, but not the physical interface eth0. (br0 is also where you
- would add an IP address, as discussed elsewhere in the FAQ.)
-
- For simple filtering rules, it might be possible to achieve similar results
- by installing appropriate OpenFlow flows instead. The OVS conntrack
- feature (see the "ct" action in ovs-actions(7)) can implement a stateful
- firewall.
-
- If the use of a particular packet filter setup is essential, Open vSwitch
- might not be the best choice for you. On Linux, you might want to consider
- using the Linux Bridge. (This is the only choice if you want to use
- ebtables rules.) On NetBSD, you might want to consider using the bridge(4)
- with BRIDGE_IPF option.
-
-Q: It seems that Open vSwitch does nothing when I removed a port and then
-immediately put it back. For example, consider that p1 is a port of
-``type=internal``::
-
- $ ovs-vsctl del-port br0 p1 -- \
- add-port br0 p1 -- \
- set interface p1 type=internal
-
-Any other type of port gets the same effect.
-
- A: It's an expected behaviour.
-
- If del-port and add-port happen in a single OVSDB transaction as your
- example, Open vSwitch always "skips" the intermediate steps. Even if they
- are done in multiple transactions, it's still allowed for Open vSwitch to
- skip the intermediate steps and just implement the overall effect. In both
- cases, your example would be turned into a no-op.
-
- If you want to make Open vSwitch actually destroy and then re-create the
- port for some side effects like resetting kernel setting for the
- corresponding interface, you need to separate operations into multiple
- OVSDB transactions and ensure that at least the first one does not have
- ``--no-wait``. In the following example, the first ovs-vsctl will block
- until Open vSwitch reloads the new configuration and removes the port::
-
- $ ovs-vsctl del-port br0 p1
- $ ovs-vsctl add-port br0 p1 -- \
- set interface p1 type=internal
-
-Q: I want to add thousands of ports to an Open vSwitch bridge, but it takes too
-long (minutes or hours) to do it with ovs-vsctl. How can I do it faster?
-
- A: If you add them one at a time with ovs-vsctl, it can take a long time to
- add thousands of ports to an Open vSwitch bridge. This is because every
- invocation of ovs-vsctl first reads the current configuration from OVSDB.
- As the number of ports grows, this starts to take an appreciable amount of
- time, and when it is repeated thousands of times the total time becomes
- significant.
-
- The solution is to add the ports in one invocation of ovs-vsctl (or a small
- number of them). For example, using bash::
-
- $ ovs-vsctl add-br br0
- $ cmds=; for i in {1..5000}; do cmds+=" -- add-port br0 p$i"; done
- $ ovs-vsctl $cmds
-
- takes seconds, not minutes or hours, in the OVS sandbox environment.
-
-Q: I created a bridge named br0. My bridge shows up in "ovs-vsctl show", but
-"ovs-ofctl show br0" just prints "br0 is not a bridge or a socket".
-
- A: Open vSwitch wasn't able to create the bridge. Check the ovs-vswitchd
- log for details (Debian and Red Hat packaging for Open vSwitch put it in
- /var/log/openvswitch/ovs-vswitchd.log).
-
- In general, the Open vSwitch database reflects the desired configuration
- state. ovs-vswitchd monitors the database and, when it changes,
- reconfigures the system to reflect the new desired state. This normally
- happens very quickly. Thus, a discrepancy between the database and the
- actual state indicates that ovs-vswitchd could not implement the
- configuration, and so one should check the log to find out why. (Another
- possible cause is that ovs-vswitchd is not running. This will make
- ovs-vsctl commands hang, if they change the configuration, unless one
- specifies ``--no-wait``.)
-
-Q: I have a bridge br0. I added a new port vif1.0, and it shows up in
-"ovs-vsctl show", but "ovs-vsctl list port" says that it has OpenFlow port
-("ofport") -1, and "ovs-ofctl show br0" doesn't show vif1.0 at all.
-
- A: Open vSwitch wasn't able to create the port. Check the ovs-vswitchd log
- for details (Debian and Red Hat packaging for Open vSwitch put it in
- /var/log/openvswitch/ovs-vswitchd.log). Please see the previous question
- for more information.
-
- You may want to upgrade to Open vSwitch 2.3 (or later), in which ovs-vsctl
- will immediately report when there is an issue creating a port.
-
-Q: I created a tap device tap0, configured an IP address on it, and added it to
-a bridge, like this::
-
- $ tunctl -t tap0
- $ ip addr add 192.168.0.123/24 dev tap0
- $ ip link set tap0 up
- $ ovs-vsctl add-br br0
- $ ovs-vsctl add-port br0 tap0
-
-I expected that I could then use this IP address to contact other hosts on the
-network, but it doesn't work. Why not?
-
- A: The short answer is that this is a misuse of a "tap" device. Use an
- "internal" device implemented by Open vSwitch, which works differently and
- is designed for this use. To solve this problem with an internal device,
- instead run::
-
- $ ovs-vsctl add-br br0
- $ ovs-vsctl add-port br0 int0 -- set Interface int0 type=internal
- $ ip addr add 192.168.0.123/24 dev int0
- $ ip link set int0 up
-
- Even more simply, you can take advantage of the internal port that every
- bridge has under the name of the bridge::
-
- $ ovs-vsctl add-br br0
- $ ip addr add 192.168.0.123/24 dev br0
- $ ip link set br0 up
-
- In more detail, a "tap" device is an interface between the Linux (or BSD)
- network stack and a user program that opens it as a socket. When the "tap"
- device transmits a packet, it appears in the socket opened by the userspace
- program. Conversely, when the userspace program writes to the "tap"
- socket, the kernel TCP/IP stack processes the packet as if it had been
- received by the "tap" device.
-
- Consider the configuration above. Given this configuration, if you "ping"
- an IP address in the 192.168.0.x subnet, the Linux kernel routing stack
- will transmit an ARP on the tap0 device. Open vSwitch userspace treats
- "tap" devices just like any other network device; that is, it doesn't open
- them as "tap" sockets. That means that the ARP packet will simply get
- dropped.
-
- You might wonder why the Open vSwitch kernel module doesn't intercept the
- ARP packet and bridge it. After all, Open vSwitch intercepts packets on
- other devices. The answer is that Open vSwitch only intercepts *received*
- packets, but this is a packet being transmitted. The same thing happens
- for all other types of network devices, except for Open vSwitch "internal"
- ports. If you, for example, add a physical Ethernet port to an OVS bridge,
- configure an IP address on a physical Ethernet port, and then issue a
- "ping" to an address in that subnet, the same thing happens: an ARP gets
- transmitted on the physical Ethernet port and Open vSwitch never sees it.
- (You should not do that, as documented at the beginning of this section.)
-
- It can make sense to add a "tap" device to an Open vSwitch bridge, if some
- userspace program (other than Open vSwitch) has opened the tap socket.
- This is the case, for example, if the "tap" device was created by KVM (or
- QEMU) to simulate a virtual NIC. In such a case, when OVS bridges a packet
- to the "tap" device, the kernel forwards that packet to KVM in userspace,
- which passes it along to the VM, and in the other direction, when the VM
- sends a packet, KVM writes it to the "tap" socket, which causes OVS to
- receive it and bridge it to the other OVS ports. Please note that in such
- a case no IP address is configured on the "tap" device (there is normally
- an IP address configured in the virtual NIC inside the VM, but this is not
- visible to the host Linux kernel or to Open vSwitch).
-
- There is one special case in which Open vSwitch does directly read and
- write "tap" sockets. This is an implementation detail of the Open vSwitch
- userspace switch, which implements its "internal" ports as Linux (or BSD)
- "tap" sockets. In such a userspace switch, OVS receives packets sent on
- the "tap" device used to implement an "internal" port by reading the
- associated "tap" socket, and bridges them to the rest of the switch. In
- the other direction, OVS transmits packets bridged to the "internal" port
- by writing them to the "tap" socket, causing them to be processed by the
- kernel TCP/IP stack as if they had been received on the "tap" device.
- Users should not need to be concerned with this implementation detail.
-
- Open vSwitch has a network device type called "tap". This is intended only
- for implementing "internal" ports in the OVS userspace switch and should
- not be used otherwise. In particular, users should not configure KVM "tap"
- devices as type "tap" (use type "system", the default, instead).
-
-Q: I observe packet loss at the beginning of RFC2544 tests on a server running
-few hundred container apps bridged to OVS with traffic generated by HW traffic
-generator. How can I fix this?
-
- A: This is expected behavior on virtual switches. RFC2544 tests were
- designed for hardware switches, which don't have caches on the fastpath
- that need to be heated. Traffic generators in order to prime the switch
- use learning phase to heat the caches before sending the actual traffic in
- test phase. In case of OVS the cache is flushed quickly and to accommodate
- the traffic generator's delay between learning and test phase, the max-idle
- timeout settings should be changed to 50000 ms.::
-
- $ ovs-vsctl --no-wait set Open_vSwitch . other_config:max-idle=50000
-
-Q: How can I configure the bridge internal interface MTU? Why does Open vSwitch
-keep changing internal ports MTU?
-
- A: By default Open vSwitch overrides the internal interfaces (e.g. br0)
- MTU. If you have just an internal interface (e.g. br0) and a physical
- interface (e.g. eth0), then every change in MTU to eth0 will be reflected
- to br0. Any manual MTU configuration using `ip` on internal interfaces is
- going to be overridden by Open vSwitch to match the current bridge minimum.
-
- Sometimes this behavior is not desirable, for example with tunnels. The
- MTU of an internal interface can be explicitly set using the following
- command::
-
- $ ovs-vsctl set int br0 mtu_request=1450
-
- After this, Open vSwitch will configure br0 MTU to 1450. Since this
- setting is in the database it will be persistent (compared to what happens
- with `ip`).
-
- The MTU configuration can be removed to restore the default behavior
- with::
-
- $ ovs-vsctl set int br0 mtu_request=[]
-
- The ``mtu_request`` column can be used to configure MTU even for physical
- interfaces (e.g. eth0).
-
-Q: I just upgraded and I see a performance drop. Why?
-
- A: The OVS kernel datapath may have been updated to a newer version than
- the OVS userspace components. Sometimes new versions of OVS kernel module
- add functionality that is backwards compatible with older userspace
- components but may cause a drop in performance with them. Especially, if a
- kernel module from OVS 2.1 or newer is paired with OVS userspace 1.10 or
- older, there will be a performance drop for TCP traffic.
-
- Updating the OVS userspace components to the latest released version should
- fix the performance degradation.
-
- To get the best possible performance and functionality, it is recommended
- to pair the same versions of the kernel module and OVS userspace.
-
-Q: I can't unload the openvswitch kernel module. Why?
-
- A: The userspace might still hold the reference count. So ``rmmod openvswitch``
- does not work, for example::
-
- $ lsmod | grep openvswitch
- openvswitch 155648 4
- nf_conncount 24576 1 openvswitch
-
- Use the command below to drop the refcnt::
-
- $ ovs-dpctl del-dp system at ovs-system
- $ rmmod openvswitch
diff --git a/Documentation/faq/openflow.rst b/Documentation/faq/openflow.rst
deleted file mode 100644
index 561d793a6..000000000
--- a/Documentation/faq/openflow.rst
+++ /dev/null
@@ -1,543 +0,0 @@
-..
- Licensed under the Apache License, Version 2.0 (the "License"); you may
- not use this file except in compliance with the License. You may obtain
- a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
- WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
- License for the specific language governing permissions and limitations
- under the License.
-
- Convention for heading levels in Open vSwitch documentation:
-
- ======= Heading 0 (reserved for the title in a document)
- ------- Heading 1
- ~~~~~~~ Heading 2
- +++++++ Heading 3
- ''''''' Heading 4
-
- Avoid deeper levels because they do not render well.
-
-==============
-Using OpenFlow
-==============
-
-Q: What versions of OpenFlow does Open vSwitch support?
-
- A: The following table lists the versions of OpenFlow supported by each
- version of Open vSwitch:
-
- =============== ===== ===== ===== ===== ===== =====
- Open vSwitch OF1.0 OF1.1 OF1.2 OF1.3 OF1.4 OF1.5
- =============== ===== ===== ===== ===== ===== =====
- 1.9 and earlier yes --- --- --- --- ---
- 1.10, 1.11 yes --- (*) (*) --- ---
- 2.0, 2.1 yes (*) (*) (*) --- ---
- 2.2 yes (*) (*) (*) (%) (*)
- 2.3, 2.4 yes yes yes yes (*) (*)
- 2.5, 2.6, 2.7 yes yes yes yes (*) (*)
- 2.8 yes yes yes yes yes (*)
- =============== ===== ===== ===== ===== ===== =====
-
- --- Not supported.
- yes Supported and enabled by default
- (*) Supported, but missing features, and must be enabled by user.
- (%) Experimental, unsafe implementation.
-
- In any case, the user may override the default:
-
- - To enable OpenFlow 1.0, 1.1, 1.2, and 1.3 on bridge br0::
-
- $ ovs-vsctl set bridge br0 \
- protocols=OpenFlow10,OpenFlow11,OpenFlow12,OpenFlow13
-
- - To enable OpenFlow 1.0, 1.1, 1.2, 1.3, 1.4, and 1.5 on bridge br0::
-
- $ ovs-vsctl set bridge br0 \
- protocols=OpenFlow10,OpenFlow11,OpenFlow12,OpenFlow13,OpenFlow14,OpenFlow15
-
- - To enable only OpenFlow 1.0 on bridge br0::
-
- $ ovs-vsctl set bridge br0 protocols=OpenFlow10
-
- All current versions of ovs-ofctl enable only OpenFlow 1.0 by default. Use
- the -O option to enable support for later versions of OpenFlow in
- ovs-ofctl. For example::
-
- $ ovs-ofctl -O OpenFlow13 dump-flows br0
-
- (Open vSwitch 2.2 had an experimental implementation of OpenFlow 1.4 that
- could cause crashes. We don't recommend enabling it.)
-
- :doc:`/topics/openflow` tracks support for OpenFlow 1.1 and later features.
- When support for OpenFlow 1.5 is solidly implemented, Open vSwitch will
- enable it by default.
-
-Q: Does Open vSwitch support MPLS?
-
- A: Before version 1.11, Open vSwitch did not support MPLS. That is, these
- versions can match on MPLS Ethernet types, but they cannot match, push, or
- pop MPLS labels, nor can they look past MPLS labels into the encapsulated
- packet.
-
- Open vSwitch versions 1.11, 2.0, and 2.1 have very minimal support for
- MPLS. With the userspace datapath only, these versions can match, push, or
- pop a single MPLS label, but they still cannot look past MPLS labels (even
- after popping them) into the encapsulated packet. Kernel datapath support
- is unchanged from earlier versions.
-
- Open vSwitch version 2.3 can match, push, or pop a single MPLS label and
- look past the MPLS label into the encapsulated packet. Both userspace and
- kernel datapaths will be supported, but MPLS processing always happens in
- userspace either way, so kernel datapath performance will be disappointing.
-
- Open vSwitch version 2.4 can match, push, or pop up to 3 MPLS labels and
- look past the MPLS label into the encapsulated packet. It will have kernel
- support for MPLS, yielding improved performance.
-
-Q: I'm getting "error type 45250 code 0". What's that?
-
- A: This is a Open vSwitch extension to OpenFlow error codes. Open vSwitch
- uses this extension when it must report an error to an OpenFlow controller
- but no standard OpenFlow error code is suitable.
-
- Open vSwitch logs the errors that it sends to controllers, so the easiest
- thing to do is probably to look at the ovs-vswitchd log to find out what
- the error was.
-
- If you want to dissect the extended error message yourself, the format is
- documented in include/openflow/nicira-ext.h in the Open vSwitch source
- distribution. The extended error codes are documented in
- include/openvswitch/ofp-errors.h.
-
-Q: Some of the traffic that I'd expect my OpenFlow controller to see doesn't
-actually appear through the OpenFlow connection, even though I know that it's
-going through.
-
- A: By default, Open vSwitch assumes that OpenFlow controllers are connected
- "in-band", that is, that the controllers are actually part of the network
- that is being controlled. In in-band mode, Open vSwitch sets up special
- "hidden" flows to make sure that traffic can make it back and forth between
- OVS and the controllers. These hidden flows are higher priority than any
- flows that can be set up through OpenFlow, and they are not visible through
- normal OpenFlow flow table dumps.
-
- Usually, the hidden flows are desirable and helpful, but occasionally they
- can cause unexpected behavior. You can view the full OpenFlow flow table,
- including hidden flows, on bridge br0 with the command::
-
- $ ovs-appctl bridge/dump-flows br0
-
- to help you debug. The hidden flows are those with priorities
- greater than 65535 (the maximum priority that can be set with
- OpenFlow).
-
- The ``Documentation/topics/design`` doc describes the in-band model in
- detail.
-
- If your controllers are not actually in-band (e.g. they are on
- localhost via 127.0.0.1, or on a separate network), then you should
- configure your controllers in "out-of-band" mode. If you have one
- controller on bridge br0, then you can configure out-of-band mode
- on it with::
-
- $ ovs-vsctl set controller br0 connection-mode=out-of-band
-
-Q: Some of the OpenFlow flows that my controller sets up don't seem to apply to
-certain traffic, especially traffic between OVS and the controller itself.
-
- A: See above.
-
-Q: I configured all my controllers for out-of-band control mode but "ovs-appctl
-bridge/dump-flows" still shows some hidden flows.
-
- A: You probably have a remote manager configured (e.g. with "ovs-vsctl
- set-manager"). By default, Open vSwitch assumes that managers need in-band
- rules set up on every bridge. You can disable these rules on bridge br0
- with::
-
- $ ovs-vsctl set bridge br0 other-config:disable-in-band=true
-
- This actually disables in-band control entirely for the bridge, as if all
- the bridge's controllers were configured for out-of-band control.
-
-Q: My OpenFlow controller doesn't see the VLANs that I expect.
-
- A: See answer under "VLANs", above.
-
-Q: I ran ``ovs-ofctl add-flow br0 nw_dst=192.168.0.1,actions=drop`` but I got a
-funny message like this::
-
- ofp_util|INFO|normalization changed ofp_match, details:
- ofp_util|INFO| pre: nw_dst=192.168.0.1
- ofp_util|INFO|post:
-
-and when I ran ``ovs-ofctl dump-flows br0`` I saw that my nw_dst match had
-disappeared, so that the flow ends up matching every packet.
-
- A: The term "normalization" in the log message means that a flow cannot
- match on an L3 field without saying what L3 protocol is in use. The
- "ovs-ofctl" command above didn't specify an L3 protocol, so the L3 field
- match was dropped.
-
- In this case, the L3 protocol could be IP or ARP. A correct command for
- each possibility is, respectively::
-
- $ ovs-ofctl add-flow br0 ip,nw_dst=192.168.0.1,actions=drop
-
- and::
-
- $ ovs-ofctl add-flow br0 arp,nw_dst=192.168.0.1,actions=drop
-
- Similarly, a flow cannot match on an L4 field without saying what L4
- protocol is in use. For example, the flow match ``tp_src=1234`` is, by
- itself, meaningless and will be ignored. Instead, to match TCP source port
- 1234, write ``tcp,tp_src=1234``, or to match UDP source port 1234, write
- ``udp,tp_src=1234``.
-
-Q: How can I figure out the OpenFlow port number for a given port?
-
- A: The ``OFPT_FEATURES_REQUEST`` message requests an OpenFlow switch to
- respond with an ``OFPT_FEATURES_REPLY`` that, among other information,
- includes a mapping between OpenFlow port names and numbers. From a command
- prompt, ``ovs-ofctl show br0`` makes such a request and prints the response
- for switch br0.
-
- The Interface table in the Open vSwitch database also maps OpenFlow port
- names to numbers. To print the OpenFlow port number associated with
- interface eth0, run::
-
- $ ovs-vsctl get Interface eth0 ofport
-
- You can print the entire mapping with::
-
- $ ovs-vsctl -- --columns=name,ofport list Interface
-
- but the output mixes together interfaces from all bridges in the database,
- so it may be confusing if more than one bridge exists.
-
- In the Open vSwitch database, ofport value ``-1`` means that the interface
- could not be created due to an error. (The Open vSwitch log should
- indicate the reason.) ofport value ``[]`` (the empty set) means that the
- interface hasn't been created yet. The latter is normally an intermittent
- condition (unless ovs-vswitchd is not running).
-
-Q: I added some flows with my controller or with ovs-ofctl, but when I run
-"ovs-dpctl dump-flows" I don't see them.
-
- A: ovs-dpctl queries a kernel datapath, not an OpenFlow switch. It won't
- display the information that you want. You want to use ``ovs-ofctl
- dump-flows`` instead.
-
-Q: It looks like each of the interfaces in my bonded port shows up as an
-individual OpenFlow port. Is that right?
-
- A: Yes, Open vSwitch makes individual bond interfaces visible as OpenFlow
- ports, rather than the bond as a whole. The interfaces are treated
- together as a bond for only a few purposes:
-
- - Sending a packet to the OFPP_NORMAL port. (When an OpenFlow controller
- is not configured, this happens implicitly to every packet.)
-
- - Mirrors configured for output to a bonded port.
-
- It would make a lot of sense for Open vSwitch to present a bond as a single
- OpenFlow port. If you want to contribute an implementation of such a
- feature, please bring it up on the Open vSwitch development mailing list at
- dev at openvswitch.org.
-
-Q: I have a sophisticated network setup involving Open vSwitch, VMs or multiple
-hosts, and other components. The behavior isn't what I expect. Help!
-
- A: To debug network behavior problems, trace the path of a packet,
- hop-by-hop, from its origin in one host to a remote host. If that's
- correct, then trace the path of the response packet back to the origin.
-
- The open source tool called ``plotnetcfg`` can help to understand the
- relationship between the networking devices on a single host.
-
- Usually a simple ICMP echo request and reply (``ping``) packet is good
- enough. Start by initiating an ongoing ``ping`` from the origin host to a
- remote host. If you are tracking down a connectivity problem, the "ping"
- will not display any successful output, but packets are still being sent.
- (In this case the packets being sent are likely ARP rather than ICMP.)
-
- Tools available for tracing include the following:
-
- - ``tcpdump`` and ``wireshark`` for observing hops across network devices,
- such as Open vSwitch internal devices and physical wires.
-
- - ``ovs-appctl dpif/dump-flows <br>`` in Open vSwitch 1.10 and later or
- ``ovs-dpctl dump-flows <br>`` in earlier versions. These tools allow one
- to observe the actions being taken on packets in ongoing flows.
-
- See ovs-vswitchd(8) for ``ovs-appctl dpif/dump-flows`` documentation,
- ovs-dpctl(8) for ``ovs-dpctl dump-flows`` documentation, and "Why are
- there so many different ways to dump flows?" above for some background.
-
- - ``ovs-appctl ofproto/trace`` to observe the logic behind how ovs-vswitchd
- treats packets. See ovs-vswitchd(8) for documentation. You can out more
- details about a given flow that ``ovs-dpctl dump-flows`` displays, by
- cutting and pasting a flow from the output into an ``ovs-appctl
- ofproto/trace`` command.
-
- - SPAN, RSPAN, and ERSPAN features of physical switches, to observe what
- goes on at these physical hops.
-
- Starting at the origin of a given packet, observe the packet at each hop in
- turn. For example, in one plausible scenario, you might:
-
- 1. ``tcpdump`` the ``eth`` interface through which an ARP egresses a VM,
- from inside the VM.
-
- 2. ``tcpdump`` the ``vif`` or ``tap`` interface through which the ARP
- ingresses the host machine.
-
- 3. Use ``ovs-dpctl dump-flows`` to spot the ARP flow and observe the host
- interface through which the ARP egresses the physical machine. You may
- need to use ``ovs-dpctl show`` to interpret the port numbers. If the
- output seems surprising, you can use ``ovs-appctl ofproto/trace`` to
- observe details of how ovs-vswitchd determined the actions in the
- ``ovs-dpctl dump-flows`` output.
-
- 4. ``tcpdump`` the ``eth`` interface through which the ARP egresses the
- physical machine.
-
- 5. ``tcpdump`` the ``eth`` interface through which the ARP ingresses the
- physical machine, at the remote host that receives the ARP.
-
- 6. Use ``ovs-dpctl dump-flows`` to spot the ARP flow on the remote host
- remote host that receives the ARP and observe the VM ``vif`` or ``tap``
- interface to which the flow is directed. Again, ``ovs-dpctl show`` and
- ``ovs-appctl ofproto/trace`` might help.
-
- 7. ``tcpdump`` the ``vif`` or ``tap`` interface to which the ARP is
- directed.
-
- 8. ``tcpdump`` the ``eth`` interface through which the ARP ingresses a VM,
- from inside the VM.
-
- It is likely that during one of these steps you will figure out the
- problem. If not, then follow the ARP reply back to the origin, in reverse.
-
-Q: How do I make a flow drop packets?
-
- A: To drop a packet is to receive it without forwarding it. OpenFlow
- explicitly specifies forwarding actions. Thus, a flow with an empty set of
- actions does not forward packets anywhere, causing them to be dropped. You
- can specify an empty set of actions with ``actions=`` on the ovs-ofctl
- command line. For example::
-
- $ ovs-ofctl add-flow br0 priority=65535,actions=
-
- would cause every packet entering switch br0 to be dropped.
-
- You can write "drop" explicitly if you like. The effect is the same.
- Thus, the following command also causes every packet entering switch br0 to
- be dropped::
-
- $ ovs-ofctl add-flow br0 priority=65535,actions=drop
-
- ``drop`` is not an action, either in OpenFlow or Open vSwitch. Rather, it
- is only a way to say that there are no actions.
-
-Q: I added a flow to send packets out the ingress port, like this::
-
- $ ovs-ofctl add-flow br0 in_port=2,actions=2
-
-but OVS drops the packets instead.
-
- A: Yes, OpenFlow requires a switch to ignore attempts to send a packet out
- its ingress port. The rationale is that dropping these packets makes it
- harder to loop the network. Sometimes this behavior can even be
- convenient, e.g. it is often the desired behavior in a flow that forwards a
- packet to several ports ("floods" the packet).
-
- Sometimes one really needs to send a packet out its ingress port
- ("hairpin"). In this case, output to ``OFPP_IN_PORT``, which in ovs-ofctl
- syntax is expressed as just ``in_port``, e.g.::
-
- $ ovs-ofctl add-flow br0 in_port=2,actions=in_port
-
- This also works in some circumstances where the flow doesn't match on the
- input port. For example, if you know that your switch has five ports
- numbered 2 through 6, then the following will send every received packet
- out every port, even its ingress port::
-
- $ ovs-ofctl add-flow br0 actions=2,3,4,5,6,in_port
-
- or, equivalently::
-
- $ ovs-ofctl add-flow br0 actions=all,in_port
-
- Sometimes, in complicated flow tables with multiple levels of ``resubmit``
- actions, a flow needs to output to a particular port that may or may not be
- the ingress port. It's difficult to take advantage of ``OFPP_IN_PORT`` in
- this situation. To help, Open vSwitch provides, as an OpenFlow extension,
- the ability to modify the in_port field. Whatever value is currently in
- the in_port field is the port to which outputs will be dropped, as well as
- the destination for ``OFPP_IN_PORT``. This means that the following will
- reliably output to port 2 or to ports 2 through 6, respectively::
-
- $ ovs-ofctl add-flow br0 in_port=2,actions=load:0->NXM_OF_IN_PORT[],2
- $ ovs-ofctl add-flow br0 actions=load:0->NXM_OF_IN_PORT[],2,3,4,5,6
-
- If the input port is important, then one may save and restore it on the
- stack:
-
- $ ovs-ofctl add-flow br0 actions=push:NXM_OF_IN_PORT[],\
- load:0->NXM_OF_IN_PORT[],\
- 2,3,4,5,6,\
- pop:NXM_OF_IN_PORT[]
-
-Q: My bridge br0 has host 192.168.0.1 on port 1 and host 192.168.0.2 on port 2.
-I set up flows to forward only traffic destined to the other host and drop
-other traffic, like this::
-
- priority=5,in_port=1,ip,nw_dst=192.168.0.2,actions=2
- priority=5,in_port=2,ip,nw_dst=192.168.0.1,actions=1
- priority=0,actions=drop
-
-But it doesn't work--I don't get any connectivity when I do this. Why?
-
- A: These flows drop the ARP packets that IP hosts use to establish IP
- connectivity over Ethernet. To solve the problem, add flows to allow ARP
- to pass between the hosts::
-
- priority=5,in_port=1,arp,actions=2
- priority=5,in_port=2,arp,actions=1
-
- This issue can manifest other ways, too. The following flows that match on
- Ethernet addresses instead of IP addresses will also drop ARP packets,
- because ARP requests are broadcast instead of being directed to a specific
- host::
-
- priority=5,in_port=1,dl_dst=54:00:00:00:00:02,actions=2
- priority=5,in_port=2,dl_dst=54:00:00:00:00:01,actions=1
- priority=0,actions=drop
-
- The solution already described above will also work in this case. It may
- be better to add flows to allow all multicast and broadcast traffic::
-
- priority=5,in_port=1,dl_dst=01:00:00:00:00:00/01:00:00:00:00:00,actions=2
- priority=5,in_port=2,dl_dst=01:00:00:00:00:00/01:00:00:00:00:00,actions=1
-
-Q: My bridge disconnects from my controller on add-port/del-port.
-
- A: Reconfiguring your bridge can change your bridge's datapath-id because
- Open vSwitch generates datapath-id from the MAC address of one of its
- ports. In that case, Open vSwitch disconnects from controllers because
- there's no graceful way to notify controllers about the change of
- datapath-id.
-
- To avoid the behaviour, you can configure datapath-id manually.::
-
- $ ovs-vsctl set bridge br0 other-config:datapath-id=0123456789abcdef
-
-Q: My controller complains that OVS is not buffering packets.
-What's going on?
-
- A: "Packet buffering" is an optional OpenFlow feature, and controllers
- should detect how many "buffers" an OpenFlow switch implements. It was
- recently noticed that OVS implementation of the buffering feature was not
- compliant to OpenFlow specifications. Rather than fix it and risk
- controller incompatibility, the buffering feature is removed as of OVS 2.7.
- Controllers are already expected to work properly in cases where the switch
- can not buffer packets, but sends full packets in "packet-in" messages
- instead, so this change should not affect existing users. After the change
- OVS always sends the ``buffer_id`` as ``0xffffffff`` in "packet-in"
- messages and will send an error response if any other value of this field
- is included in a "packet-out" or a "flow mod" sent by a controller.
-
- Packet buffers have limited usefulness in any case. Table-miss packet-in
- messages most commonly pass the first packet in a microflow to the OpenFlow
- controller, which then sets up an OpenFlow flow that handles remaining
- traffic in the microflow without further controller intervention. In such
- a case, the packet that initiates the microflow is in practice usually
- small (certainly for TCP), which means that the switch sends the entire
- packet to the controller and the buffer only saves a small number of bytes
- in the reverse direction.
-
-Q: How does OVS divide flows among buckets in an OpenFlow "select" group?
-
- A: In Open vSwitch 2.3 and earlier, Open vSwitch used the destination
- Ethernet address to choose a bucket in a select group.
-
- Open vSwitch 2.4 and later by default hashes the source and destination
- Ethernet address, VLAN ID, Ethernet type, IPv4/v6 source and destination
- address and protocol, and for TCP and SCTP only, the source and destination
- ports. The hash is "symmetric", meaning that exchanging source and
- destination addresses does not change the bucket selection.
-
- Select groups in Open vSwitch 2.4 and later can be configured to use a
- different hash function, using a Netronome extension to the OpenFlow 1.5+
- group_mod message. For more information, see
- Documentation/group-selection-method-property.txt in the Open vSwitch
- source tree. (OpenFlow 1.5 support in Open vSwitch is still experimental.)
-
-Q: An OpenFlow "select" group isn't dividing packets evenly among the buckets.
-
- A: When a packet passes through a "select" group, Open vSwitch hashes a
- subset of the fields in the packet, then it maps the hash value to a
- bucket. This means that packets whose hashed fields are the same will
- always go to the same bucket[*]. More specifically, if you test with a
- single traffic flow, only one bucket will receive any traffic[**].
- Furthermore, statistics and probability mean that testing with a small
- number of flows may still yield an uneven distribution.
-
- [*] Unless its bucket has a watch port or group whose liveness changes
- during the test.
-
- [**] Unless the hash includes fields that vary within a traffic flow, such
- as tcp_flags.
-
-Q: I added a flow to accept packets on VLAN 123 and output them on VLAN 456,
-like so::
-
- $ ovs-ofctl add-flow br0 dl_vlan=123,actions=output:1,mod_vlan_vid:456
-
-but the packets are actually being output in VLAN 123. Why?
-
- A: OpenFlow actions are executed in the order specified. Thus, the actions
- above first output the packet, then change its VLAN. Since the output
- occurs before changing the VLAN, the change in VLAN will have no visible
- effect.
-
- To solve this and similar problems, order actions so that changes to
- headers happen before output, e.g.::
-
- $ ovs-ofctl add-flow br0 dl_vlan=123,actions=mod_vlan_vid:456,output:1
-
- See also the following question.
-
-Q: I added a flow to a redirect packets for TCP port 80 to port 443,
-like so::
-
- $ ovs-ofctl add-flow br0 tcp,tcp_dst=123,actions=mod_tp_dst:443
-
-but the packets are getting dropped instead. Why?
-
- A: This set of actions does change the TCP destination port to 443, but
- then it does nothing more. It doesn't, for example, say to continue to
- another flow table or to output the packet. Therefore, the packet is
- dropped.
-
- To solve the problem, add an action that does something with the modified
- packet. For example::
-
- $ ovs-ofctl add-flow br0 tcp,tcp_dst=123,actions=mod_tp_dst:443,normal
-
- See also the preceding question.
-
-Q: When using the "ct" action with FTP connections, it doesn't seem to matter
-if I set the "alg=ftp" parameter in the action. Is this required?
-
- A: It is advisable to use this option. Some platforms may automatically
- detect and apply ALGs in the "ct" action regardless of the parameters you
- provide, however this is not consistent across all implementations. The
- `ovs-ofctl(8) <http://openvswitch.org/support/dist-docs/ovs-ofctl.8.html>`_
- man pages contain further details in the description of the ALG parameter.
-
diff --git a/Documentation/faq/ovn.rst b/Documentation/faq/ovn.rst
deleted file mode 100644
index 4d96b4aa5..000000000
--- a/Documentation/faq/ovn.rst
+++ /dev/null
@@ -1,90 +0,0 @@
-..
- Licensed under the Apache License, Version 2.0 (the "License"); you may
- not use this file except in compliance with the License. You may obtain
- a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
- WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
- License for the specific language governing permissions and limitations
- under the License.
-
- Convention for heading levels in Open vSwitch documentation:
-
- ======= Heading 0 (reserved for the title in a document)
- ------- Heading 1
- ~~~~~~~ Heading 2
- +++++++ Heading 3
- ''''''' Heading 4
-
- Avoid deeper levels because they do not render well.
-
-===
-OVN
-===
-
-Q: Why does OVN use STT and Geneve instead of VLANs or VXLAN (or GRE)?
-
- A: OVN implements a fairly sophisticated packet processing pipeline in
- "logical datapaths" that can implement switching or routing functionality.
- A logical datapath has an ingress pipeline and an egress pipeline, and each
- of these pipelines can include logic based on packet fields as well as
- packet metadata such as the logical ingress and egress ports (the latter
- only in the egress pipeline).
-
- The processing for a logical datapath can be split across hypervisors. In
- particular, when a logical ingress pipeline executes an "output" action,
- OVN passes the packet to the egress pipeline on the hypervisor (or, in the
- case of output to a logical multicast group, hypervisors) on which the
- logical egress port is located. If this hypervisor is not the same as the
- ingress hypervisor, then the packet has to be transmitted across a physical
- network.
-
- This situation is where tunneling comes in. To send the packet to another
- hypervisor, OVN encapsulates it with a tunnel protocol and sends the
- encapsulated packet across the physical network. When the remote
- hypervisor receives the tunnel packet, it decapsulates it and passes it
- through the logical egress pipeline. To do so, it also needs the metadata,
- that is, the logical ingress and egress ports.
-
- Thus, to implement OVN logical packet processing, at least the following
- metadata must pass across the physical network:
-
- * Logical datapath ID, a 24-bit identifier. In Geneve, OVN uses the VNI to
- hold the logical datapath ID; in STT, OVN uses 24 bits of STT's 64-bit
- context ID.
-
- * Logical ingress port, a 15-bit identifier. In Geneve, OVN uses an option
- to hold the logical ingress port; in STT, 15 bits of the context ID.
-
- * Logical egress port, a 16-bit identifier. In Geneve, OVN uses an option
- to hold the logical egress port; in STT, 16 bits of the context ID.
-
- See ``ovn-architecture(7)``, under "Tunnel Encapsulations", for details.
-
- Together, these metadata require 24 + 15 + 16 = 55 bits. GRE provides 32
- bits, VXLAN provides 24, and VLAN only provides 12. Most notably, if
- logical egress pipelines do not match on the logical ingress port, thereby
- restricting the class of ACLs available to users, then this eliminates 15
- bits, bringing the requirement down to 40 bits. At this point, one can
- choose to limit the size of the OVN logical network in various ways, e.g.:
-
- * 16 bits of logical datapaths + 16 bits of logical egress ports. This
- combination fits within a 32-bit GRE tunnel key.
-
- * 12 bits of logical datapaths + 12 bits of logical egress ports. This
- combination fits within a 24-bit VXLAN VNI.
-
- * It's difficult to identify an acceptable compromise for a VLAN-based
- deployment.
-
- These compromises wouldn't suit every site, since some deployments
- may need to allocate more bits to the datapath or egress port
- identifiers.
-
- As a side note, OVN does support VXLAN for use with ASIC-based top of rack
- switches, using ``ovn-controller-vtep(8)`` and the OVSDB VTEP schema
- described in ``vtep(5)``, but this limits the features available from OVN
- to the subset available from the VTEP schema.
diff --git a/Documentation/faq/qos.rst b/Documentation/faq/qos.rst
deleted file mode 100644
index 53ad89809..000000000
--- a/Documentation/faq/qos.rst
+++ /dev/null
@@ -1,169 +0,0 @@
-..
- Licensed under the Apache License, Version 2.0 (the "License"); you may
- not use this file except in compliance with the License. You may obtain
- a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
- WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
- License for the specific language governing permissions and limitations
- under the License.
-
- Convention for heading levels in Open vSwitch documentation:
-
- ======= Heading 0 (reserved for the title in a document)
- ------- Heading 1
- ~~~~~~~ Heading 2
- +++++++ Heading 3
- ''''''' Heading 4
-
- Avoid deeper levels because they do not render well.
-
-========================
-Quality of Service (QoS)
-========================
-
-Q: Does OVS support Quality of Service (QoS)?
-
- A: Yes. For traffic that egresses from a switch, OVS supports traffic
- shaping; for traffic that ingresses into a switch, OVS support policing.
- Policing is a simple form of quality-of-service that simply drops packets
- received in excess of the configured rate. Due to its simplicity, policing
- is usually less accurate and less effective than egress traffic shaping,
- which queues packets.
-
- Keep in mind that ingress and egress are from the perspective of the
- switch. That means that egress shaping limits the rate at which traffic is
- allowed to transmit from a physical interface, but not the rate at which
- traffic will be received on a virtual machine's VIF. For ingress policing,
- the behavior is the opposite.
-
-Q: How do I configure egress traffic shaping?
-
- A: Suppose that you want to set up bridge br0 connected to physical
- Ethernet port eth0 (a 1 Gbps device) and virtual machine interfaces vif1.0
- and vif2.0, and that you want to limit traffic from vif1.0 to eth0 to 10
- Mbps and from vif2.0 to eth0 to 20 Mbps. Then, you could configure the
- bridge this way::
-
- $ ovs-vsctl -- \
- add-br br0 -- \
- add-port br0 eth0 -- \
- add-port br0 vif1.0 -- set interface vif1.0 ofport_request=5 -- \
- add-port br0 vif2.0 -- set interface vif2.0 ofport_request=6 -- \
- set port eth0 qos=@newqos -- \
- --id=@newqos create qos type=linux-htb \
- other-config:max-rate=1000000000 \
- queues:123=@vif10queue \
- queues:234=@vif20queue -- \
- --id=@vif10queue create queue other-config:max-rate=10000000 -- \
- --id=@vif20queue create queue other-config:max-rate=20000000
-
- At this point, bridge br0 is configured with the ports and eth0 is
- configured with the queues that you need for QoS, but nothing is actually
- directing packets from vif1.0 or vif2.0 to the queues that we have set up
- for them. That means that all of the packets to eth0 are going to the
- "default queue", which is not what we want.
-
- We use OpenFlow to direct packets from vif1.0 and vif2.0 to the queues
- reserved for them::
-
- $ ovs-ofctl add-flow br0 in_port=5,actions=set_queue:123,normal
- $ ovs-ofctl add-flow br0 in_port=6,actions=set_queue:234,normal
-
- Each of the above flows matches on the input port, sets up the appropriate
- queue (123 for vif1.0, 234 for vif2.0), and then executes the "normal"
- action, which performs the same switching that Open vSwitch would have done
- without any OpenFlow flows being present. (We know that vif1.0 and vif2.0
- have OpenFlow port numbers 5 and 6, respectively, because we set their
- ofport_request columns above. If we had not done that, then we would have
- needed to find out their port numbers before setting up these flows.)
-
- Now traffic going from vif1.0 or vif2.0 to eth0 should be rate-limited.
-
- By the way, if you delete the bridge created by the above commands, with::
-
- $ ovs-vsctl del-br br0
-
- then that will leave one unreferenced QoS record and two unreferenced Queue
- records in the Open vSwich database. One way to clear them out, assuming
- you don't have other QoS or Queue records that you want to keep, is::
-
- $ ovs-vsctl -- --all destroy QoS -- --all destroy Queue
-
- If you do want to keep some QoS or Queue records, or the Open vSwitch you
- are using is older than version 1.8 (which added the ``--all`` option),
- then you will have to destroy QoS and Queue records individually.
-
-Q: How do I configure ingress policing?
-
- A: A policing policy can be configured on an interface to drop packets that
- arrive at a higher rate than the configured value. For example, the
- following commands will rate-limit traffic that vif1.0 may generate to
- 10Mbps:
-
- $ ovs-vsctl set interface vif1.0 ingress_policing_rate=10000
- $ ovs-vsctl set interface vif1.0 ingress_policing_burst=8000
-
- Traffic policing can interact poorly with some network protocols and can
- have surprising results. The "Ingress Policing" section of
- ovs-vswitchd.conf.db(5) discusses the issues in greater detail.
-
-Q: I configured Quality of Service (QoS) in my OpenFlow network by adding
-records to the QoS and Queue table, but the results aren't what I expect.
-
- A: Did you install OpenFlow flows that use your queues? This is the
- primary way to tell Open vSwitch which queues you want to use. If you
- don't do this, then the default queue will be used, which will probably not
- have the effect you want.
-
- Refer to the previous question for an example.
-
-Q: I'd like to take advantage of some QoS feature that Open vSwitch doesn't yet
-support. How do I do that?
-
- A: Open vSwitch does not implement QoS itself. Instead, it can configure
- some, but not all, of the QoS features built into the Linux kernel. If you
- need some QoS feature that OVS cannot configure itself, then the first step
- is to figure out whether Linux QoS supports that feature. If it does, then
- you can submit a patch to support Open vSwitch configuration for that
- feature, or you can use "tc" directly to configure the feature in Linux.
- (If Linux QoS doesn't support the feature you want, then first you have to
- add that support to Linux.)
-
-Q: I configured QoS, correctly, but my measurements show that it isn't working
-as well as I expect.
-
- A: With the Linux kernel, the Open vSwitch implementation of QoS has two
- aspects:
-
- - Open vSwitch configures a subset of Linux kernel QoS features, according
- to what is in OVSDB. It is possible that this code has bugs. If you
- believe that this is so, then you can configure the Linux traffic control
- (QoS) stack directly with the "tc" program. If you get better results
- that way, you can send a detailed bug report to bugs at openvswitch.org.
-
- It is certain that Open vSwitch cannot configure every Linux kernel QoS
- feature. If you need some feature that OVS cannot configure, then you
- can also use "tc" directly (or add that feature to OVS).
-
- - The Open vSwitch implementation of OpenFlow allows flows to be directed
- to particular queues. This is pretty simple and unlikely to have serious
- bugs at this point.
-
- However, most problems with QoS on Linux are not bugs in Open vSwitch at
- all. They tend to be either configuration errors (please see the earlier
- questions in this section) or issues with the traffic control (QoS) stack
- in Linux. The Open vSwitch developers are not experts on Linux traffic
- control. We suggest that, if you believe you are encountering a problem
- with Linux traffic control, that you consult the tc manpages (e.g. tc(8),
- tc-htb(8), tc-hfsc(8)), web resources (e.g. http://lartc.org/), or mailing
- lists (e.g. http://vger.kernel.org/vger-lists.html#netdev).
-
-Q: Does Open vSwitch support OpenFlow meters?
-
- A: Open vSwitch 2.0 added OpenFlow protocol support for OpenFlow meters.
- Open vSwitch 2.7 implemented meters in the userspace datapath. Open
- vSwitch 2.10 implemented meters in the Linux kernel datapath.
diff --git a/Documentation/faq/releases.rst b/Documentation/faq/releases.rst
deleted file mode 100644
index cd5aad162..000000000
--- a/Documentation/faq/releases.rst
+++ /dev/null
@@ -1,302 +0,0 @@
-..
- Licensed under the Apache License, Version 2.0 (the "License"); you may
- not use this file except in compliance with the License. You may obtain
- a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
- WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
- License for the specific language governing permissions and limitations
- under the License.
-
- Convention for heading levels in Open vSwitch documentation:
-
- ======= Heading 0 (reserved for the title in a document)
- ------- Heading 1
- ~~~~~~~ Heading 2
- +++++++ Heading 3
- ''''''' Heading 4
-
- Avoid deeper levels because they do not render well.
-
-========
-Releases
-========
-
-Q: What does it mean for an Open vSwitch release to be LTS (long-term support)?
-
- A: All official releases have been through a comprehensive testing process
- and are suitable for production use. Planned releases occur twice a year.
- If a significant bug is identified in an LTS release, we will provide an
- updated release that includes the fix. Releases that are not LTS may not
- be fixed and may just be supplanted by the next major release. The current
- LTS release is 2.5.x.
-
- For more information on the Open vSwitch release process, refer to
- :doc:`/internals/release-process`.
-
-Q: What Linux kernel versions does each Open vSwitch release work with?
-
- A: The following table lists the Linux kernel versions against which the
- given versions of the Open vSwitch kernel module will successfully build.
- The Linux kernel versions are upstream kernel versions, so Linux kernels
- modified from the upstream sources may not build in some cases even if they
- are based on a supported version. This is most notably true of Red Hat
- Enterprise Linux (RHEL) kernels, which are extensively modified from
- upstream.
-
- ============ ==============
- Open vSwitch Linux kernel
- ============ ==============
- 1.4.x 2.6.18 to 3.2
- 1.5.x 2.6.18 to 3.2
- 1.6.x 2.6.18 to 3.2
- 1.7.x 2.6.18 to 3.3
- 1.8.x 2.6.18 to 3.4
- 1.9.x 2.6.18 to 3.8
- 1.10.x 2.6.18 to 3.8
- 1.11.x 2.6.18 to 3.8
- 2.0.x 2.6.32 to 3.10
- 2.1.x 2.6.32 to 3.11
- 2.3.x 2.6.32 to 3.14
- 2.4.x 2.6.32 to 4.0
- 2.5.x 2.6.32 to 4.3
- 2.6.x 3.10 to 4.7
- 2.7.x 3.10 to 4.9
- 2.8.x 3.10 to 4.12
- 2.9.x 3.10 to 4.13
- 2.10.x 3.10 to 4.17
- 2.11.x 3.10 to 4.18
- ============ ==============
-
- Open vSwitch userspace should also work with the Linux kernel module built
- into Linux 3.3 and later.
-
- Open vSwitch userspace is not sensitive to the Linux kernel version. It
- should build against almost any kernel, certainly against 2.6.32 and later.
-
-Q: Are all features available with all datapaths?
-
- A: Open vSwitch supports different datapaths on different platforms. Each
- datapath has a different feature set: the following tables try to summarize
- the status.
-
- Supported datapaths:
-
- Linux upstream
- The datapath implemented by the kernel module shipped with Linux
- upstream. Since features have been gradually introduced into the kernel,
- the table mentions the first Linux release whose OVS module supports the
- feature.
-
- Linux OVS tree
- The datapath implemented by the Linux kernel module distributed with the
- OVS source tree.
-
- Userspace
- Also known as DPDK, dpif-netdev or dummy datapath. It is the only
- datapath that works on NetBSD, FreeBSD and Mac OSX.
-
- Hyper-V
- Also known as the Windows datapath.
-
- The following table lists the datapath supported features from an Open
- vSwitch user's perspective.
-
- ========================== ============== ============== ========= =======
- Feature Linux upstream Linux OVS tree Userspace Hyper-V
- ========================== ============== ============== ========= =======
- Connection tracking 4.3 YES YES YES
- Conntrack Fragment Reass. 4.3 YES YES YES
- NAT 4.6 YES YES YES
- Conntrack zone limit 4.18 YES NO YES
- Tunnel - LISP NO YES NO NO
- Tunnel - STT NO YES NO YES
- Tunnel - GRE 3.11 YES YES YES
- Tunnel - VXLAN 3.12 YES YES YES
- Tunnel - Geneve 3.18 YES YES YES
- Tunnel - GRE-IPv6 4.18 YES YES NO
- Tunnel - VXLAN-IPv6 4.3 YES YES NO
- Tunnel - Geneve-IPv6 4.4 YES YES NO
- Tunnel - ERSPAN 4.18 YES YES NO
- Tunnel - ERSPAN-IPv6 4.18 YES YES NO
- QoS - Policing YES YES YES NO
- QoS - Shaping YES YES NO NO
- sFlow YES YES YES NO
- IPFIX 3.10 YES YES YES
- Set action YES YES YES PARTIAL
- NIC Bonding YES YES YES YES
- Multiple VTEPs YES YES YES YES
- Meters 4.15 YES YES NO
- ========================== ============== ============== ========= =======
-
- Do note, however:
-
- * Only a limited set of flow fields is modifiable via the set action by the
- Hyper-V datapath.
-
- * Userspace datapath support, in some cases, is dependent on the associated
- interface types. For example, DPDK interfaces support ingress and egress
- policing, but not shaping.
-
- The following table lists features that do not *directly* impact an Open
- vSwitch user, e.g. because their absence can be hidden by the ofproto layer
- (usually this comes with a performance penalty).
-
- ===================== ============== ============== ========= =======
- Feature Linux upstream Linux OVS tree Userspace Hyper-V
- ===================== ============== ============== ========= =======
- SCTP flows 3.12 YES YES YES
- MPLS 3.19 YES YES YES
- UFID 4.0 YES YES NO
- Megaflows 3.12 YES YES NO
- Masked set action 4.0 YES YES NO
- Recirculation 3.19 YES YES YES
- TCP flags matching 3.13 YES YES NO
- Validate flow actions YES YES N/A NO
- Multiple datapaths YES YES YES NO
- Tunnel TSO - STT N/A YES NO YES
- ===================== ============== ============== ========= =======
-
-Q: What DPDK version does each Open vSwitch release work with?
-
- A: The following table lists the DPDK version against which the given
- versions of Open vSwitch will successfully build.
-
- ============ =======
- Open vSwitch DPDK
- ============ =======
- 2.2.x 1.6
- 2.3.x 1.6
- 2.4.x 2.0
- 2.5.x 2.2
- 2.6.x 16.07.2
- 2.7.x 16.11.8
- 2.8.x 17.05.2
- 2.9.x 17.11.4
- 2.10.x 17.11.4
- 2.11.x 18.11
- ============ =======
-
-Q: Are all the DPDK releases that OVS versions work with maintained?
-
- No. DPDK follows YY.MM.n (Year.Month.Number) versioning.
-
- Typically, all DPDK releases get a stable YY.MM.1 update with bugfixes 3
- months after the YY.MM.0 release. In some cases there may also be a
- YY.MM.2 release.
-
- DPDK LTS releases start once a year at YY.11.0 and are maintained for
- two years, with YY.MM.n+1 releases around every 3 months.
-
- The latest information about DPDK stable and LTS releases can be found
- at `DPDK stable`_.
-
-.. _DPDK stable: http://dpdk.org/doc/guides/contributing/stable.html
-
-Q: I get an error like this when I configure Open vSwitch:
-
- configure: error: Linux kernel in <dir> is version <x>, but
- version newer than <y> is not supported (please refer to the
- FAQ for advice)
-
- What should I do?
-
- A: You have the following options:
-
- - Use the Linux kernel module supplied with the kernel that you are using.
- (See also the following FAQ.)
-
- - If there is a newer released version of Open vSwitch, consider building
- that one, because it may support the kernel that you are building
- against. (To find out, consult the table in the previous FAQ.)
-
- - The Open vSwitch "master" branch may support the kernel that you are
- using, so consider building the kernel module from "master".
-
- All versions of Open vSwitch userspace are compatible with all versions of
- the Open vSwitch kernel module, so you do not have to use the kernel module
- from one source along with the userspace programs from the same source.
-
-Q: What features are not available in the Open vSwitch kernel datapath that
-ships as part of the upstream Linux kernel?
-
- A: The kernel module in upstream Linux does not include support for LISP.
- Work is in progress to add support for LISP to the upstream Linux version
- of the Open vSwitch kernel module. For now, if you need this feature, use
- the kernel module from the Open vSwitch distribution instead of the
- upstream Linux kernel module.
-
- Certain features require kernel support to function or to have reasonable
- performance. If the ovs-vswitchd log file indicates that a feature is not
- supported, consider upgrading to a newer upstream Linux release or using
- the kernel module paired with the userspace distribution.
-
-Q: Why do tunnels not work when using a kernel module other than the one
-packaged with Open vSwitch?
-
- A: Support for tunnels was added to the upstream Linux kernel module after
- the rest of Open vSwitch. As a result, some kernels may contain support for
- Open vSwitch but not tunnels. The minimum kernel version that supports each
- tunnel protocol is:
-
- ======== ============
- Protocol Linux Kernel
- ======== ============
- GRE 3.11
- VXLAN 3.12
- Geneve 3.18
- ERSPAN 4.18
- LISP not upstream
- STT not upstream
- ======== ============
-
- If you are using a version of the kernel that is older than the one listed
- above, it is still possible to use that tunnel protocol. However, you must
- compile and install the kernel module included with the Open vSwitch
- distribution rather than the one on your machine. If problems persist after
- doing this, check to make sure that the module that is loaded is the one
- you expect.
-
-Q: Why are UDP tunnel checksums not computed for VXLAN or Geneve?
-
- A: Generating outer UDP checksums requires kernel support that was not part
- of the initial implementation of these protocols. If using the upstream
- Linux Open vSwitch module, you must use kernel 4.0 or newer. The
- out-of-tree modules from Open vSwitch release 2.4 and later support UDP
- checksums.
-
-Q: What features are not available when using the userspace datapath?
-
- A: Tunnel virtual ports are not supported, as described in the previous
- answer. It is also not possible to use queue-related actions. On Linux
- kernels before 2.6.39, maximum-sized VLAN packets may not be transmitted.
-
-Q: Should userspace or kernel be upgraded first to minimize downtime?
-
- A. In general, the Open vSwitch userspace should be used with the kernel
- version included in the same release or with the version from upstream
- Linux. However, when upgrading between two releases of Open vSwitch it is
- best to migrate userspace first to reduce the possibility of
- incompatibilities.
-
-Q: What happened to the bridge compatibility feature?
-
- A: Bridge compatibility was a feature of Open vSwitch 1.9 and earlier.
- When it was enabled, Open vSwitch imitated the interface of the Linux
- kernel "bridge" module. This allowed users to drop Open vSwitch into
- environments designed to use the Linux kernel bridge module without
- adapting the environment to use Open vSwitch.
-
- Open vSwitch 1.10 and later do not support bridge compatibility. The
- feature was dropped because version 1.10 adopted a new internal
- architecture that made bridge compatibility difficult to maintain. Now
- that many environments use OVS directly, it would be rarely useful in any
- case.
-
- To use bridge compatibility, install OVS 1.9 or earlier, including the
- accompanying kernel modules (both the main and bridge compatibility
- modules), following the instructions that come with the release. Be sure
- to start the ovs-brcompatd daemon.
diff --git a/Documentation/faq/terminology.rst b/Documentation/faq/terminology.rst
deleted file mode 100644
index 1b34304e3..000000000
--- a/Documentation/faq/terminology.rst
+++ /dev/null
@@ -1,37 +0,0 @@
-..
- Licensed under the Apache License, Version 2.0 (the "License"); you may
- not use this file except in compliance with the License. You may obtain
- a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
- WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
- License for the specific language governing permissions and limitations
- under the License.
-
- Convention for heading levels in Open vSwitch documentation:
-
- ======= Heading 0 (reserved for the title in a document)
- ------- Heading 1
- ~~~~~~~ Heading 2
- +++++++ Heading 3
- ''''''' Heading 4
-
- Avoid deeper levels because they do not render well.
-
-===========
-Terminology
-===========
-
-Q: I thought Open vSwitch was a virtual Ethernet switch, but the documentation
-keeps talking about bridges. What's a bridge?
-
- A: In networking, the terms "bridge" and "switch" are synonyms. Open
- vSwitch implements an Ethernet switch, which means that it is also an
- Ethernet bridge.
-
-Q: What's a VLAN?
-
- A: See :doc:`vlan`.
diff --git a/Documentation/faq/vlan.rst b/Documentation/faq/vlan.rst
deleted file mode 100644
index 80e6660f5..000000000
--- a/Documentation/faq/vlan.rst
+++ /dev/null
@@ -1,285 +0,0 @@
-..
- Licensed under the Apache License, Version 2.0 (the "License"); you may
- not use this file except in compliance with the License. You may obtain
- a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
- WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
- License for the specific language governing permissions and limitations
- under the License.
-
- Convention for heading levels in Open vSwitch documentation:
-
- ======= Heading 0 (reserved for the title in a document)
- ------- Heading 1
- ~~~~~~~ Heading 2
- +++++++ Heading 3
- ''''''' Heading 4
-
- Avoid deeper levels because they do not render well.
-
-=====
-VLANs
-=====
-
-Q: What's a VLAN?
-
- A: At the simplest level, a VLAN (short for "virtual LAN") is a way to
- partition a single switch into multiple switches. Suppose, for example,
- that you have two groups of machines, group A and group B. You want the
- machines in group A to be able to talk to each other, and you want the
- machine in group B to be able to talk to each other, but you don't want the
- machines in group A to be able to talk to the machines in group B. You can
- do this with two switches, by plugging the machines in group A into one
- switch and the machines in group B into the other switch.
-
- If you only have one switch, then you can use VLANs to do the same thing,
- by configuring the ports for machines in group A as VLAN "access ports" for
- one VLAN and the ports for group B as "access ports" for a different VLAN.
- The switch will only forward packets between ports that are assigned to the
- same VLAN, so this effectively subdivides your single switch into two
- independent switches, one for each group of machines.
-
- So far we haven't said anything about VLAN headers. With access ports,
- like we've described so far, no VLAN header is present in the Ethernet
- frame. This means that the machines (or switches) connected to access
- ports need not be aware that VLANs are involved, just like in the case
- where we use two different physical switches.
-
- Now suppose that you have a whole bunch of switches in your network,
- instead of just one, and that some machines in group A are connected
- directly to both switches 1 and 2. To allow these machines to talk to each
- other, you could add an access port for group A's VLAN to switch 1 and
- another to switch 2, and then connect an Ethernet cable between those
- ports. That works fine, but it doesn't scale well as the number of
- switches and the number of VLANs increases, because you use up a lot of
- valuable switch ports just connecting together your VLANs.
-
- This is where VLAN headers come in. Instead of using one cable and two
- ports per VLAN to connect a pair of switches, we configure a port on each
- switch as a VLAN "trunk port". Packets sent and received on a trunk port
- carry a VLAN header that says what VLAN the packet belongs to, so that only
- two ports total are required to connect the switches, regardless of the
- number of VLANs in use. Normally, only switches (either physical or
- virtual) are connected to a trunk port, not individual hosts, because
- individual hosts don't expect to see a VLAN header in the traffic that they
- receive.
-
- None of the above discussion says anything about particular VLAN numbers.
- This is because VLAN numbers are completely arbitrary. One must only
- ensure that a given VLAN is numbered consistently throughout a network and
- that different VLANs are given different numbers. (That said, VLAN 0 is
- usually synonymous with a packet that has no VLAN header, and VLAN 4095 is
- reserved.)
-
-Q: VLANs don't work.
-
- A: Many drivers in Linux kernels before version 3.3 had VLAN-related bugs.
- If you are having problems with VLANs that you suspect to be driver
- related, then you have several options:
-
- - Upgrade to Linux 3.3 or later.
-
- - Build and install a fixed version of the particular driver that is
- causing trouble, if one is available.
-
- - Use a NIC whose driver does not have VLAN problems.
-
- - Use "VLAN splinters", a feature in Open vSwitch 1.4 upto 2.5 that works
- around bugs in kernel drivers. To enable VLAN splinters on interface
- eth0, use the command::
-
- $ ovs-vsctl set interface eth0 other-config:enable-vlan-splinters=true
-
- For VLAN splinters to be effective, Open vSwitch must know which VLANs
- are in use. See the "VLAN splinters" section in the Interface table in
- ovs-vswitchd.conf.db(5) for details on how Open vSwitch infers in-use
- VLANs.
-
- VLAN splinters increase memory use and reduce performance, so use them
- only if needed.
-
- - Apply the "vlan workaround" patch from the XenServer kernel patch queue,
- build Open vSwitch against this patched kernel, and then use
- ovs-vlan-bug-workaround(8) to enable the VLAN workaround for each
- interface whose driver is buggy.
-
- (This is a nontrivial exercise, so this option is included only for
- completeness.)
-
- It is not always easy to tell whether a Linux kernel driver has buggy VLAN
- support. The ovs-vlan-test(8) and ovs-test(8) utilities can help you test.
- See their manpages for details. Of the two utilities, ovs-test(8) is newer
- and more thorough, but ovs-vlan-test(8) may be easier to use.
-
-Q: VLANs still don't work. I've tested the driver so I know that it's OK.
-
- A: Do you have VLANs enabled on the physical switch that OVS is attached
- to? Make sure that the port is configured to trunk the VLAN or VLANs that
- you are using with OVS.
-
-Q: Outgoing VLAN-tagged traffic goes through OVS to my physical switch
-and to its destination host, but OVS seems to drop incoming return
-traffic.
-
- A: It's possible that you have the VLAN configured on your physical switch
- as the "native" VLAN. In this mode, the switch treats incoming packets
- either tagged with the native VLAN or untagged as part of the native VLAN.
- It may also send outgoing packets in the native VLAN without a VLAN tag.
-
- If this is the case, you have two choices:
-
- - Change the physical switch port configuration to tag packets it forwards
- to OVS with the native VLAN instead of forwarding them untagged.
-
- - Change the OVS configuration for the physical port to a native VLAN mode.
- For example, the following sets up a bridge with port eth0 in
- "native-tagged" mode in VLAN 9::
-
- $ ovs-vsctl add-br br0 $ ovs-vsctl add-port br0 eth0 tag=9
- vlan_mode=native-tagged
-
- In this situation, "native-untagged" mode will probably work equally
- well. Refer to the documentation for the Port table in
- ovs-vswitchd.conf.db(5) for more information.
-
-Q: I added a pair of VMs on different VLANs, like this::
-
- $ ovs-vsctl add-br br0
- $ ovs-vsctl add-port br0 eth0
- $ ovs-vsctl add-port br0 tap0 tag=9
- $ ovs-vsctl add-port br0 tap1 tag=10
-
-but the VMs can't access each other, the external network, or the Internet.
-
- A: It is to be expected that the VMs can't access each other. VLANs are a
- means to partition a network. When you configured tap0 and tap1 as access
- ports for different VLANs, you indicated that they should be isolated from
- each other.
-
- As for the external network and the Internet, it seems likely that the
- machines you are trying to access are not on VLAN 9 (or 10) and that the
- Internet is not available on VLAN 9 (or 10).
-
-Q: I added a pair of VMs on the same VLAN, like this::
-
- $ ovs-vsctl add-br br0
- $ ovs-vsctl add-port br0 eth0
- $ ovs-vsctl add-port br0 tap0 tag=9
- $ ovs-vsctl add-port br0 tap1 tag=9
-
-The VMs can access each other, but not the external network or the Internet.
-
- A: It seems likely that the machines you are trying to access in the
- external network are not on VLAN 9 and that the Internet is not available
- on VLAN 9. Also, ensure VLAN 9 is set up as an allowed trunk VLAN on the
- upstream switch port to which eth0 is connected.
-
-Q: Can I configure an IP address on a VLAN?
-
- A: Yes. Use an "internal port" configured as an access port. For example,
- the following configures IP address 192.168.0.7 on VLAN 9. That is, OVS
- will forward packets from eth0 to 192.168.0.7 only if they have an 802.1Q
- header with VLAN 9. Conversely, traffic forwarded from 192.168.0.7 to eth0
- will be tagged with an 802.1Q header with VLAN 9::
-
- $ ovs-vsctl add-br br0
- $ ovs-vsctl add-port br0 eth0
- $ ovs-vsctl add-port br0 vlan9 tag=9 \
- -- set interface vlan9 type=internal
- $ ip addr add 192.168.0.7/24 dev vlan9
- $ ip link set vlan9 up
-
- See also the following question.
-
-Q: I configured one IP address on VLAN 0 and another on VLAN 9, like this::
-
- $ ovs-vsctl add-br br0
- $ ovs-vsctl add-port br0 eth0
- $ ip addr add 192.168.0.5/24 dev br0
- $ ip link set br0 up
- $ ovs-vsctl add-port br0 vlan9 tag=9 -- set interface vlan9 type=internal
- $ ip addr add 192.168.0.9/24 dev vlan9
- $ ip link set vlan9 up
-
-but other hosts that are only on VLAN 0 can reach the IP address configured on
-VLAN 9. What's going on?
-
- A: `RFC 1122 section 3.3.4.2 "Multihoming Requirements"
- <https://tools.ietf.org/html/rfc1122>`__ describes two approaches to IP
- address handling in Internet hosts:
-
- - In the "Strong ES Model", where an ES is a host ("End System"), an IP
- address is primarily associated with a particular interface. The host
- discards packets that arrive on interface A if they are destined for an
- IP address that is configured on interface B. The host never sends
- packets from interface A using a source address configured on interface
- B.
-
- - In the "Weak ES Model", an IP address is primarily associated with a
- host. The host accepts packets that arrive on any interface if they are
- destined for any of the host's IP addresses, even if the address is
- configured on some interface other than the one on which it arrived. The
- host does not restrict itself to sending packets from an IP address
- associated with the originating interface.
-
- Linux uses the weak ES model. That means that when packets destined to the
- VLAN 9 IP address arrive on eth0 and are bridged to br0, the kernel IP
- stack accepts them there for the VLAN 9 IP address, even though they were
- not received on vlan9, the network device for vlan9.
-
- To simulate the strong ES model on Linux, one may add iptables rule to
- filter packets based on source and destination address and adjust ARP
- configuration with sysctls.
-
- BSD uses the strong ES model.
-
-Q: My OpenFlow controller doesn't see the VLANs that I expect.
-
- A: The configuration for VLANs in the Open vSwitch database (e.g. via
- ovs-vsctl) only affects traffic that goes through Open vSwitch's
- implementation of the OpenFlow "normal switching" action. By default, when
- Open vSwitch isn't connected to a controller and nothing has been manually
- configured in the flow table, all traffic goes through the "normal
- switching" action. But, if you set up OpenFlow flows on your own, through
- a controller or using ovs-ofctl or through other means, then you have to
- implement VLAN handling yourself.
-
- You can use "normal switching" as a component of your OpenFlow actions,
- e.g. by putting "normal" into the lists of actions on ovs-ofctl or by
- outputting to OFPP_NORMAL from an OpenFlow controller. In situations where
- this is not suitable, you can implement VLAN handling yourself, e.g.:
-
- - If a packet comes in on an access port, and the flow table needs to send
- it out on a trunk port, then the flow can add the appropriate VLAN tag
- with the "mod_vlan_vid" action.
-
- - If a packet comes in on a trunk port, and the flow table needs to send it
- out on an access port, then the flow can strip the VLAN tag with the
- "strip_vlan" action.
-
-Q: I configured ports on a bridge as access ports with different VLAN tags,
-like this::
-
- $ ovs-vsctl add-br br0
- $ ovs-vsctl set-controller br0 tcp:192.168.0.10:6653
- $ ovs-vsctl add-port br0 eth0
- $ ovs-vsctl add-port br0 tap0 tag=9
- $ ovs-vsctl add-port br0 tap1 tag=10
-
-but the VMs running behind tap0 and tap1 can still communicate, that is, they
-are not isolated from each other even though they are on different VLANs.
-
- A: Do you have a controller configured on br0 (as the commands above do)?
- If so, then this is a variant on the previous question, "My OpenFlow
- controller doesn't see the VLANs that I expect," and you can refer to the
- answer there for more information.
-
-Q: How MAC learning works with VLANs?
-
- A: Open vSwitch implements Independent VLAN Learning (IVL) for
- ``OFPP_NORMAL`` action, e.g. it logically has separate learning tables for
- each VLANs.
diff --git a/Documentation/faq/vxlan.rst b/Documentation/faq/vxlan.rst
deleted file mode 100644
index c036ffdb0..000000000
--- a/Documentation/faq/vxlan.rst
+++ /dev/null
@@ -1,53 +0,0 @@
-..
- Licensed under the Apache License, Version 2.0 (the "License"); you may
- not use this file except in compliance with the License. You may obtain
- a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
- WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
- License for the specific language governing permissions and limitations
- under the License.
-
- Convention for heading levels in Open vSwitch documentation:
-
- ======= Heading 0 (reserved for the title in a document)
- ------- Heading 1
- ~~~~~~~ Heading 2
- +++++++ Heading 3
- ''''''' Heading 4
-
- Avoid deeper levels because they do not render well.
-
-======
-VXLANs
-======
-
-Q: What's a VXLAN?
-
- A: VXLAN stands for Virtual eXtensible Local Area Network, and is a means
- to solve the scaling challenges of VLAN networks in a multi-tenant
- environment. VXLAN is an overlay network which transports an L2 network
- over an existing L3 network. For more information on VXLAN, please see `RFC
- 7348 <https://tools.ietf.org/html/rfc7348>`__.
-
-Q: How much of the VXLAN protocol does Open vSwitch currently support?
-
- A: Open vSwitch currently supports the framing format for packets on the
- wire. There is currently no support for the multicast aspects of VXLAN. To
- get around the lack of multicast support, it is possible to pre-provision
- MAC to IP address mappings either manually or from a controller.
-
-Q: What destination UDP port does the VXLAN implementation in Open vSwitch
-use?
-
- A: By default, Open vSwitch will use the assigned IANA port for VXLAN,
- which is 4789. However, it is possible to configure the destination UDP
- port manually on a per-VXLAN tunnel basis. An example of this configuration
- is provided below.::
-
- $ ovs-vsctl add-br br0
- $ ovs-vsctl add-port br0 vxlan1 -- set interface vxlan1 type=vxlan \
- options:remote_ip=192.168.1.2 options:key=flow options:dst_port=8472
diff --git a/Documentation/howto/dpdk.rst b/Documentation/howto/dpdk.rst
deleted file mode 100644
index 6397d25f1..000000000
--- a/Documentation/howto/dpdk.rst
+++ /dev/null
@@ -1,394 +0,0 @@
-..
- Licensed under the Apache License, Version 2.0 (the "License"); you may
- not use this file except in compliance with the License. You may obtain
- a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
- WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
- License for the specific language governing permissions and limitations
- under the License.
-
- Convention for heading levels in Open vSwitch documentation:
-
- ======= Heading 0 (reserved for the title in a document)
- ------- Heading 1
- ~~~~~~~ Heading 2
- +++++++ Heading 3
- ''''''' Heading 4
-
- Avoid deeper levels because they do not render well.
-
-============================
-Using Open vSwitch with DPDK
-============================
-
-This document describes how to use Open vSwitch with DPDK datapath.
-
-.. 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`.
-
-Ports and Bridges
------------------
-
-ovs-vsctl can be used to set up bridges and other Open vSwitch features.
-Bridges should be created with a ``datapath_type=netdev``::
-
- $ ovs-vsctl add-br br0 -- set bridge br0 datapath_type=netdev
-
-ovs-vsctl can also be used to add DPDK devices. ovs-vswitchd should print the
-number of dpdk devices found in the log file::
-
- $ ovs-vsctl add-port br0 dpdk-p0 -- set Interface dpdk-p0 type=dpdk \
- options:dpdk-devargs=0000:01:00.0
- $ ovs-vsctl add-port br0 dpdk-p1 -- set Interface dpdk-p1 type=dpdk \
- options:dpdk-devargs=0000:01:00.1
-
-Some NICs (i.e. Mellanox ConnectX-3) have only one PCI address associated with
-multiple ports. Using a PCI device like above won't work. Instead, below usage
-is suggested::
-
- $ ovs-vsctl add-port br0 dpdk-p0 -- set Interface dpdk-p0 type=dpdk \
- options:dpdk-devargs="class=eth,mac=00:11:22:33:44:55"
- $ ovs-vsctl add-port br0 dpdk-p1 -- set Interface dpdk-p1 type=dpdk \
- options:dpdk-devargs="class=eth,mac=00:11:22:33:44:56"
-
-.. important::
-
- Hotplugging physical interfaces is not supported using the above syntax.
- This is expected to change with the release of DPDK v18.05. For information
- on hotplugging physical interfaces, you should instead refer to
- :ref:`port-hotplug`.
-
-After the DPDK ports get added to switch, a polling thread continuously polls
-DPDK devices and consumes 100% of the core, as can be checked from ``top`` and
-``ps`` commands::
-
- $ top -H
- $ ps -eLo pid,psr,comm | grep pmd
-
-Creating bonds of DPDK interfaces is slightly different to creating bonds of
-system interfaces. For DPDK, the interface type and devargs must be explicitly
-set. For example::
-
- $ ovs-vsctl add-bond br0 dpdkbond p0 p1 \
- -- set Interface p0 type=dpdk options:dpdk-devargs=0000:01:00.0 \
- -- set Interface p1 type=dpdk options:dpdk-devargs=0000:01:00.1
-
-To stop ovs-vswitchd & delete bridge, run::
-
- $ ovs-appctl -t ovs-vswitchd exit
- $ ovs-appctl -t ovsdb-server exit
- $ ovs-vsctl del-br br0
-
-.. _dpdk-ovs-in-guest:
-
-OVS with DPDK Inside VMs
-------------------------
-
-Additional configuration is required if you want to run ovs-vswitchd with DPDK
-backend inside a QEMU virtual machine. ovs-vswitchd creates separate DPDK TX
-queues for each CPU core available. This operation fails inside QEMU virtual
-machine because, by default, VirtIO NIC provided to the guest is configured to
-support only single TX queue and single RX queue. To change this behavior, you
-need to turn on ``mq`` (multiqueue) property of all ``virtio-net-pci`` devices
-emulated by QEMU and used by DPDK. You may do it manually (by changing QEMU
-command line) or, if you use Libvirt, by adding the following string to
-``<interface>`` sections of all network devices used by DPDK::
-
- <driver name='vhost' queues='N'/>
-
-where:
-
-``N``
- determines how many queues can be used by the guest.
-
-This requires QEMU >= 2.2.
-
-.. _dpdk-phy-phy:
-
-PHY-PHY
--------
-
-Add a userspace bridge and two ``dpdk`` (PHY) ports::
-
- # Add userspace bridge
- $ ovs-vsctl add-br br0 -- set bridge br0 datapath_type=netdev
-
- # Add two dpdk ports
- $ ovs-vsctl add-port br0 phy0 -- set Interface phy0 type=dpdk \
- options:dpdk-devargs=0000:01:00.0 ofport_request=1
-
- $ ovs-vsctl add-port br0 phy1 -- set Interface phy1 type=dpdk
- options:dpdk-devargs=0000:01:00.1 ofport_request=2
-
-Add test flows to forward packets between DPDK port 0 and port 1::
-
- # Clear current flows
- $ ovs-ofctl del-flows br0
-
- # Add flows between port 1 (phy0) to port 2 (phy1)
- $ ovs-ofctl add-flow br0 in_port=1,action=output:2
- $ ovs-ofctl add-flow br0 in_port=2,action=output:1
-
-Transmit traffic into either port. You should see it returned via the other.
-
-.. _dpdk-vhost-loopback:
-
-PHY-VM-PHY (vHost Loopback)
----------------------------
-
-Add a userspace bridge, two ``dpdk`` (PHY) ports, and two ``dpdkvhostuser``
-ports::
-
- # Add userspace bridge
- $ ovs-vsctl add-br br0 -- set bridge br0 datapath_type=netdev
-
- # Add two dpdk ports
- $ ovs-vsctl add-port br0 phy0 -- set Interface phy0 type=dpdk \
- options:dpdk-devargs=0000:01:00.0 ofport_request=1
-
- $ ovs-vsctl add-port br0 phy1 -- set Interface phy1 type=dpdk
- options:dpdk-devargs=0000:01:00.1 ofport_request=2
-
- # Add two dpdkvhostuser ports
- $ ovs-vsctl add-port br0 dpdkvhostuser0 \
- -- set Interface dpdkvhostuser0 type=dpdkvhostuser ofport_request=3
- $ ovs-vsctl add-port br0 dpdkvhostuser1 \
- -- set Interface dpdkvhostuser1 type=dpdkvhostuser ofport_request=4
-
-Add test flows to forward packets between DPDK devices and VM ports::
-
- # Clear current flows
- $ ovs-ofctl del-flows br0
-
- # Add flows
- $ ovs-ofctl add-flow br0 in_port=1,action=output:3
- $ ovs-ofctl add-flow br0 in_port=3,action=output:1
- $ ovs-ofctl add-flow br0 in_port=4,action=output:2
- $ ovs-ofctl add-flow br0 in_port=2,action=output:4
-
- # Dump flows
- $ ovs-ofctl dump-flows br0
-
-Create a VM using the following configuration:
-
-.. table::
-
- ===================== ======== ============
- Configuration Values Comments
- ===================== ======== ============
- QEMU version 2.2.0 n/a
- QEMU thread affinity core 5 taskset 0x20
- Memory 4GB n/a
- Cores 2 n/a
- Qcow2 image CentOS7 n/a
- mrg_rxbuf off n/a
- ===================== ======== ============
-
-You can do this directly with QEMU via the ``qemu-system-x86_64`` application::
-
- $ export VM_NAME=vhost-vm
- $ export GUEST_MEM=3072M
- $ export QCOW2_IMAGE=/root/CentOS7_x86_64.qcow2
- $ export VHOST_SOCK_DIR=/usr/local/var/run/openvswitch
-
- $ taskset 0x20 qemu-system-x86_64 -name $VM_NAME -cpu host -enable-kvm \
- -m $GUEST_MEM -drive file=$QCOW2_IMAGE --nographic -snapshot \
- -numa node,memdev=mem -mem-prealloc -smp sockets=1,cores=2 \
- -object memory-backend-file,id=mem,size=$GUEST_MEM,mem-path=/dev/hugepages,share=on \
- -chardev socket,id=char0,path=$VHOST_SOCK_DIR/dpdkvhostuser0 \
- -netdev type=vhost-user,id=mynet1,chardev=char0,vhostforce \
- -device virtio-net-pci,mac=00:00:00:00:00:01,netdev=mynet1,mrg_rxbuf=off \
- -chardev socket,id=char1,path=$VHOST_SOCK_DIR/dpdkvhostuser1 \
- -netdev type=vhost-user,id=mynet2,chardev=char1,vhostforce \
- -device virtio-net-pci,mac=00:00:00:00:00:02,netdev=mynet2,mrg_rxbuf=off
-
-For a explanation of this command, along with alternative approaches such as
-booting the VM via libvirt, refer to :doc:`/topics/dpdk/vhost-user`.
-
-Once the guest is configured and booted, configure DPDK packet forwarding
-within the guest. To accomplish this, build the ``testpmd`` application as
-described in :ref:`dpdk-testpmd`. Once compiled, run the application::
-
- $ cd $DPDK_DIR/app/test-pmd;
- $ ./testpmd -c 0x3 -n 4 --socket-mem 1024 -- \
- --burst=64 -i --txqflags=0xf00 --disable-hw-vlan
- $ set fwd mac retry
- $ start
-
-When you finish testing, bind the vNICs back to kernel::
-
- $ $DPDK_DIR/usertools/dpdk-devbind.py --bind=virtio-pci 0000:00:03.0
- $ $DPDK_DIR/usertools/dpdk-devbind.py --bind=virtio-pci 0000:00:04.0
-
-.. note::
-
- Valid PCI IDs must be passed in above example. The PCI IDs can be retrieved
- like so::
-
- $ $DPDK_DIR/usertools/dpdk-devbind.py --status
-
-More information on the dpdkvhostuser ports can be found in
-:doc:`/topics/dpdk/vhost-user`.
-
-PHY-VM-PHY (vHost Loopback) (Kernel Forwarding)
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-:ref:`dpdk-vhost-loopback` details steps for PHY-VM-PHY loopback
-testcase and packet forwarding using DPDK testpmd application in the Guest VM.
-For users wishing to do packet forwarding using kernel stack below, you need to
-run the below commands on the guest::
-
- $ ip addr add 1.1.1.2/24 dev eth1
- $ ip addr add 1.1.2.2/24 dev eth2
- $ ip link set eth1 up
- $ ip link set eth2 up
- $ systemctl stop firewalld.service
- $ systemctl stop iptables.service
- $ sysctl -w net.ipv4.ip_forward=1
- $ sysctl -w net.ipv4.conf.all.rp_filter=0
- $ sysctl -w net.ipv4.conf.eth1.rp_filter=0
- $ sysctl -w net.ipv4.conf.eth2.rp_filter=0
- $ route add -net 1.1.2.0/24 eth2
- $ route add -net 1.1.1.0/24 eth1
- $ arp -s 1.1.2.99 DE:AD:BE:EF:CA:FE
- $ arp -s 1.1.1.99 DE:AD:BE:EF:CA:EE
-
-PHY-VM-PHY (vHost Multiqueue)
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-vHost Multiqueue functionality can also be validated using the PHY-VM-PHY
-configuration. To begin, follow the steps described in :ref:`dpdk-phy-phy` to
-create and initialize the database, start ovs-vswitchd and add ``dpdk``-type
-devices to bridge ``br0``. Once complete, follow the below steps:
-
-1. Configure PMD and RXQs.
-
- For example, set the number of dpdk port rx queues to at least 2 The number
- of rx queues at vhost-user interface gets automatically configured after
- virtio device connection and doesn't need manual configuration::
-
- $ ovs-vsctl set Open_vSwitch . other_config:pmd-cpu-mask=0xc
- $ ovs-vsctl set Interface phy0 options:n_rxq=2
- $ ovs-vsctl set Interface phy1 options:n_rxq=2
-
-2. Instantiate Guest VM using QEMU cmdline
-
- We must configure with appropriate software versions to ensure this feature
- is supported.
-
- .. list-table:: VM Configuration
- :header-rows: 1
-
- * - Setting
- - Value
- * - QEMU version
- - 2.5.0
- * - QEMU thread affinity
- - 2 cores (taskset 0x30)
- * - Memory
- - 4 GB
- * - Cores
- - 2
- * - Distro
- - Fedora 22
- * - Multiqueue
- - Enabled
-
- To do this, instantiate the guest as follows::
-
- $ export VM_NAME=vhost-vm
- $ export GUEST_MEM=4096M
- $ export QCOW2_IMAGE=/root/Fedora22_x86_64.qcow2
- $ export VHOST_SOCK_DIR=/usr/local/var/run/openvswitch
- $ taskset 0x30 qemu-system-x86_64 -cpu host -smp 2,cores=2 -m 4096M \
- -drive file=$QCOW2_IMAGE --enable-kvm -name $VM_NAME \
- -nographic -numa node,memdev=mem -mem-prealloc \
- -object memory-backend-file,id=mem,size=$GUEST_MEM,mem-path=/dev/hugepages,share=on \
- -chardev socket,id=char1,path=$VHOST_SOCK_DIR/dpdkvhostuser0 \
- -netdev type=vhost-user,id=mynet1,chardev=char1,vhostforce,queues=2 \
- -device virtio-net-pci,mac=00:00:00:00:00:01,netdev=mynet1,mq=on,vectors=6 \
- -chardev socket,id=char2,path=$VHOST_SOCK_DIR/dpdkvhostuser1 \
- -netdev type=vhost-user,id=mynet2,chardev=char2,vhostforce,queues=2 \
- -device virtio-net-pci,mac=00:00:00:00:00:02,netdev=mynet2,mq=on,vectors=6
-
- .. note::
- Queue value above should match the queues configured in OVS, The vector
- value should be set to "number of queues x 2 + 2"
-
-3. Configure the guest interface
-
- Assuming there are 2 interfaces in the guest named eth0, eth1 check the
- channel configuration and set the number of combined channels to 2 for
- virtio devices::
-
- $ ethtool -l eth0
- $ ethtool -L eth0 combined 2
- $ ethtool -L eth1 combined 2
-
- More information can be found in vHost walkthrough section.
-
-4. Configure kernel packet forwarding
-
- Configure IP and enable interfaces::
-
- $ ip addr add 5.5.5.1/24 dev eth0
- $ ip addr add 90.90.90.1/24 dev eth1
- $ ip link set eth0 up
- $ ip link set eth1 up
-
- Configure IP forwarding and add route entries::
-
- $ sysctl -w net.ipv4.ip_forward=1
- $ sysctl -w net.ipv4.conf.all.rp_filter=0
- $ sysctl -w net.ipv4.conf.eth0.rp_filter=0
- $ sysctl -w net.ipv4.conf.eth1.rp_filter=0
- $ ip route add 2.1.1.0/24 dev eth1
- $ route add default gw 2.1.1.2 eth1
- $ route add default gw 90.90.90.90 eth1
- $ arp -s 90.90.90.90 DE:AD:BE:EF:CA:FE
- $ arp -s 2.1.1.2 DE:AD:BE:EF:CA:FA
-
- Check traffic on multiple queues::
-
- $ cat /proc/interrupts | grep virtio
-
-.. _dpdk-flow-hardware-offload:
-
-Flow Hardware Offload (Experimental)
-------------------------------------
-
-The flow hardware offload is disabled by default and can be enabled by::
-
- $ ovs-vsctl set Open_vSwitch . other_config:hw-offload=true
-
-So far only partial flow offload is implemented. Moreover, it only works
-with PMD drivers have the rte_flow action "MARK + RSS" support.
-
-The validated NICs are:
-
-- Mellanox (ConnectX-4, ConnectX-4 Lx, ConnectX-5)
-- Napatech (NT200B01)
-
-Supported protocols for hardware offload are:
-- L2: Ethernet, VLAN
-- L3: IPv4, IPv6
-- L4: TCP, UDP, SCTP, ICMP
-
-Further Reading
----------------
-
-More detailed information can be found in the :doc:`DPDK topics section
-</topics/dpdk/index>` of the documentation. These guides are listed below.
-
-.. NOTE(stephenfin): Remember to keep this in sync with topics/dpdk/index
-
-.. include:: ../topics/dpdk/index.rst
- :start-line: 30
diff --git a/Documentation/howto/index.rst b/Documentation/howto/index.rst
index 9a3487be3..2a1a09188 100644
--- a/Documentation/howto/index.rst
+++ b/Documentation/howto/index.rst
@@ -43,12 +43,10 @@ OVS
ssl
lisp
tunneling
- userspace-tunneling
vlan
qos
vtep
sflow
- dpdk
OVN
---
diff --git a/Documentation/howto/userspace-tunneling.rst b/Documentation/howto/userspace-tunneling.rst
deleted file mode 100644
index d0a767bbc..000000000
--- a/Documentation/howto/userspace-tunneling.rst
+++ /dev/null
@@ -1,248 +0,0 @@
-..
- Licensed under the Apache License, Version 2.0 (the "License"); you may
- not use this file except in compliance with the License. You may obtain
- a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
- WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
- License for the specific language governing permissions and limitations
- under the License.
-
- Convention for heading levels in Open vSwitch documentation:
-
- ======= Heading 0 (reserved for the title in a document)
- ------- Heading 1
- ~~~~~~~ Heading 2
- +++++++ Heading 3
- ''''''' Heading 4
-
- Avoid deeper levels because they do not render well.
-
-========================================
-Connecting VMs Using Tunnels (Userspace)
-========================================
-
-This document describes how to use Open vSwitch to allow VMs on two different
-hosts to communicate over VXLAN tunnels. Unlike :doc:`tunneling`, this
-configuration works entirely in userspace.
-
-.. note::
-
- This guide covers the steps required to configure VXLAN tunneling. The same
- approach can be used for any of the other tunneling protocols supported by
- Open vSwitch.
-
-.. TODO(stephenfin): Convert this to a (prettier) PNG with same styling as the
- rest of the document
-
-::
-
- +--------------+
- | vm0 | 192.168.1.1/24
- +--------------+
- (vm_port0)
- |
- |
- |
- +--------------+
- | br-int | 192.168.1.2/24
- +--------------+ +--------------+
- | vxlan0 | | vxlan0 |
- +--------------+ +--------------+
- | |
- | |
- | |
- 172.168.1.1/24 |
- +--------------+ |
- | br-phy | 172.168.1.2/24
- +--------------+ +---------------+
- | dpdk0/eth1 |----------------------------------| eth1 |
- +--------------+ +---------------+
- Host A with OVS. Remote host.
-
-Setup
------
-
-This guide assumes the environment is configured as described below.
-
-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.
-
-Configuration Steps
--------------------
-
-Perform the following configuration on `host1`:
-
-#. Create a ``br-int`` bridge::
-
- $ ovs-vsctl --may-exist add-br br-int \
- -- set Bridge br-int datapath_type=netdev \
- -- br-set-external-id br-int bridge-id br-int \
- -- set bridge br-int fail-mode=standalone
-
-#. Add a port to this bridge. If using tap ports, first boot a VM and then add
- the port to the bridge::
-
- $ ovs-vsctl add-port br-int tap0
-
- If using DPDK vhost-user ports, add the port and then boot the VM
- accordingly, using ``vm_port0`` as the interface name::
-
- $ ovs-vsctl add-port br-int vm_port0 \
- -- set Interface vm_port0 type=dpdkvhostuser
-
-#. Configure the IP address of the VM interface *in the VM itself*::
-
- $ ip addr add 192.168.1.1/24 dev eth0
- $ ip link set eth0 up
-
-#. On `host1`, add a port for the VXLAN tunnel::
-
- $ ovs-vsctl add-port br-int vxlan0 \
- -- set interface vxlan0 type=vxlan options:remote_ip=172.168.1.2
-
- .. note::
-
- ``172.168.1.2`` is the remote tunnel end point address. On the remote
- host this will be ``172.168.1.1``
-
-#. Create a ``br-phy`` bridge::
-
- $ ovs-vsctl --may-exist add-br br-phy \
- -- set Bridge br-phy datapath_type=netdev \
- -- br-set-external-id br-phy bridge-id br-phy \
- -- set bridge br-phy fail-mode=standalone \
- other_config:hwaddr=<mac address of eth1 interface>
-
- .. note::
-
- This additional bridge is required when running Open vSwitch in userspace
- rather than kernel-based Open vSwitch. The purpose of this bridge is to
- allow use of the kernel network stack for routing and ARP resolution.
- The datapath needs to look-up the routing table and ARP table to prepare
- the tunnel header and transmit data to the output port.
-
- .. note::
-
- ``eth1`` is used rather than ``eth0``. This is to ensure network
- connectivity is retained.
-
-#. Attach ``eth1``/``dpdk0`` to the ``br-phy`` bridge.
-
- If the physical port ``eth1`` is operating as a kernel network interface,
- run::
-
- $ ovs-vsctl --timeout 10 add-port br-phy eth1
- $ ip addr add 172.168.1.1/24 dev br-phy
- $ ip link set br-phy up
- $ ip addr flush dev eth1 2>/dev/null
- $ ip link set eth1 up
- $ iptables -F
-
- If instead the interface is a DPDK interface and bound to the ``igb_uio`` or
- ``vfio`` driver, run::
-
- $ ovs-vsctl --timeout 10 add-port br-phy dpdk0 \
- -- set Interface dpdk0 type=dpdk options:dpdk-devargs=0000:06:00.0
- $ ip addr add 172.168.1.1/24 dev br-phy
- $ ip link set br-phy up
- $ iptables -F
-
- The commands are different as DPDK interfaces are not managed by the kernel,
- thus, the port details are not visible to any ``ip`` commands.
-
- .. important::
-
- Attempting to use the kernel network commands for a DPDK interface will
- result in a loss of connectivity through ``eth1``. Refer to
- :doc:`/faq/configuration` for more details.
-
-Once complete, check the cached routes using ovs-appctl command::
-
- $ ovs-appctl ovs/route/show
-
-If the tunnel route is missing, adding it now::
-
- $ ovs-appctl ovs/route/add 172.168.1.1/24 br-eth1
-
-Repeat these steps if necessary for `host2`, but using ``192.168.1.1`` and
-``172.168.1.2`` for the VM and tunnel interface IP addresses, respectively.
-
-Testing
--------
-
-With this setup, ping to VXLAN target device (``192.168.1.2``) should work.
-Traffic will be VXLAN encapsulated and sent over the ``eth1``/``dpdk0``
-interface.
-
-Tunneling-related Commands
---------------------------
-
-Tunnel routing table
-~~~~~~~~~~~~~~~~~~~~
-
-To add route::
-
- $ ovs-appctl ovs/route/add <IP address>/<prefix length> <output-bridge-name> <gw>
-
-To see all routes configured::
-
- $ ovs-appctl ovs/route/show
-
-To delete route::
-
- $ ovs-appctl ovs/route/del <IP address>/<prefix length>
-
-To look up and display the route for a destination::
-
- $ ovs-appctl ovs/route/lookup <IP address>
-
-ARP
-~~~
-
-To see arp cache content::
-
- $ ovs-appctl tnl/arp/show
-
-To flush arp cache::
-
- $ ovs-appctl tnl/arp/flush
-
-To set a specific arp entry::
-
- $ ovs-appctl tnl/arp/set <bridge> <IP address> <MAC address>
-
-Ports
-~~~~~
-
-To check tunnel ports listening in ovs-vswitchd::
-
- $ ovs-appctl tnl/ports/show
-
-To set range for VxLan UDP source port::
-
- $ ovs-appctl tnl/egress_port_range <num1> <num2>
-
-To show current range::
-
- $ ovs-appctl tnl/egress_port_range
-
-Datapath
-~~~~~~~~
-
-To check datapath ports::
-
- $ ovs-appctl dpif/show
-
-To check datapath flows::
-
- $ ovs-appctl dpif/dump-flows
diff --git a/Documentation/index.rst b/Documentation/index.rst
index 46261235c..a0da2a6d6 100644
--- a/Documentation/index.rst
+++ b/Documentation/index.rst
@@ -57,9 +57,7 @@ vSwitch? Start here.
:doc:`intro/install/userspace` |
:doc:`intro/install/netbsd` |
:doc:`intro/install/windows` |
- :doc:`intro/install/xenserver` |
- :doc:`intro/install/dpdk` |
- :doc:`Installation FAQs <faq/releases>`
+ :doc:`intro/install/xenserver`
- **Tutorials:** :doc:`tutorials/faucet` |
:doc:`tutorials/ovs-advanced` |
@@ -78,9 +76,6 @@ Deeper Dive
:doc:`topics/integration` |
:doc:`topics/porting`
-- **DPDK** :doc:`howto/dpdk` |
- :doc:`topics/dpdk/vhost-user`
-
- **Windows** :doc:`topics/windows`
- **Integrations:** :doc:`topics/language-bindings`
diff --git a/Documentation/intro/install/dpdk.rst b/Documentation/intro/install/dpdk.rst
deleted file mode 100644
index 344d2b3a6..000000000
--- a/Documentation/intro/install/dpdk.rst
+++ /dev/null
@@ -1,693 +0,0 @@
-..
- Licensed under the Apache License, Version 2.0 (the "License"); you may
- not use this file except in compliance with the License. You may obtain
- a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
- WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
- License for the specific language governing permissions and limitations
- under the License.
-
- Convention for heading levels in Open vSwitch documentation:
-
- ======= Heading 0 (reserved for the title in a document)
- ------- Heading 1
- ~~~~~~~ Heading 2
- +++++++ Heading 3
- ''''''' Heading 4
-
- Avoid deeper levels because they do not render well.
-
-======================
-Open vSwitch with DPDK
-======================
-
-This document describes how to build and install Open vSwitch using a DPDK
-datapath. Open vSwitch can use the DPDK library to operate entirely in
-userspace.
-
-.. important::
-
- The :doc:`releases FAQ </faq/releases>` lists support for the required
- versions of DPDK for each version of Open vSwitch. If building OVS and
- DPDK outside of the master build tree users should consult this list
- first.
-
-Build requirements
-------------------
-
-In addition to the requirements described in :doc:`general`, building Open
-vSwitch with DPDK will require the following:
-
-- DPDK 18.11
-
-- A `DPDK supported NIC`_
-
- Only required when physical ports are in use
-
-- A suitable kernel
-
- On Linux Distros running kernel version >= 3.0, only `IOMMU` needs to enabled
- via the grub cmdline, assuming you are using **VFIO**. For older kernels,
- ensure the kernel is built with ``UIO``, ``HUGETLBFS``,
- ``PROC_PAGE_MONITOR``, ``HPET``, ``HPET_MMAP`` support. If these are not
- present, it will be necessary to upgrade your kernel or build a custom kernel
- with these flags enabled.
-
-Detailed system requirements can be found at `DPDK requirements`_.
-
-.. _DPDK supported NIC: http://dpdk.org/doc/nics
-.. _DPDK requirements: http://dpdk.org/doc/guides/linux_gsg/sys_reqs.html
-
-Installing
-----------
-
-Install DPDK
-~~~~~~~~~~~~
-
-#. Download the `DPDK sources`_, extract the file and set ``DPDK_DIR``::
-
- $ cd /usr/src/
- $ wget http://fast.dpdk.org/rel/dpdk-18.11.tar.xz
- $ tar xf dpdk-18.11.tar.xz
- $ export DPDK_DIR=/usr/src/dpdk-18.11
- $ cd $DPDK_DIR
-
-#. (Optional) Configure DPDK as a shared library
-
- DPDK can be built as either a static library or a shared library. By
- default, it is configured for the former. If you wish to use the latter, set
- ``CONFIG_RTE_BUILD_SHARED_LIB=y`` in ``$DPDK_DIR/config/common_base``.
-
- .. note::
-
- Minor performance loss is expected when using OVS with a shared DPDK
- library compared to a static DPDK library.
-
-#. Configure and install DPDK
-
- Build and install the DPDK library::
-
- $ export DPDK_TARGET=x86_64-native-linuxapp-gcc
- $ export DPDK_BUILD=$DPDK_DIR/$DPDK_TARGET
- $ make install T=$DPDK_TARGET DESTDIR=install
-
-#. (Optional) Export the DPDK shared library location
-
- If DPDK was built as a shared library, export the path to this library for
- use when building OVS::
-
- $ export LD_LIBRARY_PATH=$DPDK_DIR/x86_64-native-linuxapp-gcc/lib
-
-.. _DPDK sources: http://dpdk.org/rel
-
-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``).
-
-.. note::
- This section focuses on generic recipe that suits most cases. For
- distribution specific instructions, refer to one of the more relevant guides.
-
-.. _OVS sources: http://openvswitch.org/releases/
-
-#. Ensure the standard OVS requirements, described in
- :ref:`general-build-reqs`, are installed
-
-#. Bootstrap, if required, as described in :ref:`general-bootstrapping`
-
-#. Configure the package using the ``--with-dpdk`` flag::
-
- $ ./configure --with-dpdk=$DPDK_BUILD
-
- where ``DPDK_BUILD`` is the path to the built DPDK library. This can be
- skipped if DPDK library is installed in its default location.
-
- If no path is provided to ``--with-dpdk``, but a pkg-config configuration
- for libdpdk is available the include paths will be generated via an
- equivalent ``pkg-config --cflags libdpdk``.
-
- .. note::
- While ``--with-dpdk`` is required, you can pass any other configuration
- option described in :ref:`general-configuring`.
-
-#. Build and install OVS, as described in :ref:`general-building`
-
-Additional information can be found in :doc:`general`.
-
-.. note::
- If you are running using the Fedora or Red Hat package, the Open vSwitch
- daemon will run as a non-root user. This implies that you must have a
- working IOMMU. Visit the `RHEL README`__ for additional information.
-
-__ https://github.com/openvswitch/ovs/blob/master/rhel/README.RHEL.rst
-
-Setup
------
-
-Setup Hugepages
-~~~~~~~~~~~~~~~
-
-Allocate a number of 2M Huge pages:
-
-- For persistent allocation of huge pages, write to hugepages.conf file
- in `/etc/sysctl.d`::
-
- $ echo 'vm.nr_hugepages=2048' > /etc/sysctl.d/hugepages.conf
-
-- For run-time allocation of huge pages, use the ``sysctl`` utility::
-
- $ sysctl -w vm.nr_hugepages=N # where N = No. of 2M huge pages
-
-To verify hugepage configuration::
-
- $ grep HugePages_ /proc/meminfo
-
-Mount the hugepages, if not already mounted by default::
-
- $ mount -t hugetlbfs none /dev/hugepages``
-
-.. note::
-
- The amount of hugepage memory required can be affected by various
- aspects of the datapath and device configuration. Refer to
- :doc:`/topics/dpdk/memory` for more details.
-
-.. _dpdk-vfio:
-
-Setup DPDK devices using VFIO
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-VFIO is prefered to the UIO driver when using recent versions of DPDK. VFIO
-support required support from both the kernel and BIOS. For the former, kernel
-version > 3.6 must be used. For the latter, you must enable VT-d in the BIOS
-and ensure this is configured via grub. To ensure VT-d is enabled via the BIOS,
-run::
-
- $ dmesg | grep -e DMAR -e IOMMU
-
-If VT-d is not enabled in the BIOS, enable it now.
-
-To ensure VT-d is enabled in the kernel, run::
-
- $ cat /proc/cmdline | grep iommu=pt
- $ cat /proc/cmdline | grep intel_iommu=on
-
-If VT-d is not enabled in the kernel, enable it now.
-
-Once VT-d is correctly configured, load the required modules and bind the NIC
-to the VFIO driver::
-
- $ modprobe vfio-pci
- $ /usr/bin/chmod a+x /dev/vfio
- $ /usr/bin/chmod 0666 /dev/vfio/*
- $ $DPDK_DIR/usertools/dpdk-devbind.py --bind=vfio-pci eth1
- $ $DPDK_DIR/usertools/dpdk-devbind.py --status
-
-Setup OVS
-~~~~~~~~~
-
-Open vSwitch should be started as described in :doc:`general` with the
-exception of ovs-vswitchd, which requires some special configuration to enable
-DPDK functionality. DPDK configuration arguments can be passed to ovs-vswitchd
-via the ``other_config`` column of the ``Open_vSwitch`` table. At a minimum,
-the ``dpdk-init`` option must be set to either ``true`` or ``try``.
-For example::
-
- $ export PATH=$PATH:/usr/local/share/openvswitch/scripts
- $ export DB_SOCK=/usr/local/var/run/openvswitch/db.sock
- $ ovs-vsctl --no-wait set Open_vSwitch . other_config:dpdk-init=true
- $ ovs-ctl --no-ovsdb-server --db-sock="$DB_SOCK" start
-
-There are many other configuration options, the most important of which are
-listed below. Defaults will be provided for all values not explicitly set.
-
-``dpdk-init``
- Specifies whether OVS should initialize and support DPDK ports. This field
- can either be ``true`` or ``try``.
- A value of ``true`` will cause the ovs-vswitchd process to abort on
- initialization failure.
- A value of ``try`` will imply that the ovs-vswitchd process should
- continue running even if the EAL initialization fails.
-
-``dpdk-lcore-mask``
- Specifies the CPU cores on which dpdk lcore threads should be spawned and
- expects hex string (eg '0x123').
-
-``dpdk-socket-mem``
- Comma separated list of memory to pre-allocate from hugepages on specific
- sockets. If not specified, 1024 MB will be set for each numa node by
- default.
-
-``dpdk-hugepage-dir``
- Directory where hugetlbfs is mounted
-
-``vhost-sock-dir``
- Option to set the path to the vhost-user unix socket files.
-
-If allocating more than one GB hugepage, you can configure the
-amount of memory used from any given NUMA nodes. For example, to use 1GB from
-NUMA node 0 and 0GB for all other NUMA nodes, run::
-
- $ ovs-vsctl --no-wait set Open_vSwitch . \
- other_config:dpdk-socket-mem="1024,0"
-
-or::
-
- $ ovs-vsctl --no-wait set Open_vSwitch . \
- other_config:dpdk-socket-mem="1024"
-
-.. note::
- Changing any of these options requires restarting the ovs-vswitchd
- application
-
-See the section ``Performance Tuning`` for important DPDK customizations.
-
-Validating
-----------
-
-DPDK support can be confirmed by validating the ``dpdk_initialized`` boolean
-value from the ovsdb. A value of ``true`` means that the DPDK EAL
-initialization succeeded::
-
- $ ovs-vsctl get Open_vSwitch . dpdk_initialized
- true
-
-Additionally, the library version linked to ovs-vswitchd can be confirmed
-with either the ovs-vswitchd logs, or by running either of the commands::
-
- $ ovs-vswitchd --version
- ovs-vswitchd (Open vSwitch) 2.9.0
- DPDK 17.11.0
- $ ovs-vsctl get Open_vSwitch . dpdk_version
- "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
-ports. For example, to create a userspace bridge named ``br0`` and add two
-``dpdk`` ports to it, run::
-
- $ ovs-vsctl add-br br0 -- set bridge br0 datapath_type=netdev
- $ ovs-vsctl add-port br0 myportnameone -- set Interface myportnameone \
- type=dpdk options:dpdk-devargs=0000:06:00.0
- $ ovs-vsctl add-port br0 myportnametwo -- set Interface myportnametwo \
- type=dpdk options:dpdk-devargs=0000:06:00.1
-
-DPDK devices will not be available for use until a valid dpdk-devargs is
-specified.
-
-Refer to ovs-vsctl(8) and :doc:`/howto/dpdk` for more details.
-
-Performance Tuning
-------------------
-
-To achieve optimal OVS performance, the system can be configured and that
-includes BIOS tweaks, Grub cmdline additions, better understanding of NUMA
-nodes and apt selection of PCIe slots for NIC placement.
-
-.. note::
-
- This section is optional. Once installed as described above, OVS with DPDK
- will work out of the box.
-
-Recommended BIOS Settings
-~~~~~~~~~~~~~~~~~~~~~~~~~
-
-.. list-table:: Recommended BIOS Settings
- :header-rows: 1
-
- * - Setting
- - Value
- * - C3 Power State
- - Disabled
- * - C6 Power State
- - Disabled
- * - MLC Streamer
- - Enabled
- * - MLC Spacial Prefetcher
- - Enabled
- * - DCU Data Prefetcher
- - Enabled
- * - DCA
- - Enabled
- * - CPU Power and Performance
- - Performance
- * - Memeory RAS and Performance Config -> NUMA optimized
- - Enabled
-
-PCIe Slot Selection
-~~~~~~~~~~~~~~~~~~~
-
-The fastpath performance can be affected by factors related to the placement of
-the NIC, such as channel speeds between PCIe slot and CPU or the proximity of
-PCIe slot to the CPU cores running the DPDK application. Listed below are the
-steps to identify right PCIe slot.
-
-#. Retrieve host details using ``dmidecode``. For example::
-
- $ dmidecode -t baseboard | grep "Product Name"
-
-#. Download the technical specification for product listed, e.g: S2600WT2
-
-#. Check the Product Architecture Overview on the Riser slot placement, CPU
- sharing info and also PCIe channel speeds
-
- For example: On S2600WT, CPU1 and CPU2 share Riser Slot 1 with Channel speed
- between CPU1 and Riser Slot1 at 32GB/s, CPU2 and Riser Slot1 at 16GB/s.
- Running DPDK app on CPU1 cores and NIC inserted in to Riser card Slots will
- optimize OVS performance in this case.
-
-#. Check the Riser Card #1 - Root Port mapping information, on the available
- slots and individual bus speeds. In S2600WT slot 1, slot 2 has high bus
- speeds and are potential slots for NIC placement.
-
-Advanced Hugepage Setup
-~~~~~~~~~~~~~~~~~~~~~~~
-
-Allocate and mount 1 GB hugepages.
-
-- For persistent allocation of huge pages, add the following options to the
- kernel bootline::
-
- default_hugepagesz=1GB hugepagesz=1G hugepages=N
-
- For platforms supporting multiple huge page sizes, add multiple options::
-
- default_hugepagesz=<size> hugepagesz=<size> hugepages=N
-
- where:
-
- ``N``
- number of huge pages requested
- ``size``
- huge page size with an optional suffix ``[kKmMgG]``
-
-- For run-time allocation of huge pages::
-
- $ echo N > /sys/devices/system/node/nodeX/hugepages/hugepages-1048576kB/nr_hugepages
-
- where:
-
- ``N``
- number of huge pages requested
- ``X``
- NUMA Node
-
- .. note::
- For run-time allocation of 1G huge pages, Contiguous Memory Allocator
- (``CONFIG_CMA``) has to be supported by kernel, check your Linux distro.
-
-Now mount the huge pages, if not already done so::
-
- $ mount -t hugetlbfs -o pagesize=1G none /dev/hugepages
-
-Isolate Cores
-~~~~~~~~~~~~~
-
-The ``isolcpus`` option can be used to isolate cores from the Linux scheduler.
-The isolated cores can then be used to dedicatedly run HPC applications or
-threads. This helps in better application performance due to zero context
-switching and minimal cache thrashing. To run platform logic on core 0 and
-isolate cores between 1 and 19 from scheduler, add ``isolcpus=1-19`` to GRUB
-cmdline.
-
-.. note::
- It has been verified that core isolation has minimal advantage due to mature
- Linux scheduler in some circumstances.
-
-Compiler Optimizations
-~~~~~~~~~~~~~~~~~~~~~~
-
-The default compiler optimization level is ``-O2``. Changing this to more
-aggressive compiler optimization such as ``-O3 -march=native`` with
-gcc (verified on 5.3.1) can produce performance gains though not significant.
-``-march=native`` will produce optimized code on local machine and should be
-used when software compilation is done on Testbed.
-
-Multiple Poll-Mode Driver Threads
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-With pmd multi-threading support, OVS creates one pmd thread for each NUMA node
-by default, if there is at least one DPDK interface from that NUMA node added
-to OVS. However, in cases where there are multiple ports/rxq's producing
-traffic, performance can be improved by creating multiple pmd threads running
-on separate cores. These pmd threads can share the workload by each being
-responsible for different ports/rxq's. Assignment of ports/rxq's to pmd threads
-is done automatically.
-
-A set bit in the mask means a pmd thread is created and pinned to the
-corresponding CPU core. For example, to run pmd threads on core 1 and 2::
-
- $ ovs-vsctl set Open_vSwitch . other_config:pmd-cpu-mask=0x6
-
-When using dpdk and dpdkvhostuser ports in a bi-directional VM loopback as
-shown below, spreading the workload over 2 or 4 pmd threads shows significant
-improvements as there will be more total CPU occupancy available::
-
- NIC port0 <-> OVS <-> VM <-> OVS <-> NIC port 1
-
-Refer to ovs-vswitchd.conf.db(5) for additional information on configuration
-options.
-
-Affinity
-~~~~~~~~
-
-For superior performance, DPDK pmd threads and Qemu vCPU threads needs to be
-affinitized accordingly.
-
-- PMD thread Affinity
-
- A poll mode driver (pmd) thread handles the I/O of all DPDK interfaces
- assigned to it. A pmd thread shall poll the ports for incoming packets,
- switch the packets and send to tx port. A pmd thread is CPU bound, and needs
- to be affinitized to isolated cores for optimum performance. Even though a
- PMD thread may exist, the thread only starts consuming CPU cycles if there is
- at least one receive queue assigned to the pmd.
-
- .. note::
- On NUMA systems, PCI devices are also local to a NUMA node. Unbound rx
- queues for a PCI device will be assigned to a pmd on it's local NUMA node
- if a non-isolated PMD exists on that NUMA node. If not, the queue will be
- assigned to a non-isolated pmd on a remote NUMA node. This will result in
- reduced maximum throughput on that device and possibly on other devices
- assigned to that pmd thread. If such a queue assignment is made a warning
- message will be logged: "There's no available (non-isolated) pmd thread on
- numa node N. Queue Q on port P will be assigned to the pmd on core C
- (numa node N'). Expect reduced performance."
-
- Binding PMD threads to cores is described in the above section
- ``Multiple Poll-Mode Driver Threads``.
-
-- QEMU vCPU thread Affinity
-
- A VM performing simple packet forwarding or running complex packet pipelines
- has to ensure that the vCPU threads performing the work has as much CPU
- occupancy as possible.
-
- For example, on a multicore VM, multiple QEMU vCPU threads shall be spawned.
- When the DPDK ``testpmd`` application that does packet forwarding is invoked,
- the ``taskset`` command should be used to affinitize the vCPU threads to the
- dedicated isolated cores on the host system.
-
-Enable HyperThreading
-~~~~~~~~~~~~~~~~~~~~~
-
-With HyperThreading, or SMT, enabled, a physical core appears as two logical
-cores. SMT can be utilized to spawn worker threads on logical cores of the same
-physical core there by saving additional cores.
-
-With DPDK, when pinning pmd threads to logical cores, care must be taken to set
-the correct bits of the ``pmd-cpu-mask`` to ensure that the pmd threads are
-pinned to SMT siblings.
-
-Take a sample system configuration, with 2 sockets, 2 * 10 core processors, HT
-enabled. This gives us a total of 40 logical cores. To identify the physical
-core shared by two logical cores, run::
-
- $ cat /sys/devices/system/cpu/cpuN/topology/thread_siblings_list
-
-where ``N`` is the logical core number.
-
-In this example, it would show that cores ``1`` and ``21`` share the same
-physical core. Logical cores can be specified in pmd-cpu-masks similarly to
-physical cores, as described in ``Multiple Poll-Mode Driver Threads``.
-
-NUMA/Cluster-on-Die
-~~~~~~~~~~~~~~~~~~~
-
-Ideally inter-NUMA datapaths should be avoided where possible as packets will
-go across QPI and there may be a slight performance penalty when compared with
-intra NUMA datapaths. On Intel Xeon Processor E5 v3, Cluster On Die is
-introduced on models that have 10 cores or more. This makes it possible to
-logically split a socket into two NUMA regions and again it is preferred where
-possible to keep critical datapaths within the one cluster.
-
-It is good practice to ensure that threads that are in the datapath are pinned
-to cores in the same NUMA area. e.g. pmd threads and QEMU vCPUs responsible for
-forwarding. If DPDK is built with ``CONFIG_RTE_LIBRTE_VHOST_NUMA=y``, vHost
-User ports automatically detect the NUMA socket of the QEMU vCPUs and will be
-serviced by a PMD from the same node provided a core on this node is enabled in
-the ``pmd-cpu-mask``. ``libnuma`` packages are required for this feature.
-
-Binding PMD threads is described in the above section
-``Multiple Poll-Mode Driver Threads``.
-
-DPDK Physical Port Rx Queues
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-::
-
- $ ovs-vsctl set Interface <DPDK interface> options:n_rxq=<integer>
-
-The above command sets the number of rx queues for DPDK physical interface.
-The rx queues are assigned to pmd threads on the same NUMA node in a
-round-robin fashion.
-
-.. _dpdk-queues-sizes:
-
-DPDK Physical Port Queue Sizes
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-::
-
- $ ovs-vsctl set Interface dpdk0 options:n_rxq_desc=<integer>
- $ ovs-vsctl set Interface dpdk0 options:n_txq_desc=<integer>
-
-The above command sets the number of rx/tx descriptors that the NIC associated
-with dpdk0 will be initialised with.
-
-Different ``n_rxq_desc`` and ``n_txq_desc`` configurations yield different
-benefits in terms of throughput and latency for different scenarios.
-Generally, smaller queue sizes can have a positive impact for latency at the
-expense of throughput. The opposite is often true for larger queue sizes.
-Note: increasing the number of rx descriptors eg. to 4096 may have a negative
-impact on performance due to the fact that non-vectorised DPDK rx functions may
-be used. This is dependent on the driver in use, but is true for the commonly
-used i40e and ixgbe DPDK drivers.
-
-Exact Match Cache
-~~~~~~~~~~~~~~~~~
-
-Each pmd thread contains one Exact Match Cache (EMC). After initial flow setup
-in the datapath, the EMC contains a single table and provides the lowest level
-(fastest) switching for DPDK ports. If there is a miss in the EMC then the next
-level where switching will occur is the datapath classifier. Missing in the
-EMC and looking up in the datapath classifier incurs a significant performance
-penalty. If lookup misses occur in the EMC because it is too small to handle
-the number of flows, its size can be increased. The EMC size can be modified by
-editing the define ``EM_FLOW_HASH_SHIFT`` in ``lib/dpif-netdev.c``.
-
-As mentioned above, an EMC is per pmd thread. An alternative way of increasing
-the aggregate amount of possible flow entries in EMC and avoiding datapath
-classifier lookups is to have multiple pmd threads running.
-
-Rx Mergeable Buffers
-~~~~~~~~~~~~~~~~~~~~
-
-Rx mergeable buffers is a virtio feature that allows chaining of multiple
-virtio descriptors to handle large packet sizes. Large packets are handled by
-reserving and chaining multiple free descriptors together. Mergeable buffer
-support is negotiated between the virtio driver and virtio device and is
-supported by the DPDK vhost library. This behavior is supported and enabled by
-default, however in the case where the user knows that rx mergeable buffers are
-not needed i.e. jumbo frames are not needed, it can be forced off by adding
-``mrg_rxbuf=off`` to the QEMU command line options. By not reserving multiple
-chains of descriptors it will make more individual virtio descriptors available
-for rx to the guest using dpdkvhost ports and this can improve performance.
-
-Output Packet Batching
-~~~~~~~~~~~~~~~~~~~~~~
-
-To make advantage of batched transmit functions, OVS collects packets in
-intermediate queues before sending when processing a batch of received packets.
-Even if packets are matched by different flows, OVS uses a single send
-operation for all packets destined to the same output port.
-
-Furthermore, OVS is able to buffer packets in these intermediate queues for a
-configurable amount of time to reduce the frequency of send bursts at medium
-load levels when the packet receive rate is high, but the receive batch size
-still very small. This is particularly beneficial for packets transmitted to
-VMs using an interrupt-driven virtio driver, where the interrupt overhead is
-significant for the OVS PMD, the host operating system and the guest driver.
-
-The ``tx-flush-interval`` parameter can be used to specify the time in
-microseconds OVS should wait between two send bursts to a given port (default
-is ``0``). When the intermediate queue fills up before that time is over, the
-buffered packet batch is sent immediately::
-
- $ ovs-vsctl set Open_vSwitch . other_config:tx-flush-interval=50
-
-This parameter influences both throughput and latency, depending on the traffic
-load on the port. In general lower values decrease latency while higher values
-may be useful to achieve higher throughput.
-
-Low traffic (``packet rate < 1 / tx-flush-interval``) should not experience
-any significant latency or throughput increase as packets are forwarded
-immediately.
-
-At intermediate load levels
-(``1 / tx-flush-interval < packet rate < 32 / tx-flush-interval``) traffic
-should experience an average latency increase of up to
-``1 / 2 * tx-flush-interval`` and a possible throughput improvement.
-
-Very high traffic (``packet rate >> 32 / tx-flush-interval``) should experience
-the average latency increase equal to ``32 / (2 * packet rate)``. Most send
-batches in this case will contain the maximum number of packets (``32``).
-
-A ``tx-burst-interval`` value of ``50`` microseconds has shown to provide a
-good performance increase in a ``PHY-VM-PHY`` scenario on ``x86`` system for
-interrupt-driven guests while keeping the latency increase at a reasonable
-level:
-
- https://mail.openvswitch.org/pipermail/ovs-dev/2017-December/341628.html
-
-.. note::
- Throughput impact of this option significantly depends on the scenario and
- the traffic patterns. For example: ``tx-burst-interval`` value of ``50``
- microseconds shows performance degradation in ``PHY-VM-PHY`` with bonded PHY
- scenario while testing with ``256 - 1024`` packet flows:
-
- https://mail.openvswitch.org/pipermail/ovs-dev/2017-December/341700.html
-
-The average number of packets per output batch can be checked in PMD stats::
-
- $ ovs-appctl dpif-netdev/pmd-stats-show
-
-Limitations
-------------
-
-- Network Interface Firmware requirements: Each release of DPDK is
- validated against a specific firmware version for a supported Network
- Interface. New firmware versions introduce bug fixes, performance
- improvements and new functionality that DPDK leverages. The validated
- firmware versions are available as part of the release notes for
- DPDK. It is recommended that users update Network Interface firmware
- to match what has been validated for the DPDK release.
-
- The latest list of validated firmware versions can be found in the `DPDK
- release notes`_.
-
-.. _DPDK release notes:
- https://doc.dpdk.org/guides/rel_notes/release_18_11.html
-
-- Upper bound MTU: DPDK device drivers differ in how the L2 frame for a
- given MTU value is calculated e.g. i40e driver includes 2 x vlan headers in
- MTU overhead, em driver includes 1 x vlan header, ixgbe driver does not
- include a vlan header in overhead. Currently it is not possible for OVS
- DPDK to know what upper bound MTU value is supported for a given device.
- As such OVS DPDK must provision for the case where the L2 frame for a given
- MTU includes 2 x vlan headers. This reduces the upper bound MTU value for
- devices that do not include vlan headers in their L2 frames by 8 bytes e.g.
- ixgbe devices upper bound MTU is reduced from 9710 to 9702. This work
- around is temporary and is expected to be removed once a method is provided
- by DPDK to query the upper bound MTU value for a given device.
-
-Reporting Bugs
---------------
-
-Report problems to bugs at openvswitch.org.
diff --git a/Documentation/intro/install/general.rst b/Documentation/intro/install/general.rst
index fa99491f6..bca4decb9 100644
--- a/Documentation/intro/install/general.rst
+++ b/Documentation/intro/install/general.rst
@@ -197,7 +197,7 @@ simply install and run Open vSwitch you require the following software:
can be a kernel module built with Open vSwitch (e.g. in the previous
step), or the kernel module that accompanies Linux 3.3 and later. Open
vSwitch features and performance can vary based on the module and the
- kernel. Refer to :doc:`/faq/releases` for more information.
+ kernel.
- For optional support of ingress policing on Linux, the "tc" program
from iproute2 (part of all major distributions and available at
diff --git a/Documentation/intro/install/index.rst b/Documentation/intro/install/index.rst
index 3193c736c..1f941f988 100644
--- a/Documentation/intro/install/index.rst
+++ b/Documentation/intro/install/index.rst
@@ -44,7 +44,6 @@ Installation from Source
windows
xenserver
userspace
- dpdk
Installation from Packages
--------------------------
diff --git a/Documentation/topics/dpdk/bridge.rst b/Documentation/topics/dpdk/bridge.rst
deleted file mode 100644
index a3ed926ca..000000000
--- a/Documentation/topics/dpdk/bridge.rst
+++ /dev/null
@@ -1,132 +0,0 @@
-..
- Licensed under the Apache License, Version 2.0 (the "License"); you may
- not use this file except in compliance with the License. You may obtain
- a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
- WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
- License for the specific language governing permissions and limitations
- under the License.
-
- Convention for heading levels in Open vSwitch documentation:
-
- ======= Heading 0 (reserved for the title in a document)
- ------- Heading 1
- ~~~~~~~ Heading 2
- +++++++ Heading 3
- ''''''' Heading 4
-
- Avoid deeper levels because they do not render well.
-
-============
-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.
-
-Quick Example
--------------
-
-This example demonstrates how to add a bridge using the DPDK datapath::
-
- $ ovs-vsctl add-br br0 -- set bridge br0 datapath_type=netdev
-
-This assumes Open vSwitch has been built with DPDK support. Refer to
-:doc:`/intro/install/dpdk` for more information.
-
-.. _extended-statistics:
-
-Extended & Custom Statistics
-----------------------------
-
-The DPDK Extended Statistics API allows PMDs to expose a unique set of
-statistics. The Extended Statistics are implemented and supported only for
-DPDK physical and vHost ports. Custom statistics are a dynamic set of counters
-which can vary depending on the driver. Those statistics are implemented for
-DPDK physical ports and contain all "dropped", "error" and "management"
-counters from ``XSTATS``. A list of all ``XSTATS`` counters can be found
-`here`__.
-
-__ https://wiki.opnfv.org/display/fastpath/Collectd+Metrics+and+Events
-
-.. note::
-
- vHost ports only support RX packet size-based counters. TX packet size
- counters are not available.
-
-To enable statistics, you have to enable OpenFlow 1.4 support for OVS. To
-configure a bridge, ``br0``, to support OpenFlow version 1.4, run::
-
- $ ovs-vsctl set bridge br0 datapath_type=netdev \
- protocols=OpenFlow10,OpenFlow11,OpenFlow12,OpenFlow13,OpenFlow14
-
-Once configured, check the OVSDB protocols column in the bridge table to ensure
-OpenFlow 1.4 support is enabled::
-
- $ ovsdb-client dump Bridge protocols
-
-You can also query the port statistics by explicitly specifying the ``-O
-OpenFlow14`` option::
-
- $ ovs-ofctl -O OpenFlow14 dump-ports br0
-
-EMC Insertion Probability
--------------------------
-
-By default 1 in every 100 flows is inserted into the Exact Match Cache (EMC).
-It is possible to change this insertion probability by setting the
-``emc-insert-inv-prob`` option::
-
- $ ovs-vsctl --no-wait set Open_vSwitch . other_config:emc-insert-inv-prob=N
-
-where:
-
-``N``
- A positive integer representing the inverse probability of insertion, i.e. on
- average 1 in every ``N`` packets with a unique flow will generate an EMC
- insertion.
-
-If ``N`` is set to 1, an insertion will be performed for every flow. If set to
-0, no insertions will be performed and the EMC will effectively be disabled.
-
-With default ``N`` set to 100, higher megaflow hits will occur initially as
-observed with pmd stats::
-
- $ ovs-appctl dpif-netdev/pmd-stats-show
-
-For certain traffic profiles with many parallel flows, it's recommended to set
-``N`` to '0' to achieve higher forwarding performance.
-
-It is also possible to enable/disable EMC on per-port basis using::
-
- $ ovs-vsctl set interface <iface> other_config:emc-enable={true,false}
-
-.. note::
-
- This could be useful for cases where different number of flows expected on
- different ports. For example, if one of the VMs encapsulates traffic using
- additional headers, it will receive large number of flows but only few flows
- will come out of this VM. In this scenario it's much faster to use EMC
- instead of classifier for traffic from the VM, but it's better to disable
- EMC for the traffic which flows to the VM.
-
-For more information on the EMC refer to :doc:`/intro/install/dpdk` .
-
-
-SMC cache (experimental)
--------------------------
-
-SMC cache or signature match cache is a new cache level after EMC cache.
-The difference between SMC and EMC is SMC only stores a signature of a flow
-thus it is much more memory efficient. With same memory space, EMC can store 8k
-flows while SMC can store 1M flows. When traffic flow count is much larger than
-EMC size, it is generally beneficial to turn off EMC and turn on SMC. It is
-currently turned off by default and an experimental feature.
-
-To turn on SMC::
-
- $ ovs-vsctl --no-wait set Open_vSwitch . other_config:smc-enable=true
diff --git a/Documentation/topics/dpdk/index.rst b/Documentation/topics/dpdk/index.rst
deleted file mode 100644
index cf24a7b6d..000000000
--- a/Documentation/topics/dpdk/index.rst
+++ /dev/null
@@ -1,43 +0,0 @@
-..
- Licensed under the Apache License, Version 2.0 (the "License"); you may
- not use this file except in compliance with the License. You may obtain
- a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
- WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
- License for the specific language governing permissions and limitations
- under the License.
-
- Convention for heading levels in Open vSwitch documentation:
-
- ======= Heading 0 (reserved for the title in a document)
- ------- Heading 1
- ~~~~~~~ Heading 2
- +++++++ Heading 3
- ''''''' Heading 4
-
- Avoid deeper levels because they do not render well.
-
-=================
-The DPDK Datapath
-=================
-
-.. NOTE(stephenfin): Part of this doc is included in 'howto/dpdk'. Update that
-.. if you modify this document
-
-.. toctree::
- :maxdepth: 2
-
- /topics/dpdk/bridge
- /topics/dpdk/phy
- /topics/dpdk/vhost-user
- /topics/dpdk/ring
- /topics/dpdk/vdev
- /topics/dpdk/pmd
- /topics/dpdk/qos
- /topics/dpdk/pdump
- /topics/dpdk/jumbo-frames
- /topics/dpdk/memory
diff --git a/Documentation/topics/dpdk/jumbo-frames.rst b/Documentation/topics/dpdk/jumbo-frames.rst
deleted file mode 100644
index 00360b4e6..000000000
--- a/Documentation/topics/dpdk/jumbo-frames.rst
+++ /dev/null
@@ -1,73 +0,0 @@
-..
- Copyright 2018, Red Hat, Inc.
-
- Licensed under the Apache License, Version 2.0 (the "License"); you may
- not use this file except in compliance with the License. You may obtain
- a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
- WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
- License for the specific language governing permissions and limitations
- under the License.
-
- Convention for heading levels in Open vSwitch documentation:
-
- ======= Heading 0 (reserved for the title in a document)
- ------- Heading 1
- ~~~~~~~ Heading 2
- +++++++ Heading 3
- ''''''' Heading 4
-
- Avoid deeper levels because they do not render well.
-
-============
-Jumbo Frames
-============
-
-.. versionadded:: 2.6.0
-
-By default, DPDK ports are configured with standard Ethernet MTU (1500B). To
-enable Jumbo Frames support for a DPDK port, change the Interface's
-``mtu_request`` attribute to a sufficiently large value. For example, to add a
-:doc:`DPDK physical port <phy>` with an MTU of 9000, run::
-
- $ ovs-vsctl add-port br0 dpdk-p0 -- set Interface dpdk-p0 type=dpdk \
- options:dpdk-devargs=0000:01:00.0 mtu_request=9000
-
-Similarly, to change the MTU of an existing port to 6200, run::
-
- $ ovs-vsctl set Interface dpdk-p0 mtu_request=6200
-
-Some additional configuration is needed to take advantage of jumbo frames with
-:doc:`vHost User ports <vhost-user>`:
-
-- *Mergeable buffers* must be enabled for vHost User ports, as demonstrated in
- the QEMU command line snippet below::
-
- -netdev type=vhost-user,id=mynet1,chardev=char0,vhostforce \
- -device virtio-net-pci,mac=00:00:00:00:00:01,netdev=mynet1,mrg_rxbuf=on
-
-- Where virtio devices are bound to the Linux kernel driver in a guest
- environment (i.e. interfaces are not bound to an in-guest DPDK driver), the
- MTU of those logical network interfaces must also be increased to a
- sufficiently large value. This avoids segmentation of Jumbo Frames received
- in the guest. Note that 'MTU' refers to the length of the IP packet only, and
- not that of the entire frame.
-
- To calculate the exact MTU of a standard IPv4 frame, subtract the L2 header
- and CRC lengths (i.e. 18B) from the max supported frame size. So, to set the
- MTU for a 9018B Jumbo Frame::
-
- $ ip link set eth1 mtu 9000
-
-When Jumbo Frames are enabled, the size of a DPDK port's mbuf segments are
-increased, such that a full Jumbo Frame of a specific size may be accommodated
-within a single mbuf segment.
-
-Jumbo frame support has been validated against 9728B frames, which is the
-largest frame size supported by Fortville NIC using the DPDK i40e driver, but
-larger frames and other DPDK NIC drivers may be supported. These cases are
-common for use cases involving East-West traffic only.
diff --git a/Documentation/topics/dpdk/memory.rst b/Documentation/topics/dpdk/memory.rst
deleted file mode 100644
index 9ebfd11e4..000000000
--- a/Documentation/topics/dpdk/memory.rst
+++ /dev/null
@@ -1,216 +0,0 @@
-..
- Copyright (c) 2018 Intel Corporation
-
- Licensed under the Apache License, Version 2.0 (the "License"); you may
- not use this file except in compliance with the License. You may obtain
- a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
- WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
- License for the specific language governing permissions and limitations
- under the License.
-
- Convention for heading levels in Open vSwitch documentation:
-
- ======= Heading 0 (reserved for the title in a document)
- ------- Heading 1
- ~~~~~~~ Heading 2
- +++++++ Heading 3
- ''''''' Heading 4
-
- Avoid deeper levels because they do not render well.
-
-=========================
-DPDK Device Memory Models
-=========================
-
-DPDK device memory can be allocated in one of two ways in OVS DPDK,
-**shared memory** or **per port memory**. The specifics of both are
-detailed below.
-
-Shared Memory
--------------
-
-By default OVS DPDK uses a shared memory model. This means that multiple
-ports can share the same mempool. For example when a port is added it will
-have a given MTU and socket ID associated with it. If a mempool has been
-created previously for an existing port that has the same MTU and socket ID,
-that mempool is used for both ports. If there is no existing mempool
-supporting these parameters then a new mempool is created.
-
-Per Port Memory
----------------
-
-In the per port memory model, mempools are created per device and are not
-shared. The benefit of this is a more transparent memory model where mempools
-will not be exhausted by other DPDK devices. However this comes at a potential
-increase in cost for memory dimensioning for a given deployment. Users should
-be aware of the memory requirements for their deployment before using this
-model and allocate the required hugepage memory.
-
-Per port mempool support may be enabled via a global config value,
-```per-port-memory```. Setting this to true enables the per port memory
-model for all DPDK devices in OVS::
-
- $ ovs-vsctl set Open_vSwitch . other_config:per-port-memory=true
-
-.. important::
-
- This value should be set before setting dpdk-init=true. If set after
- dpdk-init=true then the daemon must be restarted to use per-port-memory.
-
-Calculating Memory Requirements
--------------------------------
-
-The amount of memory required for a given mempool can be calculated by the
-**number mbufs in the mempool \* mbuf size**.
-
-Users should be aware of the following:
-
-* The **number of mbufs** per mempool will differ between memory models.
-
-* The **size of each mbuf** will be affected by the requested **MTU** size.
-
-.. important::
-
- An mbuf size in bytes is always larger than the requested MTU size due to
- alignment and rounding needed in OVS DPDK.
-
-Below are a number of examples of memory requirement calculations for both
-shared and per port memory models.
-
-Shared Memory Calculations
-~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-In the shared memory model the number of mbufs requested is directly
-affected by the requested MTU size as described in the table below.
-
-+--------------------+-------------+
-| MTU Size | Num MBUFS |
-+====================+=============+
-| 1500 or greater | 262144 |
-+--------------------+-------------+
-| Less than 1500 | 16384 |
-+------------+-------+-------------+
-
-.. Important::
-
- If a deployment does not have enough memory to provide 262144 mbufs then
- the requested amount is halved up until 16384.
-
-Example 1
-+++++++++
-::
-
- MTU = 1500 Bytes
- Number of mbufs = 262144
- Mbuf size = 3008 Bytes
- Memory required = 262144 * 3008 = 788 MB
-
-Example 2
-+++++++++
-::
-
- MTU = 1800 Bytes
- Number of mbufs = 262144
- Mbuf size = 3008 Bytes
- Memory required = 262144 * 3008 = 788 MB
-
-.. note::
-
- Assuming the same socket is in use for example 1 and 2 the same mempool
- would be shared.
-
-Example 3
-+++++++++
-::
-
- MTU = 6000 Bytes
- Number of mbufs = 262144
- Mbuf size = 7104 Bytes
- Memory required = 262144 * 7104 = 1862 MB
-
-Example 4
-+++++++++
-::
-
- MTU = 9000 Bytes
- Number of mbufs = 262144
- Mbuf size = 10176 Bytes
- Memory required = 262144 * 10176 = 2667 MB
-
-Per Port Memory Calculations
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-The number of mbufs requested in the per port model is more complicated and
-accounts for multiple dynamic factors in the datapath and device
-configuration.
-
-A rough estimation of the number of mbufs required for a port is:
-::
-
- packets required to fill the device rxqs +
- packets that could be stuck on other ports txqs +
- packets on the pmd threads +
- additional corner case memory.
-
-The algorithm in OVS used to calculate this is as follows:
-::
-
- requested number of rxqs * requested rxq size +
- requested number of txqs * requested txq size +
- min(RTE_MAX_LCORE, requested number of rxqs) * netdev_max_burst +
- MIN_NB_MBUF.
-
-where:
-
-* **requested number of rxqs**: Number of requested receive queues for a
- device.
-* **requested rxq size**: The number of descriptors requested for a rx queue.
-* **requested number of txqs**: Number of requested transmit queues for a
- device. Calculated as the number of PMDs configured +1.
-* **requested txq size**: the number of descriptors requested for a tx queue.
-* **min(RTE_MAX_LCORE, requested number of rxqs)**: Compare the maximum
- number of lcores supported by DPDK to the number of requested receive
- queues for the device and use the variable of lesser value.
-* **NETDEV_MAX_BURST**: Maximum number of of packets in a burst, defined as
- 32.
-* **MIN_NB_MBUF**: Additional memory for corner case, defined as 16384.
-
-For all examples below assume the following values:
-
-* requested_rxq_size = 2048
-* requested_txq_size = 2048
-* RTE_MAX_LCORE = 128
-* netdev_max_burst = 32
-* MIN_NB_MBUF = 16384
-
-Example 1: (1 rxq, 1 PMD, 1500 MTU)
-+++++++++++++++++++++++++++++++++++
-::
-
- MTU = 1500
- Number of mbufs = (1 * 2048) + (2 * 2048) + (1 * 32) + (16384) = 22560
- Mbuf size = 3008 Bytes
- Memory required = 22560 * 3008 = 67 MB
-
-Example 2: (1 rxq, 2 PMD, 6000 MTU)
-+++++++++++++++++++++++++++++++++++
-::
-
- MTU = 6000
- Number of mbufs = (1 * 2048) + (3 * 2048) + (1 * 32) + (16384) = 24608
- Mbuf size = 7104 Bytes
- Memory required = 24608 * 7104 = 175 MB
-
-Example 3: (2 rxq, 2 PMD, 9000 MTU)
-+++++++++++++++++++++++++++++++++++
-::
-
- MTU = 9000
- Number of mbufs = (2 * 2048) + (3 * 2048) + (1 * 32) + (16384) = 26656
- Mbuf size = 10176 Bytes
- Memory required = 26656 * 10176 = 271 MB
diff --git a/Documentation/topics/dpdk/pdump.rst b/Documentation/topics/dpdk/pdump.rst
deleted file mode 100644
index 7bd1d3e9f..000000000
--- a/Documentation/topics/dpdk/pdump.rst
+++ /dev/null
@@ -1,67 +0,0 @@
-..
- Licensed under the Apache License, Version 2.0 (the "License"); you may
- not use this file except in compliance with the License. You may obtain
- a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
- WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
- License for the specific language governing permissions and limitations
- under the License.
-
- Convention for heading levels in Open vSwitch documentation:
-
- ======= Heading 0 (reserved for the title in a document)
- ------- Heading 1
- ~~~~~~~ Heading 2
- +++++++ Heading 3
- ''''''' Heading 4
-
- Avoid deeper levels because they do not render well.
-
-=====
-pdump
-=====
-
-.. versionadded:: 2.6.0
-
-pdump allows you to listen on DPDK ports and view the traffic that is passing
-on them. To use this utility, one must have libpcap installed on the system.
-Furthermore, DPDK must be built with ``CONFIG_RTE_LIBRTE_PDUMP=y`` and
-``CONFIG_RTE_LIBRTE_PMD_PCAP=y``.
-
-.. warning::
-
- A performance decrease is expected when using a monitoring application like
- the DPDK pdump app.
-
-To use pdump, simply launch OVS as usual, then navigate to the ``app/pdump``
-directory in DPDK, ``make`` the application and run like so::
-
- $ sudo ./build/app/dpdk-pdump -- \
- --pdump port=0,queue=0,rx-dev=/tmp/pkts.pcap \
- --server-socket-path=/usr/local/var/run/openvswitch
-
-The above command captures traffic received on queue 0 of port 0 and stores it
-in ``/tmp/pkts.pcap``. Other combinations of port numbers, queues numbers and
-pcap locations are of course also available to use. For example, to capture all
-packets that traverse port 0 in a single pcap file::
-
- $ sudo ./build/app/dpdk-pdump -- \
- --pdump 'port=0,queue=*,rx-dev=/tmp/pkts.pcap,tx-dev=/tmp/pkts.pcap' \
- --server-socket-path=/usr/local/var/run/openvswitch
-
-``server-socket-path`` must be set to the value of ``ovs_rundir()`` which
-typically resolves to ``/usr/local/var/run/openvswitch``.
-
-Many tools are available to view the contents of the pcap file. Once example is
-tcpdump. Issue the following command to view the contents of ``pkts.pcap``::
-
- $ tcpdump -r pkts.pcap
-
-More information on the pdump app and its usage can be found in the `DPDK
-documentation`__.
-
-__ http://dpdk.org/doc/guides/tools/pdump.html
diff --git a/Documentation/topics/dpdk/phy.rst b/Documentation/topics/dpdk/phy.rst
deleted file mode 100644
index 93d74df45..000000000
--- a/Documentation/topics/dpdk/phy.rst
+++ /dev/null
@@ -1,389 +0,0 @@
-..
- Copyright 2018, Red Hat, Inc.
-
- Licensed under the Apache License, Version 2.0 (the "License"); you may
- not use this file except in compliance with the License. You may obtain
- a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
- WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
- License for the specific language governing permissions and limitations
- under the License.
-
- Convention for heading levels in Open vSwitch documentation:
-
- ======= Heading 0 (reserved for the title in a document)
- ------- Heading 1
- ~~~~~~~ Heading 2
- +++++++ Heading 3
- ''''''' Heading 4
-
- Avoid deeper levels because they do not render well.
-
-===================
-DPDK Physical Ports
-===================
-
-The netdev datapath allows attaching of DPDK-backed physical interfaces in
-order to provide high-performance ingress/egress from the host.
-
-.. important::
-
- To use any DPDK-backed interface, you must ensure your bridge is configured
- correctly. For more information, refer to :doc:`bridge`.
-
-.. versionchanged:: 2.7.0
-
- Before Open vSwitch 2.7.0, it was necessary to prefix port names with a
- ``dpdk`` prefix. Starting with 2.7.0, this is no longer necessary.
-
-.. todo::
-
- Add an example for multiple ports share the same bus slot function.
-
-Quick Example
--------------
-
-This example demonstrates how to bind two ``dpdk`` ports, bound to physical
-interfaces identified by hardware IDs ``0000:01:00.0`` and ``0000:01:00.1``, to
-an existing bridge called ``br0``::
-
- $ ovs-vsctl add-port br0 dpdk-p0 \
- -- set Interface dpdk-p0 type=dpdk options:dpdk-devargs=0000:01:00.0
- $ ovs-vsctl add-port br0 dpdk-p1 \
- -- set Interface dpdk-p1 type=dpdk options:dpdk-devargs=0000:01:00.1
-
-For the above example to work, the two physical interfaces must be bound to
-the DPDK poll-mode drivers in userspace rather than the traditional kernel
-drivers. See the `binding NIC drivers <dpdk-binding-nics>` section for details.
-
-.. _dpdk-binding-nics:
-
-Binding NIC Drivers
--------------------
-
-DPDK operates entirely in userspace and, as a result, requires use of its own
-poll-mode drivers in user space for physical interfaces and a passthrough-style
-driver for the devices in kernel space.
-
-There are two different tools for binding drivers: :command:`driverctl` which
-is a generic tool for persistently configuring alternative device drivers, and
-:command:`dpdk-devbind` which is a DPDK-specific tool and whose changes do not
-persist across reboots. In addition, there are two options available for this
-kernel space driver - VFIO (Virtual Function I/O) and UIO (Userspace I/O) -
-along with a number of drivers for each option. We will demonstrate examples of
-both tools and will use the ``vfio-pci`` driver, which is the more secure,
-robust driver of those available. More information can be found in the `DPDK
-documentation <dpdk-drivers>`__.
-
-To list devices using :command:`driverctl`, run::
-
- $ driverctl -v list-devices | grep -i net
- 0000:07:00.0 igb (I350 Gigabit Network Connection (Ethernet Server Adapter I350-T2))
- 0000:07:00.1 igb (I350 Gigabit Network Connection (Ethernet Server Adapter I350-T2))
-
-You can then bind one or more of these devices using the same tool::
-
- $ driverctl set-override 0000:07:00.0 vfio-pci
-
-Alternatively, to list devices using :command:`dpdk-devbind`, run::
-
- $ dpdk-devbind --status
- Network devices using DPDK-compatible driver
- ============================================
- <none>
-
- Network devices using kernel driver
- ===================================
- 0000:07:00.0 'I350 Gigabit Network Connection 1521' if=enp7s0f0 drv=igb unused=igb_uio
- 0000:07:00.1 'I350 Gigabit Network Connection 1521' if=enp7s0f1 drv=igb unused=igb_uio
-
- Other Network devices
- =====================
- ...
-
-Once again, you can then bind one or more of these devices using the same
-tool::
-
- $ dpdk-devbind --bind=vfio-pci 0000:07:00.0
-
-.. versionchanged:: 2.6.0
-
- Open vSwitch 2.6.0 added support for DPDK 16.07, which in turn renamed the
- former ``dpdk_nic_bind`` tool to ``dpdk-devbind``.
-
-For more information, refer to the `DPDK documentation <dpdk-drivers>`__.
-
-.. _dpdk-drivers: http://dpdk.org/doc/guides/linux_gsg/linux_drivers.html
-
-.. _dpdk-phy-multiqueue:
-
-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`.
-
-.. _dpdk-phy-flow-control:
-
-Flow Control
-------------
-
-Flow control can be enabled only on DPDK physical ports. To enable flow control
-support at Tx side while adding a port, run::
-
- $ ovs-vsctl add-port br0 dpdk-p0 -- set Interface dpdk-p0 type=dpdk \
- options:dpdk-devargs=0000:01:00.0 options:tx-flow-ctrl=true
-
-Similarly, to enable Rx flow control, run::
-
- $ ovs-vsctl add-port br0 dpdk-p0 -- set Interface dpdk-p0 type=dpdk \
- options:dpdk-devargs=0000:01:00.0 options:rx-flow-ctrl=true
-
-To enable flow control auto-negotiation, run::
-
- $ ovs-vsctl add-port br0 dpdk-p0 -- set Interface dpdk-p0 type=dpdk \
- options:dpdk-devargs=0000:01:00.0 options:flow-ctrl-autoneg=true
-
-To turn on the Tx flow control at run time for an existing port, run::
-
- $ ovs-vsctl set Interface dpdk-p0 options:tx-flow-ctrl=true
-
-The flow control parameters can be turned off by setting ``false`` to the
-respective parameter. To disable the flow control at Tx side, run::
-
- $ ovs-vsctl set Interface dpdk-p0 options:tx-flow-ctrl=false
-
-Rx Checksum Offload
--------------------
-
-By default, DPDK physical ports are enabled with Rx checksum offload.
-
-Rx checksum offload can offer performance improvement only for tunneling
-traffic in OVS-DPDK because the checksum validation of tunnel packets is
-offloaded to the NIC. Also enabling Rx checksum may slightly reduce the
-performance of non-tunnel traffic, specifically for smaller size packet.
-
-.. _port-hotplug:
-
-Hotplugging
------------
-
-OVS supports port hotplugging, allowing the use of physical ports that were not
-bound to DPDK when ovs-vswitchd was started.
-
-.. warning::
-
- This feature is not compatible with all NICs. Refer to vendor documentation
- for more information.
-
-.. important::
-
- Ports must be bound to DPDK. Refer to :ref:`dpdk-binding-nics` for more
- information.
-
-To *hotplug* a port, simply add it like any other port::
-
- $ ovs-vsctl add-port br0 dpdkx -- set Interface dpdkx type=dpdk \
- options:dpdk-devargs=0000:01:00.0
-
-Ports can be detached using the ``del-port`` command::
-
- $ ovs-vsctl del-port dpdkx
-
-This should both delete the port and detach the device. If successful, you
-should see an ``INFO`` log. For example::
-
- INFO|Device '0000:04:00.1' has been detached
-
-If the log is not seen then the port can be detached like so::
-
- $ ovs-appctl netdev-dpdk/detach 0000:01:00.0
-
-.. warning::
-
- Detaching should not be done if a device is known to be non-detachable, as
- this may cause the device to behave improperly when added back with
- add-port. The Chelsio Terminator adapters which use the cxgbe driver seem
- to be an example of this behavior; check the driver documentation if this
- is suspected.
-
-For more information please refer to the `DPDK Port Hotplug Framework`__.
-
-__ http://dpdk.org/doc/guides/prog_guide/port_hotplug_framework.html#hotplug
-
-.. _representors:
-
-Representors
-------------
-
-DPDK representors enable configuring a phy port to a guest (VM) machine.
-
-OVS resides in the hypervisor which has one or more physical interfaces also
-known as the physical functions (PFs). If a PF supports SR-IOV it can be used
-to enable communication with the VMs via Virtual Functions (VFs).
-The VFs are virtual PCIe devices created from the physical Ethernet controller.
-
-DPDK models a physical interface as a rte device on top of which an eth
-device is created.
-DPDK (version 18.xx) introduced the representors eth devices.
-A representor device represents the VF eth device (VM side) on the hypervisor
-side and operates on top of a PF.
-Representors are multi devices created on top of one PF.
-
-For more information, refer to the `DPDK documentation`__.
-
-__ https://doc.dpdk.org/guides-18.11/prog_guide/switch_representation.html
-
-Prior to port representors there was a one-to-one relationship between the PF
-and the eth device. With port representors the relationship becomes one PF to
-many eth devices.
-In case of two representors ports, when one of the ports is closed - the PCI
-bus cannot be detached until the second representor port is closed as well.
-
-.. _representors-configuration:
-
-When configuring a PF-based port, OVS traditionally assigns the device PCI
-address in devargs. For an existing bridge called ``br0`` and PCI address
-``0000:08:00.0`` an ``add-port`` command is written as::
-
- $ ovs-vsctl add-port br0 dpdk-pf -- set Interface dpdk-pf type=dpdk \
- options:dpdk-devargs=0000:08:00.0
-
-When configuring a VF-based port, DPDK uses an extended devargs syntax which
-has the following format::
-
- BDBF,representor=[<representor id>]
-
-This syntax shows that a representor is an enumerated eth device (with
-a representor ID) which uses the PF PCI address.
-The following commands add representors 3 and 5 using PCI device address
-``0000:08:00.0``::
-
- $ ovs-vsctl add-port br0 dpdk-rep3 -- set Interface dpdk-rep3 type=dpdk \
- options:dpdk-devargs=0000:08:00.0,representor=[3]
-
- $ ovs-vsctl add-port br0 dpdk-rep5 -- set Interface dpdk-rep5 type=dpdk \
- options:dpdk-devargs=0000:08:00.0,representor=[5]
-
-.. important::
-
- Representors ports are configured prior to OVS invocation and independently
- of it, or by other means as well. Please consult a NIC vendor instructions
- on how to establish representors.
-
-.. _multi-dev-configuration:
-
-**Intel NICs ixgbe and i40e**
-
-In the following example we create one representor on PF address
-``0000:05:00.0``. Once the NIC is bounded to a DPDK compatible PMD the
-representor is created::
-
- # echo 1 > /sys/bus/pci/devices/0000\:05\:00.0/max_vfs
-
-**Mellanox NICs ConnectX-4, ConnectX-5 and ConnectX-6**
-
-In the following example we create two representors on PF address
-``0000:05:00.0`` and net device name ``enp3s0f0``.
-
-- Ensure SR-IOV is enabled on the system.
-
-Enable IOMMU in Linux by adding ``intel_iommu=on`` to kernel parameters, for
-example, using GRUB (see /etc/grub/grub.conf).
-
-- Verify the PF PCI address prior to representors creation::
-
- # lspci | grep Mellanox
- 05:00.0 Ethernet controller: Mellanox Technologies MT27700 Family [ConnectX-4]
- 05:00.1 Ethernet controller: Mellanox Technologies MT27700 Family [ConnectX-4]
-
-- Create the two VFs on the compute node::
-
- # echo 2 > /sys/class/net/enp3s0f0/device/sriov_numvfs
-
- Verify the VFs creation::
-
- # lspci | grep Mellanox
- 05:00.0 Ethernet controller: Mellanox Technologies MT27700 Family [ConnectX-4]
- 05:00.1 Ethernet controller: Mellanox Technologies MT27700 Family [ConnectX-4]
- 05:00.2 Ethernet controller: Mellanox Technologies MT27700 Family [ConnectX-4 Virtual Function]
- 05:00.3 Ethernet controller: Mellanox Technologies MT27700 Family [ConnectX-4 Virtual Function]
-
-- Unbind the relevant VFs 0000:05:00.2..0000:05:00.3::
-
- # echo 0000:05:00.2 > /sys/bus/pci/drivers/mlx5_core/unbind
- # echo 0000:05:00.3 > /sys/bus/pci/drivers/mlx5_core/unbind
-
-- Change e-switch mode.
-
-The Mellanox NIC has an e-switch on it. Change the e-switch mode from
-legacy to switchdev using the PF PCI address::
-
- # sudo devlink dev eswitch set pci/0000:05:00.0 mode switchdev
-
-This will create the VF representors network devices in the host OS.
-
-- After setting the PF to switchdev mode bind back the relevant VFs::
-
- # echo 0000:05:00.2 > /sys/bus/pci/drivers/mlx5_core/bind
- # echo 0000:05:00.3 > /sys/bus/pci/drivers/mlx5_core/bind
-
-- Restart Open vSwitch
-
-To verify representors correct configuration, execute::
-
- $ ovs-vsctl show
-
-and make sure no errors are indicated.
-
-.. _vendor_configuration:
-
-Port representors are an example of multi devices. There are NICs which support
-multi devices by other methods than representors for which a generic devargs
-syntax is used. The generic syntax is based on the device mac address::
-
- class=eth,mac=<MAC address>
-
-For example, the following command adds a port to a bridge called ``br0`` using
-an eth device whose mac address is ``00:11:22:33:44:55``::
-
- $ ovs-vsctl add-port br0 dpdk-mac -- set Interface dpdk-mac type=dpdk \
- options:dpdk-devargs="class=eth,mac=00:11:22:33:44:55"
-
-Jumbo Frames
-------------
-
-DPDK physical ports can be configured to use Jumbo Frames. For more
-information, refer to :doc:`jumbo-frames`.
-
-Link State Change (LSC) detection configuration
------------------------------------------------
-
-There are two methods to get the information when Link State Change (LSC)
-happens on a network interface: by polling or interrupt.
-
-Configuring the lsc detection mode has no direct effect on OVS itself,
-instead it configures the NIC how it should handle link state changes.
-Processing the link state update request triggered by OVS takes less time
-using interrupt mode, since the NIC updates its link state in the
-background, while in polling mode the link state has to be fetched from
-the firmware every time to fulfil this request.
-
-Note that not all PMD drivers support LSC interrupts.
-
-The default configuration is polling mode. To set interrupt mode, option
-``dpdk-lsc-interrupt`` has to be set to ``true``.
-
-Command to set interrupt mode for a specific interface::
- $ ovs-vsctl set interface <iface_name> options:dpdk-lsc-interrupt=true
-
-Command to set polling mode for a specific interface::
- $ ovs-vsctl set interface <iface_name> options:dpdk-lsc-interrupt=false
diff --git a/Documentation/topics/dpdk/pmd.rst b/Documentation/topics/dpdk/pmd.rst
deleted file mode 100644
index b0e19d794..000000000
--- a/Documentation/topics/dpdk/pmd.rst
+++ /dev/null
@@ -1,248 +0,0 @@
-..
- Licensed under the Apache License, Version 2.0 (the "License"); you may
- not use this file except in compliance with the License. You may obtain
- a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
- WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
- License for the specific language governing permissions and limitations
- under the License.
-
- Convention for heading levels in Open vSwitch documentation:
-
- ======= Heading 0 (reserved for the title in a document)
- ------- Heading 1
- ~~~~~~~ Heading 2
- +++++++ Heading 3
- ''''''' Heading 4
-
- Avoid deeper levels because they do not render well.
-
-===========
-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.
-
-PMD threads utilize Receive (Rx) and Transmit (Tx) queues, commonly known as
-*rxq*\s and *txq*\s. While Tx queue configuration happens automatically, Rx
-queues can be configured by the user. This can happen in one of two ways:
-
-- For physical interfaces, configuration is done using the
- :program:`ovs-appctl` utility.
-
-- For virtual interfaces, configuration is done using the :program:`ovs-appctl`
- utility, but this configuration must be reflected in the guest configuration
- (e.g. QEMU command line arguments).
-
-The :program:`ovs-appctl` utility also provides a number of commands for
-querying PMD threads and their respective queues. This, and all of the above,
-is discussed here.
-
-.. todo::
-
- Add an overview of Tx queues including numbers created, how they relate to
- PMD threads, etc.
-
-PMD Thread Statistics
----------------------
-
-To show current stats::
-
- $ ovs-appctl dpif-netdev/pmd-stats-show
-
-To clear previous stats::
-
- $ ovs-appctl dpif-netdev/pmd-stats-clear
-
-Port/Rx Queue Assigment to PMD Threads
---------------------------------------
-
-.. todo::
-
- This needs a more detailed overview of *why* this should be done, along with
- the impact on things like NUMA affinity.
-
-Correct configuration of PMD threads and the Rx queues they utilize is a
-requirement in order to achieve maximum performance. This is particularly true
-for enabling things like multiqueue for :ref:`physical <dpdk-phy-multiqueue>`
-and :ref:`vhost-user <dpdk-vhost-user>` interfaces.
-
-To show port/Rx queue assignment::
-
- $ ovs-appctl dpif-netdev/pmd-rxq-show
-
-Rx queues may be manually pinned to cores. This will change the default Rx
-queue assignment to PMD threads::
-
- $ ovs-vsctl set Interface <iface> \
- other_config:pmd-rxq-affinity=<rxq-affinity-list>
-
-where:
-
-- ``<rxq-affinity-list>`` is a CSV list of ``<queue-id>:<core-id>`` values
-
-For example::
-
- $ ovs-vsctl set interface dpdk-p0 options:n_rxq=4 \
- other_config:pmd-rxq-affinity="0:3,1:7,3:8"
-
-This will ensure there are *4* Rx queues and that these queues are configured
-like so:
-
-- Queue #0 pinned to core 3
-- Queue #1 pinned to core 7
-- Queue #2 not pinned
-- Queue #3 pinned to core 8
-
-PMD threads on cores where Rx queues are *pinned* will become *isolated*. This
-means that this thread will only poll the *pinned* Rx queues.
-
-.. warning::
-
- If there are no *non-isolated* PMD threads, *non-pinned* RX queues will not
- be polled. Also, if the provided ``<core-id>`` is not available (e.g. the
- ``<core-id>`` is not in ``pmd-cpu-mask``), the RX queue will not be polled
- by any PMD thread.
-
-If ``pmd-rxq-affinity`` is not set for Rx queues, they will be assigned to PMDs
-(cores) automatically.
-
-The algorithm used to automatically assign Rxqs to PMDs can be set by::
-
- $ ovs-vsctl set Open_vSwitch . other_config:pmd-rxq-assign=<assignment>
-
-By default, ``cycles`` assignment is used where the Rxqs will be ordered by
-their measured processing cycles, and then be evenly assigned in descending
-order to PMDs based on an up/down walk of the PMDs. For example, where there
-are five Rx queues and three cores - 3, 7, and 8 - available and the measured
-usage of core cycles per Rx queue over the last interval is seen to be:
-
-- Queue #0: 30%
-- Queue #1: 80%
-- Queue #3: 60%
-- Queue #4: 70%
-- Queue #5: 10%
-
-The Rx queues will be assigned to the cores in the following order::
-
- Core 3: Q1 (80%) |
- Core 7: Q4 (70%) | Q5 (10%)
- Core 8: Q3 (60%) | Q0 (30%)
-
-Alternatively, ``roundrobin`` assignment can be used, where the Rxqs are
-assigned to PMDs in a round-robined fashion. This algorithm was used by
-default prior to OVS 2.9. For example, given the following ports and queues:
-
-- Port #0 Queue #0 (P0Q0)
-- Port #0 Queue #1 (P0Q1)
-- Port #1 Queue #0 (P1Q0)
-- Port #1 Queue #1 (P1Q1)
-- Port #1 Queue #2 (P1Q2)
-
-The Rx queues may be assigned to the cores in the following order::
-
- Core 3: P0Q0 | P1Q1
- Core 7: P0Q1 | P1Q2
- Core 8: P1Q0 |
-
-To see the current measured usage history of PMD core cycles for each Rx
-queue::
-
- $ ovs-appctl dpif-netdev/pmd-rxq-show
-
-.. note::
-
- A history of one minute is recorded and shown for each Rx queue to allow for
- traffic pattern spikes. Any changes in the Rx queue's PMD core cycles usage,
- due to traffic pattern or reconfig changes, will take one minute to be fully
- reflected in the stats.
-
-Rx queue to PMD assignment takes place whenever there are configuration changes
-or can be triggered by using::
-
- $ ovs-appctl dpif-netdev/pmd-rxq-rebalance
-
-.. versionchanged:: 2.6.0
-
- The ``pmd-rxq-show`` command was added in OVS 2.6.0.
-
-.. versionchanged:: 2.9.0
-
- Utilization-based allocation of Rx queues to PMDs and the
- ``pmd-rxq-rebalance`` command were added in OVS 2.9.0. Prior to this,
- allocation was round-robin and processing cycles were not taken into
- consideration.
-
- In addition, the output of ``pmd-rxq-show`` was modified to include
- Rx queue utilization of the PMD as a percentage. Prior to this, tracking of
- stats was not available.
-
-Automatic assignment of Port/Rx Queue to PMD Threads (experimental)
--------------------------------------------------------------------
-
-Cycle or utilization based allocation of Rx queues to PMDs gives efficient
-load distribution but it is not adaptive to change in traffic pattern
-occurring over the time. This causes uneven load among the PMDs which results
-in overall lower throughput.
-
-To address this automatic load balancing of PMDs can be set by::
-
- $ ovs-vsctl set open_vswitch . other_config:pmd-auto-lb="true"
-
-If pmd-auto-lb is set to true AND cycle based assignment is enabled then auto
-load balancing of PMDs is enabled provided there are 2 or more non-isolated
-PMDs and at least one of these PMDs is polling more than one RX queue. So,
-following conditions need to be met to have Auto Load balancing enabled:
-
-1. cycle based assignment of RX queues to PMD is enabled.
-2. pmd-auto-lb is set to true.
-3. There are two or more non-isolated PMDs present.
-4. And at least one of the non-isolated PMD has more than one queue polling.
-
-If any of above is not met PMD Auto Load Balancing is disabled.
-
-Once auto load balancing is set, each non-isolated PMD measures the processing
-load for each of its associated queues every 10 seconds. If the aggregated PMD
-load reaches 95% for 6 consecutive intervals then PMD considers itself to be
-overloaded.
-
-If any PMD is overloaded, a dry-run of the PMD assignment algorithm is
-performed by OVS main thread. The dry-run does NOT change the existing queue
-to PMD assignments.
-
-If the resultant mapping of dry-run indicates an improved distribution of the
-load then the actual reassignment will be performed.
-
-.. note::
-
- PMD Auto Load Balancing doesn't currently work if queues are assigned
- cross NUMA as actual processing load could get worse after assignment
- as compared to what dry run predicts.
-
-The minimum time between 2 consecutive PMD auto load balancing iterations can
-also be configured by::
-
- $ ovs-vsctl set open_vswitch .\
- other_config:pmd-auto-lb-rebal-interval="<interval>"
-
-where ``<interval>`` is a value in minutes. The default interval is 1 minute
-and setting it to 0 will also result in default value i.e. 1 min.
-
-A user can use this option to avoid frequent trigger of Auto Load Balancing of
-PMDs. For e.g. set this (in min) such that it occurs once in few hours or a day
-or a week.
-
-.. note::
- In some scenarios it may not be desired to have Auto Load Balancing
- triggerred. For example, if traffic profile for specific RX queue is
- changing dramatically very frequently which in turn thrashes CPU cache
- due to changes required in dpctl flows and EMC for newly added flows.
- In such scenarios user should configure rebalance interval accordingly
- to avoid frequent rebalancing happening.
diff --git a/Documentation/topics/dpdk/qos.rst b/Documentation/topics/dpdk/qos.rst
deleted file mode 100644
index c0aec5d88..000000000
--- a/Documentation/topics/dpdk/qos.rst
+++ /dev/null
@@ -1,78 +0,0 @@
-..
- Licensed under the Apache License, Version 2.0 (the "License"); you may
- not use this file except in compliance with the License. You may obtain
- a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
- WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
- License for the specific language governing permissions and limitations
- under the License.
-
- Convention for heading levels in Open vSwitch documentation:
-
- ======= Heading 0 (reserved for the title in a document)
- ------- Heading 1
- ~~~~~~~ Heading 2
- +++++++ Heading 3
- ''''''' Heading 4
-
- Avoid deeper levels because they do not render well.
-
-========================
-Quality of Service (QoS)
-========================
-
-It is possible to apply both ingress and egress limiting when using the DPDK
-datapath. These are referred to as *QoS* and *Rate Limiting*, respectively.
-
-.. versionadded:: 2.7.0
-
-QoS (Egress Policing)
----------------------
-
-Assuming you have a :doc:`vhost-user port <vhost-user>` transmitting traffic
-consisting of packets of size 64 bytes, the following command would limit the
-egress transmission rate of the port to ~1,000,000 packets per second::
-
- $ ovs-vsctl set port vhost-user0 qos=@newqos -- \
- --id=@newqos create qos type=egress-policer other-config:cir=46000000 \
- other-config:cbs=2048`
-
-To examine the QoS configuration of the port, run::
-
- $ ovs-appctl -t ovs-vswitchd qos/show vhost-user0
-
-To clear the QoS configuration from the port and ovsdb, run::
-
- $ ovs-vsctl destroy QoS vhost-user0 -- clear Port vhost-user0 qos
-
-Refer to ``vswitch.xml`` for more details on egress policer.
-
-Rate Limiting (Ingress Policing)
---------------------------------
-
-Assuming you have a :doc:`vhost-user port <vhost-user>` receiving traffic
-consisting of packets of size 64 bytes, the following command would limit the
-reception rate of the port to ~1,000,000 packets per second::
-
- $ ovs-vsctl set interface vhost-user0 ingress_policing_rate=368000 \
- ingress_policing_burst=1000`
-
-To examine the ingress policer configuration of the port::
-
- $ ovs-vsctl list interface vhost-user0
-
-To clear the ingress policer configuration from the port::
-
- $ ovs-vsctl set interface vhost-user0 ingress_policing_rate=0
-
-Refer to ``vswitch.xml`` for more details on ingress policer.
-
-Flow Control
-------------
-
-Flow control is available for :doc:`DPDK physical ports <phy>`. For more
-information, refer to :ref:`dpdk-phy-flow-control`.
diff --git a/Documentation/topics/dpdk/ring.rst b/Documentation/topics/dpdk/ring.rst
deleted file mode 100644
index e48b44ce8..000000000
--- a/Documentation/topics/dpdk/ring.rst
+++ /dev/null
@@ -1,86 +0,0 @@
-..
- Licensed under the Apache License, Version 2.0 (the "License"); you may
- not use this file except in compliance with the License. You may obtain
- a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
- WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
- License for the specific language governing permissions and limitations
- under the License.
-
- Convention for heading levels in Open vSwitch documentation:
-
- ======= Heading 0 (reserved for the title in a document)
- ------- Heading 1
- ~~~~~~~ Heading 2
- +++++++ Heading 3
- ''''''' Heading 4
-
- Avoid deeper levels because they do not render well.
-
-===============
-DPDK Ring Ports
-===============
-
-.. warning::
-
- DPDK ring interfaces cannot be used for guest communication and are retained
- mainly for backwards compatibility purposes. In nearly all cases,
- :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`_.
-
-.. important::
-
- To use any DPDK-backed interface, you must ensure your bridge is configured
- correctly. For more information, refer to :doc:`bridge`.
-
-Quick Example
--------------
-
-This example demonstrates how to add a ``dpdkr`` port to an existing bridge
-called ``br0``::
-
- $ ovs-vsctl add-port br0 dpdkr0 -- set Interface dpdkr0 type=dpdkr
-
-dpdkr
------
-
-To use ring ports, you must first add said ports to the switch. Unlike
-:doc:`vhost-user ports <vhost-user>`, ring port names must take a specific
-format, ``dpdkrNN``, where ``NN`` is the port ID. For example::
-
- $ ovs-vsctl add-port br0 dpdkr0 -- set Interface dpdkr0 type=dpdkr
-
-Once the port has been added to the switch, they can be used by host processes.
-A sample loopback application - ``test-dpdkr`` - is included with Open vSwitch.
-To use this, run the following::
-
- $ ./tests/test-dpdkr -c 1 -n 4 --proc-type=secondary -- -n 0
-
-Further functionality would require developing your own application. Refer to
-the `DPDK documentation`_ for more information on how to do this.
-
-Adding dpdkr ports to the guest
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-It is **not** recommended to use ring ports from guests. Historically, this was
-possible using a patched version of QEMU and the IVSHMEM feature provided with
-DPDK. However, this functionality was removed because:
-
-- The IVSHMEM library was removed from DPDK in DPDK 16.11
-
-- Support for IVSHMEM was never upstreamed to QEMU and has been publicly
- rejected by the QEMU community
-
-- :doc:`vhost-user interfaces <vhost-user>` are the de facto DPDK-based path to
- guests
-
-.. _DPDK documentation:
- https://doc.dpdk.org/guides-18.11/prog_guide/ring_lib.html
diff --git a/Documentation/topics/dpdk/vdev.rst b/Documentation/topics/dpdk/vdev.rst
deleted file mode 100644
index 1c0df7f4b..000000000
--- a/Documentation/topics/dpdk/vdev.rst
+++ /dev/null
@@ -1,66 +0,0 @@
-..
- Copyright 2018, Red Hat, Inc.
-
- Licensed under the Apache License, Version 2.0 (the "License"); you may
- not use this file except in compliance with the License. You may obtain
- a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
- WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
- License for the specific language governing permissions and limitations
- under the License.
-
- Convention for heading levels in Open vSwitch documentation:
-
- ======= Heading 0 (reserved for the title in a document)
- ------- Heading 1
- ~~~~~~~ Heading 2
- +++++++ Heading 3
- ''''''' Heading 4
-
- Avoid deeper levels because they do not render well.
-
-====================
-DPDK Virtual Devices
-====================
-
-DPDK provides drivers for both physical and virtual devices. Physical DPDK
-devices are added to OVS by specifying a valid PCI address in ``dpdk-devargs``.
-Virtual DPDK devices which do not have PCI addresses can be added using a
-different format for ``dpdk-devargs``.
-
-.. important::
-
- To use any DPDK-backed interface, you must ensure your bridge is configured
- correctly. For more information, refer to :doc:`bridge`.
-
-.. note::
-
- Not all DPDK virtual PMD drivers have been tested and verified to work.
-
-.. versionadded:: 2.7.0
-
-Quick Example
--------------
-
-To add a virtual ``dpdk`` devices, the ``dpdk-devargs`` argument should be of
-the format ``eth_<driver_name><x>``, where ``x``' is a unique identifier of
-your choice for the given port. For example to add a ``dpdk`` port that uses
-the ``null`` DPDK PMD driver, run::
-
- $ ovs-vsctl add-port br0 null0 -- set Interface null0 type=dpdk \
- options:dpdk-devargs=eth_null0
-
-Similarly, to add a ``dpdk`` port that uses the ``af_packet`` DPDK PMD driver,
-run::
-
- $ ovs-vsctl add-port br0 myeth0 -- set Interface myeth0 type=dpdk \
- options:dpdk-devargs=eth_af_packet0,iface=eth0
-
-More information on the different types of virtual DPDK PMDs can be found in
-the `DPDK documentation`__.
-
-__ http://dpdk.org/doc/guides/nics/overview.html
diff --git a/Documentation/topics/dpdk/vhost-user.rst b/Documentation/topics/dpdk/vhost-user.rst
deleted file mode 100644
index 993797de5..000000000
--- a/Documentation/topics/dpdk/vhost-user.rst
+++ /dev/null
@@ -1,505 +0,0 @@
-..
- Licensed under the Apache License, Version 2.0 (the "License"); you may
- not use this file except in compliance with the License. You may obtain
- a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
- WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
- License for the specific language governing permissions and limitations
- under the License.
-
- Convention for heading levels in Open vSwitch documentation:
-
- ======= Heading 0 (reserved for the title in a document)
- ------- Heading 1
- ~~~~~~~ Heading 2
- +++++++ Heading 3
- ''''''' Heading 4
-
- Avoid deeper levels because they do not render well.
-
-=====================
-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.
-
-.. important::
-
- To use any DPDK-backed interface, you must ensure your bridge is configured
- correctly. For more information, refer to :doc:`bridge`.
-
-Quick Example
--------------
-
-This example demonstrates how to add two ``dpdkvhostuserclient`` ports to an
-existing bridge called ``br0``::
-
- $ ovs-vsctl add-port br0 dpdkvhostclient0 \
- -- set Interface dpdkvhostclient0 type=dpdkvhostuserclient \
- options:vhost-server-path=/tmp/dpdkvhostclient0
- $ ovs-vsctl add-port br0 dpdkvhostclient1 \
- -- set Interface dpdkvhostclient1 type=dpdkvhostuserclient \
- options:vhost-server-path=/tmp/dpdkvhostclient1
-
-For the above examples to work, an appropriate server socket must be created
-at the paths specified (``/tmp/dpdkvhostclient0`` and
-``/tmp/dpdkvhostclient1``). These sockets can be created with QEMU; see the
-:ref:`vhost-user client <dpdk-vhost-user-client>` section for details.
-
-vhost-user vs. vhost-user-client
---------------------------------
-
-Open vSwitch provides two types of vHost User ports:
-
-- vhost-user (``dpdkvhostuser``)
-
-- vhost-user-client (``dpdkvhostuserclient``)
-
-vHost User uses a client-server model. The server creates/manages/destroys the
-vHost User sockets, and the client connects to the server. Depending on which
-port type you use, ``dpdkvhostuser`` or ``dpdkvhostuserclient``, a different
-configuration of the client-server model is used.
-
-For vhost-user ports, Open vSwitch acts as the server and QEMU the client. This
-means if OVS dies, all VMs **must** be restarted. On the other hand, for
-vhost-user-client ports, OVS acts as the client and QEMU the server. This means
-OVS can die and be restarted without issue, and it is also possible to restart
-an instance itself. For this reason, vhost-user-client ports are the preferred
-type for all known use cases; the only limitation is that vhost-user client
-mode ports require QEMU version 2.7. Ports of type vhost-user are currently
-deprecated and will be removed in a future release.
-
-.. _dpdk-vhost-user:
-
-vhost-user
-----------
-
-.. important::
-
- Use of vhost-user ports requires QEMU >= 2.2; vhost-user ports are
- *deprecated*.
-
-To use vhost-user ports, you must first add said ports to the switch. DPDK
-vhost-user ports can have arbitrary names with the exception of forward and
-backward slashes, which are prohibited. For vhost-user, the port type is
-``dpdkvhostuser``::
-
- $ ovs-vsctl add-port br0 vhost-user-1 -- set Interface vhost-user-1 \
- type=dpdkvhostuser
-
-This action creates a socket located at
-``/usr/local/var/run/openvswitch/vhost-user-1``, which you must provide to your
-VM on the QEMU command line.
-
-.. note::
-
- If you wish for the vhost-user sockets to be created in a sub-directory of
- ``/usr/local/var/run/openvswitch``, you may specify this directory in the
- ovsdb like so::
-
- $ ovs-vsctl --no-wait \
- set Open_vSwitch . other_config:vhost-sock-dir=subdir
-
-Once the vhost-user ports have been added to the switch, they must be added to
-the guest. There are two ways to do this: using QEMU directly, or using
-libvirt.
-
-.. note::
- IOMMU is not supported with vhost-user ports.
-
-Adding vhost-user ports to the guest (QEMU)
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-To begin, you must attach the vhost-user device sockets to the guest. To do
-this, you must pass the following parameters to QEMU::
-
- -chardev socket,id=char1,path=/usr/local/var/run/openvswitch/vhost-user-1
- -netdev type=vhost-user,id=mynet1,chardev=char1,vhostforce
- -device virtio-net-pci,mac=00:00:00:00:00:01,netdev=mynet1
-
-where ``vhost-user-1`` is the name of the vhost-user port added to the switch.
-
-Repeat the above parameters for multiple devices, changing the chardev ``path``
-and ``id`` as necessary. Note that a separate and different chardev ``path``
-needs to be specified for each vhost-user device. For example you have a second
-vhost-user port named ``vhost-user-2``, you append your QEMU command line with
-an additional set of parameters::
-
- -chardev socket,id=char2,path=/usr/local/var/run/openvswitch/vhost-user-2
- -netdev type=vhost-user,id=mynet2,chardev=char2,vhostforce
- -device virtio-net-pci,mac=00:00:00:00:00:02,netdev=mynet2
-
-In addition, QEMU must allocate the VM's memory on hugetlbfs. vhost-user ports
-access a virtio-net device's virtual rings and packet buffers mapping the VM's
-physical memory on hugetlbfs. To enable vhost-user ports to map the VM's memory
-into their process address space, pass the following parameters to QEMU::
-
- -object memory-backend-file,id=mem,size=4096M,mem-path=/dev/hugepages,share=on
- -numa node,memdev=mem -mem-prealloc
-
-Finally, you may wish to enable multiqueue support. This is optional but,
-should you wish to enable it, run::
-
- -chardev socket,id=char2,path=/usr/local/var/run/openvswitch/vhost-user-2
- -netdev type=vhost-user,id=mynet2,chardev=char2,vhostforce,queues=$q
- -device virtio-net-pci,mac=00:00:00:00:00:02,netdev=mynet2,mq=on,vectors=$v
-
-where:
-
-``$q``
- The number of queues
-``$v``
- The number of vectors, which is ``$q`` * 2 + 2
-
-The vhost-user interface will be automatically reconfigured with required
-number of Rx and Tx queues after connection of virtio device. Manual
-configuration of ``n_rxq`` is not supported because OVS will work properly only
-if ``n_rxq`` will match number of queues configured in QEMU.
-
-A least two PMDs should be configured for the vswitch when using multiqueue.
-Using a single PMD will cause traffic to be enqueued to the same vhost queue
-rather than being distributed among different vhost queues for a vhost-user
-interface.
-
-If traffic destined for a VM configured with multiqueue arrives to the vswitch
-via a physical DPDK port, then the number of Rx queues should also be set to at
-least two for that physical DPDK port. This is required to increase the
-probability that a different PMD will handle the multiqueue transmission to the
-guest using a different vhost queue.
-
-If one wishes to use multiple queues for an interface in the guest, the driver
-in the guest operating system must be configured to do so. It is recommended
-that the number of queues configured be equal to ``$q``.
-
-For example, this can be done for the Linux kernel virtio-net driver with::
-
- $ ethtool -L <DEV> combined <$q>
-
-where:
-
-``-L``
- Changes the numbers of channels of the specified network device
-``combined``
- Changes the number of multi-purpose channels.
-
-Adding vhost-user ports to the guest (libvirt)
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-To begin, you must change the user and group that qemu runs under, and restart
-libvirtd.
-
-- In ``/etc/libvirt/qemu.conf`` add/edit the following lines::
-
- user = "root"
- group = "root"
-
-- Finally, restart the libvirtd process, For example, on Fedora::
-
- $ systemctl restart libvirtd.service
-
-Once complete, instantiate the VM. A sample XML configuration file is provided
-at the :ref:`end of this file <dpdk-vhost-user-xml>`. Save this file, then
-create a VM using this file::
-
- $ virsh create demovm.xml
-
-Once created, you can connect to the guest console::
-
- $ virsh console demovm
-
-The demovm xml configuration is aimed at achieving out of box performance on
-VM. These enhancements include:
-
-- The vcpus are pinned to the cores of the CPU socket 0 using ``vcpupin``.
-
-- Configure NUMA cell and memory shared using ``memAccess='shared'``.
-
-- Disable ``mrg_rxbuf='off'``
-
-Refer to the `libvirt documentation <http://libvirt.org/formatdomain.html>`__
-for more information.
-
-.. _dpdk-vhost-user-client:
-
-vhost-user-client
------------------
-
-.. important::
-
- Use of vhost-user ports requires QEMU >= 2.7
-
-To use vhost-user-client ports, you must first add said ports to the switch.
-Like DPDK vhost-user ports, DPDK vhost-user-client ports can have mostly
-arbitrary names. However, the name given to the port does not govern the name
-of the socket device. Instead, this must be configured by the user by way of a
-``vhost-server-path`` option. For vhost-user-client, the port type is
-``dpdkvhostuserclient``::
-
- $ VHOST_USER_SOCKET_PATH=/path/to/socket
- $ ovs-vsctl add-port br0 vhost-client-1 \
- -- set Interface vhost-client-1 type=dpdkvhostuserclient \
- options:vhost-server-path=$VHOST_USER_SOCKET_PATH
-
-Once the vhost-user-client ports have been added to the switch, they must be
-added to the guest. Like vhost-user ports, there are two ways to do this: using
-QEMU directly, or using libvirt. Only the QEMU case is covered here.
-
-Adding vhost-user-client ports to the guest (QEMU)
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Attach the vhost-user device sockets to the guest. To do this, you must pass
-the following parameters to QEMU::
-
- -chardev socket,id=char1,path=$VHOST_USER_SOCKET_PATH,server
- -netdev type=vhost-user,id=mynet1,chardev=char1,vhostforce
- -device virtio-net-pci,mac=00:00:00:00:00:01,netdev=mynet1
-
-where ``vhost-user-1`` is the name of the vhost-user port added to the switch.
-
-If the corresponding ``dpdkvhostuserclient`` port has not yet been configured
-in OVS with ``vhost-server-path=/path/to/socket``, QEMU will print a log
-similar to the following::
-
- QEMU waiting for connection on: disconnected:unix:/path/to/socket,server
-
-QEMU will wait until the port is created sucessfully in OVS to boot the VM.
-One benefit of using this mode is the ability for vHost ports to 'reconnect' in
-event of the switch crashing or being brought down. Once it is brought back up,
-the vHost ports will reconnect automatically and normal service will resume.
-
-vhost-user-client IOMMU Support
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-vhost IOMMU is a feature which restricts the vhost memory that a virtio device
-can access, and as such is useful in deployments in which security is a
-concern.
-
-IOMMU support may be enabled via a global config value,
-```vhost-iommu-support```. Setting this to true enables vhost IOMMU support for
-all vhost ports when/where available::
-
- $ ovs-vsctl set Open_vSwitch . other_config:vhost-iommu-support=true
-
-The default value is false.
-
-.. important::
-
- Changing this value requires restarting the daemon.
-
-.. important::
-
- Enabling the IOMMU feature also enables the vhost user reply-ack protocol;
- this is known to work on QEMU v2.10.0, but is buggy on older versions
- (2.7.0 - 2.9.0, inclusive). Consequently, the IOMMU feature is disabled by
- default (and should remain so if using the aforementioned versions of
- QEMU). Starting with QEMU v2.9.1, vhost-iommu-support can safely be
- enabled, even without having an IOMMU device, with no performance penalty.
-
-.. _dpdk-testpmd:
-
-DPDK in the Guest
------------------
-
-The DPDK ``testpmd`` application can be run in guest VMs for high speed packet
-forwarding between vhostuser ports. DPDK and testpmd application has to be
-compiled on the guest VM. Below are the steps for setting up the testpmd
-application in the VM.
-
-.. note::
-
- Support for DPDK in the guest requires QEMU >= 2.2
-
-To begin, instantiate a guest as described in :ref:`dpdk-vhost-user` or
-:ref:`dpdk-vhost-user-client`. Once started, connect to the VM, download the
-DPDK sources to VM and build DPDK::
-
- $ cd /root/dpdk/
- $ wget http://fast.dpdk.org/rel/dpdk-18.11.tar.xz
- $ tar xf dpdk-18.11.tar.xz
- $ export DPDK_DIR=/root/dpdk/dpdk-18.11
- $ export DPDK_TARGET=x86_64-native-linuxapp-gcc
- $ export DPDK_BUILD=$DPDK_DIR/$DPDK_TARGET
- $ cd $DPDK_DIR
- $ make install T=$DPDK_TARGET DESTDIR=install
-
-Build the test-pmd application::
-
- $ cd app/test-pmd
- $ export RTE_SDK=$DPDK_DIR
- $ export RTE_TARGET=$DPDK_TARGET
- $ make
-
-Setup huge pages and DPDK devices using UIO::
-
- $ sysctl vm.nr_hugepages=1024
- $ mkdir -p /dev/hugepages
- $ mount -t hugetlbfs hugetlbfs /dev/hugepages # only if not already mounted
- $ modprobe uio
- $ insmod $DPDK_BUILD/kmod/igb_uio.ko
- $ $DPDK_DIR/usertools/dpdk-devbind.py --status
- $ $DPDK_DIR/usertools/dpdk-devbind.py -b igb_uio 00:03.0 00:04.0
-
-.. note::
-
- vhost ports pci ids can be retrieved using::
-
- lspci | grep Ethernet
-
-Finally, start the application::
-
- # TODO
-
-.. _dpdk-vhost-user-xml:
-
-Sample XML
-----------
-
-::
-
- <domain type='kvm'>
- <name>demovm</name>
- <uuid>4a9b3f53-fa2a-47f3-a757-dd87720d9d1d</uuid>
- <memory unit='KiB'>4194304</memory>
- <currentMemory unit='KiB'>4194304</currentMemory>
- <memoryBacking>
- <hugepages>
- <page size='2' unit='M' nodeset='0'/>
- </hugepages>
- </memoryBacking>
- <vcpu placement='static'>2</vcpu>
- <cputune>
- <shares>4096</shares>
- <vcpupin vcpu='0' cpuset='4'/>
- <vcpupin vcpu='1' cpuset='5'/>
- <emulatorpin cpuset='4,5'/>
- </cputune>
- <os>
- <type arch='x86_64' machine='pc'>hvm</type>
- <boot dev='hd'/>
- </os>
- <features>
- <acpi/>
- <apic/>
- </features>
- <cpu mode='host-model'>
- <model fallback='allow'/>
- <topology sockets='2' cores='1' threads='1'/>
- <numa>
- <cell id='0' cpus='0-1' memory='4194304' unit='KiB' memAccess='shared'/>
- </numa>
- </cpu>
- <on_poweroff>destroy</on_poweroff>
- <on_reboot>restart</on_reboot>
- <on_crash>destroy</on_crash>
- <devices>
- <emulator>/usr/bin/qemu-system-x86_64</emulator>
- <disk type='file' device='disk'>
- <driver name='qemu' type='qcow2' cache='none'/>
- <source file='/root/CentOS7_x86_64.qcow2'/>
- <target dev='vda' bus='virtio'/>
- </disk>
- <interface type='vhostuser'>
- <mac address='00:00:00:00:00:01'/>
- <source type='unix' path='/usr/local/var/run/openvswitch/dpdkvhostuser0' mode='client'/>
- <model type='virtio'/>
- <driver queues='2'>
- <host mrg_rxbuf='on'/>
- </driver>
- </interface>
- <interface type='vhostuser'>
- <mac address='00:00:00:00:00:02'/>
- <source type='unix' path='/usr/local/var/run/openvswitch/dpdkvhostuser1' mode='client'/>
- <model type='virtio'/>
- <driver queues='2'>
- <host mrg_rxbuf='on'/>
- </driver>
- </interface>
- <serial type='pty'>
- <target port='0'/>
- </serial>
- <console type='pty'>
- <target type='serial' port='0'/>
- </console>
- </devices>
- </domain>
-
-.. _QEMU documentation: http://git.qemu-project.org/?p=qemu.git;a=blob;f=docs/specs/vhost-user.txt;h=7890d7169;hb=HEAD
-
-Jumbo Frames
-------------
-
-DPDK vHost User ports can be configured to use Jumbo Frames. For more
-information, refer to :doc:`jumbo-frames`.
-
-vhost-user Dequeue Zero Copy (experimental)
--------------------------------------------
-
-Normally when dequeuing a packet from a vHost User device, a memcpy operation
-must be used to copy that packet from guest address space to host address
-space. This memcpy can be removed by enabling dequeue zero-copy like so::
-
- $ ovs-vsctl add-port br0 dpdkvhostuserclient0 -- set Interface \
- dpdkvhostuserclient0 type=dpdkvhostuserclient \
- options:vhost-server-path=/tmp/dpdkvhostclient0 \
- options:dq-zero-copy=true
-
-With this feature enabled, a reference (pointer) to the packet is passed to
-the host, instead of a copy of the packet. Removing this memcpy can give a
-performance improvement for some use cases, for example switching large packets
-between different VMs. However additional packet loss may be observed.
-
-Note that the feature is disabled by default and must be explicitly enabled
-by setting the ``dq-zero-copy`` option to ``true`` while specifying the
-``vhost-server-path`` option as above. If you wish to split out the command
-into multiple commands as below, ensure ``dq-zero-copy`` is set before
-``vhost-server-path``::
-
- $ ovs-vsctl set Interface dpdkvhostuserclient0 options:dq-zero-copy=true
- $ ovs-vsctl set Interface dpdkvhostuserclient0 \
- options:vhost-server-path=/tmp/dpdkvhostclient0
-
-The feature is only available to ``dpdkvhostuserclient`` port types.
-
-A limitation exists whereby if packets from a vHost port with
-``dq-zero-copy=true`` are destined for a ``dpdk`` type port, the number of tx
-descriptors (``n_txq_desc``) for that port must be reduced to a smaller number,
-128 being the recommended value. This can be achieved by issuing the following
-command::
-
- $ ovs-vsctl set Interface dpdkport options:n_txq_desc=128
-
-Note: The sum of the tx descriptors of all ``dpdk`` ports the VM will send to
-should not exceed 128. For example, in case of a bond over two physical ports
-in balance-tcp mode, one must divide 128 by the number of links in the bond.
-
-Refer to :ref:`dpdk-queues-sizes` for more information.
-
-The reason for this limitation is due to how the zero copy functionality is
-implemented. The vHost device's 'tx used vring', a virtio structure used for
-tracking used ie. sent descriptors, will only be updated when the NIC frees
-the corresponding mbuf. If we don't free the mbufs frequently enough, that
-vring will be starved and packets will no longer be processed. One way to
-ensure we don't encounter this scenario, is to configure ``n_txq_desc`` to a
-small enough number such that the 'mbuf free threshold' for the NIC will be hit
-more often and thus free mbufs more frequently. The value of 128 is suggested,
-but values of 64 and 256 have been tested and verified to work too, with
-differing performance characteristics. A value of 512 can be used too, if the
-virtio queue size in the guest is increased to 1024 (available to configure in
-QEMU versions v2.10 and greater). This value can be set like so::
-
- $ qemu-system-x86_64 ... -chardev socket,id=char1,path=<sockpath>,server
- -netdev type=vhost-user,id=mynet1,chardev=char1,vhostforce
- -device virtio-net-pci,mac=00:00:00:00:00:01,netdev=mynet1,
- tx_queue_size=1024
-
-Because of this limitation, this feature is considered 'experimental'.
-
-Further information can be found in the
-`DPDK documentation
-<https://doc.dpdk.org/guides-18.11/prog_guide/vhost_lib.html>`__
diff --git a/Documentation/topics/index.rst b/Documentation/topics/index.rst
index fa7f0a2fb..42373df95 100644
--- a/Documentation/topics/index.rst
+++ b/Documentation/topics/index.rst
@@ -44,7 +44,6 @@ OVS
bonding
networking-namespaces
ovsdb-replication
- dpdk/index
windows
language-bindings
testing
diff --git a/Documentation/topics/testing.rst b/Documentation/topics/testing.rst
index a8892e1c1..958360b85 100644
--- a/Documentation/topics/testing.rst
+++ b/Documentation/topics/testing.rst
@@ -297,37 +297,6 @@ To invoke the datapath testsuite with the userspace datapath, run::
The results of the testsuite are in ``tests/system-userspace-testsuite.dir``.
-DPDK datapath
-'''''''''''''
-
-To test :doc:`/intro/install/dpdk` (i.e., the build was configured with
-``--with-dpdk``, the DPDK is installed), run the testsuite and generate
-a report by using the ``check-dpdk`` target::
-
- # make check-dpdk
-
-or if you are not a root, but a sudo user::
-
- $ sudo -E make check-dpdk
-
-To see a list of all the available tests, run::
-
- # make check-dpdk TESTSUITEFLAGS=--list
-
-These tests support a `DPDK supported NIC`_. The tests operate on a wider set of
-environments, for instance, when a virtual port is used.
-They do require proper DPDK variables (``DPDK_DIR`` and ``DPDK_BUILD``).
-Moreover you need to have root privileges to load the required modules and to bind
-the NIC to the DPDK-compatible driver.
-
-.. _DPDK supported NIC: http://dpdk.org/doc/nics
-
-All tests are skipped if no hugepages are configured. User must look into the DPDK
-manual to figure out how to `Configure hugepages`_.
-The phy test will skip if no compatible physical device is available.
-
-.. _Configure hugepages: http://doc.dpdk.org/guides/linux_gsg/sys_reqs.html
-
Kernel datapath
'''''''''''''''
diff --git a/TODO.rst b/TODO.rst
index 33489174f..f703682d2 100644
--- a/TODO.rst
+++ b/TODO.rst
@@ -145,3 +145,8 @@ OVN To-do List
* Support FTP ALGs.
* Support reject action.
+
+* Documentation/faq
+
+ * Update configuration.rst for OVN.
+ * Add design.rst, releases.rst for OVN.
--
2.21.0
More information about the dev
mailing list