kata-containers/cloud-hypervisor
1
0
Fork 0
mirror of https://github.com/cloud-hypervisor/cloud-hypervisor.git synced 2026-08-05 02:19:16 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: generic vhost-user: document

Browse Source 
Include documentation for the generic vhost-user device.

Signed-off-by: Demi Marie Obenour <demiobenour@gmail.com>
This commit is contained in:
Demi Marie Obenour
2026-02-04 09:47:38 -05:00
committed by Rob Bradford
parent d6b80d9845
commit 042d1abd67
3 changed files with 125 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
docs/device_model.md
View File

@@ -201,6 +201,24 @@ networking device (e.g. DPDK) into the VMM as their virtio network backend.
This device is always built-in, and it is enabled when `vhost_user=true` and
`socket` are provided to the `--net` parameter.
### vhost-user-generic
This is a generic vhost-user device. The main use case is to provide a
vhost-user device that Cloud Hypervisor doesn't support natively. However,
there is nothing preventing its use for devices that Cloud Hypervisor does
support. For instance, the tag of a virtio-fs device can be set on the
virtiofsd command line, whereas the built-in virtio-fs support
requires the tag to be set in Cloud Hypervisor's command line.
If the backend negotiates the `VHOST_USER_PROTOCOL_F_CONFIG` feature,
all configuration space access will be handled by it. Otherwise,
writes will be ignored and reads will return 0xFF. Cloud Hypervisor
warns if this happens.
This device is always built-in, and it is enabled when the
`--generic-vhost-user` flag is passed.
See [the generic vhost-user documentation](generic-vhost-user.md) for more details.
## VFIO
VFIO (Virtual Function I/O) is a kernel framework that exposes direct device