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>
43 * This file provides some of the base ioctls and library routines for
44 * the graphics memory manager implemented by each device driver.
46 * Because various devices have different requirements in terms of
47 * synchronization and migration strategies, implementing that is left up to
48 * the driver, and all that the general API provides should be generic --
49 * allocating objects, reading/writing data with the cpu, freeing objects.
50 * Even there, platform-dependent optimizations for reading/writing data with
51 * the CPU mean we'll likely hook those out to driver-specific calls. However,
52 * the DRI2 implementation wants to have at least allocate/mmap be generic.
54 * The goal was to have swap-backed object allocation managed through
55 * struct file. However, file descriptors as handles to a struct file have
57 * - Process limits prevent more than 1024 or so being used at a time by
59 * - Inability to allocate high fds will aggravate the X Server's select()
60 * handling, and likely that of many GL client applications as well.
62 * This led to a plan of using our own integer IDs (called handles, following
63 * DRM terminology) to mimic fds, and implement the fd syscalls we need as
64 * ioctls. The objects themselves will still include the struct file so
65 * that we can transition to fds if the required kernel infrastructure shows
66 * up at a later date, and as our interface with shmfs for memory allocation.
70 * We make up offsets for buffer objects so we can recognize them at
74 /* pgoff in mmap is an unsigned long, so we need to make sure that
75 * the faked up offset will fit
78 #if BITS_PER_LONG == 64
79 #define DRM_FILE_PAGE_OFFSET_START ((0xFFFFFFFFUL >> PAGE_SHIFT) + 1)
80 #define DRM_FILE_PAGE_OFFSET_SIZE ((0xFFFFFFFFUL >> PAGE_SHIFT) * 16)
82 #define DRM_FILE_PAGE_OFFSET_START ((0xFFFFFFFUL >> PAGE_SHIFT) + 1)
83 #define DRM_FILE_PAGE_OFFSET_SIZE ((0xFFFFFFFUL >> PAGE_SHIFT) * 16)
87 * Initialize the GEM device fields
91 drm_gem_init(struct drm_device
*dev
)
93 struct drm_gem_mm
*mm
;
95 spin_lock_init(&dev
->object_name_lock
);
96 idr_init(&dev
->object_name_idr
);
98 mm
= kzalloc(sizeof(struct drm_gem_mm
), GFP_KERNEL
);
100 DRM_ERROR("out of memory\n");
104 dev
->mm_private
= mm
;
106 if (drm_ht_create(&mm
->offset_hash
, 12)) {
111 drm_mm_init(&mm
->offset_manager
, DRM_FILE_PAGE_OFFSET_START
,
112 DRM_FILE_PAGE_OFFSET_SIZE
);
118 drm_gem_destroy(struct drm_device
*dev
)
120 struct drm_gem_mm
*mm
= dev
->mm_private
;
122 drm_mm_takedown(&mm
->offset_manager
);
123 drm_ht_remove(&mm
->offset_hash
);
125 dev
->mm_private
= NULL
;
129 * Initialize an already allocated GEM object of the specified size with
130 * shmfs backing store.
132 int drm_gem_object_init(struct drm_device
*dev
,
133 struct drm_gem_object
*obj
, size_t size
)
135 BUG_ON((size
& (PAGE_SIZE
- 1)) != 0);
138 obj
->filp
= shmem_file_setup("drm mm object", size
, VM_NORESERVE
);
139 if (IS_ERR(obj
->filp
))
140 return PTR_ERR(obj
->filp
);
142 kref_init(&obj
->refcount
);
143 atomic_set(&obj
->handle_count
, 0);
148 EXPORT_SYMBOL(drm_gem_object_init
);
151 * Initialize an already allocated GEM object of the specified size with
152 * no GEM provided backing store. Instead the caller is responsible for
153 * backing the object and handling it.
155 int drm_gem_private_object_init(struct drm_device
*dev
,
156 struct drm_gem_object
*obj
, size_t size
)
158 BUG_ON((size
& (PAGE_SIZE
- 1)) != 0);
163 kref_init(&obj
->refcount
);
164 atomic_set(&obj
->handle_count
, 0);
169 EXPORT_SYMBOL(drm_gem_private_object_init
);
172 * Allocate a GEM object of the specified size with shmfs backing store
174 struct drm_gem_object
*
175 drm_gem_object_alloc(struct drm_device
*dev
, size_t size
)
177 struct drm_gem_object
*obj
;
179 obj
= kzalloc(sizeof(*obj
), GFP_KERNEL
);
183 if (drm_gem_object_init(dev
, obj
, size
) != 0)
186 if (dev
->driver
->gem_init_object
!= NULL
&&
187 dev
->driver
->gem_init_object(obj
) != 0) {
192 /* Object_init mangles the global counters - readjust them. */
198 EXPORT_SYMBOL(drm_gem_object_alloc
);
201 drm_gem_remove_prime_handles(struct drm_gem_object
*obj
, struct drm_file
*filp
)
203 if (obj
->import_attach
) {
204 drm_prime_remove_buf_handle(&filp
->prime
,
205 obj
->import_attach
->dmabuf
);
207 if (obj
->export_dma_buf
) {
208 drm_prime_remove_buf_handle(&filp
->prime
,
209 obj
->export_dma_buf
);
214 * Removes the mapping from handle to filp for this object.
217 drm_gem_handle_delete(struct drm_file
*filp
, u32 handle
)
219 struct drm_device
*dev
;
220 struct drm_gem_object
*obj
;
222 /* This is gross. The idr system doesn't let us try a delete and
223 * return an error code. It just spews if you fail at deleting.
224 * So, we have to grab a lock around finding the object and then
225 * doing the delete on it and dropping the refcount, or the user
226 * could race us to double-decrement the refcount and cause a
227 * use-after-free later. Given the frequency of our handle lookups,
228 * we may want to use ida for number allocation and a hash table
229 * for the pointers, anyway.
231 spin_lock(&filp
->table_lock
);
233 /* Check if we currently have a reference on the object */
234 obj
= idr_find(&filp
->object_idr
, handle
);
236 spin_unlock(&filp
->table_lock
);
241 /* Release reference and decrement refcount. */
242 idr_remove(&filp
->object_idr
, handle
);
243 spin_unlock(&filp
->table_lock
);
245 drm_gem_remove_prime_handles(obj
, filp
);
247 if (dev
->driver
->gem_close_object
)
248 dev
->driver
->gem_close_object(obj
, filp
);
249 drm_gem_object_handle_unreference_unlocked(obj
);
253 EXPORT_SYMBOL(drm_gem_handle_delete
);
256 * Create a handle for this object. This adds a handle reference
257 * to the object, which includes a regular reference count. Callers
258 * will likely want to dereference the object afterwards.
261 drm_gem_handle_create(struct drm_file
*file_priv
,
262 struct drm_gem_object
*obj
,
265 struct drm_device
*dev
= obj
->dev
;
269 * Get the user-visible handle using idr. Preload and perform
270 * allocation under our spinlock.
272 idr_preload(GFP_KERNEL
);
273 spin_lock(&file_priv
->table_lock
);
275 ret
= idr_alloc(&file_priv
->object_idr
, obj
, 1, 0, GFP_NOWAIT
);
277 spin_unlock(&file_priv
->table_lock
);
283 drm_gem_object_handle_reference(obj
);
285 if (dev
->driver
->gem_open_object
) {
286 ret
= dev
->driver
->gem_open_object(obj
, file_priv
);
288 drm_gem_handle_delete(file_priv
, *handlep
);
295 EXPORT_SYMBOL(drm_gem_handle_create
);
299 * drm_gem_free_mmap_offset - release a fake mmap offset for an object
300 * @obj: obj in question
302 * This routine frees fake offsets allocated by drm_gem_create_mmap_offset().
305 drm_gem_free_mmap_offset(struct drm_gem_object
*obj
)
307 struct drm_device
*dev
= obj
->dev
;
308 struct drm_gem_mm
*mm
= dev
->mm_private
;
309 struct drm_map_list
*list
= &obj
->map_list
;
311 drm_ht_remove_item(&mm
->offset_hash
, &list
->hash
);
312 drm_mm_put_block(list
->file_offset_node
);
316 EXPORT_SYMBOL(drm_gem_free_mmap_offset
);
319 * drm_gem_create_mmap_offset - create a fake mmap offset for an object
320 * @obj: obj in question
322 * GEM memory mapping works by handing back to userspace a fake mmap offset
323 * it can use in a subsequent mmap(2) call. The DRM core code then looks
324 * up the object based on the offset and sets up the various memory mapping
327 * This routine allocates and attaches a fake offset for @obj.
330 drm_gem_create_mmap_offset(struct drm_gem_object
*obj
)
332 struct drm_device
*dev
= obj
->dev
;
333 struct drm_gem_mm
*mm
= dev
->mm_private
;
334 struct drm_map_list
*list
;
335 struct drm_local_map
*map
;
338 /* Set the object up for mmap'ing */
339 list
= &obj
->map_list
;
340 list
->map
= kzalloc(sizeof(struct drm_map_list
), GFP_KERNEL
);
345 map
->type
= _DRM_GEM
;
346 map
->size
= obj
->size
;
349 /* Get a DRM GEM mmap offset allocated... */
350 list
->file_offset_node
= drm_mm_search_free(&mm
->offset_manager
,
351 obj
->size
/ PAGE_SIZE
, 0, false);
353 if (!list
->file_offset_node
) {
354 DRM_ERROR("failed to allocate offset for bo %d\n", obj
->name
);
359 list
->file_offset_node
= drm_mm_get_block(list
->file_offset_node
,
360 obj
->size
/ PAGE_SIZE
, 0);
361 if (!list
->file_offset_node
) {
366 list
->hash
.key
= list
->file_offset_node
->start
;
367 ret
= drm_ht_insert_item(&mm
->offset_hash
, &list
->hash
);
369 DRM_ERROR("failed to add to map hash\n");
376 drm_mm_put_block(list
->file_offset_node
);
383 EXPORT_SYMBOL(drm_gem_create_mmap_offset
);
385 /** Returns a reference to the object named by the handle. */
386 struct drm_gem_object
*
387 drm_gem_object_lookup(struct drm_device
*dev
, struct drm_file
*filp
,
390 struct drm_gem_object
*obj
;
392 spin_lock(&filp
->table_lock
);
394 /* Check if we currently have a reference on the object */
395 obj
= idr_find(&filp
->object_idr
, handle
);
397 spin_unlock(&filp
->table_lock
);
401 drm_gem_object_reference(obj
);
403 spin_unlock(&filp
->table_lock
);
407 EXPORT_SYMBOL(drm_gem_object_lookup
);
410 * Releases the handle to an mm object.
413 drm_gem_close_ioctl(struct drm_device
*dev
, void *data
,
414 struct drm_file
*file_priv
)
416 struct drm_gem_close
*args
= data
;
419 if (!(dev
->driver
->driver_features
& DRIVER_GEM
))
422 ret
= drm_gem_handle_delete(file_priv
, args
->handle
);
428 * Create a global name for an object, returning the name.
430 * Note that the name does not hold a reference; when the object
431 * is freed, the name goes away.
434 drm_gem_flink_ioctl(struct drm_device
*dev
, void *data
,
435 struct drm_file
*file_priv
)
437 struct drm_gem_flink
*args
= data
;
438 struct drm_gem_object
*obj
;
441 if (!(dev
->driver
->driver_features
& DRIVER_GEM
))
444 obj
= drm_gem_object_lookup(dev
, file_priv
, args
->handle
);
448 idr_preload(GFP_KERNEL
);
449 spin_lock(&dev
->object_name_lock
);
451 ret
= idr_alloc(&dev
->object_name_idr
, obj
, 1, 0, GFP_NOWAIT
);
457 /* Allocate a reference for the name table. */
458 drm_gem_object_reference(obj
);
461 args
->name
= (uint64_t) obj
->name
;
465 spin_unlock(&dev
->object_name_lock
);
467 drm_gem_object_unreference_unlocked(obj
);
472 * Open an object using the global name, returning a handle and the size.
474 * This handle (of course) holds a reference to the object, so the object
475 * will not go away until the handle is deleted.
478 drm_gem_open_ioctl(struct drm_device
*dev
, void *data
,
479 struct drm_file
*file_priv
)
481 struct drm_gem_open
*args
= data
;
482 struct drm_gem_object
*obj
;
486 if (!(dev
->driver
->driver_features
& DRIVER_GEM
))
489 spin_lock(&dev
->object_name_lock
);
490 obj
= idr_find(&dev
->object_name_idr
, (int) args
->name
);
492 drm_gem_object_reference(obj
);
493 spin_unlock(&dev
->object_name_lock
);
497 ret
= drm_gem_handle_create(file_priv
, obj
, &handle
);
498 drm_gem_object_unreference_unlocked(obj
);
502 args
->handle
= handle
;
503 args
->size
= obj
->size
;
509 * Called at device open time, sets up the structure for handling refcounting
513 drm_gem_open(struct drm_device
*dev
, struct drm_file
*file_private
)
515 idr_init(&file_private
->object_idr
);
516 spin_lock_init(&file_private
->table_lock
);
520 * Called at device close to release the file's
521 * handle references on objects.
524 drm_gem_object_release_handle(int id
, void *ptr
, void *data
)
526 struct drm_file
*file_priv
= data
;
527 struct drm_gem_object
*obj
= ptr
;
528 struct drm_device
*dev
= obj
->dev
;
530 drm_gem_remove_prime_handles(obj
, file_priv
);
532 if (dev
->driver
->gem_close_object
)
533 dev
->driver
->gem_close_object(obj
, file_priv
);
535 drm_gem_object_handle_unreference_unlocked(obj
);
541 * Called at close time when the filp is going away.
543 * Releases any remaining references on objects by this filp.
546 drm_gem_release(struct drm_device
*dev
, struct drm_file
*file_private
)
548 idr_for_each(&file_private
->object_idr
,
549 &drm_gem_object_release_handle
, file_private
);
550 idr_destroy(&file_private
->object_idr
);
554 drm_gem_object_release(struct drm_gem_object
*obj
)
559 EXPORT_SYMBOL(drm_gem_object_release
);
562 * Called after the last reference to the object has been lost.
563 * Must be called holding struct_ mutex
568 drm_gem_object_free(struct kref
*kref
)
570 struct drm_gem_object
*obj
= (struct drm_gem_object
*) kref
;
571 struct drm_device
*dev
= obj
->dev
;
573 BUG_ON(!mutex_is_locked(&dev
->struct_mutex
));
575 if (dev
->driver
->gem_free_object
!= NULL
)
576 dev
->driver
->gem_free_object(obj
);
578 EXPORT_SYMBOL(drm_gem_object_free
);
580 static void drm_gem_object_ref_bug(struct kref
*list_kref
)
586 * Called after the last handle to the object has been closed
588 * Removes any name for the object. Note that this must be
589 * called before drm_gem_object_free or we'll be touching
592 void drm_gem_object_handle_free(struct drm_gem_object
*obj
)
594 struct drm_device
*dev
= obj
->dev
;
596 /* Remove any name for this object */
597 spin_lock(&dev
->object_name_lock
);
599 idr_remove(&dev
->object_name_idr
, obj
->name
);
601 spin_unlock(&dev
->object_name_lock
);
603 * The object name held a reference to this object, drop
606 * This cannot be the last reference, since the handle holds one too.
608 kref_put(&obj
->refcount
, drm_gem_object_ref_bug
);
610 spin_unlock(&dev
->object_name_lock
);
613 EXPORT_SYMBOL(drm_gem_object_handle_free
);
615 void drm_gem_vm_open(struct vm_area_struct
*vma
)
617 struct drm_gem_object
*obj
= vma
->vm_private_data
;
619 drm_gem_object_reference(obj
);
621 mutex_lock(&obj
->dev
->struct_mutex
);
622 drm_vm_open_locked(obj
->dev
, vma
);
623 mutex_unlock(&obj
->dev
->struct_mutex
);
625 EXPORT_SYMBOL(drm_gem_vm_open
);
627 void drm_gem_vm_close(struct vm_area_struct
*vma
)
629 struct drm_gem_object
*obj
= vma
->vm_private_data
;
630 struct drm_device
*dev
= obj
->dev
;
632 mutex_lock(&dev
->struct_mutex
);
633 drm_vm_close_locked(obj
->dev
, vma
);
634 drm_gem_object_unreference(obj
);
635 mutex_unlock(&dev
->struct_mutex
);
637 EXPORT_SYMBOL(drm_gem_vm_close
);
640 * drm_gem_mmap_obj - memory map a GEM object
641 * @obj: the GEM object to map
642 * @obj_size: the object size to be mapped, in bytes
643 * @vma: VMA for the area to be mapped
645 * Set up the VMA to prepare mapping of the GEM object using the gem_vm_ops
646 * provided by the driver. Depending on their requirements, drivers can either
647 * provide a fault handler in their gem_vm_ops (in which case any accesses to
648 * the object will be trapped, to perform migration, GTT binding, surface
649 * register allocation, or performance monitoring), or mmap the buffer memory
650 * synchronously after calling drm_gem_mmap_obj.
652 * This function is mainly intended to implement the DMABUF mmap operation, when
653 * the GEM object is not looked up based on its fake offset. To implement the
654 * DRM mmap operation, drivers should use the drm_gem_mmap() function.
656 * NOTE: This function has to be protected with dev->struct_mutex
658 * Return 0 or success or -EINVAL if the object size is smaller than the VMA
659 * size, or if no gem_vm_ops are provided.
661 int drm_gem_mmap_obj(struct drm_gem_object
*obj
, unsigned long obj_size
,
662 struct vm_area_struct
*vma
)
664 struct drm_device
*dev
= obj
->dev
;
666 lockdep_assert_held(&dev
->struct_mutex
);
668 /* Check for valid size. */
669 if (obj_size
< vma
->vm_end
- vma
->vm_start
)
672 if (!dev
->driver
->gem_vm_ops
)
675 vma
->vm_flags
|= VM_IO
| VM_PFNMAP
| VM_DONTEXPAND
| VM_DONTDUMP
;
676 vma
->vm_ops
= dev
->driver
->gem_vm_ops
;
677 vma
->vm_private_data
= obj
;
678 vma
->vm_page_prot
= pgprot_writecombine(vm_get_page_prot(vma
->vm_flags
));
680 /* Take a ref for this mapping of the object, so that the fault
681 * handler can dereference the mmap offset's pointer to the object.
682 * This reference is cleaned up by the corresponding vm_close
683 * (which should happen whether the vma was created by this call, or
684 * by a vm_open due to mremap or partial unmap or whatever).
686 drm_gem_object_reference(obj
);
688 drm_vm_open_locked(dev
, vma
);
691 EXPORT_SYMBOL(drm_gem_mmap_obj
);
694 * drm_gem_mmap - memory map routine for GEM objects
695 * @filp: DRM file pointer
696 * @vma: VMA for the area to be mapped
698 * If a driver supports GEM object mapping, mmap calls on the DRM file
699 * descriptor will end up here.
701 * Look up the GEM object based on the offset passed in (vma->vm_pgoff will
702 * contain the fake offset we created when the GTT map ioctl was called on
703 * the object) and map it with a call to drm_gem_mmap_obj().
705 int drm_gem_mmap(struct file
*filp
, struct vm_area_struct
*vma
)
707 struct drm_file
*priv
= filp
->private_data
;
708 struct drm_device
*dev
= priv
->minor
->dev
;
709 struct drm_gem_mm
*mm
= dev
->mm_private
;
710 struct drm_local_map
*map
= NULL
;
711 struct drm_hash_item
*hash
;
714 if (drm_device_is_unplugged(dev
))
717 mutex_lock(&dev
->struct_mutex
);
719 if (drm_ht_find_item(&mm
->offset_hash
, vma
->vm_pgoff
, &hash
)) {
720 mutex_unlock(&dev
->struct_mutex
);
721 return drm_mmap(filp
, vma
);
724 map
= drm_hash_entry(hash
, struct drm_map_list
, hash
)->map
;
726 ((map
->flags
& _DRM_RESTRICTED
) && !capable(CAP_SYS_ADMIN
))) {
731 ret
= drm_gem_mmap_obj(map
->handle
, map
->size
, vma
);
734 mutex_unlock(&dev
->struct_mutex
);
738 EXPORT_SYMBOL(drm_gem_mmap
);