xref: /openbmc/qemu/include/hw/virtio/vhost.h (revision ddbb0d09)
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 used_phys;
18     unsigned used_size;
19     void *ring;
20     unsigned long long ring_phys;
21     unsigned ring_size;
22     EventNotifier masked_notifier;
23 };
24 
25 typedef unsigned long vhost_log_chunk_t;
26 #define VHOST_LOG_PAGE 0x1000
27 #define VHOST_LOG_BITS (8 * sizeof(vhost_log_chunk_t))
28 #define VHOST_LOG_CHUNK (VHOST_LOG_PAGE * VHOST_LOG_BITS)
29 #define VHOST_INVALID_FEATURE_BIT   (0xff)
30 
31 struct vhost_log {
32     unsigned long long size;
33     int refcnt;
34     vhost_log_chunk_t log[0];
35 };
36 
37 struct vhost_memory;
38 struct vhost_dev {
39     MemoryListener memory_listener;
40     struct vhost_memory *mem;
41     int n_mem_sections;
42     MemoryRegionSection *mem_sections;
43     struct vhost_virtqueue *vqs;
44     int nvqs;
45     /* the first virtqueue which would be used by this vhost dev */
46     int vq_index;
47     unsigned long long features;
48     unsigned long long acked_features;
49     unsigned long long backend_features;
50     bool started;
51     bool log_enabled;
52     unsigned long long log_size;
53     Error *migration_blocker;
54     bool memory_changed;
55     hwaddr mem_changed_start_addr;
56     hwaddr mem_changed_end_addr;
57     const VhostOps *vhost_ops;
58     void *opaque;
59     struct vhost_log *log;
60 };
61 
62 int vhost_dev_init(struct vhost_dev *hdev, void *opaque,
63                    VhostBackendType backend_type);
64 void vhost_dev_cleanup(struct vhost_dev *hdev);
65 bool vhost_dev_query(struct vhost_dev *hdev, VirtIODevice *vdev);
66 int vhost_dev_start(struct vhost_dev *hdev, VirtIODevice *vdev);
67 void vhost_dev_stop(struct vhost_dev *hdev, VirtIODevice *vdev);
68 int vhost_dev_enable_notifiers(struct vhost_dev *hdev, VirtIODevice *vdev);
69 void vhost_dev_disable_notifiers(struct vhost_dev *hdev, VirtIODevice *vdev);
70 
71 /* Test and clear masked event pending status.
72  * Should be called after unmask to avoid losing events.
73  */
74 bool vhost_virtqueue_pending(struct vhost_dev *hdev, int n);
75 
76 /* Mask/unmask events from this vq.
77  */
78 void vhost_virtqueue_mask(struct vhost_dev *hdev, VirtIODevice *vdev, int n,
79                           bool mask);
80 uint64_t vhost_get_features(struct vhost_dev *hdev, const int *feature_bits,
81                             uint64_t features);
82 void vhost_ack_features(struct vhost_dev *hdev, const int *feature_bits,
83                         uint64_t features);
84 #endif
85