goldfish: pipe: ANDROID: Add DMA support

This change improves the pipe performance by removing unnesessary
memory copying.

Bug: 72717639
Bug: 66884503
Change-Id: I0d279f682039e411faf4212713d82ec355c3e9ee
Signed-off-by: Roman Kiryanov <rkir@google.com>
Signed-off-by: Lingfeng Yang <lfy@google.com>
This commit is contained in:
Roman Kiryanov 2018-04-30 17:11:42 -07:00
parent 033c952f2e
commit 3702e76fb6
3 changed files with 442 additions and 2 deletions

View file

@ -87,6 +87,9 @@ struct goldfish_pipe_dev {
/* ptr to platform device's device struct */
struct device *pdev_dev;
/* DMA info */
size_t dma_alloc_total;
};
extern struct goldfish_pipe_dev goldfish_pipe_dev;

View file

@ -47,14 +47,24 @@
*/
#include <linux/printk.h>
#include <linux/dma-mapping.h>
#include <linux/platform_device.h>
#include <linux/types.h>
#include <linux/kernel.h>
#include <linux/bug.h>
#include <uapi/linux/goldfish/goldfish_dma.h>
#include "goldfish_pipe.h"
/*
* Update this when something changes in the driver's behavior so the host
* can benefit from knowing it
* Notes:
* version 2 was an intermediate release and isn't supported anymore.
* version 3 is goldfish_pipe_v2 without DMA support.
version 4 (current) is goldfish_pipe_v2 with DMA support.
*/
enum {
PIPE_DRIVER_VERSION = 2,
PIPE_DRIVER_VERSION = 4,
PIPE_CURRENT_DEVICE_VERSION = 2
};
@ -123,12 +133,16 @@ enum PipeCmdCode {
* parallel processing of pipe operations on the host.
*/
PIPE_CMD_WAKE_ON_DONE_IO,
PIPE_CMD_DMA_HOST_MAP,
PIPE_CMD_DMA_HOST_UNMAP,
};
enum {
MAX_BUFFERS_PER_COMMAND = 336,
MAX_SIGNALLED_PIPES = 64,
INITIAL_PIPES_CAPACITY = 64
INITIAL_PIPES_CAPACITY = 64,
DMA_REGION_MIN_SIZE = PAGE_SIZE,
DMA_REGION_MAX_SIZE = 256 << 20
};
struct goldfish_pipe_dev;
@ -153,6 +167,11 @@ struct goldfish_pipe_command {
/* buffer sizes, guest -> host */
u32 sizes[MAX_BUFFERS_PER_COMMAND];
} rw_params;
/* Parameters for PIPE_CMD_DMA_HOST_(UN)MAP */
struct {
u64 dma_paddr;
u64 sz;
} dma_maphost_params;
};
};
@ -175,6 +194,24 @@ struct goldfish_pipe_dev_buffers {
signalled_pipe_buffers[MAX_SIGNALLED_PIPES];
};
/*
* The main data structure tracking state is
* struct goldfish_dma_context, which is included
* as an extra pointer field in struct goldfish_pipe.
* Each such context is associated with possibly
* one physical address and size describing the
* allocated DMA region, and only one allocation
* is allowed for each pipe fd. Further allocations
* require more open()'s of pipe fd's.
*/
struct goldfish_dma_context {
struct device *pdev_dev; /* pointer to feed to dma_*_coherent */
void *dma_vaddr; /* kernel vaddr of dma region */
size_t dma_size; /* size of dma region */
dma_addr_t phys_begin; /* paddr of dma region */
dma_addr_t phys_end; /* paddr of dma region + dma_size */
};
/* This data type models a given pipe instance */
struct goldfish_pipe {
/* pipe ID - index into goldfish_pipe_dev::pipes array */
@ -211,6 +248,8 @@ struct goldfish_pipe {
wait_queue_head_t wake_queue;
/* Pointer to the parent goldfish_pipe_dev instance */
struct goldfish_pipe_dev *dev;
/* Holds information about reserved DMA region for this pipe */
struct goldfish_dma_context *dma;
};
struct goldfish_pipe_dev goldfish_pipe_dev;
@ -744,6 +783,8 @@ static int goldfish_pipe_open(struct inode *inode, struct file *file)
goto err_cmd;
}
pipe->dma = NULL;
/* All is done, save the pipe into the file's private data field */
file->private_data = pipe;
return 0;
@ -759,6 +800,55 @@ err_pipe:
return status;
}
static void goldfish_pipe_dma_release_host(struct goldfish_pipe *pipe)
{
struct goldfish_dma_context *dma = pipe->dma;
struct device *pdev_dev;
if (!dma)
return;
pdev_dev = pipe->dev->pdev_dev;
if (dma->dma_vaddr) {
dev_dbg(pdev_dev, "Last ref for dma region @ 0x%llx\n",
dma->phys_begin);
pipe->command_buffer->dma_maphost_params.dma_paddr =
dma->phys_begin;
pipe->command_buffer->dma_maphost_params.sz = dma->dma_size;
goldfish_pipe_cmd(pipe, PIPE_CMD_DMA_HOST_UNMAP);
}
dev_dbg(pdev_dev,
"after delete of dma @ 0x%llx: alloc total %zu\n",
dma->phys_begin, pipe->dev->dma_alloc_total);
}
static void goldfish_pipe_dma_release_guest(struct goldfish_pipe *pipe)
{
struct goldfish_dma_context *dma = pipe->dma;
struct device *pdev_dev;
if (!dma)
return;
pdev_dev = pipe->dev->pdev_dev;
if (dma->dma_vaddr) {
dma_free_coherent(
dma->pdev_dev,
dma->dma_size,
dma->dma_vaddr,
dma->phys_begin);
pipe->dev->dma_alloc_total -= dma->dma_size;
dev_dbg(pdev_dev,
"after delete of dma @ 0x%llx: alloc total %zu\n",
dma->phys_begin, pipe->dev->dma_alloc_total);
}
}
static int goldfish_pipe_release(struct inode *inode, struct file *filp)
{
unsigned long flags;
@ -766,6 +856,7 @@ static int goldfish_pipe_release(struct inode *inode, struct file *filp)
struct goldfish_pipe_dev *dev = pipe->dev;
/* The guest is closing the channel, so tell the emulator right now */
goldfish_pipe_dma_release_host(pipe);
goldfish_pipe_cmd(pipe, PIPE_CMD_CLOSE);
spin_lock_irqsave(&dev->lock, flags);
@ -775,12 +866,271 @@ static int goldfish_pipe_release(struct inode *inode, struct file *filp)
filp->private_data = NULL;
/* Even if a fd is duped or involved in a forked process,
* open/release methods are called only once, ever.
* This makes goldfish_pipe_release a safe point
* to delete the DMA region.
*/
goldfish_pipe_dma_release_guest(pipe);
kfree(pipe->dma);
free_page((unsigned long)pipe->command_buffer);
kfree(pipe);
return 0;
}
/* VMA open/close are for debugging purposes only.
* One might think that fork() (and thus pure calls to open())
* will require some sort of bookkeeping or refcounting
* for dma contexts (incl. when to call dma_free_coherent),
* but |vm_private_data| field and |vma_open/close| are only
* for situations where the driver needs to interact with vma's
* directly with its own per-VMA data structure (which does
* need to be refcounted).
*
* Here, we just use the kernel's existing
* VMA processing; we don't do anything on our own.
* The only reason we would want to do so is if we had to do
* special processing for the virtual (not physical) memory
* already associated with DMA memory; it is much less related
* to the task of knowing when to alloc/dealloc DMA memory.
*/
static void goldfish_dma_vma_open(struct vm_area_struct *vma)
{
/* Not used */
}
static void goldfish_dma_vma_close(struct vm_area_struct *vma)
{
/* Not used */
}
static const struct vm_operations_struct goldfish_dma_vm_ops = {
.open = goldfish_dma_vma_open,
.close = goldfish_dma_vma_close,
};
static bool is_page_size_multiple(unsigned long sz)
{
return !(sz & (PAGE_SIZE - 1));
}
static bool check_region_size_valid(size_t size)
{
if (size < DMA_REGION_MIN_SIZE)
return false;
if (size > DMA_REGION_MAX_SIZE)
return false;
return is_page_size_multiple(size);
}
static int goldfish_pipe_dma_alloc_locked(struct goldfish_pipe *pipe)
{
struct goldfish_dma_context *dma = pipe->dma;
struct device *pdev_dev = pipe->dev->pdev_dev;
dev_dbg(pdev_dev, "%s: try alloc dma for pipe %p\n",
__func__, pipe);
if (dma->dma_vaddr) {
dev_dbg(pdev_dev, "%s: already alloced, return.\n",
__func__);
return 0;
}
dma->phys_begin = 0;
dma->dma_vaddr =
dma_alloc_coherent(
dma->pdev_dev,
dma->dma_size,
&dma->phys_begin,
GFP_KERNEL);
return -ENOMEM;
dma->phys_end = dma->phys_begin + dma->dma_size;
pipe->dev->dma_alloc_total += dma->dma_size;
dev_dbg(pdev_dev, "%s: got v/p addrs "
"%p 0x%llx sz %zu total alloc %zu\n",
__func__,
dma->dma_vaddr,
dma->phys_begin,
dma->dma_size,
pipe->dev->dma_alloc_total);
pipe->command_buffer->dma_maphost_params.dma_paddr = dma->phys_begin;
pipe->command_buffer->dma_maphost_params.sz = dma->dma_size;
return goldfish_pipe_cmd_locked(pipe, PIPE_CMD_DMA_HOST_MAP);
}
static int goldfish_dma_mmap_locked(
struct goldfish_pipe *pipe, struct vm_area_struct *vma)
{
struct goldfish_dma_context *dma = pipe->dma;
struct device *pdev_dev = pipe->dev->pdev_dev;
size_t sz_requested = vma->vm_end - vma->vm_start;
int status;
if (!check_region_size_valid(sz_requested)) {
dev_err(pdev_dev, "%s: bad size (%zu) requested\n", __func__,
sz_requested);
return -EINVAL;
}
dev_dbg(pdev_dev, "Mapping dma at 0x%llx\n", dma->phys_begin);
/* Alloc phys region if not allocated already. */
status = goldfish_pipe_dma_alloc_locked(pipe);
if (status)
return status;
status =
remap_pfn_range(
vma,
vma->vm_start,
dma->phys_begin >> PAGE_SHIFT,
sz_requested,
vma->vm_page_prot);
if (status < 0) {
dev_err(pdev_dev, "Cannot remap pfn range....\n");
return -EAGAIN;
}
vma->vm_ops = &goldfish_dma_vm_ops;
dev_dbg(pdev_dev, "goldfish_dma_mmap for host vaddr 0x%llx succeeded\n",
dma->phys_begin);
return 0;
}
/* When we call mmap() on a pipe fd, we obtain a pointer into
* the physically contiguous DMA region of the pipe device
* (Goldfish DMA).
*/
static int goldfish_dma_mmap(struct file *filp, struct vm_area_struct *vma)
{
struct goldfish_pipe *pipe =
(struct goldfish_pipe *)(filp->private_data);
int status;
if (mutex_lock_interruptible(&pipe->lock))
return -ERESTARTSYS;
status = goldfish_dma_mmap_locked(pipe, vma);
mutex_unlock(&pipe->lock);
return status;
}
static int goldfish_pipe_dma_create_region(
struct goldfish_pipe *pipe, size_t size)
{
struct goldfish_dma_context *dma =
kzalloc(sizeof(struct goldfish_dma_context), GFP_KERNEL);
struct device *pdev_dev = pipe->dev->pdev_dev;
if (dma) {
if (mutex_lock_interruptible(&pipe->lock)) {
kfree(dma);
return -ERESTARTSYS;
}
if (pipe->dma) {
mutex_unlock(&pipe->lock);
kfree(dma);
dev_err(pdev_dev, "The DMA region already allocated\n");
return -EBUSY;
}
dma->dma_size = size;
dma->pdev_dev = pipe->dev->pdev_dev;
pipe->dma = dma;
mutex_unlock(&pipe->lock);
return 0;
}
dev_err(pdev_dev, "Could not allocate DMA context info!\n");
return -ENOMEM;
}
long goldfish_dma_ioctl_getoff(struct goldfish_pipe *pipe, unsigned long arg)
{
struct device *pdev_dev = pipe->dev->pdev_dev;
struct goldfish_dma_ioctl_info ioctl_data;
struct goldfish_dma_context *dma;
BUILD_BUG_ON(FIELD_SIZEOF(struct goldfish_dma_ioctl_info, phys_begin) <
FIELD_SIZEOF(struct goldfish_dma_context, phys_begin));
if (mutex_lock_interruptible(&pipe->lock)) {
dev_err(pdev_dev, "DMA_GETOFF: the pipe is not locked\n");
return -EACCES;
}
dma = pipe->dma;
if (dma) {
ioctl_data.phys_begin = dma->phys_begin;
ioctl_data.size = dma->dma_size;
} else {
ioctl_data.phys_begin = 0;
ioctl_data.size = 0;
}
if (copy_to_user((void __user *)arg, &ioctl_data,
sizeof(ioctl_data))) {
mutex_unlock(&pipe->lock);
return -EFAULT;
}
dev_dbg(pdev_dev,
"DMA_IOC_GETOFF: phys_begin=0x%llx size=%lld\n",
ioctl_data.phys_begin, ioctl_data.size);
mutex_unlock(&pipe->lock);
return 0;
}
long goldfish_dma_ioctl_create_region(struct goldfish_pipe *pipe,
unsigned long arg)
{
struct goldfish_dma_ioctl_info ioctl_data;
if (copy_from_user(&ioctl_data, (void __user *)arg, sizeof(ioctl_data)))
return -EFAULT;
if (!check_region_size_valid(ioctl_data.size)) {
dev_err(pipe->dev->pdev_dev,
"DMA_CREATE_REGION: bad size (%lld) requested\n",
ioctl_data.size);
return -EINVAL;
}
return goldfish_pipe_dma_create_region(pipe, ioctl_data.size);
}
static long goldfish_dma_ioctl(
struct file *file, unsigned int cmd, unsigned long arg)
{
struct goldfish_pipe *pipe =
(struct goldfish_pipe *)(file->private_data);
switch (cmd) {
case GOLDFISH_DMA_IOC_LOCK:
return 0;
case GOLDFISH_DMA_IOC_UNLOCK:
wake_up_interruptible(&pipe->wake_queue);
return 0;
case GOLDFISH_DMA_IOC_GETOFF:
return goldfish_dma_ioctl_getoff(pipe, arg);
case GOLDFISH_DMA_IOC_CREATE_REGION:
return goldfish_dma_ioctl_create_region(pipe, arg);
}
return -ENOTTY;
}
static const struct file_operations goldfish_pipe_fops = {
.owner = THIS_MODULE,
.read = goldfish_pipe_read,
@ -788,6 +1138,10 @@ static const struct file_operations goldfish_pipe_fops = {
.poll = goldfish_pipe_poll,
.open = goldfish_pipe_open,
.release = goldfish_pipe_release,
/* DMA-related operations */
.mmap = goldfish_dma_mmap,
.unlocked_ioctl = goldfish_dma_ioctl,
.compat_ioctl = goldfish_dma_ioctl,
};
static struct miscdevice goldfish_pipe_miscdev = {

View file

@ -0,0 +1,83 @@
/*
* Copyright (C) 2018 Google, Inc.
*
* This software is licensed under the terms of the GNU General Public
* License version 2, as published by the Free Software Foundation, and
* may be copied, distributed, and modified under those terms.
*
* 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.
*
*/
#ifndef UAPI_GOLDFISH_DMA_H
#define UAPI_GOLDFISH_DMA_H
#include <linux/types.h>
/* GOLDFISH DMA
*
* Goldfish DMA is an extension to the pipe device
* and is designed to facilitate high-speed RAM->RAM
* transfers from guest to host.
*
* Interface (guest side):
*
* The guest user calls goldfish_dma_alloc (ioctls)
* and then mmap() on a goldfish pipe fd,
* which means that it wants high-speed access to
* host-visible memory.
*
* The guest can then write into the pointer
* returned by mmap(), and these writes
* become immediately visible on the host without BQL
* or otherweise context switching.
*
* dma_alloc_coherent() is used to obtain contiguous
* physical memory regions, and we allocate and interact
* with this region on both guest and host through
* the following ioctls:
*
* - LOCK: lock the region for data access.
* - UNLOCK: unlock the region. This may also be done from the host
* through the WAKE_ON_UNLOCK_DMA procedure.
* - CREATE_REGION: initialize size info for a dma region.
* - GETOFF: send physical address to guest drivers.
* - (UN)MAPHOST: uses goldfish_pipe_cmd to tell the host to
* (un)map to the guest physical address associated
* with the current dma context. This makes the physically
* contiguous memory (in)visible to the host.
*
* Guest userspace obtains a pointer to the DMA memory
* through mmap(), which also lazily allocates the memory
* with dma_alloc_coherent. (On last pipe close(), the region is freed).
* The mmaped() region can handle very high bandwidth
* transfers, and pipe operations can be used at the same
* time to handle synchronization and command communication.
*/
#define GOLDFISH_DMA_BUFFER_SIZE (32 * 1024 * 1024)
struct goldfish_dma_ioctl_info {
__u64 phys_begin;
__u64 size;
};
/* There is an ioctl associated with goldfish dma driver.
* Make it conflict with ioctls that are not likely to be used
* in the emulator.
* 'G' 00-3F drivers/misc/sgi-gru/grulib.h conflict!
* 'G' 00-0F linux/gigaset_dev.h conflict!
*/
#define GOLDFISH_DMA_IOC_MAGIC 'G'
#define GOLDFISH_DMA_IOC_OP(OP) _IOWR(GOLDFISH_DMA_IOC_MAGIC, OP, \
struct goldfish_dma_ioctl_info)
#define GOLDFISH_DMA_IOC_LOCK GOLDFISH_DMA_IOC_OP(0)
#define GOLDFISH_DMA_IOC_UNLOCK GOLDFISH_DMA_IOC_OP(1)
#define GOLDFISH_DMA_IOC_GETOFF GOLDFISH_DMA_IOC_OP(2)
#define GOLDFISH_DMA_IOC_CREATE_REGION GOLDFISH_DMA_IOC_OP(3)
#endif /* UAPI_GOLDFISH_DMA_H */