2 * Copyright © 2008 Intel Corporation
4 * Permission is hereby granted, free of charge, to any person obtaining a
5 * copy of this software and associated documentation files (the "Software"),
6 * to deal in the Software without restriction, including without limitation
7 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
8 * and/or sell copies of the Software, and to permit persons to whom the
9 * Software is furnished to do so, subject to the following conditions:
11 * The above copyright notice and this permission notice (including the next
12 * paragraph) shall be included in all copies or substantial portions of the
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
18 * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
24 * Eric Anholt <eric@anholt.net>
28 #include <linux/types.h>
29 #include <linux/slab.h>
31 #include <linux/uaccess.h>
33 #include <linux/file.h>
34 #include <linux/module.h>
35 #include <linux/mman.h>
36 #include <linux/pagemap.h>
37 #include <linux/shmem_fs.h>
38 #include <linux/dma-buf.h>
39 #include <linux/mem_encrypt.h>
40 #include <linux/pagevec.h>
42 #include <drm/drm_vma_manager.h>
43 #include <drm/drm_gem.h>
44 #include <drm/drm_print.h>
45 #include "drm_internal.h"
49 * This file provides some of the base ioctls and library routines for
50 * the graphics memory manager implemented by each device driver.
52 * Because various devices have different requirements in terms of
53 * synchronization and migration strategies, implementing that is left up to
54 * the driver, and all that the general API provides should be generic --
55 * allocating objects, reading/writing data with the cpu, freeing objects.
56 * Even there, platform-dependent optimizations for reading/writing data with
57 * the CPU mean we'll likely hook those out to driver-specific calls. However,
58 * the DRI2 implementation wants to have at least allocate/mmap be generic.
60 * The goal was to have swap-backed object allocation managed through
61 * struct file. However, file descriptors as handles to a struct file have
63 * - Process limits prevent more than 1024 or so being used at a time by
65 * - Inability to allocate high fds will aggravate the X Server's select()
66 * handling, and likely that of many GL client applications as well.
68 * This led to a plan of using our own integer IDs (called handles, following
69 * DRM terminology) to mimic fds, and implement the fd syscalls we need as
70 * ioctls. The objects themselves will still include the struct file so
71 * that we can transition to fds if the required kernel infrastructure shows
72 * up at a later date, and as our interface with shmfs for memory allocation.
76 * We make up offsets for buffer objects so we can recognize them at
80 /* pgoff in mmap is an unsigned long, so we need to make sure that
81 * the faked up offset will fit
84 #if BITS_PER_LONG == 64
85 #define DRM_FILE_PAGE_OFFSET_START ((0xFFFFFFFFUL >> PAGE_SHIFT) + 1)
86 #define DRM_FILE_PAGE_OFFSET_SIZE ((0xFFFFFFFFUL >> PAGE_SHIFT) * 16)
88 #define DRM_FILE_PAGE_OFFSET_START ((0xFFFFFFFUL >> PAGE_SHIFT) + 1)
89 #define DRM_FILE_PAGE_OFFSET_SIZE ((0xFFFFFFFUL >> PAGE_SHIFT) * 16)
93 * drm_gem_init - Initialize the GEM device fields
94 * @dev: drm_devic structure to initialize
97 drm_gem_init(struct drm_device *dev)
99 struct drm_vma_offset_manager *vma_offset_manager;
101 mutex_init(&dev->object_name_lock);
102 idr_init_base(&dev->object_name_idr, 1);
104 vma_offset_manager = kzalloc(sizeof(*vma_offset_manager), GFP_KERNEL);
105 if (!vma_offset_manager) {
106 DRM_ERROR("out of memory\n");
110 dev->vma_offset_manager = vma_offset_manager;
111 drm_vma_offset_manager_init(vma_offset_manager,
112 DRM_FILE_PAGE_OFFSET_START,
113 DRM_FILE_PAGE_OFFSET_SIZE);
119 drm_gem_destroy(struct drm_device *dev)
122 drm_vma_offset_manager_destroy(dev->vma_offset_manager);
123 kfree(dev->vma_offset_manager);
124 dev->vma_offset_manager = NULL;
128 * drm_gem_object_init - initialize an allocated shmem-backed GEM object
129 * @dev: drm_device the object should be initialized for
130 * @obj: drm_gem_object to initialize
133 * Initialize an already allocated GEM object of the specified size with
134 * shmfs backing store.
136 int drm_gem_object_init(struct drm_device *dev,
137 struct drm_gem_object *obj, size_t size)
141 drm_gem_private_object_init(dev, obj, size);
143 filp = shmem_file_setup("drm mm object", size, VM_NORESERVE);
145 return PTR_ERR(filp);
151 EXPORT_SYMBOL(drm_gem_object_init);
154 * drm_gem_private_object_init - initialize an allocated private GEM object
155 * @dev: drm_device the object should be initialized for
156 * @obj: drm_gem_object to initialize
159 * Initialize an already allocated GEM object of the specified size with
160 * no GEM provided backing store. Instead the caller is responsible for
161 * backing the object and handling it.
163 void drm_gem_private_object_init(struct drm_device *dev,
164 struct drm_gem_object *obj, size_t size)
166 BUG_ON((size & (PAGE_SIZE - 1)) != 0);
171 kref_init(&obj->refcount);
172 obj->handle_count = 0;
174 reservation_object_init(&obj->_resv);
176 obj->resv = &obj->_resv;
178 drm_vma_node_reset(&obj->vma_node);
180 EXPORT_SYMBOL(drm_gem_private_object_init);
183 drm_gem_remove_prime_handles(struct drm_gem_object *obj, struct drm_file *filp)
186 * Note: obj->dma_buf can't disappear as long as we still hold a
187 * handle reference in obj->handle_count.
189 mutex_lock(&filp->prime.lock);
191 drm_prime_remove_buf_handle_locked(&filp->prime,
194 mutex_unlock(&filp->prime.lock);
198 * drm_gem_object_handle_free - release resources bound to userspace handles
199 * @obj: GEM object to clean up.
201 * Called after the last handle to the object has been closed
203 * Removes any name for the object. Note that this must be
204 * called before drm_gem_object_free or we'll be touching
207 static void drm_gem_object_handle_free(struct drm_gem_object *obj)
209 struct drm_device *dev = obj->dev;
211 /* Remove any name for this object */
213 idr_remove(&dev->object_name_idr, obj->name);
218 static void drm_gem_object_exported_dma_buf_free(struct drm_gem_object *obj)
220 /* Unbreak the reference cycle if we have an exported dma_buf. */
222 dma_buf_put(obj->dma_buf);
228 drm_gem_object_handle_put_unlocked(struct drm_gem_object *obj)
230 struct drm_device *dev = obj->dev;
233 if (WARN_ON(obj->handle_count == 0))
237 * Must bump handle count first as this may be the last
238 * ref, in which case the object would disappear before we
242 mutex_lock(&dev->object_name_lock);
243 if (--obj->handle_count == 0) {
244 drm_gem_object_handle_free(obj);
245 drm_gem_object_exported_dma_buf_free(obj);
248 mutex_unlock(&dev->object_name_lock);
251 drm_gem_object_put_unlocked(obj);
255 * Called at device or object close to release the file's
256 * handle references on objects.
259 drm_gem_object_release_handle(int id, void *ptr, void *data)
261 struct drm_file *file_priv = data;
262 struct drm_gem_object *obj = ptr;
263 struct drm_device *dev = obj->dev;
265 if (obj->funcs && obj->funcs->close)
266 obj->funcs->close(obj, file_priv);
267 else if (dev->driver->gem_close_object)
268 dev->driver->gem_close_object(obj, file_priv);
270 if (drm_core_check_feature(dev, DRIVER_PRIME))
271 drm_gem_remove_prime_handles(obj, file_priv);
272 drm_vma_node_revoke(&obj->vma_node, file_priv);
274 drm_gem_object_handle_put_unlocked(obj);
280 * drm_gem_handle_delete - deletes the given file-private handle
281 * @filp: drm file-private structure to use for the handle look up
282 * @handle: userspace handle to delete
284 * Removes the GEM handle from the @filp lookup table which has been added with
285 * drm_gem_handle_create(). If this is the last handle also cleans up linked
286 * resources like GEM names.
289 drm_gem_handle_delete(struct drm_file *filp, u32 handle)
291 struct drm_gem_object *obj;
293 spin_lock(&filp->table_lock);
295 /* Check if we currently have a reference on the object */
296 obj = idr_replace(&filp->object_idr, NULL, handle);
297 spin_unlock(&filp->table_lock);
298 if (IS_ERR_OR_NULL(obj))
301 /* Release driver's reference and decrement refcount. */
302 drm_gem_object_release_handle(handle, obj, filp);
304 /* And finally make the handle available for future allocations. */
305 spin_lock(&filp->table_lock);
306 idr_remove(&filp->object_idr, handle);
307 spin_unlock(&filp->table_lock);
311 EXPORT_SYMBOL(drm_gem_handle_delete);
314 * drm_gem_dumb_map_offset - return the fake mmap offset for a gem object
315 * @file: drm file-private structure containing the gem object
316 * @dev: corresponding drm_device
317 * @handle: gem object handle
318 * @offset: return location for the fake mmap offset
320 * This implements the &drm_driver.dumb_map_offset kms driver callback for
321 * drivers which use gem to manage their backing storage.
324 * 0 on success or a negative error code on failure.
326 int drm_gem_dumb_map_offset(struct drm_file *file, struct drm_device *dev,
327 u32 handle, u64 *offset)
329 struct drm_gem_object *obj;
332 obj = drm_gem_object_lookup(file, handle);
336 /* Don't allow imported objects to be mapped */
337 if (obj->import_attach) {
342 ret = drm_gem_create_mmap_offset(obj);
346 *offset = drm_vma_node_offset_addr(&obj->vma_node);
348 drm_gem_object_put_unlocked(obj);
352 EXPORT_SYMBOL_GPL(drm_gem_dumb_map_offset);
355 * drm_gem_dumb_destroy - dumb fb callback helper for gem based drivers
356 * @file: drm file-private structure to remove the dumb handle from
357 * @dev: corresponding drm_device
358 * @handle: the dumb handle to remove
360 * This implements the &drm_driver.dumb_destroy kms driver callback for drivers
361 * which use gem to manage their backing storage.
363 int drm_gem_dumb_destroy(struct drm_file *file,
364 struct drm_device *dev,
367 return drm_gem_handle_delete(file, handle);
369 EXPORT_SYMBOL(drm_gem_dumb_destroy);
372 * drm_gem_handle_create_tail - internal functions to create a handle
373 * @file_priv: drm file-private structure to register the handle for
374 * @obj: object to register
375 * @handlep: pointer to return the created handle to the caller
377 * This expects the &drm_device.object_name_lock to be held already and will
378 * drop it before returning. Used to avoid races in establishing new handles
379 * when importing an object from either an flink name or a dma-buf.
381 * Handles must be release again through drm_gem_handle_delete(). This is done
382 * when userspace closes @file_priv for all attached handles, or through the
383 * GEM_CLOSE ioctl for individual handles.
386 drm_gem_handle_create_tail(struct drm_file *file_priv,
387 struct drm_gem_object *obj,
390 struct drm_device *dev = obj->dev;
394 WARN_ON(!mutex_is_locked(&dev->object_name_lock));
395 if (obj->handle_count++ == 0)
396 drm_gem_object_get(obj);
399 * Get the user-visible handle using idr. Preload and perform
400 * allocation under our spinlock.
402 idr_preload(GFP_KERNEL);
403 spin_lock(&file_priv->table_lock);
405 ret = idr_alloc(&file_priv->object_idr, obj, 1, 0, GFP_NOWAIT);
407 spin_unlock(&file_priv->table_lock);
410 mutex_unlock(&dev->object_name_lock);
416 ret = drm_vma_node_allow(&obj->vma_node, file_priv);
420 if (obj->funcs && obj->funcs->open) {
421 ret = obj->funcs->open(obj, file_priv);
424 } else if (dev->driver->gem_open_object) {
425 ret = dev->driver->gem_open_object(obj, file_priv);
434 drm_vma_node_revoke(&obj->vma_node, file_priv);
436 spin_lock(&file_priv->table_lock);
437 idr_remove(&file_priv->object_idr, handle);
438 spin_unlock(&file_priv->table_lock);
440 drm_gem_object_handle_put_unlocked(obj);
445 * drm_gem_handle_create - create a gem handle for an object
446 * @file_priv: drm file-private structure to register the handle for
447 * @obj: object to register
448 * @handlep: pionter to return the created handle to the caller
450 * Create a handle for this object. This adds a handle reference to the object,
451 * which includes a regular reference count. Callers will likely want to
452 * dereference the object afterwards.
454 * Since this publishes @obj to userspace it must be fully set up by this point,
455 * drivers must call this last in their buffer object creation callbacks.
457 int drm_gem_handle_create(struct drm_file *file_priv,
458 struct drm_gem_object *obj,
461 mutex_lock(&obj->dev->object_name_lock);
463 return drm_gem_handle_create_tail(file_priv, obj, handlep);
465 EXPORT_SYMBOL(drm_gem_handle_create);
469 * drm_gem_free_mmap_offset - release a fake mmap offset for an object
470 * @obj: obj in question
472 * This routine frees fake offsets allocated by drm_gem_create_mmap_offset().
474 * Note that drm_gem_object_release() already calls this function, so drivers
475 * don't have to take care of releasing the mmap offset themselves when freeing
479 drm_gem_free_mmap_offset(struct drm_gem_object *obj)
481 struct drm_device *dev = obj->dev;
483 drm_vma_offset_remove(dev->vma_offset_manager, &obj->vma_node);
485 EXPORT_SYMBOL(drm_gem_free_mmap_offset);
488 * drm_gem_create_mmap_offset_size - create a fake mmap offset for an object
489 * @obj: obj in question
490 * @size: the virtual size
492 * GEM memory mapping works by handing back to userspace a fake mmap offset
493 * it can use in a subsequent mmap(2) call. The DRM core code then looks
494 * up the object based on the offset and sets up the various memory mapping
497 * This routine allocates and attaches a fake offset for @obj, in cases where
498 * the virtual size differs from the physical size (ie. &drm_gem_object.size).
499 * Otherwise just use drm_gem_create_mmap_offset().
501 * This function is idempotent and handles an already allocated mmap offset
502 * transparently. Drivers do not need to check for this case.
505 drm_gem_create_mmap_offset_size(struct drm_gem_object *obj, size_t size)
507 struct drm_device *dev = obj->dev;
509 return drm_vma_offset_add(dev->vma_offset_manager, &obj->vma_node,
512 EXPORT_SYMBOL(drm_gem_create_mmap_offset_size);
515 * drm_gem_create_mmap_offset - create a fake mmap offset for an object
516 * @obj: obj in question
518 * GEM memory mapping works by handing back to userspace a fake mmap offset
519 * it can use in a subsequent mmap(2) call. The DRM core code then looks
520 * up the object based on the offset and sets up the various memory mapping
523 * This routine allocates and attaches a fake offset for @obj.
525 * Drivers can call drm_gem_free_mmap_offset() before freeing @obj to release
526 * the fake offset again.
528 int drm_gem_create_mmap_offset(struct drm_gem_object *obj)
530 return drm_gem_create_mmap_offset_size(obj, obj->size);
532 EXPORT_SYMBOL(drm_gem_create_mmap_offset);
535 * Move pages to appropriate lru and release the pagevec, decrementing the
536 * ref count of those pages.
538 static void drm_gem_check_release_pagevec(struct pagevec *pvec)
540 check_move_unevictable_pages(pvec);
541 __pagevec_release(pvec);
546 * drm_gem_get_pages - helper to allocate backing pages for a GEM object
548 * @obj: obj in question
550 * This reads the page-array of the shmem-backing storage of the given gem
551 * object. An array of pages is returned. If a page is not allocated or
552 * swapped-out, this will allocate/swap-in the required pages. Note that the
553 * whole object is covered by the page-array and pinned in memory.
555 * Use drm_gem_put_pages() to release the array and unpin all pages.
557 * This uses the GFP-mask set on the shmem-mapping (see mapping_set_gfp_mask()).
558 * If you require other GFP-masks, you have to do those allocations yourself.
560 * Note that you are not allowed to change gfp-zones during runtime. That is,
561 * shmem_read_mapping_page_gfp() must be called with the same gfp_zone(gfp) as
562 * set during initialization. If you have special zone constraints, set them
563 * after drm_gem_object_init() via mapping_set_gfp_mask(). shmem-core takes care
564 * to keep pages in the required zone during swap-in.
566 struct page **drm_gem_get_pages(struct drm_gem_object *obj)
568 struct address_space *mapping;
569 struct page *p, **pages;
573 /* This is the shared memory object that backs the GEM resource */
574 mapping = obj->filp->f_mapping;
576 /* We already BUG_ON() for non-page-aligned sizes in
577 * drm_gem_object_init(), so we should never hit this unless
578 * driver author is doing something really wrong:
580 WARN_ON((obj->size & (PAGE_SIZE - 1)) != 0);
582 npages = obj->size >> PAGE_SHIFT;
584 pages = kvmalloc_array(npages, sizeof(struct page *), GFP_KERNEL);
586 return ERR_PTR(-ENOMEM);
588 mapping_set_unevictable(mapping);
590 for (i = 0; i < npages; i++) {
591 p = shmem_read_mapping_page(mapping, i);
596 /* Make sure shmem keeps __GFP_DMA32 allocated pages in the
597 * correct region during swapin. Note that this requires
598 * __GFP_DMA32 to be set in mapping_gfp_mask(inode->i_mapping)
599 * so shmem can relocate pages during swapin if required.
601 BUG_ON(mapping_gfp_constraint(mapping, __GFP_DMA32) &&
602 (page_to_pfn(p) >= 0x00100000UL));
608 mapping_clear_unevictable(mapping);
611 if (!pagevec_add(&pvec, pages[i]))
612 drm_gem_check_release_pagevec(&pvec);
614 if (pagevec_count(&pvec))
615 drm_gem_check_release_pagevec(&pvec);
620 EXPORT_SYMBOL(drm_gem_get_pages);
623 * drm_gem_put_pages - helper to free backing pages for a GEM object
624 * @obj: obj in question
625 * @pages: pages to free
626 * @dirty: if true, pages will be marked as dirty
627 * @accessed: if true, the pages will be marked as accessed
629 void drm_gem_put_pages(struct drm_gem_object *obj, struct page **pages,
630 bool dirty, bool accessed)
633 struct address_space *mapping;
636 mapping = file_inode(obj->filp)->i_mapping;
637 mapping_clear_unevictable(mapping);
639 /* We already BUG_ON() for non-page-aligned sizes in
640 * drm_gem_object_init(), so we should never hit this unless
641 * driver author is doing something really wrong:
643 WARN_ON((obj->size & (PAGE_SIZE - 1)) != 0);
645 npages = obj->size >> PAGE_SHIFT;
648 for (i = 0; i < npages; i++) {
650 set_page_dirty(pages[i]);
653 mark_page_accessed(pages[i]);
655 /* Undo the reference we took when populating the table */
656 if (!pagevec_add(&pvec, pages[i]))
657 drm_gem_check_release_pagevec(&pvec);
659 if (pagevec_count(&pvec))
660 drm_gem_check_release_pagevec(&pvec);
664 EXPORT_SYMBOL(drm_gem_put_pages);
667 * drm_gem_object_lookup - look up a GEM object from its handle
668 * @filp: DRM file private date
669 * @handle: userspace handle
673 * A reference to the object named by the handle if such exists on @filp, NULL
676 struct drm_gem_object *
677 drm_gem_object_lookup(struct drm_file *filp, u32 handle)
679 struct drm_gem_object *obj;
681 spin_lock(&filp->table_lock);
683 /* Check if we currently have a reference on the object */
684 obj = idr_find(&filp->object_idr, handle);
686 drm_gem_object_get(obj);
688 spin_unlock(&filp->table_lock);
692 EXPORT_SYMBOL(drm_gem_object_lookup);
695 * drm_gem_reservation_object_wait - Wait on GEM object's reservation's objects
696 * shared and/or exclusive fences.
697 * @filep: DRM file private date
698 * @handle: userspace handle
699 * @wait_all: if true, wait on all fences, else wait on just exclusive fence
700 * @timeout: timeout value in jiffies or zero to return immediately
704 * Returns -ERESTARTSYS if interrupted, 0 if the wait timed out, or
705 * greater than 0 on success.
707 long drm_gem_reservation_object_wait(struct drm_file *filep, u32 handle,
708 bool wait_all, unsigned long timeout)
711 struct drm_gem_object *obj;
713 obj = drm_gem_object_lookup(filep, handle);
715 DRM_DEBUG("Failed to look up GEM BO %d\n", handle);
719 ret = reservation_object_wait_timeout_rcu(obj->resv, wait_all,
726 drm_gem_object_put_unlocked(obj);
730 EXPORT_SYMBOL(drm_gem_reservation_object_wait);
733 * drm_gem_close_ioctl - implementation of the GEM_CLOSE ioctl
736 * @file_priv: drm file-private structure
738 * Releases the handle to an mm object.
741 drm_gem_close_ioctl(struct drm_device *dev, void *data,
742 struct drm_file *file_priv)
744 struct drm_gem_close *args = data;
747 if (!drm_core_check_feature(dev, DRIVER_GEM))
750 ret = drm_gem_handle_delete(file_priv, args->handle);
756 * drm_gem_flink_ioctl - implementation of the GEM_FLINK ioctl
759 * @file_priv: drm file-private structure
761 * Create a global name for an object, returning the name.
763 * Note that the name does not hold a reference; when the object
764 * is freed, the name goes away.
767 drm_gem_flink_ioctl(struct drm_device *dev, void *data,
768 struct drm_file *file_priv)
770 struct drm_gem_flink *args = data;
771 struct drm_gem_object *obj;
774 if (!drm_core_check_feature(dev, DRIVER_GEM))
777 obj = drm_gem_object_lookup(file_priv, args->handle);
781 mutex_lock(&dev->object_name_lock);
782 /* prevent races with concurrent gem_close. */
783 if (obj->handle_count == 0) {
789 ret = idr_alloc(&dev->object_name_idr, obj, 1, 0, GFP_KERNEL);
796 args->name = (uint64_t) obj->name;
800 mutex_unlock(&dev->object_name_lock);
801 drm_gem_object_put_unlocked(obj);
806 * drm_gem_open - implementation of the GEM_OPEN ioctl
809 * @file_priv: drm file-private structure
811 * Open an object using the global name, returning a handle and the size.
813 * This handle (of course) holds a reference to the object, so the object
814 * will not go away until the handle is deleted.
817 drm_gem_open_ioctl(struct drm_device *dev, void *data,
818 struct drm_file *file_priv)
820 struct drm_gem_open *args = data;
821 struct drm_gem_object *obj;
825 if (!drm_core_check_feature(dev, DRIVER_GEM))
828 mutex_lock(&dev->object_name_lock);
829 obj = idr_find(&dev->object_name_idr, (int) args->name);
831 drm_gem_object_get(obj);
833 mutex_unlock(&dev->object_name_lock);
837 /* drm_gem_handle_create_tail unlocks dev->object_name_lock. */
838 ret = drm_gem_handle_create_tail(file_priv, obj, &handle);
839 drm_gem_object_put_unlocked(obj);
843 args->handle = handle;
844 args->size = obj->size;
850 * gem_gem_open - initalizes GEM file-private structures at devnode open time
851 * @dev: drm_device which is being opened by userspace
852 * @file_private: drm file-private structure to set up
854 * Called at device open time, sets up the structure for handling refcounting
858 drm_gem_open(struct drm_device *dev, struct drm_file *file_private)
860 idr_init_base(&file_private->object_idr, 1);
861 spin_lock_init(&file_private->table_lock);
865 * drm_gem_release - release file-private GEM resources
866 * @dev: drm_device which is being closed by userspace
867 * @file_private: drm file-private structure to clean up
869 * Called at close time when the filp is going away.
871 * Releases any remaining references on objects by this filp.
874 drm_gem_release(struct drm_device *dev, struct drm_file *file_private)
876 idr_for_each(&file_private->object_idr,
877 &drm_gem_object_release_handle, file_private);
878 idr_destroy(&file_private->object_idr);
882 * drm_gem_object_release - release GEM buffer object resources
883 * @obj: GEM buffer object
885 * This releases any structures and resources used by @obj and is the invers of
886 * drm_gem_object_init().
889 drm_gem_object_release(struct drm_gem_object *obj)
891 WARN_ON(obj->dma_buf);
896 reservation_object_fini(&obj->_resv);
897 drm_gem_free_mmap_offset(obj);
899 EXPORT_SYMBOL(drm_gem_object_release);
902 * drm_gem_object_free - free a GEM object
903 * @kref: kref of the object to free
905 * Called after the last reference to the object has been lost.
906 * Must be called holding &drm_device.struct_mutex.
911 drm_gem_object_free(struct kref *kref)
913 struct drm_gem_object *obj =
914 container_of(kref, struct drm_gem_object, refcount);
915 struct drm_device *dev = obj->dev;
918 obj->funcs->free(obj);
919 } else if (dev->driver->gem_free_object_unlocked) {
920 dev->driver->gem_free_object_unlocked(obj);
921 } else if (dev->driver->gem_free_object) {
922 WARN_ON(!mutex_is_locked(&dev->struct_mutex));
924 dev->driver->gem_free_object(obj);
927 EXPORT_SYMBOL(drm_gem_object_free);
930 * drm_gem_object_put_unlocked - drop a GEM buffer object reference
931 * @obj: GEM buffer object
933 * This releases a reference to @obj. Callers must not hold the
934 * &drm_device.struct_mutex lock when calling this function.
936 * See also __drm_gem_object_put().
939 drm_gem_object_put_unlocked(struct drm_gem_object *obj)
941 struct drm_device *dev;
948 if (dev->driver->gem_free_object) {
949 might_lock(&dev->struct_mutex);
950 if (kref_put_mutex(&obj->refcount, drm_gem_object_free,
952 mutex_unlock(&dev->struct_mutex);
954 kref_put(&obj->refcount, drm_gem_object_free);
957 EXPORT_SYMBOL(drm_gem_object_put_unlocked);
960 * drm_gem_object_put - release a GEM buffer object reference
961 * @obj: GEM buffer object
963 * This releases a reference to @obj. Callers must hold the
964 * &drm_device.struct_mutex lock when calling this function, even when the
965 * driver doesn't use &drm_device.struct_mutex for anything.
967 * For drivers not encumbered with legacy locking use
968 * drm_gem_object_put_unlocked() instead.
971 drm_gem_object_put(struct drm_gem_object *obj)
974 WARN_ON(!mutex_is_locked(&obj->dev->struct_mutex));
976 kref_put(&obj->refcount, drm_gem_object_free);
979 EXPORT_SYMBOL(drm_gem_object_put);
982 * drm_gem_vm_open - vma->ops->open implementation for GEM
983 * @vma: VM area structure
985 * This function implements the #vm_operations_struct open() callback for GEM
986 * drivers. This must be used together with drm_gem_vm_close().
988 void drm_gem_vm_open(struct vm_area_struct *vma)
990 struct drm_gem_object *obj = vma->vm_private_data;
992 drm_gem_object_get(obj);
994 EXPORT_SYMBOL(drm_gem_vm_open);
997 * drm_gem_vm_close - vma->ops->close implementation for GEM
998 * @vma: VM area structure
1000 * This function implements the #vm_operations_struct close() callback for GEM
1001 * drivers. This must be used together with drm_gem_vm_open().
1003 void drm_gem_vm_close(struct vm_area_struct *vma)
1005 struct drm_gem_object *obj = vma->vm_private_data;
1007 drm_gem_object_put_unlocked(obj);
1009 EXPORT_SYMBOL(drm_gem_vm_close);
1012 * drm_gem_mmap_obj - memory map a GEM object
1013 * @obj: the GEM object to map
1014 * @obj_size: the object size to be mapped, in bytes
1015 * @vma: VMA for the area to be mapped
1017 * Set up the VMA to prepare mapping of the GEM object using the gem_vm_ops
1018 * provided by the driver. Depending on their requirements, drivers can either
1019 * provide a fault handler in their gem_vm_ops (in which case any accesses to
1020 * the object will be trapped, to perform migration, GTT binding, surface
1021 * register allocation, or performance monitoring), or mmap the buffer memory
1022 * synchronously after calling drm_gem_mmap_obj.
1024 * This function is mainly intended to implement the DMABUF mmap operation, when
1025 * the GEM object is not looked up based on its fake offset. To implement the
1026 * DRM mmap operation, drivers should use the drm_gem_mmap() function.
1028 * drm_gem_mmap_obj() assumes the user is granted access to the buffer while
1029 * drm_gem_mmap() prevents unprivileged users from mapping random objects. So
1030 * callers must verify access restrictions before calling this helper.
1032 * Return 0 or success or -EINVAL if the object size is smaller than the VMA
1033 * size, or if no gem_vm_ops are provided.
1035 int drm_gem_mmap_obj(struct drm_gem_object *obj, unsigned long obj_size,
1036 struct vm_area_struct *vma)
1038 struct drm_device *dev = obj->dev;
1040 /* Check for valid size. */
1041 if (obj_size < vma->vm_end - vma->vm_start)
1044 if (obj->funcs && obj->funcs->vm_ops)
1045 vma->vm_ops = obj->funcs->vm_ops;
1046 else if (dev->driver->gem_vm_ops)
1047 vma->vm_ops = dev->driver->gem_vm_ops;
1051 vma->vm_flags |= VM_IO | VM_PFNMAP | VM_DONTEXPAND | VM_DONTDUMP;
1052 vma->vm_private_data = obj;
1053 vma->vm_page_prot = pgprot_writecombine(vm_get_page_prot(vma->vm_flags));
1054 vma->vm_page_prot = pgprot_decrypted(vma->vm_page_prot);
1056 /* Take a ref for this mapping of the object, so that the fault
1057 * handler can dereference the mmap offset's pointer to the object.
1058 * This reference is cleaned up by the corresponding vm_close
1059 * (which should happen whether the vma was created by this call, or
1060 * by a vm_open due to mremap or partial unmap or whatever).
1062 drm_gem_object_get(obj);
1066 EXPORT_SYMBOL(drm_gem_mmap_obj);
1069 * drm_gem_mmap - memory map routine for GEM objects
1070 * @filp: DRM file pointer
1071 * @vma: VMA for the area to be mapped
1073 * If a driver supports GEM object mapping, mmap calls on the DRM file
1074 * descriptor will end up here.
1076 * Look up the GEM object based on the offset passed in (vma->vm_pgoff will
1077 * contain the fake offset we created when the GTT map ioctl was called on
1078 * the object) and map it with a call to drm_gem_mmap_obj().
1080 * If the caller is not granted access to the buffer object, the mmap will fail
1081 * with EACCES. Please see the vma manager for more information.
1083 int drm_gem_mmap(struct file *filp, struct vm_area_struct *vma)
1085 struct drm_file *priv = filp->private_data;
1086 struct drm_device *dev = priv->minor->dev;
1087 struct drm_gem_object *obj = NULL;
1088 struct drm_vma_offset_node *node;
1091 if (drm_dev_is_unplugged(dev))
1094 drm_vma_offset_lock_lookup(dev->vma_offset_manager);
1095 node = drm_vma_offset_exact_lookup_locked(dev->vma_offset_manager,
1099 obj = container_of(node, struct drm_gem_object, vma_node);
1101 * When the object is being freed, after it hits 0-refcnt it
1102 * proceeds to tear down the object. In the process it will
1103 * attempt to remove the VMA offset and so acquire this
1104 * mgr->vm_lock. Therefore if we find an object with a 0-refcnt
1105 * that matches our range, we know it is in the process of being
1106 * destroyed and will be freed as soon as we release the lock -
1107 * so we have to check for the 0-refcnted object and treat it as
1110 if (!kref_get_unless_zero(&obj->refcount))
1113 drm_vma_offset_unlock_lookup(dev->vma_offset_manager);
1118 if (!drm_vma_node_is_allowed(node, priv)) {
1119 drm_gem_object_put_unlocked(obj);
1123 if (node->readonly) {
1124 if (vma->vm_flags & VM_WRITE) {
1125 drm_gem_object_put_unlocked(obj);
1129 vma->vm_flags &= ~VM_MAYWRITE;
1132 ret = drm_gem_mmap_obj(obj, drm_vma_node_size(node) << PAGE_SHIFT,
1135 drm_gem_object_put_unlocked(obj);
1139 EXPORT_SYMBOL(drm_gem_mmap);
1141 void drm_gem_print_info(struct drm_printer *p, unsigned int indent,
1142 const struct drm_gem_object *obj)
1144 drm_printf_indent(p, indent, "name=%d\n", obj->name);
1145 drm_printf_indent(p, indent, "refcount=%u\n",
1146 kref_read(&obj->refcount));
1147 drm_printf_indent(p, indent, "start=%08lx\n",
1148 drm_vma_node_start(&obj->vma_node));
1149 drm_printf_indent(p, indent, "size=%zu\n", obj->size);
1150 drm_printf_indent(p, indent, "imported=%s\n",
1151 obj->import_attach ? "yes" : "no");
1153 if (obj->funcs && obj->funcs->print_info)
1154 obj->funcs->print_info(p, indent, obj);
1155 else if (obj->dev->driver->gem_print_info)
1156 obj->dev->driver->gem_print_info(p, indent, obj);
1160 * drm_gem_pin - Pin backing buffer in memory
1163 * Make sure the backing buffer is pinned in memory.
1166 * 0 on success or a negative error code on failure.
1168 int drm_gem_pin(struct drm_gem_object *obj)
1170 if (obj->funcs && obj->funcs->pin)
1171 return obj->funcs->pin(obj);
1172 else if (obj->dev->driver->gem_prime_pin)
1173 return obj->dev->driver->gem_prime_pin(obj);
1177 EXPORT_SYMBOL(drm_gem_pin);
1180 * drm_gem_unpin - Unpin backing buffer from memory
1183 * Relax the requirement that the backing buffer is pinned in memory.
1185 void drm_gem_unpin(struct drm_gem_object *obj)
1187 if (obj->funcs && obj->funcs->unpin)
1188 obj->funcs->unpin(obj);
1189 else if (obj->dev->driver->gem_prime_unpin)
1190 obj->dev->driver->gem_prime_unpin(obj);
1192 EXPORT_SYMBOL(drm_gem_unpin);
1195 * drm_gem_vmap - Map buffer into kernel virtual address space
1199 * A virtual pointer to a newly created GEM object or an ERR_PTR-encoded negative
1200 * error code on failure.
1202 void *drm_gem_vmap(struct drm_gem_object *obj)
1206 if (obj->funcs && obj->funcs->vmap)
1207 vaddr = obj->funcs->vmap(obj);
1208 else if (obj->dev->driver->gem_prime_vmap)
1209 vaddr = obj->dev->driver->gem_prime_vmap(obj);
1211 vaddr = ERR_PTR(-EOPNOTSUPP);
1214 vaddr = ERR_PTR(-ENOMEM);
1218 EXPORT_SYMBOL(drm_gem_vmap);
1221 * drm_gem_vunmap - Remove buffer mapping from kernel virtual address space
1223 * @vaddr: Virtual address (can be NULL)
1225 void drm_gem_vunmap(struct drm_gem_object *obj, void *vaddr)
1230 if (obj->funcs && obj->funcs->vunmap)
1231 obj->funcs->vunmap(obj, vaddr);
1232 else if (obj->dev->driver->gem_prime_vunmap)
1233 obj->dev->driver->gem_prime_vunmap(obj, vaddr);
1235 EXPORT_SYMBOL(drm_gem_vunmap);
1238 * drm_gem_lock_reservations - Sets up the ww context and acquires
1239 * the lock on an array of GEM objects.
1241 * Once you've locked your reservations, you'll want to set up space
1242 * for your shared fences (if applicable), submit your job, then
1243 * drm_gem_unlock_reservations().
1245 * @objs: drm_gem_objects to lock
1246 * @count: Number of objects in @objs
1247 * @acquire_ctx: struct ww_acquire_ctx that will be initialized as
1248 * part of tracking this set of locked reservations.
1251 drm_gem_lock_reservations(struct drm_gem_object **objs, int count,
1252 struct ww_acquire_ctx *acquire_ctx)
1257 ww_acquire_init(acquire_ctx, &reservation_ww_class);
1260 if (contended != -1) {
1261 struct drm_gem_object *obj = objs[contended];
1263 ret = ww_mutex_lock_slow_interruptible(&obj->resv->lock,
1266 ww_acquire_done(acquire_ctx);
1271 for (i = 0; i < count; i++) {
1275 ret = ww_mutex_lock_interruptible(&objs[i]->resv->lock,
1280 for (j = 0; j < i; j++)
1281 ww_mutex_unlock(&objs[j]->resv->lock);
1283 if (contended != -1 && contended >= i)
1284 ww_mutex_unlock(&objs[contended]->resv->lock);
1286 if (ret == -EDEADLK) {
1291 ww_acquire_done(acquire_ctx);
1296 ww_acquire_done(acquire_ctx);
1300 EXPORT_SYMBOL(drm_gem_lock_reservations);
1303 drm_gem_unlock_reservations(struct drm_gem_object **objs, int count,
1304 struct ww_acquire_ctx *acquire_ctx)
1308 for (i = 0; i < count; i++)
1309 ww_mutex_unlock(&objs[i]->resv->lock);
1311 ww_acquire_fini(acquire_ctx);
1313 EXPORT_SYMBOL(drm_gem_unlock_reservations);