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