net/sunrpc/stats.c

   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 #include <linux/rcupdate.h>
  26
  27 #include "netns.h"
  28
  29 #define RPCDBG_FACILITY RPCDBG_MISC
  30
  31 /*
  32  * Get RPC client stats
  33  */
  34 static 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;
  37         unsigned int i, j;
  38
  39         seq_printf(seq,
  40                 "net %u %u %u %u\n",
  41                         statp->netcnt,
  42                         statp->netudpcnt,
  43                         statp->nettcpcnt,
  44                         statp->nettcpconn);
  45         seq_printf(seq,
  46                 "rpc %u %u %u\n",
  47                         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;
  55                 seq_printf(seq, "proc%u %u",
  56                                         vers->number, vers->nrprocs);
  57                 for (j = 0; j < vers->nrprocs; j++)
  58                         seq_printf(seq, " %u", vers->counts[j]);
  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_DATA(inode));
  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 *stats;
 119         int i;
 120
 121         stats = kcalloc(clnt->cl_maxproc, sizeof(*stats), GFP_KERNEL);
 122         if (stats) {
 123                 for (i = 0; i < clnt->cl_maxproc; i++)
 124                         spin_lock_init(&stats[i].om_lock);
 125         }
 126         return stats;
 127 }
 128 EXPORT_SYMBOL_GPL(rpc_alloc_iostats);
 129
 130 /**
 131  * rpc_free_iostats - release an rpc_iostats structure
 132  * @stats: doomed rpc_iostats structure
 133  *
 134  */
 135 void rpc_free_iostats(struct rpc_iostats *stats)
 136 {
 137         kfree(stats);
 138 }
 139 EXPORT_SYMBOL_GPL(rpc_free_iostats);
 140
 141 /**
 142  * rpc_count_iostats_metrics - tally up per-task stats
 143  * @task: completed rpc_task
 144  * @op_metrics: stat structure for OP that will accumulate stats from @task
 145  */
 146 void rpc_count_iostats_metrics(const struct rpc_task *task,
 147                                struct rpc_iostats *op_metrics)
 148 {
 149         struct rpc_rqst *req = task->tk_rqstp;
 150         ktime_t delta, now;
 151
 152         if (!op_metrics || !req)
 153                 return;
 154
 155         now = ktime_get();
 156         spin_lock(&op_metrics->om_lock);
 157
 158         op_metrics->om_ops++;
 159         /* kernel API: om_ops must never become larger than om_ntrans */
 160         op_metrics->om_ntrans += max(req->rq_ntrans, 1);
 161         op_metrics->om_timeouts += task->tk_timeouts;
 162
 163         op_metrics->om_bytes_sent += req->rq_xmit_bytes_sent;
 164         op_metrics->om_bytes_recv += req->rq_reply_bytes_recvd;
 165
 166         if (ktime_to_ns(req->rq_xtime)) {
 167                 delta = ktime_sub(req->rq_xtime, task->tk_start);
 168                 op_metrics->om_queue = ktime_add(op_metrics->om_queue, delta);
 169         }
 170         op_metrics->om_rtt = ktime_add(op_metrics->om_rtt, req->rq_rtt);
 171
 172         delta = ktime_sub(now, task->tk_start);
 173         op_metrics->om_execute = ktime_add(op_metrics->om_execute, delta);
 174
 175         spin_unlock(&op_metrics->om_lock);
 176 }
 177 EXPORT_SYMBOL_GPL(rpc_count_iostats_metrics);
 178
 179 /**
 180  * rpc_count_iostats - tally up per-task stats
 181  * @task: completed rpc_task
 182  * @stats: array of stat structures
 183  *
 184  * Uses the statidx from @task
 185  */
 186 void rpc_count_iostats(const struct rpc_task *task, struct rpc_iostats *stats)
 187 {
 188         rpc_count_iostats_metrics(task,
 189                                   &stats[task->tk_msg.rpc_proc->p_statidx]);
 190 }
 191 EXPORT_SYMBOL_GPL(rpc_count_iostats);
 192
 193 static void _print_name(struct seq_file *seq, unsigned int op,
 194                         const struct rpc_procinfo *procs)
 195 {
 196         if (procs[op].p_name)
 197                 seq_printf(seq, "\t%12s: ", procs[op].p_name);
 198         else if (op == 0)
 199                 seq_printf(seq, "\t        NULL: ");
 200         else
 201                 seq_printf(seq, "\t%12u: ", op);
 202 }
 203
 204 void rpc_print_iostats(struct seq_file *seq, struct rpc_clnt *clnt)
 205 {
 206         struct rpc_iostats *stats = clnt->cl_metrics;
 207         struct rpc_xprt *xprt;
 208         unsigned int op, maxproc = clnt->cl_maxproc;
 209
 210         if (!stats)
 211                 return;
 212
 213         seq_printf(seq, "\tRPC iostats version: %s  ", RPC_IOSTATS_VERS);
 214         seq_printf(seq, "p/v: %u/%u (%s)\n",
 215                         clnt->cl_prog, clnt->cl_vers, clnt->cl_program->name);
 216
 217         rcu_read_lock();
 218         xprt = rcu_dereference(clnt->cl_xprt);
 219         if (xprt)
 220                 xprt->ops->print_stats(xprt, seq);
 221         rcu_read_unlock();
 222
 223         seq_printf(seq, "\tper-op statistics\n");
 224         for (op = 0; op < maxproc; op++) {
 225                 struct rpc_iostats *metrics = &stats[op];
 226                 _print_name(seq, op, clnt->cl_procinfo);
 227                 seq_printf(seq, "%lu %lu %lu %Lu %Lu %Lu %Lu %Lu\n",
 228                                 metrics->om_ops,
 229                                 metrics->om_ntrans,
 230                                 metrics->om_timeouts,
 231                                 metrics->om_bytes_sent,
 232                                 metrics->om_bytes_recv,
 233                                 ktime_to_ms(metrics->om_queue),
 234                                 ktime_to_ms(metrics->om_rtt),
 235                                 ktime_to_ms(metrics->om_execute));
 236         }
 237 }
 238 EXPORT_SYMBOL_GPL(rpc_print_iostats);
 239
 240 /*
 241  * Register/unregister RPC proc files
 242  */
 243 static inline struct proc_dir_entry *
 244 do_register(struct net *net, const char *name, void *data,
 245             const struct file_operations *fops)
 246 {
 247         struct sunrpc_net *sn;
 248
 249         dprintk("RPC:       registering /proc/net/rpc/%s\n", name);
 250         sn = net_generic(net, sunrpc_net_id);
 251         return proc_create_data(name, 0, sn->proc_net_rpc, fops, data);
 252 }
 253
 254 struct proc_dir_entry *
 255 rpc_proc_register(struct net *net, struct rpc_stat *statp)
 256 {
 257         return do_register(net, statp->program->name, statp, &rpc_proc_fops);
 258 }
 259 EXPORT_SYMBOL_GPL(rpc_proc_register);
 260
 261 void
 262 rpc_proc_unregister(struct net *net, const char *name)
 263 {
 264         struct sunrpc_net *sn;
 265
 266         sn = net_generic(net, sunrpc_net_id);
 267         remove_proc_entry(name, sn->proc_net_rpc);
 268 }
 269 EXPORT_SYMBOL_GPL(rpc_proc_unregister);
 270
 271 struct proc_dir_entry *
 272 svc_proc_register(struct net *net, struct svc_stat *statp, const struct file_operations *fops)
 273 {
 274         return do_register(net, statp->program->pg_name, statp, fops);
 275 }
 276 EXPORT_SYMBOL_GPL(svc_proc_register);
 277
 278 void
 279 svc_proc_unregister(struct net *net, const char *name)
 280 {
 281         struct sunrpc_net *sn;
 282
 283         sn = net_generic(net, sunrpc_net_id);
 284         remove_proc_entry(name, sn->proc_net_rpc);
 285 }
 286 EXPORT_SYMBOL_GPL(svc_proc_unregister);
 287
 288 int rpc_proc_init(struct net *net)
 289 {
 290         struct sunrpc_net *sn;
 291
 292         dprintk("RPC:       registering /proc/net/rpc\n");
 293         sn = net_generic(net, sunrpc_net_id);
 294         sn->proc_net_rpc = proc_mkdir("rpc", net->proc_net);
 295         if (sn->proc_net_rpc == NULL)
 296                 return -ENOMEM;
 297
 298         return 0;
 299 }
 300
 301 void rpc_proc_exit(struct net *net)
 302 {
 303         dprintk("RPC:       unregistering /proc/net/rpc\n");
 304         remove_proc_entry("rpc", net->proc_net);
 305 }
 306