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