[0/3] Document SHMEM vhost-user requests

Message

Albert Esteve Sept. 12, 2024, 2:44 p.m. UTC

As a continuation of the
"Add SHMEM_MAP/UNMAP requests" patch [1],
I wanted to split vhost-user spec
parts into a separate patch, so that
it could be reviewed and integrated
separately. Having the specs upstreamed
would help others to add support for
these new vhost-user requests on
their systems.

This is such documentation-only patch.

[1] - https://lore.kernel.org/all/[e-mail]/T/

Albert Esteve (3):
  vhost_user.rst: Add SHMEM_MAP/_UNMAP to spec
  vhost_user.rst: Align VhostUserMsg excerpt members
  vhost_user.rst: Add GET_SHMEM_CONFIG message

 docs/interop/vhost-user.rst | 72 +++++++++++++++++++++++++++++++++++++
 1 file changed, 72 insertions(+)

Comments

Albert Esteve Sept. 12, 2024, 2:57 p.m. UTC | #1

Link to the implementation:
https://lore.kernel.org/all/[e-mail]/T/#t


On Thu, Sep 12, 2024 at 4:44 PM Albert Esteve <[e-mail]> wrote:

> As a continuation of the
> "Add SHMEM_MAP/UNMAP requests" patch [1],
> I wanted to split vhost-user spec
> parts into a separate patch, so that
> it could be reviewed and integrated
> separately. Having the specs upstreamed
> would help others to add support for
> these new vhost-user requests on
> their systems.
>
> This is such documentation-only patch.
>
> [1] -
> https://lore.kernel.org/all/[e-mail]/T/
>
> Albert Esteve (3):
>   vhost_user.rst: Add SHMEM_MAP/_UNMAP to spec
>   vhost_user.rst: Align VhostUserMsg excerpt members
>   vhost_user.rst: Add GET_SHMEM_CONFIG message
>
>  docs/interop/vhost-user.rst | 72 +++++++++++++++++++++++++++++++++++++
>  1 file changed, 72 insertions(+)
>
> --
> 2.45.2
>
>

Stefan Hajnoczi Sept. 16, 2024, 4:55 p.m. UTC | #2

On Thu, Sep 12, 2024 at 04:44:29PM +0200, Albert Esteve wrote:
> As a continuation of the
> "Add SHMEM_MAP/UNMAP requests" patch [1],
> I wanted to split vhost-user spec
> parts into a separate patch, so that
> it could be reviewed and integrated
> separately. Having the specs upstreamed
> would help others to add support for
> these new vhost-user requests on
> their systems.
> 
> This is such documentation-only patch.

The spec changes do not mention that exposing VIRTIO Shared Memory
Regions can lead to problems when other vhost-user devices attempt to
access those memory addresses. Please either introduce MEM_READ/WRITE
and explain its use or document that front-ends must forward mappings to
back-ends so that VIRTIO Shared Memory Regions can be accessed.

> 
> [1] - https://lore.kernel.org/all/[e-mail]/T/
> 
> Albert Esteve (3):
>   vhost_user.rst: Add SHMEM_MAP/_UNMAP to spec
>   vhost_user.rst: Align VhostUserMsg excerpt members
>   vhost_user.rst: Add GET_SHMEM_CONFIG message
> 
>  docs/interop/vhost-user.rst | 72 +++++++++++++++++++++++++++++++++++++
>  1 file changed, 72 insertions(+)
> 
> -- 
> 2.45.2
>