vfio-user client
cover vfio-user client
The series contains an implement of a vfio-user client in QEMU, along with a few more preparatory patches.
The vfio-user protocol allows for implementing (PCI) devices in another userspace process; SPDK is one example, which includes a virtual NVMe implementation.
The vfio-user framework consists of 3 parts:
1) The VFIO user protocol specification.
2) A client - the VFIO device in QEMU that encapsulates VFIO messages and sends them to the server.
3) A server - a remote process that emulates a device.
This patchset implements parts 1 and 2.
It has been tested against libvfio-user test servers as well as SPDK.
A previous version of this series can be found at
https://lore.kernel.org/all/[email protected]/T/
(I've reset the version as it has changed significantly.)
thanks
john
John Levon (25):
vfio/container: pass MemoryRegion to DMA operations
vfio: move more cleanup into vfio_pci_put_device()
vfio: move config space read into vfio_pci_config_setup()
vfio: refactor out IRQ signalling setup
vfio: enable per-IRQ MSI-X masking
vfio: add per-region fd support
vfio: mark posted writes in region write callbacks
vfio-user: add vfio-user class and container
vfio-user: connect vfio proxy to remote server
vfio-user: implement message receive infrastructure
vfio-user: implement message send infrastructure
vfio-user: implement VFIO_USER_DEVICE_GET_INFO
vfio-user: implement VFIO_USER_DEVICE_GET_REGION_INFO
vfio-user: implement VFIO_USER_REGION_READ/WRITE
vfio-user: set up PCI in vfio_user_pci_realize()
vfio-user: implement VFIO_USER_DEVICE_GET/SET_IRQ*
vfio-user: forward MSI-X PBA BAR accesses to server
vfio-user: set up container access to the proxy
vfio-user: implement VFIO_USER_DEVICE_RESET
vfio-user: implement VFIO_USER_DMA_MAP/UNMAP
vfio-user: implement VFIO_USER_DMA_READ/WRITE
vfio-user: add 'x-msg-timeout' option
vfio-user: support posted writes
vfio-user: add coalesced posted writes
docs: add vfio-user documentation
Steve Sistare (1):
vfio: return mr from vfio_get_xlat_addr
Thanos Makatos (1):
vfio-user: introduce vfio-user protocol specification
MAINTAINERS | 10 +- docs/devel/index-internals.rst | 1 + docs/devel/vfio-user.rst | 1522 +++++++++++++++++++++++++ docs/system/device-emulation.rst | 1 + docs/system/devices/vfio-user.rst | 24 + meson.build | 1 + hw/vfio-user/container.h | 27 + hw/vfio-user/device.h | 27 + hw/vfio-user/protocol.h | 245 ++++ hw/vfio-user/proxy.h | 137 +++ hw/vfio-user/trace.h | 1 + hw/vfio/pci.h | 16 + include/hw/vfio/vfio-container-base.h | 5 +- include/hw/vfio/vfio-device.h | 15 +- include/hw/vfio/vfio-region.h | 2 + include/system/memory.h | 16 +- hw/vfio-user/container.c | 348 ++++++ hw/vfio-user/device.c | 389 +++++++ hw/vfio-user/pci.c | 428 +++++++ hw/vfio-user/proxy.c | 1314 +++++++++++++++++++++ hw/vfio/container-base.c | 4 +- hw/vfio/container.c | 3 +- hw/vfio/device.c | 57 +- hw/vfio/iommufd.c | 3 +- hw/vfio/listener.c | 35 +- hw/vfio/pci.c | 163 ++- hw/vfio/region.c | 10 +- hw/virtio/vhost-vdpa.c | 8 +- system/memory.c | 25 +- hw/meson.build | 1 + hw/vfio-user/meson.build | 11 + hw/vfio-user/trace-events | 18 + meson_options.txt | 2 + scripts/meson-buildoptions.sh | 4 + 34 files changed, 4753 insertions(+), 120 deletions(-) create mode 100644 docs/devel/vfio-user.rst create mode 100644 docs/system/devices/vfio-user.rst create mode 100644 hw/vfio-user/container.h create mode 100644 hw/vfio-user/device.h create mode 100644 hw/vfio-user/protocol.h create mode 100644 hw/vfio-user/proxy.h create mode 100644 hw/vfio-user/trace.h create mode 100644 hw/vfio-user/container.c create mode 100644 hw/vfio-user/device.c create mode 100644 hw/vfio-user/pci.c create mode 100644 hw/vfio-user/proxy.c create mode 100644 hw/vfio-user/meson.build create mode 100644 hw/vfio-user/trace-events
Signature · 1 line
2.43.0
PATCH 1/27 vfio: return mr from vfio_get_xlat_addr
From: Steve Sistare <[email protected]>
Modify memory_get_xlat_addr and vfio_get_xlat_addr to return the memory region that the translated address is found in. This will be needed by CPR in a subsequent patch to map blocks using IOMMU_IOAS_MAP_FILE.
Also return the xlat offset, so we can simplify the interface by removing the out parameters that can be trivially derived from mr and xlat.
--- include/system/memory.h | 16 +++++++--------- hw/vfio/listener.c | 29 +++++++++++++++++++---------- hw/virtio/vhost-vdpa.c | 8 ++++++-- system/memory.c | 25 ++++--------------------- 4 files changed, 36 insertions(+), 42 deletions(-)
include/system/memory.h +7 -9
@@ -738,21 +738,19 @@ void ram_discard_manager_unregister_listener(RamDiscardManager *rdm, RamDiscardListener *rdl);/** -* memory_get_xlat_addr: Extract addresses from a TLB entry +* memory_get_xlat_addr: Extract addresses from a TLB entry. +* Called with rcu_read_lock held. * * @iotlb: pointer to an #IOMMUTLBEntry -* @vaddr: virtual address -* @ram_addr: RAM address -* @read_only: indicates if writes are allowed -* @mr_has_discard_manager: indicates memory is controlled by a -* RamDiscardManager +* @mr_p: return the MemoryRegion containing the @iotlb translated addr. +* The MemoryRegion must not be accessed after rcu_read_unlock. +* @xlat_p: return the offset of the entry from the start of @mr_p * @errp: pointer to Error*, to store an error if it happens. * * Return: true on success, else false setting @errp with error. */ -bool memory_get_xlat_addr (IOMMUTLBEntry *iotlb,void **vaddr, -ram_addr_t *ram_addr,bool *read_only, -bool *mr_has_discard_manager,Error **errp); +bool memory_get_xlat_addr (IOMMUTLBEntry *iotlb,MemoryRegion **mr_p, +hwaddr *xlat_p,Error **errp);typedef struct CoalescedMemoryRange CoalescedMemoryRange ;typedef struct MemoryRegionIoeventfd MemoryRegionIoeventfd ;
hw/vfio/listener.c +19 -10
@@ -90,16 +90,17 @@ static bool vfio_listener_skipped_section(MemoryRegionSection *section) section->offset_within_address_space & (1ULL <<63 ); } -/* Called with rcu_read_lock held. */ -static bool vfio_get_xlat_addr (IOMMUTLBEntry *iotlb,void **vaddr, -ram_addr_t *ram_addr,bool *read_only, -Error **errp) +/* +* Called with rcu_read_lock held. +* The returned MemoryRegion must not be accessed after calling rcu_read_unlock. +*/ +static bool vfio_get_xlat_addr (IOMMUTLBEntry *iotlb,MemoryRegion **mr_p, +hwaddr *xlat_p,Error **errp) { -bool ret, mr_has_discard_manager; +bool ret; - ret =memory_get_xlat_addr (iotlb, vaddr, ram_addr, read_only, - &mr_has_discard_manager, errp); -if (ret && mr_has_discard_manager) { + ret =memory_get_xlat_addr (iotlb, mr_p, xlat_p, errp); +if (ret &&memory_region_has_ram_discard_manager (*mr_p)) {/* * Malicious VMs might trigger discarding of IOMMU-mapped memory. The * pages will remain pinned inside vfio until unmapped, resulting in a
@@ -126,6 +127,8 @@ static void vfio_iommu_map_notify(IOMMUNotifier *n, IOMMUTLBEntry *iotlb)VFIOGuestIOMMU *giommu =container_of (n, VFIOGuestIOMMU, n);VFIOContainerBase *bcontainer = giommu->bcontainer;hwaddr iova = iotlb->iova + giommu->iommu_offset; +MemoryRegion *mr; +hwaddr xlat;void *vaddr;int ret;Error *local_err =NULL ;
@@ -150,10 +153,13 @@ static void vfio_iommu_map_notify(IOMMUNotifier *n, IOMMUTLBEntry *iotlb)if ((iotlb->perm &IOMMU_RW ) !=IOMMU_NONE ) {bool read_only; -if (!vfio_get_xlat_addr (iotlb, &vaddr,NULL , &read_only, &local_err)) { +if (!vfio_get_xlat_addr (iotlb, &mr, &xlat, &local_err)) {error_report_err (local_err); goto out; } + vaddr =memory_region_get_ram_ptr (mr) + xlat; + read_only = !(iotlb->perm &IOMMU_WO ) || mr->readonly; +/* * vaddr is only valid until rcu_read_unlock(). But after * vfio_dma_map has set up the mapping the pages will be
@@ -1010,6 +1016,8 @@ static void vfio_iommu_map_dirty_notify(IOMMUNotifier *n, IOMMUTLBEntry *iotlb)ram_addr_t translated_addr;Error *local_err =NULL ;int ret = -EINVAL ; +MemoryRegion *mr; +ram_addr_t xlat;trace_vfio_iommu_map_dirty_notify (iova, iova + iotlb->addr_mask);
@@ -1021,9 +1029,10 @@ static void vfio_iommu_map_dirty_notify(IOMMUNotifier *n, IOMMUTLBEntry *iotlb) }rcu_read_lock (); -if (!vfio_get_xlat_addr (iotlb,NULL , &translated_addr,NULL , &local_err)) { +if (!vfio_get_xlat_addr (iotlb, &mr, &xlat, &local_err)) { goto out_unlock; } + translated_addr =memory_region_get_ram_addr (mr) + xlat; ret =vfio_container_query_dirty_bitmap (bcontainer, iova, iotlb->addr_mask +1 , translated_addr, &local_err);
hw/virtio/vhost-vdpa.c +6 -2
@@ -209,6 +209,8 @@ static void vhost_vdpa_iommu_map_notify(IOMMUNotifier *n, IOMMUTLBEntry *iotlb)int ret;Int128 llend;Error *local_err =NULL ; +MemoryRegion *mr; +hwaddr xlat;if (iotlb->target_as != &address_space_memory) { error_report("Wrong target AS \"%s\", only system memory is allowed",
@@ -228,11 +230,13 @@ static void vhost_vdpa_iommu_map_notify(IOMMUNotifier *n, IOMMUTLBEntry *iotlb)if ((iotlb->perm &IOMMU_RW ) !=IOMMU_NONE ) {bool read_only; -if (!memory_get_xlat_addr (iotlb, &vaddr,NULL , &read_only,NULL , - &local_err)) { +if (!memory_get_xlat_addr (iotlb, &mr, &xlat, &local_err)) {error_report_err (local_err);return ; } + vaddr =memory_region_get_ram_ptr (mr) + xlat; + read_only = !(iotlb->perm &IOMMU_WO ) || mr->readonly; + ret =vhost_vdpa_dma_map (s,VHOST_VDPA_GUEST_PA_ASID , iova, iotlb->addr_mask +1 , vaddr, read_only);if (ret) {
system/memory.c +4 -21
@@ -2174,18 +2174,14 @@ void ram_discard_manager_unregister_listener(RamDiscardManager *rdm, }/* Called with rcu_read_lock held. */ -bool memory_get_xlat_addr (IOMMUTLBEntry *iotlb,void **vaddr, -ram_addr_t *ram_addr,bool *read_only, -bool *mr_has_discard_manager,Error **errp) +bool memory_get_xlat_addr (IOMMUTLBEntry *iotlb,MemoryRegion **mr_p, +hwaddr *xlat_p,Error **errp) {MemoryRegion *mr;hwaddr xlat;hwaddr len = iotlb->addr_mask +1 ;bool writable = iotlb->perm &IOMMU_WO ; -if (mr_has_discard_manager) { - *mr_has_discard_manager = false; - }/* * The IOMMU TLB entry we have just covers translation through * this IOMMU to its immediate target. We need to translate
@@ -2203,9 +2199,6 @@ bool memory_get_xlat_addr(IOMMUTLBEntry *iotlb, void **vaddr, .offset_within_region = xlat, .size = int128_make64(len), }; -if (mr_has_discard_manager) { - *mr_has_discard_manager = true; - }/* * Malicious VMs can map memory into the IOMMU, which is expected * to remain discarded. vfio will pin all pages, populating memory.
@@ -2229,18 +2222,8 @@ bool memory_get_xlat_addr(IOMMUTLBEntry *iotlb, void **vaddr,return false; } -if (vaddr) { - *vaddr =memory_region_get_ram_ptr (mr) + xlat; - } - -if (ram_addr) { - *ram_addr =memory_region_get_ram_addr (mr) + xlat; - } - -if (read_only) { - *read_only = !writable || mr->readonly; - } - + *xlat_p = xlat; + *mr_p = mr;return true; }
Signature · 1 line
2.43.0
Re: [PATCH 01/27] vfio: return mr from vfio_get_xlat_addr
Quoted 10 lines · John Levon
From: Steve Sistare <[email protected]>
Modify
memory_get_xlat_addrandvfio_get_xlat_addrto return the memory region that the translated address is found in. This will be needed by CPR in a subsequent patch to map blocks usingIOMMU_IOAS_MAP_FILE.Also return the xlat offset, so we can simplify the interface by removing the out parameters that can be trivially derived from mr and xlat.
Signed-off-by Steve Sistare <[email protected]>
FWIW I'm aware there's recent discussion on this patch separately, but I've needed to include it in this series for the subsequent changes.
thanks
john
PATCH 2/27 vfio/container: pass MemoryRegion to DMA operations
In reply to John LevonPass through the MemoryRegion to DMA operation handlers of vfio containers. The vfio-user container will need this later, to translate the vaddr into an offset for the dma map vfio-user message.
--- include/hw/vfio/vfio-container-base.h | 4 ++-- hw/vfio/container-base.c | 4 ++-- hw/vfio/container.c | 3 ++- hw/vfio/iommufd.c | 3 ++- hw/vfio/listener.c | 6 +++--- 5 files changed, 11 insertions(+), 9 deletions(-)
include/hw/vfio/vfio-container-base.h +2 -2
@@ -78,7 +78,7 @@ void vfio_address_space_insert(VFIOAddressSpace *space,int vfio_container_dma_map (VFIOContainerBase *bcontainer,hwaddr iova,ram_addr_t size, -void *vaddr,bool readonly); +void *vaddr,bool readonly,MemoryRegion *mrp);int vfio_container_dma_unmap (VFIOContainerBase *bcontainer,hwaddr iova,ram_addr_t size,IOMMUTLBEntry *iotlb,bool unmap_all);
@@ -121,7 +121,7 @@ struct VFIOIOMMUClass {void (*listener_commit)(VFIOContainerBase *bcontainer);int (*dma_map)(const VFIOContainerBase *bcontainer,hwaddr iova,ram_addr_t size, -void *vaddr,bool readonly); +void *vaddr,bool readonly,MemoryRegion *mrp);/** * @dma_unmap *
hw/vfio/container-base.c +2 -2
@@ -75,12 +75,12 @@ void vfio_address_space_insert(VFIOAddressSpace *space,int vfio_container_dma_map (VFIOContainerBase *bcontainer,hwaddr iova,ram_addr_t size, -void *vaddr,bool readonly) +void *vaddr,bool readonly,MemoryRegion *mrp) {VFIOIOMMUClass *vioc =VFIO_IOMMU_GET_CLASS (bcontainer);g_assert (vioc->dma_map); -return vioc->dma_map (bcontainer, iova, size, vaddr, readonly); +return vioc->dma_map (bcontainer, iova, size, vaddr, readonly, mrp); } int vfio_container_dma_unmap(VFIOContainerBase *bcontainer,
hw/vfio/container.c +2 -1
@@ -207,7 +207,8 @@ static int vfio_legacy_dma_unmap(const VFIOContainerBase *bcontainer, }static int vfio_legacy_dma_map (const VFIOContainerBase *bcontainer,hwaddr iova, -ram_addr_t size,void *vaddr,bool readonly) +ram_addr_t size,void *vaddr,bool readonly, +MemoryRegion *mrp) {const VFIOContainer *container =container_of (bcontainer, VFIOContainer, bcontainer);
hw/vfio/iommufd.c +2 -1
@@ -34,7 +34,8 @@TYPE_HOST_IOMMU_DEVICE_IOMMUFD "-vfio" static int iommufd_cdev_map(const VFIOContainerBase *bcontainer, hwaddr iova, - ram_addr_t size, void *vaddr, bool readonly) + ram_addr_t size, void *vaddr, bool readonly, + MemoryRegion *mrp) {const VFIOIOMMUFDContainer *container =container_of (bcontainer, VFIOIOMMUFDContainer, bcontainer);
hw/vfio/listener.c +3 -3
@@ -169,7 +169,7 @@ static void vfio_iommu_map_notify(IOMMUNotifier *n, IOMMUTLBEntry *iotlb)*/ ret =vfio_container_dma_map (bcontainer, iova, iotlb->addr_mask +1 , vaddr, - read_only); + read_only, mr);if (ret) { error_report("vfio_container_dma_map(%p, 0x%"HWADDR_PRIx", " "0x%"HWADDR_PRIx", %p) = %d (%s)",
@@ -239,7 +239,7 @@ static int vfio_ram_discard_notify_populate(RamDiscardListener *rdl, vaddr =memory_region_get_ram_ptr (section->mr) + start; ret =vfio_container_dma_map (bcontainer, iova, next - start, - vaddr, section->readonly); + vaddr, section->readonly, section->mr);if (ret) {/* Rollback */ vfio_ram_discard_notify_discard (rdl, section);
@@ -563,7 +563,7 @@ static void vfio_listener_region_add(MemoryListener *listener, } ret =vfio_container_dma_map (bcontainer, iova,int128_get64 (llsize), - vaddr, section->readonly); + vaddr, section->readonly, section->mr);if (ret) { error_setg(&err, "vfio_container_dma_map(%p, 0x%"HWADDR_PRIx", " "0x%"HWADDR_PRIx", %p) = %d (%s)",
Signature · 1 line
2.43.0
Re: [PATCH 02/27] vfio/container: pass MemoryRegion to DMA operations
Quoted 30 lines · John Levon
Pass through the MemoryRegion to DMA operation handlers of vfio containers. The vfio-user container will need this later, to translate the vaddr into an offset for the dma map vfio-user message.
Originally-by John Johnson <[email protected]>Signed-off-by Jagannathan Raman <[email protected]>Signed-off-by Elena Ufimtseva <[email protected]>Signed-off-by John Levon <[email protected]>--- include/hw/vfio/vfio-container-base.h | 4 ++-- hw/vfio/container-base.c | 4 ++-- hw/vfio/container.c | 3 ++- hw/vfio/iommufd.c | 3 ++- hw/vfio/listener.c | 6 +++--- 5 files changed, 11 insertions(+), 9 deletions(-)include/hw/vfio/vfio-container-base.h +1
-1@@ -78,7 +78,7 @@ void vfio_address_space_insert(VFIOAddressSpace *space,int vfio_container_dma_map (VFIOContainerBase *bcontainer,hwaddr iova,ram_addr_t size, -void *vaddr,bool readonly); +void *vaddr,bool readonly,MemoryRegion *mrp);int vfio_container_dma_unmap (VFIOContainerBase *bcontainer,hwaddr iova,ram_addr_t size,IOMMUTLBEntry *iotlb,bool unmap_all);
include/hw/vfio/vfio-container-base.h struct VFIOIOMMUClass { · line 121
Quoted 1 line
include/hw/vfio/vfio-container-base.h +0
-0@@ -121,7 +121,7 @@ struct VFIOIOMMUClass {void (*listener_commit)(VFIOContainerBase *bcontainer);
We forgot to document the listener_commit() and listener_begin() handlers.
include/hw/vfio/vfio-container-base.h struct VFIOIOMMUClass { · line 122
Quoted 1 line
include/hw/vfio/vfio-container-base.h +0
-0int (*dma_map)(const VFIOContainerBase *bcontainer,
dma_map() also needs documentation.
Thanks,
C.
Quoted 84 lines
include/hw/vfio/vfio-container-base.h +1
-1hwaddr iova, ram_addr_t size, - void *vaddr, bool readonly); + void *vaddr, bool readonly, MemoryRegion *mrp);/** * @dma_unmap * hw/vfio/container-base.c +2
-2@@ -75,12 +75,12 @@ void vfio_address_space_insert(VFIOAddressSpace *space,int vfio_container_dma_map (VFIOContainerBase *bcontainer,hwaddr iova,ram_addr_t size, -void *vaddr,bool readonly) +void *vaddr,bool readonly,MemoryRegion *mrp) {VFIOIOMMUClass *vioc =VFIO_IOMMU_GET_CLASS (bcontainer);g_assert (vioc->dma_map); -return vioc->dma_map (bcontainer, iova, size, vaddr, readonly); +return vioc->dma_map (bcontainer, iova, size, vaddr, readonly, mrp); } int vfio_container_dma_unmap(VFIOContainerBase *bcontainer,hw/vfio/container.c +2
-1@@ -207,7 +207,8 @@ static int vfio_legacy_dma_unmap(const VFIOContainerBase *bcontainer, }static int vfio_legacy_dma_map (const VFIOContainerBase *bcontainer,hwaddr iova, -ram_addr_t size,void *vaddr,bool readonly) +ram_addr_t size,void *vaddr,bool readonly, +MemoryRegion *mrp) {const VFIOContainer *container =container_of (bcontainer, VFIOContainer, bcontainer);hw/vfio/iommufd.c +2
-1@@ -34,7 +34,8 @@TYPE_HOST_IOMMU_DEVICE_IOMMUFD "-vfio" static int iommufd_cdev_map(const VFIOContainerBase *bcontainer, hwaddr iova, - ram_addr_t size, void *vaddr, bool readonly) + ram_addr_t size, void *vaddr, bool readonly, + MemoryRegion *mrp) {const VFIOIOMMUFDContainer *container =container_of (bcontainer, VFIOIOMMUFDContainer, bcontainer);hw/vfio/listener.c +3
-3@@ -169,7 +169,7 @@ static void vfio_iommu_map_notify(IOMMUNotifier *n, IOMMUTLBEntry *iotlb)*/ ret =vfio_container_dma_map (bcontainer, iova, iotlb->addr_mask +1 , vaddr, - read_only); + read_only, mr);if (ret) { error_report("vfio_container_dma_map(%p, 0x%"HWADDR_PRIx", " "0x%"HWADDR_PRIx", %p) = %d (%s)",@@ -239,7 +239,7 @@ static int vfio_ram_discard_notify_populate(RamDiscardListener *rdl, vaddr =memory_region_get_ram_ptr (section->mr) + start; ret =vfio_container_dma_map (bcontainer, iova, next - start, - vaddr, section->readonly); + vaddr, section->readonly, section->mr);if (ret) {/* Rollback */ vfio_ram_discard_notify_discard (rdl, section);@@ -563,7 +563,7 @@ static void vfio_listener_region_add(MemoryListener *listener, } ret =vfio_container_dma_map (bcontainer, iova,int128_get64 (llsize), - vaddr, section->readonly); + vaddr, section->readonly, section->mr);if (ret) { error_setg(&err, "vfio_container_dma_map(%p, 0x%"HWADDR_PRIx", " "0x%"HWADDR_PRIx", %p) = %d (%s)",
Re: [PATCH 02/27] vfio/container: pass MemoryRegion to DMA operations
Quoted 4 lines · Cédric Le Goater
include/hw/vfio/vfio-container-base.h struct VFIOIOMMUClass { · line 121
Quoted 2 lines
include/hw/vfio/vfio-container-base.h +0
-0@@ -121,7 +121,7 @@ struct VFIOIOMMUClass {void (*listener_commit)(VFIOContainerBase *bcontainer);We forgot to document the
listener_commit()andlistener_begin()handlers.
Apologies, I will send a separate patch for those (and also add a dma_map comment).
regards
john
Re: [PATCH 02/27] vfio/container: pass MemoryRegion to DMA operations
Quoted 9 lines · John Levon
Quoted 4 lines · Cédric Le Goater
include/hw/vfio/vfio-container-base.h struct VFIOIOMMUClass { · line 121
Quoted 2 lines
include/hw/vfio/vfio-container-base.h +0
-0@@ -121,7 +121,7 @@ struct VFIOIOMMUClass {void (*listener_commit)(VFIOContainerBase *bcontainer);We forgot to document the
listener_commit()andlistener_begin()handlers.Apologies, I will send a separate patch for those (and also add a
dma_mapcomment).
Thanks for helping on VFIO documentation John. It is important as VFIO is exporting more services and becoming a library.
C.
PATCH 3/27 vfio: move more cleanup into vfio_pci_put_device()
In reply to John LevonAll of the cleanup can be done in the same place, and vfio-user will want to do the same.
--- hw/vfio/pci.c | 23 ++++++++++++----------- 1 file changed, 12 insertions(+), 11 deletions(-)
hw/vfio/pci.c +12 -11
@@ -2854,6 +2854,18 @@ static bool vfio_populate_device(VFIOPCIDevice *vdev, Error **errp)static void vfio_pci_put_device (VFIOPCIDevice *vdev) { +vfio_display_finalize (vdev); +vfio_bars_finalize (vdev); +g_free (vdev->emulated_config_bits); +g_free (vdev->rom); +/* +* XXX Leaking igd_opregion is not an oversight, we can't remove the +* fw_cfg entry therefore leaking this allocation seems like the safest +* option. +* +* g_free(vdev->igd_opregion); +*/ +vfio_device_detach (&vdev->vbasedev);g_free (vdev->vbasedev.name);
@@ -3302,17 +3314,6 @@ static void vfio_instance_finalize(Object *obj) {VFIOPCIDevice *vdev =VFIO_PCI_BASE (obj); -vfio_display_finalize (vdev); -vfio_bars_finalize (vdev); -g_free (vdev->emulated_config_bits); -g_free (vdev->rom); -/* -* XXX Leaking igd_opregion is not an oversight, we can't remove the -* fw_cfg entry therefore leaking this allocation seems like the safest -* option. -* -* g_free(vdev->igd_opregion); -*/ vfio_pci_put_device (vdev); }
Signature · 1 line
2.43.0
Re: [PATCH 03/27] vfio: move more cleanup into vfio_pci_put_device()
Quoted 4 lines · John Levon
All of the cleanup can be done in the same place, and vfio-user will want to do the same.
Signed-off-by John Levon <[email protected]>
Thanks,
C.
Quoted 45 lines
--- hw/vfio/pci.c | 23 ++++++++++++----------- 1 file changed, 12 insertions(+), 11 deletions(-)hw/vfio/pci.c +12
-11@@ -2854,6 +2854,18 @@ static bool vfio_populate_device(VFIOPCIDevice *vdev, Error **errp)static void vfio_pci_put_device (VFIOPCIDevice *vdev) { +vfio_display_finalize (vdev); +vfio_bars_finalize (vdev); +g_free (vdev->emulated_config_bits); +g_free (vdev->rom); +/* +* XXX Leaking igd_opregion is not an oversight, we can't remove the +* fw_cfg entry therefore leaking this allocation seems like the safest +* option. +* +* g_free(vdev->igd_opregion); +*/ +vfio_device_detach (&vdev->vbasedev);g_free (vdev->vbasedev.name);@@ -3302,17 +3314,6 @@ static void vfio_instance_finalize(Object *obj) {VFIOPCIDevice *vdev =VFIO_PCI_BASE (obj); -vfio_display_finalize (vdev); -vfio_bars_finalize (vdev); -g_free (vdev->emulated_config_bits); -g_free (vdev->rom); -/* -* XXX Leaking igd_opregion is not an oversight, we can't remove the -* fw_cfg entry therefore leaking this allocation seems like the safest -* option. -* -* g_free(vdev->igd_opregion); -*/ vfio_pci_put_device (vdev); }
PATCH 4/27 vfio: move config space read into vfio_pci_config_setup()
In reply to John LevonSmall cleanup that reduces duplicate code for vfio-user.
--- hw/vfio/pci.c | 27 ++++++++++++++------------- 1 file changed, 14 insertions(+), 13 deletions(-)
hw/vfio/pci.c +14 -13
@@ -3017,6 +3017,19 @@ static bool vfio_pci_config_setup(VFIOPCIDevice *vdev, Error **errp) {PCIDevice *pdev = &vdev->pdev;VFIODevice *vbasedev = &vdev->vbasedev; +uint32_t config_space_size; +int ret; + + config_space_size =MIN (pci_config_size (&vdev->pdev), vdev->config_size); + +/* Get a copy of config space */ + ret =vfio_pci_config_space_read (vdev,0 , config_space_size, + vdev->pdev.config); +if (ret < (int )config_space_size) { + ret = ret <0 ? -ret :EFAULT ; +error_setg_errno (errp, ret,"failed to read device config space" ); +return false; + }/* vfio emulates a lot for us, but some bits need extra love */ vdev->emulated_config_bits =g_malloc0 (vdev->config_size);
@@ -3143,10 +3156,9 @@ static void vfio_realize(PCIDevice *pdev, Error **errp)ERRP_GUARD ();VFIOPCIDevice *vdev =VFIO_PCI_BASE (pdev);VFIODevice *vbasedev = &vdev->vbasedev; -int i, ret; +int i;char uuid[UUID_STR_LEN ]; g_autofree char *name = NULL; -uint32_t config_space_size;if (vbasedev->fd <0 && !vbasedev->sysfsdev) { if (!(~vdev->host.domain || ~vdev->host.bus ||
@@ -3201,17 +3213,6 @@ static void vfio_realize(PCIDevice *pdev, Error **errp) goto error; } - config_space_size =MIN (pci_config_size (&vdev->pdev), vdev->config_size); - -/* Get a copy of config space */ - ret =vfio_pci_config_space_read (vdev,0 , config_space_size, - vdev->pdev.config); -if (ret < (int )config_space_size) { - ret = ret <0 ? -ret :EFAULT ; -error_setg_errno (errp, ret,"failed to read device config space" ); - goto error; - } -if (!vfio_pci_config_setup (vdev, errp)) { goto error; }
Signature · 1 line
2.43.0
Re: [PATCH 04/27] vfio: move config space read into vfio_pci_config_setup()
Quoted 1 line · John Levon
Small cleanup that reduces duplicate code for vfio-user.
It also reduces vfio_realize(). It's time to rename it to vfio_pci_realize() too.
Thanks,
C.
Quoted 59 lines
Signed-off-by John Levon <[email protected]>--- hw/vfio/pci.c | 27 ++++++++++++++------------- 1 file changed, 14 insertions(+), 13 deletions(-)hw/vfio/pci.c +14
-13@@ -3017,6 +3017,19 @@ static bool vfio_pci_config_setup(VFIOPCIDevice *vdev, Error **errp) {PCIDevice *pdev = &vdev->pdev;VFIODevice *vbasedev = &vdev->vbasedev; +uint32_t config_space_size; +int ret; + + config_space_size =MIN (pci_config_size (&vdev->pdev), vdev->config_size); + +/* Get a copy of config space */ + ret =vfio_pci_config_space_read (vdev,0 , config_space_size, + vdev->pdev.config); +if (ret < (int )config_space_size) { + ret = ret <0 ? -ret :EFAULT ; +error_setg_errno (errp, ret,"failed to read device config space" ); +return false; + }/* vfio emulates a lot for us, but some bits need extra love */ vdev->emulated_config_bits =g_malloc0 (vdev->config_size);@@ -3143,10 +3156,9 @@ static void vfio_realize(PCIDevice *pdev, Error **errp)ERRP_GUARD ();VFIOPCIDevice *vdev =VFIO_PCI_BASE (pdev);VFIODevice *vbasedev = &vdev->vbasedev; -int i, ret; +int i;char uuid[UUID_STR_LEN ]; g_autofree char *name = NULL; -uint32_t config_space_size;if (vbasedev->fd <0 && !vbasedev->sysfsdev) { if (!(~vdev->host.domain || ~vdev->host.bus ||@@ -3201,17 +3213,6 @@ static void vfio_realize(PCIDevice *pdev, Error **errp) goto error; } - config_space_size =MIN (pci_config_size (&vdev->pdev), vdev->config_size); - -/* Get a copy of config space */ - ret =vfio_pci_config_space_read (vdev,0 , config_space_size, - vdev->pdev.config); -if (ret < (int )config_space_size) { - ret = ret <0 ? -ret :EFAULT ; -error_setg_errno (errp, ret,"failed to read device config space" ); - goto error; - } -if (!vfio_pci_config_setup (vdev, errp)) { goto error; }
PATCH 5/27 vfio: refactor out IRQ signalling setup
In reply to John LevonThis makes for a slightly more readable vfio_msix_vector_do_use() implementation, and we will rely on this shortly.
--- hw/vfio/pci.c | 35 ++++++++++++++++++++--------------- 1 file changed, 20 insertions(+), 15 deletions(-)
hw/vfio/pci.c +20 -15
@@ -511,6 +511,25 @@ static void vfio_update_kvm_msi_virq(VFIOMSIVector *vector, MSIMessage msg,kvm_irqchip_commit_routes (kvm_state); } +static void set_irq_signalling (VFIODevice *vbasedev,VFIOMSIVector *vector, +unsigned int nr) +{ +Error *err =NULL ; +int32_t fd; + +if (vector->virq >=0 ) { + fd =event_notifier_get_fd (&vector->kvm_interrupt); + }else { + fd =event_notifier_get_fd (&vector->interrupt); + } + +if (!vfio_device_irq_set_signaling (vbasedev,VFIO_PCI_MSIX_IRQ_INDEX , nr, +VFIO_IRQ_SET_ACTION_TRIGGER , + fd, &err)) { +error_reportf_err (err,VFIO_MSG_PREFIX , vbasedev->name); + } +} +static int vfio_msix_vector_do_use (PCIDevice *pdev,unsigned int nr,MSIMessage *msg,IOHandler *handler) {
@@ -583,21 +602,7 @@ static int vfio_msix_vector_do_use(PCIDevice *pdev, unsigned int nr, strerror(-ret)); } }else { -Error *err =NULL ; -int32_t fd; - -if (vector->virq >=0 ) { - fd =event_notifier_get_fd (&vector->kvm_interrupt); - }else { - fd =event_notifier_get_fd (&vector->interrupt); - } - -if (!vfio_device_irq_set_signaling (&vdev->vbasedev, -VFIO_PCI_MSIX_IRQ_INDEX , nr, -VFIO_IRQ_SET_ACTION_TRIGGER , fd, - &err)) { -error_reportf_err (err,VFIO_MSG_PREFIX , vdev->vbasedev.name); - } +set_irq_signalling (&vdev->vbasedev, vector, nr); } }
Signature · 1 line
2.43.0
Re: [PATCH 05/27] vfio: refactor out IRQ signalling setup
Quoted 4 lines · John Levon
This makes for a slightly more readable
vfio_msix_vector_do_use()implementation, and we will rely on this shortly.Signed-off-by John Levon <[email protected]>
Thanks,
C.
Quoted 57 lines
--- hw/vfio/pci.c | 35 ++++++++++++++++++++--------------- 1 file changed, 20 insertions(+), 15 deletions(-)hw/vfio/pci.c +20
-15@@ -511,6 +511,25 @@ static void vfio_update_kvm_msi_virq(VFIOMSIVector *vector, MSIMessage msg,kvm_irqchip_commit_routes (kvm_state); } +static void set_irq_signalling (VFIODevice *vbasedev,VFIOMSIVector *vector, +unsigned int nr) +{ +Error *err =NULL ; +int32_t fd; + +if (vector->virq >=0 ) { + fd =event_notifier_get_fd (&vector->kvm_interrupt); + }else { + fd =event_notifier_get_fd (&vector->interrupt); + } + +if (!vfio_device_irq_set_signaling (vbasedev,VFIO_PCI_MSIX_IRQ_INDEX , nr, +VFIO_IRQ_SET_ACTION_TRIGGER , + fd, &err)) { +error_reportf_err (err,VFIO_MSG_PREFIX , vbasedev->name); + } +} +static int vfio_msix_vector_do_use (PCIDevice *pdev,unsigned int nr,MSIMessage *msg,IOHandler *handler) {@@ -583,21 +602,7 @@ static int vfio_msix_vector_do_use(PCIDevice *pdev, unsigned int nr, strerror(-ret)); } }else { -Error *err =NULL ; -int32_t fd; - -if (vector->virq >=0 ) { - fd =event_notifier_get_fd (&vector->kvm_interrupt); - }else { - fd =event_notifier_get_fd (&vector->interrupt); - } - -if (!vfio_device_irq_set_signaling (&vdev->vbasedev, -VFIO_PCI_MSIX_IRQ_INDEX , nr, -VFIO_IRQ_SET_ACTION_TRIGGER , fd, - &err)) { -error_reportf_err (err,VFIO_MSG_PREFIX , vdev->vbasedev.name); - } +set_irq_signalling (&vdev->vbasedev, vector, nr); } }
PATCH 6/27 vfio: enable per-IRQ MSI-X masking
In reply to John LevonIf VFIO_IRQ_INFO_MASKABLE is set for VFIO_PCI_MSIX_IRQ_INDEX, record this in ->can_mask_msix, and use it to individually mask MSI-X interrupts as needed.
--- hw/vfio/pci.h | 1 + include/hw/vfio/vfio-device.h | 2 ++ hw/vfio/device.c | 26 +++++++++++++++++++ hw/vfio/pci.c | 47 ++++++++++++++++++++++++++++++----- 4 files changed, 70 insertions(+), 6 deletions(-)
hw/vfio/pci.h +1 -0
@@ -191,6 +191,7 @@ struct VFIOPCIDevice {bool defer_kvm_irq_routing;bool clear_parent_atomics_on_exit;bool skip_vsc_check; +bool can_mask_msix;VFIODisplay *dpy;Notifier irqchip_change_notifier; };
include/hw/vfio/vfio-device.h +2 -0
@@ -133,7 +133,9 @@ struct VFIODeviceOps { (ret < 0 ? strerror(-ret) : "short write")void vfio_device_irq_disable (VFIODevice *vbasedev,int index); +void vfio_device_irq_unmask_single (VFIODevice *vbasedev,int index,int irq);void vfio_device_irq_unmask (VFIODevice *vbasedev,int index); +void vfio_device_irq_mask_single (VFIODevice *vbasedev,int index,int irq);void vfio_device_irq_mask (VFIODevice *vbasedev,int index);bool vfio_device_irq_set_signaling (VFIODevice *vbasedev,int index,int subindex,int action,int fd,Error **errp);
hw/vfio/device.c +26 -0
@@ -85,6 +85,19 @@ void vfio_device_irq_disable(VFIODevice *vbasedev, int index) vbasedev->io_ops->set_irqs (vbasedev, &irq_set); } +void vfio_device_irq_unmask_single (VFIODevice *vbasedev,int index,int irq) +{ +struct vfio_irq_set irq_set = { + .argsz =sizeof (irq_set), + .flags =VFIO_IRQ_SET_DATA_NONE |VFIO_IRQ_SET_ACTION_UNMASK , + .index = index, + .start = irq, + .count =1 , + }; + + vbasedev->io_ops->set_irqs (vbasedev, &irq_set); +} +void vfio_device_irq_unmask (VFIODevice *vbasedev,int index) {struct vfio_irq_set irq_set = {
@@ -98,6 +111,19 @@ void vfio_device_irq_unmask(VFIODevice *vbasedev, int index) vbasedev->io_ops->set_irqs (vbasedev, &irq_set); } +void vfio_device_irq_mask_single (VFIODevice *vbasedev,int index,int irq) +{ +struct vfio_irq_set irq_set = { + .argsz =sizeof (irq_set), + .flags =VFIO_IRQ_SET_DATA_NONE |VFIO_IRQ_SET_ACTION_MASK , + .index = index, + .start = irq, + .count =1 , + }; + + vbasedev->io_ops->set_irqs (vbasedev, &irq_set); +} +void vfio_device_irq_mask (VFIODevice *vbasedev,int index) {struct vfio_irq_set irq_set = {
hw/vfio/pci.c +41 -6
96 lines not on this page · raw message
Signature · 1 line
2.43.0
PATCH 7/27 vfio: add per-region fd support
In reply to John LevonFor vfio-user, each region has its own fd rather than sharing vbasedev's. Add the necessary plumbing to support this. For vfio backends with a shared fd, initialize region->fd to the shared one.
--- include/hw/vfio/vfio-device.h | 7 +++++-- include/hw/vfio/vfio-region.h | 1 + hw/vfio/device.c | 28 ++++++++++++++++++++++++++-- hw/vfio/region.c | 7 ++++++- 4 files changed, 38 insertions(+), 5 deletions(-)
include/hw/vfio/vfio-device.h +5 -2
@@ -66,6 +66,7 @@ typedef struct VFIODevice {OnOffAuto enable_migration;OnOffAuto migration_multifd_transfer;bool migration_events; +bool use_region_fds;VFIODeviceOps *ops;VFIODeviceIOOps *io_ops;unsigned int num_irqs;
@@ -84,6 +85,7 @@ typedef struct VFIODevice {VFIOIOASHwpt *hwpt;QLIST_ENTRY (VFIODevice) hwpt_next;struct vfio_region_info **reginfo; +int *region_fds; } VFIODevice;struct VFIODeviceOps {
@@ -172,10 +174,11 @@ struct VFIODeviceIOOps {/** * @get_region_info * -* Fill in @info with information on the region given by @info->index. +* Fill in @info (and optionally @fd) with information on the region given +* by @info->index. */ int (*get_region_info)(VFIODevice *vdev, -struct vfio_region_info *info); +struct vfio_region_info *info,int *fd);/** * @get_irq_info
include/hw/vfio/vfio-region.h +1 -0
@@ -29,6 +29,7 @@ typedef struct VFIORegion {uint32_t nr_mmaps;VFIOMmap *mmaps;uint8_t nr;/* cache the region number for debug */ +int fd;/* fd to mmap() region */ } VFIORegion;
hw/vfio/device.c +26 -2
@@ -226,6 +226,7 @@ int vfio_device_get_region_info(VFIODevice *vbasedev, int index, struct vfio_region_info **info) {size_t argsz =sizeof (struct vfio_region_info ); +int fd =-1 ;int ret;/* check cache */
@@ -240,7 +241,7 @@ int vfio_device_get_region_info(VFIODevice *vbasedev, int index, retry: (*info)->argsz = argsz; - ret = vbasedev->io_ops->get_region_info (vbasedev, *info); + ret = vbasedev->io_ops->get_region_info (vbasedev, *info, &fd);if (ret !=0 ) {g_free (*info); *info =NULL ;
@@ -251,11 +252,19 @@ retry: argsz = (*info)->argsz; *info =g_realloc (*info, argsz); +if (fd !=-1 ) { +close (fd); + fd =-1 ; + } + goto retry; }/* fill cache */ vbasedev->reginfo[index] = *info; +if (vbasedev->region_fds !=NULL ) { + vbasedev->region_fds[index] = fd; + }return 0 ; }
@@ -360,6 +369,7 @@ void vfio_device_init(VFIODevice *vbasedev, int type, VFIODeviceOps *ops, vbasedev->io_ops = &vfio_device_io_ops_ioctl; vbasedev->dev = dev; vbasedev->fd =-1 ; + vbasedev->use_region_fds = false; vbasedev->ram_block_discard_allowed = ram_discard; }
@@ -470,6 +480,9 @@ void vfio_device_prepare(VFIODevice *vbasedev, VFIOContainerBase *bcontainer, vbasedev->reginfo = g_new0(struct vfio_region_info *, vbasedev->num_regions); +if (vbasedev->use_region_fds) { + vbasedev->region_fds =g_new0 (int, vbasedev->num_regions); + } }void vfio_device_unprepare (VFIODevice *vbasedev)
@@ -478,9 +491,17 @@ void vfio_device_unprepare(VFIODevice *vbasedev)for (i =0 ; i < vbasedev->num_regions; i++) {g_free (vbasedev->reginfo[i]); +if (vbasedev->region_fds !=NULL && vbasedev->region_fds[i] !=-1 ) { +close (vbasedev->region_fds[i]); + } + }g_free (vbasedev->reginfo); vbasedev->reginfo =NULL ; +if (vbasedev->region_fds !=NULL ) { +g_free (vbasedev->region_fds); + vbasedev->region_fds =NULL ; + }QLIST_REMOVE (vbasedev, container_next);QLIST_REMOVE (vbasedev, global_next);
@@ -502,10 +523,13 @@ static int vfio_device_io_device_feature(VFIODevice *vbasedev, }static int vfio_device_io_get_region_info (VFIODevice *vbasedev, -struct vfio_region_info *info) +struct vfio_region_info *info, +int *fd) {int ret; + *fd =-1 ; + ret =ioctl (vbasedev->fd,VFIO_DEVICE_GET_REGION_INFO , info);return ret <0 ? -errno : ret;
hw/vfio/region.c +6 -1
@@ -200,6 +200,11 @@ int vfio_region_setup(Object *obj, VFIODevice *vbasedev, VFIORegion *region, region->size = info->size; region->fd_offset = info->offset; region->nr = index; +if (vbasedev->region_fds !=NULL ) { + region->fd = vbasedev->region_fds[index]; + }else { + region->fd = vbasedev->fd; + }if (region->size) { region->mem =g_new0 (MemoryRegion,1 );
@@ -278,7 +283,7 @@ int vfio_region_mmap(VFIORegion *region) region->mmaps[i].mmap =mmap (map_align, region->mmaps[i].size, prot,MAP_SHARED |MAP_FIXED , - region->vbasedev->fd, + region->fd, region->fd_offset + region->mmaps[i].offset);if (region->mmaps[i].mmap ==MAP_FAILED ) {
Signature · 1 line
2.43.0
PATCH 8/27 vfio: mark posted writes in region write callbacks
In reply to John LevonFor vfio-user, the region write implementation needs to know if the write is posted; add the necessary plumbing to support this.
--- include/hw/vfio/vfio-device.h | 4 ++-- include/hw/vfio/vfio-region.h | 1 + hw/vfio/device.c | 3 ++- hw/vfio/pci.c | 5 ++++- hw/vfio/region.c | 3 ++- 5 files changed, 11 insertions(+), 5 deletions(-)
include/hw/vfio/vfio-device.h +2 -2
@@ -207,10 +207,10 @@ struct VFIODeviceIOOps {* @region_write * * Write @size bytes to the region @nr at offset @off from the buffer -* @data. +* @data; if @post, the write is posted. */ int (*region_write)(VFIODevice *vdev,uint8_t nr,off_t off,uint32_t size, -void *data); +void *data,bool post); }; void vfio_device_prepare(VFIODevice *vbasedev, VFIOContainerBase *bcontainer,
include/hw/vfio/vfio-region.h +1 -0
@@ -30,6 +30,7 @@ typedef struct VFIORegion {VFIOMmap *mmaps;uint8_t nr;/* cache the region number for debug */ int fd;/* fd to mmap() region */ +bool post_wr;/* writes can be posted */ } VFIORegion;
hw/vfio/device.c +2 -1
@@ -572,7 +572,8 @@ static int vfio_device_io_region_read(VFIODevice *vbasedev, uint8_t index, }static int vfio_device_io_region_write (VFIODevice *vbasedev,uint8_t index, -off_t off,uint32_t size,void *data) +off_t off,uint32_t size,void *data, +bool post) {struct vfio_region_info *info;int ret;
hw/vfio/pci.c +4 -1
@@ -1016,7 +1016,7 @@ static int vfio_pci_config_space_write(VFIOPCIDevice *vdev, off_t offset, {return vdev->vbasedev.io_ops->region_write (&vdev->vbasedev,VFIO_PCI_CONFIG_REGION_INDEX , - offset, size, data); + offset, size, data, false); }static uint64_t vfio_rom_read (void *opaque,hwaddr addr,unsigned size)
@@ -1820,6 +1820,9 @@ static void vfio_bar_prepare(VFIOPCIDevice *vdev, int nr) bar->type = pci_bar & (bar->ioport ? ~PCI_BASE_ADDRESS_IO_MASK : ~PCI_BASE_ADDRESS_MEM_MASK ); bar->size = bar->region.size; + +/* IO regions are sync, memory can be async */ + bar->region.post_wr = (bar->ioport ==0 ); }static void vfio_bars_prepare (VFIOPCIDevice *vdev)
hw/vfio/region.c +2 -1
@@ -66,7 +66,7 @@ void vfio_region_write(void *opaque, hwaddr addr, } ret = vbasedev->io_ops->region_write (vbasedev, region->nr, - addr, size, &buf); + addr, size, &buf, region->post_wr);if (ret != size) { error_report("%s(%s:region%d+0x%"HWADDR_PRIx", 0x%"PRIx64 ",%d) failed: %s",
@@ -200,6 +200,7 @@ int vfio_region_setup(Object *obj, VFIODevice *vbasedev, VFIORegion *region, region->size = info->size; region->fd_offset = info->offset; region->nr = index; + region->post_wr = false;if (vbasedev->region_fds !=NULL ) { region->fd = vbasedev->region_fds[index]; }else {
Signature · 1 line
2.43.0
PATCH 9/27 vfio-user: introduce vfio-user protocol specification
In reply to John LevonFrom: Thanos Makatos <[email protected]>
This patch introduces the vfio-user protocol specification (formerly known as VFIO-over-socket), which is designed to allow devices to be emulated outside QEMU, in a separate process. vfio-user reuses the existing VFIO defines, structs and concepts.
It has been earlier discussed as an RFC in:
"RFC: use VFIO over a UNIX domain socket to implement device offloading"
--- MAINTAINERS | 8 +- docs/devel/index-internals.rst | 1 + docs/devel/vfio-user.rst | 1522 ++++++++++++++++++++++++++++++++ 3 files changed, 1530 insertions(+), 1 deletion(-) create mode 100644 docs/devel/vfio-user.rst
MAINTAINERS +7 -1
@@ -4218,13 +4218,19 @@ F: hw/remote/proxy-memory-listener.c F: include/hw/remote/proxy-memory-listener.h F: hw/remote/iohub.c F: include/hw/remote/iohub.h -F: subprojects/libvfio-user F: hw/remote/vfio-user-obj.c F: include/hw/remote/vfio-user-obj.h F: hw/remote/iommu.c F: include/hw/remote/iommu.h F: tests/functional/test_multiprocess.py +VFIO-USER: +M: John Levon <[email protected]> +M: Thanos Makatos <[email protected]> +S: Supported +F: docs/devel/vfio-user.rst +F: subprojects/libvfio-user + EBPF: M: Jason Wang <[email protected]> R: Andrew Melnychenko <[email protected]>
docs/devel/index-internals.rst +1 -0
@@ -22,6 +22,7 @@ Details about QEMU's various subsystems including how to add features to them. tracing uefi-vars vfio-iommufd + vfio-user writing-monitor-commands virtio-backends crypto
docs/devel/vfio-user.rst new file +1522 -0
1,522 lines not on this page · raw message
Signature · 1 line
2.43.0
PATCH 10/27 vfio-user: add vfio-user class and container
In reply to John LevonIntroduce basic plumbing for vfio-user behind a new --enable-vfio-user-client option.
We introduce VFIOUserContainer in hw/vfio-user/container.c, which is a container type for the "IOMMU" type "vfio-iommu-user", and share some common container code from hw/vfio/container.c.
Add hw/vfio-user/pci.c for instantiating VFIOUserPCIDevice objects, sharing some common code from hw/vfio/pci.c.
--- MAINTAINERS | 2 + hw/vfio-user/container.h | 25 +++ hw/vfio/pci.h | 6 + include/hw/vfio/vfio-container-base.h | 1 + hw/vfio-user/container.c | 212 ++++++++++++++++++++++++++ hw/vfio-user/pci.c | 146 ++++++++++++++++++ hw/vfio/pci.c | 10 +- hw/meson.build | 1 + hw/vfio-user/meson.build | 9 ++ meson_options.txt | 2 + scripts/meson-buildoptions.sh | 4 + 11 files changed, 413 insertions(+), 5 deletions(-) create mode 100644 hw/vfio-user/container.h create mode 100644 hw/vfio-user/container.c create mode 100644 hw/vfio-user/pci.c create mode 100644 hw/vfio-user/meson.build
MAINTAINERS +2 -0
@@ -4229,6 +4229,8 @@ M: John Levon <[email protected]> M: Thanos Makatos <[email protected]> S: Supported F: docs/devel/vfio-user.rst +F: hw/vfio-user/* +F: include/hw/vfio-user/* F: subprojects/libvfio-user EBPF:
hw/vfio-user/container.h new file +25 -0
@@ -0,0 +1,25 @@ +/* +* vfio-user specific definitions. +* +* This work is licensed under the terms of the GNU GPL, version 2. See +* the COPYING file in the top-level directory. +* +* SPDX-License-Identifier: GPL-2.0-or-later +*/ + +#ifndef HW_VFIO_USER_CONTAINER_H +#define HW_VFIO_USER_CONTAINER_H + +#include <inttypes.h> +#include <stdbool.h> + +#include "hw/vfio/vfio-container-base.h" + +/* MMU container sub-class for vfio-user. */ +typedef struct VFIOUserContainer { +VFIOContainerBase bcontainer; +}VFIOUserContainer ; + +OBJECT_DECLARE_SIMPLE_TYPE (VFIOUserContainer,VFIO_IOMMU_USER ); + +#endif /* HW_VFIO_USER_CONTAINER_H */
hw/vfio/pci.h +6 -0
@@ -215,6 +215,12 @@ uint32_t vfio_pci_read_config(PCIDevice *pdev, uint32_t addr, int len);void vfio_pci_write_config (PCIDevice *pdev,uint32_t addr,uint32_t val,int len); +void vfio_intx_eoi (VFIODevice *vbasedev); +Object *vfio_pci_get_object (VFIODevice *vbasedev); +int vfio_pci_save_config (VFIODevice *vbasedev,QEMUFile *f,Error **errp); +int vfio_pci_load_config (VFIODevice *vbasedev,QEMUFile *f); +void vfio_pci_put_device (VFIOPCIDevice *vdev); +uint64_t vfio_vga_read (void *opaque,hwaddr addr,unsigned size);void vfio_vga_write (void *opaque,hwaddr addr,uint64_t data,unsigned size);
include/hw/vfio/vfio-container-base.h +1 -0
@@ -109,6 +109,7 @@ vfio_container_get_page_size_mask(const VFIOContainerBase *bcontainer)#define TYPE_VFIO_IOMMU_LEGACY TYPE_VFIO_IOMMU "-legacy"#define TYPE_VFIO_IOMMU_SPAPR TYPE_VFIO_IOMMU "-spapr"#define TYPE_VFIO_IOMMU_IOMMUFD TYPE_VFIO_IOMMU "-iommufd" +#define TYPE_VFIO_IOMMU_USER TYPE_VFIO_IOMMU "-user"OBJECT_DECLARE_TYPE (VFIOContainerBase, VFIOIOMMUClass,VFIO_IOMMU )
hw/vfio-user/container.c new file +212 -0
212 lines not on this page · raw message
hw/vfio-user/pci.c new file +146 -0
146 lines not on this page · raw message
hw/vfio/pci.c +5 -5
@@ -103,7 +103,7 @@ static void vfio_intx_interrupt(void *opaque) } } -static void vfio_intx_eoi (VFIODevice *vbasedev) +void vfio_intx_eoi (VFIODevice *vbasedev) {VFIOPCIDevice *vdev =container_of (vbasedev, VFIOPCIDevice, vbasedev);
@@ -2629,7 +2629,7 @@ static void vfio_pci_compute_needs_reset(VFIODevice *vbasedev) } } -static Object *vfio_pci_get_object (VFIODevice *vbasedev) +Object *vfio_pci_get_object (VFIODevice *vbasedev) {VFIOPCIDevice *vdev =container_of (vbasedev, VFIOPCIDevice, vbasedev);
@@ -2685,7 +2685,7 @@ static const VMStateDescription vmstate_vfio_pci_config = { } }; -static int vfio_pci_save_config (VFIODevice *vbasedev,QEMUFile *f,Error **errp) +int vfio_pci_save_config (VFIODevice *vbasedev,QEMUFile *f,Error **errp) {VFIOPCIDevice *vdev =container_of (vbasedev, VFIOPCIDevice, vbasedev);
@@ -2693,7 +2693,7 @@ static int vfio_pci_save_config(VFIODevice *vbasedev, QEMUFile *f, Error **errp) errp); } -static int vfio_pci_load_config (VFIODevice *vbasedev,QEMUFile *f) +int vfio_pci_load_config (VFIODevice *vbasedev,QEMUFile *f) {VFIOPCIDevice *vdev =container_of (vbasedev, VFIOPCIDevice, vbasedev);PCIDevice *pdev = &vdev->pdev;
@@ -2895,7 +2895,7 @@ static bool vfio_populate_device(VFIOPCIDevice *vdev, Error **errp)return true; } -static void vfio_pci_put_device (VFIOPCIDevice *vdev) +void vfio_pci_put_device (VFIOPCIDevice *vdev) {vfio_display_finalize (vdev);vfio_bars_finalize (vdev);
hw/meson.build +1 -0
@@ -39,6 +39,7 @@ subdir('uefi') subdir('ufs') subdir('usb') subdir('vfio') +subdir('vfio-user') subdir('virtio') subdir('vmapple') subdir('watchdog')
hw/vfio-user/meson.build new file +9 -0
@@ -0,0 +1,9 @@ +vfio_user_ss = ss.source_set() +vfio_user_ss.add(files( + 'container.c', + 'pci.c', +)) + +if get_option('vfio_user_client').enabled() + specific_ss.add_all(vfio_user_ss) +endif
meson_options.txt +2 -0
@@ -109,6 +109,8 @@ option('multiprocess', type: 'feature', value: 'auto', description: 'Out of process device emulation support') option('relocatable', type : 'boolean', value : true, description: 'toggle relocatable install') +option('vfio_user_client', type: 'feature', value: 'disabled', + description: 'vfio-user client support') option('vfio_user_server', type: 'feature', value: 'disabled', description: 'vfio-user server support') option('dbus_display', type: 'feature', value: 'auto',
scripts/meson-buildoptions.sh +4 -0
@@ -201,6 +201,8 @@ meson_options_help() { printf "%s\n" ' vdi vdi image format support' printf "%s\n" ' vduse-blk-export' printf "%s\n" ' VDUSE block export support' + printf "%s\n" ' vfio-user-client' + printf "%s\n" ' vfio-user client support' printf "%s\n" ' vfio-user-server' printf "%s\n" ' vfio-user server support' printf "%s\n" ' vhdx vhdx image format support'
@@ -529,6 +531,8 @@ _meson_option_parse() { --disable-vdi) printf "%s" -Dvdi=disabled ;; --enable-vduse-blk-export) printf "%s" -Dvduse_blk_export=enabled ;; --disable-vduse-blk-export) printf "%s" -Dvduse_blk_export=disabled ;; + --enable-vfio-user-client) printf "%s" -Dvfio_user_client=enabled ;; + --disable-vfio-user-client) printf "%s" -Dvfio_user_client=disabled ;; --enable-vfio-user-server) printf "%s" -Dvfio_user_server=enabled ;; --disable-vfio-user-server) printf "%s" -Dvfio_user_server=disabled ;; --enable-vhdx) printf "%s" -Dvhdx=enabled ;;
Signature · 1 line
2.43.0
PATCH 11/27 vfio-user: connect vfio proxy to remote server
In reply to John LevonIntroduce the vfio-user "proxy": this is the client code responsible for sending and receiving vfio-user messages across the control socket.
The new files hw/vfio-user/proxy.[ch] contain some basic plumbing for managing the proxy; initialize the proxy during realization of the VFIOUserPCIDevice instance.
--- hw/vfio-user/proxy.h | 82 +++++++++++++++++ include/hw/vfio/vfio-device.h | 2 + hw/vfio-user/pci.c | 17 ++++ hw/vfio-user/proxy.c | 165 ++++++++++++++++++++++++++++++++++ hw/vfio-user/meson.build | 1 + 5 files changed, 267 insertions(+) create mode 100644 hw/vfio-user/proxy.h create mode 100644 hw/vfio-user/proxy.c
hw/vfio-user/proxy.h new file +82 -0
@@ -0,0 +1,82 @@ +#ifndef VFIO_USER_PROXY_H +#define VFIO_USER_PROXY_H + +/* +* vfio protocol over a UNIX socket. +* +* Copyright © 2018, 2021 Oracle and/or its affiliates. +* +* This work is licensed under the terms of the GNU GPL, version 2. See +* the COPYING file in the top-level directory. +* +* SPDX-License-Identifier: GPL-2.0-or-later +*/ + +#include "io/channel.h" +#include "io/channel-socket.h" + +typedef struct { +int send_fds; +int recv_fds; +int *fds; +}VFIOUserFDs ; + +enum msg_type { +VFIO_MSG_NONE , +VFIO_MSG_ASYNC , +VFIO_MSG_WAIT , +VFIO_MSG_NOWAIT , +VFIO_MSG_REQ , +}; + +typedef struct VFIOUserMsg { +QTAILQ_ENTRY (VFIOUserMsg) next; +VFIOUserFDs *fds; +uint32_t rsize; +uint32_t id; +QemuCond cv; +bool complete; +enum msg_type type; +}VFIOUserMsg ; + + +enum proxy_state { +VFIO_PROXY_CONNECTED =1 , +VFIO_PROXY_ERROR =2 , +VFIO_PROXY_CLOSING =3 , +VFIO_PROXY_CLOSED =4 , +}; + +typedef QTAILQ_HEAD(VFIOUserMsgQ, VFIOUserMsg) VFIOUserMsgQ; + +typedef struct VFIOUserProxy { +QLIST_ENTRY (VFIOUserProxy) next; +char *sockname; +struct QIOChannel *ioc; +void (*request)(void *opaque,VFIOUserMsg *msg); +void *req_arg; +int flags; +QemuCond close_cv; +AioContext *ctx; +QEMUBH *req_bh; + +/* +* above only changed when BQL is held +* below are protected by per-proxy lock +*/ +QemuMutex lock; +VFIOUserMsgQ free; +VFIOUserMsgQ pending; +VFIOUserMsgQ incoming; +VFIOUserMsgQ outgoing; +VFIOUserMsg *last_nowait; +enum proxy_state state; +}VFIOUserProxy ; + +/* VFIOProxy flags */ +#define VFIO_PROXY_CLIENT 0x1 + +VFIOUserProxy *vfio_user_connect_dev (SocketAddress *addr,Error **errp); +void vfio_user_disconnect (VFIOUserProxy *proxy); + +#endif /* VFIO_USER_PROXY_H */
include/hw/vfio/vfio-device.h +2 -0
@@ -46,6 +46,7 @@ typedef struct VFIOMigration VFIOMigration;typedef struct IOMMUFDBackend IOMMUFDBackend ;typedef struct VFIOIOASHwpt VFIOIOASHwpt ; +typedef struct VFIOUserProxy VFIOUserProxy ; typedef struct VFIODevice { QLIST_ENTRY(VFIODevice) next;
@@ -86,6 +87,7 @@ typedef struct VFIODevice {QLIST_ENTRY (VFIODevice) hwpt_next;struct vfio_region_info **reginfo;int *region_fds; +VFIOUserProxy *proxy; } VFIODevice;struct VFIODeviceOps {
hw/vfio-user/pci.c +17 -0
@@ -14,6 +14,7 @@#include "hw/qdev-properties.h" #include "hw/vfio/pci.h" +#include "hw/vfio-user/proxy.h" #define TYPE_VFIO_USER_PCI "vfio-user-pci"OBJECT_DECLARE_SIMPLE_TYPE (VFIOUserPCIDevice,VFIO_USER_PCI )
@@ -46,6 +47,8 @@ static void vfio_user_pci_realize(PCIDevice *pdev, Error **errp)VFIOPCIDevice *vdev =VFIO_PCI_BASE (pdev);VFIODevice *vbasedev = &vdev->vbasedev;AddressSpace *as; +SocketAddress addr; +VFIOUserProxy *proxy;/* * TODO: make option parser understand SocketAddress
@@ -58,6 +61,15 @@ static void vfio_user_pci_realize(PCIDevice *pdev, Error **errp)return ; } +memset (&addr,0 ,sizeof (addr)); + addr.type =SOCKET_ADDRESS_TYPE_UNIX ; + addr.u.q_unix.path = udev->sock_name; + proxy =vfio_user_connect_dev (&addr, errp); +if (!proxy) { +return ; + } + vbasedev->proxy = proxy; + vbasedev->name =g_strdup_printf ("VFIO user <%s>" , udev->sock_name);/*
@@ -103,8 +115,13 @@ static void vfio_user_instance_init(Object *obj)static void vfio_user_instance_finalize (Object *obj) {VFIOPCIDevice *vdev =VFIO_PCI_BASE (obj); +VFIODevice *vbasedev = &vdev->vbasedev;vfio_pci_put_device (vdev); + +if (vbasedev->proxy !=NULL ) { +vfio_user_disconnect (vbasedev->proxy); + } }static const Property vfio_user_pci_dev_properties[] = {
hw/vfio-user/proxy.c new file +165 -0
165 lines not on this page · raw message
hw/vfio-user/meson.build +1 -0
@@ -2,6 +2,7 @@ vfio_user_ss = ss.source_set() vfio_user_ss.add(files( 'container.c', 'pci.c', + 'proxy.c', )) if get_option('vfio_user_client').enabled()
Signature · 1 line
2.43.0
PATCH 12/27 vfio-user: implement message receive infrastructure
In reply to John LevonAdd the basic implementation for receiving vfio-user messages from the control socket.
--- meson.build | 1 + hw/vfio-user/protocol.h | 56 ++++++ hw/vfio-user/proxy.h | 11 + hw/vfio-user/trace.h | 1 + hw/vfio-user/pci.c | 11 + hw/vfio-user/proxy.c | 409 ++++++++++++++++++++++++++++++++++++++ hw/vfio-user/trace-events | 6 + 7 files changed, 495 insertions(+) create mode 100644 hw/vfio-user/protocol.h create mode 100644 hw/vfio-user/trace.h create mode 100644 hw/vfio-user/trace-events
meson.build +1 -0
@@ -3642,6 +3642,7 @@ if have_system 'hw/ufs', 'hw/usb', 'hw/vfio', + 'hw/vfio-user', 'hw/virtio', 'hw/vmapple', 'hw/watchdog',
hw/vfio-user/protocol.h new file +56 -0
56 lines not on this page · raw message
hw/vfio-user/proxy.h +11 -0
@@ -15,6 +15,9 @@#include "io/channel.h" #include "io/channel-socket.h" +#include "qemu/sockets.h" +#include "hw/vfio-user/protocol.h" + typedef struct { int send_fds; int recv_fds;
@@ -31,6 +34,7 @@ enum msg_type { typedef struct VFIOUserMsg { QTAILQ_ENTRY(VFIOUserMsg) next; + VFIOUserHdr *hdr; VFIOUserFDs *fds; uint32_t rsize; uint32_t id;
@@ -70,13 +74,20 @@ typedef struct VFIOUserProxy {VFIOUserMsgQ incoming;VFIOUserMsgQ outgoing;VFIOUserMsg *last_nowait; +VFIOUserMsg *part_recv; +size_t recv_left; enum proxy_state state; } VFIOUserProxy;/* VFIOProxy flags */ #define VFIO_PROXY_CLIENT 0x1 +typedef struct VFIODevice VFIODevice ; +VFIOUserProxy *vfio_user_connect_dev (SocketAddress *addr,Error **errp);void vfio_user_disconnect (VFIOUserProxy *proxy); +void vfio_user_set_handler (VFIODevice *vbasedev, +void (*handler)(void *opaque,VFIOUserMsg *msg), +void *reqarg);#endif /* VFIO_USER_PROXY_H */
hw/vfio-user/trace.h new file +1 -0
@@ -0,0 +1 @@ +#include "trace/trace-hw_vfio_user.h"
hw/vfio-user/pci.c +11 -0
@@ -24,6 +24,16 @@ struct VFIOUserPCIDevice {char *sock_name; }; +/* +* Incoming request message callback. +* +* Runs off main loop, so BQL held. +*/ +static void vfio_user_pci_process_req (void *opaque,VFIOUserMsg *msg) +{ + +} +/* * Emulated devices don't use host hot reset */
@@ -69,6 +79,7 @@ static void vfio_user_pci_realize(PCIDevice *pdev, Error **errp)return ; } vbasedev->proxy = proxy; +vfio_user_set_handler (vbasedev, vfio_user_pci_process_req, vdev); vbasedev->name =g_strdup_printf ("VFIO user <%s>" , udev->sock_name);
hw/vfio-user/proxy.c +409 -0
458 lines not on this page · raw message
hw/vfio-user/trace-events new file +6 -0
@@ -0,0 +1,6 @@ +# See docs/devel/tracing.rst for syntax documentation. + +# common.c +vfio_user_recv_hdr(const char *name, uint16_t id, uint16_t cmd, uint32_t size, uint32_t flags) " (%s) id 0x%x cmd 0x%x size 0x%x flags 0x%x" +vfio_user_recv_read(uint16_t id, int read) " id 0x%x read 0x%x" +vfio_user_recv_request(uint16_t cmd) " command 0x%x"
Signature · 1 line
2.43.0
PATCH 13/27 vfio-user: implement message send infrastructure
In reply to John LevonAdd plumbing for sending vfio-user messages on the control socket. Add initial version negotation on connection.
--- hw/vfio-user/protocol.h | 62 +++++ hw/vfio-user/proxy.h | 9 + hw/vfio-user/pci.c | 18 +- hw/vfio-user/proxy.c | 494 ++++++++++++++++++++++++++++++++++++++ hw/vfio-user/trace-events | 2 + 5 files changed, 583 insertions(+), 2 deletions(-)
hw/vfio-user/protocol.h +62 -0
@@ -53,4 +53,66 @@ enum vfio_user_command {#define VFIO_USER_NO_REPLY 0x10#define VFIO_USER_ERROR 0x20 + +/* +* VFIO_USER_VERSION +*/ +typedef struct { +VFIOUserHdr hdr; +uint16_t major; +uint16_t minor; +char capabilities[]; +}VFIOUserVersion ; + +#define VFIO_USER_MAJOR_VER 0 +#define VFIO_USER_MINOR_VER 0 + +#define VFIO_USER_CAP "capabilities" + +/* "capabilities" members */ +#define VFIO_USER_CAP_MAX_FDS "max_msg_fds" +#define VFIO_USER_CAP_MAX_XFER "max_data_xfer_size" +#define VFIO_USER_CAP_PGSIZES "pgsizes" +#define VFIO_USER_CAP_MAP_MAX "max_dma_maps" +#define VFIO_USER_CAP_MIGR "migration" + +/* "migration" members */ +#define VFIO_USER_CAP_PGSIZE "pgsize" +#define VFIO_USER_CAP_MAX_BITMAP "max_bitmap_size" + +/* +* Max FDs mainly comes into play when a device supports multiple interrupts +* where each ones uses an eventfd to inject it into the guest. +* It is clamped by the the number of FDs the qio channel supports in a +* single message. +*/ +#define VFIO_USER_DEF_MAX_FDS 8 +#define VFIO_USER_MAX_MAX_FDS 16 + +/* +* Max transfer limits the amount of data in region and DMA messages. +* Region R/W will be very small (limited by how much a single instruction +* can process) so just use a reasonable limit here. +*/ +#define VFIO_USER_DEF_MAX_XFER (1024 * 1024) +#define VFIO_USER_MAX_MAX_XFER (64 * 1024 * 1024) + +/* +* Default pagesizes supported is 4k. +*/ +#define VFIO_USER_DEF_PGSIZE 4096 + +/* +* Default max number of DMA mappings is stolen from the +* linux kernel "dma_entry_limit" +*/ +#define VFIO_USER_DEF_MAP_MAX 65535 + +/* +* Default max bitmap size is also take from the linux kernel, +* where usage of signed ints limits the VA range to 2^31 bytes. +* Dividing that by the number of bits per byte yields 256MB +*/ +#define VFIO_USER_DEF_MAX_BITMAP (256 * 1024 * 1024) +#endif /* VFIO_USER_PROTOCOL_H */
hw/vfio-user/proxy.h +9 -0
@@ -40,6 +40,7 @@ typedef struct VFIOUserMsg {uint32_t id;QemuCond cv;bool complete; +bool pending;enum msg_type type; } VFIOUserMsg;
@@ -59,6 +60,12 @@ typedef struct VFIOUserProxy {struct QIOChannel *ioc;void (*request)(void *opaque,VFIOUserMsg *msg);void *req_arg; +uint64_t max_xfer_size; +uint64_t max_send_fds; +uint64_t max_dma; +uint64_t dma_pgsizes; +uint64_t max_bitmap; +uint64_t migr_pgsize;int flags;QemuCond close_cv;AioContext *ctx;
@@ -81,6 +88,7 @@ typedef struct VFIOUserProxy {/* VFIOProxy flags */ #define VFIO_PROXY_CLIENT 0x1 +#define VFIO_PROXY_FORCE_QUEUED 0x4typedef struct VFIODevice VFIODevice ;
@@ -89,5 +97,6 @@ void vfio_user_disconnect(VFIOUserProxy *proxy);void vfio_user_set_handler (VFIODevice *vbasedev,void (*handler)(void *opaque,VFIOUserMsg *msg),void *reqarg); +bool vfio_user_validate_version (VFIOUserProxy *proxy,Error **errp);#endif /* VFIO_USER_PROXY_H */
hw/vfio-user/pci.c +16 -2
@@ -22,6 +22,7 @@ OBJECT_DECLARE_SIMPLE_TYPE(VFIOUserPCIDevice, VFIO_USER_PCI)struct VFIOUserPCIDevice {VFIOPCIDevice device;char *sock_name; +bool send_queued;/* all sends are queued */ };/*
@@ -81,6 +82,14 @@ static void vfio_user_pci_realize(PCIDevice *pdev, Error **errp) vbasedev->proxy = proxy;vfio_user_set_handler (vbasedev, vfio_user_pci_process_req, vdev); +if (udev->send_queued) { + proxy->flags |=VFIO_PROXY_FORCE_QUEUED ; + } + +if (!vfio_user_validate_version (proxy, errp)) { + goto error; + } + vbasedev->name =g_strdup_printf ("VFIO user <%s>" , udev->sock_name);/*
@@ -92,9 +101,13 @@ static void vfio_user_pci_realize(PCIDevice *pdev, Error **errp)if (!vfio_device_attach_by_iommu_type (TYPE_VFIO_IOMMU_USER , vbasedev->name, vbasedev, as, errp)) { -error_prepend (errp,VFIO_MSG_PREFIX , vbasedev->name); -return ; + goto error; } + +return ; + +error: +error_prepend (errp,VFIO_MSG_PREFIX , vdev->vbasedev.name); }static void vfio_user_instance_init (Object *obj)
@@ -145,6 +158,7 @@ static const Property vfio_user_pci_dev_properties[] = {DEFINE_PROP_UINT32 ("x-pci-sub-device-id" , VFIOPCIDevice, sub_device_id,PCI_ANY_ID ),DEFINE_PROP_STRING ("socket" , VFIOUserPCIDevice, sock_name), + DEFINE_PROP_BOOL("x-send-queued", VFIOUserPCIDevice, send_queued, false), };static void vfio_user_pci_dev_class_init (ObjectClass *klass,const void *data)
hw/vfio-user/proxy.c +494 -0
550 lines not on this page · raw message
hw/vfio-user/trace-events +2 -0
@@ -4,3 +4,5 @@ vfio_user_recv_hdr(const char *name, uint16_t id, uint16_t cmd, uint32_t size, uint32_t flags) " (%s) id 0x%x cmd 0x%x size 0x%x flags 0x%x" vfio_user_recv_read(uint16_t id, int read) " id 0x%x read 0x%x" vfio_user_recv_request(uint16_t cmd) " command 0x%x" +vfio_user_send_write(uint16_t id, int wrote) " id 0x%x wrote 0x%x" +vfio_user_version(uint16_t major, uint16_t minor, const char *caps) " major %d minor %d caps: %s"
Signature · 1 line
2.43.0
PATCH 14/27 vfio-user: implement VFIO_USER_DEVICE_GET_INFO
In reply to John LevonAdd support for getting basic device information.
--- hw/vfio-user/device.h | 23 ++++++++++++++++++ hw/vfio-user/protocol.h | 12 ++++++++++ hw/vfio-user/proxy.h | 7 ++++++ hw/vfio-user/container.c | 10 +++++++- hw/vfio-user/device.c | 50 +++++++++++++++++++++++++++++++++++++++ hw/vfio-user/proxy.c | 12 ++++------ hw/vfio-user/meson.build | 1 + hw/vfio-user/trace-events | 1 + 8 files changed, 107 insertions(+), 9 deletions(-) create mode 100644 hw/vfio-user/device.h create mode 100644 hw/vfio-user/device.c
hw/vfio-user/device.h new file +23 -0
@@ -0,0 +1,23 @@ +#ifndef VFIO_USER_DEVICE_H +#define VFIO_USER_DEVICE_H + +/* +* vfio protocol over a UNIX socket device handling. +* +* Copyright © 2018, 2021 Oracle and/or its affiliates. +* +* This work is licensed under the terms of the GNU GPL, version 2. See +* the COPYING file in the top-level directory. +* +* SPDX-License-Identifier: GPL-2.0-or-later +*/ + +#include "qemu/osdep.h" +#include "linux/vfio.h" + +#include "hw/vfio-user/proxy.h" + +int vfio_user_get_device_info (VFIOUserProxy *proxy, +struct vfio_device_info *info); + +#endif /* VFIO_USER_DEVICE_H */
hw/vfio-user/protocol.h +12 -0
@@ -115,4 +115,16 @@ typedef struct {*/ #define VFIO_USER_DEF_MAX_BITMAP (256 * 1024 * 1024) +/* +* VFIO_USER_DEVICE_GET_INFO +* imported from struct vfio_device_info +*/ +typedef struct { +VFIOUserHdr hdr; +uint32_t argsz; +uint32_t flags; +uint32_t num_regions; +uint32_t num_irqs; +}VFIOUserDeviceInfo ; +#endif /* VFIO_USER_PROTOCOL_H */
hw/vfio-user/proxy.h +7 -0
@@ -15,7 +15,9 @@#include "io/channel.h" #include "io/channel-socket.h" +#include "qemu/queue.h" #include "qemu/sockets.h" +#include "qemu/thread.h" #include "hw/vfio-user/protocol.h" typedef struct {
@@ -99,4 +101,9 @@ void vfio_user_set_handler(VFIODevice *vbasedev, void *reqarg);bool vfio_user_validate_version (VFIOUserProxy *proxy,Error **errp); +void vfio_user_request_msg (VFIOUserHdr *hdr,uint16_t cmd, +uint32_t size,uint32_t flags); +void vfio_user_send_wait (VFIOUserProxy *proxy,VFIOUserHdr *hdr, +VFIOUserFDs *fds,int rsize); +#endif /* VFIO_USER_PROXY_H */
hw/vfio-user/container.c +9 -1
@@ -14,6 +14,7 @@#include "qemu/osdep.h" #include "hw/vfio-user/container.h" +#include "hw/vfio-user/device.h" #include "hw/vfio/vfio-cpr.h" #include "hw/vfio/vfio-device.h" #include "hw/vfio/vfio-listener.h"
@@ -144,7 +145,14 @@ static void vfio_user_container_disconnect(VFIOUserContainer *container)static bool vfio_user_device_get (VFIOUserContainer *container,VFIODevice *vbasedev,Error **errp) { -struct vfio_device_info info = {0 }; +struct vfio_device_info info = { .argsz =sizeof (info) }; +int ret; + + ret =vfio_user_get_device_info (vbasedev->proxy, &info); +if (ret) { +error_setg_errno (errp, -ret,"get info failure" ); +return ret; + } vbasedev->fd =-1 ;
hw/vfio-user/device.c new file +50 -0
50 lines not on this page · raw message
hw/vfio-user/proxy.c +4 -8
@@ -42,10 +42,6 @@ static void vfio_user_cb(void *opaque);static void vfio_user_request (void *opaque);static int vfio_user_send_queued (VFIOUserProxy *proxy,VFIOUserMsg *msg); -static void vfio_user_send_wait (VFIOUserProxy *proxy,VFIOUserHdr *hdr, -VFIOUserFDs *fds,int rsize); -static void vfio_user_request_msg (VFIOUserHdr *hdr,uint16_t cmd, -uint32_t size,uint32_t flags);static inline void vfio_user_set_error (VFIOUserHdr *hdr,uint32_t err) {
@@ -613,8 +609,8 @@ static int vfio_user_send_queued(VFIOUserProxy *proxy, VFIOUserMsg *msg)return 0 ; } -static void vfio_user_send_wait (VFIOUserProxy *proxy,VFIOUserHdr *hdr, -VFIOUserFDs *fds,int rsize) +void vfio_user_send_wait (VFIOUserProxy *proxy,VFIOUserHdr *hdr, +VFIOUserFDs *fds,int rsize) {VFIOUserMsg *msg;int ret;
@@ -785,8 +781,8 @@ void vfio_user_disconnect(VFIOUserProxy *proxy)g_free (proxy); } -static void vfio_user_request_msg (VFIOUserHdr *hdr,uint16_t cmd, -uint32_t size,uint32_t flags) +void vfio_user_request_msg (VFIOUserHdr *hdr,uint16_t cmd, +uint32_t size,uint32_t flags) {static uint16_t next_id;
hw/vfio-user/meson.build +1 -0
@@ -1,6 +1,7 @@ vfio_user_ss = ss.source_set() vfio_user_ss.add(files( 'container.c', + 'device.c', 'pci.c', 'proxy.c', ))
hw/vfio-user/trace-events +1 -0
@@ -6,3 +6,4 @@ vfio_user_recv_read(uint16_t id, int read) " id 0x%x read 0x%x" vfio_user_recv_request(uint16_t cmd) " command 0x%x" vfio_user_send_write(uint16_t id, int wrote) " id 0x%x wrote 0x%x" vfio_user_version(uint16_t major, uint16_t minor, const char *caps) " major %d minor %d caps: %s" +vfio_user_get_info(uint32_t nregions, uint32_t nirqs) " #regions %d #irqs %d"
Signature · 1 line
2.43.0
PATCH 15/27 vfio-user: implement VFIO_USER_DEVICE_GET_REGION_INFO
In reply to John LevonAdd support for getting region info for vfio-user. As vfio-user has one fd per region, enable ->use_region_fds.
--- hw/vfio-user/device.h | 2 ++ hw/vfio-user/protocol.h | 14 ++++++++ hw/vfio-user/proxy.h | 1 + hw/vfio-user/device.c | 68 +++++++++++++++++++++++++++++++++++++++ hw/vfio-user/pci.c | 11 +++++++ hw/vfio-user/trace-events | 1 + 6 files changed, 97 insertions(+)
hw/vfio-user/device.h +2 -0
@@ -20,4 +20,6 @@int vfio_user_get_device_info (VFIOUserProxy *proxy,struct vfio_device_info *info); +extern VFIODeviceIOOps vfio_user_device_io_ops_sock; +#endif /* VFIO_USER_DEVICE_H */
hw/vfio-user/protocol.h +14 -0
@@ -127,4 +127,18 @@ typedef struct { uint32_t num_irqs; } VFIOUserDeviceInfo; +/* +* VFIO_USER_DEVICE_GET_REGION_INFO +* imported from struct vfio_region_info +*/ +typedef struct { +VFIOUserHdr hdr; +uint32_t argsz; +uint32_t flags; +uint32_t index; +uint32_t cap_offset; +uint64_t size; +uint64_t offset; +}VFIOUserRegionInfo ; +#endif /* VFIO_USER_PROTOCOL_H */
hw/vfio-user/proxy.h +1 -0
@@ -18,6 +18,7 @@#include "qemu/queue.h" #include "qemu/sockets.h" #include "qemu/thread.h" +#include "hw/vfio/vfio-device.h" #include "hw/vfio-user/protocol.h" typedef struct {
hw/vfio-user/device.c +68 -0
71 lines not on this page · raw message
hw/vfio-user/pci.c +11 -0
@@ -14,6 +14,7 @@#include "hw/qdev-properties.h" #include "hw/vfio/pci.h" +#include "hw/vfio-user/device.h" #include "hw/vfio-user/proxy.h" #define TYPE_VFIO_USER_PCI "vfio-user-pci"
@@ -92,11 +93,21 @@ static void vfio_user_pci_realize(PCIDevice *pdev, Error **errp) vbasedev->name =g_strdup_printf ("VFIO user <%s>" , udev->sock_name); +/* +* Use socket-based device I/O instead of vfio kernel driver. +*/ + vbasedev->io_ops = &vfio_user_device_io_ops_sock; +/* * vfio-user devices are effectively mdevs (don't use a host iommu). */ vbasedev->mdev = true; +/* +* Enable per-region fds. +*/ + vbasedev->use_region_fds = true; + as =pci_device_iommu_address_space (pdev); if (!vfio_device_attach_by_iommu_type(TYPE_VFIO_IOMMU_USER, vbasedev->name, vbasedev,
hw/vfio-user/trace-events +1 -0
@@ -7,3 +7,4 @@ vfio_user_recv_request(uint16_t cmd) " command 0x%x" vfio_user_send_write(uint16_t id, int wrote) " id 0x%x wrote 0x%x" vfio_user_version(uint16_t major, uint16_t minor, const char *caps) " major %d minor %d caps: %s" vfio_user_get_info(uint32_t nregions, uint32_t nirqs) " #regions %d #irqs %d" +vfio_user_get_region_info(uint32_t index, uint32_t flags, uint64_t size) " index %d flags 0x%x size 0x%"PRIx64
Signature · 1 line
2.43.0
PATCH 16/27 vfio-user: implement VFIO_USER_REGION_READ/WRITE
In reply to John Levon--- hw/vfio-user/protocol.h | 12 +++++++ hw/vfio-user/device.c | 67 +++++++++++++++++++++++++++++++++++++++ hw/vfio-user/trace-events | 1 + 3 files changed, 80 insertions(+)
hw/vfio-user/protocol.h +12 -0
@@ -141,4 +141,16 @@ typedef struct { uint64_t offset; } VFIOUserRegionInfo; +/* +* VFIO_USER_REGION_READ +* VFIO_USER_REGION_WRITE +*/ +typedef struct { +VFIOUserHdr hdr; +uint64_t offset; +uint32_t region; +uint32_t count; +char data[]; +}VFIOUserRegionRW ; +#endif /* VFIO_USER_PROTOCOL_H */
hw/vfio-user/device.c +67 -0
76 lines not on this page · raw message
hw/vfio-user/trace-events +1 -0
@@ -8,3 +8,4 @@ vfio_user_send_write(uint16_t id, int wrote) " id 0x%x wrote 0x%x" vfio_user_version(uint16_t major, uint16_t minor, const char *caps) " major %d minor %d caps: %s" vfio_user_get_info(uint32_t nregions, uint32_t nirqs) " #regions %d #irqs %d" vfio_user_get_region_info(uint32_t index, uint32_t flags, uint64_t size) " index %d flags 0x%x size 0x%"PRIx64 +vfio_user_region_rw(uint32_t region, uint64_t off, uint32_t count) " region %d offset 0x%"PRIx64" count %d"
Signature · 1 line
2.43.0
PATCH 17/27 vfio-user: set up PCI in vfio_user_pci_realize()
In reply to John LevonRe-use PCI setup functions from hw/vfio/pci.c to realize the vfio-user PCI device.
--- hw/vfio/pci.h | 8 ++++++++ hw/vfio-user/pci.c | 28 ++++++++++++++++++++++++++++ hw/vfio/pci.c | 16 ++++++++-------- 3 files changed, 44 insertions(+), 8 deletions(-)
hw/vfio/pci.h +8 -0
@@ -220,6 +220,14 @@ Object *vfio_pci_get_object(VFIODevice *vbasedev);int vfio_pci_save_config (VFIODevice *vbasedev,QEMUFile *f,Error **errp);int vfio_pci_load_config (VFIODevice *vbasedev,QEMUFile *f);void vfio_pci_put_device (VFIOPCIDevice *vdev); +bool vfio_populate_device (VFIOPCIDevice *vdev,Error **errp); +void vfio_teardown_msi (VFIOPCIDevice *vdev); +void vfio_bars_exit (VFIOPCIDevice *vdev); +bool vfio_add_capabilities (VFIOPCIDevice *vdev,Error **errp); +void vfio_register_err_notifier (VFIOPCIDevice *vdev); +void vfio_register_req_notifier (VFIOPCIDevice *vdev); +bool vfio_pci_config_setup (VFIOPCIDevice *vdev,Error **errp); +bool vfio_interrupt_setup (VFIOPCIDevice *vdev,Error **errp);uint64_t vfio_vga_read (void *opaque,hwaddr addr,unsigned size);void vfio_vga_write (void *opaque,hwaddr addr,uint64_t data,unsigned size);
hw/vfio-user/pci.c +28 -0
@@ -115,8 +115,36 @@ static void vfio_user_pci_realize(PCIDevice *pdev, Error **errp) goto error; } +if (!vfio_populate_device (vdev, errp)) { + goto error; + } + +if (!vfio_pci_config_setup (vdev, errp)) { + goto error; + } + +/* +* vfio_pci_config_setup will have registered the device's BARs +* and setup any MSIX BARs, so errors after it succeeds must +* use out_teardown +*/ + +if (!vfio_add_capabilities (vdev, errp)) { + goto out_teardown; + } + +if (!vfio_interrupt_setup (vdev, errp)) { + goto out_teardown; + } + +vfio_register_err_notifier (vdev); +vfio_register_req_notifier (vdev); +return ; +out_teardown: +vfio_teardown_msi (vdev); +vfio_bars_exit (vdev); error:error_prepend (errp,VFIO_MSG_PREFIX , vdev->vbasedev.name); }
hw/vfio/pci.c +8 -8
@@ -1770,7 +1770,7 @@ static bool vfio_msix_setup(VFIOPCIDevice *vdev, int pos, Error **errp)return true; } -static void vfio_teardown_msi (VFIOPCIDevice *vdev) +void vfio_teardown_msi (VFIOPCIDevice *vdev) {msi_uninit (&vdev->pdev);
@@ -1869,7 +1869,7 @@ static void vfio_bars_register(VFIOPCIDevice *vdev) } } -static void vfio_bars_exit (VFIOPCIDevice *vdev) +void vfio_bars_exit (VFIOPCIDevice *vdev) {int i;
@@ -2460,7 +2460,7 @@ static void vfio_add_ext_cap(VFIOPCIDevice *vdev)g_free (config); } -static bool vfio_add_capabilities (VFIOPCIDevice *vdev,Error **errp) +bool vfio_add_capabilities (VFIOPCIDevice *vdev,Error **errp) {PCIDevice *pdev = &vdev->pdev;
@@ -2807,7 +2807,7 @@ bool vfio_populate_vga(VFIOPCIDevice *vdev, Error **errp)return true; } -static bool vfio_populate_device (VFIOPCIDevice *vdev,Error **errp) +bool vfio_populate_device (VFIOPCIDevice *vdev,Error **errp) {VFIODevice *vbasedev = &vdev->vbasedev;struct vfio_region_info *reg_info =NULL ;
@@ -2943,7 +2943,7 @@ static void vfio_err_notifier_handler(void *opaque)* and continue after disabling error recovery support for the * device. */ -static void vfio_register_err_notifier (VFIOPCIDevice *vdev) +void vfio_register_err_notifier (VFIOPCIDevice *vdev) {Error *err =NULL ;int32_t fd;
@@ -3002,7 +3002,7 @@ static void vfio_req_notifier_handler(void *opaque) } } -static void vfio_register_req_notifier (VFIOPCIDevice *vdev) +void vfio_register_req_notifier (VFIOPCIDevice *vdev) {struct vfio_irq_info irq_info;Error *err =NULL ;
@@ -3056,7 +3056,7 @@ static void vfio_unregister_req_notifier(VFIOPCIDevice *vdev) vdev->req_enabled = false; } -static bool vfio_pci_config_setup (VFIOPCIDevice *vdev,Error **errp) +bool vfio_pci_config_setup (VFIOPCIDevice *vdev,Error **errp) {PCIDevice *pdev = &vdev->pdev;VFIODevice *vbasedev = &vdev->vbasedev;
@@ -3162,7 +3162,7 @@ static bool vfio_pci_config_setup(VFIOPCIDevice *vdev, Error **errp)return true; } -static bool vfio_interrupt_setup (VFIOPCIDevice *vdev,Error **errp) +bool vfio_interrupt_setup (VFIOPCIDevice *vdev,Error **errp) {PCIDevice *pdev = &vdev->pdev;
Signature · 1 line
2.43.0
PATCH 18/27 vfio-user: implement VFIO_USER_DEVICE_GET/SET_IRQ*
In reply to John LevonIRQ setup uses the same semantics as the traditional vfio path, but we need to share the corresponding file descriptors with the server as necessary.
--- hw/vfio-user/protocol.h | 25 ++++++++ hw/vfio-user/device.c | 121 ++++++++++++++++++++++++++++++++++++++ hw/vfio-user/trace-events | 2 + 3 files changed, 148 insertions(+)
hw/vfio-user/protocol.h +25 -0
@@ -141,6 +141,31 @@ typedef struct {uint64_t offset; } VFIOUserRegionInfo; +/* +* VFIO_USER_DEVICE_GET_IRQ_INFO +* imported from struct vfio_irq_info +*/ +typedef struct { +VFIOUserHdr hdr; +uint32_t argsz; +uint32_t flags; +uint32_t index; +uint32_t count; +}VFIOUserIRQInfo ; + +/* +* VFIO_USER_DEVICE_SET_IRQS +* imported from struct vfio_irq_set +*/ +typedef struct { +VFIOUserHdr hdr; +uint32_t argsz; +uint32_t flags; +uint32_t index; +uint32_t start; +uint32_t count; +}VFIOUserIRQSet ; +/* * VFIO_USER_REGION_READ * VFIO_USER_REGION_WRITE
hw/vfio-user/device.c +121 -0
133 lines not on this page · raw message
hw/vfio-user/trace-events +2 -0
@@ -9,3 +9,5 @@ vfio_user_version(uint16_t major, uint16_t minor, const char *caps) " major %d m vfio_user_get_info(uint32_t nregions, uint32_t nirqs) " #regions %d #irqs %d" vfio_user_get_region_info(uint32_t index, uint32_t flags, uint64_t size) " index %d flags 0x%x size 0x%"PRIx64 vfio_user_region_rw(uint32_t region, uint64_t off, uint32_t count) " region %d offset 0x%"PRIx64" count %d" +vfio_user_get_irq_info(uint32_t index, uint32_t flags, uint32_t count) " index %d flags 0x%x count %d" +vfio_user_set_irqs(uint32_t index, uint32_t start, uint32_t count, uint32_t flags) " index %d start %d count %d flags 0x%x"
Signature · 1 line
2.43.0
PATCH 19/27 vfio-user: forward MSI-X PBA BAR accesses to server
In reply to John LevonFor vfio-user, the server holds the pending IRQ state; set up an I/O region for the MSI-X PBA so we can ask the server for this state on a PBA read.
--- hw/vfio/pci.h | 1 + hw/vfio-user/pci.c | 64 ++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 65 insertions(+)
hw/vfio/pci.h +1 -0
@@ -116,6 +116,7 @@ typedef struct VFIOMSIXInfo {uint32_t pba_offset;unsigned long *pending;bool noresize; +MemoryRegion *pba_region; } VFIOMSIXInfo;/*
hw/vfio-user/pci.c +64 -0
82 lines not on this page · raw message
Signature · 1 line
2.43.0
PATCH 20/27 vfio-user: set up container access to the proxy
In reply to John LevonThe user container will shortly need access to the underlying vfio-user proxy; set this up.
--- hw/vfio-user/container.h | 2 ++ hw/vfio-user/container.c | 43 +++++++++++++++++++++++++++++++--------- 2 files changed, 36 insertions(+), 9 deletions(-)
hw/vfio-user/container.h +2 -0
@@ -14,10 +14,12 @@#include <stdbool.h> #include "hw/vfio/vfio-container-base.h" +#include "hw/vfio-user/proxy.h" /* MMU container sub-class for vfio-user. */ typedef struct VFIOUserContainer {VFIOContainerBase bcontainer; +VFIOUserProxy *proxy; }VFIOUserContainer ;OBJECT_DECLARE_SIMPLE_TYPE (VFIOUserContainer,VFIO_IOMMU_USER );
hw/vfio-user/container.c +34 -9
103 lines not on this page · raw message
Signature · 1 line
2.43.0
PATCH 21/27 vfio-user: implement VFIO_USER_DEVICE_RESET
In reply to John LevonHook this call up to the legacy reset handler for vfio-user-pci.
--- hw/vfio-user/device.h | 2 ++ hw/vfio-user/device.c | 12 ++++++++++++ hw/vfio-user/pci.c | 15 +++++++++++++++ 3 files changed, 29 insertions(+)
hw/vfio-user/device.h +2 -0
@@ -20,6 +20,8 @@int vfio_user_get_device_info (VFIOUserProxy *proxy,struct vfio_device_info *info); +void vfio_user_device_reset (VFIOUserProxy *proxy); +extern VFIODeviceIOOps vfio_user_device_io_ops_sock;#endif /* VFIO_USER_DEVICE_H */
hw/vfio-user/device.c +12 -0
@@ -49,6 +49,18 @@ int vfio_user_get_device_info(VFIOUserProxy *proxy,return 0 ; } +void vfio_user_device_reset (VFIOUserProxy *proxy) +{ +VFIOUserHdr msg; + +vfio_user_request_msg (&msg,VFIO_USER_DEVICE_RESET ,sizeof (msg),0 ); + +vfio_user_send_wait (proxy, &msg,NULL ,0 ); +if (msg.flags &VFIO_USER_ERROR ) { +error_printf ("reset reply error %d\n" , msg.error_reply); + } +} +static int vfio_user_get_region_info (VFIOUserProxy *proxy,struct vfio_region_info *info,VFIOUserFDs *fds)
hw/vfio-user/pci.c +15 -0
@@ -251,6 +251,20 @@ static void vfio_user_instance_finalize(Object *obj) } } +static void vfio_user_pci_reset (DeviceState *dev) +{ +VFIOPCIDevice *vdev =VFIO_PCI_BASE (dev); +VFIODevice *vbasedev = &vdev->vbasedev; + +vfio_pci_pre_reset (vdev); + +if (vbasedev->reset_works) { +vfio_user_device_reset (vbasedev->proxy); + } + +vfio_pci_post_reset (vdev); +} +static const Property vfio_user_pci_dev_properties[] = {DEFINE_PROP_UINT32 ("x-pci-vendor-id" , VFIOPCIDevice, vendor_id,PCI_ANY_ID ),
@@ -269,6 +283,7 @@ static void vfio_user_pci_dev_class_init(ObjectClass *klass, const void *data)DeviceClass *dc =DEVICE_CLASS (klass);PCIDeviceClass *pdc =PCI_DEVICE_CLASS (klass); +device_class_set_legacy_reset (dc, vfio_user_pci_reset);device_class_set_props (dc, vfio_user_pci_dev_properties); dc->desc ="VFIO over socket PCI device assignment" ; pdc->realize = vfio_user_pci_realize;
Signature · 1 line
2.43.0
PATCH 22/27 vfio-user: implement VFIO_USER_DMA_MAP/UNMAP
In reply to John LevonFrom: John Levon <[email protected]>
When the vfio-user container gets mapping updates, share them with the vfio-user by sending a message; this can include the region fd, allowing the server to directly mmap() the region as needed.
For performance, we only wait for the message responses when we're doing with a series of updates via the listener_commit() callback.
--- hw/vfio-user/protocol.h | 32 ++++++++++++ hw/vfio-user/proxy.h | 6 +++ hw/vfio-user/container.c | 107 +++++++++++++++++++++++++++++++++++++- hw/vfio-user/proxy.c | 77 ++++++++++++++++++++++++++- hw/vfio-user/trace-events | 4 ++ 5 files changed, 222 insertions(+), 4 deletions(-)
hw/vfio-user/protocol.h +32 -0
@@ -115,6 +115,31 @@ typedef struct {*/ #define VFIO_USER_DEF_MAX_BITMAP (256 * 1024 * 1024) +/* +* VFIO_USER_DMA_MAP +* imported from struct vfio_iommu_type1_dma_map +*/ +typedef struct { +VFIOUserHdr hdr; +uint32_t argsz; +uint32_t flags; +uint64_t offset;/* FD offset */ +uint64_t iova; +uint64_t size; +}VFIOUserDMAMap ; + +/* +* VFIO_USER_DMA_UNMAP +* imported from struct vfio_iommu_type1_dma_unmap +*/ +typedef struct { +VFIOUserHdr hdr; +uint32_t argsz; +uint32_t flags; +uint64_t iova; +uint64_t size; +}VFIOUserDMAUnmap ; +/* * VFIO_USER_DEVICE_GET_INFO * imported from struct vfio_device_info
@@ -178,4 +203,11 @@ typedef struct { char data[]; } VFIOUserRegionRW; +/*imported from struct vfio_bitmap */ +typedef struct { +uint64_t pgsize; +uint64_t size; +char data[]; +}VFIOUserBitmap ; +#endif /* VFIO_USER_PROTOCOL_H */
hw/vfio-user/proxy.h +6 -0
@@ -73,6 +73,7 @@ typedef struct VFIOUserProxy {QemuCond close_cv;AioContext *ctx;QEMUBH *req_bh; +bool async_ops;/* * above only changed when BQL is held
@@ -102,9 +103,14 @@ void vfio_user_set_handler(VFIODevice *vbasedev, void *reqarg);bool vfio_user_validate_version (VFIOUserProxy *proxy,Error **errp); +VFIOUserFDs *vfio_user_getfds (int numfds); +void vfio_user_request_msg (VFIOUserHdr *hdr,uint16_t cmd,uint32_t size,uint32_t flags); +void vfio_user_wait_reqs (VFIOUserProxy *proxy);void vfio_user_send_wait (VFIOUserProxy *proxy,VFIOUserHdr *hdr,VFIOUserFDs *fds,int rsize); +void vfio_user_send_nowait (VFIOUserProxy *proxy,VFIOUserHdr *hdr, +VFIOUserFDs *fds,int rsize);#endif /* VFIO_USER_PROXY_H */
hw/vfio-user/container.c +105 -2
129 lines not on this page · raw message
hw/vfio-user/proxy.c +75 -2
101 lines not on this page · raw message
hw/vfio-user/trace-events +4 -0
@@ -11,3 +11,7 @@ vfio_user_get_region_info(uint32_t index, uint32_t flags, uint64_t size) " index vfio_user_region_rw(uint32_t region, uint64_t off, uint32_t count) " region %d offset 0x%"PRIx64" count %d" vfio_user_get_irq_info(uint32_t index, uint32_t flags, uint32_t count) " index %d flags 0x%x count %d" vfio_user_set_irqs(uint32_t index, uint32_t start, uint32_t count, uint32_t flags) " index %d start %d count %d flags 0x%x" + +# container.c +vfio_user_dma_map(uint64_t iova, uint64_t size, uint64_t off, uint32_t flags, bool async_ops) " iova 0x%"PRIx64" size 0x%"PRIx64" off 0x%"PRIx64" flags 0x%x async_ops %d" +vfio_user_dma_unmap(uint64_t iova, uint64_t size, uint32_t flags, bool async_ops) " iova 0x%"PRIx64" size 0x%"PRIx64" flags 0x%x async_ops %d"
Signature · 1 line
2.43.0
PATCH 23/27 vfio-user: implement VFIO_USER_DMA_READ/WRITE
In reply to John LevonUnlike most other messages, this is a server->client message, for when a server wants to do "DMA"; this is slow, so normally the server has memory directly mapped instead.
--- hw/vfio-user/protocol.h | 13 ++++- hw/vfio-user/proxy.h | 3 ++ hw/vfio-user/pci.c | 111 ++++++++++++++++++++++++++++++++++++++++ hw/vfio-user/proxy.c | 84 ++++++++++++++++++++++++++++++ 4 files changed, 210 insertions(+), 1 deletion(-)
hw/vfio-user/protocol.h +12 -1
@@ -203,7 +203,18 @@ typedef struct {char data[]; } VFIOUserRegionRW; -/*imported from struct vfio_bitmap */ +/* +* VFIO_USER_DMA_READ +* VFIO_USER_DMA_WRITE +*/ +typedef struct { +VFIOUserHdr hdr; +uint64_t offset; +uint32_t count; +char data[]; +}VFIOUserDMARW ; + +/* imported from struct vfio_bitmap */ typedef struct { uint64_t pgsize; uint64_t size;
hw/vfio-user/proxy.h +3 -0
@@ -104,6 +104,7 @@ void vfio_user_set_handler(VFIODevice *vbasedev,bool vfio_user_validate_version (VFIOUserProxy *proxy,Error **errp);VFIOUserFDs *vfio_user_getfds (int numfds); +void vfio_user_putfds (VFIOUserMsg *msg);void vfio_user_request_msg (VFIOUserHdr *hdr,uint16_t cmd,uint32_t size,uint32_t flags);
@@ -112,5 +113,7 @@ void vfio_user_send_wait(VFIOUserProxy *proxy, VFIOUserHdr *hdr, VFIOUserFDs *fds, int rsize);void vfio_user_send_nowait (VFIOUserProxy *proxy,VFIOUserHdr *hdr,VFIOUserFDs *fds,int rsize); +void vfio_user_send_reply (VFIOUserProxy *proxy,VFIOUserHdr *hdr,int size); +void vfio_user_send_error (VFIOUserProxy *proxy,VFIOUserHdr *hdr,int error);#endif /* VFIO_USER_PROXY_H */
hw/vfio-user/pci.c +111 -0
130 lines not on this page · raw message
hw/vfio-user/proxy.c +84 -0
102 lines not on this page · raw message
Signature · 1 line
2.43.0
PATCH 24/27 vfio-user: add 'x-msg-timeout' option
In reply to John LevonBy default, the vfio-user subsystem will wait 5 seconds for a message reply from the server. Add an option to allow this to be configurable.
--- hw/vfio-user/proxy.h | 1 + hw/vfio-user/pci.c | 5 +++++ hw/vfio-user/proxy.c | 7 ++++--- 3 files changed, 10 insertions(+), 3 deletions(-)
hw/vfio-user/proxy.h +1 -0
@@ -70,6 +70,7 @@ typedef struct VFIOUserProxy {uint64_t max_bitmap;uint64_t migr_pgsize;int flags; +uint32_t wait_time;QemuCond close_cv;AioContext *ctx;QEMUBH *req_bh;
hw/vfio-user/pci.c +5 -0
@@ -25,6 +25,7 @@ struct VFIOUserPCIDevice {VFIOPCIDevice device;char *sock_name;bool send_queued;/* all sends are queued */ +uint32_t wait_time;/* timeout for message replies */ };/*
@@ -254,6 +255,9 @@ static void vfio_user_pci_realize(PCIDevice *pdev, Error **errp) proxy->flags |=VFIO_PROXY_FORCE_QUEUED ; } +/* user specified or 5 sec default */ + proxy->wait_time = udev->wait_time; +if (!vfio_user_validate_version (proxy, errp)) { goto error; }
@@ -387,6 +391,7 @@ static const Property vfio_user_pci_dev_properties[] = { sub_device_id, PCI_ANY_ID),DEFINE_PROP_STRING ("socket" , VFIOUserPCIDevice, sock_name),DEFINE_PROP_BOOL ("x-send-queued" , VFIOUserPCIDevice, send_queued, false), + DEFINE_PROP_UINT32("x-msg-timeout", VFIOUserPCIDevice, wait_time, 5000), };static void vfio_user_pci_dev_class_init (ObjectClass *klass,const void *data)
hw/vfio-user/proxy.c +4 -3
@@ -24,7 +24,6 @@#include "qemu/main-loop.h" #include "system/iothread.h" -static int wait_time =5000 ;/* wait up to 5 sec for busy servers */ static IOThread *vfio_user_iothread;static void vfio_user_shutdown (VFIOUserProxy *proxy);
@@ -665,7 +664,8 @@ void vfio_user_send_wait(VFIOUserProxy *proxy, VFIOUserHdr *hdr,if (ret ==0 ) {while (!msg->complete) { -if (!qemu_cond_timedwait (&msg->cv, &proxy->lock, wait_time)) { +if (!qemu_cond_timedwait (&msg->cv, &proxy->lock, + proxy->wait_time)) {VFIOUserMsgQ *list; list = msg->pending ? &proxy->pending : &proxy->outgoing;
@@ -725,7 +725,8 @@ void vfio_user_wait_reqs(VFIOUserProxy *proxy) msg->type =VFIO_MSG_WAIT ; proxy->last_nowait =NULL ;while (!msg->complete) { -if (!qemu_cond_timedwait (&msg->cv, &proxy->lock, wait_time)) { +if (!qemu_cond_timedwait (&msg->cv, &proxy->lock, + proxy->wait_time)) {VFIOUserMsgQ *list; list = msg->pending ? &proxy->pending : &proxy->outgoing;
Signature · 1 line
2.43.0
PATCH 25/27 vfio-user: support posted writes
In reply to John LevonSupport an asynchronous send of a vfio-user socket message (no wait for a reply) when the write is posted. This is only safe when no regions are mappable by the VM. Add an option to explicitly disable this as well.
--- hw/vfio-user/proxy.h | 5 +++++ hw/vfio-user/device.c | 37 ++++++++++++++++++++++++++++++++++--- hw/vfio-user/pci.c | 6 ++++++ hw/vfio-user/proxy.c | 12 ++++++++++-- 4 files changed, 55 insertions(+), 5 deletions(-)
hw/vfio-user/proxy.h +5 -0
@@ -94,6 +94,7 @@ typedef struct VFIOUserProxy {/* VFIOProxy flags */ #define VFIO_PROXY_CLIENT 0x1#define VFIO_PROXY_FORCE_QUEUED 0x4 +#define VFIO_PROXY_NO_POST 0x8typedef struct VFIODevice VFIODevice ;
@@ -107,6 +108,8 @@ bool vfio_user_validate_version(VFIOUserProxy *proxy, Error **errp);VFIOUserFDs *vfio_user_getfds (int numfds);void vfio_user_putfds (VFIOUserMsg *msg); +void vfio_user_disable_posted_writes (VFIOUserProxy *proxy); +void vfio_user_request_msg (VFIOUserHdr *hdr,uint16_t cmd,uint32_t size,uint32_t flags);void vfio_user_wait_reqs (VFIOUserProxy *proxy);
@@ -114,6 +117,8 @@ void vfio_user_send_wait(VFIOUserProxy *proxy, VFIOUserHdr *hdr, VFIOUserFDs *fds, int rsize);void vfio_user_send_nowait (VFIOUserProxy *proxy,VFIOUserHdr *hdr,VFIOUserFDs *fds,int rsize); +void vfio_user_send_async (VFIOUserProxy *proxy,VFIOUserHdr *hdr, +VFIOUserFDs *fds);void vfio_user_send_reply (VFIOUserProxy *proxy,VFIOUserHdr *hdr,int size);void vfio_user_send_error (VFIOUserProxy *proxy,VFIOUserHdr *hdr,int error);
hw/vfio-user/device.c +34 -3
@@ -93,10 +93,21 @@ static int vfio_user_get_region_info(VFIOUserProxy *proxy,trace_vfio_user_get_region_info (msgp->index, msgp->flags, msgp->size);memcpy (info, &msgp->argsz, info->argsz); + +/* +* If at least one region is directly mapped into the VM, then we can no +* longer rely on the sequential nature of vfio-user request handling to +* ensure that posted writes are completed before a subsequent read. In this +* case, disable posted write support. This is a per-device property, not +* per-region. +*/ +if (info->flags &VFIO_REGION_INFO_FLAG_MMAP ) { +vfio_user_disable_posted_writes (proxy); + } +return 0 ; } -static int vfio_user_device_io_get_region_info (VFIODevice *vbasedev,struct vfio_region_info *info,int *fd)
@@ -272,6 +283,12 @@ static int vfio_user_device_io_region_read(VFIODevice *vbasedev, uint8_t index,return msgp->count; } +/* +* If this is a posted write, and VFIO_PROXY_NO_POST is not set, then we are OK +* to send the write to the socket without waiting for the server's reply: +* a subsequent read (of any region) will not pass the posted write, as all +* messages are handled sequentially. +*/ static int vfio_user_device_io_region_write (VFIODevice *vbasedev,uint8_t index,off_t off,unsigned count,void *data,bool post)
@@ -279,21 +296,35 @@ static int vfio_user_device_io_region_write(VFIODevice *vbasedev, uint8_t index,VFIOUserRegionRW *msgp =NULL ;VFIOUserProxy *proxy = vbasedev->proxy;int size =sizeof (*msgp) + count; +int flags =0 ;int ret;if (count > proxy->max_xfer_size) {return -EINVAL ; } +if (proxy->flags &VFIO_PROXY_NO_POST ) { + post = false; + } + +if (post) { + flags |=VFIO_USER_NO_REPLY ; + } + msgp =g_malloc0 (size); -vfio_user_request_msg (&msgp->hdr,VFIO_USER_REGION_WRITE , size,0 ); +vfio_user_request_msg (&msgp->hdr,VFIO_USER_REGION_WRITE , size, flags); msgp->offset = off; msgp->region = index; msgp->count = count;memcpy (&msgp->data, data, count);trace_vfio_user_region_rw (msgp->region, msgp->offset, msgp->count); -/* Ignore post: all writes are synchronous/non-posted. */ +/* async send will free msg after it's sent */ +if (post) { +vfio_user_send_async (proxy, &msgp->hdr,NULL ); +return count; + } +vfio_user_send_wait (proxy, &msgp->hdr,NULL ,0 );if (msgp->hdr.flags &VFIO_USER_ERROR ) { ret = -msgp->hdr.error_reply;
hw/vfio-user/pci.c +6 -0
@@ -26,6 +26,7 @@ struct VFIOUserPCIDevice {char *sock_name;bool send_queued;/* all sends are queued */ uint32_t wait_time;/* timeout for message replies */ +bool no_post;/* all region writes are sync */ };/*
@@ -255,6 +256,10 @@ static void vfio_user_pci_realize(PCIDevice *pdev, Error **errp) proxy->flags |=VFIO_PROXY_FORCE_QUEUED ; } +if (udev->no_post) { + proxy->flags |=VFIO_PROXY_NO_POST ; + } +/* user specified or 5 sec default */ proxy->wait_time = udev->wait_time;
@@ -392,6 +397,7 @@ static const Property vfio_user_pci_dev_properties[] = {DEFINE_PROP_STRING ("socket" , VFIOUserPCIDevice, sock_name),DEFINE_PROP_BOOL ("x-send-queued" , VFIOUserPCIDevice, send_queued, false),DEFINE_PROP_UINT32 ("x-msg-timeout" , VFIOUserPCIDevice, wait_time,5000 ), + DEFINE_PROP_BOOL("x-no-posted-writes", VFIOUserPCIDevice, no_post, false), };static void vfio_user_pci_dev_class_init (ObjectClass *klass,const void *data)
hw/vfio-user/proxy.c +10 -2
@@ -683,8 +683,8 @@ void vfio_user_send_wait(VFIOUserProxy *proxy, VFIOUserHdr *hdr,/* * async send - msg can be queued, but will be freed when sent */ -static void vfio_user_send_async (VFIOUserProxy *proxy,VFIOUserHdr *hdr, -VFIOUserFDs *fds) +void vfio_user_send_async (VFIOUserProxy *proxy,VFIOUserHdr *hdr, +VFIOUserFDs *fds) {VFIOUserMsg *msg;int ret;
@@ -805,6 +805,14 @@ void vfio_user_putfds(VFIOUserMsg *msg) msg->fds =NULL ; } +void +vfio_user_disable_posted_writes (VFIOUserProxy *proxy) +{ + WITH_QEMU_LOCK_GUARD(&proxy->lock) { + proxy->flags |=VFIO_PROXY_NO_POST ; + } +} + static QLIST_HEAD(, VFIOUserProxy) vfio_user_sockets =QLIST_HEAD_INITIALIZER (vfio_user_sockets);
Signature · 1 line
2.43.0
PATCH 26/27 vfio-user: add coalesced posted writes
In reply to John LevonAdd new message to send multiple writes to server in a single message. Prevents the outgoing queue from overflowing when a long latency operation is followed by a series of posted writes.
--- hw/vfio-user/protocol.h | 21 ++++++++++ hw/vfio-user/proxy.h | 12 ++++++ hw/vfio-user/device.c | 40 +++++++++++++++++++ hw/vfio-user/proxy.c | 84 +++++++++++++++++++++++++++++++++++++++ hw/vfio-user/trace-events | 1 + 5 files changed, 158 insertions(+)
hw/vfio-user/protocol.h +21 -0
@@ -42,6 +42,7 @@ enum vfio_user_command {VFIO_USER_DMA_WRITE =12 ,VFIO_USER_DEVICE_RESET =13 ,VFIO_USER_DIRTY_PAGES =14 , +VFIO_USER_REGION_WRITE_MULTI =15 , VFIO_USER_MAX, };
@@ -75,6 +76,7 @@ typedef struct {#define VFIO_USER_CAP_PGSIZES "pgsizes"#define VFIO_USER_CAP_MAP_MAX "max_dma_maps"#define VFIO_USER_CAP_MIGR "migration" +#define VFIO_USER_CAP_MULTI "write_multiple"/* "migration" members */ #define VFIO_USER_CAP_PGSIZE "pgsize"
@@ -221,4 +223,23 @@ typedef struct { char data[]; } VFIOUserBitmap; +/* +* VFIO_USER_REGION_WRITE_MULTI +*/ +#define VFIO_USER_MULTI_DATA 8 +#define VFIO_USER_MULTI_MAX 200 + +typedef struct { +uint64_t offset; +uint32_t region; +uint32_t count; +char data[VFIO_USER_MULTI_DATA ]; +}VFIOUserWROne ; + +typedef struct { +VFIOUserHdr hdr; +uint64_t wr_cnt; +VFIOUserWROne wrs[VFIO_USER_MULTI_MAX ]; +}VFIOUserWRMulti ; +#endif /* VFIO_USER_PROTOCOL_H */
hw/vfio-user/proxy.h +12 -0
@@ -88,6 +88,8 @@ typedef struct VFIOUserProxy {VFIOUserMsg *last_nowait;VFIOUserMsg *part_recv;size_t recv_left; +VFIOUserWRMulti *wr_multi; +int num_outgoing;enum proxy_state state; } VFIOUserProxy;
@@ -95,6 +97,11 @@ typedef struct VFIOUserProxy {#define VFIO_PROXY_CLIENT 0x1#define VFIO_PROXY_FORCE_QUEUED 0x4#define VFIO_PROXY_NO_POST 0x8 +#define VFIO_PROXY_USE_MULTI 0x16 + +/* coalescing high and low water marks for VFIOProxy num_outgoing */ +#define VFIO_USER_OUT_HIGH 1024 +#define VFIO_USER_OUT_LOW 128typedef struct VFIODevice VFIODevice ;
@@ -122,4 +129,9 @@ void vfio_user_send_async(VFIOUserProxy *proxy, VFIOUserHdr *hdr,void vfio_user_send_reply (VFIOUserProxy *proxy,VFIOUserHdr *hdr,int size);void vfio_user_send_error (VFIOUserProxy *proxy,VFIOUserHdr *hdr,int error); +void vfio_user_flush_multi (VFIOUserProxy *proxy); +void vfio_user_create_multi (VFIOUserProxy *proxy); +void vfio_user_add_multi (VFIOUserProxy *proxy,uint8_t index, +off_t offset,uint32_t count,void *data); +#endif /* VFIO_USER_PROXY_H */
hw/vfio-user/device.c +40 -0
@@ -10,6 +10,8 @@*/ #include "qemu/osdep.h" +#include "qemu/lockable.h" +#include "qemu/thread.h" #include "hw/vfio-user/device.h" #include "hw/vfio-user/trace.h"
@@ -296,6 +298,7 @@ static int vfio_user_device_io_region_write(VFIODevice *vbasedev, uint8_t index,VFIOUserRegionRW *msgp =NULL ;VFIOUserProxy *proxy = vbasedev->proxy;int size =sizeof (*msgp) + count; +bool can_multi;int flags =0 ;int ret;
@@ -311,6 +314,43 @@ static int vfio_user_device_io_region_write(VFIODevice *vbasedev, uint8_t index, flags |=VFIO_USER_NO_REPLY ; } +/* write eligible to be in a WRITE_MULTI msg ? */ + can_multi = (proxy->flags &VFIO_PROXY_USE_MULTI ) && post && + count <=VFIO_USER_MULTI_DATA ; + +/* +* This should be a rare case, so first check without the lock, +* if we're wrong, vfio_send_queued() will flush any posted writes +* we missed here +*/ +if (proxy->wr_multi !=NULL || + (proxy->num_outgoing >VFIO_USER_OUT_HIGH && can_multi)) { + +/* +* re-check with lock +* +* if already building a WRITE_MULTI msg, +* add this one if possible else flush pending before +* sending the current one +* +* else if outgoing queue is over the highwater, +* start a new WRITE_MULTI message +*/ + WITH_QEMU_LOCK_GUARD(&proxy->lock) { +if (proxy->wr_multi !=NULL ) { +if (can_multi) { +vfio_user_add_multi (proxy, index, off, count, data); +return count; + } +vfio_user_flush_multi (proxy); + }else if (proxy->num_outgoing >VFIO_USER_OUT_HIGH && can_multi) { +vfio_user_create_multi (proxy); +vfio_user_add_multi (proxy, index, off, count, data); +return count; + } + } + } + msgp =g_malloc0 (size);vfio_user_request_msg (&msgp->hdr,VFIO_USER_REGION_WRITE , size, flags); msgp->offset = off;
hw/vfio-user/proxy.c +84 -0
146 lines not on this page · raw message
hw/vfio-user/trace-events +1 -0
@@ -11,6 +11,7 @@ vfio_user_get_region_info(uint32_t index, uint32_t flags, uint64_t size) " index vfio_user_region_rw(uint32_t region, uint64_t off, uint32_t count) " region %d offset 0x%"PRIx64" count %d" vfio_user_get_irq_info(uint32_t index, uint32_t flags, uint32_t count) " index %d flags 0x%x count %d" vfio_user_set_irqs(uint32_t index, uint32_t start, uint32_t count, uint32_t flags) " index %d start %d count %d flags 0x%x" +vfio_user_wrmulti(const char *s, uint64_t wr_cnt) " %s count 0x%"PRIx64 # container.c vfio_user_dma_map(uint64_t iova, uint64_t size, uint64_t off, uint32_t flags, bool async_ops) " iova 0x%"PRIx64" size 0x%"PRIx64" off 0x%"PRIx64" flags 0x%x async_ops %d"
Signature · 1 line
2.43.0
PATCH 27/27 docs: add vfio-user documentation
In reply to John LevonAdd some basic documentation on vfio-user usage.
--- docs/system/device-emulation.rst | 1 + docs/system/devices/vfio-user.rst | 24 ++++++++++++++++++++++++ 2 files changed, 25 insertions(+) create mode 100644 docs/system/devices/vfio-user.rst
docs/system/device-emulation.rst +1 -0
@@ -85,6 +85,7 @@ Emulated Devices devices/can.rst devices/ccid.rst devices/cxl.rst + devices/vfio-user.rst devices/ivshmem.rst devices/ivshmem-flat.rst devices/keyboard.rst
docs/system/devices/vfio-user.rst new file +24 -0
@@ -0,0 +1,24 @@ +========= +vfio-user +========= + +QEMU includes a ``vfio-user`` client. The ``vfio-user`` specification allows for +implementing (PCI) devices in userspace outside of QEMU; it is similar to +``vhost-user`` in this respect (see :doc:`vhost-user`), but can emulate arbitrary +PCI devices, not just ``virtio``. Whereas ``vfio`` is handled by the host +kernel, ``vfio-user``, while similar in implementation, is handled entirely in +userspace. + +For example, SPDK includes a virtual PCI NVMe controller implementation; by +setting up a ``vfio-user`` UNIX socket between QEMU and SPDK, a VM can send NVMe +I/O to the SPDK process. + +Presuming a suitable ``vfio-user`` server has opened a socket at +``/tmp/vfio-user.sock``, a device can be configured with for example: + +.. code-block:: console + +-device vfio-user-pci,socket=/tmp/vfio-user.sock,bus=pcie.0,addr=0x9 + +See `libvfio-user <https://github.com/nutanix/libvfio-user/>`_ for further +information.
Signature · 1 line
2.43.0
John,
+ Steven,
Quoted 92 lines · John Levon
The series contains an implement of a vfio-user client in QEMU, along with a few more preparatory patches.
The vfio-user protocol allows for implementing (PCI) devices in another userspace process; SPDK is one example, which includes a virtual NVMe implementation.
The vfio-user framework consists of 3 parts:
1) The VFIO user protocol specification.
2) A client - the VFIO device in QEMU that encapsulates VFIO messages and sends them to the server.
3) A server - a remote process that emulates a device.This patchset implements parts 1 and 2.
It has been tested against libvfio-user test servers as well as SPDK.
A previous version of this series can be found at
https://lore.kernel.org/all/[email protected]/T/
(I've reset the version as it has changed significantly.)thanks
johnJohn Levon (25):
vfio/container: pass MemoryRegion to DMA operations
vfio: move more cleanup intovfio_pci_put_device()
vfio: move config space read intovfio_pci_config_setup()
vfio: refactor out IRQ signalling setup
vfio: enable per-IRQ MSI-X masking
vfio: add per-region fd support
vfio: mark posted writes in region write callbacks
vfio-user: add vfio-user class and container
vfio-user: connect vfio proxy to remote server
vfio-user: implement message receive infrastructure
vfio-user: implement message send infrastructure
vfio-user: implementVFIO_USER_DEVICE_GET_INFO
vfio-user: implementVFIO_USER_DEVICE_GET_REGION_INFO
vfio-user: implement VFIO_USER_REGION_READ/WRITE
vfio-user: set up PCI invfio_user_pci_realize()
vfio-user: implement VFIO_USER_DEVICE_GET/SET_IRQ*
vfio-user: forward MSI-X PBA BAR accesses to server
vfio-user: set up container access to the proxy
vfio-user: implementVFIO_USER_DEVICE_RESET
vfio-user: implement VFIO_USER_DMA_MAP/UNMAP
vfio-user: implement VFIO_USER_DMA_READ/WRITE
vfio-user: add 'x-msg-timeout' option
vfio-user: support posted writes
vfio-user: add coalesced posted writes
docs: add vfio-user documentationSteve Sistare (1):
vfio: return mr fromvfio_get_xlat_addrThanos Makatos (1):
vfio-user: introduce vfio-user protocol specificationMAINTAINERS | 10 +- docs/devel/index-internals.rst | 1 + docs/devel/vfio-user.rst | 1522 +++++++++++++++++++++++++ docs/system/device-emulation.rst | 1 + docs/system/devices/vfio-user.rst | 24 + meson.build | 1 + hw/vfio-user/container.h | 27 + hw/vfio-user/device.h | 27 + hw/vfio-user/protocol.h | 245 ++++ hw/vfio-user/proxy.h | 137 +++ hw/vfio-user/trace.h | 1 + hw/vfio/pci.h | 16 + include/hw/vfio/vfio-container-base.h | 5 +- include/hw/vfio/vfio-device.h | 15 +- include/hw/vfio/vfio-region.h | 2 + include/system/memory.h | 16 +- hw/vfio-user/container.c | 348 ++++++ hw/vfio-user/device.c | 389 +++++++ hw/vfio-user/pci.c | 428 +++++++ hw/vfio-user/proxy.c | 1314 +++++++++++++++++++++ hw/vfio/container-base.c | 4 +- hw/vfio/container.c | 3 +- hw/vfio/device.c | 57 +- hw/vfio/iommufd.c | 3 +- hw/vfio/listener.c | 35 +- hw/vfio/pci.c | 163 ++- hw/vfio/region.c | 10 +- hw/virtio/vhost-vdpa.c | 8 +- system/memory.c | 25 +- hw/meson.build | 1 + hw/vfio-user/meson.build | 11 + hw/vfio-user/trace-events | 18 + meson_options.txt | 2 + scripts/meson-buildoptions.sh | 4 + 34 files changed, 4753 insertions(+), 120 deletions(-)
Quoted 14 lines
create mode 100644
docs/devel/vfio-user.rstcreate mode 100644docs/system/devices/vfio-user.rstcreate mode 100644hw/vfio-user/container.hcreate mode 100644hw/vfio-user/device.hcreate mode 100644hw/vfio-user/protocol.hcreate mode 100644hw/vfio-user/proxy.hcreate mode 100644hw/vfio-user/trace.hcreate mode 100644hw/vfio-user/container.ccreate mode 100644hw/vfio-user/device.ccreate mode 100644hw/vfio-user/pci.ccreate mode 100644hw/vfio-user/proxy.ccreate mode 100644 hw/vfio-user/meson.build create mode 100644 hw/vfio-user/trace-events
patches 3-5 seem be ok to merge. They are first on my vfio-next candidates.
patches 1-2 should be reworked on top of the memory_get_xlat_addr() changes [1] proposed by Steven.
I haven't looked at patches 6-8 yet. I think I saw some conflicts with the live update proposal from Steven. To be clarified next.
The rest (9-27) is vfio-user territory only (I hope). Still, it should be merged through the VFIO tree. Would it be complex to propose a functional test for it ?
Thanks,
C.
Quoted 5 lines · Cédric Le Goater
patches 3-5 seem be ok to merge. They are first on my vfio-next candidates.
patches 1-2 should be reworked on top of the
memory_get_xlat_addr()changes [1] proposed by Steven.
Now v5 is out I will rebase on top of it.
Quoted 2 lines
The rest (9-27) is vfio-user territory only (I hope). Still, it should be merged through the VFIO tree.
It isn't entirely contained within hw/vfio-user/ (there are e.g. some exports of util functions), but yes essentially. See diff below for illustration.
Quoted 1 line
Would it be complex to propose a functional test for it ?
We have a libvfio-user we can use, but this would be a problem:
487 │ 2025-05-19 14:19:20,304: modprobe gpio-pci-idio-16 488 │ 2025-05-19 14:19:20,306: modprobe: FATAL: Module gpio-pci-idio-16 not found in directory /lib/modules/5.3.7-301.fc31.x86_64
If somebody can help with how to get a suitable test initrd with this module available, we could at least do basic testing (although no DMA).
regards
john
hw/vfio/pci.h +15 -0
@@ -116,6 +116,7 @@ typedef struct VFIOMSIXInfo {uint32_t pba_offset;unsigned long *pending;bool noresize; +MemoryRegion *pba_region; } VFIOMSIXInfo;/*
@@ -215,6 +216,20 @@ uint32_t vfio_pci_read_config(PCIDevice *pdev, uint32_t addr, int len);void vfio_pci_write_config (PCIDevice *pdev,uint32_t addr,uint32_t val,int len); +void vfio_intx_eoi (VFIODevice *vbasedev); +Object *vfio_pci_get_object (VFIODevice *vbasedev); +int vfio_pci_save_config (VFIODevice *vbasedev,QEMUFile *f,Error **errp); +int vfio_pci_load_config (VFIODevice *vbasedev,QEMUFile *f); +void vfio_pci_put_device (VFIOPCIDevice *vdev); +bool vfio_populate_device (VFIOPCIDevice *vdev,Error **errp); +void vfio_teardown_msi (VFIOPCIDevice *vdev); +void vfio_bars_exit (VFIOPCIDevice *vdev); +bool vfio_add_capabilities (VFIOPCIDevice *vdev,Error **errp); +void vfio_register_err_notifier (VFIOPCIDevice *vdev); +void vfio_register_req_notifier (VFIOPCIDevice *vdev); +bool vfio_pci_config_setup (VFIOPCIDevice *vdev,Error **errp); +bool vfio_interrupt_setup (VFIOPCIDevice *vdev,Error **errp); +uint64_t vfio_vga_read (void *opaque,hwaddr addr,unsigned size);void vfio_vga_write (void *opaque,hwaddr addr,uint64_t data,unsigned size);
include/hw/vfio/vfio-container-base.h +1 -0
@@ -109,6 +109,7 @@ vfio_container_get_page_size_mask(const VFIOContainerBase *bcontainer)#define TYPE_VFIO_IOMMU_LEGACY TYPE_VFIO_IOMMU "-legacy"#define TYPE_VFIO_IOMMU_SPAPR TYPE_VFIO_IOMMU "-spapr"#define TYPE_VFIO_IOMMU_IOMMUFD TYPE_VFIO_IOMMU "-iommufd" +#define TYPE_VFIO_IOMMU_USER TYPE_VFIO_IOMMU "-user"OBJECT_DECLARE_TYPE (VFIOContainerBase, VFIOIOMMUClass,VFIO_IOMMU )
include/hw/vfio/vfio-device.h +2 -0
@@ -46,6 +46,7 @@ typedef struct VFIOMigration VFIOMigration;typedef struct IOMMUFDBackend IOMMUFDBackend ;typedef struct VFIOIOASHwpt VFIOIOASHwpt ; +typedef struct VFIOUserProxy VFIOUserProxy ; typedef struct VFIODevice { QLIST_ENTRY(VFIODevice) next;
@@ -86,6 +87,7 @@ typedef struct VFIODevice {QLIST_ENTRY (VFIODevice) hwpt_next;struct vfio_region_info **reginfo;int *region_fds; +VFIOUserProxy *proxy; } VFIODevice;struct VFIODeviceOps {
hw/vfio/pci.c +13 -13
@@ -103,7 +103,7 @@ static void vfio_intx_interrupt(void *opaque) } } -static void vfio_intx_eoi (VFIODevice *vbasedev) +void vfio_intx_eoi (VFIODevice *vbasedev) {VFIOPCIDevice *vdev =container_of (vbasedev, VFIOPCIDevice, vbasedev);
@@ -1770,7 +1770,7 @@ static bool vfio_msix_setup(VFIOPCIDevice *vdev, int pos, Error **errp)return true; } -static void vfio_teardown_msi (VFIOPCIDevice *vdev) +void vfio_teardown_msi (VFIOPCIDevice *vdev) {msi_uninit (&vdev->pdev);
@@ -1869,7 +1869,7 @@ static void vfio_bars_register(VFIOPCIDevice *vdev) } } -static void vfio_bars_exit (VFIOPCIDevice *vdev) +void vfio_bars_exit (VFIOPCIDevice *vdev) {int i;
@@ -2460,7 +2460,7 @@ static void vfio_add_ext_cap(VFIOPCIDevice *vdev)g_free (config); } -static bool vfio_add_capabilities (VFIOPCIDevice *vdev,Error **errp) +bool vfio_add_capabilities (VFIOPCIDevice *vdev,Error **errp) {PCIDevice *pdev = &vdev->pdev;
@@ -2629,7 +2629,7 @@ static void vfio_pci_compute_needs_reset(VFIODevice *vbasedev) } } -static Object *vfio_pci_get_object (VFIODevice *vbasedev) +Object *vfio_pci_get_object (VFIODevice *vbasedev) {VFIOPCIDevice *vdev =container_of (vbasedev, VFIOPCIDevice, vbasedev);
@@ -2685,7 +2685,7 @@ static const VMStateDescription vmstate_vfio_pci_config = { } }; -static int vfio_pci_save_config (VFIODevice *vbasedev,QEMUFile *f,Error **errp) +int vfio_pci_save_config (VFIODevice *vbasedev,QEMUFile *f,Error **errp) {VFIOPCIDevice *vdev =container_of (vbasedev, VFIOPCIDevice, vbasedev);
@@ -2693,7 +2693,7 @@ static int vfio_pci_save_config(VFIODevice *vbasedev, QEMUFile *f, Error **errp) errp); } -static int vfio_pci_load_config (VFIODevice *vbasedev,QEMUFile *f) +int vfio_pci_load_config (VFIODevice *vbasedev,QEMUFile *f) {VFIOPCIDevice *vdev =container_of (vbasedev, VFIOPCIDevice, vbasedev);PCIDevice *pdev = &vdev->pdev;
@@ -2807,7 +2807,7 @@ bool vfio_populate_vga(VFIOPCIDevice *vdev, Error **errp)return true; } -static bool vfio_populate_device (VFIOPCIDevice *vdev,Error **errp) +bool vfio_populate_device (VFIOPCIDevice *vdev,Error **errp) {VFIODevice *vbasedev = &vdev->vbasedev;struct vfio_region_info *reg_info =NULL ;
@@ -2895,7 +2895,7 @@ static bool vfio_populate_device(VFIOPCIDevice *vdev, Error **errp)return true; } -static void vfio_pci_put_device (VFIOPCIDevice *vdev) +void vfio_pci_put_device (VFIOPCIDevice *vdev) {vfio_display_finalize (vdev);vfio_bars_finalize (vdev);
@@ -2943,7 +2943,7 @@ static void vfio_err_notifier_handler(void *opaque)* and continue after disabling error recovery support for the * device. */ -static void vfio_register_err_notifier (VFIOPCIDevice *vdev) +void vfio_register_err_notifier (VFIOPCIDevice *vdev) {Error *err =NULL ;int32_t fd;
@@ -3002,7 +3002,7 @@ static void vfio_req_notifier_handler(void *opaque) } } -static void vfio_register_req_notifier (VFIOPCIDevice *vdev) +void vfio_register_req_notifier (VFIOPCIDevice *vdev) {struct vfio_irq_info irq_info;Error *err =NULL ;
@@ -3056,7 +3056,7 @@ static void vfio_unregister_req_notifier(VFIOPCIDevice *vdev) vdev->req_enabled = false; } -static bool vfio_pci_config_setup (VFIOPCIDevice *vdev,Error **errp) +bool vfio_pci_config_setup (VFIOPCIDevice *vdev,Error **errp) {PCIDevice *pdev = &vdev->pdev;VFIODevice *vbasedev = &vdev->vbasedev;
@@ -3162,7 +3162,7 @@ static bool vfio_pci_config_setup(VFIOPCIDevice *vdev, Error **errp)return true; } -static bool vfio_interrupt_setup (VFIOPCIDevice *vdev,Error **errp) +bool vfio_interrupt_setup (VFIOPCIDevice *vdev,Error **errp) {PCIDevice *pdev = &vdev->pdev;
Hello John,
Quoted 9 lines
Quoted 1 line
Would it be complex to propose a functional test for it ?
We have a libvfio-user we can use, but this would be a problem:
487 │ 2025-05-19 14:19:20,304: modprobe gpio-pci-idio-16 488 │ 2025-05-19 14:19:20,306: modprobe: FATAL: Module gpio-pci-idio-16 not found in directory /lib/modules/5.3.7-301.fc31.x86_64If somebody can help with how to get a suitable test initrd with this module available, we could at least do basic testing (although no DMA).
Can't we update the asset and use newer images ? It's also possible to use a custom build, buildroot images for instance.
Thanks,
C.
Quoted 4 lines · Cédric Le Goater
Quoted 4 lines
Quoted 1 line
Would it be complex to propose a functional test for it ?
We have a libvfio-user we can use, but this would be a problem:
Quoted 8 lines
Quoted 5 lines
487 │ 2025-05-19 14:19:20,304: modprobe gpio-pci-idio-16 488 │ 2025-05-19 14:19:20,306: modprobe: FATAL: Module gpio-pci-idio-16 not found in directory /lib/modules/5.3.7-301.fc31.x86_64If somebody can help with how to get a suitable test initrd with this module available, we could at least do basic testing (although no DMA).
Can't we update the asset and use newer images ? It's also possible to use a custom build, buildroot images for instance.
Mark is going to help me out with this, stay tuned.
In the meantime I sent out a v2 of the series, as there's a couple of additional generic vfio patches you might want to review.
thanks
john