[mirror_qemu.git] / tests / libqos / virtio.c

/*
 * libqos virtio driver
 *
 * Copyright (c) 2014 Marc Marí
 *
 * This work is licensed under the terms of the GNU GPL, version 2 or later.
 * See the COPYING file in the top-level directory.
 */

#include "qemu/osdep.h"
#include "libqtest.h"
#include "libqos/virtio.h"
#include "standard-headers/linux/virtio_config.h"
#include "standard-headers/linux/virtio_ring.h"

uint8_t qvirtio_config_readb(const QVirtioBus *bus, QVirtioDevice *d,
                                                                uint64_t addr)
{
    return bus->config_readb(d, addr);
}

uint16_t qvirtio_config_readw(const QVirtioBus *bus, QVirtioDevice *d,
                                                                uint64_t addr)
{
    return bus->config_readw(d, addr);
}

uint32_t qvirtio_config_readl(const QVirtioBus *bus, QVirtioDevice *d,
                                                                uint64_t addr)
{
    return bus->config_readl(d, addr);
}

uint64_t qvirtio_config_readq(const QVirtioBus *bus, QVirtioDevice *d,
                                                                uint64_t addr)
{
    return bus->config_readq(d, addr);
}

uint32_t qvirtio_get_features(const QVirtioBus *bus, QVirtioDevice *d)
{
    return bus->get_features(d);
}

void qvirtio_set_features(const QVirtioBus *bus, QVirtioDevice *d,
                                                            uint32_t features)
{
    bus->set_features(d, features);
}

QVirtQueue *qvirtqueue_setup(const QVirtioBus *bus, QVirtioDevice *d,
                                        QGuestAllocator *alloc, uint16_t index)
{
    return bus->virtqueue_setup(d, alloc, index);
}

void qvirtqueue_cleanup(const QVirtioBus *bus, QVirtQueue *vq,
                        QGuestAllocator *alloc)
{
    return bus->virtqueue_cleanup(vq, alloc);
}

void qvirtio_reset(const QVirtioBus *bus, QVirtioDevice *d)
{
    bus->set_status(d, 0);
    g_assert_cmphex(bus->get_status(d), ==, 0);
}

void qvirtio_set_acknowledge(const QVirtioBus *bus, QVirtioDevice *d)
{
    bus->set_status(d, bus->get_status(d) | VIRTIO_CONFIG_S_ACKNOWLEDGE);
    g_assert_cmphex(bus->get_status(d), ==, VIRTIO_CONFIG_S_ACKNOWLEDGE);
}

void qvirtio_set_driver(const QVirtioBus *bus, QVirtioDevice *d)
{
    bus->set_status(d, bus->get_status(d) | VIRTIO_CONFIG_S_DRIVER);
    g_assert_cmphex(bus->get_status(d), ==,
                    VIRTIO_CONFIG_S_DRIVER | VIRTIO_CONFIG_S_ACKNOWLEDGE);
}

void qvirtio_set_driver_ok(const QVirtioBus *bus, QVirtioDevice *d)
{
    bus->set_status(d, bus->get_status(d) | VIRTIO_CONFIG_S_DRIVER_OK);
    g_assert_cmphex(bus->get_status(d), ==, VIRTIO_CONFIG_S_DRIVER_OK |
                    VIRTIO_CONFIG_S_DRIVER | VIRTIO_CONFIG_S_ACKNOWLEDGE);
}

void qvirtio_wait_queue_isr(const QVirtioBus *bus, QVirtioDevice *d,
                            QVirtQueue *vq, gint64 timeout_us)
{
    gint64 start_time = g_get_monotonic_time();

    for (;;) {
        clock_step(100);
        if (bus->get_queue_isr_status(d, vq)) {
            return;
        }
        g_assert(g_get_monotonic_time() - start_time <= timeout_us);
    }
}

/* Wait for the status byte at given guest memory address to be set
 *
 * The virtqueue interrupt must not be raised, making this useful for testing
 * event_index functionality.
 */
uint8_t qvirtio_wait_status_byte_no_isr(const QVirtioBus *bus,
                                        QVirtioDevice *d,
                                        QVirtQueue *vq,
                                        uint64_t addr,
                                        gint64 timeout_us)
{
    gint64 start_time = g_get_monotonic_time();
    uint8_t val;

    while ((val = readb(addr)) == 0xff) {
        clock_step(100);
        g_assert(!bus->get_queue_isr_status(d, vq));
        g_assert(g_get_monotonic_time() - start_time <= timeout_us);
    }
    return val;
}

void qvirtio_wait_config_isr(const QVirtioBus *bus, QVirtioDevice *d,
                             gint64 timeout_us)
{
    gint64 start_time = g_get_monotonic_time();

    for (;;) {
        clock_step(100);
        if (bus->get_config_isr_status(d)) {
            return;
        }
        g_assert(g_get_monotonic_time() - start_time <= timeout_us);
    }
}

void qvring_init(const QGuestAllocator *alloc, QVirtQueue *vq, uint64_t addr)
{
    int i;

    vq->desc = addr;
    vq->avail = vq->desc + vq->size * sizeof(struct vring_desc);
    vq->used = (uint64_t)((vq->avail + sizeof(uint16_t) * (3 + vq->size)
        + vq->align - 1) & ~(vq->align - 1));

    for (i = 0; i < vq->size - 1; i++) {
        /* vq->desc[i].addr */
        writeq(vq->desc + (16 * i), 0);
        /* vq->desc[i].next */
        writew(vq->desc + (16 * i) + 14, i + 1);
    }

    /* vq->avail->flags */
    writew(vq->avail, 0);
    /* vq->avail->idx */
    writew(vq->avail + 2, 0);
    /* vq->avail->used_event */
    writew(vq->avail + 4 + (2 * vq->size), 0);

    /* vq->used->flags */
    writew(vq->used, 0);
    /* vq->used->avail_event */
    writew(vq->used + 2 + sizeof(struct vring_used_elem) * vq->size, 0);
}

QVRingIndirectDesc *qvring_indirect_desc_setup(QVirtioDevice *d,
                                        QGuestAllocator *alloc, uint16_t elem)
{
    int i;
    QVRingIndirectDesc *indirect = g_malloc(sizeof(*indirect));

    indirect->index = 0;
    indirect->elem = elem;
    indirect->desc = guest_alloc(alloc, sizeof(struct vring_desc) * elem);

    for (i = 0; i < elem - 1; ++i) {
        /* indirect->desc[i].addr */
        writeq(indirect->desc + (16 * i), 0);
        /* indirect->desc[i].flags */
        writew(indirect->desc + (16 * i) + 12, VRING_DESC_F_NEXT);
        /* indirect->desc[i].next */
        writew(indirect->desc + (16 * i) + 14, i + 1);
    }

    return indirect;
}

void qvring_indirect_desc_add(QVRingIndirectDesc *indirect, uint64_t data,
                                                    uint32_t len, bool write)
{
    uint16_t flags;

    g_assert_cmpint(indirect->index, <, indirect->elem);

    flags = readw(indirect->desc + (16 * indirect->index) + 12);

    if (write) {
        flags |= VRING_DESC_F_WRITE;
    }

    /* indirect->desc[indirect->index].addr */
    writeq(indirect->desc + (16 * indirect->index), data);
    /* indirect->desc[indirect->index].len */
    writel(indirect->desc + (16 * indirect->index) + 8, len);
    /* indirect->desc[indirect->index].flags */
    writew(indirect->desc + (16 * indirect->index) + 12, flags);

    indirect->index++;
}

uint32_t qvirtqueue_add(QVirtQueue *vq, uint64_t data, uint32_t len, bool write,
                                                                    bool next)
{
    uint16_t flags = 0;
    vq->num_free--;

    if (write) {
        flags |= VRING_DESC_F_WRITE;
    }

    if (next) {
        flags |= VRING_DESC_F_NEXT;
    }

    /* vq->desc[vq->free_head].addr */
    writeq(vq->desc + (16 * vq->free_head), data);
    /* vq->desc[vq->free_head].len */
    writel(vq->desc + (16 * vq->free_head) + 8, len);
    /* vq->desc[vq->free_head].flags */
    writew(vq->desc + (16 * vq->free_head) + 12, flags);

    return vq->free_head++; /* Return and increase, in this order */
}

uint32_t qvirtqueue_add_indirect(QVirtQueue *vq, QVRingIndirectDesc *indirect)
{
    g_assert(vq->indirect);
    g_assert_cmpint(vq->size, >=, indirect->elem);
    g_assert_cmpint(indirect->index, ==, indirect->elem);

    vq->num_free--;

    /* vq->desc[vq->free_head].addr */
    writeq(vq->desc + (16 * vq->free_head), indirect->desc);
    /* vq->desc[vq->free_head].len */
    writel(vq->desc + (16 * vq->free_head) + 8,
           sizeof(struct vring_desc) * indirect->elem);
    /* vq->desc[vq->free_head].flags */
    writew(vq->desc + (16 * vq->free_head) + 12, VRING_DESC_F_INDIRECT);

    return vq->free_head++; /* Return and increase, in this order */
}

void qvirtqueue_kick(const QVirtioBus *bus, QVirtioDevice *d, QVirtQueue *vq,
                                                            uint32_t free_head)
{
    /* vq->avail->idx */
    uint16_t idx = readw(vq->avail + 2);
    /* vq->used->flags */
    uint16_t flags;
    /* vq->used->avail_event */
    uint16_t avail_event;

    /* vq->avail->ring[idx % vq->size] */
    writew(vq->avail + 4 + (2 * (idx % vq->size)), free_head);
    /* vq->avail->idx */
    writew(vq->avail + 2, idx + 1);

    /* Must read after idx is updated */
    flags = readw(vq->avail);
    avail_event = readw(vq->used + 4 +
                                sizeof(struct vring_used_elem) * vq->size);

    /* < 1 because we add elements to avail queue one by one */
    if ((flags & VRING_USED_F_NO_NOTIFY) == 0 &&
                            (!vq->event || (uint16_t)(idx-avail_event) < 1)) {
        bus->virtqueue_kick(d, vq);
    }
}

void qvirtqueue_set_used_event(QVirtQueue *vq, uint16_t idx)
{
    g_assert(vq->event);

    /* vq->avail->used_event */
    writew(vq->avail + 4 + (2 * vq->size), idx);
}
Commit	Line	Data
46e0cf76 MM	1	/*
	2	* libqos virtio driver
	3	*
	4	* Copyright (c) 2014 Marc Marí
	5	*
	6	* This work is licensed under the terms of the GNU GPL, version 2 or later.
	7	* See the COPYING file in the top-level directory.
	8	*/
	9
681c28a3	10	#include "qemu/osdep.h"
46e0cf76 MM	11	#include "libqtest.h"
46e0cf76 MM	12	#include "libqos/virtio.h"
1373a4c2	13	#include "standard-headers/linux/virtio_config.h"
ee3b850a	14	#include "standard-headers/linux/virtio_ring.h"
46e0cf76 MM	15
46e0cf76 MM	16	uint8_t qvirtio_config_readb(const QVirtioBus bus, QVirtioDevice d,
728312b8	17	uint64_t addr)
46e0cf76 MM	18	{
	19	return bus->config_readb(d, addr);
	20	}
	21
	22	uint16_t qvirtio_config_readw(const QVirtioBus bus, QVirtioDevice d,
728312b8	23	uint64_t addr)
46e0cf76 MM	24	{
	25	return bus->config_readw(d, addr);
	26	}
	27
	28	uint32_t qvirtio_config_readl(const QVirtioBus bus, QVirtioDevice d,
728312b8	29	uint64_t addr)
46e0cf76 MM	30	{
	31	return bus->config_readl(d, addr);
	32	}
	33
	34	uint64_t qvirtio_config_readq(const QVirtioBus bus, QVirtioDevice d,
728312b8	35	uint64_t addr)
46e0cf76 MM	36	{
	37	return bus->config_readq(d, addr);
	38	}
	39
bf3c63d2 MM	40	uint32_t qvirtio_get_features(const QVirtioBus bus, QVirtioDevice d)
	41	{
	42	return bus->get_features(d);
	43	}
	44
	45	void qvirtio_set_features(const QVirtioBus bus, QVirtioDevice d,
	46	uint32_t features)
	47	{
	48	bus->set_features(d, features);
	49	}
	50
	51	QVirtQueue qvirtqueue_setup(const QVirtioBus bus, QVirtioDevice *d,
	52	QGuestAllocator *alloc, uint16_t index)
	53	{
	54	return bus->virtqueue_setup(d, alloc, index);
	55	}
	56
f1d3b991 SH	57	void qvirtqueue_cleanup(const QVirtioBus bus, QVirtQueue vq,
	58	QGuestAllocator *alloc)
	59	{
	60	return bus->virtqueue_cleanup(vq, alloc);
	61	}
	62
46e0cf76 MM	63	void qvirtio_reset(const QVirtioBus bus, QVirtioDevice d)
46e0cf76 MM	64	{
1373a4c2 SH	65	bus->set_status(d, 0);
1373a4c2 SH	66	g_assert_cmphex(bus->get_status(d), ==, 0);
46e0cf76 MM	67	}
	68
	69	void qvirtio_set_acknowledge(const QVirtioBus bus, QVirtioDevice d)
	70	{
1373a4c2 SH	71	bus->set_status(d, bus->get_status(d) \| VIRTIO_CONFIG_S_ACKNOWLEDGE);
1373a4c2 SH	72	g_assert_cmphex(bus->get_status(d), ==, VIRTIO_CONFIG_S_ACKNOWLEDGE);
46e0cf76 MM	73	}
	74
	75	void qvirtio_set_driver(const QVirtioBus bus, QVirtioDevice d)
	76	{
1373a4c2	77	bus->set_status(d, bus->get_status(d) \| VIRTIO_CONFIG_S_DRIVER);
46e0cf76	78	g_assert_cmphex(bus->get_status(d), ==,
1373a4c2	79	VIRTIO_CONFIG_S_DRIVER \| VIRTIO_CONFIG_S_ACKNOWLEDGE);
46e0cf76	80	}
bf3c63d2 MM	81
	82	void qvirtio_set_driver_ok(const QVirtioBus bus, QVirtioDevice d)
	83	{
1373a4c2 SH	84	bus->set_status(d, bus->get_status(d) \| VIRTIO_CONFIG_S_DRIVER_OK);
	85	g_assert_cmphex(bus->get_status(d), ==, VIRTIO_CONFIG_S_DRIVER_OK \|
	86	VIRTIO_CONFIG_S_DRIVER \| VIRTIO_CONFIG_S_ACKNOWLEDGE);
bf3c63d2 MM	87	}
bf3c63d2 MM	88
70556264 SH	89	void qvirtio_wait_queue_isr(const QVirtioBus bus, QVirtioDevice d,
70556264 SH	90	QVirtQueue *vq, gint64 timeout_us)
58368113	91	{
70556264 SH	92	gint64 start_time = g_get_monotonic_time();
	93
	94	for (;;) {
6cd14054	95	clock_step(100);
58368113	96	if (bus->get_queue_isr_status(d, vq)) {
70556264	97	return;
58368113	98	}
70556264 SH	99	g_assert(g_get_monotonic_time() - start_time <= timeout_us);
70556264 SH	100	}
58368113 MM	101	}
58368113 MM	102
e8c81b4d SH	103	/* Wait for the status byte at given guest memory address to be set
	104	*
	105	* The virtqueue interrupt must not be raised, making this useful for testing
	106	* event_index functionality.
	107	*/
	108	uint8_t qvirtio_wait_status_byte_no_isr(const QVirtioBus *bus,
	109	QVirtioDevice *d,
	110	QVirtQueue *vq,
	111	uint64_t addr,
	112	gint64 timeout_us)
	113	{
	114	gint64 start_time = g_get_monotonic_time();
	115	uint8_t val;
	116
	117	while ((val = readb(addr)) == 0xff) {
	118	clock_step(100);
	119	g_assert(!bus->get_queue_isr_status(d, vq));
	120	g_assert(g_get_monotonic_time() - start_time <= timeout_us);
	121	}
	122	return val;
	123	}
	124
70556264 SH	125	void qvirtio_wait_config_isr(const QVirtioBus bus, QVirtioDevice d,
70556264 SH	126	gint64 timeout_us)
bf3c63d2	127	{
70556264 SH	128	gint64 start_time = g_get_monotonic_time();
	129
	130	for (;;) {
6cd14054	131	clock_step(100);
58368113	132	if (bus->get_config_isr_status(d)) {
70556264	133	return;
bf3c63d2	134	}
70556264 SH	135	g_assert(g_get_monotonic_time() - start_time <= timeout_us);
70556264 SH	136	}
bf3c63d2 MM	137	}
	138
	139	void qvring_init(const QGuestAllocator alloc, QVirtQueue vq, uint64_t addr)
	140	{
	141	int i;
	142
	143	vq->desc = addr;
780b11a0	144	vq->avail = vq->desc + vq->size * sizeof(struct vring_desc);
bf3c63d2 MM	145	vq->used = (uint64_t)((vq->avail + sizeof(uint16_t) * (3 + vq->size)
	146	+ vq->align - 1) & ~(vq->align - 1));
	147
	148	for (i = 0; i < vq->size - 1; i++) {
	149	/* vq->desc[i].addr */
844c8229	150	writeq(vq->desc + (16 * i), 0);
bf3c63d2 MM	151	/* vq->desc[i].next */
	152	writew(vq->desc + (16 * i) + 14, i + 1);
	153	}
	154
	155	/* vq->avail->flags */
	156	writew(vq->avail, 0);
	157	/* vq->avail->idx */
	158	writew(vq->avail + 2, 0);
1053587c MM	159	/* vq->avail->used_event */
1053587c MM	160	writew(vq->avail + 4 + (2 * vq->size), 0);
bf3c63d2 MM	161
	162	/* vq->used->flags */
	163	writew(vq->used, 0);
1053587c	164	/* vq->used->avail_event */
780b11a0	165	writew(vq->used + 2 + sizeof(struct vring_used_elem) * vq->size, 0);
bf3c63d2 MM	166	}
bf3c63d2 MM	167
f294b029 MM	168	QVRingIndirectDesc qvring_indirect_desc_setup(QVirtioDevice d,
	169	QGuestAllocator *alloc, uint16_t elem)
	170	{
	171	int i;
	172	QVRingIndirectDesc indirect = g_malloc(sizeof(indirect));
	173
	174	indirect->index = 0;
	175	indirect->elem = elem;
780b11a0	176	indirect->desc = guest_alloc(alloc, sizeof(struct vring_desc) * elem);
f294b029 MM	177
	178	for (i = 0; i < elem - 1; ++i) {
	179	/* indirect->desc[i].addr */
	180	writeq(indirect->desc + (16 * i), 0);
	181	/* indirect->desc[i].flags */
ee3b850a	182	writew(indirect->desc + (16 * i) + 12, VRING_DESC_F_NEXT);
f294b029 MM	183	/* indirect->desc[i].next */
	184	writew(indirect->desc + (16 * i) + 14, i + 1);
	185	}
	186
	187	return indirect;
	188	}
	189
	190	void qvring_indirect_desc_add(QVRingIndirectDesc *indirect, uint64_t data,
	191	uint32_t len, bool write)
	192	{
	193	uint16_t flags;
	194
	195	g_assert_cmpint(indirect->index, <, indirect->elem);
	196
	197	flags = readw(indirect->desc + (16 * indirect->index) + 12);
	198
	199	if (write) {
ee3b850a	200	flags \|= VRING_DESC_F_WRITE;
f294b029 MM	201	}
	202
	203	/* indirect->desc[indirect->index].addr */
	204	writeq(indirect->desc + (16 * indirect->index), data);
	205	/* indirect->desc[indirect->index].len */
	206	writel(indirect->desc + (16 * indirect->index) + 8, len);
	207	/* indirect->desc[indirect->index].flags */
	208	writew(indirect->desc + (16 * indirect->index) + 12, flags);
	209
	210	indirect->index++;
	211	}
	212
bf3c63d2 MM	213	uint32_t qvirtqueue_add(QVirtQueue *vq, uint64_t data, uint32_t len, bool write,
	214	bool next)
	215	{
	216	uint16_t flags = 0;
	217	vq->num_free--;
	218
	219	if (write) {
ee3b850a	220	flags \|= VRING_DESC_F_WRITE;
bf3c63d2 MM	221	}
	222
	223	if (next) {
ee3b850a	224	flags \|= VRING_DESC_F_NEXT;
bf3c63d2 MM	225	}
	226
	227	/* vq->desc[vq->free_head].addr */
	228	writeq(vq->desc + (16 * vq->free_head), data);
	229	/* vq->desc[vq->free_head].len */
	230	writel(vq->desc + (16 * vq->free_head) + 8, len);
	231	/* vq->desc[vq->free_head].flags */
	232	writew(vq->desc + (16 * vq->free_head) + 12, flags);
	233
	234	return vq->free_head++; /* Return and increase, in this order */
	235	}
	236
f294b029 MM	237	uint32_t qvirtqueue_add_indirect(QVirtQueue vq, QVRingIndirectDesc indirect)
	238	{
	239	g_assert(vq->indirect);
	240	g_assert_cmpint(vq->size, >=, indirect->elem);
	241	g_assert_cmpint(indirect->index, ==, indirect->elem);
	242
	243	vq->num_free--;
	244
	245	/* vq->desc[vq->free_head].addr */
	246	writeq(vq->desc + (16 * vq->free_head), indirect->desc);
	247	/* vq->desc[vq->free_head].len */
	248	writel(vq->desc + (16 * vq->free_head) + 8,
780b11a0	249	sizeof(struct vring_desc) * indirect->elem);
f294b029	250	/* vq->desc[vq->free_head].flags */
ee3b850a	251	writew(vq->desc + (16 * vq->free_head) + 12, VRING_DESC_F_INDIRECT);
f294b029 MM	252
	253	return vq->free_head++; /* Return and increase, in this order */
	254	}
	255
bf3c63d2 MM	256	void qvirtqueue_kick(const QVirtioBus bus, QVirtioDevice d, QVirtQueue *vq,
	257	uint32_t free_head)
	258	{
	259	/* vq->avail->idx */
e49f8277	260	uint16_t idx = readw(vq->avail + 2);
1053587c MM	261	/* vq->used->flags */
	262	uint16_t flags;
	263	/* vq->used->avail_event */
	264	uint16_t avail_event;
bf3c63d2 MM	265
bf3c63d2 MM	266	/* vq->avail->ring[idx % vq->size] */
e49f8277	267	writew(vq->avail + 4 + (2 * (idx % vq->size)), free_head);
bf3c63d2	268	/* vq->avail->idx */
e49f8277	269	writew(vq->avail + 2, idx + 1);
bf3c63d2	270
1053587c MM	271	/* Must read after idx is updated */
	272	flags = readw(vq->avail);
	273	avail_event = readw(vq->used + 4 +
780b11a0	274	sizeof(struct vring_used_elem) * vq->size);
1053587c MM	275
1053587c MM	276	/* < 1 because we add elements to avail queue one by one */
ee3b850a	277	if ((flags & VRING_USED_F_NO_NOTIFY) == 0 &&
1053587c MM	278	(!vq->event \|\| (uint16_t)(idx-avail_event) < 1)) {
	279	bus->virtqueue_kick(d, vq);
	280	}
	281	}
	282
	283	void qvirtqueue_set_used_event(QVirtQueue *vq, uint16_t idx)
	284	{
	285	g_assert(vq->event);
	286
	287	/* vq->avail->used_event */
	288	writew(vq->avail + 4 + (2 * vq->size), idx);
bf3c63d2	289	}