diff options
| author | Thanos Makatos <thanos.makatos@nutanix.com> | 2021-12-01 10:45:25 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-12-01 10:45:25 +0000 |
| commit | 96b3d14160ee20bfc59d29383ffdabacf2f77bdf (patch) | |
| tree | d8eb43f50b38cbb55eb51b7a20ae1fb89244dcba /docs | |
| parent | f2dd09649e31540996fa4e9497693d1b27bc88fe (diff) | |
| download | libvfio-user-96b3d14160ee20bfc59d29383ffdabacf2f77bdf.zip libvfio-user-96b3d14160ee20bfc59d29383ffdabacf2f77bdf.tar.gz libvfio-user-96b3d14160ee20bfc59d29383ffdabacf2f77bdf.tar.bz2 | |
add SPDK instructions (#632)
And move them to separate file.
Signed-off-by: Thanos Makatos <thanos.makatos@nutanix.com>
Reviewed-by: John Levon <john.levon@nutanix.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/spdk.md | 61 |
1 files changed, 61 insertions, 0 deletions
diff --git a/docs/spdk.md b/docs/spdk.md new file mode 100644 index 0000000..4ae4a88 --- /dev/null +++ b/docs/spdk.md @@ -0,0 +1,61 @@ +SPDK and libvfio-user +===================== + +[SPDK v21.01](https://github.com/spdk/spdk/releases/tag/v21.01) added +experimental support for a virtual NVMe controller called nvmf/vfio-user. The +controller can be used with the same QEMU command line as the one used for +GPIO. + +Use Oracle's QEMU d377d483f9 from https://github.com/oracle/qemu: + + git clone https://github.com/oracle/qemu qemu-orcl + cd qemu-ocrl + git submodule update --init --recursive + ./configure --enable-multiprocess + make + +Use SPDK 72a5fa139: + + git clone https://github.com/spdk/spdk + cd spdk + git submodule update --init --recursive + ./configure --with-vfio-user + make + +Start SPDK: + + LD_LIBRARY_PATH=build/lib:dpdk/build/lib build/bin/nvmf_tgt & + +Create an NVMe controller with a 512MB RAM-based namespace: + + rm -f /var/run/{cntrl,bar0} + scripts/rpc.py nvmf_create_transport -t VFIOUSER && \ + scripts/rpc.py bdev_malloc_create 512 512 -b Malloc0 && \ + scripts/rpc.py nvmf_create_subsystem nqn.2019-07.io.spdk:cnode0 -a -s SPDK0 && \ + scripts/rpc.py nvmf_subsystem_add_ns nqn.2019-07.io.spdk:cnode0 Malloc0 && \ + scripts/rpc.py nvmf_subsystem_add_listener nqn.2019-07.io.spdk:cnode0 -t VFIOUSER -a /var/run -s 0 + +Start the guest with e.g. 4 GB of RAM: + + qemu-orcl/build/qemu-system-x86_64 ... \ + -m 4G -object memory-backend-file,id=mem0,size=4G,mem-path=/dev/hugepages,share=on,prealloc=yes -numa node,memdev=mem0 \ + -device vfio-user-pci,socket=/var/run/cntrl + + +libvirt +------- + +To use the nvmf/vfio-user target with a libvirt quest, in addition to the +libvirtd configuration documented in the [README](../README.md) the guest RAM must +be backed by hugepages: + + <memoryBacking> + <hugepages> + <page size='2048' unit='KiB'/> + </hugepages> + <source type='memfd'/> + <access mode='shared'/> + </memoryBacking> + +Because SPDK must be run as root, either fix the vfio-user socket permissions +or configure libvirt to run QEMU as root. |