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.
24 #include "migration.h"
26 #include "event_notifier.h"
29 #include <sys/types.h>
31 #define IVSHMEM_IOEVENTFD 0
34 #define IVSHMEM_PEER 0
35 #define IVSHMEM_MASTER 1
37 #define IVSHMEM_REG_BAR_SIZE 0x100
39 //#define DEBUG_IVSHMEM
41 #define IVSHMEM_DPRINTF(fmt, ...) \
42 do {printf("IVSHMEM: " fmt, ## __VA_ARGS__); } while (0)
44 #define IVSHMEM_DPRINTF(fmt, ...)
49 EventNotifier
*eventfds
;
52 typedef struct EventfdEntry
{
57 typedef struct IVShmemState
{
63 CharDriverState
**eventfd_chr
;
64 CharDriverState
*server_chr
;
65 MemoryRegion ivshmem_mmio
;
67 /* We might need to register the BAR before we actually have the memory.
68 * So prepare a container MemoryRegion for the BAR immediately and
69 * add a subregion when we have the memory.
73 uint64_t ivshmem_size
; /* size of shared memory region */
74 int shm_fd
; /* shared memory file descriptor */
77 int nb_peers
; /* how many guests we have space for */
78 int max_peer
; /* maximum numbered peer */
83 EventfdEntry
*eventfd_table
;
85 Error
*migration_blocker
;
90 int role_val
; /* scalar to avoid multiple string comparisons */
93 /* registers for the Inter-VM shared memory device */
94 enum ivshmem_registers
{
101 static inline uint32_t ivshmem_has_feature(IVShmemState
*ivs
,
102 unsigned int feature
) {
103 return (ivs
->features
& (1 << feature
));
106 static inline bool is_power_of_two(uint64_t x
) {
107 return (x
& (x
- 1)) == 0;
110 /* accessing registers - based on rtl8139 */
111 static void ivshmem_update_irq(IVShmemState
*s
, int val
)
114 isr
= (s
->intrstatus
& s
->intrmask
) & 0xffffffff;
116 /* don't print ISR resets */
118 IVSHMEM_DPRINTF("Set IRQ to %d (%04x %04x)\n",
119 isr
? 1 : 0, s
->intrstatus
, s
->intrmask
);
122 qemu_set_irq(s
->dev
.irq
[0], (isr
!= 0));
125 static void ivshmem_IntrMask_write(IVShmemState
*s
, uint32_t val
)
127 IVSHMEM_DPRINTF("IntrMask write(w) val = 0x%04x\n", val
);
131 ivshmem_update_irq(s
, val
);
134 static uint32_t ivshmem_IntrMask_read(IVShmemState
*s
)
136 uint32_t ret
= s
->intrmask
;
138 IVSHMEM_DPRINTF("intrmask read(w) val = 0x%04x\n", ret
);
143 static void ivshmem_IntrStatus_write(IVShmemState
*s
, uint32_t val
)
145 IVSHMEM_DPRINTF("IntrStatus write(w) val = 0x%04x\n", val
);
149 ivshmem_update_irq(s
, val
);
153 static uint32_t ivshmem_IntrStatus_read(IVShmemState
*s
)
155 uint32_t ret
= s
->intrstatus
;
157 /* reading ISR clears all interrupts */
160 ivshmem_update_irq(s
, 0);
165 static void ivshmem_io_write(void *opaque
, target_phys_addr_t addr
,
166 uint64_t val
, unsigned size
)
168 IVShmemState
*s
= opaque
;
170 uint16_t dest
= val
>> 16;
171 uint16_t vector
= val
& 0xff;
175 IVSHMEM_DPRINTF("writing to addr " TARGET_FMT_plx
"\n", addr
);
179 ivshmem_IntrMask_write(s
, val
);
183 ivshmem_IntrStatus_write(s
, val
);
187 /* check that dest VM ID is reasonable */
188 if (dest
> s
->max_peer
) {
189 IVSHMEM_DPRINTF("Invalid destination VM ID (%d)\n", dest
);
193 /* check doorbell range */
194 if (vector
< s
->peers
[dest
].nb_eventfds
) {
195 IVSHMEM_DPRINTF("Notifying VM %d on vector %d\n", dest
, vector
);
196 event_notifier_set(&s
->peers
[dest
].eventfds
[vector
]);
200 IVSHMEM_DPRINTF("Invalid VM Doorbell VM %d\n", dest
);
204 static uint64_t ivshmem_io_read(void *opaque
, target_phys_addr_t addr
,
208 IVShmemState
*s
= opaque
;
214 ret
= ivshmem_IntrMask_read(s
);
218 ret
= ivshmem_IntrStatus_read(s
);
222 /* return my VM ID if the memory is mapped */
231 IVSHMEM_DPRINTF("why are we reading " TARGET_FMT_plx
"\n", addr
);
238 static const MemoryRegionOps ivshmem_mmio_ops
= {
239 .read
= ivshmem_io_read
,
240 .write
= ivshmem_io_write
,
241 .endianness
= DEVICE_NATIVE_ENDIAN
,
243 .min_access_size
= 4,
244 .max_access_size
= 4,
248 static void ivshmem_receive(void *opaque
, const uint8_t *buf
, int size
)
250 IVShmemState
*s
= opaque
;
252 ivshmem_IntrStatus_write(s
, *buf
);
254 IVSHMEM_DPRINTF("ivshmem_receive 0x%02x\n", *buf
);
257 static int ivshmem_can_receive(void * opaque
)
262 static void ivshmem_event(void *opaque
, int event
)
264 IVSHMEM_DPRINTF("ivshmem_event %d\n", event
);
267 static void fake_irqfd(void *opaque
, const uint8_t *buf
, int size
) {
269 EventfdEntry
*entry
= opaque
;
270 PCIDevice
*pdev
= entry
->pdev
;
272 IVSHMEM_DPRINTF("interrupt on vector %p %d\n", pdev
, entry
->vector
);
273 msix_notify(pdev
, entry
->vector
);
276 static CharDriverState
* create_eventfd_chr_device(void * opaque
, EventNotifier
*n
,
279 /* create a event character device based on the passed eventfd */
280 IVShmemState
*s
= opaque
;
281 CharDriverState
* chr
;
282 int eventfd
= event_notifier_get_fd(n
);
284 chr
= qemu_chr_open_eventfd(eventfd
);
287 fprintf(stderr
, "creating eventfd for eventfd %d failed\n", eventfd
);
291 /* if MSI is supported we need multiple interrupts */
292 if (ivshmem_has_feature(s
, IVSHMEM_MSI
)) {
293 s
->eventfd_table
[vector
].pdev
= &s
->dev
;
294 s
->eventfd_table
[vector
].vector
= vector
;
296 qemu_chr_add_handlers(chr
, ivshmem_can_receive
, fake_irqfd
,
297 ivshmem_event
, &s
->eventfd_table
[vector
]);
299 qemu_chr_add_handlers(chr
, ivshmem_can_receive
, ivshmem_receive
,
307 static int check_shm_size(IVShmemState
*s
, int fd
) {
308 /* check that the guest isn't going to try and map more memory than the
309 * the object has allocated return -1 to indicate error */
315 if (s
->ivshmem_size
> buf
.st_size
) {
317 "IVSHMEM ERROR: Requested memory size greater"
318 " than shared object size (%" PRIu64
" > %" PRIu64
")\n",
319 s
->ivshmem_size
, (uint64_t)buf
.st_size
);
326 /* create the shared memory BAR when we are not using the server, so we can
327 * create the BAR and map the memory immediately */
328 static void create_shared_memory_BAR(IVShmemState
*s
, int fd
) {
334 ptr
= mmap(0, s
->ivshmem_size
, PROT_READ
|PROT_WRITE
, MAP_SHARED
, fd
, 0);
336 memory_region_init_ram_ptr(&s
->ivshmem
, "ivshmem.bar2",
337 s
->ivshmem_size
, ptr
);
338 vmstate_register_ram(&s
->ivshmem
, &s
->dev
.qdev
);
339 memory_region_add_subregion(&s
->bar
, 0, &s
->ivshmem
);
341 /* region for shared memory */
342 pci_register_bar(&s
->dev
, 2, PCI_BASE_ADDRESS_SPACE_MEMORY
, &s
->bar
);
345 static void ivshmem_add_eventfd(IVShmemState
*s
, int posn
, int i
)
347 memory_region_add_eventfd(&s
->ivshmem_mmio
,
352 &s
->peers
[posn
].eventfds
[i
]);
355 static void ivshmem_del_eventfd(IVShmemState
*s
, int posn
, int i
)
357 memory_region_del_eventfd(&s
->ivshmem_mmio
,
362 &s
->peers
[posn
].eventfds
[i
]);
365 static void close_guest_eventfds(IVShmemState
*s
, int posn
)
367 int i
, guest_curr_max
;
369 if (!ivshmem_has_feature(s
, IVSHMEM_IOEVENTFD
)) {
373 guest_curr_max
= s
->peers
[posn
].nb_eventfds
;
375 memory_region_transaction_begin();
376 for (i
= 0; i
< guest_curr_max
; i
++) {
377 ivshmem_del_eventfd(s
, posn
, i
);
379 memory_region_transaction_commit();
380 for (i
= 0; i
< guest_curr_max
; i
++) {
381 event_notifier_cleanup(&s
->peers
[posn
].eventfds
[i
]);
384 g_free(s
->peers
[posn
].eventfds
);
385 s
->peers
[posn
].nb_eventfds
= 0;
388 /* this function increase the dynamic storage need to store data about other
390 static void increase_dynamic_storage(IVShmemState
*s
, int new_min_size
) {
394 old_nb_alloc
= s
->nb_peers
;
396 while (new_min_size
>= s
->nb_peers
)
397 s
->nb_peers
= s
->nb_peers
* 2;
399 IVSHMEM_DPRINTF("bumping storage to %d guests\n", s
->nb_peers
);
400 s
->peers
= g_realloc(s
->peers
, s
->nb_peers
* sizeof(Peer
));
402 /* zero out new pointers */
403 for (j
= old_nb_alloc
; j
< s
->nb_peers
; j
++) {
404 s
->peers
[j
].eventfds
= NULL
;
405 s
->peers
[j
].nb_eventfds
= 0;
409 static void ivshmem_read(void *opaque
, const uint8_t * buf
, int flags
)
411 IVShmemState
*s
= opaque
;
412 int incoming_fd
, tmp_fd
;
413 int guest_max_eventfd
;
416 memcpy(&incoming_posn
, buf
, sizeof(long));
417 /* pick off s->server_chr->msgfd and store it, posn should accompany msg */
418 tmp_fd
= qemu_chr_fe_get_msgfd(s
->server_chr
);
419 IVSHMEM_DPRINTF("posn is %ld, fd is %d\n", incoming_posn
, tmp_fd
);
421 /* make sure we have enough space for this guest */
422 if (incoming_posn
>= s
->nb_peers
) {
423 increase_dynamic_storage(s
, incoming_posn
);
427 /* if posn is positive and unseen before then this is our posn*/
428 if ((incoming_posn
>= 0) &&
429 (s
->peers
[incoming_posn
].eventfds
== NULL
)) {
430 /* receive our posn */
431 s
->vm_id
= incoming_posn
;
434 /* otherwise an fd == -1 means an existing guest has gone away */
435 IVSHMEM_DPRINTF("posn %ld has gone away\n", incoming_posn
);
436 close_guest_eventfds(s
, incoming_posn
);
441 /* because of the implementation of get_msgfd, we need a dup */
442 incoming_fd
= dup(tmp_fd
);
444 if (incoming_fd
== -1) {
445 fprintf(stderr
, "could not allocate file descriptor %s\n",
450 /* if the position is -1, then it's shared memory region fd */
451 if (incoming_posn
== -1) {
457 if (check_shm_size(s
, incoming_fd
) == -1) {
461 /* mmap the region and map into the BAR2 */
462 map_ptr
= mmap(0, s
->ivshmem_size
, PROT_READ
|PROT_WRITE
, MAP_SHARED
,
464 memory_region_init_ram_ptr(&s
->ivshmem
,
465 "ivshmem.bar2", s
->ivshmem_size
, map_ptr
);
466 vmstate_register_ram(&s
->ivshmem
, &s
->dev
.qdev
);
468 IVSHMEM_DPRINTF("guest h/w addr = %" PRIu64
", size = %" PRIu64
"\n",
469 s
->ivshmem_offset
, s
->ivshmem_size
);
471 memory_region_add_subregion(&s
->bar
, 0, &s
->ivshmem
);
473 /* only store the fd if it is successfully mapped */
474 s
->shm_fd
= incoming_fd
;
479 /* each guest has an array of eventfds, and we keep track of how many
480 * guests for each VM */
481 guest_max_eventfd
= s
->peers
[incoming_posn
].nb_eventfds
;
483 if (guest_max_eventfd
== 0) {
484 /* one eventfd per MSI vector */
485 s
->peers
[incoming_posn
].eventfds
= g_new(EventNotifier
, s
->vectors
);
488 /* this is an eventfd for a particular guest VM */
489 IVSHMEM_DPRINTF("eventfds[%ld][%d] = %d\n", incoming_posn
,
490 guest_max_eventfd
, incoming_fd
);
491 event_notifier_init_fd(&s
->peers
[incoming_posn
].eventfds
[guest_max_eventfd
],
494 /* increment count for particular guest */
495 s
->peers
[incoming_posn
].nb_eventfds
++;
497 /* keep track of the maximum VM ID */
498 if (incoming_posn
> s
->max_peer
) {
499 s
->max_peer
= incoming_posn
;
502 if (incoming_posn
== s
->vm_id
) {
503 s
->eventfd_chr
[guest_max_eventfd
] = create_eventfd_chr_device(s
,
504 &s
->peers
[s
->vm_id
].eventfds
[guest_max_eventfd
],
508 if (ivshmem_has_feature(s
, IVSHMEM_IOEVENTFD
)) {
509 ivshmem_add_eventfd(s
, incoming_posn
, guest_max_eventfd
);
515 /* Select the MSI-X vectors used by device.
516 * ivshmem maps events to vectors statically, so
517 * we just enable all vectors on init and after reset. */
518 static void ivshmem_use_msix(IVShmemState
* s
)
522 if (!msix_present(&s
->dev
)) {
526 for (i
= 0; i
< s
->vectors
; i
++) {
527 msix_vector_use(&s
->dev
, i
);
531 static void ivshmem_reset(DeviceState
*d
)
533 IVShmemState
*s
= DO_UPCAST(IVShmemState
, dev
.qdev
, d
);
540 static uint64_t ivshmem_get_size(IVShmemState
* s
) {
545 value
= strtoull(s
->sizearg
, &ptr
, 10);
547 case 0: case 'M': case 'm':
554 fprintf(stderr
, "qemu: invalid ram size: %s\n", s
->sizearg
);
558 /* BARs must be a power of 2 */
559 if (!is_power_of_two(value
)) {
560 fprintf(stderr
, "ivshmem: size must be power of 2\n");
567 static void ivshmem_setup_msi(IVShmemState
* s
)
569 if (msix_init_exclusive_bar(&s
->dev
, s
->vectors
, 1)) {
570 IVSHMEM_DPRINTF("msix initialization failed\n");
574 IVSHMEM_DPRINTF("msix initialized (%d vectors)\n", s
->vectors
);
576 /* allocate QEMU char devices for receiving interrupts */
577 s
->eventfd_table
= g_malloc0(s
->vectors
* sizeof(EventfdEntry
));
582 static void ivshmem_save(QEMUFile
* f
, void *opaque
)
584 IVShmemState
*proxy
= opaque
;
586 IVSHMEM_DPRINTF("ivshmem_save\n");
587 pci_device_save(&proxy
->dev
, f
);
589 if (ivshmem_has_feature(proxy
, IVSHMEM_MSI
)) {
590 msix_save(&proxy
->dev
, f
);
592 qemu_put_be32(f
, proxy
->intrstatus
);
593 qemu_put_be32(f
, proxy
->intrmask
);
598 static int ivshmem_load(QEMUFile
* f
, void *opaque
, int version_id
)
600 IVSHMEM_DPRINTF("ivshmem_load\n");
602 IVShmemState
*proxy
= opaque
;
605 if (version_id
> 0) {
609 if (proxy
->role_val
== IVSHMEM_PEER
) {
610 fprintf(stderr
, "ivshmem: 'peer' devices are not migratable\n");
614 ret
= pci_device_load(&proxy
->dev
, f
);
619 if (ivshmem_has_feature(proxy
, IVSHMEM_MSI
)) {
620 msix_load(&proxy
->dev
, f
);
621 ivshmem_use_msix(proxy
);
623 proxy
->intrstatus
= qemu_get_be32(f
);
624 proxy
->intrmask
= qemu_get_be32(f
);
630 static void ivshmem_write_config(PCIDevice
*pci_dev
, uint32_t address
,
631 uint32_t val
, int len
)
633 pci_default_write_config(pci_dev
, address
, val
, len
);
634 msix_write_config(pci_dev
, address
, val
, len
);
637 static int pci_ivshmem_init(PCIDevice
*dev
)
639 IVShmemState
*s
= DO_UPCAST(IVShmemState
, dev
, dev
);
642 if (s
->sizearg
== NULL
)
643 s
->ivshmem_size
= 4 << 20; /* 4 MB default */
645 s
->ivshmem_size
= ivshmem_get_size(s
);
648 register_savevm(&s
->dev
.qdev
, "ivshmem", 0, 0, ivshmem_save
, ivshmem_load
,
651 /* IRQFD requires MSI */
652 if (ivshmem_has_feature(s
, IVSHMEM_IOEVENTFD
) &&
653 !ivshmem_has_feature(s
, IVSHMEM_MSI
)) {
654 fprintf(stderr
, "ivshmem: ioeventfd/irqfd requires MSI\n");
658 /* check that role is reasonable */
660 if (strncmp(s
->role
, "peer", 5) == 0) {
661 s
->role_val
= IVSHMEM_PEER
;
662 } else if (strncmp(s
->role
, "master", 7) == 0) {
663 s
->role_val
= IVSHMEM_MASTER
;
665 fprintf(stderr
, "ivshmem: 'role' must be 'peer' or 'master'\n");
669 s
->role_val
= IVSHMEM_MASTER
; /* default */
672 if (s
->role_val
== IVSHMEM_PEER
) {
673 error_set(&s
->migration_blocker
, QERR_DEVICE_FEATURE_BLOCKS_MIGRATION
,
674 "peer mode", "ivshmem");
675 migrate_add_blocker(s
->migration_blocker
);
678 pci_conf
= s
->dev
.config
;
679 pci_conf
[PCI_COMMAND
] = PCI_COMMAND_IO
| PCI_COMMAND_MEMORY
;
681 pci_config_set_interrupt_pin(pci_conf
, 1);
685 memory_region_init_io(&s
->ivshmem_mmio
, &ivshmem_mmio_ops
, s
,
686 "ivshmem-mmio", IVSHMEM_REG_BAR_SIZE
);
688 /* region for registers*/
689 pci_register_bar(&s
->dev
, 0, PCI_BASE_ADDRESS_SPACE_MEMORY
,
692 memory_region_init(&s
->bar
, "ivshmem-bar2-container", s
->ivshmem_size
);
694 if ((s
->server_chr
!= NULL
) &&
695 (strncmp(s
->server_chr
->filename
, "unix:", 5) == 0)) {
696 /* if we get a UNIX socket as the parameter we will talk
697 * to the ivshmem server to receive the memory region */
699 if (s
->shmobj
!= NULL
) {
700 fprintf(stderr
, "WARNING: do not specify both 'chardev' "
701 "and 'shm' with ivshmem\n");
704 IVSHMEM_DPRINTF("using shared memory server (socket = %s)\n",
705 s
->server_chr
->filename
);
707 if (ivshmem_has_feature(s
, IVSHMEM_MSI
)) {
708 ivshmem_setup_msi(s
);
711 /* we allocate enough space for 16 guests and grow as needed */
715 /* allocate/initialize space for interrupt handling */
716 s
->peers
= g_malloc0(s
->nb_peers
* sizeof(Peer
));
718 pci_register_bar(&s
->dev
, 2,
719 PCI_BASE_ADDRESS_SPACE_MEMORY
, &s
->bar
);
721 s
->eventfd_chr
= g_malloc0(s
->vectors
* sizeof(CharDriverState
*));
723 qemu_chr_add_handlers(s
->server_chr
, ivshmem_can_receive
, ivshmem_read
,
726 /* just map the file immediately, we're not using a server */
729 if (s
->shmobj
== NULL
) {
730 fprintf(stderr
, "Must specify 'chardev' or 'shm' to ivshmem\n");
733 IVSHMEM_DPRINTF("using shm_open (shm object = %s)\n", s
->shmobj
);
735 /* try opening with O_EXCL and if it succeeds zero the memory
736 * by truncating to 0 */
737 if ((fd
= shm_open(s
->shmobj
, O_CREAT
|O_RDWR
|O_EXCL
,
738 S_IRWXU
|S_IRWXG
|S_IRWXO
)) > 0) {
739 /* truncate file to length PCI device's memory */
740 if (ftruncate(fd
, s
->ivshmem_size
) != 0) {
741 fprintf(stderr
, "ivshmem: could not truncate shared file\n");
744 } else if ((fd
= shm_open(s
->shmobj
, O_CREAT
|O_RDWR
,
745 S_IRWXU
|S_IRWXG
|S_IRWXO
)) < 0) {
746 fprintf(stderr
, "ivshmem: could not open shared file\n");
751 if (check_shm_size(s
, fd
) == -1) {
755 create_shared_memory_BAR(s
, fd
);
759 s
->dev
.config_write
= ivshmem_write_config
;
764 static void pci_ivshmem_uninit(PCIDevice
*dev
)
766 IVShmemState
*s
= DO_UPCAST(IVShmemState
, dev
, dev
);
768 if (s
->migration_blocker
) {
769 migrate_del_blocker(s
->migration_blocker
);
770 error_free(s
->migration_blocker
);
773 memory_region_destroy(&s
->ivshmem_mmio
);
774 memory_region_del_subregion(&s
->bar
, &s
->ivshmem
);
775 vmstate_unregister_ram(&s
->ivshmem
, &s
->dev
.qdev
);
776 memory_region_destroy(&s
->ivshmem
);
777 memory_region_destroy(&s
->bar
);
778 unregister_savevm(&dev
->qdev
, "ivshmem", s
);
781 static Property ivshmem_properties
[] = {
782 DEFINE_PROP_CHR("chardev", IVShmemState
, server_chr
),
783 DEFINE_PROP_STRING("size", IVShmemState
, sizearg
),
784 DEFINE_PROP_UINT32("vectors", IVShmemState
, vectors
, 1),
785 DEFINE_PROP_BIT("ioeventfd", IVShmemState
, features
, IVSHMEM_IOEVENTFD
, false),
786 DEFINE_PROP_BIT("msi", IVShmemState
, features
, IVSHMEM_MSI
, true),
787 DEFINE_PROP_STRING("shm", IVShmemState
, shmobj
),
788 DEFINE_PROP_STRING("role", IVShmemState
, role
),
789 DEFINE_PROP_END_OF_LIST(),
792 static void ivshmem_class_init(ObjectClass
*klass
, void *data
)
794 DeviceClass
*dc
= DEVICE_CLASS(klass
);
795 PCIDeviceClass
*k
= PCI_DEVICE_CLASS(klass
);
797 k
->init
= pci_ivshmem_init
;
798 k
->exit
= pci_ivshmem_uninit
;
799 k
->vendor_id
= PCI_VENDOR_ID_REDHAT_QUMRANET
;
800 k
->device_id
= 0x1110;
801 k
->class_id
= PCI_CLASS_MEMORY_RAM
;
802 dc
->reset
= ivshmem_reset
;
803 dc
->props
= ivshmem_properties
;
806 static TypeInfo ivshmem_info
= {
808 .parent
= TYPE_PCI_DEVICE
,
809 .instance_size
= sizeof(IVShmemState
),
810 .class_init
= ivshmem_class_init
,
813 static void ivshmem_register_types(void)
815 type_register_static(&ivshmem_info
);
818 type_init(ivshmem_register_types
)