include/hw/virtio/vhost.h

   1 #ifndef VHOST_H
   2 #define VHOST_H
   3
   4 #include "hw/hw.h"
   5 #include "hw/virtio/vhost-backend.h"
   6 #include "hw/virtio/virtio.h"
   7 #include "exec/memory.h"
   8
   9 /* Generic structures common for any vhost based device. */
  10 struct vhost_virtqueue {
  11     int kick;
  12     int call;
  13     void *desc;
  14     void *avail;
  15     void *used;
  16     int num;
  17     unsigned long long desc_phys;
  18     unsigned desc_size;
  19     unsigned long long avail_phys;
  20     unsigned avail_size;
  21     unsigned long long used_phys;
  22     unsigned used_size;
  23     EventNotifier masked_notifier;
  24     struct vhost_dev *dev;
  25 };
  26
  27 typedef unsigned long vhost_log_chunk_t;
  28 #define VHOST_LOG_PAGE 0x1000
  29 #define VHOST_LOG_BITS (8 * sizeof(vhost_log_chunk_t))
  30 #define VHOST_LOG_CHUNK (VHOST_LOG_PAGE * VHOST_LOG_BITS)
  31 #define VHOST_INVALID_FEATURE_BIT   (0xff)
  32
  33 struct vhost_log {
  34     unsigned long long size;
  35     int refcnt;
  36     int fd;
  37     vhost_log_chunk_t *log;
  38 };
  39
  40 struct vhost_dev;
  41 struct vhost_iommu {
  42     struct vhost_dev *hdev;
  43     MemoryRegion *mr;
  44     hwaddr iommu_offset;
  45     IOMMUNotifier n;
  46     QLIST_ENTRY(vhost_iommu) iommu_next;
  47 };
  48
  49 typedef struct VhostDevConfigOps {
  50     /* Vhost device config space changed callback
  51      */
  52     int (*vhost_dev_config_notifier)(struct vhost_dev *dev);
  53 } VhostDevConfigOps;
  54
  55 struct vhost_memory;
  56 struct vhost_dev {
  57     VirtIODevice *vdev;
  58     MemoryListener memory_listener;
  59     MemoryListener iommu_listener;
  60     struct vhost_memory *mem;
  61     int n_mem_sections;
  62     MemoryRegionSection *mem_sections;
  63     int n_tmp_sections;
  64     MemoryRegionSection *tmp_sections;
  65     struct vhost_virtqueue *vqs;
  66     int nvqs;
  67     /* the first virtqueue which would be used by this vhost dev */
  68     int vq_index;
  69     uint64_t features;
  70     uint64_t acked_features;
  71     uint64_t backend_features;
  72     uint64_t protocol_features;
  73     uint64_t max_queues;
  74     bool started;
  75     bool log_enabled;
  76     uint64_t log_size;
  77     Error *migration_blocker;
  78     const VhostOps *vhost_ops;
  79     void *opaque;
  80     struct vhost_log *log;
  81     QLIST_ENTRY(vhost_dev) entry;
  82     QLIST_HEAD(, vhost_iommu) iommu_list;
  83     IOMMUNotifier n;
  84     const VhostDevConfigOps *config_ops;
  85 };
  86
  87 int vhost_dev_init(struct vhost_dev *hdev, void *opaque,
  88                    VhostBackendType backend_type,
  89                    uint32_t busyloop_timeout);
  90 void vhost_dev_cleanup(struct vhost_dev *hdev);
  91 int vhost_dev_start(struct vhost_dev *hdev, VirtIODevice *vdev);
  92 void vhost_dev_stop(struct vhost_dev *hdev, VirtIODevice *vdev);
  93 int vhost_dev_enable_notifiers(struct vhost_dev *hdev, VirtIODevice *vdev);
  94 void vhost_dev_disable_notifiers(struct vhost_dev *hdev, VirtIODevice *vdev);
  95
  96 /* Test and clear masked event pending status.
  97  * Should be called after unmask to avoid losing events.
  98  */
  99 bool vhost_virtqueue_pending(struct vhost_dev *hdev, int n);
 100
 101 /* Mask/unmask events from this vq.
 102  */
 103 void vhost_virtqueue_mask(struct vhost_dev *hdev, VirtIODevice *vdev, int n,
 104                           bool mask);
 105 uint64_t vhost_get_features(struct vhost_dev *hdev, const int *feature_bits,
 106                             uint64_t features);
 107 void vhost_ack_features(struct vhost_dev *hdev, const int *feature_bits,
 108                         uint64_t features);
 109 bool vhost_has_free_slot(void);
 110
 111 int vhost_net_set_backend(struct vhost_dev *hdev,
 112                           struct vhost_vring_file *file);
 113
 114 int vhost_device_iotlb_miss(struct vhost_dev *dev, uint64_t iova, int write);
 115 int vhost_dev_get_config(struct vhost_dev *dev, uint8_t *config,
 116                          uint32_t config_len);
 117 int vhost_dev_set_config(struct vhost_dev *dev, const uint8_t *data,
 118                          uint32_t offset, uint32_t size, uint32_t flags);
 119 /* notifier callback in case vhost device config space changed
 120  */
 121 void vhost_dev_set_config_notifier(struct vhost_dev *dev,
 122                                    const VhostDevConfigOps *ops);
 123 #endif