M7350/kernel/drivers/gud/MobiCoreDriver/client.c

/*
 * Copyright (c) 2013-2015 TRUSTONIC LIMITED
 * All Rights Reserved.
 *
 * 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.
 */
#include <linux/list.h>
#include <linux/slab.h>
#include <linux/device.h>
#include <linux/mm.h>
#include <linux/sched.h>
#include <linux/err.h>

#include "public/mc_linux.h"
#include "public/mc_admin.h"

#include "main.h"
#include "debug.h"
#include "mcp.h"
#include "mmu.h"
#include "session.h"
#include "client.h"

/*
 * Contiguous buffer allocated to TLCs.
 * These buffers are used as world shared memory (wsm) to share with
 * secure world.
 */
struct tbase_cbuf {
	/* Client this cbuf belongs to */
	struct tbase_client	*client;
	/* List element for client's list of cbuf's */
	struct list_head	list;
	/* Number of references kept to this buffer */
	struct kref		kref;
	/* virtual Kernel start address */
	uintptr_t		addr;
	/* virtual Userspace start address */
	uintptr_t		uaddr;
	/* physical start address */
	phys_addr_t		phys;
	/* 2^order = number of pages allocated */
	unsigned int		order;
	/* Length of memory mapped to user */
	uint32_t		len;
};

/*
 * Map a kernel contiguous buffer to user space
 */
static int map_cbuf(struct vm_area_struct *vmarea, uintptr_t addr, uint32_t len,
		    uintptr_t *uaddr)
{
	int ret;

	if (WARN(!uaddr, "No uaddr pointer available"))
		return -EINVAL;

	if (WARN(!vmarea, "No vma available"))
		return -EINVAL;

	if (WARN(!addr, "No addr available"))
		return -EINVAL;

	if (len != (uint32_t)(vmarea->vm_end - vmarea->vm_start)) {
		MCDRV_ERROR("cbuf incompatible with vma");
		return -EINVAL;
	}

	vmarea->vm_flags |= VM_IO;

	/* CPI todo: use io_remap_page_range() to be consistent with VM_IO ? */
	ret = remap_pfn_range(vmarea, vmarea->vm_start,
			      page_to_pfn(virt_to_page(addr)),
			      vmarea->vm_end - vmarea->vm_start,
			      vmarea->vm_page_prot);
	if (ret) {
		*uaddr = 0;
		MCDRV_ERROR("User mapping failed");
		return ret;
	}

	*uaddr = vmarea->vm_start;
	return 0;
}

/*
 * Allocate and initialize a client object
 */
struct tbase_client *client_create(bool is_from_kernel)
{
	struct tbase_client *client;

	/* allocate client structure */
	client = kzalloc(sizeof(*client), GFP_KERNEL);
	if (!client) {
		MCDRV_ERROR("Allocation failure");
		return NULL;
	}

	/* init members */
	client->pid = is_from_kernel ? 0 : current->pid;
	memcpy(client->comm, current->comm, sizeof(client->comm));
	kref_init(&client->kref);
	INIT_LIST_HEAD(&client->cbufs);
	mutex_init(&client->cbufs_lock);
	INIT_LIST_HEAD(&client->sessions);
	mutex_init(&client->sessions_lock);
	INIT_LIST_HEAD(&client->list);

	return client;
}

/*
 * At this point, nobody has access to the client anymore, so no new sessions
 * are coming.
 */
void client_close_sessions(struct tbase_client *client)
{
	struct tbase_session *session;

	mutex_lock(&client->sessions_lock);
	while (!list_empty(&client->sessions)) {
		session = list_first_entry(&client->sessions,
					   struct tbase_session, list);

		/* Move session to closing sessions list */
		mutex_lock(&g_ctx.closing_lock);
		list_move(&session->list, &g_ctx.closing_sess);
		mutex_unlock(&g_ctx.closing_lock);
		/* Call session_close without lock */
		mutex_unlock(&client->sessions_lock);
		session_close(session);
		mutex_lock(&client->sessions_lock);
	}

	mutex_unlock(&client->sessions_lock);
}

/*
 * Free client object + all objects it contains.
 * Can be called only by last user referencing the client,
 * therefore mutex lock seems overkill
 */
static void client_release(struct kref *kref)
{
	struct tbase_client *client;

	client = container_of(kref, struct tbase_client, kref);
	kfree(client);
}

void client_put(struct tbase_client *client)
{
	kref_put(&client->kref, client_release);
}

/*
 * Returns true if client is a kernel object.
 */
bool client_is_kernel(struct tbase_client *client)
{
	return !client->pid;
}

/*
 * Set client "closing" state, only if it contains no session.
 * Once in "closing" state, system "close" can be called.
 * Return: true if this state could be set.
 */
bool client_set_closing(struct tbase_client *client)
{
	bool clear = false;

	/* Check for sessions */
	mutex_lock(&client->sessions_lock);
	clear = list_empty(&client->sessions);
	client->closing = clear;
	mutex_unlock(&client->sessions_lock);
	MCDRV_DBG("return %d", clear);
	return clear;
}

/*
 * Opens a TA and add corresponding session object to given client
 * return: t-base driver error code
 */
int client_add_session(struct tbase_client *client,
		       const struct tbase_object *obj, uintptr_t tci,
		       size_t len, uint32_t *session_id, bool is_gp,
		       struct mc_identity *identity)
{
	struct tbase_session *session = NULL;
	struct tbase_mmu *obj_mmu = NULL;
	int ret = 0;

	/*
	 * Create session object with temp sid=0 BEFORE session is started,
	 * otherwise if a GP TA is started and NWd session object allocation
	 * fails, we cannot handle the potentially delayed GP closing.
	 * Adding session to list must be done AFTER it is started (once we have
	 * sid), therefore it cannot be done within session_create().
	 */
	session = session_create(client, is_gp, identity);
	if (IS_ERR(session))
		return PTR_ERR(session);

	/* Create blob L2 table (blob is allocated by driver, so task=NULL) */
	obj_mmu = tbase_mmu_create(NULL, obj->data, obj->length);
	if (IS_ERR(obj_mmu)) {
		ret = PTR_ERR(obj_mmu);
		goto err;
	}

	/* Open session */
	ret = session_open(session, obj, obj_mmu, tci, len);
	/* Blob table no more needed in any case */
	tbase_mmu_delete(obj_mmu);
	if (ret)
		goto err;

	mutex_lock(&client->sessions_lock);
	if (unlikely(client->closing)) {
		/* Client has been frozen, no more sessions allowed */
		ret = -ENODEV;
	} else {
		/* Add session to client */
		list_add(&session->list, &client->sessions);
		/* Set sid returned by SWd */
		*session_id = session->mcp_session.id;
	}

	mutex_unlock(&client->sessions_lock);

err:
	/* Close or free session on error */
	if (ret == -ENODEV) {
		/* The session must enter the closing process... */
		mutex_lock(&g_ctx.closing_lock);
		list_add(&session->list, &g_ctx.closing_sess);
		mutex_unlock(&g_ctx.closing_lock);
		session_close(session);
	} else if (ret) {
		session_put(session);
	}

	return ret;
}

/*
 * Remove a session object from client and close corresponding TA
 * Return: true if session was found and closed
 */
int client_remove_session(struct tbase_client *client, uint32_t session_id)
{
	struct tbase_session *session = NULL, *candidate;

	/* Move session from main list to closing list */
	mutex_lock(&client->sessions_lock);
	list_for_each_entry(candidate, &client->sessions, list) {
		if (candidate->mcp_session.id == session_id) {
			session = candidate;
			mutex_lock(&g_ctx.closing_lock);
			list_move(&session->list, &g_ctx.closing_sess);
			mutex_unlock(&g_ctx.closing_lock);
			break;
		}
	}

	mutex_unlock(&client->sessions_lock);

	/* Close session */
	return session_close(session);
}

/*
 * Find a session object and increment its reference counter.
 * Object cannot be freed until its counter reaches 0.
 * return: pointer to the object, NULL if not found.
 */
struct tbase_session *client_ref_session(struct tbase_client *client,
					 uint32_t session_id)
{
	struct tbase_session *session = NULL, *candidate;

	mutex_lock(&client->sessions_lock);
	list_for_each_entry(candidate, &client->sessions, list) {
		if (candidate->mcp_session.id == session_id) {
			session = candidate;
			session_get(session);
			break;
		}
	}

	mutex_unlock(&client->sessions_lock);
	return session;
}

/*
 * Decrement a session object's reference counter, and frees the object if it
 * was the last reference.
 * No lookup since session may have been removed from list
 */
void client_unref_session(struct tbase_session *session)
{
	session_put(session);
}

static inline int cbuf_info(struct tbase_cbuf *cbuf,
			    struct kasnprintf_buf *buf);

int client_info(struct tbase_client *client, struct kasnprintf_buf *buf)
{
	struct tbase_cbuf *cbuf;
	struct tbase_session *session;
	int ret;

	if (client->pid)
		ret = kasnprintf(buf, "client %p: %s (%d)\n", client,
				 client->comm, client->pid);
	else
		ret = kasnprintf(buf, "client %p: [kernel]\n", client);

	if (ret < 0)
		return ret;

	/* Buffers */
	mutex_lock(&client->cbufs_lock);
	if (list_empty(&client->cbufs))
		goto done_cbufs;

	list_for_each_entry(cbuf, &client->cbufs, list) {
		ret = cbuf_info(cbuf, buf);
		if (ret < 0)
			goto done_cbufs;
	}

done_cbufs:
	mutex_unlock(&client->cbufs_lock);
	if (ret < 0)
		return ret;

	/* Sessions */
	mutex_lock(&client->sessions_lock);
	if (list_empty(&client->sessions))
		goto done_sessions;

	list_for_each_entry(session, &client->sessions, list) {
		ret = session_info(session, buf);
		if (ret < 0)
			goto done_sessions;
	}

done_sessions:
	mutex_unlock(&client->sessions_lock);

	if (ret < 0)
		return ret;

	return 0;
}

/*
 * This callback is called on remap
 */
static void cbuf_vm_open(struct vm_area_struct *vmarea)
{
	struct tbase_cbuf *cbuf = vmarea->vm_private_data;

	tbase_cbuf_get(cbuf);
}

/*
 * This callback is called on unmap
 */
static void cbuf_vm_close(struct vm_area_struct *vmarea)
{
	struct tbase_cbuf *cbuf = vmarea->vm_private_data;

	tbase_cbuf_put(cbuf);
}

static struct vm_operations_struct cbuf_vm_ops = {
	.open = cbuf_vm_open,
	.close = cbuf_vm_close,
};

/*
 * Create a cbuf object and add it to client
 */
int tbase_cbuf_alloc(struct tbase_client *client, uint32_t len,
		     uintptr_t *p_addr,
		     struct vm_area_struct *vmarea)
{
	int err = 0;
	struct tbase_cbuf *cbuf = NULL;
	unsigned int order;

	if (WARN(!client, "No client available"))
		return -EINVAL;

	if (WARN(!len, "No len available"))
		return -EINVAL;

	order = get_order(len);
	if (order > MAX_ORDER) {
		MCDRV_DBG_WARN("Buffer size too large");
		return -ENOMEM;
	}

	/* Allocate buffer descriptor structure */
	cbuf = kzalloc(sizeof(*cbuf), GFP_KERNEL);
	if (!cbuf) {
		MCDRV_DBG_WARN("kzalloc failed");
		return -ENOMEM;
	}

	/* Allocate buffer */
	cbuf->addr = __get_free_pages(GFP_USER | __GFP_ZERO, order);
	if (!cbuf->addr) {
		MCDRV_DBG_WARN("get_free_pages failed");
		kfree(cbuf);
		return -ENOMEM;
	}

	/* Map to user space if applicable */
	if (!client_is_kernel(client)) {
		err = map_cbuf(vmarea, cbuf->addr, len, &cbuf->uaddr);
		if (err) {
			free_pages(cbuf->addr, order);
			kfree(cbuf);
			return err;
		}
	}

	/* Init descriptor members */
	cbuf->client = client;
	cbuf->phys = virt_to_phys((void *)cbuf->addr);
	cbuf->len = len;
	cbuf->order = order;
	kref_init(&cbuf->kref);
	INIT_LIST_HEAD(&cbuf->list);

	/* Keep cbuf in VMA private data for refcounting (user-space clients) */
	if (vmarea) {
		vmarea->vm_private_data = cbuf;
		vmarea->vm_ops = &cbuf_vm_ops;
	}

	/* Fill return parameter for k-api */
	if (p_addr)
		*p_addr = cbuf->addr;

	/* Get a token on the client */
	client_get(client);

	/* Add buffer to list */
	mutex_lock(&client->cbufs_lock);
	list_add(&cbuf->list, &client->cbufs);
	mutex_unlock(&client->cbufs_lock);
	MCDRV_DBG("created cbuf %p: client %p addr %lx uaddr %lx len %u",
		  cbuf, client, cbuf->addr, cbuf->uaddr, cbuf->len);
	return err;
}

/*
 * Remove a cbuf object from client, and mark it for freeing.
 * Freeing will happen once all current references are released.
 */
int tbase_cbuf_free(struct tbase_client *client, uintptr_t addr)
{
	struct tbase_cbuf *cbuf = tbase_cbuf_get_by_addr(client, addr);

	if (!cbuf)
		return -EINVAL;

	/* Two references to put: the caller's and the one we just took */
	tbase_cbuf_put(cbuf);
	tbase_cbuf_put(cbuf);
	return 0;
}

/*
 * Find a contiguous buffer (cbuf) in the cbuf list of given client that
 * contains given address and take a reference on it.
 * Return pointer to the object, or NULL if not found.
 */
struct tbase_cbuf *tbase_cbuf_get_by_addr(struct tbase_client *client,
					  uintptr_t addr)
{
	struct tbase_cbuf *cbuf = NULL, *candidate;
	bool is_kernel = client_is_kernel(client);

	mutex_lock(&client->cbufs_lock);
	list_for_each_entry(candidate, &client->cbufs, list) {
		/* Compare Vs kernel va OR user va depending on client type */
		uintptr_t start = is_kernel ?
			candidate->addr : candidate->uaddr;
		uintptr_t end = start + candidate->len;

		/* Check that (user) cbuf has not been unmapped */
		if (!start)
			break;

		if ((addr >= start) && (addr < end)) {
			cbuf = candidate;
			break;
		}
	}

	if (cbuf)
		tbase_cbuf_get(cbuf);

	mutex_unlock(&client->cbufs_lock);
	return cbuf;
}

void tbase_cbuf_get(struct tbase_cbuf *cbuf)
{
	kref_get(&cbuf->kref);
}

static void cbuf_release(struct kref *kref)
{
	struct tbase_cbuf *cbuf = container_of(kref, struct tbase_cbuf, kref);
	struct tbase_client *client = cbuf->client;

	/* Unlist from client */
	mutex_lock(&client->cbufs_lock);
	list_del_init(&cbuf->list);
	mutex_unlock(&client->cbufs_lock);
	/* Release client token */
	client_put(client);
	/* Free */
	free_pages(cbuf->addr, cbuf->order);
	MCDRV_DBG("freed cbuf %p: client %p addr %lx uaddr %lx len %u",
		  cbuf, client, cbuf->addr, cbuf->uaddr, cbuf->len);
	kfree(cbuf);
}

void tbase_cbuf_put(struct tbase_cbuf *cbuf)
{
	kref_put(&cbuf->kref, cbuf_release);
}

uintptr_t tbase_cbuf_addr(struct tbase_cbuf *cbuf)
{
	return cbuf->addr;
}

uintptr_t tbase_cbuf_uaddr(struct tbase_cbuf *cbuf)
{
	return cbuf->uaddr;
}

uint32_t tbase_cbuf_len(struct tbase_cbuf *cbuf)
{
	return cbuf->len;
}

static inline int cbuf_info(struct tbase_cbuf *cbuf, struct kasnprintf_buf *buf)
{
	return kasnprintf(buf, "\tcbuf %p: addr %lx uaddr %lx len %u\n",
			  cbuf, cbuf->addr, cbuf->uaddr, cbuf->len);
}