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 "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 /* 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 32 struct VirtQueue; 33 34 static inline hwaddr vring_align(hwaddr addr, 35 unsigned long align) 36 { 37 return (addr + align - 1) & ~(align - 1); 38 } 39 40 typedef struct VirtQueue VirtQueue; 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; 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 67 enum virtio_device_endian { 68 VIRTIO_DEVICE_ENDIAN_UNKNOWN, 69 VIRTIO_DEVICE_ENDIAN_LITTLE, 70 VIRTIO_DEVICE_ENDIAN_BIG, 71 }; 72 73 struct 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 97 typedef struct VirtioDeviceClass { 98 /*< private >*/ 99 DeviceClass parent; 100 /*< public >*/ 101 102 /* This is what a VirtioDevice must implement */ 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 /* Test and clear event pending status. 116 * Should be called after unmask to avoid losing events. 117 * If backend does not support masking, 118 * must check in frontend instead. 119 */ 120 bool (*guest_notifier_pending)(VirtIODevice *vdev, int n); 121 /* Mask/unmask events from this vq. Any events reported 122 * while masked will become pending. 123 * If backend does not support masking, 124 * must mask in frontend instead. 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 131 void virtio_instance_init_common(Object *proxy_obj, void *data, 132 size_t vdev_size, const char *vdev_name); 133 134 void virtio_init(VirtIODevice *vdev, const char *name, 135 uint16_t device_id, size_t config_size); 136 void virtio_cleanup(VirtIODevice *vdev); 137 138 /* Set the child bus name. */ 139 void virtio_device_set_child_bus_name(VirtIODevice *vdev, char *bus_name); 140 141 typedef void (*VirtIOHandleOutput)(VirtIODevice *, VirtQueue *); 142 143 VirtQueue *virtio_add_queue(VirtIODevice *vdev, int queue_size, 144 VirtIOHandleOutput handle_output); 145 146 VirtQueue *virtio_add_queue_aio(VirtIODevice *vdev, int queue_size, 147 VirtIOHandleOutput handle_output); 148 149 void virtio_del_queue(VirtIODevice *vdev, int n); 150 151 void *virtqueue_alloc_element(size_t sz, unsigned out_num, unsigned in_num); 152 void virtqueue_push(VirtQueue *vq, const VirtQueueElement *elem, 153 unsigned int len); 154 void virtqueue_flush(VirtQueue *vq, unsigned int count); 155 void virtqueue_discard(VirtQueue *vq, const VirtQueueElement *elem, 156 unsigned int len); 157 void virtqueue_fill(VirtQueue *vq, const VirtQueueElement *elem, 158 unsigned int len, unsigned int idx); 159 160 void virtqueue_map(VirtQueueElement *elem); 161 void *virtqueue_pop(VirtQueue *vq, size_t sz); 162 void *qemu_get_virtqueue_element(QEMUFile *f, size_t sz); 163 void qemu_put_virtqueue_element(QEMUFile *f, VirtQueueElement *elem); 164 int virtqueue_avail_bytes(VirtQueue *vq, unsigned int in_bytes, 165 unsigned int out_bytes); 166 void virtqueue_get_avail_bytes(VirtQueue *vq, unsigned int *in_bytes, 167 unsigned int *out_bytes, 168 unsigned max_in_bytes, unsigned max_out_bytes); 169 170 bool virtio_should_notify(VirtIODevice *vdev, VirtQueue *vq); 171 void virtio_notify(VirtIODevice *vdev, VirtQueue *vq); 172 173 void virtio_save(VirtIODevice *vdev, QEMUFile *f); 174 void virtio_vmstate_save(QEMUFile *f, void *opaque, size_t size); 175 176 #define VMSTATE_VIRTIO_DEVICE(devname, v, getf, putf) \ 177 static const VMStateDescription vmstate_virtio_ ## devname = { \ 178 .name = "virtio-" #devname , \ 179 .minimum_version_id = v, \ 180 .version_id = v, \ 181 .fields = (VMStateField[]) { \ 182 { \ 183 .name = "virtio", \ 184 .info = &(const VMStateInfo) {\ 185 .name = "virtio", \ 186 .get = getf, \ 187 .put = putf, \ 188 }, \ 189 .flags = VMS_SINGLE, \ 190 }, \ 191 VMSTATE_END_OF_LIST() \ 192 } \ 193 } 194 195 int virtio_load(VirtIODevice *vdev, QEMUFile *f, int version_id); 196 197 void virtio_notify_config(VirtIODevice *vdev); 198 199 void virtio_queue_set_notification(VirtQueue *vq, int enable); 200 201 int virtio_queue_ready(VirtQueue *vq); 202 203 int virtio_queue_empty(VirtQueue *vq); 204 205 /* Host binding interface. */ 206 207 uint32_t virtio_config_readb(VirtIODevice *vdev, uint32_t addr); 208 uint32_t virtio_config_readw(VirtIODevice *vdev, uint32_t addr); 209 uint32_t virtio_config_readl(VirtIODevice *vdev, uint32_t addr); 210 void virtio_config_writeb(VirtIODevice *vdev, uint32_t addr, uint32_t data); 211 void virtio_config_writew(VirtIODevice *vdev, uint32_t addr, uint32_t data); 212 void virtio_config_writel(VirtIODevice *vdev, uint32_t addr, uint32_t data); 213 uint32_t virtio_config_modern_readb(VirtIODevice *vdev, uint32_t addr); 214 uint32_t virtio_config_modern_readw(VirtIODevice *vdev, uint32_t addr); 215 uint32_t virtio_config_modern_readl(VirtIODevice *vdev, uint32_t addr); 216 void virtio_config_modern_writeb(VirtIODevice *vdev, 217 uint32_t addr, uint32_t data); 218 void virtio_config_modern_writew(VirtIODevice *vdev, 219 uint32_t addr, uint32_t data); 220 void virtio_config_modern_writel(VirtIODevice *vdev, 221 uint32_t addr, uint32_t data); 222 void virtio_queue_set_addr(VirtIODevice *vdev, int n, hwaddr addr); 223 hwaddr virtio_queue_get_addr(VirtIODevice *vdev, int n); 224 void virtio_queue_set_num(VirtIODevice *vdev, int n, int num); 225 int virtio_queue_get_num(VirtIODevice *vdev, int n); 226 int virtio_get_num_queues(VirtIODevice *vdev); 227 void virtio_queue_set_rings(VirtIODevice *vdev, int n, hwaddr desc, 228 hwaddr avail, hwaddr used); 229 void virtio_queue_update_rings(VirtIODevice *vdev, int n); 230 void virtio_queue_set_align(VirtIODevice *vdev, int n, int align); 231 void virtio_queue_notify(VirtIODevice *vdev, int n); 232 uint16_t virtio_queue_vector(VirtIODevice *vdev, int n); 233 void virtio_queue_set_vector(VirtIODevice *vdev, int n, uint16_t vector); 234 int virtio_set_status(VirtIODevice *vdev, uint8_t val); 235 void virtio_reset(void *opaque); 236 void virtio_update_irq(VirtIODevice *vdev); 237 int virtio_set_features(VirtIODevice *vdev, uint64_t val); 238 239 /* Base devices. */ 240 typedef struct VirtIOBlkConf VirtIOBlkConf; 241 struct virtio_net_conf; 242 typedef struct virtio_serial_conf virtio_serial_conf; 243 typedef struct virtio_input_conf virtio_input_conf; 244 typedef struct VirtIOSCSIConf VirtIOSCSIConf; 245 typedef struct VirtIORNGConf VirtIORNGConf; 246 247 #define DEFINE_VIRTIO_COMMON_FEATURES(_state, _field) \ 248 DEFINE_PROP_BIT64("indirect_desc", _state, _field, \ 249 VIRTIO_RING_F_INDIRECT_DESC, true), \ 250 DEFINE_PROP_BIT64("event_idx", _state, _field, \ 251 VIRTIO_RING_F_EVENT_IDX, true), \ 252 DEFINE_PROP_BIT64("notify_on_empty", _state, _field, \ 253 VIRTIO_F_NOTIFY_ON_EMPTY, true), \ 254 DEFINE_PROP_BIT64("any_layout", _state, _field, \ 255 VIRTIO_F_ANY_LAYOUT, true) 256 257 hwaddr virtio_queue_get_desc_addr(VirtIODevice *vdev, int n); 258 hwaddr virtio_queue_get_avail_addr(VirtIODevice *vdev, int n); 259 hwaddr virtio_queue_get_used_addr(VirtIODevice *vdev, int n); 260 hwaddr virtio_queue_get_ring_addr(VirtIODevice *vdev, int n); 261 hwaddr virtio_queue_get_desc_size(VirtIODevice *vdev, int n); 262 hwaddr virtio_queue_get_avail_size(VirtIODevice *vdev, int n); 263 hwaddr virtio_queue_get_used_size(VirtIODevice *vdev, int n); 264 hwaddr virtio_queue_get_ring_size(VirtIODevice *vdev, int n); 265 uint16_t virtio_queue_get_last_avail_idx(VirtIODevice *vdev, int n); 266 void virtio_queue_set_last_avail_idx(VirtIODevice *vdev, int n, uint16_t idx); 267 void virtio_queue_invalidate_signalled_used(VirtIODevice *vdev, int n); 268 VirtQueue *virtio_get_queue(VirtIODevice *vdev, int n); 269 uint16_t virtio_get_queue_index(VirtQueue *vq); 270 EventNotifier *virtio_queue_get_guest_notifier(VirtQueue *vq); 271 void virtio_queue_set_guest_notifier_fd_handler(VirtQueue *vq, bool assign, 272 bool with_irqfd); 273 EventNotifier *virtio_queue_get_host_notifier(VirtQueue *vq); 274 void virtio_queue_set_host_notifier_fd_handler(VirtQueue *vq, bool assign, 275 bool set_handler); 276 void virtio_queue_aio_set_host_notifier_handler(VirtQueue *vq, AioContext *ctx, 277 void (*fn)(VirtIODevice *, 278 VirtQueue *)); 279 void virtio_irq(VirtQueue *vq); 280 VirtQueue *virtio_vector_first_queue(VirtIODevice *vdev, uint16_t vector); 281 VirtQueue *virtio_vector_next_queue(VirtQueue *vq); 282 283 static inline void virtio_add_feature(uint64_t *features, unsigned int fbit) 284 { 285 assert(fbit < 64); 286 *features |= (1ULL << fbit); 287 } 288 289 static inline void virtio_clear_feature(uint64_t *features, unsigned int fbit) 290 { 291 assert(fbit < 64); 292 *features &= ~(1ULL << fbit); 293 } 294 295 static inline bool virtio_has_feature(uint64_t features, unsigned int fbit) 296 { 297 assert(fbit < 64); 298 return !!(features & (1ULL << fbit)); 299 } 300 301 static inline bool virtio_vdev_has_feature(VirtIODevice *vdev, 302 unsigned int fbit) 303 { 304 return virtio_has_feature(vdev->guest_features, fbit); 305 } 306 307 static inline bool virtio_host_has_feature(VirtIODevice *vdev, 308 unsigned int fbit) 309 { 310 return virtio_has_feature(vdev->host_features, fbit); 311 } 312 313 static inline bool virtio_is_big_endian(VirtIODevice *vdev) 314 { 315 if (!virtio_vdev_has_feature(vdev, VIRTIO_F_VERSION_1)) { 316 assert(vdev->device_endian != VIRTIO_DEVICE_ENDIAN_UNKNOWN); 317 return vdev->device_endian == VIRTIO_DEVICE_ENDIAN_BIG; 318 } 319 /* Devices conforming to VIRTIO 1.0 or later are always LE. */ 320 return false; 321 } 322 #endif 323