1 // SPDX-License-Identifier: GPL-2.0
3 * Copyright (c) 2020 Anna Schumaker <Anna.Schumaker@Netapp.com>
5 #include <linux/sunrpc/clnt.h>
6 #include <linux/kobject.h>
7 #include <linux/sunrpc/addr.h>
8 #include <linux/sunrpc/xprtsock.h>
17 static void free_xprt_addr(struct rcu_head *head)
19 struct xprt_addr *addr = container_of(head, struct xprt_addr, rcu);
25 static struct kset *rpc_sunrpc_kset;
26 static struct kobject *rpc_sunrpc_client_kobj, *rpc_sunrpc_xprt_switch_kobj;
28 static void rpc_sysfs_object_release(struct kobject *kobj)
33 static const struct kobj_ns_type_operations *
34 rpc_sysfs_object_child_ns_type(struct kobject *kobj)
36 return &net_ns_type_operations;
39 static struct kobj_type rpc_sysfs_object_type = {
40 .release = rpc_sysfs_object_release,
41 .sysfs_ops = &kobj_sysfs_ops,
42 .child_ns_type = rpc_sysfs_object_child_ns_type,
45 static struct kobject *rpc_sysfs_object_alloc(const char *name,
47 struct kobject *parent)
51 kobj = kzalloc(sizeof(*kobj), GFP_KERNEL);
54 if (kobject_init_and_add(kobj, &rpc_sysfs_object_type,
55 parent, "%s", name) == 0)
62 static inline struct rpc_xprt *
63 rpc_sysfs_xprt_kobj_get_xprt(struct kobject *kobj)
65 struct rpc_sysfs_xprt *x = container_of(kobj,
66 struct rpc_sysfs_xprt, kobject);
68 return xprt_get(x->xprt);
71 static inline struct rpc_xprt_switch *
72 rpc_sysfs_xprt_kobj_get_xprt_switch(struct kobject *kobj)
74 struct rpc_sysfs_xprt *x = container_of(kobj,
75 struct rpc_sysfs_xprt, kobject);
77 return xprt_switch_get(x->xprt_switch);
80 static inline struct rpc_xprt_switch *
81 rpc_sysfs_xprt_switch_kobj_get_xprt(struct kobject *kobj)
83 struct rpc_sysfs_xprt_switch *x = container_of(kobj,
84 struct rpc_sysfs_xprt_switch, kobject);
86 return xprt_switch_get(x->xprt_switch);
89 static ssize_t rpc_sysfs_xprt_dstaddr_show(struct kobject *kobj,
90 struct kobj_attribute *attr,
93 struct rpc_xprt *xprt = rpc_sysfs_xprt_kobj_get_xprt(kobj);
98 ret = sprintf(buf, "%s\n", xprt->address_strings[RPC_DISPLAY_ADDR]);
103 static ssize_t rpc_sysfs_xprt_info_show(struct kobject *kobj,
104 struct kobj_attribute *attr,
107 struct rpc_xprt *xprt = rpc_sysfs_xprt_kobj_get_xprt(kobj);
113 ret = sprintf(buf, "last_used=%lu\ncur_cong=%lu\ncong_win=%lu\n"
114 "max_num_slots=%u\nmin_num_slots=%u\nnum_reqs=%u\n"
115 "binding_q_len=%u\nsending_q_len=%u\npending_q_len=%u\n"
116 "backlog_q_len=%u\nmain_xprt=%d\nsrc_port=%u\n"
117 "tasks_queuelen=%ld\n",
118 xprt->last_used, xprt->cong, xprt->cwnd, xprt->max_reqs,
119 xprt->min_reqs, xprt->num_reqs, xprt->binding.qlen,
120 xprt->sending.qlen, xprt->pending.qlen,
121 xprt->backlog.qlen, xprt->main,
122 (xprt->xprt_class->ident == XPRT_TRANSPORT_TCP) ?
123 get_srcport(xprt) : 0,
124 atomic_long_read(&xprt->queuelen));
129 static ssize_t rpc_sysfs_xprt_state_show(struct kobject *kobj,
130 struct kobj_attribute *attr,
133 struct rpc_xprt *xprt = rpc_sysfs_xprt_kobj_get_xprt(kobj);
135 int locked, connected, connecting, close_wait, bound, binding,
136 closing, congested, cwnd_wait, write_space, offline, remove;
142 ret = sprintf(buf, "state=CLOSED\n");
144 locked = test_bit(XPRT_LOCKED, &xprt->state);
145 connected = test_bit(XPRT_CONNECTED, &xprt->state);
146 connecting = test_bit(XPRT_CONNECTING, &xprt->state);
147 close_wait = test_bit(XPRT_CLOSE_WAIT, &xprt->state);
148 bound = test_bit(XPRT_BOUND, &xprt->state);
149 binding = test_bit(XPRT_BINDING, &xprt->state);
150 closing = test_bit(XPRT_CLOSING, &xprt->state);
151 congested = test_bit(XPRT_CONGESTED, &xprt->state);
152 cwnd_wait = test_bit(XPRT_CWND_WAIT, &xprt->state);
153 write_space = test_bit(XPRT_WRITE_SPACE, &xprt->state);
154 offline = test_bit(XPRT_OFFLINE, &xprt->state);
155 remove = test_bit(XPRT_REMOVE, &xprt->state);
157 ret = sprintf(buf, "state=%s %s %s %s %s %s %s %s %s %s %s %s\n",
158 locked ? "LOCKED" : "",
159 connected ? "CONNECTED" : "",
160 connecting ? "CONNECTING" : "",
161 close_wait ? "CLOSE_WAIT" : "",
162 bound ? "BOUND" : "",
163 binding ? "BOUNDING" : "",
164 closing ? "CLOSING" : "",
165 congested ? "CONGESTED" : "",
166 cwnd_wait ? "CWND_WAIT" : "",
167 write_space ? "WRITE_SPACE" : "",
168 offline ? "OFFLINE" : "",
169 remove ? "REMOVE" : "");
176 static ssize_t rpc_sysfs_xprt_switch_info_show(struct kobject *kobj,
177 struct kobj_attribute *attr,
180 struct rpc_xprt_switch *xprt_switch =
181 rpc_sysfs_xprt_switch_kobj_get_xprt(kobj);
186 ret = sprintf(buf, "num_xprts=%u\nnum_active=%u\nqueue_len=%ld\n",
187 xprt_switch->xps_nxprts, xprt_switch->xps_nactive,
188 atomic_long_read(&xprt_switch->xps_queuelen));
189 xprt_switch_put(xprt_switch);
193 static ssize_t rpc_sysfs_xprt_dstaddr_store(struct kobject *kobj,
194 struct kobj_attribute *attr,
195 const char *buf, size_t count)
197 struct rpc_xprt *xprt = rpc_sysfs_xprt_kobj_get_xprt(kobj);
198 struct sockaddr *saddr;
201 struct xprt_addr *saved_addr;
206 if (!(xprt->xprt_class->ident == XPRT_TRANSPORT_TCP ||
207 xprt->xprt_class->ident == XPRT_TRANSPORT_RDMA)) {
212 if (wait_on_bit_lock(&xprt->state, XPRT_LOCKED, TASK_KILLABLE)) {
216 saddr = (struct sockaddr *)&xprt->addr;
217 port = rpc_get_port(saddr);
219 /* buf_len is the len until the first occurence of either
222 buf_len = strcspn(buf, "\n");
224 dst_addr = kstrndup(buf, buf_len, GFP_KERNEL);
227 saved_addr = kzalloc(sizeof(*saved_addr), GFP_KERNEL);
231 rcu_dereference_raw(xprt->address_strings[RPC_DISPLAY_ADDR]);
232 rcu_assign_pointer(xprt->address_strings[RPC_DISPLAY_ADDR], dst_addr);
233 call_rcu(&saved_addr->rcu, free_xprt_addr);
234 xprt->addrlen = rpc_pton(xprt->xprt_net, buf, buf_len, saddr,
236 rpc_set_port(saddr, port);
238 xprt_force_disconnect(xprt);
240 xprt_release_write(xprt, NULL);
251 static ssize_t rpc_sysfs_xprt_state_change(struct kobject *kobj,
252 struct kobj_attribute *attr,
253 const char *buf, size_t count)
255 struct rpc_xprt *xprt = rpc_sysfs_xprt_kobj_get_xprt(kobj);
256 int offline = 0, online = 0, remove = 0;
257 struct rpc_xprt_switch *xps = rpc_sysfs_xprt_kobj_get_xprt_switch(kobj);
262 if (!strncmp(buf, "offline", 7))
264 else if (!strncmp(buf, "online", 6))
266 else if (!strncmp(buf, "remove", 6))
271 if (wait_on_bit_lock(&xprt->state, XPRT_LOCKED, TASK_KILLABLE)) {
280 set_bit(XPRT_OFFLINE, &xprt->state);
281 spin_lock(&xps->xps_lock);
283 spin_unlock(&xps->xps_lock);
285 clear_bit(XPRT_OFFLINE, &xprt->state);
286 spin_lock(&xps->xps_lock);
288 spin_unlock(&xps->xps_lock);
290 if (test_bit(XPRT_OFFLINE, &xprt->state)) {
291 set_bit(XPRT_REMOVE, &xprt->state);
292 xprt_force_disconnect(xprt);
293 if (test_bit(XPRT_CONNECTED, &xprt->state)) {
294 if (!xprt->sending.qlen &&
295 !xprt->pending.qlen &&
296 !xprt->backlog.qlen &&
297 !atomic_long_read(&xprt->queuelen))
298 rpc_xprt_switch_remove_xprt(xps, xprt);
306 xprt_release_write(xprt, NULL);
309 xprt_switch_put(xps);
313 int rpc_sysfs_init(void)
315 rpc_sunrpc_kset = kset_create_and_add("sunrpc", NULL, kernel_kobj);
316 if (!rpc_sunrpc_kset)
318 rpc_sunrpc_client_kobj =
319 rpc_sysfs_object_alloc("rpc-clients", rpc_sunrpc_kset, NULL);
320 if (!rpc_sunrpc_client_kobj)
322 rpc_sunrpc_xprt_switch_kobj =
323 rpc_sysfs_object_alloc("xprt-switches", rpc_sunrpc_kset, NULL);
324 if (!rpc_sunrpc_xprt_switch_kobj)
328 kobject_put(rpc_sunrpc_client_kobj);
329 rpc_sunrpc_client_kobj = NULL;
331 kset_unregister(rpc_sunrpc_kset);
332 rpc_sunrpc_kset = NULL;
336 static void rpc_sysfs_client_release(struct kobject *kobj)
338 struct rpc_sysfs_client *c;
340 c = container_of(kobj, struct rpc_sysfs_client, kobject);
344 static void rpc_sysfs_xprt_switch_release(struct kobject *kobj)
346 struct rpc_sysfs_xprt_switch *xprt_switch;
348 xprt_switch = container_of(kobj, struct rpc_sysfs_xprt_switch, kobject);
352 static void rpc_sysfs_xprt_release(struct kobject *kobj)
354 struct rpc_sysfs_xprt *xprt;
356 xprt = container_of(kobj, struct rpc_sysfs_xprt, kobject);
360 static const void *rpc_sysfs_client_namespace(struct kobject *kobj)
362 return container_of(kobj, struct rpc_sysfs_client, kobject)->net;
365 static const void *rpc_sysfs_xprt_switch_namespace(struct kobject *kobj)
367 return container_of(kobj, struct rpc_sysfs_xprt_switch, kobject)->net;
370 static const void *rpc_sysfs_xprt_namespace(struct kobject *kobj)
372 return container_of(kobj, struct rpc_sysfs_xprt,
373 kobject)->xprt->xprt_net;
376 static struct kobj_attribute rpc_sysfs_xprt_dstaddr = __ATTR(dstaddr,
377 0644, rpc_sysfs_xprt_dstaddr_show, rpc_sysfs_xprt_dstaddr_store);
379 static struct kobj_attribute rpc_sysfs_xprt_info = __ATTR(xprt_info,
380 0444, rpc_sysfs_xprt_info_show, NULL);
382 static struct kobj_attribute rpc_sysfs_xprt_change_state = __ATTR(xprt_state,
383 0644, rpc_sysfs_xprt_state_show, rpc_sysfs_xprt_state_change);
385 static struct attribute *rpc_sysfs_xprt_attrs[] = {
386 &rpc_sysfs_xprt_dstaddr.attr,
387 &rpc_sysfs_xprt_info.attr,
388 &rpc_sysfs_xprt_change_state.attr,
392 static struct kobj_attribute rpc_sysfs_xprt_switch_info =
393 __ATTR(xprt_switch_info, 0444, rpc_sysfs_xprt_switch_info_show, NULL);
395 static struct attribute *rpc_sysfs_xprt_switch_attrs[] = {
396 &rpc_sysfs_xprt_switch_info.attr,
400 static struct kobj_type rpc_sysfs_client_type = {
401 .release = rpc_sysfs_client_release,
402 .sysfs_ops = &kobj_sysfs_ops,
403 .namespace = rpc_sysfs_client_namespace,
406 static struct kobj_type rpc_sysfs_xprt_switch_type = {
407 .release = rpc_sysfs_xprt_switch_release,
408 .default_attrs = rpc_sysfs_xprt_switch_attrs,
409 .sysfs_ops = &kobj_sysfs_ops,
410 .namespace = rpc_sysfs_xprt_switch_namespace,
413 static struct kobj_type rpc_sysfs_xprt_type = {
414 .release = rpc_sysfs_xprt_release,
415 .default_attrs = rpc_sysfs_xprt_attrs,
416 .sysfs_ops = &kobj_sysfs_ops,
417 .namespace = rpc_sysfs_xprt_namespace,
420 void rpc_sysfs_exit(void)
422 kobject_put(rpc_sunrpc_client_kobj);
423 kobject_put(rpc_sunrpc_xprt_switch_kobj);
424 kset_unregister(rpc_sunrpc_kset);
427 static struct rpc_sysfs_client *rpc_sysfs_client_alloc(struct kobject *parent,
431 struct rpc_sysfs_client *p;
433 p = kzalloc(sizeof(*p), GFP_KERNEL);
436 p->kobject.kset = rpc_sunrpc_kset;
437 if (kobject_init_and_add(&p->kobject, &rpc_sysfs_client_type,
438 parent, "clnt-%d", clid) == 0)
440 kobject_put(&p->kobject);
445 static struct rpc_sysfs_xprt_switch *
446 rpc_sysfs_xprt_switch_alloc(struct kobject *parent,
447 struct rpc_xprt_switch *xprt_switch,
451 struct rpc_sysfs_xprt_switch *p;
453 p = kzalloc(sizeof(*p), gfp_flags);
456 p->kobject.kset = rpc_sunrpc_kset;
457 if (kobject_init_and_add(&p->kobject,
458 &rpc_sysfs_xprt_switch_type,
460 xprt_switch->xps_id) == 0)
462 kobject_put(&p->kobject);
467 static struct rpc_sysfs_xprt *rpc_sysfs_xprt_alloc(struct kobject *parent,
468 struct rpc_xprt *xprt,
471 struct rpc_sysfs_xprt *p;
473 p = kzalloc(sizeof(*p), gfp_flags);
476 p->kobject.kset = rpc_sunrpc_kset;
477 if (kobject_init_and_add(&p->kobject, &rpc_sysfs_xprt_type,
478 parent, "xprt-%d-%s", xprt->id,
479 xprt->address_strings[RPC_DISPLAY_PROTO]) == 0)
481 kobject_put(&p->kobject);
486 void rpc_sysfs_client_setup(struct rpc_clnt *clnt,
487 struct rpc_xprt_switch *xprt_switch,
490 struct rpc_sysfs_client *rpc_client;
492 rpc_client = rpc_sysfs_client_alloc(rpc_sunrpc_client_kobj,
495 char name[] = "switch";
496 struct rpc_sysfs_xprt_switch *xswitch =
497 (struct rpc_sysfs_xprt_switch *)xprt_switch->xps_sysfs;
500 clnt->cl_sysfs = rpc_client;
501 rpc_client->clnt = clnt;
502 rpc_client->xprt_switch = xprt_switch;
503 kobject_uevent(&rpc_client->kobject, KOBJ_ADD);
504 ret = sysfs_create_link_nowarn(&rpc_client->kobject,
505 &xswitch->kobject, name);
507 pr_warn("can't create link to %s in sysfs (%d)\n",
512 void rpc_sysfs_xprt_switch_setup(struct rpc_xprt_switch *xprt_switch,
513 struct rpc_xprt *xprt,
516 struct rpc_sysfs_xprt_switch *rpc_xprt_switch;
519 if (xprt_switch->xps_net)
520 net = xprt_switch->xps_net;
522 net = xprt->xprt_net;
524 rpc_sysfs_xprt_switch_alloc(rpc_sunrpc_xprt_switch_kobj,
525 xprt_switch, net, gfp_flags);
526 if (rpc_xprt_switch) {
527 xprt_switch->xps_sysfs = rpc_xprt_switch;
528 rpc_xprt_switch->xprt_switch = xprt_switch;
529 rpc_xprt_switch->xprt = xprt;
530 kobject_uevent(&rpc_xprt_switch->kobject, KOBJ_ADD);
534 void rpc_sysfs_xprt_setup(struct rpc_xprt_switch *xprt_switch,
535 struct rpc_xprt *xprt,
538 struct rpc_sysfs_xprt *rpc_xprt;
539 struct rpc_sysfs_xprt_switch *switch_obj =
540 (struct rpc_sysfs_xprt_switch *)xprt_switch->xps_sysfs;
542 rpc_xprt = rpc_sysfs_xprt_alloc(&switch_obj->kobject, xprt, gfp_flags);
544 xprt->xprt_sysfs = rpc_xprt;
545 rpc_xprt->xprt = xprt;
546 rpc_xprt->xprt_switch = xprt_switch;
547 kobject_uevent(&rpc_xprt->kobject, KOBJ_ADD);
551 void rpc_sysfs_client_destroy(struct rpc_clnt *clnt)
553 struct rpc_sysfs_client *rpc_client = clnt->cl_sysfs;
556 char name[] = "switch";
558 sysfs_remove_link(&rpc_client->kobject, name);
559 kobject_uevent(&rpc_client->kobject, KOBJ_REMOVE);
560 kobject_del(&rpc_client->kobject);
561 kobject_put(&rpc_client->kobject);
562 clnt->cl_sysfs = NULL;
566 void rpc_sysfs_xprt_switch_destroy(struct rpc_xprt_switch *xprt_switch)
568 struct rpc_sysfs_xprt_switch *rpc_xprt_switch = xprt_switch->xps_sysfs;
570 if (rpc_xprt_switch) {
571 kobject_uevent(&rpc_xprt_switch->kobject, KOBJ_REMOVE);
572 kobject_del(&rpc_xprt_switch->kobject);
573 kobject_put(&rpc_xprt_switch->kobject);
574 xprt_switch->xps_sysfs = NULL;
578 void rpc_sysfs_xprt_destroy(struct rpc_xprt *xprt)
580 struct rpc_sysfs_xprt *rpc_xprt = xprt->xprt_sysfs;
583 kobject_uevent(&rpc_xprt->kobject, KOBJ_REMOVE);
584 kobject_del(&rpc_xprt->kobject);
585 kobject_put(&rpc_xprt->kobject);
586 xprt->xprt_sysfs = NULL;