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_srcaddr_show(struct kobject *kobj,
104 struct kobj_attribute *attr,
107 struct rpc_xprt *xprt = rpc_sysfs_xprt_kobj_get_xprt(kobj);
108 struct sockaddr_storage saddr;
109 struct sock_xprt *sock;
112 if (!xprt || !xprt_connected(xprt)) {
117 sock = container_of(xprt, struct sock_xprt, xprt);
118 mutex_lock(&sock->recv_mutex);
119 if (sock->sock == NULL ||
120 kernel_getsockname(sock->sock, (struct sockaddr *)&saddr) < 0)
123 ret = sprintf(buf, "%pISc\n", &saddr);
125 mutex_unlock(&sock->recv_mutex);
130 static ssize_t rpc_sysfs_xprt_info_show(struct kobject *kobj,
131 struct kobj_attribute *attr,
134 struct rpc_xprt *xprt = rpc_sysfs_xprt_kobj_get_xprt(kobj);
137 if (!xprt || !xprt_connected(xprt)) {
142 ret = sprintf(buf, "last_used=%lu\ncur_cong=%lu\ncong_win=%lu\n"
143 "max_num_slots=%u\nmin_num_slots=%u\nnum_reqs=%u\n"
144 "binding_q_len=%u\nsending_q_len=%u\npending_q_len=%u\n"
145 "backlog_q_len=%u\nmain_xprt=%d\nsrc_port=%u\n"
146 "tasks_queuelen=%ld\ndst_port=%s\n",
147 xprt->last_used, xprt->cong, xprt->cwnd, xprt->max_reqs,
148 xprt->min_reqs, xprt->num_reqs, xprt->binding.qlen,
149 xprt->sending.qlen, xprt->pending.qlen,
150 xprt->backlog.qlen, xprt->main,
151 (xprt->xprt_class->ident == XPRT_TRANSPORT_TCP) ?
152 get_srcport(xprt) : 0,
153 atomic_long_read(&xprt->queuelen),
154 (xprt->xprt_class->ident == XPRT_TRANSPORT_TCP) ?
155 xprt->address_strings[RPC_DISPLAY_PORT] : "0");
160 static ssize_t rpc_sysfs_xprt_state_show(struct kobject *kobj,
161 struct kobj_attribute *attr,
164 struct rpc_xprt *xprt = rpc_sysfs_xprt_kobj_get_xprt(kobj);
166 int locked, connected, connecting, close_wait, bound, binding,
167 closing, congested, cwnd_wait, write_space, offline, remove;
173 ret = sprintf(buf, "state=CLOSED\n");
175 locked = test_bit(XPRT_LOCKED, &xprt->state);
176 connected = test_bit(XPRT_CONNECTED, &xprt->state);
177 connecting = test_bit(XPRT_CONNECTING, &xprt->state);
178 close_wait = test_bit(XPRT_CLOSE_WAIT, &xprt->state);
179 bound = test_bit(XPRT_BOUND, &xprt->state);
180 binding = test_bit(XPRT_BINDING, &xprt->state);
181 closing = test_bit(XPRT_CLOSING, &xprt->state);
182 congested = test_bit(XPRT_CONGESTED, &xprt->state);
183 cwnd_wait = test_bit(XPRT_CWND_WAIT, &xprt->state);
184 write_space = test_bit(XPRT_WRITE_SPACE, &xprt->state);
185 offline = test_bit(XPRT_OFFLINE, &xprt->state);
186 remove = test_bit(XPRT_REMOVE, &xprt->state);
188 ret = sprintf(buf, "state=%s %s %s %s %s %s %s %s %s %s %s %s\n",
189 locked ? "LOCKED" : "",
190 connected ? "CONNECTED" : "",
191 connecting ? "CONNECTING" : "",
192 close_wait ? "CLOSE_WAIT" : "",
193 bound ? "BOUND" : "",
194 binding ? "BOUNDING" : "",
195 closing ? "CLOSING" : "",
196 congested ? "CONGESTED" : "",
197 cwnd_wait ? "CWND_WAIT" : "",
198 write_space ? "WRITE_SPACE" : "",
199 offline ? "OFFLINE" : "",
200 remove ? "REMOVE" : "");
207 static ssize_t rpc_sysfs_xprt_switch_info_show(struct kobject *kobj,
208 struct kobj_attribute *attr,
211 struct rpc_xprt_switch *xprt_switch =
212 rpc_sysfs_xprt_switch_kobj_get_xprt(kobj);
217 ret = sprintf(buf, "num_xprts=%u\nnum_active=%u\n"
218 "num_unique_destaddr=%u\nqueue_len=%ld\n",
219 xprt_switch->xps_nxprts, xprt_switch->xps_nactive,
220 xprt_switch->xps_nunique_destaddr_xprts,
221 atomic_long_read(&xprt_switch->xps_queuelen));
222 xprt_switch_put(xprt_switch);
226 static ssize_t rpc_sysfs_xprt_dstaddr_store(struct kobject *kobj,
227 struct kobj_attribute *attr,
228 const char *buf, size_t count)
230 struct rpc_xprt *xprt = rpc_sysfs_xprt_kobj_get_xprt(kobj);
231 struct sockaddr *saddr;
234 struct xprt_addr *saved_addr;
239 if (!(xprt->xprt_class->ident == XPRT_TRANSPORT_TCP ||
240 xprt->xprt_class->ident == XPRT_TRANSPORT_RDMA)) {
245 if (wait_on_bit_lock(&xprt->state, XPRT_LOCKED, TASK_KILLABLE)) {
249 saddr = (struct sockaddr *)&xprt->addr;
250 port = rpc_get_port(saddr);
252 /* buf_len is the len until the first occurence of either
255 buf_len = strcspn(buf, "\n");
257 dst_addr = kstrndup(buf, buf_len, GFP_KERNEL);
260 saved_addr = kzalloc(sizeof(*saved_addr), GFP_KERNEL);
264 rcu_dereference_raw(xprt->address_strings[RPC_DISPLAY_ADDR]);
265 rcu_assign_pointer(xprt->address_strings[RPC_DISPLAY_ADDR], dst_addr);
266 call_rcu(&saved_addr->rcu, free_xprt_addr);
267 xprt->addrlen = rpc_pton(xprt->xprt_net, buf, buf_len, saddr,
269 rpc_set_port(saddr, port);
271 xprt_force_disconnect(xprt);
273 xprt_release_write(xprt, NULL);
284 static ssize_t rpc_sysfs_xprt_state_change(struct kobject *kobj,
285 struct kobj_attribute *attr,
286 const char *buf, size_t count)
288 struct rpc_xprt *xprt = rpc_sysfs_xprt_kobj_get_xprt(kobj);
289 int offline = 0, online = 0, remove = 0;
290 struct rpc_xprt_switch *xps = rpc_sysfs_xprt_kobj_get_xprt_switch(kobj);
295 if (!strncmp(buf, "offline", 7))
297 else if (!strncmp(buf, "online", 6))
299 else if (!strncmp(buf, "remove", 6))
306 if (wait_on_bit_lock(&xprt->state, XPRT_LOCKED, TASK_KILLABLE)) {
315 if (!test_and_set_bit(XPRT_OFFLINE, &xprt->state)) {
316 spin_lock(&xps->xps_lock);
318 spin_unlock(&xps->xps_lock);
321 if (test_and_clear_bit(XPRT_OFFLINE, &xprt->state)) {
322 spin_lock(&xps->xps_lock);
324 spin_unlock(&xps->xps_lock);
327 if (test_bit(XPRT_OFFLINE, &xprt->state)) {
328 if (!test_and_set_bit(XPRT_REMOVE, &xprt->state)) {
329 xprt_force_disconnect(xprt);
330 if (test_bit(XPRT_CONNECTED, &xprt->state)) {
331 if (!xprt->sending.qlen &&
332 !xprt->pending.qlen &&
333 !xprt->backlog.qlen &&
334 !atomic_long_read(&xprt->queuelen))
335 rpc_xprt_switch_remove_xprt(xps, xprt);
344 xprt_release_write(xprt, NULL);
347 xprt_switch_put(xps);
351 int rpc_sysfs_init(void)
353 rpc_sunrpc_kset = kset_create_and_add("sunrpc", NULL, kernel_kobj);
354 if (!rpc_sunrpc_kset)
356 rpc_sunrpc_client_kobj =
357 rpc_sysfs_object_alloc("rpc-clients", rpc_sunrpc_kset, NULL);
358 if (!rpc_sunrpc_client_kobj)
360 rpc_sunrpc_xprt_switch_kobj =
361 rpc_sysfs_object_alloc("xprt-switches", rpc_sunrpc_kset, NULL);
362 if (!rpc_sunrpc_xprt_switch_kobj)
366 kobject_put(rpc_sunrpc_client_kobj);
367 rpc_sunrpc_client_kobj = NULL;
369 kset_unregister(rpc_sunrpc_kset);
370 rpc_sunrpc_kset = NULL;
374 static void rpc_sysfs_client_release(struct kobject *kobj)
376 struct rpc_sysfs_client *c;
378 c = container_of(kobj, struct rpc_sysfs_client, kobject);
382 static void rpc_sysfs_xprt_switch_release(struct kobject *kobj)
384 struct rpc_sysfs_xprt_switch *xprt_switch;
386 xprt_switch = container_of(kobj, struct rpc_sysfs_xprt_switch, kobject);
390 static void rpc_sysfs_xprt_release(struct kobject *kobj)
392 struct rpc_sysfs_xprt *xprt;
394 xprt = container_of(kobj, struct rpc_sysfs_xprt, kobject);
398 static const void *rpc_sysfs_client_namespace(struct kobject *kobj)
400 return container_of(kobj, struct rpc_sysfs_client, kobject)->net;
403 static const void *rpc_sysfs_xprt_switch_namespace(struct kobject *kobj)
405 return container_of(kobj, struct rpc_sysfs_xprt_switch, kobject)->net;
408 static const void *rpc_sysfs_xprt_namespace(struct kobject *kobj)
410 return container_of(kobj, struct rpc_sysfs_xprt,
411 kobject)->xprt->xprt_net;
414 static struct kobj_attribute rpc_sysfs_xprt_dstaddr = __ATTR(dstaddr,
415 0644, rpc_sysfs_xprt_dstaddr_show, rpc_sysfs_xprt_dstaddr_store);
417 static struct kobj_attribute rpc_sysfs_xprt_srcaddr = __ATTR(srcaddr,
418 0644, rpc_sysfs_xprt_srcaddr_show, NULL);
420 static struct kobj_attribute rpc_sysfs_xprt_info = __ATTR(xprt_info,
421 0444, rpc_sysfs_xprt_info_show, NULL);
423 static struct kobj_attribute rpc_sysfs_xprt_change_state = __ATTR(xprt_state,
424 0644, rpc_sysfs_xprt_state_show, rpc_sysfs_xprt_state_change);
426 static struct attribute *rpc_sysfs_xprt_attrs[] = {
427 &rpc_sysfs_xprt_dstaddr.attr,
428 &rpc_sysfs_xprt_srcaddr.attr,
429 &rpc_sysfs_xprt_info.attr,
430 &rpc_sysfs_xprt_change_state.attr,
433 ATTRIBUTE_GROUPS(rpc_sysfs_xprt);
435 static struct kobj_attribute rpc_sysfs_xprt_switch_info =
436 __ATTR(xprt_switch_info, 0444, rpc_sysfs_xprt_switch_info_show, NULL);
438 static struct attribute *rpc_sysfs_xprt_switch_attrs[] = {
439 &rpc_sysfs_xprt_switch_info.attr,
442 ATTRIBUTE_GROUPS(rpc_sysfs_xprt_switch);
444 static struct kobj_type rpc_sysfs_client_type = {
445 .release = rpc_sysfs_client_release,
446 .sysfs_ops = &kobj_sysfs_ops,
447 .namespace = rpc_sysfs_client_namespace,
450 static struct kobj_type rpc_sysfs_xprt_switch_type = {
451 .release = rpc_sysfs_xprt_switch_release,
452 .default_groups = rpc_sysfs_xprt_switch_groups,
453 .sysfs_ops = &kobj_sysfs_ops,
454 .namespace = rpc_sysfs_xprt_switch_namespace,
457 static struct kobj_type rpc_sysfs_xprt_type = {
458 .release = rpc_sysfs_xprt_release,
459 .default_groups = rpc_sysfs_xprt_groups,
460 .sysfs_ops = &kobj_sysfs_ops,
461 .namespace = rpc_sysfs_xprt_namespace,
464 void rpc_sysfs_exit(void)
466 kobject_put(rpc_sunrpc_client_kobj);
467 kobject_put(rpc_sunrpc_xprt_switch_kobj);
468 kset_unregister(rpc_sunrpc_kset);
471 static struct rpc_sysfs_client *rpc_sysfs_client_alloc(struct kobject *parent,
475 struct rpc_sysfs_client *p;
477 p = kzalloc(sizeof(*p), GFP_KERNEL);
480 p->kobject.kset = rpc_sunrpc_kset;
481 if (kobject_init_and_add(&p->kobject, &rpc_sysfs_client_type,
482 parent, "clnt-%d", clid) == 0)
484 kobject_put(&p->kobject);
489 static struct rpc_sysfs_xprt_switch *
490 rpc_sysfs_xprt_switch_alloc(struct kobject *parent,
491 struct rpc_xprt_switch *xprt_switch,
495 struct rpc_sysfs_xprt_switch *p;
497 p = kzalloc(sizeof(*p), gfp_flags);
500 p->kobject.kset = rpc_sunrpc_kset;
501 if (kobject_init_and_add(&p->kobject,
502 &rpc_sysfs_xprt_switch_type,
504 xprt_switch->xps_id) == 0)
506 kobject_put(&p->kobject);
511 static struct rpc_sysfs_xprt *rpc_sysfs_xprt_alloc(struct kobject *parent,
512 struct rpc_xprt *xprt,
515 struct rpc_sysfs_xprt *p;
517 p = kzalloc(sizeof(*p), gfp_flags);
520 p->kobject.kset = rpc_sunrpc_kset;
521 if (kobject_init_and_add(&p->kobject, &rpc_sysfs_xprt_type,
522 parent, "xprt-%d-%s", xprt->id,
523 xprt->address_strings[RPC_DISPLAY_PROTO]) == 0)
525 kobject_put(&p->kobject);
530 void rpc_sysfs_client_setup(struct rpc_clnt *clnt,
531 struct rpc_xprt_switch *xprt_switch,
534 struct rpc_sysfs_client *rpc_client;
536 rpc_client = rpc_sysfs_client_alloc(rpc_sunrpc_client_kobj,
539 char name[] = "switch";
540 struct rpc_sysfs_xprt_switch *xswitch =
541 (struct rpc_sysfs_xprt_switch *)xprt_switch->xps_sysfs;
544 clnt->cl_sysfs = rpc_client;
545 rpc_client->clnt = clnt;
546 rpc_client->xprt_switch = xprt_switch;
547 kobject_uevent(&rpc_client->kobject, KOBJ_ADD);
548 ret = sysfs_create_link_nowarn(&rpc_client->kobject,
549 &xswitch->kobject, name);
551 pr_warn("can't create link to %s in sysfs (%d)\n",
556 void rpc_sysfs_xprt_switch_setup(struct rpc_xprt_switch *xprt_switch,
557 struct rpc_xprt *xprt,
560 struct rpc_sysfs_xprt_switch *rpc_xprt_switch;
563 if (xprt_switch->xps_net)
564 net = xprt_switch->xps_net;
566 net = xprt->xprt_net;
568 rpc_sysfs_xprt_switch_alloc(rpc_sunrpc_xprt_switch_kobj,
569 xprt_switch, net, gfp_flags);
570 if (rpc_xprt_switch) {
571 xprt_switch->xps_sysfs = rpc_xprt_switch;
572 rpc_xprt_switch->xprt_switch = xprt_switch;
573 rpc_xprt_switch->xprt = xprt;
574 kobject_uevent(&rpc_xprt_switch->kobject, KOBJ_ADD);
578 void rpc_sysfs_xprt_setup(struct rpc_xprt_switch *xprt_switch,
579 struct rpc_xprt *xprt,
582 struct rpc_sysfs_xprt *rpc_xprt;
583 struct rpc_sysfs_xprt_switch *switch_obj =
584 (struct rpc_sysfs_xprt_switch *)xprt_switch->xps_sysfs;
586 rpc_xprt = rpc_sysfs_xprt_alloc(&switch_obj->kobject, xprt, gfp_flags);
588 xprt->xprt_sysfs = rpc_xprt;
589 rpc_xprt->xprt = xprt;
590 rpc_xprt->xprt_switch = xprt_switch;
591 kobject_uevent(&rpc_xprt->kobject, KOBJ_ADD);
595 void rpc_sysfs_client_destroy(struct rpc_clnt *clnt)
597 struct rpc_sysfs_client *rpc_client = clnt->cl_sysfs;
600 char name[] = "switch";
602 sysfs_remove_link(&rpc_client->kobject, name);
603 kobject_uevent(&rpc_client->kobject, KOBJ_REMOVE);
604 kobject_del(&rpc_client->kobject);
605 kobject_put(&rpc_client->kobject);
606 clnt->cl_sysfs = NULL;
610 void rpc_sysfs_xprt_switch_destroy(struct rpc_xprt_switch *xprt_switch)
612 struct rpc_sysfs_xprt_switch *rpc_xprt_switch = xprt_switch->xps_sysfs;
614 if (rpc_xprt_switch) {
615 kobject_uevent(&rpc_xprt_switch->kobject, KOBJ_REMOVE);
616 kobject_del(&rpc_xprt_switch->kobject);
617 kobject_put(&rpc_xprt_switch->kobject);
618 xprt_switch->xps_sysfs = NULL;
622 void rpc_sysfs_xprt_destroy(struct rpc_xprt *xprt)
624 struct rpc_sysfs_xprt *rpc_xprt = xprt->xprt_sysfs;
627 kobject_uevent(&rpc_xprt->kobject, KOBJ_REMOVE);
628 kobject_del(&rpc_xprt->kobject);
629 kobject_put(&rpc_xprt->kobject);
630 xprt->xprt_sysfs = NULL;