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