[linux-2.6-block.git] / net / sunrpc / debugfs.c

// SPDX-License-Identifier: GPL-2.0
/*
 * debugfs interface for sunrpc
 *
 * (c) 2014 Jeff Layton <jlayton@primarydata.com>
 */

#include <linux/debugfs.h>
#include <linux/sunrpc/sched.h>
#include <linux/sunrpc/clnt.h>

#include "netns.h"
#include "fail.h"

static struct dentry *topdir;
static struct dentry *rpc_clnt_dir;
static struct dentry *rpc_xprt_dir;

static int
tasks_show(struct seq_file *f, void *v)
{
	u32 xid = 0;
	struct rpc_task *task = v;
	struct rpc_clnt *clnt = task->tk_client;
	const char *rpc_waitq = "none";

	if (RPC_IS_QUEUED(task))
		rpc_waitq = rpc_qname(task->tk_waitqueue);

	if (task->tk_rqstp)
		xid = be32_to_cpu(task->tk_rqstp->rq_xid);

	seq_printf(f, "%5u %04x %6d 0x%x 0x%x %8ld %ps %sv%u %s a:%ps q:%s\n",
		task->tk_pid, task->tk_flags, task->tk_status,
		clnt->cl_clid, xid, rpc_task_timeout(task), task->tk_ops,
		clnt->cl_program->name, clnt->cl_vers, rpc_proc_name(task),
		task->tk_action, rpc_waitq);
	return 0;
}

static void *
tasks_start(struct seq_file *f, loff_t *ppos)
	__acquires(&clnt->cl_lock)
{
	struct rpc_clnt *clnt = f->private;
	loff_t pos = *ppos;
	struct rpc_task *task;

	spin_lock(&clnt->cl_lock);
	list_for_each_entry(task, &clnt->cl_tasks, tk_task)
		if (pos-- == 0)
			return task;
	return NULL;
}

static void *
tasks_next(struct seq_file *f, void *v, loff_t *pos)
{
	struct rpc_clnt *clnt = f->private;
	struct rpc_task *task = v;
	struct list_head *next = task->tk_task.next;

	++*pos;

	/* If there's another task on list, return it */
	if (next == &clnt->cl_tasks)
		return NULL;
	return list_entry(next, struct rpc_task, tk_task);
}

static void
tasks_stop(struct seq_file *f, void *v)
	__releases(&clnt->cl_lock)
{
	struct rpc_clnt *clnt = f->private;
	spin_unlock(&clnt->cl_lock);
}

static const struct seq_operations tasks_seq_operations = {
	.start	= tasks_start,
	.next	= tasks_next,
	.stop	= tasks_stop,
	.show	= tasks_show,
};

static int tasks_open(struct inode *inode, struct file *filp)
{
	int ret = seq_open(filp, &tasks_seq_operations);
	if (!ret) {
		struct seq_file *seq = filp->private_data;
		struct rpc_clnt *clnt = seq->private = inode->i_private;

		if (!refcount_inc_not_zero(&clnt->cl_count)) {
			seq_release(inode, filp);
			ret = -EINVAL;
		}
	}

	return ret;
}

static int
tasks_release(struct inode *inode, struct file *filp)
{
	struct seq_file *seq = filp->private_data;
	struct rpc_clnt *clnt = seq->private;

	rpc_release_client(clnt);
	return seq_release(inode, filp);
}

static const struct file_operations tasks_fops = {
	.owner		= THIS_MODULE,
	.open		= tasks_open,
	.read		= seq_read,
	.llseek		= seq_lseek,
	.release	= tasks_release,
};

static int do_xprt_debugfs(struct rpc_clnt *clnt, struct rpc_xprt *xprt, void *numv)
{
	int len;
	char name[24]; /* enough for "../../rpc_xprt/ + 8 hex digits + NULL */
	char link[9]; /* enough for 8 hex digits + NULL */
	int *nump = numv;

	if (IS_ERR_OR_NULL(xprt->debugfs))
		return 0;
	len = snprintf(name, sizeof(name), "../../rpc_xprt/%s",
		       xprt->debugfs->d_name.name);
	if (len >= sizeof(name))
		return -1;
	if (*nump == 0)
		strcpy(link, "xprt");
	else {
		len = snprintf(link, sizeof(link), "xprt%d", *nump);
		if (len >= sizeof(link))
			return -1;
	}
	debugfs_create_symlink(link, clnt->cl_debugfs, name);
	(*nump)++;
	return 0;
}

void
rpc_clnt_debugfs_register(struct rpc_clnt *clnt)
{
	int len;
	char name[9]; /* enough for 8 hex digits + NULL */
	int xprtnum = 0;

	len = snprintf(name, sizeof(name), "%x", clnt->cl_clid);
	if (len >= sizeof(name))
		return;

	/* make the per-client dir */
	clnt->cl_debugfs = debugfs_create_dir(name, rpc_clnt_dir);

	/* make tasks file */
	debugfs_create_file("tasks", S_IFREG | 0400, clnt->cl_debugfs, clnt,
			    &tasks_fops);

	rpc_clnt_iterate_for_each_xprt(clnt, do_xprt_debugfs, &xprtnum);
}

void
rpc_clnt_debugfs_unregister(struct rpc_clnt *clnt)
{
	debugfs_remove_recursive(clnt->cl_debugfs);
	clnt->cl_debugfs = NULL;
}

static int
xprt_info_show(struct seq_file *f, void *v)
{
	struct rpc_xprt *xprt = f->private;

	seq_printf(f, "netid: %s\n", xprt->address_strings[RPC_DISPLAY_NETID]);
	seq_printf(f, "addr:  %s\n", xprt->address_strings[RPC_DISPLAY_ADDR]);
	seq_printf(f, "port:  %s\n", xprt->address_strings[RPC_DISPLAY_PORT]);
	seq_printf(f, "state: 0x%lx\n", xprt->state);
	return 0;
}

static int
xprt_info_open(struct inode *inode, struct file *filp)
{
	int ret;
	struct rpc_xprt *xprt = inode->i_private;

	ret = single_open(filp, xprt_info_show, xprt);

	if (!ret) {
		if (!xprt_get(xprt)) {
			single_release(inode, filp);
			ret = -EINVAL;
		}
	}
	return ret;
}

static int
xprt_info_release(struct inode *inode, struct file *filp)
{
	struct rpc_xprt *xprt = inode->i_private;

	xprt_put(xprt);
	return single_release(inode, filp);
}

static const struct file_operations xprt_info_fops = {
	.owner		= THIS_MODULE,
	.open		= xprt_info_open,
	.read		= seq_read,
	.llseek		= seq_lseek,
	.release	= xprt_info_release,
};

void
rpc_xprt_debugfs_register(struct rpc_xprt *xprt)
{
	int len, id;
	static atomic_t	cur_id;
	char		name[9]; /* 8 hex digits + NULL term */

	id = (unsigned int)atomic_inc_return(&cur_id);

	len = snprintf(name, sizeof(name), "%x", id);
	if (len >= sizeof(name))
		return;

	/* make the per-client dir */
	xprt->debugfs = debugfs_create_dir(name, rpc_xprt_dir);

	/* make tasks file */
	debugfs_create_file("info", S_IFREG | 0400, xprt->debugfs, xprt,
			    &xprt_info_fops);
}

void
rpc_xprt_debugfs_unregister(struct rpc_xprt *xprt)
{
	debugfs_remove_recursive(xprt->debugfs);
	xprt->debugfs = NULL;
}

#if IS_ENABLED(CONFIG_FAIL_SUNRPC)
struct fail_sunrpc_attr fail_sunrpc = {
	.attr			= FAULT_ATTR_INITIALIZER,
};
EXPORT_SYMBOL_GPL(fail_sunrpc);

static void fail_sunrpc_init(void)
{
	struct dentry *dir;

	dir = fault_create_debugfs_attr("fail_sunrpc", NULL,
					&fail_sunrpc.attr);

	debugfs_create_bool("ignore-client-disconnect", S_IFREG | 0600, dir,
			    &fail_sunrpc.ignore_client_disconnect);

	debugfs_create_bool("ignore-server-disconnect", S_IFREG | 0600, dir,
			    &fail_sunrpc.ignore_server_disconnect);

	debugfs_create_bool("ignore-cache-wait", S_IFREG | 0600, dir,
			    &fail_sunrpc.ignore_cache_wait);
}
#else
static void fail_sunrpc_init(void)
{
}
#endif

void __exit
sunrpc_debugfs_exit(void)
{
	debugfs_remove_recursive(topdir);
	topdir = NULL;
	rpc_clnt_dir = NULL;
	rpc_xprt_dir = NULL;
}

void __init
sunrpc_debugfs_init(void)
{
	topdir = debugfs_create_dir("sunrpc", NULL);

	rpc_clnt_dir = debugfs_create_dir("rpc_clnt", topdir);

	rpc_xprt_dir = debugfs_create_dir("rpc_xprt", topdir);

	fail_sunrpc_init();
}
Commit	Line	Data
b2441318	1	// SPDX-License-Identifier: GPL-2.0
b6580ab3	2	/*
b4b9d2cc JL	3	* debugfs interface for sunrpc
	4	*
	5	* (c) 2014 Jeff Layton <jlayton@primarydata.com>
	6	*/
	7
	8	#include <linux/debugfs.h>
	9	#include <linux/sunrpc/sched.h>
	10	#include <linux/sunrpc/clnt.h>
c782af25	11
b4b9d2cc	12	#include "netns.h"
c782af25	13	#include "fail.h"
b4b9d2cc JL	14
	15	static struct dentry *topdir;
	16	static struct dentry *rpc_clnt_dir;
388f0c77	17	static struct dentry *rpc_xprt_dir;
b4b9d2cc	18
b4b9d2cc JL	19	static int
	20	tasks_show(struct seq_file f, void v)
	21	{
	22	u32 xid = 0;
	23	struct rpc_task *task = v;
	24	struct rpc_clnt *clnt = task->tk_client;
	25	const char *rpc_waitq = "none";
	26
	27	if (RPC_IS_QUEUED(task))
	28	rpc_waitq = rpc_qname(task->tk_waitqueue);
	29
	30	if (task->tk_rqstp)
	31	xid = be32_to_cpu(task->tk_rqstp->rq_xid);
	32
	33	seq_printf(f, "%5u %04x %6d 0x%x 0x%x %8ld %ps %sv%u %s a:%ps q:%s\n",
	34	task->tk_pid, task->tk_flags, task->tk_status,
5efd1876	35	clnt->cl_clid, xid, rpc_task_timeout(task), task->tk_ops,
b4b9d2cc JL	36	clnt->cl_program->name, clnt->cl_vers, rpc_proc_name(task),
	37	task->tk_action, rpc_waitq);
	38	return 0;
	39	}
	40
	41	static void *
	42	tasks_start(struct seq_file f, loff_t ppos)
	43	__acquires(&clnt->cl_lock)
	44	{
3f373e81	45	struct rpc_clnt *clnt = f->private;
b4b9d2cc	46	loff_t pos = *ppos;
b4b9d2cc JL	47	struct rpc_task *task;
b4b9d2cc JL	48
b4b9d2cc JL	49	spin_lock(&clnt->cl_lock);
	50	list_for_each_entry(task, &clnt->cl_tasks, tk_task)
	51	if (pos-- == 0)
	52	return task;
	53	return NULL;
	54	}
	55
	56	static void *
	57	tasks_next(struct seq_file f, void v, loff_t *pos)
	58	{
3f373e81	59	struct rpc_clnt *clnt = f->private;
b4b9d2cc JL	60	struct rpc_task *task = v;
	61	struct list_head *next = task->tk_task.next;
	62
b4b9d2cc JL	63	++*pos;
	64
	65	/* If there's another task on list, return it */
	66	if (next == &clnt->cl_tasks)
	67	return NULL;
	68	return list_entry(next, struct rpc_task, tk_task);
	69	}
	70
	71	static void
	72	tasks_stop(struct seq_file f, void v)
	73	__releases(&clnt->cl_lock)
	74	{
3f373e81	75	struct rpc_clnt *clnt = f->private;
b4b9d2cc JL	76	spin_unlock(&clnt->cl_lock);
	77	}
	78
	79	static const struct seq_operations tasks_seq_operations = {
	80	.start = tasks_start,
	81	.next = tasks_next,
	82	.stop = tasks_stop,
	83	.show = tasks_show,
	84	};
	85
	86	static int tasks_open(struct inode inode, struct file filp)
	87	{
3f373e81	88	int ret = seq_open(filp, &tasks_seq_operations);
b4b9d2cc JL	89	if (!ret) {
b4b9d2cc JL	90	struct seq_file *seq = filp->private_data;
3f373e81	91	struct rpc_clnt *clnt = seq->private = inode->i_private;
b4b9d2cc	92
71d3d0eb	93	if (!refcount_inc_not_zero(&clnt->cl_count)) {
3f373e81	94	seq_release(inode, filp);
b4b9d2cc JL	95	ret = -EINVAL;
	96	}
	97	}
	98
	99	return ret;
	100	}
	101
	102	static int
	103	tasks_release(struct inode inode, struct file filp)
	104	{
	105	struct seq_file *seq = filp->private_data;
3f373e81	106	struct rpc_clnt *clnt = seq->private;
b4b9d2cc	107
3f373e81 KM	108	rpc_release_client(clnt);
3f373e81 KM	109	return seq_release(inode, filp);
b4b9d2cc JL	110	}
	111
	112	static const struct file_operations tasks_fops = {
	113	.owner = THIS_MODULE,
	114	.open = tasks_open,
	115	.read = seq_read,
	116	.llseek = seq_lseek,
	117	.release = tasks_release,
	118	};
	119
2f34b8bf N	120	static int do_xprt_debugfs(struct rpc_clnt clnt, struct rpc_xprt xprt, void *numv)
	121	{
	122	int len;
	123	char name[24]; /* enough for "../../rpc_xprt/ + 8 hex digits + NULL */
	124	char link[9]; /* enough for 8 hex digits + NULL */
	125	int *nump = numv;
	126
	127	if (IS_ERR_OR_NULL(xprt->debugfs))
	128	return 0;
	129	len = snprintf(name, sizeof(name), "../../rpc_xprt/%s",
	130	xprt->debugfs->d_name.name);
35a6d396	131	if (len >= sizeof(name))
2f34b8bf N	132	return -1;
	133	if (*nump == 0)
	134	strcpy(link, "xprt");
	135	else {
	136	len = snprintf(link, sizeof(link), "xprt%d", *nump);
35a6d396	137	if (len >= sizeof(link))
2f34b8bf N	138	return -1;
2f34b8bf N	139	}
6860c981	140	debugfs_create_symlink(link, clnt->cl_debugfs, name);
2f34b8bf N	141	(*nump)++;
	142	return 0;
	143	}
	144
f9c72d10	145	void
b4b9d2cc JL	146	rpc_clnt_debugfs_register(struct rpc_clnt *clnt)
b4b9d2cc JL	147	{
f9c72d10	148	int len;
2f34b8bf N	149	char name[9]; /* enough for 8 hex digits + NULL */
2f34b8bf N	150	int xprtnum = 0;
b4b9d2cc	151
b4b9d2cc JL	152	len = snprintf(name, sizeof(name), "%x", clnt->cl_clid);
b4b9d2cc JL	153	if (len >= sizeof(name))
f9c72d10	154	return;
b4b9d2cc JL	155
	156	/* make the per-client dir */
	157	clnt->cl_debugfs = debugfs_create_dir(name, rpc_clnt_dir);
b4b9d2cc JL	158
b4b9d2cc JL	159	/* make tasks file */
0a0762c6 GKH	160	debugfs_create_file("tasks", S_IFREG \| 0400, clnt->cl_debugfs, clnt,
0a0762c6 GKH	161	&tasks_fops);
388f0c77	162
6860c981	163	rpc_clnt_iterate_for_each_xprt(clnt, do_xprt_debugfs, &xprtnum);
b4b9d2cc JL	164	}
	165
	166	void
	167	rpc_clnt_debugfs_unregister(struct rpc_clnt *clnt)
	168	{
	169	debugfs_remove_recursive(clnt->cl_debugfs);
	170	clnt->cl_debugfs = NULL;
	171	}
	172
388f0c77 JL	173	static int
	174	xprt_info_show(struct seq_file f, void v)
	175	{
	176	struct rpc_xprt *xprt = f->private;
	177
	178	seq_printf(f, "netid: %s\n", xprt->address_strings[RPC_DISPLAY_NETID]);
	179	seq_printf(f, "addr: %s\n", xprt->address_strings[RPC_DISPLAY_ADDR]);
	180	seq_printf(f, "port: %s\n", xprt->address_strings[RPC_DISPLAY_PORT]);
	181	seq_printf(f, "state: 0x%lx\n", xprt->state);
	182	return 0;
	183	}
	184
	185	static int
	186	xprt_info_open(struct inode inode, struct file filp)
	187	{
	188	int ret;
	189	struct rpc_xprt *xprt = inode->i_private;
	190
	191	ret = single_open(filp, xprt_info_show, xprt);
	192
	193	if (!ret) {
	194	if (!xprt_get(xprt)) {
	195	single_release(inode, filp);
	196	ret = -EINVAL;
	197	}
	198	}
	199	return ret;
	200	}
	201
	202	static int
	203	xprt_info_release(struct inode inode, struct file filp)
	204	{
	205	struct rpc_xprt *xprt = inode->i_private;
	206
	207	xprt_put(xprt);
	208	return single_release(inode, filp);
	209	}
	210
	211	static const struct file_operations xprt_info_fops = {
	212	.owner = THIS_MODULE,
	213	.open = xprt_info_open,
	214	.read = seq_read,
	215	.llseek = seq_lseek,
	216	.release = xprt_info_release,
	217	};
	218
f9c72d10	219	void
388f0c77 JL	220	rpc_xprt_debugfs_register(struct rpc_xprt *xprt)
	221	{
	222	int len, id;
	223	static atomic_t cur_id;
	224	char name[9]; /* 8 hex digits + NULL term */
	225
	226	id = (unsigned int)atomic_inc_return(&cur_id);
	227
	228	len = snprintf(name, sizeof(name), "%x", id);
	229	if (len >= sizeof(name))
f9c72d10	230	return;
388f0c77 JL	231
	232	/* make the per-client dir */
	233	xprt->debugfs = debugfs_create_dir(name, rpc_xprt_dir);
388f0c77 JL	234
388f0c77 JL	235	/* make tasks file */
0a0762c6 GKH	236	debugfs_create_file("info", S_IFREG \| 0400, xprt->debugfs, xprt,
0a0762c6 GKH	237	&xprt_info_fops);
388f0c77 JL	238	}
	239
	240	void
	241	rpc_xprt_debugfs_unregister(struct rpc_xprt *xprt)
	242	{
	243	debugfs_remove_recursive(xprt->debugfs);
	244	xprt->debugfs = NULL;
	245	}
	246
a4ae3081 CL	247	#if IS_ENABLED(CONFIG_FAIL_SUNRPC)
	248	struct fail_sunrpc_attr fail_sunrpc = {
	249	.attr = FAULT_ATTR_INITIALIZER,
	250	};
	251	EXPORT_SYMBOL_GPL(fail_sunrpc);
4a068258	252
a4ae3081	253	static void fail_sunrpc_init(void)
4a068258	254	{
a4ae3081	255	struct dentry *dir;
4a068258	256
a4ae3081 CL	257	dir = fault_create_debugfs_attr("fail_sunrpc", NULL,
a4ae3081 CL	258	&fail_sunrpc.attr);
4a068258	259
a4ae3081 CL	260	debugfs_create_bool("ignore-client-disconnect", S_IFREG \| 0600, dir,
a4ae3081 CL	261	&fail_sunrpc.ignore_client_disconnect);
3a126180 CL	262
	263	debugfs_create_bool("ignore-server-disconnect", S_IFREG \| 0600, dir,
	264	&fail_sunrpc.ignore_server_disconnect);
37324e6b CL	265
	266	debugfs_create_bool("ignore-cache-wait", S_IFREG \| 0600, dir,
	267	&fail_sunrpc.ignore_cache_wait);
4a068258	268	}
a4ae3081 CL	269	#else
a4ae3081 CL	270	static void fail_sunrpc_init(void)
4a068258	271	{
4a068258	272	}
c782af25 CL	273	#endif
c782af25 CL	274
b4b9d2cc JL	275	void __exit
	276	sunrpc_debugfs_exit(void)
	277	{
	278	debugfs_remove_recursive(topdir);
f9c72d10 JL	279	topdir = NULL;
	280	rpc_clnt_dir = NULL;
	281	rpc_xprt_dir = NULL;
b4b9d2cc JL	282	}
b4b9d2cc JL	283
f9c72d10	284	void __init
b4b9d2cc JL	285	sunrpc_debugfs_init(void)
b4b9d2cc JL	286	{
0a0762c6	287	topdir = debugfs_create_dir("sunrpc", NULL);
4a068258	288
b4b9d2cc	289	rpc_clnt_dir = debugfs_create_dir("rpc_clnt", topdir);
b4b9d2cc	290
388f0c77	291	rpc_xprt_dir = debugfs_create_dir("rpc_xprt", topdir);
388f0c77	292
a4ae3081	293	fail_sunrpc_init();
b4b9d2cc	294	}