include/hw/virtio/virtio.h

   1 /*
   2  * Virtio Support
   3  *
   4  * Copyright IBM, Corp. 2007
   5  *
   6  * Authors:
   7  *  Anthony Liguori   <[email protected]>
   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 struct VirtQueue;
  29
  30 static inline hwaddr vring_align(hwaddr addr,
  31                                              unsigned long align)
  32 {
  33     return (addr + align - 1) & ~(align - 1);
  34 }
  35
  36 typedef struct VirtQueue VirtQueue;
  37
  38 #define VIRTQUEUE_MAX_SIZE 1024
  39
  40 typedef struct VirtQueueElement
  41 {
  42     unsigned int index;
  43     unsigned int out_num;
  44     unsigned int in_num;
  45     hwaddr in_addr[VIRTQUEUE_MAX_SIZE];
  46     hwaddr out_addr[VIRTQUEUE_MAX_SIZE];
  47     struct iovec in_sg[VIRTQUEUE_MAX_SIZE];
  48     struct iovec out_sg[VIRTQUEUE_MAX_SIZE];
  49 } VirtQueueElement;
  50
  51 #define VIRTIO_QUEUE_MAX 1024
  52
  53 #define VIRTIO_NO_VECTOR 0xffff
  54
  55 #define TYPE_VIRTIO_DEVICE "virtio-device"
  56 #define VIRTIO_DEVICE_GET_CLASS(obj) \
  57         OBJECT_GET_CLASS(VirtioDeviceClass, obj, TYPE_VIRTIO_DEVICE)
  58 #define VIRTIO_DEVICE_CLASS(klass) \
  59         OBJECT_CLASS_CHECK(VirtioDeviceClass, klass, TYPE_VIRTIO_DEVICE)
  60 #define VIRTIO_DEVICE(obj) \
  61         OBJECT_CHECK(VirtIODevice, (obj), TYPE_VIRTIO_DEVICE)
  62
  63 enum virtio_device_endian {
  64     VIRTIO_DEVICE_ENDIAN_UNKNOWN,
  65     VIRTIO_DEVICE_ENDIAN_LITTLE,
  66     VIRTIO_DEVICE_ENDIAN_BIG,
  67 };
  68
  69 struct VirtIODevice
  70 {
  71     DeviceState parent_obj;
  72     const char *name;
  73     uint8_t status;
  74     uint8_t isr;
  75     uint16_t queue_sel;
  76     uint64_t guest_features;
  77     uint64_t host_features;
  78     size_t config_len;
  79     void *config;
  80     uint16_t config_vector;
  81     int nvectors;
  82     VirtQueue *vq;
  83     uint16_t device_id;
  84     bool vm_running;
  85     VMChangeStateEntry *vmstate;
  86     char *bus_name;
  87     uint8_t device_endian;
  88     QLIST_HEAD(, VirtQueue) *vector_queues;
  89 };
  90
  91 typedef struct VirtioDeviceClass {
  92     /*< private >*/
  93     DeviceClass parent;
  94     /*< public >*/
  95
  96     /* This is what a VirtioDevice must implement */
  97     DeviceRealize realize;
  98     DeviceUnrealize unrealize;
  99     uint64_t (*get_features)(VirtIODevice *vdev, uint64_t requested_features);
 100     uint64_t (*bad_features)(VirtIODevice *vdev);
 101     void (*set_features)(VirtIODevice *vdev, uint64_t val);
 102     int (*validate_features)(VirtIODevice *vdev);
 103     void (*get_config)(VirtIODevice *vdev, uint8_t *config);
 104     void (*set_config)(VirtIODevice *vdev, const uint8_t *config);
 105     void (*reset)(VirtIODevice *vdev);
 106     void (*set_status)(VirtIODevice *vdev, uint8_t val);
 107     /* Test and clear event pending status.
 108      * Should be called after unmask to avoid losing events.
 109      * If backend does not support masking,
 110      * must check in frontend instead.
 111      */
 112     bool (*guest_notifier_pending)(VirtIODevice *vdev, int n);
 113     /* Mask/unmask events from this vq. Any events reported
 114      * while masked will become pending.
 115      * If backend does not support masking,
 116      * must mask in frontend instead.
 117      */
 118     void (*guest_notifier_mask)(VirtIODevice *vdev, int n, bool mask);
 119     void (*save)(VirtIODevice *vdev, QEMUFile *f);
 120     int (*load)(VirtIODevice *vdev, QEMUFile *f, int version_id);
 121 } VirtioDeviceClass;
 122
 123 void virtio_instance_init_common(Object *proxy_obj, void *data,
 124                                  size_t vdev_size, const char *vdev_name);
 125
 126 void virtio_init(VirtIODevice *vdev, const char *name,
 127                          uint16_t device_id, size_t config_size);
 128 void virtio_cleanup(VirtIODevice *vdev);
 129
 130 /* Set the child bus name. */
 131 void virtio_device_set_child_bus_name(VirtIODevice *vdev, char *bus_name);
 132
 133 VirtQueue *virtio_add_queue(VirtIODevice *vdev, int queue_size,
 134                             void (*handle_output)(VirtIODevice *,
 135                                                   VirtQueue *));
 136
 137 void virtio_del_queue(VirtIODevice *vdev, int n);
 138
 139 void virtqueue_push(VirtQueue *vq, const VirtQueueElement *elem,
 140                     unsigned int len);
 141 void virtqueue_flush(VirtQueue *vq, unsigned int count);
 142 void virtqueue_fill(VirtQueue *vq, const VirtQueueElement *elem,
 143                     unsigned int len, unsigned int idx);
 144
 145 void virtqueue_map_sg(struct iovec *sg, hwaddr *addr,
 146     size_t num_sg, int is_write);
 147 int virtqueue_pop(VirtQueue *vq, VirtQueueElement *elem);
 148 int virtqueue_avail_bytes(VirtQueue *vq, unsigned int in_bytes,
 149                           unsigned int out_bytes);
 150 void virtqueue_get_avail_bytes(VirtQueue *vq, unsigned int *in_bytes,
 151                                unsigned int *out_bytes,
 152                                unsigned max_in_bytes, unsigned max_out_bytes);
 153
 154 void virtio_notify(VirtIODevice *vdev, VirtQueue *vq);
 155
 156 void virtio_save(VirtIODevice *vdev, QEMUFile *f);
 157
 158 int virtio_load(VirtIODevice *vdev, QEMUFile *f, int version_id);
 159
 160 void virtio_notify_config(VirtIODevice *vdev);
 161
 162 void virtio_queue_set_notification(VirtQueue *vq, int enable);
 163
 164 int virtio_queue_ready(VirtQueue *vq);
 165
 166 int virtio_queue_empty(VirtQueue *vq);
 167
 168 /* Host binding interface.  */
 169
 170 uint32_t virtio_config_readb(VirtIODevice *vdev, uint32_t addr);
 171 uint32_t virtio_config_readw(VirtIODevice *vdev, uint32_t addr);
 172 uint32_t virtio_config_readl(VirtIODevice *vdev, uint32_t addr);
 173 void virtio_config_writeb(VirtIODevice *vdev, uint32_t addr, uint32_t data);
 174 void virtio_config_writew(VirtIODevice *vdev, uint32_t addr, uint32_t data);
 175 void virtio_config_writel(VirtIODevice *vdev, uint32_t addr, uint32_t data);
 176 void virtio_queue_set_addr(VirtIODevice *vdev, int n, hwaddr addr);
 177 hwaddr virtio_queue_get_addr(VirtIODevice *vdev, int n);
 178 void virtio_queue_set_num(VirtIODevice *vdev, int n, int num);
 179 int virtio_queue_get_num(VirtIODevice *vdev, int n);
 180 int virtio_get_num_queues(VirtIODevice *vdev);
 181 void virtio_queue_set_rings(VirtIODevice *vdev, int n, hwaddr desc,
 182                             hwaddr avail, hwaddr used);
 183 void virtio_queue_update_rings(VirtIODevice *vdev, int n);
 184 void virtio_queue_set_align(VirtIODevice *vdev, int n, int align);
 185 void virtio_queue_notify(VirtIODevice *vdev, int n);
 186 uint16_t virtio_queue_vector(VirtIODevice *vdev, int n);
 187 void virtio_queue_set_vector(VirtIODevice *vdev, int n, uint16_t vector);
 188 int virtio_set_status(VirtIODevice *vdev, uint8_t val);
 189 void virtio_reset(void *opaque);
 190 void virtio_update_irq(VirtIODevice *vdev);
 191 int virtio_set_features(VirtIODevice *vdev, uint64_t val);
 192
 193 /* Base devices.  */
 194 typedef struct VirtIOBlkConf VirtIOBlkConf;
 195 struct virtio_net_conf;
 196 typedef struct virtio_serial_conf virtio_serial_conf;
 197 typedef struct virtio_input_conf virtio_input_conf;
 198 typedef struct VirtIOSCSIConf VirtIOSCSIConf;
 199 typedef struct VirtIORNGConf VirtIORNGConf;
 200
 201 #define DEFINE_VIRTIO_COMMON_FEATURES(_state, _field) \
 202     DEFINE_PROP_BIT64("indirect_desc", _state, _field,    \
 203                       VIRTIO_RING_F_INDIRECT_DESC, true), \
 204     DEFINE_PROP_BIT64("event_idx", _state, _field,        \
 205                       VIRTIO_RING_F_EVENT_IDX, true),     \
 206     DEFINE_PROP_BIT64("notify_on_empty", _state, _field,  \
 207                       VIRTIO_F_NOTIFY_ON_EMPTY, true)
 208
 209 hwaddr virtio_queue_get_desc_addr(VirtIODevice *vdev, int n);
 210 hwaddr virtio_queue_get_avail_addr(VirtIODevice *vdev, int n);
 211 hwaddr virtio_queue_get_used_addr(VirtIODevice *vdev, int n);
 212 hwaddr virtio_queue_get_ring_addr(VirtIODevice *vdev, int n);
 213 hwaddr virtio_queue_get_desc_size(VirtIODevice *vdev, int n);
 214 hwaddr virtio_queue_get_avail_size(VirtIODevice *vdev, int n);
 215 hwaddr virtio_queue_get_used_size(VirtIODevice *vdev, int n);
 216 hwaddr virtio_queue_get_ring_size(VirtIODevice *vdev, int n);
 217 uint16_t virtio_queue_get_last_avail_idx(VirtIODevice *vdev, int n);
 218 void virtio_queue_set_last_avail_idx(VirtIODevice *vdev, int n, uint16_t idx);
 219 void virtio_queue_invalidate_signalled_used(VirtIODevice *vdev, int n);
 220 VirtQueue *virtio_get_queue(VirtIODevice *vdev, int n);
 221 uint16_t virtio_get_queue_index(VirtQueue *vq);
 222 int virtio_queue_get_id(VirtQueue *vq);
 223 EventNotifier *virtio_queue_get_guest_notifier(VirtQueue *vq);
 224 void virtio_queue_set_guest_notifier_fd_handler(VirtQueue *vq, bool assign,
 225                                                 bool with_irqfd);
 226 EventNotifier *virtio_queue_get_host_notifier(VirtQueue *vq);
 227 void virtio_queue_set_host_notifier_fd_handler(VirtQueue *vq, bool assign,
 228                                                bool set_handler);
 229 void virtio_queue_notify_vq(VirtQueue *vq);
 230 void virtio_irq(VirtQueue *vq);
 231 VirtQueue *virtio_vector_first_queue(VirtIODevice *vdev, uint16_t vector);
 232 VirtQueue *virtio_vector_next_queue(VirtQueue *vq);
 233
 234 static inline void virtio_add_feature(uint64_t *features, unsigned int fbit)
 235 {
 236     assert(fbit < 64);
 237     *features |= (1ULL << fbit);
 238 }
 239
 240 static inline void virtio_clear_feature(uint64_t *features, unsigned int fbit)
 241 {
 242     assert(fbit < 64);
 243     *features &= ~(1ULL << fbit);
 244 }
 245
 246 static inline bool __virtio_has_feature(uint64_t features, unsigned int fbit)
 247 {
 248     assert(fbit < 64);
 249     return !!(features & (1ULL << fbit));
 250 }
 251
 252 static inline bool virtio_has_feature(VirtIODevice *vdev, unsigned int fbit)
 253 {
 254     return __virtio_has_feature(vdev->guest_features, fbit);
 255 }
 256
 257 static inline bool virtio_is_big_endian(VirtIODevice *vdev)
 258 {
 259     if (!virtio_has_feature(vdev, VIRTIO_F_VERSION_1)) {
 260         assert(vdev->device_endian != VIRTIO_DEVICE_ENDIAN_UNKNOWN);
 261         return vdev->device_endian == VIRTIO_DEVICE_ENDIAN_BIG;
 262     }
 263     /* Devices conforming to VIRTIO 1.0 or later are always LE. */
 264     return false;
 265 }
 266 #endif