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