]>
Commit | Line | Data |
---|---|---|
3248877e DA |
1 | /* |
2 | * Copyright © 2012 Red Hat | |
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 | * Dave Airlie <airlied@redhat.com> | |
25 | * Rob Clark <rob.clark@linaro.org> | |
26 | * | |
27 | */ | |
28 | ||
29 | #include <linux/export.h> | |
30 | #include <linux/dma-buf.h> | |
077675c1 | 31 | #include <linux/rbtree.h> |
0500c04e SR |
32 | |
33 | #include <drm/drm_drv.h> | |
34 | #include <drm/drm_file.h> | |
35 | #include <drm/drm_framebuffer.h> | |
d9fc9413 | 36 | #include <drm/drm_gem.h> |
0500c04e | 37 | #include <drm/drm_prime.h> |
d9fc9413 | 38 | |
67d0ec4e | 39 | #include "drm_internal.h" |
3248877e DA |
40 | |
41 | /* | |
42 | * DMA-BUF/GEM Object references and lifetime overview: | |
43 | * | |
44 | * On the export the dma_buf holds a reference to the exporting GEM | |
45 | * object. It takes this reference in handle_to_fd_ioctl, when it | |
46 | * first calls .prime_export and stores the exporting GEM object in | |
fa4c1de4 OA |
47 | * the dma_buf priv. This reference needs to be released when the |
48 | * final reference to the &dma_buf itself is dropped and its | |
49 | * &dma_buf_ops.release function is called. For GEM-based drivers, | |
50 | * the dma_buf should be exported using drm_gem_dmabuf_export() and | |
51 | * then released by drm_gem_dmabuf_release(). | |
3248877e DA |
52 | * |
53 | * On the import the importing GEM object holds a reference to the | |
54 | * dma_buf (which in turn holds a ref to the exporting GEM object). | |
55 | * It takes that reference in the fd_to_handle ioctl. | |
56 | * It calls dma_buf_get, creates an attachment to it and stores the | |
57 | * attachment in the GEM object. When this attachment is destroyed | |
58 | * when the imported object is destroyed, we remove the attachment | |
59 | * and drop the reference to the dma_buf. | |
60 | * | |
fa4c1de4 OA |
61 | * When all the references to the &dma_buf are dropped, i.e. when |
62 | * userspace has closed both handles to the imported GEM object (through the | |
63 | * FD_TO_HANDLE IOCTL) and closed the file descriptor of the exported | |
64 | * (through the HANDLE_TO_FD IOCTL) dma_buf, and all kernel-internal references | |
65 | * are also gone, then the dma_buf gets destroyed. This can also happen as a | |
66 | * part of the clean up procedure in the drm_release() function if userspace | |
67 | * fails to properly clean up. Note that both the kernel and userspace (by | |
68 | * keeeping the PRIME file descriptors open) can hold references onto a | |
69 | * &dma_buf. | |
70 | * | |
3248877e DA |
71 | * Thus the chain of references always flows in one direction |
72 | * (avoiding loops): importing_gem -> dmabuf -> exporting_gem | |
73 | * | |
74 | * Self-importing: if userspace is using PRIME as a replacement for flink | |
75 | * then it will get a fd->handle request for a GEM object that it created. | |
76 | * Drivers should detect this situation and return back the gem object | |
89177644 AP |
77 | * from the dma-buf private. Prime will do this automatically for drivers that |
78 | * use the drm_gem_prime_{import,export} helpers. | |
f7a71b0c SL |
79 | * |
80 | * GEM struct &dma_buf_ops symbols are now exported. They can be resued by | |
81 | * drivers which implement GEM interface. | |
3248877e DA |
82 | */ |
83 | ||
84 | struct drm_prime_member { | |
3248877e DA |
85 | struct dma_buf *dma_buf; |
86 | uint32_t handle; | |
077675c1 CW |
87 | |
88 | struct rb_node dmabuf_rb; | |
89 | struct rb_node handle_rb; | |
3248877e | 90 | }; |
538d6661 | 91 | |
39cc344a DV |
92 | static int drm_prime_add_buf_handle(struct drm_prime_file_private *prime_fpriv, |
93 | struct dma_buf *dma_buf, uint32_t handle) | |
ce92e3c9 SWK |
94 | { |
95 | struct drm_prime_member *member; | |
077675c1 | 96 | struct rb_node **p, *rb; |
ce92e3c9 SWK |
97 | |
98 | member = kmalloc(sizeof(*member), GFP_KERNEL); | |
99 | if (!member) | |
100 | return -ENOMEM; | |
101 | ||
102 | get_dma_buf(dma_buf); | |
103 | member->dma_buf = dma_buf; | |
104 | member->handle = handle; | |
077675c1 CW |
105 | |
106 | rb = NULL; | |
107 | p = &prime_fpriv->dmabufs.rb_node; | |
108 | while (*p) { | |
109 | struct drm_prime_member *pos; | |
110 | ||
111 | rb = *p; | |
112 | pos = rb_entry(rb, struct drm_prime_member, dmabuf_rb); | |
113 | if (dma_buf > pos->dma_buf) | |
114 | p = &rb->rb_right; | |
115 | else | |
116 | p = &rb->rb_left; | |
117 | } | |
118 | rb_link_node(&member->dmabuf_rb, rb, p); | |
119 | rb_insert_color(&member->dmabuf_rb, &prime_fpriv->dmabufs); | |
120 | ||
121 | rb = NULL; | |
122 | p = &prime_fpriv->handles.rb_node; | |
123 | while (*p) { | |
124 | struct drm_prime_member *pos; | |
125 | ||
126 | rb = *p; | |
127 | pos = rb_entry(rb, struct drm_prime_member, handle_rb); | |
128 | if (handle > pos->handle) | |
129 | p = &rb->rb_right; | |
130 | else | |
131 | p = &rb->rb_left; | |
132 | } | |
133 | rb_link_node(&member->handle_rb, rb, p); | |
134 | rb_insert_color(&member->handle_rb, &prime_fpriv->handles); | |
135 | ||
ce92e3c9 SWK |
136 | return 0; |
137 | } | |
3248877e | 138 | |
d0b2c533 DV |
139 | static struct dma_buf *drm_prime_lookup_buf_by_handle(struct drm_prime_file_private *prime_fpriv, |
140 | uint32_t handle) | |
141 | { | |
077675c1 CW |
142 | struct rb_node *rb; |
143 | ||
144 | rb = prime_fpriv->handles.rb_node; | |
145 | while (rb) { | |
146 | struct drm_prime_member *member; | |
d0b2c533 | 147 | |
077675c1 | 148 | member = rb_entry(rb, struct drm_prime_member, handle_rb); |
d0b2c533 DV |
149 | if (member->handle == handle) |
150 | return member->dma_buf; | |
077675c1 CW |
151 | else if (member->handle < handle) |
152 | rb = rb->rb_right; | |
153 | else | |
154 | rb = rb->rb_left; | |
d0b2c533 DV |
155 | } |
156 | ||
157 | return NULL; | |
158 | } | |
159 | ||
de9564d8 DV |
160 | static int drm_prime_lookup_buf_handle(struct drm_prime_file_private *prime_fpriv, |
161 | struct dma_buf *dma_buf, | |
162 | uint32_t *handle) | |
163 | { | |
077675c1 CW |
164 | struct rb_node *rb; |
165 | ||
166 | rb = prime_fpriv->dmabufs.rb_node; | |
167 | while (rb) { | |
168 | struct drm_prime_member *member; | |
de9564d8 | 169 | |
077675c1 | 170 | member = rb_entry(rb, struct drm_prime_member, dmabuf_rb); |
de9564d8 DV |
171 | if (member->dma_buf == dma_buf) { |
172 | *handle = member->handle; | |
173 | return 0; | |
077675c1 CW |
174 | } else if (member->dma_buf < dma_buf) { |
175 | rb = rb->rb_right; | |
176 | } else { | |
177 | rb = rb->rb_left; | |
de9564d8 DV |
178 | } |
179 | } | |
077675c1 | 180 | |
de9564d8 DV |
181 | return -ENOENT; |
182 | } | |
183 | ||
f7a71b0c SL |
184 | /** |
185 | * drm_gem_map_attach - dma_buf attach implementation for GEM | |
186 | * @dma_buf: buffer to attach device to | |
f7a71b0c SL |
187 | * @attach: buffer attachment data |
188 | * | |
c614d7e6 CK |
189 | * Calls &drm_driver.gem_prime_pin for device specific handling. This can be |
190 | * used as the &dma_buf_ops.attach callback. | |
f7a71b0c SL |
191 | * |
192 | * Returns 0 on success, negative error code on failure. | |
193 | */ | |
a19741e5 | 194 | int drm_gem_map_attach(struct dma_buf *dma_buf, |
c308279f | 195 | struct dma_buf_attachment *attach) |
ca793f75 ML |
196 | { |
197 | struct drm_gem_object *obj = dma_buf->priv; | |
ca793f75 | 198 | |
b39b5394 | 199 | return drm_gem_pin(obj); |
ca793f75 | 200 | } |
c308279f | 201 | EXPORT_SYMBOL(drm_gem_map_attach); |
ca793f75 | 202 | |
f7a71b0c SL |
203 | /** |
204 | * drm_gem_map_detach - dma_buf detach implementation for GEM | |
205 | * @dma_buf: buffer to detach from | |
206 | * @attach: attachment to be detached | |
207 | * | |
208 | * Cleans up &dma_buf_attachment. This can be used as the &dma_buf_ops.detach | |
209 | * callback. | |
210 | */ | |
c308279f SL |
211 | void drm_gem_map_detach(struct dma_buf *dma_buf, |
212 | struct dma_buf_attachment *attach) | |
ca793f75 ML |
213 | { |
214 | struct drm_gem_object *obj = dma_buf->priv; | |
ca793f75 | 215 | |
b39b5394 | 216 | drm_gem_unpin(obj); |
ca793f75 | 217 | } |
c308279f | 218 | EXPORT_SYMBOL(drm_gem_map_detach); |
ca793f75 | 219 | |
d0b2c533 DV |
220 | void drm_prime_remove_buf_handle_locked(struct drm_prime_file_private *prime_fpriv, |
221 | struct dma_buf *dma_buf) | |
da34242e | 222 | { |
077675c1 | 223 | struct rb_node *rb; |
da34242e | 224 | |
077675c1 CW |
225 | rb = prime_fpriv->dmabufs.rb_node; |
226 | while (rb) { | |
227 | struct drm_prime_member *member; | |
228 | ||
229 | member = rb_entry(rb, struct drm_prime_member, dmabuf_rb); | |
da34242e | 230 | if (member->dma_buf == dma_buf) { |
077675c1 CW |
231 | rb_erase(&member->handle_rb, &prime_fpriv->handles); |
232 | rb_erase(&member->dmabuf_rb, &prime_fpriv->dmabufs); | |
233 | ||
da34242e | 234 | dma_buf_put(dma_buf); |
da34242e | 235 | kfree(member); |
077675c1 CW |
236 | return; |
237 | } else if (member->dma_buf < dma_buf) { | |
238 | rb = rb->rb_right; | |
239 | } else { | |
240 | rb = rb->rb_left; | |
da34242e YC |
241 | } |
242 | } | |
243 | } | |
244 | ||
f7a71b0c SL |
245 | /** |
246 | * drm_gem_map_dma_buf - map_dma_buf implementation for GEM | |
247 | * @attach: attachment whose scatterlist is to be returned | |
248 | * @dir: direction of DMA transfer | |
249 | * | |
250 | * Calls &drm_driver.gem_prime_get_sg_table and then maps the scatterlist. This | |
251 | * can be used as the &dma_buf_ops.map_dma_buf callback. | |
252 | * | |
253 | * Returns sg_table containing the scatterlist to be returned; returns ERR_PTR | |
254 | * on error. May return -EINTR if it is interrupted by a signal. | |
255 | */ | |
256 | ||
c308279f SL |
257 | struct sg_table *drm_gem_map_dma_buf(struct dma_buf_attachment *attach, |
258 | enum dma_data_direction dir) | |
89177644 AP |
259 | { |
260 | struct drm_gem_object *obj = attach->dmabuf->priv; | |
261 | struct sg_table *sgt; | |
262 | ||
c614d7e6 | 263 | if (WARN_ON(dir == DMA_NONE)) |
538d6661 JS |
264 | return ERR_PTR(-EINVAL); |
265 | ||
b39b5394 NT |
266 | if (obj->funcs) |
267 | sgt = obj->funcs->get_sg_table(obj); | |
268 | else | |
269 | sgt = obj->dev->driver->gem_prime_get_sg_table(obj); | |
89177644 | 270 | |
c614d7e6 CK |
271 | if (!dma_map_sg_attrs(attach->dev, sgt->sgl, sgt->nents, dir, |
272 | DMA_ATTR_SKIP_CPU_SYNC)) { | |
273 | sg_free_table(sgt); | |
274 | kfree(sgt); | |
275 | sgt = ERR_PTR(-ENOMEM); | |
b720d54a | 276 | } |
89177644 | 277 | |
89177644 AP |
278 | return sgt; |
279 | } | |
c308279f | 280 | EXPORT_SYMBOL(drm_gem_map_dma_buf); |
89177644 | 281 | |
f7a71b0c SL |
282 | /** |
283 | * drm_gem_unmap_dma_buf - unmap_dma_buf implementation for GEM | |
790861cc SL |
284 | * @attach: attachment to unmap buffer from |
285 | * @sgt: scatterlist info of the buffer to unmap | |
286 | * @dir: direction of DMA transfer | |
f7a71b0c | 287 | * |
c614d7e6 | 288 | * This can be used as the &dma_buf_ops.unmap_dma_buf callback. |
f7a71b0c | 289 | */ |
c308279f SL |
290 | void drm_gem_unmap_dma_buf(struct dma_buf_attachment *attach, |
291 | struct sg_table *sgt, | |
292 | enum dma_data_direction dir) | |
89177644 | 293 | { |
c614d7e6 CK |
294 | if (!sgt) |
295 | return; | |
296 | ||
297 | dma_unmap_sg_attrs(attach->dev, sgt->sgl, sgt->nents, dir, | |
298 | DMA_ATTR_SKIP_CPU_SYNC); | |
299 | sg_free_table(sgt); | |
300 | kfree(sgt); | |
89177644 | 301 | } |
c308279f | 302 | EXPORT_SYMBOL(drm_gem_unmap_dma_buf); |
89177644 | 303 | |
a4fce9cb CW |
304 | /** |
305 | * drm_gem_dmabuf_export - dma_buf export implementation for GEM | |
67c8f116 CW |
306 | * @dev: parent device for the exported dmabuf |
307 | * @exp_info: the export information used by dma_buf_export() | |
a4fce9cb CW |
308 | * |
309 | * This wraps dma_buf_export() for use by generic GEM drivers that are using | |
310 | * drm_gem_dmabuf_release(). In addition to calling dma_buf_export(), we take | |
72a93e8d | 311 | * a reference to the &drm_device and the exported &drm_gem_object (stored in |
940eba2d | 312 | * &dma_buf_export_info.priv) which is released by drm_gem_dmabuf_release(). |
a4fce9cb CW |
313 | * |
314 | * Returns the new dmabuf. | |
315 | */ | |
316 | struct dma_buf *drm_gem_dmabuf_export(struct drm_device *dev, | |
317 | struct dma_buf_export_info *exp_info) | |
318 | { | |
319 | struct dma_buf *dma_buf; | |
320 | ||
321 | dma_buf = dma_buf_export(exp_info); | |
72a93e8d CW |
322 | if (IS_ERR(dma_buf)) |
323 | return dma_buf; | |
324 | ||
9a96f550 | 325 | drm_dev_get(dev); |
e6b62714 | 326 | drm_gem_object_get(exp_info->priv); |
a4fce9cb CW |
327 | |
328 | return dma_buf; | |
329 | } | |
330 | EXPORT_SYMBOL(drm_gem_dmabuf_export); | |
331 | ||
39cc344a DV |
332 | /** |
333 | * drm_gem_dmabuf_release - dma_buf release implementation for GEM | |
334 | * @dma_buf: buffer to be released | |
335 | * | |
336 | * Generic release function for dma_bufs exported as PRIME buffers. GEM drivers | |
337 | * must use this in their dma_buf ops structure as the release callback. | |
a4fce9cb CW |
338 | * drm_gem_dmabuf_release() should be used in conjunction with |
339 | * drm_gem_dmabuf_export(). | |
39cc344a | 340 | */ |
c1d6798d | 341 | void drm_gem_dmabuf_release(struct dma_buf *dma_buf) |
89177644 AP |
342 | { |
343 | struct drm_gem_object *obj = dma_buf->priv; | |
a4fce9cb | 344 | struct drm_device *dev = obj->dev; |
89177644 | 345 | |
319c933c | 346 | /* drop the reference on the export fd holds */ |
e6b62714 | 347 | drm_gem_object_put_unlocked(obj); |
a4fce9cb | 348 | |
ffeeeed0 | 349 | drm_dev_put(dev); |
89177644 | 350 | } |
c1d6798d | 351 | EXPORT_SYMBOL(drm_gem_dmabuf_release); |
89177644 | 352 | |
f7a71b0c SL |
353 | /** |
354 | * drm_gem_dmabuf_vmap - dma_buf vmap implementation for GEM | |
355 | * @dma_buf: buffer to be mapped | |
356 | * | |
357 | * Sets up a kernel virtual mapping. This can be used as the &dma_buf_ops.vmap | |
358 | * callback. | |
359 | * | |
360 | * Returns the kernel virtual address. | |
361 | */ | |
c308279f | 362 | void *drm_gem_dmabuf_vmap(struct dma_buf *dma_buf) |
89177644 AP |
363 | { |
364 | struct drm_gem_object *obj = dma_buf->priv; | |
b39b5394 | 365 | void *vaddr; |
89177644 | 366 | |
b39b5394 NT |
367 | vaddr = drm_gem_vmap(obj); |
368 | if (IS_ERR(vaddr)) | |
369 | vaddr = NULL; | |
370 | ||
371 | return vaddr; | |
89177644 | 372 | } |
c308279f | 373 | EXPORT_SYMBOL(drm_gem_dmabuf_vmap); |
89177644 | 374 | |
f7a71b0c SL |
375 | /** |
376 | * drm_gem_dmabuf_vunmap - dma_buf vunmap implementation for GEM | |
377 | * @dma_buf: buffer to be unmapped | |
378 | * @vaddr: the virtual address of the buffer | |
379 | * | |
380 | * Releases a kernel virtual mapping. This can be used as the | |
381 | * &dma_buf_ops.vunmap callback. | |
382 | */ | |
c308279f | 383 | void drm_gem_dmabuf_vunmap(struct dma_buf *dma_buf, void *vaddr) |
89177644 AP |
384 | { |
385 | struct drm_gem_object *obj = dma_buf->priv; | |
89177644 | 386 | |
b39b5394 | 387 | drm_gem_vunmap(obj, vaddr); |
89177644 | 388 | } |
c308279f | 389 | EXPORT_SYMBOL(drm_gem_dmabuf_vunmap); |
89177644 | 390 | |
f7a71b0c SL |
391 | /** |
392 | * drm_gem_dmabuf_mmap - dma_buf mmap implementation for GEM | |
393 | * @dma_buf: buffer to be mapped | |
394 | * @vma: virtual address range | |
395 | * | |
396 | * Provides memory mapping for the buffer. This can be used as the | |
397 | * &dma_buf_ops.mmap callback. | |
398 | * | |
399 | * Returns 0 on success or a negative error code on failure. | |
400 | */ | |
c308279f | 401 | int drm_gem_dmabuf_mmap(struct dma_buf *dma_buf, struct vm_area_struct *vma) |
89177644 | 402 | { |
7c397cd9 JS |
403 | struct drm_gem_object *obj = dma_buf->priv; |
404 | struct drm_device *dev = obj->dev; | |
405 | ||
406 | if (!dev->driver->gem_prime_mmap) | |
407 | return -ENOSYS; | |
408 | ||
409 | return dev->driver->gem_prime_mmap(obj, vma); | |
89177644 | 410 | } |
c308279f | 411 | EXPORT_SYMBOL(drm_gem_dmabuf_mmap); |
89177644 AP |
412 | |
413 | static const struct dma_buf_ops drm_gem_prime_dmabuf_ops = { | |
c614d7e6 | 414 | .cache_sgt_mapping = true, |
ca793f75 ML |
415 | .attach = drm_gem_map_attach, |
416 | .detach = drm_gem_map_detach, | |
89177644 AP |
417 | .map_dma_buf = drm_gem_map_dma_buf, |
418 | .unmap_dma_buf = drm_gem_unmap_dma_buf, | |
419 | .release = drm_gem_dmabuf_release, | |
89177644 AP |
420 | .mmap = drm_gem_dmabuf_mmap, |
421 | .vmap = drm_gem_dmabuf_vmap, | |
422 | .vunmap = drm_gem_dmabuf_vunmap, | |
423 | }; | |
424 | ||
425 | /** | |
426 | * DOC: PRIME Helpers | |
427 | * | |
428 | * Drivers can implement @gem_prime_export and @gem_prime_import in terms of | |
429 | * simpler APIs by using the helper functions @drm_gem_prime_export and | |
430 | * @drm_gem_prime_import. These functions implement dma-buf support in terms of | |
ffc5fbdb | 431 | * six lower-level driver callbacks: |
89177644 AP |
432 | * |
433 | * Export callbacks: | |
434 | * | |
f03d8ede DCLP |
435 | * * @gem_prime_pin (optional): prepare a GEM object for exporting |
436 | * * @gem_prime_get_sg_table: provide a scatter/gather table of pinned pages | |
437 | * * @gem_prime_vmap: vmap a buffer exported by your driver | |
438 | * * @gem_prime_vunmap: vunmap a buffer exported by your driver | |
439 | * * @gem_prime_mmap (optional): mmap a buffer exported by your driver | |
ffc5fbdb | 440 | * |
89177644 AP |
441 | * Import callback: |
442 | * | |
f03d8ede | 443 | * * @gem_prime_import_sg_table (import): produce a GEM object from another |
89177644 AP |
444 | * driver's scatter/gather table |
445 | */ | |
446 | ||
39cc344a | 447 | /** |
32197aab | 448 | * drm_gem_prime_export - helper library implementation of the export callback |
39cc344a DV |
449 | * @dev: drm_device to export from |
450 | * @obj: GEM object to export | |
bfe981a0 | 451 | * @flags: flags like DRM_CLOEXEC and DRM_RDWR |
39cc344a DV |
452 | * |
453 | * This is the implementation of the gem_prime_export functions for GEM drivers | |
454 | * using the PRIME helpers. | |
455 | */ | |
89177644 | 456 | struct dma_buf *drm_gem_prime_export(struct drm_device *dev, |
56a76c01 CW |
457 | struct drm_gem_object *obj, |
458 | int flags) | |
89177644 | 459 | { |
56a76c01 CW |
460 | struct dma_buf_export_info exp_info = { |
461 | .exp_name = KBUILD_MODNAME, /* white lie for debug */ | |
462 | .owner = dev->driver->fops->owner, | |
463 | .ops = &drm_gem_prime_dmabuf_ops, | |
464 | .size = obj->size, | |
465 | .flags = flags, | |
466 | .priv = obj, | |
1ba62714 | 467 | .resv = obj->resv, |
56a76c01 | 468 | }; |
3aac4502 ML |
469 | |
470 | if (dev->driver->gem_prime_res_obj) | |
d8fbe341 | 471 | exp_info.resv = dev->driver->gem_prime_res_obj(obj); |
3aac4502 | 472 | |
a4fce9cb | 473 | return drm_gem_dmabuf_export(dev, &exp_info); |
89177644 AP |
474 | } |
475 | EXPORT_SYMBOL(drm_gem_prime_export); | |
476 | ||
319c933c DV |
477 | static struct dma_buf *export_and_register_object(struct drm_device *dev, |
478 | struct drm_gem_object *obj, | |
479 | uint32_t flags) | |
480 | { | |
481 | struct dma_buf *dmabuf; | |
482 | ||
483 | /* prevent races with concurrent gem_close. */ | |
484 | if (obj->handle_count == 0) { | |
485 | dmabuf = ERR_PTR(-ENOENT); | |
486 | return dmabuf; | |
487 | } | |
488 | ||
b39b5394 NT |
489 | if (obj->funcs && obj->funcs->export) |
490 | dmabuf = obj->funcs->export(obj, flags); | |
491 | else if (dev->driver->gem_prime_export) | |
f0014881 NT |
492 | dmabuf = dev->driver->gem_prime_export(dev, obj, flags); |
493 | else | |
494 | dmabuf = drm_gem_prime_export(dev, obj, flags); | |
319c933c DV |
495 | if (IS_ERR(dmabuf)) { |
496 | /* normally the created dma-buf takes ownership of the ref, | |
497 | * but if that fails then drop the ref | |
498 | */ | |
499 | return dmabuf; | |
500 | } | |
501 | ||
502 | /* | |
503 | * Note that callers do not need to clean up the export cache | |
504 | * since the check for obj->handle_count guarantees that someone | |
505 | * will clean it up. | |
506 | */ | |
507 | obj->dma_buf = dmabuf; | |
508 | get_dma_buf(obj->dma_buf); | |
509 | ||
510 | return dmabuf; | |
511 | } | |
512 | ||
39cc344a DV |
513 | /** |
514 | * drm_gem_prime_handle_to_fd - PRIME export function for GEM drivers | |
515 | * @dev: dev to export the buffer from | |
516 | * @file_priv: drm file-private structure | |
517 | * @handle: buffer handle to export | |
518 | * @flags: flags like DRM_CLOEXEC | |
519 | * @prime_fd: pointer to storage for the fd id of the create dma-buf | |
520 | * | |
521 | * This is the PRIME export function which must be used mandatorily by GEM | |
522 | * drivers to ensure correct lifetime management of the underlying GEM object. | |
523 | * The actual exporting from GEM object to a dma-buf is done through the | |
524 | * gem_prime_export driver callback. | |
525 | */ | |
3248877e | 526 | int drm_gem_prime_handle_to_fd(struct drm_device *dev, |
39cc344a DV |
527 | struct drm_file *file_priv, uint32_t handle, |
528 | uint32_t flags, | |
529 | int *prime_fd) | |
3248877e DA |
530 | { |
531 | struct drm_gem_object *obj; | |
219b4733 DA |
532 | int ret = 0; |
533 | struct dma_buf *dmabuf; | |
3248877e | 534 | |
d0b2c533 | 535 | mutex_lock(&file_priv->prime.lock); |
a8ad0bd8 | 536 | obj = drm_gem_object_lookup(file_priv, handle); |
d0b2c533 DV |
537 | if (!obj) { |
538 | ret = -ENOENT; | |
539 | goto out_unlock; | |
540 | } | |
541 | ||
542 | dmabuf = drm_prime_lookup_buf_by_handle(&file_priv->prime, handle); | |
543 | if (dmabuf) { | |
544 | get_dma_buf(dmabuf); | |
545 | goto out_have_handle; | |
546 | } | |
3248877e | 547 | |
d0b2c533 | 548 | mutex_lock(&dev->object_name_lock); |
3248877e DA |
549 | /* re-export the original imported object */ |
550 | if (obj->import_attach) { | |
219b4733 | 551 | dmabuf = obj->import_attach->dmabuf; |
319c933c | 552 | get_dma_buf(dmabuf); |
219b4733 | 553 | goto out_have_obj; |
3248877e DA |
554 | } |
555 | ||
319c933c DV |
556 | if (obj->dma_buf) { |
557 | get_dma_buf(obj->dma_buf); | |
558 | dmabuf = obj->dma_buf; | |
219b4733 | 559 | goto out_have_obj; |
3248877e | 560 | } |
219b4733 | 561 | |
319c933c | 562 | dmabuf = export_and_register_object(dev, obj, flags); |
4332bf43 | 563 | if (IS_ERR(dmabuf)) { |
219b4733 DA |
564 | /* normally the created dma-buf takes ownership of the ref, |
565 | * but if that fails then drop the ref | |
566 | */ | |
4332bf43 | 567 | ret = PTR_ERR(dmabuf); |
d0b2c533 | 568 | mutex_unlock(&dev->object_name_lock); |
219b4733 DA |
569 | goto out; |
570 | } | |
219b4733 | 571 | |
d0b2c533 DV |
572 | out_have_obj: |
573 | /* | |
574 | * If we've exported this buffer then cheat and add it to the import list | |
575 | * so we get the correct handle back. We must do this under the | |
576 | * protection of dev->object_name_lock to ensure that a racing gem close | |
577 | * ioctl doesn't miss to remove this buffer handle from the cache. | |
0ff926c7 | 578 | */ |
219b4733 | 579 | ret = drm_prime_add_buf_handle(&file_priv->prime, |
319c933c | 580 | dmabuf, handle); |
d0b2c533 | 581 | mutex_unlock(&dev->object_name_lock); |
219b4733 | 582 | if (ret) |
7d8f06ac | 583 | goto fail_put_dmabuf; |
0ff926c7 | 584 | |
d0b2c533 | 585 | out_have_handle: |
4332bf43 | 586 | ret = dma_buf_fd(dmabuf, flags); |
d0b2c533 DV |
587 | /* |
588 | * We must _not_ remove the buffer from the handle cache since the newly | |
589 | * created dma buf is already linked in the global obj->dma_buf pointer, | |
590 | * and that is invariant as long as a userspace gem handle exists. | |
591 | * Closing the handle will clean out the cache anyway, so we don't leak. | |
592 | */ | |
4a88f73f | 593 | if (ret < 0) { |
d0b2c533 | 594 | goto fail_put_dmabuf; |
4a88f73f | 595 | } else { |
da34242e | 596 | *prime_fd = ret; |
4a88f73f DV |
597 | ret = 0; |
598 | } | |
599 | ||
7d8f06ac YC |
600 | goto out; |
601 | ||
602 | fail_put_dmabuf: | |
4332bf43 | 603 | dma_buf_put(dmabuf); |
219b4733 | 604 | out: |
e6b62714 | 605 | drm_gem_object_put_unlocked(obj); |
d0b2c533 DV |
606 | out_unlock: |
607 | mutex_unlock(&file_priv->prime.lock); | |
608 | ||
219b4733 | 609 | return ret; |
3248877e DA |
610 | } |
611 | EXPORT_SYMBOL(drm_gem_prime_handle_to_fd); | |
612 | ||
7698799f NT |
613 | /** |
614 | * drm_gem_prime_mmap - PRIME mmap function for GEM drivers | |
615 | * @obj: GEM object | |
616 | * @vma: Virtual address range | |
617 | * | |
618 | * This function sets up a userspace mapping for PRIME exported buffers using | |
619 | * the same codepath that is used for regular GEM buffer mapping on the DRM fd. | |
620 | * The fake GEM offset is added to vma->vm_pgoff and &drm_driver->fops->mmap is | |
621 | * called to set up the mapping. | |
622 | * | |
623 | * Drivers can use this as their &drm_driver.gem_prime_mmap callback. | |
624 | */ | |
625 | int drm_gem_prime_mmap(struct drm_gem_object *obj, struct vm_area_struct *vma) | |
626 | { | |
10fdb7d2 NT |
627 | struct drm_file *priv; |
628 | struct file *fil; | |
7698799f NT |
629 | int ret; |
630 | ||
10fdb7d2 NT |
631 | priv = kzalloc(sizeof(*priv), GFP_KERNEL); |
632 | fil = kzalloc(sizeof(*fil), GFP_KERNEL); | |
633 | if (!priv || !fil) { | |
634 | ret = -ENOMEM; | |
635 | goto out; | |
636 | } | |
637 | ||
638 | /* Used by drm_gem_mmap() to lookup the GEM object */ | |
639 | priv->minor = obj->dev->primary; | |
640 | fil->private_data = priv; | |
641 | ||
642 | ret = drm_vma_node_allow(&obj->vma_node, priv); | |
7698799f | 643 | if (ret) |
10fdb7d2 | 644 | goto out; |
7698799f NT |
645 | |
646 | vma->vm_pgoff += drm_vma_node_start(&obj->vma_node); | |
647 | ||
10fdb7d2 | 648 | ret = obj->dev->driver->fops->mmap(fil, vma); |
7698799f | 649 | |
10fdb7d2 NT |
650 | drm_vma_node_revoke(&obj->vma_node, priv); |
651 | out: | |
652 | kfree(priv); | |
653 | kfree(fil); | |
7698799f NT |
654 | |
655 | return ret; | |
656 | } | |
657 | EXPORT_SYMBOL(drm_gem_prime_mmap); | |
658 | ||
39cc344a | 659 | /** |
7e491583 | 660 | * drm_gem_prime_import_dev - core implementation of the import callback |
39cc344a DV |
661 | * @dev: drm_device to import into |
662 | * @dma_buf: dma-buf object to import | |
7e491583 | 663 | * @attach_dev: struct device to dma_buf attach |
39cc344a | 664 | * |
7e491583 LA |
665 | * This is the core of drm_gem_prime_import. It's designed to be called by |
666 | * drivers who want to use a different device structure than dev->dev for | |
667 | * attaching via dma_buf. | |
39cc344a | 668 | */ |
7e491583 LA |
669 | struct drm_gem_object *drm_gem_prime_import_dev(struct drm_device *dev, |
670 | struct dma_buf *dma_buf, | |
671 | struct device *attach_dev) | |
89177644 AP |
672 | { |
673 | struct dma_buf_attachment *attach; | |
674 | struct sg_table *sgt; | |
675 | struct drm_gem_object *obj; | |
676 | int ret; | |
677 | ||
89177644 AP |
678 | if (dma_buf->ops == &drm_gem_prime_dmabuf_ops) { |
679 | obj = dma_buf->priv; | |
680 | if (obj->dev == dev) { | |
681 | /* | |
682 | * Importing dmabuf exported from out own gem increases | |
683 | * refcount on gem itself instead of f_count of dmabuf. | |
684 | */ | |
e6b62714 | 685 | drm_gem_object_get(obj); |
89177644 AP |
686 | return obj; |
687 | } | |
688 | } | |
689 | ||
98515035 TF |
690 | if (!dev->driver->gem_prime_import_sg_table) |
691 | return ERR_PTR(-EINVAL); | |
692 | ||
7e491583 | 693 | attach = dma_buf_attach(dma_buf, attach_dev); |
89177644 | 694 | if (IS_ERR(attach)) |
f2a5da4f | 695 | return ERR_CAST(attach); |
89177644 | 696 | |
011c2282 ID |
697 | get_dma_buf(dma_buf); |
698 | ||
89177644 | 699 | sgt = dma_buf_map_attachment(attach, DMA_BIDIRECTIONAL); |
fee0c54e | 700 | if (IS_ERR(sgt)) { |
89177644 AP |
701 | ret = PTR_ERR(sgt); |
702 | goto fail_detach; | |
703 | } | |
704 | ||
b5e9c1a2 | 705 | obj = dev->driver->gem_prime_import_sg_table(dev, attach, sgt); |
89177644 AP |
706 | if (IS_ERR(obj)) { |
707 | ret = PTR_ERR(obj); | |
708 | goto fail_unmap; | |
709 | } | |
710 | ||
711 | obj->import_attach = attach; | |
712 | ||
713 | return obj; | |
714 | ||
715 | fail_unmap: | |
716 | dma_buf_unmap_attachment(attach, sgt, DMA_BIDIRECTIONAL); | |
717 | fail_detach: | |
718 | dma_buf_detach(dma_buf, attach); | |
011c2282 ID |
719 | dma_buf_put(dma_buf); |
720 | ||
89177644 AP |
721 | return ERR_PTR(ret); |
722 | } | |
7e491583 LA |
723 | EXPORT_SYMBOL(drm_gem_prime_import_dev); |
724 | ||
725 | /** | |
726 | * drm_gem_prime_import - helper library implementation of the import callback | |
727 | * @dev: drm_device to import into | |
728 | * @dma_buf: dma-buf object to import | |
729 | * | |
730 | * This is the implementation of the gem_prime_import functions for GEM drivers | |
731 | * using the PRIME helpers. | |
732 | */ | |
733 | struct drm_gem_object *drm_gem_prime_import(struct drm_device *dev, | |
734 | struct dma_buf *dma_buf) | |
735 | { | |
736 | return drm_gem_prime_import_dev(dev, dma_buf, dev->dev); | |
737 | } | |
89177644 AP |
738 | EXPORT_SYMBOL(drm_gem_prime_import); |
739 | ||
39cc344a DV |
740 | /** |
741 | * drm_gem_prime_fd_to_handle - PRIME import function for GEM drivers | |
742 | * @dev: dev to export the buffer from | |
743 | * @file_priv: drm file-private structure | |
744 | * @prime_fd: fd id of the dma-buf which should be imported | |
745 | * @handle: pointer to storage for the handle of the imported buffer object | |
746 | * | |
747 | * This is the PRIME import function which must be used mandatorily by GEM | |
748 | * drivers to ensure correct lifetime management of the underlying GEM object. | |
749 | * The actual importing of GEM object from the dma-buf is done through the | |
750 | * gem_import_export driver callback. | |
751 | */ | |
3248877e | 752 | int drm_gem_prime_fd_to_handle(struct drm_device *dev, |
39cc344a DV |
753 | struct drm_file *file_priv, int prime_fd, |
754 | uint32_t *handle) | |
3248877e DA |
755 | { |
756 | struct dma_buf *dma_buf; | |
757 | struct drm_gem_object *obj; | |
758 | int ret; | |
759 | ||
760 | dma_buf = dma_buf_get(prime_fd); | |
761 | if (IS_ERR(dma_buf)) | |
762 | return PTR_ERR(dma_buf); | |
763 | ||
764 | mutex_lock(&file_priv->prime.lock); | |
765 | ||
219b4733 | 766 | ret = drm_prime_lookup_buf_handle(&file_priv->prime, |
3248877e | 767 | dma_buf, handle); |
84341c28 | 768 | if (ret == 0) |
3248877e | 769 | goto out_put; |
3248877e DA |
770 | |
771 | /* never seen this one, need to import */ | |
319c933c | 772 | mutex_lock(&dev->object_name_lock); |
f0014881 NT |
773 | if (dev->driver->gem_prime_import) |
774 | obj = dev->driver->gem_prime_import(dev, dma_buf); | |
775 | else | |
776 | obj = drm_gem_prime_import(dev, dma_buf); | |
3248877e DA |
777 | if (IS_ERR(obj)) { |
778 | ret = PTR_ERR(obj); | |
319c933c DV |
779 | goto out_unlock; |
780 | } | |
781 | ||
782 | if (obj->dma_buf) { | |
783 | WARN_ON(obj->dma_buf != dma_buf); | |
784 | } else { | |
785 | obj->dma_buf = dma_buf; | |
786 | get_dma_buf(dma_buf); | |
3248877e DA |
787 | } |
788 | ||
bd6e2732 | 789 | /* _handle_create_tail unconditionally unlocks dev->object_name_lock. */ |
319c933c | 790 | ret = drm_gem_handle_create_tail(file_priv, obj, handle); |
e6b62714 | 791 | drm_gem_object_put_unlocked(obj); |
3248877e DA |
792 | if (ret) |
793 | goto out_put; | |
794 | ||
219b4733 | 795 | ret = drm_prime_add_buf_handle(&file_priv->prime, |
3248877e | 796 | dma_buf, *handle); |
bd6e2732 | 797 | mutex_unlock(&file_priv->prime.lock); |
3248877e DA |
798 | if (ret) |
799 | goto fail; | |
800 | ||
011c2282 ID |
801 | dma_buf_put(dma_buf); |
802 | ||
3248877e DA |
803 | return 0; |
804 | ||
805 | fail: | |
806 | /* hmm, if driver attached, we are relying on the free-object path | |
807 | * to detach.. which seems ok.. | |
808 | */ | |
730c4ff9 | 809 | drm_gem_handle_delete(file_priv, *handle); |
bd6e2732 RC |
810 | dma_buf_put(dma_buf); |
811 | return ret; | |
812 | ||
319c933c | 813 | out_unlock: |
0adb2370 | 814 | mutex_unlock(&dev->object_name_lock); |
3248877e | 815 | out_put: |
3248877e | 816 | mutex_unlock(&file_priv->prime.lock); |
bd6e2732 | 817 | dma_buf_put(dma_buf); |
3248877e DA |
818 | return ret; |
819 | } | |
820 | EXPORT_SYMBOL(drm_gem_prime_fd_to_handle); | |
821 | ||
822 | int drm_prime_handle_to_fd_ioctl(struct drm_device *dev, void *data, | |
823 | struct drm_file *file_priv) | |
824 | { | |
825 | struct drm_prime_handle *args = data; | |
3248877e DA |
826 | |
827 | if (!drm_core_check_feature(dev, DRIVER_PRIME)) | |
69fdf420 | 828 | return -EOPNOTSUPP; |
3248877e DA |
829 | |
830 | if (!dev->driver->prime_handle_to_fd) | |
831 | return -ENOSYS; | |
832 | ||
833 | /* check flags are valid */ | |
bfe981a0 | 834 | if (args->flags & ~(DRM_CLOEXEC | DRM_RDWR)) |
3248877e DA |
835 | return -EINVAL; |
836 | ||
3248877e | 837 | return dev->driver->prime_handle_to_fd(dev, file_priv, |
bfe981a0 | 838 | args->handle, args->flags, &args->fd); |
3248877e DA |
839 | } |
840 | ||
841 | int drm_prime_fd_to_handle_ioctl(struct drm_device *dev, void *data, | |
842 | struct drm_file *file_priv) | |
843 | { | |
844 | struct drm_prime_handle *args = data; | |
845 | ||
846 | if (!drm_core_check_feature(dev, DRIVER_PRIME)) | |
69fdf420 | 847 | return -EOPNOTSUPP; |
3248877e DA |
848 | |
849 | if (!dev->driver->prime_fd_to_handle) | |
850 | return -ENOSYS; | |
851 | ||
852 | return dev->driver->prime_fd_to_handle(dev, file_priv, | |
853 | args->fd, &args->handle); | |
854 | } | |
855 | ||
39cc344a DV |
856 | /** |
857 | * drm_prime_pages_to_sg - converts a page array into an sg list | |
858 | * @pages: pointer to the array of page pointers to convert | |
859 | * @nr_pages: length of the page vector | |
3248877e | 860 | * |
39cc344a | 861 | * This helper creates an sg table object from a set of pages |
3248877e | 862 | * the driver is responsible for mapping the pages into the |
39cc344a | 863 | * importers address space for use with dma_buf itself. |
3248877e | 864 | */ |
34eab43e | 865 | struct sg_table *drm_prime_pages_to_sg(struct page **pages, unsigned int nr_pages) |
3248877e DA |
866 | { |
867 | struct sg_table *sg = NULL; | |
3248877e DA |
868 | int ret; |
869 | ||
870 | sg = kmalloc(sizeof(struct sg_table), GFP_KERNEL); | |
7e3d88f9 YC |
871 | if (!sg) { |
872 | ret = -ENOMEM; | |
3248877e | 873 | goto out; |
7e3d88f9 | 874 | } |
3248877e | 875 | |
dca25cb8 RS |
876 | ret = sg_alloc_table_from_pages(sg, pages, nr_pages, 0, |
877 | nr_pages << PAGE_SHIFT, GFP_KERNEL); | |
3248877e DA |
878 | if (ret) |
879 | goto out; | |
880 | ||
3248877e DA |
881 | return sg; |
882 | out: | |
883 | kfree(sg); | |
7e3d88f9 | 884 | return ERR_PTR(ret); |
3248877e DA |
885 | } |
886 | EXPORT_SYMBOL(drm_prime_pages_to_sg); | |
887 | ||
39cc344a DV |
888 | /** |
889 | * drm_prime_sg_to_page_addr_arrays - convert an sg table into a page array | |
890 | * @sgt: scatter-gather table to convert | |
186ca446 | 891 | * @pages: optional array of page pointers to store the page array in |
39cc344a | 892 | * @addrs: optional array to store the dma bus address of each page |
186ca446 | 893 | * @max_entries: size of both the passed-in arrays |
39cc344a DV |
894 | * |
895 | * Exports an sg table into an array of pages and addresses. This is currently | |
896 | * required by the TTM driver in order to do correct fault handling. | |
897 | */ | |
51ab7ba2 | 898 | int drm_prime_sg_to_page_addr_arrays(struct sg_table *sgt, struct page **pages, |
186ca446 | 899 | dma_addr_t *addrs, int max_entries) |
51ab7ba2 DA |
900 | { |
901 | unsigned count; | |
902 | struct scatterlist *sg; | |
903 | struct page *page; | |
186ca446 | 904 | u32 len, index; |
51ab7ba2 DA |
905 | dma_addr_t addr; |
906 | ||
186ca446 | 907 | index = 0; |
51ab7ba2 DA |
908 | for_each_sg(sgt->sgl, sg, sgt->nents, count) { |
909 | len = sg->length; | |
51ab7ba2 DA |
910 | page = sg_page(sg); |
911 | addr = sg_dma_address(sg); | |
912 | ||
913 | while (len > 0) { | |
186ca446 | 914 | if (WARN_ON(index >= max_entries)) |
51ab7ba2 | 915 | return -1; |
186ca446 CK |
916 | if (pages) |
917 | pages[index] = page; | |
51ab7ba2 | 918 | if (addrs) |
186ca446 | 919 | addrs[index] = addr; |
51ab7ba2 DA |
920 | |
921 | page++; | |
922 | addr += PAGE_SIZE; | |
923 | len -= PAGE_SIZE; | |
186ca446 | 924 | index++; |
51ab7ba2 DA |
925 | } |
926 | } | |
927 | return 0; | |
928 | } | |
929 | EXPORT_SYMBOL(drm_prime_sg_to_page_addr_arrays); | |
39cc344a DV |
930 | |
931 | /** | |
932 | * drm_prime_gem_destroy - helper to clean up a PRIME-imported GEM object | |
933 | * @obj: GEM object which was created from a dma-buf | |
934 | * @sg: the sg-table which was pinned at import time | |
935 | * | |
936 | * This is the cleanup functions which GEM drivers need to call when they use | |
937 | * @drm_gem_prime_import to import dma-bufs. | |
938 | */ | |
3248877e DA |
939 | void drm_prime_gem_destroy(struct drm_gem_object *obj, struct sg_table *sg) |
940 | { | |
941 | struct dma_buf_attachment *attach; | |
942 | struct dma_buf *dma_buf; | |
943 | attach = obj->import_attach; | |
944 | if (sg) | |
945 | dma_buf_unmap_attachment(attach, sg, DMA_BIDIRECTIONAL); | |
946 | dma_buf = attach->dmabuf; | |
947 | dma_buf_detach(attach->dmabuf, attach); | |
948 | /* remove the reference */ | |
949 | dma_buf_put(dma_buf); | |
950 | } | |
951 | EXPORT_SYMBOL(drm_prime_gem_destroy); | |
952 | ||
953 | void drm_prime_init_file_private(struct drm_prime_file_private *prime_fpriv) | |
954 | { | |
3248877e | 955 | mutex_init(&prime_fpriv->lock); |
077675c1 CW |
956 | prime_fpriv->dmabufs = RB_ROOT; |
957 | prime_fpriv->handles = RB_ROOT; | |
3248877e | 958 | } |
3248877e DA |
959 | |
960 | void drm_prime_destroy_file_private(struct drm_prime_file_private *prime_fpriv) | |
961 | { | |
98b76231 | 962 | /* by now drm_gem_release should've made sure the list is empty */ |
077675c1 | 963 | WARN_ON(!RB_EMPTY_ROOT(&prime_fpriv->dmabufs)); |
3248877e | 964 | } |