blob: a4c8e8fba5997883d391211219d3c38eb1e0095f [file] [log] [blame]
Eric Anholt673a3942008-07-30 12:06:12 -07001/*
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>
Hugh Dickins5949eac2011-06-27 16:18:18 -070037#include <linux/shmem_fs.h>
Dave Airlie32488772011-11-25 15:21:02 +000038#include <linux/dma-buf.h>
David Howells760285e2012-10-02 18:01:07 +010039#include <drm/drmP.h>
David Herrmann0de23972013-07-24 21:07:52 +020040#include <drm/drm_vma_manager.h>
Eric Anholt673a3942008-07-30 12:06:12 -070041
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
Jesse Barnesa2c0a972008-11-05 10:31:53 -080070/*
71 * We make up offsets for buffer objects so we can recognize them at
72 * mmap time.
73 */
Jordan Crouse05269a32010-05-27 13:40:27 -060074
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
Jesse Barnesa2c0a972008-11-05 10:31:53 -080080#define DRM_FILE_PAGE_OFFSET_START ((0xFFFFFFFFUL >> PAGE_SHIFT) + 1)
81#define DRM_FILE_PAGE_OFFSET_SIZE ((0xFFFFFFFFUL >> PAGE_SHIFT) * 16)
Jordan Crouse05269a32010-05-27 13:40:27 -060082#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
Jesse Barnesa2c0a972008-11-05 10:31:53 -080086
Eric Anholt673a3942008-07-30 12:06:12 -070087/**
88 * Initialize the GEM device fields
89 */
90
91int
92drm_gem_init(struct drm_device *dev)
93{
Jesse Barnesa2c0a972008-11-05 10:31:53 -080094 struct drm_gem_mm *mm;
95
Eric Anholt673a3942008-07-30 12:06:12 -070096 spin_lock_init(&dev->object_name_lock);
97 idr_init(&dev->object_name_idr);
Jesse Barnesa2c0a972008-11-05 10:31:53 -080098
Eric Anholt9a298b22009-03-24 12:23:04 -070099 mm = kzalloc(sizeof(struct drm_gem_mm), GFP_KERNEL);
Jesse Barnesa2c0a972008-11-05 10:31:53 -0800100 if (!mm) {
101 DRM_ERROR("out of memory\n");
102 return -ENOMEM;
103 }
104
105 dev->mm_private = mm;
David Herrmann0de23972013-07-24 21:07:52 +0200106 drm_vma_offset_manager_init(&mm->vma_manager,
107 DRM_FILE_PAGE_OFFSET_START,
108 DRM_FILE_PAGE_OFFSET_SIZE);
Jesse Barnesa2c0a972008-11-05 10:31:53 -0800109
Eric Anholt673a3942008-07-30 12:06:12 -0700110 return 0;
111}
112
Jesse Barnesa2c0a972008-11-05 10:31:53 -0800113void
114drm_gem_destroy(struct drm_device *dev)
115{
116 struct drm_gem_mm *mm = dev->mm_private;
117
David Herrmann0de23972013-07-24 21:07:52 +0200118 drm_vma_offset_manager_destroy(&mm->vma_manager);
Eric Anholt9a298b22009-03-24 12:23:04 -0700119 kfree(mm);
Jesse Barnesa2c0a972008-11-05 10:31:53 -0800120 dev->mm_private = NULL;
121}
122
Eric Anholt673a3942008-07-30 12:06:12 -0700123/**
Alan Cox62cb70112011-06-07 14:17:51 +0100124 * Initialize an already allocated GEM object of the specified size with
Daniel Vetter1d397042010-04-09 19:05:04 +0000125 * shmfs backing store.
126 */
127int drm_gem_object_init(struct drm_device *dev,
128 struct drm_gem_object *obj, size_t size)
129{
David Herrmann89c82332013-07-11 11:56:32 +0200130 struct file *filp;
Daniel Vetter1d397042010-04-09 19:05:04 +0000131
David Herrmann89c82332013-07-11 11:56:32 +0200132 filp = shmem_file_setup("drm mm object", size, VM_NORESERVE);
133 if (IS_ERR(filp))
134 return PTR_ERR(filp);
Daniel Vetter1d397042010-04-09 19:05:04 +0000135
David Herrmann89c82332013-07-11 11:56:32 +0200136 drm_gem_private_object_init(dev, obj, size);
137 obj->filp = filp;
Daniel Vetter1d397042010-04-09 19:05:04 +0000138
Daniel Vetter1d397042010-04-09 19:05:04 +0000139 return 0;
140}
141EXPORT_SYMBOL(drm_gem_object_init);
142
143/**
Alan Cox62cb70112011-06-07 14:17:51 +0100144 * 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 */
David Herrmann89c82332013-07-11 11:56:32 +0200148void drm_gem_private_object_init(struct drm_device *dev,
149 struct drm_gem_object *obj, size_t size)
Alan Cox62cb70112011-06-07 14:17:51 +0100150{
151 BUG_ON((size & (PAGE_SIZE - 1)) != 0);
152
153 obj->dev = dev;
154 obj->filp = NULL;
155
156 kref_init(&obj->refcount);
157 atomic_set(&obj->handle_count, 0);
158 obj->size = size;
Alan Cox62cb70112011-06-07 14:17:51 +0100159}
160EXPORT_SYMBOL(drm_gem_private_object_init);
161
162/**
Eric Anholt673a3942008-07-30 12:06:12 -0700163 * 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
Robert P. J. Dayb798b1f2009-06-10 12:43:49 -0700170 obj = kzalloc(sizeof(*obj), GFP_KERNEL);
Jiri Slaby845792d2009-07-13 23:20:21 +0200171 if (!obj)
172 goto free;
Eric Anholt673a3942008-07-30 12:06:12 -0700173
Daniel Vetter1d397042010-04-09 19:05:04 +0000174 if (drm_gem_object_init(dev, obj, size) != 0)
Jiri Slaby845792d2009-07-13 23:20:21 +0200175 goto free;
Eric Anholt673a3942008-07-30 12:06:12 -0700176
Eric Anholt673a3942008-07-30 12:06:12 -0700177 if (dev->driver->gem_init_object != NULL &&
178 dev->driver->gem_init_object(obj) != 0) {
Jiri Slaby845792d2009-07-13 23:20:21 +0200179 goto fput;
Eric Anholt673a3942008-07-30 12:06:12 -0700180 }
Eric Anholt673a3942008-07-30 12:06:12 -0700181 return obj;
Jiri Slaby845792d2009-07-13 23:20:21 +0200182fput:
Daniel Vetter1d397042010-04-09 19:05:04 +0000183 /* Object_init mangles the global counters - readjust them. */
Jiri Slaby845792d2009-07-13 23:20:21 +0200184 fput(obj->filp);
185free:
186 kfree(obj);
187 return NULL;
Eric Anholt673a3942008-07-30 12:06:12 -0700188}
189EXPORT_SYMBOL(drm_gem_object_alloc);
190
Dave Airlie0ff926c2012-05-20 17:31:16 +0100191static void
192drm_gem_remove_prime_handles(struct drm_gem_object *obj, struct drm_file *filp)
193{
194 if (obj->import_attach) {
Dave Airlie219b4732013-04-22 09:54:36 +1000195 drm_prime_remove_buf_handle(&filp->prime,
Dave Airlie0ff926c2012-05-20 17:31:16 +0100196 obj->import_attach->dmabuf);
197 }
198 if (obj->export_dma_buf) {
Dave Airlie219b4732013-04-22 09:54:36 +1000199 drm_prime_remove_buf_handle(&filp->prime,
Dave Airlie0ff926c2012-05-20 17:31:16 +0100200 obj->export_dma_buf);
201 }
202}
203
Eric Anholt673a3942008-07-30 12:06:12 -0700204/**
205 * Removes the mapping from handle to filp for this object.
206 */
Dave Airlieff72145b2011-02-07 12:16:14 +1000207int
Pekka Paalanena1a2d1d2009-08-23 12:40:55 +0300208drm_gem_handle_delete(struct drm_file *filp, u32 handle)
Eric Anholt673a3942008-07-30 12:06:12 -0700209{
210 struct drm_device *dev;
211 struct drm_gem_object *obj;
212
213 /* This is gross. The idr system doesn't let us try a delete and
214 * return an error code. It just spews if you fail at deleting.
215 * So, we have to grab a lock around finding the object and then
216 * doing the delete on it and dropping the refcount, or the user
217 * could race us to double-decrement the refcount and cause a
218 * use-after-free later. Given the frequency of our handle lookups,
219 * we may want to use ida for number allocation and a hash table
220 * for the pointers, anyway.
221 */
222 spin_lock(&filp->table_lock);
223
224 /* Check if we currently have a reference on the object */
225 obj = idr_find(&filp->object_idr, handle);
226 if (obj == NULL) {
227 spin_unlock(&filp->table_lock);
228 return -EINVAL;
229 }
230 dev = obj->dev;
231
232 /* Release reference and decrement refcount. */
233 idr_remove(&filp->object_idr, handle);
234 spin_unlock(&filp->table_lock);
235
Dave Airlie0ff926c2012-05-20 17:31:16 +0100236 drm_gem_remove_prime_handles(obj, filp);
Dave Airlie32488772011-11-25 15:21:02 +0000237
Ben Skeggs304eda32011-06-09 00:24:59 +0000238 if (dev->driver->gem_close_object)
239 dev->driver->gem_close_object(obj, filp);
Luca Barbieribc9025b2010-02-09 05:49:12 +0000240 drm_gem_object_handle_unreference_unlocked(obj);
Eric Anholt673a3942008-07-30 12:06:12 -0700241
242 return 0;
243}
Dave Airlieff72145b2011-02-07 12:16:14 +1000244EXPORT_SYMBOL(drm_gem_handle_delete);
Eric Anholt673a3942008-07-30 12:06:12 -0700245
246/**
Daniel Vetter43387b32013-07-16 09:12:04 +0200247 * drm_gem_dumb_destroy - dumb fb callback helper for gem based drivers
248 *
249 * This implements the ->dumb_destroy kms driver callback for drivers which use
250 * gem to manage their backing storage.
251 */
252int drm_gem_dumb_destroy(struct drm_file *file,
253 struct drm_device *dev,
254 uint32_t handle)
255{
256 return drm_gem_handle_delete(file, handle);
257}
258EXPORT_SYMBOL(drm_gem_dumb_destroy);
259
260/**
Eric Anholt673a3942008-07-30 12:06:12 -0700261 * Create a handle for this object. This adds a handle reference
262 * to the object, which includes a regular reference count. Callers
263 * will likely want to dereference the object afterwards.
264 */
265int
266drm_gem_handle_create(struct drm_file *file_priv,
267 struct drm_gem_object *obj,
Pekka Paalanena1a2d1d2009-08-23 12:40:55 +0300268 u32 *handlep)
Eric Anholt673a3942008-07-30 12:06:12 -0700269{
Ben Skeggs304eda32011-06-09 00:24:59 +0000270 struct drm_device *dev = obj->dev;
271 int ret;
Eric Anholt673a3942008-07-30 12:06:12 -0700272
273 /*
Tejun Heo2e928812013-02-27 17:04:08 -0800274 * Get the user-visible handle using idr. Preload and perform
275 * allocation under our spinlock.
Eric Anholt673a3942008-07-30 12:06:12 -0700276 */
Tejun Heo2e928812013-02-27 17:04:08 -0800277 idr_preload(GFP_KERNEL);
Eric Anholt673a3942008-07-30 12:06:12 -0700278 spin_lock(&file_priv->table_lock);
Tejun Heo2e928812013-02-27 17:04:08 -0800279
280 ret = idr_alloc(&file_priv->object_idr, obj, 1, 0, GFP_NOWAIT);
281
Eric Anholt673a3942008-07-30 12:06:12 -0700282 spin_unlock(&file_priv->table_lock);
Tejun Heo2e928812013-02-27 17:04:08 -0800283 idr_preload_end();
284 if (ret < 0)
Eric Anholt673a3942008-07-30 12:06:12 -0700285 return ret;
Tejun Heo2e928812013-02-27 17:04:08 -0800286 *handlep = ret;
Eric Anholt673a3942008-07-30 12:06:12 -0700287
288 drm_gem_object_handle_reference(obj);
Ben Skeggs304eda32011-06-09 00:24:59 +0000289
290 if (dev->driver->gem_open_object) {
291 ret = dev->driver->gem_open_object(obj, file_priv);
292 if (ret) {
293 drm_gem_handle_delete(file_priv, *handlep);
294 return ret;
295 }
296 }
297
Eric Anholt673a3942008-07-30 12:06:12 -0700298 return 0;
299}
300EXPORT_SYMBOL(drm_gem_handle_create);
301
Rob Clark75ef8b32011-08-10 08:09:07 -0500302
303/**
304 * drm_gem_free_mmap_offset - release a fake mmap offset for an object
305 * @obj: obj in question
306 *
307 * This routine frees fake offsets allocated by drm_gem_create_mmap_offset().
308 */
309void
310drm_gem_free_mmap_offset(struct drm_gem_object *obj)
311{
312 struct drm_device *dev = obj->dev;
313 struct drm_gem_mm *mm = dev->mm_private;
Rob Clark75ef8b32011-08-10 08:09:07 -0500314
David Herrmann0de23972013-07-24 21:07:52 +0200315 drm_vma_offset_remove(&mm->vma_manager, &obj->vma_node);
Rob Clark75ef8b32011-08-10 08:09:07 -0500316}
317EXPORT_SYMBOL(drm_gem_free_mmap_offset);
318
319/**
Rob Clark367bbd42013-08-07 13:41:23 -0400320 * drm_gem_create_mmap_offset_size - create a fake mmap offset for an object
321 * @obj: obj in question
322 * @size: the virtual size
323 *
324 * GEM memory mapping works by handing back to userspace a fake mmap offset
325 * it can use in a subsequent mmap(2) call. The DRM core code then looks
326 * up the object based on the offset and sets up the various memory mapping
327 * structures.
328 *
329 * This routine allocates and attaches a fake offset for @obj, in cases where
330 * the virtual size differs from the physical size (ie. obj->size). Otherwise
331 * just use drm_gem_create_mmap_offset().
332 */
333int
334drm_gem_create_mmap_offset_size(struct drm_gem_object *obj, size_t size)
335{
336 struct drm_device *dev = obj->dev;
337 struct drm_gem_mm *mm = dev->mm_private;
338
339 return drm_vma_offset_add(&mm->vma_manager, &obj->vma_node,
340 size / PAGE_SIZE);
341}
342EXPORT_SYMBOL(drm_gem_create_mmap_offset_size);
343
344/**
Rob Clark75ef8b32011-08-10 08:09:07 -0500345 * drm_gem_create_mmap_offset - create a fake mmap offset for an object
346 * @obj: obj in question
347 *
348 * GEM memory mapping works by handing back to userspace a fake mmap offset
349 * it can use in a subsequent mmap(2) call. The DRM core code then looks
350 * up the object based on the offset and sets up the various memory mapping
351 * structures.
352 *
353 * This routine allocates and attaches a fake offset for @obj.
354 */
Rob Clark367bbd42013-08-07 13:41:23 -0400355int drm_gem_create_mmap_offset(struct drm_gem_object *obj)
Rob Clark75ef8b32011-08-10 08:09:07 -0500356{
Rob Clark367bbd42013-08-07 13:41:23 -0400357 return drm_gem_create_mmap_offset_size(obj, obj->size);
Rob Clark75ef8b32011-08-10 08:09:07 -0500358}
359EXPORT_SYMBOL(drm_gem_create_mmap_offset);
360
Rob Clarkbcc5c9d2013-08-07 13:41:24 -0400361/**
362 * drm_gem_get_pages - helper to allocate backing pages for a GEM object
363 * from shmem
364 * @obj: obj in question
365 * @gfpmask: gfp mask of requested pages
366 */
367struct page **drm_gem_get_pages(struct drm_gem_object *obj, gfp_t gfpmask)
368{
369 struct inode *inode;
370 struct address_space *mapping;
371 struct page *p, **pages;
372 int i, npages;
373
374 /* This is the shared memory object that backs the GEM resource */
375 inode = file_inode(obj->filp);
376 mapping = inode->i_mapping;
377
378 /* We already BUG_ON() for non-page-aligned sizes in
379 * drm_gem_object_init(), so we should never hit this unless
380 * driver author is doing something really wrong:
381 */
382 WARN_ON((obj->size & (PAGE_SIZE - 1)) != 0);
383
384 npages = obj->size >> PAGE_SHIFT;
385
386 pages = drm_malloc_ab(npages, sizeof(struct page *));
387 if (pages == NULL)
388 return ERR_PTR(-ENOMEM);
389
390 gfpmask |= mapping_gfp_mask(mapping);
391
392 for (i = 0; i < npages; i++) {
393 p = shmem_read_mapping_page_gfp(mapping, i, gfpmask);
394 if (IS_ERR(p))
395 goto fail;
396 pages[i] = p;
397
398 /* There is a hypothetical issue w/ drivers that require
399 * buffer memory in the low 4GB.. if the pages are un-
400 * pinned, and swapped out, they can end up swapped back
401 * in above 4GB. If pages are already in memory, then
402 * shmem_read_mapping_page_gfp will ignore the gfpmask,
403 * even if the already in-memory page disobeys the mask.
404 *
405 * It is only a theoretical issue today, because none of
406 * the devices with this limitation can be populated with
407 * enough memory to trigger the issue. But this BUG_ON()
408 * is here as a reminder in case the problem with
409 * shmem_read_mapping_page_gfp() isn't solved by the time
410 * it does become a real issue.
411 *
412 * See this thread: http://lkml.org/lkml/2011/7/11/238
413 */
414 BUG_ON((gfpmask & __GFP_DMA32) &&
415 (page_to_pfn(p) >= 0x00100000UL));
416 }
417
418 return pages;
419
420fail:
421 while (i--)
422 page_cache_release(pages[i]);
423
424 drm_free_large(pages);
425 return ERR_CAST(p);
426}
427EXPORT_SYMBOL(drm_gem_get_pages);
428
429/**
430 * drm_gem_put_pages - helper to free backing pages for a GEM object
431 * @obj: obj in question
432 * @pages: pages to free
433 * @dirty: if true, pages will be marked as dirty
434 * @accessed: if true, the pages will be marked as accessed
435 */
436void drm_gem_put_pages(struct drm_gem_object *obj, struct page **pages,
437 bool dirty, bool accessed)
438{
439 int i, npages;
440
441 /* We already BUG_ON() for non-page-aligned sizes in
442 * drm_gem_object_init(), so we should never hit this unless
443 * driver author is doing something really wrong:
444 */
445 WARN_ON((obj->size & (PAGE_SIZE - 1)) != 0);
446
447 npages = obj->size >> PAGE_SHIFT;
448
449 for (i = 0; i < npages; i++) {
450 if (dirty)
451 set_page_dirty(pages[i]);
452
453 if (accessed)
454 mark_page_accessed(pages[i]);
455
456 /* Undo the reference we took when populating the table */
457 page_cache_release(pages[i]);
458 }
459
460 drm_free_large(pages);
461}
462EXPORT_SYMBOL(drm_gem_put_pages);
463
Eric Anholt673a3942008-07-30 12:06:12 -0700464/** Returns a reference to the object named by the handle. */
465struct drm_gem_object *
466drm_gem_object_lookup(struct drm_device *dev, struct drm_file *filp,
Pekka Paalanena1a2d1d2009-08-23 12:40:55 +0300467 u32 handle)
Eric Anholt673a3942008-07-30 12:06:12 -0700468{
469 struct drm_gem_object *obj;
470
471 spin_lock(&filp->table_lock);
472
473 /* Check if we currently have a reference on the object */
474 obj = idr_find(&filp->object_idr, handle);
475 if (obj == NULL) {
476 spin_unlock(&filp->table_lock);
477 return NULL;
478 }
479
480 drm_gem_object_reference(obj);
481
482 spin_unlock(&filp->table_lock);
483
484 return obj;
485}
486EXPORT_SYMBOL(drm_gem_object_lookup);
487
488/**
489 * Releases the handle to an mm object.
490 */
491int
492drm_gem_close_ioctl(struct drm_device *dev, void *data,
493 struct drm_file *file_priv)
494{
495 struct drm_gem_close *args = data;
496 int ret;
497
498 if (!(dev->driver->driver_features & DRIVER_GEM))
499 return -ENODEV;
500
501 ret = drm_gem_handle_delete(file_priv, args->handle);
502
503 return ret;
504}
505
506/**
507 * Create a global name for an object, returning the name.
508 *
509 * Note that the name does not hold a reference; when the object
510 * is freed, the name goes away.
511 */
512int
513drm_gem_flink_ioctl(struct drm_device *dev, void *data,
514 struct drm_file *file_priv)
515{
516 struct drm_gem_flink *args = data;
517 struct drm_gem_object *obj;
518 int ret;
519
520 if (!(dev->driver->driver_features & DRIVER_GEM))
521 return -ENODEV;
522
523 obj = drm_gem_object_lookup(dev, file_priv, args->handle);
524 if (obj == NULL)
Chris Wilsonbf79cb92010-08-04 14:19:46 +0100525 return -ENOENT;
Eric Anholt673a3942008-07-30 12:06:12 -0700526
Tejun Heo2e928812013-02-27 17:04:08 -0800527 idr_preload(GFP_KERNEL);
Eric Anholt673a3942008-07-30 12:06:12 -0700528 spin_lock(&dev->object_name_lock);
Chris Wilson8d59bae2009-02-11 14:26:28 +0000529 if (!obj->name) {
Tejun Heo2e928812013-02-27 17:04:08 -0800530 ret = idr_alloc(&dev->object_name_idr, obj, 1, 0, GFP_NOWAIT);
Tejun Heo2e928812013-02-27 17:04:08 -0800531 if (ret < 0)
Chris Wilson8d59bae2009-02-11 14:26:28 +0000532 goto err;
YoungJun Cho2e07fb22013-06-27 08:58:33 +0900533
534 obj->name = ret;
Chris Wilson8d59bae2009-02-11 14:26:28 +0000535
536 /* Allocate a reference for the name table. */
537 drm_gem_object_reference(obj);
Eric Anholt673a3942008-07-30 12:06:12 -0700538 }
Chris Wilson3e49c4f2009-02-09 11:31:41 +0000539
YoungJun Cho2e07fb22013-06-27 08:58:33 +0900540 args->name = (uint64_t) obj->name;
541 ret = 0;
542
Chris Wilson3e49c4f2009-02-09 11:31:41 +0000543err:
YoungJun Cho2e07fb22013-06-27 08:58:33 +0900544 spin_unlock(&dev->object_name_lock);
545 idr_preload_end();
Luca Barbieribc9025b2010-02-09 05:49:12 +0000546 drm_gem_object_unreference_unlocked(obj);
Chris Wilson3e49c4f2009-02-09 11:31:41 +0000547 return ret;
Eric Anholt673a3942008-07-30 12:06:12 -0700548}
549
550/**
551 * Open an object using the global name, returning a handle and the size.
552 *
553 * This handle (of course) holds a reference to the object, so the object
554 * will not go away until the handle is deleted.
555 */
556int
557drm_gem_open_ioctl(struct drm_device *dev, void *data,
558 struct drm_file *file_priv)
559{
560 struct drm_gem_open *args = data;
561 struct drm_gem_object *obj;
562 int ret;
Pekka Paalanena1a2d1d2009-08-23 12:40:55 +0300563 u32 handle;
Eric Anholt673a3942008-07-30 12:06:12 -0700564
565 if (!(dev->driver->driver_features & DRIVER_GEM))
566 return -ENODEV;
567
568 spin_lock(&dev->object_name_lock);
569 obj = idr_find(&dev->object_name_idr, (int) args->name);
570 if (obj)
571 drm_gem_object_reference(obj);
572 spin_unlock(&dev->object_name_lock);
573 if (!obj)
574 return -ENOENT;
575
576 ret = drm_gem_handle_create(file_priv, obj, &handle);
Luca Barbieribc9025b2010-02-09 05:49:12 +0000577 drm_gem_object_unreference_unlocked(obj);
Eric Anholt673a3942008-07-30 12:06:12 -0700578 if (ret)
579 return ret;
580
581 args->handle = handle;
582 args->size = obj->size;
583
584 return 0;
585}
586
587/**
588 * Called at device open time, sets up the structure for handling refcounting
589 * of mm objects.
590 */
591void
592drm_gem_open(struct drm_device *dev, struct drm_file *file_private)
593{
594 idr_init(&file_private->object_idr);
595 spin_lock_init(&file_private->table_lock);
596}
597
598/**
599 * Called at device close to release the file's
600 * handle references on objects.
601 */
602static int
603drm_gem_object_release_handle(int id, void *ptr, void *data)
604{
Ben Skeggs304eda32011-06-09 00:24:59 +0000605 struct drm_file *file_priv = data;
Eric Anholt673a3942008-07-30 12:06:12 -0700606 struct drm_gem_object *obj = ptr;
Ben Skeggs304eda32011-06-09 00:24:59 +0000607 struct drm_device *dev = obj->dev;
608
Dave Airlie0ff926c2012-05-20 17:31:16 +0100609 drm_gem_remove_prime_handles(obj, file_priv);
Dave Airlie32488772011-11-25 15:21:02 +0000610
Ben Skeggs304eda32011-06-09 00:24:59 +0000611 if (dev->driver->gem_close_object)
612 dev->driver->gem_close_object(obj, file_priv);
Eric Anholt673a3942008-07-30 12:06:12 -0700613
Luca Barbieribc9025b2010-02-09 05:49:12 +0000614 drm_gem_object_handle_unreference_unlocked(obj);
Eric Anholt673a3942008-07-30 12:06:12 -0700615
616 return 0;
617}
618
619/**
620 * Called at close time when the filp is going away.
621 *
622 * Releases any remaining references on objects by this filp.
623 */
624void
625drm_gem_release(struct drm_device *dev, struct drm_file *file_private)
626{
Eric Anholt673a3942008-07-30 12:06:12 -0700627 idr_for_each(&file_private->object_idr,
Ben Skeggs304eda32011-06-09 00:24:59 +0000628 &drm_gem_object_release_handle, file_private);
Eric Anholt673a3942008-07-30 12:06:12 -0700629 idr_destroy(&file_private->object_idr);
Eric Anholt673a3942008-07-30 12:06:12 -0700630}
631
Daniel Vetterfd632aa2010-04-09 19:05:05 +0000632void
633drm_gem_object_release(struct drm_gem_object *obj)
Luca Barbieric3ae90c2010-02-09 05:49:11 +0000634{
Alan Cox62cb70112011-06-07 14:17:51 +0100635 if (obj->filp)
636 fput(obj->filp);
Luca Barbieric3ae90c2010-02-09 05:49:11 +0000637}
Daniel Vetterfd632aa2010-04-09 19:05:05 +0000638EXPORT_SYMBOL(drm_gem_object_release);
Luca Barbieric3ae90c2010-02-09 05:49:11 +0000639
Eric Anholt673a3942008-07-30 12:06:12 -0700640/**
641 * Called after the last reference to the object has been lost.
Luca Barbieric3ae90c2010-02-09 05:49:11 +0000642 * Must be called holding struct_ mutex
Eric Anholt673a3942008-07-30 12:06:12 -0700643 *
644 * Frees the object
645 */
646void
647drm_gem_object_free(struct kref *kref)
648{
649 struct drm_gem_object *obj = (struct drm_gem_object *) kref;
650 struct drm_device *dev = obj->dev;
651
652 BUG_ON(!mutex_is_locked(&dev->struct_mutex));
653
654 if (dev->driver->gem_free_object != NULL)
655 dev->driver->gem_free_object(obj);
Eric Anholt673a3942008-07-30 12:06:12 -0700656}
657EXPORT_SYMBOL(drm_gem_object_free);
658
Luca Barbieric3ae90c2010-02-09 05:49:11 +0000659static void drm_gem_object_ref_bug(struct kref *list_kref)
660{
661 BUG();
662}
663
664/**
Eric Anholt673a3942008-07-30 12:06:12 -0700665 * Called after the last handle to the object has been closed
666 *
667 * Removes any name for the object. Note that this must be
668 * called before drm_gem_object_free or we'll be touching
669 * freed memory
670 */
Dave Airlie29d08b32010-09-27 16:17:17 +1000671void drm_gem_object_handle_free(struct drm_gem_object *obj)
Eric Anholt673a3942008-07-30 12:06:12 -0700672{
Eric Anholt673a3942008-07-30 12:06:12 -0700673 struct drm_device *dev = obj->dev;
674
675 /* Remove any name for this object */
676 spin_lock(&dev->object_name_lock);
677 if (obj->name) {
678 idr_remove(&dev->object_name_idr, obj->name);
Chris Wilson8d59bae2009-02-11 14:26:28 +0000679 obj->name = 0;
Eric Anholt673a3942008-07-30 12:06:12 -0700680 spin_unlock(&dev->object_name_lock);
681 /*
682 * The object name held a reference to this object, drop
683 * that now.
Luca Barbieric3ae90c2010-02-09 05:49:11 +0000684 *
685 * This cannot be the last reference, since the handle holds one too.
Eric Anholt673a3942008-07-30 12:06:12 -0700686 */
Luca Barbieric3ae90c2010-02-09 05:49:11 +0000687 kref_put(&obj->refcount, drm_gem_object_ref_bug);
Eric Anholt673a3942008-07-30 12:06:12 -0700688 } else
689 spin_unlock(&dev->object_name_lock);
690
691}
692EXPORT_SYMBOL(drm_gem_object_handle_free);
693
Jesse Barnesab00b3e2009-02-11 14:01:46 -0800694void drm_gem_vm_open(struct vm_area_struct *vma)
695{
696 struct drm_gem_object *obj = vma->vm_private_data;
697
698 drm_gem_object_reference(obj);
Chris Wilson31dfbc92010-09-27 21:28:30 +0100699
700 mutex_lock(&obj->dev->struct_mutex);
Rob Clarkb06d66b2012-05-01 11:04:51 -0500701 drm_vm_open_locked(obj->dev, vma);
Chris Wilson31dfbc92010-09-27 21:28:30 +0100702 mutex_unlock(&obj->dev->struct_mutex);
Jesse Barnesab00b3e2009-02-11 14:01:46 -0800703}
704EXPORT_SYMBOL(drm_gem_vm_open);
705
706void drm_gem_vm_close(struct vm_area_struct *vma)
707{
708 struct drm_gem_object *obj = vma->vm_private_data;
Chris Wilsonb74ad5a2011-03-17 22:33:33 +0000709 struct drm_device *dev = obj->dev;
Jesse Barnesab00b3e2009-02-11 14:01:46 -0800710
Chris Wilsonb74ad5a2011-03-17 22:33:33 +0000711 mutex_lock(&dev->struct_mutex);
Rob Clarkb06d66b2012-05-01 11:04:51 -0500712 drm_vm_close_locked(obj->dev, vma);
Chris Wilson31dfbc92010-09-27 21:28:30 +0100713 drm_gem_object_unreference(obj);
Chris Wilsonb74ad5a2011-03-17 22:33:33 +0000714 mutex_unlock(&dev->struct_mutex);
Jesse Barnesab00b3e2009-02-11 14:01:46 -0800715}
716EXPORT_SYMBOL(drm_gem_vm_close);
717
Laurent Pinchart1c5aafa2013-04-16 14:14:52 +0200718/**
719 * drm_gem_mmap_obj - memory map a GEM object
720 * @obj: the GEM object to map
721 * @obj_size: the object size to be mapped, in bytes
722 * @vma: VMA for the area to be mapped
723 *
724 * Set up the VMA to prepare mapping of the GEM object using the gem_vm_ops
725 * provided by the driver. Depending on their requirements, drivers can either
726 * provide a fault handler in their gem_vm_ops (in which case any accesses to
727 * the object will be trapped, to perform migration, GTT binding, surface
728 * register allocation, or performance monitoring), or mmap the buffer memory
729 * synchronously after calling drm_gem_mmap_obj.
730 *
731 * This function is mainly intended to implement the DMABUF mmap operation, when
732 * the GEM object is not looked up based on its fake offset. To implement the
733 * DRM mmap operation, drivers should use the drm_gem_mmap() function.
734 *
YoungJun Cho4368dd82013-06-27 08:39:58 +0900735 * NOTE: This function has to be protected with dev->struct_mutex
736 *
Laurent Pinchart1c5aafa2013-04-16 14:14:52 +0200737 * Return 0 or success or -EINVAL if the object size is smaller than the VMA
738 * size, or if no gem_vm_ops are provided.
739 */
740int drm_gem_mmap_obj(struct drm_gem_object *obj, unsigned long obj_size,
741 struct vm_area_struct *vma)
742{
743 struct drm_device *dev = obj->dev;
744
YoungJun Cho4368dd82013-06-27 08:39:58 +0900745 lockdep_assert_held(&dev->struct_mutex);
746
Laurent Pinchart1c5aafa2013-04-16 14:14:52 +0200747 /* Check for valid size. */
748 if (obj_size < vma->vm_end - vma->vm_start)
749 return -EINVAL;
750
751 if (!dev->driver->gem_vm_ops)
752 return -EINVAL;
753
754 vma->vm_flags |= VM_IO | VM_PFNMAP | VM_DONTEXPAND | VM_DONTDUMP;
755 vma->vm_ops = dev->driver->gem_vm_ops;
756 vma->vm_private_data = obj;
757 vma->vm_page_prot = pgprot_writecombine(vm_get_page_prot(vma->vm_flags));
758
759 /* Take a ref for this mapping of the object, so that the fault
760 * handler can dereference the mmap offset's pointer to the object.
761 * This reference is cleaned up by the corresponding vm_close
762 * (which should happen whether the vma was created by this call, or
763 * by a vm_open due to mremap or partial unmap or whatever).
764 */
765 drm_gem_object_reference(obj);
766
767 drm_vm_open_locked(dev, vma);
768 return 0;
769}
770EXPORT_SYMBOL(drm_gem_mmap_obj);
Jesse Barnesab00b3e2009-02-11 14:01:46 -0800771
Jesse Barnesa2c0a972008-11-05 10:31:53 -0800772/**
773 * drm_gem_mmap - memory map routine for GEM objects
774 * @filp: DRM file pointer
775 * @vma: VMA for the area to be mapped
776 *
777 * If a driver supports GEM object mapping, mmap calls on the DRM file
778 * descriptor will end up here.
779 *
Laurent Pinchart1c5aafa2013-04-16 14:14:52 +0200780 * Look up the GEM object based on the offset passed in (vma->vm_pgoff will
Jesse Barnesa2c0a972008-11-05 10:31:53 -0800781 * contain the fake offset we created when the GTT map ioctl was called on
Laurent Pinchart1c5aafa2013-04-16 14:14:52 +0200782 * the object) and map it with a call to drm_gem_mmap_obj().
Jesse Barnesa2c0a972008-11-05 10:31:53 -0800783 */
784int drm_gem_mmap(struct file *filp, struct vm_area_struct *vma)
785{
786 struct drm_file *priv = filp->private_data;
787 struct drm_device *dev = priv->minor->dev;
788 struct drm_gem_mm *mm = dev->mm_private;
David Herrmann0de23972013-07-24 21:07:52 +0200789 struct drm_gem_object *obj;
790 struct drm_vma_offset_node *node;
Jesse Barnesa2c0a972008-11-05 10:31:53 -0800791 int ret = 0;
792
Dave Airlie2c07a212012-02-20 14:18:07 +0000793 if (drm_device_is_unplugged(dev))
794 return -ENODEV;
795
Jesse Barnesa2c0a972008-11-05 10:31:53 -0800796 mutex_lock(&dev->struct_mutex);
797
David Herrmann0de23972013-07-24 21:07:52 +0200798 node = drm_vma_offset_exact_lookup(&mm->vma_manager, vma->vm_pgoff,
799 vma_pages(vma));
800 if (!node) {
Jesse Barnesa2c0a972008-11-05 10:31:53 -0800801 mutex_unlock(&dev->struct_mutex);
802 return drm_mmap(filp, vma);
803 }
804
David Herrmann0de23972013-07-24 21:07:52 +0200805 obj = container_of(node, struct drm_gem_object, vma_node);
David Herrmannaed2c032013-07-26 12:09:32 +0200806 ret = drm_gem_mmap_obj(obj, drm_vma_node_size(node) << PAGE_SHIFT, vma);
Jesse Barnesa2c0a972008-11-05 10:31:53 -0800807
Jesse Barnesa2c0a972008-11-05 10:31:53 -0800808 mutex_unlock(&dev->struct_mutex);
809
810 return ret;
811}
812EXPORT_SYMBOL(drm_gem_mmap);