Loading...
1/*
2 * Copyright © 2008 Intel Corporation
3 *
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:
10 *
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
13 * Software.
14 *
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
21 * IN THE SOFTWARE.
22 *
23 * Authors:
24 * Eric Anholt <eric@anholt.net>
25 *
26 */
27
28#include <linux/types.h>
29#include <linux/slab.h>
30#include <linux/mm.h>
31#include <linux/uaccess.h>
32#include <linux/fs.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>
41
42#include <drm/drm.h>
43#include <drm/drm_device.h>
44#include <drm/drm_drv.h>
45#include <drm/drm_file.h>
46#include <drm/drm_gem.h>
47#include <drm/drm_print.h>
48#include <drm/drm_vma_manager.h>
49
50#include "drm_internal.h"
51
52/** @file drm_gem.c
53 *
54 * This file provides some of the base ioctls and library routines for
55 * the graphics memory manager implemented by each device driver.
56 *
57 * Because various devices have different requirements in terms of
58 * synchronization and migration strategies, implementing that is left up to
59 * the driver, and all that the general API provides should be generic --
60 * allocating objects, reading/writing data with the cpu, freeing objects.
61 * Even there, platform-dependent optimizations for reading/writing data with
62 * the CPU mean we'll likely hook those out to driver-specific calls. However,
63 * the DRI2 implementation wants to have at least allocate/mmap be generic.
64 *
65 * The goal was to have swap-backed object allocation managed through
66 * struct file. However, file descriptors as handles to a struct file have
67 * two major failings:
68 * - Process limits prevent more than 1024 or so being used at a time by
69 * default.
70 * - Inability to allocate high fds will aggravate the X Server's select()
71 * handling, and likely that of many GL client applications as well.
72 *
73 * This led to a plan of using our own integer IDs (called handles, following
74 * DRM terminology) to mimic fds, and implement the fd syscalls we need as
75 * ioctls. The objects themselves will still include the struct file so
76 * that we can transition to fds if the required kernel infrastructure shows
77 * up at a later date, and as our interface with shmfs for memory allocation.
78 */
79
80/**
81 * drm_gem_init - Initialize the GEM device fields
82 * @dev: drm_devic structure to initialize
83 */
84int
85drm_gem_init(struct drm_device *dev)
86{
87 struct drm_vma_offset_manager *vma_offset_manager;
88
89 mutex_init(&dev->object_name_lock);
90 idr_init_base(&dev->object_name_idr, 1);
91
92 vma_offset_manager = kzalloc(sizeof(*vma_offset_manager), GFP_KERNEL);
93 if (!vma_offset_manager) {
94 DRM_ERROR("out of memory\n");
95 return -ENOMEM;
96 }
97
98 dev->vma_offset_manager = vma_offset_manager;
99 drm_vma_offset_manager_init(vma_offset_manager,
100 DRM_FILE_PAGE_OFFSET_START,
101 DRM_FILE_PAGE_OFFSET_SIZE);
102
103 return 0;
104}
105
106void
107drm_gem_destroy(struct drm_device *dev)
108{
109
110 drm_vma_offset_manager_destroy(dev->vma_offset_manager);
111 kfree(dev->vma_offset_manager);
112 dev->vma_offset_manager = NULL;
113}
114
115/**
116 * drm_gem_object_init - initialize an allocated shmem-backed GEM object
117 * @dev: drm_device the object should be initialized for
118 * @obj: drm_gem_object to initialize
119 * @size: object size
120 *
121 * Initialize an already allocated GEM object of the specified size with
122 * shmfs backing store.
123 */
124int drm_gem_object_init(struct drm_device *dev,
125 struct drm_gem_object *obj, size_t size)
126{
127 struct file *filp;
128
129 drm_gem_private_object_init(dev, obj, size);
130
131 filp = shmem_file_setup("drm mm object", size, VM_NORESERVE);
132 if (IS_ERR(filp))
133 return PTR_ERR(filp);
134
135 obj->filp = filp;
136
137 return 0;
138}
139EXPORT_SYMBOL(drm_gem_object_init);
140
141/**
142 * drm_gem_private_object_init - initialize an allocated private GEM object
143 * @dev: drm_device the object should be initialized for
144 * @obj: drm_gem_object to initialize
145 * @size: object size
146 *
147 * Initialize an already allocated GEM object of the specified size with
148 * no GEM provided backing store. Instead the caller is responsible for
149 * backing the object and handling it.
150 */
151void drm_gem_private_object_init(struct drm_device *dev,
152 struct drm_gem_object *obj, size_t size)
153{
154 BUG_ON((size & (PAGE_SIZE - 1)) != 0);
155
156 obj->dev = dev;
157 obj->filp = NULL;
158
159 kref_init(&obj->refcount);
160 obj->handle_count = 0;
161 obj->size = size;
162 dma_resv_init(&obj->_resv);
163 if (!obj->resv)
164 obj->resv = &obj->_resv;
165
166 drm_vma_node_reset(&obj->vma_node);
167}
168EXPORT_SYMBOL(drm_gem_private_object_init);
169
170static void
171drm_gem_remove_prime_handles(struct drm_gem_object *obj, struct drm_file *filp)
172{
173 /*
174 * Note: obj->dma_buf can't disappear as long as we still hold a
175 * handle reference in obj->handle_count.
176 */
177 mutex_lock(&filp->prime.lock);
178 if (obj->dma_buf) {
179 drm_prime_remove_buf_handle_locked(&filp->prime,
180 obj->dma_buf);
181 }
182 mutex_unlock(&filp->prime.lock);
183}
184
185/**
186 * drm_gem_object_handle_free - release resources bound to userspace handles
187 * @obj: GEM object to clean up.
188 *
189 * Called after the last handle to the object has been closed
190 *
191 * Removes any name for the object. Note that this must be
192 * called before drm_gem_object_free or we'll be touching
193 * freed memory
194 */
195static void drm_gem_object_handle_free(struct drm_gem_object *obj)
196{
197 struct drm_device *dev = obj->dev;
198
199 /* Remove any name for this object */
200 if (obj->name) {
201 idr_remove(&dev->object_name_idr, obj->name);
202 obj->name = 0;
203 }
204}
205
206static void drm_gem_object_exported_dma_buf_free(struct drm_gem_object *obj)
207{
208 /* Unbreak the reference cycle if we have an exported dma_buf. */
209 if (obj->dma_buf) {
210 dma_buf_put(obj->dma_buf);
211 obj->dma_buf = NULL;
212 }
213}
214
215static void
216drm_gem_object_handle_put_unlocked(struct drm_gem_object *obj)
217{
218 struct drm_device *dev = obj->dev;
219 bool final = false;
220
221 if (WARN_ON(obj->handle_count == 0))
222 return;
223
224 /*
225 * Must bump handle count first as this may be the last
226 * ref, in which case the object would disappear before we
227 * checked for a name
228 */
229
230 mutex_lock(&dev->object_name_lock);
231 if (--obj->handle_count == 0) {
232 drm_gem_object_handle_free(obj);
233 drm_gem_object_exported_dma_buf_free(obj);
234 final = true;
235 }
236 mutex_unlock(&dev->object_name_lock);
237
238 if (final)
239 drm_gem_object_put_unlocked(obj);
240}
241
242/*
243 * Called at device or object close to release the file's
244 * handle references on objects.
245 */
246static int
247drm_gem_object_release_handle(int id, void *ptr, void *data)
248{
249 struct drm_file *file_priv = data;
250 struct drm_gem_object *obj = ptr;
251 struct drm_device *dev = obj->dev;
252
253 if (obj->funcs && obj->funcs->close)
254 obj->funcs->close(obj, file_priv);
255 else if (dev->driver->gem_close_object)
256 dev->driver->gem_close_object(obj, file_priv);
257
258 drm_gem_remove_prime_handles(obj, file_priv);
259 drm_vma_node_revoke(&obj->vma_node, file_priv);
260
261 drm_gem_object_handle_put_unlocked(obj);
262
263 return 0;
264}
265
266/**
267 * drm_gem_handle_delete - deletes the given file-private handle
268 * @filp: drm file-private structure to use for the handle look up
269 * @handle: userspace handle to delete
270 *
271 * Removes the GEM handle from the @filp lookup table which has been added with
272 * drm_gem_handle_create(). If this is the last handle also cleans up linked
273 * resources like GEM names.
274 */
275int
276drm_gem_handle_delete(struct drm_file *filp, u32 handle)
277{
278 struct drm_gem_object *obj;
279
280 spin_lock(&filp->table_lock);
281
282 /* Check if we currently have a reference on the object */
283 obj = idr_replace(&filp->object_idr, NULL, handle);
284 spin_unlock(&filp->table_lock);
285 if (IS_ERR_OR_NULL(obj))
286 return -EINVAL;
287
288 /* Release driver's reference and decrement refcount. */
289 drm_gem_object_release_handle(handle, obj, filp);
290
291 /* And finally make the handle available for future allocations. */
292 spin_lock(&filp->table_lock);
293 idr_remove(&filp->object_idr, handle);
294 spin_unlock(&filp->table_lock);
295
296 return 0;
297}
298EXPORT_SYMBOL(drm_gem_handle_delete);
299
300/**
301 * drm_gem_dumb_map_offset - return the fake mmap offset for a gem object
302 * @file: drm file-private structure containing the gem object
303 * @dev: corresponding drm_device
304 * @handle: gem object handle
305 * @offset: return location for the fake mmap offset
306 *
307 * This implements the &drm_driver.dumb_map_offset kms driver callback for
308 * drivers which use gem to manage their backing storage.
309 *
310 * Returns:
311 * 0 on success or a negative error code on failure.
312 */
313int drm_gem_dumb_map_offset(struct drm_file *file, struct drm_device *dev,
314 u32 handle, u64 *offset)
315{
316 struct drm_gem_object *obj;
317 int ret;
318
319 obj = drm_gem_object_lookup(file, handle);
320 if (!obj)
321 return -ENOENT;
322
323 /* Don't allow imported objects to be mapped */
324 if (obj->import_attach) {
325 ret = -EINVAL;
326 goto out;
327 }
328
329 ret = drm_gem_create_mmap_offset(obj);
330 if (ret)
331 goto out;
332
333 *offset = drm_vma_node_offset_addr(&obj->vma_node);
334out:
335 drm_gem_object_put_unlocked(obj);
336
337 return ret;
338}
339EXPORT_SYMBOL_GPL(drm_gem_dumb_map_offset);
340
341/**
342 * drm_gem_dumb_destroy - dumb fb callback helper for gem based drivers
343 * @file: drm file-private structure to remove the dumb handle from
344 * @dev: corresponding drm_device
345 * @handle: the dumb handle to remove
346 *
347 * This implements the &drm_driver.dumb_destroy kms driver callback for drivers
348 * which use gem to manage their backing storage.
349 */
350int drm_gem_dumb_destroy(struct drm_file *file,
351 struct drm_device *dev,
352 uint32_t handle)
353{
354 return drm_gem_handle_delete(file, handle);
355}
356EXPORT_SYMBOL(drm_gem_dumb_destroy);
357
358/**
359 * drm_gem_handle_create_tail - internal functions to create a handle
360 * @file_priv: drm file-private structure to register the handle for
361 * @obj: object to register
362 * @handlep: pointer to return the created handle to the caller
363 *
364 * This expects the &drm_device.object_name_lock to be held already and will
365 * drop it before returning. Used to avoid races in establishing new handles
366 * when importing an object from either an flink name or a dma-buf.
367 *
368 * Handles must be release again through drm_gem_handle_delete(). This is done
369 * when userspace closes @file_priv for all attached handles, or through the
370 * GEM_CLOSE ioctl for individual handles.
371 */
372int
373drm_gem_handle_create_tail(struct drm_file *file_priv,
374 struct drm_gem_object *obj,
375 u32 *handlep)
376{
377 struct drm_device *dev = obj->dev;
378 u32 handle;
379 int ret;
380
381 WARN_ON(!mutex_is_locked(&dev->object_name_lock));
382 if (obj->handle_count++ == 0)
383 drm_gem_object_get(obj);
384
385 /*
386 * Get the user-visible handle using idr. Preload and perform
387 * allocation under our spinlock.
388 */
389 idr_preload(GFP_KERNEL);
390 spin_lock(&file_priv->table_lock);
391
392 ret = idr_alloc(&file_priv->object_idr, obj, 1, 0, GFP_NOWAIT);
393
394 spin_unlock(&file_priv->table_lock);
395 idr_preload_end();
396
397 mutex_unlock(&dev->object_name_lock);
398 if (ret < 0)
399 goto err_unref;
400
401 handle = ret;
402
403 ret = drm_vma_node_allow(&obj->vma_node, file_priv);
404 if (ret)
405 goto err_remove;
406
407 if (obj->funcs && obj->funcs->open) {
408 ret = obj->funcs->open(obj, file_priv);
409 if (ret)
410 goto err_revoke;
411 } else if (dev->driver->gem_open_object) {
412 ret = dev->driver->gem_open_object(obj, file_priv);
413 if (ret)
414 goto err_revoke;
415 }
416
417 *handlep = handle;
418 return 0;
419
420err_revoke:
421 drm_vma_node_revoke(&obj->vma_node, file_priv);
422err_remove:
423 spin_lock(&file_priv->table_lock);
424 idr_remove(&file_priv->object_idr, handle);
425 spin_unlock(&file_priv->table_lock);
426err_unref:
427 drm_gem_object_handle_put_unlocked(obj);
428 return ret;
429}
430
431/**
432 * drm_gem_handle_create - create a gem handle for an object
433 * @file_priv: drm file-private structure to register the handle for
434 * @obj: object to register
435 * @handlep: pionter to return the created handle to the caller
436 *
437 * Create a handle for this object. This adds a handle reference to the object,
438 * which includes a regular reference count. Callers will likely want to
439 * dereference the object afterwards.
440 *
441 * Since this publishes @obj to userspace it must be fully set up by this point,
442 * drivers must call this last in their buffer object creation callbacks.
443 */
444int drm_gem_handle_create(struct drm_file *file_priv,
445 struct drm_gem_object *obj,
446 u32 *handlep)
447{
448 mutex_lock(&obj->dev->object_name_lock);
449
450 return drm_gem_handle_create_tail(file_priv, obj, handlep);
451}
452EXPORT_SYMBOL(drm_gem_handle_create);
453
454
455/**
456 * drm_gem_free_mmap_offset - release a fake mmap offset for an object
457 * @obj: obj in question
458 *
459 * This routine frees fake offsets allocated by drm_gem_create_mmap_offset().
460 *
461 * Note that drm_gem_object_release() already calls this function, so drivers
462 * don't have to take care of releasing the mmap offset themselves when freeing
463 * the GEM object.
464 */
465void
466drm_gem_free_mmap_offset(struct drm_gem_object *obj)
467{
468 struct drm_device *dev = obj->dev;
469
470 drm_vma_offset_remove(dev->vma_offset_manager, &obj->vma_node);
471}
472EXPORT_SYMBOL(drm_gem_free_mmap_offset);
473
474/**
475 * drm_gem_create_mmap_offset_size - create a fake mmap offset for an object
476 * @obj: obj in question
477 * @size: the virtual size
478 *
479 * GEM memory mapping works by handing back to userspace a fake mmap offset
480 * it can use in a subsequent mmap(2) call. The DRM core code then looks
481 * up the object based on the offset and sets up the various memory mapping
482 * structures.
483 *
484 * This routine allocates and attaches a fake offset for @obj, in cases where
485 * the virtual size differs from the physical size (ie. &drm_gem_object.size).
486 * Otherwise just use drm_gem_create_mmap_offset().
487 *
488 * This function is idempotent and handles an already allocated mmap offset
489 * transparently. Drivers do not need to check for this case.
490 */
491int
492drm_gem_create_mmap_offset_size(struct drm_gem_object *obj, size_t size)
493{
494 struct drm_device *dev = obj->dev;
495
496 return drm_vma_offset_add(dev->vma_offset_manager, &obj->vma_node,
497 size / PAGE_SIZE);
498}
499EXPORT_SYMBOL(drm_gem_create_mmap_offset_size);
500
501/**
502 * drm_gem_create_mmap_offset - create a fake mmap offset for an object
503 * @obj: obj in question
504 *
505 * GEM memory mapping works by handing back to userspace a fake mmap offset
506 * it can use in a subsequent mmap(2) call. The DRM core code then looks
507 * up the object based on the offset and sets up the various memory mapping
508 * structures.
509 *
510 * This routine allocates and attaches a fake offset for @obj.
511 *
512 * Drivers can call drm_gem_free_mmap_offset() before freeing @obj to release
513 * the fake offset again.
514 */
515int drm_gem_create_mmap_offset(struct drm_gem_object *obj)
516{
517 return drm_gem_create_mmap_offset_size(obj, obj->size);
518}
519EXPORT_SYMBOL(drm_gem_create_mmap_offset);
520
521/*
522 * Move pages to appropriate lru and release the pagevec, decrementing the
523 * ref count of those pages.
524 */
525static void drm_gem_check_release_pagevec(struct pagevec *pvec)
526{
527 check_move_unevictable_pages(pvec);
528 __pagevec_release(pvec);
529 cond_resched();
530}
531
532/**
533 * drm_gem_get_pages - helper to allocate backing pages for a GEM object
534 * from shmem
535 * @obj: obj in question
536 *
537 * This reads the page-array of the shmem-backing storage of the given gem
538 * object. An array of pages is returned. If a page is not allocated or
539 * swapped-out, this will allocate/swap-in the required pages. Note that the
540 * whole object is covered by the page-array and pinned in memory.
541 *
542 * Use drm_gem_put_pages() to release the array and unpin all pages.
543 *
544 * This uses the GFP-mask set on the shmem-mapping (see mapping_set_gfp_mask()).
545 * If you require other GFP-masks, you have to do those allocations yourself.
546 *
547 * Note that you are not allowed to change gfp-zones during runtime. That is,
548 * shmem_read_mapping_page_gfp() must be called with the same gfp_zone(gfp) as
549 * set during initialization. If you have special zone constraints, set them
550 * after drm_gem_object_init() via mapping_set_gfp_mask(). shmem-core takes care
551 * to keep pages in the required zone during swap-in.
552 */
553struct page **drm_gem_get_pages(struct drm_gem_object *obj)
554{
555 struct address_space *mapping;
556 struct page *p, **pages;
557 struct pagevec pvec;
558 int i, npages;
559
560 /* This is the shared memory object that backs the GEM resource */
561 mapping = obj->filp->f_mapping;
562
563 /* We already BUG_ON() for non-page-aligned sizes in
564 * drm_gem_object_init(), so we should never hit this unless
565 * driver author is doing something really wrong:
566 */
567 WARN_ON((obj->size & (PAGE_SIZE - 1)) != 0);
568
569 npages = obj->size >> PAGE_SHIFT;
570
571 pages = kvmalloc_array(npages, sizeof(struct page *), GFP_KERNEL);
572 if (pages == NULL)
573 return ERR_PTR(-ENOMEM);
574
575 mapping_set_unevictable(mapping);
576
577 for (i = 0; i < npages; i++) {
578 p = shmem_read_mapping_page(mapping, i);
579 if (IS_ERR(p))
580 goto fail;
581 pages[i] = p;
582
583 /* Make sure shmem keeps __GFP_DMA32 allocated pages in the
584 * correct region during swapin. Note that this requires
585 * __GFP_DMA32 to be set in mapping_gfp_mask(inode->i_mapping)
586 * so shmem can relocate pages during swapin if required.
587 */
588 BUG_ON(mapping_gfp_constraint(mapping, __GFP_DMA32) &&
589 (page_to_pfn(p) >= 0x00100000UL));
590 }
591
592 return pages;
593
594fail:
595 mapping_clear_unevictable(mapping);
596 pagevec_init(&pvec);
597 while (i--) {
598 if (!pagevec_add(&pvec, pages[i]))
599 drm_gem_check_release_pagevec(&pvec);
600 }
601 if (pagevec_count(&pvec))
602 drm_gem_check_release_pagevec(&pvec);
603
604 kvfree(pages);
605 return ERR_CAST(p);
606}
607EXPORT_SYMBOL(drm_gem_get_pages);
608
609/**
610 * drm_gem_put_pages - helper to free backing pages for a GEM object
611 * @obj: obj in question
612 * @pages: pages to free
613 * @dirty: if true, pages will be marked as dirty
614 * @accessed: if true, the pages will be marked as accessed
615 */
616void drm_gem_put_pages(struct drm_gem_object *obj, struct page **pages,
617 bool dirty, bool accessed)
618{
619 int i, npages;
620 struct address_space *mapping;
621 struct pagevec pvec;
622
623 mapping = file_inode(obj->filp)->i_mapping;
624 mapping_clear_unevictable(mapping);
625
626 /* We already BUG_ON() for non-page-aligned sizes in
627 * drm_gem_object_init(), so we should never hit this unless
628 * driver author is doing something really wrong:
629 */
630 WARN_ON((obj->size & (PAGE_SIZE - 1)) != 0);
631
632 npages = obj->size >> PAGE_SHIFT;
633
634 pagevec_init(&pvec);
635 for (i = 0; i < npages; i++) {
636 if (!pages[i])
637 continue;
638
639 if (dirty)
640 set_page_dirty(pages[i]);
641
642 if (accessed)
643 mark_page_accessed(pages[i]);
644
645 /* Undo the reference we took when populating the table */
646 if (!pagevec_add(&pvec, pages[i]))
647 drm_gem_check_release_pagevec(&pvec);
648 }
649 if (pagevec_count(&pvec))
650 drm_gem_check_release_pagevec(&pvec);
651
652 kvfree(pages);
653}
654EXPORT_SYMBOL(drm_gem_put_pages);
655
656static int objects_lookup(struct drm_file *filp, u32 *handle, int count,
657 struct drm_gem_object **objs)
658{
659 int i, ret = 0;
660 struct drm_gem_object *obj;
661
662 spin_lock(&filp->table_lock);
663
664 for (i = 0; i < count; i++) {
665 /* Check if we currently have a reference on the object */
666 obj = idr_find(&filp->object_idr, handle[i]);
667 if (!obj) {
668 ret = -ENOENT;
669 break;
670 }
671 drm_gem_object_get(obj);
672 objs[i] = obj;
673 }
674 spin_unlock(&filp->table_lock);
675
676 return ret;
677}
678
679/**
680 * drm_gem_objects_lookup - look up GEM objects from an array of handles
681 * @filp: DRM file private date
682 * @bo_handles: user pointer to array of userspace handle
683 * @count: size of handle array
684 * @objs_out: returned pointer to array of drm_gem_object pointers
685 *
686 * Takes an array of userspace handles and returns a newly allocated array of
687 * GEM objects.
688 *
689 * For a single handle lookup, use drm_gem_object_lookup().
690 *
691 * Returns:
692 *
693 * @objs filled in with GEM object pointers. Returned GEM objects need to be
694 * released with drm_gem_object_put(). -ENOENT is returned on a lookup
695 * failure. 0 is returned on success.
696 *
697 */
698int drm_gem_objects_lookup(struct drm_file *filp, void __user *bo_handles,
699 int count, struct drm_gem_object ***objs_out)
700{
701 int ret;
702 u32 *handles;
703 struct drm_gem_object **objs;
704
705 if (!count)
706 return 0;
707
708 objs = kvmalloc_array(count, sizeof(struct drm_gem_object *),
709 GFP_KERNEL | __GFP_ZERO);
710 if (!objs)
711 return -ENOMEM;
712
713 handles = kvmalloc_array(count, sizeof(u32), GFP_KERNEL);
714 if (!handles) {
715 ret = -ENOMEM;
716 goto out;
717 }
718
719 if (copy_from_user(handles, bo_handles, count * sizeof(u32))) {
720 ret = -EFAULT;
721 DRM_DEBUG("Failed to copy in GEM handles\n");
722 goto out;
723 }
724
725 ret = objects_lookup(filp, handles, count, objs);
726 *objs_out = objs;
727
728out:
729 kvfree(handles);
730 return ret;
731
732}
733EXPORT_SYMBOL(drm_gem_objects_lookup);
734
735/**
736 * drm_gem_object_lookup - look up a GEM object from its handle
737 * @filp: DRM file private date
738 * @handle: userspace handle
739 *
740 * Returns:
741 *
742 * A reference to the object named by the handle if such exists on @filp, NULL
743 * otherwise.
744 *
745 * If looking up an array of handles, use drm_gem_objects_lookup().
746 */
747struct drm_gem_object *
748drm_gem_object_lookup(struct drm_file *filp, u32 handle)
749{
750 struct drm_gem_object *obj = NULL;
751
752 objects_lookup(filp, &handle, 1, &obj);
753 return obj;
754}
755EXPORT_SYMBOL(drm_gem_object_lookup);
756
757/**
758 * drm_gem_dma_resv_wait - Wait on GEM object's reservation's objects
759 * shared and/or exclusive fences.
760 * @filep: DRM file private date
761 * @handle: userspace handle
762 * @wait_all: if true, wait on all fences, else wait on just exclusive fence
763 * @timeout: timeout value in jiffies or zero to return immediately
764 *
765 * Returns:
766 *
767 * Returns -ERESTARTSYS if interrupted, 0 if the wait timed out, or
768 * greater than 0 on success.
769 */
770long drm_gem_dma_resv_wait(struct drm_file *filep, u32 handle,
771 bool wait_all, unsigned long timeout)
772{
773 long ret;
774 struct drm_gem_object *obj;
775
776 obj = drm_gem_object_lookup(filep, handle);
777 if (!obj) {
778 DRM_DEBUG("Failed to look up GEM BO %d\n", handle);
779 return -EINVAL;
780 }
781
782 ret = dma_resv_wait_timeout_rcu(obj->resv, wait_all,
783 true, timeout);
784 if (ret == 0)
785 ret = -ETIME;
786 else if (ret > 0)
787 ret = 0;
788
789 drm_gem_object_put_unlocked(obj);
790
791 return ret;
792}
793EXPORT_SYMBOL(drm_gem_dma_resv_wait);
794
795/**
796 * drm_gem_close_ioctl - implementation of the GEM_CLOSE ioctl
797 * @dev: drm_device
798 * @data: ioctl data
799 * @file_priv: drm file-private structure
800 *
801 * Releases the handle to an mm object.
802 */
803int
804drm_gem_close_ioctl(struct drm_device *dev, void *data,
805 struct drm_file *file_priv)
806{
807 struct drm_gem_close *args = data;
808 int ret;
809
810 if (!drm_core_check_feature(dev, DRIVER_GEM))
811 return -EOPNOTSUPP;
812
813 ret = drm_gem_handle_delete(file_priv, args->handle);
814
815 return ret;
816}
817
818/**
819 * drm_gem_flink_ioctl - implementation of the GEM_FLINK ioctl
820 * @dev: drm_device
821 * @data: ioctl data
822 * @file_priv: drm file-private structure
823 *
824 * Create a global name for an object, returning the name.
825 *
826 * Note that the name does not hold a reference; when the object
827 * is freed, the name goes away.
828 */
829int
830drm_gem_flink_ioctl(struct drm_device *dev, void *data,
831 struct drm_file *file_priv)
832{
833 struct drm_gem_flink *args = data;
834 struct drm_gem_object *obj;
835 int ret;
836
837 if (!drm_core_check_feature(dev, DRIVER_GEM))
838 return -EOPNOTSUPP;
839
840 obj = drm_gem_object_lookup(file_priv, args->handle);
841 if (obj == NULL)
842 return -ENOENT;
843
844 mutex_lock(&dev->object_name_lock);
845 /* prevent races with concurrent gem_close. */
846 if (obj->handle_count == 0) {
847 ret = -ENOENT;
848 goto err;
849 }
850
851 if (!obj->name) {
852 ret = idr_alloc(&dev->object_name_idr, obj, 1, 0, GFP_KERNEL);
853 if (ret < 0)
854 goto err;
855
856 obj->name = ret;
857 }
858
859 args->name = (uint64_t) obj->name;
860 ret = 0;
861
862err:
863 mutex_unlock(&dev->object_name_lock);
864 drm_gem_object_put_unlocked(obj);
865 return ret;
866}
867
868/**
869 * drm_gem_open - implementation of the GEM_OPEN ioctl
870 * @dev: drm_device
871 * @data: ioctl data
872 * @file_priv: drm file-private structure
873 *
874 * Open an object using the global name, returning a handle and the size.
875 *
876 * This handle (of course) holds a reference to the object, so the object
877 * will not go away until the handle is deleted.
878 */
879int
880drm_gem_open_ioctl(struct drm_device *dev, void *data,
881 struct drm_file *file_priv)
882{
883 struct drm_gem_open *args = data;
884 struct drm_gem_object *obj;
885 int ret;
886 u32 handle;
887
888 if (!drm_core_check_feature(dev, DRIVER_GEM))
889 return -EOPNOTSUPP;
890
891 mutex_lock(&dev->object_name_lock);
892 obj = idr_find(&dev->object_name_idr, (int) args->name);
893 if (obj) {
894 drm_gem_object_get(obj);
895 } else {
896 mutex_unlock(&dev->object_name_lock);
897 return -ENOENT;
898 }
899
900 /* drm_gem_handle_create_tail unlocks dev->object_name_lock. */
901 ret = drm_gem_handle_create_tail(file_priv, obj, &handle);
902 drm_gem_object_put_unlocked(obj);
903 if (ret)
904 return ret;
905
906 args->handle = handle;
907 args->size = obj->size;
908
909 return 0;
910}
911
912/**
913 * gem_gem_open - initalizes GEM file-private structures at devnode open time
914 * @dev: drm_device which is being opened by userspace
915 * @file_private: drm file-private structure to set up
916 *
917 * Called at device open time, sets up the structure for handling refcounting
918 * of mm objects.
919 */
920void
921drm_gem_open(struct drm_device *dev, struct drm_file *file_private)
922{
923 idr_init_base(&file_private->object_idr, 1);
924 spin_lock_init(&file_private->table_lock);
925}
926
927/**
928 * drm_gem_release - release file-private GEM resources
929 * @dev: drm_device which is being closed by userspace
930 * @file_private: drm file-private structure to clean up
931 *
932 * Called at close time when the filp is going away.
933 *
934 * Releases any remaining references on objects by this filp.
935 */
936void
937drm_gem_release(struct drm_device *dev, struct drm_file *file_private)
938{
939 idr_for_each(&file_private->object_idr,
940 &drm_gem_object_release_handle, file_private);
941 idr_destroy(&file_private->object_idr);
942}
943
944/**
945 * drm_gem_object_release - release GEM buffer object resources
946 * @obj: GEM buffer object
947 *
948 * This releases any structures and resources used by @obj and is the invers of
949 * drm_gem_object_init().
950 */
951void
952drm_gem_object_release(struct drm_gem_object *obj)
953{
954 WARN_ON(obj->dma_buf);
955
956 if (obj->filp)
957 fput(obj->filp);
958
959 dma_resv_fini(&obj->_resv);
960 drm_gem_free_mmap_offset(obj);
961}
962EXPORT_SYMBOL(drm_gem_object_release);
963
964/**
965 * drm_gem_object_free - free a GEM object
966 * @kref: kref of the object to free
967 *
968 * Called after the last reference to the object has been lost.
969 * Must be called holding &drm_device.struct_mutex.
970 *
971 * Frees the object
972 */
973void
974drm_gem_object_free(struct kref *kref)
975{
976 struct drm_gem_object *obj =
977 container_of(kref, struct drm_gem_object, refcount);
978 struct drm_device *dev = obj->dev;
979
980 if (obj->funcs) {
981 obj->funcs->free(obj);
982 } else if (dev->driver->gem_free_object_unlocked) {
983 dev->driver->gem_free_object_unlocked(obj);
984 } else if (dev->driver->gem_free_object) {
985 WARN_ON(!mutex_is_locked(&dev->struct_mutex));
986
987 dev->driver->gem_free_object(obj);
988 }
989}
990EXPORT_SYMBOL(drm_gem_object_free);
991
992/**
993 * drm_gem_object_put_unlocked - drop a GEM buffer object reference
994 * @obj: GEM buffer object
995 *
996 * This releases a reference to @obj. Callers must not hold the
997 * &drm_device.struct_mutex lock when calling this function.
998 *
999 * See also __drm_gem_object_put().
1000 */
1001void
1002drm_gem_object_put_unlocked(struct drm_gem_object *obj)
1003{
1004 struct drm_device *dev;
1005
1006 if (!obj)
1007 return;
1008
1009 dev = obj->dev;
1010
1011 if (dev->driver->gem_free_object) {
1012 might_lock(&dev->struct_mutex);
1013 if (kref_put_mutex(&obj->refcount, drm_gem_object_free,
1014 &dev->struct_mutex))
1015 mutex_unlock(&dev->struct_mutex);
1016 } else {
1017 kref_put(&obj->refcount, drm_gem_object_free);
1018 }
1019}
1020EXPORT_SYMBOL(drm_gem_object_put_unlocked);
1021
1022/**
1023 * drm_gem_object_put - release a GEM buffer object reference
1024 * @obj: GEM buffer object
1025 *
1026 * This releases a reference to @obj. Callers must hold the
1027 * &drm_device.struct_mutex lock when calling this function, even when the
1028 * driver doesn't use &drm_device.struct_mutex for anything.
1029 *
1030 * For drivers not encumbered with legacy locking use
1031 * drm_gem_object_put_unlocked() instead.
1032 */
1033void
1034drm_gem_object_put(struct drm_gem_object *obj)
1035{
1036 if (obj) {
1037 WARN_ON(!mutex_is_locked(&obj->dev->struct_mutex));
1038
1039 kref_put(&obj->refcount, drm_gem_object_free);
1040 }
1041}
1042EXPORT_SYMBOL(drm_gem_object_put);
1043
1044/**
1045 * drm_gem_vm_open - vma->ops->open implementation for GEM
1046 * @vma: VM area structure
1047 *
1048 * This function implements the #vm_operations_struct open() callback for GEM
1049 * drivers. This must be used together with drm_gem_vm_close().
1050 */
1051void drm_gem_vm_open(struct vm_area_struct *vma)
1052{
1053 struct drm_gem_object *obj = vma->vm_private_data;
1054
1055 drm_gem_object_get(obj);
1056}
1057EXPORT_SYMBOL(drm_gem_vm_open);
1058
1059/**
1060 * drm_gem_vm_close - vma->ops->close implementation for GEM
1061 * @vma: VM area structure
1062 *
1063 * This function implements the #vm_operations_struct close() callback for GEM
1064 * drivers. This must be used together with drm_gem_vm_open().
1065 */
1066void drm_gem_vm_close(struct vm_area_struct *vma)
1067{
1068 struct drm_gem_object *obj = vma->vm_private_data;
1069
1070 drm_gem_object_put_unlocked(obj);
1071}
1072EXPORT_SYMBOL(drm_gem_vm_close);
1073
1074/**
1075 * drm_gem_mmap_obj - memory map a GEM object
1076 * @obj: the GEM object to map
1077 * @obj_size: the object size to be mapped, in bytes
1078 * @vma: VMA for the area to be mapped
1079 *
1080 * Set up the VMA to prepare mapping of the GEM object using the gem_vm_ops
1081 * provided by the driver. Depending on their requirements, drivers can either
1082 * provide a fault handler in their gem_vm_ops (in which case any accesses to
1083 * the object will be trapped, to perform migration, GTT binding, surface
1084 * register allocation, or performance monitoring), or mmap the buffer memory
1085 * synchronously after calling drm_gem_mmap_obj.
1086 *
1087 * This function is mainly intended to implement the DMABUF mmap operation, when
1088 * the GEM object is not looked up based on its fake offset. To implement the
1089 * DRM mmap operation, drivers should use the drm_gem_mmap() function.
1090 *
1091 * drm_gem_mmap_obj() assumes the user is granted access to the buffer while
1092 * drm_gem_mmap() prevents unprivileged users from mapping random objects. So
1093 * callers must verify access restrictions before calling this helper.
1094 *
1095 * Return 0 or success or -EINVAL if the object size is smaller than the VMA
1096 * size, or if no gem_vm_ops are provided.
1097 */
1098int drm_gem_mmap_obj(struct drm_gem_object *obj, unsigned long obj_size,
1099 struct vm_area_struct *vma)
1100{
1101 struct drm_device *dev = obj->dev;
1102
1103 /* Check for valid size. */
1104 if (obj_size < vma->vm_end - vma->vm_start)
1105 return -EINVAL;
1106
1107 if (obj->funcs && obj->funcs->vm_ops)
1108 vma->vm_ops = obj->funcs->vm_ops;
1109 else if (dev->driver->gem_vm_ops)
1110 vma->vm_ops = dev->driver->gem_vm_ops;
1111 else
1112 return -EINVAL;
1113
1114 vma->vm_flags |= VM_IO | VM_PFNMAP | VM_DONTEXPAND | VM_DONTDUMP;
1115 vma->vm_private_data = obj;
1116 vma->vm_page_prot = pgprot_writecombine(vm_get_page_prot(vma->vm_flags));
1117 vma->vm_page_prot = pgprot_decrypted(vma->vm_page_prot);
1118
1119 /* Take a ref for this mapping of the object, so that the fault
1120 * handler can dereference the mmap offset's pointer to the object.
1121 * This reference is cleaned up by the corresponding vm_close
1122 * (which should happen whether the vma was created by this call, or
1123 * by a vm_open due to mremap or partial unmap or whatever).
1124 */
1125 drm_gem_object_get(obj);
1126
1127 return 0;
1128}
1129EXPORT_SYMBOL(drm_gem_mmap_obj);
1130
1131/**
1132 * drm_gem_mmap - memory map routine for GEM objects
1133 * @filp: DRM file pointer
1134 * @vma: VMA for the area to be mapped
1135 *
1136 * If a driver supports GEM object mapping, mmap calls on the DRM file
1137 * descriptor will end up here.
1138 *
1139 * Look up the GEM object based on the offset passed in (vma->vm_pgoff will
1140 * contain the fake offset we created when the GTT map ioctl was called on
1141 * the object) and map it with a call to drm_gem_mmap_obj().
1142 *
1143 * If the caller is not granted access to the buffer object, the mmap will fail
1144 * with EACCES. Please see the vma manager for more information.
1145 */
1146int drm_gem_mmap(struct file *filp, struct vm_area_struct *vma)
1147{
1148 struct drm_file *priv = filp->private_data;
1149 struct drm_device *dev = priv->minor->dev;
1150 struct drm_gem_object *obj = NULL;
1151 struct drm_vma_offset_node *node;
1152 int ret;
1153
1154 if (drm_dev_is_unplugged(dev))
1155 return -ENODEV;
1156
1157 drm_vma_offset_lock_lookup(dev->vma_offset_manager);
1158 node = drm_vma_offset_exact_lookup_locked(dev->vma_offset_manager,
1159 vma->vm_pgoff,
1160 vma_pages(vma));
1161 if (likely(node)) {
1162 obj = container_of(node, struct drm_gem_object, vma_node);
1163 /*
1164 * When the object is being freed, after it hits 0-refcnt it
1165 * proceeds to tear down the object. In the process it will
1166 * attempt to remove the VMA offset and so acquire this
1167 * mgr->vm_lock. Therefore if we find an object with a 0-refcnt
1168 * that matches our range, we know it is in the process of being
1169 * destroyed and will be freed as soon as we release the lock -
1170 * so we have to check for the 0-refcnted object and treat it as
1171 * invalid.
1172 */
1173 if (!kref_get_unless_zero(&obj->refcount))
1174 obj = NULL;
1175 }
1176 drm_vma_offset_unlock_lookup(dev->vma_offset_manager);
1177
1178 if (!obj)
1179 return -EINVAL;
1180
1181 if (!drm_vma_node_is_allowed(node, priv)) {
1182 drm_gem_object_put_unlocked(obj);
1183 return -EACCES;
1184 }
1185
1186 if (node->readonly) {
1187 if (vma->vm_flags & VM_WRITE) {
1188 drm_gem_object_put_unlocked(obj);
1189 return -EINVAL;
1190 }
1191
1192 vma->vm_flags &= ~VM_MAYWRITE;
1193 }
1194
1195 ret = drm_gem_mmap_obj(obj, drm_vma_node_size(node) << PAGE_SHIFT,
1196 vma);
1197
1198 drm_gem_object_put_unlocked(obj);
1199
1200 return ret;
1201}
1202EXPORT_SYMBOL(drm_gem_mmap);
1203
1204void drm_gem_print_info(struct drm_printer *p, unsigned int indent,
1205 const struct drm_gem_object *obj)
1206{
1207 drm_printf_indent(p, indent, "name=%d\n", obj->name);
1208 drm_printf_indent(p, indent, "refcount=%u\n",
1209 kref_read(&obj->refcount));
1210 drm_printf_indent(p, indent, "start=%08lx\n",
1211 drm_vma_node_start(&obj->vma_node));
1212 drm_printf_indent(p, indent, "size=%zu\n", obj->size);
1213 drm_printf_indent(p, indent, "imported=%s\n",
1214 obj->import_attach ? "yes" : "no");
1215
1216 if (obj->funcs && obj->funcs->print_info)
1217 obj->funcs->print_info(p, indent, obj);
1218 else if (obj->dev->driver->gem_print_info)
1219 obj->dev->driver->gem_print_info(p, indent, obj);
1220}
1221
1222int drm_gem_pin(struct drm_gem_object *obj)
1223{
1224 if (obj->funcs && obj->funcs->pin)
1225 return obj->funcs->pin(obj);
1226 else if (obj->dev->driver->gem_prime_pin)
1227 return obj->dev->driver->gem_prime_pin(obj);
1228 else
1229 return 0;
1230}
1231
1232void drm_gem_unpin(struct drm_gem_object *obj)
1233{
1234 if (obj->funcs && obj->funcs->unpin)
1235 obj->funcs->unpin(obj);
1236 else if (obj->dev->driver->gem_prime_unpin)
1237 obj->dev->driver->gem_prime_unpin(obj);
1238}
1239
1240void *drm_gem_vmap(struct drm_gem_object *obj)
1241{
1242 void *vaddr;
1243
1244 if (obj->funcs && obj->funcs->vmap)
1245 vaddr = obj->funcs->vmap(obj);
1246 else if (obj->dev->driver->gem_prime_vmap)
1247 vaddr = obj->dev->driver->gem_prime_vmap(obj);
1248 else
1249 vaddr = ERR_PTR(-EOPNOTSUPP);
1250
1251 if (!vaddr)
1252 vaddr = ERR_PTR(-ENOMEM);
1253
1254 return vaddr;
1255}
1256
1257void drm_gem_vunmap(struct drm_gem_object *obj, void *vaddr)
1258{
1259 if (!vaddr)
1260 return;
1261
1262 if (obj->funcs && obj->funcs->vunmap)
1263 obj->funcs->vunmap(obj, vaddr);
1264 else if (obj->dev->driver->gem_prime_vunmap)
1265 obj->dev->driver->gem_prime_vunmap(obj, vaddr);
1266}
1267
1268/**
1269 * drm_gem_lock_reservations - Sets up the ww context and acquires
1270 * the lock on an array of GEM objects.
1271 *
1272 * Once you've locked your reservations, you'll want to set up space
1273 * for your shared fences (if applicable), submit your job, then
1274 * drm_gem_unlock_reservations().
1275 *
1276 * @objs: drm_gem_objects to lock
1277 * @count: Number of objects in @objs
1278 * @acquire_ctx: struct ww_acquire_ctx that will be initialized as
1279 * part of tracking this set of locked reservations.
1280 */
1281int
1282drm_gem_lock_reservations(struct drm_gem_object **objs, int count,
1283 struct ww_acquire_ctx *acquire_ctx)
1284{
1285 int contended = -1;
1286 int i, ret;
1287
1288 ww_acquire_init(acquire_ctx, &reservation_ww_class);
1289
1290retry:
1291 if (contended != -1) {
1292 struct drm_gem_object *obj = objs[contended];
1293
1294 ret = dma_resv_lock_slow_interruptible(obj->resv,
1295 acquire_ctx);
1296 if (ret) {
1297 ww_acquire_done(acquire_ctx);
1298 return ret;
1299 }
1300 }
1301
1302 for (i = 0; i < count; i++) {
1303 if (i == contended)
1304 continue;
1305
1306 ret = dma_resv_lock_interruptible(objs[i]->resv,
1307 acquire_ctx);
1308 if (ret) {
1309 int j;
1310
1311 for (j = 0; j < i; j++)
1312 dma_resv_unlock(objs[j]->resv);
1313
1314 if (contended != -1 && contended >= i)
1315 dma_resv_unlock(objs[contended]->resv);
1316
1317 if (ret == -EDEADLK) {
1318 contended = i;
1319 goto retry;
1320 }
1321
1322 ww_acquire_done(acquire_ctx);
1323 return ret;
1324 }
1325 }
1326
1327 ww_acquire_done(acquire_ctx);
1328
1329 return 0;
1330}
1331EXPORT_SYMBOL(drm_gem_lock_reservations);
1332
1333void
1334drm_gem_unlock_reservations(struct drm_gem_object **objs, int count,
1335 struct ww_acquire_ctx *acquire_ctx)
1336{
1337 int i;
1338
1339 for (i = 0; i < count; i++)
1340 dma_resv_unlock(objs[i]->resv);
1341
1342 ww_acquire_fini(acquire_ctx);
1343}
1344EXPORT_SYMBOL(drm_gem_unlock_reservations);
1345
1346/**
1347 * drm_gem_fence_array_add - Adds the fence to an array of fences to be
1348 * waited on, deduplicating fences from the same context.
1349 *
1350 * @fence_array: array of dma_fence * for the job to block on.
1351 * @fence: the dma_fence to add to the list of dependencies.
1352 *
1353 * Returns:
1354 * 0 on success, or an error on failing to expand the array.
1355 */
1356int drm_gem_fence_array_add(struct xarray *fence_array,
1357 struct dma_fence *fence)
1358{
1359 struct dma_fence *entry;
1360 unsigned long index;
1361 u32 id = 0;
1362 int ret;
1363
1364 if (!fence)
1365 return 0;
1366
1367 /* Deduplicate if we already depend on a fence from the same context.
1368 * This lets the size of the array of deps scale with the number of
1369 * engines involved, rather than the number of BOs.
1370 */
1371 xa_for_each(fence_array, index, entry) {
1372 if (entry->context != fence->context)
1373 continue;
1374
1375 if (dma_fence_is_later(fence, entry)) {
1376 dma_fence_put(entry);
1377 xa_store(fence_array, index, fence, GFP_KERNEL);
1378 } else {
1379 dma_fence_put(fence);
1380 }
1381 return 0;
1382 }
1383
1384 ret = xa_alloc(fence_array, &id, fence, xa_limit_32b, GFP_KERNEL);
1385 if (ret != 0)
1386 dma_fence_put(fence);
1387
1388 return ret;
1389}
1390EXPORT_SYMBOL(drm_gem_fence_array_add);
1391
1392/**
1393 * drm_gem_fence_array_add_implicit - Adds the implicit dependencies tracked
1394 * in the GEM object's reservation object to an array of dma_fences for use in
1395 * scheduling a rendering job.
1396 *
1397 * This should be called after drm_gem_lock_reservations() on your array of
1398 * GEM objects used in the job but before updating the reservations with your
1399 * own fences.
1400 *
1401 * @fence_array: array of dma_fence * for the job to block on.
1402 * @obj: the gem object to add new dependencies from.
1403 * @write: whether the job might write the object (so we need to depend on
1404 * shared fences in the reservation object).
1405 */
1406int drm_gem_fence_array_add_implicit(struct xarray *fence_array,
1407 struct drm_gem_object *obj,
1408 bool write)
1409{
1410 int ret;
1411 struct dma_fence **fences;
1412 unsigned int i, fence_count;
1413
1414 if (!write) {
1415 struct dma_fence *fence =
1416 dma_resv_get_excl_rcu(obj->resv);
1417
1418 return drm_gem_fence_array_add(fence_array, fence);
1419 }
1420
1421 ret = dma_resv_get_fences_rcu(obj->resv, NULL,
1422 &fence_count, &fences);
1423 if (ret || !fence_count)
1424 return ret;
1425
1426 for (i = 0; i < fence_count; i++) {
1427 ret = drm_gem_fence_array_add(fence_array, fences[i]);
1428 if (ret)
1429 break;
1430 }
1431
1432 for (; i < fence_count; i++)
1433 dma_fence_put(fences[i]);
1434 kfree(fences);
1435 return ret;
1436}
1437EXPORT_SYMBOL(drm_gem_fence_array_add_implicit);
1/*
2 * Copyright © 2008 Intel Corporation
3 *
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:
10 *
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
13 * Software.
14 *
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
21 * IN THE SOFTWARE.
22 *
23 * Authors:
24 * Eric Anholt <eric@anholt.net>
25 *
26 */
27
28#include <linux/types.h>
29#include <linux/slab.h>
30#include <linux/mm.h>
31#include <linux/uaccess.h>
32#include <linux/fs.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 <drm/drmP.h>
40#include <drm/drm_vma_manager.h>
41#include <drm/drm_gem.h>
42#include "drm_internal.h"
43
44/** @file drm_gem.c
45 *
46 * This file provides some of the base ioctls and library routines for
47 * the graphics memory manager implemented by each device driver.
48 *
49 * Because various devices have different requirements in terms of
50 * synchronization and migration strategies, implementing that is left up to
51 * the driver, and all that the general API provides should be generic --
52 * allocating objects, reading/writing data with the cpu, freeing objects.
53 * Even there, platform-dependent optimizations for reading/writing data with
54 * the CPU mean we'll likely hook those out to driver-specific calls. However,
55 * the DRI2 implementation wants to have at least allocate/mmap be generic.
56 *
57 * The goal was to have swap-backed object allocation managed through
58 * struct file. However, file descriptors as handles to a struct file have
59 * two major failings:
60 * - Process limits prevent more than 1024 or so being used at a time by
61 * default.
62 * - Inability to allocate high fds will aggravate the X Server's select()
63 * handling, and likely that of many GL client applications as well.
64 *
65 * This led to a plan of using our own integer IDs (called handles, following
66 * DRM terminology) to mimic fds, and implement the fd syscalls we need as
67 * ioctls. The objects themselves will still include the struct file so
68 * that we can transition to fds if the required kernel infrastructure shows
69 * up at a later date, and as our interface with shmfs for memory allocation.
70 */
71
72/*
73 * We make up offsets for buffer objects so we can recognize them at
74 * mmap time.
75 */
76
77/* pgoff in mmap is an unsigned long, so we need to make sure that
78 * the faked up offset will fit
79 */
80
81#if BITS_PER_LONG == 64
82#define DRM_FILE_PAGE_OFFSET_START ((0xFFFFFFFFUL >> PAGE_SHIFT) + 1)
83#define DRM_FILE_PAGE_OFFSET_SIZE ((0xFFFFFFFFUL >> PAGE_SHIFT) * 16)
84#else
85#define DRM_FILE_PAGE_OFFSET_START ((0xFFFFFFFUL >> PAGE_SHIFT) + 1)
86#define DRM_FILE_PAGE_OFFSET_SIZE ((0xFFFFFFFUL >> PAGE_SHIFT) * 16)
87#endif
88
89/**
90 * drm_gem_init - Initialize the GEM device fields
91 * @dev: drm_devic structure to initialize
92 */
93int
94drm_gem_init(struct drm_device *dev)
95{
96 struct drm_vma_offset_manager *vma_offset_manager;
97
98 mutex_init(&dev->object_name_lock);
99 idr_init(&dev->object_name_idr);
100
101 vma_offset_manager = kzalloc(sizeof(*vma_offset_manager), GFP_KERNEL);
102 if (!vma_offset_manager) {
103 DRM_ERROR("out of memory\n");
104 return -ENOMEM;
105 }
106
107 dev->vma_offset_manager = vma_offset_manager;
108 drm_vma_offset_manager_init(vma_offset_manager,
109 DRM_FILE_PAGE_OFFSET_START,
110 DRM_FILE_PAGE_OFFSET_SIZE);
111
112 return 0;
113}
114
115void
116drm_gem_destroy(struct drm_device *dev)
117{
118
119 drm_vma_offset_manager_destroy(dev->vma_offset_manager);
120 kfree(dev->vma_offset_manager);
121 dev->vma_offset_manager = NULL;
122}
123
124/**
125 * drm_gem_object_init - initialize an allocated shmem-backed GEM object
126 * @dev: drm_device the object should be initialized for
127 * @obj: drm_gem_object to initialize
128 * @size: object size
129 *
130 * Initialize an already allocated GEM object of the specified size with
131 * shmfs backing store.
132 */
133int drm_gem_object_init(struct drm_device *dev,
134 struct drm_gem_object *obj, size_t size)
135{
136 struct file *filp;
137
138 drm_gem_private_object_init(dev, obj, size);
139
140 filp = shmem_file_setup("drm mm object", size, VM_NORESERVE);
141 if (IS_ERR(filp))
142 return PTR_ERR(filp);
143
144 obj->filp = filp;
145
146 return 0;
147}
148EXPORT_SYMBOL(drm_gem_object_init);
149
150/**
151 * drm_gem_private_object_init - initialize an allocated private GEM object
152 * @dev: drm_device the object should be initialized for
153 * @obj: drm_gem_object to initialize
154 * @size: object size
155 *
156 * Initialize an already allocated GEM object of the specified size with
157 * no GEM provided backing store. Instead the caller is responsible for
158 * backing the object and handling it.
159 */
160void drm_gem_private_object_init(struct drm_device *dev,
161 struct drm_gem_object *obj, size_t size)
162{
163 BUG_ON((size & (PAGE_SIZE - 1)) != 0);
164
165 obj->dev = dev;
166 obj->filp = NULL;
167
168 kref_init(&obj->refcount);
169 obj->handle_count = 0;
170 obj->size = size;
171 drm_vma_node_reset(&obj->vma_node);
172}
173EXPORT_SYMBOL(drm_gem_private_object_init);
174
175static void
176drm_gem_remove_prime_handles(struct drm_gem_object *obj, struct drm_file *filp)
177{
178 /*
179 * Note: obj->dma_buf can't disappear as long as we still hold a
180 * handle reference in obj->handle_count.
181 */
182 mutex_lock(&filp->prime.lock);
183 if (obj->dma_buf) {
184 drm_prime_remove_buf_handle_locked(&filp->prime,
185 obj->dma_buf);
186 }
187 mutex_unlock(&filp->prime.lock);
188}
189
190/**
191 * drm_gem_object_handle_free - release resources bound to userspace handles
192 * @obj: GEM object to clean up.
193 *
194 * Called after the last handle to the object has been closed
195 *
196 * Removes any name for the object. Note that this must be
197 * called before drm_gem_object_free or we'll be touching
198 * freed memory
199 */
200static void drm_gem_object_handle_free(struct drm_gem_object *obj)
201{
202 struct drm_device *dev = obj->dev;
203
204 /* Remove any name for this object */
205 if (obj->name) {
206 idr_remove(&dev->object_name_idr, obj->name);
207 obj->name = 0;
208 }
209}
210
211static void drm_gem_object_exported_dma_buf_free(struct drm_gem_object *obj)
212{
213 /* Unbreak the reference cycle if we have an exported dma_buf. */
214 if (obj->dma_buf) {
215 dma_buf_put(obj->dma_buf);
216 obj->dma_buf = NULL;
217 }
218}
219
220static void
221drm_gem_object_handle_unreference_unlocked(struct drm_gem_object *obj)
222{
223 struct drm_device *dev = obj->dev;
224 bool final = false;
225
226 if (WARN_ON(obj->handle_count == 0))
227 return;
228
229 /*
230 * Must bump handle count first as this may be the last
231 * ref, in which case the object would disappear before we
232 * checked for a name
233 */
234
235 mutex_lock(&dev->object_name_lock);
236 if (--obj->handle_count == 0) {
237 drm_gem_object_handle_free(obj);
238 drm_gem_object_exported_dma_buf_free(obj);
239 final = true;
240 }
241 mutex_unlock(&dev->object_name_lock);
242
243 if (final)
244 drm_gem_object_unreference_unlocked(obj);
245}
246
247/*
248 * Called at device or object close to release the file's
249 * handle references on objects.
250 */
251static int
252drm_gem_object_release_handle(int id, void *ptr, void *data)
253{
254 struct drm_file *file_priv = data;
255 struct drm_gem_object *obj = ptr;
256 struct drm_device *dev = obj->dev;
257
258 if (drm_core_check_feature(dev, DRIVER_PRIME))
259 drm_gem_remove_prime_handles(obj, file_priv);
260 drm_vma_node_revoke(&obj->vma_node, file_priv);
261
262 if (dev->driver->gem_close_object)
263 dev->driver->gem_close_object(obj, file_priv);
264
265 drm_gem_object_handle_unreference_unlocked(obj);
266
267 return 0;
268}
269
270/**
271 * drm_gem_handle_delete - deletes the given file-private handle
272 * @filp: drm file-private structure to use for the handle look up
273 * @handle: userspace handle to delete
274 *
275 * Removes the GEM handle from the @filp lookup table which has been added with
276 * drm_gem_handle_create(). If this is the last handle also cleans up linked
277 * resources like GEM names.
278 */
279int
280drm_gem_handle_delete(struct drm_file *filp, u32 handle)
281{
282 struct drm_gem_object *obj;
283
284 /* This is gross. The idr system doesn't let us try a delete and
285 * return an error code. It just spews if you fail at deleting.
286 * So, we have to grab a lock around finding the object and then
287 * doing the delete on it and dropping the refcount, or the user
288 * could race us to double-decrement the refcount and cause a
289 * use-after-free later. Given the frequency of our handle lookups,
290 * we may want to use ida for number allocation and a hash table
291 * for the pointers, anyway.
292 */
293 spin_lock(&filp->table_lock);
294
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))
299 return -EINVAL;
300
301 /* Release driver's reference and decrement refcount. */
302 drm_gem_object_release_handle(handle, obj, filp);
303
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);
308
309 return 0;
310}
311EXPORT_SYMBOL(drm_gem_handle_delete);
312
313/**
314 * drm_gem_dumb_destroy - dumb fb callback helper for gem based drivers
315 * @file: drm file-private structure to remove the dumb handle from
316 * @dev: corresponding drm_device
317 * @handle: the dumb handle to remove
318 *
319 * This implements the ->dumb_destroy kms driver callback for drivers which use
320 * gem to manage their backing storage.
321 */
322int drm_gem_dumb_destroy(struct drm_file *file,
323 struct drm_device *dev,
324 uint32_t handle)
325{
326 return drm_gem_handle_delete(file, handle);
327}
328EXPORT_SYMBOL(drm_gem_dumb_destroy);
329
330/**
331 * drm_gem_handle_create_tail - internal functions to create a handle
332 * @file_priv: drm file-private structure to register the handle for
333 * @obj: object to register
334 * @handlep: pointer to return the created handle to the caller
335 *
336 * This expects the dev->object_name_lock to be held already and will drop it
337 * before returning. Used to avoid races in establishing new handles when
338 * importing an object from either an flink name or a dma-buf.
339 *
340 * Handles must be release again through drm_gem_handle_delete(). This is done
341 * when userspace closes @file_priv for all attached handles, or through the
342 * GEM_CLOSE ioctl for individual handles.
343 */
344int
345drm_gem_handle_create_tail(struct drm_file *file_priv,
346 struct drm_gem_object *obj,
347 u32 *handlep)
348{
349 struct drm_device *dev = obj->dev;
350 u32 handle;
351 int ret;
352
353 WARN_ON(!mutex_is_locked(&dev->object_name_lock));
354 if (obj->handle_count++ == 0)
355 drm_gem_object_reference(obj);
356
357 /*
358 * Get the user-visible handle using idr. Preload and perform
359 * allocation under our spinlock.
360 */
361 idr_preload(GFP_KERNEL);
362 spin_lock(&file_priv->table_lock);
363
364 ret = idr_alloc(&file_priv->object_idr, obj, 1, 0, GFP_NOWAIT);
365
366 spin_unlock(&file_priv->table_lock);
367 idr_preload_end();
368
369 mutex_unlock(&dev->object_name_lock);
370 if (ret < 0)
371 goto err_unref;
372
373 handle = ret;
374
375 ret = drm_vma_node_allow(&obj->vma_node, file_priv);
376 if (ret)
377 goto err_remove;
378
379 if (dev->driver->gem_open_object) {
380 ret = dev->driver->gem_open_object(obj, file_priv);
381 if (ret)
382 goto err_revoke;
383 }
384
385 *handlep = handle;
386 return 0;
387
388err_revoke:
389 drm_vma_node_revoke(&obj->vma_node, file_priv);
390err_remove:
391 spin_lock(&file_priv->table_lock);
392 idr_remove(&file_priv->object_idr, handle);
393 spin_unlock(&file_priv->table_lock);
394err_unref:
395 drm_gem_object_handle_unreference_unlocked(obj);
396 return ret;
397}
398
399/**
400 * drm_gem_handle_create - create a gem handle for an object
401 * @file_priv: drm file-private structure to register the handle for
402 * @obj: object to register
403 * @handlep: pionter to return the created handle to the caller
404 *
405 * Create a handle for this object. This adds a handle reference
406 * to the object, which includes a regular reference count. Callers
407 * will likely want to dereference the object afterwards.
408 */
409int drm_gem_handle_create(struct drm_file *file_priv,
410 struct drm_gem_object *obj,
411 u32 *handlep)
412{
413 mutex_lock(&obj->dev->object_name_lock);
414
415 return drm_gem_handle_create_tail(file_priv, obj, handlep);
416}
417EXPORT_SYMBOL(drm_gem_handle_create);
418
419
420/**
421 * drm_gem_free_mmap_offset - release a fake mmap offset for an object
422 * @obj: obj in question
423 *
424 * This routine frees fake offsets allocated by drm_gem_create_mmap_offset().
425 *
426 * Note that drm_gem_object_release() already calls this function, so drivers
427 * don't have to take care of releasing the mmap offset themselves when freeing
428 * the GEM object.
429 */
430void
431drm_gem_free_mmap_offset(struct drm_gem_object *obj)
432{
433 struct drm_device *dev = obj->dev;
434
435 drm_vma_offset_remove(dev->vma_offset_manager, &obj->vma_node);
436}
437EXPORT_SYMBOL(drm_gem_free_mmap_offset);
438
439/**
440 * drm_gem_create_mmap_offset_size - create a fake mmap offset for an object
441 * @obj: obj in question
442 * @size: the virtual size
443 *
444 * GEM memory mapping works by handing back to userspace a fake mmap offset
445 * it can use in a subsequent mmap(2) call. The DRM core code then looks
446 * up the object based on the offset and sets up the various memory mapping
447 * structures.
448 *
449 * This routine allocates and attaches a fake offset for @obj, in cases where
450 * the virtual size differs from the physical size (ie. obj->size). Otherwise
451 * just use drm_gem_create_mmap_offset().
452 *
453 * This function is idempotent and handles an already allocated mmap offset
454 * transparently. Drivers do not need to check for this case.
455 */
456int
457drm_gem_create_mmap_offset_size(struct drm_gem_object *obj, size_t size)
458{
459 struct drm_device *dev = obj->dev;
460
461 return drm_vma_offset_add(dev->vma_offset_manager, &obj->vma_node,
462 size / PAGE_SIZE);
463}
464EXPORT_SYMBOL(drm_gem_create_mmap_offset_size);
465
466/**
467 * drm_gem_create_mmap_offset - create a fake mmap offset for an object
468 * @obj: obj in question
469 *
470 * GEM memory mapping works by handing back to userspace a fake mmap offset
471 * it can use in a subsequent mmap(2) call. The DRM core code then looks
472 * up the object based on the offset and sets up the various memory mapping
473 * structures.
474 *
475 * This routine allocates and attaches a fake offset for @obj.
476 *
477 * Drivers can call drm_gem_free_mmap_offset() before freeing @obj to release
478 * the fake offset again.
479 */
480int drm_gem_create_mmap_offset(struct drm_gem_object *obj)
481{
482 return drm_gem_create_mmap_offset_size(obj, obj->size);
483}
484EXPORT_SYMBOL(drm_gem_create_mmap_offset);
485
486/**
487 * drm_gem_get_pages - helper to allocate backing pages for a GEM object
488 * from shmem
489 * @obj: obj in question
490 *
491 * This reads the page-array of the shmem-backing storage of the given gem
492 * object. An array of pages is returned. If a page is not allocated or
493 * swapped-out, this will allocate/swap-in the required pages. Note that the
494 * whole object is covered by the page-array and pinned in memory.
495 *
496 * Use drm_gem_put_pages() to release the array and unpin all pages.
497 *
498 * This uses the GFP-mask set on the shmem-mapping (see mapping_set_gfp_mask()).
499 * If you require other GFP-masks, you have to do those allocations yourself.
500 *
501 * Note that you are not allowed to change gfp-zones during runtime. That is,
502 * shmem_read_mapping_page_gfp() must be called with the same gfp_zone(gfp) as
503 * set during initialization. If you have special zone constraints, set them
504 * after drm_gem_init_object() via mapping_set_gfp_mask(). shmem-core takes care
505 * to keep pages in the required zone during swap-in.
506 */
507struct page **drm_gem_get_pages(struct drm_gem_object *obj)
508{
509 struct address_space *mapping;
510 struct page *p, **pages;
511 int i, npages;
512
513 /* This is the shared memory object that backs the GEM resource */
514 mapping = obj->filp->f_mapping;
515
516 /* We already BUG_ON() for non-page-aligned sizes in
517 * drm_gem_object_init(), so we should never hit this unless
518 * driver author is doing something really wrong:
519 */
520 WARN_ON((obj->size & (PAGE_SIZE - 1)) != 0);
521
522 npages = obj->size >> PAGE_SHIFT;
523
524 pages = drm_malloc_ab(npages, sizeof(struct page *));
525 if (pages == NULL)
526 return ERR_PTR(-ENOMEM);
527
528 for (i = 0; i < npages; i++) {
529 p = shmem_read_mapping_page(mapping, i);
530 if (IS_ERR(p))
531 goto fail;
532 pages[i] = p;
533
534 /* Make sure shmem keeps __GFP_DMA32 allocated pages in the
535 * correct region during swapin. Note that this requires
536 * __GFP_DMA32 to be set in mapping_gfp_mask(inode->i_mapping)
537 * so shmem can relocate pages during swapin if required.
538 */
539 BUG_ON(mapping_gfp_constraint(mapping, __GFP_DMA32) &&
540 (page_to_pfn(p) >= 0x00100000UL));
541 }
542
543 return pages;
544
545fail:
546 while (i--)
547 put_page(pages[i]);
548
549 drm_free_large(pages);
550 return ERR_CAST(p);
551}
552EXPORT_SYMBOL(drm_gem_get_pages);
553
554/**
555 * drm_gem_put_pages - helper to free backing pages for a GEM object
556 * @obj: obj in question
557 * @pages: pages to free
558 * @dirty: if true, pages will be marked as dirty
559 * @accessed: if true, the pages will be marked as accessed
560 */
561void drm_gem_put_pages(struct drm_gem_object *obj, struct page **pages,
562 bool dirty, bool accessed)
563{
564 int i, npages;
565
566 /* We already BUG_ON() for non-page-aligned sizes in
567 * drm_gem_object_init(), so we should never hit this unless
568 * driver author is doing something really wrong:
569 */
570 WARN_ON((obj->size & (PAGE_SIZE - 1)) != 0);
571
572 npages = obj->size >> PAGE_SHIFT;
573
574 for (i = 0; i < npages; i++) {
575 if (dirty)
576 set_page_dirty(pages[i]);
577
578 if (accessed)
579 mark_page_accessed(pages[i]);
580
581 /* Undo the reference we took when populating the table */
582 put_page(pages[i]);
583 }
584
585 drm_free_large(pages);
586}
587EXPORT_SYMBOL(drm_gem_put_pages);
588
589/**
590 * drm_gem_object_lookup - look up a GEM object from it's handle
591 * @filp: DRM file private date
592 * @handle: userspace handle
593 *
594 * Returns:
595 *
596 * A reference to the object named by the handle if such exists on @filp, NULL
597 * otherwise.
598 */
599struct drm_gem_object *
600drm_gem_object_lookup(struct drm_file *filp, u32 handle)
601{
602 struct drm_gem_object *obj;
603
604 spin_lock(&filp->table_lock);
605
606 /* Check if we currently have a reference on the object */
607 obj = idr_find(&filp->object_idr, handle);
608 if (obj)
609 drm_gem_object_reference(obj);
610
611 spin_unlock(&filp->table_lock);
612
613 return obj;
614}
615EXPORT_SYMBOL(drm_gem_object_lookup);
616
617/**
618 * drm_gem_close_ioctl - implementation of the GEM_CLOSE ioctl
619 * @dev: drm_device
620 * @data: ioctl data
621 * @file_priv: drm file-private structure
622 *
623 * Releases the handle to an mm object.
624 */
625int
626drm_gem_close_ioctl(struct drm_device *dev, void *data,
627 struct drm_file *file_priv)
628{
629 struct drm_gem_close *args = data;
630 int ret;
631
632 if (!drm_core_check_feature(dev, DRIVER_GEM))
633 return -ENODEV;
634
635 ret = drm_gem_handle_delete(file_priv, args->handle);
636
637 return ret;
638}
639
640/**
641 * drm_gem_flink_ioctl - implementation of the GEM_FLINK ioctl
642 * @dev: drm_device
643 * @data: ioctl data
644 * @file_priv: drm file-private structure
645 *
646 * Create a global name for an object, returning the name.
647 *
648 * Note that the name does not hold a reference; when the object
649 * is freed, the name goes away.
650 */
651int
652drm_gem_flink_ioctl(struct drm_device *dev, void *data,
653 struct drm_file *file_priv)
654{
655 struct drm_gem_flink *args = data;
656 struct drm_gem_object *obj;
657 int ret;
658
659 if (!drm_core_check_feature(dev, DRIVER_GEM))
660 return -ENODEV;
661
662 obj = drm_gem_object_lookup(file_priv, args->handle);
663 if (obj == NULL)
664 return -ENOENT;
665
666 mutex_lock(&dev->object_name_lock);
667 /* prevent races with concurrent gem_close. */
668 if (obj->handle_count == 0) {
669 ret = -ENOENT;
670 goto err;
671 }
672
673 if (!obj->name) {
674 ret = idr_alloc(&dev->object_name_idr, obj, 1, 0, GFP_KERNEL);
675 if (ret < 0)
676 goto err;
677
678 obj->name = ret;
679 }
680
681 args->name = (uint64_t) obj->name;
682 ret = 0;
683
684err:
685 mutex_unlock(&dev->object_name_lock);
686 drm_gem_object_unreference_unlocked(obj);
687 return ret;
688}
689
690/**
691 * drm_gem_open - implementation of the GEM_OPEN ioctl
692 * @dev: drm_device
693 * @data: ioctl data
694 * @file_priv: drm file-private structure
695 *
696 * Open an object using the global name, returning a handle and the size.
697 *
698 * This handle (of course) holds a reference to the object, so the object
699 * will not go away until the handle is deleted.
700 */
701int
702drm_gem_open_ioctl(struct drm_device *dev, void *data,
703 struct drm_file *file_priv)
704{
705 struct drm_gem_open *args = data;
706 struct drm_gem_object *obj;
707 int ret;
708 u32 handle;
709
710 if (!drm_core_check_feature(dev, DRIVER_GEM))
711 return -ENODEV;
712
713 mutex_lock(&dev->object_name_lock);
714 obj = idr_find(&dev->object_name_idr, (int) args->name);
715 if (obj) {
716 drm_gem_object_reference(obj);
717 } else {
718 mutex_unlock(&dev->object_name_lock);
719 return -ENOENT;
720 }
721
722 /* drm_gem_handle_create_tail unlocks dev->object_name_lock. */
723 ret = drm_gem_handle_create_tail(file_priv, obj, &handle);
724 drm_gem_object_unreference_unlocked(obj);
725 if (ret)
726 return ret;
727
728 args->handle = handle;
729 args->size = obj->size;
730
731 return 0;
732}
733
734/**
735 * gem_gem_open - initalizes GEM file-private structures at devnode open time
736 * @dev: drm_device which is being opened by userspace
737 * @file_private: drm file-private structure to set up
738 *
739 * Called at device open time, sets up the structure for handling refcounting
740 * of mm objects.
741 */
742void
743drm_gem_open(struct drm_device *dev, struct drm_file *file_private)
744{
745 idr_init(&file_private->object_idr);
746 spin_lock_init(&file_private->table_lock);
747}
748
749/**
750 * drm_gem_release - release file-private GEM resources
751 * @dev: drm_device which is being closed by userspace
752 * @file_private: drm file-private structure to clean up
753 *
754 * Called at close time when the filp is going away.
755 *
756 * Releases any remaining references on objects by this filp.
757 */
758void
759drm_gem_release(struct drm_device *dev, struct drm_file *file_private)
760{
761 idr_for_each(&file_private->object_idr,
762 &drm_gem_object_release_handle, file_private);
763 idr_destroy(&file_private->object_idr);
764}
765
766/**
767 * drm_gem_object_release - release GEM buffer object resources
768 * @obj: GEM buffer object
769 *
770 * This releases any structures and resources used by @obj and is the invers of
771 * drm_gem_object_init().
772 */
773void
774drm_gem_object_release(struct drm_gem_object *obj)
775{
776 WARN_ON(obj->dma_buf);
777
778 if (obj->filp)
779 fput(obj->filp);
780
781 drm_gem_free_mmap_offset(obj);
782}
783EXPORT_SYMBOL(drm_gem_object_release);
784
785/**
786 * drm_gem_object_free - free a GEM object
787 * @kref: kref of the object to free
788 *
789 * Called after the last reference to the object has been lost.
790 * Must be called holding &drm_device->struct_mutex.
791 *
792 * Frees the object
793 */
794void
795drm_gem_object_free(struct kref *kref)
796{
797 struct drm_gem_object *obj =
798 container_of(kref, struct drm_gem_object, refcount);
799 struct drm_device *dev = obj->dev;
800
801 if (dev->driver->gem_free_object_unlocked) {
802 dev->driver->gem_free_object_unlocked(obj);
803 } else if (dev->driver->gem_free_object) {
804 WARN_ON(!mutex_is_locked(&dev->struct_mutex));
805
806 dev->driver->gem_free_object(obj);
807 }
808}
809EXPORT_SYMBOL(drm_gem_object_free);
810
811/**
812 * drm_gem_object_unreference_unlocked - release a GEM BO reference
813 * @obj: GEM buffer object
814 *
815 * This releases a reference to @obj. Callers must not hold the
816 * dev->struct_mutex lock when calling this function.
817 *
818 * See also __drm_gem_object_unreference().
819 */
820void
821drm_gem_object_unreference_unlocked(struct drm_gem_object *obj)
822{
823 struct drm_device *dev;
824
825 if (!obj)
826 return;
827
828 dev = obj->dev;
829 might_lock(&dev->struct_mutex);
830
831 if (dev->driver->gem_free_object_unlocked)
832 kref_put(&obj->refcount, drm_gem_object_free);
833 else if (kref_put_mutex(&obj->refcount, drm_gem_object_free,
834 &dev->struct_mutex))
835 mutex_unlock(&dev->struct_mutex);
836}
837EXPORT_SYMBOL(drm_gem_object_unreference_unlocked);
838
839/**
840 * drm_gem_object_unreference - release a GEM BO reference
841 * @obj: GEM buffer object
842 *
843 * This releases a reference to @obj. Callers must hold the dev->struct_mutex
844 * lock when calling this function, even when the driver doesn't use
845 * dev->struct_mutex for anything.
846 *
847 * For drivers not encumbered with legacy locking use
848 * drm_gem_object_unreference_unlocked() instead.
849 */
850void
851drm_gem_object_unreference(struct drm_gem_object *obj)
852{
853 if (obj) {
854 WARN_ON(!mutex_is_locked(&obj->dev->struct_mutex));
855
856 kref_put(&obj->refcount, drm_gem_object_free);
857 }
858}
859EXPORT_SYMBOL(drm_gem_object_unreference);
860
861/**
862 * drm_gem_vm_open - vma->ops->open implementation for GEM
863 * @vma: VM area structure
864 *
865 * This function implements the #vm_operations_struct open() callback for GEM
866 * drivers. This must be used together with drm_gem_vm_close().
867 */
868void drm_gem_vm_open(struct vm_area_struct *vma)
869{
870 struct drm_gem_object *obj = vma->vm_private_data;
871
872 drm_gem_object_reference(obj);
873}
874EXPORT_SYMBOL(drm_gem_vm_open);
875
876/**
877 * drm_gem_vm_close - vma->ops->close implementation for GEM
878 * @vma: VM area structure
879 *
880 * This function implements the #vm_operations_struct close() callback for GEM
881 * drivers. This must be used together with drm_gem_vm_open().
882 */
883void drm_gem_vm_close(struct vm_area_struct *vma)
884{
885 struct drm_gem_object *obj = vma->vm_private_data;
886
887 drm_gem_object_unreference_unlocked(obj);
888}
889EXPORT_SYMBOL(drm_gem_vm_close);
890
891/**
892 * drm_gem_mmap_obj - memory map a GEM object
893 * @obj: the GEM object to map
894 * @obj_size: the object size to be mapped, in bytes
895 * @vma: VMA for the area to be mapped
896 *
897 * Set up the VMA to prepare mapping of the GEM object using the gem_vm_ops
898 * provided by the driver. Depending on their requirements, drivers can either
899 * provide a fault handler in their gem_vm_ops (in which case any accesses to
900 * the object will be trapped, to perform migration, GTT binding, surface
901 * register allocation, or performance monitoring), or mmap the buffer memory
902 * synchronously after calling drm_gem_mmap_obj.
903 *
904 * This function is mainly intended to implement the DMABUF mmap operation, when
905 * the GEM object is not looked up based on its fake offset. To implement the
906 * DRM mmap operation, drivers should use the drm_gem_mmap() function.
907 *
908 * drm_gem_mmap_obj() assumes the user is granted access to the buffer while
909 * drm_gem_mmap() prevents unprivileged users from mapping random objects. So
910 * callers must verify access restrictions before calling this helper.
911 *
912 * Return 0 or success or -EINVAL if the object size is smaller than the VMA
913 * size, or if no gem_vm_ops are provided.
914 */
915int drm_gem_mmap_obj(struct drm_gem_object *obj, unsigned long obj_size,
916 struct vm_area_struct *vma)
917{
918 struct drm_device *dev = obj->dev;
919
920 /* Check for valid size. */
921 if (obj_size < vma->vm_end - vma->vm_start)
922 return -EINVAL;
923
924 if (!dev->driver->gem_vm_ops)
925 return -EINVAL;
926
927 vma->vm_flags |= VM_IO | VM_PFNMAP | VM_DONTEXPAND | VM_DONTDUMP;
928 vma->vm_ops = dev->driver->gem_vm_ops;
929 vma->vm_private_data = obj;
930 vma->vm_page_prot = pgprot_writecombine(vm_get_page_prot(vma->vm_flags));
931
932 /* Take a ref for this mapping of the object, so that the fault
933 * handler can dereference the mmap offset's pointer to the object.
934 * This reference is cleaned up by the corresponding vm_close
935 * (which should happen whether the vma was created by this call, or
936 * by a vm_open due to mremap or partial unmap or whatever).
937 */
938 drm_gem_object_reference(obj);
939
940 return 0;
941}
942EXPORT_SYMBOL(drm_gem_mmap_obj);
943
944/**
945 * drm_gem_mmap - memory map routine for GEM objects
946 * @filp: DRM file pointer
947 * @vma: VMA for the area to be mapped
948 *
949 * If a driver supports GEM object mapping, mmap calls on the DRM file
950 * descriptor will end up here.
951 *
952 * Look up the GEM object based on the offset passed in (vma->vm_pgoff will
953 * contain the fake offset we created when the GTT map ioctl was called on
954 * the object) and map it with a call to drm_gem_mmap_obj().
955 *
956 * If the caller is not granted access to the buffer object, the mmap will fail
957 * with EACCES. Please see the vma manager for more information.
958 */
959int drm_gem_mmap(struct file *filp, struct vm_area_struct *vma)
960{
961 struct drm_file *priv = filp->private_data;
962 struct drm_device *dev = priv->minor->dev;
963 struct drm_gem_object *obj = NULL;
964 struct drm_vma_offset_node *node;
965 int ret;
966
967 if (drm_device_is_unplugged(dev))
968 return -ENODEV;
969
970 drm_vma_offset_lock_lookup(dev->vma_offset_manager);
971 node = drm_vma_offset_exact_lookup_locked(dev->vma_offset_manager,
972 vma->vm_pgoff,
973 vma_pages(vma));
974 if (likely(node)) {
975 obj = container_of(node, struct drm_gem_object, vma_node);
976 /*
977 * When the object is being freed, after it hits 0-refcnt it
978 * proceeds to tear down the object. In the process it will
979 * attempt to remove the VMA offset and so acquire this
980 * mgr->vm_lock. Therefore if we find an object with a 0-refcnt
981 * that matches our range, we know it is in the process of being
982 * destroyed and will be freed as soon as we release the lock -
983 * so we have to check for the 0-refcnted object and treat it as
984 * invalid.
985 */
986 if (!kref_get_unless_zero(&obj->refcount))
987 obj = NULL;
988 }
989 drm_vma_offset_unlock_lookup(dev->vma_offset_manager);
990
991 if (!obj)
992 return -EINVAL;
993
994 if (!drm_vma_node_is_allowed(node, priv)) {
995 drm_gem_object_unreference_unlocked(obj);
996 return -EACCES;
997 }
998
999 ret = drm_gem_mmap_obj(obj, drm_vma_node_size(node) << PAGE_SHIFT,
1000 vma);
1001
1002 drm_gem_object_unreference_unlocked(obj);
1003
1004 return ret;
1005}
1006EXPORT_SYMBOL(drm_gem_mmap);