blob: 510b427719742a539fc401aaf126e7147cb82b3b [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 /*
70 * Any fences that a dma-buf poll can wait on should be signaled
71 * before releasing dma-buf. This is the responsibility of each
72 * driver that uses the reservation objects.
73 *
74 * If you hit this BUG() it means someone dropped their ref to the
75 * dma-buf while still having pending operation to the buffer.
76 */
77 BUG_ON(dmabuf->cb_shared.active || dmabuf->cb_excl.active);
78
Sumit Semwald15bd7e2011-12-26 14:53:15 +053079 dmabuf->ops->release(dmabuf);
Sumit Semwalb89e35632013-04-04 11:44:37 +053080
Christian König52791ee2019-08-11 10:06:32 +020081 if (dmabuf->resv == (struct dma_resv *)&dmabuf[1])
82 dma_resv_fini(dmabuf->resv);
Maarten Lankhorst3aac4502014-07-01 12:57:26 +020083
Hridya Valsarajubdb8d062021-06-03 14:47:51 -070084 dma_buf_stats_teardown(dmabuf);
Sumit Semwal9abdffe2015-05-05 14:56:15 +053085 module_put(dmabuf->owner);
Cong Wangd1f37222019-12-26 22:32:04 -080086 kfree(dmabuf->name);
Sumit Semwald15bd7e2011-12-26 14:53:15 +053087 kfree(dmabuf);
Sumit Semwal4ab59c32020-06-11 17:14:18 +053088}
89
Charan Teja Reddy05cd8462021-01-05 20:06:39 +053090static int dma_buf_file_release(struct inode *inode, struct file *file)
91{
92 struct dma_buf *dmabuf;
93
94 if (!is_dma_buf_file(file))
95 return -EINVAL;
96
97 dmabuf = file->private_data;
98
99 mutex_lock(&db_list.lock);
100 list_del(&dmabuf->list_node);
101 mutex_unlock(&db_list.lock);
102
103 return 0;
104}
105
Sumit Semwal4ab59c32020-06-11 17:14:18 +0530106static const struct dentry_operations dma_buf_dentry_ops = {
107 .d_dname = dmabuffs_dname,
108 .d_release = dma_buf_release,
109};
110
111static struct vfsmount *dma_buf_mnt;
112
113static int dma_buf_fs_init_context(struct fs_context *fc)
114{
115 struct pseudo_fs_context *ctx;
116
117 ctx = init_pseudo(fc, DMA_BUF_MAGIC);
118 if (!ctx)
119 return -ENOMEM;
120 ctx->dops = &dma_buf_dentry_ops;
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530121 return 0;
122}
123
Sumit Semwal4ab59c32020-06-11 17:14:18 +0530124static struct file_system_type dma_buf_fs_type = {
125 .name = "dmabuf",
126 .init_fs_context = dma_buf_fs_init_context,
127 .kill_sb = kill_anon_super,
128};
129
Daniel Vetter4c785132012-04-24 14:38:52 +0530130static int dma_buf_mmap_internal(struct file *file, struct vm_area_struct *vma)
131{
132 struct dma_buf *dmabuf;
133
134 if (!is_dma_buf_file(file))
135 return -EINVAL;
136
137 dmabuf = file->private_data;
138
Andrew F. Davise3a9d6c2019-03-29 11:52:01 -0500139 /* check if buffer supports mmap */
140 if (!dmabuf->ops->mmap)
141 return -EINVAL;
142
Daniel Vetter4c785132012-04-24 14:38:52 +0530143 /* check for overflowing the buffer's size */
Muhammad Falak R Wanib02da6f2016-05-23 17:08:42 +0530144 if (vma->vm_pgoff + vma_pages(vma) >
Daniel Vetter4c785132012-04-24 14:38:52 +0530145 dmabuf->size >> PAGE_SHIFT)
146 return -EINVAL;
147
148 return dmabuf->ops->mmap(dmabuf, vma);
149}
150
Christopher James Halse Rogers19e86972013-09-10 11:36:45 +0530151static loff_t dma_buf_llseek(struct file *file, loff_t offset, int whence)
152{
153 struct dma_buf *dmabuf;
154 loff_t base;
155
156 if (!is_dma_buf_file(file))
157 return -EBADF;
158
159 dmabuf = file->private_data;
160
161 /* only support discovering the end of the buffer,
162 but also allow SEEK_SET to maintain the idiomatic
163 SEEK_END(0), SEEK_CUR(0) pattern */
164 if (whence == SEEK_END)
165 base = dmabuf->size;
166 else if (whence == SEEK_SET)
167 base = 0;
168 else
169 return -EINVAL;
170
171 if (offset != 0)
172 return -EINVAL;
173
174 return base + offset;
175}
176
Daniel Vettere7e21c72016-12-09 22:50:55 +0100177/**
Daniel Vetter102514e2020-06-12 09:05:35 +0200178 * DOC: implicit fence polling
Daniel Vettere7e21c72016-12-09 22:50:55 +0100179 *
180 * To support cross-device and cross-driver synchronization of buffer access
Daniel Vetter102514e2020-06-12 09:05:35 +0200181 * implicit fences (represented internally in the kernel with &struct dma_fence)
182 * 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 +0200183 * provided in the &dma_resv structure.
Daniel Vettere7e21c72016-12-09 22:50:55 +0100184 *
185 * Userspace can query the state of these implicitly tracked fences using poll()
186 * and related system calls:
187 *
Linus Torvaldsa9a08842018-02-11 14:34:03 -0800188 * - Checking for EPOLLIN, i.e. read access, can be use to query the state of the
Daniel Vettere7e21c72016-12-09 22:50:55 +0100189 * most recent write or exclusive fence.
190 *
Linus Torvaldsa9a08842018-02-11 14:34:03 -0800191 * - Checking for EPOLLOUT, i.e. write access, can be used to query the state of
Daniel Vettere7e21c72016-12-09 22:50:55 +0100192 * all attached fences, shared and exclusive ones.
193 *
194 * Note that this only signals the completion of the respective fences, i.e. the
195 * DMA transfers are complete. Cache flushing and any other necessary
196 * preparations before CPU access can begin still need to happen.
197 */
198
Chris Wilsonf54d1862016-10-25 13:00:45 +0100199static void dma_buf_poll_cb(struct dma_fence *fence, struct dma_fence_cb *cb)
Maarten Lankhorst9b495a52014-07-01 12:57:43 +0200200{
201 struct dma_buf_poll_cb_t *dcb = (struct dma_buf_poll_cb_t *)cb;
202 unsigned long flags;
203
204 spin_lock_irqsave(&dcb->poll->lock, flags);
205 wake_up_locked_poll(dcb->poll, dcb->active);
206 dcb->active = 0;
207 spin_unlock_irqrestore(&dcb->poll->lock, flags);
208}
209
Al Viroafc9a422017-07-03 06:39:46 -0400210static __poll_t dma_buf_poll(struct file *file, poll_table *poll)
Maarten Lankhorst9b495a52014-07-01 12:57:43 +0200211{
212 struct dma_buf *dmabuf;
Christian König52791ee2019-08-11 10:06:32 +0200213 struct dma_resv *resv;
214 struct dma_resv_list *fobj;
Chris Wilsonf54d1862016-10-25 13:00:45 +0100215 struct dma_fence *fence_excl;
Al Viro01699432017-07-03 03:14:15 -0400216 __poll_t events;
Chris Wilsonb016cd62019-08-14 19:24:01 +0100217 unsigned shared_count, seq;
Maarten Lankhorst9b495a52014-07-01 12:57:43 +0200218
219 dmabuf = file->private_data;
220 if (!dmabuf || !dmabuf->resv)
Linus Torvaldsa9a08842018-02-11 14:34:03 -0800221 return EPOLLERR;
Maarten Lankhorst9b495a52014-07-01 12:57:43 +0200222
223 resv = dmabuf->resv;
224
225 poll_wait(file, &dmabuf->poll, poll);
226
Linus Torvaldsa9a08842018-02-11 14:34:03 -0800227 events = poll_requested_events(poll) & (EPOLLIN | EPOLLOUT);
Maarten Lankhorst9b495a52014-07-01 12:57:43 +0200228 if (!events)
229 return 0;
230
Chris Wilsonb016cd62019-08-14 19:24:01 +0100231retry:
232 seq = read_seqcount_begin(&resv->seq);
Maarten Lankhorst3c3b1772014-07-01 12:58:00 +0200233 rcu_read_lock();
Chris Wilsonb016cd62019-08-14 19:24:01 +0100234
235 fobj = rcu_dereference(resv->fence);
236 if (fobj)
237 shared_count = fobj->shared_count;
238 else
239 shared_count = 0;
Christian König6edbd6a2021-05-10 16:14:09 +0200240 fence_excl = dma_resv_excl_fence(resv);
Chris Wilsonb016cd62019-08-14 19:24:01 +0100241 if (read_seqcount_retry(&resv->seq, seq)) {
242 rcu_read_unlock();
243 goto retry;
244 }
245
Linus Torvaldsa9a08842018-02-11 14:34:03 -0800246 if (fence_excl && (!(events & EPOLLOUT) || shared_count == 0)) {
Maarten Lankhorst9b495a52014-07-01 12:57:43 +0200247 struct dma_buf_poll_cb_t *dcb = &dmabuf->cb_excl;
Linus Torvaldsa9a08842018-02-11 14:34:03 -0800248 __poll_t pevents = EPOLLIN;
Maarten Lankhorst9b495a52014-07-01 12:57:43 +0200249
Maarten Lankhorst04a5faa2014-07-01 12:57:54 +0200250 if (shared_count == 0)
Linus Torvaldsa9a08842018-02-11 14:34:03 -0800251 pevents |= EPOLLOUT;
Maarten Lankhorst9b495a52014-07-01 12:57:43 +0200252
253 spin_lock_irq(&dmabuf->poll.lock);
254 if (dcb->active) {
255 dcb->active |= pevents;
256 events &= ~pevents;
257 } else
258 dcb->active = pevents;
259 spin_unlock_irq(&dmabuf->poll.lock);
260
261 if (events & pevents) {
Chris Wilsonf54d1862016-10-25 13:00:45 +0100262 if (!dma_fence_get_rcu(fence_excl)) {
Maarten Lankhorst3c3b1772014-07-01 12:58:00 +0200263 /* force a recheck */
264 events &= ~pevents;
265 dma_buf_poll_cb(NULL, &dcb->cb);
Chris Wilsonf54d1862016-10-25 13:00:45 +0100266 } else if (!dma_fence_add_callback(fence_excl, &dcb->cb,
267 dma_buf_poll_cb)) {
Maarten Lankhorst9b495a52014-07-01 12:57:43 +0200268 events &= ~pevents;
Chris Wilsonf54d1862016-10-25 13:00:45 +0100269 dma_fence_put(fence_excl);
Maarten Lankhorst04a5faa2014-07-01 12:57:54 +0200270 } else {
Maarten Lankhorst9b495a52014-07-01 12:57:43 +0200271 /*
272 * No callback queued, wake up any additional
273 * waiters.
274 */
Chris Wilsonf54d1862016-10-25 13:00:45 +0100275 dma_fence_put(fence_excl);
Maarten Lankhorst9b495a52014-07-01 12:57:43 +0200276 dma_buf_poll_cb(NULL, &dcb->cb);
Maarten Lankhorst04a5faa2014-07-01 12:57:54 +0200277 }
Maarten Lankhorst9b495a52014-07-01 12:57:43 +0200278 }
279 }
280
Linus Torvaldsa9a08842018-02-11 14:34:03 -0800281 if ((events & EPOLLOUT) && shared_count > 0) {
Maarten Lankhorst9b495a52014-07-01 12:57:43 +0200282 struct dma_buf_poll_cb_t *dcb = &dmabuf->cb_shared;
283 int i;
284
285 /* Only queue a new callback if no event has fired yet */
286 spin_lock_irq(&dmabuf->poll.lock);
287 if (dcb->active)
Linus Torvaldsa9a08842018-02-11 14:34:03 -0800288 events &= ~EPOLLOUT;
Maarten Lankhorst9b495a52014-07-01 12:57:43 +0200289 else
Linus Torvaldsa9a08842018-02-11 14:34:03 -0800290 dcb->active = EPOLLOUT;
Maarten Lankhorst9b495a52014-07-01 12:57:43 +0200291 spin_unlock_irq(&dmabuf->poll.lock);
292
Linus Torvaldsa9a08842018-02-11 14:34:03 -0800293 if (!(events & EPOLLOUT))
Maarten Lankhorst9b495a52014-07-01 12:57:43 +0200294 goto out;
295
Maarten Lankhorst04a5faa2014-07-01 12:57:54 +0200296 for (i = 0; i < shared_count; ++i) {
Chris Wilsonf54d1862016-10-25 13:00:45 +0100297 struct dma_fence *fence = rcu_dereference(fobj->shared[i]);
Maarten Lankhorst04a5faa2014-07-01 12:57:54 +0200298
Chris Wilsonf54d1862016-10-25 13:00:45 +0100299 if (!dma_fence_get_rcu(fence)) {
Maarten Lankhorst3c3b1772014-07-01 12:58:00 +0200300 /*
301 * fence refcount dropped to zero, this means
302 * that fobj has been freed
303 *
304 * call dma_buf_poll_cb and force a recheck!
305 */
Linus Torvaldsa9a08842018-02-11 14:34:03 -0800306 events &= ~EPOLLOUT;
Maarten Lankhorst3c3b1772014-07-01 12:58:00 +0200307 dma_buf_poll_cb(NULL, &dcb->cb);
308 break;
309 }
Chris Wilsonf54d1862016-10-25 13:00:45 +0100310 if (!dma_fence_add_callback(fence, &dcb->cb,
311 dma_buf_poll_cb)) {
312 dma_fence_put(fence);
Linus Torvaldsa9a08842018-02-11 14:34:03 -0800313 events &= ~EPOLLOUT;
Maarten Lankhorst9b495a52014-07-01 12:57:43 +0200314 break;
315 }
Chris Wilsonf54d1862016-10-25 13:00:45 +0100316 dma_fence_put(fence);
Maarten Lankhorst04a5faa2014-07-01 12:57:54 +0200317 }
Maarten Lankhorst9b495a52014-07-01 12:57:43 +0200318
319 /* No callback queued, wake up any additional waiters. */
Maarten Lankhorst04a5faa2014-07-01 12:57:54 +0200320 if (i == shared_count)
Maarten Lankhorst9b495a52014-07-01 12:57:43 +0200321 dma_buf_poll_cb(NULL, &dcb->cb);
322 }
323
324out:
Maarten Lankhorst3c3b1772014-07-01 12:58:00 +0200325 rcu_read_unlock();
Maarten Lankhorst9b495a52014-07-01 12:57:43 +0200326 return events;
327}
328
Greg Hackmannbb2bb902019-06-13 15:34:07 -0700329/**
330 * dma_buf_set_name - Set a name to a specific dma_buf to track the usage.
331 * The name of the dma-buf buffer can only be set when the dma-buf is not
332 * attached to any devices. It could theoritically support changing the
333 * name of the dma-buf if the same piece of memory is used for multiple
334 * purpose between different devices.
335 *
Krzysztof Kozlowski6d3ba802020-08-19 19:51:33 +0200336 * @dmabuf: [in] dmabuf buffer that will be renamed.
337 * @buf: [in] A piece of userspace memory that contains the name of
338 * the dma-buf.
Greg Hackmannbb2bb902019-06-13 15:34:07 -0700339 *
340 * Returns 0 on success. If the dma-buf buffer is already attached to
341 * devices, return -EBUSY.
342 *
343 */
344static long dma_buf_set_name(struct dma_buf *dmabuf, const char __user *buf)
345{
346 char *name = strndup_user(buf, DMA_BUF_NAME_LEN);
347 long ret = 0;
348
349 if (IS_ERR(name))
350 return PTR_ERR(name);
351
Christian König15fd5522018-07-03 16:42:26 +0200352 dma_resv_lock(dmabuf->resv, NULL);
Greg Hackmannbb2bb902019-06-13 15:34:07 -0700353 if (!list_empty(&dmabuf->attachments)) {
354 ret = -EBUSY;
355 kfree(name);
356 goto out_unlock;
357 }
Charan Teja Kalla6348dd22020-06-19 17:27:19 +0530358 spin_lock(&dmabuf->name_lock);
Greg Hackmannbb2bb902019-06-13 15:34:07 -0700359 kfree(dmabuf->name);
360 dmabuf->name = name;
Charan Teja Kalla6348dd22020-06-19 17:27:19 +0530361 spin_unlock(&dmabuf->name_lock);
Greg Hackmannbb2bb902019-06-13 15:34:07 -0700362
363out_unlock:
Christian König15fd5522018-07-03 16:42:26 +0200364 dma_resv_unlock(dmabuf->resv);
Greg Hackmannbb2bb902019-06-13 15:34:07 -0700365 return ret;
366}
367
Daniel Vetterc11e3912016-02-11 20:04:51 -0200368static long dma_buf_ioctl(struct file *file,
369 unsigned int cmd, unsigned long arg)
370{
371 struct dma_buf *dmabuf;
372 struct dma_buf_sync sync;
373 enum dma_data_direction direction;
Chris Wilson18b862d2016-03-18 20:02:39 +0000374 int ret;
Daniel Vetterc11e3912016-02-11 20:04:51 -0200375
376 dmabuf = file->private_data;
377
378 switch (cmd) {
379 case DMA_BUF_IOCTL_SYNC:
380 if (copy_from_user(&sync, (void __user *) arg, sizeof(sync)))
381 return -EFAULT;
382
383 if (sync.flags & ~DMA_BUF_SYNC_VALID_FLAGS_MASK)
384 return -EINVAL;
385
386 switch (sync.flags & DMA_BUF_SYNC_RW) {
387 case DMA_BUF_SYNC_READ:
388 direction = DMA_FROM_DEVICE;
389 break;
390 case DMA_BUF_SYNC_WRITE:
391 direction = DMA_TO_DEVICE;
392 break;
393 case DMA_BUF_SYNC_RW:
394 direction = DMA_BIDIRECTIONAL;
395 break;
396 default:
397 return -EINVAL;
398 }
399
400 if (sync.flags & DMA_BUF_SYNC_END)
Chris Wilson18b862d2016-03-18 20:02:39 +0000401 ret = dma_buf_end_cpu_access(dmabuf, direction);
Daniel Vetterc11e3912016-02-11 20:04:51 -0200402 else
Chris Wilson18b862d2016-03-18 20:02:39 +0000403 ret = dma_buf_begin_cpu_access(dmabuf, direction);
Daniel Vetterc11e3912016-02-11 20:04:51 -0200404
Chris Wilson18b862d2016-03-18 20:02:39 +0000405 return ret;
Greg Hackmannbb2bb902019-06-13 15:34:07 -0700406
Daniel Vettera5bff922020-04-07 15:30:02 +0200407 case DMA_BUF_SET_NAME_A:
408 case DMA_BUF_SET_NAME_B:
Greg Hackmannbb2bb902019-06-13 15:34:07 -0700409 return dma_buf_set_name(dmabuf, (const char __user *)arg);
410
Daniel Vetterc11e3912016-02-11 20:04:51 -0200411 default:
412 return -ENOTTY;
413 }
414}
415
Greg Hackmannbcc07112019-06-13 15:34:08 -0700416static void dma_buf_show_fdinfo(struct seq_file *m, struct file *file)
417{
418 struct dma_buf *dmabuf = file->private_data;
419
420 seq_printf(m, "size:\t%zu\n", dmabuf->size);
421 /* Don't count the temporary reference taken inside procfs seq_show */
422 seq_printf(m, "count:\t%ld\n", file_count(dmabuf->file) - 1);
423 seq_printf(m, "exp_name:\t%s\n", dmabuf->exp_name);
Charan Teja Kalla6348dd22020-06-19 17:27:19 +0530424 spin_lock(&dmabuf->name_lock);
Greg Hackmannbcc07112019-06-13 15:34:08 -0700425 if (dmabuf->name)
426 seq_printf(m, "name:\t%s\n", dmabuf->name);
Charan Teja Kalla6348dd22020-06-19 17:27:19 +0530427 spin_unlock(&dmabuf->name_lock);
Greg Hackmannbcc07112019-06-13 15:34:08 -0700428}
429
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530430static const struct file_operations dma_buf_fops = {
Charan Teja Reddy05cd8462021-01-05 20:06:39 +0530431 .release = dma_buf_file_release,
Daniel Vetter4c785132012-04-24 14:38:52 +0530432 .mmap = dma_buf_mmap_internal,
Christopher James Halse Rogers19e86972013-09-10 11:36:45 +0530433 .llseek = dma_buf_llseek,
Maarten Lankhorst9b495a52014-07-01 12:57:43 +0200434 .poll = dma_buf_poll,
Daniel Vetterc11e3912016-02-11 20:04:51 -0200435 .unlocked_ioctl = dma_buf_ioctl,
Arnd Bergmann1832f2d2018-09-11 21:59:08 +0200436 .compat_ioctl = compat_ptr_ioctl,
Greg Hackmannbcc07112019-06-13 15:34:08 -0700437 .show_fdinfo = dma_buf_show_fdinfo,
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530438};
439
440/*
441 * is_dma_buf_file - Check if struct file* is associated with dma_buf
442 */
443static inline int is_dma_buf_file(struct file *file)
444{
445 return file->f_op == &dma_buf_fops;
446}
447
Greg Hackmanned63bb12019-06-13 15:34:06 -0700448static struct file *dma_buf_getfile(struct dma_buf *dmabuf, int flags)
449{
450 struct file *file;
451 struct inode *inode = alloc_anon_inode(dma_buf_mnt->mnt_sb);
452
453 if (IS_ERR(inode))
454 return ERR_CAST(inode);
455
456 inode->i_size = dmabuf->size;
457 inode_set_bytes(inode, dmabuf->size);
458
459 file = alloc_file_pseudo(inode, dma_buf_mnt, "dmabuf",
460 flags, &dma_buf_fops);
461 if (IS_ERR(file))
462 goto err_alloc_file;
463 file->f_flags = flags & (O_ACCMODE | O_NONBLOCK);
464 file->private_data = dmabuf;
Greg Hackmannbb2bb902019-06-13 15:34:07 -0700465 file->f_path.dentry->d_fsdata = dmabuf;
Greg Hackmanned63bb12019-06-13 15:34:06 -0700466
467 return file;
468
469err_alloc_file:
470 iput(inode);
471 return file;
472}
473
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530474/**
Daniel Vetter2904a8c2016-12-09 19:53:07 +0100475 * DOC: dma buf device access
476 *
477 * For device DMA access to a shared DMA buffer the usual sequence of operations
478 * is fairly simple:
479 *
480 * 1. The exporter defines his exporter instance using
481 * DEFINE_DMA_BUF_EXPORT_INFO() and calls dma_buf_export() to wrap a private
482 * buffer object into a &dma_buf. It then exports that &dma_buf to userspace
483 * as a file descriptor by calling dma_buf_fd().
484 *
485 * 2. Userspace passes this file-descriptors to all drivers it wants this buffer
486 * to share with: First the filedescriptor is converted to a &dma_buf using
Liviu Dudauc1387822017-11-01 14:06:30 +0000487 * dma_buf_get(). Then the buffer is attached to the device using
Daniel Vetter2904a8c2016-12-09 19:53:07 +0100488 * dma_buf_attach().
489 *
490 * Up to this stage the exporter is still free to migrate or reallocate the
491 * backing storage.
492 *
Liviu Dudauc1387822017-11-01 14:06:30 +0000493 * 3. Once the buffer is attached to all devices userspace can initiate DMA
Daniel Vetter2904a8c2016-12-09 19:53:07 +0100494 * access to the shared buffer. In the kernel this is done by calling
495 * dma_buf_map_attachment() and dma_buf_unmap_attachment().
496 *
497 * 4. Once a driver is done with a shared buffer it needs to call
498 * dma_buf_detach() (after cleaning up any mappings) and then release the
Daniel Vetter85804b72020-12-11 16:58:41 +0100499 * reference acquired with dma_buf_get() by calling dma_buf_put().
Daniel Vetter2904a8c2016-12-09 19:53:07 +0100500 *
501 * For the detailed semantics exporters are expected to implement see
502 * &dma_buf_ops.
503 */
504
505/**
Sumit Semwald8fbe342015-01-23 12:53:43 +0530506 * dma_buf_export - Creates a new dma_buf, and associates an anon file
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530507 * with this buffer, so it can be exported.
508 * Also connect the allocator specific data and ops to the buffer.
Sumit Semwal78df9692013-03-22 18:22:16 +0530509 * Additionally, provide a name string for exporter; useful in debugging.
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530510 *
Sumit Semwald8fbe342015-01-23 12:53:43 +0530511 * @exp_info: [in] holds all the export related information provided
Daniel Vetterf641d3b2016-12-29 21:48:24 +0100512 * by the exporter. see &struct dma_buf_export_info
Sumit Semwald8fbe342015-01-23 12:53:43 +0530513 * for further details.
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530514 *
Daniel Vetter85804b72020-12-11 16:58:41 +0100515 * Returns, on success, a newly created struct dma_buf object, which wraps the
516 * supplied private data and operations for struct dma_buf_ops. On either
517 * missing ops, or error in allocating struct dma_buf, will return negative
518 * error.
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530519 *
Daniel Vetter2904a8c2016-12-09 19:53:07 +0100520 * For most cases the easiest way to create @exp_info is through the
521 * %DEFINE_DMA_BUF_EXPORT_INFO macro.
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530522 */
Sumit Semwald8fbe342015-01-23 12:53:43 +0530523struct dma_buf *dma_buf_export(const struct dma_buf_export_info *exp_info)
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530524{
525 struct dma_buf *dmabuf;
Christian König52791ee2019-08-11 10:06:32 +0200526 struct dma_resv *resv = exp_info->resv;
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530527 struct file *file;
Maarten Lankhorst3aac4502014-07-01 12:57:26 +0200528 size_t alloc_size = sizeof(struct dma_buf);
Chris Wilsona026df42016-07-18 12:16:22 +0100529 int ret;
Jagan Teki51366292015-05-21 01:09:31 +0530530
Sumit Semwald8fbe342015-01-23 12:53:43 +0530531 if (!exp_info->resv)
Christian König52791ee2019-08-11 10:06:32 +0200532 alloc_size += sizeof(struct dma_resv);
Maarten Lankhorst3aac4502014-07-01 12:57:26 +0200533 else
534 /* prevent &dma_buf[1] == dma_buf->resv */
535 alloc_size += 1;
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530536
Sumit Semwald8fbe342015-01-23 12:53:43 +0530537 if (WARN_ON(!exp_info->priv
538 || !exp_info->ops
539 || !exp_info->ops->map_dma_buf
540 || !exp_info->ops->unmap_dma_buf
Andrew F. Davise3a9d6c2019-03-29 11:52:01 -0500541 || !exp_info->ops->release)) {
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530542 return ERR_PTR(-EINVAL);
543 }
544
Christian König15fd5522018-07-03 16:42:26 +0200545 if (WARN_ON(exp_info->ops->cache_sgt_mapping &&
Christian Königbd2275e2020-02-18 16:57:24 +0100546 (exp_info->ops->pin || exp_info->ops->unpin)))
Christian König15fd5522018-07-03 16:42:26 +0200547 return ERR_PTR(-EINVAL);
548
Christian Königbd2275e2020-02-18 16:57:24 +0100549 if (WARN_ON(!exp_info->ops->pin != !exp_info->ops->unpin))
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530550 return ERR_PTR(-EINVAL);
551
Sumit Semwal9abdffe2015-05-05 14:56:15 +0530552 if (!try_module_get(exp_info->owner))
553 return ERR_PTR(-ENOENT);
554
Maarten Lankhorst3aac4502014-07-01 12:57:26 +0200555 dmabuf = kzalloc(alloc_size, GFP_KERNEL);
Sumit Semwal9abdffe2015-05-05 14:56:15 +0530556 if (!dmabuf) {
Chris Wilsona026df42016-07-18 12:16:22 +0100557 ret = -ENOMEM;
558 goto err_module;
Sumit Semwal9abdffe2015-05-05 14:56:15 +0530559 }
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530560
Sumit Semwald8fbe342015-01-23 12:53:43 +0530561 dmabuf->priv = exp_info->priv;
562 dmabuf->ops = exp_info->ops;
563 dmabuf->size = exp_info->size;
564 dmabuf->exp_name = exp_info->exp_name;
Sumit Semwal9abdffe2015-05-05 14:56:15 +0530565 dmabuf->owner = exp_info->owner;
Charan Teja Kalla6348dd22020-06-19 17:27:19 +0530566 spin_lock_init(&dmabuf->name_lock);
Maarten Lankhorst9b495a52014-07-01 12:57:43 +0200567 init_waitqueue_head(&dmabuf->poll);
568 dmabuf->cb_excl.poll = dmabuf->cb_shared.poll = &dmabuf->poll;
569 dmabuf->cb_excl.active = dmabuf->cb_shared.active = 0;
570
Maarten Lankhorst3aac4502014-07-01 12:57:26 +0200571 if (!resv) {
Christian König52791ee2019-08-11 10:06:32 +0200572 resv = (struct dma_resv *)&dmabuf[1];
573 dma_resv_init(resv);
Maarten Lankhorst3aac4502014-07-01 12:57:26 +0200574 }
575 dmabuf->resv = resv;
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530576
Greg Hackmanned63bb12019-06-13 15:34:06 -0700577 file = dma_buf_getfile(dmabuf, exp_info->flags);
Tuomas Tynkkynen9022e242013-08-27 16:30:38 +0300578 if (IS_ERR(file)) {
Chris Wilsona026df42016-07-18 12:16:22 +0100579 ret = PTR_ERR(file);
580 goto err_dmabuf;
Tuomas Tynkkynen9022e242013-08-27 16:30:38 +0300581 }
Christopher James Halse Rogers19e86972013-09-10 11:36:45 +0530582
583 file->f_mode |= FMODE_LSEEK;
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530584 dmabuf->file = file;
585
Hridya Valsarajubdb8d062021-06-03 14:47:51 -0700586 ret = dma_buf_stats_setup(dmabuf);
587 if (ret)
588 goto err_sysfs;
589
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530590 mutex_init(&dmabuf->lock);
591 INIT_LIST_HEAD(&dmabuf->attachments);
592
Sumit Semwalb89e35632013-04-04 11:44:37 +0530593 mutex_lock(&db_list.lock);
594 list_add(&dmabuf->list_node, &db_list.head);
595 mutex_unlock(&db_list.lock);
596
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530597 return dmabuf;
Chris Wilsona026df42016-07-18 12:16:22 +0100598
Hridya Valsarajubdb8d062021-06-03 14:47:51 -0700599err_sysfs:
600 /*
601 * Set file->f_path.dentry->d_fsdata to NULL so that when
602 * dma_buf_release() gets invoked by dentry_ops, it exits
603 * early before calling the release() dma_buf op.
604 */
605 file->f_path.dentry->d_fsdata = NULL;
606 fput(file);
Chris Wilsona026df42016-07-18 12:16:22 +0100607err_dmabuf:
608 kfree(dmabuf);
609err_module:
610 module_put(exp_info->owner);
611 return ERR_PTR(ret);
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530612}
Sumit Semwald8fbe342015-01-23 12:53:43 +0530613EXPORT_SYMBOL_GPL(dma_buf_export);
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530614
615/**
Daniel Vetter85804b72020-12-11 16:58:41 +0100616 * dma_buf_fd - returns a file descriptor for the given struct dma_buf
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530617 * @dmabuf: [in] pointer to dma_buf for which fd is required.
Dave Airlie55c1c4c2012-03-16 10:34:02 +0000618 * @flags: [in] flags to give to fd
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530619 *
620 * On success, returns an associated 'fd'. Else, returns error.
621 */
Dave Airlie55c1c4c2012-03-16 10:34:02 +0000622int dma_buf_fd(struct dma_buf *dmabuf, int flags)
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530623{
Borislav Petkovf5e097f2012-12-11 16:05:26 +0100624 int fd;
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530625
626 if (!dmabuf || !dmabuf->file)
627 return -EINVAL;
628
Borislav Petkovf5e097f2012-12-11 16:05:26 +0100629 fd = get_unused_fd_flags(flags);
630 if (fd < 0)
631 return fd;
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530632
633 fd_install(fd, dmabuf->file);
634
635 return fd;
636}
637EXPORT_SYMBOL_GPL(dma_buf_fd);
638
639/**
Daniel Vetter85804b72020-12-11 16:58:41 +0100640 * dma_buf_get - returns the struct dma_buf related to an fd
641 * @fd: [in] fd associated with the struct dma_buf to be returned
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530642 *
Daniel Vetter85804b72020-12-11 16:58:41 +0100643 * On success, returns the struct dma_buf associated with an fd; uses
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530644 * file's refcounting done by fget to increase refcount. returns ERR_PTR
645 * otherwise.
646 */
647struct dma_buf *dma_buf_get(int fd)
648{
649 struct file *file;
650
651 file = fget(fd);
652
653 if (!file)
654 return ERR_PTR(-EBADF);
655
656 if (!is_dma_buf_file(file)) {
657 fput(file);
658 return ERR_PTR(-EINVAL);
659 }
660
661 return file->private_data;
662}
663EXPORT_SYMBOL_GPL(dma_buf_get);
664
665/**
666 * dma_buf_put - decreases refcount of the buffer
667 * @dmabuf: [in] buffer to reduce refcount of
668 *
Daniel Vetter2904a8c2016-12-09 19:53:07 +0100669 * Uses file's refcounting done implicitly by fput().
670 *
671 * If, as a result of this call, the refcount becomes 0, the 'release' file
Daniel Vettere9b4d7b2016-12-29 21:48:25 +0100672 * operation related to this fd is called. It calls &dma_buf_ops.release vfunc
673 * in turn, and frees the memory allocated for dmabuf when exported.
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530674 */
675void dma_buf_put(struct dma_buf *dmabuf)
676{
677 if (WARN_ON(!dmabuf || !dmabuf->file))
678 return;
679
680 fput(dmabuf->file);
681}
682EXPORT_SYMBOL_GPL(dma_buf_put);
683
Daniel Vetter84335672021-01-15 17:47:39 +0100684static void mangle_sg_table(struct sg_table *sg_table)
685{
686#ifdef CONFIG_DMABUF_DEBUG
687 int i;
688 struct scatterlist *sg;
689
690 /* To catch abuse of the underlying struct page by importers mix
691 * up the bits, but take care to preserve the low SG_ bits to
692 * not corrupt the sgt. The mixing is undone in __unmap_dma_buf
693 * before passing the sgt back to the exporter. */
694 for_each_sgtable_sg(sg_table, sg, i)
695 sg->page_link ^= ~0xffUL;
696#endif
697
698}
699static struct sg_table * __map_dma_buf(struct dma_buf_attachment *attach,
700 enum dma_data_direction direction)
701{
702 struct sg_table *sg_table;
703
704 sg_table = attach->dmabuf->ops->map_dma_buf(attach, direction);
705
706 if (!IS_ERR_OR_NULL(sg_table))
707 mangle_sg_table(sg_table);
708
709 return sg_table;
710}
711
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530712/**
Daniel Vetter85804b72020-12-11 16:58:41 +0100713 * dma_buf_dynamic_attach - Add the device to dma_buf's attachments list
Christian König15fd5522018-07-03 16:42:26 +0200714 * @dmabuf: [in] buffer to attach device to.
715 * @dev: [in] device to be attached.
Randy Dunlap6f49c252020-04-07 21:20:34 -0700716 * @importer_ops: [in] importer operations for the attachment
717 * @importer_priv: [in] importer private pointer for the attachment
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530718 *
Daniel Vetter2904a8c2016-12-09 19:53:07 +0100719 * Returns struct dma_buf_attachment pointer for this attachment. Attachments
720 * must be cleaned up by calling dma_buf_detach().
721 *
Daniel Vetter85804b72020-12-11 16:58:41 +0100722 * Optionally this calls &dma_buf_ops.attach to allow device-specific attach
723 * functionality.
724 *
Daniel Vetter2904a8c2016-12-09 19:53:07 +0100725 * Returns:
726 *
727 * A pointer to newly created &dma_buf_attachment on success, or a negative
728 * error code wrapped into a pointer on failure.
729 *
730 * Note that this can fail if the backing storage of @dmabuf is in a place not
731 * accessible to @dev, and cannot be moved to a more suitable place. This is
732 * indicated with the error code -EBUSY.
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530733 */
Christian König15fd5522018-07-03 16:42:26 +0200734struct dma_buf_attachment *
735dma_buf_dynamic_attach(struct dma_buf *dmabuf, struct device *dev,
Christian Königbb42df42018-07-03 16:42:26 +0200736 const struct dma_buf_attach_ops *importer_ops,
737 void *importer_priv)
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530738{
739 struct dma_buf_attachment *attach;
740 int ret;
Hridya Valsarajubdb8d062021-06-03 14:47:51 -0700741 unsigned int attach_uid;
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530742
Laurent Pinchartd1aa06a2012-01-26 12:27:23 +0100743 if (WARN_ON(!dmabuf || !dev))
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530744 return ERR_PTR(-EINVAL);
745
Christian König4981cdb2020-02-19 13:32:43 +0100746 if (WARN_ON(importer_ops && !importer_ops->move_notify))
747 return ERR_PTR(-EINVAL);
748
Markus Elfringdb7942b2017-05-08 10:50:09 +0200749 attach = kzalloc(sizeof(*attach), GFP_KERNEL);
Markus Elfring34d84ec2017-05-08 10:54:17 +0200750 if (!attach)
Laurent Pincharta9fbc3b2012-01-26 12:27:24 +0100751 return ERR_PTR(-ENOMEM);
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530752
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530753 attach->dev = dev;
754 attach->dmabuf = dmabuf;
Christian König09606b52018-03-22 17:09:42 +0100755 if (importer_ops)
756 attach->peer2peer = importer_ops->allow_peer2peer;
Christian Königbb42df42018-07-03 16:42:26 +0200757 attach->importer_ops = importer_ops;
758 attach->importer_priv = importer_priv;
Laurent Pinchart2ed92012012-01-26 12:27:25 +0100759
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530760 if (dmabuf->ops->attach) {
Christian Königa19741e2018-05-28 11:47:52 +0200761 ret = dmabuf->ops->attach(dmabuf, attach);
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530762 if (ret)
763 goto err_attach;
764 }
Christian König15fd5522018-07-03 16:42:26 +0200765 dma_resv_lock(dmabuf->resv, NULL);
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530766 list_add(&attach->node, &dmabuf->attachments);
Hridya Valsarajubdb8d062021-06-03 14:47:51 -0700767 attach_uid = dma_buf_update_attach_uid(dmabuf);
Christian König15fd5522018-07-03 16:42:26 +0200768 dma_resv_unlock(dmabuf->resv);
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530769
Hridya Valsarajubdb8d062021-06-03 14:47:51 -0700770 ret = dma_buf_attach_stats_setup(attach, attach_uid);
771 if (ret)
772 goto err_sysfs;
773
Christian König15fd5522018-07-03 16:42:26 +0200774 /* When either the importer or the exporter can't handle dynamic
775 * mappings we cache the mapping here to avoid issues with the
776 * reservation object lock.
777 */
778 if (dma_buf_attachment_is_dynamic(attach) !=
779 dma_buf_is_dynamic(dmabuf)) {
780 struct sg_table *sgt;
781
Christian Königbb42df42018-07-03 16:42:26 +0200782 if (dma_buf_is_dynamic(attach->dmabuf)) {
Christian König15fd5522018-07-03 16:42:26 +0200783 dma_resv_lock(attach->dmabuf->resv, NULL);
Christian König7e008b02021-05-17 13:20:17 +0200784 ret = dmabuf->ops->pin(attach);
Christian Königbb42df42018-07-03 16:42:26 +0200785 if (ret)
786 goto err_unlock;
787 }
Christian König15fd5522018-07-03 16:42:26 +0200788
Daniel Vetter84335672021-01-15 17:47:39 +0100789 sgt = __map_dma_buf(attach, DMA_BIDIRECTIONAL);
Christian König15fd5522018-07-03 16:42:26 +0200790 if (!sgt)
791 sgt = ERR_PTR(-ENOMEM);
792 if (IS_ERR(sgt)) {
793 ret = PTR_ERR(sgt);
Christian Königbb42df42018-07-03 16:42:26 +0200794 goto err_unpin;
Christian König15fd5522018-07-03 16:42:26 +0200795 }
796 if (dma_buf_is_dynamic(attach->dmabuf))
797 dma_resv_unlock(attach->dmabuf->resv);
798 attach->sgt = sgt;
799 attach->dir = DMA_BIDIRECTIONAL;
Hridya Valsarajubdb8d062021-06-03 14:47:51 -0700800 dma_buf_update_attachment_map_count(attach, 1 /* delta */);
Christian König15fd5522018-07-03 16:42:26 +0200801 }
802
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530803 return attach;
804
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530805err_attach:
806 kfree(attach);
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530807 return ERR_PTR(ret);
Christian König15fd5522018-07-03 16:42:26 +0200808
Christian Königbb42df42018-07-03 16:42:26 +0200809err_unpin:
810 if (dma_buf_is_dynamic(attach->dmabuf))
Christian König7e008b02021-05-17 13:20:17 +0200811 dmabuf->ops->unpin(attach);
Christian Königbb42df42018-07-03 16:42:26 +0200812
Christian König15fd5522018-07-03 16:42:26 +0200813err_unlock:
814 if (dma_buf_is_dynamic(attach->dmabuf))
815 dma_resv_unlock(attach->dmabuf->resv);
816
Hridya Valsarajubdb8d062021-06-03 14:47:51 -0700817err_sysfs:
Christian König15fd5522018-07-03 16:42:26 +0200818 dma_buf_detach(dmabuf, attach);
819 return ERR_PTR(ret);
820}
821EXPORT_SYMBOL_GPL(dma_buf_dynamic_attach);
822
823/**
824 * dma_buf_attach - Wrapper for dma_buf_dynamic_attach
825 * @dmabuf: [in] buffer to attach device to.
826 * @dev: [in] device to be attached.
827 *
828 * Wrapper to call dma_buf_dynamic_attach() for drivers which still use a static
829 * mapping.
830 */
831struct dma_buf_attachment *dma_buf_attach(struct dma_buf *dmabuf,
832 struct device *dev)
833{
Christian Königbb42df42018-07-03 16:42:26 +0200834 return dma_buf_dynamic_attach(dmabuf, dev, NULL, NULL);
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530835}
836EXPORT_SYMBOL_GPL(dma_buf_attach);
837
Daniel Vetter84335672021-01-15 17:47:39 +0100838static void __unmap_dma_buf(struct dma_buf_attachment *attach,
839 struct sg_table *sg_table,
840 enum dma_data_direction direction)
841{
842 /* uses XOR, hence this unmangles */
843 mangle_sg_table(sg_table);
844
845 attach->dmabuf->ops->unmap_dma_buf(attach, sg_table, direction);
846}
847
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530848/**
Daniel Vetter85804b72020-12-11 16:58:41 +0100849 * dma_buf_detach - Remove the given attachment from dmabuf's attachments list
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530850 * @dmabuf: [in] buffer to detach from.
851 * @attach: [in] attachment to be detached; is free'd after this call.
852 *
Daniel Vetter2904a8c2016-12-09 19:53:07 +0100853 * Clean up a device attachment obtained by calling dma_buf_attach().
Daniel Vetter85804b72020-12-11 16:58:41 +0100854 *
855 * Optionally this calls &dma_buf_ops.detach for device-specific detach.
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530856 */
857void dma_buf_detach(struct dma_buf *dmabuf, struct dma_buf_attachment *attach)
858{
Laurent Pinchartd1aa06a2012-01-26 12:27:23 +0100859 if (WARN_ON(!dmabuf || !attach))
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530860 return;
861
Christian König15fd5522018-07-03 16:42:26 +0200862 if (attach->sgt) {
863 if (dma_buf_is_dynamic(attach->dmabuf))
864 dma_resv_lock(attach->dmabuf->resv, NULL);
865
Daniel Vetter84335672021-01-15 17:47:39 +0100866 __unmap_dma_buf(attach, attach->sgt, attach->dir);
Hridya Valsarajubdb8d062021-06-03 14:47:51 -0700867 dma_buf_update_attachment_map_count(attach, -1 /* delta */);
Christian Königf13e1432018-07-03 16:42:26 +0200868
Christian Königbb42df42018-07-03 16:42:26 +0200869 if (dma_buf_is_dynamic(attach->dmabuf)) {
Christian König7e008b02021-05-17 13:20:17 +0200870 dmabuf->ops->unpin(attach);
Christian König15fd5522018-07-03 16:42:26 +0200871 dma_resv_unlock(attach->dmabuf->resv);
Christian Königbb42df42018-07-03 16:42:26 +0200872 }
Christian König15fd5522018-07-03 16:42:26 +0200873 }
874
Christian König15fd5522018-07-03 16:42:26 +0200875 dma_resv_lock(dmabuf->resv, NULL);
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530876 list_del(&attach->node);
Christian König15fd5522018-07-03 16:42:26 +0200877 dma_resv_unlock(dmabuf->resv);
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530878 if (dmabuf->ops->detach)
879 dmabuf->ops->detach(dmabuf, attach);
880
Hridya Valsarajubdb8d062021-06-03 14:47:51 -0700881 dma_buf_attach_stats_teardown(attach);
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530882 kfree(attach);
883}
884EXPORT_SYMBOL_GPL(dma_buf_detach);
885
886/**
Christian Königbb42df42018-07-03 16:42:26 +0200887 * dma_buf_pin - Lock down the DMA-buf
Christian Königbb42df42018-07-03 16:42:26 +0200888 * @attach: [in] attachment which should be pinned
889 *
Daniel Vetterc5457812020-12-11 16:58:43 +0100890 * Only dynamic importers (who set up @attach with dma_buf_dynamic_attach()) may
891 * call this, and only for limited use cases like scanout and not for temporary
892 * pin operations. It is not permitted to allow userspace to pin arbitrary
893 * amounts of buffers through this interface.
894 *
895 * Buffers must be unpinned by calling dma_buf_unpin().
896 *
Christian Königbb42df42018-07-03 16:42:26 +0200897 * Returns:
898 * 0 on success, negative error code on failure.
899 */
900int dma_buf_pin(struct dma_buf_attachment *attach)
901{
902 struct dma_buf *dmabuf = attach->dmabuf;
903 int ret = 0;
904
Daniel Vetterc5457812020-12-11 16:58:43 +0100905 WARN_ON(!dma_buf_attachment_is_dynamic(attach));
906
Christian Königbb42df42018-07-03 16:42:26 +0200907 dma_resv_assert_held(dmabuf->resv);
908
909 if (dmabuf->ops->pin)
910 ret = dmabuf->ops->pin(attach);
911
912 return ret;
913}
914EXPORT_SYMBOL_GPL(dma_buf_pin);
915
916/**
Daniel Vetterc5457812020-12-11 16:58:43 +0100917 * dma_buf_unpin - Unpin a DMA-buf
Christian Königbb42df42018-07-03 16:42:26 +0200918 * @attach: [in] attachment which should be unpinned
Daniel Vetterc5457812020-12-11 16:58:43 +0100919 *
920 * This unpins a buffer pinned by dma_buf_pin() and allows the exporter to move
921 * any mapping of @attach again and inform the importer through
922 * &dma_buf_attach_ops.move_notify.
Christian Königbb42df42018-07-03 16:42:26 +0200923 */
924void dma_buf_unpin(struct dma_buf_attachment *attach)
925{
926 struct dma_buf *dmabuf = attach->dmabuf;
927
Daniel Vetterc5457812020-12-11 16:58:43 +0100928 WARN_ON(!dma_buf_attachment_is_dynamic(attach));
929
Christian Königbb42df42018-07-03 16:42:26 +0200930 dma_resv_assert_held(dmabuf->resv);
931
932 if (dmabuf->ops->unpin)
933 dmabuf->ops->unpin(attach);
934}
935EXPORT_SYMBOL_GPL(dma_buf_unpin);
936
937/**
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530938 * dma_buf_map_attachment - Returns the scatterlist table of the attachment;
939 * mapped into _device_ address space. Is a wrapper for map_dma_buf() of the
940 * dma_buf_ops.
941 * @attach: [in] attachment whose scatterlist is to be returned
942 * @direction: [in] direction of DMA transfer
943 *
Colin Crossfee0c542013-12-20 16:43:50 -0800944 * Returns sg_table containing the scatterlist to be returned; returns ERR_PTR
Daniel Vetter2904a8c2016-12-09 19:53:07 +0100945 * on error. May return -EINTR if it is interrupted by a signal.
946 *
Jianxin Xiongac80cd12020-10-14 09:16:01 -0700947 * On success, the DMA addresses and lengths in the returned scatterlist are
948 * PAGE_SIZE aligned.
949 *
Liviu Dudauc1387822017-11-01 14:06:30 +0000950 * A mapping must be unmapped by using dma_buf_unmap_attachment(). Note that
Daniel Vetter2904a8c2016-12-09 19:53:07 +0100951 * the underlying backing storage is pinned for as long as a mapping exists,
952 * therefore users/importers should not hold onto a mapping for undue amounts of
953 * time.
Daniel Vetter89bcadc2021-06-21 17:17:58 +0200954 *
955 * Important: Dynamic importers must wait for the exclusive fence of the struct
956 * dma_resv attached to the DMA-BUF first.
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530957 */
958struct sg_table *dma_buf_map_attachment(struct dma_buf_attachment *attach,
959 enum dma_data_direction direction)
960{
Colin Ian King531beb02017-09-15 00:05:16 +0100961 struct sg_table *sg_table;
Christian Königbb42df42018-07-03 16:42:26 +0200962 int r;
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530963
964 might_sleep();
965
Laurent Pinchartd1aa06a2012-01-26 12:27:23 +0100966 if (WARN_ON(!attach || !attach->dmabuf))
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530967 return ERR_PTR(-EINVAL);
968
Christian König15fd5522018-07-03 16:42:26 +0200969 if (dma_buf_attachment_is_dynamic(attach))
970 dma_resv_assert_held(attach->dmabuf->resv);
971
Christian Königf13e1432018-07-03 16:42:26 +0200972 if (attach->sgt) {
973 /*
974 * Two mappings with different directions for the same
975 * attachment are not allowed.
976 */
977 if (attach->dir != direction &&
978 attach->dir != DMA_BIDIRECTIONAL)
979 return ERR_PTR(-EBUSY);
980
981 return attach->sgt;
982 }
983
Christian Königbb42df42018-07-03 16:42:26 +0200984 if (dma_buf_is_dynamic(attach->dmabuf)) {
Christian König15fd5522018-07-03 16:42:26 +0200985 dma_resv_assert_held(attach->dmabuf->resv);
Christian König4981cdb2020-02-19 13:32:43 +0100986 if (!IS_ENABLED(CONFIG_DMABUF_MOVE_NOTIFY)) {
Christian König7e008b02021-05-17 13:20:17 +0200987 r = attach->dmabuf->ops->pin(attach);
Christian Königbb42df42018-07-03 16:42:26 +0200988 if (r)
989 return ERR_PTR(r);
990 }
991 }
Christian König15fd5522018-07-03 16:42:26 +0200992
Daniel Vetter84335672021-01-15 17:47:39 +0100993 sg_table = __map_dma_buf(attach, direction);
Colin Crossfee0c542013-12-20 16:43:50 -0800994 if (!sg_table)
995 sg_table = ERR_PTR(-ENOMEM);
Sumit Semwald15bd7e2011-12-26 14:53:15 +0530996
Christian Königbb42df42018-07-03 16:42:26 +0200997 if (IS_ERR(sg_table) && dma_buf_is_dynamic(attach->dmabuf) &&
Christian König4981cdb2020-02-19 13:32:43 +0100998 !IS_ENABLED(CONFIG_DMABUF_MOVE_NOTIFY))
Christian König7e008b02021-05-17 13:20:17 +0200999 attach->dmabuf->ops->unpin(attach);
Christian Königbb42df42018-07-03 16:42:26 +02001000
Christian Königf13e1432018-07-03 16:42:26 +02001001 if (!IS_ERR(sg_table) && attach->dmabuf->ops->cache_sgt_mapping) {
1002 attach->sgt = sg_table;
1003 attach->dir = direction;
1004 }
1005
Jianxin Xiongac80cd12020-10-14 09:16:01 -07001006#ifdef CONFIG_DMA_API_DEBUG
Jianxin Xiong00efd652020-11-02 19:51:58 -08001007 if (!IS_ERR(sg_table)) {
Jianxin Xiongac80cd12020-10-14 09:16:01 -07001008 struct scatterlist *sg;
1009 u64 addr;
1010 int len;
1011 int i;
1012
1013 for_each_sgtable_dma_sg(sg_table, sg, i) {
1014 addr = sg_dma_address(sg);
1015 len = sg_dma_len(sg);
1016 if (!PAGE_ALIGNED(addr) || !PAGE_ALIGNED(len)) {
1017 pr_debug("%s: addr %llx or len %x is not page aligned!\n",
1018 __func__, addr, len);
1019 }
1020 }
1021 }
1022#endif /* CONFIG_DMA_API_DEBUG */
1023
Hridya Valsarajubdb8d062021-06-03 14:47:51 -07001024 if (!IS_ERR(sg_table))
1025 dma_buf_update_attachment_map_count(attach, 1 /* delta */);
1026
Sumit Semwald15bd7e2011-12-26 14:53:15 +05301027 return sg_table;
1028}
1029EXPORT_SYMBOL_GPL(dma_buf_map_attachment);
1030
1031/**
1032 * dma_buf_unmap_attachment - unmaps and decreases usecount of the buffer;might
1033 * deallocate the scatterlist associated. Is a wrapper for unmap_dma_buf() of
1034 * dma_buf_ops.
1035 * @attach: [in] attachment to unmap buffer from
1036 * @sg_table: [in] scatterlist info of the buffer to unmap
Sumit Semwal33ea2dc2012-01-27 15:09:27 +05301037 * @direction: [in] direction of DMA transfer
Sumit Semwald15bd7e2011-12-26 14:53:15 +05301038 *
Daniel Vetter2904a8c2016-12-09 19:53:07 +01001039 * This unmaps a DMA mapping for @attached obtained by dma_buf_map_attachment().
Sumit Semwald15bd7e2011-12-26 14:53:15 +05301040 */
1041void dma_buf_unmap_attachment(struct dma_buf_attachment *attach,
Sumit Semwal33ea2dc2012-01-27 15:09:27 +05301042 struct sg_table *sg_table,
1043 enum dma_data_direction direction)
Sumit Semwald15bd7e2011-12-26 14:53:15 +05301044{
Rob Clarkb6fa0cd2012-09-28 09:29:43 +02001045 might_sleep();
1046
Laurent Pinchartd1aa06a2012-01-26 12:27:23 +01001047 if (WARN_ON(!attach || !attach->dmabuf || !sg_table))
Sumit Semwald15bd7e2011-12-26 14:53:15 +05301048 return;
1049
Christian König15fd5522018-07-03 16:42:26 +02001050 if (dma_buf_attachment_is_dynamic(attach))
1051 dma_resv_assert_held(attach->dmabuf->resv);
1052
Christian Königf13e1432018-07-03 16:42:26 +02001053 if (attach->sgt == sg_table)
1054 return;
1055
Christian König15fd5522018-07-03 16:42:26 +02001056 if (dma_buf_is_dynamic(attach->dmabuf))
1057 dma_resv_assert_held(attach->dmabuf->resv);
1058
Daniel Vetter84335672021-01-15 17:47:39 +01001059 __unmap_dma_buf(attach, sg_table, direction);
Christian Königbb42df42018-07-03 16:42:26 +02001060
1061 if (dma_buf_is_dynamic(attach->dmabuf) &&
Christian König4981cdb2020-02-19 13:32:43 +01001062 !IS_ENABLED(CONFIG_DMABUF_MOVE_NOTIFY))
Christian Königbb42df42018-07-03 16:42:26 +02001063 dma_buf_unpin(attach);
Hridya Valsarajubdb8d062021-06-03 14:47:51 -07001064
1065 dma_buf_update_attachment_map_count(attach, -1 /* delta */);
Sumit Semwald15bd7e2011-12-26 14:53:15 +05301066}
1067EXPORT_SYMBOL_GPL(dma_buf_unmap_attachment);
Daniel Vetterfc130202012-03-20 00:02:37 +01001068
Daniel Vetter0959a162016-12-09 19:53:08 +01001069/**
Christian Königbb42df42018-07-03 16:42:26 +02001070 * dma_buf_move_notify - notify attachments that DMA-buf is moving
1071 *
1072 * @dmabuf: [in] buffer which is moving
1073 *
1074 * Informs all attachmenst that they need to destroy and recreated all their
1075 * mappings.
1076 */
1077void dma_buf_move_notify(struct dma_buf *dmabuf)
1078{
1079 struct dma_buf_attachment *attach;
1080
1081 dma_resv_assert_held(dmabuf->resv);
1082
1083 list_for_each_entry(attach, &dmabuf->attachments, node)
Christian König4981cdb2020-02-19 13:32:43 +01001084 if (attach->importer_ops)
Christian Königbb42df42018-07-03 16:42:26 +02001085 attach->importer_ops->move_notify(attach);
1086}
1087EXPORT_SYMBOL_GPL(dma_buf_move_notify);
1088
1089/**
Daniel Vetter0959a162016-12-09 19:53:08 +01001090 * DOC: cpu access
1091 *
1092 * There are mutliple reasons for supporting CPU access to a dma buffer object:
1093 *
1094 * - Fallback operations in the kernel, for example when a device is connected
1095 * over USB and the kernel needs to shuffle the data around first before
1096 * sending it away. Cache coherency is handled by braketing any transactions
1097 * with calls to dma_buf_begin_cpu_access() and dma_buf_end_cpu_access()
1098 * access.
1099 *
Daniel Vetter7f0de8d2019-11-18 11:35:30 +01001100 * Since for most kernel internal dma-buf accesses need the entire buffer, a
1101 * vmap interface is introduced. Note that on very old 32-bit architectures
1102 * vmalloc space might be limited and result in vmap calls failing.
Daniel Vetter0959a162016-12-09 19:53:08 +01001103 *
1104 * Interfaces::
Daniel Vetterde9114e2020-12-11 16:58:40 +01001105 *
Daniel Vetter0959a162016-12-09 19:53:08 +01001106 * void \*dma_buf_vmap(struct dma_buf \*dmabuf)
1107 * void dma_buf_vunmap(struct dma_buf \*dmabuf, void \*vaddr)
1108 *
1109 * The vmap call can fail if there is no vmap support in the exporter, or if
Daniel Vetterde9114e2020-12-11 16:58:40 +01001110 * it runs out of vmalloc space. Note that the dma-buf layer keeps a reference
1111 * count for all vmap access and calls down into the exporter's vmap function
1112 * only when no vmapping exists, and only unmaps it once. Protection against
1113 * concurrent vmap/vunmap calls is provided by taking the &dma_buf.lock mutex.
Daniel Vetter0959a162016-12-09 19:53:08 +01001114 *
1115 * - For full compatibility on the importer side with existing userspace
1116 * interfaces, which might already support mmap'ing buffers. This is needed in
1117 * many processing pipelines (e.g. feeding a software rendered image into a
1118 * hardware pipeline, thumbnail creation, snapshots, ...). Also, Android's ION
1119 * framework already supported this and for DMA buffer file descriptors to
1120 * replace ION buffers mmap support was needed.
1121 *
1122 * There is no special interfaces, userspace simply calls mmap on the dma-buf
1123 * fd. But like for CPU access there's a need to braket the actual access,
1124 * which is handled by the ioctl (DMA_BUF_IOCTL_SYNC). Note that
1125 * DMA_BUF_IOCTL_SYNC can fail with -EAGAIN or -EINTR, in which case it must
1126 * be restarted.
1127 *
1128 * Some systems might need some sort of cache coherency management e.g. when
1129 * CPU and GPU domains are being accessed through dma-buf at the same time.
1130 * To circumvent this problem there are begin/end coherency markers, that
1131 * forward directly to existing dma-buf device drivers vfunc hooks. Userspace
1132 * can make use of those markers through the DMA_BUF_IOCTL_SYNC ioctl. The
1133 * sequence would be used like following:
1134 *
1135 * - mmap dma-buf fd
1136 * - for each drawing/upload cycle in CPU 1. SYNC_START ioctl, 2. read/write
1137 * to mmap area 3. SYNC_END ioctl. This can be repeated as often as you
1138 * want (with the new data being consumed by say the GPU or the scanout
1139 * device)
1140 * - munmap once you don't need the buffer any more
1141 *
1142 * For correctness and optimal performance, it is always required to use
1143 * SYNC_START and SYNC_END before and after, respectively, when accessing the
1144 * mapped address. Userspace cannot rely on coherent access, even when there
1145 * are systems where it just works without calling these ioctls.
1146 *
1147 * - And as a CPU fallback in userspace processing pipelines.
1148 *
1149 * Similar to the motivation for kernel cpu access it is again important that
1150 * the userspace code of a given importing subsystem can use the same
1151 * interfaces with a imported dma-buf buffer object as with a native buffer
1152 * object. This is especially important for drm where the userspace part of
1153 * contemporary OpenGL, X, and other drivers is huge, and reworking them to
1154 * use a different way to mmap a buffer rather invasive.
1155 *
1156 * The assumption in the current dma-buf interfaces is that redirecting the
1157 * initial mmap is all that's needed. A survey of some of the existing
1158 * subsystems shows that no driver seems to do any nefarious thing like
1159 * syncing up with outstanding asynchronous processing on the device or
1160 * allocating special resources at fault time. So hopefully this is good
1161 * enough, since adding interfaces to intercept pagefaults and allow pte
1162 * shootdowns would increase the complexity quite a bit.
1163 *
1164 * Interface::
Daniel Vetter85804b72020-12-11 16:58:41 +01001165 *
Daniel Vetter0959a162016-12-09 19:53:08 +01001166 * int dma_buf_mmap(struct dma_buf \*, struct vm_area_struct \*,
1167 * unsigned long);
1168 *
1169 * If the importing subsystem simply provides a special-purpose mmap call to
Daniel Vetter85804b72020-12-11 16:58:41 +01001170 * set up a mapping in userspace, calling do_mmap with &dma_buf.file will
Daniel Vetter0959a162016-12-09 19:53:08 +01001171 * equally achieve that for a dma-buf object.
1172 */
1173
Chris Wilsonae4e46b2016-08-15 16:42:18 +01001174static int __dma_buf_begin_cpu_access(struct dma_buf *dmabuf,
1175 enum dma_data_direction direction)
1176{
1177 bool write = (direction == DMA_BIDIRECTIONAL ||
1178 direction == DMA_TO_DEVICE);
Christian König52791ee2019-08-11 10:06:32 +02001179 struct dma_resv *resv = dmabuf->resv;
Chris Wilsonae4e46b2016-08-15 16:42:18 +01001180 long ret;
1181
1182 /* Wait on any implicit rendering fences */
Christian Königd3fae3b2021-06-02 13:01:15 +02001183 ret = dma_resv_wait_timeout(resv, write, true, MAX_SCHEDULE_TIMEOUT);
Chris Wilsonae4e46b2016-08-15 16:42:18 +01001184 if (ret < 0)
1185 return ret;
1186
1187 return 0;
1188}
Daniel Vetterfc130202012-03-20 00:02:37 +01001189
1190/**
1191 * dma_buf_begin_cpu_access - Must be called before accessing a dma_buf from the
1192 * cpu in the kernel context. Calls begin_cpu_access to allow exporter-specific
1193 * preparations. Coherency is only guaranteed in the specified range for the
1194 * specified access direction.
Randy Dunlapefb4df822012-04-17 17:03:30 -07001195 * @dmabuf: [in] buffer to prepare cpu access for.
Daniel Vetterfc130202012-03-20 00:02:37 +01001196 * @direction: [in] length of range for cpu access.
1197 *
Daniel Vetter0959a162016-12-09 19:53:08 +01001198 * After the cpu access is complete the caller should call
1199 * dma_buf_end_cpu_access(). Only when cpu access is braketed by both calls is
1200 * it guaranteed to be coherent with other DMA access.
1201 *
Daniel Vetterde9114e2020-12-11 16:58:40 +01001202 * This function will also wait for any DMA transactions tracked through
1203 * implicit synchronization in &dma_buf.resv. For DMA transactions with explicit
1204 * synchronization this function will only ensure cache coherency, callers must
1205 * ensure synchronization with such DMA transactions on their own.
1206 *
Daniel Vetterfc130202012-03-20 00:02:37 +01001207 * Can return negative error values, returns 0 on success.
1208 */
Tiago Vignatti831e9da2015-12-22 19:36:45 -02001209int dma_buf_begin_cpu_access(struct dma_buf *dmabuf,
Daniel Vetterfc130202012-03-20 00:02:37 +01001210 enum dma_data_direction direction)
1211{
1212 int ret = 0;
1213
1214 if (WARN_ON(!dmabuf))
1215 return -EINVAL;
1216
Daniel Vetter8ccf0a22020-12-14 18:16:22 +01001217 might_lock(&dmabuf->resv->lock.base);
1218
Daniel Vetterfc130202012-03-20 00:02:37 +01001219 if (dmabuf->ops->begin_cpu_access)
Tiago Vignatti831e9da2015-12-22 19:36:45 -02001220 ret = dmabuf->ops->begin_cpu_access(dmabuf, direction);
Daniel Vetterfc130202012-03-20 00:02:37 +01001221
Chris Wilsonae4e46b2016-08-15 16:42:18 +01001222 /* Ensure that all fences are waited upon - but we first allow
1223 * the native handler the chance to do so more efficiently if it
1224 * chooses. A double invocation here will be reasonably cheap no-op.
1225 */
1226 if (ret == 0)
1227 ret = __dma_buf_begin_cpu_access(dmabuf, direction);
1228
Daniel Vetterfc130202012-03-20 00:02:37 +01001229 return ret;
1230}
1231EXPORT_SYMBOL_GPL(dma_buf_begin_cpu_access);
1232
1233/**
1234 * dma_buf_end_cpu_access - Must be called after accessing a dma_buf from the
1235 * cpu in the kernel context. Calls end_cpu_access to allow exporter-specific
1236 * actions. Coherency is only guaranteed in the specified range for the
1237 * specified access direction.
Randy Dunlapefb4df822012-04-17 17:03:30 -07001238 * @dmabuf: [in] buffer to complete cpu access for.
Daniel Vetterfc130202012-03-20 00:02:37 +01001239 * @direction: [in] length of range for cpu access.
1240 *
Daniel Vetter0959a162016-12-09 19:53:08 +01001241 * This terminates CPU access started with dma_buf_begin_cpu_access().
1242 *
Daniel Vetter87e332d2016-03-21 08:24:22 +01001243 * Can return negative error values, returns 0 on success.
Daniel Vetterfc130202012-03-20 00:02:37 +01001244 */
Chris Wilson18b862d2016-03-18 20:02:39 +00001245int dma_buf_end_cpu_access(struct dma_buf *dmabuf,
1246 enum dma_data_direction direction)
Daniel Vetterfc130202012-03-20 00:02:37 +01001247{
Chris Wilson18b862d2016-03-18 20:02:39 +00001248 int ret = 0;
1249
Daniel Vetterfc130202012-03-20 00:02:37 +01001250 WARN_ON(!dmabuf);
1251
Daniel Vetter8ccf0a22020-12-14 18:16:22 +01001252 might_lock(&dmabuf->resv->lock.base);
1253
Daniel Vetterfc130202012-03-20 00:02:37 +01001254 if (dmabuf->ops->end_cpu_access)
Chris Wilson18b862d2016-03-18 20:02:39 +00001255 ret = dmabuf->ops->end_cpu_access(dmabuf, direction);
1256
1257 return ret;
Daniel Vetterfc130202012-03-20 00:02:37 +01001258}
1259EXPORT_SYMBOL_GPL(dma_buf_end_cpu_access);
1260
Daniel Vetter4c785132012-04-24 14:38:52 +05301261
1262/**
1263 * dma_buf_mmap - Setup up a userspace mmap with the given vma
Sumit Semwal12c47272012-05-23 15:27:40 +05301264 * @dmabuf: [in] buffer that should back the vma
Daniel Vetter4c785132012-04-24 14:38:52 +05301265 * @vma: [in] vma for the mmap
1266 * @pgoff: [in] offset in pages where this mmap should start within the
Jagan Teki51366292015-05-21 01:09:31 +05301267 * dma-buf buffer.
Daniel Vetter4c785132012-04-24 14:38:52 +05301268 *
1269 * This function adjusts the passed in vma so that it points at the file of the
Javier Martinez Canillasecf1dba2014-04-10 01:30:05 +02001270 * dma_buf operation. It also adjusts the starting pgoff and does bounds
Daniel Vetter4c785132012-04-24 14:38:52 +05301271 * checking on the size of the vma. Then it calls the exporters mmap function to
1272 * set up the mapping.
1273 *
1274 * Can return negative error values, returns 0 on success.
1275 */
1276int dma_buf_mmap(struct dma_buf *dmabuf, struct vm_area_struct *vma,
1277 unsigned long pgoff)
1278{
1279 if (WARN_ON(!dmabuf || !vma))
1280 return -EINVAL;
1281
Andrew F. Davise3a9d6c2019-03-29 11:52:01 -05001282 /* check if buffer supports mmap */
1283 if (!dmabuf->ops->mmap)
1284 return -EINVAL;
1285
Daniel Vetter4c785132012-04-24 14:38:52 +05301286 /* check for offset overflow */
Muhammad Falak R Wanib02da6f2016-05-23 17:08:42 +05301287 if (pgoff + vma_pages(vma) < pgoff)
Daniel Vetter4c785132012-04-24 14:38:52 +05301288 return -EOVERFLOW;
1289
1290 /* check for overflowing the buffer's size */
Muhammad Falak R Wanib02da6f2016-05-23 17:08:42 +05301291 if (pgoff + vma_pages(vma) >
Daniel Vetter4c785132012-04-24 14:38:52 +05301292 dmabuf->size >> PAGE_SHIFT)
1293 return -EINVAL;
1294
1295 /* readjust the vma */
Christian König295992f2020-09-14 15:09:33 +02001296 vma_set_file(vma, dmabuf->file);
Daniel Vetter4c785132012-04-24 14:38:52 +05301297 vma->vm_pgoff = pgoff;
1298
Christian König1527f922020-10-09 15:08:55 +02001299 return dmabuf->ops->mmap(dmabuf, vma);
Daniel Vetter4c785132012-04-24 14:38:52 +05301300}
1301EXPORT_SYMBOL_GPL(dma_buf_mmap);
Dave Airlie98f86c92012-05-20 12:33:56 +05301302
1303/**
Sumit Semwal12c47272012-05-23 15:27:40 +05301304 * dma_buf_vmap - Create virtual mapping for the buffer object into kernel
1305 * address space. Same restrictions as for vmap and friends apply.
1306 * @dmabuf: [in] buffer to vmap
Thomas Zimmermann6619ccf2020-09-25 13:55:59 +02001307 * @map: [out] returns the vmap pointer
Dave Airlie98f86c92012-05-20 12:33:56 +05301308 *
1309 * This call may fail due to lack of virtual mapping address space.
1310 * These calls are optional in drivers. The intended use for them
1311 * is for mapping objects linear in kernel space for high use objects.
Daniel Vetterde9114e2020-12-11 16:58:40 +01001312 *
1313 * To ensure coherency users must call dma_buf_begin_cpu_access() and
1314 * dma_buf_end_cpu_access() around any cpu access performed through this
1315 * mapping.
Colin Crossfee0c542013-12-20 16:43:50 -08001316 *
Thomas Zimmermann6619ccf2020-09-25 13:55:59 +02001317 * Returns 0 on success, or a negative errno code otherwise.
Dave Airlie98f86c92012-05-20 12:33:56 +05301318 */
Thomas Zimmermann6619ccf2020-09-25 13:55:59 +02001319int dma_buf_vmap(struct dma_buf *dmabuf, struct dma_buf_map *map)
Dave Airlie98f86c92012-05-20 12:33:56 +05301320{
Thomas Zimmermann6619ccf2020-09-25 13:55:59 +02001321 struct dma_buf_map ptr;
1322 int ret = 0;
1323
1324 dma_buf_map_clear(map);
Daniel Vetterf00b4da2012-12-20 14:14:23 +01001325
Dave Airlie98f86c92012-05-20 12:33:56 +05301326 if (WARN_ON(!dmabuf))
Thomas Zimmermann6619ccf2020-09-25 13:55:59 +02001327 return -EINVAL;
Dave Airlie98f86c92012-05-20 12:33:56 +05301328
Daniel Vetterf00b4da2012-12-20 14:14:23 +01001329 if (!dmabuf->ops->vmap)
Thomas Zimmermann6619ccf2020-09-25 13:55:59 +02001330 return -EINVAL;
Daniel Vetterf00b4da2012-12-20 14:14:23 +01001331
1332 mutex_lock(&dmabuf->lock);
1333 if (dmabuf->vmapping_counter) {
1334 dmabuf->vmapping_counter++;
Thomas Zimmermann01fd30d2020-09-25 13:55:58 +02001335 BUG_ON(dma_buf_map_is_null(&dmabuf->vmap_ptr));
Thomas Zimmermann6619ccf2020-09-25 13:55:59 +02001336 *map = dmabuf->vmap_ptr;
Daniel Vetterf00b4da2012-12-20 14:14:23 +01001337 goto out_unlock;
1338 }
1339
Thomas Zimmermann01fd30d2020-09-25 13:55:58 +02001340 BUG_ON(dma_buf_map_is_set(&dmabuf->vmap_ptr));
Daniel Vetterf00b4da2012-12-20 14:14:23 +01001341
Thomas Zimmermann6619ccf2020-09-25 13:55:59 +02001342 ret = dmabuf->ops->vmap(dmabuf, &ptr);
1343 if (WARN_ON_ONCE(ret))
Daniel Vetterf00b4da2012-12-20 14:14:23 +01001344 goto out_unlock;
1345
Thomas Zimmermann6619ccf2020-09-25 13:55:59 +02001346 dmabuf->vmap_ptr = ptr;
Daniel Vetterf00b4da2012-12-20 14:14:23 +01001347 dmabuf->vmapping_counter = 1;
1348
Thomas Zimmermann6619ccf2020-09-25 13:55:59 +02001349 *map = dmabuf->vmap_ptr;
1350
Daniel Vetterf00b4da2012-12-20 14:14:23 +01001351out_unlock:
1352 mutex_unlock(&dmabuf->lock);
Thomas Zimmermann6619ccf2020-09-25 13:55:59 +02001353 return ret;
Dave Airlie98f86c92012-05-20 12:33:56 +05301354}
1355EXPORT_SYMBOL_GPL(dma_buf_vmap);
1356
1357/**
1358 * dma_buf_vunmap - Unmap a vmap obtained by dma_buf_vmap.
Sumit Semwal12c47272012-05-23 15:27:40 +05301359 * @dmabuf: [in] buffer to vunmap
Thomas Zimmermann20e76f12020-09-25 13:56:00 +02001360 * @map: [in] vmap pointer to vunmap
Dave Airlie98f86c92012-05-20 12:33:56 +05301361 */
Thomas Zimmermann20e76f12020-09-25 13:56:00 +02001362void dma_buf_vunmap(struct dma_buf *dmabuf, struct dma_buf_map *map)
Dave Airlie98f86c92012-05-20 12:33:56 +05301363{
1364 if (WARN_ON(!dmabuf))
1365 return;
1366
Thomas Zimmermann01fd30d2020-09-25 13:55:58 +02001367 BUG_ON(dma_buf_map_is_null(&dmabuf->vmap_ptr));
Daniel Vetterf00b4da2012-12-20 14:14:23 +01001368 BUG_ON(dmabuf->vmapping_counter == 0);
Thomas Zimmermann20e76f12020-09-25 13:56:00 +02001369 BUG_ON(!dma_buf_map_is_equal(&dmabuf->vmap_ptr, map));
Daniel Vetterf00b4da2012-12-20 14:14:23 +01001370
1371 mutex_lock(&dmabuf->lock);
1372 if (--dmabuf->vmapping_counter == 0) {
1373 if (dmabuf->ops->vunmap)
Thomas Zimmermann20e76f12020-09-25 13:56:00 +02001374 dmabuf->ops->vunmap(dmabuf, map);
Thomas Zimmermann01fd30d2020-09-25 13:55:58 +02001375 dma_buf_map_clear(&dmabuf->vmap_ptr);
Daniel Vetterf00b4da2012-12-20 14:14:23 +01001376 }
1377 mutex_unlock(&dmabuf->lock);
Dave Airlie98f86c92012-05-20 12:33:56 +05301378}
1379EXPORT_SYMBOL_GPL(dma_buf_vunmap);
Sumit Semwalb89e35632013-04-04 11:44:37 +05301380
1381#ifdef CONFIG_DEBUG_FS
Mathias Krauseeb0b9472016-06-19 14:31:29 +02001382static int dma_buf_debug_show(struct seq_file *s, void *unused)
Sumit Semwalb89e35632013-04-04 11:44:37 +05301383{
Sumit Semwalb89e35632013-04-04 11:44:37 +05301384 struct dma_buf *buf_obj;
1385 struct dma_buf_attachment *attach_obj;
Christian König52791ee2019-08-11 10:06:32 +02001386 struct dma_resv *robj;
1387 struct dma_resv_list *fobj;
Russell King5eb2c722017-03-31 11:00:42 +01001388 struct dma_fence *fence;
Russell King5eb2c722017-03-31 11:00:42 +01001389 int count = 0, attach_count, shared_count, i;
Sumit Semwalb89e35632013-04-04 11:44:37 +05301390 size_t size = 0;
Christian König680753d2021-05-06 15:00:31 +02001391 int ret;
Sumit Semwalb89e35632013-04-04 11:44:37 +05301392
1393 ret = mutex_lock_interruptible(&db_list.lock);
1394
1395 if (ret)
1396 return ret;
1397
Sumit Semwalc0b00a52014-02-03 15:09:12 +05301398 seq_puts(s, "\nDma-buf Objects:\n");
Greg Hackmanned63bb12019-06-13 15:34:06 -07001399 seq_printf(s, "%-8s\t%-8s\t%-8s\t%-8s\texp_name\t%-8s\n",
1400 "size", "flags", "mode", "count", "ino");
Sumit Semwalb89e35632013-04-04 11:44:37 +05301401
1402 list_for_each_entry(buf_obj, &db_list.head, list_node) {
Sumit Semwalb89e35632013-04-04 11:44:37 +05301403
Christian König15fd5522018-07-03 16:42:26 +02001404 ret = dma_resv_lock_interruptible(buf_obj->resv, NULL);
1405 if (ret)
Christian Königf45f57c2019-10-18 16:30:19 +02001406 goto error_unlock;
Sumit Semwalb89e35632013-04-04 11:44:37 +05301407
Greg Hackmannbb2bb902019-06-13 15:34:07 -07001408 seq_printf(s, "%08zu\t%08x\t%08x\t%08ld\t%s\t%08lu\t%s\n",
Sumit Semwalc0b00a52014-02-03 15:09:12 +05301409 buf_obj->size,
Sumit Semwalb89e35632013-04-04 11:44:37 +05301410 buf_obj->file->f_flags, buf_obj->file->f_mode,
Al Viroa1f6dba2014-08-20 11:05:50 -04001411 file_count(buf_obj->file),
Greg Hackmanned63bb12019-06-13 15:34:06 -07001412 buf_obj->exp_name,
Greg Hackmannbb2bb902019-06-13 15:34:07 -07001413 file_inode(buf_obj->file)->i_ino,
1414 buf_obj->name ?: "");
Sumit Semwalb89e35632013-04-04 11:44:37 +05301415
Russell King5eb2c722017-03-31 11:00:42 +01001416 robj = buf_obj->resv;
Christian König6edbd6a2021-05-10 16:14:09 +02001417 fence = dma_resv_excl_fence(robj);
Russell King5eb2c722017-03-31 11:00:42 +01001418 if (fence)
1419 seq_printf(s, "\tExclusive fence: %s %s %ssignalled\n",
1420 fence->ops->get_driver_name(fence),
1421 fence->ops->get_timeline_name(fence),
1422 dma_fence_is_signaled(fence) ? "" : "un");
Christian König680753d2021-05-06 15:00:31 +02001423
1424 fobj = rcu_dereference_protected(robj->fence,
1425 dma_resv_held(robj));
1426 shared_count = fobj ? fobj->shared_count : 0;
Russell King5eb2c722017-03-31 11:00:42 +01001427 for (i = 0; i < shared_count; i++) {
Christian König680753d2021-05-06 15:00:31 +02001428 fence = rcu_dereference_protected(fobj->shared[i],
1429 dma_resv_held(robj));
Russell King5eb2c722017-03-31 11:00:42 +01001430 seq_printf(s, "\tShared fence: %s %s %ssignalled\n",
1431 fence->ops->get_driver_name(fence),
1432 fence->ops->get_timeline_name(fence),
1433 dma_fence_is_signaled(fence) ? "" : "un");
1434 }
Russell King5eb2c722017-03-31 11:00:42 +01001435
Sumit Semwalc0b00a52014-02-03 15:09:12 +05301436 seq_puts(s, "\tAttached Devices:\n");
Sumit Semwalb89e35632013-04-04 11:44:37 +05301437 attach_count = 0;
1438
1439 list_for_each_entry(attach_obj, &buf_obj->attachments, node) {
Markus Elfring9eddb412017-05-08 10:32:44 +02001440 seq_printf(s, "\t%s\n", dev_name(attach_obj->dev));
Sumit Semwalb89e35632013-04-04 11:44:37 +05301441 attach_count++;
1442 }
Christian König15fd5522018-07-03 16:42:26 +02001443 dma_resv_unlock(buf_obj->resv);
Sumit Semwalb89e35632013-04-04 11:44:37 +05301444
Sumit Semwalc0b00a52014-02-03 15:09:12 +05301445 seq_printf(s, "Total %d devices attached\n\n",
Sumit Semwalb89e35632013-04-04 11:44:37 +05301446 attach_count);
1447
1448 count++;
1449 size += buf_obj->size;
Sumit Semwalb89e35632013-04-04 11:44:37 +05301450 }
1451
1452 seq_printf(s, "\nTotal %d objects, %zu bytes\n", count, size);
1453
1454 mutex_unlock(&db_list.lock);
1455 return 0;
Christian König15fd5522018-07-03 16:42:26 +02001456
Christian Königf45f57c2019-10-18 16:30:19 +02001457error_unlock:
Christian König15fd5522018-07-03 16:42:26 +02001458 mutex_unlock(&db_list.lock);
1459 return ret;
Sumit Semwalb89e35632013-04-04 11:44:37 +05301460}
1461
Yangtao Li26743052018-11-30 11:11:01 -05001462DEFINE_SHOW_ATTRIBUTE(dma_buf_debug);
Sumit Semwalb89e35632013-04-04 11:44:37 +05301463
1464static struct dentry *dma_buf_debugfs_dir;
1465
1466static int dma_buf_init_debugfs(void)
1467{
Mathias Krausebd3e2202016-06-19 14:31:31 +02001468 struct dentry *d;
Sumit Semwalb89e35632013-04-04 11:44:37 +05301469 int err = 0;
Jagan Teki51366292015-05-21 01:09:31 +05301470
Mathias Krausebd3e2202016-06-19 14:31:31 +02001471 d = debugfs_create_dir("dma_buf", NULL);
1472 if (IS_ERR(d))
1473 return PTR_ERR(d);
Jagan Teki51366292015-05-21 01:09:31 +05301474
Mathias Krausebd3e2202016-06-19 14:31:31 +02001475 dma_buf_debugfs_dir = d;
Sumit Semwalb89e35632013-04-04 11:44:37 +05301476
Mathias Krausebd3e2202016-06-19 14:31:31 +02001477 d = debugfs_create_file("bufinfo", S_IRUGO, dma_buf_debugfs_dir,
1478 NULL, &dma_buf_debug_fops);
1479 if (IS_ERR(d)) {
Sumit Semwalb89e35632013-04-04 11:44:37 +05301480 pr_debug("dma_buf: debugfs: failed to create node bufinfo\n");
Mathias Krauseb7479992016-06-19 14:31:30 +02001481 debugfs_remove_recursive(dma_buf_debugfs_dir);
1482 dma_buf_debugfs_dir = NULL;
Mathias Krausebd3e2202016-06-19 14:31:31 +02001483 err = PTR_ERR(d);
Mathias Krauseb7479992016-06-19 14:31:30 +02001484 }
Sumit Semwalb89e35632013-04-04 11:44:37 +05301485
1486 return err;
1487}
1488
1489static void dma_buf_uninit_debugfs(void)
1490{
Vasyl Gomonovych298b6a82017-11-22 16:22:41 +01001491 debugfs_remove_recursive(dma_buf_debugfs_dir);
Sumit Semwalb89e35632013-04-04 11:44:37 +05301492}
Sumit Semwalb89e35632013-04-04 11:44:37 +05301493#else
1494static inline int dma_buf_init_debugfs(void)
1495{
1496 return 0;
1497}
1498static inline void dma_buf_uninit_debugfs(void)
1499{
1500}
1501#endif
1502
1503static int __init dma_buf_init(void)
1504{
Hridya Valsarajubdb8d062021-06-03 14:47:51 -07001505 int ret;
1506
1507 ret = dma_buf_init_sysfs_statistics();
1508 if (ret)
1509 return ret;
1510
Greg Hackmanned63bb12019-06-13 15:34:06 -07001511 dma_buf_mnt = kern_mount(&dma_buf_fs_type);
1512 if (IS_ERR(dma_buf_mnt))
1513 return PTR_ERR(dma_buf_mnt);
1514
Sumit Semwalb89e35632013-04-04 11:44:37 +05301515 mutex_init(&db_list.lock);
1516 INIT_LIST_HEAD(&db_list.head);
1517 dma_buf_init_debugfs();
1518 return 0;
1519}
1520subsys_initcall(dma_buf_init);
1521
1522static void __exit dma_buf_deinit(void)
1523{
1524 dma_buf_uninit_debugfs();
Greg Hackmanned63bb12019-06-13 15:34:06 -07001525 kern_unmount(dma_buf_mnt);
Hridya Valsarajubdb8d062021-06-03 14:47:51 -07001526 dma_buf_uninit_sysfs_statistics();
Sumit Semwalb89e35632013-04-04 11:44:37 +05301527}
1528__exitcall(dma_buf_deinit);