[mirror_ubuntu-artful-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->counts[j]);
		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_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++) {
		vers = prog->pg_vers[i];
		if (!vers)
			continue;
		seq_printf(seq, "proc%d %u", i, vers->vs_nproc);
		for (j = 0; j < vers->vs_nproc; j++)
			seq_printf(seq, " %u", vers->vs_count[j]);
		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_metrics - tally up per-task stats
 * @task: completed rpc_task
 * @op_metrics: stat structure for OP that will accumulate stats from @task
 */
void rpc_count_iostats_metrics(const struct rpc_task *task,
			       struct rpc_iostats *op_metrics)
{
	struct rpc_rqst *req = task->tk_rqstp;
	ktime_t delta, now;

	if (!op_metrics || !req)
		return;

	now = ktime_get();
	spin_lock(&op_metrics->om_lock);

	op_metrics->om_ops++;
	/* kernel API: om_ops must never become larger than om_ntrans */
	op_metrics->om_ntrans += max(req->rq_ntrans, 1);
	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;

	if (ktime_to_ns(req->rq_xtime)) {
		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_metrics);

/**
 * rpc_count_iostats - tally up per-task stats
 * @task: completed rpc_task
 * @stats: array of stat structures
 *
 * Uses the statidx from @task
 */
void rpc_count_iostats(const struct rpc_task *task, struct rpc_iostats *stats)
{
	rpc_count_iostats_metrics(task,
				  &stats[task->tk_msg.rpc_proc->p_statidx]);
}
EXPORT_SYMBOL_GPL(rpc_count_iostats);

static void _print_name(struct seq_file *seq, unsigned int op,
			const 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++)
1c5876dd	58	seq_printf(seq, " %u", vers->counts[j]);
1da177e4 LT	59	seq_putc(seq, '\n');
	60	}
	61	return 0;
	62	}
	63
	64	static int rpc_proc_open(struct inode inode, struct file file)
	65	{
d9dda78b	66	return single_open(file, rpc_proc_show, PDE_DATA(inode));
1da177e4 LT	67	}
1da177e4 LT	68
da7071d7	69	static const struct file_operations rpc_proc_fops = {
1da177e4 LT	70	.owner = THIS_MODULE,
	71	.open = rpc_proc_open,
	72	.read = seq_read,
	73	.llseek = seq_lseek,
	74	.release = single_release,
	75	};
	76
	77	/*
	78	* Get RPC server stats
	79	*/
7fd38af9 CH	80	void svc_seq_show(struct seq_file seq, const struct svc_stat statp)
7fd38af9 CH	81	{
1da177e4	82	const struct svc_program *prog = statp->program;
1da177e4	83	const struct svc_version *vers;
ea339d46	84	unsigned int i, j;
1da177e4 LT	85
1da177e4 LT	86	seq_printf(seq,
49e31cba	87	"net %u %u %u %u\n",
1da177e4 LT	88	statp->netcnt,
	89	statp->netudpcnt,
	90	statp->nettcpcnt,
	91	statp->nettcpconn);
	92	seq_printf(seq,
49e31cba	93	"rpc %u %u %u %u %u\n",
1da177e4 LT	94	statp->rpccnt,
	95	statp->rpcbadfmt+statp->rpcbadauth+statp->rpcbadclnt,
	96	statp->rpcbadfmt,
	97	statp->rpcbadauth,
	98	statp->rpcbadclnt);
	99
	100	for (i = 0; i < prog->pg_nvers; i++) {
7fd38af9 CH	101	vers = prog->pg_vers[i];
7fd38af9 CH	102	if (!vers)
1da177e4	103	continue;
49e31cba	104	seq_printf(seq, "proc%d %u", i, vers->vs_nproc);
7fd38af9 CH	105	for (j = 0; j < vers->vs_nproc; j++)
7fd38af9 CH	106	seq_printf(seq, " %u", vers->vs_count[j]);
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
11c556b3 CL	142	/**
840210fc	143	* rpc_count_iostats_metrics - tally up per-task stats
11c556b3	144	* @task: completed rpc_task
840210fc	145	* @op_metrics: stat structure for OP that will accumulate stats from @task
11c556b3	146	*/
840210fc WAA	147	void rpc_count_iostats_metrics(const struct rpc_task *task,
840210fc WAA	148	struct rpc_iostats *op_metrics)
11c556b3 CL	149	{
11c556b3 CL	150	struct rpc_rqst *req = task->tk_rqstp;
edef1297	151	ktime_t delta, now;
11c556b3	152
840210fc	153	if (!op_metrics \|\| !req)
11c556b3	154	return;
55ae1aab	155
edef1297	156	now = ktime_get();
edef1297 CL	157	spin_lock(&op_metrics->om_lock);
edef1297 CL	158
11c556b3	159	op_metrics->om_ops++;
ae09531d CL	160	/* kernel API: om_ops must never become larger than om_ntrans */
ae09531d CL	161	op_metrics->om_ntrans += max(req->rq_ntrans, 1);
11c556b3 CL	162	op_metrics->om_timeouts += task->tk_timeouts;
11c556b3 CL	163
d60dbb20	164	op_metrics->om_bytes_sent += req->rq_xmit_bytes_sent;
dd2b63d0	165	op_metrics->om_bytes_recv += req->rq_reply_bytes_recvd;
11c556b3	166
ae09531d CL	167	if (ktime_to_ns(req->rq_xtime)) {
	168	delta = ktime_sub(req->rq_xtime, task->tk_start);
	169	op_metrics->om_queue = ktime_add(op_metrics->om_queue, delta);
	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	}
840210fc WAA	178	EXPORT_SYMBOL_GPL(rpc_count_iostats_metrics);
	179
	180	/**
	181	* rpc_count_iostats - tally up per-task stats
	182	* @task: completed rpc_task
	183	* @stats: array of stat structures
	184	*
	185	* Uses the statidx from @task
	186	*/
	187	void rpc_count_iostats(const struct rpc_task task, struct rpc_iostats stats)
	188	{
	189	rpc_count_iostats_metrics(task,
	190	&stats[task->tk_msg.rpc_proc->p_statidx]);
	191	}
0a702195	192	EXPORT_SYMBOL_GPL(rpc_count_iostats);
11c556b3	193
ec535ce1	194	static void _print_name(struct seq_file *seq, unsigned int op,
499b4988	195	const struct rpc_procinfo *procs)
cc0175c1 CL	196	{
	197	if (procs[op].p_name)
	198	seq_printf(seq, "\t%12s: ", procs[op].p_name);
	199	else if (op == 0)
	200	seq_printf(seq, "\t NULL: ");
	201	else
	202	seq_printf(seq, "\t%12u: ", op);
	203	}
	204
11c556b3 CL	205	void rpc_print_iostats(struct seq_file seq, struct rpc_clnt clnt)
	206	{
	207	struct rpc_iostats *stats = clnt->cl_metrics;
2446ab60	208	struct rpc_xprt *xprt;
11c556b3 CL	209	unsigned int op, maxproc = clnt->cl_maxproc;
	210
	211	if (!stats)
	212	return;
	213
	214	seq_printf(seq, "\tRPC iostats version: %s ", RPC_IOSTATS_VERS);
	215	seq_printf(seq, "p/v: %u/%u (%s)\n",
55909f21	216	clnt->cl_prog, clnt->cl_vers, clnt->cl_program->name);
11c556b3	217
2446ab60 TM	218	rcu_read_lock();
2446ab60 TM	219	xprt = rcu_dereference(clnt->cl_xprt);
11c556b3 CL	220	if (xprt)
11c556b3 CL	221	xprt->ops->print_stats(xprt, seq);
2446ab60	222	rcu_read_unlock();
11c556b3 CL	223
	224	seq_printf(seq, "\tper-op statistics\n");
	225	for (op = 0; op < maxproc; op++) {
	226	struct rpc_iostats *metrics = &stats[op];
cc0175c1	227	_print_name(seq, op, clnt->cl_procinfo);
11c556b3 CL	228	seq_printf(seq, "%lu %lu %lu %Lu %Lu %Lu %Lu %Lu\n",
	229	metrics->om_ops,
	230	metrics->om_ntrans,
	231	metrics->om_timeouts,
	232	metrics->om_bytes_sent,
	233	metrics->om_bytes_recv,
ff839970 CL	234	ktime_to_ms(metrics->om_queue),
	235	ktime_to_ms(metrics->om_rtt),
	236	ktime_to_ms(metrics->om_execute));
11c556b3 CL	237	}
11c556b3 CL	238	}
e8914c65	239	EXPORT_SYMBOL_GPL(rpc_print_iostats);
11c556b3	240
1da177e4 LT	241	/*
	242	* Register/unregister RPC proc files
	243	*/
	244	static inline struct proc_dir_entry *
ec7652aa SK	245	do_register(struct net net, const char name, void *data,
ec7652aa SK	246	const struct file_operations *fops)
1da177e4	247	{
4f42d0d5	248	struct sunrpc_net *sn;
1da177e4	249
4f42d0d5	250	dprintk("RPC: registering /proc/net/rpc/%s\n", name);
ec7652aa	251	sn = net_generic(net, sunrpc_net_id);
4f42d0d5	252	return proc_create_data(name, 0, sn->proc_net_rpc, fops, data);
1da177e4 LT	253	}
	254
	255	struct proc_dir_entry *
ec7652aa	256	rpc_proc_register(struct net net, struct rpc_stat statp)
1da177e4	257	{
ec7652aa	258	return do_register(net, statp->program->name, statp, &rpc_proc_fops);
1da177e4	259	}
e8914c65	260	EXPORT_SYMBOL_GPL(rpc_proc_register);
1da177e4 LT	261
1da177e4 LT	262	void
ec7652aa	263	rpc_proc_unregister(struct net net, const char name)
1da177e4	264	{
4f42d0d5 PE	265	struct sunrpc_net *sn;
4f42d0d5 PE	266
ec7652aa	267	sn = net_generic(net, sunrpc_net_id);
4f42d0d5	268	remove_proc_entry(name, sn->proc_net_rpc);
1da177e4	269	}
e8914c65	270	EXPORT_SYMBOL_GPL(rpc_proc_unregister);
1da177e4 LT	271
1da177e4 LT	272	struct proc_dir_entry *
246590f5	273	svc_proc_register(struct net net, struct svc_stat statp, const struct file_operations *fops)
1da177e4	274	{
246590f5	275	return do_register(net, statp->program->pg_name, statp, fops);
1da177e4	276	}
24c3767e	277	EXPORT_SYMBOL_GPL(svc_proc_register);
1da177e4 LT	278
1da177e4 LT	279	void
246590f5	280	svc_proc_unregister(struct net net, const char name)
1da177e4	281	{
4f42d0d5 PE	282	struct sunrpc_net *sn;
4f42d0d5 PE	283
246590f5	284	sn = net_generic(net, sunrpc_net_id);
4f42d0d5	285	remove_proc_entry(name, sn->proc_net_rpc);
1da177e4	286	}
24c3767e	287	EXPORT_SYMBOL_GPL(svc_proc_unregister);
1da177e4	288
4f42d0d5	289	int rpc_proc_init(struct net *net)
1da177e4	290	{
4f42d0d5 PE	291	struct sunrpc_net *sn;
4f42d0d5 PE	292
46121cf7	293	dprintk("RPC: registering /proc/net/rpc\n");
4f42d0d5 PE	294	sn = net_generic(net, sunrpc_net_id);
	295	sn->proc_net_rpc = proc_mkdir("rpc", net->proc_net);
	296	if (sn->proc_net_rpc == NULL)
	297	return -ENOMEM;
	298
	299	return 0;
1da177e4 LT	300	}
1da177e4 LT	301
4f42d0d5	302	void rpc_proc_exit(struct net *net)
1da177e4	303	{
46121cf7	304	dprintk("RPC: unregistering /proc/net/rpc\n");
4f42d0d5	305	remove_proc_entry("rpc", net->proc_net);
1da177e4 LT	306	}
1da177e4 LT	307