Merge tag 'mips-fixes_5.12_3' of git://git.kernel.org/pub/scm/linux/kernel/git/mips...
[linux-block.git] / net / sunrpc / stats.c
CommitLineData
457c8996 1// SPDX-License-Identifier: GPL-2.0-only
1da177e4
LT
2/*
3 * linux/net/sunrpc/stats.c
4 *
5 * procfs-based user access to generic RPC statistics. The stats files
6 * reside in /proc/net/rpc.
7 *
8 * The read routines assume that the buffer passed in is just big enough.
9 * If you implement an RPC service that has its own stats routine which
10 * appends the generic RPC stats, make sure you don't exceed the PAGE_SIZE
11 * limit.
12 *
13 * Copyright (C) 1995, 1996, 1997 Olaf Kirch <okir@monad.swb.de>
14 */
15
16#include <linux/module.h>
5a0e3ad6 17#include <linux/slab.h>
1da177e4
LT
18
19#include <linux/init.h>
20#include <linux/kernel.h>
1da177e4
LT
21#include <linux/proc_fs.h>
22#include <linux/seq_file.h>
23#include <linux/sunrpc/clnt.h>
24#include <linux/sunrpc/svcsock.h>
11c556b3 25#include <linux/sunrpc/metrics.h>
2446ab60 26#include <linux/rcupdate.h>
1da177e4 27
40bf7eb3
CL
28#include <trace/events/sunrpc.h>
29
4f42d0d5 30#include "netns.h"
1da177e4 31
4f42d0d5 32#define RPCDBG_FACILITY RPCDBG_MISC
1da177e4
LT
33
34/*
35 * Get RPC client stats
36 */
37static int rpc_proc_show(struct seq_file *seq, void *v) {
38 const struct rpc_stat *statp = seq->private;
39 const struct rpc_program *prog = statp->program;
ea339d46 40 unsigned int i, j;
1da177e4
LT
41
42 seq_printf(seq,
49e31cba 43 "net %u %u %u %u\n",
1da177e4
LT
44 statp->netcnt,
45 statp->netudpcnt,
46 statp->nettcpcnt,
47 statp->nettcpconn);
48 seq_printf(seq,
49e31cba 49 "rpc %u %u %u\n",
1da177e4
LT
50 statp->rpccnt,
51 statp->rpcretrans,
52 statp->rpcauthrefresh);
53
54 for (i = 0; i < prog->nrvers; i++) {
55 const struct rpc_version *vers = prog->version[i];
56 if (!vers)
57 continue;
49e31cba 58 seq_printf(seq, "proc%u %u",
1da177e4
LT
59 vers->number, vers->nrprocs);
60 for (j = 0; j < vers->nrprocs; j++)
1c5876dd 61 seq_printf(seq, " %u", vers->counts[j]);
1da177e4
LT
62 seq_putc(seq, '\n');
63 }
64 return 0;
65}
66
67static int rpc_proc_open(struct inode *inode, struct file *file)
68{
d9dda78b 69 return single_open(file, rpc_proc_show, PDE_DATA(inode));
1da177e4
LT
70}
71
97a32539
AD
72static const struct proc_ops rpc_proc_ops = {
73 .proc_open = rpc_proc_open,
74 .proc_read = seq_read,
75 .proc_lseek = seq_lseek,
76 .proc_release = single_release,
1da177e4
LT
77};
78
79/*
80 * Get RPC server stats
81 */
7fd38af9
CH
82void svc_seq_show(struct seq_file *seq, const struct svc_stat *statp)
83{
1da177e4 84 const struct svc_program *prog = statp->program;
1da177e4 85 const struct svc_version *vers;
ea339d46 86 unsigned int i, j;
1da177e4
LT
87
88 seq_printf(seq,
49e31cba 89 "net %u %u %u %u\n",
1da177e4
LT
90 statp->netcnt,
91 statp->netudpcnt,
92 statp->nettcpcnt,
93 statp->nettcpconn);
94 seq_printf(seq,
49e31cba 95 "rpc %u %u %u %u %u\n",
1da177e4
LT
96 statp->rpccnt,
97 statp->rpcbadfmt+statp->rpcbadauth+statp->rpcbadclnt,
98 statp->rpcbadfmt,
99 statp->rpcbadauth,
100 statp->rpcbadclnt);
101
102 for (i = 0; i < prog->pg_nvers; i++) {
7fd38af9
CH
103 vers = prog->pg_vers[i];
104 if (!vers)
1da177e4 105 continue;
49e31cba 106 seq_printf(seq, "proc%d %u", i, vers->vs_nproc);
7fd38af9
CH
107 for (j = 0; j < vers->vs_nproc; j++)
108 seq_printf(seq, " %u", vers->vs_count[j]);
1da177e4
LT
109 seq_putc(seq, '\n');
110 }
111}
24c3767e 112EXPORT_SYMBOL_GPL(svc_seq_show);
1da177e4 113
11c556b3
CL
114/**
115 * rpc_alloc_iostats - allocate an rpc_iostats structure
116 * @clnt: RPC program, version, and xprt
117 *
118 */
119struct rpc_iostats *rpc_alloc_iostats(struct rpc_clnt *clnt)
120{
edef1297
CL
121 struct rpc_iostats *stats;
122 int i;
123
124 stats = kcalloc(clnt->cl_maxproc, sizeof(*stats), GFP_KERNEL);
125 if (stats) {
126 for (i = 0; i < clnt->cl_maxproc; i++)
127 spin_lock_init(&stats[i].om_lock);
128 }
129 return stats;
11c556b3 130}
e8914c65 131EXPORT_SYMBOL_GPL(rpc_alloc_iostats);
11c556b3
CL
132
133/**
134 * rpc_free_iostats - release an rpc_iostats structure
135 * @stats: doomed rpc_iostats structure
136 *
137 */
138void rpc_free_iostats(struct rpc_iostats *stats)
139{
140 kfree(stats);
141}
e8914c65 142EXPORT_SYMBOL_GPL(rpc_free_iostats);
11c556b3
CL
143
144/**
840210fc 145 * rpc_count_iostats_metrics - tally up per-task stats
11c556b3 146 * @task: completed rpc_task
840210fc 147 * @op_metrics: stat structure for OP that will accumulate stats from @task
11c556b3 148 */
840210fc
WAA
149void rpc_count_iostats_metrics(const struct rpc_task *task,
150 struct rpc_iostats *op_metrics)
11c556b3
CL
151{
152 struct rpc_rqst *req = task->tk_rqstp;
40bf7eb3 153 ktime_t backlog, execute, now;
11c556b3 154
840210fc 155 if (!op_metrics || !req)
11c556b3 156 return;
55ae1aab 157
edef1297 158 now = ktime_get();
edef1297
CL
159 spin_lock(&op_metrics->om_lock);
160
11c556b3 161 op_metrics->om_ops++;
ae09531d
CL
162 /* kernel API: om_ops must never become larger than om_ntrans */
163 op_metrics->om_ntrans += max(req->rq_ntrans, 1);
11c556b3
CL
164 op_metrics->om_timeouts += task->tk_timeouts;
165
d60dbb20 166 op_metrics->om_bytes_sent += req->rq_xmit_bytes_sent;
dd2b63d0 167 op_metrics->om_bytes_recv += req->rq_reply_bytes_recvd;
11c556b3 168
40bf7eb3 169 backlog = 0;
ae09531d 170 if (ktime_to_ns(req->rq_xtime)) {
40bf7eb3
CL
171 backlog = ktime_sub(req->rq_xtime, task->tk_start);
172 op_metrics->om_queue = ktime_add(op_metrics->om_queue, backlog);
ae09531d 173 }
40bf7eb3 174
d60dbb20 175 op_metrics->om_rtt = ktime_add(op_metrics->om_rtt, req->rq_rtt);
11c556b3 176
40bf7eb3
CL
177 execute = ktime_sub(now, task->tk_start);
178 op_metrics->om_execute = ktime_add(op_metrics->om_execute, execute);
a332518f
DW
179 if (task->tk_status < 0)
180 op_metrics->om_error_status++;
edef1297
CL
181
182 spin_unlock(&op_metrics->om_lock);
40bf7eb3
CL
183
184 trace_rpc_stats_latency(req->rq_task, backlog, req->rq_rtt, execute);
11c556b3 185}
840210fc
WAA
186EXPORT_SYMBOL_GPL(rpc_count_iostats_metrics);
187
188/**
189 * rpc_count_iostats - tally up per-task stats
190 * @task: completed rpc_task
191 * @stats: array of stat structures
192 *
193 * Uses the statidx from @task
194 */
195void rpc_count_iostats(const struct rpc_task *task, struct rpc_iostats *stats)
196{
197 rpc_count_iostats_metrics(task,
198 &stats[task->tk_msg.rpc_proc->p_statidx]);
199}
0a702195 200EXPORT_SYMBOL_GPL(rpc_count_iostats);
11c556b3 201
ec535ce1 202static void _print_name(struct seq_file *seq, unsigned int op,
499b4988 203 const struct rpc_procinfo *procs)
cc0175c1
CL
204{
205 if (procs[op].p_name)
206 seq_printf(seq, "\t%12s: ", procs[op].p_name);
207 else if (op == 0)
208 seq_printf(seq, "\t NULL: ");
209 else
210 seq_printf(seq, "\t%12u: ", op);
211}
212
189e1955
DW
213static void _add_rpc_iostats(struct rpc_iostats *a, struct rpc_iostats *b)
214{
215 a->om_ops += b->om_ops;
216 a->om_ntrans += b->om_ntrans;
217 a->om_timeouts += b->om_timeouts;
218 a->om_bytes_sent += b->om_bytes_sent;
219 a->om_bytes_recv += b->om_bytes_recv;
220 a->om_queue = ktime_add(a->om_queue, b->om_queue);
221 a->om_rtt = ktime_add(a->om_rtt, b->om_rtt);
222 a->om_execute = ktime_add(a->om_execute, b->om_execute);
a332518f 223 a->om_error_status += b->om_error_status;
189e1955
DW
224}
225
acdce5fb
DW
226static void _print_rpc_iostats(struct seq_file *seq, struct rpc_iostats *stats,
227 int op, const struct rpc_procinfo *procs)
228{
229 _print_name(seq, op, procs);
a332518f 230 seq_printf(seq, "%lu %lu %lu %llu %llu %llu %llu %llu %lu\n",
acdce5fb
DW
231 stats->om_ops,
232 stats->om_ntrans,
233 stats->om_timeouts,
234 stats->om_bytes_sent,
235 stats->om_bytes_recv,
236 ktime_to_ms(stats->om_queue),
237 ktime_to_ms(stats->om_rtt),
a332518f
DW
238 ktime_to_ms(stats->om_execute),
239 stats->om_error_status);
acdce5fb
DW
240}
241
10db5691
N
242static int do_print_stats(struct rpc_clnt *clnt, struct rpc_xprt *xprt, void *seqv)
243{
244 struct seq_file *seq = seqv;
245
246 xprt->ops->print_stats(xprt, seq);
247 return 0;
248}
249
016583d7 250void rpc_clnt_show_stats(struct seq_file *seq, struct rpc_clnt *clnt)
11c556b3 251{
11c556b3
CL
252 unsigned int op, maxproc = clnt->cl_maxproc;
253
016583d7 254 if (!clnt->cl_metrics)
11c556b3
CL
255 return;
256
257 seq_printf(seq, "\tRPC iostats version: %s ", RPC_IOSTATS_VERS);
258 seq_printf(seq, "p/v: %u/%u (%s)\n",
55909f21 259 clnt->cl_prog, clnt->cl_vers, clnt->cl_program->name);
11c556b3 260
10db5691 261 rpc_clnt_iterate_for_each_xprt(clnt, do_print_stats, seq);
11c556b3
CL
262
263 seq_printf(seq, "\tper-op statistics\n");
264 for (op = 0; op < maxproc; op++) {
016583d7
DW
265 struct rpc_iostats stats = {};
266 struct rpc_clnt *next = clnt;
267 do {
268 _add_rpc_iostats(&stats, &next->cl_metrics[op]);
269 if (next == next->cl_parent)
270 break;
271 next = next->cl_parent;
272 } while (next);
273 _print_rpc_iostats(seq, &stats, op, clnt->cl_procinfo);
11c556b3
CL
274 }
275}
016583d7 276EXPORT_SYMBOL_GPL(rpc_clnt_show_stats);
11c556b3 277
1da177e4
LT
278/*
279 * Register/unregister RPC proc files
280 */
281static inline struct proc_dir_entry *
ec7652aa 282do_register(struct net *net, const char *name, void *data,
97a32539 283 const struct proc_ops *proc_ops)
1da177e4 284{
4f42d0d5 285 struct sunrpc_net *sn;
1da177e4 286
4f42d0d5 287 dprintk("RPC: registering /proc/net/rpc/%s\n", name);
ec7652aa 288 sn = net_generic(net, sunrpc_net_id);
97a32539 289 return proc_create_data(name, 0, sn->proc_net_rpc, proc_ops, data);
1da177e4
LT
290}
291
292struct proc_dir_entry *
ec7652aa 293rpc_proc_register(struct net *net, struct rpc_stat *statp)
1da177e4 294{
97a32539 295 return do_register(net, statp->program->name, statp, &rpc_proc_ops);
1da177e4 296}
e8914c65 297EXPORT_SYMBOL_GPL(rpc_proc_register);
1da177e4
LT
298
299void
ec7652aa 300rpc_proc_unregister(struct net *net, const char *name)
1da177e4 301{
4f42d0d5
PE
302 struct sunrpc_net *sn;
303
ec7652aa 304 sn = net_generic(net, sunrpc_net_id);
4f42d0d5 305 remove_proc_entry(name, sn->proc_net_rpc);
1da177e4 306}
e8914c65 307EXPORT_SYMBOL_GPL(rpc_proc_unregister);
1da177e4
LT
308
309struct proc_dir_entry *
97a32539 310svc_proc_register(struct net *net, struct svc_stat *statp, const struct proc_ops *proc_ops)
1da177e4 311{
97a32539 312 return do_register(net, statp->program->pg_name, statp, proc_ops);
1da177e4 313}
24c3767e 314EXPORT_SYMBOL_GPL(svc_proc_register);
1da177e4
LT
315
316void
246590f5 317svc_proc_unregister(struct net *net, const char *name)
1da177e4 318{
4f42d0d5
PE
319 struct sunrpc_net *sn;
320
246590f5 321 sn = net_generic(net, sunrpc_net_id);
4f42d0d5 322 remove_proc_entry(name, sn->proc_net_rpc);
1da177e4 323}
24c3767e 324EXPORT_SYMBOL_GPL(svc_proc_unregister);
1da177e4 325
4f42d0d5 326int rpc_proc_init(struct net *net)
1da177e4 327{
4f42d0d5
PE
328 struct sunrpc_net *sn;
329
46121cf7 330 dprintk("RPC: registering /proc/net/rpc\n");
4f42d0d5
PE
331 sn = net_generic(net, sunrpc_net_id);
332 sn->proc_net_rpc = proc_mkdir("rpc", net->proc_net);
333 if (sn->proc_net_rpc == NULL)
334 return -ENOMEM;
335
336 return 0;
1da177e4
LT
337}
338
4f42d0d5 339void rpc_proc_exit(struct net *net)
1da177e4 340{
46121cf7 341 dprintk("RPC: unregistering /proc/net/rpc\n");
4f42d0d5 342 remove_proc_entry("rpc", net->proc_net);
1da177e4 343}