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 VMChangeStateEntry *vmstate;
91 char *bus_name;
92 uint8_t device_endian;
93 bool use_guest_notifier_mask;
94 QLIST_HEAD(, VirtQueue) *vector_queues;
95};
96
97typedef struct VirtioDeviceClass {
98
99 DeviceClass parent;
100
101
102
103 DeviceRealize realize;
104 DeviceUnrealize unrealize;
105 uint64_t (*get_features)(VirtIODevice *vdev,
106 uint64_t requested_features,
107 Error **errp);
108 uint64_t (*bad_features)(VirtIODevice *vdev);
109 void (*set_features)(VirtIODevice *vdev, uint64_t val);
110 int (*validate_features)(VirtIODevice *vdev);
111 void (*get_config)(VirtIODevice *vdev, uint8_t *config);
112 void (*set_config)(VirtIODevice *vdev, const uint8_t *config);
113 void (*reset)(VirtIODevice *vdev);
114 void (*set_status)(VirtIODevice *vdev, uint8_t val);
115
116
117
118
119
120 bool (*guest_notifier_pending)(VirtIODevice *vdev, int n);
121
122
123
124
125
126 void (*guest_notifier_mask)(VirtIODevice *vdev, int n, bool mask);
127 void (*save)(VirtIODevice *vdev, QEMUFile *f);
128 int (*load)(VirtIODevice *vdev, QEMUFile *f, int version_id);
129} VirtioDeviceClass;
130
131void virtio_instance_init_common(Object *proxy_obj, void *data,
132 size_t vdev_size, const char *vdev_name);
133
134void virtio_init(VirtIODevice *vdev, const char *name,
135 uint16_t device_id, size_t config_size);
136void virtio_cleanup(VirtIODevice *vdev);
137
138
139void virtio_device_set_child_bus_name(VirtIODevice *vdev, char *bus_name);
140
141VirtQueue *virtio_add_queue(VirtIODevice *vdev, int queue_size,
142 void (*handle_output)(VirtIODevice *,
143 VirtQueue *));
144
145void virtio_del_queue(VirtIODevice *vdev, int n);
146
147void *virtqueue_alloc_element(size_t sz, unsigned out_num, unsigned in_num);
148void virtqueue_push(VirtQueue *vq, const VirtQueueElement *elem,
149 unsigned int len);
150void virtqueue_flush(VirtQueue *vq, unsigned int count);
151void virtqueue_discard(VirtQueue *vq, const VirtQueueElement *elem,
152 unsigned int len);
153void virtqueue_fill(VirtQueue *vq, const VirtQueueElement *elem,
154 unsigned int len, unsigned int idx);
155
156void virtqueue_map(VirtQueueElement *elem);
157void *virtqueue_pop(VirtQueue *vq, size_t sz);
158void *qemu_get_virtqueue_element(QEMUFile *f, size_t sz);
159void qemu_put_virtqueue_element(QEMUFile *f, VirtQueueElement *elem);
160int virtqueue_avail_bytes(VirtQueue *vq, unsigned int in_bytes,
161 unsigned int out_bytes);
162void virtqueue_get_avail_bytes(VirtQueue *vq, unsigned int *in_bytes,
163 unsigned int *out_bytes,
164 unsigned max_in_bytes, unsigned max_out_bytes);
165
166bool virtio_should_notify(VirtIODevice *vdev, VirtQueue *vq);
167void virtio_notify(VirtIODevice *vdev, VirtQueue *vq);
168
169void virtio_save(VirtIODevice *vdev, QEMUFile *f);
170
171int virtio_load(VirtIODevice *vdev, QEMUFile *f, int version_id);
172
173void virtio_notify_config(VirtIODevice *vdev);
174
175void virtio_queue_set_notification(VirtQueue *vq, int enable);
176
177int virtio_queue_ready(VirtQueue *vq);
178
179int virtio_queue_empty(VirtQueue *vq);
180
181
182
183uint32_t virtio_config_readb(VirtIODevice *vdev, uint32_t addr);
184uint32_t virtio_config_readw(VirtIODevice *vdev, uint32_t addr);
185uint32_t virtio_config_readl(VirtIODevice *vdev, uint32_t addr);
186void virtio_config_writeb(VirtIODevice *vdev, uint32_t addr, uint32_t data);
187void virtio_config_writew(VirtIODevice *vdev, uint32_t addr, uint32_t data);
188void virtio_config_writel(VirtIODevice *vdev, uint32_t addr, uint32_t data);
189uint32_t virtio_config_modern_readb(VirtIODevice *vdev, uint32_t addr);
190uint32_t virtio_config_modern_readw(VirtIODevice *vdev, uint32_t addr);
191uint32_t virtio_config_modern_readl(VirtIODevice *vdev, uint32_t addr);
192void virtio_config_modern_writeb(VirtIODevice *vdev,
193 uint32_t addr, uint32_t data);
194void virtio_config_modern_writew(VirtIODevice *vdev,
195 uint32_t addr, uint32_t data);
196void virtio_config_modern_writel(VirtIODevice *vdev,
197 uint32_t addr, uint32_t data);
198void virtio_queue_set_addr(VirtIODevice *vdev, int n, hwaddr addr);
199hwaddr virtio_queue_get_addr(VirtIODevice *vdev, int n);
200void virtio_queue_set_num(VirtIODevice *vdev, int n, int num);
201int virtio_queue_get_num(VirtIODevice *vdev, int n);
202int virtio_get_num_queues(VirtIODevice *vdev);
203void virtio_queue_set_rings(VirtIODevice *vdev, int n, hwaddr desc,
204 hwaddr avail, hwaddr used);
205void virtio_queue_update_rings(VirtIODevice *vdev, int n);
206void virtio_queue_set_align(VirtIODevice *vdev, int n, int align);
207void virtio_queue_notify(VirtIODevice *vdev, int n);
208uint16_t virtio_queue_vector(VirtIODevice *vdev, int n);
209void virtio_queue_set_vector(VirtIODevice *vdev, int n, uint16_t vector);
210int virtio_set_status(VirtIODevice *vdev, uint8_t val);
211void virtio_reset(void *opaque);
212void virtio_update_irq(VirtIODevice *vdev);
213int virtio_set_features(VirtIODevice *vdev, uint64_t val);
214
215
216typedef struct VirtIOBlkConf VirtIOBlkConf;
217struct virtio_net_conf;
218typedef struct virtio_serial_conf virtio_serial_conf;
219typedef struct virtio_input_conf virtio_input_conf;
220typedef struct VirtIOSCSIConf VirtIOSCSIConf;
221typedef struct VirtIORNGConf VirtIORNGConf;
222
223#define DEFINE_VIRTIO_COMMON_FEATURES(_state, _field) \
224 DEFINE_PROP_BIT64("indirect_desc", _state, _field, \
225 VIRTIO_RING_F_INDIRECT_DESC, true), \
226 DEFINE_PROP_BIT64("event_idx", _state, _field, \
227 VIRTIO_RING_F_EVENT_IDX, true), \
228 DEFINE_PROP_BIT64("notify_on_empty", _state, _field, \
229 VIRTIO_F_NOTIFY_ON_EMPTY, true), \
230 DEFINE_PROP_BIT64("any_layout", _state, _field, \
231 VIRTIO_F_ANY_LAYOUT, true)
232
233hwaddr virtio_queue_get_desc_addr(VirtIODevice *vdev, int n);
234hwaddr virtio_queue_get_avail_addr(VirtIODevice *vdev, int n);
235hwaddr virtio_queue_get_used_addr(VirtIODevice *vdev, int n);
236hwaddr virtio_queue_get_ring_addr(VirtIODevice *vdev, int n);
237hwaddr virtio_queue_get_desc_size(VirtIODevice *vdev, int n);
238hwaddr virtio_queue_get_avail_size(VirtIODevice *vdev, int n);
239hwaddr virtio_queue_get_used_size(VirtIODevice *vdev, int n);
240hwaddr virtio_queue_get_ring_size(VirtIODevice *vdev, int n);
241uint16_t virtio_queue_get_last_avail_idx(VirtIODevice *vdev, int n);
242void virtio_queue_set_last_avail_idx(VirtIODevice *vdev, int n, uint16_t idx);
243void virtio_queue_invalidate_signalled_used(VirtIODevice *vdev, int n);
244VirtQueue *virtio_get_queue(VirtIODevice *vdev, int n);
245uint16_t virtio_get_queue_index(VirtQueue *vq);
246int virtio_queue_get_id(VirtQueue *vq);
247EventNotifier *virtio_queue_get_guest_notifier(VirtQueue *vq);
248void virtio_queue_set_guest_notifier_fd_handler(VirtQueue *vq, bool assign,
249 bool with_irqfd);
250EventNotifier *virtio_queue_get_host_notifier(VirtQueue *vq);
251void virtio_queue_set_host_notifier_fd_handler(VirtQueue *vq, bool assign,
252 bool set_handler);
253void virtio_queue_aio_set_host_notifier_handler(VirtQueue *vq, AioContext *ctx,
254 void (*fn)(VirtIODevice *,
255 VirtQueue *));
256void virtio_irq(VirtQueue *vq);
257VirtQueue *virtio_vector_first_queue(VirtIODevice *vdev, uint16_t vector);
258VirtQueue *virtio_vector_next_queue(VirtQueue *vq);
259
260static inline void virtio_add_feature(uint64_t *features, unsigned int fbit)
261{
262 assert(fbit < 64);
263 *features |= (1ULL << fbit);
264}
265
266static inline void virtio_clear_feature(uint64_t *features, unsigned int fbit)
267{
268 assert(fbit < 64);
269 *features &= ~(1ULL << fbit);
270}
271
272static inline bool virtio_has_feature(uint64_t features, unsigned int fbit)
273{
274 assert(fbit < 64);
275 return !!(features & (1ULL << fbit));
276}
277
278static inline bool virtio_vdev_has_feature(VirtIODevice *vdev,
279 unsigned int fbit)
280{
281 return virtio_has_feature(vdev->guest_features, fbit);
282}
283
284static inline bool virtio_host_has_feature(VirtIODevice *vdev,
285 unsigned int fbit)
286{
287 return virtio_has_feature(vdev->host_features, fbit);
288}
289
290static inline bool virtio_is_big_endian(VirtIODevice *vdev)
291{
292 if (!virtio_vdev_has_feature(vdev, VIRTIO_F_VERSION_1)) {
293 assert(vdev->device_endian != VIRTIO_DEVICE_ENDIAN_UNKNOWN);
294 return vdev->device_endian == VIRTIO_DEVICE_ENDIAN_BIG;
295 }
296
297 return false;
298}
299#endif
300