include/hw/vfio/vfio-common.h

   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     Notifier 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 typedef struct VFIOAddressSpace {
  77     AddressSpace *as;
  78     QLIST_HEAD(, VFIOContainer) containers;
  79     QLIST_ENTRY(VFIOAddressSpace) list;
  80 } VFIOAddressSpace;
  81
  82 struct VFIOGroup;
  83
  84 typedef struct VFIOContainer {
  85     VFIOContainerBase bcontainer;
  86     VFIOAddressSpace *space;
  87     int fd; /* /dev/vfio/vfio, empowered by the attached groups */
  88     MemoryListener listener;
  89     MemoryListener prereg_listener;
  90     unsigned iommu_type;
  91     Error *error;
  92     bool initialized;
  93     bool dirty_pages_supported;
  94     uint64_t dirty_pgsizes;
  95     uint64_t max_dirty_bitmap_size;
  96     unsigned long pgsizes;
  97     unsigned int dma_max_mappings;
  98     QLIST_HEAD(, VFIOGuestIOMMU) giommu_list;
  99     QLIST_HEAD(, VFIOHostDMAWindow) hostwin_list;
 100     QLIST_HEAD(, VFIOGroup) group_list;
 101     QLIST_HEAD(, VFIORamDiscardListener) vrdl_list;
 102     QLIST_ENTRY(VFIOContainer) next;
 103     QLIST_HEAD(, VFIODevice) device_list;
 104     GList *iova_ranges;
 105 } VFIOContainer;
 106
 107 typedef struct VFIOGuestIOMMU {
 108     VFIOContainer *container;
 109     IOMMUMemoryRegion *iommu_mr;
 110     hwaddr iommu_offset;
 111     IOMMUNotifier n;
 112     QLIST_ENTRY(VFIOGuestIOMMU) giommu_next;
 113 } VFIOGuestIOMMU;
 114
 115 typedef struct VFIORamDiscardListener {
 116     VFIOContainer *container;
 117     MemoryRegion *mr;
 118     hwaddr offset_within_address_space;
 119     hwaddr size;
 120     uint64_t granularity;
 121     RamDiscardListener listener;
 122     QLIST_ENTRY(VFIORamDiscardListener) next;
 123 } VFIORamDiscardListener;
 124
 125 typedef struct VFIOHostDMAWindow {
 126     hwaddr min_iova;
 127     hwaddr max_iova;
 128     uint64_t iova_pgsizes;
 129     QLIST_ENTRY(VFIOHostDMAWindow) hostwin_next;
 130 } VFIOHostDMAWindow;
 131
 132 typedef struct VFIODeviceOps VFIODeviceOps;
 133
 134 typedef struct VFIODevice {
 135     QLIST_ENTRY(VFIODevice) next;
 136     QLIST_ENTRY(VFIODevice) container_next;
 137     QLIST_ENTRY(VFIODevice) global_next;
 138     struct VFIOGroup *group;
 139     VFIOContainer *container;
 140     char *sysfsdev;
 141     char *name;
 142     DeviceState *dev;
 143     int fd;
 144     int type;
 145     bool reset_works;
 146     bool needs_reset;
 147     bool no_mmap;
 148     bool ram_block_discard_allowed;
 149     OnOffAuto enable_migration;
 150     VFIODeviceOps *ops;
 151     unsigned int num_irqs;
 152     unsigned int num_regions;
 153     unsigned int flags;
 154     VFIOMigration *migration;
 155     Error *migration_blocker;
 156     OnOffAuto pre_copy_dirty_page_tracking;
 157     bool dirty_pages_supported;
 158     bool dirty_tracking;
 159 } VFIODevice;
 160
 161 struct VFIODeviceOps {
 162     void (*vfio_compute_needs_reset)(VFIODevice *vdev);
 163     int (*vfio_hot_reset_multi)(VFIODevice *vdev);
 164     void (*vfio_eoi)(VFIODevice *vdev);
 165     Object *(*vfio_get_object)(VFIODevice *vdev);
 166     void (*vfio_save_config)(VFIODevice *vdev, QEMUFile *f);
 167     int (*vfio_load_config)(VFIODevice *vdev, QEMUFile *f);
 168 };
 169
 170 typedef struct VFIOGroup {
 171     int fd;
 172     int groupid;
 173     VFIOContainer *container;
 174     QLIST_HEAD(, VFIODevice) device_list;
 175     QLIST_ENTRY(VFIOGroup) next;
 176     QLIST_ENTRY(VFIOGroup) container_next;
 177     bool ram_block_discard_allowed;
 178 } VFIOGroup;
 179
 180 typedef struct VFIODMABuf {
 181     QemuDmaBuf buf;
 182     uint32_t pos_x, pos_y, pos_updates;
 183     uint32_t hot_x, hot_y, hot_updates;
 184     int dmabuf_id;
 185     QTAILQ_ENTRY(VFIODMABuf) next;
 186 } VFIODMABuf;
 187
 188 typedef struct VFIODisplay {
 189     QemuConsole *con;
 190     RAMFBState *ramfb;
 191     struct vfio_region_info *edid_info;
 192     struct vfio_region_gfx_edid *edid_regs;
 193     uint8_t *edid_blob;
 194     QEMUTimer *edid_link_timer;
 195     struct {
 196         VFIORegion buffer;
 197         DisplaySurface *surface;
 198     } region;
 199     struct {
 200         QTAILQ_HEAD(, VFIODMABuf) bufs;
 201         VFIODMABuf *primary;
 202         VFIODMABuf *cursor;
 203     } dmabuf;
 204 } VFIODisplay;
 205
 206 VFIOAddressSpace *vfio_get_address_space(AddressSpace *as);
 207 void vfio_put_address_space(VFIOAddressSpace *space);
 208 bool vfio_devices_all_running_and_saving(VFIOContainer *container);
 209
 210 /* container->fd */
 211 int vfio_set_dirty_page_tracking(VFIOContainer *container, bool start);
 212 int vfio_query_dirty_bitmap(VFIOContainer *container, VFIOBitmap *vbmap,
 213                             hwaddr iova, hwaddr size);
 214
 215 /* SPAPR specific */
 216 int vfio_container_add_section_window(VFIOContainer *container,
 217                                       MemoryRegionSection *section,
 218                                       Error **errp);
 219 void vfio_container_del_section_window(VFIOContainer *container,
 220                                        MemoryRegionSection *section);
 221 int vfio_spapr_container_init(VFIOContainer *container, Error **errp);
 222 void vfio_spapr_container_deinit(VFIOContainer *container);
 223
 224 void vfio_disable_irqindex(VFIODevice *vbasedev, int index);
 225 void vfio_unmask_single_irqindex(VFIODevice *vbasedev, int index);
 226 void vfio_mask_single_irqindex(VFIODevice *vbasedev, int index);
 227 int vfio_set_irq_signaling(VFIODevice *vbasedev, int index, int subindex,
 228                            int action, int fd, Error **errp);
 229 void vfio_region_write(void *opaque, hwaddr addr,
 230                            uint64_t data, unsigned size);
 231 uint64_t vfio_region_read(void *opaque,
 232                           hwaddr addr, unsigned size);
 233 int vfio_region_setup(Object *obj, VFIODevice *vbasedev, VFIORegion *region,
 234                       int index, const char *name);
 235 int vfio_region_mmap(VFIORegion *region);
 236 void vfio_region_mmaps_set_enabled(VFIORegion *region, bool enabled);
 237 void vfio_region_unmap(VFIORegion *region);
 238 void vfio_region_exit(VFIORegion *region);
 239 void vfio_region_finalize(VFIORegion *region);
 240 void vfio_reset_handler(void *opaque);
 241 struct vfio_device_info *vfio_get_device_info(int fd);
 242 int vfio_attach_device(char *name, VFIODevice *vbasedev,
 243                        AddressSpace *as, Error **errp);
 244 void vfio_detach_device(VFIODevice *vbasedev);
 245
 246 int vfio_kvm_device_add_fd(int fd, Error **errp);
 247 int vfio_kvm_device_del_fd(int fd, Error **errp);
 248
 249 extern const MemoryRegionOps vfio_region_ops;
 250 typedef QLIST_HEAD(VFIOGroupList, VFIOGroup) VFIOGroupList;
 251 typedef QLIST_HEAD(VFIODeviceList, VFIODevice) VFIODeviceList;
 252 extern VFIOGroupList vfio_group_list;
 253 extern VFIODeviceList vfio_device_list;
 254 extern const VFIOIOMMUOps vfio_legacy_ops;
 255 extern const MemoryListener vfio_memory_listener;
 256 extern int vfio_kvm_device_fd;
 257
 258 bool vfio_mig_active(void);
 259 int vfio_block_multiple_devices_migration(VFIODevice *vbasedev, Error **errp);
 260 void vfio_unblock_multiple_devices_migration(void);
 261 bool vfio_viommu_preset(VFIODevice *vbasedev);
 262 int64_t vfio_mig_bytes_transferred(void);
 263 void vfio_reset_bytes_transferred(void);
 264 bool vfio_device_state_is_running(VFIODevice *vbasedev);
 265 bool vfio_device_state_is_precopy(VFIODevice *vbasedev);
 266
 267 #ifdef CONFIG_LINUX
 268 int vfio_get_region_info(VFIODevice *vbasedev, int index,
 269                          struct vfio_region_info **info);
 270 int vfio_get_dev_region_info(VFIODevice *vbasedev, uint32_t type,
 271                              uint32_t subtype, struct vfio_region_info **info);
 272 bool vfio_has_region_cap(VFIODevice *vbasedev, int region, uint16_t cap_type);
 273 struct vfio_info_cap_header *
 274 vfio_get_region_info_cap(struct vfio_region_info *info, uint16_t id);
 275 bool vfio_get_info_dma_avail(struct vfio_iommu_type1_info *info,
 276                              unsigned int *avail);
 277 struct vfio_info_cap_header *
 278 vfio_get_device_info_cap(struct vfio_device_info *info, uint16_t id);
 279 struct vfio_info_cap_header *
 280 vfio_get_cap(void *ptr, uint32_t cap_offset, uint16_t id);
 281 #endif
 282
 283 bool vfio_migration_realize(VFIODevice *vbasedev, Error **errp);
 284 void vfio_migration_exit(VFIODevice *vbasedev);
 285
 286 int vfio_bitmap_alloc(VFIOBitmap *vbmap, hwaddr size);
 287 bool vfio_devices_all_running_and_mig_active(VFIOContainer *container);
 288 bool vfio_devices_all_device_dirty_tracking(VFIOContainer *container);
 289 int vfio_devices_query_dirty_bitmap(VFIOContainer *container,
 290                                     VFIOBitmap *vbmap, hwaddr iova,
 291                                     hwaddr size);
 292 int vfio_get_dirty_bitmap(VFIOContainer *container, uint64_t iova,
 293                                  uint64_t size, ram_addr_t ram_addr);
 294 #endif /* HW_VFIO_VFIO_COMMON_H */