1 // SPDX-License-Identifier: GPL-2.0
3 * Copyright 2018 Noralf Trønnes
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>
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>
23 * This library provides helpers for GEM objects backed by shmem buffers
24 * allocated using anonymous pageable memory.
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,
38 static struct drm_gem_shmem_object *
39 __drm_gem_shmem_create(struct drm_device *dev, size_t size, bool private)
41 struct drm_gem_shmem_object *shmem;
42 struct drm_gem_object *obj;
45 size = PAGE_ALIGN(size);
47 if (dev->driver->gem_create_object)
48 obj = dev->driver->gem_create_object(dev, size);
50 obj = kzalloc(sizeof(*shmem), GFP_KERNEL);
52 return ERR_PTR(-ENOMEM);
55 obj->funcs = &drm_gem_shmem_funcs;
58 drm_gem_private_object_init(dev, obj, size);
60 ret = drm_gem_object_init(dev, obj, size);
64 ret = drm_gem_create_mmap_offset(obj);
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);
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.
81 mapping_set_gfp_mask(obj->filp->f_mapping, GFP_HIGHUSER |
82 __GFP_RETRY_MAYFAIL | __GFP_NOWARN);
88 drm_gem_object_release(obj);
95 * drm_gem_shmem_create - Allocate an object with the given size
97 * @size: Size of the object to allocate
99 * This function creates a shmem GEM object.
102 * A struct drm_gem_shmem_object * on success or an ERR_PTR()-encoded negative
103 * error code on failure.
105 struct drm_gem_shmem_object *drm_gem_shmem_create(struct drm_device *dev, size_t size)
107 return __drm_gem_shmem_create(dev, size, false);
109 EXPORT_SYMBOL_GPL(drm_gem_shmem_create);
112 * drm_gem_shmem_free_object - Free resources associated with a shmem GEM object
113 * @obj: GEM object to free
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.
119 void drm_gem_shmem_free_object(struct drm_gem_object *obj)
121 struct drm_gem_shmem_object *shmem = to_drm_gem_shmem_obj(obj);
123 WARN_ON(shmem->vmap_use_count);
125 if (obj->import_attach) {
126 drm_prime_gem_destroy(obj, shmem->sgt);
129 dma_unmap_sg(obj->dev->dev, shmem->sgt->sgl,
130 shmem->sgt->nents, DMA_BIDIRECTIONAL);
131 sg_free_table(shmem->sgt);
135 drm_gem_shmem_put_pages(shmem);
138 WARN_ON(shmem->pages_use_count);
140 drm_gem_object_release(obj);
141 mutex_destroy(&shmem->pages_lock);
142 mutex_destroy(&shmem->vmap_lock);
145 EXPORT_SYMBOL_GPL(drm_gem_shmem_free_object);
147 static int drm_gem_shmem_get_pages_locked(struct drm_gem_shmem_object *shmem)
149 struct drm_gem_object *obj = &shmem->base;
152 if (shmem->pages_use_count++ > 0)
155 pages = drm_gem_get_pages(obj);
157 DRM_DEBUG_KMS("Failed to get pages (%ld)\n", PTR_ERR(pages));
158 shmem->pages_use_count = 0;
159 return PTR_ERR(pages);
162 shmem->pages = pages;
168 * drm_gem_shmem_get_pages - Allocate backing pages for a shmem GEM object
169 * @shmem: shmem GEM object
171 * This function makes sure that backing pages exists for the shmem GEM object
172 * and increases the use count.
175 * 0 on success or a negative error code on failure.
177 int drm_gem_shmem_get_pages(struct drm_gem_shmem_object *shmem)
181 WARN_ON(shmem->base.import_attach);
183 ret = mutex_lock_interruptible(&shmem->pages_lock);
186 ret = drm_gem_shmem_get_pages_locked(shmem);
187 mutex_unlock(&shmem->pages_lock);
191 EXPORT_SYMBOL(drm_gem_shmem_get_pages);
193 static void drm_gem_shmem_put_pages_locked(struct drm_gem_shmem_object *shmem)
195 struct drm_gem_object *obj = &shmem->base;
197 if (WARN_ON_ONCE(!shmem->pages_use_count))
200 if (--shmem->pages_use_count > 0)
203 drm_gem_put_pages(obj, shmem->pages,
204 shmem->pages_mark_dirty_on_put,
205 shmem->pages_mark_accessed_on_put);
210 * drm_gem_shmem_put_pages - Decrease use count on the backing pages for a shmem GEM object
211 * @shmem: shmem GEM object
213 * This function decreases the use count and puts the backing pages when use drops to zero.
215 void drm_gem_shmem_put_pages(struct drm_gem_shmem_object *shmem)
217 mutex_lock(&shmem->pages_lock);
218 drm_gem_shmem_put_pages_locked(shmem);
219 mutex_unlock(&shmem->pages_lock);
221 EXPORT_SYMBOL(drm_gem_shmem_put_pages);
224 * drm_gem_shmem_pin - Pin backing pages for a shmem GEM object
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.
232 * 0 on success or a negative error code on failure.
234 int drm_gem_shmem_pin(struct drm_gem_object *obj)
236 struct drm_gem_shmem_object *shmem = to_drm_gem_shmem_obj(obj);
238 WARN_ON(shmem->base.import_attach);
240 return drm_gem_shmem_get_pages(shmem);
242 EXPORT_SYMBOL(drm_gem_shmem_pin);
245 * drm_gem_shmem_unpin - Unpin backing pages for a shmem GEM object
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.
251 void drm_gem_shmem_unpin(struct drm_gem_object *obj)
253 struct drm_gem_shmem_object *shmem = to_drm_gem_shmem_obj(obj);
255 WARN_ON(shmem->base.import_attach);
257 drm_gem_shmem_put_pages(shmem);
259 EXPORT_SYMBOL(drm_gem_shmem_unpin);
261 static void *drm_gem_shmem_vmap_locked(struct drm_gem_shmem_object *shmem)
263 struct drm_gem_object *obj = &shmem->base;
264 struct dma_buf_map map;
267 if (shmem->vmap_use_count++ > 0)
270 if (obj->import_attach) {
271 ret = dma_buf_vmap(obj->import_attach->dmabuf, &map);
273 shmem->vaddr = map.vaddr;
275 pgprot_t prot = PAGE_KERNEL;
277 ret = drm_gem_shmem_get_pages(shmem);
281 if (!shmem->map_cached)
282 prot = pgprot_writecombine(prot);
283 shmem->vaddr = vmap(shmem->pages, obj->size >> PAGE_SHIFT,
290 DRM_DEBUG_KMS("Failed to vmap pages, error %d\n", ret);
297 if (!obj->import_attach)
298 drm_gem_shmem_put_pages(shmem);
300 shmem->vmap_use_count = 0;
306 * drm_gem_shmem_vmap - Create a virtual mapping for a shmem GEM object
307 * @shmem: shmem GEM object
309 * This function makes sure that a contiguous kernel virtual address mapping
310 * exists for the buffer backing the shmem GEM object.
312 * This function can be used to implement &drm_gem_object_funcs.vmap. But it can
313 * also be called by drivers directly, in which case it will hide the
314 * differences between dma-buf imported and natively allocated objects.
316 * Acquired mappings should be cleaned up by calling drm_gem_shmem_vunmap().
319 * 0 on success or a negative error code on failure.
321 void *drm_gem_shmem_vmap(struct drm_gem_object *obj)
323 struct drm_gem_shmem_object *shmem = to_drm_gem_shmem_obj(obj);
327 ret = mutex_lock_interruptible(&shmem->vmap_lock);
330 vaddr = drm_gem_shmem_vmap_locked(shmem);
331 mutex_unlock(&shmem->vmap_lock);
335 EXPORT_SYMBOL(drm_gem_shmem_vmap);
337 static void drm_gem_shmem_vunmap_locked(struct drm_gem_shmem_object *shmem)
339 struct drm_gem_object *obj = &shmem->base;
340 struct dma_buf_map map = DMA_BUF_MAP_INIT_VADDR(shmem->vaddr);
342 if (WARN_ON_ONCE(!shmem->vmap_use_count))
345 if (--shmem->vmap_use_count > 0)
348 if (obj->import_attach)
349 dma_buf_vunmap(obj->import_attach->dmabuf, &map);
351 vunmap(shmem->vaddr);
354 drm_gem_shmem_put_pages(shmem);
358 * drm_gem_shmem_vunmap - Unmap a virtual mapping fo a shmem GEM object
359 * @shmem: shmem GEM object
361 * This function cleans up a kernel virtual address mapping acquired by
362 * drm_gem_shmem_vmap(). The mapping is only removed when the use count drops to
365 * This function can be used to implement &drm_gem_object_funcs.vmap. But it can
366 * also be called by drivers directly, in which case it will hide the
367 * differences between dma-buf imported and natively allocated objects.
369 void drm_gem_shmem_vunmap(struct drm_gem_object *obj, void *vaddr)
371 struct drm_gem_shmem_object *shmem = to_drm_gem_shmem_obj(obj);
373 mutex_lock(&shmem->vmap_lock);
374 drm_gem_shmem_vunmap_locked(shmem);
375 mutex_unlock(&shmem->vmap_lock);
377 EXPORT_SYMBOL(drm_gem_shmem_vunmap);
379 struct drm_gem_shmem_object *
380 drm_gem_shmem_create_with_handle(struct drm_file *file_priv,
381 struct drm_device *dev, size_t size,
384 struct drm_gem_shmem_object *shmem;
387 shmem = drm_gem_shmem_create(dev, size);
392 * Allocate an id of idr table where the obj is registered
393 * and handle has the id what user can see.
395 ret = drm_gem_handle_create(file_priv, &shmem->base, handle);
396 /* drop reference from allocate - handle holds it now. */
397 drm_gem_object_put(&shmem->base);
403 EXPORT_SYMBOL(drm_gem_shmem_create_with_handle);
405 /* Update madvise status, returns true if not purged, else
408 int drm_gem_shmem_madvise(struct drm_gem_object *obj, int madv)
410 struct drm_gem_shmem_object *shmem = to_drm_gem_shmem_obj(obj);
412 mutex_lock(&shmem->pages_lock);
414 if (shmem->madv >= 0)
419 mutex_unlock(&shmem->pages_lock);
423 EXPORT_SYMBOL(drm_gem_shmem_madvise);
425 void drm_gem_shmem_purge_locked(struct drm_gem_object *obj)
427 struct drm_device *dev = obj->dev;
428 struct drm_gem_shmem_object *shmem = to_drm_gem_shmem_obj(obj);
430 WARN_ON(!drm_gem_shmem_is_purgeable(shmem));
432 dma_unmap_sg(obj->dev->dev, shmem->sgt->sgl,
433 shmem->sgt->nents, DMA_BIDIRECTIONAL);
434 sg_free_table(shmem->sgt);
438 drm_gem_shmem_put_pages_locked(shmem);
442 drm_vma_node_unmap(&obj->vma_node, dev->anon_inode->i_mapping);
443 drm_gem_free_mmap_offset(obj);
445 /* Our goal here is to return as much of the memory as
446 * is possible back to the system as we are called from OOM.
447 * To do this we must instruct the shmfs to drop all of its
448 * backing pages, *now*.
450 shmem_truncate_range(file_inode(obj->filp), 0, (loff_t)-1);
452 invalidate_mapping_pages(file_inode(obj->filp)->i_mapping,
455 EXPORT_SYMBOL(drm_gem_shmem_purge_locked);
457 bool drm_gem_shmem_purge(struct drm_gem_object *obj)
459 struct drm_gem_shmem_object *shmem = to_drm_gem_shmem_obj(obj);
461 if (!mutex_trylock(&shmem->pages_lock))
463 drm_gem_shmem_purge_locked(obj);
464 mutex_unlock(&shmem->pages_lock);
468 EXPORT_SYMBOL(drm_gem_shmem_purge);
471 * drm_gem_shmem_create_object_cached - Create a shmem buffer object with
474 * @size: Size of the object to allocate
476 * By default, shmem buffer objects use writecombine mappings. This
477 * function implements struct drm_driver.gem_create_object for shmem
478 * buffer objects with cached mappings.
481 * A struct drm_gem_shmem_object * on success or NULL negative on failure.
483 struct drm_gem_object *
484 drm_gem_shmem_create_object_cached(struct drm_device *dev, size_t size)
486 struct drm_gem_shmem_object *shmem;
488 shmem = kzalloc(sizeof(*shmem), GFP_KERNEL);
491 shmem->map_cached = true;
495 EXPORT_SYMBOL(drm_gem_shmem_create_object_cached);
498 * drm_gem_shmem_dumb_create - Create a dumb shmem buffer object
499 * @file: DRM file structure to create the dumb buffer for
503 * This function computes the pitch of the dumb buffer and rounds it up to an
504 * integer number of bytes per pixel. Drivers for hardware that doesn't have
505 * any additional restrictions on the pitch can directly use this function as
506 * their &drm_driver.dumb_create callback.
508 * For hardware with additional restrictions, drivers can adjust the fields
509 * set up by userspace before calling into this function.
512 * 0 on success or a negative error code on failure.
514 int drm_gem_shmem_dumb_create(struct drm_file *file, struct drm_device *dev,
515 struct drm_mode_create_dumb *args)
517 u32 min_pitch = DIV_ROUND_UP(args->width * args->bpp, 8);
518 struct drm_gem_shmem_object *shmem;
520 if (!args->pitch || !args->size) {
521 args->pitch = min_pitch;
522 args->size = args->pitch * args->height;
524 /* ensure sane minimum values */
525 if (args->pitch < min_pitch)
526 args->pitch = min_pitch;
527 if (args->size < args->pitch * args->height)
528 args->size = args->pitch * args->height;
531 shmem = drm_gem_shmem_create_with_handle(file, dev, args->size, &args->handle);
533 return PTR_ERR_OR_ZERO(shmem);
535 EXPORT_SYMBOL_GPL(drm_gem_shmem_dumb_create);
537 static vm_fault_t drm_gem_shmem_fault(struct vm_fault *vmf)
539 struct vm_area_struct *vma = vmf->vma;
540 struct drm_gem_object *obj = vma->vm_private_data;
541 struct drm_gem_shmem_object *shmem = to_drm_gem_shmem_obj(obj);
542 loff_t num_pages = obj->size >> PAGE_SHIFT;
545 if (vmf->pgoff >= num_pages || WARN_ON_ONCE(!shmem->pages))
546 return VM_FAULT_SIGBUS;
548 page = shmem->pages[vmf->pgoff];
550 return vmf_insert_page(vma, vmf->address, page);
553 static void drm_gem_shmem_vm_open(struct vm_area_struct *vma)
555 struct drm_gem_object *obj = vma->vm_private_data;
556 struct drm_gem_shmem_object *shmem = to_drm_gem_shmem_obj(obj);
559 WARN_ON(shmem->base.import_attach);
561 ret = drm_gem_shmem_get_pages(shmem);
562 WARN_ON_ONCE(ret != 0);
564 drm_gem_vm_open(vma);
567 static void drm_gem_shmem_vm_close(struct vm_area_struct *vma)
569 struct drm_gem_object *obj = vma->vm_private_data;
570 struct drm_gem_shmem_object *shmem = to_drm_gem_shmem_obj(obj);
572 drm_gem_shmem_put_pages(shmem);
573 drm_gem_vm_close(vma);
576 static const struct vm_operations_struct drm_gem_shmem_vm_ops = {
577 .fault = drm_gem_shmem_fault,
578 .open = drm_gem_shmem_vm_open,
579 .close = drm_gem_shmem_vm_close,
583 * drm_gem_shmem_mmap - Memory-map a shmem GEM object
585 * @vma: VMA for the area to be mapped
587 * This function implements an augmented version of the GEM DRM file mmap
588 * operation for shmem objects. Drivers which employ the shmem helpers should
589 * use this function as their &drm_gem_object_funcs.mmap handler.
592 * 0 on success or a negative error code on failure.
594 int drm_gem_shmem_mmap(struct drm_gem_object *obj, struct vm_area_struct *vma)
596 struct drm_gem_shmem_object *shmem;
599 /* Remove the fake offset */
600 vma->vm_pgoff -= drm_vma_node_start(&obj->vma_node);
602 if (obj->import_attach)
603 return dma_buf_mmap(obj->dma_buf, vma, 0);
605 shmem = to_drm_gem_shmem_obj(obj);
607 ret = drm_gem_shmem_get_pages(shmem);
609 drm_gem_vm_close(vma);
613 vma->vm_flags |= VM_MIXEDMAP | VM_DONTEXPAND;
614 vma->vm_page_prot = vm_get_page_prot(vma->vm_flags);
615 if (!shmem->map_cached)
616 vma->vm_page_prot = pgprot_writecombine(vma->vm_page_prot);
617 vma->vm_ops = &drm_gem_shmem_vm_ops;
621 EXPORT_SYMBOL_GPL(drm_gem_shmem_mmap);
624 * drm_gem_shmem_print_info() - Print &drm_gem_shmem_object info for debugfs
626 * @indent: Tab indentation level
629 * This implements the &drm_gem_object_funcs.info callback.
631 void drm_gem_shmem_print_info(struct drm_printer *p, unsigned int indent,
632 const struct drm_gem_object *obj)
634 const struct drm_gem_shmem_object *shmem = to_drm_gem_shmem_obj(obj);
636 drm_printf_indent(p, indent, "pages_use_count=%u\n", shmem->pages_use_count);
637 drm_printf_indent(p, indent, "vmap_use_count=%u\n", shmem->vmap_use_count);
638 drm_printf_indent(p, indent, "vaddr=%p\n", shmem->vaddr);
640 EXPORT_SYMBOL(drm_gem_shmem_print_info);
643 * drm_gem_shmem_get_sg_table - Provide a scatter/gather table of pinned
644 * pages for a shmem GEM object
647 * This function exports a scatter/gather table suitable for PRIME usage by
648 * calling the standard DMA mapping API. Drivers should not call this function
649 * directly, instead it should only be used as an implementation for
650 * &drm_gem_object_funcs.get_sg_table.
652 * Drivers who need to acquire an scatter/gather table for objects need to call
653 * drm_gem_shmem_get_pages_sgt() instead.
656 * A pointer to the scatter/gather table of pinned pages or NULL on failure.
658 struct sg_table *drm_gem_shmem_get_sg_table(struct drm_gem_object *obj)
660 struct drm_gem_shmem_object *shmem = to_drm_gem_shmem_obj(obj);
662 WARN_ON(shmem->base.import_attach);
664 return drm_prime_pages_to_sg(obj->dev, shmem->pages, obj->size >> PAGE_SHIFT);
666 EXPORT_SYMBOL_GPL(drm_gem_shmem_get_sg_table);
669 * drm_gem_shmem_get_pages_sgt - Pin pages, dma map them, and return a
670 * scatter/gather table for a shmem GEM object.
673 * This function returns a scatter/gather table suitable for driver usage. If
674 * the sg table doesn't exist, the pages are pinned, dma-mapped, and a sg
677 * This is the main function for drivers to get at backing storage, and it hides
678 * and difference between dma-buf imported and natively allocated objects.
679 * drm_gem_shmem_get_sg_table() should not be directly called by drivers.
682 * A pointer to the scatter/gather table of pinned pages or errno on failure.
684 struct sg_table *drm_gem_shmem_get_pages_sgt(struct drm_gem_object *obj)
687 struct drm_gem_shmem_object *shmem = to_drm_gem_shmem_obj(obj);
688 struct sg_table *sgt;
693 WARN_ON(obj->import_attach);
695 ret = drm_gem_shmem_get_pages(shmem);
699 sgt = drm_gem_shmem_get_sg_table(&shmem->base);
704 /* Map the pages for use by the h/w. */
705 dma_map_sg(obj->dev->dev, sgt->sgl, sgt->nents, DMA_BIDIRECTIONAL);
712 drm_gem_shmem_put_pages(shmem);
715 EXPORT_SYMBOL_GPL(drm_gem_shmem_get_pages_sgt);
718 * drm_gem_shmem_prime_import_sg_table - Produce a shmem GEM object from
719 * another driver's scatter/gather table of pinned pages
720 * @dev: Device to import into
721 * @attach: DMA-BUF attachment
722 * @sgt: Scatter/gather table of pinned pages
724 * This function imports a scatter/gather table exported via DMA-BUF by
725 * another driver. Drivers that use the shmem helpers should set this as their
726 * &drm_driver.gem_prime_import_sg_table callback.
729 * A pointer to a newly created GEM object or an ERR_PTR-encoded negative
730 * error code on failure.
732 struct drm_gem_object *
733 drm_gem_shmem_prime_import_sg_table(struct drm_device *dev,
734 struct dma_buf_attachment *attach,
735 struct sg_table *sgt)
737 size_t size = PAGE_ALIGN(attach->dmabuf->size);
738 struct drm_gem_shmem_object *shmem;
740 shmem = __drm_gem_shmem_create(dev, size, true);
742 return ERR_CAST(shmem);
746 DRM_DEBUG_PRIME("size = %zu\n", size);
750 EXPORT_SYMBOL_GPL(drm_gem_shmem_prime_import_sg_table);