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
  17 #include <linux/init.h>
  18 #include <linux/kernel.h>
  19 #include <linux/proc_fs.h>
  20 #include <linux/seq_file.h>
  21 #include <linux/sunrpc/clnt.h>
  22 #include <linux/sunrpc/svcsock.h>
  23 #include <linux/sunrpc/metrics.h>
  24
  25 #define RPCDBG_FACILITY RPCDBG_MISC
  26
  27 struct proc_dir_entry   *proc_net_rpc = NULL;
  28
  29 /*
  30  * Get RPC client stats
  31  */
  32 static int rpc_proc_show(struct seq_file *seq, void *v) {
  33         const struct rpc_stat   *statp = seq->private;
  34         const struct rpc_program *prog = statp->program;
  35         int             i, j;
  36
  37         seq_printf(seq,
  38                 "net %u %u %u %u\n",
  39                         statp->netcnt,
  40                         statp->netudpcnt,
  41                         statp->nettcpcnt,
  42                         statp->nettcpconn);
  43         seq_printf(seq,
  44                 "rpc %u %u %u\n",
  45                         statp->rpccnt,
  46                         statp->rpcretrans,
  47                         statp->rpcauthrefresh);
  48
  49         for (i = 0; i < prog->nrvers; i++) {
  50                 const struct rpc_version *vers = prog->version[i];
  51                 if (!vers)
  52                         continue;
  53                 seq_printf(seq, "proc%u %u",
  54                                         vers->number, vers->nrprocs);
  55                 for (j = 0; j < vers->nrprocs; j++)
  56                         seq_printf(seq, " %u",
  57                                         vers->procs[j].p_count);
  58                 seq_putc(seq, '\n');
  59         }
  60         return 0;
  61 }
  62
  63 static int rpc_proc_open(struct inode *inode, struct file *file)
  64 {
  65         return single_open(file, rpc_proc_show, PDE(inode)->data);
  66 }
  67
  68 static const struct file_operations rpc_proc_fops = {
  69         .owner = THIS_MODULE,
  70         .open = rpc_proc_open,
  71         .read  = seq_read,
  72         .llseek = seq_lseek,
  73         .release = single_release,
  74 };
  75
  76 /*
  77  * Get RPC server stats
  78  */
  79 void svc_seq_show(struct seq_file *seq, const struct svc_stat *statp) {
  80         const struct svc_program *prog = statp->program;
  81         const struct svc_procedure *proc;
  82         const struct svc_version *vers;
  83         int             i, j;
  84
  85         seq_printf(seq,
  86                 "net %u %u %u %u\n",
  87                         statp->netcnt,
  88                         statp->netudpcnt,
  89                         statp->nettcpcnt,
  90                         statp->nettcpconn);
  91         seq_printf(seq,
  92                 "rpc %u %u %u %u %u\n",
  93                         statp->rpccnt,
  94                         statp->rpcbadfmt+statp->rpcbadauth+statp->rpcbadclnt,
  95                         statp->rpcbadfmt,
  96                         statp->rpcbadauth,
  97                         statp->rpcbadclnt);
  98
  99         for (i = 0; i < prog->pg_nvers; i++) {
 100                 if (!(vers = prog->pg_vers[i]) || !(proc = vers->vs_proc))
 101                         continue;
 102                 seq_printf(seq, "proc%d %u", i, vers->vs_nproc);
 103                 for (j = 0; j < vers->vs_nproc; j++, proc++)
 104                         seq_printf(seq, " %u", proc->pc_count);
 105                 seq_putc(seq, '\n');
 106         }
 107 }
 108
 109 /**
 110  * rpc_alloc_iostats - allocate an rpc_iostats structure
 111  * @clnt: RPC program, version, and xprt
 112  *
 113  */
 114 struct rpc_iostats *rpc_alloc_iostats(struct rpc_clnt *clnt)
 115 {
 116         struct rpc_iostats *new;
 117         new = kcalloc(clnt->cl_maxproc, sizeof(struct rpc_iostats), GFP_KERNEL);
 118         return new;
 119 }
 120 EXPORT_SYMBOL(rpc_alloc_iostats);
 121
 122 /**
 123  * rpc_free_iostats - release an rpc_iostats structure
 124  * @stats: doomed rpc_iostats structure
 125  *
 126  */
 127 void rpc_free_iostats(struct rpc_iostats *stats)
 128 {
 129         kfree(stats);
 130 }
 131 EXPORT_SYMBOL(rpc_free_iostats);
 132
 133 /**
 134  * rpc_count_iostats - tally up per-task stats
 135  * @task: completed rpc_task
 136  *
 137  * Relies on the caller for serialization.
 138  */
 139 void rpc_count_iostats(struct rpc_task *task)
 140 {
 141         struct rpc_rqst *req = task->tk_rqstp;
 142         struct rpc_iostats *stats = task->tk_client->cl_metrics;
 143         struct rpc_iostats *op_metrics;
 144         long rtt, execute, queue;
 145
 146         if (!stats || !req)
 147                 return;
 148         op_metrics = &stats[task->tk_msg.rpc_proc->p_statidx];
 149
 150         op_metrics->om_ops++;
 151         op_metrics->om_ntrans += req->rq_ntrans;
 152         op_metrics->om_timeouts += task->tk_timeouts;
 153
 154         op_metrics->om_bytes_sent += task->tk_bytes_sent;
 155         op_metrics->om_bytes_recv += req->rq_received;
 156
 157         queue = (long)req->rq_xtime - task->tk_start;
 158         if (queue < 0)
 159                 queue = -queue;
 160         op_metrics->om_queue += queue;
 161
 162         rtt = task->tk_rtt;
 163         if (rtt < 0)
 164                 rtt = -rtt;
 165         op_metrics->om_rtt += rtt;
 166
 167         execute = (long)jiffies - task->tk_start;
 168         if (execute < 0)
 169                 execute = -execute;
 170         op_metrics->om_execute += execute;
 171 }
 172
 173 static void _print_name(struct seq_file *seq, unsigned int op,
 174                         struct rpc_procinfo *procs)
 175 {
 176         if (procs[op].p_name)
 177                 seq_printf(seq, "\t%12s: ", procs[op].p_name);
 178         else if (op == 0)
 179                 seq_printf(seq, "\t        NULL: ");
 180         else
 181                 seq_printf(seq, "\t%12u: ", op);
 182 }
 183
 184 #define MILLISECS_PER_JIFFY     (1000 / HZ)
 185
 186 void rpc_print_iostats(struct seq_file *seq, struct rpc_clnt *clnt)
 187 {
 188         struct rpc_iostats *stats = clnt->cl_metrics;
 189         struct rpc_xprt *xprt = clnt->cl_xprt;
 190         unsigned int op, maxproc = clnt->cl_maxproc;
 191
 192         if (!stats)
 193                 return;
 194
 195         seq_printf(seq, "\tRPC iostats version: %s  ", RPC_IOSTATS_VERS);
 196         seq_printf(seq, "p/v: %u/%u (%s)\n",
 197                         clnt->cl_prog, clnt->cl_vers, clnt->cl_protname);
 198
 199         if (xprt)
 200                 xprt->ops->print_stats(xprt, seq);
 201
 202         seq_printf(seq, "\tper-op statistics\n");
 203         for (op = 0; op < maxproc; op++) {
 204                 struct rpc_iostats *metrics = &stats[op];
 205                 _print_name(seq, op, clnt->cl_procinfo);
 206                 seq_printf(seq, "%lu %lu %lu %Lu %Lu %Lu %Lu %Lu\n",
 207                                 metrics->om_ops,
 208                                 metrics->om_ntrans,
 209                                 metrics->om_timeouts,
 210                                 metrics->om_bytes_sent,
 211                                 metrics->om_bytes_recv,
 212                                 metrics->om_queue * MILLISECS_PER_JIFFY,
 213                                 metrics->om_rtt * MILLISECS_PER_JIFFY,
 214                                 metrics->om_execute * MILLISECS_PER_JIFFY);
 215         }
 216 }
 217 EXPORT_SYMBOL(rpc_print_iostats);
 218
 219 /*
 220  * Register/unregister RPC proc files
 221  */
 222 static inline struct proc_dir_entry *
 223 do_register(const char *name, void *data, const struct file_operations *fops)
 224 {
 225         struct proc_dir_entry *ent;
 226
 227         rpc_proc_init();
 228         dprintk("RPC:       registering /proc/net/rpc/%s\n", name);
 229
 230         ent = create_proc_entry(name, 0, proc_net_rpc);
 231         if (ent) {
 232                 ent->proc_fops = fops;
 233                 ent->data = data;
 234         }
 235         return ent;
 236 }
 237
 238 struct proc_dir_entry *
 239 rpc_proc_register(struct rpc_stat *statp)
 240 {
 241         return do_register(statp->program->name, statp, &rpc_proc_fops);
 242 }
 243
 244 void
 245 rpc_proc_unregister(const char *name)
 246 {
 247         remove_proc_entry(name, proc_net_rpc);
 248 }
 249
 250 struct proc_dir_entry *
 251 svc_proc_register(struct svc_stat *statp, const struct file_operations *fops)
 252 {
 253         return do_register(statp->program->pg_name, statp, fops);
 254 }
 255
 256 void
 257 svc_proc_unregister(const char *name)
 258 {
 259         remove_proc_entry(name, proc_net_rpc);
 260 }
 261
 262 void
 263 rpc_proc_init(void)
 264 {
 265         dprintk("RPC:       registering /proc/net/rpc\n");
 266         if (!proc_net_rpc) {
 267                 struct proc_dir_entry *ent;
 268                 ent = proc_mkdir("rpc", proc_net);
 269                 if (ent) {
 270                         ent->owner = THIS_MODULE;
 271                         proc_net_rpc = ent;
 272                 }
 273         }
 274 }
 275
 276 void
 277 rpc_proc_exit(void)
 278 {
 279         dprintk("RPC:       unregistering /proc/net/rpc\n");
 280         if (proc_net_rpc) {
 281                 proc_net_rpc = NULL;
 282                 remove_proc_entry("net/rpc", NULL);
 283         }
 284 }
 285