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 struct class *rnbd_dev_class;
28 static struct kobject *rnbd_devs_kobj;
32 RNBD_OPT_DEST_PORT = 1 << 0,
33 RNBD_OPT_PATH = 1 << 1,
34 RNBD_OPT_DEV_PATH = 1 << 2,
35 RNBD_OPT_ACCESS_MODE = 1 << 3,
36 RNBD_OPT_SESSNAME = 1 << 6,
37 RNBD_OPT_NR_POLL_QUEUES = 1 << 7,
40 static const unsigned int rnbd_opt_mandatory[] = {
45 static const match_table_t rnbd_opt_tokens = {
46 {RNBD_OPT_PATH, "path=%s" },
47 {RNBD_OPT_DEV_PATH, "device_path=%s" },
48 {RNBD_OPT_DEST_PORT, "dest_port=%d" },
49 {RNBD_OPT_ACCESS_MODE, "access_mode=%s" },
50 {RNBD_OPT_SESSNAME, "sessname=%s" },
51 {RNBD_OPT_NR_POLL_QUEUES, "nr_poll_queues=%d" },
52 {RNBD_OPT_ERR, NULL },
55 struct rnbd_map_options {
57 struct rtrs_addr *paths;
61 enum rnbd_access_mode *access_mode;
65 static int rnbd_clt_parse_map_options(const char *buf, size_t max_path_cnt,
66 struct rnbd_map_options *opt)
68 char *options, *sep_opt;
70 substring_t args[MAX_OPT_ARGS];
74 int i, dest_port, nr_poll_queues;
77 options = kstrdup(buf, GFP_KERNEL);
81 sep_opt = strstrip(options);
82 while ((p = strsep(&sep_opt, " ")) != NULL) {
86 token = match_token(p, rnbd_opt_tokens, args);
90 case RNBD_OPT_SESSNAME:
91 p = match_strdup(args);
96 if (strlen(p) > NAME_MAX) {
97 pr_err("map_device: sessname too long\n");
102 strscpy(opt->sessname, p, NAME_MAX);
107 if (p_cnt >= max_path_cnt) {
108 pr_err("map_device: too many (> %zu) paths provided\n",
113 p = match_strdup(args);
119 ret = rtrs_addr_to_sockaddr(p, strlen(p),
123 pr_err("Can't parse path %s: %d\n", p, ret);
133 case RNBD_OPT_DEV_PATH:
134 p = match_strdup(args);
139 if (strlen(p) > NAME_MAX) {
140 pr_err("map_device: Device path too long\n");
145 strscpy(opt->pathname, p, NAME_MAX);
149 case RNBD_OPT_DEST_PORT:
150 if (match_int(args, &dest_port) || dest_port < 0 ||
152 pr_err("bad destination port number parameter '%d'\n",
157 *opt->dest_port = dest_port;
160 case RNBD_OPT_ACCESS_MODE:
161 p = match_strdup(args);
167 if (!strcmp(p, "ro")) {
168 *opt->access_mode = RNBD_ACCESS_RO;
169 } else if (!strcmp(p, "rw")) {
170 *opt->access_mode = RNBD_ACCESS_RW;
171 } else if (!strcmp(p, "migration")) {
172 *opt->access_mode = RNBD_ACCESS_MIGRATION;
174 pr_err("map_device: Invalid access_mode: '%s'\n",
184 case RNBD_OPT_NR_POLL_QUEUES:
185 if (match_int(args, &nr_poll_queues) || nr_poll_queues < -1 ||
186 nr_poll_queues > (int)nr_cpu_ids) {
187 pr_err("bad nr_poll_queues parameter '%d'\n",
192 if (nr_poll_queues == -1)
193 nr_poll_queues = nr_cpu_ids;
194 *opt->nr_poll_queues = nr_poll_queues;
198 pr_err("map_device: Unknown parameter or missing value '%s'\n",
205 for (i = 0; i < ARRAY_SIZE(rnbd_opt_mandatory); i++) {
206 if ((opt_mask & rnbd_opt_mandatory[i])) {
209 pr_err("map_device: Parameters missing\n");
216 *opt->path_cnt = p_cnt;
221 static ssize_t state_show(struct kobject *kobj,
222 struct kobj_attribute *attr, char *page)
224 struct rnbd_clt_dev *dev;
226 dev = container_of(kobj, struct rnbd_clt_dev, kobj);
228 switch (dev->dev_state) {
230 return snprintf(page, PAGE_SIZE, "init\n");
231 case DEV_STATE_MAPPED:
232 /* TODO fix cli tool before changing to proper state */
233 return snprintf(page, PAGE_SIZE, "open\n");
234 case DEV_STATE_MAPPED_DISCONNECTED:
235 /* TODO fix cli tool before changing to proper state */
236 return snprintf(page, PAGE_SIZE, "closed\n");
237 case DEV_STATE_UNMAPPED:
238 return snprintf(page, PAGE_SIZE, "unmapped\n");
240 return snprintf(page, PAGE_SIZE, "unknown\n");
244 static struct kobj_attribute rnbd_clt_state_attr = __ATTR_RO(state);
246 static ssize_t nr_poll_queues_show(struct kobject *kobj,
247 struct kobj_attribute *attr, char *page)
249 struct rnbd_clt_dev *dev;
251 dev = container_of(kobj, struct rnbd_clt_dev, kobj);
253 return sysfs_emit(page, "%d\n", dev->nr_poll_queues);
256 static struct kobj_attribute rnbd_clt_nr_poll_queues =
257 __ATTR_RO(nr_poll_queues);
259 static ssize_t mapping_path_show(struct kobject *kobj,
260 struct kobj_attribute *attr, char *page)
262 struct rnbd_clt_dev *dev;
264 dev = container_of(kobj, struct rnbd_clt_dev, kobj);
266 return scnprintf(page, PAGE_SIZE, "%s\n", dev->pathname);
269 static struct kobj_attribute rnbd_clt_mapping_path_attr =
270 __ATTR_RO(mapping_path);
272 static ssize_t access_mode_show(struct kobject *kobj,
273 struct kobj_attribute *attr, char *page)
275 struct rnbd_clt_dev *dev;
277 dev = container_of(kobj, struct rnbd_clt_dev, kobj);
279 return snprintf(page, PAGE_SIZE, "%s\n",
280 rnbd_access_mode_str(dev->access_mode));
283 static struct kobj_attribute rnbd_clt_access_mode =
284 __ATTR_RO(access_mode);
286 static ssize_t rnbd_clt_unmap_dev_show(struct kobject *kobj,
287 struct kobj_attribute *attr, char *page)
289 return scnprintf(page, PAGE_SIZE, "Usage: echo <normal|force> > %s\n",
293 static ssize_t rnbd_clt_unmap_dev_store(struct kobject *kobj,
294 struct kobj_attribute *attr,
295 const char *buf, size_t count)
297 struct rnbd_clt_dev *dev;
302 opt = kstrdup(buf, GFP_KERNEL);
306 options = strstrip(opt);
307 dev = container_of(kobj, struct rnbd_clt_dev, kobj);
308 if (sysfs_streq(options, "normal")) {
310 } else if (sysfs_streq(options, "force")) {
314 "unmap_device: Invalid value: %s\n",
320 rnbd_clt_info(dev, "Unmapping device, option: %s.\n",
321 force ? "force" : "normal");
324 * We take explicit module reference only for one reason: do not
325 * race with lockless rnbd_destroy_sessions().
327 if (!try_module_get(THIS_MODULE)) {
331 err = rnbd_clt_unmap_device(dev, force, &attr->attr);
333 if (err != -EALREADY)
334 rnbd_clt_err(dev, "unmap_device: %d\n", err);
339 * Here device can be vanished!
345 module_put(THIS_MODULE);
352 static struct kobj_attribute rnbd_clt_unmap_device_attr =
353 __ATTR(unmap_device, 0644, rnbd_clt_unmap_dev_show,
354 rnbd_clt_unmap_dev_store);
356 static ssize_t rnbd_clt_resize_dev_show(struct kobject *kobj,
357 struct kobj_attribute *attr,
360 return scnprintf(page, PAGE_SIZE,
361 "Usage: echo <new size in sectors> > %s\n",
365 static ssize_t rnbd_clt_resize_dev_store(struct kobject *kobj,
366 struct kobj_attribute *attr,
367 const char *buf, size_t count)
370 unsigned long sectors;
371 struct rnbd_clt_dev *dev;
373 dev = container_of(kobj, struct rnbd_clt_dev, kobj);
375 ret = kstrtoul(buf, 0, §ors);
379 ret = rnbd_clt_resize_disk(dev, (size_t)sectors);
386 static struct kobj_attribute rnbd_clt_resize_dev_attr =
387 __ATTR(resize, 0644, rnbd_clt_resize_dev_show,
388 rnbd_clt_resize_dev_store);
390 static ssize_t rnbd_clt_remap_dev_show(struct kobject *kobj,
391 struct kobj_attribute *attr, char *page)
393 return scnprintf(page, PAGE_SIZE, "Usage: echo <1> > %s\n",
397 static ssize_t rnbd_clt_remap_dev_store(struct kobject *kobj,
398 struct kobj_attribute *attr,
399 const char *buf, size_t count)
401 struct rnbd_clt_dev *dev;
405 opt = kstrdup(buf, GFP_KERNEL);
409 options = strstrip(opt);
410 dev = container_of(kobj, struct rnbd_clt_dev, kobj);
411 if (!sysfs_streq(options, "1")) {
413 "remap_device: Invalid value: %s\n",
418 err = rnbd_clt_remap_device(dev);
428 static struct kobj_attribute rnbd_clt_remap_device_attr =
429 __ATTR(remap_device, 0644, rnbd_clt_remap_dev_show,
430 rnbd_clt_remap_dev_store);
432 static ssize_t session_show(struct kobject *kobj, struct kobj_attribute *attr,
435 struct rnbd_clt_dev *dev;
437 dev = container_of(kobj, struct rnbd_clt_dev, kobj);
439 return scnprintf(page, PAGE_SIZE, "%s\n", dev->sess->sessname);
442 static struct kobj_attribute rnbd_clt_session_attr =
445 static struct attribute *rnbd_dev_attrs[] = {
446 &rnbd_clt_unmap_device_attr.attr,
447 &rnbd_clt_resize_dev_attr.attr,
448 &rnbd_clt_remap_device_attr.attr,
449 &rnbd_clt_mapping_path_attr.attr,
450 &rnbd_clt_state_attr.attr,
451 &rnbd_clt_session_attr.attr,
452 &rnbd_clt_access_mode.attr,
453 &rnbd_clt_nr_poll_queues.attr,
457 void rnbd_clt_remove_dev_symlink(struct rnbd_clt_dev *dev)
460 * The module unload rnbd_client_exit path is racing with unmapping of
461 * the last single device from the sysfs manually
462 * i.e. rnbd_clt_unmap_dev_store() leading to a sysfs warning because
463 * of sysfs link already was removed already.
465 if (dev->blk_symlink_name) {
466 if (try_module_get(THIS_MODULE)) {
467 sysfs_remove_link(rnbd_devs_kobj, dev->blk_symlink_name);
468 module_put(THIS_MODULE);
470 /* It should be freed always. */
471 kfree(dev->blk_symlink_name);
472 dev->blk_symlink_name = NULL;
476 static struct kobj_type rnbd_dev_ktype = {
477 .sysfs_ops = &kobj_sysfs_ops,
478 .default_attrs = rnbd_dev_attrs,
481 static int rnbd_clt_add_dev_kobj(struct rnbd_clt_dev *dev)
484 struct kobject *gd_kobj = &disk_to_dev(dev->gd)->kobj;
486 ret = kobject_init_and_add(&dev->kobj, &rnbd_dev_ktype, gd_kobj, "%s",
489 rnbd_clt_err(dev, "Failed to create device sysfs dir, err: %d\n",
491 kobject_put(&dev->kobj);
493 kobject_uevent(gd_kobj, KOBJ_ONLINE);
498 static ssize_t rnbd_clt_map_device_show(struct kobject *kobj,
499 struct kobj_attribute *attr,
502 return scnprintf(page, PAGE_SIZE,
503 "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",
507 static int rnbd_clt_get_path_name(struct rnbd_clt_dev *dev, char *buf,
511 char pathname[NAME_MAX], *s;
513 strscpy(pathname, dev->pathname, sizeof(pathname));
514 while ((s = strchr(pathname, '/')))
517 ret = snprintf(buf, len, "%s@%s", pathname, dev->sess->sessname);
519 return -ENAMETOOLONG;
524 static int rnbd_clt_add_dev_symlink(struct rnbd_clt_dev *dev)
526 struct kobject *gd_kobj = &disk_to_dev(dev->gd)->kobj;
529 len = strlen(dev->pathname) + strlen(dev->sess->sessname) + 2;
530 dev->blk_symlink_name = kzalloc(len, GFP_KERNEL);
531 if (!dev->blk_symlink_name) {
532 rnbd_clt_err(dev, "Failed to allocate memory for blk_symlink_name\n");
536 ret = rnbd_clt_get_path_name(dev, dev->blk_symlink_name,
539 rnbd_clt_err(dev, "Failed to get /sys/block symlink path, err: %d\n",
544 ret = sysfs_create_link(rnbd_devs_kobj, gd_kobj,
545 dev->blk_symlink_name);
547 rnbd_clt_err(dev, "Creating /sys/block symlink failed, err: %d\n",
555 kfree(dev->blk_symlink_name);
556 dev->blk_symlink_name = NULL ;
560 static ssize_t rnbd_clt_map_device_store(struct kobject *kobj,
561 struct kobj_attribute *attr,
562 const char *buf, size_t count)
564 struct rnbd_clt_dev *dev;
565 struct rnbd_map_options opt;
567 char pathname[NAME_MAX];
568 char sessname[NAME_MAX];
569 enum rnbd_access_mode access_mode = RNBD_ACCESS_RW;
570 u16 port_nr = RTRS_PORT;
571 u32 nr_poll_queues = 0;
573 struct sockaddr_storage *addrs;
574 struct rtrs_addr paths[6];
577 opt.sessname = sessname;
579 opt.path_cnt = &path_cnt;
580 opt.pathname = pathname;
581 opt.dest_port = &port_nr;
582 opt.access_mode = &access_mode;
583 opt.nr_poll_queues = &nr_poll_queues;
584 addrs = kcalloc(ARRAY_SIZE(paths) * 2, sizeof(*addrs), GFP_KERNEL);
588 for (path_cnt = 0; path_cnt < ARRAY_SIZE(paths); path_cnt++) {
589 paths[path_cnt].src = &addrs[path_cnt * 2];
590 paths[path_cnt].dst = &addrs[path_cnt * 2 + 1];
593 ret = rnbd_clt_parse_map_options(buf, ARRAY_SIZE(paths), &opt);
597 pr_info("Mapping device %s on session %s, (access_mode: %s, nr_poll_queues: %d)\n",
599 rnbd_access_mode_str(access_mode),
602 dev = rnbd_clt_map_device(sessname, paths, path_cnt, port_nr, pathname,
603 access_mode, nr_poll_queues);
609 ret = rnbd_clt_add_dev_kobj(dev);
613 ret = rnbd_clt_add_dev_symlink(dev);
621 rnbd_clt_unmap_device(dev, true, NULL);
627 static struct kobj_attribute rnbd_clt_map_device_attr =
628 __ATTR(map_device, 0644,
629 rnbd_clt_map_device_show, rnbd_clt_map_device_store);
631 static struct attribute *default_attrs[] = {
632 &rnbd_clt_map_device_attr.attr,
636 static struct attribute_group default_attr_group = {
637 .attrs = default_attrs,
640 static const struct attribute_group *default_attr_groups[] = {
645 int rnbd_clt_create_sysfs_files(void)
649 rnbd_dev_class = class_create(THIS_MODULE, "rnbd-client");
650 if (IS_ERR(rnbd_dev_class))
651 return PTR_ERR(rnbd_dev_class);
653 rnbd_dev = device_create_with_groups(rnbd_dev_class, NULL,
655 default_attr_groups, "ctl");
656 if (IS_ERR(rnbd_dev)) {
657 err = PTR_ERR(rnbd_dev);
660 rnbd_devs_kobj = kobject_create_and_add("devices", &rnbd_dev->kobj);
661 if (!rnbd_devs_kobj) {
669 device_destroy(rnbd_dev_class, MKDEV(0, 0));
671 class_destroy(rnbd_dev_class);
676 void rnbd_clt_destroy_sysfs_files(void)
678 sysfs_remove_group(&rnbd_dev->kobj, &default_attr_group);
679 kobject_del(rnbd_devs_kobj);
680 kobject_put(rnbd_devs_kobj);
681 device_destroy(rnbd_dev_class, MKDEV(0, 0));
682 class_destroy(rnbd_dev_class);