stats.c 8.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343
  1. // SPDX-License-Identifier: GPL-2.0-only
  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. #include <linux/module.h>
  16. #include <linux/slab.h>
  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. #include <linux/rcupdate.h>
  25. #include <trace/events/sunrpc.h>
  26. #include "netns.h"
  27. #define RPCDBG_FACILITY RPCDBG_MISC
  28. /*
  29. * Get RPC client stats
  30. */
  31. static int rpc_proc_show(struct seq_file *seq, void *v) {
  32. const struct rpc_stat *statp = seq->private;
  33. const struct rpc_program *prog = statp->program;
  34. unsigned int i, j;
  35. seq_printf(seq,
  36. "net %u %u %u %u\n",
  37. statp->netcnt,
  38. statp->netudpcnt,
  39. statp->nettcpcnt,
  40. statp->nettcpconn);
  41. seq_printf(seq,
  42. "rpc %u %u %u\n",
  43. statp->rpccnt,
  44. statp->rpcretrans,
  45. statp->rpcauthrefresh);
  46. for (i = 0; i < prog->nrvers; i++) {
  47. const struct rpc_version *vers = prog->version[i];
  48. if (!vers)
  49. continue;
  50. seq_printf(seq, "proc%u %u",
  51. vers->number, vers->nrprocs);
  52. for (j = 0; j < vers->nrprocs; j++)
  53. seq_printf(seq, " %u", vers->counts[j]);
  54. seq_putc(seq, '\n');
  55. }
  56. return 0;
  57. }
  58. static int rpc_proc_open(struct inode *inode, struct file *file)
  59. {
  60. return single_open(file, rpc_proc_show, PDE_DATA(inode));
  61. }
  62. static const struct proc_ops rpc_proc_ops = {
  63. .proc_open = rpc_proc_open,
  64. .proc_read = seq_read,
  65. .proc_lseek = seq_lseek,
  66. .proc_release = single_release,
  67. };
  68. /*
  69. * Get RPC server stats
  70. */
  71. void svc_seq_show(struct seq_file *seq, const struct svc_stat *statp)
  72. {
  73. const struct svc_program *prog = statp->program;
  74. const struct svc_version *vers;
  75. unsigned int i, j;
  76. seq_printf(seq,
  77. "net %u %u %u %u\n",
  78. statp->netcnt,
  79. statp->netudpcnt,
  80. statp->nettcpcnt,
  81. statp->nettcpconn);
  82. seq_printf(seq,
  83. "rpc %u %u %u %u %u\n",
  84. statp->rpccnt,
  85. statp->rpcbadfmt+statp->rpcbadauth+statp->rpcbadclnt,
  86. statp->rpcbadfmt,
  87. statp->rpcbadauth,
  88. statp->rpcbadclnt);
  89. for (i = 0; i < prog->pg_nvers; i++) {
  90. vers = prog->pg_vers[i];
  91. if (!vers)
  92. continue;
  93. seq_printf(seq, "proc%d %u", i, vers->vs_nproc);
  94. for (j = 0; j < vers->vs_nproc; j++)
  95. seq_printf(seq, " %u", vers->vs_count[j]);
  96. seq_putc(seq, '\n');
  97. }
  98. }
  99. EXPORT_SYMBOL_GPL(svc_seq_show);
  100. /**
  101. * rpc_alloc_iostats - allocate an rpc_iostats structure
  102. * @clnt: RPC program, version, and xprt
  103. *
  104. */
  105. struct rpc_iostats *rpc_alloc_iostats(struct rpc_clnt *clnt)
  106. {
  107. struct rpc_iostats *stats;
  108. int i;
  109. stats = kcalloc(clnt->cl_maxproc, sizeof(*stats), GFP_KERNEL);
  110. if (stats) {
  111. for (i = 0; i < clnt->cl_maxproc; i++)
  112. spin_lock_init(&stats[i].om_lock);
  113. }
  114. return stats;
  115. }
  116. EXPORT_SYMBOL_GPL(rpc_alloc_iostats);
  117. /**
  118. * rpc_free_iostats - release an rpc_iostats structure
  119. * @stats: doomed rpc_iostats structure
  120. *
  121. */
  122. void rpc_free_iostats(struct rpc_iostats *stats)
  123. {
  124. kfree(stats);
  125. }
  126. EXPORT_SYMBOL_GPL(rpc_free_iostats);
  127. /**
  128. * rpc_count_iostats_metrics - tally up per-task stats
  129. * @task: completed rpc_task
  130. * @op_metrics: stat structure for OP that will accumulate stats from @task
  131. */
  132. void rpc_count_iostats_metrics(const struct rpc_task *task,
  133. struct rpc_iostats *op_metrics)
  134. {
  135. struct rpc_rqst *req = task->tk_rqstp;
  136. ktime_t backlog, execute, now;
  137. if (!op_metrics || !req)
  138. return;
  139. now = ktime_get();
  140. spin_lock(&op_metrics->om_lock);
  141. op_metrics->om_ops++;
  142. /* kernel API: om_ops must never become larger than om_ntrans */
  143. op_metrics->om_ntrans += max(req->rq_ntrans, 1);
  144. op_metrics->om_timeouts += task->tk_timeouts;
  145. op_metrics->om_bytes_sent += req->rq_xmit_bytes_sent;
  146. op_metrics->om_bytes_recv += req->rq_reply_bytes_recvd;
  147. backlog = 0;
  148. if (ktime_to_ns(req->rq_xtime)) {
  149. backlog = ktime_sub(req->rq_xtime, task->tk_start);
  150. op_metrics->om_queue = ktime_add(op_metrics->om_queue, backlog);
  151. }
  152. op_metrics->om_rtt = ktime_add(op_metrics->om_rtt, req->rq_rtt);
  153. execute = ktime_sub(now, task->tk_start);
  154. op_metrics->om_execute = ktime_add(op_metrics->om_execute, execute);
  155. if (task->tk_status < 0)
  156. op_metrics->om_error_status++;
  157. spin_unlock(&op_metrics->om_lock);
  158. trace_rpc_stats_latency(req->rq_task, backlog, req->rq_rtt, execute);
  159. }
  160. EXPORT_SYMBOL_GPL(rpc_count_iostats_metrics);
  161. /**
  162. * rpc_count_iostats - tally up per-task stats
  163. * @task: completed rpc_task
  164. * @stats: array of stat structures
  165. *
  166. * Uses the statidx from @task
  167. */
  168. void rpc_count_iostats(const struct rpc_task *task, struct rpc_iostats *stats)
  169. {
  170. rpc_count_iostats_metrics(task,
  171. &stats[task->tk_msg.rpc_proc->p_statidx]);
  172. }
  173. EXPORT_SYMBOL_GPL(rpc_count_iostats);
  174. static void _print_name(struct seq_file *seq, unsigned int op,
  175. const struct rpc_procinfo *procs)
  176. {
  177. if (procs[op].p_name)
  178. seq_printf(seq, "\t%12s: ", procs[op].p_name);
  179. else if (op == 0)
  180. seq_printf(seq, "\t NULL: ");
  181. else
  182. seq_printf(seq, "\t%12u: ", op);
  183. }
  184. static void _add_rpc_iostats(struct rpc_iostats *a, struct rpc_iostats *b)
  185. {
  186. a->om_ops += b->om_ops;
  187. a->om_ntrans += b->om_ntrans;
  188. a->om_timeouts += b->om_timeouts;
  189. a->om_bytes_sent += b->om_bytes_sent;
  190. a->om_bytes_recv += b->om_bytes_recv;
  191. a->om_queue = ktime_add(a->om_queue, b->om_queue);
  192. a->om_rtt = ktime_add(a->om_rtt, b->om_rtt);
  193. a->om_execute = ktime_add(a->om_execute, b->om_execute);
  194. a->om_error_status += b->om_error_status;
  195. }
  196. static void _print_rpc_iostats(struct seq_file *seq, struct rpc_iostats *stats,
  197. int op, const struct rpc_procinfo *procs)
  198. {
  199. _print_name(seq, op, procs);
  200. seq_printf(seq, "%lu %lu %lu %llu %llu %llu %llu %llu %lu\n",
  201. stats->om_ops,
  202. stats->om_ntrans,
  203. stats->om_timeouts,
  204. stats->om_bytes_sent,
  205. stats->om_bytes_recv,
  206. ktime_to_ms(stats->om_queue),
  207. ktime_to_ms(stats->om_rtt),
  208. ktime_to_ms(stats->om_execute),
  209. stats->om_error_status);
  210. }
  211. static int do_print_stats(struct rpc_clnt *clnt, struct rpc_xprt *xprt, void *seqv)
  212. {
  213. struct seq_file *seq = seqv;
  214. xprt->ops->print_stats(xprt, seq);
  215. return 0;
  216. }
  217. void rpc_clnt_show_stats(struct seq_file *seq, struct rpc_clnt *clnt)
  218. {
  219. unsigned int op, maxproc = clnt->cl_maxproc;
  220. if (!clnt->cl_metrics)
  221. return;
  222. seq_printf(seq, "\tRPC iostats version: %s ", RPC_IOSTATS_VERS);
  223. seq_printf(seq, "p/v: %u/%u (%s)\n",
  224. clnt->cl_prog, clnt->cl_vers, clnt->cl_program->name);
  225. rpc_clnt_iterate_for_each_xprt(clnt, do_print_stats, seq);
  226. seq_printf(seq, "\tper-op statistics\n");
  227. for (op = 0; op < maxproc; op++) {
  228. struct rpc_iostats stats = {};
  229. struct rpc_clnt *next = clnt;
  230. do {
  231. _add_rpc_iostats(&stats, &next->cl_metrics[op]);
  232. if (next == next->cl_parent)
  233. break;
  234. next = next->cl_parent;
  235. } while (next);
  236. _print_rpc_iostats(seq, &stats, op, clnt->cl_procinfo);
  237. }
  238. }
  239. EXPORT_SYMBOL_GPL(rpc_clnt_show_stats);
  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 proc_ops *proc_ops)
  246. {
  247. struct sunrpc_net *sn;
  248. dprintk("RPC: registering /proc/net/rpc/%s\n", name);
  249. sn = net_generic(net, sunrpc_net_id);
  250. return proc_create_data(name, 0, sn->proc_net_rpc, proc_ops, data);
  251. }
  252. struct proc_dir_entry *
  253. rpc_proc_register(struct net *net, struct rpc_stat *statp)
  254. {
  255. return do_register(net, statp->program->name, statp, &rpc_proc_ops);
  256. }
  257. EXPORT_SYMBOL_GPL(rpc_proc_register);
  258. void
  259. rpc_proc_unregister(struct net *net, const char *name)
  260. {
  261. struct sunrpc_net *sn;
  262. sn = net_generic(net, sunrpc_net_id);
  263. remove_proc_entry(name, sn->proc_net_rpc);
  264. }
  265. EXPORT_SYMBOL_GPL(rpc_proc_unregister);
  266. struct proc_dir_entry *
  267. svc_proc_register(struct net *net, struct svc_stat *statp, const struct proc_ops *proc_ops)
  268. {
  269. return do_register(net, statp->program->pg_name, statp, proc_ops);
  270. }
  271. EXPORT_SYMBOL_GPL(svc_proc_register);
  272. void
  273. svc_proc_unregister(struct net *net, const char *name)
  274. {
  275. struct sunrpc_net *sn;
  276. sn = net_generic(net, sunrpc_net_id);
  277. remove_proc_entry(name, sn->proc_net_rpc);
  278. }
  279. EXPORT_SYMBOL_GPL(svc_proc_unregister);
  280. int rpc_proc_init(struct net *net)
  281. {
  282. struct sunrpc_net *sn;
  283. dprintk("RPC: registering /proc/net/rpc\n");
  284. sn = net_generic(net, sunrpc_net_id);
  285. sn->proc_net_rpc = proc_mkdir("rpc", net->proc_net);
  286. if (sn->proc_net_rpc == NULL)
  287. return -ENOMEM;
  288. return 0;
  289. }
  290. void rpc_proc_exit(struct net *net)
  291. {
  292. dprintk("RPC: unregistering /proc/net/rpc\n");
  293. remove_proc_entry("rpc", net->proc_net);
  294. }