1/*
2 * Virtio Support
3 *
4 * Copyright IBM, Corp. 2007
5 *
6 * Authors:
7 * Anthony Liguori <aliguori@us.ibm.com>
8 *
9 * This work is licensed under the terms of the GNU GPL, version 2. See
10 * the COPYING file in the top-level directory.
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
25/* A guest should never accept this. It implies negotiation is broken. */
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 QEMU_ALIGN_UP(addr, align);
38}
39
40/*
41 * Calculate the number of bytes up to and including the given 'field' of
42 * 'container'.
43 */
44#define virtio_endof(container, field) \
45 (offsetof(container, field) + sizeof_field(container, field))
46
47typedef struct VirtIOFeature {
48 uint64_t flags;
49 size_t end;
50} VirtIOFeature;
51
52size_t virtio_feature_get_config_size(VirtIOFeature *features,
53 uint64_t host_features);
54
55typedef struct VirtQueue VirtQueue;
56
57#define VIRTQUEUE_MAX_SIZE 1024
58
59typedef struct VirtQueueElement
60{
61 unsigned int index;
62 unsigned int out_num;
63 unsigned int in_num;
64 hwaddr *in_addr;
65 hwaddr *out_addr;
66 struct iovec *in_sg;
67 struct iovec *out_sg;
68} VirtQueueElement;
69
70#define VIRTIO_QUEUE_MAX 1024
71
72#define VIRTIO_NO_VECTOR 0xffff
73
74#define TYPE_VIRTIO_DEVICE "virtio-device"
75#define VIRTIO_DEVICE_GET_CLASS(obj) \
76 OBJECT_GET_CLASS(VirtioDeviceClass, obj, TYPE_VIRTIO_DEVICE)
77#define VIRTIO_DEVICE_CLASS(klass) \
78 OBJECT_CLASS_CHECK(VirtioDeviceClass, klass, TYPE_VIRTIO_DEVICE)
79#define VIRTIO_DEVICE(obj) \
80 OBJECT_CHECK(VirtIODevice, (obj), TYPE_VIRTIO_DEVICE)
81
82enum virtio_device_endian {
83 VIRTIO_DEVICE_ENDIAN_UNKNOWN,
84 VIRTIO_DEVICE_ENDIAN_LITTLE,
85 VIRTIO_DEVICE_ENDIAN_BIG,
86};
87
88struct VirtIODevice
89{
90 DeviceState parent_obj;
91 const char *name;
92 uint8_t status;
93 uint8_t isr;
94 uint16_t queue_sel;
95 uint64_t guest_features;
96 uint64_t host_features;
97 uint64_t backend_features;
98 size_t config_len;
99 void *config;
100 uint16_t config_vector;
101 uint32_t generation;
102 int nvectors;
103 VirtQueue *vq;
104 MemoryListener listener;
105 uint16_t device_id;
106 bool vm_running;
107 bool broken; /* device in invalid state, needs reset */
108 bool use_started;
109 bool started;
110 bool start_on_kick; /* when virtio 1.0 feature has not been negotiated */
111 VMChangeStateEntry *vmstate;
112 char *bus_name;
113 uint8_t device_endian;
114 bool use_guest_notifier_mask;
115 AddressSpace *dma_as;
116 QLIST_HEAD(, VirtQueue) *vector_queues;
117};
118
119typedef struct VirtioDeviceClass {
120 /*< private >*/
121 DeviceClass parent;
122 /*< public >*/
123
124 /* This is what a VirtioDevice must implement */
125 DeviceRealize realize;
126 DeviceUnrealize unrealize;
127 uint64_t (*get_features)(VirtIODevice *vdev,
128 uint64_t requested_features,
129 Error **errp);
130 uint64_t (*bad_features)(VirtIODevice *vdev);
131 void (*set_features)(VirtIODevice *vdev, uint64_t val);
132 int (*validate_features)(VirtIODevice *vdev);
133 void (*get_config)(VirtIODevice *vdev, uint8_t *config);
134 void (*set_config)(VirtIODevice *vdev, const uint8_t *config);
135 void (*reset)(VirtIODevice *vdev);
136 void (*set_status)(VirtIODevice *vdev, uint8_t val);
137 /* For transitional devices, this is a bitmap of features
138 * that are only exposed on the legacy interface but not
139 * the modern one.
140 */
141 uint64_t legacy_features;
142 /* Test and clear event pending status.
143 * Should be called after unmask to avoid losing events.
144 * If backend does not support masking,
145 * must check in frontend instead.
146 */
147 bool (*guest_notifier_pending)(VirtIODevice *vdev, int n);
148 /* Mask/unmask events from this vq. Any events reported
149 * while masked will become pending.
150 * If backend does not support masking,
151 * must mask in frontend instead.
152 */
153 void (*guest_notifier_mask)(VirtIODevice *vdev, int n, bool mask);
154 int (*start_ioeventfd)(VirtIODevice *vdev);
155 void (*stop_ioeventfd)(VirtIODevice *vdev);
156 /* Saving and loading of a device; trying to deprecate save/load
157 * use vmsd for new devices.
158 */
159 void (*save)(VirtIODevice *vdev, QEMUFile *f);
160 int (*load)(VirtIODevice *vdev, QEMUFile *f, int version_id);
161 const VMStateDescription *vmsd;
162} VirtioDeviceClass;
163
164void virtio_instance_init_common(Object *proxy_obj, void *data,
165 size_t vdev_size, const char *vdev_name);
166
167void virtio_init(VirtIODevice *vdev, const char *name,
168 uint16_t device_id, size_t config_size);
169void virtio_cleanup(VirtIODevice *vdev);
170
171void virtio_error(VirtIODevice *vdev, const char *fmt, ...) GCC_FMT_ATTR(2, 3);
172
173/* Set the child bus name. */
174void virtio_device_set_child_bus_name(VirtIODevice *vdev, char *bus_name);
175
176typedef void (*VirtIOHandleOutput)(VirtIODevice *, VirtQueue *);
177typedef bool (*VirtIOHandleAIOOutput)(VirtIODevice *, VirtQueue *);
178
179VirtQueue *virtio_add_queue(VirtIODevice *vdev, int queue_size,
180 VirtIOHandleOutput handle_output);
181
182void virtio_del_queue(VirtIODevice *vdev, int n);
183
184void virtqueue_push(VirtQueue *vq, const VirtQueueElement *elem,
185 unsigned int len);
186void virtqueue_flush(VirtQueue *vq, unsigned int count);
187void virtqueue_detach_element(VirtQueue *vq, const VirtQueueElement *elem,
188 unsigned int len);
189void virtqueue_unpop(VirtQueue *vq, const VirtQueueElement *elem,
190 unsigned int len);
191bool virtqueue_rewind(VirtQueue *vq, unsigned int num);
192void virtqueue_fill(VirtQueue *vq, const VirtQueueElement *elem,
193 unsigned int len, unsigned int idx);
194
195void virtqueue_map(VirtIODevice *vdev, VirtQueueElement *elem);
196void *virtqueue_pop(VirtQueue *vq, size_t sz);
197unsigned int virtqueue_drop_all(VirtQueue *vq);
198void *qemu_get_virtqueue_element(VirtIODevice *vdev, QEMUFile *f, size_t sz);
199void qemu_put_virtqueue_element(QEMUFile *f, VirtQueueElement *elem);
200int virtqueue_avail_bytes(VirtQueue *vq, unsigned int in_bytes,
201 unsigned int out_bytes);
202void virtqueue_get_avail_bytes(VirtQueue *vq, unsigned int *in_bytes,
203 unsigned int *out_bytes,
204 unsigned max_in_bytes, unsigned max_out_bytes);
205
206void virtio_notify_irqfd(VirtIODevice *vdev, VirtQueue *vq);
207void virtio_notify(VirtIODevice *vdev, VirtQueue *vq);
208
209int virtio_save(VirtIODevice *vdev, QEMUFile *f);
210
211extern const VMStateInfo virtio_vmstate_info;
212
213#define VMSTATE_VIRTIO_DEVICE \
214 { \
215 .name = "virtio", \
216 .info = &virtio_vmstate_info, \
217 .flags = VMS_SINGLE, \
218 }
219
220int virtio_load(VirtIODevice *vdev, QEMUFile *f, int version_id);
221
222void virtio_notify_config(VirtIODevice *vdev);
223
224void virtio_queue_set_notification(VirtQueue *vq, int enable);
225
226int virtio_queue_ready(VirtQueue *vq);
227
228int virtio_queue_empty(VirtQueue *vq);
229
230/* Host binding interface. */
231
232uint32_t virtio_config_readb(VirtIODevice *vdev, uint32_t addr);
233uint32_t virtio_config_readw(VirtIODevice *vdev, uint32_t addr);
234uint32_t virtio_config_readl(VirtIODevice *vdev, uint32_t addr);
235void virtio_config_writeb(VirtIODevice *vdev, uint32_t addr, uint32_t data);
236void virtio_config_writew(VirtIODevice *vdev, uint32_t addr, uint32_t data);
237void virtio_config_writel(VirtIODevice *vdev, uint32_t addr, uint32_t data);
238uint32_t virtio_config_modern_readb(VirtIODevice *vdev, uint32_t addr);
239uint32_t virtio_config_modern_readw(VirtIODevice *vdev, uint32_t addr);
240uint32_t virtio_config_modern_readl(VirtIODevice *vdev, uint32_t addr);
241void virtio_config_modern_writeb(VirtIODevice *vdev,
242 uint32_t addr, uint32_t data);
243void virtio_config_modern_writew(VirtIODevice *vdev,
244 uint32_t addr, uint32_t data);
245void virtio_config_modern_writel(VirtIODevice *vdev,
246 uint32_t addr, uint32_t data);
247void virtio_queue_set_addr(VirtIODevice *vdev, int n, hwaddr addr);
248hwaddr virtio_queue_get_addr(VirtIODevice *vdev, int n);
249void virtio_queue_set_num(VirtIODevice *vdev, int n, int num);
250int virtio_queue_get_num(VirtIODevice *vdev, int n);
251int virtio_queue_get_max_num(VirtIODevice *vdev, int n);
252int virtio_get_num_queues(VirtIODevice *vdev);
253void virtio_queue_set_rings(VirtIODevice *vdev, int n, hwaddr desc,
254 hwaddr avail, hwaddr used);
255void virtio_queue_update_rings(VirtIODevice *vdev, int n);
256void virtio_queue_set_align(VirtIODevice *vdev, int n, int align);
257void virtio_queue_notify(VirtIODevice *vdev, int n);
258uint16_t virtio_queue_vector(VirtIODevice *vdev, int n);
259void virtio_queue_set_vector(VirtIODevice *vdev, int n, uint16_t vector);
260int virtio_queue_set_host_notifier_mr(VirtIODevice *vdev, int n,
261 MemoryRegion *mr, bool assign);
262int virtio_set_status(VirtIODevice *vdev, uint8_t val);
263void virtio_reset(void *opaque);
264void virtio_update_irq(VirtIODevice *vdev);
265int virtio_set_features(VirtIODevice *vdev, uint64_t val);
266
267/* Base devices. */
268typedef struct VirtIOBlkConf VirtIOBlkConf;
269struct virtio_net_conf;
270typedef struct virtio_serial_conf virtio_serial_conf;
271typedef struct virtio_input_conf virtio_input_conf;
272typedef struct VirtIOSCSIConf VirtIOSCSIConf;
273typedef struct VirtIORNGConf VirtIORNGConf;
274
275#define DEFINE_VIRTIO_COMMON_FEATURES(_state, _field) \
276 DEFINE_PROP_BIT64("indirect_desc", _state, _field, \
277 VIRTIO_RING_F_INDIRECT_DESC, true), \
278 DEFINE_PROP_BIT64("event_idx", _state, _field, \
279 VIRTIO_RING_F_EVENT_IDX, true), \
280 DEFINE_PROP_BIT64("notify_on_empty", _state, _field, \
281 VIRTIO_F_NOTIFY_ON_EMPTY, true), \
282 DEFINE_PROP_BIT64("any_layout", _state, _field, \
283 VIRTIO_F_ANY_LAYOUT, true), \
284 DEFINE_PROP_BIT64("iommu_platform", _state, _field, \
285 VIRTIO_F_IOMMU_PLATFORM, false)
286
287hwaddr virtio_queue_get_desc_addr(VirtIODevice *vdev, int n);
288bool virtio_queue_enabled(VirtIODevice *vdev, int n);
289hwaddr virtio_queue_get_avail_addr(VirtIODevice *vdev, int n);
290hwaddr virtio_queue_get_used_addr(VirtIODevice *vdev, int n);
291hwaddr virtio_queue_get_desc_size(VirtIODevice *vdev, int n);
292hwaddr virtio_queue_get_avail_size(VirtIODevice *vdev, int n);
293hwaddr virtio_queue_get_used_size(VirtIODevice *vdev, int n);
294uint16_t virtio_queue_get_last_avail_idx(VirtIODevice *vdev, int n);
295void virtio_queue_set_last_avail_idx(VirtIODevice *vdev, int n, uint16_t idx);
296void virtio_queue_restore_last_avail_idx(VirtIODevice *vdev, int n);
297void virtio_queue_invalidate_signalled_used(VirtIODevice *vdev, int n);
298void virtio_queue_update_used_idx(VirtIODevice *vdev, int n);
299VirtQueue *virtio_get_queue(VirtIODevice *vdev, int n);
300uint16_t virtio_get_queue_index(VirtQueue *vq);
301EventNotifier *virtio_queue_get_guest_notifier(VirtQueue *vq);
302void virtio_queue_set_guest_notifier_fd_handler(VirtQueue *vq, bool assign,
303 bool with_irqfd);
304int virtio_device_start_ioeventfd(VirtIODevice *vdev);
305void virtio_device_stop_ioeventfd(VirtIODevice *vdev);
306int virtio_device_grab_ioeventfd(VirtIODevice *vdev);
307void virtio_device_release_ioeventfd(VirtIODevice *vdev);
308bool virtio_device_ioeventfd_enabled(VirtIODevice *vdev);
309EventNotifier *virtio_queue_get_host_notifier(VirtQueue *vq);
310void virtio_queue_host_notifier_read(EventNotifier *n);
311void virtio_queue_aio_set_host_notifier_handler(VirtQueue *vq, AioContext *ctx,
312 VirtIOHandleAIOOutput handle_output);
313VirtQueue *virtio_vector_first_queue(VirtIODevice *vdev, uint16_t vector);
314VirtQueue *virtio_vector_next_queue(VirtQueue *vq);
315
316static inline void virtio_add_feature(uint64_t *features, unsigned int fbit)
317{
318 assert(fbit < 64);
319 *features |= (1ULL << fbit);
320}
321
322static inline void virtio_clear_feature(uint64_t *features, unsigned int fbit)
323{
324 assert(fbit < 64);
325 *features &= ~(1ULL << fbit);
326}
327
328static inline bool virtio_has_feature(uint64_t features, unsigned int fbit)
329{
330 assert(fbit < 64);
331 return !!(features & (1ULL << fbit));
332}
333
334static inline bool virtio_vdev_has_feature(VirtIODevice *vdev,
335 unsigned int fbit)
336{
337 return virtio_has_feature(vdev->guest_features, fbit);
338}
339
340static inline bool virtio_host_has_feature(VirtIODevice *vdev,
341 unsigned int fbit)
342{
343 return virtio_has_feature(vdev->host_features, fbit);
344}
345
346static inline bool virtio_is_big_endian(VirtIODevice *vdev)
347{
348 if (!virtio_vdev_has_feature(vdev, VIRTIO_F_VERSION_1)) {
349 assert(vdev->device_endian != VIRTIO_DEVICE_ENDIAN_UNKNOWN);
350 return vdev->device_endian == VIRTIO_DEVICE_ENDIAN_BIG;
351 }
352 /* Devices conforming to VIRTIO 1.0 or later are always LE. */
353 return false;
354}
355
356static inline bool virtio_device_started(VirtIODevice *vdev, uint8_t status)
357{
358 if (vdev->use_started) {
359 return vdev->started;
360 }
361
362 return status & VIRTIO_CONFIG_S_DRIVER_OK;
363}
364
365static inline void virtio_set_started(VirtIODevice *vdev, bool started)
366{
367 if (started) {
368 vdev->start_on_kick = false;
369 }
370
371 if (vdev->use_started) {
372 vdev->started = started;
373 }
374}
375#endif
376