blob: 21b75cb08c039285100134281bbe8cbc7749b09a [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>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090016#include <linux/slab.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070017
18#include <linux/init.h>
19#include <linux/kernel.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070020#include <linux/proc_fs.h>
21#include <linux/seq_file.h>
22#include <linux/sunrpc/clnt.h>
23#include <linux/sunrpc/svcsock.h>
Chuck Lever11c556b2006-03-20 13:44:22 -050024#include <linux/sunrpc/metrics.h>
Trond Myklebust2446ab62012-03-01 17:00:56 -050025#include <linux/rcupdate.h>
Pavel Emelyanov4f42d0d2010-09-27 14:01:58 +040026
27#include "netns.h"
Linus Torvalds1da177e2005-04-16 15:20:36 -070028
29#define RPCDBG_FACILITY RPCDBG_MISC
30
Linus Torvalds1da177e2005-04-16 15:20:36 -070031/*
32 * Get RPC client stats
33 */
34static 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;
Chuck Leverea339d42007-10-26 13:32:56 -040037 unsigned int i, j;
Linus Torvalds1da177e2005-04-16 15:20:36 -070038
39 seq_printf(seq,
Max Kellermann49e31cb2005-09-06 15:18:03 -070040 "net %u %u %u %u\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -070041 statp->netcnt,
42 statp->netudpcnt,
43 statp->nettcpcnt,
44 statp->nettcpconn);
45 seq_printf(seq,
Max Kellermann49e31cb2005-09-06 15:18:03 -070046 "rpc %u %u %u\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -070047 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;
Max Kellermann49e31cb2005-09-06 15:18:03 -070055 seq_printf(seq, "proc%u %u",
Linus Torvalds1da177e2005-04-16 15:20:36 -070056 vers->number, vers->nrprocs);
57 for (j = 0; j < vers->nrprocs; j++)
Max Kellermann49e31cb2005-09-06 15:18:03 -070058 seq_printf(seq, " %u",
Linus Torvalds1da177e2005-04-16 15:20:36 -070059 vers->procs[j].p_count);
60 seq_putc(seq, '\n');
61 }
62 return 0;
63}
64
65static int rpc_proc_open(struct inode *inode, struct file *file)
66{
Al Virod9dda782013-03-31 18:16:14 -040067 return single_open(file, rpc_proc_show, PDE_DATA(inode));
Linus Torvalds1da177e2005-04-16 15:20:36 -070068}
69
Arjan van de Venda7071d2007-02-12 00:55:36 -080070static const struct file_operations rpc_proc_fops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -070071 .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 */
81void 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;
Chuck Leverea339d42007-10-26 13:32:56 -040085 unsigned int i, j;
Linus Torvalds1da177e2005-04-16 15:20:36 -070086
87 seq_printf(seq,
Max Kellermann49e31cb2005-09-06 15:18:03 -070088 "net %u %u %u %u\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -070089 statp->netcnt,
90 statp->netudpcnt,
91 statp->nettcpcnt,
92 statp->nettcpconn);
93 seq_printf(seq,
Max Kellermann49e31cb2005-09-06 15:18:03 -070094 "rpc %u %u %u %u %u\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -070095 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;
Max Kellermann49e31cb2005-09-06 15:18:03 -0700104 seq_printf(seq, "proc%d %u", i, vers->vs_nproc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105 for (j = 0; j < vers->vs_nproc; j++, proc++)
Max Kellermann49e31cb2005-09-06 15:18:03 -0700106 seq_printf(seq, " %u", proc->pc_count);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700107 seq_putc(seq, '\n');
108 }
109}
Trond Myklebust24c37672008-12-23 16:30:12 -0500110EXPORT_SYMBOL_GPL(svc_seq_show);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111
Chuck Lever11c556b2006-03-20 13:44:22 -0500112/**
113 * rpc_alloc_iostats - allocate an rpc_iostats structure
114 * @clnt: RPC program, version, and xprt
115 *
116 */
117struct rpc_iostats *rpc_alloc_iostats(struct rpc_clnt *clnt)
118{
Jesper Juhl94f58df2010-11-07 22:11:34 +0100119 return kcalloc(clnt->cl_maxproc, sizeof(struct rpc_iostats), GFP_KERNEL);
Chuck Lever11c556b2006-03-20 13:44:22 -0500120}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400121EXPORT_SYMBOL_GPL(rpc_alloc_iostats);
Chuck Lever11c556b2006-03-20 13:44:22 -0500122
123/**
124 * rpc_free_iostats - release an rpc_iostats structure
125 * @stats: doomed rpc_iostats structure
126 *
127 */
128void rpc_free_iostats(struct rpc_iostats *stats)
129{
130 kfree(stats);
131}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400132EXPORT_SYMBOL_GPL(rpc_free_iostats);
Chuck Lever11c556b2006-03-20 13:44:22 -0500133
134/**
135 * rpc_count_iostats - tally up per-task stats
136 * @task: completed rpc_task
Weston Andros Adamson0a702192012-02-17 13:15:24 -0500137 * @stats: array of stat structures
Chuck Lever11c556b2006-03-20 13:44:22 -0500138 *
139 * Relies on the caller for serialization.
140 */
Weston Andros Adamson0a702192012-02-17 13:15:24 -0500141void rpc_count_iostats(const struct rpc_task *task, struct rpc_iostats *stats)
Chuck Lever11c556b2006-03-20 13:44:22 -0500142{
143 struct rpc_rqst *req = task->tk_rqstp;
Chuck Lever11c556b2006-03-20 13:44:22 -0500144 struct rpc_iostats *op_metrics;
Chuck Leverff839972010-05-07 13:34:47 -0400145 ktime_t delta;
Chuck Lever11c556b2006-03-20 13:44:22 -0500146
Weston Andros Adamson0a702192012-02-17 13:15:24 -0500147 if (!stats || !req)
Chuck Lever11c556b2006-03-20 13:44:22 -0500148 return;
Ricardo Labiaga55ae1aa2009-04-01 09:23:03 -0400149
Chuck Levercc0175c2006-03-20 13:44:22 -0500150 op_metrics = &stats[task->tk_msg.rpc_proc->p_statidx];
Chuck Lever11c556b2006-03-20 13:44:22 -0500151
152 op_metrics->om_ops++;
153 op_metrics->om_ntrans += req->rq_ntrans;
154 op_metrics->om_timeouts += task->tk_timeouts;
155
Trond Myklebustd60dbb22010-05-13 12:51:49 -0400156 op_metrics->om_bytes_sent += req->rq_xmit_bytes_sent;
Ricardo Labiagadd2b63d2009-04-01 09:23:28 -0400157 op_metrics->om_bytes_recv += req->rq_reply_bytes_recvd;
Chuck Lever11c556b2006-03-20 13:44:22 -0500158
Chuck Leverff839972010-05-07 13:34:47 -0400159 delta = ktime_sub(req->rq_xtime, task->tk_start);
160 op_metrics->om_queue = ktime_add(op_metrics->om_queue, delta);
Chuck Lever11c556b2006-03-20 13:44:22 -0500161
Trond Myklebustd60dbb22010-05-13 12:51:49 -0400162 op_metrics->om_rtt = ktime_add(op_metrics->om_rtt, req->rq_rtt);
Chuck Lever11c556b2006-03-20 13:44:22 -0500163
Chuck Leverff839972010-05-07 13:34:47 -0400164 delta = ktime_sub(ktime_get(), task->tk_start);
165 op_metrics->om_execute = ktime_add(op_metrics->om_execute, delta);
Chuck Lever11c556b2006-03-20 13:44:22 -0500166}
Weston Andros Adamson0a702192012-02-17 13:15:24 -0500167EXPORT_SYMBOL_GPL(rpc_count_iostats);
Chuck Lever11c556b2006-03-20 13:44:22 -0500168
Adrian Bunkec535ce2006-04-18 13:21:50 -0400169static void _print_name(struct seq_file *seq, unsigned int op,
170 struct rpc_procinfo *procs)
Chuck Levercc0175c2006-03-20 13:44:22 -0500171{
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
Chuck Lever11c556b2006-03-20 13:44:22 -0500180void rpc_print_iostats(struct seq_file *seq, struct rpc_clnt *clnt)
181{
182 struct rpc_iostats *stats = clnt->cl_metrics;
Trond Myklebust2446ab62012-03-01 17:00:56 -0500183 struct rpc_xprt *xprt;
Chuck Lever11c556b2006-03-20 13:44:22 -0500184 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
Trond Myklebust2446ab62012-03-01 17:00:56 -0500193 rcu_read_lock();
194 xprt = rcu_dereference(clnt->cl_xprt);
Chuck Lever11c556b2006-03-20 13:44:22 -0500195 if (xprt)
196 xprt->ops->print_stats(xprt, seq);
Trond Myklebust2446ab62012-03-01 17:00:56 -0500197 rcu_read_unlock();
Chuck Lever11c556b2006-03-20 13:44:22 -0500198
199 seq_printf(seq, "\tper-op statistics\n");
200 for (op = 0; op < maxproc; op++) {
201 struct rpc_iostats *metrics = &stats[op];
Chuck Levercc0175c2006-03-20 13:44:22 -0500202 _print_name(seq, op, clnt->cl_procinfo);
Chuck Lever11c556b2006-03-20 13:44:22 -0500203 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,
Chuck Leverff839972010-05-07 13:34:47 -0400209 ktime_to_ms(metrics->om_queue),
210 ktime_to_ms(metrics->om_rtt),
211 ktime_to_ms(metrics->om_execute));
Chuck Lever11c556b2006-03-20 13:44:22 -0500212 }
213}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400214EXPORT_SYMBOL_GPL(rpc_print_iostats);
Chuck Lever11c556b2006-03-20 13:44:22 -0500215
Linus Torvalds1da177e2005-04-16 15:20:36 -0700216/*
217 * Register/unregister RPC proc files
218 */
219static inline struct proc_dir_entry *
Stanislav Kinsburskyec7652a2011-12-06 16:42:40 +0300220do_register(struct net *net, const char *name, void *data,
221 const struct file_operations *fops)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700222{
Pavel Emelyanov4f42d0d2010-09-27 14:01:58 +0400223 struct sunrpc_net *sn;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700224
Pavel Emelyanov4f42d0d2010-09-27 14:01:58 +0400225 dprintk("RPC: registering /proc/net/rpc/%s\n", name);
Stanislav Kinsburskyec7652a2011-12-06 16:42:40 +0300226 sn = net_generic(net, sunrpc_net_id);
Pavel Emelyanov4f42d0d2010-09-27 14:01:58 +0400227 return proc_create_data(name, 0, sn->proc_net_rpc, fops, data);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700228}
229
230struct proc_dir_entry *
Stanislav Kinsburskyec7652a2011-12-06 16:42:40 +0300231rpc_proc_register(struct net *net, struct rpc_stat *statp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700232{
Stanislav Kinsburskyec7652a2011-12-06 16:42:40 +0300233 return do_register(net, statp->program->name, statp, &rpc_proc_fops);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400235EXPORT_SYMBOL_GPL(rpc_proc_register);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700236
237void
Stanislav Kinsburskyec7652a2011-12-06 16:42:40 +0300238rpc_proc_unregister(struct net *net, const char *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700239{
Pavel Emelyanov4f42d0d2010-09-27 14:01:58 +0400240 struct sunrpc_net *sn;
241
Stanislav Kinsburskyec7652a2011-12-06 16:42:40 +0300242 sn = net_generic(net, sunrpc_net_id);
Pavel Emelyanov4f42d0d2010-09-27 14:01:58 +0400243 remove_proc_entry(name, sn->proc_net_rpc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700244}
Trond Myklebuste8914c62007-07-14 15:39:59 -0400245EXPORT_SYMBOL_GPL(rpc_proc_unregister);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700246
247struct proc_dir_entry *
Stanislav Kinsbursky246590f2011-12-06 16:42:49 +0300248svc_proc_register(struct net *net, struct svc_stat *statp, const struct file_operations *fops)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700249{
Stanislav Kinsbursky246590f2011-12-06 16:42:49 +0300250 return do_register(net, statp->program->pg_name, statp, fops);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700251}
Trond Myklebust24c37672008-12-23 16:30:12 -0500252EXPORT_SYMBOL_GPL(svc_proc_register);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700253
254void
Stanislav Kinsbursky246590f2011-12-06 16:42:49 +0300255svc_proc_unregister(struct net *net, const char *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700256{
Pavel Emelyanov4f42d0d2010-09-27 14:01:58 +0400257 struct sunrpc_net *sn;
258
Stanislav Kinsbursky246590f2011-12-06 16:42:49 +0300259 sn = net_generic(net, sunrpc_net_id);
Pavel Emelyanov4f42d0d2010-09-27 14:01:58 +0400260 remove_proc_entry(name, sn->proc_net_rpc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700261}
Trond Myklebust24c37672008-12-23 16:30:12 -0500262EXPORT_SYMBOL_GPL(svc_proc_unregister);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700263
Pavel Emelyanov4f42d0d2010-09-27 14:01:58 +0400264int rpc_proc_init(struct net *net)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700265{
Pavel Emelyanov4f42d0d2010-09-27 14:01:58 +0400266 struct sunrpc_net *sn;
267
Chuck Lever46121cf2007-01-31 12:14:08 -0500268 dprintk("RPC: registering /proc/net/rpc\n");
Pavel Emelyanov4f42d0d2010-09-27 14:01:58 +0400269 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;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700275}
276
Pavel Emelyanov4f42d0d2010-09-27 14:01:58 +0400277void rpc_proc_exit(struct net *net)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700278{
Chuck Lever46121cf2007-01-31 12:14:08 -0500279 dprintk("RPC: unregistering /proc/net/rpc\n");
Pavel Emelyanov4f42d0d2010-09-27 14:01:58 +0400280 remove_proc_entry("rpc", net->proc_net);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700281}
282