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