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