blob: a8d396bed6a46fa683ffb5f47ace8a828e75c2ef [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
Thierry Redinge6b62712017-02-28 15:46:41 +0100221drm_gem_object_handle_put_unlocked(struct drm_gem_object *obj)
Daniel Vetter36da5902013-08-15 00:02:34 +0200222{
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)
Thierry Redinge6b62712017-02-28 15:46:41 +0100244 drm_gem_object_put_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);
David Herrmannd9a1f0b2016-09-01 14:48:33 +0200260 drm_vma_node_revoke(&obj->vma_node, file_priv);
Chris Wilson8815b232016-01-05 09:42:31 +0000261
262 if (dev->driver->gem_close_object)
263 dev->driver->gem_close_object(obj, file_priv);
264
Thierry Redinge6b62712017-02-28 15:46:41 +0100265 drm_gem_object_handle_put_unlocked(obj);
Chris Wilson8815b232016-01-05 09:42:31 +0000266
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{
Eric Anholt673a3942008-07-30 12:06:12 -0700282 struct drm_gem_object *obj;
283
284 /* This is gross. The idr system doesn't let us try a delete and
285 * return an error code. It just spews if you fail at deleting.
286 * So, we have to grab a lock around finding the object and then
287 * doing the delete on it and dropping the refcount, or the user
288 * could race us to double-decrement the refcount and cause a
289 * use-after-free later. Given the frequency of our handle lookups,
290 * we may want to use ida for number allocation and a hash table
291 * for the pointers, anyway.
292 */
293 spin_lock(&filp->table_lock);
294
295 /* Check if we currently have a reference on the object */
Chris Wilsonf6cd7da2016-04-15 12:55:08 +0100296 obj = idr_replace(&filp->object_idr, NULL, handle);
297 spin_unlock(&filp->table_lock);
298 if (IS_ERR_OR_NULL(obj))
Eric Anholt673a3942008-07-30 12:06:12 -0700299 return -EINVAL;
Eric Anholt673a3942008-07-30 12:06:12 -0700300
Chris Wilsonf6cd7da2016-04-15 12:55:08 +0100301 /* Release driver's reference and decrement refcount. */
302 drm_gem_object_release_handle(handle, obj, filp);
303
304 /* And finally make the handle available for future allocations. */
305 spin_lock(&filp->table_lock);
Eric Anholt673a3942008-07-30 12:06:12 -0700306 idr_remove(&filp->object_idr, handle);
307 spin_unlock(&filp->table_lock);
308
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/**
Noralf Trønnesdb611522017-07-23 21:16:17 +0200314 * drm_gem_dumb_map_offset - return the fake mmap offset for a gem object
315 * @file: drm file-private structure containing the gem object
316 * @dev: corresponding drm_device
317 * @handle: gem object handle
318 * @offset: return location for the fake mmap offset
319 *
320 * This implements the &drm_driver.dumb_map_offset kms driver callback for
321 * drivers which use gem to manage their backing storage.
322 *
323 * Returns:
324 * 0 on success or a negative error code on failure.
325 */
326int drm_gem_dumb_map_offset(struct drm_file *file, struct drm_device *dev,
327 u32 handle, u64 *offset)
328{
329 struct drm_gem_object *obj;
330 int ret;
331
332 obj = drm_gem_object_lookup(file, handle);
333 if (!obj)
334 return -ENOENT;
335
336 ret = drm_gem_create_mmap_offset(obj);
337 if (ret)
338 goto out;
339
340 *offset = drm_vma_node_offset_addr(&obj->vma_node);
341out:
342 drm_gem_object_put_unlocked(obj);
343
344 return ret;
345}
346EXPORT_SYMBOL_GPL(drm_gem_dumb_map_offset);
347
348/**
Daniel Vetter43387b32013-07-16 09:12:04 +0200349 * drm_gem_dumb_destroy - dumb fb callback helper for gem based drivers
Daniel Vetter89d61fc2014-01-21 12:39:00 +0100350 * @file: drm file-private structure to remove the dumb handle from
351 * @dev: corresponding drm_device
352 * @handle: the dumb handle to remove
Daniel Vetter43387b32013-07-16 09:12:04 +0200353 *
Daniel Vetter940eba22017-01-25 07:26:46 +0100354 * This implements the &drm_driver.dumb_destroy kms driver callback for drivers
355 * which use gem to manage their backing storage.
Daniel Vetter43387b32013-07-16 09:12:04 +0200356 */
357int drm_gem_dumb_destroy(struct drm_file *file,
358 struct drm_device *dev,
359 uint32_t handle)
360{
361 return drm_gem_handle_delete(file, handle);
362}
363EXPORT_SYMBOL(drm_gem_dumb_destroy);
364
365/**
Daniel Vetter20228c42013-08-15 00:02:45 +0200366 * drm_gem_handle_create_tail - internal functions to create a handle
Daniel Vetter89d61fc2014-01-21 12:39:00 +0100367 * @file_priv: drm file-private structure to register the handle for
368 * @obj: object to register
Thierry Reding8bf81802014-11-03 13:20:52 +0100369 * @handlep: pointer to return the created handle to the caller
Daniel Vetter20228c42013-08-15 00:02:45 +0200370 *
Daniel Vetter940eba22017-01-25 07:26:46 +0100371 * This expects the &drm_device.object_name_lock to be held already and will
372 * drop it before returning. Used to avoid races in establishing new handles
373 * when importing an object from either an flink name or a dma-buf.
Daniel Vetterdf2e0902015-10-22 19:11:29 +0200374 *
375 * Handles must be release again through drm_gem_handle_delete(). This is done
376 * when userspace closes @file_priv for all attached handles, or through the
377 * GEM_CLOSE ioctl for individual handles.
Eric Anholt673a3942008-07-30 12:06:12 -0700378 */
379int
Daniel Vetter20228c42013-08-15 00:02:45 +0200380drm_gem_handle_create_tail(struct drm_file *file_priv,
381 struct drm_gem_object *obj,
382 u32 *handlep)
Eric Anholt673a3942008-07-30 12:06:12 -0700383{
Ben Skeggs304eda32011-06-09 00:24:59 +0000384 struct drm_device *dev = obj->dev;
Chris Wilson9649399e2016-01-05 09:42:30 +0000385 u32 handle;
Ben Skeggs304eda32011-06-09 00:24:59 +0000386 int ret;
Eric Anholt673a3942008-07-30 12:06:12 -0700387
Daniel Vetter20228c42013-08-15 00:02:45 +0200388 WARN_ON(!mutex_is_locked(&dev->object_name_lock));
Chris Wilson98a88832016-01-04 10:11:00 +0000389 if (obj->handle_count++ == 0)
Thierry Redinge6b62712017-02-28 15:46:41 +0100390 drm_gem_object_get(obj);
Daniel Vetter20228c42013-08-15 00:02:45 +0200391
Eric Anholt673a3942008-07-30 12:06:12 -0700392 /*
Tejun Heo2e928812013-02-27 17:04:08 -0800393 * Get the user-visible handle using idr. Preload and perform
394 * allocation under our spinlock.
Eric Anholt673a3942008-07-30 12:06:12 -0700395 */
Tejun Heo2e928812013-02-27 17:04:08 -0800396 idr_preload(GFP_KERNEL);
Eric Anholt673a3942008-07-30 12:06:12 -0700397 spin_lock(&file_priv->table_lock);
Tejun Heo2e928812013-02-27 17:04:08 -0800398
399 ret = idr_alloc(&file_priv->object_idr, obj, 1, 0, GFP_NOWAIT);
Chris Wilson98a88832016-01-04 10:11:00 +0000400
Eric Anholt673a3942008-07-30 12:06:12 -0700401 spin_unlock(&file_priv->table_lock);
Tejun Heo2e928812013-02-27 17:04:08 -0800402 idr_preload_end();
Chris Wilson98a88832016-01-04 10:11:00 +0000403
Daniel Vettercd4f0132013-08-15 00:02:44 +0200404 mutex_unlock(&dev->object_name_lock);
Chris Wilson69841282016-01-04 10:10:59 +0000405 if (ret < 0)
406 goto err_unref;
407
Chris Wilson9649399e2016-01-05 09:42:30 +0000408 handle = ret;
Eric Anholt673a3942008-07-30 12:06:12 -0700409
David Herrmannd9a1f0b2016-09-01 14:48:33 +0200410 ret = drm_vma_node_allow(&obj->vma_node, file_priv);
Chris Wilson69841282016-01-04 10:10:59 +0000411 if (ret)
412 goto err_remove;
Ben Skeggs304eda32011-06-09 00:24:59 +0000413
414 if (dev->driver->gem_open_object) {
415 ret = dev->driver->gem_open_object(obj, file_priv);
Chris Wilson69841282016-01-04 10:10:59 +0000416 if (ret)
417 goto err_revoke;
Ben Skeggs304eda32011-06-09 00:24:59 +0000418 }
419
Chris Wilson9649399e2016-01-05 09:42:30 +0000420 *handlep = handle;
Eric Anholt673a3942008-07-30 12:06:12 -0700421 return 0;
Chris Wilson69841282016-01-04 10:10:59 +0000422
423err_revoke:
David Herrmannd9a1f0b2016-09-01 14:48:33 +0200424 drm_vma_node_revoke(&obj->vma_node, file_priv);
Chris Wilson69841282016-01-04 10:10:59 +0000425err_remove:
426 spin_lock(&file_priv->table_lock);
Chris Wilson9649399e2016-01-05 09:42:30 +0000427 idr_remove(&file_priv->object_idr, handle);
Chris Wilson69841282016-01-04 10:10:59 +0000428 spin_unlock(&file_priv->table_lock);
429err_unref:
Thierry Redinge6b62712017-02-28 15:46:41 +0100430 drm_gem_object_handle_put_unlocked(obj);
Chris Wilson69841282016-01-04 10:10:59 +0000431 return ret;
Eric Anholt673a3942008-07-30 12:06:12 -0700432}
Daniel Vetter20228c42013-08-15 00:02:45 +0200433
434/**
Thierry Reding8bf81802014-11-03 13:20:52 +0100435 * drm_gem_handle_create - create a gem handle for an object
Daniel Vetter89d61fc2014-01-21 12:39:00 +0100436 * @file_priv: drm file-private structure to register the handle for
437 * @obj: object to register
438 * @handlep: pionter to return the created handle to the caller
439 *
Daniel Vetter20228c42013-08-15 00:02:45 +0200440 * Create a handle for this object. This adds a handle reference
441 * to the object, which includes a regular reference count. Callers
442 * will likely want to dereference the object afterwards.
443 */
Thierry Reding8bf81802014-11-03 13:20:52 +0100444int drm_gem_handle_create(struct drm_file *file_priv,
445 struct drm_gem_object *obj,
446 u32 *handlep)
Daniel Vetter20228c42013-08-15 00:02:45 +0200447{
448 mutex_lock(&obj->dev->object_name_lock);
449
450 return drm_gem_handle_create_tail(file_priv, obj, handlep);
451}
Eric Anholt673a3942008-07-30 12:06:12 -0700452EXPORT_SYMBOL(drm_gem_handle_create);
453
Rob Clark75ef8b32011-08-10 08:09:07 -0500454
455/**
456 * drm_gem_free_mmap_offset - release a fake mmap offset for an object
457 * @obj: obj in question
458 *
459 * This routine frees fake offsets allocated by drm_gem_create_mmap_offset().
Daniel Vetterf74418a2016-03-30 11:40:52 +0200460 *
461 * Note that drm_gem_object_release() already calls this function, so drivers
462 * don't have to take care of releasing the mmap offset themselves when freeing
463 * the GEM object.
Rob Clark75ef8b32011-08-10 08:09:07 -0500464 */
465void
466drm_gem_free_mmap_offset(struct drm_gem_object *obj)
467{
468 struct drm_device *dev = obj->dev;
Rob Clark75ef8b32011-08-10 08:09:07 -0500469
Daniel Vetterb04a5902013-12-11 14:24:46 +0100470 drm_vma_offset_remove(dev->vma_offset_manager, &obj->vma_node);
Rob Clark75ef8b32011-08-10 08:09:07 -0500471}
472EXPORT_SYMBOL(drm_gem_free_mmap_offset);
473
474/**
Rob Clark367bbd42013-08-07 13:41:23 -0400475 * drm_gem_create_mmap_offset_size - create a fake mmap offset for an object
476 * @obj: obj in question
477 * @size: the virtual size
478 *
479 * GEM memory mapping works by handing back to userspace a fake mmap offset
480 * it can use in a subsequent mmap(2) call. The DRM core code then looks
481 * up the object based on the offset and sets up the various memory mapping
482 * structures.
483 *
484 * This routine allocates and attaches a fake offset for @obj, in cases where
Daniel Vetter940eba22017-01-25 07:26:46 +0100485 * the virtual size differs from the physical size (ie. &drm_gem_object.size).
486 * Otherwise just use drm_gem_create_mmap_offset().
Daniel Vetterf74418a2016-03-30 11:40:52 +0200487 *
488 * This function is idempotent and handles an already allocated mmap offset
489 * transparently. Drivers do not need to check for this case.
Rob Clark367bbd42013-08-07 13:41:23 -0400490 */
491int
492drm_gem_create_mmap_offset_size(struct drm_gem_object *obj, size_t size)
493{
494 struct drm_device *dev = obj->dev;
Rob Clark367bbd42013-08-07 13:41:23 -0400495
Daniel Vetterb04a5902013-12-11 14:24:46 +0100496 return drm_vma_offset_add(dev->vma_offset_manager, &obj->vma_node,
Rob Clark367bbd42013-08-07 13:41:23 -0400497 size / PAGE_SIZE);
498}
499EXPORT_SYMBOL(drm_gem_create_mmap_offset_size);
500
501/**
Rob Clark75ef8b32011-08-10 08:09:07 -0500502 * drm_gem_create_mmap_offset - create a fake mmap offset for an object
503 * @obj: obj in question
504 *
505 * GEM memory mapping works by handing back to userspace a fake mmap offset
506 * it can use in a subsequent mmap(2) call. The DRM core code then looks
507 * up the object based on the offset and sets up the various memory mapping
508 * structures.
509 *
510 * This routine allocates and attaches a fake offset for @obj.
Daniel Vetterf74418a2016-03-30 11:40:52 +0200511 *
512 * Drivers can call drm_gem_free_mmap_offset() before freeing @obj to release
513 * the fake offset again.
Rob Clark75ef8b32011-08-10 08:09:07 -0500514 */
Rob Clark367bbd42013-08-07 13:41:23 -0400515int drm_gem_create_mmap_offset(struct drm_gem_object *obj)
Rob Clark75ef8b32011-08-10 08:09:07 -0500516{
Rob Clark367bbd42013-08-07 13:41:23 -0400517 return drm_gem_create_mmap_offset_size(obj, obj->size);
Rob Clark75ef8b32011-08-10 08:09:07 -0500518}
519EXPORT_SYMBOL(drm_gem_create_mmap_offset);
520
Rob Clarkbcc5c9d2013-08-07 13:41:24 -0400521/**
522 * drm_gem_get_pages - helper to allocate backing pages for a GEM object
523 * from shmem
524 * @obj: obj in question
David Herrmann0cdbe8a2014-05-25 12:59:47 +0200525 *
526 * This reads the page-array of the shmem-backing storage of the given gem
527 * object. An array of pages is returned. If a page is not allocated or
528 * swapped-out, this will allocate/swap-in the required pages. Note that the
529 * whole object is covered by the page-array and pinned in memory.
530 *
531 * Use drm_gem_put_pages() to release the array and unpin all pages.
532 *
533 * This uses the GFP-mask set on the shmem-mapping (see mapping_set_gfp_mask()).
534 * If you require other GFP-masks, you have to do those allocations yourself.
535 *
536 * Note that you are not allowed to change gfp-zones during runtime. That is,
537 * shmem_read_mapping_page_gfp() must be called with the same gfp_zone(gfp) as
538 * set during initialization. If you have special zone constraints, set them
539 * after drm_gem_init_object() via mapping_set_gfp_mask(). shmem-core takes care
540 * to keep pages in the required zone during swap-in.
Rob Clarkbcc5c9d2013-08-07 13:41:24 -0400541 */
David Herrmann0cdbe8a2014-05-25 12:59:47 +0200542struct page **drm_gem_get_pages(struct drm_gem_object *obj)
Rob Clarkbcc5c9d2013-08-07 13:41:24 -0400543{
Rob Clarkbcc5c9d2013-08-07 13:41:24 -0400544 struct address_space *mapping;
545 struct page *p, **pages;
546 int i, npages;
547
548 /* This is the shared memory object that backs the GEM resource */
Al Viro93c76a32015-12-04 23:45:44 -0500549 mapping = obj->filp->f_mapping;
Rob Clarkbcc5c9d2013-08-07 13:41:24 -0400550
551 /* We already BUG_ON() for non-page-aligned sizes in
552 * drm_gem_object_init(), so we should never hit this unless
553 * driver author is doing something really wrong:
554 */
555 WARN_ON((obj->size & (PAGE_SIZE - 1)) != 0);
556
557 npages = obj->size >> PAGE_SHIFT;
558
Michal Hocko20981052017-05-17 14:23:12 +0200559 pages = kvmalloc_array(npages, sizeof(struct page *), GFP_KERNEL);
Rob Clarkbcc5c9d2013-08-07 13:41:24 -0400560 if (pages == NULL)
561 return ERR_PTR(-ENOMEM);
562
Rob Clarkbcc5c9d2013-08-07 13:41:24 -0400563 for (i = 0; i < npages; i++) {
David Herrmann0cdbe8a2014-05-25 12:59:47 +0200564 p = shmem_read_mapping_page(mapping, i);
Rob Clarkbcc5c9d2013-08-07 13:41:24 -0400565 if (IS_ERR(p))
566 goto fail;
567 pages[i] = p;
568
David Herrmann21230002014-05-25 14:34:08 +0200569 /* Make sure shmem keeps __GFP_DMA32 allocated pages in the
570 * correct region during swapin. Note that this requires
571 * __GFP_DMA32 to be set in mapping_gfp_mask(inode->i_mapping)
572 * so shmem can relocate pages during swapin if required.
Rob Clarkbcc5c9d2013-08-07 13:41:24 -0400573 */
Michal Hockoc62d2552015-11-06 16:28:49 -0800574 BUG_ON(mapping_gfp_constraint(mapping, __GFP_DMA32) &&
Rob Clarkbcc5c9d2013-08-07 13:41:24 -0400575 (page_to_pfn(p) >= 0x00100000UL));
576 }
577
578 return pages;
579
580fail:
581 while (i--)
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300582 put_page(pages[i]);
Rob Clarkbcc5c9d2013-08-07 13:41:24 -0400583
Michal Hocko20981052017-05-17 14:23:12 +0200584 kvfree(pages);
Rob Clarkbcc5c9d2013-08-07 13:41:24 -0400585 return ERR_CAST(p);
586}
587EXPORT_SYMBOL(drm_gem_get_pages);
588
589/**
590 * drm_gem_put_pages - helper to free backing pages for a GEM object
591 * @obj: obj in question
592 * @pages: pages to free
593 * @dirty: if true, pages will be marked as dirty
594 * @accessed: if true, the pages will be marked as accessed
595 */
596void drm_gem_put_pages(struct drm_gem_object *obj, struct page **pages,
597 bool dirty, bool accessed)
598{
599 int i, npages;
600
601 /* We already BUG_ON() for non-page-aligned sizes in
602 * drm_gem_object_init(), so we should never hit this unless
603 * driver author is doing something really wrong:
604 */
605 WARN_ON((obj->size & (PAGE_SIZE - 1)) != 0);
606
607 npages = obj->size >> PAGE_SHIFT;
608
609 for (i = 0; i < npages; i++) {
610 if (dirty)
611 set_page_dirty(pages[i]);
612
613 if (accessed)
614 mark_page_accessed(pages[i]);
615
616 /* Undo the reference we took when populating the table */
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300617 put_page(pages[i]);
Rob Clarkbcc5c9d2013-08-07 13:41:24 -0400618 }
619
Michal Hocko20981052017-05-17 14:23:12 +0200620 kvfree(pages);
Rob Clarkbcc5c9d2013-08-07 13:41:24 -0400621}
622EXPORT_SYMBOL(drm_gem_put_pages);
623
Daniel Vetterdf2e0902015-10-22 19:11:29 +0200624/**
625 * drm_gem_object_lookup - look up a GEM object from it's handle
Daniel Vetterdf2e0902015-10-22 19:11:29 +0200626 * @filp: DRM file private date
627 * @handle: userspace handle
628 *
629 * Returns:
630 *
631 * A reference to the object named by the handle if such exists on @filp, NULL
632 * otherwise.
633 */
Eric Anholt673a3942008-07-30 12:06:12 -0700634struct drm_gem_object *
Chris Wilsona8ad0bd2016-05-09 11:04:54 +0100635drm_gem_object_lookup(struct drm_file *filp, u32 handle)
Eric Anholt673a3942008-07-30 12:06:12 -0700636{
637 struct drm_gem_object *obj;
638
639 spin_lock(&filp->table_lock);
640
641 /* Check if we currently have a reference on the object */
642 obj = idr_find(&filp->object_idr, handle);
Chris Wilsona8ad0bd2016-05-09 11:04:54 +0100643 if (obj)
Thierry Redinge6b62712017-02-28 15:46:41 +0100644 drm_gem_object_get(obj);
Eric Anholt673a3942008-07-30 12:06:12 -0700645
646 spin_unlock(&filp->table_lock);
647
648 return obj;
649}
650EXPORT_SYMBOL(drm_gem_object_lookup);
651
652/**
Daniel Vetter89d61fc2014-01-21 12:39:00 +0100653 * drm_gem_close_ioctl - implementation of the GEM_CLOSE ioctl
654 * @dev: drm_device
655 * @data: ioctl data
656 * @file_priv: drm file-private structure
657 *
Eric Anholt673a3942008-07-30 12:06:12 -0700658 * Releases the handle to an mm object.
659 */
660int
661drm_gem_close_ioctl(struct drm_device *dev, void *data,
662 struct drm_file *file_priv)
663{
664 struct drm_gem_close *args = data;
665 int ret;
666
Andrzej Hajda1bcecfa2014-09-30 16:49:56 +0200667 if (!drm_core_check_feature(dev, DRIVER_GEM))
Eric Anholt673a3942008-07-30 12:06:12 -0700668 return -ENODEV;
669
670 ret = drm_gem_handle_delete(file_priv, args->handle);
671
672 return ret;
673}
674
675/**
Daniel Vetter89d61fc2014-01-21 12:39:00 +0100676 * drm_gem_flink_ioctl - implementation of the GEM_FLINK ioctl
677 * @dev: drm_device
678 * @data: ioctl data
679 * @file_priv: drm file-private structure
680 *
Eric Anholt673a3942008-07-30 12:06:12 -0700681 * Create a global name for an object, returning the name.
682 *
683 * Note that the name does not hold a reference; when the object
684 * is freed, the name goes away.
685 */
686int
687drm_gem_flink_ioctl(struct drm_device *dev, void *data,
688 struct drm_file *file_priv)
689{
690 struct drm_gem_flink *args = data;
691 struct drm_gem_object *obj;
692 int ret;
693
Andrzej Hajda1bcecfa2014-09-30 16:49:56 +0200694 if (!drm_core_check_feature(dev, DRIVER_GEM))
Eric Anholt673a3942008-07-30 12:06:12 -0700695 return -ENODEV;
696
Chris Wilsona8ad0bd2016-05-09 11:04:54 +0100697 obj = drm_gem_object_lookup(file_priv, args->handle);
Eric Anholt673a3942008-07-30 12:06:12 -0700698 if (obj == NULL)
Chris Wilsonbf79cb92010-08-04 14:19:46 +0100699 return -ENOENT;
Eric Anholt673a3942008-07-30 12:06:12 -0700700
Daniel Vettercd4f0132013-08-15 00:02:44 +0200701 mutex_lock(&dev->object_name_lock);
Daniel Vettera8e11d12013-08-15 00:02:37 +0200702 /* prevent races with concurrent gem_close. */
703 if (obj->handle_count == 0) {
704 ret = -ENOENT;
705 goto err;
706 }
707
Chris Wilson8d59bae2009-02-11 14:26:28 +0000708 if (!obj->name) {
Chris Wilson0f646422016-01-04 10:11:01 +0000709 ret = idr_alloc(&dev->object_name_idr, obj, 1, 0, GFP_KERNEL);
Tejun Heo2e928812013-02-27 17:04:08 -0800710 if (ret < 0)
Chris Wilson8d59bae2009-02-11 14:26:28 +0000711 goto err;
YoungJun Cho2e07fb22013-06-27 08:58:33 +0900712
713 obj->name = ret;
Eric Anholt673a3942008-07-30 12:06:12 -0700714 }
Chris Wilson3e49c4f2009-02-09 11:31:41 +0000715
YoungJun Cho2e07fb22013-06-27 08:58:33 +0900716 args->name = (uint64_t) obj->name;
717 ret = 0;
718
Chris Wilson3e49c4f2009-02-09 11:31:41 +0000719err:
Daniel Vettercd4f0132013-08-15 00:02:44 +0200720 mutex_unlock(&dev->object_name_lock);
Thierry Redinge6b62712017-02-28 15:46:41 +0100721 drm_gem_object_put_unlocked(obj);
Chris Wilson3e49c4f2009-02-09 11:31:41 +0000722 return ret;
Eric Anholt673a3942008-07-30 12:06:12 -0700723}
724
725/**
Daniel Vetter89d61fc2014-01-21 12:39:00 +0100726 * drm_gem_open - implementation of the GEM_OPEN ioctl
727 * @dev: drm_device
728 * @data: ioctl data
729 * @file_priv: drm file-private structure
730 *
Eric Anholt673a3942008-07-30 12:06:12 -0700731 * Open an object using the global name, returning a handle and the size.
732 *
733 * This handle (of course) holds a reference to the object, so the object
734 * will not go away until the handle is deleted.
735 */
736int
737drm_gem_open_ioctl(struct drm_device *dev, void *data,
738 struct drm_file *file_priv)
739{
740 struct drm_gem_open *args = data;
741 struct drm_gem_object *obj;
742 int ret;
Pekka Paalanena1a2d1d2009-08-23 12:40:55 +0300743 u32 handle;
Eric Anholt673a3942008-07-30 12:06:12 -0700744
Andrzej Hajda1bcecfa2014-09-30 16:49:56 +0200745 if (!drm_core_check_feature(dev, DRIVER_GEM))
Eric Anholt673a3942008-07-30 12:06:12 -0700746 return -ENODEV;
747
Daniel Vettercd4f0132013-08-15 00:02:44 +0200748 mutex_lock(&dev->object_name_lock);
Eric Anholt673a3942008-07-30 12:06:12 -0700749 obj = idr_find(&dev->object_name_idr, (int) args->name);
Daniel Vetter20228c42013-08-15 00:02:45 +0200750 if (obj) {
Thierry Redinge6b62712017-02-28 15:46:41 +0100751 drm_gem_object_get(obj);
Daniel Vetter20228c42013-08-15 00:02:45 +0200752 } else {
753 mutex_unlock(&dev->object_name_lock);
Eric Anholt673a3942008-07-30 12:06:12 -0700754 return -ENOENT;
Daniel Vetter20228c42013-08-15 00:02:45 +0200755 }
Eric Anholt673a3942008-07-30 12:06:12 -0700756
Daniel Vetter20228c42013-08-15 00:02:45 +0200757 /* drm_gem_handle_create_tail unlocks dev->object_name_lock. */
758 ret = drm_gem_handle_create_tail(file_priv, obj, &handle);
Thierry Redinge6b62712017-02-28 15:46:41 +0100759 drm_gem_object_put_unlocked(obj);
Eric Anholt673a3942008-07-30 12:06:12 -0700760 if (ret)
761 return ret;
762
763 args->handle = handle;
764 args->size = obj->size;
765
766 return 0;
767}
768
769/**
Daniel Vetter89d61fc2014-01-21 12:39:00 +0100770 * gem_gem_open - initalizes GEM file-private structures at devnode open time
771 * @dev: drm_device which is being opened by userspace
772 * @file_private: drm file-private structure to set up
773 *
Eric Anholt673a3942008-07-30 12:06:12 -0700774 * Called at device open time, sets up the structure for handling refcounting
775 * of mm objects.
776 */
777void
778drm_gem_open(struct drm_device *dev, struct drm_file *file_private)
779{
780 idr_init(&file_private->object_idr);
781 spin_lock_init(&file_private->table_lock);
782}
783
Eric Anholt673a3942008-07-30 12:06:12 -0700784/**
Daniel Vetter89d61fc2014-01-21 12:39:00 +0100785 * drm_gem_release - release file-private GEM resources
786 * @dev: drm_device which is being closed by userspace
787 * @file_private: drm file-private structure to clean up
788 *
Eric Anholt673a3942008-07-30 12:06:12 -0700789 * Called at close time when the filp is going away.
790 *
791 * Releases any remaining references on objects by this filp.
792 */
793void
794drm_gem_release(struct drm_device *dev, struct drm_file *file_private)
795{
Eric Anholt673a3942008-07-30 12:06:12 -0700796 idr_for_each(&file_private->object_idr,
Ben Skeggs304eda32011-06-09 00:24:59 +0000797 &drm_gem_object_release_handle, file_private);
Eric Anholt673a3942008-07-30 12:06:12 -0700798 idr_destroy(&file_private->object_idr);
Eric Anholt673a3942008-07-30 12:06:12 -0700799}
800
Daniel Vetterf74418a2016-03-30 11:40:52 +0200801/**
802 * drm_gem_object_release - release GEM buffer object resources
803 * @obj: GEM buffer object
804 *
805 * This releases any structures and resources used by @obj and is the invers of
806 * drm_gem_object_init().
807 */
Daniel Vetterfd632aa2010-04-09 19:05:05 +0000808void
809drm_gem_object_release(struct drm_gem_object *obj)
Luca Barbieric3ae90c2010-02-09 05:49:11 +0000810{
Daniel Vetter319c9332013-08-15 00:02:46 +0200811 WARN_ON(obj->dma_buf);
812
Alan Cox62cb70112011-06-07 14:17:51 +0100813 if (obj->filp)
David Herrmann16d28312014-01-20 20:07:49 +0100814 fput(obj->filp);
David Herrmann77472342014-01-20 20:05:43 +0100815
816 drm_gem_free_mmap_offset(obj);
Luca Barbieric3ae90c2010-02-09 05:49:11 +0000817}
Daniel Vetterfd632aa2010-04-09 19:05:05 +0000818EXPORT_SYMBOL(drm_gem_object_release);
Luca Barbieric3ae90c2010-02-09 05:49:11 +0000819
Eric Anholt673a3942008-07-30 12:06:12 -0700820/**
Daniel Vetter89d61fc2014-01-21 12:39:00 +0100821 * drm_gem_object_free - free a GEM object
822 * @kref: kref of the object to free
823 *
Eric Anholt673a3942008-07-30 12:06:12 -0700824 * Called after the last reference to the object has been lost.
Daniel Vetter940eba22017-01-25 07:26:46 +0100825 * Must be called holding &drm_device.struct_mutex.
Eric Anholt673a3942008-07-30 12:06:12 -0700826 *
827 * Frees the object
828 */
829void
830drm_gem_object_free(struct kref *kref)
831{
Daniel Vetter6ff774b2015-10-15 09:36:26 +0200832 struct drm_gem_object *obj =
833 container_of(kref, struct drm_gem_object, refcount);
Eric Anholt673a3942008-07-30 12:06:12 -0700834 struct drm_device *dev = obj->dev;
835
Daniel Vetter6d3e7fd2016-05-04 14:10:44 +0200836 if (dev->driver->gem_free_object_unlocked) {
Daniel Vetter9f0ba532016-05-02 10:40:51 +0200837 dev->driver->gem_free_object_unlocked(obj);
Daniel Vetter6d3e7fd2016-05-04 14:10:44 +0200838 } else if (dev->driver->gem_free_object) {
839 WARN_ON(!mutex_is_locked(&dev->struct_mutex));
840
Eric Anholt673a3942008-07-30 12:06:12 -0700841 dev->driver->gem_free_object(obj);
Daniel Vetter6d3e7fd2016-05-04 14:10:44 +0200842 }
Eric Anholt673a3942008-07-30 12:06:12 -0700843}
844EXPORT_SYMBOL(drm_gem_object_free);
845
Daniel Vetterdf2e0902015-10-22 19:11:29 +0200846/**
Thierry Redinge6b62712017-02-28 15:46:41 +0100847 * drm_gem_object_put_unlocked - drop a GEM buffer object reference
Daniel Vetter9f0ba532016-05-02 10:40:51 +0200848 * @obj: GEM buffer object
849 *
850 * This releases a reference to @obj. Callers must not hold the
Daniel Vetter940eba22017-01-25 07:26:46 +0100851 * &drm_device.struct_mutex lock when calling this function.
Daniel Vetter9f0ba532016-05-02 10:40:51 +0200852 *
Thierry Redinge6b62712017-02-28 15:46:41 +0100853 * See also __drm_gem_object_put().
Daniel Vetter9f0ba532016-05-02 10:40:51 +0200854 */
855void
Thierry Redinge6b62712017-02-28 15:46:41 +0100856drm_gem_object_put_unlocked(struct drm_gem_object *obj)
Daniel Vetter9f0ba532016-05-02 10:40:51 +0200857{
858 struct drm_device *dev;
859
860 if (!obj)
861 return;
862
863 dev = obj->dev;
Daniel Vetter9f0ba532016-05-02 10:40:51 +0200864
Daniel Vetter3379c042017-07-15 11:53:28 +0200865 if (dev->driver->gem_free_object_unlocked) {
Daniel Vetter9f0ba532016-05-02 10:40:51 +0200866 kref_put(&obj->refcount, drm_gem_object_free);
Daniel Vetter3379c042017-07-15 11:53:28 +0200867 } else {
868 might_lock(&dev->struct_mutex);
869 if (kref_put_mutex(&obj->refcount, drm_gem_object_free,
Daniel Vetter9f0ba532016-05-02 10:40:51 +0200870 &dev->struct_mutex))
Daniel Vetter3379c042017-07-15 11:53:28 +0200871 mutex_unlock(&dev->struct_mutex);
872 }
Daniel Vetter9f0ba532016-05-02 10:40:51 +0200873}
Thierry Redinge6b62712017-02-28 15:46:41 +0100874EXPORT_SYMBOL(drm_gem_object_put_unlocked);
Daniel Vetter9f0ba532016-05-02 10:40:51 +0200875
876/**
Thierry Redinge6b62712017-02-28 15:46:41 +0100877 * drm_gem_object_put - release a GEM buffer object reference
Daniel Vetter9f0ba532016-05-02 10:40:51 +0200878 * @obj: GEM buffer object
879 *
Daniel Vetter940eba22017-01-25 07:26:46 +0100880 * This releases a reference to @obj. Callers must hold the
881 * &drm_device.struct_mutex lock when calling this function, even when the
882 * driver doesn't use &drm_device.struct_mutex for anything.
Daniel Vetter9f0ba532016-05-02 10:40:51 +0200883 *
884 * For drivers not encumbered with legacy locking use
Thierry Redinge6b62712017-02-28 15:46:41 +0100885 * drm_gem_object_put_unlocked() instead.
Daniel Vetter9f0ba532016-05-02 10:40:51 +0200886 */
887void
Thierry Redinge6b62712017-02-28 15:46:41 +0100888drm_gem_object_put(struct drm_gem_object *obj)
Daniel Vetter9f0ba532016-05-02 10:40:51 +0200889{
890 if (obj) {
891 WARN_ON(!mutex_is_locked(&obj->dev->struct_mutex));
892
893 kref_put(&obj->refcount, drm_gem_object_free);
894 }
895}
Thierry Redinge6b62712017-02-28 15:46:41 +0100896EXPORT_SYMBOL(drm_gem_object_put);
Daniel Vetter9f0ba532016-05-02 10:40:51 +0200897
898/**
Daniel Vetterdf2e0902015-10-22 19:11:29 +0200899 * drm_gem_vm_open - vma->ops->open implementation for GEM
900 * @vma: VM area structure
901 *
902 * This function implements the #vm_operations_struct open() callback for GEM
903 * drivers. This must be used together with drm_gem_vm_close().
904 */
Jesse Barnesab00b3e2009-02-11 14:01:46 -0800905void drm_gem_vm_open(struct vm_area_struct *vma)
906{
907 struct drm_gem_object *obj = vma->vm_private_data;
908
Thierry Redinge6b62712017-02-28 15:46:41 +0100909 drm_gem_object_get(obj);
Jesse Barnesab00b3e2009-02-11 14:01:46 -0800910}
911EXPORT_SYMBOL(drm_gem_vm_open);
912
Daniel Vetterdf2e0902015-10-22 19:11:29 +0200913/**
914 * drm_gem_vm_close - vma->ops->close implementation for GEM
915 * @vma: VM area structure
916 *
917 * This function implements the #vm_operations_struct close() callback for GEM
918 * drivers. This must be used together with drm_gem_vm_open().
919 */
Jesse Barnesab00b3e2009-02-11 14:01:46 -0800920void drm_gem_vm_close(struct vm_area_struct *vma)
921{
922 struct drm_gem_object *obj = vma->vm_private_data;
Jesse Barnesab00b3e2009-02-11 14:01:46 -0800923
Thierry Redinge6b62712017-02-28 15:46:41 +0100924 drm_gem_object_put_unlocked(obj);
Jesse Barnesab00b3e2009-02-11 14:01:46 -0800925}
926EXPORT_SYMBOL(drm_gem_vm_close);
927
Laurent Pinchart1c5aafa2013-04-16 14:14:52 +0200928/**
929 * drm_gem_mmap_obj - memory map a GEM object
930 * @obj: the GEM object to map
931 * @obj_size: the object size to be mapped, in bytes
932 * @vma: VMA for the area to be mapped
933 *
934 * Set up the VMA to prepare mapping of the GEM object using the gem_vm_ops
935 * provided by the driver. Depending on their requirements, drivers can either
936 * provide a fault handler in their gem_vm_ops (in which case any accesses to
937 * the object will be trapped, to perform migration, GTT binding, surface
938 * register allocation, or performance monitoring), or mmap the buffer memory
939 * synchronously after calling drm_gem_mmap_obj.
940 *
941 * This function is mainly intended to implement the DMABUF mmap operation, when
942 * the GEM object is not looked up based on its fake offset. To implement the
943 * DRM mmap operation, drivers should use the drm_gem_mmap() function.
944 *
David Herrmannca481c92013-08-25 18:28:58 +0200945 * drm_gem_mmap_obj() assumes the user is granted access to the buffer while
946 * drm_gem_mmap() prevents unprivileged users from mapping random objects. So
947 * callers must verify access restrictions before calling this helper.
948 *
Laurent Pinchart1c5aafa2013-04-16 14:14:52 +0200949 * Return 0 or success or -EINVAL if the object size is smaller than the VMA
950 * size, or if no gem_vm_ops are provided.
951 */
952int drm_gem_mmap_obj(struct drm_gem_object *obj, unsigned long obj_size,
953 struct vm_area_struct *vma)
954{
955 struct drm_device *dev = obj->dev;
956
957 /* Check for valid size. */
958 if (obj_size < vma->vm_end - vma->vm_start)
959 return -EINVAL;
960
961 if (!dev->driver->gem_vm_ops)
962 return -EINVAL;
963
964 vma->vm_flags |= VM_IO | VM_PFNMAP | VM_DONTEXPAND | VM_DONTDUMP;
965 vma->vm_ops = dev->driver->gem_vm_ops;
966 vma->vm_private_data = obj;
David Herrmann16d28312014-01-20 20:07:49 +0100967 vma->vm_page_prot = pgprot_writecombine(vm_get_page_prot(vma->vm_flags));
Laurent Pinchart1c5aafa2013-04-16 14:14:52 +0200968
969 /* Take a ref for this mapping of the object, so that the fault
970 * handler can dereference the mmap offset's pointer to the object.
971 * This reference is cleaned up by the corresponding vm_close
972 * (which should happen whether the vma was created by this call, or
973 * by a vm_open due to mremap or partial unmap or whatever).
974 */
Thierry Redinge6b62712017-02-28 15:46:41 +0100975 drm_gem_object_get(obj);
Laurent Pinchart1c5aafa2013-04-16 14:14:52 +0200976
Laurent Pinchart1c5aafa2013-04-16 14:14:52 +0200977 return 0;
978}
979EXPORT_SYMBOL(drm_gem_mmap_obj);
Jesse Barnesab00b3e2009-02-11 14:01:46 -0800980
Jesse Barnesa2c0a972008-11-05 10:31:53 -0800981/**
982 * drm_gem_mmap - memory map routine for GEM objects
983 * @filp: DRM file pointer
984 * @vma: VMA for the area to be mapped
985 *
986 * If a driver supports GEM object mapping, mmap calls on the DRM file
987 * descriptor will end up here.
988 *
Laurent Pinchart1c5aafa2013-04-16 14:14:52 +0200989 * Look up the GEM object based on the offset passed in (vma->vm_pgoff will
Jesse Barnesa2c0a972008-11-05 10:31:53 -0800990 * contain the fake offset we created when the GTT map ioctl was called on
Laurent Pinchart1c5aafa2013-04-16 14:14:52 +0200991 * the object) and map it with a call to drm_gem_mmap_obj().
David Herrmannca481c92013-08-25 18:28:58 +0200992 *
993 * If the caller is not granted access to the buffer object, the mmap will fail
994 * with EACCES. Please see the vma manager for more information.
Jesse Barnesa2c0a972008-11-05 10:31:53 -0800995 */
996int drm_gem_mmap(struct file *filp, struct vm_area_struct *vma)
997{
998 struct drm_file *priv = filp->private_data;
999 struct drm_device *dev = priv->minor->dev;
Daniel Vetter2225cfe2015-10-15 11:33:43 +02001000 struct drm_gem_object *obj = NULL;
David Herrmann0de23972013-07-24 21:07:52 +02001001 struct drm_vma_offset_node *node;
David Herrmanna8469aa2014-01-20 20:15:38 +01001002 int ret;
Jesse Barnesa2c0a972008-11-05 10:31:53 -08001003
Dave Airlie2c07a212012-02-20 14:18:07 +00001004 if (drm_device_is_unplugged(dev))
1005 return -ENODEV;
1006
Daniel Vetter2225cfe2015-10-15 11:33:43 +02001007 drm_vma_offset_lock_lookup(dev->vma_offset_manager);
1008 node = drm_vma_offset_exact_lookup_locked(dev->vma_offset_manager,
1009 vma->vm_pgoff,
1010 vma_pages(vma));
1011 if (likely(node)) {
1012 obj = container_of(node, struct drm_gem_object, vma_node);
1013 /*
1014 * When the object is being freed, after it hits 0-refcnt it
1015 * proceeds to tear down the object. In the process it will
1016 * attempt to remove the VMA offset and so acquire this
1017 * mgr->vm_lock. Therefore if we find an object with a 0-refcnt
1018 * that matches our range, we know it is in the process of being
1019 * destroyed and will be freed as soon as we release the lock -
1020 * so we have to check for the 0-refcnted object and treat it as
1021 * invalid.
1022 */
1023 if (!kref_get_unless_zero(&obj->refcount))
1024 obj = NULL;
1025 }
1026 drm_vma_offset_unlock_lookup(dev->vma_offset_manager);
Jesse Barnesa2c0a972008-11-05 10:31:53 -08001027
Daniel Vetter2225cfe2015-10-15 11:33:43 +02001028 if (!obj)
Daniel Vetter197633b2014-09-23 15:46:48 +02001029 return -EINVAL;
Daniel Vetter2225cfe2015-10-15 11:33:43 +02001030
David Herrmannd9a1f0b2016-09-01 14:48:33 +02001031 if (!drm_vma_node_is_allowed(node, priv)) {
Thierry Redinge6b62712017-02-28 15:46:41 +01001032 drm_gem_object_put_unlocked(obj);
David Herrmannca481c92013-08-25 18:28:58 +02001033 return -EACCES;
Jesse Barnesa2c0a972008-11-05 10:31:53 -08001034 }
1035
Daniel Vetter2225cfe2015-10-15 11:33:43 +02001036 ret = drm_gem_mmap_obj(obj, drm_vma_node_size(node) << PAGE_SHIFT,
1037 vma);
Jesse Barnesa2c0a972008-11-05 10:31:53 -08001038
Thierry Redinge6b62712017-02-28 15:46:41 +01001039 drm_gem_object_put_unlocked(obj);
Jesse Barnesa2c0a972008-11-05 10:31:53 -08001040
1041 return ret;
1042}
1043EXPORT_SYMBOL(drm_gem_mmap);