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[VIRTQUEUE_MAX_SIZE]; 50 hwaddr out_addr[VIRTQUEUE_MAX_SIZE]; 51 struct iovec in_sg[VIRTQUEUE_MAX_SIZE]; 52 struct iovec out_sg[VIRTQUEUE_MAX_SIZE]; 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 QLIST_HEAD(, VirtQueue) *vector_queues; 94 }; 95 96 typedef struct VirtioDeviceClass { 97 /*< private >*/ 98 DeviceClass parent; 99 /*< public >*/ 100 101 /* This is what a VirtioDevice must implement */ 102 DeviceRealize realize; 103 DeviceUnrealize unrealize; 104 uint64_t (*get_features)(VirtIODevice *vdev, 105 uint64_t requested_features, 106 Error **errp); 107 uint64_t (*bad_features)(VirtIODevice *vdev); 108 void (*set_features)(VirtIODevice *vdev, uint64_t val); 109 int (*validate_features)(VirtIODevice *vdev); 110 void (*get_config)(VirtIODevice *vdev, uint8_t *config); 111 void (*set_config)(VirtIODevice *vdev, const uint8_t *config); 112 void (*reset)(VirtIODevice *vdev); 113 void (*set_status)(VirtIODevice *vdev, uint8_t val); 114 /* Test and clear event pending status. 115 * Should be called after unmask to avoid losing events. 116 * If backend does not support masking, 117 * must check in frontend instead. 118 */ 119 bool (*guest_notifier_pending)(VirtIODevice *vdev, int n); 120 /* Mask/unmask events from this vq. Any events reported 121 * while masked will become pending. 122 * If backend does not support masking, 123 * must mask in frontend instead. 124 */ 125 void (*guest_notifier_mask)(VirtIODevice *vdev, int n, bool mask); 126 void (*save)(VirtIODevice *vdev, QEMUFile *f); 127 int (*load)(VirtIODevice *vdev, QEMUFile *f, int version_id); 128 } VirtioDeviceClass; 129 130 void virtio_instance_init_common(Object *proxy_obj, void *data, 131 size_t vdev_size, const char *vdev_name); 132 133 void virtio_init(VirtIODevice *vdev, const char *name, 134 uint16_t device_id, size_t config_size); 135 void virtio_cleanup(VirtIODevice *vdev); 136 137 /* Set the child bus name. */ 138 void virtio_device_set_child_bus_name(VirtIODevice *vdev, char *bus_name); 139 140 VirtQueue *virtio_add_queue(VirtIODevice *vdev, int queue_size, 141 void (*handle_output)(VirtIODevice *, 142 VirtQueue *)); 143 144 void virtio_del_queue(VirtIODevice *vdev, int n); 145 146 void virtqueue_push(VirtQueue *vq, const VirtQueueElement *elem, 147 unsigned int len); 148 void virtqueue_flush(VirtQueue *vq, unsigned int count); 149 void virtqueue_discard(VirtQueue *vq, const VirtQueueElement *elem, 150 unsigned int len); 151 void virtqueue_fill(VirtQueue *vq, const VirtQueueElement *elem, 152 unsigned int len, unsigned int idx); 153 154 void virtqueue_map(VirtQueueElement *elem); 155 void *virtqueue_pop(VirtQueue *vq, size_t sz); 156 void *qemu_get_virtqueue_element(QEMUFile *f, size_t sz); 157 void qemu_put_virtqueue_element(QEMUFile *f, VirtQueueElement *elem); 158 int virtqueue_avail_bytes(VirtQueue *vq, unsigned int in_bytes, 159 unsigned int out_bytes); 160 void virtqueue_get_avail_bytes(VirtQueue *vq, unsigned int *in_bytes, 161 unsigned int *out_bytes, 162 unsigned max_in_bytes, unsigned max_out_bytes); 163 164 void virtio_notify(VirtIODevice *vdev, VirtQueue *vq); 165 166 void virtio_save(VirtIODevice *vdev, QEMUFile *f); 167 168 int virtio_load(VirtIODevice *vdev, QEMUFile *f, int version_id); 169 170 void virtio_notify_config(VirtIODevice *vdev); 171 172 void virtio_queue_set_notification(VirtQueue *vq, int enable); 173 174 int virtio_queue_ready(VirtQueue *vq); 175 176 int virtio_queue_empty(VirtQueue *vq); 177 178 /* Host binding interface. */ 179 180 uint32_t virtio_config_readb(VirtIODevice *vdev, uint32_t addr); 181 uint32_t virtio_config_readw(VirtIODevice *vdev, uint32_t addr); 182 uint32_t virtio_config_readl(VirtIODevice *vdev, uint32_t addr); 183 void virtio_config_writeb(VirtIODevice *vdev, uint32_t addr, uint32_t data); 184 void virtio_config_writew(VirtIODevice *vdev, uint32_t addr, uint32_t data); 185 void virtio_config_writel(VirtIODevice *vdev, uint32_t addr, uint32_t data); 186 uint32_t virtio_config_modern_readb(VirtIODevice *vdev, uint32_t addr); 187 uint32_t virtio_config_modern_readw(VirtIODevice *vdev, uint32_t addr); 188 uint32_t virtio_config_modern_readl(VirtIODevice *vdev, uint32_t addr); 189 void virtio_config_modern_writeb(VirtIODevice *vdev, 190 uint32_t addr, uint32_t data); 191 void virtio_config_modern_writew(VirtIODevice *vdev, 192 uint32_t addr, uint32_t data); 193 void virtio_config_modern_writel(VirtIODevice *vdev, 194 uint32_t addr, uint32_t data); 195 void virtio_queue_set_addr(VirtIODevice *vdev, int n, hwaddr addr); 196 hwaddr virtio_queue_get_addr(VirtIODevice *vdev, int n); 197 void virtio_queue_set_num(VirtIODevice *vdev, int n, int num); 198 int virtio_queue_get_num(VirtIODevice *vdev, int n); 199 int virtio_get_num_queues(VirtIODevice *vdev); 200 void virtio_queue_set_rings(VirtIODevice *vdev, int n, hwaddr desc, 201 hwaddr avail, hwaddr used); 202 void virtio_queue_update_rings(VirtIODevice *vdev, int n); 203 void virtio_queue_set_align(VirtIODevice *vdev, int n, int align); 204 void virtio_queue_notify(VirtIODevice *vdev, int n); 205 uint16_t virtio_queue_vector(VirtIODevice *vdev, int n); 206 void virtio_queue_set_vector(VirtIODevice *vdev, int n, uint16_t vector); 207 int virtio_set_status(VirtIODevice *vdev, uint8_t val); 208 void virtio_reset(void *opaque); 209 void virtio_update_irq(VirtIODevice *vdev); 210 int virtio_set_features(VirtIODevice *vdev, uint64_t val); 211 212 /* Base devices. */ 213 typedef struct VirtIOBlkConf VirtIOBlkConf; 214 struct virtio_net_conf; 215 typedef struct virtio_serial_conf virtio_serial_conf; 216 typedef struct virtio_input_conf virtio_input_conf; 217 typedef struct VirtIOSCSIConf VirtIOSCSIConf; 218 typedef struct VirtIORNGConf VirtIORNGConf; 219 220 #define DEFINE_VIRTIO_COMMON_FEATURES(_state, _field) \ 221 DEFINE_PROP_BIT64("indirect_desc", _state, _field, \ 222 VIRTIO_RING_F_INDIRECT_DESC, true), \ 223 DEFINE_PROP_BIT64("event_idx", _state, _field, \ 224 VIRTIO_RING_F_EVENT_IDX, true), \ 225 DEFINE_PROP_BIT64("notify_on_empty", _state, _field, \ 226 VIRTIO_F_NOTIFY_ON_EMPTY, true), \ 227 DEFINE_PROP_BIT64("any_layout", _state, _field, \ 228 VIRTIO_F_ANY_LAYOUT, true) 229 230 hwaddr virtio_queue_get_desc_addr(VirtIODevice *vdev, int n); 231 hwaddr virtio_queue_get_avail_addr(VirtIODevice *vdev, int n); 232 hwaddr virtio_queue_get_used_addr(VirtIODevice *vdev, int n); 233 hwaddr virtio_queue_get_ring_addr(VirtIODevice *vdev, int n); 234 hwaddr virtio_queue_get_desc_size(VirtIODevice *vdev, int n); 235 hwaddr virtio_queue_get_avail_size(VirtIODevice *vdev, int n); 236 hwaddr virtio_queue_get_used_size(VirtIODevice *vdev, int n); 237 hwaddr virtio_queue_get_ring_size(VirtIODevice *vdev, int n); 238 uint16_t virtio_queue_get_last_avail_idx(VirtIODevice *vdev, int n); 239 void virtio_queue_set_last_avail_idx(VirtIODevice *vdev, int n, uint16_t idx); 240 void virtio_queue_invalidate_signalled_used(VirtIODevice *vdev, int n); 241 VirtQueue *virtio_get_queue(VirtIODevice *vdev, int n); 242 uint16_t virtio_get_queue_index(VirtQueue *vq); 243 int virtio_queue_get_id(VirtQueue *vq); 244 EventNotifier *virtio_queue_get_guest_notifier(VirtQueue *vq); 245 void virtio_queue_set_guest_notifier_fd_handler(VirtQueue *vq, bool assign, 246 bool with_irqfd); 247 EventNotifier *virtio_queue_get_host_notifier(VirtQueue *vq); 248 void virtio_queue_set_host_notifier_fd_handler(VirtQueue *vq, bool assign, 249 bool set_handler); 250 void virtio_queue_notify_vq(VirtQueue *vq); 251 void virtio_irq(VirtQueue *vq); 252 VirtQueue *virtio_vector_first_queue(VirtIODevice *vdev, uint16_t vector); 253 VirtQueue *virtio_vector_next_queue(VirtQueue *vq); 254 255 static inline void virtio_add_feature(uint64_t *features, unsigned int fbit) 256 { 257 assert(fbit < 64); 258 *features |= (1ULL << fbit); 259 } 260 261 static inline void virtio_clear_feature(uint64_t *features, unsigned int fbit) 262 { 263 assert(fbit < 64); 264 *features &= ~(1ULL << fbit); 265 } 266 267 static inline bool virtio_has_feature(uint64_t features, unsigned int fbit) 268 { 269 assert(fbit < 64); 270 return !!(features & (1ULL << fbit)); 271 } 272 273 static inline bool virtio_vdev_has_feature(VirtIODevice *vdev, 274 unsigned int fbit) 275 { 276 return virtio_has_feature(vdev->guest_features, fbit); 277 } 278 279 static inline bool virtio_host_has_feature(VirtIODevice *vdev, 280 unsigned int fbit) 281 { 282 return virtio_has_feature(vdev->host_features, fbit); 283 } 284 285 static inline bool virtio_is_big_endian(VirtIODevice *vdev) 286 { 287 if (!virtio_vdev_has_feature(vdev, VIRTIO_F_VERSION_1)) { 288 assert(vdev->device_endian != VIRTIO_DEVICE_ENDIAN_UNKNOWN); 289 return vdev->device_endian == VIRTIO_DEVICE_ENDIAN_BIG; 290 } 291 /* Devices conforming to VIRTIO 1.0 or later are always LE. */ 292 return false; 293 } 294 #endif 295