diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 32 |
1 files changed, 0 insertions, 32 deletions
diff --git a/README.md b/README.md deleted file mode 100644 index b0f4dfa..0000000 --- a/README.md +++ /dev/null @@ -1,32 +0,0 @@ -# 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: - - -## 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](https://qemu.readthedocs.io/en/latest/interop/vhost-user.html#communication) 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. |