kernel-brax3-ubuntu-touch/drivers/tee/gud/510/MobiCoreDriver/logging.c

// SPDX-License-Identifier: GPL-2.0
/*
 * Copyright (c) 2013-2019 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/kthread.h>
#include <linux/mutex.h>
#include <linux/slab.h>
#include <linux/device.h>
#include <linux/debugfs.h>
#include <linux/version.h>

#include "main.h"
#include "fastcall.h"
#include "mci/mclog.h"
#include "logging.h"
#include "nq.h"

/* Supported log buffer version */
#define MC_LOG_VERSION			3

/* Default length of the log ring buffer 256KiB */
#define LOG_BUF_ORDER			6

/* Max Len of a log line for printing */
#define LOG_LINE_SIZE			256

struct mc_logmsg {
	u16	source;		/* Unique value for each event source */
	u8	cpuid;		/* CPU id */
	u8	log_data;	/* Value */
};

/* MobiCore internal trace buffer structure. */
struct mc_trace_buf {
	u32	version;	/* version of trace buffer */
	u32	length;		/* length of buff */
	u32	head;		/* last write position */
	u32	tail;		/* last read position */
	u8	buff[];		/* start of the log buffer */
};

static struct logging_ctx {
	struct kthread_work work;
	struct kthread_worker worker;
	struct task_struct *thread;
	union {
		struct mc_trace_buf *trace_buf;	/* Circular log buffer */
		unsigned long trace_page;
	};
	int	thread_err;
	u16	prev_source;		/* Previous Log source */
	char	line[LOG_LINE_SIZE + 1];/* Log Line buffer */
	u32	line_len;		/* Log Line buffer current length */
	u32	line_log_level;		/* Log Line log message level */
	bool	dead;
	u32	log_level;		/* Kinibi trace level */
} log_ctx;

static inline void dev_print_level(u16 prev_source, u32 cpuid)
{
	/* Choosing print function according to the log level value */
	switch (log_ctx.line_log_level) {
	case LOG_ERROR:
		if (prev_source)
			/* TEE user-space */
			dev_err(g_ctx.mcd, "%03x(%u)|%s\n", prev_source,
				cpuid, log_ctx.line);
		else
			/* TEE kernel */
			dev_err(g_ctx.mcd, "mtk(%u)|%s\n",
				cpuid, log_ctx.line);
		break;
	case LOG_INFO:
		if (prev_source)
			/* TEE user-space */
			dev_notice(g_ctx.mcd, "%03x(%u)|%s\n", prev_source,
				   cpuid, log_ctx.line);
		else
			/* TEE kernel */
			dev_notice(g_ctx.mcd, "mtk(%u)|%s\n",
				   cpuid, log_ctx.line);
		break;
	default:
		if (prev_source)
			/* TEE user-space */
			dev_info(g_ctx.mcd, "%03x(%u)|%s\n", prev_source,
				 cpuid, log_ctx.line);
		else
			/* TEE kernel */
			dev_info(g_ctx.mcd, "mtk(%u)|%s\n",
				 cpuid, log_ctx.line);
		break;
	}
}

static inline void log_eol(u32 cpuid)
{
	if (!log_ctx.line_len)
		return;

	dev_print_level(log_ctx.prev_source, cpuid);
	log_ctx.line[0] = '\0';
	log_ctx.line_len = 0;
	log_ctx.line_log_level = 0;
}

/*
 * Collect chars in log_ctx.line buffer and output the buffer when it is full.
 * No locking needed because only "mobicore_log" thread updates this buffer.
 */
static inline void log_char(char ch, u16 source, u32 cpuid)
{
	if (ch == '\0')
		return;

	if (ch == '\n') {
		log_eol(cpuid);
		return;
	}

	if (log_ctx.line_len >= LOG_LINE_SIZE ||
	    source != log_ctx.prev_source) {
		log_eol(cpuid);
		/* This is useless but some static analysis tools want it */
		log_ctx.line_len = 0;
	}

	/* If this is the character that identifies the level let's set it as
	 * current level and not add it to the string line
	 */
	if (ch >= LOG_ERROR && ch <= LOG_DEBUG) {
		log_ctx.line_log_level = ch;
	} else {
		log_ctx.line[log_ctx.line_len++] = ch;
		log_ctx.line[log_ctx.line_len] = 0;
	}
	log_ctx.prev_source = source;
}

static inline int log_msg(void *data)
{
	struct mc_logmsg *msg = (struct mc_logmsg *)data;

	log_char(msg->log_data, msg->source, msg->cpuid);
	return sizeof(*msg);
}

static void logging_worker(struct kthread_work *work)
{
	static DEFINE_MUTEX(local_mutex);

	mutex_lock(&local_mutex);
	while (log_ctx.trace_buf->head != log_ctx.trace_buf->tail) {
		u32 tail = log_ctx.trace_buf->tail;

		if (log_ctx.trace_buf->version != MC_LOG_VERSION) {
			mc_dev_err(-EINVAL, "Bad log data v%d (exp. v%d), stop",
				   log_ctx.trace_buf->version, MC_LOG_VERSION);
			log_ctx.dead = true;
			break;
		}

		tail += log_msg(&log_ctx.trace_buf->buff[tail]);
		/* Wrap over if no space left for a complete message */
		if (tail >= log_ctx.trace_buf->length)
			tail = 0;
		log_ctx.trace_buf->tail = tail;
	}
	mutex_unlock(&local_mutex);
}

static int logging_set_trace_level(u32 log_level)
{
	int ret = -EINVAL;
	cpumask_t old_affinity;

	if (log_level < LOG_ERROR ||
	    log_level > LOG_DEBUG) {
		mc_dev_err(ret,
			   "log_level value must be in following range: [%d,%d]",
			   LOG_ERROR, LOG_DEBUG);
		return ret;
	}

	if (log_level == log_ctx.log_level) {
		mc_dev_devel("log_level is already set to = %u",
			     log_level);
		return 0;
	}

	old_affinity = tee_set_affinity();
	ret = fc_trace_set_level(log_level);
	tee_restore_affinity(old_affinity);

	if (ret) {
		mc_dev_err(ret, "Setting the log_level in TEE failed");
		return ret;
	}

	log_ctx.log_level = log_level;
	mc_dev_devel("log_level is set to = %u",
		     log_ctx.log_level);
	return 0;
}

static ssize_t logging_log_level_write(struct file *file,
				       const char __user *buffer,
				       size_t buffer_len, loff_t *x)
{
	u32 log_level = 0;
	int ret = -EINVAL;

	if (buffer_len < 1) {
		mc_dev_err(ret, "Incorrect input value for log_level");
		return ret;
	}

	if (kstrtouint_from_user(buffer, buffer_len, 16, &log_level)) {
		mc_dev_err(ret, "Non-integer input value for log_level");
		return ret;
	}

	ret = logging_set_trace_level(log_level);
	if (!ret)
		return buffer_len;
	else
		return ret;
}

static ssize_t logging_log_level_read(struct file *file, char __user *buffer,
				      size_t buffer_len, loff_t *ppos)
{
	char log_level_str[8];
	int ret = 0;

	ret = snprintf(log_level_str, sizeof(log_level_str), "%u\n",
		       log_ctx.log_level);
	if (ret < 0) {
		mc_dev_err(ret, "Failed to obtained the log_level");
		return -EINVAL;
	}

	return simple_read_from_buffer(buffer, buffer_len, ppos,
				       log_level_str, ret);
}

static const struct file_operations mc_logging_log_level_ops = {
	.write = logging_log_level_write,
	.read = logging_log_level_read,
};

/*
 * Wake up the log reader thread
 * This should be called from the places where calls into MobiCore have
 * generated some logs(eg, yield, SIQ...)
 */
void logging_run(void)
{
	if (!log_ctx.dead && log_ctx.trace_buf->head != log_ctx.trace_buf->tail)
#if KERNEL_VERSION(4, 9, 0) > LINUX_VERSION_CODE
		queue_kthread_work(&log_ctx.worker, &log_ctx.work);
#else
		kthread_queue_work(&log_ctx.worker, &log_ctx.work);
#endif
}

/*
 * Setup MobiCore kernel log. It assumes it's running on CORE 0!
 * The fastcall will complain if that is not the case!
 */
int logging_init(phys_addr_t *buffer, u32 *size)
{
	/*
	 * We are going to map this buffer into virtual address space in SWd.
	 * To reduce complexity there, we use a contiguous buffer.
	 */
	log_ctx.trace_page = __get_free_pages(GFP_KERNEL | __GFP_ZERO,
					      LOG_BUF_ORDER);
	if (!log_ctx.trace_page)
		return -ENOMEM;

	*buffer = virt_to_phys((void *)(log_ctx.trace_page));
	*size = BIT(LOG_BUF_ORDER) * PAGE_SIZE;

	/* Logging thread */
#if KERNEL_VERSION(4, 9, 0) > LINUX_VERSION_CODE
	init_kthread_work(&log_ctx.work, logging_worker);
	init_kthread_worker(&log_ctx.worker);
#else
	kthread_init_work(&log_ctx.work, logging_worker);
	kthread_init_worker(&log_ctx.worker);
#endif
	log_ctx.thread = kthread_create(kthread_worker_fn, &log_ctx.worker,
					"tee_log");
	if (IS_ERR(log_ctx.thread))
		return PTR_ERR(log_ctx.thread);

	wake_up_process(log_ctx.thread);

	return 0;
}

int logging_trace_level_init(void)
{
	int ret = 0;

	/* Trace level */
	log_ctx.log_level = LOG_DEBUG;

	ret = logging_set_trace_level(LOG_ERROR);
	if (!ret)
		/* Create tee log_level debugfs entry */
		debugfs_create_file(
				    "dbg_log_level", 0600,
				    g_ctx.debug_dir, NULL,
				    &mc_logging_log_level_ops);
	return ret;
}

void logging_exit(bool buffer_busy)
{
	/*
	 * This is not racey as the only caller for logging_run is the
	 * scheduler which gets stopped before us, and long before we exit.
	 */
	kthread_stop(log_ctx.thread);
	if (!buffer_busy)
		free_pages(log_ctx.trace_page, LOG_BUF_ORDER);
}