[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH v4 4/4] docs: vhost-user: add subsection for non-Linux platforms
From: |
Sergio Lopez |
Subject: |
[PATCH v4 4/4] docs: vhost-user: add subsection for non-Linux platforms |
Date: |
Fri, 4 Mar 2022 11:08:54 +0100 |
Add a section explaining how vhost-user is supported on platforms
other than Linux.
Signed-off-by: Sergio Lopez <slp@redhat.com>
Reviewed-by: Stefan Hajnoczi <stefanha@redhat.com>
---
docs/interop/vhost-user.rst | 20 ++++++++++++++++++++
1 file changed, 20 insertions(+)
diff --git a/docs/interop/vhost-user.rst b/docs/interop/vhost-user.rst
index edc3ad84a3..4dbc84fd00 100644
--- a/docs/interop/vhost-user.rst
+++ b/docs/interop/vhost-user.rst
@@ -38,6 +38,26 @@ conventions <backend_conventions>`.
*Master* and *slave* can be either a client (i.e. connecting) or
server (listening) in the socket communication.
+Support for platforms other than Linux
+--------------------------------------
+
+While vhost-user was initially developed targeting Linux, nowadays it
+is supported on any platform that provides the following features:
+
+- A way for requesting shared memory represented by a file descriptor
+ so it can be passed over a UNIX domain socket and then mapped by the
+ other process.
+
+- AF_UNIX sockets with SCM_RIGHTS, so QEMU and the other process can
+ exchange messages through it, including ancillary data when needed.
+
+- Either eventfd or pipe/pipe2. On platforms where eventfd is not
+ available, QEMU will automatically fall back to pipe2 or, as a last
+ resort, pipe. Each file descriptor will be used for receiving or
+ sending events by reading or writing (respectively) an 8-byte value
+ to the corresponding it. The 8-value itself has no meaning and
+ should not be interpreted.
+
Message Specification
=====================
--
2.35.1
- [PATCH v4 0/4] Enable vhost-user to be used on BSD systems, Sergio Lopez, 2022/03/04
- [PATCH v4 1/4] event_notifier: add event_notifier_get_wfd(), Sergio Lopez, 2022/03/04
- [PATCH v4 2/4] vhost: use wfd on functions setting vring call fd, Sergio Lopez, 2022/03/04
- [PATCH v4 3/4] configure, meson: allow enabling vhost-user on all POSIX systems, Sergio Lopez, 2022/03/04
- [PATCH v4 4/4] docs: vhost-user: add subsection for non-Linux platforms,
Sergio Lopez <=
- Re: [PATCH v4 0/4] Enable vhost-user to be used on BSD systems, Stefan Hajnoczi, 2022/03/07