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"
21 #include "hw/i386/pc.h"
22 #include "hw/pci/pci.h"
23 #include "hw/pci/msi.h"
24 #include "hw/pci/msix.h"
25 #include "sysemu/kvm.h"
26 #include "migration/migration.h"
27 #include "qemu/error-report.h"
28 #include "qemu/event_notifier.h"
29 #include "qom/object_interfaces.h"
30 #include "sysemu/char.h"
31 #include "sysemu/hostmem.h"
32 #include "sysemu/qtest.h"
33 #include "qapi/visitor.h"
34 #include "exec/ram_addr.h"
36 #include "hw/misc/ivshmem.h"
40 #define PCI_VENDOR_ID_IVSHMEM PCI_VENDOR_ID_REDHAT_QUMRANET
41 #define PCI_DEVICE_ID_IVSHMEM 0x1110
43 #define IVSHMEM_MAX_PEERS UINT16_MAX
44 #define IVSHMEM_IOEVENTFD 0
47 #define IVSHMEM_REG_BAR_SIZE 0x100
49 #define IVSHMEM_DEBUG 0
50 #define IVSHMEM_DPRINTF(fmt, ...) \
52 if (IVSHMEM_DEBUG) { \
53 printf("IVSHMEM: " fmt, ## __VA_ARGS__); \
57 #define TYPE_IVSHMEM_COMMON "ivshmem-common"
58 #define IVSHMEM_COMMON(obj) \
59 OBJECT_CHECK(IVShmemState, (obj), TYPE_IVSHMEM_COMMON)
61 #define TYPE_IVSHMEM_PLAIN "ivshmem-plain"
62 #define IVSHMEM_PLAIN(obj) \
63 OBJECT_CHECK(IVShmemState, (obj), TYPE_IVSHMEM_PLAIN)
65 #define TYPE_IVSHMEM_DOORBELL "ivshmem-doorbell"
66 #define IVSHMEM_DOORBELL(obj) \
67 OBJECT_CHECK(IVShmemState, (obj), TYPE_IVSHMEM_DOORBELL)
69 #define TYPE_IVSHMEM "ivshmem"
70 #define IVSHMEM(obj) \
71 OBJECT_CHECK(IVShmemState, (obj), TYPE_IVSHMEM)
75 EventNotifier
*eventfds
;
78 typedef struct MSIVector
{
83 typedef struct IVShmemState
{
88 HostMemoryBackend
*hostmem
;
92 CharDriverState
*server_chr
;
93 MemoryRegion ivshmem_mmio
;
95 MemoryRegion
*ivshmem_bar2
; /* BAR 2 (shared memory) */
96 MemoryRegion server_bar2
; /* used with server_chr */
99 int nb_peers
; /* space in @peers[] */
104 MSIVector
*msi_vectors
;
105 uint64_t msg_buf
; /* buffer for receiving server messages */
106 int msg_buffered_bytes
; /* #bytes in @msg_buf */
109 Error
*migration_blocker
;
116 uint32_t not_legacy_32bit
;
119 /* registers for the Inter-VM shared memory device */
120 enum ivshmem_registers
{
127 static inline uint32_t ivshmem_has_feature(IVShmemState
*ivs
,
128 unsigned int feature
) {
129 return (ivs
->features
& (1 << feature
));
132 static inline bool ivshmem_is_master(IVShmemState
*s
)
134 assert(s
->master
!= ON_OFF_AUTO_AUTO
);
135 return s
->master
== ON_OFF_AUTO_ON
;
138 static void ivshmem_update_irq(IVShmemState
*s
)
140 PCIDevice
*d
= PCI_DEVICE(s
);
141 uint32_t isr
= s
->intrstatus
& s
->intrmask
;
144 * Do nothing unless the device actually uses INTx. Here's how
145 * the device variants signal interrupts, what they put in PCI
147 * Device variant Interrupt Interrupt Pin MSI-X cap.
148 * ivshmem-plain none 0 no
149 * ivshmem-doorbell MSI-X 1 yes(1)
150 * ivshmem,msi=off INTx 1 no
151 * ivshmem,msi=on MSI-X 1(2) yes(1)
152 * (1) if guest enabled MSI-X
153 * (2) the device lies
154 * Leads to the condition for doing nothing:
156 if (ivshmem_has_feature(s
, IVSHMEM_MSI
)
157 || !d
->config
[PCI_INTERRUPT_PIN
]) {
161 /* don't print ISR resets */
163 IVSHMEM_DPRINTF("Set IRQ to %d (%04x %04x)\n",
164 isr
? 1 : 0, s
->intrstatus
, s
->intrmask
);
167 pci_set_irq(d
, isr
!= 0);
170 static void ivshmem_IntrMask_write(IVShmemState
*s
, uint32_t val
)
172 IVSHMEM_DPRINTF("IntrMask write(w) val = 0x%04x\n", val
);
175 ivshmem_update_irq(s
);
178 static uint32_t ivshmem_IntrMask_read(IVShmemState
*s
)
180 uint32_t ret
= s
->intrmask
;
182 IVSHMEM_DPRINTF("intrmask read(w) val = 0x%04x\n", ret
);
186 static void ivshmem_IntrStatus_write(IVShmemState
*s
, uint32_t val
)
188 IVSHMEM_DPRINTF("IntrStatus write(w) val = 0x%04x\n", val
);
191 ivshmem_update_irq(s
);
194 static uint32_t ivshmem_IntrStatus_read(IVShmemState
*s
)
196 uint32_t ret
= s
->intrstatus
;
198 /* reading ISR clears all interrupts */
200 ivshmem_update_irq(s
);
204 static void ivshmem_io_write(void *opaque
, hwaddr addr
,
205 uint64_t val
, unsigned size
)
207 IVShmemState
*s
= opaque
;
209 uint16_t dest
= val
>> 16;
210 uint16_t vector
= val
& 0xff;
214 IVSHMEM_DPRINTF("writing to addr " TARGET_FMT_plx
"\n", addr
);
218 ivshmem_IntrMask_write(s
, val
);
222 ivshmem_IntrStatus_write(s
, val
);
226 /* check that dest VM ID is reasonable */
227 if (dest
>= s
->nb_peers
) {
228 IVSHMEM_DPRINTF("Invalid destination VM ID (%d)\n", dest
);
232 /* check doorbell range */
233 if (vector
< s
->peers
[dest
].nb_eventfds
) {
234 IVSHMEM_DPRINTF("Notifying VM %d on vector %d\n", dest
, vector
);
235 event_notifier_set(&s
->peers
[dest
].eventfds
[vector
]);
237 IVSHMEM_DPRINTF("Invalid destination vector %d on VM %d\n",
242 IVSHMEM_DPRINTF("Unhandled write " TARGET_FMT_plx
"\n", addr
);
246 static uint64_t ivshmem_io_read(void *opaque
, hwaddr addr
,
250 IVShmemState
*s
= opaque
;
256 ret
= ivshmem_IntrMask_read(s
);
260 ret
= ivshmem_IntrStatus_read(s
);
268 IVSHMEM_DPRINTF("why are we reading " TARGET_FMT_plx
"\n", addr
);
275 static const MemoryRegionOps ivshmem_mmio_ops
= {
276 .read
= ivshmem_io_read
,
277 .write
= ivshmem_io_write
,
278 .endianness
= DEVICE_NATIVE_ENDIAN
,
280 .min_access_size
= 4,
281 .max_access_size
= 4,
285 static void ivshmem_vector_notify(void *opaque
)
287 MSIVector
*entry
= opaque
;
288 PCIDevice
*pdev
= entry
->pdev
;
289 IVShmemState
*s
= IVSHMEM_COMMON(pdev
);
290 int vector
= entry
- s
->msi_vectors
;
291 EventNotifier
*n
= &s
->peers
[s
->vm_id
].eventfds
[vector
];
293 if (!event_notifier_test_and_clear(n
)) {
297 IVSHMEM_DPRINTF("interrupt on vector %p %d\n", pdev
, vector
);
298 if (ivshmem_has_feature(s
, IVSHMEM_MSI
)) {
299 if (msix_enabled(pdev
)) {
300 msix_notify(pdev
, vector
);
303 ivshmem_IntrStatus_write(s
, 1);
307 static int ivshmem_vector_unmask(PCIDevice
*dev
, unsigned vector
,
310 IVShmemState
*s
= IVSHMEM_COMMON(dev
);
311 EventNotifier
*n
= &s
->peers
[s
->vm_id
].eventfds
[vector
];
312 MSIVector
*v
= &s
->msi_vectors
[vector
];
315 IVSHMEM_DPRINTF("vector unmask %p %d\n", dev
, vector
);
317 ret
= kvm_irqchip_update_msi_route(kvm_state
, v
->virq
, msg
, dev
);
322 return kvm_irqchip_add_irqfd_notifier_gsi(kvm_state
, n
, NULL
, v
->virq
);
325 static void ivshmem_vector_mask(PCIDevice
*dev
, unsigned vector
)
327 IVShmemState
*s
= IVSHMEM_COMMON(dev
);
328 EventNotifier
*n
= &s
->peers
[s
->vm_id
].eventfds
[vector
];
331 IVSHMEM_DPRINTF("vector mask %p %d\n", dev
, vector
);
333 ret
= kvm_irqchip_remove_irqfd_notifier_gsi(kvm_state
, n
,
334 s
->msi_vectors
[vector
].virq
);
336 error_report("remove_irqfd_notifier_gsi failed");
340 static void ivshmem_vector_poll(PCIDevice
*dev
,
341 unsigned int vector_start
,
342 unsigned int vector_end
)
344 IVShmemState
*s
= IVSHMEM_COMMON(dev
);
347 IVSHMEM_DPRINTF("vector poll %p %d-%d\n", dev
, vector_start
, vector_end
);
349 vector_end
= MIN(vector_end
, s
->vectors
);
351 for (vector
= vector_start
; vector
< vector_end
; vector
++) {
352 EventNotifier
*notifier
= &s
->peers
[s
->vm_id
].eventfds
[vector
];
354 if (!msix_is_masked(dev
, vector
)) {
358 if (event_notifier_test_and_clear(notifier
)) {
359 msix_set_pending(dev
, vector
);
364 static void watch_vector_notifier(IVShmemState
*s
, EventNotifier
*n
,
367 int eventfd
= event_notifier_get_fd(n
);
369 assert(!s
->msi_vectors
[vector
].pdev
);
370 s
->msi_vectors
[vector
].pdev
= PCI_DEVICE(s
);
372 qemu_set_fd_handler(eventfd
, ivshmem_vector_notify
,
373 NULL
, &s
->msi_vectors
[vector
]);
376 static void ivshmem_add_eventfd(IVShmemState
*s
, int posn
, int i
)
378 memory_region_add_eventfd(&s
->ivshmem_mmio
,
383 &s
->peers
[posn
].eventfds
[i
]);
386 static void ivshmem_del_eventfd(IVShmemState
*s
, int posn
, int i
)
388 memory_region_del_eventfd(&s
->ivshmem_mmio
,
393 &s
->peers
[posn
].eventfds
[i
]);
396 static void close_peer_eventfds(IVShmemState
*s
, int posn
)
400 assert(posn
>= 0 && posn
< s
->nb_peers
);
401 n
= s
->peers
[posn
].nb_eventfds
;
403 if (ivshmem_has_feature(s
, IVSHMEM_IOEVENTFD
)) {
404 memory_region_transaction_begin();
405 for (i
= 0; i
< n
; i
++) {
406 ivshmem_del_eventfd(s
, posn
, i
);
408 memory_region_transaction_commit();
411 for (i
= 0; i
< n
; i
++) {
412 event_notifier_cleanup(&s
->peers
[posn
].eventfds
[i
]);
415 g_free(s
->peers
[posn
].eventfds
);
416 s
->peers
[posn
].nb_eventfds
= 0;
419 static void resize_peers(IVShmemState
*s
, int nb_peers
)
421 int old_nb_peers
= s
->nb_peers
;
424 assert(nb_peers
> old_nb_peers
);
425 IVSHMEM_DPRINTF("bumping storage to %d peers\n", nb_peers
);
427 s
->peers
= g_realloc(s
->peers
, nb_peers
* sizeof(Peer
));
428 s
->nb_peers
= nb_peers
;
430 for (i
= old_nb_peers
; i
< nb_peers
; i
++) {
431 s
->peers
[i
].eventfds
= g_new0(EventNotifier
, s
->vectors
);
432 s
->peers
[i
].nb_eventfds
= 0;
436 static void ivshmem_add_kvm_msi_virq(IVShmemState
*s
, int vector
,
439 PCIDevice
*pdev
= PCI_DEVICE(s
);
440 MSIMessage msg
= msix_get_message(pdev
, vector
);
443 IVSHMEM_DPRINTF("ivshmem_add_kvm_msi_virq vector:%d\n", vector
);
444 assert(!s
->msi_vectors
[vector
].pdev
);
446 ret
= kvm_irqchip_add_msi_route(kvm_state
, msg
, pdev
);
448 error_setg(errp
, "kvm_irqchip_add_msi_route failed");
452 s
->msi_vectors
[vector
].virq
= ret
;
453 s
->msi_vectors
[vector
].pdev
= pdev
;
456 static void setup_interrupt(IVShmemState
*s
, int vector
, Error
**errp
)
458 EventNotifier
*n
= &s
->peers
[s
->vm_id
].eventfds
[vector
];
459 bool with_irqfd
= kvm_msi_via_irqfd_enabled() &&
460 ivshmem_has_feature(s
, IVSHMEM_MSI
);
461 PCIDevice
*pdev
= PCI_DEVICE(s
);
464 IVSHMEM_DPRINTF("setting up interrupt for vector: %d\n", vector
);
467 IVSHMEM_DPRINTF("with eventfd\n");
468 watch_vector_notifier(s
, n
, vector
);
469 } else if (msix_enabled(pdev
)) {
470 IVSHMEM_DPRINTF("with irqfd\n");
471 ivshmem_add_kvm_msi_virq(s
, vector
, &err
);
473 error_propagate(errp
, err
);
477 if (!msix_is_masked(pdev
, vector
)) {
478 kvm_irqchip_add_irqfd_notifier_gsi(kvm_state
, n
, NULL
,
479 s
->msi_vectors
[vector
].virq
);
480 /* TODO handle error */
483 /* it will be delayed until msix is enabled, in write_config */
484 IVSHMEM_DPRINTF("with irqfd, delayed until msix enabled\n");
488 static void process_msg_shmem(IVShmemState
*s
, int fd
, Error
**errp
)
494 if (s
->ivshmem_bar2
) {
495 error_setg(errp
, "server sent unexpected shared memory message");
500 if (fstat(fd
, &buf
) < 0) {
501 error_setg_errno(errp
, errno
,
502 "can't determine size of shared memory sent by server");
510 if (s
->legacy_size
!= SIZE_MAX
) {
511 if (size
< s
->legacy_size
) {
512 error_setg(errp
, "server sent only %zd bytes of shared memory",
513 (size_t)buf
.st_size
);
517 size
= s
->legacy_size
;
520 /* mmap the region and map into the BAR2 */
521 ptr
= mmap(0, size
, PROT_READ
| PROT_WRITE
, MAP_SHARED
, fd
, 0);
522 if (ptr
== MAP_FAILED
) {
523 error_setg_errno(errp
, errno
, "Failed to mmap shared memory");
527 memory_region_init_ram_ptr(&s
->server_bar2
, OBJECT(s
),
528 "ivshmem.bar2", size
, ptr
);
529 qemu_set_ram_fd(memory_region_get_ram_addr(&s
->server_bar2
), fd
);
530 s
->ivshmem_bar2
= &s
->server_bar2
;
533 static void process_msg_disconnect(IVShmemState
*s
, uint16_t posn
,
536 IVSHMEM_DPRINTF("posn %d has gone away\n", posn
);
537 if (posn
>= s
->nb_peers
|| posn
== s
->vm_id
) {
538 error_setg(errp
, "invalid peer %d", posn
);
541 close_peer_eventfds(s
, posn
);
544 static void process_msg_connect(IVShmemState
*s
, uint16_t posn
, int fd
,
547 Peer
*peer
= &s
->peers
[posn
];
551 * The N-th connect message for this peer comes with the file
552 * descriptor for vector N-1. Count messages to find the vector.
554 if (peer
->nb_eventfds
>= s
->vectors
) {
555 error_setg(errp
, "Too many eventfd received, device has %d vectors",
560 vector
= peer
->nb_eventfds
++;
562 IVSHMEM_DPRINTF("eventfds[%d][%d] = %d\n", posn
, vector
, fd
);
563 event_notifier_init_fd(&peer
->eventfds
[vector
], fd
);
564 fcntl_setfl(fd
, O_NONBLOCK
); /* msix/irqfd poll non block */
566 if (posn
== s
->vm_id
) {
567 setup_interrupt(s
, vector
, errp
);
568 /* TODO do we need to handle the error? */
571 if (ivshmem_has_feature(s
, IVSHMEM_IOEVENTFD
)) {
572 ivshmem_add_eventfd(s
, posn
, vector
);
576 static void process_msg(IVShmemState
*s
, int64_t msg
, int fd
, Error
**errp
)
578 IVSHMEM_DPRINTF("posn is %" PRId64
", fd is %d\n", msg
, fd
);
580 if (msg
< -1 || msg
> IVSHMEM_MAX_PEERS
) {
581 error_setg(errp
, "server sent invalid message %" PRId64
, msg
);
587 process_msg_shmem(s
, fd
, errp
);
591 if (msg
>= s
->nb_peers
) {
592 resize_peers(s
, msg
+ 1);
596 process_msg_connect(s
, msg
, fd
, errp
);
598 process_msg_disconnect(s
, msg
, errp
);
602 static int ivshmem_can_receive(void *opaque
)
604 IVShmemState
*s
= opaque
;
606 assert(s
->msg_buffered_bytes
< sizeof(s
->msg_buf
));
607 return sizeof(s
->msg_buf
) - s
->msg_buffered_bytes
;
610 static void ivshmem_read(void *opaque
, const uint8_t *buf
, int size
)
612 IVShmemState
*s
= opaque
;
617 assert(size
>= 0 && s
->msg_buffered_bytes
+ size
<= sizeof(s
->msg_buf
));
618 memcpy((unsigned char *)&s
->msg_buf
+ s
->msg_buffered_bytes
, buf
, size
);
619 s
->msg_buffered_bytes
+= size
;
620 if (s
->msg_buffered_bytes
< sizeof(s
->msg_buf
)) {
623 msg
= le64_to_cpu(s
->msg_buf
);
624 s
->msg_buffered_bytes
= 0;
626 fd
= qemu_chr_fe_get_msgfd(s
->server_chr
);
627 IVSHMEM_DPRINTF("posn is %" PRId64
", fd is %d\n", msg
, fd
);
629 process_msg(s
, msg
, fd
, &err
);
631 error_report_err(err
);
635 static int64_t ivshmem_recv_msg(IVShmemState
*s
, int *pfd
, Error
**errp
)
642 ret
= qemu_chr_fe_read_all(s
->server_chr
, (uint8_t *)&msg
+ n
,
644 if (ret
< 0 && ret
!= -EINTR
) {
645 error_setg_errno(errp
, -ret
, "read from server failed");
649 } while (n
< sizeof(msg
));
651 *pfd
= qemu_chr_fe_get_msgfd(s
->server_chr
);
655 static void ivshmem_recv_setup(IVShmemState
*s
, Error
**errp
)
661 msg
= ivshmem_recv_msg(s
, &fd
, &err
);
663 error_propagate(errp
, err
);
666 if (msg
!= IVSHMEM_PROTOCOL_VERSION
) {
667 error_setg(errp
, "server sent version %" PRId64
", expecting %d",
668 msg
, IVSHMEM_PROTOCOL_VERSION
);
672 error_setg(errp
, "server sent invalid version message");
677 * ivshmem-server sends the remaining initial messages in a fixed
678 * order, but the device has always accepted them in any order.
679 * Stay as compatible as practical, just in case people use
680 * servers that behave differently.
684 * ivshmem_device_spec.txt has always required the ID message
685 * right here, and ivshmem-server has always complied. However,
686 * older versions of the device accepted it out of order, but
687 * broke when an interrupt setup message arrived before it.
689 msg
= ivshmem_recv_msg(s
, &fd
, &err
);
691 error_propagate(errp
, err
);
694 if (fd
!= -1 || msg
< 0 || msg
> IVSHMEM_MAX_PEERS
) {
695 error_setg(errp
, "server sent invalid ID message");
701 * Receive more messages until we got shared memory.
704 msg
= ivshmem_recv_msg(s
, &fd
, &err
);
706 error_propagate(errp
, err
);
709 process_msg(s
, msg
, fd
, &err
);
711 error_propagate(errp
, err
);
717 * This function must either map the shared memory or fail. The
718 * loop above ensures that: it terminates normally only after it
719 * successfully processed the server's shared memory message.
720 * Assert that actually mapped the shared memory:
722 assert(s
->ivshmem_bar2
);
725 /* Select the MSI-X vectors used by device.
726 * ivshmem maps events to vectors statically, so
727 * we just enable all vectors on init and after reset. */
728 static void ivshmem_msix_vector_use(IVShmemState
*s
)
730 PCIDevice
*d
= PCI_DEVICE(s
);
733 for (i
= 0; i
< s
->vectors
; i
++) {
734 msix_vector_use(d
, i
);
738 static void ivshmem_reset(DeviceState
*d
)
740 IVShmemState
*s
= IVSHMEM_COMMON(d
);
744 if (ivshmem_has_feature(s
, IVSHMEM_MSI
)) {
745 ivshmem_msix_vector_use(s
);
749 static int ivshmem_setup_interrupts(IVShmemState
*s
)
751 /* allocate QEMU callback data for receiving interrupts */
752 s
->msi_vectors
= g_malloc0(s
->vectors
* sizeof(MSIVector
));
754 if (ivshmem_has_feature(s
, IVSHMEM_MSI
)) {
755 if (msix_init_exclusive_bar(PCI_DEVICE(s
), s
->vectors
, 1)) {
759 IVSHMEM_DPRINTF("msix initialized (%d vectors)\n", s
->vectors
);
760 ivshmem_msix_vector_use(s
);
766 static void ivshmem_enable_irqfd(IVShmemState
*s
)
768 PCIDevice
*pdev
= PCI_DEVICE(s
);
771 for (i
= 0; i
< s
->peers
[s
->vm_id
].nb_eventfds
; i
++) {
774 ivshmem_add_kvm_msi_virq(s
, i
, &err
);
776 error_report_err(err
);
777 /* TODO do we need to handle the error? */
781 if (msix_set_vector_notifiers(pdev
,
782 ivshmem_vector_unmask
,
784 ivshmem_vector_poll
)) {
785 error_report("ivshmem: msix_set_vector_notifiers failed");
789 static void ivshmem_remove_kvm_msi_virq(IVShmemState
*s
, int vector
)
791 IVSHMEM_DPRINTF("ivshmem_remove_kvm_msi_virq vector:%d\n", vector
);
793 if (s
->msi_vectors
[vector
].pdev
== NULL
) {
797 /* it was cleaned when masked in the frontend. */
798 kvm_irqchip_release_virq(kvm_state
, s
->msi_vectors
[vector
].virq
);
800 s
->msi_vectors
[vector
].pdev
= NULL
;
803 static void ivshmem_disable_irqfd(IVShmemState
*s
)
805 PCIDevice
*pdev
= PCI_DEVICE(s
);
808 for (i
= 0; i
< s
->peers
[s
->vm_id
].nb_eventfds
; i
++) {
809 ivshmem_remove_kvm_msi_virq(s
, i
);
812 msix_unset_vector_notifiers(pdev
);
815 static void ivshmem_write_config(PCIDevice
*pdev
, uint32_t address
,
816 uint32_t val
, int len
)
818 IVShmemState
*s
= IVSHMEM_COMMON(pdev
);
819 int is_enabled
, was_enabled
= msix_enabled(pdev
);
821 pci_default_write_config(pdev
, address
, val
, len
);
822 is_enabled
= msix_enabled(pdev
);
824 if (kvm_msi_via_irqfd_enabled()) {
825 if (!was_enabled
&& is_enabled
) {
826 ivshmem_enable_irqfd(s
);
827 } else if (was_enabled
&& !is_enabled
) {
828 ivshmem_disable_irqfd(s
);
833 static void desugar_shm(IVShmemState
*s
)
838 obj
= object_new("memory-backend-file");
839 path
= g_strdup_printf("/dev/shm/%s", s
->shmobj
);
840 object_property_set_str(obj
, path
, "mem-path", &error_abort
);
842 object_property_set_int(obj
, s
->legacy_size
, "size", &error_abort
);
843 object_property_set_bool(obj
, true, "share", &error_abort
);
844 object_property_add_child(OBJECT(s
), "internal-shm-backend", obj
,
846 user_creatable_complete(obj
, &error_abort
);
847 s
->hostmem
= MEMORY_BACKEND(obj
);
850 static void ivshmem_common_realize(PCIDevice
*dev
, Error
**errp
)
852 IVShmemState
*s
= IVSHMEM_COMMON(dev
);
855 uint8_t attr
= PCI_BASE_ADDRESS_SPACE_MEMORY
|
856 PCI_BASE_ADDRESS_MEM_PREFETCH
;
858 /* IRQFD requires MSI */
859 if (ivshmem_has_feature(s
, IVSHMEM_IOEVENTFD
) &&
860 !ivshmem_has_feature(s
, IVSHMEM_MSI
)) {
861 error_setg(errp
, "ioeventfd/irqfd requires MSI");
865 pci_conf
= dev
->config
;
866 pci_conf
[PCI_COMMAND
] = PCI_COMMAND_IO
| PCI_COMMAND_MEMORY
;
868 memory_region_init_io(&s
->ivshmem_mmio
, OBJECT(s
), &ivshmem_mmio_ops
, s
,
869 "ivshmem-mmio", IVSHMEM_REG_BAR_SIZE
);
871 /* region for registers*/
872 pci_register_bar(dev
, 0, PCI_BASE_ADDRESS_SPACE_MEMORY
,
875 if (!s
->not_legacy_32bit
) {
876 attr
|= PCI_BASE_ADDRESS_MEM_TYPE_64
;
879 if (s
->hostmem
!= NULL
) {
880 IVSHMEM_DPRINTF("using hostmem\n");
882 s
->ivshmem_bar2
= host_memory_backend_get_memory(s
->hostmem
,
885 IVSHMEM_DPRINTF("using shared memory server (socket = %s)\n",
886 s
->server_chr
->filename
);
888 /* we allocate enough space for 16 peers and grow as needed */
892 * Receive setup messages from server synchronously.
893 * Older versions did it asynchronously, but that creates a
894 * number of entertaining race conditions.
896 ivshmem_recv_setup(s
, &err
);
898 error_propagate(errp
, err
);
902 qemu_chr_add_handlers(s
->server_chr
, ivshmem_can_receive
,
903 ivshmem_read
, NULL
, s
);
905 if (ivshmem_setup_interrupts(s
) < 0) {
906 error_setg(errp
, "failed to initialize interrupts");
911 vmstate_register_ram(s
->ivshmem_bar2
, DEVICE(s
));
912 pci_register_bar(PCI_DEVICE(s
), 2, attr
, s
->ivshmem_bar2
);
914 if (s
->master
== ON_OFF_AUTO_AUTO
) {
915 s
->master
= s
->vm_id
== 0 ? ON_OFF_AUTO_ON
: ON_OFF_AUTO_OFF
;
918 if (!ivshmem_is_master(s
)) {
919 error_setg(&s
->migration_blocker
,
920 "Migration is disabled when using feature 'peer mode' in device 'ivshmem'");
921 migrate_add_blocker(s
->migration_blocker
);
925 static void ivshmem_realize(PCIDevice
*dev
, Error
**errp
)
927 IVShmemState
*s
= IVSHMEM_COMMON(dev
);
929 if (!qtest_enabled()) {
930 error_report("ivshmem is deprecated, please use ivshmem-plain"
931 " or ivshmem-doorbell instead");
934 if (!!s
->server_chr
+ !!s
->shmobj
+ !!s
->hostmem
!= 1) {
936 "You must specify either 'shm', 'chardev' or 'x-memdev'");
942 g_warning("size argument ignored with hostmem");
944 } else if (s
->sizearg
== NULL
) {
945 s
->legacy_size
= 4 << 20; /* 4 MB default */
948 int64_t size
= qemu_strtosz(s
->sizearg
, &end
);
949 if (size
< 0 || (size_t)size
!= size
|| *end
!= '\0'
950 || !is_power_of_2(size
)) {
951 error_setg(errp
, "Invalid size %s", s
->sizearg
);
954 s
->legacy_size
= size
;
957 /* check that role is reasonable */
959 if (strncmp(s
->role
, "peer", 5) == 0) {
960 s
->master
= ON_OFF_AUTO_OFF
;
961 } else if (strncmp(s
->role
, "master", 7) == 0) {
962 s
->master
= ON_OFF_AUTO_ON
;
964 error_setg(errp
, "'role' must be 'peer' or 'master'");
968 s
->master
= ON_OFF_AUTO_AUTO
;
976 * Note: we don't use INTx with IVSHMEM_MSI at all, so this is a
977 * bald-faced lie then. But it's a backwards compatible lie.
979 pci_config_set_interrupt_pin(dev
->config
, 1);
981 ivshmem_common_realize(dev
, errp
);
984 static void ivshmem_exit(PCIDevice
*dev
)
986 IVShmemState
*s
= IVSHMEM_COMMON(dev
);
989 if (s
->migration_blocker
) {
990 migrate_del_blocker(s
->migration_blocker
);
991 error_free(s
->migration_blocker
);
994 if (memory_region_is_mapped(s
->ivshmem_bar2
)) {
996 void *addr
= memory_region_get_ram_ptr(s
->ivshmem_bar2
);
999 if (munmap(addr
, memory_region_size(s
->ivshmem_bar2
) == -1)) {
1000 error_report("Failed to munmap shared memory %s",
1004 fd
= qemu_get_ram_fd(memory_region_get_ram_addr(s
->ivshmem_bar2
));
1008 vmstate_unregister_ram(s
->ivshmem_bar2
, DEVICE(dev
));
1012 for (i
= 0; i
< s
->nb_peers
; i
++) {
1013 close_peer_eventfds(s
, i
);
1018 if (ivshmem_has_feature(s
, IVSHMEM_MSI
)) {
1019 msix_uninit_exclusive_bar(dev
);
1022 g_free(s
->msi_vectors
);
1025 static bool test_msix(void *opaque
, int version_id
)
1027 IVShmemState
*s
= opaque
;
1029 return ivshmem_has_feature(s
, IVSHMEM_MSI
);
1032 static bool test_no_msix(void *opaque
, int version_id
)
1034 return !test_msix(opaque
, version_id
);
1037 static int ivshmem_pre_load(void *opaque
)
1039 IVShmemState
*s
= opaque
;
1041 if (!ivshmem_is_master(s
)) {
1042 error_report("'peer' devices are not migratable");
1049 static int ivshmem_post_load(void *opaque
, int version_id
)
1051 IVShmemState
*s
= opaque
;
1053 if (ivshmem_has_feature(s
, IVSHMEM_MSI
)) {
1054 ivshmem_msix_vector_use(s
);
1059 static int ivshmem_load_old(QEMUFile
*f
, void *opaque
, int version_id
)
1061 IVShmemState
*s
= opaque
;
1062 PCIDevice
*pdev
= PCI_DEVICE(s
);
1065 IVSHMEM_DPRINTF("ivshmem_load_old\n");
1067 if (version_id
!= 0) {
1071 ret
= ivshmem_pre_load(s
);
1076 ret
= pci_device_load(pdev
, f
);
1081 if (ivshmem_has_feature(s
, IVSHMEM_MSI
)) {
1083 ivshmem_msix_vector_use(s
);
1085 s
->intrstatus
= qemu_get_be32(f
);
1086 s
->intrmask
= qemu_get_be32(f
);
1092 static const VMStateDescription ivshmem_vmsd
= {
1095 .minimum_version_id
= 1,
1096 .pre_load
= ivshmem_pre_load
,
1097 .post_load
= ivshmem_post_load
,
1098 .fields
= (VMStateField
[]) {
1099 VMSTATE_PCI_DEVICE(parent_obj
, IVShmemState
),
1101 VMSTATE_MSIX_TEST(parent_obj
, IVShmemState
, test_msix
),
1102 VMSTATE_UINT32_TEST(intrstatus
, IVShmemState
, test_no_msix
),
1103 VMSTATE_UINT32_TEST(intrmask
, IVShmemState
, test_no_msix
),
1105 VMSTATE_END_OF_LIST()
1107 .load_state_old
= ivshmem_load_old
,
1108 .minimum_version_id_old
= 0
1111 static Property ivshmem_properties
[] = {
1112 DEFINE_PROP_CHR("chardev", IVShmemState
, server_chr
),
1113 DEFINE_PROP_STRING("size", IVShmemState
, sizearg
),
1114 DEFINE_PROP_UINT32("vectors", IVShmemState
, vectors
, 1),
1115 DEFINE_PROP_BIT("ioeventfd", IVShmemState
, features
, IVSHMEM_IOEVENTFD
, false),
1116 DEFINE_PROP_BIT("msi", IVShmemState
, features
, IVSHMEM_MSI
, true),
1117 DEFINE_PROP_STRING("shm", IVShmemState
, shmobj
),
1118 DEFINE_PROP_STRING("role", IVShmemState
, role
),
1119 DEFINE_PROP_UINT32("use64", IVShmemState
, not_legacy_32bit
, 1),
1120 DEFINE_PROP_END_OF_LIST(),
1123 static void ivshmem_common_class_init(ObjectClass
*klass
, void *data
)
1125 DeviceClass
*dc
= DEVICE_CLASS(klass
);
1126 PCIDeviceClass
*k
= PCI_DEVICE_CLASS(klass
);
1128 k
->realize
= ivshmem_common_realize
;
1129 k
->exit
= ivshmem_exit
;
1130 k
->config_write
= ivshmem_write_config
;
1131 k
->vendor_id
= PCI_VENDOR_ID_IVSHMEM
;
1132 k
->device_id
= PCI_DEVICE_ID_IVSHMEM
;
1133 k
->class_id
= PCI_CLASS_MEMORY_RAM
;
1135 dc
->reset
= ivshmem_reset
;
1136 set_bit(DEVICE_CATEGORY_MISC
, dc
->categories
);
1137 dc
->desc
= "Inter-VM shared memory";
1140 static void ivshmem_class_init(ObjectClass
*klass
, void *data
)
1142 DeviceClass
*dc
= DEVICE_CLASS(klass
);
1143 PCIDeviceClass
*k
= PCI_DEVICE_CLASS(klass
);
1145 k
->realize
= ivshmem_realize
;
1147 dc
->desc
= "Inter-VM shared memory (legacy)";
1148 dc
->props
= ivshmem_properties
;
1149 dc
->vmsd
= &ivshmem_vmsd
;
1152 static void ivshmem_check_memdev_is_busy(Object
*obj
, const char *name
,
1153 Object
*val
, Error
**errp
)
1157 mr
= host_memory_backend_get_memory(MEMORY_BACKEND(val
), &error_abort
);
1158 if (memory_region_is_mapped(mr
)) {
1159 char *path
= object_get_canonical_path_component(val
);
1160 error_setg(errp
, "can't use already busy memdev: %s", path
);
1163 qdev_prop_allow_set_link_before_realize(obj
, name
, val
, errp
);
1167 static void ivshmem_init(Object
*obj
)
1169 IVShmemState
*s
= IVSHMEM(obj
);
1171 object_property_add_link(obj
, "x-memdev", TYPE_MEMORY_BACKEND
,
1172 (Object
**)&s
->hostmem
,
1173 ivshmem_check_memdev_is_busy
,
1174 OBJ_PROP_LINK_UNREF_ON_RELEASE
,
1178 static const TypeInfo ivshmem_common_info
= {
1179 .name
= TYPE_IVSHMEM_COMMON
,
1180 .parent
= TYPE_PCI_DEVICE
,
1181 .instance_size
= sizeof(IVShmemState
),
1183 .class_init
= ivshmem_common_class_init
,
1186 static const TypeInfo ivshmem_info
= {
1187 .name
= TYPE_IVSHMEM
,
1188 .parent
= TYPE_IVSHMEM_COMMON
,
1189 .instance_size
= sizeof(IVShmemState
),
1190 .instance_init
= ivshmem_init
,
1191 .class_init
= ivshmem_class_init
,
1194 static const VMStateDescription ivshmem_plain_vmsd
= {
1195 .name
= TYPE_IVSHMEM_PLAIN
,
1197 .minimum_version_id
= 0,
1198 .pre_load
= ivshmem_pre_load
,
1199 .post_load
= ivshmem_post_load
,
1200 .fields
= (VMStateField
[]) {
1201 VMSTATE_PCI_DEVICE(parent_obj
, IVShmemState
),
1202 VMSTATE_UINT32(intrstatus
, IVShmemState
),
1203 VMSTATE_UINT32(intrmask
, IVShmemState
),
1204 VMSTATE_END_OF_LIST()
1208 static Property ivshmem_plain_properties
[] = {
1209 DEFINE_PROP_ON_OFF_AUTO("master", IVShmemState
, master
, ON_OFF_AUTO_OFF
),
1210 DEFINE_PROP_END_OF_LIST(),
1213 static void ivshmem_plain_init(Object
*obj
)
1215 IVShmemState
*s
= IVSHMEM_PLAIN(obj
);
1217 object_property_add_link(obj
, "memdev", TYPE_MEMORY_BACKEND
,
1218 (Object
**)&s
->hostmem
,
1219 ivshmem_check_memdev_is_busy
,
1220 OBJ_PROP_LINK_UNREF_ON_RELEASE
,
1224 static void ivshmem_plain_class_init(ObjectClass
*klass
, void *data
)
1226 DeviceClass
*dc
= DEVICE_CLASS(klass
);
1228 dc
->props
= ivshmem_plain_properties
;
1229 dc
->vmsd
= &ivshmem_plain_vmsd
;
1232 static const TypeInfo ivshmem_plain_info
= {
1233 .name
= TYPE_IVSHMEM_PLAIN
,
1234 .parent
= TYPE_IVSHMEM_COMMON
,
1235 .instance_size
= sizeof(IVShmemState
),
1236 .instance_init
= ivshmem_plain_init
,
1237 .class_init
= ivshmem_plain_class_init
,
1240 static const VMStateDescription ivshmem_doorbell_vmsd
= {
1241 .name
= TYPE_IVSHMEM_DOORBELL
,
1243 .minimum_version_id
= 0,
1244 .pre_load
= ivshmem_pre_load
,
1245 .post_load
= ivshmem_post_load
,
1246 .fields
= (VMStateField
[]) {
1247 VMSTATE_PCI_DEVICE(parent_obj
, IVShmemState
),
1248 VMSTATE_MSIX(parent_obj
, IVShmemState
),
1249 VMSTATE_UINT32(intrstatus
, IVShmemState
),
1250 VMSTATE_UINT32(intrmask
, IVShmemState
),
1251 VMSTATE_END_OF_LIST()
1255 static Property ivshmem_doorbell_properties
[] = {
1256 DEFINE_PROP_CHR("chardev", IVShmemState
, server_chr
),
1257 DEFINE_PROP_UINT32("vectors", IVShmemState
, vectors
, 1),
1258 DEFINE_PROP_BIT("ioeventfd", IVShmemState
, features
, IVSHMEM_IOEVENTFD
,
1260 DEFINE_PROP_ON_OFF_AUTO("master", IVShmemState
, master
, ON_OFF_AUTO_OFF
),
1261 DEFINE_PROP_END_OF_LIST(),
1264 static void ivshmem_doorbell_init(Object
*obj
)
1266 IVShmemState
*s
= IVSHMEM_DOORBELL(obj
);
1268 s
->features
|= (1 << IVSHMEM_MSI
);
1269 s
->legacy_size
= SIZE_MAX
; /* whatever the server sends */
1272 static void ivshmem_doorbell_class_init(ObjectClass
*klass
, void *data
)
1274 DeviceClass
*dc
= DEVICE_CLASS(klass
);
1276 dc
->props
= ivshmem_doorbell_properties
;
1277 dc
->vmsd
= &ivshmem_doorbell_vmsd
;
1280 static const TypeInfo ivshmem_doorbell_info
= {
1281 .name
= TYPE_IVSHMEM_DOORBELL
,
1282 .parent
= TYPE_IVSHMEM_COMMON
,
1283 .instance_size
= sizeof(IVShmemState
),
1284 .instance_init
= ivshmem_doorbell_init
,
1285 .class_init
= ivshmem_doorbell_class_init
,
1288 static void ivshmem_register_types(void)
1290 type_register_static(&ivshmem_common_info
);
1291 type_register_static(&ivshmem_plain_info
);
1292 type_register_static(&ivshmem_doorbell_info
);
1293 type_register_static(&ivshmem_info
);
1296 type_init(ivshmem_register_types
)