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
  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     VFIORegion region;
  65     uint32_t device_state;
  66     int vm_running;
  67     Notifier migration_state;
  68     uint64_t pending_bytes;
  69 } VFIOMigration;
  70
  71 typedef struct VFIOAddressSpace {
  72     AddressSpace *as;
  73     QLIST_HEAD(, VFIOContainer) containers;
  74     QLIST_ENTRY(VFIOAddressSpace) list;
  75 } VFIOAddressSpace;
  76
  77 struct VFIOGroup;
  78
  79 typedef struct VFIOContainer {
  80     VFIOAddressSpace *space;
  81     int fd; /* /dev/vfio/vfio, empowered by the attached groups */
  82     MemoryListener listener;
  83     MemoryListener prereg_listener;
  84     unsigned iommu_type;
  85     Error *error;
  86     bool initialized;
  87     bool dirty_pages_supported;
  88     uint64_t dirty_pgsizes;
  89     uint64_t max_dirty_bitmap_size;
  90     unsigned long pgsizes;
  91     QLIST_HEAD(, VFIOGuestIOMMU) giommu_list;
  92     QLIST_HEAD(, VFIOHostDMAWindow) hostwin_list;
  93     QLIST_HEAD(, VFIOGroup) group_list;
  94     QLIST_ENTRY(VFIOContainer) next;
  95 } VFIOContainer;
  96
  97 typedef struct VFIOGuestIOMMU {
  98     VFIOContainer *container;
  99     IOMMUMemoryRegion *iommu;
 100     hwaddr iommu_offset;
 101     IOMMUNotifier n;
 102     QLIST_ENTRY(VFIOGuestIOMMU) giommu_next;
 103 } VFIOGuestIOMMU;
 104
 105 typedef struct VFIOHostDMAWindow {
 106     hwaddr min_iova;
 107     hwaddr max_iova;
 108     uint64_t iova_pgsizes;
 109     QLIST_ENTRY(VFIOHostDMAWindow) hostwin_next;
 110 } VFIOHostDMAWindow;
 111
 112 typedef struct VFIODeviceOps VFIODeviceOps;
 113
 114 typedef struct VFIODevice {
 115     QLIST_ENTRY(VFIODevice) next;
 116     struct VFIOGroup *group;
 117     char *sysfsdev;
 118     char *name;
 119     DeviceState *dev;
 120     int fd;
 121     int type;
 122     bool reset_works;
 123     bool needs_reset;
 124     bool no_mmap;
 125     bool ram_block_discard_allowed;
 126     bool enable_migration;
 127     VFIODeviceOps *ops;
 128     unsigned int num_irqs;
 129     unsigned int num_regions;
 130     unsigned int flags;
 131     VFIOMigration *migration;
 132     Error *migration_blocker;
 133     OnOffAuto pre_copy_dirty_page_tracking;
 134 } VFIODevice;
 135
 136 struct VFIODeviceOps {
 137     void (*vfio_compute_needs_reset)(VFIODevice *vdev);
 138     int (*vfio_hot_reset_multi)(VFIODevice *vdev);
 139     void (*vfio_eoi)(VFIODevice *vdev);
 140     Object *(*vfio_get_object)(VFIODevice *vdev);
 141     void (*vfio_save_config)(VFIODevice *vdev, QEMUFile *f);
 142     int (*vfio_load_config)(VFIODevice *vdev, QEMUFile *f);
 143 };
 144
 145 typedef struct VFIOGroup {
 146     int fd;
 147     int groupid;
 148     VFIOContainer *container;
 149     QLIST_HEAD(, VFIODevice) device_list;
 150     QLIST_ENTRY(VFIOGroup) next;
 151     QLIST_ENTRY(VFIOGroup) container_next;
 152     bool ram_block_discard_allowed;
 153 } VFIOGroup;
 154
 155 typedef struct VFIODMABuf {
 156     QemuDmaBuf buf;
 157     uint32_t pos_x, pos_y, pos_updates;
 158     uint32_t hot_x, hot_y, hot_updates;
 159     int dmabuf_id;
 160     QTAILQ_ENTRY(VFIODMABuf) next;
 161 } VFIODMABuf;
 162
 163 typedef struct VFIODisplay {
 164     QemuConsole *con;
 165     RAMFBState *ramfb;
 166     struct vfio_region_info *edid_info;
 167     struct vfio_region_gfx_edid *edid_regs;
 168     uint8_t *edid_blob;
 169     QEMUTimer *edid_link_timer;
 170     struct {
 171         VFIORegion buffer;
 172         DisplaySurface *surface;
 173     } region;
 174     struct {
 175         QTAILQ_HEAD(, VFIODMABuf) bufs;
 176         VFIODMABuf *primary;
 177         VFIODMABuf *cursor;
 178     } dmabuf;
 179 } VFIODisplay;
 180
 181 void vfio_put_base_device(VFIODevice *vbasedev);
 182 void vfio_disable_irqindex(VFIODevice *vbasedev, int index);
 183 void vfio_unmask_single_irqindex(VFIODevice *vbasedev, int index);
 184 void vfio_mask_single_irqindex(VFIODevice *vbasedev, int index);
 185 int vfio_set_irq_signaling(VFIODevice *vbasedev, int index, int subindex,
 186                            int action, int fd, Error **errp);
 187 void vfio_region_write(void *opaque, hwaddr addr,
 188                            uint64_t data, unsigned size);
 189 uint64_t vfio_region_read(void *opaque,
 190                           hwaddr addr, unsigned size);
 191 int vfio_region_setup(Object *obj, VFIODevice *vbasedev, VFIORegion *region,
 192                       int index, const char *name);
 193 int vfio_region_mmap(VFIORegion *region);
 194 void vfio_region_mmaps_set_enabled(VFIORegion *region, bool enabled);
 195 void vfio_region_unmap(VFIORegion *region);
 196 void vfio_region_exit(VFIORegion *region);
 197 void vfio_region_finalize(VFIORegion *region);
 198 void vfio_reset_handler(void *opaque);
 199 VFIOGroup *vfio_get_group(int groupid, AddressSpace *as, Error **errp);
 200 void vfio_put_group(VFIOGroup *group);
 201 int vfio_get_device(VFIOGroup *group, const char *name,
 202                     VFIODevice *vbasedev, Error **errp);
 203
 204 extern const MemoryRegionOps vfio_region_ops;
 205 typedef QLIST_HEAD(VFIOGroupList, VFIOGroup) VFIOGroupList;
 206 extern VFIOGroupList vfio_group_list;
 207
 208 bool vfio_mig_active(void);
 209 int64_t vfio_mig_bytes_transferred(void);
 210
 211 #ifdef CONFIG_LINUX
 212 int vfio_get_region_info(VFIODevice *vbasedev, int index,
 213                          struct vfio_region_info **info);
 214 int vfio_get_dev_region_info(VFIODevice *vbasedev, uint32_t type,
 215                              uint32_t subtype, struct vfio_region_info **info);
 216 bool vfio_has_region_cap(VFIODevice *vbasedev, int region, uint16_t cap_type);
 217 struct vfio_info_cap_header *
 218 vfio_get_region_info_cap(struct vfio_region_info *info, uint16_t id);
 219 bool vfio_get_info_dma_avail(struct vfio_iommu_type1_info *info,
 220                              unsigned int *avail);
 221 struct vfio_info_cap_header *
 222 vfio_get_device_info_cap(struct vfio_device_info *info, uint16_t id);
 223 #endif
 224 extern const MemoryListener vfio_prereg_listener;
 225
 226 int vfio_spapr_create_window(VFIOContainer *container,
 227                              MemoryRegionSection *section,
 228                              hwaddr *pgsize);
 229 int vfio_spapr_remove_window(VFIOContainer *container,
 230                              hwaddr offset_within_address_space);
 231
 232 int vfio_migration_probe(VFIODevice *vbasedev, Error **errp);
 233 void vfio_migration_finalize(VFIODevice *vbasedev);
 234
 235 #endif /* HW_VFIO_VFIO_COMMON_H */