]>
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 | ||
967f97fa | 40 | typedef struct VirtQueue VirtQueue; |
967f97fa AL |
41 | |
42 | #define VIRTQUEUE_MAX_SIZE 1024 | |
43 | ||
44 | typedef struct VirtQueueElement | |
45 | { | |
46 | unsigned int index; | |
47 | unsigned int out_num; | |
48 | unsigned int in_num; | |
3724650d PB |
49 | hwaddr *in_addr; |
50 | hwaddr *out_addr; | |
51 | struct iovec *in_sg; | |
52 | struct iovec *out_sg; | |
967f97fa AL |
53 | } VirtQueueElement; |
54 | ||
b829c2a9 | 55 | #define VIRTIO_QUEUE_MAX 1024 |
967f97fa | 56 | |
7055e687 MT |
57 | #define VIRTIO_NO_VECTOR 0xffff |
58 | ||
8e05db92 FK |
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 | ||
616a6552 GK |
67 | enum virtio_device_endian { |
68 | VIRTIO_DEVICE_ENDIAN_UNKNOWN, | |
69 | VIRTIO_DEVICE_ENDIAN_LITTLE, | |
70 | VIRTIO_DEVICE_ENDIAN_BIG, | |
71 | }; | |
72 | ||
967f97fa AL |
73 | struct VirtIODevice |
74 | { | |
8e05db92 | 75 | DeviceState parent_obj; |
967f97fa | 76 | const char *name; |
967f97fa AL |
77 | uint8_t status; |
78 | uint8_t isr; | |
79 | uint16_t queue_sel; | |
019a3edb GH |
80 | uint64_t guest_features; |
81 | uint64_t host_features; | |
967f97fa AL |
82 | size_t config_len; |
83 | void *config; | |
7055e687 | 84 | uint16_t config_vector; |
b8f05908 | 85 | uint32_t generation; |
7055e687 | 86 | int nvectors; |
967f97fa | 87 | VirtQueue *vq; |
c611c764 | 88 | MemoryListener listener; |
53c25cea | 89 | uint16_t device_id; |
85cf2a8d | 90 | bool vm_running; |
f5ed3663 | 91 | bool broken; /* device in invalid state, needs reset */ |
85cf2a8d | 92 | VMChangeStateEntry *vmstate; |
1034e9cf | 93 | char *bus_name; |
616a6552 | 94 | uint8_t device_endian; |
5669655a | 95 | bool use_guest_notifier_mask; |
8607f5c3 | 96 | AddressSpace *dma_as; |
850d0070 | 97 | QLIST_HEAD(, VirtQueue) *vector_queues; |
967f97fa AL |
98 | }; |
99 | ||
8e05db92 | 100 | typedef struct VirtioDeviceClass { |
0ba94b6f | 101 | /*< private >*/ |
8e05db92 | 102 | DeviceClass parent; |
0ba94b6f | 103 | /*< public >*/ |
1d244b42 AF |
104 | |
105 | /* This is what a VirtioDevice must implement */ | |
1d244b42 | 106 | DeviceRealize realize; |
306ec6c3 | 107 | DeviceUnrealize unrealize; |
9d5b731d JW |
108 | uint64_t (*get_features)(VirtIODevice *vdev, |
109 | uint64_t requested_features, | |
110 | Error **errp); | |
019a3edb | 111 | uint64_t (*bad_features)(VirtIODevice *vdev); |
d5aaa1b0 | 112 | void (*set_features)(VirtIODevice *vdev, uint64_t val); |
0b352fd6 | 113 | int (*validate_features)(VirtIODevice *vdev); |
8e05db92 FK |
114 | void (*get_config)(VirtIODevice *vdev, uint8_t *config); |
115 | void (*set_config)(VirtIODevice *vdev, const uint8_t *config); | |
116 | void (*reset)(VirtIODevice *vdev); | |
117 | void (*set_status)(VirtIODevice *vdev, uint8_t val); | |
9b706dbb MT |
118 | /* For transitional devices, this is a bitmap of features |
119 | * that are only exposed on the legacy interface but not | |
120 | * the modern one. | |
121 | */ | |
122 | uint64_t legacy_features; | |
6a87acf7 FK |
123 | /* Test and clear event pending status. |
124 | * Should be called after unmask to avoid losing events. | |
125 | * If backend does not support masking, | |
126 | * must check in frontend instead. | |
127 | */ | |
128 | bool (*guest_notifier_pending)(VirtIODevice *vdev, int n); | |
129 | /* Mask/unmask events from this vq. Any events reported | |
130 | * while masked will become pending. | |
131 | * If backend does not support masking, | |
132 | * must mask in frontend instead. | |
133 | */ | |
134 | void (*guest_notifier_mask)(VirtIODevice *vdev, int n, bool mask); | |
ff4c07df PB |
135 | int (*start_ioeventfd)(VirtIODevice *vdev); |
136 | void (*stop_ioeventfd)(VirtIODevice *vdev); | |
ea43e259 DDAG |
137 | /* Saving and loading of a device; trying to deprecate save/load |
138 | * use vmsd for new devices. | |
139 | */ | |
1b5fc0de GK |
140 | void (*save)(VirtIODevice *vdev, QEMUFile *f); |
141 | int (*load)(VirtIODevice *vdev, QEMUFile *f, int version_id); | |
ea43e259 | 142 | const VMStateDescription *vmsd; |
8e05db92 FK |
143 | } VirtioDeviceClass; |
144 | ||
c8075caf GA |
145 | void virtio_instance_init_common(Object *proxy_obj, void *data, |
146 | size_t vdev_size, const char *vdev_name); | |
147 | ||
8e05db92 FK |
148 | void virtio_init(VirtIODevice *vdev, const char *name, |
149 | uint16_t device_id, size_t config_size); | |
6a1a8cc7 | 150 | void virtio_cleanup(VirtIODevice *vdev); |
8e05db92 | 151 | |
f5ed3663 SH |
152 | void virtio_error(VirtIODevice *vdev, const char *fmt, ...) GCC_FMT_ATTR(2, 3); |
153 | ||
1034e9cf FK |
154 | /* Set the child bus name. */ |
155 | void virtio_device_set_child_bus_name(VirtIODevice *vdev, char *bus_name); | |
156 | ||
bf1780b0 | 157 | typedef void (*VirtIOHandleOutput)(VirtIODevice *, VirtQueue *); |
07931698 | 158 | typedef bool (*VirtIOHandleAIOOutput)(VirtIODevice *, VirtQueue *); |
bf1780b0 | 159 | |
967f97fa | 160 | VirtQueue *virtio_add_queue(VirtIODevice *vdev, int queue_size, |
bf1780b0 | 161 | VirtIOHandleOutput handle_output); |
967f97fa | 162 | |
f23fd811 JW |
163 | void virtio_del_queue(VirtIODevice *vdev, int n); |
164 | ||
967f97fa AL |
165 | void virtqueue_push(VirtQueue *vq, const VirtQueueElement *elem, |
166 | unsigned int len); | |
167 | void virtqueue_flush(VirtQueue *vq, unsigned int count); | |
2640d2a5 SH |
168 | void virtqueue_detach_element(VirtQueue *vq, const VirtQueueElement *elem, |
169 | unsigned int len); | |
27e57efe LP |
170 | void virtqueue_unpop(VirtQueue *vq, const VirtQueueElement *elem, |
171 | unsigned int len); | |
297a75e6 | 172 | bool virtqueue_rewind(VirtQueue *vq, unsigned int num); |
967f97fa AL |
173 | void virtqueue_fill(VirtQueue *vq, const VirtQueueElement *elem, |
174 | unsigned int len, unsigned int idx); | |
175 | ||
8607f5c3 | 176 | void virtqueue_map(VirtIODevice *vdev, VirtQueueElement *elem); |
51b19ebe | 177 | void *virtqueue_pop(VirtQueue *vq, size_t sz); |
54e17709 | 178 | unsigned int virtqueue_drop_all(VirtQueue *vq); |
8607f5c3 | 179 | void *qemu_get_virtqueue_element(VirtIODevice *vdev, QEMUFile *f, size_t sz); |
ab281c17 | 180 | void qemu_put_virtqueue_element(QEMUFile *f, VirtQueueElement *elem); |
0d8d7690 AS |
181 | int virtqueue_avail_bytes(VirtQueue *vq, unsigned int in_bytes, |
182 | unsigned int out_bytes); | |
183 | void virtqueue_get_avail_bytes(VirtQueue *vq, unsigned int *in_bytes, | |
e1f7b481 MT |
184 | unsigned int *out_bytes, |
185 | unsigned max_in_bytes, unsigned max_out_bytes); | |
967f97fa | 186 | |
83d768b5 | 187 | void virtio_notify_irqfd(VirtIODevice *vdev, VirtQueue *vq); |
967f97fa AL |
188 | void virtio_notify(VirtIODevice *vdev, VirtQueue *vq); |
189 | ||
190 | void virtio_save(VirtIODevice *vdev, QEMUFile *f); | |
5943124c | 191 | |
1a665855 HP |
192 | extern const VMStateInfo virtio_vmstate_info; |
193 | ||
1a665855 HP |
194 | #define VMSTATE_VIRTIO_DEVICE \ |
195 | { \ | |
196 | .name = "virtio", \ | |
197 | .info = &virtio_vmstate_info, \ | |
198 | .flags = VMS_SINGLE, \ | |
199 | } | |
200 | ||
1b5fc0de | 201 | int virtio_load(VirtIODevice *vdev, QEMUFile *f, int version_id); |
967f97fa AL |
202 | |
203 | void virtio_notify_config(VirtIODevice *vdev); | |
204 | ||
205 | void virtio_queue_set_notification(VirtQueue *vq, int enable); | |
206 | ||
207 | int virtio_queue_ready(VirtQueue *vq); | |
208 | ||
209 | int virtio_queue_empty(VirtQueue *vq); | |
210 | ||
53c25cea PB |
211 | /* Host binding interface. */ |
212 | ||
53c25cea PB |
213 | uint32_t virtio_config_readb(VirtIODevice *vdev, uint32_t addr); |
214 | uint32_t virtio_config_readw(VirtIODevice *vdev, uint32_t addr); | |
215 | uint32_t virtio_config_readl(VirtIODevice *vdev, uint32_t addr); | |
216 | void virtio_config_writeb(VirtIODevice *vdev, uint32_t addr, uint32_t data); | |
217 | void virtio_config_writew(VirtIODevice *vdev, uint32_t addr, uint32_t data); | |
218 | void virtio_config_writel(VirtIODevice *vdev, uint32_t addr, uint32_t data); | |
adfb743c MT |
219 | uint32_t virtio_config_modern_readb(VirtIODevice *vdev, uint32_t addr); |
220 | uint32_t virtio_config_modern_readw(VirtIODevice *vdev, uint32_t addr); | |
221 | uint32_t virtio_config_modern_readl(VirtIODevice *vdev, uint32_t addr); | |
222 | void virtio_config_modern_writeb(VirtIODevice *vdev, | |
223 | uint32_t addr, uint32_t data); | |
224 | void virtio_config_modern_writew(VirtIODevice *vdev, | |
225 | uint32_t addr, uint32_t data); | |
226 | void virtio_config_modern_writel(VirtIODevice *vdev, | |
227 | uint32_t addr, uint32_t data); | |
a8170e5e AK |
228 | void virtio_queue_set_addr(VirtIODevice *vdev, int n, hwaddr addr); |
229 | hwaddr virtio_queue_get_addr(VirtIODevice *vdev, int n); | |
e63c0ba1 | 230 | void virtio_queue_set_num(VirtIODevice *vdev, int n, int num); |
53c25cea | 231 | int virtio_queue_get_num(VirtIODevice *vdev, int n); |
8c797e75 | 232 | int virtio_queue_get_max_num(VirtIODevice *vdev, int n); |
8ad176aa | 233 | int virtio_get_num_queues(VirtIODevice *vdev); |
ab223c95 CH |
234 | void virtio_queue_set_rings(VirtIODevice *vdev, int n, hwaddr desc, |
235 | hwaddr avail, hwaddr used); | |
236 | void virtio_queue_update_rings(VirtIODevice *vdev, int n); | |
6ce69d1c | 237 | void virtio_queue_set_align(VirtIODevice *vdev, int n, int align); |
53c25cea | 238 | void virtio_queue_notify(VirtIODevice *vdev, int n); |
7055e687 MT |
239 | uint16_t virtio_queue_vector(VirtIODevice *vdev, int n); |
240 | void virtio_queue_set_vector(VirtIODevice *vdev, int n, uint16_t vector); | |
0b352fd6 | 241 | int virtio_set_status(VirtIODevice *vdev, uint8_t val); |
53c25cea PB |
242 | void virtio_reset(void *opaque); |
243 | void virtio_update_irq(VirtIODevice *vdev); | |
d5aaa1b0 | 244 | int virtio_set_features(VirtIODevice *vdev, uint64_t val); |
53c25cea | 245 | |
53c25cea | 246 | /* Base devices. */ |
12c5674b | 247 | typedef struct VirtIOBlkConf VirtIOBlkConf; |
f0c07c7c | 248 | struct virtio_net_conf; |
6b331efb | 249 | typedef struct virtio_serial_conf virtio_serial_conf; |
f73ddbad | 250 | typedef struct virtio_input_conf virtio_input_conf; |
973abc7f | 251 | typedef struct VirtIOSCSIConf VirtIOSCSIConf; |
16c915ba | 252 | typedef struct VirtIORNGConf VirtIORNGConf; |
97b15621 | 253 | |
8172539d | 254 | #define DEFINE_VIRTIO_COMMON_FEATURES(_state, _field) \ |
019a3edb GH |
255 | DEFINE_PROP_BIT64("indirect_desc", _state, _field, \ |
256 | VIRTIO_RING_F_INDIRECT_DESC, true), \ | |
257 | DEFINE_PROP_BIT64("event_idx", _state, _field, \ | |
258 | VIRTIO_RING_F_EVENT_IDX, true), \ | |
259 | DEFINE_PROP_BIT64("notify_on_empty", _state, _field, \ | |
09999a5f MT |
260 | VIRTIO_F_NOTIFY_ON_EMPTY, true), \ |
261 | DEFINE_PROP_BIT64("any_layout", _state, _field, \ | |
8607f5c3 JW |
262 | VIRTIO_F_ANY_LAYOUT, true), \ |
263 | DEFINE_PROP_BIT64("iommu_platform", _state, _field, \ | |
264 | VIRTIO_F_IOMMU_PLATFORM, false) | |
8172539d | 265 | |
a8170e5e AK |
266 | hwaddr virtio_queue_get_desc_addr(VirtIODevice *vdev, int n); |
267 | hwaddr virtio_queue_get_avail_addr(VirtIODevice *vdev, int n); | |
268 | hwaddr virtio_queue_get_used_addr(VirtIODevice *vdev, int n); | |
a8170e5e AK |
269 | hwaddr virtio_queue_get_desc_size(VirtIODevice *vdev, int n); |
270 | hwaddr virtio_queue_get_avail_size(VirtIODevice *vdev, int n); | |
271 | hwaddr virtio_queue_get_used_size(VirtIODevice *vdev, int n); | |
1cbdabe2 MT |
272 | uint16_t virtio_queue_get_last_avail_idx(VirtIODevice *vdev, int n); |
273 | void virtio_queue_set_last_avail_idx(VirtIODevice *vdev, int n, uint16_t idx); | |
6793dfd1 | 274 | void virtio_queue_invalidate_signalled_used(VirtIODevice *vdev, int n); |
312d3b35 | 275 | void virtio_queue_update_used_idx(VirtIODevice *vdev, int n); |
1cbdabe2 | 276 | VirtQueue *virtio_get_queue(VirtIODevice *vdev, int n); |
e78a2b42 | 277 | uint16_t virtio_get_queue_index(VirtQueue *vq); |
1cbdabe2 | 278 | EventNotifier *virtio_queue_get_guest_notifier(VirtQueue *vq); |
15b2bd18 PB |
279 | void virtio_queue_set_guest_notifier_fd_handler(VirtQueue *vq, bool assign, |
280 | bool with_irqfd); | |
ff4c07df PB |
281 | int virtio_device_start_ioeventfd(VirtIODevice *vdev); |
282 | void virtio_device_stop_ioeventfd(VirtIODevice *vdev); | |
310837de PB |
283 | int virtio_device_grab_ioeventfd(VirtIODevice *vdev); |
284 | void virtio_device_release_ioeventfd(VirtIODevice *vdev); | |
8e93cef1 | 285 | bool virtio_device_ioeventfd_enabled(VirtIODevice *vdev); |
1cbdabe2 | 286 | EventNotifier *virtio_queue_get_host_notifier(VirtQueue *vq); |
fa283a4a | 287 | void virtio_queue_host_notifier_read(EventNotifier *n); |
a1afb606 | 288 | void virtio_queue_aio_set_host_notifier_handler(VirtQueue *vq, AioContext *ctx, |
07931698 | 289 | VirtIOHandleAIOOutput handle_output); |
e0d686bf JW |
290 | VirtQueue *virtio_vector_first_queue(VirtIODevice *vdev, uint16_t vector); |
291 | VirtQueue *virtio_vector_next_queue(VirtQueue *vq); | |
98ed8ecf | 292 | |
019a3edb | 293 | static inline void virtio_add_feature(uint64_t *features, unsigned int fbit) |
0cd09c3a | 294 | { |
019a3edb | 295 | assert(fbit < 64); |
d5aaa1b0 | 296 | *features |= (1ULL << fbit); |
0cd09c3a CH |
297 | } |
298 | ||
019a3edb | 299 | static inline void virtio_clear_feature(uint64_t *features, unsigned int fbit) |
0cd09c3a | 300 | { |
019a3edb | 301 | assert(fbit < 64); |
d5aaa1b0 | 302 | *features &= ~(1ULL << fbit); |
0cd09c3a CH |
303 | } |
304 | ||
95129d6f | 305 | static inline bool virtio_has_feature(uint64_t features, unsigned int fbit) |
ef546f12 | 306 | { |
019a3edb | 307 | assert(fbit < 64); |
d5aaa1b0 | 308 | return !!(features & (1ULL << fbit)); |
ef546f12 CH |
309 | } |
310 | ||
95129d6f CH |
311 | static inline bool virtio_vdev_has_feature(VirtIODevice *vdev, |
312 | unsigned int fbit) | |
ef546f12 | 313 | { |
95129d6f | 314 | return virtio_has_feature(vdev->guest_features, fbit); |
ef546f12 CH |
315 | } |
316 | ||
74aae7b2 JW |
317 | static inline bool virtio_host_has_feature(VirtIODevice *vdev, |
318 | unsigned int fbit) | |
319 | { | |
95129d6f | 320 | return virtio_has_feature(vdev->host_features, fbit); |
74aae7b2 JW |
321 | } |
322 | ||
616a6552 | 323 | static inline bool virtio_is_big_endian(VirtIODevice *vdev) |
98ed8ecf | 324 | { |
95129d6f | 325 | if (!virtio_vdev_has_feature(vdev, VIRTIO_F_VERSION_1)) { |
3c185597 CH |
326 | assert(vdev->device_endian != VIRTIO_DEVICE_ENDIAN_UNKNOWN); |
327 | return vdev->device_endian == VIRTIO_DEVICE_ENDIAN_BIG; | |
328 | } | |
329 | /* Devices conforming to VIRTIO 1.0 or later are always LE. */ | |
330 | return false; | |
98ed8ecf | 331 | } |
967f97fa | 332 | #endif |