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