virtio.c 44.7 KB
Newer Older
A
aliguori 已提交
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
/*
 * Virtio Support
 *
 * Copyright IBM, Corp. 2007
 *
 * Authors:
 *  Anthony Liguori   <aliguori@us.ibm.com>
 *
 * This work is licensed under the terms of the GNU GPL, version 2.  See
 * the COPYING file in the top-level directory.
 *
 */

#include <inttypes.h>

16
#include "trace.h"
17
#include "exec/address-spaces.h"
18
#include "qemu/error-report.h"
P
Paolo Bonzini 已提交
19
#include "hw/virtio/virtio.h"
20
#include "qemu/atomic.h"
P
Paolo Bonzini 已提交
21
#include "hw/virtio/virtio-bus.h"
22
#include "migration/migration.h"
23
#include "hw/virtio/virtio-access.h"
A
aliguori 已提交
24

25 26 27 28 29
/*
 * The alignment to use between consumer and producer parts of vring.
 * x86 pagesize again. This is the default, used by transports like PCI
 * which don't provide a means for the guest to tell the host the alignment.
 */
30 31
#define VIRTIO_PCI_VRING_ALIGN         4096

A
aliguori 已提交
32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62
typedef struct VRingDesc
{
    uint64_t addr;
    uint32_t len;
    uint16_t flags;
    uint16_t next;
} VRingDesc;

typedef struct VRingAvail
{
    uint16_t flags;
    uint16_t idx;
    uint16_t ring[0];
} VRingAvail;

typedef struct VRingUsedElem
{
    uint32_t id;
    uint32_t len;
} VRingUsedElem;

typedef struct VRingUsed
{
    uint16_t flags;
    uint16_t idx;
    VRingUsedElem ring[0];
} VRingUsed;

typedef struct VRing
{
    unsigned int num;
C
Cornelia Huck 已提交
63
    unsigned int num_default;
64
    unsigned int align;
A
Avi Kivity 已提交
65 66 67
    hwaddr desc;
    hwaddr avail;
    hwaddr used;
A
aliguori 已提交
68 69 70 71 72 73
} VRing;

struct VirtQueue
{
    VRing vring;
    uint16_t last_avail_idx;
M
Michael S. Tsirkin 已提交
74 75 76 77 78 79 80 81 82
    /* Last used index value we have signalled on */
    uint16_t signalled_used;

    /* Last used index value we have signalled on */
    bool signalled_used_valid;

    /* Notification enabled? */
    bool notification;

83 84
    uint16_t queue_index;

A
aliguori 已提交
85
    int inuse;
M
Michael S. Tsirkin 已提交
86

87
    uint16_t vector;
A
aliguori 已提交
88
    void (*handle_output)(VirtIODevice *vdev, VirtQueue *vq);
89 90 91
    VirtIODevice *vdev;
    EventNotifier guest_notifier;
    EventNotifier host_notifier;
92
    QLIST_ENTRY(VirtQueue) node;
A
aliguori 已提交
93 94 95
};

/* virt queue functions */
96
void virtio_queue_update_rings(VirtIODevice *vdev, int n)
A
aliguori 已提交
97
{
98
    VRing *vring = &vdev->vq[n].vring;
P
Paul Brook 已提交
99

100 101 102 103 104 105 106 107
    if (!vring->desc) {
        /* not yet setup -> nothing to do */
        return;
    }
    vring->avail = vring->desc + vring->num * sizeof(VRingDesc);
    vring->used = vring_align(vring->avail +
                              offsetof(VRingAvail, ring[vring->num]),
                              vring->align);
A
aliguori 已提交
108 109
}

110 111
static inline uint64_t vring_desc_addr(VirtIODevice *vdev, hwaddr desc_pa,
                                       int i)
A
aliguori 已提交
112
{
A
Avi Kivity 已提交
113
    hwaddr pa;
114
    pa = desc_pa + sizeof(VRingDesc) * i + offsetof(VRingDesc, addr);
115
    return virtio_ldq_phys(vdev, pa);
A
aliguori 已提交
116 117
}

118
static inline uint32_t vring_desc_len(VirtIODevice *vdev, hwaddr desc_pa, int i)
A
aliguori 已提交
119
{
A
Avi Kivity 已提交
120
    hwaddr pa;
121
    pa = desc_pa + sizeof(VRingDesc) * i + offsetof(VRingDesc, len);
122
    return virtio_ldl_phys(vdev, pa);
A
aliguori 已提交
123 124
}

125 126
static inline uint16_t vring_desc_flags(VirtIODevice *vdev, hwaddr desc_pa,
                                        int i)
A
aliguori 已提交
127
{
A
Avi Kivity 已提交
128
    hwaddr pa;
129
    pa = desc_pa + sizeof(VRingDesc) * i + offsetof(VRingDesc, flags);
130
    return virtio_lduw_phys(vdev, pa);
A
aliguori 已提交
131 132
}

133 134
static inline uint16_t vring_desc_next(VirtIODevice *vdev, hwaddr desc_pa,
                                       int i)
A
aliguori 已提交
135
{
A
Avi Kivity 已提交
136
    hwaddr pa;
137
    pa = desc_pa + sizeof(VRingDesc) * i + offsetof(VRingDesc, next);
138
    return virtio_lduw_phys(vdev, pa);
A
aliguori 已提交
139 140 141 142
}

static inline uint16_t vring_avail_flags(VirtQueue *vq)
{
A
Avi Kivity 已提交
143
    hwaddr pa;
A
aliguori 已提交
144
    pa = vq->vring.avail + offsetof(VRingAvail, flags);
145
    return virtio_lduw_phys(vq->vdev, pa);
A
aliguori 已提交
146 147 148 149
}

static inline uint16_t vring_avail_idx(VirtQueue *vq)
{
A
Avi Kivity 已提交
150
    hwaddr pa;
A
aliguori 已提交
151
    pa = vq->vring.avail + offsetof(VRingAvail, idx);
152
    return virtio_lduw_phys(vq->vdev, pa);
A
aliguori 已提交
153 154 155 156
}

static inline uint16_t vring_avail_ring(VirtQueue *vq, int i)
{
A
Avi Kivity 已提交
157
    hwaddr pa;
A
aliguori 已提交
158
    pa = vq->vring.avail + offsetof(VRingAvail, ring[i]);
159
    return virtio_lduw_phys(vq->vdev, pa);
A
aliguori 已提交
160 161
}

162
static inline uint16_t vring_get_used_event(VirtQueue *vq)
M
Michael S. Tsirkin 已提交
163 164 165 166
{
    return vring_avail_ring(vq, vq->vring.num);
}

A
aliguori 已提交
167 168
static inline void vring_used_ring_id(VirtQueue *vq, int i, uint32_t val)
{
A
Avi Kivity 已提交
169
    hwaddr pa;
A
aliguori 已提交
170
    pa = vq->vring.used + offsetof(VRingUsed, ring[i].id);
171
    virtio_stl_phys(vq->vdev, pa, val);
A
aliguori 已提交
172 173 174 175
}

static inline void vring_used_ring_len(VirtQueue *vq, int i, uint32_t val)
{
A
Avi Kivity 已提交
176
    hwaddr pa;
A
aliguori 已提交
177
    pa = vq->vring.used + offsetof(VRingUsed, ring[i].len);
178
    virtio_stl_phys(vq->vdev, pa, val);
A
aliguori 已提交
179 180 181 182
}

static uint16_t vring_used_idx(VirtQueue *vq)
{
A
Avi Kivity 已提交
183
    hwaddr pa;
A
aliguori 已提交
184
    pa = vq->vring.used + offsetof(VRingUsed, idx);
185
    return virtio_lduw_phys(vq->vdev, pa);
A
aliguori 已提交
186 187
}

M
Michael S. Tsirkin 已提交
188
static inline void vring_used_idx_set(VirtQueue *vq, uint16_t val)
A
aliguori 已提交
189
{
A
Avi Kivity 已提交
190
    hwaddr pa;
A
aliguori 已提交
191
    pa = vq->vring.used + offsetof(VRingUsed, idx);
192
    virtio_stw_phys(vq->vdev, pa, val);
A
aliguori 已提交
193 194 195 196
}

static inline void vring_used_flags_set_bit(VirtQueue *vq, int mask)
{
197
    VirtIODevice *vdev = vq->vdev;
A
Avi Kivity 已提交
198
    hwaddr pa;
A
aliguori 已提交
199
    pa = vq->vring.used + offsetof(VRingUsed, flags);
200
    virtio_stw_phys(vdev, pa, virtio_lduw_phys(vdev, pa) | mask);
A
aliguori 已提交
201 202 203 204
}

static inline void vring_used_flags_unset_bit(VirtQueue *vq, int mask)
{
205
    VirtIODevice *vdev = vq->vdev;
A
Avi Kivity 已提交
206
    hwaddr pa;
A
aliguori 已提交
207
    pa = vq->vring.used + offsetof(VRingUsed, flags);
208
    virtio_stw_phys(vdev, pa, virtio_lduw_phys(vdev, pa) & ~mask);
A
aliguori 已提交
209 210
}

211
static inline void vring_set_avail_event(VirtQueue *vq, uint16_t val)
M
Michael S. Tsirkin 已提交
212
{
A
Avi Kivity 已提交
213
    hwaddr pa;
M
Michael S. Tsirkin 已提交
214 215 216 217
    if (!vq->notification) {
        return;
    }
    pa = vq->vring.used + offsetof(VRingUsed, ring[vq->vring.num]);
218
    virtio_stw_phys(vq->vdev, pa, val);
M
Michael S. Tsirkin 已提交
219 220
}

A
aliguori 已提交
221 222
void virtio_queue_set_notification(VirtQueue *vq, int enable)
{
M
Michael S. Tsirkin 已提交
223
    vq->notification = enable;
224
    if (virtio_vdev_has_feature(vq->vdev, VIRTIO_RING_F_EVENT_IDX)) {
225
        vring_set_avail_event(vq, vring_avail_idx(vq));
M
Michael S. Tsirkin 已提交
226
    } else if (enable) {
A
aliguori 已提交
227
        vring_used_flags_unset_bit(vq, VRING_USED_F_NO_NOTIFY);
M
Michael S. Tsirkin 已提交
228
    } else {
A
aliguori 已提交
229
        vring_used_flags_set_bit(vq, VRING_USED_F_NO_NOTIFY);
M
Michael S. Tsirkin 已提交
230
    }
231 232 233 234
    if (enable) {
        /* Expose avail event/used flags before caller checks the avail idx. */
        smp_mb();
    }
A
aliguori 已提交
235 236 237 238 239 240 241 242 243 244 245 246
}

int virtio_queue_ready(VirtQueue *vq)
{
    return vq->vring.avail != 0;
}

int virtio_queue_empty(VirtQueue *vq)
{
    return vring_avail_idx(vq) == vq->last_avail_idx;
}

247 248
static void virtqueue_unmap_sg(VirtQueue *vq, const VirtQueueElement *elem,
                               unsigned int len)
A
aliguori 已提交
249 250 251 252 253 254 255 256
{
    unsigned int offset;
    int i;

    offset = 0;
    for (i = 0; i < elem->in_num; i++) {
        size_t size = MIN(len - offset, elem->in_sg[i].iov_len);

257 258 259
        cpu_physical_memory_unmap(elem->in_sg[i].iov_base,
                                  elem->in_sg[i].iov_len,
                                  1, size);
A
aliguori 已提交
260

261
        offset += size;
A
aliguori 已提交
262 263
    }

264 265 266 267
    for (i = 0; i < elem->out_num; i++)
        cpu_physical_memory_unmap(elem->out_sg[i].iov_base,
                                  elem->out_sg[i].iov_len,
                                  0, elem->out_sg[i].iov_len);
268 269 270 271 272 273 274 275
}

void virtqueue_fill(VirtQueue *vq, const VirtQueueElement *elem,
                    unsigned int len, unsigned int idx)
{
    trace_virtqueue_fill(vq, elem, len, idx);

    virtqueue_unmap_sg(vq, elem, len);
276

A
aliguori 已提交
277 278 279 280 281 282 283 284 285
    idx = (idx + vring_used_idx(vq)) % vq->vring.num;

    /* Get a pointer to the next entry in the used ring. */
    vring_used_ring_id(vq, idx, elem->index);
    vring_used_ring_len(vq, idx, len);
}

void virtqueue_flush(VirtQueue *vq, unsigned int count)
{
M
Michael S. Tsirkin 已提交
286
    uint16_t old, new;
A
aliguori 已提交
287
    /* Make sure buffer is written before we update index. */
288
    smp_wmb();
289
    trace_virtqueue_flush(vq, count);
M
Michael S. Tsirkin 已提交
290 291 292
    old = vring_used_idx(vq);
    new = old + count;
    vring_used_idx_set(vq, new);
A
aliguori 已提交
293
    vq->inuse -= count;
M
Michael S. Tsirkin 已提交
294 295
    if (unlikely((int16_t)(new - vq->signalled_used) < (uint16_t)(new - old)))
        vq->signalled_used_valid = false;
A
aliguori 已提交
296 297 298 299 300 301 302 303 304 305 306 307 308 309
}

void virtqueue_push(VirtQueue *vq, const VirtQueueElement *elem,
                    unsigned int len)
{
    virtqueue_fill(vq, elem, len, 0);
    virtqueue_flush(vq, 1);
}

static int virtqueue_num_heads(VirtQueue *vq, unsigned int idx)
{
    uint16_t num_heads = vring_avail_idx(vq) - idx;

    /* Check it isn't doing very strange things with descriptor numbers. */
A
aliguori 已提交
310
    if (num_heads > vq->vring.num) {
311 312
        error_report("Guest moved used index from %u to %u",
                     idx, vring_avail_idx(vq));
A
aliguori 已提交
313 314
        exit(1);
    }
315 316 317 318 319
    /* On success, callers read a descriptor at vq->last_avail_idx.
     * Make sure descriptor read does not bypass avail index read. */
    if (num_heads) {
        smp_rmb();
    }
A
aliguori 已提交
320 321 322 323 324 325 326 327 328 329 330 331 332

    return num_heads;
}

static unsigned int virtqueue_get_head(VirtQueue *vq, unsigned int idx)
{
    unsigned int head;

    /* Grab the next descriptor number they're advertising, and increment
     * the index we've seen. */
    head = vring_avail_ring(vq, idx % vq->vring.num);

    /* If their number is silly, that's a fatal mistake. */
A
aliguori 已提交
333
    if (head >= vq->vring.num) {
334
        error_report("Guest says index %u is available", head);
A
aliguori 已提交
335 336
        exit(1);
    }
A
aliguori 已提交
337 338 339 340

    return head;
}

341
static unsigned virtqueue_next_desc(VirtIODevice *vdev, hwaddr desc_pa,
342
                                    unsigned int i, unsigned int max)
A
aliguori 已提交
343 344 345 346
{
    unsigned int next;

    /* If this descriptor says it doesn't chain, we're done. */
347
    if (!(vring_desc_flags(vdev, desc_pa, i) & VRING_DESC_F_NEXT)) {
348
        return max;
349
    }
A
aliguori 已提交
350 351

    /* Check they're not leading us off end of descriptors. */
352
    next = vring_desc_next(vdev, desc_pa, i);
A
aliguori 已提交
353
    /* Make sure compiler knows to grab that: we don't want it changing! */
354
    smp_wmb();
A
aliguori 已提交
355

356
    if (next >= max) {
357
        error_report("Desc next is %u", next);
A
aliguori 已提交
358 359
        exit(1);
    }
A
aliguori 已提交
360 361 362 363

    return next;
}

364
void virtqueue_get_avail_bytes(VirtQueue *vq, unsigned int *in_bytes,
365 366
                               unsigned int *out_bytes,
                               unsigned max_in_bytes, unsigned max_out_bytes)
A
aliguori 已提交
367
{
368
    unsigned int idx;
369
    unsigned int total_bufs, in_total, out_total;
A
aliguori 已提交
370 371 372

    idx = vq->last_avail_idx;

373
    total_bufs = in_total = out_total = 0;
A
aliguori 已提交
374
    while (virtqueue_num_heads(vq, idx)) {
375
        VirtIODevice *vdev = vq->vdev;
376
        unsigned int max, num_bufs, indirect = 0;
A
Avi Kivity 已提交
377
        hwaddr desc_pa;
A
aliguori 已提交
378 379
        int i;

380 381
        max = vq->vring.num;
        num_bufs = total_bufs;
A
aliguori 已提交
382
        i = virtqueue_get_head(vq, idx++);
383 384
        desc_pa = vq->vring.desc;

385 386
        if (vring_desc_flags(vdev, desc_pa, i) & VRING_DESC_F_INDIRECT) {
            if (vring_desc_len(vdev, desc_pa, i) % sizeof(VRingDesc)) {
387
                error_report("Invalid size for indirect buffer table");
388 389 390 391 392
                exit(1);
            }

            /* If we've got too many, that implies a descriptor loop. */
            if (num_bufs >= max) {
393
                error_report("Looped descriptor");
394 395 396 397 398
                exit(1);
            }

            /* loop over the indirect descriptor table */
            indirect = 1;
399 400
            max = vring_desc_len(vdev, desc_pa, i) / sizeof(VRingDesc);
            desc_pa = vring_desc_addr(vdev, desc_pa, i);
401
            num_bufs = i = 0;
402 403
        }

A
aliguori 已提交
404 405
        do {
            /* If we've got too many, that implies a descriptor loop. */
406
            if (++num_bufs > max) {
407
                error_report("Looped descriptor");
A
aliguori 已提交
408 409
                exit(1);
            }
A
aliguori 已提交
410

411 412
            if (vring_desc_flags(vdev, desc_pa, i) & VRING_DESC_F_WRITE) {
                in_total += vring_desc_len(vdev, desc_pa, i);
A
aliguori 已提交
413
            } else {
414
                out_total += vring_desc_len(vdev, desc_pa, i);
A
aliguori 已提交
415
            }
416 417 418
            if (in_total >= max_in_bytes && out_total >= max_out_bytes) {
                goto done;
            }
419
        } while ((i = virtqueue_next_desc(vdev, desc_pa, i, max)) != max);
420 421 422 423 424

        if (!indirect)
            total_bufs = num_bufs;
        else
            total_bufs++;
A
aliguori 已提交
425
    }
426
done:
427 428 429 430 431 432 433
    if (in_bytes) {
        *in_bytes = in_total;
    }
    if (out_bytes) {
        *out_bytes = out_total;
    }
}
A
aliguori 已提交
434

435 436 437 438 439
int virtqueue_avail_bytes(VirtQueue *vq, unsigned int in_bytes,
                          unsigned int out_bytes)
{
    unsigned int in_total, out_total;

440 441
    virtqueue_get_avail_bytes(vq, &in_total, &out_total, in_bytes, out_bytes);
    return in_bytes <= in_total && out_bytes <= out_total;
A
aliguori 已提交
442 443
}

A
Avi Kivity 已提交
444
void virtqueue_map_sg(struct iovec *sg, hwaddr *addr,
K
Kevin Wolf 已提交
445 446 447
    size_t num_sg, int is_write)
{
    unsigned int i;
A
Avi Kivity 已提交
448
    hwaddr len;
K
Kevin Wolf 已提交
449

450
    if (num_sg > VIRTQUEUE_MAX_SIZE) {
451 452 453 454 455
        error_report("virtio: map attempt out of bounds: %zd > %d",
                     num_sg, VIRTQUEUE_MAX_SIZE);
        exit(1);
    }

K
Kevin Wolf 已提交
456 457 458 459
    for (i = 0; i < num_sg; i++) {
        len = sg[i].iov_len;
        sg[i].iov_base = cpu_physical_memory_map(addr[i], &len, is_write);
        if (sg[i].iov_base == NULL || len != sg[i].iov_len) {
M
Michael Tokarev 已提交
460
            error_report("virtio: error trying to map MMIO memory");
K
Kevin Wolf 已提交
461 462 463 464 465
            exit(1);
        }
    }
}

A
aliguori 已提交
466 467
int virtqueue_pop(VirtQueue *vq, VirtQueueElement *elem)
{
468
    unsigned int i, head, max;
A
Avi Kivity 已提交
469
    hwaddr desc_pa = vq->vring.desc;
470
    VirtIODevice *vdev = vq->vdev;
A
aliguori 已提交
471 472 473 474 475 476 477

    if (!virtqueue_num_heads(vq, vq->last_avail_idx))
        return 0;

    /* When we start there are none of either input nor output. */
    elem->out_num = elem->in_num = 0;

478 479
    max = vq->vring.num;

A
aliguori 已提交
480
    i = head = virtqueue_get_head(vq, vq->last_avail_idx++);
481
    if (virtio_vdev_has_feature(vdev, VIRTIO_RING_F_EVENT_IDX)) {
482
        vring_set_avail_event(vq, vq->last_avail_idx);
M
Michael S. Tsirkin 已提交
483
    }
484

485 486
    if (vring_desc_flags(vdev, desc_pa, i) & VRING_DESC_F_INDIRECT) {
        if (vring_desc_len(vdev, desc_pa, i) % sizeof(VRingDesc)) {
487
            error_report("Invalid size for indirect buffer table");
488 489 490 491
            exit(1);
        }

        /* loop over the indirect descriptor table */
492 493
        max = vring_desc_len(vdev, desc_pa, i) / sizeof(VRingDesc);
        desc_pa = vring_desc_addr(vdev, desc_pa, i);
494 495 496
        i = 0;
    }

K
Kevin Wolf 已提交
497
    /* Collect all the descriptors */
A
aliguori 已提交
498 499 500
    do {
        struct iovec *sg;

501
        if (vring_desc_flags(vdev, desc_pa, i) & VRING_DESC_F_WRITE) {
502 503 504 505
            if (elem->in_num >= ARRAY_SIZE(elem->in_sg)) {
                error_report("Too many write descriptors in indirect table");
                exit(1);
            }
506
            elem->in_addr[elem->in_num] = vring_desc_addr(vdev, desc_pa, i);
A
aliguori 已提交
507
            sg = &elem->in_sg[elem->in_num++];
K
Kevin Wolf 已提交
508
        } else {
509 510 511 512
            if (elem->out_num >= ARRAY_SIZE(elem->out_sg)) {
                error_report("Too many read descriptors in indirect table");
                exit(1);
            }
513
            elem->out_addr[elem->out_num] = vring_desc_addr(vdev, desc_pa, i);
A
aliguori 已提交
514
            sg = &elem->out_sg[elem->out_num++];
K
Kevin Wolf 已提交
515
        }
A
aliguori 已提交
516

517
        sg->iov_len = vring_desc_len(vdev, desc_pa, i);
A
aliguori 已提交
518 519

        /* If we've got too many, that implies a descriptor loop. */
520
        if ((elem->in_num + elem->out_num) > max) {
521
            error_report("Looped descriptor");
A
aliguori 已提交
522 523
            exit(1);
        }
524
    } while ((i = virtqueue_next_desc(vdev, desc_pa, i, max)) != max);
A
aliguori 已提交
525

K
Kevin Wolf 已提交
526 527 528 529
    /* Now map what we have collected */
    virtqueue_map_sg(elem->in_sg, elem->in_addr, elem->in_num, 1);
    virtqueue_map_sg(elem->out_sg, elem->out_addr, elem->out_num, 0);

A
aliguori 已提交
530 531 532 533
    elem->index = head;

    vq->inuse++;

534
    trace_virtqueue_pop(vq, elem, elem->in_num, elem->out_num);
A
aliguori 已提交
535 536 537 538
    return elem->in_num + elem->out_num;
}

/* virtio device */
539 540
static void virtio_notify_vector(VirtIODevice *vdev, uint16_t vector)
{
K
KONRAD Frederic 已提交
541 542 543 544 545
    BusState *qbus = qdev_get_parent_bus(DEVICE(vdev));
    VirtioBusClass *k = VIRTIO_BUS_GET_CLASS(qbus);

    if (k->notify) {
        k->notify(qbus->parent, vector);
546 547
    }
}
A
aliguori 已提交
548

P
Paul Brook 已提交
549
void virtio_update_irq(VirtIODevice *vdev)
A
aliguori 已提交
550
{
551
    virtio_notify_vector(vdev, VIRTIO_NO_VECTOR);
A
aliguori 已提交
552 553
}

554 555 556 557 558 559 560 561 562 563 564 565
static int virtio_validate_features(VirtIODevice *vdev)
{
    VirtioDeviceClass *k = VIRTIO_DEVICE_GET_CLASS(vdev);

    if (k->validate_features) {
        return k->validate_features(vdev);
    } else {
        return 0;
    }
}

int virtio_set_status(VirtIODevice *vdev, uint8_t val)
566
{
567
    VirtioDeviceClass *k = VIRTIO_DEVICE_GET_CLASS(vdev);
568 569
    trace_virtio_set_status(vdev, val);

570
    if (virtio_vdev_has_feature(vdev, VIRTIO_F_VERSION_1)) {
571 572 573 574 575 576 577 578 579
        if (!(vdev->status & VIRTIO_CONFIG_S_FEATURES_OK) &&
            val & VIRTIO_CONFIG_S_FEATURES_OK) {
            int ret = virtio_validate_features(vdev);

            if (ret) {
                return ret;
            }
        }
    }
580 581
    if (k->set_status) {
        k->set_status(vdev, val);
582 583
    }
    vdev->status = val;
584
    return 0;
585 586
}

587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607
bool target_words_bigendian(void);
static enum virtio_device_endian virtio_default_endian(void)
{
    if (target_words_bigendian()) {
        return VIRTIO_DEVICE_ENDIAN_BIG;
    } else {
        return VIRTIO_DEVICE_ENDIAN_LITTLE;
    }
}

static enum virtio_device_endian virtio_current_cpu_endian(void)
{
    CPUClass *cc = CPU_GET_CLASS(current_cpu);

    if (cc->virtio_is_big_endian(current_cpu)) {
        return VIRTIO_DEVICE_ENDIAN_BIG;
    } else {
        return VIRTIO_DEVICE_ENDIAN_LITTLE;
    }
}

P
Paul Brook 已提交
608
void virtio_reset(void *opaque)
A
aliguori 已提交
609 610
{
    VirtIODevice *vdev = opaque;
611
    VirtioDeviceClass *k = VIRTIO_DEVICE_GET_CLASS(vdev);
A
aliguori 已提交
612 613
    int i;

614
    virtio_set_status(vdev, 0);
615 616 617 618 619 620 621
    if (current_cpu) {
        /* Guest initiated reset */
        vdev->device_endian = virtio_current_cpu_endian();
    } else {
        /* System reset */
        vdev->device_endian = virtio_default_endian();
    }
622

623 624 625
    if (k->reset) {
        k->reset(vdev);
    }
A
aliguori 已提交
626

627
    vdev->guest_features = 0;
A
aliguori 已提交
628 629 630
    vdev->queue_sel = 0;
    vdev->status = 0;
    vdev->isr = 0;
631 632
    vdev->config_vector = VIRTIO_NO_VECTOR;
    virtio_notify_vector(vdev, vdev->config_vector);
A
aliguori 已提交
633

634
    for(i = 0; i < VIRTIO_QUEUE_MAX; i++) {
A
aliguori 已提交
635 636 637 638
        vdev->vq[i].vring.desc = 0;
        vdev->vq[i].vring.avail = 0;
        vdev->vq[i].vring.used = 0;
        vdev->vq[i].last_avail_idx = 0;
639
        virtio_queue_set_vector(vdev, i, VIRTIO_NO_VECTOR);
M
Michael S. Tsirkin 已提交
640 641 642
        vdev->vq[i].signalled_used = 0;
        vdev->vq[i].signalled_used_valid = false;
        vdev->vq[i].notification = true;
C
Cornelia Huck 已提交
643
        vdev->vq[i].vring.num = vdev->vq[i].vring.num_default;
A
aliguori 已提交
644 645 646
    }
}

P
Paul Brook 已提交
647
uint32_t virtio_config_readb(VirtIODevice *vdev, uint32_t addr)
A
aliguori 已提交
648
{
649
    VirtioDeviceClass *k = VIRTIO_DEVICE_GET_CLASS(vdev);
A
aliguori 已提交
650 651
    uint8_t val;

652
    if (addr + sizeof(val) > vdev->config_len) {
A
aliguori 已提交
653
        return (uint32_t)-1;
654 655 656
    }

    k->get_config(vdev, vdev->config);
A
aliguori 已提交
657

658
    val = ldub_p(vdev->config + addr);
A
aliguori 已提交
659 660 661
    return val;
}

P
Paul Brook 已提交
662
uint32_t virtio_config_readw(VirtIODevice *vdev, uint32_t addr)
A
aliguori 已提交
663
{
664
    VirtioDeviceClass *k = VIRTIO_DEVICE_GET_CLASS(vdev);
A
aliguori 已提交
665 666
    uint16_t val;

667
    if (addr + sizeof(val) > vdev->config_len) {
A
aliguori 已提交
668
        return (uint32_t)-1;
669 670 671
    }

    k->get_config(vdev, vdev->config);
A
aliguori 已提交
672

673
    val = lduw_p(vdev->config + addr);
A
aliguori 已提交
674 675 676
    return val;
}

P
Paul Brook 已提交
677
uint32_t virtio_config_readl(VirtIODevice *vdev, uint32_t addr)
A
aliguori 已提交
678
{
679
    VirtioDeviceClass *k = VIRTIO_DEVICE_GET_CLASS(vdev);
A
aliguori 已提交
680 681
    uint32_t val;

682
    if (addr + sizeof(val) > vdev->config_len) {
A
aliguori 已提交
683
        return (uint32_t)-1;
684 685 686
    }

    k->get_config(vdev, vdev->config);
A
aliguori 已提交
687

688
    val = ldl_p(vdev->config + addr);
A
aliguori 已提交
689 690 691
    return val;
}

P
Paul Brook 已提交
692
void virtio_config_writeb(VirtIODevice *vdev, uint32_t addr, uint32_t data)
A
aliguori 已提交
693
{
694
    VirtioDeviceClass *k = VIRTIO_DEVICE_GET_CLASS(vdev);
A
aliguori 已提交
695 696
    uint8_t val = data;

697
    if (addr + sizeof(val) > vdev->config_len) {
A
aliguori 已提交
698
        return;
699
    }
A
aliguori 已提交
700

701
    stb_p(vdev->config + addr, val);
A
aliguori 已提交
702

703 704 705
    if (k->set_config) {
        k->set_config(vdev, vdev->config);
    }
A
aliguori 已提交
706 707
}

P
Paul Brook 已提交
708
void virtio_config_writew(VirtIODevice *vdev, uint32_t addr, uint32_t data)
A
aliguori 已提交
709
{
710
    VirtioDeviceClass *k = VIRTIO_DEVICE_GET_CLASS(vdev);
A
aliguori 已提交
711 712
    uint16_t val = data;

713
    if (addr + sizeof(val) > vdev->config_len) {
A
aliguori 已提交
714
        return;
715
    }
A
aliguori 已提交
716

717
    stw_p(vdev->config + addr, val);
A
aliguori 已提交
718

719 720 721
    if (k->set_config) {
        k->set_config(vdev, vdev->config);
    }
A
aliguori 已提交
722 723
}

P
Paul Brook 已提交
724
void virtio_config_writel(VirtIODevice *vdev, uint32_t addr, uint32_t data)
A
aliguori 已提交
725
{
726
    VirtioDeviceClass *k = VIRTIO_DEVICE_GET_CLASS(vdev);
A
aliguori 已提交
727 728
    uint32_t val = data;

729
    if (addr + sizeof(val) > vdev->config_len) {
A
aliguori 已提交
730
        return;
731
    }
A
aliguori 已提交
732

733
    stl_p(vdev->config + addr, val);
A
aliguori 已提交
734

735 736 737
    if (k->set_config) {
        k->set_config(vdev, vdev->config);
    }
A
aliguori 已提交
738 739
}

740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835
uint32_t virtio_config_modern_readb(VirtIODevice *vdev, uint32_t addr)
{
    VirtioDeviceClass *k = VIRTIO_DEVICE_GET_CLASS(vdev);
    uint8_t val;

    if (addr + sizeof(val) > vdev->config_len) {
        return (uint32_t)-1;
    }

    k->get_config(vdev, vdev->config);

    val = ldub_p(vdev->config + addr);
    return val;
}

uint32_t virtio_config_modern_readw(VirtIODevice *vdev, uint32_t addr)
{
    VirtioDeviceClass *k = VIRTIO_DEVICE_GET_CLASS(vdev);
    uint16_t val;

    if (addr + sizeof(val) > vdev->config_len) {
        return (uint32_t)-1;
    }

    k->get_config(vdev, vdev->config);

    val = lduw_le_p(vdev->config + addr);
    return val;
}

uint32_t virtio_config_modern_readl(VirtIODevice *vdev, uint32_t addr)
{
    VirtioDeviceClass *k = VIRTIO_DEVICE_GET_CLASS(vdev);
    uint32_t val;

    if (addr + sizeof(val) > vdev->config_len) {
        return (uint32_t)-1;
    }

    k->get_config(vdev, vdev->config);

    val = ldl_le_p(vdev->config + addr);
    return val;
}

void virtio_config_modern_writeb(VirtIODevice *vdev,
                                 uint32_t addr, uint32_t data)
{
    VirtioDeviceClass *k = VIRTIO_DEVICE_GET_CLASS(vdev);
    uint8_t val = data;

    if (addr + sizeof(val) > vdev->config_len) {
        return;
    }

    stb_p(vdev->config + addr, val);

    if (k->set_config) {
        k->set_config(vdev, vdev->config);
    }
}

void virtio_config_modern_writew(VirtIODevice *vdev,
                                 uint32_t addr, uint32_t data)
{
    VirtioDeviceClass *k = VIRTIO_DEVICE_GET_CLASS(vdev);
    uint16_t val = data;

    if (addr + sizeof(val) > vdev->config_len) {
        return;
    }

    stw_le_p(vdev->config + addr, val);

    if (k->set_config) {
        k->set_config(vdev, vdev->config);
    }
}

void virtio_config_modern_writel(VirtIODevice *vdev,
                                 uint32_t addr, uint32_t data)
{
    VirtioDeviceClass *k = VIRTIO_DEVICE_GET_CLASS(vdev);
    uint32_t val = data;

    if (addr + sizeof(val) > vdev->config_len) {
        return;
    }

    stl_le_p(vdev->config + addr, val);

    if (k->set_config) {
        k->set_config(vdev, vdev->config);
    }
}

A
Avi Kivity 已提交
836
void virtio_queue_set_addr(VirtIODevice *vdev, int n, hwaddr addr)
A
aliguori 已提交
837
{
838 839
    vdev->vq[n].vring.desc = addr;
    virtio_queue_update_rings(vdev, n);
P
Paul Brook 已提交
840 841
}

A
Avi Kivity 已提交
842
hwaddr virtio_queue_get_addr(VirtIODevice *vdev, int n)
P
Paul Brook 已提交
843
{
844 845 846 847 848 849 850 851 852
    return vdev->vq[n].vring.desc;
}

void virtio_queue_set_rings(VirtIODevice *vdev, int n, hwaddr desc,
                            hwaddr avail, hwaddr used)
{
    vdev->vq[n].vring.desc = desc;
    vdev->vq[n].vring.avail = avail;
    vdev->vq[n].vring.used = used;
P
Paul Brook 已提交
853 854
}

855 856
void virtio_queue_set_num(VirtIODevice *vdev, int n, int num)
{
857 858 859 860 861 862 863
    /* Don't allow guest to flip queue between existent and
     * nonexistent states, or to set it to an invalid size.
     */
    if (!!num != !!vdev->vq[n].vring.num ||
        num > VIRTQUEUE_MAX_SIZE ||
        num < 0) {
        return;
864
    }
865
    vdev->vq[n].vring.num = num;
866 867
}

868 869 870 871 872 873 874 875 876 877
VirtQueue *virtio_vector_first_queue(VirtIODevice *vdev, uint16_t vector)
{
    return QLIST_FIRST(&vdev->vector_queues[vector]);
}

VirtQueue *virtio_vector_next_queue(VirtQueue *vq)
{
    return QLIST_NEXT(vq, node);
}

P
Paul Brook 已提交
878 879 880 881
int virtio_queue_get_num(VirtIODevice *vdev, int n)
{
    return vdev->vq[n].vring.num;
}
A
aliguori 已提交
882

883 884 885 886
int virtio_get_num_queues(VirtIODevice *vdev)
{
    int i;

887
    for (i = 0; i < VIRTIO_QUEUE_MAX; i++) {
888 889 890 891 892 893 894 895
        if (!virtio_queue_get_num(vdev, i)) {
            break;
        }
    }

    return i;
}

P
Paolo Bonzini 已提交
896 897 898
int virtio_queue_get_id(VirtQueue *vq)
{
    VirtIODevice *vdev = vq->vdev;
899
    assert(vq >= &vdev->vq[0] && vq < &vdev->vq[VIRTIO_QUEUE_MAX]);
P
Paolo Bonzini 已提交
900 901 902
    return vq - &vdev->vq[0];
}

903 904 905 906 907
void virtio_queue_set_align(VirtIODevice *vdev, int n, int align)
{
    BusState *qbus = qdev_get_parent_bus(DEVICE(vdev));
    VirtioBusClass *k = VIRTIO_BUS_GET_CLASS(qbus);

908
    /* virtio-1 compliant devices cannot change the alignment */
909
    if (virtio_vdev_has_feature(vdev, VIRTIO_F_VERSION_1)) {
910 911 912
        error_report("tried to modify queue alignment for virtio-1 device");
        return;
    }
913 914 915 916 917 918 919
    /* Check that the transport told us it was going to do this
     * (so a buggy transport will immediately assert rather than
     * silently failing to migrate this state)
     */
    assert(k->has_variable_vring_alignment);

    vdev->vq[n].vring.align = align;
920
    virtio_queue_update_rings(vdev, n);
921 922
}

923 924
void virtio_queue_notify_vq(VirtQueue *vq)
{
925
    if (vq->vring.desc && vq->handle_output) {
926
        VirtIODevice *vdev = vq->vdev;
927

928 929 930 931 932
        trace_virtio_queue_notify(vdev, vq - vdev->vq, vq);
        vq->handle_output(vdev, vq);
    }
}

P
Paul Brook 已提交
933 934
void virtio_queue_notify(VirtIODevice *vdev, int n)
{
935
    virtio_queue_notify_vq(&vdev->vq[n]);
A
aliguori 已提交
936 937
}

938 939
uint16_t virtio_queue_vector(VirtIODevice *vdev, int n)
{
940
    return n < VIRTIO_QUEUE_MAX ? vdev->vq[n].vector :
941 942 943 944 945
        VIRTIO_NO_VECTOR;
}

void virtio_queue_set_vector(VirtIODevice *vdev, int n, uint16_t vector)
{
946 947
    VirtQueue *vq = &vdev->vq[n];

948
    if (n < VIRTIO_QUEUE_MAX) {
949 950 951 952
        if (vdev->vector_queues &&
            vdev->vq[n].vector != VIRTIO_NO_VECTOR) {
            QLIST_REMOVE(vq, node);
        }
953
        vdev->vq[n].vector = vector;
954 955 956 957 958
        if (vdev->vector_queues &&
            vector != VIRTIO_NO_VECTOR) {
            QLIST_INSERT_HEAD(&vdev->vector_queues[vector], vq, node);
        }
    }
959 960
}

A
aliguori 已提交
961 962 963 964 965
VirtQueue *virtio_add_queue(VirtIODevice *vdev, int queue_size,
                            void (*handle_output)(VirtIODevice *, VirtQueue *))
{
    int i;

966
    for (i = 0; i < VIRTIO_QUEUE_MAX; i++) {
A
aliguori 已提交
967 968 969 970
        if (vdev->vq[i].vring.num == 0)
            break;
    }

971
    if (i == VIRTIO_QUEUE_MAX || queue_size > VIRTQUEUE_MAX_SIZE)
A
aliguori 已提交
972 973 974
        abort();

    vdev->vq[i].vring.num = queue_size;
C
Cornelia Huck 已提交
975
    vdev->vq[i].vring.num_default = queue_size;
976
    vdev->vq[i].vring.align = VIRTIO_PCI_VRING_ALIGN;
A
aliguori 已提交
977 978 979 980 981
    vdev->vq[i].handle_output = handle_output;

    return &vdev->vq[i];
}

982 983
void virtio_del_queue(VirtIODevice *vdev, int n)
{
984
    if (n < 0 || n >= VIRTIO_QUEUE_MAX) {
985 986 987 988
        abort();
    }

    vdev->vq[n].vring.num = 0;
C
Cornelia Huck 已提交
989
    vdev->vq[n].vring.num_default = 0;
990 991
}

992 993
void virtio_irq(VirtQueue *vq)
{
994
    trace_virtio_irq(vq);
995 996 997 998
    vq->vdev->isr |= 0x01;
    virtio_notify_vector(vq->vdev, vq->vector);
}

M
Michael S. Tsirkin 已提交
999 1000 1001 1002
static bool vring_notify(VirtIODevice *vdev, VirtQueue *vq)
{
    uint16_t old, new;
    bool v;
1003 1004
    /* We need to expose used array entries before checking used event. */
    smp_mb();
1005
    /* Always notify when queue is empty (when feature acknowledge) */
1006
    if (virtio_vdev_has_feature(vdev, VIRTIO_F_NOTIFY_ON_EMPTY) &&
1007
        !vq->inuse && vring_avail_idx(vq) == vq->last_avail_idx) {
M
Michael S. Tsirkin 已提交
1008 1009 1010
        return true;
    }

1011
    if (!virtio_vdev_has_feature(vdev, VIRTIO_RING_F_EVENT_IDX)) {
M
Michael S. Tsirkin 已提交
1012 1013 1014 1015 1016 1017 1018
        return !(vring_avail_flags(vq) & VRING_AVAIL_F_NO_INTERRUPT);
    }

    v = vq->signalled_used_valid;
    vq->signalled_used_valid = true;
    old = vq->signalled_used;
    new = vq->signalled_used = vring_used_idx(vq);
1019
    return !v || vring_need_event(vring_get_used_event(vq), new, old);
M
Michael S. Tsirkin 已提交
1020 1021 1022 1023 1024
}

void virtio_notify(VirtIODevice *vdev, VirtQueue *vq)
{
    if (!vring_notify(vdev, vq)) {
A
aliguori 已提交
1025
        return;
M
Michael S. Tsirkin 已提交
1026
    }
A
aliguori 已提交
1027

1028
    trace_virtio_notify(vdev, vq);
A
aliguori 已提交
1029
    vdev->isr |= 0x01;
1030
    virtio_notify_vector(vdev, vq->vector);
A
aliguori 已提交
1031 1032 1033 1034
}

void virtio_notify_config(VirtIODevice *vdev)
{
1035 1036 1037
    if (!(vdev->status & VIRTIO_CONFIG_S_DRIVER_OK))
        return;

A
aliguori 已提交
1038
    vdev->isr |= 0x03;
1039
    vdev->generation++;
1040
    virtio_notify_vector(vdev, vdev->config_vector);
A
aliguori 已提交
1041 1042
}

1043 1044 1045 1046 1047
static bool virtio_device_endian_needed(void *opaque)
{
    VirtIODevice *vdev = opaque;

    assert(vdev->device_endian != VIRTIO_DEVICE_ENDIAN_UNKNOWN);
1048
    if (!virtio_vdev_has_feature(vdev, VIRTIO_F_VERSION_1)) {
1049 1050 1051 1052
        return vdev->device_endian != virtio_default_endian();
    }
    /* Devices conforming to VIRTIO 1.0 or later are always LE. */
    return vdev->device_endian != VIRTIO_DEVICE_ENDIAN_LITTLE;
1053 1054
}

G
Gerd Hoffmann 已提交
1055 1056 1057 1058 1059 1060 1061
static bool virtio_64bit_features_needed(void *opaque)
{
    VirtIODevice *vdev = opaque;

    return (vdev->host_features >> 32) != 0;
}

J
Jason Wang 已提交
1062 1063 1064 1065 1066 1067 1068
static bool virtio_virtqueue_needed(void *opaque)
{
    VirtIODevice *vdev = opaque;

    return virtio_host_has_feature(vdev, VIRTIO_F_VERSION_1);
}

C
Cornelia Huck 已提交
1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081
static bool virtio_ringsize_needed(void *opaque)
{
    VirtIODevice *vdev = opaque;
    int i;

    for (i = 0; i < VIRTIO_QUEUE_MAX; i++) {
        if (vdev->vq[i].vring.num != vdev->vq[i].vring.num_default) {
            return true;
        }
    }
    return false;
}

J
Jason Wang 已提交
1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129
static void put_virtqueue_state(QEMUFile *f, void *pv, size_t size)
{
    VirtIODevice *vdev = pv;
    int i;

    for (i = 0; i < VIRTIO_QUEUE_MAX; i++) {
        qemu_put_be64(f, vdev->vq[i].vring.avail);
        qemu_put_be64(f, vdev->vq[i].vring.used);
    }
}

static int get_virtqueue_state(QEMUFile *f, void *pv, size_t size)
{
    VirtIODevice *vdev = pv;
    int i;

    for (i = 0; i < VIRTIO_QUEUE_MAX; i++) {
        vdev->vq[i].vring.avail = qemu_get_be64(f);
        vdev->vq[i].vring.used = qemu_get_be64(f);
    }
    return 0;
}

static VMStateInfo vmstate_info_virtqueue = {
    .name = "virtqueue_state",
    .get = get_virtqueue_state,
    .put = put_virtqueue_state,
};

static const VMStateDescription vmstate_virtio_virtqueues = {
    .name = "virtio/virtqueues",
    .version_id = 1,
    .minimum_version_id = 1,
    .needed = &virtio_virtqueue_needed,
    .fields = (VMStateField[]) {
        {
            .name         = "virtqueues",
            .version_id   = 0,
            .field_exists = NULL,
            .size         = 0,
            .info         = &vmstate_info_virtqueue,
            .flags        = VMS_SINGLE,
            .offset       = 0,
        },
        VMSTATE_END_OF_LIST()
    }
};

C
Cornelia Huck 已提交
1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175
static void put_ringsize_state(QEMUFile *f, void *pv, size_t size)
{
    VirtIODevice *vdev = pv;
    int i;

    for (i = 0; i < VIRTIO_QUEUE_MAX; i++) {
        qemu_put_be32(f, vdev->vq[i].vring.num_default);
    }
}

static int get_ringsize_state(QEMUFile *f, void *pv, size_t size)
{
    VirtIODevice *vdev = pv;
    int i;

    for (i = 0; i < VIRTIO_QUEUE_MAX; i++) {
        vdev->vq[i].vring.num_default = qemu_get_be32(f);
    }
    return 0;
}

static VMStateInfo vmstate_info_ringsize = {
    .name = "ringsize_state",
    .get = get_ringsize_state,
    .put = put_ringsize_state,
};

static const VMStateDescription vmstate_virtio_ringsize = {
    .name = "virtio/ringsize",
    .version_id = 1,
    .minimum_version_id = 1,
    .needed = &virtio_ringsize_needed,
    .fields = (VMStateField[]) {
        {
            .name         = "ringsize",
            .version_id   = 0,
            .field_exists = NULL,
            .size         = 0,
            .info         = &vmstate_info_ringsize,
            .flags        = VMS_SINGLE,
            .offset       = 0,
        },
        VMSTATE_END_OF_LIST()
    }
};

1176 1177 1178 1179
static const VMStateDescription vmstate_virtio_device_endian = {
    .name = "virtio/device_endian",
    .version_id = 1,
    .minimum_version_id = 1,
1180
    .needed = &virtio_device_endian_needed,
1181 1182 1183 1184 1185 1186
    .fields = (VMStateField[]) {
        VMSTATE_UINT8(device_endian, VirtIODevice),
        VMSTATE_END_OF_LIST()
    }
};

G
Gerd Hoffmann 已提交
1187 1188 1189 1190
static const VMStateDescription vmstate_virtio_64bit_features = {
    .name = "virtio/64bit_features",
    .version_id = 1,
    .minimum_version_id = 1,
1191
    .needed = &virtio_64bit_features_needed,
G
Gerd Hoffmann 已提交
1192 1193 1194 1195 1196 1197
    .fields = (VMStateField[]) {
        VMSTATE_UINT64(guest_features, VirtIODevice),
        VMSTATE_END_OF_LIST()
    }
};

1198 1199 1200 1201 1202 1203 1204
static const VMStateDescription vmstate_virtio = {
    .name = "virtio",
    .version_id = 1,
    .minimum_version_id = 1,
    .minimum_version_id_old = 1,
    .fields = (VMStateField[]) {
        VMSTATE_END_OF_LIST()
1205
    },
1206 1207 1208
    .subsections = (const VMStateDescription*[]) {
        &vmstate_virtio_device_endian,
        &vmstate_virtio_64bit_features,
J
Jason Wang 已提交
1209
        &vmstate_virtio_virtqueues,
C
Cornelia Huck 已提交
1210
        &vmstate_virtio_ringsize,
1211
        NULL
1212 1213 1214
    }
};

A
aliguori 已提交
1215 1216
void virtio_save(VirtIODevice *vdev, QEMUFile *f)
{
K
KONRAD Frederic 已提交
1217 1218
    BusState *qbus = qdev_get_parent_bus(DEVICE(vdev));
    VirtioBusClass *k = VIRTIO_BUS_GET_CLASS(qbus);
1219
    VirtioDeviceClass *vdc = VIRTIO_DEVICE_GET_CLASS(vdev);
G
Gerd Hoffmann 已提交
1220
    uint32_t guest_features_lo = (vdev->guest_features & 0xffffffff);
A
aliguori 已提交
1221 1222
    int i;

K
KONRAD Frederic 已提交
1223 1224 1225
    if (k->save_config) {
        k->save_config(qbus->parent, f);
    }
A
aliguori 已提交
1226 1227 1228 1229

    qemu_put_8s(f, &vdev->status);
    qemu_put_8s(f, &vdev->isr);
    qemu_put_be16s(f, &vdev->queue_sel);
G
Gerd Hoffmann 已提交
1230
    qemu_put_be32s(f, &guest_features_lo);
A
aliguori 已提交
1231 1232 1233
    qemu_put_be32(f, vdev->config_len);
    qemu_put_buffer(f, vdev->config, vdev->config_len);

1234
    for (i = 0; i < VIRTIO_QUEUE_MAX; i++) {
A
aliguori 已提交
1235 1236 1237 1238 1239 1240
        if (vdev->vq[i].vring.num == 0)
            break;
    }

    qemu_put_be32(f, i);

1241
    for (i = 0; i < VIRTIO_QUEUE_MAX; i++) {
A
aliguori 已提交
1242 1243 1244 1245
        if (vdev->vq[i].vring.num == 0)
            break;

        qemu_put_be32(f, vdev->vq[i].vring.num);
1246 1247 1248
        if (k->has_variable_vring_alignment) {
            qemu_put_be32(f, vdev->vq[i].vring.align);
        }
1249 1250
        /* XXX virtio-1 devices */
        qemu_put_be64(f, vdev->vq[i].vring.desc);
A
aliguori 已提交
1251
        qemu_put_be16s(f, &vdev->vq[i].last_avail_idx);
K
KONRAD Frederic 已提交
1252 1253 1254
        if (k->save_queue) {
            k->save_queue(qbus->parent, i, f);
        }
A
aliguori 已提交
1255
    }
1256 1257 1258 1259

    if (vdc->save != NULL) {
        vdc->save(vdev, f);
    }
1260 1261

    /* Subsections */
1262
    vmstate_save_state(f, &vmstate_virtio, vdev, NULL);
A
aliguori 已提交
1263 1264
}

1265
static int virtio_set_features_nocheck(VirtIODevice *vdev, uint64_t val)
1266
{
1267
    VirtioDeviceClass *k = VIRTIO_DEVICE_GET_CLASS(vdev);
C
Cornelia Huck 已提交
1268
    bool bad = (val & ~(vdev->host_features)) != 0;
1269

C
Cornelia Huck 已提交
1270
    val &= vdev->host_features;
1271 1272
    if (k->set_features) {
        k->set_features(vdev, val);
1273 1274 1275 1276 1277
    }
    vdev->guest_features = val;
    return bad ? -1 : 0;
}

1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289
int virtio_set_features(VirtIODevice *vdev, uint64_t val)
{
   /*
     * The driver must not attempt to set features after feature negotiation
     * has finished.
     */
    if (vdev->status & VIRTIO_CONFIG_S_FEATURES_OK) {
        return -EINVAL;
    }
    return virtio_set_features_nocheck(vdev, val);
}

1290
int virtio_load(VirtIODevice *vdev, QEMUFile *f, int version_id)
A
aliguori 已提交
1291
{
1292
    int i, ret;
1293
    int32_t config_len;
1294
    uint32_t num;
1295
    uint32_t features;
K
KONRAD Frederic 已提交
1296 1297
    BusState *qbus = qdev_get_parent_bus(DEVICE(vdev));
    VirtioBusClass *k = VIRTIO_BUS_GET_CLASS(qbus);
1298
    VirtioDeviceClass *vdc = VIRTIO_DEVICE_GET_CLASS(vdev);
A
aliguori 已提交
1299

1300 1301 1302 1303 1304 1305
    /*
     * We poison the endianness to ensure it does not get used before
     * subsections have been loaded.
     */
    vdev->device_endian = VIRTIO_DEVICE_ENDIAN_UNKNOWN;

K
KONRAD Frederic 已提交
1306 1307
    if (k->load_config) {
        ret = k->load_config(qbus->parent, f);
1308 1309 1310
        if (ret)
            return ret;
    }
A
aliguori 已提交
1311 1312 1313 1314

    qemu_get_8s(f, &vdev->status);
    qemu_get_8s(f, &vdev->isr);
    qemu_get_be16s(f, &vdev->queue_sel);
1315
    if (vdev->queue_sel >= VIRTIO_QUEUE_MAX) {
1316 1317
        return -1;
    }
1318
    qemu_get_be32s(f, &features);
1319

1320
    config_len = qemu_get_be32(f);
1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331

    /*
     * There are cases where the incoming config can be bigger or smaller
     * than what we have; so load what we have space for, and skip
     * any excess that's in the stream.
     */
    qemu_get_buffer(f, vdev->config, MIN(config_len, vdev->config_len));

    while (config_len > vdev->config_len) {
        qemu_get_byte(f);
        config_len--;
1332
    }
A
aliguori 已提交
1333 1334 1335

    num = qemu_get_be32(f);

1336
    if (num > VIRTIO_QUEUE_MAX) {
1337 1338 1339 1340
        error_report("Invalid number of PCI queues: 0x%x", num);
        return -1;
    }

A
aliguori 已提交
1341 1342
    for (i = 0; i < num; i++) {
        vdev->vq[i].vring.num = qemu_get_be32(f);
1343 1344 1345
        if (k->has_variable_vring_alignment) {
            vdev->vq[i].vring.align = qemu_get_be32(f);
        }
1346
        vdev->vq[i].vring.desc = qemu_get_be64(f);
A
aliguori 已提交
1347
        qemu_get_be16s(f, &vdev->vq[i].last_avail_idx);
M
Michael S. Tsirkin 已提交
1348 1349
        vdev->vq[i].signalled_used_valid = false;
        vdev->vq[i].notification = true;
A
aliguori 已提交
1350

1351 1352 1353
        if (vdev->vq[i].vring.desc) {
            /* XXX virtio-1 devices */
            virtio_queue_update_rings(vdev, i);
M
Michael S. Tsirkin 已提交
1354 1355
        } else if (vdev->vq[i].last_avail_idx) {
            error_report("VQ %d address 0x0 "
1356
                         "inconsistent with Host index 0x%x",
M
Michael S. Tsirkin 已提交
1357 1358
                         i, vdev->vq[i].last_avail_idx);
                return -1;
1359
	}
K
KONRAD Frederic 已提交
1360 1361
        if (k->load_queue) {
            ret = k->load_queue(qbus->parent, i, f);
1362 1363
            if (ret)
                return ret;
1364
        }
A
aliguori 已提交
1365 1366
    }

1367
    virtio_notify_vector(vdev, VIRTIO_NO_VECTOR);
1368 1369

    if (vdc->load != NULL) {
1370 1371 1372 1373
        ret = vdc->load(vdev, f, version_id);
        if (ret) {
            return ret;
        }
1374 1375
    }

1376 1377 1378 1379 1380 1381 1382 1383 1384 1385
    /* Subsections */
    ret = vmstate_load_state(f, &vmstate_virtio, vdev, 1);
    if (ret) {
        return ret;
    }

    if (vdev->device_endian == VIRTIO_DEVICE_ENDIAN_UNKNOWN) {
        vdev->device_endian = virtio_default_endian();
    }

G
Gerd Hoffmann 已提交
1386 1387 1388 1389 1390 1391 1392
    if (virtio_64bit_features_needed(vdev)) {
        /*
         * Subsection load filled vdev->guest_features.  Run them
         * through virtio_set_features to sanity-check them against
         * host_features.
         */
        uint64_t features64 = vdev->guest_features;
1393
        if (virtio_set_features_nocheck(vdev, features64) < 0) {
G
Gerd Hoffmann 已提交
1394 1395 1396 1397 1398 1399
            error_report("Features 0x%" PRIx64 " unsupported. "
                         "Allowed features: 0x%" PRIx64,
                         features64, vdev->host_features);
            return -1;
        }
    } else {
1400
        if (virtio_set_features_nocheck(vdev, features) < 0) {
G
Gerd Hoffmann 已提交
1401 1402 1403 1404 1405 1406 1407
            error_report("Features 0x%x unsupported. "
                         "Allowed features: 0x%" PRIx64,
                         features, vdev->host_features);
            return -1;
        }
    }

1408
    for (i = 0; i < num; i++) {
1409
        if (vdev->vq[i].vring.desc) {
1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424
            uint16_t nheads;
            nheads = vring_avail_idx(&vdev->vq[i]) - vdev->vq[i].last_avail_idx;
            /* Check it isn't doing strange things with descriptor numbers. */
            if (nheads > vdev->vq[i].vring.num) {
                error_report("VQ %d size 0x%x Guest index 0x%x "
                             "inconsistent with Host index 0x%x: delta 0x%x",
                             i, vdev->vq[i].vring.num,
                             vring_avail_idx(&vdev->vq[i]),
                             vdev->vq[i].last_avail_idx, nheads);
                return -1;
            }
        }
    }

    return 0;
A
aliguori 已提交
1425 1426
}

1427
void virtio_cleanup(VirtIODevice *vdev)
1428
{
1429
    qemu_del_vm_change_state_handler(vdev->vmstate);
1430
    g_free(vdev->config);
1431
    g_free(vdev->vq);
1432
    g_free(vdev->vector_queues);
1433 1434
}

1435
static void virtio_vmstate_change(void *opaque, int running, RunState state)
1436 1437
{
    VirtIODevice *vdev = opaque;
K
KONRAD Frederic 已提交
1438 1439
    BusState *qbus = qdev_get_parent_bus(DEVICE(vdev));
    VirtioBusClass *k = VIRTIO_BUS_GET_CLASS(qbus);
1440
    bool backend_run = running && (vdev->status & VIRTIO_CONFIG_S_DRIVER_OK);
1441
    vdev->vm_running = running;
1442 1443 1444 1445 1446

    if (backend_run) {
        virtio_set_status(vdev, vdev->status);
    }

K
KONRAD Frederic 已提交
1447 1448
    if (k->vmstate_change) {
        k->vmstate_change(qbus->parent, backend_run);
1449 1450 1451 1452 1453 1454 1455
    }

    if (!backend_run) {
        virtio_set_status(vdev, vdev->status);
    }
}

1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466
void virtio_instance_init_common(Object *proxy_obj, void *data,
                                 size_t vdev_size, const char *vdev_name)
{
    DeviceState *vdev = data;

    object_initialize(vdev, vdev_size, vdev_name);
    object_property_add_child(proxy_obj, "virtio-backend", OBJECT(vdev), NULL);
    object_unref(OBJECT(vdev));
    qdev_alias_all_properties(vdev, proxy_obj);
}

1467 1468
void virtio_init(VirtIODevice *vdev, const char *name,
                 uint16_t device_id, size_t config_size)
A
aliguori 已提交
1469
{
1470 1471
    BusState *qbus = qdev_get_parent_bus(DEVICE(vdev));
    VirtioBusClass *k = VIRTIO_BUS_GET_CLASS(qbus);
1472
    int i;
1473 1474 1475 1476 1477 1478 1479
    int nvectors = k->query_nvectors ? k->query_nvectors(qbus->parent) : 0;

    if (nvectors) {
        vdev->vector_queues =
            g_malloc0(sizeof(*vdev->vector_queues) * nvectors);
    }

P
Paul Brook 已提交
1480
    vdev->device_id = device_id;
A
aliguori 已提交
1481 1482 1483
    vdev->status = 0;
    vdev->isr = 0;
    vdev->queue_sel = 0;
1484
    vdev->config_vector = VIRTIO_NO_VECTOR;
1485
    vdev->vq = g_malloc0(sizeof(VirtQueue) * VIRTIO_QUEUE_MAX);
1486
    vdev->vm_running = runstate_is_running();
1487
    for (i = 0; i < VIRTIO_QUEUE_MAX; i++) {
1488
        vdev->vq[i].vector = VIRTIO_NO_VECTOR;
1489
        vdev->vq[i].vdev = vdev;
1490
        vdev->vq[i].queue_index = i;
1491
    }
A
aliguori 已提交
1492 1493 1494

    vdev->name = name;
    vdev->config_len = config_size;
1495
    if (vdev->config_len) {
1496
        vdev->config = g_malloc0(config_size);
1497
    } else {
A
aliguori 已提交
1498
        vdev->config = NULL;
1499 1500 1501
    }
    vdev->vmstate = qemu_add_vm_change_state_handler(virtio_vmstate_change,
                                                     vdev);
1502
    vdev->device_endian = virtio_default_endian();
1503
}
A
aliguori 已提交
1504

A
Avi Kivity 已提交
1505
hwaddr virtio_queue_get_desc_addr(VirtIODevice *vdev, int n)
1506 1507 1508 1509
{
    return vdev->vq[n].vring.desc;
}

A
Avi Kivity 已提交
1510
hwaddr virtio_queue_get_avail_addr(VirtIODevice *vdev, int n)
1511 1512 1513 1514
{
    return vdev->vq[n].vring.avail;
}

A
Avi Kivity 已提交
1515
hwaddr virtio_queue_get_used_addr(VirtIODevice *vdev, int n)
1516 1517 1518 1519
{
    return vdev->vq[n].vring.used;
}

A
Avi Kivity 已提交
1520
hwaddr virtio_queue_get_ring_addr(VirtIODevice *vdev, int n)
1521 1522 1523 1524
{
    return vdev->vq[n].vring.desc;
}

A
Avi Kivity 已提交
1525
hwaddr virtio_queue_get_desc_size(VirtIODevice *vdev, int n)
1526 1527 1528 1529
{
    return sizeof(VRingDesc) * vdev->vq[n].vring.num;
}

A
Avi Kivity 已提交
1530
hwaddr virtio_queue_get_avail_size(VirtIODevice *vdev, int n)
1531 1532
{
    return offsetof(VRingAvail, ring) +
1533
        sizeof(uint16_t) * vdev->vq[n].vring.num;
1534 1535
}

A
Avi Kivity 已提交
1536
hwaddr virtio_queue_get_used_size(VirtIODevice *vdev, int n)
1537 1538 1539 1540 1541
{
    return offsetof(VRingUsed, ring) +
        sizeof(VRingUsedElem) * vdev->vq[n].vring.num;
}

A
Avi Kivity 已提交
1542
hwaddr virtio_queue_get_ring_size(VirtIODevice *vdev, int n)
1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557
{
    return vdev->vq[n].vring.used - vdev->vq[n].vring.desc +
	    virtio_queue_get_used_size(vdev, n);
}

uint16_t virtio_queue_get_last_avail_idx(VirtIODevice *vdev, int n)
{
    return vdev->vq[n].last_avail_idx;
}

void virtio_queue_set_last_avail_idx(VirtIODevice *vdev, int n, uint16_t idx)
{
    vdev->vq[n].last_avail_idx = idx;
}

1558 1559 1560 1561 1562
void virtio_queue_invalidate_signalled_used(VirtIODevice *vdev, int n)
{
    vdev->vq[n].signalled_used_valid = false;
}

1563 1564 1565 1566 1567
VirtQueue *virtio_get_queue(VirtIODevice *vdev, int n)
{
    return vdev->vq + n;
}

1568 1569 1570 1571 1572
uint16_t virtio_get_queue_index(VirtQueue *vq)
{
    return vq->queue_index;
}

1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596
static void virtio_queue_guest_notifier_read(EventNotifier *n)
{
    VirtQueue *vq = container_of(n, VirtQueue, guest_notifier);
    if (event_notifier_test_and_clear(n)) {
        virtio_irq(vq);
    }
}

void virtio_queue_set_guest_notifier_fd_handler(VirtQueue *vq, bool assign,
                                                bool with_irqfd)
{
    if (assign && !with_irqfd) {
        event_notifier_set_handler(&vq->guest_notifier,
                                   virtio_queue_guest_notifier_read);
    } else {
        event_notifier_set_handler(&vq->guest_notifier, NULL);
    }
    if (!assign) {
        /* Test and clear notifier before closing it,
         * in case poll callback didn't have time to run. */
        virtio_queue_guest_notifier_read(&vq->guest_notifier);
    }
}

1597 1598 1599 1600
EventNotifier *virtio_queue_get_guest_notifier(VirtQueue *vq)
{
    return &vq->guest_notifier;
}
1601 1602 1603 1604 1605 1606 1607 1608 1609

static void virtio_queue_host_notifier_read(EventNotifier *n)
{
    VirtQueue *vq = container_of(n, VirtQueue, host_notifier);
    if (event_notifier_test_and_clear(n)) {
        virtio_queue_notify_vq(vq);
    }
}

P
Paolo Bonzini 已提交
1610 1611
void virtio_queue_set_host_notifier_fd_handler(VirtQueue *vq, bool assign,
                                               bool set_handler)
1612
{
P
Paolo Bonzini 已提交
1613
    if (assign && set_handler) {
1614 1615 1616 1617
        event_notifier_set_handler(&vq->host_notifier,
                                   virtio_queue_host_notifier_read);
    } else {
        event_notifier_set_handler(&vq->host_notifier, NULL);
P
Paolo Bonzini 已提交
1618 1619
    }
    if (!assign) {
1620 1621 1622 1623 1624 1625
        /* Test and clear notifier before after disabling event,
         * in case poll callback didn't have time to run. */
        virtio_queue_host_notifier_read(&vq->host_notifier);
    }
}

1626 1627 1628 1629
EventNotifier *virtio_queue_get_host_notifier(VirtQueue *vq)
{
    return &vq->host_notifier;
}
1630

1631 1632
void virtio_device_set_child_bus_name(VirtIODevice *vdev, char *bus_name)
{
1633
    g_free(vdev->bus_name);
1634
    vdev->bus_name = g_strdup(bus_name);
1635 1636
}

1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648
static void virtio_device_realize(DeviceState *dev, Error **errp)
{
    VirtIODevice *vdev = VIRTIO_DEVICE(dev);
    VirtioDeviceClass *vdc = VIRTIO_DEVICE_GET_CLASS(dev);
    Error *err = NULL;

    if (vdc->realize != NULL) {
        vdc->realize(dev, &err);
        if (err != NULL) {
            error_propagate(errp, err);
            return;
        }
1649
    }
J
Jason Wang 已提交
1650 1651 1652 1653 1654 1655

    virtio_bus_device_plugged(vdev, &err);
    if (err != NULL) {
        error_propagate(errp, err);
        return;
    }
1656 1657
}

1658
static void virtio_device_unrealize(DeviceState *dev, Error **errp)
1659
{
1660
    VirtIODevice *vdev = VIRTIO_DEVICE(dev);
1661 1662
    VirtioDeviceClass *vdc = VIRTIO_DEVICE_GET_CLASS(dev);
    Error *err = NULL;
1663

1664 1665
    virtio_bus_device_unplugged(vdev);

1666 1667 1668 1669 1670 1671
    if (vdc->unrealize != NULL) {
        vdc->unrealize(dev, &err);
        if (err != NULL) {
            error_propagate(errp, err);
            return;
        }
1672
    }
1673

1674 1675
    g_free(vdev->bus_name);
    vdev->bus_name = NULL;
1676 1677
}

C
Cornelia Huck 已提交
1678 1679 1680 1681 1682
static Property virtio_properties[] = {
    DEFINE_VIRTIO_COMMON_FEATURES(VirtIODevice, host_features),
    DEFINE_PROP_END_OF_LIST(),
};

1683 1684 1685 1686
static void virtio_device_class_init(ObjectClass *klass, void *data)
{
    /* Set the default value here. */
    DeviceClass *dc = DEVICE_CLASS(klass);
1687 1688 1689

    dc->realize = virtio_device_realize;
    dc->unrealize = virtio_device_unrealize;
1690
    dc->bus_type = TYPE_VIRTIO_BUS;
C
Cornelia Huck 已提交
1691
    dc->props = virtio_properties;
1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708
}

static const TypeInfo virtio_device_info = {
    .name = TYPE_VIRTIO_DEVICE,
    .parent = TYPE_DEVICE,
    .instance_size = sizeof(VirtIODevice),
    .class_init = virtio_device_class_init,
    .abstract = true,
    .class_size = sizeof(VirtioDeviceClass),
};

static void virtio_register_types(void)
{
    type_register_static(&virtio_device_info);
}

type_init(virtio_register_types)