2 * Inter-VM Shared Memory PCI device.
5 * Cam Macdonell <cam@cs.ualberta.ca>
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/blocker.h"
29 #include "qemu/error-report.h"
30 #include "qemu/event_notifier.h"
31 #include "qom/object_interfaces.h"
32 #include "chardev/char-fe.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
)
494 Error
*local_err
= NULL
;
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 memory_region_init_ram_from_fd(&s
->server_bar2
, OBJECT(s
),
526 "ivshmem.bar2", size
, true, fd
, &local_err
);
528 error_propagate(errp
, local_err
);
532 s
->ivshmem_bar2
= &s
->server_bar2
;
535 static void process_msg_disconnect(IVShmemState
*s
, uint16_t posn
,
538 IVSHMEM_DPRINTF("posn %d has gone away\n", posn
);
539 if (posn
>= s
->nb_peers
|| posn
== s
->vm_id
) {
540 error_setg(errp
, "invalid peer %d", posn
);
543 close_peer_eventfds(s
, posn
);
546 static void process_msg_connect(IVShmemState
*s
, uint16_t posn
, int fd
,
549 Peer
*peer
= &s
->peers
[posn
];
553 * The N-th connect message for this peer comes with the file
554 * descriptor for vector N-1. Count messages to find the vector.
556 if (peer
->nb_eventfds
>= s
->vectors
) {
557 error_setg(errp
, "Too many eventfd received, device has %d vectors",
562 vector
= peer
->nb_eventfds
++;
564 IVSHMEM_DPRINTF("eventfds[%d][%d] = %d\n", posn
, vector
, fd
);
565 event_notifier_init_fd(&peer
->eventfds
[vector
], fd
);
566 fcntl_setfl(fd
, O_NONBLOCK
); /* msix/irqfd poll non block */
568 if (posn
== s
->vm_id
) {
569 setup_interrupt(s
, vector
, errp
);
570 /* TODO do we need to handle the error? */
573 if (ivshmem_has_feature(s
, IVSHMEM_IOEVENTFD
)) {
574 ivshmem_add_eventfd(s
, posn
, vector
);
578 static void process_msg(IVShmemState
*s
, int64_t msg
, int fd
, Error
**errp
)
580 IVSHMEM_DPRINTF("posn is %" PRId64
", fd is %d\n", msg
, fd
);
582 if (msg
< -1 || msg
> IVSHMEM_MAX_PEERS
) {
583 error_setg(errp
, "server sent invalid message %" PRId64
, msg
);
589 process_msg_shmem(s
, fd
, errp
);
593 if (msg
>= s
->nb_peers
) {
594 resize_peers(s
, msg
+ 1);
598 process_msg_connect(s
, msg
, fd
, errp
);
600 process_msg_disconnect(s
, msg
, errp
);
604 static int ivshmem_can_receive(void *opaque
)
606 IVShmemState
*s
= opaque
;
608 assert(s
->msg_buffered_bytes
< sizeof(s
->msg_buf
));
609 return sizeof(s
->msg_buf
) - s
->msg_buffered_bytes
;
612 static void ivshmem_read(void *opaque
, const uint8_t *buf
, int size
)
614 IVShmemState
*s
= opaque
;
619 assert(size
>= 0 && s
->msg_buffered_bytes
+ size
<= sizeof(s
->msg_buf
));
620 memcpy((unsigned char *)&s
->msg_buf
+ s
->msg_buffered_bytes
, buf
, size
);
621 s
->msg_buffered_bytes
+= size
;
622 if (s
->msg_buffered_bytes
< sizeof(s
->msg_buf
)) {
625 msg
= le64_to_cpu(s
->msg_buf
);
626 s
->msg_buffered_bytes
= 0;
628 fd
= qemu_chr_fe_get_msgfd(&s
->server_chr
);
630 process_msg(s
, msg
, fd
, &err
);
632 error_report_err(err
);
636 static int64_t ivshmem_recv_msg(IVShmemState
*s
, int *pfd
, Error
**errp
)
643 ret
= qemu_chr_fe_read_all(&s
->server_chr
, (uint8_t *)&msg
+ n
,
645 if (ret
< 0 && ret
!= -EINTR
) {
646 error_setg_errno(errp
, -ret
, "read from server failed");
650 } while (n
< sizeof(msg
));
652 *pfd
= qemu_chr_fe_get_msgfd(&s
->server_chr
);
656 static void ivshmem_recv_setup(IVShmemState
*s
, Error
**errp
)
662 msg
= ivshmem_recv_msg(s
, &fd
, &err
);
664 error_propagate(errp
, err
);
667 if (msg
!= IVSHMEM_PROTOCOL_VERSION
) {
668 error_setg(errp
, "server sent version %" PRId64
", expecting %d",
669 msg
, IVSHMEM_PROTOCOL_VERSION
);
673 error_setg(errp
, "server sent invalid version message");
678 * ivshmem-server sends the remaining initial messages in a fixed
679 * order, but the device has always accepted them in any order.
680 * Stay as compatible as practical, just in case people use
681 * servers that behave differently.
685 * ivshmem_device_spec.txt has always required the ID message
686 * right here, and ivshmem-server has always complied. However,
687 * older versions of the device accepted it out of order, but
688 * broke when an interrupt setup message arrived before it.
690 msg
= ivshmem_recv_msg(s
, &fd
, &err
);
692 error_propagate(errp
, err
);
695 if (fd
!= -1 || msg
< 0 || msg
> IVSHMEM_MAX_PEERS
) {
696 error_setg(errp
, "server sent invalid ID message");
702 * Receive more messages until we got shared memory.
705 msg
= ivshmem_recv_msg(s
, &fd
, &err
);
707 error_propagate(errp
, err
);
710 process_msg(s
, msg
, fd
, &err
);
712 error_propagate(errp
, err
);
718 * This function must either map the shared memory or fail. The
719 * loop above ensures that: it terminates normally only after it
720 * successfully processed the server's shared memory message.
721 * Assert that actually mapped the shared memory:
723 assert(s
->ivshmem_bar2
);
726 /* Select the MSI-X vectors used by device.
727 * ivshmem maps events to vectors statically, so
728 * we just enable all vectors on init and after reset. */
729 static void ivshmem_msix_vector_use(IVShmemState
*s
)
731 PCIDevice
*d
= PCI_DEVICE(s
);
734 for (i
= 0; i
< s
->vectors
; i
++) {
735 msix_vector_use(d
, i
);
739 static void ivshmem_reset(DeviceState
*d
)
741 IVShmemState
*s
= IVSHMEM_COMMON(d
);
745 if (ivshmem_has_feature(s
, IVSHMEM_MSI
)) {
746 ivshmem_msix_vector_use(s
);
750 static int ivshmem_setup_interrupts(IVShmemState
*s
, Error
**errp
)
752 /* allocate QEMU callback data for receiving interrupts */
753 s
->msi_vectors
= g_malloc0(s
->vectors
* sizeof(MSIVector
));
755 if (ivshmem_has_feature(s
, IVSHMEM_MSI
)) {
756 if (msix_init_exclusive_bar(PCI_DEVICE(s
), s
->vectors
, 1, errp
)) {
760 IVSHMEM_DPRINTF("msix initialized (%d vectors)\n", s
->vectors
);
761 ivshmem_msix_vector_use(s
);
767 static void ivshmem_enable_irqfd(IVShmemState
*s
)
769 PCIDevice
*pdev
= PCI_DEVICE(s
);
772 for (i
= 0; i
< s
->peers
[s
->vm_id
].nb_eventfds
; i
++) {
775 ivshmem_add_kvm_msi_virq(s
, i
, &err
);
777 error_report_err(err
);
778 /* TODO do we need to handle the error? */
782 if (msix_set_vector_notifiers(pdev
,
783 ivshmem_vector_unmask
,
785 ivshmem_vector_poll
)) {
786 error_report("ivshmem: msix_set_vector_notifiers failed");
790 static void ivshmem_remove_kvm_msi_virq(IVShmemState
*s
, int vector
)
792 IVSHMEM_DPRINTF("ivshmem_remove_kvm_msi_virq vector:%d\n", vector
);
794 if (s
->msi_vectors
[vector
].pdev
== NULL
) {
798 /* it was cleaned when masked in the frontend. */
799 kvm_irqchip_release_virq(kvm_state
, s
->msi_vectors
[vector
].virq
);
801 s
->msi_vectors
[vector
].pdev
= NULL
;
804 static void ivshmem_disable_irqfd(IVShmemState
*s
)
806 PCIDevice
*pdev
= PCI_DEVICE(s
);
809 for (i
= 0; i
< s
->peers
[s
->vm_id
].nb_eventfds
; i
++) {
810 ivshmem_remove_kvm_msi_virq(s
, i
);
813 msix_unset_vector_notifiers(pdev
);
816 static void ivshmem_write_config(PCIDevice
*pdev
, uint32_t address
,
817 uint32_t val
, int len
)
819 IVShmemState
*s
= IVSHMEM_COMMON(pdev
);
820 int is_enabled
, was_enabled
= msix_enabled(pdev
);
822 pci_default_write_config(pdev
, address
, val
, len
);
823 is_enabled
= msix_enabled(pdev
);
825 if (kvm_msi_via_irqfd_enabled()) {
826 if (!was_enabled
&& is_enabled
) {
827 ivshmem_enable_irqfd(s
);
828 } else if (was_enabled
&& !is_enabled
) {
829 ivshmem_disable_irqfd(s
);
834 static void ivshmem_common_realize(PCIDevice
*dev
, Error
**errp
)
836 IVShmemState
*s
= IVSHMEM_COMMON(dev
);
839 uint8_t attr
= PCI_BASE_ADDRESS_SPACE_MEMORY
|
840 PCI_BASE_ADDRESS_MEM_PREFETCH
;
841 Error
*local_err
= NULL
;
843 /* IRQFD requires MSI */
844 if (ivshmem_has_feature(s
, IVSHMEM_IOEVENTFD
) &&
845 !ivshmem_has_feature(s
, IVSHMEM_MSI
)) {
846 error_setg(errp
, "ioeventfd/irqfd requires MSI");
850 pci_conf
= dev
->config
;
851 pci_conf
[PCI_COMMAND
] = PCI_COMMAND_IO
| PCI_COMMAND_MEMORY
;
853 memory_region_init_io(&s
->ivshmem_mmio
, OBJECT(s
), &ivshmem_mmio_ops
, s
,
854 "ivshmem-mmio", IVSHMEM_REG_BAR_SIZE
);
856 /* region for registers*/
857 pci_register_bar(dev
, 0, PCI_BASE_ADDRESS_SPACE_MEMORY
,
860 if (s
->not_legacy_32bit
) {
861 attr
|= PCI_BASE_ADDRESS_MEM_TYPE_64
;
864 if (s
->hostmem
!= NULL
) {
865 IVSHMEM_DPRINTF("using hostmem\n");
867 s
->ivshmem_bar2
= host_memory_backend_get_memory(s
->hostmem
,
870 Chardev
*chr
= qemu_chr_fe_get_driver(&s
->server_chr
);
873 IVSHMEM_DPRINTF("using shared memory server (socket = %s)\n",
876 /* we allocate enough space for 16 peers and grow as needed */
880 * Receive setup messages from server synchronously.
881 * Older versions did it asynchronously, but that creates a
882 * number of entertaining race conditions.
884 ivshmem_recv_setup(s
, &err
);
886 error_propagate(errp
, err
);
890 if (s
->master
== ON_OFF_AUTO_ON
&& s
->vm_id
!= 0) {
892 "master must connect to the server before any peers");
896 qemu_chr_fe_set_handlers(&s
->server_chr
, ivshmem_can_receive
,
897 ivshmem_read
, NULL
, NULL
, s
, NULL
, true);
899 if (ivshmem_setup_interrupts(s
, errp
) < 0) {
900 error_prepend(errp
, "Failed to initialize interrupts: ");
905 if (s
->master
== ON_OFF_AUTO_AUTO
) {
906 s
->master
= s
->vm_id
== 0 ? ON_OFF_AUTO_ON
: ON_OFF_AUTO_OFF
;
909 if (!ivshmem_is_master(s
)) {
910 error_setg(&s
->migration_blocker
,
911 "Migration is disabled when using feature 'peer mode' in device 'ivshmem'");
912 migrate_add_blocker(s
->migration_blocker
, &local_err
);
914 error_propagate(errp
, local_err
);
915 error_free(s
->migration_blocker
);
920 vmstate_register_ram(s
->ivshmem_bar2
, DEVICE(s
));
921 pci_register_bar(PCI_DEVICE(s
), 2, attr
, s
->ivshmem_bar2
);
924 static void ivshmem_exit(PCIDevice
*dev
)
926 IVShmemState
*s
= IVSHMEM_COMMON(dev
);
929 if (s
->migration_blocker
) {
930 migrate_del_blocker(s
->migration_blocker
);
931 error_free(s
->migration_blocker
);
934 if (memory_region_is_mapped(s
->ivshmem_bar2
)) {
936 void *addr
= memory_region_get_ram_ptr(s
->ivshmem_bar2
);
939 if (munmap(addr
, memory_region_size(s
->ivshmem_bar2
) == -1)) {
940 error_report("Failed to munmap shared memory %s",
944 fd
= memory_region_get_fd(s
->ivshmem_bar2
);
948 vmstate_unregister_ram(s
->ivshmem_bar2
, DEVICE(dev
));
952 for (i
= 0; i
< s
->nb_peers
; i
++) {
953 close_peer_eventfds(s
, i
);
958 if (ivshmem_has_feature(s
, IVSHMEM_MSI
)) {
959 msix_uninit_exclusive_bar(dev
);
962 g_free(s
->msi_vectors
);
965 static int ivshmem_pre_load(void *opaque
)
967 IVShmemState
*s
= opaque
;
969 if (!ivshmem_is_master(s
)) {
970 error_report("'peer' devices are not migratable");
977 static int ivshmem_post_load(void *opaque
, int version_id
)
979 IVShmemState
*s
= opaque
;
981 if (ivshmem_has_feature(s
, IVSHMEM_MSI
)) {
982 ivshmem_msix_vector_use(s
);
987 static void ivshmem_common_class_init(ObjectClass
*klass
, void *data
)
989 DeviceClass
*dc
= DEVICE_CLASS(klass
);
990 PCIDeviceClass
*k
= PCI_DEVICE_CLASS(klass
);
992 k
->realize
= ivshmem_common_realize
;
993 k
->exit
= ivshmem_exit
;
994 k
->config_write
= ivshmem_write_config
;
995 k
->vendor_id
= PCI_VENDOR_ID_IVSHMEM
;
996 k
->device_id
= PCI_DEVICE_ID_IVSHMEM
;
997 k
->class_id
= PCI_CLASS_MEMORY_RAM
;
999 dc
->reset
= ivshmem_reset
;
1000 set_bit(DEVICE_CATEGORY_MISC
, dc
->categories
);
1001 dc
->desc
= "Inter-VM shared memory";
1004 static const TypeInfo ivshmem_common_info
= {
1005 .name
= TYPE_IVSHMEM_COMMON
,
1006 .parent
= TYPE_PCI_DEVICE
,
1007 .instance_size
= sizeof(IVShmemState
),
1009 .class_init
= ivshmem_common_class_init
,
1012 static const VMStateDescription ivshmem_plain_vmsd
= {
1013 .name
= TYPE_IVSHMEM_PLAIN
,
1015 .minimum_version_id
= 0,
1016 .pre_load
= ivshmem_pre_load
,
1017 .post_load
= ivshmem_post_load
,
1018 .fields
= (VMStateField
[]) {
1019 VMSTATE_PCI_DEVICE(parent_obj
, IVShmemState
),
1020 VMSTATE_UINT32(intrstatus
, IVShmemState
),
1021 VMSTATE_UINT32(intrmask
, IVShmemState
),
1022 VMSTATE_END_OF_LIST()
1026 static Property ivshmem_plain_properties
[] = {
1027 DEFINE_PROP_ON_OFF_AUTO("master", IVShmemState
, master
, ON_OFF_AUTO_OFF
),
1028 DEFINE_PROP_LINK("memdev", IVShmemState
, hostmem
, TYPE_MEMORY_BACKEND
,
1029 HostMemoryBackend
*),
1030 DEFINE_PROP_END_OF_LIST(),
1033 static void ivshmem_plain_init(Object
*obj
)
1035 IVShmemState
*s
= IVSHMEM_PLAIN(obj
);
1037 s
->not_legacy_32bit
= 1;
1040 static void ivshmem_plain_realize(PCIDevice
*dev
, Error
**errp
)
1042 IVShmemState
*s
= IVSHMEM_COMMON(dev
);
1045 error_setg(errp
, "You must specify a 'memdev'");
1047 } else if (host_memory_backend_is_mapped(s
->hostmem
)) {
1048 char *path
= object_get_canonical_path_component(OBJECT(s
->hostmem
));
1049 error_setg(errp
, "can't use already busy memdev: %s", path
);
1054 ivshmem_common_realize(dev
, errp
);
1055 host_memory_backend_set_mapped(s
->hostmem
, true);
1058 static void ivshmem_plain_exit(PCIDevice
*pci_dev
)
1060 IVShmemState
*s
= IVSHMEM_COMMON(pci_dev
);
1062 host_memory_backend_set_mapped(s
->hostmem
, false);
1065 static void ivshmem_plain_class_init(ObjectClass
*klass
, void *data
)
1067 DeviceClass
*dc
= DEVICE_CLASS(klass
);
1068 PCIDeviceClass
*k
= PCI_DEVICE_CLASS(klass
);
1070 k
->realize
= ivshmem_plain_realize
;
1071 k
->exit
= ivshmem_plain_exit
;
1072 dc
->props
= ivshmem_plain_properties
;
1073 dc
->vmsd
= &ivshmem_plain_vmsd
;
1076 static const TypeInfo ivshmem_plain_info
= {
1077 .name
= TYPE_IVSHMEM_PLAIN
,
1078 .parent
= TYPE_IVSHMEM_COMMON
,
1079 .instance_size
= sizeof(IVShmemState
),
1080 .instance_init
= ivshmem_plain_init
,
1081 .class_init
= ivshmem_plain_class_init
,
1084 static const VMStateDescription ivshmem_doorbell_vmsd
= {
1085 .name
= TYPE_IVSHMEM_DOORBELL
,
1087 .minimum_version_id
= 0,
1088 .pre_load
= ivshmem_pre_load
,
1089 .post_load
= ivshmem_post_load
,
1090 .fields
= (VMStateField
[]) {
1091 VMSTATE_PCI_DEVICE(parent_obj
, IVShmemState
),
1092 VMSTATE_MSIX(parent_obj
, IVShmemState
),
1093 VMSTATE_UINT32(intrstatus
, IVShmemState
),
1094 VMSTATE_UINT32(intrmask
, IVShmemState
),
1095 VMSTATE_END_OF_LIST()
1099 static Property ivshmem_doorbell_properties
[] = {
1100 DEFINE_PROP_CHR("chardev", IVShmemState
, server_chr
),
1101 DEFINE_PROP_UINT32("vectors", IVShmemState
, vectors
, 1),
1102 DEFINE_PROP_BIT("ioeventfd", IVShmemState
, features
, IVSHMEM_IOEVENTFD
,
1104 DEFINE_PROP_ON_OFF_AUTO("master", IVShmemState
, master
, ON_OFF_AUTO_OFF
),
1105 DEFINE_PROP_END_OF_LIST(),
1108 static void ivshmem_doorbell_init(Object
*obj
)
1110 IVShmemState
*s
= IVSHMEM_DOORBELL(obj
);
1112 s
->features
|= (1 << IVSHMEM_MSI
);
1113 s
->legacy_size
= SIZE_MAX
; /* whatever the server sends */
1114 s
->not_legacy_32bit
= 1;
1117 static void ivshmem_doorbell_realize(PCIDevice
*dev
, Error
**errp
)
1119 IVShmemState
*s
= IVSHMEM_COMMON(dev
);
1121 if (!qemu_chr_fe_backend_connected(&s
->server_chr
)) {
1122 error_setg(errp
, "You must specify a 'chardev'");
1126 ivshmem_common_realize(dev
, errp
);
1129 static void ivshmem_doorbell_class_init(ObjectClass
*klass
, void *data
)
1131 DeviceClass
*dc
= DEVICE_CLASS(klass
);
1132 PCIDeviceClass
*k
= PCI_DEVICE_CLASS(klass
);
1134 k
->realize
= ivshmem_doorbell_realize
;
1135 dc
->props
= ivshmem_doorbell_properties
;
1136 dc
->vmsd
= &ivshmem_doorbell_vmsd
;
1139 static const TypeInfo ivshmem_doorbell_info
= {
1140 .name
= TYPE_IVSHMEM_DOORBELL
,
1141 .parent
= TYPE_IVSHMEM_COMMON
,
1142 .instance_size
= sizeof(IVShmemState
),
1143 .instance_init
= ivshmem_doorbell_init
,
1144 .class_init
= ivshmem_doorbell_class_init
,
1147 static int ivshmem_load_old(QEMUFile
*f
, void *opaque
, int version_id
)
1149 IVShmemState
*s
= opaque
;
1150 PCIDevice
*pdev
= PCI_DEVICE(s
);
1153 IVSHMEM_DPRINTF("ivshmem_load_old\n");
1155 if (version_id
!= 0) {
1159 ret
= ivshmem_pre_load(s
);
1164 ret
= pci_device_load(pdev
, f
);
1169 if (ivshmem_has_feature(s
, IVSHMEM_MSI
)) {
1171 ivshmem_msix_vector_use(s
);
1173 s
->intrstatus
= qemu_get_be32(f
);
1174 s
->intrmask
= qemu_get_be32(f
);
1180 static bool test_msix(void *opaque
, int version_id
)
1182 IVShmemState
*s
= opaque
;
1184 return ivshmem_has_feature(s
, IVSHMEM_MSI
);
1187 static bool test_no_msix(void *opaque
, int version_id
)
1189 return !test_msix(opaque
, version_id
);
1192 static const VMStateDescription ivshmem_vmsd
= {
1195 .minimum_version_id
= 1,
1196 .pre_load
= ivshmem_pre_load
,
1197 .post_load
= ivshmem_post_load
,
1198 .fields
= (VMStateField
[]) {
1199 VMSTATE_PCI_DEVICE(parent_obj
, IVShmemState
),
1201 VMSTATE_MSIX_TEST(parent_obj
, IVShmemState
, test_msix
),
1202 VMSTATE_UINT32_TEST(intrstatus
, IVShmemState
, test_no_msix
),
1203 VMSTATE_UINT32_TEST(intrmask
, IVShmemState
, test_no_msix
),
1205 VMSTATE_END_OF_LIST()
1207 .load_state_old
= ivshmem_load_old
,
1208 .minimum_version_id_old
= 0
1211 static Property ivshmem_properties
[] = {
1212 DEFINE_PROP_CHR("chardev", IVShmemState
, server_chr
),
1213 DEFINE_PROP_STRING("size", IVShmemState
, sizearg
),
1214 DEFINE_PROP_UINT32("vectors", IVShmemState
, vectors
, 1),
1215 DEFINE_PROP_BIT("ioeventfd", IVShmemState
, features
, IVSHMEM_IOEVENTFD
,
1217 DEFINE_PROP_BIT("msi", IVShmemState
, features
, IVSHMEM_MSI
, true),
1218 DEFINE_PROP_STRING("shm", IVShmemState
, shmobj
),
1219 DEFINE_PROP_STRING("role", IVShmemState
, role
),
1220 DEFINE_PROP_UINT32("use64", IVShmemState
, not_legacy_32bit
, 1),
1221 DEFINE_PROP_END_OF_LIST(),
1224 static void desugar_shm(IVShmemState
*s
)
1229 obj
= object_new("memory-backend-file");
1230 path
= g_strdup_printf("/dev/shm/%s", s
->shmobj
);
1231 object_property_set_str(obj
, path
, "mem-path", &error_abort
);
1233 object_property_set_int(obj
, s
->legacy_size
, "size", &error_abort
);
1234 object_property_set_bool(obj
, true, "share", &error_abort
);
1235 object_property_add_child(OBJECT(s
), "internal-shm-backend", obj
,
1237 user_creatable_complete(obj
, &error_abort
);
1238 s
->hostmem
= MEMORY_BACKEND(obj
);
1241 static void ivshmem_realize(PCIDevice
*dev
, Error
**errp
)
1243 IVShmemState
*s
= IVSHMEM_COMMON(dev
);
1245 if (!qtest_enabled()) {
1246 error_report("ivshmem is deprecated, please use ivshmem-plain"
1247 " or ivshmem-doorbell instead");
1250 if (qemu_chr_fe_backend_connected(&s
->server_chr
) + !!s
->shmobj
!= 1) {
1251 error_setg(errp
, "You must specify either 'shm' or 'chardev'");
1255 if (s
->sizearg
== NULL
) {
1256 s
->legacy_size
= 4 << 20; /* 4 MB default */
1261 ret
= qemu_strtosz_MiB(s
->sizearg
, NULL
, &size
);
1262 if (ret
< 0 || (size_t)size
!= size
|| !is_power_of_2(size
)) {
1263 error_setg(errp
, "Invalid size %s", s
->sizearg
);
1266 s
->legacy_size
= size
;
1269 /* check that role is reasonable */
1271 if (strncmp(s
->role
, "peer", 5) == 0) {
1272 s
->master
= ON_OFF_AUTO_OFF
;
1273 } else if (strncmp(s
->role
, "master", 7) == 0) {
1274 s
->master
= ON_OFF_AUTO_ON
;
1276 error_setg(errp
, "'role' must be 'peer' or 'master'");
1280 s
->master
= ON_OFF_AUTO_AUTO
;
1288 * Note: we don't use INTx with IVSHMEM_MSI at all, so this is a
1289 * bald-faced lie then. But it's a backwards compatible lie.
1291 pci_config_set_interrupt_pin(dev
->config
, 1);
1293 ivshmem_common_realize(dev
, errp
);
1296 static void ivshmem_class_init(ObjectClass
*klass
, void *data
)
1298 DeviceClass
*dc
= DEVICE_CLASS(klass
);
1299 PCIDeviceClass
*k
= PCI_DEVICE_CLASS(klass
);
1301 k
->realize
= ivshmem_realize
;
1303 dc
->desc
= "Inter-VM shared memory (legacy)";
1304 dc
->props
= ivshmem_properties
;
1305 dc
->vmsd
= &ivshmem_vmsd
;
1308 static const TypeInfo ivshmem_info
= {
1309 .name
= TYPE_IVSHMEM
,
1310 .parent
= TYPE_IVSHMEM_COMMON
,
1311 .instance_size
= sizeof(IVShmemState
),
1312 .class_init
= ivshmem_class_init
,
1315 static void ivshmem_register_types(void)
1317 type_register_static(&ivshmem_common_info
);
1318 type_register_static(&ivshmem_plain_info
);
1319 type_register_static(&ivshmem_doorbell_info
);
1320 type_register_static(&ivshmem_info
);
1323 type_init(ivshmem_register_types
)