1 /* 2 * common header for vfio based device assignment support 3 * 4 * Copyright Red Hat, Inc. 2012 5 * 6 * Authors: 7 * Alex Williamson <alex.williamson@redhat.com> 8 * 9 * This work is licensed under the terms of the GNU GPL, version 2. See 10 * the COPYING file in the top-level directory. 11 * 12 * Based on qemu-kvm device-assignment: 13 * Adapted for KVM by Qumranet. 14 * Copyright (c) 2007, Neocleus, Alex Novik (alex@neocleus.com) 15 * Copyright (c) 2007, Neocleus, Guy Zana (guy@neocleus.com) 16 * Copyright (C) 2008, Qumranet, Amit Shah (amit.shah@qumranet.com) 17 * Copyright (C) 2008, Red Hat, Amit Shah (amit.shah@redhat.com) 18 * Copyright (C) 2008, IBM, Muli Ben-Yehuda (muli@il.ibm.com) 19 */ 20 21 #ifndef HW_VFIO_VFIO_COMMON_H 22 #define HW_VFIO_VFIO_COMMON_H 23 24 #include "exec/memory.h" 25 #include "qemu/queue.h" 26 #include "qemu/notify.h" 27 #include "ui/console.h" 28 #include "hw/display/ramfb.h" 29 #ifdef CONFIG_LINUX 30 #include <linux/vfio.h> 31 #endif 32 #include "sysemu/sysemu.h" 33 34 #define VFIO_MSG_PREFIX "vfio %s: " 35 36 enum { 37 VFIO_DEVICE_TYPE_PCI = 0, 38 VFIO_DEVICE_TYPE_PLATFORM = 1, 39 VFIO_DEVICE_TYPE_CCW = 2, 40 VFIO_DEVICE_TYPE_AP = 3, 41 }; 42 43 typedef struct VFIOMmap { 44 MemoryRegion mem; 45 void *mmap; 46 off_t offset; 47 size_t size; 48 } VFIOMmap; 49 50 typedef struct VFIORegion { 51 struct VFIODevice *vbasedev; 52 off_t fd_offset; /* offset of region within device fd */ 53 MemoryRegion *mem; /* slow, read/write access */ 54 size_t size; 55 uint32_t flags; /* VFIO region flags (rd/wr/mmap) */ 56 uint32_t nr_mmaps; 57 VFIOMmap *mmaps; 58 uint8_t nr; /* cache the region number for debug */ 59 } VFIORegion; 60 61 typedef struct VFIOMigration { 62 struct VFIODevice *vbasedev; 63 VMChangeStateEntry *vm_state; 64 Notifier migration_state; 65 uint32_t device_state; 66 int data_fd; 67 void *data_buffer; 68 size_t data_buffer_size; 69 uint64_t mig_flags; 70 uint64_t precopy_init_size; 71 uint64_t precopy_dirty_size; 72 bool initial_data_sent; 73 } VFIOMigration; 74 75 typedef struct VFIOAddressSpace { 76 AddressSpace *as; 77 QLIST_HEAD(, VFIOContainer) containers; 78 QLIST_ENTRY(VFIOAddressSpace) list; 79 } VFIOAddressSpace; 80 81 struct VFIOGroup; 82 83 typedef struct VFIOContainer { 84 VFIOAddressSpace *space; 85 int fd; /* /dev/vfio/vfio, empowered by the attached groups */ 86 MemoryListener listener; 87 MemoryListener prereg_listener; 88 unsigned iommu_type; 89 Error *error; 90 bool initialized; 91 bool dirty_pages_supported; 92 uint64_t dirty_pgsizes; 93 uint64_t max_dirty_bitmap_size; 94 unsigned long pgsizes; 95 unsigned int dma_max_mappings; 96 QLIST_HEAD(, VFIOGuestIOMMU) giommu_list; 97 QLIST_HEAD(, VFIOHostDMAWindow) hostwin_list; 98 QLIST_HEAD(, VFIOGroup) group_list; 99 QLIST_HEAD(, VFIORamDiscardListener) vrdl_list; 100 QLIST_ENTRY(VFIOContainer) next; 101 } VFIOContainer; 102 103 typedef struct VFIOGuestIOMMU { 104 VFIOContainer *container; 105 IOMMUMemoryRegion *iommu_mr; 106 hwaddr iommu_offset; 107 IOMMUNotifier n; 108 QLIST_ENTRY(VFIOGuestIOMMU) giommu_next; 109 } VFIOGuestIOMMU; 110 111 typedef struct VFIORamDiscardListener { 112 VFIOContainer *container; 113 MemoryRegion *mr; 114 hwaddr offset_within_address_space; 115 hwaddr size; 116 uint64_t granularity; 117 RamDiscardListener listener; 118 QLIST_ENTRY(VFIORamDiscardListener) next; 119 } VFIORamDiscardListener; 120 121 typedef struct VFIOHostDMAWindow { 122 hwaddr min_iova; 123 hwaddr max_iova; 124 uint64_t iova_pgsizes; 125 QLIST_ENTRY(VFIOHostDMAWindow) hostwin_next; 126 } VFIOHostDMAWindow; 127 128 typedef struct VFIODeviceOps VFIODeviceOps; 129 130 typedef struct VFIODevice { 131 QLIST_ENTRY(VFIODevice) next; 132 struct VFIOGroup *group; 133 char *sysfsdev; 134 char *name; 135 DeviceState *dev; 136 int fd; 137 int type; 138 bool reset_works; 139 bool needs_reset; 140 bool no_mmap; 141 bool ram_block_discard_allowed; 142 OnOffAuto enable_migration; 143 VFIODeviceOps *ops; 144 unsigned int num_irqs; 145 unsigned int num_regions; 146 unsigned int flags; 147 VFIOMigration *migration; 148 Error *migration_blocker; 149 OnOffAuto pre_copy_dirty_page_tracking; 150 bool dirty_pages_supported; 151 bool dirty_tracking; 152 } VFIODevice; 153 154 struct VFIODeviceOps { 155 void (*vfio_compute_needs_reset)(VFIODevice *vdev); 156 int (*vfio_hot_reset_multi)(VFIODevice *vdev); 157 void (*vfio_eoi)(VFIODevice *vdev); 158 Object *(*vfio_get_object)(VFIODevice *vdev); 159 void (*vfio_save_config)(VFIODevice *vdev, QEMUFile *f); 160 int (*vfio_load_config)(VFIODevice *vdev, QEMUFile *f); 161 }; 162 163 typedef struct VFIOGroup { 164 int fd; 165 int groupid; 166 VFIOContainer *container; 167 QLIST_HEAD(, VFIODevice) device_list; 168 QLIST_ENTRY(VFIOGroup) next; 169 QLIST_ENTRY(VFIOGroup) container_next; 170 bool ram_block_discard_allowed; 171 } VFIOGroup; 172 173 typedef struct VFIODMABuf { 174 QemuDmaBuf buf; 175 uint32_t pos_x, pos_y, pos_updates; 176 uint32_t hot_x, hot_y, hot_updates; 177 int dmabuf_id; 178 QTAILQ_ENTRY(VFIODMABuf) next; 179 } VFIODMABuf; 180 181 typedef struct VFIODisplay { 182 QemuConsole *con; 183 RAMFBState *ramfb; 184 struct vfio_region_info *edid_info; 185 struct vfio_region_gfx_edid *edid_regs; 186 uint8_t *edid_blob; 187 QEMUTimer *edid_link_timer; 188 struct { 189 VFIORegion buffer; 190 DisplaySurface *surface; 191 } region; 192 struct { 193 QTAILQ_HEAD(, VFIODMABuf) bufs; 194 VFIODMABuf *primary; 195 VFIODMABuf *cursor; 196 } dmabuf; 197 } VFIODisplay; 198 199 void vfio_put_base_device(VFIODevice *vbasedev); 200 void vfio_disable_irqindex(VFIODevice *vbasedev, int index); 201 void vfio_unmask_single_irqindex(VFIODevice *vbasedev, int index); 202 void vfio_mask_single_irqindex(VFIODevice *vbasedev, int index); 203 int vfio_set_irq_signaling(VFIODevice *vbasedev, int index, int subindex, 204 int action, int fd, Error **errp); 205 void vfio_region_write(void *opaque, hwaddr addr, 206 uint64_t data, unsigned size); 207 uint64_t vfio_region_read(void *opaque, 208 hwaddr addr, unsigned size); 209 int vfio_region_setup(Object *obj, VFIODevice *vbasedev, VFIORegion *region, 210 int index, const char *name); 211 int vfio_region_mmap(VFIORegion *region); 212 void vfio_region_mmaps_set_enabled(VFIORegion *region, bool enabled); 213 void vfio_region_unmap(VFIORegion *region); 214 void vfio_region_exit(VFIORegion *region); 215 void vfio_region_finalize(VFIORegion *region); 216 void vfio_reset_handler(void *opaque); 217 VFIOGroup *vfio_get_group(int groupid, AddressSpace *as, Error **errp); 218 void vfio_put_group(VFIOGroup *group); 219 struct vfio_device_info *vfio_get_device_info(int fd); 220 int vfio_get_device(VFIOGroup *group, const char *name, 221 VFIODevice *vbasedev, Error **errp); 222 223 extern const MemoryRegionOps vfio_region_ops; 224 typedef QLIST_HEAD(VFIOGroupList, VFIOGroup) VFIOGroupList; 225 extern VFIOGroupList vfio_group_list; 226 227 bool vfio_mig_active(void); 228 int vfio_block_multiple_devices_migration(VFIODevice *vbasedev, Error **errp); 229 void vfio_unblock_multiple_devices_migration(void); 230 bool vfio_viommu_preset(VFIODevice *vbasedev); 231 int64_t vfio_mig_bytes_transferred(void); 232 void vfio_reset_bytes_transferred(void); 233 234 #ifdef CONFIG_LINUX 235 int vfio_get_region_info(VFIODevice *vbasedev, int index, 236 struct vfio_region_info **info); 237 int vfio_get_dev_region_info(VFIODevice *vbasedev, uint32_t type, 238 uint32_t subtype, struct vfio_region_info **info); 239 bool vfio_has_region_cap(VFIODevice *vbasedev, int region, uint16_t cap_type); 240 struct vfio_info_cap_header * 241 vfio_get_region_info_cap(struct vfio_region_info *info, uint16_t id); 242 bool vfio_get_info_dma_avail(struct vfio_iommu_type1_info *info, 243 unsigned int *avail); 244 struct vfio_info_cap_header * 245 vfio_get_device_info_cap(struct vfio_device_info *info, uint16_t id); 246 #endif 247 extern const MemoryListener vfio_prereg_listener; 248 249 int vfio_spapr_create_window(VFIOContainer *container, 250 MemoryRegionSection *section, 251 hwaddr *pgsize); 252 int vfio_spapr_remove_window(VFIOContainer *container, 253 hwaddr offset_within_address_space); 254 255 bool vfio_migration_realize(VFIODevice *vbasedev, Error **errp); 256 void vfio_migration_exit(VFIODevice *vbasedev); 257 258 #endif /* HW_VFIO_VFIO_COMMON_H */ 259