xref: /linux/net/sunrpc/stats.c (revision cb299ba8b5ef2239429484072fea394cd7581bd7)
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>
16 #include <linux/slab.h>
17 
18 #include <linux/init.h>
19 #include <linux/kernel.h>
20 #include <linux/proc_fs.h>
21 #include <linux/seq_file.h>
22 #include <linux/sunrpc/clnt.h>
23 #include <linux/sunrpc/svcsock.h>
24 #include <linux/sunrpc/metrics.h>
25 
26 #include "netns.h"
27 
28 #define RPCDBG_FACILITY	RPCDBG_MISC
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;
36 	unsigned int i, j;
37 
38 	seq_printf(seq,
39 		"net %u %u %u %u\n",
40 			statp->netcnt,
41 			statp->netudpcnt,
42 			statp->nettcpcnt,
43 			statp->nettcpconn);
44 	seq_printf(seq,
45 		"rpc %u %u %u\n",
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;
54 		seq_printf(seq, "proc%u %u",
55 					vers->number, vers->nrprocs);
56 		for (j = 0; j < vers->nrprocs; j++)
57 			seq_printf(seq, " %u",
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 
69 static const struct file_operations rpc_proc_fops = {
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;
84 	unsigned int i, j;
85 
86 	seq_printf(seq,
87 		"net %u %u %u %u\n",
88 			statp->netcnt,
89 			statp->netudpcnt,
90 			statp->nettcpcnt,
91 			statp->nettcpconn);
92 	seq_printf(seq,
93 		"rpc %u %u %u %u %u\n",
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;
103 		seq_printf(seq, "proc%d %u", i, vers->vs_nproc);
104 		for (j = 0; j < vers->vs_nproc; j++, proc++)
105 			seq_printf(seq, " %u", proc->pc_count);
106 		seq_putc(seq, '\n');
107 	}
108 }
109 EXPORT_SYMBOL_GPL(svc_seq_show);
110 
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 {
118 	struct rpc_iostats *new;
119 	new = kcalloc(clnt->cl_maxproc, sizeof(struct rpc_iostats), GFP_KERNEL);
120 	return new;
121 }
122 EXPORT_SYMBOL_GPL(rpc_alloc_iostats);
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 }
133 EXPORT_SYMBOL_GPL(rpc_free_iostats);
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;
144 	struct rpc_iostats *stats;
145 	struct rpc_iostats *op_metrics;
146 	ktime_t delta;
147 
148 	if (!task->tk_client || !task->tk_client->cl_metrics || !req)
149 		return;
150 
151 	stats = task->tk_client->cl_metrics;
152 	op_metrics = &stats[task->tk_msg.rpc_proc->p_statidx];
153 
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 += req->rq_xmit_bytes_sent;
159 	op_metrics->om_bytes_recv += req->rq_reply_bytes_recvd;
160 
161 	delta = ktime_sub(req->rq_xtime, task->tk_start);
162 	op_metrics->om_queue = ktime_add(op_metrics->om_queue, delta);
163 
164 	op_metrics->om_rtt = ktime_add(op_metrics->om_rtt, req->rq_rtt);
165 
166 	delta = ktime_sub(ktime_get(), task->tk_start);
167 	op_metrics->om_execute = ktime_add(op_metrics->om_execute, delta);
168 }
169 
170 static void _print_name(struct seq_file *seq, unsigned int op,
171 			struct rpc_procinfo *procs)
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 
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];
200 		_print_name(seq, op, clnt->cl_procinfo);
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,
207 				ktime_to_ms(metrics->om_queue),
208 				ktime_to_ms(metrics->om_rtt),
209 				ktime_to_ms(metrics->om_execute));
210 	}
211 }
212 EXPORT_SYMBOL_GPL(rpc_print_iostats);
213 
214 /*
215  * Register/unregister RPC proc files
216  */
217 static inline struct proc_dir_entry *
218 do_register(const char *name, void *data, const struct file_operations *fops)
219 {
220 	struct sunrpc_net *sn;
221 
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);
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 }
232 EXPORT_SYMBOL_GPL(rpc_proc_register);
233 
234 void
235 rpc_proc_unregister(const char *name)
236 {
237 	struct sunrpc_net *sn;
238 
239 	sn = net_generic(&init_net, sunrpc_net_id);
240 	remove_proc_entry(name, sn->proc_net_rpc);
241 }
242 EXPORT_SYMBOL_GPL(rpc_proc_unregister);
243 
244 struct proc_dir_entry *
245 svc_proc_register(struct svc_stat *statp, const struct file_operations *fops)
246 {
247 	return do_register(statp->program->pg_name, statp, fops);
248 }
249 EXPORT_SYMBOL_GPL(svc_proc_register);
250 
251 void
252 svc_proc_unregister(const char *name)
253 {
254 	struct sunrpc_net *sn;
255 
256 	sn = net_generic(&init_net, sunrpc_net_id);
257 	remove_proc_entry(name, sn->proc_net_rpc);
258 }
259 EXPORT_SYMBOL_GPL(svc_proc_unregister);
260 
261 int rpc_proc_init(struct net *net)
262 {
263 	struct sunrpc_net *sn;
264 
265 	dprintk("RPC:       registering /proc/net/rpc\n");
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;
272 }
273 
274 void rpc_proc_exit(struct net *net)
275 {
276 	dprintk("RPC:       unregistering /proc/net/rpc\n");
277 	remove_proc_entry("rpc", net->proc_net);
278 }
279 
280