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