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