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 #include "hw/vfio/vfio-container-base.h" 34 35 #define VFIO_MSG_PREFIX "vfio %s: " 36 37 enum { 38 VFIO_DEVICE_TYPE_PCI = 0, 39 VFIO_DEVICE_TYPE_PLATFORM = 1, 40 VFIO_DEVICE_TYPE_CCW = 2, 41 VFIO_DEVICE_TYPE_AP = 3, 42 }; 43 44 typedef struct VFIOMmap { 45 MemoryRegion mem; 46 void *mmap; 47 off_t offset; 48 size_t size; 49 } VFIOMmap; 50 51 typedef struct VFIORegion { 52 struct VFIODevice *vbasedev; 53 off_t fd_offset; /* offset of region within device fd */ 54 MemoryRegion *mem; /* slow, read/write access */ 55 size_t size; 56 uint32_t flags; /* VFIO region flags (rd/wr/mmap) */ 57 uint32_t nr_mmaps; 58 VFIOMmap *mmaps; 59 uint8_t nr; /* cache the region number for debug */ 60 } VFIORegion; 61 62 typedef struct VFIOMigration { 63 struct VFIODevice *vbasedev; 64 VMChangeStateEntry *vm_state; 65 NotifierWithReturn migration_state; 66 uint32_t device_state; 67 int data_fd; 68 void *data_buffer; 69 size_t data_buffer_size; 70 uint64_t mig_flags; 71 uint64_t precopy_init_size; 72 uint64_t precopy_dirty_size; 73 bool initial_data_sent; 74 } VFIOMigration; 75 76 struct VFIOGroup; 77 78 typedef struct VFIOContainer { 79 VFIOContainerBase bcontainer; 80 int fd; /* /dev/vfio/vfio, empowered by the attached groups */ 81 unsigned iommu_type; 82 QLIST_HEAD(, VFIOGroup) group_list; 83 } VFIOContainer; 84 85 typedef struct VFIOHostDMAWindow { 86 hwaddr min_iova; 87 hwaddr max_iova; 88 uint64_t iova_pgsizes; 89 QLIST_ENTRY(VFIOHostDMAWindow) hostwin_next; 90 } VFIOHostDMAWindow; 91 92 typedef struct IOMMUFDBackend IOMMUFDBackend; 93 94 typedef struct VFIOIOMMUFDContainer { 95 VFIOContainerBase bcontainer; 96 IOMMUFDBackend *be; 97 uint32_t ioas_id; 98 } VFIOIOMMUFDContainer; 99 100 typedef struct VFIODeviceOps VFIODeviceOps; 101 102 typedef struct VFIODevice { 103 QLIST_ENTRY(VFIODevice) next; 104 QLIST_ENTRY(VFIODevice) container_next; 105 QLIST_ENTRY(VFIODevice) global_next; 106 struct VFIOGroup *group; 107 VFIOContainerBase *bcontainer; 108 char *sysfsdev; 109 char *name; 110 DeviceState *dev; 111 int fd; 112 int type; 113 bool reset_works; 114 bool needs_reset; 115 bool no_mmap; 116 bool ram_block_discard_allowed; 117 OnOffAuto enable_migration; 118 VFIODeviceOps *ops; 119 unsigned int num_irqs; 120 unsigned int num_regions; 121 unsigned int flags; 122 VFIOMigration *migration; 123 Error *migration_blocker; 124 OnOffAuto pre_copy_dirty_page_tracking; 125 bool dirty_pages_supported; 126 bool dirty_tracking; 127 int devid; 128 IOMMUFDBackend *iommufd; 129 } VFIODevice; 130 131 struct VFIODeviceOps { 132 void (*vfio_compute_needs_reset)(VFIODevice *vdev); 133 int (*vfio_hot_reset_multi)(VFIODevice *vdev); 134 void (*vfio_eoi)(VFIODevice *vdev); 135 Object *(*vfio_get_object)(VFIODevice *vdev); 136 void (*vfio_save_config)(VFIODevice *vdev, QEMUFile *f); 137 int (*vfio_load_config)(VFIODevice *vdev, QEMUFile *f); 138 }; 139 140 typedef struct VFIOGroup { 141 int fd; 142 int groupid; 143 VFIOContainer *container; 144 QLIST_HEAD(, VFIODevice) device_list; 145 QLIST_ENTRY(VFIOGroup) next; 146 QLIST_ENTRY(VFIOGroup) container_next; 147 bool ram_block_discard_allowed; 148 } VFIOGroup; 149 150 typedef struct VFIODMABuf { 151 QemuDmaBuf buf; 152 uint32_t pos_x, pos_y, pos_updates; 153 uint32_t hot_x, hot_y, hot_updates; 154 int dmabuf_id; 155 QTAILQ_ENTRY(VFIODMABuf) next; 156 } VFIODMABuf; 157 158 typedef struct VFIODisplay { 159 QemuConsole *con; 160 RAMFBState *ramfb; 161 struct vfio_region_info *edid_info; 162 struct vfio_region_gfx_edid *edid_regs; 163 uint8_t *edid_blob; 164 QEMUTimer *edid_link_timer; 165 struct { 166 VFIORegion buffer; 167 DisplaySurface *surface; 168 } region; 169 struct { 170 QTAILQ_HEAD(, VFIODMABuf) bufs; 171 VFIODMABuf *primary; 172 VFIODMABuf *cursor; 173 } dmabuf; 174 } VFIODisplay; 175 176 VFIOAddressSpace *vfio_get_address_space(AddressSpace *as); 177 void vfio_put_address_space(VFIOAddressSpace *space); 178 179 /* SPAPR specific */ 180 int vfio_spapr_container_init(VFIOContainer *container, Error **errp); 181 void vfio_spapr_container_deinit(VFIOContainer *container); 182 183 void vfio_disable_irqindex(VFIODevice *vbasedev, int index); 184 void vfio_unmask_single_irqindex(VFIODevice *vbasedev, int index); 185 void vfio_mask_single_irqindex(VFIODevice *vbasedev, int index); 186 int vfio_set_irq_signaling(VFIODevice *vbasedev, int index, int subindex, 187 int action, int fd, Error **errp); 188 void vfio_region_write(void *opaque, hwaddr addr, 189 uint64_t data, unsigned size); 190 uint64_t vfio_region_read(void *opaque, 191 hwaddr addr, unsigned size); 192 int vfio_region_setup(Object *obj, VFIODevice *vbasedev, VFIORegion *region, 193 int index, const char *name); 194 int vfio_region_mmap(VFIORegion *region); 195 void vfio_region_mmaps_set_enabled(VFIORegion *region, bool enabled); 196 void vfio_region_unmap(VFIORegion *region); 197 void vfio_region_exit(VFIORegion *region); 198 void vfio_region_finalize(VFIORegion *region); 199 void vfio_reset_handler(void *opaque); 200 struct vfio_device_info *vfio_get_device_info(int fd); 201 int vfio_attach_device(char *name, VFIODevice *vbasedev, 202 AddressSpace *as, Error **errp); 203 void vfio_detach_device(VFIODevice *vbasedev); 204 205 int vfio_kvm_device_add_fd(int fd, Error **errp); 206 int vfio_kvm_device_del_fd(int fd, Error **errp); 207 208 extern const MemoryRegionOps vfio_region_ops; 209 typedef QLIST_HEAD(VFIOGroupList, VFIOGroup) VFIOGroupList; 210 typedef QLIST_HEAD(VFIODeviceList, VFIODevice) VFIODeviceList; 211 extern VFIOGroupList vfio_group_list; 212 extern VFIODeviceList vfio_device_list; 213 extern const MemoryListener vfio_memory_listener; 214 extern int vfio_kvm_device_fd; 215 216 bool vfio_mig_active(void); 217 int vfio_block_multiple_devices_migration(VFIODevice *vbasedev, Error **errp); 218 void vfio_unblock_multiple_devices_migration(void); 219 bool vfio_viommu_preset(VFIODevice *vbasedev); 220 int64_t vfio_mig_bytes_transferred(void); 221 void vfio_reset_bytes_transferred(void); 222 bool vfio_device_state_is_running(VFIODevice *vbasedev); 223 bool vfio_device_state_is_precopy(VFIODevice *vbasedev); 224 225 #ifdef CONFIG_LINUX 226 int vfio_get_region_info(VFIODevice *vbasedev, int index, 227 struct vfio_region_info **info); 228 int vfio_get_dev_region_info(VFIODevice *vbasedev, uint32_t type, 229 uint32_t subtype, struct vfio_region_info **info); 230 bool vfio_has_region_cap(VFIODevice *vbasedev, int region, uint16_t cap_type); 231 struct vfio_info_cap_header * 232 vfio_get_region_info_cap(struct vfio_region_info *info, uint16_t id); 233 bool vfio_get_info_dma_avail(struct vfio_iommu_type1_info *info, 234 unsigned int *avail); 235 struct vfio_info_cap_header * 236 vfio_get_device_info_cap(struct vfio_device_info *info, uint16_t id); 237 struct vfio_info_cap_header * 238 vfio_get_cap(void *ptr, uint32_t cap_offset, uint16_t id); 239 #endif 240 241 bool vfio_migration_realize(VFIODevice *vbasedev, Error **errp); 242 void vfio_migration_exit(VFIODevice *vbasedev); 243 244 int vfio_bitmap_alloc(VFIOBitmap *vbmap, hwaddr size); 245 bool 246 vfio_devices_all_running_and_mig_active(const VFIOContainerBase *bcontainer); 247 bool 248 vfio_devices_all_device_dirty_tracking(const VFIOContainerBase *bcontainer); 249 int vfio_devices_query_dirty_bitmap(const VFIOContainerBase *bcontainer, 250 VFIOBitmap *vbmap, hwaddr iova, 251 hwaddr size); 252 int vfio_get_dirty_bitmap(const VFIOContainerBase *bcontainer, uint64_t iova, 253 uint64_t size, ram_addr_t ram_addr); 254 255 /* Returns 0 on success, or a negative errno. */ 256 int vfio_device_get_name(VFIODevice *vbasedev, Error **errp); 257 void vfio_device_set_fd(VFIODevice *vbasedev, const char *str, Error **errp); 258 void vfio_device_init(VFIODevice *vbasedev, int type, VFIODeviceOps *ops, 259 DeviceState *dev, bool ram_discard); 260 #endif /* HW_VFIO_VFIO_COMMON_H */ 261