drivers/xen/gntdev.c

   1 /******************************************************************************
   2  * gntdev.c
   3  *
   4  * Device for accessing (in user-space) pages that have been granted by other
   5  * domains.
   6  *
   7  * Copyright (c) 2006-2007, D G Murray.
   8  *           (c) 2009 Gerd Hoffmann <kraxel@redhat.com>
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  18  */
  19
  20 #undef DEBUG
  21
  22 #define pr_fmt(fmt) "xen:" KBUILD_MODNAME ": " fmt
  23
  24 #include <linux/module.h>
  25 #include <linux/kernel.h>
  26 #include <linux/init.h>
  27 #include <linux/miscdevice.h>
  28 #include <linux/fs.h>
  29 #include <linux/mm.h>
  30 #include <linux/mman.h>
  31 #include <linux/mmu_notifier.h>
  32 #include <linux/types.h>
  33 #include <linux/uaccess.h>
  34 #include <linux/sched.h>
  35 #include <linux/spinlock.h>
  36 #include <linux/slab.h>
  37 #include <linux/highmem.h>
  38
  39 #include <xen/xen.h>
  40 #include <xen/grant_table.h>
  41 #include <xen/balloon.h>
  42 #include <xen/gntdev.h>
  43 #include <xen/events.h>
  44 #include <xen/page.h>
  45 #include <asm/xen/hypervisor.h>
  46 #include <asm/xen/hypercall.h>
  47
  48 MODULE_LICENSE("GPL");
  49 MODULE_AUTHOR("Derek G. Murray <Derek.Murray@cl.cam.ac.uk>, "
  50               "Gerd Hoffmann <kraxel@redhat.com>");
  51 MODULE_DESCRIPTION("User-space granted page access driver");
  52
  53 static int limit = 1024*1024;
  54 module_param(limit, int, 0644);
  55 MODULE_PARM_DESC(limit, "Maximum number of grants that may be mapped by "
  56                 "the gntdev device");
  57
  58 static atomic_t pages_mapped = ATOMIC_INIT(0);
  59
  60 static int use_ptemod;
  61 #define populate_freeable_maps use_ptemod
  62
  63 struct gntdev_priv {
  64         /* maps with visible offsets in the file descriptor */
  65         struct list_head maps;
  66         /* maps that are not visible; will be freed on munmap.
  67          * Only populated if populate_freeable_maps == 1 */
  68         struct list_head freeable_maps;
  69         /* lock protects maps and freeable_maps */
  70         struct mutex lock;
  71         struct mm_struct *mm;
  72         struct mmu_notifier mn;
  73 };
  74
  75 struct unmap_notify {
  76         int flags;
  77         /* Address relative to the start of the grant_map */
  78         int addr;
  79         int event;
  80 };
  81
  82 struct grant_map {
  83         struct list_head next;
  84         struct vm_area_struct *vma;
  85         int index;
  86         int count;
  87         int flags;
  88         atomic_t users;
  89         struct unmap_notify notify;
  90         struct ioctl_gntdev_grant_ref *grants;
  91         struct gnttab_map_grant_ref   *map_ops;
  92         struct gnttab_unmap_grant_ref *unmap_ops;
  93         struct gnttab_map_grant_ref   *kmap_ops;
  94         struct gnttab_unmap_grant_ref *kunmap_ops;
  95         struct page **pages;
  96         unsigned long pages_vm_start;
  97 };
  98
  99 static int unmap_grant_pages(struct grant_map *map, int offset, int pages);
 100
 101 /* ------------------------------------------------------------------ */
 102
 103 static void gntdev_print_maps(struct gntdev_priv *priv,
 104                               char *text, int text_index)
 105 {
 106 #ifdef DEBUG
 107         struct grant_map *map;
 108
 109         pr_debug("%s: maps list (priv %p)\n", __func__, priv);
 110         list_for_each_entry(map, &priv->maps, next)
 111                 pr_debug("  index %2d, count %2d %s\n",
 112                        map->index, map->count,
 113                        map->index == text_index && text ? text : "");
 114 #endif
 115 }
 116
 117 static void gntdev_free_map(struct grant_map *map)
 118 {
 119         if (map == NULL)
 120                 return;
 121
 122         if (map->pages)
 123                 gnttab_free_pages(map->count, map->pages);
 124         kfree(map->pages);
 125         kfree(map->grants);
 126         kfree(map->map_ops);
 127         kfree(map->unmap_ops);
 128         kfree(map->kmap_ops);
 129         kfree(map->kunmap_ops);
 130         kfree(map);
 131 }
 132
 133 static struct grant_map *gntdev_alloc_map(struct gntdev_priv *priv, int count)
 134 {
 135         struct grant_map *add;
 136         int i;
 137
 138         add = kzalloc(sizeof(struct grant_map), GFP_KERNEL);
 139         if (NULL == add)
 140                 return NULL;
 141
 142         add->grants    = kcalloc(count, sizeof(add->grants[0]), GFP_KERNEL);
 143         add->map_ops   = kcalloc(count, sizeof(add->map_ops[0]), GFP_KERNEL);
 144         add->unmap_ops = kcalloc(count, sizeof(add->unmap_ops[0]), GFP_KERNEL);
 145         add->kmap_ops  = kcalloc(count, sizeof(add->kmap_ops[0]), GFP_KERNEL);
 146         add->kunmap_ops = kcalloc(count, sizeof(add->kunmap_ops[0]), GFP_KERNEL);
 147         add->pages     = kcalloc(count, sizeof(add->pages[0]), GFP_KERNEL);
 148         if (NULL == add->grants    ||
 149             NULL == add->map_ops   ||
 150             NULL == add->unmap_ops ||
 151             NULL == add->kmap_ops  ||
 152             NULL == add->kunmap_ops ||
 153             NULL == add->pages)
 154                 goto err;
 155
 156         if (gnttab_alloc_pages(count, add->pages))
 157                 goto err;
 158
 159         for (i = 0; i < count; i++) {
 160                 add->map_ops[i].handle = -1;
 161                 add->unmap_ops[i].handle = -1;
 162                 add->kmap_ops[i].handle = -1;
 163                 add->kunmap_ops[i].handle = -1;
 164         }
 165
 166         add->index = 0;
 167         add->count = count;
 168         atomic_set(&add->users, 1);
 169
 170         return add;
 171
 172 err:
 173         gntdev_free_map(add);
 174         return NULL;
 175 }
 176
 177 static void gntdev_add_map(struct gntdev_priv *priv, struct grant_map *add)
 178 {
 179         struct grant_map *map;
 180
 181         list_for_each_entry(map, &priv->maps, next) {
 182                 if (add->index + add->count < map->index) {
 183                         list_add_tail(&add->next, &map->next);
 184                         goto done;
 185                 }
 186                 add->index = map->index + map->count;
 187         }
 188         list_add_tail(&add->next, &priv->maps);
 189
 190 done:
 191         gntdev_print_maps(priv, "[new]", add->index);
 192 }
 193
 194 static struct grant_map *gntdev_find_map_index(struct gntdev_priv *priv,
 195                 int index, int count)
 196 {
 197         struct grant_map *map;
 198
 199         list_for_each_entry(map, &priv->maps, next) {
 200                 if (map->index != index)
 201                         continue;
 202                 if (count && map->count != count)
 203                         continue;
 204                 return map;
 205         }
 206         return NULL;
 207 }
 208
 209 static void gntdev_put_map(struct gntdev_priv *priv, struct grant_map *map)
 210 {
 211         if (!map)
 212                 return;
 213
 214         if (!atomic_dec_and_test(&map->users))
 215                 return;
 216
 217         atomic_sub(map->count, &pages_mapped);
 218
 219         if (map->notify.flags & UNMAP_NOTIFY_SEND_EVENT) {
 220                 notify_remote_via_evtchn(map->notify.event);
 221                 evtchn_put(map->notify.event);
 222         }
 223
 224         if (populate_freeable_maps && priv) {
 225                 mutex_lock(&priv->lock);
 226                 list_del(&map->next);
 227                 mutex_unlock(&priv->lock);
 228         }
 229
 230         if (map->pages && !use_ptemod)
 231                 unmap_grant_pages(map, 0, map->count);
 232         gntdev_free_map(map);
 233 }
 234
 235 /* ------------------------------------------------------------------ */
 236
 237 static int find_grant_ptes(pte_t *pte, pgtable_t token,
 238                 unsigned long addr, void *data)
 239 {
 240         struct grant_map *map = data;
 241         unsigned int pgnr = (addr - map->vma->vm_start) >> PAGE_SHIFT;
 242         int flags = map->flags | GNTMAP_application_map | GNTMAP_contains_pte;
 243         u64 pte_maddr;
 244
 245         BUG_ON(pgnr >= map->count);
 246         pte_maddr = arbitrary_virt_to_machine(pte).maddr;
 247
 248         /*
 249          * Set the PTE as special to force get_user_pages_fast() fall
 250          * back to the slow path.  If this is not supported as part of
 251          * the grant map, it will be done afterwards.
 252          */
 253         if (xen_feature(XENFEAT_gnttab_map_avail_bits))
 254                 flags |= (1 << _GNTMAP_guest_avail0);
 255
 256         gnttab_set_map_op(&map->map_ops[pgnr], pte_maddr, flags,
 257                           map->grants[pgnr].ref,
 258                           map->grants[pgnr].domid);
 259         gnttab_set_unmap_op(&map->unmap_ops[pgnr], pte_maddr, flags,
 260                             -1 /* handle */);
 261         return 0;
 262 }
 263
 264 #ifdef CONFIG_X86
 265 static int set_grant_ptes_as_special(pte_t *pte, pgtable_t token,
 266                                      unsigned long addr, void *data)
 267 {
 268         set_pte_at(current->mm, addr, pte, pte_mkspecial(*pte));
 269         return 0;
 270 }
 271 #endif
 272
 273 static int map_grant_pages(struct grant_map *map)
 274 {
 275         int i, err = 0;
 276
 277         if (!use_ptemod) {
 278                 /* Note: it could already be mapped */
 279                 if (map->map_ops[0].handle != -1)
 280                         return 0;
 281                 for (i = 0; i < map->count; i++) {
 282                         unsigned long addr = (unsigned long)
 283                                 pfn_to_kaddr(page_to_pfn(map->pages[i]));
 284                         gnttab_set_map_op(&map->map_ops[i], addr, map->flags,
 285                                 map->grants[i].ref,
 286                                 map->grants[i].domid);
 287                         gnttab_set_unmap_op(&map->unmap_ops[i], addr,
 288                                 map->flags, -1 /* handle */);
 289                 }
 290         } else {
 291                 /*
 292                  * Setup the map_ops corresponding to the pte entries pointing
 293                  * to the kernel linear addresses of the struct pages.
 294                  * These ptes are completely different from the user ptes dealt
 295                  * with find_grant_ptes.
 296                  * Note that GNTMAP_device_map isn't needed here: The
 297                  * dev_bus_addr output field gets consumed only from ->map_ops,
 298                  * and by not requesting it when mapping we also avoid needing
 299                  * to mirror dev_bus_addr into ->unmap_ops (and holding an extra
 300                  * reference to the page in the hypervisor).
 301                  */
 302                 unsigned int flags = (map->flags & ~GNTMAP_device_map) |
 303                                      GNTMAP_host_map;
 304
 305                 for (i = 0; i < map->count; i++) {
 306                         unsigned long address = (unsigned long)
 307                                 pfn_to_kaddr(page_to_pfn(map->pages[i]));
 308                         BUG_ON(PageHighMem(map->pages[i]));
 309
 310                         gnttab_set_map_op(&map->kmap_ops[i], address, flags,
 311                                 map->grants[i].ref,
 312                                 map->grants[i].domid);
 313                         gnttab_set_unmap_op(&map->kunmap_ops[i], address,
 314                                 flags, -1);
 315                 }
 316         }
 317
 318         pr_debug("map %d+%d\n", map->index, map->count);
 319         err = gnttab_map_refs(map->map_ops, use_ptemod ? map->kmap_ops : NULL,
 320                         map->pages, map->count);
 321
 322         for (i = 0; i < map->count; i++) {
 323                 if (map->map_ops[i].status == GNTST_okay)
 324                         map->unmap_ops[i].handle = map->map_ops[i].handle;
 325                 else if (!err)
 326                         err = -EINVAL;
 327
 328                 if (map->flags & GNTMAP_device_map)
 329                         map->unmap_ops[i].dev_bus_addr = map->map_ops[i].dev_bus_addr;
 330
 331                 if (use_ptemod) {
 332                         if (map->kmap_ops[i].status == GNTST_okay)
 333                                 map->kunmap_ops[i].handle = map->kmap_ops[i].handle;
 334                         else if (!err)
 335                                 err = -EINVAL;
 336                 }
 337         }
 338         return err;
 339 }
 340
 341 static int __unmap_grant_pages(struct grant_map *map, int offset, int pages)
 342 {
 343         int i, err = 0;
 344         struct gntab_unmap_queue_data unmap_data;
 345
 346         if (map->notify.flags & UNMAP_NOTIFY_CLEAR_BYTE) {
 347                 int pgno = (map->notify.addr >> PAGE_SHIFT);
 348                 if (pgno >= offset && pgno < offset + pages) {
 349                         /* No need for kmap, pages are in lowmem */
 350                         uint8_t *tmp = pfn_to_kaddr(page_to_pfn(map->pages[pgno]));
 351                         tmp[map->notify.addr & (PAGE_SIZE-1)] = 0;
 352                         map->notify.flags &= ~UNMAP_NOTIFY_CLEAR_BYTE;
 353                 }
 354         }
 355
 356         unmap_data.unmap_ops = map->unmap_ops + offset;
 357         unmap_data.kunmap_ops = use_ptemod ? map->kunmap_ops + offset : NULL;
 358         unmap_data.pages = map->pages + offset;
 359         unmap_data.count = pages;
 360
 361         err = gnttab_unmap_refs_sync(&unmap_data);
 362         if (err)
 363                 return err;
 364
 365         for (i = 0; i < pages; i++) {
 366                 if (map->unmap_ops[offset+i].status)
 367                         err = -EINVAL;
 368                 pr_debug("unmap handle=%d st=%d\n",
 369                         map->unmap_ops[offset+i].handle,
 370                         map->unmap_ops[offset+i].status);
 371                 map->unmap_ops[offset+i].handle = -1;
 372         }
 373         return err;
 374 }
 375
 376 static int unmap_grant_pages(struct grant_map *map, int offset, int pages)
 377 {
 378         int range, err = 0;
 379
 380         pr_debug("unmap %d+%d [%d+%d]\n", map->index, map->count, offset, pages);
 381
 382         /* It is possible the requested range will have a "hole" where we
 383          * already unmapped some of the grants. Only unmap valid ranges.
 384          */
 385         while (pages && !err) {
 386                 while (pages && map->unmap_ops[offset].handle == -1) {
 387                         offset++;
 388                         pages--;
 389                 }
 390                 range = 0;
 391                 while (range < pages) {
 392                         if (map->unmap_ops[offset+range].handle == -1)
 393                                 break;
 394                         range++;
 395                 }
 396                 err = __unmap_grant_pages(map, offset, range);
 397                 offset += range;
 398                 pages -= range;
 399         }
 400
 401         return err;
 402 }
 403
 404 /* ------------------------------------------------------------------ */
 405
 406 static void gntdev_vma_open(struct vm_area_struct *vma)
 407 {
 408         struct grant_map *map = vma->vm_private_data;
 409
 410         pr_debug("gntdev_vma_open %p\n", vma);
 411         atomic_inc(&map->users);
 412 }
 413
 414 static void gntdev_vma_close(struct vm_area_struct *vma)
 415 {
 416         struct grant_map *map = vma->vm_private_data;
 417         struct file *file = vma->vm_file;
 418         struct gntdev_priv *priv = file->private_data;
 419
 420         pr_debug("gntdev_vma_close %p\n", vma);
 421         if (use_ptemod) {
 422                 /* It is possible that an mmu notifier could be running
 423                  * concurrently, so take priv->lock to ensure that the vma won't
 424                  * vanishing during the unmap_grant_pages call, since we will
 425                  * spin here until that completes. Such a concurrent call will
 426                  * not do any unmapping, since that has been done prior to
 427                  * closing the vma, but it may still iterate the unmap_ops list.
 428                  */
 429                 mutex_lock(&priv->lock);
 430                 map->vma = NULL;
 431                 mutex_unlock(&priv->lock);
 432         }
 433         vma->vm_private_data = NULL;
 434         gntdev_put_map(priv, map);
 435 }
 436
 437 static struct page *gntdev_vma_find_special_page(struct vm_area_struct *vma,
 438                                                  unsigned long addr)
 439 {
 440         struct grant_map *map = vma->vm_private_data;
 441
 442         return map->pages[(addr - map->pages_vm_start) >> PAGE_SHIFT];
 443 }
 444
 445 static const struct vm_operations_struct gntdev_vmops = {
 446         .open = gntdev_vma_open,
 447         .close = gntdev_vma_close,
 448         .find_special_page = gntdev_vma_find_special_page,
 449 };
 450
 451 /* ------------------------------------------------------------------ */
 452
 453 static void unmap_if_in_range(struct grant_map *map,
 454                               unsigned long start, unsigned long end)
 455 {
 456         unsigned long mstart, mend;
 457         int err;
 458
 459         if (!map->vma)
 460                 return;
 461         if (map->vma->vm_start >= end)
 462                 return;
 463         if (map->vma->vm_end <= start)
 464                 return;
 465         mstart = max(start, map->vma->vm_start);
 466         mend   = min(end,   map->vma->vm_end);
 467         pr_debug("map %d+%d (%lx %lx), range %lx %lx, mrange %lx %lx\n",
 468                         map->index, map->count,
 469                         map->vma->vm_start, map->vma->vm_end,
 470                         start, end, mstart, mend);
 471         err = unmap_grant_pages(map,
 472                                 (mstart - map->vma->vm_start) >> PAGE_SHIFT,
 473                                 (mend - mstart) >> PAGE_SHIFT);
 474         WARN_ON(err);
 475 }
 476
 477 static void mn_invl_range_start(struct mmu_notifier *mn,
 478                                 struct mm_struct *mm,
 479                                 unsigned long start, unsigned long end)
 480 {
 481         struct gntdev_priv *priv = container_of(mn, struct gntdev_priv, mn);
 482         struct grant_map *map;
 483
 484         mutex_lock(&priv->lock);
 485         list_for_each_entry(map, &priv->maps, next) {
 486                 unmap_if_in_range(map, start, end);
 487         }
 488         list_for_each_entry(map, &priv->freeable_maps, next) {
 489                 unmap_if_in_range(map, start, end);
 490         }
 491         mutex_unlock(&priv->lock);
 492 }
 493
 494 static void mn_invl_page(struct mmu_notifier *mn,
 495                          struct mm_struct *mm,
 496                          unsigned long address)
 497 {
 498         mn_invl_range_start(mn, mm, address, address + PAGE_SIZE);
 499 }
 500
 501 static void mn_release(struct mmu_notifier *mn,
 502                        struct mm_struct *mm)
 503 {
 504         struct gntdev_priv *priv = container_of(mn, struct gntdev_priv, mn);
 505         struct grant_map *map;
 506         int err;
 507
 508         mutex_lock(&priv->lock);
 509         list_for_each_entry(map, &priv->maps, next) {
 510                 if (!map->vma)
 511                         continue;
 512                 pr_debug("map %d+%d (%lx %lx)\n",
 513                                 map->index, map->count,
 514                                 map->vma->vm_start, map->vma->vm_end);
 515                 err = unmap_grant_pages(map, /* offset */ 0, map->count);
 516                 WARN_ON(err);
 517         }
 518         list_for_each_entry(map, &priv->freeable_maps, next) {
 519                 if (!map->vma)
 520                         continue;
 521                 pr_debug("map %d+%d (%lx %lx)\n",
 522                                 map->index, map->count,
 523                                 map->vma->vm_start, map->vma->vm_end);
 524                 err = unmap_grant_pages(map, /* offset */ 0, map->count);
 525                 WARN_ON(err);
 526         }
 527         mutex_unlock(&priv->lock);
 528 }
 529
 530 static const struct mmu_notifier_ops gntdev_mmu_ops = {
 531         .release                = mn_release,
 532         .invalidate_page        = mn_invl_page,
 533         .invalidate_range_start = mn_invl_range_start,
 534 };
 535
 536 /* ------------------------------------------------------------------ */
 537
 538 static int gntdev_open(struct inode *inode, struct file *flip)
 539 {
 540         struct gntdev_priv *priv;
 541         int ret = 0;
 542
 543         priv = kzalloc(sizeof(*priv), GFP_KERNEL);
 544         if (!priv)
 545                 return -ENOMEM;
 546
 547         INIT_LIST_HEAD(&priv->maps);
 548         INIT_LIST_HEAD(&priv->freeable_maps);
 549         mutex_init(&priv->lock);
 550
 551         if (use_ptemod) {
 552                 priv->mm = get_task_mm(current);
 553                 if (!priv->mm) {
 554                         kfree(priv);
 555                         return -ENOMEM;
 556                 }
 557                 priv->mn.ops = &gntdev_mmu_ops;
 558                 ret = mmu_notifier_register(&priv->mn, priv->mm);
 559                 mmput(priv->mm);
 560         }
 561
 562         if (ret) {
 563                 kfree(priv);
 564                 return ret;
 565         }
 566
 567         flip->private_data = priv;
 568         pr_debug("priv %p\n", priv);
 569
 570         return 0;
 571 }
 572
 573 static int gntdev_release(struct inode *inode, struct file *flip)
 574 {
 575         struct gntdev_priv *priv = flip->private_data;
 576         struct grant_map *map;
 577
 578         pr_debug("priv %p\n", priv);
 579
 580         mutex_lock(&priv->lock);
 581         while (!list_empty(&priv->maps)) {
 582                 map = list_entry(priv->maps.next, struct grant_map, next);
 583                 list_del(&map->next);
 584                 gntdev_put_map(NULL /* already removed */, map);
 585         }
 586         WARN_ON(!list_empty(&priv->freeable_maps));
 587         mutex_unlock(&priv->lock);
 588
 589         if (use_ptemod)
 590                 mmu_notifier_unregister(&priv->mn, priv->mm);
 591         kfree(priv);
 592         return 0;
 593 }
 594
 595 static long gntdev_ioctl_map_grant_ref(struct gntdev_priv *priv,
 596                                        struct ioctl_gntdev_map_grant_ref __user *u)
 597 {
 598         struct ioctl_gntdev_map_grant_ref op;
 599         struct grant_map *map;
 600         int err;
 601
 602         if (copy_from_user(&op, u, sizeof(op)) != 0)
 603                 return -EFAULT;
 604         pr_debug("priv %p, add %d\n", priv, op.count);
 605         if (unlikely(op.count <= 0))
 606                 return -EINVAL;
 607
 608         err = -ENOMEM;
 609         map = gntdev_alloc_map(priv, op.count);
 610         if (!map)
 611                 return err;
 612
 613         if (unlikely(atomic_add_return(op.count, &pages_mapped) > limit)) {
 614                 pr_debug("can't map: over limit\n");
 615                 gntdev_put_map(NULL, map);
 616                 return err;
 617         }
 618
 619         if (copy_from_user(map->grants, &u->refs,
 620                            sizeof(map->grants[0]) * op.count) != 0) {
 621                 gntdev_put_map(NULL, map);
 622                 return -EFAULT;
 623         }
 624
 625         mutex_lock(&priv->lock);
 626         gntdev_add_map(priv, map);
 627         op.index = map->index << PAGE_SHIFT;
 628         mutex_unlock(&priv->lock);
 629
 630         if (copy_to_user(u, &op, sizeof(op)) != 0)
 631                 return -EFAULT;
 632
 633         return 0;
 634 }
 635
 636 static long gntdev_ioctl_unmap_grant_ref(struct gntdev_priv *priv,
 637                                          struct ioctl_gntdev_unmap_grant_ref __user *u)
 638 {
 639         struct ioctl_gntdev_unmap_grant_ref op;
 640         struct grant_map *map;
 641         int err = -ENOENT;
 642
 643         if (copy_from_user(&op, u, sizeof(op)) != 0)
 644                 return -EFAULT;
 645         pr_debug("priv %p, del %d+%d\n", priv, (int)op.index, (int)op.count);
 646
 647         mutex_lock(&priv->lock);
 648         map = gntdev_find_map_index(priv, op.index >> PAGE_SHIFT, op.count);
 649         if (map) {
 650                 list_del(&map->next);
 651                 if (populate_freeable_maps)
 652                         list_add_tail(&map->next, &priv->freeable_maps);
 653                 err = 0;
 654         }
 655         mutex_unlock(&priv->lock);
 656         if (map)
 657                 gntdev_put_map(priv, map);
 658         return err;
 659 }
 660
 661 static long gntdev_ioctl_get_offset_for_vaddr(struct gntdev_priv *priv,
 662                                               struct ioctl_gntdev_get_offset_for_vaddr __user *u)
 663 {
 664         struct ioctl_gntdev_get_offset_for_vaddr op;
 665         struct vm_area_struct *vma;
 666         struct grant_map *map;
 667         int rv = -EINVAL;
 668
 669         if (copy_from_user(&op, u, sizeof(op)) != 0)
 670                 return -EFAULT;
 671         pr_debug("priv %p, offset for vaddr %lx\n", priv, (unsigned long)op.vaddr);
 672
 673         down_read(&current->mm->mmap_sem);
 674         vma = find_vma(current->mm, op.vaddr);
 675         if (!vma || vma->vm_ops != &gntdev_vmops)
 676                 goto out_unlock;
 677
 678         map = vma->vm_private_data;
 679         if (!map)
 680                 goto out_unlock;
 681
 682         op.offset = map->index << PAGE_SHIFT;
 683         op.count = map->count;
 684         rv = 0;
 685
 686  out_unlock:
 687         up_read(&current->mm->mmap_sem);
 688
 689         if (rv == 0 && copy_to_user(u, &op, sizeof(op)) != 0)
 690                 return -EFAULT;
 691         return rv;
 692 }
 693
 694 static long gntdev_ioctl_notify(struct gntdev_priv *priv, void __user *u)
 695 {
 696         struct ioctl_gntdev_unmap_notify op;
 697         struct grant_map *map;
 698         int rc;
 699         int out_flags;
 700         unsigned int out_event;
 701
 702         if (copy_from_user(&op, u, sizeof(op)))
 703                 return -EFAULT;
 704
 705         if (op.action & ~(UNMAP_NOTIFY_CLEAR_BYTE|UNMAP_NOTIFY_SEND_EVENT))
 706                 return -EINVAL;
 707
 708         /* We need to grab a reference to the event channel we are going to use
 709          * to send the notify before releasing the reference we may already have
 710          * (if someone has called this ioctl twice). This is required so that
 711          * it is possible to change the clear_byte part of the notification
 712          * without disturbing the event channel part, which may now be the last
 713          * reference to that event channel.
 714          */
 715         if (op.action & UNMAP_NOTIFY_SEND_EVENT) {
 716                 if (evtchn_get(op.event_channel_port))
 717                         return -EINVAL;
 718         }
 719
 720         out_flags = op.action;
 721         out_event = op.event_channel_port;
 722
 723         mutex_lock(&priv->lock);
 724
 725         list_for_each_entry(map, &priv->maps, next) {
 726                 uint64_t begin = map->index << PAGE_SHIFT;
 727                 uint64_t end = (map->index + map->count) << PAGE_SHIFT;
 728                 if (op.index >= begin && op.index < end)
 729                         goto found;
 730         }
 731         rc = -ENOENT;
 732         goto unlock_out;
 733
 734  found:
 735         if ((op.action & UNMAP_NOTIFY_CLEAR_BYTE) &&
 736                         (map->flags & GNTMAP_readonly)) {
 737                 rc = -EINVAL;
 738                 goto unlock_out;
 739         }
 740
 741         out_flags = map->notify.flags;
 742         out_event = map->notify.event;
 743
 744         map->notify.flags = op.action;
 745         map->notify.addr = op.index - (map->index << PAGE_SHIFT);
 746         map->notify.event = op.event_channel_port;
 747
 748         rc = 0;
 749
 750  unlock_out:
 751         mutex_unlock(&priv->lock);
 752
 753         /* Drop the reference to the event channel we did not save in the map */
 754         if (out_flags & UNMAP_NOTIFY_SEND_EVENT)
 755                 evtchn_put(out_event);
 756
 757         return rc;
 758 }
 759
 760 #define GNTDEV_COPY_BATCH 16
 761
 762 struct gntdev_copy_batch {
 763         struct gnttab_copy ops[GNTDEV_COPY_BATCH];
 764         struct page *pages[GNTDEV_COPY_BATCH];
 765         s16 __user *status[GNTDEV_COPY_BATCH];
 766         unsigned int nr_ops;
 767         unsigned int nr_pages;
 768 };
 769
 770 static int gntdev_get_page(struct gntdev_copy_batch *batch, void __user *virt,
 771                            bool writeable, unsigned long *gfn)
 772 {
 773         unsigned long addr = (unsigned long)virt;
 774         struct page *page;
 775         unsigned long xen_pfn;
 776         int ret;
 777
 778         ret = get_user_pages_fast(addr, 1, writeable, &page);
 779         if (ret < 0)
 780                 return ret;
 781
 782         batch->pages[batch->nr_pages++] = page;
 783
 784         xen_pfn = page_to_xen_pfn(page) + XEN_PFN_DOWN(addr & ~PAGE_MASK);
 785         *gfn = pfn_to_gfn(xen_pfn);
 786
 787         return 0;
 788 }
 789
 790 static void gntdev_put_pages(struct gntdev_copy_batch *batch)
 791 {
 792         unsigned int i;
 793
 794         for (i = 0; i < batch->nr_pages; i++)
 795                 put_page(batch->pages[i]);
 796         batch->nr_pages = 0;
 797 }
 798
 799 static int gntdev_copy(struct gntdev_copy_batch *batch)
 800 {
 801         unsigned int i;
 802
 803         gnttab_batch_copy(batch->ops, batch->nr_ops);
 804         gntdev_put_pages(batch);
 805
 806         /*
 807          * For each completed op, update the status if the op failed
 808          * and all previous ops for the segment were successful.
 809          */
 810         for (i = 0; i < batch->nr_ops; i++) {
 811                 s16 status = batch->ops[i].status;
 812                 s16 old_status;
 813
 814                 if (status == GNTST_okay)
 815                         continue;
 816
 817                 if (__get_user(old_status, batch->status[i]))
 818                         return -EFAULT;
 819
 820                 if (old_status != GNTST_okay)
 821                         continue;
 822
 823                 if (__put_user(status, batch->status[i]))
 824                         return -EFAULT;
 825         }
 826
 827         batch->nr_ops = 0;
 828         return 0;
 829 }
 830
 831 static int gntdev_grant_copy_seg(struct gntdev_copy_batch *batch,
 832                                  struct gntdev_grant_copy_segment *seg,
 833                                  s16 __user *status)
 834 {
 835         uint16_t copied = 0;
 836
 837         /*
 838          * Disallow local -> local copies since there is only space in
 839          * batch->pages for one page per-op and this would be a very
 840          * expensive memcpy().
 841          */
 842         if (!(seg->flags & (GNTCOPY_source_gref | GNTCOPY_dest_gref)))
 843                 return -EINVAL;
 844
 845         /* Can't cross page if source/dest is a grant ref. */
 846         if (seg->flags & GNTCOPY_source_gref) {
 847                 if (seg->source.foreign.offset + seg->len > XEN_PAGE_SIZE)
 848                         return -EINVAL;
 849         }
 850         if (seg->flags & GNTCOPY_dest_gref) {
 851                 if (seg->dest.foreign.offset + seg->len > XEN_PAGE_SIZE)
 852                         return -EINVAL;
 853         }
 854
 855         if (put_user(GNTST_okay, status))
 856                 return -EFAULT;
 857
 858         while (copied < seg->len) {
 859                 struct gnttab_copy *op;
 860                 void __user *virt;
 861                 size_t len, off;
 862                 unsigned long gfn;
 863                 int ret;
 864
 865                 if (batch->nr_ops >= GNTDEV_COPY_BATCH) {
 866                         ret = gntdev_copy(batch);
 867                         if (ret < 0)
 868                                 return ret;
 869                 }
 870
 871                 len = seg->len - copied;
 872
 873                 op = &batch->ops[batch->nr_ops];
 874                 op->flags = 0;
 875
 876                 if (seg->flags & GNTCOPY_source_gref) {
 877                         op->source.u.ref = seg->source.foreign.ref;
 878                         op->source.domid = seg->source.foreign.domid;
 879                         op->source.offset = seg->source.foreign.offset + copied;
 880                         op->flags |= GNTCOPY_source_gref;
 881                 } else {
 882                         virt = seg->source.virt + copied;
 883                         off = (unsigned long)virt & ~XEN_PAGE_MASK;
 884                         len = min(len, (size_t)XEN_PAGE_SIZE - off);
 885
 886                         ret = gntdev_get_page(batch, virt, false, &gfn);
 887                         if (ret < 0)
 888                                 return ret;
 889
 890                         op->source.u.gmfn = gfn;
 891                         op->source.domid = DOMID_SELF;
 892                         op->source.offset = off;
 893                 }
 894
 895                 if (seg->flags & GNTCOPY_dest_gref) {
 896                         op->dest.u.ref = seg->dest.foreign.ref;
 897                         op->dest.domid = seg->dest.foreign.domid;
 898                         op->dest.offset = seg->dest.foreign.offset + copied;
 899                         op->flags |= GNTCOPY_dest_gref;
 900                 } else {
 901                         virt = seg->dest.virt + copied;
 902                         off = (unsigned long)virt & ~XEN_PAGE_MASK;
 903                         len = min(len, (size_t)XEN_PAGE_SIZE - off);
 904
 905                         ret = gntdev_get_page(batch, virt, true, &gfn);
 906                         if (ret < 0)
 907                                 return ret;
 908
 909                         op->dest.u.gmfn = gfn;
 910                         op->dest.domid = DOMID_SELF;
 911                         op->dest.offset = off;
 912                 }
 913
 914                 op->len = len;
 915                 copied += len;
 916
 917                 batch->status[batch->nr_ops] = status;
 918                 batch->nr_ops++;
 919         }
 920
 921         return 0;
 922 }
 923
 924 static long gntdev_ioctl_grant_copy(struct gntdev_priv *priv, void __user *u)
 925 {
 926         struct ioctl_gntdev_grant_copy copy;
 927         struct gntdev_copy_batch batch;
 928         unsigned int i;
 929         int ret = 0;
 930
 931         if (copy_from_user(&copy, u, sizeof(copy)))
 932                 return -EFAULT;
 933
 934         batch.nr_ops = 0;
 935         batch.nr_pages = 0;
 936
 937         for (i = 0; i < copy.count; i++) {
 938                 struct gntdev_grant_copy_segment seg;
 939
 940                 if (copy_from_user(&seg, &copy.segments[i], sizeof(seg))) {
 941                         ret = -EFAULT;
 942                         goto out;
 943                 }
 944
 945                 ret = gntdev_grant_copy_seg(&batch, &seg, &copy.segments[i].status);
 946                 if (ret < 0)
 947                         goto out;
 948
 949                 cond_resched();
 950         }
 951         if (batch.nr_ops)
 952                 ret = gntdev_copy(&batch);
 953         return ret;
 954
 955   out:
 956         gntdev_put_pages(&batch);
 957         return ret;
 958 }
 959
 960 static long gntdev_ioctl(struct file *flip,
 961                          unsigned int cmd, unsigned long arg)
 962 {
 963         struct gntdev_priv *priv = flip->private_data;
 964         void __user *ptr = (void __user *)arg;
 965
 966         switch (cmd) {
 967         case IOCTL_GNTDEV_MAP_GRANT_REF:
 968                 return gntdev_ioctl_map_grant_ref(priv, ptr);
 969
 970         case IOCTL_GNTDEV_UNMAP_GRANT_REF:
 971                 return gntdev_ioctl_unmap_grant_ref(priv, ptr);
 972
 973         case IOCTL_GNTDEV_GET_OFFSET_FOR_VADDR:
 974                 return gntdev_ioctl_get_offset_for_vaddr(priv, ptr);
 975
 976         case IOCTL_GNTDEV_SET_UNMAP_NOTIFY:
 977                 return gntdev_ioctl_notify(priv, ptr);
 978
 979         case IOCTL_GNTDEV_GRANT_COPY:
 980                 return gntdev_ioctl_grant_copy(priv, ptr);
 981
 982         default:
 983                 pr_debug("priv %p, unknown cmd %x\n", priv, cmd);
 984                 return -ENOIOCTLCMD;
 985         }
 986
 987         return 0;
 988 }
 989
 990 static int gntdev_mmap(struct file *flip, struct vm_area_struct *vma)
 991 {
 992         struct gntdev_priv *priv = flip->private_data;
 993         int index = vma->vm_pgoff;
 994         int count = vma_pages(vma);
 995         struct grant_map *map;
 996         int i, err = -EINVAL;
 997
 998         if ((vma->vm_flags & VM_WRITE) && !(vma->vm_flags & VM_SHARED))
 999                 return -EINVAL;
1000
1001         pr_debug("map %d+%d at %lx (pgoff %lx)\n",
1002                         index, count, vma->vm_start, vma->vm_pgoff);
1003
1004         mutex_lock(&priv->lock);
1005         map = gntdev_find_map_index(priv, index, count);
1006         if (!map)
1007                 goto unlock_out;
1008         if (use_ptemod && map->vma)
1009                 goto unlock_out;
1010         if (use_ptemod && priv->mm != vma->vm_mm) {
1011                 pr_warn("Huh? Other mm?\n");
1012                 goto unlock_out;
1013         }
1014
1015         atomic_inc(&map->users);
1016
1017         vma->vm_ops = &gntdev_vmops;
1018
1019         vma->vm_flags |= VM_DONTEXPAND | VM_DONTDUMP | VM_MIXEDMAP;
1020
1021         if (use_ptemod)
1022                 vma->vm_flags |= VM_DONTCOPY;
1023
1024         vma->vm_private_data = map;
1025
1026         if (use_ptemod)
1027                 map->vma = vma;
1028
1029         if (map->flags) {
1030                 if ((vma->vm_flags & VM_WRITE) &&
1031                                 (map->flags & GNTMAP_readonly))
1032                         goto out_unlock_put;
1033         } else {
1034                 map->flags = GNTMAP_host_map;
1035                 if (!(vma->vm_flags & VM_WRITE))
1036                         map->flags |= GNTMAP_readonly;
1037         }
1038
1039         mutex_unlock(&priv->lock);
1040
1041         if (use_ptemod) {
1042                 map->pages_vm_start = vma->vm_start;
1043                 err = apply_to_page_range(vma->vm_mm, vma->vm_start,
1044                                           vma->vm_end - vma->vm_start,
1045                                           find_grant_ptes, map);
1046                 if (err) {
1047                         pr_warn("find_grant_ptes() failure.\n");
1048                         goto out_put_map;
1049                 }
1050         }
1051
1052         err = map_grant_pages(map);
1053         if (err)
1054                 goto out_put_map;
1055
1056         if (!use_ptemod) {
1057                 for (i = 0; i < count; i++) {
1058                         err = vm_insert_page(vma, vma->vm_start + i*PAGE_SIZE,
1059                                 map->pages[i]);
1060                         if (err)
1061                                 goto out_put_map;
1062                 }
1063         } else {
1064 #ifdef CONFIG_X86
1065                 /*
1066                  * If the PTEs were not made special by the grant map
1067                  * hypercall, do so here.
1068                  *
1069                  * This is racy since the mapping is already visible
1070                  * to userspace but userspace should be well-behaved
1071                  * enough to not touch it until the mmap() call
1072                  * returns.
1073                  */
1074                 if (!xen_feature(XENFEAT_gnttab_map_avail_bits)) {
1075                         apply_to_page_range(vma->vm_mm, vma->vm_start,
1076                                             vma->vm_end - vma->vm_start,
1077                                             set_grant_ptes_as_special, NULL);
1078                 }
1079 #endif
1080         }
1081
1082         return 0;
1083
1084 unlock_out:
1085         mutex_unlock(&priv->lock);
1086         return err;
1087
1088 out_unlock_put:
1089         mutex_unlock(&priv->lock);
1090 out_put_map:
1091         if (use_ptemod) {
1092                 map->vma = NULL;
1093                 unmap_grant_pages(map, 0, map->count);
1094         }
1095         gntdev_put_map(priv, map);
1096         return err;
1097 }
1098
1099 static const struct file_operations gntdev_fops = {
1100         .owner = THIS_MODULE,
1101         .open = gntdev_open,
1102         .release = gntdev_release,
1103         .mmap = gntdev_mmap,
1104         .unlocked_ioctl = gntdev_ioctl
1105 };
1106
1107 static struct miscdevice gntdev_miscdev = {
1108         .minor        = MISC_DYNAMIC_MINOR,
1109         .name         = "xen/gntdev",
1110         .fops         = &gntdev_fops,
1111 };
1112
1113 /* ------------------------------------------------------------------ */
1114
1115 static int __init gntdev_init(void)
1116 {
1117         int err;
1118
1119         if (!xen_domain())
1120                 return -ENODEV;
1121
1122         use_ptemod = !xen_feature(XENFEAT_auto_translated_physmap);
1123
1124         err = misc_register(&gntdev_miscdev);
1125         if (err != 0) {
1126                 pr_err("Could not register gntdev device\n");
1127                 return err;
1128         }
1129         return 0;
1130 }
1131
1132 static void __exit gntdev_exit(void)
1133 {
1134         misc_deregister(&gntdev_miscdev);
1135 }
1136
1137 module_init(gntdev_init);
1138 module_exit(gntdev_exit);
1139
1140 /* ------------------------------------------------------------------ */