Loading...
1// SPDX-License-Identifier: GPL-2.0
2/*
3 * debugfs interface for sunrpc
4 *
5 * (c) 2014 Jeff Layton <jlayton@primarydata.com>
6 */
7
8#include <linux/debugfs.h>
9#include <linux/sunrpc/sched.h>
10#include <linux/sunrpc/clnt.h>
11
12#include "netns.h"
13#include "fail.h"
14
15static struct dentry *topdir;
16static struct dentry *rpc_clnt_dir;
17static struct dentry *rpc_xprt_dir;
18
19static int
20tasks_show(struct seq_file *f, void *v)
21{
22 u32 xid = 0;
23 struct rpc_task *task = v;
24 struct rpc_clnt *clnt = task->tk_client;
25 const char *rpc_waitq = "none";
26
27 if (RPC_IS_QUEUED(task))
28 rpc_waitq = rpc_qname(task->tk_waitqueue);
29
30 if (task->tk_rqstp)
31 xid = be32_to_cpu(task->tk_rqstp->rq_xid);
32
33 seq_printf(f, "%5u %04x %6d 0x%x 0x%x %8ld %ps %sv%u %s a:%ps q:%s\n",
34 task->tk_pid, task->tk_flags, task->tk_status,
35 clnt->cl_clid, xid, rpc_task_timeout(task), task->tk_ops,
36 clnt->cl_program->name, clnt->cl_vers, rpc_proc_name(task),
37 task->tk_action, rpc_waitq);
38 return 0;
39}
40
41static void *
42tasks_start(struct seq_file *f, loff_t *ppos)
43 __acquires(&clnt->cl_lock)
44{
45 struct rpc_clnt *clnt = f->private;
46 loff_t pos = *ppos;
47 struct rpc_task *task;
48
49 spin_lock(&clnt->cl_lock);
50 list_for_each_entry(task, &clnt->cl_tasks, tk_task)
51 if (pos-- == 0)
52 return task;
53 return NULL;
54}
55
56static void *
57tasks_next(struct seq_file *f, void *v, loff_t *pos)
58{
59 struct rpc_clnt *clnt = f->private;
60 struct rpc_task *task = v;
61 struct list_head *next = task->tk_task.next;
62
63 ++*pos;
64
65 /* If there's another task on list, return it */
66 if (next == &clnt->cl_tasks)
67 return NULL;
68 return list_entry(next, struct rpc_task, tk_task);
69}
70
71static void
72tasks_stop(struct seq_file *f, void *v)
73 __releases(&clnt->cl_lock)
74{
75 struct rpc_clnt *clnt = f->private;
76 spin_unlock(&clnt->cl_lock);
77}
78
79static const struct seq_operations tasks_seq_operations = {
80 .start = tasks_start,
81 .next = tasks_next,
82 .stop = tasks_stop,
83 .show = tasks_show,
84};
85
86static int tasks_open(struct inode *inode, struct file *filp)
87{
88 int ret = seq_open(filp, &tasks_seq_operations);
89 if (!ret) {
90 struct seq_file *seq = filp->private_data;
91 struct rpc_clnt *clnt = seq->private = inode->i_private;
92
93 if (!refcount_inc_not_zero(&clnt->cl_count)) {
94 seq_release(inode, filp);
95 ret = -EINVAL;
96 }
97 }
98
99 return ret;
100}
101
102static int
103tasks_release(struct inode *inode, struct file *filp)
104{
105 struct seq_file *seq = filp->private_data;
106 struct rpc_clnt *clnt = seq->private;
107
108 rpc_release_client(clnt);
109 return seq_release(inode, filp);
110}
111
112static const struct file_operations tasks_fops = {
113 .owner = THIS_MODULE,
114 .open = tasks_open,
115 .read = seq_read,
116 .llseek = seq_lseek,
117 .release = tasks_release,
118};
119
120static int do_xprt_debugfs(struct rpc_clnt *clnt, struct rpc_xprt *xprt, void *numv)
121{
122 int len;
123 char name[24]; /* enough for "../../rpc_xprt/ + 8 hex digits + NULL */
124 char link[9]; /* enough for 8 hex digits + NULL */
125 int *nump = numv;
126
127 if (IS_ERR_OR_NULL(xprt->debugfs))
128 return 0;
129 len = snprintf(name, sizeof(name), "../../rpc_xprt/%s",
130 xprt->debugfs->d_name.name);
131 if (len >= sizeof(name))
132 return -1;
133 if (*nump == 0)
134 strcpy(link, "xprt");
135 else {
136 len = snprintf(link, sizeof(link), "xprt%d", *nump);
137 if (len >= sizeof(link))
138 return -1;
139 }
140 debugfs_create_symlink(link, clnt->cl_debugfs, name);
141 (*nump)++;
142 return 0;
143}
144
145void
146rpc_clnt_debugfs_register(struct rpc_clnt *clnt)
147{
148 int len;
149 char name[9]; /* enough for 8 hex digits + NULL */
150 int xprtnum = 0;
151
152 len = snprintf(name, sizeof(name), "%x", clnt->cl_clid);
153 if (len >= sizeof(name))
154 return;
155
156 /* make the per-client dir */
157 clnt->cl_debugfs = debugfs_create_dir(name, rpc_clnt_dir);
158
159 /* make tasks file */
160 debugfs_create_file("tasks", S_IFREG | 0400, clnt->cl_debugfs, clnt,
161 &tasks_fops);
162
163 rpc_clnt_iterate_for_each_xprt(clnt, do_xprt_debugfs, &xprtnum);
164}
165
166void
167rpc_clnt_debugfs_unregister(struct rpc_clnt *clnt)
168{
169 debugfs_remove_recursive(clnt->cl_debugfs);
170 clnt->cl_debugfs = NULL;
171}
172
173static int
174xprt_info_show(struct seq_file *f, void *v)
175{
176 struct rpc_xprt *xprt = f->private;
177
178 seq_printf(f, "netid: %s\n", xprt->address_strings[RPC_DISPLAY_NETID]);
179 seq_printf(f, "addr: %s\n", xprt->address_strings[RPC_DISPLAY_ADDR]);
180 seq_printf(f, "port: %s\n", xprt->address_strings[RPC_DISPLAY_PORT]);
181 seq_printf(f, "state: 0x%lx\n", xprt->state);
182 return 0;
183}
184
185static int
186xprt_info_open(struct inode *inode, struct file *filp)
187{
188 int ret;
189 struct rpc_xprt *xprt = inode->i_private;
190
191 ret = single_open(filp, xprt_info_show, xprt);
192
193 if (!ret) {
194 if (!xprt_get(xprt)) {
195 single_release(inode, filp);
196 ret = -EINVAL;
197 }
198 }
199 return ret;
200}
201
202static int
203xprt_info_release(struct inode *inode, struct file *filp)
204{
205 struct rpc_xprt *xprt = inode->i_private;
206
207 xprt_put(xprt);
208 return single_release(inode, filp);
209}
210
211static const struct file_operations xprt_info_fops = {
212 .owner = THIS_MODULE,
213 .open = xprt_info_open,
214 .read = seq_read,
215 .llseek = seq_lseek,
216 .release = xprt_info_release,
217};
218
219void
220rpc_xprt_debugfs_register(struct rpc_xprt *xprt)
221{
222 int len, id;
223 static atomic_t cur_id;
224 char name[9]; /* 8 hex digits + NULL term */
225
226 id = (unsigned int)atomic_inc_return(&cur_id);
227
228 len = snprintf(name, sizeof(name), "%x", id);
229 if (len >= sizeof(name))
230 return;
231
232 /* make the per-client dir */
233 xprt->debugfs = debugfs_create_dir(name, rpc_xprt_dir);
234
235 /* make tasks file */
236 debugfs_create_file("info", S_IFREG | 0400, xprt->debugfs, xprt,
237 &xprt_info_fops);
238}
239
240void
241rpc_xprt_debugfs_unregister(struct rpc_xprt *xprt)
242{
243 debugfs_remove_recursive(xprt->debugfs);
244 xprt->debugfs = NULL;
245}
246
247#if IS_ENABLED(CONFIG_FAIL_SUNRPC)
248struct fail_sunrpc_attr fail_sunrpc = {
249 .attr = FAULT_ATTR_INITIALIZER,
250};
251EXPORT_SYMBOL_GPL(fail_sunrpc);
252
253static void fail_sunrpc_init(void)
254{
255 struct dentry *dir;
256
257 dir = fault_create_debugfs_attr("fail_sunrpc", NULL,
258 &fail_sunrpc.attr);
259
260 debugfs_create_bool("ignore-client-disconnect", S_IFREG | 0600, dir,
261 &fail_sunrpc.ignore_client_disconnect);
262
263 debugfs_create_bool("ignore-server-disconnect", S_IFREG | 0600, dir,
264 &fail_sunrpc.ignore_server_disconnect);
265
266 debugfs_create_bool("ignore-cache-wait", S_IFREG | 0600, dir,
267 &fail_sunrpc.ignore_cache_wait);
268}
269#else
270static void fail_sunrpc_init(void)
271{
272}
273#endif
274
275void __exit
276sunrpc_debugfs_exit(void)
277{
278 debugfs_remove_recursive(topdir);
279 topdir = NULL;
280 rpc_clnt_dir = NULL;
281 rpc_xprt_dir = NULL;
282}
283
284void __init
285sunrpc_debugfs_init(void)
286{
287 topdir = debugfs_create_dir("sunrpc", NULL);
288
289 rpc_clnt_dir = debugfs_create_dir("rpc_clnt", topdir);
290
291 rpc_xprt_dir = debugfs_create_dir("rpc_xprt", topdir);
292
293 fail_sunrpc_init();
294}
1// SPDX-License-Identifier: GPL-2.0
2/**
3 * debugfs interface for sunrpc
4 *
5 * (c) 2014 Jeff Layton <jlayton@primarydata.com>
6 */
7
8#include <linux/debugfs.h>
9#include <linux/sunrpc/sched.h>
10#include <linux/sunrpc/clnt.h>
11#include "netns.h"
12
13static struct dentry *topdir;
14static struct dentry *rpc_fault_dir;
15static struct dentry *rpc_clnt_dir;
16static struct dentry *rpc_xprt_dir;
17
18unsigned int rpc_inject_disconnect;
19
20static int
21tasks_show(struct seq_file *f, void *v)
22{
23 u32 xid = 0;
24 struct rpc_task *task = v;
25 struct rpc_clnt *clnt = task->tk_client;
26 const char *rpc_waitq = "none";
27
28 if (RPC_IS_QUEUED(task))
29 rpc_waitq = rpc_qname(task->tk_waitqueue);
30
31 if (task->tk_rqstp)
32 xid = be32_to_cpu(task->tk_rqstp->rq_xid);
33
34 seq_printf(f, "%5u %04x %6d 0x%x 0x%x %8ld %ps %sv%u %s a:%ps q:%s\n",
35 task->tk_pid, task->tk_flags, task->tk_status,
36 clnt->cl_clid, xid, task->tk_timeout, task->tk_ops,
37 clnt->cl_program->name, clnt->cl_vers, rpc_proc_name(task),
38 task->tk_action, rpc_waitq);
39 return 0;
40}
41
42static void *
43tasks_start(struct seq_file *f, loff_t *ppos)
44 __acquires(&clnt->cl_lock)
45{
46 struct rpc_clnt *clnt = f->private;
47 loff_t pos = *ppos;
48 struct rpc_task *task;
49
50 spin_lock(&clnt->cl_lock);
51 list_for_each_entry(task, &clnt->cl_tasks, tk_task)
52 if (pos-- == 0)
53 return task;
54 return NULL;
55}
56
57static void *
58tasks_next(struct seq_file *f, void *v, loff_t *pos)
59{
60 struct rpc_clnt *clnt = f->private;
61 struct rpc_task *task = v;
62 struct list_head *next = task->tk_task.next;
63
64 ++*pos;
65
66 /* If there's another task on list, return it */
67 if (next == &clnt->cl_tasks)
68 return NULL;
69 return list_entry(next, struct rpc_task, tk_task);
70}
71
72static void
73tasks_stop(struct seq_file *f, void *v)
74 __releases(&clnt->cl_lock)
75{
76 struct rpc_clnt *clnt = f->private;
77 spin_unlock(&clnt->cl_lock);
78}
79
80static const struct seq_operations tasks_seq_operations = {
81 .start = tasks_start,
82 .next = tasks_next,
83 .stop = tasks_stop,
84 .show = tasks_show,
85};
86
87static int tasks_open(struct inode *inode, struct file *filp)
88{
89 int ret = seq_open(filp, &tasks_seq_operations);
90 if (!ret) {
91 struct seq_file *seq = filp->private_data;
92 struct rpc_clnt *clnt = seq->private = inode->i_private;
93
94 if (!atomic_inc_not_zero(&clnt->cl_count)) {
95 seq_release(inode, filp);
96 ret = -EINVAL;
97 }
98 }
99
100 return ret;
101}
102
103static int
104tasks_release(struct inode *inode, struct file *filp)
105{
106 struct seq_file *seq = filp->private_data;
107 struct rpc_clnt *clnt = seq->private;
108
109 rpc_release_client(clnt);
110 return seq_release(inode, filp);
111}
112
113static const struct file_operations tasks_fops = {
114 .owner = THIS_MODULE,
115 .open = tasks_open,
116 .read = seq_read,
117 .llseek = seq_lseek,
118 .release = tasks_release,
119};
120
121void
122rpc_clnt_debugfs_register(struct rpc_clnt *clnt)
123{
124 int len;
125 char name[24]; /* enough for "../../rpc_xprt/ + 8 hex digits + NULL */
126 struct rpc_xprt *xprt;
127
128 /* Already registered? */
129 if (clnt->cl_debugfs || !rpc_clnt_dir)
130 return;
131
132 len = snprintf(name, sizeof(name), "%x", clnt->cl_clid);
133 if (len >= sizeof(name))
134 return;
135
136 /* make the per-client dir */
137 clnt->cl_debugfs = debugfs_create_dir(name, rpc_clnt_dir);
138 if (!clnt->cl_debugfs)
139 return;
140
141 /* make tasks file */
142 if (!debugfs_create_file("tasks", S_IFREG | 0400, clnt->cl_debugfs,
143 clnt, &tasks_fops))
144 goto out_err;
145
146 rcu_read_lock();
147 xprt = rcu_dereference(clnt->cl_xprt);
148 /* no "debugfs" dentry? Don't bother with the symlink. */
149 if (!xprt->debugfs) {
150 rcu_read_unlock();
151 return;
152 }
153 len = snprintf(name, sizeof(name), "../../rpc_xprt/%s",
154 xprt->debugfs->d_name.name);
155 rcu_read_unlock();
156
157 if (len >= sizeof(name))
158 goto out_err;
159
160 if (!debugfs_create_symlink("xprt", clnt->cl_debugfs, name))
161 goto out_err;
162
163 return;
164out_err:
165 debugfs_remove_recursive(clnt->cl_debugfs);
166 clnt->cl_debugfs = NULL;
167}
168
169void
170rpc_clnt_debugfs_unregister(struct rpc_clnt *clnt)
171{
172 debugfs_remove_recursive(clnt->cl_debugfs);
173 clnt->cl_debugfs = NULL;
174}
175
176static int
177xprt_info_show(struct seq_file *f, void *v)
178{
179 struct rpc_xprt *xprt = f->private;
180
181 seq_printf(f, "netid: %s\n", xprt->address_strings[RPC_DISPLAY_NETID]);
182 seq_printf(f, "addr: %s\n", xprt->address_strings[RPC_DISPLAY_ADDR]);
183 seq_printf(f, "port: %s\n", xprt->address_strings[RPC_DISPLAY_PORT]);
184 seq_printf(f, "state: 0x%lx\n", xprt->state);
185 return 0;
186}
187
188static int
189xprt_info_open(struct inode *inode, struct file *filp)
190{
191 int ret;
192 struct rpc_xprt *xprt = inode->i_private;
193
194 ret = single_open(filp, xprt_info_show, xprt);
195
196 if (!ret) {
197 if (!xprt_get(xprt)) {
198 single_release(inode, filp);
199 ret = -EINVAL;
200 }
201 }
202 return ret;
203}
204
205static int
206xprt_info_release(struct inode *inode, struct file *filp)
207{
208 struct rpc_xprt *xprt = inode->i_private;
209
210 xprt_put(xprt);
211 return single_release(inode, filp);
212}
213
214static const struct file_operations xprt_info_fops = {
215 .owner = THIS_MODULE,
216 .open = xprt_info_open,
217 .read = seq_read,
218 .llseek = seq_lseek,
219 .release = xprt_info_release,
220};
221
222void
223rpc_xprt_debugfs_register(struct rpc_xprt *xprt)
224{
225 int len, id;
226 static atomic_t cur_id;
227 char name[9]; /* 8 hex digits + NULL term */
228
229 if (!rpc_xprt_dir)
230 return;
231
232 id = (unsigned int)atomic_inc_return(&cur_id);
233
234 len = snprintf(name, sizeof(name), "%x", id);
235 if (len >= sizeof(name))
236 return;
237
238 /* make the per-client dir */
239 xprt->debugfs = debugfs_create_dir(name, rpc_xprt_dir);
240 if (!xprt->debugfs)
241 return;
242
243 /* make tasks file */
244 if (!debugfs_create_file("info", S_IFREG | 0400, xprt->debugfs,
245 xprt, &xprt_info_fops)) {
246 debugfs_remove_recursive(xprt->debugfs);
247 xprt->debugfs = NULL;
248 }
249
250 atomic_set(&xprt->inject_disconnect, rpc_inject_disconnect);
251}
252
253void
254rpc_xprt_debugfs_unregister(struct rpc_xprt *xprt)
255{
256 debugfs_remove_recursive(xprt->debugfs);
257 xprt->debugfs = NULL;
258}
259
260static int
261fault_open(struct inode *inode, struct file *filp)
262{
263 filp->private_data = kmalloc(128, GFP_KERNEL);
264 if (!filp->private_data)
265 return -ENOMEM;
266 return 0;
267}
268
269static int
270fault_release(struct inode *inode, struct file *filp)
271{
272 kfree(filp->private_data);
273 return 0;
274}
275
276static ssize_t
277fault_disconnect_read(struct file *filp, char __user *user_buf,
278 size_t len, loff_t *offset)
279{
280 char *buffer = (char *)filp->private_data;
281 size_t size;
282
283 size = sprintf(buffer, "%u\n", rpc_inject_disconnect);
284 return simple_read_from_buffer(user_buf, len, offset, buffer, size);
285}
286
287static ssize_t
288fault_disconnect_write(struct file *filp, const char __user *user_buf,
289 size_t len, loff_t *offset)
290{
291 char buffer[16];
292
293 if (len >= sizeof(buffer))
294 len = sizeof(buffer) - 1;
295 if (copy_from_user(buffer, user_buf, len))
296 return -EFAULT;
297 buffer[len] = '\0';
298 if (kstrtouint(buffer, 10, &rpc_inject_disconnect))
299 return -EINVAL;
300 return len;
301}
302
303static const struct file_operations fault_disconnect_fops = {
304 .owner = THIS_MODULE,
305 .open = fault_open,
306 .read = fault_disconnect_read,
307 .write = fault_disconnect_write,
308 .release = fault_release,
309};
310
311static struct dentry *
312inject_fault_dir(struct dentry *topdir)
313{
314 struct dentry *faultdir;
315
316 faultdir = debugfs_create_dir("inject_fault", topdir);
317 if (!faultdir)
318 return NULL;
319
320 if (!debugfs_create_file("disconnect", S_IFREG | 0400, faultdir,
321 NULL, &fault_disconnect_fops))
322 return NULL;
323
324 return faultdir;
325}
326
327void __exit
328sunrpc_debugfs_exit(void)
329{
330 debugfs_remove_recursive(topdir);
331 topdir = NULL;
332 rpc_fault_dir = NULL;
333 rpc_clnt_dir = NULL;
334 rpc_xprt_dir = NULL;
335}
336
337void __init
338sunrpc_debugfs_init(void)
339{
340 topdir = debugfs_create_dir("sunrpc", NULL);
341 if (!topdir)
342 return;
343
344 rpc_fault_dir = inject_fault_dir(topdir);
345 if (!rpc_fault_dir)
346 goto out_remove;
347
348 rpc_clnt_dir = debugfs_create_dir("rpc_clnt", topdir);
349 if (!rpc_clnt_dir)
350 goto out_remove;
351
352 rpc_xprt_dir = debugfs_create_dir("rpc_xprt", topdir);
353 if (!rpc_xprt_dir)
354 goto out_remove;
355
356 return;
357out_remove:
358 debugfs_remove_recursive(topdir);
359 topdir = NULL;
360 rpc_fault_dir = NULL;
361 rpc_clnt_dir = NULL;
362}