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 "exec/memory.h"
18#include "hw/qdev-core.h"
19#include "net/net.h"
20#include "migration/vmstate.h"
21#include "qemu/event_notifier.h"
22#include "standard-headers/linux/virtio_config.h"
23#include "standard-headers/linux/virtio_ring.h"
24#include "qom/object.h"
25#include "hw/virtio/vhost.h"
26
27
28
29
30
31
32
33#define VIRTIO_F_BAD_FEATURE 30
34
35#define VIRTIO_LEGACY_FEATURES ((0x1ULL << VIRTIO_F_BAD_FEATURE) | \
36 (0x1ULL << VIRTIO_F_NOTIFY_ON_EMPTY) | \
37 (0x1ULL << VIRTIO_F_ANY_LAYOUT))
38
39struct VirtQueue;
40
41static inline hwaddr vring_align(hwaddr addr,
42 unsigned long align)
43{
44 return QEMU_ALIGN_UP(addr, align);
45}
46
47typedef struct VirtIOFeature {
48 uint64_t flags;
49 size_t end;
50} VirtIOFeature;
51
52typedef struct VirtIOConfigSizeParams {
53 size_t min_size;
54 size_t max_size;
55 const VirtIOFeature *feature_sizes;
56} VirtIOConfigSizeParams;
57
58size_t virtio_get_config_size(const VirtIOConfigSizeParams *params,
59 uint64_t host_features);
60
61typedef struct VirtQueue VirtQueue;
62
63#define VIRTQUEUE_MAX_SIZE 1024
64
65typedef struct VirtQueueElement
66{
67 unsigned int index;
68 unsigned int len;
69 unsigned int ndescs;
70 unsigned int out_num;
71 unsigned int in_num;
72 hwaddr *in_addr;
73 hwaddr *out_addr;
74 struct iovec *in_sg;
75 struct iovec *out_sg;
76} VirtQueueElement;
77
78#define VIRTIO_QUEUE_MAX 1024
79
80#define VIRTIO_NO_VECTOR 0xffff
81
82#define TYPE_VIRTIO_DEVICE "virtio-device"
83OBJECT_DECLARE_TYPE(VirtIODevice, VirtioDeviceClass, VIRTIO_DEVICE)
84
85typedef struct {
86 int virtio_bit;
87 const char *feature_desc;
88} qmp_virtio_feature_map_t;
89
90enum virtio_device_endian {
91 VIRTIO_DEVICE_ENDIAN_UNKNOWN,
92 VIRTIO_DEVICE_ENDIAN_LITTLE,
93 VIRTIO_DEVICE_ENDIAN_BIG,
94};
95
96struct VirtIODevice
97{
98 DeviceState parent_obj;
99 const char *name;
100 uint8_t status;
101 uint8_t isr;
102 uint16_t queue_sel;
103 uint64_t guest_features;
104 uint64_t host_features;
105 uint64_t backend_features;
106 size_t config_len;
107 void *config;
108 uint16_t config_vector;
109 uint32_t generation;
110 int nvectors;
111 VirtQueue *vq;
112 MemoryListener listener;
113 uint16_t device_id;
114
115 bool vm_running;
116 bool broken;
117 bool use_disabled_flag;
118 bool disabled;
119
120
121
122
123
124
125
126 bool use_started;
127 bool started;
128 bool start_on_kick;
129 bool disable_legacy_check;
130 bool vhost_started;
131 VMChangeStateEntry *vmstate;
132 char *bus_name;
133 uint8_t device_endian;
134 bool use_guest_notifier_mask;
135 AddressSpace *dma_as;
136 QLIST_HEAD(, VirtQueue) *vector_queues;
137 QTAILQ_ENTRY(VirtIODevice) next;
138};
139
140struct VirtioDeviceClass {
141
142 DeviceClass parent;
143
144
145
146 DeviceRealize realize;
147 DeviceUnrealize unrealize;
148 uint64_t (*get_features)(VirtIODevice *vdev,
149 uint64_t requested_features,
150 Error **errp);
151 uint64_t (*bad_features)(VirtIODevice *vdev);
152 void (*set_features)(VirtIODevice *vdev, uint64_t val);
153 int (*validate_features)(VirtIODevice *vdev);
154 void (*get_config)(VirtIODevice *vdev, uint8_t *config);
155 void (*set_config)(VirtIODevice *vdev, const uint8_t *config);
156 void (*reset)(VirtIODevice *vdev);
157 void (*set_status)(VirtIODevice *vdev, uint8_t val);
158
159 void (*queue_reset)(VirtIODevice *vdev, uint32_t queue_index);
160
161 void (*queue_enable)(VirtIODevice *vdev, uint32_t queue_index);
162
163
164
165
166 uint64_t legacy_features;
167
168
169
170
171
172 bool (*guest_notifier_pending)(VirtIODevice *vdev, int n);
173
174
175
176
177
178 void (*guest_notifier_mask)(VirtIODevice *vdev, int n, bool mask);
179 int (*start_ioeventfd)(VirtIODevice *vdev);
180 void (*stop_ioeventfd)(VirtIODevice *vdev);
181
182
183
184 void (*save)(VirtIODevice *vdev, QEMUFile *f);
185 int (*load)(VirtIODevice *vdev, QEMUFile *f, int version_id);
186
187
188
189
190
191 int (*post_load)(VirtIODevice *vdev);
192 const VMStateDescription *vmsd;
193 bool (*primary_unplug_pending)(void *opaque);
194 struct vhost_dev *(*get_vhost)(VirtIODevice *vdev);
195};
196
197void virtio_instance_init_common(Object *proxy_obj, void *data,
198 size_t vdev_size, const char *vdev_name);
199
200void virtio_init(VirtIODevice *vdev, uint16_t device_id, size_t config_size);
201
202void virtio_cleanup(VirtIODevice *vdev);
203
204void virtio_error(VirtIODevice *vdev, const char *fmt, ...) G_GNUC_PRINTF(2, 3);
205
206
207void virtio_device_set_child_bus_name(VirtIODevice *vdev, char *bus_name);
208
209typedef void (*VirtIOHandleOutput)(VirtIODevice *, VirtQueue *);
210
211VirtQueue *virtio_add_queue(VirtIODevice *vdev, int queue_size,
212 VirtIOHandleOutput handle_output);
213
214void virtio_del_queue(VirtIODevice *vdev, int n);
215
216void virtio_delete_queue(VirtQueue *vq);
217
218void virtqueue_push(VirtQueue *vq, const VirtQueueElement *elem,
219 unsigned int len);
220void virtqueue_flush(VirtQueue *vq, unsigned int count);
221void virtqueue_detach_element(VirtQueue *vq, const VirtQueueElement *elem,
222 unsigned int len);
223void virtqueue_unpop(VirtQueue *vq, const VirtQueueElement *elem,
224 unsigned int len);
225bool virtqueue_rewind(VirtQueue *vq, unsigned int num);
226void virtqueue_fill(VirtQueue *vq, const VirtQueueElement *elem,
227 unsigned int len, unsigned int idx);
228
229void virtqueue_map(VirtIODevice *vdev, VirtQueueElement *elem);
230void *virtqueue_pop(VirtQueue *vq, size_t sz);
231unsigned int virtqueue_drop_all(VirtQueue *vq);
232void *qemu_get_virtqueue_element(VirtIODevice *vdev, QEMUFile *f, size_t sz);
233void qemu_put_virtqueue_element(VirtIODevice *vdev, QEMUFile *f,
234 VirtQueueElement *elem);
235int virtqueue_avail_bytes(VirtQueue *vq, unsigned int in_bytes,
236 unsigned int out_bytes);
237void virtqueue_get_avail_bytes(VirtQueue *vq, unsigned int *in_bytes,
238 unsigned int *out_bytes,
239 unsigned max_in_bytes, unsigned max_out_bytes);
240
241void virtio_notify_irqfd(VirtIODevice *vdev, VirtQueue *vq);
242void virtio_notify(VirtIODevice *vdev, VirtQueue *vq);
243
244int virtio_save(VirtIODevice *vdev, QEMUFile *f);
245
246extern const VMStateInfo virtio_vmstate_info;
247
248#define VMSTATE_VIRTIO_DEVICE \
249 { \
250 .name = "virtio", \
251 .info = &virtio_vmstate_info, \
252 .flags = VMS_SINGLE, \
253 }
254
255int virtio_load(VirtIODevice *vdev, QEMUFile *f, int version_id);
256
257void virtio_notify_config(VirtIODevice *vdev);
258
259bool virtio_queue_get_notification(VirtQueue *vq);
260void virtio_queue_set_notification(VirtQueue *vq, int enable);
261
262int virtio_queue_ready(VirtQueue *vq);
263
264int virtio_queue_empty(VirtQueue *vq);
265
266
267
268uint32_t virtio_config_readb(VirtIODevice *vdev, uint32_t addr);
269uint32_t virtio_config_readw(VirtIODevice *vdev, uint32_t addr);
270uint32_t virtio_config_readl(VirtIODevice *vdev, uint32_t addr);
271void virtio_config_writeb(VirtIODevice *vdev, uint32_t addr, uint32_t data);
272void virtio_config_writew(VirtIODevice *vdev, uint32_t addr, uint32_t data);
273void virtio_config_writel(VirtIODevice *vdev, uint32_t addr, uint32_t data);
274uint32_t virtio_config_modern_readb(VirtIODevice *vdev, uint32_t addr);
275uint32_t virtio_config_modern_readw(VirtIODevice *vdev, uint32_t addr);
276uint32_t virtio_config_modern_readl(VirtIODevice *vdev, uint32_t addr);
277void virtio_config_modern_writeb(VirtIODevice *vdev,
278 uint32_t addr, uint32_t data);
279void virtio_config_modern_writew(VirtIODevice *vdev,
280 uint32_t addr, uint32_t data);
281void virtio_config_modern_writel(VirtIODevice *vdev,
282 uint32_t addr, uint32_t data);
283void virtio_queue_set_addr(VirtIODevice *vdev, int n, hwaddr addr);
284hwaddr virtio_queue_get_addr(VirtIODevice *vdev, int n);
285void virtio_queue_set_num(VirtIODevice *vdev, int n, int num);
286int virtio_queue_get_num(VirtIODevice *vdev, int n);
287int virtio_queue_get_max_num(VirtIODevice *vdev, int n);
288int virtio_get_num_queues(VirtIODevice *vdev);
289void virtio_queue_set_rings(VirtIODevice *vdev, int n, hwaddr desc,
290 hwaddr avail, hwaddr used);
291void virtio_queue_update_rings(VirtIODevice *vdev, int n);
292void virtio_queue_set_align(VirtIODevice *vdev, int n, int align);
293void virtio_queue_notify(VirtIODevice *vdev, int n);
294uint16_t virtio_queue_vector(VirtIODevice *vdev, int n);
295void virtio_queue_set_vector(VirtIODevice *vdev, int n, uint16_t vector);
296int virtio_queue_set_host_notifier_mr(VirtIODevice *vdev, int n,
297 MemoryRegion *mr, bool assign);
298int virtio_set_status(VirtIODevice *vdev, uint8_t val);
299void virtio_reset(void *opaque);
300void virtio_queue_reset(VirtIODevice *vdev, uint32_t queue_index);
301void virtio_queue_enable(VirtIODevice *vdev, uint32_t queue_index);
302void virtio_update_irq(VirtIODevice *vdev);
303int virtio_set_features(VirtIODevice *vdev, uint64_t val);
304
305
306typedef struct VirtIOBlkConf VirtIOBlkConf;
307struct virtio_net_conf;
308typedef struct virtio_serial_conf virtio_serial_conf;
309typedef struct virtio_input_conf virtio_input_conf;
310typedef struct VirtIOSCSIConf VirtIOSCSIConf;
311typedef struct VirtIORNGConf VirtIORNGConf;
312
313#define DEFINE_VIRTIO_COMMON_FEATURES(_state, _field) \
314 DEFINE_PROP_BIT64("indirect_desc", _state, _field, \
315 VIRTIO_RING_F_INDIRECT_DESC, true), \
316 DEFINE_PROP_BIT64("event_idx", _state, _field, \
317 VIRTIO_RING_F_EVENT_IDX, true), \
318 DEFINE_PROP_BIT64("notify_on_empty", _state, _field, \
319 VIRTIO_F_NOTIFY_ON_EMPTY, true), \
320 DEFINE_PROP_BIT64("any_layout", _state, _field, \
321 VIRTIO_F_ANY_LAYOUT, true), \
322 DEFINE_PROP_BIT64("iommu_platform", _state, _field, \
323 VIRTIO_F_IOMMU_PLATFORM, false), \
324 DEFINE_PROP_BIT64("packed", _state, _field, \
325 VIRTIO_F_RING_PACKED, false), \
326 DEFINE_PROP_BIT64("queue_reset", _state, _field, \
327 VIRTIO_F_RING_RESET, true)
328
329hwaddr virtio_queue_get_desc_addr(VirtIODevice *vdev, int n);
330bool virtio_queue_enabled_legacy(VirtIODevice *vdev, int n);
331bool virtio_queue_enabled(VirtIODevice *vdev, int n);
332hwaddr virtio_queue_get_avail_addr(VirtIODevice *vdev, int n);
333hwaddr virtio_queue_get_used_addr(VirtIODevice *vdev, int n);
334hwaddr virtio_queue_get_desc_size(VirtIODevice *vdev, int n);
335hwaddr virtio_queue_get_avail_size(VirtIODevice *vdev, int n);
336hwaddr virtio_queue_get_used_size(VirtIODevice *vdev, int n);
337unsigned int virtio_queue_get_last_avail_idx(VirtIODevice *vdev, int n);
338void virtio_queue_set_last_avail_idx(VirtIODevice *vdev, int n,
339 unsigned int idx);
340void virtio_queue_restore_last_avail_idx(VirtIODevice *vdev, int n);
341void virtio_queue_invalidate_signalled_used(VirtIODevice *vdev, int n);
342void virtio_queue_update_used_idx(VirtIODevice *vdev, int n);
343VirtQueue *virtio_get_queue(VirtIODevice *vdev, int n);
344uint16_t virtio_get_queue_index(VirtQueue *vq);
345EventNotifier *virtio_queue_get_guest_notifier(VirtQueue *vq);
346void virtio_queue_set_guest_notifier_fd_handler(VirtQueue *vq, bool assign,
347 bool with_irqfd);
348int virtio_device_start_ioeventfd(VirtIODevice *vdev);
349int virtio_device_grab_ioeventfd(VirtIODevice *vdev);
350void virtio_device_release_ioeventfd(VirtIODevice *vdev);
351bool virtio_device_ioeventfd_enabled(VirtIODevice *vdev);
352EventNotifier *virtio_queue_get_host_notifier(VirtQueue *vq);
353void virtio_queue_set_host_notifier_enabled(VirtQueue *vq, bool enabled);
354void virtio_queue_host_notifier_read(EventNotifier *n);
355void virtio_queue_aio_attach_host_notifier(VirtQueue *vq, AioContext *ctx);
356void virtio_queue_aio_attach_host_notifier_no_poll(VirtQueue *vq, AioContext *ctx);
357void virtio_queue_aio_detach_host_notifier(VirtQueue *vq, AioContext *ctx);
358VirtQueue *virtio_vector_first_queue(VirtIODevice *vdev, uint16_t vector);
359VirtQueue *virtio_vector_next_queue(VirtQueue *vq);
360
361static inline void virtio_add_feature(uint64_t *features, unsigned int fbit)
362{
363 assert(fbit < 64);
364 *features |= (1ULL << fbit);
365}
366
367static inline void virtio_clear_feature(uint64_t *features, unsigned int fbit)
368{
369 assert(fbit < 64);
370 *features &= ~(1ULL << fbit);
371}
372
373static inline bool virtio_has_feature(uint64_t features, unsigned int fbit)
374{
375 assert(fbit < 64);
376 return !!(features & (1ULL << fbit));
377}
378
379static inline bool virtio_vdev_has_feature(VirtIODevice *vdev,
380 unsigned int fbit)
381{
382 return virtio_has_feature(vdev->guest_features, fbit);
383}
384
385static inline bool virtio_host_has_feature(VirtIODevice *vdev,
386 unsigned int fbit)
387{
388 return virtio_has_feature(vdev->host_features, fbit);
389}
390
391static inline bool virtio_is_big_endian(VirtIODevice *vdev)
392{
393 if (!virtio_vdev_has_feature(vdev, VIRTIO_F_VERSION_1)) {
394 assert(vdev->device_endian != VIRTIO_DEVICE_ENDIAN_UNKNOWN);
395 return vdev->device_endian == VIRTIO_DEVICE_ENDIAN_BIG;
396 }
397
398 return false;
399}
400
401
402
403
404
405
406
407
408
409
410
411static inline bool virtio_device_started(VirtIODevice *vdev, uint8_t status)
412{
413 if (vdev->use_started) {
414 return vdev->started;
415 }
416
417 return status & VIRTIO_CONFIG_S_DRIVER_OK;
418}
419
420
421
422
423
424
425
426
427
428
429static inline bool virtio_device_should_start(VirtIODevice *vdev, uint8_t status)
430{
431 if (!vdev->vm_running) {
432 return false;
433 }
434
435 return virtio_device_started(vdev, status);
436}
437
438static inline void virtio_set_started(VirtIODevice *vdev, bool started)
439{
440 if (started) {
441 vdev->start_on_kick = false;
442 }
443
444 if (vdev->use_started) {
445 vdev->started = started;
446 }
447}
448
449static inline void virtio_set_disabled(VirtIODevice *vdev, bool disable)
450{
451 if (vdev->use_disabled_flag) {
452 vdev->disabled = disable;
453 }
454}
455
456static inline bool virtio_device_disabled(VirtIODevice *vdev)
457{
458 return unlikely(vdev->disabled || vdev->broken);
459}
460
461bool virtio_legacy_allowed(VirtIODevice *vdev);
462bool virtio_legacy_check_disabled(VirtIODevice *vdev);
463
464#endif
465