From 31bc5998bba8115cebffdaf80286aa882513daf6 Mon Sep 17 00:00:00 2001 From: Keiichi Watanabe Date: Wed, 8 Dec 2021 01:09:33 +0900 Subject: [PATCH] devices: vhost: user: Add README BUG=none TEST=none Change-Id: I6a7b27c5dbb44d417ff9e0e7b213403efee92ec5 Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/crosvm/+/3320905 Auto-Submit: Keiichi Watanabe Tested-by: kokoro Reviewed-by: Chirantan Ekbote Commit-Queue: Chirantan Ekbote --- devices/src/virtio/vhost/user/README.md | 34 +++++++++++++++++++++++++ 1 file changed, 34 insertions(+) create mode 100644 devices/src/virtio/vhost/user/README.md diff --git a/devices/src/virtio/vhost/user/README.md b/devices/src/virtio/vhost/user/README.md new file mode 100644 index 0000000000..b22731025f --- /dev/null +++ b/devices/src/virtio/vhost/user/README.md @@ -0,0 +1,34 @@ +# Vhost-user devices + +This directory contains the implementation of [vhost-user] devices and +[virtio vhost-user] devices. + +## Code Locations + +* [`vmm`](./vmm/) - Implements vhost-user vmm device; i.e. vhost-user master. +* [`device`](./device/) - Implements vhost-user device backend; i.e. + vhost-user slave. +* [`proxy.rs`](./proxy.rs) - Implements [virtio vhost-user] device, which + works like a proxy forwarding vhost-user messages to the guest via + virtqueues. + +## Usage + +### Vhost-user + +First, start a vhost-user device with the `crosvm device` command. Here we use +the block device as an example, but the basic usage is same for all of devices. + +```bash +$ crosvm device block --socket /path/to/socket --file /path/to/block.img +``` + +Then start a VM with a vhost-user block device by specifying the same socket +path . + +```bash +$ crosvm run -r rootfs.img --vhost-user-blk /path/to/socket +``` + +[vhost-user]: https://qemu.readthedocs.io/en/latest/interop/vhost-user.html +[virtio vhost-user]: https://wiki.qemu.org/Features/VirtioVhostUser