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 sysfs_emit(page, "init\n");
231 case DEV_STATE_MAPPED:
232 /* TODO fix cli tool before changing to proper state */
233 return sysfs_emit(page, "open\n");
234 case DEV_STATE_MAPPED_DISCONNECTED:
235 /* TODO fix cli tool before changing to proper state */
236 return sysfs_emit(page, "closed\n");
237 case DEV_STATE_UNMAPPED:
238 return sysfs_emit(page, "unmapped\n");
240 return sysfs_emit(page, "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 sysfs_emit(page, "%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 sysfs_emit(page, "%s\n", rnbd_access_mode_str(dev->access_mode));
282 static struct kobj_attribute rnbd_clt_access_mode =
283 __ATTR_RO(access_mode);
285 static ssize_t rnbd_clt_unmap_dev_show(struct kobject *kobj,
286 struct kobj_attribute *attr, char *page)
288 return sysfs_emit(page, "Usage: echo <normal|force> > %s\n",
292 static ssize_t rnbd_clt_unmap_dev_store(struct kobject *kobj,
293 struct kobj_attribute *attr,
294 const char *buf, size_t count)
296 struct rnbd_clt_dev *dev;
301 opt = kstrdup(buf, GFP_KERNEL);
305 options = strstrip(opt);
306 dev = container_of(kobj, struct rnbd_clt_dev, kobj);
307 if (sysfs_streq(options, "normal")) {
309 } else if (sysfs_streq(options, "force")) {
313 "unmap_device: Invalid value: %s\n",
319 rnbd_clt_info(dev, "Unmapping device, option: %s.\n",
320 force ? "force" : "normal");
323 * We take explicit module reference only for one reason: do not
324 * race with lockless rnbd_destroy_sessions().
326 if (!try_module_get(THIS_MODULE)) {
330 err = rnbd_clt_unmap_device(dev, force, &attr->attr);
332 if (err != -EALREADY)
333 rnbd_clt_err(dev, "unmap_device: %d\n", err);
338 * Here device can be vanished!
344 module_put(THIS_MODULE);
351 static struct kobj_attribute rnbd_clt_unmap_device_attr =
352 __ATTR(unmap_device, 0644, rnbd_clt_unmap_dev_show,
353 rnbd_clt_unmap_dev_store);
355 static ssize_t rnbd_clt_resize_dev_show(struct kobject *kobj,
356 struct kobj_attribute *attr,
359 return sysfs_emit(page, "Usage: echo <new size in sectors> > %s\n",
363 static ssize_t rnbd_clt_resize_dev_store(struct kobject *kobj,
364 struct kobj_attribute *attr,
365 const char *buf, size_t count)
368 unsigned long sectors;
369 struct rnbd_clt_dev *dev;
371 dev = container_of(kobj, struct rnbd_clt_dev, kobj);
373 ret = kstrtoul(buf, 0, §ors);
377 ret = rnbd_clt_resize_disk(dev, (size_t)sectors);
384 static struct kobj_attribute rnbd_clt_resize_dev_attr =
385 __ATTR(resize, 0644, rnbd_clt_resize_dev_show,
386 rnbd_clt_resize_dev_store);
388 static ssize_t rnbd_clt_remap_dev_show(struct kobject *kobj,
389 struct kobj_attribute *attr, char *page)
391 return sysfs_emit(page, "Usage: echo <1> > %s\n", attr->attr.name);
394 static ssize_t rnbd_clt_remap_dev_store(struct kobject *kobj,
395 struct kobj_attribute *attr,
396 const char *buf, size_t count)
398 struct rnbd_clt_dev *dev;
402 opt = kstrdup(buf, GFP_KERNEL);
406 options = strstrip(opt);
407 dev = container_of(kobj, struct rnbd_clt_dev, kobj);
408 if (!sysfs_streq(options, "1")) {
410 "remap_device: Invalid value: %s\n",
415 err = rnbd_clt_remap_device(dev);
425 static struct kobj_attribute rnbd_clt_remap_device_attr =
426 __ATTR(remap_device, 0644, rnbd_clt_remap_dev_show,
427 rnbd_clt_remap_dev_store);
429 static ssize_t session_show(struct kobject *kobj, struct kobj_attribute *attr,
432 struct rnbd_clt_dev *dev;
434 dev = container_of(kobj, struct rnbd_clt_dev, kobj);
436 return sysfs_emit(page, "%s\n", dev->sess->sessname);
439 static struct kobj_attribute rnbd_clt_session_attr =
442 static struct attribute *rnbd_dev_attrs[] = {
443 &rnbd_clt_unmap_device_attr.attr,
444 &rnbd_clt_resize_dev_attr.attr,
445 &rnbd_clt_remap_device_attr.attr,
446 &rnbd_clt_mapping_path_attr.attr,
447 &rnbd_clt_state_attr.attr,
448 &rnbd_clt_session_attr.attr,
449 &rnbd_clt_access_mode.attr,
450 &rnbd_clt_nr_poll_queues.attr,
454 void rnbd_clt_remove_dev_symlink(struct rnbd_clt_dev *dev)
457 * The module unload rnbd_client_exit path is racing with unmapping of
458 * the last single device from the sysfs manually
459 * i.e. rnbd_clt_unmap_dev_store() leading to a sysfs warning because
460 * of sysfs link already was removed already.
462 if (dev->blk_symlink_name) {
463 if (try_module_get(THIS_MODULE)) {
464 sysfs_remove_link(rnbd_devs_kobj, dev->blk_symlink_name);
465 module_put(THIS_MODULE);
467 /* It should be freed always. */
468 kfree(dev->blk_symlink_name);
469 dev->blk_symlink_name = NULL;
473 static struct kobj_type rnbd_dev_ktype = {
474 .sysfs_ops = &kobj_sysfs_ops,
475 .default_attrs = rnbd_dev_attrs,
478 static int rnbd_clt_add_dev_kobj(struct rnbd_clt_dev *dev)
481 struct kobject *gd_kobj = &disk_to_dev(dev->gd)->kobj;
483 ret = kobject_init_and_add(&dev->kobj, &rnbd_dev_ktype, gd_kobj, "%s",
486 rnbd_clt_err(dev, "Failed to create device sysfs dir, err: %d\n",
488 kobject_put(&dev->kobj);
490 kobject_uevent(gd_kobj, KOBJ_ONLINE);
495 static ssize_t rnbd_clt_map_device_show(struct kobject *kobj,
496 struct kobj_attribute *attr,
499 return sysfs_emit(page,
500 "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",
504 static int rnbd_clt_get_path_name(struct rnbd_clt_dev *dev, char *buf,
508 char pathname[NAME_MAX], *s;
510 strscpy(pathname, dev->pathname, sizeof(pathname));
511 while ((s = strchr(pathname, '/')))
514 ret = snprintf(buf, len, "%s@%s", pathname, dev->sess->sessname);
516 return -ENAMETOOLONG;
521 static int rnbd_clt_add_dev_symlink(struct rnbd_clt_dev *dev)
523 struct kobject *gd_kobj = &disk_to_dev(dev->gd)->kobj;
526 len = strlen(dev->pathname) + strlen(dev->sess->sessname) + 2;
527 dev->blk_symlink_name = kzalloc(len, GFP_KERNEL);
528 if (!dev->blk_symlink_name) {
529 rnbd_clt_err(dev, "Failed to allocate memory for blk_symlink_name\n");
533 ret = rnbd_clt_get_path_name(dev, dev->blk_symlink_name,
536 rnbd_clt_err(dev, "Failed to get /sys/block symlink path, err: %d\n",
541 ret = sysfs_create_link(rnbd_devs_kobj, gd_kobj,
542 dev->blk_symlink_name);
544 rnbd_clt_err(dev, "Creating /sys/block symlink failed, err: %d\n",
552 kfree(dev->blk_symlink_name);
553 dev->blk_symlink_name = NULL ;
557 static ssize_t rnbd_clt_map_device_store(struct kobject *kobj,
558 struct kobj_attribute *attr,
559 const char *buf, size_t count)
561 struct rnbd_clt_dev *dev;
562 struct rnbd_map_options opt;
564 char pathname[NAME_MAX];
565 char sessname[NAME_MAX];
566 enum rnbd_access_mode access_mode = RNBD_ACCESS_RW;
567 u16 port_nr = RTRS_PORT;
568 u32 nr_poll_queues = 0;
570 struct sockaddr_storage *addrs;
571 struct rtrs_addr paths[6];
574 opt.sessname = sessname;
576 opt.path_cnt = &path_cnt;
577 opt.pathname = pathname;
578 opt.dest_port = &port_nr;
579 opt.access_mode = &access_mode;
580 opt.nr_poll_queues = &nr_poll_queues;
581 addrs = kcalloc(ARRAY_SIZE(paths) * 2, sizeof(*addrs), GFP_KERNEL);
585 for (path_cnt = 0; path_cnt < ARRAY_SIZE(paths); path_cnt++) {
586 paths[path_cnt].src = &addrs[path_cnt * 2];
587 paths[path_cnt].dst = &addrs[path_cnt * 2 + 1];
590 ret = rnbd_clt_parse_map_options(buf, ARRAY_SIZE(paths), &opt);
594 pr_info("Mapping device %s on session %s, (access_mode: %s, nr_poll_queues: %d)\n",
596 rnbd_access_mode_str(access_mode),
599 dev = rnbd_clt_map_device(sessname, paths, path_cnt, port_nr, pathname,
600 access_mode, nr_poll_queues);
606 ret = rnbd_clt_add_dev_kobj(dev);
610 ret = rnbd_clt_add_dev_symlink(dev);
618 rnbd_clt_unmap_device(dev, true, NULL);
624 static struct kobj_attribute rnbd_clt_map_device_attr =
625 __ATTR(map_device, 0644,
626 rnbd_clt_map_device_show, rnbd_clt_map_device_store);
628 static struct attribute *default_attrs[] = {
629 &rnbd_clt_map_device_attr.attr,
633 static struct attribute_group default_attr_group = {
634 .attrs = default_attrs,
637 static const struct attribute_group *default_attr_groups[] = {
642 int rnbd_clt_create_sysfs_files(void)
646 rnbd_dev_class = class_create(THIS_MODULE, "rnbd-client");
647 if (IS_ERR(rnbd_dev_class))
648 return PTR_ERR(rnbd_dev_class);
650 rnbd_dev = device_create_with_groups(rnbd_dev_class, NULL,
652 default_attr_groups, "ctl");
653 if (IS_ERR(rnbd_dev)) {
654 err = PTR_ERR(rnbd_dev);
657 rnbd_devs_kobj = kobject_create_and_add("devices", &rnbd_dev->kobj);
658 if (!rnbd_devs_kobj) {
666 device_destroy(rnbd_dev_class, MKDEV(0, 0));
668 class_destroy(rnbd_dev_class);
673 void rnbd_clt_destroy_sysfs_files(void)
675 sysfs_remove_group(&rnbd_dev->kobj, &default_attr_group);
676 kobject_del(rnbd_devs_kobj);
677 kobject_put(rnbd_devs_kobj);
678 device_destroy(rnbd_dev_class, MKDEV(0, 0));
679 class_destroy(rnbd_dev_class);