4 * Copyright IBM, Corp. 2007
7 * Anthony Liguori <aliguori@us.ibm.com>
9 * This work is licensed under the terms of the GNU GPL, version 2. See
10 * the COPYING file in the top-level directory.
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"
25 /* A guest should never accept this. It implies negotiation is broken. */
26 #define VIRTIO_F_BAD_FEATURE 30
28 #define VIRTIO_LEGACY_FEATURES ((0x1ULL << VIRTIO_F_BAD_FEATURE) | \
29 (0x1ULL << VIRTIO_F_NOTIFY_ON_EMPTY) | \
30 (0x1ULL << VIRTIO_F_ANY_LAYOUT))
34 static inline hwaddr
vring_align(hwaddr addr
,
37 return QEMU_ALIGN_UP(addr
, align
);
41 * Calculate the number of bytes up to and including the given 'field' of
44 #define virtio_endof(container, field) \
45 (offsetof(container, field) + sizeof_field(container, field))
47 typedef struct VirtIOFeature
{
52 size_t virtio_feature_get_config_size(VirtIOFeature
*features
,
53 uint64_t host_features
);
55 typedef struct VirtQueue VirtQueue
;
57 #define VIRTQUEUE_MAX_SIZE 1024
59 typedef struct VirtQueueElement
70 #define VIRTIO_QUEUE_MAX 1024
72 #define VIRTIO_NO_VECTOR 0xffff
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)
82 enum virtio_device_endian
{
83 VIRTIO_DEVICE_ENDIAN_UNKNOWN
,
84 VIRTIO_DEVICE_ENDIAN_LITTLE
,
85 VIRTIO_DEVICE_ENDIAN_BIG
,
90 DeviceState parent_obj
;
95 uint64_t guest_features
;
96 uint64_t host_features
;
97 uint64_t backend_features
;
100 uint16_t config_vector
;
104 MemoryListener listener
;
107 bool broken
; /* device in invalid state, needs reset */
110 bool start_on_kick
; /* when virtio 1.0 feature has not been negotiated */
111 VMChangeStateEntry
*vmstate
;
113 uint8_t device_endian
;
114 bool use_guest_notifier_mask
;
115 AddressSpace
*dma_as
;
116 QLIST_HEAD(, VirtQueue
) *vector_queues
;
119 typedef struct VirtioDeviceClass
{
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
,
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
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.
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.
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.
159 void (*save
)(VirtIODevice
*vdev
, QEMUFile
*f
);
160 int (*load
)(VirtIODevice
*vdev
, QEMUFile
*f
, int version_id
);
161 const VMStateDescription
*vmsd
;
164 void virtio_instance_init_common(Object
*proxy_obj
, void *data
,
165 size_t vdev_size
, const char *vdev_name
);
167 void virtio_init(VirtIODevice
*vdev
, const char *name
,
168 uint16_t device_id
, size_t config_size
);
169 void virtio_cleanup(VirtIODevice
*vdev
);
171 void virtio_error(VirtIODevice
*vdev
, const char *fmt
, ...) GCC_FMT_ATTR(2, 3);
173 /* Set the child bus name. */
174 void virtio_device_set_child_bus_name(VirtIODevice
*vdev
, char *bus_name
);
176 typedef void (*VirtIOHandleOutput
)(VirtIODevice
*, VirtQueue
*);
177 typedef bool (*VirtIOHandleAIOOutput
)(VirtIODevice
*, VirtQueue
*);
179 VirtQueue
*virtio_add_queue(VirtIODevice
*vdev
, int queue_size
,
180 VirtIOHandleOutput handle_output
);
182 void virtio_del_queue(VirtIODevice
*vdev
, int n
);
184 void virtqueue_push(VirtQueue
*vq
, const VirtQueueElement
*elem
,
186 void virtqueue_flush(VirtQueue
*vq
, unsigned int count
);
187 void virtqueue_detach_element(VirtQueue
*vq
, const VirtQueueElement
*elem
,
189 void virtqueue_unpop(VirtQueue
*vq
, const VirtQueueElement
*elem
,
191 bool virtqueue_rewind(VirtQueue
*vq
, unsigned int num
);
192 void virtqueue_fill(VirtQueue
*vq
, const VirtQueueElement
*elem
,
193 unsigned int len
, unsigned int idx
);
195 void virtqueue_map(VirtIODevice
*vdev
, VirtQueueElement
*elem
);
196 void *virtqueue_pop(VirtQueue
*vq
, size_t sz
);
197 unsigned int virtqueue_drop_all(VirtQueue
*vq
);
198 void *qemu_get_virtqueue_element(VirtIODevice
*vdev
, QEMUFile
*f
, size_t sz
);
199 void qemu_put_virtqueue_element(QEMUFile
*f
, VirtQueueElement
*elem
);
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
,
203 unsigned int *out_bytes
,
204 unsigned max_in_bytes
, unsigned max_out_bytes
);
206 void virtio_notify_irqfd(VirtIODevice
*vdev
, VirtQueue
*vq
);
207 void virtio_notify(VirtIODevice
*vdev
, VirtQueue
*vq
);
209 int virtio_save(VirtIODevice
*vdev
, QEMUFile
*f
);
211 extern const VMStateInfo virtio_vmstate_info
;
213 #define VMSTATE_VIRTIO_DEVICE \
216 .info = &virtio_vmstate_info, \
217 .flags = VMS_SINGLE, \
220 int virtio_load(VirtIODevice
*vdev
, QEMUFile
*f
, int version_id
);
222 void virtio_notify_config(VirtIODevice
*vdev
);
224 void virtio_queue_set_notification(VirtQueue
*vq
, int enable
);
226 int virtio_queue_ready(VirtQueue
*vq
);
228 int virtio_queue_empty(VirtQueue
*vq
);
230 /* Host binding interface. */
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
);
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
);
247 void virtio_queue_set_addr(VirtIODevice
*vdev
, int n
, hwaddr addr
);
248 hwaddr
virtio_queue_get_addr(VirtIODevice
*vdev
, int n
);
249 void virtio_queue_set_num(VirtIODevice
*vdev
, int n
, int num
);
250 int virtio_queue_get_num(VirtIODevice
*vdev
, int n
);
251 int virtio_queue_get_max_num(VirtIODevice
*vdev
, int n
);
252 int virtio_get_num_queues(VirtIODevice
*vdev
);
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
);
256 void virtio_queue_set_align(VirtIODevice
*vdev
, int n
, int align
);
257 void virtio_queue_notify(VirtIODevice
*vdev
, int n
);
258 uint16_t virtio_queue_vector(VirtIODevice
*vdev
, int n
);
259 void virtio_queue_set_vector(VirtIODevice
*vdev
, int n
, uint16_t vector
);
260 int virtio_queue_set_host_notifier_mr(VirtIODevice
*vdev
, int n
,
261 MemoryRegion
*mr
, bool assign
);
262 int virtio_set_status(VirtIODevice
*vdev
, uint8_t val
);
263 void virtio_reset(void *opaque
);
264 void virtio_update_irq(VirtIODevice
*vdev
);
265 int virtio_set_features(VirtIODevice
*vdev
, uint64_t val
);
268 typedef struct VirtIOBlkConf VirtIOBlkConf
;
269 struct virtio_net_conf
;
270 typedef struct virtio_serial_conf virtio_serial_conf
;
271 typedef struct virtio_input_conf virtio_input_conf
;
272 typedef struct VirtIOSCSIConf VirtIOSCSIConf
;
273 typedef struct VirtIORNGConf VirtIORNGConf
;
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)
287 hwaddr
virtio_queue_get_desc_addr(VirtIODevice
*vdev
, int n
);
288 bool virtio_queue_enabled(VirtIODevice
*vdev
, int n
);
289 hwaddr
virtio_queue_get_avail_addr(VirtIODevice
*vdev
, int n
);
290 hwaddr
virtio_queue_get_used_addr(VirtIODevice
*vdev
, int n
);
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
);
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
);
296 void virtio_queue_restore_last_avail_idx(VirtIODevice
*vdev
, int n
);
297 void virtio_queue_invalidate_signalled_used(VirtIODevice
*vdev
, int n
);
298 void virtio_queue_update_used_idx(VirtIODevice
*vdev
, int n
);
299 VirtQueue
*virtio_get_queue(VirtIODevice
*vdev
, int n
);
300 uint16_t virtio_get_queue_index(VirtQueue
*vq
);
301 EventNotifier
*virtio_queue_get_guest_notifier(VirtQueue
*vq
);
302 void virtio_queue_set_guest_notifier_fd_handler(VirtQueue
*vq
, bool assign
,
304 int virtio_device_start_ioeventfd(VirtIODevice
*vdev
);
305 void virtio_device_stop_ioeventfd(VirtIODevice
*vdev
);
306 int virtio_device_grab_ioeventfd(VirtIODevice
*vdev
);
307 void virtio_device_release_ioeventfd(VirtIODevice
*vdev
);
308 bool virtio_device_ioeventfd_enabled(VirtIODevice
*vdev
);
309 EventNotifier
*virtio_queue_get_host_notifier(VirtQueue
*vq
);
310 void virtio_queue_host_notifier_read(EventNotifier
*n
);
311 void virtio_queue_aio_set_host_notifier_handler(VirtQueue
*vq
, AioContext
*ctx
,
312 VirtIOHandleAIOOutput handle_output
);
313 VirtQueue
*virtio_vector_first_queue(VirtIODevice
*vdev
, uint16_t vector
);
314 VirtQueue
*virtio_vector_next_queue(VirtQueue
*vq
);
316 static inline void virtio_add_feature(uint64_t *features
, unsigned int fbit
)
319 *features
|= (1ULL << fbit
);
322 static inline void virtio_clear_feature(uint64_t *features
, unsigned int fbit
)
325 *features
&= ~(1ULL << fbit
);
328 static inline bool virtio_has_feature(uint64_t features
, unsigned int fbit
)
331 return !!(features
& (1ULL << fbit
));
334 static inline bool virtio_vdev_has_feature(VirtIODevice
*vdev
,
337 return virtio_has_feature(vdev
->guest_features
, fbit
);
340 static inline bool virtio_host_has_feature(VirtIODevice
*vdev
,
343 return virtio_has_feature(vdev
->host_features
, fbit
);
346 static inline bool virtio_is_big_endian(VirtIODevice
*vdev
)
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
;
352 /* Devices conforming to VIRTIO 1.0 or later are always LE. */
356 static inline bool virtio_device_started(VirtIODevice
*vdev
, uint8_t status
)
358 if (vdev
->use_started
) {
359 return vdev
->started
;
362 return status
& VIRTIO_CONFIG_S_DRIVER_OK
;
365 static inline void virtio_set_started(VirtIODevice
*vdev
, bool started
)
368 vdev
->start_on_kick
= false;
371 if (vdev
->use_started
) {
372 vdev
->started
= started
;