2017-11-19 15:05:11 +01:00
|
|
|
// SPDX-License-Identifier: GPL-2.0
|
2018-12-31 23:59:59 +01:00
|
|
|
/* Copyright (C) 2010-2019 B.A.T.M.A.N. contributors:
|
2016-05-15 23:48:31 +02:00
|
|
|
*
|
|
|
|
* Marek Lindner
|
|
|
|
*/
|
|
|
|
|
|
|
|
#include "log.h"
|
|
|
|
#include "main.h"
|
|
|
|
|
|
|
|
#include <linux/compiler.h>
|
|
|
|
#include <linux/debugfs.h>
|
|
|
|
#include <linux/errno.h>
|
2018-03-18 09:48:03 +01:00
|
|
|
#include <linux/eventpoll.h>
|
2016-05-15 23:48:31 +02:00
|
|
|
#include <linux/export.h>
|
|
|
|
#include <linux/fcntl.h>
|
|
|
|
#include <linux/fs.h>
|
2017-11-19 17:12:02 +01:00
|
|
|
#include <linux/gfp.h>
|
2016-05-15 23:48:31 +02:00
|
|
|
#include <linux/jiffies.h>
|
|
|
|
#include <linux/kernel.h>
|
|
|
|
#include <linux/module.h>
|
|
|
|
#include <linux/poll.h>
|
|
|
|
#include <linux/sched.h> /* for linux/wait.h */
|
|
|
|
#include <linux/slab.h>
|
|
|
|
#include <linux/spinlock.h>
|
|
|
|
#include <linux/stddef.h>
|
|
|
|
#include <linux/types.h>
|
|
|
|
#include <linux/uaccess.h>
|
|
|
|
#include <linux/wait.h>
|
|
|
|
#include <stdarg.h>
|
|
|
|
|
2018-08-10 23:36:15 +02:00
|
|
|
#include "debugfs.h"
|
2018-08-10 23:36:16 +02:00
|
|
|
#include "trace.h"
|
2018-08-10 23:36:15 +02:00
|
|
|
|
2018-10-21 11:30:31 +02:00
|
|
|
#ifdef CONFIG_BATMAN_ADV_DEBUGFS
|
|
|
|
|
2016-05-15 23:48:31 +02:00
|
|
|
#define BATADV_LOG_BUFF_MASK (batadv_log_buff_len - 1)
|
|
|
|
|
|
|
|
static const int batadv_log_buff_len = BATADV_LOG_BUF_LEN;
|
|
|
|
|
|
|
|
static char *batadv_log_char_addr(struct batadv_priv_debug_log *debug_log,
|
|
|
|
size_t idx)
|
|
|
|
{
|
|
|
|
return &debug_log->log_buff[idx & BATADV_LOG_BUFF_MASK];
|
|
|
|
}
|
|
|
|
|
|
|
|
static void batadv_emit_log_char(struct batadv_priv_debug_log *debug_log,
|
|
|
|
char c)
|
|
|
|
{
|
|
|
|
char *char_addr;
|
|
|
|
|
|
|
|
char_addr = batadv_log_char_addr(debug_log, debug_log->log_end);
|
|
|
|
*char_addr = c;
|
|
|
|
debug_log->log_end++;
|
|
|
|
|
|
|
|
if (debug_log->log_end - debug_log->log_start > batadv_log_buff_len)
|
|
|
|
debug_log->log_start = debug_log->log_end - batadv_log_buff_len;
|
|
|
|
}
|
|
|
|
|
|
|
|
__printf(2, 3)
|
|
|
|
static int batadv_fdebug_log(struct batadv_priv_debug_log *debug_log,
|
|
|
|
const char *fmt, ...)
|
|
|
|
{
|
|
|
|
va_list args;
|
|
|
|
static char debug_log_buf[256];
|
|
|
|
char *p;
|
|
|
|
|
|
|
|
if (!debug_log)
|
|
|
|
return 0;
|
|
|
|
|
|
|
|
spin_lock_bh(&debug_log->lock);
|
|
|
|
va_start(args, fmt);
|
|
|
|
vscnprintf(debug_log_buf, sizeof(debug_log_buf), fmt, args);
|
|
|
|
va_end(args);
|
|
|
|
|
|
|
|
for (p = debug_log_buf; *p != 0; p++)
|
|
|
|
batadv_emit_log_char(debug_log, *p);
|
|
|
|
|
|
|
|
spin_unlock_bh(&debug_log->lock);
|
|
|
|
|
|
|
|
wake_up(&debug_log->queue_wait);
|
|
|
|
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
|
|
|
|
static int batadv_log_open(struct inode *inode, struct file *file)
|
|
|
|
{
|
|
|
|
if (!try_module_get(THIS_MODULE))
|
|
|
|
return -EBUSY;
|
|
|
|
|
2018-08-10 23:36:16 +02:00
|
|
|
batadv_debugfs_deprecated(file,
|
|
|
|
"Use tracepoint batadv:batadv_dbg instead\n");
|
2018-08-10 23:36:15 +02:00
|
|
|
|
2019-03-26 21:51:19 +01:00
|
|
|
stream_open(inode, file);
|
2016-05-15 23:48:31 +02:00
|
|
|
file->private_data = inode->i_private;
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
|
|
|
|
static int batadv_log_release(struct inode *inode, struct file *file)
|
|
|
|
{
|
|
|
|
module_put(THIS_MODULE);
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
|
|
|
|
static bool batadv_log_empty(struct batadv_priv_debug_log *debug_log)
|
|
|
|
{
|
|
|
|
return !(debug_log->log_start - debug_log->log_end);
|
|
|
|
}
|
|
|
|
|
|
|
|
static ssize_t batadv_log_read(struct file *file, char __user *buf,
|
|
|
|
size_t count, loff_t *ppos)
|
|
|
|
{
|
|
|
|
struct batadv_priv *bat_priv = file->private_data;
|
|
|
|
struct batadv_priv_debug_log *debug_log = bat_priv->debug_log;
|
|
|
|
int error, i = 0;
|
|
|
|
char *char_addr;
|
|
|
|
char c;
|
|
|
|
|
|
|
|
if ((file->f_flags & O_NONBLOCK) && batadv_log_empty(debug_log))
|
|
|
|
return -EAGAIN;
|
|
|
|
|
|
|
|
if (!buf)
|
|
|
|
return -EINVAL;
|
|
|
|
|
|
|
|
if (count == 0)
|
|
|
|
return 0;
|
|
|
|
|
Remove 'type' argument from access_ok() function
Nobody has actually used the type (VERIFY_READ vs VERIFY_WRITE) argument
of the user address range verification function since we got rid of the
old racy i386-only code to walk page tables by hand.
It existed because the original 80386 would not honor the write protect
bit when in kernel mode, so you had to do COW by hand before doing any
user access. But we haven't supported that in a long time, and these
days the 'type' argument is a purely historical artifact.
A discussion about extending 'user_access_begin()' to do the range
checking resulted this patch, because there is no way we're going to
move the old VERIFY_xyz interface to that model. And it's best done at
the end of the merge window when I've done most of my merges, so let's
just get this done once and for all.
This patch was mostly done with a sed-script, with manual fix-ups for
the cases that weren't of the trivial 'access_ok(VERIFY_xyz' form.
There were a couple of notable cases:
- csky still had the old "verify_area()" name as an alias.
- the iter_iov code had magical hardcoded knowledge of the actual
values of VERIFY_{READ,WRITE} (not that they mattered, since nothing
really used it)
- microblaze used the type argument for a debug printout
but other than those oddities this should be a total no-op patch.
I tried to fix up all architectures, did fairly extensive grepping for
access_ok() uses, and the changes are trivial, but I may have missed
something. Any missed conversion should be trivially fixable, though.
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
2019-01-04 03:57:57 +01:00
|
|
|
if (!access_ok(buf, count))
|
2016-05-15 23:48:31 +02:00
|
|
|
return -EFAULT;
|
|
|
|
|
|
|
|
error = wait_event_interruptible(debug_log->queue_wait,
|
|
|
|
(!batadv_log_empty(debug_log)));
|
|
|
|
|
|
|
|
if (error)
|
|
|
|
return error;
|
|
|
|
|
|
|
|
spin_lock_bh(&debug_log->lock);
|
|
|
|
|
|
|
|
while ((!error) && (i < count) &&
|
|
|
|
(debug_log->log_start != debug_log->log_end)) {
|
|
|
|
char_addr = batadv_log_char_addr(debug_log,
|
|
|
|
debug_log->log_start);
|
|
|
|
c = *char_addr;
|
|
|
|
|
|
|
|
debug_log->log_start++;
|
|
|
|
|
|
|
|
spin_unlock_bh(&debug_log->lock);
|
|
|
|
|
|
|
|
error = __put_user(c, buf);
|
|
|
|
|
|
|
|
spin_lock_bh(&debug_log->lock);
|
|
|
|
|
|
|
|
buf++;
|
|
|
|
i++;
|
|
|
|
}
|
|
|
|
|
|
|
|
spin_unlock_bh(&debug_log->lock);
|
|
|
|
|
|
|
|
if (!error)
|
|
|
|
return i;
|
|
|
|
|
|
|
|
return error;
|
|
|
|
}
|
|
|
|
|
2017-07-03 06:01:49 +02:00
|
|
|
static __poll_t batadv_log_poll(struct file *file, poll_table *wait)
|
2016-05-15 23:48:31 +02:00
|
|
|
{
|
|
|
|
struct batadv_priv *bat_priv = file->private_data;
|
|
|
|
struct batadv_priv_debug_log *debug_log = bat_priv->debug_log;
|
|
|
|
|
|
|
|
poll_wait(file, &debug_log->queue_wait, wait);
|
|
|
|
|
|
|
|
if (!batadv_log_empty(debug_log))
|
2018-02-11 23:34:03 +01:00
|
|
|
return EPOLLIN | EPOLLRDNORM;
|
2016-05-15 23:48:31 +02:00
|
|
|
|
|
|
|
return 0;
|
|
|
|
}
|
|
|
|
|
|
|
|
static const struct file_operations batadv_log_fops = {
|
|
|
|
.open = batadv_log_open,
|
|
|
|
.release = batadv_log_release,
|
|
|
|
.read = batadv_log_read,
|
|
|
|
.poll = batadv_log_poll,
|
|
|
|
.llseek = no_llseek,
|
|
|
|
};
|
|
|
|
|
2017-12-02 19:51:53 +01:00
|
|
|
/**
|
|
|
|
* batadv_debug_log_setup() - Initialize debug log
|
|
|
|
* @bat_priv: the bat priv with all the soft interface information
|
|
|
|
*
|
|
|
|
* Return: 0 on success or negative error number in case of failure
|
|
|
|
*/
|
2016-05-15 23:48:31 +02:00
|
|
|
int batadv_debug_log_setup(struct batadv_priv *bat_priv)
|
|
|
|
{
|
|
|
|
struct dentry *d;
|
|
|
|
|
|
|
|
if (!bat_priv->debug_dir)
|
|
|
|
goto err;
|
|
|
|
|
|
|
|
bat_priv->debug_log = kzalloc(sizeof(*bat_priv->debug_log), GFP_ATOMIC);
|
|
|
|
if (!bat_priv->debug_log)
|
|
|
|
goto err;
|
|
|
|
|
|
|
|
spin_lock_init(&bat_priv->debug_log->lock);
|
|
|
|
init_waitqueue_head(&bat_priv->debug_log->queue_wait);
|
|
|
|
|
2016-09-01 10:25:12 +02:00
|
|
|
d = debugfs_create_file("log", 0400, bat_priv->debug_dir, bat_priv,
|
2016-05-15 23:48:31 +02:00
|
|
|
&batadv_log_fops);
|
|
|
|
if (!d)
|
|
|
|
goto err;
|
|
|
|
|
|
|
|
return 0;
|
|
|
|
|
|
|
|
err:
|
|
|
|
return -ENOMEM;
|
|
|
|
}
|
|
|
|
|
2017-12-02 19:51:53 +01:00
|
|
|
/**
|
|
|
|
* batadv_debug_log_cleanup() - Destroy debug log
|
|
|
|
* @bat_priv: the bat priv with all the soft interface information
|
|
|
|
*/
|
2016-05-15 23:48:31 +02:00
|
|
|
void batadv_debug_log_cleanup(struct batadv_priv *bat_priv)
|
|
|
|
{
|
|
|
|
kfree(bat_priv->debug_log);
|
|
|
|
bat_priv->debug_log = NULL;
|
|
|
|
}
|
2018-10-21 11:30:31 +02:00
|
|
|
|
|
|
|
#endif /* CONFIG_BATMAN_ADV_DEBUGFS */
|
|
|
|
|
|
|
|
/**
|
|
|
|
* batadv_debug_log() - Add debug log entry
|
|
|
|
* @bat_priv: the bat priv with all the soft interface information
|
|
|
|
* @fmt: format string
|
|
|
|
*
|
|
|
|
* Return: 0 on success or negative error number in case of failure
|
|
|
|
*/
|
|
|
|
int batadv_debug_log(struct batadv_priv *bat_priv, const char *fmt, ...)
|
|
|
|
{
|
|
|
|
struct va_format vaf;
|
|
|
|
va_list args;
|
|
|
|
|
|
|
|
va_start(args, fmt);
|
|
|
|
|
|
|
|
vaf.fmt = fmt;
|
|
|
|
vaf.va = &args;
|
|
|
|
|
|
|
|
#ifdef CONFIG_BATMAN_ADV_DEBUGFS
|
|
|
|
batadv_fdebug_log(bat_priv->debug_log, "[%10u] %pV",
|
|
|
|
jiffies_to_msecs(jiffies), &vaf);
|
|
|
|
#endif
|
|
|
|
|
|
|
|
trace_batadv_dbg(bat_priv, &vaf);
|
|
|
|
|
|
|
|
va_end(args);
|
|
|
|
|
|
|
|
return 0;
|
|
|
|
}
|