1 /******************************************************************************
4 * Driver for receiving and demuxing event-channel signals.
6 * Copyright (c) 2004-2005, K A Fraser
7 * Multi-process extensions Copyright (c) 2004, Steven Smith
9 * This program is free software; you can redistribute it and/or
10 * modify it under the terms of the GNU General Public License version 2
11 * as published by the Free Software Foundation; or, when distributed
12 * separately from the Linux kernel or incorporated into other
13 * software packages, subject to the following license:
15 * Permission is hereby granted, free of charge, to any person obtaining a copy
16 * of this source file (the "Software"), to deal in the Software without
17 * restriction, including without limitation the rights to use, copy, modify,
18 * merge, publish, distribute, sublicense, and/or sell copies of the Software,
19 * and to permit persons to whom the Software is furnished to do so, subject to
20 * the following conditions:
22 * The above copyright notice and this permission notice shall be included in
23 * all copies or substantial portions of the Software.
25 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
26 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
27 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
28 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
29 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
30 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
34 #define pr_fmt(fmt) "xen:" KBUILD_MODNAME ": " fmt
36 #include <linux/module.h>
37 #include <linux/kernel.h>
38 #include <linux/sched.h>
39 #include <linux/slab.h>
40 #include <linux/string.h>
41 #include <linux/errno.h>
43 #include <linux/miscdevice.h>
44 #include <linux/major.h>
45 #include <linux/proc_fs.h>
46 #include <linux/stat.h>
47 #include <linux/poll.h>
48 #include <linux/irq.h>
49 #include <linux/init.h>
50 #include <linux/mutex.h>
51 #include <linux/cpu.h>
53 #include <linux/vmalloc.h>
56 #include <xen/events.h>
57 #include <xen/evtchn.h>
58 #include <asm/xen/hypervisor.h>
60 struct per_user_data {
61 struct mutex bind_mutex; /* serialize bind/unbind operations */
62 struct rb_root evtchns;
63 unsigned int nr_evtchns;
65 /* Notification ring, accessed via /dev/xen/evtchn. */
66 unsigned int ring_size;
68 unsigned int ring_cons, ring_prod, ring_overflow;
69 struct mutex ring_cons_mutex; /* protect against concurrent readers */
70 spinlock_t ring_prod_lock; /* product against concurrent interrupts */
72 /* Processes wait on this queue when ring is empty. */
73 wait_queue_head_t evtchn_wait;
74 struct fasync_struct *evtchn_async_queue;
80 struct per_user_data *user;
85 static evtchn_port_t *evtchn_alloc_ring(unsigned int size)
88 size_t s = size * sizeof(*ring);
90 ring = kmalloc(s, GFP_KERNEL);
97 static void evtchn_free_ring(evtchn_port_t *ring)
102 static unsigned int evtchn_ring_offset(struct per_user_data *u,
105 return idx & (u->ring_size - 1);
108 static evtchn_port_t *evtchn_ring_entry(struct per_user_data *u,
111 return u->ring + evtchn_ring_offset(u, idx);
114 static int add_evtchn(struct per_user_data *u, struct user_evtchn *evtchn)
116 struct rb_node **new = &(u->evtchns.rb_node), *parent = NULL;
121 struct user_evtchn *this;
123 this = container_of(*new, struct user_evtchn, node);
126 if (this->port < evtchn->port)
127 new = &((*new)->rb_left);
128 else if (this->port > evtchn->port)
129 new = &((*new)->rb_right);
134 /* Add new node and rebalance tree. */
135 rb_link_node(&evtchn->node, parent, new);
136 rb_insert_color(&evtchn->node, &u->evtchns);
141 static void del_evtchn(struct per_user_data *u, struct user_evtchn *evtchn)
144 rb_erase(&evtchn->node, &u->evtchns);
148 static struct user_evtchn *find_evtchn(struct per_user_data *u, unsigned port)
150 struct rb_node *node = u->evtchns.rb_node;
153 struct user_evtchn *evtchn;
155 evtchn = container_of(node, struct user_evtchn, node);
157 if (evtchn->port < port)
158 node = node->rb_left;
159 else if (evtchn->port > port)
160 node = node->rb_right;
167 static irqreturn_t evtchn_interrupt(int irq, void *data)
169 struct user_evtchn *evtchn = data;
170 struct per_user_data *u = evtchn->user;
172 WARN(!evtchn->enabled,
173 "Interrupt for port %d, but apparently not enabled; per-user %p\n",
176 evtchn->enabled = false;
178 spin_lock(&u->ring_prod_lock);
180 if ((u->ring_prod - u->ring_cons) < u->ring_size) {
181 *evtchn_ring_entry(u, u->ring_prod) = evtchn->port;
182 wmb(); /* Ensure ring contents visible */
183 if (u->ring_cons == u->ring_prod++) {
184 wake_up_interruptible(&u->evtchn_wait);
185 kill_fasync(&u->evtchn_async_queue,
189 u->ring_overflow = 1;
191 spin_unlock(&u->ring_prod_lock);
196 static ssize_t evtchn_read(struct file *file, char __user *buf,
197 size_t count, loff_t *ppos)
200 unsigned int c, p, bytes1 = 0, bytes2 = 0;
201 struct per_user_data *u = file->private_data;
203 /* Whole number of ports. */
204 count &= ~(sizeof(evtchn_port_t)-1);
209 if (count > PAGE_SIZE)
213 mutex_lock(&u->ring_cons_mutex);
216 if (u->ring_overflow)
224 mutex_unlock(&u->ring_cons_mutex);
226 if (file->f_flags & O_NONBLOCK)
229 rc = wait_event_interruptible(u->evtchn_wait,
230 u->ring_cons != u->ring_prod);
235 /* Byte lengths of two chunks. Chunk split (if any) is at ring wrap. */
236 if (((c ^ p) & u->ring_size) != 0) {
237 bytes1 = (u->ring_size - evtchn_ring_offset(u, c)) *
238 sizeof(evtchn_port_t);
239 bytes2 = evtchn_ring_offset(u, p) * sizeof(evtchn_port_t);
241 bytes1 = (p - c) * sizeof(evtchn_port_t);
245 /* Truncate chunks according to caller's maximum byte count. */
246 if (bytes1 > count) {
249 } else if ((bytes1 + bytes2) > count) {
250 bytes2 = count - bytes1;
254 rmb(); /* Ensure that we see the port before we copy it. */
255 if (copy_to_user(buf, evtchn_ring_entry(u, c), bytes1) ||
257 copy_to_user(&buf[bytes1], &u->ring[0], bytes2)))
260 u->ring_cons += (bytes1 + bytes2) / sizeof(evtchn_port_t);
261 rc = bytes1 + bytes2;
264 mutex_unlock(&u->ring_cons_mutex);
268 static ssize_t evtchn_write(struct file *file, const char __user *buf,
269 size_t count, loff_t *ppos)
272 evtchn_port_t *kbuf = (evtchn_port_t *)__get_free_page(GFP_KERNEL);
273 struct per_user_data *u = file->private_data;
278 /* Whole number of ports. */
279 count &= ~(sizeof(evtchn_port_t)-1);
285 if (count > PAGE_SIZE)
289 if (copy_from_user(kbuf, buf, count) != 0)
292 mutex_lock(&u->bind_mutex);
294 for (i = 0; i < (count/sizeof(evtchn_port_t)); i++) {
295 unsigned port = kbuf[i];
296 struct user_evtchn *evtchn;
298 evtchn = find_evtchn(u, port);
299 if (evtchn && !evtchn->enabled) {
300 evtchn->enabled = true;
301 xen_irq_lateeoi(irq_from_evtchn(port), 0);
305 mutex_unlock(&u->bind_mutex);
310 free_page((unsigned long)kbuf);
314 static int evtchn_resize_ring(struct per_user_data *u)
316 unsigned int new_size;
317 evtchn_port_t *new_ring, *old_ring;
320 * Ensure the ring is large enough to capture all possible
321 * events. i.e., one free slot for each bound event.
323 if (u->nr_evtchns <= u->ring_size)
326 if (u->ring_size == 0)
329 new_size = 2 * u->ring_size;
331 new_ring = evtchn_alloc_ring(new_size);
338 * Access to the ring contents is serialized by either the
339 * prod /or/ cons lock so take both when resizing.
341 mutex_lock(&u->ring_cons_mutex);
342 spin_lock_irq(&u->ring_prod_lock);
345 * Copy the old ring contents to the new ring.
347 * To take care of wrapping, a full ring, and the new index
348 * pointing into the second half, simply copy the old contents
351 * +---------+ +------------------+
352 * |34567 12| -> |34567 1234567 12|
353 * +-----p-c-+ +-------c------p---+
355 memcpy(new_ring, old_ring, u->ring_size * sizeof(*u->ring));
356 memcpy(new_ring + u->ring_size, old_ring,
357 u->ring_size * sizeof(*u->ring));
360 u->ring_size = new_size;
362 spin_unlock_irq(&u->ring_prod_lock);
363 mutex_unlock(&u->ring_cons_mutex);
365 evtchn_free_ring(old_ring);
370 static int evtchn_bind_to_user(struct per_user_data *u, int port)
372 struct user_evtchn *evtchn;
373 struct evtchn_close close;
377 * Ports are never reused, so every caller should pass in a
380 * (Locking not necessary because we haven't registered the
381 * interrupt handler yet, and our caller has already
382 * serialized bind operations.)
385 evtchn = kzalloc(sizeof(*evtchn), GFP_KERNEL);
391 evtchn->enabled = true; /* start enabled */
393 rc = add_evtchn(u, evtchn);
397 rc = evtchn_resize_ring(u);
401 rc = bind_evtchn_to_irqhandler_lateeoi(port, evtchn_interrupt, 0,
406 rc = evtchn_make_refcounted(port);
410 /* bind failed, should close the port now */
412 if (HYPERVISOR_event_channel_op(EVTCHNOP_close, &close) != 0)
414 del_evtchn(u, evtchn);
418 static void evtchn_unbind_from_user(struct per_user_data *u,
419 struct user_evtchn *evtchn)
421 int irq = irq_from_evtchn(evtchn->port);
425 unbind_from_irqhandler(irq, evtchn);
427 del_evtchn(u, evtchn);
430 static long evtchn_ioctl(struct file *file,
431 unsigned int cmd, unsigned long arg)
434 struct per_user_data *u = file->private_data;
435 void __user *uarg = (void __user *) arg;
437 /* Prevent bind from racing with unbind */
438 mutex_lock(&u->bind_mutex);
441 case IOCTL_EVTCHN_BIND_VIRQ: {
442 struct ioctl_evtchn_bind_virq bind;
443 struct evtchn_bind_virq bind_virq;
446 if (copy_from_user(&bind, uarg, sizeof(bind)))
449 bind_virq.virq = bind.virq;
451 rc = HYPERVISOR_event_channel_op(EVTCHNOP_bind_virq,
456 rc = evtchn_bind_to_user(u, bind_virq.port);
462 case IOCTL_EVTCHN_BIND_INTERDOMAIN: {
463 struct ioctl_evtchn_bind_interdomain bind;
464 struct evtchn_bind_interdomain bind_interdomain;
467 if (copy_from_user(&bind, uarg, sizeof(bind)))
470 bind_interdomain.remote_dom = bind.remote_domain;
471 bind_interdomain.remote_port = bind.remote_port;
472 rc = HYPERVISOR_event_channel_op(EVTCHNOP_bind_interdomain,
477 rc = evtchn_bind_to_user(u, bind_interdomain.local_port);
479 rc = bind_interdomain.local_port;
483 case IOCTL_EVTCHN_BIND_UNBOUND_PORT: {
484 struct ioctl_evtchn_bind_unbound_port bind;
485 struct evtchn_alloc_unbound alloc_unbound;
488 if (copy_from_user(&bind, uarg, sizeof(bind)))
491 alloc_unbound.dom = DOMID_SELF;
492 alloc_unbound.remote_dom = bind.remote_domain;
493 rc = HYPERVISOR_event_channel_op(EVTCHNOP_alloc_unbound,
498 rc = evtchn_bind_to_user(u, alloc_unbound.port);
500 rc = alloc_unbound.port;
504 case IOCTL_EVTCHN_UNBIND: {
505 struct ioctl_evtchn_unbind unbind;
506 struct user_evtchn *evtchn;
509 if (copy_from_user(&unbind, uarg, sizeof(unbind)))
513 if (unbind.port >= xen_evtchn_nr_channels())
517 evtchn = find_evtchn(u, unbind.port);
521 disable_irq(irq_from_evtchn(unbind.port));
522 evtchn_unbind_from_user(u, evtchn);
527 case IOCTL_EVTCHN_NOTIFY: {
528 struct ioctl_evtchn_notify notify;
529 struct user_evtchn *evtchn;
532 if (copy_from_user(¬ify, uarg, sizeof(notify)))
536 evtchn = find_evtchn(u, notify.port);
538 notify_remote_via_evtchn(notify.port);
544 case IOCTL_EVTCHN_RESET: {
545 /* Initialise the ring to empty. Clear errors. */
546 mutex_lock(&u->ring_cons_mutex);
547 spin_lock_irq(&u->ring_prod_lock);
548 u->ring_cons = u->ring_prod = u->ring_overflow = 0;
549 spin_unlock_irq(&u->ring_prod_lock);
550 mutex_unlock(&u->ring_cons_mutex);
559 mutex_unlock(&u->bind_mutex);
564 static unsigned int evtchn_poll(struct file *file, poll_table *wait)
566 unsigned int mask = POLLOUT | POLLWRNORM;
567 struct per_user_data *u = file->private_data;
569 poll_wait(file, &u->evtchn_wait, wait);
570 if (u->ring_cons != u->ring_prod)
571 mask |= POLLIN | POLLRDNORM;
572 if (u->ring_overflow)
577 static int evtchn_fasync(int fd, struct file *filp, int on)
579 struct per_user_data *u = filp->private_data;
580 return fasync_helper(fd, filp, on, &u->evtchn_async_queue);
583 static int evtchn_open(struct inode *inode, struct file *filp)
585 struct per_user_data *u;
587 u = kzalloc(sizeof(*u), GFP_KERNEL);
591 u->name = kasprintf(GFP_KERNEL, "evtchn:%s", current->comm);
592 if (u->name == NULL) {
597 init_waitqueue_head(&u->evtchn_wait);
599 mutex_init(&u->bind_mutex);
600 mutex_init(&u->ring_cons_mutex);
601 spin_lock_init(&u->ring_prod_lock);
603 filp->private_data = u;
605 return nonseekable_open(inode, filp);
608 static int evtchn_release(struct inode *inode, struct file *filp)
610 struct per_user_data *u = filp->private_data;
611 struct rb_node *node;
613 while ((node = u->evtchns.rb_node)) {
614 struct user_evtchn *evtchn;
616 evtchn = rb_entry(node, struct user_evtchn, node);
617 disable_irq(irq_from_evtchn(evtchn->port));
618 evtchn_unbind_from_user(u, evtchn);
621 evtchn_free_ring(u->ring);
628 static const struct file_operations evtchn_fops = {
629 .owner = THIS_MODULE,
631 .write = evtchn_write,
632 .unlocked_ioctl = evtchn_ioctl,
634 .fasync = evtchn_fasync,
636 .release = evtchn_release,
640 static struct miscdevice evtchn_miscdev = {
641 .minor = MISC_DYNAMIC_MINOR,
642 .name = "xen/evtchn",
643 .fops = &evtchn_fops,
645 static int __init evtchn_init(void)
652 /* Create '/dev/xen/evtchn'. */
653 err = misc_register(&evtchn_miscdev);
655 pr_err("Could not register /dev/xen/evtchn\n");
659 pr_info("Event-channel device installed\n");
664 static void __exit evtchn_cleanup(void)
666 misc_deregister(&evtchn_miscdev);
669 module_init(evtchn_init);
670 module_exit(evtchn_cleanup);
672 MODULE_LICENSE("GPL");