447e0d3797
Introduce a new iommu-support parameter to Vhost PMD that passes the RTE_VHOST_USER_IOMMU_SUPPORT flag at vhost device register time. Default value is 0, meaning that IOMMU support is disabled if not specified explicitly. Example to enable IOMMU support for a given device: --vdev 'net_vhost0,iface=/tmp/vhost-user2,iommu-support=1' Signed-off-by: Maxime Coquelin <maxime.coquelin@redhat.com> Acked-by: Yuanhan Liu <yliu@fridaylinux.org> Tested-by: Mark Kavanagh <mark.b.kavanagh@intel.com> Acked-by: Mark Kavanagh <mark.b.kavanagh@intel.com>
116 lines
4.3 KiB
ReStructuredText
116 lines
4.3 KiB
ReStructuredText
.. BSD LICENSE
|
|
Copyright(c) 2016 IGEL Co., Ltd.. All rights reserved.
|
|
All rights reserved.
|
|
|
|
Redistribution and use in source and binary forms, with or without
|
|
modification, are permitted provided that the following conditions
|
|
are met:
|
|
|
|
* Redistributions of source code must retain the above copyright
|
|
notice, this list of conditions and the following disclaimer.
|
|
* Redistributions in binary form must reproduce the above copyright
|
|
notice, this list of conditions and the following disclaimer in
|
|
the documentation and/or other materials provided with the
|
|
distribution.
|
|
* Neither the name of IGEL Co., Ltd. nor the names of its
|
|
contributors may be used to endorse or promote products derived
|
|
from this software without specific prior written permission.
|
|
|
|
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
|
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
|
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
|
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
|
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
|
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
|
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
|
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
|
|
Poll Mode Driver that wraps vhost library
|
|
=========================================
|
|
|
|
This PMD is a thin wrapper of the DPDK vhost library.
|
|
The user can handle virtqueues as one of normal DPDK port.
|
|
|
|
Vhost Implementation in DPDK
|
|
----------------------------
|
|
|
|
Please refer to Chapter "Vhost Library" of *DPDK Programmer's Guide* to know detail of vhost.
|
|
|
|
Features and Limitations of vhost PMD
|
|
-------------------------------------
|
|
|
|
Currently, the vhost PMD provides the basic functionality of packet reception, transmission and event handling.
|
|
|
|
* It has multiple queues support.
|
|
|
|
* It supports ``RTE_ETH_EVENT_INTR_LSC`` and ``RTE_ETH_EVENT_QUEUE_STATE`` events.
|
|
|
|
* It supports Port Hotplug functionality.
|
|
|
|
* Don't need to stop RX/TX, when the user wants to stop a guest or a virtio-net driver on guest.
|
|
|
|
Vhost PMD arguments
|
|
-------------------
|
|
|
|
The user can specify below arguments in `--vdev` option.
|
|
|
|
#. ``iface``:
|
|
|
|
It is used to specify a path to connect to a QEMU virtio-net device.
|
|
|
|
#. ``queues``:
|
|
|
|
It is used to specify the number of queues virtio-net device has.
|
|
(Default: 1)
|
|
|
|
#. ``iommu-support``:
|
|
|
|
It is used to enable iommu support in vhost library.
|
|
(Default: 0 (disabled))
|
|
|
|
Vhost PMD event handling
|
|
------------------------
|
|
|
|
This section describes how to handle vhost PMD events.
|
|
|
|
The user can register an event callback handler with ``rte_eth_dev_callback_register()``.
|
|
The registered callback handler will be invoked with one of below event types.
|
|
|
|
#. ``RTE_ETH_EVENT_INTR_LSC``:
|
|
|
|
It means link status of the port was changed.
|
|
|
|
#. ``RTE_ETH_EVENT_QUEUE_STATE``:
|
|
|
|
It means some of queue statuses were changed. Call ``rte_eth_vhost_get_queue_event()`` in the callback handler.
|
|
Because changing multiple statuses may occur only one event, call the function repeatedly as long as it doesn't return negative value.
|
|
|
|
Vhost PMD with testpmd application
|
|
----------------------------------
|
|
|
|
This section demonstrates vhost PMD with testpmd DPDK sample application.
|
|
|
|
#. Launch the testpmd with vhost PMD:
|
|
|
|
.. code-block:: console
|
|
|
|
./testpmd -l 0-3 -n 4 --vdev 'net_vhost0,iface=/tmp/sock0,queues=1' -- -i
|
|
|
|
Other basic DPDK preparations like hugepage enabling here.
|
|
Please refer to the *DPDK Getting Started Guide* for detailed instructions.
|
|
|
|
#. Launch the QEMU:
|
|
|
|
.. code-block:: console
|
|
|
|
qemu-system-x86_64 <snip>
|
|
-chardev socket,id=chr0,path=/tmp/sock0 \
|
|
-netdev vhost-user,id=net0,chardev=chr0,vhostforce,queues=1 \
|
|
-device virtio-net-pci,netdev=net0
|
|
|
|
This command attaches one virtio-net device to QEMU guest.
|
|
After initialization processes between QEMU and DPDK vhost library are done, status of the port will be linked up.
|