blob: d47aa774d64b3d1fe7e20870f3fc06052494da01 [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
Daniel Vettercd4f0132013-08-15 00:02:44 +020096 mutex_init(&dev->object_name_lock);
Eric Anholt673a3942008-07-30 12:06:12 -070097 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);
Daniel Vettera8e11d12013-08-15 00:02:37 +0200157 obj->handle_count = 0;
Alan Cox62cb70112011-06-07 14:17:51 +0100158 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
Daniel Vetter36da5902013-08-15 00:02:34 +0200204static 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 */
Daniel Vetter36da5902013-08-15 00:02:34 +0200221 if (obj->name) {
222 idr_remove(&dev->object_name_idr, obj->name);
223 obj->name = 0;
Daniel Vetter36da5902013-08-15 00:02:34 +0200224 /*
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);
Daniel Vettera8e11d12013-08-15 00:02:37 +0200231 }
Daniel Vetter36da5902013-08-15 00:02:34 +0200232}
233
Daniel Vetterbecee2a2013-08-15 00:02:39 +0200234static void
Daniel Vetter36da5902013-08-15 00:02:34 +0200235drm_gem_object_handle_unreference_unlocked(struct drm_gem_object *obj)
236{
Daniel Vettera8e11d12013-08-15 00:02:37 +0200237 if (WARN_ON(obj->handle_count == 0))
Daniel Vetter36da5902013-08-15 00:02:34 +0200238 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
Daniel Vettercd4f0132013-08-15 00:02:44 +0200246 mutex_lock(&obj->dev->object_name_lock);
Daniel Vettera8e11d12013-08-15 00:02:37 +0200247 if (--obj->handle_count == 0)
Daniel Vetter36da5902013-08-15 00:02:34 +0200248 drm_gem_object_handle_free(obj);
Daniel Vettercd4f0132013-08-15 00:02:44 +0200249 mutex_unlock(&obj->dev->object_name_lock);
Daniel Vettera8e11d12013-08-15 00:02:37 +0200250
Daniel Vetter36da5902013-08-15 00:02:34 +0200251 drm_gem_object_unreference_unlocked(obj);
252}
253
Eric Anholt673a3942008-07-30 12:06:12 -0700254/**
255 * Removes the mapping from handle to filp for this object.
256 */
Dave Airlieff72145b2011-02-07 12:16:14 +1000257int
Pekka Paalanena1a2d1d2009-08-23 12:40:55 +0300258drm_gem_handle_delete(struct drm_file *filp, u32 handle)
Eric Anholt673a3942008-07-30 12:06:12 -0700259{
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
Dave Airlie0ff926c2012-05-20 17:31:16 +0100286 drm_gem_remove_prime_handles(obj, filp);
Dave Airlie32488772011-11-25 15:21:02 +0000287
Ben Skeggs304eda32011-06-09 00:24:59 +0000288 if (dev->driver->gem_close_object)
289 dev->driver->gem_close_object(obj, filp);
Luca Barbieribc9025b2010-02-09 05:49:12 +0000290 drm_gem_object_handle_unreference_unlocked(obj);
Eric Anholt673a3942008-07-30 12:06:12 -0700291
292 return 0;
293}
Dave Airlieff72145b2011-02-07 12:16:14 +1000294EXPORT_SYMBOL(drm_gem_handle_delete);
Eric Anholt673a3942008-07-30 12:06:12 -0700295
296/**
Daniel Vetter43387b32013-07-16 09:12:04 +0200297 * 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
310/**
Daniel Vetter20228c42013-08-15 00:02:45 +0200311 * drm_gem_handle_create_tail - internal functions to create a handle
312 *
313 * This expects the dev->object_name_lock to be held already and will drop it
314 * before returning. Used to avoid races in establishing new handles when
315 * importing an object from either an flink name or a dma-buf.
Eric Anholt673a3942008-07-30 12:06:12 -0700316 */
317int
Daniel Vetter20228c42013-08-15 00:02:45 +0200318drm_gem_handle_create_tail(struct drm_file *file_priv,
319 struct drm_gem_object *obj,
320 u32 *handlep)
Eric Anholt673a3942008-07-30 12:06:12 -0700321{
Ben Skeggs304eda32011-06-09 00:24:59 +0000322 struct drm_device *dev = obj->dev;
323 int ret;
Eric Anholt673a3942008-07-30 12:06:12 -0700324
Daniel Vetter20228c42013-08-15 00:02:45 +0200325 WARN_ON(!mutex_is_locked(&dev->object_name_lock));
326
Eric Anholt673a3942008-07-30 12:06:12 -0700327 /*
Tejun Heo2e928812013-02-27 17:04:08 -0800328 * Get the user-visible handle using idr. Preload and perform
329 * allocation under our spinlock.
Eric Anholt673a3942008-07-30 12:06:12 -0700330 */
Tejun Heo2e928812013-02-27 17:04:08 -0800331 idr_preload(GFP_KERNEL);
Eric Anholt673a3942008-07-30 12:06:12 -0700332 spin_lock(&file_priv->table_lock);
Tejun Heo2e928812013-02-27 17:04:08 -0800333
334 ret = idr_alloc(&file_priv->object_idr, obj, 1, 0, GFP_NOWAIT);
Daniel Vettera8e11d12013-08-15 00:02:37 +0200335 drm_gem_object_reference(obj);
336 obj->handle_count++;
Eric Anholt673a3942008-07-30 12:06:12 -0700337 spin_unlock(&file_priv->table_lock);
Tejun Heo2e928812013-02-27 17:04:08 -0800338 idr_preload_end();
Daniel Vettercd4f0132013-08-15 00:02:44 +0200339 mutex_unlock(&dev->object_name_lock);
Daniel Vettera8e11d12013-08-15 00:02:37 +0200340 if (ret < 0) {
341 drm_gem_object_handle_unreference_unlocked(obj);
Eric Anholt673a3942008-07-30 12:06:12 -0700342 return ret;
Daniel Vettera8e11d12013-08-15 00:02:37 +0200343 }
Tejun Heo2e928812013-02-27 17:04:08 -0800344 *handlep = ret;
Eric Anholt673a3942008-07-30 12:06:12 -0700345
Ben Skeggs304eda32011-06-09 00:24:59 +0000346
347 if (dev->driver->gem_open_object) {
348 ret = dev->driver->gem_open_object(obj, file_priv);
349 if (ret) {
350 drm_gem_handle_delete(file_priv, *handlep);
351 return ret;
352 }
353 }
354
Eric Anholt673a3942008-07-30 12:06:12 -0700355 return 0;
356}
Daniel Vetter20228c42013-08-15 00:02:45 +0200357
358/**
359 * Create a handle for this object. This adds a handle reference
360 * to the object, which includes a regular reference count. Callers
361 * will likely want to dereference the object afterwards.
362 */
363int
364drm_gem_handle_create(struct drm_file *file_priv,
365 struct drm_gem_object *obj,
366 u32 *handlep)
367{
368 mutex_lock(&obj->dev->object_name_lock);
369
370 return drm_gem_handle_create_tail(file_priv, obj, handlep);
371}
Eric Anholt673a3942008-07-30 12:06:12 -0700372EXPORT_SYMBOL(drm_gem_handle_create);
373
Rob Clark75ef8b32011-08-10 08:09:07 -0500374
375/**
376 * drm_gem_free_mmap_offset - release a fake mmap offset for an object
377 * @obj: obj in question
378 *
379 * This routine frees fake offsets allocated by drm_gem_create_mmap_offset().
380 */
381void
382drm_gem_free_mmap_offset(struct drm_gem_object *obj)
383{
384 struct drm_device *dev = obj->dev;
385 struct drm_gem_mm *mm = dev->mm_private;
Rob Clark75ef8b32011-08-10 08:09:07 -0500386
David Herrmann0de23972013-07-24 21:07:52 +0200387 drm_vma_offset_remove(&mm->vma_manager, &obj->vma_node);
Rob Clark75ef8b32011-08-10 08:09:07 -0500388}
389EXPORT_SYMBOL(drm_gem_free_mmap_offset);
390
391/**
Rob Clark367bbd42013-08-07 13:41:23 -0400392 * drm_gem_create_mmap_offset_size - create a fake mmap offset for an object
393 * @obj: obj in question
394 * @size: the virtual size
395 *
396 * GEM memory mapping works by handing back to userspace a fake mmap offset
397 * it can use in a subsequent mmap(2) call. The DRM core code then looks
398 * up the object based on the offset and sets up the various memory mapping
399 * structures.
400 *
401 * This routine allocates and attaches a fake offset for @obj, in cases where
402 * the virtual size differs from the physical size (ie. obj->size). Otherwise
403 * just use drm_gem_create_mmap_offset().
404 */
405int
406drm_gem_create_mmap_offset_size(struct drm_gem_object *obj, size_t size)
407{
408 struct drm_device *dev = obj->dev;
409 struct drm_gem_mm *mm = dev->mm_private;
410
411 return drm_vma_offset_add(&mm->vma_manager, &obj->vma_node,
412 size / PAGE_SIZE);
413}
414EXPORT_SYMBOL(drm_gem_create_mmap_offset_size);
415
416/**
Rob Clark75ef8b32011-08-10 08:09:07 -0500417 * drm_gem_create_mmap_offset - create a fake mmap offset for an object
418 * @obj: obj in question
419 *
420 * GEM memory mapping works by handing back to userspace a fake mmap offset
421 * it can use in a subsequent mmap(2) call. The DRM core code then looks
422 * up the object based on the offset and sets up the various memory mapping
423 * structures.
424 *
425 * This routine allocates and attaches a fake offset for @obj.
426 */
Rob Clark367bbd42013-08-07 13:41:23 -0400427int drm_gem_create_mmap_offset(struct drm_gem_object *obj)
Rob Clark75ef8b32011-08-10 08:09:07 -0500428{
Rob Clark367bbd42013-08-07 13:41:23 -0400429 return drm_gem_create_mmap_offset_size(obj, obj->size);
Rob Clark75ef8b32011-08-10 08:09:07 -0500430}
431EXPORT_SYMBOL(drm_gem_create_mmap_offset);
432
Rob Clarkbcc5c9d2013-08-07 13:41:24 -0400433/**
434 * drm_gem_get_pages - helper to allocate backing pages for a GEM object
435 * from shmem
436 * @obj: obj in question
437 * @gfpmask: gfp mask of requested pages
438 */
439struct page **drm_gem_get_pages(struct drm_gem_object *obj, gfp_t gfpmask)
440{
441 struct inode *inode;
442 struct address_space *mapping;
443 struct page *p, **pages;
444 int i, npages;
445
446 /* This is the shared memory object that backs the GEM resource */
447 inode = file_inode(obj->filp);
448 mapping = inode->i_mapping;
449
450 /* We already BUG_ON() for non-page-aligned sizes in
451 * drm_gem_object_init(), so we should never hit this unless
452 * driver author is doing something really wrong:
453 */
454 WARN_ON((obj->size & (PAGE_SIZE - 1)) != 0);
455
456 npages = obj->size >> PAGE_SHIFT;
457
458 pages = drm_malloc_ab(npages, sizeof(struct page *));
459 if (pages == NULL)
460 return ERR_PTR(-ENOMEM);
461
462 gfpmask |= mapping_gfp_mask(mapping);
463
464 for (i = 0; i < npages; i++) {
465 p = shmem_read_mapping_page_gfp(mapping, i, gfpmask);
466 if (IS_ERR(p))
467 goto fail;
468 pages[i] = p;
469
470 /* There is a hypothetical issue w/ drivers that require
471 * buffer memory in the low 4GB.. if the pages are un-
472 * pinned, and swapped out, they can end up swapped back
473 * in above 4GB. If pages are already in memory, then
474 * shmem_read_mapping_page_gfp will ignore the gfpmask,
475 * even if the already in-memory page disobeys the mask.
476 *
477 * It is only a theoretical issue today, because none of
478 * the devices with this limitation can be populated with
479 * enough memory to trigger the issue. But this BUG_ON()
480 * is here as a reminder in case the problem with
481 * shmem_read_mapping_page_gfp() isn't solved by the time
482 * it does become a real issue.
483 *
484 * See this thread: http://lkml.org/lkml/2011/7/11/238
485 */
486 BUG_ON((gfpmask & __GFP_DMA32) &&
487 (page_to_pfn(p) >= 0x00100000UL));
488 }
489
490 return pages;
491
492fail:
493 while (i--)
494 page_cache_release(pages[i]);
495
496 drm_free_large(pages);
497 return ERR_CAST(p);
498}
499EXPORT_SYMBOL(drm_gem_get_pages);
500
501/**
502 * drm_gem_put_pages - helper to free backing pages for a GEM object
503 * @obj: obj in question
504 * @pages: pages to free
505 * @dirty: if true, pages will be marked as dirty
506 * @accessed: if true, the pages will be marked as accessed
507 */
508void drm_gem_put_pages(struct drm_gem_object *obj, struct page **pages,
509 bool dirty, bool accessed)
510{
511 int i, npages;
512
513 /* We already BUG_ON() for non-page-aligned sizes in
514 * drm_gem_object_init(), so we should never hit this unless
515 * driver author is doing something really wrong:
516 */
517 WARN_ON((obj->size & (PAGE_SIZE - 1)) != 0);
518
519 npages = obj->size >> PAGE_SHIFT;
520
521 for (i = 0; i < npages; i++) {
522 if (dirty)
523 set_page_dirty(pages[i]);
524
525 if (accessed)
526 mark_page_accessed(pages[i]);
527
528 /* Undo the reference we took when populating the table */
529 page_cache_release(pages[i]);
530 }
531
532 drm_free_large(pages);
533}
534EXPORT_SYMBOL(drm_gem_put_pages);
535
Eric Anholt673a3942008-07-30 12:06:12 -0700536/** Returns a reference to the object named by the handle. */
537struct drm_gem_object *
538drm_gem_object_lookup(struct drm_device *dev, struct drm_file *filp,
Pekka Paalanena1a2d1d2009-08-23 12:40:55 +0300539 u32 handle)
Eric Anholt673a3942008-07-30 12:06:12 -0700540{
541 struct drm_gem_object *obj;
542
543 spin_lock(&filp->table_lock);
544
545 /* Check if we currently have a reference on the object */
546 obj = idr_find(&filp->object_idr, handle);
547 if (obj == NULL) {
548 spin_unlock(&filp->table_lock);
549 return NULL;
550 }
551
552 drm_gem_object_reference(obj);
553
554 spin_unlock(&filp->table_lock);
555
556 return obj;
557}
558EXPORT_SYMBOL(drm_gem_object_lookup);
559
560/**
561 * Releases the handle to an mm object.
562 */
563int
564drm_gem_close_ioctl(struct drm_device *dev, void *data,
565 struct drm_file *file_priv)
566{
567 struct drm_gem_close *args = data;
568 int ret;
569
570 if (!(dev->driver->driver_features & DRIVER_GEM))
571 return -ENODEV;
572
573 ret = drm_gem_handle_delete(file_priv, args->handle);
574
575 return ret;
576}
577
578/**
579 * Create a global name for an object, returning the name.
580 *
581 * Note that the name does not hold a reference; when the object
582 * is freed, the name goes away.
583 */
584int
585drm_gem_flink_ioctl(struct drm_device *dev, void *data,
586 struct drm_file *file_priv)
587{
588 struct drm_gem_flink *args = data;
589 struct drm_gem_object *obj;
590 int ret;
591
592 if (!(dev->driver->driver_features & DRIVER_GEM))
593 return -ENODEV;
594
595 obj = drm_gem_object_lookup(dev, file_priv, args->handle);
596 if (obj == NULL)
Chris Wilsonbf79cb92010-08-04 14:19:46 +0100597 return -ENOENT;
Eric Anholt673a3942008-07-30 12:06:12 -0700598
Daniel Vettercd4f0132013-08-15 00:02:44 +0200599 mutex_lock(&dev->object_name_lock);
Tejun Heo2e928812013-02-27 17:04:08 -0800600 idr_preload(GFP_KERNEL);
Daniel Vettera8e11d12013-08-15 00:02:37 +0200601 /* prevent races with concurrent gem_close. */
602 if (obj->handle_count == 0) {
603 ret = -ENOENT;
604 goto err;
605 }
606
Chris Wilson8d59bae2009-02-11 14:26:28 +0000607 if (!obj->name) {
Tejun Heo2e928812013-02-27 17:04:08 -0800608 ret = idr_alloc(&dev->object_name_idr, obj, 1, 0, GFP_NOWAIT);
Tejun Heo2e928812013-02-27 17:04:08 -0800609 if (ret < 0)
Chris Wilson8d59bae2009-02-11 14:26:28 +0000610 goto err;
YoungJun Cho2e07fb22013-06-27 08:58:33 +0900611
612 obj->name = ret;
Chris Wilson8d59bae2009-02-11 14:26:28 +0000613
614 /* Allocate a reference for the name table. */
615 drm_gem_object_reference(obj);
Eric Anholt673a3942008-07-30 12:06:12 -0700616 }
Chris Wilson3e49c4f2009-02-09 11:31:41 +0000617
YoungJun Cho2e07fb22013-06-27 08:58:33 +0900618 args->name = (uint64_t) obj->name;
619 ret = 0;
620
Chris Wilson3e49c4f2009-02-09 11:31:41 +0000621err:
YoungJun Cho2e07fb22013-06-27 08:58:33 +0900622 idr_preload_end();
Daniel Vettercd4f0132013-08-15 00:02:44 +0200623 mutex_unlock(&dev->object_name_lock);
Luca Barbieribc9025b2010-02-09 05:49:12 +0000624 drm_gem_object_unreference_unlocked(obj);
Chris Wilson3e49c4f2009-02-09 11:31:41 +0000625 return ret;
Eric Anholt673a3942008-07-30 12:06:12 -0700626}
627
628/**
629 * Open an object using the global name, returning a handle and the size.
630 *
631 * This handle (of course) holds a reference to the object, so the object
632 * will not go away until the handle is deleted.
633 */
634int
635drm_gem_open_ioctl(struct drm_device *dev, void *data,
636 struct drm_file *file_priv)
637{
638 struct drm_gem_open *args = data;
639 struct drm_gem_object *obj;
640 int ret;
Pekka Paalanena1a2d1d2009-08-23 12:40:55 +0300641 u32 handle;
Eric Anholt673a3942008-07-30 12:06:12 -0700642
643 if (!(dev->driver->driver_features & DRIVER_GEM))
644 return -ENODEV;
645
Daniel Vettercd4f0132013-08-15 00:02:44 +0200646 mutex_lock(&dev->object_name_lock);
Eric Anholt673a3942008-07-30 12:06:12 -0700647 obj = idr_find(&dev->object_name_idr, (int) args->name);
Daniel Vetter20228c42013-08-15 00:02:45 +0200648 if (obj) {
Eric Anholt673a3942008-07-30 12:06:12 -0700649 drm_gem_object_reference(obj);
Daniel Vetter20228c42013-08-15 00:02:45 +0200650 } else {
651 mutex_unlock(&dev->object_name_lock);
Eric Anholt673a3942008-07-30 12:06:12 -0700652 return -ENOENT;
Daniel Vetter20228c42013-08-15 00:02:45 +0200653 }
Eric Anholt673a3942008-07-30 12:06:12 -0700654
Daniel Vetter20228c42013-08-15 00:02:45 +0200655 /* drm_gem_handle_create_tail unlocks dev->object_name_lock. */
656 ret = drm_gem_handle_create_tail(file_priv, obj, &handle);
Luca Barbieribc9025b2010-02-09 05:49:12 +0000657 drm_gem_object_unreference_unlocked(obj);
Eric Anholt673a3942008-07-30 12:06:12 -0700658 if (ret)
659 return ret;
660
661 args->handle = handle;
662 args->size = obj->size;
663
664 return 0;
665}
666
667/**
668 * Called at device open time, sets up the structure for handling refcounting
669 * of mm objects.
670 */
671void
672drm_gem_open(struct drm_device *dev, struct drm_file *file_private)
673{
674 idr_init(&file_private->object_idr);
675 spin_lock_init(&file_private->table_lock);
676}
677
678/**
679 * Called at device close to release the file's
680 * handle references on objects.
681 */
682static int
683drm_gem_object_release_handle(int id, void *ptr, void *data)
684{
Ben Skeggs304eda32011-06-09 00:24:59 +0000685 struct drm_file *file_priv = data;
Eric Anholt673a3942008-07-30 12:06:12 -0700686 struct drm_gem_object *obj = ptr;
Ben Skeggs304eda32011-06-09 00:24:59 +0000687 struct drm_device *dev = obj->dev;
688
Dave Airlie0ff926c2012-05-20 17:31:16 +0100689 drm_gem_remove_prime_handles(obj, file_priv);
Dave Airlie32488772011-11-25 15:21:02 +0000690
Ben Skeggs304eda32011-06-09 00:24:59 +0000691 if (dev->driver->gem_close_object)
692 dev->driver->gem_close_object(obj, file_priv);
Eric Anholt673a3942008-07-30 12:06:12 -0700693
Luca Barbieribc9025b2010-02-09 05:49:12 +0000694 drm_gem_object_handle_unreference_unlocked(obj);
Eric Anholt673a3942008-07-30 12:06:12 -0700695
696 return 0;
697}
698
699/**
700 * Called at close time when the filp is going away.
701 *
702 * Releases any remaining references on objects by this filp.
703 */
704void
705drm_gem_release(struct drm_device *dev, struct drm_file *file_private)
706{
Eric Anholt673a3942008-07-30 12:06:12 -0700707 idr_for_each(&file_private->object_idr,
Ben Skeggs304eda32011-06-09 00:24:59 +0000708 &drm_gem_object_release_handle, file_private);
Eric Anholt673a3942008-07-30 12:06:12 -0700709 idr_destroy(&file_private->object_idr);
Eric Anholt673a3942008-07-30 12:06:12 -0700710}
711
Daniel Vetterfd632aa2010-04-09 19:05:05 +0000712void
713drm_gem_object_release(struct drm_gem_object *obj)
Luca Barbieric3ae90c2010-02-09 05:49:11 +0000714{
Alan Cox62cb70112011-06-07 14:17:51 +0100715 if (obj->filp)
716 fput(obj->filp);
Luca Barbieric3ae90c2010-02-09 05:49:11 +0000717}
Daniel Vetterfd632aa2010-04-09 19:05:05 +0000718EXPORT_SYMBOL(drm_gem_object_release);
Luca Barbieric3ae90c2010-02-09 05:49:11 +0000719
Eric Anholt673a3942008-07-30 12:06:12 -0700720/**
721 * Called after the last reference to the object has been lost.
Luca Barbieric3ae90c2010-02-09 05:49:11 +0000722 * Must be called holding struct_ mutex
Eric Anholt673a3942008-07-30 12:06:12 -0700723 *
724 * Frees the object
725 */
726void
727drm_gem_object_free(struct kref *kref)
728{
729 struct drm_gem_object *obj = (struct drm_gem_object *) kref;
730 struct drm_device *dev = obj->dev;
731
732 BUG_ON(!mutex_is_locked(&dev->struct_mutex));
733
734 if (dev->driver->gem_free_object != NULL)
735 dev->driver->gem_free_object(obj);
Eric Anholt673a3942008-07-30 12:06:12 -0700736}
737EXPORT_SYMBOL(drm_gem_object_free);
738
Jesse Barnesab00b3e2009-02-11 14:01:46 -0800739void drm_gem_vm_open(struct vm_area_struct *vma)
740{
741 struct drm_gem_object *obj = vma->vm_private_data;
742
743 drm_gem_object_reference(obj);
Chris Wilson31dfbc92010-09-27 21:28:30 +0100744
745 mutex_lock(&obj->dev->struct_mutex);
Rob Clarkb06d66b2012-05-01 11:04:51 -0500746 drm_vm_open_locked(obj->dev, vma);
Chris Wilson31dfbc92010-09-27 21:28:30 +0100747 mutex_unlock(&obj->dev->struct_mutex);
Jesse Barnesab00b3e2009-02-11 14:01:46 -0800748}
749EXPORT_SYMBOL(drm_gem_vm_open);
750
751void drm_gem_vm_close(struct vm_area_struct *vma)
752{
753 struct drm_gem_object *obj = vma->vm_private_data;
Chris Wilsonb74ad5a2011-03-17 22:33:33 +0000754 struct drm_device *dev = obj->dev;
Jesse Barnesab00b3e2009-02-11 14:01:46 -0800755
Chris Wilsonb74ad5a2011-03-17 22:33:33 +0000756 mutex_lock(&dev->struct_mutex);
Rob Clarkb06d66b2012-05-01 11:04:51 -0500757 drm_vm_close_locked(obj->dev, vma);
Chris Wilson31dfbc92010-09-27 21:28:30 +0100758 drm_gem_object_unreference(obj);
Chris Wilsonb74ad5a2011-03-17 22:33:33 +0000759 mutex_unlock(&dev->struct_mutex);
Jesse Barnesab00b3e2009-02-11 14:01:46 -0800760}
761EXPORT_SYMBOL(drm_gem_vm_close);
762
Laurent Pinchart1c5aafa2013-04-16 14:14:52 +0200763/**
764 * drm_gem_mmap_obj - memory map a GEM object
765 * @obj: the GEM object to map
766 * @obj_size: the object size to be mapped, in bytes
767 * @vma: VMA for the area to be mapped
768 *
769 * Set up the VMA to prepare mapping of the GEM object using the gem_vm_ops
770 * provided by the driver. Depending on their requirements, drivers can either
771 * provide a fault handler in their gem_vm_ops (in which case any accesses to
772 * the object will be trapped, to perform migration, GTT binding, surface
773 * register allocation, or performance monitoring), or mmap the buffer memory
774 * synchronously after calling drm_gem_mmap_obj.
775 *
776 * This function is mainly intended to implement the DMABUF mmap operation, when
777 * the GEM object is not looked up based on its fake offset. To implement the
778 * DRM mmap operation, drivers should use the drm_gem_mmap() function.
779 *
YoungJun Cho4368dd82013-06-27 08:39:58 +0900780 * NOTE: This function has to be protected with dev->struct_mutex
781 *
Laurent Pinchart1c5aafa2013-04-16 14:14:52 +0200782 * Return 0 or success or -EINVAL if the object size is smaller than the VMA
783 * size, or if no gem_vm_ops are provided.
784 */
785int drm_gem_mmap_obj(struct drm_gem_object *obj, unsigned long obj_size,
786 struct vm_area_struct *vma)
787{
788 struct drm_device *dev = obj->dev;
789
YoungJun Cho4368dd82013-06-27 08:39:58 +0900790 lockdep_assert_held(&dev->struct_mutex);
791
Laurent Pinchart1c5aafa2013-04-16 14:14:52 +0200792 /* Check for valid size. */
793 if (obj_size < vma->vm_end - vma->vm_start)
794 return -EINVAL;
795
796 if (!dev->driver->gem_vm_ops)
797 return -EINVAL;
798
799 vma->vm_flags |= VM_IO | VM_PFNMAP | VM_DONTEXPAND | VM_DONTDUMP;
800 vma->vm_ops = dev->driver->gem_vm_ops;
801 vma->vm_private_data = obj;
802 vma->vm_page_prot = pgprot_writecombine(vm_get_page_prot(vma->vm_flags));
803
804 /* Take a ref for this mapping of the object, so that the fault
805 * handler can dereference the mmap offset's pointer to the object.
806 * This reference is cleaned up by the corresponding vm_close
807 * (which should happen whether the vma was created by this call, or
808 * by a vm_open due to mremap or partial unmap or whatever).
809 */
810 drm_gem_object_reference(obj);
811
812 drm_vm_open_locked(dev, vma);
813 return 0;
814}
815EXPORT_SYMBOL(drm_gem_mmap_obj);
Jesse Barnesab00b3e2009-02-11 14:01:46 -0800816
Jesse Barnesa2c0a972008-11-05 10:31:53 -0800817/**
818 * drm_gem_mmap - memory map routine for GEM objects
819 * @filp: DRM file pointer
820 * @vma: VMA for the area to be mapped
821 *
822 * If a driver supports GEM object mapping, mmap calls on the DRM file
823 * descriptor will end up here.
824 *
Laurent Pinchart1c5aafa2013-04-16 14:14:52 +0200825 * Look up the GEM object based on the offset passed in (vma->vm_pgoff will
Jesse Barnesa2c0a972008-11-05 10:31:53 -0800826 * contain the fake offset we created when the GTT map ioctl was called on
Laurent Pinchart1c5aafa2013-04-16 14:14:52 +0200827 * the object) and map it with a call to drm_gem_mmap_obj().
Jesse Barnesa2c0a972008-11-05 10:31:53 -0800828 */
829int drm_gem_mmap(struct file *filp, struct vm_area_struct *vma)
830{
831 struct drm_file *priv = filp->private_data;
832 struct drm_device *dev = priv->minor->dev;
833 struct drm_gem_mm *mm = dev->mm_private;
David Herrmann0de23972013-07-24 21:07:52 +0200834 struct drm_gem_object *obj;
835 struct drm_vma_offset_node *node;
Jesse Barnesa2c0a972008-11-05 10:31:53 -0800836 int ret = 0;
837
Dave Airlie2c07a212012-02-20 14:18:07 +0000838 if (drm_device_is_unplugged(dev))
839 return -ENODEV;
840
Jesse Barnesa2c0a972008-11-05 10:31:53 -0800841 mutex_lock(&dev->struct_mutex);
842
David Herrmann0de23972013-07-24 21:07:52 +0200843 node = drm_vma_offset_exact_lookup(&mm->vma_manager, vma->vm_pgoff,
844 vma_pages(vma));
845 if (!node) {
Jesse Barnesa2c0a972008-11-05 10:31:53 -0800846 mutex_unlock(&dev->struct_mutex);
847 return drm_mmap(filp, vma);
848 }
849
David Herrmann0de23972013-07-24 21:07:52 +0200850 obj = container_of(node, struct drm_gem_object, vma_node);
David Herrmannaed2c032013-07-26 12:09:32 +0200851 ret = drm_gem_mmap_obj(obj, drm_vma_node_size(node) << PAGE_SHIFT, vma);
Jesse Barnesa2c0a972008-11-05 10:31:53 -0800852
Jesse Barnesa2c0a972008-11-05 10:31:53 -0800853 mutex_unlock(&dev->struct_mutex);
854
855 return ret;
856}
857EXPORT_SYMBOL(drm_gem_mmap);