[net-next-2.6.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 "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(inode)->data);
}

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 *new;
	new = kcalloc(clnt->cl_maxproc, sizeof(struct rpc_iostats), GFP_KERNEL);
	return new;
}
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
 *
 * Relies on the caller for serialization.
 */
void rpc_count_iostats(struct rpc_task *task)
{
	struct rpc_rqst *req = task->tk_rqstp;
	struct rpc_iostats *stats;
	struct rpc_iostats *op_metrics;
	ktime_t delta;

	if (!task->tk_client || !task->tk_client->cl_metrics || !req)
		return;

	stats = task->tk_client->cl_metrics;
	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);
}

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 = clnt->cl_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);

	if (xprt)
		xprt->ops->print_stats(xprt, seq);

	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(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(&init_net, sunrpc_net_id);
	return proc_create_data(name, 0, sn->proc_net_rpc, fops, data);
}

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

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

	sn = net_generic(&init_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 svc_stat *statp, const struct file_operations *fops)
{
	return do_register(statp->program->pg_name, statp, fops);
}
EXPORT_SYMBOL_GPL(svc_proc_register);

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

	sn = net_generic(&init_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>
1da177e4	25
4f42d0d5	26	#include "netns.h"
1da177e4	27
4f42d0d5	28	#define RPCDBG_FACILITY RPCDBG_MISC
1da177e4 LT	29
	30	/*
	31	* Get RPC client stats
	32	*/
	33	static int rpc_proc_show(struct seq_file seq, void v) {
	34	const struct rpc_stat *statp = seq->private;
	35	const struct rpc_program *prog = statp->program;
ea339d46	36	unsigned int i, j;
1da177e4 LT	37
1da177e4 LT	38	seq_printf(seq,
49e31cba	39	"net %u %u %u %u\n",
1da177e4 LT	40	statp->netcnt,
	41	statp->netudpcnt,
	42	statp->nettcpcnt,
	43	statp->nettcpconn);
	44	seq_printf(seq,
49e31cba	45	"rpc %u %u %u\n",
1da177e4 LT	46	statp->rpccnt,
	47	statp->rpcretrans,
	48	statp->rpcauthrefresh);
	49
	50	for (i = 0; i < prog->nrvers; i++) {
	51	const struct rpc_version *vers = prog->version[i];
	52	if (!vers)
	53	continue;
49e31cba	54	seq_printf(seq, "proc%u %u",
1da177e4 LT	55	vers->number, vers->nrprocs);
1da177e4 LT	56	for (j = 0; j < vers->nrprocs; j++)
49e31cba	57	seq_printf(seq, " %u",
1da177e4 LT	58	vers->procs[j].p_count);
	59	seq_putc(seq, '\n');
	60	}
	61	return 0;
	62	}
	63
	64	static int rpc_proc_open(struct inode inode, struct file file)
	65	{
	66	return single_open(file, rpc_proc_show, PDE(inode)->data);
	67	}
	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	*/
	80	void svc_seq_show(struct seq_file seq, const struct svc_stat statp) {
	81	const struct svc_program *prog = statp->program;
	82	const struct svc_procedure *proc;
	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++) {
	101	if (!(vers = prog->pg_vers[i]) \|\| !(proc = vers->vs_proc))
	102	continue;
49e31cba	103	seq_printf(seq, "proc%d %u", i, vers->vs_nproc);
1da177e4	104	for (j = 0; j < vers->vs_nproc; j++, proc++)
49e31cba	105	seq_printf(seq, " %u", proc->pc_count);
1da177e4 LT	106	seq_putc(seq, '\n');
	107	}
	108	}
24c3767e	109	EXPORT_SYMBOL_GPL(svc_seq_show);
1da177e4	110
11c556b3 CL	111	/**
	112	* rpc_alloc_iostats - allocate an rpc_iostats structure
	113	* @clnt: RPC program, version, and xprt
	114	*
	115	*/
	116	struct rpc_iostats rpc_alloc_iostats(struct rpc_clnt clnt)
	117	{
11c556b3	118	struct rpc_iostats *new;
0da974f4	119	new = kcalloc(clnt->cl_maxproc, sizeof(struct rpc_iostats), GFP_KERNEL);
11c556b3 CL	120	return new;
11c556b3 CL	121	}
e8914c65	122	EXPORT_SYMBOL_GPL(rpc_alloc_iostats);
11c556b3 CL	123
	124	/**
	125	* rpc_free_iostats - release an rpc_iostats structure
	126	* @stats: doomed rpc_iostats structure
	127	*
	128	*/
	129	void rpc_free_iostats(struct rpc_iostats *stats)
	130	{
	131	kfree(stats);
	132	}
e8914c65	133	EXPORT_SYMBOL_GPL(rpc_free_iostats);
11c556b3 CL	134
	135	/**
	136	* rpc_count_iostats - tally up per-task stats
	137	* @task: completed rpc_task
	138	*
	139	* Relies on the caller for serialization.
	140	*/
	141	void rpc_count_iostats(struct rpc_task *task)
	142	{
	143	struct rpc_rqst *req = task->tk_rqstp;
55ae1aab	144	struct rpc_iostats *stats;
11c556b3	145	struct rpc_iostats *op_metrics;
ff839970	146	ktime_t delta;
11c556b3	147
55ae1aab	148	if (!task->tk_client \|\| !task->tk_client->cl_metrics \|\| !req)
11c556b3	149	return;
55ae1aab RL	150
55ae1aab RL	151	stats = task->tk_client->cl_metrics;
cc0175c1	152	op_metrics = &stats[task->tk_msg.rpc_proc->p_statidx];
11c556b3 CL	153
	154	op_metrics->om_ops++;
	155	op_metrics->om_ntrans += req->rq_ntrans;
	156	op_metrics->om_timeouts += task->tk_timeouts;
	157
d60dbb20	158	op_metrics->om_bytes_sent += req->rq_xmit_bytes_sent;
dd2b63d0	159	op_metrics->om_bytes_recv += req->rq_reply_bytes_recvd;
11c556b3	160
ff839970 CL	161	delta = ktime_sub(req->rq_xtime, task->tk_start);
ff839970 CL	162	op_metrics->om_queue = ktime_add(op_metrics->om_queue, delta);
11c556b3	163
d60dbb20	164	op_metrics->om_rtt = ktime_add(op_metrics->om_rtt, req->rq_rtt);
11c556b3	165
ff839970 CL	166	delta = ktime_sub(ktime_get(), task->tk_start);
ff839970 CL	167	op_metrics->om_execute = ktime_add(op_metrics->om_execute, delta);
11c556b3 CL	168	}
11c556b3 CL	169
ec535ce1 AB	170	static void _print_name(struct seq_file *seq, unsigned int op,
ec535ce1 AB	171	struct rpc_procinfo *procs)
cc0175c1 CL	172	{
	173	if (procs[op].p_name)
	174	seq_printf(seq, "\t%12s: ", procs[op].p_name);
	175	else if (op == 0)
	176	seq_printf(seq, "\t NULL: ");
	177	else
	178	seq_printf(seq, "\t%12u: ", op);
	179	}
	180
11c556b3 CL	181	void rpc_print_iostats(struct seq_file seq, struct rpc_clnt clnt)
	182	{
	183	struct rpc_iostats *stats = clnt->cl_metrics;
	184	struct rpc_xprt *xprt = clnt->cl_xprt;
	185	unsigned int op, maxproc = clnt->cl_maxproc;
	186
	187	if (!stats)
	188	return;
	189
	190	seq_printf(seq, "\tRPC iostats version: %s ", RPC_IOSTATS_VERS);
	191	seq_printf(seq, "p/v: %u/%u (%s)\n",
	192	clnt->cl_prog, clnt->cl_vers, clnt->cl_protname);
	193
	194	if (xprt)
	195	xprt->ops->print_stats(xprt, seq);
	196
	197	seq_printf(seq, "\tper-op statistics\n");
	198	for (op = 0; op < maxproc; op++) {
	199	struct rpc_iostats *metrics = &stats[op];
cc0175c1	200	_print_name(seq, op, clnt->cl_procinfo);
11c556b3 CL	201	seq_printf(seq, "%lu %lu %lu %Lu %Lu %Lu %Lu %Lu\n",
	202	metrics->om_ops,
	203	metrics->om_ntrans,
	204	metrics->om_timeouts,
	205	metrics->om_bytes_sent,
	206	metrics->om_bytes_recv,
ff839970 CL	207	ktime_to_ms(metrics->om_queue),
	208	ktime_to_ms(metrics->om_rtt),
	209	ktime_to_ms(metrics->om_execute));
11c556b3 CL	210	}
11c556b3 CL	211	}
e8914c65	212	EXPORT_SYMBOL_GPL(rpc_print_iostats);
11c556b3	213
1da177e4 LT	214	/*
	215	* Register/unregister RPC proc files
	216	*/
	217	static inline struct proc_dir_entry *
99ac48f5	218	do_register(const char name, void data, const struct file_operations *fops)
1da177e4	219	{
4f42d0d5	220	struct sunrpc_net *sn;
1da177e4	221
4f42d0d5 PE	222	dprintk("RPC: registering /proc/net/rpc/%s\n", name);
	223	sn = net_generic(&init_net, sunrpc_net_id);
	224	return proc_create_data(name, 0, sn->proc_net_rpc, fops, data);
1da177e4 LT	225	}
	226
	227	struct proc_dir_entry *
	228	rpc_proc_register(struct rpc_stat *statp)
	229	{
	230	return do_register(statp->program->name, statp, &rpc_proc_fops);
	231	}
e8914c65	232	EXPORT_SYMBOL_GPL(rpc_proc_register);
1da177e4 LT	233
	234	void
	235	rpc_proc_unregister(const char *name)
	236	{
4f42d0d5 PE	237	struct sunrpc_net *sn;
	238
	239	sn = net_generic(&init_net, sunrpc_net_id);
	240	remove_proc_entry(name, sn->proc_net_rpc);
1da177e4	241	}
e8914c65	242	EXPORT_SYMBOL_GPL(rpc_proc_unregister);
1da177e4 LT	243
1da177e4 LT	244	struct proc_dir_entry *
99ac48f5	245	svc_proc_register(struct svc_stat statp, const struct file_operations fops)
1da177e4 LT	246	{
	247	return do_register(statp->program->pg_name, statp, fops);
	248	}
24c3767e	249	EXPORT_SYMBOL_GPL(svc_proc_register);
1da177e4 LT	250
	251	void
	252	svc_proc_unregister(const char *name)
	253	{
4f42d0d5 PE	254	struct sunrpc_net *sn;
	255
	256	sn = net_generic(&init_net, sunrpc_net_id);
	257	remove_proc_entry(name, sn->proc_net_rpc);
1da177e4	258	}
24c3767e	259	EXPORT_SYMBOL_GPL(svc_proc_unregister);
1da177e4	260
4f42d0d5	261	int rpc_proc_init(struct net *net)
1da177e4	262	{
4f42d0d5 PE	263	struct sunrpc_net *sn;
4f42d0d5 PE	264
46121cf7	265	dprintk("RPC: registering /proc/net/rpc\n");
4f42d0d5 PE	266	sn = net_generic(net, sunrpc_net_id);
	267	sn->proc_net_rpc = proc_mkdir("rpc", net->proc_net);
	268	if (sn->proc_net_rpc == NULL)
	269	return -ENOMEM;
	270
	271	return 0;
1da177e4 LT	272	}
1da177e4 LT	273
4f42d0d5	274	void rpc_proc_exit(struct net *net)
1da177e4	275	{
46121cf7	276	dprintk("RPC: unregistering /proc/net/rpc\n");
4f42d0d5	277	remove_proc_entry("rpc", net->proc_net);
1da177e4 LT	278	}
1da177e4 LT	279