blob: 1b4e6791ecf3d3a036347150708fb0e345c26198 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
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>
16
17#include <linux/init.h>
18#include <linux/kernel.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070019#include <linux/proc_fs.h>
20#include <linux/seq_file.h>
21#include <linux/sunrpc/clnt.h>
22#include <linux/sunrpc/svcsock.h>
Chuck Lever11c556b2006-03-20 13:44:22 -050023#include <linux/sunrpc/metrics.h>
Eric W. Biederman457c4cb2007-09-12 12:01:34 +020024#include <net/net_namespace.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070025
26#define RPCDBG_FACILITY RPCDBG_MISC
27
28struct proc_dir_entry *proc_net_rpc = NULL;
29
30/*
31 * Get RPC client stats
32 */
33static 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;
Chuck Leverea339d42007-10-26 13:32:56 -040036 unsigned int i, j;
Linus Torvalds1da177e2005-04-16 15:20:36 -070037
38 seq_printf(seq,
Max Kellermann49e31cb2005-09-06 15:18:03 -070039 "net %u %u %u %u\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -070040 statp->netcnt,
41 statp->netudpcnt,
42 statp->nettcpcnt,
43 statp->nettcpconn);
44 seq_printf(seq,
Max Kellermann49e31cb2005-09-06 15:18:03 -070045 "rpc %u %u %u\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -070046 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;
Max Kellermann49e31cb2005-09-06 15:18:03 -070054 seq_printf(seq, "proc%u %u",
Linus Torvalds1da177e2005-04-16 15:20:36 -070055 vers->number, vers->nrprocs);
56 for (j = 0; j < vers->nrprocs; j++)
Max Kellermann49e31cb2005-09-06 15:18:03 -070057 seq_printf(seq, " %u",
Linus Torvalds1da177e2005-04-16 15:20:36 -070058 vers->procs[j].p_count);
59 seq_putc(seq, '\n');
60 }
61 return 0;
62}
63
64static int rpc_proc_open(struct inode *inode, struct file *file)
65{
66 return single_open(file, rpc_proc_show, PDE(inode)->data);
67}
68
Arjan van de Venda7071d2007-02-12 00:55:36 -080069static const struct file_operations rpc_proc_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -070070 .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 */
80void 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;
Chuck Leverea339d42007-10-26 13:32:56 -040084 unsigned int i, j;
Linus Torvalds1da177e2005-04-16 15:20:36 -070085
86 seq_printf(seq,
Max Kellermann49e31cb2005-09-06 15:18:03 -070087 "net %u %u %u %u\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -070088 statp->netcnt,
89 statp->netudpcnt,
90 statp->nettcpcnt,
91 statp->nettcpconn);
92 seq_printf(seq,
Max Kellermann49e31cb2005-09-06 15:18:03 -070093 "rpc %u %u %u %u %u\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -070094 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;
Max Kellermann49e31cb2005-09-06 15:18:03 -0700103 seq_printf(seq, "proc%d %u", i, vers->vs_nproc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104 for (j = 0; j < vers->vs_nproc; j++, proc++)
Max Kellermann49e31cb2005-09-06 15:18:03 -0700105 seq_printf(seq, " %u", proc->pc_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700106 seq_putc(seq, '\n');
107 }
108}
Trond Myklebust24c37672008-12-23 16:30:12 -0500109EXPORT_SYMBOL_GPL(svc_seq_show);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700110
Chuck Lever11c556b2006-03-20 13:44:22 -0500111/**
112 * rpc_alloc_iostats - allocate an rpc_iostats structure
113 * @clnt: RPC program, version, and xprt
114 *
115 */
116struct rpc_iostats *rpc_alloc_iostats(struct rpc_clnt *clnt)
117{
Chuck Lever11c556b2006-03-20 13:44:22 -0500118 struct rpc_iostats *new;
Panagiotis Issaris0da974f2006-07-21 14:51:30 -0700119 new = kcalloc(clnt->cl_maxproc, sizeof(struct rpc_iostats), GFP_KERNEL);
Chuck Lever11c556b2006-03-20 13:44:22 -0500120 return new;
121}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400122EXPORT_SYMBOL_GPL(rpc_alloc_iostats);
Chuck Lever11c556b2006-03-20 13:44:22 -0500123
124/**
125 * rpc_free_iostats - release an rpc_iostats structure
126 * @stats: doomed rpc_iostats structure
127 *
128 */
129void rpc_free_iostats(struct rpc_iostats *stats)
130{
131 kfree(stats);
132}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400133EXPORT_SYMBOL_GPL(rpc_free_iostats);
Chuck Lever11c556b2006-03-20 13:44:22 -0500134
135/**
136 * rpc_count_iostats - tally up per-task stats
137 * @task: completed rpc_task
138 *
139 * Relies on the caller for serialization.
140 */
141void rpc_count_iostats(struct rpc_task *task)
142{
143 struct rpc_rqst *req = task->tk_rqstp;
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400144 struct rpc_iostats *stats;
Chuck Lever11c556b2006-03-20 13:44:22 -0500145 struct rpc_iostats *op_metrics;
146 long rtt, execute, queue;
147
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400148 if (!task->tk_client || !task->tk_client->cl_metrics || !req)
Chuck Lever11c556b2006-03-20 13:44:22 -0500149 return;
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400150
151 stats = task->tk_client->cl_metrics;
Chuck Levercc0175c2006-03-20 13:44:22 -0500152 op_metrics = &stats[task->tk_msg.rpc_proc->p_statidx];
Chuck Lever11c556b2006-03-20 13:44:22 -0500153
154 op_metrics->om_ops++;
155 op_metrics->om_ntrans += req->rq_ntrans;
156 op_metrics->om_timeouts += task->tk_timeouts;
157
158 op_metrics->om_bytes_sent += task->tk_bytes_sent;
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -0400159 op_metrics->om_bytes_recv += req->rq_reply_bytes_recvd;
Chuck Lever11c556b2006-03-20 13:44:22 -0500160
161 queue = (long)req->rq_xtime - task->tk_start;
162 if (queue < 0)
163 queue = -queue;
164 op_metrics->om_queue += queue;
165
166 rtt = task->tk_rtt;
167 if (rtt < 0)
168 rtt = -rtt;
169 op_metrics->om_rtt += rtt;
170
171 execute = (long)jiffies - task->tk_start;
172 if (execute < 0)
173 execute = -execute;
174 op_metrics->om_execute += execute;
175}
176
Adrian Bunkec535ce2006-04-18 13:21:50 -0400177static void _print_name(struct seq_file *seq, unsigned int op,
178 struct rpc_procinfo *procs)
Chuck Levercc0175c2006-03-20 13:44:22 -0500179{
180 if (procs[op].p_name)
181 seq_printf(seq, "\t%12s: ", procs[op].p_name);
182 else if (op == 0)
183 seq_printf(seq, "\t NULL: ");
184 else
185 seq_printf(seq, "\t%12u: ", op);
186}
187
Chuck Lever5eb53f42006-03-20 13:44:42 -0500188#define MILLISECS_PER_JIFFY (1000 / HZ)
Chuck Lever11c556b2006-03-20 13:44:22 -0500189
190void rpc_print_iostats(struct seq_file *seq, struct rpc_clnt *clnt)
191{
192 struct rpc_iostats *stats = clnt->cl_metrics;
193 struct rpc_xprt *xprt = clnt->cl_xprt;
194 unsigned int op, maxproc = clnt->cl_maxproc;
195
196 if (!stats)
197 return;
198
199 seq_printf(seq, "\tRPC iostats version: %s ", RPC_IOSTATS_VERS);
200 seq_printf(seq, "p/v: %u/%u (%s)\n",
201 clnt->cl_prog, clnt->cl_vers, clnt->cl_protname);
202
203 if (xprt)
204 xprt->ops->print_stats(xprt, seq);
205
206 seq_printf(seq, "\tper-op statistics\n");
207 for (op = 0; op < maxproc; op++) {
208 struct rpc_iostats *metrics = &stats[op];
Chuck Levercc0175c2006-03-20 13:44:22 -0500209 _print_name(seq, op, clnt->cl_procinfo);
Chuck Lever11c556b2006-03-20 13:44:22 -0500210 seq_printf(seq, "%lu %lu %lu %Lu %Lu %Lu %Lu %Lu\n",
211 metrics->om_ops,
212 metrics->om_ntrans,
213 metrics->om_timeouts,
214 metrics->om_bytes_sent,
215 metrics->om_bytes_recv,
216 metrics->om_queue * MILLISECS_PER_JIFFY,
217 metrics->om_rtt * MILLISECS_PER_JIFFY,
218 metrics->om_execute * MILLISECS_PER_JIFFY);
219 }
220}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400221EXPORT_SYMBOL_GPL(rpc_print_iostats);
Chuck Lever11c556b2006-03-20 13:44:22 -0500222
Linus Torvalds1da177e2005-04-16 15:20:36 -0700223/*
224 * Register/unregister RPC proc files
225 */
226static inline struct proc_dir_entry *
Arjan van de Ven99ac48f2006-03-28 01:56:41 -0800227do_register(const char *name, void *data, const struct file_operations *fops)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700228{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700229 rpc_proc_init();
Chuck Lever46121cf2007-01-31 12:14:08 -0500230 dprintk("RPC: registering /proc/net/rpc/%s\n", name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700231
Denis V. Luneve7fe2332008-05-02 02:44:36 -0700232 return proc_create_data(name, 0, proc_net_rpc, fops, data);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700233}
234
235struct proc_dir_entry *
236rpc_proc_register(struct rpc_stat *statp)
237{
238 return do_register(statp->program->name, statp, &rpc_proc_fops);
239}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400240EXPORT_SYMBOL_GPL(rpc_proc_register);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700241
242void
243rpc_proc_unregister(const char *name)
244{
245 remove_proc_entry(name, proc_net_rpc);
246}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400247EXPORT_SYMBOL_GPL(rpc_proc_unregister);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700248
249struct proc_dir_entry *
Arjan van de Ven99ac48f2006-03-28 01:56:41 -0800250svc_proc_register(struct svc_stat *statp, const struct file_operations *fops)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700251{
252 return do_register(statp->program->pg_name, statp, fops);
253}
Trond Myklebust24c37672008-12-23 16:30:12 -0500254EXPORT_SYMBOL_GPL(svc_proc_register);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700255
256void
257svc_proc_unregister(const char *name)
258{
259 remove_proc_entry(name, proc_net_rpc);
260}
Trond Myklebust24c37672008-12-23 16:30:12 -0500261EXPORT_SYMBOL_GPL(svc_proc_unregister);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700262
263void
264rpc_proc_init(void)
265{
Chuck Lever46121cf2007-01-31 12:14:08 -0500266 dprintk("RPC: registering /proc/net/rpc\n");
Alexey Dobriyan99b76232009-03-25 22:48:06 +0300267 if (!proc_net_rpc)
268 proc_net_rpc = proc_mkdir("rpc", init_net.proc_net);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700269}
270
271void
272rpc_proc_exit(void)
273{
Chuck Lever46121cf2007-01-31 12:14:08 -0500274 dprintk("RPC: unregistering /proc/net/rpc\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700275 if (proc_net_rpc) {
276 proc_net_rpc = NULL;
Eric W. Biederman457c4cb2007-09-12 12:01:34 +0200277 remove_proc_entry("rpc", init_net.proc_net);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700278 }
279}
280