1 /* 2 * VFIO BASE CONTAINER 3 * 4 * Copyright (C) 2023 Intel Corporation. 5 * Copyright Red Hat, Inc. 2023 6 * 7 * Authors: Yi Liu <yi.l.liu@intel.com> 8 * Eric Auger <eric.auger@redhat.com> 9 * 10 * SPDX-License-Identifier: GPL-2.0-or-later 11 */ 12 13 #ifndef HW_VFIO_VFIO_CONTAINER_BASE_H 14 #define HW_VFIO_VFIO_CONTAINER_BASE_H 15 16 #include "exec/memory.h" 17 18 typedef struct VFIODevice VFIODevice; 19 typedef struct VFIOIOMMUOps VFIOIOMMUOps; 20 21 typedef struct { 22 unsigned long *bitmap; 23 hwaddr size; 24 hwaddr pages; 25 } VFIOBitmap; 26 27 typedef struct VFIOAddressSpace { 28 AddressSpace *as; 29 QLIST_HEAD(, VFIOContainerBase) containers; 30 QLIST_ENTRY(VFIOAddressSpace) list; 31 } VFIOAddressSpace; 32 33 /* 34 * This is the base object for vfio container backends 35 */ 36 typedef struct VFIOContainerBase { 37 const VFIOIOMMUOps *ops; 38 VFIOAddressSpace *space; 39 QLIST_HEAD(, VFIOGuestIOMMU) giommu_list; 40 QLIST_ENTRY(VFIOContainerBase) next; 41 } VFIOContainerBase; 42 43 typedef struct VFIOGuestIOMMU { 44 VFIOContainerBase *bcontainer; 45 IOMMUMemoryRegion *iommu_mr; 46 hwaddr iommu_offset; 47 IOMMUNotifier n; 48 QLIST_ENTRY(VFIOGuestIOMMU) giommu_next; 49 } VFIOGuestIOMMU; 50 51 int vfio_container_dma_map(VFIOContainerBase *bcontainer, 52 hwaddr iova, ram_addr_t size, 53 void *vaddr, bool readonly); 54 int vfio_container_dma_unmap(VFIOContainerBase *bcontainer, 55 hwaddr iova, ram_addr_t size, 56 IOMMUTLBEntry *iotlb); 57 58 void vfio_container_init(VFIOContainerBase *bcontainer, 59 VFIOAddressSpace *space, 60 const VFIOIOMMUOps *ops); 61 void vfio_container_destroy(VFIOContainerBase *bcontainer); 62 63 struct VFIOIOMMUOps { 64 /* basic feature */ 65 int (*dma_map)(VFIOContainerBase *bcontainer, 66 hwaddr iova, ram_addr_t size, 67 void *vaddr, bool readonly); 68 int (*dma_unmap)(VFIOContainerBase *bcontainer, 69 hwaddr iova, ram_addr_t size, 70 IOMMUTLBEntry *iotlb); 71 int (*attach_device)(const char *name, VFIODevice *vbasedev, 72 AddressSpace *as, Error **errp); 73 void (*detach_device)(VFIODevice *vbasedev); 74 /* migration feature */ 75 int (*set_dirty_page_tracking)(VFIOContainerBase *bcontainer, bool start); 76 int (*query_dirty_bitmap)(VFIOContainerBase *bcontainer, VFIOBitmap *vbmap, 77 hwaddr iova, hwaddr size); 78 }; 79 #endif /* HW_VFIO_VFIO_CONTAINER_BASE_H */ 80