Coverage Report

Created: 2026-11-20 08:13

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/qemu/tests/qtest/libqos/virtio-pci.c
Line
Count
Source
1
/*
2
 * libqos virtio PCI 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
10
#include "qemu/osdep.h"
11
#include "../libqtest.h"
12
#include "virtio.h"
13
#include "virtio-pci.h"
14
#include "pci.h"
15
#include "pci-pc.h"
16
#include "libqos-malloc.h"
17
#include "malloc-pc.h"
18
#include "qgraph.h"
19
#include "standard-headers/linux/virtio_ring.h"
20
#include "standard-headers/linux/virtio_pci.h"
21
22
#include "hw/pci/pci.h"
23
#include "hw/pci/pci_regs.h"
24
25
#include "virtio-pci-modern.h"
26
27
/* virtio-pci is a superclass of all virtio-xxx-pci devices;
28
 * the relation between virtio-pci and virtio-xxx-pci is implicit,
29
 * and therefore virtio-pci does not produce virtio and is not
30
 * reached by any edge, not even as a "contains" edge.
31
 * In facts, every device is a QVirtioPCIDevice with
32
 * additional fields, since every one has its own
33
 * number of queues and various attributes.
34
 * Virtio-pci provides default functions to start the
35
 * hw and destroy the object, and nodes that want to
36
 * override them should always remember to call the
37
 * original qvirtio_pci_destructor and qvirtio_pci_start_hw.
38
 */
39
40
0
#define CONFIG_BASE(dev) (VIRTIO_PCI_CONFIG_OFF((dev)->pdev->msix_enabled))
41
42
static uint8_t qvirtio_pci_config_readb(QVirtioDevice *d, uint64_t off)
43
0
{
44
0
    QVirtioPCIDevice *dev = container_of(d, QVirtioPCIDevice, vdev);
45
0
    return qpci_io_readb(dev->pdev, dev->bar, CONFIG_BASE(dev) + off);
46
0
}
47
48
/* PCI is always read in little-endian order
49
 * but virtio ( < 1.0) is in guest order
50
 * so with a big-endian guest the order has been reversed,
51
 * reverse it again
52
 * virtio-1.0 is always little-endian, like PCI
53
 */
54
55
static uint16_t qvirtio_pci_config_readw(QVirtioDevice *d, uint64_t off)
56
0
{
57
0
    QVirtioPCIDevice *dev = container_of(d, QVirtioPCIDevice, vdev);
58
0
    uint16_t value;
59
60
0
    value = qpci_io_readw(dev->pdev, dev->bar, CONFIG_BASE(dev) + off);
61
0
    if (qvirtio_is_big_endian(d)) {
62
0
        value = bswap16(value);
63
0
    }
64
0
    return value;
65
0
}
66
67
static uint32_t qvirtio_pci_config_readl(QVirtioDevice *d, uint64_t off)
68
0
{
69
0
    QVirtioPCIDevice *dev = container_of(d, QVirtioPCIDevice, vdev);
70
0
    uint32_t value;
71
72
0
    value = qpci_io_readl(dev->pdev, dev->bar, CONFIG_BASE(dev) + off);
73
0
    if (qvirtio_is_big_endian(d)) {
74
0
        value = bswap32(value);
75
0
    }
76
0
    return value;
77
0
}
78
79
static uint64_t qvirtio_pci_config_readq(QVirtioDevice *d, uint64_t off)
80
0
{
81
0
    QVirtioPCIDevice *dev = container_of(d, QVirtioPCIDevice, vdev);
82
0
    uint64_t val;
83
84
0
    val = qpci_io_readq(dev->pdev, dev->bar, CONFIG_BASE(dev) + off);
85
0
    if (qvirtio_is_big_endian(d)) {
86
0
        val = bswap64(val);
87
0
    }
88
89
0
    return val;
90
0
}
91
92
static uint64_t qvirtio_pci_get_features(QVirtioDevice *d)
93
0
{
94
0
    QVirtioPCIDevice *dev = container_of(d, QVirtioPCIDevice, vdev);
95
0
    return qpci_io_readl(dev->pdev, dev->bar, VIRTIO_PCI_HOST_FEATURES);
96
0
}
97
98
static void qvirtio_pci_set_features(QVirtioDevice *d, uint64_t features)
99
0
{
100
0
    QVirtioPCIDevice *dev = container_of(d, QVirtioPCIDevice, vdev);
101
0
    qpci_io_writel(dev->pdev, dev->bar, VIRTIO_PCI_GUEST_FEATURES, features);
102
0
}
103
104
static uint64_t qvirtio_pci_get_guest_features(QVirtioDevice *d)
105
0
{
106
0
    QVirtioPCIDevice *dev = container_of(d, QVirtioPCIDevice, vdev);
107
0
    return qpci_io_readl(dev->pdev, dev->bar, VIRTIO_PCI_GUEST_FEATURES);
108
0
}
109
110
static uint8_t qvirtio_pci_get_status(QVirtioDevice *d)
111
0
{
112
0
    QVirtioPCIDevice *dev = container_of(d, QVirtioPCIDevice, vdev);
113
0
    return qpci_io_readb(dev->pdev, dev->bar, VIRTIO_PCI_STATUS);
114
0
}
115
116
static void qvirtio_pci_set_status(QVirtioDevice *d, uint8_t status)
117
0
{
118
0
    QVirtioPCIDevice *dev = container_of(d, QVirtioPCIDevice, vdev);
119
0
    qpci_io_writeb(dev->pdev, dev->bar, VIRTIO_PCI_STATUS, status);
120
0
}
121
122
static bool qvirtio_pci_get_queue_isr_status(QVirtioDevice *d, QVirtQueue *vq)
123
0
{
124
0
    QVirtioPCIDevice *dev = container_of(d, QVirtioPCIDevice, vdev);
125
126
0
    if (dev->pdev->msix_enabled) {
127
0
        QVirtQueuePCI *vqpci = (QVirtQueuePCI *)vq;
128
129
0
        return qpci_msix_test_interrupt(dev->pdev, vqpci->msix_entry,
130
0
                                        vqpci->msix_addr, vqpci->msix_data);
131
0
    } else {
132
0
        return qpci_io_readb(dev->pdev, dev->bar, VIRTIO_PCI_ISR) & 1;
133
0
    }
134
0
}
135
136
static bool qvirtio_pci_get_config_isr_status(QVirtioDevice *d)
137
0
{
138
0
    QVirtioPCIDevice *dev = container_of(d, QVirtioPCIDevice, vdev);
139
140
0
    if (dev->pdev->msix_enabled) {
141
0
        return qpci_msix_test_interrupt(dev->pdev, dev->config_msix_entry,
142
0
                                        dev->config_msix_addr,
143
0
                                        dev->config_msix_data);
144
0
    } else {
145
0
        return qpci_io_readb(dev->pdev, dev->bar, VIRTIO_PCI_ISR) & 2;
146
0
    }
147
0
}
148
149
static void qvirtio_pci_wait_config_isr_status(QVirtioDevice *d,
150
                                               gint64 timeout_us)
151
0
{
152
0
    gint64 start_time = g_get_monotonic_time();
153
154
0
    while (!qvirtio_pci_get_config_isr_status(d)) {
155
0
        g_assert(g_get_monotonic_time() - start_time <= timeout_us);
156
0
    }
157
0
}
158
159
static void qvirtio_pci_queue_select(QVirtioDevice *d, uint16_t index)
160
0
{
161
0
    QVirtioPCIDevice *dev = container_of(d, QVirtioPCIDevice, vdev);
162
0
    qpci_io_writeb(dev->pdev, dev->bar, VIRTIO_PCI_QUEUE_SEL, index);
163
0
}
164
165
static uint16_t qvirtio_pci_get_queue_size(QVirtioDevice *d)
166
0
{
167
0
    QVirtioPCIDevice *dev = container_of(d, QVirtioPCIDevice, vdev);
168
0
    return qpci_io_readw(dev->pdev, dev->bar, VIRTIO_PCI_QUEUE_NUM);
169
0
}
170
171
static void qvirtio_pci_set_queue_address(QVirtioDevice *d, QVirtQueue *vq)
172
0
{
173
0
    QVirtioPCIDevice *dev = container_of(d, QVirtioPCIDevice, vdev);
174
0
    uint64_t pfn = vq->desc / VIRTIO_PCI_VRING_ALIGN;
175
176
0
    qpci_io_writel(dev->pdev, dev->bar, VIRTIO_PCI_QUEUE_PFN, pfn);
177
0
}
178
179
QVirtQueue *qvirtio_pci_virtqueue_setup_common(QVirtioDevice *d,
180
                                               QGuestAllocator *alloc,
181
                                               uint16_t index)
182
0
{
183
0
    uint64_t feat;
184
0
    uint64_t addr;
185
0
    QVirtQueuePCI *vqpci;
186
0
    QVirtioPCIDevice *qvpcidev = container_of(d, QVirtioPCIDevice, vdev);
187
188
0
    vqpci = g_malloc0(sizeof(*vqpci));
189
0
    feat = d->bus->get_guest_features(d);
190
191
0
    d->bus->queue_select(d, index);
192
0
    vqpci->vq.vdev = d;
193
0
    vqpci->vq.index = index;
194
0
    vqpci->vq.size = d->bus->get_queue_size(d);
195
0
    vqpci->vq.free_head = 0;
196
0
    vqpci->vq.num_free = vqpci->vq.size;
197
0
    vqpci->vq.align = VIRTIO_PCI_VRING_ALIGN;
198
0
    vqpci->vq.indirect = feat & (1ull << VIRTIO_RING_F_INDIRECT_DESC);
199
0
    vqpci->vq.event = feat & (1ull << VIRTIO_RING_F_EVENT_IDX);
200
201
0
    vqpci->msix_entry = -1;
202
0
    vqpci->msix_addr = 0;
203
0
    vqpci->msix_data = 0x12345678;
204
205
    /* Check different than 0 */
206
0
    g_assert_cmpint(vqpci->vq.size, !=, 0);
207
208
    /* Check power of 2 */
209
0
    g_assert_cmpint(vqpci->vq.size & (vqpci->vq.size - 1), ==, 0);
210
211
0
    addr = guest_alloc(alloc, qvring_size(vqpci->vq.size,
212
0
                                          VIRTIO_PCI_VRING_ALIGN));
213
0
    qvring_init(qvpcidev->pdev->bus->qts, alloc, &vqpci->vq, addr);
214
0
    d->bus->set_queue_address(d, &vqpci->vq);
215
216
0
    return &vqpci->vq;
217
0
}
218
219
void qvirtio_pci_virtqueue_cleanup_common(QVirtQueue *vq,
220
                                          QGuestAllocator *alloc)
221
0
{
222
0
    QVirtQueuePCI *vqpci = container_of(vq, QVirtQueuePCI, vq);
223
224
0
    guest_free(alloc, vq->desc);
225
0
    g_free(vqpci);
226
0
}
227
228
static void qvirtio_pci_virtqueue_kick(QVirtioDevice *d, QVirtQueue *vq)
229
0
{
230
0
    QVirtioPCIDevice *dev = container_of(d, QVirtioPCIDevice, vdev);
231
0
    qpci_io_writew(dev->pdev, dev->bar, VIRTIO_PCI_QUEUE_NOTIFY, vq->index);
232
0
}
233
234
static const QVirtioBus qvirtio_pci_legacy = {
235
    .config_readb = qvirtio_pci_config_readb,
236
    .config_readw = qvirtio_pci_config_readw,
237
    .config_readl = qvirtio_pci_config_readl,
238
    .config_readq = qvirtio_pci_config_readq,
239
    .get_features = qvirtio_pci_get_features,
240
    .set_features = qvirtio_pci_set_features,
241
    .get_guest_features = qvirtio_pci_get_guest_features,
242
    .get_status = qvirtio_pci_get_status,
243
    .set_status = qvirtio_pci_set_status,
244
    .get_queue_isr_status = qvirtio_pci_get_queue_isr_status,
245
    .wait_config_isr_status = qvirtio_pci_wait_config_isr_status,
246
    .queue_select = qvirtio_pci_queue_select,
247
    .get_queue_size = qvirtio_pci_get_queue_size,
248
    .set_queue_address = qvirtio_pci_set_queue_address,
249
    .virtqueue_setup = qvirtio_pci_virtqueue_setup_common,
250
    .virtqueue_cleanup = qvirtio_pci_virtqueue_cleanup_common,
251
    .virtqueue_kick = qvirtio_pci_virtqueue_kick,
252
};
253
254
static void qvirtio_pci_set_config_vector(QVirtioPCIDevice *d, uint16_t entry)
255
0
{
256
0
    uint16_t vector;
257
258
0
    qpci_io_writew(d->pdev, d->bar, VIRTIO_MSI_CONFIG_VECTOR, entry);
259
0
    vector = qpci_io_readw(d->pdev, d->bar, VIRTIO_MSI_CONFIG_VECTOR);
260
0
    g_assert_cmphex(vector, !=, VIRTIO_MSI_NO_VECTOR);
261
0
}
262
263
static void qvirtio_pci_set_queue_vector(QVirtioPCIDevice *d, uint16_t vq_idx,
264
                                         uint16_t entry)
265
0
{
266
0
    uint16_t vector;
267
268
0
    qvirtio_pci_queue_select(&d->vdev, vq_idx);
269
0
    qpci_io_writew(d->pdev, d->bar, VIRTIO_MSI_QUEUE_VECTOR, entry);
270
0
    vector = qpci_io_readw(d->pdev, d->bar, VIRTIO_MSI_QUEUE_VECTOR);
271
0
    g_assert_cmphex(vector, !=, VIRTIO_MSI_NO_VECTOR);
272
0
}
273
274
static const QVirtioPCIMSIXOps qvirtio_pci_msix_ops_legacy = {
275
    .set_config_vector = qvirtio_pci_set_config_vector,
276
    .set_queue_vector = qvirtio_pci_set_queue_vector,
277
};
278
279
void qvirtio_pci_device_enable(QVirtioPCIDevice *d)
280
0
{
281
0
    qpci_device_enable(d->pdev);
282
0
    d->bar = qpci_iomap(d->pdev, d->bar_idx, NULL);
283
0
}
284
285
void qvirtio_pci_device_disable(QVirtioPCIDevice *d)
286
0
{
287
0
    qpci_iounmap(d->pdev, d->bar);
288
0
}
289
290
void qvirtqueue_pci_msix_setup(QVirtioPCIDevice *d, QVirtQueuePCI *vqpci,
291
                                        QGuestAllocator *alloc, uint16_t entry)
292
0
{
293
0
    g_assert(d->pdev->msix_enabled);
294
0
    vqpci->msix_entry = entry;
295
0
    vqpci->msix_addr = guest_alloc(alloc, 4);
296
0
    qtest_memset(d->pdev->bus->qts, vqpci->msix_addr, 0, 4);
297
298
0
    qpci_msix_set_entry(d->pdev, entry, vqpci->msix_addr, vqpci->msix_data);
299
0
    qpci_msix_set_masked(d->pdev, entry, false);
300
0
    d->msix_ops->set_queue_vector(d, vqpci->vq.index, entry);
301
0
}
302
303
void qvirtio_pci_set_msix_configuration_vector(QVirtioPCIDevice *d,
304
                                        QGuestAllocator *alloc, uint16_t entry)
305
0
{
306
0
    g_assert(d->pdev->msix_enabled);
307
0
    d->config_msix_entry = entry;
308
0
    d->config_msix_data = 0x12345678;
309
0
    d->config_msix_addr = guest_alloc(alloc, 4);
310
0
    qtest_memset(d->pdev->bus->qts, d->config_msix_addr, 0, 4);
311
312
0
    qpci_msix_set_entry(d->pdev, entry, d->config_msix_addr,
313
0
                                        d->config_msix_data);
314
0
    qpci_msix_set_masked(d->pdev, entry, false);
315
0
    d->msix_ops->set_config_vector(d, entry);
316
0
}
317
318
void qvirtio_pci_destructor(QOSGraphObject *obj)
319
0
{
320
0
    QVirtioPCIDevice *dev = (QVirtioPCIDevice *)obj;
321
0
    qvirtio_pci_device_disable(dev);
322
0
    g_free(dev->pdev);
323
0
}
324
325
void qvirtio_pci_start_hw(QOSGraphObject *obj)
326
0
{
327
0
    QVirtioPCIDevice *dev = (QVirtioPCIDevice *)obj;
328
0
    qvirtio_pci_device_enable(dev);
329
0
    qvirtio_start_device(&dev->vdev);
330
0
}
331
332
static void qvirtio_pci_init_legacy(QVirtioPCIDevice *dev)
333
0
{
334
0
    dev->vdev.device_type = qpci_config_readw(dev->pdev, PCI_SUBSYSTEM_ID);
335
0
    dev->bar_idx = 0;
336
0
    dev->vdev.bus = &qvirtio_pci_legacy;
337
0
    dev->msix_ops = &qvirtio_pci_msix_ops_legacy;
338
0
    dev->vdev.big_endian = qtest_big_endian(dev->pdev->bus->qts);
339
0
}
340
341
static void qvirtio_pci_init_from_pcidev(QVirtioPCIDevice *dev, QPCIDevice *pci_dev)
342
0
{
343
0
    dev->pdev = pci_dev;
344
0
    dev->config_msix_entry = -1;
345
346
0
    if (!qvirtio_pci_init_virtio_1(dev)) {
347
0
        qvirtio_pci_init_legacy(dev);
348
0
    }
349
350
    /* each virtio-xxx-pci device should override at least this function */
351
0
    dev->obj.get_driver = NULL;
352
0
    dev->obj.start_hw = qvirtio_pci_start_hw;
353
0
    dev->obj.destructor = qvirtio_pci_destructor;
354
0
}
355
356
void virtio_pci_init(QVirtioPCIDevice *dev, QPCIBus *bus, QPCIAddress * addr)
357
0
{
358
0
    QPCIDevice *pci_dev = qpci_device_find(bus, addr->devfn);
359
0
    g_assert_nonnull(pci_dev);
360
0
    qvirtio_pci_init_from_pcidev(dev, pci_dev);
361
0
}
362
363
QVirtioPCIDevice *virtio_pci_new(QPCIBus *bus, QPCIAddress * addr)
364
0
{
365
0
    QVirtioPCIDevice *dev;
366
0
    QPCIDevice *pci_dev = qpci_device_find(bus, addr->devfn);
367
0
    if (!pci_dev) {
368
0
        return NULL;
369
0
    }
370
371
0
    dev = g_new0(QVirtioPCIDevice, 1);
372
0
    qvirtio_pci_init_from_pcidev(dev, pci_dev);
373
0
    dev->obj.free = g_free;
374
0
    return dev;
375
0
}