[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Qemu-devel] [PULL 14/16] docs: Add section for NVMe VFIO driver
From: |
Fam Zheng |
Subject: |
[Qemu-devel] [PULL 14/16] docs: Add section for NVMe VFIO driver |
Date: |
Thu, 8 Feb 2018 10:19:51 +0800 |
Signed-off-by: Fam Zheng <address@hidden>
Reviewed-by: Stefan Hajnoczi <address@hidden>
Message-Id: <address@hidden>
Signed-off-by: Fam Zheng <address@hidden>
---
docs/qemu-block-drivers.texi | 37 +++++++++++++++++++++++++++++++++++++
qemu-doc.texi | 1 +
2 files changed, 38 insertions(+)
diff --git a/docs/qemu-block-drivers.texi b/docs/qemu-block-drivers.texi
index 503c1847aa..cd74767ed3 100644
--- a/docs/qemu-block-drivers.texi
+++ b/docs/qemu-block-drivers.texi
@@ -785,6 +785,43 @@ warning: ssh server @code{ssh.example.com:22} does not
support fsync
With sufficiently new versions of libssh2 and OpenSSH, @code{fsync} is
supported.
address@hidden disk_images_nvme
address@hidden NVMe disk images
+
+NVM Express (NVMe) storage controllers can be accessed directly by a userspace
+driver in QEMU. This bypasses the host kernel file system and block layers
+while retaining QEMU block layer functionalities, such as block jobs, I/O
+throttling, image formats, etc. Disk I/O performance is typically higher than
+with @code{-drive file=/dev/sda} using either thread pool or linux-aio.
+
+The controller will be exclusively used by the QEMU process once started. To be
+able to share storage between multiple VMs and other applications on the host,
+please use the file based protocols.
+
+Before starting QEMU, bind the host NVMe controller to the host vfio-pci
+driver. For example:
+
address@hidden
+# modprobe vfio-pci
+# lspci -n -s 0000:06:0d.0
+06:0d.0 0401: 1102:0002 (rev 08)
+# echo 0000:06:0d.0 > /sys/bus/pci/devices/0000:06:0d.0/driver/unbind
+# echo 1102 0002 > /sys/bus/pci/drivers/vfio-pci/new_id
+
+# qemu-system-x86_64 -drive
file=nvme://@var{host}:@var{bus}:@address@hidden/@var{namespace}
address@hidden example
+
+Alternative syntax using properties:
+
address@hidden
+qemu-system-x86_64 -drive
file.driver=nvme,address@hidden:@var{bus}:@address@hidden,address@hidden
address@hidden example
+
address@hidden:@var{bus}:@address@hidden is the NVMe controller's PCI device
+address on the host.
+
address@hidden is the NVMe namespace number, starting from 1.
+
@node disk_image_locking
@subsection Disk image file locking
diff --git a/qemu-doc.texi b/qemu-doc.texi
index 19a82bfea3..769968aba4 100644
--- a/qemu-doc.texi
+++ b/qemu-doc.texi
@@ -621,6 +621,7 @@ encrypted disk images.
* disk_images_iscsi:: iSCSI LUNs
* disk_images_gluster:: GlusterFS disk images
* disk_images_ssh:: Secure Shell (ssh) disk images
+* disk_images_nvme:: NVMe userspace driver
* disk_image_locking:: Disk image file locking
@end menu
--
2.14.3
- [Qemu-devel] [PULL 04/16] coroutine-lock: convert CoQueue to use QemuLockable, (continued)
- [Qemu-devel] [PULL 04/16] coroutine-lock: convert CoQueue to use QemuLockable, Fam Zheng, 2018/02/07
- [Qemu-devel] [PULL 03/16] lockable: add QemuLockable, Fam Zheng, 2018/02/07
- [Qemu-devel] [PULL 05/16] coroutine-lock: make qemu_co_enter_next thread-safe, Fam Zheng, 2018/02/07
- [Qemu-devel] [PULL 06/16] curl: convert to CoQueue, Fam Zheng, 2018/02/07
- [Qemu-devel] [PULL 07/16] stubs: Add stubs for ram block API, Fam Zheng, 2018/02/07
- [Qemu-devel] [PULL 08/16] util: Introduce vfio helpers, Fam Zheng, 2018/02/07
- [Qemu-devel] [PULL 10/16] block: Introduce buf register API, Fam Zheng, 2018/02/07
- [Qemu-devel] [PULL 12/16] qemu-img: Map bench buffer, Fam Zheng, 2018/02/07
- [Qemu-devel] [PULL 11/16] block/nvme: Implement .bdrv_(un)register_buf, Fam Zheng, 2018/02/07
- [Qemu-devel] [PULL 09/16] block: Add VFIO based NVMe driver, Fam Zheng, 2018/02/07
- [Qemu-devel] [PULL 14/16] docs: Add section for NVMe VFIO driver,
Fam Zheng <=
- [Qemu-devel] [PULL 15/16] qapi: Add NVMe driver options to the schema, Fam Zheng, 2018/02/07
- [Qemu-devel] [PULL 13/16] block: Move NVMe constants to a separate header, Fam Zheng, 2018/02/07
- [Qemu-devel] [PULL 16/16] docs: Add docs/devel/testing.rst, Fam Zheng, 2018/02/07
- Re: [Qemu-devel] [PULL 00/16] Docker and block patches, Peter Maydell, 2018/02/08