blob: 602b12d7470d2d6cca23e7aca1356110cbdea917 [file] [log] [blame]
Thomas Gleixnercaab2772019-06-03 07:44:50 +02001// SPDX-License-Identifier: GPL-2.0-only
Sumit Semwald15bd7e2011-12-26 14:53:15 +05302/*
3 * Framework for buffer objects that can be shared across devices/subsystems.
4 *
5 * Copyright(C) 2011 Linaro Limited. All rights reserved.
6 * Author: Sumit Semwal <sumit.semwal@ti.com>
7 *
8 * Many thanks to linaro-mm-sig list, and specially
9 * Arnd Bergmann <arnd@arndb.de>, Rob Clark <rob@ti.com> and
10 * Daniel Vetter <daniel@ffwll.ch> for their support in creation and
11 * refining of this idea.
Sumit Semwald15bd7e2011-12-26 14:53:15 +053012 */
13
14#include <linux/fs.h>
15#include <linux/slab.h>
16#include <linux/dma-buf.h>
Chris Wilsonf54d1862016-10-25 13:00:45 +010017#include <linux/dma-fence.h>
Sumit Semwald15bd7e2011-12-26 14:53:15 +053018#include <linux/anon_inodes.h>
19#include <linux/export.h>
Sumit Semwalb89e35632013-04-04 11:44:37 +053020#include <linux/debugfs.h>
Sumit Semwal9abdffe2015-05-05 14:56:15 +053021#include <linux/module.h>
Sumit Semwalb89e35632013-04-04 11:44:37 +053022#include <linux/seq_file.h>
Maarten Lankhorst9b495a52014-07-01 12:57:43 +020023#include <linux/poll.h>
Christian König52791ee2019-08-11 10:06:32 +020024#include <linux/dma-resv.h>
Muhammad Falak R Wanib02da6f2016-05-23 17:08:42 +053025#include <linux/mm.h>
Greg Hackmanned63bb12019-06-13 15:34:06 -070026#include <linux/mount.h>
Linus Torvalds933a90b2019-07-19 10:42:02 -070027#include <linux/pseudo_fs.h>
Sumit Semwald15bd7e2011-12-26 14:53:15 +053028
Daniel Vetterc11e3912016-02-11 20:04:51 -020029#include <uapi/linux/dma-buf.h>
Greg Hackmanned63bb12019-06-13 15:34:06 -070030#include <uapi/linux/magic.h>
Daniel Vetterc11e3912016-02-11 20:04:51 -020031
Hridya Valsarajubdb8d062021-06-03 14:47:51 -070032#include "dma-buf-sysfs-stats.h"
33
Sumit Semwald15bd7e2011-12-26 14:53:15 +053034static inline int is_dma_buf_file(struct file *);
35
Sumit Semwalb89e35632013-04-04 11:44:37 +053036struct dma_buf_list {
37 struct list_head head;
38 struct mutex lock;
39};
40
41static struct dma_buf_list db_list;
42
Greg Hackmannbb2bb902019-06-13 15:34:07 -070043static char *dmabuffs_dname(struct dentry *dentry, char *buffer, int buflen)
44{
45 struct dma_buf *dmabuf;
46 char name[DMA_BUF_NAME_LEN];
47 size_t ret = 0;
48
49 dmabuf = dentry->d_fsdata;
Charan Teja Kalla6348dd22020-06-19 17:27:19 +053050 spin_lock(&dmabuf->name_lock);
Greg Hackmannbb2bb902019-06-13 15:34:07 -070051 if (dmabuf->name)
52 ret = strlcpy(name, dmabuf->name, DMA_BUF_NAME_LEN);
Charan Teja Kalla6348dd22020-06-19 17:27:19 +053053 spin_unlock(&dmabuf->name_lock);
Greg Hackmannbb2bb902019-06-13 15:34:07 -070054
55 return dynamic_dname(dentry, buffer, buflen, "/%s:%s",
56 dentry->d_name.name, ret > 0 ? name : "");
57}
58
Sumit Semwal4ab59c32020-06-11 17:14:18 +053059static void dma_buf_release(struct dentry *dentry)
Sumit Semwald15bd7e2011-12-26 14:53:15 +053060{
61 struct dma_buf *dmabuf;
62
Sumit Semwal4ab59c32020-06-11 17:14:18 +053063 dmabuf = dentry->d_fsdata;
Charan Teja Reddy19a508b2020-09-18 16:02:31 +053064 if (unlikely(!dmabuf))
65 return;
Sumit Semwald15bd7e2011-12-26 14:53:15 +053066
Daniel Vetterf00b4da2012-12-20 14:14:23 +010067 BUG_ON(dmabuf->vmapping_counter);
68
Maarten Lankhorst9b495a52014-07-01 12:57:43 +020069 /*
Michel Dänzerff2d2382021-07-23 09:58:57 +020070 * If you hit this BUG() it could mean:
71 * * There's a file reference imbalance in dma_buf_poll / dma_buf_poll_cb or somewhere else
72 * * dmabuf->cb_in/out.active are non-0 despite no pending fence callback
Maarten Lankhorst9b495a52014-07-01 12:57:43 +020073 */
Christian König6b51b022021-06-15 13:12:33 +020074 BUG_ON(dmabuf->cb_in.active || dmabuf->cb_out.active);
Maarten Lankhorst9b495a52014-07-01 12:57:43 +020075
Guangming Cao63c57e82021-07-20 18:31:58 +080076 dma_buf_stats_teardown(dmabuf);
Sumit Semwald15bd7e2011-12-26 14:53:15 +053077 dmabuf->ops->release(dmabuf);
Sumit Semwalb89e35632013-04-04 11:44:37 +053078
Christian König52791ee2019-08-11 10:06:32 +020079 if (dmabuf->resv == (struct dma_resv *)&dmabuf[1])
80 dma_resv_fini(dmabuf->resv);
Maarten Lankhorst3aac4502014-07-01 12:57:26 +020081
Charan Teja Reddyf4922832021-07-23 18:01:08 +053082 WARN_ON(!list_empty(&dmabuf->attachments));
Sumit Semwal9abdffe2015-05-05 14:56:15 +053083 module_put(dmabuf->owner);
Cong Wangd1f37222019-12-26 22:32:04 -080084 kfree(dmabuf->name);
Sumit Semwald15bd7e2011-12-26 14:53:15 +053085 kfree(dmabuf);
Sumit Semwal4ab59c32020-06-11 17:14:18 +053086}
87
Charan Teja Reddy05cd8462021-01-05 20:06:39 +053088static int dma_buf_file_release(struct inode *inode, struct file *file)
89{
90 struct dma_buf *dmabuf;
91
92 if (!is_dma_buf_file(file))
93 return -EINVAL;
94
95 dmabuf = file->private_data;
96
97 mutex_lock(&db_list.lock);
98 list_del(&dmabuf->list_node);
99 mutex_unlock(&db_list.lock);
100
101 return 0;
102}
103
Sumit Semwal4ab59c32020-06-11 17:14:18 +0530104static const struct dentry_operations dma_buf_dentry_ops = {
105 .d_dname = dmabuffs_dname,
106 .d_release = dma_buf_release,
107};
108
109static struct vfsmount *dma_buf_mnt;
110
111static int dma_buf_fs_init_context(struct fs_context *fc)
112{
113 struct pseudo_fs_context *ctx;
114
115 ctx = init_pseudo(fc, DMA_BUF_MAGIC);
116 if (!ctx)
117 return -ENOMEM;
118 ctx->dops = &dma_buf_dentry_ops;
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530119 return 0;
120}
121
Sumit Semwal4ab59c32020-06-11 17:14:18 +0530122static struct file_system_type dma_buf_fs_type = {
123 .name = "dmabuf",
124 .init_fs_context = dma_buf_fs_init_context,
125 .kill_sb = kill_anon_super,
126};
127
Daniel Vetter4c785132012-04-24 14:38:52 +0530128static int dma_buf_mmap_internal(struct file *file, struct vm_area_struct *vma)
129{
130 struct dma_buf *dmabuf;
131
132 if (!is_dma_buf_file(file))
133 return -EINVAL;
134
135 dmabuf = file->private_data;
136
Andrew F. Davise3a9d6c2019-03-29 11:52:01 -0500137 /* check if buffer supports mmap */
138 if (!dmabuf->ops->mmap)
139 return -EINVAL;
140
Daniel Vetter4c785132012-04-24 14:38:52 +0530141 /* check for overflowing the buffer's size */
Muhammad Falak R Wanib02da6f2016-05-23 17:08:42 +0530142 if (vma->vm_pgoff + vma_pages(vma) >
Daniel Vetter4c785132012-04-24 14:38:52 +0530143 dmabuf->size >> PAGE_SHIFT)
144 return -EINVAL;
145
146 return dmabuf->ops->mmap(dmabuf, vma);
147}
148
Christopher James Halse Rogers19e86972013-09-10 11:36:45 +0530149static loff_t dma_buf_llseek(struct file *file, loff_t offset, int whence)
150{
151 struct dma_buf *dmabuf;
152 loff_t base;
153
154 if (!is_dma_buf_file(file))
155 return -EBADF;
156
157 dmabuf = file->private_data;
158
159 /* only support discovering the end of the buffer,
160 but also allow SEEK_SET to maintain the idiomatic
161 SEEK_END(0), SEEK_CUR(0) pattern */
162 if (whence == SEEK_END)
163 base = dmabuf->size;
164 else if (whence == SEEK_SET)
165 base = 0;
166 else
167 return -EINVAL;
168
169 if (offset != 0)
170 return -EINVAL;
171
172 return base + offset;
173}
174
Daniel Vettere7e21c72016-12-09 22:50:55 +0100175/**
Daniel Vetter102514e2020-06-12 09:05:35 +0200176 * DOC: implicit fence polling
Daniel Vettere7e21c72016-12-09 22:50:55 +0100177 *
178 * To support cross-device and cross-driver synchronization of buffer access
Daniel Vetter102514e2020-06-12 09:05:35 +0200179 * implicit fences (represented internally in the kernel with &struct dma_fence)
180 * can be attached to a &dma_buf. The glue for that and a few related things are
Christian König52791ee2019-08-11 10:06:32 +0200181 * provided in the &dma_resv structure.
Daniel Vettere7e21c72016-12-09 22:50:55 +0100182 *
183 * Userspace can query the state of these implicitly tracked fences using poll()
184 * and related system calls:
185 *
Linus Torvaldsa9a08842018-02-11 14:34:03 -0800186 * - Checking for EPOLLIN, i.e. read access, can be use to query the state of the
Daniel Vettere7e21c72016-12-09 22:50:55 +0100187 * most recent write or exclusive fence.
188 *
Linus Torvaldsa9a08842018-02-11 14:34:03 -0800189 * - Checking for EPOLLOUT, i.e. write access, can be used to query the state of
Daniel Vettere7e21c72016-12-09 22:50:55 +0100190 * all attached fences, shared and exclusive ones.
191 *
192 * Note that this only signals the completion of the respective fences, i.e. the
193 * DMA transfers are complete. Cache flushing and any other necessary
194 * preparations before CPU access can begin still need to happen.
195 */
196
Chris Wilsonf54d1862016-10-25 13:00:45 +0100197static void dma_buf_poll_cb(struct dma_fence *fence, struct dma_fence_cb *cb)
Maarten Lankhorst9b495a52014-07-01 12:57:43 +0200198{
199 struct dma_buf_poll_cb_t *dcb = (struct dma_buf_poll_cb_t *)cb;
Michel Dänzerff2d2382021-07-23 09:58:57 +0200200 struct dma_buf *dmabuf = container_of(dcb->poll, struct dma_buf, poll);
Maarten Lankhorst9b495a52014-07-01 12:57:43 +0200201 unsigned long flags;
202
203 spin_lock_irqsave(&dcb->poll->lock, flags);
204 wake_up_locked_poll(dcb->poll, dcb->active);
205 dcb->active = 0;
206 spin_unlock_irqrestore(&dcb->poll->lock, flags);
Christian König6b51b022021-06-15 13:12:33 +0200207 dma_fence_put(fence);
Michel Dänzerff2d2382021-07-23 09:58:57 +0200208 /* Paired with get_file in dma_buf_poll */
209 fput(dmabuf->file);
Christian König6b51b022021-06-15 13:12:33 +0200210}
211
Christian König0a420162021-09-24 11:31:22 +0200212static bool dma_buf_poll_add_cb(struct dma_resv *resv, bool write,
Christian König6b51b022021-06-15 13:12:33 +0200213 struct dma_buf_poll_cb_t *dcb)
214{
Christian König0a420162021-09-24 11:31:22 +0200215 struct dma_resv_iter cursor;
Christian König6b51b022021-06-15 13:12:33 +0200216 struct dma_fence *fence;
Christian König0a420162021-09-24 11:31:22 +0200217 int r;
Christian König6b51b022021-06-15 13:12:33 +0200218
Christian König0a420162021-09-24 11:31:22 +0200219 dma_resv_for_each_fence(&cursor, resv, write, fence) {
Christian König6b51b022021-06-15 13:12:33 +0200220 dma_fence_get(fence);
221 r = dma_fence_add_callback(fence, &dcb->cb, dma_buf_poll_cb);
222 if (!r)
223 return true;
224 dma_fence_put(fence);
225 }
226
227 return false;
228}
229
Al Viroafc9a422017-07-03 06:39:46 -0400230static __poll_t dma_buf_poll(struct file *file, poll_table *poll)
Maarten Lankhorst9b495a52014-07-01 12:57:43 +0200231{
232 struct dma_buf *dmabuf;
Christian König52791ee2019-08-11 10:06:32 +0200233 struct dma_resv *resv;
Al Viro01699432017-07-03 03:14:15 -0400234 __poll_t events;
Maarten Lankhorst9b495a52014-07-01 12:57:43 +0200235
236 dmabuf = file->private_data;
237 if (!dmabuf || !dmabuf->resv)
Linus Torvaldsa9a08842018-02-11 14:34:03 -0800238 return EPOLLERR;
Maarten Lankhorst9b495a52014-07-01 12:57:43 +0200239
240 resv = dmabuf->resv;
241
242 poll_wait(file, &dmabuf->poll, poll);
243
Linus Torvaldsa9a08842018-02-11 14:34:03 -0800244 events = poll_requested_events(poll) & (EPOLLIN | EPOLLOUT);
Maarten Lankhorst9b495a52014-07-01 12:57:43 +0200245 if (!events)
246 return 0;
247
Christian König6b51b022021-06-15 13:12:33 +0200248 dma_resv_lock(resv, NULL);
Chris Wilsonb016cd62019-08-14 19:24:01 +0100249
Christian König6b51b022021-06-15 13:12:33 +0200250 if (events & EPOLLOUT) {
251 struct dma_buf_poll_cb_t *dcb = &dmabuf->cb_out;
Chris Wilsonb016cd62019-08-14 19:24:01 +0100252
Christian König6b51b022021-06-15 13:12:33 +0200253 /* Check that callback isn't busy */
Maarten Lankhorst9b495a52014-07-01 12:57:43 +0200254 spin_lock_irq(&dmabuf->poll.lock);
255 if (dcb->active)
Linus Torvaldsa9a08842018-02-11 14:34:03 -0800256 events &= ~EPOLLOUT;
Maarten Lankhorst9b495a52014-07-01 12:57:43 +0200257 else
Linus Torvaldsa9a08842018-02-11 14:34:03 -0800258 dcb->active = EPOLLOUT;
Maarten Lankhorst9b495a52014-07-01 12:57:43 +0200259 spin_unlock_irq(&dmabuf->poll.lock);
260
Christian König6b51b022021-06-15 13:12:33 +0200261 if (events & EPOLLOUT) {
Michel Dänzerff2d2382021-07-23 09:58:57 +0200262 /* Paired with fput in dma_buf_poll_cb */
263 get_file(dmabuf->file);
264
Christian König0a420162021-09-24 11:31:22 +0200265 if (!dma_buf_poll_add_cb(resv, true, dcb))
Christian König6b51b022021-06-15 13:12:33 +0200266 /* No callback queued, wake up any other waiters */
Maarten Lankhorst3c3b1772014-07-01 12:58:00 +0200267 dma_buf_poll_cb(NULL, &dcb->cb);
Christian König6b51b022021-06-15 13:12:33 +0200268 else
Linus Torvaldsa9a08842018-02-11 14:34:03 -0800269 events &= ~EPOLLOUT;
Maarten Lankhorst04a5faa2014-07-01 12:57:54 +0200270 }
Maarten Lankhorst9b495a52014-07-01 12:57:43 +0200271 }
272
Christian König6b51b022021-06-15 13:12:33 +0200273 if (events & EPOLLIN) {
274 struct dma_buf_poll_cb_t *dcb = &dmabuf->cb_in;
275
276 /* Check that callback isn't busy */
277 spin_lock_irq(&dmabuf->poll.lock);
278 if (dcb->active)
279 events &= ~EPOLLIN;
280 else
281 dcb->active = EPOLLIN;
282 spin_unlock_irq(&dmabuf->poll.lock);
283
284 if (events & EPOLLIN) {
Michel Dänzerff2d2382021-07-23 09:58:57 +0200285 /* Paired with fput in dma_buf_poll_cb */
286 get_file(dmabuf->file);
287
Christian König0a420162021-09-24 11:31:22 +0200288 if (!dma_buf_poll_add_cb(resv, false, dcb))
Christian König6b51b022021-06-15 13:12:33 +0200289 /* No callback queued, wake up any other waiters */
290 dma_buf_poll_cb(NULL, &dcb->cb);
291 else
292 events &= ~EPOLLIN;
293 }
294 }
295
296 dma_resv_unlock(resv);
Maarten Lankhorst9b495a52014-07-01 12:57:43 +0200297 return events;
298}
299
Greg Hackmannbb2bb902019-06-13 15:34:07 -0700300/**
301 * dma_buf_set_name - Set a name to a specific dma_buf to track the usage.
Guangming Caoe73c3172021-10-14 18:25:51 +0800302 * It could support changing the name of the dma-buf if the same
303 * piece of memory is used for multiple purpose between different devices.
Greg Hackmannbb2bb902019-06-13 15:34:07 -0700304 *
Krzysztof Kozlowski6d3ba802020-08-19 19:51:33 +0200305 * @dmabuf: [in] dmabuf buffer that will be renamed.
306 * @buf: [in] A piece of userspace memory that contains the name of
307 * the dma-buf.
Greg Hackmannbb2bb902019-06-13 15:34:07 -0700308 *
309 * Returns 0 on success. If the dma-buf buffer is already attached to
310 * devices, return -EBUSY.
311 *
312 */
313static long dma_buf_set_name(struct dma_buf *dmabuf, const char __user *buf)
314{
315 char *name = strndup_user(buf, DMA_BUF_NAME_LEN);
Greg Hackmannbb2bb902019-06-13 15:34:07 -0700316
317 if (IS_ERR(name))
318 return PTR_ERR(name);
319
Charan Teja Kalla6348dd22020-06-19 17:27:19 +0530320 spin_lock(&dmabuf->name_lock);
Greg Hackmannbb2bb902019-06-13 15:34:07 -0700321 kfree(dmabuf->name);
322 dmabuf->name = name;
Charan Teja Kalla6348dd22020-06-19 17:27:19 +0530323 spin_unlock(&dmabuf->name_lock);
Greg Hackmannbb2bb902019-06-13 15:34:07 -0700324
Guangming Caoe73c3172021-10-14 18:25:51 +0800325 return 0;
Greg Hackmannbb2bb902019-06-13 15:34:07 -0700326}
327
Daniel Vetterc11e3912016-02-11 20:04:51 -0200328static long dma_buf_ioctl(struct file *file,
329 unsigned int cmd, unsigned long arg)
330{
331 struct dma_buf *dmabuf;
332 struct dma_buf_sync sync;
333 enum dma_data_direction direction;
Chris Wilson18b862d2016-03-18 20:02:39 +0000334 int ret;
Daniel Vetterc11e3912016-02-11 20:04:51 -0200335
336 dmabuf = file->private_data;
337
338 switch (cmd) {
339 case DMA_BUF_IOCTL_SYNC:
340 if (copy_from_user(&sync, (void __user *) arg, sizeof(sync)))
341 return -EFAULT;
342
343 if (sync.flags & ~DMA_BUF_SYNC_VALID_FLAGS_MASK)
344 return -EINVAL;
345
346 switch (sync.flags & DMA_BUF_SYNC_RW) {
347 case DMA_BUF_SYNC_READ:
348 direction = DMA_FROM_DEVICE;
349 break;
350 case DMA_BUF_SYNC_WRITE:
351 direction = DMA_TO_DEVICE;
352 break;
353 case DMA_BUF_SYNC_RW:
354 direction = DMA_BIDIRECTIONAL;
355 break;
356 default:
357 return -EINVAL;
358 }
359
360 if (sync.flags & DMA_BUF_SYNC_END)
Chris Wilson18b862d2016-03-18 20:02:39 +0000361 ret = dma_buf_end_cpu_access(dmabuf, direction);
Daniel Vetterc11e3912016-02-11 20:04:51 -0200362 else
Chris Wilson18b862d2016-03-18 20:02:39 +0000363 ret = dma_buf_begin_cpu_access(dmabuf, direction);
Daniel Vetterc11e3912016-02-11 20:04:51 -0200364
Chris Wilson18b862d2016-03-18 20:02:39 +0000365 return ret;
Greg Hackmannbb2bb902019-06-13 15:34:07 -0700366
Daniel Vettera5bff922020-04-07 15:30:02 +0200367 case DMA_BUF_SET_NAME_A:
368 case DMA_BUF_SET_NAME_B:
Greg Hackmannbb2bb902019-06-13 15:34:07 -0700369 return dma_buf_set_name(dmabuf, (const char __user *)arg);
370
Daniel Vetterc11e3912016-02-11 20:04:51 -0200371 default:
372 return -ENOTTY;
373 }
374}
375
Greg Hackmannbcc07112019-06-13 15:34:08 -0700376static void dma_buf_show_fdinfo(struct seq_file *m, struct file *file)
377{
378 struct dma_buf *dmabuf = file->private_data;
379
380 seq_printf(m, "size:\t%zu\n", dmabuf->size);
381 /* Don't count the temporary reference taken inside procfs seq_show */
382 seq_printf(m, "count:\t%ld\n", file_count(dmabuf->file) - 1);
383 seq_printf(m, "exp_name:\t%s\n", dmabuf->exp_name);
Charan Teja Kalla6348dd22020-06-19 17:27:19 +0530384 spin_lock(&dmabuf->name_lock);
Greg Hackmannbcc07112019-06-13 15:34:08 -0700385 if (dmabuf->name)
386 seq_printf(m, "name:\t%s\n", dmabuf->name);
Charan Teja Kalla6348dd22020-06-19 17:27:19 +0530387 spin_unlock(&dmabuf->name_lock);
Greg Hackmannbcc07112019-06-13 15:34:08 -0700388}
389
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530390static const struct file_operations dma_buf_fops = {
Charan Teja Reddy05cd8462021-01-05 20:06:39 +0530391 .release = dma_buf_file_release,
Daniel Vetter4c785132012-04-24 14:38:52 +0530392 .mmap = dma_buf_mmap_internal,
Christopher James Halse Rogers19e86972013-09-10 11:36:45 +0530393 .llseek = dma_buf_llseek,
Maarten Lankhorst9b495a52014-07-01 12:57:43 +0200394 .poll = dma_buf_poll,
Daniel Vetterc11e3912016-02-11 20:04:51 -0200395 .unlocked_ioctl = dma_buf_ioctl,
Arnd Bergmann1832f2d2018-09-11 21:59:08 +0200396 .compat_ioctl = compat_ptr_ioctl,
Greg Hackmannbcc07112019-06-13 15:34:08 -0700397 .show_fdinfo = dma_buf_show_fdinfo,
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530398};
399
400/*
401 * is_dma_buf_file - Check if struct file* is associated with dma_buf
402 */
403static inline int is_dma_buf_file(struct file *file)
404{
405 return file->f_op == &dma_buf_fops;
406}
407
Greg Hackmanned63bb12019-06-13 15:34:06 -0700408static struct file *dma_buf_getfile(struct dma_buf *dmabuf, int flags)
409{
410 struct file *file;
411 struct inode *inode = alloc_anon_inode(dma_buf_mnt->mnt_sb);
412
413 if (IS_ERR(inode))
414 return ERR_CAST(inode);
415
416 inode->i_size = dmabuf->size;
417 inode_set_bytes(inode, dmabuf->size);
418
419 file = alloc_file_pseudo(inode, dma_buf_mnt, "dmabuf",
420 flags, &dma_buf_fops);
421 if (IS_ERR(file))
422 goto err_alloc_file;
423 file->f_flags = flags & (O_ACCMODE | O_NONBLOCK);
424 file->private_data = dmabuf;
Greg Hackmannbb2bb902019-06-13 15:34:07 -0700425 file->f_path.dentry->d_fsdata = dmabuf;
Greg Hackmanned63bb12019-06-13 15:34:06 -0700426
427 return file;
428
429err_alloc_file:
430 iput(inode);
431 return file;
432}
433
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530434/**
Daniel Vetter2904a8c2016-12-09 19:53:07 +0100435 * DOC: dma buf device access
436 *
437 * For device DMA access to a shared DMA buffer the usual sequence of operations
438 * is fairly simple:
439 *
440 * 1. The exporter defines his exporter instance using
441 * DEFINE_DMA_BUF_EXPORT_INFO() and calls dma_buf_export() to wrap a private
442 * buffer object into a &dma_buf. It then exports that &dma_buf to userspace
443 * as a file descriptor by calling dma_buf_fd().
444 *
445 * 2. Userspace passes this file-descriptors to all drivers it wants this buffer
446 * to share with: First the filedescriptor is converted to a &dma_buf using
Liviu Dudauc1387822017-11-01 14:06:30 +0000447 * dma_buf_get(). Then the buffer is attached to the device using
Daniel Vetter2904a8c2016-12-09 19:53:07 +0100448 * dma_buf_attach().
449 *
450 * Up to this stage the exporter is still free to migrate or reallocate the
451 * backing storage.
452 *
Liviu Dudauc1387822017-11-01 14:06:30 +0000453 * 3. Once the buffer is attached to all devices userspace can initiate DMA
Daniel Vetter2904a8c2016-12-09 19:53:07 +0100454 * access to the shared buffer. In the kernel this is done by calling
455 * dma_buf_map_attachment() and dma_buf_unmap_attachment().
456 *
457 * 4. Once a driver is done with a shared buffer it needs to call
458 * dma_buf_detach() (after cleaning up any mappings) and then release the
Daniel Vetter85804b72020-12-11 16:58:41 +0100459 * reference acquired with dma_buf_get() by calling dma_buf_put().
Daniel Vetter2904a8c2016-12-09 19:53:07 +0100460 *
461 * For the detailed semantics exporters are expected to implement see
462 * &dma_buf_ops.
463 */
464
465/**
Sumit Semwald8fbe342015-01-23 12:53:43 +0530466 * dma_buf_export - Creates a new dma_buf, and associates an anon file
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530467 * with this buffer, so it can be exported.
468 * Also connect the allocator specific data and ops to the buffer.
Sumit Semwal78df9692013-03-22 18:22:16 +0530469 * Additionally, provide a name string for exporter; useful in debugging.
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530470 *
Sumit Semwald8fbe342015-01-23 12:53:43 +0530471 * @exp_info: [in] holds all the export related information provided
Daniel Vetterf641d3b2016-12-29 21:48:24 +0100472 * by the exporter. see &struct dma_buf_export_info
Sumit Semwald8fbe342015-01-23 12:53:43 +0530473 * for further details.
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530474 *
Daniel Vetter85804b72020-12-11 16:58:41 +0100475 * Returns, on success, a newly created struct dma_buf object, which wraps the
476 * supplied private data and operations for struct dma_buf_ops. On either
477 * missing ops, or error in allocating struct dma_buf, will return negative
478 * error.
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530479 *
Daniel Vetter2904a8c2016-12-09 19:53:07 +0100480 * For most cases the easiest way to create @exp_info is through the
481 * %DEFINE_DMA_BUF_EXPORT_INFO macro.
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530482 */
Sumit Semwald8fbe342015-01-23 12:53:43 +0530483struct dma_buf *dma_buf_export(const struct dma_buf_export_info *exp_info)
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530484{
485 struct dma_buf *dmabuf;
Christian König52791ee2019-08-11 10:06:32 +0200486 struct dma_resv *resv = exp_info->resv;
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530487 struct file *file;
Maarten Lankhorst3aac4502014-07-01 12:57:26 +0200488 size_t alloc_size = sizeof(struct dma_buf);
Chris Wilsona026df42016-07-18 12:16:22 +0100489 int ret;
Jagan Teki51366292015-05-21 01:09:31 +0530490
Sumit Semwald8fbe342015-01-23 12:53:43 +0530491 if (!exp_info->resv)
Christian König52791ee2019-08-11 10:06:32 +0200492 alloc_size += sizeof(struct dma_resv);
Maarten Lankhorst3aac4502014-07-01 12:57:26 +0200493 else
494 /* prevent &dma_buf[1] == dma_buf->resv */
495 alloc_size += 1;
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530496
Sumit Semwald8fbe342015-01-23 12:53:43 +0530497 if (WARN_ON(!exp_info->priv
498 || !exp_info->ops
499 || !exp_info->ops->map_dma_buf
500 || !exp_info->ops->unmap_dma_buf
Andrew F. Davise3a9d6c2019-03-29 11:52:01 -0500501 || !exp_info->ops->release)) {
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530502 return ERR_PTR(-EINVAL);
503 }
504
Christian König15fd5522018-07-03 16:42:26 +0200505 if (WARN_ON(exp_info->ops->cache_sgt_mapping &&
Christian Königbd2275e2020-02-18 16:57:24 +0100506 (exp_info->ops->pin || exp_info->ops->unpin)))
Christian König15fd5522018-07-03 16:42:26 +0200507 return ERR_PTR(-EINVAL);
508
Christian Königbd2275e2020-02-18 16:57:24 +0100509 if (WARN_ON(!exp_info->ops->pin != !exp_info->ops->unpin))
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530510 return ERR_PTR(-EINVAL);
511
Sumit Semwal9abdffe2015-05-05 14:56:15 +0530512 if (!try_module_get(exp_info->owner))
513 return ERR_PTR(-ENOENT);
514
Maarten Lankhorst3aac4502014-07-01 12:57:26 +0200515 dmabuf = kzalloc(alloc_size, GFP_KERNEL);
Sumit Semwal9abdffe2015-05-05 14:56:15 +0530516 if (!dmabuf) {
Chris Wilsona026df42016-07-18 12:16:22 +0100517 ret = -ENOMEM;
518 goto err_module;
Sumit Semwal9abdffe2015-05-05 14:56:15 +0530519 }
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530520
Sumit Semwald8fbe342015-01-23 12:53:43 +0530521 dmabuf->priv = exp_info->priv;
522 dmabuf->ops = exp_info->ops;
523 dmabuf->size = exp_info->size;
524 dmabuf->exp_name = exp_info->exp_name;
Sumit Semwal9abdffe2015-05-05 14:56:15 +0530525 dmabuf->owner = exp_info->owner;
Charan Teja Kalla6348dd22020-06-19 17:27:19 +0530526 spin_lock_init(&dmabuf->name_lock);
Maarten Lankhorst9b495a52014-07-01 12:57:43 +0200527 init_waitqueue_head(&dmabuf->poll);
Christian König6b51b022021-06-15 13:12:33 +0200528 dmabuf->cb_in.poll = dmabuf->cb_out.poll = &dmabuf->poll;
529 dmabuf->cb_in.active = dmabuf->cb_out.active = 0;
Maarten Lankhorst9b495a52014-07-01 12:57:43 +0200530
Maarten Lankhorst3aac4502014-07-01 12:57:26 +0200531 if (!resv) {
Christian König52791ee2019-08-11 10:06:32 +0200532 resv = (struct dma_resv *)&dmabuf[1];
533 dma_resv_init(resv);
Maarten Lankhorst3aac4502014-07-01 12:57:26 +0200534 }
535 dmabuf->resv = resv;
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530536
Greg Hackmanned63bb12019-06-13 15:34:06 -0700537 file = dma_buf_getfile(dmabuf, exp_info->flags);
Tuomas Tynkkynen9022e242013-08-27 16:30:38 +0300538 if (IS_ERR(file)) {
Chris Wilsona026df42016-07-18 12:16:22 +0100539 ret = PTR_ERR(file);
540 goto err_dmabuf;
Tuomas Tynkkynen9022e242013-08-27 16:30:38 +0300541 }
Christopher James Halse Rogers19e86972013-09-10 11:36:45 +0530542
543 file->f_mode |= FMODE_LSEEK;
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530544 dmabuf->file = file;
545
Hridya Valsarajubdb8d062021-06-03 14:47:51 -0700546 ret = dma_buf_stats_setup(dmabuf);
547 if (ret)
548 goto err_sysfs;
549
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530550 mutex_init(&dmabuf->lock);
551 INIT_LIST_HEAD(&dmabuf->attachments);
552
Sumit Semwalb89e35632013-04-04 11:44:37 +0530553 mutex_lock(&db_list.lock);
554 list_add(&dmabuf->list_node, &db_list.head);
555 mutex_unlock(&db_list.lock);
556
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530557 return dmabuf;
Chris Wilsona026df42016-07-18 12:16:22 +0100558
Hridya Valsarajubdb8d062021-06-03 14:47:51 -0700559err_sysfs:
560 /*
561 * Set file->f_path.dentry->d_fsdata to NULL so that when
562 * dma_buf_release() gets invoked by dentry_ops, it exits
563 * early before calling the release() dma_buf op.
564 */
565 file->f_path.dentry->d_fsdata = NULL;
566 fput(file);
Chris Wilsona026df42016-07-18 12:16:22 +0100567err_dmabuf:
568 kfree(dmabuf);
569err_module:
570 module_put(exp_info->owner);
571 return ERR_PTR(ret);
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530572}
Greg Kroah-Hartman16b03142021-10-10 14:46:28 +0200573EXPORT_SYMBOL_NS_GPL(dma_buf_export, DMA_BUF);
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530574
575/**
Daniel Vetter85804b72020-12-11 16:58:41 +0100576 * dma_buf_fd - returns a file descriptor for the given struct dma_buf
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530577 * @dmabuf: [in] pointer to dma_buf for which fd is required.
Dave Airlie55c1c4c2012-03-16 10:34:02 +0000578 * @flags: [in] flags to give to fd
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530579 *
580 * On success, returns an associated 'fd'. Else, returns error.
581 */
Dave Airlie55c1c4c2012-03-16 10:34:02 +0000582int dma_buf_fd(struct dma_buf *dmabuf, int flags)
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530583{
Borislav Petkovf5e097f2012-12-11 16:05:26 +0100584 int fd;
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530585
586 if (!dmabuf || !dmabuf->file)
587 return -EINVAL;
588
Borislav Petkovf5e097f2012-12-11 16:05:26 +0100589 fd = get_unused_fd_flags(flags);
590 if (fd < 0)
591 return fd;
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530592
593 fd_install(fd, dmabuf->file);
594
595 return fd;
596}
Greg Kroah-Hartman16b03142021-10-10 14:46:28 +0200597EXPORT_SYMBOL_NS_GPL(dma_buf_fd, DMA_BUF);
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530598
599/**
Daniel Vetter85804b72020-12-11 16:58:41 +0100600 * dma_buf_get - returns the struct dma_buf related to an fd
601 * @fd: [in] fd associated with the struct dma_buf to be returned
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530602 *
Daniel Vetter85804b72020-12-11 16:58:41 +0100603 * On success, returns the struct dma_buf associated with an fd; uses
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530604 * file's refcounting done by fget to increase refcount. returns ERR_PTR
605 * otherwise.
606 */
607struct dma_buf *dma_buf_get(int fd)
608{
609 struct file *file;
610
611 file = fget(fd);
612
613 if (!file)
614 return ERR_PTR(-EBADF);
615
616 if (!is_dma_buf_file(file)) {
617 fput(file);
618 return ERR_PTR(-EINVAL);
619 }
620
621 return file->private_data;
622}
Greg Kroah-Hartman16b03142021-10-10 14:46:28 +0200623EXPORT_SYMBOL_NS_GPL(dma_buf_get, DMA_BUF);
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530624
625/**
626 * dma_buf_put - decreases refcount of the buffer
627 * @dmabuf: [in] buffer to reduce refcount of
628 *
Daniel Vetter2904a8c2016-12-09 19:53:07 +0100629 * Uses file's refcounting done implicitly by fput().
630 *
631 * If, as a result of this call, the refcount becomes 0, the 'release' file
Daniel Vettere9b4d7b2016-12-29 21:48:25 +0100632 * operation related to this fd is called. It calls &dma_buf_ops.release vfunc
633 * in turn, and frees the memory allocated for dmabuf when exported.
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530634 */
635void dma_buf_put(struct dma_buf *dmabuf)
636{
637 if (WARN_ON(!dmabuf || !dmabuf->file))
638 return;
639
640 fput(dmabuf->file);
641}
Greg Kroah-Hartman16b03142021-10-10 14:46:28 +0200642EXPORT_SYMBOL_NS_GPL(dma_buf_put, DMA_BUF);
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530643
Daniel Vetter84335672021-01-15 17:47:39 +0100644static void mangle_sg_table(struct sg_table *sg_table)
645{
646#ifdef CONFIG_DMABUF_DEBUG
647 int i;
648 struct scatterlist *sg;
649
650 /* To catch abuse of the underlying struct page by importers mix
651 * up the bits, but take care to preserve the low SG_ bits to
652 * not corrupt the sgt. The mixing is undone in __unmap_dma_buf
653 * before passing the sgt back to the exporter. */
654 for_each_sgtable_sg(sg_table, sg, i)
655 sg->page_link ^= ~0xffUL;
656#endif
657
658}
659static struct sg_table * __map_dma_buf(struct dma_buf_attachment *attach,
660 enum dma_data_direction direction)
661{
662 struct sg_table *sg_table;
663
664 sg_table = attach->dmabuf->ops->map_dma_buf(attach, direction);
665
666 if (!IS_ERR_OR_NULL(sg_table))
667 mangle_sg_table(sg_table);
668
669 return sg_table;
670}
671
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530672/**
Daniel Vetter85804b72020-12-11 16:58:41 +0100673 * dma_buf_dynamic_attach - Add the device to dma_buf's attachments list
Christian König15fd5522018-07-03 16:42:26 +0200674 * @dmabuf: [in] buffer to attach device to.
675 * @dev: [in] device to be attached.
Randy Dunlap6f49c252020-04-07 21:20:34 -0700676 * @importer_ops: [in] importer operations for the attachment
677 * @importer_priv: [in] importer private pointer for the attachment
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530678 *
Daniel Vetter2904a8c2016-12-09 19:53:07 +0100679 * Returns struct dma_buf_attachment pointer for this attachment. Attachments
680 * must be cleaned up by calling dma_buf_detach().
681 *
Daniel Vetter85804b72020-12-11 16:58:41 +0100682 * Optionally this calls &dma_buf_ops.attach to allow device-specific attach
683 * functionality.
684 *
Daniel Vetter2904a8c2016-12-09 19:53:07 +0100685 * Returns:
686 *
687 * A pointer to newly created &dma_buf_attachment on success, or a negative
688 * error code wrapped into a pointer on failure.
689 *
690 * Note that this can fail if the backing storage of @dmabuf is in a place not
691 * accessible to @dev, and cannot be moved to a more suitable place. This is
692 * indicated with the error code -EBUSY.
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530693 */
Christian König15fd5522018-07-03 16:42:26 +0200694struct dma_buf_attachment *
695dma_buf_dynamic_attach(struct dma_buf *dmabuf, struct device *dev,
Christian Königbb42df42018-07-03 16:42:26 +0200696 const struct dma_buf_attach_ops *importer_ops,
697 void *importer_priv)
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530698{
699 struct dma_buf_attachment *attach;
700 int ret;
701
Laurent Pinchartd1aa06a2012-01-26 12:27:23 +0100702 if (WARN_ON(!dmabuf || !dev))
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530703 return ERR_PTR(-EINVAL);
704
Christian König4981cdb2020-02-19 13:32:43 +0100705 if (WARN_ON(importer_ops && !importer_ops->move_notify))
706 return ERR_PTR(-EINVAL);
707
Markus Elfringdb7942b2017-05-08 10:50:09 +0200708 attach = kzalloc(sizeof(*attach), GFP_KERNEL);
Markus Elfring34d84ec2017-05-08 10:54:17 +0200709 if (!attach)
Laurent Pincharta9fbc3b2012-01-26 12:27:24 +0100710 return ERR_PTR(-ENOMEM);
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530711
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530712 attach->dev = dev;
713 attach->dmabuf = dmabuf;
Christian König09606b52018-03-22 17:09:42 +0100714 if (importer_ops)
715 attach->peer2peer = importer_ops->allow_peer2peer;
Christian Königbb42df42018-07-03 16:42:26 +0200716 attach->importer_ops = importer_ops;
717 attach->importer_priv = importer_priv;
Laurent Pinchart2ed92012012-01-26 12:27:25 +0100718
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530719 if (dmabuf->ops->attach) {
Christian Königa19741e2018-05-28 11:47:52 +0200720 ret = dmabuf->ops->attach(dmabuf, attach);
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530721 if (ret)
722 goto err_attach;
723 }
Christian König15fd5522018-07-03 16:42:26 +0200724 dma_resv_lock(dmabuf->resv, NULL);
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530725 list_add(&attach->node, &dmabuf->attachments);
Christian König15fd5522018-07-03 16:42:26 +0200726 dma_resv_unlock(dmabuf->resv);
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530727
Christian König15fd5522018-07-03 16:42:26 +0200728 /* When either the importer or the exporter can't handle dynamic
729 * mappings we cache the mapping here to avoid issues with the
730 * reservation object lock.
731 */
732 if (dma_buf_attachment_is_dynamic(attach) !=
733 dma_buf_is_dynamic(dmabuf)) {
734 struct sg_table *sgt;
735
Christian Königbb42df42018-07-03 16:42:26 +0200736 if (dma_buf_is_dynamic(attach->dmabuf)) {
Christian König15fd5522018-07-03 16:42:26 +0200737 dma_resv_lock(attach->dmabuf->resv, NULL);
Christian König7e008b02021-05-17 13:20:17 +0200738 ret = dmabuf->ops->pin(attach);
Christian Königbb42df42018-07-03 16:42:26 +0200739 if (ret)
740 goto err_unlock;
741 }
Christian König15fd5522018-07-03 16:42:26 +0200742
Daniel Vetter84335672021-01-15 17:47:39 +0100743 sgt = __map_dma_buf(attach, DMA_BIDIRECTIONAL);
Christian König15fd5522018-07-03 16:42:26 +0200744 if (!sgt)
745 sgt = ERR_PTR(-ENOMEM);
746 if (IS_ERR(sgt)) {
747 ret = PTR_ERR(sgt);
Christian Königbb42df42018-07-03 16:42:26 +0200748 goto err_unpin;
Christian König15fd5522018-07-03 16:42:26 +0200749 }
750 if (dma_buf_is_dynamic(attach->dmabuf))
751 dma_resv_unlock(attach->dmabuf->resv);
752 attach->sgt = sgt;
753 attach->dir = DMA_BIDIRECTIONAL;
754 }
755
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530756 return attach;
757
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530758err_attach:
759 kfree(attach);
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530760 return ERR_PTR(ret);
Christian König15fd5522018-07-03 16:42:26 +0200761
Christian Königbb42df42018-07-03 16:42:26 +0200762err_unpin:
763 if (dma_buf_is_dynamic(attach->dmabuf))
Christian König7e008b02021-05-17 13:20:17 +0200764 dmabuf->ops->unpin(attach);
Christian Königbb42df42018-07-03 16:42:26 +0200765
Christian König15fd5522018-07-03 16:42:26 +0200766err_unlock:
767 if (dma_buf_is_dynamic(attach->dmabuf))
768 dma_resv_unlock(attach->dmabuf->resv);
769
770 dma_buf_detach(dmabuf, attach);
771 return ERR_PTR(ret);
772}
Greg Kroah-Hartman16b03142021-10-10 14:46:28 +0200773EXPORT_SYMBOL_NS_GPL(dma_buf_dynamic_attach, DMA_BUF);
Christian König15fd5522018-07-03 16:42:26 +0200774
775/**
776 * dma_buf_attach - Wrapper for dma_buf_dynamic_attach
777 * @dmabuf: [in] buffer to attach device to.
778 * @dev: [in] device to be attached.
779 *
780 * Wrapper to call dma_buf_dynamic_attach() for drivers which still use a static
781 * mapping.
782 */
783struct dma_buf_attachment *dma_buf_attach(struct dma_buf *dmabuf,
784 struct device *dev)
785{
Christian Königbb42df42018-07-03 16:42:26 +0200786 return dma_buf_dynamic_attach(dmabuf, dev, NULL, NULL);
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530787}
Greg Kroah-Hartman16b03142021-10-10 14:46:28 +0200788EXPORT_SYMBOL_NS_GPL(dma_buf_attach, DMA_BUF);
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530789
Daniel Vetter84335672021-01-15 17:47:39 +0100790static void __unmap_dma_buf(struct dma_buf_attachment *attach,
791 struct sg_table *sg_table,
792 enum dma_data_direction direction)
793{
794 /* uses XOR, hence this unmangles */
795 mangle_sg_table(sg_table);
796
797 attach->dmabuf->ops->unmap_dma_buf(attach, sg_table, direction);
798}
799
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530800/**
Daniel Vetter85804b72020-12-11 16:58:41 +0100801 * dma_buf_detach - Remove the given attachment from dmabuf's attachments list
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530802 * @dmabuf: [in] buffer to detach from.
803 * @attach: [in] attachment to be detached; is free'd after this call.
804 *
Daniel Vetter2904a8c2016-12-09 19:53:07 +0100805 * Clean up a device attachment obtained by calling dma_buf_attach().
Daniel Vetter85804b72020-12-11 16:58:41 +0100806 *
807 * Optionally this calls &dma_buf_ops.detach for device-specific detach.
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530808 */
809void dma_buf_detach(struct dma_buf *dmabuf, struct dma_buf_attachment *attach)
810{
Laurent Pinchartd1aa06a2012-01-26 12:27:23 +0100811 if (WARN_ON(!dmabuf || !attach))
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530812 return;
813
Christian König15fd5522018-07-03 16:42:26 +0200814 if (attach->sgt) {
815 if (dma_buf_is_dynamic(attach->dmabuf))
816 dma_resv_lock(attach->dmabuf->resv, NULL);
817
Daniel Vetter84335672021-01-15 17:47:39 +0100818 __unmap_dma_buf(attach, attach->sgt, attach->dir);
Christian Königf13e1432018-07-03 16:42:26 +0200819
Christian Königbb42df42018-07-03 16:42:26 +0200820 if (dma_buf_is_dynamic(attach->dmabuf)) {
Christian König7e008b02021-05-17 13:20:17 +0200821 dmabuf->ops->unpin(attach);
Christian König15fd5522018-07-03 16:42:26 +0200822 dma_resv_unlock(attach->dmabuf->resv);
Christian Königbb42df42018-07-03 16:42:26 +0200823 }
Christian König15fd5522018-07-03 16:42:26 +0200824 }
825
Christian König15fd5522018-07-03 16:42:26 +0200826 dma_resv_lock(dmabuf->resv, NULL);
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530827 list_del(&attach->node);
Christian König15fd5522018-07-03 16:42:26 +0200828 dma_resv_unlock(dmabuf->resv);
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530829 if (dmabuf->ops->detach)
830 dmabuf->ops->detach(dmabuf, attach);
831
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530832 kfree(attach);
833}
Greg Kroah-Hartman16b03142021-10-10 14:46:28 +0200834EXPORT_SYMBOL_NS_GPL(dma_buf_detach, DMA_BUF);
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530835
836/**
Christian Königbb42df42018-07-03 16:42:26 +0200837 * dma_buf_pin - Lock down the DMA-buf
Christian Königbb42df42018-07-03 16:42:26 +0200838 * @attach: [in] attachment which should be pinned
839 *
Daniel Vetterc5457812020-12-11 16:58:43 +0100840 * Only dynamic importers (who set up @attach with dma_buf_dynamic_attach()) may
841 * call this, and only for limited use cases like scanout and not for temporary
842 * pin operations. It is not permitted to allow userspace to pin arbitrary
843 * amounts of buffers through this interface.
844 *
845 * Buffers must be unpinned by calling dma_buf_unpin().
846 *
Christian Königbb42df42018-07-03 16:42:26 +0200847 * Returns:
848 * 0 on success, negative error code on failure.
849 */
850int dma_buf_pin(struct dma_buf_attachment *attach)
851{
852 struct dma_buf *dmabuf = attach->dmabuf;
853 int ret = 0;
854
Daniel Vetterc5457812020-12-11 16:58:43 +0100855 WARN_ON(!dma_buf_attachment_is_dynamic(attach));
856
Christian Königbb42df42018-07-03 16:42:26 +0200857 dma_resv_assert_held(dmabuf->resv);
858
859 if (dmabuf->ops->pin)
860 ret = dmabuf->ops->pin(attach);
861
862 return ret;
863}
Greg Kroah-Hartman16b03142021-10-10 14:46:28 +0200864EXPORT_SYMBOL_NS_GPL(dma_buf_pin, DMA_BUF);
Christian Königbb42df42018-07-03 16:42:26 +0200865
866/**
Daniel Vetterc5457812020-12-11 16:58:43 +0100867 * dma_buf_unpin - Unpin a DMA-buf
Christian Königbb42df42018-07-03 16:42:26 +0200868 * @attach: [in] attachment which should be unpinned
Daniel Vetterc5457812020-12-11 16:58:43 +0100869 *
870 * This unpins a buffer pinned by dma_buf_pin() and allows the exporter to move
871 * any mapping of @attach again and inform the importer through
872 * &dma_buf_attach_ops.move_notify.
Christian Königbb42df42018-07-03 16:42:26 +0200873 */
874void dma_buf_unpin(struct dma_buf_attachment *attach)
875{
876 struct dma_buf *dmabuf = attach->dmabuf;
877
Daniel Vetterc5457812020-12-11 16:58:43 +0100878 WARN_ON(!dma_buf_attachment_is_dynamic(attach));
879
Christian Königbb42df42018-07-03 16:42:26 +0200880 dma_resv_assert_held(dmabuf->resv);
881
882 if (dmabuf->ops->unpin)
883 dmabuf->ops->unpin(attach);
884}
Greg Kroah-Hartman16b03142021-10-10 14:46:28 +0200885EXPORT_SYMBOL_NS_GPL(dma_buf_unpin, DMA_BUF);
Christian Königbb42df42018-07-03 16:42:26 +0200886
887/**
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530888 * dma_buf_map_attachment - Returns the scatterlist table of the attachment;
889 * mapped into _device_ address space. Is a wrapper for map_dma_buf() of the
890 * dma_buf_ops.
891 * @attach: [in] attachment whose scatterlist is to be returned
892 * @direction: [in] direction of DMA transfer
893 *
Colin Crossfee0c542013-12-20 16:43:50 -0800894 * Returns sg_table containing the scatterlist to be returned; returns ERR_PTR
Daniel Vetter2904a8c2016-12-09 19:53:07 +0100895 * on error. May return -EINTR if it is interrupted by a signal.
896 *
Jianxin Xiongac80cd12020-10-14 09:16:01 -0700897 * On success, the DMA addresses and lengths in the returned scatterlist are
898 * PAGE_SIZE aligned.
899 *
Liviu Dudauc1387822017-11-01 14:06:30 +0000900 * A mapping must be unmapped by using dma_buf_unmap_attachment(). Note that
Daniel Vetter2904a8c2016-12-09 19:53:07 +0100901 * the underlying backing storage is pinned for as long as a mapping exists,
902 * therefore users/importers should not hold onto a mapping for undue amounts of
903 * time.
Daniel Vetter89bcadc2021-06-21 17:17:58 +0200904 *
905 * Important: Dynamic importers must wait for the exclusive fence of the struct
906 * dma_resv attached to the DMA-BUF first.
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530907 */
908struct sg_table *dma_buf_map_attachment(struct dma_buf_attachment *attach,
909 enum dma_data_direction direction)
910{
Colin Ian King531beb02017-09-15 00:05:16 +0100911 struct sg_table *sg_table;
Christian Königbb42df42018-07-03 16:42:26 +0200912 int r;
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530913
914 might_sleep();
915
Laurent Pinchartd1aa06a2012-01-26 12:27:23 +0100916 if (WARN_ON(!attach || !attach->dmabuf))
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530917 return ERR_PTR(-EINVAL);
918
Christian König15fd5522018-07-03 16:42:26 +0200919 if (dma_buf_attachment_is_dynamic(attach))
920 dma_resv_assert_held(attach->dmabuf->resv);
921
Christian Königf13e1432018-07-03 16:42:26 +0200922 if (attach->sgt) {
923 /*
924 * Two mappings with different directions for the same
925 * attachment are not allowed.
926 */
927 if (attach->dir != direction &&
928 attach->dir != DMA_BIDIRECTIONAL)
929 return ERR_PTR(-EBUSY);
930
931 return attach->sgt;
932 }
933
Christian Königbb42df42018-07-03 16:42:26 +0200934 if (dma_buf_is_dynamic(attach->dmabuf)) {
Christian König15fd5522018-07-03 16:42:26 +0200935 dma_resv_assert_held(attach->dmabuf->resv);
Christian König4981cdb2020-02-19 13:32:43 +0100936 if (!IS_ENABLED(CONFIG_DMABUF_MOVE_NOTIFY)) {
Christian König7e008b02021-05-17 13:20:17 +0200937 r = attach->dmabuf->ops->pin(attach);
Christian Königbb42df42018-07-03 16:42:26 +0200938 if (r)
939 return ERR_PTR(r);
940 }
941 }
Christian König15fd5522018-07-03 16:42:26 +0200942
Daniel Vetter84335672021-01-15 17:47:39 +0100943 sg_table = __map_dma_buf(attach, direction);
Colin Crossfee0c542013-12-20 16:43:50 -0800944 if (!sg_table)
945 sg_table = ERR_PTR(-ENOMEM);
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530946
Christian Königbb42df42018-07-03 16:42:26 +0200947 if (IS_ERR(sg_table) && dma_buf_is_dynamic(attach->dmabuf) &&
Christian König4981cdb2020-02-19 13:32:43 +0100948 !IS_ENABLED(CONFIG_DMABUF_MOVE_NOTIFY))
Christian König7e008b02021-05-17 13:20:17 +0200949 attach->dmabuf->ops->unpin(attach);
Christian Königbb42df42018-07-03 16:42:26 +0200950
Christian Königf13e1432018-07-03 16:42:26 +0200951 if (!IS_ERR(sg_table) && attach->dmabuf->ops->cache_sgt_mapping) {
952 attach->sgt = sg_table;
953 attach->dir = direction;
954 }
955
Jianxin Xiongac80cd12020-10-14 09:16:01 -0700956#ifdef CONFIG_DMA_API_DEBUG
Jianxin Xiong00efd652020-11-02 19:51:58 -0800957 if (!IS_ERR(sg_table)) {
Jianxin Xiongac80cd12020-10-14 09:16:01 -0700958 struct scatterlist *sg;
959 u64 addr;
960 int len;
961 int i;
962
963 for_each_sgtable_dma_sg(sg_table, sg, i) {
964 addr = sg_dma_address(sg);
965 len = sg_dma_len(sg);
966 if (!PAGE_ALIGNED(addr) || !PAGE_ALIGNED(len)) {
967 pr_debug("%s: addr %llx or len %x is not page aligned!\n",
968 __func__, addr, len);
969 }
970 }
971 }
972#endif /* CONFIG_DMA_API_DEBUG */
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530973 return sg_table;
974}
Greg Kroah-Hartman16b03142021-10-10 14:46:28 +0200975EXPORT_SYMBOL_NS_GPL(dma_buf_map_attachment, DMA_BUF);
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530976
977/**
978 * dma_buf_unmap_attachment - unmaps and decreases usecount of the buffer;might
979 * deallocate the scatterlist associated. Is a wrapper for unmap_dma_buf() of
980 * dma_buf_ops.
981 * @attach: [in] attachment to unmap buffer from
982 * @sg_table: [in] scatterlist info of the buffer to unmap
Sumit Semwal33ea2dc2012-01-27 15:09:27 +0530983 * @direction: [in] direction of DMA transfer
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530984 *
Daniel Vetter2904a8c2016-12-09 19:53:07 +0100985 * This unmaps a DMA mapping for @attached obtained by dma_buf_map_attachment().
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530986 */
987void dma_buf_unmap_attachment(struct dma_buf_attachment *attach,
Sumit Semwal33ea2dc2012-01-27 15:09:27 +0530988 struct sg_table *sg_table,
989 enum dma_data_direction direction)
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530990{
Rob Clarkb6fa0cd2012-09-28 09:29:43 +0200991 might_sleep();
992
Laurent Pinchartd1aa06a2012-01-26 12:27:23 +0100993 if (WARN_ON(!attach || !attach->dmabuf || !sg_table))
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530994 return;
995
Christian König15fd5522018-07-03 16:42:26 +0200996 if (dma_buf_attachment_is_dynamic(attach))
997 dma_resv_assert_held(attach->dmabuf->resv);
998
Christian Königf13e1432018-07-03 16:42:26 +0200999 if (attach->sgt == sg_table)
1000 return;
1001
Christian König15fd5522018-07-03 16:42:26 +02001002 if (dma_buf_is_dynamic(attach->dmabuf))
1003 dma_resv_assert_held(attach->dmabuf->resv);
1004
Daniel Vetter84335672021-01-15 17:47:39 +01001005 __unmap_dma_buf(attach, sg_table, direction);
Christian Königbb42df42018-07-03 16:42:26 +02001006
1007 if (dma_buf_is_dynamic(attach->dmabuf) &&
Christian König4981cdb2020-02-19 13:32:43 +01001008 !IS_ENABLED(CONFIG_DMABUF_MOVE_NOTIFY))
Christian Königbb42df42018-07-03 16:42:26 +02001009 dma_buf_unpin(attach);
Sumit Semwald15bd7e2011-12-26 14:53:15 +05301010}
Greg Kroah-Hartman16b03142021-10-10 14:46:28 +02001011EXPORT_SYMBOL_NS_GPL(dma_buf_unmap_attachment, DMA_BUF);
Daniel Vetterfc130202012-03-20 00:02:37 +01001012
Daniel Vetter0959a162016-12-09 19:53:08 +01001013/**
Christian Königbb42df42018-07-03 16:42:26 +02001014 * dma_buf_move_notify - notify attachments that DMA-buf is moving
1015 *
1016 * @dmabuf: [in] buffer which is moving
1017 *
1018 * Informs all attachmenst that they need to destroy and recreated all their
1019 * mappings.
1020 */
1021void dma_buf_move_notify(struct dma_buf *dmabuf)
1022{
1023 struct dma_buf_attachment *attach;
1024
1025 dma_resv_assert_held(dmabuf->resv);
1026
1027 list_for_each_entry(attach, &dmabuf->attachments, node)
Christian König4981cdb2020-02-19 13:32:43 +01001028 if (attach->importer_ops)
Christian Königbb42df42018-07-03 16:42:26 +02001029 attach->importer_ops->move_notify(attach);
1030}
Greg Kroah-Hartman16b03142021-10-10 14:46:28 +02001031EXPORT_SYMBOL_NS_GPL(dma_buf_move_notify, DMA_BUF);
Christian Königbb42df42018-07-03 16:42:26 +02001032
1033/**
Daniel Vetter0959a162016-12-09 19:53:08 +01001034 * DOC: cpu access
1035 *
1036 * There are mutliple reasons for supporting CPU access to a dma buffer object:
1037 *
1038 * - Fallback operations in the kernel, for example when a device is connected
1039 * over USB and the kernel needs to shuffle the data around first before
1040 * sending it away. Cache coherency is handled by braketing any transactions
1041 * with calls to dma_buf_begin_cpu_access() and dma_buf_end_cpu_access()
1042 * access.
1043 *
Daniel Vetter7f0de8d2019-11-18 11:35:30 +01001044 * Since for most kernel internal dma-buf accesses need the entire buffer, a
1045 * vmap interface is introduced. Note that on very old 32-bit architectures
1046 * vmalloc space might be limited and result in vmap calls failing.
Daniel Vetter0959a162016-12-09 19:53:08 +01001047 *
1048 * Interfaces::
Daniel Vetterde9114e2020-12-11 16:58:40 +01001049 *
Shunsuke Mie91909d52021-10-08 20:20:09 +09001050 * void \*dma_buf_vmap(struct dma_buf \*dmabuf, struct dma_buf_map \*map)
1051 * void dma_buf_vunmap(struct dma_buf \*dmabuf, struct dma_buf_map \*map)
Daniel Vetter0959a162016-12-09 19:53:08 +01001052 *
1053 * The vmap call can fail if there is no vmap support in the exporter, or if
Daniel Vetterde9114e2020-12-11 16:58:40 +01001054 * it runs out of vmalloc space. Note that the dma-buf layer keeps a reference
1055 * count for all vmap access and calls down into the exporter's vmap function
1056 * only when no vmapping exists, and only unmaps it once. Protection against
1057 * concurrent vmap/vunmap calls is provided by taking the &dma_buf.lock mutex.
Daniel Vetter0959a162016-12-09 19:53:08 +01001058 *
1059 * - For full compatibility on the importer side with existing userspace
1060 * interfaces, which might already support mmap'ing buffers. This is needed in
1061 * many processing pipelines (e.g. feeding a software rendered image into a
1062 * hardware pipeline, thumbnail creation, snapshots, ...). Also, Android's ION
1063 * framework already supported this and for DMA buffer file descriptors to
1064 * replace ION buffers mmap support was needed.
1065 *
1066 * There is no special interfaces, userspace simply calls mmap on the dma-buf
1067 * fd. But like for CPU access there's a need to braket the actual access,
1068 * which is handled by the ioctl (DMA_BUF_IOCTL_SYNC). Note that
1069 * DMA_BUF_IOCTL_SYNC can fail with -EAGAIN or -EINTR, in which case it must
1070 * be restarted.
1071 *
1072 * Some systems might need some sort of cache coherency management e.g. when
1073 * CPU and GPU domains are being accessed through dma-buf at the same time.
1074 * To circumvent this problem there are begin/end coherency markers, that
1075 * forward directly to existing dma-buf device drivers vfunc hooks. Userspace
1076 * can make use of those markers through the DMA_BUF_IOCTL_SYNC ioctl. The
1077 * sequence would be used like following:
1078 *
1079 * - mmap dma-buf fd
1080 * - for each drawing/upload cycle in CPU 1. SYNC_START ioctl, 2. read/write
1081 * to mmap area 3. SYNC_END ioctl. This can be repeated as often as you
1082 * want (with the new data being consumed by say the GPU or the scanout
1083 * device)
1084 * - munmap once you don't need the buffer any more
1085 *
1086 * For correctness and optimal performance, it is always required to use
1087 * SYNC_START and SYNC_END before and after, respectively, when accessing the
1088 * mapped address. Userspace cannot rely on coherent access, even when there
1089 * are systems where it just works without calling these ioctls.
1090 *
1091 * - And as a CPU fallback in userspace processing pipelines.
1092 *
1093 * Similar to the motivation for kernel cpu access it is again important that
1094 * the userspace code of a given importing subsystem can use the same
1095 * interfaces with a imported dma-buf buffer object as with a native buffer
1096 * object. This is especially important for drm where the userspace part of
1097 * contemporary OpenGL, X, and other drivers is huge, and reworking them to
1098 * use a different way to mmap a buffer rather invasive.
1099 *
1100 * The assumption in the current dma-buf interfaces is that redirecting the
1101 * initial mmap is all that's needed. A survey of some of the existing
1102 * subsystems shows that no driver seems to do any nefarious thing like
1103 * syncing up with outstanding asynchronous processing on the device or
1104 * allocating special resources at fault time. So hopefully this is good
1105 * enough, since adding interfaces to intercept pagefaults and allow pte
1106 * shootdowns would increase the complexity quite a bit.
1107 *
1108 * Interface::
Daniel Vetter85804b72020-12-11 16:58:41 +01001109 *
Daniel Vetter0959a162016-12-09 19:53:08 +01001110 * int dma_buf_mmap(struct dma_buf \*, struct vm_area_struct \*,
1111 * unsigned long);
1112 *
1113 * If the importing subsystem simply provides a special-purpose mmap call to
Daniel Vetter85804b72020-12-11 16:58:41 +01001114 * set up a mapping in userspace, calling do_mmap with &dma_buf.file will
Daniel Vetter0959a162016-12-09 19:53:08 +01001115 * equally achieve that for a dma-buf object.
1116 */
1117
Chris Wilsonae4e46b2016-08-15 16:42:18 +01001118static int __dma_buf_begin_cpu_access(struct dma_buf *dmabuf,
1119 enum dma_data_direction direction)
1120{
1121 bool write = (direction == DMA_BIDIRECTIONAL ||
1122 direction == DMA_TO_DEVICE);
Christian König52791ee2019-08-11 10:06:32 +02001123 struct dma_resv *resv = dmabuf->resv;
Chris Wilsonae4e46b2016-08-15 16:42:18 +01001124 long ret;
1125
1126 /* Wait on any implicit rendering fences */
Christian Königd3fae3b2021-06-02 13:01:15 +02001127 ret = dma_resv_wait_timeout(resv, write, true, MAX_SCHEDULE_TIMEOUT);
Chris Wilsonae4e46b2016-08-15 16:42:18 +01001128 if (ret < 0)
1129 return ret;
1130
1131 return 0;
1132}
Daniel Vetterfc130202012-03-20 00:02:37 +01001133
1134/**
1135 * dma_buf_begin_cpu_access - Must be called before accessing a dma_buf from the
1136 * cpu in the kernel context. Calls begin_cpu_access to allow exporter-specific
1137 * preparations. Coherency is only guaranteed in the specified range for the
1138 * specified access direction.
Randy Dunlapefb4df822012-04-17 17:03:30 -07001139 * @dmabuf: [in] buffer to prepare cpu access for.
Daniel Vetterfc130202012-03-20 00:02:37 +01001140 * @direction: [in] length of range for cpu access.
1141 *
Daniel Vetter0959a162016-12-09 19:53:08 +01001142 * After the cpu access is complete the caller should call
1143 * dma_buf_end_cpu_access(). Only when cpu access is braketed by both calls is
1144 * it guaranteed to be coherent with other DMA access.
1145 *
Daniel Vetterde9114e2020-12-11 16:58:40 +01001146 * This function will also wait for any DMA transactions tracked through
1147 * implicit synchronization in &dma_buf.resv. For DMA transactions with explicit
1148 * synchronization this function will only ensure cache coherency, callers must
1149 * ensure synchronization with such DMA transactions on their own.
1150 *
Daniel Vetterfc130202012-03-20 00:02:37 +01001151 * Can return negative error values, returns 0 on success.
1152 */
Tiago Vignatti831e9da2015-12-22 19:36:45 -02001153int dma_buf_begin_cpu_access(struct dma_buf *dmabuf,
Daniel Vetterfc130202012-03-20 00:02:37 +01001154 enum dma_data_direction direction)
1155{
1156 int ret = 0;
1157
1158 if (WARN_ON(!dmabuf))
1159 return -EINVAL;
1160
Daniel Vetter8ccf0a22020-12-14 18:16:22 +01001161 might_lock(&dmabuf->resv->lock.base);
1162
Daniel Vetterfc130202012-03-20 00:02:37 +01001163 if (dmabuf->ops->begin_cpu_access)
Tiago Vignatti831e9da2015-12-22 19:36:45 -02001164 ret = dmabuf->ops->begin_cpu_access(dmabuf, direction);
Daniel Vetterfc130202012-03-20 00:02:37 +01001165
Chris Wilsonae4e46b2016-08-15 16:42:18 +01001166 /* Ensure that all fences are waited upon - but we first allow
1167 * the native handler the chance to do so more efficiently if it
1168 * chooses. A double invocation here will be reasonably cheap no-op.
1169 */
1170 if (ret == 0)
1171 ret = __dma_buf_begin_cpu_access(dmabuf, direction);
1172
Daniel Vetterfc130202012-03-20 00:02:37 +01001173 return ret;
1174}
Greg Kroah-Hartman16b03142021-10-10 14:46:28 +02001175EXPORT_SYMBOL_NS_GPL(dma_buf_begin_cpu_access, DMA_BUF);
Daniel Vetterfc130202012-03-20 00:02:37 +01001176
1177/**
1178 * dma_buf_end_cpu_access - Must be called after accessing a dma_buf from the
1179 * cpu in the kernel context. Calls end_cpu_access to allow exporter-specific
1180 * actions. Coherency is only guaranteed in the specified range for the
1181 * specified access direction.
Randy Dunlapefb4df822012-04-17 17:03:30 -07001182 * @dmabuf: [in] buffer to complete cpu access for.
Daniel Vetterfc130202012-03-20 00:02:37 +01001183 * @direction: [in] length of range for cpu access.
1184 *
Daniel Vetter0959a162016-12-09 19:53:08 +01001185 * This terminates CPU access started with dma_buf_begin_cpu_access().
1186 *
Daniel Vetter87e332d2016-03-21 08:24:22 +01001187 * Can return negative error values, returns 0 on success.
Daniel Vetterfc130202012-03-20 00:02:37 +01001188 */
Chris Wilson18b862d2016-03-18 20:02:39 +00001189int dma_buf_end_cpu_access(struct dma_buf *dmabuf,
1190 enum dma_data_direction direction)
Daniel Vetterfc130202012-03-20 00:02:37 +01001191{
Chris Wilson18b862d2016-03-18 20:02:39 +00001192 int ret = 0;
1193
Daniel Vetterfc130202012-03-20 00:02:37 +01001194 WARN_ON(!dmabuf);
1195
Daniel Vetter8ccf0a22020-12-14 18:16:22 +01001196 might_lock(&dmabuf->resv->lock.base);
1197
Daniel Vetterfc130202012-03-20 00:02:37 +01001198 if (dmabuf->ops->end_cpu_access)
Chris Wilson18b862d2016-03-18 20:02:39 +00001199 ret = dmabuf->ops->end_cpu_access(dmabuf, direction);
1200
1201 return ret;
Daniel Vetterfc130202012-03-20 00:02:37 +01001202}
Greg Kroah-Hartman16b03142021-10-10 14:46:28 +02001203EXPORT_SYMBOL_NS_GPL(dma_buf_end_cpu_access, DMA_BUF);
Daniel Vetterfc130202012-03-20 00:02:37 +01001204
Daniel Vetter4c785132012-04-24 14:38:52 +05301205
1206/**
1207 * dma_buf_mmap - Setup up a userspace mmap with the given vma
Sumit Semwal12c47272012-05-23 15:27:40 +05301208 * @dmabuf: [in] buffer that should back the vma
Daniel Vetter4c785132012-04-24 14:38:52 +05301209 * @vma: [in] vma for the mmap
1210 * @pgoff: [in] offset in pages where this mmap should start within the
Jagan Teki51366292015-05-21 01:09:31 +05301211 * dma-buf buffer.
Daniel Vetter4c785132012-04-24 14:38:52 +05301212 *
1213 * This function adjusts the passed in vma so that it points at the file of the
Javier Martinez Canillasecf1dba2014-04-10 01:30:05 +02001214 * dma_buf operation. It also adjusts the starting pgoff and does bounds
Daniel Vetter4c785132012-04-24 14:38:52 +05301215 * checking on the size of the vma. Then it calls the exporters mmap function to
1216 * set up the mapping.
1217 *
1218 * Can return negative error values, returns 0 on success.
1219 */
1220int dma_buf_mmap(struct dma_buf *dmabuf, struct vm_area_struct *vma,
1221 unsigned long pgoff)
1222{
1223 if (WARN_ON(!dmabuf || !vma))
1224 return -EINVAL;
1225
Andrew F. Davise3a9d6c2019-03-29 11:52:01 -05001226 /* check if buffer supports mmap */
1227 if (!dmabuf->ops->mmap)
1228 return -EINVAL;
1229
Daniel Vetter4c785132012-04-24 14:38:52 +05301230 /* check for offset overflow */
Muhammad Falak R Wanib02da6f2016-05-23 17:08:42 +05301231 if (pgoff + vma_pages(vma) < pgoff)
Daniel Vetter4c785132012-04-24 14:38:52 +05301232 return -EOVERFLOW;
1233
1234 /* check for overflowing the buffer's size */
Muhammad Falak R Wanib02da6f2016-05-23 17:08:42 +05301235 if (pgoff + vma_pages(vma) >
Daniel Vetter4c785132012-04-24 14:38:52 +05301236 dmabuf->size >> PAGE_SHIFT)
1237 return -EINVAL;
1238
1239 /* readjust the vma */
Christian König295992f2020-09-14 15:09:33 +02001240 vma_set_file(vma, dmabuf->file);
Daniel Vetter4c785132012-04-24 14:38:52 +05301241 vma->vm_pgoff = pgoff;
1242
Christian König1527f922020-10-09 15:08:55 +02001243 return dmabuf->ops->mmap(dmabuf, vma);
Daniel Vetter4c785132012-04-24 14:38:52 +05301244}
Greg Kroah-Hartman16b03142021-10-10 14:46:28 +02001245EXPORT_SYMBOL_NS_GPL(dma_buf_mmap, DMA_BUF);
Dave Airlie98f86c92012-05-20 12:33:56 +05301246
1247/**
Sumit Semwal12c47272012-05-23 15:27:40 +05301248 * dma_buf_vmap - Create virtual mapping for the buffer object into kernel
1249 * address space. Same restrictions as for vmap and friends apply.
1250 * @dmabuf: [in] buffer to vmap
Thomas Zimmermann6619ccf2020-09-25 13:55:59 +02001251 * @map: [out] returns the vmap pointer
Dave Airlie98f86c92012-05-20 12:33:56 +05301252 *
1253 * This call may fail due to lack of virtual mapping address space.
1254 * These calls are optional in drivers. The intended use for them
1255 * is for mapping objects linear in kernel space for high use objects.
Daniel Vetterde9114e2020-12-11 16:58:40 +01001256 *
1257 * To ensure coherency users must call dma_buf_begin_cpu_access() and
1258 * dma_buf_end_cpu_access() around any cpu access performed through this
1259 * mapping.
Colin Crossfee0c542013-12-20 16:43:50 -08001260 *
Thomas Zimmermann6619ccf2020-09-25 13:55:59 +02001261 * Returns 0 on success, or a negative errno code otherwise.
Dave Airlie98f86c92012-05-20 12:33:56 +05301262 */
Thomas Zimmermann6619ccf2020-09-25 13:55:59 +02001263int dma_buf_vmap(struct dma_buf *dmabuf, struct dma_buf_map *map)
Dave Airlie98f86c92012-05-20 12:33:56 +05301264{
Thomas Zimmermann6619ccf2020-09-25 13:55:59 +02001265 struct dma_buf_map ptr;
1266 int ret = 0;
1267
1268 dma_buf_map_clear(map);
Daniel Vetterf00b4da2012-12-20 14:14:23 +01001269
Dave Airlie98f86c92012-05-20 12:33:56 +05301270 if (WARN_ON(!dmabuf))
Thomas Zimmermann6619ccf2020-09-25 13:55:59 +02001271 return -EINVAL;
Dave Airlie98f86c92012-05-20 12:33:56 +05301272
Daniel Vetterf00b4da2012-12-20 14:14:23 +01001273 if (!dmabuf->ops->vmap)
Thomas Zimmermann6619ccf2020-09-25 13:55:59 +02001274 return -EINVAL;
Daniel Vetterf00b4da2012-12-20 14:14:23 +01001275
1276 mutex_lock(&dmabuf->lock);
1277 if (dmabuf->vmapping_counter) {
1278 dmabuf->vmapping_counter++;
Thomas Zimmermann01fd30d2020-09-25 13:55:58 +02001279 BUG_ON(dma_buf_map_is_null(&dmabuf->vmap_ptr));
Thomas Zimmermann6619ccf2020-09-25 13:55:59 +02001280 *map = dmabuf->vmap_ptr;
Daniel Vetterf00b4da2012-12-20 14:14:23 +01001281 goto out_unlock;
1282 }
1283
Thomas Zimmermann01fd30d2020-09-25 13:55:58 +02001284 BUG_ON(dma_buf_map_is_set(&dmabuf->vmap_ptr));
Daniel Vetterf00b4da2012-12-20 14:14:23 +01001285
Thomas Zimmermann6619ccf2020-09-25 13:55:59 +02001286 ret = dmabuf->ops->vmap(dmabuf, &ptr);
1287 if (WARN_ON_ONCE(ret))
Daniel Vetterf00b4da2012-12-20 14:14:23 +01001288 goto out_unlock;
1289
Thomas Zimmermann6619ccf2020-09-25 13:55:59 +02001290 dmabuf->vmap_ptr = ptr;
Daniel Vetterf00b4da2012-12-20 14:14:23 +01001291 dmabuf->vmapping_counter = 1;
1292
Thomas Zimmermann6619ccf2020-09-25 13:55:59 +02001293 *map = dmabuf->vmap_ptr;
1294
Daniel Vetterf00b4da2012-12-20 14:14:23 +01001295out_unlock:
1296 mutex_unlock(&dmabuf->lock);
Thomas Zimmermann6619ccf2020-09-25 13:55:59 +02001297 return ret;
Dave Airlie98f86c92012-05-20 12:33:56 +05301298}
Greg Kroah-Hartman16b03142021-10-10 14:46:28 +02001299EXPORT_SYMBOL_NS_GPL(dma_buf_vmap, DMA_BUF);
Dave Airlie98f86c92012-05-20 12:33:56 +05301300
1301/**
1302 * dma_buf_vunmap - Unmap a vmap obtained by dma_buf_vmap.
Sumit Semwal12c47272012-05-23 15:27:40 +05301303 * @dmabuf: [in] buffer to vunmap
Thomas Zimmermann20e76f12020-09-25 13:56:00 +02001304 * @map: [in] vmap pointer to vunmap
Dave Airlie98f86c92012-05-20 12:33:56 +05301305 */
Thomas Zimmermann20e76f12020-09-25 13:56:00 +02001306void dma_buf_vunmap(struct dma_buf *dmabuf, struct dma_buf_map *map)
Dave Airlie98f86c92012-05-20 12:33:56 +05301307{
1308 if (WARN_ON(!dmabuf))
1309 return;
1310
Thomas Zimmermann01fd30d2020-09-25 13:55:58 +02001311 BUG_ON(dma_buf_map_is_null(&dmabuf->vmap_ptr));
Daniel Vetterf00b4da2012-12-20 14:14:23 +01001312 BUG_ON(dmabuf->vmapping_counter == 0);
Thomas Zimmermann20e76f12020-09-25 13:56:00 +02001313 BUG_ON(!dma_buf_map_is_equal(&dmabuf->vmap_ptr, map));
Daniel Vetterf00b4da2012-12-20 14:14:23 +01001314
1315 mutex_lock(&dmabuf->lock);
1316 if (--dmabuf->vmapping_counter == 0) {
1317 if (dmabuf->ops->vunmap)
Thomas Zimmermann20e76f12020-09-25 13:56:00 +02001318 dmabuf->ops->vunmap(dmabuf, map);
Thomas Zimmermann01fd30d2020-09-25 13:55:58 +02001319 dma_buf_map_clear(&dmabuf->vmap_ptr);
Daniel Vetterf00b4da2012-12-20 14:14:23 +01001320 }
1321 mutex_unlock(&dmabuf->lock);
Dave Airlie98f86c92012-05-20 12:33:56 +05301322}
Greg Kroah-Hartman16b03142021-10-10 14:46:28 +02001323EXPORT_SYMBOL_NS_GPL(dma_buf_vunmap, DMA_BUF);
Sumit Semwalb89e35632013-04-04 11:44:37 +05301324
1325#ifdef CONFIG_DEBUG_FS
Mathias Krauseeb0b9472016-06-19 14:31:29 +02001326static int dma_buf_debug_show(struct seq_file *s, void *unused)
Sumit Semwalb89e35632013-04-04 11:44:37 +05301327{
Sumit Semwalb89e35632013-04-04 11:44:37 +05301328 struct dma_buf *buf_obj;
1329 struct dma_buf_attachment *attach_obj;
Christian König63639d02021-09-23 10:28:42 +02001330 int count = 0, attach_count;
Sumit Semwalb89e35632013-04-04 11:44:37 +05301331 size_t size = 0;
Christian König680753d2021-05-06 15:00:31 +02001332 int ret;
Sumit Semwalb89e35632013-04-04 11:44:37 +05301333
1334 ret = mutex_lock_interruptible(&db_list.lock);
1335
1336 if (ret)
1337 return ret;
1338
Sumit Semwalc0b00a52014-02-03 15:09:12 +05301339 seq_puts(s, "\nDma-buf Objects:\n");
Greg Hackmanned63bb12019-06-13 15:34:06 -07001340 seq_printf(s, "%-8s\t%-8s\t%-8s\t%-8s\texp_name\t%-8s\n",
1341 "size", "flags", "mode", "count", "ino");
Sumit Semwalb89e35632013-04-04 11:44:37 +05301342
1343 list_for_each_entry(buf_obj, &db_list.head, list_node) {
Sumit Semwalb89e35632013-04-04 11:44:37 +05301344
Christian König15fd5522018-07-03 16:42:26 +02001345 ret = dma_resv_lock_interruptible(buf_obj->resv, NULL);
1346 if (ret)
Christian Königf45f57c2019-10-18 16:30:19 +02001347 goto error_unlock;
Sumit Semwalb89e35632013-04-04 11:44:37 +05301348
Guangming Cao8c0fd122021-10-08 15:54:20 +08001349
1350 spin_lock(&buf_obj->name_lock);
Greg Hackmannbb2bb902019-06-13 15:34:07 -07001351 seq_printf(s, "%08zu\t%08x\t%08x\t%08ld\t%s\t%08lu\t%s\n",
Sumit Semwalc0b00a52014-02-03 15:09:12 +05301352 buf_obj->size,
Sumit Semwalb89e35632013-04-04 11:44:37 +05301353 buf_obj->file->f_flags, buf_obj->file->f_mode,
Al Viroa1f6dba2014-08-20 11:05:50 -04001354 file_count(buf_obj->file),
Greg Hackmanned63bb12019-06-13 15:34:06 -07001355 buf_obj->exp_name,
Greg Hackmannbb2bb902019-06-13 15:34:07 -07001356 file_inode(buf_obj->file)->i_ino,
1357 buf_obj->name ?: "");
Guangming Cao8c0fd122021-10-08 15:54:20 +08001358 spin_unlock(&buf_obj->name_lock);
Sumit Semwalb89e35632013-04-04 11:44:37 +05301359
Christian Königa25efb32021-09-23 13:57:42 +02001360 dma_resv_describe(buf_obj->resv, s);
Russell King5eb2c722017-03-31 11:00:42 +01001361
Sumit Semwalc0b00a52014-02-03 15:09:12 +05301362 seq_puts(s, "\tAttached Devices:\n");
Sumit Semwalb89e35632013-04-04 11:44:37 +05301363 attach_count = 0;
1364
1365 list_for_each_entry(attach_obj, &buf_obj->attachments, node) {
Markus Elfring9eddb412017-05-08 10:32:44 +02001366 seq_printf(s, "\t%s\n", dev_name(attach_obj->dev));
Sumit Semwalb89e35632013-04-04 11:44:37 +05301367 attach_count++;
1368 }
Christian König15fd5522018-07-03 16:42:26 +02001369 dma_resv_unlock(buf_obj->resv);
Sumit Semwalb89e35632013-04-04 11:44:37 +05301370
Sumit Semwalc0b00a52014-02-03 15:09:12 +05301371 seq_printf(s, "Total %d devices attached\n\n",
Sumit Semwalb89e35632013-04-04 11:44:37 +05301372 attach_count);
1373
1374 count++;
1375 size += buf_obj->size;
Sumit Semwalb89e35632013-04-04 11:44:37 +05301376 }
1377
1378 seq_printf(s, "\nTotal %d objects, %zu bytes\n", count, size);
1379
1380 mutex_unlock(&db_list.lock);
1381 return 0;
Christian König15fd5522018-07-03 16:42:26 +02001382
Christian Königf45f57c2019-10-18 16:30:19 +02001383error_unlock:
Christian König15fd5522018-07-03 16:42:26 +02001384 mutex_unlock(&db_list.lock);
1385 return ret;
Sumit Semwalb89e35632013-04-04 11:44:37 +05301386}
1387
Yangtao Li26743052018-11-30 11:11:01 -05001388DEFINE_SHOW_ATTRIBUTE(dma_buf_debug);
Sumit Semwalb89e35632013-04-04 11:44:37 +05301389
1390static struct dentry *dma_buf_debugfs_dir;
1391
1392static int dma_buf_init_debugfs(void)
1393{
Mathias Krausebd3e2202016-06-19 14:31:31 +02001394 struct dentry *d;
Sumit Semwalb89e35632013-04-04 11:44:37 +05301395 int err = 0;
Jagan Teki51366292015-05-21 01:09:31 +05301396
Mathias Krausebd3e2202016-06-19 14:31:31 +02001397 d = debugfs_create_dir("dma_buf", NULL);
1398 if (IS_ERR(d))
1399 return PTR_ERR(d);
Jagan Teki51366292015-05-21 01:09:31 +05301400
Mathias Krausebd3e2202016-06-19 14:31:31 +02001401 dma_buf_debugfs_dir = d;
Sumit Semwalb89e35632013-04-04 11:44:37 +05301402
Mathias Krausebd3e2202016-06-19 14:31:31 +02001403 d = debugfs_create_file("bufinfo", S_IRUGO, dma_buf_debugfs_dir,
1404 NULL, &dma_buf_debug_fops);
1405 if (IS_ERR(d)) {
Sumit Semwalb89e35632013-04-04 11:44:37 +05301406 pr_debug("dma_buf: debugfs: failed to create node bufinfo\n");
Mathias Krauseb7479992016-06-19 14:31:30 +02001407 debugfs_remove_recursive(dma_buf_debugfs_dir);
1408 dma_buf_debugfs_dir = NULL;
Mathias Krausebd3e2202016-06-19 14:31:31 +02001409 err = PTR_ERR(d);
Mathias Krauseb7479992016-06-19 14:31:30 +02001410 }
Sumit Semwalb89e35632013-04-04 11:44:37 +05301411
1412 return err;
1413}
1414
1415static void dma_buf_uninit_debugfs(void)
1416{
Vasyl Gomonovych298b6a82017-11-22 16:22:41 +01001417 debugfs_remove_recursive(dma_buf_debugfs_dir);
Sumit Semwalb89e35632013-04-04 11:44:37 +05301418}
Sumit Semwalb89e35632013-04-04 11:44:37 +05301419#else
1420static inline int dma_buf_init_debugfs(void)
1421{
1422 return 0;
1423}
1424static inline void dma_buf_uninit_debugfs(void)
1425{
1426}
1427#endif
1428
1429static int __init dma_buf_init(void)
1430{
Hridya Valsarajubdb8d062021-06-03 14:47:51 -07001431 int ret;
1432
1433 ret = dma_buf_init_sysfs_statistics();
1434 if (ret)
1435 return ret;
1436
Greg Hackmanned63bb12019-06-13 15:34:06 -07001437 dma_buf_mnt = kern_mount(&dma_buf_fs_type);
1438 if (IS_ERR(dma_buf_mnt))
1439 return PTR_ERR(dma_buf_mnt);
1440
Sumit Semwalb89e35632013-04-04 11:44:37 +05301441 mutex_init(&db_list.lock);
1442 INIT_LIST_HEAD(&db_list.head);
1443 dma_buf_init_debugfs();
1444 return 0;
1445}
1446subsys_initcall(dma_buf_init);
1447
1448static void __exit dma_buf_deinit(void)
1449{
1450 dma_buf_uninit_debugfs();
Greg Hackmanned63bb12019-06-13 15:34:06 -07001451 kern_unmount(dma_buf_mnt);
Hridya Valsarajubdb8d062021-06-03 14:47:51 -07001452 dma_buf_uninit_sysfs_statistics();
Sumit Semwalb89e35632013-04-04 11:44:37 +05301453}
1454__exitcall(dma_buf_deinit);