Re: [Qemu-devel] [PATCH v10 16/18] Add vhost-user protocol documentation

[Eric Blake]

On 05/27/2014 06:06 AM, Nikolay Nikolaev wrote:
> This document describes the basic message format used by vhost-user
> for communication over a unix domain socket. The protocol is based
> on the existing ioctl interface used for the kernel version of vhost.
> 
> Signed-off-by: Antonios Motakis <address@hidden>
> Signed-off-by: Nikolay Nikolaev <address@hidden>
> ---
>  docs/specs/vhost-user.txt |  261 
> +++++++++++++++++++++++++++++++++++++++++++++
>  1 file changed, 261 insertions(+)
>  create mode 100644 docs/specs/vhost-user.txt
> 
> diff --git a/docs/specs/vhost-user.txt b/docs/specs/vhost-user.txt
> new file mode 100644
> index 0000000..e7f43f5
> --- /dev/null
> +++ b/docs/specs/vhost-user.txt
> @@ -0,0 +1,261 @@
> +Vhost-user Protocol

Pre-existing problem throughout this directory, but it might be nice to
assert copyright and assign a license to this file.


> +
> +The protocol defines 2 sides of the communication, master and slave. Master 
> is
> +the application that shares it's virtqueues, in our case QEMU. Slave is the

s/it's/its/ (remember, "it's" only works if "it is" could be used in the
same context)

> +consumer of the virtqueues.
> +
> +In the current implementation QEMU is the Master, and the Slave is intended 
> to
> +be a software ethernet switch running in user space, such as Snabbswitch.

s/ethernet/Ethernet/

> +Communication
> +-------------
> +
> +The protocol for vhost-user is based on the existing implementation of vhost
> +for the Linux Kernel. Most messages that can be send via the Unix domain 
> socket

s/send/sent/

-- 
Eric Blake   eblake redhat com    +1-919-301-3266
Libvirt virtualization library http://libvirt.org

signature.asc
Description: OpenPGP digital signature