drivers/gpu/drm/msm/msm_gem.c

   1 // SPDX-License-Identifier: GPL-2.0-only
   2 /*
   3  * Copyright (C) 2013 Red Hat
   4  * Author: Rob Clark <robdclark@gmail.com>
   5  */
   6
   7 #include <linux/dma-map-ops.h>
   8 #include <linux/spinlock.h>
   9 #include <linux/shmem_fs.h>
  10 #include <linux/dma-buf.h>
  11 #include <linux/pfn_t.h>
  12
  13 #include <drm/drm_prime.h>
  14
  15 #include "msm_drv.h"
  16 #include "msm_fence.h"
  17 #include "msm_gem.h"
  18 #include "msm_gpu.h"
  19 #include "msm_mmu.h"
  20
  21 static void msm_gem_vunmap_locked(struct drm_gem_object *obj);
  22
  23
  24 static dma_addr_t physaddr(struct drm_gem_object *obj)
  25 {
  26         struct msm_gem_object *msm_obj = to_msm_bo(obj);
  27         struct msm_drm_private *priv = obj->dev->dev_private;
  28         return (((dma_addr_t)msm_obj->vram_node->start) << PAGE_SHIFT) +
  29                         priv->vram.paddr;
  30 }
  31
  32 static bool use_pages(struct drm_gem_object *obj)
  33 {
  34         struct msm_gem_object *msm_obj = to_msm_bo(obj);
  35         return !msm_obj->vram_node;
  36 }
  37
  38 /*
  39  * Cache sync.. this is a bit over-complicated, to fit dma-mapping
  40  * API.  Really GPU cache is out of scope here (handled on cmdstream)
  41  * and all we need to do is invalidate newly allocated pages before
  42  * mapping to CPU as uncached/writecombine.
  43  *
  44  * On top of this, we have the added headache, that depending on
  45  * display generation, the display's iommu may be wired up to either
  46  * the toplevel drm device (mdss), or to the mdp sub-node, meaning
  47  * that here we either have dma-direct or iommu ops.
  48  *
  49  * Let this be a cautionary tail of abstraction gone wrong.
  50  */
  51
  52 static void sync_for_device(struct msm_gem_object *msm_obj)
  53 {
  54         struct device *dev = msm_obj->base.dev->dev;
  55
  56         dma_map_sgtable(dev, msm_obj->sgt, DMA_BIDIRECTIONAL, 0);
  57 }
  58
  59 static void sync_for_cpu(struct msm_gem_object *msm_obj)
  60 {
  61         struct device *dev = msm_obj->base.dev->dev;
  62
  63         dma_unmap_sgtable(dev, msm_obj->sgt, DMA_BIDIRECTIONAL, 0);
  64 }
  65
  66 /* allocate pages from VRAM carveout, used when no IOMMU: */
  67 static struct page **get_pages_vram(struct drm_gem_object *obj, int npages)
  68 {
  69         struct msm_gem_object *msm_obj = to_msm_bo(obj);
  70         struct msm_drm_private *priv = obj->dev->dev_private;
  71         dma_addr_t paddr;
  72         struct page **p;
  73         int ret, i;
  74
  75         p = kvmalloc_array(npages, sizeof(struct page *), GFP_KERNEL);
  76         if (!p)
  77                 return ERR_PTR(-ENOMEM);
  78
  79         spin_lock(&priv->vram.lock);
  80         ret = drm_mm_insert_node(&priv->vram.mm, msm_obj->vram_node, npages);
  81         spin_unlock(&priv->vram.lock);
  82         if (ret) {
  83                 kvfree(p);
  84                 return ERR_PTR(ret);
  85         }
  86
  87         paddr = physaddr(obj);
  88         for (i = 0; i < npages; i++) {
  89                 p[i] = phys_to_page(paddr);
  90                 paddr += PAGE_SIZE;
  91         }
  92
  93         return p;
  94 }
  95
  96 static struct page **get_pages(struct drm_gem_object *obj)
  97 {
  98         struct msm_gem_object *msm_obj = to_msm_bo(obj);
  99
 100         if (!msm_obj->pages) {
 101                 struct drm_device *dev = obj->dev;
 102                 struct page **p;
 103                 int npages = obj->size >> PAGE_SHIFT;
 104
 105                 if (use_pages(obj))
 106                         p = drm_gem_get_pages(obj);
 107                 else
 108                         p = get_pages_vram(obj, npages);
 109
 110                 if (IS_ERR(p)) {
 111                         DRM_DEV_ERROR(dev->dev, "could not get pages: %ld\n",
 112                                         PTR_ERR(p));
 113                         return p;
 114                 }
 115
 116                 msm_obj->pages = p;
 117
 118                 msm_obj->sgt = drm_prime_pages_to_sg(obj->dev, p, npages);
 119                 if (IS_ERR(msm_obj->sgt)) {
 120                         void *ptr = ERR_CAST(msm_obj->sgt);
 121
 122                         DRM_DEV_ERROR(dev->dev, "failed to allocate sgt\n");
 123                         msm_obj->sgt = NULL;
 124                         return ptr;
 125                 }
 126
 127                 /* For non-cached buffers, ensure the new pages are clean
 128                  * because display controller, GPU, etc. are not coherent:
 129                  */
 130                 if (msm_obj->flags & (MSM_BO_WC|MSM_BO_UNCACHED))
 131                         sync_for_device(msm_obj);
 132         }
 133
 134         return msm_obj->pages;
 135 }
 136
 137 static void put_pages_vram(struct drm_gem_object *obj)
 138 {
 139         struct msm_gem_object *msm_obj = to_msm_bo(obj);
 140         struct msm_drm_private *priv = obj->dev->dev_private;
 141
 142         spin_lock(&priv->vram.lock);
 143         drm_mm_remove_node(msm_obj->vram_node);
 144         spin_unlock(&priv->vram.lock);
 145
 146         kvfree(msm_obj->pages);
 147 }
 148
 149 static void put_pages(struct drm_gem_object *obj)
 150 {
 151         struct msm_gem_object *msm_obj = to_msm_bo(obj);
 152
 153         if (msm_obj->pages) {
 154                 if (msm_obj->sgt) {
 155                         /* For non-cached buffers, ensure the new
 156                          * pages are clean because display controller,
 157                          * GPU, etc. are not coherent:
 158                          */
 159                         if (msm_obj->flags & (MSM_BO_WC|MSM_BO_UNCACHED))
 160                                 sync_for_cpu(msm_obj);
 161
 162                         sg_free_table(msm_obj->sgt);
 163                         kfree(msm_obj->sgt);
 164                 }
 165
 166                 if (use_pages(obj))
 167                         drm_gem_put_pages(obj, msm_obj->pages, true, false);
 168                 else
 169                         put_pages_vram(obj);
 170
 171                 msm_obj->pages = NULL;
 172         }
 173 }
 174
 175 struct page **msm_gem_get_pages(struct drm_gem_object *obj)
 176 {
 177         struct msm_gem_object *msm_obj = to_msm_bo(obj);
 178         struct page **p;
 179
 180         mutex_lock(&msm_obj->lock);
 181
 182         if (WARN_ON(msm_obj->madv != MSM_MADV_WILLNEED)) {
 183                 mutex_unlock(&msm_obj->lock);
 184                 return ERR_PTR(-EBUSY);
 185         }
 186
 187         p = get_pages(obj);
 188         mutex_unlock(&msm_obj->lock);
 189         return p;
 190 }
 191
 192 void msm_gem_put_pages(struct drm_gem_object *obj)
 193 {
 194         /* when we start tracking the pin count, then do something here */
 195 }
 196
 197 int msm_gem_mmap_obj(struct drm_gem_object *obj,
 198                 struct vm_area_struct *vma)
 199 {
 200         struct msm_gem_object *msm_obj = to_msm_bo(obj);
 201
 202         vma->vm_flags &= ~VM_PFNMAP;
 203         vma->vm_flags |= VM_MIXEDMAP;
 204
 205         if (msm_obj->flags & MSM_BO_WC) {
 206                 vma->vm_page_prot = pgprot_writecombine(vm_get_page_prot(vma->vm_flags));
 207         } else if (msm_obj->flags & MSM_BO_UNCACHED) {
 208                 vma->vm_page_prot = pgprot_noncached(vm_get_page_prot(vma->vm_flags));
 209         } else {
 210                 /*
 211                  * Shunt off cached objs to shmem file so they have their own
 212                  * address_space (so unmap_mapping_range does what we want,
 213                  * in particular in the case of mmap'd dmabufs)
 214                  */
 215                 vma->vm_pgoff = 0;
 216                 vma_set_file(vma, obj->filp);
 217
 218                 vma->vm_page_prot = vm_get_page_prot(vma->vm_flags);
 219         }
 220
 221         return 0;
 222 }
 223
 224 int msm_gem_mmap(struct file *filp, struct vm_area_struct *vma)
 225 {
 226         int ret;
 227
 228         ret = drm_gem_mmap(filp, vma);
 229         if (ret) {
 230                 DBG("mmap failed: %d", ret);
 231                 return ret;
 232         }
 233
 234         return msm_gem_mmap_obj(vma->vm_private_data, vma);
 235 }
 236
 237 static vm_fault_t msm_gem_fault(struct vm_fault *vmf)
 238 {
 239         struct vm_area_struct *vma = vmf->vma;
 240         struct drm_gem_object *obj = vma->vm_private_data;
 241         struct msm_gem_object *msm_obj = to_msm_bo(obj);
 242         struct page **pages;
 243         unsigned long pfn;
 244         pgoff_t pgoff;
 245         int err;
 246         vm_fault_t ret;
 247
 248         /*
 249          * vm_ops.open/drm_gem_mmap_obj and close get and put
 250          * a reference on obj. So, we dont need to hold one here.
 251          */
 252         err = mutex_lock_interruptible(&msm_obj->lock);
 253         if (err) {
 254                 ret = VM_FAULT_NOPAGE;
 255                 goto out;
 256         }
 257
 258         if (WARN_ON(msm_obj->madv != MSM_MADV_WILLNEED)) {
 259                 mutex_unlock(&msm_obj->lock);
 260                 return VM_FAULT_SIGBUS;
 261         }
 262
 263         /* make sure we have pages attached now */
 264         pages = get_pages(obj);
 265         if (IS_ERR(pages)) {
 266                 ret = vmf_error(PTR_ERR(pages));
 267                 goto out_unlock;
 268         }
 269
 270         /* We don't use vmf->pgoff since that has the fake offset: */
 271         pgoff = (vmf->address - vma->vm_start) >> PAGE_SHIFT;
 272
 273         pfn = page_to_pfn(pages[pgoff]);
 274
 275         VERB("Inserting %p pfn %lx, pa %lx", (void *)vmf->address,
 276                         pfn, pfn << PAGE_SHIFT);
 277
 278         ret = vmf_insert_mixed(vma, vmf->address, __pfn_to_pfn_t(pfn, PFN_DEV));
 279 out_unlock:
 280         mutex_unlock(&msm_obj->lock);
 281 out:
 282         return ret;
 283 }
 284
 285 /** get mmap offset */
 286 static uint64_t mmap_offset(struct drm_gem_object *obj)
 287 {
 288         struct drm_device *dev = obj->dev;
 289         struct msm_gem_object *msm_obj = to_msm_bo(obj);
 290         int ret;
 291
 292         WARN_ON(!mutex_is_locked(&msm_obj->lock));
 293
 294         /* Make it mmapable */
 295         ret = drm_gem_create_mmap_offset(obj);
 296
 297         if (ret) {
 298                 DRM_DEV_ERROR(dev->dev, "could not allocate mmap offset\n");
 299                 return 0;
 300         }
 301
 302         return drm_vma_node_offset_addr(&obj->vma_node);
 303 }
 304
 305 uint64_t msm_gem_mmap_offset(struct drm_gem_object *obj)
 306 {
 307         uint64_t offset;
 308         struct msm_gem_object *msm_obj = to_msm_bo(obj);
 309
 310         mutex_lock(&msm_obj->lock);
 311         offset = mmap_offset(obj);
 312         mutex_unlock(&msm_obj->lock);
 313         return offset;
 314 }
 315
 316 static struct msm_gem_vma *add_vma(struct drm_gem_object *obj,
 317                 struct msm_gem_address_space *aspace)
 318 {
 319         struct msm_gem_object *msm_obj = to_msm_bo(obj);
 320         struct msm_gem_vma *vma;
 321
 322         WARN_ON(!mutex_is_locked(&msm_obj->lock));
 323
 324         vma = kzalloc(sizeof(*vma), GFP_KERNEL);
 325         if (!vma)
 326                 return ERR_PTR(-ENOMEM);
 327
 328         vma->aspace = aspace;
 329
 330         list_add_tail(&vma->list, &msm_obj->vmas);
 331
 332         return vma;
 333 }
 334
 335 static struct msm_gem_vma *lookup_vma(struct drm_gem_object *obj,
 336                 struct msm_gem_address_space *aspace)
 337 {
 338         struct msm_gem_object *msm_obj = to_msm_bo(obj);
 339         struct msm_gem_vma *vma;
 340
 341         WARN_ON(!mutex_is_locked(&msm_obj->lock));
 342
 343         list_for_each_entry(vma, &msm_obj->vmas, list) {
 344                 if (vma->aspace == aspace)
 345                         return vma;
 346         }
 347
 348         return NULL;
 349 }
 350
 351 static void del_vma(struct msm_gem_vma *vma)
 352 {
 353         if (!vma)
 354                 return;
 355
 356         list_del(&vma->list);
 357         kfree(vma);
 358 }
 359
 360 /* Called with msm_obj->lock locked */
 361 static void
 362 put_iova(struct drm_gem_object *obj)
 363 {
 364         struct msm_gem_object *msm_obj = to_msm_bo(obj);
 365         struct msm_gem_vma *vma, *tmp;
 366
 367         WARN_ON(!mutex_is_locked(&msm_obj->lock));
 368
 369         list_for_each_entry_safe(vma, tmp, &msm_obj->vmas, list) {
 370                 if (vma->aspace) {
 371                         msm_gem_purge_vma(vma->aspace, vma);
 372                         msm_gem_close_vma(vma->aspace, vma);
 373                 }
 374                 del_vma(vma);
 375         }
 376 }
 377
 378 static int msm_gem_get_iova_locked(struct drm_gem_object *obj,
 379                 struct msm_gem_address_space *aspace, uint64_t *iova,
 380                 u64 range_start, u64 range_end)
 381 {
 382         struct msm_gem_object *msm_obj = to_msm_bo(obj);
 383         struct msm_gem_vma *vma;
 384         int ret = 0;
 385
 386         WARN_ON(!mutex_is_locked(&msm_obj->lock));
 387
 388         vma = lookup_vma(obj, aspace);
 389
 390         if (!vma) {
 391                 vma = add_vma(obj, aspace);
 392                 if (IS_ERR(vma))
 393                         return PTR_ERR(vma);
 394
 395                 ret = msm_gem_init_vma(aspace, vma, obj->size >> PAGE_SHIFT,
 396                         range_start, range_end);
 397                 if (ret) {
 398                         del_vma(vma);
 399                         return ret;
 400                 }
 401         }
 402
 403         *iova = vma->iova;
 404         return 0;
 405 }
 406
 407 static int msm_gem_pin_iova(struct drm_gem_object *obj,
 408                 struct msm_gem_address_space *aspace)
 409 {
 410         struct msm_gem_object *msm_obj = to_msm_bo(obj);
 411         struct msm_gem_vma *vma;
 412         struct page **pages;
 413         int prot = IOMMU_READ;
 414
 415         if (!(msm_obj->flags & MSM_BO_GPU_READONLY))
 416                 prot |= IOMMU_WRITE;
 417
 418         if (msm_obj->flags & MSM_BO_MAP_PRIV)
 419                 prot |= IOMMU_PRIV;
 420
 421         WARN_ON(!mutex_is_locked(&msm_obj->lock));
 422
 423         if (WARN_ON(msm_obj->madv != MSM_MADV_WILLNEED))
 424                 return -EBUSY;
 425
 426         vma = lookup_vma(obj, aspace);
 427         if (WARN_ON(!vma))
 428                 return -EINVAL;
 429
 430         pages = get_pages(obj);
 431         if (IS_ERR(pages))
 432                 return PTR_ERR(pages);
 433
 434         return msm_gem_map_vma(aspace, vma, prot,
 435                         msm_obj->sgt, obj->size >> PAGE_SHIFT);
 436 }
 437
 438 /*
 439  * get iova and pin it. Should have a matching put
 440  * limits iova to specified range (in pages)
 441  */
 442 int msm_gem_get_and_pin_iova_range(struct drm_gem_object *obj,
 443                 struct msm_gem_address_space *aspace, uint64_t *iova,
 444                 u64 range_start, u64 range_end)
 445 {
 446         struct msm_gem_object *msm_obj = to_msm_bo(obj);
 447         u64 local;
 448         int ret;
 449
 450         mutex_lock(&msm_obj->lock);
 451
 452         ret = msm_gem_get_iova_locked(obj, aspace, &local,
 453                 range_start, range_end);
 454
 455         if (!ret)
 456                 ret = msm_gem_pin_iova(obj, aspace);
 457
 458         if (!ret)
 459                 *iova = local;
 460
 461         mutex_unlock(&msm_obj->lock);
 462         return ret;
 463 }
 464
 465 /* get iova and pin it. Should have a matching put */
 466 int msm_gem_get_and_pin_iova(struct drm_gem_object *obj,
 467                 struct msm_gem_address_space *aspace, uint64_t *iova)
 468 {
 469         return msm_gem_get_and_pin_iova_range(obj, aspace, iova, 0, U64_MAX);
 470 }
 471
 472 /*
 473  * Get an iova but don't pin it. Doesn't need a put because iovas are currently
 474  * valid for the life of the object
 475  */
 476 int msm_gem_get_iova(struct drm_gem_object *obj,
 477                 struct msm_gem_address_space *aspace, uint64_t *iova)
 478 {
 479         struct msm_gem_object *msm_obj = to_msm_bo(obj);
 480         int ret;
 481
 482         mutex_lock(&msm_obj->lock);
 483         ret = msm_gem_get_iova_locked(obj, aspace, iova, 0, U64_MAX);
 484         mutex_unlock(&msm_obj->lock);
 485
 486         return ret;
 487 }
 488
 489 /* get iova without taking a reference, used in places where you have
 490  * already done a 'msm_gem_get_and_pin_iova' or 'msm_gem_get_iova'
 491  */
 492 uint64_t msm_gem_iova(struct drm_gem_object *obj,
 493                 struct msm_gem_address_space *aspace)
 494 {
 495         struct msm_gem_object *msm_obj = to_msm_bo(obj);
 496         struct msm_gem_vma *vma;
 497
 498         mutex_lock(&msm_obj->lock);
 499         vma = lookup_vma(obj, aspace);
 500         mutex_unlock(&msm_obj->lock);
 501         WARN_ON(!vma);
 502
 503         return vma ? vma->iova : 0;
 504 }
 505
 506 /*
 507  * Unpin a iova by updating the reference counts. The memory isn't actually
 508  * purged until something else (shrinker, mm_notifier, destroy, etc) decides
 509  * to get rid of it
 510  */
 511 void msm_gem_unpin_iova(struct drm_gem_object *obj,
 512                 struct msm_gem_address_space *aspace)
 513 {
 514         struct msm_gem_object *msm_obj = to_msm_bo(obj);
 515         struct msm_gem_vma *vma;
 516
 517         mutex_lock(&msm_obj->lock);
 518         vma = lookup_vma(obj, aspace);
 519
 520         if (!WARN_ON(!vma))
 521                 msm_gem_unmap_vma(aspace, vma);
 522
 523         mutex_unlock(&msm_obj->lock);
 524 }
 525
 526 int msm_gem_dumb_create(struct drm_file *file, struct drm_device *dev,
 527                 struct drm_mode_create_dumb *args)
 528 {
 529         args->pitch = align_pitch(args->width, args->bpp);
 530         args->size  = PAGE_ALIGN(args->pitch * args->height);
 531         return msm_gem_new_handle(dev, file, args->size,
 532                         MSM_BO_SCANOUT | MSM_BO_WC, &args->handle, "dumb");
 533 }
 534
 535 int msm_gem_dumb_map_offset(struct drm_file *file, struct drm_device *dev,
 536                 uint32_t handle, uint64_t *offset)
 537 {
 538         struct drm_gem_object *obj;
 539         int ret = 0;
 540
 541         /* GEM does all our handle to object mapping */
 542         obj = drm_gem_object_lookup(file, handle);
 543         if (obj == NULL) {
 544                 ret = -ENOENT;
 545                 goto fail;
 546         }
 547
 548         *offset = msm_gem_mmap_offset(obj);
 549
 550         drm_gem_object_put(obj);
 551
 552 fail:
 553         return ret;
 554 }
 555
 556 static void *get_vaddr(struct drm_gem_object *obj, unsigned madv)
 557 {
 558         struct msm_gem_object *msm_obj = to_msm_bo(obj);
 559         int ret = 0;
 560
 561         if (obj->import_attach)
 562                 return ERR_PTR(-ENODEV);
 563
 564         mutex_lock(&msm_obj->lock);
 565
 566         if (WARN_ON(msm_obj->madv > madv)) {
 567                 DRM_DEV_ERROR(obj->dev->dev, "Invalid madv state: %u vs %u\n",
 568                         msm_obj->madv, madv);
 569                 mutex_unlock(&msm_obj->lock);
 570                 return ERR_PTR(-EBUSY);
 571         }
 572
 573         /* increment vmap_count *before* vmap() call, so shrinker can
 574          * check vmap_count (is_vunmapable()) outside of msm_obj->lock.
 575          * This guarantees that we won't try to msm_gem_vunmap() this
 576          * same object from within the vmap() call (while we already
 577          * hold msm_obj->lock)
 578          */
 579         msm_obj->vmap_count++;
 580
 581         if (!msm_obj->vaddr) {
 582                 struct page **pages = get_pages(obj);
 583                 if (IS_ERR(pages)) {
 584                         ret = PTR_ERR(pages);
 585                         goto fail;
 586                 }
 587                 msm_obj->vaddr = vmap(pages, obj->size >> PAGE_SHIFT,
 588                                 VM_MAP, pgprot_writecombine(PAGE_KERNEL));
 589                 if (msm_obj->vaddr == NULL) {
 590                         ret = -ENOMEM;
 591                         goto fail;
 592                 }
 593         }
 594
 595         mutex_unlock(&msm_obj->lock);
 596         return msm_obj->vaddr;
 597
 598 fail:
 599         msm_obj->vmap_count--;
 600         mutex_unlock(&msm_obj->lock);
 601         return ERR_PTR(ret);
 602 }
 603
 604 void *msm_gem_get_vaddr(struct drm_gem_object *obj)
 605 {
 606         return get_vaddr(obj, MSM_MADV_WILLNEED);
 607 }
 608
 609 /*
 610  * Don't use this!  It is for the very special case of dumping
 611  * submits from GPU hangs or faults, were the bo may already
 612  * be MSM_MADV_DONTNEED, but we know the buffer is still on the
 613  * active list.
 614  */
 615 void *msm_gem_get_vaddr_active(struct drm_gem_object *obj)
 616 {
 617         return get_vaddr(obj, __MSM_MADV_PURGED);
 618 }
 619
 620 void msm_gem_put_vaddr(struct drm_gem_object *obj)
 621 {
 622         struct msm_gem_object *msm_obj = to_msm_bo(obj);
 623
 624         mutex_lock(&msm_obj->lock);
 625         WARN_ON(msm_obj->vmap_count < 1);
 626         msm_obj->vmap_count--;
 627         mutex_unlock(&msm_obj->lock);
 628 }
 629
 630 /* Update madvise status, returns true if not purged, else
 631  * false or -errno.
 632  */
 633 int msm_gem_madvise(struct drm_gem_object *obj, unsigned madv)
 634 {
 635         struct msm_gem_object *msm_obj = to_msm_bo(obj);
 636
 637         mutex_lock(&msm_obj->lock);
 638
 639         WARN_ON(!mutex_is_locked(&obj->dev->struct_mutex));
 640
 641         if (msm_obj->madv != __MSM_MADV_PURGED)
 642                 msm_obj->madv = madv;
 643
 644         madv = msm_obj->madv;
 645
 646         mutex_unlock(&msm_obj->lock);
 647
 648         return (madv != __MSM_MADV_PURGED);
 649 }
 650
 651 void msm_gem_purge(struct drm_gem_object *obj, enum msm_gem_lock subclass)
 652 {
 653         struct drm_device *dev = obj->dev;
 654         struct msm_gem_object *msm_obj = to_msm_bo(obj);
 655
 656         WARN_ON(!mutex_is_locked(&dev->struct_mutex));
 657         WARN_ON(!is_purgeable(msm_obj));
 658         WARN_ON(obj->import_attach);
 659
 660         mutex_lock_nested(&msm_obj->lock, subclass);
 661
 662         put_iova(obj);
 663
 664         msm_gem_vunmap_locked(obj);
 665
 666         put_pages(obj);
 667
 668         msm_obj->madv = __MSM_MADV_PURGED;
 669
 670         drm_vma_node_unmap(&obj->vma_node, dev->anon_inode->i_mapping);
 671         drm_gem_free_mmap_offset(obj);
 672
 673         /* Our goal here is to return as much of the memory as
 674          * is possible back to the system as we are called from OOM.
 675          * To do this we must instruct the shmfs to drop all of its
 676          * backing pages, *now*.
 677          */
 678         shmem_truncate_range(file_inode(obj->filp), 0, (loff_t)-1);
 679
 680         invalidate_mapping_pages(file_inode(obj->filp)->i_mapping,
 681                         0, (loff_t)-1);
 682
 683         mutex_unlock(&msm_obj->lock);
 684 }
 685
 686 static void msm_gem_vunmap_locked(struct drm_gem_object *obj)
 687 {
 688         struct msm_gem_object *msm_obj = to_msm_bo(obj);
 689
 690         WARN_ON(!mutex_is_locked(&msm_obj->lock));
 691
 692         if (!msm_obj->vaddr || WARN_ON(!is_vunmapable(msm_obj)))
 693                 return;
 694
 695         vunmap(msm_obj->vaddr);
 696         msm_obj->vaddr = NULL;
 697 }
 698
 699 void msm_gem_vunmap(struct drm_gem_object *obj, enum msm_gem_lock subclass)
 700 {
 701         struct msm_gem_object *msm_obj = to_msm_bo(obj);
 702
 703         mutex_lock_nested(&msm_obj->lock, subclass);
 704         msm_gem_vunmap_locked(obj);
 705         mutex_unlock(&msm_obj->lock);
 706 }
 707
 708 /* must be called before _move_to_active().. */
 709 int msm_gem_sync_object(struct drm_gem_object *obj,
 710                 struct msm_fence_context *fctx, bool exclusive)
 711 {
 712         struct dma_resv_list *fobj;
 713         struct dma_fence *fence;
 714         int i, ret;
 715
 716         fobj = dma_resv_get_list(obj->resv);
 717         if (!fobj || (fobj->shared_count == 0)) {
 718                 fence = dma_resv_get_excl(obj->resv);
 719                 /* don't need to wait on our own fences, since ring is fifo */
 720                 if (fence && (fence->context != fctx->context)) {
 721                         ret = dma_fence_wait(fence, true);
 722                         if (ret)
 723                                 return ret;
 724                 }
 725         }
 726
 727         if (!exclusive || !fobj)
 728                 return 0;
 729
 730         for (i = 0; i < fobj->shared_count; i++) {
 731                 fence = rcu_dereference_protected(fobj->shared[i],
 732                                                 dma_resv_held(obj->resv));
 733                 if (fence->context != fctx->context) {
 734                         ret = dma_fence_wait(fence, true);
 735                         if (ret)
 736                                 return ret;
 737                 }
 738         }
 739
 740         return 0;
 741 }
 742
 743 void msm_gem_active_get(struct drm_gem_object *obj, struct msm_gpu *gpu)
 744 {
 745         struct msm_gem_object *msm_obj = to_msm_bo(obj);
 746         WARN_ON(!mutex_is_locked(&obj->dev->struct_mutex));
 747         WARN_ON(msm_obj->madv != MSM_MADV_WILLNEED);
 748
 749         if (!atomic_fetch_inc(&msm_obj->active_count)) {
 750                 msm_obj->gpu = gpu;
 751                 list_del_init(&msm_obj->mm_list);
 752                 list_add_tail(&msm_obj->mm_list, &gpu->active_list);
 753         }
 754 }
 755
 756 void msm_gem_active_put(struct drm_gem_object *obj)
 757 {
 758         struct msm_gem_object *msm_obj = to_msm_bo(obj);
 759         struct msm_drm_private *priv = obj->dev->dev_private;
 760
 761         WARN_ON(!mutex_is_locked(&obj->dev->struct_mutex));
 762
 763         if (!atomic_dec_return(&msm_obj->active_count)) {
 764                 msm_obj->gpu = NULL;
 765                 list_del_init(&msm_obj->mm_list);
 766                 list_add_tail(&msm_obj->mm_list, &priv->inactive_list);
 767         }
 768 }
 769
 770 int msm_gem_cpu_prep(struct drm_gem_object *obj, uint32_t op, ktime_t *timeout)
 771 {
 772         bool write = !!(op & MSM_PREP_WRITE);
 773         unsigned long remain =
 774                 op & MSM_PREP_NOSYNC ? 0 : timeout_to_jiffies(timeout);
 775         long ret;
 776
 777         ret = dma_resv_wait_timeout_rcu(obj->resv, write,
 778                                                   true,  remain);
 779         if (ret == 0)
 780                 return remain == 0 ? -EBUSY : -ETIMEDOUT;
 781         else if (ret < 0)
 782                 return ret;
 783
 784         /* TODO cache maintenance */
 785
 786         return 0;
 787 }
 788
 789 int msm_gem_cpu_fini(struct drm_gem_object *obj)
 790 {
 791         /* TODO cache maintenance */
 792         return 0;
 793 }
 794
 795 #ifdef CONFIG_DEBUG_FS
 796 static void describe_fence(struct dma_fence *fence, const char *type,
 797                 struct seq_file *m)
 798 {
 799         if (!dma_fence_is_signaled(fence))
 800                 seq_printf(m, "\t%9s: %s %s seq %llu\n", type,
 801                                 fence->ops->get_driver_name(fence),
 802                                 fence->ops->get_timeline_name(fence),
 803                                 fence->seqno);
 804 }
 805
 806 void msm_gem_describe(struct drm_gem_object *obj, struct seq_file *m)
 807 {
 808         struct msm_gem_object *msm_obj = to_msm_bo(obj);
 809         struct dma_resv *robj = obj->resv;
 810         struct dma_resv_list *fobj;
 811         struct dma_fence *fence;
 812         struct msm_gem_vma *vma;
 813         uint64_t off = drm_vma_node_start(&obj->vma_node);
 814         const char *madv;
 815
 816         mutex_lock(&msm_obj->lock);
 817
 818         switch (msm_obj->madv) {
 819         case __MSM_MADV_PURGED:
 820                 madv = " purged";
 821                 break;
 822         case MSM_MADV_DONTNEED:
 823                 madv = " purgeable";
 824                 break;
 825         case MSM_MADV_WILLNEED:
 826         default:
 827                 madv = "";
 828                 break;
 829         }
 830
 831         seq_printf(m, "%08x: %c %2d (%2d) %08llx %p",
 832                         msm_obj->flags, is_active(msm_obj) ? 'A' : 'I',
 833                         obj->name, kref_read(&obj->refcount),
 834                         off, msm_obj->vaddr);
 835
 836         seq_printf(m, " %08zu %9s %-32s\n", obj->size, madv, msm_obj->name);
 837
 838         if (!list_empty(&msm_obj->vmas)) {
 839
 840                 seq_puts(m, "      vmas:");
 841
 842                 list_for_each_entry(vma, &msm_obj->vmas, list) {
 843                         const char *name, *comm;
 844                         if (vma->aspace) {
 845                                 struct msm_gem_address_space *aspace = vma->aspace;
 846                                 struct task_struct *task =
 847                                         get_pid_task(aspace->pid, PIDTYPE_PID);
 848                                 if (task) {
 849                                         comm = kstrdup(task->comm, GFP_KERNEL);
 850                                 } else {
 851                                         comm = NULL;
 852                                 }
 853                                 name = aspace->name;
 854                         } else {
 855                                 name = comm = NULL;
 856                         }
 857                         seq_printf(m, " [%s%s%s: aspace=%p, %08llx,%s,inuse=%d]",
 858                                 name, comm ? ":" : "", comm ? comm : "",
 859                                 vma->aspace, vma->iova,
 860                                 vma->mapped ? "mapped" : "unmapped",
 861                                 vma->inuse);
 862                         kfree(comm);
 863                 }
 864
 865                 seq_puts(m, "\n");
 866         }
 867
 868         rcu_read_lock();
 869         fobj = rcu_dereference(robj->fence);
 870         if (fobj) {
 871                 unsigned int i, shared_count = fobj->shared_count;
 872
 873                 for (i = 0; i < shared_count; i++) {
 874                         fence = rcu_dereference(fobj->shared[i]);
 875                         describe_fence(fence, "Shared", m);
 876                 }
 877         }
 878
 879         fence = rcu_dereference(robj->fence_excl);
 880         if (fence)
 881                 describe_fence(fence, "Exclusive", m);
 882         rcu_read_unlock();
 883
 884         mutex_unlock(&msm_obj->lock);
 885 }
 886
 887 void msm_gem_describe_objects(struct list_head *list, struct seq_file *m)
 888 {
 889         struct msm_gem_object *msm_obj;
 890         int count = 0;
 891         size_t size = 0;
 892
 893         seq_puts(m, "   flags       id ref  offset   kaddr            size     madv      name\n");
 894         list_for_each_entry(msm_obj, list, mm_list) {
 895                 struct drm_gem_object *obj = &msm_obj->base;
 896                 seq_puts(m, "   ");
 897                 msm_gem_describe(obj, m);
 898                 count++;
 899                 size += obj->size;
 900         }
 901
 902         seq_printf(m, "Total %d objects, %zu bytes\n", count, size);
 903 }
 904 #endif
 905
 906 /* don't call directly!  Use drm_gem_object_put_locked() and friends */
 907 void msm_gem_free_object(struct drm_gem_object *obj)
 908 {
 909         struct msm_gem_object *msm_obj = to_msm_bo(obj);
 910         struct drm_device *dev = obj->dev;
 911         struct msm_drm_private *priv = dev->dev_private;
 912
 913         if (llist_add(&msm_obj->freed, &priv->free_list))
 914                 queue_work(priv->wq, &priv->free_work);
 915 }
 916
 917 static void free_object(struct msm_gem_object *msm_obj)
 918 {
 919         struct drm_gem_object *obj = &msm_obj->base;
 920         struct drm_device *dev = obj->dev;
 921
 922         WARN_ON(!mutex_is_locked(&dev->struct_mutex));
 923
 924         /* object should not be on active list: */
 925         WARN_ON(is_active(msm_obj));
 926
 927         list_del(&msm_obj->mm_list);
 928
 929         mutex_lock(&msm_obj->lock);
 930
 931         put_iova(obj);
 932
 933         if (obj->import_attach) {
 934                 WARN_ON(msm_obj->vaddr);
 935
 936                 /* Don't drop the pages for imported dmabuf, as they are not
 937                  * ours, just free the array we allocated:
 938                  */
 939                 if (msm_obj->pages)
 940                         kvfree(msm_obj->pages);
 941
 942                 drm_prime_gem_destroy(obj, msm_obj->sgt);
 943         } else {
 944                 msm_gem_vunmap_locked(obj);
 945                 put_pages(obj);
 946         }
 947
 948         drm_gem_object_release(obj);
 949
 950         mutex_unlock(&msm_obj->lock);
 951         kfree(msm_obj);
 952 }
 953
 954 void msm_gem_free_work(struct work_struct *work)
 955 {
 956         struct msm_drm_private *priv =
 957                 container_of(work, struct msm_drm_private, free_work);
 958         struct drm_device *dev = priv->dev;
 959         struct llist_node *freed;
 960         struct msm_gem_object *msm_obj, *next;
 961
 962         while ((freed = llist_del_all(&priv->free_list))) {
 963
 964                 mutex_lock(&dev->struct_mutex);
 965
 966                 llist_for_each_entry_safe(msm_obj, next,
 967                                           freed, freed)
 968                         free_object(msm_obj);
 969
 970                 mutex_unlock(&dev->struct_mutex);
 971
 972                 if (need_resched())
 973                         break;
 974         }
 975 }
 976
 977 /* convenience method to construct a GEM buffer object, and userspace handle */
 978 int msm_gem_new_handle(struct drm_device *dev, struct drm_file *file,
 979                 uint32_t size, uint32_t flags, uint32_t *handle,
 980                 char *name)
 981 {
 982         struct drm_gem_object *obj;
 983         int ret;
 984
 985         obj = msm_gem_new(dev, size, flags);
 986
 987         if (IS_ERR(obj))
 988                 return PTR_ERR(obj);
 989
 990         if (name)
 991                 msm_gem_object_set_name(obj, "%s", name);
 992
 993         ret = drm_gem_handle_create(file, obj, handle);
 994
 995         /* drop reference from allocate - handle holds it now */
 996         drm_gem_object_put(obj);
 997
 998         return ret;
 999 }
1000
1001 static const struct vm_operations_struct vm_ops = {
1002         .fault = msm_gem_fault,
1003         .open = drm_gem_vm_open,
1004         .close = drm_gem_vm_close,
1005 };
1006
1007 static const struct drm_gem_object_funcs msm_gem_object_funcs = {
1008         .free = msm_gem_free_object,
1009         .pin = msm_gem_prime_pin,
1010         .unpin = msm_gem_prime_unpin,
1011         .get_sg_table = msm_gem_prime_get_sg_table,
1012         .vmap = msm_gem_prime_vmap,
1013         .vunmap = msm_gem_prime_vunmap,
1014         .vm_ops = &vm_ops,
1015 };
1016
1017 static int msm_gem_new_impl(struct drm_device *dev,
1018                 uint32_t size, uint32_t flags,
1019                 struct drm_gem_object **obj)
1020 {
1021         struct msm_gem_object *msm_obj;
1022
1023         switch (flags & MSM_BO_CACHE_MASK) {
1024         case MSM_BO_UNCACHED:
1025         case MSM_BO_CACHED:
1026         case MSM_BO_WC:
1027                 break;
1028         default:
1029                 DRM_DEV_ERROR(dev->dev, "invalid cache flag: %x\n",
1030                                 (flags & MSM_BO_CACHE_MASK));
1031                 return -EINVAL;
1032         }
1033
1034         msm_obj = kzalloc(sizeof(*msm_obj), GFP_KERNEL);
1035         if (!msm_obj)
1036                 return -ENOMEM;
1037
1038         mutex_init(&msm_obj->lock);
1039
1040         msm_obj->flags = flags;
1041         msm_obj->madv = MSM_MADV_WILLNEED;
1042
1043         INIT_LIST_HEAD(&msm_obj->submit_entry);
1044         INIT_LIST_HEAD(&msm_obj->vmas);
1045
1046         *obj = &msm_obj->base;
1047         (*obj)->funcs = &msm_gem_object_funcs;
1048
1049         return 0;
1050 }
1051
1052 static struct drm_gem_object *_msm_gem_new(struct drm_device *dev,
1053                 uint32_t size, uint32_t flags, bool struct_mutex_locked)
1054 {
1055         struct msm_drm_private *priv = dev->dev_private;
1056         struct msm_gem_object *msm_obj;
1057         struct drm_gem_object *obj = NULL;
1058         bool use_vram = false;
1059         int ret;
1060
1061         size = PAGE_ALIGN(size);
1062
1063         if (!msm_use_mmu(dev))
1064                 use_vram = true;
1065         else if ((flags & (MSM_BO_STOLEN | MSM_BO_SCANOUT)) && priv->vram.size)
1066                 use_vram = true;
1067
1068         if (WARN_ON(use_vram && !priv->vram.size))
1069                 return ERR_PTR(-EINVAL);
1070
1071         /* Disallow zero sized objects as they make the underlying
1072          * infrastructure grumpy
1073          */
1074         if (size == 0)
1075                 return ERR_PTR(-EINVAL);
1076
1077         ret = msm_gem_new_impl(dev, size, flags, &obj);
1078         if (ret)
1079                 goto fail;
1080
1081         msm_obj = to_msm_bo(obj);
1082
1083         if (use_vram) {
1084                 struct msm_gem_vma *vma;
1085                 struct page **pages;
1086
1087                 mutex_lock(&msm_obj->lock);
1088
1089                 vma = add_vma(obj, NULL);
1090                 mutex_unlock(&msm_obj->lock);
1091                 if (IS_ERR(vma)) {
1092                         ret = PTR_ERR(vma);
1093                         goto fail;
1094                 }
1095
1096                 to_msm_bo(obj)->vram_node = &vma->node;
1097
1098                 drm_gem_private_object_init(dev, obj, size);
1099
1100                 pages = get_pages(obj);
1101                 if (IS_ERR(pages)) {
1102                         ret = PTR_ERR(pages);
1103                         goto fail;
1104                 }
1105
1106                 vma->iova = physaddr(obj);
1107         } else {
1108                 ret = drm_gem_object_init(dev, obj, size);
1109                 if (ret)
1110                         goto fail;
1111                 /*
1112                  * Our buffers are kept pinned, so allocating them from the
1113                  * MOVABLE zone is a really bad idea, and conflicts with CMA.
1114                  * See comments above new_inode() why this is required _and_
1115                  * expected if you're going to pin these pages.
1116                  */
1117                 mapping_set_gfp_mask(obj->filp->f_mapping, GFP_HIGHUSER);
1118         }
1119
1120         if (struct_mutex_locked) {
1121                 WARN_ON(!mutex_is_locked(&dev->struct_mutex));
1122                 list_add_tail(&msm_obj->mm_list, &priv->inactive_list);
1123         } else {
1124                 mutex_lock(&dev->struct_mutex);
1125                 list_add_tail(&msm_obj->mm_list, &priv->inactive_list);
1126                 mutex_unlock(&dev->struct_mutex);
1127         }
1128
1129         return obj;
1130
1131 fail:
1132         drm_gem_object_put(obj);
1133         return ERR_PTR(ret);
1134 }
1135
1136 struct drm_gem_object *msm_gem_new_locked(struct drm_device *dev,
1137                 uint32_t size, uint32_t flags)
1138 {
1139         return _msm_gem_new(dev, size, flags, true);
1140 }
1141
1142 struct drm_gem_object *msm_gem_new(struct drm_device *dev,
1143                 uint32_t size, uint32_t flags)
1144 {
1145         return _msm_gem_new(dev, size, flags, false);
1146 }
1147
1148 struct drm_gem_object *msm_gem_import(struct drm_device *dev,
1149                 struct dma_buf *dmabuf, struct sg_table *sgt)
1150 {
1151         struct msm_drm_private *priv = dev->dev_private;
1152         struct msm_gem_object *msm_obj;
1153         struct drm_gem_object *obj;
1154         uint32_t size;
1155         int ret, npages;
1156
1157         /* if we don't have IOMMU, don't bother pretending we can import: */
1158         if (!msm_use_mmu(dev)) {
1159                 DRM_DEV_ERROR(dev->dev, "cannot import without IOMMU\n");
1160                 return ERR_PTR(-EINVAL);
1161         }
1162
1163         size = PAGE_ALIGN(dmabuf->size);
1164
1165         ret = msm_gem_new_impl(dev, size, MSM_BO_WC, &obj);
1166         if (ret)
1167                 goto fail;
1168
1169         drm_gem_private_object_init(dev, obj, size);
1170
1171         npages = size / PAGE_SIZE;
1172
1173         msm_obj = to_msm_bo(obj);
1174         mutex_lock(&msm_obj->lock);
1175         msm_obj->sgt = sgt;
1176         msm_obj->pages = kvmalloc_array(npages, sizeof(struct page *), GFP_KERNEL);
1177         if (!msm_obj->pages) {
1178                 mutex_unlock(&msm_obj->lock);
1179                 ret = -ENOMEM;
1180                 goto fail;
1181         }
1182
1183         ret = drm_prime_sg_to_page_addr_arrays(sgt, msm_obj->pages, NULL, npages);
1184         if (ret) {
1185                 mutex_unlock(&msm_obj->lock);
1186                 goto fail;
1187         }
1188
1189         mutex_unlock(&msm_obj->lock);
1190
1191         mutex_lock(&dev->struct_mutex);
1192         list_add_tail(&msm_obj->mm_list, &priv->inactive_list);
1193         mutex_unlock(&dev->struct_mutex);
1194
1195         return obj;
1196
1197 fail:
1198         drm_gem_object_put(obj);
1199         return ERR_PTR(ret);
1200 }
1201
1202 static void *_msm_gem_kernel_new(struct drm_device *dev, uint32_t size,
1203                 uint32_t flags, struct msm_gem_address_space *aspace,
1204                 struct drm_gem_object **bo, uint64_t *iova, bool locked)
1205 {
1206         void *vaddr;
1207         struct drm_gem_object *obj = _msm_gem_new(dev, size, flags, locked);
1208         int ret;
1209
1210         if (IS_ERR(obj))
1211                 return ERR_CAST(obj);
1212
1213         if (iova) {
1214                 ret = msm_gem_get_and_pin_iova(obj, aspace, iova);
1215                 if (ret)
1216                         goto err;
1217         }
1218
1219         vaddr = msm_gem_get_vaddr(obj);
1220         if (IS_ERR(vaddr)) {
1221                 msm_gem_unpin_iova(obj, aspace);
1222                 ret = PTR_ERR(vaddr);
1223                 goto err;
1224         }
1225
1226         if (bo)
1227                 *bo = obj;
1228
1229         return vaddr;
1230 err:
1231         if (locked)
1232                 drm_gem_object_put_locked(obj);
1233         else
1234                 drm_gem_object_put(obj);
1235
1236         return ERR_PTR(ret);
1237
1238 }
1239
1240 void *msm_gem_kernel_new(struct drm_device *dev, uint32_t size,
1241                 uint32_t flags, struct msm_gem_address_space *aspace,
1242                 struct drm_gem_object **bo, uint64_t *iova)
1243 {
1244         return _msm_gem_kernel_new(dev, size, flags, aspace, bo, iova, false);
1245 }
1246
1247 void *msm_gem_kernel_new_locked(struct drm_device *dev, uint32_t size,
1248                 uint32_t flags, struct msm_gem_address_space *aspace,
1249                 struct drm_gem_object **bo, uint64_t *iova)
1250 {
1251         return _msm_gem_kernel_new(dev, size, flags, aspace, bo, iova, true);
1252 }
1253
1254 void msm_gem_kernel_put(struct drm_gem_object *bo,
1255                 struct msm_gem_address_space *aspace, bool locked)
1256 {
1257         if (IS_ERR_OR_NULL(bo))
1258                 return;
1259
1260         msm_gem_put_vaddr(bo);
1261         msm_gem_unpin_iova(bo, aspace);
1262
1263         if (locked)
1264                 drm_gem_object_put_locked(bo);
1265         else
1266                 drm_gem_object_put(bo);
1267 }
1268
1269 void msm_gem_object_set_name(struct drm_gem_object *bo, const char *fmt, ...)
1270 {
1271         struct msm_gem_object *msm_obj = to_msm_bo(bo);
1272         va_list ap;
1273
1274         if (!fmt)
1275                 return;
1276
1277         va_start(ap, fmt);
1278         vsnprintf(msm_obj->name, sizeof(msm_obj->name), fmt, ap);
1279         va_end(ap);
1280 }