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 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 VFIODeviceOps VFIODeviceOps;
  93
  94 typedef struct VFIODevice {
  95     QLIST_ENTRY(VFIODevice) next;
  96     QLIST_ENTRY(VFIODevice) container_next;
  97     QLIST_ENTRY(VFIODevice) global_next;
  98     struct VFIOGroup *group;
  99     VFIOContainerBase *bcontainer;
 100     char *sysfsdev;
 101     char *name;
 102     DeviceState *dev;
 103     int fd;
 104     int type;
 105     bool reset_works;
 106     bool needs_reset;
 107     bool no_mmap;
 108     bool ram_block_discard_allowed;
 109     OnOffAuto enable_migration;
 110     VFIODeviceOps *ops;
 111     unsigned int num_irqs;
 112     unsigned int num_regions;
 113     unsigned int flags;
 114     VFIOMigration *migration;
 115     Error *migration_blocker;
 116     OnOffAuto pre_copy_dirty_page_tracking;
 117     bool dirty_pages_supported;
 118     bool dirty_tracking;
 119 } VFIODevice;
 120
 121 struct VFIODeviceOps {
 122     void (*vfio_compute_needs_reset)(VFIODevice *vdev);
 123     int (*vfio_hot_reset_multi)(VFIODevice *vdev);
 124     void (*vfio_eoi)(VFIODevice *vdev);
 125     Object *(*vfio_get_object)(VFIODevice *vdev);
 126     void (*vfio_save_config)(VFIODevice *vdev, QEMUFile *f);
 127     int (*vfio_load_config)(VFIODevice *vdev, QEMUFile *f);
 128 };
 129
 130 typedef struct VFIOGroup {
 131     int fd;
 132     int groupid;
 133     VFIOContainer *container;
 134     QLIST_HEAD(, VFIODevice) device_list;
 135     QLIST_ENTRY(VFIOGroup) next;
 136     QLIST_ENTRY(VFIOGroup) container_next;
 137     bool ram_block_discard_allowed;
 138 } VFIOGroup;
 139
 140 typedef struct VFIODMABuf {
 141     QemuDmaBuf buf;
 142     uint32_t pos_x, pos_y, pos_updates;
 143     uint32_t hot_x, hot_y, hot_updates;
 144     int dmabuf_id;
 145     QTAILQ_ENTRY(VFIODMABuf) next;
 146 } VFIODMABuf;
 147
 148 typedef struct VFIODisplay {
 149     QemuConsole *con;
 150     RAMFBState *ramfb;
 151     struct vfio_region_info *edid_info;
 152     struct vfio_region_gfx_edid *edid_regs;
 153     uint8_t *edid_blob;
 154     QEMUTimer *edid_link_timer;
 155     struct {
 156         VFIORegion buffer;
 157         DisplaySurface *surface;
 158     } region;
 159     struct {
 160         QTAILQ_HEAD(, VFIODMABuf) bufs;
 161         VFIODMABuf *primary;
 162         VFIODMABuf *cursor;
 163     } dmabuf;
 164 } VFIODisplay;
 165
 166 VFIOAddressSpace *vfio_get_address_space(AddressSpace *as);
 167 void vfio_put_address_space(VFIOAddressSpace *space);
 168
 169 /* SPAPR specific */
 170 int vfio_spapr_container_init(VFIOContainer *container, Error **errp);
 171 void vfio_spapr_container_deinit(VFIOContainer *container);
 172
 173 void vfio_disable_irqindex(VFIODevice *vbasedev, int index);
 174 void vfio_unmask_single_irqindex(VFIODevice *vbasedev, int index);
 175 void vfio_mask_single_irqindex(VFIODevice *vbasedev, int index);
 176 int vfio_set_irq_signaling(VFIODevice *vbasedev, int index, int subindex,
 177                            int action, int fd, Error **errp);
 178 void vfio_region_write(void *opaque, hwaddr addr,
 179                            uint64_t data, unsigned size);
 180 uint64_t vfio_region_read(void *opaque,
 181                           hwaddr addr, unsigned size);
 182 int vfio_region_setup(Object *obj, VFIODevice *vbasedev, VFIORegion *region,
 183                       int index, const char *name);
 184 int vfio_region_mmap(VFIORegion *region);
 185 void vfio_region_mmaps_set_enabled(VFIORegion *region, bool enabled);
 186 void vfio_region_unmap(VFIORegion *region);
 187 void vfio_region_exit(VFIORegion *region);
 188 void vfio_region_finalize(VFIORegion *region);
 189 void vfio_reset_handler(void *opaque);
 190 struct vfio_device_info *vfio_get_device_info(int fd);
 191 int vfio_attach_device(char *name, VFIODevice *vbasedev,
 192                        AddressSpace *as, Error **errp);
 193 void vfio_detach_device(VFIODevice *vbasedev);
 194
 195 int vfio_kvm_device_add_fd(int fd, Error **errp);
 196 int vfio_kvm_device_del_fd(int fd, Error **errp);
 197
 198 extern const MemoryRegionOps vfio_region_ops;
 199 typedef QLIST_HEAD(VFIOGroupList, VFIOGroup) VFIOGroupList;
 200 typedef QLIST_HEAD(VFIODeviceList, VFIODevice) VFIODeviceList;
 201 extern VFIOGroupList vfio_group_list;
 202 extern VFIODeviceList vfio_device_list;
 203 extern const VFIOIOMMUOps vfio_legacy_ops;
 204 extern const MemoryListener vfio_memory_listener;
 205 extern int vfio_kvm_device_fd;
 206
 207 bool vfio_mig_active(void);
 208 int vfio_block_multiple_devices_migration(VFIODevice *vbasedev, Error **errp);
 209 void vfio_unblock_multiple_devices_migration(void);
 210 bool vfio_viommu_preset(VFIODevice *vbasedev);
 211 int64_t vfio_mig_bytes_transferred(void);
 212 void vfio_reset_bytes_transferred(void);
 213 bool vfio_device_state_is_running(VFIODevice *vbasedev);
 214 bool vfio_device_state_is_precopy(VFIODevice *vbasedev);
 215
 216 #ifdef CONFIG_LINUX
 217 int vfio_get_region_info(VFIODevice *vbasedev, int index,
 218                          struct vfio_region_info **info);
 219 int vfio_get_dev_region_info(VFIODevice *vbasedev, uint32_t type,
 220                              uint32_t subtype, struct vfio_region_info **info);
 221 bool vfio_has_region_cap(VFIODevice *vbasedev, int region, uint16_t cap_type);
 222 struct vfio_info_cap_header *
 223 vfio_get_region_info_cap(struct vfio_region_info *info, uint16_t id);
 224 bool vfio_get_info_dma_avail(struct vfio_iommu_type1_info *info,
 225                              unsigned int *avail);
 226 struct vfio_info_cap_header *
 227 vfio_get_device_info_cap(struct vfio_device_info *info, uint16_t id);
 228 struct vfio_info_cap_header *
 229 vfio_get_cap(void *ptr, uint32_t cap_offset, uint16_t id);
 230 #endif
 231
 232 bool vfio_migration_realize(VFIODevice *vbasedev, Error **errp);
 233 void vfio_migration_exit(VFIODevice *vbasedev);
 234
 235 int vfio_bitmap_alloc(VFIOBitmap *vbmap, hwaddr size);
 236 bool vfio_devices_all_running_and_mig_active(VFIOContainerBase *bcontainer);
 237 bool vfio_devices_all_device_dirty_tracking(VFIOContainerBase *bcontainer);
 238 int vfio_devices_query_dirty_bitmap(VFIOContainerBase *bcontainer,
 239                                     VFIOBitmap *vbmap, hwaddr iova,
 240                                     hwaddr size);
 241 int vfio_get_dirty_bitmap(VFIOContainerBase *bcontainer, uint64_t iova,
 242                                  uint64_t size, ram_addr_t ram_addr);
 243 #endif /* HW_VFIO_VFIO_COMMON_H */