[linux-block.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)
{
	struct rpc_iostats *stats;
	int i;

	stats = kcalloc(clnt->cl_maxproc, sizeof(*stats), GFP_KERNEL);
	if (stats) {
		for (i = 0; i < clnt->cl_maxproc; i++)
			spin_lock_init(&stats[i].om_lock);
	}
	return stats;
}
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
 */
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, now;

	if (!stats || !req)
		return;

	now = ktime_get();
	op_metrics = &stats[task->tk_msg.rpc_proc->p_statidx];

	spin_lock(&op_metrics->om_lock);

	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(now, task->tk_start);
	op_metrics->om_execute = ktime_add(op_metrics->om_execute, delta);

	spin_unlock(&op_metrics->om_lock);
}
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_program->name);

	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	{
edef1297 CL	119	struct rpc_iostats *stats;
	120	int i;
	121
	122	stats = kcalloc(clnt->cl_maxproc, sizeof(*stats), GFP_KERNEL);
	123	if (stats) {
	124	for (i = 0; i < clnt->cl_maxproc; i++)
	125	spin_lock_init(&stats[i].om_lock);
	126	}
	127	return stats;
11c556b3	128	}
e8914c65	129	EXPORT_SYMBOL_GPL(rpc_alloc_iostats);
11c556b3 CL	130
	131	/**
	132	* rpc_free_iostats - release an rpc_iostats structure
	133	* @stats: doomed rpc_iostats structure
	134	*
	135	*/
	136	void rpc_free_iostats(struct rpc_iostats *stats)
	137	{
	138	kfree(stats);
	139	}
e8914c65	140	EXPORT_SYMBOL_GPL(rpc_free_iostats);
11c556b3 CL	141
	142	/**
	143	* rpc_count_iostats - tally up per-task stats
	144	* @task: completed rpc_task
0a702195	145	* @stats: array of stat structures
11c556b3	146	*/
0a702195	147	void rpc_count_iostats(const struct rpc_task task, struct rpc_iostats stats)
11c556b3 CL	148	{
11c556b3 CL	149	struct rpc_rqst *req = task->tk_rqstp;
11c556b3	150	struct rpc_iostats *op_metrics;
edef1297	151	ktime_t delta, now;
11c556b3	152
0a702195	153	if (!stats \|\| !req)
11c556b3	154	return;
55ae1aab	155
edef1297	156	now = ktime_get();
cc0175c1	157	op_metrics = &stats[task->tk_msg.rpc_proc->p_statidx];
11c556b3	158
edef1297 CL	159	spin_lock(&op_metrics->om_lock);
edef1297 CL	160
11c556b3 CL	161	op_metrics->om_ops++;
	162	op_metrics->om_ntrans += req->rq_ntrans;
	163	op_metrics->om_timeouts += task->tk_timeouts;
	164
d60dbb20	165	op_metrics->om_bytes_sent += req->rq_xmit_bytes_sent;
dd2b63d0	166	op_metrics->om_bytes_recv += req->rq_reply_bytes_recvd;
11c556b3	167
ff839970 CL	168	delta = ktime_sub(req->rq_xtime, task->tk_start);
ff839970 CL	169	op_metrics->om_queue = ktime_add(op_metrics->om_queue, delta);
11c556b3	170
d60dbb20	171	op_metrics->om_rtt = ktime_add(op_metrics->om_rtt, req->rq_rtt);
11c556b3	172
edef1297	173	delta = ktime_sub(now, task->tk_start);
ff839970	174	op_metrics->om_execute = ktime_add(op_metrics->om_execute, delta);
edef1297 CL	175
edef1297 CL	176	spin_unlock(&op_metrics->om_lock);
11c556b3	177	}
0a702195	178	EXPORT_SYMBOL_GPL(rpc_count_iostats);
11c556b3	179
ec535ce1 AB	180	static void _print_name(struct seq_file *seq, unsigned int op,
ec535ce1 AB	181	struct rpc_procinfo *procs)
cc0175c1 CL	182	{
	183	if (procs[op].p_name)
	184	seq_printf(seq, "\t%12s: ", procs[op].p_name);
	185	else if (op == 0)
	186	seq_printf(seq, "\t NULL: ");
	187	else
	188	seq_printf(seq, "\t%12u: ", op);
	189	}
	190
11c556b3 CL	191	void rpc_print_iostats(struct seq_file seq, struct rpc_clnt clnt)
	192	{
	193	struct rpc_iostats *stats = clnt->cl_metrics;
2446ab60	194	struct rpc_xprt *xprt;
11c556b3 CL	195	unsigned int op, maxproc = clnt->cl_maxproc;
	196
	197	if (!stats)
	198	return;
	199
	200	seq_printf(seq, "\tRPC iostats version: %s ", RPC_IOSTATS_VERS);
	201	seq_printf(seq, "p/v: %u/%u (%s)\n",
55909f21	202	clnt->cl_prog, clnt->cl_vers, clnt->cl_program->name);
11c556b3	203
2446ab60 TM	204	rcu_read_lock();
2446ab60 TM	205	xprt = rcu_dereference(clnt->cl_xprt);
11c556b3 CL	206	if (xprt)
11c556b3 CL	207	xprt->ops->print_stats(xprt, seq);
2446ab60	208	rcu_read_unlock();
11c556b3 CL	209
	210	seq_printf(seq, "\tper-op statistics\n");
	211	for (op = 0; op < maxproc; op++) {
	212	struct rpc_iostats *metrics = &stats[op];
cc0175c1	213	_print_name(seq, op, clnt->cl_procinfo);
11c556b3 CL	214	seq_printf(seq, "%lu %lu %lu %Lu %Lu %Lu %Lu %Lu\n",
	215	metrics->om_ops,
	216	metrics->om_ntrans,
	217	metrics->om_timeouts,
	218	metrics->om_bytes_sent,
	219	metrics->om_bytes_recv,
ff839970 CL	220	ktime_to_ms(metrics->om_queue),
	221	ktime_to_ms(metrics->om_rtt),
	222	ktime_to_ms(metrics->om_execute));
11c556b3 CL	223	}
11c556b3 CL	224	}
e8914c65	225	EXPORT_SYMBOL_GPL(rpc_print_iostats);
11c556b3	226
1da177e4 LT	227	/*
	228	* Register/unregister RPC proc files
	229	*/
	230	static inline struct proc_dir_entry *
ec7652aa SK	231	do_register(struct net net, const char name, void *data,
ec7652aa SK	232	const struct file_operations *fops)
1da177e4	233	{
4f42d0d5	234	struct sunrpc_net *sn;
1da177e4	235
4f42d0d5	236	dprintk("RPC: registering /proc/net/rpc/%s\n", name);
ec7652aa	237	sn = net_generic(net, sunrpc_net_id);
4f42d0d5	238	return proc_create_data(name, 0, sn->proc_net_rpc, fops, data);
1da177e4 LT	239	}
	240
	241	struct proc_dir_entry *
ec7652aa	242	rpc_proc_register(struct net net, struct rpc_stat statp)
1da177e4	243	{
ec7652aa	244	return do_register(net, statp->program->name, statp, &rpc_proc_fops);
1da177e4	245	}
e8914c65	246	EXPORT_SYMBOL_GPL(rpc_proc_register);
1da177e4 LT	247
1da177e4 LT	248	void
ec7652aa	249	rpc_proc_unregister(struct net net, const char name)
1da177e4	250	{
4f42d0d5 PE	251	struct sunrpc_net *sn;
4f42d0d5 PE	252
ec7652aa	253	sn = net_generic(net, sunrpc_net_id);
4f42d0d5	254	remove_proc_entry(name, sn->proc_net_rpc);
1da177e4	255	}
e8914c65	256	EXPORT_SYMBOL_GPL(rpc_proc_unregister);
1da177e4 LT	257
1da177e4 LT	258	struct proc_dir_entry *
246590f5	259	svc_proc_register(struct net net, struct svc_stat statp, const struct file_operations *fops)
1da177e4	260	{
246590f5	261	return do_register(net, statp->program->pg_name, statp, fops);
1da177e4	262	}
24c3767e	263	EXPORT_SYMBOL_GPL(svc_proc_register);
1da177e4 LT	264
1da177e4 LT	265	void
246590f5	266	svc_proc_unregister(struct net net, const char name)
1da177e4	267	{
4f42d0d5 PE	268	struct sunrpc_net *sn;
4f42d0d5 PE	269
246590f5	270	sn = net_generic(net, sunrpc_net_id);
4f42d0d5	271	remove_proc_entry(name, sn->proc_net_rpc);
1da177e4	272	}
24c3767e	273	EXPORT_SYMBOL_GPL(svc_proc_unregister);
1da177e4	274
4f42d0d5	275	int rpc_proc_init(struct net *net)
1da177e4	276	{
4f42d0d5 PE	277	struct sunrpc_net *sn;
4f42d0d5 PE	278
46121cf7	279	dprintk("RPC: registering /proc/net/rpc\n");
4f42d0d5 PE	280	sn = net_generic(net, sunrpc_net_id);
	281	sn->proc_net_rpc = proc_mkdir("rpc", net->proc_net);
	282	if (sn->proc_net_rpc == NULL)
	283	return -ENOMEM;
	284
	285	return 0;
1da177e4 LT	286	}
1da177e4 LT	287
4f42d0d5	288	void rpc_proc_exit(struct net *net)
1da177e4	289	{
46121cf7	290	dprintk("RPC: unregistering /proc/net/rpc\n");
4f42d0d5	291	remove_proc_entry("rpc", net->proc_net);
1da177e4 LT	292	}
1da177e4 LT	293