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> |
673a394b EA |
41 | |
42 | /** @file drm_gem.c | |
43 | * | |
44 | * This file provides some of the base ioctls and library routines for | |
45 | * the graphics memory manager implemented by each device driver. | |
46 | * | |
47 | * Because various devices have different requirements in terms of | |
48 | * synchronization and migration strategies, implementing that is left up to | |
49 | * the driver, and all that the general API provides should be generic -- | |
50 | * allocating objects, reading/writing data with the cpu, freeing objects. | |
51 | * Even there, platform-dependent optimizations for reading/writing data with | |
52 | * the CPU mean we'll likely hook those out to driver-specific calls. However, | |
53 | * the DRI2 implementation wants to have at least allocate/mmap be generic. | |
54 | * | |
55 | * The goal was to have swap-backed object allocation managed through | |
56 | * struct file. However, file descriptors as handles to a struct file have | |
57 | * two major failings: | |
58 | * - Process limits prevent more than 1024 or so being used at a time by | |
59 | * default. | |
60 | * - Inability to allocate high fds will aggravate the X Server's select() | |
61 | * handling, and likely that of many GL client applications as well. | |
62 | * | |
63 | * This led to a plan of using our own integer IDs (called handles, following | |
64 | * DRM terminology) to mimic fds, and implement the fd syscalls we need as | |
65 | * ioctls. The objects themselves will still include the struct file so | |
66 | * that we can transition to fds if the required kernel infrastructure shows | |
67 | * up at a later date, and as our interface with shmfs for memory allocation. | |
68 | */ | |
69 | ||
a2c0a97b JB |
70 | /* |
71 | * We make up offsets for buffer objects so we can recognize them at | |
72 | * mmap time. | |
73 | */ | |
05269a3a JC |
74 | |
75 | /* pgoff in mmap is an unsigned long, so we need to make sure that | |
76 | * the faked up offset will fit | |
77 | */ | |
78 | ||
79 | #if BITS_PER_LONG == 64 | |
a2c0a97b JB |
80 | #define DRM_FILE_PAGE_OFFSET_START ((0xFFFFFFFFUL >> PAGE_SHIFT) + 1) |
81 | #define DRM_FILE_PAGE_OFFSET_SIZE ((0xFFFFFFFFUL >> PAGE_SHIFT) * 16) | |
05269a3a JC |
82 | #else |
83 | #define DRM_FILE_PAGE_OFFSET_START ((0xFFFFFFFUL >> PAGE_SHIFT) + 1) | |
84 | #define DRM_FILE_PAGE_OFFSET_SIZE ((0xFFFFFFFUL >> PAGE_SHIFT) * 16) | |
85 | #endif | |
a2c0a97b | 86 | |
673a394b EA |
87 | /** |
88 | * Initialize the GEM device fields | |
89 | */ | |
90 | ||
91 | int | |
92 | drm_gem_init(struct drm_device *dev) | |
93 | { | |
b04a5906 | 94 | struct drm_vma_offset_manager *vma_offset_manager; |
a2c0a97b | 95 | |
cd4f013f | 96 | mutex_init(&dev->object_name_lock); |
673a394b | 97 | idr_init(&dev->object_name_idr); |
a2c0a97b | 98 | |
b04a5906 DV |
99 | vma_offset_manager = kzalloc(sizeof(*vma_offset_manager), GFP_KERNEL); |
100 | if (!vma_offset_manager) { | |
a2c0a97b JB |
101 | DRM_ERROR("out of memory\n"); |
102 | return -ENOMEM; | |
103 | } | |
104 | ||
b04a5906 DV |
105 | dev->vma_offset_manager = vma_offset_manager; |
106 | drm_vma_offset_manager_init(vma_offset_manager, | |
0de23977 DH |
107 | DRM_FILE_PAGE_OFFSET_START, |
108 | DRM_FILE_PAGE_OFFSET_SIZE); | |
a2c0a97b | 109 | |
673a394b EA |
110 | return 0; |
111 | } | |
112 | ||
a2c0a97b JB |
113 | void |
114 | drm_gem_destroy(struct drm_device *dev) | |
115 | { | |
a2c0a97b | 116 | |
b04a5906 DV |
117 | drm_vma_offset_manager_destroy(dev->vma_offset_manager); |
118 | kfree(dev->vma_offset_manager); | |
119 | dev->vma_offset_manager = NULL; | |
a2c0a97b JB |
120 | } |
121 | ||
1d397043 | 122 | /** |
62cb7011 | 123 | * Initialize an already allocated GEM object of the specified size with |
1d397043 DV |
124 | * shmfs backing store. |
125 | */ | |
126 | int drm_gem_object_init(struct drm_device *dev, | |
127 | struct drm_gem_object *obj, size_t size) | |
128 | { | |
89c8233f | 129 | struct file *filp; |
1d397043 | 130 | |
89c8233f DH |
131 | filp = shmem_file_setup("drm mm object", size, VM_NORESERVE); |
132 | if (IS_ERR(filp)) | |
133 | return PTR_ERR(filp); | |
1d397043 | 134 | |
89c8233f DH |
135 | drm_gem_private_object_init(dev, obj, size); |
136 | obj->filp = filp; | |
1d397043 | 137 | |
1d397043 DV |
138 | return 0; |
139 | } | |
140 | EXPORT_SYMBOL(drm_gem_object_init); | |
141 | ||
62cb7011 AC |
142 | /** |
143 | * Initialize an already allocated GEM object of the specified size with | |
144 | * no GEM provided backing store. Instead the caller is responsible for | |
145 | * backing the object and handling it. | |
146 | */ | |
89c8233f DH |
147 | void drm_gem_private_object_init(struct drm_device *dev, |
148 | struct drm_gem_object *obj, size_t size) | |
62cb7011 AC |
149 | { |
150 | BUG_ON((size & (PAGE_SIZE - 1)) != 0); | |
151 | ||
152 | obj->dev = dev; | |
153 | obj->filp = NULL; | |
154 | ||
155 | kref_init(&obj->refcount); | |
a8e11d1c | 156 | obj->handle_count = 0; |
62cb7011 | 157 | obj->size = size; |
88d7ebe5 | 158 | drm_vma_node_reset(&obj->vma_node); |
62cb7011 AC |
159 | } |
160 | EXPORT_SYMBOL(drm_gem_private_object_init); | |
161 | ||
0ff926c7 DA |
162 | static void |
163 | drm_gem_remove_prime_handles(struct drm_gem_object *obj, struct drm_file *filp) | |
164 | { | |
319c933c DV |
165 | /* |
166 | * Note: obj->dma_buf can't disappear as long as we still hold a | |
167 | * handle reference in obj->handle_count. | |
168 | */ | |
d0b2c533 | 169 | mutex_lock(&filp->prime.lock); |
319c933c | 170 | if (obj->dma_buf) { |
d0b2c533 DV |
171 | drm_prime_remove_buf_handle_locked(&filp->prime, |
172 | obj->dma_buf); | |
0ff926c7 | 173 | } |
d0b2c533 | 174 | mutex_unlock(&filp->prime.lock); |
0ff926c7 DA |
175 | } |
176 | ||
36da5908 DV |
177 | /** |
178 | * Called after the last handle to the object has been closed | |
179 | * | |
180 | * Removes any name for the object. Note that this must be | |
181 | * called before drm_gem_object_free or we'll be touching | |
182 | * freed memory | |
183 | */ | |
184 | static void drm_gem_object_handle_free(struct drm_gem_object *obj) | |
185 | { | |
186 | struct drm_device *dev = obj->dev; | |
187 | ||
188 | /* Remove any name for this object */ | |
36da5908 DV |
189 | if (obj->name) { |
190 | idr_remove(&dev->object_name_idr, obj->name); | |
191 | obj->name = 0; | |
a8e11d1c | 192 | } |
36da5908 DV |
193 | } |
194 | ||
319c933c DV |
195 | static void drm_gem_object_exported_dma_buf_free(struct drm_gem_object *obj) |
196 | { | |
197 | /* Unbreak the reference cycle if we have an exported dma_buf. */ | |
198 | if (obj->dma_buf) { | |
199 | dma_buf_put(obj->dma_buf); | |
200 | obj->dma_buf = NULL; | |
201 | } | |
202 | } | |
203 | ||
becee2a5 | 204 | static void |
36da5908 DV |
205 | drm_gem_object_handle_unreference_unlocked(struct drm_gem_object *obj) |
206 | { | |
a8e11d1c | 207 | if (WARN_ON(obj->handle_count == 0)) |
36da5908 DV |
208 | return; |
209 | ||
210 | /* | |
211 | * Must bump handle count first as this may be the last | |
212 | * ref, in which case the object would disappear before we | |
213 | * checked for a name | |
214 | */ | |
215 | ||
cd4f013f | 216 | mutex_lock(&obj->dev->object_name_lock); |
319c933c | 217 | if (--obj->handle_count == 0) { |
36da5908 | 218 | drm_gem_object_handle_free(obj); |
319c933c DV |
219 | drm_gem_object_exported_dma_buf_free(obj); |
220 | } | |
cd4f013f | 221 | mutex_unlock(&obj->dev->object_name_lock); |
a8e11d1c | 222 | |
36da5908 DV |
223 | drm_gem_object_unreference_unlocked(obj); |
224 | } | |
225 | ||
673a394b EA |
226 | /** |
227 | * Removes the mapping from handle to filp for this object. | |
228 | */ | |
ff72145b | 229 | int |
a1a2d1d3 | 230 | drm_gem_handle_delete(struct drm_file *filp, u32 handle) |
673a394b EA |
231 | { |
232 | struct drm_device *dev; | |
233 | struct drm_gem_object *obj; | |
234 | ||
235 | /* This is gross. The idr system doesn't let us try a delete and | |
236 | * return an error code. It just spews if you fail at deleting. | |
237 | * So, we have to grab a lock around finding the object and then | |
238 | * doing the delete on it and dropping the refcount, or the user | |
239 | * could race us to double-decrement the refcount and cause a | |
240 | * use-after-free later. Given the frequency of our handle lookups, | |
241 | * we may want to use ida for number allocation and a hash table | |
242 | * for the pointers, anyway. | |
243 | */ | |
244 | spin_lock(&filp->table_lock); | |
245 | ||
246 | /* Check if we currently have a reference on the object */ | |
247 | obj = idr_find(&filp->object_idr, handle); | |
248 | if (obj == NULL) { | |
249 | spin_unlock(&filp->table_lock); | |
250 | return -EINVAL; | |
251 | } | |
252 | dev = obj->dev; | |
253 | ||
254 | /* Release reference and decrement refcount. */ | |
255 | idr_remove(&filp->object_idr, handle); | |
256 | spin_unlock(&filp->table_lock); | |
257 | ||
9c784855 TR |
258 | if (drm_core_check_feature(dev, DRIVER_PRIME)) |
259 | drm_gem_remove_prime_handles(obj, filp); | |
ca481c9b | 260 | drm_vma_node_revoke(&obj->vma_node, filp->filp); |
3248877e | 261 | |
304eda32 BS |
262 | if (dev->driver->gem_close_object) |
263 | dev->driver->gem_close_object(obj, filp); | |
bc9025bd | 264 | drm_gem_object_handle_unreference_unlocked(obj); |
673a394b EA |
265 | |
266 | return 0; | |
267 | } | |
ff72145b | 268 | EXPORT_SYMBOL(drm_gem_handle_delete); |
673a394b | 269 | |
43387b37 DV |
270 | /** |
271 | * drm_gem_dumb_destroy - dumb fb callback helper for gem based drivers | |
272 | * | |
273 | * This implements the ->dumb_destroy kms driver callback for drivers which use | |
274 | * gem to manage their backing storage. | |
275 | */ | |
276 | int drm_gem_dumb_destroy(struct drm_file *file, | |
277 | struct drm_device *dev, | |
278 | uint32_t handle) | |
279 | { | |
280 | return drm_gem_handle_delete(file, handle); | |
281 | } | |
282 | EXPORT_SYMBOL(drm_gem_dumb_destroy); | |
283 | ||
673a394b | 284 | /** |
20228c44 DV |
285 | * drm_gem_handle_create_tail - internal functions to create a handle |
286 | * | |
287 | * This expects the dev->object_name_lock to be held already and will drop it | |
288 | * before returning. Used to avoid races in establishing new handles when | |
289 | * importing an object from either an flink name or a dma-buf. | |
673a394b EA |
290 | */ |
291 | int | |
20228c44 DV |
292 | drm_gem_handle_create_tail(struct drm_file *file_priv, |
293 | struct drm_gem_object *obj, | |
294 | u32 *handlep) | |
673a394b | 295 | { |
304eda32 BS |
296 | struct drm_device *dev = obj->dev; |
297 | int ret; | |
673a394b | 298 | |
20228c44 DV |
299 | WARN_ON(!mutex_is_locked(&dev->object_name_lock)); |
300 | ||
673a394b | 301 | /* |
2e928815 TH |
302 | * Get the user-visible handle using idr. Preload and perform |
303 | * allocation under our spinlock. | |
673a394b | 304 | */ |
2e928815 | 305 | idr_preload(GFP_KERNEL); |
673a394b | 306 | spin_lock(&file_priv->table_lock); |
2e928815 TH |
307 | |
308 | ret = idr_alloc(&file_priv->object_idr, obj, 1, 0, GFP_NOWAIT); | |
a8e11d1c DV |
309 | drm_gem_object_reference(obj); |
310 | obj->handle_count++; | |
673a394b | 311 | spin_unlock(&file_priv->table_lock); |
2e928815 | 312 | idr_preload_end(); |
cd4f013f | 313 | mutex_unlock(&dev->object_name_lock); |
a8e11d1c DV |
314 | if (ret < 0) { |
315 | drm_gem_object_handle_unreference_unlocked(obj); | |
673a394b | 316 | return ret; |
a8e11d1c | 317 | } |
2e928815 | 318 | *handlep = ret; |
673a394b | 319 | |
ca481c9b DH |
320 | ret = drm_vma_node_allow(&obj->vma_node, file_priv->filp); |
321 | if (ret) { | |
322 | drm_gem_handle_delete(file_priv, *handlep); | |
323 | return ret; | |
324 | } | |
304eda32 BS |
325 | |
326 | if (dev->driver->gem_open_object) { | |
327 | ret = dev->driver->gem_open_object(obj, file_priv); | |
328 | if (ret) { | |
329 | drm_gem_handle_delete(file_priv, *handlep); | |
330 | return ret; | |
331 | } | |
332 | } | |
333 | ||
673a394b EA |
334 | return 0; |
335 | } | |
20228c44 DV |
336 | |
337 | /** | |
338 | * Create a handle for this object. This adds a handle reference | |
339 | * to the object, which includes a regular reference count. Callers | |
340 | * will likely want to dereference the object afterwards. | |
341 | */ | |
342 | int | |
343 | drm_gem_handle_create(struct drm_file *file_priv, | |
344 | struct drm_gem_object *obj, | |
345 | u32 *handlep) | |
346 | { | |
347 | mutex_lock(&obj->dev->object_name_lock); | |
348 | ||
349 | return drm_gem_handle_create_tail(file_priv, obj, handlep); | |
350 | } | |
673a394b EA |
351 | EXPORT_SYMBOL(drm_gem_handle_create); |
352 | ||
75ef8b3b RC |
353 | |
354 | /** | |
355 | * drm_gem_free_mmap_offset - release a fake mmap offset for an object | |
356 | * @obj: obj in question | |
357 | * | |
358 | * This routine frees fake offsets allocated by drm_gem_create_mmap_offset(). | |
359 | */ | |
360 | void | |
361 | drm_gem_free_mmap_offset(struct drm_gem_object *obj) | |
362 | { | |
363 | struct drm_device *dev = obj->dev; | |
75ef8b3b | 364 | |
b04a5906 | 365 | drm_vma_offset_remove(dev->vma_offset_manager, &obj->vma_node); |
75ef8b3b RC |
366 | } |
367 | EXPORT_SYMBOL(drm_gem_free_mmap_offset); | |
368 | ||
369 | /** | |
367bbd49 | 370 | * drm_gem_create_mmap_offset_size - create a fake mmap offset for an object |
75ef8b3b | 371 | * @obj: obj in question |
367bbd49 | 372 | * @size: the virtual size |
75ef8b3b RC |
373 | * |
374 | * GEM memory mapping works by handing back to userspace a fake mmap offset | |
375 | * it can use in a subsequent mmap(2) call. The DRM core code then looks | |
376 | * up the object based on the offset and sets up the various memory mapping | |
377 | * structures. | |
378 | * | |
367bbd49 RC |
379 | * This routine allocates and attaches a fake offset for @obj, in cases where |
380 | * the virtual size differs from the physical size (ie. obj->size). Otherwise | |
381 | * just use drm_gem_create_mmap_offset(). | |
75ef8b3b RC |
382 | */ |
383 | int | |
367bbd49 | 384 | drm_gem_create_mmap_offset_size(struct drm_gem_object *obj, size_t size) |
75ef8b3b RC |
385 | { |
386 | struct drm_device *dev = obj->dev; | |
75ef8b3b | 387 | |
b04a5906 | 388 | return drm_vma_offset_add(dev->vma_offset_manager, &obj->vma_node, |
367bbd49 RC |
389 | size / PAGE_SIZE); |
390 | } | |
391 | EXPORT_SYMBOL(drm_gem_create_mmap_offset_size); | |
392 | ||
393 | /** | |
394 | * drm_gem_create_mmap_offset - create a fake mmap offset for an object | |
395 | * @obj: obj in question | |
396 | * | |
397 | * GEM memory mapping works by handing back to userspace a fake mmap offset | |
398 | * it can use in a subsequent mmap(2) call. The DRM core code then looks | |
399 | * up the object based on the offset and sets up the various memory mapping | |
400 | * structures. | |
401 | * | |
402 | * This routine allocates and attaches a fake offset for @obj. | |
403 | */ | |
404 | int drm_gem_create_mmap_offset(struct drm_gem_object *obj) | |
405 | { | |
406 | return drm_gem_create_mmap_offset_size(obj, obj->size); | |
75ef8b3b RC |
407 | } |
408 | EXPORT_SYMBOL(drm_gem_create_mmap_offset); | |
409 | ||
bcc5c9d5 RC |
410 | /** |
411 | * drm_gem_get_pages - helper to allocate backing pages for a GEM object | |
412 | * from shmem | |
413 | * @obj: obj in question | |
414 | * @gfpmask: gfp mask of requested pages | |
415 | */ | |
416 | struct page **drm_gem_get_pages(struct drm_gem_object *obj, gfp_t gfpmask) | |
417 | { | |
418 | struct inode *inode; | |
419 | struct address_space *mapping; | |
420 | struct page *p, **pages; | |
421 | int i, npages; | |
422 | ||
423 | /* This is the shared memory object that backs the GEM resource */ | |
424 | inode = file_inode(obj->filp); | |
425 | mapping = inode->i_mapping; | |
426 | ||
427 | /* We already BUG_ON() for non-page-aligned sizes in | |
428 | * drm_gem_object_init(), so we should never hit this unless | |
429 | * driver author is doing something really wrong: | |
430 | */ | |
431 | WARN_ON((obj->size & (PAGE_SIZE - 1)) != 0); | |
432 | ||
433 | npages = obj->size >> PAGE_SHIFT; | |
434 | ||
435 | pages = drm_malloc_ab(npages, sizeof(struct page *)); | |
436 | if (pages == NULL) | |
437 | return ERR_PTR(-ENOMEM); | |
438 | ||
439 | gfpmask |= mapping_gfp_mask(mapping); | |
440 | ||
441 | for (i = 0; i < npages; i++) { | |
442 | p = shmem_read_mapping_page_gfp(mapping, i, gfpmask); | |
443 | if (IS_ERR(p)) | |
444 | goto fail; | |
445 | pages[i] = p; | |
446 | ||
447 | /* There is a hypothetical issue w/ drivers that require | |
448 | * buffer memory in the low 4GB.. if the pages are un- | |
449 | * pinned, and swapped out, they can end up swapped back | |
450 | * in above 4GB. If pages are already in memory, then | |
451 | * shmem_read_mapping_page_gfp will ignore the gfpmask, | |
452 | * even if the already in-memory page disobeys the mask. | |
453 | * | |
454 | * It is only a theoretical issue today, because none of | |
455 | * the devices with this limitation can be populated with | |
456 | * enough memory to trigger the issue. But this BUG_ON() | |
457 | * is here as a reminder in case the problem with | |
458 | * shmem_read_mapping_page_gfp() isn't solved by the time | |
459 | * it does become a real issue. | |
460 | * | |
461 | * See this thread: http://lkml.org/lkml/2011/7/11/238 | |
462 | */ | |
463 | BUG_ON((gfpmask & __GFP_DMA32) && | |
464 | (page_to_pfn(p) >= 0x00100000UL)); | |
465 | } | |
466 | ||
467 | return pages; | |
468 | ||
469 | fail: | |
470 | while (i--) | |
471 | page_cache_release(pages[i]); | |
472 | ||
473 | drm_free_large(pages); | |
474 | return ERR_CAST(p); | |
475 | } | |
476 | EXPORT_SYMBOL(drm_gem_get_pages); | |
477 | ||
478 | /** | |
479 | * drm_gem_put_pages - helper to free backing pages for a GEM object | |
480 | * @obj: obj in question | |
481 | * @pages: pages to free | |
482 | * @dirty: if true, pages will be marked as dirty | |
483 | * @accessed: if true, the pages will be marked as accessed | |
484 | */ | |
485 | void drm_gem_put_pages(struct drm_gem_object *obj, struct page **pages, | |
486 | bool dirty, bool accessed) | |
487 | { | |
488 | int i, npages; | |
489 | ||
490 | /* We already BUG_ON() for non-page-aligned sizes in | |
491 | * drm_gem_object_init(), so we should never hit this unless | |
492 | * driver author is doing something really wrong: | |
493 | */ | |
494 | WARN_ON((obj->size & (PAGE_SIZE - 1)) != 0); | |
495 | ||
496 | npages = obj->size >> PAGE_SHIFT; | |
497 | ||
498 | for (i = 0; i < npages; i++) { | |
499 | if (dirty) | |
500 | set_page_dirty(pages[i]); | |
501 | ||
502 | if (accessed) | |
503 | mark_page_accessed(pages[i]); | |
504 | ||
505 | /* Undo the reference we took when populating the table */ | |
506 | page_cache_release(pages[i]); | |
507 | } | |
508 | ||
509 | drm_free_large(pages); | |
510 | } | |
511 | EXPORT_SYMBOL(drm_gem_put_pages); | |
512 | ||
673a394b EA |
513 | /** Returns a reference to the object named by the handle. */ |
514 | struct drm_gem_object * | |
515 | drm_gem_object_lookup(struct drm_device *dev, struct drm_file *filp, | |
a1a2d1d3 | 516 | u32 handle) |
673a394b EA |
517 | { |
518 | struct drm_gem_object *obj; | |
519 | ||
520 | spin_lock(&filp->table_lock); | |
521 | ||
522 | /* Check if we currently have a reference on the object */ | |
523 | obj = idr_find(&filp->object_idr, handle); | |
524 | if (obj == NULL) { | |
525 | spin_unlock(&filp->table_lock); | |
526 | return NULL; | |
527 | } | |
528 | ||
529 | drm_gem_object_reference(obj); | |
530 | ||
531 | spin_unlock(&filp->table_lock); | |
532 | ||
533 | return obj; | |
534 | } | |
535 | EXPORT_SYMBOL(drm_gem_object_lookup); | |
536 | ||
537 | /** | |
538 | * Releases the handle to an mm object. | |
539 | */ | |
540 | int | |
541 | drm_gem_close_ioctl(struct drm_device *dev, void *data, | |
542 | struct drm_file *file_priv) | |
543 | { | |
544 | struct drm_gem_close *args = data; | |
545 | int ret; | |
546 | ||
547 | if (!(dev->driver->driver_features & DRIVER_GEM)) | |
548 | return -ENODEV; | |
549 | ||
550 | ret = drm_gem_handle_delete(file_priv, args->handle); | |
551 | ||
552 | return ret; | |
553 | } | |
554 | ||
555 | /** | |
556 | * Create a global name for an object, returning the name. | |
557 | * | |
558 | * Note that the name does not hold a reference; when the object | |
559 | * is freed, the name goes away. | |
560 | */ | |
561 | int | |
562 | drm_gem_flink_ioctl(struct drm_device *dev, void *data, | |
563 | struct drm_file *file_priv) | |
564 | { | |
565 | struct drm_gem_flink *args = data; | |
566 | struct drm_gem_object *obj; | |
567 | int ret; | |
568 | ||
569 | if (!(dev->driver->driver_features & DRIVER_GEM)) | |
570 | return -ENODEV; | |
571 | ||
572 | obj = drm_gem_object_lookup(dev, file_priv, args->handle); | |
573 | if (obj == NULL) | |
bf79cb91 | 574 | return -ENOENT; |
673a394b | 575 | |
cd4f013f | 576 | mutex_lock(&dev->object_name_lock); |
2e928815 | 577 | idr_preload(GFP_KERNEL); |
a8e11d1c DV |
578 | /* prevent races with concurrent gem_close. */ |
579 | if (obj->handle_count == 0) { | |
580 | ret = -ENOENT; | |
581 | goto err; | |
582 | } | |
583 | ||
8d59bae5 | 584 | if (!obj->name) { |
2e928815 | 585 | ret = idr_alloc(&dev->object_name_idr, obj, 1, 0, GFP_NOWAIT); |
2e928815 | 586 | if (ret < 0) |
8d59bae5 | 587 | goto err; |
2e07fb22 YC |
588 | |
589 | obj->name = ret; | |
8d59bae5 | 590 | } |
3e49c4f4 | 591 | |
2e07fb22 YC |
592 | args->name = (uint64_t) obj->name; |
593 | ret = 0; | |
594 | ||
3e49c4f4 | 595 | err: |
2e07fb22 | 596 | idr_preload_end(); |
cd4f013f | 597 | mutex_unlock(&dev->object_name_lock); |
bc9025bd | 598 | drm_gem_object_unreference_unlocked(obj); |
3e49c4f4 | 599 | return ret; |
673a394b EA |
600 | } |
601 | ||
602 | /** | |
603 | * Open an object using the global name, returning a handle and the size. | |
604 | * | |
605 | * This handle (of course) holds a reference to the object, so the object | |
606 | * will not go away until the handle is deleted. | |
607 | */ | |
608 | int | |
609 | drm_gem_open_ioctl(struct drm_device *dev, void *data, | |
610 | struct drm_file *file_priv) | |
611 | { | |
612 | struct drm_gem_open *args = data; | |
613 | struct drm_gem_object *obj; | |
614 | int ret; | |
a1a2d1d3 | 615 | u32 handle; |
673a394b EA |
616 | |
617 | if (!(dev->driver->driver_features & DRIVER_GEM)) | |
618 | return -ENODEV; | |
619 | ||
cd4f013f | 620 | mutex_lock(&dev->object_name_lock); |
673a394b | 621 | obj = idr_find(&dev->object_name_idr, (int) args->name); |
20228c44 | 622 | if (obj) { |
673a394b | 623 | drm_gem_object_reference(obj); |
20228c44 DV |
624 | } else { |
625 | mutex_unlock(&dev->object_name_lock); | |
673a394b | 626 | return -ENOENT; |
20228c44 | 627 | } |
673a394b | 628 | |
20228c44 DV |
629 | /* drm_gem_handle_create_tail unlocks dev->object_name_lock. */ |
630 | ret = drm_gem_handle_create_tail(file_priv, obj, &handle); | |
bc9025bd | 631 | drm_gem_object_unreference_unlocked(obj); |
673a394b EA |
632 | if (ret) |
633 | return ret; | |
634 | ||
635 | args->handle = handle; | |
636 | args->size = obj->size; | |
637 | ||
638 | return 0; | |
639 | } | |
640 | ||
641 | /** | |
642 | * Called at device open time, sets up the structure for handling refcounting | |
643 | * of mm objects. | |
644 | */ | |
645 | void | |
646 | drm_gem_open(struct drm_device *dev, struct drm_file *file_private) | |
647 | { | |
648 | idr_init(&file_private->object_idr); | |
649 | spin_lock_init(&file_private->table_lock); | |
650 | } | |
651 | ||
652 | /** | |
653 | * Called at device close to release the file's | |
654 | * handle references on objects. | |
655 | */ | |
656 | static int | |
657 | drm_gem_object_release_handle(int id, void *ptr, void *data) | |
658 | { | |
304eda32 | 659 | struct drm_file *file_priv = data; |
673a394b | 660 | struct drm_gem_object *obj = ptr; |
304eda32 BS |
661 | struct drm_device *dev = obj->dev; |
662 | ||
9c784855 TR |
663 | if (drm_core_check_feature(dev, DRIVER_PRIME)) |
664 | drm_gem_remove_prime_handles(obj, file_priv); | |
ca481c9b | 665 | drm_vma_node_revoke(&obj->vma_node, file_priv->filp); |
3248877e | 666 | |
304eda32 BS |
667 | if (dev->driver->gem_close_object) |
668 | dev->driver->gem_close_object(obj, file_priv); | |
673a394b | 669 | |
bc9025bd | 670 | drm_gem_object_handle_unreference_unlocked(obj); |
673a394b EA |
671 | |
672 | return 0; | |
673 | } | |
674 | ||
675 | /** | |
676 | * Called at close time when the filp is going away. | |
677 | * | |
678 | * Releases any remaining references on objects by this filp. | |
679 | */ | |
680 | void | |
681 | drm_gem_release(struct drm_device *dev, struct drm_file *file_private) | |
682 | { | |
673a394b | 683 | idr_for_each(&file_private->object_idr, |
304eda32 | 684 | &drm_gem_object_release_handle, file_private); |
673a394b | 685 | idr_destroy(&file_private->object_idr); |
673a394b EA |
686 | } |
687 | ||
fd632aa3 DV |
688 | void |
689 | drm_gem_object_release(struct drm_gem_object *obj) | |
c3ae90c0 | 690 | { |
319c933c DV |
691 | WARN_ON(obj->dma_buf); |
692 | ||
62cb7011 AC |
693 | if (obj->filp) |
694 | fput(obj->filp); | |
c3ae90c0 | 695 | } |
fd632aa3 | 696 | EXPORT_SYMBOL(drm_gem_object_release); |
c3ae90c0 | 697 | |
673a394b EA |
698 | /** |
699 | * Called after the last reference to the object has been lost. | |
c3ae90c0 | 700 | * Must be called holding struct_ mutex |
673a394b EA |
701 | * |
702 | * Frees the object | |
703 | */ | |
704 | void | |
705 | drm_gem_object_free(struct kref *kref) | |
706 | { | |
707 | struct drm_gem_object *obj = (struct drm_gem_object *) kref; | |
708 | struct drm_device *dev = obj->dev; | |
709 | ||
710 | BUG_ON(!mutex_is_locked(&dev->struct_mutex)); | |
711 | ||
712 | if (dev->driver->gem_free_object != NULL) | |
713 | dev->driver->gem_free_object(obj); | |
673a394b EA |
714 | } |
715 | EXPORT_SYMBOL(drm_gem_object_free); | |
716 | ||
ab00b3e5 JB |
717 | void drm_gem_vm_open(struct vm_area_struct *vma) |
718 | { | |
719 | struct drm_gem_object *obj = vma->vm_private_data; | |
720 | ||
721 | drm_gem_object_reference(obj); | |
31dfbc93 CW |
722 | |
723 | mutex_lock(&obj->dev->struct_mutex); | |
b06d66be | 724 | drm_vm_open_locked(obj->dev, vma); |
31dfbc93 | 725 | mutex_unlock(&obj->dev->struct_mutex); |
ab00b3e5 JB |
726 | } |
727 | EXPORT_SYMBOL(drm_gem_vm_open); | |
728 | ||
729 | void drm_gem_vm_close(struct vm_area_struct *vma) | |
730 | { | |
731 | struct drm_gem_object *obj = vma->vm_private_data; | |
b74ad5ae | 732 | struct drm_device *dev = obj->dev; |
ab00b3e5 | 733 | |
b74ad5ae | 734 | mutex_lock(&dev->struct_mutex); |
b06d66be | 735 | drm_vm_close_locked(obj->dev, vma); |
31dfbc93 | 736 | drm_gem_object_unreference(obj); |
b74ad5ae | 737 | mutex_unlock(&dev->struct_mutex); |
ab00b3e5 JB |
738 | } |
739 | EXPORT_SYMBOL(drm_gem_vm_close); | |
740 | ||
1c5aafa6 LP |
741 | /** |
742 | * drm_gem_mmap_obj - memory map a GEM object | |
743 | * @obj: the GEM object to map | |
744 | * @obj_size: the object size to be mapped, in bytes | |
745 | * @vma: VMA for the area to be mapped | |
746 | * | |
747 | * Set up the VMA to prepare mapping of the GEM object using the gem_vm_ops | |
748 | * provided by the driver. Depending on their requirements, drivers can either | |
749 | * provide a fault handler in their gem_vm_ops (in which case any accesses to | |
750 | * the object will be trapped, to perform migration, GTT binding, surface | |
751 | * register allocation, or performance monitoring), or mmap the buffer memory | |
752 | * synchronously after calling drm_gem_mmap_obj. | |
753 | * | |
754 | * This function is mainly intended to implement the DMABUF mmap operation, when | |
755 | * the GEM object is not looked up based on its fake offset. To implement the | |
756 | * DRM mmap operation, drivers should use the drm_gem_mmap() function. | |
757 | * | |
ca481c9b DH |
758 | * drm_gem_mmap_obj() assumes the user is granted access to the buffer while |
759 | * drm_gem_mmap() prevents unprivileged users from mapping random objects. So | |
760 | * callers must verify access restrictions before calling this helper. | |
761 | * | |
4368dd84 YC |
762 | * NOTE: This function has to be protected with dev->struct_mutex |
763 | * | |
1c5aafa6 LP |
764 | * Return 0 or success or -EINVAL if the object size is smaller than the VMA |
765 | * size, or if no gem_vm_ops are provided. | |
766 | */ | |
767 | int drm_gem_mmap_obj(struct drm_gem_object *obj, unsigned long obj_size, | |
768 | struct vm_area_struct *vma) | |
769 | { | |
770 | struct drm_device *dev = obj->dev; | |
771 | ||
4368dd84 YC |
772 | lockdep_assert_held(&dev->struct_mutex); |
773 | ||
1c5aafa6 LP |
774 | /* Check for valid size. */ |
775 | if (obj_size < vma->vm_end - vma->vm_start) | |
776 | return -EINVAL; | |
777 | ||
778 | if (!dev->driver->gem_vm_ops) | |
779 | return -EINVAL; | |
780 | ||
781 | vma->vm_flags |= VM_IO | VM_PFNMAP | VM_DONTEXPAND | VM_DONTDUMP; | |
782 | vma->vm_ops = dev->driver->gem_vm_ops; | |
783 | vma->vm_private_data = obj; | |
784 | vma->vm_page_prot = pgprot_writecombine(vm_get_page_prot(vma->vm_flags)); | |
785 | ||
786 | /* Take a ref for this mapping of the object, so that the fault | |
787 | * handler can dereference the mmap offset's pointer to the object. | |
788 | * This reference is cleaned up by the corresponding vm_close | |
789 | * (which should happen whether the vma was created by this call, or | |
790 | * by a vm_open due to mremap or partial unmap or whatever). | |
791 | */ | |
792 | drm_gem_object_reference(obj); | |
793 | ||
794 | drm_vm_open_locked(dev, vma); | |
795 | return 0; | |
796 | } | |
797 | EXPORT_SYMBOL(drm_gem_mmap_obj); | |
ab00b3e5 | 798 | |
a2c0a97b JB |
799 | /** |
800 | * drm_gem_mmap - memory map routine for GEM objects | |
801 | * @filp: DRM file pointer | |
802 | * @vma: VMA for the area to be mapped | |
803 | * | |
804 | * If a driver supports GEM object mapping, mmap calls on the DRM file | |
805 | * descriptor will end up here. | |
806 | * | |
1c5aafa6 | 807 | * Look up the GEM object based on the offset passed in (vma->vm_pgoff will |
a2c0a97b | 808 | * contain the fake offset we created when the GTT map ioctl was called on |
1c5aafa6 | 809 | * the object) and map it with a call to drm_gem_mmap_obj(). |
ca481c9b DH |
810 | * |
811 | * If the caller is not granted access to the buffer object, the mmap will fail | |
812 | * with EACCES. Please see the vma manager for more information. | |
a2c0a97b JB |
813 | */ |
814 | int drm_gem_mmap(struct file *filp, struct vm_area_struct *vma) | |
815 | { | |
816 | struct drm_file *priv = filp->private_data; | |
817 | struct drm_device *dev = priv->minor->dev; | |
0de23977 DH |
818 | struct drm_gem_object *obj; |
819 | struct drm_vma_offset_node *node; | |
a2c0a97b JB |
820 | int ret = 0; |
821 | ||
2c07a21d DA |
822 | if (drm_device_is_unplugged(dev)) |
823 | return -ENODEV; | |
824 | ||
a2c0a97b JB |
825 | mutex_lock(&dev->struct_mutex); |
826 | ||
b04a5906 DV |
827 | node = drm_vma_offset_exact_lookup(dev->vma_offset_manager, |
828 | vma->vm_pgoff, | |
0de23977 DH |
829 | vma_pages(vma)); |
830 | if (!node) { | |
a2c0a97b JB |
831 | mutex_unlock(&dev->struct_mutex); |
832 | return drm_mmap(filp, vma); | |
ca481c9b DH |
833 | } else if (!drm_vma_node_is_allowed(node, filp)) { |
834 | mutex_unlock(&dev->struct_mutex); | |
835 | return -EACCES; | |
a2c0a97b JB |
836 | } |
837 | ||
0de23977 | 838 | obj = container_of(node, struct drm_gem_object, vma_node); |
aed2c03c | 839 | ret = drm_gem_mmap_obj(obj, drm_vma_node_size(node) << PAGE_SHIFT, vma); |
a2c0a97b | 840 | |
a2c0a97b JB |
841 | mutex_unlock(&dev->struct_mutex); |
842 | ||
843 | return ret; | |
844 | } | |
845 | EXPORT_SYMBOL(drm_gem_mmap); |