[deliverable/linux.git] / net / batman-adv / debugfs.c

/* Copyright (C) 2010-2016  B.A.T.M.A.N. contributors:
 *
 * Marek Lindner
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of version 2 of the GNU General Public
 * License 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 "debugfs.h"
#include "main.h"

#include <linux/compiler.h>
#include <linux/debugfs.h>
#include <linux/device.h>
#include <linux/errno.h>
#include <linux/export.h>
#include <linux/fcntl.h>
#include <linux/fs.h>
#include <linux/jiffies.h>
#include <linux/kernel.h>
#include <linux/module.h>
#include <linux/netdevice.h>
#include <linux/poll.h>
#include <linux/printk.h>
#include <linux/sched.h> /* for linux/wait.h */
#include <linux/seq_file.h>
#include <linux/slab.h>
#include <linux/spinlock.h>
#include <linux/stat.h>
#include <linux/stddef.h>
#include <linux/stringify.h>
#include <linux/sysfs.h>
#include <linux/types.h>
#include <linux/uaccess.h>
#include <linux/wait.h>
#include <stdarg.h>

#include "bridge_loop_avoidance.h"
#include "distributed-arp-table.h"
#include "gateway_client.h"
#include "icmp_socket.h"
#include "network-coding.h"
#include "originator.h"
#include "translation-table.h"

static struct dentry *batadv_debugfs;

#ifdef CONFIG_BATMAN_ADV_DEBUG
#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;
}

int batadv_debug_log(struct batadv_priv *bat_priv, const char *fmt, ...)
{
	va_list args;
	char tmp_log_buf[256];

	va_start(args, fmt);
	vscnprintf(tmp_log_buf, sizeof(tmp_log_buf), fmt, args);
	batadv_fdebug_log(bat_priv->debug_log, "[%10u] %s",
			  jiffies_to_msecs(jiffies), tmp_log_buf);
	va_end(args);

	return 0;
}

static int batadv_log_open(struct inode *inode, struct file *file)
{
	if (!try_module_get(THIS_MODULE))
		return -EBUSY;

	nonseekable_open(inode, file);
	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;

	if (!access_ok(VERIFY_WRITE, buf, count))
		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;
}

static unsigned int batadv_log_poll(struct file *file, poll_table *wait)
{
	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))
		return POLLIN | POLLRDNORM;

	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,
};

static 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);

	d = debugfs_create_file("log", S_IFREG | S_IRUSR,
				bat_priv->debug_dir, bat_priv,
				&batadv_log_fops);
	if (!d)
		goto err;

	return 0;

err:
	return -ENOMEM;
}

static void batadv_debug_log_cleanup(struct batadv_priv *bat_priv)
{
	kfree(bat_priv->debug_log);
	bat_priv->debug_log = NULL;
}
#else /* CONFIG_BATMAN_ADV_DEBUG */
static int batadv_debug_log_setup(struct batadv_priv *bat_priv)
{
	return 0;
}

static void batadv_debug_log_cleanup(struct batadv_priv *bat_priv)
{
}
#endif

static int batadv_algorithms_open(struct inode *inode, struct file *file)
{
	return single_open(file, batadv_algo_seq_print_text, NULL);
}

static int neighbors_open(struct inode *inode, struct file *file)
{
	struct net_device *net_dev = (struct net_device *)inode->i_private;

	return single_open(file, batadv_hardif_neigh_seq_print_text, net_dev);
}

static int batadv_originators_open(struct inode *inode, struct file *file)
{
	struct net_device *net_dev = (struct net_device *)inode->i_private;

	return single_open(file, batadv_orig_seq_print_text, net_dev);
}

/**
 * batadv_originators_hardif_open - handles debugfs output for the
 *  originator table of an hard interface
 * @inode: inode pointer to debugfs file
 * @file: pointer to the seq_file
 *
 * Return: 0 on success or negative error number in case of failure
 */
static int batadv_originators_hardif_open(struct inode *inode,
					  struct file *file)
{
	struct net_device *net_dev = (struct net_device *)inode->i_private;

	return single_open(file, batadv_orig_hardif_seq_print_text, net_dev);
}

static int batadv_gateways_open(struct inode *inode, struct file *file)
{
	struct net_device *net_dev = (struct net_device *)inode->i_private;

	return single_open(file, batadv_gw_client_seq_print_text, net_dev);
}

static int batadv_transtable_global_open(struct inode *inode, struct file *file)
{
	struct net_device *net_dev = (struct net_device *)inode->i_private;

	return single_open(file, batadv_tt_global_seq_print_text, net_dev);
}

#ifdef CONFIG_BATMAN_ADV_BLA
static int batadv_bla_claim_table_open(struct inode *inode, struct file *file)
{
	struct net_device *net_dev = (struct net_device *)inode->i_private;

	return single_open(file, batadv_bla_claim_table_seq_print_text,
			   net_dev);
}

static int batadv_bla_backbone_table_open(struct inode *inode,
					  struct file *file)
{
	struct net_device *net_dev = (struct net_device *)inode->i_private;

	return single_open(file, batadv_bla_backbone_table_seq_print_text,
			   net_dev);
}

#endif

#ifdef CONFIG_BATMAN_ADV_DAT
/**
 * batadv_dat_cache_open - Prepare file handler for reads from dat_chache
 * @inode: inode which was opened
 * @file: file handle to be initialized
 *
 * Return: 0 on success or negative error number in case of failure
 */
static int batadv_dat_cache_open(struct inode *inode, struct file *file)
{
	struct net_device *net_dev = (struct net_device *)inode->i_private;

	return single_open(file, batadv_dat_cache_seq_print_text, net_dev);
}
#endif

static int batadv_transtable_local_open(struct inode *inode, struct file *file)
{
	struct net_device *net_dev = (struct net_device *)inode->i_private;

	return single_open(file, batadv_tt_local_seq_print_text, net_dev);
}

struct batadv_debuginfo {
	struct attribute attr;
	const struct file_operations fops;
};

#ifdef CONFIG_BATMAN_ADV_NC
static int batadv_nc_nodes_open(struct inode *inode, struct file *file)
{
	struct net_device *net_dev = (struct net_device *)inode->i_private;

	return single_open(file, batadv_nc_nodes_seq_print_text, net_dev);
}
#endif

#define BATADV_DEBUGINFO(_name, _mode, _open)		\
struct batadv_debuginfo batadv_debuginfo_##_name = {	\
	.attr = {					\
		.name = __stringify(_name),		\
		.mode = _mode,				\
	},						\
	.fops = {					\
		.owner = THIS_MODULE,			\
		.open = _open,				\
		.read	= seq_read,			\
		.llseek = seq_lseek,			\
		.release = single_release,		\
	},						\
}

/* the following attributes are general and therefore they will be directly
 * placed in the BATADV_DEBUGFS_SUBDIR subdirectory of debugfs
 */
static BATADV_DEBUGINFO(routing_algos, S_IRUGO, batadv_algorithms_open);

static struct batadv_debuginfo *batadv_general_debuginfos[] = {
	&batadv_debuginfo_routing_algos,
	NULL,
};

/* The following attributes are per soft interface */
static BATADV_DEBUGINFO(neighbors, S_IRUGO, neighbors_open);
static BATADV_DEBUGINFO(originators, S_IRUGO, batadv_originators_open);
static BATADV_DEBUGINFO(gateways, S_IRUGO, batadv_gateways_open);
static BATADV_DEBUGINFO(transtable_global, S_IRUGO,
			batadv_transtable_global_open);
#ifdef CONFIG_BATMAN_ADV_BLA
static BATADV_DEBUGINFO(bla_claim_table, S_IRUGO, batadv_bla_claim_table_open);
static BATADV_DEBUGINFO(bla_backbone_table, S_IRUGO,
			batadv_bla_backbone_table_open);
#endif
#ifdef CONFIG_BATMAN_ADV_DAT
static BATADV_DEBUGINFO(dat_cache, S_IRUGO, batadv_dat_cache_open);
#endif
static BATADV_DEBUGINFO(transtable_local, S_IRUGO,
			batadv_transtable_local_open);
#ifdef CONFIG_BATMAN_ADV_NC
static BATADV_DEBUGINFO(nc_nodes, S_IRUGO, batadv_nc_nodes_open);
#endif

static struct batadv_debuginfo *batadv_mesh_debuginfos[] = {
	&batadv_debuginfo_neighbors,
	&batadv_debuginfo_originators,
	&batadv_debuginfo_gateways,
	&batadv_debuginfo_transtable_global,
#ifdef CONFIG_BATMAN_ADV_BLA
	&batadv_debuginfo_bla_claim_table,
	&batadv_debuginfo_bla_backbone_table,
#endif
#ifdef CONFIG_BATMAN_ADV_DAT
	&batadv_debuginfo_dat_cache,
#endif
	&batadv_debuginfo_transtable_local,
#ifdef CONFIG_BATMAN_ADV_NC
	&batadv_debuginfo_nc_nodes,
#endif
	NULL,
};

#define BATADV_HARDIF_DEBUGINFO(_name, _mode, _open)		\
struct batadv_debuginfo batadv_hardif_debuginfo_##_name = {	\
	.attr = {						\
		.name = __stringify(_name),			\
		.mode = _mode,					\
	},							\
	.fops = {						\
		.owner = THIS_MODULE,				\
		.open = _open,					\
		.read	= seq_read,				\
		.llseek = seq_lseek,				\
		.release = single_release,			\
	},							\
}

static BATADV_HARDIF_DEBUGINFO(originators, S_IRUGO,
			       batadv_originators_hardif_open);

static struct batadv_debuginfo *batadv_hardif_debuginfos[] = {
	&batadv_hardif_debuginfo_originators,
	NULL,
};

void batadv_debugfs_init(void)
{
	struct batadv_debuginfo **bat_debug;
	struct dentry *file;

	batadv_debugfs = debugfs_create_dir(BATADV_DEBUGFS_SUBDIR, NULL);
	if (batadv_debugfs == ERR_PTR(-ENODEV))
		batadv_debugfs = NULL;

	if (!batadv_debugfs)
		goto err;

	for (bat_debug = batadv_general_debuginfos; *bat_debug; ++bat_debug) {
		file = debugfs_create_file(((*bat_debug)->attr).name,
					   S_IFREG | ((*bat_debug)->attr).mode,
					   batadv_debugfs, NULL,
					   &(*bat_debug)->fops);
		if (!file) {
			pr_err("Can't add general debugfs file: %s\n",
			       ((*bat_debug)->attr).name);
			goto err;
		}
	}

	return;
err:
	debugfs_remove_recursive(batadv_debugfs);
	batadv_debugfs = NULL;
}

void batadv_debugfs_destroy(void)
{
	debugfs_remove_recursive(batadv_debugfs);
	batadv_debugfs = NULL;
}

/**
 * batadv_debugfs_add_hardif - creates the base directory for a hard interface
 *  in debugfs.
 * @hard_iface: hard interface which should be added.
 *
 * Return: 0 on success or negative error number in case of failure
 */
int batadv_debugfs_add_hardif(struct batadv_hard_iface *hard_iface)
{
	struct batadv_debuginfo **bat_debug;
	struct dentry *file;

	if (!batadv_debugfs)
		goto out;

	hard_iface->debug_dir = debugfs_create_dir(hard_iface->net_dev->name,
						   batadv_debugfs);
	if (!hard_iface->debug_dir)
		goto out;

	for (bat_debug = batadv_hardif_debuginfos; *bat_debug; ++bat_debug) {
		file = debugfs_create_file(((*bat_debug)->attr).name,
					   S_IFREG | ((*bat_debug)->attr).mode,
					   hard_iface->debug_dir,
					   hard_iface->net_dev,
					   &(*bat_debug)->fops);
		if (!file)
			goto rem_attr;
	}

	return 0;
rem_attr:
	debugfs_remove_recursive(hard_iface->debug_dir);
	hard_iface->debug_dir = NULL;
out:
	return -ENOMEM;
}

/**
 * batadv_debugfs_del_hardif - delete the base directory for a hard interface
 *  in debugfs.
 * @hard_iface: hard interface which is deleted.
 */
void batadv_debugfs_del_hardif(struct batadv_hard_iface *hard_iface)
{
	if (batadv_debugfs) {
		debugfs_remove_recursive(hard_iface->debug_dir);
		hard_iface->debug_dir = NULL;
	}
}

int batadv_debugfs_add_meshif(struct net_device *dev)
{
	struct batadv_priv *bat_priv = netdev_priv(dev);
	struct batadv_debuginfo **bat_debug;
	struct dentry *file;

	if (!batadv_debugfs)
		goto out;

	bat_priv->debug_dir = debugfs_create_dir(dev->name, batadv_debugfs);
	if (!bat_priv->debug_dir)
		goto out;

	if (batadv_socket_setup(bat_priv) < 0)
		goto rem_attr;

	if (batadv_debug_log_setup(bat_priv) < 0)
		goto rem_attr;

	for (bat_debug = batadv_mesh_debuginfos; *bat_debug; ++bat_debug) {
		file = debugfs_create_file(((*bat_debug)->attr).name,
					   S_IFREG | ((*bat_debug)->attr).mode,
					   bat_priv->debug_dir,
					   dev, &(*bat_debug)->fops);
		if (!file) {
			batadv_err(dev, "Can't add debugfs file: %s/%s\n",
				   dev->name, ((*bat_debug)->attr).name);
			goto rem_attr;
		}
	}

	if (batadv_nc_init_debugfs(bat_priv) < 0)
		goto rem_attr;

	return 0;
rem_attr:
	debugfs_remove_recursive(bat_priv->debug_dir);
	bat_priv->debug_dir = NULL;
out:
	return -ENOMEM;
}

void batadv_debugfs_del_meshif(struct net_device *dev)
{
	struct batadv_priv *bat_priv = netdev_priv(dev);

	batadv_debug_log_cleanup(bat_priv);

	if (batadv_debugfs) {
		debugfs_remove_recursive(bat_priv->debug_dir);
		bat_priv->debug_dir = NULL;
	}
}
Commit	Line	Data
0046b040	1	/* Copyright (C) 2010-2016 B.A.T.M.A.N. contributors:
c6c8fea2 SE	2	*
	3	* Marek Lindner
	4	*
	5	* This program is free software; you can redistribute it and/or
	6	* modify it under the terms of version 2 of the GNU General Public
	7	* License as published by the Free Software Foundation.
	8	*
	9	* This program is distributed in the hope that it will be useful, but
	10	* WITHOUT ANY WARRANTY; without even the implied warranty of
	11	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
	12	* General Public License for more details.
	13	*
	14	* You should have received a copy of the GNU General Public License
ebf38fb7	15	* along with this program; if not, see <http://www.gnu.org/licenses/>.
c6c8fea2 SE	16	*/
c6c8fea2 SE	17
1e2c2a4f	18	#include "debugfs.h"
c6c8fea2 SE	19	#include "main.h"
c6c8fea2 SE	20
1e2c2a4f	21	#include <linux/compiler.h>
c6c8fea2	22	#include <linux/debugfs.h>
1e2c2a4f SE	23	#include <linux/device.h>
	24	#include <linux/errno.h>
	25	#include <linux/export.h>
	26	#include <linux/fcntl.h>
	27	#include <linux/fs.h>
	28	#include <linux/jiffies.h>
	29	#include <linux/kernel.h>
	30	#include <linux/module.h>
	31	#include <linux/netdevice.h>
	32	#include <linux/poll.h>
	33	#include <linux/printk.h>
	34	#include <linux/sched.h> /* for linux/wait.h */
	35	#include <linux/seq_file.h>
	36	#include <linux/slab.h>
	37	#include <linux/spinlock.h>
	38	#include <linux/stat.h>
	39	#include <linux/stddef.h>
	40	#include <linux/stringify.h>
	41	#include <linux/sysfs.h>
	42	#include <linux/types.h>
	43	#include <linux/uaccess.h>
	44	#include <linux/wait.h>
	45	#include <stdarg.h>
c6c8fea2	46
9bf8e4d4	47	#include "bridge_loop_avoidance.h"
2f1dfbe1	48	#include "distributed-arp-table.h"
1e2c2a4f SE	49	#include "gateway_client.h"
1e2c2a4f SE	50	#include "icmp_socket.h"
d56b1705	51	#include "network-coding.h"
1e2c2a4f SE	52	#include "originator.h"
1e2c2a4f SE	53	#include "translation-table.h"
c6c8fea2	54
9e466250	55	static struct dentry *batadv_debugfs;
c6c8fea2 SE	56
c6c8fea2 SE	57	#ifdef CONFIG_BATMAN_ADV_DEBUG
347c80f0	58	#define BATADV_LOG_BUFF_MASK (batadv_log_buff_len - 1)
c6c8fea2	59
a8a0a62d SE	60	static const int batadv_log_buff_len = BATADV_LOG_BUF_LEN;
a8a0a62d SE	61
0abf5d81	62	static char batadv_log_char_addr(struct batadv_priv_debug_log debug_log,
a8a0a62d SE	63	size_t idx)
	64	{
	65	return &debug_log->log_buff[idx & BATADV_LOG_BUFF_MASK];
	66	}
c6c8fea2	67
0abf5d81 ML	68	static void batadv_emit_log_char(struct batadv_priv_debug_log *debug_log,
0abf5d81 ML	69	char c)
c6c8fea2	70	{
a8a0a62d SE	71	char *char_addr;
	72
	73	char_addr = batadv_log_char_addr(debug_log, debug_log->log_end);
	74	*char_addr = c;
c6c8fea2 SE	75	debug_log->log_end++;
c6c8fea2 SE	76
9e466250 SE	77	if (debug_log->log_end - debug_log->log_start > batadv_log_buff_len)
9e466250 SE	78	debug_log->log_start = debug_log->log_end - batadv_log_buff_len;
c6c8fea2 SE	79	}
c6c8fea2 SE	80
d3a547be	81	__printf(2, 3)
0abf5d81	82	static int batadv_fdebug_log(struct batadv_priv_debug_log *debug_log,
56303d34	83	const char *fmt, ...)
c6c8fea2	84	{
c6c8fea2 SE	85	va_list args;
	86	static char debug_log_buf[256];
	87	char *p;
	88
	89	if (!debug_log)
	90	return 0;
	91
	92	spin_lock_bh(&debug_log->lock);
	93	va_start(args, fmt);
1299bdaa	94	vscnprintf(debug_log_buf, sizeof(debug_log_buf), fmt, args);
c6c8fea2 SE	95	va_end(args);
	96
	97	for (p = debug_log_buf; *p != 0; p++)
9e466250	98	batadv_emit_log_char(debug_log, *p);
c6c8fea2 SE	99
	100	spin_unlock_bh(&debug_log->lock);
	101
	102	wake_up(&debug_log->queue_wait);
	103
	104	return 0;
	105	}
	106
56303d34	107	int batadv_debug_log(struct batadv_priv bat_priv, const char fmt, ...)
c6c8fea2 SE	108	{
	109	va_list args;
	110	char tmp_log_buf[256];
	111
	112	va_start(args, fmt);
	113	vscnprintf(tmp_log_buf, sizeof(tmp_log_buf), fmt, args);
9e466250 SE	114	batadv_fdebug_log(bat_priv->debug_log, "[%10u] %s",
9e466250 SE	115	jiffies_to_msecs(jiffies), tmp_log_buf);
c6c8fea2 SE	116	va_end(args);
	117
	118	return 0;
	119	}
	120
9e466250	121	static int batadv_log_open(struct inode inode, struct file file)
c6c8fea2	122	{
bd5b80d5 SE	123	if (!try_module_get(THIS_MODULE))
	124	return -EBUSY;
	125
c6c8fea2 SE	126	nonseekable_open(inode, file);
c6c8fea2 SE	127	file->private_data = inode->i_private;
c6c8fea2 SE	128	return 0;
	129	}
	130
9e466250	131	static int batadv_log_release(struct inode inode, struct file file)
c6c8fea2	132	{
bd5b80d5	133	module_put(THIS_MODULE);
c6c8fea2 SE	134	return 0;
	135	}
	136
4b426b10	137	static bool batadv_log_empty(struct batadv_priv_debug_log *debug_log)
0aca2369 SE	138	{
	139	return !(debug_log->log_start - debug_log->log_end);
	140	}
	141
9e466250 SE	142	static ssize_t batadv_log_read(struct file file, char __user buf,
9e466250 SE	143	size_t count, loff_t *ppos)
c6c8fea2	144	{
56303d34	145	struct batadv_priv *bat_priv = file->private_data;
0abf5d81	146	struct batadv_priv_debug_log *debug_log = bat_priv->debug_log;
c6c8fea2	147	int error, i = 0;
a8a0a62d	148	char *char_addr;
c6c8fea2 SE	149	char c;
c6c8fea2 SE	150
0aca2369	151	if ((file->f_flags & O_NONBLOCK) && batadv_log_empty(debug_log))
c6c8fea2 SE	152	return -EAGAIN;
c6c8fea2 SE	153
16f14b45	154	if (!buf)
c6c8fea2 SE	155	return -EINVAL;
	156
	157	if (count == 0)
	158	return 0;
	159
	160	if (!access_ok(VERIFY_WRITE, buf, count))
	161	return -EFAULT;
	162
	163	error = wait_event_interruptible(debug_log->queue_wait,
0aca2369	164	(!batadv_log_empty(debug_log)));
c6c8fea2 SE	165
	166	if (error)
	167	return error;
	168
	169	spin_lock_bh(&debug_log->lock);
	170
	171	while ((!error) && (i < count) &&
	172	(debug_log->log_start != debug_log->log_end)) {
a8a0a62d SE	173	char_addr = batadv_log_char_addr(debug_log,
	174	debug_log->log_start);
	175	c = *char_addr;
c6c8fea2 SE	176
	177	debug_log->log_start++;
	178
	179	spin_unlock_bh(&debug_log->lock);
	180
	181	error = __put_user(c, buf);
	182
	183	spin_lock_bh(&debug_log->lock);
	184
	185	buf++;
	186	i++;
c6c8fea2 SE	187	}
	188
	189	spin_unlock_bh(&debug_log->lock);
	190
	191	if (!error)
	192	return i;
	193
	194	return error;
	195	}
	196
9e466250	197	static unsigned int batadv_log_poll(struct file file, poll_table wait)
c6c8fea2	198	{
56303d34	199	struct batadv_priv *bat_priv = file->private_data;
0abf5d81	200	struct batadv_priv_debug_log *debug_log = bat_priv->debug_log;
c6c8fea2 SE	201
	202	poll_wait(file, &debug_log->queue_wait, wait);
	203
0aca2369	204	if (!batadv_log_empty(debug_log))
c6c8fea2 SE	205	return POLLIN \| POLLRDNORM;
	206
	207	return 0;
	208	}
	209
9e466250 SE	210	static const struct file_operations batadv_log_fops = {
	211	.open = batadv_log_open,
	212	.release = batadv_log_release,
	213	.read = batadv_log_read,
	214	.poll = batadv_log_poll,
c6c8fea2 SE	215	.llseek = no_llseek,
	216	};
	217
56303d34	218	static int batadv_debug_log_setup(struct batadv_priv *bat_priv)
c6c8fea2 SE	219	{
	220	struct dentry *d;
	221
	222	if (!bat_priv->debug_dir)
	223	goto err;
	224
704509b8	225	bat_priv->debug_log = kzalloc(sizeof(*bat_priv->debug_log), GFP_ATOMIC);
c6c8fea2 SE	226	if (!bat_priv->debug_log)
	227	goto err;
	228
	229	spin_lock_init(&bat_priv->debug_log->lock);
	230	init_waitqueue_head(&bat_priv->debug_log->queue_wait);
	231
	232	d = debugfs_create_file("log", S_IFREG \| S_IRUSR,
9e466250 SE	233	bat_priv->debug_dir, bat_priv,
9e466250 SE	234	&batadv_log_fops);
5346c35e	235	if (!d)
c6c8fea2 SE	236	goto err;
	237
	238	return 0;
	239
	240	err:
5346c35e	241	return -ENOMEM;
c6c8fea2 SE	242	}
c6c8fea2 SE	243
56303d34	244	static void batadv_debug_log_cleanup(struct batadv_priv *bat_priv)
c6c8fea2 SE	245	{
	246	kfree(bat_priv->debug_log);
	247	bat_priv->debug_log = NULL;
	248	}
	249	#else /* CONFIG_BATMAN_ADV_DEBUG */
56303d34	250	static int batadv_debug_log_setup(struct batadv_priv *bat_priv)
c6c8fea2	251	{
c6c8fea2 SE	252	return 0;
	253	}
	254
56303d34	255	static void batadv_debug_log_cleanup(struct batadv_priv *bat_priv)
c6c8fea2	256	{
c6c8fea2 SE	257	}
	258	#endif
	259
9e466250	260	static int batadv_algorithms_open(struct inode inode, struct file file)
1c280471	261	{
3193e8fd	262	return single_open(file, batadv_algo_seq_print_text, NULL);
1c280471 ML	263	}
1c280471 ML	264
7587405a ML	265	static int neighbors_open(struct inode inode, struct file file)
	266	{
	267	struct net_device net_dev = (struct net_device )inode->i_private;
	268
	269	return single_open(file, batadv_hardif_neigh_seq_print_text, net_dev);
	270	}
	271
9e466250	272	static int batadv_originators_open(struct inode inode, struct file file)
c6c8fea2 SE	273	{
c6c8fea2 SE	274	struct net_device net_dev = (struct net_device )inode->i_private;
f138694b	275
7d211efc	276	return single_open(file, batadv_orig_seq_print_text, net_dev);
c6c8fea2 SE	277	}
c6c8fea2 SE	278
cb1c92ec SW	279	/**
	280	* batadv_originators_hardif_open - handles debugfs output for the
	281	* originator table of an hard interface
	282	* @inode: inode pointer to debugfs file
	283	* @file: pointer to the seq_file
7afcbbef SE	284	*
7afcbbef SE	285	* Return: 0 on success or negative error number in case of failure
cb1c92ec SW	286	*/
	287	static int batadv_originators_hardif_open(struct inode *inode,
	288	struct file *file)
	289	{
	290	struct net_device net_dev = (struct net_device )inode->i_private;
f138694b	291
cb1c92ec SW	292	return single_open(file, batadv_orig_hardif_seq_print_text, net_dev);
	293	}
	294
9e466250	295	static int batadv_gateways_open(struct inode inode, struct file file)
c6c8fea2 SE	296	{
c6c8fea2 SE	297	struct net_device net_dev = (struct net_device )inode->i_private;
f138694b	298
7cf06bc6	299	return single_open(file, batadv_gw_client_seq_print_text, net_dev);
c6c8fea2 SE	300	}
c6c8fea2 SE	301
9e466250	302	static int batadv_transtable_global_open(struct inode inode, struct file file)
c6c8fea2 SE	303	{
c6c8fea2 SE	304	struct net_device net_dev = (struct net_device )inode->i_private;
f138694b	305
08c36d3e	306	return single_open(file, batadv_tt_global_seq_print_text, net_dev);
c6c8fea2 SE	307	}
c6c8fea2 SE	308
7a5cc242	309	#ifdef CONFIG_BATMAN_ADV_BLA
9e466250	310	static int batadv_bla_claim_table_open(struct inode inode, struct file file)
9bf8e4d4 SW	311	{
9bf8e4d4 SW	312	struct net_device net_dev = (struct net_device )inode->i_private;
f138694b	313
08adf151 SE	314	return single_open(file, batadv_bla_claim_table_seq_print_text,
08adf151 SE	315	net_dev);
9bf8e4d4	316	}
536a23f1 SW	317
	318	static int batadv_bla_backbone_table_open(struct inode *inode,
	319	struct file *file)
	320	{
	321	struct net_device net_dev = (struct net_device )inode->i_private;
f138694b	322
536a23f1 SW	323	return single_open(file, batadv_bla_backbone_table_seq_print_text,
	324	net_dev);
	325	}
	326
7a5cc242	327	#endif
9bf8e4d4	328
17224474	329	#ifdef CONFIG_BATMAN_ADV_DAT
2f1dfbe1 AQ	330	/**
	331	* batadv_dat_cache_open - Prepare file handler for reads from dat_chache
	332	* @inode: inode which was opened
	333	* @file: file handle to be initialized
7afcbbef SE	334	*
7afcbbef SE	335	* Return: 0 on success or negative error number in case of failure
2f1dfbe1 AQ	336	*/
	337	static int batadv_dat_cache_open(struct inode inode, struct file file)
	338	{
	339	struct net_device net_dev = (struct net_device )inode->i_private;
f138694b	340
2f1dfbe1 AQ	341	return single_open(file, batadv_dat_cache_seq_print_text, net_dev);
2f1dfbe1 AQ	342	}
17224474	343	#endif
2f1dfbe1	344
9e466250	345	static int batadv_transtable_local_open(struct inode inode, struct file file)
c6c8fea2 SE	346	{
c6c8fea2 SE	347	struct net_device net_dev = (struct net_device )inode->i_private;
f138694b	348
08c36d3e	349	return single_open(file, batadv_tt_local_seq_print_text, net_dev);
c6c8fea2 SE	350	}
c6c8fea2 SE	351
7f223c0c	352	struct batadv_debuginfo {
c6c8fea2 SE	353	struct attribute attr;
	354	const struct file_operations fops;
	355	};
	356
d56b1705 MH	357	#ifdef CONFIG_BATMAN_ADV_NC
	358	static int batadv_nc_nodes_open(struct inode inode, struct file file)
	359	{
	360	struct net_device net_dev = (struct net_device )inode->i_private;
f138694b	361
d56b1705 MH	362	return single_open(file, batadv_nc_nodes_seq_print_text, net_dev);
	363	}
	364	#endif
	365
347c80f0	366	#define BATADV_DEBUGINFO(_name, _mode, _open) \
7f223c0c	367	struct batadv_debuginfo batadv_debuginfo_##_name = { \
121bdca0 SW	368	.attr = { \
	369	.name = __stringify(_name), \
	370	.mode = _mode, \
	371	}, \
	372	.fops = { \
	373	.owner = THIS_MODULE, \
	374	.open = _open, \
	375	.read = seq_read, \
	376	.llseek = seq_lseek, \
	377	.release = single_release, \
	378	}, \
2b64df20	379	}
c6c8fea2	380
637fbd12 AQ	381	/* the following attributes are general and therefore they will be directly
	382	* placed in the BATADV_DEBUGFS_SUBDIR subdirectory of debugfs
	383	*/
347c80f0	384	static BATADV_DEBUGINFO(routing_algos, S_IRUGO, batadv_algorithms_open);
637fbd12 AQ	385
	386	static struct batadv_debuginfo *batadv_general_debuginfos[] = {
	387	&batadv_debuginfo_routing_algos,
	388	NULL,
	389	};
	390
	391	/* The following attributes are per soft interface */
7587405a	392	static BATADV_DEBUGINFO(neighbors, S_IRUGO, neighbors_open);
347c80f0 SE	393	static BATADV_DEBUGINFO(originators, S_IRUGO, batadv_originators_open);
	394	static BATADV_DEBUGINFO(gateways, S_IRUGO, batadv_gateways_open);
	395	static BATADV_DEBUGINFO(transtable_global, S_IRUGO,
	396	batadv_transtable_global_open);
7a5cc242	397	#ifdef CONFIG_BATMAN_ADV_BLA
347c80f0	398	static BATADV_DEBUGINFO(bla_claim_table, S_IRUGO, batadv_bla_claim_table_open);
536a23f1 SW	399	static BATADV_DEBUGINFO(bla_backbone_table, S_IRUGO,
536a23f1 SW	400	batadv_bla_backbone_table_open);
7a5cc242	401	#endif
17224474	402	#ifdef CONFIG_BATMAN_ADV_DAT
2f1dfbe1	403	static BATADV_DEBUGINFO(dat_cache, S_IRUGO, batadv_dat_cache_open);
17224474	404	#endif
347c80f0 SE	405	static BATADV_DEBUGINFO(transtable_local, S_IRUGO,
347c80f0 SE	406	batadv_transtable_local_open);
d56b1705 MH	407	#ifdef CONFIG_BATMAN_ADV_NC
	408	static BATADV_DEBUGINFO(nc_nodes, S_IRUGO, batadv_nc_nodes_open);
	409	#endif
c6c8fea2	410
7f223c0c	411	static struct batadv_debuginfo *batadv_mesh_debuginfos[] = {
7587405a	412	&batadv_debuginfo_neighbors,
9e466250 SE	413	&batadv_debuginfo_originators,
	414	&batadv_debuginfo_gateways,
	415	&batadv_debuginfo_transtable_global,
7a5cc242	416	#ifdef CONFIG_BATMAN_ADV_BLA
9e466250	417	&batadv_debuginfo_bla_claim_table,
536a23f1	418	&batadv_debuginfo_bla_backbone_table,
7a5cc242	419	#endif
17224474	420	#ifdef CONFIG_BATMAN_ADV_DAT
2f1dfbe1	421	&batadv_debuginfo_dat_cache,
17224474	422	#endif
9e466250	423	&batadv_debuginfo_transtable_local,
d56b1705 MH	424	#ifdef CONFIG_BATMAN_ADV_NC
	425	&batadv_debuginfo_nc_nodes,
	426	#endif
c6c8fea2 SE	427	NULL,
	428	};
	429
5bc7c1eb SW	430	#define BATADV_HARDIF_DEBUGINFO(_name, _mode, _open) \
	431	struct batadv_debuginfo batadv_hardif_debuginfo_##_name = { \
	432	.attr = { \
	433	.name = __stringify(_name), \
	434	.mode = _mode, \
	435	}, \
	436	.fops = { \
	437	.owner = THIS_MODULE, \
	438	.open = _open, \
	439	.read = seq_read, \
	440	.llseek = seq_lseek, \
	441	.release = single_release, \
	442	}, \
2b64df20	443	}
aa143d28	444
cb1c92ec SW	445	static BATADV_HARDIF_DEBUGINFO(originators, S_IRUGO,
cb1c92ec SW	446	batadv_originators_hardif_open);
5bc7c1eb SW	447
5bc7c1eb SW	448	static struct batadv_debuginfo *batadv_hardif_debuginfos[] = {
cb1c92ec	449	&batadv_hardif_debuginfo_originators,
5bc7c1eb SW	450	NULL,
	451	};
	452
40a072d7	453	void batadv_debugfs_init(void)
c6c8fea2	454	{
637fbd12	455	struct batadv_debuginfo **bat_debug;
1c280471 ML	456	struct dentry *file;
1c280471 ML	457
54590e4d	458	batadv_debugfs = debugfs_create_dir(BATADV_DEBUGFS_SUBDIR, NULL);
9e466250 SE	459	if (batadv_debugfs == ERR_PTR(-ENODEV))
9e466250 SE	460	batadv_debugfs = NULL;
1c280471	461
9e466250	462	if (!batadv_debugfs)
637fbd12	463	goto err;
1c280471	464
637fbd12 AQ	465	for (bat_debug = batadv_general_debuginfos; *bat_debug; ++bat_debug) {
	466	file = debugfs_create_file(((*bat_debug)->attr).name,
	467	S_IFREG \| ((*bat_debug)->attr).mode,
	468	batadv_debugfs, NULL,
	469	&(*bat_debug)->fops);
	470	if (!file) {
	471	pr_err("Can't add general debugfs file: %s\n",
	472	((*bat_debug)->attr).name);
	473	goto err;
	474	}
	475	}
1c280471	476
1c280471	477	return;
637fbd12 AQ	478	err:
637fbd12 AQ	479	debugfs_remove_recursive(batadv_debugfs);
5bc7c1eb	480	batadv_debugfs = NULL;
c6c8fea2 SE	481	}
c6c8fea2 SE	482
40a072d7	483	void batadv_debugfs_destroy(void)
c6c8fea2	484	{
3f87c423 AQ	485	debugfs_remove_recursive(batadv_debugfs);
3f87c423 AQ	486	batadv_debugfs = NULL;
c6c8fea2 SE	487	}
c6c8fea2 SE	488
5bc7c1eb SW	489	/**
	490	* batadv_debugfs_add_hardif - creates the base directory for a hard interface
	491	* in debugfs.
	492	* @hard_iface: hard interface which should be added.
7afcbbef SE	493	*
7afcbbef SE	494	* Return: 0 on success or negative error number in case of failure
5bc7c1eb SW	495	*/
	496	int batadv_debugfs_add_hardif(struct batadv_hard_iface *hard_iface)
	497	{
	498	struct batadv_debuginfo **bat_debug;
	499	struct dentry *file;
	500
	501	if (!batadv_debugfs)
	502	goto out;
	503
	504	hard_iface->debug_dir = debugfs_create_dir(hard_iface->net_dev->name,
	505	batadv_debugfs);
	506	if (!hard_iface->debug_dir)
	507	goto out;
	508
	509	for (bat_debug = batadv_hardif_debuginfos; *bat_debug; ++bat_debug) {
	510	file = debugfs_create_file(((*bat_debug)->attr).name,
	511	S_IFREG \| ((*bat_debug)->attr).mode,
	512	hard_iface->debug_dir,
	513	hard_iface->net_dev,
	514	&(*bat_debug)->fops);
	515	if (!file)
	516	goto rem_attr;
	517	}
	518
	519	return 0;
	520	rem_attr:
	521	debugfs_remove_recursive(hard_iface->debug_dir);
	522	hard_iface->debug_dir = NULL;
	523	out:
5bc7c1eb	524	return -ENOMEM;
5bc7c1eb SW	525	}
	526
	527	/**
	528	* batadv_debugfs_del_hardif - delete the base directory for a hard interface
	529	* in debugfs.
	530	* @hard_iface: hard interface which is deleted.
	531	*/
	532	void batadv_debugfs_del_hardif(struct batadv_hard_iface *hard_iface)
	533	{
	534	if (batadv_debugfs) {
	535	debugfs_remove_recursive(hard_iface->debug_dir);
	536	hard_iface->debug_dir = NULL;
	537	}
	538	}
	539
40a072d7	540	int batadv_debugfs_add_meshif(struct net_device *dev)
c6c8fea2	541	{
56303d34	542	struct batadv_priv *bat_priv = netdev_priv(dev);
7f223c0c	543	struct batadv_debuginfo **bat_debug;
c6c8fea2 SE	544	struct dentry *file;
c6c8fea2 SE	545
9e466250	546	if (!batadv_debugfs)
c6c8fea2 SE	547	goto out;
c6c8fea2 SE	548
9e466250	549	bat_priv->debug_dir = debugfs_create_dir(dev->name, batadv_debugfs);
c6c8fea2 SE	550	if (!bat_priv->debug_dir)
	551	goto out;
	552
9039dc7e	553	if (batadv_socket_setup(bat_priv) < 0)
5346c35e SE	554	goto rem_attr;
5346c35e SE	555
9e466250	556	if (batadv_debug_log_setup(bat_priv) < 0)
5346c35e	557	goto rem_attr;
c6c8fea2	558
9e466250	559	for (bat_debug = batadv_mesh_debuginfos; *bat_debug; ++bat_debug) {
c6c8fea2	560	file = debugfs_create_file(((*bat_debug)->attr).name,
0aca2369 SE	561	S_IFREG \| ((*bat_debug)->attr).mode,
	562	bat_priv->debug_dir,
	563	dev, &(*bat_debug)->fops);
c6c8fea2	564	if (!file) {
3e34819e SE	565	batadv_err(dev, "Can't add debugfs file: %s/%s\n",
3e34819e SE	566	dev->name, ((*bat_debug)->attr).name);
c6c8fea2 SE	567	goto rem_attr;
	568	}
	569	}
	570
d56b1705 MH	571	if (batadv_nc_init_debugfs(bat_priv) < 0)
	572	goto rem_attr;
	573
c6c8fea2 SE	574	return 0;
	575	rem_attr:
	576	debugfs_remove_recursive(bat_priv->debug_dir);
	577	bat_priv->debug_dir = NULL;
	578	out:
c6c8fea2	579	return -ENOMEM;
c6c8fea2 SE	580	}
c6c8fea2 SE	581
40a072d7	582	void batadv_debugfs_del_meshif(struct net_device *dev)
c6c8fea2	583	{
56303d34	584	struct batadv_priv *bat_priv = netdev_priv(dev);
c6c8fea2	585
9e466250	586	batadv_debug_log_cleanup(bat_priv);
c6c8fea2	587
9e466250	588	if (batadv_debugfs) {
c6c8fea2 SE	589	debugfs_remove_recursive(bat_priv->debug_dir);
	590	bat_priv->debug_dir = NULL;
	591	}
	592	}