]>
Commit | Line | Data |
---|---|---|
967f97fa AL |
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 | ||
2a6a4076 MA |
14 | #ifndef QEMU_VIRTIO_H |
15 | #define QEMU_VIRTIO_H | |
967f97fa | 16 | |
83c9f4ca | 17 | #include "hw/hw.h" |
1422e32d | 18 | #include "net/net.h" |
83c9f4ca | 19 | #include "hw/qdev.h" |
9c17d615 | 20 | #include "sysemu/sysemu.h" |
1de7afc9 | 21 | #include "qemu/event_notifier.h" |
e9600c6c MT |
22 | #include "standard-headers/linux/virtio_config.h" |
23 | #include "standard-headers/linux/virtio_ring.h" | |
967f97fa | 24 | |
8eca6b1b AL |
25 | /* A guest should never accept this. It implies negotiation is broken. */ |
26 | #define VIRTIO_F_BAD_FEATURE 30 | |
967f97fa | 27 | |
5f456073 MT |
28 | #define VIRTIO_LEGACY_FEATURES ((0x1ULL << VIRTIO_F_BAD_FEATURE) | \ |
29 | (0x1ULL << VIRTIO_F_NOTIFY_ON_EMPTY) | \ | |
30 | (0x1ULL << VIRTIO_F_ANY_LAYOUT)) | |
31 | ||
967f97fa AL |
32 | struct VirtQueue; |
33 | ||
a8170e5e | 34 | static inline hwaddr vring_align(hwaddr addr, |
f46f15bc AL |
35 | unsigned long align) |
36 | { | |
b8adbc65 | 37 | return QEMU_ALIGN_UP(addr, align); |
f46f15bc AL |
38 | } |
39 | ||
ba550851 SG |
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 | ||
47 | typedef struct VirtIOFeature { | |
48 | uint64_t flags; | |
49 | size_t end; | |
50 | } VirtIOFeature; | |
51 | ||
52 | size_t virtio_feature_get_config_size(VirtIOFeature *features, | |
53 | uint64_t host_features); | |
54 | ||
967f97fa | 55 | typedef struct VirtQueue VirtQueue; |
967f97fa AL |
56 | |
57 | #define VIRTQUEUE_MAX_SIZE 1024 | |
58 | ||
59 | typedef struct VirtQueueElement | |
60 | { | |
61 | unsigned int index; | |
62 | unsigned int out_num; | |
63 | unsigned int in_num; | |
3724650d PB |
64 | hwaddr *in_addr; |
65 | hwaddr *out_addr; | |
66 | struct iovec *in_sg; | |
67 | struct iovec *out_sg; | |
967f97fa AL |
68 | } VirtQueueElement; |
69 | ||
b829c2a9 | 70 | #define VIRTIO_QUEUE_MAX 1024 |
967f97fa | 71 | |
7055e687 MT |
72 | #define VIRTIO_NO_VECTOR 0xffff |
73 | ||
8e05db92 FK |
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 | ||
616a6552 GK |
82 | enum virtio_device_endian { |
83 | VIRTIO_DEVICE_ENDIAN_UNKNOWN, | |
84 | VIRTIO_DEVICE_ENDIAN_LITTLE, | |
85 | VIRTIO_DEVICE_ENDIAN_BIG, | |
86 | }; | |
87 | ||
967f97fa AL |
88 | struct VirtIODevice |
89 | { | |
8e05db92 | 90 | DeviceState parent_obj; |
967f97fa | 91 | const char *name; |
967f97fa AL |
92 | uint8_t status; |
93 | uint8_t isr; | |
94 | uint16_t queue_sel; | |
019a3edb GH |
95 | uint64_t guest_features; |
96 | uint64_t host_features; | |
75ebec11 | 97 | uint64_t backend_features; |
967f97fa AL |
98 | size_t config_len; |
99 | void *config; | |
7055e687 | 100 | uint16_t config_vector; |
b8f05908 | 101 | uint32_t generation; |
7055e687 | 102 | int nvectors; |
967f97fa | 103 | VirtQueue *vq; |
c611c764 | 104 | MemoryListener listener; |
53c25cea | 105 | uint16_t device_id; |
85cf2a8d | 106 | bool vm_running; |
f5ed3663 | 107 | bool broken; /* device in invalid state, needs reset */ |
e57f2c31 | 108 | bool use_started; |
badaf79c XY |
109 | bool started; |
110 | bool start_on_kick; /* virtio 1.0 transitional devices support that */ | |
85cf2a8d | 111 | VMChangeStateEntry *vmstate; |
1034e9cf | 112 | char *bus_name; |
616a6552 | 113 | uint8_t device_endian; |
5669655a | 114 | bool use_guest_notifier_mask; |
8607f5c3 | 115 | AddressSpace *dma_as; |
850d0070 | 116 | QLIST_HEAD(, VirtQueue) *vector_queues; |
967f97fa AL |
117 | }; |
118 | ||
8e05db92 | 119 | typedef struct VirtioDeviceClass { |
0ba94b6f | 120 | /*< private >*/ |
8e05db92 | 121 | DeviceClass parent; |
0ba94b6f | 122 | /*< public >*/ |
1d244b42 AF |
123 | |
124 | /* This is what a VirtioDevice must implement */ | |
1d244b42 | 125 | DeviceRealize realize; |
306ec6c3 | 126 | DeviceUnrealize unrealize; |
9d5b731d JW |
127 | uint64_t (*get_features)(VirtIODevice *vdev, |
128 | uint64_t requested_features, | |
129 | Error **errp); | |
019a3edb | 130 | uint64_t (*bad_features)(VirtIODevice *vdev); |
d5aaa1b0 | 131 | void (*set_features)(VirtIODevice *vdev, uint64_t val); |
0b352fd6 | 132 | int (*validate_features)(VirtIODevice *vdev); |
8e05db92 FK |
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); | |
9b706dbb MT |
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; | |
6a87acf7 FK |
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); | |
ff4c07df PB |
154 | int (*start_ioeventfd)(VirtIODevice *vdev); |
155 | void (*stop_ioeventfd)(VirtIODevice *vdev); | |
ea43e259 DDAG |
156 | /* Saving and loading of a device; trying to deprecate save/load |
157 | * use vmsd for new devices. | |
158 | */ | |
1b5fc0de GK |
159 | void (*save)(VirtIODevice *vdev, QEMUFile *f); |
160 | int (*load)(VirtIODevice *vdev, QEMUFile *f, int version_id); | |
ea43e259 | 161 | const VMStateDescription *vmsd; |
8e05db92 FK |
162 | } VirtioDeviceClass; |
163 | ||
c8075caf GA |
164 | void virtio_instance_init_common(Object *proxy_obj, void *data, |
165 | size_t vdev_size, const char *vdev_name); | |
166 | ||
8e05db92 FK |
167 | void virtio_init(VirtIODevice *vdev, const char *name, |
168 | uint16_t device_id, size_t config_size); | |
6a1a8cc7 | 169 | void virtio_cleanup(VirtIODevice *vdev); |
8e05db92 | 170 | |
f5ed3663 SH |
171 | void virtio_error(VirtIODevice *vdev, const char *fmt, ...) GCC_FMT_ATTR(2, 3); |
172 | ||
1034e9cf FK |
173 | /* Set the child bus name. */ |
174 | void virtio_device_set_child_bus_name(VirtIODevice *vdev, char *bus_name); | |
175 | ||
bf1780b0 | 176 | typedef void (*VirtIOHandleOutput)(VirtIODevice *, VirtQueue *); |
07931698 | 177 | typedef bool (*VirtIOHandleAIOOutput)(VirtIODevice *, VirtQueue *); |
bf1780b0 | 178 | |
967f97fa | 179 | VirtQueue *virtio_add_queue(VirtIODevice *vdev, int queue_size, |
bf1780b0 | 180 | VirtIOHandleOutput handle_output); |
967f97fa | 181 | |
f23fd811 JW |
182 | void virtio_del_queue(VirtIODevice *vdev, int n); |
183 | ||
967f97fa AL |
184 | void virtqueue_push(VirtQueue *vq, const VirtQueueElement *elem, |
185 | unsigned int len); | |
186 | void virtqueue_flush(VirtQueue *vq, unsigned int count); | |
2640d2a5 SH |
187 | void virtqueue_detach_element(VirtQueue *vq, const VirtQueueElement *elem, |
188 | unsigned int len); | |
27e57efe LP |
189 | void virtqueue_unpop(VirtQueue *vq, const VirtQueueElement *elem, |
190 | unsigned int len); | |
297a75e6 | 191 | bool virtqueue_rewind(VirtQueue *vq, unsigned int num); |
967f97fa AL |
192 | void virtqueue_fill(VirtQueue *vq, const VirtQueueElement *elem, |
193 | unsigned int len, unsigned int idx); | |
194 | ||
8607f5c3 | 195 | void virtqueue_map(VirtIODevice *vdev, VirtQueueElement *elem); |
51b19ebe | 196 | void *virtqueue_pop(VirtQueue *vq, size_t sz); |
54e17709 | 197 | unsigned int virtqueue_drop_all(VirtQueue *vq); |
8607f5c3 | 198 | void *qemu_get_virtqueue_element(VirtIODevice *vdev, QEMUFile *f, size_t sz); |
ab281c17 | 199 | void qemu_put_virtqueue_element(QEMUFile *f, VirtQueueElement *elem); |
0d8d7690 AS |
200 | int virtqueue_avail_bytes(VirtQueue *vq, unsigned int in_bytes, |
201 | unsigned int out_bytes); | |
202 | void virtqueue_get_avail_bytes(VirtQueue *vq, unsigned int *in_bytes, | |
e1f7b481 MT |
203 | unsigned int *out_bytes, |
204 | unsigned max_in_bytes, unsigned max_out_bytes); | |
967f97fa | 205 | |
83d768b5 | 206 | void virtio_notify_irqfd(VirtIODevice *vdev, VirtQueue *vq); |
967f97fa AL |
207 | void virtio_notify(VirtIODevice *vdev, VirtQueue *vq); |
208 | ||
2f168d07 | 209 | int virtio_save(VirtIODevice *vdev, QEMUFile *f); |
5943124c | 210 | |
1a665855 HP |
211 | extern const VMStateInfo virtio_vmstate_info; |
212 | ||
1a665855 HP |
213 | #define VMSTATE_VIRTIO_DEVICE \ |
214 | { \ | |
215 | .name = "virtio", \ | |
216 | .info = &virtio_vmstate_info, \ | |
217 | .flags = VMS_SINGLE, \ | |
218 | } | |
219 | ||
1b5fc0de | 220 | int virtio_load(VirtIODevice *vdev, QEMUFile *f, int version_id); |
967f97fa AL |
221 | |
222 | void virtio_notify_config(VirtIODevice *vdev); | |
223 | ||
224 | void virtio_queue_set_notification(VirtQueue *vq, int enable); | |
225 | ||
226 | int virtio_queue_ready(VirtQueue *vq); | |
227 | ||
228 | int virtio_queue_empty(VirtQueue *vq); | |
229 | ||
53c25cea PB |
230 | /* Host binding interface. */ |
231 | ||
53c25cea PB |
232 | uint32_t virtio_config_readb(VirtIODevice *vdev, uint32_t addr); |
233 | uint32_t virtio_config_readw(VirtIODevice *vdev, uint32_t addr); | |
234 | uint32_t virtio_config_readl(VirtIODevice *vdev, uint32_t addr); | |
235 | void virtio_config_writeb(VirtIODevice *vdev, uint32_t addr, uint32_t data); | |
236 | void virtio_config_writew(VirtIODevice *vdev, uint32_t addr, uint32_t data); | |
237 | void virtio_config_writel(VirtIODevice *vdev, uint32_t addr, uint32_t data); | |
adfb743c MT |
238 | uint32_t virtio_config_modern_readb(VirtIODevice *vdev, uint32_t addr); |
239 | uint32_t virtio_config_modern_readw(VirtIODevice *vdev, uint32_t addr); | |
240 | uint32_t virtio_config_modern_readl(VirtIODevice *vdev, uint32_t addr); | |
241 | void virtio_config_modern_writeb(VirtIODevice *vdev, | |
242 | uint32_t addr, uint32_t data); | |
243 | void virtio_config_modern_writew(VirtIODevice *vdev, | |
244 | uint32_t addr, uint32_t data); | |
245 | void virtio_config_modern_writel(VirtIODevice *vdev, | |
246 | uint32_t addr, uint32_t data); | |
a8170e5e AK |
247 | void virtio_queue_set_addr(VirtIODevice *vdev, int n, hwaddr addr); |
248 | hwaddr virtio_queue_get_addr(VirtIODevice *vdev, int n); | |
e63c0ba1 | 249 | void virtio_queue_set_num(VirtIODevice *vdev, int n, int num); |
53c25cea | 250 | int virtio_queue_get_num(VirtIODevice *vdev, int n); |
8c797e75 | 251 | int virtio_queue_get_max_num(VirtIODevice *vdev, int n); |
8ad176aa | 252 | int virtio_get_num_queues(VirtIODevice *vdev); |
ab223c95 CH |
253 | void virtio_queue_set_rings(VirtIODevice *vdev, int n, hwaddr desc, |
254 | hwaddr avail, hwaddr used); | |
255 | void virtio_queue_update_rings(VirtIODevice *vdev, int n); | |
6ce69d1c | 256 | void virtio_queue_set_align(VirtIODevice *vdev, int n, int align); |
53c25cea | 257 | void virtio_queue_notify(VirtIODevice *vdev, int n); |
7055e687 MT |
258 | uint16_t virtio_queue_vector(VirtIODevice *vdev, int n); |
259 | void virtio_queue_set_vector(VirtIODevice *vdev, int n, uint16_t vector); | |
6f80e617 TB |
260 | int virtio_queue_set_host_notifier_mr(VirtIODevice *vdev, int n, |
261 | MemoryRegion *mr, bool assign); | |
0b352fd6 | 262 | int virtio_set_status(VirtIODevice *vdev, uint8_t val); |
53c25cea PB |
263 | void virtio_reset(void *opaque); |
264 | void virtio_update_irq(VirtIODevice *vdev); | |
d5aaa1b0 | 265 | int virtio_set_features(VirtIODevice *vdev, uint64_t val); |
53c25cea | 266 | |
53c25cea | 267 | /* Base devices. */ |
12c5674b | 268 | typedef struct VirtIOBlkConf VirtIOBlkConf; |
f0c07c7c | 269 | struct virtio_net_conf; |
6b331efb | 270 | typedef struct virtio_serial_conf virtio_serial_conf; |
f73ddbad | 271 | typedef struct virtio_input_conf virtio_input_conf; |
973abc7f | 272 | typedef struct VirtIOSCSIConf VirtIOSCSIConf; |
16c915ba | 273 | typedef struct VirtIORNGConf VirtIORNGConf; |
97b15621 | 274 | |
8172539d | 275 | #define DEFINE_VIRTIO_COMMON_FEATURES(_state, _field) \ |
019a3edb GH |
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, \ | |
09999a5f MT |
281 | VIRTIO_F_NOTIFY_ON_EMPTY, true), \ |
282 | DEFINE_PROP_BIT64("any_layout", _state, _field, \ | |
8607f5c3 JW |
283 | VIRTIO_F_ANY_LAYOUT, true), \ |
284 | DEFINE_PROP_BIT64("iommu_platform", _state, _field, \ | |
285 | VIRTIO_F_IOMMU_PLATFORM, false) | |
8172539d | 286 | |
a8170e5e | 287 | hwaddr virtio_queue_get_desc_addr(VirtIODevice *vdev, int n); |
23bfaf77 | 288 | bool virtio_queue_enabled(VirtIODevice *vdev, int n); |
a8170e5e AK |
289 | hwaddr virtio_queue_get_avail_addr(VirtIODevice *vdev, int n); |
290 | hwaddr virtio_queue_get_used_addr(VirtIODevice *vdev, int n); | |
a8170e5e AK |
291 | hwaddr virtio_queue_get_desc_size(VirtIODevice *vdev, int n); |
292 | hwaddr virtio_queue_get_avail_size(VirtIODevice *vdev, int n); | |
293 | hwaddr virtio_queue_get_used_size(VirtIODevice *vdev, int n); | |
1cbdabe2 MT |
294 | uint16_t virtio_queue_get_last_avail_idx(VirtIODevice *vdev, int n); |
295 | void virtio_queue_set_last_avail_idx(VirtIODevice *vdev, int n, uint16_t idx); | |
2d4ba6cc | 296 | void virtio_queue_restore_last_avail_idx(VirtIODevice *vdev, int n); |
6793dfd1 | 297 | void virtio_queue_invalidate_signalled_used(VirtIODevice *vdev, int n); |
312d3b35 | 298 | void virtio_queue_update_used_idx(VirtIODevice *vdev, int n); |
1cbdabe2 | 299 | VirtQueue *virtio_get_queue(VirtIODevice *vdev, int n); |
e78a2b42 | 300 | uint16_t virtio_get_queue_index(VirtQueue *vq); |
1cbdabe2 | 301 | EventNotifier *virtio_queue_get_guest_notifier(VirtQueue *vq); |
15b2bd18 PB |
302 | void virtio_queue_set_guest_notifier_fd_handler(VirtQueue *vq, bool assign, |
303 | bool with_irqfd); | |
ff4c07df PB |
304 | int virtio_device_start_ioeventfd(VirtIODevice *vdev); |
305 | void virtio_device_stop_ioeventfd(VirtIODevice *vdev); | |
310837de PB |
306 | int virtio_device_grab_ioeventfd(VirtIODevice *vdev); |
307 | void virtio_device_release_ioeventfd(VirtIODevice *vdev); | |
8e93cef1 | 308 | bool virtio_device_ioeventfd_enabled(VirtIODevice *vdev); |
1cbdabe2 | 309 | EventNotifier *virtio_queue_get_host_notifier(VirtQueue *vq); |
fa283a4a | 310 | void virtio_queue_host_notifier_read(EventNotifier *n); |
a1afb606 | 311 | void virtio_queue_aio_set_host_notifier_handler(VirtQueue *vq, AioContext *ctx, |
07931698 | 312 | VirtIOHandleAIOOutput handle_output); |
e0d686bf JW |
313 | VirtQueue *virtio_vector_first_queue(VirtIODevice *vdev, uint16_t vector); |
314 | VirtQueue *virtio_vector_next_queue(VirtQueue *vq); | |
98ed8ecf | 315 | |
019a3edb | 316 | static inline void virtio_add_feature(uint64_t *features, unsigned int fbit) |
0cd09c3a | 317 | { |
019a3edb | 318 | assert(fbit < 64); |
d5aaa1b0 | 319 | *features |= (1ULL << fbit); |
0cd09c3a CH |
320 | } |
321 | ||
019a3edb | 322 | static inline void virtio_clear_feature(uint64_t *features, unsigned int fbit) |
0cd09c3a | 323 | { |
019a3edb | 324 | assert(fbit < 64); |
d5aaa1b0 | 325 | *features &= ~(1ULL << fbit); |
0cd09c3a CH |
326 | } |
327 | ||
95129d6f | 328 | static inline bool virtio_has_feature(uint64_t features, unsigned int fbit) |
ef546f12 | 329 | { |
019a3edb | 330 | assert(fbit < 64); |
d5aaa1b0 | 331 | return !!(features & (1ULL << fbit)); |
ef546f12 CH |
332 | } |
333 | ||
95129d6f CH |
334 | static inline bool virtio_vdev_has_feature(VirtIODevice *vdev, |
335 | unsigned int fbit) | |
ef546f12 | 336 | { |
95129d6f | 337 | return virtio_has_feature(vdev->guest_features, fbit); |
ef546f12 CH |
338 | } |
339 | ||
74aae7b2 JW |
340 | static inline bool virtio_host_has_feature(VirtIODevice *vdev, |
341 | unsigned int fbit) | |
342 | { | |
95129d6f | 343 | return virtio_has_feature(vdev->host_features, fbit); |
74aae7b2 JW |
344 | } |
345 | ||
616a6552 | 346 | static inline bool virtio_is_big_endian(VirtIODevice *vdev) |
98ed8ecf | 347 | { |
95129d6f | 348 | if (!virtio_vdev_has_feature(vdev, VIRTIO_F_VERSION_1)) { |
3c185597 CH |
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; | |
98ed8ecf | 354 | } |
e57f2c31 XY |
355 | |
356 | static 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 | ||
365 | static 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 | } | |
967f97fa | 375 | #endif |