iosignalfd is a mechanism to register PIO/MMIO regions to trigger an eventfd signal when written to by a guest. Host userspace can register any arbitrary IO address with a corresponding eventfd and then pass the eventfd to a specific end-point of interest for handling. Normal IO requires a blocking round-trip since the operation may cause side-effects in the emulated model or may return data to the caller. Therefore, an IO in KVM traps from the guest to the host, causes a VMX/SVM "heavy-weight" exit back to userspace, and is ultimately serviced by qemu's device model synchronously before returning control back to the vcpu. However, there is a subclass of IO which acts purely as a trigger for other IO (such as to kick off an out-of-band DMA request, etc). For these patterns, the synchronous call is particularly expensive since we really only want to simply get our notification transmitted asychronously and return as quickly as possible. All the sychronous infrastructure to ensure proper data-dependencies are met in the normal IO case are just unecessary overhead for signalling. This adds additional computational load on the system, as well as latency to the signalling path. Therefore, we provide a mechanism for registration of an in-kernel trigger point that allows the VCPU to only require a very brief, lightweight exit just long enough to signal an eventfd. This also means that any clients compatible with the eventfd interface (which includes userspace and kernelspace equally well) can now register to be notified. The end result should be a more flexible and higher performance notification API for the backend KVM hypervisor and perhipheral components. To test this theory, we built a test-harness called "doorbell". This module has a function called "doorbell_ring()" which simply increments a counter for each time the doorbell is signaled. It supports signalling from either an eventfd, or an ioctl(). We then wired up two paths to the doorbell: One via QEMU via a registered io region and through the doorbell ioctl(). The other is direct via iosignalfd. You can download this test harness here: ftp://ftp.novell.com/dev/ghaskins/doorbell.tar.bz2 The measured results are as follows: qemu-mmio: 110000 iops, 9.09us rtt iosignalfd-mmio: 200100 iops, 5.00us rtt iosignalfd-pio: 367300 iops, 2.72us rtt I didn't measure qemu-pio, because I have to figure out how to register a PIO region with qemu's device model, and I got lazy. However, for now we can extrapolate based on the data from the NULLIO runs of +2.56us for MMIO, and -350ns for HC, we get: qemu-pio: 153139 iops, 6.53us rtt iosignalfd-hc: 412585 iops, 2.37us rtt these are just for fun, for now, until I can gather more data. Here is a graph for your convenience: http://developer.novell.com/wiki/images/7/76/Iofd-chart.png The conclusion to draw is that we save about 4us by skipping the userspace hop. -------------------- Signed-off-by: Gregory Haskins <ghaskins@xxxxxxxxxx> --- include/linux/kvm.h | 15 ++++ include/linux/kvm_host.h | 2 + virt/kvm/eventfd.c | 154 ++++++++++++++++++++++++++++++++++++++++++++++ virt/kvm/kvm_main.c | 13 ++++ 4 files changed, 184 insertions(+), 0 deletions(-) diff --git a/include/linux/kvm.h b/include/linux/kvm.h index a1ecc6a..9372b12 100644 --- a/include/linux/kvm.h +++ b/include/linux/kvm.h @@ -292,6 +292,19 @@ struct kvm_guest_debug { struct kvm_guest_debug_arch arch; }; +#define KVM_IOSIGNALFD_FLAG_DEASSIGN (1 << 0) +#define KVM_IOSIGNALFD_FLAG_PIO (1 << 1) +#define KVM_IOSIGNALFD_FLAG_COOKIE (1 << 2) + +struct kvm_iosignalfd { + __u64 cookie; + __u64 addr; + __u32 len; + __u32 fd; + __u32 flags; + __u8 pad[12]; +}; + #define KVM_TRC_SHIFT 16 /* * kvm trace categories @@ -416,6 +429,7 @@ struct kvm_trace_rec { /* Another bug in KVM_SET_USER_MEMORY_REGION fixed: */ #define KVM_CAP_JOIN_MEMORY_REGIONS_WORKS 30 #define KVM_CAP_IRQFD 31 +#define KVM_CAP_IOSIGNALFD 32 #ifdef KVM_CAP_IRQ_ROUTING @@ -509,6 +523,7 @@ struct kvm_irqfd { _IOW(KVMIO, 0x74, struct kvm_assigned_msix_entry) #define KVM_DEASSIGN_DEV_IRQ _IOW(KVMIO, 0x75, struct kvm_assigned_irq) #define KVM_IRQFD _IOW(KVMIO, 0x76, struct kvm_irqfd) +#define KVM_IOSIGNALFD _IOW(KVMIO, 0x77, struct kvm_iosignalfd) /* * ioctls for vcpu fds diff --git a/include/linux/kvm_host.h b/include/linux/kvm_host.h index 214089f..4e4b174 100644 --- a/include/linux/kvm_host.h +++ b/include/linux/kvm_host.h @@ -137,6 +137,7 @@ struct kvm { struct kvm_io_bus mmio_bus; struct kvm_io_bus pio_bus; struct list_head irqfds; + struct list_head iosignalfds; struct kvm_vm_stat stat; struct kvm_arch arch; atomic_t users_count; @@ -530,5 +531,6 @@ static inline void kvm_free_irq_routing(struct kvm *kvm) {} int kvm_irqfd(struct kvm *kvm, int fd, int gsi, int flags); void kvm_irqfd_release(struct kvm *kvm); +int kvm_iosignalfd(struct kvm *kvm, struct kvm_iosignalfd *args); #endif diff --git a/virt/kvm/eventfd.c b/virt/kvm/eventfd.c index 884df16..8e726c3 100644 --- a/virt/kvm/eventfd.c +++ b/virt/kvm/eventfd.c @@ -21,12 +21,16 @@ */ #include <linux/kvm_host.h> +#include <linux/kvm.h> #include <linux/workqueue.h> #include <linux/syscalls.h> #include <linux/wait.h> #include <linux/poll.h> #include <linux/file.h> #include <linux/list.h> +#include <linux/eventfd.h> + +#include "iodev.h" /* * -------------------------------------------------------------------- @@ -196,3 +200,153 @@ kvm_irqfd_release(struct kvm *kvm) list_for_each_entry_safe(irqfd, tmp, &kvm->irqfds, list) irqfd_release(irqfd); } + +/* + * -------------------------------------------------------------------- + * iosignalfd: translate a PIO/MMIO memory write to an eventfd signal. + * + * userspace can register a PIO/MMIO address with an eventfd for recieving + * notification when the memory has been touched. + * -------------------------------------------------------------------- + */ + +struct _iosignalfd { + u64 cookie; + u64 addr; + size_t length; + struct file *file; + struct list_head list; + struct kvm_io_device dev; +}; + +static int +iosignalfd_in_range(struct kvm_io_device *this, gpa_t addr, int len, + int is_write) +{ + struct _iosignalfd *p = (struct _iosignalfd *)this->private; + + return ((addr >= p->addr && (addr < p->addr + p->length))); +} + +/* writes trigger an event */ +static void +iosignalfd_write(struct kvm_io_device *this, gpa_t addr, int len, + const void *val) +{ + struct _iosignalfd *iosignalfd = (struct _iosignalfd *)this->private; + + eventfd_signal(iosignalfd->file, 1); +} + +/* reads return all zeros */ +static void +iosignalfd_read(struct kvm_io_device *this, gpa_t addr, int len, void *val) +{ + memset(val, 0, len); +} + +static void +_iosignalfd_destructor(struct _iosignalfd *iosignalfd) +{ + fput(iosignalfd->file); + list_del(&iosignalfd->list); + + kfree(iosignalfd); +} + +static void +iosignalfd_destructor(struct kvm_io_device *this) +{ + struct _iosignalfd *iosignalfd = (struct _iosignalfd *)this->private; + + _iosignalfd_destructor(iosignalfd); +} + +static int +kvm_assign_iosignalfd(struct kvm *kvm, struct kvm_iosignalfd *args) +{ + int pio = args->flags & KVM_IOSIGNALFD_FLAG_PIO; + struct kvm_io_bus *bus = pio ? &kvm->pio_bus : &kvm->mmio_bus; + struct _iosignalfd *iosignalfd; + struct file *file; + int ret; + + file = eventfd_fget(args->fd); + if (IS_ERR(file)) + return PTR_ERR(file); + + iosignalfd = kzalloc(sizeof(*iosignalfd), GFP_KERNEL); + if (!iosignalfd) { + fput(file); + return -ENOMEM; + } + + iosignalfd->dev.read = iosignalfd_read; + iosignalfd->dev.write = iosignalfd_write; + iosignalfd->dev.in_range = iosignalfd_in_range; + iosignalfd->dev.destructor = iosignalfd_destructor; + iosignalfd->dev.private = iosignalfd; + + iosignalfd->cookie = args->cookie; + iosignalfd->addr = args->addr; + iosignalfd->length = args->len; + iosignalfd->file = file; + INIT_LIST_HEAD(&iosignalfd->list); + + ret = kvm_io_bus_register_dev(bus, &iosignalfd->dev); + if (ret < 0) + goto fail; + + printk(KERN_DEBUG "registering %s iosignalfd at %llx of size %d\n", + pio ? "PIO" : "MMIO", args->addr, (int)args->len); + + mutex_lock(&kvm->lock); + list_add_tail(&iosignalfd->list, &kvm->iosignalfds); + mutex_unlock(&kvm->lock); + + return 0; + +fail: + /* + * This doesn't take a lock, but the failure case will never result + * in the list being populated anyway + */ + _iosignalfd_destructor(iosignalfd); + + return ret; +} + +static int +kvm_deassign_iosignalfd(struct kvm *kvm, struct kvm_iosignalfd *args) +{ + int pio = args->flags & KVM_IOSIGNALFD_FLAG_PIO; + struct kvm_io_bus *bus = pio ? &kvm->pio_bus : &kvm->mmio_bus; + struct _iosignalfd *iosignalfd, *tmp; + + mutex_lock(&kvm->lock); + + list_for_each_entry_safe(iosignalfd, tmp, &kvm->iosignalfds, list) { + if (iosignalfd->addr != args->addr) + continue; + + if ((args->flags & KVM_IOSIGNALFD_FLAG_COOKIE) && + (iosignalfd->cookie != args->cookie)) + continue; + + kvm_io_bus_unregister_dev(bus, &iosignalfd->dev); + _iosignalfd_destructor(iosignalfd); + } + + mutex_unlock(&kvm->lock); + + return 0; +} + +int +kvm_iosignalfd(struct kvm *kvm, struct kvm_iosignalfd *args) +{ + if (args->flags & KVM_IOSIGNALFD_FLAG_DEASSIGN) + return kvm_deassign_iosignalfd(kvm, args); + + return kvm_assign_iosignalfd(kvm, args); +} diff --git a/virt/kvm/kvm_main.c b/virt/kvm/kvm_main.c index 5f5e443..a381dd0 100644 --- a/virt/kvm/kvm_main.c +++ b/virt/kvm/kvm_main.c @@ -984,6 +984,7 @@ static struct kvm *kvm_create_vm(void) spin_lock_init(&kvm->mmu_lock); kvm_io_bus_init(&kvm->pio_bus); INIT_LIST_HEAD(&kvm->irqfds); + INIT_LIST_HEAD(&kvm->iosignalfds); mutex_init(&kvm->lock); kvm_io_bus_init(&kvm->mmio_bus); init_rwsem(&kvm->slots_lock); @@ -2219,6 +2220,18 @@ static long kvm_vm_ioctl(struct file *filp, r = kvm_irqfd(kvm, data.fd, data.gsi, data.flags); break; } + case KVM_IOSIGNALFD: { + struct kvm_iosignalfd entry; + + r = -EFAULT; + if (copy_from_user(&entry, argp, sizeof entry)) + goto out; + + r = kvm_iosignalfd(kvm, &entry); + if (r) + goto out; + break; + } default: r = kvm_arch_vm_ioctl(filp, ioctl, arg); } -- To unsubscribe from this list: send the line "unsubscribe kvm" in the body of a message to majordomo@xxxxxxxxxxxxxxx More majordomo info at http://vger.kernel.org/majordomo-info.html
