[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH v1 03/21] docs: add a section on the generalities of vhost-user
From: |
Alex Bennée |
Subject: |
[PATCH v1 03/21] docs: add a section on the generalities of vhost-user |
Date: |
Wed, 14 Jul 2021 10:37:01 +0100 |
While we do mention some of this stuff in the various daemons and
manuals the subtleties of the socket and memory sharing are sometimes
missed. This document attempts to give some background on vhost-user
daemons in general terms.
Signed-off-by: Alex Bennée <alex.bennee@linaro.org>
Cc: Stefan Hajnoczi <stefanha@redhat.com>
---
v2
- drop reference to socket direction (it can be either)
- mention memory-backend-memfd object
- mention requirement to match system memory size
---
docs/interop/vhost-user.rst | 4 +-
docs/system/device-emulation.rst | 1 +
docs/system/devices/vhost-user.rst | 59 ++++++++++++++++++++++++++++++
3 files changed, 63 insertions(+), 1 deletion(-)
create mode 100644 docs/system/devices/vhost-user.rst
diff --git a/docs/interop/vhost-user.rst b/docs/interop/vhost-user.rst
index d6085f7045..f46423b6f3 100644
--- a/docs/interop/vhost-user.rst
+++ b/docs/interop/vhost-user.rst
@@ -1,3 +1,5 @@
+.. _vhost_user_proto:
+
===================
Vhost-user Protocol
===================
@@ -6,7 +8,7 @@ Vhost-user Protocol
:Licence: This work is licensed under the terms of the GNU GPL,
version 2 or later. See the COPYING file in the top-level
directory.
-
+
.. contents:: Table of Contents
Introduction
diff --git a/docs/system/device-emulation.rst b/docs/system/device-emulation.rst
index a0f00bc340..5aca6ed66b 100644
--- a/docs/system/device-emulation.rst
+++ b/docs/system/device-emulation.rst
@@ -75,4 +75,5 @@ Emulated Devices
devices/net.rst
devices/nvme.rst
devices/usb.rst
+ devices/vhost-user.rst
devices/virtio-pmem.rst
diff --git a/docs/system/devices/vhost-user.rst
b/docs/system/devices/vhost-user.rst
new file mode 100644
index 0000000000..86128114fa
--- /dev/null
+++ b/docs/system/devices/vhost-user.rst
@@ -0,0 +1,59 @@
+.. _vhost_user:
+
+vhost-user back ends
+--------------------
+
+vhost-user back ends are way to service the request of VirtIO devices
+outside of QEMU itself. To do this there are a number of things
+required.
+
+vhost-user device
+===================
+
+These are simple stub devices that ensure the VirtIO device is visible
+to the guest. The code is mostly boilerplate although each device has
+a ``chardev`` option which specifies the ID of the ``--chardev``
+device that connects via a socket to the vhost-user *daemon*.
+
+vhost-user daemon
+=================
+
+This is a separate process that is connected to by QEMU via a socket
+following the :ref:`vhost_user_proto`. There are a number of daemons
+that can be built when enabled by the project although any daemon that
+meets the specification for a given device can be used.
+
+Shared memory object
+====================
+
+In order for the daemon to access the VirtIO queues to process the
+requests it needs access to the guest's address space. This is
+achieved via the ``memory-backend-file`` or ``memory-backend-memfd``
+objects. A reference to a file-descriptor which can access this object
+will be passed via the socket as part of the protocol negotiation.
+
+Currently the shared memory object needs to match the size of the main
+system memory as defined by the ``-m`` argument.
+
+Example
+=======
+
+First start you daemon.
+
+.. parsed-literal::
+
+ $ virtio-foo --socket-path=/var/run/foo.sock $OTHER_ARGS
+
+The you start your QEMU instance specifying the device, chardev and
+memory objects.
+
+.. parsed-literal::
+
+ $ |qemu_system| \\
+ -m 4096 \\
+ -chardev socket,id=ba1,path=/var/run/foo.sock \\
+ -device vhost-user-foo,chardev=ba1,$OTHER_ARGS \\
+ -object memory-backend-memfd,id=mem,size=4G,share=on \\
+ -numa node,memdev=mem \\
+ ...
+
--
2.20.1
- [PATCH v1 13/21] contrib/gitdm: un-ironically add a mapping for LWN, (continued)
- [PATCH v1 13/21] contrib/gitdm: un-ironically add a mapping for LWN, Alex Bennée, 2021/07/14
- [PATCH v1 19/21] contrib/gitdm: add an explicit academic entry for BU, Alex Bennée, 2021/07/14
- [PATCH v1 20/21] contrib/gitdm: add a new interns group-map for GSoC/Outreachy work, Alex Bennée, 2021/07/14
- [PATCH v1 14/21] contrib/gitdm: add domain-map for Crudebyte, Alex Bennée, 2021/07/14
- [PATCH v1 16/21] contrib/gitdm: add domain-map for Syrmia, Alex Bennée, 2021/07/14
- [PATCH v1 18/21] contrib/gitdm: add group-map for Netflix, Alex Bennée, 2021/07/14
- [PATCH v1 11/21] contrib/gitdm: add domain-map for Eldorado, Alex Bennée, 2021/07/14
- [PATCH v1 17/21] contrib/gitdm: add domain-map for NVIDIA, Alex Bennée, 2021/07/14
- [PATCH for 6.1-rc0 v1 00/21] documentation and metadata updates, Alex Bennée, 2021/07/14
- [PATCH v1 04/21] configure: remove needless if leg, Alex Bennée, 2021/07/14
- [PATCH v1 03/21] docs: add a section on the generalities of vhost-user,
Alex Bennée <=
- [PATCH v1 01/21] gitignore: Update with some filetypes, Alex Bennée, 2021/07/14
- [PATCH v1 02/21] docs: collect the disparate device emulation docs into one section, Alex Bennée, 2021/07/14
- [PATCH v1 11/21] contrib/gitdm: add domain-map for Eldorado, Alex Bennée, 2021/07/14
- [PATCH v1 06/21] .mailmap: fix up some broken commit authors, Alex Bennée, 2021/07/14
- [PATCH v1 08/21] contrib/gitdm: add a group mapping for robot scanners, Alex Bennée, 2021/07/14
- [PATCH v1 07/21] contrib/gitdm: add domain-map for MontaVista, Alex Bennée, 2021/07/14
- [PATCH v1 10/21] contrib/gitdm: add domain-map/group-map mappings for Samsung, Alex Bennée, 2021/07/14
- [PATCH v1 05/21] contrib/gitdm: add some new aliases to fix up commits, Alex Bennée, 2021/07/14
- [PATCH v1 12/21] contrib/gitdm: add domain-map/group-map for Wind River, Alex Bennée, 2021/07/14