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> |
95cf9264 | 39 | #include <linux/mem_encrypt.h> |
fb4b4927 | 40 | #include <linux/pagevec.h> |
0500c04e | 41 | |
1c535876 | 42 | #include <drm/drm.h> |
0500c04e SR |
43 | #include <drm/drm_device.h> |
44 | #include <drm/drm_drv.h> | |
45 | #include <drm/drm_file.h> | |
d9fc9413 | 46 | #include <drm/drm_gem.h> |
45d58b40 | 47 | #include <drm/drm_print.h> |
0500c04e SR |
48 | #include <drm/drm_vma_manager.h> |
49 | ||
67d0ec4e | 50 | #include "drm_internal.h" |
673a394b EA |
51 | |
52 | /** @file drm_gem.c | |
53 | * | |
54 | * This file provides some of the base ioctls and library routines for | |
55 | * the graphics memory manager implemented by each device driver. | |
56 | * | |
57 | * Because various devices have different requirements in terms of | |
58 | * synchronization and migration strategies, implementing that is left up to | |
59 | * the driver, and all that the general API provides should be generic -- | |
60 | * allocating objects, reading/writing data with the cpu, freeing objects. | |
61 | * Even there, platform-dependent optimizations for reading/writing data with | |
62 | * the CPU mean we'll likely hook those out to driver-specific calls. However, | |
63 | * the DRI2 implementation wants to have at least allocate/mmap be generic. | |
64 | * | |
65 | * The goal was to have swap-backed object allocation managed through | |
66 | * struct file. However, file descriptors as handles to a struct file have | |
67 | * two major failings: | |
68 | * - Process limits prevent more than 1024 or so being used at a time by | |
69 | * default. | |
70 | * - Inability to allocate high fds will aggravate the X Server's select() | |
71 | * handling, and likely that of many GL client applications as well. | |
72 | * | |
73 | * This led to a plan of using our own integer IDs (called handles, following | |
74 | * DRM terminology) to mimic fds, and implement the fd syscalls we need as | |
75 | * ioctls. The objects themselves will still include the struct file so | |
76 | * that we can transition to fds if the required kernel infrastructure shows | |
77 | * up at a later date, and as our interface with shmfs for memory allocation. | |
78 | */ | |
79 | ||
80 | /** | |
89d61fc0 DV |
81 | * drm_gem_init - Initialize the GEM device fields |
82 | * @dev: drm_devic structure to initialize | |
673a394b | 83 | */ |
673a394b EA |
84 | int |
85 | drm_gem_init(struct drm_device *dev) | |
86 | { | |
b04a5906 | 87 | struct drm_vma_offset_manager *vma_offset_manager; |
a2c0a97b | 88 | |
cd4f013f | 89 | mutex_init(&dev->object_name_lock); |
e86584c5 | 90 | idr_init_base(&dev->object_name_idr, 1); |
a2c0a97b | 91 | |
b04a5906 DV |
92 | vma_offset_manager = kzalloc(sizeof(*vma_offset_manager), GFP_KERNEL); |
93 | if (!vma_offset_manager) { | |
a2c0a97b JB |
94 | DRM_ERROR("out of memory\n"); |
95 | return -ENOMEM; | |
96 | } | |
97 | ||
b04a5906 DV |
98 | dev->vma_offset_manager = vma_offset_manager; |
99 | drm_vma_offset_manager_init(vma_offset_manager, | |
0de23977 DH |
100 | DRM_FILE_PAGE_OFFSET_START, |
101 | DRM_FILE_PAGE_OFFSET_SIZE); | |
a2c0a97b | 102 | |
673a394b EA |
103 | return 0; |
104 | } | |
105 | ||
a2c0a97b JB |
106 | void |
107 | drm_gem_destroy(struct drm_device *dev) | |
108 | { | |
a2c0a97b | 109 | |
b04a5906 DV |
110 | drm_vma_offset_manager_destroy(dev->vma_offset_manager); |
111 | kfree(dev->vma_offset_manager); | |
112 | dev->vma_offset_manager = NULL; | |
a2c0a97b JB |
113 | } |
114 | ||
1d397043 | 115 | /** |
89d61fc0 DV |
116 | * drm_gem_object_init - initialize an allocated shmem-backed GEM object |
117 | * @dev: drm_device the object should be initialized for | |
118 | * @obj: drm_gem_object to initialize | |
119 | * @size: object size | |
120 | * | |
62cb7011 | 121 | * Initialize an already allocated GEM object of the specified size with |
1d397043 DV |
122 | * shmfs backing store. |
123 | */ | |
124 | int drm_gem_object_init(struct drm_device *dev, | |
125 | struct drm_gem_object *obj, size_t size) | |
126 | { | |
89c8233f | 127 | struct file *filp; |
1d397043 | 128 | |
6ab11a26 DV |
129 | drm_gem_private_object_init(dev, obj, size); |
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 | 135 | obj->filp = filp; |
1d397043 | 136 | |
1d397043 DV |
137 | return 0; |
138 | } | |
139 | EXPORT_SYMBOL(drm_gem_object_init); | |
140 | ||
62cb7011 | 141 | /** |
2a5706a3 | 142 | * drm_gem_private_object_init - initialize an allocated private GEM object |
89d61fc0 DV |
143 | * @dev: drm_device the object should be initialized for |
144 | * @obj: drm_gem_object to initialize | |
145 | * @size: object size | |
146 | * | |
62cb7011 AC |
147 | * Initialize an already allocated GEM object of the specified size with |
148 | * no GEM provided backing store. Instead the caller is responsible for | |
149 | * backing the object and handling it. | |
150 | */ | |
89c8233f DH |
151 | void drm_gem_private_object_init(struct drm_device *dev, |
152 | struct drm_gem_object *obj, size_t size) | |
62cb7011 AC |
153 | { |
154 | BUG_ON((size & (PAGE_SIZE - 1)) != 0); | |
155 | ||
156 | obj->dev = dev; | |
157 | obj->filp = NULL; | |
158 | ||
159 | kref_init(&obj->refcount); | |
a8e11d1c | 160 | obj->handle_count = 0; |
62cb7011 | 161 | obj->size = size; |
52791eee | 162 | dma_resv_init(&obj->_resv); |
1ba62714 RH |
163 | if (!obj->resv) |
164 | obj->resv = &obj->_resv; | |
165 | ||
88d7ebe5 | 166 | drm_vma_node_reset(&obj->vma_node); |
62cb7011 AC |
167 | } |
168 | EXPORT_SYMBOL(drm_gem_private_object_init); | |
169 | ||
0ff926c7 DA |
170 | static void |
171 | drm_gem_remove_prime_handles(struct drm_gem_object *obj, struct drm_file *filp) | |
172 | { | |
319c933c DV |
173 | /* |
174 | * Note: obj->dma_buf can't disappear as long as we still hold a | |
175 | * handle reference in obj->handle_count. | |
176 | */ | |
d0b2c533 | 177 | mutex_lock(&filp->prime.lock); |
319c933c | 178 | if (obj->dma_buf) { |
d0b2c533 DV |
179 | drm_prime_remove_buf_handle_locked(&filp->prime, |
180 | obj->dma_buf); | |
0ff926c7 | 181 | } |
d0b2c533 | 182 | mutex_unlock(&filp->prime.lock); |
0ff926c7 DA |
183 | } |
184 | ||
36da5908 | 185 | /** |
c6a84325 | 186 | * drm_gem_object_handle_free - release resources bound to userspace handles |
89d61fc0 DV |
187 | * @obj: GEM object to clean up. |
188 | * | |
36da5908 DV |
189 | * Called after the last handle to the object has been closed |
190 | * | |
191 | * Removes any name for the object. Note that this must be | |
192 | * called before drm_gem_object_free or we'll be touching | |
193 | * freed memory | |
194 | */ | |
195 | static void drm_gem_object_handle_free(struct drm_gem_object *obj) | |
196 | { | |
197 | struct drm_device *dev = obj->dev; | |
198 | ||
199 | /* Remove any name for this object */ | |
36da5908 DV |
200 | if (obj->name) { |
201 | idr_remove(&dev->object_name_idr, obj->name); | |
202 | obj->name = 0; | |
a8e11d1c | 203 | } |
36da5908 DV |
204 | } |
205 | ||
319c933c DV |
206 | static void drm_gem_object_exported_dma_buf_free(struct drm_gem_object *obj) |
207 | { | |
208 | /* Unbreak the reference cycle if we have an exported dma_buf. */ | |
209 | if (obj->dma_buf) { | |
210 | dma_buf_put(obj->dma_buf); | |
211 | obj->dma_buf = NULL; | |
212 | } | |
213 | } | |
214 | ||
becee2a5 | 215 | static void |
e6b62714 | 216 | drm_gem_object_handle_put_unlocked(struct drm_gem_object *obj) |
36da5908 | 217 | { |
98a8883a CW |
218 | struct drm_device *dev = obj->dev; |
219 | bool final = false; | |
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 | ||
98a8883a | 230 | mutex_lock(&dev->object_name_lock); |
319c933c | 231 | if (--obj->handle_count == 0) { |
36da5908 | 232 | drm_gem_object_handle_free(obj); |
319c933c | 233 | drm_gem_object_exported_dma_buf_free(obj); |
98a8883a | 234 | final = true; |
319c933c | 235 | } |
98a8883a | 236 | mutex_unlock(&dev->object_name_lock); |
a8e11d1c | 237 | |
98a8883a | 238 | if (final) |
e6b62714 | 239 | drm_gem_object_put_unlocked(obj); |
36da5908 DV |
240 | } |
241 | ||
8815b23a CW |
242 | /* |
243 | * Called at device or object close to release the file's | |
244 | * handle references on objects. | |
245 | */ | |
246 | static int | |
247 | drm_gem_object_release_handle(int id, void *ptr, void *data) | |
248 | { | |
249 | struct drm_file *file_priv = data; | |
250 | struct drm_gem_object *obj = ptr; | |
251 | struct drm_device *dev = obj->dev; | |
252 | ||
b39b5394 NT |
253 | if (obj->funcs && obj->funcs->close) |
254 | obj->funcs->close(obj, file_priv); | |
255 | else if (dev->driver->gem_close_object) | |
d0a133f7 CW |
256 | dev->driver->gem_close_object(obj, file_priv); |
257 | ||
ae75f836 | 258 | drm_gem_remove_prime_handles(obj, file_priv); |
d9a1f0b4 | 259 | drm_vma_node_revoke(&obj->vma_node, file_priv); |
8815b23a | 260 | |
e6b62714 | 261 | drm_gem_object_handle_put_unlocked(obj); |
8815b23a CW |
262 | |
263 | return 0; | |
264 | } | |
265 | ||
673a394b | 266 | /** |
89d61fc0 DV |
267 | * drm_gem_handle_delete - deletes the given file-private handle |
268 | * @filp: drm file-private structure to use for the handle look up | |
269 | * @handle: userspace handle to delete | |
270 | * | |
df2e0900 DV |
271 | * Removes the GEM handle from the @filp lookup table which has been added with |
272 | * drm_gem_handle_create(). If this is the last handle also cleans up linked | |
273 | * resources like GEM names. | |
673a394b | 274 | */ |
ff72145b | 275 | int |
a1a2d1d3 | 276 | drm_gem_handle_delete(struct drm_file *filp, u32 handle) |
673a394b | 277 | { |
673a394b EA |
278 | struct drm_gem_object *obj; |
279 | ||
673a394b EA |
280 | spin_lock(&filp->table_lock); |
281 | ||
282 | /* Check if we currently have a reference on the object */ | |
f6cd7dae CW |
283 | obj = idr_replace(&filp->object_idr, NULL, handle); |
284 | spin_unlock(&filp->table_lock); | |
285 | if (IS_ERR_OR_NULL(obj)) | |
673a394b | 286 | return -EINVAL; |
673a394b | 287 | |
f6cd7dae CW |
288 | /* Release driver's reference and decrement refcount. */ |
289 | drm_gem_object_release_handle(handle, obj, filp); | |
290 | ||
291 | /* And finally make the handle available for future allocations. */ | |
292 | spin_lock(&filp->table_lock); | |
673a394b EA |
293 | idr_remove(&filp->object_idr, handle); |
294 | spin_unlock(&filp->table_lock); | |
295 | ||
673a394b EA |
296 | return 0; |
297 | } | |
ff72145b | 298 | EXPORT_SYMBOL(drm_gem_handle_delete); |
673a394b | 299 | |
db611527 | 300 | /** |
abd4e745 | 301 | * drm_gem_dumb_map_offset - return the fake mmap offset for a gem object |
db611527 NT |
302 | * @file: drm file-private structure containing the gem object |
303 | * @dev: corresponding drm_device | |
304 | * @handle: gem object handle | |
305 | * @offset: return location for the fake mmap offset | |
306 | * | |
307 | * This implements the &drm_driver.dumb_map_offset kms driver callback for | |
308 | * drivers which use gem to manage their backing storage. | |
309 | * | |
310 | * Returns: | |
311 | * 0 on success or a negative error code on failure. | |
312 | */ | |
abd4e745 | 313 | int drm_gem_dumb_map_offset(struct drm_file *file, struct drm_device *dev, |
db611527 NT |
314 | u32 handle, u64 *offset) |
315 | { | |
316 | struct drm_gem_object *obj; | |
317 | int ret; | |
318 | ||
319 | obj = drm_gem_object_lookup(file, handle); | |
320 | if (!obj) | |
321 | return -ENOENT; | |
322 | ||
90378e58 NT |
323 | /* Don't allow imported objects to be mapped */ |
324 | if (obj->import_attach) { | |
325 | ret = -EINVAL; | |
326 | goto out; | |
327 | } | |
328 | ||
db611527 NT |
329 | ret = drm_gem_create_mmap_offset(obj); |
330 | if (ret) | |
331 | goto out; | |
332 | ||
333 | *offset = drm_vma_node_offset_addr(&obj->vma_node); | |
334 | out: | |
335 | drm_gem_object_put_unlocked(obj); | |
336 | ||
337 | return ret; | |
338 | } | |
abd4e745 | 339 | EXPORT_SYMBOL_GPL(drm_gem_dumb_map_offset); |
db611527 | 340 | |
43387b37 DV |
341 | /** |
342 | * drm_gem_dumb_destroy - dumb fb callback helper for gem based drivers | |
89d61fc0 DV |
343 | * @file: drm file-private structure to remove the dumb handle from |
344 | * @dev: corresponding drm_device | |
345 | * @handle: the dumb handle to remove | |
1dd3a060 | 346 | * |
940eba2d DV |
347 | * This implements the &drm_driver.dumb_destroy kms driver callback for drivers |
348 | * which use gem to manage their backing storage. | |
43387b37 DV |
349 | */ |
350 | int drm_gem_dumb_destroy(struct drm_file *file, | |
351 | struct drm_device *dev, | |
352 | uint32_t handle) | |
353 | { | |
354 | return drm_gem_handle_delete(file, handle); | |
355 | } | |
356 | EXPORT_SYMBOL(drm_gem_dumb_destroy); | |
357 | ||
673a394b | 358 | /** |
20228c44 | 359 | * drm_gem_handle_create_tail - internal functions to create a handle |
89d61fc0 DV |
360 | * @file_priv: drm file-private structure to register the handle for |
361 | * @obj: object to register | |
8bf8180f | 362 | * @handlep: pointer to return the created handle to the caller |
1dd3a060 | 363 | * |
940eba2d DV |
364 | * This expects the &drm_device.object_name_lock to be held already and will |
365 | * drop it before returning. Used to avoid races in establishing new handles | |
366 | * when importing an object from either an flink name or a dma-buf. | |
df2e0900 DV |
367 | * |
368 | * Handles must be release again through drm_gem_handle_delete(). This is done | |
369 | * when userspace closes @file_priv for all attached handles, or through the | |
370 | * GEM_CLOSE ioctl for individual handles. | |
673a394b EA |
371 | */ |
372 | int | |
20228c44 DV |
373 | drm_gem_handle_create_tail(struct drm_file *file_priv, |
374 | struct drm_gem_object *obj, | |
375 | u32 *handlep) | |
673a394b | 376 | { |
304eda32 | 377 | struct drm_device *dev = obj->dev; |
9649399e | 378 | u32 handle; |
304eda32 | 379 | int ret; |
673a394b | 380 | |
20228c44 | 381 | WARN_ON(!mutex_is_locked(&dev->object_name_lock)); |
98a8883a | 382 | if (obj->handle_count++ == 0) |
e6b62714 | 383 | drm_gem_object_get(obj); |
20228c44 | 384 | |
673a394b | 385 | /* |
2e928815 TH |
386 | * Get the user-visible handle using idr. Preload and perform |
387 | * allocation under our spinlock. | |
673a394b | 388 | */ |
2e928815 | 389 | idr_preload(GFP_KERNEL); |
673a394b | 390 | spin_lock(&file_priv->table_lock); |
2e928815 TH |
391 | |
392 | ret = idr_alloc(&file_priv->object_idr, obj, 1, 0, GFP_NOWAIT); | |
98a8883a | 393 | |
673a394b | 394 | spin_unlock(&file_priv->table_lock); |
2e928815 | 395 | idr_preload_end(); |
98a8883a | 396 | |
cd4f013f | 397 | mutex_unlock(&dev->object_name_lock); |
6984128d CW |
398 | if (ret < 0) |
399 | goto err_unref; | |
400 | ||
9649399e | 401 | handle = ret; |
673a394b | 402 | |
d9a1f0b4 | 403 | ret = drm_vma_node_allow(&obj->vma_node, file_priv); |
6984128d CW |
404 | if (ret) |
405 | goto err_remove; | |
304eda32 | 406 | |
b39b5394 NT |
407 | if (obj->funcs && obj->funcs->open) { |
408 | ret = obj->funcs->open(obj, file_priv); | |
409 | if (ret) | |
410 | goto err_revoke; | |
411 | } else if (dev->driver->gem_open_object) { | |
304eda32 | 412 | ret = dev->driver->gem_open_object(obj, file_priv); |
6984128d CW |
413 | if (ret) |
414 | goto err_revoke; | |
304eda32 BS |
415 | } |
416 | ||
9649399e | 417 | *handlep = handle; |
673a394b | 418 | return 0; |
6984128d CW |
419 | |
420 | err_revoke: | |
d9a1f0b4 | 421 | drm_vma_node_revoke(&obj->vma_node, file_priv); |
6984128d CW |
422 | err_remove: |
423 | spin_lock(&file_priv->table_lock); | |
9649399e | 424 | idr_remove(&file_priv->object_idr, handle); |
6984128d CW |
425 | spin_unlock(&file_priv->table_lock); |
426 | err_unref: | |
e6b62714 | 427 | drm_gem_object_handle_put_unlocked(obj); |
6984128d | 428 | return ret; |
673a394b | 429 | } |
20228c44 DV |
430 | |
431 | /** | |
8bf8180f | 432 | * drm_gem_handle_create - create a gem handle for an object |
89d61fc0 DV |
433 | * @file_priv: drm file-private structure to register the handle for |
434 | * @obj: object to register | |
435 | * @handlep: pionter to return the created handle to the caller | |
436 | * | |
39031176 DV |
437 | * Create a handle for this object. This adds a handle reference to the object, |
438 | * which includes a regular reference count. Callers will likely want to | |
439 | * dereference the object afterwards. | |
440 | * | |
441 | * Since this publishes @obj to userspace it must be fully set up by this point, | |
442 | * drivers must call this last in their buffer object creation callbacks. | |
20228c44 | 443 | */ |
8bf8180f TR |
444 | int drm_gem_handle_create(struct drm_file *file_priv, |
445 | struct drm_gem_object *obj, | |
446 | u32 *handlep) | |
20228c44 DV |
447 | { |
448 | mutex_lock(&obj->dev->object_name_lock); | |
449 | ||
450 | return drm_gem_handle_create_tail(file_priv, obj, handlep); | |
451 | } | |
673a394b EA |
452 | EXPORT_SYMBOL(drm_gem_handle_create); |
453 | ||
75ef8b3b RC |
454 | |
455 | /** | |
456 | * drm_gem_free_mmap_offset - release a fake mmap offset for an object | |
457 | * @obj: obj in question | |
458 | * | |
459 | * This routine frees fake offsets allocated by drm_gem_create_mmap_offset(). | |
f74418a4 DV |
460 | * |
461 | * Note that drm_gem_object_release() already calls this function, so drivers | |
462 | * don't have to take care of releasing the mmap offset themselves when freeing | |
463 | * the GEM object. | |
75ef8b3b RC |
464 | */ |
465 | void | |
466 | drm_gem_free_mmap_offset(struct drm_gem_object *obj) | |
467 | { | |
468 | struct drm_device *dev = obj->dev; | |
75ef8b3b | 469 | |
b04a5906 | 470 | drm_vma_offset_remove(dev->vma_offset_manager, &obj->vma_node); |
75ef8b3b RC |
471 | } |
472 | EXPORT_SYMBOL(drm_gem_free_mmap_offset); | |
473 | ||
474 | /** | |
367bbd49 | 475 | * drm_gem_create_mmap_offset_size - create a fake mmap offset for an object |
75ef8b3b | 476 | * @obj: obj in question |
367bbd49 | 477 | * @size: the virtual size |
75ef8b3b RC |
478 | * |
479 | * GEM memory mapping works by handing back to userspace a fake mmap offset | |
480 | * it can use in a subsequent mmap(2) call. The DRM core code then looks | |
481 | * up the object based on the offset and sets up the various memory mapping | |
482 | * structures. | |
483 | * | |
367bbd49 | 484 | * This routine allocates and attaches a fake offset for @obj, in cases where |
940eba2d DV |
485 | * the virtual size differs from the physical size (ie. &drm_gem_object.size). |
486 | * Otherwise just use drm_gem_create_mmap_offset(). | |
f74418a4 DV |
487 | * |
488 | * This function is idempotent and handles an already allocated mmap offset | |
489 | * transparently. Drivers do not need to check for this case. | |
75ef8b3b RC |
490 | */ |
491 | int | |
367bbd49 | 492 | drm_gem_create_mmap_offset_size(struct drm_gem_object *obj, size_t size) |
75ef8b3b RC |
493 | { |
494 | struct drm_device *dev = obj->dev; | |
75ef8b3b | 495 | |
b04a5906 | 496 | return drm_vma_offset_add(dev->vma_offset_manager, &obj->vma_node, |
367bbd49 RC |
497 | size / PAGE_SIZE); |
498 | } | |
499 | EXPORT_SYMBOL(drm_gem_create_mmap_offset_size); | |
500 | ||
501 | /** | |
502 | * drm_gem_create_mmap_offset - create a fake mmap offset for an object | |
503 | * @obj: obj in question | |
504 | * | |
505 | * GEM memory mapping works by handing back to userspace a fake mmap offset | |
506 | * it can use in a subsequent mmap(2) call. The DRM core code then looks | |
507 | * up the object based on the offset and sets up the various memory mapping | |
508 | * structures. | |
509 | * | |
510 | * This routine allocates and attaches a fake offset for @obj. | |
f74418a4 DV |
511 | * |
512 | * Drivers can call drm_gem_free_mmap_offset() before freeing @obj to release | |
513 | * the fake offset again. | |
367bbd49 RC |
514 | */ |
515 | int drm_gem_create_mmap_offset(struct drm_gem_object *obj) | |
516 | { | |
517 | return drm_gem_create_mmap_offset_size(obj, obj->size); | |
75ef8b3b RC |
518 | } |
519 | EXPORT_SYMBOL(drm_gem_create_mmap_offset); | |
520 | ||
fb4b4927 KHY |
521 | /* |
522 | * Move pages to appropriate lru and release the pagevec, decrementing the | |
523 | * ref count of those pages. | |
524 | */ | |
525 | static void drm_gem_check_release_pagevec(struct pagevec *pvec) | |
526 | { | |
527 | check_move_unevictable_pages(pvec); | |
528 | __pagevec_release(pvec); | |
529 | cond_resched(); | |
530 | } | |
531 | ||
bcc5c9d5 RC |
532 | /** |
533 | * drm_gem_get_pages - helper to allocate backing pages for a GEM object | |
534 | * from shmem | |
535 | * @obj: obj in question | |
0cdbe8ac DH |
536 | * |
537 | * This reads the page-array of the shmem-backing storage of the given gem | |
538 | * object. An array of pages is returned. If a page is not allocated or | |
539 | * swapped-out, this will allocate/swap-in the required pages. Note that the | |
540 | * whole object is covered by the page-array and pinned in memory. | |
541 | * | |
542 | * Use drm_gem_put_pages() to release the array and unpin all pages. | |
543 | * | |
544 | * This uses the GFP-mask set on the shmem-mapping (see mapping_set_gfp_mask()). | |
545 | * If you require other GFP-masks, you have to do those allocations yourself. | |
546 | * | |
547 | * Note that you are not allowed to change gfp-zones during runtime. That is, | |
548 | * shmem_read_mapping_page_gfp() must be called with the same gfp_zone(gfp) as | |
549 | * set during initialization. If you have special zone constraints, set them | |
5b9fbfff | 550 | * after drm_gem_object_init() via mapping_set_gfp_mask(). shmem-core takes care |
0cdbe8ac | 551 | * to keep pages in the required zone during swap-in. |
bcc5c9d5 | 552 | */ |
0cdbe8ac | 553 | struct page **drm_gem_get_pages(struct drm_gem_object *obj) |
bcc5c9d5 | 554 | { |
bcc5c9d5 RC |
555 | struct address_space *mapping; |
556 | struct page *p, **pages; | |
fb4b4927 | 557 | struct pagevec pvec; |
bcc5c9d5 RC |
558 | int i, npages; |
559 | ||
560 | /* This is the shared memory object that backs the GEM resource */ | |
93c76a3d | 561 | mapping = obj->filp->f_mapping; |
bcc5c9d5 RC |
562 | |
563 | /* We already BUG_ON() for non-page-aligned sizes in | |
564 | * drm_gem_object_init(), so we should never hit this unless | |
565 | * driver author is doing something really wrong: | |
566 | */ | |
567 | WARN_ON((obj->size & (PAGE_SIZE - 1)) != 0); | |
568 | ||
569 | npages = obj->size >> PAGE_SHIFT; | |
570 | ||
2098105e | 571 | pages = kvmalloc_array(npages, sizeof(struct page *), GFP_KERNEL); |
bcc5c9d5 RC |
572 | if (pages == NULL) |
573 | return ERR_PTR(-ENOMEM); | |
574 | ||
fb4b4927 KHY |
575 | mapping_set_unevictable(mapping); |
576 | ||
bcc5c9d5 | 577 | for (i = 0; i < npages; i++) { |
0cdbe8ac | 578 | p = shmem_read_mapping_page(mapping, i); |
bcc5c9d5 RC |
579 | if (IS_ERR(p)) |
580 | goto fail; | |
581 | pages[i] = p; | |
582 | ||
2123000b DH |
583 | /* Make sure shmem keeps __GFP_DMA32 allocated pages in the |
584 | * correct region during swapin. Note that this requires | |
585 | * __GFP_DMA32 to be set in mapping_gfp_mask(inode->i_mapping) | |
586 | * so shmem can relocate pages during swapin if required. | |
bcc5c9d5 | 587 | */ |
c62d2555 | 588 | BUG_ON(mapping_gfp_constraint(mapping, __GFP_DMA32) && |
bcc5c9d5 RC |
589 | (page_to_pfn(p) >= 0x00100000UL)); |
590 | } | |
591 | ||
592 | return pages; | |
593 | ||
594 | fail: | |
fb4b4927 KHY |
595 | mapping_clear_unevictable(mapping); |
596 | pagevec_init(&pvec); | |
597 | while (i--) { | |
598 | if (!pagevec_add(&pvec, pages[i])) | |
599 | drm_gem_check_release_pagevec(&pvec); | |
600 | } | |
601 | if (pagevec_count(&pvec)) | |
602 | drm_gem_check_release_pagevec(&pvec); | |
bcc5c9d5 | 603 | |
2098105e | 604 | kvfree(pages); |
bcc5c9d5 RC |
605 | return ERR_CAST(p); |
606 | } | |
607 | EXPORT_SYMBOL(drm_gem_get_pages); | |
608 | ||
609 | /** | |
610 | * drm_gem_put_pages - helper to free backing pages for a GEM object | |
611 | * @obj: obj in question | |
612 | * @pages: pages to free | |
613 | * @dirty: if true, pages will be marked as dirty | |
614 | * @accessed: if true, the pages will be marked as accessed | |
615 | */ | |
616 | void drm_gem_put_pages(struct drm_gem_object *obj, struct page **pages, | |
617 | bool dirty, bool accessed) | |
618 | { | |
619 | int i, npages; | |
fb4b4927 KHY |
620 | struct address_space *mapping; |
621 | struct pagevec pvec; | |
622 | ||
623 | mapping = file_inode(obj->filp)->i_mapping; | |
624 | mapping_clear_unevictable(mapping); | |
bcc5c9d5 RC |
625 | |
626 | /* We already BUG_ON() for non-page-aligned sizes in | |
627 | * drm_gem_object_init(), so we should never hit this unless | |
628 | * driver author is doing something really wrong: | |
629 | */ | |
630 | WARN_ON((obj->size & (PAGE_SIZE - 1)) != 0); | |
631 | ||
632 | npages = obj->size >> PAGE_SHIFT; | |
633 | ||
fb4b4927 | 634 | pagevec_init(&pvec); |
bcc5c9d5 | 635 | for (i = 0; i < npages; i++) { |
930a4024 RH |
636 | if (!pages[i]) |
637 | continue; | |
638 | ||
bcc5c9d5 RC |
639 | if (dirty) |
640 | set_page_dirty(pages[i]); | |
641 | ||
642 | if (accessed) | |
643 | mark_page_accessed(pages[i]); | |
644 | ||
645 | /* Undo the reference we took when populating the table */ | |
fb4b4927 KHY |
646 | if (!pagevec_add(&pvec, pages[i])) |
647 | drm_gem_check_release_pagevec(&pvec); | |
bcc5c9d5 | 648 | } |
fb4b4927 KHY |
649 | if (pagevec_count(&pvec)) |
650 | drm_gem_check_release_pagevec(&pvec); | |
bcc5c9d5 | 651 | |
2098105e | 652 | kvfree(pages); |
bcc5c9d5 RC |
653 | } |
654 | EXPORT_SYMBOL(drm_gem_put_pages); | |
655 | ||
c117aa4d RH |
656 | static int objects_lookup(struct drm_file *filp, u32 *handle, int count, |
657 | struct drm_gem_object **objs) | |
658 | { | |
659 | int i, ret = 0; | |
660 | struct drm_gem_object *obj; | |
661 | ||
662 | spin_lock(&filp->table_lock); | |
663 | ||
664 | for (i = 0; i < count; i++) { | |
665 | /* Check if we currently have a reference on the object */ | |
666 | obj = idr_find(&filp->object_idr, handle[i]); | |
667 | if (!obj) { | |
668 | ret = -ENOENT; | |
669 | break; | |
670 | } | |
671 | drm_gem_object_get(obj); | |
672 | objs[i] = obj; | |
673 | } | |
674 | spin_unlock(&filp->table_lock); | |
675 | ||
676 | return ret; | |
677 | } | |
678 | ||
679 | /** | |
680 | * drm_gem_objects_lookup - look up GEM objects from an array of handles | |
681 | * @filp: DRM file private date | |
682 | * @bo_handles: user pointer to array of userspace handle | |
683 | * @count: size of handle array | |
684 | * @objs_out: returned pointer to array of drm_gem_object pointers | |
685 | * | |
686 | * Takes an array of userspace handles and returns a newly allocated array of | |
687 | * GEM objects. | |
688 | * | |
689 | * For a single handle lookup, use drm_gem_object_lookup(). | |
690 | * | |
691 | * Returns: | |
692 | * | |
693 | * @objs filled in with GEM object pointers. Returned GEM objects need to be | |
694 | * released with drm_gem_object_put(). -ENOENT is returned on a lookup | |
695 | * failure. 0 is returned on success. | |
696 | * | |
697 | */ | |
698 | int drm_gem_objects_lookup(struct drm_file *filp, void __user *bo_handles, | |
699 | int count, struct drm_gem_object ***objs_out) | |
700 | { | |
701 | int ret; | |
702 | u32 *handles; | |
703 | struct drm_gem_object **objs; | |
704 | ||
705 | if (!count) | |
706 | return 0; | |
707 | ||
708 | objs = kvmalloc_array(count, sizeof(struct drm_gem_object *), | |
709 | GFP_KERNEL | __GFP_ZERO); | |
710 | if (!objs) | |
711 | return -ENOMEM; | |
712 | ||
713 | handles = kvmalloc_array(count, sizeof(u32), GFP_KERNEL); | |
714 | if (!handles) { | |
715 | ret = -ENOMEM; | |
716 | goto out; | |
717 | } | |
718 | ||
719 | if (copy_from_user(handles, bo_handles, count * sizeof(u32))) { | |
720 | ret = -EFAULT; | |
721 | DRM_DEBUG("Failed to copy in GEM handles\n"); | |
722 | goto out; | |
723 | } | |
724 | ||
725 | ret = objects_lookup(filp, handles, count, objs); | |
726 | *objs_out = objs; | |
727 | ||
728 | out: | |
729 | kvfree(handles); | |
730 | return ret; | |
731 | ||
732 | } | |
733 | EXPORT_SYMBOL(drm_gem_objects_lookup); | |
734 | ||
df2e0900 | 735 | /** |
1e55a53a | 736 | * drm_gem_object_lookup - look up a GEM object from its handle |
df2e0900 DV |
737 | * @filp: DRM file private date |
738 | * @handle: userspace handle | |
739 | * | |
740 | * Returns: | |
741 | * | |
742 | * A reference to the object named by the handle if such exists on @filp, NULL | |
743 | * otherwise. | |
c117aa4d RH |
744 | * |
745 | * If looking up an array of handles, use drm_gem_objects_lookup(). | |
df2e0900 | 746 | */ |
673a394b | 747 | struct drm_gem_object * |
a8ad0bd8 | 748 | drm_gem_object_lookup(struct drm_file *filp, u32 handle) |
673a394b | 749 | { |
c117aa4d | 750 | struct drm_gem_object *obj = NULL; |
673a394b | 751 | |
c117aa4d | 752 | objects_lookup(filp, &handle, 1, &obj); |
673a394b EA |
753 | return obj; |
754 | } | |
755 | EXPORT_SYMBOL(drm_gem_object_lookup); | |
756 | ||
1ba62714 | 757 | /** |
52791eee | 758 | * drm_gem_dma_resv_wait - Wait on GEM object's reservation's objects |
1ba62714 RH |
759 | * shared and/or exclusive fences. |
760 | * @filep: DRM file private date | |
761 | * @handle: userspace handle | |
762 | * @wait_all: if true, wait on all fences, else wait on just exclusive fence | |
763 | * @timeout: timeout value in jiffies or zero to return immediately | |
764 | * | |
765 | * Returns: | |
766 | * | |
767 | * Returns -ERESTARTSYS if interrupted, 0 if the wait timed out, or | |
768 | * greater than 0 on success. | |
769 | */ | |
52791eee | 770 | long drm_gem_dma_resv_wait(struct drm_file *filep, u32 handle, |
1ba62714 RH |
771 | bool wait_all, unsigned long timeout) |
772 | { | |
773 | long ret; | |
774 | struct drm_gem_object *obj; | |
775 | ||
776 | obj = drm_gem_object_lookup(filep, handle); | |
777 | if (!obj) { | |
778 | DRM_DEBUG("Failed to look up GEM BO %d\n", handle); | |
779 | return -EINVAL; | |
780 | } | |
781 | ||
52791eee | 782 | ret = dma_resv_wait_timeout_rcu(obj->resv, wait_all, |
1ba62714 RH |
783 | true, timeout); |
784 | if (ret == 0) | |
785 | ret = -ETIME; | |
786 | else if (ret > 0) | |
787 | ret = 0; | |
788 | ||
789 | drm_gem_object_put_unlocked(obj); | |
790 | ||
791 | return ret; | |
792 | } | |
52791eee | 793 | EXPORT_SYMBOL(drm_gem_dma_resv_wait); |
1ba62714 | 794 | |
673a394b | 795 | /** |
89d61fc0 DV |
796 | * drm_gem_close_ioctl - implementation of the GEM_CLOSE ioctl |
797 | * @dev: drm_device | |
798 | * @data: ioctl data | |
799 | * @file_priv: drm file-private structure | |
800 | * | |
673a394b EA |
801 | * Releases the handle to an mm object. |
802 | */ | |
803 | int | |
804 | drm_gem_close_ioctl(struct drm_device *dev, void *data, | |
805 | struct drm_file *file_priv) | |
806 | { | |
807 | struct drm_gem_close *args = data; | |
808 | int ret; | |
809 | ||
1bcecfac | 810 | if (!drm_core_check_feature(dev, DRIVER_GEM)) |
69fdf420 | 811 | return -EOPNOTSUPP; |
673a394b EA |
812 | |
813 | ret = drm_gem_handle_delete(file_priv, args->handle); | |
814 | ||
815 | return ret; | |
816 | } | |
817 | ||
818 | /** | |
89d61fc0 DV |
819 | * drm_gem_flink_ioctl - implementation of the GEM_FLINK ioctl |
820 | * @dev: drm_device | |
821 | * @data: ioctl data | |
822 | * @file_priv: drm file-private structure | |
823 | * | |
673a394b EA |
824 | * Create a global name for an object, returning the name. |
825 | * | |
826 | * Note that the name does not hold a reference; when the object | |
827 | * is freed, the name goes away. | |
828 | */ | |
829 | int | |
830 | drm_gem_flink_ioctl(struct drm_device *dev, void *data, | |
831 | struct drm_file *file_priv) | |
832 | { | |
833 | struct drm_gem_flink *args = data; | |
834 | struct drm_gem_object *obj; | |
835 | int ret; | |
836 | ||
1bcecfac | 837 | if (!drm_core_check_feature(dev, DRIVER_GEM)) |
69fdf420 | 838 | return -EOPNOTSUPP; |
673a394b | 839 | |
a8ad0bd8 | 840 | obj = drm_gem_object_lookup(file_priv, args->handle); |
673a394b | 841 | if (obj == NULL) |
bf79cb91 | 842 | return -ENOENT; |
673a394b | 843 | |
cd4f013f | 844 | mutex_lock(&dev->object_name_lock); |
a8e11d1c DV |
845 | /* prevent races with concurrent gem_close. */ |
846 | if (obj->handle_count == 0) { | |
847 | ret = -ENOENT; | |
848 | goto err; | |
849 | } | |
850 | ||
8d59bae5 | 851 | if (!obj->name) { |
0f646425 | 852 | ret = idr_alloc(&dev->object_name_idr, obj, 1, 0, GFP_KERNEL); |
2e928815 | 853 | if (ret < 0) |
8d59bae5 | 854 | goto err; |
2e07fb22 YC |
855 | |
856 | obj->name = ret; | |
8d59bae5 | 857 | } |
3e49c4f4 | 858 | |
2e07fb22 YC |
859 | args->name = (uint64_t) obj->name; |
860 | ret = 0; | |
861 | ||
3e49c4f4 | 862 | err: |
cd4f013f | 863 | mutex_unlock(&dev->object_name_lock); |
e6b62714 | 864 | drm_gem_object_put_unlocked(obj); |
3e49c4f4 | 865 | return ret; |
673a394b EA |
866 | } |
867 | ||
868 | /** | |
89d61fc0 DV |
869 | * drm_gem_open - implementation of the GEM_OPEN ioctl |
870 | * @dev: drm_device | |
871 | * @data: ioctl data | |
872 | * @file_priv: drm file-private structure | |
873 | * | |
673a394b EA |
874 | * Open an object using the global name, returning a handle and the size. |
875 | * | |
876 | * This handle (of course) holds a reference to the object, so the object | |
877 | * will not go away until the handle is deleted. | |
878 | */ | |
879 | int | |
880 | drm_gem_open_ioctl(struct drm_device *dev, void *data, | |
881 | struct drm_file *file_priv) | |
882 | { | |
883 | struct drm_gem_open *args = data; | |
884 | struct drm_gem_object *obj; | |
885 | int ret; | |
a1a2d1d3 | 886 | u32 handle; |
673a394b | 887 | |
1bcecfac | 888 | if (!drm_core_check_feature(dev, DRIVER_GEM)) |
69fdf420 | 889 | return -EOPNOTSUPP; |
673a394b | 890 | |
cd4f013f | 891 | mutex_lock(&dev->object_name_lock); |
673a394b | 892 | obj = idr_find(&dev->object_name_idr, (int) args->name); |
20228c44 | 893 | if (obj) { |
e6b62714 | 894 | drm_gem_object_get(obj); |
20228c44 DV |
895 | } else { |
896 | mutex_unlock(&dev->object_name_lock); | |
673a394b | 897 | return -ENOENT; |
20228c44 | 898 | } |
673a394b | 899 | |
20228c44 DV |
900 | /* drm_gem_handle_create_tail unlocks dev->object_name_lock. */ |
901 | ret = drm_gem_handle_create_tail(file_priv, obj, &handle); | |
e6b62714 | 902 | drm_gem_object_put_unlocked(obj); |
673a394b EA |
903 | if (ret) |
904 | return ret; | |
905 | ||
906 | args->handle = handle; | |
907 | args->size = obj->size; | |
908 | ||
909 | return 0; | |
910 | } | |
911 | ||
912 | /** | |
89d61fc0 DV |
913 | * gem_gem_open - initalizes GEM file-private structures at devnode open time |
914 | * @dev: drm_device which is being opened by userspace | |
915 | * @file_private: drm file-private structure to set up | |
916 | * | |
673a394b EA |
917 | * Called at device open time, sets up the structure for handling refcounting |
918 | * of mm objects. | |
919 | */ | |
920 | void | |
921 | drm_gem_open(struct drm_device *dev, struct drm_file *file_private) | |
922 | { | |
e86584c5 | 923 | idr_init_base(&file_private->object_idr, 1); |
673a394b EA |
924 | spin_lock_init(&file_private->table_lock); |
925 | } | |
926 | ||
673a394b | 927 | /** |
89d61fc0 DV |
928 | * drm_gem_release - release file-private GEM resources |
929 | * @dev: drm_device which is being closed by userspace | |
930 | * @file_private: drm file-private structure to clean up | |
931 | * | |
673a394b EA |
932 | * Called at close time when the filp is going away. |
933 | * | |
934 | * Releases any remaining references on objects by this filp. | |
935 | */ | |
936 | void | |
937 | drm_gem_release(struct drm_device *dev, struct drm_file *file_private) | |
938 | { | |
673a394b | 939 | idr_for_each(&file_private->object_idr, |
304eda32 | 940 | &drm_gem_object_release_handle, file_private); |
673a394b | 941 | idr_destroy(&file_private->object_idr); |
673a394b EA |
942 | } |
943 | ||
f74418a4 DV |
944 | /** |
945 | * drm_gem_object_release - release GEM buffer object resources | |
946 | * @obj: GEM buffer object | |
947 | * | |
948 | * This releases any structures and resources used by @obj and is the invers of | |
949 | * drm_gem_object_init(). | |
950 | */ | |
fd632aa3 DV |
951 | void |
952 | drm_gem_object_release(struct drm_gem_object *obj) | |
c3ae90c0 | 953 | { |
319c933c DV |
954 | WARN_ON(obj->dma_buf); |
955 | ||
62cb7011 | 956 | if (obj->filp) |
16d2831d | 957 | fput(obj->filp); |
77472347 | 958 | |
52791eee | 959 | dma_resv_fini(&obj->_resv); |
77472347 | 960 | drm_gem_free_mmap_offset(obj); |
c3ae90c0 | 961 | } |
fd632aa3 | 962 | EXPORT_SYMBOL(drm_gem_object_release); |
c3ae90c0 | 963 | |
673a394b | 964 | /** |
89d61fc0 DV |
965 | * drm_gem_object_free - free a GEM object |
966 | * @kref: kref of the object to free | |
967 | * | |
673a394b | 968 | * Called after the last reference to the object has been lost. |
940eba2d | 969 | * Must be called holding &drm_device.struct_mutex. |
673a394b EA |
970 | * |
971 | * Frees the object | |
972 | */ | |
973 | void | |
974 | drm_gem_object_free(struct kref *kref) | |
975 | { | |
6ff774bd DV |
976 | struct drm_gem_object *obj = |
977 | container_of(kref, struct drm_gem_object, refcount); | |
673a394b EA |
978 | struct drm_device *dev = obj->dev; |
979 | ||
b39b5394 NT |
980 | if (obj->funcs) { |
981 | obj->funcs->free(obj); | |
982 | } else if (dev->driver->gem_free_object_unlocked) { | |
9f0ba539 | 983 | dev->driver->gem_free_object_unlocked(obj); |
6d3e7fdd DV |
984 | } else if (dev->driver->gem_free_object) { |
985 | WARN_ON(!mutex_is_locked(&dev->struct_mutex)); | |
986 | ||
673a394b | 987 | dev->driver->gem_free_object(obj); |
6d3e7fdd | 988 | } |
673a394b EA |
989 | } |
990 | EXPORT_SYMBOL(drm_gem_object_free); | |
991 | ||
9f0ba539 | 992 | /** |
e6b62714 | 993 | * drm_gem_object_put_unlocked - drop a GEM buffer object reference |
9f0ba539 DV |
994 | * @obj: GEM buffer object |
995 | * | |
996 | * This releases a reference to @obj. Callers must not hold the | |
940eba2d | 997 | * &drm_device.struct_mutex lock when calling this function. |
9f0ba539 | 998 | * |
e6b62714 | 999 | * See also __drm_gem_object_put(). |
9f0ba539 DV |
1000 | */ |
1001 | void | |
e6b62714 | 1002 | drm_gem_object_put_unlocked(struct drm_gem_object *obj) |
9f0ba539 DV |
1003 | { |
1004 | struct drm_device *dev; | |
1005 | ||
1006 | if (!obj) | |
1007 | return; | |
1008 | ||
1009 | dev = obj->dev; | |
9f0ba539 | 1010 | |
b39b5394 | 1011 | if (dev->driver->gem_free_object) { |
3379c04c DV |
1012 | might_lock(&dev->struct_mutex); |
1013 | if (kref_put_mutex(&obj->refcount, drm_gem_object_free, | |
9f0ba539 | 1014 | &dev->struct_mutex)) |
3379c04c | 1015 | mutex_unlock(&dev->struct_mutex); |
b39b5394 NT |
1016 | } else { |
1017 | kref_put(&obj->refcount, drm_gem_object_free); | |
3379c04c | 1018 | } |
9f0ba539 | 1019 | } |
e6b62714 | 1020 | EXPORT_SYMBOL(drm_gem_object_put_unlocked); |
9f0ba539 DV |
1021 | |
1022 | /** | |
e6b62714 | 1023 | * drm_gem_object_put - release a GEM buffer object reference |
9f0ba539 DV |
1024 | * @obj: GEM buffer object |
1025 | * | |
940eba2d DV |
1026 | * This releases a reference to @obj. Callers must hold the |
1027 | * &drm_device.struct_mutex lock when calling this function, even when the | |
1028 | * driver doesn't use &drm_device.struct_mutex for anything. | |
9f0ba539 DV |
1029 | * |
1030 | * For drivers not encumbered with legacy locking use | |
e6b62714 | 1031 | * drm_gem_object_put_unlocked() instead. |
9f0ba539 DV |
1032 | */ |
1033 | void | |
e6b62714 | 1034 | drm_gem_object_put(struct drm_gem_object *obj) |
9f0ba539 DV |
1035 | { |
1036 | if (obj) { | |
1037 | WARN_ON(!mutex_is_locked(&obj->dev->struct_mutex)); | |
1038 | ||
1039 | kref_put(&obj->refcount, drm_gem_object_free); | |
1040 | } | |
1041 | } | |
e6b62714 | 1042 | EXPORT_SYMBOL(drm_gem_object_put); |
9f0ba539 | 1043 | |
df2e0900 DV |
1044 | /** |
1045 | * drm_gem_vm_open - vma->ops->open implementation for GEM | |
1046 | * @vma: VM area structure | |
1047 | * | |
1048 | * This function implements the #vm_operations_struct open() callback for GEM | |
1049 | * drivers. This must be used together with drm_gem_vm_close(). | |
1050 | */ | |
ab00b3e5 JB |
1051 | void drm_gem_vm_open(struct vm_area_struct *vma) |
1052 | { | |
1053 | struct drm_gem_object *obj = vma->vm_private_data; | |
1054 | ||
e6b62714 | 1055 | drm_gem_object_get(obj); |
ab00b3e5 JB |
1056 | } |
1057 | EXPORT_SYMBOL(drm_gem_vm_open); | |
1058 | ||
df2e0900 DV |
1059 | /** |
1060 | * drm_gem_vm_close - vma->ops->close implementation for GEM | |
1061 | * @vma: VM area structure | |
1062 | * | |
1063 | * This function implements the #vm_operations_struct close() callback for GEM | |
1064 | * drivers. This must be used together with drm_gem_vm_open(). | |
1065 | */ | |
ab00b3e5 JB |
1066 | void drm_gem_vm_close(struct vm_area_struct *vma) |
1067 | { | |
1068 | struct drm_gem_object *obj = vma->vm_private_data; | |
ab00b3e5 | 1069 | |
e6b62714 | 1070 | drm_gem_object_put_unlocked(obj); |
ab00b3e5 JB |
1071 | } |
1072 | EXPORT_SYMBOL(drm_gem_vm_close); | |
1073 | ||
1c5aafa6 LP |
1074 | /** |
1075 | * drm_gem_mmap_obj - memory map a GEM object | |
1076 | * @obj: the GEM object to map | |
1077 | * @obj_size: the object size to be mapped, in bytes | |
1078 | * @vma: VMA for the area to be mapped | |
1079 | * | |
1080 | * Set up the VMA to prepare mapping of the GEM object using the gem_vm_ops | |
1081 | * provided by the driver. Depending on their requirements, drivers can either | |
1082 | * provide a fault handler in their gem_vm_ops (in which case any accesses to | |
1083 | * the object will be trapped, to perform migration, GTT binding, surface | |
1084 | * register allocation, or performance monitoring), or mmap the buffer memory | |
1085 | * synchronously after calling drm_gem_mmap_obj. | |
1086 | * | |
1087 | * This function is mainly intended to implement the DMABUF mmap operation, when | |
1088 | * the GEM object is not looked up based on its fake offset. To implement the | |
1089 | * DRM mmap operation, drivers should use the drm_gem_mmap() function. | |
1090 | * | |
ca481c9b DH |
1091 | * drm_gem_mmap_obj() assumes the user is granted access to the buffer while |
1092 | * drm_gem_mmap() prevents unprivileged users from mapping random objects. So | |
1093 | * callers must verify access restrictions before calling this helper. | |
1094 | * | |
1c5aafa6 LP |
1095 | * Return 0 or success or -EINVAL if the object size is smaller than the VMA |
1096 | * size, or if no gem_vm_ops are provided. | |
1097 | */ | |
1098 | int drm_gem_mmap_obj(struct drm_gem_object *obj, unsigned long obj_size, | |
1099 | struct vm_area_struct *vma) | |
1100 | { | |
1101 | struct drm_device *dev = obj->dev; | |
c40069cb | 1102 | int ret; |
1c5aafa6 LP |
1103 | |
1104 | /* Check for valid size. */ | |
1105 | if (obj_size < vma->vm_end - vma->vm_start) | |
1106 | return -EINVAL; | |
1107 | ||
c40069cb | 1108 | if (obj->funcs && obj->funcs->mmap) { |
83b8a6f2 RH |
1109 | /* Remove the fake offset */ |
1110 | vma->vm_pgoff -= drm_vma_node_start(&obj->vma_node); | |
1111 | ||
c40069cb GH |
1112 | ret = obj->funcs->mmap(obj, vma); |
1113 | if (ret) | |
1114 | return ret; | |
1115 | WARN_ON(!(vma->vm_flags & VM_DONTEXPAND)); | |
1116 | } else { | |
1117 | if (obj->funcs && obj->funcs->vm_ops) | |
1118 | vma->vm_ops = obj->funcs->vm_ops; | |
1119 | else if (dev->driver->gem_vm_ops) | |
1120 | vma->vm_ops = dev->driver->gem_vm_ops; | |
1121 | else | |
1122 | return -EINVAL; | |
1123 | ||
1124 | vma->vm_flags |= VM_IO | VM_PFNMAP | VM_DONTEXPAND | VM_DONTDUMP; | |
1125 | vma->vm_page_prot = pgprot_writecombine(vm_get_page_prot(vma->vm_flags)); | |
1126 | vma->vm_page_prot = pgprot_decrypted(vma->vm_page_prot); | |
1127 | } | |
1c5aafa6 | 1128 | |
1c5aafa6 | 1129 | vma->vm_private_data = obj; |
1c5aafa6 LP |
1130 | |
1131 | /* Take a ref for this mapping of the object, so that the fault | |
1132 | * handler can dereference the mmap offset's pointer to the object. | |
1133 | * This reference is cleaned up by the corresponding vm_close | |
1134 | * (which should happen whether the vma was created by this call, or | |
1135 | * by a vm_open due to mremap or partial unmap or whatever). | |
1136 | */ | |
e6b62714 | 1137 | drm_gem_object_get(obj); |
1c5aafa6 | 1138 | |
1c5aafa6 LP |
1139 | return 0; |
1140 | } | |
1141 | EXPORT_SYMBOL(drm_gem_mmap_obj); | |
ab00b3e5 | 1142 | |
a2c0a97b JB |
1143 | /** |
1144 | * drm_gem_mmap - memory map routine for GEM objects | |
1145 | * @filp: DRM file pointer | |
1146 | * @vma: VMA for the area to be mapped | |
1147 | * | |
1148 | * If a driver supports GEM object mapping, mmap calls on the DRM file | |
1149 | * descriptor will end up here. | |
1150 | * | |
1c5aafa6 | 1151 | * Look up the GEM object based on the offset passed in (vma->vm_pgoff will |
a2c0a97b | 1152 | * contain the fake offset we created when the GTT map ioctl was called on |
1c5aafa6 | 1153 | * the object) and map it with a call to drm_gem_mmap_obj(). |
ca481c9b DH |
1154 | * |
1155 | * If the caller is not granted access to the buffer object, the mmap will fail | |
1156 | * with EACCES. Please see the vma manager for more information. | |
a2c0a97b JB |
1157 | */ |
1158 | int drm_gem_mmap(struct file *filp, struct vm_area_struct *vma) | |
1159 | { | |
1160 | struct drm_file *priv = filp->private_data; | |
1161 | struct drm_device *dev = priv->minor->dev; | |
2225cfe4 | 1162 | struct drm_gem_object *obj = NULL; |
0de23977 | 1163 | struct drm_vma_offset_node *node; |
a8469aa8 | 1164 | int ret; |
a2c0a97b | 1165 | |
c07dcd61 | 1166 | if (drm_dev_is_unplugged(dev)) |
2c07a21d DA |
1167 | return -ENODEV; |
1168 | ||
2225cfe4 DV |
1169 | drm_vma_offset_lock_lookup(dev->vma_offset_manager); |
1170 | node = drm_vma_offset_exact_lookup_locked(dev->vma_offset_manager, | |
1171 | vma->vm_pgoff, | |
1172 | vma_pages(vma)); | |
1173 | if (likely(node)) { | |
1174 | obj = container_of(node, struct drm_gem_object, vma_node); | |
1175 | /* | |
1176 | * When the object is being freed, after it hits 0-refcnt it | |
1177 | * proceeds to tear down the object. In the process it will | |
1178 | * attempt to remove the VMA offset and so acquire this | |
1179 | * mgr->vm_lock. Therefore if we find an object with a 0-refcnt | |
1180 | * that matches our range, we know it is in the process of being | |
1181 | * destroyed and will be freed as soon as we release the lock - | |
1182 | * so we have to check for the 0-refcnted object and treat it as | |
1183 | * invalid. | |
1184 | */ | |
1185 | if (!kref_get_unless_zero(&obj->refcount)) | |
1186 | obj = NULL; | |
1187 | } | |
1188 | drm_vma_offset_unlock_lookup(dev->vma_offset_manager); | |
a2c0a97b | 1189 | |
2225cfe4 | 1190 | if (!obj) |
197633b9 | 1191 | return -EINVAL; |
2225cfe4 | 1192 | |
d9a1f0b4 | 1193 | if (!drm_vma_node_is_allowed(node, priv)) { |
e6b62714 | 1194 | drm_gem_object_put_unlocked(obj); |
ca481c9b | 1195 | return -EACCES; |
a2c0a97b JB |
1196 | } |
1197 | ||
3e977ac6 CW |
1198 | if (node->readonly) { |
1199 | if (vma->vm_flags & VM_WRITE) { | |
1200 | drm_gem_object_put_unlocked(obj); | |
1201 | return -EINVAL; | |
1202 | } | |
1203 | ||
1204 | vma->vm_flags &= ~VM_MAYWRITE; | |
1205 | } | |
1206 | ||
2225cfe4 DV |
1207 | ret = drm_gem_mmap_obj(obj, drm_vma_node_size(node) << PAGE_SHIFT, |
1208 | vma); | |
a2c0a97b | 1209 | |
e6b62714 | 1210 | drm_gem_object_put_unlocked(obj); |
a2c0a97b JB |
1211 | |
1212 | return ret; | |
1213 | } | |
1214 | EXPORT_SYMBOL(drm_gem_mmap); | |
45d58b40 NT |
1215 | |
1216 | void drm_gem_print_info(struct drm_printer *p, unsigned int indent, | |
1217 | const struct drm_gem_object *obj) | |
1218 | { | |
1219 | drm_printf_indent(p, indent, "name=%d\n", obj->name); | |
1220 | drm_printf_indent(p, indent, "refcount=%u\n", | |
1221 | kref_read(&obj->refcount)); | |
1222 | drm_printf_indent(p, indent, "start=%08lx\n", | |
1223 | drm_vma_node_start(&obj->vma_node)); | |
1224 | drm_printf_indent(p, indent, "size=%zu\n", obj->size); | |
1225 | drm_printf_indent(p, indent, "imported=%s\n", | |
1226 | obj->import_attach ? "yes" : "no"); | |
1227 | ||
b39b5394 NT |
1228 | if (obj->funcs && obj->funcs->print_info) |
1229 | obj->funcs->print_info(p, indent, obj); | |
1230 | else if (obj->dev->driver->gem_print_info) | |
45d58b40 NT |
1231 | obj->dev->driver->gem_print_info(p, indent, obj); |
1232 | } | |
b39b5394 | 1233 | |
b39b5394 NT |
1234 | int drm_gem_pin(struct drm_gem_object *obj) |
1235 | { | |
1236 | if (obj->funcs && obj->funcs->pin) | |
1237 | return obj->funcs->pin(obj); | |
1238 | else if (obj->dev->driver->gem_prime_pin) | |
1239 | return obj->dev->driver->gem_prime_pin(obj); | |
1240 | else | |
1241 | return 0; | |
1242 | } | |
b39b5394 | 1243 | |
b39b5394 NT |
1244 | void drm_gem_unpin(struct drm_gem_object *obj) |
1245 | { | |
1246 | if (obj->funcs && obj->funcs->unpin) | |
1247 | obj->funcs->unpin(obj); | |
1248 | else if (obj->dev->driver->gem_prime_unpin) | |
1249 | obj->dev->driver->gem_prime_unpin(obj); | |
1250 | } | |
b39b5394 | 1251 | |
b39b5394 NT |
1252 | void *drm_gem_vmap(struct drm_gem_object *obj) |
1253 | { | |
1254 | void *vaddr; | |
1255 | ||
1256 | if (obj->funcs && obj->funcs->vmap) | |
1257 | vaddr = obj->funcs->vmap(obj); | |
1258 | else if (obj->dev->driver->gem_prime_vmap) | |
1259 | vaddr = obj->dev->driver->gem_prime_vmap(obj); | |
1260 | else | |
1261 | vaddr = ERR_PTR(-EOPNOTSUPP); | |
1262 | ||
1263 | if (!vaddr) | |
1264 | vaddr = ERR_PTR(-ENOMEM); | |
1265 | ||
1266 | return vaddr; | |
1267 | } | |
b39b5394 | 1268 | |
b39b5394 NT |
1269 | void drm_gem_vunmap(struct drm_gem_object *obj, void *vaddr) |
1270 | { | |
1271 | if (!vaddr) | |
1272 | return; | |
1273 | ||
1274 | if (obj->funcs && obj->funcs->vunmap) | |
1275 | obj->funcs->vunmap(obj, vaddr); | |
1276 | else if (obj->dev->driver->gem_prime_vunmap) | |
1277 | obj->dev->driver->gem_prime_vunmap(obj, vaddr); | |
1278 | } | |
7edc3e3b EA |
1279 | |
1280 | /** | |
1281 | * drm_gem_lock_reservations - Sets up the ww context and acquires | |
1282 | * the lock on an array of GEM objects. | |
1283 | * | |
1284 | * Once you've locked your reservations, you'll want to set up space | |
1285 | * for your shared fences (if applicable), submit your job, then | |
1286 | * drm_gem_unlock_reservations(). | |
1287 | * | |
1288 | * @objs: drm_gem_objects to lock | |
1289 | * @count: Number of objects in @objs | |
1290 | * @acquire_ctx: struct ww_acquire_ctx that will be initialized as | |
1291 | * part of tracking this set of locked reservations. | |
1292 | */ | |
1293 | int | |
1294 | drm_gem_lock_reservations(struct drm_gem_object **objs, int count, | |
1295 | struct ww_acquire_ctx *acquire_ctx) | |
1296 | { | |
1297 | int contended = -1; | |
1298 | int i, ret; | |
1299 | ||
1300 | ww_acquire_init(acquire_ctx, &reservation_ww_class); | |
1301 | ||
1302 | retry: | |
1303 | if (contended != -1) { | |
1304 | struct drm_gem_object *obj = objs[contended]; | |
1305 | ||
52791eee | 1306 | ret = dma_resv_lock_slow_interruptible(obj->resv, |
0dbd555a | 1307 | acquire_ctx); |
7edc3e3b EA |
1308 | if (ret) { |
1309 | ww_acquire_done(acquire_ctx); | |
1310 | return ret; | |
1311 | } | |
1312 | } | |
1313 | ||
1314 | for (i = 0; i < count; i++) { | |
1315 | if (i == contended) | |
1316 | continue; | |
1317 | ||
52791eee | 1318 | ret = dma_resv_lock_interruptible(objs[i]->resv, |
0dbd555a | 1319 | acquire_ctx); |
7edc3e3b EA |
1320 | if (ret) { |
1321 | int j; | |
1322 | ||
1323 | for (j = 0; j < i; j++) | |
52791eee | 1324 | dma_resv_unlock(objs[j]->resv); |
7edc3e3b EA |
1325 | |
1326 | if (contended != -1 && contended >= i) | |
52791eee | 1327 | dma_resv_unlock(objs[contended]->resv); |
7edc3e3b EA |
1328 | |
1329 | if (ret == -EDEADLK) { | |
1330 | contended = i; | |
1331 | goto retry; | |
1332 | } | |
1333 | ||
1334 | ww_acquire_done(acquire_ctx); | |
1335 | return ret; | |
1336 | } | |
1337 | } | |
1338 | ||
1339 | ww_acquire_done(acquire_ctx); | |
1340 | ||
1341 | return 0; | |
1342 | } | |
1343 | EXPORT_SYMBOL(drm_gem_lock_reservations); | |
1344 | ||
1345 | void | |
1346 | drm_gem_unlock_reservations(struct drm_gem_object **objs, int count, | |
1347 | struct ww_acquire_ctx *acquire_ctx) | |
1348 | { | |
1349 | int i; | |
1350 | ||
1351 | for (i = 0; i < count; i++) | |
52791eee | 1352 | dma_resv_unlock(objs[i]->resv); |
7edc3e3b EA |
1353 | |
1354 | ww_acquire_fini(acquire_ctx); | |
1355 | } | |
1356 | EXPORT_SYMBOL(drm_gem_unlock_reservations); | |
5d5a179d EA |
1357 | |
1358 | /** | |
1359 | * drm_gem_fence_array_add - Adds the fence to an array of fences to be | |
1360 | * waited on, deduplicating fences from the same context. | |
1361 | * | |
761e473f SP |
1362 | * @fence_array: array of dma_fence * for the job to block on. |
1363 | * @fence: the dma_fence to add to the list of dependencies. | |
5d5a179d EA |
1364 | * |
1365 | * Returns: | |
1366 | * 0 on success, or an error on failing to expand the array. | |
1367 | */ | |
1368 | int drm_gem_fence_array_add(struct xarray *fence_array, | |
1369 | struct dma_fence *fence) | |
1370 | { | |
1371 | struct dma_fence *entry; | |
1372 | unsigned long index; | |
1373 | u32 id = 0; | |
1374 | int ret; | |
1375 | ||
1376 | if (!fence) | |
1377 | return 0; | |
1378 | ||
1379 | /* Deduplicate if we already depend on a fence from the same context. | |
1380 | * This lets the size of the array of deps scale with the number of | |
1381 | * engines involved, rather than the number of BOs. | |
1382 | */ | |
1383 | xa_for_each(fence_array, index, entry) { | |
1384 | if (entry->context != fence->context) | |
1385 | continue; | |
1386 | ||
1387 | if (dma_fence_is_later(fence, entry)) { | |
1388 | dma_fence_put(entry); | |
1389 | xa_store(fence_array, index, fence, GFP_KERNEL); | |
1390 | } else { | |
1391 | dma_fence_put(fence); | |
1392 | } | |
1393 | return 0; | |
1394 | } | |
1395 | ||
1396 | ret = xa_alloc(fence_array, &id, fence, xa_limit_32b, GFP_KERNEL); | |
1397 | if (ret != 0) | |
1398 | dma_fence_put(fence); | |
1399 | ||
1400 | return ret; | |
1401 | } | |
1402 | EXPORT_SYMBOL(drm_gem_fence_array_add); | |
1403 | ||
1404 | /** | |
1405 | * drm_gem_fence_array_add_implicit - Adds the implicit dependencies tracked | |
1406 | * in the GEM object's reservation object to an array of dma_fences for use in | |
1407 | * scheduling a rendering job. | |
1408 | * | |
1409 | * This should be called after drm_gem_lock_reservations() on your array of | |
1410 | * GEM objects used in the job but before updating the reservations with your | |
1411 | * own fences. | |
1412 | * | |
761e473f SP |
1413 | * @fence_array: array of dma_fence * for the job to block on. |
1414 | * @obj: the gem object to add new dependencies from. | |
1415 | * @write: whether the job might write the object (so we need to depend on | |
5d5a179d EA |
1416 | * shared fences in the reservation object). |
1417 | */ | |
1418 | int drm_gem_fence_array_add_implicit(struct xarray *fence_array, | |
1419 | struct drm_gem_object *obj, | |
1420 | bool write) | |
1421 | { | |
1422 | int ret; | |
1423 | struct dma_fence **fences; | |
1424 | unsigned int i, fence_count; | |
1425 | ||
1426 | if (!write) { | |
1427 | struct dma_fence *fence = | |
52791eee | 1428 | dma_resv_get_excl_rcu(obj->resv); |
5d5a179d EA |
1429 | |
1430 | return drm_gem_fence_array_add(fence_array, fence); | |
1431 | } | |
1432 | ||
52791eee | 1433 | ret = dma_resv_get_fences_rcu(obj->resv, NULL, |
5d5a179d EA |
1434 | &fence_count, &fences); |
1435 | if (ret || !fence_count) | |
1436 | return ret; | |
1437 | ||
1438 | for (i = 0; i < fence_count; i++) { | |
1439 | ret = drm_gem_fence_array_add(fence_array, fences[i]); | |
1440 | if (ret) | |
1441 | break; | |
1442 | } | |
1443 | ||
1444 | for (; i < fence_count; i++) | |
1445 | dma_fence_put(fences[i]); | |
1446 | kfree(fences); | |
1447 | return ret; | |
1448 | } | |
1449 | EXPORT_SYMBOL(drm_gem_fence_array_add_implicit); |