drm/prime: clarify logic a bit in drm_gem_prime_fd_to_handle
[deliverable/linux.git] / drivers / gpu / drm / drm_gem.c
CommitLineData
673a394b
EA
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>
5949eac4 37#include <linux/shmem_fs.h>
3248877e 38#include <linux/dma-buf.h>
760285e7 39#include <drm/drmP.h>
0de23977 40#include <drm/drm_vma_manager.h>
673a394b
EA
41
42/** @file drm_gem.c
43 *
44 * This file provides some of the base ioctls and library routines for
45 * the graphics memory manager implemented by each device driver.
46 *
47 * Because various devices have different requirements in terms of
48 * synchronization and migration strategies, implementing that is left up to
49 * the driver, and all that the general API provides should be generic --
50 * allocating objects, reading/writing data with the cpu, freeing objects.
51 * Even there, platform-dependent optimizations for reading/writing data with
52 * the CPU mean we'll likely hook those out to driver-specific calls. However,
53 * the DRI2 implementation wants to have at least allocate/mmap be generic.
54 *
55 * The goal was to have swap-backed object allocation managed through
56 * struct file. However, file descriptors as handles to a struct file have
57 * two major failings:
58 * - Process limits prevent more than 1024 or so being used at a time by
59 * default.
60 * - Inability to allocate high fds will aggravate the X Server's select()
61 * handling, and likely that of many GL client applications as well.
62 *
63 * This led to a plan of using our own integer IDs (called handles, following
64 * DRM terminology) to mimic fds, and implement the fd syscalls we need as
65 * ioctls. The objects themselves will still include the struct file so
66 * that we can transition to fds if the required kernel infrastructure shows
67 * up at a later date, and as our interface with shmfs for memory allocation.
68 */
69
a2c0a97b
JB
70/*
71 * We make up offsets for buffer objects so we can recognize them at
72 * mmap time.
73 */
05269a3a
JC
74
75/* pgoff in mmap is an unsigned long, so we need to make sure that
76 * the faked up offset will fit
77 */
78
79#if BITS_PER_LONG == 64
a2c0a97b
JB
80#define DRM_FILE_PAGE_OFFSET_START ((0xFFFFFFFFUL >> PAGE_SHIFT) + 1)
81#define DRM_FILE_PAGE_OFFSET_SIZE ((0xFFFFFFFFUL >> PAGE_SHIFT) * 16)
05269a3a
JC
82#else
83#define DRM_FILE_PAGE_OFFSET_START ((0xFFFFFFFUL >> PAGE_SHIFT) + 1)
84#define DRM_FILE_PAGE_OFFSET_SIZE ((0xFFFFFFFUL >> PAGE_SHIFT) * 16)
85#endif
a2c0a97b 86
673a394b
EA
87/**
88 * Initialize the GEM device fields
89 */
90
91int
92drm_gem_init(struct drm_device *dev)
93{
a2c0a97b
JB
94 struct drm_gem_mm *mm;
95
673a394b
EA
96 spin_lock_init(&dev->object_name_lock);
97 idr_init(&dev->object_name_idr);
a2c0a97b 98
9a298b2a 99 mm = kzalloc(sizeof(struct drm_gem_mm), GFP_KERNEL);
a2c0a97b
JB
100 if (!mm) {
101 DRM_ERROR("out of memory\n");
102 return -ENOMEM;
103 }
104
105 dev->mm_private = mm;
0de23977
DH
106 drm_vma_offset_manager_init(&mm->vma_manager,
107 DRM_FILE_PAGE_OFFSET_START,
108 DRM_FILE_PAGE_OFFSET_SIZE);
a2c0a97b 109
673a394b
EA
110 return 0;
111}
112
a2c0a97b
JB
113void
114drm_gem_destroy(struct drm_device *dev)
115{
116 struct drm_gem_mm *mm = dev->mm_private;
117
0de23977 118 drm_vma_offset_manager_destroy(&mm->vma_manager);
9a298b2a 119 kfree(mm);
a2c0a97b
JB
120 dev->mm_private = NULL;
121}
122
1d397043 123/**
62cb7011 124 * Initialize an already allocated GEM object of the specified size with
1d397043
DV
125 * shmfs backing store.
126 */
127int drm_gem_object_init(struct drm_device *dev,
128 struct drm_gem_object *obj, size_t size)
129{
89c8233f 130 struct file *filp;
1d397043 131
89c8233f
DH
132 filp = shmem_file_setup("drm mm object", size, VM_NORESERVE);
133 if (IS_ERR(filp))
134 return PTR_ERR(filp);
1d397043 135
89c8233f
DH
136 drm_gem_private_object_init(dev, obj, size);
137 obj->filp = filp;
1d397043 138
1d397043
DV
139 return 0;
140}
141EXPORT_SYMBOL(drm_gem_object_init);
142
62cb7011
AC
143/**
144 * Initialize an already allocated GEM object of the specified size with
145 * no GEM provided backing store. Instead the caller is responsible for
146 * backing the object and handling it.
147 */
89c8233f
DH
148void drm_gem_private_object_init(struct drm_device *dev,
149 struct drm_gem_object *obj, size_t size)
62cb7011
AC
150{
151 BUG_ON((size & (PAGE_SIZE - 1)) != 0);
152
153 obj->dev = dev;
154 obj->filp = NULL;
155
156 kref_init(&obj->refcount);
a8e11d1c 157 obj->handle_count = 0;
62cb7011 158 obj->size = size;
62cb7011
AC
159}
160EXPORT_SYMBOL(drm_gem_private_object_init);
161
673a394b
EA
162/**
163 * Allocate a GEM object of the specified size with shmfs backing store
164 */
165struct drm_gem_object *
166drm_gem_object_alloc(struct drm_device *dev, size_t size)
167{
168 struct drm_gem_object *obj;
169
b798b1fe 170 obj = kzalloc(sizeof(*obj), GFP_KERNEL);
845792d9
JS
171 if (!obj)
172 goto free;
673a394b 173
1d397043 174 if (drm_gem_object_init(dev, obj, size) != 0)
845792d9 175 goto free;
673a394b 176
673a394b
EA
177 if (dev->driver->gem_init_object != NULL &&
178 dev->driver->gem_init_object(obj) != 0) {
845792d9 179 goto fput;
673a394b 180 }
673a394b 181 return obj;
845792d9 182fput:
1d397043 183 /* Object_init mangles the global counters - readjust them. */
845792d9
JS
184 fput(obj->filp);
185free:
186 kfree(obj);
187 return NULL;
673a394b
EA
188}
189EXPORT_SYMBOL(drm_gem_object_alloc);
190
0ff926c7
DA
191static void
192drm_gem_remove_prime_handles(struct drm_gem_object *obj, struct drm_file *filp)
193{
194 if (obj->import_attach) {
219b4733 195 drm_prime_remove_buf_handle(&filp->prime,
0ff926c7
DA
196 obj->import_attach->dmabuf);
197 }
198 if (obj->export_dma_buf) {
219b4733 199 drm_prime_remove_buf_handle(&filp->prime,
0ff926c7
DA
200 obj->export_dma_buf);
201 }
202}
203
36da5908
DV
204static void drm_gem_object_ref_bug(struct kref *list_kref)
205{
206 BUG();
207}
208
209/**
210 * Called after the last handle to the object has been closed
211 *
212 * Removes any name for the object. Note that this must be
213 * called before drm_gem_object_free or we'll be touching
214 * freed memory
215 */
216static void drm_gem_object_handle_free(struct drm_gem_object *obj)
217{
218 struct drm_device *dev = obj->dev;
219
220 /* Remove any name for this object */
36da5908
DV
221 if (obj->name) {
222 idr_remove(&dev->object_name_idr, obj->name);
223 obj->name = 0;
36da5908
DV
224 /*
225 * The object name held a reference to this object, drop
226 * that now.
227 *
228 * This cannot be the last reference, since the handle holds one too.
229 */
230 kref_put(&obj->refcount, drm_gem_object_ref_bug);
a8e11d1c 231 }
36da5908
DV
232}
233
becee2a5 234static void
36da5908
DV
235drm_gem_object_handle_unreference_unlocked(struct drm_gem_object *obj)
236{
a8e11d1c 237 if (WARN_ON(obj->handle_count == 0))
36da5908
DV
238 return;
239
240 /*
241 * Must bump handle count first as this may be the last
242 * ref, in which case the object would disappear before we
243 * checked for a name
244 */
245
a8e11d1c
DV
246 spin_lock(&obj->dev->object_name_lock);
247 if (--obj->handle_count == 0)
36da5908 248 drm_gem_object_handle_free(obj);
a8e11d1c
DV
249 spin_unlock(&obj->dev->object_name_lock);
250
36da5908
DV
251 drm_gem_object_unreference_unlocked(obj);
252}
253
673a394b
EA
254/**
255 * Removes the mapping from handle to filp for this object.
256 */
ff72145b 257int
a1a2d1d3 258drm_gem_handle_delete(struct drm_file *filp, u32 handle)
673a394b
EA
259{
260 struct drm_device *dev;
261 struct drm_gem_object *obj;
262
263 /* This is gross. The idr system doesn't let us try a delete and
264 * return an error code. It just spews if you fail at deleting.
265 * So, we have to grab a lock around finding the object and then
266 * doing the delete on it and dropping the refcount, or the user
267 * could race us to double-decrement the refcount and cause a
268 * use-after-free later. Given the frequency of our handle lookups,
269 * we may want to use ida for number allocation and a hash table
270 * for the pointers, anyway.
271 */
272 spin_lock(&filp->table_lock);
273
274 /* Check if we currently have a reference on the object */
275 obj = idr_find(&filp->object_idr, handle);
276 if (obj == NULL) {
277 spin_unlock(&filp->table_lock);
278 return -EINVAL;
279 }
280 dev = obj->dev;
281
282 /* Release reference and decrement refcount. */
283 idr_remove(&filp->object_idr, handle);
284 spin_unlock(&filp->table_lock);
285
0ff926c7 286 drm_gem_remove_prime_handles(obj, filp);
3248877e 287
304eda32
BS
288 if (dev->driver->gem_close_object)
289 dev->driver->gem_close_object(obj, filp);
bc9025bd 290 drm_gem_object_handle_unreference_unlocked(obj);
673a394b
EA
291
292 return 0;
293}
ff72145b 294EXPORT_SYMBOL(drm_gem_handle_delete);
673a394b 295
43387b37
DV
296/**
297 * drm_gem_dumb_destroy - dumb fb callback helper for gem based drivers
298 *
299 * This implements the ->dumb_destroy kms driver callback for drivers which use
300 * gem to manage their backing storage.
301 */
302int drm_gem_dumb_destroy(struct drm_file *file,
303 struct drm_device *dev,
304 uint32_t handle)
305{
306 return drm_gem_handle_delete(file, handle);
307}
308EXPORT_SYMBOL(drm_gem_dumb_destroy);
309
673a394b
EA
310/**
311 * Create a handle for this object. This adds a handle reference
312 * to the object, which includes a regular reference count. Callers
313 * will likely want to dereference the object afterwards.
314 */
315int
316drm_gem_handle_create(struct drm_file *file_priv,
317 struct drm_gem_object *obj,
a1a2d1d3 318 u32 *handlep)
673a394b 319{
304eda32
BS
320 struct drm_device *dev = obj->dev;
321 int ret;
673a394b
EA
322
323 /*
2e928815
TH
324 * Get the user-visible handle using idr. Preload and perform
325 * allocation under our spinlock.
673a394b 326 */
2e928815 327 idr_preload(GFP_KERNEL);
a8e11d1c 328 spin_lock(&dev->object_name_lock);
673a394b 329 spin_lock(&file_priv->table_lock);
2e928815
TH
330
331 ret = idr_alloc(&file_priv->object_idr, obj, 1, 0, GFP_NOWAIT);
a8e11d1c
DV
332 drm_gem_object_reference(obj);
333 obj->handle_count++;
673a394b 334 spin_unlock(&file_priv->table_lock);
a8e11d1c 335 spin_unlock(&dev->object_name_lock);
2e928815 336 idr_preload_end();
a8e11d1c
DV
337 if (ret < 0) {
338 drm_gem_object_handle_unreference_unlocked(obj);
673a394b 339 return ret;
a8e11d1c 340 }
2e928815 341 *handlep = ret;
673a394b 342
304eda32
BS
343
344 if (dev->driver->gem_open_object) {
345 ret = dev->driver->gem_open_object(obj, file_priv);
346 if (ret) {
347 drm_gem_handle_delete(file_priv, *handlep);
348 return ret;
349 }
350 }
351
673a394b
EA
352 return 0;
353}
354EXPORT_SYMBOL(drm_gem_handle_create);
355
75ef8b3b
RC
356
357/**
358 * drm_gem_free_mmap_offset - release a fake mmap offset for an object
359 * @obj: obj in question
360 *
361 * This routine frees fake offsets allocated by drm_gem_create_mmap_offset().
362 */
363void
364drm_gem_free_mmap_offset(struct drm_gem_object *obj)
365{
366 struct drm_device *dev = obj->dev;
367 struct drm_gem_mm *mm = dev->mm_private;
75ef8b3b 368
0de23977 369 drm_vma_offset_remove(&mm->vma_manager, &obj->vma_node);
75ef8b3b
RC
370}
371EXPORT_SYMBOL(drm_gem_free_mmap_offset);
372
373/**
367bbd49 374 * drm_gem_create_mmap_offset_size - create a fake mmap offset for an object
75ef8b3b 375 * @obj: obj in question
367bbd49 376 * @size: the virtual size
75ef8b3b
RC
377 *
378 * GEM memory mapping works by handing back to userspace a fake mmap offset
379 * it can use in a subsequent mmap(2) call. The DRM core code then looks
380 * up the object based on the offset and sets up the various memory mapping
381 * structures.
382 *
367bbd49
RC
383 * This routine allocates and attaches a fake offset for @obj, in cases where
384 * the virtual size differs from the physical size (ie. obj->size). Otherwise
385 * just use drm_gem_create_mmap_offset().
75ef8b3b
RC
386 */
387int
367bbd49 388drm_gem_create_mmap_offset_size(struct drm_gem_object *obj, size_t size)
75ef8b3b
RC
389{
390 struct drm_device *dev = obj->dev;
391 struct drm_gem_mm *mm = dev->mm_private;
75ef8b3b 392
0de23977 393 return drm_vma_offset_add(&mm->vma_manager, &obj->vma_node,
367bbd49
RC
394 size / PAGE_SIZE);
395}
396EXPORT_SYMBOL(drm_gem_create_mmap_offset_size);
397
398/**
399 * drm_gem_create_mmap_offset - create a fake mmap offset for an object
400 * @obj: obj in question
401 *
402 * GEM memory mapping works by handing back to userspace a fake mmap offset
403 * it can use in a subsequent mmap(2) call. The DRM core code then looks
404 * up the object based on the offset and sets up the various memory mapping
405 * structures.
406 *
407 * This routine allocates and attaches a fake offset for @obj.
408 */
409int drm_gem_create_mmap_offset(struct drm_gem_object *obj)
410{
411 return drm_gem_create_mmap_offset_size(obj, obj->size);
75ef8b3b
RC
412}
413EXPORT_SYMBOL(drm_gem_create_mmap_offset);
414
bcc5c9d5
RC
415/**
416 * drm_gem_get_pages - helper to allocate backing pages for a GEM object
417 * from shmem
418 * @obj: obj in question
419 * @gfpmask: gfp mask of requested pages
420 */
421struct page **drm_gem_get_pages(struct drm_gem_object *obj, gfp_t gfpmask)
422{
423 struct inode *inode;
424 struct address_space *mapping;
425 struct page *p, **pages;
426 int i, npages;
427
428 /* This is the shared memory object that backs the GEM resource */
429 inode = file_inode(obj->filp);
430 mapping = inode->i_mapping;
431
432 /* We already BUG_ON() for non-page-aligned sizes in
433 * drm_gem_object_init(), so we should never hit this unless
434 * driver author is doing something really wrong:
435 */
436 WARN_ON((obj->size & (PAGE_SIZE - 1)) != 0);
437
438 npages = obj->size >> PAGE_SHIFT;
439
440 pages = drm_malloc_ab(npages, sizeof(struct page *));
441 if (pages == NULL)
442 return ERR_PTR(-ENOMEM);
443
444 gfpmask |= mapping_gfp_mask(mapping);
445
446 for (i = 0; i < npages; i++) {
447 p = shmem_read_mapping_page_gfp(mapping, i, gfpmask);
448 if (IS_ERR(p))
449 goto fail;
450 pages[i] = p;
451
452 /* There is a hypothetical issue w/ drivers that require
453 * buffer memory in the low 4GB.. if the pages are un-
454 * pinned, and swapped out, they can end up swapped back
455 * in above 4GB. If pages are already in memory, then
456 * shmem_read_mapping_page_gfp will ignore the gfpmask,
457 * even if the already in-memory page disobeys the mask.
458 *
459 * It is only a theoretical issue today, because none of
460 * the devices with this limitation can be populated with
461 * enough memory to trigger the issue. But this BUG_ON()
462 * is here as a reminder in case the problem with
463 * shmem_read_mapping_page_gfp() isn't solved by the time
464 * it does become a real issue.
465 *
466 * See this thread: http://lkml.org/lkml/2011/7/11/238
467 */
468 BUG_ON((gfpmask & __GFP_DMA32) &&
469 (page_to_pfn(p) >= 0x00100000UL));
470 }
471
472 return pages;
473
474fail:
475 while (i--)
476 page_cache_release(pages[i]);
477
478 drm_free_large(pages);
479 return ERR_CAST(p);
480}
481EXPORT_SYMBOL(drm_gem_get_pages);
482
483/**
484 * drm_gem_put_pages - helper to free backing pages for a GEM object
485 * @obj: obj in question
486 * @pages: pages to free
487 * @dirty: if true, pages will be marked as dirty
488 * @accessed: if true, the pages will be marked as accessed
489 */
490void drm_gem_put_pages(struct drm_gem_object *obj, struct page **pages,
491 bool dirty, bool accessed)
492{
493 int i, npages;
494
495 /* We already BUG_ON() for non-page-aligned sizes in
496 * drm_gem_object_init(), so we should never hit this unless
497 * driver author is doing something really wrong:
498 */
499 WARN_ON((obj->size & (PAGE_SIZE - 1)) != 0);
500
501 npages = obj->size >> PAGE_SHIFT;
502
503 for (i = 0; i < npages; i++) {
504 if (dirty)
505 set_page_dirty(pages[i]);
506
507 if (accessed)
508 mark_page_accessed(pages[i]);
509
510 /* Undo the reference we took when populating the table */
511 page_cache_release(pages[i]);
512 }
513
514 drm_free_large(pages);
515}
516EXPORT_SYMBOL(drm_gem_put_pages);
517
673a394b
EA
518/** Returns a reference to the object named by the handle. */
519struct drm_gem_object *
520drm_gem_object_lookup(struct drm_device *dev, struct drm_file *filp,
a1a2d1d3 521 u32 handle)
673a394b
EA
522{
523 struct drm_gem_object *obj;
524
525 spin_lock(&filp->table_lock);
526
527 /* Check if we currently have a reference on the object */
528 obj = idr_find(&filp->object_idr, handle);
529 if (obj == NULL) {
530 spin_unlock(&filp->table_lock);
531 return NULL;
532 }
533
534 drm_gem_object_reference(obj);
535
536 spin_unlock(&filp->table_lock);
537
538 return obj;
539}
540EXPORT_SYMBOL(drm_gem_object_lookup);
541
542/**
543 * Releases the handle to an mm object.
544 */
545int
546drm_gem_close_ioctl(struct drm_device *dev, void *data,
547 struct drm_file *file_priv)
548{
549 struct drm_gem_close *args = data;
550 int ret;
551
552 if (!(dev->driver->driver_features & DRIVER_GEM))
553 return -ENODEV;
554
555 ret = drm_gem_handle_delete(file_priv, args->handle);
556
557 return ret;
558}
559
560/**
561 * Create a global name for an object, returning the name.
562 *
563 * Note that the name does not hold a reference; when the object
564 * is freed, the name goes away.
565 */
566int
567drm_gem_flink_ioctl(struct drm_device *dev, void *data,
568 struct drm_file *file_priv)
569{
570 struct drm_gem_flink *args = data;
571 struct drm_gem_object *obj;
572 int ret;
573
574 if (!(dev->driver->driver_features & DRIVER_GEM))
575 return -ENODEV;
576
577 obj = drm_gem_object_lookup(dev, file_priv, args->handle);
578 if (obj == NULL)
bf79cb91 579 return -ENOENT;
673a394b 580
2e928815 581 idr_preload(GFP_KERNEL);
673a394b 582 spin_lock(&dev->object_name_lock);
a8e11d1c
DV
583 /* prevent races with concurrent gem_close. */
584 if (obj->handle_count == 0) {
585 ret = -ENOENT;
586 goto err;
587 }
588
8d59bae5 589 if (!obj->name) {
2e928815 590 ret = idr_alloc(&dev->object_name_idr, obj, 1, 0, GFP_NOWAIT);
2e928815 591 if (ret < 0)
8d59bae5 592 goto err;
2e07fb22
YC
593
594 obj->name = ret;
673a394b 595
8d59bae5
CW
596 /* Allocate a reference for the name table. */
597 drm_gem_object_reference(obj);
8d59bae5 598 }
3e49c4f4 599
2e07fb22
YC
600 args->name = (uint64_t) obj->name;
601 ret = 0;
602
3e49c4f4 603err:
2e07fb22
YC
604 spin_unlock(&dev->object_name_lock);
605 idr_preload_end();
bc9025bd 606 drm_gem_object_unreference_unlocked(obj);
3e49c4f4 607 return ret;
673a394b
EA
608}
609
610/**
611 * Open an object using the global name, returning a handle and the size.
612 *
613 * This handle (of course) holds a reference to the object, so the object
614 * will not go away until the handle is deleted.
615 */
616int
617drm_gem_open_ioctl(struct drm_device *dev, void *data,
618 struct drm_file *file_priv)
619{
620 struct drm_gem_open *args = data;
621 struct drm_gem_object *obj;
622 int ret;
a1a2d1d3 623 u32 handle;
673a394b
EA
624
625 if (!(dev->driver->driver_features & DRIVER_GEM))
626 return -ENODEV;
627
628 spin_lock(&dev->object_name_lock);
629 obj = idr_find(&dev->object_name_idr, (int) args->name);
630 if (obj)
631 drm_gem_object_reference(obj);
632 spin_unlock(&dev->object_name_lock);
633 if (!obj)
634 return -ENOENT;
635
636 ret = drm_gem_handle_create(file_priv, obj, &handle);
bc9025bd 637 drm_gem_object_unreference_unlocked(obj);
673a394b
EA
638 if (ret)
639 return ret;
640
641 args->handle = handle;
642 args->size = obj->size;
643
644 return 0;
645}
646
647/**
648 * Called at device open time, sets up the structure for handling refcounting
649 * of mm objects.
650 */
651void
652drm_gem_open(struct drm_device *dev, struct drm_file *file_private)
653{
654 idr_init(&file_private->object_idr);
655 spin_lock_init(&file_private->table_lock);
656}
657
658/**
659 * Called at device close to release the file's
660 * handle references on objects.
661 */
662static int
663drm_gem_object_release_handle(int id, void *ptr, void *data)
664{
304eda32 665 struct drm_file *file_priv = data;
673a394b 666 struct drm_gem_object *obj = ptr;
304eda32
BS
667 struct drm_device *dev = obj->dev;
668
0ff926c7 669 drm_gem_remove_prime_handles(obj, file_priv);
3248877e 670
304eda32
BS
671 if (dev->driver->gem_close_object)
672 dev->driver->gem_close_object(obj, file_priv);
673a394b 673
bc9025bd 674 drm_gem_object_handle_unreference_unlocked(obj);
673a394b
EA
675
676 return 0;
677}
678
679/**
680 * Called at close time when the filp is going away.
681 *
682 * Releases any remaining references on objects by this filp.
683 */
684void
685drm_gem_release(struct drm_device *dev, struct drm_file *file_private)
686{
673a394b 687 idr_for_each(&file_private->object_idr,
304eda32 688 &drm_gem_object_release_handle, file_private);
673a394b 689 idr_destroy(&file_private->object_idr);
673a394b
EA
690}
691
fd632aa3
DV
692void
693drm_gem_object_release(struct drm_gem_object *obj)
c3ae90c0 694{
62cb7011
AC
695 if (obj->filp)
696 fput(obj->filp);
c3ae90c0 697}
fd632aa3 698EXPORT_SYMBOL(drm_gem_object_release);
c3ae90c0 699
673a394b
EA
700/**
701 * Called after the last reference to the object has been lost.
c3ae90c0 702 * Must be called holding struct_ mutex
673a394b
EA
703 *
704 * Frees the object
705 */
706void
707drm_gem_object_free(struct kref *kref)
708{
709 struct drm_gem_object *obj = (struct drm_gem_object *) kref;
710 struct drm_device *dev = obj->dev;
711
712 BUG_ON(!mutex_is_locked(&dev->struct_mutex));
713
714 if (dev->driver->gem_free_object != NULL)
715 dev->driver->gem_free_object(obj);
673a394b
EA
716}
717EXPORT_SYMBOL(drm_gem_object_free);
718
ab00b3e5
JB
719void drm_gem_vm_open(struct vm_area_struct *vma)
720{
721 struct drm_gem_object *obj = vma->vm_private_data;
722
723 drm_gem_object_reference(obj);
31dfbc93
CW
724
725 mutex_lock(&obj->dev->struct_mutex);
b06d66be 726 drm_vm_open_locked(obj->dev, vma);
31dfbc93 727 mutex_unlock(&obj->dev->struct_mutex);
ab00b3e5
JB
728}
729EXPORT_SYMBOL(drm_gem_vm_open);
730
731void drm_gem_vm_close(struct vm_area_struct *vma)
732{
733 struct drm_gem_object *obj = vma->vm_private_data;
b74ad5ae 734 struct drm_device *dev = obj->dev;
ab00b3e5 735
b74ad5ae 736 mutex_lock(&dev->struct_mutex);
b06d66be 737 drm_vm_close_locked(obj->dev, vma);
31dfbc93 738 drm_gem_object_unreference(obj);
b74ad5ae 739 mutex_unlock(&dev->struct_mutex);
ab00b3e5
JB
740}
741EXPORT_SYMBOL(drm_gem_vm_close);
742
1c5aafa6
LP
743/**
744 * drm_gem_mmap_obj - memory map a GEM object
745 * @obj: the GEM object to map
746 * @obj_size: the object size to be mapped, in bytes
747 * @vma: VMA for the area to be mapped
748 *
749 * Set up the VMA to prepare mapping of the GEM object using the gem_vm_ops
750 * provided by the driver. Depending on their requirements, drivers can either
751 * provide a fault handler in their gem_vm_ops (in which case any accesses to
752 * the object will be trapped, to perform migration, GTT binding, surface
753 * register allocation, or performance monitoring), or mmap the buffer memory
754 * synchronously after calling drm_gem_mmap_obj.
755 *
756 * This function is mainly intended to implement the DMABUF mmap operation, when
757 * the GEM object is not looked up based on its fake offset. To implement the
758 * DRM mmap operation, drivers should use the drm_gem_mmap() function.
759 *
4368dd84
YC
760 * NOTE: This function has to be protected with dev->struct_mutex
761 *
1c5aafa6
LP
762 * Return 0 or success or -EINVAL if the object size is smaller than the VMA
763 * size, or if no gem_vm_ops are provided.
764 */
765int drm_gem_mmap_obj(struct drm_gem_object *obj, unsigned long obj_size,
766 struct vm_area_struct *vma)
767{
768 struct drm_device *dev = obj->dev;
769
4368dd84
YC
770 lockdep_assert_held(&dev->struct_mutex);
771
1c5aafa6
LP
772 /* Check for valid size. */
773 if (obj_size < vma->vm_end - vma->vm_start)
774 return -EINVAL;
775
776 if (!dev->driver->gem_vm_ops)
777 return -EINVAL;
778
779 vma->vm_flags |= VM_IO | VM_PFNMAP | VM_DONTEXPAND | VM_DONTDUMP;
780 vma->vm_ops = dev->driver->gem_vm_ops;
781 vma->vm_private_data = obj;
782 vma->vm_page_prot = pgprot_writecombine(vm_get_page_prot(vma->vm_flags));
783
784 /* Take a ref for this mapping of the object, so that the fault
785 * handler can dereference the mmap offset's pointer to the object.
786 * This reference is cleaned up by the corresponding vm_close
787 * (which should happen whether the vma was created by this call, or
788 * by a vm_open due to mremap or partial unmap or whatever).
789 */
790 drm_gem_object_reference(obj);
791
792 drm_vm_open_locked(dev, vma);
793 return 0;
794}
795EXPORT_SYMBOL(drm_gem_mmap_obj);
ab00b3e5 796
a2c0a97b
JB
797/**
798 * drm_gem_mmap - memory map routine for GEM objects
799 * @filp: DRM file pointer
800 * @vma: VMA for the area to be mapped
801 *
802 * If a driver supports GEM object mapping, mmap calls on the DRM file
803 * descriptor will end up here.
804 *
1c5aafa6 805 * Look up the GEM object based on the offset passed in (vma->vm_pgoff will
a2c0a97b 806 * contain the fake offset we created when the GTT map ioctl was called on
1c5aafa6 807 * the object) and map it with a call to drm_gem_mmap_obj().
a2c0a97b
JB
808 */
809int drm_gem_mmap(struct file *filp, struct vm_area_struct *vma)
810{
811 struct drm_file *priv = filp->private_data;
812 struct drm_device *dev = priv->minor->dev;
813 struct drm_gem_mm *mm = dev->mm_private;
0de23977
DH
814 struct drm_gem_object *obj;
815 struct drm_vma_offset_node *node;
a2c0a97b
JB
816 int ret = 0;
817
2c07a21d
DA
818 if (drm_device_is_unplugged(dev))
819 return -ENODEV;
820
a2c0a97b
JB
821 mutex_lock(&dev->struct_mutex);
822
0de23977
DH
823 node = drm_vma_offset_exact_lookup(&mm->vma_manager, vma->vm_pgoff,
824 vma_pages(vma));
825 if (!node) {
a2c0a97b
JB
826 mutex_unlock(&dev->struct_mutex);
827 return drm_mmap(filp, vma);
828 }
829
0de23977 830 obj = container_of(node, struct drm_gem_object, vma_node);
aed2c03c 831 ret = drm_gem_mmap_obj(obj, drm_vma_node_size(node) << PAGE_SHIFT, vma);
a2c0a97b 832
a2c0a97b
JB
833 mutex_unlock(&dev->struct_mutex);
834
835 return ret;
836}
837EXPORT_SYMBOL(drm_gem_mmap);
This page took 0.455985 seconds and 5 git commands to generate.