2 * Inter-VM Shared Memory PCI device.
7 * Based On: cirrus_vga.c
8 * Copyright (c) 2004 Fabrice Bellard
9 * Copyright (c) 2004 Makoto Suzuki (suzu)
12 * Copyright (c) 2006 Igor Kovalenko
14 * This code is licensed under the GNU GPL v2.
16 * Contributions after 2012-01-13 are licensed under the terms of the
17 * GNU GPL, version 2 or (at your option) any later version.
19 #include "qemu/osdep.h"
20 #include "qapi/error.h"
21 #include "qemu/cutils.h"
23 #include "hw/i386/pc.h"
24 #include "hw/pci/pci.h"
25 #include "hw/pci/msi.h"
26 #include "hw/pci/msix.h"
27 #include "sysemu/kvm.h"
28 #include "migration/migration.h"
29 #include "qemu/error-report.h"
30 #include "qemu/event_notifier.h"
31 #include "qom/object_interfaces.h"
32 #include "sysemu/char.h"
33 #include "sysemu/hostmem.h"
34 #include "sysemu/qtest.h"
35 #include "qapi/visitor.h"
37 #include "hw/misc/ivshmem.h"
39 #define PCI_VENDOR_ID_IVSHMEM PCI_VENDOR_ID_REDHAT_QUMRANET
40 #define PCI_DEVICE_ID_IVSHMEM 0x1110
42 #define IVSHMEM_MAX_PEERS UINT16_MAX
43 #define IVSHMEM_IOEVENTFD 0
46 #define IVSHMEM_REG_BAR_SIZE 0x100
48 #define IVSHMEM_DEBUG 0
49 #define IVSHMEM_DPRINTF(fmt, ...) \
51 if (IVSHMEM_DEBUG) { \
52 printf("IVSHMEM: " fmt, ## __VA_ARGS__); \
56 #define TYPE_IVSHMEM_COMMON "ivshmem-common"
57 #define IVSHMEM_COMMON(obj) \
58 OBJECT_CHECK(IVShmemState, (obj), TYPE_IVSHMEM_COMMON)
60 #define TYPE_IVSHMEM_PLAIN "ivshmem-plain"
61 #define IVSHMEM_PLAIN(obj) \
62 OBJECT_CHECK(IVShmemState, (obj), TYPE_IVSHMEM_PLAIN)
64 #define TYPE_IVSHMEM_DOORBELL "ivshmem-doorbell"
65 #define IVSHMEM_DOORBELL(obj) \
66 OBJECT_CHECK(IVShmemState, (obj), TYPE_IVSHMEM_DOORBELL)
68 #define TYPE_IVSHMEM "ivshmem"
69 #define IVSHMEM(obj) \
70 OBJECT_CHECK(IVShmemState, (obj), TYPE_IVSHMEM)
74 EventNotifier *eventfds;
77 typedef struct MSIVector {
82 typedef struct IVShmemState {
89 /* exactly one of these two may be set */
90 HostMemoryBackend *hostmem; /* with interrupts */
91 CharBackend server_chr; /* without interrupts */
99 MemoryRegion ivshmem_mmio; /* BAR 0 (registers) */
100 MemoryRegion *ivshmem_bar2; /* BAR 2 (shared memory) */
101 MemoryRegion server_bar2; /* used with server_chr */
103 /* interrupt support */
105 int nb_peers; /* space in @peers[] */
107 MSIVector *msi_vectors;
108 uint64_t msg_buf; /* buffer for receiving server messages */
109 int msg_buffered_bytes; /* #bytes in @msg_buf */
111 /* migration stuff */
113 Error *migration_blocker;
120 uint32_t not_legacy_32bit;
123 /* registers for the Inter-VM shared memory device */
124 enum ivshmem_registers {
131 static inline uint32_t ivshmem_has_feature(IVShmemState *ivs,
132 unsigned int feature) {
133 return (ivs->features & (1 << feature));
136 static inline bool ivshmem_is_master(IVShmemState *s)
138 assert(s->master != ON_OFF_AUTO_AUTO);
139 return s->master == ON_OFF_AUTO_ON;
142 static void ivshmem_update_irq(IVShmemState *s)
144 PCIDevice *d = PCI_DEVICE(s);
145 uint32_t isr = s->intrstatus & s->intrmask;
148 * Do nothing unless the device actually uses INTx. Here's how
149 * the device variants signal interrupts, what they put in PCI
151 * Device variant Interrupt Interrupt Pin MSI-X cap.
152 * ivshmem-plain none 0 no
153 * ivshmem-doorbell MSI-X 1 yes(1)
154 * ivshmem,msi=off INTx 1 no
155 * ivshmem,msi=on MSI-X 1(2) yes(1)
156 * (1) if guest enabled MSI-X
157 * (2) the device lies
158 * Leads to the condition for doing nothing:
160 if (ivshmem_has_feature(s, IVSHMEM_MSI)
161 || !d->config[PCI_INTERRUPT_PIN]) {
165 /* don't print ISR resets */
167 IVSHMEM_DPRINTF("Set IRQ to %d (%04x %04x)\n",
168 isr ? 1 : 0, s->intrstatus, s->intrmask);
171 pci_set_irq(d, isr != 0);
174 static void ivshmem_IntrMask_write(IVShmemState *s, uint32_t val)
176 IVSHMEM_DPRINTF("IntrMask write(w) val = 0x%04x\n", val);
179 ivshmem_update_irq(s);
182 static uint32_t ivshmem_IntrMask_read(IVShmemState *s)
184 uint32_t ret = s->intrmask;
186 IVSHMEM_DPRINTF("intrmask read(w) val = 0x%04x\n", ret);
190 static void ivshmem_IntrStatus_write(IVShmemState *s, uint32_t val)
192 IVSHMEM_DPRINTF("IntrStatus write(w) val = 0x%04x\n", val);
195 ivshmem_update_irq(s);
198 static uint32_t ivshmem_IntrStatus_read(IVShmemState *s)
200 uint32_t ret = s->intrstatus;
202 /* reading ISR clears all interrupts */
204 ivshmem_update_irq(s);
208 static void ivshmem_io_write(void *opaque, hwaddr addr,
209 uint64_t val, unsigned size)
211 IVShmemState *s = opaque;
213 uint16_t dest = val >> 16;
214 uint16_t vector = val & 0xff;
218 IVSHMEM_DPRINTF("writing to addr " TARGET_FMT_plx "\n", addr);
222 ivshmem_IntrMask_write(s, val);
226 ivshmem_IntrStatus_write(s, val);
230 /* check that dest VM ID is reasonable */
231 if (dest >= s->nb_peers) {
232 IVSHMEM_DPRINTF("Invalid destination VM ID (%d)\n", dest);
236 /* check doorbell range */
237 if (vector < s->peers[dest].nb_eventfds) {
238 IVSHMEM_DPRINTF("Notifying VM %d on vector %d\n", dest, vector);
239 event_notifier_set(&s->peers[dest].eventfds[vector]);
241 IVSHMEM_DPRINTF("Invalid destination vector %d on VM %d\n",
246 IVSHMEM_DPRINTF("Unhandled write " TARGET_FMT_plx "\n", addr);
250 static uint64_t ivshmem_io_read(void *opaque, hwaddr addr,
254 IVShmemState *s = opaque;
260 ret = ivshmem_IntrMask_read(s);
264 ret = ivshmem_IntrStatus_read(s);
272 IVSHMEM_DPRINTF("why are we reading " TARGET_FMT_plx "\n", addr);
279 static const MemoryRegionOps ivshmem_mmio_ops = {
280 .read = ivshmem_io_read,
281 .write = ivshmem_io_write,
282 .endianness = DEVICE_NATIVE_ENDIAN,
284 .min_access_size = 4,
285 .max_access_size = 4,
289 static void ivshmem_vector_notify(void *opaque)
291 MSIVector *entry = opaque;
292 PCIDevice *pdev = entry->pdev;
293 IVShmemState *s = IVSHMEM_COMMON(pdev);
294 int vector = entry - s->msi_vectors;
295 EventNotifier *n = &s->peers[s->vm_id].eventfds[vector];
297 if (!event_notifier_test_and_clear(n)) {
301 IVSHMEM_DPRINTF("interrupt on vector %p %d\n", pdev, vector);
302 if (ivshmem_has_feature(s, IVSHMEM_MSI)) {
303 if (msix_enabled(pdev)) {
304 msix_notify(pdev, vector);
307 ivshmem_IntrStatus_write(s, 1);
311 static int ivshmem_vector_unmask(PCIDevice *dev, unsigned vector,
314 IVShmemState *s = IVSHMEM_COMMON(dev);
315 EventNotifier *n = &s->peers[s->vm_id].eventfds[vector];
316 MSIVector *v = &s->msi_vectors[vector];
319 IVSHMEM_DPRINTF("vector unmask %p %d\n", dev, vector);
321 ret = kvm_irqchip_update_msi_route(kvm_state, v->virq, msg, dev);
325 kvm_irqchip_commit_routes(kvm_state);
327 return kvm_irqchip_add_irqfd_notifier_gsi(kvm_state, n, NULL, v->virq);
330 static void ivshmem_vector_mask(PCIDevice *dev, unsigned vector)
332 IVShmemState *s = IVSHMEM_COMMON(dev);
333 EventNotifier *n = &s->peers[s->vm_id].eventfds[vector];
336 IVSHMEM_DPRINTF("vector mask %p %d\n", dev, vector);
338 ret = kvm_irqchip_remove_irqfd_notifier_gsi(kvm_state, n,
339 s->msi_vectors[vector].virq);
341 error_report("remove_irqfd_notifier_gsi failed");
345 static void ivshmem_vector_poll(PCIDevice *dev,
346 unsigned int vector_start,
347 unsigned int vector_end)
349 IVShmemState *s = IVSHMEM_COMMON(dev);
352 IVSHMEM_DPRINTF("vector poll %p %d-%d\n", dev, vector_start, vector_end);
354 vector_end = MIN(vector_end, s->vectors);
356 for (vector = vector_start; vector < vector_end; vector++) {
357 EventNotifier *notifier = &s->peers[s->vm_id].eventfds[vector];
359 if (!msix_is_masked(dev, vector)) {
363 if (event_notifier_test_and_clear(notifier)) {
364 msix_set_pending(dev, vector);
369 static void watch_vector_notifier(IVShmemState *s, EventNotifier *n,
372 int eventfd = event_notifier_get_fd(n);
374 assert(!s->msi_vectors[vector].pdev);
375 s->msi_vectors[vector].pdev = PCI_DEVICE(s);
377 qemu_set_fd_handler(eventfd, ivshmem_vector_notify,
378 NULL, &s->msi_vectors[vector]);
381 static void ivshmem_add_eventfd(IVShmemState *s, int posn, int i)
383 memory_region_add_eventfd(&s->ivshmem_mmio,
388 &s->peers[posn].eventfds[i]);
391 static void ivshmem_del_eventfd(IVShmemState *s, int posn, int i)
393 memory_region_del_eventfd(&s->ivshmem_mmio,
398 &s->peers[posn].eventfds[i]);
401 static void close_peer_eventfds(IVShmemState *s, int posn)
405 assert(posn >= 0 && posn < s->nb_peers);
406 n = s->peers[posn].nb_eventfds;
408 if (ivshmem_has_feature(s, IVSHMEM_IOEVENTFD)) {
409 memory_region_transaction_begin();
410 for (i = 0; i < n; i++) {
411 ivshmem_del_eventfd(s, posn, i);
413 memory_region_transaction_commit();
416 for (i = 0; i < n; i++) {
417 event_notifier_cleanup(&s->peers[posn].eventfds[i]);
420 g_free(s->peers[posn].eventfds);
421 s->peers[posn].nb_eventfds = 0;
424 static void resize_peers(IVShmemState *s, int nb_peers)
426 int old_nb_peers = s->nb_peers;
429 assert(nb_peers > old_nb_peers);
430 IVSHMEM_DPRINTF("bumping storage to %d peers\n", nb_peers);
432 s->peers = g_realloc(s->peers, nb_peers * sizeof(Peer));
433 s->nb_peers = nb_peers;
435 for (i = old_nb_peers; i < nb_peers; i++) {
436 s->peers[i].eventfds = g_new0(EventNotifier, s->vectors);
437 s->peers[i].nb_eventfds = 0;
441 static void ivshmem_add_kvm_msi_virq(IVShmemState *s, int vector,
444 PCIDevice *pdev = PCI_DEVICE(s);
447 IVSHMEM_DPRINTF("ivshmem_add_kvm_msi_virq vector:%d\n", vector);
448 assert(!s->msi_vectors[vector].pdev);
450 ret = kvm_irqchip_add_msi_route(kvm_state, vector, pdev);
452 error_setg(errp, "kvm_irqchip_add_msi_route failed");
456 s->msi_vectors[vector].virq = ret;
457 s->msi_vectors[vector].pdev = pdev;
460 static void setup_interrupt(IVShmemState *s, int vector, Error **errp)
462 EventNotifier *n = &s->peers[s->vm_id].eventfds[vector];
463 bool with_irqfd = kvm_msi_via_irqfd_enabled() &&
464 ivshmem_has_feature(s, IVSHMEM_MSI);
465 PCIDevice *pdev = PCI_DEVICE(s);
468 IVSHMEM_DPRINTF("setting up interrupt for vector: %d\n", vector);
471 IVSHMEM_DPRINTF("with eventfd\n");
472 watch_vector_notifier(s, n, vector);
473 } else if (msix_enabled(pdev)) {
474 IVSHMEM_DPRINTF("with irqfd\n");
475 ivshmem_add_kvm_msi_virq(s, vector, &err);
477 error_propagate(errp, err);
481 if (!msix_is_masked(pdev, vector)) {
482 kvm_irqchip_add_irqfd_notifier_gsi(kvm_state, n, NULL,
483 s->msi_vectors[vector].virq);
484 /* TODO handle error */
487 /* it will be delayed until msix is enabled, in write_config */
488 IVSHMEM_DPRINTF("with irqfd, delayed until msix enabled\n");
492 static void process_msg_shmem(IVShmemState *s, int fd, Error **errp)
498 if (s->ivshmem_bar2) {
499 error_setg(errp, "server sent unexpected shared memory message");
504 if (fstat(fd, &buf) < 0) {
505 error_setg_errno(errp, errno,
506 "can't determine size of shared memory sent by server");
514 if (s->legacy_size != SIZE_MAX) {
515 if (size < s->legacy_size) {
516 error_setg(errp, "server sent only %zd bytes of shared memory",
517 (size_t)buf.st_size);
521 size = s->legacy_size;
524 /* mmap the region and map into the BAR2 */
525 ptr = mmap(0, size, PROT_READ | PROT_WRITE, MAP_SHARED, fd, 0);
526 if (ptr == MAP_FAILED) {
527 error_setg_errno(errp, errno, "Failed to mmap shared memory");
531 memory_region_init_ram_ptr(&s->server_bar2, OBJECT(s),
532 "ivshmem.bar2", size, ptr);
533 memory_region_set_fd(&s->server_bar2, fd);
534 s->ivshmem_bar2 = &s->server_bar2;
537 static void process_msg_disconnect(IVShmemState *s, uint16_t posn,
540 IVSHMEM_DPRINTF("posn %d has gone away\n", posn);
541 if (posn >= s->nb_peers || posn == s->vm_id) {
542 error_setg(errp, "invalid peer %d", posn);
545 close_peer_eventfds(s, posn);
548 static void process_msg_connect(IVShmemState *s, uint16_t posn, int fd,
551 Peer *peer = &s->peers[posn];
555 * The N-th connect message for this peer comes with the file
556 * descriptor for vector N-1. Count messages to find the vector.
558 if (peer->nb_eventfds >= s->vectors) {
559 error_setg(errp, "Too many eventfd received, device has %d vectors",
564 vector = peer->nb_eventfds++;
566 IVSHMEM_DPRINTF("eventfds[%d][%d] = %d\n", posn, vector, fd);
567 event_notifier_init_fd(&peer->eventfds[vector], fd);
568 fcntl_setfl(fd, O_NONBLOCK); /* msix/irqfd poll non block */
570 if (posn == s->vm_id) {
571 setup_interrupt(s, vector, errp);
572 /* TODO do we need to handle the error? */
575 if (ivshmem_has_feature(s, IVSHMEM_IOEVENTFD)) {
576 ivshmem_add_eventfd(s, posn, vector);
580 static void process_msg(IVShmemState *s, int64_t msg, int fd, Error **errp)
582 IVSHMEM_DPRINTF("posn is %" PRId64 ", fd is %d\n", msg, fd);
584 if (msg < -1 || msg > IVSHMEM_MAX_PEERS) {
585 error_setg(errp, "server sent invalid message %" PRId64, msg);
591 process_msg_shmem(s, fd, errp);
595 if (msg >= s->nb_peers) {
596 resize_peers(s, msg + 1);
600 process_msg_connect(s, msg, fd, errp);
602 process_msg_disconnect(s, msg, errp);
606 static int ivshmem_can_receive(void *opaque)
608 IVShmemState *s = opaque;
610 assert(s->msg_buffered_bytes < sizeof(s->msg_buf));
611 return sizeof(s->msg_buf) - s->msg_buffered_bytes;
614 static void ivshmem_read(void *opaque, const uint8_t *buf, int size)
616 IVShmemState *s = opaque;
621 assert(size >= 0 && s->msg_buffered_bytes + size <= sizeof(s->msg_buf));
622 memcpy((unsigned char *)&s->msg_buf + s->msg_buffered_bytes, buf, size);
623 s->msg_buffered_bytes += size;
624 if (s->msg_buffered_bytes < sizeof(s->msg_buf)) {
627 msg = le64_to_cpu(s->msg_buf);
628 s->msg_buffered_bytes = 0;
630 fd = qemu_chr_fe_get_msgfd(&s->server_chr);
632 process_msg(s, msg, fd, &err);
634 error_report_err(err);
638 static int64_t ivshmem_recv_msg(IVShmemState *s, int *pfd, Error **errp)
645 ret = qemu_chr_fe_read_all(&s->server_chr, (uint8_t *)&msg + n,
647 if (ret < 0 && ret != -EINTR) {
648 error_setg_errno(errp, -ret, "read from server failed");
652 } while (n < sizeof(msg));
654 *pfd = qemu_chr_fe_get_msgfd(&s->server_chr);
658 static void ivshmem_recv_setup(IVShmemState *s, Error **errp)
664 msg = ivshmem_recv_msg(s, &fd, &err);
666 error_propagate(errp, err);
669 if (msg != IVSHMEM_PROTOCOL_VERSION) {
670 error_setg(errp, "server sent version %" PRId64 ", expecting %d",
671 msg, IVSHMEM_PROTOCOL_VERSION);
675 error_setg(errp, "server sent invalid version message");
680 * ivshmem-server sends the remaining initial messages in a fixed
681 * order, but the device has always accepted them in any order.
682 * Stay as compatible as practical, just in case people use
683 * servers that behave differently.
687 * ivshmem_device_spec.txt has always required the ID message
688 * right here, and ivshmem-server has always complied. However,
689 * older versions of the device accepted it out of order, but
690 * broke when an interrupt setup message arrived before it.
692 msg = ivshmem_recv_msg(s, &fd, &err);
694 error_propagate(errp, err);
697 if (fd != -1 || msg < 0 || msg > IVSHMEM_MAX_PEERS) {
698 error_setg(errp, "server sent invalid ID message");
704 * Receive more messages until we got shared memory.
707 msg = ivshmem_recv_msg(s, &fd, &err);
709 error_propagate(errp, err);
712 process_msg(s, msg, fd, &err);
714 error_propagate(errp, err);
720 * This function must either map the shared memory or fail. The
721 * loop above ensures that: it terminates normally only after it
722 * successfully processed the server's shared memory message.
723 * Assert that actually mapped the shared memory:
725 assert(s->ivshmem_bar2);
728 /* Select the MSI-X vectors used by device.
729 * ivshmem maps events to vectors statically, so
730 * we just enable all vectors on init and after reset. */
731 static void ivshmem_msix_vector_use(IVShmemState *s)
733 PCIDevice *d = PCI_DEVICE(s);
736 for (i = 0; i < s->vectors; i++) {
737 msix_vector_use(d, i);
741 static void ivshmem_reset(DeviceState *d)
743 IVShmemState *s = IVSHMEM_COMMON(d);
747 if (ivshmem_has_feature(s, IVSHMEM_MSI)) {
748 ivshmem_msix_vector_use(s);
752 static int ivshmem_setup_interrupts(IVShmemState *s)
754 /* allocate QEMU callback data for receiving interrupts */
755 s->msi_vectors = g_malloc0(s->vectors * sizeof(MSIVector));
757 if (ivshmem_has_feature(s, IVSHMEM_MSI)) {
758 if (msix_init_exclusive_bar(PCI_DEVICE(s), s->vectors, 1)) {
762 IVSHMEM_DPRINTF("msix initialized (%d vectors)\n", s->vectors);
763 ivshmem_msix_vector_use(s);
769 static void ivshmem_enable_irqfd(IVShmemState *s)
771 PCIDevice *pdev = PCI_DEVICE(s);
774 for (i = 0; i < s->peers[s->vm_id].nb_eventfds; i++) {
777 ivshmem_add_kvm_msi_virq(s, i, &err);
779 error_report_err(err);
780 /* TODO do we need to handle the error? */
784 if (msix_set_vector_notifiers(pdev,
785 ivshmem_vector_unmask,
787 ivshmem_vector_poll)) {
788 error_report("ivshmem: msix_set_vector_notifiers failed");
792 static void ivshmem_remove_kvm_msi_virq(IVShmemState *s, int vector)
794 IVSHMEM_DPRINTF("ivshmem_remove_kvm_msi_virq vector:%d\n", vector);
796 if (s->msi_vectors[vector].pdev == NULL) {
800 /* it was cleaned when masked in the frontend. */
801 kvm_irqchip_release_virq(kvm_state, s->msi_vectors[vector].virq);
803 s->msi_vectors[vector].pdev = NULL;
806 static void ivshmem_disable_irqfd(IVShmemState *s)
808 PCIDevice *pdev = PCI_DEVICE(s);
811 for (i = 0; i < s->peers[s->vm_id].nb_eventfds; i++) {
812 ivshmem_remove_kvm_msi_virq(s, i);
815 msix_unset_vector_notifiers(pdev);
818 static void ivshmem_write_config(PCIDevice *pdev, uint32_t address,
819 uint32_t val, int len)
821 IVShmemState *s = IVSHMEM_COMMON(pdev);
822 int is_enabled, was_enabled = msix_enabled(pdev);
824 pci_default_write_config(pdev, address, val, len);
825 is_enabled = msix_enabled(pdev);
827 if (kvm_msi_via_irqfd_enabled()) {
828 if (!was_enabled && is_enabled) {
829 ivshmem_enable_irqfd(s);
830 } else if (was_enabled && !is_enabled) {
831 ivshmem_disable_irqfd(s);
836 static void ivshmem_common_realize(PCIDevice *dev, Error **errp)
838 IVShmemState *s = IVSHMEM_COMMON(dev);
841 uint8_t attr = PCI_BASE_ADDRESS_SPACE_MEMORY |
842 PCI_BASE_ADDRESS_MEM_PREFETCH;
844 /* IRQFD requires MSI */
845 if (ivshmem_has_feature(s, IVSHMEM_IOEVENTFD) &&
846 !ivshmem_has_feature(s, IVSHMEM_MSI)) {
847 error_setg(errp, "ioeventfd/irqfd requires MSI");
851 pci_conf = dev->config;
852 pci_conf[PCI_COMMAND] = PCI_COMMAND_IO | PCI_COMMAND_MEMORY;
854 memory_region_init_io(&s->ivshmem_mmio, OBJECT(s), &ivshmem_mmio_ops, s,
855 "ivshmem-mmio", IVSHMEM_REG_BAR_SIZE);
857 /* region for registers*/
858 pci_register_bar(dev, 0, PCI_BASE_ADDRESS_SPACE_MEMORY,
861 if (s->not_legacy_32bit) {
862 attr |= PCI_BASE_ADDRESS_MEM_TYPE_64;
865 if (s->hostmem != NULL) {
866 IVSHMEM_DPRINTF("using hostmem\n");
868 s->ivshmem_bar2 = host_memory_backend_get_memory(s->hostmem,
871 CharDriverState *chr = qemu_chr_fe_get_driver(&s->server_chr);
874 IVSHMEM_DPRINTF("using shared memory server (socket = %s)\n",
877 /* we allocate enough space for 16 peers and grow as needed */
881 * Receive setup messages from server synchronously.
882 * Older versions did it asynchronously, but that creates a
883 * number of entertaining race conditions.
885 ivshmem_recv_setup(s, &err);
887 error_propagate(errp, err);
891 if (s->master == ON_OFF_AUTO_ON && s->vm_id != 0) {
893 "master must connect to the server before any peers");
897 qemu_chr_fe_set_handlers(&s->server_chr, ivshmem_can_receive,
898 ivshmem_read, NULL, s, NULL, true);
900 if (ivshmem_setup_interrupts(s) < 0) {
901 error_setg(errp, "failed to initialize interrupts");
906 vmstate_register_ram(s->ivshmem_bar2, DEVICE(s));
907 pci_register_bar(PCI_DEVICE(s), 2, attr, s->ivshmem_bar2);
909 if (s->master == ON_OFF_AUTO_AUTO) {
910 s->master = s->vm_id == 0 ? ON_OFF_AUTO_ON : ON_OFF_AUTO_OFF;
913 if (!ivshmem_is_master(s)) {
914 error_setg(&s->migration_blocker,
915 "Migration is disabled when using feature 'peer mode' in device 'ivshmem'");
916 migrate_add_blocker(s->migration_blocker);
920 static void ivshmem_exit(PCIDevice *dev)
922 IVShmemState *s = IVSHMEM_COMMON(dev);
925 if (s->migration_blocker) {
926 migrate_del_blocker(s->migration_blocker);
927 error_free(s->migration_blocker);
930 if (memory_region_is_mapped(s->ivshmem_bar2)) {
932 void *addr = memory_region_get_ram_ptr(s->ivshmem_bar2);
935 if (munmap(addr, memory_region_size(s->ivshmem_bar2) == -1)) {
936 error_report("Failed to munmap shared memory %s",
940 fd = memory_region_get_fd(s->ivshmem_bar2);
944 vmstate_unregister_ram(s->ivshmem_bar2, DEVICE(dev));
948 for (i = 0; i < s->nb_peers; i++) {
949 close_peer_eventfds(s, i);
954 if (ivshmem_has_feature(s, IVSHMEM_MSI)) {
955 msix_uninit_exclusive_bar(dev);
958 g_free(s->msi_vectors);
961 static int ivshmem_pre_load(void *opaque)
963 IVShmemState *s = opaque;
965 if (!ivshmem_is_master(s)) {
966 error_report("'peer' devices are not migratable");
973 static int ivshmem_post_load(void *opaque, int version_id)
975 IVShmemState *s = opaque;
977 if (ivshmem_has_feature(s, IVSHMEM_MSI)) {
978 ivshmem_msix_vector_use(s);
983 static void ivshmem_common_class_init(ObjectClass *klass, void *data)
985 DeviceClass *dc = DEVICE_CLASS(klass);
986 PCIDeviceClass *k = PCI_DEVICE_CLASS(klass);
988 k->realize = ivshmem_common_realize;
989 k->exit = ivshmem_exit;
990 k->config_write = ivshmem_write_config;
991 k->vendor_id = PCI_VENDOR_ID_IVSHMEM;
992 k->device_id = PCI_DEVICE_ID_IVSHMEM;
993 k->class_id = PCI_CLASS_MEMORY_RAM;
995 dc->reset = ivshmem_reset;
996 set_bit(DEVICE_CATEGORY_MISC, dc->categories);
997 dc->desc = "Inter-VM shared memory";
1000 static const TypeInfo ivshmem_common_info = {
1001 .name = TYPE_IVSHMEM_COMMON,
1002 .parent = TYPE_PCI_DEVICE,
1003 .instance_size = sizeof(IVShmemState),
1005 .class_init = ivshmem_common_class_init,
1008 static void ivshmem_check_memdev_is_busy(Object *obj, const char *name,
1009 Object *val, Error **errp)
1011 if (host_memory_backend_is_mapped(MEMORY_BACKEND(val))) {
1012 char *path = object_get_canonical_path_component(val);
1013 error_setg(errp, "can't use already busy memdev: %s", path);
1016 qdev_prop_allow_set_link_before_realize(obj, name, val, errp);
1020 static const VMStateDescription ivshmem_plain_vmsd = {
1021 .name = TYPE_IVSHMEM_PLAIN,
1023 .minimum_version_id = 0,
1024 .pre_load = ivshmem_pre_load,
1025 .post_load = ivshmem_post_load,
1026 .fields = (VMStateField[]) {
1027 VMSTATE_PCI_DEVICE(parent_obj, IVShmemState),
1028 VMSTATE_UINT32(intrstatus, IVShmemState),
1029 VMSTATE_UINT32(intrmask, IVShmemState),
1030 VMSTATE_END_OF_LIST()
1034 static Property ivshmem_plain_properties[] = {
1035 DEFINE_PROP_ON_OFF_AUTO("master", IVShmemState, master, ON_OFF_AUTO_OFF),
1036 DEFINE_PROP_END_OF_LIST(),
1039 static void ivshmem_plain_init(Object *obj)
1041 IVShmemState *s = IVSHMEM_PLAIN(obj);
1043 object_property_add_link(obj, "memdev", TYPE_MEMORY_BACKEND,
1044 (Object **)&s->hostmem,
1045 ivshmem_check_memdev_is_busy,
1046 OBJ_PROP_LINK_UNREF_ON_RELEASE,
1048 s->not_legacy_32bit = 1;
1051 static void ivshmem_plain_realize(PCIDevice *dev, Error **errp)
1053 IVShmemState *s = IVSHMEM_COMMON(dev);
1056 error_setg(errp, "You must specify a 'memdev'");
1060 ivshmem_common_realize(dev, errp);
1061 host_memory_backend_set_mapped(s->hostmem, true);
1064 static void ivshmem_plain_exit(PCIDevice *pci_dev)
1066 IVShmemState *s = IVSHMEM_COMMON(pci_dev);
1068 host_memory_backend_set_mapped(s->hostmem, false);
1071 static void ivshmem_plain_class_init(ObjectClass *klass, void *data)
1073 DeviceClass *dc = DEVICE_CLASS(klass);
1074 PCIDeviceClass *k = PCI_DEVICE_CLASS(klass);
1076 k->realize = ivshmem_plain_realize;
1077 k->exit = ivshmem_plain_exit;
1078 dc->props = ivshmem_plain_properties;
1079 dc->vmsd = &ivshmem_plain_vmsd;
1082 static const TypeInfo ivshmem_plain_info = {
1083 .name = TYPE_IVSHMEM_PLAIN,
1084 .parent = TYPE_IVSHMEM_COMMON,
1085 .instance_size = sizeof(IVShmemState),
1086 .instance_init = ivshmem_plain_init,
1087 .class_init = ivshmem_plain_class_init,
1090 static const VMStateDescription ivshmem_doorbell_vmsd = {
1091 .name = TYPE_IVSHMEM_DOORBELL,
1093 .minimum_version_id = 0,
1094 .pre_load = ivshmem_pre_load,
1095 .post_load = ivshmem_post_load,
1096 .fields = (VMStateField[]) {
1097 VMSTATE_PCI_DEVICE(parent_obj, IVShmemState),
1098 VMSTATE_MSIX(parent_obj, IVShmemState),
1099 VMSTATE_UINT32(intrstatus, IVShmemState),
1100 VMSTATE_UINT32(intrmask, IVShmemState),
1101 VMSTATE_END_OF_LIST()
1105 static Property ivshmem_doorbell_properties[] = {
1106 DEFINE_PROP_CHR("chardev", IVShmemState, server_chr),
1107 DEFINE_PROP_UINT32("vectors", IVShmemState, vectors, 1),
1108 DEFINE_PROP_BIT("ioeventfd", IVShmemState, features, IVSHMEM_IOEVENTFD,
1110 DEFINE_PROP_ON_OFF_AUTO("master", IVShmemState, master, ON_OFF_AUTO_OFF),
1111 DEFINE_PROP_END_OF_LIST(),
1114 static void ivshmem_doorbell_init(Object *obj)
1116 IVShmemState *s = IVSHMEM_DOORBELL(obj);
1118 s->features |= (1 << IVSHMEM_MSI);
1119 s->legacy_size = SIZE_MAX; /* whatever the server sends */
1120 s->not_legacy_32bit = 1;
1123 static void ivshmem_doorbell_realize(PCIDevice *dev, Error **errp)
1125 IVShmemState *s = IVSHMEM_COMMON(dev);
1127 if (!qemu_chr_fe_get_driver(&s->server_chr)) {
1128 error_setg(errp, "You must specify a 'chardev'");
1132 ivshmem_common_realize(dev, errp);
1135 static void ivshmem_doorbell_class_init(ObjectClass *klass, void *data)
1137 DeviceClass *dc = DEVICE_CLASS(klass);
1138 PCIDeviceClass *k = PCI_DEVICE_CLASS(klass);
1140 k->realize = ivshmem_doorbell_realize;
1141 dc->props = ivshmem_doorbell_properties;
1142 dc->vmsd = &ivshmem_doorbell_vmsd;
1145 static const TypeInfo ivshmem_doorbell_info = {
1146 .name = TYPE_IVSHMEM_DOORBELL,
1147 .parent = TYPE_IVSHMEM_COMMON,
1148 .instance_size = sizeof(IVShmemState),
1149 .instance_init = ivshmem_doorbell_init,
1150 .class_init = ivshmem_doorbell_class_init,
1153 static int ivshmem_load_old(QEMUFile *f, void *opaque, int version_id)
1155 IVShmemState *s = opaque;
1156 PCIDevice *pdev = PCI_DEVICE(s);
1159 IVSHMEM_DPRINTF("ivshmem_load_old\n");
1161 if (version_id != 0) {
1165 ret = ivshmem_pre_load(s);
1170 ret = pci_device_load(pdev, f);
1175 if (ivshmem_has_feature(s, IVSHMEM_MSI)) {
1177 ivshmem_msix_vector_use(s);
1179 s->intrstatus = qemu_get_be32(f);
1180 s->intrmask = qemu_get_be32(f);
1186 static bool test_msix(void *opaque, int version_id)
1188 IVShmemState *s = opaque;
1190 return ivshmem_has_feature(s, IVSHMEM_MSI);
1193 static bool test_no_msix(void *opaque, int version_id)
1195 return !test_msix(opaque, version_id);
1198 static const VMStateDescription ivshmem_vmsd = {
1201 .minimum_version_id = 1,
1202 .pre_load = ivshmem_pre_load,
1203 .post_load = ivshmem_post_load,
1204 .fields = (VMStateField[]) {
1205 VMSTATE_PCI_DEVICE(parent_obj, IVShmemState),
1207 VMSTATE_MSIX_TEST(parent_obj, IVShmemState, test_msix),
1208 VMSTATE_UINT32_TEST(intrstatus, IVShmemState, test_no_msix),
1209 VMSTATE_UINT32_TEST(intrmask, IVShmemState, test_no_msix),
1211 VMSTATE_END_OF_LIST()
1213 .load_state_old = ivshmem_load_old,
1214 .minimum_version_id_old = 0
1217 static Property ivshmem_properties[] = {
1218 DEFINE_PROP_CHR("chardev", IVShmemState, server_chr),
1219 DEFINE_PROP_STRING("size", IVShmemState, sizearg),
1220 DEFINE_PROP_UINT32("vectors", IVShmemState, vectors, 1),
1221 DEFINE_PROP_BIT("ioeventfd", IVShmemState, features, IVSHMEM_IOEVENTFD,
1223 DEFINE_PROP_BIT("msi", IVShmemState, features, IVSHMEM_MSI, true),
1224 DEFINE_PROP_STRING("shm", IVShmemState, shmobj),
1225 DEFINE_PROP_STRING("role", IVShmemState, role),
1226 DEFINE_PROP_UINT32("use64", IVShmemState, not_legacy_32bit, 1),
1227 DEFINE_PROP_END_OF_LIST(),
1230 static void desugar_shm(IVShmemState *s)
1235 obj = object_new("memory-backend-file");
1236 path = g_strdup_printf("/dev/shm/%s", s->shmobj);
1237 object_property_set_str(obj, path, "mem-path", &error_abort);
1239 object_property_set_int(obj, s->legacy_size, "size", &error_abort);
1240 object_property_set_bool(obj, true, "share", &error_abort);
1241 object_property_add_child(OBJECT(s), "internal-shm-backend", obj,
1243 user_creatable_complete(obj, &error_abort);
1244 s->hostmem = MEMORY_BACKEND(obj);
1247 static void ivshmem_realize(PCIDevice *dev, Error **errp)
1249 IVShmemState *s = IVSHMEM_COMMON(dev);
1251 if (!qtest_enabled()) {
1252 error_report("ivshmem is deprecated, please use ivshmem-plain"
1253 " or ivshmem-doorbell instead");
1256 if (!!qemu_chr_fe_get_driver(&s->server_chr) + !!s->shmobj != 1) {
1257 error_setg(errp, "You must specify either 'shm' or 'chardev'");
1261 if (s->sizearg == NULL) {
1262 s->legacy_size = 4 << 20; /* 4 MB default */
1265 int64_t size = qemu_strtosz(s->sizearg, &end);
1266 if (size < 0 || (size_t)size != size || *end != '\0'
1267 || !is_power_of_2(size)) {
1268 error_setg(errp, "Invalid size %s", s->sizearg);
1271 s->legacy_size = size;
1274 /* check that role is reasonable */
1276 if (strncmp(s->role, "peer", 5) == 0) {
1277 s->master = ON_OFF_AUTO_OFF;
1278 } else if (strncmp(s->role, "master", 7) == 0) {
1279 s->master = ON_OFF_AUTO_ON;
1281 error_setg(errp, "'role' must be 'peer' or 'master'");
1285 s->master = ON_OFF_AUTO_AUTO;
1293 * Note: we don't use INTx with IVSHMEM_MSI at all, so this is a
1294 * bald-faced lie then. But it's a backwards compatible lie.
1296 pci_config_set_interrupt_pin(dev->config, 1);
1298 ivshmem_common_realize(dev, errp);
1301 static void ivshmem_class_init(ObjectClass *klass, void *data)
1303 DeviceClass *dc = DEVICE_CLASS(klass);
1304 PCIDeviceClass *k = PCI_DEVICE_CLASS(klass);
1306 k->realize = ivshmem_realize;
1308 dc->desc = "Inter-VM shared memory (legacy)";
1309 dc->props = ivshmem_properties;
1310 dc->vmsd = &ivshmem_vmsd;
1313 static const TypeInfo ivshmem_info = {
1314 .name = TYPE_IVSHMEM,
1315 .parent = TYPE_IVSHMEM_COMMON,
1316 .instance_size = sizeof(IVShmemState),
1317 .class_init = ivshmem_class_init,
1320 static void ivshmem_register_types(void)
1322 type_register_static(&ivshmem_common_info);
1323 type_register_static(&ivshmem_plain_info);
1324 type_register_static(&ivshmem_doorbell_info);
1325 type_register_static(&ivshmem_info);
1328 type_init(ivshmem_register_types)