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