drivers/xen/evtchn.c

   1 /******************************************************************************
   2  * evtchn.c
   3  *
   4  * Driver for receiving and demuxing event-channel signals.
   5  *
   6  * Copyright (c) 2004-2005, K A Fraser
   7  * Multi-process extensions Copyright (c) 2004, Steven Smith
   8  *
   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:
  14  *
  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:
  21  *
  22  * The above copyright notice and this permission notice shall be included in
  23  * all copies or substantial portions of the Software.
  24  *
  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
  31  * IN THE SOFTWARE.
  32  */
  33
  34 #define pr_fmt(fmt) "xen:" KBUILD_MODNAME ": " fmt
  35
  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>
  42 #include <linux/fs.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>
  52 #include <linux/mm.h>
  53 #include <linux/vmalloc.h>
  54
  55 #include <xen/xen.h>
  56 #include <xen/events.h>
  57 #include <xen/evtchn.h>
  58 #include <asm/xen/hypervisor.h>
  59
  60 struct per_user_data {
  61         struct mutex bind_mutex; /* serialize bind/unbind operations */
  62         struct rb_root evtchns;
  63         unsigned int nr_evtchns;
  64
  65         /* Notification ring, accessed via /dev/xen/evtchn. */
  66         unsigned int ring_size;
  67         evtchn_port_t *ring;
  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 */
  71
  72         /* Processes wait on this queue when ring is empty. */
  73         wait_queue_head_t evtchn_wait;
  74         struct fasync_struct *evtchn_async_queue;
  75         const char *name;
  76 };
  77
  78 struct user_evtchn {
  79         struct rb_node node;
  80         struct per_user_data *user;
  81         unsigned port;
  82         bool enabled;
  83 };
  84
  85 static evtchn_port_t *evtchn_alloc_ring(unsigned int size)
  86 {
  87         evtchn_port_t *ring;
  88         size_t s = size * sizeof(*ring);
  89
  90         ring = kmalloc(s, GFP_KERNEL);
  91         if (!ring)
  92                 ring = vmalloc(s);
  93
  94         return ring;
  95 }
  96
  97 static void evtchn_free_ring(evtchn_port_t *ring)
  98 {
  99         kvfree(ring);
 100 }
 101
 102 static unsigned int evtchn_ring_offset(struct per_user_data *u,
 103                                        unsigned int idx)
 104 {
 105         return idx & (u->ring_size - 1);
 106 }
 107
 108 static evtchn_port_t *evtchn_ring_entry(struct per_user_data *u,
 109                                         unsigned int idx)
 110 {
 111         return u->ring + evtchn_ring_offset(u, idx);
 112 }
 113
 114 static int add_evtchn(struct per_user_data *u, struct user_evtchn *evtchn)
 115 {
 116         struct rb_node **new = &(u->evtchns.rb_node), *parent = NULL;
 117
 118         u->nr_evtchns++;
 119
 120         while (*new) {
 121                 struct user_evtchn *this;
 122
 123                 this = container_of(*new, struct user_evtchn, node);
 124
 125                 parent = *new;
 126                 if (this->port < evtchn->port)
 127                         new = &((*new)->rb_left);
 128                 else if (this->port > evtchn->port)
 129                         new = &((*new)->rb_right);
 130                 else
 131                         return -EEXIST;
 132         }
 133
 134         /* Add new node and rebalance tree. */
 135         rb_link_node(&evtchn->node, parent, new);
 136         rb_insert_color(&evtchn->node, &u->evtchns);
 137
 138         return 0;
 139 }
 140
 141 static void del_evtchn(struct per_user_data *u, struct user_evtchn *evtchn)
 142 {
 143         u->nr_evtchns--;
 144         rb_erase(&evtchn->node, &u->evtchns);
 145         kfree(evtchn);
 146 }
 147
 148 static struct user_evtchn *find_evtchn(struct per_user_data *u, unsigned port)
 149 {
 150         struct rb_node *node = u->evtchns.rb_node;
 151
 152         while (node) {
 153                 struct user_evtchn *evtchn;
 154
 155                 evtchn = container_of(node, struct user_evtchn, node);
 156
 157                 if (evtchn->port < port)
 158                         node = node->rb_left;
 159                 else if (evtchn->port > port)
 160                         node = node->rb_right;
 161                 else
 162                         return evtchn;
 163         }
 164         return NULL;
 165 }
 166
 167 static irqreturn_t evtchn_interrupt(int irq, void *data)
 168 {
 169         struct user_evtchn *evtchn = data;
 170         struct per_user_data *u = evtchn->user;
 171
 172         WARN(!evtchn->enabled,
 173              "Interrupt for port %d, but apparently not enabled; per-user %p\n",
 174              evtchn->port, u);
 175
 176         evtchn->enabled = false;
 177
 178         spin_lock(&u->ring_prod_lock);
 179
 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,
 186                                     SIGIO, POLL_IN);
 187                 }
 188         } else
 189                 u->ring_overflow = 1;
 190
 191         spin_unlock(&u->ring_prod_lock);
 192
 193         return IRQ_HANDLED;
 194 }
 195
 196 static ssize_t evtchn_read(struct file *file, char __user *buf,
 197                            size_t count, loff_t *ppos)
 198 {
 199         int rc;
 200         unsigned int c, p, bytes1 = 0, bytes2 = 0;
 201         struct per_user_data *u = file->private_data;
 202
 203         /* Whole number of ports. */
 204         count &= ~(sizeof(evtchn_port_t)-1);
 205
 206         if (count == 0)
 207                 return 0;
 208
 209         if (count > PAGE_SIZE)
 210                 count = PAGE_SIZE;
 211
 212         for (;;) {
 213                 mutex_lock(&u->ring_cons_mutex);
 214
 215                 rc = -EFBIG;
 216                 if (u->ring_overflow)
 217                         goto unlock_out;
 218
 219                 c = u->ring_cons;
 220                 p = u->ring_prod;
 221                 if (c != p)
 222                         break;
 223
 224                 mutex_unlock(&u->ring_cons_mutex);
 225
 226                 if (file->f_flags & O_NONBLOCK)
 227                         return -EAGAIN;
 228
 229                 rc = wait_event_interruptible(u->evtchn_wait,
 230                                               u->ring_cons != u->ring_prod);
 231                 if (rc)
 232                         return rc;
 233         }
 234
 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);
 240         } else {
 241                 bytes1 = (p - c) * sizeof(evtchn_port_t);
 242                 bytes2 = 0;
 243         }
 244
 245         /* Truncate chunks according to caller's maximum byte count. */
 246         if (bytes1 > count) {
 247                 bytes1 = count;
 248                 bytes2 = 0;
 249         } else if ((bytes1 + bytes2) > count) {
 250                 bytes2 = count - bytes1;
 251         }
 252
 253         rc = -EFAULT;
 254         rmb(); /* Ensure that we see the port before we copy it. */
 255         if (copy_to_user(buf, evtchn_ring_entry(u, c), bytes1) ||
 256             ((bytes2 != 0) &&
 257              copy_to_user(&buf[bytes1], &u->ring[0], bytes2)))
 258                 goto unlock_out;
 259
 260         u->ring_cons += (bytes1 + bytes2) / sizeof(evtchn_port_t);
 261         rc = bytes1 + bytes2;
 262
 263  unlock_out:
 264         mutex_unlock(&u->ring_cons_mutex);
 265         return rc;
 266 }
 267
 268 static ssize_t evtchn_write(struct file *file, const char __user *buf,
 269                             size_t count, loff_t *ppos)
 270 {
 271         int rc, i;
 272         evtchn_port_t *kbuf = (evtchn_port_t *)__get_free_page(GFP_KERNEL);
 273         struct per_user_data *u = file->private_data;
 274
 275         if (kbuf == NULL)
 276                 return -ENOMEM;
 277
 278         /* Whole number of ports. */
 279         count &= ~(sizeof(evtchn_port_t)-1);
 280
 281         rc = 0;
 282         if (count == 0)
 283                 goto out;
 284
 285         if (count > PAGE_SIZE)
 286                 count = PAGE_SIZE;
 287
 288         rc = -EFAULT;
 289         if (copy_from_user(kbuf, buf, count) != 0)
 290                 goto out;
 291
 292         mutex_lock(&u->bind_mutex);
 293
 294         for (i = 0; i < (count/sizeof(evtchn_port_t)); i++) {
 295                 unsigned port = kbuf[i];
 296                 struct user_evtchn *evtchn;
 297
 298                 evtchn = find_evtchn(u, port);
 299                 if (evtchn && !evtchn->enabled) {
 300                         evtchn->enabled = true;
 301                         xen_irq_lateeoi(irq_from_evtchn(port), 0);
 302                 }
 303         }
 304
 305         mutex_unlock(&u->bind_mutex);
 306
 307         rc = count;
 308
 309  out:
 310         free_page((unsigned long)kbuf);
 311         return rc;
 312 }
 313
 314 static int evtchn_resize_ring(struct per_user_data *u)
 315 {
 316         unsigned int new_size;
 317         evtchn_port_t *new_ring, *old_ring;
 318
 319         /*
 320          * Ensure the ring is large enough to capture all possible
 321          * events. i.e., one free slot for each bound event.
 322          */
 323         if (u->nr_evtchns <= u->ring_size)
 324                 return 0;
 325
 326         if (u->ring_size == 0)
 327                 new_size = 64;
 328         else
 329                 new_size = 2 * u->ring_size;
 330
 331         new_ring = evtchn_alloc_ring(new_size);
 332         if (!new_ring)
 333                 return -ENOMEM;
 334
 335         old_ring = u->ring;
 336
 337         /*
 338          * Access to the ring contents is serialized by either the
 339          * prod /or/ cons lock so take both when resizing.
 340          */
 341         mutex_lock(&u->ring_cons_mutex);
 342         spin_lock_irq(&u->ring_prod_lock);
 343
 344         /*
 345          * Copy the old ring contents to the new ring.
 346          *
 347          * To take care of wrapping, a full ring, and the new index
 348          * pointing into the second half, simply copy the old contents
 349          * twice.
 350          *
 351          * +---------+    +------------------+
 352          * |34567  12| -> |34567  1234567  12|
 353          * +-----p-c-+    +-------c------p---+
 354          */
 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));
 358
 359         u->ring = new_ring;
 360         u->ring_size = new_size;
 361
 362         spin_unlock_irq(&u->ring_prod_lock);
 363         mutex_unlock(&u->ring_cons_mutex);
 364
 365         evtchn_free_ring(old_ring);
 366
 367         return 0;
 368 }
 369
 370 static int evtchn_bind_to_user(struct per_user_data *u, int port)
 371 {
 372         struct user_evtchn *evtchn;
 373         struct evtchn_close close;
 374         int rc = 0;
 375
 376         /*
 377          * Ports are never reused, so every caller should pass in a
 378          * unique port.
 379          *
 380          * (Locking not necessary because we haven't registered the
 381          * interrupt handler yet, and our caller has already
 382          * serialized bind operations.)
 383          */
 384
 385         evtchn = kzalloc(sizeof(*evtchn), GFP_KERNEL);
 386         if (!evtchn)
 387                 return -ENOMEM;
 388
 389         evtchn->user = u;
 390         evtchn->port = port;
 391         evtchn->enabled = true; /* start enabled */
 392
 393         rc = add_evtchn(u, evtchn);
 394         if (rc < 0)
 395                 goto err;
 396
 397         rc = evtchn_resize_ring(u);
 398         if (rc < 0)
 399                 goto err;
 400
 401         rc = bind_evtchn_to_irqhandler_lateeoi(port, evtchn_interrupt, 0,
 402                                                u->name, evtchn);
 403         if (rc < 0)
 404                 goto err;
 405
 406         rc = evtchn_make_refcounted(port);
 407         return rc;
 408
 409 err:
 410         /* bind failed, should close the port now */
 411         close.port = port;
 412         if (HYPERVISOR_event_channel_op(EVTCHNOP_close, &close) != 0)
 413                 BUG();
 414         del_evtchn(u, evtchn);
 415         return rc;
 416 }
 417
 418 static void evtchn_unbind_from_user(struct per_user_data *u,
 419                                     struct user_evtchn *evtchn)
 420 {
 421         int irq = irq_from_evtchn(evtchn->port);
 422
 423         BUG_ON(irq < 0);
 424
 425         unbind_from_irqhandler(irq, evtchn);
 426
 427         del_evtchn(u, evtchn);
 428 }
 429
 430 static long evtchn_ioctl(struct file *file,
 431                          unsigned int cmd, unsigned long arg)
 432 {
 433         int rc;
 434         struct per_user_data *u = file->private_data;
 435         void __user *uarg = (void __user *) arg;
 436
 437         /* Prevent bind from racing with unbind */
 438         mutex_lock(&u->bind_mutex);
 439
 440         switch (cmd) {
 441         case IOCTL_EVTCHN_BIND_VIRQ: {
 442                 struct ioctl_evtchn_bind_virq bind;
 443                 struct evtchn_bind_virq bind_virq;
 444
 445                 rc = -EFAULT;
 446                 if (copy_from_user(&bind, uarg, sizeof(bind)))
 447                         break;
 448
 449                 bind_virq.virq = bind.virq;
 450                 bind_virq.vcpu = 0;
 451                 rc = HYPERVISOR_event_channel_op(EVTCHNOP_bind_virq,
 452                                                  &bind_virq);
 453                 if (rc != 0)
 454                         break;
 455
 456                 rc = evtchn_bind_to_user(u, bind_virq.port);
 457                 if (rc == 0)
 458                         rc = bind_virq.port;
 459                 break;
 460         }
 461
 462         case IOCTL_EVTCHN_BIND_INTERDOMAIN: {
 463                 struct ioctl_evtchn_bind_interdomain bind;
 464                 struct evtchn_bind_interdomain bind_interdomain;
 465
 466                 rc = -EFAULT;
 467                 if (copy_from_user(&bind, uarg, sizeof(bind)))
 468                         break;
 469
 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,
 473                                                  &bind_interdomain);
 474                 if (rc != 0)
 475                         break;
 476
 477                 rc = evtchn_bind_to_user(u, bind_interdomain.local_port);
 478                 if (rc == 0)
 479                         rc = bind_interdomain.local_port;
 480                 break;
 481         }
 482
 483         case IOCTL_EVTCHN_BIND_UNBOUND_PORT: {
 484                 struct ioctl_evtchn_bind_unbound_port bind;
 485                 struct evtchn_alloc_unbound alloc_unbound;
 486
 487                 rc = -EFAULT;
 488                 if (copy_from_user(&bind, uarg, sizeof(bind)))
 489                         break;
 490
 491                 alloc_unbound.dom        = DOMID_SELF;
 492                 alloc_unbound.remote_dom = bind.remote_domain;
 493                 rc = HYPERVISOR_event_channel_op(EVTCHNOP_alloc_unbound,
 494                                                  &alloc_unbound);
 495                 if (rc != 0)
 496                         break;
 497
 498                 rc = evtchn_bind_to_user(u, alloc_unbound.port);
 499                 if (rc == 0)
 500                         rc = alloc_unbound.port;
 501                 break;
 502         }
 503
 504         case IOCTL_EVTCHN_UNBIND: {
 505                 struct ioctl_evtchn_unbind unbind;
 506                 struct user_evtchn *evtchn;
 507
 508                 rc = -EFAULT;
 509                 if (copy_from_user(&unbind, uarg, sizeof(unbind)))
 510                         break;
 511
 512                 rc = -EINVAL;
 513                 if (unbind.port >= xen_evtchn_nr_channels())
 514                         break;
 515
 516                 rc = -ENOTCONN;
 517                 evtchn = find_evtchn(u, unbind.port);
 518                 if (!evtchn)
 519                         break;
 520
 521                 disable_irq(irq_from_evtchn(unbind.port));
 522                 evtchn_unbind_from_user(u, evtchn);
 523                 rc = 0;
 524                 break;
 525         }
 526
 527         case IOCTL_EVTCHN_NOTIFY: {
 528                 struct ioctl_evtchn_notify notify;
 529                 struct user_evtchn *evtchn;
 530
 531                 rc = -EFAULT;
 532                 if (copy_from_user(&notify, uarg, sizeof(notify)))
 533                         break;
 534
 535                 rc = -ENOTCONN;
 536                 evtchn = find_evtchn(u, notify.port);
 537                 if (evtchn) {
 538                         notify_remote_via_evtchn(notify.port);
 539                         rc = 0;
 540                 }
 541                 break;
 542         }
 543
 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);
 551                 rc = 0;
 552                 break;
 553         }
 554
 555         default:
 556                 rc = -ENOSYS;
 557                 break;
 558         }
 559         mutex_unlock(&u->bind_mutex);
 560
 561         return rc;
 562 }
 563
 564 static unsigned int evtchn_poll(struct file *file, poll_table *wait)
 565 {
 566         unsigned int mask = POLLOUT | POLLWRNORM;
 567         struct per_user_data *u = file->private_data;
 568
 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)
 573                 mask = POLLERR;
 574         return mask;
 575 }
 576
 577 static int evtchn_fasync(int fd, struct file *filp, int on)
 578 {
 579         struct per_user_data *u = filp->private_data;
 580         return fasync_helper(fd, filp, on, &u->evtchn_async_queue);
 581 }
 582
 583 static int evtchn_open(struct inode *inode, struct file *filp)
 584 {
 585         struct per_user_data *u;
 586
 587         u = kzalloc(sizeof(*u), GFP_KERNEL);
 588         if (u == NULL)
 589                 return -ENOMEM;
 590
 591         u->name = kasprintf(GFP_KERNEL, "evtchn:%s", current->comm);
 592         if (u->name == NULL) {
 593                 kfree(u);
 594                 return -ENOMEM;
 595         }
 596
 597         init_waitqueue_head(&u->evtchn_wait);
 598
 599         mutex_init(&u->bind_mutex);
 600         mutex_init(&u->ring_cons_mutex);
 601         spin_lock_init(&u->ring_prod_lock);
 602
 603         filp->private_data = u;
 604
 605         return nonseekable_open(inode, filp);
 606 }
 607
 608 static int evtchn_release(struct inode *inode, struct file *filp)
 609 {
 610         struct per_user_data *u = filp->private_data;
 611         struct rb_node *node;
 612
 613         while ((node = u->evtchns.rb_node)) {
 614                 struct user_evtchn *evtchn;
 615
 616                 evtchn = rb_entry(node, struct user_evtchn, node);
 617                 disable_irq(irq_from_evtchn(evtchn->port));
 618                 evtchn_unbind_from_user(u, evtchn);
 619         }
 620
 621         evtchn_free_ring(u->ring);
 622         kfree(u->name);
 623         kfree(u);
 624
 625         return 0;
 626 }
 627
 628 static const struct file_operations evtchn_fops = {
 629         .owner   = THIS_MODULE,
 630         .read    = evtchn_read,
 631         .write   = evtchn_write,
 632         .unlocked_ioctl = evtchn_ioctl,
 633         .poll    = evtchn_poll,
 634         .fasync  = evtchn_fasync,
 635         .open    = evtchn_open,
 636         .release = evtchn_release,
 637         .llseek  = no_llseek,
 638 };
 639
 640 static struct miscdevice evtchn_miscdev = {
 641         .minor        = MISC_DYNAMIC_MINOR,
 642         .name         = "xen/evtchn",
 643         .fops         = &evtchn_fops,
 644 };
 645 static int __init evtchn_init(void)
 646 {
 647         int err;
 648
 649         if (!xen_domain())
 650                 return -ENODEV;
 651
 652         /* Create '/dev/xen/evtchn'. */
 653         err = misc_register(&evtchn_miscdev);
 654         if (err != 0) {
 655                 pr_err("Could not register /dev/xen/evtchn\n");
 656                 return err;
 657         }
 658
 659         pr_info("Event-channel device installed\n");
 660
 661         return 0;
 662 }
 663
 664 static void __exit evtchn_cleanup(void)
 665 {
 666         misc_deregister(&evtchn_miscdev);
 667 }
 668
 669 module_init(evtchn_init);
 670 module_exit(evtchn_cleanup);
 671
 672 MODULE_LICENSE("GPL");