mirror of https://github.com/rust-vmm/vhost-device.git synced 2025-12-27 15:45:44 +00:00

Go to file

Alex Bennée a8ce1ec2e0 gpio: introduce "mock_gpio" let cfg drive device type Now we have our plumbing in place we can separate the starting of the device backend into a new function and call appropriately. As the config is no longer parsed inside start_backend we can ensure we pass any errors up rather than blindly unwrapping. We can drop DeviceUnimplemented as we can't build a version where this happens. Signed-off-by: Alex Bennée <alex.bennee@linaro.org>		2023-10-09 11:36:59 +01:00
.cargo	Ignore advisory: RUSTSEC-2021-0145	2022-11-30 12:01:14 +05:30
.github	dependabot: enable update grouping	2023-10-06 12:58:11 +05:30
crates	gpio: introduce "mock_gpio" let cfg drive device type	2023-10-09 11:36:59 +01:00
rust-vmm-ci@9751aaa0d0	build(deps): bump rust-vmm-ci from `665f31f` to `9751aaa`	2023-10-03 09:03:40 +05:30
.gitignore	Add .gitignore	2021-08-19 09:52:14 +03:00
.gitmodules	Initial commit	2021-05-26 10:18:40 +03:00
Cargo.lock	build(deps): bump the vhost-device group with 3 updates	2023-10-09 10:52:26 +05:30
Cargo.toml	Prepend vhost-device- to crate directories	2023-09-26 18:57:55 +05:30
CODEOWNERS	CODEOWNERS: add stefano-garzarella	2022-10-13 09:41:24 +02:00
coverage_config_x86_64.json	tests: adjust code coverage after tool updates	2023-09-13 15:58:52 +01:00
LICENSE-APACHE	Initial commit	2021-05-26 10:18:40 +03:00
LICENSE-BSD-3-Clause	Add BSD-3-Clause license for the crates	2022-10-27 11:19:40 -06:00
README.md	Prepend vhost-device- to crate directories	2023-09-26 18:57:55 +05:30

README.md

vhost-device

Design

This repository hosts various 'vhost-user' device backends in their own crates. See their individual README.md files for specific information about those crates.

Here is the list of device backends that we support:

Testing and Code Coverage

Like the wider rust-vmm project we expect new features to come with comprehensive code coverage. However as a multi-binary repository there are cases where avoiding a drop in coverage can be hard and an exception to the approach is allowable. These are:

adding a new binary target (aim at least 60% overall coverage)
expanding the main function (a small drop is acceptable)

However any new feature added to an existing binary should not cause a drop in coverage. The general aim should be to always improve coverage.

Separation of Concerns

The binaries built by this repository can be run with any VMM which can act as a vhost-user frontend. Typically they have been tested with QEMU although the rust-vmm project does provide a vhost-user frontend crate for rust based VMMs.

While it's possible to implement all parts of the backend inside the vhost-device workspace consideration should be given to separating the VirtQueue handling and response logic to a crate in vm-virtio devices. This way a monolithic rust-vmm VMM implementation can reuse the core logic to service the virtio requests directly in the application.

Build dependency

The GPIO crate needs a local installation of libgpiod library to be available. If your distro ships libgpiod >= v2.0, then you should be fine.

Otherwise, you will need to build libgpiod yourself:

git clone --depth 1 --branch v2.0.x https://git.kernel.org/pub/scm/libs/libgpiod/libgpiod.git/
cd libgpiod
./autogen.sh --prefix="$PWD/install/"
make install

In order to inform tools about the build location, you can now set:

export PKG_CONFIG_PATH="<PATH-TO-LIBGPIOD>/install/lib/pkgconfig/"

To prevent setting this in every terminal session, you can also configure cargo to set it automatically.

Xen support

Supporting Xen requires special handling while mapping the guest memory. The vm-memory crate implements xen memory mapping support via a separate feature xen, and this crate uses the same feature name to enable Xen support.

It was decided by the rust-vmm maintainers to keep the interface simple and build the crate for either standard Unix memory mapping or Xen, and not both.