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 if (drm_mm_init(&mm->offset_manager, DRM_FILE_PAGE_OFFSET_START,
112 DRM_FILE_PAGE_OFFSET_SIZE)) {
113 drm_ht_remove(&mm->offset_hash);
122 drm_gem_destroy(struct drm_device *dev)
124 struct drm_gem_mm *mm = dev->mm_private;
126 drm_mm_takedown(&mm->offset_manager);
127 drm_ht_remove(&mm->offset_hash);
129 dev->mm_private = NULL;
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)
139 BUG_ON((size & (PAGE_SIZE - 1)) != 0);
142 obj->filp = shmem_file_setup("drm mm object", size, VM_NORESERVE);
143 if (IS_ERR(obj->filp))
144 return PTR_ERR(obj->filp);
146 kref_init(&obj->refcount);
147 atomic_set(&obj->handle_count, 0);
152 EXPORT_SYMBOL(drm_gem_object_init);
155 * Initialize an already allocated GEM object of the specified size with
156 * no GEM provided backing store. Instead the caller is responsible for
157 * backing the object and handling it.
159 int drm_gem_private_object_init(struct drm_device *dev,
160 struct drm_gem_object *obj, size_t size)
162 BUG_ON((size & (PAGE_SIZE - 1)) != 0);
167 kref_init(&obj->refcount);
168 atomic_set(&obj->handle_count, 0);
173 EXPORT_SYMBOL(drm_gem_private_object_init);
176 * Allocate a GEM object of the specified size with shmfs backing store
178 struct drm_gem_object *
179 drm_gem_object_alloc(struct drm_device *dev, size_t size)
181 struct drm_gem_object *obj;
183 obj = kzalloc(sizeof(*obj), GFP_KERNEL);
187 if (drm_gem_object_init(dev, obj, size) != 0)
190 if (dev->driver->gem_init_object != NULL &&
191 dev->driver->gem_init_object(obj) != 0) {
196 /* Object_init mangles the global counters - readjust them. */
202 EXPORT_SYMBOL(drm_gem_object_alloc);
205 drm_gem_remove_prime_handles(struct drm_gem_object *obj, struct drm_file *filp)
207 if (obj->import_attach) {
208 drm_prime_remove_buf_handle(&filp->prime,
209 obj->import_attach->dmabuf);
211 if (obj->export_dma_buf) {
212 drm_prime_remove_buf_handle(&filp->prime,
213 obj->export_dma_buf);
218 * Removes the mapping from handle to filp for this object.
221 drm_gem_handle_delete(struct drm_file *filp, u32 handle)
223 struct drm_device *dev;
224 struct drm_gem_object *obj;
226 /* This is gross. The idr system doesn't let us try a delete and
227 * return an error code. It just spews if you fail at deleting.
228 * So, we have to grab a lock around finding the object and then
229 * doing the delete on it and dropping the refcount, or the user
230 * could race us to double-decrement the refcount and cause a
231 * use-after-free later. Given the frequency of our handle lookups,
232 * we may want to use ida for number allocation and a hash table
233 * for the pointers, anyway.
235 spin_lock(&filp->table_lock);
237 /* Check if we currently have a reference on the object */
238 obj = idr_find(&filp->object_idr, handle);
240 spin_unlock(&filp->table_lock);
245 DRM_DEBUG("%s:hdl[%d]obj[0x%x]\n", __func__, handle, (int)obj);
247 /* Release reference and decrement refcount. */
248 idr_remove(&filp->object_idr, handle);
249 spin_unlock(&filp->table_lock);
251 drm_gem_remove_prime_handles(obj, filp);
253 if (dev->driver->gem_close_object)
254 dev->driver->gem_close_object(obj, filp);
255 drm_gem_object_handle_unreference_unlocked(obj);
259 EXPORT_SYMBOL(drm_gem_handle_delete);
262 * Create a handle for this object. This adds a handle reference
263 * to the object, which includes a regular reference count. Callers
264 * will likely want to dereference the object afterwards.
267 drm_gem_handle_create(struct drm_file *file_priv,
268 struct drm_gem_object *obj,
271 struct drm_device *dev = obj->dev;
275 * Get the user-visible handle using idr. Preload and perform
276 * allocation under our spinlock.
278 idr_preload(GFP_KERNEL);
279 spin_lock(&file_priv->table_lock);
281 ret = idr_alloc(&file_priv->object_idr, obj, 1, 0, GFP_NOWAIT);
283 spin_unlock(&file_priv->table_lock);
289 drm_gem_object_handle_reference(obj);
291 if (dev->driver->gem_open_object) {
292 ret = dev->driver->gem_open_object(obj, file_priv);
294 drm_gem_handle_delete(file_priv, *handlep);
301 EXPORT_SYMBOL(drm_gem_handle_create);
305 * drm_gem_free_mmap_offset - release a fake mmap offset for an object
306 * @obj: obj in question
308 * This routine frees fake offsets allocated by drm_gem_create_mmap_offset().
311 drm_gem_free_mmap_offset(struct drm_gem_object *obj)
313 struct drm_device *dev = obj->dev;
314 struct drm_gem_mm *mm = dev->mm_private;
315 struct drm_map_list *list = &obj->map_list;
317 drm_ht_remove_item(&mm->offset_hash, &list->hash);
318 drm_mm_put_block(list->file_offset_node);
322 EXPORT_SYMBOL(drm_gem_free_mmap_offset);
325 * drm_gem_create_mmap_offset - create a fake mmap offset for an object
326 * @obj: obj in question
328 * GEM memory mapping works by handing back to userspace a fake mmap offset
329 * it can use in a subsequent mmap(2) call. The DRM core code then looks
330 * up the object based on the offset and sets up the various memory mapping
333 * This routine allocates and attaches a fake offset for @obj.
336 drm_gem_create_mmap_offset(struct drm_gem_object *obj)
338 struct drm_device *dev = obj->dev;
339 struct drm_gem_mm *mm = dev->mm_private;
340 struct drm_map_list *list;
341 struct drm_local_map *map;
344 /* Set the object up for mmap'ing */
345 list = &obj->map_list;
346 list->map = kzalloc(sizeof(struct drm_map_list), GFP_KERNEL);
351 map->type = _DRM_GEM;
352 map->size = obj->size;
355 /* Get a DRM GEM mmap offset allocated... */
356 list->file_offset_node = drm_mm_search_free(&mm->offset_manager,
357 obj->size / PAGE_SIZE, 0, false);
359 if (!list->file_offset_node) {
360 DRM_ERROR("failed to allocate offset for bo %d\n", obj->name);
365 list->file_offset_node = drm_mm_get_block(list->file_offset_node,
366 obj->size / PAGE_SIZE, 0);
367 if (!list->file_offset_node) {
372 list->hash.key = list->file_offset_node->start;
373 ret = drm_ht_insert_item(&mm->offset_hash, &list->hash);
375 DRM_ERROR("failed to add to map hash\n");
382 drm_mm_put_block(list->file_offset_node);
389 EXPORT_SYMBOL(drm_gem_create_mmap_offset);
391 /** Returns a reference to the object named by the handle. */
392 struct drm_gem_object *
393 drm_gem_object_lookup(struct drm_device *dev, struct drm_file *filp,
396 struct drm_gem_object *obj;
398 spin_lock(&filp->table_lock);
400 /* Check if we currently have a reference on the object */
401 obj = idr_find(&filp->object_idr, handle);
403 spin_unlock(&filp->table_lock);
407 drm_gem_object_reference(obj);
409 spin_unlock(&filp->table_lock);
413 EXPORT_SYMBOL(drm_gem_object_lookup);
416 * Releases the handle to an mm object.
419 drm_gem_close_ioctl(struct drm_device *dev, void *data,
420 struct drm_file *file_priv)
422 struct drm_gem_close *args = data;
425 if (!(dev->driver->driver_features & DRIVER_GEM))
428 ret = drm_gem_handle_delete(file_priv, args->handle);
434 * Create a global name for an object, returning the name.
436 * Note that the name does not hold a reference; when the object
437 * is freed, the name goes away.
440 drm_gem_flink_ioctl(struct drm_device *dev, void *data,
441 struct drm_file *file_priv)
443 struct drm_gem_flink *args = data;
444 struct drm_gem_object *obj;
447 if (!(dev->driver->driver_features & DRIVER_GEM))
450 obj = drm_gem_object_lookup(dev, file_priv, args->handle);
454 idr_preload(GFP_KERNEL);
455 spin_lock(&dev->object_name_lock);
457 ret = idr_alloc(&dev->object_name_idr, obj, 1, 0, GFP_NOWAIT);
463 /* Allocate a reference for the name table. */
464 drm_gem_object_reference(obj);
467 args->name = (uint64_t) obj->name;
471 spin_unlock(&dev->object_name_lock);
473 drm_gem_object_unreference_unlocked(obj);
475 DRM_DEBUG("%s:hdl[%d]obj[0x%x]name[%d]\n",
476 __func__, (int) args->handle, (int)obj, args->name);
482 * Open an object using the global name, returning a handle and the size.
484 * This handle (of course) holds a reference to the object, so the object
485 * will not go away until the handle is deleted.
488 drm_gem_open_ioctl(struct drm_device *dev, void *data,
489 struct drm_file *file_priv)
491 struct drm_gem_open *args = data;
492 struct drm_gem_object *obj;
496 if (!(dev->driver->driver_features & DRIVER_GEM))
499 spin_lock(&dev->object_name_lock);
500 obj = idr_find(&dev->object_name_idr, (int) args->name);
502 drm_gem_object_reference(obj);
503 spin_unlock(&dev->object_name_lock);
507 ret = drm_gem_handle_create(file_priv, obj, &handle);
508 drm_gem_object_unreference_unlocked(obj);
512 args->handle = handle;
513 args->size = obj->size;
515 DRM_DEBUG("%s:name[%d]obj[0x%x]hdl[%d]sz[%d]\n",
516 __func__, (int) args->name, (int)obj,
517 args->handle, (int)args->size);
523 * Called at device open time, sets up the structure for handling refcounting
527 drm_gem_open(struct drm_device *dev, struct drm_file *file_private)
529 idr_init(&file_private->object_idr);
530 spin_lock_init(&file_private->table_lock);
534 * Called at device close to release the file's
535 * handle references on objects.
538 drm_gem_object_release_handle(int id, void *ptr, void *data)
540 struct drm_file *file_priv = data;
541 struct drm_gem_object *obj = ptr;
542 struct drm_device *dev = obj->dev;
544 drm_gem_remove_prime_handles(obj, file_priv);
546 if (dev->driver->gem_close_object)
547 dev->driver->gem_close_object(obj, file_priv);
549 drm_gem_object_handle_unreference_unlocked(obj);
555 * Called at close time when the filp is going away.
557 * Releases any remaining references on objects by this filp.
560 drm_gem_release(struct drm_device *dev, struct drm_file *file_private)
562 idr_for_each(&file_private->object_idr,
563 &drm_gem_object_release_handle, file_private);
564 idr_destroy(&file_private->object_idr);
568 drm_gem_object_release(struct drm_gem_object *obj)
573 EXPORT_SYMBOL(drm_gem_object_release);
576 * Called after the last reference to the object has been lost.
577 * Must be called holding struct_ mutex
582 drm_gem_object_free(struct kref *kref)
584 struct drm_gem_object *obj = (struct drm_gem_object *) kref;
585 struct drm_device *dev = obj->dev;
587 BUG_ON(!mutex_is_locked(&dev->struct_mutex));
589 if (dev->driver->gem_free_object != NULL)
590 dev->driver->gem_free_object(obj);
592 EXPORT_SYMBOL(drm_gem_object_free);
594 static void drm_gem_object_ref_bug(struct kref *list_kref)
600 * Called after the last handle to the object has been closed
602 * Removes any name for the object. Note that this must be
603 * called before drm_gem_object_free or we'll be touching
606 void drm_gem_object_handle_free(struct drm_gem_object *obj)
608 struct drm_device *dev = obj->dev;
610 /* Remove any name for this object */
611 spin_lock(&dev->object_name_lock);
613 idr_remove(&dev->object_name_idr, obj->name);
615 spin_unlock(&dev->object_name_lock);
617 * The object name held a reference to this object, drop
620 * This cannot be the last reference, since the handle holds one too.
622 kref_put(&obj->refcount, drm_gem_object_ref_bug);
624 spin_unlock(&dev->object_name_lock);
627 EXPORT_SYMBOL(drm_gem_object_handle_free);
629 void drm_gem_vm_open(struct vm_area_struct *vma)
631 struct drm_gem_object *obj = vma->vm_private_data;
633 drm_gem_object_reference(obj);
635 mutex_lock(&obj->dev->struct_mutex);
636 drm_vm_open_locked(obj->dev, vma);
637 mutex_unlock(&obj->dev->struct_mutex);
639 EXPORT_SYMBOL(drm_gem_vm_open);
641 void drm_gem_vm_close(struct vm_area_struct *vma)
643 struct drm_gem_object *obj = vma->vm_private_data;
644 struct drm_device *dev = obj->dev;
646 mutex_lock(&dev->struct_mutex);
647 drm_vm_close_locked(obj->dev, vma);
648 drm_gem_object_unreference(obj);
649 mutex_unlock(&dev->struct_mutex);
651 EXPORT_SYMBOL(drm_gem_vm_close);
655 * drm_gem_mmap - memory map routine for GEM objects
656 * @filp: DRM file pointer
657 * @vma: VMA for the area to be mapped
659 * If a driver supports GEM object mapping, mmap calls on the DRM file
660 * descriptor will end up here.
662 * If we find the object based on the offset passed in (vma->vm_pgoff will
663 * contain the fake offset we created when the GTT map ioctl was called on
664 * the object), we set up the driver fault handler so that any accesses
665 * to the object can be trapped, to perform migration, GTT binding, surface
666 * register allocation, or performance monitoring.
668 int drm_gem_mmap(struct file *filp, struct vm_area_struct *vma)
670 struct drm_file *priv = filp->private_data;
671 struct drm_device *dev = priv->minor->dev;
672 struct drm_gem_mm *mm = dev->mm_private;
673 struct drm_local_map *map = NULL;
674 struct drm_gem_object *obj;
675 struct drm_hash_item *hash;
678 if (drm_device_is_unplugged(dev))
681 mutex_lock(&dev->struct_mutex);
683 if (drm_ht_find_item(&mm->offset_hash, vma->vm_pgoff, &hash)) {
684 mutex_unlock(&dev->struct_mutex);
685 return drm_mmap(filp, vma);
688 map = drm_hash_entry(hash, struct drm_map_list, hash)->map;
690 ((map->flags & _DRM_RESTRICTED) && !capable(CAP_SYS_ADMIN))) {
695 /* Check for valid size. */
696 if (map->size < vma->vm_end - vma->vm_start) {
702 if (!obj->dev->driver->gem_vm_ops) {
707 vma->vm_flags |= VM_IO | VM_PFNMAP | VM_DONTEXPAND | VM_DONTDUMP;
708 vma->vm_ops = obj->dev->driver->gem_vm_ops;
709 vma->vm_private_data = map->handle;
710 vma->vm_page_prot = pgprot_writecombine(vm_get_page_prot(vma->vm_flags));
712 /* Take a ref for this mapping of the object, so that the fault
713 * handler can dereference the mmap offset's pointer to the object.
714 * This reference is cleaned up by the corresponding vm_close
715 * (which should happen whether the vma was created by this call, or
716 * by a vm_open due to mremap or partial unmap or whatever).
718 drm_gem_object_reference(obj);
720 drm_vm_open_locked(dev, vma);
723 mutex_unlock(&dev->struct_mutex);
727 EXPORT_SYMBOL(drm_gem_mmap);