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 | { | |
a8e11d1c | 223 | if (WARN_ON(obj->handle_count == 0)) |
36da5908 DV |
224 | return; |
225 | ||
226 | /* | |
227 | * Must bump handle count first as this may be the last | |
228 | * ref, in which case the object would disappear before we | |
229 | * checked for a name | |
230 | */ | |
231 | ||
cd4f013f | 232 | mutex_lock(&obj->dev->object_name_lock); |
319c933c | 233 | if (--obj->handle_count == 0) { |
36da5908 | 234 | drm_gem_object_handle_free(obj); |
319c933c DV |
235 | drm_gem_object_exported_dma_buf_free(obj); |
236 | } | |
cd4f013f | 237 | mutex_unlock(&obj->dev->object_name_lock); |
a8e11d1c | 238 | |
36da5908 DV |
239 | drm_gem_object_unreference_unlocked(obj); |
240 | } | |
241 | ||
673a394b | 242 | /** |
89d61fc0 DV |
243 | * drm_gem_handle_delete - deletes the given file-private handle |
244 | * @filp: drm file-private structure to use for the handle look up | |
245 | * @handle: userspace handle to delete | |
246 | * | |
df2e0900 DV |
247 | * Removes the GEM handle from the @filp lookup table which has been added with |
248 | * drm_gem_handle_create(). If this is the last handle also cleans up linked | |
249 | * resources like GEM names. | |
673a394b | 250 | */ |
ff72145b | 251 | int |
a1a2d1d3 | 252 | drm_gem_handle_delete(struct drm_file *filp, u32 handle) |
673a394b EA |
253 | { |
254 | struct drm_device *dev; | |
255 | struct drm_gem_object *obj; | |
256 | ||
257 | /* This is gross. The idr system doesn't let us try a delete and | |
258 | * return an error code. It just spews if you fail at deleting. | |
259 | * So, we have to grab a lock around finding the object and then | |
260 | * doing the delete on it and dropping the refcount, or the user | |
261 | * could race us to double-decrement the refcount and cause a | |
262 | * use-after-free later. Given the frequency of our handle lookups, | |
263 | * we may want to use ida for number allocation and a hash table | |
264 | * for the pointers, anyway. | |
265 | */ | |
266 | spin_lock(&filp->table_lock); | |
267 | ||
268 | /* Check if we currently have a reference on the object */ | |
269 | obj = idr_find(&filp->object_idr, handle); | |
270 | if (obj == NULL) { | |
271 | spin_unlock(&filp->table_lock); | |
272 | return -EINVAL; | |
273 | } | |
274 | dev = obj->dev; | |
275 | ||
276 | /* Release reference and decrement refcount. */ | |
277 | idr_remove(&filp->object_idr, handle); | |
278 | spin_unlock(&filp->table_lock); | |
279 | ||
9c784855 TR |
280 | if (drm_core_check_feature(dev, DRIVER_PRIME)) |
281 | drm_gem_remove_prime_handles(obj, filp); | |
ca481c9b | 282 | drm_vma_node_revoke(&obj->vma_node, filp->filp); |
3248877e | 283 | |
304eda32 BS |
284 | if (dev->driver->gem_close_object) |
285 | dev->driver->gem_close_object(obj, filp); | |
bc9025bd | 286 | drm_gem_object_handle_unreference_unlocked(obj); |
673a394b EA |
287 | |
288 | return 0; | |
289 | } | |
ff72145b | 290 | EXPORT_SYMBOL(drm_gem_handle_delete); |
673a394b | 291 | |
43387b37 DV |
292 | /** |
293 | * drm_gem_dumb_destroy - dumb fb callback helper for gem based drivers | |
89d61fc0 DV |
294 | * @file: drm file-private structure to remove the dumb handle from |
295 | * @dev: corresponding drm_device | |
296 | * @handle: the dumb handle to remove | |
43387b37 DV |
297 | * |
298 | * This implements the ->dumb_destroy kms driver callback for drivers which use | |
299 | * gem to manage their backing storage. | |
300 | */ | |
301 | int drm_gem_dumb_destroy(struct drm_file *file, | |
302 | struct drm_device *dev, | |
303 | uint32_t handle) | |
304 | { | |
305 | return drm_gem_handle_delete(file, handle); | |
306 | } | |
307 | EXPORT_SYMBOL(drm_gem_dumb_destroy); | |
308 | ||
673a394b | 309 | /** |
20228c44 | 310 | * drm_gem_handle_create_tail - internal functions to create a handle |
89d61fc0 DV |
311 | * @file_priv: drm file-private structure to register the handle for |
312 | * @obj: object to register | |
8bf8180f | 313 | * @handlep: pointer to return the created handle to the caller |
20228c44 DV |
314 | * |
315 | * This expects the dev->object_name_lock to be held already and will drop it | |
316 | * before returning. Used to avoid races in establishing new handles when | |
317 | * importing an object from either an flink name or a dma-buf. | |
df2e0900 DV |
318 | * |
319 | * Handles must be release again through drm_gem_handle_delete(). This is done | |
320 | * when userspace closes @file_priv for all attached handles, or through the | |
321 | * GEM_CLOSE ioctl for individual handles. | |
673a394b EA |
322 | */ |
323 | int | |
20228c44 DV |
324 | drm_gem_handle_create_tail(struct drm_file *file_priv, |
325 | struct drm_gem_object *obj, | |
326 | u32 *handlep) | |
673a394b | 327 | { |
304eda32 BS |
328 | struct drm_device *dev = obj->dev; |
329 | int ret; | |
673a394b | 330 | |
20228c44 DV |
331 | WARN_ON(!mutex_is_locked(&dev->object_name_lock)); |
332 | ||
673a394b | 333 | /* |
2e928815 TH |
334 | * Get the user-visible handle using idr. Preload and perform |
335 | * allocation under our spinlock. | |
673a394b | 336 | */ |
2e928815 | 337 | idr_preload(GFP_KERNEL); |
673a394b | 338 | spin_lock(&file_priv->table_lock); |
2e928815 TH |
339 | |
340 | ret = idr_alloc(&file_priv->object_idr, obj, 1, 0, GFP_NOWAIT); | |
a8e11d1c DV |
341 | drm_gem_object_reference(obj); |
342 | obj->handle_count++; | |
673a394b | 343 | spin_unlock(&file_priv->table_lock); |
2e928815 | 344 | idr_preload_end(); |
cd4f013f | 345 | mutex_unlock(&dev->object_name_lock); |
a8e11d1c DV |
346 | if (ret < 0) { |
347 | drm_gem_object_handle_unreference_unlocked(obj); | |
673a394b | 348 | return ret; |
a8e11d1c | 349 | } |
2e928815 | 350 | *handlep = ret; |
673a394b | 351 | |
ca481c9b DH |
352 | ret = drm_vma_node_allow(&obj->vma_node, file_priv->filp); |
353 | if (ret) { | |
354 | drm_gem_handle_delete(file_priv, *handlep); | |
355 | return ret; | |
356 | } | |
304eda32 BS |
357 | |
358 | if (dev->driver->gem_open_object) { | |
359 | ret = dev->driver->gem_open_object(obj, file_priv); | |
360 | if (ret) { | |
361 | drm_gem_handle_delete(file_priv, *handlep); | |
362 | return ret; | |
363 | } | |
364 | } | |
365 | ||
673a394b EA |
366 | return 0; |
367 | } | |
20228c44 DV |
368 | |
369 | /** | |
8bf8180f | 370 | * drm_gem_handle_create - create a gem handle for an object |
89d61fc0 DV |
371 | * @file_priv: drm file-private structure to register the handle for |
372 | * @obj: object to register | |
373 | * @handlep: pionter to return the created handle to the caller | |
374 | * | |
20228c44 DV |
375 | * Create a handle for this object. This adds a handle reference |
376 | * to the object, which includes a regular reference count. Callers | |
377 | * will likely want to dereference the object afterwards. | |
378 | */ | |
8bf8180f TR |
379 | int drm_gem_handle_create(struct drm_file *file_priv, |
380 | struct drm_gem_object *obj, | |
381 | u32 *handlep) | |
20228c44 DV |
382 | { |
383 | mutex_lock(&obj->dev->object_name_lock); | |
384 | ||
385 | return drm_gem_handle_create_tail(file_priv, obj, handlep); | |
386 | } | |
673a394b EA |
387 | EXPORT_SYMBOL(drm_gem_handle_create); |
388 | ||
75ef8b3b RC |
389 | |
390 | /** | |
391 | * drm_gem_free_mmap_offset - release a fake mmap offset for an object | |
392 | * @obj: obj in question | |
393 | * | |
394 | * This routine frees fake offsets allocated by drm_gem_create_mmap_offset(). | |
395 | */ | |
396 | void | |
397 | drm_gem_free_mmap_offset(struct drm_gem_object *obj) | |
398 | { | |
399 | struct drm_device *dev = obj->dev; | |
75ef8b3b | 400 | |
b04a5906 | 401 | drm_vma_offset_remove(dev->vma_offset_manager, &obj->vma_node); |
75ef8b3b RC |
402 | } |
403 | EXPORT_SYMBOL(drm_gem_free_mmap_offset); | |
404 | ||
405 | /** | |
367bbd49 | 406 | * drm_gem_create_mmap_offset_size - create a fake mmap offset for an object |
75ef8b3b | 407 | * @obj: obj in question |
367bbd49 | 408 | * @size: the virtual size |
75ef8b3b RC |
409 | * |
410 | * GEM memory mapping works by handing back to userspace a fake mmap offset | |
411 | * it can use in a subsequent mmap(2) call. The DRM core code then looks | |
412 | * up the object based on the offset and sets up the various memory mapping | |
413 | * structures. | |
414 | * | |
367bbd49 RC |
415 | * This routine allocates and attaches a fake offset for @obj, in cases where |
416 | * the virtual size differs from the physical size (ie. obj->size). Otherwise | |
417 | * just use drm_gem_create_mmap_offset(). | |
75ef8b3b RC |
418 | */ |
419 | int | |
367bbd49 | 420 | drm_gem_create_mmap_offset_size(struct drm_gem_object *obj, size_t size) |
75ef8b3b RC |
421 | { |
422 | struct drm_device *dev = obj->dev; | |
75ef8b3b | 423 | |
b04a5906 | 424 | return drm_vma_offset_add(dev->vma_offset_manager, &obj->vma_node, |
367bbd49 RC |
425 | size / PAGE_SIZE); |
426 | } | |
427 | EXPORT_SYMBOL(drm_gem_create_mmap_offset_size); | |
428 | ||
429 | /** | |
430 | * drm_gem_create_mmap_offset - create a fake mmap offset for an object | |
431 | * @obj: obj in question | |
432 | * | |
433 | * GEM memory mapping works by handing back to userspace a fake mmap offset | |
434 | * it can use in a subsequent mmap(2) call. The DRM core code then looks | |
435 | * up the object based on the offset and sets up the various memory mapping | |
436 | * structures. | |
437 | * | |
438 | * This routine allocates and attaches a fake offset for @obj. | |
439 | */ | |
440 | int drm_gem_create_mmap_offset(struct drm_gem_object *obj) | |
441 | { | |
442 | return drm_gem_create_mmap_offset_size(obj, obj->size); | |
75ef8b3b RC |
443 | } |
444 | EXPORT_SYMBOL(drm_gem_create_mmap_offset); | |
445 | ||
bcc5c9d5 RC |
446 | /** |
447 | * drm_gem_get_pages - helper to allocate backing pages for a GEM object | |
448 | * from shmem | |
449 | * @obj: obj in question | |
0cdbe8ac DH |
450 | * |
451 | * This reads the page-array of the shmem-backing storage of the given gem | |
452 | * object. An array of pages is returned. If a page is not allocated or | |
453 | * swapped-out, this will allocate/swap-in the required pages. Note that the | |
454 | * whole object is covered by the page-array and pinned in memory. | |
455 | * | |
456 | * Use drm_gem_put_pages() to release the array and unpin all pages. | |
457 | * | |
458 | * This uses the GFP-mask set on the shmem-mapping (see mapping_set_gfp_mask()). | |
459 | * If you require other GFP-masks, you have to do those allocations yourself. | |
460 | * | |
461 | * Note that you are not allowed to change gfp-zones during runtime. That is, | |
462 | * shmem_read_mapping_page_gfp() must be called with the same gfp_zone(gfp) as | |
463 | * set during initialization. If you have special zone constraints, set them | |
464 | * after drm_gem_init_object() via mapping_set_gfp_mask(). shmem-core takes care | |
465 | * to keep pages in the required zone during swap-in. | |
bcc5c9d5 | 466 | */ |
0cdbe8ac | 467 | struct page **drm_gem_get_pages(struct drm_gem_object *obj) |
bcc5c9d5 | 468 | { |
bcc5c9d5 RC |
469 | struct address_space *mapping; |
470 | struct page *p, **pages; | |
471 | int i, npages; | |
472 | ||
473 | /* This is the shared memory object that backs the GEM resource */ | |
0cdbe8ac | 474 | mapping = file_inode(obj->filp)->i_mapping; |
bcc5c9d5 RC |
475 | |
476 | /* We already BUG_ON() for non-page-aligned sizes in | |
477 | * drm_gem_object_init(), so we should never hit this unless | |
478 | * driver author is doing something really wrong: | |
479 | */ | |
480 | WARN_ON((obj->size & (PAGE_SIZE - 1)) != 0); | |
481 | ||
482 | npages = obj->size >> PAGE_SHIFT; | |
483 | ||
484 | pages = drm_malloc_ab(npages, sizeof(struct page *)); | |
485 | if (pages == NULL) | |
486 | return ERR_PTR(-ENOMEM); | |
487 | ||
bcc5c9d5 | 488 | for (i = 0; i < npages; i++) { |
0cdbe8ac | 489 | p = shmem_read_mapping_page(mapping, i); |
bcc5c9d5 RC |
490 | if (IS_ERR(p)) |
491 | goto fail; | |
492 | pages[i] = p; | |
493 | ||
2123000b DH |
494 | /* Make sure shmem keeps __GFP_DMA32 allocated pages in the |
495 | * correct region during swapin. Note that this requires | |
496 | * __GFP_DMA32 to be set in mapping_gfp_mask(inode->i_mapping) | |
497 | * so shmem can relocate pages during swapin if required. | |
bcc5c9d5 | 498 | */ |
c62d2555 | 499 | BUG_ON(mapping_gfp_constraint(mapping, __GFP_DMA32) && |
bcc5c9d5 RC |
500 | (page_to_pfn(p) >= 0x00100000UL)); |
501 | } | |
502 | ||
503 | return pages; | |
504 | ||
505 | fail: | |
506 | while (i--) | |
507 | page_cache_release(pages[i]); | |
508 | ||
509 | drm_free_large(pages); | |
510 | return ERR_CAST(p); | |
511 | } | |
512 | EXPORT_SYMBOL(drm_gem_get_pages); | |
513 | ||
514 | /** | |
515 | * drm_gem_put_pages - helper to free backing pages for a GEM object | |
516 | * @obj: obj in question | |
517 | * @pages: pages to free | |
518 | * @dirty: if true, pages will be marked as dirty | |
519 | * @accessed: if true, the pages will be marked as accessed | |
520 | */ | |
521 | void drm_gem_put_pages(struct drm_gem_object *obj, struct page **pages, | |
522 | bool dirty, bool accessed) | |
523 | { | |
524 | int i, npages; | |
525 | ||
526 | /* We already BUG_ON() for non-page-aligned sizes in | |
527 | * drm_gem_object_init(), so we should never hit this unless | |
528 | * driver author is doing something really wrong: | |
529 | */ | |
530 | WARN_ON((obj->size & (PAGE_SIZE - 1)) != 0); | |
531 | ||
532 | npages = obj->size >> PAGE_SHIFT; | |
533 | ||
534 | for (i = 0; i < npages; i++) { | |
535 | if (dirty) | |
536 | set_page_dirty(pages[i]); | |
537 | ||
538 | if (accessed) | |
539 | mark_page_accessed(pages[i]); | |
540 | ||
541 | /* Undo the reference we took when populating the table */ | |
542 | page_cache_release(pages[i]); | |
543 | } | |
544 | ||
545 | drm_free_large(pages); | |
546 | } | |
547 | EXPORT_SYMBOL(drm_gem_put_pages); | |
548 | ||
df2e0900 DV |
549 | /** |
550 | * drm_gem_object_lookup - look up a GEM object from it's handle | |
551 | * @dev: DRM device | |
552 | * @filp: DRM file private date | |
553 | * @handle: userspace handle | |
554 | * | |
555 | * Returns: | |
556 | * | |
557 | * A reference to the object named by the handle if such exists on @filp, NULL | |
558 | * otherwise. | |
559 | */ | |
673a394b EA |
560 | struct drm_gem_object * |
561 | drm_gem_object_lookup(struct drm_device *dev, struct drm_file *filp, | |
a1a2d1d3 | 562 | u32 handle) |
673a394b EA |
563 | { |
564 | struct drm_gem_object *obj; | |
565 | ||
566 | spin_lock(&filp->table_lock); | |
567 | ||
568 | /* Check if we currently have a reference on the object */ | |
569 | obj = idr_find(&filp->object_idr, handle); | |
570 | if (obj == NULL) { | |
571 | spin_unlock(&filp->table_lock); | |
572 | return NULL; | |
573 | } | |
574 | ||
575 | drm_gem_object_reference(obj); | |
576 | ||
577 | spin_unlock(&filp->table_lock); | |
578 | ||
579 | return obj; | |
580 | } | |
581 | EXPORT_SYMBOL(drm_gem_object_lookup); | |
582 | ||
583 | /** | |
89d61fc0 DV |
584 | * drm_gem_close_ioctl - implementation of the GEM_CLOSE ioctl |
585 | * @dev: drm_device | |
586 | * @data: ioctl data | |
587 | * @file_priv: drm file-private structure | |
588 | * | |
673a394b EA |
589 | * Releases the handle to an mm object. |
590 | */ | |
591 | int | |
592 | drm_gem_close_ioctl(struct drm_device *dev, void *data, | |
593 | struct drm_file *file_priv) | |
594 | { | |
595 | struct drm_gem_close *args = data; | |
596 | int ret; | |
597 | ||
1bcecfac | 598 | if (!drm_core_check_feature(dev, DRIVER_GEM)) |
673a394b EA |
599 | return -ENODEV; |
600 | ||
601 | ret = drm_gem_handle_delete(file_priv, args->handle); | |
602 | ||
603 | return ret; | |
604 | } | |
605 | ||
606 | /** | |
89d61fc0 DV |
607 | * drm_gem_flink_ioctl - implementation of the GEM_FLINK ioctl |
608 | * @dev: drm_device | |
609 | * @data: ioctl data | |
610 | * @file_priv: drm file-private structure | |
611 | * | |
673a394b EA |
612 | * Create a global name for an object, returning the name. |
613 | * | |
614 | * Note that the name does not hold a reference; when the object | |
615 | * is freed, the name goes away. | |
616 | */ | |
617 | int | |
618 | drm_gem_flink_ioctl(struct drm_device *dev, void *data, | |
619 | struct drm_file *file_priv) | |
620 | { | |
621 | struct drm_gem_flink *args = data; | |
622 | struct drm_gem_object *obj; | |
623 | int ret; | |
624 | ||
1bcecfac | 625 | if (!drm_core_check_feature(dev, DRIVER_GEM)) |
673a394b EA |
626 | return -ENODEV; |
627 | ||
628 | obj = drm_gem_object_lookup(dev, file_priv, args->handle); | |
629 | if (obj == NULL) | |
bf79cb91 | 630 | return -ENOENT; |
673a394b | 631 | |
cd4f013f | 632 | mutex_lock(&dev->object_name_lock); |
2e928815 | 633 | idr_preload(GFP_KERNEL); |
a8e11d1c DV |
634 | /* prevent races with concurrent gem_close. */ |
635 | if (obj->handle_count == 0) { | |
636 | ret = -ENOENT; | |
637 | goto err; | |
638 | } | |
639 | ||
8d59bae5 | 640 | if (!obj->name) { |
2e928815 | 641 | ret = idr_alloc(&dev->object_name_idr, obj, 1, 0, GFP_NOWAIT); |
2e928815 | 642 | if (ret < 0) |
8d59bae5 | 643 | goto err; |
2e07fb22 YC |
644 | |
645 | obj->name = ret; | |
8d59bae5 | 646 | } |
3e49c4f4 | 647 | |
2e07fb22 YC |
648 | args->name = (uint64_t) obj->name; |
649 | ret = 0; | |
650 | ||
3e49c4f4 | 651 | err: |
2e07fb22 | 652 | idr_preload_end(); |
cd4f013f | 653 | mutex_unlock(&dev->object_name_lock); |
bc9025bd | 654 | drm_gem_object_unreference_unlocked(obj); |
3e49c4f4 | 655 | return ret; |
673a394b EA |
656 | } |
657 | ||
658 | /** | |
89d61fc0 DV |
659 | * drm_gem_open - implementation of the GEM_OPEN ioctl |
660 | * @dev: drm_device | |
661 | * @data: ioctl data | |
662 | * @file_priv: drm file-private structure | |
663 | * | |
673a394b EA |
664 | * Open an object using the global name, returning a handle and the size. |
665 | * | |
666 | * This handle (of course) holds a reference to the object, so the object | |
667 | * will not go away until the handle is deleted. | |
668 | */ | |
669 | int | |
670 | drm_gem_open_ioctl(struct drm_device *dev, void *data, | |
671 | struct drm_file *file_priv) | |
672 | { | |
673 | struct drm_gem_open *args = data; | |
674 | struct drm_gem_object *obj; | |
675 | int ret; | |
a1a2d1d3 | 676 | u32 handle; |
673a394b | 677 | |
1bcecfac | 678 | if (!drm_core_check_feature(dev, DRIVER_GEM)) |
673a394b EA |
679 | return -ENODEV; |
680 | ||
cd4f013f | 681 | mutex_lock(&dev->object_name_lock); |
673a394b | 682 | obj = idr_find(&dev->object_name_idr, (int) args->name); |
20228c44 | 683 | if (obj) { |
673a394b | 684 | drm_gem_object_reference(obj); |
20228c44 DV |
685 | } else { |
686 | mutex_unlock(&dev->object_name_lock); | |
673a394b | 687 | return -ENOENT; |
20228c44 | 688 | } |
673a394b | 689 | |
20228c44 DV |
690 | /* drm_gem_handle_create_tail unlocks dev->object_name_lock. */ |
691 | ret = drm_gem_handle_create_tail(file_priv, obj, &handle); | |
bc9025bd | 692 | drm_gem_object_unreference_unlocked(obj); |
673a394b EA |
693 | if (ret) |
694 | return ret; | |
695 | ||
696 | args->handle = handle; | |
697 | args->size = obj->size; | |
698 | ||
699 | return 0; | |
700 | } | |
701 | ||
702 | /** | |
89d61fc0 DV |
703 | * gem_gem_open - initalizes GEM file-private structures at devnode open time |
704 | * @dev: drm_device which is being opened by userspace | |
705 | * @file_private: drm file-private structure to set up | |
706 | * | |
673a394b EA |
707 | * Called at device open time, sets up the structure for handling refcounting |
708 | * of mm objects. | |
709 | */ | |
710 | void | |
711 | drm_gem_open(struct drm_device *dev, struct drm_file *file_private) | |
712 | { | |
713 | idr_init(&file_private->object_idr); | |
714 | spin_lock_init(&file_private->table_lock); | |
715 | } | |
716 | ||
89d61fc0 | 717 | /* |
673a394b EA |
718 | * Called at device close to release the file's |
719 | * handle references on objects. | |
720 | */ | |
721 | static int | |
722 | drm_gem_object_release_handle(int id, void *ptr, void *data) | |
723 | { | |
304eda32 | 724 | struct drm_file *file_priv = data; |
673a394b | 725 | struct drm_gem_object *obj = ptr; |
304eda32 BS |
726 | struct drm_device *dev = obj->dev; |
727 | ||
9c784855 TR |
728 | if (drm_core_check_feature(dev, DRIVER_PRIME)) |
729 | drm_gem_remove_prime_handles(obj, file_priv); | |
ca481c9b | 730 | drm_vma_node_revoke(&obj->vma_node, file_priv->filp); |
3248877e | 731 | |
304eda32 BS |
732 | if (dev->driver->gem_close_object) |
733 | dev->driver->gem_close_object(obj, file_priv); | |
673a394b | 734 | |
bc9025bd | 735 | drm_gem_object_handle_unreference_unlocked(obj); |
673a394b EA |
736 | |
737 | return 0; | |
738 | } | |
739 | ||
740 | /** | |
89d61fc0 DV |
741 | * drm_gem_release - release file-private GEM resources |
742 | * @dev: drm_device which is being closed by userspace | |
743 | * @file_private: drm file-private structure to clean up | |
744 | * | |
673a394b EA |
745 | * Called at close time when the filp is going away. |
746 | * | |
747 | * Releases any remaining references on objects by this filp. | |
748 | */ | |
749 | void | |
750 | drm_gem_release(struct drm_device *dev, struct drm_file *file_private) | |
751 | { | |
673a394b | 752 | idr_for_each(&file_private->object_idr, |
304eda32 | 753 | &drm_gem_object_release_handle, file_private); |
673a394b | 754 | idr_destroy(&file_private->object_idr); |
673a394b EA |
755 | } |
756 | ||
fd632aa3 DV |
757 | void |
758 | drm_gem_object_release(struct drm_gem_object *obj) | |
c3ae90c0 | 759 | { |
319c933c DV |
760 | WARN_ON(obj->dma_buf); |
761 | ||
62cb7011 | 762 | if (obj->filp) |
16d2831d | 763 | fput(obj->filp); |
77472347 DH |
764 | |
765 | drm_gem_free_mmap_offset(obj); | |
c3ae90c0 | 766 | } |
fd632aa3 | 767 | EXPORT_SYMBOL(drm_gem_object_release); |
c3ae90c0 | 768 | |
673a394b | 769 | /** |
89d61fc0 DV |
770 | * drm_gem_object_free - free a GEM object |
771 | * @kref: kref of the object to free | |
772 | * | |
673a394b | 773 | * Called after the last reference to the object has been lost. |
c3ae90c0 | 774 | * Must be called holding struct_ mutex |
673a394b EA |
775 | * |
776 | * Frees the object | |
777 | */ | |
778 | void | |
779 | drm_gem_object_free(struct kref *kref) | |
780 | { | |
6ff774bd DV |
781 | struct drm_gem_object *obj = |
782 | container_of(kref, struct drm_gem_object, refcount); | |
673a394b EA |
783 | struct drm_device *dev = obj->dev; |
784 | ||
8d77a940 | 785 | WARN_ON(!mutex_is_locked(&dev->struct_mutex)); |
673a394b EA |
786 | |
787 | if (dev->driver->gem_free_object != NULL) | |
788 | dev->driver->gem_free_object(obj); | |
673a394b EA |
789 | } |
790 | EXPORT_SYMBOL(drm_gem_object_free); | |
791 | ||
df2e0900 DV |
792 | /** |
793 | * drm_gem_vm_open - vma->ops->open implementation for GEM | |
794 | * @vma: VM area structure | |
795 | * | |
796 | * This function implements the #vm_operations_struct open() callback for GEM | |
797 | * drivers. This must be used together with drm_gem_vm_close(). | |
798 | */ | |
ab00b3e5 JB |
799 | void drm_gem_vm_open(struct vm_area_struct *vma) |
800 | { | |
801 | struct drm_gem_object *obj = vma->vm_private_data; | |
802 | ||
803 | drm_gem_object_reference(obj); | |
804 | } | |
805 | EXPORT_SYMBOL(drm_gem_vm_open); | |
806 | ||
df2e0900 DV |
807 | /** |
808 | * drm_gem_vm_close - vma->ops->close implementation for GEM | |
809 | * @vma: VM area structure | |
810 | * | |
811 | * This function implements the #vm_operations_struct close() callback for GEM | |
812 | * drivers. This must be used together with drm_gem_vm_open(). | |
813 | */ | |
ab00b3e5 JB |
814 | void drm_gem_vm_close(struct vm_area_struct *vma) |
815 | { | |
816 | struct drm_gem_object *obj = vma->vm_private_data; | |
ab00b3e5 | 817 | |
131e663b | 818 | drm_gem_object_unreference_unlocked(obj); |
ab00b3e5 JB |
819 | } |
820 | EXPORT_SYMBOL(drm_gem_vm_close); | |
821 | ||
1c5aafa6 LP |
822 | /** |
823 | * drm_gem_mmap_obj - memory map a GEM object | |
824 | * @obj: the GEM object to map | |
825 | * @obj_size: the object size to be mapped, in bytes | |
826 | * @vma: VMA for the area to be mapped | |
827 | * | |
828 | * Set up the VMA to prepare mapping of the GEM object using the gem_vm_ops | |
829 | * provided by the driver. Depending on their requirements, drivers can either | |
830 | * provide a fault handler in their gem_vm_ops (in which case any accesses to | |
831 | * the object will be trapped, to perform migration, GTT binding, surface | |
832 | * register allocation, or performance monitoring), or mmap the buffer memory | |
833 | * synchronously after calling drm_gem_mmap_obj. | |
834 | * | |
835 | * This function is mainly intended to implement the DMABUF mmap operation, when | |
836 | * the GEM object is not looked up based on its fake offset. To implement the | |
837 | * DRM mmap operation, drivers should use the drm_gem_mmap() function. | |
838 | * | |
ca481c9b DH |
839 | * drm_gem_mmap_obj() assumes the user is granted access to the buffer while |
840 | * drm_gem_mmap() prevents unprivileged users from mapping random objects. So | |
841 | * callers must verify access restrictions before calling this helper. | |
842 | * | |
1c5aafa6 LP |
843 | * Return 0 or success or -EINVAL if the object size is smaller than the VMA |
844 | * size, or if no gem_vm_ops are provided. | |
845 | */ | |
846 | int drm_gem_mmap_obj(struct drm_gem_object *obj, unsigned long obj_size, | |
847 | struct vm_area_struct *vma) | |
848 | { | |
849 | struct drm_device *dev = obj->dev; | |
850 | ||
851 | /* Check for valid size. */ | |
852 | if (obj_size < vma->vm_end - vma->vm_start) | |
853 | return -EINVAL; | |
854 | ||
855 | if (!dev->driver->gem_vm_ops) | |
856 | return -EINVAL; | |
857 | ||
858 | vma->vm_flags |= VM_IO | VM_PFNMAP | VM_DONTEXPAND | VM_DONTDUMP; | |
859 | vma->vm_ops = dev->driver->gem_vm_ops; | |
860 | vma->vm_private_data = obj; | |
16d2831d | 861 | vma->vm_page_prot = pgprot_writecombine(vm_get_page_prot(vma->vm_flags)); |
1c5aafa6 LP |
862 | |
863 | /* Take a ref for this mapping of the object, so that the fault | |
864 | * handler can dereference the mmap offset's pointer to the object. | |
865 | * This reference is cleaned up by the corresponding vm_close | |
866 | * (which should happen whether the vma was created by this call, or | |
867 | * by a vm_open due to mremap or partial unmap or whatever). | |
868 | */ | |
869 | drm_gem_object_reference(obj); | |
870 | ||
1c5aafa6 LP |
871 | return 0; |
872 | } | |
873 | EXPORT_SYMBOL(drm_gem_mmap_obj); | |
ab00b3e5 | 874 | |
a2c0a97b JB |
875 | /** |
876 | * drm_gem_mmap - memory map routine for GEM objects | |
877 | * @filp: DRM file pointer | |
878 | * @vma: VMA for the area to be mapped | |
879 | * | |
880 | * If a driver supports GEM object mapping, mmap calls on the DRM file | |
881 | * descriptor will end up here. | |
882 | * | |
1c5aafa6 | 883 | * Look up the GEM object based on the offset passed in (vma->vm_pgoff will |
a2c0a97b | 884 | * contain the fake offset we created when the GTT map ioctl was called on |
1c5aafa6 | 885 | * the object) and map it with a call to drm_gem_mmap_obj(). |
ca481c9b DH |
886 | * |
887 | * If the caller is not granted access to the buffer object, the mmap will fail | |
888 | * with EACCES. Please see the vma manager for more information. | |
a2c0a97b JB |
889 | */ |
890 | int drm_gem_mmap(struct file *filp, struct vm_area_struct *vma) | |
891 | { | |
892 | struct drm_file *priv = filp->private_data; | |
893 | struct drm_device *dev = priv->minor->dev; | |
2225cfe4 | 894 | struct drm_gem_object *obj = NULL; |
0de23977 | 895 | struct drm_vma_offset_node *node; |
a8469aa8 | 896 | int ret; |
a2c0a97b | 897 | |
2c07a21d DA |
898 | if (drm_device_is_unplugged(dev)) |
899 | return -ENODEV; | |
900 | ||
2225cfe4 DV |
901 | drm_vma_offset_lock_lookup(dev->vma_offset_manager); |
902 | node = drm_vma_offset_exact_lookup_locked(dev->vma_offset_manager, | |
903 | vma->vm_pgoff, | |
904 | vma_pages(vma)); | |
905 | if (likely(node)) { | |
906 | obj = container_of(node, struct drm_gem_object, vma_node); | |
907 | /* | |
908 | * When the object is being freed, after it hits 0-refcnt it | |
909 | * proceeds to tear down the object. In the process it will | |
910 | * attempt to remove the VMA offset and so acquire this | |
911 | * mgr->vm_lock. Therefore if we find an object with a 0-refcnt | |
912 | * that matches our range, we know it is in the process of being | |
913 | * destroyed and will be freed as soon as we release the lock - | |
914 | * so we have to check for the 0-refcnted object and treat it as | |
915 | * invalid. | |
916 | */ | |
917 | if (!kref_get_unless_zero(&obj->refcount)) | |
918 | obj = NULL; | |
919 | } | |
920 | drm_vma_offset_unlock_lookup(dev->vma_offset_manager); | |
a2c0a97b | 921 | |
2225cfe4 | 922 | if (!obj) |
197633b9 | 923 | return -EINVAL; |
2225cfe4 DV |
924 | |
925 | if (!drm_vma_node_is_allowed(node, filp)) { | |
926 | drm_gem_object_unreference_unlocked(obj); | |
ca481c9b | 927 | return -EACCES; |
a2c0a97b JB |
928 | } |
929 | ||
2225cfe4 DV |
930 | ret = drm_gem_mmap_obj(obj, drm_vma_node_size(node) << PAGE_SHIFT, |
931 | vma); | |
a2c0a97b | 932 | |
2225cfe4 | 933 | drm_gem_object_unreference_unlocked(obj); |
a2c0a97b JB |
934 | |
935 | return ret; | |
936 | } | |
937 | EXPORT_SYMBOL(drm_gem_mmap); |