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 "system/memory.h" 17 18 typedef struct VFIODevice VFIODevice; 19 typedef struct VFIOIOMMUClass VFIOIOMMUClass; 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 Object parent; 38 VFIOAddressSpace *space; 39 MemoryListener listener; 40 Error *error; 41 bool initialized; 42 uint64_t dirty_pgsizes; 43 uint64_t max_dirty_bitmap_size; 44 unsigned long pgsizes; 45 unsigned int dma_max_mappings; 46 bool dirty_pages_supported; 47 bool dirty_pages_started; /* Protected by BQL */ 48 QLIST_HEAD(, VFIOGuestIOMMU) giommu_list; 49 QLIST_HEAD(, VFIORamDiscardListener) vrdl_list; 50 QLIST_ENTRY(VFIOContainerBase) next; 51 QLIST_HEAD(, VFIODevice) device_list; 52 GList *iova_ranges; 53 NotifierWithReturn cpr_reboot_notifier; 54 } VFIOContainerBase; 55 56 typedef struct VFIOGuestIOMMU { 57 VFIOContainerBase *bcontainer; 58 IOMMUMemoryRegion *iommu_mr; 59 hwaddr iommu_offset; 60 IOMMUNotifier n; 61 QLIST_ENTRY(VFIOGuestIOMMU) giommu_next; 62 } VFIOGuestIOMMU; 63 64 typedef struct VFIORamDiscardListener { 65 VFIOContainerBase *bcontainer; 66 MemoryRegion *mr; 67 hwaddr offset_within_address_space; 68 hwaddr size; 69 uint64_t granularity; 70 RamDiscardListener listener; 71 QLIST_ENTRY(VFIORamDiscardListener) next; 72 } VFIORamDiscardListener; 73 74 VFIOAddressSpace *vfio_address_space_get(AddressSpace *as); 75 void vfio_address_space_put(VFIOAddressSpace *space); 76 void vfio_address_space_insert(VFIOAddressSpace *space, 77 VFIOContainerBase *bcontainer); 78 79 int vfio_container_dma_map(VFIOContainerBase *bcontainer, 80 hwaddr iova, ram_addr_t size, 81 void *vaddr, bool readonly); 82 int vfio_container_dma_unmap(VFIOContainerBase *bcontainer, 83 hwaddr iova, ram_addr_t size, 84 IOMMUTLBEntry *iotlb, bool unmap_all); 85 bool vfio_container_add_section_window(VFIOContainerBase *bcontainer, 86 MemoryRegionSection *section, 87 Error **errp); 88 void vfio_container_del_section_window(VFIOContainerBase *bcontainer, 89 MemoryRegionSection *section); 90 int vfio_container_set_dirty_page_tracking(VFIOContainerBase *bcontainer, 91 bool start, Error **errp); 92 bool vfio_container_dirty_tracking_is_started( 93 const VFIOContainerBase *bcontainer); 94 bool vfio_container_devices_dirty_tracking_is_supported( 95 const VFIOContainerBase *bcontainer); 96 int vfio_container_query_dirty_bitmap(const VFIOContainerBase *bcontainer, 97 uint64_t iova, uint64_t size, ram_addr_t ram_addr, Error **errp); 98 99 GList *vfio_container_get_iova_ranges(const VFIOContainerBase *bcontainer); 100 101 static inline uint64_t 102 vfio_container_get_page_size_mask(const VFIOContainerBase *bcontainer) 103 { 104 assert(bcontainer); 105 return bcontainer->pgsizes; 106 } 107 108 #define TYPE_VFIO_IOMMU "vfio-iommu" 109 #define TYPE_VFIO_IOMMU_LEGACY TYPE_VFIO_IOMMU "-legacy" 110 #define TYPE_VFIO_IOMMU_SPAPR TYPE_VFIO_IOMMU "-spapr" 111 #define TYPE_VFIO_IOMMU_IOMMUFD TYPE_VFIO_IOMMU "-iommufd" 112 113 OBJECT_DECLARE_TYPE(VFIOContainerBase, VFIOIOMMUClass, VFIO_IOMMU) 114 115 struct VFIOIOMMUClass { 116 ObjectClass parent_class; 117 118 /** 119 * @setup 120 * 121 * Perform basic setup of the container, including configuring IOMMU 122 * capabilities, IOVA ranges, supported page sizes, etc. 123 * 124 * @bcontainer: #VFIOContainerBase 125 * @errp: pointer to Error*, to store an error if it happens. 126 * 127 * Returns true to indicate success and false for error. 128 */ 129 bool (*setup)(VFIOContainerBase *bcontainer, Error **errp); 130 131 /** 132 * @listener_begin 133 * 134 * Called at the beginning of an address space update transaction. 135 * See #MemoryListener. 136 * 137 * @bcontainer: #VFIOContainerBase 138 */ 139 void (*listener_begin)(VFIOContainerBase *bcontainer); 140 141 /** 142 * @listener_commit 143 * 144 * Called at the end of an address space update transaction, 145 * See #MemoryListener. 146 * 147 * @bcontainer: #VFIOContainerBase 148 */ 149 void (*listener_commit)(VFIOContainerBase *bcontainer); 150 151 /** 152 * @dma_map 153 * 154 * Map an address range into the container. 155 * 156 * @bcontainer: #VFIOContainerBase to use 157 * @iova: start address to map 158 * @size: size of the range to map 159 * @vaddr: process virtual address of mapping 160 * @readonly: true if mapping should be readonly 161 * 162 * Returns 0 to indicate success and -errno otherwise. 163 */ 164 int (*dma_map)(const VFIOContainerBase *bcontainer, 165 hwaddr iova, ram_addr_t size, 166 void *vaddr, bool readonly); 167 168 /** 169 * @dma_unmap 170 * 171 * Unmap an address range from the container. 172 * 173 * @bcontainer: #VFIOContainerBase to use for unmap 174 * @iova: start address to unmap 175 * @size: size of the range to unmap 176 * @iotlb: The IOMMU TLB mapping entry (or NULL) 177 * @unmap_all: if set, unmap the entire address space 178 * 179 * Returns 0 to indicate success and -errno otherwise. 180 */ 181 int (*dma_unmap)(const VFIOContainerBase *bcontainer, 182 hwaddr iova, ram_addr_t size, 183 IOMMUTLBEntry *iotlb, bool unmap_all); 184 185 186 /** 187 * @attach_device 188 * 189 * Associate the given device with a container and do some related 190 * initialization of the device context. 191 * 192 * @name: name of the device 193 * @vbasedev: the device 194 * @as: address space to use 195 * @errp: pointer to Error*, to store an error if it happens. 196 * 197 * Returns true to indicate success and false for error. 198 */ 199 bool (*attach_device)(const char *name, VFIODevice *vbasedev, 200 AddressSpace *as, Error **errp); 201 202 /* 203 * @detach_device 204 * 205 * Detach the given device from its container and clean up any necessary 206 * state. 207 * 208 * @vbasedev: the device to disassociate 209 */ 210 void (*detach_device)(VFIODevice *vbasedev); 211 212 /* migration feature */ 213 214 /** 215 * @set_dirty_page_tracking 216 * 217 * Start or stop dirty pages tracking on VFIO container 218 * 219 * @bcontainer: #VFIOContainerBase on which to de/activate dirty 220 * page tracking 221 * @start: indicates whether to start or stop dirty pages tracking 222 * @errp: pointer to Error*, to store an error if it happens. 223 * 224 * Returns zero to indicate success and negative for error. 225 */ 226 int (*set_dirty_page_tracking)(const VFIOContainerBase *bcontainer, 227 bool start, Error **errp); 228 /** 229 * @query_dirty_bitmap 230 * 231 * Get bitmap of dirty pages from container 232 * 233 * @bcontainer: #VFIOContainerBase from which to get dirty pages 234 * @vbmap: #VFIOBitmap internal bitmap structure 235 * @iova: iova base address 236 * @size: size of iova range 237 * @errp: pointer to Error*, to store an error if it happens. 238 * 239 * Returns zero to indicate success and negative for error. 240 */ 241 int (*query_dirty_bitmap)(const VFIOContainerBase *bcontainer, 242 VFIOBitmap *vbmap, hwaddr iova, hwaddr size, Error **errp); 243 /* PCI specific */ 244 int (*pci_hot_reset)(VFIODevice *vbasedev, bool single); 245 246 /* SPAPR specific */ 247 bool (*add_window)(VFIOContainerBase *bcontainer, 248 MemoryRegionSection *section, 249 Error **errp); 250 void (*del_window)(VFIOContainerBase *bcontainer, 251 MemoryRegionSection *section); 252 void (*release)(VFIOContainerBase *bcontainer); 253 }; 254 255 #endif /* HW_VFIO_VFIO_CONTAINER_BASE_H */ 256