cloud-hypervisor/docs/vfio-user.md

1 # Cloud Hypervisor VFIO-user HOWTO
3 …-user is an *experimental* protocol for allowing devices to be implemented in another process and …
5 The protocol is documented here: https://github.com/nutanix/libvfio-user/blob/master/docs/vfio-user…
7 …*. Not all Cloud Hypervisor functionality is supported in particular: virtio-mem and iommu are not…
11 …--user-device socket=<path>` parameter is used to create a vfio-user device when creating the VM s…
13 ## Example (GPIO device)
15 There is a simple GPIO device included in the libvfio-user repository: https://github.com/nutanix/l…
17 Run the example from the libvfio-user repository:
20 rm /tmp/vfio-user.sock
21 ./build/dbg/samples/gpio-pci-idio-16 -v /tmp/vfio-user.sock &
27 target/debug/cloud-hypervisor \
28     --memory size=1G,shared=on \
29     --disk path=~/images/focal-server-cloudimg-amd64.raw \
30     --kernel ~/src/linux/vmlinux \
31     --cmdline "root=/dev/vda1 console=hvc0" \
32     --user-device socket=/tmp/vfio-user.sock
35 Inside the VM you can test the device with:
42 ## Example (NVMe device)
46 Compile with `./configure --with-vfio-user`
48 Create an NVMe controller listening on a vfio-user socket with a simple AIO block device in spdk.
50 More details of setting SPDK NVMe-oF target can be viewed in [SDPK NVMe-oF tgt](https://spdk.io/doc…
54 rm ~/images/test-disk.raw
55 truncate ~/images/test-disk.raw -s 128M
56 mkfs.ext4  ~/images/test-disk.raw
58 sudo ./build/bin/nvmf_tgt -i 0 -e 0xFFFF -m 0x1 &
60 sudo ./scripts/rpc.py nvmf_create_transport -t VFIOUSER
61 sudo rm -rf /tmp/nvme-vfio-user
62 sudo mkdir -p /tmp/nvme-vfio-user
63 sudo ./scripts/rpc.py bdev_aio_create ~/images/test-disk.raw test 512
64 sudo ./scripts/rpc.py nvmf_create_subsystem nqn.2019-07.io.spdk:cnode -a -s test
65 sudo ./scripts/rpc.py nvmf_subsystem_add_ns nqn.2019-07.io.spdk:cnode test
66 …ripts/rpc.py nvmf_subsystem_add_listener nqn.2019-07.io.spdk:cnode -t VFIOUSER -a /tmp/nvme-vfio-u…
67 sudo chown $USER.$USER -R /tmp/nvme-vfio-user
73 target/debug/cloud-hypervisor \
74     --memory size=1G,shared=on \
75     --disk path=~/images/focal-server-cloudimg-amd64.raw \
76     --kernel ~/src/linux/vmlinux \
77     --cmdline "root=/dev/vda1 console=hvc0" \
78     --user-device socket=/tmp/nvme-vfio-user/cntrl