mirrors/qemu
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: avoid vhost-user-net specifics in multiqueue section

Browse Source 
The "Multiple queue support" section makes references to vhost-user-net
"queue pairs".  This is confusing for two reasons:
1. This actually applies to all device types, not just vhost-user-net.
2. VHOST_USER_GET_QUEUE_NUM returns the number of virtqueues, not the
   number of queue pairs.

Reword the section so that the vhost-user-net specific part is relegated
to the very end: we acknowledge that vhost-user-net historically
automatically enabled the first queue pair.

Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
Reviewed-by: Marc-André Lureau <marcandre.lureau@redhat.com>
Message-Id: <20190626074815.19994-5-stefanha@redhat.com>
Reviewed-by: Michael S. Tsirkin <mst@redhat.com>
Signed-off-by: Michael S. Tsirkin <mst@redhat.com>
This commit is contained in:
Stefan Hajnoczi 2019-06-26 08:48:15 +01:00 committed by Michael S. Tsirkin
parent ea1b802ca2
commit 3ef4dff2b3
1 changed files with 11 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
docs/interop/vhost-user.rst
View File

@ -324,19 +324,20 @@ must support changing some configuration aspects on the fly.
Multiple queue support Multiple queue support
---------------------- ----------------------
Multiple queue is treated as a protocol extension, hence the slave has Multiple queue support allows the slave to advertise the maximum number of
to implement protocol features first. The multiple queues feature is queues. This is treated as a protocol extension, hence the slave has to
supported only when the protocol feature ``VHOST_USER_PROTOCOL_F_MQ`` implement protocol features first. The multiple queues feature is supported
(bit 0) is set. only when the protocol feature ``VHOST_USER_PROTOCOL_F_MQ`` (bit 0) is set.
The max number of queue pairs the slave supports can be queried with The max number of queues the slave supports can be queried with message
message ``VHOST_USER_GET_QUEUE_NUM``. Master should stop when the ``VHOST_USER_GET_QUEUE_NUM``. Master should stop when the number of requested
number of requested queues is bigger than that. queues is bigger than that.
As all queues share one connection, the master uses a unique index for each As all queues share one connection, the master uses a unique index for each
queue in the sent message to identify a specified queue. One queue pair queue in the sent message to identify a specified queue.
is enabled initially. More queues are enabled dynamically, by sending
message ``VHOST_USER_SET_VRING_ENABLE``. The master enables queues by sending message ``VHOST_USER_SET_VRING_ENABLE``.
vhost-user-net has historically automatically enabled the first queue pair.
Migration Migration
--------- ---------