dsg/vhost
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
vmsilo fork of vhost rust libraries
106 commits 1 branch 42 tags 997 KiB
Find a file
Liu Jiang 14d754c5c7 Fix an error in license statement 
"Apache-2.0 or BSD-3-Clause" is not an valid license statement and is
rejected by cargo. So change it to "Apache-2.0 OR BSD-3-Clause".

Signed-off-by: Liu Jiang <gerry@linux.alibaba.com>
2021-08-06 10:23:50 +02:00
.buildkite Prepare for release v0.1 2021-08-05 17:51:35 +02: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@a00c7d2f1b build(deps): bump rust-vmm-ci from 7693628 to a00c7d2 2021-08-03 09:50:08 +01:00
src Prepare for release v0.1 2021-08-05 17:51:35 +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 Fix an error in license statement 2021-08-06 10:23:50 +02:00
CHANGELOG.md Prepare for release v0.1 2021-08-05 17:51:35 +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 Fix set_log_base() implementation for vhost-user 2021-08-04 16:44:05 +08:00
LICENSE Initial commit 2019-04-03 14:38:29 +08:00
LICENSE-BSD-Google Prepare for release v0.1 2021-08-05 17:51:35 +02:00
README.md Prepare for publishing to crates.io 2021-03-01 12:50:56 +01:00

README.md

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.