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 "exec/memory.h" 18 #include "hw/qdev-core.h" 19 #include "net/net.h" 20 #include "migration/vmstate.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 QEMU_ALIGN_UP(addr, align); 38 } 39 40 typedef struct VirtIOFeature { 41 uint64_t flags; 42 size_t end; 43 } VirtIOFeature; 44 45 size_t virtio_feature_get_config_size(VirtIOFeature *features, 46 uint64_t host_features); 47 48 typedef struct VirtQueue VirtQueue; 49 50 #define VIRTQUEUE_MAX_SIZE 1024 51 52 typedef struct VirtQueueElement 53 { 54 unsigned int index; 55 unsigned int len; 56 unsigned int ndescs; 57 unsigned int out_num; 58 unsigned int in_num; 59 hwaddr *in_addr; 60 hwaddr *out_addr; 61 struct iovec *in_sg; 62 struct iovec *out_sg; 63 } VirtQueueElement; 64 65 #define VIRTIO_QUEUE_MAX 1024 66 67 #define VIRTIO_NO_VECTOR 0xffff 68 69 #define TYPE_VIRTIO_DEVICE "virtio-device" 70 #define VIRTIO_DEVICE_GET_CLASS(obj) \ 71 OBJECT_GET_CLASS(VirtioDeviceClass, obj, TYPE_VIRTIO_DEVICE) 72 #define VIRTIO_DEVICE_CLASS(klass) \ 73 OBJECT_CLASS_CHECK(VirtioDeviceClass, klass, TYPE_VIRTIO_DEVICE) 74 #define VIRTIO_DEVICE(obj) \ 75 OBJECT_CHECK(VirtIODevice, (obj), TYPE_VIRTIO_DEVICE) 76 77 enum virtio_device_endian { 78 VIRTIO_DEVICE_ENDIAN_UNKNOWN, 79 VIRTIO_DEVICE_ENDIAN_LITTLE, 80 VIRTIO_DEVICE_ENDIAN_BIG, 81 }; 82 83 struct VirtIODevice 84 { 85 DeviceState parent_obj; 86 const char *name; 87 uint8_t status; 88 uint8_t isr; 89 uint16_t queue_sel; 90 uint64_t guest_features; 91 uint64_t host_features; 92 uint64_t backend_features; 93 size_t config_len; 94 void *config; 95 uint16_t config_vector; 96 uint32_t generation; 97 int nvectors; 98 VirtQueue *vq; 99 MemoryListener listener; 100 uint16_t device_id; 101 bool vm_running; 102 bool broken; /* device in invalid state, needs reset */ 103 bool use_started; 104 bool started; 105 bool start_on_kick; /* when virtio 1.0 feature has not been negotiated */ 106 VMChangeStateEntry *vmstate; 107 char *bus_name; 108 uint8_t device_endian; 109 bool use_guest_notifier_mask; 110 AddressSpace *dma_as; 111 QLIST_HEAD(, VirtQueue) *vector_queues; 112 }; 113 114 typedef struct VirtioDeviceClass { 115 /*< private >*/ 116 DeviceClass parent; 117 /*< public >*/ 118 119 /* This is what a VirtioDevice must implement */ 120 DeviceRealize realize; 121 DeviceUnrealize unrealize; 122 uint64_t (*get_features)(VirtIODevice *vdev, 123 uint64_t requested_features, 124 Error **errp); 125 uint64_t (*bad_features)(VirtIODevice *vdev); 126 void (*set_features)(VirtIODevice *vdev, uint64_t val); 127 int (*validate_features)(VirtIODevice *vdev); 128 void (*get_config)(VirtIODevice *vdev, uint8_t *config); 129 void (*set_config)(VirtIODevice *vdev, const uint8_t *config); 130 void (*reset)(VirtIODevice *vdev); 131 void (*set_status)(VirtIODevice *vdev, uint8_t val); 132 /* For transitional devices, this is a bitmap of features 133 * that are only exposed on the legacy interface but not 134 * the modern one. 135 */ 136 uint64_t legacy_features; 137 /* Test and clear event pending status. 138 * Should be called after unmask to avoid losing events. 139 * If backend does not support masking, 140 * must check in frontend instead. 141 */ 142 bool (*guest_notifier_pending)(VirtIODevice *vdev, int n); 143 /* Mask/unmask events from this vq. Any events reported 144 * while masked will become pending. 145 * If backend does not support masking, 146 * must mask in frontend instead. 147 */ 148 void (*guest_notifier_mask)(VirtIODevice *vdev, int n, bool mask); 149 int (*start_ioeventfd)(VirtIODevice *vdev); 150 void (*stop_ioeventfd)(VirtIODevice *vdev); 151 /* Saving and loading of a device; trying to deprecate save/load 152 * use vmsd for new devices. 153 */ 154 void (*save)(VirtIODevice *vdev, QEMUFile *f); 155 int (*load)(VirtIODevice *vdev, QEMUFile *f, int version_id); 156 const VMStateDescription *vmsd; 157 } VirtioDeviceClass; 158 159 void virtio_instance_init_common(Object *proxy_obj, void *data, 160 size_t vdev_size, const char *vdev_name); 161 162 void virtio_init(VirtIODevice *vdev, const char *name, 163 uint16_t device_id, size_t config_size); 164 void virtio_cleanup(VirtIODevice *vdev); 165 166 void virtio_error(VirtIODevice *vdev, const char *fmt, ...) GCC_FMT_ATTR(2, 3); 167 168 /* Set the child bus name. */ 169 void virtio_device_set_child_bus_name(VirtIODevice *vdev, char *bus_name); 170 171 typedef void (*VirtIOHandleOutput)(VirtIODevice *, VirtQueue *); 172 typedef bool (*VirtIOHandleAIOOutput)(VirtIODevice *, VirtQueue *); 173 174 VirtQueue *virtio_add_queue(VirtIODevice *vdev, int queue_size, 175 VirtIOHandleOutput handle_output); 176 177 void virtio_del_queue(VirtIODevice *vdev, int n); 178 179 void virtqueue_push(VirtQueue *vq, const VirtQueueElement *elem, 180 unsigned int len); 181 void virtqueue_flush(VirtQueue *vq, unsigned int count); 182 void virtqueue_detach_element(VirtQueue *vq, const VirtQueueElement *elem, 183 unsigned int len); 184 void virtqueue_unpop(VirtQueue *vq, const VirtQueueElement *elem, 185 unsigned int len); 186 bool virtqueue_rewind(VirtQueue *vq, unsigned int num); 187 void virtqueue_fill(VirtQueue *vq, const VirtQueueElement *elem, 188 unsigned int len, unsigned int idx); 189 190 void virtqueue_map(VirtIODevice *vdev, VirtQueueElement *elem); 191 void *virtqueue_pop(VirtQueue *vq, size_t sz); 192 unsigned int virtqueue_drop_all(VirtQueue *vq); 193 void *qemu_get_virtqueue_element(VirtIODevice *vdev, QEMUFile *f, size_t sz); 194 void qemu_put_virtqueue_element(VirtIODevice *vdev, QEMUFile *f, 195 VirtQueueElement *elem); 196 int virtqueue_avail_bytes(VirtQueue *vq, unsigned int in_bytes, 197 unsigned int out_bytes); 198 void virtqueue_get_avail_bytes(VirtQueue *vq, unsigned int *in_bytes, 199 unsigned int *out_bytes, 200 unsigned max_in_bytes, unsigned max_out_bytes); 201 202 void virtio_notify_irqfd(VirtIODevice *vdev, VirtQueue *vq); 203 void virtio_notify(VirtIODevice *vdev, VirtQueue *vq); 204 205 int virtio_save(VirtIODevice *vdev, QEMUFile *f); 206 207 extern const VMStateInfo virtio_vmstate_info; 208 209 #define VMSTATE_VIRTIO_DEVICE \ 210 { \ 211 .name = "virtio", \ 212 .info = &virtio_vmstate_info, \ 213 .flags = VMS_SINGLE, \ 214 } 215 216 int virtio_load(VirtIODevice *vdev, QEMUFile *f, int version_id); 217 218 void virtio_notify_config(VirtIODevice *vdev); 219 220 void virtio_queue_set_notification(VirtQueue *vq, int enable); 221 222 int virtio_queue_ready(VirtQueue *vq); 223 224 int virtio_queue_empty(VirtQueue *vq); 225 226 /* Host binding interface. */ 227 228 uint32_t virtio_config_readb(VirtIODevice *vdev, uint32_t addr); 229 uint32_t virtio_config_readw(VirtIODevice *vdev, uint32_t addr); 230 uint32_t virtio_config_readl(VirtIODevice *vdev, uint32_t addr); 231 void virtio_config_writeb(VirtIODevice *vdev, uint32_t addr, uint32_t data); 232 void virtio_config_writew(VirtIODevice *vdev, uint32_t addr, uint32_t data); 233 void virtio_config_writel(VirtIODevice *vdev, uint32_t addr, uint32_t data); 234 uint32_t virtio_config_modern_readb(VirtIODevice *vdev, uint32_t addr); 235 uint32_t virtio_config_modern_readw(VirtIODevice *vdev, uint32_t addr); 236 uint32_t virtio_config_modern_readl(VirtIODevice *vdev, uint32_t addr); 237 void virtio_config_modern_writeb(VirtIODevice *vdev, 238 uint32_t addr, uint32_t data); 239 void virtio_config_modern_writew(VirtIODevice *vdev, 240 uint32_t addr, uint32_t data); 241 void virtio_config_modern_writel(VirtIODevice *vdev, 242 uint32_t addr, uint32_t data); 243 void virtio_queue_set_addr(VirtIODevice *vdev, int n, hwaddr addr); 244 hwaddr virtio_queue_get_addr(VirtIODevice *vdev, int n); 245 void virtio_queue_set_num(VirtIODevice *vdev, int n, int num); 246 int virtio_queue_get_num(VirtIODevice *vdev, int n); 247 int virtio_queue_get_max_num(VirtIODevice *vdev, int n); 248 int virtio_get_num_queues(VirtIODevice *vdev); 249 void virtio_queue_set_rings(VirtIODevice *vdev, int n, hwaddr desc, 250 hwaddr avail, hwaddr used); 251 void virtio_queue_update_rings(VirtIODevice *vdev, int n); 252 void virtio_queue_set_align(VirtIODevice *vdev, int n, int align); 253 void virtio_queue_notify(VirtIODevice *vdev, int n); 254 uint16_t virtio_queue_vector(VirtIODevice *vdev, int n); 255 void virtio_queue_set_vector(VirtIODevice *vdev, int n, uint16_t vector); 256 int virtio_queue_set_host_notifier_mr(VirtIODevice *vdev, int n, 257 MemoryRegion *mr, bool assign); 258 int virtio_set_status(VirtIODevice *vdev, uint8_t val); 259 void virtio_reset(void *opaque); 260 void virtio_update_irq(VirtIODevice *vdev); 261 int virtio_set_features(VirtIODevice *vdev, uint64_t val); 262 263 /* Base devices. */ 264 typedef struct VirtIOBlkConf VirtIOBlkConf; 265 struct virtio_net_conf; 266 typedef struct virtio_serial_conf virtio_serial_conf; 267 typedef struct virtio_input_conf virtio_input_conf; 268 typedef struct VirtIOSCSIConf VirtIOSCSIConf; 269 typedef struct VirtIORNGConf VirtIORNGConf; 270 271 #define DEFINE_VIRTIO_COMMON_FEATURES(_state, _field) \ 272 DEFINE_PROP_BIT64("indirect_desc", _state, _field, \ 273 VIRTIO_RING_F_INDIRECT_DESC, true), \ 274 DEFINE_PROP_BIT64("event_idx", _state, _field, \ 275 VIRTIO_RING_F_EVENT_IDX, true), \ 276 DEFINE_PROP_BIT64("notify_on_empty", _state, _field, \ 277 VIRTIO_F_NOTIFY_ON_EMPTY, true), \ 278 DEFINE_PROP_BIT64("any_layout", _state, _field, \ 279 VIRTIO_F_ANY_LAYOUT, true), \ 280 DEFINE_PROP_BIT64("iommu_platform", _state, _field, \ 281 VIRTIO_F_IOMMU_PLATFORM, false), \ 282 DEFINE_PROP_BIT64("packed", _state, _field, \ 283 VIRTIO_F_RING_PACKED, false) 284 285 hwaddr virtio_queue_get_desc_addr(VirtIODevice *vdev, int n); 286 bool virtio_queue_enabled(VirtIODevice *vdev, int n); 287 hwaddr virtio_queue_get_avail_addr(VirtIODevice *vdev, int n); 288 hwaddr virtio_queue_get_used_addr(VirtIODevice *vdev, int n); 289 hwaddr virtio_queue_get_desc_size(VirtIODevice *vdev, int n); 290 hwaddr virtio_queue_get_avail_size(VirtIODevice *vdev, int n); 291 hwaddr virtio_queue_get_used_size(VirtIODevice *vdev, int n); 292 unsigned int virtio_queue_get_last_avail_idx(VirtIODevice *vdev, int n); 293 void virtio_queue_set_last_avail_idx(VirtIODevice *vdev, int n, 294 unsigned int idx); 295 void virtio_queue_restore_last_avail_idx(VirtIODevice *vdev, int n); 296 void virtio_queue_invalidate_signalled_used(VirtIODevice *vdev, int n); 297 void virtio_queue_update_used_idx(VirtIODevice *vdev, int n); 298 VirtQueue *virtio_get_queue(VirtIODevice *vdev, int n); 299 uint16_t virtio_get_queue_index(VirtQueue *vq); 300 EventNotifier *virtio_queue_get_guest_notifier(VirtQueue *vq); 301 void virtio_queue_set_guest_notifier_fd_handler(VirtQueue *vq, bool assign, 302 bool with_irqfd); 303 int virtio_device_start_ioeventfd(VirtIODevice *vdev); 304 int virtio_device_grab_ioeventfd(VirtIODevice *vdev); 305 void virtio_device_release_ioeventfd(VirtIODevice *vdev); 306 bool virtio_device_ioeventfd_enabled(VirtIODevice *vdev); 307 EventNotifier *virtio_queue_get_host_notifier(VirtQueue *vq); 308 void virtio_queue_host_notifier_read(EventNotifier *n); 309 void virtio_queue_aio_set_host_notifier_handler(VirtQueue *vq, AioContext *ctx, 310 VirtIOHandleAIOOutput handle_output); 311 VirtQueue *virtio_vector_first_queue(VirtIODevice *vdev, uint16_t vector); 312 VirtQueue *virtio_vector_next_queue(VirtQueue *vq); 313 314 static inline void virtio_add_feature(uint64_t *features, unsigned int fbit) 315 { 316 assert(fbit < 64); 317 *features |= (1ULL << fbit); 318 } 319 320 static inline void virtio_clear_feature(uint64_t *features, unsigned int fbit) 321 { 322 assert(fbit < 64); 323 *features &= ~(1ULL << fbit); 324 } 325 326 static inline bool virtio_has_feature(uint64_t features, unsigned int fbit) 327 { 328 assert(fbit < 64); 329 return !!(features & (1ULL << fbit)); 330 } 331 332 static inline bool virtio_vdev_has_feature(VirtIODevice *vdev, 333 unsigned int fbit) 334 { 335 return virtio_has_feature(vdev->guest_features, fbit); 336 } 337 338 static inline bool virtio_host_has_feature(VirtIODevice *vdev, 339 unsigned int fbit) 340 { 341 return virtio_has_feature(vdev->host_features, fbit); 342 } 343 344 static inline bool virtio_is_big_endian(VirtIODevice *vdev) 345 { 346 if (!virtio_vdev_has_feature(vdev, VIRTIO_F_VERSION_1)) { 347 assert(vdev->device_endian != VIRTIO_DEVICE_ENDIAN_UNKNOWN); 348 return vdev->device_endian == VIRTIO_DEVICE_ENDIAN_BIG; 349 } 350 /* Devices conforming to VIRTIO 1.0 or later are always LE. */ 351 return false; 352 } 353 354 static inline bool virtio_device_started(VirtIODevice *vdev, uint8_t status) 355 { 356 if (vdev->use_started) { 357 return vdev->started; 358 } 359 360 return status & VIRTIO_CONFIG_S_DRIVER_OK; 361 } 362 363 static inline void virtio_set_started(VirtIODevice *vdev, bool started) 364 { 365 if (started) { 366 vdev->start_on_kick = false; 367 } 368 369 if (vdev->use_started) { 370 vdev->started = started; 371 } 372 } 373 #endif 374