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/module.h>
14 #include <linux/blkdev.h>
15 #include <linux/hdreg.h>
16 #include <linux/scatterlist.h>
17 #include <linux/idr.h>
21 MODULE_DESCRIPTION("RDMA Network Block Device Client");
22 MODULE_LICENSE("GPL");
24 static int rnbd_client_major;
25 static DEFINE_IDA(index_ida);
26 static DEFINE_MUTEX(sess_lock);
27 static LIST_HEAD(sess_list);
28 static struct workqueue_struct *rnbd_clt_wq;
31 * Maximum number of partitions an instance can have.
32 * 6 bits = 64 minors = 63 partitions (one minor is used for the device itself)
34 #define RNBD_PART_BITS 6
36 static inline bool rnbd_clt_get_sess(struct rnbd_clt_session *sess)
38 return refcount_inc_not_zero(&sess->refcount);
41 static void free_sess(struct rnbd_clt_session *sess);
43 static void rnbd_clt_put_sess(struct rnbd_clt_session *sess)
47 if (refcount_dec_and_test(&sess->refcount))
51 static void rnbd_clt_put_dev(struct rnbd_clt_dev *dev)
55 if (!refcount_dec_and_test(&dev->refcount))
58 ida_free(&index_ida, dev->clt_device_id);
59 kfree(dev->hw_queues);
61 rnbd_clt_put_sess(dev->sess);
62 mutex_destroy(&dev->lock);
66 static inline bool rnbd_clt_get_dev(struct rnbd_clt_dev *dev)
68 return refcount_inc_not_zero(&dev->refcount);
71 static int rnbd_clt_set_dev_attr(struct rnbd_clt_dev *dev,
72 const struct rnbd_msg_open_rsp *rsp)
74 struct rnbd_clt_session *sess = dev->sess;
76 if (!rsp->logical_block_size)
79 dev->device_id = le32_to_cpu(rsp->device_id);
80 dev->nsectors = le64_to_cpu(rsp->nsectors);
81 dev->logical_block_size = le16_to_cpu(rsp->logical_block_size);
82 dev->physical_block_size = le16_to_cpu(rsp->physical_block_size);
83 dev->max_discard_sectors = le32_to_cpu(rsp->max_discard_sectors);
84 dev->discard_granularity = le32_to_cpu(rsp->discard_granularity);
85 dev->discard_alignment = le32_to_cpu(rsp->discard_alignment);
86 dev->secure_discard = le16_to_cpu(rsp->secure_discard);
87 dev->wc = !!(rsp->cache_policy & RNBD_WRITEBACK);
88 dev->fua = !!(rsp->cache_policy & RNBD_FUA);
90 dev->max_hw_sectors = sess->max_io_size / SECTOR_SIZE;
91 dev->max_segments = sess->max_segments;
96 static int rnbd_clt_change_capacity(struct rnbd_clt_dev *dev,
99 rnbd_clt_info(dev, "Device size changed from %zu to %zu sectors\n",
100 dev->nsectors, new_nsectors);
101 dev->nsectors = new_nsectors;
102 set_capacity_and_notify(dev->gd, dev->nsectors);
106 static int process_msg_open_rsp(struct rnbd_clt_dev *dev,
107 struct rnbd_msg_open_rsp *rsp)
109 struct kobject *gd_kobj;
112 mutex_lock(&dev->lock);
113 if (dev->dev_state == DEV_STATE_UNMAPPED) {
115 "Ignoring Open-Response message from server for unmapped device\n");
119 if (dev->dev_state == DEV_STATE_MAPPED_DISCONNECTED) {
120 u64 nsectors = le64_to_cpu(rsp->nsectors);
123 * If the device was remapped and the size changed in the
124 * meantime we need to revalidate it
126 if (dev->nsectors != nsectors)
127 rnbd_clt_change_capacity(dev, nsectors);
128 gd_kobj = &disk_to_dev(dev->gd)->kobj;
129 kobject_uevent(gd_kobj, KOBJ_ONLINE);
130 rnbd_clt_info(dev, "Device online, device remapped successfully\n");
132 err = rnbd_clt_set_dev_attr(dev, rsp);
135 dev->dev_state = DEV_STATE_MAPPED;
138 mutex_unlock(&dev->lock);
143 int rnbd_clt_resize_disk(struct rnbd_clt_dev *dev, size_t newsize)
147 mutex_lock(&dev->lock);
148 if (dev->dev_state != DEV_STATE_MAPPED) {
149 pr_err("Failed to set new size of the device, device is not opened\n");
153 ret = rnbd_clt_change_capacity(dev, newsize);
156 mutex_unlock(&dev->lock);
161 static inline void rnbd_clt_dev_requeue(struct rnbd_queue *q)
163 if (WARN_ON(!q->hctx))
166 /* We can come here from interrupt, thus async=true */
167 blk_mq_run_hw_queue(q->hctx, true);
171 RNBD_DELAY_IFBUSY = -1,
175 * rnbd_get_cpu_qlist() - finds a list with HW queues to be rerun
176 * @sess: Session to find a queue for
177 * @cpu: Cpu to start the search from
180 * Each CPU has a list of HW queues, which needs to be rerun. If a list
181 * is not empty - it is marked with a bit. This function finds first
182 * set bit in a bitmap and returns corresponding CPU list.
184 static struct rnbd_cpu_qlist *
185 rnbd_get_cpu_qlist(struct rnbd_clt_session *sess, int cpu)
189 /* Search from cpu to nr_cpu_ids */
190 bit = find_next_bit(sess->cpu_queues_bm, nr_cpu_ids, cpu);
191 if (bit < nr_cpu_ids) {
192 return per_cpu_ptr(sess->cpu_queues, bit);
193 } else if (cpu != 0) {
194 /* Search from 0 to cpu */
195 bit = find_first_bit(sess->cpu_queues_bm, cpu);
197 return per_cpu_ptr(sess->cpu_queues, bit);
203 static inline int nxt_cpu(int cpu)
205 return (cpu + 1) % nr_cpu_ids;
209 * rnbd_rerun_if_needed() - rerun next queue marked as stopped
210 * @sess: Session to rerun a queue on
213 * Each CPU has it's own list of HW queues, which should be rerun.
214 * Function finds such list with HW queues, takes a list lock, picks up
215 * the first HW queue out of the list and requeues it.
218 * True if the queue was requeued, false otherwise.
223 static bool rnbd_rerun_if_needed(struct rnbd_clt_session *sess)
225 struct rnbd_queue *q = NULL;
226 struct rnbd_cpu_qlist *cpu_q;
231 * To keep fairness and not to let other queues starve we always
232 * try to wake up someone else in round-robin manner. That of course
233 * increases latency but queues always have a chance to be executed.
235 cpup = get_cpu_ptr(sess->cpu_rr);
236 for (cpu_q = rnbd_get_cpu_qlist(sess, nxt_cpu(*cpup)); cpu_q;
237 cpu_q = rnbd_get_cpu_qlist(sess, nxt_cpu(cpu_q->cpu))) {
238 if (!spin_trylock_irqsave(&cpu_q->requeue_lock, flags))
240 if (!test_bit(cpu_q->cpu, sess->cpu_queues_bm))
242 q = list_first_entry_or_null(&cpu_q->requeue_list,
243 typeof(*q), requeue_list);
246 list_del_init(&q->requeue_list);
247 clear_bit_unlock(0, &q->in_list);
249 if (list_empty(&cpu_q->requeue_list)) {
250 /* Clear bit if nothing is left */
252 clear_bit(cpu_q->cpu, sess->cpu_queues_bm);
255 spin_unlock_irqrestore(&cpu_q->requeue_lock, flags);
262 * Saves the CPU that is going to be requeued on the per-cpu var. Just
263 * incrementing it doesn't work because rnbd_get_cpu_qlist() will
264 * always return the first CPU with something on the queue list when the
265 * value stored on the var is greater than the last CPU with something
270 put_cpu_ptr(sess->cpu_rr);
273 rnbd_clt_dev_requeue(q);
279 * rnbd_rerun_all_if_idle() - rerun all queues left in the list if
280 * session is idling (there are no requests
282 * @sess: Session to rerun the queues on
285 * This function tries to rerun all stopped queues if there are no
286 * requests in-flight anymore. This function tries to solve an obvious
287 * problem, when number of tags < than number of queues (hctx), which
288 * are stopped and put to sleep. If last permit, which has been just put,
289 * does not wake up all left queues (hctxs), IO requests hang forever.
291 * That can happen when all number of permits, say N, have been exhausted
292 * from one CPU, and we have many block devices per session, say M.
293 * Each block device has it's own queue (hctx) for each CPU, so eventually
294 * we can put that number of queues (hctxs) to sleep: M x nr_cpu_ids.
295 * If number of permits N < M x nr_cpu_ids finally we will get an IO hang.
297 * To avoid this hang last caller of rnbd_put_permit() (last caller is the
298 * one who observes sess->busy == 0) must wake up all remaining queues.
303 static void rnbd_rerun_all_if_idle(struct rnbd_clt_session *sess)
308 requeued = rnbd_rerun_if_needed(sess);
309 } while (atomic_read(&sess->busy) == 0 && requeued);
312 static struct rtrs_permit *rnbd_get_permit(struct rnbd_clt_session *sess,
313 enum rtrs_clt_con_type con_type,
316 struct rtrs_permit *permit;
318 permit = rtrs_clt_get_permit(sess->rtrs, con_type, wait);
320 /* We have a subtle rare case here, when all permits can be
321 * consumed before busy counter increased. This is safe,
322 * because loser will get NULL as a permit, observe 0 busy
323 * counter and immediately restart the queue himself.
325 atomic_inc(&sess->busy);
330 static void rnbd_put_permit(struct rnbd_clt_session *sess,
331 struct rtrs_permit *permit)
333 rtrs_clt_put_permit(sess->rtrs, permit);
334 atomic_dec(&sess->busy);
335 /* Paired with rnbd_clt_dev_add_to_requeue(). Decrement first
336 * and then check queue bits.
338 smp_mb__after_atomic();
339 rnbd_rerun_all_if_idle(sess);
342 static struct rnbd_iu *rnbd_get_iu(struct rnbd_clt_session *sess,
343 enum rtrs_clt_con_type con_type,
347 struct rtrs_permit *permit;
349 iu = kzalloc(sizeof(*iu), GFP_KERNEL);
353 permit = rnbd_get_permit(sess, con_type, wait);
361 * 1st reference is dropped after finishing sending a "user" message,
362 * 2nd reference is dropped after confirmation with the response is
364 * 1st and 2nd can happen in any order, so the rnbd_iu should be
365 * released (rtrs_permit returned to rtrs) only after both
368 atomic_set(&iu->refcount, 2);
369 init_waitqueue_head(&iu->comp.wait);
370 iu->comp.errno = INT_MAX;
372 if (sg_alloc_table(&iu->sgt, 1, GFP_KERNEL)) {
373 rnbd_put_permit(sess, permit);
381 static void rnbd_put_iu(struct rnbd_clt_session *sess, struct rnbd_iu *iu)
383 if (atomic_dec_and_test(&iu->refcount)) {
384 sg_free_table(&iu->sgt);
385 rnbd_put_permit(sess, iu->permit);
390 static void rnbd_softirq_done_fn(struct request *rq)
392 struct rnbd_clt_dev *dev = rq->q->disk->private_data;
393 struct rnbd_clt_session *sess = dev->sess;
396 iu = blk_mq_rq_to_pdu(rq);
397 sg_free_table_chained(&iu->sgt, RNBD_INLINE_SG_CNT);
398 rnbd_put_permit(sess, iu->permit);
399 blk_mq_end_request(rq, errno_to_blk_status(iu->errno));
402 static void msg_io_conf(void *priv, int errno)
404 struct rnbd_iu *iu = priv;
405 struct rnbd_clt_dev *dev = iu->dev;
406 struct request *rq = iu->rq;
407 int rw = rq_data_dir(rq);
411 blk_mq_complete_request(rq);
414 rnbd_clt_info_rl(dev, "%s I/O failed with err: %d\n",
415 rw == READ ? "read" : "write", errno);
418 static void wake_up_iu_comp(struct rnbd_iu *iu, int errno)
420 iu->comp.errno = errno;
421 wake_up(&iu->comp.wait);
424 static void msg_conf(void *priv, int errno)
426 struct rnbd_iu *iu = priv;
429 schedule_work(&iu->work);
432 static int send_usr_msg(struct rtrs_clt_sess *rtrs, int dir,
433 struct rnbd_iu *iu, struct kvec *vec,
434 size_t len, struct scatterlist *sg, unsigned int sg_len,
435 void (*conf)(struct work_struct *work),
436 int *errno, int wait)
439 struct rtrs_clt_req_ops req_ops;
441 INIT_WORK(&iu->work, conf);
442 req_ops = (struct rtrs_clt_req_ops) {
446 err = rtrs_clt_request(dir, &req_ops, rtrs, iu->permit,
447 vec, 1, len, sg, sg_len);
449 wait_event(iu->comp.wait, iu->comp.errno != INT_MAX);
450 *errno = iu->comp.errno;
458 static void msg_close_conf(struct work_struct *work)
460 struct rnbd_iu *iu = container_of(work, struct rnbd_iu, work);
461 struct rnbd_clt_dev *dev = iu->dev;
463 wake_up_iu_comp(iu, iu->errno);
464 rnbd_put_iu(dev->sess, iu);
465 rnbd_clt_put_dev(dev);
468 static int send_msg_close(struct rnbd_clt_dev *dev, u32 device_id,
471 struct rnbd_clt_session *sess = dev->sess;
472 struct rnbd_msg_close msg;
476 .iov_len = sizeof(msg)
480 iu = rnbd_get_iu(sess, RTRS_ADMIN_CON, RTRS_PERMIT_WAIT);
487 msg.hdr.type = cpu_to_le16(RNBD_MSG_CLOSE);
488 msg.device_id = cpu_to_le32(device_id);
490 WARN_ON(!rnbd_clt_get_dev(dev));
491 err = send_usr_msg(sess->rtrs, WRITE, iu, &vec, 0, NULL, 0,
492 msg_close_conf, &errno, wait);
494 rnbd_clt_put_dev(dev);
495 rnbd_put_iu(sess, iu);
500 rnbd_put_iu(sess, iu);
504 static void msg_open_conf(struct work_struct *work)
506 struct rnbd_iu *iu = container_of(work, struct rnbd_iu, work);
507 struct rnbd_msg_open_rsp *rsp = iu->buf;
508 struct rnbd_clt_dev *dev = iu->dev;
509 int errno = iu->errno;
513 "Opening failed, server responded: %d\n",
516 errno = process_msg_open_rsp(dev, rsp);
518 u32 device_id = le32_to_cpu(rsp->device_id);
520 * If server thinks its fine, but we fail to process
521 * then be nice and send a close to server.
523 send_msg_close(dev, device_id, RTRS_PERMIT_NOWAIT);
527 wake_up_iu_comp(iu, errno);
528 rnbd_put_iu(dev->sess, iu);
529 rnbd_clt_put_dev(dev);
532 static void msg_sess_info_conf(struct work_struct *work)
534 struct rnbd_iu *iu = container_of(work, struct rnbd_iu, work);
535 struct rnbd_msg_sess_info_rsp *rsp = iu->buf;
536 struct rnbd_clt_session *sess = iu->sess;
539 sess->ver = min_t(u8, rsp->ver, RNBD_PROTO_VER_MAJOR);
542 wake_up_iu_comp(iu, iu->errno);
543 rnbd_put_iu(sess, iu);
544 rnbd_clt_put_sess(sess);
547 static int send_msg_open(struct rnbd_clt_dev *dev, enum wait_type wait)
549 struct rnbd_clt_session *sess = dev->sess;
550 struct rnbd_msg_open_rsp *rsp;
551 struct rnbd_msg_open msg;
555 .iov_len = sizeof(msg)
559 rsp = kzalloc(sizeof(*rsp), GFP_KERNEL);
563 iu = rnbd_get_iu(sess, RTRS_ADMIN_CON, RTRS_PERMIT_WAIT);
572 sg_init_one(iu->sgt.sgl, rsp, sizeof(*rsp));
574 msg.hdr.type = cpu_to_le16(RNBD_MSG_OPEN);
575 msg.access_mode = dev->access_mode;
576 strscpy(msg.dev_name, dev->pathname, sizeof(msg.dev_name));
578 WARN_ON(!rnbd_clt_get_dev(dev));
579 err = send_usr_msg(sess->rtrs, READ, iu,
580 &vec, sizeof(*rsp), iu->sgt.sgl, 1,
581 msg_open_conf, &errno, wait);
583 rnbd_clt_put_dev(dev);
584 rnbd_put_iu(sess, iu);
590 rnbd_put_iu(sess, iu);
594 static int send_msg_sess_info(struct rnbd_clt_session *sess, enum wait_type wait)
596 struct rnbd_msg_sess_info_rsp *rsp;
597 struct rnbd_msg_sess_info msg;
601 .iov_len = sizeof(msg)
605 rsp = kzalloc(sizeof(*rsp), GFP_KERNEL);
609 iu = rnbd_get_iu(sess, RTRS_ADMIN_CON, RTRS_PERMIT_WAIT);
617 sg_init_one(iu->sgt.sgl, rsp, sizeof(*rsp));
619 msg.hdr.type = cpu_to_le16(RNBD_MSG_SESS_INFO);
620 msg.ver = RNBD_PROTO_VER_MAJOR;
622 if (!rnbd_clt_get_sess(sess)) {
624 * That can happen only in one case, when RTRS has restablished
625 * the connection and link_ev() is called, but session is almost
626 * dead, last reference on session is put and caller is waiting
627 * for RTRS to close everything.
632 err = send_usr_msg(sess->rtrs, READ, iu,
633 &vec, sizeof(*rsp), iu->sgt.sgl, 1,
634 msg_sess_info_conf, &errno, wait);
636 rnbd_clt_put_sess(sess);
638 rnbd_put_iu(sess, iu);
643 rnbd_put_iu(sess, iu);
647 static void set_dev_states_to_disconnected(struct rnbd_clt_session *sess)
649 struct rnbd_clt_dev *dev;
650 struct kobject *gd_kobj;
652 mutex_lock(&sess->lock);
653 list_for_each_entry(dev, &sess->devs_list, list) {
654 rnbd_clt_err(dev, "Device disconnected.\n");
656 mutex_lock(&dev->lock);
657 if (dev->dev_state == DEV_STATE_MAPPED) {
658 dev->dev_state = DEV_STATE_MAPPED_DISCONNECTED;
659 gd_kobj = &disk_to_dev(dev->gd)->kobj;
660 kobject_uevent(gd_kobj, KOBJ_OFFLINE);
662 mutex_unlock(&dev->lock);
664 mutex_unlock(&sess->lock);
667 static void remap_devs(struct rnbd_clt_session *sess)
669 struct rnbd_clt_dev *dev;
670 struct rtrs_attrs attrs;
674 * Careful here: we are called from RTRS link event directly,
675 * thus we can't send any RTRS request and wait for response
676 * or RTRS will not be able to complete request with failure
677 * if something goes wrong (failing of outstanding requests
678 * happens exactly from the context where we are blocking now).
680 * So to avoid deadlocks each usr message sent from here must
684 err = send_msg_sess_info(sess, RTRS_PERMIT_NOWAIT);
686 pr_err("send_msg_sess_info(\"%s\"): %d\n", sess->sessname, err);
690 err = rtrs_clt_query(sess->rtrs, &attrs);
692 pr_err("rtrs_clt_query(\"%s\"): %d\n", sess->sessname, err);
695 mutex_lock(&sess->lock);
696 sess->max_io_size = attrs.max_io_size;
698 list_for_each_entry(dev, &sess->devs_list, list) {
701 mutex_lock(&dev->lock);
702 skip = (dev->dev_state == DEV_STATE_INIT);
703 mutex_unlock(&dev->lock);
706 * When device is establishing connection for the first
707 * time - do not remap, it will be closed soon.
711 rnbd_clt_info(dev, "session reconnected, remapping device\n");
712 err = send_msg_open(dev, RTRS_PERMIT_NOWAIT);
714 rnbd_clt_err(dev, "send_msg_open(): %d\n", err);
718 mutex_unlock(&sess->lock);
721 static void rnbd_clt_link_ev(void *priv, enum rtrs_clt_link_ev ev)
723 struct rnbd_clt_session *sess = priv;
726 case RTRS_CLT_LINK_EV_DISCONNECTED:
727 set_dev_states_to_disconnected(sess);
729 case RTRS_CLT_LINK_EV_RECONNECTED:
733 pr_err("Unknown session event received (%d), session: %s\n",
738 static void rnbd_init_cpu_qlists(struct rnbd_cpu_qlist __percpu *cpu_queues)
741 struct rnbd_cpu_qlist *cpu_q;
743 for_each_possible_cpu(cpu) {
744 cpu_q = per_cpu_ptr(cpu_queues, cpu);
747 INIT_LIST_HEAD(&cpu_q->requeue_list);
748 spin_lock_init(&cpu_q->requeue_lock);
752 static void destroy_mq_tags(struct rnbd_clt_session *sess)
754 if (sess->tag_set.tags)
755 blk_mq_free_tag_set(&sess->tag_set);
758 static inline void wake_up_rtrs_waiters(struct rnbd_clt_session *sess)
760 sess->rtrs_ready = true;
761 wake_up_all(&sess->rtrs_waitq);
764 static void close_rtrs(struct rnbd_clt_session *sess)
768 if (!IS_ERR_OR_NULL(sess->rtrs)) {
769 rtrs_clt_close(sess->rtrs);
771 wake_up_rtrs_waiters(sess);
775 static void free_sess(struct rnbd_clt_session *sess)
777 WARN_ON(!list_empty(&sess->devs_list));
782 destroy_mq_tags(sess);
783 if (!list_empty(&sess->list)) {
784 mutex_lock(&sess_lock);
785 list_del(&sess->list);
786 mutex_unlock(&sess_lock);
788 free_percpu(sess->cpu_queues);
789 free_percpu(sess->cpu_rr);
790 mutex_destroy(&sess->lock);
794 static struct rnbd_clt_session *alloc_sess(const char *sessname)
796 struct rnbd_clt_session *sess;
799 sess = kzalloc_node(sizeof(*sess), GFP_KERNEL, NUMA_NO_NODE);
801 return ERR_PTR(-ENOMEM);
802 strscpy(sess->sessname, sessname, sizeof(sess->sessname));
803 atomic_set(&sess->busy, 0);
804 mutex_init(&sess->lock);
805 INIT_LIST_HEAD(&sess->devs_list);
806 INIT_LIST_HEAD(&sess->list);
807 bitmap_zero(sess->cpu_queues_bm, num_possible_cpus());
808 init_waitqueue_head(&sess->rtrs_waitq);
809 refcount_set(&sess->refcount, 1);
811 sess->cpu_queues = alloc_percpu(struct rnbd_cpu_qlist);
812 if (!sess->cpu_queues) {
816 rnbd_init_cpu_qlists(sess->cpu_queues);
819 * That is simple percpu variable which stores cpu indices, which are
820 * incremented on each access. We need that for the sake of fairness
821 * to wake up queues in a round-robin manner.
823 sess->cpu_rr = alloc_percpu(int);
828 for_each_possible_cpu(cpu)
829 * per_cpu_ptr(sess->cpu_rr, cpu) = cpu;
839 static int wait_for_rtrs_connection(struct rnbd_clt_session *sess)
841 wait_event(sess->rtrs_waitq, sess->rtrs_ready);
842 if (IS_ERR_OR_NULL(sess->rtrs))
848 static void wait_for_rtrs_disconnection(struct rnbd_clt_session *sess)
849 __releases(&sess_lock)
850 __acquires(&sess_lock)
854 prepare_to_wait(&sess->rtrs_waitq, &wait, TASK_UNINTERRUPTIBLE);
855 if (IS_ERR_OR_NULL(sess->rtrs)) {
856 finish_wait(&sess->rtrs_waitq, &wait);
859 mutex_unlock(&sess_lock);
860 /* loop in caller, see __find_and_get_sess().
861 * You can't leave mutex locked and call schedule(), you will catch a
862 * deadlock with a caller of free_sess(), which has just put the last
863 * reference and is about to take the sess_lock in order to delete
864 * the session from the list.
867 mutex_lock(&sess_lock);
870 static struct rnbd_clt_session *__find_and_get_sess(const char *sessname)
871 __releases(&sess_lock)
872 __acquires(&sess_lock)
874 struct rnbd_clt_session *sess, *sn;
878 list_for_each_entry_safe(sess, sn, &sess_list, list) {
879 if (strcmp(sessname, sess->sessname))
882 if (sess->rtrs_ready && IS_ERR_OR_NULL(sess->rtrs))
884 * No RTRS connection, session is dying.
888 if (rnbd_clt_get_sess(sess)) {
890 * Alive session is found, wait for RTRS connection.
892 mutex_unlock(&sess_lock);
893 err = wait_for_rtrs_connection(sess);
895 rnbd_clt_put_sess(sess);
896 mutex_lock(&sess_lock);
899 /* Session is dying, repeat the loop */
905 * Ref is 0, session is dying, wait for RTRS disconnect
906 * in order to avoid session names clashes.
908 wait_for_rtrs_disconnection(sess);
910 * RTRS is disconnected and soon session will be freed,
919 /* caller is responsible for initializing 'first' to false */
921 rnbd_clt_session *find_or_create_sess(const char *sessname, bool *first)
923 struct rnbd_clt_session *sess = NULL;
925 mutex_lock(&sess_lock);
926 sess = __find_and_get_sess(sessname);
928 sess = alloc_sess(sessname);
930 mutex_unlock(&sess_lock);
933 list_add(&sess->list, &sess_list);
936 mutex_unlock(&sess_lock);
941 static int rnbd_client_open(struct block_device *block_device, fmode_t mode)
943 struct rnbd_clt_dev *dev = block_device->bd_disk->private_data;
945 if (dev->read_only && (mode & FMODE_WRITE))
948 if (dev->dev_state == DEV_STATE_UNMAPPED ||
949 !rnbd_clt_get_dev(dev))
955 static void rnbd_client_release(struct gendisk *gen, fmode_t mode)
957 struct rnbd_clt_dev *dev = gen->private_data;
959 rnbd_clt_put_dev(dev);
962 static int rnbd_client_getgeo(struct block_device *block_device,
963 struct hd_geometry *geo)
966 struct rnbd_clt_dev *dev;
968 dev = block_device->bd_disk->private_data;
969 size = dev->size * (dev->logical_block_size / SECTOR_SIZE);
970 geo->cylinders = size >> 6; /* size/64 */
978 static const struct block_device_operations rnbd_client_ops = {
979 .owner = THIS_MODULE,
980 .open = rnbd_client_open,
981 .release = rnbd_client_release,
982 .getgeo = rnbd_client_getgeo
985 /* The amount of data that belongs to an I/O and the amount of data that
986 * should be read or written to the disk (bi_size) can differ.
988 * E.g. When WRITE_SAME is used, only a small amount of data is
989 * transferred that is then written repeatedly over a lot of sectors.
991 * Get the size of data to be transferred via RTRS by summing up the size
992 * of the scather-gather list entries.
994 static size_t rnbd_clt_get_sg_size(struct scatterlist *sglist, u32 len)
996 struct scatterlist *sg;
1000 for_each_sg(sglist, sg, len, i)
1001 tsize += sg->length;
1005 static int rnbd_client_xfer_request(struct rnbd_clt_dev *dev,
1009 struct rtrs_clt_sess *rtrs = dev->sess->rtrs;
1010 struct rtrs_permit *permit = iu->permit;
1011 struct rnbd_msg_io msg;
1012 struct rtrs_clt_req_ops req_ops;
1013 unsigned int sg_cnt = 0;
1020 msg.sector = cpu_to_le64(blk_rq_pos(rq));
1021 msg.bi_size = cpu_to_le32(blk_rq_bytes(rq));
1022 msg.rw = cpu_to_le32(rq_to_rnbd_flags(rq));
1023 msg.prio = cpu_to_le16(req_get_ioprio(rq));
1026 * We only support discards with single segment for now.
1029 if (req_op(rq) != REQ_OP_DISCARD)
1030 sg_cnt = blk_rq_map_sg(dev->queue, rq, iu->sgt.sgl);
1033 sg_mark_end(&iu->sgt.sgl[0]);
1035 msg.hdr.type = cpu_to_le16(RNBD_MSG_IO);
1036 msg.device_id = cpu_to_le32(dev->device_id);
1038 vec = (struct kvec) {
1040 .iov_len = sizeof(msg)
1042 size = rnbd_clt_get_sg_size(iu->sgt.sgl, sg_cnt);
1043 req_ops = (struct rtrs_clt_req_ops) {
1045 .conf_fn = msg_io_conf,
1047 err = rtrs_clt_request(rq_data_dir(rq), &req_ops, rtrs, permit,
1048 &vec, 1, size, iu->sgt.sgl, sg_cnt);
1050 rnbd_clt_err_rl(dev, "RTRS failed to transfer IO, err: %d\n",
1059 * rnbd_clt_dev_add_to_requeue() - add device to requeue if session is busy
1060 * @dev: Device to be checked
1061 * @q: Queue to be added to the requeue list if required
1064 * If session is busy, that means someone will requeue us when resources
1065 * are freed. If session is not doing anything - device is not added to
1066 * the list and @false is returned.
1068 static bool rnbd_clt_dev_add_to_requeue(struct rnbd_clt_dev *dev,
1069 struct rnbd_queue *q)
1071 struct rnbd_clt_session *sess = dev->sess;
1072 struct rnbd_cpu_qlist *cpu_q;
1073 unsigned long flags;
1077 cpu_q = get_cpu_ptr(sess->cpu_queues);
1078 spin_lock_irqsave(&cpu_q->requeue_lock, flags);
1080 if (!test_and_set_bit_lock(0, &q->in_list)) {
1081 if (WARN_ON(!list_empty(&q->requeue_list)))
1084 need_set = !test_bit(cpu_q->cpu, sess->cpu_queues_bm);
1086 set_bit(cpu_q->cpu, sess->cpu_queues_bm);
1087 /* Paired with rnbd_put_permit(). Set a bit first
1088 * and then observe the busy counter.
1090 smp_mb__before_atomic();
1092 if (atomic_read(&sess->busy)) {
1093 list_add_tail(&q->requeue_list, &cpu_q->requeue_list);
1095 /* Very unlikely, but possible: busy counter was
1096 * observed as zero. Drop all bits and return
1097 * false to restart the queue by ourselves.
1100 clear_bit(cpu_q->cpu, sess->cpu_queues_bm);
1101 clear_bit_unlock(0, &q->in_list);
1106 spin_unlock_irqrestore(&cpu_q->requeue_lock, flags);
1107 put_cpu_ptr(sess->cpu_queues);
1112 static void rnbd_clt_dev_kick_mq_queue(struct rnbd_clt_dev *dev,
1113 struct blk_mq_hw_ctx *hctx,
1116 struct rnbd_queue *q = hctx->driver_data;
1118 if (delay != RNBD_DELAY_IFBUSY)
1119 blk_mq_delay_run_hw_queue(hctx, delay);
1120 else if (!rnbd_clt_dev_add_to_requeue(dev, q))
1122 * If session is not busy we have to restart
1123 * the queue ourselves.
1125 blk_mq_delay_run_hw_queue(hctx, 10/*ms*/);
1128 static blk_status_t rnbd_queue_rq(struct blk_mq_hw_ctx *hctx,
1129 const struct blk_mq_queue_data *bd)
1131 struct request *rq = bd->rq;
1132 struct rnbd_clt_dev *dev = rq->q->disk->private_data;
1133 struct rnbd_iu *iu = blk_mq_rq_to_pdu(rq);
1135 blk_status_t ret = BLK_STS_IOERR;
1137 if (dev->dev_state != DEV_STATE_MAPPED)
1138 return BLK_STS_IOERR;
1140 iu->permit = rnbd_get_permit(dev->sess, RTRS_IO_CON,
1141 RTRS_PERMIT_NOWAIT);
1143 rnbd_clt_dev_kick_mq_queue(dev, hctx, RNBD_DELAY_IFBUSY);
1144 return BLK_STS_RESOURCE;
1147 iu->sgt.sgl = iu->first_sgl;
1148 err = sg_alloc_table_chained(&iu->sgt,
1149 /* Even-if the request has no segment,
1150 * sglist must have one entry at least.
1152 blk_rq_nr_phys_segments(rq) ? : 1,
1154 RNBD_INLINE_SG_CNT);
1156 rnbd_clt_err_rl(dev, "sg_alloc_table_chained ret=%d\n", err);
1157 rnbd_clt_dev_kick_mq_queue(dev, hctx, 10/*ms*/);
1158 rnbd_put_permit(dev->sess, iu->permit);
1159 return BLK_STS_RESOURCE;
1162 blk_mq_start_request(rq);
1163 err = rnbd_client_xfer_request(dev, rq, iu);
1166 if (err == -EAGAIN || err == -ENOMEM) {
1167 rnbd_clt_dev_kick_mq_queue(dev, hctx, 10/*ms*/);
1168 ret = BLK_STS_RESOURCE;
1170 sg_free_table_chained(&iu->sgt, RNBD_INLINE_SG_CNT);
1171 rnbd_put_permit(dev->sess, iu->permit);
1175 static int rnbd_rdma_poll(struct blk_mq_hw_ctx *hctx, struct io_comp_batch *iob)
1177 struct rnbd_queue *q = hctx->driver_data;
1178 struct rnbd_clt_dev *dev = q->dev;
1181 cnt = rtrs_clt_rdma_cq_direct(dev->sess->rtrs, hctx->queue_num);
1185 static int rnbd_rdma_map_queues(struct blk_mq_tag_set *set)
1187 struct rnbd_clt_session *sess = set->driver_data;
1189 /* shared read/write queues */
1190 set->map[HCTX_TYPE_DEFAULT].nr_queues = num_online_cpus();
1191 set->map[HCTX_TYPE_DEFAULT].queue_offset = 0;
1192 set->map[HCTX_TYPE_READ].nr_queues = num_online_cpus();
1193 set->map[HCTX_TYPE_READ].queue_offset = 0;
1194 blk_mq_map_queues(&set->map[HCTX_TYPE_DEFAULT]);
1195 blk_mq_map_queues(&set->map[HCTX_TYPE_READ]);
1197 if (sess->nr_poll_queues) {
1198 /* dedicated queue for poll */
1199 set->map[HCTX_TYPE_POLL].nr_queues = sess->nr_poll_queues;
1200 set->map[HCTX_TYPE_POLL].queue_offset = set->map[HCTX_TYPE_READ].queue_offset +
1201 set->map[HCTX_TYPE_READ].nr_queues;
1202 blk_mq_map_queues(&set->map[HCTX_TYPE_POLL]);
1203 pr_info("[session=%s] mapped %d/%d/%d default/read/poll queues.\n",
1205 set->map[HCTX_TYPE_DEFAULT].nr_queues,
1206 set->map[HCTX_TYPE_READ].nr_queues,
1207 set->map[HCTX_TYPE_POLL].nr_queues);
1209 pr_info("[session=%s] mapped %d/%d default/read queues.\n",
1211 set->map[HCTX_TYPE_DEFAULT].nr_queues,
1212 set->map[HCTX_TYPE_READ].nr_queues);
1218 static struct blk_mq_ops rnbd_mq_ops = {
1219 .queue_rq = rnbd_queue_rq,
1220 .complete = rnbd_softirq_done_fn,
1221 .map_queues = rnbd_rdma_map_queues,
1222 .poll = rnbd_rdma_poll,
1225 static int setup_mq_tags(struct rnbd_clt_session *sess)
1227 struct blk_mq_tag_set *tag_set = &sess->tag_set;
1229 memset(tag_set, 0, sizeof(*tag_set));
1230 tag_set->ops = &rnbd_mq_ops;
1231 tag_set->queue_depth = sess->queue_depth;
1232 tag_set->numa_node = NUMA_NO_NODE;
1233 tag_set->flags = BLK_MQ_F_SHOULD_MERGE |
1234 BLK_MQ_F_TAG_QUEUE_SHARED;
1235 tag_set->cmd_size = sizeof(struct rnbd_iu) + RNBD_RDMA_SGL_SIZE;
1237 /* for HCTX_TYPE_DEFAULT, HCTX_TYPE_READ, HCTX_TYPE_POLL */
1238 tag_set->nr_maps = sess->nr_poll_queues ? HCTX_MAX_TYPES : 2;
1240 * HCTX_TYPE_DEFAULT and HCTX_TYPE_READ share one set of queues
1241 * others are for HCTX_TYPE_POLL
1243 tag_set->nr_hw_queues = num_online_cpus() + sess->nr_poll_queues;
1244 tag_set->driver_data = sess;
1246 return blk_mq_alloc_tag_set(tag_set);
1249 static struct rnbd_clt_session *
1250 find_and_get_or_create_sess(const char *sessname,
1251 const struct rtrs_addr *paths,
1252 size_t path_cnt, u16 port_nr, u32 nr_poll_queues)
1254 struct rnbd_clt_session *sess;
1255 struct rtrs_attrs attrs;
1258 struct rtrs_clt_ops rtrs_ops;
1260 sess = find_or_create_sess(sessname, &first);
1261 if (sess == ERR_PTR(-ENOMEM)) {
1262 return ERR_PTR(-ENOMEM);
1263 } else if ((nr_poll_queues && !first) || (!nr_poll_queues && sess->nr_poll_queues)) {
1265 * A device MUST have its own session to use the polling-mode.
1266 * It must fail to map new device with the same session.
1276 pr_err("Session %s not found, and path parameter not given", sessname);
1281 rtrs_ops = (struct rtrs_clt_ops) {
1283 .link_ev = rnbd_clt_link_ev,
1286 * Nothing was found, establish rtrs connection and proceed further.
1288 sess->rtrs = rtrs_clt_open(&rtrs_ops, sessname,
1289 paths, path_cnt, port_nr,
1290 0, /* Do not use pdu of rtrs */
1292 MAX_RECONNECTS, nr_poll_queues);
1293 if (IS_ERR(sess->rtrs)) {
1294 err = PTR_ERR(sess->rtrs);
1295 goto wake_up_and_put;
1298 err = rtrs_clt_query(sess->rtrs, &attrs);
1302 sess->max_io_size = attrs.max_io_size;
1303 sess->queue_depth = attrs.queue_depth;
1304 sess->nr_poll_queues = nr_poll_queues;
1305 sess->max_segments = attrs.max_segments;
1307 err = setup_mq_tags(sess);
1311 err = send_msg_sess_info(sess, RTRS_PERMIT_WAIT);
1315 wake_up_rtrs_waiters(sess);
1322 rnbd_clt_put_sess(sess);
1324 return ERR_PTR(err);
1327 wake_up_rtrs_waiters(sess);
1331 static inline void rnbd_init_hw_queue(struct rnbd_clt_dev *dev,
1332 struct rnbd_queue *q,
1333 struct blk_mq_hw_ctx *hctx)
1335 INIT_LIST_HEAD(&q->requeue_list);
1340 static void rnbd_init_mq_hw_queues(struct rnbd_clt_dev *dev)
1343 struct blk_mq_hw_ctx *hctx;
1344 struct rnbd_queue *q;
1346 queue_for_each_hw_ctx(dev->queue, hctx, i) {
1347 q = &dev->hw_queues[i];
1348 rnbd_init_hw_queue(dev, q, hctx);
1349 hctx->driver_data = q;
1353 static void setup_request_queue(struct rnbd_clt_dev *dev)
1355 blk_queue_logical_block_size(dev->queue, dev->logical_block_size);
1356 blk_queue_physical_block_size(dev->queue, dev->physical_block_size);
1357 blk_queue_max_hw_sectors(dev->queue, dev->max_hw_sectors);
1360 * we don't support discards to "discontiguous" segments
1363 blk_queue_max_discard_segments(dev->queue, 1);
1365 blk_queue_max_discard_sectors(dev->queue, dev->max_discard_sectors);
1366 dev->queue->limits.discard_granularity = dev->discard_granularity;
1367 dev->queue->limits.discard_alignment = dev->discard_alignment;
1368 if (dev->secure_discard)
1369 blk_queue_max_secure_erase_sectors(dev->queue,
1370 dev->max_discard_sectors);
1371 blk_queue_flag_set(QUEUE_FLAG_SAME_COMP, dev->queue);
1372 blk_queue_flag_set(QUEUE_FLAG_SAME_FORCE, dev->queue);
1373 blk_queue_max_segments(dev->queue, dev->max_segments);
1374 blk_queue_io_opt(dev->queue, dev->sess->max_io_size);
1375 blk_queue_virt_boundary(dev->queue, SZ_4K - 1);
1376 blk_queue_write_cache(dev->queue, dev->wc, dev->fua);
1379 static int rnbd_clt_setup_gen_disk(struct rnbd_clt_dev *dev, int idx)
1383 dev->gd->major = rnbd_client_major;
1384 dev->gd->first_minor = idx << RNBD_PART_BITS;
1385 dev->gd->minors = 1 << RNBD_PART_BITS;
1386 dev->gd->fops = &rnbd_client_ops;
1387 dev->gd->queue = dev->queue;
1388 dev->gd->private_data = dev;
1389 snprintf(dev->gd->disk_name, sizeof(dev->gd->disk_name), "rnbd%d",
1391 pr_debug("disk_name=%s, capacity=%zu\n",
1393 dev->nsectors * (dev->logical_block_size / SECTOR_SIZE)
1396 set_capacity(dev->gd, dev->nsectors);
1398 if (dev->access_mode == RNBD_ACCESS_RO) {
1399 dev->read_only = true;
1400 set_disk_ro(dev->gd, true);
1402 dev->read_only = false;
1406 * Network device does not need rotational
1408 blk_queue_flag_set(QUEUE_FLAG_NONROT, dev->queue);
1409 err = add_disk(dev->gd);
1411 blk_cleanup_disk(dev->gd);
1416 static int rnbd_client_setup_device(struct rnbd_clt_dev *dev)
1418 int idx = dev->clt_device_id;
1420 dev->size = dev->nsectors * dev->logical_block_size;
1422 dev->gd = blk_mq_alloc_disk(&dev->sess->tag_set, dev);
1423 if (IS_ERR(dev->gd))
1424 return PTR_ERR(dev->gd);
1425 dev->queue = dev->gd->queue;
1426 rnbd_init_mq_hw_queues(dev);
1428 setup_request_queue(dev);
1429 return rnbd_clt_setup_gen_disk(dev, idx);
1432 static struct rnbd_clt_dev *init_dev(struct rnbd_clt_session *sess,
1433 enum rnbd_access_mode access_mode,
1434 const char *pathname,
1437 struct rnbd_clt_dev *dev;
1440 dev = kzalloc_node(sizeof(*dev), GFP_KERNEL, NUMA_NO_NODE);
1442 return ERR_PTR(-ENOMEM);
1445 * nr_cpu_ids: the number of softirq queues
1446 * nr_poll_queues: the number of polling queues
1448 dev->hw_queues = kcalloc(nr_cpu_ids + nr_poll_queues,
1449 sizeof(*dev->hw_queues),
1451 if (!dev->hw_queues) {
1456 ret = ida_alloc_max(&index_ida, 1 << (MINORBITS - RNBD_PART_BITS),
1459 pr_err("Failed to initialize device '%s' from session %s, allocating idr failed, err: %d\n",
1460 pathname, sess->sessname, ret);
1464 dev->pathname = kstrdup(pathname, GFP_KERNEL);
1465 if (!dev->pathname) {
1470 dev->clt_device_id = ret;
1472 dev->access_mode = access_mode;
1473 dev->nr_poll_queues = nr_poll_queues;
1474 mutex_init(&dev->lock);
1475 refcount_set(&dev->refcount, 1);
1476 dev->dev_state = DEV_STATE_INIT;
1479 * Here we called from sysfs entry, thus clt-sysfs is
1480 * responsible that session will not disappear.
1482 WARN_ON(!rnbd_clt_get_sess(sess));
1487 kfree(dev->hw_queues);
1490 return ERR_PTR(ret);
1493 static bool __exists_dev(const char *pathname, const char *sessname)
1495 struct rnbd_clt_session *sess;
1496 struct rnbd_clt_dev *dev;
1499 list_for_each_entry(sess, &sess_list, list) {
1500 if (sessname && strncmp(sess->sessname, sessname,
1501 sizeof(sess->sessname)))
1503 mutex_lock(&sess->lock);
1504 list_for_each_entry(dev, &sess->devs_list, list) {
1505 if (strlen(dev->pathname) == strlen(pathname) &&
1506 !strcmp(dev->pathname, pathname)) {
1511 mutex_unlock(&sess->lock);
1519 static bool exists_devpath(const char *pathname, const char *sessname)
1523 mutex_lock(&sess_lock);
1524 found = __exists_dev(pathname, sessname);
1525 mutex_unlock(&sess_lock);
1530 static bool insert_dev_if_not_exists_devpath(struct rnbd_clt_dev *dev)
1533 struct rnbd_clt_session *sess = dev->sess;
1535 mutex_lock(&sess_lock);
1536 found = __exists_dev(dev->pathname, sess->sessname);
1538 mutex_lock(&sess->lock);
1539 list_add_tail(&dev->list, &sess->devs_list);
1540 mutex_unlock(&sess->lock);
1542 mutex_unlock(&sess_lock);
1547 static void delete_dev(struct rnbd_clt_dev *dev)
1549 struct rnbd_clt_session *sess = dev->sess;
1551 mutex_lock(&sess->lock);
1552 list_del(&dev->list);
1553 mutex_unlock(&sess->lock);
1556 struct rnbd_clt_dev *rnbd_clt_map_device(const char *sessname,
1557 struct rtrs_addr *paths,
1558 size_t path_cnt, u16 port_nr,
1559 const char *pathname,
1560 enum rnbd_access_mode access_mode,
1563 struct rnbd_clt_session *sess;
1564 struct rnbd_clt_dev *dev;
1567 if (exists_devpath(pathname, sessname))
1568 return ERR_PTR(-EEXIST);
1570 sess = find_and_get_or_create_sess(sessname, paths, path_cnt, port_nr, nr_poll_queues);
1572 return ERR_CAST(sess);
1574 dev = init_dev(sess, access_mode, pathname, nr_poll_queues);
1576 pr_err("map_device: failed to map device '%s' from session %s, can't initialize device, err: %ld\n",
1577 pathname, sess->sessname, PTR_ERR(dev));
1581 if (insert_dev_if_not_exists_devpath(dev)) {
1585 ret = send_msg_open(dev, RTRS_PERMIT_WAIT);
1588 "map_device: failed, can't open remote device, err: %d\n",
1592 mutex_lock(&dev->lock);
1593 pr_debug("Opened remote device: session=%s, path='%s'\n",
1594 sess->sessname, pathname);
1595 ret = rnbd_client_setup_device(dev);
1598 "map_device: Failed to configure device, err: %d\n",
1600 mutex_unlock(&dev->lock);
1605 "map_device: Device mapped as %s (nsectors: %zu, logical_block_size: %d, physical_block_size: %d, max_discard_sectors: %d, discard_granularity: %d, discard_alignment: %d, secure_discard: %d, max_segments: %d, max_hw_sectors: %d, wc: %d, fua: %d)\n",
1606 dev->gd->disk_name, dev->nsectors,
1607 dev->logical_block_size, dev->physical_block_size,
1608 dev->max_discard_sectors,
1609 dev->discard_granularity, dev->discard_alignment,
1610 dev->secure_discard, dev->max_segments,
1611 dev->max_hw_sectors, dev->wc, dev->fua);
1613 mutex_unlock(&dev->lock);
1614 rnbd_clt_put_sess(sess);
1619 send_msg_close(dev, dev->device_id, RTRS_PERMIT_WAIT);
1623 rnbd_clt_put_dev(dev);
1625 rnbd_clt_put_sess(sess);
1627 return ERR_PTR(ret);
1630 static void destroy_gen_disk(struct rnbd_clt_dev *dev)
1632 del_gendisk(dev->gd);
1633 blk_cleanup_disk(dev->gd);
1636 static void destroy_sysfs(struct rnbd_clt_dev *dev,
1637 const struct attribute *sysfs_self)
1639 rnbd_clt_remove_dev_symlink(dev);
1640 if (dev->kobj.state_initialized) {
1642 /* To avoid deadlock firstly remove itself */
1643 sysfs_remove_file_self(&dev->kobj, sysfs_self);
1644 kobject_del(&dev->kobj);
1645 kobject_put(&dev->kobj);
1649 int rnbd_clt_unmap_device(struct rnbd_clt_dev *dev, bool force,
1650 const struct attribute *sysfs_self)
1652 struct rnbd_clt_session *sess = dev->sess;
1653 int refcount, ret = 0;
1656 mutex_lock(&dev->lock);
1657 if (dev->dev_state == DEV_STATE_UNMAPPED) {
1658 rnbd_clt_info(dev, "Device is already being unmapped\n");
1662 refcount = refcount_read(&dev->refcount);
1663 if (!force && refcount > 1) {
1665 "Closing device failed, device is in use, (%d device users)\n",
1670 was_mapped = (dev->dev_state == DEV_STATE_MAPPED);
1671 dev->dev_state = DEV_STATE_UNMAPPED;
1672 mutex_unlock(&dev->lock);
1675 destroy_sysfs(dev, sysfs_self);
1676 destroy_gen_disk(dev);
1677 if (was_mapped && sess->rtrs)
1678 send_msg_close(dev, dev->device_id, RTRS_PERMIT_WAIT);
1680 rnbd_clt_info(dev, "Device is unmapped\n");
1682 /* Likely last reference put */
1683 rnbd_clt_put_dev(dev);
1686 * Here device and session can be vanished!
1691 mutex_unlock(&dev->lock);
1696 int rnbd_clt_remap_device(struct rnbd_clt_dev *dev)
1700 mutex_lock(&dev->lock);
1701 if (dev->dev_state == DEV_STATE_MAPPED_DISCONNECTED)
1703 else if (dev->dev_state == DEV_STATE_UNMAPPED)
1705 else if (dev->dev_state == DEV_STATE_MAPPED)
1709 mutex_unlock(&dev->lock);
1711 rnbd_clt_info(dev, "Remapping device.\n");
1712 err = send_msg_open(dev, RTRS_PERMIT_WAIT);
1714 rnbd_clt_err(dev, "remap_device: %d\n", err);
1720 static void unmap_device_work(struct work_struct *work)
1722 struct rnbd_clt_dev *dev;
1724 dev = container_of(work, typeof(*dev), unmap_on_rmmod_work);
1725 rnbd_clt_unmap_device(dev, true, NULL);
1728 static void rnbd_destroy_sessions(void)
1730 struct rnbd_clt_session *sess, *sn;
1731 struct rnbd_clt_dev *dev, *tn;
1733 /* Firstly forbid access through sysfs interface */
1734 rnbd_clt_destroy_sysfs_files();
1737 * Here at this point there is no any concurrent access to sessions
1738 * list and devices list:
1739 * 1. New session or device can't be created - session sysfs files
1741 * 2. Device or session can't be removed - module reference is taken
1742 * into account in unmap device sysfs callback.
1743 * 3. No IO requests inflight - each file open of block_dev increases
1744 * module reference in get_disk().
1746 * But still there can be user requests inflights, which are sent by
1747 * asynchronous send_msg_*() functions, thus before unmapping devices
1748 * RTRS session must be explicitly closed.
1751 list_for_each_entry_safe(sess, sn, &sess_list, list) {
1752 if (!rnbd_clt_get_sess(sess))
1755 list_for_each_entry_safe(dev, tn, &sess->devs_list, list) {
1757 * Here unmap happens in parallel for only one reason:
1758 * blk_cleanup_queue() takes around half a second, so
1759 * on huge amount of devices the whole module unload
1760 * procedure takes minutes.
1762 INIT_WORK(&dev->unmap_on_rmmod_work, unmap_device_work);
1763 queue_work(rnbd_clt_wq, &dev->unmap_on_rmmod_work);
1765 rnbd_clt_put_sess(sess);
1767 /* Wait for all scheduled unmap works */
1768 flush_workqueue(rnbd_clt_wq);
1769 WARN_ON(!list_empty(&sess_list));
1772 static int __init rnbd_client_init(void)
1776 BUILD_BUG_ON(sizeof(struct rnbd_msg_hdr) != 4);
1777 BUILD_BUG_ON(sizeof(struct rnbd_msg_sess_info) != 36);
1778 BUILD_BUG_ON(sizeof(struct rnbd_msg_sess_info_rsp) != 36);
1779 BUILD_BUG_ON(sizeof(struct rnbd_msg_open) != 264);
1780 BUILD_BUG_ON(sizeof(struct rnbd_msg_close) != 8);
1781 BUILD_BUG_ON(sizeof(struct rnbd_msg_open_rsp) != 56);
1782 rnbd_client_major = register_blkdev(rnbd_client_major, "rnbd");
1783 if (rnbd_client_major <= 0) {
1784 pr_err("Failed to load module, block device registration failed\n");
1788 err = rnbd_clt_create_sysfs_files();
1790 pr_err("Failed to load module, creating sysfs device files failed, err: %d\n",
1792 unregister_blkdev(rnbd_client_major, "rnbd");
1795 rnbd_clt_wq = alloc_workqueue("rnbd_clt_wq", 0, 0);
1797 pr_err("Failed to load module, alloc_workqueue failed.\n");
1798 rnbd_clt_destroy_sysfs_files();
1799 unregister_blkdev(rnbd_client_major, "rnbd");
1806 static void __exit rnbd_client_exit(void)
1808 rnbd_destroy_sessions();
1809 unregister_blkdev(rnbd_client_major, "rnbd");
1810 ida_destroy(&index_ida);
1811 destroy_workqueue(rnbd_clt_wq);
1814 module_init(rnbd_client_init);
1815 module_exit(rnbd_client_exit);