From: Paolo Bonzini <pbonzini@redhat.com>
To: qemu-devel@nongnu.org
Cc: marcandre.lureau@redhat.com, stefanha@redhat.com, mst@redhat.com
Subject: [PATCH 4/7] docs: vhost-user: rename message names from "SLAVE" to "BACKEND"
Date: Thu, 11 Mar 2021 05:32:47 -0500 [thread overview]
Message-ID: <20210311103250.532191-5-pbonzini@redhat.com> (raw)
In-Reply-To: <20210311103250.532191-1-pbonzini@redhat.com>
Follow the terminology that is used in the rest of the document.
Signed-off-by: Paolo Bonzini <pbonzini@redhat.com>
---
docs/interop/vhost-user.rst | 40 ++++++++++++++++++-------------------
1 file changed, 20 insertions(+), 20 deletions(-)
diff --git a/docs/interop/vhost-user.rst b/docs/interop/vhost-user.rst
index 96be549127..84c05dfb91 100644
--- a/docs/interop/vhost-user.rst
+++ b/docs/interop/vhost-user.rst
@@ -290,7 +290,7 @@ in the ancillary data:
* ``VHOST_USER_SET_VRING_KICK``
* ``VHOST_USER_SET_VRING_CALL``
* ``VHOST_USER_SET_VRING_ERR``
-* ``VHOST_USER_SET_SLAVE_REQ_FD``
+* ``VHOST_USER_SET_BACKEND_REQ_FD``
* ``VHOST_USER_SET_INFLIGHT_FD`` (if ``VHOST_USER_PROTOCOL_F_INFLIGHT_SHMFD``)
If *frontend* is unable to send the full message or receives a wrong
@@ -479,7 +479,7 @@ expected to reply with a zero payload, non-zero otherwise.
The backend relies on the backend communication channel (see :ref:`Back-end
communication <backend_communication>` section below) to send IOTLB miss
-and access failure events, by sending ``VHOST_USER_SLAVE_IOTLB_MSG``
+and access failure events, by sending ``VHOST_USER_BACKEND_IOTLB_MSG``
requests to the frontend with a ``struct vhost_iotlb_msg`` as
payload. For miss events, the iotlb payload has to be filled with the
miss message type (1), the I/O virtual address and the permissions
@@ -503,15 +503,15 @@ Back-end communication
----------------------
An optional communication channel is provided if the backend declares
-``VHOST_USER_PROTOCOL_F_SLAVE_REQ`` protocol feature, to allow the
+``VHOST_USER_PROTOCOL_F_BACKEND_REQ`` protocol feature, to allow the
backend to make requests to the frontend.
-The fd is provided via ``VHOST_USER_SET_SLAVE_REQ_FD`` ancillary data.
+The fd is provided via ``VHOST_USER_SET_BACKEND_REQ_FD`` ancillary data.
-A backend may then send ``VHOST_USER_SLAVE_*`` messages to the frontend
+A backend may then send ``VHOST_USER_BACKEND_*`` messages to the frontend
using this fd communication channel.
-If ``VHOST_USER_PROTOCOL_F_SLAVE_SEND_FD`` protocol feature is
+If ``VHOST_USER_PROTOCOL_F_BACKEND_SEND_FD`` protocol feature is
negotiated, backend can send file descriptors (at most 8 descriptors in
each message) to frontend via ancillary data using this fd communication
channel.
@@ -798,7 +798,7 @@ Note that due to the fact that too many messages on the sockets can
cause the sending application(s) to block, it is not advised to use
this feature unless absolutely necessary. It is also considered an
error to negotiate this feature without also negotiating
-``VHOST_USER_PROTOCOL_F_SLAVE_REQ`` and ``VHOST_USER_PROTOCOL_F_REPLY_ACK``,
+``VHOST_USER_PROTOCOL_F_BACKEND_REQ`` and ``VHOST_USER_PROTOCOL_F_REPLY_ACK``,
the former is necessary for getting a message channel from the backend
to the frontend, while the latter needs to be used with the in-band
notification messages to block until they are processed, both to avoid
@@ -818,12 +818,12 @@ Protocol features
#define VHOST_USER_PROTOCOL_F_RARP 2
#define VHOST_USER_PROTOCOL_F_REPLY_ACK 3
#define VHOST_USER_PROTOCOL_F_MTU 4
- #define VHOST_USER_PROTOCOL_F_SLAVE_REQ 5
+ #define VHOST_USER_PROTOCOL_F_BACKEND_REQ 5
#define VHOST_USER_PROTOCOL_F_CROSS_ENDIAN 6
#define VHOST_USER_PROTOCOL_F_CRYPTO_SESSION 7
#define VHOST_USER_PROTOCOL_F_PAGEFAULT 8
#define VHOST_USER_PROTOCOL_F_CONFIG 9
- #define VHOST_USER_PROTOCOL_F_SLAVE_SEND_FD 10
+ #define VHOST_USER_PROTOCOL_F_BACKEND_SEND_FD 10
#define VHOST_USER_PROTOCOL_F_HOST_NOTIFIER 11
#define VHOST_USER_PROTOCOL_F_INFLIGHT_SHMFD 12
#define VHOST_USER_PROTOCOL_F_RESET_DEVICE 13
@@ -1023,8 +1023,8 @@ reply is sent by the backend.
in the ancillary data. This signals that polling will be used
instead of waiting for the call. Note that if the protocol features
``VHOST_USER_PROTOCOL_F_INBAND_NOTIFICATIONS`` and
- ``VHOST_USER_PROTOCOL_F_SLAVE_REQ`` have been negotiated this message
- isn't necessary as the ``VHOST_USER_SLAVE_VRING_CALL`` message can be
+ ``VHOST_USER_PROTOCOL_F_BACKEND_REQ`` have been negotiated this message
+ isn't necessary as the ``VHOST_USER_BACKEND_VRING_CALL`` message can be
used, it may however still be used to set an event file descriptor
or to enable polling.
@@ -1041,8 +1041,8 @@ reply is sent by the backend.
invalid FD flag. This flag is set when there is no file descriptor
in the ancillary data. Note that if the protocol features
``VHOST_USER_PROTOCOL_F_INBAND_NOTIFICATIONS`` and
- ``VHOST_USER_PROTOCOL_F_SLAVE_REQ`` have been negotiated this message
- isn't necessary as the ``VHOST_USER_SLAVE_VRING_ERR`` message can be
+ ``VHOST_USER_PROTOCOL_F_BACKEND_REQ`` have been negotiated this message
+ isn't necessary as the ``VHOST_USER_BACKEND_VRING_ERR`` message can be
used, it may however still be used to set an event file descriptor
(which will be preferred over the message).
@@ -1103,7 +1103,7 @@ reply is sent by the backend.
respond with zero in case the specified MTU is valid, or non-zero
otherwise.
-``VHOST_USER_SET_SLAVE_REQ_FD``
+``VHOST_USER_SET_BACKEND_REQ_FD``
:id: 21
:equivalent ioctl: N/A
:request payload: N/A
@@ -1114,7 +1114,7 @@ reply is sent by the backend.
This request should be sent only when
``VHOST_USER_F_PROTOCOL_FEATURES`` has been negotiated, and protocol
- feature bit ``VHOST_USER_PROTOCOL_F_SLAVE_REQ`` bit is present in
+ feature bit ``VHOST_USER_PROTOCOL_F_BACKEND_REQ`` bit is present in
``VHOST_USER_GET_PROTOCOL_FEATURES``. If
``VHOST_USER_PROTOCOL_F_REPLY_ACK`` is negotiated, the backend must
respond with zero for success, non-zero otherwise.
@@ -1377,7 +1377,7 @@ Back-end message types
For this type of message, the request is sent by the backend and the reply
is sent by the frontend.
-``VHOST_USER_SLAVE_IOTLB_MSG``
+``VHOST_USER_BACKEND_IOTLB_MSG``
:id: 1
:equivalent ioctl: N/A (equivalent to ``VHOST_IOTLB_MSG`` message type)
:request payload: ``struct vhost_iotlb_msg``
@@ -1392,7 +1392,7 @@ is sent by the frontend.
``VIRTIO_F_IOMMU_PLATFORM`` feature has been successfully
negotiated.
-``VHOST_USER_SLAVE_CONFIG_CHANGE_MSG``
+``VHOST_USER_BACKEND_CONFIG_CHANGE_MSG``
:id: 2
:equivalent ioctl: N/A
:request payload: N/A
@@ -1407,7 +1407,7 @@ is sent by the frontend.
``VHOST_USER_NEED_REPLY`` flag, the frontend must respond with zero when
operation is successfully completed, or non-zero otherwise.
-``VHOST_USER_SLAVE_VRING_HOST_NOTIFIER_MSG``
+``VHOST_USER_BACKEND_VRING_HOST_NOTIFIER_MSG``
:id: 3
:equivalent ioctl: N/A
:request payload: vring area description
@@ -1430,7 +1430,7 @@ is sent by the frontend.
``VHOST_USER_PROTOCOL_F_HOST_NOTIFIER`` protocol feature has been
successfully negotiated.
-``VHOST_USER_SLAVE_VRING_CALL``
+``VHOST_USER_BACKEND_VRING_CALL``
:id: 4
:equivalent ioctl: N/A
:request payload: vring state description
@@ -1444,7 +1444,7 @@ is sent by the frontend.
The state.num field is currently reserved and must be set to 0.
-``VHOST_USER_SLAVE_VRING_ERR``
+``VHOST_USER_BACKEND_VRING_ERR``
:id: 5
:equivalent ioctl: N/A
:request payload: vring state description
--
2.26.2
next prev parent reply other threads:[~2021-03-11 10:39 UTC|newest]
Thread overview: 14+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-03-11 10:32 [PATCH v2 0/7] vhost: replace master/slave with more accurate wording Paolo Bonzini
2021-03-11 10:32 ` [PATCH 1/7] docs: vhost-user: clean up request/reply description Paolo Bonzini
2021-03-11 10:32 ` [PATCH 2/7] docs: vhost-user: rewrite section on ring state machine Paolo Bonzini
2021-03-11 10:32 ` [PATCH 3/7] docs: vhost-user: replace master/slave with frontend/backend Paolo Bonzini
2021-03-11 10:32 ` Paolo Bonzini [this message]
2021-03-11 10:32 ` [PATCH 5/7] vhost-user: rename message names from "SLAVE" to "BACKEND" Paolo Bonzini
2021-03-11 10:32 ` [PATCH 6/7] libvhost-user: " Paolo Bonzini
2021-03-11 10:32 ` [PATCH 7/7] libvhost-user: rename struct VuDev fields from "slave" to "backend" Paolo Bonzini
2021-03-11 10:45 ` [PATCH v2 0/7] vhost: replace master/slave with more accurate wording no-reply
2021-03-11 10:51 ` Marc-André Lureau
2021-03-11 11:08 ` Paolo Bonzini
2021-03-11 11:18 ` Marc-André Lureau
2021-03-11 11:27 ` Paolo Bonzini
2021-03-12 9:58 ` Stefano Garzarella
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20210311103250.532191-5-pbonzini@redhat.com \
--to=pbonzini@redhat.com \
--cc=marcandre.lureau@redhat.com \
--cc=mst@redhat.com \
--cc=qemu-devel@nongnu.org \
--cc=stefanha@redhat.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).