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