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 if (kernel_getsockname(sock->sock, (struct sockaddr *)&saddr) < 0)
121 ret = sprintf(buf, "%pISc\n", &saddr);
127 static ssize_t rpc_sysfs_xprt_info_show(struct kobject *kobj,
128 struct kobj_attribute *attr,
131 struct rpc_xprt *xprt = rpc_sysfs_xprt_kobj_get_xprt(kobj);
134 if (!xprt || !xprt_connected(xprt)) {
139 ret = sprintf(buf, "last_used=%lu\ncur_cong=%lu\ncong_win=%lu\n"
140 "max_num_slots=%u\nmin_num_slots=%u\nnum_reqs=%u\n"
141 "binding_q_len=%u\nsending_q_len=%u\npending_q_len=%u\n"
142 "backlog_q_len=%u\nmain_xprt=%d\nsrc_port=%u\n"
143 "tasks_queuelen=%ld\ndst_port=%s\n",
144 xprt->last_used, xprt->cong, xprt->cwnd, xprt->max_reqs,
145 xprt->min_reqs, xprt->num_reqs, xprt->binding.qlen,
146 xprt->sending.qlen, xprt->pending.qlen,
147 xprt->backlog.qlen, xprt->main,
148 (xprt->xprt_class->ident == XPRT_TRANSPORT_TCP) ?
149 get_srcport(xprt) : 0,
150 atomic_long_read(&xprt->queuelen),
151 (xprt->xprt_class->ident == XPRT_TRANSPORT_TCP) ?
152 xprt->address_strings[RPC_DISPLAY_PORT] : "0");
157 static ssize_t rpc_sysfs_xprt_state_show(struct kobject *kobj,
158 struct kobj_attribute *attr,
161 struct rpc_xprt *xprt = rpc_sysfs_xprt_kobj_get_xprt(kobj);
163 int locked, connected, connecting, close_wait, bound, binding,
164 closing, congested, cwnd_wait, write_space, offline, remove;
170 ret = sprintf(buf, "state=CLOSED\n");
172 locked = test_bit(XPRT_LOCKED, &xprt->state);
173 connected = test_bit(XPRT_CONNECTED, &xprt->state);
174 connecting = test_bit(XPRT_CONNECTING, &xprt->state);
175 close_wait = test_bit(XPRT_CLOSE_WAIT, &xprt->state);
176 bound = test_bit(XPRT_BOUND, &xprt->state);
177 binding = test_bit(XPRT_BINDING, &xprt->state);
178 closing = test_bit(XPRT_CLOSING, &xprt->state);
179 congested = test_bit(XPRT_CONGESTED, &xprt->state);
180 cwnd_wait = test_bit(XPRT_CWND_WAIT, &xprt->state);
181 write_space = test_bit(XPRT_WRITE_SPACE, &xprt->state);
182 offline = test_bit(XPRT_OFFLINE, &xprt->state);
183 remove = test_bit(XPRT_REMOVE, &xprt->state);
185 ret = sprintf(buf, "state=%s %s %s %s %s %s %s %s %s %s %s %s\n",
186 locked ? "LOCKED" : "",
187 connected ? "CONNECTED" : "",
188 connecting ? "CONNECTING" : "",
189 close_wait ? "CLOSE_WAIT" : "",
190 bound ? "BOUND" : "",
191 binding ? "BOUNDING" : "",
192 closing ? "CLOSING" : "",
193 congested ? "CONGESTED" : "",
194 cwnd_wait ? "CWND_WAIT" : "",
195 write_space ? "WRITE_SPACE" : "",
196 offline ? "OFFLINE" : "",
197 remove ? "REMOVE" : "");
204 static ssize_t rpc_sysfs_xprt_switch_info_show(struct kobject *kobj,
205 struct kobj_attribute *attr,
208 struct rpc_xprt_switch *xprt_switch =
209 rpc_sysfs_xprt_switch_kobj_get_xprt(kobj);
214 ret = sprintf(buf, "num_xprts=%u\nnum_active=%u\n"
215 "num_unique_destaddr=%u\nqueue_len=%ld\n",
216 xprt_switch->xps_nxprts, xprt_switch->xps_nactive,
217 xprt_switch->xps_nunique_destaddr_xprts,
218 atomic_long_read(&xprt_switch->xps_queuelen));
219 xprt_switch_put(xprt_switch);
223 static ssize_t rpc_sysfs_xprt_dstaddr_store(struct kobject *kobj,
224 struct kobj_attribute *attr,
225 const char *buf, size_t count)
227 struct rpc_xprt *xprt = rpc_sysfs_xprt_kobj_get_xprt(kobj);
228 struct sockaddr *saddr;
231 struct xprt_addr *saved_addr;
236 if (!(xprt->xprt_class->ident == XPRT_TRANSPORT_TCP ||
237 xprt->xprt_class->ident == XPRT_TRANSPORT_RDMA)) {
242 if (wait_on_bit_lock(&xprt->state, XPRT_LOCKED, TASK_KILLABLE)) {
246 saddr = (struct sockaddr *)&xprt->addr;
247 port = rpc_get_port(saddr);
249 /* buf_len is the len until the first occurence of either
252 buf_len = strcspn(buf, "\n");
254 dst_addr = kstrndup(buf, buf_len, GFP_KERNEL);
257 saved_addr = kzalloc(sizeof(*saved_addr), GFP_KERNEL);
261 rcu_dereference_raw(xprt->address_strings[RPC_DISPLAY_ADDR]);
262 rcu_assign_pointer(xprt->address_strings[RPC_DISPLAY_ADDR], dst_addr);
263 call_rcu(&saved_addr->rcu, free_xprt_addr);
264 xprt->addrlen = rpc_pton(xprt->xprt_net, buf, buf_len, saddr,
266 rpc_set_port(saddr, port);
268 xprt_force_disconnect(xprt);
270 xprt_release_write(xprt, NULL);
281 static ssize_t rpc_sysfs_xprt_state_change(struct kobject *kobj,
282 struct kobj_attribute *attr,
283 const char *buf, size_t count)
285 struct rpc_xprt *xprt = rpc_sysfs_xprt_kobj_get_xprt(kobj);
286 int offline = 0, online = 0, remove = 0;
287 struct rpc_xprt_switch *xps = rpc_sysfs_xprt_kobj_get_xprt_switch(kobj);
292 if (!strncmp(buf, "offline", 7))
294 else if (!strncmp(buf, "online", 6))
296 else if (!strncmp(buf, "remove", 6))
301 if (wait_on_bit_lock(&xprt->state, XPRT_LOCKED, TASK_KILLABLE)) {
310 set_bit(XPRT_OFFLINE, &xprt->state);
311 spin_lock(&xps->xps_lock);
313 spin_unlock(&xps->xps_lock);
315 clear_bit(XPRT_OFFLINE, &xprt->state);
316 spin_lock(&xps->xps_lock);
318 spin_unlock(&xps->xps_lock);
320 if (test_bit(XPRT_OFFLINE, &xprt->state)) {
321 set_bit(XPRT_REMOVE, &xprt->state);
322 xprt_force_disconnect(xprt);
323 if (test_bit(XPRT_CONNECTED, &xprt->state)) {
324 if (!xprt->sending.qlen &&
325 !xprt->pending.qlen &&
326 !xprt->backlog.qlen &&
327 !atomic_long_read(&xprt->queuelen))
328 rpc_xprt_switch_remove_xprt(xps, xprt);
336 xprt_release_write(xprt, NULL);
339 xprt_switch_put(xps);
343 int rpc_sysfs_init(void)
345 rpc_sunrpc_kset = kset_create_and_add("sunrpc", NULL, kernel_kobj);
346 if (!rpc_sunrpc_kset)
348 rpc_sunrpc_client_kobj =
349 rpc_sysfs_object_alloc("rpc-clients", rpc_sunrpc_kset, NULL);
350 if (!rpc_sunrpc_client_kobj)
352 rpc_sunrpc_xprt_switch_kobj =
353 rpc_sysfs_object_alloc("xprt-switches", rpc_sunrpc_kset, NULL);
354 if (!rpc_sunrpc_xprt_switch_kobj)
358 kobject_put(rpc_sunrpc_client_kobj);
359 rpc_sunrpc_client_kobj = NULL;
361 kset_unregister(rpc_sunrpc_kset);
362 rpc_sunrpc_kset = NULL;
366 static void rpc_sysfs_client_release(struct kobject *kobj)
368 struct rpc_sysfs_client *c;
370 c = container_of(kobj, struct rpc_sysfs_client, kobject);
374 static void rpc_sysfs_xprt_switch_release(struct kobject *kobj)
376 struct rpc_sysfs_xprt_switch *xprt_switch;
378 xprt_switch = container_of(kobj, struct rpc_sysfs_xprt_switch, kobject);
382 static void rpc_sysfs_xprt_release(struct kobject *kobj)
384 struct rpc_sysfs_xprt *xprt;
386 xprt = container_of(kobj, struct rpc_sysfs_xprt, kobject);
390 static const void *rpc_sysfs_client_namespace(struct kobject *kobj)
392 return container_of(kobj, struct rpc_sysfs_client, kobject)->net;
395 static const void *rpc_sysfs_xprt_switch_namespace(struct kobject *kobj)
397 return container_of(kobj, struct rpc_sysfs_xprt_switch, kobject)->net;
400 static const void *rpc_sysfs_xprt_namespace(struct kobject *kobj)
402 return container_of(kobj, struct rpc_sysfs_xprt,
403 kobject)->xprt->xprt_net;
406 static struct kobj_attribute rpc_sysfs_xprt_dstaddr = __ATTR(dstaddr,
407 0644, rpc_sysfs_xprt_dstaddr_show, rpc_sysfs_xprt_dstaddr_store);
409 static struct kobj_attribute rpc_sysfs_xprt_srcaddr = __ATTR(srcaddr,
410 0644, rpc_sysfs_xprt_srcaddr_show, NULL);
412 static struct kobj_attribute rpc_sysfs_xprt_info = __ATTR(xprt_info,
413 0444, rpc_sysfs_xprt_info_show, NULL);
415 static struct kobj_attribute rpc_sysfs_xprt_change_state = __ATTR(xprt_state,
416 0644, rpc_sysfs_xprt_state_show, rpc_sysfs_xprt_state_change);
418 static struct attribute *rpc_sysfs_xprt_attrs[] = {
419 &rpc_sysfs_xprt_dstaddr.attr,
420 &rpc_sysfs_xprt_srcaddr.attr,
421 &rpc_sysfs_xprt_info.attr,
422 &rpc_sysfs_xprt_change_state.attr,
425 ATTRIBUTE_GROUPS(rpc_sysfs_xprt);
427 static struct kobj_attribute rpc_sysfs_xprt_switch_info =
428 __ATTR(xprt_switch_info, 0444, rpc_sysfs_xprt_switch_info_show, NULL);
430 static struct attribute *rpc_sysfs_xprt_switch_attrs[] = {
431 &rpc_sysfs_xprt_switch_info.attr,
434 ATTRIBUTE_GROUPS(rpc_sysfs_xprt_switch);
436 static struct kobj_type rpc_sysfs_client_type = {
437 .release = rpc_sysfs_client_release,
438 .sysfs_ops = &kobj_sysfs_ops,
439 .namespace = rpc_sysfs_client_namespace,
442 static struct kobj_type rpc_sysfs_xprt_switch_type = {
443 .release = rpc_sysfs_xprt_switch_release,
444 .default_groups = rpc_sysfs_xprt_switch_groups,
445 .sysfs_ops = &kobj_sysfs_ops,
446 .namespace = rpc_sysfs_xprt_switch_namespace,
449 static struct kobj_type rpc_sysfs_xprt_type = {
450 .release = rpc_sysfs_xprt_release,
451 .default_groups = rpc_sysfs_xprt_groups,
452 .sysfs_ops = &kobj_sysfs_ops,
453 .namespace = rpc_sysfs_xprt_namespace,
456 void rpc_sysfs_exit(void)
458 kobject_put(rpc_sunrpc_client_kobj);
459 kobject_put(rpc_sunrpc_xprt_switch_kobj);
460 kset_unregister(rpc_sunrpc_kset);
463 static struct rpc_sysfs_client *rpc_sysfs_client_alloc(struct kobject *parent,
467 struct rpc_sysfs_client *p;
469 p = kzalloc(sizeof(*p), GFP_KERNEL);
472 p->kobject.kset = rpc_sunrpc_kset;
473 if (kobject_init_and_add(&p->kobject, &rpc_sysfs_client_type,
474 parent, "clnt-%d", clid) == 0)
476 kobject_put(&p->kobject);
481 static struct rpc_sysfs_xprt_switch *
482 rpc_sysfs_xprt_switch_alloc(struct kobject *parent,
483 struct rpc_xprt_switch *xprt_switch,
487 struct rpc_sysfs_xprt_switch *p;
489 p = kzalloc(sizeof(*p), gfp_flags);
492 p->kobject.kset = rpc_sunrpc_kset;
493 if (kobject_init_and_add(&p->kobject,
494 &rpc_sysfs_xprt_switch_type,
496 xprt_switch->xps_id) == 0)
498 kobject_put(&p->kobject);
503 static struct rpc_sysfs_xprt *rpc_sysfs_xprt_alloc(struct kobject *parent,
504 struct rpc_xprt *xprt,
507 struct rpc_sysfs_xprt *p;
509 p = kzalloc(sizeof(*p), gfp_flags);
512 p->kobject.kset = rpc_sunrpc_kset;
513 if (kobject_init_and_add(&p->kobject, &rpc_sysfs_xprt_type,
514 parent, "xprt-%d-%s", xprt->id,
515 xprt->address_strings[RPC_DISPLAY_PROTO]) == 0)
517 kobject_put(&p->kobject);
522 void rpc_sysfs_client_setup(struct rpc_clnt *clnt,
523 struct rpc_xprt_switch *xprt_switch,
526 struct rpc_sysfs_client *rpc_client;
528 rpc_client = rpc_sysfs_client_alloc(rpc_sunrpc_client_kobj,
531 char name[] = "switch";
532 struct rpc_sysfs_xprt_switch *xswitch =
533 (struct rpc_sysfs_xprt_switch *)xprt_switch->xps_sysfs;
536 clnt->cl_sysfs = rpc_client;
537 rpc_client->clnt = clnt;
538 rpc_client->xprt_switch = xprt_switch;
539 kobject_uevent(&rpc_client->kobject, KOBJ_ADD);
540 ret = sysfs_create_link_nowarn(&rpc_client->kobject,
541 &xswitch->kobject, name);
543 pr_warn("can't create link to %s in sysfs (%d)\n",
548 void rpc_sysfs_xprt_switch_setup(struct rpc_xprt_switch *xprt_switch,
549 struct rpc_xprt *xprt,
552 struct rpc_sysfs_xprt_switch *rpc_xprt_switch;
555 if (xprt_switch->xps_net)
556 net = xprt_switch->xps_net;
558 net = xprt->xprt_net;
560 rpc_sysfs_xprt_switch_alloc(rpc_sunrpc_xprt_switch_kobj,
561 xprt_switch, net, gfp_flags);
562 if (rpc_xprt_switch) {
563 xprt_switch->xps_sysfs = rpc_xprt_switch;
564 rpc_xprt_switch->xprt_switch = xprt_switch;
565 rpc_xprt_switch->xprt = xprt;
566 kobject_uevent(&rpc_xprt_switch->kobject, KOBJ_ADD);
570 void rpc_sysfs_xprt_setup(struct rpc_xprt_switch *xprt_switch,
571 struct rpc_xprt *xprt,
574 struct rpc_sysfs_xprt *rpc_xprt;
575 struct rpc_sysfs_xprt_switch *switch_obj =
576 (struct rpc_sysfs_xprt_switch *)xprt_switch->xps_sysfs;
578 rpc_xprt = rpc_sysfs_xprt_alloc(&switch_obj->kobject, xprt, gfp_flags);
580 xprt->xprt_sysfs = rpc_xprt;
581 rpc_xprt->xprt = xprt;
582 rpc_xprt->xprt_switch = xprt_switch;
583 kobject_uevent(&rpc_xprt->kobject, KOBJ_ADD);
587 void rpc_sysfs_client_destroy(struct rpc_clnt *clnt)
589 struct rpc_sysfs_client *rpc_client = clnt->cl_sysfs;
592 char name[] = "switch";
594 sysfs_remove_link(&rpc_client->kobject, name);
595 kobject_uevent(&rpc_client->kobject, KOBJ_REMOVE);
596 kobject_del(&rpc_client->kobject);
597 kobject_put(&rpc_client->kobject);
598 clnt->cl_sysfs = NULL;
602 void rpc_sysfs_xprt_switch_destroy(struct rpc_xprt_switch *xprt_switch)
604 struct rpc_sysfs_xprt_switch *rpc_xprt_switch = xprt_switch->xps_sysfs;
606 if (rpc_xprt_switch) {
607 kobject_uevent(&rpc_xprt_switch->kobject, KOBJ_REMOVE);
608 kobject_del(&rpc_xprt_switch->kobject);
609 kobject_put(&rpc_xprt_switch->kobject);
610 xprt_switch->xps_sysfs = NULL;
614 void rpc_sysfs_xprt_destroy(struct rpc_xprt *xprt)
616 struct rpc_sysfs_xprt *rpc_xprt = xprt->xprt_sysfs;
619 kobject_uevent(&rpc_xprt->kobject, KOBJ_REMOVE);
620 kobject_del(&rpc_xprt->kobject);
621 kobject_put(&rpc_xprt->kobject);
622 xprt->xprt_sysfs = NULL;