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