drivers/gpu/drm/drm_gem_shmem_helper.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 /*
   3  * Copyright 2018 Noralf Trønnes
   4  */
   5
   6 #include <linux/dma-buf.h>
   7 #include <linux/export.h>
   8 #include <linux/module.h>
   9 #include <linux/mutex.h>
  10 #include <linux/shmem_fs.h>
  11 #include <linux/slab.h>
  12 #include <linux/vmalloc.h>
  13 #include <linux/module.h>
  14
  15 #ifdef CONFIG_X86
  16 #include <asm/set_memory.h>
  17 #endif
  18
  19 #include <drm/drm.h>
  20 #include <drm/drm_device.h>
  21 #include <drm/drm_drv.h>
  22 #include <drm/drm_gem_shmem_helper.h>
  23 #include <drm/drm_prime.h>
  24 #include <drm/drm_print.h>
  25
  26 MODULE_IMPORT_NS(DMA_BUF);
  27
  28 /**
  29  * DOC: overview
  30  *
  31  * This library provides helpers for GEM objects backed by shmem buffers
  32  * allocated using anonymous pageable memory.
  33  *
  34  * Functions that operate on the GEM object receive struct &drm_gem_shmem_object.
  35  * For GEM callback helpers in struct &drm_gem_object functions, see likewise
  36  * named functions with an _object_ infix (e.g., drm_gem_shmem_object_vmap() wraps
  37  * drm_gem_shmem_vmap()). These helpers perform the necessary type conversion.
  38  */
  39
  40 static const struct drm_gem_object_funcs drm_gem_shmem_funcs = {
  41         .free = drm_gem_shmem_object_free,
  42         .print_info = drm_gem_shmem_object_print_info,
  43         .pin = drm_gem_shmem_object_pin,
  44         .unpin = drm_gem_shmem_object_unpin,
  45         .get_sg_table = drm_gem_shmem_object_get_sg_table,
  46         .vmap = drm_gem_shmem_object_vmap,
  47         .vunmap = drm_gem_shmem_object_vunmap,
  48         .mmap = drm_gem_shmem_object_mmap,
  49         .vm_ops = &drm_gem_shmem_vm_ops,
  50 };
  51
  52 static struct drm_gem_shmem_object *
  53 __drm_gem_shmem_create(struct drm_device *dev, size_t size, bool private)
  54 {
  55         struct drm_gem_shmem_object *shmem;
  56         struct drm_gem_object *obj;
  57         int ret = 0;
  58
  59         size = PAGE_ALIGN(size);
  60
  61         if (dev->driver->gem_create_object) {
  62                 obj = dev->driver->gem_create_object(dev, size);
  63                 if (IS_ERR(obj))
  64                         return ERR_CAST(obj);
  65                 shmem = to_drm_gem_shmem_obj(obj);
  66         } else {
  67                 shmem = kzalloc(sizeof(*shmem), GFP_KERNEL);
  68                 if (!shmem)
  69                         return ERR_PTR(-ENOMEM);
  70                 obj = &shmem->base;
  71         }
  72
  73         if (!obj->funcs)
  74                 obj->funcs = &drm_gem_shmem_funcs;
  75
  76         if (private) {
  77                 drm_gem_private_object_init(dev, obj, size);
  78                 shmem->map_wc = false; /* dma-buf mappings use always writecombine */
  79         } else {
  80                 ret = drm_gem_object_init(dev, obj, size);
  81         }
  82         if (ret) {
  83                 drm_gem_private_object_fini(obj);
  84                 goto err_free;
  85         }
  86
  87         ret = drm_gem_create_mmap_offset(obj);
  88         if (ret)
  89                 goto err_release;
  90
  91         mutex_init(&shmem->pages_lock);
  92         mutex_init(&shmem->vmap_lock);
  93         INIT_LIST_HEAD(&shmem->madv_list);
  94
  95         if (!private) {
  96                 /*
  97                  * Our buffers are kept pinned, so allocating them
  98                  * from the MOVABLE zone is a really bad idea, and
  99                  * conflicts with CMA. See comments above new_inode()
 100                  * why this is required _and_ expected if you're
 101                  * going to pin these pages.
 102                  */
 103                 mapping_set_gfp_mask(obj->filp->f_mapping, GFP_HIGHUSER |
 104                                      __GFP_RETRY_MAYFAIL | __GFP_NOWARN);
 105         }
 106
 107         return shmem;
 108
 109 err_release:
 110         drm_gem_object_release(obj);
 111 err_free:
 112         kfree(obj);
 113
 114         return ERR_PTR(ret);
 115 }
 116 /**
 117  * drm_gem_shmem_create - Allocate an object with the given size
 118  * @dev: DRM device
 119  * @size: Size of the object to allocate
 120  *
 121  * This function creates a shmem GEM object.
 122  *
 123  * Returns:
 124  * A struct drm_gem_shmem_object * on success or an ERR_PTR()-encoded negative
 125  * error code on failure.
 126  */
 127 struct drm_gem_shmem_object *drm_gem_shmem_create(struct drm_device *dev, size_t size)
 128 {
 129         return __drm_gem_shmem_create(dev, size, false);
 130 }
 131 EXPORT_SYMBOL_GPL(drm_gem_shmem_create);
 132
 133 /**
 134  * drm_gem_shmem_free - Free resources associated with a shmem GEM object
 135  * @shmem: shmem GEM object to free
 136  *
 137  * This function cleans up the GEM object state and frees the memory used to
 138  * store the object itself.
 139  */
 140 void drm_gem_shmem_free(struct drm_gem_shmem_object *shmem)
 141 {
 142         struct drm_gem_object *obj = &shmem->base;
 143
 144         drm_WARN_ON(obj->dev, shmem->vmap_use_count);
 145
 146         if (obj->import_attach) {
 147                 drm_prime_gem_destroy(obj, shmem->sgt);
 148         } else {
 149                 if (shmem->sgt) {
 150                         dma_unmap_sgtable(obj->dev->dev, shmem->sgt,
 151                                           DMA_BIDIRECTIONAL, 0);
 152                         sg_free_table(shmem->sgt);
 153                         kfree(shmem->sgt);
 154                 }
 155                 if (shmem->pages)
 156                         drm_gem_shmem_put_pages(shmem);
 157         }
 158
 159         drm_WARN_ON(obj->dev, shmem->pages_use_count);
 160
 161         drm_gem_object_release(obj);
 162         mutex_destroy(&shmem->pages_lock);
 163         mutex_destroy(&shmem->vmap_lock);
 164         kfree(shmem);
 165 }
 166 EXPORT_SYMBOL_GPL(drm_gem_shmem_free);
 167
 168 static int drm_gem_shmem_get_pages_locked(struct drm_gem_shmem_object *shmem)
 169 {
 170         struct drm_gem_object *obj = &shmem->base;
 171         struct page **pages;
 172
 173         if (shmem->pages_use_count++ > 0)
 174                 return 0;
 175
 176         pages = drm_gem_get_pages(obj);
 177         if (IS_ERR(pages)) {
 178                 drm_dbg_kms(obj->dev, "Failed to get pages (%ld)\n",
 179                             PTR_ERR(pages));
 180                 shmem->pages_use_count = 0;
 181                 return PTR_ERR(pages);
 182         }
 183
 184         /*
 185          * TODO: Allocating WC pages which are correctly flushed is only
 186          * supported on x86. Ideal solution would be a GFP_WC flag, which also
 187          * ttm_pool.c could use.
 188          */
 189 #ifdef CONFIG_X86
 190         if (shmem->map_wc)
 191                 set_pages_array_wc(pages, obj->size >> PAGE_SHIFT);
 192 #endif
 193
 194         shmem->pages = pages;
 195
 196         return 0;
 197 }
 198
 199 /*
 200  * drm_gem_shmem_get_pages - Allocate backing pages for a shmem GEM object
 201  * @shmem: shmem GEM object
 202  *
 203  * This function makes sure that backing pages exists for the shmem GEM object
 204  * and increases the use count.
 205  *
 206  * Returns:
 207  * 0 on success or a negative error code on failure.
 208  */
 209 int drm_gem_shmem_get_pages(struct drm_gem_shmem_object *shmem)
 210 {
 211         struct drm_gem_object *obj = &shmem->base;
 212         int ret;
 213
 214         drm_WARN_ON(obj->dev, obj->import_attach);
 215
 216         ret = mutex_lock_interruptible(&shmem->pages_lock);
 217         if (ret)
 218                 return ret;
 219         ret = drm_gem_shmem_get_pages_locked(shmem);
 220         mutex_unlock(&shmem->pages_lock);
 221
 222         return ret;
 223 }
 224 EXPORT_SYMBOL(drm_gem_shmem_get_pages);
 225
 226 static void drm_gem_shmem_put_pages_locked(struct drm_gem_shmem_object *shmem)
 227 {
 228         struct drm_gem_object *obj = &shmem->base;
 229
 230         if (drm_WARN_ON_ONCE(obj->dev, !shmem->pages_use_count))
 231                 return;
 232
 233         if (--shmem->pages_use_count > 0)
 234                 return;
 235
 236 #ifdef CONFIG_X86
 237         if (shmem->map_wc)
 238                 set_pages_array_wb(shmem->pages, obj->size >> PAGE_SHIFT);
 239 #endif
 240
 241         drm_gem_put_pages(obj, shmem->pages,
 242                           shmem->pages_mark_dirty_on_put,
 243                           shmem->pages_mark_accessed_on_put);
 244         shmem->pages = NULL;
 245 }
 246
 247 /*
 248  * drm_gem_shmem_put_pages - Decrease use count on the backing pages for a shmem GEM object
 249  * @shmem: shmem GEM object
 250  *
 251  * This function decreases the use count and puts the backing pages when use drops to zero.
 252  */
 253 void drm_gem_shmem_put_pages(struct drm_gem_shmem_object *shmem)
 254 {
 255         mutex_lock(&shmem->pages_lock);
 256         drm_gem_shmem_put_pages_locked(shmem);
 257         mutex_unlock(&shmem->pages_lock);
 258 }
 259 EXPORT_SYMBOL(drm_gem_shmem_put_pages);
 260
 261 /**
 262  * drm_gem_shmem_pin - Pin backing pages for a shmem GEM object
 263  * @shmem: shmem GEM object
 264  *
 265  * This function makes sure the backing pages are pinned in memory while the
 266  * buffer is exported.
 267  *
 268  * Returns:
 269  * 0 on success or a negative error code on failure.
 270  */
 271 int drm_gem_shmem_pin(struct drm_gem_shmem_object *shmem)
 272 {
 273         struct drm_gem_object *obj = &shmem->base;
 274
 275         drm_WARN_ON(obj->dev, obj->import_attach);
 276
 277         return drm_gem_shmem_get_pages(shmem);
 278 }
 279 EXPORT_SYMBOL(drm_gem_shmem_pin);
 280
 281 /**
 282  * drm_gem_shmem_unpin - Unpin backing pages for a shmem GEM object
 283  * @shmem: shmem GEM object
 284  *
 285  * This function removes the requirement that the backing pages are pinned in
 286  * memory.
 287  */
 288 void drm_gem_shmem_unpin(struct drm_gem_shmem_object *shmem)
 289 {
 290         struct drm_gem_object *obj = &shmem->base;
 291
 292         drm_WARN_ON(obj->dev, obj->import_attach);
 293
 294         drm_gem_shmem_put_pages(shmem);
 295 }
 296 EXPORT_SYMBOL(drm_gem_shmem_unpin);
 297
 298 static int drm_gem_shmem_vmap_locked(struct drm_gem_shmem_object *shmem,
 299                                      struct iosys_map *map)
 300 {
 301         struct drm_gem_object *obj = &shmem->base;
 302         int ret = 0;
 303
 304         if (shmem->vmap_use_count++ > 0) {
 305                 iosys_map_set_vaddr(map, shmem->vaddr);
 306                 return 0;
 307         }
 308
 309         if (obj->import_attach) {
 310                 ret = dma_buf_vmap(obj->import_attach->dmabuf, map);
 311                 if (!ret) {
 312                         if (drm_WARN_ON(obj->dev, map->is_iomem)) {
 313                                 dma_buf_vunmap(obj->import_attach->dmabuf, map);
 314                                 ret = -EIO;
 315                                 goto err_put_pages;
 316                         }
 317                         shmem->vaddr = map->vaddr;
 318                 }
 319         } else {
 320                 pgprot_t prot = PAGE_KERNEL;
 321
 322                 ret = drm_gem_shmem_get_pages(shmem);
 323                 if (ret)
 324                         goto err_zero_use;
 325
 326                 if (shmem->map_wc)
 327                         prot = pgprot_writecombine(prot);
 328                 shmem->vaddr = vmap(shmem->pages, obj->size >> PAGE_SHIFT,
 329                                     VM_MAP, prot);
 330                 if (!shmem->vaddr)
 331                         ret = -ENOMEM;
 332                 else
 333                         iosys_map_set_vaddr(map, shmem->vaddr);
 334         }
 335
 336         if (ret) {
 337                 drm_dbg_kms(obj->dev, "Failed to vmap pages, error %d\n", ret);
 338                 goto err_put_pages;
 339         }
 340
 341         return 0;
 342
 343 err_put_pages:
 344         if (!obj->import_attach)
 345                 drm_gem_shmem_put_pages(shmem);
 346 err_zero_use:
 347         shmem->vmap_use_count = 0;
 348
 349         return ret;
 350 }
 351
 352 /*
 353  * drm_gem_shmem_vmap - Create a virtual mapping for a shmem GEM object
 354  * @shmem: shmem GEM object
 355  * @map: Returns the kernel virtual address of the SHMEM GEM object's backing
 356  *       store.
 357  *
 358  * This function makes sure that a contiguous kernel virtual address mapping
 359  * exists for the buffer backing the shmem GEM object. It hides the differences
 360  * between dma-buf imported and natively allocated objects.
 361  *
 362  * Acquired mappings should be cleaned up by calling drm_gem_shmem_vunmap().
 363  *
 364  * Returns:
 365  * 0 on success or a negative error code on failure.
 366  */
 367 int drm_gem_shmem_vmap(struct drm_gem_shmem_object *shmem,
 368                        struct iosys_map *map)
 369 {
 370         int ret;
 371
 372         ret = mutex_lock_interruptible(&shmem->vmap_lock);
 373         if (ret)
 374                 return ret;
 375         ret = drm_gem_shmem_vmap_locked(shmem, map);
 376         mutex_unlock(&shmem->vmap_lock);
 377
 378         return ret;
 379 }
 380 EXPORT_SYMBOL(drm_gem_shmem_vmap);
 381
 382 static void drm_gem_shmem_vunmap_locked(struct drm_gem_shmem_object *shmem,
 383                                         struct iosys_map *map)
 384 {
 385         struct drm_gem_object *obj = &shmem->base;
 386
 387         if (drm_WARN_ON_ONCE(obj->dev, !shmem->vmap_use_count))
 388                 return;
 389
 390         if (--shmem->vmap_use_count > 0)
 391                 return;
 392
 393         if (obj->import_attach) {
 394                 dma_buf_vunmap(obj->import_attach->dmabuf, map);
 395         } else {
 396                 vunmap(shmem->vaddr);
 397                 drm_gem_shmem_put_pages(shmem);
 398         }
 399
 400         shmem->vaddr = NULL;
 401 }
 402
 403 /*
 404  * drm_gem_shmem_vunmap - Unmap a virtual mapping for a shmem GEM object
 405  * @shmem: shmem GEM object
 406  * @map: Kernel virtual address where the SHMEM GEM object was mapped
 407  *
 408  * This function cleans up a kernel virtual address mapping acquired by
 409  * drm_gem_shmem_vmap(). The mapping is only removed when the use count drops to
 410  * zero.
 411  *
 412  * This function hides the differences between dma-buf imported and natively
 413  * allocated objects.
 414  */
 415 void drm_gem_shmem_vunmap(struct drm_gem_shmem_object *shmem,
 416                           struct iosys_map *map)
 417 {
 418         mutex_lock(&shmem->vmap_lock);
 419         drm_gem_shmem_vunmap_locked(shmem, map);
 420         mutex_unlock(&shmem->vmap_lock);
 421 }
 422 EXPORT_SYMBOL(drm_gem_shmem_vunmap);
 423
 424 static int
 425 drm_gem_shmem_create_with_handle(struct drm_file *file_priv,
 426                                  struct drm_device *dev, size_t size,
 427                                  uint32_t *handle)
 428 {
 429         struct drm_gem_shmem_object *shmem;
 430         int ret;
 431
 432         shmem = drm_gem_shmem_create(dev, size);
 433         if (IS_ERR(shmem))
 434                 return PTR_ERR(shmem);
 435
 436         /*
 437          * Allocate an id of idr table where the obj is registered
 438          * and handle has the id what user can see.
 439          */
 440         ret = drm_gem_handle_create(file_priv, &shmem->base, handle);
 441         /* drop reference from allocate - handle holds it now. */
 442         drm_gem_object_put(&shmem->base);
 443
 444         return ret;
 445 }
 446
 447 /* Update madvise status, returns true if not purged, else
 448  * false or -errno.
 449  */
 450 int drm_gem_shmem_madvise(struct drm_gem_shmem_object *shmem, int madv)
 451 {
 452         mutex_lock(&shmem->pages_lock);
 453
 454         if (shmem->madv >= 0)
 455                 shmem->madv = madv;
 456
 457         madv = shmem->madv;
 458
 459         mutex_unlock(&shmem->pages_lock);
 460
 461         return (madv >= 0);
 462 }
 463 EXPORT_SYMBOL(drm_gem_shmem_madvise);
 464
 465 void drm_gem_shmem_purge_locked(struct drm_gem_shmem_object *shmem)
 466 {
 467         struct drm_gem_object *obj = &shmem->base;
 468         struct drm_device *dev = obj->dev;
 469
 470         drm_WARN_ON(obj->dev, !drm_gem_shmem_is_purgeable(shmem));
 471
 472         dma_unmap_sgtable(dev->dev, shmem->sgt, DMA_BIDIRECTIONAL, 0);
 473         sg_free_table(shmem->sgt);
 474         kfree(shmem->sgt);
 475         shmem->sgt = NULL;
 476
 477         drm_gem_shmem_put_pages_locked(shmem);
 478
 479         shmem->madv = -1;
 480
 481         drm_vma_node_unmap(&obj->vma_node, dev->anon_inode->i_mapping);
 482         drm_gem_free_mmap_offset(obj);
 483
 484         /* Our goal here is to return as much of the memory as
 485          * is possible back to the system as we are called from OOM.
 486          * To do this we must instruct the shmfs to drop all of its
 487          * backing pages, *now*.
 488          */
 489         shmem_truncate_range(file_inode(obj->filp), 0, (loff_t)-1);
 490
 491         invalidate_mapping_pages(file_inode(obj->filp)->i_mapping, 0, (loff_t)-1);
 492 }
 493 EXPORT_SYMBOL(drm_gem_shmem_purge_locked);
 494
 495 bool drm_gem_shmem_purge(struct drm_gem_shmem_object *shmem)
 496 {
 497         if (!mutex_trylock(&shmem->pages_lock))
 498                 return false;
 499         drm_gem_shmem_purge_locked(shmem);
 500         mutex_unlock(&shmem->pages_lock);
 501
 502         return true;
 503 }
 504 EXPORT_SYMBOL(drm_gem_shmem_purge);
 505
 506 /**
 507  * drm_gem_shmem_dumb_create - Create a dumb shmem buffer object
 508  * @file: DRM file structure to create the dumb buffer for
 509  * @dev: DRM device
 510  * @args: IOCTL data
 511  *
 512  * This function computes the pitch of the dumb buffer and rounds it up to an
 513  * integer number of bytes per pixel. Drivers for hardware that doesn't have
 514  * any additional restrictions on the pitch can directly use this function as
 515  * their &drm_driver.dumb_create callback.
 516  *
 517  * For hardware with additional restrictions, drivers can adjust the fields
 518  * set up by userspace before calling into this function.
 519  *
 520  * Returns:
 521  * 0 on success or a negative error code on failure.
 522  */
 523 int drm_gem_shmem_dumb_create(struct drm_file *file, struct drm_device *dev,
 524                               struct drm_mode_create_dumb *args)
 525 {
 526         u32 min_pitch = DIV_ROUND_UP(args->width * args->bpp, 8);
 527
 528         if (!args->pitch || !args->size) {
 529                 args->pitch = min_pitch;
 530                 args->size = PAGE_ALIGN(args->pitch * args->height);
 531         } else {
 532                 /* ensure sane minimum values */
 533                 if (args->pitch < min_pitch)
 534                         args->pitch = min_pitch;
 535                 if (args->size < args->pitch * args->height)
 536                         args->size = PAGE_ALIGN(args->pitch * args->height);
 537         }
 538
 539         return drm_gem_shmem_create_with_handle(file, dev, args->size, &args->handle);
 540 }
 541 EXPORT_SYMBOL_GPL(drm_gem_shmem_dumb_create);
 542
 543 static vm_fault_t drm_gem_shmem_fault(struct vm_fault *vmf)
 544 {
 545         struct vm_area_struct *vma = vmf->vma;
 546         struct drm_gem_object *obj = vma->vm_private_data;
 547         struct drm_gem_shmem_object *shmem = to_drm_gem_shmem_obj(obj);
 548         loff_t num_pages = obj->size >> PAGE_SHIFT;
 549         vm_fault_t ret;
 550         struct page *page;
 551         pgoff_t page_offset;
 552
 553         /* We don't use vmf->pgoff since that has the fake offset */
 554         page_offset = (vmf->address - vma->vm_start) >> PAGE_SHIFT;
 555
 556         mutex_lock(&shmem->pages_lock);
 557
 558         if (page_offset >= num_pages ||
 559             drm_WARN_ON_ONCE(obj->dev, !shmem->pages) ||
 560             shmem->madv < 0) {
 561                 ret = VM_FAULT_SIGBUS;
 562         } else {
 563                 page = shmem->pages[page_offset];
 564
 565                 ret = vmf_insert_pfn(vma, vmf->address, page_to_pfn(page));
 566         }
 567
 568         mutex_unlock(&shmem->pages_lock);
 569
 570         return ret;
 571 }
 572
 573 static void drm_gem_shmem_vm_open(struct vm_area_struct *vma)
 574 {
 575         struct drm_gem_object *obj = vma->vm_private_data;
 576         struct drm_gem_shmem_object *shmem = to_drm_gem_shmem_obj(obj);
 577
 578         drm_WARN_ON(obj->dev, obj->import_attach);
 579
 580         mutex_lock(&shmem->pages_lock);
 581
 582         /*
 583          * We should have already pinned the pages when the buffer was first
 584          * mmap'd, vm_open() just grabs an additional reference for the new
 585          * mm the vma is getting copied into (ie. on fork()).
 586          */
 587         if (!drm_WARN_ON_ONCE(obj->dev, !shmem->pages_use_count))
 588                 shmem->pages_use_count++;
 589
 590         mutex_unlock(&shmem->pages_lock);
 591
 592         drm_gem_vm_open(vma);
 593 }
 594
 595 static void drm_gem_shmem_vm_close(struct vm_area_struct *vma)
 596 {
 597         struct drm_gem_object *obj = vma->vm_private_data;
 598         struct drm_gem_shmem_object *shmem = to_drm_gem_shmem_obj(obj);
 599
 600         drm_gem_shmem_put_pages(shmem);
 601         drm_gem_vm_close(vma);
 602 }
 603
 604 const struct vm_operations_struct drm_gem_shmem_vm_ops = {
 605         .fault = drm_gem_shmem_fault,
 606         .open = drm_gem_shmem_vm_open,
 607         .close = drm_gem_shmem_vm_close,
 608 };
 609 EXPORT_SYMBOL_GPL(drm_gem_shmem_vm_ops);
 610
 611 /**
 612  * drm_gem_shmem_mmap - Memory-map a shmem GEM object
 613  * @shmem: shmem GEM object
 614  * @vma: VMA for the area to be mapped
 615  *
 616  * This function implements an augmented version of the GEM DRM file mmap
 617  * operation for shmem objects.
 618  *
 619  * Returns:
 620  * 0 on success or a negative error code on failure.
 621  */
 622 int drm_gem_shmem_mmap(struct drm_gem_shmem_object *shmem, struct vm_area_struct *vma)
 623 {
 624         struct drm_gem_object *obj = &shmem->base;
 625         int ret;
 626
 627         if (obj->import_attach) {
 628                 /* Drop the reference drm_gem_mmap_obj() acquired.*/
 629                 drm_gem_object_put(obj);
 630                 vma->vm_private_data = NULL;
 631
 632                 return dma_buf_mmap(obj->dma_buf, vma, 0);
 633         }
 634
 635         ret = drm_gem_shmem_get_pages(shmem);
 636         if (ret)
 637                 return ret;
 638
 639         vma->vm_flags |= VM_PFNMAP | VM_DONTEXPAND | VM_DONTDUMP;
 640         vma->vm_page_prot = vm_get_page_prot(vma->vm_flags);
 641         if (shmem->map_wc)
 642                 vma->vm_page_prot = pgprot_writecombine(vma->vm_page_prot);
 643
 644         return 0;
 645 }
 646 EXPORT_SYMBOL_GPL(drm_gem_shmem_mmap);
 647
 648 /**
 649  * drm_gem_shmem_print_info() - Print &drm_gem_shmem_object info for debugfs
 650  * @shmem: shmem GEM object
 651  * @p: DRM printer
 652  * @indent: Tab indentation level
 653  */
 654 void drm_gem_shmem_print_info(const struct drm_gem_shmem_object *shmem,
 655                               struct drm_printer *p, unsigned int indent)
 656 {
 657         drm_printf_indent(p, indent, "pages_use_count=%u\n", shmem->pages_use_count);
 658         drm_printf_indent(p, indent, "vmap_use_count=%u\n", shmem->vmap_use_count);
 659         drm_printf_indent(p, indent, "vaddr=%p\n", shmem->vaddr);
 660 }
 661 EXPORT_SYMBOL(drm_gem_shmem_print_info);
 662
 663 /**
 664  * drm_gem_shmem_get_sg_table - Provide a scatter/gather table of pinned
 665  *                              pages for a shmem GEM object
 666  * @shmem: shmem GEM object
 667  *
 668  * This function exports a scatter/gather table suitable for PRIME usage by
 669  * calling the standard DMA mapping API.
 670  *
 671  * Drivers who need to acquire an scatter/gather table for objects need to call
 672  * drm_gem_shmem_get_pages_sgt() instead.
 673  *
 674  * Returns:
 675  * A pointer to the scatter/gather table of pinned pages or error pointer on failure.
 676  */
 677 struct sg_table *drm_gem_shmem_get_sg_table(struct drm_gem_shmem_object *shmem)
 678 {
 679         struct drm_gem_object *obj = &shmem->base;
 680
 681         drm_WARN_ON(obj->dev, obj->import_attach);
 682
 683         return drm_prime_pages_to_sg(obj->dev, shmem->pages, obj->size >> PAGE_SHIFT);
 684 }
 685 EXPORT_SYMBOL_GPL(drm_gem_shmem_get_sg_table);
 686
 687 static struct sg_table *drm_gem_shmem_get_pages_sgt_locked(struct drm_gem_shmem_object *shmem)
 688 {
 689         struct drm_gem_object *obj = &shmem->base;
 690         int ret;
 691         struct sg_table *sgt;
 692
 693         if (shmem->sgt)
 694                 return shmem->sgt;
 695
 696         drm_WARN_ON(obj->dev, obj->import_attach);
 697
 698         ret = drm_gem_shmem_get_pages_locked(shmem);
 699         if (ret)
 700                 return ERR_PTR(ret);
 701
 702         sgt = drm_gem_shmem_get_sg_table(shmem);
 703         if (IS_ERR(sgt)) {
 704                 ret = PTR_ERR(sgt);
 705                 goto err_put_pages;
 706         }
 707         /* Map the pages for use by the h/w. */
 708         ret = dma_map_sgtable(obj->dev->dev, sgt, DMA_BIDIRECTIONAL, 0);
 709         if (ret)
 710                 goto err_free_sgt;
 711
 712         shmem->sgt = sgt;
 713
 714         return sgt;
 715
 716 err_free_sgt:
 717         sg_free_table(sgt);
 718         kfree(sgt);
 719 err_put_pages:
 720         drm_gem_shmem_put_pages_locked(shmem);
 721         return ERR_PTR(ret);
 722 }
 723
 724 /**
 725  * drm_gem_shmem_get_pages_sgt - Pin pages, dma map them, and return a
 726  *                               scatter/gather table for a shmem GEM object.
 727  * @shmem: shmem GEM object
 728  *
 729  * This function returns a scatter/gather table suitable for driver usage. If
 730  * the sg table doesn't exist, the pages are pinned, dma-mapped, and a sg
 731  * table created.
 732  *
 733  * This is the main function for drivers to get at backing storage, and it hides
 734  * and difference between dma-buf imported and natively allocated objects.
 735  * drm_gem_shmem_get_sg_table() should not be directly called by drivers.
 736  *
 737  * Returns:
 738  * A pointer to the scatter/gather table of pinned pages or errno on failure.
 739  */
 740 struct sg_table *drm_gem_shmem_get_pages_sgt(struct drm_gem_shmem_object *shmem)
 741 {
 742         int ret;
 743         struct sg_table *sgt;
 744
 745         ret = mutex_lock_interruptible(&shmem->pages_lock);
 746         if (ret)
 747                 return ERR_PTR(ret);
 748         sgt = drm_gem_shmem_get_pages_sgt_locked(shmem);
 749         mutex_unlock(&shmem->pages_lock);
 750
 751         return sgt;
 752 }
 753 EXPORT_SYMBOL(drm_gem_shmem_get_pages_sgt);
 754
 755 /**
 756  * drm_gem_shmem_prime_import_sg_table - Produce a shmem GEM object from
 757  *                 another driver's scatter/gather table of pinned pages
 758  * @dev: Device to import into
 759  * @attach: DMA-BUF attachment
 760  * @sgt: Scatter/gather table of pinned pages
 761  *
 762  * This function imports a scatter/gather table exported via DMA-BUF by
 763  * another driver. Drivers that use the shmem helpers should set this as their
 764  * &drm_driver.gem_prime_import_sg_table callback.
 765  *
 766  * Returns:
 767  * A pointer to a newly created GEM object or an ERR_PTR-encoded negative
 768  * error code on failure.
 769  */
 770 struct drm_gem_object *
 771 drm_gem_shmem_prime_import_sg_table(struct drm_device *dev,
 772                                     struct dma_buf_attachment *attach,
 773                                     struct sg_table *sgt)
 774 {
 775         size_t size = PAGE_ALIGN(attach->dmabuf->size);
 776         struct drm_gem_shmem_object *shmem;
 777
 778         shmem = __drm_gem_shmem_create(dev, size, true);
 779         if (IS_ERR(shmem))
 780                 return ERR_CAST(shmem);
 781
 782         shmem->sgt = sgt;
 783
 784         drm_dbg_prime(dev, "size = %zu\n", size);
 785
 786         return &shmem->base;
 787 }
 788 EXPORT_SYMBOL_GPL(drm_gem_shmem_prime_import_sg_table);
 789
 790 MODULE_DESCRIPTION("DRM SHMEM memory-management helpers");
 791 MODULE_IMPORT_NS(DMA_BUF);
 792 MODULE_LICENSE("GPL v2");