1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * RDMA Network Block Driver
5 * Copyright (c) 2014 - 2018 ProfitBricks GmbH. All rights reserved.
6 * Copyright (c) 2018 - 2019 1&1 IONOS Cloud GmbH. All rights reserved.
7 * Copyright (c) 2019 - 2020 1&1 IONOS SE. All rights reserved.
11 #define pr_fmt(fmt) KBUILD_MODNAME " L" __stringify(__LINE__) ": " fmt
13 #include <linux/types.h>
14 #include <linux/ctype.h>
15 #include <linux/parser.h>
16 #include <linux/module.h>
17 #include <linux/in6.h>
19 #include <linux/uaccess.h>
20 #include <linux/device.h>
22 #include <rdma/rdma_cm.h>
26 static struct device
*rnbd_dev
;
27 static const struct class rnbd_dev_class
= {
28 .name
= "rnbd-client",
30 static struct kobject
*rnbd_devs_kobj
;
34 RNBD_OPT_DEST_PORT
= 1 << 0,
35 RNBD_OPT_PATH
= 1 << 1,
36 RNBD_OPT_DEV_PATH
= 1 << 2,
37 RNBD_OPT_ACCESS_MODE
= 1 << 3,
38 RNBD_OPT_SESSNAME
= 1 << 6,
39 RNBD_OPT_NR_POLL_QUEUES
= 1 << 7,
42 static const unsigned int rnbd_opt_mandatory
[] = {
47 static const match_table_t rnbd_opt_tokens
= {
48 {RNBD_OPT_PATH
, "path=%s" },
49 {RNBD_OPT_DEV_PATH
, "device_path=%s" },
50 {RNBD_OPT_DEST_PORT
, "dest_port=%d" },
51 {RNBD_OPT_ACCESS_MODE
, "access_mode=%s" },
52 {RNBD_OPT_SESSNAME
, "sessname=%s" },
53 {RNBD_OPT_NR_POLL_QUEUES
, "nr_poll_queues=%d" },
54 {RNBD_OPT_ERR
, NULL
},
57 struct rnbd_map_options
{
59 struct rtrs_addr
*paths
;
63 enum rnbd_access_mode
*access_mode
;
67 static int rnbd_clt_parse_map_options(const char *buf
, size_t max_path_cnt
,
68 struct rnbd_map_options
*opt
)
70 char *options
, *sep_opt
;
72 substring_t args
[MAX_OPT_ARGS
];
76 int nr_poll_queues
= 0;
81 options
= kstrdup(buf
, GFP_KERNEL
);
85 sep_opt
= strstrip(options
);
86 while ((p
= strsep(&sep_opt
, " ")) != NULL
) {
90 token
= match_token(p
, rnbd_opt_tokens
, args
);
94 case RNBD_OPT_SESSNAME
:
95 p
= match_strdup(args
);
100 if (strlen(p
) > NAME_MAX
) {
101 pr_err("map_device: sessname too long\n");
106 strscpy(opt
->sessname
, p
, NAME_MAX
);
111 if (p_cnt
>= max_path_cnt
) {
112 pr_err("map_device: too many (> %zu) paths provided\n",
117 p
= match_strdup(args
);
123 ret
= rtrs_addr_to_sockaddr(p
, strlen(p
),
127 pr_err("Can't parse path %s: %d\n", p
, ret
);
137 case RNBD_OPT_DEV_PATH
:
138 p
= match_strdup(args
);
143 if (strlen(p
) > NAME_MAX
) {
144 pr_err("map_device: Device path too long\n");
149 strscpy(opt
->pathname
, p
, NAME_MAX
);
153 case RNBD_OPT_DEST_PORT
:
154 if (match_int(args
, &dest_port
) || dest_port
< 0 ||
156 pr_err("bad destination port number parameter '%d'\n",
161 *opt
->dest_port
= dest_port
;
164 case RNBD_OPT_ACCESS_MODE
:
165 p
= match_strdup(args
);
171 if (!strcmp(p
, "ro")) {
172 *opt
->access_mode
= RNBD_ACCESS_RO
;
173 } else if (!strcmp(p
, "rw")) {
174 *opt
->access_mode
= RNBD_ACCESS_RW
;
175 } else if (!strcmp(p
, "migration")) {
176 *opt
->access_mode
= RNBD_ACCESS_MIGRATION
;
178 pr_err("map_device: Invalid access_mode: '%s'\n",
188 case RNBD_OPT_NR_POLL_QUEUES
:
189 if (match_int(args
, &nr_poll_queues
) || nr_poll_queues
< -1 ||
190 nr_poll_queues
> (int)nr_cpu_ids
) {
191 pr_err("bad nr_poll_queues parameter '%d'\n",
196 if (nr_poll_queues
== -1)
197 nr_poll_queues
= nr_cpu_ids
;
198 *opt
->nr_poll_queues
= nr_poll_queues
;
202 pr_err("map_device: Unknown parameter or missing value '%s'\n",
209 for (i
= 0; i
< ARRAY_SIZE(rnbd_opt_mandatory
); i
++) {
210 if ((opt_mask
& rnbd_opt_mandatory
[i
])) {
213 pr_err("map_device: Parameters missing\n");
220 *opt
->path_cnt
= p_cnt
;
225 static ssize_t
state_show(struct kobject
*kobj
,
226 struct kobj_attribute
*attr
, char *page
)
228 struct rnbd_clt_dev
*dev
;
230 dev
= container_of(kobj
, struct rnbd_clt_dev
, kobj
);
232 switch (dev
->dev_state
) {
234 return sysfs_emit(page
, "init\n");
235 case DEV_STATE_MAPPED
:
236 /* TODO fix cli tool before changing to proper state */
237 return sysfs_emit(page
, "open\n");
238 case DEV_STATE_MAPPED_DISCONNECTED
:
239 /* TODO fix cli tool before changing to proper state */
240 return sysfs_emit(page
, "closed\n");
241 case DEV_STATE_UNMAPPED
:
242 return sysfs_emit(page
, "unmapped\n");
244 return sysfs_emit(page
, "unknown\n");
248 static struct kobj_attribute rnbd_clt_state_attr
= __ATTR_RO(state
);
250 static ssize_t
nr_poll_queues_show(struct kobject
*kobj
,
251 struct kobj_attribute
*attr
, char *page
)
253 struct rnbd_clt_dev
*dev
;
255 dev
= container_of(kobj
, struct rnbd_clt_dev
, kobj
);
257 return sysfs_emit(page
, "%d\n", dev
->nr_poll_queues
);
260 static struct kobj_attribute rnbd_clt_nr_poll_queues
=
261 __ATTR_RO(nr_poll_queues
);
263 static ssize_t
mapping_path_show(struct kobject
*kobj
,
264 struct kobj_attribute
*attr
, char *page
)
266 struct rnbd_clt_dev
*dev
;
268 dev
= container_of(kobj
, struct rnbd_clt_dev
, kobj
);
270 return sysfs_emit(page
, "%s\n", dev
->pathname
);
273 static struct kobj_attribute rnbd_clt_mapping_path_attr
=
274 __ATTR_RO(mapping_path
);
276 static ssize_t
access_mode_show(struct kobject
*kobj
,
277 struct kobj_attribute
*attr
, char *page
)
279 struct rnbd_clt_dev
*dev
;
281 dev
= container_of(kobj
, struct rnbd_clt_dev
, kobj
);
283 return sysfs_emit(page
, "%s\n", rnbd_access_modes
[dev
->access_mode
].str
);
286 static struct kobj_attribute rnbd_clt_access_mode
=
287 __ATTR_RO(access_mode
);
289 static ssize_t
rnbd_clt_unmap_dev_show(struct kobject
*kobj
,
290 struct kobj_attribute
*attr
, char *page
)
292 return sysfs_emit(page
, "Usage: echo <normal|force> > %s\n",
296 static ssize_t
rnbd_clt_unmap_dev_store(struct kobject
*kobj
,
297 struct kobj_attribute
*attr
,
298 const char *buf
, size_t count
)
300 struct rnbd_clt_dev
*dev
;
305 opt
= kstrdup(buf
, GFP_KERNEL
);
309 options
= strstrip(opt
);
310 dev
= container_of(kobj
, struct rnbd_clt_dev
, kobj
);
311 if (sysfs_streq(options
, "normal")) {
313 } else if (sysfs_streq(options
, "force")) {
317 "unmap_device: Invalid value: %s\n",
323 rnbd_clt_info(dev
, "Unmapping device, option: %s.\n",
324 force
? "force" : "normal");
327 * We take explicit module reference only for one reason: do not
328 * race with lockless rnbd_destroy_sessions().
330 if (!try_module_get(THIS_MODULE
)) {
334 err
= rnbd_clt_unmap_device(dev
, force
, &attr
->attr
);
336 if (err
!= -EALREADY
)
337 rnbd_clt_err(dev
, "unmap_device: %d\n", err
);
342 * Here device can be vanished!
348 module_put(THIS_MODULE
);
355 static struct kobj_attribute rnbd_clt_unmap_device_attr
=
356 __ATTR(unmap_device
, 0644, rnbd_clt_unmap_dev_show
,
357 rnbd_clt_unmap_dev_store
);
359 static ssize_t
rnbd_clt_resize_dev_show(struct kobject
*kobj
,
360 struct kobj_attribute
*attr
,
363 return sysfs_emit(page
, "Usage: echo <new size in sectors> > %s\n",
367 static ssize_t
rnbd_clt_resize_dev_store(struct kobject
*kobj
,
368 struct kobj_attribute
*attr
,
369 const char *buf
, size_t count
)
372 unsigned long sectors
;
373 struct rnbd_clt_dev
*dev
;
375 dev
= container_of(kobj
, struct rnbd_clt_dev
, kobj
);
377 ret
= kstrtoul(buf
, 0, §ors
);
381 ret
= rnbd_clt_resize_disk(dev
, sectors
);
388 static struct kobj_attribute rnbd_clt_resize_dev_attr
=
389 __ATTR(resize
, 0644, rnbd_clt_resize_dev_show
,
390 rnbd_clt_resize_dev_store
);
392 static ssize_t
rnbd_clt_remap_dev_show(struct kobject
*kobj
,
393 struct kobj_attribute
*attr
, char *page
)
395 return sysfs_emit(page
, "Usage: echo <1> > %s\n", attr
->attr
.name
);
398 static ssize_t
rnbd_clt_remap_dev_store(struct kobject
*kobj
,
399 struct kobj_attribute
*attr
,
400 const char *buf
, size_t count
)
402 struct rnbd_clt_dev
*dev
;
406 opt
= kstrdup(buf
, GFP_KERNEL
);
410 options
= strstrip(opt
);
411 dev
= container_of(kobj
, struct rnbd_clt_dev
, kobj
);
412 if (!sysfs_streq(options
, "1")) {
414 "remap_device: Invalid value: %s\n",
419 err
= rnbd_clt_remap_device(dev
);
429 static struct kobj_attribute rnbd_clt_remap_device_attr
=
430 __ATTR(remap_device
, 0644, rnbd_clt_remap_dev_show
,
431 rnbd_clt_remap_dev_store
);
433 static ssize_t
session_show(struct kobject
*kobj
, struct kobj_attribute
*attr
,
436 struct rnbd_clt_dev
*dev
;
438 dev
= container_of(kobj
, struct rnbd_clt_dev
, kobj
);
440 return sysfs_emit(page
, "%s\n", dev
->sess
->sessname
);
443 static struct kobj_attribute rnbd_clt_session_attr
=
446 static struct attribute
*rnbd_dev_attrs
[] = {
447 &rnbd_clt_unmap_device_attr
.attr
,
448 &rnbd_clt_resize_dev_attr
.attr
,
449 &rnbd_clt_remap_device_attr
.attr
,
450 &rnbd_clt_mapping_path_attr
.attr
,
451 &rnbd_clt_state_attr
.attr
,
452 &rnbd_clt_session_attr
.attr
,
453 &rnbd_clt_access_mode
.attr
,
454 &rnbd_clt_nr_poll_queues
.attr
,
457 ATTRIBUTE_GROUPS(rnbd_dev
);
459 void rnbd_clt_remove_dev_symlink(struct rnbd_clt_dev
*dev
)
462 * The module unload rnbd_client_exit path is racing with unmapping of
463 * the last single device from the sysfs manually
464 * i.e. rnbd_clt_unmap_dev_store() leading to a sysfs warning because
465 * of sysfs link already was removed already.
467 if (dev
->blk_symlink_name
) {
468 if (try_module_get(THIS_MODULE
)) {
469 sysfs_remove_link(rnbd_devs_kobj
, dev
->blk_symlink_name
);
470 module_put(THIS_MODULE
);
472 /* It should be freed always. */
473 kfree(dev
->blk_symlink_name
);
474 dev
->blk_symlink_name
= NULL
;
478 static const struct kobj_type rnbd_dev_ktype
= {
479 .sysfs_ops
= &kobj_sysfs_ops
,
480 .default_groups
= rnbd_dev_groups
,
483 static int rnbd_clt_add_dev_kobj(struct rnbd_clt_dev
*dev
)
486 struct kobject
*gd_kobj
= &disk_to_dev(dev
->gd
)->kobj
;
488 ret
= kobject_init_and_add(&dev
->kobj
, &rnbd_dev_ktype
, gd_kobj
, "%s",
491 rnbd_clt_err(dev
, "Failed to create device sysfs dir, err: %d\n",
493 kobject_put(&dev
->kobj
);
495 kobject_uevent(gd_kobj
, KOBJ_ONLINE
);
500 static ssize_t
rnbd_clt_map_device_show(struct kobject
*kobj
,
501 struct kobj_attribute
*attr
,
504 return sysfs_emit(page
,
505 "Usage: echo \"[dest_port=server port number] sessname=<name of the rtrs session> path=<[srcaddr@]dstaddr> [path=<[srcaddr@]dstaddr>] device_path=<full path on remote side> [access_mode=<ro|rw|migration>] [nr_poll_queues=<number of queues>]\" > %s\n\naddr ::= [ ip:<ipv4> | ip:<ipv6> | gid:<gid> ]\n",
509 static int rnbd_clt_get_path_name(struct rnbd_clt_dev
*dev
, char *buf
,
513 char pathname
[NAME_MAX
], *s
;
515 strscpy(pathname
, dev
->pathname
, sizeof(pathname
));
516 while ((s
= strchr(pathname
, '/')))
519 ret
= snprintf(buf
, len
, "%s@%s", pathname
, dev
->sess
->sessname
);
521 return -ENAMETOOLONG
;
526 static int rnbd_clt_add_dev_symlink(struct rnbd_clt_dev
*dev
)
528 struct kobject
*gd_kobj
= &disk_to_dev(dev
->gd
)->kobj
;
531 len
= strlen(dev
->pathname
) + strlen(dev
->sess
->sessname
) + 2;
532 dev
->blk_symlink_name
= kzalloc(len
, GFP_KERNEL
);
533 if (!dev
->blk_symlink_name
) {
534 rnbd_clt_err(dev
, "Failed to allocate memory for blk_symlink_name\n");
538 ret
= rnbd_clt_get_path_name(dev
, dev
->blk_symlink_name
,
541 rnbd_clt_err(dev
, "Failed to get /sys/block symlink path, err: %d\n",
546 ret
= sysfs_create_link(rnbd_devs_kobj
, gd_kobj
,
547 dev
->blk_symlink_name
);
549 rnbd_clt_err(dev
, "Creating /sys/block symlink failed, err: %d\n",
557 kfree(dev
->blk_symlink_name
);
558 dev
->blk_symlink_name
= NULL
;
562 static ssize_t
rnbd_clt_map_device_store(struct kobject
*kobj
,
563 struct kobj_attribute
*attr
,
564 const char *buf
, size_t count
)
566 struct rnbd_clt_dev
*dev
;
567 struct rnbd_map_options opt
;
569 char pathname
[NAME_MAX
];
570 char sessname
[NAME_MAX
];
571 enum rnbd_access_mode access_mode
= RNBD_ACCESS_RW
;
572 u16 port_nr
= RTRS_PORT
;
573 u32 nr_poll_queues
= 0;
575 struct sockaddr_storage
*addrs
;
576 struct rtrs_addr paths
[6];
579 opt
.sessname
= sessname
;
581 opt
.path_cnt
= &path_cnt
;
582 opt
.pathname
= pathname
;
583 opt
.dest_port
= &port_nr
;
584 opt
.access_mode
= &access_mode
;
585 opt
.nr_poll_queues
= &nr_poll_queues
;
586 addrs
= kcalloc(ARRAY_SIZE(paths
) * 2, sizeof(*addrs
), GFP_KERNEL
);
590 for (path_cnt
= 0; path_cnt
< ARRAY_SIZE(paths
); path_cnt
++) {
591 paths
[path_cnt
].src
= &addrs
[path_cnt
* 2];
592 paths
[path_cnt
].dst
= &addrs
[path_cnt
* 2 + 1];
595 ret
= rnbd_clt_parse_map_options(buf
, ARRAY_SIZE(paths
), &opt
);
599 pr_info("Mapping device %s on session %s, (access_mode: %s, nr_poll_queues: %d)\n",
601 rnbd_access_modes
[access_mode
].str
,
604 dev
= rnbd_clt_map_device(sessname
, paths
, path_cnt
, port_nr
, pathname
,
605 access_mode
, nr_poll_queues
);
611 ret
= rnbd_clt_add_dev_kobj(dev
);
615 ret
= rnbd_clt_add_dev_symlink(dev
);
623 rnbd_clt_unmap_device(dev
, true, NULL
);
629 static struct kobj_attribute rnbd_clt_map_device_attr
=
630 __ATTR(map_device
, 0644,
631 rnbd_clt_map_device_show
, rnbd_clt_map_device_store
);
633 static struct attribute
*default_attrs
[] = {
634 &rnbd_clt_map_device_attr
.attr
,
638 static struct attribute_group default_attr_group
= {
639 .attrs
= default_attrs
,
642 static const struct attribute_group
*default_attr_groups
[] = {
647 int rnbd_clt_create_sysfs_files(void)
651 err
= class_register(&rnbd_dev_class
);
655 rnbd_dev
= device_create_with_groups(&rnbd_dev_class
, NULL
,
657 default_attr_groups
, "ctl");
658 if (IS_ERR(rnbd_dev
)) {
659 err
= PTR_ERR(rnbd_dev
);
662 rnbd_devs_kobj
= kobject_create_and_add("devices", &rnbd_dev
->kobj
);
663 if (!rnbd_devs_kobj
) {
671 device_destroy(&rnbd_dev_class
, MKDEV(0, 0));
673 class_unregister(&rnbd_dev_class
);
678 void rnbd_clt_destroy_sysfs_files(void)
680 sysfs_remove_group(&rnbd_dev
->kobj
, &default_attr_group
);
681 kobject_del(rnbd_devs_kobj
);
682 kobject_put(rnbd_devs_kobj
);
683 device_destroy(&rnbd_dev_class
, MKDEV(0, 0));
684 class_unregister(&rnbd_dev_class
);