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/blk-mq-rdma.h>
23 #include <linux/types.h>
24 #include <linux/list.h>
25 #include <linux/mutex.h>
26 #include <linux/scatterlist.h>
27 #include <linux/nvme.h>
28 #include <asm/unaligned.h>
30 #include <rdma/ib_verbs.h>
31 #include <rdma/rdma_cm.h>
32 #include <linux/nvme-rdma.h>
38 #define NVME_RDMA_CONNECT_TIMEOUT_MS 3000 /* 3 second */
40 #define NVME_RDMA_MAX_SEGMENTS 256
42 #define NVME_RDMA_MAX_INLINE_SEGMENTS 1
45 * We handle AEN commands ourselves and don't even let the
46 * block layer know about them.
48 #define NVME_RDMA_NR_AEN_COMMANDS 1
49 #define NVME_RDMA_AQ_BLKMQ_DEPTH \
50 (NVME_AQ_DEPTH - NVME_RDMA_NR_AEN_COMMANDS)
52 struct nvme_rdma_device
{
53 struct ib_device
*dev
;
56 struct list_head entry
;
65 struct nvme_rdma_queue
;
66 struct nvme_rdma_request
{
67 struct nvme_request req
;
69 struct nvme_rdma_qe sqe
;
70 struct ib_sge sge
[1 + NVME_RDMA_MAX_INLINE_SEGMENTS
];
74 struct ib_reg_wr reg_wr
;
75 struct ib_cqe reg_cqe
;
76 struct nvme_rdma_queue
*queue
;
77 struct sg_table sg_table
;
78 struct scatterlist first_sgl
[];
81 enum nvme_rdma_queue_flags
{
83 NVME_RDMA_Q_DELETING
= 1,
86 struct nvme_rdma_queue
{
87 struct nvme_rdma_qe
*rsp_ring
;
90 size_t cmnd_capsule_len
;
91 struct nvme_rdma_ctrl
*ctrl
;
92 struct nvme_rdma_device
*device
;
97 struct rdma_cm_id
*cm_id
;
99 struct completion cm_done
;
102 struct nvme_rdma_ctrl
{
103 /* read only in the hot path */
104 struct nvme_rdma_queue
*queues
;
106 /* other member variables */
107 struct blk_mq_tag_set tag_set
;
108 struct work_struct delete_work
;
109 struct work_struct err_work
;
111 struct nvme_rdma_qe async_event_sqe
;
113 struct delayed_work reconnect_work
;
115 struct list_head list
;
117 struct blk_mq_tag_set admin_tag_set
;
118 struct nvme_rdma_device
*device
;
122 struct sockaddr_storage addr
;
123 struct sockaddr_storage src_addr
;
125 struct nvme_ctrl ctrl
;
128 static inline struct nvme_rdma_ctrl
*to_rdma_ctrl(struct nvme_ctrl
*ctrl
)
130 return container_of(ctrl
, struct nvme_rdma_ctrl
, ctrl
);
133 static LIST_HEAD(device_list
);
134 static DEFINE_MUTEX(device_list_mutex
);
136 static LIST_HEAD(nvme_rdma_ctrl_list
);
137 static DEFINE_MUTEX(nvme_rdma_ctrl_mutex
);
140 * Disabling this option makes small I/O goes faster, but is fundamentally
141 * unsafe. With it turned off we will have to register a global rkey that
142 * allows read and write access to all physical memory.
144 static bool register_always
= true;
145 module_param(register_always
, bool, 0444);
146 MODULE_PARM_DESC(register_always
,
147 "Use memory registration even for contiguous memory regions");
149 static int nvme_rdma_cm_handler(struct rdma_cm_id
*cm_id
,
150 struct rdma_cm_event
*event
);
151 static void nvme_rdma_recv_done(struct ib_cq
*cq
, struct ib_wc
*wc
);
153 static const struct blk_mq_ops nvme_rdma_mq_ops
;
154 static const struct blk_mq_ops nvme_rdma_admin_mq_ops
;
156 /* XXX: really should move to a generic header sooner or later.. */
157 static inline void put_unaligned_le24(u32 val
, u8
*p
)
164 static inline int nvme_rdma_queue_idx(struct nvme_rdma_queue
*queue
)
166 return queue
- queue
->ctrl
->queues
;
169 static inline size_t nvme_rdma_inline_data_size(struct nvme_rdma_queue
*queue
)
171 return queue
->cmnd_capsule_len
- sizeof(struct nvme_command
);
174 static void nvme_rdma_free_qe(struct ib_device
*ibdev
, struct nvme_rdma_qe
*qe
,
175 size_t capsule_size
, enum dma_data_direction dir
)
177 ib_dma_unmap_single(ibdev
, qe
->dma
, capsule_size
, dir
);
181 static int nvme_rdma_alloc_qe(struct ib_device
*ibdev
, struct nvme_rdma_qe
*qe
,
182 size_t capsule_size
, enum dma_data_direction dir
)
184 qe
->data
= kzalloc(capsule_size
, GFP_KERNEL
);
188 qe
->dma
= ib_dma_map_single(ibdev
, qe
->data
, capsule_size
, dir
);
189 if (ib_dma_mapping_error(ibdev
, qe
->dma
)) {
197 static void nvme_rdma_free_ring(struct ib_device
*ibdev
,
198 struct nvme_rdma_qe
*ring
, size_t ib_queue_size
,
199 size_t capsule_size
, enum dma_data_direction dir
)
203 for (i
= 0; i
< ib_queue_size
; i
++)
204 nvme_rdma_free_qe(ibdev
, &ring
[i
], capsule_size
, dir
);
208 static struct nvme_rdma_qe
*nvme_rdma_alloc_ring(struct ib_device
*ibdev
,
209 size_t ib_queue_size
, size_t capsule_size
,
210 enum dma_data_direction dir
)
212 struct nvme_rdma_qe
*ring
;
215 ring
= kcalloc(ib_queue_size
, sizeof(struct nvme_rdma_qe
), GFP_KERNEL
);
219 for (i
= 0; i
< ib_queue_size
; i
++) {
220 if (nvme_rdma_alloc_qe(ibdev
, &ring
[i
], capsule_size
, dir
))
227 nvme_rdma_free_ring(ibdev
, ring
, i
, capsule_size
, dir
);
231 static void nvme_rdma_qp_event(struct ib_event
*event
, void *context
)
233 pr_debug("QP event %s (%d)\n",
234 ib_event_msg(event
->event
), event
->event
);
238 static int nvme_rdma_wait_for_cm(struct nvme_rdma_queue
*queue
)
240 wait_for_completion_interruptible_timeout(&queue
->cm_done
,
241 msecs_to_jiffies(NVME_RDMA_CONNECT_TIMEOUT_MS
) + 1);
242 return queue
->cm_error
;
245 static int nvme_rdma_create_qp(struct nvme_rdma_queue
*queue
, const int factor
)
247 struct nvme_rdma_device
*dev
= queue
->device
;
248 struct ib_qp_init_attr init_attr
;
251 memset(&init_attr
, 0, sizeof(init_attr
));
252 init_attr
.event_handler
= nvme_rdma_qp_event
;
254 init_attr
.cap
.max_send_wr
= factor
* queue
->queue_size
+ 1;
256 init_attr
.cap
.max_recv_wr
= queue
->queue_size
+ 1;
257 init_attr
.cap
.max_recv_sge
= 1;
258 init_attr
.cap
.max_send_sge
= 1 + NVME_RDMA_MAX_INLINE_SEGMENTS
;
259 init_attr
.sq_sig_type
= IB_SIGNAL_REQ_WR
;
260 init_attr
.qp_type
= IB_QPT_RC
;
261 init_attr
.send_cq
= queue
->ib_cq
;
262 init_attr
.recv_cq
= queue
->ib_cq
;
264 ret
= rdma_create_qp(queue
->cm_id
, dev
->pd
, &init_attr
);
266 queue
->qp
= queue
->cm_id
->qp
;
270 static int nvme_rdma_reinit_request(void *data
, struct request
*rq
)
272 struct nvme_rdma_ctrl
*ctrl
= data
;
273 struct nvme_rdma_device
*dev
= ctrl
->device
;
274 struct nvme_rdma_request
*req
= blk_mq_rq_to_pdu(rq
);
277 if (WARN_ON_ONCE(!req
->mr
))
280 ib_dereg_mr(req
->mr
);
282 req
->mr
= ib_alloc_mr(dev
->pd
, IB_MR_TYPE_MEM_REG
,
284 if (IS_ERR(req
->mr
)) {
285 ret
= PTR_ERR(req
->mr
);
290 req
->mr
->need_inval
= false;
296 static void nvme_rdma_exit_request(struct blk_mq_tag_set
*set
,
297 struct request
*rq
, unsigned int hctx_idx
)
299 struct nvme_rdma_ctrl
*ctrl
= set
->driver_data
;
300 struct nvme_rdma_request
*req
= blk_mq_rq_to_pdu(rq
);
301 int queue_idx
= (set
== &ctrl
->tag_set
) ? hctx_idx
+ 1 : 0;
302 struct nvme_rdma_queue
*queue
= &ctrl
->queues
[queue_idx
];
303 struct nvme_rdma_device
*dev
= queue
->device
;
306 ib_dereg_mr(req
->mr
);
308 nvme_rdma_free_qe(dev
->dev
, &req
->sqe
, sizeof(struct nvme_command
),
312 static int nvme_rdma_init_request(struct blk_mq_tag_set
*set
,
313 struct request
*rq
, unsigned int hctx_idx
,
314 unsigned int numa_node
)
316 struct nvme_rdma_ctrl
*ctrl
= set
->driver_data
;
317 struct nvme_rdma_request
*req
= blk_mq_rq_to_pdu(rq
);
318 int queue_idx
= (set
== &ctrl
->tag_set
) ? hctx_idx
+ 1 : 0;
319 struct nvme_rdma_queue
*queue
= &ctrl
->queues
[queue_idx
];
320 struct nvme_rdma_device
*dev
= queue
->device
;
321 struct ib_device
*ibdev
= dev
->dev
;
324 ret
= nvme_rdma_alloc_qe(ibdev
, &req
->sqe
, sizeof(struct nvme_command
),
329 req
->mr
= ib_alloc_mr(dev
->pd
, IB_MR_TYPE_MEM_REG
,
331 if (IS_ERR(req
->mr
)) {
332 ret
= PTR_ERR(req
->mr
);
341 nvme_rdma_free_qe(dev
->dev
, &req
->sqe
, sizeof(struct nvme_command
),
346 static int nvme_rdma_init_hctx(struct blk_mq_hw_ctx
*hctx
, void *data
,
347 unsigned int hctx_idx
)
349 struct nvme_rdma_ctrl
*ctrl
= data
;
350 struct nvme_rdma_queue
*queue
= &ctrl
->queues
[hctx_idx
+ 1];
352 BUG_ON(hctx_idx
>= ctrl
->ctrl
.queue_count
);
354 hctx
->driver_data
= queue
;
358 static int nvme_rdma_init_admin_hctx(struct blk_mq_hw_ctx
*hctx
, void *data
,
359 unsigned int hctx_idx
)
361 struct nvme_rdma_ctrl
*ctrl
= data
;
362 struct nvme_rdma_queue
*queue
= &ctrl
->queues
[0];
364 BUG_ON(hctx_idx
!= 0);
366 hctx
->driver_data
= queue
;
370 static void nvme_rdma_free_dev(struct kref
*ref
)
372 struct nvme_rdma_device
*ndev
=
373 container_of(ref
, struct nvme_rdma_device
, ref
);
375 mutex_lock(&device_list_mutex
);
376 list_del(&ndev
->entry
);
377 mutex_unlock(&device_list_mutex
);
379 ib_dealloc_pd(ndev
->pd
);
383 static void nvme_rdma_dev_put(struct nvme_rdma_device
*dev
)
385 kref_put(&dev
->ref
, nvme_rdma_free_dev
);
388 static int nvme_rdma_dev_get(struct nvme_rdma_device
*dev
)
390 return kref_get_unless_zero(&dev
->ref
);
393 static struct nvme_rdma_device
*
394 nvme_rdma_find_get_device(struct rdma_cm_id
*cm_id
)
396 struct nvme_rdma_device
*ndev
;
398 mutex_lock(&device_list_mutex
);
399 list_for_each_entry(ndev
, &device_list
, entry
) {
400 if (ndev
->dev
->node_guid
== cm_id
->device
->node_guid
&&
401 nvme_rdma_dev_get(ndev
))
405 ndev
= kzalloc(sizeof(*ndev
), GFP_KERNEL
);
409 ndev
->dev
= cm_id
->device
;
410 kref_init(&ndev
->ref
);
412 ndev
->pd
= ib_alloc_pd(ndev
->dev
,
413 register_always
? 0 : IB_PD_UNSAFE_GLOBAL_RKEY
);
414 if (IS_ERR(ndev
->pd
))
417 if (!(ndev
->dev
->attrs
.device_cap_flags
&
418 IB_DEVICE_MEM_MGT_EXTENSIONS
)) {
419 dev_err(&ndev
->dev
->dev
,
420 "Memory registrations not supported.\n");
424 list_add(&ndev
->entry
, &device_list
);
426 mutex_unlock(&device_list_mutex
);
430 ib_dealloc_pd(ndev
->pd
);
434 mutex_unlock(&device_list_mutex
);
438 static void nvme_rdma_destroy_queue_ib(struct nvme_rdma_queue
*queue
)
440 struct nvme_rdma_device
*dev
= queue
->device
;
441 struct ib_device
*ibdev
= dev
->dev
;
443 rdma_destroy_qp(queue
->cm_id
);
444 ib_free_cq(queue
->ib_cq
);
446 nvme_rdma_free_ring(ibdev
, queue
->rsp_ring
, queue
->queue_size
,
447 sizeof(struct nvme_completion
), DMA_FROM_DEVICE
);
449 nvme_rdma_dev_put(dev
);
452 static int nvme_rdma_create_queue_ib(struct nvme_rdma_queue
*queue
)
454 struct ib_device
*ibdev
;
455 const int send_wr_factor
= 3; /* MR, SEND, INV */
456 const int cq_factor
= send_wr_factor
+ 1; /* + RECV */
457 int comp_vector
, idx
= nvme_rdma_queue_idx(queue
);
460 queue
->device
= nvme_rdma_find_get_device(queue
->cm_id
);
461 if (!queue
->device
) {
462 dev_err(queue
->cm_id
->device
->dev
.parent
,
463 "no client data found!\n");
464 return -ECONNREFUSED
;
466 ibdev
= queue
->device
->dev
;
469 * Spread I/O queues completion vectors according their queue index.
470 * Admin queues can always go on completion vector 0.
472 comp_vector
= idx
== 0 ? idx
: idx
- 1;
474 /* +1 for ib_stop_cq */
475 queue
->ib_cq
= ib_alloc_cq(ibdev
, queue
,
476 cq_factor
* queue
->queue_size
+ 1,
477 comp_vector
, IB_POLL_SOFTIRQ
);
478 if (IS_ERR(queue
->ib_cq
)) {
479 ret
= PTR_ERR(queue
->ib_cq
);
483 ret
= nvme_rdma_create_qp(queue
, send_wr_factor
);
485 goto out_destroy_ib_cq
;
487 queue
->rsp_ring
= nvme_rdma_alloc_ring(ibdev
, queue
->queue_size
,
488 sizeof(struct nvme_completion
), DMA_FROM_DEVICE
);
489 if (!queue
->rsp_ring
) {
497 ib_destroy_qp(queue
->qp
);
499 ib_free_cq(queue
->ib_cq
);
501 nvme_rdma_dev_put(queue
->device
);
505 static int nvme_rdma_alloc_queue(struct nvme_rdma_ctrl
*ctrl
,
506 int idx
, size_t queue_size
)
508 struct nvme_rdma_queue
*queue
;
509 struct sockaddr
*src_addr
= NULL
;
512 queue
= &ctrl
->queues
[idx
];
514 init_completion(&queue
->cm_done
);
517 queue
->cmnd_capsule_len
= ctrl
->ctrl
.ioccsz
* 16;
519 queue
->cmnd_capsule_len
= sizeof(struct nvme_command
);
521 queue
->queue_size
= queue_size
;
522 atomic_set(&queue
->sig_count
, 0);
524 queue
->cm_id
= rdma_create_id(&init_net
, nvme_rdma_cm_handler
, queue
,
525 RDMA_PS_TCP
, IB_QPT_RC
);
526 if (IS_ERR(queue
->cm_id
)) {
527 dev_info(ctrl
->ctrl
.device
,
528 "failed to create CM ID: %ld\n", PTR_ERR(queue
->cm_id
));
529 return PTR_ERR(queue
->cm_id
);
532 if (ctrl
->ctrl
.opts
->mask
& NVMF_OPT_HOST_TRADDR
)
533 src_addr
= (struct sockaddr
*)&ctrl
->src_addr
;
535 queue
->cm_error
= -ETIMEDOUT
;
536 ret
= rdma_resolve_addr(queue
->cm_id
, src_addr
,
537 (struct sockaddr
*)&ctrl
->addr
,
538 NVME_RDMA_CONNECT_TIMEOUT_MS
);
540 dev_info(ctrl
->ctrl
.device
,
541 "rdma_resolve_addr failed (%d).\n", ret
);
542 goto out_destroy_cm_id
;
545 ret
= nvme_rdma_wait_for_cm(queue
);
547 dev_info(ctrl
->ctrl
.device
,
548 "rdma connection establishment failed (%d)\n", ret
);
549 goto out_destroy_cm_id
;
552 clear_bit(NVME_RDMA_Q_DELETING
, &queue
->flags
);
557 rdma_destroy_id(queue
->cm_id
);
561 static void nvme_rdma_stop_queue(struct nvme_rdma_queue
*queue
)
563 if (!test_and_clear_bit(NVME_RDMA_Q_LIVE
, &queue
->flags
))
566 rdma_disconnect(queue
->cm_id
);
567 ib_drain_qp(queue
->qp
);
570 static void nvme_rdma_free_queue(struct nvme_rdma_queue
*queue
)
572 if (test_and_set_bit(NVME_RDMA_Q_DELETING
, &queue
->flags
))
575 nvme_rdma_destroy_queue_ib(queue
);
576 rdma_destroy_id(queue
->cm_id
);
579 static void nvme_rdma_free_io_queues(struct nvme_rdma_ctrl
*ctrl
)
583 for (i
= 1; i
< ctrl
->ctrl
.queue_count
; i
++)
584 nvme_rdma_free_queue(&ctrl
->queues
[i
]);
587 static void nvme_rdma_stop_io_queues(struct nvme_rdma_ctrl
*ctrl
)
591 for (i
= 1; i
< ctrl
->ctrl
.queue_count
; i
++)
592 nvme_rdma_stop_queue(&ctrl
->queues
[i
]);
595 static int nvme_rdma_start_queue(struct nvme_rdma_ctrl
*ctrl
, int idx
)
600 ret
= nvmf_connect_io_queue(&ctrl
->ctrl
, idx
);
602 ret
= nvmf_connect_admin_queue(&ctrl
->ctrl
);
605 set_bit(NVME_RDMA_Q_LIVE
, &ctrl
->queues
[idx
].flags
);
607 dev_info(ctrl
->ctrl
.device
,
608 "failed to connect queue: %d ret=%d\n", idx
, ret
);
612 static int nvme_rdma_start_io_queues(struct nvme_rdma_ctrl
*ctrl
)
616 for (i
= 1; i
< ctrl
->ctrl
.queue_count
; i
++) {
617 ret
= nvme_rdma_start_queue(ctrl
, i
);
619 goto out_stop_queues
;
625 for (i
--; i
>= 1; i
--)
626 nvme_rdma_stop_queue(&ctrl
->queues
[i
]);
630 static int nvme_rdma_alloc_io_queues(struct nvme_rdma_ctrl
*ctrl
)
632 struct nvmf_ctrl_options
*opts
= ctrl
->ctrl
.opts
;
633 struct ib_device
*ibdev
= ctrl
->device
->dev
;
634 unsigned int nr_io_queues
;
637 nr_io_queues
= min(opts
->nr_io_queues
, num_online_cpus());
640 * we map queues according to the device irq vectors for
641 * optimal locality so we don't need more queues than
642 * completion vectors.
644 nr_io_queues
= min_t(unsigned int, nr_io_queues
,
645 ibdev
->num_comp_vectors
);
647 ret
= nvme_set_queue_count(&ctrl
->ctrl
, &nr_io_queues
);
651 ctrl
->ctrl
.queue_count
= nr_io_queues
+ 1;
652 if (ctrl
->ctrl
.queue_count
< 2)
655 dev_info(ctrl
->ctrl
.device
,
656 "creating %d I/O queues.\n", nr_io_queues
);
658 for (i
= 1; i
< ctrl
->ctrl
.queue_count
; i
++) {
659 ret
= nvme_rdma_alloc_queue(ctrl
, i
,
660 ctrl
->ctrl
.sqsize
+ 1);
662 goto out_free_queues
;
668 for (i
--; i
>= 1; i
--)
669 nvme_rdma_free_queue(&ctrl
->queues
[i
]);
674 static void nvme_rdma_free_tagset(struct nvme_ctrl
*nctrl
,
675 struct blk_mq_tag_set
*set
)
677 struct nvme_rdma_ctrl
*ctrl
= to_rdma_ctrl(nctrl
);
679 blk_mq_free_tag_set(set
);
680 nvme_rdma_dev_put(ctrl
->device
);
683 static struct blk_mq_tag_set
*nvme_rdma_alloc_tagset(struct nvme_ctrl
*nctrl
,
686 struct nvme_rdma_ctrl
*ctrl
= to_rdma_ctrl(nctrl
);
687 struct blk_mq_tag_set
*set
;
691 set
= &ctrl
->admin_tag_set
;
692 memset(set
, 0, sizeof(*set
));
693 set
->ops
= &nvme_rdma_admin_mq_ops
;
694 set
->queue_depth
= NVME_RDMA_AQ_BLKMQ_DEPTH
;
695 set
->reserved_tags
= 2; /* connect + keep-alive */
696 set
->numa_node
= NUMA_NO_NODE
;
697 set
->cmd_size
= sizeof(struct nvme_rdma_request
) +
698 SG_CHUNK_SIZE
* sizeof(struct scatterlist
);
699 set
->driver_data
= ctrl
;
700 set
->nr_hw_queues
= 1;
701 set
->timeout
= ADMIN_TIMEOUT
;
703 set
= &ctrl
->tag_set
;
704 memset(set
, 0, sizeof(*set
));
705 set
->ops
= &nvme_rdma_mq_ops
;
706 set
->queue_depth
= nctrl
->opts
->queue_size
;
707 set
->reserved_tags
= 1; /* fabric connect */
708 set
->numa_node
= NUMA_NO_NODE
;
709 set
->flags
= BLK_MQ_F_SHOULD_MERGE
;
710 set
->cmd_size
= sizeof(struct nvme_rdma_request
) +
711 SG_CHUNK_SIZE
* sizeof(struct scatterlist
);
712 set
->driver_data
= ctrl
;
713 set
->nr_hw_queues
= nctrl
->queue_count
- 1;
714 set
->timeout
= NVME_IO_TIMEOUT
;
717 ret
= blk_mq_alloc_tag_set(set
);
722 * We need a reference on the device as long as the tag_set is alive,
723 * as the MRs in the request structures need a valid ib_device.
725 ret
= nvme_rdma_dev_get(ctrl
->device
);
728 goto out_free_tagset
;
734 blk_mq_free_tag_set(set
);
739 static void nvme_rdma_destroy_admin_queue(struct nvme_rdma_ctrl
*ctrl
,
742 nvme_rdma_free_qe(ctrl
->queues
[0].device
->dev
, &ctrl
->async_event_sqe
,
743 sizeof(struct nvme_command
), DMA_TO_DEVICE
);
744 nvme_rdma_stop_queue(&ctrl
->queues
[0]);
746 blk_cleanup_queue(ctrl
->ctrl
.admin_q
);
747 nvme_rdma_free_tagset(&ctrl
->ctrl
, ctrl
->ctrl
.admin_tagset
);
749 nvme_rdma_free_queue(&ctrl
->queues
[0]);
752 static int nvme_rdma_configure_admin_queue(struct nvme_rdma_ctrl
*ctrl
,
757 error
= nvme_rdma_alloc_queue(ctrl
, 0, NVME_AQ_DEPTH
);
761 ctrl
->device
= ctrl
->queues
[0].device
;
763 ctrl
->max_fr_pages
= min_t(u32
, NVME_RDMA_MAX_SEGMENTS
,
764 ctrl
->device
->dev
->attrs
.max_fast_reg_page_list_len
);
767 ctrl
->ctrl
.admin_tagset
= nvme_rdma_alloc_tagset(&ctrl
->ctrl
, true);
768 if (IS_ERR(ctrl
->ctrl
.admin_tagset
))
771 ctrl
->ctrl
.admin_q
= blk_mq_init_queue(&ctrl
->admin_tag_set
);
772 if (IS_ERR(ctrl
->ctrl
.admin_q
)) {
773 error
= PTR_ERR(ctrl
->ctrl
.admin_q
);
774 goto out_free_tagset
;
777 error
= nvme_reinit_tagset(&ctrl
->ctrl
, ctrl
->ctrl
.admin_tagset
);
782 error
= nvme_rdma_start_queue(ctrl
, 0);
784 goto out_cleanup_queue
;
786 error
= ctrl
->ctrl
.ops
->reg_read64(&ctrl
->ctrl
, NVME_REG_CAP
,
789 dev_err(ctrl
->ctrl
.device
,
790 "prop_get NVME_REG_CAP failed\n");
791 goto out_cleanup_queue
;
795 min_t(int, NVME_CAP_MQES(ctrl
->ctrl
.cap
), ctrl
->ctrl
.sqsize
);
797 error
= nvme_enable_ctrl(&ctrl
->ctrl
, ctrl
->ctrl
.cap
);
799 goto out_cleanup_queue
;
801 ctrl
->ctrl
.max_hw_sectors
=
802 (ctrl
->max_fr_pages
- 1) << (ilog2(SZ_4K
) - 9);
804 error
= nvme_init_identify(&ctrl
->ctrl
);
806 goto out_cleanup_queue
;
808 error
= nvme_rdma_alloc_qe(ctrl
->queues
[0].device
->dev
,
809 &ctrl
->async_event_sqe
, sizeof(struct nvme_command
),
812 goto out_cleanup_queue
;
818 blk_cleanup_queue(ctrl
->ctrl
.admin_q
);
821 nvme_rdma_free_tagset(&ctrl
->ctrl
, ctrl
->ctrl
.admin_tagset
);
823 nvme_rdma_free_queue(&ctrl
->queues
[0]);
827 static void nvme_rdma_destroy_io_queues(struct nvme_rdma_ctrl
*ctrl
,
830 nvme_rdma_stop_io_queues(ctrl
);
832 blk_cleanup_queue(ctrl
->ctrl
.connect_q
);
833 nvme_rdma_free_tagset(&ctrl
->ctrl
, ctrl
->ctrl
.tagset
);
835 nvme_rdma_free_io_queues(ctrl
);
838 static int nvme_rdma_configure_io_queues(struct nvme_rdma_ctrl
*ctrl
, bool new)
842 ret
= nvme_rdma_alloc_io_queues(ctrl
);
847 ctrl
->ctrl
.tagset
= nvme_rdma_alloc_tagset(&ctrl
->ctrl
, false);
848 if (IS_ERR(ctrl
->ctrl
.tagset
))
849 goto out_free_io_queues
;
851 ctrl
->ctrl
.connect_q
= blk_mq_init_queue(&ctrl
->tag_set
);
852 if (IS_ERR(ctrl
->ctrl
.connect_q
)) {
853 ret
= PTR_ERR(ctrl
->ctrl
.connect_q
);
854 goto out_free_tag_set
;
857 ret
= nvme_reinit_tagset(&ctrl
->ctrl
, ctrl
->ctrl
.tagset
);
859 goto out_free_io_queues
;
861 blk_mq_update_nr_hw_queues(&ctrl
->tag_set
,
862 ctrl
->ctrl
.queue_count
- 1);
865 ret
= nvme_rdma_start_io_queues(ctrl
);
867 goto out_cleanup_connect_q
;
871 out_cleanup_connect_q
:
873 blk_cleanup_queue(ctrl
->ctrl
.connect_q
);
876 nvme_rdma_free_tagset(&ctrl
->ctrl
, ctrl
->ctrl
.tagset
);
878 nvme_rdma_free_io_queues(ctrl
);
882 static void nvme_rdma_free_ctrl(struct nvme_ctrl
*nctrl
)
884 struct nvme_rdma_ctrl
*ctrl
= to_rdma_ctrl(nctrl
);
886 if (list_empty(&ctrl
->list
))
889 mutex_lock(&nvme_rdma_ctrl_mutex
);
890 list_del(&ctrl
->list
);
891 mutex_unlock(&nvme_rdma_ctrl_mutex
);
894 nvmf_free_options(nctrl
->opts
);
899 static void nvme_rdma_reconnect_or_remove(struct nvme_rdma_ctrl
*ctrl
)
901 /* If we are resetting/deleting then do nothing */
902 if (ctrl
->ctrl
.state
!= NVME_CTRL_RECONNECTING
) {
903 WARN_ON_ONCE(ctrl
->ctrl
.state
== NVME_CTRL_NEW
||
904 ctrl
->ctrl
.state
== NVME_CTRL_LIVE
);
908 if (nvmf_should_reconnect(&ctrl
->ctrl
)) {
909 dev_info(ctrl
->ctrl
.device
, "Reconnecting in %d seconds...\n",
910 ctrl
->ctrl
.opts
->reconnect_delay
);
911 queue_delayed_work(nvme_wq
, &ctrl
->reconnect_work
,
912 ctrl
->ctrl
.opts
->reconnect_delay
* HZ
);
914 dev_info(ctrl
->ctrl
.device
, "Removing controller...\n");
915 queue_work(nvme_wq
, &ctrl
->delete_work
);
919 static void nvme_rdma_reconnect_ctrl_work(struct work_struct
*work
)
921 struct nvme_rdma_ctrl
*ctrl
= container_of(to_delayed_work(work
),
922 struct nvme_rdma_ctrl
, reconnect_work
);
926 ++ctrl
->ctrl
.nr_reconnects
;
928 ret
= nvme_rdma_configure_admin_queue(ctrl
, false);
932 if (ctrl
->ctrl
.queue_count
> 1) {
933 ret
= nvme_rdma_configure_io_queues(ctrl
, false);
938 changed
= nvme_change_ctrl_state(&ctrl
->ctrl
, NVME_CTRL_LIVE
);
940 /* state change failure is ok if we're in DELETING state */
941 WARN_ON_ONCE(ctrl
->ctrl
.state
!= NVME_CTRL_DELETING
);
945 nvme_start_ctrl(&ctrl
->ctrl
);
947 dev_info(ctrl
->ctrl
.device
, "Successfully reconnected (%d attempts)\n",
948 ctrl
->ctrl
.nr_reconnects
);
950 ctrl
->ctrl
.nr_reconnects
= 0;
955 nvme_rdma_destroy_admin_queue(ctrl
, false);
957 dev_info(ctrl
->ctrl
.device
, "Failed reconnect attempt %d\n",
958 ctrl
->ctrl
.nr_reconnects
);
959 nvme_rdma_reconnect_or_remove(ctrl
);
962 static void nvme_rdma_error_recovery_work(struct work_struct
*work
)
964 struct nvme_rdma_ctrl
*ctrl
= container_of(work
,
965 struct nvme_rdma_ctrl
, err_work
);
967 nvme_stop_keep_alive(&ctrl
->ctrl
);
969 if (ctrl
->ctrl
.queue_count
> 1) {
970 nvme_stop_queues(&ctrl
->ctrl
);
971 blk_mq_tagset_busy_iter(&ctrl
->tag_set
,
972 nvme_cancel_request
, &ctrl
->ctrl
);
973 nvme_rdma_destroy_io_queues(ctrl
, false);
976 blk_mq_quiesce_queue(ctrl
->ctrl
.admin_q
);
977 blk_mq_tagset_busy_iter(&ctrl
->admin_tag_set
,
978 nvme_cancel_request
, &ctrl
->ctrl
);
979 nvme_rdma_destroy_admin_queue(ctrl
, false);
982 * queues are not a live anymore, so restart the queues to fail fast
985 blk_mq_unquiesce_queue(ctrl
->ctrl
.admin_q
);
986 nvme_start_queues(&ctrl
->ctrl
);
988 nvme_rdma_reconnect_or_remove(ctrl
);
991 static void nvme_rdma_error_recovery(struct nvme_rdma_ctrl
*ctrl
)
993 if (!nvme_change_ctrl_state(&ctrl
->ctrl
, NVME_CTRL_RECONNECTING
))
996 queue_work(nvme_wq
, &ctrl
->err_work
);
999 static void nvme_rdma_wr_error(struct ib_cq
*cq
, struct ib_wc
*wc
,
1002 struct nvme_rdma_queue
*queue
= cq
->cq_context
;
1003 struct nvme_rdma_ctrl
*ctrl
= queue
->ctrl
;
1005 if (ctrl
->ctrl
.state
== NVME_CTRL_LIVE
)
1006 dev_info(ctrl
->ctrl
.device
,
1007 "%s for CQE 0x%p failed with status %s (%d)\n",
1009 ib_wc_status_msg(wc
->status
), wc
->status
);
1010 nvme_rdma_error_recovery(ctrl
);
1013 static void nvme_rdma_memreg_done(struct ib_cq
*cq
, struct ib_wc
*wc
)
1015 if (unlikely(wc
->status
!= IB_WC_SUCCESS
))
1016 nvme_rdma_wr_error(cq
, wc
, "MEMREG");
1019 static void nvme_rdma_inv_rkey_done(struct ib_cq
*cq
, struct ib_wc
*wc
)
1021 if (unlikely(wc
->status
!= IB_WC_SUCCESS
))
1022 nvme_rdma_wr_error(cq
, wc
, "LOCAL_INV");
1025 static int nvme_rdma_inv_rkey(struct nvme_rdma_queue
*queue
,
1026 struct nvme_rdma_request
*req
)
1028 struct ib_send_wr
*bad_wr
;
1029 struct ib_send_wr wr
= {
1030 .opcode
= IB_WR_LOCAL_INV
,
1034 .ex
.invalidate_rkey
= req
->mr
->rkey
,
1037 req
->reg_cqe
.done
= nvme_rdma_inv_rkey_done
;
1038 wr
.wr_cqe
= &req
->reg_cqe
;
1040 return ib_post_send(queue
->qp
, &wr
, &bad_wr
);
1043 static void nvme_rdma_unmap_data(struct nvme_rdma_queue
*queue
,
1046 struct nvme_rdma_request
*req
= blk_mq_rq_to_pdu(rq
);
1047 struct nvme_rdma_ctrl
*ctrl
= queue
->ctrl
;
1048 struct nvme_rdma_device
*dev
= queue
->device
;
1049 struct ib_device
*ibdev
= dev
->dev
;
1052 if (!blk_rq_bytes(rq
))
1055 if (req
->mr
->need_inval
) {
1056 res
= nvme_rdma_inv_rkey(queue
, req
);
1057 if (unlikely(res
< 0)) {
1058 dev_err(ctrl
->ctrl
.device
,
1059 "Queueing INV WR for rkey %#x failed (%d)\n",
1060 req
->mr
->rkey
, res
);
1061 nvme_rdma_error_recovery(queue
->ctrl
);
1065 ib_dma_unmap_sg(ibdev
, req
->sg_table
.sgl
,
1066 req
->nents
, rq_data_dir(rq
) ==
1067 WRITE
? DMA_TO_DEVICE
: DMA_FROM_DEVICE
);
1069 nvme_cleanup_cmd(rq
);
1070 sg_free_table_chained(&req
->sg_table
, true);
1073 static int nvme_rdma_set_sg_null(struct nvme_command
*c
)
1075 struct nvme_keyed_sgl_desc
*sg
= &c
->common
.dptr
.ksgl
;
1078 put_unaligned_le24(0, sg
->length
);
1079 put_unaligned_le32(0, sg
->key
);
1080 sg
->type
= NVME_KEY_SGL_FMT_DATA_DESC
<< 4;
1084 static int nvme_rdma_map_sg_inline(struct nvme_rdma_queue
*queue
,
1085 struct nvme_rdma_request
*req
, struct nvme_command
*c
)
1087 struct nvme_sgl_desc
*sg
= &c
->common
.dptr
.sgl
;
1089 req
->sge
[1].addr
= sg_dma_address(req
->sg_table
.sgl
);
1090 req
->sge
[1].length
= sg_dma_len(req
->sg_table
.sgl
);
1091 req
->sge
[1].lkey
= queue
->device
->pd
->local_dma_lkey
;
1093 sg
->addr
= cpu_to_le64(queue
->ctrl
->ctrl
.icdoff
);
1094 sg
->length
= cpu_to_le32(sg_dma_len(req
->sg_table
.sgl
));
1095 sg
->type
= (NVME_SGL_FMT_DATA_DESC
<< 4) | NVME_SGL_FMT_OFFSET
;
1097 req
->inline_data
= true;
1102 static int nvme_rdma_map_sg_single(struct nvme_rdma_queue
*queue
,
1103 struct nvme_rdma_request
*req
, struct nvme_command
*c
)
1105 struct nvme_keyed_sgl_desc
*sg
= &c
->common
.dptr
.ksgl
;
1107 sg
->addr
= cpu_to_le64(sg_dma_address(req
->sg_table
.sgl
));
1108 put_unaligned_le24(sg_dma_len(req
->sg_table
.sgl
), sg
->length
);
1109 put_unaligned_le32(queue
->device
->pd
->unsafe_global_rkey
, sg
->key
);
1110 sg
->type
= NVME_KEY_SGL_FMT_DATA_DESC
<< 4;
1114 static int nvme_rdma_map_sg_fr(struct nvme_rdma_queue
*queue
,
1115 struct nvme_rdma_request
*req
, struct nvme_command
*c
,
1118 struct nvme_keyed_sgl_desc
*sg
= &c
->common
.dptr
.ksgl
;
1122 * Align the MR to a 4K page size to match the ctrl page size and
1123 * the block virtual boundary.
1125 nr
= ib_map_mr_sg(req
->mr
, req
->sg_table
.sgl
, count
, NULL
, SZ_4K
);
1126 if (unlikely(nr
< count
)) {
1132 ib_update_fast_reg_key(req
->mr
, ib_inc_rkey(req
->mr
->rkey
));
1134 req
->reg_cqe
.done
= nvme_rdma_memreg_done
;
1135 memset(&req
->reg_wr
, 0, sizeof(req
->reg_wr
));
1136 req
->reg_wr
.wr
.opcode
= IB_WR_REG_MR
;
1137 req
->reg_wr
.wr
.wr_cqe
= &req
->reg_cqe
;
1138 req
->reg_wr
.wr
.num_sge
= 0;
1139 req
->reg_wr
.mr
= req
->mr
;
1140 req
->reg_wr
.key
= req
->mr
->rkey
;
1141 req
->reg_wr
.access
= IB_ACCESS_LOCAL_WRITE
|
1142 IB_ACCESS_REMOTE_READ
|
1143 IB_ACCESS_REMOTE_WRITE
;
1145 req
->mr
->need_inval
= true;
1147 sg
->addr
= cpu_to_le64(req
->mr
->iova
);
1148 put_unaligned_le24(req
->mr
->length
, sg
->length
);
1149 put_unaligned_le32(req
->mr
->rkey
, sg
->key
);
1150 sg
->type
= (NVME_KEY_SGL_FMT_DATA_DESC
<< 4) |
1151 NVME_SGL_FMT_INVALIDATE
;
1156 static int nvme_rdma_map_data(struct nvme_rdma_queue
*queue
,
1157 struct request
*rq
, struct nvme_command
*c
)
1159 struct nvme_rdma_request
*req
= blk_mq_rq_to_pdu(rq
);
1160 struct nvme_rdma_device
*dev
= queue
->device
;
1161 struct ib_device
*ibdev
= dev
->dev
;
1165 req
->inline_data
= false;
1166 req
->mr
->need_inval
= false;
1168 c
->common
.flags
|= NVME_CMD_SGL_METABUF
;
1170 if (!blk_rq_bytes(rq
))
1171 return nvme_rdma_set_sg_null(c
);
1173 req
->sg_table
.sgl
= req
->first_sgl
;
1174 ret
= sg_alloc_table_chained(&req
->sg_table
,
1175 blk_rq_nr_phys_segments(rq
), req
->sg_table
.sgl
);
1179 req
->nents
= blk_rq_map_sg(rq
->q
, rq
, req
->sg_table
.sgl
);
1181 count
= ib_dma_map_sg(ibdev
, req
->sg_table
.sgl
, req
->nents
,
1182 rq_data_dir(rq
) == WRITE
? DMA_TO_DEVICE
: DMA_FROM_DEVICE
);
1183 if (unlikely(count
<= 0)) {
1184 sg_free_table_chained(&req
->sg_table
, true);
1189 if (rq_data_dir(rq
) == WRITE
&& nvme_rdma_queue_idx(queue
) &&
1190 blk_rq_payload_bytes(rq
) <=
1191 nvme_rdma_inline_data_size(queue
))
1192 return nvme_rdma_map_sg_inline(queue
, req
, c
);
1194 if (dev
->pd
->flags
& IB_PD_UNSAFE_GLOBAL_RKEY
)
1195 return nvme_rdma_map_sg_single(queue
, req
, c
);
1198 return nvme_rdma_map_sg_fr(queue
, req
, c
, count
);
1201 static void nvme_rdma_send_done(struct ib_cq
*cq
, struct ib_wc
*wc
)
1203 if (unlikely(wc
->status
!= IB_WC_SUCCESS
))
1204 nvme_rdma_wr_error(cq
, wc
, "SEND");
1208 * We want to signal completion at least every queue depth/2. This returns the
1209 * largest power of two that is not above half of (queue size + 1) to optimize
1210 * (avoid divisions).
1212 static inline bool nvme_rdma_queue_sig_limit(struct nvme_rdma_queue
*queue
)
1214 int limit
= 1 << ilog2((queue
->queue_size
+ 1) / 2);
1216 return (atomic_inc_return(&queue
->sig_count
) & (limit
- 1)) == 0;
1219 static int nvme_rdma_post_send(struct nvme_rdma_queue
*queue
,
1220 struct nvme_rdma_qe
*qe
, struct ib_sge
*sge
, u32 num_sge
,
1221 struct ib_send_wr
*first
, bool flush
)
1223 struct ib_send_wr wr
, *bad_wr
;
1226 sge
->addr
= qe
->dma
;
1227 sge
->length
= sizeof(struct nvme_command
),
1228 sge
->lkey
= queue
->device
->pd
->local_dma_lkey
;
1230 qe
->cqe
.done
= nvme_rdma_send_done
;
1233 wr
.wr_cqe
= &qe
->cqe
;
1235 wr
.num_sge
= num_sge
;
1236 wr
.opcode
= IB_WR_SEND
;
1240 * Unsignalled send completions are another giant desaster in the
1241 * IB Verbs spec: If we don't regularly post signalled sends
1242 * the send queue will fill up and only a QP reset will rescue us.
1243 * Would have been way to obvious to handle this in hardware or
1244 * at least the RDMA stack..
1246 * Always signal the flushes. The magic request used for the flush
1247 * sequencer is not allocated in our driver's tagset and it's
1248 * triggered to be freed by blk_cleanup_queue(). So we need to
1249 * always mark it as signaled to ensure that the "wr_cqe", which is
1250 * embedded in request's payload, is not freed when __ib_process_cq()
1251 * calls wr_cqe->done().
1253 if (nvme_rdma_queue_sig_limit(queue
) || flush
)
1254 wr
.send_flags
|= IB_SEND_SIGNALED
;
1261 ret
= ib_post_send(queue
->qp
, first
, &bad_wr
);
1262 if (unlikely(ret
)) {
1263 dev_err(queue
->ctrl
->ctrl
.device
,
1264 "%s failed with error code %d\n", __func__
, ret
);
1269 static int nvme_rdma_post_recv(struct nvme_rdma_queue
*queue
,
1270 struct nvme_rdma_qe
*qe
)
1272 struct ib_recv_wr wr
, *bad_wr
;
1276 list
.addr
= qe
->dma
;
1277 list
.length
= sizeof(struct nvme_completion
);
1278 list
.lkey
= queue
->device
->pd
->local_dma_lkey
;
1280 qe
->cqe
.done
= nvme_rdma_recv_done
;
1283 wr
.wr_cqe
= &qe
->cqe
;
1287 ret
= ib_post_recv(queue
->qp
, &wr
, &bad_wr
);
1288 if (unlikely(ret
)) {
1289 dev_err(queue
->ctrl
->ctrl
.device
,
1290 "%s failed with error code %d\n", __func__
, ret
);
1295 static struct blk_mq_tags
*nvme_rdma_tagset(struct nvme_rdma_queue
*queue
)
1297 u32 queue_idx
= nvme_rdma_queue_idx(queue
);
1300 return queue
->ctrl
->admin_tag_set
.tags
[queue_idx
];
1301 return queue
->ctrl
->tag_set
.tags
[queue_idx
- 1];
1304 static void nvme_rdma_submit_async_event(struct nvme_ctrl
*arg
, int aer_idx
)
1306 struct nvme_rdma_ctrl
*ctrl
= to_rdma_ctrl(arg
);
1307 struct nvme_rdma_queue
*queue
= &ctrl
->queues
[0];
1308 struct ib_device
*dev
= queue
->device
->dev
;
1309 struct nvme_rdma_qe
*sqe
= &ctrl
->async_event_sqe
;
1310 struct nvme_command
*cmd
= sqe
->data
;
1314 if (WARN_ON_ONCE(aer_idx
!= 0))
1317 ib_dma_sync_single_for_cpu(dev
, sqe
->dma
, sizeof(*cmd
), DMA_TO_DEVICE
);
1319 memset(cmd
, 0, sizeof(*cmd
));
1320 cmd
->common
.opcode
= nvme_admin_async_event
;
1321 cmd
->common
.command_id
= NVME_RDMA_AQ_BLKMQ_DEPTH
;
1322 cmd
->common
.flags
|= NVME_CMD_SGL_METABUF
;
1323 nvme_rdma_set_sg_null(cmd
);
1325 ib_dma_sync_single_for_device(dev
, sqe
->dma
, sizeof(*cmd
),
1328 ret
= nvme_rdma_post_send(queue
, sqe
, &sge
, 1, NULL
, false);
1332 static int nvme_rdma_process_nvme_rsp(struct nvme_rdma_queue
*queue
,
1333 struct nvme_completion
*cqe
, struct ib_wc
*wc
, int tag
)
1336 struct nvme_rdma_request
*req
;
1339 rq
= blk_mq_tag_to_rq(nvme_rdma_tagset(queue
), cqe
->command_id
);
1341 dev_err(queue
->ctrl
->ctrl
.device
,
1342 "tag 0x%x on QP %#x not found\n",
1343 cqe
->command_id
, queue
->qp
->qp_num
);
1344 nvme_rdma_error_recovery(queue
->ctrl
);
1347 req
= blk_mq_rq_to_pdu(rq
);
1352 if ((wc
->wc_flags
& IB_WC_WITH_INVALIDATE
) &&
1353 wc
->ex
.invalidate_rkey
== req
->mr
->rkey
)
1354 req
->mr
->need_inval
= false;
1356 nvme_end_request(rq
, cqe
->status
, cqe
->result
);
1360 static int __nvme_rdma_recv_done(struct ib_cq
*cq
, struct ib_wc
*wc
, int tag
)
1362 struct nvme_rdma_qe
*qe
=
1363 container_of(wc
->wr_cqe
, struct nvme_rdma_qe
, cqe
);
1364 struct nvme_rdma_queue
*queue
= cq
->cq_context
;
1365 struct ib_device
*ibdev
= queue
->device
->dev
;
1366 struct nvme_completion
*cqe
= qe
->data
;
1367 const size_t len
= sizeof(struct nvme_completion
);
1370 if (unlikely(wc
->status
!= IB_WC_SUCCESS
)) {
1371 nvme_rdma_wr_error(cq
, wc
, "RECV");
1375 ib_dma_sync_single_for_cpu(ibdev
, qe
->dma
, len
, DMA_FROM_DEVICE
);
1377 * AEN requests are special as they don't time out and can
1378 * survive any kind of queue freeze and often don't respond to
1379 * aborts. We don't even bother to allocate a struct request
1380 * for them but rather special case them here.
1382 if (unlikely(nvme_rdma_queue_idx(queue
) == 0 &&
1383 cqe
->command_id
>= NVME_RDMA_AQ_BLKMQ_DEPTH
))
1384 nvme_complete_async_event(&queue
->ctrl
->ctrl
, cqe
->status
,
1387 ret
= nvme_rdma_process_nvme_rsp(queue
, cqe
, wc
, tag
);
1388 ib_dma_sync_single_for_device(ibdev
, qe
->dma
, len
, DMA_FROM_DEVICE
);
1390 nvme_rdma_post_recv(queue
, qe
);
1394 static void nvme_rdma_recv_done(struct ib_cq
*cq
, struct ib_wc
*wc
)
1396 __nvme_rdma_recv_done(cq
, wc
, -1);
1399 static int nvme_rdma_conn_established(struct nvme_rdma_queue
*queue
)
1403 for (i
= 0; i
< queue
->queue_size
; i
++) {
1404 ret
= nvme_rdma_post_recv(queue
, &queue
->rsp_ring
[i
]);
1406 goto out_destroy_queue_ib
;
1411 out_destroy_queue_ib
:
1412 nvme_rdma_destroy_queue_ib(queue
);
1416 static int nvme_rdma_conn_rejected(struct nvme_rdma_queue
*queue
,
1417 struct rdma_cm_event
*ev
)
1419 struct rdma_cm_id
*cm_id
= queue
->cm_id
;
1420 int status
= ev
->status
;
1421 const char *rej_msg
;
1422 const struct nvme_rdma_cm_rej
*rej_data
;
1425 rej_msg
= rdma_reject_msg(cm_id
, status
);
1426 rej_data
= rdma_consumer_reject_data(cm_id
, ev
, &rej_data_len
);
1428 if (rej_data
&& rej_data_len
>= sizeof(u16
)) {
1429 u16 sts
= le16_to_cpu(rej_data
->sts
);
1431 dev_err(queue
->ctrl
->ctrl
.device
,
1432 "Connect rejected: status %d (%s) nvme status %d (%s).\n",
1433 status
, rej_msg
, sts
, nvme_rdma_cm_msg(sts
));
1435 dev_err(queue
->ctrl
->ctrl
.device
,
1436 "Connect rejected: status %d (%s).\n", status
, rej_msg
);
1442 static int nvme_rdma_addr_resolved(struct nvme_rdma_queue
*queue
)
1446 ret
= nvme_rdma_create_queue_ib(queue
);
1450 ret
= rdma_resolve_route(queue
->cm_id
, NVME_RDMA_CONNECT_TIMEOUT_MS
);
1452 dev_err(queue
->ctrl
->ctrl
.device
,
1453 "rdma_resolve_route failed (%d).\n",
1455 goto out_destroy_queue
;
1461 nvme_rdma_destroy_queue_ib(queue
);
1465 static int nvme_rdma_route_resolved(struct nvme_rdma_queue
*queue
)
1467 struct nvme_rdma_ctrl
*ctrl
= queue
->ctrl
;
1468 struct rdma_conn_param param
= { };
1469 struct nvme_rdma_cm_req priv
= { };
1472 param
.qp_num
= queue
->qp
->qp_num
;
1473 param
.flow_control
= 1;
1475 param
.responder_resources
= queue
->device
->dev
->attrs
.max_qp_rd_atom
;
1476 /* maximum retry count */
1477 param
.retry_count
= 7;
1478 param
.rnr_retry_count
= 7;
1479 param
.private_data
= &priv
;
1480 param
.private_data_len
= sizeof(priv
);
1482 priv
.recfmt
= cpu_to_le16(NVME_RDMA_CM_FMT_1_0
);
1483 priv
.qid
= cpu_to_le16(nvme_rdma_queue_idx(queue
));
1485 * set the admin queue depth to the minimum size
1486 * specified by the Fabrics standard.
1488 if (priv
.qid
== 0) {
1489 priv
.hrqsize
= cpu_to_le16(NVME_AQ_DEPTH
);
1490 priv
.hsqsize
= cpu_to_le16(NVME_AQ_DEPTH
- 1);
1493 * current interpretation of the fabrics spec
1494 * is at minimum you make hrqsize sqsize+1, or a
1495 * 1's based representation of sqsize.
1497 priv
.hrqsize
= cpu_to_le16(queue
->queue_size
);
1498 priv
.hsqsize
= cpu_to_le16(queue
->ctrl
->ctrl
.sqsize
);
1501 ret
= rdma_connect(queue
->cm_id
, ¶m
);
1503 dev_err(ctrl
->ctrl
.device
,
1504 "rdma_connect failed (%d).\n", ret
);
1505 goto out_destroy_queue_ib
;
1510 out_destroy_queue_ib
:
1511 nvme_rdma_destroy_queue_ib(queue
);
1515 static int nvme_rdma_cm_handler(struct rdma_cm_id
*cm_id
,
1516 struct rdma_cm_event
*ev
)
1518 struct nvme_rdma_queue
*queue
= cm_id
->context
;
1521 dev_dbg(queue
->ctrl
->ctrl
.device
, "%s (%d): status %d id %p\n",
1522 rdma_event_msg(ev
->event
), ev
->event
,
1525 switch (ev
->event
) {
1526 case RDMA_CM_EVENT_ADDR_RESOLVED
:
1527 cm_error
= nvme_rdma_addr_resolved(queue
);
1529 case RDMA_CM_EVENT_ROUTE_RESOLVED
:
1530 cm_error
= nvme_rdma_route_resolved(queue
);
1532 case RDMA_CM_EVENT_ESTABLISHED
:
1533 queue
->cm_error
= nvme_rdma_conn_established(queue
);
1534 /* complete cm_done regardless of success/failure */
1535 complete(&queue
->cm_done
);
1537 case RDMA_CM_EVENT_REJECTED
:
1538 nvme_rdma_destroy_queue_ib(queue
);
1539 cm_error
= nvme_rdma_conn_rejected(queue
, ev
);
1541 case RDMA_CM_EVENT_ROUTE_ERROR
:
1542 case RDMA_CM_EVENT_CONNECT_ERROR
:
1543 case RDMA_CM_EVENT_UNREACHABLE
:
1544 nvme_rdma_destroy_queue_ib(queue
);
1545 case RDMA_CM_EVENT_ADDR_ERROR
:
1546 dev_dbg(queue
->ctrl
->ctrl
.device
,
1547 "CM error event %d\n", ev
->event
);
1548 cm_error
= -ECONNRESET
;
1550 case RDMA_CM_EVENT_DISCONNECTED
:
1551 case RDMA_CM_EVENT_ADDR_CHANGE
:
1552 case RDMA_CM_EVENT_TIMEWAIT_EXIT
:
1553 dev_dbg(queue
->ctrl
->ctrl
.device
,
1554 "disconnect received - connection closed\n");
1555 nvme_rdma_error_recovery(queue
->ctrl
);
1557 case RDMA_CM_EVENT_DEVICE_REMOVAL
:
1558 /* device removal is handled via the ib_client API */
1561 dev_err(queue
->ctrl
->ctrl
.device
,
1562 "Unexpected RDMA CM event (%d)\n", ev
->event
);
1563 nvme_rdma_error_recovery(queue
->ctrl
);
1568 queue
->cm_error
= cm_error
;
1569 complete(&queue
->cm_done
);
1575 static enum blk_eh_timer_return
1576 nvme_rdma_timeout(struct request
*rq
, bool reserved
)
1578 struct nvme_rdma_request
*req
= blk_mq_rq_to_pdu(rq
);
1580 /* queue error recovery */
1581 nvme_rdma_error_recovery(req
->queue
->ctrl
);
1583 /* fail with DNR on cmd timeout */
1584 nvme_req(rq
)->status
= NVME_SC_ABORT_REQ
| NVME_SC_DNR
;
1586 return BLK_EH_HANDLED
;
1590 * We cannot accept any other command until the Connect command has completed.
1592 static inline blk_status_t
1593 nvme_rdma_queue_is_ready(struct nvme_rdma_queue
*queue
, struct request
*rq
)
1595 if (unlikely(!test_bit(NVME_RDMA_Q_LIVE
, &queue
->flags
))) {
1596 struct nvme_command
*cmd
= nvme_req(rq
)->cmd
;
1598 if (!blk_rq_is_passthrough(rq
) ||
1599 cmd
->common
.opcode
!= nvme_fabrics_command
||
1600 cmd
->fabrics
.fctype
!= nvme_fabrics_type_connect
) {
1602 * reconnecting state means transport disruption, which
1603 * can take a long time and even might fail permanently,
1604 * so we can't let incoming I/O be requeued forever.
1605 * fail it fast to allow upper layers a chance to
1608 if (queue
->ctrl
->ctrl
.state
== NVME_CTRL_RECONNECTING
)
1609 return BLK_STS_IOERR
;
1610 return BLK_STS_RESOURCE
; /* try again later */
1617 static blk_status_t
nvme_rdma_queue_rq(struct blk_mq_hw_ctx
*hctx
,
1618 const struct blk_mq_queue_data
*bd
)
1620 struct nvme_ns
*ns
= hctx
->queue
->queuedata
;
1621 struct nvme_rdma_queue
*queue
= hctx
->driver_data
;
1622 struct request
*rq
= bd
->rq
;
1623 struct nvme_rdma_request
*req
= blk_mq_rq_to_pdu(rq
);
1624 struct nvme_rdma_qe
*sqe
= &req
->sqe
;
1625 struct nvme_command
*c
= sqe
->data
;
1627 struct ib_device
*dev
;
1631 WARN_ON_ONCE(rq
->tag
< 0);
1633 ret
= nvme_rdma_queue_is_ready(queue
, rq
);
1637 dev
= queue
->device
->dev
;
1638 ib_dma_sync_single_for_cpu(dev
, sqe
->dma
,
1639 sizeof(struct nvme_command
), DMA_TO_DEVICE
);
1641 ret
= nvme_setup_cmd(ns
, rq
, c
);
1645 blk_mq_start_request(rq
);
1647 err
= nvme_rdma_map_data(queue
, rq
, c
);
1648 if (unlikely(err
< 0)) {
1649 dev_err(queue
->ctrl
->ctrl
.device
,
1650 "Failed to map data (%d)\n", err
);
1651 nvme_cleanup_cmd(rq
);
1655 ib_dma_sync_single_for_device(dev
, sqe
->dma
,
1656 sizeof(struct nvme_command
), DMA_TO_DEVICE
);
1658 if (req_op(rq
) == REQ_OP_FLUSH
)
1660 err
= nvme_rdma_post_send(queue
, sqe
, req
->sge
, req
->num_sge
,
1661 req
->mr
->need_inval
? &req
->reg_wr
.wr
: NULL
, flush
);
1662 if (unlikely(err
)) {
1663 nvme_rdma_unmap_data(queue
, rq
);
1669 if (err
== -ENOMEM
|| err
== -EAGAIN
)
1670 return BLK_STS_RESOURCE
;
1671 return BLK_STS_IOERR
;
1674 static int nvme_rdma_poll(struct blk_mq_hw_ctx
*hctx
, unsigned int tag
)
1676 struct nvme_rdma_queue
*queue
= hctx
->driver_data
;
1677 struct ib_cq
*cq
= queue
->ib_cq
;
1681 while (ib_poll_cq(cq
, 1, &wc
) > 0) {
1682 struct ib_cqe
*cqe
= wc
.wr_cqe
;
1685 if (cqe
->done
== nvme_rdma_recv_done
)
1686 found
|= __nvme_rdma_recv_done(cq
, &wc
, tag
);
1695 static void nvme_rdma_complete_rq(struct request
*rq
)
1697 struct nvme_rdma_request
*req
= blk_mq_rq_to_pdu(rq
);
1699 nvme_rdma_unmap_data(req
->queue
, rq
);
1700 nvme_complete_rq(rq
);
1703 static int nvme_rdma_map_queues(struct blk_mq_tag_set
*set
)
1705 struct nvme_rdma_ctrl
*ctrl
= set
->driver_data
;
1707 return blk_mq_rdma_map_queues(set
, ctrl
->device
->dev
, 0);
1710 static const struct blk_mq_ops nvme_rdma_mq_ops
= {
1711 .queue_rq
= nvme_rdma_queue_rq
,
1712 .complete
= nvme_rdma_complete_rq
,
1713 .init_request
= nvme_rdma_init_request
,
1714 .exit_request
= nvme_rdma_exit_request
,
1715 .init_hctx
= nvme_rdma_init_hctx
,
1716 .poll
= nvme_rdma_poll
,
1717 .timeout
= nvme_rdma_timeout
,
1718 .map_queues
= nvme_rdma_map_queues
,
1721 static const struct blk_mq_ops nvme_rdma_admin_mq_ops
= {
1722 .queue_rq
= nvme_rdma_queue_rq
,
1723 .complete
= nvme_rdma_complete_rq
,
1724 .init_request
= nvme_rdma_init_request
,
1725 .exit_request
= nvme_rdma_exit_request
,
1726 .init_hctx
= nvme_rdma_init_admin_hctx
,
1727 .timeout
= nvme_rdma_timeout
,
1730 static void nvme_rdma_shutdown_ctrl(struct nvme_rdma_ctrl
*ctrl
, bool shutdown
)
1732 cancel_work_sync(&ctrl
->err_work
);
1733 cancel_delayed_work_sync(&ctrl
->reconnect_work
);
1735 if (ctrl
->ctrl
.queue_count
> 1) {
1736 nvme_stop_queues(&ctrl
->ctrl
);
1737 blk_mq_tagset_busy_iter(&ctrl
->tag_set
,
1738 nvme_cancel_request
, &ctrl
->ctrl
);
1739 nvme_rdma_destroy_io_queues(ctrl
, shutdown
);
1743 nvme_shutdown_ctrl(&ctrl
->ctrl
);
1745 nvme_disable_ctrl(&ctrl
->ctrl
, ctrl
->ctrl
.cap
);
1747 blk_mq_quiesce_queue(ctrl
->ctrl
.admin_q
);
1748 blk_mq_tagset_busy_iter(&ctrl
->admin_tag_set
,
1749 nvme_cancel_request
, &ctrl
->ctrl
);
1750 blk_mq_unquiesce_queue(ctrl
->ctrl
.admin_q
);
1751 nvme_rdma_destroy_admin_queue(ctrl
, shutdown
);
1754 static void nvme_rdma_remove_ctrl(struct nvme_rdma_ctrl
*ctrl
)
1756 nvme_remove_namespaces(&ctrl
->ctrl
);
1757 nvme_rdma_shutdown_ctrl(ctrl
, true);
1758 nvme_uninit_ctrl(&ctrl
->ctrl
);
1759 nvme_put_ctrl(&ctrl
->ctrl
);
1762 static void nvme_rdma_del_ctrl_work(struct work_struct
*work
)
1764 struct nvme_rdma_ctrl
*ctrl
= container_of(work
,
1765 struct nvme_rdma_ctrl
, delete_work
);
1767 nvme_stop_ctrl(&ctrl
->ctrl
);
1768 nvme_rdma_remove_ctrl(ctrl
);
1771 static int __nvme_rdma_del_ctrl(struct nvme_rdma_ctrl
*ctrl
)
1773 if (!nvme_change_ctrl_state(&ctrl
->ctrl
, NVME_CTRL_DELETING
))
1776 if (!queue_work(nvme_wq
, &ctrl
->delete_work
))
1782 static int nvme_rdma_del_ctrl(struct nvme_ctrl
*nctrl
)
1784 struct nvme_rdma_ctrl
*ctrl
= to_rdma_ctrl(nctrl
);
1788 * Keep a reference until all work is flushed since
1789 * __nvme_rdma_del_ctrl can free the ctrl mem
1791 if (!kref_get_unless_zero(&ctrl
->ctrl
.kref
))
1793 ret
= __nvme_rdma_del_ctrl(ctrl
);
1795 flush_work(&ctrl
->delete_work
);
1796 nvme_put_ctrl(&ctrl
->ctrl
);
1800 static void nvme_rdma_reset_ctrl_work(struct work_struct
*work
)
1802 struct nvme_rdma_ctrl
*ctrl
=
1803 container_of(work
, struct nvme_rdma_ctrl
, ctrl
.reset_work
);
1807 nvme_stop_ctrl(&ctrl
->ctrl
);
1808 nvme_rdma_shutdown_ctrl(ctrl
, false);
1810 ret
= nvme_rdma_configure_admin_queue(ctrl
, false);
1814 if (ctrl
->ctrl
.queue_count
> 1) {
1815 ret
= nvme_rdma_configure_io_queues(ctrl
, false);
1820 changed
= nvme_change_ctrl_state(&ctrl
->ctrl
, NVME_CTRL_LIVE
);
1821 WARN_ON_ONCE(!changed
);
1823 nvme_start_ctrl(&ctrl
->ctrl
);
1828 dev_warn(ctrl
->ctrl
.device
, "Removing after reset failure\n");
1829 nvme_rdma_remove_ctrl(ctrl
);
1832 static const struct nvme_ctrl_ops nvme_rdma_ctrl_ops
= {
1834 .module
= THIS_MODULE
,
1835 .flags
= NVME_F_FABRICS
,
1836 .reg_read32
= nvmf_reg_read32
,
1837 .reg_read64
= nvmf_reg_read64
,
1838 .reg_write32
= nvmf_reg_write32
,
1839 .free_ctrl
= nvme_rdma_free_ctrl
,
1840 .submit_async_event
= nvme_rdma_submit_async_event
,
1841 .delete_ctrl
= nvme_rdma_del_ctrl
,
1842 .get_address
= nvmf_get_address
,
1843 .reinit_request
= nvme_rdma_reinit_request
,
1846 static struct nvme_ctrl
*nvme_rdma_create_ctrl(struct device
*dev
,
1847 struct nvmf_ctrl_options
*opts
)
1849 struct nvme_rdma_ctrl
*ctrl
;
1854 ctrl
= kzalloc(sizeof(*ctrl
), GFP_KERNEL
);
1856 return ERR_PTR(-ENOMEM
);
1857 ctrl
->ctrl
.opts
= opts
;
1858 INIT_LIST_HEAD(&ctrl
->list
);
1860 if (opts
->mask
& NVMF_OPT_TRSVCID
)
1861 port
= opts
->trsvcid
;
1863 port
= __stringify(NVME_RDMA_IP_PORT
);
1865 ret
= inet_pton_with_scope(&init_net
, AF_UNSPEC
,
1866 opts
->traddr
, port
, &ctrl
->addr
);
1868 pr_err("malformed address passed: %s:%s\n", opts
->traddr
, port
);
1872 if (opts
->mask
& NVMF_OPT_HOST_TRADDR
) {
1873 ret
= inet_pton_with_scope(&init_net
, AF_UNSPEC
,
1874 opts
->host_traddr
, NULL
, &ctrl
->src_addr
);
1876 pr_err("malformed src address passed: %s\n",
1882 ret
= nvme_init_ctrl(&ctrl
->ctrl
, dev
, &nvme_rdma_ctrl_ops
,
1883 0 /* no quirks, we're perfect! */);
1887 INIT_DELAYED_WORK(&ctrl
->reconnect_work
,
1888 nvme_rdma_reconnect_ctrl_work
);
1889 INIT_WORK(&ctrl
->err_work
, nvme_rdma_error_recovery_work
);
1890 INIT_WORK(&ctrl
->delete_work
, nvme_rdma_del_ctrl_work
);
1891 INIT_WORK(&ctrl
->ctrl
.reset_work
, nvme_rdma_reset_ctrl_work
);
1893 ctrl
->ctrl
.queue_count
= opts
->nr_io_queues
+ 1; /* +1 for admin queue */
1894 ctrl
->ctrl
.sqsize
= opts
->queue_size
- 1;
1895 ctrl
->ctrl
.kato
= opts
->kato
;
1898 ctrl
->queues
= kcalloc(ctrl
->ctrl
.queue_count
, sizeof(*ctrl
->queues
),
1901 goto out_uninit_ctrl
;
1903 ret
= nvme_rdma_configure_admin_queue(ctrl
, true);
1905 goto out_kfree_queues
;
1907 /* sanity check icdoff */
1908 if (ctrl
->ctrl
.icdoff
) {
1909 dev_err(ctrl
->ctrl
.device
, "icdoff is not supported!\n");
1911 goto out_remove_admin_queue
;
1914 /* sanity check keyed sgls */
1915 if (!(ctrl
->ctrl
.sgls
& (1 << 20))) {
1916 dev_err(ctrl
->ctrl
.device
, "Mandatory keyed sgls are not support\n");
1918 goto out_remove_admin_queue
;
1921 if (opts
->queue_size
> ctrl
->ctrl
.maxcmd
) {
1922 /* warn if maxcmd is lower than queue_size */
1923 dev_warn(ctrl
->ctrl
.device
,
1924 "queue_size %zu > ctrl maxcmd %u, clamping down\n",
1925 opts
->queue_size
, ctrl
->ctrl
.maxcmd
);
1926 opts
->queue_size
= ctrl
->ctrl
.maxcmd
;
1929 if (opts
->queue_size
> ctrl
->ctrl
.sqsize
+ 1) {
1930 /* warn if sqsize is lower than queue_size */
1931 dev_warn(ctrl
->ctrl
.device
,
1932 "queue_size %zu > ctrl sqsize %u, clamping down\n",
1933 opts
->queue_size
, ctrl
->ctrl
.sqsize
+ 1);
1934 opts
->queue_size
= ctrl
->ctrl
.sqsize
+ 1;
1937 if (opts
->nr_io_queues
) {
1938 ret
= nvme_rdma_configure_io_queues(ctrl
, true);
1940 goto out_remove_admin_queue
;
1943 changed
= nvme_change_ctrl_state(&ctrl
->ctrl
, NVME_CTRL_LIVE
);
1944 WARN_ON_ONCE(!changed
);
1946 dev_info(ctrl
->ctrl
.device
, "new ctrl: NQN \"%s\", addr %pISpcs\n",
1947 ctrl
->ctrl
.opts
->subsysnqn
, &ctrl
->addr
);
1949 kref_get(&ctrl
->ctrl
.kref
);
1951 mutex_lock(&nvme_rdma_ctrl_mutex
);
1952 list_add_tail(&ctrl
->list
, &nvme_rdma_ctrl_list
);
1953 mutex_unlock(&nvme_rdma_ctrl_mutex
);
1955 nvme_start_ctrl(&ctrl
->ctrl
);
1959 out_remove_admin_queue
:
1960 nvme_rdma_destroy_admin_queue(ctrl
, true);
1962 kfree(ctrl
->queues
);
1964 nvme_uninit_ctrl(&ctrl
->ctrl
);
1965 nvme_put_ctrl(&ctrl
->ctrl
);
1968 return ERR_PTR(ret
);
1971 return ERR_PTR(ret
);
1974 static struct nvmf_transport_ops nvme_rdma_transport
= {
1976 .required_opts
= NVMF_OPT_TRADDR
,
1977 .allowed_opts
= NVMF_OPT_TRSVCID
| NVMF_OPT_RECONNECT_DELAY
|
1978 NVMF_OPT_HOST_TRADDR
| NVMF_OPT_CTRL_LOSS_TMO
,
1979 .create_ctrl
= nvme_rdma_create_ctrl
,
1982 static void nvme_rdma_remove_one(struct ib_device
*ib_device
, void *client_data
)
1984 struct nvme_rdma_ctrl
*ctrl
;
1986 /* Delete all controllers using this device */
1987 mutex_lock(&nvme_rdma_ctrl_mutex
);
1988 list_for_each_entry(ctrl
, &nvme_rdma_ctrl_list
, list
) {
1989 if (ctrl
->device
->dev
!= ib_device
)
1991 dev_info(ctrl
->ctrl
.device
,
1992 "Removing ctrl: NQN \"%s\", addr %pISp\n",
1993 ctrl
->ctrl
.opts
->subsysnqn
, &ctrl
->addr
);
1994 __nvme_rdma_del_ctrl(ctrl
);
1996 mutex_unlock(&nvme_rdma_ctrl_mutex
);
1998 flush_workqueue(nvme_wq
);
2001 static struct ib_client nvme_rdma_ib_client
= {
2002 .name
= "nvme_rdma",
2003 .remove
= nvme_rdma_remove_one
2006 static int __init
nvme_rdma_init_module(void)
2010 ret
= ib_register_client(&nvme_rdma_ib_client
);
2014 ret
= nvmf_register_transport(&nvme_rdma_transport
);
2016 goto err_unreg_client
;
2021 ib_unregister_client(&nvme_rdma_ib_client
);
2025 static void __exit
nvme_rdma_cleanup_module(void)
2027 nvmf_unregister_transport(&nvme_rdma_transport
);
2028 ib_unregister_client(&nvme_rdma_ib_client
);
2031 module_init(nvme_rdma_init_module
);
2032 module_exit(nvme_rdma_cleanup_module
);
2034 MODULE_LICENSE("GPL v2");