vmsilo fork of vhost rust libraries
Find a file
Keiichi Watanabe 4757091c61 vhost_user: Allow clippy::upper_case_acronyms
Allow enum names whose characters are all upper case such as `NOOP`.
This change is needed to uprev bump rust-vmm-ci's version at #46.

Signed-off-by: Keiichi Watanabe <keiichiw@chromium.org>
2021-06-22 13:06:10 +02:00
.buildkite Add custom pipeline yaml for wider clippy coverage 2021-05-18 16:01:08 +08:00
.cargo fix link issues on aarch64 musl 2020-09-04 17:59:53 +03:00
.github Upgrade to GitHub-native Dependabot 2021-05-11 16:44:51 +03:00
docs Prepare for publishing to crates.io 2021-03-01 12:50:56 +01:00
rust-vmm-ci@24d66cdae6 build(deps): bump rust-vmm-ci from ebc7016 to 24d66cd 2021-03-18 14:17:10 +00:00
src vhost_user: Allow clippy::upper_case_acronyms 2021-06-22 13:06:10 +02:00
.gitignore Update .gitignore file 2021-03-01 12:50:56 +01:00
.gitmodules Switch to rust-vmm-ci for the CI 2020-09-04 17:59:53 +03:00
Cargo.toml vhost_user: Add Inflight I/O tracking support 2021-06-11 13:51:37 +02:00
CODEOWNERS Prepare for publishing to crates.io 2021-03-01 12:50:56 +01:00
coverage_config_aarch64.json Switch to rust-vmm-ci for the CI 2020-09-04 17:59:53 +03:00
coverage_config_x86_64.json vhost_user: Add Inflight I/O tracking support 2021-06-11 13:51:37 +02:00
LICENSE Initial commit 2019-04-03 14:38:29 +08:00
LICENSE-BSD-3-Clause Add license files for BSD-Alibaba, BSD-Google 2020-09-04 17:59:53 +03:00
LICENSE-BSD-Chromium Add license files for BSD-Alibaba, BSD-Google 2020-09-04 17:59:53 +03:00
README.md Prepare for publishing to crates.io 2021-03-01 12:50:56 +01:00

vHost

A pure rust library for vDPA, vhost and vhost-user.

The vhost crate aims to help implementing dataplane for virtio backend drivers. It supports three different types of dataplane drivers:

  • vhost: the dataplane is implemented by linux kernel
  • vhost-user: the dataplane is implemented by dedicated vhost-user servers
  • vDPA(vhost DataPath Accelerator): the dataplane is implemented by hardwares

The main relationship among Traits and Structs exported by the vhost crate is as below:

vhost Architecture

Kernel-based vHost Backend Drivers

The vhost drivers in Linux provide in-kernel virtio device emulation. Normally the hypervisor userspace process emulates I/O accesses from the guest. Vhost puts virtio emulation code into the kernel, taking hypervisor userspace out of the picture. This allows device emulation code to directly call into kernel subsystems instead of performing system calls from userspace. The hypervisor relies on ioctl based interfaces to control those in-kernel vhost drivers, such as vhost-net, vhost-scsi and vhost-vsock etc.

vHost-user Backend Drivers

The vhost-user protocol aims to implement vhost backend drivers in userspace, which complements the ioctl interface used to control the vhost implementation in the Linux kernel. It implements the control plane needed to establish virtqueue sharing with a user space process on the same host. It uses communication over a Unix domain socket to share file descriptors in the ancillary data of the message.

The protocol defines two sides of the communication, master and slave. Master is the application that shares its virtqueues, slave is the consumer of the virtqueues. Master and slave can be either a client (i.e. connecting) or server (listening) in the socket communication.