blob: 2e8c77e71e1f699fc2837f2b5d67d24e52729a6d [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>
Daniel Vetterd9fc9412014-09-23 15:46:53 +020041#include <drm/drm_gem.h>
Daniel Vetter67d0ec42014-09-10 12:43:53 +020042#include "drm_internal.h"
Eric Anholt673a3942008-07-30 12:06:12 -070043
44/** @file drm_gem.c
45 *
46 * This file provides some of the base ioctls and library routines for
47 * the graphics memory manager implemented by each device driver.
48 *
49 * Because various devices have different requirements in terms of
50 * synchronization and migration strategies, implementing that is left up to
51 * the driver, and all that the general API provides should be generic --
52 * allocating objects, reading/writing data with the cpu, freeing objects.
53 * Even there, platform-dependent optimizations for reading/writing data with
54 * the CPU mean we'll likely hook those out to driver-specific calls. However,
55 * the DRI2 implementation wants to have at least allocate/mmap be generic.
56 *
57 * The goal was to have swap-backed object allocation managed through
58 * struct file. However, file descriptors as handles to a struct file have
59 * two major failings:
60 * - Process limits prevent more than 1024 or so being used at a time by
61 * default.
62 * - Inability to allocate high fds will aggravate the X Server's select()
63 * handling, and likely that of many GL client applications as well.
64 *
65 * This led to a plan of using our own integer IDs (called handles, following
66 * DRM terminology) to mimic fds, and implement the fd syscalls we need as
67 * ioctls. The objects themselves will still include the struct file so
68 * that we can transition to fds if the required kernel infrastructure shows
69 * up at a later date, and as our interface with shmfs for memory allocation.
70 */
71
Jesse Barnesa2c0a972008-11-05 10:31:53 -080072/*
73 * We make up offsets for buffer objects so we can recognize them at
74 * mmap time.
75 */
Jordan Crouse05269a32010-05-27 13:40:27 -060076
77/* pgoff in mmap is an unsigned long, so we need to make sure that
78 * the faked up offset will fit
79 */
80
81#if BITS_PER_LONG == 64
Jesse Barnesa2c0a972008-11-05 10:31:53 -080082#define DRM_FILE_PAGE_OFFSET_START ((0xFFFFFFFFUL >> PAGE_SHIFT) + 1)
83#define DRM_FILE_PAGE_OFFSET_SIZE ((0xFFFFFFFFUL >> PAGE_SHIFT) * 16)
Jordan Crouse05269a32010-05-27 13:40:27 -060084#else
85#define DRM_FILE_PAGE_OFFSET_START ((0xFFFFFFFUL >> PAGE_SHIFT) + 1)
86#define DRM_FILE_PAGE_OFFSET_SIZE ((0xFFFFFFFUL >> PAGE_SHIFT) * 16)
87#endif
Jesse Barnesa2c0a972008-11-05 10:31:53 -080088
Eric Anholt673a3942008-07-30 12:06:12 -070089/**
Daniel Vetter89d61fc2014-01-21 12:39:00 +010090 * drm_gem_init - Initialize the GEM device fields
91 * @dev: drm_devic structure to initialize
Eric Anholt673a3942008-07-30 12:06:12 -070092 */
Eric Anholt673a3942008-07-30 12:06:12 -070093int
94drm_gem_init(struct drm_device *dev)
95{
Daniel Vetterb04a5902013-12-11 14:24:46 +010096 struct drm_vma_offset_manager *vma_offset_manager;
Jesse Barnesa2c0a972008-11-05 10:31:53 -080097
Daniel Vettercd4f0132013-08-15 00:02:44 +020098 mutex_init(&dev->object_name_lock);
Eric Anholt673a3942008-07-30 12:06:12 -070099 idr_init(&dev->object_name_idr);
Jesse Barnesa2c0a972008-11-05 10:31:53 -0800100
Daniel Vetterb04a5902013-12-11 14:24:46 +0100101 vma_offset_manager = kzalloc(sizeof(*vma_offset_manager), GFP_KERNEL);
102 if (!vma_offset_manager) {
Jesse Barnesa2c0a972008-11-05 10:31:53 -0800103 DRM_ERROR("out of memory\n");
104 return -ENOMEM;
105 }
106
Daniel Vetterb04a5902013-12-11 14:24:46 +0100107 dev->vma_offset_manager = vma_offset_manager;
108 drm_vma_offset_manager_init(vma_offset_manager,
David Herrmann0de23972013-07-24 21:07:52 +0200109 DRM_FILE_PAGE_OFFSET_START,
110 DRM_FILE_PAGE_OFFSET_SIZE);
Jesse Barnesa2c0a972008-11-05 10:31:53 -0800111
Eric Anholt673a3942008-07-30 12:06:12 -0700112 return 0;
113}
114
Jesse Barnesa2c0a972008-11-05 10:31:53 -0800115void
116drm_gem_destroy(struct drm_device *dev)
117{
Jesse Barnesa2c0a972008-11-05 10:31:53 -0800118
Daniel Vetterb04a5902013-12-11 14:24:46 +0100119 drm_vma_offset_manager_destroy(dev->vma_offset_manager);
120 kfree(dev->vma_offset_manager);
121 dev->vma_offset_manager = NULL;
Jesse Barnesa2c0a972008-11-05 10:31:53 -0800122}
123
Eric Anholt673a3942008-07-30 12:06:12 -0700124/**
Daniel Vetter89d61fc2014-01-21 12:39:00 +0100125 * drm_gem_object_init - initialize an allocated shmem-backed GEM object
126 * @dev: drm_device the object should be initialized for
127 * @obj: drm_gem_object to initialize
128 * @size: object size
129 *
Alan Cox62cb70112011-06-07 14:17:51 +0100130 * Initialize an already allocated GEM object of the specified size with
Daniel Vetter1d397042010-04-09 19:05:04 +0000131 * shmfs backing store.
132 */
133int drm_gem_object_init(struct drm_device *dev,
134 struct drm_gem_object *obj, size_t size)
135{
David Herrmann89c82332013-07-11 11:56:32 +0200136 struct file *filp;
Daniel Vetter1d397042010-04-09 19:05:04 +0000137
Daniel Vetter6ab11a22014-01-20 08:21:54 +0100138 drm_gem_private_object_init(dev, obj, size);
139
David Herrmann89c82332013-07-11 11:56:32 +0200140 filp = shmem_file_setup("drm mm object", size, VM_NORESERVE);
141 if (IS_ERR(filp))
142 return PTR_ERR(filp);
Daniel Vetter1d397042010-04-09 19:05:04 +0000143
David Herrmann89c82332013-07-11 11:56:32 +0200144 obj->filp = filp;
Daniel Vetter1d397042010-04-09 19:05:04 +0000145
Daniel Vetter1d397042010-04-09 19:05:04 +0000146 return 0;
147}
148EXPORT_SYMBOL(drm_gem_object_init);
149
150/**
Laurent Pinchart2a5706a2014-08-28 14:34:36 +0200151 * drm_gem_private_object_init - initialize an allocated private GEM object
Daniel Vetter89d61fc2014-01-21 12:39:00 +0100152 * @dev: drm_device the object should be initialized for
153 * @obj: drm_gem_object to initialize
154 * @size: object size
155 *
Alan Cox62cb70112011-06-07 14:17:51 +0100156 * Initialize an already allocated GEM object of the specified size with
157 * no GEM provided backing store. Instead the caller is responsible for
158 * backing the object and handling it.
159 */
David Herrmann89c82332013-07-11 11:56:32 +0200160void drm_gem_private_object_init(struct drm_device *dev,
161 struct drm_gem_object *obj, size_t size)
Alan Cox62cb70112011-06-07 14:17:51 +0100162{
163 BUG_ON((size & (PAGE_SIZE - 1)) != 0);
164
165 obj->dev = dev;
166 obj->filp = NULL;
167
168 kref_init(&obj->refcount);
Daniel Vettera8e11d12013-08-15 00:02:37 +0200169 obj->handle_count = 0;
Alan Cox62cb70112011-06-07 14:17:51 +0100170 obj->size = size;
David Herrmann88d7ebe2013-08-25 18:28:57 +0200171 drm_vma_node_reset(&obj->vma_node);
Alan Cox62cb70112011-06-07 14:17:51 +0100172}
173EXPORT_SYMBOL(drm_gem_private_object_init);
174
Dave Airlie0ff926c2012-05-20 17:31:16 +0100175static void
176drm_gem_remove_prime_handles(struct drm_gem_object *obj, struct drm_file *filp)
177{
Daniel Vetter319c9332013-08-15 00:02:46 +0200178 /*
179 * Note: obj->dma_buf can't disappear as long as we still hold a
180 * handle reference in obj->handle_count.
181 */
Daniel Vetterd0b2c532013-08-15 00:02:49 +0200182 mutex_lock(&filp->prime.lock);
Daniel Vetter319c9332013-08-15 00:02:46 +0200183 if (obj->dma_buf) {
Daniel Vetterd0b2c532013-08-15 00:02:49 +0200184 drm_prime_remove_buf_handle_locked(&filp->prime,
185 obj->dma_buf);
Dave Airlie0ff926c2012-05-20 17:31:16 +0100186 }
Daniel Vetterd0b2c532013-08-15 00:02:49 +0200187 mutex_unlock(&filp->prime.lock);
Dave Airlie0ff926c2012-05-20 17:31:16 +0100188}
189
Daniel Vetter36da5902013-08-15 00:02:34 +0200190/**
Thierry Redingc6a84322014-10-02 14:45:55 +0200191 * drm_gem_object_handle_free - release resources bound to userspace handles
Daniel Vetter89d61fc2014-01-21 12:39:00 +0100192 * @obj: GEM object to clean up.
193 *
Daniel Vetter36da5902013-08-15 00:02:34 +0200194 * Called after the last handle to the object has been closed
195 *
196 * Removes any name for the object. Note that this must be
197 * called before drm_gem_object_free or we'll be touching
198 * freed memory
199 */
200static void drm_gem_object_handle_free(struct drm_gem_object *obj)
201{
202 struct drm_device *dev = obj->dev;
203
204 /* Remove any name for this object */
Daniel Vetter36da5902013-08-15 00:02:34 +0200205 if (obj->name) {
206 idr_remove(&dev->object_name_idr, obj->name);
207 obj->name = 0;
Daniel Vettera8e11d12013-08-15 00:02:37 +0200208 }
Daniel Vetter36da5902013-08-15 00:02:34 +0200209}
210
Daniel Vetter319c9332013-08-15 00:02:46 +0200211static void drm_gem_object_exported_dma_buf_free(struct drm_gem_object *obj)
212{
213 /* Unbreak the reference cycle if we have an exported dma_buf. */
214 if (obj->dma_buf) {
215 dma_buf_put(obj->dma_buf);
216 obj->dma_buf = NULL;
217 }
218}
219
Daniel Vetterbecee2a2013-08-15 00:02:39 +0200220static void
Daniel Vetter36da5902013-08-15 00:02:34 +0200221drm_gem_object_handle_unreference_unlocked(struct drm_gem_object *obj)
222{
Chris Wilson98a88832016-01-04 10:11:00 +0000223 struct drm_device *dev = obj->dev;
224 bool final = false;
225
Daniel Vettera8e11d12013-08-15 00:02:37 +0200226 if (WARN_ON(obj->handle_count == 0))
Daniel Vetter36da5902013-08-15 00:02:34 +0200227 return;
228
229 /*
230 * Must bump handle count first as this may be the last
231 * ref, in which case the object would disappear before we
232 * checked for a name
233 */
234
Chris Wilson98a88832016-01-04 10:11:00 +0000235 mutex_lock(&dev->object_name_lock);
Daniel Vetter319c9332013-08-15 00:02:46 +0200236 if (--obj->handle_count == 0) {
Daniel Vetter36da5902013-08-15 00:02:34 +0200237 drm_gem_object_handle_free(obj);
Daniel Vetter319c9332013-08-15 00:02:46 +0200238 drm_gem_object_exported_dma_buf_free(obj);
Chris Wilson98a88832016-01-04 10:11:00 +0000239 final = true;
Daniel Vetter319c9332013-08-15 00:02:46 +0200240 }
Chris Wilson98a88832016-01-04 10:11:00 +0000241 mutex_unlock(&dev->object_name_lock);
Daniel Vettera8e11d12013-08-15 00:02:37 +0200242
Chris Wilson98a88832016-01-04 10:11:00 +0000243 if (final)
244 drm_gem_object_unreference_unlocked(obj);
Daniel Vetter36da5902013-08-15 00:02:34 +0200245}
246
Chris Wilson8815b232016-01-05 09:42:31 +0000247/*
248 * Called at device or object close to release the file's
249 * handle references on objects.
250 */
251static int
252drm_gem_object_release_handle(int id, void *ptr, void *data)
253{
254 struct drm_file *file_priv = data;
255 struct drm_gem_object *obj = ptr;
256 struct drm_device *dev = obj->dev;
257
258 if (drm_core_check_feature(dev, DRIVER_PRIME))
259 drm_gem_remove_prime_handles(obj, file_priv);
260 drm_vma_node_revoke(&obj->vma_node, file_priv->filp);
261
262 if (dev->driver->gem_close_object)
263 dev->driver->gem_close_object(obj, file_priv);
264
265 drm_gem_object_handle_unreference_unlocked(obj);
266
267 return 0;
268}
269
Eric Anholt673a3942008-07-30 12:06:12 -0700270/**
Daniel Vetter89d61fc2014-01-21 12:39:00 +0100271 * drm_gem_handle_delete - deletes the given file-private handle
272 * @filp: drm file-private structure to use for the handle look up
273 * @handle: userspace handle to delete
274 *
Daniel Vetterdf2e0902015-10-22 19:11:29 +0200275 * Removes the GEM handle from the @filp lookup table which has been added with
276 * drm_gem_handle_create(). If this is the last handle also cleans up linked
277 * resources like GEM names.
Eric Anholt673a3942008-07-30 12:06:12 -0700278 */
Dave Airlieff72145b2011-02-07 12:16:14 +1000279int
Pekka Paalanena1a2d1d2009-08-23 12:40:55 +0300280drm_gem_handle_delete(struct drm_file *filp, u32 handle)
Eric Anholt673a3942008-07-30 12:06:12 -0700281{
282 struct drm_device *dev;
283 struct drm_gem_object *obj;
284
285 /* This is gross. The idr system doesn't let us try a delete and
286 * return an error code. It just spews if you fail at deleting.
287 * So, we have to grab a lock around finding the object and then
288 * doing the delete on it and dropping the refcount, or the user
289 * could race us to double-decrement the refcount and cause a
290 * use-after-free later. Given the frequency of our handle lookups,
291 * we may want to use ida for number allocation and a hash table
292 * for the pointers, anyway.
293 */
294 spin_lock(&filp->table_lock);
295
296 /* Check if we currently have a reference on the object */
297 obj = idr_find(&filp->object_idr, handle);
298 if (obj == NULL) {
299 spin_unlock(&filp->table_lock);
300 return -EINVAL;
301 }
302 dev = obj->dev;
303
304 /* Release reference and decrement refcount. */
305 idr_remove(&filp->object_idr, handle);
306 spin_unlock(&filp->table_lock);
307
Chris Wilson8815b232016-01-05 09:42:31 +0000308 drm_gem_object_release_handle(handle, obj, filp);
Eric Anholt673a3942008-07-30 12:06:12 -0700309 return 0;
310}
Dave Airlieff72145b2011-02-07 12:16:14 +1000311EXPORT_SYMBOL(drm_gem_handle_delete);
Eric Anholt673a3942008-07-30 12:06:12 -0700312
313/**
Daniel Vetter43387b32013-07-16 09:12:04 +0200314 * drm_gem_dumb_destroy - dumb fb callback helper for gem based drivers
Daniel Vetter89d61fc2014-01-21 12:39:00 +0100315 * @file: drm file-private structure to remove the dumb handle from
316 * @dev: corresponding drm_device
317 * @handle: the dumb handle to remove
Daniel Vetter43387b32013-07-16 09:12:04 +0200318 *
319 * This implements the ->dumb_destroy kms driver callback for drivers which use
320 * gem to manage their backing storage.
321 */
322int drm_gem_dumb_destroy(struct drm_file *file,
323 struct drm_device *dev,
324 uint32_t handle)
325{
326 return drm_gem_handle_delete(file, handle);
327}
328EXPORT_SYMBOL(drm_gem_dumb_destroy);
329
330/**
Daniel Vetter20228c42013-08-15 00:02:45 +0200331 * drm_gem_handle_create_tail - internal functions to create a handle
Daniel Vetter89d61fc2014-01-21 12:39:00 +0100332 * @file_priv: drm file-private structure to register the handle for
333 * @obj: object to register
Thierry Reding8bf81802014-11-03 13:20:52 +0100334 * @handlep: pointer to return the created handle to the caller
Daniel Vetter20228c42013-08-15 00:02:45 +0200335 *
336 * This expects the dev->object_name_lock to be held already and will drop it
337 * before returning. Used to avoid races in establishing new handles when
338 * importing an object from either an flink name or a dma-buf.
Daniel Vetterdf2e0902015-10-22 19:11:29 +0200339 *
340 * Handles must be release again through drm_gem_handle_delete(). This is done
341 * when userspace closes @file_priv for all attached handles, or through the
342 * GEM_CLOSE ioctl for individual handles.
Eric Anholt673a3942008-07-30 12:06:12 -0700343 */
344int
Daniel Vetter20228c42013-08-15 00:02:45 +0200345drm_gem_handle_create_tail(struct drm_file *file_priv,
346 struct drm_gem_object *obj,
347 u32 *handlep)
Eric Anholt673a3942008-07-30 12:06:12 -0700348{
Ben Skeggs304eda32011-06-09 00:24:59 +0000349 struct drm_device *dev = obj->dev;
Chris Wilson96493992016-01-05 09:42:30 +0000350 u32 handle;
Ben Skeggs304eda32011-06-09 00:24:59 +0000351 int ret;
Eric Anholt673a3942008-07-30 12:06:12 -0700352
Daniel Vetter20228c42013-08-15 00:02:45 +0200353 WARN_ON(!mutex_is_locked(&dev->object_name_lock));
Chris Wilson98a88832016-01-04 10:11:00 +0000354 if (obj->handle_count++ == 0)
355 drm_gem_object_reference(obj);
Daniel Vetter20228c42013-08-15 00:02:45 +0200356
Eric Anholt673a3942008-07-30 12:06:12 -0700357 /*
Tejun Heo2e928812013-02-27 17:04:08 -0800358 * Get the user-visible handle using idr. Preload and perform
359 * allocation under our spinlock.
Eric Anholt673a3942008-07-30 12:06:12 -0700360 */
Tejun Heo2e928812013-02-27 17:04:08 -0800361 idr_preload(GFP_KERNEL);
Eric Anholt673a3942008-07-30 12:06:12 -0700362 spin_lock(&file_priv->table_lock);
Tejun Heo2e928812013-02-27 17:04:08 -0800363
364 ret = idr_alloc(&file_priv->object_idr, obj, 1, 0, GFP_NOWAIT);
Chris Wilson98a88832016-01-04 10:11:00 +0000365
Eric Anholt673a3942008-07-30 12:06:12 -0700366 spin_unlock(&file_priv->table_lock);
Tejun Heo2e928812013-02-27 17:04:08 -0800367 idr_preload_end();
Chris Wilson98a88832016-01-04 10:11:00 +0000368
Daniel Vettercd4f0132013-08-15 00:02:44 +0200369 mutex_unlock(&dev->object_name_lock);
Chris Wilson69841282016-01-04 10:10:59 +0000370 if (ret < 0)
371 goto err_unref;
372
Chris Wilson96493992016-01-05 09:42:30 +0000373 handle = ret;
Eric Anholt673a3942008-07-30 12:06:12 -0700374
David Herrmannca481c92013-08-25 18:28:58 +0200375 ret = drm_vma_node_allow(&obj->vma_node, file_priv->filp);
Chris Wilson69841282016-01-04 10:10:59 +0000376 if (ret)
377 goto err_remove;
Ben Skeggs304eda32011-06-09 00:24:59 +0000378
379 if (dev->driver->gem_open_object) {
380 ret = dev->driver->gem_open_object(obj, file_priv);
Chris Wilson69841282016-01-04 10:10:59 +0000381 if (ret)
382 goto err_revoke;
Ben Skeggs304eda32011-06-09 00:24:59 +0000383 }
384
Chris Wilson96493992016-01-05 09:42:30 +0000385 *handlep = handle;
Eric Anholt673a3942008-07-30 12:06:12 -0700386 return 0;
Chris Wilson69841282016-01-04 10:10:59 +0000387
388err_revoke:
389 drm_vma_node_revoke(&obj->vma_node, file_priv->filp);
390err_remove:
391 spin_lock(&file_priv->table_lock);
Chris Wilson96493992016-01-05 09:42:30 +0000392 idr_remove(&file_priv->object_idr, handle);
Chris Wilson69841282016-01-04 10:10:59 +0000393 spin_unlock(&file_priv->table_lock);
394err_unref:
395 drm_gem_object_handle_unreference_unlocked(obj);
396 return ret;
Eric Anholt673a3942008-07-30 12:06:12 -0700397}
Daniel Vetter20228c42013-08-15 00:02:45 +0200398
399/**
Thierry Reding8bf81802014-11-03 13:20:52 +0100400 * drm_gem_handle_create - create a gem handle for an object
Daniel Vetter89d61fc2014-01-21 12:39:00 +0100401 * @file_priv: drm file-private structure to register the handle for
402 * @obj: object to register
403 * @handlep: pionter to return the created handle to the caller
404 *
Daniel Vetter20228c42013-08-15 00:02:45 +0200405 * Create a handle for this object. This adds a handle reference
406 * to the object, which includes a regular reference count. Callers
407 * will likely want to dereference the object afterwards.
408 */
Thierry Reding8bf81802014-11-03 13:20:52 +0100409int drm_gem_handle_create(struct drm_file *file_priv,
410 struct drm_gem_object *obj,
411 u32 *handlep)
Daniel Vetter20228c42013-08-15 00:02:45 +0200412{
413 mutex_lock(&obj->dev->object_name_lock);
414
415 return drm_gem_handle_create_tail(file_priv, obj, handlep);
416}
Eric Anholt673a3942008-07-30 12:06:12 -0700417EXPORT_SYMBOL(drm_gem_handle_create);
418
Rob Clark75ef8b32011-08-10 08:09:07 -0500419
420/**
421 * drm_gem_free_mmap_offset - release a fake mmap offset for an object
422 * @obj: obj in question
423 *
424 * This routine frees fake offsets allocated by drm_gem_create_mmap_offset().
425 */
426void
427drm_gem_free_mmap_offset(struct drm_gem_object *obj)
428{
429 struct drm_device *dev = obj->dev;
Rob Clark75ef8b32011-08-10 08:09:07 -0500430
Daniel Vetterb04a5902013-12-11 14:24:46 +0100431 drm_vma_offset_remove(dev->vma_offset_manager, &obj->vma_node);
Rob Clark75ef8b32011-08-10 08:09:07 -0500432}
433EXPORT_SYMBOL(drm_gem_free_mmap_offset);
434
435/**
Rob Clark367bbd42013-08-07 13:41:23 -0400436 * drm_gem_create_mmap_offset_size - create a fake mmap offset for an object
437 * @obj: obj in question
438 * @size: the virtual size
439 *
440 * GEM memory mapping works by handing back to userspace a fake mmap offset
441 * it can use in a subsequent mmap(2) call. The DRM core code then looks
442 * up the object based on the offset and sets up the various memory mapping
443 * structures.
444 *
445 * This routine allocates and attaches a fake offset for @obj, in cases where
446 * the virtual size differs from the physical size (ie. obj->size). Otherwise
447 * just use drm_gem_create_mmap_offset().
448 */
449int
450drm_gem_create_mmap_offset_size(struct drm_gem_object *obj, size_t size)
451{
452 struct drm_device *dev = obj->dev;
Rob Clark367bbd42013-08-07 13:41:23 -0400453
Daniel Vetterb04a5902013-12-11 14:24:46 +0100454 return drm_vma_offset_add(dev->vma_offset_manager, &obj->vma_node,
Rob Clark367bbd42013-08-07 13:41:23 -0400455 size / PAGE_SIZE);
456}
457EXPORT_SYMBOL(drm_gem_create_mmap_offset_size);
458
459/**
Rob Clark75ef8b32011-08-10 08:09:07 -0500460 * drm_gem_create_mmap_offset - create a fake mmap offset for an object
461 * @obj: obj in question
462 *
463 * GEM memory mapping works by handing back to userspace a fake mmap offset
464 * it can use in a subsequent mmap(2) call. The DRM core code then looks
465 * up the object based on the offset and sets up the various memory mapping
466 * structures.
467 *
468 * This routine allocates and attaches a fake offset for @obj.
469 */
Rob Clark367bbd42013-08-07 13:41:23 -0400470int drm_gem_create_mmap_offset(struct drm_gem_object *obj)
Rob Clark75ef8b32011-08-10 08:09:07 -0500471{
Rob Clark367bbd42013-08-07 13:41:23 -0400472 return drm_gem_create_mmap_offset_size(obj, obj->size);
Rob Clark75ef8b32011-08-10 08:09:07 -0500473}
474EXPORT_SYMBOL(drm_gem_create_mmap_offset);
475
Rob Clarkbcc5c9d2013-08-07 13:41:24 -0400476/**
477 * drm_gem_get_pages - helper to allocate backing pages for a GEM object
478 * from shmem
479 * @obj: obj in question
David Herrmann0cdbe8a2014-05-25 12:59:47 +0200480 *
481 * This reads the page-array of the shmem-backing storage of the given gem
482 * object. An array of pages is returned. If a page is not allocated or
483 * swapped-out, this will allocate/swap-in the required pages. Note that the
484 * whole object is covered by the page-array and pinned in memory.
485 *
486 * Use drm_gem_put_pages() to release the array and unpin all pages.
487 *
488 * This uses the GFP-mask set on the shmem-mapping (see mapping_set_gfp_mask()).
489 * If you require other GFP-masks, you have to do those allocations yourself.
490 *
491 * Note that you are not allowed to change gfp-zones during runtime. That is,
492 * shmem_read_mapping_page_gfp() must be called with the same gfp_zone(gfp) as
493 * set during initialization. If you have special zone constraints, set them
494 * after drm_gem_init_object() via mapping_set_gfp_mask(). shmem-core takes care
495 * to keep pages in the required zone during swap-in.
Rob Clarkbcc5c9d2013-08-07 13:41:24 -0400496 */
David Herrmann0cdbe8a2014-05-25 12:59:47 +0200497struct page **drm_gem_get_pages(struct drm_gem_object *obj)
Rob Clarkbcc5c9d2013-08-07 13:41:24 -0400498{
Rob Clarkbcc5c9d2013-08-07 13:41:24 -0400499 struct address_space *mapping;
500 struct page *p, **pages;
501 int i, npages;
502
503 /* This is the shared memory object that backs the GEM resource */
David Herrmann0cdbe8a2014-05-25 12:59:47 +0200504 mapping = file_inode(obj->filp)->i_mapping;
Rob Clarkbcc5c9d2013-08-07 13:41:24 -0400505
506 /* We already BUG_ON() for non-page-aligned sizes in
507 * drm_gem_object_init(), so we should never hit this unless
508 * driver author is doing something really wrong:
509 */
510 WARN_ON((obj->size & (PAGE_SIZE - 1)) != 0);
511
512 npages = obj->size >> PAGE_SHIFT;
513
514 pages = drm_malloc_ab(npages, sizeof(struct page *));
515 if (pages == NULL)
516 return ERR_PTR(-ENOMEM);
517
Rob Clarkbcc5c9d2013-08-07 13:41:24 -0400518 for (i = 0; i < npages; i++) {
David Herrmann0cdbe8a2014-05-25 12:59:47 +0200519 p = shmem_read_mapping_page(mapping, i);
Rob Clarkbcc5c9d2013-08-07 13:41:24 -0400520 if (IS_ERR(p))
521 goto fail;
522 pages[i] = p;
523
David Herrmann21230002014-05-25 14:34:08 +0200524 /* Make sure shmem keeps __GFP_DMA32 allocated pages in the
525 * correct region during swapin. Note that this requires
526 * __GFP_DMA32 to be set in mapping_gfp_mask(inode->i_mapping)
527 * so shmem can relocate pages during swapin if required.
Rob Clarkbcc5c9d2013-08-07 13:41:24 -0400528 */
Michal Hockoc62d2552015-11-06 16:28:49 -0800529 BUG_ON(mapping_gfp_constraint(mapping, __GFP_DMA32) &&
Rob Clarkbcc5c9d2013-08-07 13:41:24 -0400530 (page_to_pfn(p) >= 0x00100000UL));
531 }
532
533 return pages;
534
535fail:
536 while (i--)
537 page_cache_release(pages[i]);
538
539 drm_free_large(pages);
540 return ERR_CAST(p);
541}
542EXPORT_SYMBOL(drm_gem_get_pages);
543
544/**
545 * drm_gem_put_pages - helper to free backing pages for a GEM object
546 * @obj: obj in question
547 * @pages: pages to free
548 * @dirty: if true, pages will be marked as dirty
549 * @accessed: if true, the pages will be marked as accessed
550 */
551void drm_gem_put_pages(struct drm_gem_object *obj, struct page **pages,
552 bool dirty, bool accessed)
553{
554 int i, npages;
555
556 /* We already BUG_ON() for non-page-aligned sizes in
557 * drm_gem_object_init(), so we should never hit this unless
558 * driver author is doing something really wrong:
559 */
560 WARN_ON((obj->size & (PAGE_SIZE - 1)) != 0);
561
562 npages = obj->size >> PAGE_SHIFT;
563
564 for (i = 0; i < npages; i++) {
565 if (dirty)
566 set_page_dirty(pages[i]);
567
568 if (accessed)
569 mark_page_accessed(pages[i]);
570
571 /* Undo the reference we took when populating the table */
572 page_cache_release(pages[i]);
573 }
574
575 drm_free_large(pages);
576}
577EXPORT_SYMBOL(drm_gem_put_pages);
578
Daniel Vetterdf2e0902015-10-22 19:11:29 +0200579/**
580 * drm_gem_object_lookup - look up a GEM object from it's handle
581 * @dev: DRM device
582 * @filp: DRM file private date
583 * @handle: userspace handle
584 *
585 * Returns:
586 *
587 * A reference to the object named by the handle if such exists on @filp, NULL
588 * otherwise.
589 */
Eric Anholt673a3942008-07-30 12:06:12 -0700590struct drm_gem_object *
591drm_gem_object_lookup(struct drm_device *dev, struct drm_file *filp,
Pekka Paalanena1a2d1d2009-08-23 12:40:55 +0300592 u32 handle)
Eric Anholt673a3942008-07-30 12:06:12 -0700593{
594 struct drm_gem_object *obj;
595
596 spin_lock(&filp->table_lock);
597
598 /* Check if we currently have a reference on the object */
599 obj = idr_find(&filp->object_idr, handle);
600 if (obj == NULL) {
601 spin_unlock(&filp->table_lock);
602 return NULL;
603 }
604
605 drm_gem_object_reference(obj);
606
607 spin_unlock(&filp->table_lock);
608
609 return obj;
610}
611EXPORT_SYMBOL(drm_gem_object_lookup);
612
613/**
Daniel Vetter89d61fc2014-01-21 12:39:00 +0100614 * drm_gem_close_ioctl - implementation of the GEM_CLOSE ioctl
615 * @dev: drm_device
616 * @data: ioctl data
617 * @file_priv: drm file-private structure
618 *
Eric Anholt673a3942008-07-30 12:06:12 -0700619 * Releases the handle to an mm object.
620 */
621int
622drm_gem_close_ioctl(struct drm_device *dev, void *data,
623 struct drm_file *file_priv)
624{
625 struct drm_gem_close *args = data;
626 int ret;
627
Andrzej Hajda1bcecfa2014-09-30 16:49:56 +0200628 if (!drm_core_check_feature(dev, DRIVER_GEM))
Eric Anholt673a3942008-07-30 12:06:12 -0700629 return -ENODEV;
630
631 ret = drm_gem_handle_delete(file_priv, args->handle);
632
633 return ret;
634}
635
636/**
Daniel Vetter89d61fc2014-01-21 12:39:00 +0100637 * drm_gem_flink_ioctl - implementation of the GEM_FLINK ioctl
638 * @dev: drm_device
639 * @data: ioctl data
640 * @file_priv: drm file-private structure
641 *
Eric Anholt673a3942008-07-30 12:06:12 -0700642 * Create a global name for an object, returning the name.
643 *
644 * Note that the name does not hold a reference; when the object
645 * is freed, the name goes away.
646 */
647int
648drm_gem_flink_ioctl(struct drm_device *dev, void *data,
649 struct drm_file *file_priv)
650{
651 struct drm_gem_flink *args = data;
652 struct drm_gem_object *obj;
653 int ret;
654
Andrzej Hajda1bcecfa2014-09-30 16:49:56 +0200655 if (!drm_core_check_feature(dev, DRIVER_GEM))
Eric Anholt673a3942008-07-30 12:06:12 -0700656 return -ENODEV;
657
658 obj = drm_gem_object_lookup(dev, file_priv, args->handle);
659 if (obj == NULL)
Chris Wilsonbf79cb92010-08-04 14:19:46 +0100660 return -ENOENT;
Eric Anholt673a3942008-07-30 12:06:12 -0700661
Daniel Vettercd4f0132013-08-15 00:02:44 +0200662 mutex_lock(&dev->object_name_lock);
Daniel Vettera8e11d12013-08-15 00:02:37 +0200663 /* prevent races with concurrent gem_close. */
664 if (obj->handle_count == 0) {
665 ret = -ENOENT;
666 goto err;
667 }
668
Chris Wilson8d59bae2009-02-11 14:26:28 +0000669 if (!obj->name) {
Chris Wilson0f646422016-01-04 10:11:01 +0000670 ret = idr_alloc(&dev->object_name_idr, obj, 1, 0, GFP_KERNEL);
Tejun Heo2e928812013-02-27 17:04:08 -0800671 if (ret < 0)
Chris Wilson8d59bae2009-02-11 14:26:28 +0000672 goto err;
YoungJun Cho2e07fb22013-06-27 08:58:33 +0900673
674 obj->name = ret;
Eric Anholt673a3942008-07-30 12:06:12 -0700675 }
Chris Wilson3e49c4f2009-02-09 11:31:41 +0000676
YoungJun Cho2e07fb22013-06-27 08:58:33 +0900677 args->name = (uint64_t) obj->name;
678 ret = 0;
679
Chris Wilson3e49c4f2009-02-09 11:31:41 +0000680err:
Daniel Vettercd4f0132013-08-15 00:02:44 +0200681 mutex_unlock(&dev->object_name_lock);
Luca Barbieribc9025b2010-02-09 05:49:12 +0000682 drm_gem_object_unreference_unlocked(obj);
Chris Wilson3e49c4f2009-02-09 11:31:41 +0000683 return ret;
Eric Anholt673a3942008-07-30 12:06:12 -0700684}
685
686/**
Daniel Vetter89d61fc2014-01-21 12:39:00 +0100687 * drm_gem_open - implementation of the GEM_OPEN ioctl
688 * @dev: drm_device
689 * @data: ioctl data
690 * @file_priv: drm file-private structure
691 *
Eric Anholt673a3942008-07-30 12:06:12 -0700692 * Open an object using the global name, returning a handle and the size.
693 *
694 * This handle (of course) holds a reference to the object, so the object
695 * will not go away until the handle is deleted.
696 */
697int
698drm_gem_open_ioctl(struct drm_device *dev, void *data,
699 struct drm_file *file_priv)
700{
701 struct drm_gem_open *args = data;
702 struct drm_gem_object *obj;
703 int ret;
Pekka Paalanena1a2d1d2009-08-23 12:40:55 +0300704 u32 handle;
Eric Anholt673a3942008-07-30 12:06:12 -0700705
Andrzej Hajda1bcecfa2014-09-30 16:49:56 +0200706 if (!drm_core_check_feature(dev, DRIVER_GEM))
Eric Anholt673a3942008-07-30 12:06:12 -0700707 return -ENODEV;
708
Daniel Vettercd4f0132013-08-15 00:02:44 +0200709 mutex_lock(&dev->object_name_lock);
Eric Anholt673a3942008-07-30 12:06:12 -0700710 obj = idr_find(&dev->object_name_idr, (int) args->name);
Daniel Vetter20228c42013-08-15 00:02:45 +0200711 if (obj) {
Eric Anholt673a3942008-07-30 12:06:12 -0700712 drm_gem_object_reference(obj);
Daniel Vetter20228c42013-08-15 00:02:45 +0200713 } else {
714 mutex_unlock(&dev->object_name_lock);
Eric Anholt673a3942008-07-30 12:06:12 -0700715 return -ENOENT;
Daniel Vetter20228c42013-08-15 00:02:45 +0200716 }
Eric Anholt673a3942008-07-30 12:06:12 -0700717
Daniel Vetter20228c42013-08-15 00:02:45 +0200718 /* drm_gem_handle_create_tail unlocks dev->object_name_lock. */
719 ret = drm_gem_handle_create_tail(file_priv, obj, &handle);
Luca Barbieribc9025b2010-02-09 05:49:12 +0000720 drm_gem_object_unreference_unlocked(obj);
Eric Anholt673a3942008-07-30 12:06:12 -0700721 if (ret)
722 return ret;
723
724 args->handle = handle;
725 args->size = obj->size;
726
727 return 0;
728}
729
730/**
Daniel Vetter89d61fc2014-01-21 12:39:00 +0100731 * gem_gem_open - initalizes GEM file-private structures at devnode open time
732 * @dev: drm_device which is being opened by userspace
733 * @file_private: drm file-private structure to set up
734 *
Eric Anholt673a3942008-07-30 12:06:12 -0700735 * Called at device open time, sets up the structure for handling refcounting
736 * of mm objects.
737 */
738void
739drm_gem_open(struct drm_device *dev, struct drm_file *file_private)
740{
741 idr_init(&file_private->object_idr);
742 spin_lock_init(&file_private->table_lock);
743}
744
Eric Anholt673a3942008-07-30 12:06:12 -0700745/**
Daniel Vetter89d61fc2014-01-21 12:39:00 +0100746 * drm_gem_release - release file-private GEM resources
747 * @dev: drm_device which is being closed by userspace
748 * @file_private: drm file-private structure to clean up
749 *
Eric Anholt673a3942008-07-30 12:06:12 -0700750 * Called at close time when the filp is going away.
751 *
752 * Releases any remaining references on objects by this filp.
753 */
754void
755drm_gem_release(struct drm_device *dev, struct drm_file *file_private)
756{
Eric Anholt673a3942008-07-30 12:06:12 -0700757 idr_for_each(&file_private->object_idr,
Ben Skeggs304eda32011-06-09 00:24:59 +0000758 &drm_gem_object_release_handle, file_private);
Eric Anholt673a3942008-07-30 12:06:12 -0700759 idr_destroy(&file_private->object_idr);
Eric Anholt673a3942008-07-30 12:06:12 -0700760}
761
Daniel Vetterfd632aa2010-04-09 19:05:05 +0000762void
763drm_gem_object_release(struct drm_gem_object *obj)
Luca Barbieric3ae90c2010-02-09 05:49:11 +0000764{
Daniel Vetter319c9332013-08-15 00:02:46 +0200765 WARN_ON(obj->dma_buf);
766
Alan Cox62cb70112011-06-07 14:17:51 +0100767 if (obj->filp)
David Herrmann16d28312014-01-20 20:07:49 +0100768 fput(obj->filp);
David Herrmann77472342014-01-20 20:05:43 +0100769
770 drm_gem_free_mmap_offset(obj);
Luca Barbieric3ae90c2010-02-09 05:49:11 +0000771}
Daniel Vetterfd632aa2010-04-09 19:05:05 +0000772EXPORT_SYMBOL(drm_gem_object_release);
Luca Barbieric3ae90c2010-02-09 05:49:11 +0000773
Eric Anholt673a3942008-07-30 12:06:12 -0700774/**
Daniel Vetter89d61fc2014-01-21 12:39:00 +0100775 * drm_gem_object_free - free a GEM object
776 * @kref: kref of the object to free
777 *
Eric Anholt673a3942008-07-30 12:06:12 -0700778 * Called after the last reference to the object has been lost.
Luca Barbieric3ae90c2010-02-09 05:49:11 +0000779 * Must be called holding struct_ mutex
Eric Anholt673a3942008-07-30 12:06:12 -0700780 *
781 * Frees the object
782 */
783void
784drm_gem_object_free(struct kref *kref)
785{
Daniel Vetter6ff774b2015-10-15 09:36:26 +0200786 struct drm_gem_object *obj =
787 container_of(kref, struct drm_gem_object, refcount);
Eric Anholt673a3942008-07-30 12:06:12 -0700788 struct drm_device *dev = obj->dev;
789
Daniel Vetter8d77a942015-07-09 23:32:35 +0200790 WARN_ON(!mutex_is_locked(&dev->struct_mutex));
Eric Anholt673a3942008-07-30 12:06:12 -0700791
792 if (dev->driver->gem_free_object != NULL)
793 dev->driver->gem_free_object(obj);
Eric Anholt673a3942008-07-30 12:06:12 -0700794}
795EXPORT_SYMBOL(drm_gem_object_free);
796
Daniel Vetterdf2e0902015-10-22 19:11:29 +0200797/**
798 * drm_gem_vm_open - vma->ops->open implementation for GEM
799 * @vma: VM area structure
800 *
801 * This function implements the #vm_operations_struct open() callback for GEM
802 * drivers. This must be used together with drm_gem_vm_close().
803 */
Jesse Barnesab00b3e2009-02-11 14:01:46 -0800804void drm_gem_vm_open(struct vm_area_struct *vma)
805{
806 struct drm_gem_object *obj = vma->vm_private_data;
807
808 drm_gem_object_reference(obj);
809}
810EXPORT_SYMBOL(drm_gem_vm_open);
811
Daniel Vetterdf2e0902015-10-22 19:11:29 +0200812/**
813 * drm_gem_vm_close - vma->ops->close implementation for GEM
814 * @vma: VM area structure
815 *
816 * This function implements the #vm_operations_struct close() callback for GEM
817 * drivers. This must be used together with drm_gem_vm_open().
818 */
Jesse Barnesab00b3e2009-02-11 14:01:46 -0800819void drm_gem_vm_close(struct vm_area_struct *vma)
820{
821 struct drm_gem_object *obj = vma->vm_private_data;
Jesse Barnesab00b3e2009-02-11 14:01:46 -0800822
Daniel Vetter131e6632015-07-09 23:32:33 +0200823 drm_gem_object_unreference_unlocked(obj);
Jesse Barnesab00b3e2009-02-11 14:01:46 -0800824}
825EXPORT_SYMBOL(drm_gem_vm_close);
826
Laurent Pinchart1c5aafa2013-04-16 14:14:52 +0200827/**
828 * drm_gem_mmap_obj - memory map a GEM object
829 * @obj: the GEM object to map
830 * @obj_size: the object size to be mapped, in bytes
831 * @vma: VMA for the area to be mapped
832 *
833 * Set up the VMA to prepare mapping of the GEM object using the gem_vm_ops
834 * provided by the driver. Depending on their requirements, drivers can either
835 * provide a fault handler in their gem_vm_ops (in which case any accesses to
836 * the object will be trapped, to perform migration, GTT binding, surface
837 * register allocation, or performance monitoring), or mmap the buffer memory
838 * synchronously after calling drm_gem_mmap_obj.
839 *
840 * This function is mainly intended to implement the DMABUF mmap operation, when
841 * the GEM object is not looked up based on its fake offset. To implement the
842 * DRM mmap operation, drivers should use the drm_gem_mmap() function.
843 *
David Herrmannca481c92013-08-25 18:28:58 +0200844 * drm_gem_mmap_obj() assumes the user is granted access to the buffer while
845 * drm_gem_mmap() prevents unprivileged users from mapping random objects. So
846 * callers must verify access restrictions before calling this helper.
847 *
Laurent Pinchart1c5aafa2013-04-16 14:14:52 +0200848 * Return 0 or success or -EINVAL if the object size is smaller than the VMA
849 * size, or if no gem_vm_ops are provided.
850 */
851int drm_gem_mmap_obj(struct drm_gem_object *obj, unsigned long obj_size,
852 struct vm_area_struct *vma)
853{
854 struct drm_device *dev = obj->dev;
855
856 /* Check for valid size. */
857 if (obj_size < vma->vm_end - vma->vm_start)
858 return -EINVAL;
859
860 if (!dev->driver->gem_vm_ops)
861 return -EINVAL;
862
863 vma->vm_flags |= VM_IO | VM_PFNMAP | VM_DONTEXPAND | VM_DONTDUMP;
864 vma->vm_ops = dev->driver->gem_vm_ops;
865 vma->vm_private_data = obj;
David Herrmann16d28312014-01-20 20:07:49 +0100866 vma->vm_page_prot = pgprot_writecombine(vm_get_page_prot(vma->vm_flags));
Laurent Pinchart1c5aafa2013-04-16 14:14:52 +0200867
868 /* Take a ref for this mapping of the object, so that the fault
869 * handler can dereference the mmap offset's pointer to the object.
870 * This reference is cleaned up by the corresponding vm_close
871 * (which should happen whether the vma was created by this call, or
872 * by a vm_open due to mremap or partial unmap or whatever).
873 */
874 drm_gem_object_reference(obj);
875
Laurent Pinchart1c5aafa2013-04-16 14:14:52 +0200876 return 0;
877}
878EXPORT_SYMBOL(drm_gem_mmap_obj);
Jesse Barnesab00b3e2009-02-11 14:01:46 -0800879
Jesse Barnesa2c0a972008-11-05 10:31:53 -0800880/**
881 * drm_gem_mmap - memory map routine for GEM objects
882 * @filp: DRM file pointer
883 * @vma: VMA for the area to be mapped
884 *
885 * If a driver supports GEM object mapping, mmap calls on the DRM file
886 * descriptor will end up here.
887 *
Laurent Pinchart1c5aafa2013-04-16 14:14:52 +0200888 * Look up the GEM object based on the offset passed in (vma->vm_pgoff will
Jesse Barnesa2c0a972008-11-05 10:31:53 -0800889 * contain the fake offset we created when the GTT map ioctl was called on
Laurent Pinchart1c5aafa2013-04-16 14:14:52 +0200890 * the object) and map it with a call to drm_gem_mmap_obj().
David Herrmannca481c92013-08-25 18:28:58 +0200891 *
892 * If the caller is not granted access to the buffer object, the mmap will fail
893 * with EACCES. Please see the vma manager for more information.
Jesse Barnesa2c0a972008-11-05 10:31:53 -0800894 */
895int drm_gem_mmap(struct file *filp, struct vm_area_struct *vma)
896{
897 struct drm_file *priv = filp->private_data;
898 struct drm_device *dev = priv->minor->dev;
Daniel Vetter2225cfe2015-10-15 11:33:43 +0200899 struct drm_gem_object *obj = NULL;
David Herrmann0de23972013-07-24 21:07:52 +0200900 struct drm_vma_offset_node *node;
David Herrmanna8469aa2014-01-20 20:15:38 +0100901 int ret;
Jesse Barnesa2c0a972008-11-05 10:31:53 -0800902
Dave Airlie2c07a212012-02-20 14:18:07 +0000903 if (drm_device_is_unplugged(dev))
904 return -ENODEV;
905
Daniel Vetter2225cfe2015-10-15 11:33:43 +0200906 drm_vma_offset_lock_lookup(dev->vma_offset_manager);
907 node = drm_vma_offset_exact_lookup_locked(dev->vma_offset_manager,
908 vma->vm_pgoff,
909 vma_pages(vma));
910 if (likely(node)) {
911 obj = container_of(node, struct drm_gem_object, vma_node);
912 /*
913 * When the object is being freed, after it hits 0-refcnt it
914 * proceeds to tear down the object. In the process it will
915 * attempt to remove the VMA offset and so acquire this
916 * mgr->vm_lock. Therefore if we find an object with a 0-refcnt
917 * that matches our range, we know it is in the process of being
918 * destroyed and will be freed as soon as we release the lock -
919 * so we have to check for the 0-refcnted object and treat it as
920 * invalid.
921 */
922 if (!kref_get_unless_zero(&obj->refcount))
923 obj = NULL;
924 }
925 drm_vma_offset_unlock_lookup(dev->vma_offset_manager);
Jesse Barnesa2c0a972008-11-05 10:31:53 -0800926
Daniel Vetter2225cfe2015-10-15 11:33:43 +0200927 if (!obj)
Daniel Vetter197633b2014-09-23 15:46:48 +0200928 return -EINVAL;
Daniel Vetter2225cfe2015-10-15 11:33:43 +0200929
930 if (!drm_vma_node_is_allowed(node, filp)) {
931 drm_gem_object_unreference_unlocked(obj);
David Herrmannca481c92013-08-25 18:28:58 +0200932 return -EACCES;
Jesse Barnesa2c0a972008-11-05 10:31:53 -0800933 }
934
Daniel Vetter2225cfe2015-10-15 11:33:43 +0200935 ret = drm_gem_mmap_obj(obj, drm_vma_node_size(node) << PAGE_SHIFT,
936 vma);
Jesse Barnesa2c0a972008-11-05 10:31:53 -0800937
Daniel Vetter2225cfe2015-10-15 11:33:43 +0200938 drm_gem_object_unreference_unlocked(obj);
Jesse Barnesa2c0a972008-11-05 10:31:53 -0800939
940 return ret;
941}
942EXPORT_SYMBOL(drm_gem_mmap);