2 * NVMe over Fabrics RDMA host code.
3 * Copyright (c) 2015-2016 HGST, a Western Digital Company.
5 * This program is free software; you can redistribute it and/or modify it
6 * under the terms and conditions of the GNU General Public License,
7 * version 2, as published by the Free Software Foundation.
9 * This program is distributed in the hope it will be useful, but WITHOUT
10 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
14 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
15 #include <linux/module.h>
16 #include <linux/init.h>
17 #include <linux/slab.h>
18 #include <linux/err.h>
19 #include <linux/string.h>
20 #include <linux/atomic.h>
21 #include <linux/blk-mq.h>
22 #include <linux/types.h>
23 #include <linux/list.h>
24 #include <linux/mutex.h>
25 #include <linux/scatterlist.h>
26 #include <linux/nvme.h>
27 #include <asm/unaligned.h>
29 #include <rdma/ib_verbs.h>
30 #include <rdma/rdma_cm.h>
31 #include <linux/nvme-rdma.h>
37 #define NVME_RDMA_CONNECT_TIMEOUT_MS 3000 /* 3 second */
39 #define NVME_RDMA_MAX_SEGMENT_SIZE 0xffffff /* 24-bit SGL field */
41 #define NVME_RDMA_MAX_SEGMENTS 256
43 #define NVME_RDMA_MAX_INLINE_SEGMENTS 1
46 * We handle AEN commands ourselves and don't even let the
47 * block layer know about them.
49 #define NVME_RDMA_NR_AEN_COMMANDS 1
50 #define NVME_RDMA_AQ_BLKMQ_DEPTH \
51 (NVME_AQ_DEPTH - NVME_RDMA_NR_AEN_COMMANDS)
53 struct nvme_rdma_device
{
54 struct ib_device
*dev
;
57 struct list_head entry
;
66 struct nvme_rdma_queue
;
67 struct nvme_rdma_request
{
68 struct nvme_request req
;
70 struct nvme_rdma_qe sqe
;
71 struct ib_sge sge
[1 + NVME_RDMA_MAX_INLINE_SEGMENTS
];
75 struct ib_reg_wr reg_wr
;
76 struct ib_cqe reg_cqe
;
77 struct nvme_rdma_queue
*queue
;
78 struct sg_table sg_table
;
79 struct scatterlist first_sgl
[];
82 enum nvme_rdma_queue_flags
{
84 NVME_RDMA_Q_DELETING
= 1,
87 struct nvme_rdma_queue
{
88 struct nvme_rdma_qe
*rsp_ring
;
91 size_t cmnd_capsule_len
;
92 struct nvme_rdma_ctrl
*ctrl
;
93 struct nvme_rdma_device
*device
;
98 struct rdma_cm_id
*cm_id
;
100 struct completion cm_done
;
103 struct nvme_rdma_ctrl
{
104 /* read only in the hot path */
105 struct nvme_rdma_queue
*queues
;
107 /* other member variables */
108 struct blk_mq_tag_set tag_set
;
109 struct work_struct delete_work
;
110 struct work_struct err_work
;
112 struct nvme_rdma_qe async_event_sqe
;
114 struct delayed_work reconnect_work
;
116 struct list_head list
;
118 struct blk_mq_tag_set admin_tag_set
;
119 struct nvme_rdma_device
*device
;
123 struct sockaddr_storage addr
;
124 struct sockaddr_storage src_addr
;
126 struct nvme_ctrl ctrl
;
129 static inline struct nvme_rdma_ctrl
*to_rdma_ctrl(struct nvme_ctrl
*ctrl
)
131 return container_of(ctrl
, struct nvme_rdma_ctrl
, ctrl
);
134 static LIST_HEAD(device_list
);
135 static DEFINE_MUTEX(device_list_mutex
);
137 static LIST_HEAD(nvme_rdma_ctrl_list
);
138 static DEFINE_MUTEX(nvme_rdma_ctrl_mutex
);
141 * Disabling this option makes small I/O goes faster, but is fundamentally
142 * unsafe. With it turned off we will have to register a global rkey that
143 * allows read and write access to all physical memory.
145 static bool register_always
= true;
146 module_param(register_always
, bool, 0444);
147 MODULE_PARM_DESC(register_always
,
148 "Use memory registration even for contiguous memory regions");
150 static int nvme_rdma_cm_handler(struct rdma_cm_id
*cm_id
,
151 struct rdma_cm_event
*event
);
152 static void nvme_rdma_recv_done(struct ib_cq
*cq
, struct ib_wc
*wc
);
154 /* XXX: really should move to a generic header sooner or later.. */
155 static inline void put_unaligned_le24(u32 val
, u8
*p
)
162 static inline int nvme_rdma_queue_idx(struct nvme_rdma_queue
*queue
)
164 return queue
- queue
->ctrl
->queues
;
167 static inline size_t nvme_rdma_inline_data_size(struct nvme_rdma_queue
*queue
)
169 return queue
->cmnd_capsule_len
- sizeof(struct nvme_command
);
172 static void nvme_rdma_free_qe(struct ib_device
*ibdev
, struct nvme_rdma_qe
*qe
,
173 size_t capsule_size
, enum dma_data_direction dir
)
175 ib_dma_unmap_single(ibdev
, qe
->dma
, capsule_size
, dir
);
179 static int nvme_rdma_alloc_qe(struct ib_device
*ibdev
, struct nvme_rdma_qe
*qe
,
180 size_t capsule_size
, enum dma_data_direction dir
)
182 qe
->data
= kzalloc(capsule_size
, GFP_KERNEL
);
186 qe
->dma
= ib_dma_map_single(ibdev
, qe
->data
, capsule_size
, dir
);
187 if (ib_dma_mapping_error(ibdev
, qe
->dma
)) {
195 static void nvme_rdma_free_ring(struct ib_device
*ibdev
,
196 struct nvme_rdma_qe
*ring
, size_t ib_queue_size
,
197 size_t capsule_size
, enum dma_data_direction dir
)
201 for (i
= 0; i
< ib_queue_size
; i
++)
202 nvme_rdma_free_qe(ibdev
, &ring
[i
], capsule_size
, dir
);
206 static struct nvme_rdma_qe
*nvme_rdma_alloc_ring(struct ib_device
*ibdev
,
207 size_t ib_queue_size
, size_t capsule_size
,
208 enum dma_data_direction dir
)
210 struct nvme_rdma_qe
*ring
;
213 ring
= kcalloc(ib_queue_size
, sizeof(struct nvme_rdma_qe
), GFP_KERNEL
);
217 for (i
= 0; i
< ib_queue_size
; i
++) {
218 if (nvme_rdma_alloc_qe(ibdev
, &ring
[i
], capsule_size
, dir
))
225 nvme_rdma_free_ring(ibdev
, ring
, i
, capsule_size
, dir
);
229 static void nvme_rdma_qp_event(struct ib_event
*event
, void *context
)
231 pr_debug("QP event %s (%d)\n",
232 ib_event_msg(event
->event
), event
->event
);
236 static int nvme_rdma_wait_for_cm(struct nvme_rdma_queue
*queue
)
238 wait_for_completion_interruptible_timeout(&queue
->cm_done
,
239 msecs_to_jiffies(NVME_RDMA_CONNECT_TIMEOUT_MS
) + 1);
240 return queue
->cm_error
;
243 static int nvme_rdma_create_qp(struct nvme_rdma_queue
*queue
, const int factor
)
245 struct nvme_rdma_device
*dev
= queue
->device
;
246 struct ib_qp_init_attr init_attr
;
249 memset(&init_attr
, 0, sizeof(init_attr
));
250 init_attr
.event_handler
= nvme_rdma_qp_event
;
252 init_attr
.cap
.max_send_wr
= factor
* queue
->queue_size
+ 1;
254 init_attr
.cap
.max_recv_wr
= queue
->queue_size
+ 1;
255 init_attr
.cap
.max_recv_sge
= 1;
256 init_attr
.cap
.max_send_sge
= 1 + NVME_RDMA_MAX_INLINE_SEGMENTS
;
257 init_attr
.sq_sig_type
= IB_SIGNAL_REQ_WR
;
258 init_attr
.qp_type
= IB_QPT_RC
;
259 init_attr
.send_cq
= queue
->ib_cq
;
260 init_attr
.recv_cq
= queue
->ib_cq
;
262 ret
= rdma_create_qp(queue
->cm_id
, dev
->pd
, &init_attr
);
264 queue
->qp
= queue
->cm_id
->qp
;
268 static int nvme_rdma_reinit_request(void *data
, struct request
*rq
)
270 struct nvme_rdma_ctrl
*ctrl
= data
;
271 struct nvme_rdma_device
*dev
= ctrl
->device
;
272 struct nvme_rdma_request
*req
= blk_mq_rq_to_pdu(rq
);
275 ib_dereg_mr(req
->mr
);
277 req
->mr
= ib_alloc_mr(dev
->pd
, IB_MR_TYPE_MEM_REG
,
279 if (IS_ERR(req
->mr
)) {
280 ret
= PTR_ERR(req
->mr
);
285 req
->mr
->need_inval
= false;
291 static void nvme_rdma_exit_request(struct blk_mq_tag_set
*set
,
292 struct request
*rq
, unsigned int hctx_idx
)
294 struct nvme_rdma_ctrl
*ctrl
= set
->driver_data
;
295 struct nvme_rdma_request
*req
= blk_mq_rq_to_pdu(rq
);
296 int queue_idx
= (set
== &ctrl
->tag_set
) ? hctx_idx
+ 1 : 0;
297 struct nvme_rdma_queue
*queue
= &ctrl
->queues
[queue_idx
];
298 struct nvme_rdma_device
*dev
= queue
->device
;
301 ib_dereg_mr(req
->mr
);
303 nvme_rdma_free_qe(dev
->dev
, &req
->sqe
, sizeof(struct nvme_command
),
307 static int nvme_rdma_init_request(struct blk_mq_tag_set
*set
,
308 struct request
*rq
, unsigned int hctx_idx
,
309 unsigned int numa_node
)
311 struct nvme_rdma_ctrl
*ctrl
= set
->driver_data
;
312 struct nvme_rdma_request
*req
= blk_mq_rq_to_pdu(rq
);
313 int queue_idx
= (set
== &ctrl
->tag_set
) ? hctx_idx
+ 1 : 0;
314 struct nvme_rdma_queue
*queue
= &ctrl
->queues
[queue_idx
];
315 struct nvme_rdma_device
*dev
= queue
->device
;
316 struct ib_device
*ibdev
= dev
->dev
;
319 ret
= nvme_rdma_alloc_qe(ibdev
, &req
->sqe
, sizeof(struct nvme_command
),
324 req
->mr
= ib_alloc_mr(dev
->pd
, IB_MR_TYPE_MEM_REG
,
326 if (IS_ERR(req
->mr
)) {
327 ret
= PTR_ERR(req
->mr
);
336 nvme_rdma_free_qe(dev
->dev
, &req
->sqe
, sizeof(struct nvme_command
),
341 static int nvme_rdma_init_hctx(struct blk_mq_hw_ctx
*hctx
, void *data
,
342 unsigned int hctx_idx
)
344 struct nvme_rdma_ctrl
*ctrl
= data
;
345 struct nvme_rdma_queue
*queue
= &ctrl
->queues
[hctx_idx
+ 1];
347 BUG_ON(hctx_idx
>= ctrl
->ctrl
.queue_count
);
349 hctx
->driver_data
= queue
;
353 static int nvme_rdma_init_admin_hctx(struct blk_mq_hw_ctx
*hctx
, void *data
,
354 unsigned int hctx_idx
)
356 struct nvme_rdma_ctrl
*ctrl
= data
;
357 struct nvme_rdma_queue
*queue
= &ctrl
->queues
[0];
359 BUG_ON(hctx_idx
!= 0);
361 hctx
->driver_data
= queue
;
365 static void nvme_rdma_free_dev(struct kref
*ref
)
367 struct nvme_rdma_device
*ndev
=
368 container_of(ref
, struct nvme_rdma_device
, ref
);
370 mutex_lock(&device_list_mutex
);
371 list_del(&ndev
->entry
);
372 mutex_unlock(&device_list_mutex
);
374 ib_dealloc_pd(ndev
->pd
);
378 static void nvme_rdma_dev_put(struct nvme_rdma_device
*dev
)
380 kref_put(&dev
->ref
, nvme_rdma_free_dev
);
383 static int nvme_rdma_dev_get(struct nvme_rdma_device
*dev
)
385 return kref_get_unless_zero(&dev
->ref
);
388 static struct nvme_rdma_device
*
389 nvme_rdma_find_get_device(struct rdma_cm_id
*cm_id
)
391 struct nvme_rdma_device
*ndev
;
393 mutex_lock(&device_list_mutex
);
394 list_for_each_entry(ndev
, &device_list
, entry
) {
395 if (ndev
->dev
->node_guid
== cm_id
->device
->node_guid
&&
396 nvme_rdma_dev_get(ndev
))
400 ndev
= kzalloc(sizeof(*ndev
), GFP_KERNEL
);
404 ndev
->dev
= cm_id
->device
;
405 kref_init(&ndev
->ref
);
407 ndev
->pd
= ib_alloc_pd(ndev
->dev
,
408 register_always
? 0 : IB_PD_UNSAFE_GLOBAL_RKEY
);
409 if (IS_ERR(ndev
->pd
))
412 if (!(ndev
->dev
->attrs
.device_cap_flags
&
413 IB_DEVICE_MEM_MGT_EXTENSIONS
)) {
414 dev_err(&ndev
->dev
->dev
,
415 "Memory registrations not supported.\n");
419 list_add(&ndev
->entry
, &device_list
);
421 mutex_unlock(&device_list_mutex
);
425 ib_dealloc_pd(ndev
->pd
);
429 mutex_unlock(&device_list_mutex
);
433 static void nvme_rdma_destroy_queue_ib(struct nvme_rdma_queue
*queue
)
435 struct nvme_rdma_device
*dev
;
436 struct ib_device
*ibdev
;
440 rdma_destroy_qp(queue
->cm_id
);
441 ib_free_cq(queue
->ib_cq
);
443 nvme_rdma_free_ring(ibdev
, queue
->rsp_ring
, queue
->queue_size
,
444 sizeof(struct nvme_completion
), DMA_FROM_DEVICE
);
446 nvme_rdma_dev_put(dev
);
449 static int nvme_rdma_create_queue_ib(struct nvme_rdma_queue
*queue
)
451 struct ib_device
*ibdev
;
452 const int send_wr_factor
= 3; /* MR, SEND, INV */
453 const int cq_factor
= send_wr_factor
+ 1; /* + RECV */
454 int comp_vector
, idx
= nvme_rdma_queue_idx(queue
);
457 queue
->device
= nvme_rdma_find_get_device(queue
->cm_id
);
458 if (!queue
->device
) {
459 dev_err(queue
->cm_id
->device
->dev
.parent
,
460 "no client data found!\n");
461 return -ECONNREFUSED
;
463 ibdev
= queue
->device
->dev
;
466 * The admin queue is barely used once the controller is live, so don't
467 * bother to spread it out.
472 comp_vector
= idx
% ibdev
->num_comp_vectors
;
475 /* +1 for ib_stop_cq */
476 queue
->ib_cq
= ib_alloc_cq(ibdev
, queue
,
477 cq_factor
* queue
->queue_size
+ 1,
478 comp_vector
, IB_POLL_SOFTIRQ
);
479 if (IS_ERR(queue
->ib_cq
)) {
480 ret
= PTR_ERR(queue
->ib_cq
);
484 ret
= nvme_rdma_create_qp(queue
, send_wr_factor
);
486 goto out_destroy_ib_cq
;
488 queue
->rsp_ring
= nvme_rdma_alloc_ring(ibdev
, queue
->queue_size
,
489 sizeof(struct nvme_completion
), DMA_FROM_DEVICE
);
490 if (!queue
->rsp_ring
) {
498 ib_destroy_qp(queue
->qp
);
500 ib_free_cq(queue
->ib_cq
);
502 nvme_rdma_dev_put(queue
->device
);
506 static int nvme_rdma_init_queue(struct nvme_rdma_ctrl
*ctrl
,
507 int idx
, size_t queue_size
)
509 struct nvme_rdma_queue
*queue
;
510 struct sockaddr
*src_addr
= NULL
;
513 queue
= &ctrl
->queues
[idx
];
515 init_completion(&queue
->cm_done
);
518 queue
->cmnd_capsule_len
= ctrl
->ctrl
.ioccsz
* 16;
520 queue
->cmnd_capsule_len
= sizeof(struct nvme_command
);
522 queue
->queue_size
= queue_size
;
523 atomic_set(&queue
->sig_count
, 0);
525 queue
->cm_id
= rdma_create_id(&init_net
, nvme_rdma_cm_handler
, queue
,
526 RDMA_PS_TCP
, IB_QPT_RC
);
527 if (IS_ERR(queue
->cm_id
)) {
528 dev_info(ctrl
->ctrl
.device
,
529 "failed to create CM ID: %ld\n", PTR_ERR(queue
->cm_id
));
530 return PTR_ERR(queue
->cm_id
);
533 if (ctrl
->ctrl
.opts
->mask
& NVMF_OPT_HOST_TRADDR
)
534 src_addr
= (struct sockaddr
*)&ctrl
->src_addr
;
536 queue
->cm_error
= -ETIMEDOUT
;
537 ret
= rdma_resolve_addr(queue
->cm_id
, src_addr
,
538 (struct sockaddr
*)&ctrl
->addr
,
539 NVME_RDMA_CONNECT_TIMEOUT_MS
);
541 dev_info(ctrl
->ctrl
.device
,
542 "rdma_resolve_addr failed (%d).\n", ret
);
543 goto out_destroy_cm_id
;
546 ret
= nvme_rdma_wait_for_cm(queue
);
548 dev_info(ctrl
->ctrl
.device
,
549 "rdma_resolve_addr wait failed (%d).\n", ret
);
550 goto out_destroy_cm_id
;
553 clear_bit(NVME_RDMA_Q_DELETING
, &queue
->flags
);
558 rdma_destroy_id(queue
->cm_id
);
562 static void nvme_rdma_stop_queue(struct nvme_rdma_queue
*queue
)
564 rdma_disconnect(queue
->cm_id
);
565 ib_drain_qp(queue
->qp
);
568 static void nvme_rdma_free_queue(struct nvme_rdma_queue
*queue
)
570 nvme_rdma_destroy_queue_ib(queue
);
571 rdma_destroy_id(queue
->cm_id
);
574 static void nvme_rdma_stop_and_free_queue(struct nvme_rdma_queue
*queue
)
576 if (test_and_set_bit(NVME_RDMA_Q_DELETING
, &queue
->flags
))
578 nvme_rdma_stop_queue(queue
);
579 nvme_rdma_free_queue(queue
);
582 static void nvme_rdma_free_io_queues(struct nvme_rdma_ctrl
*ctrl
)
586 for (i
= 1; i
< ctrl
->ctrl
.queue_count
; i
++)
587 nvme_rdma_stop_and_free_queue(&ctrl
->queues
[i
]);
590 static int nvme_rdma_connect_io_queues(struct nvme_rdma_ctrl
*ctrl
)
594 for (i
= 1; i
< ctrl
->ctrl
.queue_count
; i
++) {
595 ret
= nvmf_connect_io_queue(&ctrl
->ctrl
, i
);
597 dev_info(ctrl
->ctrl
.device
,
598 "failed to connect i/o queue: %d\n", ret
);
599 goto out_free_queues
;
601 set_bit(NVME_RDMA_Q_LIVE
, &ctrl
->queues
[i
].flags
);
607 nvme_rdma_free_io_queues(ctrl
);
611 static int nvme_rdma_init_io_queues(struct nvme_rdma_ctrl
*ctrl
)
613 struct nvmf_ctrl_options
*opts
= ctrl
->ctrl
.opts
;
614 unsigned int nr_io_queues
;
617 nr_io_queues
= min(opts
->nr_io_queues
, num_online_cpus());
618 ret
= nvme_set_queue_count(&ctrl
->ctrl
, &nr_io_queues
);
622 ctrl
->ctrl
.queue_count
= nr_io_queues
+ 1;
623 if (ctrl
->ctrl
.queue_count
< 2)
626 dev_info(ctrl
->ctrl
.device
,
627 "creating %d I/O queues.\n", nr_io_queues
);
629 for (i
= 1; i
< ctrl
->ctrl
.queue_count
; i
++) {
630 ret
= nvme_rdma_init_queue(ctrl
, i
,
631 ctrl
->ctrl
.opts
->queue_size
);
633 dev_info(ctrl
->ctrl
.device
,
634 "failed to initialize i/o queue: %d\n", ret
);
635 goto out_free_queues
;
642 for (i
--; i
>= 1; i
--)
643 nvme_rdma_stop_and_free_queue(&ctrl
->queues
[i
]);
648 static void nvme_rdma_destroy_admin_queue(struct nvme_rdma_ctrl
*ctrl
)
650 nvme_rdma_free_qe(ctrl
->queues
[0].device
->dev
, &ctrl
->async_event_sqe
,
651 sizeof(struct nvme_command
), DMA_TO_DEVICE
);
652 nvme_rdma_stop_and_free_queue(&ctrl
->queues
[0]);
653 blk_cleanup_queue(ctrl
->ctrl
.admin_q
);
654 blk_mq_free_tag_set(&ctrl
->admin_tag_set
);
655 nvme_rdma_dev_put(ctrl
->device
);
658 static void nvme_rdma_free_ctrl(struct nvme_ctrl
*nctrl
)
660 struct nvme_rdma_ctrl
*ctrl
= to_rdma_ctrl(nctrl
);
662 if (list_empty(&ctrl
->list
))
665 mutex_lock(&nvme_rdma_ctrl_mutex
);
666 list_del(&ctrl
->list
);
667 mutex_unlock(&nvme_rdma_ctrl_mutex
);
670 nvmf_free_options(nctrl
->opts
);
675 static void nvme_rdma_reconnect_or_remove(struct nvme_rdma_ctrl
*ctrl
)
677 /* If we are resetting/deleting then do nothing */
678 if (ctrl
->ctrl
.state
!= NVME_CTRL_RECONNECTING
) {
679 WARN_ON_ONCE(ctrl
->ctrl
.state
== NVME_CTRL_NEW
||
680 ctrl
->ctrl
.state
== NVME_CTRL_LIVE
);
684 if (nvmf_should_reconnect(&ctrl
->ctrl
)) {
685 dev_info(ctrl
->ctrl
.device
, "Reconnecting in %d seconds...\n",
686 ctrl
->ctrl
.opts
->reconnect_delay
);
687 queue_delayed_work(nvme_wq
, &ctrl
->reconnect_work
,
688 ctrl
->ctrl
.opts
->reconnect_delay
* HZ
);
690 dev_info(ctrl
->ctrl
.device
, "Removing controller...\n");
691 queue_work(nvme_wq
, &ctrl
->delete_work
);
695 static void nvme_rdma_reconnect_ctrl_work(struct work_struct
*work
)
697 struct nvme_rdma_ctrl
*ctrl
= container_of(to_delayed_work(work
),
698 struct nvme_rdma_ctrl
, reconnect_work
);
702 ++ctrl
->ctrl
.nr_reconnects
;
704 if (ctrl
->ctrl
.queue_count
> 1) {
705 nvme_rdma_free_io_queues(ctrl
);
707 ret
= blk_mq_reinit_tagset(&ctrl
->tag_set
);
712 nvme_rdma_stop_and_free_queue(&ctrl
->queues
[0]);
714 ret
= blk_mq_reinit_tagset(&ctrl
->admin_tag_set
);
718 ret
= nvme_rdma_init_queue(ctrl
, 0, NVME_AQ_DEPTH
);
722 ret
= nvmf_connect_admin_queue(&ctrl
->ctrl
);
726 set_bit(NVME_RDMA_Q_LIVE
, &ctrl
->queues
[0].flags
);
728 ret
= nvme_enable_ctrl(&ctrl
->ctrl
, ctrl
->ctrl
.cap
);
732 if (ctrl
->ctrl
.queue_count
> 1) {
733 ret
= nvme_rdma_init_io_queues(ctrl
);
737 ret
= nvme_rdma_connect_io_queues(ctrl
);
741 blk_mq_update_nr_hw_queues(&ctrl
->tag_set
,
742 ctrl
->ctrl
.queue_count
- 1);
745 changed
= nvme_change_ctrl_state(&ctrl
->ctrl
, NVME_CTRL_LIVE
);
746 WARN_ON_ONCE(!changed
);
747 ctrl
->ctrl
.nr_reconnects
= 0;
749 nvme_start_ctrl(&ctrl
->ctrl
);
751 dev_info(ctrl
->ctrl
.device
, "Successfully reconnected\n");
756 dev_info(ctrl
->ctrl
.device
, "Failed reconnect attempt %d\n",
757 ctrl
->ctrl
.nr_reconnects
);
758 nvme_rdma_reconnect_or_remove(ctrl
);
761 static void nvme_rdma_error_recovery_work(struct work_struct
*work
)
763 struct nvme_rdma_ctrl
*ctrl
= container_of(work
,
764 struct nvme_rdma_ctrl
, err_work
);
767 nvme_stop_ctrl(&ctrl
->ctrl
);
769 for (i
= 0; i
< ctrl
->ctrl
.queue_count
; i
++)
770 clear_bit(NVME_RDMA_Q_LIVE
, &ctrl
->queues
[i
].flags
);
772 if (ctrl
->ctrl
.queue_count
> 1)
773 nvme_stop_queues(&ctrl
->ctrl
);
774 blk_mq_quiesce_queue(ctrl
->ctrl
.admin_q
);
776 /* We must take care of fastfail/requeue all our inflight requests */
777 if (ctrl
->ctrl
.queue_count
> 1)
778 blk_mq_tagset_busy_iter(&ctrl
->tag_set
,
779 nvme_cancel_request
, &ctrl
->ctrl
);
780 blk_mq_tagset_busy_iter(&ctrl
->admin_tag_set
,
781 nvme_cancel_request
, &ctrl
->ctrl
);
784 * queues are not a live anymore, so restart the queues to fail fast
787 blk_mq_unquiesce_queue(ctrl
->ctrl
.admin_q
);
788 nvme_start_queues(&ctrl
->ctrl
);
790 nvme_rdma_reconnect_or_remove(ctrl
);
793 static void nvme_rdma_error_recovery(struct nvme_rdma_ctrl
*ctrl
)
795 if (!nvme_change_ctrl_state(&ctrl
->ctrl
, NVME_CTRL_RECONNECTING
))
798 queue_work(nvme_wq
, &ctrl
->err_work
);
801 static void nvme_rdma_wr_error(struct ib_cq
*cq
, struct ib_wc
*wc
,
804 struct nvme_rdma_queue
*queue
= cq
->cq_context
;
805 struct nvme_rdma_ctrl
*ctrl
= queue
->ctrl
;
807 if (ctrl
->ctrl
.state
== NVME_CTRL_LIVE
)
808 dev_info(ctrl
->ctrl
.device
,
809 "%s for CQE 0x%p failed with status %s (%d)\n",
811 ib_wc_status_msg(wc
->status
), wc
->status
);
812 nvme_rdma_error_recovery(ctrl
);
815 static void nvme_rdma_memreg_done(struct ib_cq
*cq
, struct ib_wc
*wc
)
817 if (unlikely(wc
->status
!= IB_WC_SUCCESS
))
818 nvme_rdma_wr_error(cq
, wc
, "MEMREG");
821 static void nvme_rdma_inv_rkey_done(struct ib_cq
*cq
, struct ib_wc
*wc
)
823 if (unlikely(wc
->status
!= IB_WC_SUCCESS
))
824 nvme_rdma_wr_error(cq
, wc
, "LOCAL_INV");
827 static int nvme_rdma_inv_rkey(struct nvme_rdma_queue
*queue
,
828 struct nvme_rdma_request
*req
)
830 struct ib_send_wr
*bad_wr
;
831 struct ib_send_wr wr
= {
832 .opcode
= IB_WR_LOCAL_INV
,
836 .ex
.invalidate_rkey
= req
->mr
->rkey
,
839 req
->reg_cqe
.done
= nvme_rdma_inv_rkey_done
;
840 wr
.wr_cqe
= &req
->reg_cqe
;
842 return ib_post_send(queue
->qp
, &wr
, &bad_wr
);
845 static void nvme_rdma_unmap_data(struct nvme_rdma_queue
*queue
,
848 struct nvme_rdma_request
*req
= blk_mq_rq_to_pdu(rq
);
849 struct nvme_rdma_ctrl
*ctrl
= queue
->ctrl
;
850 struct nvme_rdma_device
*dev
= queue
->device
;
851 struct ib_device
*ibdev
= dev
->dev
;
854 if (!blk_rq_bytes(rq
))
857 if (req
->mr
->need_inval
) {
858 res
= nvme_rdma_inv_rkey(queue
, req
);
860 dev_err(ctrl
->ctrl
.device
,
861 "Queueing INV WR for rkey %#x failed (%d)\n",
863 nvme_rdma_error_recovery(queue
->ctrl
);
867 ib_dma_unmap_sg(ibdev
, req
->sg_table
.sgl
,
868 req
->nents
, rq_data_dir(rq
) ==
869 WRITE
? DMA_TO_DEVICE
: DMA_FROM_DEVICE
);
871 nvme_cleanup_cmd(rq
);
872 sg_free_table_chained(&req
->sg_table
, true);
875 static int nvme_rdma_set_sg_null(struct nvme_command
*c
)
877 struct nvme_keyed_sgl_desc
*sg
= &c
->common
.dptr
.ksgl
;
880 put_unaligned_le24(0, sg
->length
);
881 put_unaligned_le32(0, sg
->key
);
882 sg
->type
= NVME_KEY_SGL_FMT_DATA_DESC
<< 4;
886 static int nvme_rdma_map_sg_inline(struct nvme_rdma_queue
*queue
,
887 struct nvme_rdma_request
*req
, struct nvme_command
*c
)
889 struct nvme_sgl_desc
*sg
= &c
->common
.dptr
.sgl
;
891 req
->sge
[1].addr
= sg_dma_address(req
->sg_table
.sgl
);
892 req
->sge
[1].length
= sg_dma_len(req
->sg_table
.sgl
);
893 req
->sge
[1].lkey
= queue
->device
->pd
->local_dma_lkey
;
895 sg
->addr
= cpu_to_le64(queue
->ctrl
->ctrl
.icdoff
);
896 sg
->length
= cpu_to_le32(sg_dma_len(req
->sg_table
.sgl
));
897 sg
->type
= (NVME_SGL_FMT_DATA_DESC
<< 4) | NVME_SGL_FMT_OFFSET
;
899 req
->inline_data
= true;
904 static int nvme_rdma_map_sg_single(struct nvme_rdma_queue
*queue
,
905 struct nvme_rdma_request
*req
, struct nvme_command
*c
)
907 struct nvme_keyed_sgl_desc
*sg
= &c
->common
.dptr
.ksgl
;
909 sg
->addr
= cpu_to_le64(sg_dma_address(req
->sg_table
.sgl
));
910 put_unaligned_le24(sg_dma_len(req
->sg_table
.sgl
), sg
->length
);
911 put_unaligned_le32(queue
->device
->pd
->unsafe_global_rkey
, sg
->key
);
912 sg
->type
= NVME_KEY_SGL_FMT_DATA_DESC
<< 4;
916 static int nvme_rdma_map_sg_fr(struct nvme_rdma_queue
*queue
,
917 struct nvme_rdma_request
*req
, struct nvme_command
*c
,
920 struct nvme_keyed_sgl_desc
*sg
= &c
->common
.dptr
.ksgl
;
923 nr
= ib_map_mr_sg(req
->mr
, req
->sg_table
.sgl
, count
, NULL
, PAGE_SIZE
);
930 ib_update_fast_reg_key(req
->mr
, ib_inc_rkey(req
->mr
->rkey
));
932 req
->reg_cqe
.done
= nvme_rdma_memreg_done
;
933 memset(&req
->reg_wr
, 0, sizeof(req
->reg_wr
));
934 req
->reg_wr
.wr
.opcode
= IB_WR_REG_MR
;
935 req
->reg_wr
.wr
.wr_cqe
= &req
->reg_cqe
;
936 req
->reg_wr
.wr
.num_sge
= 0;
937 req
->reg_wr
.mr
= req
->mr
;
938 req
->reg_wr
.key
= req
->mr
->rkey
;
939 req
->reg_wr
.access
= IB_ACCESS_LOCAL_WRITE
|
940 IB_ACCESS_REMOTE_READ
|
941 IB_ACCESS_REMOTE_WRITE
;
943 req
->mr
->need_inval
= true;
945 sg
->addr
= cpu_to_le64(req
->mr
->iova
);
946 put_unaligned_le24(req
->mr
->length
, sg
->length
);
947 put_unaligned_le32(req
->mr
->rkey
, sg
->key
);
948 sg
->type
= (NVME_KEY_SGL_FMT_DATA_DESC
<< 4) |
949 NVME_SGL_FMT_INVALIDATE
;
954 static int nvme_rdma_map_data(struct nvme_rdma_queue
*queue
,
955 struct request
*rq
, struct nvme_command
*c
)
957 struct nvme_rdma_request
*req
= blk_mq_rq_to_pdu(rq
);
958 struct nvme_rdma_device
*dev
= queue
->device
;
959 struct ib_device
*ibdev
= dev
->dev
;
963 req
->inline_data
= false;
964 req
->mr
->need_inval
= false;
966 c
->common
.flags
|= NVME_CMD_SGL_METABUF
;
968 if (!blk_rq_bytes(rq
))
969 return nvme_rdma_set_sg_null(c
);
971 req
->sg_table
.sgl
= req
->first_sgl
;
972 ret
= sg_alloc_table_chained(&req
->sg_table
,
973 blk_rq_nr_phys_segments(rq
), req
->sg_table
.sgl
);
977 req
->nents
= blk_rq_map_sg(rq
->q
, rq
, req
->sg_table
.sgl
);
979 count
= ib_dma_map_sg(ibdev
, req
->sg_table
.sgl
, req
->nents
,
980 rq_data_dir(rq
) == WRITE
? DMA_TO_DEVICE
: DMA_FROM_DEVICE
);
981 if (unlikely(count
<= 0)) {
982 sg_free_table_chained(&req
->sg_table
, true);
987 if (rq_data_dir(rq
) == WRITE
&& nvme_rdma_queue_idx(queue
) &&
988 blk_rq_payload_bytes(rq
) <=
989 nvme_rdma_inline_data_size(queue
))
990 return nvme_rdma_map_sg_inline(queue
, req
, c
);
992 if (dev
->pd
->flags
& IB_PD_UNSAFE_GLOBAL_RKEY
)
993 return nvme_rdma_map_sg_single(queue
, req
, c
);
996 return nvme_rdma_map_sg_fr(queue
, req
, c
, count
);
999 static void nvme_rdma_send_done(struct ib_cq
*cq
, struct ib_wc
*wc
)
1001 if (unlikely(wc
->status
!= IB_WC_SUCCESS
))
1002 nvme_rdma_wr_error(cq
, wc
, "SEND");
1006 * We want to signal completion at least every queue depth/2. This returns the
1007 * largest power of two that is not above half of (queue size + 1) to optimize
1008 * (avoid divisions).
1010 static inline bool nvme_rdma_queue_sig_limit(struct nvme_rdma_queue
*queue
)
1012 int limit
= 1 << ilog2((queue
->queue_size
+ 1) / 2);
1014 return (atomic_inc_return(&queue
->sig_count
) & (limit
- 1)) == 0;
1017 static int nvme_rdma_post_send(struct nvme_rdma_queue
*queue
,
1018 struct nvme_rdma_qe
*qe
, struct ib_sge
*sge
, u32 num_sge
,
1019 struct ib_send_wr
*first
, bool flush
)
1021 struct ib_send_wr wr
, *bad_wr
;
1024 sge
->addr
= qe
->dma
;
1025 sge
->length
= sizeof(struct nvme_command
),
1026 sge
->lkey
= queue
->device
->pd
->local_dma_lkey
;
1028 qe
->cqe
.done
= nvme_rdma_send_done
;
1031 wr
.wr_cqe
= &qe
->cqe
;
1033 wr
.num_sge
= num_sge
;
1034 wr
.opcode
= IB_WR_SEND
;
1038 * Unsignalled send completions are another giant desaster in the
1039 * IB Verbs spec: If we don't regularly post signalled sends
1040 * the send queue will fill up and only a QP reset will rescue us.
1041 * Would have been way to obvious to handle this in hardware or
1042 * at least the RDMA stack..
1044 * Always signal the flushes. The magic request used for the flush
1045 * sequencer is not allocated in our driver's tagset and it's
1046 * triggered to be freed by blk_cleanup_queue(). So we need to
1047 * always mark it as signaled to ensure that the "wr_cqe", which is
1048 * embedded in request's payload, is not freed when __ib_process_cq()
1049 * calls wr_cqe->done().
1051 if (nvme_rdma_queue_sig_limit(queue
) || flush
)
1052 wr
.send_flags
|= IB_SEND_SIGNALED
;
1059 ret
= ib_post_send(queue
->qp
, first
, &bad_wr
);
1061 dev_err(queue
->ctrl
->ctrl
.device
,
1062 "%s failed with error code %d\n", __func__
, ret
);
1067 static int nvme_rdma_post_recv(struct nvme_rdma_queue
*queue
,
1068 struct nvme_rdma_qe
*qe
)
1070 struct ib_recv_wr wr
, *bad_wr
;
1074 list
.addr
= qe
->dma
;
1075 list
.length
= sizeof(struct nvme_completion
);
1076 list
.lkey
= queue
->device
->pd
->local_dma_lkey
;
1078 qe
->cqe
.done
= nvme_rdma_recv_done
;
1081 wr
.wr_cqe
= &qe
->cqe
;
1085 ret
= ib_post_recv(queue
->qp
, &wr
, &bad_wr
);
1087 dev_err(queue
->ctrl
->ctrl
.device
,
1088 "%s failed with error code %d\n", __func__
, ret
);
1093 static struct blk_mq_tags
*nvme_rdma_tagset(struct nvme_rdma_queue
*queue
)
1095 u32 queue_idx
= nvme_rdma_queue_idx(queue
);
1098 return queue
->ctrl
->admin_tag_set
.tags
[queue_idx
];
1099 return queue
->ctrl
->tag_set
.tags
[queue_idx
- 1];
1102 static void nvme_rdma_submit_async_event(struct nvme_ctrl
*arg
, int aer_idx
)
1104 struct nvme_rdma_ctrl
*ctrl
= to_rdma_ctrl(arg
);
1105 struct nvme_rdma_queue
*queue
= &ctrl
->queues
[0];
1106 struct ib_device
*dev
= queue
->device
->dev
;
1107 struct nvme_rdma_qe
*sqe
= &ctrl
->async_event_sqe
;
1108 struct nvme_command
*cmd
= sqe
->data
;
1112 if (WARN_ON_ONCE(aer_idx
!= 0))
1115 ib_dma_sync_single_for_cpu(dev
, sqe
->dma
, sizeof(*cmd
), DMA_TO_DEVICE
);
1117 memset(cmd
, 0, sizeof(*cmd
));
1118 cmd
->common
.opcode
= nvme_admin_async_event
;
1119 cmd
->common
.command_id
= NVME_RDMA_AQ_BLKMQ_DEPTH
;
1120 cmd
->common
.flags
|= NVME_CMD_SGL_METABUF
;
1121 nvme_rdma_set_sg_null(cmd
);
1123 ib_dma_sync_single_for_device(dev
, sqe
->dma
, sizeof(*cmd
),
1126 ret
= nvme_rdma_post_send(queue
, sqe
, &sge
, 1, NULL
, false);
1130 static int nvme_rdma_process_nvme_rsp(struct nvme_rdma_queue
*queue
,
1131 struct nvme_completion
*cqe
, struct ib_wc
*wc
, int tag
)
1134 struct nvme_rdma_request
*req
;
1137 rq
= blk_mq_tag_to_rq(nvme_rdma_tagset(queue
), cqe
->command_id
);
1139 dev_err(queue
->ctrl
->ctrl
.device
,
1140 "tag 0x%x on QP %#x not found\n",
1141 cqe
->command_id
, queue
->qp
->qp_num
);
1142 nvme_rdma_error_recovery(queue
->ctrl
);
1145 req
= blk_mq_rq_to_pdu(rq
);
1150 if ((wc
->wc_flags
& IB_WC_WITH_INVALIDATE
) &&
1151 wc
->ex
.invalidate_rkey
== req
->mr
->rkey
)
1152 req
->mr
->need_inval
= false;
1154 nvme_end_request(rq
, cqe
->status
, cqe
->result
);
1158 static int __nvme_rdma_recv_done(struct ib_cq
*cq
, struct ib_wc
*wc
, int tag
)
1160 struct nvme_rdma_qe
*qe
=
1161 container_of(wc
->wr_cqe
, struct nvme_rdma_qe
, cqe
);
1162 struct nvme_rdma_queue
*queue
= cq
->cq_context
;
1163 struct ib_device
*ibdev
= queue
->device
->dev
;
1164 struct nvme_completion
*cqe
= qe
->data
;
1165 const size_t len
= sizeof(struct nvme_completion
);
1168 if (unlikely(wc
->status
!= IB_WC_SUCCESS
)) {
1169 nvme_rdma_wr_error(cq
, wc
, "RECV");
1173 ib_dma_sync_single_for_cpu(ibdev
, qe
->dma
, len
, DMA_FROM_DEVICE
);
1175 * AEN requests are special as they don't time out and can
1176 * survive any kind of queue freeze and often don't respond to
1177 * aborts. We don't even bother to allocate a struct request
1178 * for them but rather special case them here.
1180 if (unlikely(nvme_rdma_queue_idx(queue
) == 0 &&
1181 cqe
->command_id
>= NVME_RDMA_AQ_BLKMQ_DEPTH
))
1182 nvme_complete_async_event(&queue
->ctrl
->ctrl
, cqe
->status
,
1185 ret
= nvme_rdma_process_nvme_rsp(queue
, cqe
, wc
, tag
);
1186 ib_dma_sync_single_for_device(ibdev
, qe
->dma
, len
, DMA_FROM_DEVICE
);
1188 nvme_rdma_post_recv(queue
, qe
);
1192 static void nvme_rdma_recv_done(struct ib_cq
*cq
, struct ib_wc
*wc
)
1194 __nvme_rdma_recv_done(cq
, wc
, -1);
1197 static int nvme_rdma_conn_established(struct nvme_rdma_queue
*queue
)
1201 for (i
= 0; i
< queue
->queue_size
; i
++) {
1202 ret
= nvme_rdma_post_recv(queue
, &queue
->rsp_ring
[i
]);
1204 goto out_destroy_queue_ib
;
1209 out_destroy_queue_ib
:
1210 nvme_rdma_destroy_queue_ib(queue
);
1214 static int nvme_rdma_conn_rejected(struct nvme_rdma_queue
*queue
,
1215 struct rdma_cm_event
*ev
)
1217 struct rdma_cm_id
*cm_id
= queue
->cm_id
;
1218 int status
= ev
->status
;
1219 const char *rej_msg
;
1220 const struct nvme_rdma_cm_rej
*rej_data
;
1223 rej_msg
= rdma_reject_msg(cm_id
, status
);
1224 rej_data
= rdma_consumer_reject_data(cm_id
, ev
, &rej_data_len
);
1226 if (rej_data
&& rej_data_len
>= sizeof(u16
)) {
1227 u16 sts
= le16_to_cpu(rej_data
->sts
);
1229 dev_err(queue
->ctrl
->ctrl
.device
,
1230 "Connect rejected: status %d (%s) nvme status %d (%s).\n",
1231 status
, rej_msg
, sts
, nvme_rdma_cm_msg(sts
));
1233 dev_err(queue
->ctrl
->ctrl
.device
,
1234 "Connect rejected: status %d (%s).\n", status
, rej_msg
);
1240 static int nvme_rdma_addr_resolved(struct nvme_rdma_queue
*queue
)
1244 ret
= nvme_rdma_create_queue_ib(queue
);
1248 ret
= rdma_resolve_route(queue
->cm_id
, NVME_RDMA_CONNECT_TIMEOUT_MS
);
1250 dev_err(queue
->ctrl
->ctrl
.device
,
1251 "rdma_resolve_route failed (%d).\n",
1253 goto out_destroy_queue
;
1259 nvme_rdma_destroy_queue_ib(queue
);
1263 static int nvme_rdma_route_resolved(struct nvme_rdma_queue
*queue
)
1265 struct nvme_rdma_ctrl
*ctrl
= queue
->ctrl
;
1266 struct rdma_conn_param param
= { };
1267 struct nvme_rdma_cm_req priv
= { };
1270 param
.qp_num
= queue
->qp
->qp_num
;
1271 param
.flow_control
= 1;
1273 param
.responder_resources
= queue
->device
->dev
->attrs
.max_qp_rd_atom
;
1274 /* maximum retry count */
1275 param
.retry_count
= 7;
1276 param
.rnr_retry_count
= 7;
1277 param
.private_data
= &priv
;
1278 param
.private_data_len
= sizeof(priv
);
1280 priv
.recfmt
= cpu_to_le16(NVME_RDMA_CM_FMT_1_0
);
1281 priv
.qid
= cpu_to_le16(nvme_rdma_queue_idx(queue
));
1283 * set the admin queue depth to the minimum size
1284 * specified by the Fabrics standard.
1286 if (priv
.qid
== 0) {
1287 priv
.hrqsize
= cpu_to_le16(NVME_AQ_DEPTH
);
1288 priv
.hsqsize
= cpu_to_le16(NVME_AQ_DEPTH
- 1);
1291 * current interpretation of the fabrics spec
1292 * is at minimum you make hrqsize sqsize+1, or a
1293 * 1's based representation of sqsize.
1295 priv
.hrqsize
= cpu_to_le16(queue
->queue_size
);
1296 priv
.hsqsize
= cpu_to_le16(queue
->ctrl
->ctrl
.sqsize
);
1299 ret
= rdma_connect(queue
->cm_id
, ¶m
);
1301 dev_err(ctrl
->ctrl
.device
,
1302 "rdma_connect failed (%d).\n", ret
);
1303 goto out_destroy_queue_ib
;
1308 out_destroy_queue_ib
:
1309 nvme_rdma_destroy_queue_ib(queue
);
1313 static int nvme_rdma_cm_handler(struct rdma_cm_id
*cm_id
,
1314 struct rdma_cm_event
*ev
)
1316 struct nvme_rdma_queue
*queue
= cm_id
->context
;
1319 dev_dbg(queue
->ctrl
->ctrl
.device
, "%s (%d): status %d id %p\n",
1320 rdma_event_msg(ev
->event
), ev
->event
,
1323 switch (ev
->event
) {
1324 case RDMA_CM_EVENT_ADDR_RESOLVED
:
1325 cm_error
= nvme_rdma_addr_resolved(queue
);
1327 case RDMA_CM_EVENT_ROUTE_RESOLVED
:
1328 cm_error
= nvme_rdma_route_resolved(queue
);
1330 case RDMA_CM_EVENT_ESTABLISHED
:
1331 queue
->cm_error
= nvme_rdma_conn_established(queue
);
1332 /* complete cm_done regardless of success/failure */
1333 complete(&queue
->cm_done
);
1335 case RDMA_CM_EVENT_REJECTED
:
1336 nvme_rdma_destroy_queue_ib(queue
);
1337 cm_error
= nvme_rdma_conn_rejected(queue
, ev
);
1339 case RDMA_CM_EVENT_ROUTE_ERROR
:
1340 case RDMA_CM_EVENT_CONNECT_ERROR
:
1341 case RDMA_CM_EVENT_UNREACHABLE
:
1342 nvme_rdma_destroy_queue_ib(queue
);
1343 case RDMA_CM_EVENT_ADDR_ERROR
:
1344 dev_dbg(queue
->ctrl
->ctrl
.device
,
1345 "CM error event %d\n", ev
->event
);
1346 cm_error
= -ECONNRESET
;
1348 case RDMA_CM_EVENT_DISCONNECTED
:
1349 case RDMA_CM_EVENT_ADDR_CHANGE
:
1350 case RDMA_CM_EVENT_TIMEWAIT_EXIT
:
1351 dev_dbg(queue
->ctrl
->ctrl
.device
,
1352 "disconnect received - connection closed\n");
1353 nvme_rdma_error_recovery(queue
->ctrl
);
1355 case RDMA_CM_EVENT_DEVICE_REMOVAL
:
1356 /* device removal is handled via the ib_client API */
1359 dev_err(queue
->ctrl
->ctrl
.device
,
1360 "Unexpected RDMA CM event (%d)\n", ev
->event
);
1361 nvme_rdma_error_recovery(queue
->ctrl
);
1366 queue
->cm_error
= cm_error
;
1367 complete(&queue
->cm_done
);
1373 static enum blk_eh_timer_return
1374 nvme_rdma_timeout(struct request
*rq
, bool reserved
)
1376 struct nvme_rdma_request
*req
= blk_mq_rq_to_pdu(rq
);
1378 /* queue error recovery */
1379 nvme_rdma_error_recovery(req
->queue
->ctrl
);
1381 /* fail with DNR on cmd timeout */
1382 nvme_req(rq
)->status
= NVME_SC_ABORT_REQ
| NVME_SC_DNR
;
1384 return BLK_EH_HANDLED
;
1388 * We cannot accept any other command until the Connect command has completed.
1390 static inline blk_status_t
1391 nvme_rdma_queue_is_ready(struct nvme_rdma_queue
*queue
, struct request
*rq
)
1393 if (unlikely(!test_bit(NVME_RDMA_Q_LIVE
, &queue
->flags
))) {
1394 struct nvme_command
*cmd
= nvme_req(rq
)->cmd
;
1396 if (!blk_rq_is_passthrough(rq
) ||
1397 cmd
->common
.opcode
!= nvme_fabrics_command
||
1398 cmd
->fabrics
.fctype
!= nvme_fabrics_type_connect
) {
1400 * reconnecting state means transport disruption, which
1401 * can take a long time and even might fail permanently,
1402 * so we can't let incoming I/O be requeued forever.
1403 * fail it fast to allow upper layers a chance to
1406 if (queue
->ctrl
->ctrl
.state
== NVME_CTRL_RECONNECTING
)
1407 return BLK_STS_IOERR
;
1408 return BLK_STS_RESOURCE
; /* try again later */
1415 static blk_status_t
nvme_rdma_queue_rq(struct blk_mq_hw_ctx
*hctx
,
1416 const struct blk_mq_queue_data
*bd
)
1418 struct nvme_ns
*ns
= hctx
->queue
->queuedata
;
1419 struct nvme_rdma_queue
*queue
= hctx
->driver_data
;
1420 struct request
*rq
= bd
->rq
;
1421 struct nvme_rdma_request
*req
= blk_mq_rq_to_pdu(rq
);
1422 struct nvme_rdma_qe
*sqe
= &req
->sqe
;
1423 struct nvme_command
*c
= sqe
->data
;
1425 struct ib_device
*dev
;
1429 WARN_ON_ONCE(rq
->tag
< 0);
1431 ret
= nvme_rdma_queue_is_ready(queue
, rq
);
1435 dev
= queue
->device
->dev
;
1436 ib_dma_sync_single_for_cpu(dev
, sqe
->dma
,
1437 sizeof(struct nvme_command
), DMA_TO_DEVICE
);
1439 ret
= nvme_setup_cmd(ns
, rq
, c
);
1443 blk_mq_start_request(rq
);
1445 err
= nvme_rdma_map_data(queue
, rq
, c
);
1447 dev_err(queue
->ctrl
->ctrl
.device
,
1448 "Failed to map data (%d)\n", err
);
1449 nvme_cleanup_cmd(rq
);
1453 ib_dma_sync_single_for_device(dev
, sqe
->dma
,
1454 sizeof(struct nvme_command
), DMA_TO_DEVICE
);
1456 if (req_op(rq
) == REQ_OP_FLUSH
)
1458 err
= nvme_rdma_post_send(queue
, sqe
, req
->sge
, req
->num_sge
,
1459 req
->mr
->need_inval
? &req
->reg_wr
.wr
: NULL
, flush
);
1461 nvme_rdma_unmap_data(queue
, rq
);
1467 if (err
== -ENOMEM
|| err
== -EAGAIN
)
1468 return BLK_STS_RESOURCE
;
1469 return BLK_STS_IOERR
;
1472 static int nvme_rdma_poll(struct blk_mq_hw_ctx
*hctx
, unsigned int tag
)
1474 struct nvme_rdma_queue
*queue
= hctx
->driver_data
;
1475 struct ib_cq
*cq
= queue
->ib_cq
;
1479 while (ib_poll_cq(cq
, 1, &wc
) > 0) {
1480 struct ib_cqe
*cqe
= wc
.wr_cqe
;
1483 if (cqe
->done
== nvme_rdma_recv_done
)
1484 found
|= __nvme_rdma_recv_done(cq
, &wc
, tag
);
1493 static void nvme_rdma_complete_rq(struct request
*rq
)
1495 struct nvme_rdma_request
*req
= blk_mq_rq_to_pdu(rq
);
1497 nvme_rdma_unmap_data(req
->queue
, rq
);
1498 nvme_complete_rq(rq
);
1501 static const struct blk_mq_ops nvme_rdma_mq_ops
= {
1502 .queue_rq
= nvme_rdma_queue_rq
,
1503 .complete
= nvme_rdma_complete_rq
,
1504 .init_request
= nvme_rdma_init_request
,
1505 .exit_request
= nvme_rdma_exit_request
,
1506 .reinit_request
= nvme_rdma_reinit_request
,
1507 .init_hctx
= nvme_rdma_init_hctx
,
1508 .poll
= nvme_rdma_poll
,
1509 .timeout
= nvme_rdma_timeout
,
1512 static const struct blk_mq_ops nvme_rdma_admin_mq_ops
= {
1513 .queue_rq
= nvme_rdma_queue_rq
,
1514 .complete
= nvme_rdma_complete_rq
,
1515 .init_request
= nvme_rdma_init_request
,
1516 .exit_request
= nvme_rdma_exit_request
,
1517 .reinit_request
= nvme_rdma_reinit_request
,
1518 .init_hctx
= nvme_rdma_init_admin_hctx
,
1519 .timeout
= nvme_rdma_timeout
,
1522 static int nvme_rdma_configure_admin_queue(struct nvme_rdma_ctrl
*ctrl
)
1526 error
= nvme_rdma_init_queue(ctrl
, 0, NVME_AQ_DEPTH
);
1530 ctrl
->device
= ctrl
->queues
[0].device
;
1533 * We need a reference on the device as long as the tag_set is alive,
1534 * as the MRs in the request structures need a valid ib_device.
1537 if (!nvme_rdma_dev_get(ctrl
->device
))
1538 goto out_free_queue
;
1540 ctrl
->max_fr_pages
= min_t(u32
, NVME_RDMA_MAX_SEGMENTS
,
1541 ctrl
->device
->dev
->attrs
.max_fast_reg_page_list_len
);
1543 memset(&ctrl
->admin_tag_set
, 0, sizeof(ctrl
->admin_tag_set
));
1544 ctrl
->admin_tag_set
.ops
= &nvme_rdma_admin_mq_ops
;
1545 ctrl
->admin_tag_set
.queue_depth
= NVME_RDMA_AQ_BLKMQ_DEPTH
;
1546 ctrl
->admin_tag_set
.reserved_tags
= 2; /* connect + keep-alive */
1547 ctrl
->admin_tag_set
.numa_node
= NUMA_NO_NODE
;
1548 ctrl
->admin_tag_set
.cmd_size
= sizeof(struct nvme_rdma_request
) +
1549 SG_CHUNK_SIZE
* sizeof(struct scatterlist
);
1550 ctrl
->admin_tag_set
.driver_data
= ctrl
;
1551 ctrl
->admin_tag_set
.nr_hw_queues
= 1;
1552 ctrl
->admin_tag_set
.timeout
= ADMIN_TIMEOUT
;
1554 error
= blk_mq_alloc_tag_set(&ctrl
->admin_tag_set
);
1558 ctrl
->ctrl
.admin_q
= blk_mq_init_queue(&ctrl
->admin_tag_set
);
1559 if (IS_ERR(ctrl
->ctrl
.admin_q
)) {
1560 error
= PTR_ERR(ctrl
->ctrl
.admin_q
);
1561 goto out_free_tagset
;
1564 error
= nvmf_connect_admin_queue(&ctrl
->ctrl
);
1566 goto out_cleanup_queue
;
1568 set_bit(NVME_RDMA_Q_LIVE
, &ctrl
->queues
[0].flags
);
1570 error
= nvmf_reg_read64(&ctrl
->ctrl
, NVME_REG_CAP
,
1573 dev_err(ctrl
->ctrl
.device
,
1574 "prop_get NVME_REG_CAP failed\n");
1575 goto out_cleanup_queue
;
1579 min_t(int, NVME_CAP_MQES(ctrl
->ctrl
.cap
), ctrl
->ctrl
.sqsize
);
1581 error
= nvme_enable_ctrl(&ctrl
->ctrl
, ctrl
->ctrl
.cap
);
1583 goto out_cleanup_queue
;
1585 ctrl
->ctrl
.max_hw_sectors
=
1586 (ctrl
->max_fr_pages
- 1) << (PAGE_SHIFT
- 9);
1588 error
= nvme_init_identify(&ctrl
->ctrl
);
1590 goto out_cleanup_queue
;
1592 error
= nvme_rdma_alloc_qe(ctrl
->queues
[0].device
->dev
,
1593 &ctrl
->async_event_sqe
, sizeof(struct nvme_command
),
1596 goto out_cleanup_queue
;
1601 blk_cleanup_queue(ctrl
->ctrl
.admin_q
);
1603 /* disconnect and drain the queue before freeing the tagset */
1604 nvme_rdma_stop_queue(&ctrl
->queues
[0]);
1605 blk_mq_free_tag_set(&ctrl
->admin_tag_set
);
1607 nvme_rdma_dev_put(ctrl
->device
);
1609 nvme_rdma_free_queue(&ctrl
->queues
[0]);
1613 static void nvme_rdma_shutdown_ctrl(struct nvme_rdma_ctrl
*ctrl
)
1615 cancel_work_sync(&ctrl
->err_work
);
1616 cancel_delayed_work_sync(&ctrl
->reconnect_work
);
1618 if (ctrl
->ctrl
.queue_count
> 1) {
1619 nvme_stop_queues(&ctrl
->ctrl
);
1620 blk_mq_tagset_busy_iter(&ctrl
->tag_set
,
1621 nvme_cancel_request
, &ctrl
->ctrl
);
1622 nvme_rdma_free_io_queues(ctrl
);
1625 if (test_bit(NVME_RDMA_Q_LIVE
, &ctrl
->queues
[0].flags
))
1626 nvme_shutdown_ctrl(&ctrl
->ctrl
);
1628 blk_mq_quiesce_queue(ctrl
->ctrl
.admin_q
);
1629 blk_mq_tagset_busy_iter(&ctrl
->admin_tag_set
,
1630 nvme_cancel_request
, &ctrl
->ctrl
);
1631 blk_mq_unquiesce_queue(ctrl
->ctrl
.admin_q
);
1632 nvme_rdma_destroy_admin_queue(ctrl
);
1635 static void __nvme_rdma_remove_ctrl(struct nvme_rdma_ctrl
*ctrl
, bool shutdown
)
1637 nvme_stop_ctrl(&ctrl
->ctrl
);
1638 nvme_remove_namespaces(&ctrl
->ctrl
);
1640 nvme_rdma_shutdown_ctrl(ctrl
);
1642 nvme_uninit_ctrl(&ctrl
->ctrl
);
1643 if (ctrl
->ctrl
.tagset
) {
1644 blk_cleanup_queue(ctrl
->ctrl
.connect_q
);
1645 blk_mq_free_tag_set(&ctrl
->tag_set
);
1646 nvme_rdma_dev_put(ctrl
->device
);
1649 nvme_put_ctrl(&ctrl
->ctrl
);
1652 static void nvme_rdma_del_ctrl_work(struct work_struct
*work
)
1654 struct nvme_rdma_ctrl
*ctrl
= container_of(work
,
1655 struct nvme_rdma_ctrl
, delete_work
);
1657 __nvme_rdma_remove_ctrl(ctrl
, true);
1660 static int __nvme_rdma_del_ctrl(struct nvme_rdma_ctrl
*ctrl
)
1662 if (!nvme_change_ctrl_state(&ctrl
->ctrl
, NVME_CTRL_DELETING
))
1665 if (!queue_work(nvme_wq
, &ctrl
->delete_work
))
1671 static int nvme_rdma_del_ctrl(struct nvme_ctrl
*nctrl
)
1673 struct nvme_rdma_ctrl
*ctrl
= to_rdma_ctrl(nctrl
);
1677 * Keep a reference until all work is flushed since
1678 * __nvme_rdma_del_ctrl can free the ctrl mem
1680 if (!kref_get_unless_zero(&ctrl
->ctrl
.kref
))
1682 ret
= __nvme_rdma_del_ctrl(ctrl
);
1684 flush_work(&ctrl
->delete_work
);
1685 nvme_put_ctrl(&ctrl
->ctrl
);
1689 static void nvme_rdma_remove_ctrl_work(struct work_struct
*work
)
1691 struct nvme_rdma_ctrl
*ctrl
= container_of(work
,
1692 struct nvme_rdma_ctrl
, delete_work
);
1694 __nvme_rdma_remove_ctrl(ctrl
, false);
1697 static void nvme_rdma_reset_ctrl_work(struct work_struct
*work
)
1699 struct nvme_rdma_ctrl
*ctrl
=
1700 container_of(work
, struct nvme_rdma_ctrl
, ctrl
.reset_work
);
1704 nvme_stop_ctrl(&ctrl
->ctrl
);
1705 nvme_rdma_shutdown_ctrl(ctrl
);
1707 ret
= nvme_rdma_configure_admin_queue(ctrl
);
1709 /* ctrl is already shutdown, just remove the ctrl */
1710 INIT_WORK(&ctrl
->delete_work
, nvme_rdma_remove_ctrl_work
);
1714 if (ctrl
->ctrl
.queue_count
> 1) {
1715 ret
= blk_mq_reinit_tagset(&ctrl
->tag_set
);
1719 ret
= nvme_rdma_init_io_queues(ctrl
);
1723 ret
= nvme_rdma_connect_io_queues(ctrl
);
1727 blk_mq_update_nr_hw_queues(&ctrl
->tag_set
,
1728 ctrl
->ctrl
.queue_count
- 1);
1731 changed
= nvme_change_ctrl_state(&ctrl
->ctrl
, NVME_CTRL_LIVE
);
1732 WARN_ON_ONCE(!changed
);
1734 nvme_start_ctrl(&ctrl
->ctrl
);
1739 /* Deleting this dead controller... */
1740 dev_warn(ctrl
->ctrl
.device
, "Removing after reset failure\n");
1741 WARN_ON(!queue_work(nvme_wq
, &ctrl
->delete_work
));
1744 static const struct nvme_ctrl_ops nvme_rdma_ctrl_ops
= {
1746 .module
= THIS_MODULE
,
1747 .flags
= NVME_F_FABRICS
,
1748 .reg_read32
= nvmf_reg_read32
,
1749 .reg_read64
= nvmf_reg_read64
,
1750 .reg_write32
= nvmf_reg_write32
,
1751 .free_ctrl
= nvme_rdma_free_ctrl
,
1752 .submit_async_event
= nvme_rdma_submit_async_event
,
1753 .delete_ctrl
= nvme_rdma_del_ctrl
,
1754 .get_address
= nvmf_get_address
,
1757 static int nvme_rdma_create_io_queues(struct nvme_rdma_ctrl
*ctrl
)
1761 ret
= nvme_rdma_init_io_queues(ctrl
);
1766 * We need a reference on the device as long as the tag_set is alive,
1767 * as the MRs in the request structures need a valid ib_device.
1770 if (!nvme_rdma_dev_get(ctrl
->device
))
1771 goto out_free_io_queues
;
1773 memset(&ctrl
->tag_set
, 0, sizeof(ctrl
->tag_set
));
1774 ctrl
->tag_set
.ops
= &nvme_rdma_mq_ops
;
1775 ctrl
->tag_set
.queue_depth
= ctrl
->ctrl
.opts
->queue_size
;
1776 ctrl
->tag_set
.reserved_tags
= 1; /* fabric connect */
1777 ctrl
->tag_set
.numa_node
= NUMA_NO_NODE
;
1778 ctrl
->tag_set
.flags
= BLK_MQ_F_SHOULD_MERGE
;
1779 ctrl
->tag_set
.cmd_size
= sizeof(struct nvme_rdma_request
) +
1780 SG_CHUNK_SIZE
* sizeof(struct scatterlist
);
1781 ctrl
->tag_set
.driver_data
= ctrl
;
1782 ctrl
->tag_set
.nr_hw_queues
= ctrl
->ctrl
.queue_count
- 1;
1783 ctrl
->tag_set
.timeout
= NVME_IO_TIMEOUT
;
1785 ret
= blk_mq_alloc_tag_set(&ctrl
->tag_set
);
1788 ctrl
->ctrl
.tagset
= &ctrl
->tag_set
;
1790 ctrl
->ctrl
.connect_q
= blk_mq_init_queue(&ctrl
->tag_set
);
1791 if (IS_ERR(ctrl
->ctrl
.connect_q
)) {
1792 ret
= PTR_ERR(ctrl
->ctrl
.connect_q
);
1793 goto out_free_tag_set
;
1796 ret
= nvme_rdma_connect_io_queues(ctrl
);
1798 goto out_cleanup_connect_q
;
1802 out_cleanup_connect_q
:
1803 blk_cleanup_queue(ctrl
->ctrl
.connect_q
);
1805 blk_mq_free_tag_set(&ctrl
->tag_set
);
1807 nvme_rdma_dev_put(ctrl
->device
);
1809 nvme_rdma_free_io_queues(ctrl
);
1813 static struct nvme_ctrl
*nvme_rdma_create_ctrl(struct device
*dev
,
1814 struct nvmf_ctrl_options
*opts
)
1816 struct nvme_rdma_ctrl
*ctrl
;
1821 ctrl
= kzalloc(sizeof(*ctrl
), GFP_KERNEL
);
1823 return ERR_PTR(-ENOMEM
);
1824 ctrl
->ctrl
.opts
= opts
;
1825 INIT_LIST_HEAD(&ctrl
->list
);
1827 if (opts
->mask
& NVMF_OPT_TRSVCID
)
1828 port
= opts
->trsvcid
;
1830 port
= __stringify(NVME_RDMA_IP_PORT
);
1832 ret
= inet_pton_with_scope(&init_net
, AF_UNSPEC
,
1833 opts
->traddr
, port
, &ctrl
->addr
);
1835 pr_err("malformed address passed: %s:%s\n", opts
->traddr
, port
);
1839 if (opts
->mask
& NVMF_OPT_HOST_TRADDR
) {
1840 ret
= inet_pton_with_scope(&init_net
, AF_UNSPEC
,
1841 opts
->host_traddr
, NULL
, &ctrl
->src_addr
);
1843 pr_err("malformed src address passed: %s\n",
1849 ret
= nvme_init_ctrl(&ctrl
->ctrl
, dev
, &nvme_rdma_ctrl_ops
,
1850 0 /* no quirks, we're perfect! */);
1854 INIT_DELAYED_WORK(&ctrl
->reconnect_work
,
1855 nvme_rdma_reconnect_ctrl_work
);
1856 INIT_WORK(&ctrl
->err_work
, nvme_rdma_error_recovery_work
);
1857 INIT_WORK(&ctrl
->delete_work
, nvme_rdma_del_ctrl_work
);
1858 INIT_WORK(&ctrl
->ctrl
.reset_work
, nvme_rdma_reset_ctrl_work
);
1860 ctrl
->ctrl
.queue_count
= opts
->nr_io_queues
+ 1; /* +1 for admin queue */
1861 ctrl
->ctrl
.sqsize
= opts
->queue_size
- 1;
1862 ctrl
->ctrl
.kato
= opts
->kato
;
1865 ctrl
->queues
= kcalloc(ctrl
->ctrl
.queue_count
, sizeof(*ctrl
->queues
),
1868 goto out_uninit_ctrl
;
1870 ret
= nvme_rdma_configure_admin_queue(ctrl
);
1872 goto out_kfree_queues
;
1874 /* sanity check icdoff */
1875 if (ctrl
->ctrl
.icdoff
) {
1876 dev_err(ctrl
->ctrl
.device
, "icdoff is not supported!\n");
1878 goto out_remove_admin_queue
;
1881 /* sanity check keyed sgls */
1882 if (!(ctrl
->ctrl
.sgls
& (1 << 20))) {
1883 dev_err(ctrl
->ctrl
.device
, "Mandatory keyed sgls are not support\n");
1885 goto out_remove_admin_queue
;
1888 if (opts
->queue_size
> ctrl
->ctrl
.maxcmd
) {
1889 /* warn if maxcmd is lower than queue_size */
1890 dev_warn(ctrl
->ctrl
.device
,
1891 "queue_size %zu > ctrl maxcmd %u, clamping down\n",
1892 opts
->queue_size
, ctrl
->ctrl
.maxcmd
);
1893 opts
->queue_size
= ctrl
->ctrl
.maxcmd
;
1896 if (opts
->queue_size
> ctrl
->ctrl
.sqsize
+ 1) {
1897 /* warn if sqsize is lower than queue_size */
1898 dev_warn(ctrl
->ctrl
.device
,
1899 "queue_size %zu > ctrl sqsize %u, clamping down\n",
1900 opts
->queue_size
, ctrl
->ctrl
.sqsize
+ 1);
1901 opts
->queue_size
= ctrl
->ctrl
.sqsize
+ 1;
1904 if (opts
->nr_io_queues
) {
1905 ret
= nvme_rdma_create_io_queues(ctrl
);
1907 goto out_remove_admin_queue
;
1910 changed
= nvme_change_ctrl_state(&ctrl
->ctrl
, NVME_CTRL_LIVE
);
1911 WARN_ON_ONCE(!changed
);
1913 dev_info(ctrl
->ctrl
.device
, "new ctrl: NQN \"%s\", addr %pISpcs\n",
1914 ctrl
->ctrl
.opts
->subsysnqn
, &ctrl
->addr
);
1916 kref_get(&ctrl
->ctrl
.kref
);
1918 mutex_lock(&nvme_rdma_ctrl_mutex
);
1919 list_add_tail(&ctrl
->list
, &nvme_rdma_ctrl_list
);
1920 mutex_unlock(&nvme_rdma_ctrl_mutex
);
1922 nvme_start_ctrl(&ctrl
->ctrl
);
1926 out_remove_admin_queue
:
1927 nvme_rdma_destroy_admin_queue(ctrl
);
1929 kfree(ctrl
->queues
);
1931 nvme_uninit_ctrl(&ctrl
->ctrl
);
1932 nvme_put_ctrl(&ctrl
->ctrl
);
1935 return ERR_PTR(ret
);
1938 return ERR_PTR(ret
);
1941 static struct nvmf_transport_ops nvme_rdma_transport
= {
1943 .required_opts
= NVMF_OPT_TRADDR
,
1944 .allowed_opts
= NVMF_OPT_TRSVCID
| NVMF_OPT_RECONNECT_DELAY
|
1945 NVMF_OPT_HOST_TRADDR
| NVMF_OPT_CTRL_LOSS_TMO
,
1946 .create_ctrl
= nvme_rdma_create_ctrl
,
1949 static void nvme_rdma_add_one(struct ib_device
*ib_device
)
1953 static void nvme_rdma_remove_one(struct ib_device
*ib_device
, void *client_data
)
1955 struct nvme_rdma_ctrl
*ctrl
;
1957 /* Delete all controllers using this device */
1958 mutex_lock(&nvme_rdma_ctrl_mutex
);
1959 list_for_each_entry(ctrl
, &nvme_rdma_ctrl_list
, list
) {
1960 if (ctrl
->device
->dev
!= ib_device
)
1962 dev_info(ctrl
->ctrl
.device
,
1963 "Removing ctrl: NQN \"%s\", addr %pISp\n",
1964 ctrl
->ctrl
.opts
->subsysnqn
, &ctrl
->addr
);
1965 __nvme_rdma_del_ctrl(ctrl
);
1967 mutex_unlock(&nvme_rdma_ctrl_mutex
);
1969 flush_workqueue(nvme_wq
);
1972 static struct ib_client nvme_rdma_ib_client
= {
1973 .name
= "nvme_rdma",
1974 .add
= nvme_rdma_add_one
,
1975 .remove
= nvme_rdma_remove_one
1978 static int __init
nvme_rdma_init_module(void)
1982 ret
= ib_register_client(&nvme_rdma_ib_client
);
1986 ret
= nvmf_register_transport(&nvme_rdma_transport
);
1988 goto err_unreg_client
;
1993 ib_unregister_client(&nvme_rdma_ib_client
);
1997 static void __exit
nvme_rdma_cleanup_module(void)
1999 nvmf_unregister_transport(&nvme_rdma_transport
);
2000 ib_unregister_client(&nvme_rdma_ib_client
);
2003 module_init(nvme_rdma_init_module
);
2004 module_exit(nvme_rdma_cleanup_module
);
2006 MODULE_LICENSE("GPL v2");