drivers/gpu/drm/ttm/ttm_bo_vm.c

   1 /**************************************************************************
   2  *
   3  * Copyright (c) 2006-2009 VMware, Inc., Palo Alto, CA., USA
   4  * All Rights Reserved.
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a
   7  * copy of this software and associated documentation files (the
   8  * "Software"), to deal in the Software without restriction, including
   9  * without limitation the rights to use, copy, modify, merge, publish,
  10  * distribute, sub license, and/or sell copies of the Software, and to
  11  * permit persons to whom the Software is furnished to do so, subject to
  12  * the following conditions:
  13  *
  14  * The above copyright notice and this permission notice (including the
  15  * next paragraph) shall be included in all copies or substantial portions
  16  * of the Software.
  17  *
  18  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  19  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  20  * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL
  21  * THE COPYRIGHT HOLDERS, AUTHORS AND/OR ITS SUPPLIERS BE LIABLE FOR ANY CLAIM,
  22  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
  23  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE
  24  * USE OR OTHER DEALINGS IN THE SOFTWARE.
  25  *
  26  **************************************************************************/
  27 /*
  28  * Authors: Thomas Hellstrom <thellstrom-at-vmware-dot-com>
  29  */
  30
  31 #define pr_fmt(fmt) "[TTM] " fmt
  32
  33 #include <drm/ttm/ttm_module.h>
  34 #include <drm/ttm/ttm_bo_driver.h>
  35 #include <drm/ttm/ttm_placement.h>
  36 #include <drm/drm_vma_manager.h>
  37 #include <linux/mm.h>
  38 #include <linux/pfn_t.h>
  39 #include <linux/rbtree.h>
  40 #include <linux/module.h>
  41 #include <linux/uaccess.h>
  42 #include <linux/mem_encrypt.h>
  43
  44 #define TTM_BO_VM_NUM_PREFAULT 16
  45
  46 static int ttm_bo_vm_fault_idle(struct ttm_buffer_object *bo,
  47                                 struct vm_fault *vmf)
  48 {
  49         int ret = 0;
  50
  51         if (likely(!bo->moving))
  52                 goto out_unlock;
  53
  54         /*
  55          * Quick non-stalling check for idle.
  56          */
  57         if (dma_fence_is_signaled(bo->moving))
  58                 goto out_clear;
  59
  60         /*
  61          * If possible, avoid waiting for GPU with mmap_sem
  62          * held.
  63          */
  64         if (vmf->flags & FAULT_FLAG_ALLOW_RETRY) {
  65                 ret = VM_FAULT_RETRY;
  66                 if (vmf->flags & FAULT_FLAG_RETRY_NOWAIT)
  67                         goto out_unlock;
  68
  69                 ttm_bo_reference(bo);
  70                 up_read(&vmf->vma->vm_mm->mmap_sem);
  71                 (void) dma_fence_wait(bo->moving, true);
  72                 ttm_bo_unreserve(bo);
  73                 ttm_bo_unref(&bo);
  74                 goto out_unlock;
  75         }
  76
  77         /*
  78          * Ordinary wait.
  79          */
  80         ret = dma_fence_wait(bo->moving, true);
  81         if (unlikely(ret != 0)) {
  82                 ret = (ret != -ERESTARTSYS) ? VM_FAULT_SIGBUS :
  83                         VM_FAULT_NOPAGE;
  84                 goto out_unlock;
  85         }
  86
  87 out_clear:
  88         dma_fence_put(bo->moving);
  89         bo->moving = NULL;
  90
  91 out_unlock:
  92         return ret;
  93 }
  94
  95 static unsigned long ttm_bo_io_mem_pfn(struct ttm_buffer_object *bo,
  96                                        unsigned long page_offset)
  97 {
  98         struct ttm_bo_device *bdev = bo->bdev;
  99
 100         if (bdev->driver->io_mem_pfn)
 101                 return bdev->driver->io_mem_pfn(bo, page_offset);
 102
 103         return ((bo->mem.bus.base + bo->mem.bus.offset) >> PAGE_SHIFT)
 104                 + page_offset;
 105 }
 106
 107 static int ttm_bo_vm_fault(struct vm_fault *vmf)
 108 {
 109         struct vm_area_struct *vma = vmf->vma;
 110         struct ttm_buffer_object *bo = (struct ttm_buffer_object *)
 111             vma->vm_private_data;
 112         struct ttm_bo_device *bdev = bo->bdev;
 113         unsigned long page_offset;
 114         unsigned long page_last;
 115         unsigned long pfn;
 116         struct ttm_tt *ttm = NULL;
 117         struct page *page;
 118         int ret;
 119         int i;
 120         unsigned long address = vmf->address;
 121         struct ttm_mem_type_manager *man =
 122                 &bdev->man[bo->mem.mem_type];
 123         struct vm_area_struct cvma;
 124
 125         /*
 126          * Work around locking order reversal in fault / nopfn
 127          * between mmap_sem and bo_reserve: Perform a trylock operation
 128          * for reserve, and if it fails, retry the fault after waiting
 129          * for the buffer to become unreserved.
 130          */
 131         ret = ttm_bo_reserve(bo, true, true, NULL);
 132         if (unlikely(ret != 0)) {
 133                 if (ret != -EBUSY)
 134                         return VM_FAULT_NOPAGE;
 135
 136                 if (vmf->flags & FAULT_FLAG_ALLOW_RETRY) {
 137                         if (!(vmf->flags & FAULT_FLAG_RETRY_NOWAIT)) {
 138                                 ttm_bo_reference(bo);
 139                                 up_read(&vmf->vma->vm_mm->mmap_sem);
 140                                 (void) ttm_bo_wait_unreserved(bo);
 141                                 ttm_bo_unref(&bo);
 142                         }
 143
 144                         return VM_FAULT_RETRY;
 145                 }
 146
 147                 /*
 148                  * If we'd want to change locking order to
 149                  * mmap_sem -> bo::reserve, we'd use a blocking reserve here
 150                  * instead of retrying the fault...
 151                  */
 152                 return VM_FAULT_NOPAGE;
 153         }
 154
 155         /*
 156          * Refuse to fault imported pages. This should be handled
 157          * (if at all) by redirecting mmap to the exporter.
 158          */
 159         if (bo->ttm && (bo->ttm->page_flags & TTM_PAGE_FLAG_SG)) {
 160                 ret = VM_FAULT_SIGBUS;
 161                 goto out_unlock;
 162         }
 163
 164         if (bdev->driver->fault_reserve_notify) {
 165                 ret = bdev->driver->fault_reserve_notify(bo);
 166                 switch (ret) {
 167                 case 0:
 168                         break;
 169                 case -EBUSY:
 170                 case -ERESTARTSYS:
 171                         ret = VM_FAULT_NOPAGE;
 172                         goto out_unlock;
 173                 default:
 174                         ret = VM_FAULT_SIGBUS;
 175                         goto out_unlock;
 176                 }
 177         }
 178
 179         /*
 180          * Wait for buffer data in transit, due to a pipelined
 181          * move.
 182          */
 183         ret = ttm_bo_vm_fault_idle(bo, vmf);
 184         if (unlikely(ret != 0)) {
 185                 if (ret == VM_FAULT_RETRY &&
 186                     !(vmf->flags & FAULT_FLAG_RETRY_NOWAIT)) {
 187                         /* The BO has already been unreserved. */
 188                         return ret;
 189                 }
 190
 191                 goto out_unlock;
 192         }
 193
 194         ret = ttm_mem_io_lock(man, true);
 195         if (unlikely(ret != 0)) {
 196                 ret = VM_FAULT_NOPAGE;
 197                 goto out_unlock;
 198         }
 199         ret = ttm_mem_io_reserve_vm(bo);
 200         if (unlikely(ret != 0)) {
 201                 ret = VM_FAULT_SIGBUS;
 202                 goto out_io_unlock;
 203         }
 204
 205         page_offset = ((address - vma->vm_start) >> PAGE_SHIFT) +
 206                 vma->vm_pgoff - drm_vma_node_start(&bo->vma_node);
 207         page_last = vma_pages(vma) + vma->vm_pgoff -
 208                 drm_vma_node_start(&bo->vma_node);
 209
 210         if (unlikely(page_offset >= bo->num_pages)) {
 211                 ret = VM_FAULT_SIGBUS;
 212                 goto out_io_unlock;
 213         }
 214
 215         /*
 216          * Make a local vma copy to modify the page_prot member
 217          * and vm_flags if necessary. The vma parameter is protected
 218          * by mmap_sem in write mode.
 219          */
 220         cvma = *vma;
 221         cvma.vm_page_prot = vm_get_page_prot(cvma.vm_flags);
 222
 223         if (bo->mem.bus.is_iomem) {
 224                 cvma.vm_page_prot = ttm_io_prot(bo->mem.placement,
 225                                                 cvma.vm_page_prot);
 226         } else {
 227                 struct ttm_operation_ctx ctx = {
 228                         .interruptible = false,
 229                         .no_wait_gpu = false,
 230                         .flags = TTM_OPT_FLAG_FORCE_ALLOC
 231
 232                 };
 233
 234                 ttm = bo->ttm;
 235                 cvma.vm_page_prot = ttm_io_prot(bo->mem.placement,
 236                                                 cvma.vm_page_prot);
 237
 238                 /* Allocate all page at once, most common usage */
 239                 if (ttm_tt_populate(ttm, &ctx)) {
 240                         ret = VM_FAULT_OOM;
 241                         goto out_io_unlock;
 242                 }
 243         }
 244
 245         /*
 246          * Speculatively prefault a number of pages. Only error on
 247          * first page.
 248          */
 249         for (i = 0; i < TTM_BO_VM_NUM_PREFAULT; ++i) {
 250                 if (bo->mem.bus.is_iomem) {
 251                         /* Iomem should not be marked encrypted */
 252                         cvma.vm_page_prot = pgprot_decrypted(cvma.vm_page_prot);
 253                         pfn = ttm_bo_io_mem_pfn(bo, page_offset);
 254                 } else {
 255                         page = ttm->pages[page_offset];
 256                         if (unlikely(!page && i == 0)) {
 257                                 ret = VM_FAULT_OOM;
 258                                 goto out_io_unlock;
 259                         } else if (unlikely(!page)) {
 260                                 break;
 261                         }
 262                         page->index = drm_vma_node_start(&bo->vma_node) +
 263                                 page_offset;
 264                         pfn = page_to_pfn(page);
 265                 }
 266
 267                 if (vma->vm_flags & VM_MIXEDMAP)
 268                         ret = vm_insert_mixed(&cvma, address,
 269                                         __pfn_to_pfn_t(pfn, PFN_DEV));
 270                 else
 271                         ret = vm_insert_pfn(&cvma, address, pfn);
 272
 273                 /*
 274                  * Somebody beat us to this PTE or prefaulting to
 275                  * an already populated PTE, or prefaulting error.
 276                  */
 277
 278                 if (unlikely((ret == -EBUSY) || (ret != 0 && i > 0)))
 279                         break;
 280                 else if (unlikely(ret != 0)) {
 281                         ret =
 282                             (ret == -ENOMEM) ? VM_FAULT_OOM : VM_FAULT_SIGBUS;
 283                         goto out_io_unlock;
 284                 }
 285
 286                 address += PAGE_SIZE;
 287                 if (unlikely(++page_offset >= page_last))
 288                         break;
 289         }
 290         ret = VM_FAULT_NOPAGE;
 291 out_io_unlock:
 292         ttm_mem_io_unlock(man);
 293 out_unlock:
 294         ttm_bo_unreserve(bo);
 295         return ret;
 296 }
 297
 298 static void ttm_bo_vm_open(struct vm_area_struct *vma)
 299 {
 300         struct ttm_buffer_object *bo =
 301             (struct ttm_buffer_object *)vma->vm_private_data;
 302
 303         WARN_ON(bo->bdev->dev_mapping != vma->vm_file->f_mapping);
 304
 305         (void)ttm_bo_reference(bo);
 306 }
 307
 308 static void ttm_bo_vm_close(struct vm_area_struct *vma)
 309 {
 310         struct ttm_buffer_object *bo = (struct ttm_buffer_object *)vma->vm_private_data;
 311
 312         ttm_bo_unref(&bo);
 313         vma->vm_private_data = NULL;
 314 }
 315
 316 static int ttm_bo_vm_access_kmap(struct ttm_buffer_object *bo,
 317                                  unsigned long offset,
 318                                  uint8_t *buf, int len, int write)
 319 {
 320         unsigned long page = offset >> PAGE_SHIFT;
 321         unsigned long bytes_left = len;
 322         int ret;
 323
 324         /* Copy a page at a time, that way no extra virtual address
 325          * mapping is needed
 326          */
 327         offset -= page << PAGE_SHIFT;
 328         do {
 329                 unsigned long bytes = min(bytes_left, PAGE_SIZE - offset);
 330                 struct ttm_bo_kmap_obj map;
 331                 void *ptr;
 332                 bool is_iomem;
 333
 334                 ret = ttm_bo_kmap(bo, page, 1, &map);
 335                 if (ret)
 336                         return ret;
 337
 338                 ptr = (uint8_t *)ttm_kmap_obj_virtual(&map, &is_iomem) + offset;
 339                 WARN_ON_ONCE(is_iomem);
 340                 if (write)
 341                         memcpy(ptr, buf, bytes);
 342                 else
 343                         memcpy(buf, ptr, bytes);
 344                 ttm_bo_kunmap(&map);
 345
 346                 page++;
 347                 buf += bytes;
 348                 bytes_left -= bytes;
 349                 offset = 0;
 350         } while (bytes_left);
 351
 352         return len;
 353 }
 354
 355 static int ttm_bo_vm_access(struct vm_area_struct *vma, unsigned long addr,
 356                             void *buf, int len, int write)
 357 {
 358         unsigned long offset = (addr) - vma->vm_start;
 359         struct ttm_buffer_object *bo = vma->vm_private_data;
 360         int ret;
 361
 362         if (len < 1 || (offset + len) >> PAGE_SHIFT > bo->num_pages)
 363                 return -EIO;
 364
 365         ret = ttm_bo_reserve(bo, true, false, NULL);
 366         if (ret)
 367                 return ret;
 368
 369         switch (bo->mem.mem_type) {
 370         case TTM_PL_SYSTEM:
 371                 if (unlikely(bo->ttm->page_flags & TTM_PAGE_FLAG_SWAPPED)) {
 372                         ret = ttm_tt_swapin(bo->ttm);
 373                         if (unlikely(ret != 0))
 374                                 return ret;
 375                 }
 376                 /* fall through */
 377         case TTM_PL_TT:
 378                 ret = ttm_bo_vm_access_kmap(bo, offset, buf, len, write);
 379                 break;
 380         default:
 381                 if (bo->bdev->driver->access_memory)
 382                         ret = bo->bdev->driver->access_memory(
 383                                 bo, offset, buf, len, write);
 384                 else
 385                         ret = -EIO;
 386         }
 387
 388         ttm_bo_unreserve(bo);
 389
 390         return ret;
 391 }
 392
 393 static const struct vm_operations_struct ttm_bo_vm_ops = {
 394         .fault = ttm_bo_vm_fault,
 395         .open = ttm_bo_vm_open,
 396         .close = ttm_bo_vm_close,
 397         .access = ttm_bo_vm_access
 398 };
 399
 400 static struct ttm_buffer_object *ttm_bo_vm_lookup(struct ttm_bo_device *bdev,
 401                                                   unsigned long offset,
 402                                                   unsigned long pages)
 403 {
 404         struct drm_vma_offset_node *node;
 405         struct ttm_buffer_object *bo = NULL;
 406
 407         drm_vma_offset_lock_lookup(&bdev->vma_manager);
 408
 409         node = drm_vma_offset_lookup_locked(&bdev->vma_manager, offset, pages);
 410         if (likely(node)) {
 411                 bo = container_of(node, struct ttm_buffer_object, vma_node);
 412                 if (!kref_get_unless_zero(&bo->kref))
 413                         bo = NULL;
 414         }
 415
 416         drm_vma_offset_unlock_lookup(&bdev->vma_manager);
 417
 418         if (!bo)
 419                 pr_err("Could not find buffer object to map\n");
 420
 421         return bo;
 422 }
 423
 424 int ttm_bo_mmap(struct file *filp, struct vm_area_struct *vma,
 425                 struct ttm_bo_device *bdev)
 426 {
 427         struct ttm_bo_driver *driver;
 428         struct ttm_buffer_object *bo;
 429         int ret;
 430
 431         bo = ttm_bo_vm_lookup(bdev, vma->vm_pgoff, vma_pages(vma));
 432         if (unlikely(!bo))
 433                 return -EINVAL;
 434
 435         driver = bo->bdev->driver;
 436         if (unlikely(!driver->verify_access)) {
 437                 ret = -EPERM;
 438                 goto out_unref;
 439         }
 440         ret = driver->verify_access(bo, filp);
 441         if (unlikely(ret != 0))
 442                 goto out_unref;
 443
 444         vma->vm_ops = &ttm_bo_vm_ops;
 445
 446         /*
 447          * Note: We're transferring the bo reference to
 448          * vma->vm_private_data here.
 449          */
 450
 451         vma->vm_private_data = bo;
 452
 453         /*
 454          * We'd like to use VM_PFNMAP on shared mappings, where
 455          * (vma->vm_flags & VM_SHARED) != 0, for performance reasons,
 456          * but for some reason VM_PFNMAP + x86 PAT + write-combine is very
 457          * bad for performance. Until that has been sorted out, use
 458          * VM_MIXEDMAP on all mappings. See freedesktop.org bug #75719
 459          */
 460         vma->vm_flags |= VM_MIXEDMAP;
 461         vma->vm_flags |= VM_IO | VM_DONTEXPAND | VM_DONTDUMP;
 462         return 0;
 463 out_unref:
 464         ttm_bo_unref(&bo);
 465         return ret;
 466 }
 467 EXPORT_SYMBOL(ttm_bo_mmap);
 468
 469 int ttm_fbdev_mmap(struct vm_area_struct *vma, struct ttm_buffer_object *bo)
 470 {
 471         if (vma->vm_pgoff != 0)
 472                 return -EACCES;
 473
 474         vma->vm_ops = &ttm_bo_vm_ops;
 475         vma->vm_private_data = ttm_bo_reference(bo);
 476         vma->vm_flags |= VM_MIXEDMAP;
 477         vma->vm_flags |= VM_IO | VM_DONTEXPAND;
 478         return 0;
 479 }
 480 EXPORT_SYMBOL(ttm_fbdev_mmap);