xref: /openbmc/qemu/include/hw/virtio/vhost.h (revision 502d0f36)
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 struct vhost_memory;
50 struct vhost_dev {
51     VirtIODevice *vdev;
52     MemoryListener memory_listener;
53     MemoryListener iommu_listener;
54     struct vhost_memory *mem;
55     int n_mem_sections;
56     MemoryRegionSection *mem_sections;
57     struct vhost_virtqueue *vqs;
58     int nvqs;
59     /* the first virtqueue which would be used by this vhost dev */
60     int vq_index;
61     uint64_t features;
62     uint64_t acked_features;
63     uint64_t backend_features;
64     uint64_t protocol_features;
65     uint64_t max_queues;
66     bool started;
67     bool log_enabled;
68     uint64_t log_size;
69     Error *migration_blocker;
70     bool memory_changed;
71     hwaddr mem_changed_start_addr;
72     hwaddr mem_changed_end_addr;
73     const VhostOps *vhost_ops;
74     void *opaque;
75     struct vhost_log *log;
76     QLIST_ENTRY(vhost_dev) entry;
77     QLIST_HEAD(, vhost_iommu) iommu_list;
78     IOMMUNotifier n;
79 };
80 
81 int vhost_dev_init(struct vhost_dev *hdev, void *opaque,
82                    VhostBackendType backend_type,
83                    uint32_t busyloop_timeout);
84 void vhost_dev_cleanup(struct vhost_dev *hdev);
85 int vhost_dev_start(struct vhost_dev *hdev, VirtIODevice *vdev);
86 void vhost_dev_stop(struct vhost_dev *hdev, VirtIODevice *vdev);
87 int vhost_dev_enable_notifiers(struct vhost_dev *hdev, VirtIODevice *vdev);
88 void vhost_dev_disable_notifiers(struct vhost_dev *hdev, VirtIODevice *vdev);
89 
90 /* Test and clear masked event pending status.
91  * Should be called after unmask to avoid losing events.
92  */
93 bool vhost_virtqueue_pending(struct vhost_dev *hdev, int n);
94 
95 /* Mask/unmask events from this vq.
96  */
97 void vhost_virtqueue_mask(struct vhost_dev *hdev, VirtIODevice *vdev, int n,
98                           bool mask);
99 uint64_t vhost_get_features(struct vhost_dev *hdev, const int *feature_bits,
100                             uint64_t features);
101 void vhost_ack_features(struct vhost_dev *hdev, const int *feature_bits,
102                         uint64_t features);
103 bool vhost_has_free_slot(void);
104 
105 int vhost_net_set_backend(struct vhost_dev *hdev,
106                           struct vhost_vring_file *file);
107 
108 int vhost_device_iotlb_miss(struct vhost_dev *dev, uint64_t iova, int write);
109 #endif
110