dma-buf.c 22.6 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27
/*
 * Framework for buffer objects that can be shared across devices/subsystems.
 *
 * Copyright(C) 2011 Linaro Limited. All rights reserved.
 * Author: Sumit Semwal <sumit.semwal@ti.com>
 *
 * Many thanks to linaro-mm-sig list, and specially
 * Arnd Bergmann <arnd@arndb.de>, Rob Clark <rob@ti.com> and
 * Daniel Vetter <daniel@ffwll.ch> for their support in creation and
 * refining of this idea.
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 as published by
 * the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for
 * more details.
 *
 * You should have received a copy of the GNU General Public License along with
 * this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#include <linux/fs.h>
#include <linux/slab.h>
#include <linux/dma-buf.h>
28
#include <linux/fence.h>
29 30
#include <linux/anon_inodes.h>
#include <linux/export.h>
S
Sumit Semwal 已提交
31
#include <linux/debugfs.h>
32
#include <linux/module.h>
S
Sumit Semwal 已提交
33
#include <linux/seq_file.h>
34
#include <linux/poll.h>
35
#include <linux/reservation.h>
36 37 38

static inline int is_dma_buf_file(struct file *);

S
Sumit Semwal 已提交
39 40 41 42 43 44 45
struct dma_buf_list {
	struct list_head head;
	struct mutex lock;
};

static struct dma_buf_list db_list;

46 47 48 49 50 51 52 53 54
static int dma_buf_release(struct inode *inode, struct file *file)
{
	struct dma_buf *dmabuf;

	if (!is_dma_buf_file(file))
		return -EINVAL;

	dmabuf = file->private_data;

55 56
	BUG_ON(dmabuf->vmapping_counter);

57 58 59 60 61 62 63 64 65 66
	/*
	 * Any fences that a dma-buf poll can wait on should be signaled
	 * before releasing dma-buf. This is the responsibility of each
	 * driver that uses the reservation objects.
	 *
	 * If you hit this BUG() it means someone dropped their ref to the
	 * dma-buf while still having pending operation to the buffer.
	 */
	BUG_ON(dmabuf->cb_shared.active || dmabuf->cb_excl.active);

67
	dmabuf->ops->release(dmabuf);
S
Sumit Semwal 已提交
68 69 70 71 72

	mutex_lock(&db_list.lock);
	list_del(&dmabuf->list_node);
	mutex_unlock(&db_list.lock);

73 74 75
	if (dmabuf->resv == (struct reservation_object *)&dmabuf[1])
		reservation_object_fini(dmabuf->resv);

76
	module_put(dmabuf->owner);
77 78 79 80
	kfree(dmabuf);
	return 0;
}

D
Daniel Vetter 已提交
81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97
static int dma_buf_mmap_internal(struct file *file, struct vm_area_struct *vma)
{
	struct dma_buf *dmabuf;

	if (!is_dma_buf_file(file))
		return -EINVAL;

	dmabuf = file->private_data;

	/* check for overflowing the buffer's size */
	if (vma->vm_pgoff + ((vma->vm_end - vma->vm_start) >> PAGE_SHIFT) >
	    dmabuf->size >> PAGE_SHIFT)
		return -EINVAL;

	return dmabuf->ops->mmap(dmabuf, vma);
}

98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123
static loff_t dma_buf_llseek(struct file *file, loff_t offset, int whence)
{
	struct dma_buf *dmabuf;
	loff_t base;

	if (!is_dma_buf_file(file))
		return -EBADF;

	dmabuf = file->private_data;

	/* only support discovering the end of the buffer,
	   but also allow SEEK_SET to maintain the idiomatic
	   SEEK_END(0), SEEK_CUR(0) pattern */
	if (whence == SEEK_END)
		base = dmabuf->size;
	else if (whence == SEEK_SET)
		base = 0;
	else
		return -EINVAL;

	if (offset != 0)
		return -EINVAL;

	return base + offset;
}

124 125 126 127 128 129 130 131 132 133 134 135 136 137 138
static void dma_buf_poll_cb(struct fence *fence, struct fence_cb *cb)
{
	struct dma_buf_poll_cb_t *dcb = (struct dma_buf_poll_cb_t *)cb;
	unsigned long flags;

	spin_lock_irqsave(&dcb->poll->lock, flags);
	wake_up_locked_poll(dcb->poll, dcb->active);
	dcb->active = 0;
	spin_unlock_irqrestore(&dcb->poll->lock, flags);
}

static unsigned int dma_buf_poll(struct file *file, poll_table *poll)
{
	struct dma_buf *dmabuf;
	struct reservation_object *resv;
139 140
	struct reservation_object_list *fobj;
	struct fence *fence_excl;
141
	unsigned long events;
142
	unsigned shared_count, seq;
143 144 145 146 147 148 149 150 151 152 153 154 155

	dmabuf = file->private_data;
	if (!dmabuf || !dmabuf->resv)
		return POLLERR;

	resv = dmabuf->resv;

	poll_wait(file, &dmabuf->poll, poll);

	events = poll_requested_events(poll) & (POLLIN | POLLOUT);
	if (!events)
		return 0;

156 157 158
retry:
	seq = read_seqcount_begin(&resv->seq);
	rcu_read_lock();
159

160 161 162 163 164 165 166 167 168 169
	fobj = rcu_dereference(resv->fence);
	if (fobj)
		shared_count = fobj->shared_count;
	else
		shared_count = 0;
	fence_excl = rcu_dereference(resv->fence_excl);
	if (read_seqcount_retry(&resv->seq, seq)) {
		rcu_read_unlock();
		goto retry;
	}
170 171

	if (fence_excl && (!(events & POLLOUT) || shared_count == 0)) {
172 173 174
		struct dma_buf_poll_cb_t *dcb = &dmabuf->cb_excl;
		unsigned long pevents = POLLIN;

175
		if (shared_count == 0)
176 177 178 179 180 181 182 183 184 185 186
			pevents |= POLLOUT;

		spin_lock_irq(&dmabuf->poll.lock);
		if (dcb->active) {
			dcb->active |= pevents;
			events &= ~pevents;
		} else
			dcb->active = pevents;
		spin_unlock_irq(&dmabuf->poll.lock);

		if (events & pevents) {
187 188 189 190 191
			if (!fence_get_rcu(fence_excl)) {
				/* force a recheck */
				events &= ~pevents;
				dma_buf_poll_cb(NULL, &dcb->cb);
			} else if (!fence_add_callback(fence_excl, &dcb->cb,
192
						       dma_buf_poll_cb)) {
193
				events &= ~pevents;
194
				fence_put(fence_excl);
195
			} else {
196 197 198 199
				/*
				 * No callback queued, wake up any additional
				 * waiters.
				 */
200
				fence_put(fence_excl);
201
				dma_buf_poll_cb(NULL, &dcb->cb);
202
			}
203 204 205
		}
	}

206
	if ((events & POLLOUT) && shared_count > 0) {
207 208 209 210 211 212 213 214 215 216 217 218 219 220
		struct dma_buf_poll_cb_t *dcb = &dmabuf->cb_shared;
		int i;

		/* Only queue a new callback if no event has fired yet */
		spin_lock_irq(&dmabuf->poll.lock);
		if (dcb->active)
			events &= ~POLLOUT;
		else
			dcb->active = POLLOUT;
		spin_unlock_irq(&dmabuf->poll.lock);

		if (!(events & POLLOUT))
			goto out;

221
		for (i = 0; i < shared_count; ++i) {
222
			struct fence *fence = rcu_dereference(fobj->shared[i]);
223

224 225 226 227 228 229 230 231 232 233 234
			if (!fence_get_rcu(fence)) {
				/*
				 * fence refcount dropped to zero, this means
				 * that fobj has been freed
				 *
				 * call dma_buf_poll_cb and force a recheck!
				 */
				events &= ~POLLOUT;
				dma_buf_poll_cb(NULL, &dcb->cb);
				break;
			}
235 236
			if (!fence_add_callback(fence, &dcb->cb,
						dma_buf_poll_cb)) {
237
				fence_put(fence);
238 239 240
				events &= ~POLLOUT;
				break;
			}
241
			fence_put(fence);
242
		}
243 244

		/* No callback queued, wake up any additional waiters. */
245
		if (i == shared_count)
246 247 248 249
			dma_buf_poll_cb(NULL, &dcb->cb);
	}

out:
250
	rcu_read_unlock();
251 252 253
	return events;
}

254 255
static const struct file_operations dma_buf_fops = {
	.release	= dma_buf_release,
D
Daniel Vetter 已提交
256
	.mmap		= dma_buf_mmap_internal,
257
	.llseek		= dma_buf_llseek,
258
	.poll		= dma_buf_poll,
259 260 261 262 263 264 265 266 267 268 269
};

/*
 * is_dma_buf_file - Check if struct file* is associated with dma_buf
 */
static inline int is_dma_buf_file(struct file *file)
{
	return file->f_op == &dma_buf_fops;
}

/**
270
 * dma_buf_export - Creates a new dma_buf, and associates an anon file
271 272
 * with this buffer, so it can be exported.
 * Also connect the allocator specific data and ops to the buffer.
273
 * Additionally, provide a name string for exporter; useful in debugging.
274
 *
275 276 277
 * @exp_info:	[in]	holds all the export related information provided
 *			by the exporter. see struct dma_buf_export_info
 *			for further details.
278 279 280 281 282 283
 *
 * Returns, on success, a newly created dma_buf object, which wraps the
 * supplied private data and operations for dma_buf_ops. On either missing
 * ops, or error in allocating struct dma_buf, will return negative error.
 *
 */
284
struct dma_buf *dma_buf_export(const struct dma_buf_export_info *exp_info)
285 286
{
	struct dma_buf *dmabuf;
287
	struct reservation_object *resv = exp_info->resv;
288
	struct file *file;
289
	size_t alloc_size = sizeof(struct dma_buf);
290
	if (!exp_info->resv)
291 292 293 294
		alloc_size += sizeof(struct reservation_object);
	else
		/* prevent &dma_buf[1] == dma_buf->resv */
		alloc_size += 1;
295

296 297 298 299 300 301 302 303
	if (WARN_ON(!exp_info->priv
			  || !exp_info->ops
			  || !exp_info->ops->map_dma_buf
			  || !exp_info->ops->unmap_dma_buf
			  || !exp_info->ops->release
			  || !exp_info->ops->kmap_atomic
			  || !exp_info->ops->kmap
			  || !exp_info->ops->mmap)) {
304 305 306
		return ERR_PTR(-EINVAL);
	}

307 308 309
	if (!try_module_get(exp_info->owner))
		return ERR_PTR(-ENOENT);

310
	dmabuf = kzalloc(alloc_size, GFP_KERNEL);
311 312
	if (!dmabuf) {
		module_put(exp_info->owner);
313
		return ERR_PTR(-ENOMEM);
314
	}
315

316 317 318 319
	dmabuf->priv = exp_info->priv;
	dmabuf->ops = exp_info->ops;
	dmabuf->size = exp_info->size;
	dmabuf->exp_name = exp_info->exp_name;
320
	dmabuf->owner = exp_info->owner;
321 322 323 324
	init_waitqueue_head(&dmabuf->poll);
	dmabuf->cb_excl.poll = dmabuf->cb_shared.poll = &dmabuf->poll;
	dmabuf->cb_excl.active = dmabuf->cb_shared.active = 0;

325 326 327 328 329
	if (!resv) {
		resv = (struct reservation_object *)&dmabuf[1];
		reservation_object_init(resv);
	}
	dmabuf->resv = resv;
330

331 332
	file = anon_inode_getfile("dmabuf", &dma_buf_fops, dmabuf,
					exp_info->flags);
333 334 335 336
	if (IS_ERR(file)) {
		kfree(dmabuf);
		return ERR_CAST(file);
	}
337 338

	file->f_mode |= FMODE_LSEEK;
339 340 341 342 343
	dmabuf->file = file;

	mutex_init(&dmabuf->lock);
	INIT_LIST_HEAD(&dmabuf->attachments);

S
Sumit Semwal 已提交
344 345 346 347
	mutex_lock(&db_list.lock);
	list_add(&dmabuf->list_node, &db_list.head);
	mutex_unlock(&db_list.lock);

348 349
	return dmabuf;
}
350
EXPORT_SYMBOL_GPL(dma_buf_export);
351 352 353 354

/**
 * dma_buf_fd - returns a file descriptor for the given dma_buf
 * @dmabuf:	[in]	pointer to dma_buf for which fd is required.
355
 * @flags:      [in]    flags to give to fd
356 357 358
 *
 * On success, returns an associated 'fd'. Else, returns error.
 */
359
int dma_buf_fd(struct dma_buf *dmabuf, int flags)
360
{
B
Borislav Petkov 已提交
361
	int fd;
362 363 364 365

	if (!dmabuf || !dmabuf->file)
		return -EINVAL;

B
Borislav Petkov 已提交
366 367 368
	fd = get_unused_fd_flags(flags);
	if (fd < 0)
		return fd;
369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422

	fd_install(fd, dmabuf->file);

	return fd;
}
EXPORT_SYMBOL_GPL(dma_buf_fd);

/**
 * dma_buf_get - returns the dma_buf structure related to an fd
 * @fd:	[in]	fd associated with the dma_buf to be returned
 *
 * On success, returns the dma_buf structure associated with an fd; uses
 * file's refcounting done by fget to increase refcount. returns ERR_PTR
 * otherwise.
 */
struct dma_buf *dma_buf_get(int fd)
{
	struct file *file;

	file = fget(fd);

	if (!file)
		return ERR_PTR(-EBADF);

	if (!is_dma_buf_file(file)) {
		fput(file);
		return ERR_PTR(-EINVAL);
	}

	return file->private_data;
}
EXPORT_SYMBOL_GPL(dma_buf_get);

/**
 * dma_buf_put - decreases refcount of the buffer
 * @dmabuf:	[in]	buffer to reduce refcount of
 *
 * Uses file's refcounting done implicitly by fput()
 */
void dma_buf_put(struct dma_buf *dmabuf)
{
	if (WARN_ON(!dmabuf || !dmabuf->file))
		return;

	fput(dmabuf->file);
}
EXPORT_SYMBOL_GPL(dma_buf_put);

/**
 * dma_buf_attach - Add the device to dma_buf's attachments list; optionally,
 * calls attach() of dma_buf_ops to allow device-specific attach functionality
 * @dmabuf:	[in]	buffer to attach device to.
 * @dev:	[in]	device to be attached.
 *
423 424
 * Returns struct dma_buf_attachment * for this attachment; returns ERR_PTR on
 * error.
425 426 427 428 429 430 431
 */
struct dma_buf_attachment *dma_buf_attach(struct dma_buf *dmabuf,
					  struct device *dev)
{
	struct dma_buf_attachment *attach;
	int ret;

432
	if (WARN_ON(!dmabuf || !dev))
433 434 435 436
		return ERR_PTR(-EINVAL);

	attach = kzalloc(sizeof(struct dma_buf_attachment), GFP_KERNEL);
	if (attach == NULL)
437
		return ERR_PTR(-ENOMEM);
438 439 440

	attach->dev = dev;
	attach->dmabuf = dmabuf;
441 442 443

	mutex_lock(&dmabuf->lock);

444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469
	if (dmabuf->ops->attach) {
		ret = dmabuf->ops->attach(dmabuf, dev, attach);
		if (ret)
			goto err_attach;
	}
	list_add(&attach->node, &dmabuf->attachments);

	mutex_unlock(&dmabuf->lock);
	return attach;

err_attach:
	kfree(attach);
	mutex_unlock(&dmabuf->lock);
	return ERR_PTR(ret);
}
EXPORT_SYMBOL_GPL(dma_buf_attach);

/**
 * dma_buf_detach - Remove the given attachment from dmabuf's attachments list;
 * optionally calls detach() of dma_buf_ops for device-specific detach
 * @dmabuf:	[in]	buffer to detach from.
 * @attach:	[in]	attachment to be detached; is free'd after this call.
 *
 */
void dma_buf_detach(struct dma_buf *dmabuf, struct dma_buf_attachment *attach)
{
470
	if (WARN_ON(!dmabuf || !attach))
471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489
		return;

	mutex_lock(&dmabuf->lock);
	list_del(&attach->node);
	if (dmabuf->ops->detach)
		dmabuf->ops->detach(dmabuf, attach);

	mutex_unlock(&dmabuf->lock);
	kfree(attach);
}
EXPORT_SYMBOL_GPL(dma_buf_detach);

/**
 * dma_buf_map_attachment - Returns the scatterlist table of the attachment;
 * mapped into _device_ address space. Is a wrapper for map_dma_buf() of the
 * dma_buf_ops.
 * @attach:	[in]	attachment whose scatterlist is to be returned
 * @direction:	[in]	direction of DMA transfer
 *
490 491
 * Returns sg_table containing the scatterlist to be returned; returns ERR_PTR
 * on error.
492 493 494 495 496 497 498 499
 */
struct sg_table *dma_buf_map_attachment(struct dma_buf_attachment *attach,
					enum dma_data_direction direction)
{
	struct sg_table *sg_table = ERR_PTR(-EINVAL);

	might_sleep();

500
	if (WARN_ON(!attach || !attach->dmabuf))
501 502
		return ERR_PTR(-EINVAL);

503
	sg_table = attach->dmabuf->ops->map_dma_buf(attach, direction);
504 505
	if (!sg_table)
		sg_table = ERR_PTR(-ENOMEM);
506 507 508 509 510 511 512 513 514 515 516

	return sg_table;
}
EXPORT_SYMBOL_GPL(dma_buf_map_attachment);

/**
 * dma_buf_unmap_attachment - unmaps and decreases usecount of the buffer;might
 * deallocate the scatterlist associated. Is a wrapper for unmap_dma_buf() of
 * dma_buf_ops.
 * @attach:	[in]	attachment to unmap buffer from
 * @sg_table:	[in]	scatterlist info of the buffer to unmap
517
 * @direction:  [in]    direction of DMA transfer
518 519 520
 *
 */
void dma_buf_unmap_attachment(struct dma_buf_attachment *attach,
521 522
				struct sg_table *sg_table,
				enum dma_data_direction direction)
523
{
524 525
	might_sleep();

526
	if (WARN_ON(!attach || !attach->dmabuf || !sg_table))
527 528
		return;

529 530
	attach->dmabuf->ops->unmap_dma_buf(attach, sg_table,
						direction);
531 532
}
EXPORT_SYMBOL_GPL(dma_buf_unmap_attachment);
533 534 535 536 537 538 539


/**
 * dma_buf_begin_cpu_access - Must be called before accessing a dma_buf from the
 * cpu in the kernel context. Calls begin_cpu_access to allow exporter-specific
 * preparations. Coherency is only guaranteed in the specified range for the
 * specified access direction.
540
 * @dmabuf:	[in]	buffer to prepare cpu access for.
541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566
 * @start:	[in]	start of range for cpu access.
 * @len:	[in]	length of range for cpu access.
 * @direction:	[in]	length of range for cpu access.
 *
 * Can return negative error values, returns 0 on success.
 */
int dma_buf_begin_cpu_access(struct dma_buf *dmabuf, size_t start, size_t len,
			     enum dma_data_direction direction)
{
	int ret = 0;

	if (WARN_ON(!dmabuf))
		return -EINVAL;

	if (dmabuf->ops->begin_cpu_access)
		ret = dmabuf->ops->begin_cpu_access(dmabuf, start, len, direction);

	return ret;
}
EXPORT_SYMBOL_GPL(dma_buf_begin_cpu_access);

/**
 * dma_buf_end_cpu_access - Must be called after accessing a dma_buf from the
 * cpu in the kernel context. Calls end_cpu_access to allow exporter-specific
 * actions. Coherency is only guaranteed in the specified range for the
 * specified access direction.
567
 * @dmabuf:	[in]	buffer to complete cpu access for.
568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586
 * @start:	[in]	start of range for cpu access.
 * @len:	[in]	length of range for cpu access.
 * @direction:	[in]	length of range for cpu access.
 *
 * This call must always succeed.
 */
void dma_buf_end_cpu_access(struct dma_buf *dmabuf, size_t start, size_t len,
			    enum dma_data_direction direction)
{
	WARN_ON(!dmabuf);

	if (dmabuf->ops->end_cpu_access)
		dmabuf->ops->end_cpu_access(dmabuf, start, len, direction);
}
EXPORT_SYMBOL_GPL(dma_buf_end_cpu_access);

/**
 * dma_buf_kmap_atomic - Map a page of the buffer object into kernel address
 * space. The same restrictions as for kmap_atomic and friends apply.
587
 * @dmabuf:	[in]	buffer to map page from.
588 589 590 591 592 593 594 595 596 597 598 599 600 601 602
 * @page_num:	[in]	page in PAGE_SIZE units to map.
 *
 * This call must always succeed, any necessary preparations that might fail
 * need to be done in begin_cpu_access.
 */
void *dma_buf_kmap_atomic(struct dma_buf *dmabuf, unsigned long page_num)
{
	WARN_ON(!dmabuf);

	return dmabuf->ops->kmap_atomic(dmabuf, page_num);
}
EXPORT_SYMBOL_GPL(dma_buf_kmap_atomic);

/**
 * dma_buf_kunmap_atomic - Unmap a page obtained by dma_buf_kmap_atomic.
603
 * @dmabuf:	[in]	buffer to unmap page from.
604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621
 * @page_num:	[in]	page in PAGE_SIZE units to unmap.
 * @vaddr:	[in]	kernel space pointer obtained from dma_buf_kmap_atomic.
 *
 * This call must always succeed.
 */
void dma_buf_kunmap_atomic(struct dma_buf *dmabuf, unsigned long page_num,
			   void *vaddr)
{
	WARN_ON(!dmabuf);

	if (dmabuf->ops->kunmap_atomic)
		dmabuf->ops->kunmap_atomic(dmabuf, page_num, vaddr);
}
EXPORT_SYMBOL_GPL(dma_buf_kunmap_atomic);

/**
 * dma_buf_kmap - Map a page of the buffer object into kernel address space. The
 * same restrictions as for kmap and friends apply.
622
 * @dmabuf:	[in]	buffer to map page from.
623 624 625 626 627 628 629 630 631 632 633 634 635 636 637
 * @page_num:	[in]	page in PAGE_SIZE units to map.
 *
 * This call must always succeed, any necessary preparations that might fail
 * need to be done in begin_cpu_access.
 */
void *dma_buf_kmap(struct dma_buf *dmabuf, unsigned long page_num)
{
	WARN_ON(!dmabuf);

	return dmabuf->ops->kmap(dmabuf, page_num);
}
EXPORT_SYMBOL_GPL(dma_buf_kmap);

/**
 * dma_buf_kunmap - Unmap a page obtained by dma_buf_kmap.
638
 * @dmabuf:	[in]	buffer to unmap page from.
639 640 641 642 643 644 645 646 647 648 649 650 651 652
 * @page_num:	[in]	page in PAGE_SIZE units to unmap.
 * @vaddr:	[in]	kernel space pointer obtained from dma_buf_kmap.
 *
 * This call must always succeed.
 */
void dma_buf_kunmap(struct dma_buf *dmabuf, unsigned long page_num,
		    void *vaddr)
{
	WARN_ON(!dmabuf);

	if (dmabuf->ops->kunmap)
		dmabuf->ops->kunmap(dmabuf, page_num, vaddr);
}
EXPORT_SYMBOL_GPL(dma_buf_kunmap);
D
Daniel Vetter 已提交
653 654 655 656


/**
 * dma_buf_mmap - Setup up a userspace mmap with the given vma
657
 * @dmabuf:	[in]	buffer that should back the vma
D
Daniel Vetter 已提交
658 659 660 661 662
 * @vma:	[in]	vma for the mmap
 * @pgoff:	[in]	offset in pages where this mmap should start within the
 * 			dma-buf buffer.
 *
 * This function adjusts the passed in vma so that it points at the file of the
663
 * dma_buf operation. It also adjusts the starting pgoff and does bounds
D
Daniel Vetter 已提交
664 665 666 667 668 669 670 671
 * checking on the size of the vma. Then it calls the exporters mmap function to
 * set up the mapping.
 *
 * Can return negative error values, returns 0 on success.
 */
int dma_buf_mmap(struct dma_buf *dmabuf, struct vm_area_struct *vma,
		 unsigned long pgoff)
{
672 673 674
	struct file *oldfile;
	int ret;

D
Daniel Vetter 已提交
675 676 677 678 679 680 681 682 683 684 685 686 687
	if (WARN_ON(!dmabuf || !vma))
		return -EINVAL;

	/* check for offset overflow */
	if (pgoff + ((vma->vm_end - vma->vm_start) >> PAGE_SHIFT) < pgoff)
		return -EOVERFLOW;

	/* check for overflowing the buffer's size */
	if (pgoff + ((vma->vm_end - vma->vm_start) >> PAGE_SHIFT) >
	    dmabuf->size >> PAGE_SHIFT)
		return -EINVAL;

	/* readjust the vma */
688 689 690
	get_file(dmabuf->file);
	oldfile = vma->vm_file;
	vma->vm_file = dmabuf->file;
D
Daniel Vetter 已提交
691 692
	vma->vm_pgoff = pgoff;

693 694 695 696 697 698 699 700 701 702 703
	ret = dmabuf->ops->mmap(dmabuf, vma);
	if (ret) {
		/* restore old parameters on failure */
		vma->vm_file = oldfile;
		fput(dmabuf->file);
	} else {
		if (oldfile)
			fput(oldfile);
	}
	return ret;

D
Daniel Vetter 已提交
704 705
}
EXPORT_SYMBOL_GPL(dma_buf_mmap);
D
Dave Airlie 已提交
706 707

/**
708 709 710
 * dma_buf_vmap - Create virtual mapping for the buffer object into kernel
 * address space. Same restrictions as for vmap and friends apply.
 * @dmabuf:	[in]	buffer to vmap
D
Dave Airlie 已提交
711 712 713 714 715
 *
 * This call may fail due to lack of virtual mapping address space.
 * These calls are optional in drivers. The intended use for them
 * is for mapping objects linear in kernel space for high use objects.
 * Please attempt to use kmap/kunmap before thinking about these interfaces.
716 717
 *
 * Returns NULL on error.
D
Dave Airlie 已提交
718 719 720
 */
void *dma_buf_vmap(struct dma_buf *dmabuf)
{
721 722
	void *ptr;

D
Dave Airlie 已提交
723 724 725
	if (WARN_ON(!dmabuf))
		return NULL;

726 727 728 729 730 731 732 733 734 735 736 737 738 739
	if (!dmabuf->ops->vmap)
		return NULL;

	mutex_lock(&dmabuf->lock);
	if (dmabuf->vmapping_counter) {
		dmabuf->vmapping_counter++;
		BUG_ON(!dmabuf->vmap_ptr);
		ptr = dmabuf->vmap_ptr;
		goto out_unlock;
	}

	BUG_ON(dmabuf->vmap_ptr);

	ptr = dmabuf->ops->vmap(dmabuf);
740 741 742
	if (WARN_ON_ONCE(IS_ERR(ptr)))
		ptr = NULL;
	if (!ptr)
743 744 745 746 747 748 749 750
		goto out_unlock;

	dmabuf->vmap_ptr = ptr;
	dmabuf->vmapping_counter = 1;

out_unlock:
	mutex_unlock(&dmabuf->lock);
	return ptr;
D
Dave Airlie 已提交
751 752 753 754 755
}
EXPORT_SYMBOL_GPL(dma_buf_vmap);

/**
 * dma_buf_vunmap - Unmap a vmap obtained by dma_buf_vmap.
756
 * @dmabuf:	[in]	buffer to vunmap
757
 * @vaddr:	[in]	vmap to vunmap
D
Dave Airlie 已提交
758 759 760 761 762 763
 */
void dma_buf_vunmap(struct dma_buf *dmabuf, void *vaddr)
{
	if (WARN_ON(!dmabuf))
		return;

764 765 766 767 768 769 770 771 772 773 774
	BUG_ON(!dmabuf->vmap_ptr);
	BUG_ON(dmabuf->vmapping_counter == 0);
	BUG_ON(dmabuf->vmap_ptr != vaddr);

	mutex_lock(&dmabuf->lock);
	if (--dmabuf->vmapping_counter == 0) {
		if (dmabuf->ops->vunmap)
			dmabuf->ops->vunmap(dmabuf, vaddr);
		dmabuf->vmap_ptr = NULL;
	}
	mutex_unlock(&dmabuf->lock);
D
Dave Airlie 已提交
775 776
}
EXPORT_SYMBOL_GPL(dma_buf_vunmap);
S
Sumit Semwal 已提交
777 778 779 780 781 782 783 784 785 786 787 788 789 790 791

#ifdef CONFIG_DEBUG_FS
static int dma_buf_describe(struct seq_file *s)
{
	int ret;
	struct dma_buf *buf_obj;
	struct dma_buf_attachment *attach_obj;
	int count = 0, attach_count;
	size_t size = 0;

	ret = mutex_lock_interruptible(&db_list.lock);

	if (ret)
		return ret;

S
Sumit Semwal 已提交
792 793
	seq_puts(s, "\nDma-buf Objects:\n");
	seq_puts(s, "size\tflags\tmode\tcount\texp_name\n");
S
Sumit Semwal 已提交
794 795 796 797 798

	list_for_each_entry(buf_obj, &db_list.head, list_node) {
		ret = mutex_lock_interruptible(&buf_obj->lock);

		if (ret) {
S
Sumit Semwal 已提交
799 800
			seq_puts(s,
				 "\tERROR locking buffer object: skipping\n");
S
Sumit Semwal 已提交
801 802 803
			continue;
		}

S
Sumit Semwal 已提交
804 805
		seq_printf(s, "%08zu\t%08x\t%08x\t%08ld\t%s\n",
				buf_obj->size,
S
Sumit Semwal 已提交
806
				buf_obj->file->f_flags, buf_obj->file->f_mode,
807
				file_count(buf_obj->file),
S
Sumit Semwal 已提交
808
				buf_obj->exp_name);
S
Sumit Semwal 已提交
809

S
Sumit Semwal 已提交
810
		seq_puts(s, "\tAttached Devices:\n");
S
Sumit Semwal 已提交
811 812 813
		attach_count = 0;

		list_for_each_entry(attach_obj, &buf_obj->attachments, node) {
S
Sumit Semwal 已提交
814
			seq_puts(s, "\t");
S
Sumit Semwal 已提交
815

S
Sumit Semwal 已提交
816
			seq_printf(s, "%s\n", dev_name(attach_obj->dev));
S
Sumit Semwal 已提交
817 818 819
			attach_count++;
		}

S
Sumit Semwal 已提交
820
		seq_printf(s, "Total %d devices attached\n\n",
S
Sumit Semwal 已提交
821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886
				attach_count);

		count++;
		size += buf_obj->size;
		mutex_unlock(&buf_obj->lock);
	}

	seq_printf(s, "\nTotal %d objects, %zu bytes\n", count, size);

	mutex_unlock(&db_list.lock);
	return 0;
}

static int dma_buf_show(struct seq_file *s, void *unused)
{
	void (*func)(struct seq_file *) = s->private;
	func(s);
	return 0;
}

static int dma_buf_debug_open(struct inode *inode, struct file *file)
{
	return single_open(file, dma_buf_show, inode->i_private);
}

static const struct file_operations dma_buf_debug_fops = {
	.open           = dma_buf_debug_open,
	.read           = seq_read,
	.llseek         = seq_lseek,
	.release        = single_release,
};

static struct dentry *dma_buf_debugfs_dir;

static int dma_buf_init_debugfs(void)
{
	int err = 0;
	dma_buf_debugfs_dir = debugfs_create_dir("dma_buf", NULL);
	if (IS_ERR(dma_buf_debugfs_dir)) {
		err = PTR_ERR(dma_buf_debugfs_dir);
		dma_buf_debugfs_dir = NULL;
		return err;
	}

	err = dma_buf_debugfs_create_file("bufinfo", dma_buf_describe);

	if (err)
		pr_debug("dma_buf: debugfs: failed to create node bufinfo\n");

	return err;
}

static void dma_buf_uninit_debugfs(void)
{
	if (dma_buf_debugfs_dir)
		debugfs_remove_recursive(dma_buf_debugfs_dir);
}

int dma_buf_debugfs_create_file(const char *name,
				int (*write)(struct seq_file *))
{
	struct dentry *d;

	d = debugfs_create_file(name, S_IRUGO, dma_buf_debugfs_dir,
			write, &dma_buf_debug_fops);

887
	return PTR_ERR_OR_ZERO(d);
S
Sumit Semwal 已提交
888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912
}
#else
static inline int dma_buf_init_debugfs(void)
{
	return 0;
}
static inline void dma_buf_uninit_debugfs(void)
{
}
#endif

static int __init dma_buf_init(void)
{
	mutex_init(&db_list.lock);
	INIT_LIST_HEAD(&db_list.head);
	dma_buf_init_debugfs();
	return 0;
}
subsys_initcall(dma_buf_init);

static void __exit dma_buf_deinit(void)
{
	dma_buf_uninit_debugfs();
}
__exitcall(dma_buf_deinit);