Commit | Line | Data |
---|---|---|
673a394b EA |
1 | /* |
2 | * Copyright © 2008 Intel Corporation | |
3 | * | |
4 | * Permission is hereby granted, free of charge, to any person obtaining a | |
5 | * copy of this software and associated documentation files (the "Software"), | |
6 | * to deal in the Software without restriction, including without limitation | |
7 | * the rights to use, copy, modify, merge, publish, distribute, sublicense, | |
8 | * and/or sell copies of the Software, and to permit persons to whom the | |
9 | * Software is furnished to do so, subject to the following conditions: | |
10 | * | |
11 | * The above copyright notice and this permission notice (including the next | |
12 | * paragraph) shall be included in all copies or substantial portions of the | |
13 | * Software. | |
14 | * | |
15 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
16 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
17 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL | |
18 | * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
19 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING | |
20 | * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS | |
21 | * IN THE SOFTWARE. | |
22 | * | |
23 | * Authors: | |
24 | * Eric Anholt <eric@anholt.net> | |
25 | * | |
26 | */ | |
27 | ||
28 | #include <linux/types.h> | |
29 | #include <linux/slab.h> | |
30 | #include <linux/mm.h> | |
31 | #include <linux/uaccess.h> | |
32 | #include <linux/fs.h> | |
33 | #include <linux/file.h> | |
34 | #include <linux/module.h> | |
35 | #include <linux/mman.h> | |
36 | #include <linux/pagemap.h> | |
5949eac4 | 37 | #include <linux/shmem_fs.h> |
3248877e | 38 | #include <linux/dma-buf.h> |
760285e7 | 39 | #include <drm/drmP.h> |
0de23977 | 40 | #include <drm/drm_vma_manager.h> |
d9fc9413 | 41 | #include <drm/drm_gem.h> |
67d0ec4e | 42 | #include "drm_internal.h" |
673a394b EA |
43 | |
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 | ||
a2c0a97b JB |
72 | /* |
73 | * We make up offsets for buffer objects so we can recognize them at | |
74 | * mmap time. | |
75 | */ | |
05269a3a JC |
76 | |
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 | |
a2c0a97b JB |
82 | #define DRM_FILE_PAGE_OFFSET_START ((0xFFFFFFFFUL >> PAGE_SHIFT) + 1) |
83 | #define DRM_FILE_PAGE_OFFSET_SIZE ((0xFFFFFFFFUL >> PAGE_SHIFT) * 16) | |
05269a3a JC |
84 | #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 | |
a2c0a97b | 88 | |
673a394b | 89 | /** |
89d61fc0 DV |
90 | * drm_gem_init - Initialize the GEM device fields |
91 | * @dev: drm_devic structure to initialize | |
673a394b | 92 | */ |
673a394b EA |
93 | int |
94 | drm_gem_init(struct drm_device *dev) | |
95 | { | |
b04a5906 | 96 | struct drm_vma_offset_manager *vma_offset_manager; |
a2c0a97b | 97 | |
cd4f013f | 98 | mutex_init(&dev->object_name_lock); |
673a394b | 99 | idr_init(&dev->object_name_idr); |
a2c0a97b | 100 | |
b04a5906 DV |
101 | vma_offset_manager = kzalloc(sizeof(*vma_offset_manager), GFP_KERNEL); |
102 | if (!vma_offset_manager) { | |
a2c0a97b JB |
103 | DRM_ERROR("out of memory\n"); |
104 | return -ENOMEM; | |
105 | } | |
106 | ||
b04a5906 DV |
107 | dev->vma_offset_manager = vma_offset_manager; |
108 | drm_vma_offset_manager_init(vma_offset_manager, | |
0de23977 DH |
109 | DRM_FILE_PAGE_OFFSET_START, |
110 | DRM_FILE_PAGE_OFFSET_SIZE); | |
a2c0a97b | 111 | |
673a394b EA |
112 | return 0; |
113 | } | |
114 | ||
a2c0a97b JB |
115 | void |
116 | drm_gem_destroy(struct drm_device *dev) | |
117 | { | |
a2c0a97b | 118 | |
b04a5906 DV |
119 | drm_vma_offset_manager_destroy(dev->vma_offset_manager); |
120 | kfree(dev->vma_offset_manager); | |
121 | dev->vma_offset_manager = NULL; | |
a2c0a97b JB |
122 | } |
123 | ||
1d397043 | 124 | /** |
89d61fc0 DV |
125 | * 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 | * | |
62cb7011 | 130 | * Initialize an already allocated GEM object of the specified size with |
1d397043 DV |
131 | * shmfs backing store. |
132 | */ | |
133 | int drm_gem_object_init(struct drm_device *dev, | |
134 | struct drm_gem_object *obj, size_t size) | |
135 | { | |
89c8233f | 136 | struct file *filp; |
1d397043 | 137 | |
6ab11a26 DV |
138 | drm_gem_private_object_init(dev, obj, size); |
139 | ||
89c8233f DH |
140 | filp = shmem_file_setup("drm mm object", size, VM_NORESERVE); |
141 | if (IS_ERR(filp)) | |
142 | return PTR_ERR(filp); | |
1d397043 | 143 | |
89c8233f | 144 | obj->filp = filp; |
1d397043 | 145 | |
1d397043 DV |
146 | return 0; |
147 | } | |
148 | EXPORT_SYMBOL(drm_gem_object_init); | |
149 | ||
62cb7011 | 150 | /** |
2a5706a3 | 151 | * drm_gem_private_object_init - initialize an allocated private GEM object |
89d61fc0 DV |
152 | * @dev: drm_device the object should be initialized for |
153 | * @obj: drm_gem_object to initialize | |
154 | * @size: object size | |
155 | * | |
62cb7011 AC |
156 | * 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 | */ | |
89c8233f DH |
160 | void drm_gem_private_object_init(struct drm_device *dev, |
161 | struct drm_gem_object *obj, size_t size) | |
62cb7011 AC |
162 | { |
163 | BUG_ON((size & (PAGE_SIZE - 1)) != 0); | |
164 | ||
165 | obj->dev = dev; | |
166 | obj->filp = NULL; | |
167 | ||
168 | kref_init(&obj->refcount); | |
a8e11d1c | 169 | obj->handle_count = 0; |
62cb7011 | 170 | obj->size = size; |
88d7ebe5 | 171 | drm_vma_node_reset(&obj->vma_node); |
62cb7011 AC |
172 | } |
173 | EXPORT_SYMBOL(drm_gem_private_object_init); | |
174 | ||
0ff926c7 DA |
175 | static void |
176 | drm_gem_remove_prime_handles(struct drm_gem_object *obj, struct drm_file *filp) | |
177 | { | |
319c933c DV |
178 | /* |
179 | * Note: obj->dma_buf can't disappear as long as we still hold a | |
180 | * handle reference in obj->handle_count. | |
181 | */ | |
d0b2c533 | 182 | mutex_lock(&filp->prime.lock); |
319c933c | 183 | if (obj->dma_buf) { |
d0b2c533 DV |
184 | drm_prime_remove_buf_handle_locked(&filp->prime, |
185 | obj->dma_buf); | |
0ff926c7 | 186 | } |
d0b2c533 | 187 | mutex_unlock(&filp->prime.lock); |
0ff926c7 DA |
188 | } |
189 | ||
36da5908 | 190 | /** |
c6a84325 | 191 | * drm_gem_object_handle_free - release resources bound to userspace handles |
89d61fc0 DV |
192 | * @obj: GEM object to clean up. |
193 | * | |
36da5908 DV |
194 | * 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 | */ | |
200 | static 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 */ | |
36da5908 DV |
205 | if (obj->name) { |
206 | idr_remove(&dev->object_name_idr, obj->name); | |
207 | obj->name = 0; | |
a8e11d1c | 208 | } |
36da5908 DV |
209 | } |
210 | ||
319c933c DV |
211 | static 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 | ||
becee2a5 | 220 | static void |
36da5908 DV |
221 | drm_gem_object_handle_unreference_unlocked(struct drm_gem_object *obj) |
222 | { | |
98a8883a CW |
223 | struct drm_device *dev = obj->dev; |
224 | bool final = false; | |
225 | ||
a8e11d1c | 226 | if (WARN_ON(obj->handle_count == 0)) |
36da5908 DV |
227 | 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 | ||
98a8883a | 235 | mutex_lock(&dev->object_name_lock); |
319c933c | 236 | if (--obj->handle_count == 0) { |
36da5908 | 237 | drm_gem_object_handle_free(obj); |
319c933c | 238 | drm_gem_object_exported_dma_buf_free(obj); |
98a8883a | 239 | final = true; |
319c933c | 240 | } |
98a8883a | 241 | mutex_unlock(&dev->object_name_lock); |
a8e11d1c | 242 | |
98a8883a CW |
243 | if (final) |
244 | drm_gem_object_unreference_unlocked(obj); | |
36da5908 DV |
245 | } |
246 | ||
8815b23a CW |
247 | /* |
248 | * Called at device or object close to release the file's | |
249 | * handle references on objects. | |
250 | */ | |
251 | static int | |
252 | drm_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 | ||
673a394b | 270 | /** |
89d61fc0 DV |
271 | * 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 | * | |
df2e0900 DV |
275 | * 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. | |
673a394b | 278 | */ |
ff72145b | 279 | int |
a1a2d1d3 | 280 | drm_gem_handle_delete(struct drm_file *filp, u32 handle) |
673a394b EA |
281 | { |
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 | ||
8815b23a | 308 | drm_gem_object_release_handle(handle, obj, filp); |
673a394b EA |
309 | return 0; |
310 | } | |
ff72145b | 311 | EXPORT_SYMBOL(drm_gem_handle_delete); |
673a394b | 312 | |
43387b37 DV |
313 | /** |
314 | * drm_gem_dumb_destroy - dumb fb callback helper for gem based drivers | |
89d61fc0 DV |
315 | * @file: drm file-private structure to remove the dumb handle from |
316 | * @dev: corresponding drm_device | |
317 | * @handle: the dumb handle to remove | |
43387b37 DV |
318 | * |
319 | * This implements the ->dumb_destroy kms driver callback for drivers which use | |
320 | * gem to manage their backing storage. | |
321 | */ | |
322 | int 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 | } | |
328 | EXPORT_SYMBOL(drm_gem_dumb_destroy); | |
329 | ||
673a394b | 330 | /** |
20228c44 | 331 | * drm_gem_handle_create_tail - internal functions to create a handle |
89d61fc0 DV |
332 | * @file_priv: drm file-private structure to register the handle for |
333 | * @obj: object to register | |
8bf8180f | 334 | * @handlep: pointer to return the created handle to the caller |
20228c44 DV |
335 | * |
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. | |
df2e0900 DV |
339 | * |
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. | |
673a394b EA |
343 | */ |
344 | int | |
20228c44 DV |
345 | drm_gem_handle_create_tail(struct drm_file *file_priv, |
346 | struct drm_gem_object *obj, | |
347 | u32 *handlep) | |
673a394b | 348 | { |
304eda32 | 349 | struct drm_device *dev = obj->dev; |
9649399e | 350 | u32 handle; |
304eda32 | 351 | int ret; |
673a394b | 352 | |
20228c44 | 353 | WARN_ON(!mutex_is_locked(&dev->object_name_lock)); |
98a8883a CW |
354 | if (obj->handle_count++ == 0) |
355 | drm_gem_object_reference(obj); | |
20228c44 | 356 | |
673a394b | 357 | /* |
2e928815 TH |
358 | * Get the user-visible handle using idr. Preload and perform |
359 | * allocation under our spinlock. | |
673a394b | 360 | */ |
2e928815 | 361 | idr_preload(GFP_KERNEL); |
673a394b | 362 | spin_lock(&file_priv->table_lock); |
2e928815 TH |
363 | |
364 | ret = idr_alloc(&file_priv->object_idr, obj, 1, 0, GFP_NOWAIT); | |
98a8883a | 365 | |
673a394b | 366 | spin_unlock(&file_priv->table_lock); |
2e928815 | 367 | idr_preload_end(); |
98a8883a | 368 | |
cd4f013f | 369 | mutex_unlock(&dev->object_name_lock); |
6984128d CW |
370 | if (ret < 0) |
371 | goto err_unref; | |
372 | ||
9649399e | 373 | handle = ret; |
673a394b | 374 | |
ca481c9b | 375 | ret = drm_vma_node_allow(&obj->vma_node, file_priv->filp); |
6984128d CW |
376 | if (ret) |
377 | goto err_remove; | |
304eda32 BS |
378 | |
379 | if (dev->driver->gem_open_object) { | |
380 | ret = dev->driver->gem_open_object(obj, file_priv); | |
6984128d CW |
381 | if (ret) |
382 | goto err_revoke; | |
304eda32 BS |
383 | } |
384 | ||
9649399e | 385 | *handlep = handle; |
673a394b | 386 | return 0; |
6984128d CW |
387 | |
388 | err_revoke: | |
389 | drm_vma_node_revoke(&obj->vma_node, file_priv->filp); | |
390 | err_remove: | |
391 | spin_lock(&file_priv->table_lock); | |
9649399e | 392 | idr_remove(&file_priv->object_idr, handle); |
6984128d CW |
393 | spin_unlock(&file_priv->table_lock); |
394 | err_unref: | |
395 | drm_gem_object_handle_unreference_unlocked(obj); | |
396 | return ret; | |
673a394b | 397 | } |
20228c44 DV |
398 | |
399 | /** | |
8bf8180f | 400 | * drm_gem_handle_create - create a gem handle for an object |
89d61fc0 DV |
401 | * @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 | * | |
20228c44 DV |
405 | * 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 | */ | |
8bf8180f TR |
409 | int drm_gem_handle_create(struct drm_file *file_priv, |
410 | struct drm_gem_object *obj, | |
411 | u32 *handlep) | |
20228c44 DV |
412 | { |
413 | mutex_lock(&obj->dev->object_name_lock); | |
414 | ||
415 | return drm_gem_handle_create_tail(file_priv, obj, handlep); | |
416 | } | |
673a394b EA |
417 | EXPORT_SYMBOL(drm_gem_handle_create); |
418 | ||
75ef8b3b RC |
419 | |
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 | */ | |
426 | void | |
427 | drm_gem_free_mmap_offset(struct drm_gem_object *obj) | |
428 | { | |
429 | struct drm_device *dev = obj->dev; | |
75ef8b3b | 430 | |
b04a5906 | 431 | drm_vma_offset_remove(dev->vma_offset_manager, &obj->vma_node); |
75ef8b3b RC |
432 | } |
433 | EXPORT_SYMBOL(drm_gem_free_mmap_offset); | |
434 | ||
435 | /** | |
367bbd49 | 436 | * drm_gem_create_mmap_offset_size - create a fake mmap offset for an object |
75ef8b3b | 437 | * @obj: obj in question |
367bbd49 | 438 | * @size: the virtual size |
75ef8b3b RC |
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 | * | |
367bbd49 RC |
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(). | |
75ef8b3b RC |
448 | */ |
449 | int | |
367bbd49 | 450 | drm_gem_create_mmap_offset_size(struct drm_gem_object *obj, size_t size) |
75ef8b3b RC |
451 | { |
452 | struct drm_device *dev = obj->dev; | |
75ef8b3b | 453 | |
b04a5906 | 454 | return drm_vma_offset_add(dev->vma_offset_manager, &obj->vma_node, |
367bbd49 RC |
455 | size / PAGE_SIZE); |
456 | } | |
457 | EXPORT_SYMBOL(drm_gem_create_mmap_offset_size); | |
458 | ||
459 | /** | |
460 | * 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 | */ | |
470 | int drm_gem_create_mmap_offset(struct drm_gem_object *obj) | |
471 | { | |
472 | return drm_gem_create_mmap_offset_size(obj, obj->size); | |
75ef8b3b RC |
473 | } |
474 | EXPORT_SYMBOL(drm_gem_create_mmap_offset); | |
475 | ||
bcc5c9d5 RC |
476 | /** |
477 | * drm_gem_get_pages - helper to allocate backing pages for a GEM object | |
478 | * from shmem | |
479 | * @obj: obj in question | |
0cdbe8ac DH |
480 | * |
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. | |
bcc5c9d5 | 496 | */ |
0cdbe8ac | 497 | struct page **drm_gem_get_pages(struct drm_gem_object *obj) |
bcc5c9d5 | 498 | { |
bcc5c9d5 RC |
499 | 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 */ | |
0cdbe8ac | 504 | mapping = file_inode(obj->filp)->i_mapping; |
bcc5c9d5 RC |
505 | |
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 | ||
bcc5c9d5 | 518 | for (i = 0; i < npages; i++) { |
0cdbe8ac | 519 | p = shmem_read_mapping_page(mapping, i); |
bcc5c9d5 RC |
520 | if (IS_ERR(p)) |
521 | goto fail; | |
522 | pages[i] = p; | |
523 | ||
2123000b DH |
524 | /* 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. | |
bcc5c9d5 | 528 | */ |
c62d2555 | 529 | BUG_ON(mapping_gfp_constraint(mapping, __GFP_DMA32) && |
bcc5c9d5 RC |
530 | (page_to_pfn(p) >= 0x00100000UL)); |
531 | } | |
532 | ||
533 | return pages; | |
534 | ||
535 | fail: | |
536 | while (i--) | |
537 | page_cache_release(pages[i]); | |
538 | ||
539 | drm_free_large(pages); | |
540 | return ERR_CAST(p); | |
541 | } | |
542 | EXPORT_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 | */ | |
551 | void 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 | } | |
577 | EXPORT_SYMBOL(drm_gem_put_pages); | |
578 | ||
df2e0900 DV |
579 | /** |
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 | */ | |
673a394b EA |
590 | struct drm_gem_object * |
591 | drm_gem_object_lookup(struct drm_device *dev, struct drm_file *filp, | |
a1a2d1d3 | 592 | u32 handle) |
673a394b EA |
593 | { |
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 | } | |
611 | EXPORT_SYMBOL(drm_gem_object_lookup); | |
612 | ||
613 | /** | |
89d61fc0 DV |
614 | * 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 | * | |
673a394b EA |
619 | * Releases the handle to an mm object. |
620 | */ | |
621 | int | |
622 | drm_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 | ||
1bcecfac | 628 | if (!drm_core_check_feature(dev, DRIVER_GEM)) |
673a394b EA |
629 | return -ENODEV; |
630 | ||
631 | ret = drm_gem_handle_delete(file_priv, args->handle); | |
632 | ||
633 | return ret; | |
634 | } | |
635 | ||
636 | /** | |
89d61fc0 DV |
637 | * 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 | * | |
673a394b EA |
642 | * 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 | */ | |
647 | int | |
648 | drm_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 | ||
1bcecfac | 655 | if (!drm_core_check_feature(dev, DRIVER_GEM)) |
673a394b EA |
656 | return -ENODEV; |
657 | ||
658 | obj = drm_gem_object_lookup(dev, file_priv, args->handle); | |
659 | if (obj == NULL) | |
bf79cb91 | 660 | return -ENOENT; |
673a394b | 661 | |
cd4f013f | 662 | mutex_lock(&dev->object_name_lock); |
a8e11d1c DV |
663 | /* prevent races with concurrent gem_close. */ |
664 | if (obj->handle_count == 0) { | |
665 | ret = -ENOENT; | |
666 | goto err; | |
667 | } | |
668 | ||
8d59bae5 | 669 | if (!obj->name) { |
0f646425 | 670 | ret = idr_alloc(&dev->object_name_idr, obj, 1, 0, GFP_KERNEL); |
2e928815 | 671 | if (ret < 0) |
8d59bae5 | 672 | goto err; |
2e07fb22 YC |
673 | |
674 | obj->name = ret; | |
8d59bae5 | 675 | } |
3e49c4f4 | 676 | |
2e07fb22 YC |
677 | args->name = (uint64_t) obj->name; |
678 | ret = 0; | |
679 | ||
3e49c4f4 | 680 | err: |
cd4f013f | 681 | mutex_unlock(&dev->object_name_lock); |
bc9025bd | 682 | drm_gem_object_unreference_unlocked(obj); |
3e49c4f4 | 683 | return ret; |
673a394b EA |
684 | } |
685 | ||
686 | /** | |
89d61fc0 DV |
687 | * 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 | * | |
673a394b EA |
692 | * 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 | */ | |
697 | int | |
698 | drm_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; | |
a1a2d1d3 | 704 | u32 handle; |
673a394b | 705 | |
1bcecfac | 706 | if (!drm_core_check_feature(dev, DRIVER_GEM)) |
673a394b EA |
707 | return -ENODEV; |
708 | ||
cd4f013f | 709 | mutex_lock(&dev->object_name_lock); |
673a394b | 710 | obj = idr_find(&dev->object_name_idr, (int) args->name); |
20228c44 | 711 | if (obj) { |
673a394b | 712 | drm_gem_object_reference(obj); |
20228c44 DV |
713 | } else { |
714 | mutex_unlock(&dev->object_name_lock); | |
673a394b | 715 | return -ENOENT; |
20228c44 | 716 | } |
673a394b | 717 | |
20228c44 DV |
718 | /* drm_gem_handle_create_tail unlocks dev->object_name_lock. */ |
719 | ret = drm_gem_handle_create_tail(file_priv, obj, &handle); | |
bc9025bd | 720 | drm_gem_object_unreference_unlocked(obj); |
673a394b EA |
721 | if (ret) |
722 | return ret; | |
723 | ||
724 | args->handle = handle; | |
725 | args->size = obj->size; | |
726 | ||
727 | return 0; | |
728 | } | |
729 | ||
730 | /** | |
89d61fc0 DV |
731 | * 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 | * | |
673a394b EA |
735 | * Called at device open time, sets up the structure for handling refcounting |
736 | * of mm objects. | |
737 | */ | |
738 | void | |
739 | drm_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 | ||
673a394b | 745 | /** |
89d61fc0 DV |
746 | * 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 | * | |
673a394b EA |
750 | * Called at close time when the filp is going away. |
751 | * | |
752 | * Releases any remaining references on objects by this filp. | |
753 | */ | |
754 | void | |
755 | drm_gem_release(struct drm_device *dev, struct drm_file *file_private) | |
756 | { | |
673a394b | 757 | idr_for_each(&file_private->object_idr, |
304eda32 | 758 | &drm_gem_object_release_handle, file_private); |
673a394b | 759 | idr_destroy(&file_private->object_idr); |
673a394b EA |
760 | } |
761 | ||
fd632aa3 DV |
762 | void |
763 | drm_gem_object_release(struct drm_gem_object *obj) | |
c3ae90c0 | 764 | { |
319c933c DV |
765 | WARN_ON(obj->dma_buf); |
766 | ||
62cb7011 | 767 | if (obj->filp) |
16d2831d | 768 | fput(obj->filp); |
77472347 DH |
769 | |
770 | drm_gem_free_mmap_offset(obj); | |
c3ae90c0 | 771 | } |
fd632aa3 | 772 | EXPORT_SYMBOL(drm_gem_object_release); |
c3ae90c0 | 773 | |
673a394b | 774 | /** |
89d61fc0 DV |
775 | * drm_gem_object_free - free a GEM object |
776 | * @kref: kref of the object to free | |
777 | * | |
673a394b | 778 | * Called after the last reference to the object has been lost. |
c3ae90c0 | 779 | * Must be called holding struct_ mutex |
673a394b EA |
780 | * |
781 | * Frees the object | |
782 | */ | |
783 | void | |
784 | drm_gem_object_free(struct kref *kref) | |
785 | { | |
6ff774bd DV |
786 | struct drm_gem_object *obj = |
787 | container_of(kref, struct drm_gem_object, refcount); | |
673a394b EA |
788 | struct drm_device *dev = obj->dev; |
789 | ||
8d77a940 | 790 | WARN_ON(!mutex_is_locked(&dev->struct_mutex)); |
673a394b EA |
791 | |
792 | if (dev->driver->gem_free_object != NULL) | |
793 | dev->driver->gem_free_object(obj); | |
673a394b EA |
794 | } |
795 | EXPORT_SYMBOL(drm_gem_object_free); | |
796 | ||
df2e0900 DV |
797 | /** |
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 | */ | |
ab00b3e5 JB |
804 | void 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 | } | |
810 | EXPORT_SYMBOL(drm_gem_vm_open); | |
811 | ||
df2e0900 DV |
812 | /** |
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 | */ | |
ab00b3e5 JB |
819 | void drm_gem_vm_close(struct vm_area_struct *vma) |
820 | { | |
821 | struct drm_gem_object *obj = vma->vm_private_data; | |
ab00b3e5 | 822 | |
131e663b | 823 | drm_gem_object_unreference_unlocked(obj); |
ab00b3e5 JB |
824 | } |
825 | EXPORT_SYMBOL(drm_gem_vm_close); | |
826 | ||
1c5aafa6 LP |
827 | /** |
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 | * | |
ca481c9b DH |
844 | * 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 | * | |
1c5aafa6 LP |
848 | * 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 | */ | |
851 | int 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; | |
16d2831d | 866 | vma->vm_page_prot = pgprot_writecombine(vm_get_page_prot(vma->vm_flags)); |
1c5aafa6 LP |
867 | |
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 | ||
1c5aafa6 LP |
876 | return 0; |
877 | } | |
878 | EXPORT_SYMBOL(drm_gem_mmap_obj); | |
ab00b3e5 | 879 | |
a2c0a97b JB |
880 | /** |
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 | * | |
1c5aafa6 | 888 | * Look up the GEM object based on the offset passed in (vma->vm_pgoff will |
a2c0a97b | 889 | * contain the fake offset we created when the GTT map ioctl was called on |
1c5aafa6 | 890 | * the object) and map it with a call to drm_gem_mmap_obj(). |
ca481c9b DH |
891 | * |
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. | |
a2c0a97b JB |
894 | */ |
895 | int 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; | |
2225cfe4 | 899 | struct drm_gem_object *obj = NULL; |
0de23977 | 900 | struct drm_vma_offset_node *node; |
a8469aa8 | 901 | int ret; |
a2c0a97b | 902 | |
2c07a21d DA |
903 | if (drm_device_is_unplugged(dev)) |
904 | return -ENODEV; | |
905 | ||
2225cfe4 DV |
906 | 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); | |
a2c0a97b | 926 | |
2225cfe4 | 927 | if (!obj) |
197633b9 | 928 | return -EINVAL; |
2225cfe4 DV |
929 | |
930 | if (!drm_vma_node_is_allowed(node, filp)) { | |
931 | drm_gem_object_unreference_unlocked(obj); | |
ca481c9b | 932 | return -EACCES; |
a2c0a97b JB |
933 | } |
934 | ||
2225cfe4 DV |
935 | ret = drm_gem_mmap_obj(obj, drm_vma_node_size(node) << PAGE_SHIFT, |
936 | vma); | |
a2c0a97b | 937 | |
2225cfe4 | 938 | drm_gem_object_unreference_unlocked(obj); |
a2c0a97b JB |
939 | |
940 | return ret; | |
941 | } | |
942 | EXPORT_SYMBOL(drm_gem_mmap); |