bdev_virtio: specify limitations in README.md

Change-Id: Ifb913c85392eb7d9803726b40895906bdf2b3281
Signed-off-by: Dariusz Stojaczyk <dariuszx.stojaczyk@intel.com>
Reviewed-on: https://review.gerrithub.io/378616
Reviewed-by: Daniel Verkamp <daniel.verkamp@intel.com>
Tested-by: SPDK Automated Test System <sys_sgsw@intel.com>
Reviewed-by: Jim Harris <james.r.harris@intel.com>
This commit is contained in:
Dariusz Stojaczyk 2017-09-14 19:29:52 +02:00 committed by Jim Harris
parent 49934e252e
commit 9f2784ec21

View File

@ -1,15 +1,15 @@
# SPDK virtio bdev module # SPDK virtio bdev module
This directory contains an experimental SPDK virtio bdev module. This directory contains an experimental SPDK virtio bdev module.
It currently supports very basic enumeration capabilities for It currently supports very basic read/write operations for
virtio-scsi devices as well as read/write operations to any virtio-scsi drive. Currently it will only work with a single
SCSI LUNs discovered during enumeration. target with a single LUN.
It supports two different usage models: It supports two different usage models:
* PCI - This is the standard mode of operation when used in a guest virtual * PCI - This is the standard mode of operation when used in a guest virtual
machine, where QEMU has presented the virtio-scsi controller as a virtual machine, where QEMU has presented the virtio-scsi controller as a virtual
PCI device. The virtio-scsi controller might be implemented in the host OS PCI device. The virtio-scsi controller might be implemented in the host OS
by SPDK vhost-scsi, kernel vhost-scsi, or a QEMU virtio-scsi backend. by SPDK vhost-scsi. Kernel/QEMU vhost-scsi are not supported yet.
* User vhost - Can be used to connect to an SPDK vhost-scsi target running on * User vhost - Can be used to connect to an SPDK vhost-scsi target running on
the same host. the same host.
@ -20,8 +20,7 @@ every huge page explicitly, it is fairly limited on how many file descriptors
it can pass due to the VHOST_MEMORY_MAX_NREGIONS limit of 8. it can pass due to the VHOST_MEMORY_MAX_NREGIONS limit of 8.
Use the following configuration file snippet to enumerate a virtio-scsi PCI Use the following configuration file snippet to enumerate a virtio-scsi PCI
device and present its LUNs as bdevs. Currently it will only work with device and present its LUNs as bdevs.
a single PCI device.
~~~{.sh} ~~~{.sh}
[Virtio] [Virtio]