1
2
3
4
5
6
7
8
9
10
11
12
13
14#ifndef QEMU_VIRTIO_H
15#define QEMU_VIRTIO_H
16
17#include "hw/hw.h"
18#include "net/net.h"
19#include "hw/qdev.h"
20#include "sysemu/sysemu.h"
21#include "qemu/event_notifier.h"
22#include "standard-headers/linux/virtio_config.h"
23#include "standard-headers/linux/virtio_ring.h"
24
25
26#define VIRTIO_F_BAD_FEATURE 30
27
28#define VIRTIO_LEGACY_FEATURES ((0x1ULL << VIRTIO_F_BAD_FEATURE) | \
29 (0x1ULL << VIRTIO_F_NOTIFY_ON_EMPTY) | \
30 (0x1ULL << VIRTIO_F_ANY_LAYOUT))
31
32struct VirtQueue;
33
34static inline hwaddr vring_align(hwaddr addr,
35 unsigned long align)
36{
37 return (addr + align - 1) & ~(align - 1);
38}
39
40typedef struct VirtQueue VirtQueue;
41
42#define VIRTQUEUE_MAX_SIZE 1024
43
44typedef struct VirtQueueElement
45{
46 unsigned int index;
47 unsigned int out_num;
48 unsigned int in_num;
49 hwaddr *in_addr;
50 hwaddr *out_addr;
51 struct iovec *in_sg;
52 struct iovec *out_sg;
53} VirtQueueElement;
54
55#define VIRTIO_QUEUE_MAX 1024
56
57#define VIRTIO_NO_VECTOR 0xffff
58
59#define TYPE_VIRTIO_DEVICE "virtio-device"
60#define VIRTIO_DEVICE_GET_CLASS(obj) \
61 OBJECT_GET_CLASS(VirtioDeviceClass, obj, TYPE_VIRTIO_DEVICE)
62#define VIRTIO_DEVICE_CLASS(klass) \
63 OBJECT_CLASS_CHECK(VirtioDeviceClass, klass, TYPE_VIRTIO_DEVICE)
64#define VIRTIO_DEVICE(obj) \
65 OBJECT_CHECK(VirtIODevice, (obj), TYPE_VIRTIO_DEVICE)
66
67enum virtio_device_endian {
68 VIRTIO_DEVICE_ENDIAN_UNKNOWN,
69 VIRTIO_DEVICE_ENDIAN_LITTLE,
70 VIRTIO_DEVICE_ENDIAN_BIG,
71};
72
73struct VirtIODevice
74{
75 DeviceState parent_obj;
76 const char *name;
77 uint8_t status;
78 uint8_t isr;
79 uint16_t queue_sel;
80 uint64_t guest_features;
81 uint64_t host_features;
82 size_t config_len;
83 void *config;
84 uint16_t config_vector;
85 uint32_t generation;
86 int nvectors;
87 VirtQueue *vq;
88 uint16_t device_id;
89 bool vm_running;
90 bool broken;
91 VMChangeStateEntry *vmstate;
92 char *bus_name;
93 uint8_t device_endian;
94 bool use_guest_notifier_mask;
95 QLIST_HEAD(, VirtQueue) *vector_queues;
96};
97
98typedef struct VirtioDeviceClass {
99
100 DeviceClass parent;
101
102
103
104 DeviceRealize realize;
105 DeviceUnrealize unrealize;
106 uint64_t (*get_features)(VirtIODevice *vdev,
107 uint64_t requested_features,
108 Error **errp);
109 uint64_t (*bad_features)(VirtIODevice *vdev);
110 void (*set_features)(VirtIODevice *vdev, uint64_t val);
111 int (*validate_features)(VirtIODevice *vdev);
112 void (*get_config)(VirtIODevice *vdev, uint8_t *config);
113 void (*set_config)(VirtIODevice *vdev, const uint8_t *config);
114 void (*reset)(VirtIODevice *vdev);
115 void (*set_status)(VirtIODevice *vdev, uint8_t val);
116
117
118
119
120 uint64_t legacy_features;
121
122
123
124
125
126 bool (*guest_notifier_pending)(VirtIODevice *vdev, int n);
127
128
129
130
131
132 void (*guest_notifier_mask)(VirtIODevice *vdev, int n, bool mask);
133 int (*start_ioeventfd)(VirtIODevice *vdev);
134 void (*stop_ioeventfd)(VirtIODevice *vdev);
135
136
137
138 void (*save)(VirtIODevice *vdev, QEMUFile *f);
139 int (*load)(VirtIODevice *vdev, QEMUFile *f, int version_id);
140 const VMStateDescription *vmsd;
141} VirtioDeviceClass;
142
143void virtio_instance_init_common(Object *proxy_obj, void *data,
144 size_t vdev_size, const char *vdev_name);
145
146void virtio_init(VirtIODevice *vdev, const char *name,
147 uint16_t device_id, size_t config_size);
148void virtio_cleanup(VirtIODevice *vdev);
149
150void virtio_error(VirtIODevice *vdev, const char *fmt, ...) GCC_FMT_ATTR(2, 3);
151
152
153void virtio_device_set_child_bus_name(VirtIODevice *vdev, char *bus_name);
154
155typedef void (*VirtIOHandleOutput)(VirtIODevice *, VirtQueue *);
156
157VirtQueue *virtio_add_queue(VirtIODevice *vdev, int queue_size,
158 VirtIOHandleOutput handle_output);
159
160void virtio_del_queue(VirtIODevice *vdev, int n);
161
162void virtqueue_push(VirtQueue *vq, const VirtQueueElement *elem,
163 unsigned int len);
164void virtqueue_flush(VirtQueue *vq, unsigned int count);
165void virtqueue_detach_element(VirtQueue *vq, const VirtQueueElement *elem,
166 unsigned int len);
167void virtqueue_unpop(VirtQueue *vq, const VirtQueueElement *elem,
168 unsigned int len);
169bool virtqueue_rewind(VirtQueue *vq, unsigned int num);
170void virtqueue_fill(VirtQueue *vq, const VirtQueueElement *elem,
171 unsigned int len, unsigned int idx);
172
173void virtqueue_map(VirtQueueElement *elem);
174void *virtqueue_pop(VirtQueue *vq, size_t sz);
175void *qemu_get_virtqueue_element(QEMUFile *f, size_t sz);
176void qemu_put_virtqueue_element(QEMUFile *f, VirtQueueElement *elem);
177int virtqueue_avail_bytes(VirtQueue *vq, unsigned int in_bytes,
178 unsigned int out_bytes);
179void virtqueue_get_avail_bytes(VirtQueue *vq, unsigned int *in_bytes,
180 unsigned int *out_bytes,
181 unsigned max_in_bytes, unsigned max_out_bytes);
182
183bool virtio_should_notify(VirtIODevice *vdev, VirtQueue *vq);
184void virtio_notify_irqfd(VirtIODevice *vdev, VirtQueue *vq);
185void virtio_notify(VirtIODevice *vdev, VirtQueue *vq);
186
187void virtio_save(VirtIODevice *vdev, QEMUFile *f);
188
189extern const VMStateInfo virtio_vmstate_info;
190
191#define VMSTATE_VIRTIO_DEVICE \
192 { \
193 .name = "virtio", \
194 .info = &virtio_vmstate_info, \
195 .flags = VMS_SINGLE, \
196 }
197
198int virtio_load(VirtIODevice *vdev, QEMUFile *f, int version_id);
199
200void virtio_notify_config(VirtIODevice *vdev);
201
202void virtio_queue_set_notification(VirtQueue *vq, int enable);
203
204int virtio_queue_ready(VirtQueue *vq);
205
206int virtio_queue_empty(VirtQueue *vq);
207
208
209
210uint32_t virtio_config_readb(VirtIODevice *vdev, uint32_t addr);
211uint32_t virtio_config_readw(VirtIODevice *vdev, uint32_t addr);
212uint32_t virtio_config_readl(VirtIODevice *vdev, uint32_t addr);
213void virtio_config_writeb(VirtIODevice *vdev, uint32_t addr, uint32_t data);
214void virtio_config_writew(VirtIODevice *vdev, uint32_t addr, uint32_t data);
215void virtio_config_writel(VirtIODevice *vdev, uint32_t addr, uint32_t data);
216uint32_t virtio_config_modern_readb(VirtIODevice *vdev, uint32_t addr);
217uint32_t virtio_config_modern_readw(VirtIODevice *vdev, uint32_t addr);
218uint32_t virtio_config_modern_readl(VirtIODevice *vdev, uint32_t addr);
219void virtio_config_modern_writeb(VirtIODevice *vdev,
220 uint32_t addr, uint32_t data);
221void virtio_config_modern_writew(VirtIODevice *vdev,
222 uint32_t addr, uint32_t data);
223void virtio_config_modern_writel(VirtIODevice *vdev,
224 uint32_t addr, uint32_t data);
225void virtio_queue_set_addr(VirtIODevice *vdev, int n, hwaddr addr);
226hwaddr virtio_queue_get_addr(VirtIODevice *vdev, int n);
227void virtio_queue_set_num(VirtIODevice *vdev, int n, int num);
228int virtio_queue_get_num(VirtIODevice *vdev, int n);
229int virtio_get_num_queues(VirtIODevice *vdev);
230void virtio_queue_set_rings(VirtIODevice *vdev, int n, hwaddr desc,
231 hwaddr avail, hwaddr used);
232void virtio_queue_update_rings(VirtIODevice *vdev, int n);
233void virtio_queue_set_align(VirtIODevice *vdev, int n, int align);
234void virtio_queue_notify(VirtIODevice *vdev, int n);
235uint16_t virtio_queue_vector(VirtIODevice *vdev, int n);
236void virtio_queue_set_vector(VirtIODevice *vdev, int n, uint16_t vector);
237int virtio_set_status(VirtIODevice *vdev, uint8_t val);
238void virtio_reset(void *opaque);
239void virtio_update_irq(VirtIODevice *vdev);
240int virtio_set_features(VirtIODevice *vdev, uint64_t val);
241
242
243typedef struct VirtIOBlkConf VirtIOBlkConf;
244struct virtio_net_conf;
245typedef struct virtio_serial_conf virtio_serial_conf;
246typedef struct virtio_input_conf virtio_input_conf;
247typedef struct VirtIOSCSIConf VirtIOSCSIConf;
248typedef struct VirtIORNGConf VirtIORNGConf;
249
250#define DEFINE_VIRTIO_COMMON_FEATURES(_state, _field) \
251 DEFINE_PROP_BIT64("indirect_desc", _state, _field, \
252 VIRTIO_RING_F_INDIRECT_DESC, true), \
253 DEFINE_PROP_BIT64("event_idx", _state, _field, \
254 VIRTIO_RING_F_EVENT_IDX, true), \
255 DEFINE_PROP_BIT64("notify_on_empty", _state, _field, \
256 VIRTIO_F_NOTIFY_ON_EMPTY, true), \
257 DEFINE_PROP_BIT64("any_layout", _state, _field, \
258 VIRTIO_F_ANY_LAYOUT, true)
259
260hwaddr virtio_queue_get_desc_addr(VirtIODevice *vdev, int n);
261hwaddr virtio_queue_get_avail_addr(VirtIODevice *vdev, int n);
262hwaddr virtio_queue_get_used_addr(VirtIODevice *vdev, int n);
263hwaddr virtio_queue_get_desc_size(VirtIODevice *vdev, int n);
264hwaddr virtio_queue_get_avail_size(VirtIODevice *vdev, int n);
265hwaddr virtio_queue_get_used_size(VirtIODevice *vdev, int n);
266uint16_t virtio_queue_get_last_avail_idx(VirtIODevice *vdev, int n);
267void virtio_queue_set_last_avail_idx(VirtIODevice *vdev, int n, uint16_t idx);
268void virtio_queue_invalidate_signalled_used(VirtIODevice *vdev, int n);
269VirtQueue *virtio_get_queue(VirtIODevice *vdev, int n);
270uint16_t virtio_get_queue_index(VirtQueue *vq);
271EventNotifier *virtio_queue_get_guest_notifier(VirtQueue *vq);
272void virtio_queue_set_guest_notifier_fd_handler(VirtQueue *vq, bool assign,
273 bool with_irqfd);
274int virtio_device_start_ioeventfd(VirtIODevice *vdev);
275void virtio_device_stop_ioeventfd(VirtIODevice *vdev);
276int virtio_device_grab_ioeventfd(VirtIODevice *vdev);
277void virtio_device_release_ioeventfd(VirtIODevice *vdev);
278bool virtio_device_ioeventfd_enabled(VirtIODevice *vdev);
279EventNotifier *virtio_queue_get_host_notifier(VirtQueue *vq);
280void virtio_queue_host_notifier_read(EventNotifier *n);
281void virtio_queue_aio_set_host_notifier_handler(VirtQueue *vq, AioContext *ctx,
282 void (*fn)(VirtIODevice *,
283 VirtQueue *));
284VirtQueue *virtio_vector_first_queue(VirtIODevice *vdev, uint16_t vector);
285VirtQueue *virtio_vector_next_queue(VirtQueue *vq);
286
287static inline void virtio_add_feature(uint64_t *features, unsigned int fbit)
288{
289 assert(fbit < 64);
290 *features |= (1ULL << fbit);
291}
292
293static inline void virtio_clear_feature(uint64_t *features, unsigned int fbit)
294{
295 assert(fbit < 64);
296 *features &= ~(1ULL << fbit);
297}
298
299static inline bool virtio_has_feature(uint64_t features, unsigned int fbit)
300{
301 assert(fbit < 64);
302 return !!(features & (1ULL << fbit));
303}
304
305static inline bool virtio_vdev_has_feature(VirtIODevice *vdev,
306 unsigned int fbit)
307{
308 return virtio_has_feature(vdev->guest_features, fbit);
309}
310
311static inline bool virtio_host_has_feature(VirtIODevice *vdev,
312 unsigned int fbit)
313{
314 return virtio_has_feature(vdev->host_features, fbit);
315}
316
317static inline bool virtio_is_big_endian(VirtIODevice *vdev)
318{
319 if (!virtio_vdev_has_feature(vdev, VIRTIO_F_VERSION_1)) {
320 assert(vdev->device_endian != VIRTIO_DEVICE_ENDIAN_UNKNOWN);
321 return vdev->device_endian == VIRTIO_DEVICE_ENDIAN_BIG;
322 }
323
324 return false;
325}
326#endif
327