xref: /openbmc/qemu/hw/vfio/pci.c (revision 891f8dcd)
1 /*
2  * vfio based device assignment support
3  *
4  * Copyright Red Hat, Inc. 2012
5  *
6  * Authors:
7  *  Alex Williamson <alex.williamson@redhat.com>
8  *
9  * This work is licensed under the terms of the GNU GPL, version 2.  See
10  * the COPYING file in the top-level directory.
11  *
12  * Based on qemu-kvm device-assignment:
13  *  Adapted for KVM by Qumranet.
14  *  Copyright (c) 2007, Neocleus, Alex Novik (alex@neocleus.com)
15  *  Copyright (c) 2007, Neocleus, Guy Zana (guy@neocleus.com)
16  *  Copyright (C) 2008, Qumranet, Amit Shah (amit.shah@qumranet.com)
17  *  Copyright (C) 2008, Red Hat, Amit Shah (amit.shah@redhat.com)
18  *  Copyright (C) 2008, IBM, Muli Ben-Yehuda (muli@il.ibm.com)
19  */
20 
21 #include "qemu/osdep.h"
22 #include <linux/vfio.h>
23 #include <sys/ioctl.h>
24 #include <sys/mman.h>
25 
26 #include "hw/pci/msi.h"
27 #include "hw/pci/msix.h"
28 #include "hw/pci/pci_bridge.h"
29 #include "qemu/error-report.h"
30 #include "qemu/range.h"
31 #include "sysemu/kvm.h"
32 #include "sysemu/sysemu.h"
33 #include "pci.h"
34 #include "trace.h"
35 
36 #define MSIX_CAP_LENGTH 12
37 
38 static void vfio_disable_interrupts(VFIOPCIDevice *vdev);
39 static void vfio_mmap_set_enabled(VFIOPCIDevice *vdev, bool enabled);
40 
41 /*
42  * Disabling BAR mmaping can be slow, but toggling it around INTx can
43  * also be a huge overhead.  We try to get the best of both worlds by
44  * waiting until an interrupt to disable mmaps (subsequent transitions
45  * to the same state are effectively no overhead).  If the interrupt has
46  * been serviced and the time gap is long enough, we re-enable mmaps for
47  * performance.  This works well for things like graphics cards, which
48  * may not use their interrupt at all and are penalized to an unusable
49  * level by read/write BAR traps.  Other devices, like NICs, have more
50  * regular interrupts and see much better latency by staying in non-mmap
51  * mode.  We therefore set the default mmap_timeout such that a ping
52  * is just enough to keep the mmap disabled.  Users can experiment with
53  * other options with the x-intx-mmap-timeout-ms parameter (a value of
54  * zero disables the timer).
55  */
56 static void vfio_intx_mmap_enable(void *opaque)
57 {
58     VFIOPCIDevice *vdev = opaque;
59 
60     if (vdev->intx.pending) {
61         timer_mod(vdev->intx.mmap_timer,
62                        qemu_clock_get_ms(QEMU_CLOCK_VIRTUAL) + vdev->intx.mmap_timeout);
63         return;
64     }
65 
66     vfio_mmap_set_enabled(vdev, true);
67 }
68 
69 static void vfio_intx_interrupt(void *opaque)
70 {
71     VFIOPCIDevice *vdev = opaque;
72 
73     if (!event_notifier_test_and_clear(&vdev->intx.interrupt)) {
74         return;
75     }
76 
77     trace_vfio_intx_interrupt(vdev->vbasedev.name, 'A' + vdev->intx.pin);
78 
79     vdev->intx.pending = true;
80     pci_irq_assert(&vdev->pdev);
81     vfio_mmap_set_enabled(vdev, false);
82     if (vdev->intx.mmap_timeout) {
83         timer_mod(vdev->intx.mmap_timer,
84                        qemu_clock_get_ms(QEMU_CLOCK_VIRTUAL) + vdev->intx.mmap_timeout);
85     }
86 }
87 
88 static void vfio_intx_eoi(VFIODevice *vbasedev)
89 {
90     VFIOPCIDevice *vdev = container_of(vbasedev, VFIOPCIDevice, vbasedev);
91 
92     if (!vdev->intx.pending) {
93         return;
94     }
95 
96     trace_vfio_intx_eoi(vbasedev->name);
97 
98     vdev->intx.pending = false;
99     pci_irq_deassert(&vdev->pdev);
100     vfio_unmask_single_irqindex(vbasedev, VFIO_PCI_INTX_IRQ_INDEX);
101 }
102 
103 static void vfio_intx_enable_kvm(VFIOPCIDevice *vdev)
104 {
105 #ifdef CONFIG_KVM
106     struct kvm_irqfd irqfd = {
107         .fd = event_notifier_get_fd(&vdev->intx.interrupt),
108         .gsi = vdev->intx.route.irq,
109         .flags = KVM_IRQFD_FLAG_RESAMPLE,
110     };
111     struct vfio_irq_set *irq_set;
112     int ret, argsz;
113     int32_t *pfd;
114 
115     if (vdev->no_kvm_intx || !kvm_irqfds_enabled() ||
116         vdev->intx.route.mode != PCI_INTX_ENABLED ||
117         !kvm_resamplefds_enabled()) {
118         return;
119     }
120 
121     /* Get to a known interrupt state */
122     qemu_set_fd_handler(irqfd.fd, NULL, NULL, vdev);
123     vfio_mask_single_irqindex(&vdev->vbasedev, VFIO_PCI_INTX_IRQ_INDEX);
124     vdev->intx.pending = false;
125     pci_irq_deassert(&vdev->pdev);
126 
127     /* Get an eventfd for resample/unmask */
128     if (event_notifier_init(&vdev->intx.unmask, 0)) {
129         error_report("vfio: Error: event_notifier_init failed eoi");
130         goto fail;
131     }
132 
133     /* KVM triggers it, VFIO listens for it */
134     irqfd.resamplefd = event_notifier_get_fd(&vdev->intx.unmask);
135 
136     if (kvm_vm_ioctl(kvm_state, KVM_IRQFD, &irqfd)) {
137         error_report("vfio: Error: Failed to setup resample irqfd: %m");
138         goto fail_irqfd;
139     }
140 
141     argsz = sizeof(*irq_set) + sizeof(*pfd);
142 
143     irq_set = g_malloc0(argsz);
144     irq_set->argsz = argsz;
145     irq_set->flags = VFIO_IRQ_SET_DATA_EVENTFD | VFIO_IRQ_SET_ACTION_UNMASK;
146     irq_set->index = VFIO_PCI_INTX_IRQ_INDEX;
147     irq_set->start = 0;
148     irq_set->count = 1;
149     pfd = (int32_t *)&irq_set->data;
150 
151     *pfd = irqfd.resamplefd;
152 
153     ret = ioctl(vdev->vbasedev.fd, VFIO_DEVICE_SET_IRQS, irq_set);
154     g_free(irq_set);
155     if (ret) {
156         error_report("vfio: Error: Failed to setup INTx unmask fd: %m");
157         goto fail_vfio;
158     }
159 
160     /* Let'em rip */
161     vfio_unmask_single_irqindex(&vdev->vbasedev, VFIO_PCI_INTX_IRQ_INDEX);
162 
163     vdev->intx.kvm_accel = true;
164 
165     trace_vfio_intx_enable_kvm(vdev->vbasedev.name);
166 
167     return;
168 
169 fail_vfio:
170     irqfd.flags = KVM_IRQFD_FLAG_DEASSIGN;
171     kvm_vm_ioctl(kvm_state, KVM_IRQFD, &irqfd);
172 fail_irqfd:
173     event_notifier_cleanup(&vdev->intx.unmask);
174 fail:
175     qemu_set_fd_handler(irqfd.fd, vfio_intx_interrupt, NULL, vdev);
176     vfio_unmask_single_irqindex(&vdev->vbasedev, VFIO_PCI_INTX_IRQ_INDEX);
177 #endif
178 }
179 
180 static void vfio_intx_disable_kvm(VFIOPCIDevice *vdev)
181 {
182 #ifdef CONFIG_KVM
183     struct kvm_irqfd irqfd = {
184         .fd = event_notifier_get_fd(&vdev->intx.interrupt),
185         .gsi = vdev->intx.route.irq,
186         .flags = KVM_IRQFD_FLAG_DEASSIGN,
187     };
188 
189     if (!vdev->intx.kvm_accel) {
190         return;
191     }
192 
193     /*
194      * Get to a known state, hardware masked, QEMU ready to accept new
195      * interrupts, QEMU IRQ de-asserted.
196      */
197     vfio_mask_single_irqindex(&vdev->vbasedev, VFIO_PCI_INTX_IRQ_INDEX);
198     vdev->intx.pending = false;
199     pci_irq_deassert(&vdev->pdev);
200 
201     /* Tell KVM to stop listening for an INTx irqfd */
202     if (kvm_vm_ioctl(kvm_state, KVM_IRQFD, &irqfd)) {
203         error_report("vfio: Error: Failed to disable INTx irqfd: %m");
204     }
205 
206     /* We only need to close the eventfd for VFIO to cleanup the kernel side */
207     event_notifier_cleanup(&vdev->intx.unmask);
208 
209     /* QEMU starts listening for interrupt events. */
210     qemu_set_fd_handler(irqfd.fd, vfio_intx_interrupt, NULL, vdev);
211 
212     vdev->intx.kvm_accel = false;
213 
214     /* If we've missed an event, let it re-fire through QEMU */
215     vfio_unmask_single_irqindex(&vdev->vbasedev, VFIO_PCI_INTX_IRQ_INDEX);
216 
217     trace_vfio_intx_disable_kvm(vdev->vbasedev.name);
218 #endif
219 }
220 
221 static void vfio_intx_update(PCIDevice *pdev)
222 {
223     VFIOPCIDevice *vdev = DO_UPCAST(VFIOPCIDevice, pdev, pdev);
224     PCIINTxRoute route;
225 
226     if (vdev->interrupt != VFIO_INT_INTx) {
227         return;
228     }
229 
230     route = pci_device_route_intx_to_irq(&vdev->pdev, vdev->intx.pin);
231 
232     if (!pci_intx_route_changed(&vdev->intx.route, &route)) {
233         return; /* Nothing changed */
234     }
235 
236     trace_vfio_intx_update(vdev->vbasedev.name,
237                            vdev->intx.route.irq, route.irq);
238 
239     vfio_intx_disable_kvm(vdev);
240 
241     vdev->intx.route = route;
242 
243     if (route.mode != PCI_INTX_ENABLED) {
244         return;
245     }
246 
247     vfio_intx_enable_kvm(vdev);
248 
249     /* Re-enable the interrupt in cased we missed an EOI */
250     vfio_intx_eoi(&vdev->vbasedev);
251 }
252 
253 static int vfio_intx_enable(VFIOPCIDevice *vdev)
254 {
255     uint8_t pin = vfio_pci_read_config(&vdev->pdev, PCI_INTERRUPT_PIN, 1);
256     int ret, argsz;
257     struct vfio_irq_set *irq_set;
258     int32_t *pfd;
259 
260     if (!pin) {
261         return 0;
262     }
263 
264     vfio_disable_interrupts(vdev);
265 
266     vdev->intx.pin = pin - 1; /* Pin A (1) -> irq[0] */
267     pci_config_set_interrupt_pin(vdev->pdev.config, pin);
268 
269 #ifdef CONFIG_KVM
270     /*
271      * Only conditional to avoid generating error messages on platforms
272      * where we won't actually use the result anyway.
273      */
274     if (kvm_irqfds_enabled() && kvm_resamplefds_enabled()) {
275         vdev->intx.route = pci_device_route_intx_to_irq(&vdev->pdev,
276                                                         vdev->intx.pin);
277     }
278 #endif
279 
280     ret = event_notifier_init(&vdev->intx.interrupt, 0);
281     if (ret) {
282         error_report("vfio: Error: event_notifier_init failed");
283         return ret;
284     }
285 
286     argsz = sizeof(*irq_set) + sizeof(*pfd);
287 
288     irq_set = g_malloc0(argsz);
289     irq_set->argsz = argsz;
290     irq_set->flags = VFIO_IRQ_SET_DATA_EVENTFD | VFIO_IRQ_SET_ACTION_TRIGGER;
291     irq_set->index = VFIO_PCI_INTX_IRQ_INDEX;
292     irq_set->start = 0;
293     irq_set->count = 1;
294     pfd = (int32_t *)&irq_set->data;
295 
296     *pfd = event_notifier_get_fd(&vdev->intx.interrupt);
297     qemu_set_fd_handler(*pfd, vfio_intx_interrupt, NULL, vdev);
298 
299     ret = ioctl(vdev->vbasedev.fd, VFIO_DEVICE_SET_IRQS, irq_set);
300     g_free(irq_set);
301     if (ret) {
302         error_report("vfio: Error: Failed to setup INTx fd: %m");
303         qemu_set_fd_handler(*pfd, NULL, NULL, vdev);
304         event_notifier_cleanup(&vdev->intx.interrupt);
305         return -errno;
306     }
307 
308     vfio_intx_enable_kvm(vdev);
309 
310     vdev->interrupt = VFIO_INT_INTx;
311 
312     trace_vfio_intx_enable(vdev->vbasedev.name);
313 
314     return 0;
315 }
316 
317 static void vfio_intx_disable(VFIOPCIDevice *vdev)
318 {
319     int fd;
320 
321     timer_del(vdev->intx.mmap_timer);
322     vfio_intx_disable_kvm(vdev);
323     vfio_disable_irqindex(&vdev->vbasedev, VFIO_PCI_INTX_IRQ_INDEX);
324     vdev->intx.pending = false;
325     pci_irq_deassert(&vdev->pdev);
326     vfio_mmap_set_enabled(vdev, true);
327 
328     fd = event_notifier_get_fd(&vdev->intx.interrupt);
329     qemu_set_fd_handler(fd, NULL, NULL, vdev);
330     event_notifier_cleanup(&vdev->intx.interrupt);
331 
332     vdev->interrupt = VFIO_INT_NONE;
333 
334     trace_vfio_intx_disable(vdev->vbasedev.name);
335 }
336 
337 /*
338  * MSI/X
339  */
340 static void vfio_msi_interrupt(void *opaque)
341 {
342     VFIOMSIVector *vector = opaque;
343     VFIOPCIDevice *vdev = vector->vdev;
344     MSIMessage (*get_msg)(PCIDevice *dev, unsigned vector);
345     void (*notify)(PCIDevice *dev, unsigned vector);
346     MSIMessage msg;
347     int nr = vector - vdev->msi_vectors;
348 
349     if (!event_notifier_test_and_clear(&vector->interrupt)) {
350         return;
351     }
352 
353     if (vdev->interrupt == VFIO_INT_MSIX) {
354         get_msg = msix_get_message;
355         notify = msix_notify;
356 
357         /* A masked vector firing needs to use the PBA, enable it */
358         if (msix_is_masked(&vdev->pdev, nr)) {
359             set_bit(nr, vdev->msix->pending);
360             memory_region_set_enabled(&vdev->pdev.msix_pba_mmio, true);
361             trace_vfio_msix_pba_enable(vdev->vbasedev.name);
362         }
363     } else if (vdev->interrupt == VFIO_INT_MSI) {
364         get_msg = msi_get_message;
365         notify = msi_notify;
366     } else {
367         abort();
368     }
369 
370     msg = get_msg(&vdev->pdev, nr);
371     trace_vfio_msi_interrupt(vdev->vbasedev.name, nr, msg.address, msg.data);
372     notify(&vdev->pdev, nr);
373 }
374 
375 static int vfio_enable_vectors(VFIOPCIDevice *vdev, bool msix)
376 {
377     struct vfio_irq_set *irq_set;
378     int ret = 0, i, argsz;
379     int32_t *fds;
380 
381     argsz = sizeof(*irq_set) + (vdev->nr_vectors * sizeof(*fds));
382 
383     irq_set = g_malloc0(argsz);
384     irq_set->argsz = argsz;
385     irq_set->flags = VFIO_IRQ_SET_DATA_EVENTFD | VFIO_IRQ_SET_ACTION_TRIGGER;
386     irq_set->index = msix ? VFIO_PCI_MSIX_IRQ_INDEX : VFIO_PCI_MSI_IRQ_INDEX;
387     irq_set->start = 0;
388     irq_set->count = vdev->nr_vectors;
389     fds = (int32_t *)&irq_set->data;
390 
391     for (i = 0; i < vdev->nr_vectors; i++) {
392         int fd = -1;
393 
394         /*
395          * MSI vs MSI-X - The guest has direct access to MSI mask and pending
396          * bits, therefore we always use the KVM signaling path when setup.
397          * MSI-X mask and pending bits are emulated, so we want to use the
398          * KVM signaling path only when configured and unmasked.
399          */
400         if (vdev->msi_vectors[i].use) {
401             if (vdev->msi_vectors[i].virq < 0 ||
402                 (msix && msix_is_masked(&vdev->pdev, i))) {
403                 fd = event_notifier_get_fd(&vdev->msi_vectors[i].interrupt);
404             } else {
405                 fd = event_notifier_get_fd(&vdev->msi_vectors[i].kvm_interrupt);
406             }
407         }
408 
409         fds[i] = fd;
410     }
411 
412     ret = ioctl(vdev->vbasedev.fd, VFIO_DEVICE_SET_IRQS, irq_set);
413 
414     g_free(irq_set);
415 
416     return ret;
417 }
418 
419 static void vfio_add_kvm_msi_virq(VFIOPCIDevice *vdev, VFIOMSIVector *vector,
420                                   MSIMessage *msg, bool msix)
421 {
422     int virq;
423 
424     if ((msix && vdev->no_kvm_msix) || (!msix && vdev->no_kvm_msi) || !msg) {
425         return;
426     }
427 
428     if (event_notifier_init(&vector->kvm_interrupt, 0)) {
429         return;
430     }
431 
432     virq = kvm_irqchip_add_msi_route(kvm_state, *msg, &vdev->pdev);
433     if (virq < 0) {
434         event_notifier_cleanup(&vector->kvm_interrupt);
435         return;
436     }
437 
438     if (kvm_irqchip_add_irqfd_notifier_gsi(kvm_state, &vector->kvm_interrupt,
439                                        NULL, virq) < 0) {
440         kvm_irqchip_release_virq(kvm_state, virq);
441         event_notifier_cleanup(&vector->kvm_interrupt);
442         return;
443     }
444 
445     vector->virq = virq;
446 }
447 
448 static void vfio_remove_kvm_msi_virq(VFIOMSIVector *vector)
449 {
450     kvm_irqchip_remove_irqfd_notifier_gsi(kvm_state, &vector->kvm_interrupt,
451                                           vector->virq);
452     kvm_irqchip_release_virq(kvm_state, vector->virq);
453     vector->virq = -1;
454     event_notifier_cleanup(&vector->kvm_interrupt);
455 }
456 
457 static void vfio_update_kvm_msi_virq(VFIOMSIVector *vector, MSIMessage msg,
458                                      PCIDevice *pdev)
459 {
460     kvm_irqchip_update_msi_route(kvm_state, vector->virq, msg, pdev);
461 }
462 
463 static int vfio_msix_vector_do_use(PCIDevice *pdev, unsigned int nr,
464                                    MSIMessage *msg, IOHandler *handler)
465 {
466     VFIOPCIDevice *vdev = DO_UPCAST(VFIOPCIDevice, pdev, pdev);
467     VFIOMSIVector *vector;
468     int ret;
469 
470     trace_vfio_msix_vector_do_use(vdev->vbasedev.name, nr);
471 
472     vector = &vdev->msi_vectors[nr];
473 
474     if (!vector->use) {
475         vector->vdev = vdev;
476         vector->virq = -1;
477         if (event_notifier_init(&vector->interrupt, 0)) {
478             error_report("vfio: Error: event_notifier_init failed");
479         }
480         vector->use = true;
481         msix_vector_use(pdev, nr);
482     }
483 
484     qemu_set_fd_handler(event_notifier_get_fd(&vector->interrupt),
485                         handler, NULL, vector);
486 
487     /*
488      * Attempt to enable route through KVM irqchip,
489      * default to userspace handling if unavailable.
490      */
491     if (vector->virq >= 0) {
492         if (!msg) {
493             vfio_remove_kvm_msi_virq(vector);
494         } else {
495             vfio_update_kvm_msi_virq(vector, *msg, pdev);
496         }
497     } else {
498         vfio_add_kvm_msi_virq(vdev, vector, msg, true);
499     }
500 
501     /*
502      * We don't want to have the host allocate all possible MSI vectors
503      * for a device if they're not in use, so we shutdown and incrementally
504      * increase them as needed.
505      */
506     if (vdev->nr_vectors < nr + 1) {
507         vfio_disable_irqindex(&vdev->vbasedev, VFIO_PCI_MSIX_IRQ_INDEX);
508         vdev->nr_vectors = nr + 1;
509         ret = vfio_enable_vectors(vdev, true);
510         if (ret) {
511             error_report("vfio: failed to enable vectors, %d", ret);
512         }
513     } else {
514         int argsz;
515         struct vfio_irq_set *irq_set;
516         int32_t *pfd;
517 
518         argsz = sizeof(*irq_set) + sizeof(*pfd);
519 
520         irq_set = g_malloc0(argsz);
521         irq_set->argsz = argsz;
522         irq_set->flags = VFIO_IRQ_SET_DATA_EVENTFD |
523                          VFIO_IRQ_SET_ACTION_TRIGGER;
524         irq_set->index = VFIO_PCI_MSIX_IRQ_INDEX;
525         irq_set->start = nr;
526         irq_set->count = 1;
527         pfd = (int32_t *)&irq_set->data;
528 
529         if (vector->virq >= 0) {
530             *pfd = event_notifier_get_fd(&vector->kvm_interrupt);
531         } else {
532             *pfd = event_notifier_get_fd(&vector->interrupt);
533         }
534 
535         ret = ioctl(vdev->vbasedev.fd, VFIO_DEVICE_SET_IRQS, irq_set);
536         g_free(irq_set);
537         if (ret) {
538             error_report("vfio: failed to modify vector, %d", ret);
539         }
540     }
541 
542     /* Disable PBA emulation when nothing more is pending. */
543     clear_bit(nr, vdev->msix->pending);
544     if (find_first_bit(vdev->msix->pending,
545                        vdev->nr_vectors) == vdev->nr_vectors) {
546         memory_region_set_enabled(&vdev->pdev.msix_pba_mmio, false);
547         trace_vfio_msix_pba_disable(vdev->vbasedev.name);
548     }
549 
550     return 0;
551 }
552 
553 static int vfio_msix_vector_use(PCIDevice *pdev,
554                                 unsigned int nr, MSIMessage msg)
555 {
556     return vfio_msix_vector_do_use(pdev, nr, &msg, vfio_msi_interrupt);
557 }
558 
559 static void vfio_msix_vector_release(PCIDevice *pdev, unsigned int nr)
560 {
561     VFIOPCIDevice *vdev = DO_UPCAST(VFIOPCIDevice, pdev, pdev);
562     VFIOMSIVector *vector = &vdev->msi_vectors[nr];
563 
564     trace_vfio_msix_vector_release(vdev->vbasedev.name, nr);
565 
566     /*
567      * There are still old guests that mask and unmask vectors on every
568      * interrupt.  If we're using QEMU bypass with a KVM irqfd, leave all of
569      * the KVM setup in place, simply switch VFIO to use the non-bypass
570      * eventfd.  We'll then fire the interrupt through QEMU and the MSI-X
571      * core will mask the interrupt and set pending bits, allowing it to
572      * be re-asserted on unmask.  Nothing to do if already using QEMU mode.
573      */
574     if (vector->virq >= 0) {
575         int argsz;
576         struct vfio_irq_set *irq_set;
577         int32_t *pfd;
578 
579         argsz = sizeof(*irq_set) + sizeof(*pfd);
580 
581         irq_set = g_malloc0(argsz);
582         irq_set->argsz = argsz;
583         irq_set->flags = VFIO_IRQ_SET_DATA_EVENTFD |
584                          VFIO_IRQ_SET_ACTION_TRIGGER;
585         irq_set->index = VFIO_PCI_MSIX_IRQ_INDEX;
586         irq_set->start = nr;
587         irq_set->count = 1;
588         pfd = (int32_t *)&irq_set->data;
589 
590         *pfd = event_notifier_get_fd(&vector->interrupt);
591 
592         ioctl(vdev->vbasedev.fd, VFIO_DEVICE_SET_IRQS, irq_set);
593 
594         g_free(irq_set);
595     }
596 }
597 
598 static void vfio_msix_enable(VFIOPCIDevice *vdev)
599 {
600     vfio_disable_interrupts(vdev);
601 
602     vdev->msi_vectors = g_new0(VFIOMSIVector, vdev->msix->entries);
603 
604     vdev->interrupt = VFIO_INT_MSIX;
605 
606     /*
607      * Some communication channels between VF & PF or PF & fw rely on the
608      * physical state of the device and expect that enabling MSI-X from the
609      * guest enables the same on the host.  When our guest is Linux, the
610      * guest driver call to pci_enable_msix() sets the enabling bit in the
611      * MSI-X capability, but leaves the vector table masked.  We therefore
612      * can't rely on a vector_use callback (from request_irq() in the guest)
613      * to switch the physical device into MSI-X mode because that may come a
614      * long time after pci_enable_msix().  This code enables vector 0 with
615      * triggering to userspace, then immediately release the vector, leaving
616      * the physical device with no vectors enabled, but MSI-X enabled, just
617      * like the guest view.
618      */
619     vfio_msix_vector_do_use(&vdev->pdev, 0, NULL, NULL);
620     vfio_msix_vector_release(&vdev->pdev, 0);
621 
622     if (msix_set_vector_notifiers(&vdev->pdev, vfio_msix_vector_use,
623                                   vfio_msix_vector_release, NULL)) {
624         error_report("vfio: msix_set_vector_notifiers failed");
625     }
626 
627     trace_vfio_msix_enable(vdev->vbasedev.name);
628 }
629 
630 static void vfio_msi_enable(VFIOPCIDevice *vdev)
631 {
632     int ret, i;
633 
634     vfio_disable_interrupts(vdev);
635 
636     vdev->nr_vectors = msi_nr_vectors_allocated(&vdev->pdev);
637 retry:
638     vdev->msi_vectors = g_new0(VFIOMSIVector, vdev->nr_vectors);
639 
640     for (i = 0; i < vdev->nr_vectors; i++) {
641         VFIOMSIVector *vector = &vdev->msi_vectors[i];
642         MSIMessage msg = msi_get_message(&vdev->pdev, i);
643 
644         vector->vdev = vdev;
645         vector->virq = -1;
646         vector->use = true;
647 
648         if (event_notifier_init(&vector->interrupt, 0)) {
649             error_report("vfio: Error: event_notifier_init failed");
650         }
651 
652         qemu_set_fd_handler(event_notifier_get_fd(&vector->interrupt),
653                             vfio_msi_interrupt, NULL, vector);
654 
655         /*
656          * Attempt to enable route through KVM irqchip,
657          * default to userspace handling if unavailable.
658          */
659         vfio_add_kvm_msi_virq(vdev, vector, &msg, false);
660     }
661 
662     /* Set interrupt type prior to possible interrupts */
663     vdev->interrupt = VFIO_INT_MSI;
664 
665     ret = vfio_enable_vectors(vdev, false);
666     if (ret) {
667         if (ret < 0) {
668             error_report("vfio: Error: Failed to setup MSI fds: %m");
669         } else if (ret != vdev->nr_vectors) {
670             error_report("vfio: Error: Failed to enable %d "
671                          "MSI vectors, retry with %d", vdev->nr_vectors, ret);
672         }
673 
674         for (i = 0; i < vdev->nr_vectors; i++) {
675             VFIOMSIVector *vector = &vdev->msi_vectors[i];
676             if (vector->virq >= 0) {
677                 vfio_remove_kvm_msi_virq(vector);
678             }
679             qemu_set_fd_handler(event_notifier_get_fd(&vector->interrupt),
680                                 NULL, NULL, NULL);
681             event_notifier_cleanup(&vector->interrupt);
682         }
683 
684         g_free(vdev->msi_vectors);
685 
686         if (ret > 0 && ret != vdev->nr_vectors) {
687             vdev->nr_vectors = ret;
688             goto retry;
689         }
690         vdev->nr_vectors = 0;
691 
692         /*
693          * Failing to setup MSI doesn't really fall within any specification.
694          * Let's try leaving interrupts disabled and hope the guest figures
695          * out to fall back to INTx for this device.
696          */
697         error_report("vfio: Error: Failed to enable MSI");
698         vdev->interrupt = VFIO_INT_NONE;
699 
700         return;
701     }
702 
703     trace_vfio_msi_enable(vdev->vbasedev.name, vdev->nr_vectors);
704 }
705 
706 static void vfio_msi_disable_common(VFIOPCIDevice *vdev)
707 {
708     int i;
709 
710     for (i = 0; i < vdev->nr_vectors; i++) {
711         VFIOMSIVector *vector = &vdev->msi_vectors[i];
712         if (vdev->msi_vectors[i].use) {
713             if (vector->virq >= 0) {
714                 vfio_remove_kvm_msi_virq(vector);
715             }
716             qemu_set_fd_handler(event_notifier_get_fd(&vector->interrupt),
717                                 NULL, NULL, NULL);
718             event_notifier_cleanup(&vector->interrupt);
719         }
720     }
721 
722     g_free(vdev->msi_vectors);
723     vdev->msi_vectors = NULL;
724     vdev->nr_vectors = 0;
725     vdev->interrupt = VFIO_INT_NONE;
726 
727     vfio_intx_enable(vdev);
728 }
729 
730 static void vfio_msix_disable(VFIOPCIDevice *vdev)
731 {
732     int i;
733 
734     msix_unset_vector_notifiers(&vdev->pdev);
735 
736     /*
737      * MSI-X will only release vectors if MSI-X is still enabled on the
738      * device, check through the rest and release it ourselves if necessary.
739      */
740     for (i = 0; i < vdev->nr_vectors; i++) {
741         if (vdev->msi_vectors[i].use) {
742             vfio_msix_vector_release(&vdev->pdev, i);
743             msix_vector_unuse(&vdev->pdev, i);
744         }
745     }
746 
747     if (vdev->nr_vectors) {
748         vfio_disable_irqindex(&vdev->vbasedev, VFIO_PCI_MSIX_IRQ_INDEX);
749     }
750 
751     vfio_msi_disable_common(vdev);
752 
753     memset(vdev->msix->pending, 0,
754            BITS_TO_LONGS(vdev->msix->entries) * sizeof(unsigned long));
755 
756     trace_vfio_msix_disable(vdev->vbasedev.name);
757 }
758 
759 static void vfio_msi_disable(VFIOPCIDevice *vdev)
760 {
761     vfio_disable_irqindex(&vdev->vbasedev, VFIO_PCI_MSI_IRQ_INDEX);
762     vfio_msi_disable_common(vdev);
763 
764     trace_vfio_msi_disable(vdev->vbasedev.name);
765 }
766 
767 static void vfio_update_msi(VFIOPCIDevice *vdev)
768 {
769     int i;
770 
771     for (i = 0; i < vdev->nr_vectors; i++) {
772         VFIOMSIVector *vector = &vdev->msi_vectors[i];
773         MSIMessage msg;
774 
775         if (!vector->use || vector->virq < 0) {
776             continue;
777         }
778 
779         msg = msi_get_message(&vdev->pdev, i);
780         vfio_update_kvm_msi_virq(vector, msg, &vdev->pdev);
781     }
782 }
783 
784 static void vfio_pci_load_rom(VFIOPCIDevice *vdev)
785 {
786     struct vfio_region_info *reg_info;
787     uint64_t size;
788     off_t off = 0;
789     ssize_t bytes;
790 
791     if (vfio_get_region_info(&vdev->vbasedev,
792                              VFIO_PCI_ROM_REGION_INDEX, &reg_info)) {
793         error_report("vfio: Error getting ROM info: %m");
794         return;
795     }
796 
797     trace_vfio_pci_load_rom(vdev->vbasedev.name, (unsigned long)reg_info->size,
798                             (unsigned long)reg_info->offset,
799                             (unsigned long)reg_info->flags);
800 
801     vdev->rom_size = size = reg_info->size;
802     vdev->rom_offset = reg_info->offset;
803 
804     g_free(reg_info);
805 
806     if (!vdev->rom_size) {
807         vdev->rom_read_failed = true;
808         error_report("vfio-pci: Cannot read device rom at "
809                     "%s", vdev->vbasedev.name);
810         error_printf("Device option ROM contents are probably invalid "
811                     "(check dmesg).\nSkip option ROM probe with rombar=0, "
812                     "or load from file with romfile=\n");
813         return;
814     }
815 
816     vdev->rom = g_malloc(size);
817     memset(vdev->rom, 0xff, size);
818 
819     while (size) {
820         bytes = pread(vdev->vbasedev.fd, vdev->rom + off,
821                       size, vdev->rom_offset + off);
822         if (bytes == 0) {
823             break;
824         } else if (bytes > 0) {
825             off += bytes;
826             size -= bytes;
827         } else {
828             if (errno == EINTR || errno == EAGAIN) {
829                 continue;
830             }
831             error_report("vfio: Error reading device ROM: %m");
832             break;
833         }
834     }
835 
836     /*
837      * Test the ROM signature against our device, if the vendor is correct
838      * but the device ID doesn't match, store the correct device ID and
839      * recompute the checksum.  Intel IGD devices need this and are known
840      * to have bogus checksums so we can't simply adjust the checksum.
841      */
842     if (pci_get_word(vdev->rom) == 0xaa55 &&
843         pci_get_word(vdev->rom + 0x18) + 8 < vdev->rom_size &&
844         !memcmp(vdev->rom + pci_get_word(vdev->rom + 0x18), "PCIR", 4)) {
845         uint16_t vid, did;
846 
847         vid = pci_get_word(vdev->rom + pci_get_word(vdev->rom + 0x18) + 4);
848         did = pci_get_word(vdev->rom + pci_get_word(vdev->rom + 0x18) + 6);
849 
850         if (vid == vdev->vendor_id && did != vdev->device_id) {
851             int i;
852             uint8_t csum, *data = vdev->rom;
853 
854             pci_set_word(vdev->rom + pci_get_word(vdev->rom + 0x18) + 6,
855                          vdev->device_id);
856             data[6] = 0;
857 
858             for (csum = 0, i = 0; i < vdev->rom_size; i++) {
859                 csum += data[i];
860             }
861 
862             data[6] = -csum;
863         }
864     }
865 }
866 
867 static uint64_t vfio_rom_read(void *opaque, hwaddr addr, unsigned size)
868 {
869     VFIOPCIDevice *vdev = opaque;
870     union {
871         uint8_t byte;
872         uint16_t word;
873         uint32_t dword;
874         uint64_t qword;
875     } val;
876     uint64_t data = 0;
877 
878     /* Load the ROM lazily when the guest tries to read it */
879     if (unlikely(!vdev->rom && !vdev->rom_read_failed)) {
880         vfio_pci_load_rom(vdev);
881     }
882 
883     memcpy(&val, vdev->rom + addr,
884            (addr < vdev->rom_size) ? MIN(size, vdev->rom_size - addr) : 0);
885 
886     switch (size) {
887     case 1:
888         data = val.byte;
889         break;
890     case 2:
891         data = le16_to_cpu(val.word);
892         break;
893     case 4:
894         data = le32_to_cpu(val.dword);
895         break;
896     default:
897         hw_error("vfio: unsupported read size, %d bytes\n", size);
898         break;
899     }
900 
901     trace_vfio_rom_read(vdev->vbasedev.name, addr, size, data);
902 
903     return data;
904 }
905 
906 static void vfio_rom_write(void *opaque, hwaddr addr,
907                            uint64_t data, unsigned size)
908 {
909 }
910 
911 static const MemoryRegionOps vfio_rom_ops = {
912     .read = vfio_rom_read,
913     .write = vfio_rom_write,
914     .endianness = DEVICE_LITTLE_ENDIAN,
915 };
916 
917 static void vfio_pci_size_rom(VFIOPCIDevice *vdev)
918 {
919     uint32_t orig, size = cpu_to_le32((uint32_t)PCI_ROM_ADDRESS_MASK);
920     off_t offset = vdev->config_offset + PCI_ROM_ADDRESS;
921     DeviceState *dev = DEVICE(vdev);
922     char *name;
923     int fd = vdev->vbasedev.fd;
924 
925     if (vdev->pdev.romfile || !vdev->pdev.rom_bar) {
926         /* Since pci handles romfile, just print a message and return */
927         if (vfio_blacklist_opt_rom(vdev) && vdev->pdev.romfile) {
928             error_printf("Warning : Device at %s is known to cause system instability issues during option rom execution. Proceeding anyway since user specified romfile\n",
929                          vdev->vbasedev.name);
930         }
931         return;
932     }
933 
934     /*
935      * Use the same size ROM BAR as the physical device.  The contents
936      * will get filled in later when the guest tries to read it.
937      */
938     if (pread(fd, &orig, 4, offset) != 4 ||
939         pwrite(fd, &size, 4, offset) != 4 ||
940         pread(fd, &size, 4, offset) != 4 ||
941         pwrite(fd, &orig, 4, offset) != 4) {
942         error_report("%s(%s) failed: %m", __func__, vdev->vbasedev.name);
943         return;
944     }
945 
946     size = ~(le32_to_cpu(size) & PCI_ROM_ADDRESS_MASK) + 1;
947 
948     if (!size) {
949         return;
950     }
951 
952     if (vfio_blacklist_opt_rom(vdev)) {
953         if (dev->opts && qemu_opt_get(dev->opts, "rombar")) {
954             error_printf("Warning : Device at %s is known to cause system instability issues during option rom execution. Proceeding anyway since user specified non zero value for rombar\n",
955                          vdev->vbasedev.name);
956         } else {
957             error_printf("Warning : Rom loading for device at %s has been disabled due to system instability issues. Specify rombar=1 or romfile to force\n",
958                          vdev->vbasedev.name);
959             return;
960         }
961     }
962 
963     trace_vfio_pci_size_rom(vdev->vbasedev.name, size);
964 
965     name = g_strdup_printf("vfio[%s].rom", vdev->vbasedev.name);
966 
967     memory_region_init_io(&vdev->pdev.rom, OBJECT(vdev),
968                           &vfio_rom_ops, vdev, name, size);
969     g_free(name);
970 
971     pci_register_bar(&vdev->pdev, PCI_ROM_SLOT,
972                      PCI_BASE_ADDRESS_SPACE_MEMORY, &vdev->pdev.rom);
973 
974     vdev->pdev.has_rom = true;
975     vdev->rom_read_failed = false;
976 }
977 
978 void vfio_vga_write(void *opaque, hwaddr addr,
979                            uint64_t data, unsigned size)
980 {
981     VFIOVGARegion *region = opaque;
982     VFIOVGA *vga = container_of(region, VFIOVGA, region[region->nr]);
983     union {
984         uint8_t byte;
985         uint16_t word;
986         uint32_t dword;
987         uint64_t qword;
988     } buf;
989     off_t offset = vga->fd_offset + region->offset + addr;
990 
991     switch (size) {
992     case 1:
993         buf.byte = data;
994         break;
995     case 2:
996         buf.word = cpu_to_le16(data);
997         break;
998     case 4:
999         buf.dword = cpu_to_le32(data);
1000         break;
1001     default:
1002         hw_error("vfio: unsupported write size, %d bytes", size);
1003         break;
1004     }
1005 
1006     if (pwrite(vga->fd, &buf, size, offset) != size) {
1007         error_report("%s(,0x%"HWADDR_PRIx", 0x%"PRIx64", %d) failed: %m",
1008                      __func__, region->offset + addr, data, size);
1009     }
1010 
1011     trace_vfio_vga_write(region->offset + addr, data, size);
1012 }
1013 
1014 uint64_t vfio_vga_read(void *opaque, hwaddr addr, unsigned size)
1015 {
1016     VFIOVGARegion *region = opaque;
1017     VFIOVGA *vga = container_of(region, VFIOVGA, region[region->nr]);
1018     union {
1019         uint8_t byte;
1020         uint16_t word;
1021         uint32_t dword;
1022         uint64_t qword;
1023     } buf;
1024     uint64_t data = 0;
1025     off_t offset = vga->fd_offset + region->offset + addr;
1026 
1027     if (pread(vga->fd, &buf, size, offset) != size) {
1028         error_report("%s(,0x%"HWADDR_PRIx", %d) failed: %m",
1029                      __func__, region->offset + addr, size);
1030         return (uint64_t)-1;
1031     }
1032 
1033     switch (size) {
1034     case 1:
1035         data = buf.byte;
1036         break;
1037     case 2:
1038         data = le16_to_cpu(buf.word);
1039         break;
1040     case 4:
1041         data = le32_to_cpu(buf.dword);
1042         break;
1043     default:
1044         hw_error("vfio: unsupported read size, %d bytes", size);
1045         break;
1046     }
1047 
1048     trace_vfio_vga_read(region->offset + addr, size, data);
1049 
1050     return data;
1051 }
1052 
1053 static const MemoryRegionOps vfio_vga_ops = {
1054     .read = vfio_vga_read,
1055     .write = vfio_vga_write,
1056     .endianness = DEVICE_LITTLE_ENDIAN,
1057 };
1058 
1059 /*
1060  * PCI config space
1061  */
1062 uint32_t vfio_pci_read_config(PCIDevice *pdev, uint32_t addr, int len)
1063 {
1064     VFIOPCIDevice *vdev = DO_UPCAST(VFIOPCIDevice, pdev, pdev);
1065     uint32_t emu_bits = 0, emu_val = 0, phys_val = 0, val;
1066 
1067     memcpy(&emu_bits, vdev->emulated_config_bits + addr, len);
1068     emu_bits = le32_to_cpu(emu_bits);
1069 
1070     if (emu_bits) {
1071         emu_val = pci_default_read_config(pdev, addr, len);
1072     }
1073 
1074     if (~emu_bits & (0xffffffffU >> (32 - len * 8))) {
1075         ssize_t ret;
1076 
1077         ret = pread(vdev->vbasedev.fd, &phys_val, len,
1078                     vdev->config_offset + addr);
1079         if (ret != len) {
1080             error_report("%s(%s, 0x%x, 0x%x) failed: %m",
1081                          __func__, vdev->vbasedev.name, addr, len);
1082             return -errno;
1083         }
1084         phys_val = le32_to_cpu(phys_val);
1085     }
1086 
1087     val = (emu_val & emu_bits) | (phys_val & ~emu_bits);
1088 
1089     trace_vfio_pci_read_config(vdev->vbasedev.name, addr, len, val);
1090 
1091     return val;
1092 }
1093 
1094 void vfio_pci_write_config(PCIDevice *pdev,
1095                            uint32_t addr, uint32_t val, int len)
1096 {
1097     VFIOPCIDevice *vdev = DO_UPCAST(VFIOPCIDevice, pdev, pdev);
1098     uint32_t val_le = cpu_to_le32(val);
1099 
1100     trace_vfio_pci_write_config(vdev->vbasedev.name, addr, val, len);
1101 
1102     /* Write everything to VFIO, let it filter out what we can't write */
1103     if (pwrite(vdev->vbasedev.fd, &val_le, len, vdev->config_offset + addr)
1104                 != len) {
1105         error_report("%s(%s, 0x%x, 0x%x, 0x%x) failed: %m",
1106                      __func__, vdev->vbasedev.name, addr, val, len);
1107     }
1108 
1109     /* MSI/MSI-X Enabling/Disabling */
1110     if (pdev->cap_present & QEMU_PCI_CAP_MSI &&
1111         ranges_overlap(addr, len, pdev->msi_cap, vdev->msi_cap_size)) {
1112         int is_enabled, was_enabled = msi_enabled(pdev);
1113 
1114         pci_default_write_config(pdev, addr, val, len);
1115 
1116         is_enabled = msi_enabled(pdev);
1117 
1118         if (!was_enabled) {
1119             if (is_enabled) {
1120                 vfio_msi_enable(vdev);
1121             }
1122         } else {
1123             if (!is_enabled) {
1124                 vfio_msi_disable(vdev);
1125             } else {
1126                 vfio_update_msi(vdev);
1127             }
1128         }
1129     } else if (pdev->cap_present & QEMU_PCI_CAP_MSIX &&
1130         ranges_overlap(addr, len, pdev->msix_cap, MSIX_CAP_LENGTH)) {
1131         int is_enabled, was_enabled = msix_enabled(pdev);
1132 
1133         pci_default_write_config(pdev, addr, val, len);
1134 
1135         is_enabled = msix_enabled(pdev);
1136 
1137         if (!was_enabled && is_enabled) {
1138             vfio_msix_enable(vdev);
1139         } else if (was_enabled && !is_enabled) {
1140             vfio_msix_disable(vdev);
1141         }
1142     } else {
1143         /* Write everything to QEMU to keep emulated bits correct */
1144         pci_default_write_config(pdev, addr, val, len);
1145     }
1146 }
1147 
1148 /*
1149  * Interrupt setup
1150  */
1151 static void vfio_disable_interrupts(VFIOPCIDevice *vdev)
1152 {
1153     /*
1154      * More complicated than it looks.  Disabling MSI/X transitions the
1155      * device to INTx mode (if supported).  Therefore we need to first
1156      * disable MSI/X and then cleanup by disabling INTx.
1157      */
1158     if (vdev->interrupt == VFIO_INT_MSIX) {
1159         vfio_msix_disable(vdev);
1160     } else if (vdev->interrupt == VFIO_INT_MSI) {
1161         vfio_msi_disable(vdev);
1162     }
1163 
1164     if (vdev->interrupt == VFIO_INT_INTx) {
1165         vfio_intx_disable(vdev);
1166     }
1167 }
1168 
1169 static int vfio_msi_setup(VFIOPCIDevice *vdev, int pos)
1170 {
1171     uint16_t ctrl;
1172     bool msi_64bit, msi_maskbit;
1173     int ret, entries;
1174 
1175     if (pread(vdev->vbasedev.fd, &ctrl, sizeof(ctrl),
1176               vdev->config_offset + pos + PCI_CAP_FLAGS) != sizeof(ctrl)) {
1177         return -errno;
1178     }
1179     ctrl = le16_to_cpu(ctrl);
1180 
1181     msi_64bit = !!(ctrl & PCI_MSI_FLAGS_64BIT);
1182     msi_maskbit = !!(ctrl & PCI_MSI_FLAGS_MASKBIT);
1183     entries = 1 << ((ctrl & PCI_MSI_FLAGS_QMASK) >> 1);
1184 
1185     trace_vfio_msi_setup(vdev->vbasedev.name, pos);
1186 
1187     ret = msi_init(&vdev->pdev, pos, entries, msi_64bit, msi_maskbit);
1188     if (ret < 0) {
1189         if (ret == -ENOTSUP) {
1190             return 0;
1191         }
1192         error_report("vfio: msi_init failed");
1193         return ret;
1194     }
1195     vdev->msi_cap_size = 0xa + (msi_maskbit ? 0xa : 0) + (msi_64bit ? 0x4 : 0);
1196 
1197     return 0;
1198 }
1199 
1200 static void vfio_pci_fixup_msix_region(VFIOPCIDevice *vdev)
1201 {
1202     off_t start, end;
1203     VFIORegion *region = &vdev->bars[vdev->msix->table_bar].region;
1204 
1205     /*
1206      * We expect to find a single mmap covering the whole BAR, anything else
1207      * means it's either unsupported or already setup.
1208      */
1209     if (region->nr_mmaps != 1 || region->mmaps[0].offset ||
1210         region->size != region->mmaps[0].size) {
1211         return;
1212     }
1213 
1214     /* MSI-X table start and end aligned to host page size */
1215     start = vdev->msix->table_offset & qemu_real_host_page_mask;
1216     end = REAL_HOST_PAGE_ALIGN((uint64_t)vdev->msix->table_offset +
1217                                (vdev->msix->entries * PCI_MSIX_ENTRY_SIZE));
1218 
1219     /*
1220      * Does the MSI-X table cover the beginning of the BAR?  The whole BAR?
1221      * NB - Host page size is necessarily a power of two and so is the PCI
1222      * BAR (not counting EA yet), therefore if we have host page aligned
1223      * @start and @end, then any remainder of the BAR before or after those
1224      * must be at least host page sized and therefore mmap'able.
1225      */
1226     if (!start) {
1227         if (end >= region->size) {
1228             region->nr_mmaps = 0;
1229             g_free(region->mmaps);
1230             region->mmaps = NULL;
1231             trace_vfio_msix_fixup(vdev->vbasedev.name,
1232                                   vdev->msix->table_bar, 0, 0);
1233         } else {
1234             region->mmaps[0].offset = end;
1235             region->mmaps[0].size = region->size - end;
1236             trace_vfio_msix_fixup(vdev->vbasedev.name,
1237                               vdev->msix->table_bar, region->mmaps[0].offset,
1238                               region->mmaps[0].offset + region->mmaps[0].size);
1239         }
1240 
1241     /* Maybe it's aligned at the end of the BAR */
1242     } else if (end >= region->size) {
1243         region->mmaps[0].size = start;
1244         trace_vfio_msix_fixup(vdev->vbasedev.name,
1245                               vdev->msix->table_bar, region->mmaps[0].offset,
1246                               region->mmaps[0].offset + region->mmaps[0].size);
1247 
1248     /* Otherwise it must split the BAR */
1249     } else {
1250         region->nr_mmaps = 2;
1251         region->mmaps = g_renew(VFIOMmap, region->mmaps, 2);
1252 
1253         memcpy(&region->mmaps[1], &region->mmaps[0], sizeof(VFIOMmap));
1254 
1255         region->mmaps[0].size = start;
1256         trace_vfio_msix_fixup(vdev->vbasedev.name,
1257                               vdev->msix->table_bar, region->mmaps[0].offset,
1258                               region->mmaps[0].offset + region->mmaps[0].size);
1259 
1260         region->mmaps[1].offset = end;
1261         region->mmaps[1].size = region->size - end;
1262         trace_vfio_msix_fixup(vdev->vbasedev.name,
1263                               vdev->msix->table_bar, region->mmaps[1].offset,
1264                               region->mmaps[1].offset + region->mmaps[1].size);
1265     }
1266 }
1267 
1268 /*
1269  * We don't have any control over how pci_add_capability() inserts
1270  * capabilities into the chain.  In order to setup MSI-X we need a
1271  * MemoryRegion for the BAR.  In order to setup the BAR and not
1272  * attempt to mmap the MSI-X table area, which VFIO won't allow, we
1273  * need to first look for where the MSI-X table lives.  So we
1274  * unfortunately split MSI-X setup across two functions.
1275  */
1276 static int vfio_msix_early_setup(VFIOPCIDevice *vdev)
1277 {
1278     uint8_t pos;
1279     uint16_t ctrl;
1280     uint32_t table, pba;
1281     int fd = vdev->vbasedev.fd;
1282     VFIOMSIXInfo *msix;
1283 
1284     pos = pci_find_capability(&vdev->pdev, PCI_CAP_ID_MSIX);
1285     if (!pos) {
1286         return 0;
1287     }
1288 
1289     if (pread(fd, &ctrl, sizeof(ctrl),
1290               vdev->config_offset + pos + PCI_MSIX_FLAGS) != sizeof(ctrl)) {
1291         return -errno;
1292     }
1293 
1294     if (pread(fd, &table, sizeof(table),
1295               vdev->config_offset + pos + PCI_MSIX_TABLE) != sizeof(table)) {
1296         return -errno;
1297     }
1298 
1299     if (pread(fd, &pba, sizeof(pba),
1300               vdev->config_offset + pos + PCI_MSIX_PBA) != sizeof(pba)) {
1301         return -errno;
1302     }
1303 
1304     ctrl = le16_to_cpu(ctrl);
1305     table = le32_to_cpu(table);
1306     pba = le32_to_cpu(pba);
1307 
1308     msix = g_malloc0(sizeof(*msix));
1309     msix->table_bar = table & PCI_MSIX_FLAGS_BIRMASK;
1310     msix->table_offset = table & ~PCI_MSIX_FLAGS_BIRMASK;
1311     msix->pba_bar = pba & PCI_MSIX_FLAGS_BIRMASK;
1312     msix->pba_offset = pba & ~PCI_MSIX_FLAGS_BIRMASK;
1313     msix->entries = (ctrl & PCI_MSIX_FLAGS_QSIZE) + 1;
1314 
1315     /*
1316      * Test the size of the pba_offset variable and catch if it extends outside
1317      * of the specified BAR. If it is the case, we need to apply a hardware
1318      * specific quirk if the device is known or we have a broken configuration.
1319      */
1320     if (msix->pba_offset >= vdev->bars[msix->pba_bar].region.size) {
1321         /*
1322          * Chelsio T5 Virtual Function devices are encoded as 0x58xx for T5
1323          * adapters. The T5 hardware returns an incorrect value of 0x8000 for
1324          * the VF PBA offset while the BAR itself is only 8k. The correct value
1325          * is 0x1000, so we hard code that here.
1326          */
1327         if (vdev->vendor_id == PCI_VENDOR_ID_CHELSIO &&
1328             (vdev->device_id & 0xff00) == 0x5800) {
1329             msix->pba_offset = 0x1000;
1330         } else {
1331             error_report("vfio: Hardware reports invalid configuration, "
1332                          "MSIX PBA outside of specified BAR");
1333             g_free(msix);
1334             return -EINVAL;
1335         }
1336     }
1337 
1338     trace_vfio_msix_early_setup(vdev->vbasedev.name, pos, msix->table_bar,
1339                                 msix->table_offset, msix->entries);
1340     vdev->msix = msix;
1341 
1342     vfio_pci_fixup_msix_region(vdev);
1343 
1344     return 0;
1345 }
1346 
1347 static int vfio_msix_setup(VFIOPCIDevice *vdev, int pos)
1348 {
1349     int ret;
1350 
1351     vdev->msix->pending = g_malloc0(BITS_TO_LONGS(vdev->msix->entries) *
1352                                     sizeof(unsigned long));
1353     ret = msix_init(&vdev->pdev, vdev->msix->entries,
1354                     vdev->bars[vdev->msix->table_bar].region.mem,
1355                     vdev->msix->table_bar, vdev->msix->table_offset,
1356                     vdev->bars[vdev->msix->pba_bar].region.mem,
1357                     vdev->msix->pba_bar, vdev->msix->pba_offset, pos);
1358     if (ret < 0) {
1359         if (ret == -ENOTSUP) {
1360             return 0;
1361         }
1362         error_report("vfio: msix_init failed");
1363         return ret;
1364     }
1365 
1366     /*
1367      * The PCI spec suggests that devices provide additional alignment for
1368      * MSI-X structures and avoid overlapping non-MSI-X related registers.
1369      * For an assigned device, this hopefully means that emulation of MSI-X
1370      * structures does not affect the performance of the device.  If devices
1371      * fail to provide that alignment, a significant performance penalty may
1372      * result, for instance Mellanox MT27500 VFs:
1373      * http://www.spinics.net/lists/kvm/msg125881.html
1374      *
1375      * The PBA is simply not that important for such a serious regression and
1376      * most drivers do not appear to look at it.  The solution for this is to
1377      * disable the PBA MemoryRegion unless it's being used.  We disable it
1378      * here and only enable it if a masked vector fires through QEMU.  As the
1379      * vector-use notifier is called, which occurs on unmask, we test whether
1380      * PBA emulation is needed and again disable if not.
1381      */
1382     memory_region_set_enabled(&vdev->pdev.msix_pba_mmio, false);
1383 
1384     return 0;
1385 }
1386 
1387 static void vfio_teardown_msi(VFIOPCIDevice *vdev)
1388 {
1389     msi_uninit(&vdev->pdev);
1390 
1391     if (vdev->msix) {
1392         msix_uninit(&vdev->pdev,
1393                     vdev->bars[vdev->msix->table_bar].region.mem,
1394                     vdev->bars[vdev->msix->pba_bar].region.mem);
1395         g_free(vdev->msix->pending);
1396     }
1397 }
1398 
1399 /*
1400  * Resource setup
1401  */
1402 static void vfio_mmap_set_enabled(VFIOPCIDevice *vdev, bool enabled)
1403 {
1404     int i;
1405 
1406     for (i = 0; i < PCI_ROM_SLOT; i++) {
1407         vfio_region_mmaps_set_enabled(&vdev->bars[i].region, enabled);
1408     }
1409 }
1410 
1411 static void vfio_bar_setup(VFIOPCIDevice *vdev, int nr)
1412 {
1413     VFIOBAR *bar = &vdev->bars[nr];
1414 
1415     uint32_t pci_bar;
1416     uint8_t type;
1417     int ret;
1418 
1419     /* Skip both unimplemented BARs and the upper half of 64bit BARS. */
1420     if (!bar->region.size) {
1421         return;
1422     }
1423 
1424     /* Determine what type of BAR this is for registration */
1425     ret = pread(vdev->vbasedev.fd, &pci_bar, sizeof(pci_bar),
1426                 vdev->config_offset + PCI_BASE_ADDRESS_0 + (4 * nr));
1427     if (ret != sizeof(pci_bar)) {
1428         error_report("vfio: Failed to read BAR %d (%m)", nr);
1429         return;
1430     }
1431 
1432     pci_bar = le32_to_cpu(pci_bar);
1433     bar->ioport = (pci_bar & PCI_BASE_ADDRESS_SPACE_IO);
1434     bar->mem64 = bar->ioport ? 0 : (pci_bar & PCI_BASE_ADDRESS_MEM_TYPE_64);
1435     type = pci_bar & (bar->ioport ? ~PCI_BASE_ADDRESS_IO_MASK :
1436                                     ~PCI_BASE_ADDRESS_MEM_MASK);
1437 
1438     if (vfio_region_mmap(&bar->region)) {
1439         error_report("Failed to mmap %s BAR %d. Performance may be slow",
1440                      vdev->vbasedev.name, nr);
1441     }
1442 
1443     pci_register_bar(&vdev->pdev, nr, type, bar->region.mem);
1444 }
1445 
1446 static void vfio_bars_setup(VFIOPCIDevice *vdev)
1447 {
1448     int i;
1449 
1450     for (i = 0; i < PCI_ROM_SLOT; i++) {
1451         vfio_bar_setup(vdev, i);
1452     }
1453 }
1454 
1455 static void vfio_bars_exit(VFIOPCIDevice *vdev)
1456 {
1457     int i;
1458 
1459     for (i = 0; i < PCI_ROM_SLOT; i++) {
1460         vfio_bar_quirk_exit(vdev, i);
1461         vfio_region_exit(&vdev->bars[i].region);
1462     }
1463 
1464     if (vdev->vga) {
1465         pci_unregister_vga(&vdev->pdev);
1466         vfio_vga_quirk_exit(vdev);
1467     }
1468 }
1469 
1470 static void vfio_bars_finalize(VFIOPCIDevice *vdev)
1471 {
1472     int i;
1473 
1474     for (i = 0; i < PCI_ROM_SLOT; i++) {
1475         vfio_bar_quirk_finalize(vdev, i);
1476         vfio_region_finalize(&vdev->bars[i].region);
1477     }
1478 
1479     if (vdev->vga) {
1480         vfio_vga_quirk_finalize(vdev);
1481         for (i = 0; i < ARRAY_SIZE(vdev->vga->region); i++) {
1482             object_unparent(OBJECT(&vdev->vga->region[i].mem));
1483         }
1484         g_free(vdev->vga);
1485     }
1486 }
1487 
1488 /*
1489  * General setup
1490  */
1491 static uint8_t vfio_std_cap_max_size(PCIDevice *pdev, uint8_t pos)
1492 {
1493     uint8_t tmp;
1494     uint16_t next = PCI_CONFIG_SPACE_SIZE;
1495 
1496     for (tmp = pdev->config[PCI_CAPABILITY_LIST]; tmp;
1497          tmp = pdev->config[tmp + PCI_CAP_LIST_NEXT]) {
1498         if (tmp > pos && tmp < next) {
1499             next = tmp;
1500         }
1501     }
1502 
1503     return next - pos;
1504 }
1505 
1506 static void vfio_set_word_bits(uint8_t *buf, uint16_t val, uint16_t mask)
1507 {
1508     pci_set_word(buf, (pci_get_word(buf) & ~mask) | val);
1509 }
1510 
1511 static void vfio_add_emulated_word(VFIOPCIDevice *vdev, int pos,
1512                                    uint16_t val, uint16_t mask)
1513 {
1514     vfio_set_word_bits(vdev->pdev.config + pos, val, mask);
1515     vfio_set_word_bits(vdev->pdev.wmask + pos, ~mask, mask);
1516     vfio_set_word_bits(vdev->emulated_config_bits + pos, mask, mask);
1517 }
1518 
1519 static void vfio_set_long_bits(uint8_t *buf, uint32_t val, uint32_t mask)
1520 {
1521     pci_set_long(buf, (pci_get_long(buf) & ~mask) | val);
1522 }
1523 
1524 static void vfio_add_emulated_long(VFIOPCIDevice *vdev, int pos,
1525                                    uint32_t val, uint32_t mask)
1526 {
1527     vfio_set_long_bits(vdev->pdev.config + pos, val, mask);
1528     vfio_set_long_bits(vdev->pdev.wmask + pos, ~mask, mask);
1529     vfio_set_long_bits(vdev->emulated_config_bits + pos, mask, mask);
1530 }
1531 
1532 static int vfio_setup_pcie_cap(VFIOPCIDevice *vdev, int pos, uint8_t size)
1533 {
1534     uint16_t flags;
1535     uint8_t type;
1536 
1537     flags = pci_get_word(vdev->pdev.config + pos + PCI_CAP_FLAGS);
1538     type = (flags & PCI_EXP_FLAGS_TYPE) >> 4;
1539 
1540     if (type != PCI_EXP_TYPE_ENDPOINT &&
1541         type != PCI_EXP_TYPE_LEG_END &&
1542         type != PCI_EXP_TYPE_RC_END) {
1543 
1544         error_report("vfio: Assignment of PCIe type 0x%x "
1545                      "devices is not currently supported", type);
1546         return -EINVAL;
1547     }
1548 
1549     if (!pci_bus_is_express(vdev->pdev.bus)) {
1550         PCIBus *bus = vdev->pdev.bus;
1551         PCIDevice *bridge;
1552 
1553         /*
1554          * Traditionally PCI device assignment exposes the PCIe capability
1555          * as-is on non-express buses.  The reason being that some drivers
1556          * simply assume that it's there, for example tg3.  However when
1557          * we're running on a native PCIe machine type, like Q35, we need
1558          * to hide the PCIe capability.  The reason for this is twofold;
1559          * first Windows guests get a Code 10 error when the PCIe capability
1560          * is exposed in this configuration.  Therefore express devices won't
1561          * work at all unless they're attached to express buses in the VM.
1562          * Second, a native PCIe machine introduces the possibility of fine
1563          * granularity IOMMUs supporting both translation and isolation.
1564          * Guest code to discover the IOMMU visibility of a device, such as
1565          * IOMMU grouping code on Linux, is very aware of device types and
1566          * valid transitions between bus types.  An express device on a non-
1567          * express bus is not a valid combination on bare metal systems.
1568          *
1569          * Drivers that require a PCIe capability to make the device
1570          * functional are simply going to need to have their devices placed
1571          * on a PCIe bus in the VM.
1572          */
1573         while (!pci_bus_is_root(bus)) {
1574             bridge = pci_bridge_get_device(bus);
1575             bus = bridge->bus;
1576         }
1577 
1578         if (pci_bus_is_express(bus)) {
1579             return 0;
1580         }
1581 
1582     } else if (pci_bus_is_root(vdev->pdev.bus)) {
1583         /*
1584          * On a Root Complex bus Endpoints become Root Complex Integrated
1585          * Endpoints, which changes the type and clears the LNK & LNK2 fields.
1586          */
1587         if (type == PCI_EXP_TYPE_ENDPOINT) {
1588             vfio_add_emulated_word(vdev, pos + PCI_CAP_FLAGS,
1589                                    PCI_EXP_TYPE_RC_END << 4,
1590                                    PCI_EXP_FLAGS_TYPE);
1591 
1592             /* Link Capabilities, Status, and Control goes away */
1593             if (size > PCI_EXP_LNKCTL) {
1594                 vfio_add_emulated_long(vdev, pos + PCI_EXP_LNKCAP, 0, ~0);
1595                 vfio_add_emulated_word(vdev, pos + PCI_EXP_LNKCTL, 0, ~0);
1596                 vfio_add_emulated_word(vdev, pos + PCI_EXP_LNKSTA, 0, ~0);
1597 
1598 #ifndef PCI_EXP_LNKCAP2
1599 #define PCI_EXP_LNKCAP2 44
1600 #endif
1601 #ifndef PCI_EXP_LNKSTA2
1602 #define PCI_EXP_LNKSTA2 50
1603 #endif
1604                 /* Link 2 Capabilities, Status, and Control goes away */
1605                 if (size > PCI_EXP_LNKCAP2) {
1606                     vfio_add_emulated_long(vdev, pos + PCI_EXP_LNKCAP2, 0, ~0);
1607                     vfio_add_emulated_word(vdev, pos + PCI_EXP_LNKCTL2, 0, ~0);
1608                     vfio_add_emulated_word(vdev, pos + PCI_EXP_LNKSTA2, 0, ~0);
1609                 }
1610             }
1611 
1612         } else if (type == PCI_EXP_TYPE_LEG_END) {
1613             /*
1614              * Legacy endpoints don't belong on the root complex.  Windows
1615              * seems to be happier with devices if we skip the capability.
1616              */
1617             return 0;
1618         }
1619 
1620     } else {
1621         /*
1622          * Convert Root Complex Integrated Endpoints to regular endpoints.
1623          * These devices don't support LNK/LNK2 capabilities, so make them up.
1624          */
1625         if (type == PCI_EXP_TYPE_RC_END) {
1626             vfio_add_emulated_word(vdev, pos + PCI_CAP_FLAGS,
1627                                    PCI_EXP_TYPE_ENDPOINT << 4,
1628                                    PCI_EXP_FLAGS_TYPE);
1629             vfio_add_emulated_long(vdev, pos + PCI_EXP_LNKCAP,
1630                                    PCI_EXP_LNK_MLW_1 | PCI_EXP_LNK_LS_25, ~0);
1631             vfio_add_emulated_word(vdev, pos + PCI_EXP_LNKCTL, 0, ~0);
1632         }
1633 
1634         /* Mark the Link Status bits as emulated to allow virtual negotiation */
1635         vfio_add_emulated_word(vdev, pos + PCI_EXP_LNKSTA,
1636                                pci_get_word(vdev->pdev.config + pos +
1637                                             PCI_EXP_LNKSTA),
1638                                PCI_EXP_LNKCAP_MLW | PCI_EXP_LNKCAP_SLS);
1639     }
1640 
1641     pos = pci_add_capability(&vdev->pdev, PCI_CAP_ID_EXP, pos, size);
1642     if (pos >= 0) {
1643         vdev->pdev.exp.exp_cap = pos;
1644     }
1645 
1646     return pos;
1647 }
1648 
1649 static void vfio_check_pcie_flr(VFIOPCIDevice *vdev, uint8_t pos)
1650 {
1651     uint32_t cap = pci_get_long(vdev->pdev.config + pos + PCI_EXP_DEVCAP);
1652 
1653     if (cap & PCI_EXP_DEVCAP_FLR) {
1654         trace_vfio_check_pcie_flr(vdev->vbasedev.name);
1655         vdev->has_flr = true;
1656     }
1657 }
1658 
1659 static void vfio_check_pm_reset(VFIOPCIDevice *vdev, uint8_t pos)
1660 {
1661     uint16_t csr = pci_get_word(vdev->pdev.config + pos + PCI_PM_CTRL);
1662 
1663     if (!(csr & PCI_PM_CTRL_NO_SOFT_RESET)) {
1664         trace_vfio_check_pm_reset(vdev->vbasedev.name);
1665         vdev->has_pm_reset = true;
1666     }
1667 }
1668 
1669 static void vfio_check_af_flr(VFIOPCIDevice *vdev, uint8_t pos)
1670 {
1671     uint8_t cap = pci_get_byte(vdev->pdev.config + pos + PCI_AF_CAP);
1672 
1673     if ((cap & PCI_AF_CAP_TP) && (cap & PCI_AF_CAP_FLR)) {
1674         trace_vfio_check_af_flr(vdev->vbasedev.name);
1675         vdev->has_flr = true;
1676     }
1677 }
1678 
1679 static int vfio_add_std_cap(VFIOPCIDevice *vdev, uint8_t pos)
1680 {
1681     PCIDevice *pdev = &vdev->pdev;
1682     uint8_t cap_id, next, size;
1683     int ret;
1684 
1685     cap_id = pdev->config[pos];
1686     next = pdev->config[pos + PCI_CAP_LIST_NEXT];
1687 
1688     /*
1689      * If it becomes important to configure capabilities to their actual
1690      * size, use this as the default when it's something we don't recognize.
1691      * Since QEMU doesn't actually handle many of the config accesses,
1692      * exact size doesn't seem worthwhile.
1693      */
1694     size = vfio_std_cap_max_size(pdev, pos);
1695 
1696     /*
1697      * pci_add_capability always inserts the new capability at the head
1698      * of the chain.  Therefore to end up with a chain that matches the
1699      * physical device, we insert from the end by making this recursive.
1700      * This is also why we pre-calculate size above as cached config space
1701      * will be changed as we unwind the stack.
1702      */
1703     if (next) {
1704         ret = vfio_add_std_cap(vdev, next);
1705         if (ret) {
1706             return ret;
1707         }
1708     } else {
1709         /* Begin the rebuild, use QEMU emulated list bits */
1710         pdev->config[PCI_CAPABILITY_LIST] = 0;
1711         vdev->emulated_config_bits[PCI_CAPABILITY_LIST] = 0xff;
1712         vdev->emulated_config_bits[PCI_STATUS] |= PCI_STATUS_CAP_LIST;
1713     }
1714 
1715     /* Use emulated next pointer to allow dropping caps */
1716     pci_set_byte(vdev->emulated_config_bits + pos + PCI_CAP_LIST_NEXT, 0xff);
1717 
1718     switch (cap_id) {
1719     case PCI_CAP_ID_MSI:
1720         ret = vfio_msi_setup(vdev, pos);
1721         break;
1722     case PCI_CAP_ID_EXP:
1723         vfio_check_pcie_flr(vdev, pos);
1724         ret = vfio_setup_pcie_cap(vdev, pos, size);
1725         break;
1726     case PCI_CAP_ID_MSIX:
1727         ret = vfio_msix_setup(vdev, pos);
1728         break;
1729     case PCI_CAP_ID_PM:
1730         vfio_check_pm_reset(vdev, pos);
1731         vdev->pm_cap = pos;
1732         ret = pci_add_capability(pdev, cap_id, pos, size);
1733         break;
1734     case PCI_CAP_ID_AF:
1735         vfio_check_af_flr(vdev, pos);
1736         ret = pci_add_capability(pdev, cap_id, pos, size);
1737         break;
1738     default:
1739         ret = pci_add_capability(pdev, cap_id, pos, size);
1740         break;
1741     }
1742 
1743     if (ret < 0) {
1744         error_report("vfio: %s Error adding PCI capability "
1745                      "0x%x[0x%x]@0x%x: %d", vdev->vbasedev.name,
1746                      cap_id, size, pos, ret);
1747         return ret;
1748     }
1749 
1750     return 0;
1751 }
1752 
1753 static int vfio_add_capabilities(VFIOPCIDevice *vdev)
1754 {
1755     PCIDevice *pdev = &vdev->pdev;
1756 
1757     if (!(pdev->config[PCI_STATUS] & PCI_STATUS_CAP_LIST) ||
1758         !pdev->config[PCI_CAPABILITY_LIST]) {
1759         return 0; /* Nothing to add */
1760     }
1761 
1762     return vfio_add_std_cap(vdev, pdev->config[PCI_CAPABILITY_LIST]);
1763 }
1764 
1765 static void vfio_pci_pre_reset(VFIOPCIDevice *vdev)
1766 {
1767     PCIDevice *pdev = &vdev->pdev;
1768     uint16_t cmd;
1769 
1770     vfio_disable_interrupts(vdev);
1771 
1772     /* Make sure the device is in D0 */
1773     if (vdev->pm_cap) {
1774         uint16_t pmcsr;
1775         uint8_t state;
1776 
1777         pmcsr = vfio_pci_read_config(pdev, vdev->pm_cap + PCI_PM_CTRL, 2);
1778         state = pmcsr & PCI_PM_CTRL_STATE_MASK;
1779         if (state) {
1780             pmcsr &= ~PCI_PM_CTRL_STATE_MASK;
1781             vfio_pci_write_config(pdev, vdev->pm_cap + PCI_PM_CTRL, pmcsr, 2);
1782             /* vfio handles the necessary delay here */
1783             pmcsr = vfio_pci_read_config(pdev, vdev->pm_cap + PCI_PM_CTRL, 2);
1784             state = pmcsr & PCI_PM_CTRL_STATE_MASK;
1785             if (state) {
1786                 error_report("vfio: Unable to power on device, stuck in D%d",
1787                              state);
1788             }
1789         }
1790     }
1791 
1792     /*
1793      * Stop any ongoing DMA by disconecting I/O, MMIO, and bus master.
1794      * Also put INTx Disable in known state.
1795      */
1796     cmd = vfio_pci_read_config(pdev, PCI_COMMAND, 2);
1797     cmd &= ~(PCI_COMMAND_IO | PCI_COMMAND_MEMORY | PCI_COMMAND_MASTER |
1798              PCI_COMMAND_INTX_DISABLE);
1799     vfio_pci_write_config(pdev, PCI_COMMAND, cmd, 2);
1800 }
1801 
1802 static void vfio_pci_post_reset(VFIOPCIDevice *vdev)
1803 {
1804     vfio_intx_enable(vdev);
1805 }
1806 
1807 static bool vfio_pci_host_match(PCIHostDeviceAddress *addr, const char *name)
1808 {
1809     char tmp[13];
1810 
1811     sprintf(tmp, "%04x:%02x:%02x.%1x", addr->domain,
1812             addr->bus, addr->slot, addr->function);
1813 
1814     return (strcmp(tmp, name) == 0);
1815 }
1816 
1817 static int vfio_pci_hot_reset(VFIOPCIDevice *vdev, bool single)
1818 {
1819     VFIOGroup *group;
1820     struct vfio_pci_hot_reset_info *info;
1821     struct vfio_pci_dependent_device *devices;
1822     struct vfio_pci_hot_reset *reset;
1823     int32_t *fds;
1824     int ret, i, count;
1825     bool multi = false;
1826 
1827     trace_vfio_pci_hot_reset(vdev->vbasedev.name, single ? "one" : "multi");
1828 
1829     vfio_pci_pre_reset(vdev);
1830     vdev->vbasedev.needs_reset = false;
1831 
1832     info = g_malloc0(sizeof(*info));
1833     info->argsz = sizeof(*info);
1834 
1835     ret = ioctl(vdev->vbasedev.fd, VFIO_DEVICE_GET_PCI_HOT_RESET_INFO, info);
1836     if (ret && errno != ENOSPC) {
1837         ret = -errno;
1838         if (!vdev->has_pm_reset) {
1839             error_report("vfio: Cannot reset device %s, "
1840                          "no available reset mechanism.", vdev->vbasedev.name);
1841         }
1842         goto out_single;
1843     }
1844 
1845     count = info->count;
1846     info = g_realloc(info, sizeof(*info) + (count * sizeof(*devices)));
1847     info->argsz = sizeof(*info) + (count * sizeof(*devices));
1848     devices = &info->devices[0];
1849 
1850     ret = ioctl(vdev->vbasedev.fd, VFIO_DEVICE_GET_PCI_HOT_RESET_INFO, info);
1851     if (ret) {
1852         ret = -errno;
1853         error_report("vfio: hot reset info failed: %m");
1854         goto out_single;
1855     }
1856 
1857     trace_vfio_pci_hot_reset_has_dep_devices(vdev->vbasedev.name);
1858 
1859     /* Verify that we have all the groups required */
1860     for (i = 0; i < info->count; i++) {
1861         PCIHostDeviceAddress host;
1862         VFIOPCIDevice *tmp;
1863         VFIODevice *vbasedev_iter;
1864 
1865         host.domain = devices[i].segment;
1866         host.bus = devices[i].bus;
1867         host.slot = PCI_SLOT(devices[i].devfn);
1868         host.function = PCI_FUNC(devices[i].devfn);
1869 
1870         trace_vfio_pci_hot_reset_dep_devices(host.domain,
1871                 host.bus, host.slot, host.function, devices[i].group_id);
1872 
1873         if (vfio_pci_host_match(&host, vdev->vbasedev.name)) {
1874             continue;
1875         }
1876 
1877         QLIST_FOREACH(group, &vfio_group_list, next) {
1878             if (group->groupid == devices[i].group_id) {
1879                 break;
1880             }
1881         }
1882 
1883         if (!group) {
1884             if (!vdev->has_pm_reset) {
1885                 error_report("vfio: Cannot reset device %s, "
1886                              "depends on group %d which is not owned.",
1887                              vdev->vbasedev.name, devices[i].group_id);
1888             }
1889             ret = -EPERM;
1890             goto out;
1891         }
1892 
1893         /* Prep dependent devices for reset and clear our marker. */
1894         QLIST_FOREACH(vbasedev_iter, &group->device_list, next) {
1895             if (vbasedev_iter->type != VFIO_DEVICE_TYPE_PCI) {
1896                 continue;
1897             }
1898             tmp = container_of(vbasedev_iter, VFIOPCIDevice, vbasedev);
1899             if (vfio_pci_host_match(&host, tmp->vbasedev.name)) {
1900                 if (single) {
1901                     ret = -EINVAL;
1902                     goto out_single;
1903                 }
1904                 vfio_pci_pre_reset(tmp);
1905                 tmp->vbasedev.needs_reset = false;
1906                 multi = true;
1907                 break;
1908             }
1909         }
1910     }
1911 
1912     if (!single && !multi) {
1913         ret = -EINVAL;
1914         goto out_single;
1915     }
1916 
1917     /* Determine how many group fds need to be passed */
1918     count = 0;
1919     QLIST_FOREACH(group, &vfio_group_list, next) {
1920         for (i = 0; i < info->count; i++) {
1921             if (group->groupid == devices[i].group_id) {
1922                 count++;
1923                 break;
1924             }
1925         }
1926     }
1927 
1928     reset = g_malloc0(sizeof(*reset) + (count * sizeof(*fds)));
1929     reset->argsz = sizeof(*reset) + (count * sizeof(*fds));
1930     fds = &reset->group_fds[0];
1931 
1932     /* Fill in group fds */
1933     QLIST_FOREACH(group, &vfio_group_list, next) {
1934         for (i = 0; i < info->count; i++) {
1935             if (group->groupid == devices[i].group_id) {
1936                 fds[reset->count++] = group->fd;
1937                 break;
1938             }
1939         }
1940     }
1941 
1942     /* Bus reset! */
1943     ret = ioctl(vdev->vbasedev.fd, VFIO_DEVICE_PCI_HOT_RESET, reset);
1944     g_free(reset);
1945 
1946     trace_vfio_pci_hot_reset_result(vdev->vbasedev.name,
1947                                     ret ? "%m" : "Success");
1948 
1949 out:
1950     /* Re-enable INTx on affected devices */
1951     for (i = 0; i < info->count; i++) {
1952         PCIHostDeviceAddress host;
1953         VFIOPCIDevice *tmp;
1954         VFIODevice *vbasedev_iter;
1955 
1956         host.domain = devices[i].segment;
1957         host.bus = devices[i].bus;
1958         host.slot = PCI_SLOT(devices[i].devfn);
1959         host.function = PCI_FUNC(devices[i].devfn);
1960 
1961         if (vfio_pci_host_match(&host, vdev->vbasedev.name)) {
1962             continue;
1963         }
1964 
1965         QLIST_FOREACH(group, &vfio_group_list, next) {
1966             if (group->groupid == devices[i].group_id) {
1967                 break;
1968             }
1969         }
1970 
1971         if (!group) {
1972             break;
1973         }
1974 
1975         QLIST_FOREACH(vbasedev_iter, &group->device_list, next) {
1976             if (vbasedev_iter->type != VFIO_DEVICE_TYPE_PCI) {
1977                 continue;
1978             }
1979             tmp = container_of(vbasedev_iter, VFIOPCIDevice, vbasedev);
1980             if (vfio_pci_host_match(&host, tmp->vbasedev.name)) {
1981                 vfio_pci_post_reset(tmp);
1982                 break;
1983             }
1984         }
1985     }
1986 out_single:
1987     vfio_pci_post_reset(vdev);
1988     g_free(info);
1989 
1990     return ret;
1991 }
1992 
1993 /*
1994  * We want to differentiate hot reset of mulitple in-use devices vs hot reset
1995  * of a single in-use device.  VFIO_DEVICE_RESET will already handle the case
1996  * of doing hot resets when there is only a single device per bus.  The in-use
1997  * here refers to how many VFIODevices are affected.  A hot reset that affects
1998  * multiple devices, but only a single in-use device, means that we can call
1999  * it from our bus ->reset() callback since the extent is effectively a single
2000  * device.  This allows us to make use of it in the hotplug path.  When there
2001  * are multiple in-use devices, we can only trigger the hot reset during a
2002  * system reset and thus from our reset handler.  We separate _one vs _multi
2003  * here so that we don't overlap and do a double reset on the system reset
2004  * path where both our reset handler and ->reset() callback are used.  Calling
2005  * _one() will only do a hot reset for the one in-use devices case, calling
2006  * _multi() will do nothing if a _one() would have been sufficient.
2007  */
2008 static int vfio_pci_hot_reset_one(VFIOPCIDevice *vdev)
2009 {
2010     return vfio_pci_hot_reset(vdev, true);
2011 }
2012 
2013 static int vfio_pci_hot_reset_multi(VFIODevice *vbasedev)
2014 {
2015     VFIOPCIDevice *vdev = container_of(vbasedev, VFIOPCIDevice, vbasedev);
2016     return vfio_pci_hot_reset(vdev, false);
2017 }
2018 
2019 static void vfio_pci_compute_needs_reset(VFIODevice *vbasedev)
2020 {
2021     VFIOPCIDevice *vdev = container_of(vbasedev, VFIOPCIDevice, vbasedev);
2022     if (!vbasedev->reset_works || (!vdev->has_flr && vdev->has_pm_reset)) {
2023         vbasedev->needs_reset = true;
2024     }
2025 }
2026 
2027 static VFIODeviceOps vfio_pci_ops = {
2028     .vfio_compute_needs_reset = vfio_pci_compute_needs_reset,
2029     .vfio_hot_reset_multi = vfio_pci_hot_reset_multi,
2030     .vfio_eoi = vfio_intx_eoi,
2031 };
2032 
2033 int vfio_populate_vga(VFIOPCIDevice *vdev)
2034 {
2035     VFIODevice *vbasedev = &vdev->vbasedev;
2036     struct vfio_region_info *reg_info;
2037     int ret;
2038 
2039     ret = vfio_get_region_info(vbasedev, VFIO_PCI_VGA_REGION_INDEX, &reg_info);
2040     if (ret) {
2041         return ret;
2042     }
2043 
2044     if (!(reg_info->flags & VFIO_REGION_INFO_FLAG_READ) ||
2045         !(reg_info->flags & VFIO_REGION_INFO_FLAG_WRITE) ||
2046         reg_info->size < 0xbffff + 1) {
2047         error_report("vfio: Unexpected VGA info, flags 0x%lx, size 0x%lx",
2048                      (unsigned long)reg_info->flags,
2049                      (unsigned long)reg_info->size);
2050         g_free(reg_info);
2051         return -EINVAL;
2052     }
2053 
2054     vdev->vga = g_new0(VFIOVGA, 1);
2055 
2056     vdev->vga->fd_offset = reg_info->offset;
2057     vdev->vga->fd = vdev->vbasedev.fd;
2058 
2059     g_free(reg_info);
2060 
2061     vdev->vga->region[QEMU_PCI_VGA_MEM].offset = QEMU_PCI_VGA_MEM_BASE;
2062     vdev->vga->region[QEMU_PCI_VGA_MEM].nr = QEMU_PCI_VGA_MEM;
2063     QLIST_INIT(&vdev->vga->region[QEMU_PCI_VGA_MEM].quirks);
2064 
2065     memory_region_init_io(&vdev->vga->region[QEMU_PCI_VGA_MEM].mem,
2066                           OBJECT(vdev), &vfio_vga_ops,
2067                           &vdev->vga->region[QEMU_PCI_VGA_MEM],
2068                           "vfio-vga-mmio@0xa0000",
2069                           QEMU_PCI_VGA_MEM_SIZE);
2070 
2071     vdev->vga->region[QEMU_PCI_VGA_IO_LO].offset = QEMU_PCI_VGA_IO_LO_BASE;
2072     vdev->vga->region[QEMU_PCI_VGA_IO_LO].nr = QEMU_PCI_VGA_IO_LO;
2073     QLIST_INIT(&vdev->vga->region[QEMU_PCI_VGA_IO_LO].quirks);
2074 
2075     memory_region_init_io(&vdev->vga->region[QEMU_PCI_VGA_IO_LO].mem,
2076                           OBJECT(vdev), &vfio_vga_ops,
2077                           &vdev->vga->region[QEMU_PCI_VGA_IO_LO],
2078                           "vfio-vga-io@0x3b0",
2079                           QEMU_PCI_VGA_IO_LO_SIZE);
2080 
2081     vdev->vga->region[QEMU_PCI_VGA_IO_HI].offset = QEMU_PCI_VGA_IO_HI_BASE;
2082     vdev->vga->region[QEMU_PCI_VGA_IO_HI].nr = QEMU_PCI_VGA_IO_HI;
2083     QLIST_INIT(&vdev->vga->region[QEMU_PCI_VGA_IO_HI].quirks);
2084 
2085     memory_region_init_io(&vdev->vga->region[QEMU_PCI_VGA_IO_HI].mem,
2086                           OBJECT(vdev), &vfio_vga_ops,
2087                           &vdev->vga->region[QEMU_PCI_VGA_IO_HI],
2088                           "vfio-vga-io@0x3c0",
2089                           QEMU_PCI_VGA_IO_HI_SIZE);
2090 
2091     pci_register_vga(&vdev->pdev, &vdev->vga->region[QEMU_PCI_VGA_MEM].mem,
2092                      &vdev->vga->region[QEMU_PCI_VGA_IO_LO].mem,
2093                      &vdev->vga->region[QEMU_PCI_VGA_IO_HI].mem);
2094 
2095     return 0;
2096 }
2097 
2098 static int vfio_populate_device(VFIOPCIDevice *vdev)
2099 {
2100     VFIODevice *vbasedev = &vdev->vbasedev;
2101     struct vfio_region_info *reg_info;
2102     struct vfio_irq_info irq_info = { .argsz = sizeof(irq_info) };
2103     int i, ret = -1;
2104 
2105     /* Sanity check device */
2106     if (!(vbasedev->flags & VFIO_DEVICE_FLAGS_PCI)) {
2107         error_report("vfio: Um, this isn't a PCI device");
2108         goto error;
2109     }
2110 
2111     if (vbasedev->num_regions < VFIO_PCI_CONFIG_REGION_INDEX + 1) {
2112         error_report("vfio: unexpected number of io regions %u",
2113                      vbasedev->num_regions);
2114         goto error;
2115     }
2116 
2117     if (vbasedev->num_irqs < VFIO_PCI_MSIX_IRQ_INDEX + 1) {
2118         error_report("vfio: unexpected number of irqs %u", vbasedev->num_irqs);
2119         goto error;
2120     }
2121 
2122     for (i = VFIO_PCI_BAR0_REGION_INDEX; i < VFIO_PCI_ROM_REGION_INDEX; i++) {
2123         char *name = g_strdup_printf("%s BAR %d", vbasedev->name, i);
2124 
2125         ret = vfio_region_setup(OBJECT(vdev), vbasedev,
2126                                 &vdev->bars[i].region, i, name);
2127         g_free(name);
2128 
2129         if (ret) {
2130             error_report("vfio: Error getting region %d info: %m", i);
2131             goto error;
2132         }
2133 
2134         QLIST_INIT(&vdev->bars[i].quirks);
2135     }
2136 
2137     ret = vfio_get_region_info(vbasedev,
2138                                VFIO_PCI_CONFIG_REGION_INDEX, &reg_info);
2139     if (ret) {
2140         error_report("vfio: Error getting config info: %m");
2141         goto error;
2142     }
2143 
2144     trace_vfio_populate_device_config(vdev->vbasedev.name,
2145                                       (unsigned long)reg_info->size,
2146                                       (unsigned long)reg_info->offset,
2147                                       (unsigned long)reg_info->flags);
2148 
2149     vdev->config_size = reg_info->size;
2150     if (vdev->config_size == PCI_CONFIG_SPACE_SIZE) {
2151         vdev->pdev.cap_present &= ~QEMU_PCI_CAP_EXPRESS;
2152     }
2153     vdev->config_offset = reg_info->offset;
2154 
2155     g_free(reg_info);
2156 
2157     if (vdev->features & VFIO_FEATURE_ENABLE_VGA) {
2158         ret = vfio_populate_vga(vdev);
2159         if (ret) {
2160             error_report(
2161                 "vfio: Device does not support requested feature x-vga");
2162             goto error;
2163         }
2164     }
2165 
2166     irq_info.index = VFIO_PCI_ERR_IRQ_INDEX;
2167 
2168     ret = ioctl(vdev->vbasedev.fd, VFIO_DEVICE_GET_IRQ_INFO, &irq_info);
2169     if (ret) {
2170         /* This can fail for an old kernel or legacy PCI dev */
2171         trace_vfio_populate_device_get_irq_info_failure();
2172         ret = 0;
2173     } else if (irq_info.count == 1) {
2174         vdev->pci_aer = true;
2175     } else {
2176         error_report("vfio: %s "
2177                      "Could not enable error recovery for the device",
2178                      vbasedev->name);
2179     }
2180 
2181 error:
2182     return ret;
2183 }
2184 
2185 static void vfio_put_device(VFIOPCIDevice *vdev)
2186 {
2187     g_free(vdev->vbasedev.name);
2188     g_free(vdev->msix);
2189 
2190     vfio_put_base_device(&vdev->vbasedev);
2191 }
2192 
2193 static void vfio_err_notifier_handler(void *opaque)
2194 {
2195     VFIOPCIDevice *vdev = opaque;
2196 
2197     if (!event_notifier_test_and_clear(&vdev->err_notifier)) {
2198         return;
2199     }
2200 
2201     /*
2202      * TBD. Retrieve the error details and decide what action
2203      * needs to be taken. One of the actions could be to pass
2204      * the error to the guest and have the guest driver recover
2205      * from the error. This requires that PCIe capabilities be
2206      * exposed to the guest. For now, we just terminate the
2207      * guest to contain the error.
2208      */
2209 
2210     error_report("%s(%s) Unrecoverable error detected. Please collect any data possible and then kill the guest", __func__, vdev->vbasedev.name);
2211 
2212     vm_stop(RUN_STATE_INTERNAL_ERROR);
2213 }
2214 
2215 /*
2216  * Registers error notifier for devices supporting error recovery.
2217  * If we encounter a failure in this function, we report an error
2218  * and continue after disabling error recovery support for the
2219  * device.
2220  */
2221 static void vfio_register_err_notifier(VFIOPCIDevice *vdev)
2222 {
2223     int ret;
2224     int argsz;
2225     struct vfio_irq_set *irq_set;
2226     int32_t *pfd;
2227 
2228     if (!vdev->pci_aer) {
2229         return;
2230     }
2231 
2232     if (event_notifier_init(&vdev->err_notifier, 0)) {
2233         error_report("vfio: Unable to init event notifier for error detection");
2234         vdev->pci_aer = false;
2235         return;
2236     }
2237 
2238     argsz = sizeof(*irq_set) + sizeof(*pfd);
2239 
2240     irq_set = g_malloc0(argsz);
2241     irq_set->argsz = argsz;
2242     irq_set->flags = VFIO_IRQ_SET_DATA_EVENTFD |
2243                      VFIO_IRQ_SET_ACTION_TRIGGER;
2244     irq_set->index = VFIO_PCI_ERR_IRQ_INDEX;
2245     irq_set->start = 0;
2246     irq_set->count = 1;
2247     pfd = (int32_t *)&irq_set->data;
2248 
2249     *pfd = event_notifier_get_fd(&vdev->err_notifier);
2250     qemu_set_fd_handler(*pfd, vfio_err_notifier_handler, NULL, vdev);
2251 
2252     ret = ioctl(vdev->vbasedev.fd, VFIO_DEVICE_SET_IRQS, irq_set);
2253     if (ret) {
2254         error_report("vfio: Failed to set up error notification");
2255         qemu_set_fd_handler(*pfd, NULL, NULL, vdev);
2256         event_notifier_cleanup(&vdev->err_notifier);
2257         vdev->pci_aer = false;
2258     }
2259     g_free(irq_set);
2260 }
2261 
2262 static void vfio_unregister_err_notifier(VFIOPCIDevice *vdev)
2263 {
2264     int argsz;
2265     struct vfio_irq_set *irq_set;
2266     int32_t *pfd;
2267     int ret;
2268 
2269     if (!vdev->pci_aer) {
2270         return;
2271     }
2272 
2273     argsz = sizeof(*irq_set) + sizeof(*pfd);
2274 
2275     irq_set = g_malloc0(argsz);
2276     irq_set->argsz = argsz;
2277     irq_set->flags = VFIO_IRQ_SET_DATA_EVENTFD |
2278                      VFIO_IRQ_SET_ACTION_TRIGGER;
2279     irq_set->index = VFIO_PCI_ERR_IRQ_INDEX;
2280     irq_set->start = 0;
2281     irq_set->count = 1;
2282     pfd = (int32_t *)&irq_set->data;
2283     *pfd = -1;
2284 
2285     ret = ioctl(vdev->vbasedev.fd, VFIO_DEVICE_SET_IRQS, irq_set);
2286     if (ret) {
2287         error_report("vfio: Failed to de-assign error fd: %m");
2288     }
2289     g_free(irq_set);
2290     qemu_set_fd_handler(event_notifier_get_fd(&vdev->err_notifier),
2291                         NULL, NULL, vdev);
2292     event_notifier_cleanup(&vdev->err_notifier);
2293 }
2294 
2295 static void vfio_req_notifier_handler(void *opaque)
2296 {
2297     VFIOPCIDevice *vdev = opaque;
2298 
2299     if (!event_notifier_test_and_clear(&vdev->req_notifier)) {
2300         return;
2301     }
2302 
2303     qdev_unplug(&vdev->pdev.qdev, NULL);
2304 }
2305 
2306 static void vfio_register_req_notifier(VFIOPCIDevice *vdev)
2307 {
2308     struct vfio_irq_info irq_info = { .argsz = sizeof(irq_info),
2309                                       .index = VFIO_PCI_REQ_IRQ_INDEX };
2310     int argsz;
2311     struct vfio_irq_set *irq_set;
2312     int32_t *pfd;
2313 
2314     if (!(vdev->features & VFIO_FEATURE_ENABLE_REQ)) {
2315         return;
2316     }
2317 
2318     if (ioctl(vdev->vbasedev.fd,
2319               VFIO_DEVICE_GET_IRQ_INFO, &irq_info) < 0 || irq_info.count < 1) {
2320         return;
2321     }
2322 
2323     if (event_notifier_init(&vdev->req_notifier, 0)) {
2324         error_report("vfio: Unable to init event notifier for device request");
2325         return;
2326     }
2327 
2328     argsz = sizeof(*irq_set) + sizeof(*pfd);
2329 
2330     irq_set = g_malloc0(argsz);
2331     irq_set->argsz = argsz;
2332     irq_set->flags = VFIO_IRQ_SET_DATA_EVENTFD |
2333                      VFIO_IRQ_SET_ACTION_TRIGGER;
2334     irq_set->index = VFIO_PCI_REQ_IRQ_INDEX;
2335     irq_set->start = 0;
2336     irq_set->count = 1;
2337     pfd = (int32_t *)&irq_set->data;
2338 
2339     *pfd = event_notifier_get_fd(&vdev->req_notifier);
2340     qemu_set_fd_handler(*pfd, vfio_req_notifier_handler, NULL, vdev);
2341 
2342     if (ioctl(vdev->vbasedev.fd, VFIO_DEVICE_SET_IRQS, irq_set)) {
2343         error_report("vfio: Failed to set up device request notification");
2344         qemu_set_fd_handler(*pfd, NULL, NULL, vdev);
2345         event_notifier_cleanup(&vdev->req_notifier);
2346     } else {
2347         vdev->req_enabled = true;
2348     }
2349 
2350     g_free(irq_set);
2351 }
2352 
2353 static void vfio_unregister_req_notifier(VFIOPCIDevice *vdev)
2354 {
2355     int argsz;
2356     struct vfio_irq_set *irq_set;
2357     int32_t *pfd;
2358 
2359     if (!vdev->req_enabled) {
2360         return;
2361     }
2362 
2363     argsz = sizeof(*irq_set) + sizeof(*pfd);
2364 
2365     irq_set = g_malloc0(argsz);
2366     irq_set->argsz = argsz;
2367     irq_set->flags = VFIO_IRQ_SET_DATA_EVENTFD |
2368                      VFIO_IRQ_SET_ACTION_TRIGGER;
2369     irq_set->index = VFIO_PCI_REQ_IRQ_INDEX;
2370     irq_set->start = 0;
2371     irq_set->count = 1;
2372     pfd = (int32_t *)&irq_set->data;
2373     *pfd = -1;
2374 
2375     if (ioctl(vdev->vbasedev.fd, VFIO_DEVICE_SET_IRQS, irq_set)) {
2376         error_report("vfio: Failed to de-assign device request fd: %m");
2377     }
2378     g_free(irq_set);
2379     qemu_set_fd_handler(event_notifier_get_fd(&vdev->req_notifier),
2380                         NULL, NULL, vdev);
2381     event_notifier_cleanup(&vdev->req_notifier);
2382 
2383     vdev->req_enabled = false;
2384 }
2385 
2386 static int vfio_initfn(PCIDevice *pdev)
2387 {
2388     VFIOPCIDevice *vdev = DO_UPCAST(VFIOPCIDevice, pdev, pdev);
2389     VFIODevice *vbasedev_iter;
2390     VFIOGroup *group;
2391     char *tmp, group_path[PATH_MAX], *group_name;
2392     ssize_t len;
2393     struct stat st;
2394     int groupid;
2395     int i, ret;
2396 
2397     if (!vdev->vbasedev.sysfsdev) {
2398         vdev->vbasedev.sysfsdev =
2399             g_strdup_printf("/sys/bus/pci/devices/%04x:%02x:%02x.%01x",
2400                             vdev->host.domain, vdev->host.bus,
2401                             vdev->host.slot, vdev->host.function);
2402     }
2403 
2404     if (stat(vdev->vbasedev.sysfsdev, &st) < 0) {
2405         error_report("vfio: error: no such host device: %s",
2406                      vdev->vbasedev.sysfsdev);
2407         return -errno;
2408     }
2409 
2410     vdev->vbasedev.name = g_strdup(basename(vdev->vbasedev.sysfsdev));
2411     vdev->vbasedev.ops = &vfio_pci_ops;
2412     vdev->vbasedev.type = VFIO_DEVICE_TYPE_PCI;
2413 
2414     tmp = g_strdup_printf("%s/iommu_group", vdev->vbasedev.sysfsdev);
2415     len = readlink(tmp, group_path, sizeof(group_path));
2416     g_free(tmp);
2417 
2418     if (len <= 0 || len >= sizeof(group_path)) {
2419         error_report("vfio: error no iommu_group for device");
2420         return len < 0 ? -errno : -ENAMETOOLONG;
2421     }
2422 
2423     group_path[len] = 0;
2424 
2425     group_name = basename(group_path);
2426     if (sscanf(group_name, "%d", &groupid) != 1) {
2427         error_report("vfio: error reading %s: %m", group_path);
2428         return -errno;
2429     }
2430 
2431     trace_vfio_initfn(vdev->vbasedev.name, groupid);
2432 
2433     group = vfio_get_group(groupid, pci_device_iommu_address_space(pdev));
2434     if (!group) {
2435         error_report("vfio: failed to get group %d", groupid);
2436         return -ENOENT;
2437     }
2438 
2439     QLIST_FOREACH(vbasedev_iter, &group->device_list, next) {
2440         if (strcmp(vbasedev_iter->name, vdev->vbasedev.name) == 0) {
2441             error_report("vfio: error: device %s is already attached",
2442                          vdev->vbasedev.name);
2443             vfio_put_group(group);
2444             return -EBUSY;
2445         }
2446     }
2447 
2448     ret = vfio_get_device(group, vdev->vbasedev.name, &vdev->vbasedev);
2449     if (ret) {
2450         error_report("vfio: failed to get device %s", vdev->vbasedev.name);
2451         vfio_put_group(group);
2452         return ret;
2453     }
2454 
2455     ret = vfio_populate_device(vdev);
2456     if (ret) {
2457         return ret;
2458     }
2459 
2460     /* Get a copy of config space */
2461     ret = pread(vdev->vbasedev.fd, vdev->pdev.config,
2462                 MIN(pci_config_size(&vdev->pdev), vdev->config_size),
2463                 vdev->config_offset);
2464     if (ret < (int)MIN(pci_config_size(&vdev->pdev), vdev->config_size)) {
2465         ret = ret < 0 ? -errno : -EFAULT;
2466         error_report("vfio: Failed to read device config space");
2467         return ret;
2468     }
2469 
2470     /* vfio emulates a lot for us, but some bits need extra love */
2471     vdev->emulated_config_bits = g_malloc0(vdev->config_size);
2472 
2473     /* QEMU can choose to expose the ROM or not */
2474     memset(vdev->emulated_config_bits + PCI_ROM_ADDRESS, 0xff, 4);
2475 
2476     /*
2477      * The PCI spec reserves vendor ID 0xffff as an invalid value.  The
2478      * device ID is managed by the vendor and need only be a 16-bit value.
2479      * Allow any 16-bit value for subsystem so they can be hidden or changed.
2480      */
2481     if (vdev->vendor_id != PCI_ANY_ID) {
2482         if (vdev->vendor_id >= 0xffff) {
2483             error_report("vfio: Invalid PCI vendor ID provided");
2484             return -EINVAL;
2485         }
2486         vfio_add_emulated_word(vdev, PCI_VENDOR_ID, vdev->vendor_id, ~0);
2487         trace_vfio_pci_emulated_vendor_id(vdev->vbasedev.name, vdev->vendor_id);
2488     } else {
2489         vdev->vendor_id = pci_get_word(pdev->config + PCI_VENDOR_ID);
2490     }
2491 
2492     if (vdev->device_id != PCI_ANY_ID) {
2493         if (vdev->device_id > 0xffff) {
2494             error_report("vfio: Invalid PCI device ID provided");
2495             return -EINVAL;
2496         }
2497         vfio_add_emulated_word(vdev, PCI_DEVICE_ID, vdev->device_id, ~0);
2498         trace_vfio_pci_emulated_device_id(vdev->vbasedev.name, vdev->device_id);
2499     } else {
2500         vdev->device_id = pci_get_word(pdev->config + PCI_DEVICE_ID);
2501     }
2502 
2503     if (vdev->sub_vendor_id != PCI_ANY_ID) {
2504         if (vdev->sub_vendor_id > 0xffff) {
2505             error_report("vfio: Invalid PCI subsystem vendor ID provided");
2506             return -EINVAL;
2507         }
2508         vfio_add_emulated_word(vdev, PCI_SUBSYSTEM_VENDOR_ID,
2509                                vdev->sub_vendor_id, ~0);
2510         trace_vfio_pci_emulated_sub_vendor_id(vdev->vbasedev.name,
2511                                               vdev->sub_vendor_id);
2512     }
2513 
2514     if (vdev->sub_device_id != PCI_ANY_ID) {
2515         if (vdev->sub_device_id > 0xffff) {
2516             error_report("vfio: Invalid PCI subsystem device ID provided");
2517             return -EINVAL;
2518         }
2519         vfio_add_emulated_word(vdev, PCI_SUBSYSTEM_ID, vdev->sub_device_id, ~0);
2520         trace_vfio_pci_emulated_sub_device_id(vdev->vbasedev.name,
2521                                               vdev->sub_device_id);
2522     }
2523 
2524     /* QEMU can change multi-function devices to single function, or reverse */
2525     vdev->emulated_config_bits[PCI_HEADER_TYPE] =
2526                                               PCI_HEADER_TYPE_MULTI_FUNCTION;
2527 
2528     /* Restore or clear multifunction, this is always controlled by QEMU */
2529     if (vdev->pdev.cap_present & QEMU_PCI_CAP_MULTIFUNCTION) {
2530         vdev->pdev.config[PCI_HEADER_TYPE] |= PCI_HEADER_TYPE_MULTI_FUNCTION;
2531     } else {
2532         vdev->pdev.config[PCI_HEADER_TYPE] &= ~PCI_HEADER_TYPE_MULTI_FUNCTION;
2533     }
2534 
2535     /*
2536      * Clear host resource mapping info.  If we choose not to register a
2537      * BAR, such as might be the case with the option ROM, we can get
2538      * confusing, unwritable, residual addresses from the host here.
2539      */
2540     memset(&vdev->pdev.config[PCI_BASE_ADDRESS_0], 0, 24);
2541     memset(&vdev->pdev.config[PCI_ROM_ADDRESS], 0, 4);
2542 
2543     vfio_pci_size_rom(vdev);
2544 
2545     ret = vfio_msix_early_setup(vdev);
2546     if (ret) {
2547         return ret;
2548     }
2549 
2550     vfio_bars_setup(vdev);
2551 
2552     ret = vfio_add_capabilities(vdev);
2553     if (ret) {
2554         goto out_teardown;
2555     }
2556 
2557     if (vdev->vga) {
2558         vfio_vga_quirk_setup(vdev);
2559     }
2560 
2561     for (i = 0; i < PCI_ROM_SLOT; i++) {
2562         vfio_bar_quirk_setup(vdev, i);
2563     }
2564 
2565     if (!vdev->igd_opregion &&
2566         vdev->features & VFIO_FEATURE_ENABLE_IGD_OPREGION) {
2567         struct vfio_region_info *opregion;
2568 
2569         if (vdev->pdev.qdev.hotplugged) {
2570             error_report("Cannot support IGD OpRegion feature on hotplugged "
2571                          "device %s", vdev->vbasedev.name);
2572             ret = -EINVAL;
2573             goto out_teardown;
2574         }
2575 
2576         ret = vfio_get_dev_region_info(&vdev->vbasedev,
2577                         VFIO_REGION_TYPE_PCI_VENDOR_TYPE | PCI_VENDOR_ID_INTEL,
2578                         VFIO_REGION_SUBTYPE_INTEL_IGD_OPREGION, &opregion);
2579         if (ret) {
2580             error_report("Device %s does not support requested IGD OpRegion "
2581                          "feature", vdev->vbasedev.name);
2582             goto out_teardown;
2583         }
2584 
2585         ret = vfio_pci_igd_opregion_init(vdev, opregion);
2586         g_free(opregion);
2587         if (ret) {
2588             error_report("Device %s IGD OpRegion initialization failed",
2589                          vdev->vbasedev.name);
2590             goto out_teardown;
2591         }
2592     }
2593 
2594     /* QEMU emulates all of MSI & MSIX */
2595     if (pdev->cap_present & QEMU_PCI_CAP_MSIX) {
2596         memset(vdev->emulated_config_bits + pdev->msix_cap, 0xff,
2597                MSIX_CAP_LENGTH);
2598     }
2599 
2600     if (pdev->cap_present & QEMU_PCI_CAP_MSI) {
2601         memset(vdev->emulated_config_bits + pdev->msi_cap, 0xff,
2602                vdev->msi_cap_size);
2603     }
2604 
2605     if (vfio_pci_read_config(&vdev->pdev, PCI_INTERRUPT_PIN, 1)) {
2606         vdev->intx.mmap_timer = timer_new_ms(QEMU_CLOCK_VIRTUAL,
2607                                                   vfio_intx_mmap_enable, vdev);
2608         pci_device_set_intx_routing_notifier(&vdev->pdev, vfio_intx_update);
2609         ret = vfio_intx_enable(vdev);
2610         if (ret) {
2611             goto out_teardown;
2612         }
2613     }
2614 
2615     vfio_register_err_notifier(vdev);
2616     vfio_register_req_notifier(vdev);
2617     vfio_setup_resetfn_quirk(vdev);
2618 
2619     return 0;
2620 
2621 out_teardown:
2622     pci_device_set_intx_routing_notifier(&vdev->pdev, NULL);
2623     vfio_teardown_msi(vdev);
2624     vfio_bars_exit(vdev);
2625     return ret;
2626 }
2627 
2628 static void vfio_instance_finalize(Object *obj)
2629 {
2630     PCIDevice *pci_dev = PCI_DEVICE(obj);
2631     VFIOPCIDevice *vdev = DO_UPCAST(VFIOPCIDevice, pdev, pci_dev);
2632     VFIOGroup *group = vdev->vbasedev.group;
2633 
2634     vfio_bars_finalize(vdev);
2635     g_free(vdev->emulated_config_bits);
2636     g_free(vdev->rom);
2637     /*
2638      * XXX Leaking igd_opregion is not an oversight, we can't remove the
2639      * fw_cfg entry therefore leaking this allocation seems like the safest
2640      * option.
2641      *
2642      * g_free(vdev->igd_opregion);
2643      */
2644     vfio_put_device(vdev);
2645     vfio_put_group(group);
2646 }
2647 
2648 static void vfio_exitfn(PCIDevice *pdev)
2649 {
2650     VFIOPCIDevice *vdev = DO_UPCAST(VFIOPCIDevice, pdev, pdev);
2651 
2652     vfio_unregister_req_notifier(vdev);
2653     vfio_unregister_err_notifier(vdev);
2654     pci_device_set_intx_routing_notifier(&vdev->pdev, NULL);
2655     vfio_disable_interrupts(vdev);
2656     if (vdev->intx.mmap_timer) {
2657         timer_free(vdev->intx.mmap_timer);
2658     }
2659     vfio_teardown_msi(vdev);
2660     vfio_bars_exit(vdev);
2661 }
2662 
2663 static void vfio_pci_reset(DeviceState *dev)
2664 {
2665     PCIDevice *pdev = DO_UPCAST(PCIDevice, qdev, dev);
2666     VFIOPCIDevice *vdev = DO_UPCAST(VFIOPCIDevice, pdev, pdev);
2667 
2668     trace_vfio_pci_reset(vdev->vbasedev.name);
2669 
2670     vfio_pci_pre_reset(vdev);
2671 
2672     if (vdev->resetfn && !vdev->resetfn(vdev)) {
2673         goto post_reset;
2674     }
2675 
2676     if (vdev->vbasedev.reset_works &&
2677         (vdev->has_flr || !vdev->has_pm_reset) &&
2678         !ioctl(vdev->vbasedev.fd, VFIO_DEVICE_RESET)) {
2679         trace_vfio_pci_reset_flr(vdev->vbasedev.name);
2680         goto post_reset;
2681     }
2682 
2683     /* See if we can do our own bus reset */
2684     if (!vfio_pci_hot_reset_one(vdev)) {
2685         goto post_reset;
2686     }
2687 
2688     /* If nothing else works and the device supports PM reset, use it */
2689     if (vdev->vbasedev.reset_works && vdev->has_pm_reset &&
2690         !ioctl(vdev->vbasedev.fd, VFIO_DEVICE_RESET)) {
2691         trace_vfio_pci_reset_pm(vdev->vbasedev.name);
2692         goto post_reset;
2693     }
2694 
2695 post_reset:
2696     vfio_pci_post_reset(vdev);
2697 }
2698 
2699 static void vfio_instance_init(Object *obj)
2700 {
2701     PCIDevice *pci_dev = PCI_DEVICE(obj);
2702     VFIOPCIDevice *vdev = DO_UPCAST(VFIOPCIDevice, pdev, PCI_DEVICE(obj));
2703 
2704     device_add_bootindex_property(obj, &vdev->bootindex,
2705                                   "bootindex", NULL,
2706                                   &pci_dev->qdev, NULL);
2707 }
2708 
2709 static Property vfio_pci_dev_properties[] = {
2710     DEFINE_PROP_PCI_HOST_DEVADDR("host", VFIOPCIDevice, host),
2711     DEFINE_PROP_STRING("sysfsdev", VFIOPCIDevice, vbasedev.sysfsdev),
2712     DEFINE_PROP_UINT32("x-intx-mmap-timeout-ms", VFIOPCIDevice,
2713                        intx.mmap_timeout, 1100),
2714     DEFINE_PROP_BIT("x-vga", VFIOPCIDevice, features,
2715                     VFIO_FEATURE_ENABLE_VGA_BIT, false),
2716     DEFINE_PROP_BIT("x-req", VFIOPCIDevice, features,
2717                     VFIO_FEATURE_ENABLE_REQ_BIT, true),
2718     DEFINE_PROP_BIT("x-igd-opregion", VFIOPCIDevice, features,
2719                     VFIO_FEATURE_ENABLE_IGD_OPREGION_BIT, false),
2720     DEFINE_PROP_BOOL("x-no-mmap", VFIOPCIDevice, vbasedev.no_mmap, false),
2721     DEFINE_PROP_BOOL("x-no-kvm-intx", VFIOPCIDevice, no_kvm_intx, false),
2722     DEFINE_PROP_BOOL("x-no-kvm-msi", VFIOPCIDevice, no_kvm_msi, false),
2723     DEFINE_PROP_BOOL("x-no-kvm-msix", VFIOPCIDevice, no_kvm_msix, false),
2724     DEFINE_PROP_UINT32("x-pci-vendor-id", VFIOPCIDevice, vendor_id, PCI_ANY_ID),
2725     DEFINE_PROP_UINT32("x-pci-device-id", VFIOPCIDevice, device_id, PCI_ANY_ID),
2726     DEFINE_PROP_UINT32("x-pci-sub-vendor-id", VFIOPCIDevice,
2727                        sub_vendor_id, PCI_ANY_ID),
2728     DEFINE_PROP_UINT32("x-pci-sub-device-id", VFIOPCIDevice,
2729                        sub_device_id, PCI_ANY_ID),
2730     DEFINE_PROP_UINT32("x-igd-gms", VFIOPCIDevice, igd_gms, 0),
2731     /*
2732      * TODO - support passed fds... is this necessary?
2733      * DEFINE_PROP_STRING("vfiofd", VFIOPCIDevice, vfiofd_name),
2734      * DEFINE_PROP_STRING("vfiogroupfd, VFIOPCIDevice, vfiogroupfd_name),
2735      */
2736     DEFINE_PROP_END_OF_LIST(),
2737 };
2738 
2739 static const VMStateDescription vfio_pci_vmstate = {
2740     .name = "vfio-pci",
2741     .unmigratable = 1,
2742 };
2743 
2744 static void vfio_pci_dev_class_init(ObjectClass *klass, void *data)
2745 {
2746     DeviceClass *dc = DEVICE_CLASS(klass);
2747     PCIDeviceClass *pdc = PCI_DEVICE_CLASS(klass);
2748 
2749     dc->reset = vfio_pci_reset;
2750     dc->props = vfio_pci_dev_properties;
2751     dc->vmsd = &vfio_pci_vmstate;
2752     dc->desc = "VFIO-based PCI device assignment";
2753     set_bit(DEVICE_CATEGORY_MISC, dc->categories);
2754     pdc->init = vfio_initfn;
2755     pdc->exit = vfio_exitfn;
2756     pdc->config_read = vfio_pci_read_config;
2757     pdc->config_write = vfio_pci_write_config;
2758     pdc->is_express = 1; /* We might be */
2759 }
2760 
2761 static const TypeInfo vfio_pci_dev_info = {
2762     .name = "vfio-pci",
2763     .parent = TYPE_PCI_DEVICE,
2764     .instance_size = sizeof(VFIOPCIDevice),
2765     .class_init = vfio_pci_dev_class_init,
2766     .instance_init = vfio_instance_init,
2767     .instance_finalize = vfio_instance_finalize,
2768 };
2769 
2770 static void register_vfio_pci_dev_type(void)
2771 {
2772     type_register_static(&vfio_pci_dev_info);
2773 }
2774 
2775 type_init(register_vfio_pci_dev_type)
2776