[mirror_ubuntu-bionic-kernel.git] / net / sunrpc / stats.c

/*
 * linux/net/sunrpc/stats.c
 *
 * procfs-based user access to generic RPC statistics. The stats files
 * reside in /proc/net/rpc.
 *
 * The read routines assume that the buffer passed in is just big enough.
 * If you implement an RPC service that has its own stats routine which
 * appends the generic RPC stats, make sure you don't exceed the PAGE_SIZE
 * limit.
 *
 * Copyright (C) 1995, 1996, 1997 Olaf Kirch <okir@monad.swb.de>
 */

#include <linux/module.h>
#include <linux/slab.h>

#include <linux/init.h>
#include <linux/kernel.h>
#include <linux/proc_fs.h>
#include <linux/seq_file.h>
#include <linux/sunrpc/clnt.h>
#include <linux/sunrpc/svcsock.h>
#include <linux/sunrpc/metrics.h>
#include <linux/rcupdate.h>

#include "netns.h"

#define RPCDBG_FACILITY	RPCDBG_MISC

/*
 * Get RPC client stats
 */
static int rpc_proc_show(struct seq_file *seq, void *v) {
	const struct rpc_stat	*statp = seq->private;
	const struct rpc_program *prog = statp->program;
	unsigned int i, j;

	seq_printf(seq,
		"net %u %u %u %u\n",
			statp->netcnt,
			statp->netudpcnt,
			statp->nettcpcnt,
			statp->nettcpconn);
	seq_printf(seq,
		"rpc %u %u %u\n",
			statp->rpccnt,
			statp->rpcretrans,
			statp->rpcauthrefresh);

	for (i = 0; i < prog->nrvers; i++) {
		const struct rpc_version *vers = prog->version[i];
		if (!vers)
			continue;
		seq_printf(seq, "proc%u %u",
					vers->number, vers->nrprocs);
		for (j = 0; j < vers->nrprocs; j++)
			seq_printf(seq, " %u",
					vers->procs[j].p_count);
		seq_putc(seq, '\n');
	}
	return 0;
}

static int rpc_proc_open(struct inode *inode, struct file *file)
{
	return single_open(file, rpc_proc_show, PDE_DATA(inode));
}

static const struct file_operations rpc_proc_fops = {
	.owner = THIS_MODULE,
	.open = rpc_proc_open,
	.read  = seq_read,
	.llseek = seq_lseek,
	.release = single_release,
};

/*
 * Get RPC server stats
 */
void svc_seq_show(struct seq_file *seq, const struct svc_stat *statp) {
	const struct svc_program *prog = statp->program;
	const struct svc_procedure *proc;
	const struct svc_version *vers;
	unsigned int i, j;

	seq_printf(seq,
		"net %u %u %u %u\n",
			statp->netcnt,
			statp->netudpcnt,
			statp->nettcpcnt,
			statp->nettcpconn);
	seq_printf(seq,
		"rpc %u %u %u %u %u\n",
			statp->rpccnt,
			statp->rpcbadfmt+statp->rpcbadauth+statp->rpcbadclnt,
			statp->rpcbadfmt,
			statp->rpcbadauth,
			statp->rpcbadclnt);

	for (i = 0; i < prog->pg_nvers; i++) {
		if (!(vers = prog->pg_vers[i]) || !(proc = vers->vs_proc))
			continue;
		seq_printf(seq, "proc%d %u", i, vers->vs_nproc);
		for (j = 0; j < vers->vs_nproc; j++, proc++)
			seq_printf(seq, " %u", proc->pc_count);
		seq_putc(seq, '\n');
	}
}
EXPORT_SYMBOL_GPL(svc_seq_show);

/**
 * rpc_alloc_iostats - allocate an rpc_iostats structure
 * @clnt: RPC program, version, and xprt
 *
 */
struct rpc_iostats *rpc_alloc_iostats(struct rpc_clnt *clnt)
{
	return kcalloc(clnt->cl_maxproc, sizeof(struct rpc_iostats), GFP_KERNEL);
}
EXPORT_SYMBOL_GPL(rpc_alloc_iostats);

/**
 * rpc_free_iostats - release an rpc_iostats structure
 * @stats: doomed rpc_iostats structure
 *
 */
void rpc_free_iostats(struct rpc_iostats *stats)
{
	kfree(stats);
}
EXPORT_SYMBOL_GPL(rpc_free_iostats);

/**
 * rpc_count_iostats - tally up per-task stats
 * @task: completed rpc_task
 * @stats: array of stat structures
 *
 * Relies on the caller for serialization.
 */
void rpc_count_iostats(const struct rpc_task *task, struct rpc_iostats *stats)
{
	struct rpc_rqst *req = task->tk_rqstp;
	struct rpc_iostats *op_metrics;
	ktime_t delta;

	if (!stats || !req)
		return;

	op_metrics = &stats[task->tk_msg.rpc_proc->p_statidx];

	op_metrics->om_ops++;
	op_metrics->om_ntrans += req->rq_ntrans;
	op_metrics->om_timeouts += task->tk_timeouts;

	op_metrics->om_bytes_sent += req->rq_xmit_bytes_sent;
	op_metrics->om_bytes_recv += req->rq_reply_bytes_recvd;

	delta = ktime_sub(req->rq_xtime, task->tk_start);
	op_metrics->om_queue = ktime_add(op_metrics->om_queue, delta);

	op_metrics->om_rtt = ktime_add(op_metrics->om_rtt, req->rq_rtt);

	delta = ktime_sub(ktime_get(), task->tk_start);
	op_metrics->om_execute = ktime_add(op_metrics->om_execute, delta);
}
EXPORT_SYMBOL_GPL(rpc_count_iostats);

static void _print_name(struct seq_file *seq, unsigned int op,
			struct rpc_procinfo *procs)
{
	if (procs[op].p_name)
		seq_printf(seq, "\t%12s: ", procs[op].p_name);
	else if (op == 0)
		seq_printf(seq, "\t        NULL: ");
	else
		seq_printf(seq, "\t%12u: ", op);
}

void rpc_print_iostats(struct seq_file *seq, struct rpc_clnt *clnt)
{
	struct rpc_iostats *stats = clnt->cl_metrics;
	struct rpc_xprt *xprt;
	unsigned int op, maxproc = clnt->cl_maxproc;

	if (!stats)
		return;

	seq_printf(seq, "\tRPC iostats version: %s  ", RPC_IOSTATS_VERS);
	seq_printf(seq, "p/v: %u/%u (%s)\n",
			clnt->cl_prog, clnt->cl_vers, clnt->cl_protname);

	rcu_read_lock();
	xprt = rcu_dereference(clnt->cl_xprt);
	if (xprt)
		xprt->ops->print_stats(xprt, seq);
	rcu_read_unlock();

	seq_printf(seq, "\tper-op statistics\n");
	for (op = 0; op < maxproc; op++) {
		struct rpc_iostats *metrics = &stats[op];
		_print_name(seq, op, clnt->cl_procinfo);
		seq_printf(seq, "%lu %lu %lu %Lu %Lu %Lu %Lu %Lu\n",
				metrics->om_ops,
				metrics->om_ntrans,
				metrics->om_timeouts,
				metrics->om_bytes_sent,
				metrics->om_bytes_recv,
				ktime_to_ms(metrics->om_queue),
				ktime_to_ms(metrics->om_rtt),
				ktime_to_ms(metrics->om_execute));
	}
}
EXPORT_SYMBOL_GPL(rpc_print_iostats);

/*
 * Register/unregister RPC proc files
 */
static inline struct proc_dir_entry *
do_register(struct net *net, const char *name, void *data,
	    const struct file_operations *fops)
{
	struct sunrpc_net *sn;

	dprintk("RPC:       registering /proc/net/rpc/%s\n", name);
	sn = net_generic(net, sunrpc_net_id);
	return proc_create_data(name, 0, sn->proc_net_rpc, fops, data);
}

struct proc_dir_entry *
rpc_proc_register(struct net *net, struct rpc_stat *statp)
{
	return do_register(net, statp->program->name, statp, &rpc_proc_fops);
}
EXPORT_SYMBOL_GPL(rpc_proc_register);

void
rpc_proc_unregister(struct net *net, const char *name)
{
	struct sunrpc_net *sn;

	sn = net_generic(net, sunrpc_net_id);
	remove_proc_entry(name, sn->proc_net_rpc);
}
EXPORT_SYMBOL_GPL(rpc_proc_unregister);

struct proc_dir_entry *
svc_proc_register(struct net *net, struct svc_stat *statp, const struct file_operations *fops)
{
	return do_register(net, statp->program->pg_name, statp, fops);
}
EXPORT_SYMBOL_GPL(svc_proc_register);

void
svc_proc_unregister(struct net *net, const char *name)
{
	struct sunrpc_net *sn;

	sn = net_generic(net, sunrpc_net_id);
	remove_proc_entry(name, sn->proc_net_rpc);
}
EXPORT_SYMBOL_GPL(svc_proc_unregister);

int rpc_proc_init(struct net *net)
{
	struct sunrpc_net *sn;

	dprintk("RPC:       registering /proc/net/rpc\n");
	sn = net_generic(net, sunrpc_net_id);
	sn->proc_net_rpc = proc_mkdir("rpc", net->proc_net);
	if (sn->proc_net_rpc == NULL)
		return -ENOMEM;

	return 0;
}

void rpc_proc_exit(struct net *net)
{
	dprintk("RPC:       unregistering /proc/net/rpc\n");
	remove_proc_entry("rpc", net->proc_net);
}
Commit	Line	Data
1da177e4 LT	1	/*
	2	* linux/net/sunrpc/stats.c
	3	*
	4	* procfs-based user access to generic RPC statistics. The stats files
	5	* reside in /proc/net/rpc.
	6	*
	7	* The read routines assume that the buffer passed in is just big enough.
	8	* If you implement an RPC service that has its own stats routine which
	9	* appends the generic RPC stats, make sure you don't exceed the PAGE_SIZE
	10	* limit.
	11	*
	12	* Copyright (C) 1995, 1996, 1997 Olaf Kirch <okir@monad.swb.de>
	13	*/
	14
	15	#include <linux/module.h>
5a0e3ad6	16	#include <linux/slab.h>
1da177e4 LT	17
	18	#include <linux/init.h>
	19	#include <linux/kernel.h>
1da177e4 LT	20	#include <linux/proc_fs.h>
	21	#include <linux/seq_file.h>
	22	#include <linux/sunrpc/clnt.h>
	23	#include <linux/sunrpc/svcsock.h>
11c556b3	24	#include <linux/sunrpc/metrics.h>
2446ab60	25	#include <linux/rcupdate.h>
1da177e4	26
4f42d0d5	27	#include "netns.h"
1da177e4	28
4f42d0d5	29	#define RPCDBG_FACILITY RPCDBG_MISC
1da177e4 LT	30
	31	/*
	32	* Get RPC client stats
	33	*/
	34	static int rpc_proc_show(struct seq_file seq, void v) {
	35	const struct rpc_stat *statp = seq->private;
	36	const struct rpc_program *prog = statp->program;
ea339d46	37	unsigned int i, j;
1da177e4 LT	38
1da177e4 LT	39	seq_printf(seq,
49e31cba	40	"net %u %u %u %u\n",
1da177e4 LT	41	statp->netcnt,
	42	statp->netudpcnt,
	43	statp->nettcpcnt,
	44	statp->nettcpconn);
	45	seq_printf(seq,
49e31cba	46	"rpc %u %u %u\n",
1da177e4 LT	47	statp->rpccnt,
	48	statp->rpcretrans,
	49	statp->rpcauthrefresh);
	50
	51	for (i = 0; i < prog->nrvers; i++) {
	52	const struct rpc_version *vers = prog->version[i];
	53	if (!vers)
	54	continue;
49e31cba	55	seq_printf(seq, "proc%u %u",
1da177e4 LT	56	vers->number, vers->nrprocs);
1da177e4 LT	57	for (j = 0; j < vers->nrprocs; j++)
49e31cba	58	seq_printf(seq, " %u",
1da177e4 LT	59	vers->procs[j].p_count);
	60	seq_putc(seq, '\n');
	61	}
	62	return 0;
	63	}
	64
	65	static int rpc_proc_open(struct inode inode, struct file file)
	66	{
d9dda78b	67	return single_open(file, rpc_proc_show, PDE_DATA(inode));
1da177e4 LT	68	}
1da177e4 LT	69
da7071d7	70	static const struct file_operations rpc_proc_fops = {
1da177e4 LT	71	.owner = THIS_MODULE,
	72	.open = rpc_proc_open,
	73	.read = seq_read,
	74	.llseek = seq_lseek,
	75	.release = single_release,
	76	};
	77
	78	/*
	79	* Get RPC server stats
	80	*/
	81	void svc_seq_show(struct seq_file seq, const struct svc_stat statp) {
	82	const struct svc_program *prog = statp->program;
	83	const struct svc_procedure *proc;
	84	const struct svc_version *vers;
ea339d46	85	unsigned int i, j;
1da177e4 LT	86
1da177e4 LT	87	seq_printf(seq,
49e31cba	88	"net %u %u %u %u\n",
1da177e4 LT	89	statp->netcnt,
	90	statp->netudpcnt,
	91	statp->nettcpcnt,
	92	statp->nettcpconn);
	93	seq_printf(seq,
49e31cba	94	"rpc %u %u %u %u %u\n",
1da177e4 LT	95	statp->rpccnt,
	96	statp->rpcbadfmt+statp->rpcbadauth+statp->rpcbadclnt,
	97	statp->rpcbadfmt,
	98	statp->rpcbadauth,
	99	statp->rpcbadclnt);
	100
	101	for (i = 0; i < prog->pg_nvers; i++) {
	102	if (!(vers = prog->pg_vers[i]) \|\| !(proc = vers->vs_proc))
	103	continue;
49e31cba	104	seq_printf(seq, "proc%d %u", i, vers->vs_nproc);
1da177e4	105	for (j = 0; j < vers->vs_nproc; j++, proc++)
49e31cba	106	seq_printf(seq, " %u", proc->pc_count);
1da177e4 LT	107	seq_putc(seq, '\n');
	108	}
	109	}
24c3767e	110	EXPORT_SYMBOL_GPL(svc_seq_show);
1da177e4	111
11c556b3 CL	112	/**
	113	* rpc_alloc_iostats - allocate an rpc_iostats structure
	114	* @clnt: RPC program, version, and xprt
	115	*
	116	*/
	117	struct rpc_iostats rpc_alloc_iostats(struct rpc_clnt clnt)
	118	{
94f58df8	119	return kcalloc(clnt->cl_maxproc, sizeof(struct rpc_iostats), GFP_KERNEL);
11c556b3	120	}
e8914c65	121	EXPORT_SYMBOL_GPL(rpc_alloc_iostats);
11c556b3 CL	122
	123	/**
	124	* rpc_free_iostats - release an rpc_iostats structure
	125	* @stats: doomed rpc_iostats structure
	126	*
	127	*/
	128	void rpc_free_iostats(struct rpc_iostats *stats)
	129	{
	130	kfree(stats);
	131	}
e8914c65	132	EXPORT_SYMBOL_GPL(rpc_free_iostats);
11c556b3 CL	133
	134	/**
	135	* rpc_count_iostats - tally up per-task stats
	136	* @task: completed rpc_task
0a702195	137	* @stats: array of stat structures
11c556b3 CL	138	*
	139	* Relies on the caller for serialization.
	140	*/
0a702195	141	void rpc_count_iostats(const struct rpc_task task, struct rpc_iostats stats)
11c556b3 CL	142	{
11c556b3 CL	143	struct rpc_rqst *req = task->tk_rqstp;
11c556b3	144	struct rpc_iostats *op_metrics;
ff839970	145	ktime_t delta;
11c556b3	146
0a702195	147	if (!stats \|\| !req)
11c556b3	148	return;
55ae1aab	149
cc0175c1	150	op_metrics = &stats[task->tk_msg.rpc_proc->p_statidx];
11c556b3 CL	151
	152	op_metrics->om_ops++;
	153	op_metrics->om_ntrans += req->rq_ntrans;
	154	op_metrics->om_timeouts += task->tk_timeouts;
	155
d60dbb20	156	op_metrics->om_bytes_sent += req->rq_xmit_bytes_sent;
dd2b63d0	157	op_metrics->om_bytes_recv += req->rq_reply_bytes_recvd;
11c556b3	158
ff839970 CL	159	delta = ktime_sub(req->rq_xtime, task->tk_start);
ff839970 CL	160	op_metrics->om_queue = ktime_add(op_metrics->om_queue, delta);
11c556b3	161
d60dbb20	162	op_metrics->om_rtt = ktime_add(op_metrics->om_rtt, req->rq_rtt);
11c556b3	163
ff839970 CL	164	delta = ktime_sub(ktime_get(), task->tk_start);
ff839970 CL	165	op_metrics->om_execute = ktime_add(op_metrics->om_execute, delta);
11c556b3	166	}
0a702195	167	EXPORT_SYMBOL_GPL(rpc_count_iostats);
11c556b3	168
ec535ce1 AB	169	static void _print_name(struct seq_file *seq, unsigned int op,
ec535ce1 AB	170	struct rpc_procinfo *procs)
cc0175c1 CL	171	{
	172	if (procs[op].p_name)
	173	seq_printf(seq, "\t%12s: ", procs[op].p_name);
	174	else if (op == 0)
	175	seq_printf(seq, "\t NULL: ");
	176	else
	177	seq_printf(seq, "\t%12u: ", op);
	178	}
	179
11c556b3 CL	180	void rpc_print_iostats(struct seq_file seq, struct rpc_clnt clnt)
	181	{
	182	struct rpc_iostats *stats = clnt->cl_metrics;
2446ab60	183	struct rpc_xprt *xprt;
11c556b3 CL	184	unsigned int op, maxproc = clnt->cl_maxproc;
	185
	186	if (!stats)
	187	return;
	188
	189	seq_printf(seq, "\tRPC iostats version: %s ", RPC_IOSTATS_VERS);
	190	seq_printf(seq, "p/v: %u/%u (%s)\n",
	191	clnt->cl_prog, clnt->cl_vers, clnt->cl_protname);
	192
2446ab60 TM	193	rcu_read_lock();
2446ab60 TM	194	xprt = rcu_dereference(clnt->cl_xprt);
11c556b3 CL	195	if (xprt)
11c556b3 CL	196	xprt->ops->print_stats(xprt, seq);
2446ab60	197	rcu_read_unlock();
11c556b3 CL	198
	199	seq_printf(seq, "\tper-op statistics\n");
	200	for (op = 0; op < maxproc; op++) {
	201	struct rpc_iostats *metrics = &stats[op];
cc0175c1	202	_print_name(seq, op, clnt->cl_procinfo);
11c556b3 CL	203	seq_printf(seq, "%lu %lu %lu %Lu %Lu %Lu %Lu %Lu\n",
	204	metrics->om_ops,
	205	metrics->om_ntrans,
	206	metrics->om_timeouts,
	207	metrics->om_bytes_sent,
	208	metrics->om_bytes_recv,
ff839970 CL	209	ktime_to_ms(metrics->om_queue),
	210	ktime_to_ms(metrics->om_rtt),
	211	ktime_to_ms(metrics->om_execute));
11c556b3 CL	212	}
11c556b3 CL	213	}
e8914c65	214	EXPORT_SYMBOL_GPL(rpc_print_iostats);
11c556b3	215
1da177e4 LT	216	/*
	217	* Register/unregister RPC proc files
	218	*/
	219	static inline struct proc_dir_entry *
ec7652aa SK	220	do_register(struct net net, const char name, void *data,
ec7652aa SK	221	const struct file_operations *fops)
1da177e4	222	{
4f42d0d5	223	struct sunrpc_net *sn;
1da177e4	224
4f42d0d5	225	dprintk("RPC: registering /proc/net/rpc/%s\n", name);
ec7652aa	226	sn = net_generic(net, sunrpc_net_id);
4f42d0d5	227	return proc_create_data(name, 0, sn->proc_net_rpc, fops, data);
1da177e4 LT	228	}
	229
	230	struct proc_dir_entry *
ec7652aa	231	rpc_proc_register(struct net net, struct rpc_stat statp)
1da177e4	232	{
ec7652aa	233	return do_register(net, statp->program->name, statp, &rpc_proc_fops);
1da177e4	234	}
e8914c65	235	EXPORT_SYMBOL_GPL(rpc_proc_register);
1da177e4 LT	236
1da177e4 LT	237	void
ec7652aa	238	rpc_proc_unregister(struct net net, const char name)
1da177e4	239	{
4f42d0d5 PE	240	struct sunrpc_net *sn;
4f42d0d5 PE	241
ec7652aa	242	sn = net_generic(net, sunrpc_net_id);
4f42d0d5	243	remove_proc_entry(name, sn->proc_net_rpc);
1da177e4	244	}
e8914c65	245	EXPORT_SYMBOL_GPL(rpc_proc_unregister);
1da177e4 LT	246
1da177e4 LT	247	struct proc_dir_entry *
246590f5	248	svc_proc_register(struct net net, struct svc_stat statp, const struct file_operations *fops)
1da177e4	249	{
246590f5	250	return do_register(net, statp->program->pg_name, statp, fops);
1da177e4	251	}
24c3767e	252	EXPORT_SYMBOL_GPL(svc_proc_register);
1da177e4 LT	253
1da177e4 LT	254	void
246590f5	255	svc_proc_unregister(struct net net, const char name)
1da177e4	256	{
4f42d0d5 PE	257	struct sunrpc_net *sn;
4f42d0d5 PE	258
246590f5	259	sn = net_generic(net, sunrpc_net_id);
4f42d0d5	260	remove_proc_entry(name, sn->proc_net_rpc);
1da177e4	261	}
24c3767e	262	EXPORT_SYMBOL_GPL(svc_proc_unregister);
1da177e4	263
4f42d0d5	264	int rpc_proc_init(struct net *net)
1da177e4	265	{
4f42d0d5 PE	266	struct sunrpc_net *sn;
4f42d0d5 PE	267
46121cf7	268	dprintk("RPC: registering /proc/net/rpc\n");
4f42d0d5 PE	269	sn = net_generic(net, sunrpc_net_id);
	270	sn->proc_net_rpc = proc_mkdir("rpc", net->proc_net);
	271	if (sn->proc_net_rpc == NULL)
	272	return -ENOMEM;
	273
	274	return 0;
1da177e4 LT	275	}
1da177e4 LT	276
4f42d0d5	277	void rpc_proc_exit(struct net *net)
1da177e4	278	{
46121cf7	279	dprintk("RPC: unregistering /proc/net/rpc\n");
4f42d0d5	280	remove_proc_entry("rpc", net->proc_net);
1da177e4 LT	281	}
1da177e4 LT	282